Chuyển đến nội dung chính
QuantanSite

Tham chiếu API

Tài liệu API

Một API JSON chỉ đọc trên cùng dữ liệu thị trường mà trang này hiển thị. Phản hồi thành công dùng phong bì { data, meta }; phản hồi lỗi dùng { error: { code, message } }.

URL gốc
http://localhost:3000
Phương thức
Chỉ GET
Định dạng
JSON, UTF-8
Giới hạn tốc độ
60 yêu cầu mỗi 60 giây, cho mỗi địa chỉ IP và điểm cuối

These are API examples. This site is served as static files.

Bản demo
Các phản hồi đến từ một tập dữ liệu demo tất định với những tổ chức phát hành hư cấu, trừ khi máy chủ đặt MARKET_DATA_PROVIDER=fmp cùng với FMP_API_KEY. Trường meta.provider trong mỗi phản hồi cho biết nguồn nào đã trả lời.

Liệt kê báo giá

GET/api/quotes

Trả về một trang công cụ dưới dạng mảng phẳng, kèm total, page và pageSize trong meta. Mọi bộ lọc của trang sàng lọc bên dưới cũng hoạt động ở đây; những giá trị không phân tích được sẽ bị bỏ qua.

Tham số

Tham sốVị tríKiểuBắt buộcMô tả
sectorquerystringTùy chọnTên ngành chính xác: Technology, Healthcare, Financials, Consumer Discretionary, Consumer Staples, Industrials, Energy, Materials, Utilities, Real Estate.
sortquerystringTùy chọnTrường sắp xếp: marketCap (mặc định), price, changePercent, volume hoặc symbol.
orderquerystringTùy chọnHướng sắp xếp: desc (mặc định) hoặc asc.
pagequerynumberTùy chọnSố trang, bắt đầu từ 1.
pageSizequerynumberTùy chọnSố hàng mỗi trang: mặc định 20, tối đa 100.

Yêu cầu

curl -s "http://localhost:3000/api/quotes?pageSize=3"

Mẫu phản hồi

200application/json

{
  "data": [
    {
      "symbol": "NWRB",
      "name": "Northwind Robotics",
      "exchange": "NASDAQ",
      "sector": "Technology",
      "industry": "Industrial Automation",
      "price": 733.8,
      "change": -16.52,
      "changePercent": -2.2,
      "previousClose": 750.32,
      "open": 750.03,
      "dayHigh": 751.29,
      "dayLow": 731.5,
      "volume": 3471317,
      "avgVolume": 2962633,
      "marketCap": 982258754565,
      "peRatio": 60.35,
      "eps": 12.16,
      "dividendYield": null,
      "week52High": 963.99,
      "week52Low": 583.89,
      "afterHoursPrice": 731,
      "afterHoursChangePercent": -0.38,
      "updatedAt": "2026-11-12T21:00:00.000Z"
    }
  ],
  "meta": {
    "provider": "demo",
    "generatedAt": "2026-11-12T21:00:04.512Z",
    "disclaimer": "Demo dataset: fictional issuers and simulated prices. Not investment advice.",
    "total": 20,
    "page": 1,
    "pageSize": 3
  }
}

Mẫu được rút gọn còn một hàng.

Lấy một báo giá

GET/api/quotes/{symbol}

Trả về báo giá đầy đủ cho một công cụ hoặc chỉ số. Một mã không tồn tại trả về 404 not_found.

Tham số

Tham sốVị tríKiểuBắt buộcMô tả
symbolpathstringBắt buộcMã công cụ hoặc chỉ số, ví dụ NWRB. Việc so khớp không phân biệt chữ hoa chữ thường.

Yêu cầu

curl -s "http://localhost:3000/api/quotes/NWRB"

Mẫu phản hồi

200application/json

{
  "data": {
    "symbol": "NWRB",
    "name": "Northwind Robotics",
    "exchange": "NASDAQ",
    "sector": "Technology",
    "industry": "Industrial Automation",
    "price": 733.8,
    "change": -16.52,
    "changePercent": -2.2,
    "previousClose": 750.32,
    "open": 750.03,
    "dayHigh": 751.29,
    "dayLow": 731.5,
    "volume": 3471317,
    "avgVolume": 2962633,
    "marketCap": 982258754565,
    "peRatio": 60.35,
    "eps": 12.16,
    "dividendYield": null,
    "week52High": 963.99,
    "week52Low": 583.89,
    "afterHoursPrice": 731,
    "afterHoursChangePercent": -0.38,
    "updatedAt": "2026-11-12T21:00:00.000Z"
  },
  "meta": {
    "provider": "demo",
    "generatedAt": "2026-11-12T21:00:04.512Z",
    "disclaimer": "Demo dataset: fictional issuers and simulated prices. Not investment advice."
  }
}

Lấy nến

GET/api/candles/{symbol}

Trả về nến OHLCV, cũ nhất trước. Khoảng 1D dùng các khoảng 30-minute; mọi khoảng khác dùng nến ngày. Một khoảng không hợp lệ trả về 400 bad_request.

Tham số

Tham sốVị tríKiểuBắt buộcMô tả
symbolpathstringBắt buộcMã công cụ hoặc chỉ số, ví dụ NWRB. Việc so khớp không phân biệt chữ hoa chữ thường.
rangequerystringTùy chọnMột trong 1D, 5D, 1M, 6M, 1Y, 5Y. Mặc định là 1M.

Yêu cầu

curl -s "http://localhost:3000/api/candles/NWRB?range=1M"

Mẫu phản hồi

200application/json

{
  "data": [
    {
      "time": "2026-11-11",
      "open": 757.4,
      "high": 761.18,
      "low": 743.92,
      "close": 750.32,
      "volume": 3531710
    },
    {
      "time": "2026-11-12",
      "open": 750.03,
      "high": 751.29,
      "low": 731.5,
      "close": 733.8,
      "volume": 3471317
    }
  ],
  "meta": {
    "provider": "demo",
    "generatedAt": "2026-11-12T21:00:04.512Z",
    "disclaimer": "Demo dataset: fictional issuers and simulated prices. Not investment advice.",
    "symbol": "NWRB",
    "range": "1M"
  }
}

Mẫu được rút gọn còn hai nến; khoảng 1M trả về 22 nến.

Sàng lọc công cụ

GET/api/screener

Lọc, sắp xếp và phân trang công cụ với cùng tham số như trang sàng lọc. Kết quả mang rows cùng total, page và pageSize; những giá trị không phân tích được sẽ bị bỏ qua.

Tham số

Tham sốVị tríKiểuBắt buộcMô tả
sectorquerystringTùy chọnTên ngành chính xác: Technology, Healthcare, Financials, Consumer Discretionary, Consumer Staples, Industrials, Energy, Materials, Utilities, Real Estate.
minMarketCap, maxMarketCapquerynumberTùy chọnGiới hạn vốn hóa thị trường bằng USD.
minPrice, maxPricequerynumberTùy chọnGiới hạn giá bằng USD.
minChangePercent, maxChangePercentquerynumberTùy chọnGiới hạn thay đổi hằng ngày theo điểm phần trăm: -3 nghĩa là -3%.
minVolumequerynumberTùy chọnKhối lượng giao dịch hằng ngày tối thiểu tính bằng cổ phiếu.
profitableOnlyquerystringTùy chọnĐặt thành 1 để chỉ giữ các công cụ có EPS trên 0.
sortquerystringTùy chọnTrường sắp xếp: marketCap (mặc định), price, changePercent, volume hoặc symbol.
orderquerystringTùy chọnHướng sắp xếp: desc (mặc định) hoặc asc.
pagequerynumberTùy chọnSố trang, bắt đầu từ 1.
pageSizequerynumberTùy chọnSố hàng mỗi trang: mặc định 20, tối đa 100.

Yêu cầu

curl -s "http://localhost:3000/api/screener?profitableOnly=1&pageSize=5"

Mẫu phản hồi

200application/json

{
  "data": {
    "rows": [
      {
        "symbol": "NWRB",
        "name": "Northwind Robotics",
        "exchange": "NASDAQ",
        "sector": "Technology",
        "industry": "Industrial Automation",
        "price": 733.8,
        "change": -16.52,
        "changePercent": -2.2,
        "previousClose": 750.32,
        "open": 750.03,
        "dayHigh": 751.29,
        "dayLow": 731.5,
        "volume": 3471317,
        "avgVolume": 2962633,
        "marketCap": 982258754565,
        "peRatio": 60.35,
        "eps": 12.16,
        "dividendYield": null,
        "week52High": 963.99,
        "week52Low": 583.89,
        "afterHoursPrice": 731,
        "afterHoursChangePercent": -0.38,
        "updatedAt": "2026-11-12T21:00:00.000Z"
      }
    ],
    "total": 17,
    "page": 1,
    "pageSize": 5
  },
  "meta": {
    "provider": "demo",
    "generatedAt": "2026-11-12T21:00:04.512Z",
    "disclaimer": "Demo dataset: fictional issuers and simulated prices. Not investment advice.",
    "total": 17,
    "page": 1,
    "pageSize": 5
  }
}

Mẫu được rút gọn còn một hàng.

Xác thực

Chế độ demo không cần khóa. Khi máy chủ đặt biến môi trường API_KEY, mọi yêu cầu phải gửi cùng giá trị đó trong tiêu đề X-API-Key; mọi giá trị khác sẽ nhận 401 unauthorized.

curl -s "http://localhost:3000/api/quotes/NWRB" \
  -H "X-API-Key: your-key-here"
Ghi chú
Khóa chỉ được đọc trên máy chủ. Các nút Gửi yêu cầu trên trang này gọi API từ trình duyệt của bạn mà không có khóa, nên chúng trả về 401 khi xác thực bằng khóa đang bật.

Mã lỗi

Các yêu cầu thất bại trả về một trạng thái HTTP tương ứng và một đối tượng lỗi. Hãy rẽ nhánh theo code; message được viết cho con người và có thể thay đổi.

{
  "error": {
    "code": "not_found",
    "message": "A human-readable explanation."
  }
}
Trạng thái HTTPMãKhi nào xảy ra
400bad_requestMột giá trị tham số không được phép, ví dụ một khoảng nến không hợp lệ.
401unauthorizedAPI_KEY đã được cấu hình và yêu cầu không có tiêu đề X-API-Key khớp.
404not_foundMã này không tồn tại trong tập dữ liệu.
405method_not_allowedAPI chỉ đọc: /api/quotes trả lời POST bằng mã này.
429rate_limitedHơn 60 yêu cầu trong 60 giây từ một địa chỉ IP đến một điểm cuối. Phản hồi có kèm Retry-After tính bằng giây.

Xem cùng dữ liệu đó trong sản phẩm

Tổng quan thị trường, các trang báo giá và bộ sàng lọc đọc cùng nhà cung cấp như các điểm cuối này.