The order ID that Gemini has assigned to this order, first provided in the accepted or rejected message. All further events (fill, booked, cancelled, closed) will refer to this order_id.
event_id
string
Y*
The event ID associated with this specific order event. event_id is supplied for every order event type except the initial events that supply the active orders when you initially subscribe.
account_name
string
N
Returned when using a Master scoped API key. The name of the account within the subaccount group. Master API keys can get all account names using the Get Accounts endpoint.
api_session
string
Y*
The API session key associated with this order.
Note: orders placed by website users show UI as the API session key.
When limit orders are placed with immediate-or-cancel, fill-or-kill, or maker-or-cancel behavior, this field will indicate the order behavior.
order_type
string
Y
Description of the order.
timestamp
string
Y
The timestamp the order was submitted. For compatibility reasons, this is returned as a string. It is recommended to use the timestampms field instead.
timestampms
timestampms
Y
The timestamp the order was submitted in milliseconds.
is_live
boolean
Y
true if the order is active on the book (has remaining quantity and has not been canceled).
is_cancelled
boolean
Y
true if the order has been canceled. Note the spelling: "cancelled" instead of "canceled" (for compatibility reasons).
is_hidden
boolean
Y
true if the order is active but not visible.
avg_execution_price
decimal
N
The average price at which this order has been executed so far. 0 if the order has not been executed at all.
executed_amount
decimal
N
The amount of the order that has been filled.
remaining_amount
decimal
N
The amount of the order that has not been filled. Present for limit and market sell orders; absent for market buy orders.
original_amount
decimal
N
For limit orders and market sells, the quantity the order was placed for. Not present for market buys.
price
decimal
N
For limit orders, the price the order was placed for. Not present for market buys and sells.
total_spend
decimal
N
For market buys, the total spend (fee-inclusive notional value) the order was placed for. Not present for limit orders and market sells.