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

File metadata

File hashes

Hashes for financial_reports_generated_client-1.4.17.tar.gz
Algorithm Hash digest
SHA256 4630b025d0548270473b483070ead8fe7f9a5f065894054a873dc56a4b6b053c
MD5 a88005cd1210d72b4ce628c78d5c2d4f
BLAKE2b-256 da12f0f1a84a43ec4e7e30b7c032801202c00f7bceb4ea4619a582b31897903e

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for financial_reports_generated_client-1.4.17-py3-none-any.whl
Algorithm Hash digest
SHA256 1341bde92b9d8c387d176e226218e6f0d4af5dd788450d896b830c54b1fd98b7
MD5 3d315e6afe322a70c21103fbc37d6e64
BLAKE2b-256 5b2cef0cf8bf784686e6d84f0ae848ad9ab5a62ce845b76a8b987b09f4720486

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