# Fonrex Documentation

> Fonrex is an open-source, self-hosted financial data API (FastAPI, PostgreSQL/TimescaleDB, Redis):
> end-of-day prices per listing, real-time quotes, fundamentals with their sources, technical indicators,
> news, DCF valuations and provider health monitoring. Every client talks to its own instance; an API key
> is required by default.

## Introduction

- [Introduction to Fonrex](https://docs.fonrex.io/docs/intro): Overview of Fonrex, the open-source self-hosted financial data API

## Guided Pathways

- [Quant & Algo-Trader Pathway](https://docs.fonrex.io/docs/pathways/quant-trader): From an empty instance to backtests: ingest prices per listing, compute indicators server-side, feed Zipline
- [Financial Analyst Pathway](https://docs.fonrex.io/docs/pathways/financial-analyst): Fundamentals with their sources, DCF valuations, Google Sheets and OpenBB Workspace on your own instance
- [App Developer Pathway](https://docs.fonrex.io/docs/pathways/app-developer): Integrate a Fonrex instance in an application: authentication, REST routes, WebSocket stream, errors and caching
- [DevOps & Infra Admin Pathway](https://docs.fonrex.io/docs/pathways/devops-admin): Install, secure, upgrade, back up and monitor a Fonrex instance

## Getting Started

- [Installation Guide](https://docs.fonrex.io/docs/getting-started/installation): Install and run a self-hosted Fonrex instance with Docker Compose
- [System Configuration](https://docs.fonrex.io/docs/getting-started/configuration): Reference of the Fonrex settings read from .env
- [Making Your First API Call](https://docs.fonrex.io/docs/getting-started/first-api-call): Authenticate and query prices, indicators and real-time quotes with cURL, Python and WebSocket clients
- [Docker Compose Topology](https://docs.fonrex.io/docs/getting-started/docker-compose): Containers, ports, volumes, health checks and everyday operations of the Fonrex stack

## API Reference

- [Asset & Listing API Reference](https://docs.fonrex.io/docs/api-reference/assets): Instruments, listings and end-of-day prices of the Fonrex catalogue
- [Fundamental Financials API Reference](https://docs.fonrex.io/docs/api-reference/fundamentals): Multi-provider fundamentals in the EODHD layout and stored deep fundamentals
- [Historical Ingestion API Reference](https://docs.fonrex.io/docs/api-reference/historical): Ingest end-of-day prices into TimescaleDB and read them back
- [Realtime & WebSocket API Reference](https://docs.fonrex.io/docs/api-reference/realtime): WebSocket price stream, quote snapshots and stream subscriptions
- [Technical Indicators API Reference](https://docs.fonrex.io/docs/api-reference/technical-indicators): 18 server-side technical indicators, multi-indicator requests, chart data and a screener
- [DCF Valuation API Reference](https://docs.fonrex.io/docs/api-reference/valuation-dcf): Intrinsic value with three DCF models, dynamic WACC, model comparison, sensitivity matrix and macro rates
- [News Aggregator API Reference](https://docs.fonrex.io/docs/api-reference/news): News of a ticker from 7 providers, deduplicated, and the global feed of stored articles
- [Provider Monitoring & Administration API Reference](https://docs.fonrex.io/docs/api-reference/monitoring): Provider health, canary runs, alerts, validation statistics, cache and database administration
- [Specialized Providers API Reference](https://docs.fonrex.io/docs/api-reference/specialized): SEC insider transactions, UCITS ETF details from JustETF and index constituents
- [OpenBB Workspace Integration API](https://docs.fonrex.io/docs/api-reference/openbb): The /openbb routes and discovery files that feed OpenBB Workspace widgets

## Guides

- [Asset CSV Import Pipeline Guide](https://docs.fonrex.io/docs/guides/import-assets): Import instruments and listings from CSV files with import_assets.py
- [Ingesting Historical Market Data](https://docs.fonrex.io/docs/guides/ingest-historical-data): How Fonrex fetches, verifies and stores end-of-day prices per listing
- [Realtime Streaming & WebSocket Setup](https://docs.fonrex.io/docs/guides/configure-realtime): Start TradingView streams, receive ticks over WebSocket and tune the realtime worker
- [Backtesting with Zipline](https://docs.fonrex.io/docs/guides/backtesting-zipline): Run zipline-reloaded backtests on the prices of your Fonrex database, or load them into pandas
- [Using Fonrex from Python and Jupyter](https://docs.fonrex.io/docs/guides/python-jupyter): Load prices from your Fonrex instance into pandas, and replace OpenBB price calls in a notebook
- [Guide: Adding a Fundamentals Provider](https://docs.fonrex.io/docs/guides/adding-providers): Every step a new fundamentals provider needs: code, registration, units, canary, tests and coverage floor
- [Google Sheets Connector](https://docs.fonrex.io/docs/guides/google-sheets-connector): Fill a Google Sheets template with fundamentals, DCF valuations and indicators from your own Fonrex instance
- [Connecting Fonrex to OpenBB Workspace](https://docs.fonrex.io/docs/guides/openbb-workspace): Connect your self-hosted Fonrex instance to OpenBB Workspace widgets and dashboards

## Architecture

- [Architecture Overview](https://docs.fonrex.io/docs/architecture/overview): Components, data flows and start-up of a Fonrex instance
- [Layers & Ports](https://docs.fonrex.io/docs/architecture/hexagonal): How Fonrex separates HTTP adapters, application logic and adapters to the outside, and how far each feature follows it
- [Data Model & Schema Reference](https://docs.fonrex.io/docs/architecture/data-model): Instruments, listings and provider mappings, per-listing prices on TimescaleDB, fundamentals and monitoring tables
- [Schema Migrations (Alembic)](https://docs.fonrex.io/docs/architecture/migrations): The Alembic migration chain, how it runs and how to add a migration
- [Concurrency & Async Execution](https://docs.fonrex.io/docs/architecture/concurrency): How Fonrex runs blocking calls without blocking the FastAPI event loop

## Providers

- [Providers Architecture Overview](https://docs.fonrex.io/docs/providers/overview): How Fonrex queries its providers in parallel, chooses the search term, validates the values and shares one HTTP layer
- [Fundamental Providers List](https://docs.fonrex.io/docs/providers/fundamentals-providers): The providers queried by /fundamental and the specialised providers
- [News Aggregator Providers](https://docs.fonrex.io/docs/providers/news-providers): The 7 news providers, their mappings and the deduplication of articles
- [Custom Provider Implementation Reference](https://docs.fonrex.io/docs/providers/adding-custom-provider): Skeleton of a fundamentals provider and the helpers of BaseFinancialProvider

## Monitoring

- [Validation Layer Architecture](https://docs.fonrex.io/docs/monitoring/validation-layer): Range and consensus checks applied to every provider value before it reaches an answer
- [Canary Monitor Suite](https://docs.fonrex.io/docs/monitoring/canary-monitor): Daily check of every fundamentals provider against known assets and expected ranges
- [Provider Alerts & Resolution](https://docs.fonrex.io/docs/monitoring/alerts): The alerts raised by the canary, their severity, automatic and manual resolution

## Deployment

- [Docker Production Deployment](https://docs.fonrex.io/docs/deployment/docker): Run Fonrex on a server: Compose overrides, reverse proxy with TLS and WebSocket, what to expose
- [Environment Variables Deployment Reference](https://docs.fonrex.io/docs/deployment/environment-variables): The settings that matter when deploying Fonrex, and how .env reaches the containers
- [Database Migrations in Production](https://docs.fonrex.io/docs/deployment/database-migrations): Upgrade an instance safely: back up, migrate, check, and restore if needed
- [Production Deployment Checklist](https://docs.fonrex.io/docs/deployment/production-checklist): Security, configuration, monitoring and backup checks before exposing an instance

## Contributing

- [Development Environment Setup](https://docs.fonrex.io/docs/contributing/setup): Run Fonrex from source with locked dependencies, a local database and the quality gate
- [Testing Guidelines & Execution](https://docs.fonrex.io/docs/contributing/testing): The quality gate, the database tests and how to test providers without network
- [Architecture Rules & Guidelines](https://docs.fonrex.io/docs/contributing/architecture-rules): The contribution rules of AGENTS.md and the test that holds each one
- [Fonrex Version Changelog](https://docs.fonrex.io/docs/contributing/changelog): Project history, feature additions, schema migrations, and version updates

## Complete documentation

- [llms-full.txt](https://docs.fonrex.io/llms-full.txt): every page
- [llms-docs.txt](https://docs.fonrex.io/llms-docs.txt): guides, architecture, operations
- [llms-api.txt](https://docs.fonrex.io/llms-api.txt): API reference