Перейти к основному содержимому
QuantanSite

Справочник API

Документация API

JSON API только для чтения поверх тех же рыночных данных, которые отображает этот сайт. Успешные ответы используют конверт { data, meta }; ответы с ошибкой используют { error: { code, message } }.

Базовый URL
http://localhost:3000
Методы
Только GET
Формат
JSON, UTF-8
Ограничение запросов
60 запросов за 60 секунд, на IP-адрес и эндпоинт

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

Демо
Ответы берутся из детерминированного демонстрационного набора данных с вымышленными эмитентами, если сервер не задаёт MARKET_DATA_PROVIDER=fmp вместе с FMP_API_KEY. Поле meta.provider в каждом ответе показывает, какой источник ответил.

Список котировок

GET/api/quotes

Возвращает одну страницу инструментов в виде плоского массива, а в meta содержатся total, page и pageSize. Все фильтры скринера ниже работают и здесь; значения, которые не удаётся разобрать, игнорируются.

Параметры

ПараметрГдеТипОбязательныйОписание
sectorquerystringНеобязательныйТочное название сектора: Technology, Healthcare, Financials, Consumer Discretionary, Consumer Staples, Industrials, Energy, Materials, Utilities, Real Estate.
sortquerystringНеобязательныйПоле сортировки: marketCap (по умолчанию), price, changePercent, volume или symbol.
orderquerystringНеобязательныйПорядок сортировки: desc (по умолчанию) или asc.
pagequerynumberНеобязательныйНомер страницы, начиная с 1.
pageSizequerynumberНеобязательныйСтрок на странице: по умолчанию 20, максимум 100.

Запрос

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

Пример ответа

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
  }
}

Пример сокращён до одной строки.

Получить котировку

GET/api/quotes/{symbol}

Возвращает полную котировку одного инструмента или индекса. Неизвестный symbol возвращает 404 not_found.

Параметры

ПараметрГдеТипОбязательныйОписание
symbolpathstringОбязательныйСимвол инструмента или индекса, например NWRB. Регистр не учитывается.

Запрос

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

Пример ответа

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."
  }
}

Получить свечи

GET/api/candles/{symbol}

Возвращает свечи OHLCV, начиная с самых старых. Диапазон 1D использует интервалы 30-minute; все остальные диапазоны используют дневные свечи. Неизвестный диапазон возвращает 400 bad_request.

Параметры

ПараметрГдеТипОбязательныйОписание
symbolpathstringОбязательныйСимвол инструмента или индекса, например NWRB. Регистр не учитывается.
rangequerystringНеобязательныйОдно из значений 1D, 5D, 1M, 6M, 1Y, 5Y. По умолчанию 1M.

Запрос

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

Пример ответа

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"
  }
}

Пример сокращён до двух свечей; 1M возвращает 22.

Скрининг инструментов

GET/api/screener

Фильтрует, сортирует и разбивает на страницы инструменты с теми же параметрами, что и страница скринера. Результат содержит rows вместе с total, page и pageSize; значения, которые не удаётся разобрать, игнорируются.

Параметры

ПараметрГдеТипОбязательныйОписание
sectorquerystringНеобязательныйТочное название сектора: Technology, Healthcare, Financials, Consumer Discretionary, Consumer Staples, Industrials, Energy, Materials, Utilities, Real Estate.
minMarketCap, maxMarketCapquerynumberНеобязательныйГраницы рыночной капитализации в USD.
minPrice, maxPricequerynumberНеобязательныйГраницы цены в USD.
minChangePercent, maxChangePercentquerynumberНеобязательныйГраницы дневного изменения в процентных пунктах: -3 означает -3%.
minVolumequerynumberНеобязательныйМинимальный дневной объём в акциях.
profitableOnlyquerystringНеобязательныйУстановите 1, чтобы оставить только инструменты с EPS выше 0.
sortquerystringНеобязательныйПоле сортировки: marketCap (по умолчанию), price, changePercent, volume или symbol.
orderquerystringНеобязательныйПорядок сортировки: desc (по умолчанию) или asc.
pagequerynumberНеобязательныйНомер страницы, начиная с 1.
pageSizequerynumberНеобязательныйСтрок на странице: по умолчанию 20, максимум 100.

Запрос

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

Пример ответа

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
  }
}

Пример сокращён до одной строки.

Аутентификация

В демо-режиме ключ не нужен. Если сервер задаёт переменную окружения API_KEY, каждый запрос должен передавать то же значение в заголовке X-API-Key; иначе возвращается 401 unauthorized.

curl -s "http://localhost:3000/api/quotes/NWRB" \
  -H "X-API-Key: your-key-here"
Примечание
Ключ читается только на сервере. Кнопки «Отправить запрос» на этой странице вызывают API из браузера без ключа, поэтому при включённой аутентификации по ключу они возвращают 401.

Коды ошибок

Неуспешные запросы возвращают соответствующий статус HTTP и один объект ошибки. Ветвление выполняйте по code; message написан для людей и может меняться.

{
  "error": {
    "code": "not_found",
    "message": "A human-readable explanation."
  }
}
Статус HTTPКодКогда возникает
400bad_requestЗначение параметра недопустимо, например неизвестный диапазон свечей.
401unauthorizedAPI_KEY задан, а запрос не содержит подходящего заголовка X-API-Key.
404not_foundТакого symbol нет в наборе данных.
405method_not_allowedAPI работает только на чтение: /api/quotes отвечает на POST этим кодом.
429rate_limitedБолее 60 запросов за 60 секунд с одного IP-адреса на один эндпоинт. Ответ содержит Retry-After в секундах.

Посмотрите те же данные в продукте

Обзор рынка, страницы котировок и скринер читают того же провайдера, что и эти эндпоинты.