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.22.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.22.tar.gz.

File metadata

File hashes

Hashes for financial_reports_generated_client-1.4.22.tar.gz
Algorithm Hash digest
SHA256 9c27bd0bb44f35c976b1ada79a6f5c230bafc60d7f45820cd5ddd8a7fdc07bc6
MD5 9e132d3f6891c7877b301334e5fbce65
BLAKE2b-256 9e61edd3841a9c56b8237b36fb00e687d04669355434df4ae030eca26c8d5ff9

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for financial_reports_generated_client-1.4.22-py3-none-any.whl
Algorithm Hash digest
SHA256 cc946b9154b3833dfed4ac3a4572b7469f6f55ae173cec32d87ae350a5cbd563
MD5 a35bb7d9eeda77b378436eb8e8157132
BLAKE2b-256 e203b57a9f9c915afe4d1bdf935862822046e32ca6fcf4b1220c4bca740e04bd

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