Create Target Order

Use Case

Create a price-triggered order that fires once the market hits your target_price — the limit-style primitive for the Trading API. side: "buy" fires when the market falls to or below target; side: "sell" fires when the market rises to or above target.

Create Target Order

Request Body

base_currencyStringRequired

Asset to buy or sell (e.g. 'BTC').

quote_currencyStringRequired

Currency the target_price is expressed in.

sideStringRequired

'buy' or 'sell'.

quantityStringRequired

Amount of base_currency to trade once triggered.

target_priceStringRequired

Trigger price in quote_currency units. Buy orders trigger at <= target; sell orders trigger at >= target.

expires_atDateOptional

When the order should auto-cancel if never triggered. Empty string when the order has no expiry.

referenceStringOptional

Client-generated identifier for idempotency and tracking.

Response Fields

successBoolean

Flag indicating the target order was created.

messageString

Human-readable status message.

data.orderObject

The created target order.

data.order.idUUID

Target order identifier.

data.order.company_idUUID

Company that owns the order.

data.order.base_currencyString

Asset to buy or sell.

data.order.quote_currencyString

Pricing currency for target_price.

data.order.sideString

'BUY' or 'SELL' (returned uppercase).

data.order.quantityString

Total base-asset amount requested.

data.order.filled_quantityString

Base-asset amount already filled.

data.order.remaining_quantityString

Base-asset amount still pending: quantity - filled_quantity.

data.order.target_priceString

Trigger price in quote_currency.

data.order.average_fill_priceString

Volume-weighted average price across fills. Empty string until the first fill.

data.order.locked_amountString

Quote-currency amount escrowed at creation (includes fees). Returned to the wallet on cancel/expiry.

data.order.remaining_lockedString

Portion of locked_amount still reserved and not yet consumed by fills.

data.order.locked_currencyString

Currency held in escrow — quote_currency for buys, base_currency for sells.

data.order.statusString

'active', 'triggered', 'filled', 'cancelled', or 'expired'.

data.order.expires_atString

Auto-cancel timestamp. Empty string when the order has no expiry.

data.order.first_triggered_atString

Timestamp of the first trigger. Empty until the target price is hit.

data.order.last_fill_atString

Timestamp of the most recent fill. Empty until the first fill.

data.order.fully_filled_atString

Timestamp when the order was completely filled. Empty while partial or active.

data.order.created_atDate

When the order was created.

data.order.updated_atDate

When the order was last modified.

data.order.referenceString

Client-supplied idempotency key echoed back. Empty string when not provided.

metadata.request_idString

Unique request identifier for support and tracing.

timestampDate

Server time when the response was generated.

Funds Locked at Creation

locked_amount is escrowed the moment the order is created — for buys this is quantity × target_price plus fees in quote_currency, and for sells it's quantity of base_currency. This reservation is released back to the wallet if the order is cancelled or expires without fully filling.

Sample Request

Sample Response

List Target Orders

Use Case

Return all target orders under data.orders[]. Each entry is the full target-order record — same shape as Create Target Order's data.order, including the escrow fields (locked_amount, remaining_locked, locked_currency) and state timestamps. Filter by status to surface only what you care about.

List Target Orders

Query Parameters

statusStringOptional

Filter by lifecycle state: 'active', 'triggered', 'filled', 'cancelled', or 'expired'.

Response Fields

successBoolean

Flag indicating the query succeeded.

messageString

Human-readable status message.

data.ordersArray<TargetOrder>

List of target orders. Each entry is the full Create Target Order shape — see that section for per-field documentation.

metadata.request_idString

Unique request identifier for support and tracing.

timestampDate

Server time when the response was generated.

Sample Response

Get Target Order

Use Case

Retrieve a single target order by ID under data.order. Use this to poll a specific order's lifecycle — it surfaces status, filled_quantity / remaining_quantity, average_fill_price, the escrow fields (locked_amount / remaining_locked / locked_currency), and state timestamps (first_triggered_at, last_fill_at, fully_filled_at).

Get Target Order

Path Parameters

idUUIDRequired

Target order identifier.

Response Fields

successBoolean

Flag indicating the order was retrieved.

messageString

Human-readable status message.

data.orderObject

The target order record. Shape is identical to Create Target Order's data.order — refer to that section for per-field docs.

metadata.request_idString

Unique request identifier for support and tracing.

timestampDate

Server time when the response was generated.

Following a Trigger

Once the market hits the target, first_triggered_at becomes populated and fills flow in — filled_quantity, average_fill_price, and last_fill_at update per fill. When the order is fully filled, status flips to filled and fully_filled_at is set. remaining_locked tracks unspent escrow and is released back to the wallet on cancel, expiry, or final fill.

Sample Response