cdp-tv

English | 简体中文

Overview

A synchronous Python SDK and CLI for controlling a local TradingView Desktop instance through the Chrome DevTools Protocol (CDP). It provides 83 operations and market data polling, covering the portable functionality of the reference project tradingview-mcp. This is a standalone pip package with no MCP server and no Node.js requirement.

Requires Python 3.12+ and a TradingView Desktop chart page with an active login. See Installation and Connection for setup, the SDK Guide for advanced usage, and the API Reference for all parameters. Feature availability depends on the desktop version and account permissions; see Compatibility Notes for verified coverage, Behavior and Limitations for caveats, and the Development Guide for development details. This is an unofficial implementation licensed under MIT; upstream attribution is listed in THIRD_PARTY_LICENSES.

Features

SDK Quick Start

from cdp_tv import TradingView

tv = TradingView(port=9222)
tv.launch()  # Launch or reuse a desktop instance with CDP enabled

with tv:
    print(tv.get_chart_state())
    print(tv.quote_get())
    print(tv.data_get_ohlcv(count=10))
    print(tv.capture_screenshot("chart.png", region="chart"))

Methods use keyword arguments, for example tv.chart_set_symbol(symbol="BINANCE:BTCUSDT"). You can also use tv.call("chart_set_symbol", symbol="BINANCE:BTCUSDT"). Closing the connection does not quit TradingView.

CLI Reference

Entry Points and Global Options

After installation, run cdp-tv or python -m cdp_tv. For the project's virtual environment on Windows, use .\.venv\Scripts\python.exe -m cdp_tv. The examples below use cdp-tv and assume PowerShell.

cdp-tv [GLOBAL_OPTIONS] [COMMAND] [COMMAND_ARGUMENTS]
cdp-tv [GLOBAL_OPTIONS] call OPERATION_NAME [COMMAND_ARGUMENTS]

Place global options before the command. If no command is given, status runs by default. For batch operations, the timeout applies to each internal operation, rather than the entire batch.

cdp-tv --port 9222 --pretty state
cdp-tv --target-id "ACTUAL_PAGE_ID" quote
cdp-tv tools
cdp-tv call chart_set_timeframe --timeframe 60

tools lists all operations, parameter types, required parameters, and enum values without connecting. Any operation can be invoked directly by its full name or after call; see the API Reference for the complete list.

Passing Arguments

Pass strings directly; use JSON syntax for numbers, arrays, and objects. The CLI uses --from for time range parameters, while the Python SDK uses from_. Quote argument values that contain spaces using your shell's quoting rules.

cdp-tv ohlcv --count 10 --summary
cdp-tv ohlcv --count 10 --summary=false
cdp-tv type Candles
'{"symbols":["BINANCE:BTCUSDT"],"action":"get_ohlcv","delay_ms":0}' | cdp-tv call batch_run --json -
cdp-tv pine check --source-file example.pine

Common Commands

Uppercase words in the table below are placeholders to replace, and square brackets indicate optional arguments. Prefix every command in the table with cdp-tv.

cdp-tv symbol BINANCE:BTCUSDT
cdp-tv timeframe 60
cdp-tv screenshot --path chart.png --region chart --wait-for-render
'{"from":1727740800,"to":1727827200}' | cdp-tv call chart_set_visible_range --json -

Command Groups

Hyphens and underscores are interchangeable in subcommands, for example pine smart-compile and pine smart_compile. Where subcommands or enum values are separated by commas or slashes in the table, choose one when running the command.

Replay speed is a delay in milliseconds, with supported values of 100, 143, 200, 300, 1000, 2000, 3000, 5000, and 10000. Each autoplay call toggles between playing and paused. Alert changes, watchlist additions/removals, and Pine saves write to the current account. See the API Reference and Behavior and Limitations for additional parameters and behavioral constraints.

cdp-tv indicator search --query RSI --limit 5
cdp-tv tab list
cdp-tv tab switch --index 0
cdp-tv ui panel --panel pine-editor --action open
'{"key":"s","modifiers":["ctrl"]}' | cdp-tv ui keyboard --json -

Polling and Batch Operations

cdp-tv stream KIND [--interval SECONDS] [--count N] [--duration SECONDS] [--filter TEXT] [--all-samples]
cdp-tv call batch_run --json JSON_OBJECT

batch_run requires a symbols array and an action (one of screenshot/get_ohlcv/get_strategy_results). Optional parameters are a timeframes array, delay_ms (default 2000), ohlcv_count (default 100), and output_dir (default screenshots). After execution, it attempts to restore the symbol and timeframe independently. Results include failed, restored, and restore_error.

cdp-tv stream quote --interval 1 --count 3
cdp-tv stream all --duration 30 --all-samples
'{"symbols":["BINANCE:BTCUSDT"],"timeframes":["60","D"],"action":"get_ohlcv","ohlcv_count":10}' | cdp-tv call batch_run --json -

Output and Exit Codes

Regular operations write JSON to standard output, while streaming operations write one JSON object per line. Operation errors include success: false, error, and error_type; help and argparse argument errors use plain text. --pretty affects only regular output and does not change the stream's JSONL format.