Place an async order

Permissions required: Execute trades

Place an order, either Limit, StopLoss, StopLimit or TakeProfitLimit currently FillOrKill, ImediateOrCancel or GoodTillCancel are supported.

One of accountId or subaccountId must be specified but not both.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Parameters to place an order.

string

Account ID for this order to book into.

allocation
array of objects

Order subaccount allocation

allocation
string
required

Unique client order ID.

string
required

The currency in which order quantity is specified in.

string

Limit price for the order, required for limit order

string
enum
required

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

Allowed:
parameters
object

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

string
required

Order quantity in units of currency.

string
enum
required

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

Allowed:
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.

string

Subaccount ID for this order to book into.

string
required

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

string
enum
required

Time in Force specifies how long the order remains in effect

Allowed:
date-time
required

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

Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json