Незначительные исправления в документации

📢 Уважаемые клиенты! 📢

Делимся с Вами новостями о последних изменениях!

✏ В этом дайджесте:

• Исправлена ошибка в параметре condition
• Немного расширены описания параметров volume и currentVolume
• Дополнено описание параметра protectingSeconds
• Уточнены типы значений параметра id для запросов сделок

🔽 Подробнее — под катом! 🔽

---

Ошибка в параметре condition

В описание параметра condition закралась небольшая ошибка — возможные значения были записаны в стиле PascalCase (например, MoreOrEqual), когда система использует flatcase (например, moreorequal).

Разница кажется незначительной, но из-за неё возникали ошибки в стороннем ПО, т.к. система ожидала и возвращала значения целиком в нижнем регистре. Описание параметра приведено в соответствие с системными параметрами.

Влияет на запросы

HTTP

• /md/v2/Clients/{exchange}/{portfolio}/stoporders
• /md/v2/Clients/{exchange}/{portfolio}/stoporders/{orderId}
• /commandapi/warptrans/TRADE/v2/client/orders/actions/stop
• /commandapi/warptrans/TRADE/v2/client/orders/actions/stopLimit
• /commandapi/warptrans/TRADE/v2/client/orders/actions/stop/{stopOrderId}
• /commandapi/warptrans/TRADE/v2/client/orders/actions/stopLimit/{stopOrderId}

WebSocket-подписки

• StopOrdersGetAndSubscribeV2

WebSocket-команды

• create:stop
• create:stopLimit
• update:stop
• update:stopLimit

---

Описания volume и currentVolume

Внесены небольшие уточнения, что из себя представляют поля "Объём" в случае запросов на получение позиций и сделок. Новые значения рекомендуем посмотреть на страницах запросов.

Влияет на запросы

HTTP

• /md/v2/Clients/{exchange}/{portfolio}/positions
• /md/v2/Clients/{exchange}/{portfolio}/positions/{symbol}
• /md/v2/Clients/{exchange}/{portfolio}/trades
• /md/v2/Clients/{exchange}/{portfolio}/{symbol}/trades
• /md/stats/{exchange}/{portfolio}/history/trades
• /md/stats/{exchange}/{portfolio}/history/trades/{symbol}

WebSocket-подписки

• PositionsGetAndSubscribe

---

Описание protectingSeconds

Крошечное исправление, вдохновлённое вопросами от пользователей.

В описании параметра protectingSeconds упоминается цена срабатывания условной заявки, обозначенная параметром triggerPrice. Проблема в том, что этот параметр называется так только при создании заявки, тогда как в ответе на запрос списка заявок эта цена называется stopPrice. Для большей ясности оба имени цены срабатывания были внесены в описание параметра protectingSeconds.

Влияет на запросы

HTTP

• /md/v2/Clients/{exchange}/{portfolio}/stoporders
• /md/v2/Clients/{exchange}/{portfolio}/stoporders/{orderId}
• /commandapi/warptrans/TRADE/v2/client/orders/actions/stop
• /commandapi/warptrans/TRADE/v2/client/orders/actions/stopLimit
• /commandapi/warptrans/TRADE/v2/client/orders/actions/stop/{stopOrderId}
• /commandapi/warptrans/TRADE/v2/client/orders/actions/stopLimit/{stopOrderId}

WebSocket-подписки

• StopOrdersGetAndSubscribeV2

WebSocket-команды

• create:stop
• create:stopLimit
• update:stop
• update:stopLimit

---

Типы id

Система возвращает идентификатор сделки в двух типах значений: string для персонализированных (при запросе по портфелю) и long для анонимных (при запросе всей массы сделок). До недавнего момента это различие не было отражено в документации. Теперь отражено.

Влияет на запросы

HTTP

• /md/v2/Clients/{exchange}/{portfolio}/trades
• /md/v2/Clients/{exchange}/{portfolio}/{symbol}/trades
• /md/stats/{exchange}/{portfolio}/history/trades
• /md/stats/{exchange}/{portfolio}/history/trades/{symbol}

WebSocket-подписки

• TradesGetAndSubscribeV2
• AllTradesGetAndSubscribe

---

Если у вас возникли вопросы о работе системы, свяжитесь с нами любым удобным способом:

• 📧 Электронная почта support@alor.ru
• 🗃 Личный кабинет
• ☎ Горячая линия: 8 800 775-11-99, +7 495 980-24-98

Если у вас есть идеи по дальнейшему развитию системы, можете отправить их нам через портал Обратной связи.

Спасибо, что помогаете нам делать систему лучше!