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


Release history Release notifications | RSS feed

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.44.tar.gz (84.6 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.44.tar.gz.

File metadata

File hashes

Hashes for financial_reports_generated_client-1.4.44.tar.gz
Algorithm Hash digest
SHA256 7cc410a3f9ba6d174c718a9e62a9784c2638f891710c42323791f0bf1d6d3f11
MD5 2acfe929d1ea8be774d159b80e76beec
BLAKE2b-256 9354f7dd09761b072814aba13c99ef13d816da7b1c7ebf4cfde6aa1f5bfafd33

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for financial_reports_generated_client-1.4.44-py3-none-any.whl
Algorithm Hash digest
SHA256 7ab61b4062368825ee20ac0f26ee2ad3f22b0e8f7d1df4ad5f27ea9566b792e7
MD5 4f99dc55e74f2a94613ef163efc92308
BLAKE2b-256 c0204896ebd4b56aa9470f9caba5ac2ce725b351f302739ee3c00ffa377a31d4

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