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.8.tar.gz (78.4 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.8.tar.gz.

File metadata

File hashes

Hashes for financial_reports_generated_client-1.4.8.tar.gz
Algorithm Hash digest
SHA256 2ef31ec72881f306df9bf85f39e6d6f3e1fde021438c1df9893e2039db2ce3bb
MD5 f4ce96ed83e321412145ebb2df496876
BLAKE2b-256 1a6149d32a7d0a700bfeb3fc2545c041d8959675a9fae03e9bc2eababbf02a35

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for financial_reports_generated_client-1.4.8-py3-none-any.whl
Algorithm Hash digest
SHA256 89d0fb264ba96c4100d04f108ffe07c79e54291858d1d3bc70d196c56ff477b4
MD5 c3a31eea66ace8c676996468e91a51a9
BLAKE2b-256 8561c1ee532af9a86764c3c80d6362357dddd83c3a5084daa9a5549e661e5082

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