symbol_info

Properties

base_currency

Type: simple String

Returns base currency of the symbol.

For example, in the pair EURUSD, the base currency is EUR, in the pair BTCUSDT, the base currency is BTC.

---

country

Type: simple String

Returns the two-letter code of the country where the symbol is traded, in the ISO 3166-1 alpha-2 format.

---

currency

Type: simple String

Returns the currency of the symbol's prices.

---

current_contract

Type: simple String

Returns the ticker identifier of the underlying contract.

---

description

Type: simple String

Returns the description of the symbol.

---

employees

Type: simple int

Returns the number of employees in the company (for stocks).

---

expiration_date

Type: simple int

Returns the expiration date of the symbol as UNIX timestamp in milliseconds.

---

industry

Type: simple String

Returns the industry of the company (for stocks).

---

isin

Type: simple String

Returns the International Securities Identification Number (ISIN) of the symbol.

---

main_tickerid

Type: simple String

Returns the full identifier of the chart's primary symbol.

This value keeps referring to the outer chart symbol even while code is executing inside a request.*() context.

---

market

Type: simple String

Returns the market of the symbol, e.g. US for AAPL.US.

---

min_contract

Type: simple float

Returns the minimum contract size for the symbol.

---

min_move

Type: simple float

Returns the minimum price movement (tick size) for the symbol.

---

min_tick

Type: simple float

Returns the minimum price fluctuation (tick value) for the symbol.

---

point_value

Type: simple float

Returns the point value for the symbol.

---

price_scale

Type: simple int

Returns the price scale for the symbol.

---

recommendations_buy

Type: simple int

Returns the number of 'buy' recommendations for the symbol.

---

recommendations_buy_strong

Type: simple int

Returns the number of 'strong buy' recommendations for the symbol.

---

recommendations_date

Type: simple int

Returns the date of the latest recommendations update as UNIX timestamp in milliseconds.

---

recommendations_hold

Type: simple int

Returns the number of 'hold' recommendations for the symbol.

---

recommendations_sell

Type: simple int

Returns the number of 'sell' recommendations for the symbol.

---

recommendations_sell_strong

Type: simple int

Returns the number of 'strong sell' recommendations for the symbol.

---

recommendations_total

Type: simple int

Returns the total number of recommendations for the symbol.

---

root

Type: simple String

Returns the root symbol of the symbol's ticker identifier.

---

sector

Type: simple String

Returns the sector of the company (for stocks).

---

session

Type: simple Session

Returns the session type of the chart main series (Session.Regular, Session.Extended, or Session.Overnight).

---

shareholders

Type: simple int

Returns the number of shareholders the company has (for stocks).

---

shares_outstanding_float

Type: simple float

Returns the total number of shares outstanding a company has available, excluding any of its restricted shares (for stocks).

---

shares_outstanding_total

Type: simple float

Returns the total number of shares outstanding a company has available, including restricted shares held by insiders, major shareholders, and employees (for stocks).

---

target_price_average

Type: simple float

Returns the latest average yearly price target for the symbol predicted by

---

target_price_date

Type: simple int

Returns the date of the target price as UNIX timestamp in milliseconds (for stocks).

---

target_price_estimates

Type: simple int

Returns the latest total number of price target predictions for the current symbol.

---

target_price_high

Type: simple float

Returns the last highest yearly price target for the symbol predicted by analysts.

---

target_price_low

Type: simple float

Returns the last lowest yearly price target for the symbol predicted by analysts.

---

target_price_median

Type: simple float

Returns the median yearly price target for the symbol predicted by analysts.

---

ticker

Type: simple String

Returns the symbol name without its market.

---

tickerid

Type: simple String

Returns the full ticker identifier of the symbol.

---

timezone

Type: simple String

Returns the timezone of the exchange of the chart main series.

---

type

Type: simple String

Returns the type of the symbol.

The values are stock, fund, dr, right, bond, warrant, structured, index, forex, futures, spread, economic, fundamental, crypto, spot, swap, option, commodity.

---

volumetype

Type: simple String

Returns the volume type of the symbol.

The values are base, quote, tick.

Functions

market

market(ticker_id: String): String

Returns the market of the given symbol.

Parameters

Name	Type	Default	Description
ticker_id	String		The symbol to get the market from.

Returns: String

---

ticker

ticker(ticker_id: String): String

Returns the symbol name without its market.

Parameters

Name	Type	Default	Description
ticker_id	String		The symbol to get the name from.

Returns: String