Skip to main content
GET
Retrieve an order

Authorizations

Authorization
string
header
required

Authorization: Bearer <key>. Sandbox keys start with mgw_test_ and live keys start with mgw_live_. Each key works only in its own environment, and a live key works only from the IP addresses or ranges registered for it.

Path Parameters

id
string
required

The order's id.

Response

An order.

object
string
required
Allowed value: "order"
id
string
required

Unique identifier for the order. Starts with ord_.

state
enum<string>
required

sending: stored, and the send is in progress. pending: the exchange has the order. partially_filled, filled: some or all of the order has traded. uncertain: we don't know whether the exchange received it. We don't send it again; we reconcile it against the exchange's record. rejected: the exchange rejected it; see reject_reason. refused: we refused it, and it never reached the exchange. cancelled: the exchange confirmed the cancel. expired: its time in force ran out.

Available options:
sending,
pending,
partially_filled,
filled,
uncertain,
rejected,
refused,
cancelled,
expired
account
string
required

The account code, in uppercase.

symbol
string
required

The symbol, in uppercase.

side
enum<string>
required
Available options:
buy,
sell
quantity
integer<int64>
required
type
enum<string>
required
Available options:
limit,
market
time_in_force
enum<string>
required
Available options:
day,
gtc,
ioc,
fok
price_kobo
integer<int64> | null
required

The limit price in kobo. Null for a market order.

filled_quantity
integer<int64>
required

The total number of shares traded so far.

exchange_order_id
string | null
required

The exchange's identifier for the order, once it has one.

reason
string | null
required

A sentence explaining the order's current state. It's for people to read, so don't use it in your logic.

reject_reason
enum<string> | null
required

Why the exchange rejected the order. Set only when state is rejected.

Available options:
insufficient_funds,
market_closed,
settlement_lockout,
limit_orders_etf_only,
unknown_symbol,
symbol_not_tradable,
account_not_at_broker,
rejected_by_exchange,
null
created_at
string<date-time>
required

In UTC, to the second.

updated_at
string<date-time>
required

In UTC, to the second.