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.0.tar.gz (62.0 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.0.tar.gz.

File metadata

File hashes

Hashes for financial_reports_generated_client-1.4.0.tar.gz
Algorithm Hash digest
SHA256 ea1d17e80ee33139996fcfb965a2b703f40808ba3bad9c9d4e9c5760aaee1b48
MD5 361000cd302ecde0a5ef34103a4cca12
BLAKE2b-256 57ca07a7153e0af964e0dbaeb2fc366ac232c16d8fd810b82e6717bb76f6d431

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for financial_reports_generated_client-1.4.0-py3-none-any.whl
Algorithm Hash digest
SHA256 64080ea10d54b5b6145e71092e3ee80b9ee4cb36d66d71ffdcfa9cf013cdaa35
MD5 23b8808b8716b7b81a873d0bc3d8ab3a
BLAKE2b-256 cafdbbf04b00523a4137dd9020d5265620591d9dda9ac42cf0fcfdda9a55c16b

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