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.36.tar.gz (78.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.36.tar.gz.

File metadata

File hashes

Hashes for financial_reports_generated_client-1.4.36.tar.gz
Algorithm Hash digest
SHA256 8cf2d52ad5cd8af468314c56e6f6648c2f321ab50dc8915a999701c7181eed96
MD5 ec70c6cb45ae7d2dc33a5f7a983b5347
BLAKE2b-256 769a88ee24d4112f3379fd1fae1e999f6d6041a5a0d15eea89d55042d2251a02

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for financial_reports_generated_client-1.4.36-py3-none-any.whl
Algorithm Hash digest
SHA256 3a74e17607f601a5c576aff387a2debc283fd8de3231529125247e04c98fa7ad
MD5 97ecdf29dba48342e29470b9cc7dd057
BLAKE2b-256 ada5dd5d30170e8c1856fabcd4ac33b5a25321c9743b159926636638bd509674

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