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

File metadata

File hashes

Hashes for financial_reports_generated_client-1.4.28.tar.gz
Algorithm Hash digest
SHA256 ec413ad2521f7a36d4b7645489b57573c36041114b0dd7e8fb5da8d43ef347d7
MD5 02f6c4c271736d6d6ff7f10d9888b48c
BLAKE2b-256 5275d782cbd37aed17fcefa111eef746b16a5cab254d24f0ff58974de5bc763f

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for financial_reports_generated_client-1.4.28-py3-none-any.whl
Algorithm Hash digest
SHA256 68eab3424ce0cb0d92caaaaf885be7d1078db4d559a688d9a646c8a0e6de7b8f
MD5 02f847d0717068b6f70622ed2a6ae58f
BLAKE2b-256 93fd785c039d7fe7492a5b59e72e6ed2472b0106b38dbe45b847b5497dda300e

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