# mathieu2301/tradingview-api architecture

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

- Interactive diagram: https://gitdiagram.com/mathieu2301/tradingview-api
- Repository: https://github.com/mathieu2301/tradingview-api

## Overview

TradingView-API is a TypeScript library for retrieving TradingView market data, working with chart and quote sessions, and backtesting trading rules. The main user workflow is to request candles, quotes, or indicator data (or keep a watcher running), then consume the result in an application; a separate workflow runs a signal against historical candles and produces a report. The README also documents market search, screening, watchlists, and a low-level session API. Relationships among unsampled modules are shown only where documented or strongly implied; dashed links mark unverified integration details.

Main entry points: [`src/backtest/run.ts`](https://github.com/mathieu2301/tradingview-api/blob/main/src/backtest/run.ts) (Backtest Runner), [`src/data/index.ts`](https://github.com/mathieu2301/tradingview-api/blob/main/src/data/index.ts) (Data API), [`src/data/candles.ts`](https://github.com/mathieu2301/tradingview-api/blob/main/src/data/candles.ts) (Candles), [`src/client/client.ts`](https://github.com/mathieu2301/tradingview-api/blob/main/src/client/client.ts) (WebSocket Client)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_data["High-Level Data"]
  node_data_api["Data API<br/>[index.ts]"]
  node_candles["Candles<br/>[candles.ts]"]
  node_quotes["Quotes<br/>[quotes.ts]"]
  node_indicator_data["Indicator Data<br/>[indicators.ts]"]
  node_symbols["Symbol Info<br/>[symbols.ts]"]
  node_operation["Operation Lifecycle<br/>[operation.ts]"]
  node_provider["Data Provider<br/>[provider.ts]"]
end

subgraph group_sessions["Client And Sessions"]
  node_client["WebSocket Client<br/>[client.ts]"]
  node_transport["WebSocket Transport<br/>[transport.ts]"]
  node_chart_session["Chart Session<br/>[chart-session.ts]"]
  node_quote_session["Quote Session<br/>[quote-session.ts]"]
  node_study["Chart Studies<br/>[study.ts]"]
  node_indicator_types["Indicator Definitions<br/>[pine-indicator.ts]"]
  node_graphics["Chart Graphics<br/>[graphics.ts]"]
end

subgraph group_http["HTTP Lookups"]
  node_http_api["HTTP API<br/>[index.ts]"]
  node_http_request["HTTP Requests<br/>[request.ts]"]
  node_market["Market Search<br/>[market.ts]"]
  node_screener["Market Screener<br/>[screener.ts]"]
  node_watchlists["Watchlists<br/>[watchlists.ts]"]
end

subgraph group_backtest["Backtesting"]
  node_backtest_run["Backtest Runner<br/>[run.ts]"]
  node_snapshot["Frozen Snapshot<br/>[snapshot.ts]"]
  node_simulation["Trade Simulation<br/>[simulate.ts]"]
  node_exits["Exit Models<br/>[exits.ts]"]
  node_backtest_stats["Backtest Statistics<br/>[stats.ts]"]
  node_report["Backtest Report<br/>[report.ts]"]
end

subgraph group_protocol["Wire Protocol"]
  node_protocol_framing["Frame Encoding<br/>[framing.ts]"]
  node_protocol_ids["Session IDs<br/>[ids.ts]"]
end

node_developer(("Library User"))
node_tradingview{{"TradingView Service"}}

node_developer -->|"requests data"| node_data_api
node_data_api -->|"exposes candle calls"| node_candles
node_data_api -->|"exposes quote calls"| node_quotes
node_data_api -->|"exposes indicator calls"| node_indicator_data
node_data_api -->|"exposes symbol lookup"| node_symbols
node_candles -->|"uses provider"| node_provider
node_candles -->|"uses lifecycle"| node_operation
node_candles -.->|"requests market data"| node_tradingview
node_quotes -.->|"streams quotes"| node_quote_session
node_indicator_data -.->|"requests study data"| node_chart_session
node_operation -->|"uses client"| node_client
node_client -->|"sends and receives"| node_transport
node_client -->|"encodes and decodes"| node_protocol_framing
node_chart_session -->|"registers and sends"| node_client
node_chart_session -->|"creates studies"| node_study
node_quote_session -->|"registers and sends"| node_client
node_quote_session -->|"creates session ID"| node_protocol_ids
node_study -->|"accepts indicators"| node_indicator_types
node_developer -->|"requests lookups"| node_http_api
node_http_api -->|"exposes search"| node_market
node_http_api -->|"exposes screening"| node_screener
node_http_api -->|"exposes watchlists"| node_watchlists
node_market -->|"uses request helper"| node_http_request
node_screener -.->|"uses request helper"| node_http_request
node_watchlists -.->|"uses request helper"| node_http_request
node_http_request -.->|"calls HTTP service"| node_tradingview
node_developer -->|"runs backtest"| node_backtest_run
node_backtest_run -->|"fetches history"| node_candles
node_backtest_run -.->|"freezes input"| node_snapshot
node_backtest_run -.->|"simulates trades"| node_simulation
node_backtest_run -->|"selects exit models"| node_exits
node_backtest_run -.->|"summarizes results"| node_backtest_stats
node_backtest_run -.->|"formats report"| node_report

click node_data_api "https://github.com/mathieu2301/tradingview-api/blob/main/src/data/index.ts"
click node_candles "https://github.com/mathieu2301/tradingview-api/blob/main/src/data/candles.ts"
click node_quotes "https://github.com/mathieu2301/tradingview-api/blob/main/src/data/quotes.ts"
click node_indicator_data "https://github.com/mathieu2301/tradingview-api/blob/main/src/data/indicators.ts"
click node_symbols "https://github.com/mathieu2301/tradingview-api/blob/main/src/data/symbols.ts"
click node_operation "https://github.com/mathieu2301/tradingview-api/blob/main/src/data/operation.ts"
click node_provider "https://github.com/mathieu2301/tradingview-api/blob/main/src/data/provider.ts"
click node_client "https://github.com/mathieu2301/tradingview-api/blob/main/src/client/client.ts"
click node_transport "https://github.com/mathieu2301/tradingview-api/blob/main/src/client/transport.ts"
click node_chart_session "https://github.com/mathieu2301/tradingview-api/blob/main/src/chart/chart-session.ts"
click node_quote_session "https://github.com/mathieu2301/tradingview-api/blob/main/src/quote/quote-session.ts"
click node_study "https://github.com/mathieu2301/tradingview-api/blob/main/src/chart/study.ts"
click node_indicator_types "https://github.com/mathieu2301/tradingview-api/blob/main/src/indicators/pine-indicator.ts"
click node_graphics "https://github.com/mathieu2301/tradingview-api/blob/main/src/chart/graphics.ts"
click node_http_api "https://github.com/mathieu2301/tradingview-api/blob/main/src/http/index.ts"
click node_http_request "https://github.com/mathieu2301/tradingview-api/blob/main/src/http/request.ts"
click node_market "https://github.com/mathieu2301/tradingview-api/blob/main/src/http/market.ts"
click node_screener "https://github.com/mathieu2301/tradingview-api/blob/main/src/http/screener.ts"
click node_watchlists "https://github.com/mathieu2301/tradingview-api/blob/main/src/http/watchlists.ts"
click node_backtest_run "https://github.com/mathieu2301/tradingview-api/blob/main/src/backtest/run.ts"
click node_snapshot "https://github.com/mathieu2301/tradingview-api/blob/main/src/backtest/snapshot.ts"
click node_simulation "https://github.com/mathieu2301/tradingview-api/blob/main/src/backtest/simulate.ts"
click node_exits "https://github.com/mathieu2301/tradingview-api/blob/main/src/backtest/exits.ts"
click node_backtest_stats "https://github.com/mathieu2301/tradingview-api/blob/main/src/backtest/stats.ts"
click node_report "https://github.com/mathieu2301/tradingview-api/blob/main/src/backtest/report.ts"
click node_protocol_framing "https://github.com/mathieu2301/tradingview-api/blob/main/src/protocol/framing.ts"
click node_protocol_ids "https://github.com/mathieu2301/tradingview-api/blob/main/src/protocol/ids.ts"

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_data_api,node_candles,node_quotes,node_indicator_data,node_symbols,node_operation,node_provider,node_developer,node_tradingview toneBlue
class node_client,node_transport,node_chart_session,node_quote_session,node_study,node_indicator_types,node_graphics toneAmber
class node_http_api,node_http_request,node_market,node_screener,node_watchlists toneMint
class node_backtest_run,node_snapshot,node_simulation,node_exits,node_backtest_stats,node_report toneRose
class node_protocol_framing,node_protocol_ids toneIndigo
```

## Components

### High-Level Data

- [Data API](https://github.com/mathieu2301/tradingview-api/blob/main/src/data/index.ts): `src/data/index.ts`
- [Candles](https://github.com/mathieu2301/tradingview-api/blob/main/src/data/candles.ts): `src/data/candles.ts`
- [Quotes](https://github.com/mathieu2301/tradingview-api/blob/main/src/data/quotes.ts): `src/data/quotes.ts`
- [Indicator Data](https://github.com/mathieu2301/tradingview-api/blob/main/src/data/indicators.ts): `src/data/indicators.ts`
- [Symbol Info](https://github.com/mathieu2301/tradingview-api/blob/main/src/data/symbols.ts): `src/data/symbols.ts`
- [Operation Lifecycle](https://github.com/mathieu2301/tradingview-api/blob/main/src/data/operation.ts): `src/data/operation.ts`
- [Data Provider](https://github.com/mathieu2301/tradingview-api/blob/main/src/data/provider.ts): `src/data/provider.ts`

### Client And Sessions

- [WebSocket Client](https://github.com/mathieu2301/tradingview-api/blob/main/src/client/client.ts): `src/client/client.ts`
- [WebSocket Transport](https://github.com/mathieu2301/tradingview-api/blob/main/src/client/transport.ts): `src/client/transport.ts`
- [Chart Session](https://github.com/mathieu2301/tradingview-api/blob/main/src/chart/chart-session.ts): `src/chart/chart-session.ts`
- [Quote Session](https://github.com/mathieu2301/tradingview-api/blob/main/src/quote/quote-session.ts): `src/quote/quote-session.ts`
- [Chart Studies](https://github.com/mathieu2301/tradingview-api/blob/main/src/chart/study.ts): `src/chart/study.ts`
- [Indicator Definitions](https://github.com/mathieu2301/tradingview-api/blob/main/src/indicators/pine-indicator.ts): `src/indicators/pine-indicator.ts`
- [Chart Graphics](https://github.com/mathieu2301/tradingview-api/blob/main/src/chart/graphics.ts): `src/chart/graphics.ts`

### HTTP Lookups

- [HTTP API](https://github.com/mathieu2301/tradingview-api/blob/main/src/http/index.ts): `src/http/index.ts`
- [HTTP Requests](https://github.com/mathieu2301/tradingview-api/blob/main/src/http/request.ts): `src/http/request.ts`
- [Market Search](https://github.com/mathieu2301/tradingview-api/blob/main/src/http/market.ts): `src/http/market.ts`
- [Market Screener](https://github.com/mathieu2301/tradingview-api/blob/main/src/http/screener.ts): `src/http/screener.ts`
- [Watchlists](https://github.com/mathieu2301/tradingview-api/blob/main/src/http/watchlists.ts): `src/http/watchlists.ts`

### Backtesting

- [Backtest Runner](https://github.com/mathieu2301/tradingview-api/blob/main/src/backtest/run.ts): `src/backtest/run.ts`
- [Frozen Snapshot](https://github.com/mathieu2301/tradingview-api/blob/main/src/backtest/snapshot.ts): `src/backtest/snapshot.ts`
- [Trade Simulation](https://github.com/mathieu2301/tradingview-api/blob/main/src/backtest/simulate.ts): `src/backtest/simulate.ts`
- [Exit Models](https://github.com/mathieu2301/tradingview-api/blob/main/src/backtest/exits.ts): `src/backtest/exits.ts`
- [Backtest Statistics](https://github.com/mathieu2301/tradingview-api/blob/main/src/backtest/stats.ts): `src/backtest/stats.ts`
- [Backtest Report](https://github.com/mathieu2301/tradingview-api/blob/main/src/backtest/report.ts): `src/backtest/report.ts`

### Wire Protocol

- [Frame Encoding](https://github.com/mathieu2301/tradingview-api/blob/main/src/protocol/framing.ts): `src/protocol/framing.ts`
- [Session IDs](https://github.com/mathieu2301/tradingview-api/blob/main/src/protocol/ids.ts): `src/protocol/ids.ts`

### Other components

- **Library User**
- **TradingView Service**

## Connections

- Library User → Data API: requests data
- Data API → Candles: exposes candle calls (evidence: `src/data/index.ts`)
- Data API → Quotes: exposes quote calls (evidence: `src/data/index.ts`)
- Data API → Indicator Data: exposes indicator calls (evidence: `src/data/index.ts`)
- Data API → Symbol Info: exposes symbol lookup (evidence: `src/data/index.ts`)
- Candles → Data Provider: uses provider (evidence: `src/data/candles.ts`)
- Candles → Operation Lifecycle: uses lifecycle (evidence: `src/data/candles.ts`)
- Candles → TradingView Service: requests market data
- Quotes → Quote Session: streams quotes
- Indicator Data → Chart Session: requests study data
- Operation Lifecycle → WebSocket Client: uses client (evidence: `src/data/operation.ts`)
- WebSocket Client → WebSocket Transport: sends and receives (evidence: `src/client/client.ts`)
- WebSocket Client → Frame Encoding: encodes and decodes (evidence: `src/client/client.ts`)
- Chart Session → WebSocket Client: registers and sends (evidence: `src/chart/chart-session.ts`)
- Chart Session → Chart Studies: creates studies (evidence: `src/chart/chart-session.ts`)
- Quote Session → WebSocket Client: registers and sends (evidence: `src/quote/quote-session.ts`)
- Quote Session → Session IDs: creates session ID (evidence: `src/quote/quote-session.ts`)
- Chart Studies → Indicator Definitions: accepts indicators (evidence: `src/chart/study.ts`)
- Library User → HTTP API: requests lookups
- HTTP API → Market Search: exposes search (evidence: `src/http/index.ts`)
- HTTP API → Market Screener: exposes screening (evidence: `src/http/index.ts`)
- HTTP API → Watchlists: exposes watchlists (evidence: `src/http/index.ts`)
- Market Search → HTTP Requests: uses request helper
- Market Screener → HTTP Requests: uses request helper
- Watchlists → HTTP Requests: uses request helper
- HTTP Requests → TradingView Service: calls HTTP service
- Library User → Backtest Runner: runs backtest
- Backtest Runner → Candles: fetches history (evidence: `src/backtest/run.ts`)
- Backtest Runner → Frozen Snapshot: freezes input (evidence: `src/backtest/run.ts`)
- Backtest Runner → Trade Simulation: simulates trades (evidence: `src/backtest/run.ts`)
- Backtest Runner → Exit Models: selects exit models (evidence: `src/backtest/run.ts`)
- Backtest Runner → Backtest Statistics: summarizes results (evidence: `src/backtest/run.ts`)
- Backtest Runner → Backtest Report: formats report
