Снятие стоп-заявки

Требуется авторизация

Используемое WebSocket-соединение должно быть предварительно авторизовано с помощью запроса на авторизацию.

HTTP API

Для этой операции есть альтернативный HTTP-запрос.

Запрос снимает выставленную ранее стоп-заявку. Для определения отменяемой заявки используется её номер в параметре orderid.

---

Запрос

Для снятия заявки отправьте в установленное WebSocket-соединение сообщение с кодом операции delete:stop, содержащее номер отменяемой заявки.

Тело запроса

{
  "opcode": "delete:stop",
  "guid": "c328fcf1-e495-408a-a0ed-e20f95d6b813",
  "orderId": "18995978560",
  "exchange": "MOEX",
  "user": {
    "portfolio": "D39004"
  },
  "checkDuplicates": true
}

Схема

Параметры тела запроса

opcodestringrequired
Код выполняемой операции:
• authorize — Авторизация WebSocket-соединения
• create:market — Создание рыночной заявки
• create:limit — Создание лимитной заявки
• create:stop — Создание стоп-заявки
• create:stopLimit — Создание стоп-лимитной заявки
• update:market — Изменение рыночной заявки
• update:limit — Изменение лимитной заявки
• update:stop — Изменение стоп-заявки
• update:stopLimit — Изменение стоп-лимитной заявки
• delete:market — Снятие рыночной заявки
• delete:limit — Снятие лимитной заявки
• delete:stop — Снятие стоп-заявки
• delete:stopLimit — Снятие стоп-лимитной заявки
guidstringrequired

Уникальный идентификатор запроса. Все ответные сообщения будут иметь такое же значение поля guid

Пример: c328fcf1-e495-408a-a0ed-e20f95d6b813

sidestringrequired

Направление сделки:

• buy — Покупка
• sell — Продажа

Пример: buy

exchangestringrequired

Биржа:

• MOEX — Московская Биржа
• SPBX — СПБ Биржа

Пример: MOEX

user

object

Данные о пользователе, от чьего имени создаётся заявка

portfoliostringrequired

Идентификатор клиентского портфеля

Пример: D39004

checkDuplicatesboolean

Флаг, отвечающий за проверку уникальности команд. По умолчанию включен, препятствуя случайному множественному выполнению одного и того же запроса. При отключении ускоряет обработку запроса.

Пример: true

---

Ответы

В зависимости от результатов обработки полученного запроса сервер вернёт в WebSocket-соединение сообщение с соответствующим кодом ответа.

200

Сообщение об успешной обработке запроса

Тело ответа

{
  "requestGuid": "c328fcf1-e495-408a-a0ed-e20f95d6b813",
  "httpCode": 200,
  "message": "An order '12345' has been deleted.",
  "orderNumber": "12345"
}

Схема

Параметры тела ответа

requestGuidstring

Уникальный идентификатор запроса. Значением выступает параметр guid, указанный в теле запроса

Пример: c328fcf1-e495-408a-a0ed-e20f95d6b813

httpCodeint32

Код возвращаемого сообщения

Пример: 200

messagestring

Текстовое представление возвращаемого сообщения

Пример: An order '12345' has been deleted.

orderNumberstring

Уникальный идентификатор заявки

Пример: "12346"

400

Не удалось обработать запрос. Проверьте корректность переданного сообщения и повторите попытку.

Тело ответа

{
  "requestGuid": "c328fcf1-e495-408a-a0ed-e20f95d6b813",
  "httpCode": 400,
  "message": "Invalid or unsupported quantity"
}

Схема

Параметры тела ответа

requestGuidstring

Уникальный идентификатор запроса. Значением выступает параметр guid, указанный в теле запроса

Пример: c328fcf1-e495-408a-a0ed-e20f95d6b813

httpCodeint32

Код возвращаемого сообщения

Пример: 400

messagestring

Текстовое представление возвращаемого сообщения

Пример: Invalid or unsupported quantity