Skip to main content
POST
Place an order

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

Idempotency-Key
string | null

Path Parameters

account_id
string
required

Body

application/json
instrument
string
required

The ID of the instrument to buy or sell.

order_type
enum<string>
required

The order type, market or limit. Limit orders are ETFs only.

Available options:
market,
limit
side
enum<string>
required

The order side, buy or sell.

Available options:
buy,
sell
automatic_rollover
boolean | null
default:false

Whether the resulting position rolls into a similar instrument at maturity; valid only for eligible buy orders.

cash_amount

Pre-fee cash amount required for buy orders.

Example:

"1000.00"

limit_price

Positive price required for limit orders and rejected for market orders.

Example:

"25.7500"

quantity

Positive unit quantity required for sell orders.

Example:

"12.5"

quote
string | null

ID of a previously issued order quote. FX orders replay the locked rate; security cash buys may reference a prior quote for a deviation check against the quoted amount.

Response

Created

created_at
string<date-time>
required

The timestamp (in ISO-8601 format) of when the resource was created.

fees
string
required

The total fees for this order.

Example:

"1.50"

id
string
required

Unique resource identifier.

instrument
Bill · object
required

The instrument to buy or sell.

is_cancellable
boolean
required

Whether the order can be cancelled now; true only for limit orders in a cancellable phase with no fills.

modified_at
string<date-time>
required

The timestamp (in ISO-8601 format) of when the resource was last modified.

order_type
enum<string>
required

The order type (e.g. market, limit).

Available options:
market,
limit
purpose
enum<string>
required

The purpose of the order.

Available options:
user_request,
rollover,
square_off,
backfill
side
enum<string>
required

Buy or sell.

Available options:
buy,
sell
status
enum<string>
required

The order status.

Available options:
held,
placed,
executing,
cancelling,
filled,
settled,
cancelled
traded_notional
string
required

The total notional value executed.

Example:

"998.50"

traded_quantity
string
required

The total quantity executed.

Example:

"10.5"

trades
OrderTrade · object[]
required

All trades executed to fill this order.

account
string | null

ID of the parent account. Present on customer orders; null for system-placed orders.

automatic_rollover
boolean | null

Customer's automatic rollover preference; set only on eligible buy orders.

cancelled_at
string<date-time> | null

The time the order was cancelled.

Example:

"2026-07-14T09:34:12Z"

cancelled_reason
string | null

The reason for cancelling the order, if cancelled.

cash_amount
string | null

The amount to invest (before fees). Buy orders are cash-based (you specify how much to invest, not how many units to buy).

Example:

"1000.00"

currency
enum<string> | null

Order currency: the instrument trading currency for securities, or the base currency for FX.

Available options:
EUR,
USD,
GBP
filled_at
string<date-time> | null

The time the order was filled.

Example:

"2026-07-14T09:34:12Z"

limit_price
string | null

Limit price per unit; null for market orders.

Example:

"95.1000"

net_cash_amount
string | null

The amount to invest after fees. This is what gets traded.

Example:

"998.50"

position
string | null

ID of the position this order belongs to; null until the order executes.

quantity
string | null

Requested unit quantity for sell orders.

Example:

"10.5"

quote
string | null

ID of the quote used to place this order. On FX orders, locks the executing rate; when omitted, the order trades at the live rate.

settled_at
string<date-time> | null

The time the order was settled.

Example:

"2026-07-16T09:34:12Z"