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.21.tar.gz (79.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.21.tar.gz.

File metadata

File hashes

Hashes for financial_reports_generated_client-1.4.21.tar.gz
Algorithm Hash digest
SHA256 df4068c93c5a52763ab46ae03512f98a69e60e6fa450f96504643dac0154c875
MD5 4702aa70e2de9603347a525de8dae5c5
BLAKE2b-256 f9c279b2ac53d3623bc72fbe75c6483b8067956ca9fb045a9a5ae4601999a39c

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for financial_reports_generated_client-1.4.21-py3-none-any.whl
Algorithm Hash digest
SHA256 a25efb4d630d141764da4f8d50f0c2ace9ab2ce36eec59b5e33fa0c74afa1255
MD5 722f007afee258a4735493c0c54e09be
BLAKE2b-256 a3135d59a0790a66def8a3b44bd808cda04a9a9b72c6d9b10c93ce3e9b081e00

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