|View as Markdown

REST

2.14.0REST 2.0

Токены и аутентификация в Finam Trade API (REST) 1. Получение ключа: Сгенерируйте постоянный секретный ключ в разделе «Токены» вашего профиля. 2. Получение JWT: Отправьте POST-запрос к методу `Auth`, передав секретный ключ в теле запроса. В ответ сервер вернет временный JWT. 3. Использование в заголовках: Добавляйте заголовок во все последующие HTTP-запросы: `Authorization: Bearer <ваш_jwt_токен>`. Без этого заголовка сервер отклонит запрос. 4. Управление жизненным циклом: В REST отсутствует механизм автоматической подписки на обновления. Для получения свежего токена вам необходимо повторно вызывать метод `Auth` вручную до того, как текущий JWT станет недействительным. Разработчик должен самостоятельно реализовать логику контроля времени жизни токена в коде.

https://api.finam.ru
API Key

Authorization

JWT токен авторизации

header
|View as Markdown

POSTПолучение JWT токена из API токена

/v1/sessions

{ "secret": "your-api-secret-key" } Все поля передаются в теле запроса

Request Body

  • secret

    string

Responses

200A successful response.
401Срок действия токена истек или токен недействителен
404Счёт не был найден в токене
429Слишком много запросов. Доступный лимит - 200 запросов в минуту
500Внутренняя ошибка сервиса. Попробуйте позже
503Сервис на данный момент не доступен. Попробуйте позже
504Крайний срок истек до завершения операции
defaultAn unexpected error response.

A successful response.

|View as Markdown

POSTПолучение информации о токене сессии

/v1/sessions/details

{ "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..." } Токен передается в теле запроса для безопасности Получение информации о токене. Также включает список доступных счетов.

Request Body

  • token

    string

Responses

200A successful response.
401Срок действия токена истек или токен недействителен
404Счёт не был найден в токене
429Слишком много запросов. Доступный лимит - 200 запросов в минуту
500Внутренняя ошибка сервиса. Попробуйте позже
503Сервис на данный момент не доступен. Попробуйте позже
504Крайний срок истек до завершения операции
defaultAn unexpected error response.

A successful response.

|View as Markdown

GETПолучение информации по конкретному аккаунту

/v1/accounts/{account_id}

Path Parameters

  • account_id

    string

    required

    Идентификатор аккаунта

Responses

200A successful response.
401Срок действия токена истек или токен недействителен
404Счёт не был найден в токене
429Слишком много запросов. Доступный лимит - 200 запросов в минуту
500Внутренняя ошибка сервиса. Попробуйте позже
503Сервис на данный момент не доступен. Попробуйте позже
504Крайний срок истек до завершения операции
defaultAn unexpected error response.

A successful response.

|View as Markdown

GETПолучение истории по сделкам аккаунта

/v1/accounts/{account_id}/trades

Параметры: - account_id - передается в URL пути - limit и interval - передаются как query-параметры

Path Parameters

  • account_id

    string

    required

    Идентификатор аккаунта

Query Parameters

  • limit

    integer

    Лимит количества сделок

  • interval.start_time

    string

    Optional. Inclusive start of the interval. If specified, a Timestamp matching this interval will have to be the same or after the start.

  • interval.end_time

    string

    Optional. Exclusive end of the interval. If specified, a Timestamp matching this interval will have to be before the end.

Responses

200A successful response.
400Неверно передан интервал
401Срок действия токена истек или токен недействителен
404Счёт не был найден в токене
429Слишком много запросов. Доступный лимит - 200 запросов в минуту
500Внутренняя ошибка сервиса. Попробуйте позже
503Сервис на данный момент не доступен. Попробуйте позже
504Крайний срок истек до завершения операции
defaultAn unexpected error response.

A successful response.

|View as Markdown

GETПолучение списка транзакций аккаунта

/v1/accounts/{account_id}/transactions

Параметры: - account_id - передается в URL пути - limit и interval - передаются как query-параметры

Path Parameters

  • account_id

    string

    required

    Идентификатор аккаунта

Query Parameters

  • limit

    integer

    Лимит количества транзакций

  • interval.start_time

    string

    Optional. Inclusive start of the interval. If specified, a Timestamp matching this interval will have to be the same or after the start.

  • interval.end_time

    string

    Optional. Exclusive end of the interval. If specified, a Timestamp matching this interval will have to be before the end.

Responses

200A successful response.
400Неверно передан интервал
401Срок действия токена истек или токен недействителен
404Счёт не был найден в токене
429Слишком много запросов. Доступный лимит - 200 запросов в минуту
500Внутренняя ошибка сервиса. Попробуйте позже
503Сервис на данный момент не доступен. Попробуйте позже
504Крайний срок истек до завершения операции
defaultAn unexpected error response.

A successful response.

|View as Markdown

GETПолучение списка заявок для аккаунта

/v1/accounts/{account_id}/orders

Path Parameters

  • account_id

    string

    required

    Идентификатор аккаунта

Responses

200A successful response.
401Срок действия токена истек или токен недействителен
404Счёт не был найден
429Слишком много запросов. Доступный лимит - 200 запросов в минуту
500Внутренняя ошибка сервиса. Попробуйте позже
503Сервис на данный момент не доступен. Попробуйте позже
504Крайний срок истек до завершения операции
defaultAn unexpected error response.

A successful response.

|View as Markdown

POSTВыставление биржевой заявки

/v1/accounts/{account_id}/orders

{ "symbol": "SBER@MISX", "quantity": { "value": "10" }, "side": "SIDE_BUY", "type": "ORDER_TYPE_LIMIT", "time_in_force": "TIME_IN_FORCE_DAY", "limit_price": { "value": "150.50" } } Поле account_id берется из URL-пути, остальные поля передаются в теле запроса

Path Parameters

  • account_id

    string

    required

    Идентификатор аккаунта

Request Body

  • symbol

    string

  • quantity

    object

    A representation of a decimal value, such as 2.5. Clients may convert values into language-native decimal formats, such as Java's [BigDecimal][] or Python's [decimal.Decimal][]. [BigDecimal]: https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/math/BigDecimal.html [decimal.Decimal]: https://docs.python.org/3/library/decimal.html

  • side

    enum

    - SIDE_UNSPECIFIED: Сторона сделки не указана - SIDE_BUY: Покупка - SIDE_SELL: Продажа

  • type

    enum

    - ORDER_TYPE_UNSPECIFIED: Значение не указано - ORDER_TYPE_MARKET: Рыночная - ORDER_TYPE_LIMIT: Лимитная - ORDER_TYPE_STOP: Стоп заявка рыночная - ORDER_TYPE_STOP_LIMIT: Стоп заявка лимитная - ORDER_TYPE_MULTI_LEG: Мульти лег заявка

  • time_in_force

    enum

    - TIME_IN_FORCE_UNSPECIFIED: Значение не указано - TIME_IN_FORCE_DAY: До конца дня - TIME_IN_FORCE_GOOD_TILL_CANCEL: Действителен до отмены - TIME_IN_FORCE_GOOD_TILL_CROSSING: Действителен до пересечения - TIME_IN_FORCE_EXT: Внебиржевая торговля - TIME_IN_FORCE_ON_OPEN: На открытии биржи - TIME_IN_FORCE_ON_CLOSE: На закрытии биржи - TIME_IN_FORCE_IOC: Исполнить немедленно или отменить - TIME_IN_FORCE_FOK: Исполнить полностью или отменить

  • limit_price

    object

    A representation of a decimal value, such as 2.5. Clients may convert values into language-native decimal formats, such as Java's [BigDecimal][] or Python's [decimal.Decimal][]. [BigDecimal]: https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/math/BigDecimal.html [decimal.Decimal]: https://docs.python.org/3/library/decimal.html

  • stop_price

    object

    A representation of a decimal value, such as 2.5. Clients may convert values into language-native decimal formats, such as Java's [BigDecimal][] or Python's [decimal.Decimal][]. [BigDecimal]: https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/math/BigDecimal.html [decimal.Decimal]: https://docs.python.org/3/library/decimal.html

  • stop_condition

    enum

    - STOP_CONDITION_UNSPECIFIED: Значение не указано - STOP_CONDITION_LAST_UP: Цена срабатывания больше текущей цены - STOP_CONDITION_LAST_DOWN: Цена срабатывания меньше текущей цены

  • legs

    ordersLeg[]

  • client_order_id

    string

  • valid_before

    enum

    - VALID_BEFORE_UNSPECIFIED: Значение не указано - VALID_BEFORE_END_OF_DAY: До конца торгового дня - VALID_BEFORE_GOOD_TILL_CANCEL: До отмены - VALID_BEFORE_GOOD_TILL_DATE: До указанной даты-времени. Данный тип поддерживается только при выставлении SL/TP заявок

  • comment

    string

Responses

200A successful response.
400Неверно переданы торговые параметры
401Срок действия токена истек или токен недействителен
404Счёт или инструмент не были найдены
429Слишком много запросов. Доступный лимит - 200 запросов в минуту
500Внутренняя ошибка сервиса. Попробуйте позже
503Сервис на данный момент не доступен. Попробуйте позже
504Крайний срок истек до завершения операции
defaultAn unexpected error response.

A successful response.

|View as Markdown

GETПолучение информации о конкретном ордере

/v1/accounts/{account_id}/orders/{order_id}

Path Parameters

  • account_id

    string

    required

    Идентификатор аккаунта

  • order_id

    string

    required

    Идентификатор заявки

Responses

200A successful response.
401Срок действия токена истек или токен недействителен
404Счёт или заявка не были найдены
429Слишком много запросов. Доступный лимит - 200 запросов в минуту
500Внутренняя ошибка сервиса. Попробуйте позже
503Сервис на данный момент не доступен. Попробуйте позже
504Крайний срок истек до завершения операции
defaultAn unexpected error response.

A successful response.

|View as Markdown

DELETEОтмена биржевой заявки

/v1/accounts/{account_id}/orders/{order_id}

Path Parameters

  • account_id

    string

    required

    Идентификатор аккаунта

  • order_id

    string

    required

    Идентификатор заявки

Responses

200A successful response.
400Заявка не может быть отменена так как она уже исполнена
401Срок действия токена истек или токен недействителен
404Счёт или заявка не были найдены
429Слишком много запросов. Доступный лимит - 200 запросов в минуту
500Внутренняя ошибка сервиса. Попробуйте позже
503Сервис на данный момент не доступен. Попробуйте позже
504Крайний срок истек до завершения операции
defaultAn unexpected error response.

A successful response.

|View as Markdown

POSTВыставление SL/TP заявки

/v1/accounts/{account_id}/sltp-orders

{ "symbol": "SBER@MISX", "side": "SIDE_BUY", "quantity_sl": { "value": "10" }, "sl_price": { "value": "270.00" }, "limit_price": { "value": "269.50" }, "quantity_tp": { "value": "10" }, "tp_price": { "value": "295.50" }, "tp_guard_spread": { "value": "0.5" }, "tp_spread_measure": "TP_SPREAD_MEASURE_VALUE", "valid_before": "VALID_BEFORE_GOOD_TILL_DATE", "valid_expiry_time": "2026-12-31T23:59:59Z", "comment": "my SL/TP order" } Поле account_id берется из URL-пути, остальные поля передаются в теле запроса

Path Parameters

  • account_id

    string

    required

    Идентификатор аккаунта

Request Body

  • symbol

    string

  • side

    enum

    - SIDE_UNSPECIFIED: Сторона сделки не указана - SIDE_BUY: Покупка - SIDE_SELL: Продажа

  • quantity_sl

    object

    A representation of a decimal value, such as 2.5. Clients may convert values into language-native decimal formats, such as Java's [BigDecimal][] or Python's [decimal.Decimal][]. [BigDecimal]: https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/math/BigDecimal.html [decimal.Decimal]: https://docs.python.org/3/library/decimal.html

  • sl_price

    object

    A representation of a decimal value, such as 2.5. Clients may convert values into language-native decimal formats, such as Java's [BigDecimal][] or Python's [decimal.Decimal][]. [BigDecimal]: https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/math/BigDecimal.html [decimal.Decimal]: https://docs.python.org/3/library/decimal.html

  • limit_price

    object

    A representation of a decimal value, such as 2.5. Clients may convert values into language-native decimal formats, such as Java's [BigDecimal][] or Python's [decimal.Decimal][]. [BigDecimal]: https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/math/BigDecimal.html [decimal.Decimal]: https://docs.python.org/3/library/decimal.html

  • quantity_tp

    object

    A representation of a decimal value, such as 2.5. Clients may convert values into language-native decimal formats, such as Java's [BigDecimal][] or Python's [decimal.Decimal][]. [BigDecimal]: https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/math/BigDecimal.html [decimal.Decimal]: https://docs.python.org/3/library/decimal.html

  • tp_price

    object

    A representation of a decimal value, such as 2.5. Clients may convert values into language-native decimal formats, such as Java's [BigDecimal][] or Python's [decimal.Decimal][]. [BigDecimal]: https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/math/BigDecimal.html [decimal.Decimal]: https://docs.python.org/3/library/decimal.html

  • tp_guard_spread

    object

    A representation of a decimal value, such as 2.5. Clients may convert values into language-native decimal formats, such as Java's [BigDecimal][] or Python's [decimal.Decimal][]. [BigDecimal]: https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/math/BigDecimal.html [decimal.Decimal]: https://docs.python.org/3/library/decimal.html

  • tp_spread_measure

    enum

    - TP_SPREAD_MEASURE_UNDEFINED: Значение не указано - TP_SPREAD_MEASURE_VALUE: в единицах цены - TP_SPREAD_MEASURE_PERCENT: в процентах, с максимальной точностью до сотых процента

  • client_order_id

    string

  • valid_before

    enum

    - VALID_BEFORE_UNSPECIFIED: Значение не указано - VALID_BEFORE_END_OF_DAY: До конца торгового дня - VALID_BEFORE_GOOD_TILL_CANCEL: До отмены - VALID_BEFORE_GOOD_TILL_DATE: До указанной даты-времени. Данный тип поддерживается только при выставлении SL/TP заявок

  • valid_expiry_time

    string

  • comment

    string

Responses

200A successful response.
400Неверно переданы торговые параметры
401Срок действия токена истек или токен недействителен
404Счёт или инструмент не были найдены
429Слишком много запросов. Доступный лимит - 200 запросов в минуту
500Внутренняя ошибка сервиса. Попробуйте позже
503Сервис на данный момент не доступен. Попробуйте позже
504Крайний срок истек до завершения операции
defaultAn unexpected error response.

A successful response.

|View as Markdown

GETПолучение исторических данных по инструменту (агрегированные свечи)

/v1/instruments/{symbol}/bars

Параметры: - symbol - передается в URL пути - timeframe и interval - передаются как query-параметры

Path Parameters

  • symbol

    string

    required

    Символ инструмента

Query Parameters

  • timeframe

    string

    Необходимый таймфрейм - TIME_FRAME_UNSPECIFIED: Таймфрейм не указан - TIME_FRAME_M1: 1 минута. Глубина данных 7 дней. - TIME_FRAME_M5: 5 минут. Глубина данных 30 дней. - TIME_FRAME_M15: 15 минут. Глубина данных 30 дней. - TIME_FRAME_M30: 30 минут. Глубина данных 30 дней. - TIME_FRAME_H1: 1 час. Глубина данных 30 дней. - TIME_FRAME_H2: 2 часа. Глубина данных 30 дней. - TIME_FRAME_H4: 4 часа. Глубина данных 30 дней. - TIME_FRAME_H8: 8 часов. Глубина данных 30 дней. - TIME_FRAME_D: День. Глубина данных 365 дней. - TIME_FRAME_W: Неделя. Глубина данных 365*5 дней. - TIME_FRAME_MN: Месяц. Глубина данных 365*5 дней. - TIME_FRAME_QR: Квартал. Глубина данных 365*5 дней.

  • interval.start_time

    string

    Optional. Inclusive start of the interval. If specified, a Timestamp matching this interval will have to be the same or after the start.

  • interval.end_time

    string

    Optional. Exclusive end of the interval. If specified, a Timestamp matching this interval will have to be before the end.

Responses

200A successful response.
400Неверно передан символ или интервал. Символ должен быть в виде ticker@mic. Где ticker - это, например, SBER. А mic, например, MISX
401Срок действия токена истек или токен недействителен
404Счёт не был найден в токене
429Слишком много запросов. Доступный лимит - 200 запросов в минуту
500Внутренняя ошибка сервиса. Попробуйте позже
503Сервис на данный момент не доступен. Попробуйте позже
504Крайний срок истек до завершения операции
defaultAn unexpected error response.

A successful response.

|View as Markdown

GETПолучение текущего стакана по инструменту

/v1/instruments/{symbol}/orderbook

Path Parameters

  • symbol

    string

    required

    Символ инструмента

Responses

200A successful response.
401Срок действия токена истек или токен недействителен
404Счёт не был найден в токене
429Слишком много запросов. Доступный лимит - 200 запросов в минуту
500Внутренняя ошибка сервиса. Попробуйте позже
503Сервис на данный момент не доступен. Попробуйте позже
504Крайний срок истек до завершения операции
defaultAn unexpected error response.

A successful response.

|View as Markdown

GETПолучение последней котировки по инструменту

/v1/instruments/{symbol}/quotes/latest

Path Parameters

  • symbol

    string

    required

    Символ инструмента

Responses

200A successful response.
401Срок действия токена истек или токен недействителен
404Счёт не был найден в токене
429Слишком много запросов. Доступный лимит - 200 запросов в минуту
500Внутренняя ошибка сервиса. Попробуйте позже
503Сервис на данный момент не доступен. Попробуйте позже
504Крайний срок истек до завершения операции
defaultAn unexpected error response.

A successful response.

|View as Markdown

GETПолучение списка последних сделок по инструменту

/v1/instruments/{symbol}/trades/latest

Path Parameters

  • symbol

    string

    required

    Символ инструмента

Responses

200A successful response.
401Срок действия токена истек или токен недействителен
404Счёт не был найден в токене
429Слишком много запросов. Доступный лимит - 200 запросов в минуту
500Внутренняя ошибка сервиса. Попробуйте позже
503Сервис на данный момент не доступен. Попробуйте позже
504Крайний срок истек до завершения операции
defaultAn unexpected error response.

A successful response.

|View as Markdown

GETПолучение списка доступных для торговли инструментов, их описание

/v1/assets

Responses

200A successful response.
401Срок действия токена истек или токен недействителен
404Счёт не был найден в токене
429Слишком много запросов. Доступный лимит - 200 запросов в минуту
500Внутренняя ошибка сервиса. Попробуйте позже
503Сервис на данный момент не доступен. Попробуйте позже
504Крайний срок истек до завершения операции
defaultAn unexpected error response.

A successful response.

|View as Markdown

GETПолучение списка всех инструментов, в том числе индикативных и архивных, их описание

/v1/assets/all

Query Parameters

  • cursor

    string

    Курсор для пагинации. Указывает sec_id инструмента, с которого должен начинаться список. Для первого запроса оставьте поле пустым (значение 0). Для последующих запросов используйте значение next_cursor из предыдущего ответа.

  • only_active

    boolean

    Фильтрация по статусу инструмента: выбираются только активные(неархивные) инструменты По умолчанию: false.

  • only_disabled

    boolean

    Фильтрация по статусу инструмента: выбираются только неактивные(архивные) инструменты По умолчанию: false.

Responses

200A successful response.
401Срок действия токена истек или токен недействителен
404Счёт не был найден в токене
429Слишком много запросов. Доступный лимит - 200 запросов в минуту
500Внутренняя ошибка сервиса. Попробуйте позже
503Сервис на данный момент не доступен. Попробуйте позже
504Крайний срок истек до завершения операции
defaultAn unexpected error response.

A successful response.

|View as Markdown

GETПолучение времени на сервере

/v1/assets/clock

Responses

200A successful response.
401Срок действия токена истек или токен недействителен
404Счёт не был найден в токене
429Слишком много запросов. Доступный лимит - 200 запросов в минуту
500Внутренняя ошибка сервиса. Попробуйте позже
503Сервис на данный момент не доступен. Попробуйте позже
504Крайний срок истек до завершения операции
defaultAn unexpected error response.

A successful response.

|View as Markdown

GETПолучение информации по конкретному инструменту

/v1/assets/{symbol}

Параметры: - symbol - передается в URL пути - account_id - передаётся как query-параметр

Path Parameters

  • symbol

    string

    required

    Символ инструмента

Query Parameters

  • account_id

    string

    ID аккаунта для которого будет подбираться информация по инструменту

Responses

200A successful response.
400Неверно передан символ или счет. Символ должен быть в виде ticker@mic. Где ticker - это, например, SBER. А mic, например, MISX
401Срок действия токена истек или токен недействителен
404Счёт не был найден в токене
429Слишком много запросов. Доступный лимит - 200 запросов в минуту
500Внутренняя ошибка сервиса. Попробуйте позже
503Сервис на данный момент не доступен. Попробуйте позже
504Крайний срок истек до завершения операции
defaultAn unexpected error response.

A successful response.

|View as Markdown

GETПолучить состав биржевого индекса по его символу

/v1/assets/{symbol}/constituents

Path Parameters

  • symbol

    string

    required

    Символьный код индекса (например, "SPX@_SP", "NDX@_SCI")

Query Parameters

  • cursor

    string

    Курсор для пагинации. Указывает sec_id инструмента, с которого должен начинаться список. Для первого запроса оставьте поле пустым (значение 0). Для последующих запросов используйте значение next_cursor из предыдущего ответа.

Responses

200A successful response.
401Срок действия токена истек или токен недействителен
404Счёт не был найден в токене
429Слишком много запросов. Доступный лимит - 200 запросов в минуту
500Внутренняя ошибка сервиса. Попробуйте позже
503Сервис на данный момент не доступен. Попробуйте позже
504Крайний срок истек до завершения операции
defaultAn unexpected error response.

A successful response.

|View as Markdown

GETПолучение торговых параметров по инструменту

/v1/assets/{symbol}/params

Параметры: - symbol - передается в URL пути - account_id - передаётся как query-параметр

Path Parameters

  • symbol

    string

    required

    Символ инструмента

Query Parameters

  • account_id

    string

    ID аккаунта для которого будут подбираться торговые параметры

Responses

200A successful response.
400Неверно передан символ или счет. Символ должен быть в виде ticker@mic. Где ticker - это, например, SBER. А mic, например, MISX
401Срок действия токена истек или токен недействителен
404Счёт не был найден в токене
429Слишком много запросов. Доступный лимит - 200 запросов в минуту
500Внутренняя ошибка сервиса. Попробуйте позже
503Сервис на данный момент не доступен. Попробуйте позже
504Крайний срок истек до завершения операции
defaultAn unexpected error response.

A successful response.

|View as Markdown

GETПолучение расписания торгов для инструмента

/v1/assets/{symbol}/schedule

Path Parameters

  • symbol

    string

    required

    Символ инструмента

Responses

200A successful response.
400Неверно передан символ. Символ должен быть в виде ticker@mic. Где ticker - это, например, SBER. А mic, например, MISX
401Срок действия токена истек или токен недействителен
404Счёт не был найден в токене
429Слишком много запросов. Доступный лимит - 200 запросов в минуту
500Внутренняя ошибка сервиса. Попробуйте позже
503Сервис на данный момент не доступен. Попробуйте позже
504Крайний срок истек до завершения операции
defaultAn unexpected error response.

A successful response.

|View as Markdown

GETПолучение цепочки опционов для базового актива

/v1/assets/{underlying_symbol}/options

Path Parameters

  • underlying_symbol

    string

    required

    Символ базового актива опциона

Query Parameters

  • root

    string

    Опциональный параметр. Актуален для опционов на фьючерсы, по типу (недельные, месячные). Если параметр не указан, будут возвращены опционы с ближайшей датой экспирации.

  • expiration_date.year

    integer

    Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.

  • expiration_date.month

    integer

    Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.

  • expiration_date.day

    integer

    Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.

Responses

200A successful response.
400Неверно передан символ. Символ должен быть в виде ticker@mic. Где ticker - это, например, SBER. А mic, например, MISX
401Срок действия токена истек или токен недействителен
404Счёт не был найден в токене
429Слишком много запросов. Доступный лимит - 200 запросов в минуту
500Внутренняя ошибка сервиса. Попробуйте позже
503Сервис на данный момент не доступен. Попробуйте позже
504Крайний срок истек до завершения операции
defaultAn unexpected error response.

A successful response.

|View as Markdown

GETПолучение списка доступных бирж, названия и mic коды

/v1/exchanges

Responses

200A successful response.
401Срок действия токена истек или токен недействителен
404Счёт не был найден в токене
429Слишком много запросов. Доступный лимит - 200 запросов в минуту
500Внутренняя ошибка сервиса. Попробуйте позже
503Сервис на данный момент не доступен. Попробуйте позже
504Крайний срок истек до завершения операции
defaultAn unexpected error response.

A successful response.

|View as Markdown

GETПолучение текущих метрик использования для пользователя

/v1/usage

Responses

200A successful response.
401Срок действия токена истек или токен недействителен
404Счёт не был найден в токене
429Слишком много запросов. Доступный лимит - 200 запросов в минуту
500Внутренняя ошибка сервиса. Попробуйте позже
503Сервис на данный момент не доступен. Попробуйте позже
504Крайний срок истек до завершения операции
defaultAn unexpected error response.

A successful response.

|View as Markdown

POSTЗапустить генерацию отчета по счету за период

/v1/report

Request Body

  • date_range

    object

  • report_form

    enum

    - REPORT_FORM_UNKNOWN: Не указана - REPORT_FORM_SHORT: Краткая - REPORT_FORM_LONG: Полная

  • account_id

    string

Responses

200A successful response.
401Срок действия токена истек или токен недействителен
404Счёт не был найден в токене
429Слишком много запросов. Доступный лимит - 200 запросов в минуту
500Внутренняя ошибка сервиса. Попробуйте позже
503Сервис на данный момент не доступен. Попробуйте позже
504Крайний срок истек до завершения операции
defaultAn unexpected error response.

A successful response.

|View as Markdown

GETПолучение информации о результате генерации отчета по счету

/v1/report/{report_id}/info

Path Parameters

  • report_id

    string

    required

    Идентификатор отчёта

Responses

200A successful response.
401Срок действия токена истек или токен недействителен
404Счёт не был найден в токене
429Слишком много запросов. Доступный лимит - 200 запросов в минуту
500Внутренняя ошибка сервиса. Попробуйте позже
503Сервис на данный момент не доступен. Попробуйте позже
504Крайний срок истек до завершения операции
defaultAn unexpected error response.

A successful response.