Data Query

Query workflow-plane data

The main data-read path for idx_... indices. It exposes the underlying DynamoDB tables directly as a keyed query: you pick a table, give a partition key (pk — the workflow or delivery id) and get back rows in sort-key order.

Tables (table): index-parameters (the workflow definition itself, no sort key), index-holdings, index-values-eod, index-weightings, index-universes, index-corporate-actions (all sorted by time), and deliveries (no sort key).

Narrowing the read. sk pins one exact sort-key value — the fastest way to fetch a single snapshot. attributes is a projection: only the named top-level fields come back, which matters because holdings and universe rows are large. order=descending with limit is the idiom for "most recent N".

Paging. cursor is an opaque base64-encoded DynamoDB LastEvaluatedKey; never parse or construct it. It is returned only when limit was reached and more rows exist. Without limit the handler pages internally and returns the whole partition in one response — safe for values, expensive for holdings.

Symbols. map_symbols=true adds a figi_symbols map covering every identifier that appears anywhere in the payload, so you can render tickers without a second lookup.

Access control. pk must be a workflow or delivery id belonging to one of the caller's teams (site admins bypass this). This is the only authorization check — there is no per-table permission.

get/query

Request

  • Base URL: https://api.indexone.io
  • URL: https://api.indexone.io/query
  • Auth: API key in header x-api-key and API key in header Authorization

Query parameters

table'index-parameters' | 'index-holdings' | 'index-values-eod' | 'index-weightings' | 'index-universes' | 'index-corporate-actions' | 'deliveries' required

Which table to read.

pkstring required

Partition key: the workflow (idx_...) or delivery (dlv_...) id.

skstring

Exact sort-key value (time). Ignored for tables without a sort key.

attributesstring

Comma-separated top-level fields to project. Omit for whole rows.

order'ascending' | 'descending'

Sort-key direction.

limitinteger

Maximum rows to return. Also enables cursor paging.

cursorstring

Opaque continuation token from a previous response.

map_symbolsboolean

Add a figi_symbols FIGI-to-ticker map.

Response

The matching rows.

itemsobject[]

The matching rows, in sort-key order (ascending unless order=descending).

countinteger

Number of rows in items (not the total matching count).

cursorstring nullable

Opaque base64 continuation token. Present only when limit was reached and more rows exist; pass it back as cursor to resume. null means the partition was exhausted.

figi_symbolsobject

Only present when map_symbols=true: FIGI to ticker-symbol lookup covering every identifier found anywhere in items.

Changes

No recorded changes to this operation across all 1 revision of this API.