Skip to main content
GET
List traded symbols

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 to narrow to. Omitted spans every account the organization owns.

environment
enum<string>
required

Required. Which environment the read covers. Resolved to the organization's accounts in that environment, including disabled and deleted ones, since the ledger stores no environment of its own. Rejected with 400 when it disagrees with the account named alongside it.

Available options:
paper,
live
days
integer<int64>

Trailing day count. Defaults to 1, clamped to 365, then to the window the caller's plan grants.

Response

Symbols retrieved

The symbols an organization has traded in a window, or still holds.

Sorted ascending, so a caller can index it for prefix search without sorting it again. Held positions are folded in regardless of when they were opened: a symbol carried from before the window is one an operator still expects to find by typing it.

data
string[]
required
days
integer<int64>
required

Trailing window the list was built from, echoed back so a caller does not have to remember what it asked for. Clamped, so this can differ from what was sent.