mirror of
https://github.com/bitburner-official/bitburner-src.git
synced 2024-11-10 01:33:54 +01:00
35 lines
955 B
Markdown
35 lines
955 B
Markdown
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||
|
||
[Home](./index.md) > [bitburner](./bitburner.md) > [TIX](./bitburner.tix.md) > [getVolatility](./bitburner.tix.getvolatility.md)
|
||
|
||
## TIX.getVolatility() method
|
||
|
||
Returns the volatility of the specified stock.
|
||
|
||
Volatility represents the maximum percentage by which a stock’s 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.
|
||
|
||
<b>Signature:</b>
|
||
|
||
```typescript
|
||
getVolatility(sym: StockSymbol): number;
|
||
```
|
||
|
||
## Parameters
|
||
|
||
| Parameter | Type | Description |
|
||
| --- | --- | --- |
|
||
| sym | [StockSymbol](./bitburner.stocksymbol.md) | Stock symbol. |
|
||
|
||
<b>Returns:</b>
|
||
|
||
number
|
||
|
||
Volatility of the specified stock.
|
||
|
||
## Remarks
|
||
|
||
2.5 GB
|
||
|