Skip to main content
POST
Place an async order

Authorizations

Api-Access-Key
string
header
required

An API key associated with a security role

Body

application/json

Parameters to place an order.

clOrderId
string
required

Unique client order ID.

Example:

"6fb5fc79-0bb4-446d-82dd-d4687fb56a02"

currency
string
required

The currency in which order quantity is specified in.

Example:

"BTC"

orderType
enum<string>
required

Order type should be for BUY and SELL: LIMIT, STOP_LIMIT, TAKE_PROFIT_LIMIT. Only for SELL: STOP_LOSS

Available options:
LIMIT,
STOP_LOSS,
STOP_LIMIT,
TAKE_PROFIT_LIMIT
quantity
string
required

Order quantity in units of currency.

Example:

"100.00"

side
enum<string>
required

Order side, either "BUY" or "SELL".

Available options:
BUY,
SELL
symbol
string
required

Symbol for the order, e.g. BTC-USD.

Example:

"BTC-USD"

timeInForce
enum<string>
required

Time in Force specifies how long the order remains in effect

Available options:
FOK,
IOC,
GTC
timestamp
string<date-time>
required

Timestamp when submitting this order. Date-times are always in UTC RFC 3339 'date-time'.

accountId
string

Account ID for this order to book into.

Example:

"0e2b2f9d-8d10-4f1e-960b-28567255045f"

allocation
OrderAllocation · object[]

Order subaccount allocation

limitPrice
string

Limit price for the order, required for limit order

Example:

"21005.5"

parameters
object

Optional order type parameters for STOP_LOSS, STOP_LIMIT and TAKE_PROFIT_LIMIT orders.

specLotId
string

Optional specification lot ID for tax reporting purposes. Only applicable for SELL orders with timeInForce FOK. When provided, instructs the tax service to retire the specified lot.

Example:

"550e8400-e29b-41d4-a716-446655440000"

subaccountId
string

Subaccount ID for this order to book into.

Example:

"343b6c83-6d91-4f13-9982-2109abd2dbb0"

Response

Successfully placed an ansyc order

data
OrderExecutionReport · object
required