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

File metadata

File hashes

Hashes for financial_reports_generated_client-1.4.7.tar.gz
Algorithm Hash digest
SHA256 d0a92ad933b649b1399e52817298d185fb0e81d46f7c3755a95c248389546861
MD5 88803f7dea7f1cafb5099c5f5b7a52d2
BLAKE2b-256 776391cf068108ed0d168f49cc2f11c8b3f7615aa01beca3c1baf39863142504

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for financial_reports_generated_client-1.4.7-py3-none-any.whl
Algorithm Hash digest
SHA256 432ae8243d27ad2d591484bfecc6b29ac280ab632dda16c5a30ea77193830e20
MD5 02114941baa430f8a793d8ccb6d3014f
BLAKE2b-256 256be3a05e1c28898c7930d35d507ae63e1cc8478207b91acaac3168d8070599

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