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

File metadata

File hashes

Hashes for financial_reports_generated_client-1.4.15.tar.gz
Algorithm Hash digest
SHA256 066ed07baf92a502255e6ac65322264ae38461a5caae0d99f9498c13ced3a327
MD5 a85ade06065b1305eecf1ea187ae6183
BLAKE2b-256 a9f33f446179579e468757d147c0e7ae6ee59e5f3fe1df146327fa873d804a6b

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for financial_reports_generated_client-1.4.15-py3-none-any.whl
Algorithm Hash digest
SHA256 182c79da08eb3d9c5f21f9ccfd9cd166411758930eeaad3aa74216e70e74e0f1
MD5 77d084bed307dcaf65415549e36b386b
BLAKE2b-256 6747b1befe4833e2a6c5aa79c44588e03358692844145adb38e046ea0f447ef5

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