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.23.tar.gz (79.2 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.23.tar.gz.

File metadata

File hashes

Hashes for financial_reports_generated_client-1.4.23.tar.gz
Algorithm Hash digest
SHA256 00b4f1a5123f2749943b27954c63bd74759ae8d3d83d4adc66a295835115fa31
MD5 df34587e9f89e9ae26b2ce37ee3a469a
BLAKE2b-256 57baac212a0b5781a5e8da12c39e4dec2c579a0897670f6294ccce3b8c5f6c8b

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for financial_reports_generated_client-1.4.23-py3-none-any.whl
Algorithm Hash digest
SHA256 17a18f2f716871af8a49c3ca0987b7834d197cba209ba2bfc21d7b070aab92f1
MD5 8283d56326f3b121b82a4f199b8e4430
BLAKE2b-256 73cef08861587101d2a9e609e3ae4dbb45d12c7b1a9fc876401f1059a058e4d7

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