FinancialReports API Documentation
Base URL
https://api.financialreports.eu/
Authentication
X-API-Key
HTTP header with every request.
Rate Limiting and Quotas
429 Too Many Requests
errors. Please consult your plan details or contact support for information specific to your account.Available Endpoints
Filings
GET /filings/
GET /filings/{id}/
Companies
GET /companies/
GET /companies/{id}/
Filing Types
GET /filing-types/
GET /filing-types/{id}/
Sources
GET /sources/
GET /sources/{id}/
GICS Classifications
GET /sectors/
GET /sectors/{id}/
GET /industry-groups/
GET /industry-groups/{id}/
GET /industries/
GET /industries/{id}/
GET /sub-industries/
GET /sub-industries/{id}/
Filtering 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
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
Successful Responses (200 OK
)
{
"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 ... }
]
}
{
"id": 123,
"field_name": "value",
... other fields ...
}
Error Responses (4xx
, 5xx
)
{
"detail": "Error message describing the issue."
}
Error Handling 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
SDKs / Client Libraries
pip install financial-reports-generated-client
Terms of Service
Changelog
Modified at 2025-04-15 06:07:35