Multi-timeframe

Note

For converting values in different currencies to a comparable unit. Rate data comes from the terminal. If the direct pair is unavailable the inverse (1/rate) is used, and failing that a USD cross is computed — every combination of the 11 supported units works.

When to use

To align two values priced in different currencies to a common unit before comparing them.

Limits

Supported units: USD, EUR, GBP, JPY, TRY, AUD, CAD, CHF, NZD and XAU/XAG (gold/silver ounce) — any other code returns na. Source/target must be LITERAL text: a variable call like `currencyRate(a, b)` fetches no rate and returns na. na before the bar where rate data begins (no rate is carried back into the past). If the same currency code is given, the result is a constant 1.0 (no data needed). Codes are case-insensitive.

Not for

Not for converting a strategy's P&L to the account currency (that is convertToAccount's job); nor is it a price feed.

Note

na on non-payment bars; the whole series is na if no data.

Limits

"gross"/"net" come from the Borsa İstanbul rights-usage announcement (amount per 1 TL nominal). The difference is withholding tax (e.g. gross 2.00 → net 1.70); in withholding-exempt cases such as REITs the two are equal, which is not an error. "yield"/"paid" come from the company calendar and cover the current period only. Dates the archive does not cover return na.

Note

na on non-announcement bars; na if no data.

Limits

Currently NOT connected to a data source — returns na on every bar (silent, no error; a one-time warning is shown on first use).

Note

A value appears only on bars after its release, na before that — tomorrow's rate decision is not visible on today's bar. Macro indicators are released infrequently; the value is carried forward until the next release.

Limits

Only RELEASED figures are supplied. Forecast and previous-period values are NOT used: the calendar does not record when those were published, and putting today's forecast on an older bar would be backward leakage. The calendar source covers the recent window (roughly the past week plus the coming week) → older bars return na; it is not yet suitable for long-history backtests. Events without a code (ticker) in the calendar cannot be addressed either.

Note

The value applies only from its report date onward (no look-ahead); na if unavailable.

When to use

In strategies combining price with fundamentals (revenue, earnings, debt).

Limits

Read from KAP official financial statements for BIST stocks. A statement is visible only on bars after the date it was RECORDED; since the archive began on 18 May 2026, earlier bars return na (deliberate: showing a statement on an older bar, before it was known, would be backward leakage). Symbols/items/periods without data return na. The same data is supplied everywhere: normal run, optimization, forward-test, bot and scan (so optimized parameters rest on the data the bot will actually see).

Note

There is NO look-ahead — the value appears only after the HTF bar closes, so it does not peek into the future (repaint-safe). A simpler shortcut than `security` for same-symbol higher timeframes.

When to use

To use a higher-timeframe trend/level (e.g. daily close, weekly average) as a filter on a lower-timeframe chart.

Limits

Until the HTF bar closes the value comes from the previous completed bar (it does not show the currently forming HTF bar). timeframe must be a valid duration.

Note

Present for backward compatibility; it returns no functional data because the source was shut down (the upstream itself is closed).

Limits

Always na. Use `seed`/`financial`/`economic` instead.

Note

The higher-timeframe value is aligned after that bar CLOSES (it does not look ahead and does not change afterward). The `currency` (FX conversion) and `calc_bars_count` parameters are NOT supported in this version — if given, they are silently ignored. The higher-timeframe value aligns only after that bar closes; the symbol and timeframe must stay constant throughout the run.

When to use

For a multi-timeframe filter (for example, trading on the 5-minute according to the 1-hour trend direction).

Limits

The symbol and timeframe must stay fixed through the run (a symbol that changes bar by bar is not supported). Until the higher-timeframe bar closes, the last closed higher-timeframe value is carried forward — so it looks flat across the forming higher-timeframe bar.

Not for

Not for a symbol or timeframe that changes bar by bar — both must stay constant through the run. If you want the same data as the chart's own timeframe, you do not need security; use close/sma(...) directly. It is not for dropping to a lower (shorter) timeframe to read data early; a higher-timeframe value aligns only after that bar closes.

Tip

The higher-timeframe value aligns only after that bar closes; the symbol and timeframe must stay constant throughout the run.

Note

Equivalent to `request.security_lower_tf(symbol, tf, source)` (the namespace form). The `source` expression may only reference built-ins, user functions (`fn`), and independent top-level variables.

Limits

Only accepts a LOWER timeframe — passing the same or a higher TF raises a clear error (use `request.security` for that). There is a depth limit on nested `request.security*` calls; exceeding it raises an error.

Note

Populated only if the terminal supplies the relevant seed data; otherwise na.

Limits

If this data is not supplied by the terminal, the series is empty (na). Fundamental-data coverage varies by symbol/market.

Note

The value appears from the day the entitlement starts and carries forward until the next event; before that it is na.

Limits

Only BONUS (free) share distributions are recorded. Paid (rights) capital increases are deliberately excluded — those are not a share split but raising money from shareholders, and their price effect is computed differently. The source archive is collected daily from Borsa İstanbul announcements; dates the archive does not cover return na. The price series already arrives adjusted for bonus issues — this function is not for adjusting the price but for seeing which day the event happened.

Note

For pair/ratio strategies: ratio = close / sym("LTCUSDT").close. The returned object's fields are used in calculations like any series.

When to use

To compare two instruments on one chart, build a ratio/spread, or measure relative strength or correlation (market-neutral pairs).

Limits

At most 4 additional symbols. The data must be supplied by the terminal; if it is not loaded the call raises. Series are aligned to this chart's bar times (the secondary symbol's own gaps are carried onto the aligned grid).

Not for

Not for a higher timeframe of the same symbol — use htf or security for that. Not for fundamental data (financials/dividends) either.

Note

To extract which exchange/provider a symbol belongs to.

When to use

To branch or label by the exchange/provider segment of a ticker (e.g. applying a rule only to "BIST" symbols).

Limits

Splits on the first ":"; returns an empty string for a symbol without a ":".

Note

Bare syminfoTicker() yields the active symbol in multi-symbol scans (useful inside request.security loops and securityLowerTf expressions).

When to use

To get the bare symbol code without a prefix, or to learn the currently processed symbol inside a scan for labeling/logging.

Limits

The argument form takes what follows the first ":" (or the string as-is if there is no ":"). The bare form returns an empty string when no active symbol is set.

Note

Mirrors the common idiom: security(tickerHeikinashi(syminfo.ticker), "" instead of timeframe.period, close). The close/open/high/low inside that call are NOT standard bars — they are the Heikin-Ashi formula (close=(o+h+l+c)/4, open=average of the previous HA-open/HA-close, high/low=max/min of the real value and HA-open/HA-close).

When to use

When you want an HA-based source (e.g. a crossover against HA-close) without switching the main chart to Heikin-Ashi.

Limits

Only works at the chart's OWN timeframe — a different timeframe (e.g. "1D" on a 1h chart) raises a clear error (it does NOT produce an approximate/wrong result). For another symbol's Heikin-Ashi, that symbol must already be loaded elsewhere in the code via sym()/security().

Note

Intended for a symbol to inherit another symbol's settings; it has no effect on standard bars (a placeholder).

When to use

For syntax compatibility when porting code where one symbol inherits another's settings.

Limits

Returns the first ticker unchanged; no real setting is carried over from the source ticker.

Note

Intended to attach session/adjustment settings to a ticker; since CodeScript works on standard bars, this transform leaves the symbol as-is (a placeholder).

When to use

Present for syntax compatibility when porting code that attach session/adjustment settings.

Limits

Returns the ticker unchanged; no session/adjustment transform is applied.

Not for

Not for changing the bar type (renko/heikin-ashi, etc.) — those transforms raise an error here.

Note

Used to build a full ticker for security or sym. The result is a string, not a series.

When to use

To assemble a fully-qualified ticker from an exchange prefix + symbol to pass to security/sym.

Limits

It only concatenates text (prefix + ":" + symbol); it does not fetch data by itself. If the prefix is empty the result is just the symbol.

Note

Intended to convert a symbol to a standard (untransformed) ticker; since CodeScript works on standard bars, this transform leaves the symbol as-is (a placeholder).

When to use

To explicitly state that a symbol should use the standard bar type (behavior is standard already).

Limits

Returns the ticker unchanged; it has no effect since CodeScript already produces standard bars.

Note

For simulating trades on a ratio/spread instead of close (pair mode). If not called, the backtest uses close.

When to use

When signals are generated on a pair/ratio and P&L should be computed on that same pair (market-neutral backtest).

Limits

It may be called only once in the same code (a second call raises). The argument must be a series.

Not for

It draws nothing; use plot for visual output. It is not needed when you trade the chart symbol itself (close is the default instrument).

Note

security() aligns the secondary series to EVERY chart bar and pulls the whole range. For a single figure in a panel this form pulls far less: measured on a 3,270-bar chart, 4,200 bars sufficed instead of ~1,360,000, with identical output.