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

File metadata

File hashes

Hashes for financial_reports_generated_client-1.4.5.tar.gz
Algorithm Hash digest
SHA256 5fafcebc3241cef16bbf0babdc94ec98a4b05ee9bf69037cea9172da14c46584
MD5 24a2d9d1303f329ff4f7c8f15e6bfd7e
BLAKE2b-256 4d2a420922bea5f3c22724b111d7f0e0c1300b77139def9011fb8bc5c2f96898

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for financial_reports_generated_client-1.4.5-py3-none-any.whl
Algorithm Hash digest
SHA256 17f48db7a835168bb7c4cd0813e794f24384704871077e38804ff0f516236c8c
MD5 5a096b8abd308c34f32818d98eb2bc17
BLAKE2b-256 c1e0582802f265a982673dc60827587fa71fbc1771a2c7b9c5142915c345d2c4

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