Update Limit 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.

Exchange restrictions

Due to restriction imposed by the Exchange, the parameters side and symbol will not be included in the change of orders related to the derivatives market. The restriction does not apply to initial placing of derivatives orders and change of orders at other markets.

The request creates a new limit order with changed characteristics, automatically canceling the previously created one. To specify the order to be canceled, use its number in the orderid parameter.

---

Request

To modify an order, send a message to the established WebSocket connection with the operation code update:limit containing the new order details.

Request body

{
  "opcode": "update:limit",
  "guid": "c328fcf1-e495-408a-a0ed-e20f95d6b813",
  "orderId": "18995978560",
  "side": "buy",
  "quantity": 300,
  "price": 142.52,
  "instrument": {
    "symbol": "SBER",
    "exchange": "MOEX",
    "instrumentGroup": "TQBR"
  },
  "comment": "First order",
  "user": {
    "portfolio": "D39004"
  },
  "allowMargin": false,
  "icebergFixed": 100,
  "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

sidestringrequired

Transaction side:

• buy
• sell

Example: buy

quantityint32required

Number of lots

Example: 300

pricedecimalrequired

Price

Example: 142.52

instrument

object

Security data

symbolstringrequired

Security code (Ticker)

Example: SBER

exchangestringrequired

Exchange code:

• MOEX — Moscow Exchange
• SPBX — SPB Exchange

Example: MOEX

instrumentGroupstring

Trading mode code (Board):

• List of Moscow Exchange codes is available in table
• SPB Exchange securities always have SPBX code

Example: TQBR

commentstring

Custom order comment. Maximum comment length is limited by 100 characters

Example: First order

user

object

User data

portfoliostringrequired

Client portfolio ID

Example: D39004

allowMarginboolean

A flag that confirms that the Initial Risk Level Customer (IRLC) agrees to submit an order with a potentially uncovered position. Must be true to place a margin position order on behalf of the IRLC. Otherwise the server will return an error stating that there is no confirmation of consent to open a margin position.n The flag is ignored in the derivatives market and for other risk level clients.

Example: false

icebergFixedint32

The visible constant part of the iceberg order in lots. Must be filled at the order creation, can be changed later but only for orders created on stock and money markets

Example: 100

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 has been updated. New order ID is '12346'.",
  "orderNumber": "12346"
}

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 has been updated. New order ID is '12346'.

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