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

File metadata

File hashes

Hashes for financial_reports_generated_client-1.4.31.tar.gz
Algorithm Hash digest
SHA256 8dcd992f6074f506c2ef348e9f3d1c52e721cd30f0dda51206382ed2d533ec14
MD5 b005206a2179c5b84c50e4e699671b09
BLAKE2b-256 108bac233a6f9f2732095fe4504c50353c934617b8c40dbd3323108bc01495cd

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for financial_reports_generated_client-1.4.31-py3-none-any.whl
Algorithm Hash digest
SHA256 bfe0720d010fa8d5e04dbbb10afa55fade86932d3605447eba660bb0ecded8a8
MD5 466aa6b5d0f2f65d90dabaf3f112c70e
BLAKE2b-256 2ca115d8a6112c81bcc7f34d61f51b285df1642789571b705925284e7233134d

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