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


Release history Release notifications | RSS feed

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.46.tar.gz (84.7 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.46.tar.gz.

File metadata

File hashes

Hashes for financial_reports_generated_client-1.4.46.tar.gz
Algorithm Hash digest
SHA256 1c4c72706c5df75fdfa85b985d8e51e7fe70af0031a2001e0014e14b50f16816
MD5 26a0f883c796b7f6a0bd8cd8f389eda3
BLAKE2b-256 eb6d4b7a0b21c00a2be7b4631711da31e8fae4e8608cea400e05d1075d716716

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for financial_reports_generated_client-1.4.46-py3-none-any.whl
Algorithm Hash digest
SHA256 465bbbf2062b03a353f329dd6a74c1d29155db1372353e9ad76e565b616a342a
MD5 2c47b07b66391a3ccf188791aeeb6536
BLAKE2b-256 bfa0494b3b0cfa78bb9ca6542970eeabf7808cc0bf47709e1a9cd1cbdc267388

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