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.32.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.32.tar.gz.

File metadata

File hashes

Hashes for financial_reports_generated_client-1.4.32.tar.gz
Algorithm Hash digest
SHA256 6d2824d0e6e92e70e4192be41cf1b349aa41cc1e02079f7f7431c93a6d0e7f98
MD5 94b0ac8b3f1f94c6f6b33d1f159088cb
BLAKE2b-256 ed9ab36f416e1c9ace8fda49418cab75b4569af9a80e089414c0cd14214f9f98

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for financial_reports_generated_client-1.4.32-py3-none-any.whl
Algorithm Hash digest
SHA256 1c711155eb8b3e567aca9ae60e068e1de3e6852e137201289c5d1d4b9b1747b2
MD5 3cdb61413784dc449f550e79e49ffe15
BLAKE2b-256 2de83fb7d91c1946688b2db51acf5de8c05fd52fd9f3e37ac0bc0a6e4c031e0f

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