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.39.tar.gz (76.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.39.tar.gz.

File metadata

File hashes

Hashes for financial_reports_generated_client-1.4.39.tar.gz
Algorithm Hash digest
SHA256 4cfe0ef4d08f20691afd6f98761f0f54016441a57398ce4f591c9a2ee134b946
MD5 3fc0b05a680c134cf4fd0ee87aa50b78
BLAKE2b-256 abed6fb91ab5136b3b422e33af0d76f5e65aa5580815aafcc6804ad0642d0a67

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for financial_reports_generated_client-1.4.39-py3-none-any.whl
Algorithm Hash digest
SHA256 292afee073c7638baa31f840e2468f1c10743be0e1bdfbda665f2626c7585a14
MD5 f78a13017bcc1f8c7aecb9d60e52bff9
BLAKE2b-256 87933eb110566adbf4f9b461cffb7acce9a5328bad3b6fa93e2874bffd14c3ac

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