Skip to main content

Interface: DatafeedQuoteValues

Datafeed.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. See property descriptions for more information.

Indexable​

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

Properties​

ask​

• Optional ask: number

Ask price

bid​

• Optional bid: number

Bid price

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

high_price​

• Optional high_price: number

Today's high price

low_price​

• Optional low_price: number

Today's low price

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 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.

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 (difference between the ask and bid prices)

volume​

• Optional volume: number

Today's trading volume