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.45.tar.gz (84.7 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.45.tar.gz.

File metadata

File hashes

Hashes for financial_reports_generated_client-1.4.45.tar.gz
Algorithm Hash digest
SHA256 b3a203e44dddbcc975494fe3becc2e168ee9e6ebb336bcc3a9918e7b2dc68c26
MD5 a5ff43d874fafac362c95949ace7c65c
BLAKE2b-256 17a6b6818df6673a3afef3243862b5bb193256e9f4480770e98dd9aaff84147c

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for financial_reports_generated_client-1.4.45-py3-none-any.whl
Algorithm Hash digest
SHA256 accc94a72133eb32e97dae59fcde20366deece013cc613af4ee7592dcb8d4c52
MD5 1d4a6bbcd9e098e2b425851a07edbff5
BLAKE2b-256 7a931cd557ac22c25f164d2f53aba4df969b962afc245fcbc6792b77f1f6dea9

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