Base URL
Authentication
Send your key in theX-API-KEY header on every request. See Authentication.
The scenario_id parameter
Almost every data endpoint requires a scenario_id query parameter identifying the world to read from. David generates and curates the scenarios; obtain a scenario_id by listing scenarios.
Response shape
Responses are JSON objects keyed by the resource name, with the payload as a list or object:prices, news, financials, companies, …). Detail endpoints return a single named object.
Shared query parameters
| Parameter | Type | Description |
|---|---|---|
scenario_id | string | Required on data endpoints. The world to read from. |
ticker | string | Symbol to filter by. Case-insensitive; normalized (e.g. BRK.B → BRK-B). |
limit | integer | Page size. Each endpoint documents its default and maximum. |
offset | integer | Number of rows to skip, for pagination. |
as_of | date | Point-in-time cutoff (YYYY-MM-DD). Returns only data visible on or before this date. |
start_date / end_date | date | Inclusive window for time-series endpoints. |
Pagination
List endpoints page withlimit and offset. To walk a full result set, increase offset by limit until a short page returns:
Rate limits & errors
Every response carriesX-RateLimit-Limit, X-RateLimit-Remaining, and X-Account-ID. See Errors & rate limits for status codes and handling.