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.3.tar.gz (80.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.3.tar.gz.

File metadata

File hashes

Hashes for financial_reports_generated_client-1.4.3.tar.gz
Algorithm Hash digest
SHA256 d53f3652f13ee1b3a211483942b1dadb7d995b370ad98531dfff53ab5d694617
MD5 75c2f6b07f03d01dab618cac85c41feb
BLAKE2b-256 5055b18081f8a3dc1545151e60aa3fda5fe40135f53765eae01d71fcb838ff78

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for financial_reports_generated_client-1.4.3-py3-none-any.whl
Algorithm Hash digest
SHA256 12083756e3f579b824d160bfdbbe4756af9635aae7497512b24b9f96eb2e9f17
MD5 c16aff609b8d77d3bc8b9c4b3c46a501
BLAKE2b-256 d61efe36bbd823030fb0b4325f120f80fae242be3a349e7c89b37215924f2592

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