Skip to main content
The ordersByIds query fetches one or more resting orders by their exchange-assigned order IDs — the id values returned by userOrders or an order placement response. The response orders[] array uses the same fields as userOrders.
Only orders currently on the book are returned — resting orders, including partially filled ones. Fully filled orders, canceled orders, and untriggered conditional orders are not returned, and an ID that matches no resting order is omitted without an error. An absent order therefore does not tell you whether it filled, was canceled, or never existed. To reconcile, use userOrders for active orders and orderHistory or userFills for terminated orders and fills.

Request

string
required
type (required) — Must be "ordersByIds".
integer
required
marketDeployerId (required) — The Market Deployer the orders belong to. An order under a different Market Deployer is not returned.
string[]
required
orderIds (required) — Array of exchange-assigned order IDs to look up, each expressed as an int64 decimal string (e.g. ["8280", "8281"]). At most 256 IDs per request; pass a single-element array to look up one order. A missing field, a value that is not an array of IDs, or more than 256 IDs returns HTTP 400 with code BAD_REQUEST and message "missing or invalid orderIds array".

Response

string
Always "ordersByIds".
integer
The marketDeployerId from the request.
boolean
Always present. false means orders is the complete result. true means the response has an upper bound on the number of orders and orders was cut at an order boundary; split the IDs into smaller requests to read the rest.
object[]
The matching resting orders. Each element carries the fields described in userOrders — including originalSize, since size is the remaining quantity rather than the quantity originally submitted.