Appendix A: Endpoint reference (full per-endpoint cards)

This appendix is the per-endpoint reference for the entire API surface, organised by family (system liveness, identity and access, catalog, then the per-asset-class data endpoints, and finally the admin key-management endpoints). For each endpoint it lists the path, a one-line description, the request shape (path parameters, query parameters, required/optional flag, and type), and the documented response codes. Use it as a lookup when writing client code; the rest of the guide covers the patterns and gotchas behind these shapes.

Each endpoint below has its full request shape (path parameters, query parameters, required/optional flag, type) and the documented responses. Note: the spec lists only the protocol-level parameters. Most data endpoints additionally accept Pascal-case column names as filters (Ticker, TradeDate); the legal column set is per-dataset and discoverable via GET /api/v1/meta/datasets/{id}/columns.

Standard query parameters

Every data endpoint accepts the same six standard query parameters (unless noted otherwise). Throughout this appendix the standard set is referred to as (std) and individual cards only list any additional parameters specific to that endpoint.

In	Name	Required	Type	Description
query	`sort`	no	string	Sorting criteria for the results. Provide a column name with optional prefix `+` for ascending order, or prefix with `-` for descending order.
query	`columns`	no	string	A comma-separated list of columns to include in the response. Use this parameter to select only specific fields from the dataset.
query	`offset`	no	integer	Number of records to skip before returning results. To be used with the `limit` parameter for pagination. Defaults to 0.
query	`limit`	no	integer	Maximum number of records to return. Used to control response size and pagination. If not provided, a default limit is applied by the server.
query	`response_format`	no	enum`{json,csv,csv_gzip}`	The type of the data to return.

Per-family additional query parameters:

adjusted (boolean) — only on eq-trades*, eq-trades-1min*, eq-daily-ohlc. Routes to the adjusted-price variant.
aggregation_logic (enum {algoseek, industry_std}) — only on eq-daily-ohlc, eq-taq-1min, eq-trades-1min. Routes to the chosen aggregation variant.

System liveness

`GET /api/v1/status`

API liveness probe.

Returns a tiny JSON envelope confirming the API is reachable. Requires no authentication. Suitable for kubernetes liveness probes, ALB target group health checks, and pre-flight checks before a long-running ingestion job.

Documented responses: 200.

Dataset publication status

`GET /api/v1/meta/datasets/{dataset_id}/status`

Get dataset status.

Retrieves time of the last update, the expected time of the next update and the status code for the dataset.

In	Name	Required	Type	Description
path	`dataset_id`	yes	string	Opaque catalog id, e.g. `US####`.

Documented responses: 200, 403, 404, 422.

Identity & Access

Note: the API also exposes admin-only API-key management endpoints (POST /api/v1/api-keys/{key_id}/activate, POST /api/v1/api-keys/{key_id}/deactivate, etc.) referenced in the key-rotation discussion in the setup chapter. These require admin-level entitlement and are omitted from this appendix; non-admin holders of an API key cannot call them and should arrange rotation through their account contact.

`GET /api/v1/account/my`

Get current identity. Returns details about the account that owns the API key used to authenticate the request.

Documented responses: 200, 403.

`GET /api/v1/account/my/api-keys`

List api keys. Retrieves the list of API keys associated with this account.

Documented responses: 200, 403.

`GET /api/v1/account/my/data-access-rules`

List dataset access rules. Retrieves the list of datasets with their access constraints.

Documented responses: 200.

`GET /api/v1/account/my/quotas`

Get usage quotas. Returns the API usage summary for the current month and current minute, along with the usage limits.

Note: the monthly limit is refreshed at the beginning of each month.

Important: the quotas are applied across all API keys in your account.

Documented responses: 200, 403.

Catalog (Meta)

`GET /api/v1/meta/datasets`

List datasets. Retrieves the list of all datasets available via API.

Documented responses: 200, 403.

`GET /api/v1/meta/datasets/my`

List my datasets. Retrieves the list of datasets available for the current identity.

Documented responses: 200, 403.

`GET /api/v1/meta/datasets/{dataset_id}/columns`

List dataset columns. Retrieves the list of dataset's columns (fields) with data types and descriptions.

In	Name	Required	Type	Description
path	`dataset_id`	yes	string	Opaque catalog id.

Documented responses: 200, 403, 404, 422.

`GET /api/v1/meta/datasets/{dataset_id}/info`

Get dataset info. Retrieves the dataset metadata details.

In	Name	Required	Type	Description
path	`dataset_id`	yes	string	Opaque catalog id.

Documented responses: 200, 403, 404, 422.

US Equity Data

`GET /api/v1/data/us-equity/eq-daily-ohlc`

US Equities Daily OHLC. OHLCV data with separated full-day, market-hours, and FINRA volume, plus VWAP for the full trading day and market hours.

Parameters: (std) + adjusted, aggregation_logic.