Skip to main content

Interface: DatafeedQuoteValues

Charting Library.DatafeedQuoteValues

This object contains symbol quote values, where a quote represents a set of data describing the current price. The library uses quote data for various trading functionalities, including the Order Ticket, Legend, and widgets, such as Watchlist, Details, News, and Depth of Market.

While all properties in this object are marked as optional, populating most of them is required for supporting trading functionalities. Providing values that do not match the expected data types can cause issues such as UI loading delays or missing data. See property descriptions for more information.

Indexable​

▪ [valueName: string]: string | number | string[] | number[] | undefined

Properties​

ask​

• Optional ask: number

Ask price – the lowest price a seller is willing to accept for a security. The value is displayed in the Order Ticket and Buy/Sell buttons.

bid​

• Optional bid: number

Bid price – the highest price a buyer is willing to pay for a security. The value is displayed in the Order Ticket and Buy/Sell buttons.

ch​

• Optional ch: number

Price change. It is usually calculated as a difference between the current price and close price of the previous day (regular session). In the UI, ch and chp are represented as the last day change parameter in Data Window. You can also display these values in the legend. If ch and chp are not provided, 0.00 (0.00%) is displayed instead.

Note that ch and chp are required for mobile apps. Otherwise, NaN values will appear in the legend.

chp​

• Optional chp: number

Price change percentage. In the UI, chp and ch are represented as the last day change parameter in Data Window. You can also display these values in the Legend. If ch and chp are not provided, 0.00 (0.00%) is displayed instead.

Note that ch and chp are required for mobile apps. Otherwise, NaN values will appear in the Legend.

description​

• Optional description: string

A short description of the symbol. This description is displayed in the Details widget and the tooltip of the Watchlist widget.

exchange​

• Optional exchange: string

The name of the exchange. The exchange name is displayed in the Details widget.

high_price​

• Optional high_price: number

Today's high price. The value is displayed in the Details widget.

low_price​

• Optional low_price: number

Today's low price. The value is displayed in the Details widget.

lp​

• Optional lp: number

The price at which the most recent trade of a security occurred, regardless of whether it was a buy or sell. Required for the Order Ticket, Depth of Market, Buy/Sell buttons, and Details and Watchlist widgets.

open_price​

• Optional open_price: number

Today's opening price

original_name​

• Optional original_name: string

Original name

prev_close_price​

• Optional prev_close_price: number

Closing price of the symbol from the previous regular market session.

Required for mobile apps. Otherwise, NaN values will appear in the Legend.

rch​

• Optional rch: number

Pre-/post-market price change. This value is required to display information on the extended session in the Details widget.

rchp​

• Optional rchp: number

Pre-/post-market price change percentage. This value is required to display information on the extended session the Details widget.

rtc​

• Optional rtc: number

Pre-/post-market price. This value is required to display the pre-/post-market price line on the chart and information on the extended session in the Details widget.

rtc_time​

• Optional rtc_time: number

Pre-/post-market price update time. This value is required to display information on the extended session in the Details widget.

short_name​

• Optional short_name: string

Short name for a symbol. Short name is used in the title for the News, Watchlist and Details widgets. You can disable the prefer_quote_short_name to use the LibrarySymbolInfo.ticker value instead.

spread​

• Optional spread: number

Spread – the difference between the ask and bid prices. The value is displayed between Buy/Sell buttons.

volume​

• Optional volume: number

Today's trading volume. This value is displayed in the Watchlist widget.