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.19.tar.gz (79.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.19.tar.gz.

File metadata

File hashes

Hashes for financial_reports_generated_client-1.4.19.tar.gz
Algorithm Hash digest
SHA256 ca2dcd1b6426b9e48b9b5c40c8115270c2e6f9cf81afe7ec6eb35a8ca4bb2eaf
MD5 37e47aa0d9696b189cd95abe52907f80
BLAKE2b-256 e69f082052852a099310de4dfe37242ade9c1780b9290c5a34b24a4a91befc0b

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for financial_reports_generated_client-1.4.19-py3-none-any.whl
Algorithm Hash digest
SHA256 41bc1fc25649332ef17b216f720e0bbcb720a7dcedab044a8d1625cfa083f386
MD5 1b5f9f2717bda01b40421c81f916cab5
BLAKE2b-256 d8b057080b04f94daa63df09998e575d4558ba599a0731af57c33401f09ec2f9

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