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

File metadata

File hashes

Hashes for financial_reports_generated_client-1.4.18.tar.gz
Algorithm Hash digest
SHA256 2c625bc10c64a5db601e5b4c7681ba4b56d258568fd9963aeb7ff46d62626248
MD5 71c53aa15ac9e1eb6b497122bb1f17d4
BLAKE2b-256 30f58128cba406984e687524517e1be61bba240e7b1cf2729ca7a97932d09f22

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for financial_reports_generated_client-1.4.18-py3-none-any.whl
Algorithm Hash digest
SHA256 b0e69c350dab5504cc43e39947e394330cbda69179354a2e46886b101dcbd1bd
MD5 60776ec66cacc6ae2a9c2b4c59f98778
BLAKE2b-256 ae3de4c2cb5a9c185987eb587dd3c967108a541045290fad4d6a3df087703663

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