bitburner-src/markdown/bitburner.tix.getvolatility.md
Olivier Gagnon 43fc5dfd48 work on doc
2021-10-30 12:34:14 -04:00

955 B
Raw Blame History

Home > bitburner > TIX > getVolatility

TIX.getVolatility() method

Returns the volatility of the specified stock.

Volatility represents the maximum percentage by which a stocks price can change every tick. The volatility is returned as a decimal value, NOT a percentage (e.g. if a stock has a volatility of 3%, then this function will return 0.03, NOT 3).

In order to use this function, you must first purchase access to the Four Sigma (4S) Market Data TIX API.

Signature:

getVolatility(sym: StockSymbol): number;

Parameters

Parameter Type Description
sym StockSymbol Stock symbol.

Returns:

number

Volatility of the specified stock.

Remarks

2.5 GB