semvec/pypi-packages huggingface dataset:
financial-reports-generated-client 1.4.2
FinancialReports API
License: Apache-2.0
Requires Python: >=3.9
Keywords: OpenAPI, OpenAPI-Generator, FinancialReports API

# Financial Reports Python SDK

The official Python client for the [FinancialReports API](https://financialreports.eu). 

Access a comprehensive database of European financial filings, company information, and industry classifications programmatically.

## Installation

```bash
pip install financial-reports-generated-client
```

## Quick Start

The SDK is designed to be simple and intuitive. It uses `asyncio` for high-performance data retrieval.

### 1. Initialize the Client

You can pass your API key directly or set it as an environment variable `FINANCIAL_REPORTS_API_KEY`.

```python
import asyncio
from financial_reports_generated_client import FinancialReports

async def main():
    # Context manager automatically handles cleanup
    async with FinancialReports(api_key="YOUR_API_KEY") as client:
        
        # --- Example 1: List Filings ---
        # Get the latest filings, searching for "Volkswagen"
        filings = await client.filings.list(
            search="Volkswagen", 
            ordering="-release_datetime",
            page_size=5
        )
        
        for filing in filings.results:
            print(f"{filing.release_datetime}: {filing.title} ({filing.company.name})")

        # --- Example 2: Get Company Details ---
        # Fetch detailed profile for a specific company ID
        company = await client.companies.retrieve(id=123)
        print(f"Company: {company.name}, Country: {company.country_code}")

if __name__ == "__main__":
    asyncio.run(main())
```

## Access Levels

The API response data depends on your subscription tier.

| Level | Name | Description |
| :--- | :--- | :--- |
| **Level 1** | **Standard Access** | Access to raw PDF/XBRL metadata, company profiles, ISIC classifications, and reference data. |
| **Level 2** | **Processed Filings** | Access to converted content (Markdown/JSON) and full-text search capabilities. |
| **Level 3** | **Extracted Financials** | Access to specific extracted financial line items (Revenue, EBITDA, etc.). |

## Documentation

* **Full API Reference:** [https://financialreports.eu/docs](https://financialreports.eu/docs)
* **Support:** [support@financialreports.eu](mailto:support@financialreports.eu)

---
*Generated by FinancialReports Engineering.*