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.35.tar.gz (78.0 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.35.tar.gz.

File metadata

File hashes

Hashes for financial_reports_generated_client-1.4.35.tar.gz
Algorithm Hash digest
SHA256 1c4e23167ec6fe5992b95501a8dcd5b545efa9421f0d51ab07c34407e479c915
MD5 6d23cc95f8db97262800a4391831b197
BLAKE2b-256 9b03432e499d3869f2035e71d3e7d7da7abdf09ccab9e8c23a52a41f9e086f1b

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for financial_reports_generated_client-1.4.35-py3-none-any.whl
Algorithm Hash digest
SHA256 159af71baabc99c6297c86b3308fb5db3f8fdd724aeb17c1bd18e3c66ce4571e
MD5 a94ed12d178a6cd1a8c23d157fdc696c
BLAKE2b-256 83e09ca119fe458f3d11058fbe9b65b1abce603cd0ab696ccebdf8f223e2a2d5

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