История цен (свечи)
Запрос нельзя выполнить анонимно. Обязательный параметр token
должен содержать актуальный Access Токен.
Запрос создаёт подписку на получение исторических данных о ценовых показателях (свечах) финансового инструмента на выбранной бирже за указанный период времени.
Запрос
Для создания подписки на информационный канал отправьте в установленное WebSocket-соединение сообщение с телом запроса, содержащим детали создаваемой подписки.
- Тело запроса
- Схема
{
"opcode": "BarsGetAndSubscribe",
"code": "SBER",
"tf": "60",
"from": 1536557084,
"skipHistory": false,
"splitAdjust": true,
"exchange": "MOEX",
"instrumentGroup": "TQBR",
"format": "Simple",
"frequency": 100,
"guid": "c328fcf1-e495-408a-a0ed-e20f95d6b813",
"token": "eyJhbGciOiJ..."
}
Параметры тела запроса
OrderBookGetAndSubscribe
— Подписка на биржевой стаканBarsGetAndSubscribe
— Подписка на историю цен (свечи)QuotesSubscribe
— Подписка на информацию о котировкахInstrumentsGetAndSubscribeV2
— Подписка на изменение информации о финансовых инструментах на выбранной биржеAllTradesGetAndSubscribe
— Подписка на все сделкиPositionsGetAndSubscribeV2
— Подписка на информацию о текущих позициях по торговым инструментам и деньгамSummariesGetAndSubscribeV2
— Подписка на сводную информацию по портфелюRisksGetAndSubscribe
— Подписка на сводную информацию по портфельным рискамSpectraRisksGetAndSubscribe
— Подписка на информацию по рискам срочного рынка (FORTS)TradesGetAndSubscribeV2
— Подписка на информацию о сделкахOrdersGetAndSubscribeV2
— Подписка на информацию о текущих заявках на рынке для выбранных биржи и финансового инструментаStopOrdersGetAndSubscribeV2
— Подписка на информацию о текущих заявках на рынке для выбранных биржи и финансового инструментаunsubscribe
— Отмена существующей подписки15
— 15 секунд60
— 60 секунд или 1 минута3600
— 3600 секунд или 1 часD
— сутки (соответствует значению 86400)W
— неделя (соответствует значению 604800)M
— месяц (соответствует значению 2592000)Y
— год (соответствует значению 31536000)true
— отображать только новые данныеfalse
— отображать в том числе данные из историиtrue
— свечи пересчитываются с учётом дополнительных факторовfalse
— свечи отображаются как есть, т.е. без корректировкиMOEX
— Московская БиржаSPBX
— СПБ Биржа- Для Московской Биржи список кодов доступен в таблице
- Для Биржи СПБ всегда SPBX
Simple
— оригинальный формат данных. Поддерживает устаревшие параметры для обеспечения обратной совместимостиSlim
— облегчённый формат данных для быстрой передачи сообщений. Не поддерживает устаревшие параметрыHeavy
— полный формат данных, развивающийся и дополняющийся новыми полями. Не поддерживает устаревшие параметрыSimple
— 25 миллисекундSlim
— 10 миллисекундHeavy
— 500 миллисекунд
Код выполняемой операции:
Тикер (Код финансового инструмента)
Пример: SBER
Длительность таймфрейма. В качестве значения можно указать точное количество секунд или код таймфрейма:
Пример: 60
Дата и время (UTC) для первой запрашиваемой свечи
Пример: 1536557084
Флаг отсеивания исторических данных:
Пример: false
Флаг коррекции исторических свечей инструмента с учётом сплитов, консолидаций и прочих факторов.
Пример: true
Биржа:
Пример: MOEX
Код режима торгов (Борд):
Пример: TQBR
Формат возвращаемого сервером JSON-объекта:
От формата объекта также зависит минимальное значение параметра frequency
для WebSocket-подписок.
Пример: Simple
Частота (интервал) передачи данных сервером. Сервер вернёт последние данные по запросу за тот временной интервал, который указан в качестве значения параметра. Пример: биржа передаёт данные каждые 2 мс, но, при значении параметра 10 мс, сервер вернёт только последнее значение, отбросив предыдущие.
Минимальное значение параметра зависит от выбранного формата возвращаемого JSON-объекта:
Пример: 100
Уникальный идентификатор запроса. Все ответные сообщения будут иметь такое же значение поля guid
Пример: c328fcf1-e495-408a-a0ed-e20f95d6b813
Access Токен для авторизации запроса
Пример: eyJhbGciOiJ...
Ответы
Содержимое ответа, возвращаемого в WebSocket-соединение, зависит от результатов обработки запроса:
- Если запрос обработан успешно, сервер передаст в ответ одно сообщение с кодом
200
, подтверждающее создание подписки, после чего начнёт передачу сообщений с кодом100
, содержащих запрошенную в рамках подписки информацию. - Если обработка запроса завершилась неудачей, сервер передаст в ответ одно сообщение с кодом ошибки, соответствующим причине отказа, после чего закроет WebSocket-соединение.
- 100
- 200
- 401
Сообщения от канала, содержащие в себе информацию, запрошенную в рамках подписки
- Формат Simple
- Формат Slim
- Формат Heavy
- Тело ответа
- Схема
{
"data": {
"time": 1537529040,
"close": 192.15,
"open": 192.18,
"high": 192.2,
"low": 192.15,
"volume": 1960
},
"guid": "c328fcf1-e495-408a-a0ed-e20f95d6b813"
}
Параметры тела ответа
data
object
Блок данных от информационного канала
Время (UTC) (Unix time seconds)
Пример: 1537529040
Цена при закрытии
Пример: 192.15
Цена при открытии
Пример: 192.18
Максимальная цена
Пример: 192.2
Минимальная цена
Пример: 192.15
Объём
Пример: 1960
Уникальный идентификатор запроса. Все ответные сообщения будут иметь такое же значение поля guid
Пример: c328fcf1-e495-408a-a0ed-e20f95d6b813
- Тело ответа
- Схема
{
"data": {
"t": 1537529040,
"c": 192.15,
"o": 192.18,
"h": 192.2,
"l": 192.15,
"v": 1960
},
"guid": "c328fcf1-e495-408a-a0ed-e20f95d6b813"
}
Параметры тела ответа
data
object
Блок данных от информационного канала
Время (UTC) (Unix time seconds)
Пример: 1537529040
Цена при закрытии
Пример: 192.15
Цена при открытии
Пример: 192.18
Максимальная цена
Пример: 192.2
Минимальная цена
Пример: 192.15
Объём
Пример: 1960
Уникальный идентификатор запроса. Все ответные сообщения будут иметь такое же значение поля guid
Пример: c328fcf1-e495-408a-a0ed-e20f95d6b813
- Тело ответа
- Схема
{
"data": {
"time": 1537529040,
"close": 192.15,
"open": 192.18,
"high": 192.2,
"low": 192.15,
"volume": 1960
},
"guid": "c328fcf1-e495-408a-a0ed-e20f95d6b813"
}
Параметры тела ответа
data
object
Блок данных от информационного канала
Время (UTC) (Unix time seconds)
Пример: 1537529040
Цена при закрытии
Пример: 192.15
Цена при открытии
Пример: 192.18
Максимальная цена
Пример: 192.2
Минимальная цена
Пример: 192.15
Объём
Пример: 1960
Уникальный идентификатор запроса. Все ответные сообщения будут иметь такое же значение поля guid
Пример: c328fcf1-e495-408a-a0ed-e20f95d6b813
Сообщение об успешной обработке запроса на подписку
- Тело ответа
- Схема
{
"message": "Handled successfully",
"httpCode": 200,
"requestGuid": "c328fcf1-e495-408a-a0ed-e20f95d6b813"
}
Параметры тела ответа
Текстовое представление возвращаемого сообщения
Пример: Handled successfully
Код возвращаемого сообщения
Пример: 200
Уникальный идентификатор запроса. Значением выступает параметр guid
, указанный в теле запроса
Пример: c328fcf1-e495-408a-a0ed-e20f95d6b813
Не удалось авторизовать запрос — Access Токен не указан в теле запроса, срок его действия истёк или он относится к другому контуру системы
- Тело ответа
- Схема
{
"requestGuid": "c328fcf1-e495-408a-a0ed-e20f95d6b813",
"httpCode": 401,
"message": "Invalid JWT token!"
}
Параметры тела ответа
Уникальный идентификатор запроса. Значением выступает параметр guid
, указанный в теле запроса
Пример: c328fcf1-e495-408a-a0ed-e20f95d6b813
Код возвращаемого сообщения
Пример: 401
Текстовое представление возвращаемого сообщения
Пример: Invalid JWT token!