Update Market 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 creates a new market 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:market containing the new order details.

Request body

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

Example: authorize

guidstringrequired

Unique request identifier. All response messages related to the request will have the same identifier value

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

orderIdint64required

Unique order ID

Example: 12345

sidestringrequired

Transaction side:

• buy
• sell

Example: buy

quantityint32required

Number of lots

Example: 300

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: true

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

timeInForcestring

Order placement condition considering the possibility of its execution:

• OneDay — Execute within one trading day. At the expiration of this term the unexecuted balance is withdrawn
• ImmediateOrCancel — Execute immediately for the entire available volume of counter orders. The unexecuted balance is canceled
• FillOrKill — Execute immediately for the whole specified volume without a balance. If execution without a balance is impossible — the order is canceled
• AtTheClose — Execution at market price prevailing at the moment of market close. Available only for SPBX (automatically converted to fillorkill on MOEX) and applicable only to market orders, as the order price depends on the market price at execution time
• GoodTillCancelled — Execute within the maximum available period supported by the exchange. For example, within one year for MOEX. Futures market only
• BookOrCancel — Passive order. Will be placed on the exchange only if its price or spread value is worse than similar indicators of counter orders

Example: OneDay

allowMarginboolean

Flag confirming the consent of a client with the initial risk level to place or modify an order whose execution may create or increase an uncovered position.

The flag is not carried over between requests — each request that requires confirmation must include its own allowMargin: true flag.

Must be true:

• for any placement or modification of exchange orders on the derivatives market, including closing previously opened positions;
• for placement or modification of exchange orders on the equity and currency markets if it results in opening a new uncovered position or increasing the deficit on an existing one;
• for placement or modification of conditional orders on any market.

May be false or omitted if:

• the client has been assigned a different risk level;
• the 100% collateral service is enabled.

Example: false

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

Unique request identifier. The value is the guid parameter specified in the request body

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'.

orderIdstringrequired

Unique order ID

Example: 12345

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

Unique request identifier. The value is the guid parameter specified in the request body

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