Cancel Stop order

Authorization

The WebSocket connection being used must be pre-authorized with authorization request.

Alternative request

The same operation can be performed using HTTP request.

The request cancels the previously posted stop order. To specify the order to be canceled, use its number in the orderid parameter.

---

Request

To cancel an order, send to the established WebSocket connection a message with the operation code delete:stop containing the number of the order to be canceled.

Request body

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

Schema

Request body parameters

opcodestringrequired
Operation code:
• authorize — Authorization of WebSocket connection
• create:market — Creation of market order
• create:limit — Creation of limit order
• create:stop — Creation of stop order
• create:stopLimit — Creation of stop limit order
• update:market — Modification of market order
• update:limit — Modification of limit order
• update:stop — Modification of stop order
• update:stopLimit — Modification of stop limit order
• delete:market — Cancelation of market order
• delete:limit — Cancelation of limit order
• delete:stop — Cancelation of stop order
• delete:stopLimit — Cancelation of stop limit order
guidstringrequired

The unique identifier of the operation. All incoming messages related to this operation will have this guid field value

Example: c328fcf1-e495-408a-a0ed-e20f95d6b813

sidestringrequired

Transaction side:

• buy
• sell

Example: buy

exchangestringrequired

Exchange code:

• MOEX — Moscow Exchange
• SPBX — SPB Exchange

Example: MOEX

user

object

User data

portfoliostringrequired

Client portfolio ID

Example: D39004

checkDuplicatesboolean

Flag for checking the uniqueness of commands. It is enabled by default, preventing spamming with similar commands. When disabled, speeds up request processing.

Example: true

---

Responses

According to the results of processing the received request, the server will return a message with the corresponding code to the WebSocket connection.

Messages

200

Successful request processing report

Body

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

Schema

Response body parameters

requestGuidstring

The unique identifier of the operation. All incoming messages related to this operation will have this guid field value

Example: c328fcf1-e495-408a-a0ed-e20f95d6b813

httpCodeint32

Response HTTP code

Example: 200

messagestring

Text description of the returned HTTP code

Example: An order '12345' has been deleted.

orderNumberstring

Unique order ID

Example: "12346"

400

Failed to process the request. Check the validity of the transmitted message and try again.

Body

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

Schema

Response body parameters

requestGuidstring

The unique identifier of the operation. All incoming messages related to this operation will have this guid field value

Example: c328fcf1-e495-408a-a0ed-e20f95d6b813

httpCodeint32

Response HTTP code

Example: 400

messagestring

Text description of the returned HTTP code

Example: Invalid or unsupported quantity