{"id":38570433,"url":"https://github.com/financial-reports/financial-reports-code-examples","last_synced_at":"2026-01-17T08:00:23.726Z","repository":{"id":319991040,"uuid":"1079676747","full_name":"financial-reports/financial-reports-code-examples","owner":"financial-reports","description":"Official FinancialReports Code Cookbook. 🍳 Production-ready Python scripts \u0026 notebooks to accelerate financial analysis, from API integration to bulk data dump processing.","archived":false,"fork":false,"pushed_at":"2025-12-18T07:24:54.000Z","size":335,"stargazers_count":3,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-12-21T15:27:14.911Z","etag":null,"topics":["analysis","examples","examples-python","finance","stocks","trading"],"latest_commit_sha":null,"homepage":"https://financialreports.eu/","language":"Jupyter Notebook","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/financial-reports.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2025-10-20T08:01:00.000Z","updated_at":"2025-12-18T07:24:58.000Z","dependencies_parsed_at":"2025-10-21T11:25:24.266Z","dependency_job_id":"82c4aab2-b3a0-45c3-b1d0-b365e78bb9a1","html_url":"https://github.com/financial-reports/financial-reports-code-examples","commit_stats":null,"previous_names":["financial-reports/financial-reports-code-examples"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/financial-reports/financial-reports-code-examples","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/financial-reports%2Ffinancial-reports-code-examples","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/financial-reports%2Ffinancial-reports-code-examples/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/financial-reports%2Ffinancial-reports-code-examples/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/financial-reports%2Ffinancial-reports-code-examples/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/financial-reports","download_url":"https://codeload.github.com/financial-reports/financial-reports-code-examples/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/financial-reports%2Ffinancial-reports-code-examples/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28504358,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-17T06:57:29.758Z","status":"ssl_error","status_checked_at":"2026-01-17T06:56:03.931Z","response_time":85,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["analysis","examples","examples-python","finance","stocks","trading"],"created_at":"2026-01-17T08:00:12.799Z","updated_at":"2026-01-17T08:00:23.571Z","avatar_url":"https://github.com/financial-reports.png","language":"Jupyter Notebook","funding_links":[],"categories":[],"sub_categories":[],"readme":"![FinancialReports Logo](https://cdn.financialreports.eu/financialreports/static/assets/logo.svg)\n# The FinancialReports Code Cookbook\n\nWelcome to the official FinancialReports code cookbook. This repository provides practical, production-ready solutions to accelerate your financial data analysis. Our goal is to help you go from raw data to actionable insights in minutes.\n\nThis \"cookbook\" provides clients and developers with scripts and notebooks to accelerate integration with:\n\n1.  **The FinancialReports REST API**\n2.  **FinancialReports Data Dumps**\n\n## How to Use This Cookbook\n\n1.  **Start with the Basics:** If you're new, begin with our `00_Getting_Started.ipynb` notebook.\n2.  **Find Your Goal:** Browse the **Recipe Index** below to find the category that matches your problem.\n3.  **Explore the Examples:** Click the link to navigate to the relevant directory and explore the self-contained examples inside.\n\nEvery example has its own `README.md` with specific instructions.\n\n---\n\n## Recipe Index\n\n| Goal / Use Case | Explore Recipes In | Description |\n| :--- | :--- | :--- |\n| **Start Here: Learn the Basics** | **[`00_Getting_Started.ipynb`](./00_Getting_Started.ipynb)** | Learn how to set your API key, make your first API calls, and handle responses. |\n| **Solve a Real-World Problem** | **[`/use-cases/`](./use-cases/)** | Advanced workflows that combine multiple tools to solve complex problems like competitor analysis or bulk readability scoring. |\n| **Process a Large Data Dump** | **[`/data-dump-processing/`](./data-dump-processing/)** | Production-ready scripts to handle bulk data, like loading a huge CSV into a high-performance SQLite database. |\n| **Analyze Filing Content** | **[`/analysis/`](./analysis/)** | Standalone notebooks for specific analytical tasks like calculating readability (Gunning Fog) or counting keyword mentions. |\n| **Find a Simple API Snippet** | **[`/api-examples/`](./api-examples/)** | A collection of basic, standalone Python scripts for individual API endpoints (e.g., get a company, search filings). |\n\n---\n\n## Authentication\n\nFor all examples that use the API, you must set your API key as an environment variable. **Never hardcode your key.**\n\n```bash\n# On macOS / Linux\nexport FR_API_KEY=\"your_api_key_here\"\n\n# On Windows (Command Prompt)\n# set FR_API_KEY=\"your_api_key_here\"\n```\n\n## Links \u0026 Support\n\n* **Main Website**: https://financialreports.eu/\n* **API Documentation**: https://docs.financialreports.eu/\n* **Python SDK (PyPI)**: https://pypi.org/project/financial-reports-generated-client/\n* **Support**: Contact `support@financialreports.eu` for questions.\n\n## Contributing\n\nWe welcome contributions! Please see our updated `CONTRIBUTING.md` file for detailed guidelines on code standards and our preference for Jupyter Notebooks for analysis.","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffinancial-reports%2Ffinancial-reports-code-examples","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffinancial-reports%2Ffinancial-reports-code-examples","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffinancial-reports%2Ffinancial-reports-code-examples/lists"}