Skip to main content

Get Order

Reads one order by id.

GET/api/orders/{id}Auth: Required

Response​

The order.

idnumberRequired

The order id.

client_order_idstring | nullRequired

The id you sent on creation, echoed back. null if you sent none.

market_idstringRequired

The market the order is on.

sidestringRequired

buy or sell.

ord_typestringRequired

market or limit.

volumestring | nullRequired

Base-asset volume still unfilled. Counts down to "0.0" as the order fills. null on an order placed by amount — a market buy, whose volume is not known in advance.

origin_volumestring | nullRequired

Base-asset volume the order was placed for. Never changes. null on an order placed by amount.

amountstring | nullRequired

Quote-asset amount, on an order that was placed by amount rather than by volume.

pricestring | nullRequired

The limit price. null on a market order.

avg_pricestring | nullRequired

Volume-weighted average fill price. null until the first fill.

statestringRequired

wait, done, fail or cancel — see Statuses.

member_idnumberRequired

The member the order belongs to.

lockedstringRequired

Funds still held for this order. Counts down to "0.0" as it fills or is cancelled.

origin_lockedstringRequired

Funds held when the order was placed. Never changes.

updated_atstringRequired

When the record last changed.

created_atstringRequired

When the record was created.