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.33.tar.gz (81.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.33.tar.gz.

File metadata

File hashes

Hashes for financial_reports_generated_client-1.4.33.tar.gz
Algorithm Hash digest
SHA256 9b78e4ce8098cec83d6eac45f5f12910e6c81bb04ddd485d449b9f10704aecc3
MD5 1f62d59f5b5f9756791c749f1ad4f39e
BLAKE2b-256 9fe5022f74e86b08838b339f2a86caaa5721c350203285bcb5fca2a7ed445616

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for financial_reports_generated_client-1.4.33-py3-none-any.whl
Algorithm Hash digest
SHA256 53c3c620be399f08d427cb7b5c62cf5c610c04b68dfb293a15c1785ebd6259aa
MD5 03191e1335cb8d53e936d00610d70f39
BLAKE2b-256 a830d521e0bdb9f418b1713ce329fc2e5a2f1f77dbbf6a3ddccd58a35770600b

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