Skip to main content
GET
Get completed intents

Authorizations

Authorization
string
header
required

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

Query Parameters

account_id
string<uuid>

Trading account ID. Omitted, the read covers every account in the organization.

environment
enum<string>
required

Required broker environment. Includes disabled and deleted accounts. A named account must belong to this environment.

Available options:
paper,
live
intent_id
string<uuid>

Filter by intent ID; other filters and pagination still apply.

symbol
string

Filter by symbol. Normalized to uppercase.

terminal_status
string

How the intent ended: FILLED, CANCELLED or REJECTED

start
string<date-time>

Inclusive range start, against the sort column when that is a clock and terminal_at otherwise

end
string<date-time>

Exclusive range end, bounding the same column as start

terminal_only
boolean

One row per intent instead of one per action

limit
integer<int32>

Maximum rows; defaults to 100 and is clamped to 1 through 1000

Required range: x >= 0
sort_by
enum<string>

Sort field; defaults to terminal_at Sortable columns on completed intents.

Deliberately short. Every column here is either in the table's sort key or cheap to scan, and a sort offered over a six year table is a promise about cost as much as about ordering.

Available options:
terminal_at,
created_at,
received_at,
symbol
sort_direction
enum<string>

Sort direction; defaults to Desc

Available options:
Asc,
Desc
next_cursor
string

Opaque keyset cursor from a previous response. Only valid for the sort_by it was issued with.

Response

Completed intents retrieved

data
object[]
required
next_cursor
string | null