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

File metadata

File hashes

Hashes for financial_reports_generated_client-1.4.11.tar.gz
Algorithm Hash digest
SHA256 9d22a860cb4c757f7f67945a3d60806661159a5f05b9e801729aed3b516fe153
MD5 7f21a701e4489f9f8d5606e51b048d69
BLAKE2b-256 317fa49d62f9cff2da5dc40c547607a382b80140e882cb1ded143f272a0c08ac

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for financial_reports_generated_client-1.4.11-py3-none-any.whl
Algorithm Hash digest
SHA256 5684d94cf248dfc0c909552b196df1cc86b532347463ad709e58614cf6ac3fa9
MD5 502f3f34e4b67559337362e4450f529e
BLAKE2b-256 927cbcb97112421680261cb506fe219fa5b33df0b225394db5f1683a1eb240c4

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