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.37.tar.gz (78.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.37.tar.gz.

File metadata

File hashes

Hashes for financial_reports_generated_client-1.4.37.tar.gz
Algorithm Hash digest
SHA256 ad05eb5eeefaaf4a6e649ee19463bd5eef29d483a3ac5f4ff2ca9bf9e9d79e75
MD5 44143079d874e2b49695cd72a993a25c
BLAKE2b-256 5b07c72ea5228973647f88a332c10bf9254e97e2d5c5b746bd7daa603ab05f95

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for financial_reports_generated_client-1.4.37-py3-none-any.whl
Algorithm Hash digest
SHA256 1b895be2cf0f8dd3920af4a961f43f95e36fbe8c07ff2fac71a9b733d95ea2ff
MD5 fe800869ab410db3641e3171986d85e7
BLAKE2b-256 d3f9fcf2c1bb2c1754bb2f72e05d5d8572783136f1f99222b540d550c970debb

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