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.20.tar.gz (79.1 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.20.tar.gz.

File metadata

File hashes

Hashes for financial_reports_generated_client-1.4.20.tar.gz
Algorithm Hash digest
SHA256 0c496f33693737bff1ea73b5a087be5c7a3627d9a8c7c63104cc3f6bb015fca4
MD5 ddfd6692a036b555b8d118b35a816b6b
BLAKE2b-256 735542a6863222642c7c5de1fcca08911bde85e7588f2aa45a92cf98ad89455b

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for financial_reports_generated_client-1.4.20-py3-none-any.whl
Algorithm Hash digest
SHA256 19bcd07475b30fec1ea00d34d7e0e65ecfcbff611509a94c0f77ace76a384780
MD5 3da34eab754bd4d09b13d80a8ab4d462
BLAKE2b-256 eab81e87a0061106f970ba427427523559a0c4ef056fa5548d5f8235b42ddf86

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