Skip to main content

private/advanced/create-order-list

REQUEST 

wss://stream.crypto.com/exchange/v1/user

private/advanced/create-order-listPrivate
Creates multiple advanced orders in a single request.

This call is asynchronous, so the response is simply a confirmation of the request.

The user.advanced.order subscription can be used to check when the orders are successfully created.

Request

Body

required
    id int64required

    Request id (echoed in response)

    method stringrequired

    Must be "private/advanced/create-order-list"

    nonce int64required

    Current timestamp in milliseconds, e.g. "1771761038000".

    params objectrequired
    order_list object[]required
    Possible values: >= 1, <= 10
    Array of trigger orders to create (max 10). Each order must be STOP_LOSS, STOP_LIMIT, TAKE_PROFIT, or TAKE_PROFIT_LIMIT.
  • Array [
  • instrument_name stringrequired

    Instrument symbol, e.g. BTCUSD-PERP

    side WsOrderSide (string)required

    Possible values: [BUY, SELL]

    BUY or SELL

    quantity decimalrequired

    Order quantity. For MARKET BUY can use notional instead.

    client_oid string

    Client order ID (max 36 chars). Recommended for correlation.

    time_in_force WsTimeInForce (string)

    Possible values: [GOOD_TILL_CANCEL, IMMEDIATE_OR_CANCEL, FILL_OR_KILL]

    Time in force

    exec_inst WsExecInstCreateOrder (string)[]

    Possible values: [POST_ONLY, REDUCE_ONLY, SMART_POST_ONLY, ISOLATED_MARGIN, MARGIN_ORDER]

    Optional array of execution instructions. POST_ONLY and SMART_POST_ONLY mutually exclusive.

    fee_instrument_name string

    Fee instrument (e.g. CRO) for fee deduction

    stp_id string

    Self-trade prevention ID (0 to 32767)

    stp_inst WsStpInst (string)

    Possible values: [M, T, B]

    Self-trade prevention instruction. Used in private/change-account-settings (params) and private/get-account-settings (result). Mandatory if stp_scope is set.

    • ➖ M: Cancel Maker
    • ➖ T: Cancel Taker
    • ➖ B: Cancel Both Maker and Taker
    stp_scope WsStpScope (string)

    Possible values: [M, S, D]

    Self-trade prevention scope. Used in private/change-account-settings (params) and private/get-account-settings (result).

    • ➖ M: Matches Master or Sub a/c
    • ➖ S: Matches Sub a/c only
    • ➖ D: reset all STP fields to default (stp_inst and stp_id in same request are ignored).
    type stringrequired

    Possible values: [STOP_LOSS, STOP_LIMIT, TAKE_PROFIT, TAKE_PROFIT_LIMIT]

    Trigger order type

    price decimal

    Limit price (required for STOP_LIMIT and TAKE_PROFIT_LIMIT)

    ref_price decimal

    Trigger price (required for all trigger order types)

    ref_price_type WsRefPriceType (string)

    Possible values: [MARK_PRICE, INDEX_PRICE, LAST_PRICE]

    Reference price type for trigger orders

    attach_order_id int64

    The order ID this trigger order is attached to. Used to attach TP/SL to an existing limit order (SpotAttach / DerivAttach attach-to-order).

    attach_isolation_id string

    Position this trigger order is attached to (DerivAttach attach-to-position, derivatives only). > 0: attach to the isolated position whose isolation_id equals the value. 0: attach to the cross-margin position. Requires REDUCE_ONLY in exec_inst. Mutually exclusive with attach_order_id and isolation_id.

  • ]
WebSocket response
Schema
    id int64

    Echoed request id

    method string

    Method invoked

    code int32

    0 = success; non-zero indicates error (reason code).

    result object[]
    Present when code === 0. Array of results for each order.
  • Array [
  • index integer

    Index of the order in the original request (0-based).

    code integer

    0 for success, error code otherwise.

    order_id int64

    Order ID (present on success).

    client_oid string

    Client Order ID (present on success).

    message string

    Error message (present on failure).

  • ]
  • message string

    Present when code !== 0.

    original string

    Present when code !== 0.