Skip to main content
Version: latest

DatafeedQuoteValues

Interface

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 price

Type

number


bid

Optional

Bid price

Type

number


ch

Optional

Price change (usually counts as an open price on a particular day). Required for mobile apps. Otherwise, NaN values will appear in the Legend.

Type

number


chp

Optional

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

Type

number


description

Optional

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

Type

string


exchange

Optional

The name of the exchange

Type

string


high_price

Optional

Today's high price

Type

number


low_price

Optional

Today's low price

Type

number


lp

Optional

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.

Type

number


open_price

Optional

Today's opening price

Type

number


original_name

Optional

Original name

Type

string


prev_close_price

Optional

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

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

Type

number


short_name

Optional

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.

Type

string


spread

Optional

Spread (difference between the ask and bid prices)

Type

number


volume

Optional

Today's trading volume

Type

number