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.38.tar.gz (78.7 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.38.tar.gz.

File metadata

File hashes

Hashes for financial_reports_generated_client-1.4.38.tar.gz
Algorithm Hash digest
SHA256 c17ca75a72bfae34dd90cb50f6ec5520dfc01996af1da84352456a49bc86f8f3
MD5 6412588a6606a716cb1131e84603a1a3
BLAKE2b-256 d5cf160e53dde7161835bb6b866bfc8b0a2bc3f927e0889b1c131da26c43fda7

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for financial_reports_generated_client-1.4.38-py3-none-any.whl
Algorithm Hash digest
SHA256 8db7c75599d6c15f093729620265ff84017f059afbece269cd383465d64a3f01
MD5 c5bf1ebaf08f615d7b199648a5a4f2d0
BLAKE2b-256 411d9419480a2e780cb4cde3d6fbbe944681ab9e2a7b2f8a3d6535512bf2ab38

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