Skip to main content

FinancialReports API

Project description

Financial Reports Python SDK

The official Python client for the FinancialReports API.

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

Installation

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.

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


Generated by FinancialReports Engineering.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

financial_reports_generated_client-1.4.2.tar.gz (62.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

File details

Details for the file financial_reports_generated_client-1.4.2.tar.gz.

File metadata

File hashes

Hashes for financial_reports_generated_client-1.4.2.tar.gz
Algorithm Hash digest
SHA256 037ef014f558ee3806af3a22f785b332949b6a026d559dc8f7bc0e761de94116
MD5 a0ef8a046a73618276c0d3aa2819ded9
BLAKE2b-256 12e87169be66835bc91819f843a47a947de82c745b99108d757ad0e2e0469e29

See more details on using hashes here.

File details

Details for the file financial_reports_generated_client-1.4.2-py3-none-any.whl.

File metadata

File hashes

Hashes for financial_reports_generated_client-1.4.2-py3-none-any.whl
Algorithm Hash digest
SHA256 cdef25471d5b5302c84ae1e8fe52af1301a3096ca8c51ee287f75c67321e4820
MD5 5a885ed665bef54f0eaba17ef0c8258b
BLAKE2b-256 9edecdbe017e1f57d545994c0ca95dca78a8171680e7cd383ca13fbb2e22538b

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page