TradingView API

The TradingView API allows you to retrieve real-time market prices and indicator values. Key features include:

• Access to premium features and invite-only indicators.
• Support for unlimited simultaneous indicators.
• Real-time data retrieval.
• Access to TradingView's technical analysis.
• Ability to retrieve drawings made on charts.
• Replay mode and Fake Replay mode (available for free plans).
• Ability to get values from a specific date range.
• Automated backtesting of multiple strategies and settings.

Retrieve detailed information about a specific Pine Script indicator, including its inputs and plots.

Parameters:

• id (string): Indicator ID (e.g., PUB;XXXXXXXXXXXXXXXXXXXXX).
• version (string, optional): Specific version to fetch. Defaults to 'last'.
• session (string, optional): User sessionid cookie for private indicators.
• signature (string, optional): User sessionid_sign cookie for private indicators.

Returns:

• Promise<PineIndicator>: An object containing pineId, pineVersion, description, shortDescription, inputs (configuration options), plots (output data), and the script (source template).

The Client class exposes a Session namespace to generate specialized sessions for different data types:

• Client.Session.Quote(clientBridge): Generates a Quote session.
• Client.Session.Chart(clientBridge): Generates a Chart session.

Note: These are typically used internally by the library's session generators, but they are accessible via the Session property on the Client instance.

Retrieve technical analysis advice for a specific market ID. The results include recommendations (Other, All, MA) across multiple timeframes.

Parameters:

• id (string): The full market ID (e.g., COINBASE:BTCEUR).

Returns:

• Promise<Periods>: An object where keys are timeframes (1, 5, 15, 60, 240, 1D, 1W, 1M) and values are objects containing advice for Other, All, and MA.

The QuoteMarket class is used to subscribe to real-time market quotes for a specific symbol and session. It is initialized by passing a quoteSession (an instance of QuoteSessionBridge).

Constructor Parameters:

• symbol (string): The market symbol (e.g., 'BTCEUR' or 'KRAKEN:BTCEUR').
• session (string, optional): The market session, defaults to 'regular'. Options include 'regular' or 'extended'.

Event Listeners:

• onLoaded(cb): Triggered when the quote market has finished loading.
• onData(cb): Triggered when new quote data is received. The callback receives the merged data object.
• onEvent(cb): Triggered for all market events. Receives the event type ('loaded', 'data', 'error') and the associated data.
• onError(cb): Triggered when a market error occurs.

To stop receiving updates and free up resources, call the close() method.

Use the setOption(key, value, FORCE) method to modify indicator settings.

• key: The name of the option to change (e.g., rows, volume, vaVolume).
• value: The new value for the option.
• FORCE (optional): A boolean. If true, it bypasses type checking and verification of whether the key is valid for the specific indicator type.

By default, setOption performs strict type checking against the indicator's expected value type and ensures the key is valid for the current indicator type. If validation fails, it throws an error.

Use setOption(key, value) to change the value of an indicator input. The key can be the internal ID (e.g., in_{ID}), the inline name, or the internalID.

Validation Rules:

• Type Safety: The value must match the input's type. Supported type mappings:
  • bool -> boolean
  • integer -> number
  • float -> number
  • text -> string
• Options: If the input has an options array, the value must be included in that array.

Errors:

• Throws an error if the key is not found.
• Throws an error if the type is incorrect.
• Throws an error if the value is not in the allowed options list.

The Client class is the main entry point for interacting with TradingView. You can initialize it with an optional ClientOptions object to provide authentication tokens, custom headers, or specify the server type.

ClientOptions properties:

• token (string, optional): User auth token (from the sessionid cookie).
• signature (string, optional): User auth token signature (from the sessionid_sign cookie).
• DEBUG (boolean, optional): Enable debug mode (sets global.TW_DEBUG).
• server (string, optional): Server type. Options: 'data', 'prodata', or 'widgetdata'. Defaults to 'data'.
• location (string, optional): Auth page location (e.g., https://fr.tradingview.com/ for France).
• headers (Object<string, string>, optional): Custom WebSocket headers.

Use the following methods to check the current state of the client or to terminate the connection:

• get isLogged(): Returns true if the client is logged in.
• get isOpen(): Returns true if the WebSocket connection is currently open.
• end(): Returns a Promise that resolves when the WebSocket connection is closed.

By default, an indicator is treated as a standard script. You can change this using setType(type).

Supported IndicatorType values:

• 'Script@tv-scripting-101!' (Default)
• 'StrategyScript@tv-scripting-101!'