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.10.tar.gz (78.3 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.10.tar.gz.

File metadata

File hashes

Hashes for financial_reports_generated_client-1.4.10.tar.gz
Algorithm Hash digest
SHA256 51af1d88c6ac0c0098226224582aae4c0f14a8b0d0c2e553caa242638e14b581
MD5 0fc4b6ca0029f421568b8afd487d76bc
BLAKE2b-256 16f9a4abe12a7109cc5479bbc30be325ca3f79a9fe1d0f01a675d1d9cc7a30bc

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for financial_reports_generated_client-1.4.10-py3-none-any.whl
Algorithm Hash digest
SHA256 ccc1c0611b3e3a6a5d448d589c3967da237902e229b5788f23e522a30dfa4656
MD5 9f62a3c112cd902b81a10eafe997a254
BLAKE2b-256 50b3a9d155f21aa155ae17fdde044cfbdc08f9a5de4d5d0eb9968744389971f3

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