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

File metadata

File hashes

Hashes for financial_reports_generated_client-1.4.6.tar.gz
Algorithm Hash digest
SHA256 16ef9147d5475ba2688cabc87f523cf0bf5266fa486a0846885ff8fa34b7b010
MD5 576687307d30c6632f62a4d7fa2bb5a9
BLAKE2b-256 2a1c2a686277027f132cea5825f8425d90e8c5829cd96e60a9aff737f3f4b5bc

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for financial_reports_generated_client-1.4.6-py3-none-any.whl
Algorithm Hash digest
SHA256 5de69974ee760f1db259fdbcd1e04abaf98f5539cb5001e9ceca82f19bf30654
MD5 e9a3cb32786f70d20b71d76d394bd9bc
BLAKE2b-256 79df24bf595f98f44ebd552f438575c9db77edfc16b9f0ab3fd9fe450c0f8175

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