Fundamentals for symbol

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

symbolstringRequired
statementenumRequired
Allowed values:

Query parameters

startstringOptional

The start period for the statement. Format: YYYY or YYYYQn (eg 2024Q1) if fetching quarterly statements.

endstringOptional

The end period for the statement. Format: YYYY or YYYYQn (eg 2024Q1) if fetching quarterly statements.

quarterlybooleanOptional

Whether to fetch quarterly statements instead of annual. Default is false, which gets annual statements. This takes precedence over the start and end parameters, ie if quarterly is true, and start is 2020, the first period fetched will be 2020Q1.

Response

Successful Response
datalist of objects or null
messagestring or null
A message with the response status.
infomap from strings to any or string or null
Additional information or metadata about the response. Varies by response type.

Errors