FinancialReports API Documentation

Welcome to the Financial Reports API documentation. This API provides access to a comprehensive database of financial filings, company information, and industry classifications.

Base URL

All API requests should be made to:

https://api.financialreports.eu/

Authentication

All endpoints require authentication via an API key. Include your API key in the X-API-Key header with every request:

X-API-Key: your_api_key_here

To obtain an API key, please contact us at api@financialreports.eu. We offer various plans to suit different needs, including custom solutions for enterprise clients.

Rate Limiting and Quotas

Rate limits and quotas vary depending on your subscription plan. Please refer to your plan details or contact our support team for specific information about your account's limitations.

Available Endpoints

Our API provides the following main categories of endpoints:

1. Filings: Access financial filings from various companies.
2. Companies: Retrieve detailed information about companies.
3. Filing Types: Get information about different types of financial filings.
4. Sources: Access details about the sources of our financial data.
5. Sectors: Retrieve information about business sectors.
6. Industry Groups: Access data on industry groups within sectors.
7. Industries: Get detailed information about specific industries.
8. Sub-Industries: Retrieve data on sub-industries within industries.

Each category has endpoints for listing all items and retrieving specific items by ID.

Common Parameters

Many of our list endpoints support the following common query parameters:

• page: The page number for pagination (default is 1)
• page_size: The number of results per page (default may vary by endpoint)
• search: A search term to filter results (where applicable)
• ordering: Field(s) to order the results by (where applicable)

Response Format

All responses are returned in JSON format. Successful responses will have a 200 OK status code, while errors will return appropriate 4xx or 5xx status codes along with error messages.

Error Handling

The API uses standard HTTP response codes to indicate the success or failure of requests:

• 200 OK: The request was successful
• 400 Bad Request: The request was invalid or cannot be served
• 401 Unauthorized: The request requires authentication
• 403 Forbidden: The server understood the request but refuses to authorize it
• 404 Not Found: The requested resource could not be found
• 429 Too Many Requests: You have exceeded your rate limit
• 500 Internal Server Error: The server encountered an unexpected condition

Support

If you encounter any issues or have questions about using the API, please contact our support team at support@financialreports.eu.

Terms of Service

By using this API, you agree to comply with our Terms of Service and API Usage Policy.

Changelog

We continuously improve our API. Check our Changelog for updates and new features.

---

Explore the sidebar to find detailed documentation for each endpoint. Happy coding!