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.27.tar.gz (73.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.27.tar.gz.

File metadata

File hashes

Hashes for financial_reports_generated_client-1.4.27.tar.gz
Algorithm Hash digest
SHA256 1b1038485c07b80e3eedcfddade46ba39689faa8db00f20b27c8f87b987b2205
MD5 7853e02dbf35b6ca3958c8be3678b38a
BLAKE2b-256 d5c0d8abf5d0de5693c37ccff01a99898f8e40e68fe541c7e141c42ee6d1651a

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for financial_reports_generated_client-1.4.27-py3-none-any.whl
Algorithm Hash digest
SHA256 2045d3a5b1d109f7b9632c00f211e6347bd5423a022b7b30b8140801a14cb892
MD5 98959ca5c9fbd7adeed56ec0ce99098b
BLAKE2b-256 db1d0d8461219ddc87efe8b41cf59b3b0623a80b215236a7c4a896a6751ca26d

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