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.1.tar.gz (62.3 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.1.tar.gz.

File metadata

File hashes

Hashes for financial_reports_generated_client-1.4.1.tar.gz
Algorithm Hash digest
SHA256 2d0381e00bc556536b41a3c4add85057a9525b9c3836a03b2d286ec58f604e2c
MD5 423dea8da50b508aeb09807e00f3fc81
BLAKE2b-256 9ff76a328cea2b28a5bca3d5d6570bf8a535e9b397a85e2351d16822d2ff3cf1

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for financial_reports_generated_client-1.4.1-py3-none-any.whl
Algorithm Hash digest
SHA256 897395d516877270e3c17b32b70077c024ea401fe947f1e832347130162c562b
MD5 2add3af3516bdf1b80d4cecc30bc3efa
BLAKE2b-256 b328a0df8697a296ede081eb74962fc1af0d877afa6fb4314b9e910c9c549ad9

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