bitburner-src/markdown/bitburner.tix.getvolatility.md
omuretsu 06a985bdf8 Revert "Remove markdown from git tracking (#139)"
This reverts commit bbb6e3f309935aebac74ddb1fbeec12dfb7540b1.
2022-10-21 11:16:00 -04:00

33 lines
924 B
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [TIX](./bitburner.tix.md) &gt; [getVolatility](./bitburner.tix.getvolatility.md)
## TIX.getVolatility() method
Returns the volatility of the specified stock.
<b>Signature:</b>
```typescript
getVolatility(sym: string): number;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| sym | string | Stock symbol. |
<b>Returns:</b>
number
Volatility of the specified stock.
## Remarks
RAM cost: 2.5 GB 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.