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

Collateral

Conditional orders do not require collateral, but limit and market orders placed by them do. Ensure that at the time the conditional order is triggered, there will be sufficient funds in the portfolio to ensure the exchange order being placed using order estimation request.

The request creates a stop order with the parameters defined in the message body for the specified portfolio.

---

Request

To create an order, send a message to the established WebSocket connection with the operation code create:stop containing the details of this order.

Request body

{
  "opcode": "create:stop",
  "guid": "c328fcf1-e495-408a-a0ed-e20f95d6b813",
  "side": "buy",
  "quantity": 300,
  "condition": "LessOrEqual",
  "triggerPrice": 191.33,
  "stopEndUnixTime": 1590094740,
  "instrument": {
    "symbol": "SBER",
    "exchange": "MOEX",
    "instrumentGroup": "TQBR"
  },
  "user": {
    "portfolio": "D39004"
  },
  "allowMargin": false,
  "checkDuplicates": true,
  "protectingSeconds": 15,
  "comment": "First order",
  "activate": 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

quantityint32required

Number of lots

Example: 300

conditionstringrequired

Triggering condition for stop and stop limit orders:

• More — Current price is higher that trigger price
• Less — Current price is lower than trigger price
• MoreOrEqual — Current price is higher or equal to the trigger price
• LessOrEqual — Current price is lower or equal to the trigger price

Example: LessOrEqual

triggerPricedecimalrequired

Trigger price for stop and stop limit orders

Example: 191.33

stopEndUnixTimeint64

Validity time (UTC) in Unix Time Seconds format

Example: 1590094740

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

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

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

protectingSecondsint32
Protective time. Continuous period of time in seconds, during which the market price of the instrument must satisfy the price and triggering condition specified in the order (triggerPrice and condition). It is intended to protect conditional orders from triggering on short-term price fluctuations.
Example: 15
Example: 15
commentstring

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

Example: First order

activateboolean

Flag to specify whether to create an active or inactive order. An inactive order is displayed in the system, but does not react to the price level until it becomes active. This flag is required when creating a group of orders with the TriggerBracketOrders type

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 created.",
  "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 created.

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