Docs/Reference/Ontology/List Fields
GET/v1/ontology/fieldsTier · Free

List Fields

List every field the API can return, with XBRL-element mappings, standard coverage, null reasons, and comparability caveats.

Filter by category to scope to one section of the financial statements (e.g. only income-statement fields).

Query parameters · 1

Optional filters and modifiers. Pass as URL-encoded ?key=value.

categorystring | nulloptional

Filter by category: income_statement, balance_sheet, cash_flow, per_share, ratio, dei, other

Request headers · 1

Authentication.

Authorizationstringrequired

Production API key. Pass it as Bearer ax_live_…

Returns · 200

The standard { data, meta } envelope.

Envelope

dataobject

A single result object.

metaMeta

Pagination and request metadata, including request_id, data_as_of, and ontology_version.

ontology_version 2.1.0replay meta.as_of · ?as_of=<token>

Errors

Standard HTTP status codes plus a typed error.code in the { error: { code, message } } envelope.

Every endpoint returns the same typed error envelope ({ error: { code, message } }). For the full list of codes, see the Errors reference.