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 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.25.tar.gz (79.2 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.25.tar.gz.

File metadata

File hashes

Hashes for financial_reports_generated_client-1.4.25.tar.gz
Algorithm Hash digest
SHA256 8649984e7b02e918692419dfdd185cf9e6e02e196b37c469b675a188ad8cb743
MD5 bb66fc135338c3f1381b56dc3ccfe3cc
BLAKE2b-256 58c76db6123ac209ecdedada365dcdaa623fe0c6897a454f6cda09fc02bad07d

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for financial_reports_generated_client-1.4.25-py3-none-any.whl
Algorithm Hash digest
SHA256 c59d1206c2bd327ee6d714562d43bf45f0e068407f5711f2e6f79b69e7c5d55b
MD5 9b117b665a477319ce2a44e8c2f11778
BLAKE2b-256 c233b997c6a7e155b8ba40517d481a9dbc069e1454d0c39e78201cc81f70dc55

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