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.40.tar.gz (79.8 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.40.tar.gz.

File metadata

File hashes

Hashes for financial_reports_generated_client-1.4.40.tar.gz
Algorithm Hash digest
SHA256 2e7280b88f0483a2f9041e0e232205baada64c26983ceb73aa2386e962b1b470
MD5 9910c3abb694e3a5d17e70acbc226284
BLAKE2b-256 bc27c44c553692de16fa4975b34802fa7aeaae5022c8f23b56ddc39f35cb6950

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for financial_reports_generated_client-1.4.40-py3-none-any.whl
Algorithm Hash digest
SHA256 dfe923d7e9ccc5773be84d4e23714b63a1c97c7c32bff80bd494878e7952f1f7
MD5 f46ed128a580d2981d1ba84b3a2f852b
BLAKE2b-256 67a838098d1a9171b5aec3ac2c43fdcf03b65a2dfd9ef910f17c2f7ee01dcb89

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