Skip to content

API overview

REST resources, historical queries, streaming concepts, portfolio snapshots, scenarios, and response conventions.

Read api overview

Schema reference

Field-level definitions for markets, assets, book snapshots, deltas, gaps, positions, and scenarios.

Read schema reference

Data quality

Source authority, acquisition design, reconstruction validity, gap policy, current evidence limits, and reporting requirements.

Read data quality

Methodology

Reconstruction principles, sequence handling, binary-claim representation, dependence, and current limitations.

Read methodology

Authentication / future

Scoped machine credentials

The intended production API would use organization-scoped API keys or short-lived tokens, transmitted with the Authorization header. Key lifecycle, rotation, audit events, and least-privilege scopes are part of the interface design.

Conventions

Predictable transport semantics

Encoding
UTF-8 JSON over HTTPS; newline-delimited JSON where noted.
Time
RFC 3339 UTC timestamps with source precision retained.
Decimals
Prices, sizes, and currency values encoded as strings.
Pagination
Opaque, stable cursors rather than page numbers.

Rate-limit philosophy

Capacity should be explicit and observable

Limits are designed to be scoped by organization, credential, and resource cost rather than advertised as a single request count. Responses would expose remaining budget and reset timing. A 429 response would include a machine-readable error and Retry-After.