Skip to main content
GET
Get an order by id

Authorizations

X-API-KEY
string
header
required

Per-user API key. Create and revoke keys from your SOAR account settings. A revoked key stops working within 60 seconds.

Path Parameters

order_id
string
required

Decimal order_id as returned by POST /orders.

Pattern: ^[0-9]{1,20}$

Response

The order.

order_id
string
required

Decimal digits in a string. It is FNV-derived and routinely exceeds 2^53, so a JSON number would be silently rounded by any JavaScript client and you would then cancel an order that does not exist.

Pattern: ^[0-9]{1,20}$
ticker
string
required

This market's ticker.

market_id
string<uuid>
required
event_ticker
string
required

The parent event's ticker — the prefix this market's ticker begins with.

outcome
enum<string>
required

Which side of the market. Your position is in this outcome.

unknown is emitted only for a stored value this API version does not recognise (corruption, or an encoding added after your client was generated). It is declared so one bad row cannot fail the whole page; treat it as unparseable data rather than a fourth outcome.

Available options:
yes,
no,
unknown
side
enum<string>
required

See Outcome for when unknown appears.

Available options:
buy,
sell,
unknown
price
integer
required

Your limit price in whole cents, for your own outcome.

Required range: 1 <= x <= 99
qty
integer
required

Original size in shares.

Required range: x >= 0
remaining_qty
integer
required
Required range: x >= 0
filled_qty
integer
required
Required range: x >= 0
status
enum<string>
required

accepted is a transient projection state visible only on reads, while the durable state catches up. A create or amend response never returns it: its status is derived from what the engine actually did.

Available options:
accepted,
open,
partially_filled,
filled,
canceled,
expired
time_in_force
enum<string>
required

gtc rests until filled or canceled. ioc fills what it can immediately and cancels the rest. fok fills entirely or not at all. Omitted means gtc — an order that would silently become ioc dies the moment it fails to cross.

Available options:
gtc,
ioc,
fok,
unknown
created_at
string<date-time>
required

On a read, when the engine sequenced the order. On a create or amend response, the gateway's submit instant instead — the engine's reply carries no timestamp, and the authoritative one is only visible to the projection. The two are within a millisecond, but they are not the same clock: re-sending an idempotent client_order_id returns the same order with a fresh created_at. Key on order_id, not on this.

updated_at
string<date-time>
required
client_order_id
string

Echoed on the create response when you supplied one. Not stored, so it is absent from every read (GET /orders, GET /orders/{order_id}) — keep your own mapping. order_id is derived deterministically from it, so re-sending the identical create is also a safe way to recover the id.

Maximum string length: 64
reserved_cents
integer

Cash locked by this order. Present on reads only — a create or amend response omits it, because the engine reports the caller's account-wide reserve there rather than this order's share, and one field name cannot mean both. For the account-wide figure use reserved_cents on /portfolio/balance.

Required range: x >= 0
spent_cents
integer

Present only on the create response of a budget order: the exact realized cash cost of the execution — fill flow plus taker fees, cent for cent what left your balance. Absent on qty orders and on every read (the projection does not store it); reconcile historical executions against /portfolio/fills. On a budget order the executed size is qty (= filled_qty), so spent_cents / qty is your realized average cost per share, fees included.

Required range: x >= 1