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.34.tar.gz (81.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.34.tar.gz.

File metadata

File hashes

Hashes for financial_reports_generated_client-1.4.34.tar.gz
Algorithm Hash digest
SHA256 e72c58fad3aca7c00f70c8fceebac621cb4b11ca4307d117bb3fd46a17832b6d
MD5 8db868bcba91e3a8de1d2334ddb7164a
BLAKE2b-256 80a0837010c686cf1d4bf228ce792b84bda54c517c32531c3afed04e5c658456

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for financial_reports_generated_client-1.4.34-py3-none-any.whl
Algorithm Hash digest
SHA256 00829e5717bcb7b53d640c9a98ff385cea797f2ba951a0f3fbfced041e5b04a1
MD5 aeffd08c3c9996987754c05ce456f49c
BLAKE2b-256 c76a9ba0221f3e3be8852f268db87bb14831a5eb6f2876305bfd094e8e48a663

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