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

File metadata

File hashes

Hashes for financial_reports_generated_client-1.4.4.tar.gz
Algorithm Hash digest
SHA256 1e505964613eebbd52aa903705bfed5079adbc1eea2085a34f8cad46b3e01098
MD5 6365d5dc3adc2856c0e9a2866ea47d0d
BLAKE2b-256 62bdf0aeffe79ec1fc2a76b7ffd0b7972b3050e029b9b799e142450593aaceb6

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for financial_reports_generated_client-1.4.4-py3-none-any.whl
Algorithm Hash digest
SHA256 4028e7489a8f17859cf61b024853193e76d9c10d42294ba6027d3c137cf378c8
MD5 226074bc4c51e1be1151574cad07a188
BLAKE2b-256 b3a56feadccc6665b40ade863c604475faa78be0e435a58922d031eff0a9c561

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