Skip to main content

Send new order

POST /v1/orders

This request creating new order for the specific exchange.

Request Body required

OrderNewSingleRequest object.

  • exchange_id string required

    Exchange identifier used to identify the routing destination.

  • client_order_id string required

    The unique identifier of the order assigned by the client.

  • symbol_id_exchange string

    Exchange symbol. One of the properties (symbol_id_exchange, symbol_id_coinapi) is required to identify the market for the new order.

  • symbol_id_coinapi string

    CoinAPI symbol. One of the properties (symbol_id_exchange, symbol_id_coinapi) is required to identify the market for the new order.

  • amount_order number required

    Order quantity.

  • price number required

    Order price.

  • side OrdSide required

    Possible values: [BUY, SELL]

    Side of order.

  • order_type OrdType required

    Possible values: [LIMIT]

    Order types are documented in the separate section: EMS / Starter Guide / Order parameters / Order type

  • time_in_force TimeInForce required

    Possible values: [GOOD_TILL_CANCEL, GOOD_TILL_TIME_EXCHANGE, GOOD_TILL_TIME_OMS, FILL_OR_KILL, IMMEDIATE_OR_CANCEL]

    Order time in force options are documented in the separate section: EMS / Starter Guide / Order parameters / Time in force

  • expire_time date

    Expiration time. Conditionaly required for orders with time_in_force = GOOD_TILL_TIME_EXCHANGE or GOOD_TILL_TIME_OEML.

  • exec_inst string[]

    Possible values: [MAKER_OR_CANCEL, AUCTION_ONLY, INDICATION_OF_INTEREST]

    Order execution instructions are documented in the separate section: EMS / Starter Guide / Order parameters / Execution instructions

Responses

Created

Schema
  • exchange_id string required

    Exchange identifier used to identify the routing destination.

  • client_order_id string required

    The unique identifier of the order assigned by the client.

  • symbol_id_exchange string

    Exchange symbol. One of the properties (symbol_id_exchange, symbol_id_coinapi) is required to identify the market for the new order.

  • symbol_id_coinapi string

    CoinAPI symbol. One of the properties (symbol_id_exchange, symbol_id_coinapi) is required to identify the market for the new order.

  • amount_order number required

    Order quantity.

  • price number required

    Order price.

  • side OrdSide required

    Possible values: [BUY, SELL]

    Side of order.

  • order_type OrdType required

    Possible values: [LIMIT]

    Order types are documented in the separate section: EMS / Starter Guide / Order parameters / Order type

  • time_in_force TimeInForce required

    Possible values: [GOOD_TILL_CANCEL, GOOD_TILL_TIME_EXCHANGE, GOOD_TILL_TIME_OMS, FILL_OR_KILL, IMMEDIATE_OR_CANCEL]

    Order time in force options are documented in the separate section: EMS / Starter Guide / Order parameters / Time in force

  • expire_time date

    Expiration time. Conditionaly required for orders with time_in_force = GOOD_TILL_TIME_EXCHANGE or GOOD_TILL_TIME_OEML.

  • exec_inst string[]

    Possible values: [MAKER_OR_CANCEL, AUCTION_ONLY, INDICATION_OF_INTEREST]

    Order execution instructions are documented in the separate section: EMS / Starter Guide / Order parameters / Execution instructions

  • client_order_id_format_exchange string required

    The unique identifier of the order assigned by the client converted to the exchange order tag format for the purpose of tracking it.

  • exchange_order_id string

    Unique identifier of the order assigned by the exchange or executing system.

  • amount_open number required

    Quantity open for further execution. amount_open = amount_order - amount_filled

  • amount_filled number required

    Total quantity filled.

  • avg_px number

    Calculated average price of all fills on this order.

  • status OrdStatus required

    Possible values: [RECEIVED, ROUTING, ROUTED, NEW, PENDING_CANCEL, PARTIALLY_FILLED, FILLED, CANCELED, REJECTED]

    Order statuses and the lifecycle are documented in the separate section: EMS / Starter Guide / Order Lifecycle

  • status_history array[]

    Timestamped history of order status changes.

  • error_message string

    Error message.

  • fills object[]

    Relay fill information on working orders.

  • Array [
  • time date

    Execution time.

  • price number

    Execution price.

  • amount number

    Executed quantity.

  • ]
Loading...