How mathieu2301/tradingview-api works
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: run.ts Backtest Runner · index.ts Data API · candles.ts Candles · client.ts WebSocket Client
Components 29
High-Level Data
- Data API
src/data/index.ts - Candles
src/data/candles.ts - Quotes
src/data/quotes.ts - Indicator Data
src/data/indicators.ts - Symbol Info
src/data/symbols.ts - Operation Lifecycle
src/data/operation.ts - Data Provider
src/data/provider.ts
Client And Sessions
- WebSocket Client
src/client/client.ts - WebSocket Transport
src/client/transport.ts - Chart Session
src/chart/chart-session.ts - Quote Session
src/quote/quote-session.ts - Chart Studies
src/chart/study.ts - Indicator Definitions
src/indicators/pine-indicator.ts - Chart Graphics
src/chart/graphics.ts
HTTP Lookups
- HTTP API
src/http/index.ts - HTTP Requests
src/http/request.ts - Market Search
src/http/market.ts - Market Screener
src/http/screener.ts - Watchlists
src/http/watchlists.ts
Backtesting
- Backtest Runner
src/backtest/run.ts - Frozen Snapshot
src/backtest/snapshot.ts - Trade Simulation
src/backtest/simulate.ts - Exit Models
src/backtest/exits.ts - Backtest Statistics
src/backtest/stats.ts - Backtest Report
src/backtest/report.ts
Wire Protocol
- Frame Encoding
src/protocol/framing.ts - Session IDs
src/protocol/ids.ts
Other components
- Library User
- TradingView Service
Connections 33
- Library User → Data API: requests data
- Data API → Candles: exposes candle calls
src/data/index.ts - Data API → Quotes: exposes quote calls
src/data/index.ts - Data API → Indicator Data: exposes indicator calls
src/data/index.ts - Data API → Symbol Info: exposes symbol lookup
src/data/index.ts - Candles → Data Provider: uses provider
src/data/candles.ts - Candles → Operation Lifecycle: uses lifecycle
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
src/data/operation.ts - WebSocket Client → WebSocket Transport: sends and receives
src/client/client.ts - WebSocket Client → Frame Encoding: encodes and decodes
src/client/client.ts - Chart Session → WebSocket Client: registers and sends
src/chart/chart-session.ts - Chart Session → Chart Studies: creates studies
src/chart/chart-session.ts - Quote Session → WebSocket Client: registers and sends
src/quote/quote-session.ts - Quote Session → Session IDs: creates session ID
src/quote/quote-session.ts - Chart Studies → Indicator Definitions: accepts indicators
src/chart/study.ts - Library User → HTTP API: requests lookups
- HTTP API → Market Search: exposes search
src/http/index.ts - HTTP API → Market Screener: exposes screening
src/http/index.ts - HTTP API → Watchlists: exposes watchlists
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
src/backtest/run.ts - Backtest Runner → Frozen Snapshot: freezes input
src/backtest/run.ts - Backtest Runner → Trade Simulation: simulates trades
src/backtest/run.ts - Backtest Runner → Exit Models: selects exit models
src/backtest/run.ts - Backtest Runner → Backtest Statistics: summarizes results
src/backtest/run.ts - Backtest Runner → Backtest Report: formats report