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


Release history Release notifications | RSS feed

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.48.tar.gz (84.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.48.tar.gz.

File metadata

File hashes

Hashes for financial_reports_generated_client-1.4.48.tar.gz
Algorithm Hash digest
SHA256 17891d97c952b189c813bbb988b5ee62585b6ad0c4deaaf4862c01c70a6b7d5b
MD5 d4db686f93c11269f21a02073f971b63
BLAKE2b-256 e6c850e53c989a6339a59428b747b106758deacbee610fe403c2da5c4ee50086

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for financial_reports_generated_client-1.4.48-py3-none-any.whl
Algorithm Hash digest
SHA256 5a94cfa4b741e23c1fcaefc00fd445fffea3b5746b23426c2dafc50b1d1f6c7a
MD5 3d469403f9dcf765f30d57fe47f1dbb7
BLAKE2b-256 7dd106fd94bb28ce155488425a599fbed57b3bb03134a4a961b2cc0bd1a6546a

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