FinancialReports API Documentation

Welcome to the Financial Reports API documentation. This API provides programmatic access to a comprehensive database of financial filings, company information, and industry classifications primarily focused on European markets.

Base URL

All API requests should be made to the following base URL:

https://api.financialreports.eu/

Authentication

All API endpoints require authentication via an API key. You must include your unique API key in the X-API-Key HTTP header with every request.

Example Header:

To obtain an API key, please contact our team at api@financialreports.eu. We offer various plans, including custom solutions.

Rate Limiting and Quotas

API usage is subject to rate limits and quotas based on your subscription plan. Exceeding these limits will result in 429 Too Many Requests errors. Please consult your plan details or contact support for information specific to your account.

Available Endpoints

The API provides read-only access to the following resources:

Filings

Access regulatory filing data.

GET /filings/

Retrieve a paginated list of filings. Supports filtering, searching, and ordering.

GET /filings/{id}/

Retrieve detailed information for a single filing by its unique ID.

Companies

Access detailed company information.

GET /companies/

Retrieve a paginated list of companies. Supports filtering and searching.

GET /companies/{id}/

Retrieve detailed information for a single company by its unique ID.

Filing Types

Access reference data for filing types.

GET /filing-types/

Retrieve a list of all available filing types. Supports searching.

GET /filing-types/{id}/

Retrieve details for a single filing type by its primary key.

Sources

Access reference data for data sources.

GET /sources/

Retrieve a list of all available data sources.

GET /sources/{id}/

Retrieve details for a single data source by its primary key.

GICS Classifications

Access reference data for Global Industry Classification Standard (GICS) categories.

GET /sectors/

Retrieve a list of all available GICS Sectors. Supports searching.

GET /sectors/{id}/

Retrieve details for a single GICS Sector by its primary key.

GET /industry-groups/

Retrieve a list of all available GICS Industry Groups. Supports filtering by sector ID and searching.

GET /industry-groups/{id}/

Retrieve details for a single GICS Industry Group by its primary key.

GET /industries/

Retrieve a list of all available GICS Industries. Supports filtering by industry group ID and searching.

GET /industries/{id}/

Retrieve details for a single GICS Industry by its primary key.

GET /sub-industries/

Retrieve a list of all available GICS Sub-Industries. Supports filtering by industry ID and searching.

GET /sub-industries/{id}/

Retrieve details for a single GICS Sub-Industry by its primary key.

Filtering Parameters

The following list endpoints support specific filtering query parameters:

`/filings/` Filters

company: Filter by internal Company ID (Number).

company_isin: Filter by Company ISIN (String, Case-insensitive).

lei: Filter by Company Legal Entity Identifier (LEI) (String).

countries: Filter by Company country ISO Alpha-2 code(s). Comma-separated for multiple values (e.g., US,GB,DE) (String).

languages: Filter by filing language ISO 639-1 code(s). Comma-separated for multiple values (e.g., en,de) (String).

language: Filter by a single filing language ISO 639-1 code (e.g., en) (String).

added_to_platform_from: Filter by date added to platform (inclusive start date, YYYY-MM-DDTHH:MM:SSZ format) (DateTime).

added_to_platform_to: Filter by date added to platform (inclusive end date, YYYY-MM-DDTHH:MM:SSZ format) (DateTime).

dissemination_datetime_from: Filter by dissemination datetime (inclusive start, YYYY-MM-DDTHH:MM:SSZ format) (DateTime).

dissemination_datetime_to: Filter by dissemination datetime (inclusive end, YYYY-MM-DDTHH:MM:SSZ format) (DateTime).

release_datetime_from: Filter by release datetime (inclusive start, YYYY-MM-DDTHH:MM:SSZ format) (DateTime).

release_datetime_to: Filter by release datetime (inclusive end, YYYY-MM-DDTHH:MM:SSZ format) (DateTime).

type: Filter by Filing Type code (e.g., ANNREP) (String).

source: Filter by Source ID (likely internal ID or name, exact field depends on default filter generation) (String/Number).

`/companies/` Filters

sector: Filter by GICS Sector code (String).

industry_group: Filter by GICS Industry Group code (String).

industry: Filter by GICS Industry code (String).

sub_industry: Filter by GICS Sub-Industry code (String).

countries: Filter by Company country ISO Alpha-2 code(s). Comma-separated for multiple values (e.g., US,GB,DE) (String).

Other Filters

/industry-groups/: Supports sector (filter by parent sector ID).

/industries/: Supports industry_group (filter by parent industry group ID).

/sub-industries/: Supports industry (filter by parent industry ID).

Common Parameters

List endpoints generally support the following common query parameters:

page (Integer): The page number for pagination (default is 1).

page_size (Integer): The number of results per page (default is 20, max is 100).

search (String): A general search term. Supported fields vary by endpoint (see endpoint descriptions).

ordering (String): Field name to order results by. Prefix with - for descending order. Supported fields vary (e.g., /filings/ supports release_datetime, added_to_platform).

Response Format

All API responses are returned in JSON format.

Successful Responses (`200 OK`)

List Endpoints: Return a paginated structure:

{
  "count": 123, // Total number of results matching query
  "next": "https://api.financialreports.eu/endpoint/?page=3", // URL for the next page, or null
  "previous": "https://api.financialreports.eu/endpoint/?page=1", // URL for the previous page, or null
  "results": [
    { ... object 1 ... },
    { ... object 2 ... }
  ]
}

Retrieve Endpoints: Return a single JSON object representing the requested resource:

{
  "id": 123,
  "field_name": "value",
  ... other fields ...
}

Error Responses (`4xx`, `5xx`)

Errors are returned with an appropriate HTTP status code and a JSON body, typically containing a detail message:

{
  "detail": "Error message describing the issue."
}

(Specific error formats may vary slightly)

Error Handling Codes

The API uses standard HTTP response codes:

200 OK: Request successful.

400 Bad Request: Invalid request parameters or format. Check the detail message.

401 Unauthorized: No API key provided or key is invalid/inactive (AuthenticationFailed).

403 Forbidden: API key is valid, but lacks permission for the requested resource or action (or potentially plan-related restrictions).

404 Not Found: The requested resource (e.g., specific company ID) does not exist.

429 Too Many Requests: Rate limit exceeded.

500 Internal Server Error: An unexpected error occurred on the server.

Support

If you encounter issues or have questions, please contact support at support@financialreports.eu.

SDKs / Client Libraries

To help you integrate with our API more easily, we provide automatically generated client libraries (SDKs).

GitHub Repository: https://github.com/financial-reports/financial-reports-python

PyPI Package: https://pypi.org/project/financial-reports-generated-client/

Installation:

pip install financial-reports-generated-client

Terms of Service

API usage is subject to our Terms of Service and API Usage Policy.

Changelog

Stay updated with API changes via our Changelog.

This documentation provides an overview. For detailed field descriptions and examples for each endpoint's request/response, please refer to the interactive documentation powered by our OpenAPI schema (available via APIdog sync or potentially a dedicated portal).

FinancialReports API Documentation

Base URL#

Authentication#

Rate Limiting and Quotas#

Available Endpoints#

Filings#

Companies#

Filing Types#

Sources#

GICS Classifications#

Filtering Parameters#

/filings/ Filters#

/companies/ Filters#

Other Filters#

Common Parameters#

Response Format#

Successful Responses (200 OK)#

Error Responses (4xx, 5xx)#

Error Handling Codes#

Support#

SDKs / Client Libraries#

Terms of Service#

Changelog#