0% found this document useful (0 votes)

17 views398 pages

Pine Script® Variables and Functions Guide

The Pine Script® language reference manual provides detailed information on various variables and functions used in Pine Script, including their types, remarks, and examples. Key variables include 'ask', 'bid', 'bar_index', and various 'barstate' functions that help in determining the state of bars in real-time and historical data. The document also covers chart properties and dividend-related variables, emphasizing the importance of understanding how these variables behave in different contexts.

Uploaded by

qwerty

We take content rights seriously. If you suspect this is your content, claim it here.

Available Formats

Download as PDF, TXT or read online on Scribd

0% found this document useful (0 votes)

17 views398 pages

Pine Script® Variables and Functions Guide

Uploaded by

qwerty

We take content rights seriously. If you suspect this is your content, claim it here.

Available Formats

Download as PDF, TXT or read online on Scribd

Pine Script® language reference manual

Variables

ask
The ask price at the time of the current tick, which represents the lowest price an active seller will accept for the
instrument at its current value. This information is available only on the "1T" timeframe. On other timeframes, the
variable's value is na.

TYPE

series float

REMARKS

If the bid/ask values change since the last tick but no new trades are made, these changes will not be reflected in the
value of this variable. It is only updated on new ticks.

SEE ALSO

open high low volume time() hl2 hlc3 hlcc4 ohlc4 bid

bar_index
Current bar index. Numbering is zero-based, index of the first bar is 0.

TYPE

series int

EXAMPLE

[Link]

[Link]
Returns true if current bar is a historical bar, false otherwise.

TYPE

series bool

REMARKS

Pine Script® code that uses this variable could calculate differently on history and real-time data.
Please note that using this variable/function can cause indicator repainting.

SEE ALSO

[Link] [Link] [Link] [Link] [Link]

[Link]

[Link]
Returns true if current bar is the last bar in barset, false otherwise. This condition is true for all real-time bars in barset.

TYPE

series bool

REMARKS

Pine Script® code that uses this variable could calculate differently on history and real-time data.
Please note that using this variable/function can cause indicator repainting.

SEE ALSO

[Link] [Link] [Link] [Link] [Link]

[Link]

[Link]
Returns true if script is executing on the dataset's last bar when market is closed, or script is executing on the bar
immediately preceding the real-time bar, if market is open. Returns false otherwise.

TYPE

series bool

REMARKS

Pine Script® code that uses this variable could calculate differently on history and real-time data.

Please note that using this variable/function can cause indicator repainting.

SEE ALSO

[Link] [Link] [Link] [Link] [Link]

[Link]
Returns true if script is currently calculating on new bar, false otherwise. This variable is true when calculating on
historical bars or on first update of a newly generated real-time bar.

TYPE

series bool

REMARKS

Pine Script® code that uses this variable could calculate differently on history and real-time data.

Please note that using this variable/function can cause indicator repainting.

SEE ALSO

[Link] [Link] [Link] [Link] [Link]

[Link]

[Link]
Returns true if current bar is a real-time bar, false otherwise.

TYPE

series bool

REMARKS

Pine Script® code that uses this variable could calculate differently on history and real-time data.

Please note that using this variable/function can cause indicator repainting.

SEE ALSO

[Link] [Link] [Link] [Link] [Link]

[Link]

bid
The bid price at the time of the current tick, which represents the highest price an active buyer is willing to pay for the
instrument at its current value. This information is available only on the "1T" timeframe. On other timeframes, the
variable's value is na.

TYPE

series float

REMARKS
If the bid/ask values change since the last tick but no new trades are made, these changes will not be reflected in the
value of this variable. It is only updated on new ticks.

SEE ALSO

open high low volume time() hl2 hlc3 hlcc4 ohlc4 ask

[Link]
Returns an array filled with all the current boxes drawn by the script.

TYPE

array<box>

EXAMPLE

//@version=6
indicator("[Link]")
//delete all boxes
[Link](time, open, time + 60 * 60 * 24, close, xloc=xloc.bar_time, border_style=line.style_dashed)
a_allBoxes = [Link]
if [Link](a_allBoxes) > 0
for i = 0 to [Link](a_allBoxes) - 1
[Link]([Link](a_allBoxes, i))

REMARKS

The array is read-only. Index zero of the array is the ID of the oldest object on the chart.

SEE ALSO

[Link]() [Link] [Link] [Link]

chart.bg_color
Returns the color of the chart's background from the "Chart settings/Appearance/Background" field. When a gradient
is selected, the middle point of the gradient is returned.

TYPE

input color

SEE ALSO

chart.fg_color

chart.fg_color
Returns a color providing optimal contrast with chart.bg_color.

TYPE

input color

SEE ALSO

chart.is_renko
TYPE

simple bool

RETURNS

Returns true if the chart type is Renko, false otherwise.

SEE ALSO

chart.is_heikinashi chart.is_linebreak chart.is_kagi chart.is_pnf chart.is_range

chart.is_standard

TYPE

simple bool

RETURNS

Returns true if the chart type is not one of the following: Renko, Kagi, Line break, Point & figure, Range, Heikin Ashi;
false otherwise.

SEE ALSO

chart.is_renko chart.is_linebreak chart.is_kagi chart.is_pnf chart.is_range chart.is_heikinashi

chart.left_visible_bar_time
The time of the leftmost bar currently visible on the chart.

TYPE

input int

REMARKS

Scripts using this variable will automatically re-execute when its value updates to reflect changes in the chart, which
can be caused by users scrolling the chart, or new real-time bars.
Alerts created on a script that includes this variable will only use the value assigned to the variable at the moment of
the alert's creation, regardless of whether the value changes afterward, which may lead to repainting.

SEE ALSO

chart.right_visible_bar_time

chart.right_visible_bar_time
The time of the rightmost bar currently visible on the chart.

TYPE

input int

REMARKS

SEE ALSO

chart.left_visible_bar_time

close
Close price of the current bar when it has closed, or last traded price of a yet incomplete, realtime bar.

TYPE

series float

REMARKS

Previous values may be accessed with square brackets operator [], e.g. close[1], close[2].

SEE ALSO

open high low volume time() hl2 hlc3 hlcc4 ohlc4 ask bid

dayofmonth
The day number of the month, in the exchange time zone, calculated from the bar's opening UNIX timestamp.

TYPE

series int

REMARKS

This variable always references the day number corresponding to the bar's opening time. Consequently, for symbols
with overnight sessions (e.g., "EURUSD", where the "Monday" session starts on Sunday at 17:00 in exchange time),
the value may represent a day from the previous week rather than the session's primary trading day.

SEE ALSO

dayofmonth() dayofweek weekofyear time year month hour minute second

REMARKS

This value is only fetched once during the script's initial calculation. The variable will return the same value until the
script is recalculated, even after the expected time of the next earnings report.

SEE ALSO

[Link]()

earnings.future_period_end_time
Checks the data for the next earnings report and returns the UNIX timestamp of the day when the financial period
covered by those earnings ends, or na if this data isn't available.

TYPE

series int

RETURNS

UNIX time, expressed in milliseconds.

REMARKS

SEE ALSO

[Link]()

earnings.future_revenue
Returns the estimated Revenue of the next earnings report in the currency of the instrument, or na if this data isn't
available.

TYPE

series float

REMARKS

SEE ALSO

[Link]()

earnings.future_time
Returns a UNIX timestamp indicating the expected time of the next earnings report, or na if this data isn't available.

TYPE

series int

RETURNS

UNIX time, expressed in milliseconds.

REMARKS

SEE ALSO

[Link]()

high
Current high price.

TYPE

series float

REMARKS

Previous values may be accessed with square brackets operator [], e.g. high[1], high[2].

SEE ALSO

open low close volume time() hl2 hlc3 hlcc4 ohlc4 ask bid

hl2
Is a shortcut for (high + low)/2
TYPE

series float

SEE ALSO

open high low close volume time() hlc3 hlcc4 ohlc4 ask bid

hlc3
Is a shortcut for (high + low + close)/3

TYPE

series float

SEE ALSO

open high low close volume time() hl2 hlcc4 ohlc4 ask bid

hlcc4
Is a shortcut for (high + low + close + close)/4

TYPE

series float

SEE ALSO

open high low close volume time() hl2 hlc3 ohlc4 ask bid

hour
Current bar hour in exchange timezone.

TYPE

series int

SEE ALSO

hour() time year month weekofyear dayofmonth dayofweek minute second

[Link]
Returns an array filled with all the current labels drawn by the script.

TYPE

array<label>

EXAMPLE

//@version=6
indicator("[Link]")
//delete all labels
[Link](bar_index, close)
a_allLabels = [Link]
if [Link](a_allLabels) > 0
for i = 0 to [Link](a_allLabels) - 1
[Link]([Link](a_allLabels, i))

REMARKS

The array is read-only. Index zero of the array is the ID of the oldest object on the chart.
SEE ALSO

[Link]() [Link] [Link] [Link]

last_bar_index
Bar index of the last chart bar. Bar indices begin at zero on the first bar.

TYPE

series int

EXAMPLE

//@version=6
strategy("Mark Last X Bars For Backtesting", overlay = true, calc_on_every_tick = true)
lastBarsFilterInput = [Link](100, "Bars Count:")
// Here, we store the 'last_bar_index' value that is known from the beginning of the script's calculati
on.
// The 'last_bar_index' will change when new real-time bars appear, so we declare 'lastbar' with the 'v
ar' keyword.
var lastbar = last_bar_index
// Check if the current bar_index is 'lastBarsFilterInput' removed from the last bar on the chart, or t
he chart is traded in real-time.
allowedToTrade = (lastbar - bar_index <= lastBarsFilterInput) or [Link]
bgcolor(allowedToTrade ? [Link]([Link], 80) : na)

RETURNS

Last historical bar index for closed markets, or the real-time bar index for open markets.

REMARKS

Please note that using this variable can cause indicator repainting.

SEE ALSO

bar_index last_bar_time [Link] [Link]

last_bar_time
Time in UNIX format of the last chart bar. It is the number of milliseconds that have elapsed since 00:00:00 UTC, 1
January 1970.

TYPE

series int

REMARKS

Please note that using this variable/function can cause indicator repainting.

Note that this variable returns the timestamp based on the time of the bar's open.

SEE ALSO

time timenow timestamp() last_bar_index

[Link]
Returns an array filled with all the current lines drawn by the script.

TYPE

array<line>

EXAMPLE
//@version=6
indicator("[Link]")
//delete all lines
[Link](bar_index - 10, close, bar_index, close)
a_allLines = [Link]
if [Link](a_allLines) > 0
for i = 0 to [Link](a_allLines) - 1
[Link]([Link](a_allLines, i))

REMARKS

The array is read-only. Index zero of the array is the ID of the oldest object on the chart.

SEE ALSO

[Link]() [Link] [Link] [Link]

[Link]
Returns an array filled with all the current linefill objects drawn by the script.

TYPE

array<linefill>

REMARKS

The array is read-only. Index zero of the array is the ID of the oldest object on the chart.

low
Current low price.

TYPE

series float

REMARKS

Previous values may be accessed with square brackets operator [], e.g. low[1], low[2].

SEE ALSO

open high close volume time() hl2 hlc3 hlcc4 ohlc4 ask bid

minute
Current bar minute in exchange timezone.

TYPE

series int

SEE ALSO

minute() time year month weekofyear dayofmonth dayofweek hour second

month
Current bar month in exchange timezone.

TYPE

series int

REMARKS
Note that this variable returns the month based on the time of the bar's open. For overnight sessions (e.g. EURUSD,
where Monday session starts on Sunday, 17:00) this value can be lower by 1 than the month of the trading day.

SEE ALSO

month() time year weekofyear dayofmonth dayofweek hour minute second

na
A keyword signifying "not available", indicating that a variable has no assigned value.

TYPE

simple na

EXAMPLE

//@version=6
indicator("na")
// CORRECT
// Plot no value when on bars zero to nine. Plot `close` on other bars.
plot(bar_index < 10 ? na : close)
// CORRECT ALTERNATIVE
// Initialize `a` to `na`. Reassign `close` to `a` on bars 10 and later.
float a = na
if bar_index >= 10
a := close
plot(a)

// INCORRECT
// Trying to test the preceding bar's `close` for `na`.
// The next line, if uncommented, will cause a compilation error, because direct comparison with `na` i
s not allowed.
// plot(close[1] == na ? close : close[1])
// CORRECT
// Use the `na()` function to test for `na`.
plot(na(close[1]) ? close : close[1])
// CORRECT ALTERNATIVE
// `nz()` tests `close[1]` for `na`. It returns `close[1]` if it is not `na`, and `close` if it is.
plot(nz(close[1], close))

REMARKS

Do not use this variable with comparison operators to test values for na , as it might lead to unexpected behavior.
Instead, use the na() function. Note that na can be used to initialize variables when the initialization statement also
specifies the variable's type.

SEE ALSO

na() nz() fixnan()

ohlc4
Is a shortcut for (open + high + low + close)/4

TYPE

series float

SEE ALSO

open high low close volume time() hl2 hlc3 hlcc4

open
Current open price.
TYPE

series float

REMARKS

Previous values may be accessed with square brackets operator [], e.g. open[1], open[2].

SEE ALSO

high low close volume time() hl2 hlc3 hlcc4 ohlc4 ask bid

[Link]
Returns an array containing all current polyline instances drawn by the script.

TYPE

array<polyline>

REMARKS

The array is read-only. Index zero of the array references the ID of the oldest polyline object on the chart.

second
Current bar second in exchange timezone.

TYPE

series int

SEE ALSO

second() time year month weekofyear dayofmonth dayofweek hour minute

[Link]
Returns true if the current bar is the first bar of the day's session, false otherwise. If extended session information is
used, only returns true on the first bar of the pre-market bars.

TYPE

series bool

EXAMPLE

//@version=6
strategy("`[Link]` Example", overlay = true)
longCondition = year >= 2022
// Place a long order at the `close` of the trading session's first bar.
if [Link] and longCondition
[Link]("Long", [Link])

// Close the long position at the `close` of the trading session's last bar.
if [Link] and [Link]
[Link]("Long", immediately = true)

SEE ALSO

session.isfirstbar_regular [Link] session.islastbar_regular

session.isfirstbar_regular
Returns true on the first regular session bar of the day, false otherwise. The result is the same whether extended
session information is used or not.
TYPE

series bool

EXAMPLE

//@version=6
strategy("`session.isfirstbar_regular` Example", overlay = true)
longCondition = year >= 2022
// Place a long order at the `close` of the trading session's first bar.
if [Link] and longCondition
[Link]("Long", [Link])
// Close the long position at the `close` of the trading session's last bar.
if session.islastbar_regular and [Link]
[Link]("Long", immediately = true)

SEE ALSO

[Link] [Link]

[Link]
Returns true if the current bar is the last bar of the day's session, false otherwise. If extended session information is
used, only returns true on the last bar of the post-market bars.

TYPE

series bool

EXAMPLE

//@version=6
strategy("`[Link]` Example", overlay = true)
longCondition = year >= 2022
// Place a long order at the `close` of the trading session's last bar.
// The position will enter on the `open` of next session's first bar.
if [Link] and longCondition
[Link]("Long", [Link])
// Close 'Long' position at the close of the last bar of the trading session
if [Link] and [Link]
[Link]("Long", immediately = true)

REMARKS

This variable is not guaranteed to return true once in every session because the last bar of the session might not exist
if no trades occur during what should be the session's last bar.

This variable is not guaranteed to work as expected on non-standard chart types, e.g., Renko.

SEE ALSO

[Link] session.islastbar_regular

session.islastbar_regular
Returns true on the last regular session bar of the day, false otherwise. The result is the same whether extended
session information is used or not.

TYPE

series bool

EXAMPLE

//@version=6
strategy("`session.islastbar_regular` Example", overlay = true)
longCondition = year >= 2022
// Place a long order at the `close` of the trading session's first bar.
if [Link] and longCondition
[Link]("Long", [Link])
// Close the long position at the `close` of the trading session's last bar.
if session.islastbar_regular and [Link]
[Link]("Long", immediately = true)

REMARKS

This variable is not guaranteed to return true once in every session because the last bar of the session might not exist
if no trades occur during what should be the session's last bar.
This variable is not guaranteed to work as expected on non-standard chart types, e.g., Renko.

SEE ALSO

[Link] [Link] session.isfirstbar_regular

[Link]
Returns true if the current bar is a part of the regular trading hours (i.e. market hours), false otherwise.

TYPE

series bool

SEE ALSO

[Link] [Link]

[Link]
Returns true if the current bar is a part of the post-market, false otherwise. On non-intraday charts always returns fa
lse .

TYPE

series bool

SEE ALSO

[Link] [Link]

[Link]
Returns true if the current bar is a part of the pre-market, false otherwise. On non-intraday charts always returns fal
se .

TYPE

series bool

SEE ALSO

[Link] [Link]

strategy.account_currency
Returns the currency used to calculate results, which can be set in the strategy's properties.

TYPE

simple string

SEE ALSO

strategy() strategy.convert_to_account() strategy.convert_to_symbol()

strategy.avg_losing_trade
Returns the average amount of money lost per losing trade. Calculated as the sum of losses divided by the number of
losing trades.

TYPE

series float

SEE ALSO

strategy.avg_losing_trade_percent

strategy.avg_losing_trade_percent
Returns the average percentage loss per losing trade. Calculated as the sum of loss percentages divided by the
number of losing trades.

TYPE

series float

SEE ALSO

strategy.avg_losing_trade

strategy.avg_trade
Returns the average amount of money gained or lost per trade. Calculated as the sum of all profits and losses divided
by the number of closed trades.

TYPE

series float

SEE ALSO

strategy.avg_trade_percent

strategy.avg_trade_percent
Returns the average percentage gain or loss per trade. Calculated as the sum of all profit and loss percentages divided
by the number of closed trades.

TYPE

series float

SEE ALSO

strategy.avg_trade

strategy.avg_winning_trade
Returns the average amount of money gained per winning trade. Calculated as the sum of profits divided by the
number of winning trades.

TYPE

series float

SEE ALSO

strategy.avg_winning_trade_percent
strategy.avg_winning_trade_percent
Returns the average percentage gain per winning trade. Calculated as the sum of profit percentages divided by the
number of winning trades.

TYPE

series float

SEE ALSO

strategy.avg_winning_trade

[Link]
Number of trades, which were closed for the whole trading range.

TYPE

series int

SEE ALSO

strategy.position_size [Link] [Link] [Link] [Link]

[Link].first_index
The index, or trade number, of the first (oldest) trade listed in the List of Trades. This number is usually zero. If more
trades than the allowed limit have been closed, the oldest trades are removed, and this number is the index of the
oldest remaining trade.

TYPE

series int

SEE ALSO

strategy.position_size [Link] [Link] [Link] [Link]

[Link]
Current equity (strategy.initial_capital + [Link] + [Link]).

TYPE

series float

SEE ALSO

[Link] [Link] strategy.position_size

[Link]
Number of breakeven trades for the whole trading range.

TYPE

series int

SEE ALSO

strategy.position_size [Link] [Link] [Link] [Link]

[Link]
Total currency value of all completed losing trades.

TYPE

series float

SEE ALSO

[Link] [Link]

strategy.grossloss_percent
The total value of all completed losing trades, expressed as a percentage of the initial capital.

TYPE

series float

SEE ALSO

[Link]

[Link]
Total currency value of all completed winning trades.

TYPE

series float

SEE ALSO

[Link] [Link]

strategy.grossprofit_percent
The total currency value of all completed winning trades, expressed as a percentage of the initial capital.

TYPE

series float

SEE ALSO

[Link]

strategy.initial_capital
The amount of initial capital set in the strategy properties.

TYPE

series float

SEE ALSO

strategy()

[Link]
Number of unprofitable trades for the whole trading range.

TYPE
series int

SEE ALSO

strategy.position_size [Link] [Link] [Link] [Link]

strategy.margin_liquidation_price
When margin is used in a strategy, returns the price point where a simulated margin call will occur and liquidate
enough of the position to meet the margin requirements.

strategy.position_size strategy.max_contracts_held_all strategy.max_contracts_held_long

strategy.max_drawdown
Maximum equity drawdown value for the whole trading range.

TYPE

series float

SEE ALSO

[Link] [Link] strategy.max_runup

strategy.max_drawdown_percent
The maximum equity drawdown value for the whole trading range, expressed as a percentage and calculated by
formula: Lowest Value During Trade / (Entry Price x Quantity) * 100 .

TYPE

series float

SEE ALSO

strategy.max_drawdown

strategy.max_runup
Maximum equity run-up value for the whole trading range.

TYPE

series float

SEE ALSO

[Link] [Link] strategy.max_drawdown

strategy.max_runup_percent
The maximum equity run-up value for the whole trading range, expressed as a percentage and calculated by formula:
Highest Value During Trade / (Entry Price x Quantity) * 100 .

TYPE

series float

SEE ALSO

strategy.max_runup

[Link]
Total currency value of all completed trades.
TYPE

series float

SEE ALSO

[Link] strategy.position_size [Link] [Link]

strategy.netprofit_percent
The total value of all completed trades, expressed as a percentage of the initial capital.

TYPE

series float

SEE ALSO

[Link]

[Link]
Current unrealized profit or loss for all open positions.

TYPE

series float

SEE ALSO

[Link] strategy.position_size

strategy.openprofit_percent
The current unrealized profit or loss for all open positions, expressed as a percentage and calculated by formula: ope
nPL / realizedEquity * 100 .

TYPE

series float

SEE ALSO

[Link]

[Link]
Number of market position entries, which were not closed and remain opened. If there is no open market position, 0 is
returned.

TYPE

series int

SEE ALSO

strategy.position_size

[Link].capital_held
Returns the capital amount currently held by open trades.

TYPE

series float
EXAMPLE

//@version=6
strategy(
"[Link].capital_held example", overlay=false, margin_long=50, margin_short=50,
default_qty_type = strategy.percent_of_equity, default_qty_value = 100
)

// Enter a short position on the first bar.

if [Link]
[Link]("Short", [Link])

// Plot the capital held by the short position.

plot([Link].capital_held, "Capital held")
// Highlight the chart background if the position is completely closed by margin calls.
bgcolor(bar_index > 0 and [Link].capital_held == 0 ? [Link]([Link], 60) : na)

REMARKS

This variable returns na if the strategy does not simulate funding trades with a portion of the hypothetical account, i.e.,
if the strategy() function does not include nonzero margin_long or margin_short arguments.

strategy.position_avg_price
Average entry price of current market position. If the market position is flat, 'NaN' is returned.

TYPE

series float

SEE ALSO

strategy.position_size

strategy.position_entry_name
Name of the order that initially opened current market position.

TYPE

series string

SEE ALSO

strategy.position_size

strategy.position_size
Direction and size of the current market position. If the value is > 0, the market position is long. If the value is < 0, the
market position is short. The absolute value is the number of contracts/shares/lots/units in trade (position size).

TYPE

series float

SEE ALSO

strategy.position_avg_price

[Link]
Number of profitable trades for the whole trading range.

TYPE

series int
SEE ALSO

strategy.position_size [Link] [Link] [Link] [Link]

[Link]
Returns a string containing the code representing the symbol's base currency (i.e., the traded currency or coin) if the
instrument is a Forex or Crypto pair or a derivative based on such a pair. Otherwise, it returns an empty string. For
example, this variable returns "EUR" for "EURJPY", "BTC" for "BTCUSDT", "CAD" for "CME:6C1!", and "" for
"NASDAQ:AAPL".

TYPE

simple string

SEE ALSO

[Link] [Link]

[Link]
Returns the two-letter code of the country where the symbol is traded, in the ISO 3166-1 alpha-2 format, or na if the
exchange is not directly tied to a specific country. For example, on "NASDAQ:AAPL" it will return "US", on "LSE:AAPL"
it will return "GB", and on "BITSTAMP:BTCUSD it will return na.

TYPE

simple string

[Link]
Returns a string containing the code representing the currency of the symbol's prices. For example, this variable
returns "USD" for "NASDAQ:AAPL" and "JPY" for "EURJPY".

TYPE

simple string

SEE ALSO

[Link] [Link] [Link] [Link]

syminfo.current_contract
The ticker identifier of the underlying contract, if the current symbol is a continuous futures contract; na otherwise.

TYPE

simple string

SEE ALSO

[Link] [Link]

[Link]
Description for the current symbol.

TYPE

simple string

SEE ALSO

[Link] [Link]
[Link]
The number of employees the company has.

TYPE

simple int

EXAMPLE

//@version=6
indicator("syminfo simple")
//@variable A table containing information about a company's employees, shareholders, and shares.
var result_table = [Link](position = position.top_right, columns = 2, rows = 5, border_width = 1)
if [Link]
// Add header cells
[Link](table_id = result_table, column = 0, row = 0, text = "name")
[Link](table_id = result_table, column = 1, row = 0, text = "value")
// Add employee info cells.
[Link](table_id = result_table, column = 0, row = 1, text = "employees")
[Link](table_id = result_table, column = 1, row = 1, text = [Link]([Link]))
// Add shareholder cells.
[Link](table_id = result_table, column = 0, row = 2, text = "shareholders")
[Link](table_id = result_table, column = 1, row = 2, text = [Link]([Link]))
// Add float shares outstanding cells.
[Link](table_id = result_table, column = 0, row = 3, text = "shares_outstanding_float")
[Link](table_id = result_table, column = 1, row = 3, text = [Link](syminfo.shares_outstan
ding_float))
// Add total shares outstanding cells.
[Link](table_id = result_table, column = 0, row = 4, text = "shares_outstanding_total")
[Link](table_id = result_table, column = 1, row = 4, text = [Link](syminfo.shares_outstan
ding_total))

SEE ALSO

[Link] syminfo.shares_outstanding_float syminfo.shares_outstanding_total

syminfo.expiration_date
A UNIX timestamp representing the start of the last day of the current futures contract. This variable is only compatible
with non-continuous futures symbols. On other symbols, it returns na.

TYPE

simple int

[Link]
Returns the industry of the symbol, or na if the symbol has no industry. Example: "Internet Software/Services",
"Packaged software", "Integrated Oil", "Motor Vehicles", etc. These are the same values one can see in the chart's
"Symbol info" window.

TYPE

simple string

REMARKS

A sector is a broad section of the economy. An industry is a narrower classification. NASDAQ:CAT (Caterpillar, Inc.) for
example, belongs to the "Producer Manufacturing" sector and the "Trucks/Construction/Farm Machinery" industry.

[Link]
Holds a string representing a symbol's associated International Securities Identification Number (ISIN), or an empty
string if there is no ISIN information available for the symbol. An ISIN is a 12-character alphanumeric code that
uniquely identifies a security globally. Unlike ticker symbols, which can vary across exchanges, the ISIN for a security is
consistent across exchanges. As such, programmers can use the ISIN to identify an underlying financial instrument,
regardless of the exchange or the symbol name listed by an exchange.

For example, the ISIN associated with NASDAQ:AAPL and GETTEX:APC is US0378331005, because both symbols
refer to the common stock from Apple Inc. In contrast, the ISIN for TSX:AAPL is CA03785Y1007, because the symbol
refers to a different instrument: the Apple Inc. Canadian Depositary Receipt (CDR).

TYPE

simple string

SEE ALSO

[Link] [Link]

syminfo.main_tickerid
A ticker identifier representing the current chart's symbol. The value contains an exchange prefix and a symbol name,
separated by a colon (e.g., "NASDAQ:AAPL"). It can also include information about data modifications such as dividend
adjustment, non-standard chart type, currency conversion, etc. Unlike [Link], this variable's value does not
change when used in the expression argument of a request.*() function call.

TYPE

simple string

SEE ALSO

[Link]() timeframe.main_period [Link] [Link] [Link] [Link]

[Link]

[Link]
The smallest amount of the current symbol that can be traded. This limit is set by the exchange. For cryptocurrencies,
it is often less than 1 token. For most other types of asset, it is often 1.

TYPE

simple float

SEE ALSO

[Link] [Link]

[Link]
Returns a whole number used to calculate the smallest increment between a symbol's price movements
([Link]). It is the numerator in the [Link] formula: [Link] / [Link]
= [Link] .

TYPE

simple int

SEE ALSO

[Link]() [Link] [Link] [Link] [Link]

[Link]
Min tick value for the current symbol.

TYPE

simple float
SEE ALSO

[Link] [Link]

[Link]
The chart price of a security multiplied by the point value equals the actual price of the traded security.
For all types of security except futures, the point value is usually equal to 1 and can therefore be ignored. For futures,
the prices shown on the chart are either the cost of a single futures contract, in which case the point value is 1, or the
price of a single unit of the underlying commodity, in which case the point value represents the number of units
included in a single contract.
For example, the price of the "COMEX:GC1!" gold futures chart reflects the price of a single troy ounce of gold.
However, a single GC futures contract comprises 100 troy ounces, as defined by the COMEX exchange. So when the
price on the "GC1!" chart is 2000 USD, a single contract costs 2000 USD * 100 troy ounces = 200,000 USD. This
calculation is important in backtesting, because the strategy engine takes the point value into account, and does not
open a position if there is not enough capital.
The point value is also displayed in the Security Info window for a given asset.

TYPE

simple float

SEE ALSO

[Link] [Link]

[Link]
Prefix of current symbol name (i.e. for 'CME_EOD:TICKER' prefix is 'CME_EOD').

TYPE

simple string

EXAMPLE

//@version=6
indicator("[Link]")

// If current chart symbol is 'BATS:MSFT' then [Link] is 'BATS'.

if [Link]
[Link](bar_index, high, text=[Link])

SEE ALSO

[Link] [Link]

[Link]
Returns a whole number used to calculate the smallest increment between a symbol's price movements
([Link]). It is the denominator in the [Link] formula: [Link] / [Link]
e = [Link] .

TYPE

simple int

SEE ALSO

[Link]() [Link] [Link] [Link] [Link]

syminfo.recommendations_buy
The number of analysts who gave the current symbol a "Buy" rating.

TYPE

series int

EXAMPLE

SEE ALSO

syminfo.recommendations_buy syminfo.recommendations_buy_strong syminfo.recommendations_date

syminfo.recommendations_hold syminfo.recommendations_sell syminfo.recommendations_sell_strong

[Link]
Root for derivatives like futures contract. For other symbols returns the same value as [Link].

TYPE
simple string

EXAMPLE

//@version=6
indicator("[Link]")

// If the current chart symbol is continuous futures ('ES1!'), it would display 'ES'.
if [Link]
[Link](bar_index, high, [Link])

SEE ALSO

[Link] [Link]

[Link]
Returns the sector of the symbol, or na if the symbol has no sector. Example: "Electronic Technology", "Technology
services", "Energy Minerals", "Consumer Durables", etc. These are the same values one can see in the chart's "Symbol
info" window.

TYPE

simple string

REMARKS

[Link]
Session type of the chart main series. Possible values are [Link], [Link].

TYPE

simple string

SEE ALSO

[Link] [Link]

[Link]
The number of shareholders the company has.

TYPE

simple int

EXAMPLE

SEE ALSO

[Link] syminfo.shares_outstanding_float syminfo.shares_outstanding_total

syminfo.shares_outstanding_float
The total number of shares outstanding a company has available, excluding any of its restricted shares.

TYPE

simple float

EXAMPLE

SEE ALSO

[Link] [Link] syminfo.shares_outstanding_total

syminfo.shares_outstanding_total
The total number of shares outstanding a company has available, including restricted shares held by insiders, major
shareholders, and employees.

TYPE

simple int

EXAMPLE

SEE ALSO

[Link] [Link] syminfo.shares_outstanding_float

syminfo.target_price_average
The average of the last yearly price targets for the symbol predicted by analysts.

TYPE

series float

EXAMPLE

//@version=6
indicator("syminfo target_price")
if [Link]
//@variable The time value one year from the date of the last analyst recommendations.
int YTD = syminfo.target_price_date + timeframe.in_seconds("12M") * 1000
//@variable A line connecting the current `close` to the highest yearly price estimate.
highLine = [Link](time, close, YTD, syminfo.target_price_high, color = [Link], xloc = xloc.b
ar_time)
//@variable A line connecting the current `close` to the lowest yearly price estimate.
lowLine = [Link](time, close, YTD, syminfo.target_price_low, color = [Link], xloc = xloc.bar_t
ime)
//@variable A line connecting the current `close` to the median yearly price estimate.
medianLine = [Link](time, close, YTD, syminfo.target_price_median, color = [Link], xloc = xlo
c.bar_time)
//@variable A line connecting the current `close` to the average yearly price estimate.
averageLine = [Link](time, close, YTD, syminfo.target_price_average, color = [Link], xloc
= xloc.bar_time)
// Fill the space between targets
[Link](lowLine, medianLine, [Link]([Link], 90))
[Link](medianLine, highLine, [Link]([Link], 90))
// Create a label displaying the total number of analyst estimates.
string estimatesText = [Link]("Number of estimates: {0}", syminfo.target_price_estimates)
[Link](bar_index, close, estimatesText, textcolor = [Link], size = [Link])

REMARKS

If analysts supply the targets when the market is closed, the variable can return na until the market opens.

SEE ALSO

syminfo.target_price_date syminfo.target_price_estimates syminfo.target_price_high syminfo.target_price_low

syminfo.target_price_median

syminfo.target_price_date
The starting date of the last price target prediction for the current symbol.

TYPE

series int
EXAMPLE

REMARKS

If analysts supply the targets when the market is closed, the variable can return na until the market opens.

SEE ALSO

syminfo.target_price_low
[Link]
Symbol name without exchange prefix, e.g. 'MSFT'.

TYPE

simple string

SEE ALSO

[Link] [Link] [Link] [Link]

[Link]
A ticker identifier representing the chart's symbol or a requested symbol, depending on how the script uses it. The
variable's value represents a requested dataset's ticker ID when used in the expression argument of a reques
t.*() function call. Otherwise, it represents the chart's ticker ID. The value contains an exchange prefix and a
symbol name, separated by a colon (e.g., "NASDAQ:AAPL"). It can also include information about data modifications
such as dividend adjustment, non-standard chart type, currency conversion, etc.

TYPE

simple string

REMARKS

Because the value of this variable does not always use a simple "prefix:ticker" format, it is a poor candidate for use in
boolean comparisons or string manipulation functions. In those contexts, run the variable's result through
[Link]() to purify it. This will remove any extraneous information and return a ticker ID consistently formatted
using the "prefix:ticker" structure.

To always access the script's main ticker ID, even within another context, use the syminfo.main_tickerid variable.

SEE ALSO

[Link]() syminfo.main_tickerid timeframe.main_period [Link] [Link] [Link]

[Link]

[Link]
Timezone of the exchange of the chart main series. Possible values see in timestamp().

TYPE

simple string

SEE ALSO

timestamp()

[Link]
The type of market the symbol belongs to. The values are "stock", "fund", "dr", "right", "bond", "warrant", "structured",
"index", "forex", "futures", "spread", "economic", "fundamental", "crypto", "spot", "swap", "option", "commodity".

TYPE

simple string

SEE ALSO

[Link]

[Link]
Volume type of the current symbol. Possible values are: "base" for base currency, "quote" for quote currency, "tick"
for the number of transactions, and "n/a" when there is no volume or its type is not specified.

TYPE

simple string

REMARKS

Only some data feed suppliers provide information qualifying volume. As a result, the variable will return a value on
some symbols only, mostly in the crypto sector.

SEE ALSO

[Link]

[Link]
Accumulation/distribution index.

TYPE

series float

[Link]
Intraday Intensity Index.

TYPE

series float

EXAMPLE

//@version=6
indicator("Intraday Intensity Index")
plot([Link], color=[Link])

// the same on pine

f_iii() =>
(2 * close - high - low) / ((high - low) * volume)

plot(f_iii())

[Link]
Negative Volume Index.

TYPE

series float

EXAMPLE

//@version=6
indicator("Negative Volume Index")

plot([Link], color=[Link])

// the same on pine

f_nvi() =>
float ta_nvi = 1.0
float prevNvi = (nz(ta_nvi[1], 0.0) == 0.0) ? 1.0 : ta_nvi[1]
if nz(close, 0.0) == 0.0 or nz(close[1], 0.0) == 0.0
ta_nvi := prevNvi
else
ta_nvi := (volume < nz(volume[1], 0.0)) ? prevNvi + ((close - close[1]) / close[1]) * prevNv
i : prevNvi
result = ta_nvi

plot(f_nvi())

[Link]
On Balance Volume.

TYPE

series float

EXAMPLE

//@version=6
indicator("On Balance Volume")
plot([Link], color=[Link])

// the same on pine

f_obv() =>
[Link]([Link]([Link](close)) * volume)

plot(f_obv())

[Link]
Positive Volume Index.

TYPE

series float

EXAMPLE

//@version=6
indicator("Positive Volume Index")

plot([Link], color=[Link])

// the same on pine

f_pvi() =>
float ta_pvi = 1.0
float prevPvi = (nz(ta_pvi[1], 0.0) == 0.0) ? 1.0 : ta_pvi[1]
if nz(close, 0.0) == 0.0 or nz(close[1], 0.0) == 0.0
ta_pvi := prevPvi
else
ta_pvi := (volume > nz(volume[1], 0.0)) ? prevPvi + ((close - close[1]) / close[1]) * prevPv
i : prevPvi
result = ta_pvi

plot(f_pvi())

[Link]
Price-Volume Trend.

TYPE

series float

EXAMPLE
//@version=6
indicator("Price-Volume Trend")
plot([Link], color=[Link])

// the same on pine

f_pvt() =>
[Link](([Link](close) / close[1]) * volume)

plot(f_pvt())

[Link]
True range, equivalent to [Link](handle_na = false) . It is calculated as [Link](high - low, [Link]
s(high - close[1]), [Link](low - close[1])) .

TYPE

series float

SEE ALSO

[Link]() [Link]()

[Link]
Volume Weighted Average Price. It uses hlc3 as its source series.

TYPE

series float

SEE ALSO

[Link]()

[Link]
Williams Accumulation/Distribution.

TYPE

series float

EXAMPLE

//@version=6
indicator("Williams Accumulation/Distribution")
plot([Link], color=[Link])

// the same on pine

f_wad() =>
trueHigh = [Link](high, close[1])
trueLow = [Link](low, close[1])
mom = [Link](close)
gain = (mom > 0) ? close - trueLow : (mom < 0) ? close - trueHigh : 0
[Link](gain)

plot(f_wad())

[Link]
Williams Variable Accumulation/Distribution.
TYPE

series float

EXAMPLE

//@version=6
indicator("Williams Variable Accumulation/Distribution")
plot([Link], color=[Link])

// the same on pine

f_wvad() =>
(close - open) / (high - low) * volume

plot(f_wvad())

[Link]
Returns an array filled with all the current tables drawn by the script.

TYPE

array<table>

EXAMPLE

//@version=6
indicator("[Link]")
//delete all tables
[Link](position = position.top_right, columns = 2, rows = 1, bgcolor = [Link], border_width =
1)
a_allTables = [Link]
if [Link](a_allTables) > 0
for i = 0 to [Link](a_allTables) - 1
[Link]([Link](a_allTables, i))

REMARKS

The array is read-only. Index zero of the array is the ID of the oldest object on the chart.

SEE ALSO

[Link]() [Link] [Link] [Link]

time
Current bar time in UNIX format. It is the number of milliseconds that have elapsed since 00:00:00 UTC, 1 January
1970.

TYPE

series int

REMARKS

Note that this variable returns the timestamp based on the time of the bar's open. Because of that, for overnight
sessions (e.g. EURUSD, where Monday session starts on Sunday, 17:00) this variable can return time before the
specified date of the trading day. For example, on EURUSD, dayofmonth(time) can be lower by 1 than the date of
the trading day, because the bar for the current day actually opens one day prior.

SEE ALSO

time() time_close timenow year month weekofyear dayofmonth dayofweek hour minute second

time_close
The time of the current bar's close in UNIX format. It represents the number of milliseconds elapsed since 00:00:00
UTC, 1 January 1970. On tick charts and price-based charts such as Renko, line break, Kagi, point & figure, and range,
this variable's series holds an na timestamp for the latest realtime bar (because the future closing time is
unpredictable), but valid timestamps for all previous bars.

TYPE

series int

SEE ALSO

time timenow year month weekofyear dayofmonth dayofweek hour minute second

time_tradingday
The timestamp that represents 00:00 UTC of the trading day the current bar belongs to, in UNIX format (the number of
milliseconds that have elapsed since 00:00:00 UTC, 1 January 1970).

TYPE

series int

EXAMPLE

//@version=6
indicator("Friday session")

//@variable The day of week, based on the current `time_tradingday` value.

// Uses "UTC+0" to return the daily session's timestamp at 00:00 UTC.
int tradingDayOfWeek = dayofweek(time_tradingday, "UTC+0")

//@variable Returns `true` if the `dayofweek` represents Friday, in exchange time.

// It might never return `true` on overnight symbols, depending on the timeframe, since the Fr
iday session
// starts on Thursday.
bool isFriday = dayofweek == [Link]
//@variable Returns `true` if the `tradingDayOfWeek` is Friday.
// Differs from `isFriday` on symbols with overnight sessions and for timeframes > "1D" on oth
ers.
bool isFridaySession = tradingDayOfWeek == [Link]

// Create a horizontal line at the `[Link]` value.

hline([Link], "Friday value", [Link], hline.style_dashed, 2)
// Plot the `dayofweek` and `tradingDayOfWeek` for comparison.
plot(dayofweek, "Day of week", [Link], 2)
plot(tradingDayOfWeek, "Trading day", [Link], 3)
// Highlight the background when `isFriday` and `isFridaySession` occur.
bgcolor(isFriday ? [Link]([Link], 90) : na, title = "isFriday highlight")
bgcolor(isFridaySession ? [Link]([Link], 80) : na, title = "isFridaySession highlight")

REMARKS

This variable is helpful when working with overnight sessions, where the day's session can begin on the previous
calendar day. For example, on the "FXCM:EURUSD" symbol, the Monday session starts on Sunday, 17:00, exchange
time. Unlike time , which returns the timestamp for Sunday at 17:00 on the Monday daily bar, time_tradingday
returns the timestamp for Monday at 00:00 UTC. When used on timeframes higher than "1D", time_tradingday
returns the timestamp of the last trading day inside that bar (e.g., on "1W", it returns the timestamp of the final trading
day within the week).

SEE ALSO

time time_close

[Link]
Returns true if current resolution is a daily resolution, false otherwise.
TYPE

simple bool

SEE ALSO

[Link] [Link] [Link] [Link] [Link]

[Link] [Link]

[Link]
Returns true if current resolution is a daily or weekly or monthly resolution, false otherwise.

TYPE

simple bool

SEE ALSO

[Link] [Link] [Link] [Link] [Link]

[Link] [Link]

[Link]
Returns true if current resolution is an intraday (minutes or seconds) resolution, false otherwise.

TYPE

simple bool

SEE ALSO

[Link] [Link] [Link] [Link] [Link] [Link]

[Link]

[Link]
Returns true if current resolution is a minutes resolution, false otherwise.

TYPE

simple bool

SEE ALSO

[Link] [Link] [Link] [Link] [Link] [Link]

[Link]

[Link]
Returns true if current resolution is a monthly resolution, false otherwise.

TYPE

simple bool

SEE ALSO

[Link] [Link]

timeframe.main_period
A string representation of the script's main timeframe. If the script is an indicator() that specifies a timeframe value
in its declaration statement, this variable holds that value. Otherwise, its value represents the chart's timeframe. Unlike
[Link], this variable's value does not change when used in the expression argument of a request.*
() function call.

The string's format is "<quantity>[<unit>]", where <unit> is "T" for ticks, "S" for seconds, "D" for days, "W" for weeks,
and "M" for months, but is absent for minutes. No <unit> exists for hours: hourly timeframes are expressed in minutes.
The variable's value is: "10S" for 10 seconds, "30" for 30 minutes, "240" for four hours, "1D" for one day, "2W" for
two weeks, and "3M" for one quarter.

TYPE

simple string

SEE ALSO

[Link] syminfo.main_tickerid [Link] [Link] [Link]

[Link]
Multiplier of resolution, e.g. '60' - 60, 'D' - 1, '5D' - 5, '12M' - 12.

TYPE

simple int

SEE ALSO

[Link] [Link] [Link]

[Link]
A string representation of the script's main timeframe or a requested timeframe, depending on how the script uses it.
The variable's value represents the timeframe of a requested dataset when used in the expression argument of a
request.*() function call. Otherwise, its value represents the script's main timeframe (timeframe.main_period),
which equals either the timeframe argument of the indicator() declaration statement or the chart's timeframe.

TYPE

simple string

REMARKS

To always access the script's main timeframe, even within another context, use the timeframe.main_period variable.

SEE ALSO

timeframe.main_period syminfo.main_tickerid [Link] [Link] [Link]

timenow
Current time in UNIX format. It is the number of milliseconds that have elapsed since 00:00:00 UTC, 1 January 1970.

TYPE

series int

REMARKS

Please note that using this variable/function can cause indicator repainting.

SEE ALSO

timestamp() time time_close year month weekofyear dayofmonth dayofweek hour minute second

volume
Current bar volume.

TYPE

series float

REMARKS

Previous values may be accessed with square brackets operator [], e.g. volume[1], volume[2].

SEE ALSO

open high low close time() hl2 hlc3 hlcc4 ohlc4 ask bid

weekofyear
The week number of the year, in the exchange time zone, calculated from the bar's opening UNIX timestamp.

TYPE

series int

REMARKS

This variable always references the week number corresponding to the bar's opening time. Consequently, for symbols
with overnight sessions (e.g., "EURUSD", where the "Monday" session starts on Sunday at 17:00 in exchange time),
the value may represent a previous calendar week rather than the week of the session's primary trading day.

SEE ALSO

weekofyear() dayofmonth dayofweek time year month hour minute second

year
Current bar year in exchange timezone.

TYPE

series int

REMARKS

Note that this variable returns the year based on the time of the bar's open. For overnight sessions (e.g. EURUSD,
where Monday session starts on Sunday, 17:00) this value can be lower by 1 than the year of the trading day.

SEE ALSO

year() time month weekofyear dayofmonth dayofweek hour minute second

Constants

[Link]
Constant for dividends adjustment type (dividends adjustment is applied).

TYPE

const string

SEE ALSO

[Link] [Link] [Link]()

[Link]
Constant for none adjustment type (no adjustment is applied).

TYPE

const string

SEE ALSO

[Link] [Link] [Link]()

[Link]
Constant for splits adjustment type (splits adjustment is applied).

TYPE
const string

SEE ALSO

[Link] [Link] [Link]()

alert.freq_all
A named constant for use with the freq parameter of the alert() function.

All function calls trigger the alert.

TYPE

const string

SEE ALSO

alert()

alert.freq_once_per_bar
A named constant for use with the freq parameter of the alert() function.

The first function call during the bar triggers the alert.

TYPE

const string

SEE ALSO

alert()

alert.freq_once_per_bar_close
A named constant for use with the freq parameter of the alert() function.

The function call triggers the alert only when it occurs during the last script iteration of the real-time bar, when it
closes.

TYPE

const string

SEE ALSO

alert()

[Link]
A constant to specify the value of the backadjustment parameter in [Link]() and [Link]() functions.

TYPE

const backadjustment

SEE ALSO

[Link]() [Link]() [Link] [Link]

[Link]
A constant to specify the value of the backadjustment parameter in [Link]() and [Link]() functions.

TYPE
const backadjustment

SEE ALSO

[Link]() [Link]() [Link] [Link]

[Link]
A constant to specify the value of the backadjustment parameter in [Link]() and [Link]() functions.

TYPE

const backadjustment

SEE ALSO

[Link]() [Link]() [Link] [Link]

barmerge.gaps_off
Merge strategy for requested data. Data is merged continuously without gaps, all the gaps are filled with the previous
nearest existing value.

TYPE

const barmerge_gaps

SEE ALSO

[Link]() barmerge.gaps_on

barmerge.gaps_on
Merge strategy for requested data. Data is merged with possible gaps (na values).

TYPE

const barmerge_gaps

SEE ALSO

[Link]() barmerge.gaps_off

barmerge.lookahead_off
Merge strategy for the requested data position. Requested barset is merged with current barset in the order of sorting
bars by their close time. This merge strategy disables effect of getting data from "future" on calculation on history.

TYPE

const barmerge_lookahead

SEE ALSO

[Link]() barmerge.lookahead_on

barmerge.lookahead_on
Merge strategy for the requested data position. Requested barset is merged with current barset in the order of sorting
bars by their opening time. This merge strategy can lead to undesirable effect of getting data from "future" on
calculation on history. This is unacceptable in backtesting strategies, but can be useful in indicators.

TYPE

const barmerge_lookahead
SEE ALSO

[Link]() barmerge.lookahead_off

[Link]
Argentine Pesos.

TYPE

const string

SEE ALSO

strategy()
[Link]
Australian dollar.

TYPE

const string

SEE ALSO

strategy()

[Link]
Bangladeshi Taka.

TYPE

const string

SEE ALSO

strategy()

[Link]
Bahraini Dinar.

TYPE

const string

SEE ALSO

strategy()

[Link]
Brazilian real.

TYPE

const string

SEE ALSO

strategy()

[Link]
Bitcoin.

TYPE

const string

SEE ALSO

strategy()

[Link]
Canadian dollar.

TYPE
const string

SEE ALSO

strategy()

[Link]
Swiss franc.

TYPE

const string

SEE ALSO

strategy()

[Link]
Chilean Peso.

TYPE

const string

SEE ALSO

strategy()

[Link]
Chinese Yuan.

TYPE

const string

SEE ALSO

strategy()

[Link]
Colombian Peso.

TYPE

const string

SEE ALSO

strategy()

[Link]
Czech Koruna.

TYPE

const string

SEE ALSO

strategy()
[Link]
Danish Krone.

TYPE

const string

SEE ALSO

strategy()

[Link]
Egyptian pound.

TYPE

const string

SEE ALSO

strategy()

[Link]
Ethereum.

TYPE

const string

SEE ALSO

strategy()

[Link]
Euro.

TYPE

const string

SEE ALSO

strategy()

[Link]
Pound sterling.

TYPE

const string

SEE ALSO

strategy()

[Link]
Hong Kong dollar.

TYPE
const string

SEE ALSO

strategy()

[Link]
Hungarian Forint.

TYPE

const string

SEE ALSO

strategy()

[Link]
Indonesian Rupiah.

TYPE

const string

SEE ALSO

strategy()

[Link]
Israeli New Shekel.

TYPE

const string

SEE ALSO

strategy()

[Link]
Indian rupee.

TYPE

const string

SEE ALSO

strategy()

[Link]
Icelandic Krona.

TYPE

const string

SEE ALSO

strategy()
[Link]
Japanese yen.

TYPE

const string

SEE ALSO

strategy()

[Link]
Kenyan Shilling.

TYPE

const string

SEE ALSO

strategy()

[Link]
South Korean won.

TYPE

const string

SEE ALSO

strategy()

[Link]
Kuwaiti Dinar.

TYPE

const string

SEE ALSO

strategy()

[Link]
Sri Lankan Rupee.

TYPE

const string

SEE ALSO

strategy()

[Link]
Moroccan Dirham.

TYPE
const string

SEE ALSO

strategy()

[Link]
Mexican Peso.

TYPE

const string

SEE ALSO

strategy()

[Link]
Malaysian ringgit.

TYPE

const string

SEE ALSO

strategy()

[Link]
Nigerian Naira.

TYPE

const string

SEE ALSO

strategy()

[Link]
Norwegian krone.

TYPE

const string

SEE ALSO

strategy()

[Link]
Unspecified currency.

TYPE

const string

SEE ALSO

strategy()
[Link]
New Zealand dollar.

TYPE

const string

SEE ALSO

strategy()

[Link]
Peruvian sol.

TYPE

const string

SEE ALSO

strategy()

[Link]
Philippine Peso.

TYPE

const string

SEE ALSO

strategy()

[Link]
Pakistani rupee.

TYPE

const string

SEE ALSO

strategy()

[Link]
Polish zloty.

TYPE

const string

SEE ALSO

strategy()

[Link]
Qatari Riyal.

TYPE
const string

SEE ALSO

strategy()

[Link]
Romanian Leu.

TYPE

const string

SEE ALSO

strategy()

[Link]
Serbian Dinar.

TYPE

const string

SEE ALSO

strategy()

[Link]
Russian ruble.

TYPE

const string

SEE ALSO

strategy()

[Link]
Saudi Riyal.

TYPE

const string

SEE ALSO

strategy()

[Link]
Swedish krona.

TYPE

const string

SEE ALSO

strategy()
[Link]
Singapore dollar.

TYPE

const string

SEE ALSO

strategy()

[Link]
Thai Baht.

TYPE

const string

SEE ALSO

strategy()

[Link]
Tunisian Dinar.

TYPE

const string

SEE ALSO

strategy()

[Link]
Turkish lira.

TYPE

const string

SEE ALSO

strategy()

[Link]
New Taiwan Dollar.

TYPE

const string

SEE ALSO

strategy()

[Link]
United States dollar.

TYPE
const string

SEE ALSO

strategy()

[Link]
Tether.

TYPE

const string

SEE ALSO

strategy()

[Link]
Venezuelan Bolivar.

TYPE

const string

SEE ALSO

strategy()

[Link]
Vietnamese Dong.

TYPE

const string

SEE ALSO

strategy()

[Link]
South African rand.

TYPE

const string

SEE ALSO

strategy()

[Link]
Is a named constant for return value of dayofweek() function and value of dayofweek variable.

TYPE

const int

SEE ALSO
[Link] [Link] [Link] [Link] [Link]

[Link]

[Link]
Is a named constant for return value of dayofweek() function and value of dayofweek variable.

TYPE

const int

SEE ALSO

[Link] [Link] [Link] [Link] [Link]

[Link]

[Link]
Is a named constant for return value of dayofweek() function and value of dayofweek variable.

TYPE

const int

SEE ALSO

[Link] [Link] [Link] [Link] [Link]

[Link]

[Link]
Is a named constant for return value of dayofweek() function and value of dayofweek variable.

TYPE

const int

SEE ALSO

[Link] [Link] [Link] [Link] [Link]

[Link]

[Link]
Is a named constant for return value of dayofweek() function and value of dayofweek variable.

TYPE

const int

SEE ALSO

[Link] [Link] [Link] [Link] [Link]

[Link]

[Link]
Is a named constant for return value of dayofweek() function and value of dayofweek variable.

TYPE
const int

SEE ALSO

[Link] [Link] [Link] [Link] [Link]

[Link]

[Link]
Is a named constant for return value of dayofweek() function and value of dayofweek variable.

TYPE

const int

SEE ALSO

[Link] [Link] [Link] [Link] [Link]

[Link]

[Link]
A named constant for use with the display parameter of the plot*() , input*() , fill(), bgcolor(), barcolor(),
and hline() functions. Specifies that the values or visuals appear in all possible locations by default.

TYPE

const plot_simple_display

REMARKS

The display.* constants support + and - operations, enabling custom combinations of display settings. For
example, [Link] - display.data_window specifies that the data for an input or plot appears in all
possible locations except for the Data Window.

Selecting a deselected plot in the script's "Settings/Style" tab changes its display settings, causing the plotted data to
appear in all available chart locations. To restore the display settings coded in the script, select "Reset settings" from
the "Defaults" dropdown menu at the bottom of the "Settings" dialog box.

SEE ALSO

plot() plotshape() plotchar() plotarrow() plotbar() plotcandle()

display.data_window
A named constant for use with the display parameter of the plot*() and input*() functions. Specifies that
the values are available in the Data Window by default. The Data Window tab is accessible by clicking the "Object Tree
and Data Window" icon in the chart's right sidebar.

TYPE

const plot_display

REMARKS

The display.* constants support + and - operations, enabling custom combinations of display settings. For
example, display.data_window + display.status_line specifies that the data for an input or plot appears in
the Data Window and the script's status line, and [Link] - display.data_window specifies that the data
appears in all possible locations except for the Data Window.
Selecting a deselected plot in the script's "Settings/Style" tab changes its display settings, causing the plotted data to
appear in all available chart locations. To restore the display settings coded in the script, select "Reset settings" from
the "Defaults" dropdown menu at the bottom of the "Settings" dialog box.

SEE ALSO
plot() plotshape() plotchar() plotarrow() plotbar() plotcandle()

TYPE

const plot_simple_display

REMARKS

SEE ALSO

plot() plotshape() plotchar() plotarrow() plotbar() plotcandle()

[Link]
A named constant for use with the display parameter of the plot*() functions. Specifies that the plotted values
are displayed in a chart pane by default.

TYPE

const plot_display

REMARKS

The display.* constants support + and - operations, enabling custom combinations of display settings. For
example, [Link] + display.data_window specifies that the plot's values appear in the chart pane and
the Data Window, and [Link] - [Link] specifies that the values appear in all possible locations
except for the chart pane.
Selecting a deselected plot in the script's "Settings/Style" tab changes its display settings, causing the plotted data to
appear in all available chart locations. To restore the display settings coded in the script, select "Reset settings" from
the "Defaults" dropdown menu at the bottom of the "Settings" dialog box.

SEE ALSO

[Link]
A named constant for the [Link]() function. Is used to request the dividends return on a stock before
deductions.

TYPE

const string

SEE ALSO

[Link]()
[Link]
A named constant for the [Link]() function. Is used to request the dividends return on a stock after
deductions.

TYPE

const string

SEE ALSO

[Link]()

[Link]
A named constant for the [Link]() function. Is used to request the earnings value as it was reported.

TYPE

const string

SEE ALSO

[Link]()

[Link]
A named constant for the [Link]() function. Is used to request the estimated earnings value.

TYPE

const string

SEE ALSO

[Link]()

[Link]
A named constant for the [Link]() function. Is used to request the standardized earnings value.

TYPE

const string

SEE ALSO

[Link]()

[Link]
A named constant for [Link]() and line.set_extend() functions.

TYPE

const string

SEE ALSO

false
Literal representing a bool value, and result of a comparison operation.

REMARKS

See the User Manual for comparison operators and logical operators.

SEE ALSO

bool

font.family_default
Default text font for [Link](), box.set_text_font_family(), [Link](), label.set_text_font_family(), [Link]() and
table.cell_set_text_font_family() functions.

TYPE

const string

SEE ALSO

[Link]() box.set_text_font_family() [Link]() label.set_text_font_family() [Link]()

table.cell_set_text_font_family() font.family_monospace

font.family_monospace
Monospace text font for [Link](), box.set_text_font_family(), [Link](), label.set_text_font_family(), [Link]()
and table.cell_set_text_font_family() functions.

TYPE
const string

SEE ALSO

[Link]() box.set_text_font_family() [Link]() label.set_text_font_family() [Link]()

TYPE

const hline_style

SEE ALSO

hline.style_solid hline.style_dashed

hline.style_solid
Is a named constant for solid linestyle of hline() function.

TYPE

const hline_style

label.style_label_lower_left label.style_label_lower_right label.style_label_upper_left label.style_label_upper_right

label.style_label_center label.style_square

label.style_label_lower_right label.style_label_upper_left label.style_label_upper_right label.style_label_center

label.style_square label.style_diamond

label.style_label_lower_left label.style_label_upper_left label.style_label_upper_right label.style_label_center

label.style_square label.style_diamond

label.style_label_lower_left label.style_label_lower_right label.style_label_upper_right label.style_label_center

label.style_square label.style_diamond

[Link]
Determines the sort order of the array from the smallest to the largest value.

TYPE

const sort_order

SEE ALSO

array.new_float() [Link]()

[Link]
Determines the sort order of the array from the largest to the smallest value.

TYPE

const sort_order

SEE ALSO

array.new_float() [Link]()

plot.linestyle_dashed
A named constant for use with the plot() function's linestyle parameter, which modifies the appearance of plotted
lines. If the style argument of the function call specifies a plot style that displays a line, using this constant as the
linestyle argument specifies that the plotted line is dashed.

TYPE

const plot_line_style

SEE ALSO

plot() plot.linestyle_solid plot.linestyle_dotted

plot.linestyle_dotted
A named constant for use with the plot() function's linestyle parameter, which modifies the appearance of plotted
lines. If the style argument of the function call specifies a plot style that displays a line, using this constant as the
linestyle argument specifies that the plotted line is dotted.

TYPE

const plot_line_style

SEE ALSO

plot() plot.linestyle_dashed plot.linestyle_solid

plot.linestyle_solid
A named constant for use with the plot() function's linestyle parameter, which modifies the appearance of plotted
lines. If the style argument of the function call specifies a plot style that displays a line, using this constant as the
linestyle argument specifies that the plotted line is solid.

TYPE

const plot_line_style

SEE ALSO

plot() plot.linestyle_dashed plot.linestyle_dotted

plot.style_area
A named constant for the 'Area' style, to be used as an argument for the style parameter in the plot() function.

TYPE

const plot_style

SEE ALSO

plot() plot.style_line plot.style_linebr plot.style_histogram plot.style_cross plot.style_areabr plot.style_columns

plot.style_circles plot.style_stepline plot.style_stepline_diamond plot.style_steplinebr

plot.style_areabr
A named constant for the 'Area With Breaks' style, to be used as an argument for the style parameter in the plot()
function. Similar to plot.style_area, except the gaps in the data are not filled.

position.top_left
Table position is used in [Link](), [Link]() functions.

Binds the table to the upper-left edge.

TYPE

const string

SEE ALSO

[Link]() [Link]() table.set_position() position.top_center position.top_right position.middle_left

position.middle_center position.middle_right position.bottom_left position.bottom_center position.bottom_right

position.top_right
Table position is used in [Link](), [Link]() functions.

Binds the table to the upper-right edge.

TYPE

const string

SEE ALSO

[Link]() [Link]() table.set_position() position.top_left position.top_center position.middle_left

position.middle_center position.middle_right position.bottom_left position.bottom_center position.bottom_right

[Link]
Scale value for indicator() function. Indicator is added to the left price scale.

TYPE

const scale_type

SEE ALSO

indicator()

[Link]
Scale value for indicator() function. Indicator is added in 'No Scale' mode. Can be used only with 'overlay=true'.

TYPE

const scale_type

SEE ALSO

indicator()

[Link]
Scale value for indicator() function. Indicator is added to the right price scale.

TYPE

const scale_type

SEE ALSO

indicator()

[Link]
Constant for extended session type (with extended hours data).

TYPE

const string

SEE ALSO

[Link] [Link]

[Link]
Constant for regular session type (no extended hours data).

TYPE

const string

SEE ALSO

[Link] [Link]

settlement_as_close.inherit
A constant to specify the value of the settlement_as_close parameter in [Link]() and [Link]()
functions.

TYPE

const settlement
SEE ALSO

[Link]() [Link]() settlement_as_close.on settlement_as_close.off

settlement_as_close.off
A constant to specify the value of the settlement_as_close parameter in [Link]() and [Link]()
functions.

TYPE

const settlement

SEE ALSO

[Link]() [Link]() settlement_as_close.on settlement_as_close.inherit

settlement_as_close.on
A constant to specify the value of the settlement_as_close parameter in [Link]() and [Link]()
functions.

TYPE

const settlement

SEE ALSO

[Link]() [Link]() settlement_as_close.inherit settlement_as_close.off

[Link]
Shape style for plotshape() function.

TYPE

const string

SEE ALSO

plotshape()

[Link]
Shape style for plotshape() function.

TYPE

const string

SEE ALSO

plotshape()

[Link]
Shape style for plotshape() function.

TYPE

const string

SEE ALSO

plotshape()
[Link]
Shape style for plotshape() function.

TYPE

const string

SEE ALSO

plotshape()

[Link]
Shape style for plotshape() function.

TYPE

const string

SEE ALSO

plotshape()

[Link]
Shape style for plotshape() function.

TYPE

const string

SEE ALSO

plotshape()

[Link]
Shape style for plotshape() function.

TYPE

const string

SEE ALSO

plotshape()

[Link]
Shape style for plotshape() function.

TYPE

const string

SEE ALSO

plotshape()

[Link]
Shape style for plotshape() function.

TYPE
const string

SEE ALSO

plotshape()

[Link]
Shape style for plotshape() function.

TYPE

const string

SEE ALSO

plotshape()

[Link]
Shape style for plotshape() function.

TYPE

const string

SEE ALSO

plotshape()

[Link]
Shape style for plotshape() function.

TYPE

const string

SEE ALSO

plotshape()

[Link]
A constant to specify the size of the graphics drawn by plotchar(), plotshape(), [Link](), and [Link](). Adjusts the
size of the graphics automatically.

TYPE

const string

SEE ALSO

plotshape() plotchar() label.set_size() [Link] [Link] [Link] [Link] [Link]

[Link]
A constant to specify the size of the graphics drawn by plotchar(), plotshape(), [Link](), [Link](), and [Link]().
Sets the size to huge.

TYPE

const string

SEE ALSO
plotshape() plotchar() label.set_size() [Link] [Link] [Link] [Link] [Link]

[Link]
A constant to specify the size of the graphics drawn by plotchar(), plotshape(), [Link](), [Link](), and [Link]().
Sets the size to large.

TYPE

const string

SEE ALSO

plotshape() plotchar() label.set_size() [Link] [Link] [Link] [Link] [Link]

[Link]
A constant to specify the size of the graphics drawn by plotchar(), plotshape(), [Link](), [Link](), and [Link]().
Sets the size to normal.

TYPE

const string

SEE ALSO

plotshape() plotchar() label.set_size() [Link] [Link] [Link] [Link] [Link]

[Link]
A constant to specify the size of the graphics drawn by plotchar(), plotshape(), [Link](), [Link](), and [Link]().
Sets the size to small.

TYPE

const string

SEE ALSO

plotshape() plotchar() label.set_size() [Link] [Link] [Link] [Link] [Link]

[Link]
A constant to specify the size of the graphics drawn by plotchar(), plotshape(), [Link](), [Link](), and [Link]().
Sets the size to tiny.

TYPE

const string

SEE ALSO

plotshape() plotchar() label.set_size() [Link] [Link] [Link] [Link] [Link]

[Link]
A named constant for the [Link]() function. Is used to request the denominator (the number below the line in a
fraction) of a splits.

TYPE

const string

SEE ALSO

[Link]()

[Link]
This is one of the arguments that can be supplied to the default_qty_type parameter in the strategy() declaration
statement. It is only relevant when no value is used for the ‘qty’ parameter in [Link]() or [Link]()
function calls. It specifies that an amount of cash in the strategy.account_currency will be used to enter
trades.

TYPE

const string

EXAMPLE

//@version=6
strategy("[Link]", overlay = true, default_qty_value = 50, default_qty_type = [Link], ini
tial_capital = 1000000)

if bar_index == 0
// As ‘qty’ is not defined, the previously defined values for the `default_qty_type` and `default_q
ty_value` parameters are used to enter trades, namely 50 units of cash in the currency of `[Link]
ount_currency`.
// `qty` is calculated as (default_qty_value)/(close price). If current price is $5, then qty = 50/
5 = 10.
[Link]("EN", [Link])
if bar_index == 2
[Link]("EN")

SEE ALSO

strategy()

[Link].cash_per_contract
Commission type for an order. Money displayed in the account currency per contract.

TYPE

const string

SEE ALSO

strategy()

[Link].cash_per_order
Commission type for an order. Money displayed in the account currency per order.

TYPE

const string
SEE ALSO

strategy()

[Link]
Commission type for an order. A percentage of the cash volume of order.

TYPE

const string

SEE ALSO

strategy()

[Link]
It allows strategy to open both long and short positions.

TYPE

const string

SEE ALSO

[Link].allow_entry_in()

[Link]
It allows strategy to open only long positions.

TYPE

const string

SEE ALSO

[Link].allow_entry_in()

[Link]
It allows strategy to open only short positions.

TYPE

const string

SEE ALSO

[Link].allow_entry_in()

[Link]
This is one of the arguments that can be supplied to the default_qty_type parameter in the strategy() declaration
statement. It is only relevant when no value is used for the ‘qty’ parameter in [Link]() or [Link]()
function calls. It specifies that a number of contracts/shares/lots will be used to enter trades.

TYPE

const string

EXAMPLE

//@version=6
strategy("[Link]", overlay = true, default_qty_value = 50, default_qty_type = [Link], i
nitial_capital = 1000000)

if bar_index == 0
// As ‘qty’ is not defined, the previously defined values for the `default_qty_type` and `default_q
ty_value` parameters are used to enter trades, namely 50 contracts.
// qty = 50
[Link]("EN", [Link])
if bar_index == 2
[Link]("EN")

SEE ALSO

strategy()

[Link]
A named constant for use with the direction parameter of the [Link]() and [Link]() commands. It
specifies that the command creates a buy order.

TYPE

const strategy_direction

SEE ALSO

[Link]() [Link]() [Link]()

[Link]
A named constant for use with the oca_type parameter of the [Link]() and [Link]() commands. It
specifies that the strategy cancels the unfilled order when another order with the same oca_name and oca_type
executes.

TYPE

const string

REMARKS

Strategies cannot cancel or reduce pending orders from an OCA group if they execute on the same tick. For example, if
the market price triggers two stop orders from [Link]() calls with the same oca_* arguments, the strategy
cannot fully or partially cancel either one.

SEE ALSO

[Link]() [Link]() [Link]()

[Link]
A named constant for use with the oca_type parameter of the [Link]() and [Link]() commands. It
specifies that the order executes independently of all other orders, including those with the same oca_name .

TYPE

const string

SEE ALSO

[Link]() [Link]() [Link]()

[Link]
A named constant for use with the oca_type parameter of the [Link]() and [Link]() commands. It
specifies that when another order with the same oca_name and oca_type executes, the strategy reduces the
unfilled order by that order's size. If the unfilled order's size reaches 0 after reduction, it is the same as canceling the
order entirely.

TYPE

const string

REMARKS

Orders from [Link]() automatically use this OCA type, and they belong to the same OCA group by default.

SEE ALSO

[Link]() [Link]() [Link]()

strategy.percent_of_equity
This is one of the arguments that can be supplied to the default_qty_type parameter in the strategy() declaration
statement. It is only relevant when no value is used for the ‘qty’ parameter in [Link]() or [Link]()
function calls. It specifies that a percentage (0-100) of equity will be used to enter trades.

TYPE

const string

EXAMPLE

//@version=6
strategy("strategy.percent_of_equity", overlay = false, default_qty_value = 100, default_qty_type = str
ategy.percent_of_equity, initial_capital = 1000000)

// As ‘qty’ is not defined, the previously defined values for the `default_qty_type` and `default_qty_v
alue` parameters are used to enter trades, namely 100% of available equity.
if bar_index == 0
[Link]("EN", [Link])
if bar_index == 2
[Link]("EN")
plot([Link])

// The ‘qty’ parameter is set to 10. Entering position with fixed size of 10 contracts and entry marke
t price = (10 * close).
if bar_index == 4
[Link]("EN", [Link], qty = 10)
if bar_index == 6
[Link]("EN")

SEE ALSO

strategy()

TYPE

const string

SEE ALSO

xloc.bar_time [Link]() [Link]() [Link]() [Link]() line.set_xloc() label.set_xloc()

xloc.bar_time
A constant that specifies how functions that create and modify Pine drawings interpret x-coordinates. If xloc = xlo
c.bar_time , the drawing object treats each x-coordinate as a UNIX timestamp, expressed in milliseconds.

TYPE

const string

SEE ALSO

xloc.bar_index [Link]() [Link]() [Link]() [Link]() line.set_xloc() label.set_xloc() xloc.bar_index

[Link]
A named constant that specifies the algorithm of interpretation of y-value in function [Link]().

TYPE

const string

SEE ALSO

[Link]() label.set_yloc() [Link] [Link]

[Link]
A named constant that specifies the algorithm of interpretation of y-value in function [Link]().

TYPE

const string

SEE ALSO

[Link]() label.set_yloc() [Link] [Link]

[Link]
A named constant that specifies the algorithm of interpretation of y-value in function [Link]().

TYPE

const string
SEE ALSO

[Link]() label.set_yloc() [Link] [Link]

Functions

alert()
Creates an alert trigger for an indicator or strategy, with a specified frequency, when called on the latest realtime bar.
To activate alerts for a script containing calls to this function, open the "Create Alert" dialog box, then select the script
name and "Any alert() function call" in the "Condition" section.

SYNTAX

alert(message, freq) → void

ARGUMENTS

message (series string) The message to send when the alert occurs.
freq (input string) Optional. Determines the allowed frequency of the alert trigger. Possible values are: alert.freq_all
(allows an alert on any realtime update), alert.freq_once_per_bar (allows an alert only on the first execution for each
realtime bar), or alert.freq_once_per_bar_close (allows an alert only when a realtime bar closes). The default is
alert.freq_once_per_bar.

EXAMPLE

//@version=6
indicator("`alert()` example", "", true)
ma = [Link](close, 14)
xUp = [Link](close, ma)
if xUp
// Trigger the alert the first time a cross occurs during the real-time bar.
alert("Price (" + [Link](close) + ") crossed over MA (" + [Link](ma) + ").", [Link]
_once_per_bar)
plot(ma)
plotchar(xUp, "xUp", "▲", [Link], size = [Link])

REMARKS

The alert() function does not display information on the chart.

In contrast to alertcondition(), calls to this function do not count toward a script's plot count. Additionally, alert()
calls are allowed in local scopes, including the scopes of exported library functions.
See this article in our Help Center to learn more about activating alerts from alert() calls.

SEE ALSO

alertcondition()

alertcondition()
Creates alert condition, that is available in Create Alert dialog. Please note, that alertcondition() does NOT create an
alert, it just gives you more options in Create Alert dialog. Also, alertcondition() effect is invisible on chart.

SYNTAX

alertcondition(condition, title, message) → void

ARGUMENTS

condition (series bool) Series of boolean values that is used for alert. True values mean alert fire, false - no alert.
Required argument.
title (const string) Title of the alert condition. Optional argument.

message (const string) Message to display when alert fires. Optional argument.

EXAMPLE

//@version=6
indicator("alertcondition", overlay=true)
alertcondition(close >= open, title='Alert on Green Bar', message='Green Bar!')

REMARKS

Please note that an alertcondition call generates an additional plot. All such calls are taken into account when we
calculate the number of the output series per script.

SEE ALSO

alert()

[Link]() 2 overloads

Returns an array containing the absolute value of each element in the original array.

SYNTAX & OVERLOADS

[Link](id) → array<float>

[Link](id) → array<int>

ARGUMENTS

id (array<int/float>) An array object.

SEE ALSO

array.new_float() [Link]() [Link]() [Link]() [Link] [Link]

[Link]() 2 overloads

The function returns the mean of an array's elements.

SYNTAX & OVERLOADS

[Link](id) → series float

[Link](id) → series int

ARGUMENTS

id (array<int/float>) An array object.

EXAMPLE

//@version=6
indicator("[Link] example")
a = array.new_float(0)
for i = 0 to 9
[Link](a, close[i])
plot([Link](a))

RETURNS
Mean of array's elements.

REMARKS

Returns na if the id array is empty.

REMARKS
A binary search works on sorted arrays in ascending order. It begins by comparing an element in the middle of the
array with the target value. If the element matches the target value, its position in the array is returned. If the element's
value is greater than the target value, the search continues in the lower half of the array. If the element's value is less
than the target value, the search continues in the upper half of the array. By doing this recursively, the algorithm
progressively eliminates smaller and smaller portions of the array in which the target value cannot lie.

SEE ALSO

array.new_float() [Link]() [Link]() [Link]() [Link] [Link]

[Link]()
The function removes all elements from an array.

SYNTAX

[Link](id) → void

ARGUMENTS

id (any array type) An array object.

EXAMPLE

//@version=6
indicator("[Link] example")
a = array.new_float(0)
b = array.new_float(0)
for i = 0 to 9
[Link](a, close[i])
[Link](b, open[i])
plot([Link](a, b))
RETURNS

The covariance of two arrays.

REMARKS

If biased is true, function will calculate using a biased estimate of the entire population, if false - unbiased estimate
of a sample. Returns na if both arrays are empty.

SEE ALSO

array.new_float() [Link]() [Link]() [Link]() [Link]()

[Link]()
Returns true if all elements of the id array are true, false otherwise.

SYNTAX

[Link](id) → series bool

ARGUMENTS

id (array<bool>) An array object.

REMARKS

This function also works with arrays of int and float types, in which case zero values are considered false, and all
others true.

SEE ALSO

[Link]() [Link]()

[Link]()
The function sets elements of an array to a single value. If no index is specified, all elements are set. If only a start
index (default 0) is supplied, the elements starting at that index are set. If both index parameters are used, the
elements from the starting index up to but not including the end index (default na) are set.

SYNTAX

[Link](id, value, index_from, index_to) → void

ARGUMENTS

id (any array type) An array object.

value (series <type of the array's elements>) Value to fill the array with.
index_from (series int) Start index, default is 0.

index_to (series int) End index, default is na. Must be one greater than the index of the last element to set.

EXAMPLE

//@version=6
indicator("[Link] example")
a = array.new_float(10)
[Link](a, close)
plot([Link](a))

SEE ALSO

array.new_float() [Link]() [Link]()

[Link]()
Returns the array's first element. Throws a runtime error if the array is empty.

SYNTAX

[Link](id) → series <type>

ARGUMENTS

id (any array type) An array object.

EXAMPLE

//@version=6
indicator("[Link] example")
arr = array.new_int(3, 10)
plot([Link](arr))

SEE ALSO

[Link]() [Link]()

[Link]() 12 overloads

The function takes a variable number of arguments with one of the types: int, float, bool, string, label, line, color, box,
table, linefill, and returns an array of the corresponding type.

SYNTAX & OVERLOADS

[Link](arg0, arg1, ...) → array<type>

[Link](arg0, arg1, ...) → array<enum>

[Link](arg0, arg1, ...) → array<label>

[Link](arg0, arg1, ...) → array<line>

[Link](arg0, arg1, ...) → array<box>

[Link](arg0, arg1, ...) → array<table>

[Link](arg0, arg1, ...) → array<linefill>

[Link](arg0, arg1, ...) → array<string>

[Link](arg0, arg1, ...) → array<color>

[Link](arg0, arg1, ...) → array<int>

[Link](arg0, arg1, ...) → array<float>

[Link](arg0, arg1, ...) → array<bool>

ARGUMENTS

arg0, arg1, ... (<arg..._type>) Array arguments.

EXAMPLE

//@version=6
indicator("array.from_example", overlay = false)
arr = [Link]("Hello", "World!") // arr (array<string>) will contain 2 elements: {Hello}, {World!}.
plot(close)

RETURNS

The array element's value.

REMARKS

This function can accept up to 4,000 'int', 'float', 'bool', or 'color' arguments. For all other types, including user-defined
types, the limit is 999.

[Link]()
The function returns the value of the element at the specified index.

SYNTAX

[Link](id, index) → series <type>

ARGUMENTS

id (any array type) An array object.

index (series int) The index of the element whose value is to be returned.

EXAMPLE

//@version=6
indicator("[Link] example")
a = array.new_float(0)
for i = 0 to 9
[Link](a, close[i] - open[i])
plot([Link](a, 9))

RETURNS

The array element's value.

REMARKS

If the index is positive, the function counts forwards from the beginning of the array to the end. The index of the first
element is 0, and the index of the last element is [Link]() - 1 . If the index is negative, the function counts
backwards from the end of the array to the beginning. In this case, the index of the last element is -1, and the index of
the first element is negative [Link]() . For example, for an array that contains three elements, all of the
following are valid arguments for the index parameter: 0, 1, 2, -1, -2, -3.

SEE ALSO

array.new_float() [Link]() [Link]() [Link]()

[Link]()
The function returns true if the value was found in an array, false otherwise.

SYNTAX
[Link](id, value) → series bool

ARGUMENTS

id (any array type) An array object.

value (series <type of the array's elements>) The value to search in the array.

EXAMPLE

//@version=6
indicator("[Link] example")
a = array.new_float(5, 5)
[Link](bar_index, close, [Link](a, ","))

SEE ALSO

array.new_float() [Link]() [Link]() [Link]() [Link]() [Link]()

[Link]()
Returns the array's last element. Throws a runtime error if the array is empty.

SYNTAX

[Link](id) → series <type>

ARGUMENTS
id (any array type) An array object.

EXAMPLE

//@version=6
indicator("[Link] example")
arr = array.new_int(3, 10)
plot([Link](arr))

SEE ALSO

[Link]() [Link]()

[Link]()
The function returns the index of the last occurrence of the value, or -1 if the value is not found.

SYNTAX

[Link](id, value) → series int

ARGUMENTS

id (any array type) An array object.

value (series <type of the array's elements>) The value to search in the array.

EXAMPLE

//@version=6
indicator("[Link] example")
a = array.new_float(5,high)
index = [Link](a, high)
plot(index)

RETURNS

The index of an element.

SEE ALSO

array.new_float() [Link]() [Link]() [Link]() [Link]()

[Link]() 2 overloads

The function returns the greatest value, or the nth greatest value in a given array.

SYNTAX & OVERLOADS

[Link](id, nth) → series float

[Link](id, nth) → series int

ARGUMENTS

id (array<int/float>) An array object.

nth (series int) The nth greatest value to return, where zero is the greatest. Optional. The default is zero.

EXAMPLE

//@version=6
indicator("[Link]")
a = [Link](5, -2, 0, 9, 1)
thirdHighest = [Link](a, 2) // 1
plot(thirdHighest)

RETURNS

The greatest or the nth greatest value in the array.

REMARKS

Returns na if the id array is empty.

SEE ALSO

array.new_float() [Link]() [Link]()

[Link]() 2 overloads

The function returns the median of an array's elements.

SYNTAX & OVERLOADS

[Link](id) → series float

[Link](id) → series int

ARGUMENTS

id (array<int/float>) An array object.

EXAMPLE

//@version=6
indicator("[Link] example")
a = array.new_float(0)
for i = 0 to 9
[Link](a, close[i])
plot([Link](a))

RETURNS

The median of the array's elements.

REMARKS

Returns na if the id array is empty.

SEE ALSO

[Link]() [Link]() [Link]() [Link]()

[Link]() 2 overloads

The function returns the smallest value, or the nth smallest value in a given array.

SYNTAX & OVERLOADS

[Link](id, nth) → series float

[Link](id, nth) → series int

ARGUMENTS
id (array<int/float>) An array object.

nth (series int) The nth smallest value to return, where zero is the smallest. Optional. The default is zero.

EXAMPLE

//@version=6
indicator("[Link]")
a = [Link](5, -2, 0, 9, 1)
secondLowest = [Link](a, 1) // 0
plot(secondLowest)

RETURNS

The smallest or the nth smallest value in the array.

REMARKS

Returns na if the id array is empty.

SEE ALSO

array.new_float() [Link]() [Link]()

[Link]() 2 overloads

The function returns the mode of an array's elements. If there are several values with the same frequency, it returns
the smallest value.

SYNTAX & OVERLOADS

[Link](id) → series float

[Link](id) → series int

ARGUMENTS

id (array<int/float>) An array object.

EXAMPLE

//@version=6
indicator("[Link] example")
a = array.new_float(0)
for i = 0 to 9
[Link](a, close[i])
plot([Link](a))

RETURNS

The most frequently occurring value from the id array. If none exists, returns the smallest value instead.

REMARKS

Returns na if the id array is empty.

SEE ALSO

array.new_float() [Link]() [Link]() [Link]() [Link]() [Link]()

array.new_bool()
The function creates a new array object of bool type elements.

SYNTAX
array.new_bool(size, initial_value) → array<bool>

ARGUMENTS

size (series int) Initial size of an array. Optional. The default is 0.

initial_value (series bool) Initial value of all array elements. Optional. The default is 'false'.

EXAMPLE

//@version=6
indicator("array.new_bool example")
length = 5
a = array.new_bool(length, close > open)
plot([Link](a, 0) ? close : open)

RETURNS

The ID of an array object which may be used in other array.*() functions.

REMARKS

An array index starts from 0.

SEE ALSO

array.new_float() [Link]() [Link]() [Link]()

array.new_box()
The function creates a new array object of box type elements.

SYNTAX

array.new_box(size, initial_value) → array<box>

ARGUMENTS

size (series int) Initial size of an array. Optional. The default is 0.

initial_value (series box) Initial value of all array elements. Optional. The default is 'na'.

EXAMPLE

//@version=6
indicator("array.new_box example")
boxes = array.new_box()
[Link](boxes, [Link](time, close, time+2, low, xloc=xloc.bar_time))
plot(1)

RETURNS

The ID of an array object which may be used in other array.*() functions.

REMARKS

An array index starts from 0.

SEE ALSO

array.new_label()
The function creates a new array object of label type elements.

SYNTAX

array.new_label(size, initial_value) → array<label>

ARGUMENTS

size (series int) Initial size of an array. Optional. The default is 0.

initial_value (series label) Initial value of all array elements. Optional. The default is 'na'.

EXAMPLE

//@version=6
indicator("array.new_label example", overlay = true, max_labels_count = 500)

//@variable The number of labels to show on the chart.

int labelCount = [Link](50, "Labels to show", 1, 500)

//@variable An array of `label` objects.

var array<label> labelArray = array.new_label()

//@variable A `[Link]` for the new label.

labelPoint = [Link].from_index(bar_index, close)
//@variable The text in the new label.
string labelText = na
//@variable The color of the new label.
color labelColor = na
//@variable The style of the new label.
string labelStyle = na

// Set the label attributes for rising bars.

if close > open
labelText := "Rising"
labelColor := [Link]
labelStyle := label.style_label_down
// Set the label attributes for falling bars.
else if close < open
labelText := "Falling"
labelColor := [Link]
labelStyle := label.style_label_up

// Add a new label to the `labelArray` when the chart bar closed at a new value.
if close != open
[Link]([Link](labelPoint, labelText, color = labelColor, style = labelStyle))
// Remove the first element and delete its label when the size of the `labelArray` exceeds the `labelCo
unt`.
if [Link]() > labelCount
[Link]([Link]())

RETURNS

The ID of an array object which may be used in other array.*() functions.

REMARKS

An array index starts from 0.

SEE ALSO

array.new_float() [Link]() [Link]()

array.new_line()
The function creates a new array object of line type elements.

SYNTAX

array.new_line(size, initial_value) → array<line>

ARGUMENTS

size (series int) Initial size of an array. Optional. The default is 0.

initial_value (series line) Initial value of all array elements. Optional. The default is 'na'.

EXAMPLE

//@version=6
indicator("array.new_line example")
// draw last 15 lines
var a = array.new_line()
[Link](a, [Link](bar_index - 1, close[1], bar_index, close))
if [Link](a) > 15
ln = [Link](a)
[Link](ln)

RETURNS

The ID of an array object which may be used in other array.*() functions.

REMARKS

An array index starts from 0.

SEE ALSO

array.new_float() [Link]() [Link]()

array.new_linefill()
The function creates a new array object of linefill type elements.
SYNTAX

array.new_linefill(size, initial_value) → array<linefill>

ARGUMENTS

size (series int) Initial size of an array.

initial_value (series linefill) Initial value of all array elements.

RETURNS

The ID of an array object which may be used in other array.*() functions.

REMARKS

An array index starts from 0.

array.new_string()
The function creates a new array object of string type elements.

SYNTAX

array.new_string(size, initial_value) → array<string>

ARGUMENTS

size (series int) Initial size of an array. Optional. The default is 0.

initial_value (series string) Initial value of all array elements. Optional. The default is 'na'.

EXAMPLE

//@version=6
indicator("array.new_string example")
length = 5
a = array.new_string(length, "text")
[Link](bar_index, close, [Link](a, 0))

RETURNS

The ID of an array object which may be used in other array.*() functions.

REMARKS

An array index starts from 0.

SEE ALSO

array.new_float() [Link]() [Link]()

array.new_table()
The function creates a new array object of table type elements.

SYNTAX

array.new_table(size, initial_value) → array<table>

ARGUMENTS

size (series int) Initial size of an array. Optional. The default is 0.

initial_value (series table) Initial value of all array elements. Optional. The default is 'na'.

EXAMPLE
//@version=6
indicator("table array")
tables = array.new_table()
[Link](tables, [Link](position = position.top_left, rows = 1, columns = 2, bgcolor = [Link]
w, border_width=1))
plot(1)

RETURNS

The ID of an array object which may be used in other array.*() functions.

REMARKS

An array index starts from 0.

SEE ALSO

array.new_float() [Link]() [Link]()

[Link]<type>()
The function creates a new array object of <type> elements.

SYNTAX

[Link]<type>(size, initial_value) → array<type>

ARGUMENTS

size (series int) Initial size of an array. Optional. The default is 0.

initial_value (<array_type>) Initial value of all array elements. Optional. The default is 'na'.

EXAMPLE

//@version=6
indicator("[Link]<string> example")
a = [Link]<string>(1, "Hello, World!")
[Link](bar_index, close, [Link](a, 0))

EXAMPLE

//@version=6
indicator("[Link]<color> example")
a = [Link]<color>()
[Link](a, [Link])
[Link](a, [Link])
plot(close, color = [Link](a, close > open ? 1 : 0))

EXAMPLE

//@version=6
indicator("[Link]<float> example")
length = 5
var a = [Link]<float>(length, close)
if [Link](a) == length
[Link](a, 0)
[Link](a, close)
plot([Link](a) / length, "SMA")

EXAMPLE

//@version=6
indicator("[Link]<line> example")
// draw last 15 lines
var a = [Link]<line>()
[Link](a, [Link](bar_index - 1, close[1], bar_index, close))
if [Link](a) > 15
ln = [Link](a)
[Link](ln)

RETURNS

The ID of an array object which may be used in other array.*() functions.

REMARKS

An array index starts from 0.

Percentile rank is the number of elements in the array that are less than or equal to the reference value, expressed as a
percentage.

Returns na if the id array is empty.

SEE ALSO

array.new_float() [Link]() [Link]() [Link]() [Link] [Link]

[Link]()
The function removes the last element from an array and returns its value.

SYNTAX

[Link](id) → series <type>

ARGUMENTS

id (any array type) An array object.

EXAMPLE

//@version=6
indicator("[Link] example")
a = array.new_float(5,high)
removedEl = [Link](a)
plot([Link](a))
plot(removedEl)

RETURNS

The value of the removed element.

SEE ALSO

array.new_float() [Link]() [Link]() [Link]() [Link]() [Link]()

[Link]()
The function appends a value to an array.

SYNTAX

[Link](id, value) → void

ARGUMENTS

id (any array type) An array object.

value (series <type of the array's elements>) The value of the element added to the end of the array.

EXAMPLE

//@version=6
indicator("[Link] example")
a = array.new_float(5, 0)
[Link](a, open)
plot([Link](a, 5))

SEE ALSO

array.new_float() [Link]() [Link]() [Link]() [Link]() [Link]()

[Link]() 2 overloads

The function returns the difference between the min and max values from a given array.

SYNTAX & OVERLOADS

[Link](id) → series float

[Link](id) → series int

ARGUMENTS

id (array<int/float>) An array object.

EXAMPLE

//@version=6
indicator("[Link] example")
a = array.new_float(0)
for i = 0 to 9
[Link](a, close[i])
plot([Link](a))

RETURNS

The difference between the min and max values in the array.

REMARKS

Returns na if the id array is empty.

SEE ALSO

array.new_float() [Link]() [Link]() [Link]()

[Link]()
The function changes the contents of an array by removing the element with the specified index.

SYNTAX

[Link](id, index) → series <type>

ARGUMENTS

id (any array type) An array object.

index (series int) The index of the element to remove.

EXAMPLE

//@version=6
indicator("[Link] example")
a = array.new_float(5,high)
removedEl = [Link](a, 0)
plot([Link](a))
plot(removedEl)

RETURNS

The value of the removed element.

REMARKS

SEE ALSO

array.new_float() [Link]() [Link]() [Link]() [Link]() [Link]()

[Link]()
The function reverses an array. The first array element becomes the last, and the last array element becomes the first.

SYNTAX

SEE ALSO

[Link]() [Link]() [Link]() [Link]() [Link]()

[Link]()
The function returns the number of elements in an array.

SYNTAX

[Link](id) → series int

ARGUMENTS

id (any array type) An array object.

EXAMPLE

//@version=6
indicator("[Link] example")
a = array.new_float(0)
for i = 0 to 9
[Link](a, close[i])
// note that changes in slice also modify original array
slice = [Link](a, 0, 5)
[Link](slice, open)
// size was changed in slice and in original array
plot([Link](a))
plot([Link](slice))

RETURNS

The number of elements in the array.

SEE ALSO

array.new_float() [Link]() [Link]() [Link]()

[Link]()
The function creates a slice from an existing array. If an object from the slice changes, the changes are applied to both
the new and the original arrays.

SYNTAX

[Link](id, index_from, index_to) → array<type>

ARGUMENTS

id (any array type) An array object.

index_from (series int) Zero-based index at which to begin extraction.

index_to (series int) Zero-based index before which to end extraction. The function extracts up to but not including
the element with this index.

EXAMPLE

//@version=6
indicator("[Link] example")
a = array.new_float(0)
for i = 0 to 9
[Link](a, close[i])
// take elements from 0 to 4
// *note that changes in slice also modify original array
slice = [Link](a, 0, 5)
plot([Link](a) / 10)
plot([Link](slice) / 5)

RETURNS

A shallow copy of an array's slice.

SEE ALSO

array.new_float() [Link]() [Link]() [Link]()

array.new_float() [Link]() [Link]() [Link]() [Link] [Link]

[Link]() 2 overloads

The function returns the array of standardized elements.

SYNTAX & OVERLOADS

[Link](id) → array<float>

[Link](id) → array<int>

ARGUMENTS

id (array<int/float>) An array object.

EXAMPLE

//@version=6
indicator("[Link] example")
a = array.new_float(0)
for i = 0 to 9
[Link](a, close[i])
b = [Link](a)
plot([Link](b))
plot([Link](b))

RETURNS

The array of standardized elements.

SEE ALSO

[Link]() [Link]() [Link]() [Link]() [Link]() [Link]()

[Link]() 2 overloads

The function returns the standard deviation of an array's elements.

SYNTAX & OVERLOADS

[Link](id, biased) → series float

[Link](id, biased) → series int

ARGUMENTS

id (array<int/float>) An array object.

biased (series bool) Determines which estimate should be used. Optional. The default is true.

EXAMPLE

//@version=6
indicator("[Link] example")
a = array.new_float(0)
for i = 0 to 9
[Link](a, close[i])
plot([Link](a))

RETURNS

The standard deviation of the array's elements.

REMARKS

If biased is true, the function calculates using a biased estimate of the entire population. If biased is false, it uses
an unbiased estimate of a sample.

Returns na if the id array is empty.

SEE ALSO

array.new_float() [Link]() [Link]() [Link]()

[Link]() 2 overloads

The function returns the sum of an array's elements.

SYNTAX & OVERLOADS

[Link](id) → series float

[Link](id) → series int

ARGUMENTS

id (array<int/float>) An array object.

EXAMPLE

//@version=6
indicator("[Link] example")
a = array.new_float(0)
for i = 0 to 9
[Link](a, close[i])
plot([Link](a))

RETURNS

The sum of the array's elements.

REMARKS

Returns na if the id array is empty.

SEE ALSO

array.new_float() [Link]() [Link]()

[Link]()
The function inserts the value at the beginning of the array.

SYNTAX

[Link](id, value) → void

ARGUMENTS

id (any array type) An array object.

value (series <type of the array's elements>) The value to add to the start of the array.

EXAMPLE

//@version=6
indicator("[Link] example")
a = array.new_float(5, 0)
[Link](a, open)
plot([Link](a, 0))

SEE ALSO

[Link]() [Link]() [Link]() [Link]() [Link]()

[Link]() 2 overloads

The function returns the variance of an array's elements.

SYNTAX & OVERLOADS

[Link](id, biased) → series float

[Link](id, biased) → series int

ARGUMENTS

id (array<int/float>) An array object.

biased (series bool) Determines which estimate should be used. Optional. The default is true.

EXAMPLE

//@version=6
indicator("[Link] example")
a = array.new_float(0)
for i = 0 to 9
[Link](a, close[i])
plot([Link](a))

RETURNS

The variance of the array's elements.

REMARKS

If biased is true, function will calculate using a biased estimate of the entire population, if false - unbiased estimate
of a sample.
Returns na if the id array is empty.

SEE ALSO

array.new_float() [Link]() [Link]() [Link]() [Link]()

barcolor()
Set color of bars.

SYNTAX

barcolor(color, offset, editable, show_last, title, display) → void

ARGUMENTS

color (series color) Color of bars. You can use constants like 'red' or '#ff001a' as well as complex expressions like
'close >= open ? [Link] : [Link]'. Required argument.

offset (simple int) Shifts the color series to the left or to the right on the given number of bars. Default is 0.
editable (input bool) If true then barcolor style will be editable in Format dialog. Default is true.

show_last (input int) Optional. The number of bars, counting backwards from the most recent bar, on which the
function can draw.

title (const string) Title of the barcolor. Optional argument.

display (input plot_simple_display) Controls where the barcolor is displayed. Possible values are: [Link],
[Link]. Default is [Link].

EXAMPLE

//@version=6
indicator("barcolor example", overlay=true)
barcolor(close < open ? [Link] : [Link])

SEE ALSO

bgcolor() plot() fill()

bgcolor()
Fill background of bars with specified color.

SYNTAX

bgcolor(color, offset, editable, show_last, title, display, force_overlay) → void

ARGUMENTS

color (series color) Color of the filled background. You can use constants like 'red' or '#ff001a' as well as complex
expressions like 'close >= open ? [Link] : [Link]'. Required argument.

offset (simple int) Shifts the color series to the left or to the right on the given number of bars. Default is 0.
editable (input bool) If true then bgcolor style will be editable in Format dialog. Default is true.

show_last (input int) Optional. The number of bars, counting backwards from the most recent bar, on which the
function can draw.

title (const string) Title of the bgcolor. Optional argument.

display (input plot_simple_display) Controls where the bgcolor is displayed. Possible values are: [Link],
[Link]. Default is [Link].
force_overlay (const bool) If true, the plotted results will display on the main chart pane, even when the script
occupies a separate pane. Optional. The default is false.
EXAMPLE

//@version=6
indicator("bgcolor example", overlay=true)
bgcolor(close < open ? [Link]([Link],70) : [Link]([Link], 70))

SEE ALSO

barcolor() plot() fill()

bool() 4 overloads

Converts the x value to a bool value. Returns false if x is na, false, or an int/float value equal to 0. Returns true for
all other possible values.

SYNTAX & OVERLOADS

bool(x) → const bool

bool(x) → input bool

bool(x) → simple bool

bool(x) → series bool

ARGUMENTS

x (simple int/float/bool) The value to convert to the specified type, usually na.

RETURNS

The value of the argument after casting to bool.

SEE ALSO

float() int() color() string() line() label()

box()
Casts na to box.

SYNTAX

box(x) → series box

ARGUMENTS

x (series box) The value to convert to the specified type, usually na.

RETURNS

The value of the argument after casting to box.

SEE ALSO

float() int() bool() color() string() line() label()

[Link]()
Clones the box object.
SYNTAX

[Link](id) → series box

ARGUMENTS

id (series box) Box object.

EXAMPLE

//@version=6
indicator('Last 50 bars price ranges', overlay = true)
LOOKBACK = 50
highest = [Link](LOOKBACK)
lowest = [Link](LOOKBACK)
if [Link]
var BoxLast = [Link](bar_index[LOOKBACK], highest, bar_index, lowest, bgcolor = [Link]([Link]
een, 80))
var BoxPrev = [Link](BoxLast)
box.set_lefttop(BoxPrev, bar_index[LOOKBACK * 2], highest[50])
box.set_rightbottom(BoxPrev, bar_index[LOOKBACK], lowest[50])
box.set_bgcolor(BoxPrev, [Link]([Link], 80))

SEE ALSO

[Link]() [Link]()

[Link]()
Deletes the specified box object. If it has already been deleted, does nothing.

ARGUMENTS

id (series box) A box object.

RETURNS

The price value.

SEE ALSO

[Link]() box.set_top()

[Link]() 2 overloads

Creates a new box object.

SYNTAX & OVERLOADS

[Link](top_left, bottom_right, border_color, border_width, border_style, extend, xloc, bgcolor, text, text
_size, text_color, text_halign, text_valign, text_wrap, text_font_family, force_overlay, text_formatting) →
series box

[Link](left, top, right, bottom, border_color, border_width, border_style, extend, xloc, bgcolor, text, te
xt_size, text_color, text_halign, text_valign, text_wrap, text_font_family, force_overlay, text_formatting)
→ series box

ARGUMENTS

top_left ([Link]) A [Link] object that specifies the top-left corner location of the box.

bottom_right ([Link]) A [Link] object that specifies the bottom-right corner location of the box.

border_color (series color) Color of the four borders. Optional. The default is [Link].
border_width (series int) Width of the four borders, in pixels. Optional. The default is 1 pixel.

border_style (series string) Style of the four borders. Possible values: line.style_solid, line.style_dotted,
line.style_dashed. Optional. The default value is line.style_solid.

extend (series string) When [Link] is used, the horizontal borders start at the left border and end at the right
border. With [Link] or [Link], the horizontal borders are extended indefinitely to the left or right of the box,
respectively. With [Link], the horizontal borders are extended on both sides. Optional. The default value is
[Link].
xloc (series string) Determines whether the arguments to 'left' and 'right' are a bar index or a time value. If xloc =
xloc.bar_index, the arguments must be a bar index. If xloc = xloc.bar_time, the arguments must be a UNIX time.
Possible values: xloc.bar_index and xloc.bar_time. Optional. The default is xloc.bar_index.

bgcolor (series color) Background color of the box. Optional. The default is [Link].
text (series string) The text to be displayed inside the box. Optional. The default is empty string.

text_size (series int/string) Optional. Size of the box's text. The size can be any positive integer, or one of the siz
e.* built-in constant strings. The constant strings and their equivalent integer values are: [Link] (0), [Link] (8),
[Link] (10), [Link] (14), [Link] (20), [Link] (36). The default value is [Link] or 0.

text_color (series color) The color of the text. Optional. The default is [Link].
text_halign (series string) The horizontal alignment of the box's text. Optional. The default value is text.align_center.
Possible values: text.align_left, text.align_center, text.align_right.
text_valign (series string) The vertical alignment of the box's text. Optional. The default value is text.align_center.
Possible values: text.align_top, text.align_center, text.align_bottom.
text_wrap (series string) Optional. Whether to wrap text. Wrapped text starts a new line when it reaches the side of
the box. Wrapped text lower than the bottom of the box is not displayed. Unwrapped text stays on a single line and is
displayed past the width of the box if it is too long. If the text_size is 0 or text.wrap_auto, this setting has no
effect. The default value is text.wrap_none. Possible values: text.wrap_none, text.wrap_auto.

text_font_family (series string) The font family of the text. Optional. The default value is font.family_default. Possible
values: font.family_default, font.family_monospace.
force_overlay (const bool) If true, the drawing will display on the main chart pane, even when the script occupies a
separate pane. Optional. The default is false.
text_formatting (const text_format) The formatting of the displayed text. Formatting options support addition. For
example, text.format_bold + text.format_italic will make the text both bold and italicized. Possible
values: text.format_none, text.format_bold, text.format_italic. Optional. The default is text.format_none.

EXAMPLE

//@version=6
indicator("[Link]")
var b = [Link](time, open, time + 60 * 60 * 24, close, xloc=xloc.bar_time, border_style=line.style_das
hed)
box.set_lefttop(b, time, 100)
box.set_rightbottom(b, time + 60 * 60 * 24, 500)
box.set_bgcolor(b, [Link])

RETURNS

The ID of a box object which may be used in box.set_*() and box.get_*() functions.
SEE ALSO

[Link]() box.get_left() box.get_top() box.get_right() box.get_bottom() box.set_top_left_point()

box.set_left() box.set_top() box.set_bottom_right_point() box.set_right() box.set_bottom() box.set_border_color()

box.set_bgcolor() box.set_border_width() box.set_border_style() box.set_extend() box.set_text()

box.set_text_formatting() box.set_xloc()

box.set_right(id, right) → void

ARGUMENTS

id (series box) A box object.

right (series int) Bar index or bar time of the right border. Note that objects positioned using xloc.bar_index cannot be
drawn further than 500 bars into the future.

SEE ALSO

SEE ALSO

[Link]() font.family_default font.family_monospace

box.set_text_formatting()
Sets the formatting attributes the drawing applies to displayed text.

SYNTAX

box.set_text_formatting(id, text_formatting) → void

ARGUMENTS

id (series box) A box object.

text_formatting (const text_format) The formatting of the displayed text. Formatting options support addition. For
example, text.format_bold + text.format_italic will make the text both bold and italicized. Possible
values: text.format_none, text.format_bold, text.format_italic. Optional. The default is text.format_none.

SEE ALSO

box.set_text_color() box.set_text_size() box.set_text_valign() box.set_text_halign() box.set_text()

box.set_text_halign()
The function sets the horizontal alignment of the box's text.

SYNTAX

box.set_text_halign(id, text_halign) → void

ARGUMENTS

id (series box) A box object.

text_halign (series string) The horizontal alignment of a box's text. Possible values: text.align_left, text.align_center,
text.align_right.

SEE ALSO

box.set_text() box.set_text_size() box.set_text_valign() box.set_text_color()

SYNTAX

box.set_top(id, top) → void

ARGUMENTS
id (series box) A box object.

top (series int/float) Price value of the top border.

SEE ALSO

[Link](id) → [Link]

ARGUMENTS

id ([Link]) A [Link] object.

[Link].from_index()
Returns a [Link] object with index as its x-coordinate and price as its y-coordinate.

SYNTAX
[Link].from_index(index, price) → [Link]

ARGUMENTS

index (series int) The x-coordinate of the point, expressed as a bar index value.
price (series int/float) The y-coordinate of the point.

REMARKS

The time field values of [Link] instances returned from this function will be na, meaning drawing objects with x
loc values set to xloc.bar_time will not work with them.

[Link].from_time()
Returns a [Link] object with time as its x-coordinate and price as its y-coordinate.

SYNTAX

[Link].from_time(time, price) → [Link]

color(x) → const color

color(x) → input color

color(x) → simple color

color(x) → series color

ARGUMENTS

x (const color) The value to convert to the specified type, usually na.

RETURNS

The value of the argument after casting to color.

SEE ALSO

float() int() bool() string() line() label()

color.b() 4 overloads

Retrieves the value of the color's blue component.

SYNTAX & OVERLOADS

color.b(color) → const float

color.b(color) → input float

color.b(color) → simple float

color.b(color) → series float

ARGUMENTS

color (const color) Color.

EXAMPLE

//@version=6
indicator("color.b", overlay=true)
plot(color.b([Link]))

RETURNS
The value (0 to 255) of the color's blue component.

color.from_gradient()
Based on the relative position of value in the bottom_value to top_value range, the function returns a color from the
gradient defined by bottom_color to top_color.

SYNTAX

color.from_gradient(value, bottom_value, top_value, bottom_color, top_color) → series color

ARGUMENTS

value (series int/float) Value to calculate the position-dependent color.

bottom_value (series int/float) Bottom position value corresponding to bottom_color.

top_value (series int/float) Top position value corresponding to top_color.

bottom_color (series color) Bottom position color.

top_color (series color) Top position color.

EXAMPLE

//@version=6
indicator("color.from_gradient", overlay=true)
color1 = color.from_gradient(close, low, high, [Link], [Link])
color2 = color.from_gradient([Link](close, 7), 0, 100, [Link](255, 0, 0), [Link](0, 255, 0, 50))
plot(close, color=color1)
plot([Link](close,7), color=color2)

RETURNS

A color calculated from the linear gradient between bottom_color to top_color.

REMARKS

Using this function will have an impact on the colors displayed in the script's "Settings/Style" tab. See the User Manual
for more information.

color.g() 4 overloads

Retrieves the value of the color's green component.

SYNTAX & OVERLOADS

color.g(color) → const float

color.g(color) → input float

color.g(color) → simple float

color.g(color) → series float

ARGUMENTS

color (const color) Color.

EXAMPLE

//@version=6
indicator("color.g", overlay=true)
plot(color.g([Link]))

RETURNS

The value (0 to 255) of the color's green component.

[Link]() 4 overloads

Function color applies the specified transparency to the given color.

SYNTAX & OVERLOADS

[Link](color, transp) → const color

[Link](color, transp) → input color

[Link](color, transp) → simple color

[Link](color, transp) → series color

ARGUMENTS

color (const color) Color to apply transparency to.

transp (const int/float) Possible values are from 0 (not transparent) to 100 (invisible).

EXAMPLE

//@version=6
indicator("[Link]", overlay=true)
plot(close, color=[Link]([Link], 50))

RETURNS

Color with specified transparency.

REMARKS

Using arguments that are not constants (e.g., 'simple', 'input' or 'series') will have an impact on the colors displayed in
the script's "Settings/Style" tab. See the User Manual for more information.

color.r() 4 overloads

Retrieves the value of the color's red component.

SYNTAX & OVERLOADS

color.r(color) → const float

color.r(color) → input float

color.r(color) → simple float

color.r(color) → series float

ARGUMENTS

color (const color) Color.

EXAMPLE

//@version=6
indicator("color.r", overlay=true)
plot(color.r([Link]))

RETURNS

The value (0 to 255) of the color's red component.

[Link]() 4 overloads

Creates a new color with transparency using the RGB color model.

SYNTAX & OVERLOADS

[Link](red, green, blue, transp) → const color

[Link](red, green, blue, transp) → input color

[Link](red, green, blue, transp) → simple color

[Link](red, green, blue, transp) → series color

ARGUMENTS

red (const int/float) Red color component. Possible values are from 0 to 255.

green (const int/float) Green color component. Possible values are from 0 to 255.
blue (const int/float) Blue color component. Possible values are from 0 to 255.

transp (const int/float) Optional. Color transparency. Possible values are from 0 (opaque) to 100 (invisible). Default
value is 0.

EXAMPLE

//@version=6
indicator("[Link]", overlay=true)
plot(close, color=[Link](255, 0, 0, 50))

RETURNS

Color with specified transparency.

REMARKS

color.t() 4 overloads

Retrieves the color's transparency.

SYNTAX & OVERLOADS

color.t(color) → const float

color.t(color) → input float

color.t(color) → simple float

color.t(color) → series float

ARGUMENTS

color (const color) Color.

EXAMPLE

//@version=6
indicator("color.t", overlay=true)
plot(color.t([Link]([Link], 50)))

RETURNS

The value (0-100) of the color's transparency.

dayofmonth()
Calculates the day number of the month, in a specified time zone, from a UNIX timestamp.

SYNTAX

dayofmonth(time, timezone) → series int

ARGUMENTS

time (series int) A UNIX timestamp in milliseconds.

timezone (series string) Optional. Specifies the time zone of the returned day number. The value can be a time zone
string in UTC/GMT offset notation (e.g., "UTC-5") or IANA time zone database notation (e.g., "America/New_York").
The default is [Link].

RETURNS

The calculated day of the month, expressed in the specified time zone.

REMARKS

A UNIX timestamp represents the number of milliseconds elapsed since 00:00 UTC on 1970-01-01. The meaning of a
UNIX timestamp does not change relative to any time zone.

SEE ALSO

dayofmonth dayofweek() weekofyear() time() year() month() hour() minute() second()

dayofweek()
Calculates the day number of the week, in a specified time zone, from a UNIX timestamp.

SYNTAX

dayofweek(time, timezone) → series int

ARGUMENTS

time (series int) A UNIX timestamp in milliseconds.

RETURNS
The calculated day number, expressed in the specified time zone.

REMARKS

A UNIX timestamp represents the number of milliseconds elapsed since 00:00 UTC on 1970-01-01. The meaning of a
UNIX timestamp does not change relative to any time zone.

SEE ALSO

dayofweek dayofmonth() weekofyear() time() year() month() hour() minute() second()

fill() 3 overloads

Fills background between two plots or hlines with a given color.

SYNTAX & OVERLOADS

fill(hline1, hline2, color, title, editable, fillgaps, display) → void

fill(plot1, plot2, color, title, editable, show_last, fillgaps, display) → void

fill(plot1, plot2, top_value, bottom_value, top_color, bottom_color, title, display, fillgaps, editable) →
void

ARGUMENTS

hline1 (hline) The first hline object. Required argument.

hline2 (hline) The second hline object. Required argument.

color (series color) Color of the background fill. You can use constants like 'color=[Link]' or 'color=#ff001a' as well
as complex expressions like 'color = close >= open ? [Link] : [Link]'. Optional argument.
title (const string) Title of the created fill object. Optional argument.

editable (input bool) If true then fill style will be editable in Format dialog. Default is true.
fillgaps (const bool) Controls continuing fills on gaps, i.e., when one of the plot() calls returns an na value. When true,
the last fill will continue on gaps. The default is false.
display (input plot_simple_display) Controls where the fill is displayed. Possible values are: [Link], [Link].
Default is [Link].
Fill between two horizontal lines

EXAMPLE

//@version=6
indicator("Fill between hlines", overlay = false)
h1 = hline(20)
h2 = hline(10)
fill(h1, h2, color = [Link]([Link], 90))

Fill between two plots

EXAMPLE

//@version=6
indicator("Fill between plots", overlay = true)
p1 = plot(open)
p2 = plot(close)
fill(p1, p2, color = [Link]([Link], 90))

Gradient fill between two horizontal lines

EXAMPLE

//@version=6
indicator("Gradient Fill between hlines", overlay = false)
topVal = [Link](100)
botVal = [Link](0)
topCol = [Link]([Link])
botCol = [Link]([Link])
topLine = hline(100, color = topCol, linestyle = hline.style_solid)
botLine = hline(0, color = botCol, linestyle = hline.style_solid)
fill(topLine, botLine, topVal, botVal, topCol, botCol)

SEE ALSO

plot() barcolor() bgcolor() hline() [Link]()

fixnan() 3 overloads

For a given series replaces NaN values with previous nearest non-NaN value.

SYNTAX & OVERLOADS

fixnan(source) → series color

fixnan(source) → series int

fixnan(source) → series float

ARGUMENTS

source (series color) Source used for the calculation.

RETURNS

Series without na gaps.

SEE ALSO

na() na nz()

float() 4 overloads

Casts na to float

SYNTAX & OVERLOADS

float(x) → const float

float(x) → input float

float(x) → simple float

float(x) → series float

If the price does not belong to any level of the footprint, the function returns na .

SYNTAX

footprint.get_row_by_price(id, price) → volume_row

ARGUMENTS

id (footprint) A footprint object.

price (series int/float) The price for which to find the corresponding footprint level.

RETURNS

hline()
Renders a horizontal line at a given fixed price level.

SYNTAX

hline(price, title, color, linestyle, linewidth, editable, display) → hline

ARGUMENTS

price (input int/float) Price value at which the object will be rendered. Required argument.

title (const string) Title of the object.

color (input color) Color of the rendered line. Must be a constant value (not an expression). Optional argument.

linestyle (input hline_style) Style of the rendered line. Possible values are: hline.style_solid, hline.style_dotted,
hline.style_dashed. Optional argument.

linewidth (input int) Width of the rendered line. Default value is 1.

editable (input bool) If true then hline style will be editable in Format dialog. Default is true.

display (input plot_simple_display) Controls where the hline is displayed. Possible values are: [Link],
[Link]. Default is [Link].

EXAMPLE

//@version=6
indicator("[Link]", overlay=true)
hline(3.14, title='Pi', color=[Link], linestyle=hline.style_dotted, linewidth=2)

// You may fill the background between any two hlines with a fill() function:
h1 = hline(20)
h2 = hline(10)
fill(h1, h2, color=[Link]([Link], 90))

RETURNS

An hline object, that can be used in fill()

SEE ALSO

fill()

hour()

SYNTAX

hour(time, timezone) → series int

ARGUMENTS

time (series int) UNIX time in milliseconds.

timezone (series string) Allows adjusting the returned value to a time zone specified in either UTC/GMT notation
(e.g., "UTC-5", "GMT+0530") or as an IANA time zone database name (e.g., "America/New_York"). Optional. The
default is [Link].

RETURNS

Hour (in exchange timezone) for provided UNIX time.

REMARKS

UNIX time is the number of milliseconds that have elapsed since 00:00:00 UTC, 1 January 1970.

SEE ALSO

hour time() year() month() dayofmonth() dayofweek() minute() second()

indicator()
A declaration statement that identifies the script as an indicator and sets specific script-wide properties.

SYNTAX

indicator(title, shorttitle, overlay, format, precision, scale, max_bars_back, timeframe, timeframe_gaps, e

xplicit_plot_zorder, max_lines_count, max_labels_count, max_boxes_count, calc_bars_count, max_polylines_cou
nt, dynamic_requests, behind_chart) → void

ARGUMENTS

title (const string) A string representing the script's title. The script displays the string's text in all possible locations if
the declaration statement does not include a shorttitle argument. Additionally, the "Publish script" window uses
the text as the default title for a script publication.

shorttitle (const string) Optional. A string representing the script's display name on charts. If specified and not an
empty string, the value's text replaces the title string in most chart locations, including the "Settings" window, the
script's status line, the Data Window, and the "Create alert" dialog box. Otherwise, the title string appears as the
script's title in all locations. The default is an empty string.
overlay (const bool) Optional. If true , the script's visuals appear on the main chart pane if the user adds it to the
chart directly, or in another script's pane if the user applies it to that script. If false , the script's visuals appear in a
separate pane. However, if a function call that creates visuals includes force_overlay = true , its output always
appears on the main chart pane, even if the script occupies a separate pane. Changes to this argument apply only
after the user adds the script to the chart again. Additionally, if the user moves the script to another pane by selecting
a "Move to" option in the script's "More" menu, the script does not move back to its original pane after any updates to
the source code. The default is false .

format (const string) Optional. Specifies the format of the script's plotted values. Possible values are [Link],
[Link], [Link], and [Link]. The default is [Link].

precision (const int) Optional. Specifies the number of fractional digits that the script shows for plotted numbers. The
value must be an integer from 0 to 16. If specified and the format argument is [Link], the script uses
[Link] as the formatting option instead. If the format argument is {[Link]}, the script ignores the pre
cision value, because the decimal precision rules specified by [Link] supersede other precision settings. By
default, the script inherits the precision settings of the chart.

scale (const scale_type) Optional. Specifies the location of the script's price scale. Possible values are [Link] for
the right side of the pane, [Link] for the left side of the pane, or [Link] to use the pane's default scale. The
[Link] argument is allowed only if the overlay value is true . If the script overlays on the main chart pane and
uses [Link] or [Link], it adds a separate scale to the pane. Changes to the argument apply only after the user
adds the script to the chart again. If not specified, the script uses the pane's default scale.
max_bars_back (const int) Optional. Sets the minimum length of all the script's historical buffers, which determine
the number of bars back that the script can reference for each series using the [] operator or the functions that
retrieve history internally. The value must be an integer from 0 to 5000. By default, Pine's runtime system
automatically calculates appropriate historical buffer sizes for each series while loading a script. Manually setting
buffer sizes is necessary only in rare cases where automatic size detection fails. See the Historical buffers section of
our User Manual for advanced details.

timeframe (const string) Optional. A valid timeframe string that determines the main timeframe the script uses for its
calculations. If specified, the script automatically adds a "Timeframe" input to the "Settings/Inputs" tab. The input's
displayed default in the tab represents the same timeframe as the specified argument. If the value is an empty string or
not specified, the script uses the same timeframe as the chart. An argument is allowed for this parameter only if the
script does not use drawing types or alert() function calls.

timeframe_gaps (const bool) Optional. Controls how the script displays plotted values if the timeframe value
represents a higher timeframe than the chart's timeframe. An argument for this parameter is allowed only if the call
includes a timeframe argument. If specified, the script adds a "Wait for timeframe closes" input, where users can
change the setting, below the generated "Timeframe" input in the "Settings/Inputs" tab. If true , the indicator
displays values only on the chart bars where new higher-timeframe data is available, and na on all other bars. If fals
e , the indicator displays the last retrieved values on all chart bars where new data is not available. The default is tru
e.

explicit_plot_zorder (const bool) Optional. Specifies which rules the script uses to determine the visual order of
plots from plot*() calls, levels from hline() calls, and fills from fill() calls on the chart. If true , the indicator
displays these visuals in the order of their function calls in the code. If false , the script uses the default z-index
rules to determine the order of the visuals. The default is false .

max_lines_count (const int) Optional. Determines the maximum number of line objects that remain available to the
script. The system automatically deletes the oldest line objects when the number of lines exceeds the limit. The limit
specified by the argument is approximate; the script might display more drawings than specified. The default is ~50
lines.

max_labels_count (const int) Optional. Determines the maximum number of label objects that remain available to the
script. The system automatically deletes the oldest label objects when the number of labels exceeds the limit. The limit
specified by the argument is approximate; the script might display more drawings than specified. The default is ~50
labels.

max_boxes_count (const int) Optional. Determines the maximum number of box objects that remain available to the
script. The system automatically deletes the oldest box objects when the number of boxes exceeds the limit. The limit
specified by the argument is approximate; the script might display more drawings than specified. The default is ~50
boxes.
calc_bars_count (const int) Optional. Determines how many of the most recent historical bars are available to the
script. If specified, the script automatically adds a "Calculated bars" input to the "Settings/Inputs" tab. If the value is
positive and less than the number of historical bars in the dataset, the script starts its calculations that number of bars
before the most recent bar. If the value is 0, the script's calculations start on the dataset's first bar. The default is 0.
max_polylines_count (const int) Optional. Determines the maximum number of polyline objects that remain available
to the script. The system automatically deletes the oldest polyline objects when the number of polylines exceeds the
limit. The limit specified by the argument is approximate; the script might display more drawings than specified. The
default is ~50 polylines.

dynamic_requests (const bool) Optional. Specifies whether the script can use dynamic request.*() function
calls. Dynamic request.*() calls are allowed within the local scopes of conditional structures (e.g., if), loops (e.g.,
for), and exported functions. Additionally, such calls allow "series" arguments for several parameters that otherwise
require values with "simple" or weaker qualifiers. See the Dynamic requests section of our User Manual for more
information. The default is true .

behind_chart (const bool) Optional. Controls whether all plots and drawings appear behind the chart display (if tru
e ) or in front of it (if false ). This parameter takes effect only when the overlay argument is true . Changes to
the argument apply only after the user adds the script to the chart again. The default is true .

EXAMPLE

//@version=6
indicator("My script", shorttitle="Script")
plot(close)

REMARKS

Every indicator script must include exactly one indicator() statement in the code.

SEE ALSO

strategy() library()

input() 6 overloads

Adds an input to the Inputs tab of your script's Settings, which allows you to provide configuration options to script
users. This function automatically detects the type of the argument used for 'defval' and uses the corresponding input
widget.

SYNTAX & OVERLOADS

input(defval, title, tooltip, inline, group, display, active) → input color

input(defval, title, tooltip, inline, group, display, active) → input string

input(defval, title, tooltip, inline, group, display, active) → input int

input(defval, title, tooltip, inline, group, display, active) → input float

input(defval, title, inline, group, tooltip, display, active) → series float

input(defval, title, tooltip, inline, group, display, active) → input bool

ARGUMENTS

defval (const int/float/bool/string/color or source-type built-ins) Determines the default value of the input variable
proposed in the script's "Settings/Inputs" tab, from where script users can change it. Source-type built-ins are built-in
series float variables that specify the source of the calculation: close , hlc3 , etc.

title (const string) Title of the input. If not specified, the variable name is used as the input's title. If the title is
specified, but it is empty, the name will be an empty string.

group (const string) Creates a header above all inputs using the same group argument string. The string is also used
as the header's text.

active (input bool) Optional. Specifies whether users can change the value of the input in the script's
"Settings/Inputs" tab. The script can use this parameter to set the state of the input based on the values of other
inputs. If true, users can change the value of the input. If false, the input is grayed out, and users cannot change the
value. The default is true.

EXAMPLE

//@version=6
indicator("input", overlay=true)
i_switch = input(true, "On/Off")
plot(i_switch ? open : na)

i_len = input(7, "Length")

i_src = input(close, "Source")
plot([Link](i_src, i_len))

i_border = input(142.50, "Price Border")

hline(i_border)
bgcolor(close > i_border ? [Link] : [Link])

i_col = input([Link], "Plot Color")

plot(close, color=i_col)

i_text = input("Hello!", "Message")

l = [Link](bar_index, high, text=i_text)
[Link](l[1])

RETURNS

Value of input variable.

REMARKS

Result of input() function always should be assigned to a variable, see examples above.

SEE ALSO

[Link]() [Link]() [Link]() [Link]() [Link]() [Link]() [Link]()

input.text_area() [Link]() [Link]() [Link]()

[Link]()
Adds an input to the Inputs tab of your script's Settings, which allows you to provide configuration options to script
users. This function adds a checkmark to the script's inputs.

SYNTAX

[Link](defval, title, tooltip, inline, group, confirm, display, active) → input bool

ARGUMENTS

defval (const bool) Determines the default value of the input variable proposed in the script's "Settings/Inputs" tab,
from where the user can change it.
title (const string) Title of the input. If not specified, the variable name is used as the input's title. If the title is
specified, but it is empty, the name will be an empty string.
tooltip (const string) The string that will be shown to the user when hovering over the tooltip icon.

inline (const string) Combines all the input calls using the same argument in one line. The string used as an argument
is not displayed. It is only used to identify inputs belonging to the same line.

group (const string) Creates a header above all inputs using the same group argument string. The string is also used
as the header's text.

EXAMPLE

//@version=6
indicator("[Link]", overlay=true)
i_switch = [Link](true, "On/Off")
plot(i_switch ? open : na)

RETURNS

Value of input variable.

REMARKS

Result of [Link]() function always should be assigned to a variable, see examples above.

SEE ALSO

[Link]() [Link]() [Link]() input.text_area() [Link]() [Link]() [Link]()

[Link]() [Link]() [Link]() input()

[Link]()
Adds an input to the Inputs tab of your script's Settings, which allows you to provide configuration options to script
users. This function adds a color picker that allows the user to select a color and transparency, either from a palette or
a hex value.

SYNTAX

[Link](defval, title, tooltip, inline, group, confirm, display, active) → input color

ARGUMENTS

defval (const color) Determines the default value of the input variable proposed in the script's "Settings/Inputs" tab,
from where the user can change it.
title (const string) Title of the input. If not specified, the variable name is used as the input's title. If the title is
specified, but it is empty, the name will be an empty string.
tooltip (const string) The string that will be shown to the user when hovering over the tooltip icon.

inline (const string) Combines all the input calls using the same argument in one line. The string used as an argument
is not displayed. It is only used to identify inputs belonging to the same line.

group (const string) Creates a header above all inputs using the same group argument string. The string is also used
as the header's text.

confirm (const bool) If true, then user will be asked to confirm input value before indicator is added to chart. Default
value is false.

display (const plot_display) Controls where the script will display the input's information, aside from within the
script's settings. This option allows one to remove a specific input from the script's status line or the Data Window to
ensure only the most necessary inputs are displayed there. Possible values: [Link], display.data_window,
display.status_line, [Link]. Optional. The default is [Link].
active (input bool) Optional. Specifies whether users can change the value of the input in the script's
"Settings/Inputs" tab. The script can use this parameter to set the state of the input based on the values of other
inputs. If true, users can change the value of the input. If false, the input is grayed out, and users cannot change the
value. The default is true.
EXAMPLE

//@version=6
indicator("[Link]", overlay=true)
i_col = [Link]([Link], "Plot Color")
plot(close, color=i_col)

RETURNS

Value of input variable.

REMARKS

Result of [Link]() function always should be assigned to a variable, see examples above.

SEE ALSO

[Link]() [Link]() [Link]() [Link]() input.text_area() [Link]() [Link]()

[Link]() [Link]() [Link]() input()

[Link]()
Adds an input to the Inputs tab of your script's Settings, which allows you to provide configuration options to script
users. This function adds a dropdown with options based on the enum fields passed to its defval and options
parameters.

The text for each option in the resulting dropdown corresponds to the titles of the included fields. If a field's title is not
specified in the enum declaration, its title is the string representation of its name.

SYNTAX

[Link](defval, title, options, tooltip, inline, group, confirm, display, active) → input enum

ARGUMENTS

defval (const enum) Determines the default value of the input, which users can change in the script's
"Settings/Inputs" tab. When the options parameter has a specified tuple of enum fields, the tuple must include the
defval .

title (const string) Title of the input. If not specified, the variable name is used as the input's title. If the title is
specified, but it is empty, the name will be an empty string.

options (tuple of enum fields: [enumName.field1, enumName.field2, ...]) A list of options to choose from.
Optional. By default, the titles of all of the enum's fields are available in the dropdown. Passing a tuple as the option
s argument limits the list to only the included fields.

//@version=6
indicator("Session highlight", overlay = true)

//@enum Contains fields with popular timezones as titles.

//@field exch Has an empty string as the title to represent the chart timezone.
enum tz
utc = "UTC"
exch = ""
ny = "America/New_York"
chi = "America/Chicago"
lon = "Europe/London"
tok = "Asia/Tokyo"

//@variable The session string.

selectedSession = [Link]("1200-1500", "Session")
//@variable The selected timezone. The input's dropdown contains the fields in the `tz` enum.
selectedTimezone = [Link]([Link], "Session Timezone")

//@variable Is `true` if the current bar's time is in the specified session.

bool inSession = false
if not na(time("", selectedSession, [Link](selectedTimezone)))
inSession := true

// Highlight the background when `inSession` is `true`.

bgcolor(inSession ? [Link]([Link], 90) : na, title = "Active session highlight")

RETURNS

Value of input variable.

REMARKS

All fields included in the defval and options arguments must belong to the same enum.

SEE ALSO

input.text_area() [Link]() [Link]() [Link]() [Link]() [Link]() [Link]()

[Link]() [Link]() [Link]() input()

[Link]() 2 overloads

Adds an input to the Inputs tab of your script's Settings, which allows you to provide configuration options to script
users. This function adds a field for a float input to the script's inputs.

SYNTAX & OVERLOADS

[Link](defval, title, options, tooltip, inline, group, confirm, display, active) → input float

[Link](defval, title, minval, maxval, step, tooltip, inline, group, confirm, display, active) → input
float

ARGUMENTS

defval (const int/float) Determines the default value of the input variable proposed in the script's "Settings/Inputs"
tab, from where script users can change it. When a list of values is used with the options parameter, the value must
be one of them.

title (const string) Title of the input. If not specified, the variable name is used as the input's title. If the title is
specified, but it is empty, the name will be an empty string.
options (tuple of const int/float values: [val1, val2, ...]) A list of options to choose from a dropdown menu,
separated by commas and enclosed in square brackets: [val1, val2, ...]. When using this parameter, the minval , ma
xval and step parameters cannot be used.

group (const string) Creates a header above all inputs using the same group argument string. The string is also used
as the header's text.

confirm (const bool) If true, then user will be asked to confirm input value before indicator is added to chart. Default
value is false.

EXAMPLE

//@version=6
indicator("[Link]", overlay=true)
i_angle1 = [Link](0.5, "Sin Angle", minval=-3.14, maxval=3.14, step=0.02)
plot([Link](i_angle1) > 0 ? close : open, "sin", color=[Link])

i_angle2 = [Link](0, "Cos Angle", options=[-3.14, -1.57, 0, 1.57, 3.14])

plot([Link](i_angle2) > 0 ? close : open, "cos", color=[Link])

RETURNS

Value of input variable.

REMARKS

Result of [Link]() function always should be assigned to a variable, see examples above.

SEE ALSO

[Link]() [Link]() [Link]() input.text_area() [Link]() [Link]() [Link]()

[Link]() [Link]() [Link]() input()

[Link]() 2 overloads

Adds an input to the Inputs tab of your script's Settings, which allows you to provide configuration options to script
users. This function adds a field for an integer input to the script's inputs.

SYNTAX & OVERLOADS

[Link](defval, title, options, tooltip, inline, group, confirm, display, active) → input int

[Link](defval, title, minval, maxval, step, tooltip, inline, group, confirm, display, active) → input in
t

ARGUMENTS

defval (const int) Determines the default value of the input variable proposed in the script's "Settings/Inputs" tab,
from where script users can change it. When a list of values is used with the options parameter, the value must be
one of them.

title (const string) Title of the input. If not specified, the variable name is used as the input's title. If the title is
specified, but it is empty, the name will be an empty string.

options (tuple of const int values: [val1, val2, ...]) A list of options to choose from a dropdown menu, separated by
commas and enclosed in square brackets: [val1, val2, ...]. When using this parameter, the minval , maxval and s
tep parameters cannot be used.

tooltip (const string) The string that will be shown to the user when hovering over the tooltip icon.

inline (const string) Combines all the input calls using the same argument in one line. The string used as an argument
is not displayed. It is only used to identify inputs belonging to the same line.
group (const string) Creates a header above all inputs using the same group argument string. The string is also used
as the header's text.
confirm (const bool) If true, then user will be asked to confirm input value before indicator is added to chart. Default
value is false.
display (const plot_display) Controls where the script will display the input's information, aside from within the
script's settings. This option allows one to remove a specific input from the script's status line or the Data Window to
ensure only the most necessary inputs are displayed there. Possible values: [Link], display.data_window,
display.status_line, [Link]. Optional. The default is [Link].
active (input bool) Optional. Specifies whether users can change the value of the input in the script's
"Settings/Inputs" tab. The script can use this parameter to set the state of the input based on the values of other
inputs. If true, users can change the value of the input. If false, the input is grayed out, and users cannot change the
value. The default is true.

EXAMPLE

//@version=6
indicator("[Link]", overlay=true)
i_len1 = [Link](10, "Length 1", minval=5, maxval=21, step=1)
plot([Link](close, i_len1))

i_len2 = [Link](10, "Length 2", options=[5, 10, 21])

plot([Link](close, i_len2))

RETURNS

Value of input variable.

REMARKS

Result of [Link]() function always should be assigned to a variable, see examples above.

SEE ALSO

[Link]() [Link]() [Link]() input.text_area() [Link]() [Link]() [Link]()

[Link]() [Link]() [Link]() input()

[Link]()
Adds a price input to the script's "Settings/Inputs" tab. The user can change the price in the settings or by selecting
the indicator and dragging the price line.

SYNTAX

[Link](defval, title, tooltip, inline, group, confirm, display, active) → input float

ARGUMENTS

defval (const int/float) Determines the default value of the input variable proposed in the script's "Settings/Inputs"
tab, from where the user can change it.
title (const string) Title of the input. If not specified, the variable name is used as the input's title. If the title is
specified, but it is empty, the name will be an empty string.
tooltip (const string) The string that will be shown to the user when hovering over the tooltip icon.
inline (const string) Combines all the input calls using the same argument in one line. The string used as an argument
is not displayed. It is only used to identify inputs belonging to the same line.
group (const string) Creates a header above all inputs using the same group argument string. The string is also used
as the header's text.

confirm (const bool) Optional. If true, the script prompts the user to set the input's initial value by clicking a point on
the chart. If inputs of other types require confirmation, the "Confirm inputs" dialog box also displays this input's field,
allowing final adjustments to the value before the script starts to run. The default is false.
display (const plot_display) Controls where the script will display the input's information, aside from within the
script's settings. This option allows one to remove a specific input from the script's status line or the Data Window to
ensure only the most necessary inputs are displayed there. Possible values: [Link], display.data_window,
display.status_line, [Link]. Optional. The default is [Link].
active (input bool) Optional. Specifies whether users can change the value of the input in the script's
"Settings/Inputs" tab. The script can use this parameter to set the state of the input based on the values of other
inputs. If true, users can change the value of the input. If false, the input is grayed out, and users cannot change the
value. The default is true.

EXAMPLE

//@version=6
indicator("[Link]", overlay=true)
price1 = [Link](title="Date", defval=42)
plot(price1)

price2 = [Link](54, title="Date")

plot(price2)

RETURNS

Value of input variable.

REMARKS

If an [Link]() and [Link]() function call in the script share a unique inline argument and have matching gr
oup arguments, those calls create a single interactive point marker on the chart. The user can move that marker to
adjust the input time and price values simultaneously.

SEE ALSO

[Link]() [Link]() [Link]() [Link]() input.text_area() [Link]() [Link]()

[Link]() [Link]() [Link]() input()

[Link]()
Adds an input to the Inputs tab of your script's Settings, which allows you to provide configuration options to script
users. This function adds two dropdowns that allow the user to specify the beginning and the end of a session using
the session selector and returns the result as a string.

SYNTAX

[Link](defval, title, options, tooltip, inline, group, confirm, display, active) → input string

ARGUMENTS

title (const string) Title of the input. If not specified, the variable name is used as the input's title. If the title is
specified, but it is empty, the name will be an empty string.
options (tuple of const string values: [val1, val2, ...]) A list of options to choose from.
tooltip (const string) The string that will be shown to the user when hovering over the tooltip icon.

inline (const string) Combines all the input calls using the same argument in one line. The string used as an argument
is not displayed. It is only used to identify inputs belonging to the same line.

group (const string) Creates a header above all inputs using the same group argument string. The string is also used
as the header's text.

confirm (const bool) If true, then user will be asked to confirm input value before indicator is added to chart. Default
value is false.
display (const plot_display) Controls where the script will display the input's information, aside from within the
script's settings. This option allows one to remove a specific input from the script's status line or the Data Window to
ensure only the most necessary inputs are displayed there. Possible values: [Link], display.data_window,
display.status_line, [Link]. Optional. The default is [Link].
active (input bool) Optional. Specifies whether users can change the value of the input in the script's
"Settings/Inputs" tab. The script can use this parameter to set the state of the input based on the values of other
inputs. If true, users can change the value of the input. If false, the input is grayed out, and users cannot change the
value. The default is true.

EXAMPLE

//@version=6
indicator("[Link]", overlay=true)
i_sess = [Link]("1300-1700", "Session", options=["0930-1600", "1300-1700", "1700-2100"])
t = time([Link], i_sess)
bgcolor(time == t ? [Link] : na)

RETURNS

Value of input variable.

REMARKS

Result of [Link]() function always should be assigned to a variable, see examples above.

SEE ALSO

[Link]() [Link]() [Link]() [Link]() input.text_area() [Link]() [Link]()

[Link]() [Link]() [Link]() input()

[Link]()
Adds an input to the Inputs tab of your script's Settings, which allows you to provide configuration options to script
users. This function adds a dropdown that allows the user to select a source for the calculation, e.g. close, hl2, etc.
The user can also select an output from another indicator on their chart as the source.

SYNTAX

[Link](defval, title, tooltip, inline, group, display, active, confirm) → series float

ARGUMENTS

defval (open/high/low/close/hl2/hlc3/ohlc4/hlcc4) Determines the default value of the input variable proposed in
the script's "Settings/Inputs" tab, from where the user can change it.
title (const string) Title of the input. If not specified, the variable name is used as the input's title. If the title is
specified, but it is empty, the name will be an empty string.
tooltip (const string) The string that will be shown to the user when hovering over the tooltip icon.

confirm (const bool) If true, then user will be asked to confirm input value before indicator is added to chart. Default
value is false.

EXAMPLE

//@version=6
indicator("[Link]", overlay=true)
i_src = [Link](close, "Source")
plot(i_src)

RETURNS

Value of input variable.

REMARKS

Result of [Link]() function always should be assigned to a variable, see examples above.

SEE ALSO

[Link]() [Link]() [Link]() [Link]() input.text_area() [Link]() [Link]()

[Link]() [Link]() [Link]() input()

[Link]()
Adds an input to the Inputs tab of your script's Settings, which allows you to provide configuration options to script
users. This function adds a field for a string input to the script's inputs.

SYNTAX

[Link](defval, title, options, tooltip, inline, group, confirm, display, active) → input string

ARGUMENTS

defval (const string) Determines the default value of the input variable proposed in the script's "Settings/Inputs" tab,
from where the user can change it. When a list of values is used with the options parameter, the value must be one
of them.
title (const string) Title of the input. If not specified, the variable name is used as the input's title. If the title is
specified, but it is empty, the name will be an empty string.
options (tuple of const string values: [val1, val2, ...]) A list of options to choose from.

EXAMPLE

//@version=6
indicator("[Link]", overlay=true)
i_text = [Link]("Hello!", "Message")
l = [Link](bar_index, high, i_text)
[Link](l[1])

RETURNS

Value of input variable.

REMARKS

Result of [Link]() function always should be assigned to a variable, see examples above.

SEE ALSO

input.text_area() [Link]() [Link]() [Link]() [Link]() [Link]() [Link]()

[Link]() [Link]() [Link]() input()

[Link]()
Adds an input to the Inputs tab of your script's Settings, which allows you to provide configuration options to script
users. This function adds a field that allows the user to select a specific symbol using the symbol search and returns
that symbol, paired with its exchange prefix, as a string.

SYNTAX

[Link](defval, title, tooltip, inline, group, confirm, display, active) → input string

ARGUMENTS

defval (const string) Determines the default value of the input variable proposed in the script's "Settings/Inputs" tab,
from where the user can change it.

title (const string) Title of the input. If not specified, the variable name is used as the input's title. If the title is
specified, but it is empty, the name will be an empty string.

tooltip (const string) The string that will be shown to the user when hovering over the tooltip icon.
inline (const string) Combines all the input calls using the same argument in one line. The string used as an argument
is not displayed. It is only used to identify inputs belonging to the same line.
group (const string) Creates a header above all inputs using the same group argument string. The string is also used
as the header's text.
confirm (const bool) If true, then user will be asked to confirm input value before indicator is added to chart. Default
value is false.
display (const plot_display) Controls where the script will display the input's information, aside from within the
script's settings. This option allows one to remove a specific input from the script's status line or the Data Window to
ensure only the most necessary inputs are displayed there. Possible values: [Link], display.data_window,
display.status_line, [Link]. Optional. The default is [Link].

//@version=6
indicator("[Link]", overlay=true)
i_sym = [Link]("DELL", "Symbol")
s = [Link](i_sym, 'D', close)
plot(s)

RETURNS

Value of input variable.

REMARKS

Result of [Link]() function always should be assigned to a variable, see examples above.

SEE ALSO

[Link]() [Link]() [Link]() [Link]() input.text_area() [Link]() [Link]()

[Link]() [Link]() [Link]() input()

input.text_area()
Adds an input to the Inputs tab of your script's Settings, which allows you to provide configuration options to script
users. This function adds a field for a multiline text input.

SYNTAX

input.text_area(defval, title, tooltip, group, confirm, display, active) → input string

ARGUMENTS

defval (const string) Determines the default value of the input variable proposed in the script's "Settings/Inputs" tab,
from where the user can change it.

title (const string) Title of the input. If not specified, the variable name is used as the input's title. If the title is
specified, but it is empty, the name will be an empty string.

tooltip (const string) The string that will be shown to the user when hovering over the tooltip icon.
group (const string) Creates a header above all inputs using the same group argument string. The string is also used
as the header's text.
confirm (const bool) If true, then user will be asked to confirm input value before indicator is added to chart. Default
value is false.
display (const plot_display) Controls where the script will display the input's information, aside from within the
script's settings. This option allows one to remove a specific input from the script's status line or the Data Window to
ensure only the most necessary inputs are displayed there. Possible values: [Link], display.data_window,
display.status_line, [Link]. Optional. The default is [Link].

EXAMPLE

//@version=6
indicator("input.text_area")
i_text = input.text_area(defval = "Hello \nWorld!", title = "Message")
plot(close)

RETURNS

Value of input variable.

REMARKS

Result of input.text_area() function always should be assigned to a variable, see examples above.

SEE ALSO

[Link]() [Link]() [Link]() [Link]() [Link]() [Link]() [Link]()

[Link]() [Link]() [Link]() input()

[Link]()
Adds two inputs to the script's "Settings/Inputs" tab on the same line: one for the date and one for the time. The user
can change the price in the settings or by selecting the indicator and dragging the price line. The function returns a
date/time value in UNIX format.

SYNTAX

[Link](defval, title, tooltip, inline, group, confirm, display, active) → input int

ARGUMENTS

defval (const int) Determines the default value of the input variable proposed in the script's "Settings/Inputs" tab,
from where the user can change it. The value can be a timestamp() function, but only if it uses a date argument in
const string format.
title (const string) Title of the input. If not specified, the variable name is used as the input's title. If the title is
specified, but it is empty, the name will be an empty string.
tooltip (const string) The string that will be shown to the user when hovering over the tooltip icon.

inline (const string) Combines all the input calls using the same argument in one line. The string used as an argument
is not displayed. It is only used to identify inputs belonging to the same line.

group (const string) Creates a header above all inputs using the same group argument string. The string is also used
as the header's text.

EXAMPLE

//@version=6
indicator("[Link]", overlay=true)
i_date = [Link](timestamp("20 Jul 2021 00:00 +0300"), "Date")
l = [Link](i_date, high, "Date", xloc=xloc.bar_time)
[Link](l[1])

RETURNS

Value of input variable.

REMARKS

The user can change the input's value by specifying a new value in the "Settings/Inputs" tab, or by moving the input's
marker on the chart. Alternatively, they can select "Reset points" from the script's "More" menu and set a new input
value by clicking a point on the chart.
If an [Link]() and [Link]() function call in the script share a unique inline argument and have matching gr
oup arguments, those calls create a single interactive point marker on the chart. The user can move that marker to
adjust the input time and price values simultaneously.

SEE ALSO

[Link]() [Link]() [Link]() [Link]() input.text_area() [Link]() [Link]()

[Link]() [Link]() [Link]() input()

[Link]()
Adds an input to the Inputs tab of your script's Settings, which allows you to provide configuration options to script
users. This function adds a dropdown that allows the user to select a specific timeframe via the timeframe selector and
returns it as a string. The selector includes the custom timeframes a user may have added using the chart's Timeframe
dropdown.

SYNTAX

[Link](defval, title, options, tooltip, inline, group, confirm, display, active) → input string

ARGUMENTS

title (const string) Title of the input. If not specified, the variable name is used as the input's title. If the title is
specified, but it is empty, the name will be an empty string.

options (tuple of const string values: [val1, val2, ...]) A list of options to choose from.
tooltip (const string) The string that will be shown to the user when hovering over the tooltip icon.

inline (const string) Combines all the input calls using the same argument in one line. The string used as an argument
is not displayed. It is only used to identify inputs belonging to the same line.

group (const string) Creates a header above all inputs using the same group argument string. The string is also used
as the header's text.

confirm (const bool) If true, then user will be asked to confirm input value before indicator is added to chart. Default
value is false.

EXAMPLE

//@version=6
indicator("[Link]", overlay=true)
i_res = [Link]('D', "Resolution", options=['D', 'W', 'M'])
s = [Link]("AAPL", i_res, close)
plot(s)

RETURNS

Value of input variable.

REMARKS
Result of [Link]() function always should be assigned to a variable, see examples above.

SEE ALSO

[Link]() [Link]() [Link]() [Link]() input.text_area() [Link]() [Link]()

[Link]() [Link]() [Link]() input()

int() 4 overloads

Casts na or truncates float value to int

SYNTAX & OVERLOADS

int(x) → const int

int(x) → input int

int(x) → simple int

int(x) → series int

ARGUMENTS

x (const int/float) The value to convert to the specified type, usually na.

RETURNS

The value of the argument after casting to int.

SEE ALSO

float() bool() color() string() line() label()

label()
Casts na to label

SYNTAX

label(x) → series label

ARGUMENTS

x (series label) The value to convert to the specified type, usually na.

RETURNS

The value of the argument after casting to label.

SEE ALSO

float() int() bool() color() string() line()

[Link]()
Clones the label object.

SYNTAX

[Link](id) → series label

ARGUMENTS

id (series label) Label object.

EXAMPLE

//@version=6
indicator('Last 100 bars highest/lowest', overlay = true)
LOOKBACK = 100
highest = [Link](LOOKBACK)
highestBars = [Link](LOOKBACK)
lowest = [Link](LOOKBACK)
lowestBars = [Link](LOOKBACK)
if [Link]
var labelHigh = [Link](bar_index + highestBars, highest, [Link](highest), color = [Link]
een)
var labelLow = [Link](labelHigh)
label.set_xy(labelLow, bar_index + lowestBars, lowest)
label.set_text(labelLow, [Link](lowest))
label.set_color(labelLow, [Link])
label.set_style(labelLow, label.style_label_up)

RETURNS

New label ID object which may be passed to [Link] and [Link] functions.

SEE ALSO

[Link]() [Link]()

[Link]()
Deletes the specified label object. If it has already been deleted, does nothing.

SYNTAX

[Link](id) → void

ARGUMENTS

id (series label) Label object to delete.

SEE ALSO

[Link]()

label.get_text()
Returns the text of this label object.

SYNTAX

label.get_text(id) → series string

ARGUMENTS

id (series label) Label object.

EXAMPLE

//@version=6
indicator("label.get_text")
my_label = [Link](time, open, text="Open bar text", xloc=xloc.bar_time)
a = label.get_text(my_label)
[Link](time, close, text = a + " new", xloc=xloc.bar_time)
RETURNS

String object containing the text of this label.

SEE ALSO

[Link]()

label.get_x()
Returns UNIX time or bar index (depending on the last xloc value set) of this label's position.

SYNTAX

label.get_x(id) → series int

ARGUMENTS

id (series label) Label object.

EXAMPLE

//@version=6
indicator("label.get_x")
my_label = [Link](time, open, text="Open bar text", xloc=xloc.bar_time)
a = label.get_x(my_label)
plot(time - label.get_x(my_label)) //draws zero plot

RETURNS

UNIX timestamp (in milliseconds) or bar index.

SEE ALSO

[Link]()

label.get_y()
Returns price of this label's position.

SYNTAX

label.get_y(id) → series float

ARGUMENTS

id (series label) Label object.

RETURNS

Floating point value representing price.

SEE ALSO

[Link]()

[Link]() 2 overloads

Creates new label object.

SYNTAX & OVERLOADS

[Link](point, text, xloc, yloc, color, style, textcolor, size, textalign, tooltip, text_font_family, for
ce_overlay, text_formatting) → series label
[Link](x, y, text, xloc, yloc, color, style, textcolor, size, textalign, tooltip, text_font_family, forc
e_overlay, text_formatting) → series label

ARGUMENTS

point ([Link]) A [Link] object that specifies the label's location.

text (series string) Label text. Default is empty string.

xloc (series string) See description of x argument. Possible values: xloc.bar_index and xloc.bar_time. Default is
xloc.bar_index.
yloc (series string) Possible values are [Link], [Link], [Link]. If yloc=[Link], y argument
specifies the price of the label position. If yloc=[Link], label is located above bar. If yloc=[Link], label is
located below bar. Default is [Link].

color (series color) Color of the label border and arrow

style (series string) Label style. Possible values: label.style_none, label.style_xcross, label.style_cross,
label.style_triangleup, label.style_triangledown, label.style_flag, label.style_circle, label.style_arrowup,
label.style_arrowdown, label.style_label_up, label.style_label_down, label.style_label_left, label.style_label_right,
label.style_label_lower_left, label.style_label_lower_right, label.style_label_upper_left, label.style_label_upper_right,
label.style_label_center, label.style_square, label.style_diamond, label.style_text_outline. Default is
label.style_label_down.

textcolor (series color) Text color.

size (series int/string) Optional. Size of the label. Accepts a positive int value or one of the built-in size.*
constants. The constants and their equivalent numeric sizes are: [Link] (0), [Link] (~7), [Link] (~10),
[Link] (12), [Link] (18), [Link] (24). The default value is [Link], which represents the numeric size of
12.
textalign (series string) Label text alignment. Possible values: text.align_left, text.align_center, text.align_right.
Default value is text.align_center.
tooltip (series string) Hover to see tooltip label.

text_font_family (series string) The font family of the text. Optional. The default value is font.family_default. Possible
values: font.family_default, font.family_monospace.

force_overlay (const bool) If true, the drawing will display on the main chart pane, even when the script occupies a
separate pane. Optional. The default is false.

EXAMPLE

//@version=6
indicator("[Link]")
var label1 = [Link](bar_index, low, text="Hello, world!", style=label.style_circle)
label.set_x(label1, 0)
label.set_xloc(label1, time, xloc.bar_time)
label.set_color(label1, [Link])
label.set_size(label1, [Link])

RETURNS

Label ID object which may be passed to [Link] and [Link] functions.

SEE ALSO

[Link]() label.set_x() label.set_y() label.set_xy() label.set_xloc() label.set_yloc() label.set_color()

label.set_textcolor() label.set_style() label.set_size() label.set_textalign() label.set_tooltip() label.set_text()

label.set_text_formatting()
label.set_color()
Sets label border and arrow color.

SYNTAX

label.set_color(id, color) → void

ARGUMENTS

id (series label) Label object.

color (series color) New label border and arrow color.

SEE ALSO

[Link]()

label.set_point()
Sets the location of the id label to point .

SYNTAX

label.set_point(id, point) → void

ARGUMENTS

id (series label) A label object.

//@version=6
indicator("Example of setting the label font")
if [Link]
l = [Link](bar_index, 0, "monospace", yloc=[Link])
label.set_text_font_family(l, font.family_monospace)

SEE ALSO

[Link]() font.family_default font.family_monospace

label.set_text_formatting()
Sets the formatting attributes the drawing applies to displayed text.

SYNTAX

label.set_text_formatting(id, text_formatting) → void

ARGUMENTS

id (series label) Label object.

SEE ALSO

[Link]()
label.set_x()
Sets bar index or bar time (depending on the xloc) of the label position.

SYNTAX

label.set_x(id, x) → void

ARGUMENTS

id (series label) Label object.

x (series int) New bar index or bar time of the label position. Note that objects positioned using xloc.bar_index cannot
be drawn further than 500 bars into the future.

SEE ALSO

[Link]()

label.set_xloc()
Sets x-location and new bar index/time value.

SYNTAX

label.set_xloc(id, x, xloc) → void

ARGUMENTS

id (series label) Label object.

x (series int) New bar index or bar time of the label position.
xloc (series string) New x-location value.

SEE ALSO

xloc.bar_index xloc.bar_time [Link]()

label.set_xy()
Sets bar index/time and price of the label position.

SYNTAX

label.set_xy(id, x, y) → void

ARGUMENTS

id (series label) Label object.

x (series int) New bar index or bar time of the label position. Note that objects positioned using xloc.bar_index cannot
be drawn further than 500 bars into the future.

y (series int/float) New price of the label position.

SEE ALSO

[Link]()

label.set_y()
Sets price of the label position

SYNTAX
label.set_y(id, y) → void

ARGUMENTS

id (series label) Label object.

y (series int/float) New price of the label position.

SEE ALSO

[Link]()

label.set_yloc()
Sets new y-location calculation algorithm.

SYNTAX

label.set_yloc(id, yloc) → void

ARGUMENTS

id (series label) Label object.

yloc (series string) New y-location value.

SEE ALSO

[Link] [Link] [Link] [Link]()

library()
Declaration statement identifying a script as a library.

SYNTAX

library(title, overlay, dynamic_requests) → void

ARGUMENTS

title (const string) The title of the library and its identifier. It cannot contain spaces, special characters or begin with a
digit. It is used as the publication's default title, and to uniquely identify the library in the import statement, when
another script uses it. It is also used as the script's name on the chart.
overlay (const bool) If true, the script's visuals appear on the main chart pane if the user adds it to the chart directly,
or in another script's pane if the user applies it to that script. If false, the script's visuals appear in a separate pane.
Changes to the overlay value apply only after the user adds the script to the chart again. Additionally, if the user
moves the script to another pane by selecting a "Move to" option in the script's "More" menu, it does not move back
to its original pane after any updates to the source code. The default is false. Strategy-specific labels that display
entries and exits will be displayed over the main chart regardless of this setting.
dynamic_requests (const bool) Specifies whether the script can dynamically call functions from the request.*()
namespace. Dynamic request.*() calls are allowed within the local scopes of conditional structures (e.g., if), loops
(e.g., for), and exported functions. Additionally, such calls allow "series" arguments for many of their parameters.
Optional. The default is true. See the User Manual's Dynamic requests section for more information.

EXAMPLE

//@version=6
// @description Math library
library("num_methods", overlay = true)
// Calculate "sinh()" from the float parameter `x`
export sinh(float x) =>
([Link](x) - [Link](-x)) / 2.0
plot(sinh(0))
SEE ALSO

indicator() strategy()

line()
Casts na to line

SYNTAX

line(x) → series line

ARGUMENTS

x (series line) The value to convert to the specified type, usually na.

RETURNS

The value of the argument after casting to line.

SEE ALSO

float() int() bool() color() string() label()

[Link]()
Clones the line object.

SYNTAX

[Link](id) → series line

ARGUMENTS

id (series line) Line object.

EXAMPLE

//@version=6
indicator('Last 100 bars price range', overlay = true)
LOOKBACK = 100
highest = [Link](LOOKBACK)
lowest = [Link](LOOKBACK)
if [Link]
var lineTop = [Link](bar_index[LOOKBACK], highest, bar_index, highest, color = [Link])
var lineBottom = [Link](lineTop)
line.set_y1(lineBottom, lowest)
line.set_y2(lineBottom, lowest)
line.set_color(lineBottom, [Link])

RETURNS

New line ID object which may be passed to [Link] and [Link] functions.

SEE ALSO

[Link]() [Link]()

[Link]()
Deletes the specified line object. If it has already been deleted, does nothing.

SYNTAX
[Link](id) → void

ARGUMENTS

id (series line) Line object to delete.

SEE ALSO

[Link]()

line.get_price()
Returns the price level of a line at a given bar index.

SYNTAX

line.get_price(id, x) → series float

ARGUMENTS

id (series line) Line object.

x (series int) Bar index for which price is required.

EXAMPLE

//@version=6
indicator("GetPrice", overlay=true)
var line l = na
if bar_index == 10
l := [Link](0, high[5], bar_index, high)
plot(line.get_price(l, bar_index), color=[Link])

RETURNS

Price value of line 'id' at bar index 'x'.

REMARKS

The line is considered to have been created using 'extend=[Link]'.

This function can only be called for lines created using 'xloc.bar_index'. If you try to call it for a line created with
'xloc.bar_time', it will generate an error.

SEE ALSO

[Link]()

line.get_x1()
Returns UNIX time or bar index (depending on the last xloc value set) of the first point of the line.

SYNTAX

line.get_x1(id) → series int

ARGUMENTS

id (series line) Line object.

EXAMPLE

//@version=6
indicator("line.get_x1")
my_line = [Link](time, open, time + 60 * 60 * 24, close, xloc=xloc.bar_time)
a = line.get_x1(my_line)
plot(time - line.get_x1(my_line)) //draws zero plot

RETURNS

Price value.
SEE ALSO

[Link]()

[Link]() 2 overloads

Creates new line object.

SYNTAX & OVERLOADS

[Link](first_point, second_point, xloc, extend, color, style, width, force_overlay) → series line

[Link](x1, y1, x2, y2, xloc, extend, color, style, width, force_overlay) → series line

ARGUMENTS

first_point ([Link]) A [Link] object that specifies the line's starting coordinate.
second_point ([Link]) A [Link] object that specifies the line's ending coordinate.

xloc (series string) See description of x1 argument. Possible values: xloc.bar_index and xloc.bar_time. Default is
xloc.bar_index.

extend (series string) If extend=[Link], draws segment starting at point (x1, y1) and ending at point (x2, y2). If
extend is equal to [Link] or [Link], draws a ray starting at point (x1, y1) or (x2, y2), respectively. If
extend=[Link], draws a straight line that goes through these points. Default value is [Link].
color (series color) Line color.

style (series string) Line style. Possible values: line.style_solid, line.style_dotted, line.style_dashed,
line.style_arrow_left, line.style_arrow_right, line.style_arrow_both.

width (series int) Line width in pixels.

force_overlay (const bool) If true, the drawing will display on the main chart pane, even when the script occupies a
separate pane. Optional. The default is false.

EXAMPLE

//@version=6
indicator("[Link]")
var line1 = [Link](0, low, bar_index, high, extend=[Link])
var line2 = [Link](time, open, time + 60 * 60 * 24, close, xloc=xloc.bar_time, style=line.style_dashe
d)
line.set_x2(line1, 0)
line.set_xloc(line1, time, time + 60 * 60 * 24, xloc.bar_time)
line.set_color(line2, [Link])
line.set_width(line2, 5)

RETURNS

Line ID object which may be passed to [Link] and [Link] functions.

SEE ALSO

[Link]() line.set_x1() line.set_y1() line.set_xy1() line.set_x2() line.set_y2() line.set_xy2() line.set_xloc()

line.set_color() line.set_extend() line.set_style() line.set_width()

line.set_color()
Sets the line color

SYNTAX

line.set_color(id, color) → void

ARGUMENTS

id (series line) Line object.

color (series color) New line color

SEE ALSO

[Link]()

line.set_extend()
Sets extending type of this line object. If extend=[Link], draws segment starting at point (x1, y1) and ending at
point (x2, y2). If extend is equal to [Link] or [Link], draws a ray starting at point (x1, y1) or (x2, y2),
respectively. If extend=[Link], draws a straight line that goes through these points.

SYNTAX

line.set_extend(id, extend) → void

ARGUMENTS

id (series line) Line object.

extend (series string) New extending type.

SEE ALSO

style (series string) New line style.

SEE ALSO

line.style_solid line.style_dotted line.style_dashed line.style_arrow_left line.style_arrow_right line.style_arrow_both

[Link]()

line.set_width()
Sets the line width.

SYNTAX

line.set_width(id, width) → void

ARGUMENTS

id (series line) Line object.

width (series int) New line width in pixels.

SEE ALSO

[Link]()

line.set_x1()
Sets bar index or bar time (depending on the xloc) of the first point.

SYNTAX

line.set_x1(id, x) → void

ARGUMENTS

id (series line) Line object.

x (series int) Bar index or bar time. Note that objects positioned using xloc.bar_index cannot be drawn further than
500 bars into the future.

SEE ALSO

[Link]()

line.set_x2()
Sets bar index or bar time (depending on the xloc) of the second point.

SYNTAX

line.set_x2(id, x) → void

ARGUMENTS

id (series line) Line object.

x (series int) Bar index or bar time. Note that objects positioned using xloc.bar_index cannot be drawn further than
500 bars into the future.

line.set_xloc(id, x1, x2, xloc) → void

ARGUMENTS

id (series line) Line object.

x1 (series int) Bar index or bar time of the first point.

x2 (series int) Bar index or bar time of the second point.

xloc (series string) New x-location value.

SEE ALSO

xloc.bar_index xloc.bar_time [Link]()

line.set_xy1()
Sets bar index/time and price of the first point.

SYNTAX

line.set_xy1(id, x, y) → void

ARGUMENTS

id (series line) Line object.

x (series int) Bar index or bar time. Note that objects positioned using xloc.bar_index cannot be drawn further than
500 bars into the future.

y (series int/float) Price.

SEE ALSO

[Link]()

line.set_xy2()
Sets bar index/time and price of the second point

SYNTAX

line.set_xy2(id, x, y) → void

ARGUMENTS

id (series line) Line object.

x (series int) Bar index or bar time.

ARGUMENTS

x (series linefill) The value to convert to the specified type, usually na.

RETURNS

The value of the argument after casting to linefill.

SEE ALSO

float() int() bool() color() string() line() label()

[Link]()
Deletes the specified linefill object. If it has already been deleted, does nothing.

SYNTAX

ARGUMENTS

line1 (series line) First line object.

line2 (series line) Second line object.

color (series color) The color used to fill the space between the lines.

RETURNS

The ID of a linefill object that can be passed to other linefill.*() functions.

REMARKS

If any line of the two is deleted, the linefill object is also deleted. If the lines are moved (e.g. via line.set_xy() functions),
the linefill object is also moved.

If both lines are extended in the same direction relative to the lines themselves (e.g. both have [Link] as the
value of their extend= parameter), the space between line extensions will also be filled.

linefill.set_color()
The function sets the color of the linefill object passed to it.

SYNTAX

linefill.set_color(id, color) → void

ARGUMENTS

id (series linefill) A linefill object.

color (series color) The color of the linefill object.

[Link]() 2 overloads

Converts the formatting string and value(s) into a formatted string, and sends the result to the "Pine logs" menu
tagged with the "error" debug level.

The formatting string can contain literal text and one placeholder in curly braces {} for each value to be formatted.
Each placeholder consists of the index of the required argument (beginning at 0) that will replace it, and an optional
format specifier. The index represents the position of that argument in the function's argument list.

SYNTAX & OVERLOADS

[Link](message) → void

[Link](formatString, arg0, arg1, ...) → void

ARGUMENTS

message (series string) Log message.

EXAMPLE

//@version=6
strategy("My strategy", overlay = true, process_orders_on_close = true)
bracketTickSizeInput = [Link](1000, "Stoploss/Take-Profit distance (in ticks)")

longCondition = [Link]([Link](close, 14), [Link](close, 28))

if (longCondition)
limitLevel = close * 1.01
[Link]("Long limit order has been placed at {0}", limitLevel)
[Link]("My Long Entry Id", [Link], limit = limitLevel)

[Link]("Exit orders have been placed: Take-profit at {0}, Stop-loss at {1}", close, limitLevel)
[Link]("Exit", "My Long Entry Id", profit = bracketTickSizeInput, loss = bracketTickSizeInpu
t)

if [Link] > 10
[Link]("{0} positions opened in the same direction in a row. Try adjusting `bracketTickSizeInp
ut`", [Link])

last10Perc = strategy.initial_capital / 10 > [Link]

if (last10Perc and not last10Perc[1])
[Link]("The strategy has lost 90% of the initial capital!")

RETURNS

The formatted string.

REMARKS

Any curly braces within an unquoted pattern must be balanced. For example, "ab {0} de" and "ab '}' de" are valid
patterns, but "ab {0'}' de", "ab } de" and "''{''" are not.
The function can apply additional formatting to some values inside of the {} . The list of additional formatting options
can be found in the EXAMPLE section of the [Link]() article.

The string used as the formatString argument can contain single quote characters ('). However, one must pair all
single quotes in that string to avoid unexpected formatting results.
The "Pine logs..." button is accessible from the "More" dropdown in the Pine Editor and from the "More" dropdown in
the status line of any script that uses log.*() functions.

[Link]() 2 overloads
Converts the formatting string and value(s) into a formatted string, and sends the result to the "Pine logs" menu
tagged with the "info" debug level.

SYNTAX & OVERLOADS

[Link](message) → void

[Link](formatString, arg0, arg1, ...) → void

ARGUMENTS

message (series string) Log message.

EXAMPLE

//@version=6
strategy("My strategy", overlay = true, process_orders_on_close = true)
bracketTickSizeInput = [Link](1000, "Stoploss/Take-Profit distance (in ticks)")

longCondition = [Link]([Link](close, 14), [Link](close, 28))

if (longCondition)
limitLevel = close * 1.01
[Link]("Long limit order has been placed at {0}", limitLevel)
[Link]("My Long Entry Id", [Link], limit = limitLevel)

[Link]("Exit orders have been placed: Take-profit at {0}, Stop-loss at {1}", close, limitLevel)
[Link]("Exit", "My Long Entry Id", profit = bracketTickSizeInput, loss = bracketTickSizeInpu
t)

if [Link] > 10
[Link]("{0} positions opened in the same direction in a row. Try adjusting `bracketTickSizeInp
ut`", [Link])

last10Perc = strategy.initial_capital / 10 > [Link]

if (last10Perc and not last10Perc[1])
[Link]("The strategy has lost 90% of the initial capital!")

RETURNS

The formatted string.

REMARKS

[Link]() 2 overloads

Converts the formatting string and value(s) into a formatted string, and sends the result to the "Pine logs" menu
tagged with the "warning" debug level.
The formatting string can contain literal text and one placeholder in curly braces {} for each value to be formatted.
Each placeholder consists of the index of the required argument (beginning at 0) that will replace it, and an optional
format specifier. The index represents the position of that argument in the function's argument list.
SYNTAX & OVERLOADS

[Link](message) → void

[Link](formatString, arg0, arg1, ...) → void

ARGUMENTS

message (series string) Log message.

EXAMPLE

//@version=6
strategy("My strategy", overlay = true, process_orders_on_close = true)
bracketTickSizeInput = [Link](1000, "Stoploss/Take-Profit distance (in ticks)")

longCondition = [Link]([Link](close, 14), [Link](close, 28))

if (longCondition)
limitLevel = close * 1.01
[Link]("Long limit order has been placed at {0}", limitLevel)
[Link]("My Long Entry Id", [Link], limit = limitLevel)

[Link]("Exit orders have been placed: Take-profit at {0}, Stop-loss at {1}", close, limitLevel)
[Link]("Exit", "My Long Entry Id", profit = bracketTickSizeInput, loss = bracketTickSizeInpu
t)

if [Link] > 10
[Link]("{0} positions opened in the same direction in a row. Try adjusting `bracketTickSizeInp
ut`", [Link])

last10Perc = strategy.initial_capital / 10 > [Link]

if (last10Perc and not last10Perc[1])
[Link]("The strategy has lost 90% of the initial capital!")

RETURNS

The formatted string.

REMARKS

Any curly braces within an unquoted pattern must be balanced. For example, "ab {0} de" and "ab '}' de" are valid
patterns, but "ab {0'}' de", "ab } de" and "''{''" are not.

The function can apply additional formatting to some values inside of the {} . The list of additional formatting options
can be found in the EXAMPLE section of the [Link]() article.
The string used as the formatString argument can contain single quote characters ('). However, one must pair all
single quotes in that string to avoid unexpected formatting results.

The "Pine logs..." button is accessible from the "More" dropdown in the Pine Editor and from the "More" dropdown in
the status line of any script that uses log.*() functions.

[Link]()
Clears the map, removing all key-value pairs from it.

SYNTAX

[Link](id) → void

ARGUMENTS

id (any map type) A map object.

//@version=6
indicator("[Link]<string, int> example")
a = [Link]<string, int>()
[Link]("example", 1)
[Link](bar_index, close, [Link]([Link]("example")))

RETURNS

The ID of a map object which may be used in other map.*() functions.

REMARKS

Each key is unique and can only appear once. When adding a new value with a key that the map already contains, that
value replaces the old value associated with the key.

Maps maintain insertion order. Note that the order does not change when inserting a pair with a key that's already in
the map. The new pair replaces the existing pair with the key in such cases.

SEE ALSO

[Link]() [Link]() [Link]() [Link]() [Link]<type>()

[Link]()
Puts a new key-value pair into the id map.

SYNTAX

[Link](id, key, value) → <value_type>

ARGUMENTS

id (any map type) A map object.

key (series <type of the map's elements>) The key to put into the map.
value (series <type of the map's elements>) The key value to put into the map.

EXAMPLE

//@version=6
indicator("[Link] example")
a = [Link]<string, float>()
[Link](a, "first", 10)
[Link](a, "second", 15)
prevFirst = [Link](a, "first", 20)
currFirst = [Link]("first")
plot(prevFirst)
plot(currFirst)

RETURNS

The previous value associated with key if the key was already present in the map, or na if the key is new.

REMARKS

Maps maintain insertion order. Note that the order does not change when inserting a pair with a key that's already in
the map. The new pair replaces the existing pair with the key in such cases.

SEE ALSO

[Link]<type,type>() map.put_all() [Link]() [Link]() [Link]()

map.put_all()
Puts all key-value pairs from the id2 map into the id map.

SYNTAX

map.put_all(id, id2) → void

ARGUMENTS

id (any map type) A map object to append to.

id2 (any map type) A map object to be appended.

EXAMPLE

//@version=6
indicator("map.put_all example")
a = [Link]<string, float>()
b = [Link]<string, float>()
[Link]("first", 10)
[Link]("second", 15)
[Link]("third", 20)
map.put_all(a, b)
plot([Link]("third"))

SEE ALSO

[Link]<type,type>() [Link]() [Link]() [Link]() [Link]()

[Link]()
Removes a key-value pair from the id map.

SYNTAX

[Link](id, key) → <value_type>

ARGUMENTS

id (any map type) A map object.

key (series <type of the map's elements>) The key of the pair to remove from the map.

EXAMPLE
//@version=6
indicator("[Link] example")
a = [Link]<string, color>()
[Link]("firstColor", [Link])
oldColorValue = [Link](a, "firstColor")
plot(close, color = oldColorValue)

RETURNS

The previous value associated with key if the key was present in the map, or na if there was no such key.

SEE ALSO

[Link]<type,type>() [Link]() [Link]() [Link]() [Link]()

[Link]()
Returns the number of key-value pairs in the id map.

SYNTAX

[Link](id) → series int

ARGUMENTS

id (any map type) A map object.

EXAMPLE

//@version=6
indicator("[Link] example")
a = [Link]<int, int>()
size = 10
for i = 0 to size
[Link](i, size-i)
plot([Link](a))

SEE ALSO

[Link]<type,type>() [Link]() [Link]() [Link]() [Link]()

[Link]()
Returns an array of all the values in the id map. The resulting array is a copy and any changes to it are not reflected
in the original map.

SYNTAX

[Link](id) → array<type>

ARGUMENTS

id (any map type) A map object.

EXAMPLE

//@version=6
indicator("[Link] example")
a = [Link]<string, float>()
[Link]("open", open)
[Link]("high", high)
[Link]("low", low)
[Link]("close", close)
values = [Link](a)
ohlc = 0.0
for value in values
ohlc += value
plot(ohlc/4)

REMARKS

Maps maintain insertion order. The elements within the array returned by this function will also be in the insertion
order.

SEE ALSO

[Link]<type,type>() [Link]() [Link]() [Link]() [Link]()

[Link]() 8 overloads

Absolute value of number is number if number >= 0, or - number otherwise.

SYNTAX & OVERLOADS

[Link](number) → const int

[Link](number) → input int

[Link](number) → const float

[Link](number) → simple int

[Link](number) → input float

[Link](number) → series int

[Link](number) → simple float

[Link](number) → series float

ARGUMENTS

number (const int) The number to use in the calculation.

RETURNS

The absolute value of number .

[Link]() 2 overloads

Calculates average of all given series (elementwise).

SYNTAX & OVERLOADS

[Link](number0, number1, ...) → simple float

[Link](number0, number1, ...) → series float

ARGUMENTS

number0, number1, ... (simple int/float) A sequence of numbers to use in the calculation.

RETURNS

Average.

SEE ALSO

[Link]() [Link]() [Link]()

[Link]() 4 overloads

Rounds the specified number up to the smallest whole number ("int" value) that is greater than or equal to it.

SYNTAX & OVERLOADS

[Link](number) → const int

[Link](number) → input int

[Link](number) → simple int

[Link](number) → series int

ARGUMENTS

number (const int/float) The number to round.

RETURNS

The smallest "int" value that is greater than or equal to the number .

SEE ALSO

[Link]() [Link]()

[Link]() 4 overloads

The cos function returns the trigonometric cosine of an angle.

SYNTAX & OVERLOADS

[Link](angle) → const float

[Link](angle) → input float

[Link](angle) → simple float

[Link](angle) → series float

ARGUMENTS

angle (const int/float) Angle, in radians.

RETURNS

The trigonometric cosine of an angle.

[Link]() 4 overloads

The exp function of number is e raised to the power of number , where e is Euler's number.

SYNTAX & OVERLOADS

[Link](number) → const float

[Link](number) → input float

[Link](number) → simple float

[Link](number) → series float

ARGUMENTS

number (const int/float) The number to use in the calculation.

RETURNS

A value representing e raised to the power of number .

SEE ALSO

[Link]()

[Link]() 4 overloads

Rounds the specified number down to the largest whole number ("int" value) that is less than or equal to it.

SYNTAX & OVERLOADS

[Link](number) → const int

[Link](number) → input int

[Link](number) → simple int

[Link](number) → series int

ARGUMENTS

number (const int/float) The number to round.

RETURNS

The largest "int" value that is less than or equal to the number .

SEE ALSO

[Link]() [Link]()

[Link]() 4 overloads

Natural logarithm of any number > 0 is the unique y such that e^y = number .
SYNTAX & OVERLOADS

[Link](number) → const float

[Link](number) → input float

[Link](number) → simple float

[Link](number) → series float

ARGUMENTS

number (const int/float) The number to use in the calculation.

RETURNS

The natural logarithm of number .

SEE ALSO

math.log10()

math.log10() 4 overloads

The common (or base 10) logarithm of number is the power to which 10 must be raised to obtain the number .
10^y = number .

SYNTAX & OVERLOADS

math.log10(number) → const float

math.log10(number) → input float

math.log10(number) → simple float

math.log10(number) → series float

ARGUMENTS

number (const int/float) The number to use in the calculation.

RETURNS

The base 10 logarithm of number .

SEE ALSO

[Link]()

[Link]() 8 overloads

Returns the greatest of multiple values.

SYNTAX & OVERLOADS

[Link](number0, number1, ...) → const int

[Link](number0, number1, ...) → const float

[Link](number0, number1, ...) → input int

[Link](number0, number1, ...) → simple int

[Link](number0, number1, ...) → input float

[Link](number0, number1, ...) → series int

[Link](number0, number1, ...) → simple float

[Link](number0, number1, ...) → series float

ARGUMENTS

number0, number1, ... (const int) A sequence of numbers to use in the calculation.

EXAMPLE

//@version=6
indicator("[Link]", overlay=true)
plot([Link](close, open))
plot([Link](close, [Link](open, 42)))

RETURNS

The greatest of multiple given values.

SEE ALSO

[Link]()

[Link]() 8 overloads

Returns the smallest of multiple values.

SYNTAX & OVERLOADS

[Link](number0, number1, ...) → const int

[Link](number0, number1, ...) → const float

[Link](number0, number1, ...) → input int

[Link](number0, number1, ...) → simple int

[Link](number0, number1, ...) → input float

[Link](number0, number1, ...) → series int

[Link](number0, number1, ...) → simple float

[Link](number0, number1, ...) → series float

ARGUMENTS
number0, number1, ... (const int) A sequence of numbers to use in the calculation.

EXAMPLE

//@version=6
indicator("[Link]", overlay=true)
plot([Link](close, open))
plot([Link](close, [Link](open, 42)))

RETURNS

The smallest of multiple given values.

SEE ALSO

[Link]()

[Link]() 4 overloads

Mathematical power function.

SYNTAX & OVERLOADS

[Link](base, exponent) → const float

[Link](base, exponent) → input float

[Link](base, exponent) → simple float

[Link](base, exponent) → series float

ARGUMENTS

base (const int/float) Specify the base to use.

exponent (const int/float) Specifies the exponent.

EXAMPLE

//@version=6
indicator("[Link]", overlay=true)
plot([Link](close, 2))

RETURNS

base raised to the power of exponent . If base is a series, it is calculated elementwise.

SEE ALSO

[Link]() [Link]()

[Link]()
Returns a pseudo-random value. The function will generate a different sequence of values for each script execution.
Using the same value for the optional seed argument will produce a repeatable sequence.

SYNTAX

[Link](min, max, seed) → series float

ARGUMENTS

min (series int/float) The lower bound of the range of random values. The value is not included in the range. The
default is 0.

max (series int/float) The upper bound of the range of random values. The value is not included in the range. The
default is 1.

seed (series int) Optional argument. When the same seed is used, allows successive calls to the function to produce
a repeatable set of values.

RETURNS

A random value.

[Link]() 8 overloads

Returns the value of number rounded to the nearest integer, with ties rounding up. If the precision parameter is
used, returns a float value rounded to that amount of decimal places.

SYNTAX & OVERLOADS

[Link](number) → const int

[Link](number) → input int

[Link](number) → simple int

[Link](number) → series int

[Link](number, precision) → const float

[Link](number, precision) → input float

[Link](number, precision) → simple float

[Link](number, precision) → series float

ARGUMENTS

number (const int/float) The value to be rounded.

RETURNS

The value of number rounded to the nearest integer, or according to precision.

REMARKS

Note that for 'na' values function returns 'na'.

SEE ALSO

[Link]() [Link]()

math.round_to_mintick() 2 overloads

Returns the value rounded to the symbol's mintick, i.e. the nearest value that can be divided by [Link],
without the remainder, with ties rounding up.

SYNTAX & OVERLOADS

math.round_to_mintick(number) → simple float

math.round_to_mintick(number) → series float

ARGUMENTS

number (simple int/float) The value to be rounded.

RETURNS

The number rounded to tick precision.

REMARKS

Note that for 'na' values function returns 'na'.

SEE ALSO

[Link]() [Link]()

[Link]() 4 overloads

Sign (signum) of number is zero if number is zero, 1.0 if number is greater than zero, -1.0 if number is less
than zero.

SYNTAX & OVERLOADS

[Link](number) → const float

[Link](number) → input float

[Link](number) → simple float

[Link](number) → series float

ARGUMENTS

number (const int/float) The number to use in the calculation.

RETURNS

The sign of the argument.

[Link]() 4 overloads

The sin function returns the trigonometric sine of an angle.

SYNTAX & OVERLOADS

[Link](angle) → const float

[Link](angle) → input float

[Link](angle) → simple float

[Link](angle) → series float

ARGUMENTS
angle (const int/float) Angle, in radians.

RETURNS

The trigonometric sine of an angle.

[Link]() 4 overloads

Square root of any number >= 0 is the unique y >= 0 such that y^2 = number .

SYNTAX & OVERLOADS

[Link](number) → const float

[Link](number) → input float

[Link](number) → simple float

[Link](number) → series float

ARGUMENTS

number (const int/float) The number to use in the calculation.

RETURNS

The square root of number .

SEE ALSO

[Link]()

[Link]()
The sum function returns the sliding sum of last y values of x.

SYNTAX

[Link](source, length) → series float

ARGUMENTS

source (series int/float) Series of values to process.

length (series int) Number of bars (length).

RETURNS

Sum of source for length bars back.

REMARKS

na values in the source series are ignored; the function calculates on the length quantity of non- na values.

SEE ALSO

[Link]() for

[Link]() 4 overloads

The tan function returns the trigonometric tangent of an angle.

SYNTAX & OVERLOADS

[Link](angle) → const float

[Link](angle) → input float

SYNTAX

matrix.add_col(id, column, array_id) → void

ARGUMENTS

id (any matrix type) The matrix object's ID (reference).

column (series int) Optional. The index of the new column. Must be a value from 0 to [Link](id) . All
existing columns with indices that are greater than or equal to this value increase their index by one. The default is ma
[Link](id) .

array_id (any array type) Optional. The ID of an array to use as the new column. If the matrix is empty, the array can
be of any size. Otherwise, its size must equal [Link](id) . By default, the function inserts a column of na
values.

Adding a column to the matrix

EXAMPLE

//@version=6
indicator("`matrix.add_col()` Example 1")

// Create a 2x3 "int" matrix containing values `0`.

m = [Link]<int>(2, 3, 0)

// Add a column with `na` values to the matrix.

matrix.add_col(m)

// Display matrix elements.

if [Link]
var t = [Link](position.top_right, 2, 2, [Link])
[Link](t, 0, 0, "Matrix elements:")
[Link](t, 0, 1, [Link](m))

Adding an array as a column to the matrix

EXAMPLE

//@version=6
indicator("`matrix.add_col()` Example 2")

if [Link]
// Create an empty matrix object.
var m = [Link]<int>()

// Create an array with values `1` and `3`.

var a = [Link](1, 3)

// Add the `a` array as the first column of the empty matrix.
matrix.add_col(m, 0, a)

// Display matrix elements.

var t = [Link](position.top_right, 2, 2, [Link])
[Link](t, 0, 0, "Matrix elements:")
[Link](t, 0, 1, [Link](m))

REMARKS

Rather than add columns to an empty matrix, it is far more efficient to declare a matrix with explicit dimensions and fill
it with values. Adding a column is also much slower than adding a row with the matrix.add_row() function.

SEE ALSO

[Link]<type>() [Link]() [Link]() [Link]() [Link]() matrix.add_row()

matrix.add_row()
Inserts a new row at the row index of the id matrix.

SYNTAX

matrix.add_row(id, row, array_id) → void

ARGUMENTS

id (any matrix type) The matrix object's ID (reference).

row (series int) Optional. The index of the new row. Must be a value from 0 to [Link](id) . All existing rows
with indices that are greater than or equal to this value increase their index by one. The default is [Link](i
d) .

array_id (any array type) Optional. The ID of an array to use as the new row. If the matrix is empty, the array can be of
any size. Otherwise, its size must equal [Link](id) . By default, the function inserts a row of na values.

Adding a row to the matrix

EXAMPLE

//@version=6
indicator("`matrix.add_row()` Example 1")

// Create a 2x3 "int" matrix containing values `0`.

m = [Link]<int>(2, 3, 0)

// Add a row with `na` values to the matrix.

matrix.add_row(m)

// Display matrix elements.

if [Link]
var t = [Link](position.top_right, 2, 2, [Link])
[Link](t, 0, 0, "Matrix elements:")
[Link](t, 0, 1, [Link](m))

Adding an array as a row to the matrix

EXAMPLE

//@version=6
indicator("`matrix.add_row()` Example 2")

if [Link]
// Create an empty matrix object.
var m = [Link]<int>()

// Create an array with values `1` and `2`.

var a = [Link](1, 2)

// Add the `a` array as the first row of the empty matrix.
matrix.add_row(m, 0, a)

// Display matrix elements.

var t = [Link](position.top_right, 2, 2, [Link])
[Link](t, 0, 0, "Matrix elements:")
[Link](t, 0, 1, [Link](m))

REMARKS

Indexing of rows and columns starts at zero. Rather than add rows to an empty matrix, it is far more efficient to declare
a matrix with explicit dimensions and fill it with values.

SEE ALSO

[Link]<type>() [Link]() [Link]() [Link]() [Link]() matrix.add_col()

[Link]() 2 overloads

The function calculates the average of all elements in the matrix.

SYNTAX & OVERLOADS

[Link](id) → series float

[Link](id) → series int

ARGUMENTS

id (matrix<int/float>) A matrix object.

EXAMPLE

//@version=6
indicator("`[Link]()` Example")

// Create a 2x2 matrix.

var m = [Link]<int>(2, 2, na)
// Fill the matrix with values.
[Link](m, 0, 0, 1)
[Link](m, 0, 1, 2)
[Link](m, 1, 0, 3)
[Link](m, 1, 1, 4)

// Get the average value of the matrix.

var x = [Link](m)

plot(x, 'Matrix average value')

RETURNS

The average value from the id matrix.

SEE ALSO

[Link]<type>() [Link]() [Link]() [Link]() [Link]()

[Link]()
The function creates a one-dimensional array from the elements of a matrix column.

SYNTAX

[Link](id, column) → array<type>

ARGUMENTS

id (any matrix type) A matrix object.

column (series int) Index of the required column.

EXAMPLE

//@version=6
indicator("`[Link]()` Example", "", true)

// Create a 2x3 "float" matrix from `hlc3` values.

m = [Link]<float>(2, 3, hlc3)

// Return an array with the values of the first column of matrix `m`.
a = [Link](m, 0)

// Plot the first value from the array `a`.

plot([Link](a, 0))

RETURNS

An array ID containing the column values of the id matrix.

REMARKS

Indexing of rows starts at 0.

SEE ALSO

[Link]<type>() [Link]() [Link]() [Link]() [Link]()

[Link]()
The function returns the number of columns in the matrix.

SYNTAX

[Link](id) → series int

ARGUMENTS

id (any matrix type) A matrix object.

EXAMPLE

//@version=6
indicator("`[Link]()` Example")

// Create a 2x6 matrix with values `0`.

var m = [Link]<int>(2, 6, 0)

// Get the quantity of columns in matrix `m`.

var x = [Link](m)

// Display using a label.

if [Link]
[Link](bar_index, high, "Columns: " + [Link](x) + "\n" + [Link](m))

RETURNS

The number of columns in the matrix id .

SEE ALSO

[Link]<type>() [Link]() [Link]() [Link]() [Link]() [Link]()

[Link]()
The function appends the m2 matrix to the m1 matrix.

SYNTAX

[Link](id1, id2) → matrix<type>

ARGUMENTS

id1 (any matrix type) Matrix object to concatenate into.

id2 (any matrix type) Matrix object whose elements will be appended to id1 .

EXAMPLE

//@version=6
indicator("`[Link]()` Example")

// Create a 2x4 "int" matrix containing values `0`.

m1 = [Link]<int>(2, 4, 0)
// Create a 2x4 "int" matrix containing values `1`.
m2 = [Link]<int>(2, 4, 1)

// Append matrix `m2` to `m1`.

[Link](m1, m2)

// Display matrix elements.

if [Link]
var t = [Link](position.top_right, 2, 2, [Link])
[Link](t, 0, 0, "Matrix Elements:")
[Link](t, 0, 1, [Link](m1))
RETURNS

Returns the id1 matrix concatenated with the id2 matrix.

REMARKS

The number of columns in both matrices must be identical.

SEE ALSO

[Link]<type>() [Link]() [Link]() [Link]() [Link]()

[Link]()
The function creates a new matrix which is a copy of the original.

SYNTAX

[Link](id) → matrix<type>

ARGUMENTS

id (any matrix type) A matrix object to copy.

EXAMPLE

//@version=6
indicator("`[Link]()` Example")

// For efficiency, execute this code only once.

if [Link]
// Create a 2x3 "float" matrix with `1` values.
var m1 = [Link]<float>(2, 3, 1)

// Copy the matrix to a new one.

// Note that unlike what `[Link]()` does,
// the simple assignment operation `m2 = m1`
// would NOT create a new copy of the `m1` matrix.
// It would merely create a copy of its ID referencing the same matrix.
var m2 = [Link](m1)

// Display using a table.

var t = [Link](position.top_right, 5, 2, [Link])
[Link](t, 0, 0, "Original Matrix:")
[Link](t, 0, 1, [Link](m1))
[Link](t, 1, 0, "Matrix Copy:")
[Link](t, 1, 1, [Link](m2))

RETURNS

A new matrix object of the copied id matrix.

SEE ALSO

[Link]<type>() [Link]() [Link]() [Link]() [Link]()

[Link]() 2 overloads

The function returns the determinant of a square matrix.

SYNTAX & OVERLOADS

[Link](id) → series float

[Link](id) → series int

ARGUMENTS

id (matrix<int/float>) A matrix object.

EXAMPLE

//@version=6
indicator("`[Link]` Example")

// Create a 2x2 matrix.

var m = [Link]<float>(2, 2, na)
// Fill the matrix with values.
[Link](m, 0, 0, 3)
[Link](m, 0, 1, 7)
[Link](m, 1, 0, 1)
[Link](m, 1, 1, -4)

// Get the determinant of the matrix.

var x = [Link](m)

plot(x, 'Matrix determinant')

RETURNS

The determinant value of the id matrix.

REMARKS

Function calculation based on the LU decomposition algorithm.

SEE ALSO

[Link]<type>() [Link]() matrix.is_square()

[Link]() 2 overloads

The function returns a new matrix resulting from the subtraction between matrices id1 and id2 , or of matrix id1
and an id2 scalar (a numerical value).

SYNTAX & OVERLOADS

[Link](id1, id2) → matrix<int>

[Link](id1, id2) → matrix<float>

ARGUMENTS

id1 (matrix<int>) Matrix to subtract from.

id2 (series int/float/matrix<int>) Matrix object or a scalar value to be subtracted.

Difference between two matrices

EXAMPLE

//@version=6
indicator("`[Link]()` Example 1")

// For efficiency, execute this code only once.

if [Link]
// Create a 2x3 matrix containing values `5`.
var m1 = [Link]<float>(2, 3, 5)
// Create a 2x3 matrix containing values `4`.
var m2 = [Link]<float>(2, 3, 4)
// Create a new matrix containing the difference between matrices `m1` and `m2`.
var m3 = [Link](m1, m2)

// Display using a table.

var t = [Link](position.top_right, 1, 2, [Link])
[Link](t, 0, 0, "Difference between two matrices:")
[Link](t, 0, 1, [Link](m3))

Difference between a matrix and a scalar value

EXAMPLE

//@version=6
indicator("`[Link]()` Example 2")

// For efficiency, execute this code only once.

if [Link]
// Create a 2x3 matrix with values `4`.
var m1 = [Link]<float>(2, 3, 4)

// Create a new matrix containing the difference between the `m1` matrix and the "int" value `1`.
var m2 = [Link](m1, 1)

// Display using a table.

var t = [Link](position.top_right, 1, 2, [Link])
[Link](t, 0, 0, "Difference between a matrix and a scalar:")
[Link](t, 0, 1, [Link](m2))

RETURNS

A new matrix object containing the difference between id2 and id1 .

SEE ALSO

[Link]<type>() [Link]() [Link]() [Link]() [Link]()

[Link]() 2 overloads

The function returns an array containing the eigenvalues of a square matrix.

SYNTAX & OVERLOADS

[Link](id) → array<float>

[Link](id) → array<int>

ARGUMENTS

id (matrix<int/float>) A matrix object.

EXAMPLE

//@version=6
indicator("`[Link]()` Example")

// For efficiency, execute this code only once.

if [Link]
// Create a 2x2 matrix.
var m1 = [Link]<int>(2, 2, na)
// Fill the matrix with values.
[Link](m1, 0, 0, 2)
[Link](m1, 0, 1, 4)
[Link](m1, 1, 0, 6)
[Link](m1, 1, 1, 8)

// Get the eigenvalues of the matrix.

tr = [Link](m1)

// Display matrix elements.

var t = [Link](position.top_right, 2, 2, [Link])
[Link](t, 0, 0, "Matrix elements:")
[Link](t, 0, 1, [Link](m1))
[Link](t, 1, 0, "Array of Eigenvalues:")
[Link](t, 1, 1, [Link](tr))
RETURNS

An array containing the eigenvalues of the id matrix.

REMARKS

The function is calculated using "The Implicit QL Algorithm".

SEE ALSO

[Link]<type>() [Link]() [Link]()

[Link]() 2 overloads

Returns a matrix of eigenvectors, in which each column is an eigenvector of the id matrix.

SYNTAX & OVERLOADS

[Link](id) → matrix<float>

[Link](id) → matrix<int>

ARGUMENTS

id (matrix<int/float>) A matrix object.

EXAMPLE

//@version=6
indicator("`[Link]()` Example")

// For efficiency, execute this code only once.

if [Link]
// Create a 2x2 matrix
var m1 = [Link]<int>(2, 2, 1)
// Fill the matrix with values.
[Link](m1, 0, 0, 2)
[Link](m1, 0, 1, 4)
[Link](m1, 1, 0, 6)
[Link](m1, 1, 1, 8)

// Get the eigenvectors of the matrix.

m2 = [Link](m1)

// Display matrix elements.

var t = [Link](position.top_right, 2, 2, [Link])
[Link](t, 0, 0, "Matrix Elements:")
[Link](t, 0, 1, [Link](m1))
[Link](t, 1, 0, "Matrix Eigenvectors:")
[Link](t, 1, 1, [Link](m2))

RETURNS

A new matrix containing the eigenvectors of the id matrix.

REMARKS

The function is calculated using "The Implicit QL Algorithm".

SEE ALSO

[Link]<type>() [Link]() [Link]() [Link]()

matrix.elements_count()
The function returns the total number of all matrix elements.
SYNTAX

matrix.elements_count(id) → series int

ARGUMENTS

id (any matrix type) A matrix object.

SEE ALSO

[Link]<type>() [Link]() [Link]()

[Link]()
The function fills a rectangular area of the id matrix defined by the indices from_column to to_column (not
including it) and from_row to to_row (not including it) with the value .

SYNTAX

[Link](id, value, from_row, to_row, from_column, to_column) → void

ARGUMENTS

id (any matrix type) A matrix object.

value (series <type of the matrix's elements>) The value to fill with.
from_row (series int) Row index from which the fill will begin (inclusive). Optional. The default value is 0.

to_row (series int) Row index where the fill will end (not inclusive). Optional. The default value is [Link]().
from_column (series int) Column index from which the fill will begin (inclusive). Optional. The default value is 0.

to_column (series int) Column index where the fill will end (non inclusive). Optional. The default value is
[Link]().

EXAMPLE

//@version=6
indicator("`[Link]()` Example")

// Create a 4x5 "int" matrix containing values `0`.

m = [Link]<float>(4, 5, 0)

// Fill the intersection of rows 1 to 2 and columns 2 to 3 of the matrix with `hl2` values.
[Link](m, hl2, 0, 2, 1, 3)

// Display using a label.

if [Link]
[Link](bar_index, high, [Link](m))

SEE ALSO

[Link]<type>() [Link]() [Link]() [Link]() [Link]()

[Link]()
The function returns the element with the specified index of the matrix.

SYNTAX

[Link](id, row, column) → <matrix_type>

ARGUMENTS

id (any matrix type) A matrix object.

row (series int) Index of the required row.

column (series int) Index of the required column.

EXAMPLE

//@version=6
indicator("`[Link]()` Example", "", true)

// Create a 2x3 "float" matrix from the `hl2` values.

m = [Link]<float>(2, 3, hl2)

// Return the value of the element at index [0, 0] of matrix `m`.

x = [Link](m, 0, 0)

plot(x)

RETURNS

The value of the element at the row and column index of the id matrix.

REMARKS

Indexing of the rows and columns starts at zero.

SEE ALSO

[Link]<type>() [Link]() [Link]() [Link]()

[Link]() 2 overloads

The function returns the inverse of a square matrix.

SYNTAX & OVERLOADS

[Link](id) → matrix<float>

[Link](id) → matrix<int>

ARGUMENTS

id (matrix<int/float>) A matrix object.

EXAMPLE

//@version=6
indicator("`[Link]()` Example")

SEE ALSO

[Link]<type>() [Link]() matrix.is_square() matrix.is_identity() matrix.is_antidiagonal()

matrix.is_identity()
The function determines if a matrix is an identity matrix (elements with ones on the main diagonal and zeros
elsewhere).

SYNTAX

matrix.is_identity(id) → series bool

ARGUMENTS

id (matrix<int/float>) Matrix object to test.

RETURNS

Returns true if id is an identity matrix, false otherwise.

REMARKS

Returns false with non-square matrices.

SEE ALSO

[Link]<type>() matrix.is_square() matrix.is_diagonal()

matrix.is_square()
The function determines if the matrix is square (it has the same number of rows and columns).

SYNTAX

matrix.is_square(id) → series bool

Returns true if the id matrix is symmetric, false otherwise.

REMARKS

Returns false with non-square matrices.

SEE ALSO

[Link]<type>() [Link]() [Link]() matrix.is_square()

matrix.is_triangular()
The function determines if the matrix is triangular (if all elements above or below the main diagonal are zero).

SYNTAX

matrix.is_triangular(id) → series bool

ARGUMENTS
id (matrix<int/float>) Matrix object to test.

RETURNS

Returns true if the id matrix is triangular, false otherwise.

REMARKS

Returns false with non-square matrices.

SEE ALSO

[Link]<type>() [Link]() matrix.is_square()

matrix.is_zero()
The function determines if all elements of the matrix are zero.

SYNTAX

matrix.is_zero(id) → series bool

ARGUMENTS

id (matrix<int/float>) Matrix object to check.

RETURNS

Returns true if all elements of the id matrix are zero, false otherwise.

SEE ALSO

[Link]<type>() [Link]() [Link]()

[Link]() 2 overloads

The function returns the Kronecker product for the id1 and id2 matrices.

SYNTAX & OVERLOADS

[Link](id1, id2) → matrix<float>

[Link](id1, id2) → matrix<int>

ARGUMENTS

id1 (matrix<int/float>) First matrix object.

id2 (matrix<int/float>) Second matrix object.

EXAMPLE

//@version=6
indicator("`[Link]()` Example")

// Display using a table.

if [Link]
// Create two matrices with default values `1` and `2`.
var m1 = [Link]<float>(2, 2, 1)
var m2 = [Link]<float>(2, 2, 2)

// Calculate the Kronecker product of the matrices.

var m3 = [Link](m1, m2)

// Display matrix elements.

var t = [Link](position.top_right, 5, 2, [Link])
[Link](t, 0, 0, "Matrix 1:")
[Link](t, 0, 1, [Link](m1))
[Link](t, 1, 1, "⊗")
[Link](t, 2, 0, "Matrix 2:")
[Link](t, 2, 1, [Link](m2))
[Link](t, 3, 1, "=")
[Link](t, 4, 0, "Kronecker product:")
[Link](t, 4, 1, [Link](m3))

RETURNS

A new matrix containing the Kronecker product of id1 and id2 .

SEE ALSO

[Link]<type>() [Link]() [Link]() [Link]()

[Link]() 2 overloads

The function returns the largest value from the matrix elements.

SYNTAX & OVERLOADS

[Link](id) → series float

[Link](id) → series int

ARGUMENTS

id (matrix<int/float>) A matrix object.

EXAMPLE

//@version=6
indicator("`[Link]()` Example")

// Create a 2x2 matrix.

var m = [Link]<int>(2, 2, na)
// Fill the matrix with values.
[Link](m, 0, 0, 1)
[Link](m, 0, 1, 2)
[Link](m, 1, 0, 3)
[Link](m, 1, 1, 4)

// Get the maximum value in the matrix.

var x = [Link](m)

plot(x, 'Matrix maximum value')

RETURNS

The maximum value from the id matrix.

SEE ALSO

[Link]<type>() [Link]() [Link]() [Link]()

[Link]() 2 overloads

The function calculates the median ("the middle" value) of matrix elements.

SYNTAX & OVERLOADS

[Link](id) → series float

[Link](id) → series int

ARGUMENTS

id (matrix<int/float>) A matrix object.

EXAMPLE

//@version=6
indicator("`[Link]()` Example")

// Create a 2x2 matrix.

m = [Link]<int>(2, 2, na)
// Fill the matrix with values.
[Link](m, 0, 0, 1)
[Link](m, 0, 1, 2)
[Link](m, 1, 0, 3)
[Link](m, 1, 1, 4)

// Get the median of the matrix.

x = [Link](m)

plot(x, 'Median of the matrix')

REMARKS

Note that na elements of the matrix are not considered when calculating the median.

SEE ALSO

[Link]<type>() [Link]() [Link]() [Link]()

[Link]() 2 overloads

The function returns the smallest value from the matrix elements.

SYNTAX & OVERLOADS

[Link](id) → series float

[Link](id) → series int

ARGUMENTS

id (matrix<int/float>) A matrix object.

EXAMPLE

//@version=6
indicator("`[Link]()` Example")

// Create a 2x2 matrix.

var m = [Link]<int>(2, 2, na)
// Fill the matrix with values.
[Link](m, 0, 0, 1)
[Link](m, 0, 1, 2)
[Link](m, 1, 0, 3)
[Link](m, 1, 1, 4)

// Get the minimum value from the matrix.

var x = [Link](m)

plot(x, 'Matrix minimum value')

RETURNS

The smallest value from the id matrix.

SEE ALSO
[Link]<type>() [Link]() [Link]() [Link]()

[Link]() 2 overloads

The function calculates the mode of the matrix, which is the most frequently occurring value from the matrix elements.
When there are multiple values occurring equally frequently, the function returns the smallest of those values.

SYNTAX & OVERLOADS

[Link](id) → series float

[Link](id) → series int

ARGUMENTS

id (matrix<int/float>) A matrix object.

EXAMPLE

//@version=6
indicator("`[Link]()` Example")

// Create a 2x2 matrix.

var m = [Link]<int>(2, 2, na)
// Fill the matrix with values.
[Link](m, 0, 0, 0)
[Link](m, 0, 1, 0)
[Link](m, 1, 0, 1)
[Link](m, 1, 1, 1)

// Get the mode of the matrix.

var x = [Link](m)

plot(x, 'Mode of the matrix')

RETURNS

The most frequently occurring value from the id matrix. If none exists, returns the smallest value instead.

REMARKS

Note that na elements of the matrix are not considered when calculating the mode.

SEE ALSO

[Link]<type>() [Link]() [Link]() [Link]() [Link]()

[Link]() 4 overloads

The function returns a new matrix resulting from the product between the matrices id1 and id2 , or between an i
d1 matrix and an id2 scalar (a numerical value), or between an id1 matrix and an id2 vector (an array of
values).

SYNTAX & OVERLOADS

[Link](id1, id2) → array<int>

[Link](id1, id2) → array<float>

[Link](id1, id2) → matrix<int>

[Link](id1, id2) → matrix<float>

ARGUMENTS

id1 (matrix<int>) First matrix object.

id2 (array<int>) Second matrix object, value or array.

Product of two matrices

EXAMPLE

//@version=6
indicator("`[Link]()` Example 1")

// For efficiency, execute this code only once.

if [Link]
// Create a 6x2 matrix containing values `5`.
var m1 = [Link]<float>(6, 2, 5)
// Create a 2x3 matrix containing values `4`.
// Note that it must have the same quantity of rows as there are columns in the first matrix.
var m2 = [Link]<float>(2, 3, 4)
// Create a new matrix from the multiplication of the two matrices.
var m3 = [Link](m1, m2)

// Display using a table.

var t = [Link](position.top_right, 1, 2, [Link])
[Link](t, 0, 0, "Product of two matrices:")
[Link](t, 0, 1, [Link](m3))

Product of a matrix and a scalar

EXAMPLE

//@version=6
indicator("`[Link]()` Example 2")

// For efficiency, execute this code only once.

if [Link]
// Create a 2x3 matrix containing values `4`.
var m1 = [Link]<float>(2, 3, 4)

// Create a new matrix from the product of the two matrices.

scalar = 5
var m2 = [Link](m1, scalar)

// Display using a table.

var t = [Link](position.top_right, 5, 2, [Link])
[Link](t, 0, 0, "Matrix 1:")
[Link](t, 0, 1, [Link](m1))
[Link](t, 1, 1, "x")
[Link](t, 2, 0, "Scalar:")
[Link](t, 2, 1, [Link](scalar))
[Link](t, 3, 1, "=")
[Link](t, 4, 0, "Matrix 2:")
[Link](t, 4, 1, [Link](m2))

Product of a matrix and an array vector

EXAMPLE

//@version=6
indicator("`[Link]()` Example 3")

// For efficiency, execute this code only once.

if [Link]
// Create a 2x3 matrix containing values `4`.
var m1 = [Link]<int>(2, 3, 4)

// Create an array of three elements.

var array<int> a = [Link](1, 1, 1)
// Create a new matrix containing the product of the `m1` matrix and the `a` array.
var m3 = [Link](m1, a)

// Display using a table.

var t = [Link](position.top_right, 5, 2, [Link])
[Link](t, 0, 0, "Matrix 1:")
[Link](t, 0, 1, [Link](m1))
[Link](t, 1, 1, "x")
[Link](t, 2, 0, "Value:")
[Link](t, 2, 1, [Link](a, " "))
[Link](t, 3, 1, "=")
[Link](t, 4, 0, "Matrix 3:")
[Link](t, 4, 1, [Link](m3))

RETURNS

A new matrix object containing the product of id2 and id1 .

SEE ALSO

[Link]<type>() [Link]() [Link]()

[Link]<type>()
The function creates a new matrix object. A matrix is a two-dimensional data structure containing rows and columns.
All elements in the matrix must be of the type specified in the type template ("<type>").

SYNTAX

[Link]<type>(rows, columns, initial_value) → matrix<type>

ARGUMENTS

rows (series int) Initial row count of the matrix. Optional. The default value is 0.
columns (series int) Initial column count of the matrix. Optional. The default value is 0.

initial_value (<matrix_type>) Initial value of all matrix elements. Optional. The default is 'na'.
Create a matrix of elements with the same initial value

EXAMPLE

//@version=6
indicator("`[Link]<type>()` Example 1")

// Create a 2x3 (2 rows x 3 columns) "int" matrix with values zero.

var m = [Link]<int>(2, 3, 0)

// Display using a label.

if [Link]
[Link](bar_index, high, [Link](m))

Create a matrix from array values

EXAMPLE

//@version=6
indicator("`[Link]<type>()` Example 2")

// Function to create a matrix whose rows are filled with array values.
matrixFromArray(int rows, int columns, array<float> data) =>
m = [Link]<float>(rows, columns)
for i = 0 to rows <= 0 ? na : rows - 1
for j = 0 to columns <= 0 ? na : columns - 1
[Link](m, i, j, [Link](data, i * columns + j))
m

// Create a 3x3 matrix from an array of values.

var m1 = matrixFromArray(3, 3, [Link](1, 2, 3, 4, 5, 6, 7, 8, 9))
// Display using a label.
if [Link]
[Link](bar_index, high, [Link](m1))

Create a matrix from an input.text_area() field

EXAMPLE

//@version=6
indicator("`[Link]<type>()` Example 3")

// Function to create a matrix from a text string.

// Values in a row must be separated by a space. Each line is one row.
matrixFromInputArea(stringOfValues) =>
var rowsArray = [Link](stringOfValues, "\n")
var rows = [Link](rowsArray)
var cols = [Link]([Link]([Link](rowsArray, 0), " "))
var matrix = [Link]<float>(rows, cols, na)
row = 0
for rowString in rowsArray
col = 0
values = [Link](rowString, " ")
for val in values
[Link](matrix, row, col, [Link](val))
col += 1
row += 1
matrix

stringInput = input.text_area("1 2 3\n4 5 6\n7 8 9")

var m = matrixFromInputArea(stringInput)

// Display using a label.

if [Link]
[Link](bar_index, high, [Link](m))

Create matrix from random values

EXAMPLE

//@version=6
indicator("`[Link]<type>()` Example 4")

// Function to create a matrix with random values (0.0 to 1.0).

matrixRandom(int rows, int columns)=>
result = [Link]<float>(rows, columns)
for i = 0 to rows - 1
for j = 0 to columns - 1
[Link](result, i, j, [Link]())
result

// Create a 2x3 matrix with random values.

var m = matrixRandom(2, 3)

// Display using a label.

if [Link]
[Link](bar_index, high, [Link](m))

RETURNS

The ID of the new matrix object.

SEE ALSO

[Link]() [Link]() [Link]() [Link]() [Link]<type>()

[Link]() 2 overloads
The function returns the pseudoinverse of a matrix.

SYNTAX & OVERLOADS

[Link](id) → matrix<float>

[Link](id) → matrix<int>

ARGUMENTS

id (matrix<int/float>) A matrix object.

EXAMPLE

//@version=6
indicator("`[Link]()` Example")

// For efficiency, execute this code only once.

if [Link]
// Create a 2x2 matrix.
var m1 = [Link]<int>(2, 2, na)
// Fill the matrix with values.
[Link](m1, 0, 0, 1)
[Link](m1, 0, 1, 2)
[Link](m1, 1, 0, 3)
[Link](m1, 1, 1, 4)

// Pseudoinverse of the matrix.

var m2 = [Link](m1)

// Display matrix elements.

var t = [Link](position.top_right, 2, 2, [Link])
[Link](t, 0, 0, "Original Matrix:")
[Link](t, 0, 1, [Link](m1))
[Link](t, 1, 0, "Pseudoinverse matrix:")
[Link](t, 1, 1, [Link](m2))

RETURNS

A new matrix containing the pseudoinverse of the id matrix.

REMARKS

The function is calculated using a Moore–Penrose inverse formula based on singular-value decomposition of a matrix.
For non-singular square matrices this function returns the result of [Link]().

SEE ALSO

[Link]<type>() [Link]() [Link]()

[Link]() 2 overloads

The function calculates the product of the matrix by itself power times.

SYNTAX & OVERLOADS

[Link](id, power) → matrix<float>

[Link](id, power) → matrix<int>

ARGUMENTS

id (matrix<int/float>) A matrix object.

power (series int) The number of times the matrix will be multiplied by itself.
EXAMPLE

//@version=6
indicator("`[Link]()` Example")

// Display using a table.

if [Link]
// Create a 2x2 matrix.
var m1 = [Link]<int>(2, 2, 2)
// Calculate the power of three of the matrix.
var m2 = [Link](m1, 3)

// Display matrix elements.

var t = [Link](position.top_right, 2, 2, [Link])
[Link](t, 0, 0, "Original Matrix:")
[Link](t, 0, 1, [Link](m1))
[Link](t, 1, 0, "Matrix³:")
[Link](t, 1, 1, [Link](m2))

RETURNS

The product of the id matrix by itself power times.

SEE ALSO

[Link]<type>() [Link]() [Link]()

[Link]()
The function calculates the rank of the matrix.

SYNTAX

[Link](id) → series int

ARGUMENTS

id (any matrix type) A matrix object.

EXAMPLE

//@version=6
indicator("`[Link]()` Example")

// For efficiency, execute this code only once.

if [Link]
// Create a 2x2 matrix.
var m1 = [Link]<int>(2, 2, na)
// Fill the matrix with values.
[Link](m1, 0, 0, 1)
[Link](m1, 0, 1, 2)
[Link](m1, 1, 0, 3)
[Link](m1, 1, 1, 4)

// Get the rank of the matrix.

r = [Link](m1)

// Display matrix elements.

var t = [Link](position.top_right, 2, 2, [Link])
[Link](t, 0, 0, "Matrix elements:")
[Link](t, 0, 1, [Link](m1))
[Link](t, 1, 0, "Rank of the matrix:")
[Link](t, 1, 1, [Link](r))

RETURNS

The rank of the id matrix.

SEE ALSO
[Link]<type>() [Link]() [Link]()

matrix.remove_col()
The function removes the column at column index of the id matrix and returns an array containing the removed
column's values.

SYNTAX

matrix.remove_col(id, column) → array<type>

ARGUMENTS

id (any matrix type) A matrix object.

column (series int) The index of the column to be removed. Optional. The default value is [Link]().

EXAMPLE

//@version=6
indicator("matrix_remove_col", overlay = true)

// Create a 2x2 matrix with ones.

var matrixOrig = [Link]<int>(2, 2, 1)

// Set values to the 'matrixOrig' matrix.

[Link](matrixOrig, 0, 1, 2)
[Link](matrixOrig, 1, 0, 3)
[Link](matrixOrig, 1, 1, 4)

// Create a copy of the 'matrixOrig' matrix.

matrixCopy = [Link](matrixOrig)

// Remove the first column from the `matrixCopy` matrix.

arr = matrix.remove_col(matrixCopy, 0)

// Display matrix elements.

if [Link]
var t = [Link](position.top_right, 3, 2, [Link])
[Link](t, 0, 0, "Original Matrix:")
[Link](t, 0, 1, [Link](matrixOrig))
[Link](t, 1, 0, "Removed Elements:")
[Link](t, 1, 1, [Link](arr))
[Link](t, 2, 0, "Result Matrix:")
[Link](t, 2, 1, [Link](matrixCopy))

RETURNS

An array containing the elements of the column removed from the id matrix.

REMARKS

Indexing of rows and columns starts at zero. It is far more efficient to declare matrices with explicit dimensions than to
build them by adding or removing columns. Deleting a column is also much slower than deleting a row with the
matrix.remove_row() function.

SEE ALSO

[Link]<type>() [Link]() [Link]() matrix.remove_row()

matrix.remove_row()
The function removes the row at row index of the id matrix and returns an array containing the removed row's
values.

SYNTAX
matrix.remove_row(id, row) → array<type>

ARGUMENTS

id (any matrix type) A matrix object.

row (series int) The index of the row to be deleted. Optional. The default value is [Link]().

EXAMPLE

//@version=6
indicator("matrix_remove_row", overlay = true)

// Create a 2x2 "int" matrix containing values `1`.

var matrixOrig = [Link]<int>(2, 2, 1)

// Set values to the 'matrixOrig' matrix.

[Link](matrixOrig, 0, 1, 2)
[Link](matrixOrig, 1, 0, 3)
[Link](matrixOrig, 1, 1, 4)

// Create a copy of the 'matrixOrig' matrix.

matrixCopy = [Link](matrixOrig)

// Remove the first row from the matrix `matrixCopy`.

arr = matrix.remove_row(matrixCopy, 0)

// Display matrix elements.

RETURNS

An array containing the elements of the row removed from the id matrix.

REMARKS

Indexing of rows and columns starts at zero. It is far more efficient to declare matrices with explicit dimensions than to
build them by adding or removing rows.

SEE ALSO

[Link]<type>() [Link]() [Link]() matrix.remove_col()

[Link]()
The function rebuilds the id matrix to rows x cols dimensions.

SYNTAX

[Link](id, rows, columns) → void

ARGUMENTS

id (any matrix type) A matrix object.

rows (series int) The number of rows of the reshaped matrix.

columns (series int) The number of columns of the reshaped matrix.

EXAMPLE

//@version=6
indicator("`[Link]()` Example")
// For efficiency, execute this code only once.
if [Link]
// Create a 2x3 matrix.
var m1 = [Link]<float>(2, 3)
// Fill the matrix with values.
[Link](m1, 0, 0, 1)
[Link](m1, 0, 1, 2)
[Link](m1, 0, 2, 3)
[Link](m1, 1, 0, 4)
[Link](m1, 1, 1, 5)
[Link](m1, 1, 2, 6)

// Copy the matrix to a new one.

var m2 = [Link](m1)

// Reshape the copy to a 3x2.

[Link](m2, 3, 2)

// Display using a table.

var t = [Link](position.top_right, 2, 2, [Link])
[Link](t, 0, 0, "Original matrix:")
[Link](t, 0, 1, [Link](m1))
[Link](t, 1, 0, "Reshaped matrix:")
[Link](t, 1, 1, [Link](m2))

SEE ALSO

[Link]<type>() [Link]() [Link]() matrix.add_row() matrix.add_col()

[Link]()
The function reverses the order of rows and columns in the matrix id . The first row and first column become the last,
and the last become the first.

SYNTAX

[Link](id) → void

ARGUMENTS

id (any matrix type) A matrix object.

EXAMPLE

//@version=6
indicator("`[Link]()` Example")

// For efficiency, execute this code only once.

if [Link]
// Copy the matrix to a new one.
var m1 = [Link]<int>(2, 2, na)
// Fill the matrix with values.
[Link](m1, 0, 0, 1)
[Link](m1, 0, 1, 2)
[Link](m1, 1, 0, 3)
[Link](m1, 1, 1, 4)

// Copy matrix elements to a new matrix.

var m2 = [Link](m1)

// Reverse the `m2` copy of the original matrix.

[Link](m2)

// Display using a table.

var t = [Link](position.top_right, 2, 2, [Link])
[Link](t, 0, 0, "Original matrix:")
[Link](t, 0, 1, [Link](m1))
[Link](t, 1, 0, "Reversed matrix:")
[Link](t, 1, 1, [Link](m2))
SEE ALSO

[Link]<type>() [Link]() [Link]() [Link]() [Link]()

[Link]()
The function creates a one-dimensional array from the elements of a matrix row.

SYNTAX

[Link](id, row) → array<type>

ARGUMENTS

id (any matrix type) A matrix object.

row (series int) Index of the required row.

EXAMPLE

//@version=6
indicator("`[Link]()` Example", "", true)

// Create a 2x3 "float" matrix from `hlc3` values.

m = [Link]<float>(2, 3, hlc3)

// Return an array with the values of the first row of the matrix.
a = [Link](m, 0)

// Plot the first value from the array `a`.

plot([Link](a, 0))

RETURNS

An array ID containing the row values of the id matrix.

REMARKS

Indexing of rows starts at 0.

SEE ALSO

[Link]<type>() [Link]() [Link]() [Link]() [Link]()

[Link]()
The function returns the number of rows in the matrix.

SYNTAX

[Link](id) → series int

ARGUMENTS

id (any matrix type) A matrix object.

EXAMPLE

//@version=6
indicator("`[Link]()` Example")

// Create a 2x6 matrix with values `0`.

var m = [Link]<int>(2, 6, 0)

// Get the quantity of rows in the matrix.

var x = [Link](m)
// Display using a label.
if [Link]
[Link](bar_index, high, "Rows: " + [Link](x) + "\n" + [Link](m))

RETURNS

The number of rows in the matrix id .

SEE ALSO

[Link]<type>() [Link]() [Link]() [Link]() [Link]()

[Link]()
The function assigns value to the element at the row and column of the id matrix.

SYNTAX

[Link](id, row, column, value) → void

ARGUMENTS

id (any matrix type) A matrix object.

row (series int) The row index of the element to be modified.

column (series int) The column index of the element to be modified.

value (series <type of the matrix's elements>) The new value to be set.

EXAMPLE

//@version=6
indicator("`[Link]()` Example")

// Create a 2x3 "int" matrix containing values `4`.

m = [Link]<int>(2, 3, 4)

// Replace the value of element at row 1 and column 2 with value `3`.
[Link](m, 0, 1, 3)

// Display using a label.

if [Link]
[Link](bar_index, high, [Link](m))

SEE ALSO

[Link]<type>() [Link]() [Link]() [Link]()

[Link]()
The function rearranges the rows in the id matrix following the sorted order of the values in the column .

SYNTAX

[Link](id, column, order) → void

ARGUMENTS

id (matrix<int/float/string>) A matrix object to be sorted.

column (series int) Index of the column whose sorted values determine the new order of rows. Optional. The default
value is 0.
order (series sort_order) The sort order. Possible values: [Link] (default), [Link].
EXAMPLE

//@version=6
indicator("`[Link]()` Example")

// For efficiency, execute this code only once.

if [Link]
// Create a 2x2 matrix.
var m1 = [Link]<float>(2, 2, na)
// Fill the matrix with values.
[Link](m1, 0, 0, 3)
[Link](m1, 0, 1, 4)
[Link](m1, 1, 0, 1)
[Link](m1, 1, 1, 2)

// Copy the matrix to a new one.

var m2 = [Link](m1)
// Sort the rows of `m2` using the default arguments (first column and ascending order).
[Link](m2)

// Display using a table.

if [Link]
var t = [Link](position.top_right, 2, 2, [Link])
[Link](t, 0, 0, "Original matrix:")
[Link](t, 0, 1, [Link](m1))
[Link](t, 1, 0, "Sorted matrix:")
[Link](t, 1, 1, [Link](m2))

SEE ALSO

[Link]<type>() [Link]() [Link]() [Link]()

[Link]()
The function extracts a submatrix of the id matrix within the specified indices.

SYNTAX

[Link](id, from_row, to_row, from_column, to_column) → matrix<type>

ARGUMENTS

id (any matrix type) A matrix object.

from_row (series int) Index of the row from which the extraction will begin (inclusive). Optional. The default value is
0.

to_row (series int) Index of the row where the extraction will end (non inclusive). Optional. The default value is
[Link]().

from_column (series int) Index of the column from which the extraction will begin (inclusive). Optional. The default
value is 0.

to_column (series int) Index of the column where the extraction will end (non inclusive). Optional. The default value is
[Link]().

EXAMPLE

//@version=6
indicator("`[Link]()` Example")

// For efficiency, execute this code only once.

if [Link]
// Create a 2x3 matrix matrix with values `0`.
var m1 = [Link]<int>(2, 3, 0)
// Fill the matrix with values.
[Link](m1, 0, 0, 1)
[Link](m1, 0, 1, 2)
[Link](m1, 0, 2, 3)
[Link](m1, 1, 0, 4)
[Link](m1, 1, 1, 5)
[Link](m1, 1, 2, 6)

// Create a 2x2 submatrix of the `m1` matrix.

var m2 = [Link](m1, 0, 2, 1, 3)

// Display using a table.

var t = [Link](position.top_right, 2, 2, [Link])
[Link](t, 0, 0, "Original Matrix:")
[Link](t, 0, 1, [Link](m1))
[Link](t, 1, 0, "Submatrix:")
[Link](t, 1, 1, [Link](m2))

RETURNS

A new matrix object containing the submatrix of the id matrix defined by the from_row , to_row , from_colum
n and to_column indices.

REMARKS

Indexing of the rows and columns starts at zero.

SEE ALSO

[Link]<type>() [Link]() [Link]() [Link]() [Link]()

[Link]() 2 overloads

The function returns a new matrix resulting from the sum of two matrices id1 and id2 , or of an id1 matrix and
an id2 scalar (a numerical value).

SYNTAX & OVERLOADS

[Link](id1, id2) → matrix<int>

[Link](id1, id2) → matrix<float>

ARGUMENTS

id1 (matrix<int>) First matrix object.

id2 (series int/float/matrix<int>) Second matrix object, or scalar value.

Sum of two matrices

EXAMPLE

//@version=6
indicator("`[Link]()` Example 1")

// For efficiency, execute this code only once.

if [Link]
// Create a 2x3 matrix containing values `5`.
var m1 = [Link]<float>(2, 3, 5)
// Create a 2x3 matrix containing values `4`.
var m2 = [Link]<float>(2, 3, 4)
// Create a new matrix that sums matrices `m1` and `m2`.
var m3 = [Link](m1, m2)

// Display using a table.

var t = [Link](position.top_right, 1, 2, [Link])
[Link](t, 0, 0, "Sum of two matrices:")
[Link](t, 0, 1, [Link](m3))

Sum of a matrix and scalar

EXAMPLE
//@version=6
indicator("`[Link]()` Example 2")

// For efficiency, execute this code only once.

if [Link]
// Create a 2x3 matrix with values `4`.
var m1 = [Link]<float>(2, 3, 4)

// Create a new matrix containing the sum of the `m1` matrix with the "int" value `1`.
var m2 = [Link](m1, 1)

// Display using a table.

var t = [Link](position.top_right, 1, 2, [Link])
[Link](t, 0, 0, "Sum of a matrix and a scalar:")
[Link](t, 0, 1, [Link](m2))

RETURNS

A new matrix object containing the sum of id2 and id1 .

SEE ALSO

[Link]<type>() [Link]() [Link]() [Link]() [Link]()

matrix.swap_columns()
The function swaps the columns at the index column1 and column2 in the id matrix.

SYNTAX

matrix.swap_columns(id, column1, column2) → void

ARGUMENTS

id (any matrix type) A matrix object.

column1 (series int) Index of the first column to be swapped.

column2 (series int) Index of the second column to be swapped.

EXAMPLE

//@version=6
indicator("`matrix.swap_columns()` Example")

// For efficiency, execute this code only once.

if [Link]
// Create a 2x2 matrix with ‘na’ values.
var m1 = [Link]<int>(2, 2, na)
// Fill the matrix with values.
[Link](m1, 0, 0, 1)
[Link](m1, 0, 1, 2)
[Link](m1, 1, 0, 3)
[Link](m1, 1, 1, 4)

// Copy the matrix to a new one.

var m2 = [Link](m1)

// Swap the first and second columns of the matrix copy.

matrix.swap_columns(m2, 0, 1)

// Display using a table.

var t = [Link](position.top_right, 2, 2, [Link])
[Link](t, 0, 0, "Original matrix:")
[Link](t, 0, 1, [Link](m1))
[Link](t, 1, 0, "Swapped columns in copy:")
[Link](t, 1, 1, [Link](m2))

REMARKS

Indexing of the rows and columns starts at zero.

SEE ALSO

[Link]<type>() [Link]() [Link]() [Link]() [Link]()

matrix.swap_rows()
The function swaps the rows at the index row1 and row2 in the id matrix.

SYNTAX

matrix.swap_rows(id, row1, row2) → void

ARGUMENTS

id (any matrix type) A matrix object.

row1 (series int) Index of the first row to be swapped.

row2 (series int) Index of the second row to be swapped.

EXAMPLE

//@version=6
indicator("`matrix.swap_rows()` Example")

// For efficiency, execute this code only once.

if [Link]
// Create a 3x2 matrix with ‘na’ values.
var m1 = [Link]<int>(3, 2, na)
// Fill the matrix with values.
[Link](m1, 0, 0, 1)
[Link](m1, 0, 1, 2)
[Link](m1, 1, 0, 3)
[Link](m1, 1, 1, 4)
[Link](m1, 2, 0, 5)
[Link](m1, 2, 1, 6)

// Copy the matrix to a new one.

var m2 = [Link](m1)

// Swap the first and second rows of the matrix copy.

matrix.swap_rows(m2, 0, 1)

// Display using a table.

var t = [Link](position.top_right, 2, 2, [Link])
[Link](t, 0, 0, "Original matrix:")
[Link](t, 0, 1, [Link](m1))
[Link](t, 1, 0, "Swapped rows in copy:")
[Link](t, 1, 1, [Link](m2))

REMARKS

Indexing of the rows and columns starts at zero.

SEE ALSO

[Link]<type>() [Link]() [Link]() [Link]() matrix.swap_columns()

[Link]() 2 overloads

The function calculates the trace of a matrix (the sum of the main diagonal's elements).

SYNTAX & OVERLOADS

[Link](id) → series float

[Link](id) → series int

ARGUMENTS

id (matrix<int/float>) A matrix object.

EXAMPLE

//@version=6
indicator("`[Link]()` Example")

// For efficiency, execute this code only once.

if [Link]
// Create a 2x2 matrix.
var m1 = [Link]<int>(2, 2, na)
// Fill the matrix with values.
[Link](m1, 0, 0, 1)
[Link](m1, 0, 1, 2)
[Link](m1, 1, 0, 3)
[Link](m1, 1, 1, 4)

// Get the trace of the matrix.

tr = [Link](m1)

// Display matrix elements.

var t = [Link](position.top_right, 2, 2, [Link])
[Link](t, 0, 0, "Matrix elements:")
[Link](t, 0, 1, [Link](m1))
[Link](t, 1, 0, "Trace of the matrix:")
[Link](t, 1, 1, [Link](tr))

RETURNS

The trace of the id matrix.

SEE ALSO

[Link]<type>() [Link]() [Link]() [Link]() [Link]()

[Link]()
The function creates a new, transposed version of the id . This interchanges the row and column index of each
element.

SYNTAX

[Link](id) → matrix<type>

ARGUMENTS

id (any matrix type) A matrix object.

EXAMPLE

//@version=6
indicator("`[Link]()` Example")

// For efficiency, execute this code only once.

if [Link]
// Create a 2x2 matrix.
var m1 = [Link]<float>(2, 2, na)
// Fill the matrix with values.
[Link](m1, 0, 0, 1)
[Link](m1, 0, 1, 2)
[Link](m1, 1, 0, 3)
[Link](m1, 1, 1, 4)

// Create a transpose of the matrix.

var m2 = [Link](m1)

// Display using a table.

var t = [Link](position.top_right, 2, 2, [Link])
[Link](t, 0, 0, "Original matrix:")
[Link](t, 0, 1, [Link](m1))
[Link](t, 1, 0, "Transposed matrix:")
[Link](t, 1, 1, [Link](m2))

RETURNS

A new matrix containing the transposed version of the id matrix.

SEE ALSO

[Link]<type>() [Link]() [Link]() [Link]() [Link]() [Link]()

max_bars_back()
Function sets the maximum number of bars that is available for historical reference of a given built-in or user variable.
When operator '[]' is applied to a variable - it is a reference to a historical value of that variable.
If an argument of an operator '[]' is a compile time constant value (e.g. 'v[10]', 'close[500]') then there is no need to
use 'max_bars_back' function for that variable. Pine Script® compiler will use that constant value as history buffer
size.
If an argument of an operator '[]' is a value, calculated at runtime (e.g. 'v[i]' where 'i' - is a series variable) then Pine
Script® attempts to autodetect the history buffer size at runtime. Sometimes it fails and the script crashes at runtime
because it eventually refers to historical values that are out of the buffer. In that case you should use 'max_bars_back'
to fix that problem manually.

SYNTAX

max_bars_back(var, num) → void

ARGUMENTS

var (series int/float/bool/color/label/line) Series variable identifier for which history buffer should be resized.
Possible values are: 'open', 'high', 'low', 'close', 'volume', 'time', or any user defined variable id.

num (const int) History buffer size which is the number of bars that could be referenced for variable 'var'.

EXAMPLE

//@version=6
indicator("max_bars_back")
close_() => close
depth() => 400
d = depth()
v = close_()
max_bars_back(v, 500)
out = if bar_index > 0
v[d]
else
v
plot(out)

RETURNS

void

REMARKS

At the moment 'max_bars_back' cannot be applied to built-ins like 'hl2', 'hlc3', 'ohlc4'. Please use multiple
'max_bars_back' calls as workaround here (e.g. instead of a single ‘max_bars_back(hl2, 100)’ call you should call the
function twice: ‘max_bars_back(high, 100), max_bars_back(low, 100)’).

If the indicator() or strategy() 'max_bars_back' parameter is used, all variables in the indicator are affected. This may
result in excessive memory usage and cause runtime problems. When possible (i.e. when the cause is a variable rather
than a function), please use the max_bars_back() function instead.

minute(time, timezone) → series int

ARGUMENTS

time (series int) UNIX time in milliseconds.

RETURNS

Minute (in exchange timezone) for provided UNIX time.

REMARKS

UNIX time is the number of milliseconds that have elapsed since 00:00:00 UTC, 1 January 1970.

SEE ALSO

minute time() year() month() dayofmonth() dayofweek() hour() second()

month()

SYNTAX

month(time, timezone) → series int

ARGUMENTS

time (series int) UNIX time in milliseconds.

RETURNS

Month (in exchange timezone) for provided UNIX time.

REMARKS

UNIX time is the number of milliseconds that have elapsed since 00:00:00 UTC, 1 January 1970.

Note that this function returns the month based on the time of the bar's open. For overnight sessions (e.g. EURUSD,
where Monday session starts on Sunday, 17:00 UTC-4) this value can be lower by 1 than the month of the trading day.

SEE ALSO

month time() year() dayofmonth() dayofweek() hour() minute() second()

na() 2 overloads

Tests if x is na.

SYNTAX & OVERLOADS

na(x) → simple bool

na(x) → series bool

ARGUMENTS

x (simple int/float) Value to be tested.

EXAMPLE

//@version=6
indicator("na")
// Use the `na()` function to test for `na`.
plot(na(close[1]) ? close : close[1])
// ALTERNATIVE
// `nz()` also tests `close[1]` for `na`. It returns `close[1]` if it is not `na`, and `close` if it i
s.
plot(nz(close[1], close))

RETURNS

Returns true if x is na, false otherwise.

SEE ALSO

na fixnan() nz()

nz() 6 overloads

Replaces na (undefined) values with either a type-specific default value or a specified replacement.

SYNTAX & OVERLOADS

nz(source, replacement) → simple color

nz(source, replacement) → simple int

nz(source, replacement) → series color

nz(source, replacement) → series int

nz(source, replacement) → simple float

nz(source, replacement) → series float

ARGUMENTS

source (simple color) The source series to process.

replacement (simple color) Optional. The value the function uses to replace na values in the source series. The
default depends on the source type: 0 for "int", 0.0 for "float", or #00000000 for "color".

EXAMPLE

//@version=6
indicator("nz", overlay=true)
plot(nz([Link](close, 100)))

RETURNS

The value of source if it is not na . If the value of source is na , returns zero, or the replacement argument
when one is used.
SEE ALSO

na na() fixnan()

plot()
Plots a series of data on the chart.

SYNTAX

plot(series, title, color, linewidth, style, trackprice, histbase, offset, join, editable, show_last, displ
ay, format, precision, force_overlay, linestyle) → plot

ARGUMENTS

series (series int/float) Series of data to be plotted. Required argument.

title (const string) Title of the plot.

color (series color) Color of the plot. You can use constants like 'color=[Link]' or 'color=#ff001a' as well as
complex expressions like 'color = close >= open ? [Link] : [Link]'. Optional argument.
linewidth (input int) Width of the plotted line. Default value is 1. Not applicable to every style.

style (input plot_style) Type of plot. Possible values are: plot.style_line, plot.style_stepline,
plot.style_stepline_diamond, plot.style_histogram, plot.style_cross, plot.style_area, plot.style_columns,
plot.style_circles, plot.style_linebr, plot.style_areabr, plot.style_steplinebr. Default value is plot.style_line.
trackprice (input bool) If true then a horizontal price line will be shown at the level of the last indicator value. Default
is false.
histbase (input int/float) The price value used as the reference level when rendering plot with plot.style_histogram,
plot.style_columns or plot.style_area style. Default is 0.0.
offset (simple int) Shifts the plot to the left or to the right on the given number of bars. Default is 0.

join (input bool) If true then plot points will be joined with line, applicable only to plot.style_cross and plot.style_circles
styles. Default is false.

editable (input bool) If true then plot style will be editable in Format dialog. Default is true.
show_last (input int) Optional. The number of bars, counting backwards from the most recent bar, on which the
function can draw.
display (input plot_display) Controls where the plot's information is displayed. Display options support addition and
subtraction, meaning that using [Link] - display.status_line will display the plot's information
everywhere except in the script's status line. display.price_scale + display.status_line will display the
plot only in the price scale and status line. When display arguments such as display.price_scale have user-
controlled chart settings equivalents, the relevant plot information will only appear when all settings allow for it.
Possible values: [Link], [Link], display.data_window, display.price_scale, display.status_line, [Link].
Optional. The default is [Link].
format (input string) Determines whether the script formats the plot's values as prices, percentages, or volume
values. The argument passed to this parameter supersedes the format parameter of the indicator(), and strategy()
functions. Optional. The default is the format value used by the indicator()/strategy() function. Possible values:
[Link], [Link], [Link].

precision (input int) The number of digits after the decimal point the plot's values show on the chart pane's y-axis,
the script's status line, and the Data Window. Accepts a non-negative integer less than or equal to 16. The argument
passed to this parameter supersedes the precision parameter of the indicator() and strategy() functions. When
the function's format parameter uses [Link], the precision parameter will not affect the result, as the
decimal precision rules defined by [Link] supersede other precision settings. Optional. The default is the pre
cision value used by the indicator()/strategy() function.

force_overlay (const bool) If true, the plotted results will display on the main chart pane, even when the script
occupies a separate pane. Optional. The default is false.

linestyle (input plot_line_style) Optional. A modifier for plot styles that display lines. It specifies whether the plotted
line is solid (plot.linestyle_solid), dashed (plot.linestyle_dashed), or dotted (plot.linestyle_dotted). The modifier applies
only when the function uses one of the following style arguments: plot.style_line, plot.style_linebr,
plot.style_stepline, plot.style_stepline_diamond, and plot.style_area. The default is plot.linestyle_solid.

EXAMPLE

//@version=6
indicator("plot")
plot(high+low, title='Title', color=[Link](#00ffaa, 70), linewidth=2, style=plot.style_area, offset=
15, trackprice=true)

// You may fill the background between any two plots with a fill() function:
p1 = plot(open)
p2 = plot(close)
fill(p1, p2, color=[Link]([Link], 90))

RETURNS

A plot object, that can be used in fill()

SEE ALSO

plotshape() plotchar() plotarrow() barcolor() bgcolor() fill()

plotarrow()
Plots up and down arrows on the chart. Up arrow is drawn at every indicator positive value, down arrow is drawn at
every negative value. If indicator returns na then no arrow is drawn. Arrows has different height, the more absolute
indicator value the longer arrow is drawn.

SYNTAX

plotarrow(series, title, colorup, colordown, offset, minheight, maxheight, editable, show_last, display, fo
rmat, precision, force_overlay) → void

ARGUMENTS

series (series int/float) Series of data to be plotted as arrows. Required argument.

title (const string) Title of the plot.

colorup (series color) Color of the up arrows. Optional argument.

colordown (series color) Color of the down arrows. Optional argument.

offset (simple int) Shifts arrows to the left or to the right on the given number of bars. Default is 0.
minheight (input int) Minimal possible arrow height in pixels. Default is 5.

maxheight (input int) Maximum possible arrow height in pixels. Default is 100.
editable (input bool) If true then plotarrow style will be editable in Format dialog. Default is true.

show_last (input int) Optional. The number of bars, counting backwards from the most recent bar, on which the
function can draw.

format (input string) Determines whether the script formats the plot's values as prices, percentages, or volume
values. The argument passed to this parameter supersedes the format parameter of the indicator(), and strategy()
functions. Optional. The default is the format value used by the indicator()/strategy() function. Possible values:
[Link], [Link], [Link].
precision (input int) The number of digits after the decimal point the plot's values show on the chart pane's y-axis,
the script's status line, and the Data Window. Accepts a non-negative integer less than or equal to 16. The argument
passed to this parameter supersedes the precision parameter of the indicator() and strategy() functions. When
the function's format parameter uses [Link], the precision parameter will not affect the result, as the
decimal precision rules defined by [Link] supersede other precision settings. Optional. The default is the pre
cision value used by the indicator()/strategy() function.

force_overlay (const bool) If true, the plotted results will display on the main chart pane, even when the script
occupies a separate pane. Optional. The default is false.

EXAMPLE

//@version=6
indicator("plotarrow example", overlay=true)
codiff = close - open
plotarrow(codiff, colorup=[Link]([Link],40), colordown=[Link]([Link], 40))

REMARKS

Use plotarrow() function in conjunction with 'overlay=true' indicator() parameter!

SEE ALSO

plot() plotshape() plotchar() barcolor() bgcolor()

plotbar()
Plots ohlc bars on the chart.

SYNTAX

plotbar(open, high, low, close, title, color, editable, show_last, display, format, precision, force_overla
y) → void

ARGUMENTS

open (series int/float) Open series of data to be used as open values of bars. Required argument.

high (series int/float) High series of data to be used as high values of bars. Required argument.
low (series int/float) Low series of data to be used as low values of bars. Required argument.

close (series int/float) Close series of data to be used as close values of bars. Required argument.
title (const string) Title of the plotbar. Optional argument.

color (series color) Color of the ohlc bars. You can use constants like 'color=[Link]' or 'color=#ff001a' as well as
complex expressions like 'color = close >= open ? [Link] : [Link]'. Optional argument.

editable (input bool) If true then plotbar style will be editable in Format dialog. Default is true.
show_last (input int) Optional. The number of bars, counting backwards from the most recent bar, on which the
function can draw.
display (input plot_display) Controls where the plot's information is displayed. Display options support addition and
subtraction, meaning that using [Link] - display.status_line will display the plot's information
everywhere except in the script's status line. display.price_scale + display.status_line will display the
plot only in the price scale and status line. When display arguments such as display.price_scale have user-
controlled chart settings equivalents, the relevant plot information will only appear when all settings allow for it.
Possible values: [Link], [Link], display.data_window, display.price_scale, display.status_line, [Link].
Optional. The default is [Link].

force_overlay (const bool) If true, the plotted results will display on the main chart pane, even when the script
occupies a separate pane. Optional. The default is false.

EXAMPLE

//@version=6
indicator("plotbar example", overlay=true)
plotbar(open, high, low, close, title='Title', color = open < close ? [Link] : [Link])

REMARKS

Even if one value of open, high, low or close equal NaN then bar no draw.

The maximal value of open, high, low or close will be set as 'high', and the minimal value will be set as 'low'.

SEE ALSO

plotcandle()

plotcandle()
Plots candles on the chart.

SYNTAX

plotcandle(open, high, low, close, title, color, wickcolor, editable, show_last, bordercolor, display, form
at, precision, force_overlay) → void

ARGUMENTS

open (series int/float) Open series of data to be used as open values of candles. Required argument.
high (series int/float) High series of data to be used as high values of candles. Required argument.

low (series int/float) Low series of data to be used as low values of candles. Required argument.
close (series int/float) Close series of data to be used as close values of candles. Required argument.

title (const string) Title of the plotcandles. Optional argument.

color (series color) Color of the candles. You can use constants like 'color=[Link]' or 'color=#ff001a' as well as
complex expressions like 'color = close >= open ? [Link] : [Link]'. Optional argument.

wickcolor (series color) The color of the wick of candles. An optional argument.
editable (input bool) If true then plotcandle style will be editable in Format dialog. Default is true.

show_last (input int) Optional. The number of bars, counting backwards from the most recent bar, on which the
function can draw.

bordercolor (series color) The border color of candles. An optional argument.

display (input plot_display) Controls where the plot's information is displayed. Display options support addition and
subtraction, meaning that using [Link] - display.status_line will display the plot's information
everywhere except in the script's status line. display.price_scale + display.status_line will display the
plot only in the price scale and status line. When display arguments such as display.price_scale have user-
controlled chart settings equivalents, the relevant plot information will only appear when all settings allow for it.
Possible values: [Link], [Link], display.data_window, display.price_scale, display.status_line, [Link].
Optional. The default is [Link].
format (input string) Determines whether the script formats the plot's values as prices, percentages, or volume
values. The argument passed to this parameter supersedes the format parameter of the indicator(), and strategy()
functions. Optional. The default is the format value used by the indicator()/strategy() function. Possible values:
[Link], [Link], [Link].
precision (input int) The number of digits after the decimal point the plot's values show on the chart pane's y-axis,
the script's status line, and the Data Window. Accepts a non-negative integer less than or equal to 16. The argument
passed to this parameter supersedes the precision parameter of the indicator() and strategy() functions. When
the function's format parameter uses [Link], the precision parameter will not affect the result, as the
decimal precision rules defined by [Link] supersede other precision settings. Optional. The default is the pre
cision value used by the indicator()/strategy() function.

force_overlay (const bool) If true, the plotted results will display on the main chart pane, even when the script
occupies a separate pane. Optional. The default is false.

EXAMPLE

//@version=6
indicator("plotcandle example", overlay=true)
plotcandle(open, high, low, close, title='Title', color = open < close ? [Link] : [Link], wickc
olor=[Link])

REMARKS

Even if one value of open, high, low or close equal NaN then bar no draw.

The maximal value of open, high, low or close will be set as 'high', and the minimal value will be set as 'low'.

SEE ALSO

plotbar()

plotchar()
Plots visual shapes using any given one Unicode character on the chart.

SYNTAX

plotchar(series, title, char, location, color, offset, text, textcolor, editable, size, show_last, display,
format, precision, force_overlay) → void

ARGUMENTS

series (series int/float/bool) Series of data to be plotted as shapes. Series is treated as a series of boolean values for
all location values except [Link]. Required argument.
title (const string) Title of the plot.

char (input string) Character to use as a visual shape.

location (input string) Location of shapes on the chart. Possible values are: [Link], [Link],
[Link], [Link], [Link]. Default value is [Link].
color (series color) Color of the shapes. You can use constants like 'color=[Link]' or 'color=#ff001a' as well as
complex expressions like 'color = close >= open ? [Link] : [Link]'. Optional argument.
offset (simple int) Shifts shapes to the left or to the right on the given number of bars. Default is 0.

text (const string) Text to display with the shape. You can use multiline text, to separate lines use '\n' escape
sequence. Example: 'line one\nline two'.

textcolor (series color) Color of the text. You can use constants like 'textcolor=[Link]' or 'textcolor=#ff001a' as
well as complex expressions like 'textcolor = close >= open ? [Link] : [Link]'. Optional argument.

editable (input bool) If true then plotchar style will be editable in Format dialog. Default is true.
size (const string) Size of characters on the chart. Possible values are: [Link], [Link], [Link], [Link],
[Link], [Link]. Default is [Link].

show_last (input int) Optional. The number of bars, counting backwards from the most recent bar, on which the
function can draw.

force_overlay (const bool) If true, the plotted results will display on the main chart pane, even when the script
occupies a separate pane. Optional. The default is false.

EXAMPLE

//@version=6
indicator("plotchar example", overlay=true)
data = close >= open
plotchar(data, char='❄')

REMARKS

Use plotchar() function in conjunction with 'overlay=true' indicator() parameter!

SEE ALSO

plot() plotshape() plotarrow() barcolor() bgcolor()

plotshape()
Plots visual shapes on the chart.

SYNTAX

plotshape(series, title, style, location, color, offset, text, textcolor, editable, size, show_last, displa
y, format, precision, force_overlay) → void

ARGUMENTS

series (series int/float/bool) Series of data to be plotted as shapes. Series is treated as a series of boolean values for
all location values except [Link]. Required argument.

title (const string) Title of the plot.

style (input string) Type of plot. Possible values are: [Link], [Link], [Link],
[Link], [Link], [Link], [Link], [Link], [Link], [Link],
[Link], [Link]. Default value is [Link].

location (input string) Location of shapes on the chart. Possible values are: [Link], [Link],
[Link], [Link], [Link]. Default value is [Link].

color (series color) Color of the shapes. You can use constants like 'color=[Link]' or 'color=#ff001a' as well as
complex expressions like 'color = close >= open ? [Link] : [Link]'. Optional argument.
offset (simple int) Shifts shapes to the left or to the right on the given number of bars. Default is 0.

text (const string) Text to display with the shape. You can use multiline text, to separate lines use '\n' escape
sequence. Example: 'line one\nline two'.
textcolor (series color) Color of the text. You can use constants like 'textcolor=[Link]' or 'textcolor=#ff001a' as
well as complex expressions like 'textcolor = close >= open ? [Link] : [Link]'. Optional argument.

editable (input bool) If true then plotshape style will be editable in Format dialog. Default is true.
size (const string) Size of shapes on the chart. Possible values are: [Link], [Link], [Link], [Link],
[Link], [Link]. Default is [Link].
show_last (input int) Optional. The number of bars, counting backwards from the most recent bar, on which the
function can draw.
display (input plot_display) Controls where the plot's information is displayed. Display options support addition and
subtraction, meaning that using [Link] - display.status_line will display the plot's information
everywhere except in the script's status line. display.price_scale + display.status_line will display the
plot only in the price scale and status line. When display arguments such as display.price_scale have user-
controlled chart settings equivalents, the relevant plot information will only appear when all settings allow for it.
Possible values: [Link], [Link], display.data_window, display.price_scale, display.status_line, [Link].
Optional. The default is [Link].
format (input string) Determines whether the script formats the plot's values as prices, percentages, or volume
values. The argument passed to this parameter supersedes the format parameter of the indicator(), and strategy()
functions. Optional. The default is the format value used by the indicator()/strategy() function. Possible values:
[Link], [Link], [Link].

force_overlay (const bool) If true, the plotted results will display on the main chart pane, even when the script
occupies a separate pane. Optional. The default is false.

EXAMPLE

//@version=6
indicator("plotshape example 1", overlay=true)
data = close >= open
plotshape(data, style=[Link])

REMARKS

Use plotshape() function in conjunction with 'overlay=true' indicator() parameter!

SEE ALSO

plot() plotchar() plotarrow() barcolor() bgcolor()

[Link]()
Deletes the specified polyline object. It has no effect if the id doesn't exist.

SYNTAX

[Link](id) → void

ARGUMENTS

id (series polyline) The polyline ID to delete.

[Link]()
Creates a new polyline instance and displays it on the chart, sequentially connecting all of the points in the points
array with line segments. The segments in the drawing can be straight or curved depending on the curved
parameter.

SYNTAX

[Link](points, curved, closed, xloc, line_color, fill_color, line_style, line_width, force_overlay) →

series polyline

ARGUMENTS

points (array<[Link]>) An array of [Link] objects for the drawing to sequentially connect.
curved (series bool) If true, the drawing will connect all points from the points array using curved line segments.
Optional. The default is false.
closed (series bool) If true, the drawing will also connect the first point to the last point from the points array,
resulting in a closed polyline. Optional. The default is false.

xloc (series string) Determines the field of the [Link] objects in the points array that the polyline will use for
its x-coordinates. If xloc.bar_index, the polyline will use the index field from each point. If xloc.bar_time, it will use
the time field. Optional. The default is xloc.bar_index.

line_color (series color) The color of the line segments. Optional. The default is [Link].

fill_color (series color) The fill color of the polyline. Optional. The default is na.
line_style (series string) The style of the polyline. Possible values: line.style_solid, line.style_dotted,
line.style_dashed, line.style_arrow_left, line.style_arrow_right, line.style_arrow_both. Optional. The default is
line.style_solid.

line_width (series int) The width of the line segments, expressed in pixels. Optional. The default is 1.
force_overlay (const bool) If true, the drawing will display on the main chart pane, even when the script occupies a
separate pane. Optional. The default is false.

EXAMPLE

//@version=6
indicator("Polylines example", overlay = true)

//@variable If `true`, connects all points in the polyline with curved line segments.
bool curvedInput = [Link](false, "Curve Polyline")
//@variable If `true`, connects the first point in the polyline to the last point.
bool closedInput = [Link](true, "Close Polyline")
//@variable The color of the space filled by the polyline.
color fillcolor = [Link]([Link]([Link], 90), "Fill Color")

// Time and price inputs for the polyline's points.

p1x = [Link](0, "p1", confirm = true, inline = "p1")
p1y = [Link](0, " ", confirm = true, inline = "p1")
p2x = [Link](0, "p2", confirm = true, inline = "p2")
p2y = [Link](0, " ", confirm = true, inline = "p2")
p3x = [Link](0, "p3", confirm = true, inline = "p3")
p3y = [Link](0, " ", confirm = true, inline = "p3")
p4x = [Link](0, "p4", confirm = true, inline = "p4")
p4y = [Link](0, " ", confirm = true, inline = "p4")
p5x = [Link](0, "p5", confirm = true, inline = "p5")
p5y = [Link](0, " ", confirm = true, inline = "p5")

if [Link]
//@variable An array of `[Link]` objects for the new polyline.
var points = [Link]<[Link]>()
// Push new `[Link]` instances into the `points` array.
[Link]([Link].from_time(p1x, p1y))
[Link]([Link].from_time(p2x, p2y))
[Link]([Link].from_time(p3x, p3y))
[Link]([Link].from_time(p4x, p4y))
[Link]([Link].from_time(p5x, p5y))
// Add labels for each `[Link]` in `points`.
l1p1 = [Link]([Link](0), text = "p1", xloc = xloc.bar_time, color = na)
l1p2 = [Link]([Link](1), text = "p2", xloc = xloc.bar_time, color = na)
l2p1 = [Link]([Link](2), text = "p3", xloc = xloc.bar_time, color = na)
l2p2 = [Link]([Link](3), text = "p4", xloc = xloc.bar_time, color = na)
// Create a new polyline that connects each `[Link]` in the `points` array, starting from the
first.
[Link](points, curved = curvedInput, closed = closedInput, fill_color = fillcolor, xloc = xlo
c.bar_time)

RETURNS

The ID of a new polyline object that a script can use in other polyline.*() functions.

SEE ALSO

[Link]()

request.currency_rate()
Provides a daily rate that can be used to convert a value expressed in the from currency to another in the to
currency.

SYNTAX

request.currency_rate(from, to, ignore_invalid_currency) → series float

ARGUMENTS

from (series string) The currency in which the value to be converted is expressed. Possible values: a three-letter
string with the currency code in the ISO 4217 format (e.g. "USD"), or one of the built-in variables that return currency
codes, like [Link] or [Link].

to (series string) The currency in which the value is to be converted. Possible values: a three-letter string with the
currency code in the ISO 4217 format (e.g. "USD"), or one of the built-in variables that return currency codes, like
[Link] or [Link].

ignore_invalid_currency (series bool) Determines the behavior of the function if a conversion rate between the two
currencies cannot be calculated: if false, the script will halt and return a runtime error; if true, the function will return na
and execution will continue. Optional. The default is false.

EXAMPLE

//@version=6
indicator("Close in British Pounds")
rate = request.currency_rate([Link], "GBP")
plot(close * rate)

REMARKS

If from and to arguments are equal, function returns 1. Please note that using this variable/function can cause
indicator repainting.

[Link]()
Requests dividends data for the specified symbol.

SYNTAX

[Link](ticker, field, gaps, lookahead, ignore_invalid_symbol, currency) → series float

ARGUMENTS

ticker (series string) Symbol. Note that the symbol should be passed with a prefix. For example: "NASDAQ:AAPL"
instead of "AAPL". Using [Link] will cause an error. Use [Link] instead.
field (series string) Input string. Possible values include: [Link], [Link]. Default value is
[Link].
gaps (simple barmerge_gaps) Merge strategy for the requested data (requested data automatically merges with the
main series OHLC data). Possible values: barmerge.gaps_on, barmerge.gaps_off. barmerge.gaps_on - requested data
is merged with possible gaps (na values). barmerge.gaps_off - requested data is merged continuously without gaps,
all the gaps are filled with the previous nearest existing values. Default value is barmerge.gaps_off.

lookahead (simple barmerge_lookahead) Merge strategy for the requested data position. Possible values:
barmerge.lookahead_on, barmerge.lookahead_off. Default value is barmerge.lookahead_off starting from version 3.
Note that behavour is the same on real-time, and differs only on history.

ignore_invalid_symbol (input bool) An optional parameter. Determines the behavior of the function if the specified
symbol is not found: if false, the script will halt and return a runtime error; if true, the function will return na and
execution will continue. The default value is false.
currency (series string) Currency into which the symbol's currency-related dividends values (e.g. [Link])
are to be converted. The conversion rate depends on the previous daily value of a corresponding currency pair from
the most popular exchange. A spread symbol is used if no exchange provides the rate directly. Possible values: a
"string" representing a valid currency code (e.g., "USD" or "USDT") or a constant from the currency.* namespace
(e.g., [Link] or [Link]). The default is [Link].

EXAMPLE

//@version=6
indicator("[Link]")
s1 = [Link]("NASDAQ:BELFA")
plot(s1)
s2 = [Link]("NASDAQ:BELFA", [Link], gaps=barmerge.gaps_on, lookahead=[Link]
ad_on)
plot(s2)

RETURNS

Requested series, or n/a if there is no dividends data for the specified symbol.

SEE ALSO

[Link]() [Link]() [Link]() [Link]

[Link]()
Requests earnings data for the specified symbol.

SYNTAX

[Link](ticker, field, gaps, lookahead, ignore_invalid_symbol, currency) → series float

ARGUMENTS

ticker (series string) Symbol. Note that the symbol should be passed with a prefix. For example: "NASDAQ:AAPL"
instead of "AAPL". Using [Link] will cause an error. Use [Link] instead.

RETURNS

A footprint object containing Volume Footprint data for the bar in the current context.

[Link]()
Note: This function has been deprecated due to the API change from NASDAQ Data Link. Requests for "QUANDL"
symbols are no longer valid and requests for them return a runtime error.

Some of the data previously provided by this function is available on TradingView through other feeds, such as
"BCHAIN" or "FRED". Use Symbol Search to look for such data based on its description. Commitment of Traders (COT)
data can be requested using the official LibraryCOT library.
Requests Nasdaq Data Link (formerly Quandl) data for a symbol.

SYNTAX

[Link](ticker, gaps, index, ignore_invalid_symbol) → series float

ARGUMENTS

ticker (series string) Symbol. Note that the name of a time series and Quandl data feed should be divided by a
forward slash. For example: "CFTC/SB_FO_ALL".

gaps (simple barmerge_gaps) Merge strategy for the requested data (requested data automatically merges with the
main series: OHLC data). Possible values include: barmerge.gaps_on, barmerge.gaps_off. barmerge.gaps_on -
requested data is merged with possible gaps (na values). barmerge.gaps_off - requested data is merged continuously
without gaps, all the gaps are filled with the previous, nearest existing values. Default value is barmerge.gaps_off.
index (series int) A Quandl time-series column index.

EXAMPLE

//@version=6
indicator("[Link]")
f = [Link]("CFTC/SB_FO_ALL", barmerge.gaps_off, 0)
plot(f)

RETURNS

Requested series.

SEE ALSO

[Link]() [Link]

[Link]()
Requests the result of an expression from a specified context (symbol and timeframe).

SYNTAX

[Link](symbol, timeframe, expression, gaps, lookahead, ignore_invalid_symbol, currency, calc_bars

_count) → series <type>

ARGUMENTS

symbol (series string) Symbol or ticker identifier of the requested data. Use an empty string or [Link] to
request data using the chart's symbol. To retrieve data with additional modifiers (extended sessions, dividend
adjustments, non-standard chart types like Heikin Ashi and Renko, etc.), create a custom ticker ID for the request
using the functions in the ticker.* namespace.

timeframe (series string) Timeframe of the requested data. Use an empty string or [Link] to request data
from the chart's timeframe or the timeframe specified in the indicator() function. To request data from a different
timeframe, supply a valid timeframe string. See here to learn about specifying timeframe strings.
expression (variable, function, object, array, matrix, or map of series int/float/bool/string/color/enum, or a tuple
of these) The expression to calculate and return from the requested context. It can accept a built-in variable like close,
a user-defined variable, an expression such as [Link](close) / (high - low) , a function call that does
not use Pine Script® drawings, an object, a collection, or a tuple of expressions.
gaps (simple barmerge_gaps) Specifies how the returned values are merged on chart bars. Possible values:
barmerge.gaps_on, barmerge.gaps_off. With barmerge.gaps_on a value only appears on the current chart bar when it
first becomes available from the function's context, otherwise na is returned (thus a "gap" occurs). With
barmerge.gaps_off what would otherwise be gaps are filled with the latest known value returned, avoiding na values.
Optional. The default is barmerge.gaps_off.
lookahead (simple barmerge_lookahead) On historical bars only, returns data from the timeframe before it elapses.
Possible values: barmerge.lookahead_on, barmerge.lookahead_off. Has no effect on realtime values. Optional. The
default is barmerge.lookahead_off starting from Pine Script® v3. The default is barmerge.lookahead_on in v1 and v2.
WARNING: Using barmerge.lookahead_on at timeframes higher than the chart's without offsetting the expression
argument like in close[1] will introduce future leak in scripts, as the function will then return the close price
before it is actually known in the current context. As is explained in the User Manual's page on Repainting this will
produce misleading results.
ignore_invalid_symbol (input bool) Determines the behavior of the function if the specified symbol is not found: if
false, the script will halt and throw a runtime error; if true, the function will return na and execution will continue.
Optional. The default is false.

currency (series string) Optional. Specifies the target currency for converting values expressed in currency units
(e.g., open, high, low, close) or expressions involving such values. Literal values such as 200 are not converted. The
conversion rate for monetary values depends on the previous daily value of a corresponding currency pair from the
most popular exchange. A spread symbol is used if no exchange provides the rate directly. Possible values: a "string"
representing a valid currency code (e.g., "USD" or "USDT") or a constant from the currency.* namespace (e.g.,
[Link] or [Link]). The default is [Link].

calc_bars_count (simple int) Optional. Determines the maximum number of recent historical bars that the function
can request. If specified, the function evaluates the expression argument starting from that number of bars behind
the last historical bar in the requested dataset, treating those bars as the only available data. Limiting the number of
historical bars in a request can help improve calculation efficiency in some cases. The default is the same as the
number of chart bars available for the symbol and timeframe. The maximum number of bars that the function can
attempt to retrieve depends on the intrabar limit of the user's plan. However, the request cannot retrieve more bars
than are available in the dataset.

EXAMPLE

//@version=6
indicator("Simple `[Link]()` calls")
// Returns 1D close of the current symbol.
dailyClose = [Link]([Link], "1D", close)
plot(dailyClose)

// Returns the close of "AAPL" from the same timeframe as currently open on the chart.
aaplClose = [Link]("AAPL", [Link], close)
plot(aaplClose)

EXAMPLE

//@version=6
indicator("Advanced `[Link]()` calls")
// This calculates a 10-period moving average on the active chart.
sma = [Link](close, 10)
// This sends the `sma` calculation for execution in the context of the "AAPL" symbol at a "240" (4 hou
rs) timeframe.
aaplSma = [Link]("AAPL", "240", sma)
plot(aaplSma)

// To avoid differences on historical and realtime bars, you can use this technique, which only return
s a value from the higher timeframe on the bar after it completes:
indexHighTF = [Link] ? 1 : 0
indexCurrTF = [Link] ? 0 : 1
nonRepaintingClose = [Link]([Link], "1D", close[indexHighTF])[indexCurrTF]
plot(nonRepaintingClose, "Non-repainting close")

// Returns the 1H close of "AAPL", extended session included. The value is dividend-adjusted.
extendedTicker = [Link]("NASDAQ:AAPL", session = [Link], adjustment = [Link]
ends)
aaplExtAdj = [Link](extendedTicker, "60", close)
plot(aaplExtAdj)

// Returns the result of a user-defined function.

// The `max` variable is mutable, but we can pass it to `[Link]()` because it is wrapped in
a function.
allTimeHigh(source) =>
var max = source
max := [Link](max, source)
allTimeHigh1D = [Link]([Link], "1D", allTimeHigh(high))

// By using a tuple `expression`, we obtain several values with only one `[Link]()` call.
[open1D, high1D, low1D, close1D, ema1D] = [Link]([Link], "1D", [open, high, low, cl
ose, [Link](close, 10)])
plotcandle(open1D, high1D, low1D, close1D)
plot(ema1D)

// Returns an array containing the OHLC values of the chart's symbol from the 1D timeframe.
ohlcArray = [Link]([Link], "1D", [Link](open, high, low, close))
plotcandle([Link](ohlcArray, 0), [Link](ohlcArray, 1), [Link](ohlcArray, 2), [Link](ohlcArr
ay, 3))

RETURNS

A result determined by expression .

REMARKS

Scripts using this function might calculate differently on historical and realtime bars, leading to repainting.
A single script can contain no more than 40 unique request.*() function calls. A call is unique only if it does not
call the same function with the same arguments.

When using two calls to a request.*() function to evaluate the same expression from the same context with
different calc_bars_count values, the second call requests the same number of historical bars as the first. For
example, if a script calls [Link]("AAPL", "", close, calc_bars_count = 3) after it calls req
[Link]("AAPL", "", close, calc_bars_count = 5) , the second call also uses five bars of
historical data, not three.

The symbol of a request.() call can be inherited if it is not specified precisely, i.e., if the symbol argument is an
empty string or [Link]. Similarly, the timeframe of a request.() call can be inherited if the timeframe
argument is an empty string or [Link]. These values are normally taken from the chart on which the script is
running. However, if request.*() function A is called from within the expression of request.*() function B,
then function A can inherit the values from function B. See here for more information.

SEE ALSO

[Link] [Link] [Link] [Link]() [Link]() request.security_lower_tf()

[Link]() [Link]() [Link]() [Link]()

request.security_lower_tf()
Requests the results of an expression from a specified symbol on a timeframe lower than or equal to the chart's
timeframe. It returns an array containing one element for each lower-timeframe bar within the chart bar. On a 5-minute
chart, requesting data using a timeframe argument of "1" typically returns an array with five elements representing
the value of the expression on each 1-minute bar, ordered by time with the earliest value first.

SYNTAX
request.security_lower_tf(symbol, timeframe, expression, ignore_invalid_symbol, currency, ignore_invalid_ti
meframe, calc_bars_count) → array<type>

ARGUMENTS

ignore_invalid_symbol (series bool) Determines the behavior of the function if the specified symbol is not found: if
false, the script will halt and throw a runtime error; if true, the function will return na and execution will continue.
Optional. The default is false.
currency (series string) Optional. Specifies the target currency for converting values expressed in currency units
(e.g., open, high, low, close) or expressions involving such values. Literal values such as 200 are not converted. The
conversion rate for monetary values depends on the previous daily value of a corresponding currency pair from the
most popular exchange. A spread symbol is used if no exchange provides the rate directly. Possible values: a "string"
representing a valid currency code (e.g., "USD" or "USDT") or a constant from the currency.* namespace (e.g.,
[Link] or [Link]). The default is [Link].

ignore_invalid_timeframe (series bool) Determines the behavior of the function when the chart's timeframe is
smaller than the timeframe used in the function call. If false, the script will halt and throw a runtime error. If true, the
function will return na and execution will continue. Optional. The default is false.

EXAMPLE

//@version=6
indicator("`request.security_lower_tf()` Example", overlay = true)

// If the current chart timeframe is set to 120 minutes, then the `arrayClose` array will contain two '
close' values from the 60 minute timeframe for each bar.
arrClose = request.security_lower_tf([Link], "60", close)

if bar_index == last_bar_index - 1
[Link](bar_index, high, [Link](arrClose))

RETURNS

An array of a type determined by expression , or a tuple of these.

REMARKS

Scripts using this function might calculate differently on historical and realtime bars, leading to repainting.

Please note that spreads (e.g., "AAPL+MSFT*TSLA") do not always return reliable data with this function.
A single script can contain no more than 40 unique request.*() function calls. A call is unique only if it does not
call the same function with the same arguments.
When using two calls to a request.*() function to evaluate the same expression from the same context with
different calc_bars_count values, the second call requests the same number of historical bars as the first. For
example, if a script calls [Link]("AAPL", "", close, calc_bars_count = 3) after it calls req
[Link]("AAPL", "", close, calc_bars_count = 5) , the second call also uses five bars of
historical data, not three.

The symbol of a request.() call can be inherited if it is not specified precisely, i.e., if the symbol argument is an
empty string or [Link]. Similarly, the timeframe of a request.() call can be inherited if the timeframe
argument is an empty string or [Link]. These values are normally taken from the chart that the script is
running on. However, if request.*() function A is called from within the expression of request.*() function B,
then function A can inherit the values from function B. See here for more information.

SEE ALSO

[Link]() [Link] [Link] [Link] [Link]() [Link]()

[Link]() [Link]() [Link]()

[Link]()
Requests the result of an expression evaluated on data from a user-maintained GitHub repository. **Note:**The
creation of new Pine Seeds repositories is suspended; only existing repositories are currently supported. See the Pine
Seeds documentation on GitHub to learn more.

SYNTAX

[Link](source, symbol, expression, ignore_invalid_symbol, calc_bars_count) → series <type>

ARGUMENTS

source (series string) Name of the GitHub repository.

symbol (series string) Name of the file in the GitHub repository containing the data. The ".csv" file extension must not
be included.
expression (<arg_expr_type>) An expression to be calculated and returned from the requested symbol's context. It
can be a built-in variable like close, an expression such as [Link](close, 100) , a non-mutable variable
previously calculated in the script, a function call that does not use Pine Script® drawings, an array, a matrix, or a tuple.
Mutable variables are not allowed, unless they are enclosed in the body of a function used in the expression.
ignore_invalid_symbol (input bool) Determines the behavior of the function if the specified symbol is not found: if
false, the script will halt and throw a runtime error; if true, the function will return na and execution will continue.
Optional. The default is false.

calc_bars_count (simple int) Optional. If specified, the function requests only this number of values from the end of
the symbol's history and calculates expression as if these values are the only available data, which might improve
calculation speed in some cases. The default is the same as the number of chart bars available for the symbol and
timeframe. The maximum number of bars that the function can attempt to retrieve depends on the intrabar limit of the
user's plan. However, the request cannot retrieve more bars than are available in the dataset.

EXAMPLE

//@version=6
indicator("BTC Development Activity")

[devAct, devActSMA] = [Link]("seed_crypto_santiment", "BTC_DEV_ACTIVITY", [close, [Link](close, 1

0)])

plot(devAct, "BTC Development Activity")

plot(devActSMA, "BTC Development Activity SMA10", color = [Link])

RETURNS

Requested series or tuple of series, which may include array/matrix IDs.

[Link]()
Requests splits data for the specified symbol.

SYNTAX

[Link](ticker, field, gaps, lookahead, ignore_invalid_symbol) → series float

ARGUMENTS

ticker (series string) Symbol. Note that the symbol should be passed with a prefix. For example: "NASDAQ:AAPL"
instead of "AAPL". Using [Link] will cause an error. Use [Link] instead.

field (series string) Input string. Possible values include: [Link], [Link].

EXAMPLE

//@version=6
indicator("[Link]")
s1 = [Link]("NASDAQ:BELFA", [Link])
plot(s1)
s2 = [Link]("NASDAQ:BELFA", [Link], gaps=barmerge.gaps_on, lookahead=[Link]
head_on)
plot(s2)

RETURNS

Requested series, or n/a if there is no splits data for the specified symbol.

SEE ALSO

[Link]() [Link]() [Link]() [Link]

[Link]()
When called, causes a runtime error with the error message specified in the message argument.

SYNTAX

[Link](message) → void

ARGUMENTS

message (series string) Error message.

second()

SYNTAX

second(time, timezone) → series int

ARGUMENTS

time (series int) UNIX time in milliseconds.

RETURNS

Second (in exchange timezone) for provided UNIX time.

REMARKS

UNIX time is the number of milliseconds that have elapsed since 00:00:00 UTC, 1 January 1970.

SEE ALSO

second time() year() month() dayofmonth() dayofweek() hour() minute()

[Link]() 3 overloads

Returns true if the source string contains the str substring, false otherwise.

SYNTAX & OVERLOADS

[Link](source, str) → const bool

[Link](source, str) → simple bool

[Link](source, str) → series bool

ARGUMENTS

source (const string) Source string.

str (const string) The substring to search for.

EXAMPLE

//@version=6
indicator("[Link]")
// If the current chart is a continuous futures chart, e.g “BTC1!”, then the function will return tru
e, false otherwise.
var isFutures = [Link]([Link], "!")
plot(isFutures ? 1 : 0)

RETURNS

True if the str was found in the source string, false otherwise.

SEE ALSO

[Link]() [Link]()

[Link]() 3 overloads

Returns true if the source string ends with the substring specified in str , false otherwise.

SYNTAX & OVERLOADS

[Link](source, str) → const bool

[Link](source, str) → simple bool

[Link](source, str) → series bool

ARGUMENTS

source (const string) Source string.

str (const string) The substring to search for.

RETURNS

True if the source string ends with the substring specified in str , false otherwise.

SEE ALSO

[Link]()

[Link]() 2 overloads

Creates a formatted string using a specified formatting string ( formatString ) and one or more additional
arguments ( arg0 , arg1 , etc.). The formatting string defines the structure of the returned string, where all
placeholders in curly brackets ( {} ) refer to the additional arguments. Each placeholder requires a number
representing an argument's position, starting from 0. For instance, the placeholder {0} refers to the first argument
after formatString ( arg0 ), {1} refers to the second ( arg1 ), and so on. The function replaces each
placeholder with a string representation of the corresponding argument.

SYNTAX & OVERLOADS

[Link](formatString, arg0, arg1, ...) → simple string

[Link](formatString, arg0, arg1, ...) → series string

ARGUMENTS

formatString (simple string) Format string.

arg0, arg1, ... (simple int/float/bool/string) Values to format.

EXAMPLE

//@version=6
indicator("Simple `[Link]()` demo")

//@variable A formatted string that includes representations of the current `bar_index` and `close` val
ues.
// The placeholder `{0}` refers to the first argument after the formatting string (`bar_index
`), and
// `{1}` refers to the second (`close`).
string labelText = [Link]("Current bar index: {0}\nCurrent bar close: {1}", bar_index, close)

// Draw a label to display the `labelText` string at the current bar's `high` price.
[Link](bar_index, high, labelText)

EXAMPLE

//@version=6
indicator("Extensive `[Link]()` demo", overlay=true)
// The format specifier inside the curly braces accepts certain modifiers:
// - Specify the number of decimals to display:
s1 = [Link]("{0,number,#.#}", 1.34) // returns: 1.3
[Link](bar_index, close, text=s1)
// - Round a float value to an integer:
s2 = [Link]("{0,number,integer}", 1.34) // returns: 1
[Link](bar_index - 1, close, text=s2)
// - Display a number in currency:
s3 = [Link]("{0,number,currency}", 1.34) // returns: $1.34
[Link](bar_index - 2, close, text=s3)
// - Display a number as a percentage:
s4 = [Link]("{0,number,percent}", 0.5) // returns: 50%
[Link](bar_index - 3, close, text=s4)
// EXAMPLES WITH SEVERAL ARGUMENTS
// returns: Number 1 is not equal to 4
s5 = [Link]("Number {0} is not {1} to {2}", 1, "equal", 4)
[Link](bar_index - 4, close, text=s5)
// returns: 1.34 != 1.3
s6 = [Link]("{0} != {0, number, #.#}", 1.34)
[Link](bar_index - 5, close, text=s6)
// returns: 1 is equal to 1, but 2 is equal to 2
s7 = [Link]("{0, number, integer} is equal to 1, but {1, number, integer} is equal to 2", 1.34, 1.5
2)
[Link](bar_index - 6, close, text=s7)
// returns: The cash turnover amounted to $1,340,000.00
s8 = [Link]("The cash turnover amounted to {0, number, currency}", 1340000)
[Link](bar_index - 7, close, text=s8)
// returns: Expected return is 10% - 20%
s9 = [Link]("Expected return is {0, number, percent} - {1, number, percent}", 0.1, 0.2)
[Link](bar_index - 8, close, text=s9)

RETURNS

The formatted string.

REMARKS

The string used as the formatString argument can contain single quote characters ('). However, programmers
must pair all single quotes in that string to avoid unexpected formatting results.
All non-quoted left curly brackets must have corresponding right curly brackets in the formatting string. If the string
contains imbalanced left curly brackets, it causes a runtime error. For example, "ab {0} de" and "ab }{0} de" are valid
formatting strings, but "ab {0'}' de", "ab }{0}{ de" and "''{''{0}" are not.

The placeholders for "int" or "float" values or arrays can include modifiers and formatting tokens to customize how the
resulting string represents them.
For example, the placeholder {0,number,#.#) specifies that the result inserts characters representing the arg0
number rounded to one fractional digit.

For detailed information about placeholders and supported formats, refer to the Formatting strings section of our User
Manual's Strings page.

The apostrophe ( ' ) acts as a quote character rather than a literal character inside formatting strings. If a formatting
string has a sequence of characters between two apostrophes, the function's result includes those characters literally.
For instance, the substring '{' adds a literal { character to the result instead of treating it as the start of a
placeholder. Note that if a formatting string uses apostrophes instead of quotation marks for its enclosing characters,
the string must escape any apostrophes within the character sequence using the backslash.

str.format_time()
Converts the time timestamp into a string formatted according to format and timezone .

SYNTAX

str.format_time(time, format, timezone) → series string

ARGUMENTS

time (series int) UNIX time, in milliseconds.

format (series string) A format string specifying the date/time representation of the time in the returned string. All
letters used in the string, except those escaped by single quotation marks ' , are considered formatting tokens and
will be used as a formatting instruction. Refer to the Remarks section for a list of the most useful tokens. Optional. The
default is "yyyy-MM-dd'T'HH:mm:ssZ", which represents the ISO 8601 standard.
timezone (series string) Allows adjusting the returned value to a time zone specified in either UTC/GMT notation
(e.g., "UTC-5", "GMT+0530") or as an IANA time zone database name (e.g., "America/New_York"). Optional. The
default is [Link].
EXAMPLE

//@version=6
indicator("str.format_time")
if [Link]("1D")
formattedTime = str.format_time(time, "yyyy-MM-dd HH:mm", [Link])
[Link](bar_index, high, formattedTime)

RETURNS

The formatted string.

REMARKS

The M , d , h , H , m and s tokens can all be doubled to generate leading zeros. For example, the month of
January will display as 1 with M , or 01 with MM .

The most frequently used formatting tokens are:

y - Year. Use yy to output the last two digits of the year or yyyy to output all four. Year 2000 will be 00 with yy
or 2000 with yyyy .

M - Month. Not to be confused with lowercase m , which stands for minute.

d - Day of the month.

a - AM/PM postfix.
h - Hour in the 12-hour format. The last hour of the day will be 11 in this format.

H - Hour in the 24-hour format. The last hour of the day will be 23 in this format.

m - Minute.

s - Second.
S - Fractions of a second.

Z - Timezone, the HHmm offset from UTC, preceded by either + or - .

[Link]() 3 overloads

Returns an integer corresponding to the amount of chars in that string.

SYNTAX & OVERLOADS

[Link](string) → const int

[Link](string) → simple int

[Link](string) → series int

ARGUMENTS

string (const string) Source string.

RETURNS

The number of chars in source string.

[Link]() 3 overloads

Returns a new string with all letters converted to lowercase.

SYNTAX & OVERLOADS

[Link](source) → const string

[Link](source) → simple string

[Link](source) → series string

ARGUMENTS

source (const string) String to be converted.

RETURNS

A new string with all letters converted to lowercase.

SEE ALSO

[Link]()

[Link]() 2 overloads

Returns the new substring of the source string if it matches a regex regular expression, an empty string
otherwise.

SYNTAX & OVERLOADS

[Link](source, regex) → simple string

[Link](source, regex) → series string

ARGUMENTS

source (simple string) Source string.

regex (simple string) The regular expression to which this string is to be matched.

EXAMPLE

//@version=6
indicator("[Link]")

s = [Link]("It's time to sell some NASDAQ:AAPL!")

// finding first substring that matches regular expression "[\w]+:[\w]+"

var string tickerid = [Link](s, "[\\w]+:[\\w]+")

if [Link]
[Link](bar_index, high, text = tickerid) // "NASDAQ:AAPL"

RETURNS

The new substring of the source string if it matches a regex regular expression, an empty string otherwise.

REMARKS

Function returns first occurrence of the regular expression in the source string.

The backslash "\" symbol in the regex string needs to be escaped with additional backslash, e.g. "\\d" stands for
regular expression "\d".

SEE ALSO

[Link]() [Link]()

[Link]() 3 overloads

Returns the position of the first occurrence of the str string in the source string, 'na' otherwise.
SYNTAX & OVERLOADS

[Link](source, str) → const int

[Link](source, str) → simple int

[Link](source, str) → series int

ARGUMENTS

source (const string) Source string.

str (const string) The substring to search for.

RETURNS

Position of the str string in the source string.

REMARKS

Strings indexing starts at 0.

SEE ALSO

[Link]() [Link]() [Link]()

[Link]() 4 overloads

Constructs a new string containing the source string repeated repeat times with the separator injected
between each repeated instance.

SYNTAX & OVERLOADS

[Link](source, repeat, separator) → const string

[Link](source, repeat, separator) → input string

[Link](source, repeat, separator) → simple string

[Link](source, repeat, separator) → series string

ARGUMENTS

source (const string) String to repeat.

repeat (const int) Number of times to repeat the source string. Must be greater than or equal to 0.

separator (const string) String to inject between repeated values. Optional. The default is empty string.

EXAMPLE

//@version=6
indicator("[Link]")
repeat = [Link]("?", 3, ",") // Returns "?,?,?"
[Link](bar_index,close,repeat)

REMARKS

Returns na if the source is na.

[Link]() 3 overloads
Returns a new string with the Nth occurrence of the target string replaced by the replacement string, where N
is specified in occurrence .

SYNTAX & OVERLOADS

[Link](source, target, replacement, occurrence) → const string

[Link](source, target, replacement, occurrence) → simple string

[Link](source, target, replacement, occurrence) → series string

ARGUMENTS

source (const string) Source string.

target (const string) String to be replaced.

replacement (const string) String to be inserted instead of the target string.

occurrence (const int) N-th occurrence of the target string to replace. Indexing starts at 0 for the first match.
Optional. Default value is 0.

EXAMPLE

//@version=6
indicator("[Link]")
var source = "FTX:BTCUSD / FTX:BTCEUR"

// Replace first occurrence of "FTX" with "BINANCE" replacement string

var newSource = [Link](source, "FTX", "BINANCE", 0)

if [Link]
// Display "BINANCE:BTCUSD / FTX:BTCEUR"
[Link](bar_index, high, text = newSource)

RETURNS

Processed string.

SEE ALSO

str.replace_all() [Link]()

str.replace_all() 2 overloads

Replaces each occurrence of the target string in the source string with the replacement string.

SYNTAX & OVERLOADS

str.replace_all(source, target, replacement) → simple string

str.replace_all(source, target, replacement) → series string

ARGUMENTS

source (simple string) Source string.

target (simple string) String to be replaced.

replacement (simple string) String to be substituted for each occurrence of target string.

RETURNS

Processed string.
[Link]()
Divides a string into an array of substrings and returns its array id.

SYNTAX

[Link](string, separator) → array<string>

ARGUMENTS

string (series string) Source string.

separator (series string) The string separating each substring.

RETURNS

The id of an array of strings.

[Link]() 3 overloads

Returns true if the source string starts with the substring specified in str , false otherwise.

SYNTAX & OVERLOADS

[Link](source, str) → const bool

[Link](source, str) → simple bool

[Link](source, str) → series bool

ARGUMENTS

source (const string) Source string.

str (const string) The substring to search for.

RETURNS

True if the source string starts with the substring specified in str , false otherwise.

SEE ALSO

[Link]()

[Link]() 3 overloads

Returns a new string that is a substring of the source string. The substring begins with the character at the index
specified by begin_pos and extends to 'end_pos - 1' of the source string.

SYNTAX & OVERLOADS

[Link](source, begin_pos, end_pos) → const string

[Link](source, begin_pos, end_pos) → simple string

[Link](source, begin_pos, end_pos) → series string

ARGUMENTS

source (const string) Source string from which to extract the substring.
begin_pos (const int) The beginning position of the extracted substring. It is inclusive (the extracted substring
includes the character at that position).

end_pos (const int) The ending position. It is exclusive (the extracted string does NOT include that position's
character). Optional. The default is the length of the source string.

EXAMPLE

//@version=6
indicator("[Link]", overlay = true)
sym= [Link]("NASDAQ:AAPL")
pos = [Link](sym, ":") // Get position of ":" character
tkr= [Link](sym, pos+1) // "AAPL"
if [Link]
[Link](bar_index, high, text = tkr)

RETURNS

The substring extracted from the source string.

REMARKS

Strings indexing starts from 0. If begin_pos is equal to end_pos , the function returns an empty string.

SEE ALSO

[Link]() [Link]() [Link]()

[Link]() 4 overloads

Converts a value represented in string to its "float" equivalent.

SYNTAX & OVERLOADS

[Link](string) → const float

[Link](string) → input float

[Link](string) → simple float

[Link](string) → series float

ARGUMENTS

string (const string) String containing the representation of an integer or floating point value.

RETURNS

A "float" equivalent of the value in string . If the value is not a properly formed integer or floating point value, the
function returns na.

[Link]() 5 overloads

SYNTAX & OVERLOADS

[Link](value) → const string

[Link](value, format) → simple string

[Link](value, format) → series string

[Link](value) → simple string

[Link](value) → series string

ARGUMENTS

value (const enum) Value or array ID whose elements are converted to a string.

RETURNS

The string representation of the value argument.

If the value argument is a string, it is returned as is.

When the value is na, the function returns the string "NaN".

REMARKS

The formatting of float values will also round those values when necessary, e.g. [Link](3.99, '#') will return "4".
To display trailing zeros, use '0' instead of '#'. For example, '#.000'.

When using [Link], the value will be rounded to the nearest number that can be divided by [Link]
without the remainder. The string is returned with trailing zeros.

If the x argument is a string, the same string value will be returned.

Bool type arguments return "true" or "false".

When x is na, the function returns "NaN".

[Link]() 4 overloads

Constructs a new string with all consecutive whitespaces and other control characters (e.g., “\n”, “\t”, etc.) removed
from the left and right of the source .

SYNTAX & OVERLOADS

[Link](source) → const string

[Link](source) → input string

[Link](source) → simple string

[Link](source) → series string

ARGUMENTS

source (const string) String to trim.

EXAMPLE

//@version=6
indicator("[Link]")
trim = [Link](" abc ") // Returns "abc"
[Link](bar_index,close,trim)

REMARKS

Returns an empty string ("") if the result is empty after the trim or if the source is na.

[Link]() 3 overloads

Returns a new string with all letters converted to uppercase.

SYNTAX & OVERLOADS

[Link](source) → const string

[Link](source) → simple string

[Link](source) → series string

ARGUMENTS

source (const string) String to be converted.

RETURNS

A new string with all letters converted to uppercase.

SEE ALSO

[Link]()

strategy()
This declaration statement designates the script as a strategy and sets a number of strategy-related properties.

SYNTAX

strategy(title, shorttitle, overlay, format, precision, scale, pyramiding, calc_on_order_fills, calc_on_eve

ry_tick, max_bars_back, backtest_fill_limits_assumption, default_qty_type, default_qty_value, initial_capit
al, currency, slippage, commission_type, commission_value, process_orders_on_close, close_entries_rule, mar
gin_long, margin_short, explicit_plot_zorder, max_lines_count, max_labels_count, max_boxes_count, calc_bars
_count, risk_free_rate, use_bar_magnifier, fill_orders_on_standard_ohlc, max_polylines_count, dynamic_reque
sts, behind_chart) → void

ARGUMENTS

title (const string) The title of the script. It is displayed on the chart when no shorttitle argument is used, and
becomes the publication's default title when publishing the script.

shorttitle (const string) The script's display name on charts. If specified, it will replace the title argument in most
chart-related windows. Optional. The default is the argument used for title .

overlay (const bool) If true, the script's visuals appear on the main chart pane if the user adds it to the chart directly,
or in another script's pane if the user applies it to that script. If false, the script's visuals appear in a separate pane.
Changes to the overlay value apply only after the user adds the script to the chart again. Additionally, if the user
moves the script to another pane by selecting a "Move to" option in the script's "More" menu, it does not move back
to its original pane after any updates to the source code. The default is false. Strategy-specific labels that display
entries and exits will be displayed over the main chart regardless of this setting.

format (const string) Specifies the formatting of the script's displayed values. Possible values: [Link],
[Link], [Link], [Link]. Optional. The default is [Link].
precision (const int) Specifies the number of digits after the floating point of the script's displayed values. Must be a
non-negative integer no greater than 16. If format is set to [Link] and precision is specified, the format
will instead be set to [Link]. When the function's format parameter uses [Link], the precision
parameter will not affect the result, as the decimal precision rules defined by [Link] supersede other precision
settings. Optional. The default is inherited from the precision of the chart's symbol.
scale (const scale_type) The price scale used. Possible values: [Link], [Link], [Link]. The [Link]
value can only be applied in combination with overlay = true . Optional. By default, the script uses the same scale
as the chart.
pyramiding (const int) The maximum number of entries allowed in the same direction. If the value is 0, only one entry
order in the same direction can be opened, and additional entry orders are rejected. This setting can also be changed
in the strategy's "Settings/Properties" tab. Optional. The default is 0.

calc_on_order_fills (const bool) Specifies whether the strategy should be recalculated after an order is filled. If true,
the strategy recalculates after an order is filled, as opposed to recalculating only when the bar closes. This setting can
also be changed in the strategy's "Settings/Properties" tab. Optional. The default is false.

calc_on_every_tick (const bool) Specifies whether the strategy should be recalculated on each realtime tick. If true,
when the strategy is running on a realtime bar, it will recalculate on each chart update. If false, the strategy only
calculates when the realtime bar closes. The argument used does not affect strategy calculation on historical data.
This setting can also be changed in the strategy's "Settings/Properties" tab. Optional. The default is false.

max_bars_back (const int) The length of the historical buffer the script keeps for every variable and function, which
determines how many past values can be referenced using the [] history-referencing operator. The required buffer
size is automatically detected by the Pine Script® runtime. Using this parameter is only necessary when a runtime error
occurs because automatic detection fails. More information on the underlying mechanics of the historical buffer can be
found in our Help Center. Optional. The default is 0.
backtest_fill_limits_assumption (const int) Limit order execution threshold in ticks. When it is used, limit orders are
only filled if the market price exceeds the order's limit level by the specified number of ticks. Optional. The default is 0.
default_qty_type (const string) Specifies the units used for default_qty_value . Possible values are:
[Link] for contracts/shares/lots, [Link] for currency amounts, or strategy.percent_of_equity for a
percentage of available equity. This setting can also be changed in the strategy's "Settings/Properties" tab. Optional.
The default is [Link].
default_qty_value (const int/float) The default quantity to trade, in units determined by the argument used with the
default_qty_type parameter. This setting can also be changed in the strategy's "Settings/Properties" tab.
Optional. The default is 1.
initial_capital (const int/float) The amount of funds initially available for the strategy to trade, in units of currency .
Optional. The default is 1000000.

currency (const string) Currency used by the strategy in currency-related calculations. Market positions are still
opened by converting currency into the chart symbol's currency. The conversion rate depends on the previous
daily value of a corresponding currency pair from the most popular exchange. A spread symbol is used if no exchange
provides the rate directly. Possible values: a "string" representing a valid currency code (e.g., "USD" or "USDT") or a
constant from the currency.* namespace (e.g., [Link] or [Link]). The default is [Link].

slippage (const int) Slippage expressed in ticks. This value is added to or subtracted from the fill price of market/stop
orders to make the fill price less favorable for the strategy. E.g., if [Link] is 0.01 and slippage is set to 5, a
long market order will enter at 5 * 0.01 = 0.05 points above the actual price. This setting can also be changed in the
strategy's "Settings/Properties" tab. Optional. The default is 0.

commission_type (const string) Determines what the number passed to the commission_value expresses:
[Link] for a percentage of the cash volume of the order,
[Link].cash_per_contract for currency per contract, [Link].cash_per_order for currency
per order. This setting can also be changed in the strategy's "Settings/Properties" tab. Optional. The default is
[Link].
commission_value (const int/float) Commission applied to the strategy's orders in units determined by the argument
passed to the commission_type parameter. This setting can also be changed in the strategy's
"Settings/Properties" tab. Optional. The default is 0.

process_orders_on_close (const bool) When set to true, generates an additional attempt to execute orders after a
bar closes and strategy calculations are completed. If the orders are market orders, the broker emulator executes them
before the next bar's open. If the orders are price-dependent, they will only be filled if the price conditions are met.
This option is useful if you wish to close positions on the current bar. This setting can also be changed in the strategy's
"Settings/Properties" tab. Optional. The default is false.
close_entries_rule (const string) Determines the order in which trades are closed. Possible values are: "FIFO" (First-
In, First-Out) if the earliest exit order must close the earliest entry order, or "ANY" if the orders are closed based on the
from_entry parameter of the [Link]() function. "FIFO" can only be used with stocks, futures and US forex
(NFA Compliance Rule 2-43b), while "ANY" is allowed in non-US forex. Optional. The default is "FIFO".
margin_long (const int/float) Margin long is the percentage of the purchase price of a security that must be covered
by cash or collateral for long positions. Must be a non-negative number. The logic used to simulate margin calls is
explained in the Help Center. This setting can also be changed in the strategy's "Settings/Properties" tab. Optional. If
the value is 0, the strategy does not enforce any limits on position size. The default is 100, in which case the strategy
only uses its own funds and the long positions cannot be margin called.

margin_short (const int/float) Margin short is the percentage of the purchase price of a security that must be
covered by cash or collateral for short positions. Must be a non-negative number. The logic used to simulate margin
calls is explained in the Help Center. This setting can also be changed in the strategy's "Settings/Properties" tab.
Optional. If the value is 0, the strategy does not enforce any limits on position size. The default is 100, in which case
the strategy only uses its own funds. Note that even with no margin used, short positions can be margin called if the
loss exceeds available funds.
explicit_plot_zorder (const bool) Specifies the order in which the script's plots, fills, and hlines are rendered. If true,
plots are drawn in the order in which they appear in the script's code, each newer plot being drawn above the previous
ones. This only applies to plot*() functions, fill(), and hline(). Optional. The default is false.

max_lines_count (const int) The number of last line drawings displayed. Possible values: 1-500. Optional. The
default is 50.

max_labels_count (const int) The number of last label drawings displayed. Possible values: 1-500. Optional. The
default is 50.

max_boxes_count (const int) The number of last box drawings displayed. Possible values: 1-500. Optional. The
default is 50.

calc_bars_count (const int) Limits the initial calculation of a script to the last number of bars specified. When
specified, a "Calculated bars" field will be included in the "Calculation" section of the script's "Settings/Inputs" tab.
Optional. The default is 0, in which case the script executes on all available bars.
risk_free_rate (const int/float) The risk-free rate of return is the annual percentage change in the value of an
investment with minimal or zero risk. It is used to calculate the Sharpe and Sortino ratios. Optional. The default is 2.
use_bar_magnifier (const bool) Optional. When true, the Broker Emulator uses lower timeframe data during
backtesting on historical bars to achieve more realistic results. The default is false. Only Premium and higher-tier plans
have access to this feature.
fill_orders_on_standard_ohlc (const bool) When true, forces strategies running on Heikin Ashi charts to fill orders
using actual OHLC prices, for more realistic results. Optional. The default is false.
max_polylines_count (const int) The number of last polyline drawings displayed. Possible values: 1-100. The count
is approximate; more drawings than the specified count may be displayed. Optional. The default is 50.
dynamic_requests (const bool) Specifies whether the script can dynamically call functions from the request.*()
namespace. Dynamic request.*() calls are allowed within the local scopes of conditional structures (e.g., if), loops
(e.g., for), and exported functions. Additionally, such calls allow "series" arguments for many of their parameters.
Optional. The default is true. See the User Manual's Dynamic requests section for more information.

behind_chart (const bool) Optional. Controls whether all plots and drawings appear behind the chart display (if true)
or in front of it (if false). This parameter only takes effect when the overlay parameter is true . The default is true.

EXAMPLE

//@version=6
strategy("My strategy", overlay = true)

// Enter long by market if current open is greater than previous high.

if open > high[1]
[Link]("Long", [Link], 1)
// Generate a full exit bracket (profit 10 points, loss 5 points per contract) from the entry named "Lo
ng".
[Link]("Exit", "Long", profit = 10, loss = 5)

REMARKS

You can learn more about strategies in our User Manual.

Every strategy script must have one strategy() call.

Strategies using calc_on_every_tick = true parameter may calculate differently on historical and realtime
bars, which causes repainting.

Strategies always use the chart's prices to enter and exit positions. Using them on non-standard chart types (Heikin
Ashi, Renko, etc.) will produce misleading results, as their prices are synthetic. Backtesting on non-standard charts is
thus not recommended.
The maximum number of orders a strategy can open, unless it uses Deep Backtesting mode, is 9000. If the strategy
exceeds this limit, it removes the oldest order's information when a new entry appears in the "List of Trades" tab. The
[Link].*() functions return na for trades opened or closed by removed orders. To retrieve the
index of the oldest available closed trade, use the [Link].first_index variable.

SEE ALSO

indicator() library()

[Link]()
Cancels a pending or unfilled order with a specific identifier. If multiple unfilled orders share the same ID, calling this
command with that ID as the id argument cancels all of them. If a script calls this command with an id
representing the ID of a filled order, it has no effect.
This command is most useful when working with price-based orders (e.g., limit orders). Calls to this command can also
cancel market orders, but only if they execute on the same ticks as the order placement commands.

SYNTAX

[Link](id) → void

ARGUMENTS

id (series string) The identifier of the unfilled order to cancel.

EXAMPLE

//@version=6
strategy(title = "Order cancellation demo")

conditionForBuy = open > high[1]

if conditionForBuy
[Link]("Long", [Link], 1, limit = low) // Enter long using limit order at low price
of current bar if `conditionForBuy` is `true`.
if not conditionForBuy
[Link]("Long") // Cancel the entry order with name "Long" if `conditionForBuy` is `false`.

strategy.cancel_all()
Cancels all pending or unfilled orders, regardless of their identifiers.
This command is most useful when working with price-based orders (e.g., limit orders). Calls to this command can also
cancel market orders, but only if they execute on the same ticks as the order placement commands.

SYNTAX

strategy.cancel_all() → void

EXAMPLE

//@version=6
strategy(title = "Cancel all orders demo")
conditionForBuy1 = open > high[1]
if conditionForBuy1
[Link]("Long entry 1", [Link], 1, limit = low) // Enter long using a limit order if
`conditionForBuy1` is `true`.
conditionForBuy2 = conditionForBuy1 and open[1] > high[2]
float lowest2 = [Link](low, 2)
if conditionForBuy2
[Link]("Long entry 2", [Link], 1, limit = lowest2) // Enter long using a limit orde
r if `conditionForBuy2` is `true`.
conditionForStopTrading = open < lowest2
if conditionForStopTrading
strategy.cancel_all() // Cancel both limit orders if `conditionForStopTrading` is `true`.
[Link]()
Creates an order to exit from the part of a position opened by entry orders with a specific identifier. If multiple entries
in the position share the same ID, the orders from this command apply to all those entries, starting from the first open
trade, when its calls use that ID as the id argument.

This command always generates market orders. To exit from a position using price-based orders (e.g., stop-loss
orders), use the [Link]() command.

SYNTAX

[Link](id, comment, qty, qty_percent, alert_message, immediately, disable_alert) → void

ARGUMENTS

id (series string) The entry identifier of the open trades to close.

comment (series string) Optional. Additional notes on the filled order. If the value is not an empty string, the Strategy
Tester and the chart show this text for the order instead of the automatically generated exit identifier. The default is an
empty string.

qty_percent (series int/float) Optional. A value between 0 and 100 representing the percentage of the open trade
quantity to close when an exit order fills. The percentage calculation depends on the total size of the open trades with
the id entry identifier. The command ignores this parameter if the qty value is not na. The default is 100.

alert_message (series string) Optional. Custom text for the alert that fires when an order fills. If the "Message" field
of the "Create Alert" dialog box contains the {{[Link].alert_message}} placeholder, the alert
message replaces the placeholder with this text. The default is an empty string.
immediately (series bool) Optional. If true, the closing order executes on the same tick when the strategy places it,
ignoring the strategy properties that restrict execution to the opening tick of the following bar. The default is false.
disable_alert (series bool) Optional. If true when the command creates an order, the strategy does not trigger an
alert when that order fills. This parameter accepts a "series" value, meaning users can control which orders trigger
alerts when they execute. The default is false.

EXAMPLE

//@version=6
strategy("Partial close strategy")

// Calculate a 14-bar and 28-bar moving average of `close` prices.

float sma14 = [Link](close, 14)
float sma28 = [Link](close, 28)

// Place a market order to enter a long position when `sma14` crosses over `sma28`.
if [Link](sma14, sma28)
[Link]("My Long Entry ID", [Link])

// Place a market order to close the long trade when `sma14` crosses under `sma28`.
if [Link](sma14, sma28)
[Link]("My Long Entry ID", "50% market close", qty_percent = 50)

// Plot the position size.

plot(strategy.position_size)

REMARKS

When a position consists of several open trades and the close_entries_rule in the strategy() declaration
statement is "FIFO" (default), a [Link]() call exits from the position starting with the first open trade. This
behavior applies even if the id value is the entry ID of different open trades. However, in that case, the maximum exit
order size still depends on the trades opened by orders with the id identifier. For more information, see this section
of our User Manual.

strategy.close_all()
Creates an order to close an open position completely, regardless of the identifiers of the entry orders that opened or
added to it.
This command always generates market orders. To exit from a position using price-based orders (e.g., stop-loss
orders), use the [Link]() command.

SYNTAX

strategy.close_all(comment, alert_message, immediately, disable_alert) → void

ARGUMENTS

EXAMPLE

//@version=6
strategy("Multi-entry close strategy")

// Calculate a 14-bar and 28-bar moving average of `close` prices.

float sma14 = [Link](close, 14)
float sma28 = [Link](close, 28)

// Place a market order to enter a long trade every time `sma14` crosses over `sma28`.
if [Link](sma14, sma28)
[Link]("My Long Entry ID " + [Link]([Link]), [Link])

// Place a market order to close the entire position every 500 bars.
if bar_index % 500 == 0
strategy.close_all()

// Plot the position size.

plot(strategy.position_size)

[Link]()
Returns the sum of entry and exit fees paid in the closed trade, expressed in strategy.account_currency.

SYNTAX

[Link](trade_num) → series float

ARGUMENTS

trade_num (series int) The trade number of the closed trade. The number of the first trade is zero.

EXAMPLE
//@version=6
strategy("`[Link]` Example", commission_type = [Link], c
ommission_value = 0.1)

// Strategy calls to enter long trades every 15 bars and exit long trades every 20 bars.
if bar_index % 15 == 0
[Link]("Long", [Link])
if bar_index % 20 == 0
[Link]("Long")

// Plot total fees for the latest closed trade.

plot([Link]([Link] - 1))

SEE ALSO

strategy() [Link]()

[Link].entry_bar_index()
Returns the bar_index of the closed trade's entry.

SYNTAX

[Link].entry_bar_index(trade_num) → series int

ARGUMENTS

trade_num (series int) The trade number of the closed trade. The number of the first trade is zero.

EXAMPLE

//@version=6
strategy("[Link].entry_bar_index Example")
// Enter long trades on three rising bars; exit on two falling bars.
if [Link](close, 3)
[Link]("Long", [Link])
if [Link](close, 2)
[Link]("Long")
// Function that calculates the average amount of bars in a trade.
avgBarsPerTrade() =>
sumBarsPerTrade = 0
for tradeNo = 0 to [Link] - 1
// Loop through all closed trades, starting with the oldest.
sumBarsPerTrade += [Link].exit_bar_index(tradeNo) - [Link].entry_
bar_index(tradeNo) + 1
result = nz(sumBarsPerTrade / [Link])
plot(avgBarsPerTrade())

SEE ALSO

[Link].exit_bar_index() [Link].entry_bar_index()

[Link].entry_comment()
Returns the comment message of the closed trade's entry, or na if there is no entry with this trade_num .

SYNTAX

[Link].entry_comment(trade_num) → series string

ARGUMENTS

trade_num (series int) The trade number of the closed trade. The number of the first trade is zero.

EXAMPLE
//@version=6
strategy("`[Link].entry_comment()` Example", overlay = true)

stopPrice = open * 1.01

longCondition = [Link]([Link](close, 14), [Link](close, 28))

if (longCondition)
[Link]("Long", [Link], stop = stopPrice, comment = [Link](stopPric
e, "#.####"))
[Link]("EXIT", trail_points = 1000, trail_offset = 0)

var testTable = [Link](position.top_right, 1, 3, [Link], border_width = 1)

if [Link] or [Link]
[Link](testTable, 0, 0, 'Last closed trade:')
[Link](testTable, 0, 1, "Order stop price value: " + [Link].entry_comment(strate
[Link] - 1))
[Link](testTable, 0, 2, "Actual Entry Price: " + [Link]([Link].entry_pric
e([Link] - 1)))

SEE ALSO

strategy() [Link]() [Link]

[Link].entry_id()
Returns the id of the closed trade's entry.

SYNTAX

[Link].entry_id(trade_num) → series string

ARGUMENTS

trade_num (series int) The trade number of the closed trade. The number of the first trade is zero.

EXAMPLE

//@version=6
strategy("[Link].entry_id Example", overlay = true)

// Enter a short position and close at the previous to last bar.

if bar_index == 1
[Link]("Short at bar #" + [Link](bar_index), [Link])
if bar_index == last_bar_index - 2
strategy.close_all()

// Display ID of the last entry position.

if [Link]
[Link](last_bar_index, high, "Last Entry ID is: " + [Link].entry_id([Link]
edtrades - 1))

RETURNS

Returns the id of the closed trade's entry.

REMARKS

The function returns na if trade_num is not in the range: 0 to [Link]-1.

SEE ALSO

[Link].entry_bar_index() [Link].entry_price() [Link].entry_time()

[Link].entry_price()
Returns the price of the closed trade's entry.
SYNTAX

[Link].entry_price(trade_num) → series float

ARGUMENTS

trade_num (series int) The trade number of the closed trade. The number of the first trade is zero.

EXAMPLE

//@version=6
strategy("[Link].entry_price Example 1")

// Strategy calls to enter long trades every 15 bars and exit long trades every 20 bars.
if bar_index % 15 == 0
[Link]("Long", [Link])
if bar_index % 20 == 0
[Link]("Long")

// Return the entry price for the latest entry.

entryPrice = [Link].entry_price([Link] - 1)

plot(entryPrice, "Long entry price")

EXAMPLE

// Calculates the average profit percentage for all closed trades.

//@version=6
strategy("[Link].entry_price Example 2")

// Strategy calls to create single short and long trades

if bar_index == last_bar_index - 15
[Link]("Long Entry", [Link])
else if bar_index == last_bar_index - 10
[Link]("Long Entry")
[Link]("Short", [Link])
else if bar_index == last_bar_index - 5
[Link]("Short")

// Calculate profit for both closed trades.

profitPct = 0.0
for tradeNo = 0 to [Link] - 1
entryP = [Link].entry_price(tradeNo)
exitP = [Link].exit_price(tradeNo)
profitPct += (exitP - entryP) / entryP * [Link](tradeNo) * 100

// Calculate average profit percent for both closed trades.

avgProfitPct = nz(profitPct / [Link])

plot(avgProfitPct)

SEE ALSO

[Link].entry_price() [Link].exit_price() [Link]() [Link]

[Link].entry_time()
Returns the UNIX time of the closed trade's entry, expressed in milliseconds..

SYNTAX

[Link].entry_time(trade_num) → series int

ARGUMENTS

trade_num (series int) The trade number of the closed trade. The number of the first trade is zero.
EXAMPLE

//@version=6
strategy("[Link].entry_time Example", overlay = true)

// Enter long trades on three rising bars; exit on two falling bars.
if [Link](close, 3)
[Link]("Long", [Link])
if [Link](close, 2)
[Link]("Long")

// Calculate the average trade duration

avgTradeDuration() =>
sumTradeDuration = 0
for i = 0 to [Link] - 1
sumTradeDuration += [Link].exit_time(i) - [Link].entry_time(i)
result = nz(sumTradeDuration / [Link])

// Display average duration converted to seconds and formatted using 2 decimal points
if [Link]
[Link](bar_index, high, [Link](avgTradeDuration() / 1000, "#.##") + " seconds")

SEE ALSO

[Link].entry_time() [Link].exit_time() time

[Link].exit_bar_index()
Returns the bar_index of the closed trade's exit.

SYNTAX

[Link].exit_bar_index(trade_num) → series int

ARGUMENTS

trade_num (series int) The trade number of the closed trade. The number of the first trade is zero.

EXAMPLE

//@version=6
strategy("[Link].exit_bar_index Example 1")

// Strategy calls to place a single short trade. We enter the trade at the first bar and exit the trad
e at 10 bars before the last chart bar.
if bar_index == 0
[Link]("Short", [Link])
if bar_index == last_bar_index - 10
[Link]("Short")

// Calculate the amount of bars since the last closed trade.

barsSinceClosed = [Link] > 0 ? bar_index - [Link].exit_bar_index(strateg
[Link] - 1) : na

plot(barsSinceClosed, "Bars since last closed trade")

EXAMPLE

// Calculates the average amount of bars per trade.

//@version=6
strategy("[Link].exit_bar_index Example 2")

// Enter long trades on three rising bars; exit on two falling bars.
if [Link](close, 3)
[Link]("Long", [Link])
if [Link](close, 2)
[Link]("Long")
// Function that calculates the average amount of bars per trade.
avgBarsPerTrade() =>
sumBarsPerTrade = 0
for tradeNo = 0 to [Link] - 1
// Loop through all closed trades, starting with the oldest.
sumBarsPerTrade += [Link].exit_bar_index(tradeNo) - [Link].entry_
bar_index(tradeNo) + 1
result = nz(sumBarsPerTrade / [Link])

plot(avgBarsPerTrade())

SEE ALSO

bar_index last_bar_index

[Link].exit_comment()
Returns the comment message of the closed trade's exit, or na if there is no entry with this trade_num .

SYNTAX

[Link].exit_comment(trade_num) → series string

ARGUMENTS

trade_num (series int) The trade number of the closed trade. The number of the first trade is zero.

EXAMPLE

//@version=6
strategy("`[Link].exit_comment()` Example", overlay = true)

longCondition = [Link]([Link](close, 14), [Link](close, 28))

if (longCondition)
[Link]("Long", [Link])
[Link]("Exit", stop = open * 0.95, limit = close * 1.05, trail_points = 100, trail_offset =
0, comment_profit = "TP", comment_loss = "SL", comment_trailing = "TRAIL")

exitStats() =>
int slCount = 0
int tpCount = 0
int trailCount = 0

if [Link] > 0
for i = 0 to [Link] - 1
switch [Link].exit_comment(i)
"TP" => tpCount += 1
"SL" => slCount += 1
"TRAIL" => trailCount += 1
[slCount, tpCount, trailCount]

var testTable = [Link](position.top_right, 1, 4, [Link], border_width = 1)

if [Link]
[slCount, tpCount, trailCount] = exitStats()
[Link](testTable, 0, 0, "Closed trades (" + [Link]([Link]) +") stats:")
[Link](testTable, 0, 1, "Stop Loss: " + [Link](slCount))
[Link](testTable, 0, 2, "Take Profit: " + [Link](tpCount))
[Link](testTable, 0, 3, "Trailing Stop: " + [Link](trailCount))

SEE ALSO

strategy() [Link]() [Link]() [Link]()

[Link].exit_id()
Returns the id of the closed trade's exit.
SYNTAX

[Link].exit_id(trade_num) → series string

ARGUMENTS

trade_num (series int) The trade number of the closed trade. The number of the first trade is zero.

EXAMPLE

//@version=6
strategy("[Link].exit_id Example", overlay = true)

// Strategy calls to create single short and long trades

if bar_index == last_bar_index - 15
[Link]("Long Entry", [Link])
else if bar_index == last_bar_index - 10
[Link]("Short Entry", [Link])

// When a new open trade is detected then we create the exit strategy corresponding with the matching e
ntry id
// We detect the correct entry id by determining if a position is long or short based on the position q
uantity
if [Link]([Link]) != 0
posSign = [Link]([Link] - 1)
[Link](posSign > 0 ? "SL Long Exit" : "SL Short Exit", [Link].entry_id(strateg
[Link] - 1), stop = posSign > 0 ? high - [Link] : low + [Link])

// When a new closed trade is detected then we place a label above the bar with the exit info
if [Link]([Link]) != 0
msg = "Trade closed by: " + [Link].exit_id([Link] - 1)
[Link](bar_index, high + (3 * [Link]), msg)

RETURNS

Returns the id of the closed trade's exit.

REMARKS

The function returns na if trade_num is not in the range: 0 to [Link]-1.

SEE ALSO

[Link].exit_bar_index() [Link].exit_price() [Link].exit_time()

[Link].exit_price()
Returns the price of the closed trade's exit.

SYNTAX

[Link].exit_price(trade_num) → series float

ARGUMENTS

trade_num (series int) The trade number of the closed trade. The number of the first trade is zero.

EXAMPLE

//@version=6
strategy("[Link].exit_price Example 1")

// We are creating a long trade every 5 bars

if bar_index % 5 == 0
[Link]("Long", [Link])
[Link]("Long")

// Return the exit price from the latest closed trade.

exitPrice = [Link].exit_price([Link] - 1)
plot(exitPrice, "Long exit price")

EXAMPLE

// Calculates the average profit percentage for all closed trades.

//@version=6
strategy("[Link].exit_price Example 2")

// Strategy calls to create single short and long trades.

// Calculate profit for both closed trades.

profitPct = 0.0
for tradeNo = 0 to [Link] - 1
entryP = [Link].entry_price(tradeNo)
exitP = [Link].exit_price(tradeNo)
profitPct += (exitP - entryP) / entryP * [Link](tradeNo) * 100

// Calculate average profit percent for both closed trades.

avgProfitPct = nz(profitPct / [Link])

plot(avgProfitPct)

SEE ALSO

[Link].entry_price()

[Link].exit_time()
Returns the UNIX time of the closed trade's exit, expressed in milliseconds.

SYNTAX

[Link].exit_time(trade_num) → series int

ARGUMENTS

trade_num (series int) The trade number of the closed trade. The number of the first trade is zero.

EXAMPLE

//@version=6
strategy("[Link].exit_time Example 1")

// Enter long trades on three rising bars; exit on two falling bars.
if [Link](close, 3)
[Link]("Long", [Link])
if [Link](close, 2)
[Link]("Long")

// Calculate the average trade duration.

avgTradeDuration() =>
sumTradeDuration = 0
for i = 0 to [Link] - 1
sumTradeDuration += [Link].exit_time(i) - [Link].entry_time(i)
result = nz(sumTradeDuration / [Link])

// Display average duration converted to seconds and formatted using 2 decimal points.
if [Link]
[Link](bar_index, high, [Link](avgTradeDuration() / 1000, "#.##") + " seconds")
EXAMPLE

// Reopens a closed trade after X seconds.

//@version=6
strategy("[Link].exit_time Example 2")

// Strategy calls to emulate a single long trade at the first bar.

[Link].max_runup_percent(trade_num) → series float

ARGUMENTS

trade_num (series int) The trade number of the closed trade. The number of the first trade is zero.
SEE ALSO

[Link].max_runup() strategy.max_runup

[Link]()
Returns the profit/loss of the closed trade in the strategy's account currency, reduced by the trade's commissions. A
positive returned value represents a profit, and a negative value represents a loss.

SYNTAX

[Link](trade_num) → series float

ARGUMENTS

trade_num (series int) The trade number of the closed trade. The number of the first trade is zero.

EXAMPLE

//@version=6
strategy("`[Link]()` example")

// Enter a long trade every 15 bars, and close a long trade every 20 bars.
if bar_index % 15 == 0
[Link]("Long", [Link])
if bar_index % 20 == 0
[Link]("Long")

//@function Calculates the average gross profit from all available closed trades.
avgGrossProfit() =>
var float result = 0.0
if result == 0.0 or [Link] > [Link][1]
float sumGrossProfit = 0.0
for tradeNo = 0 to [Link] - 1
sumGrossProfit += [Link](tradeNo)
result := nz(sumGrossProfit / [Link])
result

plot(avgGrossProfit(), "Average gross profit")

SEE ALSO

strategy.account_currency [Link]() [Link]()

[Link].profit_percent()
Returns the profit/loss value of the closed trade, expressed as a percentage. Losses are expressed as negative values.

SYNTAX

[Link].profit_percent(trade_num) → series float

ARGUMENTS

trade_num (series int) The trade number of the closed trade. The number of the first trade is zero.

SEE ALSO

[Link]()

[Link]()
Returns the direction and the number of contracts traded in the closed trade. If the value is > 0, the market position
was long. If the value is < 0, the market position was short.
SYNTAX

[Link](trade_num) → series float

ARGUMENTS

trade_num (series int) The trade number of the closed trade. The number of the first trade is zero.

EXAMPLE

//@version=6
strategy("`[Link]` Example 1")

// We calculate the max amt of shares we can buy.

amtShares = [Link]([Link] / close)
// Strategy calls to enter long trades every 15 bars and exit long trades every 20 bars
if bar_index % 15 == 0
[Link]("Long", [Link], qty = amtShares)
if bar_index % 20 == 0
[Link]("Long")

// Plot the number of contracts traded in the last closed trade.

plot([Link]([Link] - 1), "Number of contracts traded")

EXAMPLE

// Calculates the average profit percentage for all closed trades.

//@version=6
strategy("`[Link]` Example 2")

// Strategy calls to enter long trades every 15 bars and exit long trades every 20 bars.
if bar_index % 15 == 0
[Link]("Long", [Link])
if bar_index % 20 == 0
[Link]("Long")

// Calculate profit for both closed trades.

profitPct = 0.0
for tradeNo = 0 to [Link] - 1
entryP = [Link].entry_price(tradeNo)
exitP = [Link].exit_price(tradeNo)
profitPct += (exitP - entryP) / entryP * [Link](tradeNo) * 100

// Calculate average profit percent for both closed trades.

avgProfitPct = nz(profitPct / [Link])

plot(avgProfitPct)

SEE ALSO

[Link]() strategy.position_size [Link] [Link]

strategy.convert_to_account()
Converts the value from the currency that the symbol on the chart is traded in ([Link]) to the currency used
by the strategy (strategy.account_currency).

SYNTAX

strategy.convert_to_account(value) → series float

ARGUMENTS

value (series int/float) The value to be converted.

EXAMPLE
//@version=6
strategy("`strategy.convert_to_account` Example 1", currency = [Link])

plot(close, "Close price using default currency")

plot(strategy.convert_to_account(close), "Close price converted to strategy currency")

EXAMPLE

// Calculates the "Buy and hold return" using your account's currency.
//@version=6
strategy("`strategy.convert_to_account` Example 2", currency = [Link])

dateInput = [Link](timestamp("20 Jul 2021 00:00 +0300"), "From Date", confirm = true)

buyAndHoldReturnPct(fromDate) =>
if time >= fromDate
money = close * [Link]
var initialBal = strategy.convert_to_account(money)
(strategy.convert_to_account(money) - initialBal) / initialBal * 100

plot(buyAndHoldReturnPct(dateInput))

SEE ALSO

strategy() strategy.convert_to_symbol()

strategy.convert_to_symbol()
Converts the value from the currency used by the strategy (strategy.account_currency) to the currency that the
symbol on the chart is traded in ([Link]).

SYNTAX

strategy.convert_to_symbol(value) → series float

ARGUMENTS

value (series int/float) The value to be converted.

EXAMPLE

//@version=6
strategy("`strategy.convert_to_symbol` Example", currency = [Link])

// Calculate the max qty we can buy using current chart's currency.
calcContracts(accountMoney) =>
[Link](strategy.convert_to_symbol(accountMoney) / [Link] / close)

// Return max qty we can buy using 300 euros

qt = calcContracts(300)

// Strategy calls to enter long trades every 15 bars and exit long trades every 20 bars using our custo
m qty.
if bar_index % 15 == 0
[Link]("Long", [Link], qty = qt)
if bar_index % 20 == 0
[Link]("Long")

SEE ALSO

strategy() strategy.convert_to_account()

strategy.default_entry_qty()
Calculates the default quantity, in units, of an entry order from [Link]() or [Link]() if it were to fill at the
specified fill_price value. The calculation depends on several strategy properties, including default_qty_typ
e , default_qty_value , currency , and other parameters in the strategy() function and their representation in
the "Properties" tab of the strategy's settings.

SYNTAX

strategy.default_entry_qty(fill_price) → series float

ARGUMENTS

fill_price (series int/float) The fill price for which to calculate the default order quantity.

EXAMPLE

//@version=6
strategy("Supertrend Strategy", overlay = true, default_qty_type = strategy.percent_of_equity, default_
qty_value = 15)

//@variable The length of the ATR calculation.

atrPeriod = input(10, "ATR Length")
//@variable The ATR multiplier.
factor = [Link](3.0, "Factor", step = 0.01)
//@variable The tick offset of the stop order.
stopOffsetInput = [Link](100, "Tick offset for entry stop")

// Get the direction of the SuperTrend.

[_, direction] = [Link](factor, atrPeriod)

if [Link](direction) < 0
//@variable The stop price of the entry order.
stopPrice = close + [Link] * stopOffsetInput
//@variable The expected default fill quantity at the `stopPrice`. This value may not reflect actua
l qty of the filled order, because fill price may be different.
calculatedQty = strategy.default_entry_qty(stopPrice)
[Link]("My Long Entry Id", [Link], stop = stopPrice)
[Link](bar_index, stopPrice, [Link]("Stop set at {0}\nExpected qty at {0}: {1}", math.round_
to_mintick(stopPrice), calculatedQty))

if [Link](direction) > 0
strategy.close_all()

REMARKS

This function does not consider open positions simulated by a strategy. For example, if a strategy script has an open
position from a long order with a qty of 10 units, using the [Link]() function to simulate a short order with a
qty of 5 will prompt the script to sell 15 units to reverse the position. This function will still return 5 in such a case
since it doesn't consider an open trade.
This value represents the default calculated quantity of an order.

Order placement commands can override the default value by explicitly passing a new qty value in the function call.

[Link]()
Creates a new order to open or add to a position. If an unfilled order with the same id exists, a call to this command
modifies that order.
The resulting order's type depends on the limit and stop parameters. If the call does not contain limit or st
op arguments, it creates a market order that executes on the next tick. If the call specifies a limit value but no st
op value, it places a limit order that executes after the market price reaches the limit value or a better price (lower
for buy orders and higher for sell orders). If the call specifies a stop value but no limit value, it places a stop
order that executes after the market price reaches the stop value or a worse price (higher for buy orders and lower
for sell orders). If the call contains limit and stop arguments, it creates a stop-limit order, which generates a limit
order at the limit price only after the market price reaches the stop value or a worse price.

Orders from this command, unlike those from [Link](), are affected by the pyramiding parameter of the
strategy() declaration statement. Pyramiding specifies the number of concurrent open entries allowed per position. For
example, with pyramiding = 3 , the strategy can have up to three open trades, and the command cannot create
orders to open additional trades until at least one existing trade closes.
By default, when a strategy executes an order from this command in the opposite direction of the current market
position, it reverses that position. For example, if there is an open long position of five shares, an order from this
command with a qty of 5 and a direction of [Link] triggers the sale of 10 shares to close the long
position and open a new five-share short position. Users can change this behavior by specifying an allowed direction
with the strategy.risk_allow_entry_in() function.

SYNTAX

[Link](id, direction, qty, limit, stop, oca_name, oca_type, comment, alert_message, disable_alert)
→ void

ARGUMENTS

id (series string) The identifier of the order, which corresponds to an entry ID in the strategy's trades after the order
fills. If the strategy opens a new position after filling the order, the order's ID becomes the
strategy.position_entry_name value. Strategy commands can reference the order ID to cancel or modify pending
orders and generate exit orders for specific open trades. The Strategy Tester and the chart display the order ID unless
the command specifies a comment value.

direction (series strategy_direction) The direction of the trade. Possible values: [Link] for a long trade,
[Link] for a short one.
qty (series int/float) Optional. The number of contracts/shares/lots/units in the resulting open trade when the order
fills. The default is na, which means that the command uses the default_qty_type and default_qty_value
parameters of the strategy() declaration statement to determine the quantity.
limit (series int/float) Optional. The limit price of the order. If specified, the command creates a limit or stop-limit
order, depending on whether the stop value is also specified. The default is na, which means the resulting order is
not of the limit or stop-limit type.

stop (series int/float) Optional. The stop price of the order. If specified, the command creates a stop or stop-limit
order, depending on whether the limit value is also specified. The default is na, which means the resulting order is
not of the stop or stop-limit type.

oca_name (series string) Optional. The name of the order's One-Cancels-All (OCA) group. When a pending order
with the same oca_name and oca_type parameters executes, that order affects all unfilled orders in the group.
The default is an empty string, which means the order does not belong to an OCA group.
oca_type (input string) Optional. Specifies how an unfilled order behaves when another pending order with the same
oca_name and oca_type values executes. Possible values: [Link], [Link],
[Link]. The default is [Link].
comment (series string) Optional. Additional notes on the filled order. If the value is not an empty string, the Strategy
Tester and the chart show this text for the order instead of the specified id . The default is an empty string.

alert_message (series string) Optional. Custom text for the alert that fires when an order fills. If the "Message" field
of the "Create Alert" dialog box contains the {{[Link].alert_message}} placeholder, the alert
message replaces the placeholder with this text. The default is an empty string.
disable_alert (series bool) Optional. If true when the command creates an order, the strategy does not trigger an
alert when that order fills. This parameter accepts a "series" value, meaning users can control which orders trigger
alerts when they execute. The default is false.

EXAMPLE

//@version=6
strategy("Market order strategy", overlay = true)

// Calculate a 14-bar and 28-bar moving average of `close` prices.

float sma14 = [Link](close, 14)
float sma28 = [Link](close, 28)

// Place a market order to close the short trade and enter a long position when `sma14` crosses over `s
ma28`.
if [Link](sma14, sma28)
[Link]("My Long Entry ID", [Link])
// Place a market order to close the long trade and enter a short position when `sma14` crosses under `
sma28`.
if [Link](sma14, sma28)
[Link]("My Short Entry ID", [Link])

EXAMPLE

//@version=6
strategy("Limit order strategy", overlay=true, margin_long=100, margin_short=100)

//@variable The distance from the `close` price for each limit order.
float limitOffsetInput = [Link](100, "Limit offset, in ticks", 1) * [Link]

//@function Draws a label and line at the specified `price` to visualize a limit order's level.
drawLimit(float price, bool isLong) =>
color col = isLong ? [Link] : [Link]
[Link](
bar_index, price, (isLong ? "Long" : "Short") + " limit order created",
style = label.style_label_right, color = col, textcolor = [Link]
)
[Link](bar_index, price, bar_index + 1, price, extend = [Link], style = line.style_dashed,
color = col)

//@function Stops the `l` line from extending further.

method stopExtend(line l) =>
l.set_x2(bar_index)
l.set_extend([Link])

// Initialize two `line` variables to reference limit line IDs.

var line longLimit = na
var line shortLimit = na

// Calculate a 14-bar and 28-bar moving average of `close` prices.

float sma14 = [Link](close, 14)
float sma28 = [Link](close, 28)

if [Link](sma14, sma28)
// Cancel any unfilled sell orders with the specified ID.
[Link]("My Short Entry ID")
//@variable The limit price level. Its value is `limitOffsetInput` ticks below the current `close`.
float limitLevel = close - limitOffsetInput
// Place a long limit order to close the short trade and enter a long position at the `limitLevel`.
[Link]("My Long Entry ID", [Link], limit = limitLevel)
// Make new drawings for the long limit and stop extending the `shortLimit` line.
longLimit := drawLimit(limitLevel, isLong = true)
[Link]()

if [Link](sma14, sma28)
// Cancel any unfilled buy orders with the specified ID.
[Link]("My Long Entry ID")
//@variable The limit price level. Its value is `limitOffsetInput` ticks above the current `close`.
float limitLevel = close + limitOffsetInput
// Place a short limit order to close the long trade and enter a short position at the `limitLevel
`.
[Link]("My Short Entry ID", [Link], limit = limitLevel)
// Make new drawings for the short limit and stop extending the `shortLimit` line.
shortLimit := drawLimit(limitLevel, isLong = false)
[Link]()

[Link]()
Creates price-based orders to exit from an open position. If unfilled exit orders with the same id exist, calls to this
command modify those orders. This command can generate more than one type of exit order, depending on the
specified parameters. However, it does not create market orders. To exit from a position with a market order, use
[Link]() or strategy.close_all().
If a call to this command contains a profit or limit argument, it creates take-profit orders to exit from applicable
trades at the determined price levels or better values (higher for long trades and lower for short ones). If the call
contains loss or stop arguments, it creates stop-loss orders to exit from applicable trades at the determined
levels or worse values (lower for long trades and higher for short ones). Calling this command with profit or limi
t and loss or stop arguments creates an order bracket with both order types.

This command can create trailing stop orders when its call specifies a trail_price or trail_points argument
and a trail_offset argument. A trailing stop order activates when the price moves trail_points ticks past
the entry price or touches the trail_price level. Once activated, the stop follows trail_offset ticks behind
the market price each time the trade's profit reaches a new high. The stop does not move when the trade does not
achieve a new best value.
Each call to this command reserves a portion of the position to close until the strategy fills or cancels its orders. For
example, if there is an open position of 50 contracts and a [Link]() call specifies a qty of 20, that call's orders
reserve 20 contracts out of the position. A second call can close a maximum of 30 contracts, even if its qty is 50
and one of its orders executes first. This behavior does not affect the orders from other commands, such as
[Link]() or [Link]().
If a call to this command occurs before a created entry order's execution, the strategy waits and does not create the
exit orders until after the entry order executes.

SYNTAX

[Link](id, from_entry, qty, qty_percent, profit, limit, loss, stop, trail_price, trail_points, trail
_offset, oca_name, comment, comment_profit, comment_loss, comment_trailing, alert_message, alert_profit, al
ert_loss, alert_trailing, disable_alert) → void

ARGUMENTS

id (series string) The identifier of the orders, which corresponds to an exit ID in the strategy's trades after an order
fills. Strategy commands can reference the order ID to cancel or modify pending exit orders. The Strategy Tester and
the chart display the order ID unless the command includes a comment* argument that applies to the filled order.

from_entry (series string) Optional. The entry order ID of the trade to exit from. If there is more than one open trade
with the specified entry ID, the command generates exit orders for all the entries from before or at the time of the call.
The default is an empty string, which means the command generates exit orders for all open trades until the position
closes.

qty (series int/float) Optional. The number of contracts/lots/shares/units to close when an exit order fills. If specified,
the command uses this value instead of qty_percent to determine the order size. The exit orders reserve this
quantity from the position, meaning other calls to this command cannot close this portion until the strategy fills or
cancels those orders. The default is na, which means the order size depends on the qty_percent value.

qty_percent (series int/float) Optional. A value between 0 and 100 representing the percentage of the open trade
quantity to close when an exit order fills. The exit orders reserve this percentage from the applicable open trades,
meaning other calls to this command cannot close this portion until the strategy fills or cancels those orders. The
percentage calculation depends on the total size of the applicable open trades without considering the reserved
amount from other [Link]() calls. The command ignores this parameter if the qty value is not na. The default is
100.
profit (series int/float) Optional. The take-profit distance, expressed in ticks. If specified, the command creates a limit
order to exit the trade profit ticks away from the entry price in the favorable direction. The order executes at the
calculated price or a better value. If this parameter and limit are not na, the command places a take-profit order
only at the price level expected to trigger an exit first. The default is na.

limit (series int/float) Optional. The take-profit price. If this parameter and profit are not na, the command places
a take-profit order only at the price level expected to trigger an exit first. The default is na.

loss (series int/float) Optional. The stop-loss distance, expressed in ticks. If specified, the command creates a stop
order to exit the trade loss ticks away from the entry price in the unfavorable direction. The order executes at the
calculated price or a worse value. If this parameter and stop are not na, the command places a stop-loss order only
at the price level expected to trigger an exit first. The default is na.

stop (series int/float) Optional. The stop-loss price. If this parameter and loss are not na, the command places a
stop-loss order only at the price level expected to trigger an exit first. The default is na.

trail_price (series int/float) Optional. The price of the trailing stop activation level. If the value is more favorable than
the entry price, the command creates a trailing stop when the market price reaches that value. If less favorable than
the entry price, the command creates the trailing stop immediately when the current market price is equal to or more
favorable than the value. If this parameter and trail_points are not na, the command sets the activation level
using the value expected to activate the stop first. The default is na.

trail_points (series int/float) Optional. The trailing stop activation distance, expressed in ticks. If the value is positive,
the command creates a trailing stop order when the market price moves trail_points ticks away from the trade's
entry price in the favorable direction. If the value is negative, the command creates the trailing stop immediately when
the market price is equal to or more favorable than the level trail_points ticks away from the entry price in the
unfavorable direction. The default is na.

trail_offset (series int/float) Optional. The trailing stop offset. When the market price reaches the activation level
determined by the trail_price or trail_points parameter, or exceeds the level in the favorable direction, the
command creates a trailing stop with an initial value trail_offset ticks away from that level in the unfavorable
direction. After activation, the trailing stop moves toward the market price each time the trade's profit reaches a better
value, maintaining the specified distance behind the best price. The default is na.

oca_name (series string) Optional. The name of the One-Cancels-All (OCA) group that the command's take-profit,
stop-loss, and trailing stop orders belong to. All orders from this command are of the [Link] OCA type.
When an order of this OCA type with the same oca_name executes, the strategy reduces the sizes of other unfilled
orders in the OCA group by the filled quantity. The default is an empty string, which means the strategy assigns the
OCA name automatically, and the resulting orders cannot reduce or be reduced by the orders from other commands.
comment (series string) Optional. Additional notes on the filled order. If the value is not an empty string, the Strategy
Tester and the chart show this text for the order instead of the specified id . The command ignores this value if the
call includes an argument for a comment_* parameter that applies to the order. The default is an empty string.

comment_profit (series string) Optional. Additional notes on the filled order. If the value is not an empty string, the
Strategy Tester and the chart show this text for the order instead of the specified id or comment . This comment
applies only to the command's take-profit orders created using the profit or limit parameter. The default is an
empty string.

comment_loss (series string) Optional. Additional notes on the filled order. If the value is not an empty string, the
Strategy Tester and the chart show this text for the order instead of the specified id or comment . This comment
applies only to the command's stop-loss orders created using the loss or stop parameter. The default is an
empty string.
comment_trailing (series string) Optional. Additional notes on the filled order. If the value is not an empty string, the
Strategy Tester and the chart show this text for the order instead of the specified id or comment . This comment
applies only to the command's trailing stop orders created using the trail_price or trail_points and trail
_offset parameters. The default is an empty string.

alert_profit (series string) Optional. Custom text for the alert that fires when an order fills. If the "Message" field of
the "Create Alert" dialog box contains the {{[Link].alert_message}} placeholder, the alert message
replaces the placeholder with this text. This message applies only to the command's take-profit orders created using
the profit or limit parameter. The default is an empty string.

alert_loss (series string) Optional. Custom text for the alert that fires when an order fills. If the "Message" field of the
"Create Alert" dialog box contains the {{[Link].alert_message}} placeholder, the alert message
replaces the placeholder with this text. This message applies only to the command's stop-loss orders created using
the loss or stop parameter. The default is an empty string.

alert_trailing (series string) Optional. Custom text for the alert that fires when an order fills. If the "Message" field of
the "Create Alert" dialog box contains the {{[Link].alert_message}} placeholder, the alert message
replaces the placeholder with this text. This message applies only to the command's trailing stop orders created using
the trail_price or trail_points and trail_offset parameters. The default is an empty string.

disable_alert (series bool) Optional. If true when the command creates an order, the strategy does not trigger an
alert when that order fills. This parameter accepts a "series" value, meaning users can control which orders trigger
alerts when they execute. The default is false.

EXAMPLE

//@version=6
strategy("Exit bracket strategy", overlay = true)

// Inputs that define the profit and loss amount of each trade as a tick distance from the entry price.
int profitDistanceInput = [Link](100, "Profit distance, in ticks", 1)
int lossDistanceInput = [Link](100, "Loss distance, in ticks", 1)

// Variables to track the take-profit and stop-loss price.

var float takeProfit = na
var float stopLoss = na

// Calculate a 14-bar and 28-bar moving average of `close` prices.

float sma14 = [Link](close, 14)
float sma28 = [Link](close, 28)

if [Link](sma14, sma28) and [Link] == 0

// Place a market order to enter a long position.
[Link]("My Long Entry ID", [Link])
// Place a take-profit and stop-loss order when the entry order fills.
[Link]("My Long Exit ID", "My Long Entry ID", profit = profitDistanceInput, loss = lossDista
nceInput)

if [Link]([Link]) == 1
//@variable The long entry price.
float entryPrice = [Link].entry_price(0)
// Update the `takeProfit` and `stopLoss` values.
takeProfit := entryPrice + profitDistanceInput * [Link]
stopLoss := entryPrice - lossDistanceInput * [Link]

if [Link]([Link]) == 1
// Reset the `takeProfit` and `stopLoss`.
takeProfit := na
stopLoss := na

// Plot the `takeProfit` and `stopLoss`.

plot(takeProfit, "Take-profit level", [Link], 2, plot.style_linebr)
plot(stopLoss, "Stop-loss level", [Link], 2, plot.style_linebr)

EXAMPLE

//@version=6
strategy("Trailing stop strategy", overlay = true)

//@variable The distance required to activate the trailing stop.

float activationDistanceInput = [Link](100, "Trail activation distance, in ticks") * [Link]
//@variable The number of ticks the trailing stop follows behind the price as it reaches new peaks.
int trailDistanceInput = [Link](100, "Trail distance, in ticks")

//@function Draws a label and line at the specified `price` to visualize a trailing stop order's activa
tion level.
drawActivation(float price) =>
[Link](
bar_index, price, "Activation level", style = label.style_label_right,
color = [Link], textcolor = [Link]
)
[Link](
bar_index, price, bar_index + 1, price, extend = [Link], style = line.style_dashed, colo
r = [Link]
)

//@function Stops the `l` line from extending further.

method stopExtend(line l) =>
l.set_x2(bar_index)
l.set_extend([Link])

// The activation line, active trailing stop price, and active trailing stop flag.
var line activationLine = na
var float trailingStopPrice = na
var bool isActive = false

if bar_index % 100 == 0 and [Link] == 0

trailingStopPrice := na
isActive := false
// Place a market order to enter a long position.
[Link]("My Long Entry ID", [Link])
//@variable The activation level's price.
float activationPrice = close + activationDistanceInput
// Create a trailing stop order that activates the defined number of ticks above the entry price.
[Link](
"My Long Exit ID", "My Long Entry ID", trail_price = activationPrice, trail_offset = trailDist
anceInput,
oca_name = "Exit"
)
// Create new drawings at the `activationPrice`.
activationLine := drawActivation(activationPrice)

// Logic for trailing stop visualization.

if [Link] == 1
// Stop extending the `activationLine` when the stop activates.
if not isActive and high > activationLine.get_price(bar_index)
isActive := true
[Link]()
// Update the `trailingStopPrice` while the trailing stop is active.
if isActive
float offsetPrice = high - trailDistanceInput * [Link]
trailingStopPrice := [Link](nz(trailingStopPrice, offsetPrice), offsetPrice)

// Close the trade with a market order if the trailing stop does not activate before the next 300th ba
r.
if not isActive and bar_index % 300 == 0
strategy.close_all("Market close")

// Reset the `trailingStopPrice` and `isActive` flags when the trade closes, and stop extending the `ac
tivationLine`.
if [Link]([Link]) > 0
if not isActive
[Link]()
trailingStopPrice := na
isActive := false

// Plot the `trailingStopPrice`.

plot(trailingStopPrice, "Trailing stop", [Link], 3, plot.style_linebr)

REMARKS

A single call to the [Link]() command can generate exit orders for several entries in an open position, depending
on the call's from_entry value. If the call does not include a from_entry argument, it creates exit orders for all
open trades, even the ones opened after the call, until the position closes. See this section of our User Manual to learn
more.

When a position consists of several open trades, and the close_entries_rule in the strategy() declaration
statement is "FIFO" (default), the orders from a [Link]() call exit from the position starting with the first open
trade. This behavior applies even if the from_entry value is the entry ID of different open trades. However, in that
case, the maximum size of the exit orders still depends on the trades opened by orders with the from_entry ID. For
more information, see this section of our User Manual.
If a [Link]() call includes arguments for creating stop-loss and trailing stop orders, the command places only the
order that is supposed to fill first, because both orders are of the "stop" type.

[Link]()
Returns the sum of entry and exit fees paid in the open trade, expressed in strategy.account_currency.

SYNTAX

[Link](trade_num) → series float

ARGUMENTS

trade_num (series int) The trade number of the open trade. The number of the first trade is zero.

EXAMPLE

// Calculates the gross profit or loss for the current open position.
//@version=6
strategy("`[Link]` Example", commission_type = [Link], com
mission_value = 0.1)
// Strategy calls to enter long trades every 15 bars and exit long trades every 20 bars.
if bar_index % 15 == 0
[Link]("Long", [Link])
if bar_index % 20 == 0
[Link]("Long")

// Calculate gross profit or loss for open positions only.

tradeOpenGrossPL() =>
sumOpenGrossPL = 0.0
for tradeNo = 0 to [Link] - 1
sumOpenGrossPL += [Link](tradeNo) - [Link](tradeNo)
result = sumOpenGrossPL

plot(tradeOpenGrossPL())

SEE ALSO

strategy() [Link]()

[Link].entry_bar_index()
Returns the bar_index of the open trade's entry.

SYNTAX

[Link].entry_bar_index(trade_num) → series int

ARGUMENTS

trade_num (series int) The trade number of the open trade. The number of the first trade is zero.

EXAMPLE

// Wait 10 bars and then close the position.

//@version=6
strategy("`[Link].entry_bar_index` Example")

barsSinceLastEntry() =>
[Link] > 0 ? bar_index - [Link].entry_bar_index([Link] -
1) : na

// Enter a long position if there are no open positions.

if [Link] == 0
[Link]("Long", [Link])

// Close the long position after 10 bars.

if barsSinceLastEntry() >= 10
[Link]("Long")

SEE ALSO

[Link].entry_bar_index() [Link].exit_bar_index()

[Link].entry_comment()
Returns the comment message of the open trade's entry, or na if there is no entry with this trade_num .

SYNTAX

[Link].entry_comment(trade_num) → series string

ARGUMENTS

trade_num (series int) The trade number of the open trade. The number of the first trade is zero.
EXAMPLE

//@version=6
strategy("`[Link].entry_comment()` Example", overlay = true)

stopPrice = open * 1.01

longCondition = [Link]([Link](close, 14), [Link](close, 28))

if (longCondition)
[Link]("Long", [Link], stop = stopPrice, comment = [Link](stopPric
e, "#.####"))

var testTable = [Link](position.top_right, 1, 3, [Link], border_width = 1)

if [Link] or [Link]
[Link](testTable, 0, 0, 'Last entry stats')
[Link](testTable, 0, 1, "Order stop price value: " + [Link].entry_comment(strateg
[Link] - 1))
[Link](testTable, 0, 2, "Actual Entry Price: " + [Link]([Link].entry_price(s
[Link] - 1)))

SEE ALSO

strategy() [Link]() [Link]

[Link].entry_id()
Returns the id of the open trade's entry.

SYNTAX

[Link].entry_id(trade_num) → series string

ARGUMENTS

trade_num (series int) The trade number of the open trade. The number of the first trade is zero.

EXAMPLE

//@version=6
strategy("`[Link].entry_id` Example", overlay = true)

// We enter a long position when 14 period sma crosses over 28 period sma.
// We enter a short position when 14 period sma crosses under 28 period sma.
longCondition = [Link]([Link](close, 14), [Link](close, 28))
shortCondition = [Link]([Link](close, 14), [Link](close, 28))

// Strategy calls to enter a long or short position when the corresponding condition is met.
if longCondition
[Link]("Long entry at bar #" + [Link](bar_index), [Link])
if shortCondition
[Link]("Short entry at bar #" + [Link](bar_index), [Link])

// Display ID of the latest open position.

if [Link]
[Link](bar_index, high + (2 * [Link]), "Last opened position is \n " + [Link].entry_
id([Link] - 1))

RETURNS

Returns the id of the open trade's entry.

REMARKS

The function returns na if trade_num is not in the range: 0 to [Link]-1.

SEE ALSO
[Link].entry_bar_index() [Link].entry_price() [Link].entry_time()

[Link].entry_price()
Returns the price of the open trade's entry.

SYNTAX

[Link].entry_price(trade_num) → series float

ARGUMENTS

trade_num (series int) The trade number of the open trade. The number of the first trade is zero.

EXAMPLE

//@version=6
strategy("[Link].entry_price Example 1", overlay = true)

// Strategy calls to enter long trades every 15 bars and exit long trades every 20 bars.
if [Link](close, [Link](close, 14))
[Link]("Long", [Link])

// Return the entry price for the latest closed trade.

currEntryPrice = [Link].entry_price([Link] - 1)
currExitPrice = currEntryPrice * 1.05

if high >= currExitPrice

[Link]("Long")

plot(currEntryPrice, "Long entry price", style = plot.style_linebr)

plot(currExitPrice, "Long exit price", [Link], style = plot.style_linebr)

EXAMPLE

// Calculates the average price for the open position.

//@version=6
strategy("[Link].entry_price Example 2", pyramiding = 2)

// Strategy calls to enter long trades every 15 bars and exit long trades every 20 bars.
if bar_index % 15 == 0
[Link]("Long", [Link])
if bar_index % 20 == 0
[Link]("Long")

// Calculates the average price for the open position.

avgOpenPositionPrice() =>
sumOpenPositionPrice = 0.0
for tradeNo = 0 to [Link] - 1
sumOpenPositionPrice += [Link].entry_price(tradeNo) * [Link](tra
deNo) / strategy.position_size
result = nz(sumOpenPositionPrice / [Link])

plot(avgOpenPositionPrice())

SEE ALSO

[Link].exit_price()

[Link].entry_time()
Returns the UNIX time of the open trade's entry, expressed in milliseconds.

SYNTAX

[Link].entry_time(trade_num) → series int

ARGUMENTS

trade_num (series int) The trade number of the open trade. The number of the first trade is zero.

EXAMPLE

//@version=6
strategy("[Link].entry_time Example")

// Strategy calls to enter long trades every 15 bars and exit long trades every 20 bars.
if bar_index % 15 == 0
[Link]("Long", [Link])
if bar_index % 20 == 0
[Link]("Long")

// Calculates duration in milliseconds since the last position was opened.

timeSinceLastEntry()=>
[Link] > 0 ? (time - [Link].entry_time([Link] - 1)) : na

plot(timeSinceLastEntry() / 1000 * 60 * 60 * 24, "Days since last entry")

SEE ALSO

[Link].entry_time() [Link].exit_time()

[Link].max_drawdown()
Returns the maximum drawdown of the open trade, i.e., the maximum possible loss during the trade, expressed in
strategy.account_currency.

SYNTAX

[Link].max_drawdown(trade_num) → series float

ARGUMENTS

trade_num (series int) The trade number of the open trade. The number of the first trade is zero.

EXAMPLE

//@version=6
strategy("[Link].max_drawdown Example 1")

// Strategy calls to enter long trades every 15 bars and exit long trades every 20 bars.
if bar_index % 15 == 0
[Link]("Long", [Link])
if bar_index % 20 == 0
[Link]("Long")

// Plot the max drawdown of the latest open trade.

plot([Link].max_drawdown([Link] - 1), "Max drawdown of the latest open trad
e")

EXAMPLE

// Calculates the max trade drawdown value for all open trades.
//@version=6
strategy("`[Link].max_drawdown` Example 2", pyramiding = 100)

// Strategy calls to enter long trades every 15 bars and exit long trades every 20 bars.
if bar_index % 15 == 0
[Link]("Long", [Link])
if bar_index % 20 == 0
[Link]("Long")

// Get the biggest max trade drawdown value from all of the open trades.
maxTradeDrawDown() =>
maxDrawdown = 0.0
for tradeNo = 0 to [Link] - 1
maxDrawdown := [Link](maxDrawdown, [Link].max_drawdown(tradeNo))
result = maxDrawdown

plot(maxTradeDrawDown(), "Biggest max drawdown")

REMARKS

The function returns na if trade_num is not in the range: 0 to [Link] - 1.

SEE ALSO

[Link].max_drawdown() strategy.max_drawdown

[Link].max_drawdown_percent()
Returns the maximum drawdown of the open trade, i.e., the maximum possible loss during the trade, expressed as a
percentage and calculated by formula: Lowest Value During Trade / (Entry Price x Quantity) * 100 .

SYNTAX

[Link].max_drawdown_percent(trade_num) → series float

ARGUMENTS

trade_num (series int) The trade number of the closed trade. The number of the first trade is zero.

SEE ALSO

[Link].max_drawdown() strategy.max_drawdown

[Link].max_runup()
Returns the maximum run up of the open trade, i.e., the maximum possible profit during the trade, expressed in
strategy.account_currency.

SYNTAX

[Link].max_runup(trade_num) → series float

ARGUMENTS

trade_num (series int) The trade number of the open trade. The number of the first trade is zero.

EXAMPLE

//@version=6
strategy("[Link].max_runup Example 1")

// Strategy calls to enter long trades every 15 bars and exit long trades every 20 bars.
if bar_index % 15 == 0
[Link]("Long", [Link])
if bar_index % 20 == 0
[Link]("Long")

// Plot the max runup of the latest open trade.

plot([Link].max_runup([Link] - 1), "Max runup of the latest open trade")

EXAMPLE

// Calculates the max trade runup value for all open trades.
//@version=6
strategy("[Link].max_runup Example 2", pyramiding = 100)
// Enter a long position every 30 bars.
if bar_index % 30 == 0
[Link]("Long", [Link])

// Calculate biggest max trade runup value from all of the open trades.
maxOpenTradeRunUp() =>
maxRunup = 0.0
for tradeNo = 0 to [Link] - 1
maxRunup := [Link](maxRunup, [Link].max_runup(tradeNo))
result = maxRunup

plot(maxOpenTradeRunUp(), "Biggest max runup of all open trades")

SEE ALSO

[Link].max_runup() strategy.max_drawdown

[Link].max_runup_percent()
Returns the maximum run-up of the open trade, i.e., the maximum possible profit during the trade, expressed as a
percentage and calculated by formula: Highest Value During Trade / (Entry Price x Quantity) * 10
0.

SYNTAX

[Link].max_runup_percent(trade_num) → series float

ARGUMENTS

trade_num (series int) The trade number of the closed trade. The number of the first trade is zero.

SEE ALSO

[Link].max_runup() strategy.max_runup

[Link]()
Returns the profit/loss of the open trade, expressed in strategy.account_currency. Losses are expressed as negative
values.

SYNTAX

[Link](trade_num) → series float

ARGUMENTS

trade_num (series int) The trade number of the open trade. The number of the first trade is zero.

EXAMPLE

// Returns the profit of the last open trade.

//@version=6
strategy("`[Link]` Example 1", commission_type = [Link], commi
ssion_value = 0.1)

// Strategy calls to enter long trades every 15 bars and exit long trades every 20 bars.
if bar_index % 15 == 0
[Link]("Long", [Link])
if bar_index % 20 == 0
[Link]("Long")

plot([Link]([Link] - 1), "Profit of the latest open trade")

EXAMPLE
// Calculates the profit for all open trades.
//@version=6
strategy("`[Link]` Example 2", pyramiding = 5)

// Strategy calls to enter 5 long positions every 2 bars.

if bar_index % 2 == 0
[Link]("Long", [Link], qty = 5)

// Calculate open profit or loss for the open positions.

tradeOpenPL() =>
sumProfit = 0.0
for tradeNo = 0 to [Link] - 1
sumProfit += [Link](tradeNo)
result = sumProfit

plot(tradeOpenPL(), "Profit of all open trades")

SEE ALSO

[Link]() [Link] [Link] [Link]

[Link].profit_percent()
Returns the profit/loss of the open trade, expressed as a percentage. Losses are expressed as negative values.

SYNTAX

[Link].profit_percent(trade_num) → series float

ARGUMENTS

trade_num (series int) The trade number of the closed trade. The number of the first trade is zero.

SEE ALSO

[Link]()

[Link]()
Returns the direction and the number of contracts traded in the open trade. If the value is > 0, the market position was
long. If the value is < 0, the market position was short.

SYNTAX

[Link](trade_num) → series float

ARGUMENTS

trade_num (series int) The trade number of the open trade. The number of the first trade is zero.

EXAMPLE

//@version=6
strategy("`[Link]` Example 1")

// We calculate the max amt of shares we can buy.

// Plot the number of contracts in the latest open trade.

plot([Link]([Link] - 1), "Amount of contracts in latest open trade")
EXAMPLE

// Calculates the average profit percentage for all open trades.

//@version=6
strategy("`[Link]` Example 2")

// Strategy calls to enter long trades every 15 bars and exit long trades every 20 bars.
if bar_index % 15 == 0
[Link]("Long", [Link])
if bar_index % 20 == 0
[Link]("Long")

// Calculate profit for all open trades.

profitPct = 0.0
for tradeNo = 0 to [Link] - 1
entryP = [Link].entry_price(tradeNo)
exitP = close
profitPct += (exitP - entryP) / entryP * [Link](tradeNo) * 100

// Calculate average profit percent for all open trades.

avgProfitPct = nz(profitPct / [Link])
plot(avgProfitPct)

SEE ALSO

[Link]() strategy.position_size [Link] [Link]

[Link]()
Creates a new order to open, add to, or exit from a position. If an unfilled order with the same id exists, a call to this
command modifies that order.

The resulting order's type depends on the limit and stop parameters. If the call does not contain limit or st
op arguments, it creates a market order that executes on the next tick. If the call specifies a limit value but no st
op value, it places a limit order that executes after the market price reaches the limit value or a better price (lower
for buy orders and higher for sell orders). If the call specifies a stop value but no limit value, it places a stop
order that executes after the market price reaches the stop value or a worse price (higher for buy orders and lower
for sell orders). If the call contains limit and stop arguments, it creates a stop-limit order, which generates a limit
order at the limit price only after the market price reaches the stop value or a worse price.

Orders from this command, unlike those from [Link](), are not affected by the pyramiding parameter of the
strategy() declaration statement. Strategies can open any number of trades in the same direction with calls to this
function.

This command does not automatically reverse open positions because it does not exclusively create entry orders like
[Link]() does. For example, if there is an open long position of five shares, an order from this command with a
qty of 5 and a direction of [Link] triggers the sale of five shares, which closes the position.

SYNTAX

[Link](id, direction, qty, limit, stop, oca_name, oca_type, comment, alert_message, disable_alert)
→ void

ARGUMENTS

id (series string) The identifier of the order, which corresponds to an entry or exit ID in the strategy's trades after the
order fills. If the strategy opens a new position after filling the order, the order's ID becomes the
strategy.position_entry_name value. Strategy commands can reference the order ID to cancel or modify pending
orders and generate exit orders for specific open trades. The Strategy Tester and the chart display the order ID unless
the command specifies a comment value.

direction (series strategy_direction) The direction of the trade. Possible values: [Link] for a long trade,
[Link] for a short one.
qty (series int/float) Optional. The number of contracts/shares/lots/units to trade when the order fills. The default is
na, which means that the command uses the default_qty_type and default_qty_value parameters of the
strategy() declaration statement to determine the quantity.
limit (series int/float) Optional. The limit price of the order. If specified, the command creates a limit or stop-limit
order, depending on whether the stop value is also specified. The default is na, which means the resulting order is
not of the limit or stop-limit type.

alert_message (series string) Optional. Custom text for the alert that fires when an order fills. If the "Message" field
of the "Create Alert" dialog box contains the {{[Link].alert_message}} placeholder, the alert
message replaces the placeholder with this text. The default is an empty string.
disable_alert (series bool) Optional. If true when the command creates an order, the strategy does not trigger an
alert when that order fills. This parameter accepts a "series" value, meaning users can control which orders trigger
alerts when they execute. The default is false.

EXAMPLE

//@version=6
strategy("Market order strategy", overlay = true)

// Calculate a 14-bar and 28-bar moving average of `close` prices.

float sma14 = [Link](close, 14)
float sma28 = [Link](close, 28)

// Place a market order to enter a long position when `sma14` crosses over `sma28`.
if [Link](sma14, sma28) and strategy.position_size == 0
[Link]("My Long Entry ID", [Link])

// Place a market order to sell the same quantity as the long trade when `sma14` crosses under `sma28`,
// effectively closing the long position.
if [Link](sma14, sma28) and strategy.position_size > 0
[Link]("My Long Exit ID", [Link])

EXAMPLE

//@version=6
strategy("Limit and stop exit strategy", overlay = true)

//@variable The distance from the long entry price for each short limit order.
float shortOffsetInput = [Link](200, "Sell limit/stop offset, in ticks", 1) * [Link]

//@function Draws a label and line at the specified `price` to visualize a limit order's level.
drawLimit(float price, bool isLong, bool isStop = false) =>
color col = isLong ? [Link] : [Link]
[Link](
bar_index, price, (isLong ? "Long " : "Short ") + (isStop ? "stop" : "limit") + " order create
d",
style = label.style_label_right, color = col, textcolor = [Link]
)
[Link](bar_index, price, bar_index + 1, price, extend = [Link], style = line.style_dashed,
color = col)

//@function Stops the `l` line from extending further.

method stopExtend(line l) =>
l.set_x2(bar_index)
l.set_extend([Link])

// Initialize two `line` variables to reference limit and stop line IDs.
var line profitLimit = na
var line lossStop = na

// Calculate a 14-bar and 28-bar moving average of `close` prices.

float sma14 = [Link](close, 14)
float sma28 = [Link](close, 28)

if [Link](sma14, sma28) and strategy.position_size == 0

// Place a market order to enter a long position.
[Link]("My Long Entry ID", [Link])

if strategy.position_size > 0 and strategy.position_size[1] == 0

//@variable The entry price of the long trade.
float entryPrice = [Link].entry_price(0)
// Calculate short limit and stop levels above and below the `entryPrice`.
float profitLevel = entryPrice + shortOffsetInput
float lossLevel = entryPrice - shortOffsetInput
// Place short limit and stop orders at the `profitLevel` and `lossLevel`.
[Link]("Profit", [Link], limit = profitLevel, oca_name = "Bracket", oca_type = stra
[Link])
[Link]("Loss", [Link], stop = lossLevel, oca_name = "Bracket", oca_type = strategy.
[Link])
// Make new drawings for the `profitLimit` and `lossStop` lines.
profitLimit := drawLimit(profitLevel, isLong = false)
lossStop := drawLimit(lossLevel, isLong = false, isStop = true)

if [Link]([Link]) > 0
// Stop extending the `profitLimit` and `lossStop` lines.
[Link]()
[Link]()

[Link].allow_entry_in()
This function can be used to specify in which market direction the [Link]() function is allowed to open
positions.

SYNTAX

[Link].allow_entry_in(value) → void

ARGUMENTS

value (simple string) The allowed direction. Possible values: [Link], [Link],
[Link]

EXAMPLE

//@version=6
strategy("[Link].allow_entry_in")

[Link].allow_entry_in([Link])
if open > close
[Link]("Long", [Link])
// Instead of opening a short position with 10 contracts, this command will close long entries.
if open < close
[Link]("Short", [Link], qty = 10)

[Link].max_cons_loss_days()
The purpose of this rule is to cancel all pending orders, close all open positions and stop placing orders after a
specified number of consecutive days with losses. The rule affects the whole strategy.

SYNTAX

[Link].max_cons_loss_days(count, alert_message) → void

ARGUMENTS

count (simple int) A required parameter. The allowed number of consecutive days with losses.

alert_message (simple string) An optional parameter which replaces the {{[Link].alert_message}}

placeholder when it is used in the "Create Alert" dialog box's "Message" field.

EXAMPLE

//@version=6
strategy("risk.max_cons_loss_days Demo 1")
[Link].max_cons_loss_days(3) // No orders will be placed after 3 days, if each day is with loss.
plot(strategy.position_size)

[Link].max_drawdown()
The purpose of this rule is to determine maximum drawdown. The rule affects the whole strategy. Once the maximum
drawdown value is reached, all pending orders are cancelled, all open positions are closed and no new orders can be
placed.

SYNTAX

[Link].max_drawdown(value, type, alert_message) → void

ARGUMENTS

value (simple int/float) A required parameter. The maximum drawdown value. It is specified either in money (base
currency), or in percentage of maximum equity. For % of equity the range of allowed values is from 0 to 100.
type (simple string) A required parameter. The type of the value. Please specify one of the following values:
strategy.percent_of_equity or [Link]. Note: if equity drops down to zero or to a negative and the
'strategy.percent_of_equity' is specified, all pending orders are cancelled, all open positions are closed and no new
orders can be placed for good.
alert_message (simple string) An optional parameter which replaces the {{[Link].alert_message}}
placeholder when it is used in the "Create Alert" dialog box's "Message" field.

EXAMPLE

//@version=6
strategy("risk.max_drawdown Demo 1")
[Link].max_drawdown(50, strategy.percent_of_equity) // set maximum drawdown to 50% of maximum eq
uity
plot(strategy.position_size)

EXAMPLE

//@version=6
strategy("risk.max_drawdown Demo 2", currency = "EUR")
[Link].max_drawdown(2000, [Link]) // set maximum drawdown to 2000 EUR from maximum equity
plot(strategy.position_size)

[Link].max_intraday_filled_orders()
The purpose of this rule is to determine maximum number of filled orders per 1 day (per 1 bar, if chart resolution is
higher than 1 day). The rule affects the whole strategy. Once the maximum number of filled orders is reached, all
pending orders are cancelled, all open positions are closed and no new orders can be placed till the end of the current
trading session.

SYNTAX
[Link].max_intraday_filled_orders(count, alert_message) → void

ARGUMENTS

count (simple int) A required parameter. The maximum number of filled orders per 1 day.

alert_message (simple string) An optional parameter which replaces the {{[Link].alert_message}}

placeholder when it is used in the "Create Alert" dialog box's "Message" field.

EXAMPLE

//@version=6
strategy("risk.max_intraday_filled_orders Demo")
[Link].max_intraday_filled_orders(10) // After 10 orders are filled, no more strategy orders wil
l be placed (except for a market order to exit current open market position, if there is any).
if open > close
[Link]("buy", [Link])
if open < close
[Link]("sell", [Link])

[Link].max_intraday_loss()
The maximum loss value allowed during a day. It is specified either in money (base currency), or in percentage of
maximum intraday equity (0 -100).

SYNTAX

[Link].max_intraday_loss(value, type, alert_message) → void

ARGUMENTS

value (simple int/float) A required parameter. The maximum loss value. It is specified either in money (base
currency), or in percentage of maximum intraday equity. For % of equity the range of allowed values is from 0 to 100.
type (simple string) A required parameter. The type of the value. Please specify one of the following values:
strategy.percent_of_equity or [Link]. Note: if equity drops down to zero or to a negative and the
strategy.percent_of_equity is specified, all pending orders are cancelled, all open positions are closed and no new
orders can be placed for good.

alert_message (simple string) An optional parameter which replaces the {{[Link].alert_message}}

placeholder when it is used in the "Create Alert" dialog box's "Message" field.

EXAMPLE

// Sets the maximum intraday loss using the strategy's equity value.
//@version=6
strategy("[Link].max_intraday_loss Example 1", overlay = false, default_qty_type = [Link]
ent_of_equity, default_qty_value = 100)

// Input for maximum intraday loss %.

lossPct = [Link](10)

// Set maximum intraday loss to our lossPct input

[Link].max_intraday_loss(lossPct, strategy.percent_of_equity)

// Enter Short at bar_index zero.

if bar_index == 0
[Link]("Short", [Link])

// Store equity value from the beginning of the day

eqFromDayStart = [Link]([Link](dayofweek) > 0, [Link], 0)

// Calculate change of the current equity from the beginning of the current day.
eqChgPct = 100 * (([Link] - eqFromDayStart) / [Link])

// Plot it
plot(eqChgPct)
hline(-lossPct)

EXAMPLE

// Sets the maximum intraday loss using the strategy's cash value.
//@version=6
strategy("[Link].max_intraday_loss Example 2", overlay = false)

// Input for maximum intraday loss in absolute cash value of the symbol.
absCashLoss = [Link](5)

// Set maximum intraday loss to `absCashLoss` in account currency.

[Link].max_intraday_loss(absCashLoss, [Link])

// Enter Short at bar_index zero.

if bar_index == 0
[Link]("Short", [Link])

// Store the open price value from the beginning of the day.
beginPrice = [Link]([Link](dayofweek) > 0, open, 0)

// Calculate the absolute price change for the current period.

priceChg = (close - beginPrice)

hline(absCashLoss)
plot(priceChg)

SEE ALSO

strategy() strategy.percent_of_equity [Link]

[Link].max_position_size()
The purpose of this rule is to determine maximum size of a market position. The rule affects the following function:
[Link](). The 'entry' quantity can be reduced (if needed) to such number of contracts/shares/lots/units, so the
total position size doesn't exceed the value specified in '[Link].max_position_size'. If minimum possible quantity
still violates the rule, the order will not be placed.

SYNTAX

[Link].max_position_size(contracts) → void

ARGUMENTS

contracts (simple int/float) A required parameter. Maximum number of contracts/shares/lots/units in a position.

EXAMPLE

//@version=6
strategy("risk.max_position_size Demo", default_qty_value = 100)
[Link].max_position_size(10)
if open > close
[Link]("buy", [Link])
plot(strategy.position_size) // max plot value will be 10

string() 4 overloads

Casts na to string

SYNTAX & OVERLOADS

string(x) → const string

string(x) → input string

string(x) → simple string

string(x) → series string

ARGUMENTS

x (const string) The value to convert to the specified type, usually na.

RETURNS

The value of the argument after casting to string.

SEE ALSO

float() int() bool() color() line() label()

[Link]() 2 overloads

Returns exchange prefix of the symbol , e.g. "NASDAQ".

SYNTAX & OVERLOADS

[Link](symbol) → simple string

[Link](symbol) → series string

ARGUMENTS

symbol (simple string) Symbol. Note that the symbol should be passed with a prefix. For example: "NASDAQ:AAPL"
instead of "AAPL".

EXAMPLE

//@version=6
indicator("[Link] fun", overlay=true)
i_sym = [Link]("NASDAQ:AAPL")
pref = [Link](i_sym)
tick = [Link](i_sym)
t = [Link](pref, tick, [Link])
s = [Link](t, "1D", close)
plot(s)

RETURNS

Returns exchange prefix of the symbol , e.g. "NASDAQ".

REMARKS

The result of the function is used in the [Link]()/[Link]() and [Link]().

SEE ALSO

[Link] [Link] [Link] [Link]() [Link]()

[Link]() 2 overloads

Returns symbol name without exchange prefix, e.g. "AAPL".

SYNTAX & OVERLOADS

[Link](symbol) → simple string

[Link](symbol) → series string

ARGUMENTS

symbol (simple string) Symbol. Note that the symbol should be passed with a prefix. For example: "NASDAQ:AAPL"
instead of "AAPL".

EXAMPLE

//@version=6
indicator("[Link] fun", overlay=true)
i_sym = [Link]("NASDAQ:AAPL")
pref = [Link](i_sym)
tick = [Link](i_sym)
t = [Link](pref, tick, [Link])
s = [Link](t, "1D", close)
plot(s)

RETURNS

Returns symbol name without exchange prefix, e.g. "AAPL".

REMARKS

The result of the function is used in the [Link]()/[Link]() and [Link]().

SEE ALSO

[Link] [Link] [Link] [Link]() [Link]()

[Link]()
Arnaud Legoux Moving Average. It uses Gaussian distribution as weights for moving average.

SYNTAX

[Link](series, length, offset, sigma, floor) → series float

ARGUMENTS

series (series int/float) Series of values to process.

length (series int) Number of bars (length).

offset (simple int/float) Controls tradeoff between smoothness (closer to 1) and responsiveness (closer to 0).
sigma (simple int/float) Changes the smoothness of ALMA. The larger sigma the smoother ALMA.

floor (simple bool) An optional parameter. Specifies whether the offset calculation is floored before ALMA is
calculated. Default value is false.

EXAMPLE

//@version=6
indicator("[Link]", overlay=true)
plot([Link](close, 9, 0.85, 6))

// same on pine, but much less efficient

pine_alma(series, windowsize, offset, sigma) =>
m = offset * (windowsize - 1)
//m = [Link](offset * (windowsize - 1)) // Used as m when [Link]=true
s = windowsize / sigma
norm = 0.0
sum = 0.0
for i = 0 to windowsize - 1
weight = [Link](-1 * [Link](i - m, 2) / (2 * [Link](s, 2)))
norm := norm + weight
sum := sum + series[windowsize - i - 1] * weight
sum / norm
plot(pine_alma(close, 9, 0.85, 6))

RETURNS

Arnaud Legoux Moving Average.

REMARKS

na values in the source series are included in calculations and will produce an na result.

SEE ALSO

[Link]() [Link]() [Link]() [Link]() [Link]() [Link]()

[Link]()
Function atr (average true range) returns the RMA of true range. True range is max(high - low, abs(high - close[1]),
abs(low - close[1])).

SYNTAX

[Link](length) → series float

ARGUMENTS

length (simple int) Length (number of bars back).

EXAMPLE

//@version=6
indicator("[Link]")
plot([Link](14))

//the same on pine

pine_atr(length) =>
trueRange = na(high[1])? high-low : [Link]([Link](high - low, [Link](high - close[1])), math.
abs(low - close[1]))
//true range can be also calculated with [Link](true)
[Link](trueRange, length)

plot(pine_atr(14))

RETURNS

Average true range.

REMARKS

na values in the source series are ignored; the function calculates on the length quantity of non- na values.

SEE ALSO

[Link]() [Link]()

[Link]()
Counts the number of bars since the last time the condition was true.

SYNTAX

[Link](condition) → series int

ARGUMENTS

condition (series bool) The condition to check for.

EXAMPLE

//@version=6
indicator("[Link]")
// get number of bars since last [Link] bar
plot([Link](close >= open))

RETURNS

Number of bars since condition was true.

REMARKS

If the condition has never been met prior to the current bar, the function returns na.

Please note that using this variable/function can cause indicator repainting.

SEE ALSO

[Link]() [Link]() [Link]() [Link]() [Link]()

[Link]()
Bollinger Bands. A Bollinger Band is a technical analysis tool defined by a set of lines plotted two standard deviations
(positively and negatively) away from a simple moving average (SMA) of the security's price, but can be adjusted to
user preferences.

SYNTAX

[Link](series, length, mult) → [series float, series float, series float]

ARGUMENTS

series (series int/float) Series of values to process.

length (series int) Number of bars (length).

mult (simple int/float) Standard deviation factor.

EXAMPLE

//@version=6
indicator("[Link]")

[middle, upper, lower] = [Link](close, 5, 4)

plot(middle, color=[Link])
plot(upper, color=[Link])
plot(lower, color=[Link])

// the same on pine

f_bb(src, length, mult) =>
float basis = [Link](src, length)
float dev = mult * [Link](src, length)
[basis, basis + dev, basis - dev]

[pineMiddle, pineUpper, pineLower] = f_bb(close, 5, 4)

plot(pineMiddle)
plot(pineUpper)
plot(pineLower)

RETURNS

Bollinger Bands.

REMARKS

na values in the source series are ignored; the function calculates on the length quantity of non- na values.

[Link](series, length, mult) → series float

ARGUMENTS

series (series int/float) Series of values to process.

length (series int) Number of bars (length).

mult (simple int/float) Standard deviation factor.

EXAMPLE

//@version=6
indicator("[Link]")

plot([Link](close, 5, 4), color=[Link])

// the same on pine

f_bbw(src, length, mult) =>
float basis = [Link](src, length)
float dev = mult * [Link](src, length)
(((basis + dev) - (basis - dev)) / basis) * 100

plot(f_bbw(close, 5, 4))

RETURNS

Bollinger Bands Width.

REMARKS

na values in the source series are ignored; the function calculates on the length quantity of non- na values.

SEE ALSO

[Link]() [Link]() [Link]()

[Link]()
The CCI (commodity channel index) is calculated as the difference between the typical price of a commodity and its
simple moving average, divided by the mean absolute deviation of the typical price. The index is scaled by an inverse
factor of 0.015 to provide more readable numbers.

SYNTAX

[Link](source, length) → series float

ARGUMENTS

source (series int/float) Series of values to process.

length (series int) Number of bars (length).

RETURNS

Commodity channel index of source for length bars back.

REMARKS
na values in the source series are ignored.

[Link]() 3 overloads

Compares the current source value to its value length bars ago and returns the difference.

SYNTAX & OVERLOADS

[Link](source, length) → series int

[Link](source, length) → series float

[Link](source, length) → series bool

ARGUMENTS

source (series int) Source series.

length (series int) How far the past source value is offset from the current one, in bars. Optional. The default is 1.

EXAMPLE

//@version=6
indicator('Day and Direction Change', overlay = true)
dailyBarTime = time('1D')
isNewDay = [Link](dailyBarTime) != 0
bgcolor(isNewDay ? [Link]([Link], 80) : na)

isGreenBar = close >= open

colorChange = [Link](isGreenBar)
plotshape(colorChange, 'Direction Change')

RETURNS

The difference between the values when they are numerical. When a 'bool' source is used, returns true when the
current source is different from the previous source.

REMARKS

na values in the source series are included in calculations and will produce an na result.

SEE ALSO

[Link]() [Link]()

[Link]()
Chande Momentum Oscillator. Calculates the difference between the sum of recent gains and the sum of recent losses
and then divides the result by the sum of all price movement over the same period.

SYNTAX

[Link](series, length) → series float

ARGUMENTS

series (series int/float) Series of values to process.

length (series int) Number of bars (length).

EXAMPLE

//@version=6
indicator("[Link]")
plot([Link](close, 5), color=[Link])

// the same on pine

f_cmo(src, length) =>
float mom = [Link](src)
float sm1 = [Link]((mom >= 0) ? mom : 0.0, length)
float sm2 = [Link]((mom >= 0) ? 0.0 : -mom, length)
100 * (sm1 - sm2) / (sm1 + sm2)

plot(f_cmo(close, 5))

RETURNS

Chande Momentum Oscillator.

REMARKS

na values in the source series are ignored.

SEE ALSO

[Link]() [Link]() [Link]()

[Link]()
The cog (center of gravity) is an indicator based on statistics and the Fibonacci golden ratio.

SYNTAX

[Link](source, length) → series float

ARGUMENTS

source (series int/float) Series of values to process.

length (series int) Number of bars (length).

EXAMPLE

//@version=6
indicator("[Link]", overlay=true)
plot([Link](close, 10))

// the same on pine

pine_cog(source, length) =>
sum = [Link](source, length)
num = 0.0
for i = 0 to length - 1
price = source[i]
num := num + price * (i + 1)
-num / sum

plot(pine_cog(close, 10))

RETURNS

Center of Gravity.

REMARKS

na values in the source series are ignored.

SEE ALSO

[Link]()

[Link]()
Correlation coefficient. Describes the degree to which two series tend to deviate from their [Link]() values.

SYNTAX

[Link](source1, source2, length) → series float

ARGUMENTS

source1 (series int/float) Source series.

source2 (series int/float) Target series.

length (series int) Length (number of bars back).

RETURNS

Correlation coefficient.

REMARKS

na values in the source series are ignored; the function calculates on the length quantity of non- na values.

SEE ALSO

[Link]()

SYNTAX

[Link](source1, source2) → series bool

ARGUMENTS

source1 (series int/float) First data series.

source2 (series int/float) Second data series.

RETURNS

true if two series have crossed each other, otherwise false.

SEE ALSO

[Link]()

[Link]()
The source1 -series is defined as having crossed over source2 -series if, on the current bar, the value of source
1 is greater than the value of source2 , and on the previous bar, the value of source1 was less than or equal to
the value of source2 .

SYNTAX

[Link](source1, source2) → series bool

ARGUMENTS

source1 (series int/float) First data series.

source2 (series int/float) Second data series.

RETURNS

true if source1 crossed over source2 otherwise false.

[Link]()
The source1 -series is defined as having crossed under source2 -series if, on the current bar, the value of sourc
e1 is less than the value of source2 , and on the previous bar, the value of source1 was greater than or equal to
the value of source2 .

SYNTAX

[Link](source1, source2) → series bool

ARGUMENTS

source1 (series int/float) First data series.

source2 (series int/float) Second data series.

RETURNS

true if source1 crossed under source2 otherwise false.

[Link]()
Cumulative (total) sum of source . In other words it's a sum of all elements of source .

SYNTAX

[Link](source) → series float

ARGUMENTS

source (series int/float) Source used for the calculation.

RETURNS

Total sum series.

SEE ALSO

[Link]()

[Link]()
Measure of difference between the series and it's [Link]()

SYNTAX

[Link](source, length) → series float

ARGUMENTS

source (series int/float) Series of values to process.

length (series int) Number of bars (length).

EXAMPLE

//@version=6
indicator("[Link]")
plot([Link](close, 10))

// the same on pine

pine_dev(source, length) =>
mean = [Link](source, length)
sum = 0.0
for i = 0 to length - 1
val = source[i]
sum := sum + [Link](val - mean)
dev = sum/length
plot(pine_dev(close, 10))
RETURNS

Deviation of source for length bars back.

REMARKS

na values in the source series are ignored.

SEE ALSO

[Link]() [Link]()

[Link]()
The dmi function returns the directional movement index.

SYNTAX

[Link](diLength, adxSmoothing) → [series float, series float, series float]

ARGUMENTS

diLength (simple int) DI Period.

adxSmoothing (simple int) ADX Smoothing Period.

EXAMPLE

//@version=6
indicator(title="Directional Movement Index", shorttitle="DMI", format=[Link], precision=4)
len = [Link](17, minval=1, title="DI Length")
lensig = [Link](14, title="ADX Smoothing", minval=1)
[diplus, diminus, adx] = [Link](len, lensig)
plot(adx, color=[Link], title="ADX")
plot(diplus, color=[Link], title="+DI")
plot(diminus, color=[Link], title="-DI")

RETURNS

Tuple of three DMI series: Positive Directional Movement (+DI), Negative Directional Movement (-DI) and Average
Directional Movement Index (ADX).

SEE ALSO

[Link]() [Link]() [Link]()

[Link]()
The ema function returns the exponentially weighted moving average. In ema weighting factors decrease
exponentially. It calculates by using a formula: EMA = alpha * source + (1 - alpha) * EMA[1] , where alp
ha = 2 / (length + 1) .

SYNTAX

[Link](source, length) → series float

ARGUMENTS

source (series int/float) Series of values to process.

length (simple int) Number of bars (length).

EXAMPLE

//@version=6
indicator("[Link]")
plot([Link](close, 15))

//the same on pine

pine_ema(src, length) =>
alpha = 2 / (length + 1)
sum = 0.0
sum := na(sum[1]) ? src : alpha * src + (1 - alpha) * nz(sum[1])
plot(pine_ema(close,15))

RETURNS

Exponential moving average of source with alpha = 2 / (length + 1).

REMARKS

Please note that using this variable/function can cause indicator repainting.
na values in the source series are ignored; the function calculates on the length quantity of non- na values.

SEE ALSO

[Link]() [Link]() [Link]() [Link]() [Link]() [Link]()

[Link]()
Test if the source series is now falling for length bars long.

SYNTAX

[Link](source, length) → series bool

ARGUMENTS

source (series int/float) Series of values to process.

length (series int) Number of bars (length).

RETURNS

true if current source value is less than any previous source value for length bars back, false otherwise.

REMARKS

na values in the source series are ignored; the function calculates on the length quantity of non- na values.

SEE ALSO

[Link]()

[Link]()
Highest value for a given number of bars back.

SYNTAX

[Link](source, length) → series float

ARGUMENTS

source (series int/float) Series of values to process.

length (series int) Number of bars (length).

RETURNS

Highest value in the series.

REMARKS
Two args version: source is a series and length is the number of bars back.

One arg version: length is the number of bars back. Algorithm uses high as a source series.

na values in the source series are ignored.

SEE ALSO

[Link]() [Link]() [Link]() [Link]() [Link]()

[Link]()
Highest value offset for a given number of bars back.

SYNTAX

[Link](source, length) → series int

ARGUMENTS

source (series int/float) Series of values to process.

length (series int) Number of bars (length).

RETURNS

Offset to the highest bar.

REMARKS

Two args version: source is a series and length is the number of bars back.

One arg version: length is the number of bars back. Algorithm uses high as a source series.

na values in the source series are ignored.

SEE ALSO

[Link]() [Link]() [Link]() [Link]() [Link]()

[Link]()
The hma function returns the Hull Moving Average.

SYNTAX

[Link](source, length) → series float

ARGUMENTS

source (series int/float) Series of values to process.

length (simple int) Number of bars.

EXAMPLE

//@version=6
indicator("Hull Moving Average")
src = input(defval=close, title="Source")
length = input(defval=9, title="Length")
hmaBuildIn = [Link](src, length)
plot(hmaBuildIn, title="Hull MA", color=#674EA7)

RETURNS

Hull moving average of 'source' for 'length' bars back.

REMARKS
na values in the source series are ignored.

SEE ALSO

[Link]() [Link]() [Link]() [Link]() [Link]()

[Link]()
Keltner Channels. Keltner channel is a technical analysis indicator showing a central moving average line plus channel
lines at a distance above and below.

SYNTAX

[Link](series, length, mult, useTrueRange) → [series float, series float, series float]

ARGUMENTS

series (series int/float) Series of values to process.

length (simple int) Number of bars (length).

mult (simple int/float) Standard deviation factor.

useTrueRange (simple bool) An optional parameter. Specifies if True Range is used; default is true. If the value is
false, the range will be calculated with the expression (high - low).

EXAMPLE

//@version=6
indicator("[Link]")

[middle, upper, lower] = [Link](close, 5, 4)

plot(middle, color=[Link])
plot(upper, color=[Link])
plot(lower, color=[Link])

// the same on pine

f_kc(src, length, mult, useTrueRange) =>
float basis = [Link](src, length)
float span = (useTrueRange) ? [Link] : (high - low)
float rangeEma = [Link](span, length)
[basis, basis + rangeEma * mult, basis - rangeEma * mult]

[pineMiddle, pineUpper, pineLower] = f_kc(close, 5, 4, true)

plot(pineMiddle)
plot(pineUpper)
plot(pineLower)

RETURNS

Keltner Channels.

REMARKS

na values in the source series are ignored; the function calculates on the length quantity of non- na values.

SEE ALSO

[Link]() [Link]() [Link]()

[Link]()
Keltner Channels Width. The Keltner Channels Width is the difference between the upper and the lower Keltner
Channels divided by the middle channel.

SYNTAX
[Link](series, length, mult, useTrueRange) → series float

ARGUMENTS

series (series int/float) Series of values to process.

length (simple int) Number of bars (length).

mult (simple int/float) Standard deviation factor.

useTrueRange (simple bool) An optional parameter. Specifies if True Range is used; default is true. If the value is
false, the range will be calculated with the expression (high - low).

EXAMPLE

//@version=6
indicator("[Link]")

plot([Link](close, 5, 4), color=[Link])

// the same on pine

f_kcw(src, length, mult, useTrueRange) =>
float basis = [Link](src, length)
float span = (useTrueRange) ? [Link] : (high - low)
float rangeEma = [Link](span, length)

((basis + rangeEma * mult) - (basis - rangeEma * mult)) / basis

plot(f_kcw(close, 5, 4, true))

RETURNS

Keltner Channels Width.

REMARKS

na values in the source series are ignored; the function calculates on the length quantity of non- na values.

SEE ALSO

[Link]() [Link]() [Link]() [Link]()

[Link]()
Linear regression curve. A line that best fits the prices specified over a user-defined time period. It is calculated using
the least squares method. The result of this function is calculated using the formula: linreg = intercept + slope * (length
- 1 - offset), where intercept and slope are the values calculated with the least squares method on source series.

SYNTAX

[Link](source, length, offset) → series float

ARGUMENTS

source (series int/float) Source series.

length (series int) Number of bars (length).

offset (simple int) Offset.

RETURNS

Linear regression curve.

REMARKS

na values in the source series are included in calculations and will produce an na result.

[Link]()
Lowest value for a given number of bars back.

SYNTAX

[Link](source, length) → series float

ARGUMENTS

source (series int/float) Series of values to process.

length (series int) Number of bars (length).

RETURNS

Lowest value in the series.

REMARKS

Two args version: source is a series and length is the number of bars back.

One arg version: length is the number of bars back. Algorithm uses low as a source series.

na values in the source series are ignored.

SEE ALSO

[Link]() [Link]() [Link]() [Link]() [Link]()

[Link]()
Lowest value offset for a given number of bars back.

SYNTAX

[Link](source, length) → series int

ARGUMENTS

source (series int/float) Series of values to process.

length (series int) Number of bars back.

RETURNS

Offset to the lowest bar.

REMARKS

Two args version: source is a series and length is the number of bars back.

One arg version: length is the number of bars back. Algorithm uses low as a source series.

na values in the source series are ignored.

SEE ALSO

[Link]() [Link]() [Link]() [Link]() [Link]()

[Link]()
MACD (moving average convergence/divergence). It is supposed to reveal changes in the strength, direction,
momentum, and duration of a trend in a stock's price.

SYNTAX

[Link](source, fastlen, slowlen, siglen) → [series float, series float, series float]

ARGUMENTS

source (series int/float) Series of values to process.

fastlen (simple int) Fast Length parameter.

slowlen (simple int) Slow Length parameter.

siglen (simple int) Signal Length parameter.

EXAMPLE

//@version=6
indicator("MACD")
[macdLine, signalLine, histLine] = [Link](close, 12, 26, 9)
plot(macdLine, color=[Link])
plot(signalLine, color=[Link])
plot(histLine, color=[Link], style=plot.style_histogram)

If you need only one value, use placeholders '_' like this:

EXAMPLE

//@version=6
indicator("MACD")
[_, signalLine, _] = [Link](close, 12, 26, 9)
plot(signalLine, color=[Link])

RETURNS

Tuple of three MACD series: MACD line, signal line and histogram line.

REMARKS

na values in the source series are ignored; the function calculates on the length quantity of non- na values.

SEE ALSO

[Link]() [Link]()

[Link]()
Returns the all-time high value of source from the beginning of the chart up to the current bar.

SYNTAX

[Link](source) → series float

ARGUMENTS

source (series int/float) Source used for the calculation.

REMARKS

[Link]() 2 overloads

Returns the median of the series.

SYNTAX & OVERLOADS

[Link](source, length) → series int

[Link](source, length) → series float

ARGUMENTS
source (series int) Series of values to process.

length (series int) Number of bars (length).

RETURNS

The median of the series.

REMARKS

na values in the source series are ignored; the function calculates on the length quantity of non- na values.

[Link]()
Money Flow Index. The Money Flow Index (MFI) is a technical oscillator that uses price and volume for identifying
overbought or oversold conditions in an asset.

SYNTAX

[Link](series, length) → series float

ARGUMENTS

series (series int/float) Series of values to process.

length (series int) Number of bars (length).

EXAMPLE

//@version=6
indicator("Money Flow Index")

plot([Link](hlc3, 14), color=[Link])

// the same on pine

pine_mfi(src, length) =>
float upper = [Link](volume * ([Link](src) <= 0.0 ? 0.0 : src), length)
float lower = [Link](volume * ([Link](src) >= 0.0 ? 0.0 : src), length)
mfi = 100.0 - (100.0 / (1.0 + upper / lower))
mfi

plot(pine_mfi(hlc3, 14))

RETURNS

Money Flow Index.

REMARKS

na values in the source series are ignored; the function calculates on the length quantity of non- na values.

SEE ALSO

[Link]() [Link]()

[Link]()
Returns the all-time low value of source from the beginning of the chart up to the current bar.

SYNTAX

[Link](source) → series float

ARGUMENTS

source (series int/float) Source used for the calculation.

REMARKS
na

[Link]() 2 overloads

Returns the mode of the series. If there are several values with the same frequency, it returns the smallest value.

SYNTAX & OVERLOADS

[Link](source, length) → series int

[Link](source, length) → series float

ARGUMENTS

source (series int) Series of values to process.

length (series int) Number of bars (length).

RETURNS

The most frequently occurring value from the source . If none exists, returns the smallest value instead.

REMARKS

na values in the source series are ignored; the function calculates on the length quantity of non- na values.

[Link]()
Momentum of source price and source price length bars ago. This is simply a difference: source -
source[length].

SYNTAX

[Link](source, length) → series float

ARGUMENTS

source (series int/float) Series of values to process.

length (series int) Offset from the current bar to the previous bar.

RETURNS

Momentum of source price and source price length bars ago.

REMARKS

na values in the source series are included in calculations and will produce an na result.

SEE ALSO

[Link]()

ta.percentile_linear_interpolation()
Calculates percentile using method of linear interpolation between the two nearest ranks.

SYNTAX

ta.percentile_linear_interpolation(source, length, percentage) → series float

ARGUMENTS

source (series int/float) Series of values to process (source).

length (series int) Number of bars back (length).
percentage (simple int/float) Percentage, a number from range 0..100.

RETURNS

P-th percentile of source series for length bars back.

REMARKS

Note that a percentile calculated using this method will NOT always be a member of the input data set.

na values in the source series are included in calculations and will produce an na result.

SEE ALSO

ta.percentile_nearest_rank()

ta.percentile_nearest_rank()
Calculates percentile using method of Nearest Rank.

SYNTAX

ta.percentile_nearest_rank(source, length, percentage) → series float

ARGUMENTS

source (series int/float) Series of values to process (source).

length (series int) Number of bars back (length).

percentage (simple int/float) Percentage, a number from range 0..100.

RETURNS

P-th percentile of source series for length bars back.

REMARKS

Using the Nearest Rank method on lengths less than 100 bars back can result in the same number being used for
more than one percentile.
A percentile calculated using the Nearest Rank method will always be a member of the input data set.

The 100th percentile is defined to be the largest value in the input data set.
na values in the source series are ignored.

SEE ALSO

ta.percentile_linear_interpolation()

[Link]()
Percent rank is the percents of how many previous values was less than or equal to the current value of given series.

SYNTAX

[Link](source, length) → series float

ARGUMENTS

source (series int/float) Series of values to process.

length (series int) Number of bars (length).

RETURNS

Percent rank of source for length bars back.

REMARKS

na values in the source series are included in calculations and will produce an na result.
ta.pivot_point_levels()
Calculates the pivot point levels using the specified type and anchor .

SYNTAX

ta.pivot_point_levels(type, anchor, developing) → array<float>

ARGUMENTS

type (series string) The type of pivot point levels. Possible values: "Traditional", "Fibonacci", "Woodie", "Classic",
"DM", "Camarilla".
anchor (series bool) The condition that triggers the reset of the pivot point calculations. When true, calculations
reset; when false, results calculated at the last reset persist.
developing (series bool) If false, the values are those calculated the last time the anchor condition was true. They
remain constant until the anchor condition becomes true again. If true, the pivots are developing, i.e., they constantly
recalculate on the data developing between the point of the last anchor (or bar zero if the anchor condition was never
true) and the current bar. Optional. The default is false.

EXAMPLE

//@version=6
indicator("Weekly Pivots", max_lines_count=500, overlay=true)
timeframe = "1W"
typeInput = [Link]("Traditional", "Type", options=["Traditional", "Fibonacci", "Woodie", "Classi
c", "DM", "Camarilla"])
weekChange = [Link](timeframe)
pivotPointsArray = ta.pivot_point_levels(typeInput, weekChange)
if weekChange
for pivotLevel in pivotPointsArray
[Link](time, pivotLevel, time + timeframe.in_seconds(timeframe) * 1000, pivotLevel, xloc=xlo
c.bar_time)

RETURNS

An array<float> with numerical values representing 11 pivot point levels: [P, R1, S1, R2, S2, R3, S3, R4, S4, R5,
S5]. Levels absent from the specified type return na values (e.g., "DM" only calculates P, R1, and S1).

REMARKS

The developing parameter cannot be true when type is set to "Woodie", because the Woodie calculation for a
period depends on that period's open, which means that the pivot value is either available or unavailable, but never
developing. If used together, the indicator will return a runtime error.

[Link]() 2 overloads

This function returns price of the pivot high point. It returns 'NaN', if there was no pivot high point.

SYNTAX & OVERLOADS

[Link](leftbars, rightbars) → series float

[Link](source, leftbars, rightbars) → series float

ARGUMENTS

leftbars (series int/float) Left strength.

rightbars (series int/float) Right strength.

EXAMPLE
//@version=6
indicator("PivotHigh", overlay=true)
leftBars = input(2)
rightBars=input(2)
ph = [Link](leftBars, rightBars)
plot(ph, style=plot.style_cross, linewidth=3, color= [Link], offset=-rightBars)

RETURNS

Price of the point or 'NaN'.

REMARKS

If parameters 'leftbars' or 'rightbars' are series you should use max_bars_back() function for the 'source' variable.

[Link]() 2 overloads

This function returns price of the pivot low point. It returns 'NaN', if there was no pivot low point.

SYNTAX & OVERLOADS

[Link](leftbars, rightbars) → series float

[Link](source, leftbars, rightbars) → series float

ARGUMENTS

leftbars (series int/float) Left strength.

rightbars (series int/float) Right strength.

EXAMPLE

//@version=6
indicator("PivotLow", overlay=true)
leftBars = input(2)
rightBars=input(2)
pl = [Link](close, leftBars, rightBars)
plot(pl, style=plot.style_cross, linewidth=3, color= [Link], offset=-rightBars)

RETURNS

Price of the point or 'NaN'.

REMARKS

If parameters 'leftbars' or 'rightbars' are series you should use max_bars_back() function for the 'source' variable.

[Link]() 2 overloads

Returns the difference between the min and max values in a series.

SYNTAX & OVERLOADS

[Link](source, length) → series int

[Link](source, length) → series float

ARGUMENTS

source (series int) Series of values to process.

length (series int) Number of bars (length).

RETURNS
The difference between the min and max values in the series.

REMARKS

na values in the source series are ignored; the function calculates on the length quantity of non- na values.

[Link]()
Calculates the Rank Correlation Index (RCI), which measures the directional consistency of price movements. It
evaluates the monotonic relationship between a source series and the bar index over length bars using
Spearman's rank correlation coefficient. The resulting value is scaled to a range of -100 to 100, where 100 indicates
the source consistently increased over the period, and -100 indicates it consistently decreased. Values between
-100 and 100 reflect varying degrees of upward or downward consistency.

SYNTAX

[Link](source, length) → series float

ARGUMENTS

source (series int/float) Series of values to process.

length (simple int) Number of bars (length).

RETURNS

The Rank Correlation Index, a value between -100 to 100.

SEE ALSO

[Link]()
Test if the source series is now rising for length bars long.

SYNTAX

[Link](source, length) → series bool

ARGUMENTS

source (series int/float) Series of values to process.

length (series int) Number of bars (length).

RETURNS

true if current source is greater than any previous source for length bars back, false otherwise.

REMARKS

na values in the source series are ignored.

SEE ALSO

[Link]()

[Link]()
Moving average used in RSI. It is the exponentially weighted moving average with alpha = 1 / length.

SYNTAX

[Link](source, length) → series float

ARGUMENTS
source (series int/float) Series of values to process.

length (simple int) Number of bars (length).

EXAMPLE

//@version=6
indicator("[Link]")
plot([Link](close, 15))

//the same on pine

pine_rma(src, length) =>
alpha = 1/length
sum = 0.0
sum := na(sum[1]) ? [Link](src, length) : alpha * src + (1 - alpha) * nz(sum[1])
plot(pine_rma(close, 15))

RETURNS

Exponential moving average of source with alpha = 1 / length .

REMARKS

na values in the source series are ignored; the function calculates on the length quantity of non- na values.

SEE ALSO

[Link]() [Link]() [Link]() [Link]() [Link]() [Link]() [Link]()

[Link]()
Calculates the percentage of change (rate of change) between the current value of source and its value length
bars ago.

It is calculated by the formula: 100 * change(src, length) / src[length].

SYNTAX

[Link](source, length) → series float

ARGUMENTS

source (series int/float) Series of values to process.

length (series int) Number of bars (length).

RETURNS

The rate of change of source for length bars back.

REMARKS

na values in the source series are included in calculations and will produce an na result.

[Link]()
Relative strength index. It is calculated using the [Link]() of upward and downward changes of source over the
last length bars.

SYNTAX

[Link](source, length) → series float

ARGUMENTS

source (series int/float) Series of values to process.

length (simple int) Number of bars (length).

EXAMPLE

//@version=6
indicator("[Link]")
plot([Link](close, 7))

// same on pine, but less efficient

pine_rsi(x, y) =>
u = [Link](x - x[1], 0) // upward [Link]
d = [Link](x[1] - x, 0) // downward [Link]
rs = [Link](u, y) / [Link](d, y)
res = 100 - 100 / (1 + rs)
res

plot(pine_rsi(close, 7))

RETURNS

Relative strength index.

REMARKS

na values in the source series are ignored; the function calculates on the length quantity of non- na values.

SEE ALSO

[Link]()

[Link]()
Parabolic SAR (parabolic stop and reverse) is a method devised by J. Welles Wilder, Jr., to find potential reversals in
the market price direction of traded goods.

SYNTAX

[Link](start, inc, max) → series float

ARGUMENTS

start (simple int/float) Start.

inc (simple int/float) Increment.

max (simple int/float) Maximum.

EXAMPLE

//@version=6
indicator("[Link]")
plot([Link](0.02, 0.02, 0.2), style=plot.style_cross, linewidth=3)

// The same on Pine Script®

pine_sar(start, inc, max) =>
var float result = na
var float maxMin = na
var float acceleration = na
var bool isBelow = false
bool isFirstTrendBar = false

if bar_index == 1
if close > close[1]
isBelow := true
maxMin := high
result := low[1]
else
isBelow := false
maxMin := low
result := high[1]
isFirstTrendBar := true
acceleration := start
result := result + acceleration * (maxMin - result)

if isBelow
if result > low
isFirstTrendBar := true
isBelow := false
result := [Link](high, maxMin)
maxMin := low
acceleration := start
else
if result < high
isFirstTrendBar := true
isBelow := true
result := [Link](low, maxMin)
maxMin := high
acceleration := start

if not isFirstTrendBar
if isBelow
if high > maxMin
maxMin := high
acceleration := [Link](acceleration + inc, max)
else
if low < maxMin
maxMin := low
acceleration := [Link](acceleration + inc, max)

if isBelow
result := [Link](result, low[1])
if bar_index > 1
result := [Link](result, low[2])

else
result := [Link](result, high[1])
if bar_index > 1
result := [Link](result, high[2])

result

plot(pine_sar(0.02, 0.02, 0.2), style=plot.style_cross, linewidth=3)

RETURNS

Parabolic SAR.

[Link]()
The sma function returns the moving average, that is the sum of last y values of x, divided by y.

SYNTAX

[Link](source, length) → series float

ARGUMENTS

source (series int/float) Series of values to process.

length (series int) Number of bars (length).

EXAMPLE

//@version=6
indicator("[Link]")
plot([Link](close, 15))

// same on pine, but much less efficient

pine_sma(x, y) =>
sum = 0.0
for i = 0 to y - 1
sum := sum + x[i] / y
sum
plot(pine_sma(close, 15))
RETURNS

Simple moving average of source for length bars back.

REMARKS

na values in the source series are ignored.

SEE ALSO

[Link]() [Link]() [Link]() [Link]() [Link]() [Link]()

[Link]()

SYNTAX

[Link](source, length, biased) → series float

ARGUMENTS

source (series int/float) Series of values to process.

length (series int) Number of bars (length).

biased (series bool) Determines which estimate should be used. Optional. The default is true.

EXAMPLE

//@version=6
indicator("[Link]")
plot([Link](close, 5))

//the same on pine

isZero(val, eps) => [Link](val) <= eps

SUM(fst, snd) =>

EPS = 1e-10
res = fst + snd
if isZero(res, EPS)
res := 0
else
if not isZero(res, 1e-4)
res := res
else
15

pine_stdev(src, length) =>

avg = [Link](src, length)
sumOfSquareDeviations = 0.0
for i = 0 to length - 1
sum = SUM(src[i], -avg)
sumOfSquareDeviations := sumOfSquareDeviations + sum * sum

stdev = [Link](sumOfSquareDeviations / length)

plot(pine_stdev(close, 5))

RETURNS

Standard deviation.

REMARKS

If biased is true, function will calculate using a biased estimate of the entire population, if false - unbiased estimate
of a sample.
na values in the source series are ignored; the function calculates on the length quantity of non- na values.

SEE ALSO

[Link]() [Link]()
[Link]()
Stochastic. It is calculated by a formula: 100 * (close - lowest(low, length)) / (highest(high, length) - lowest(low,
length)).

SYNTAX

[Link](source, high, low, length) → series float

ARGUMENTS

source (series int/float) Source series.

high (series int/float) Series of high.

low (series int/float) Series of low.

length (series int) Length (number of bars back).

RETURNS

Stochastic.

REMARKS

na values in the source series are ignored.

SEE ALSO

[Link]()

[Link]()
The Supertrend Indicator. The Supertrend is a trend following indicator.

SYNTAX

[Link](factor, atrPeriod) → [series float, series float]

ARGUMENTS

factor (series int/float) The multiplier by which the ATR will get multiplied.

atrPeriod (simple int) Length of ATR.

EXAMPLE

//@version=6
indicator("Pine Script® Supertrend")

[supertrend, direction] = [Link](3, 10)

plot(direction < 0 ? supertrend : na, "Up direction", color = [Link], style=plot.style_linebr)
plot(direction > 0 ? supertrend : na, "Down direction", color = [Link], style=plot.style_linebr)

// The same on Pine Script®

pine_supertrend(factor, atrPeriod) =>
src = hl2
atr = [Link](atrPeriod)
upperBand = src + factor * atr
lowerBand = src - factor * atr
prevLowerBand = nz(lowerBand[1])
prevUpperBand = nz(upperBand[1])

lowerBand := lowerBand > prevLowerBand or close[1] < prevLowerBand ? lowerBand : prevLowerBand

upperBand := upperBand < prevUpperBand or close[1] > prevUpperBand ? upperBand : prevUpperBand
int _direction = na
float superTrend = na
prevSuperTrend = superTrend[1]
if na(atr[1])
_direction := 1
else if prevSuperTrend == prevUpperBand
_direction := close > upperBand ? -1 : 1
else
_direction := close < lowerBand ? 1 : -1
superTrend := _direction == -1 ? lowerBand : upperBand
[superTrend, _direction]

[Pine_Supertrend, pineDirection] = pine_supertrend(3, 10)

plot(pineDirection < 0 ? Pine_Supertrend : na, "Up direction", color = [Link], style=plot.style_li
nebr)
plot(pineDirection > 0 ? Pine_Supertrend : na, "Down direction", color = [Link], style=plot.style_li
nebr)

RETURNS

Tuple of two supertrend series: supertrend line and direction of trend. Possible values are 1 (down direction) and -1
(up direction).

SEE ALSO

[Link]()

[Link]()
Symmetrically weighted moving average with fixed length: 4. Weights: [1/6, 2/6, 2/6, 1/6].

SYNTAX

[Link](source) → series float

ARGUMENTS

source (series int/float) Source series.

EXAMPLE

//@version=6
indicator("[Link]")
plot([Link](close))

// same on pine, but less efficient

pine_swma(x) =>
x[3] * 1 / 6 + x[2] * 2 / 6 + x[1] * 2 / 6 + x[0] * 1 / 6
plot(pine_swma(close))

RETURNS

Symmetrically weighted moving average.

REMARKS

na values in the source series are included in calculations and will produce an na result.

SEE ALSO

[Link]() [Link]() [Link]() [Link]() [Link]() [Link]()

[Link]()
Calculates the current bar's true range. Unlike a bar's actual range ( high - low ), true range accounts for potential
gaps by taking the maximum of the current bar's actual range and the absolute distances from the previous bar's close
to the current bar's high and low. The formula is: [Link](high - low, [Link](high - close[1]), mat
[Link](low - close[1])) .

SYNTAX
[Link](handle_na) → series float

ARGUMENTS

handle_na (simple bool) Defines how the function calculates the result when the previous bar's close is na. If true,
the function returns the bar's high - low value. If false, it returns na.

RETURNS

True range. It is [Link](high - low, [Link](high - close[1]), [Link](low - close[1])).

REMARKS

[Link](false) is exactly the same as [Link].

SEE ALSO

[Link] [Link]()

[Link]()
True strength index. It uses moving averages of the underlying momentum of a financial instrument.

SYNTAX

[Link](source, short_length, long_length) → series float

ARGUMENTS

source (series int/float) Source series.

short_length (simple int) Short length.

long_length (simple int) Long length.

RETURNS

True strength index. A value in range [-1, 1].

REMARKS

na values in the source series are ignored; the function calculates on the length quantity of non- na values.

[Link]() 4 overloads

Returns the value of the source series on the bar where the condition was true on the nth most recent
occurrence.

SYNTAX & OVERLOADS

[Link](condition, source, occurrence) → series color

[Link](condition, source, occurrence) → series int

[Link](condition, source, occurrence) → series float

[Link](condition, source, occurrence) → series bool

ARGUMENTS

condition (series bool) The condition to search for.

source (series color) The value to be returned from the bar where the condition is met.

occurrence (simple int) The occurrence of the condition. The numbering starts from 0 and goes back in time, so '0' is
the most recent occurrence of condition , '1' is the second most recent and so forth. Must be an integer >= 0.

EXAMPLE

//@version=6
indicator("[Link]")
slow = [Link](close, 7)
fast = [Link](close, 14)
// Get value of `close` on second most recent cross
plot([Link]([Link](slow, fast), close, 1))

REMARKS

This function requires execution on every bar. It is not recommended to use it inside a for or while loop structure,
where its behavior can be unexpected. Please note that using this function can cause indicator repainting.

SEE ALSO

[Link]() [Link]() [Link]() [Link]() [Link]()

[Link]()
Variance is the expectation of the squared deviation of a series from its mean ([Link]()), and it informally measures
how far a set of numbers are spread out from their mean.

SYNTAX

[Link](source, length, biased) → series float

ARGUMENTS

source (series int/float) Series of values to process.

length (series int) Number of bars (length).

biased (series bool) Determines which estimate should be used. Optional. The default is true.

RETURNS

Variance of source for length bars back.

REMARKS

SEE ALSO

[Link]() [Link]()

[Link]() 2 overloads

Volume weighted average price.

SYNTAX & OVERLOADS

[Link](source, anchor) → series float

[Link](source, anchor, stdev_mult) → [series float, series float, series float]

ARGUMENTS

source (series int/float) Source used for the VWAP calculation.

anchor (series bool) The condition that triggers the reset of VWAP calculations. When true, calculations reset; when
false, calculations proceed using the values accumulated since the previous reset. Optional. The default is equivalent
to passing [Link]() with "1D" as its argument.

EXAMPLE

//@version=6
indicator("Simple VWAP")
vwap = [Link](open)
plot(vwap)

EXAMPLE

//@version=6
indicator("Advanced VWAP")
vwapAnchorInput = [Link]("Daily", "Anchor", options = ["Daily", "Weekly", "Monthly"])
stdevMultiplierInput = [Link](1.0, "Standard Deviation Multiplier")
anchorTimeframe = switch vwapAnchorInput
"Daily" => "1D"
"Weekly" => "1W"
"Monthly" => "1M"
anchor = [Link](anchorTimeframe)
[vwap, upper, lower] = [Link](open, anchor, stdevMultiplierInput)
plot(vwap)
plot(upper, color = [Link])
plot(lower, color = [Link])

RETURNS

A VWAP series, or a tuple [vwap, upper_band, lower_band] if stdev_mult is specified.

REMARKS

Calculations only begin the first time the anchor condition becomes true. Until then, the function returns na.

SEE ALSO

[Link]

[Link]()
The vwma function returns volume-weighted moving average of source for length bars back. It is the same as:
sma(source * volume, length) / sma(volume, length).

SYNTAX

[Link](source, length) → series float

ARGUMENTS

source (series int/float) Series of values to process.

length (series int) Number of bars (length).

EXAMPLE

//@version=6
indicator("[Link]")
plot([Link](close, 15))

// same on pine, but less efficient

pine_vwma(x, y) =>
[Link](x * volume, y) / [Link](volume, y)
plot(pine_vwma(close, 15))
RETURNS

Volume-weighted moving average of source for length bars back.

REMARKS

na values in the source series are ignored.

SEE ALSO

[Link]() [Link]() [Link]() [Link]() [Link]() [Link]()

[Link]()
The wma function returns weighted moving average of source for length bars back. In wma weighting factors
decrease in arithmetical progression.

SYNTAX

[Link](source, length) → series float

ARGUMENTS

source (series int/float) Series of values to process.

length (series int) Number of bars (length).

EXAMPLE

//@version=6
indicator("[Link]")
plot([Link](close, 15))

// same on pine, but much less efficient

pine_wma(x, y) =>
norm = 0.0
sum = 0.0
for i = 0 to y - 1
weight = (y - i) * y
norm := norm + weight
sum := sum + x[i] * weight
sum / norm
plot(pine_wma(close, 15))

RETURNS

Weighted moving average of source for length bars back.

REMARKS

na values in the source series are ignored.

SEE ALSO

[Link]() [Link]() [Link]() [Link]() [Link]() [Link]()

[Link]()
Williams %R. The oscillator shows the current closing price in relation to the high and low of the past 'length' bars.

SYNTAX

[Link](length) → series float

This function does not create the table itself, but defines the table’s cells. To use it, you first need to create a table
object with [Link]().

Each [Link]() call overwrites all previously defined properties of a cell. If you call [Link]() twice in a row, e.g., the
first time with text='Test Text', and the second time with text_color=[Link] but without a new text argument, the
default value of the 'text' being an empty string, it will overwrite 'Test Text', and your cell will display an empty string. If
you want, instead, to modify any of the cell's properties, use the table.cell_set_*() functions.

A single script can only display one table in each of the possible locations. If [Link]() is used on several bars to
change the same attribute of a cell (e.g. change the background color of the cell to red on the first bar, then to yellow
on the second bar), only the last change will be reflected in the table, i.e., the cell’s background will be yellow. Avoid
unnecessary setting of cell properties by enclosing function calls in an if [Link] block whenever possible, to
restrict their execution to the last bar of the series.

SEE ALSO

table.cell_set_bgcolor() table.cell_set_height() table.cell_set_text() table.cell_set_text_formatting()

table.cell_set_text_color() table.cell_set_text_halign() table.cell_set_text_size() table.cell_set_text_valign()

table.cell_set_width() table.cell_set_tooltip()

table.cell_set_bgcolor()
The function sets the background color of the cell.

SYNTAX

table.cell_set_bgcolor(table_id, column, row, bgcolor) → void

ARGUMENTS

table_id (series table) A table object.

column (series int) The index of the cell's column. Numbering starts at 0.

row (series int) The index of the cell's row. Numbering starts at 0.
bgcolor (series color) The background color of the cell.

SEE ALSO

table.cell_set_height() table.cell_set_text() table.cell_set_text_color() table.cell_set_text_halign()

table.cell_set_text_size() table.cell_set_text_valign() table.cell_set_width() table.cell_set_tooltip()

table.cell_set_height()
The function sets the height of cell.
SYNTAX

table.cell_set_height(table_id, column, row, height) → void

ARGUMENTS

table_id (series table) A table object.

column (series int) The index of the cell's column. Numbering starts at 0.

row (series int) The index of the cell's row. Numbering starts at 0.
height (series int/float) The height of the cell as a % of the chart window. Passing 0 auto-adjusts the height based on
the text inside of the cell.

SEE ALSO

table.cell_set_bgcolor() table.cell_set_text() table.cell_set_text_color() table.cell_set_text_halign()

table.cell_set_text_size() table.cell_set_text_valign() table.cell_set_width() table.cell_set_tooltip()

table.cell_set_text()
The function sets the text in the specified cell.

SYNTAX

table.cell_set_text(table_id, column, row, text) → void

ARGUMENTS

table_id (series table) A table object.

column (series int) The index of the cell's column. Numbering starts at 0.

row (series int) The index of the cell's row. Numbering starts at 0.

text (series string) The text to be displayed inside the cell.

EXAMPLE

//@version=6
indicator("TABLE example")
var tLog = [Link](position = position.top_left, rows = 1, columns = 2, bgcolor = [Link], borde
r_width=1)
[Link](tLog, row = 0, column = 0, text = "sometext", text_color = [Link])
table.cell_set_text(tLog, row = 0, column = 0, text = "sometext")

SEE ALSO

table.cell_set_bgcolor() table.cell_set_height() table.cell_set_text_color() table.cell_set_text_halign()

table.cell_set_text_size() table.cell_set_text_valign() table.cell_set_width() table.cell_set_tooltip()

table.cell_set_text_formatting()

table.cell_set_text_color()
The function sets the color of the text inside the cell.

SYNTAX

table.cell_set_text_color(table_id, column, row, text_color) → void

ARGUMENTS

table_id (series table) A table object.

column (series int) The index of the cell's column. Numbering starts at 0.

row (series int) The index of the cell's row. Numbering starts at 0.
text_color (series color) The color of the text.

SEE ALSO

table.cell_set_bgcolor() table.cell_set_height() table.cell_set_text() table.cell_set_text_halign()

table.cell_set_text_size() table.cell_set_text_valign() table.cell_set_width() table.cell_set_tooltip()

table.cell_set_text_font_family()
The function sets the font family of the text inside the cell.

SYNTAX

table.cell_set_text_font_family(table_id, column, row, text_font_family) → void

ARGUMENTS

table_id (series table) A table object.

column (series int) The index of the cell's column. Numbering starts at 0.
row (series int) The index of the cell's row. Numbering starts at 0.

text_font_family (series string) The font family of the text. Possible values: font.family_default,
font.family_monospace.

EXAMPLE

//@version=6
indicator("Example of setting the table cell font")
var t = [Link](position.top_left, rows = 1, columns = 1)
[Link](t, 0, 0, "monospace", text_color = [Link])
table.cell_set_text_font_family(t, 0, 0, font.family_monospace)

SEE ALSO

table.cell_set_text_halign() table.cell_set_text_size() table.cell_set_width() table.cell_set_tooltip()

table.cell_set_tooltip()
The function sets the tooltip in the specified cell.

SYNTAX

table.cell_set_tooltip(table_id, column, row, tooltip) → void

ARGUMENTS

table_id (series table) A table object.

column (series int) The index of the cell's column. Numbering starts at 0.
row (series int) The index of the cell's row. Numbering starts at 0.

tooltip (series string) The tooltip to be displayed inside the cell.

EXAMPLE

SEE ALSO

table.cell_set_bgcolor() table.cell_set_height() table.cell_set_text_color() table.cell_set_text_halign()

table.cell_set_text_size() table.cell_set_text_valign() table.cell_set_width() table.cell_set_text()

table.cell_set_width()
The function sets the width of the cell.

SYNTAX

table.cell_set_width(table_id, column, row, width) → void

ARGUMENTS

table_id (series table) A table object.

column (series int) The index of the cell's column. Numbering starts at 0.

row (series int) The index of the cell's row. Numbering starts at 0.
width (series int/float) The width of the cell as a % of the chart window. Passing 0 auto-adjusts the width based on
the text inside of the cell.
SEE ALSO

table.cell_set_bgcolor() table.cell_set_height() table.cell_set_text() table.cell_set_text_color()

table.cell_set_text_halign() table.cell_set_text_size() table.cell_set_text_valign() table.cell_set_tooltip()

[Link]()
The function removes a cell or a sequence of cells from the table. The cells are removed in a rectangle shape where
the start_column and start_row specify the top-left corner, and end_column and end_row specify the bottom-right
corner.

SYNTAX

[Link](table_id, start_column, start_row, end_column, end_row) → void

ARGUMENTS

table_id (series table) A table object.

start_column (series int) The index of the column of the first cell to delete. Numbering starts at 0.
start_row (series int) The index of the row of the first cell to delete. Numbering starts at 0.

end_column (series int) The index of the column of the last cell to delete. Optional. The default is the argument used
for start_column. Numbering starts at 0.

end_row (series int) The index of the row of the last cell to delete. Optional. The default is the argument used for
start_row. Numbering starts at 0.

EXAMPLE

//@version=6
indicator("A donut", overlay=true)
if [Link]
colNum = 8, rowNum = 8
padding = "◯"
donutTable = [Link](position.middle_right, colNum, rowNum)
for c = 0 to colNum - 1
for r = 0 to rowNum - 1
[Link](donutTable, c, r, text=padding, bgcolor=#face6e, text_color=[Link]([Link]
k, 100))
[Link](donutTable, 2, 2, 5, 5)

SEE ALSO

[Link]() [Link]()

[Link]()
The function deletes a table.

SYNTAX

[Link](table_id) → void

ARGUMENTS

table_id (series table) A table object.

EXAMPLE

//@version=6
indicator("[Link] example")
var testTable = [Link](position = position.top_right, columns = 2, rows = 1, bgcolor = [Link]
w, border_width = 1)
if [Link]
[Link](table_id = testTable, column = 0, row = 0, text = "Open is " + [Link](open))
[Link](table_id = testTable, column = 1, row = 0, text = "Close is " + [Link](close), bgc
olor=[Link])
if [Link]
[Link](testTable)

SEE ALSO

[Link]() [Link]()

table.merge_cells()
The function merges a sequence of cells in the table into one cell. The cells are merged in a rectangle shape where the
start_column and start_row specify the top-left corner, and end_column and end_row specify the bottom-right corner.

SYNTAX

table.merge_cells(table_id, start_column, start_row, end_column, end_row) → void

ARGUMENTS

table_id (series table) A table object.

start_column (series int) The index of the column of the first cell to merge. Numbering starts at 0.

start_row (series int) The index of the row of the first cell to merge. Numbering starts at 0.

end_column (series int) The index of the column of the last cell to merge. Numbering starts at 0.
end_row (series int) The index of the row of the last cell to merge. Numbering starts at 0.

EXAMPLE

//@version=6
indicator("table.merge_cells example")
SMA50 = [Link](close, 50)
SMA100 = [Link](close, 100)
SMA200 = [Link](close, 200)
if [Link]
maTable = [Link](position.bottom_right, 3, 3, bgcolor = [Link], border_width = 1, border_col
or = [Link])
// Header
[Link](maTable, 0, 0, text = "SMA Table")
table.merge_cells(maTable, 0, 0, 2, 0)
// Cell Titles
[Link](maTable, 0, 1, text = "SMA 50")
[Link](maTable, 1, 1, text = "SMA 100")
[Link](maTable, 2, 1, text = "SMA 200")
// Values
[Link](maTable, 0, 2, bgcolor = [Link], text = [Link](SMA50))
[Link](maTable, 1, 2, bgcolor = [Link], text = [Link](SMA100))
[Link](maTable, 2, 2, bgcolor = [Link], text = [Link](SMA200))

REMARKS

This function will merge cells, even if their properties are not yet defined with [Link]().

The resulting merged cell inherits all of its values from the cell located at start_column : start_row , except
width and height. The width and height of the resulting merged cell are based on the width/height of other cells in the
neighboring columns/rows and cannot be set manually.
To modify the merged cell with any of the table.cell_set_* functions, target the cell at the start_column : st
art_row coordinates.

An attempt to merge a cell that has already been merged will result in an error.

SEE ALSO

[Link]() [Link]()
[Link]()
The function creates a new table.

SYNTAX

[Link](position, columns, rows, bgcolor, frame_color, frame_width, border_color, border_width, force_ove

rlay) → series table

ARGUMENTS

position (series string) Position of the table. Possible values are: position.top_left, position.top_center,
position.top_right, position.middle_left, position.middle_center, position.middle_right, position.bottom_left,
position.bottom_center, position.bottom_right.

columns (series int) The number of columns in the table.

rows (series int) The number of rows in the table.

bgcolor (series color) The background color of the table. Optional. The default is no color.

frame_color (series color) The color of the outer frame of the table. Optional. The default is no color.
frame_width (series int) The width of the outer frame of the table. Optional. The default is 0.

border_color (series color) The color of the borders of the cells (excluding the outer frame). Optional. The default is
no color.

border_width (series int) The width of the borders of the cells (excluding the outer frame). Optional. The default is 0.
force_overlay (const bool) If true, the drawing will display on the main chart pane, even when the script occupies a
separate pane. Optional. The default is false.

EXAMPLE

RETURNS

The ID of a table object that can be passed to other table.*() functions.

REMARKS

This function creates the table object itself, but the table will not be displayed until its cells are populated. To define a
cell and change its contents or attributes, use [Link]() and other table.cell_*() functions.

One [Link]() call can only display one table (the last one drawn), but the function itself will be recalculated on each
bar it is used on. For performance reasons, it is wise to use [Link]() in conjunction with either the var keyword (so
the table object is only created on the first bar) or in an if [Link] block (so the table object is only created on
the last bar).

SEE ALSO

[Link]() [Link]() [Link]() table.set_bgcolor() table.set_border_color() table.set_border_width()

table.set_frame_color() table.set_frame_width() table.set_position()

SYNTAX

table.set_position(table_id, position) → void

ARGUMENTS

table_id (series table) A table object.

SEE ALSO

[Link]() [Link]() [Link]() table.set_bgcolor() table.set_border_color() table.set_border_width()

table.set_frame_color() table.set_frame_width()

[Link]() 2 overloads

Creates a ticker identifier for requesting Heikin Ashi bar values.

SYNTAX & OVERLOADS

[Link](symbol) → simple string

[Link](symbol) → series string

ARGUMENTS

symbol (simple string) Symbol ticker identifier.

EXAMPLE

//@version=6
indicator("[Link]", overlay=true)
heikinashi_close = [Link]([Link]([Link]), [Link], close)

heikinashi_aapl_60_close = [Link]([Link]("AAPL"), "60", close)

plot(heikinashi_close)
plot(heikinashi_aapl_60_close)

RETURNS

String value of ticker id, that can be supplied to [Link]() function.

SEE ALSO

[Link] [Link] [Link]() [Link]() [Link]() [Link]() [Link]()

[Link]() 2 overloads

Constructs a ticker ID for the specified symbol with additional parameters inherited from the ticker ID passed into
the function call, allowing the script to request a symbol's data using the same modifiers that the from_tickerid
has, including extended session, dividend adjustment, currency conversion, non-standard chart types, back-
adjustment, settlement-as-close, etc.

SYNTAX & OVERLOADS

[Link](from_tickerid, symbol) → simple string

[Link](from_tickerid, symbol) → series string

ARGUMENTS

from_tickerid (simple string) The ticker ID to inherit modifiers from.

symbol (simple string) The symbol to construct the new ticker ID for.

EXAMPLE

//@version=6
indicator("[Link]")

//@variable A "NASDAQ:AAPL" ticker ID with Extender Hours enabled.

tickerExtHours = [Link]("NASDAQ", "AAPL", [Link])
//@variable A Heikin Ashi ticker ID for "NASDAQ:AAPL" with Extended Hours enabled.
HAtickerExtHours = [Link](tickerExtHours)
//@variable The "NASDAQ:MSFT" symbol with no modifiers.
testSymbol = "NASDAQ:MSFT"
//@variable A ticker ID for "NASDAQ:MSFT" with inherited Heikin Ashi and Extended Hours modifiers.
testSymbolHAtickerExtHours = [Link](HAtickerExtHours, testSymbol)

//@variable The `close` price requested using "NASDAQ:MSFT" with inherited modifiers.
secData = [Link](testSymbolHAtickerExtHours, "60", close, ignore_invalid_symbol = true)
//@variable The `close` price requested using "NASDAQ:MSFT" without modifiers.
compareData = [Link](testSymbol, "60", close, ignore_invalid_symbol = true)

plot(secData, color = [Link])

plot(compareData)

REMARKS

If the constructed ticker ID inherits a modifier that doesn't apply to the symbol (e.g., if the from_tickerid has
Extended Hours enabled, but no such option is available for the symbol ), the script will ignore the modifier when
requesting data using the ID.
[Link]() 4 overloads

Creates a ticker identifier for requesting Kagi values.

SYNTAX & OVERLOADS

[Link](symbol, reversal) → simple string

[Link](symbol, reversal) → series string

[Link](symbol, param, style) → simple string

[Link](symbol, param, style) → series string

ARGUMENTS

symbol (simple string) Symbol ticker identifier.

reversal (simple int/float) Reversal amount (absolute price value).

EXAMPLE

//@version=6
indicator("[Link]", overlay=true)
kagi_tickerid = [Link]([Link], 3)
kagi_close = [Link](kagi_tickerid, [Link], close)
plot(kagi_close)

RETURNS

String value of ticker id, that can be supplied to [Link]() function.

SEE ALSO

[Link] [Link] [Link]() [Link]() [Link]() [Link]()

[Link]()

[Link]() 2 overloads

Creates a ticker identifier for requesting Line Break values.

SYNTAX & OVERLOADS

[Link](symbol, number_of_lines) → simple string

[Link](symbol, number_of_lines) → series string

ARGUMENTS

symbol (simple string) Symbol ticker identifier.

number_of_lines (simple int) Number of line.

EXAMPLE

//@version=6
indicator("[Link]", overlay=true)
linebreak_tickerid = [Link]([Link], 3)
linebreak_close = [Link](linebreak_tickerid, [Link], close)
plot(linebreak_close)
RETURNS

String value of ticker id, that can be supplied to [Link]() function.

SEE ALSO

[Link] [Link] [Link]() [Link]() [Link]() [Link]()

[Link]()

[Link]() 2 overloads

Creates a ticker identifier for requesting additional data for the script.

SYNTAX & OVERLOADS

[Link](tickerid, session, adjustment, backadjustment, settlement_as_close) → simple string

[Link](tickerid, session, adjustment, backadjustment, settlement_as_close) → series string

ARGUMENTS

tickerid (simple string) Symbol name with exchange prefix, e.g. 'BATS:MSFT', 'NASDAQ:MSFT' or tickerid with
session and adjustment from the [Link]() function.

session (simple string) Session type. Optional argument. Possible values: [Link], [Link]. Session
type of the current chart is [Link]. If session is not given, then [Link] value is used.

adjustment (simple string) Adjustment type. Optional argument. Possible values: [Link], [Link],
[Link]. If adjustment is not given, then default adjustment value is used (can be different depending on
particular instrument).

backadjustment (simple backadjustment) Specifies whether past contract data on continuous futures symbols is
back-adjusted. This setting only affects the data from symbols with this option available on their charts. Optional. The
default is [Link], meaning that the modified ticker ID inherits the setting from the ticker ID passed to
the tickerid parameter, or it inherits the symbol's default if the tickerid does not specify this setting. Possible
values: [Link], [Link], [Link].

settlement_as_close (simple settlement) Specifies whether a futures symbol's close value represents the actual
closing price or the settlement price on "1D" and higher timeframes. This setting only affects the data from symbols
with this option available on their charts. Optional. The default is settlement_as_close.inherit, meaning that the
modified ticker ID inherits the setting from the tickerid passed into the function, or it inherits the chart symbol's
default if the tickerid does not specify this setting. Possible values: settlement_as_close.inherit,
settlement_as_close.on, settlement_as_close.off.

EXAMPLE

//@version=6
indicator("ticker_modify", overlay=true)
t1 = [Link]([Link], [Link], [Link], [Link])
c1 = [Link](t1, "D", close)
t2 = [Link](t1, [Link])
c2 = [Link](t2, "2D", close)
plot(c1)
plot(c2)

RETURNS

String value of ticker id, that can be supplied to [Link]() function.

SEE ALSO
[Link] [Link] [Link] [Link] [Link] [Link]()

[Link] [Link] [Link] [Link] [Link]

[Link] settlement_as_close.inherit settlement_as_close.on settlement_as_close.off

[Link]() 2 overloads

Creates a ticker identifier for requesting additional data for the script.

SYNTAX & OVERLOADS

[Link](prefix, ticker, session, adjustment, backadjustment, settlement_as_close) → simple string

[Link](prefix, ticker, session, adjustment, backadjustment, settlement_as_close) → series string

ARGUMENTS

prefix (simple string) Exchange prefix. For example: 'BATS', 'NYSE', 'NASDAQ'. Exchange prefix of main series is
[Link].

ticker (simple string) Ticker name. For example 'AAPL', 'MSFT', 'EURUSD'. Ticker name of the main series is
[Link].

session (simple string) Session type. Optional argument. Possible values: [Link], [Link]. Session
type of the current chart is [Link]. If session is not given, then [Link] value is used.

backadjustment (simple backadjustment) Specifies whether past contract data on continuous futures symbols is
back-adjusted. This setting only affects the data from symbols with this option available on their charts. Optional. The
default is [Link], meaning that the new ticker ID inherits the symbol's default setting. Possible values:
[Link], [Link], [Link].

settlement_as_close (simple settlement) Specifies whether a futures symbol's close value represents the actual
closing price or the settlement price on "1D" and higher timeframes. This setting only affects the data from symbols
with this option available on their charts. Optional. The default is settlement_as_close.inherit, meaning that the new
ticker ID inherits the chart symbol's default setting. Possible values: settlement_as_close.inherit,
settlement_as_close.on, settlement_as_close.off.

EXAMPLE

//@version=6
indicator("[Link]", overlay=true)
t = [Link]([Link], [Link], [Link], [Link])
t2 = [Link](t)
c = [Link](t2, [Link], low, barmerge.gaps_on)
plot(c, style=plot.style_linebr)

RETURNS

String value of ticker id, that can be supplied to [Link]() function.

REMARKS

You may use return value of [Link]() function as input argument for [Link](), [Link](),
[Link](), [Link](), [Link]() functions.

SEE ALSO
[Link] [Link] [Link] [Link] [Link] [Link]()

[Link] [Link] [Link] [Link] [Link]

[Link] settlement_as_close.inherit settlement_as_close.on settlement_as_close.off

[Link]() 2 overloads

Creates a ticker identifier for requesting Point & Figure values.

SYNTAX & OVERLOADS

[Link](symbol, source, style, param, reversal) → simple string

[Link](symbol, source, style, param, reversal) → series string

ARGUMENTS

symbol (simple string) Symbol ticker identifier.

source (simple string) The source for calculating Point & Figure. Possible values are: 'hl', 'close'.

param (simple int/float) Represents the ticker's "ATR length" value if the style value is "ATR", "Box size" value if
the style is "Traditional", or "Percentage" value if the style is "PercentageLTP".

reversal (simple int) Reversal amount.

EXAMPLE

//@version=6
indicator("[Link]", overlay=true)
pnf_tickerid = [Link]([Link], "hl", "Traditional", 1, 3)
pnf_close = [Link](pnf_tickerid, [Link], close)
plot(pnf_close)

RETURNS

String value of ticker id, that can be supplied to [Link]() function.

SEE ALSO

[Link] [Link] [Link]() [Link]() [Link]() [Link]() [Link]()

[Link]() 2 overloads

Creates a ticker identifier for requesting Renko values.

SYNTAX & OVERLOADS

[Link](symbol, style, param, request_wicks, source) → simple string

[Link](symbol, style, param, request_wicks, source) → series string

ARGUMENTS

symbol (simple string) Symbol ticker identifier.

style (simple string) Specifies the ticker's box size assignment method. Possible values: "ATR" for Average True
Range sizing, "Traditional" to use a fixed size, or "PercentageLTP" to use a percentage of the last trading price.
param (simple int/float) Represents the ticker's "ATR length" value if the style value is "ATR", "Box size" value if
the style is "Traditional", or "Percentage" value if the style is "PercentageLTP".

request_wicks (simple bool) Specifies if wick values are returned for Renko bricks. When true, high and low values
requested from a symbol using the ticker formed by this function will include wick values when they are present. When
false, high and low will always be equal to either open or close. Optional. The default is false. A detailed explanation of
how Renko wicks are calculated can be found in our Help Center.

source (simple string) The source used to calculate bricks. Optional. Possible values: "Close", "OHLC". The default is
"Close".

EXAMPLE

//@version=6
indicator("[Link]", overlay=true)
renko_tickerid = [Link]([Link], "ATR", 10)
renko_close = [Link](renko_tickerid, [Link], close)
plot(renko_close)

EXAMPLE

//@version=6
indicator("Renko candles", overlay=false)
renko_tickerid = [Link]([Link], "ATR", 10)
[renko_open, renko_high, renko_low, renko_close] = [Link](renko_tickerid, [Link], [
open, high, low, close])
plotcandle(renko_open, renko_high, renko_low, renko_close, color = renko_close > renko_open ? [Link]
en : [Link])

RETURNS

String value of ticker id, that can be supplied to [Link]() function.

SEE ALSO

[Link] [Link] [Link]() [Link]() [Link]() [Link]()

[Link]()

[Link]() 2 overloads

Creates a ticker to request data from a standard chart that is unaffected by modifiers like extended session, dividend
adjustment, currency conversion, and the calculations of non-standard chart types: Heikin Ashi, Renko, etc. Among
other things, this makes it possible to retrieve standard chart values when the script is running on a non-standard
chart.

SYNTAX & OVERLOADS

[Link](symbol) → simple string

[Link](symbol) → series string

ARGUMENTS

symbol (simple string) A ticker ID to be converted into its standard form. Optional. The default is [Link].

EXAMPLE

//@version=6
indicator("[Link]", overlay = true)
// This script should be run on a non-standard chart such as HA, Renko...

// Requests data from the chart type the script is running on.
chartTypeValue = [Link]([Link], "1D", close)
// Request data from the standard chart type, regardless of the chart type the script is running on.
standardChartValue = [Link]([Link]([Link]), "1D", close)

// This will not use a standard ticker ID because the `symbol` argument contains only the ticker — not
the prefix (exchange).
standardChartValue2 = [Link]([Link]([Link]), "1D", close)

plot(chartTypeValue)
plot(standardChartValue, color = [Link])

RETURNS

A string representing the ticker of a standard chart in the "prefix:ticker" format. If the symbol argument does not
contain the prefix and ticker information, the function returns the supplied argument as is.

SEE ALSO

[Link]()

time() 2 overloads

Returns the opening UNIX timestamp for the specified timeframe and session, or na if the time point is outside the
session.

SYNTAX & OVERLOADS

time(timeframe, session, bars_back, timeframe_bars_back) → series int

time(timeframe, session, timezone, bars_back, timeframe_bars_back) → series int

ARGUMENTS

timeframe (series string) The timeframe of the timestamp calculation. If the value is an empty string, the function
uses the script's main timeframe.

session (series string) Optional. The session string for filtering times. The function returns a timestamp if the time is
in the specified session, or na if the time is outside the session. If the argument is an empty string, the function uses
the default, which is the symbol's session.
bars_back (series int) Optional. The bar offset on the script's main timeframe. If the value is positive, the function
finds the bar that is N bars before the current bar on the main timeframe, then retrieves the timestamp of the
corresponding bar on the timeframe specified by the timeframe argument. If the value is a negative number from
-1 to -500, the function calculates the expected timestamp of the timeframe bar corresponding to N bars after the
current bar on the main timeframe. The default is 0.
timeframe_bars_back (series int) Optional. The additional bar offset on the timeframe specified by the timefram
e argument. If the value is positive, the function retrieves the timestamp of the bar that is N timeframe bars before
the one corresponding to the bars_back offset. If the value is a negative number from -1 to -500, the function
calculates the expected timestamp of the timeframe bar that is N timeframe bars after the one corresponding
to the bars_back offset. The default is 0.

EXAMPLE

//@version=6
indicator("Time", overlay=true)
// Try this on chart AAPL,1
timeinrange(res, sess) => not na(time(res, sess, "America/New_York")) ? 1 : 0
plot(timeinrange("1", "1300-1400"), color=[Link])

// This plots 1.0 at every start of 10 minute bar on a 1 minute chart:

newbar(res) => [Link](time(res)) == 0 ? 0 : 1
plot(newbar("10"))

While setting up a session you can specify not just the hours and minutes but also the days of the week that will be
included in that session.
If the days aren't specified, the session is considered to have been set from Sunday (1) to Saturday (7), i.e. "1100-
2000" is the same as "1100-1200:1234567".

You can change that by specifying the days. For example, on a symbol that is traded seven days a week with the 24-
hour trading session the following script will not color Saturdays and Sundays:

EXAMPLE

//@version=6
indicator("Time", overlay=true)
t1 = time([Link], "0000-0000:23456")
bgcolor(not na(t1) ? [Link]([Link], 90) : na)

One session argument can include several different sessions, separated by commas. For example, the following
script will highlight the bars from 10:00 to 11:00 and from 14:00 to 15:00 (workdays only):

EXAMPLE

//@version=6
indicator("Time", overlay=true)
t1 = time([Link], "1000-1100,1400-1500:23456")
bgcolor(not na(t1) ? [Link]([Link], 90) : na)

RETURNS

The opening UNIX timestamp.

REMARKS

UNIX time is a standardized date and time representation that measures the number of non-leap seconds elapsed
since January 1, 1970 at 00:00:00 UTC. Pine Script expresses UNIX time values in milliseconds. See the UNIX
timestamps section of the User Manual's Time page to learn more.

SEE ALSO

time

time_close() 2 overloads

Returns the closing UNIX timestamp for the specified timeframe and session, or na if the time point is outside the
session. On tick charts and price-based charts such as Renko, line break, Kagi, point & figure, and range, the function
returns na on the latest realtime bar because the future closing time is unpredictable. However, it returns a valid
timestamp for any previous bar.

SYNTAX & OVERLOADS

time_close(timeframe, session, bars_back, timeframe_bars_back) → series int

time_close(timeframe, session, timezone, bars_back, timeframe_bars_back) → series int

ARGUMENTS

timeframe (series string) The timeframe of the timestamp calculation. If the value is an empty string, the function
uses the script's main timeframe.

timeframe_bars_back (series int) Optional. The additional bar offset on the timeframe specified by the timefram
e argument. If the value is positive, the function retrieves the timestamp of the bar that is N timeframe bars before
the one corresponding to the bars_back offset. If the value is a negative number from -1 to -500, the function
calculates the expected timestamp of the timeframe bar that is N timeframe bars after the one corresponding
to the bars_back offset. The default is 0.

EXAMPLE

//@version=6
indicator("Time", overlay=true)
t1 = time_close([Link], "1200-1300", "America/New_York")
bgcolor(not na(t1) ? [Link]([Link], 90) : na)

RETURNS

The closing UNIX timestamp.

REMARKS

SEE ALSO

time_close

[Link]()
Detects changes in the specified timeframe .

SYNTAX

[Link](timeframe) → series bool

ARGUMENTS

timeframe (series string) String formatted according to the User manual's timeframe string specifications.

EXAMPLE

//@version=6
// Run this script on an intraday chart.
indicator("New day started", overlay = true)
// Highlights the first bar of the new day.
isNewDay = [Link]("1D")
bgcolor(isNewDay ? [Link]([Link], 80) : na)

RETURNS

Returns true on the first bar of a new timeframe , false otherwise.

timeframe.from_seconds() 2 overloads

Converts a number of seconds into a valid timeframe string.

SYNTAX & OVERLOADS

timeframe.from_seconds(seconds) → simple string

timeframe.from_seconds(seconds) → series string

ARGUMENTS

seconds (simple int) The number of seconds in the timeframe.

EXAMPLE

//@version=6
indicator("HTF Close", "", true)
int chartTf = timeframe.in_seconds()
string tfTimes5 = timeframe.from_seconds(chartTf * 5)
float htfClose = [Link]([Link], tfTimes5, close)
plot(htfClose)

RETURNS

A timeframe string compliant with timeframe string specifications.

REMARKS

If no valid timeframe exists for the quantity of seconds supplied, the next higher valid timeframe will be returned.
Accordingly, one second or less will return "1S", 2-5 seconds will return "5S", and 604,799 seconds (one second less
than 7 days) will return "7D".
If the seconds exactly represent two or more valid timeframes, the one with the larger base unit will be used. Thus
604,800 seconds (7 days) returns "1W", not "7D".

All values above 31,622,400 (366 days) return "12M".

SEE ALSO

timeframe.in_seconds() [Link] request.security_lower_tf

timeframe.in_seconds() 2 overloads

Converts a timeframe string into seconds.

SYNTAX & OVERLOADS

timeframe.in_seconds(timeframe) → simple int

timeframe.in_seconds(timeframe) → series int

ARGUMENTS

timeframe (simple string) Timeframe string in timeframe string specifications format. Optional. The default is
[Link].

EXAMPLE

//@version=6
indicator("`timeframe_in_seconds()`"),

// Get a user-selected timeframe.

tfInput = [Link]("1D")

// Convert it into an "int" number of seconds.

secondsInTf = timeframe.in_seconds(tfInput)

plot(secondsInTf)

RETURNS

The "int" representation of the number of seconds in the timeframe string.

REMARKS
When the timeframe is "1M" or more, calculations use 2628003 as the number of seconds in one month, which
represents 30.4167 (365/12) days.

SEE ALSO

[Link]() [Link] timeframe.from_seconds()

timestamp() 6 overloads

Function timestamp returns UNIX time of specified date and time.

SYNTAX & OVERLOADS

timestamp(dateString) → const int

timestamp(dateString) → series int

timestamp(year, month, day, hour, minute, second) → simple int

timestamp(year, month, day, hour, minute, second) → series int

timestamp(timezone, year, month, day, hour, minute, second) → simple int

timestamp(timezone, year, month, day, hour, minute, second) → series int

ARGUMENTS

dateString (const string) A string containing the date and, optionally, the time and time zone. Its format must comply
with either the IETF RFC 2822 or ISO 8601 standards ("DD MMM YYYY hh:mm:ss ±hhmm" or "YYYY-MM-
DDThh:mm:ss±hh:mm", so "20 Feb 2020" or "2020-02-20"). If no time is supplied, "00:00" is used. If no time zone is
supplied, GMT+0 will be used. Note that this diverges from the usual behavior of the function where it returns time in
the exchange's timezone.

EXAMPLE

//@version=6
indicator("timestamp")
plot(timestamp(2016, 01, 19, 09, 30), linewidth=3, color=[Link])
plot(timestamp([Link], 2016, 01, 19, 09, 30), color=[Link])
plot(timestamp(2016, 01, 19, 09, 30), color=[Link])
plot(timestamp("GMT+6", 2016, 01, 19, 09, 30))
plot(timestamp(2019, 06, 19, 09, 30, 15), color=[Link])
plot(timestamp("GMT+3", 2019, 06, 19, 09, 30, 15), color=[Link])
plot(timestamp("Feb 01 2020 22:10:05"))
plot(timestamp("2011-10-10T14:48:00"))
plot(timestamp("04 Dec 1995 00:12:00 GMT+5"))

RETURNS

UNIX time.

ARGUMENTS

time (series int) A UNIX timestamp in milliseconds.

timezone (series string) Optional. Specifies the time zone of the returned week number. The value can be a time
zone string in UTC/GMT offset notation (e.g., "UTC-5") or IANA time zone database notation (e.g.,
"America/New_York"). The default is [Link].

RETURNS

The calculated week number, expressed in the specified time zone.

REMARKS

A UNIX timestamp represents the number of milliseconds elapsed since 00:00 UTC on 1970-01-01. The meaning of a
UNIX timestamp does not change relative to any time zone.

SEE ALSO

weekofyear dayofmonth() dayofweek() time() year() month() hour() minute() second()

year()

SYNTAX

year(time, timezone) → series int

ARGUMENTS

time (series int) UNIX time in milliseconds.

RETURNS

Year (in exchange timezone) for provided UNIX time.

REMARKS

UNIX time is the number of milliseconds that have elapsed since 00:00:00 UTC, 1 January 1970.

Note that this function returns the year based on the time of the bar's open. For overnight sessions (e.g. EURUSD,
where Monday session starts on Sunday, 17:00 UTC-4) this value can be lower by 1 than the year of the trading day.

SEE ALSO

year time() month() dayofmonth() dayofweek() hour() minute() second()

Keywords

and
Logical AND. Applicable to boolean expressions.

SYNTAX

expr1 and expr2

RETURNS

Boolean value, or series of boolean values.

REMARKS

If expr1 evaluates to false, the and operator returns false without evaluating expr2 .

enum
This keyword allows the creation of an enumeration, enum for short. Enums are unique constructs that hold groups of
predefined constants.

Each field in an enum has a const string title. Scripts can access the fields in an enum using dot notation, similar
to accessing the fields of a user-defined type.

Each field represents a value of the enumName enum. Scripts can declare each field in an enum with an optional co
nst string title. If a field's title is not specified, its title is the string representation of its name. Use [Link]() on
an enum field to retrieve its title.

SYNTAX

[export ]enum <enumName>

<field_1> [= <title_1>]
<field_2> [= <title_2>]
...
<field_N> [= <title_N>]

One can use an enum to quickly create a dropdown input with the help of the [Link]() function. The options that
appear in the dropdown represent the titles of the enum fields.

EXAMPLE

//@version=6
indicator("Session highlight", overlay = true)

//@enum Contains fields with popular timezones as titles.

//@field exch Has an empty string as the title to represent the chart timezone.
enum tz
utc = "UTC"
exch = ""
ny = "America/New_York"
chi = "America/Chicago"
lon = "Europe/London"
tok = "Asia/Tokyo"

//@variable The session string.

selectedSession = [Link]("1200-1500", "Session")
//@variable The selected timezone. The input's dropdown contains the fields in the `tz` enum.
selectedTimezone = [Link]([Link], "Session Timezone")

//@variable Is `true` if the current bar's time is in the specified session.

bool inSession = false
if not na(time("", selectedSession, [Link](selectedTimezone)))
inSession := true

// Highlight the background when `inSession` is `true`.

bgcolor(inSession ? [Link]([Link], 90) : na, title = "Active session highlight")

Additionally, one can use an enum in a collection's type template to restrict the values it will allow as elements. When
used inside a type template, the collection will only accept fields that belong to the specified enum.

EXAMPLE

//@version=6
indicator("Map with enum keys")

//@enum Contains fields with titles representing ticker IDs.

//@field aapl Has an Apple ticker ID as its title.
//@field tsla Has a Tesla ticker ID as its title.
//@field amzn Has an Amazon ticker ID as its title.
enum symbols
aapl = "NASDAQ:AAPL"
tsla = "NASDAQ:TSLA"
amzn = "NASDAQ:AMZN"

//@variable A map that accepts fields from the `symbols` enum as keys and "float" values.
map<symbols, float> data = [Link]<symbols, float>()
// Put key-value pairs into the `data` map.
[Link]([Link], [Link]([Link]([Link]), [Link], close))
[Link]([Link], [Link]([Link]([Link]), [Link], close))
[Link]([Link], [Link]([Link]([Link]), [Link], close))
// Plot the value from the `data` map accessed by the `[Link]` key.
plot([Link]([Link]))

export
Used in libraries to prefix the declaration of functions or user-defined type definitions that will be available from other
scripts importing the library.

EXAMPLE

//@version=6
//@description Library of debugging functions.
library("Debugging_library", overlay = true)
//@function Displays a string as a table cell for debugging purposes.
//@param txt String to display.
//@returns Void.
export print(string txt) =>
var table t = [Link](position.middle_right, 1, 1)
[Link](t, 0, 0, txt, bgcolor = [Link])
// Using the function from inside the library to show an example on the published chart.
// This has no impact on scripts using the library.
print("Library Test")

REMARKS

Each library must have at least one exported function or user-defined type (UDT).
Exported functions cannot use variables from the global scope if they are arrays, mutable variables (reassigned with :
= ), or variables of 'input' form.

Exported functions cannot use request.*() functions.

Exported functions must explicitly declare each parameter's type and all parameters must be used in the function's
body. By default, all arguments passed to exported functions are of the series form, unless they are explicitly specified
as simple in the function's signature.
The @description, @function, @param, @type, @field, and @returns compiler annotations are used to automatically
generate the library's description and release notes, and in the Pine Script® Editor's tooltips.

SEE ALSO

library() import simple series type

for
Creates a count-controlled loop, which uses a counter variable to manage the iterative executions of its local code
block. The loop continues new iterations until the counter reaches a specified final value.

SYNTAX

[variables =|:=] for counter = from_num to to_num [by step_num]

statements | continue | break
return_expression
variables (return_expression type) Optional. A variable or tuple to hold the values or references from the last
evaluation of return_expression after the loop terminates. The script can assign the loop's returned results to
variables only if the results are not of the "void" type. If the loop's conditions prevent iteration, or if no iterations
evaluate return_expression , the variables' assigned values or references are na, or false if the return type is
"bool".

counter (series int/float) The counter variable. The loop increments the variable's value from the initial value ( from_
num ) to the final value ( to_num ) by a fixed amount ( step_num ) after each iteration. The last possible iteration
occurs when the variable's value reaches the to_num value.

from_num (series int/float) The value of the counter variable on the loop's first iteration.

to_num (series int/float) The final counter value for which the loop's header allows a new iteration. The loop
increments the counter value by the step_num until it reaches or passes this value. If the script modifies this
value during a loop iteration, the loop header uses the new value to control the allowed subsequent iterations.

step_num (series int/float) Optional. A positive value specifying the amount by which the counter value increases
or decreases until it reaches or passes the to_num value. If the from_num value is greater than the initial to_num
value, the loop subtracts this amount from the counter value after each iteration. Otherwise, the loop adds this
amount after each iteration. The default is 1.

statements The code statements and expressions within the loop's body, i.e., the indented block of code beneath the
loop header.

return_expression (any type) The last expression or statement within the loop's body. The loop returns the results
from this code after the final iteration. If the loop stops prematurely due to a continue or break statement, the
returned values or references are those of the latest iteration that evaluated this code. To use the loop's returned
results, assign them to a variable or tuple.

continue A loop-specific keyword that instructs the script to skip the remainder of the current loop iteration and
continue to the next iteration.

break A loop-specific keyword that prompts the script to stop the current iteration and exit the loop entirely.

EXAMPLE

//@version=6
indicator("Basic `for` loop")

//@function Calculates the number of bars in the last `length` bars that have their `close` above the c
urrent `close`.
//@param length The number of bars used in the calculation.
greaterCloseCount(length) =>
int result = 0
for i = 1 to length
if close[i] > close
result += 1
result

plot(greaterCloseCount(14))

EXAMPLE

//@version=6
indicator("`for` loop with a step")

a = [Link](0, 1, 2, 3, 4, 5, 6, 7, 8, 9)
sum = 0.0

for i = 0 to 9 by 5
// Because the step is set to 5, we are adding only the first (0) and the sixth (5) value from the
array `a`.
sum += [Link](a, i)

plot(sum)

REMARKS

Modifying a loop's to_num value during an iteration does not change the direction of the loop's counter. For a loop
that counts upward, setting the to_num to a value less than the from_num value on an iteration stops the loop
immediately after that iteration ends. Likewise, a loop that counts downward stops after an iteration where the to_nu
m value becomes greater than the from_num value.

If a script initializes a variable declared with var or varip using a loop's result, the loop stops after the first iteration,
even if the header's criteria allow more iterations. Instead of initializing the variable with the result of this structure
directly, declare the variable first and use := to update it with the result. Alternatively, move the loop into a Declaring
functions and initialize the variable using a call to that function.
See the Loops page of our User Manual to learn more about loops and how they work.

SEE ALSO

for...in while

for...in
Creates a collection-controlled loop, which iterates over the elements of an array, the rows of a matrix, or the key-
value pairs of a map in order. The loop's local code block executes once for each element, row, or pair in the specified
collection.

SYNTAX

[variables = | :=] for item in collection_id

statements | continue | break
return_expression

[variables = | :=] for [index, item] in collection_id

statements | continue | break
return_expression

variables (return_expression type) - Optional. A variable or tuple to hold the values or references from the last
evaluation of return_expression after the loop terminates. The script can assign the loop's returned results to
variables only if the results are not of the "void" type. If the loop's conditions prevent iteration, or if no iterations
evaluate return_expression , the variables' assigned values or references are na, or false if the return type is
"bool".
index - A variable to track the array element index, matrix row index, or map key of the current iteration. The loop
cannot modify this variable using reassignment or compound assignment operators. This variable is valid only in the
second form of the loop structure.

item - A variable to track the array element, matrix row, or map value element of the current iteration. The loop cannot
modify this variable using reassignment or compound assignment operators.

collection_id (array/matrix/map) - The ID of the array, matrix, or map whose items the loop iterates over.
statements - The code statements and expressions within the loop's body, i.e., the indented block of code beneath
the loop header.
return_expression (any type) - The last expression or statement within the loop's body. The loop returns the results
from this code after the final iteration. If the loop stops prematurely due to a continue or break statement, the
returned values or references are those of the latest iteration that evaluated this code. To use the loop's returned
results, assign them to a variable or tuple.
continue - A loop-specific keyword that instructs the script to skip the remainder of the current loop iteration and
continue to the next iteration.
break - A loop-specific keyword that prompts the script to stop the current iteration and exit the loop entirely.

The following example uses the first form of the for...in loop to count the number of array element values that are
greater than a specified value:

EXAMPLE

//@version=6
indicator("'for...in' array (first form) demo")

//@function Counts the number of 'id' array elements that are greater than the specified value.
numGreaterThan(array<float> id, float value) =>
int result = 0
for element in id
if element > value
result += 1
result

//@variable References an array containing the current bar's OHLC values.

array<float> ohlcValues = [Link](open, high, low, close)

// Plot the number of 'ohlcValues' elements that are greater than the 20-bar SMA of 'close'.
plot(numGreaterThan(ohlcValues, [Link](close, 20)))

The example below uses the second form of the loop structure to perform element-wise addition between two arrays:

EXAMPLE

//@version=6
indicator("`for...in` array (second form) demo")

//@function Creates a new array whose elements are the sums of corresponding elements in the ìd1` and
ìd2` arrays.
elementWiseAdd(array<float> id1, array<float> id2) =>
array<float> result = [Link]<float>()
// Loop through the ìd1` array while tracking each element's index *and* value.
for [index, element1] in id1
// Use ìndex` to retrieve the corresponding element in the ìd2` array, then push the sum int
o the new array.
float element2 = [Link](index)
[Link](element1 + element2)
result

if [Link]
// Create two arrays for which to perform element-wise addition.
array<float> array1 = [Link](1.0, 2.0, 3.0, 4.0)
array<float> array2 = [Link](2.0, 3.0, 4.0, 5.0)

//@variable References the resulting array of element-wise sums.

array<float> sums = elementWiseAdd(array1, array2)
// Log a string representation of the `sums` array's contents in the Pine Logs pane.
[Link]([Link](sums))

This example uses the first form of the loop structure to iterate over the rows of a matrix and create an array containing
each one's sum. The header's loop variable, rowArrayID , references an array containing the current row's values:

EXAMPLE

//@version=6
indicator("`for...in` matrix (first form) demo")

//@function Creates a matrix that organizes the contents of the `arrayID` array into a specified shape.
matrixFromArray(array<float> arrayID, int rows, int columns) =>
matrix<float> result = [Link]<float>()
result.add_row(0, arrayID)
[Link](rows, columns)
result

//@function Creates an array containing the sum of elements in each row of the `matrixID` matrix.
calcRowSums(matrix<float> matrixID) =>
array<float> result = [Link]<float>()
// Iterate over the matrix rows, where `rowArrayID` references an *array* containing the current ro
w's values.
for rowArrayID in matrixID
// Push the sum of `rowArrayID` elements into the `result` array.
[Link]([Link]())
result

if [Link]
// Create a 2x2 matrix of pseudorandom values.
array<float> randArray = [Link]([Link](), [Link](), [Link](), [Link]())
matrix<float> randMat = matrixFromArray(randArray, 2, 2)
// Log string representation of the `randMat` matrix and the calculated array of row sums in the Pi
ne Logs pane.
[Link]("\n" + [Link](randMat))
[Link]([Link](calcRowSums(randMat)))

The following example uses a for...in loop to iterate over a map's key-value pairs and construct a custom string
representation of its contents:

EXAMPLE

//@version=6
indicator("`for...in` map demo")

//@function Creates a custom string representation of a map containing "string" keys and "float" value
s.
toString(map<string, float> id) =>
string result = "{"
// Iterate through the key-value pairs of the `id` map, in insertion order.
for [key, value] in id
result += [Link]("''{0}'': {1}, ", key, value)
result += "}"
result := [Link](result, ", }", "}")

if [Link]
//@variable References a map to store "float" OHLC values with corresponding "string" keys.
map<string, float> ohlcMap = [Link]<string, float>()
// Put key-value pairs into the map.
[Link]("Open", open)
[Link]("High", high)
[Link]("Low", low)
[Link]("Close", close)
// Log the `toString()` result for the map referenced by `ohlcMap`.
[Link](toString(ohlcMap))

REMARKS

Only the second form of the for...in loop is compatible with maps. The loop iterates over the key-value pairs of a
map in the insertion order of its keys.
Scripts can modify the sizes of arrays and matrices while iterating over their contents with a for...in loop.
However, they cannot modify the sizes of maps while looping over them directly with this structure. To modify a map
while using a for...in loop, use the loop on a copy of the map or on the map's [Link]() array.

SEE ALSO

for while [Link]() [Link]() [Link]()

if
If statement defines what block of statements must be executed when conditions of the expression are satisfied.

To have access to and use the if statement, one should specify the version >= 2 of Pine Script® language in the very
first line of code, for example: //@version=6

The 4th version of Pine Script® Language allows you to use “else if” syntax.
General code form:

SYNTAX

var_declarationX = if condition
var_decl_then0
var_decl_then1
…
var_decl_thenN
else if [optional block]
var_decl_else0
var_decl_else1
…
var_decl_elseN
else
var_decl_else0
var_decl_else1
…
var_decl_elseN
return_expression_else

where

var_declarationX — this variable gets the value of the if statement

condition — if the condition is true, the logic from the block 'then' (var_decl_then0, var_decl_then1, etc.) is used.

If the condition is false, the logic from the block 'else' (var_decl_else0, var_decl_else1, etc.) is used.
return_expression_then, return_expression_else — the last expression from the block then or from the block else
will return the final value of the statement. If declaration of the variable is in the end, its value will be the result.
The type of returning value of the if statement depends on return_expression_then and return_expression_else type
(their types must match: it is not possible to return an integer value from then, while you have a string value in else
block).

EXAMPLE

//@version=6
indicator("if")
// This code compiles
x = if close > open
close
else
open

// This code doesn’t compile

// y = if close > open
// close
// else
// "open"
plot(x)

It is possible to omit the else block. In this case if the condition is false, an “empty” value (na, false, or “”) will be
assigned to the var_declarationX variable:

EXAMPLE

//@version=6
indicator("if")
x = if close > open
close
// If current close > current open, then x = close.
// Otherwise the x = na.
plot(x)

It is possible to use either multiple “else if” blocks or none at all. The blocks “then”, “else if”, “else” are shifted by four
spaces:

EXAMPLE

//@version=6
indicator("if")
x = if open > close
5
else if high > low
close
else
open
plot(x)

It is possible to ignore the resulting value of an if statement (“var_declarationX=“ can be omitted). It may be useful if
you need the side effect of the expression, for example in strategy trading:

EXAMPLE

//@version=6
strategy("if")
if ([Link](high, low))
[Link]("BBandLE", [Link], stop=low, oca_name="BollingerBands", oca_type=[Link]
[Link], comment="BBandLE")
else
[Link](id="BBandLE")

If statements can include each other:

EXAMPLE

//@version=6
indicator("if")
float x = na
if close > open
if close > close[1]
x := close
else
x := close[1]
else
x := open
plot(x)

import
Used to load an external library() into a script and bind its functions to a namespace. The importing script can be an
indicator, a strategy, or another library. A library must be published (privately or publicly) before it can be imported.

SYNTAX

import {username}/{libraryName}/{libraryVersion} as {alias}

ARGUMENTS

username (literal string) User name of the library's author.

libraryName (literal string) Name of the imported library, which corresponds to the title argument used by the
author in his library script.

libraryVersion (literal int) Version number of the imported library.

alias (literal string) A non-numeric identifier used as a namespace to refer to the library's functions. Optional. The
default is the libraryName string.

EXAMPLE

//@version=6
indicator("num_methods import")
// Import the first version of the username’s "num_methods" library and assign it to the "m" namespac
e",
import username/num_methods/1 as m
// Call the “sinh()” function from the imported library
y = [Link](3.14)
// Plot value returned by the "sinh()" function",
plot(y)
REMARKS

Using an alias that replaces a built-in namespace such as math.* or strategy.* is allowed, but if the library contains
function names that shadow Pine Script®'s built-in functions, the built-ins will become unavailable. The same version
of a library can only be imported once. Aliases must be distinct for each imported library. When calling library
functions, casting their arguments to types other than their declared type is not allowed. An import statement cannot
use 'as' or 'import' as username , libraryName , or alias identifiers.

SEE ALSO

library() export

method
This keyword is used to prefix a function declaration, indicating it can then be invoked using dot notation by appending
its name to a variable of the type of its first parameter and omitting that first parameter. Alternatively, functions
declared as methods can also be invoked like normal user-defined functions. In that case, an argument must be
supplied for its first parameter.

The first parameter of a method declaration must be explicitly typified.

SYNTAX

[export] method <functionName>(<paramType> <paramName> [= <defaultValue>], …) =>

EXAMPLE

//@version=6
indicator("")

var prices = [Link]<float>()

//@function Pushes a new value into the array and removes the first one if the resulting array is great
er than `maxSize`. Can be used as a method.
method maintainArray(array<float> id, maxSize, value) =>
[Link](value)
if [Link]() > maxSize
[Link]()

[Link](50, close)
// The method can also be called like a function, without using dot notation.
// In this case an argument must be supplied for its first parameter.
// maintainArray(prices, 50, close)

// This calls the `[Link]()` built-in using dot notation with the `prices` array.
// It is possible because built-in functions belonging to some namespaces that are a special Pine type
// can be invoked with method notation when the function's first parameter is an ID of that type.
// Those namespaces are: `array`, `matrix`, `line`, `linefill`, `label`, `box`, and `table`.
plot([Link]())

not
Logical negation (NOT). Applicable to boolean expressions.

SYNTAX

not expr1

RETURNS

Boolean value, or series of boolean values.

or
Logical OR. Applicable to boolean expressions.

SYNTAX

expr1 or expr2

RETURNS

Boolean value, or series of boolean values.

REMARKS

If expr1 evaluates to true, the or operator returns true without evaluating expr2 .

switch
The switch operator transfers control to one of the several statements, depending on the values of a condition and
expressions.

SYNTAX

[variable_declaration = ] switch expression

value1 => local_block
value2 => local_block
…
=> default_local_block

[variable_declaration = ] switch
condition1 => local_block
condition2 => local_block
…
=> default_local_block

Switch with an expression:

EXAMPLE

//@version=6
indicator("Switch using an expression")

string i_maType = [Link]("EMA", "MA type", options = ["EMA", "SMA", "RMA", "WMA"])

float ma = switch i_maType

"EMA" => [Link](close, 10)
"SMA" => [Link](close, 10)
"RMA" => [Link](close, 10)
// Default used when the three first cases do not match.
=> [Link](close, 10)

plot(ma)

Switch without an expression:

EXAMPLE

//@version=6
strategy("Switch without an expression", overlay = true)

bool longCondition = [Link]( [Link](close, 14), [Link](close, 28))

bool shortCondition = [Link]([Link](close, 14), [Link](close, 28))

switch
longCondition => [Link]("Long ID", [Link])
shortCondition => [Link]("Short ID", [Link])

RETURNS
The value of the last expression in the local block of statements that is executed.

REMARKS

Only one of the local_block instances or the default_local_block can be executed. The default_local_
block is introduced with the => token alone and is only executed when none of the preceding blocks are executed.
If the result of the switch statement is assigned to a variable and a default_local_block is not specified, the
statement returns na if no local_block is executed. When assigning the result of the switch statement to a
variable, all local_block instances must return the same type of value.

SEE ALSO

if ?:

type
This keyword allows the declaration of user-defined types (UDT) from which scripts can instantiate objects. UDTs are
composite types that contain an arbitrary number of fields of any built-in or user-defined type, including the defined
UDT itself. The syntax to define a UDT is:

SYNTAX

[export ]type <UDT_identifier>

[varip ]<field_type> <field_name> [= <value>]
…

Once a UDT is defined, scripts can instantiate objects from it with the UDT_identifier.new() construct. When
creating a new type instance, the fields of the resulting object will initialize with the default values from the UDT's
definition. Any type fields without specified defaults will initialize as na. Alternatively, users can pass initial values as
arguments in the *.new() method to override the type's defaults. For example, newFooObject = [Link](x =
true) assigns a new foo object to the newFooObject variable with its x field initialized using a value of true.

Field declarations can include the varip keyword, in which case the field values persist between successive script
iterations on the same bar.
For more information see the User Manual's sections on defining UDTs and using objects.

Libraries can export UDTs. See the Libraries page of our User Manual to learn more.

EXAMPLE

//@version=6
indicator("Multi Time Period Chart", overlay = true)

timeframeInput = [Link]("1D")

type bar
float o = open
float h = high
float l = low
float c = close
int t = time

drawBox(bar b, right) =>

color boxColor = b.c >= b.o ? [Link] : [Link]
[Link](b.t, b.h, right, b.l, boxColor, xloc = xloc.bar_time, bgcolor = [Link](boxColor, 90))

updateBox(box boxId, bar b) =>

color boxColor = b.c >= b.o ? [Link] : [Link]
box.set_border_color(boxId, boxColor)
box.set_bgcolor(boxId, [Link](boxColor, 90))
box.set_top(boxId, b.h)
box.set_bottom(boxId, b.l)
box.set_right(boxId, time)

secBar = [Link]([Link], timeframeInput, [Link]())

if not na(secBar)
// To avoid a runtime error, only process data when an object exists.
if not [Link]
if [Link](timeframeInput)
// On historical bars, draw a new box in the past when the HTF closes.
drawBox(secBar, time[1])
else
var box lastBox = na
if na(lastBox) or [Link](timeframeInput)
// On the last bar, only draw a new current box the first time we get there or when HTF cha
nges.
lastBox := drawBox(secBar, time)
else
// On other chart updates, use setters to modify the current box.
updateBox(lastBox, secBar)

var
var is the keyword used for assigning and one-time initializing of the variable.
Normally, a syntax of assignment of variables, which doesn’t include the keyword var, results in the value of the
variable being overwritten with every update of the data. Contrary to that, when assigning variables with the keyword
var, they can “keep the state” despite the data updating, only changing it when conditions within if-expressions are
met.

SYNTAX

var variable_name = expression

where:

variable_name - any name of the user’s variable that’s allowed in Pine Script® (can contain capital and lowercase
Latin characters, numbers, and underscores (_), but can’t start with a number).

expression - any arithmetic expression, just as with defining a regular variable. The expression will be calculated and
assigned to a variable once.

EXAMPLE

//@version=6
indicator("Var keyword example")
var a = close
var b = 0.0
var c = 0.0
var green_bars_count = 0
if close > open
var x = close
b := x
green_bars_count := green_bars_count + 1
if green_bars_count >= 10
var y = close
c := y
plot(a)
plot(b)
plot(c)

The variable 'a' keeps the closing price of the first bar for each bar in the series.

The variable 'b' keeps the closing price of the first "green" bar in the series.
The variable 'c' keeps the closing price of the tenth "green" bar in the series.

varip
varip (var intrabar persist) is the keyword used for the assignment and one-time initialization of a variable or a field of
a user-defined type. It’s similar to the var keyword, but variables and fields declared with varip retain their values
between executions of the script on the same bar.

SYNTAX
varip [<variable_type> ]<variable_name> = <expression>

[export ]type <UDT_identifier>

varip <field_type> <field_name> [= <value>]

where:

variable_type - An optional fundamental type (int, float, bool, color, string) or a user-defined type, or an array or
matrix of one of those types. Special types are not compatible with this keyword.
variable_name - A valid identifier. The variable can also be an object created from a UDT.

expression - Any arithmetic expression, just as when defining a regular variable. The expression will be calculated and
assigned to the variable only once, on the first bar.

UDT_identifier, field_type, field_name, value - Constructs related to user-defined types as described in the type
section.

EXAMPLE

//@version=6
indicator("varip")
varip int v = -1
v := v + 1
plot(v)

With var, v would equal the value of the bar_index. On historical bars, where the script calculates only once per chart
bar, the value of v is the same as with var. However, on realtime bars, the script will evaluate the expression on each
new chart update, producing a different result.

EXAMPLE

//@version=6
indicator("varip with types")
type barData
int index = -1
varip int ticks = -1

var currBar = [Link]()

[Link] += 1
[Link] += 1

// Will be equal to bar_index on all bars

plot([Link])
// In real time, will increment per every tick on the chart
plot([Link])

The same += operation applied to both the index and ticks fields results in different real-time values because t
icks increases on every chart update, while index only does so once per bar. Note how the currBar object
does not use the varip keyword. The ticks field of the object can increment on every tick, but the reference itself is
defined once and then stays unchanged. If we were to declare currBar using varip, the behavior of index would
remain unchanged because while the reference to the type instance would persist between chart updates, the index
field of the object would not.

REMARKS

When using varip to declare variables in strategies that may execute more than once per historical chart bar, the values
of such variables are preserved across successive iterations of the script on the same bar.

The effect of varip eliminates the rollback of variables before each successive execution of a script on the same bar.

while
Creates a condition-controlled loop whose local code block executes repeatedly while the value of a conditional
expression remains true . The loop's iterations end after the condition's value becomes false .
SYNTAX

[variables = | :=] while condition

statements | continue | break
return_expression

variables (return_expression type) - Optional. A variable or tuple to hold the values or references from the last
evaluation of return_expression after the loop terminates. The script can assign the loop's returned results to
variables only if the results are not of the "void" type. If the loop's conditions prevent iteration, or if no iterations
evaluate return_expression , the variables' assigned values or references are na, or false if the return type is
"bool".
condition (series bool) - The conditional expression that controls the loop's iterations. If true , the script performs
a new iteration. If false , the script exits the loop without performing a new iteration.

statements - The code statements and expressions within the loop's body, i.e., the indented block of code beneath
the loop header.
return_expression (any type) - The last expression or statement within the loop's body. The loop returns the results
from this code after the final iteration. If the loop stops prematurely due to a continue or break statement, the
returned values or references are those of the latest iteration that evaluated this code. To use the loop's returned
results, assign them to a variable or tuple.
continue - A loop-specific keyword that instructs the script to skip the remainder of the current loop iteration and
continue to the next iteration.
break - A loop-specific keyword that prompts the script to stop the current iteration and exit the loop entirely.

EXAMPLE

//@version=6
indicator("`while` demo")

//@variable The number for which to calculate the factorial (N!).

// The factorial is the product of all integers from 1 to `n`, with the exception (0! == 1).
int n = [Link](10, "N", 0)

//@variable The current value to multiply in the factorial calculation.

var int counter = n
//@variable The factorial value.
var int factorial = 1

if [Link]
// Repeatedly multiply `factorial` by `counter` and decrease the `counter` value by 1.
// The loop ends after the value of `counter` becomes 0.
while counter > 0
factorial *= counter
counter -= 1

plot(factorial, "N!")

REMARKS

color
Keyword used to explicitly declare the "color" type of a variable or a parameter.

EXAMPLE

//@version=6
indicator("color", overlay = true)

color textColor = [Link]

color labelColor = #FF000080 // Red color (FF0000) with 50% transparency (80 which is half of FF).
if [Link]
[Link](bar_index, high, text = "Label", color = labelColor, textcolor = textColor)

// When declaring variables with color literals, built-in constants([Link]) or functions ([Link]
w(), [Link]()), the "color" keyword for the type can be omitted.
c = [Link](0,255,0,0)
plot(close, color = c)

REMARKS

Color literals have the following format: #RRGGBB or #RRGGBBAA. The letter pairs represent 00 to FF hexadecimal
values (0 to 255 in decimal) where RR, GG and BB pairs are the values for the color's red, green and blue components.
AA is an optional value for the color's transparency (or alpha component) where 00 is invisible and FF opaque. When
no AA pair is supplied, FF is used. The hexadecimal letters can be upper or lower case.

Explicitly mentioning the type in a variable declaration is optional, except when it is initialized with na. Learn more
about Pine Script® types in the User Manual page on the Type System.

SEE ALSO

var varip int float string [Link]() [Link]()

const
The const keyword explicitly assigns the "const" type qualifier to variables and the parameters of non-exported
functions. Variables and parameters with the "const" qualifier reference values established at compile time that never
change in the script's execution.

In variable declarations, the compiler can usually infer the qualified type automatically based on the values assigned to
a variable, and it can automatically change a variable's qualifier to a stronger one when necessary. The type qualifier
hierarchy is "const" < "input" < "simple" < "series", where "const" is the weakest.

Explicitly declaring a variable with the const keyword restricts the type qualifier to "const", meaning the variable
cannot accept a value with a stronger qualifier (e.g., "input"), nor can the value assigned to the variable change at any
point in the script's execution.

When using this keyword to specify the type qualifier, one must also use a type keyword to declare the allowed type.

SYNTAX
[method ]<functionName>([const <paramType> ]<paramName>[ = <defaultValue>])

[var/varip ]const <variableType> <variableName> = <variableValue>

EXAMPLE

//@version=6
indicator("custom plot title")

//@function Concatenates two "const string" values.

concatStrings(const string x, const string y) =>
const string result = x + y

//@variable The title of the plot.

const string myTitle = concatStrings("My ", "Plot")

plot(close, myTitle)

EXAMPLE

//@version=6
indicator("can't assign input to const")

//@variable A variable declared as "const float" that attempts to assign the result of `[Link]()`
as its value.
// This declaration causes an error. The "input float" qualified type is stronger than "const
float".
const float myVar = [Link](2.0)

plot(myVar)

REMARKS

To learn more, see our User Manual's section on type qualifiers.

SEE ALSO

simple series

float
Keyword used to explicitly declare the "float" (floating point) type of a variable or a parameter.

EXAMPLE

//@version=6
indicator("float")
float f = 3.14 // Same as `f = 3.14`
f := na
plot(f)

REMARKS

Explicitly mentioning the type in a variable declaration is optional, except when it is initialized with na. Learn more
about Pine Script® types in the User Manual page on the Type System.

SEE ALSO

var varip int bool color string

footprint
Keyword to explicitly declare the type of a variable or parameter as footprint . Script can produce footprint
instances using the [Link]() function.

SEE ALSO

[Link]() volume_row footprint.total_volume() footprint.buy_volume() footprint.sell_volume()

[Link]() [Link]() [Link]() [Link]() [Link]() footprint.get_row_by_price()

int
Keyword used to explicitly declare the "int" (integer) type of a variable or a parameter.

EXAMPLE

//@version=6
indicator("int")
int i = 14 // Same as `i = 14`
i := na
plot(i)

REMARKS

Explicitly mentioning the type in a variable declaration is optional, except when it is initialized with na. Learn more
about Pine Script® types in the User Manual page on the Type System.

Linefill objects are always of "series" form.

SEE ALSO

var line label table box [Link]()

map
Keyword used to explicitly declare the "map" type of a variable or a parameter. Map objects (or IDs) can be created
with the [Link]<type,type>() function.

EXAMPLE

//@version=6
indicator("map", overlay=true)
map<int, float> a = na
a := [Link]<int, float>()
[Link](bar_index, close)
[Link](bar_index, [Link](bar_index), "Current close")

REMARKS

Map objects are always of series form.

SEE ALSO

[Link]<type,type>()

matrix
Keyword used to explicitly declare the "matrix" type of a variable or a parameter. Matrix objects (or IDs) can be created
with the [Link]<type>() function.

EXAMPLE

//@version=6
indicator("matrix example")

// Create `m1` matrix of `int` type.

matrix<int> m1 = [Link]<int>(2, 3, 0)

// `matrix<int>` is unnecessary because the `[Link]<int>()` function returns an `int` type matrix o
bject.
m2 = [Link]<int>(2, 3, 0)

// Display matrix using a label.

if [Link]
[Link](bar_index, high, [Link](m2))

REMARKS

Matrix objects are always of "series" form.

SEE ALSO

var [Link]<type>() array

polyline
Keyword to explicitly declare the type of a variable or parameter as polyline . Scripts can produce polyline
instances using the [Link]() function.

SEE ALSO

[Link]

series
The series keyword explicitly assigns the "series" type qualifier to variables and function parameters. Variables and
parameters that use the "series" qualifier can reference values that change throughout a script's execution.

Explicit use of the series keyword when declaring the parameters of a library's exported functions is typically
unnecessary, as the compiler can usually automatically detect whether a parameter is compatible with "series" or
"simple" qualified values. By default, all exported function parameters are qualified as "series" wherever possible.
In variable declarations, the compiler can usually infer the qualified type automatically based on the values assigned to
a variable, and it can automatically change a variable's qualifier to a stronger one when necessary. The type qualifier
hierarchy is "const" < "input" < "simple" < "series", where "series" is the strongest.

Explicitly declaring a variable with the series keyword restricts the type qualifier to "series", meaning the script
cannot pass its value to any variable or function parameter that requires a value with a weaker qualifier ("const",
"input", or "simple").

When using this keyword to specify the type qualifier, one must also use a type keyword to declare the allowed type.

SYNTAX

export [method ]<functionName>([[series ]<paramType>] <paramName>[ = <defaultValue>])

[method ]<functionName>([series <paramType> ]<paramName>[ = <defaultValue>])

[var/varip ]series <variableType> <variableName> = <variableValue>

EXAMPLE
//@version=6
//@description A library with custom functions.
library("CustomFunctions", overlay = true)

//@function Finds the highest `source` value over `length` bars, filtered by the `cond` condition.
export conditionalHighest(series float source, series bool cond, series int length) =>
//@variable The highest `source` value from when the `cond` was `true` over `length` bars.
series float result = na
// Loop to find the highest value.
for i = 0 to length - 1
if cond[i]
value = source[i]
result := [Link](nz(result, value), value)
// Return the `result`.
result

//@variable Is `true` once every five bars.

series bool condition = bar_index % 5 == 0

//@variable The highest `close` value from every fifth bar over the last 100 bars.
series float hiValue = conditionalHighest(close, condition, 100)

plot(hiValue)
bgcolor(condition ? [Link]([Link], 80) : na)

EXAMPLE

//@version=6
indicator("series variable not allowed")

//@variable A variable declared as "series int" with a value of 5.

series int myVar = 5

// This call causes an error.

// The `histbase` accepts "input int/float". It can't accept the stronger "series int" qualified type.
plot(close, style = plot.style_histogram, histbase = myVar)

REMARKS

To learn more, see our User Manual's section on type qualifiers.

SEE ALSO

simple const

simple
The simple keyword explicitly assigns the "simple" type qualifier to variables and function parameters. Variables
and parameters that use the "simple" qualifier can reference values established at the beginning of a script's execution
that do not change later.

To restrict the parameters in a library's exported functions to only allow values with a "simple" or weaker type qualifier,
using the simple keyword when declaring parameters is often necessary, as libraries automatically qualify all
parameters as "series" wherever possible by default. Explicitly restricting functions to accept "simple" arguments also
allows them to return "simple" values in some cases, depending on the operations they execute, making them usable
with the parameters of built-in functions that do not allow "series" arguments.
In variable declarations, the compiler can usually infer the qualified type automatically based on the values assigned to
a variable, and it can automatically change a variable's qualifier to a stronger one when necessary. The type qualifier
hierarchy is "const" < "input" < "simple" < "series", where "simple" is stronger than "input" and "const".

Explicitly declaring a variable with the simple keyword restricts the type qualifier to "simple", meaning the script
cannot pass its value to any variable or function parameter that requires a value with a weaker qualifier ("const" or
"input"). Additionally, one cannot assign a "series" value to a variable explicitly declared with the simple keyword.

When using this keyword to specify the type qualifier, one must also use a type keyword to declare the allowed type.

SYNTAX
export [method ]<functionName>([[simple ]<paramType>] <paramName>[ = <defaultValue>])

[method ]<functionName>([simple <paramType> ]<paramName>[ = <defaultValue>])

[var/varip ]simple <variableType> <variableName> = <variableValue></variableValue>

EXAMPLE

//@version=6
//@description A library with custom functions.
library("CustomFunctions", overlay = true)

//@function Calculates the length values for a ribbon of four EMAs by multiplying the `baseLeng
th`.
//@param baseLength The initial EMA length. Requires "simple int" because you can't use "series int" i
n `[Link]()`.
//@returns A tuple of length values.
export ribbonLengths(simple int baseLength) =>
simple int length1 = baseLength
simple int length2 = baseLength * 2
simple int length3 = baseLength * 3
simple int length4 = baseLength * 4
[length1, length2, length3, length4]

// Get a tuple of "simple int" length values.

[len1, len2, len3, len4] = ribbonLengths(14)

// Plot four EMAs using the values from the tuple.

plot([Link](close, len1), "EMA 1", color = [Link])
plot([Link](close, len2), "EMA 1", color = [Link])
plot([Link](close, len3), "EMA 1", color = [Link])
plot([Link](close, len4), "EMA 1", color = [Link])

EXAMPLE

//@version=6
indicator("can't change simple to series")

//@variable A variable declared as "simple float" with a value of 5.0.

simple float myVar = 5.0

// This reassignment causes an error.

// The `close` variable returns a "series float" value. Since `myVar` is restricted to "simple" value
s, it cannot
// change its qualifier to "series".
myVar := close

plot(myVar)

REMARKS

To learn more, see our User Manual's section on type qualifiers.

SEE ALSO

series const

string
Keyword used to explicitly declare the "string" type of a variable or a parameter.

EXAMPLE

//@version=6
indicator("string")
string s = "Hello World!" // Same as `s = "Hello world!"`
// string s = na // same as ""
plot(na, title=s)
REMARKS

Explicitly mentioning the type in a variable declaration is optional, except when it is initialized with na. Learn more
about Pine Script® types in the User Manual page on the Type System.

SEE ALSO

var varip int float bool [Link]() [Link]()

table
Keyword used to explicitly declare the "table" type of a variable or a parameter. Table objects (or IDs) can be created
with the [Link]() function.

EXAMPLE

//@version=6
indicator("table")
// Empty `table1` table ID.
var table table1 = na
// `table` type is unnecessary because `[Link]()` returns "table" type.
var table2 = [Link](position.top_left, na, na)

if [Link]
var table3 = [Link](position = position.top_right, columns = 1, rows = 1, bgcolor = [Link]
w, border_width = 1)
[Link](table_id = table3, column = 0, row = 0, text = "table3 text")

REMARKS

Table objects are always of "series" form.

SEE ALSO

var line label box [Link]()

volume_row
Keyword to explicitly declare the type of a variable or parameter as volume_row . Script can produce volume_row
instances using the [Link](), [Link](), [Link]() functions.

SEE ALSO

footprint volume_row.up_price() volume_row.down_price() volume_row.total_volume() volume_row.buy_volume()

volume_row.sell_volume() volume_row.delta() volume_row.has_buy_imbalance() volume_row.has_sell_imbalance()

Operators

-
Subtraction or unary minus. Applicable to numerical expressions.

SYNTAX

expr1 - expr2

RETURNS

Returns integer or float value, or series of values:

Binary - returns expr1 minus expr2.
Unary - returns the negation of expr.

REMARKS

You may use arithmetic operators with numbers as well as with series variables. In case of usage with series the
operators are applied elementwise.

-=
Subtraction assignment. Applicable to numerical expressions.

SYNTAX

expr1 -= expr2

EXAMPLE

//@version=6
indicator("-=")
// Equals to expr1 = expr1 - expr2.
a = 2
b = 3
a -= b
// Result: a = -1.
plot(a)

RETURNS

Integer or float value, or series of values.

:=
Reassignment operator. It is used to assign a new value to a previously declared variable.

SYNTAX

<var_name> := <new_value>

EXAMPLE

//@version=6
indicator("My script")

myVar = 10

if close > open

// Modifies the existing global scope `myVar` variable by changing its value from 10 to 20.
myVar := 20
// Creates a new `myVar` variable local to the `if` condition and unreachable from the global scop
e.
// Does not affect the `myVar` declared in global scope.
myVar = 30

plot(myVar)

!=
Inequality operator. Returns true if the operands are considered not equal, and false otherwise. This operator is
compatible with all value types, including "int", "float", "bool", "color", and "string". The operator can also compare two
line or label IDs.

SYNTAX
expr1 != expr2

RETURNS

Boolean value, or series of boolean values.

REMARKS

This operator rounds "float" operands to nine fractional digits.

?:
Ternary conditional operator.

SYNTAX

expr1 ? expr2 : expr3

EXAMPLE

//@version=6
indicator("?:")
// Draw circles at the bars where open crosses close
s2 = [Link](open, close) ? [Link](open,close) : na
plot(s2, style=plot.style_circles, linewidth=2, color=[Link])

// Combination of ?: operators for 'switch'-like logic

c = [Link] ? [Link] : [Link] ? [Link] : [Link] ? [Link]
e : [Link]
plot(hl2, color=c)

RETURNS

expr2 if expr1 is evaluated to true, expr3 otherwise. Zero value (0 and also NaN, +Infinity, -Infinity) is considered to be
false, any other value is true.

REMARKS

Use na for 'else' branch if you do not need it.

You can combine two or more ?: operators to achieve the equivalent of a 'switch'-like statement (see examples above).
You may use arithmetic operators with numbers as well as with series variables. In case of usage with series the
operators are applied elementwise.

SEE ALSO

[]
Series subscript. Provides access to previous values of series expr1. expr2 is the number of bars back, and must be
numerical. Floats will be rounded down.

SYNTAX

expr1[expr2]

EXAMPLE

//@version=6
indicator("[]")
// [] can be used to "save" variable value between bars
a = 0.0 // declare `a`
a := a[1] // immediately set current value to the same as previous. `na` in the beginning of history
if high == low // if some condition - change `a` value to another
a := low
plot(a)

RETURNS

A series of values.

SEE ALSO

[Link]()

*
Multiplication. Applicable to numerical expressions.

SYNTAX

expr1 * expr2

RETURNS

Integer or float value, or series of values.

*=
Multiplication assignment. Applicable to numerical expressions.

SYNTAX

expr1 *= expr2

EXAMPLE

//@version=6
indicator("*=")
// Equals to expr1 = expr1 * expr2.
a = 2
b = 3
a *= b
// Result: a = 6.
plot(a)

RETURNS

Integer or float value, or series of values.

/
Division. Applicable to numerical expressions.

SYNTAX

expr1 / expr2

RETURNS

Integer or float value, or series of values.

/=
Division assignment. Applicable to numerical expressions.
SYNTAX

expr1 /= expr2

EXAMPLE

//@version=6
indicator("/=")
// Equals to expr1 = expr1 / expr2.
float a = 3.0
b = 3
a /= b
// Result: a = 1.
plot(a)

RETURNS

Integer or float value, or series of values.

%
Modulo (integer remainder). Applicable to numerical expressions.

SYNTAX

expr1 % expr2

RETURNS

Integer or float value, or series of values.

REMARKS

In Pine Script®, when the integer remainder is calculated, the quotient is truncated, i.e. rounded towards the lowest
absolute value. The resulting value will have the same sign as the dividend.

Example: -1 % 9 = -1 - 9 * int(-1/9) = -1 - 9 * int(-0.111) = -1 - 9 * 0 = -1.

%=
Modulo assignment. Applicable to numerical expressions.

SYNTAX

expr1 %= expr2

EXAMPLE

//@version=6
indicator("%=")
// Equals to expr1 = expr1 % expr2.
a = 3
b = 3
a %= b
// Result: a = 0.
plot(a)

RETURNS

Integer or float value, or series of values.

+
Addition or unary plus. Applicable to numerical expressions or strings.

SYNTAX

expr1 + expr2

RETURNS

Binary + for strings returns concatenation of expr1 and expr2

For numbers returns integer or float value, or series of values:

Binary + returns expr1 plus expr2.

Unary + returns expr (does nothing added just for the symmetry with the unary - operator).

REMARKS

You may use arithmetic operators with numbers as well as with series variables. In case of usage with series the
operators are applied elementwise.

+=
Addition assignment. Applicable to numerical expressions or strings.

SYNTAX

expr1 += expr2

EXAMPLE

//@version=6
indicator("+=")
// Equals to expr1 = expr1 + expr2.
a = 2
b = 3
a += b
// Result: a = 5.
plot(a)

RETURNS

For strings returns concatenation of expr1 and expr2. For numbers returns integer or float value, or series of values.

REMARKS

You may use arithmetic operators with numbers as well as with series variables. In case of usage with series the
operators are applied elementwise.

<
Less than. Applicable to numerical expressions.

SYNTAX

expr1 < expr2

RETURNS

Boolean value, or series of boolean values.

<=
Less than or equal to. Applicable to numerical expressions.
SYNTAX

expr1 <= expr2

RETURNS

Boolean value, or series of boolean values.

=
Assignment operator. Assigns an initial value or reference to a declared variable. It means this is a new variable, and it
starts with this value.

SYNTAX

<var_name> := <initial_value>

EXAMPLE

Annotations

@description
Sets a custom description for scripts that use the library() declaration statement. The text provided with this
annotation will be used to pre-fill the "Description" field in the publication dialogue.

EXAMPLE

//@version=6
// @description Provides a tool to quickly output a label on the chart.
library("MyLibrary")

// @function Outputs a label with `labelText` on the bar's high.

// @param labelText (series string) The text to display on the label.
// @returns Drawn label.
export drawLabel(string labelText) =>
[Link](bar_index, high, text = labelText)
@enum
If placed above an enum declaration, it adds a custom description for the enum. The Pine Editor's autosuggest uses
this description and displays it when a user hovers over the enum name. When used in library scripts, the descriptions
of all enums using the export keyword will pre-fill the "Description" field in the publication dialogue.

EXAMPLE

//@version=6
indicator("Session highlight", overlay = true)

//@enum Contains fields with popular timezones as titles.

//@field exch Has an empty string as the title to represent the chart timezone.
enum tz
utc = "UTC"
exch = ""
ny = "America/New_York"
chi = "America/Chicago"
lon = "Europe/London"
tok = "Asia/Tokyo"

//@variable The session string.

selectedSession = [Link]("1200-1500", "Session")
//@variable The selected timezone. The input's dropdown contains the fields in the `tz` enum.
selectedTimezone = [Link]([Link], "Session Timezone")

//@variable Is `true` if the current bar's time is in the specified session.

bool inSession = false
if not na(time("", selectedSession, [Link](selectedTimezone)))
inSession := true

// Highlight the background when `inSession` is `true`.

bgcolor(inSession ? [Link]([Link], 90) : na, title = "Active session highlight")

@field
If placed above a type or enum declaration, it adds a custom description for a field of the type/enum. After the
annotation, users should specify the field name, followed by its description.
The Pine Editor's autosuggest uses this description and displays it when a user hovers over the type/enum or field
name. When used in library() scripts, the descriptions of all types/enums using the export keyword will pre-fill the
"Description" field in the publication dialogue.

EXAMPLE

//@version=6
indicator("New high over the last 20 bars", overlay = true)

//@type A point on a chart.

//@field index The index of the bar where the point is located, i.e., its `x` coordinate.
//@field price The price where the point is located, i.e., its `y` coordinate.
type Point
int index
float price

//@variable If the current `high` is the highest over the last 20 bars, returns a new `Point` instanc
e, `na` otherwise.
Point highest = na

if [Link](high, 20) == 0
highest := [Link](bar_index, high)
[Link]([Link], [Link], [Link]([Link]))

@function
If placed above a function declaration, it adds a custom description for the function.
The Pine Editor's autosuggest uses this description and displays it when a user hovers over the function name. When
used in library() scripts, the descriptions of all functions using the export keyword will pre-fill the "Description" field in
the publication dialogue.

EXAMPLE

//@version=6
// @description Provides a tool to quickly output a label on the chart.
library("MyLibrary")

// @function Outputs a label with `labelText` on the bar's high.

// @param labelText (series string) The text to display on the label.
// @returns Drawn label.
export drawLabel(string labelText) =>
[Link](bar_index, high, text = labelText)

@param
If placed above a function declaration, it adds a custom description for a function parameter. After the annotation,
users should specify the parameter name, then its description.
The Pine Editor's autosuggest uses this description and displays it when a user hovers over the function name. When
used in library() scripts, the descriptions of all functions using the export keyword will pre-fill the "Description" field in
the publication dialogue.

EXAMPLE

//@version=6
// @description Provides a tool to quickly output a label on the chart.
library("MyLibrary")

// @function Outputs a label with `labelText` on the bar's high.

// @param labelText (series string) The text to display on the label.
// @returns Drawn label.
export drawLabel(string labelText) =>
[Link](bar_index, high, text = labelText)

@returns
If placed above a function declaration, it adds a custom description for what that function returns.
The Pine Editor's autosuggest uses this description and displays it when a user hovers over the function name. When
used in library() scripts, the descriptions of all functions using the export keyword will pre-fill the "Description" field in
the publication dialogue.

EXAMPLE

//@version=6
// @description Provides a tool to quickly output a label on the chart.
library("MyLibrary")

//Pine Script® v1 has no function named `indicator()`, so the script will not compile.
indicator("Pine v1 Indicator")
plot(close)

REMARKS

The version should always be specified. Otherwise, for compatibility reasons, the script will be compiled using Pine
Script® v1, which lacks most of the newer features and is bound to confuse. This annotation can be anywhere within a
script, but we recommend placing it at the top of the code for readability.

Custom Trading Indicator Script
No ratings yet
Custom Trading Indicator Script
20 pages
Trading Range Filter and Order Blocks
No ratings yet
Trading Range Filter and Order Blocks
48 pages
IronBot v3 Trading Indicator Code
No ratings yet
IronBot v3 Trading Indicator Code
12 pages
UST Signal Conditions for Scalping
No ratings yet
UST Signal Conditions for Scalping
2 pages
TradeAi Trend Table Overview
No ratings yet
TradeAi Trend Table Overview
2 pages
Algorithmic Trading System Manual 20 Pages
No ratings yet
Algorithmic Trading System Manual 20 Pages
22 pages
Daily Positional Trading Indicator
No ratings yet
Daily Positional Trading Indicator
2 pages
Crypto Futures Risk Management Guide
No ratings yet
Crypto Futures Risk Management Guide
5 pages
BTC Position Sizing Calculator Guide
100% (1)
BTC Position Sizing Calculator Guide
5 pages
Ghost Automated Trading Reference
No ratings yet
Ghost Automated Trading Reference
5 pages
Traders Intelligence System
No ratings yet
Traders Intelligence System
15 pages
Class 10 Statistics Formulas Guide
No ratings yet
Class 10 Statistics Formulas Guide
3 pages
Zimmerman, RL - Python Coding - One Year Later - A Treasure Trove of Practical and Simple Examples (2020, Cathy - Wilson@att - Net) - Libgen - Li
No ratings yet
Zimmerman, RL - Python Coding - One Year Later - A Treasure Trove of Practical and Simple Examples (2020, Cathy - Wilson@att - Net) - Libgen - Li
403 pages
Qwen Training Manual: Features & Best Practices
No ratings yet
Qwen Training Manual: Features & Best Practices
5 pages
Understanding Crypto Derivatives Market
No ratings yet
Understanding Crypto Derivatives Market
14 pages
AI Prompting Guide 5
No ratings yet
AI Prompting Guide 5
11 pages
Formulas and Tables For Statistics
No ratings yet
Formulas and Tables For Statistics
11 pages
TTFM Swing Model
No ratings yet
TTFM Swing Model
9 pages
90-Day Crypto Trading Checklist
No ratings yet
90-Day Crypto Trading Checklist
1 page
AI Code Tutor and Debugger
No ratings yet
AI Code Tutor and Debugger
14 pages
AI Models for Python Code Generation Analysis
No ratings yet
AI Models for Python Code Generation Analysis
17 pages
AI Prompt Handbook
100% (1)
AI Prompt Handbook
16 pages
AI Volume Squeeze Candle Indicator
No ratings yet
AI Volume Squeeze Candle Indicator
33 pages
Pine Script BuySell Indicators Guide
No ratings yet
Pine Script BuySell Indicators Guide
10 pages
Importance of Clear Prompts
No ratings yet
Importance of Clear Prompts
22 pages
Pine Script Array Line Example
No ratings yet
Pine Script Array Line Example
2 pages
Long-Only Crypto Trading Strategy
No ratings yet
Long-Only Crypto Trading Strategy
3 pages
AI Tools for Code Generation & Debugging
No ratings yet
AI Tools for Code Generation & Debugging
8 pages
AI-Assisted Coding Best Practices
No ratings yet
AI-Assisted Coding Best Practices
17 pages
A Comprehensive Survey of Self-Evolving AI Agents
No ratings yet
A Comprehensive Survey of Self-Evolving AI Agents
54 pages
Top 10 Effective Trading Indicators
No ratings yet
Top 10 Effective Trading Indicators
7 pages
Free MarketCipher B Trading Indicator
No ratings yet
Free MarketCipher B Trading Indicator
4 pages
AI Prompt Mega-Pack
No ratings yet
AI Prompt Mega-Pack
5 pages
Trading Bot para Binance con SL y TP
No ratings yet
Trading Bot para Binance con SL y TP
12 pages
Forever Model Trading Indicator Setup
No ratings yet
Forever Model Trading Indicator Setup
8 pages
Arc System Indicator for Trading Analysis
No ratings yet
Arc System Indicator for Trading Analysis
2 pages
DR/IDR Candles Indicator Script
No ratings yet
DR/IDR Candles Indicator Script
5 pages
DCA Settings for Profit Trailer Bot
No ratings yet
DCA Settings for Profit Trailer Bot
4 pages
OJLJ Elliott Waves Detector Script
No ratings yet
OJLJ Elliott Waves Detector Script
3 pages
Pine Script Focus Indicator Guide
No ratings yet
Pine Script Focus Indicator Guide
1 page
Top 20 Free Data Science MOOCs
No ratings yet
Top 20 Free Data Science MOOCs
21 pages
15-Minute BTCUSDTPERP Trading Bot
No ratings yet
15-Minute BTCUSDTPERP Trading Bot
9 pages
Twin Range Filter Indicator for TradingView
No ratings yet
Twin Range Filter Indicator for TradingView
2 pages
Trading Targets Indicator Script
No ratings yet
Trading Targets Indicator Script
14 pages
Pine References
No ratings yet
Pine References
134 pages
Stock Market Trading Basics
No ratings yet
Stock Market Trading Basics
5 pages
Orb Probability Sniper Pinescript V6
No ratings yet
Orb Probability Sniper Pinescript V6
10 pages
Liquidation Hunting in Crypto Trading
No ratings yet
Liquidation Hunting in Crypto Trading
2 pages
Volatility-Scaled Trading Strategy
No ratings yet
Volatility-Scaled Trading Strategy
2 pages
TTP ICT Unicorn Trading Strategy
No ratings yet
TTP ICT Unicorn Trading Strategy
12 pages
Python Coding Style
No ratings yet
Python Coding Style
32 pages
Pivot Indicator for Trading Analysis
No ratings yet
Pivot Indicator for Trading Analysis
12 pages
Sample
No ratings yet
Sample
72 pages
Trading Bot
No ratings yet
Trading Bot
7 pages
Price Action Toolkit v6
No ratings yet
Price Action Toolkit v6
17 pages
Advanced Trend Meter in Pine Script
No ratings yet
Advanced Trend Meter in Pine Script
4 pages
Close Above Previous High with Labels
No ratings yet
Close Above Previous High with Labels
5 pages
Breaker Blocks Indicator Script
No ratings yet
Breaker Blocks Indicator Script
16 pages
Supertrend AI Clustering
No ratings yet
Supertrend AI Clustering
5 pages
Pine Script Variables Explained
No ratings yet
Pine Script Variables Explained
587 pages
Dividend Decision in Financial Management
No ratings yet
Dividend Decision in Financial Management
76 pages
JK Tyre Dividend Analysis 2024
No ratings yet
JK Tyre Dividend Analysis 2024
26 pages
Class X Ratio Analysis Overview
No ratings yet
Class X Ratio Analysis Overview
15 pages
3 Introduction To Gaps
No ratings yet
3 Introduction To Gaps
14 pages
Ch. 14 Gitman 14e
100% (1)
Ch. 14 Gitman 14e
65 pages
BANKINDIA Futures & Options Adjustment
No ratings yet
BANKINDIA Futures & Options Adjustment
6 pages
Ex-Dividend Date Stock Price Analysis
No ratings yet
Ex-Dividend Date Stock Price Analysis
51 pages
Lecture-11 12 Payout-Policy
No ratings yet
Lecture-11 12 Payout-Policy
26 pages
Ambit - Strategy - Thematic - Ten Baggers 8 - A Relook at The Past For Progress - 28jan2019 PDF
No ratings yet
Ambit - Strategy - Thematic - Ten Baggers 8 - A Relook at The Past For Progress - 28jan2019 PDF
29 pages
Corporate Finance Practice Exam: Stocks & Dividends
No ratings yet
Corporate Finance Practice Exam: Stocks & Dividends
3 pages
Ftse Uk Index Series Guide To Calc
No ratings yet
Ftse Uk Index Series Guide To Calc
18 pages
Understanding Dividend Decisions
No ratings yet
Understanding Dividend Decisions
49 pages
Dividends and Dividend Policy: Mcgraw-Hill/Irwin ©2001 The Mcgraw-Hill Companies All Rights Reserved
No ratings yet
Dividends and Dividend Policy: Mcgraw-Hill/Irwin ©2001 The Mcgraw-Hill Companies All Rights Reserved
24 pages
Finance Formula Sheet Overview
No ratings yet
Finance Formula Sheet Overview
11 pages
Chapter Nineteen: Dividends and Other Payouts
No ratings yet
Chapter Nineteen: Dividends and Other Payouts
37 pages
Understanding Corporate Dividends
No ratings yet
Understanding Corporate Dividends
2 pages
Capital Structure and Financial Leverage
No ratings yet
Capital Structure and Financial Leverage
118 pages
SEC Mock Exam: Capital Raising & Leasing
No ratings yet
SEC Mock Exam: Capital Raising & Leasing
15 pages
Question Bank For Principles of Corporate Finance 12th Edition by Richard Brealey
No ratings yet
Question Bank For Principles of Corporate Finance 12th Edition by Richard Brealey
27 pages
2025 Dividend Announcements in Kenya
No ratings yet
2025 Dividend Announcements in Kenya
3 pages
Recently Announced Corporate Actions'
No ratings yet
Recently Announced Corporate Actions'
2 pages
Understanding Dividend Policy Essentials
No ratings yet
Understanding Dividend Policy Essentials
6 pages
Global Market Indices and Economic Update
No ratings yet
Global Market Indices and Economic Update
3 pages
Payout Policy: Suggested Answer To Opener-in-Review Question
No ratings yet
Payout Policy: Suggested Answer To Opener-in-Review Question
15 pages
Dividend Policy and Retained Earnings: Foundations of Financial Management
No ratings yet
Dividend Policy and Retained Earnings: Foundations of Financial Management
38 pages
Corporate Actions Guide for Indices
No ratings yet
Corporate Actions Guide for Indices
32 pages
Understanding Corporate Actions Explained
No ratings yet
Understanding Corporate Actions Explained
5 pages
Abnormal Earnings Growth Valuation Guide
No ratings yet
Abnormal Earnings Growth Valuation Guide
6 pages
Portfolio Return Calculations
No ratings yet
Portfolio Return Calculations
13 pages
eSSVI Implied Volatility WP FY20
No ratings yet
eSSVI Implied Volatility WP FY20
11 pages