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.42.tar.gz (84.4 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.42.tar.gz.

File metadata

File hashes

Hashes for financial_reports_generated_client-1.4.42.tar.gz
Algorithm Hash digest
SHA256 ecceaa022f03040aa614f76e77a1cf4f7197fd81189edd185cbbf62f565331df
MD5 d6f3b2e15744d333ed7c817ecce12971
BLAKE2b-256 1d44a77becff2f4465f52fd103dc234b313442afa77d4ee35137510f53387072

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for financial_reports_generated_client-1.4.42-py3-none-any.whl
Algorithm Hash digest
SHA256 687971a8aacdcc029e47af2fe8f1551d41d092f1ce4c34a1ea5caaf6a66c816f
MD5 adb7d4b9220646fdc6cad1676eb32e16
BLAKE2b-256 f288758b0af07ad33385622acf6fafef24025f892e9c84f551de667e4221e14d

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