Skip to main content
GET
List your orders

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.

Query Parameters

limit
integer
default:100

Page size. Values outside 1–1000 are clamped, never rejected.

Required range: 1 <= x <= 1000
cursor
string

Opaque continuation token from the previous page's cursor. Omit for the first page. Do not parse or construct one.

status
string

Filter orders by status. Accepts the group names and the concrete statuses, comma-separated to combine (open,filled).

resting is the one a quoter wants each cycle, and it is exactly the set that is still cancelable. canceled is a group: it also matches expired, because an order that aged out is one of the terminal-not-filled ones you are asking for.

Example:

"resting"

ticker
string

Scope to one market, by ticker or UUID. An unknown value is 400, not an empty page — an empty page would read as "you hold nothing there", which is a different and more dangerous claim than "that market does not exist".

event_ticker
string

Scope to every market under one event — all rungs of a ladder. Unknown values are 400, for the same reason as ticker. Mutually exclusive with ticker: sending both is 400 conflicting_identifiers.

Response

A page of orders.

orders
object[]
required
cursor
string
required

Empty string on the last page.