English | 简体中文

FinancialFilings Python SDK

The official Python client for the FinancialFilings 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 FR_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())

Credits

One key reaches every endpoint, and each call is priced in credits: metadata and search, filing Markdown and standardized financials each have their own cost, with free credits every month. Per-endpoint costs: https://financialfilings.com/developers/

Documentation

• Developer docs: https://financialfilings.com/developers/
• Full API Reference: https://financialfilings.com/developers/reference/
• Support: support@financialfilings.com

Generated by FinancialFilings Engineering.