FinancialReports API Documentation
Base URL
https://api.financialreports.eu/
Authentication
X-API-Key: your_api_key_here
Obtaining an API Key
Rate Limiting and Quotas
Available Endpoints
Companies
GET /companies/
- Retrieve a paginated list of companies. Supports extensive filtering (GICS, location, identifiers), searching, and ordering.GET /companies/{id}/
- Retrieve detailed information for a single company by its internal ID.Filings
GET /filings/
- Retrieve a paginated list of filings. Supports extensive filtering (company identifiers, location, filing attributes, date ranges), searching, and ordering.GET /filings/{id}/
- Retrieve detailed information for a single filing by its ID.Processed Filings
GET /processed-filings/{id}/
- Retrieve the processed content (typically Markdown) for a single filing by its ProcessedFiling ID.GICS Classifications
Sectors:
GET /sectors/
- List GICS Sectors. Supports filtering and searching.GET /sectors/{id}/
- Retrieve a specific GICS Sector.Industry Groups:
GET /industry-groups/
- List GICS Industry Groups. Supports filtering and searching.GET /industry-groups/{id}/
- Retrieve a specific GICS Industry Group.Industries:
GET /industries/
- List GICS Industries. Supports filtering and searching.GET /industries/{id}/
- Retrieve a specific GICS Industry.Sub-Industries:
GET /sub-industries/
- List GICS Sub-Industries. Supports filtering and searching.GET /sub-industries/{id}/
- Retrieve a specific GICS Sub-Industry.Reference Data
Filing Types:
GET /filing-types/
- List filing types. Supports searching.GET /filing-types/{id}/
- Retrieve a specific filing type.Sources:
GET /sources/
- List data sources.GET /sources/{id}/
- Retrieve a specific data source.User Watchlist
GET /watchlist/
- Get the current user's watchlist of companies.POST /watchlist/
(or /watchlist/add/
depending on your URL configuration) - Add a company to the user's watchlist. Requires company_id in the request body.DELETE /watchlist/{company_id}/
(or /watchlist/remove/{company_id}/
depending on your URL configuration) - Remove a company from the user's watchlist using the company ID from the URL path.Common Parameters for List Endpoints
page
(Integer): The page number for pagination (default is 1).page_size
(Integer): The number of results per page (default is 20, configurable per plan or request up to a maximum).search
(String): A general search term. The specific fields searched vary by endpoint (e.g., company name, filing title, GICS codes).ordering
(String): Field name to order results by. Prefix with -
for descending order (e.g., name
, -release_datetime
). Supported fields vary by endpoint./filings/
, /companies/
), please refer to the interactive OpenAPI documentation.Response Format
Successful Responses (200 OK, 201 Created)
List Endpoints (GET): Return a paginated structure:
{
"count": 123,
"next": "https://api.financialreports.eu/api/endpoint/?page=3",
"previous": "https://api.financialreports.eu/api/endpoint/?page=1",
"results": [
{ /* object 1 data */ },
{ /* object 2 data */ }
]
}
Retrieve Endpoints (GET): Return a single JSON object representing the requested resource:
{
"id": 123,
"field_name": "value"
/* ... other fields ... */
}
Create/Action Endpoints (POST, DELETE success): Typically return a JSON object confirming the action's status, often with a relevant ID:
{
"status": "success",
"message": "Action performed successfully.",
"company_id": 456
/* ... other relevant fields ... */
}
Error Responses (4xx, 5xx)
General Error Example:
{
"detail": "Error message describing the issue."
}
Field-Specific Validation Error Example (e.g., on POST):
{
"field_name": ["Error message for this field."]
}
Error Handling Codes
SDKs / Client Libraries
Installation (Python):
Support
Modified at 2025-05-24 07:45:48