Update Limit order

Private resource

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

HTTP API

This operation can be performed with request to HTTP API.

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"
  },
  "comment": "First order",
  "board": "TQBR",
  "user": {
    "portfolio": "D39004"
  },
  "timeInForce": "oneday",
  "icebergFixed": 100,
  "icebergVariance": 2,
  "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

commentstring

Custom comment

Example: First order

boardstring

Trading mode code (Board):

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

Example: TQBR

user

object

User data

portfoliostringrequired

Client portfolio ID

Example: D39004

timeInForcestring

Order validity type:

• OneDay — Fulfill the order or keep it active till the end of the trading day
• ImmediateOrCancel — Partially fulfill the order and cancel the unfulfilled balance
• FillOrKill — Fulfill completely or cancel the entire order
• GoodTillCancelled — Fulfill the order or keep it until cancelation

Example: OneDay

icebergFixedint32

The visible constant part of the iceberg order in lots set out at the order creation

Example: 100

icebergVarianceint32

The deviation amplitude (% of icebergFixed) of the random increment to the visible part of the iceberg order set out at the order creation. Derivatives only

Example: 2

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.

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