Skip to main content
GET
Get exposure over time

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 window 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
days
integer<int64>
required

Trailing day count. Clamped to 1..=90 and then to the window the caller's plan grants; a single day is reported as 24 hourly buckets

symbol
string

Filter by symbol. Symbols are normalized to uppercase; a blank value is treated as no filter

asset_class
enum<string>

Filter by instrument type. Narrows the totals, the per-instrument breakdown and opening_position_count alike. UNSPECIFIED names no instrument and is rejected with 400; omit the parameter to read every class The kind of thing an Instrument [blocked] is, without its payload.

Separate from the sum type because the discriminant travels where the payload cannot: a column, a metric label, a capability check asking whether this deployment is cleared to trade futures at all. It is Copy and string-convertible for exactly those uses.

Unspecified is what an unset column reads back as, the same role it plays on Feed [blocked] and Broker [blocked]. Instrument::asset_class [blocked] never returns it.

Available options:
UNSPECIFIED,
EQUITY,
FUTURE,
OPTION,
CURRENCY,
CRYPTO,
PERPETUAL,
PREDICTION

Response

Exposure retrieved

Exposure over a trailing window, oldest bucket first.

data
object[]
required

One entry per bucket in the window, including buckets in which nothing was held or nothing traded, so the series can be plotted without the caller filling gaps.

granularity
enum<string>
required

Width of one bucket: hour for a single-day window, day otherwise.

Available options:
hour,
day
opening_position_count
integer<int64>
required

Instruments the account had ever held, and not yet flattened, when the window opened.

The series carries positions forward from before its own start, so a non-zero figure here is what makes the left-hand end a real level rather than an artefact of where the scan began.

Required range: x >= 0