Skip to main content
GET
Get order

Authorizations

Authorization
string
header
required

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

Path Parameters

order_id
string<uuid>
required

Internal order id to fetch

Response

Order retrieved

account_id
string<uuid>
required
broker
enum<string>
required
Available options:
unspecified,
lightspeed,
alpaca
command_seq
integer<int64>
required
filled_quantity
string
required
intent_id
string<uuid>
required
order_id
string<uuid>
required
order_side
enum<string>
required
Available options:
UNSPECIFIED,
BUY,
SELL,
SELL_SHORT
order_state
enum<string>
required
Available options:
Unspecified,
Open,
Closed,
Rejected
order_status
enum<string>
required
Available options:
UNSPECIFIED,
PENDING_NEW,
NEW,
PARTIALLY_FILLED,
FILLED,
PENDING_CANCEL,
CANCELLED,
PENDING_REPLACE,
REPLACED,
STOPPED,
REJECTED
order_type
enum<string>
required
Available options:
UNSPECIFIED,
LIMIT,
MARKET,
FILL_OR_KILL,
LIMIT_ON_OPEN,
LIMIT_ON_CLOSE,
MARKET_ON_OPEN,
MARKET_ON_CLOSE,
STOP,
STOP_LIMIT,
TRAILING_STOP
organization_id
string<uuid>
required
quantity
string
required
received_at
string<date-time>
required
route_strategy
enum<string>
required
Available options:
UNSPECIFIED,
SMART,
AMEX,
ARCA,
BATS,
BATY,
EDGA,
EDGX,
NSDQ,
NYSE
symbol
string
required
time_in_force
enum<string>
required
Available options:
UNSPECIFIED,
DAY,
IMMEDIATE_OR_CANCEL,
GOOD_TILL_CANCEL,
AT_OPEN,
AT_CLOSE,
FILL_OR_KILL,
EXT
average_price
null | string
client_reference_id
string | null

The caller's own correlation id for this order, if it set one.

intent_id is minted by the platform and only reaches the caller on the response, so it cannot identify an order the caller has sent but not yet heard back about. This can: it is set before the request goes out and carried across every replace and cancel under the intent, which makes an order on an account-wide stream attributable to whoever placed it rather than to whoever happens to be listening.

serde(default) because the snapshot table stores this struct as a JSONB payload: rows written before the field existed carry no key for it, and without a default every one of them fails to deserialize.

external_order_id
string | null
limit_price
null | string
stop_price
null | string