# ranaroussi/yfinance architecture

> Architecture diagram of the GitHub repository ranaroussi/yfinance, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-11-09). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/ranaroussi/yfinance
- Repository: https://github.com/ranaroussi/yfinance

## Overview

yfinance is a Python client for Yahoo Finance market data. Users access single- and multi-ticker data, historical prices, search, screening, market and sector/industry information, and live streams through its public APIs. The principal download path is ticker-oriented: ticker objects expose data capabilities implemented by scrapers, which use a shared data layer to make Yahoo requests and return parsed results. The README documents additional API branches; unsampled implementations are represented by their exact directories, and uncertain connections are omitted.

Main entry points: [`yfinance/ticker.py`](https://github.com/ranaroussi/yfinance/blob/main/yfinance/ticker.py) (Ticker), [`yfinance/data.py`](https://github.com/ranaroussi/yfinance/blob/main/yfinance/data.py) (Yahoo data access), [`yfinance/screener/screener.py`](https://github.com/ranaroussi/yfinance/blob/main/yfinance/screener/screener.py) (Screener), [`yfinance/tickers.py`](https://github.com/ranaroussi/yfinance/blob/main/yfinance/tickers.py) (Tickers)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_api["Public API"]
  node_ticker["Ticker<br/>[ticker.py]"]
  node_tickers["Tickers<br/>[tickers.py]"]
  node_download["Bulk download<br/>[multi.py]"]
end

subgraph group_domain["Market Data Features"]
  node_history["Price history<br/>[history.py]"]
  node_quote["Quote data<br/>[quote.py]"]
  node_funds["Fund data<br/>[funds.py]"]
  node_analysis["Analysis data<br/>[analysis.py]"]
  node_fundamentals["Fundamentals<br/>[fundamentals.py]"]
  node_holders["Holder data<br/>[holders.py]"]
  node_search["Search<br/>[search.py]"]
  node_lookup["Symbol lookup<br/>[lookup.py]"]
  node_market["Market info<br/>[market.py]"]
  node_sector["Sector info<br/>[sector.py]"]
  node_industry["Industry info<br/>[industry.py]"]
  node_screener["Screener<br/>[screener.py]"]
  node_query["Screen queries<br/>[query.py]"]
  node_live["Live streams<br/>[live.py]"]
  node_calendars["Calendars<br/>[calendars.py]"]
end

subgraph group_transport["Data Transport"]
  node_data["Yahoo data access<br/>[data.py]"]
  node_http["HTTP backend<br/>[_http.py]"]
end

subgraph group_support["Shared Support"]
  node_cache[("Response cache<br/>[cache.py]")]
  node_config["Configuration<br/>[config.py]"]
end

node_user(("Python user"))
node_yahoo{{"Yahoo Finance"}}

node_user -->|"uses"| node_ticker
node_user -->|"uses"| node_tickers
node_user -->|"downloads"| node_download
node_user -->|"searches"| node_search
node_user -->|"queries"| node_market
node_user -->|"queries"| node_sector
node_user -->|"queries"| node_industry
node_user -->|"screens"| node_screener
node_user -->|"streams"| node_live
node_ticker -.->|"exposes"| node_history
node_ticker -.->|"exposes"| node_quote
node_ticker -.->|"exposes"| node_funds
node_ticker -.->|"exposes"| node_analysis
node_ticker -.->|"exposes"| node_fundamentals
node_ticker -.->|"exposes"| node_holders
node_tickers -.->|"delegates"| node_download
node_screener -->|"accepts"| node_query
node_screener -->|"posts query"| node_data
node_market -->|"uses"| node_data
node_sector -->|"uses"| node_data
node_industry -->|"uses"| node_data
node_data -->|"uses"| node_http
node_data -->|"requests data"| node_yahoo

click node_ticker "https://github.com/ranaroussi/yfinance/blob/main/yfinance/ticker.py"
click node_tickers "https://github.com/ranaroussi/yfinance/blob/main/yfinance/tickers.py"
click node_download "https://github.com/ranaroussi/yfinance/blob/main/yfinance/multi.py"
click node_history "https://github.com/ranaroussi/yfinance/blob/main/yfinance/scrapers/history.py"
click node_quote "https://github.com/ranaroussi/yfinance/blob/main/yfinance/scrapers/quote.py"
click node_funds "https://github.com/ranaroussi/yfinance/blob/main/yfinance/scrapers/funds.py"
click node_analysis "https://github.com/ranaroussi/yfinance/blob/main/yfinance/scrapers/analysis.py"
click node_fundamentals "https://github.com/ranaroussi/yfinance/blob/main/yfinance/scrapers/fundamentals.py"
click node_holders "https://github.com/ranaroussi/yfinance/blob/main/yfinance/scrapers/holders.py"
click node_search "https://github.com/ranaroussi/yfinance/blob/main/yfinance/search.py"
click node_lookup "https://github.com/ranaroussi/yfinance/blob/main/yfinance/lookup.py"
click node_market "https://github.com/ranaroussi/yfinance/blob/main/yfinance/domain/market.py"
click node_sector "https://github.com/ranaroussi/yfinance/blob/main/yfinance/domain/sector.py"
click node_industry "https://github.com/ranaroussi/yfinance/blob/main/yfinance/domain/industry.py"
click node_screener "https://github.com/ranaroussi/yfinance/blob/main/yfinance/screener/screener.py"
click node_query "https://github.com/ranaroussi/yfinance/blob/main/yfinance/screener/query.py"
click node_live "https://github.com/ranaroussi/yfinance/blob/main/yfinance/live.py"
click node_calendars "https://github.com/ranaroussi/yfinance/blob/main/yfinance/calendars.py"
click node_data "https://github.com/ranaroussi/yfinance/blob/main/yfinance/data.py"
click node_http "https://github.com/ranaroussi/yfinance/blob/main/yfinance/_http.py"
click node_cache "https://github.com/ranaroussi/yfinance/blob/main/yfinance/cache.py"
click node_config "https://github.com/ranaroussi/yfinance/blob/main/yfinance/config.py"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_ticker,node_tickers,node_download,node_user toneBlue
class node_history,node_quote,node_funds,node_analysis,node_fundamentals,node_holders,node_search,node_lookup,node_market,node_sector,node_industry,node_screener,node_query,node_live,node_calendars toneAmber
class node_data,node_http toneMint
class node_cache,node_config toneRose
class node_yahoo toneIndigo
```

## Components

### Public API

- [Ticker](https://github.com/ranaroussi/yfinance/blob/main/yfinance/ticker.py): `yfinance/ticker.py`
- [Tickers](https://github.com/ranaroussi/yfinance/blob/main/yfinance/tickers.py): `yfinance/tickers.py`
- [Bulk download](https://github.com/ranaroussi/yfinance/blob/main/yfinance/multi.py): `yfinance/multi.py`

### Market Data Features

- [Price history](https://github.com/ranaroussi/yfinance/blob/main/yfinance/scrapers/history.py): `yfinance/scrapers/history.py`
- [Quote data](https://github.com/ranaroussi/yfinance/blob/main/yfinance/scrapers/quote.py): `yfinance/scrapers/quote.py`
- [Fund data](https://github.com/ranaroussi/yfinance/blob/main/yfinance/scrapers/funds.py): `yfinance/scrapers/funds.py`
- [Analysis data](https://github.com/ranaroussi/yfinance/blob/main/yfinance/scrapers/analysis.py): `yfinance/scrapers/analysis.py`
- [Fundamentals](https://github.com/ranaroussi/yfinance/blob/main/yfinance/scrapers/fundamentals.py): `yfinance/scrapers/fundamentals.py`
- [Holder data](https://github.com/ranaroussi/yfinance/blob/main/yfinance/scrapers/holders.py): `yfinance/scrapers/holders.py`
- [Search](https://github.com/ranaroussi/yfinance/blob/main/yfinance/search.py): `yfinance/search.py`
- [Symbol lookup](https://github.com/ranaroussi/yfinance/blob/main/yfinance/lookup.py): `yfinance/lookup.py`
- [Market info](https://github.com/ranaroussi/yfinance/blob/main/yfinance/domain/market.py): `yfinance/domain/market.py`
- [Sector info](https://github.com/ranaroussi/yfinance/blob/main/yfinance/domain/sector.py): `yfinance/domain/sector.py`
- [Industry info](https://github.com/ranaroussi/yfinance/blob/main/yfinance/domain/industry.py): `yfinance/domain/industry.py`
- [Screener](https://github.com/ranaroussi/yfinance/blob/main/yfinance/screener/screener.py): `yfinance/screener/screener.py`
- [Screen queries](https://github.com/ranaroussi/yfinance/blob/main/yfinance/screener/query.py): `yfinance/screener/query.py`
- [Live streams](https://github.com/ranaroussi/yfinance/blob/main/yfinance/live.py): `yfinance/live.py`
- [Calendars](https://github.com/ranaroussi/yfinance/blob/main/yfinance/calendars.py): `yfinance/calendars.py`

### Data Transport

- [Yahoo data access](https://github.com/ranaroussi/yfinance/blob/main/yfinance/data.py): `yfinance/data.py`
- [HTTP backend](https://github.com/ranaroussi/yfinance/blob/main/yfinance/_http.py): `yfinance/_http.py`

### Shared Support

- [Response cache](https://github.com/ranaroussi/yfinance/blob/main/yfinance/cache.py): `yfinance/cache.py`
- [Configuration](https://github.com/ranaroussi/yfinance/blob/main/yfinance/config.py): `yfinance/config.py`

### Other components

- **Python user**
- **Yahoo Finance**

## Connections

- Python user → Ticker: uses (evidence: `README.md`)
- Python user → Tickers: uses (evidence: `README.md`)
- Python user → Bulk download: downloads (evidence: `README.md`)
- Python user → Search: searches (evidence: `README.md`)
- Python user → Market info: queries (evidence: `README.md`)
- Python user → Sector info: queries (evidence: `README.md`)
- Python user → Industry info: queries (evidence: `README.md`)
- Python user → Screener: screens (evidence: `README.md`)
- Python user → Live streams: streams (evidence: `README.md`)
- Ticker → Price history: exposes
- Ticker → Quote data: exposes
- Ticker → Fund data: exposes (evidence: `yfinance/ticker.py`)
- Ticker → Analysis data: exposes
- Ticker → Fundamentals: exposes
- Ticker → Holder data: exposes
- Tickers → Bulk download: delegates (evidence: `yfinance/tickers.py`)
- Screener → Screen queries: accepts (evidence: `yfinance/screener/screener.py`)
- Screener → Yahoo data access: posts query (evidence: `yfinance/screener/screener.py`)
- Market info → Yahoo data access: uses (evidence: `yfinance/domain/market.py`)
- Sector info → Yahoo data access: uses (evidence: `yfinance/domain/sector.py`)
- Industry info → Yahoo data access: uses (evidence: `yfinance/domain/industry.py`)
- Yahoo data access → HTTP backend: uses (evidence: `yfinance/data.py`)
- Yahoo data access → Yahoo Finance: requests data (evidence: `yfinance/data.py`)
