Complete Reference - kScript Documentation

Notice!

This is documentation for kScript v1.0, which may not include the latest features. For up-to-date documentation, see the latest version.

Variables & Constants

Core variables, data types, and constants available in kScript for market data access and styling.

Core Data Variables

4 items

currentSymbolstring

The current trading symbol (e.g., 'BTCUSDT')

currentSymbol // Returns 'BTCUSDT'

currentExchangestring

The current exchange being used for trading (e.g., 'BINANCE', 'COINBASE')

currentExchange // Returns 'BINANCE'

colorcolor

The color to use for plotting (e.g., 'red', 'blue')

plotLine(ema20, ["blue"], 2);

color[]color[]

Storing an array of color

let colors = ["red", "green", "blue"];

Color Constants

17 items

yellowcolor

Yellow color (#FFFF00)

orangecolor

Orange color (#FFA500)

purplecolor

Purple color (#800080)

graycolor

Gray color (#808080)

blackcolor

Black color (#000000)

whitecolor

White color (#FFFFFF)

Data Types

2 items

timeseriesTimeSeries

This represents time-aligned numerical data. Only timeseries data can be passed into plot().

ShapeTypeShapeType

Defines the type of shape to render when using plotShape function. Currently supports 'circle' with more shapes potentially available.

plotShape(signals, "circle", ["red"], 2, true);

Data Sources

6 items

buy_sell_volumeDataSource

Buy/sell volume from trade data

timeseries buySellData = source("buy_sell_volume", currentSymbol, currentExchange);
timeseries buyVolume = buySellData.buy;
timeseries sellVolume = buySellData.sell;

funding_rateDataSource

Funding rate aggregation data from derivatives markets

timeseries fundingData = source("funding_rate", currentSymbol, currentExchange);
// Single value data source

liquidationsDataSource

Liquidation aggregation data from derivatives markets

timeseries liquidationData = source("liquidations", currentSymbol, currentExchange);
timeseries buyLiquidations = liquidationData.buy;
timeseries sellLiquidations = liquidationData.sell;

ohlcvDataSource

Open, High, Low, Close, Volume data from trade aggregations

timeseries ohlcv = source("ohlcv", currentSymbol, currentExchange);
timeseries close = ohlcv.close;
timeseries volume = ohlcv.volume;
timeseries high = ohlcv.high;

open_interestDataSource

Open interest aggregation data from derivatives markets

timeseries openInterestData = source("open_interest", currentSymbol, currentExchange);
timeseries oiClose = openInterestData.close;
timeseries oiHigh = openInterestData.high;

orderbookDataSource

Orderbook heatmap snapshot aggregation data

timeseries orderbookData = source("orderbook", currentSymbol, currentExchange);
// Use with orderbook functions like sumBids(), sumAsks()

Function Categories

Explore technical indicators, mathematical functions, and utilities organized by category.

Moving Averages

4 functions

Trend-following indicators that smooth price data

sma() _sma() ema()

Oscillators

3 functions

Momentum indicators that fluctuate between bounded values

rsi() _cci() _stochastic()

Volume Indicators

2 functions

Indicators that incorporate volume data in their calculations

_mfi() _obv()

Trend Indicators

4 functions

Indicators that help identify trend direction and strength

_adx() _ichimoku() _macd()

Utility Functions

8 functions

Helper functions for statistical calculations and data manipulation

lowest() highest() sum()

Plotting & Visualization

5 functions

Functions for rendering data on charts

plot() plotCandle() plotBar()

TimeSeries Management

3 functions

Functions for creating, transforming and merging time series data

buildTimeseries() matchTimestamp() timeseries()

Script Definition

4 functions

Functions for defining script metadata and input parameters

define() input() source()

Color Functions

6 functions

Functions for manipulating and transforming colors

brightness() darken() lighten()

Orderbook Functions

6 functions

Functions for working with orderbook data

sumBids() sumAsks() maxBidAmount()

Popular Functions

Commonly used functions for quick access and reference.

smaMoving Averages

Simple Moving Average calculation

sma(source, period, priceIndex?)

emaMoving Averages

Exponential Moving Average calculation

ema(source, period, priceIndex?)

rsiOscillators

Relative Strength Index oscillator

rsi(source, period, priceIndex?)

plotPlotting & Visualization

Universal plotting function for all visualization types. The primary way to display your calculated data on charts.

plot(series, type?, colors?, width?, fill?, smooth?, showPriceDisplay?)