mirror of
https://github.com/bitburner-official/bitburner-src.git
synced 2024-12-23 14:42:28 +01:00
35 lines
1.2 KiB
Markdown
35 lines
1.2 KiB
Markdown
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||
|
||
[Home](./index.md) > [bitburner](./bitburner.md) > [TIX](./bitburner.tix.md) > [getForecast](./bitburner.tix.getforecast.md)
|
||
|
||
## TIX.getForecast() method
|
||
|
||
Returns the probability that the specified stock’s price will increase (as opposed to decrease) during the next tick.
|
||
|
||
<b>Signature:</b>
|
||
|
||
```typescript
|
||
getForecast(sym: StockSymbol): number;
|
||
```
|
||
|
||
## Parameters
|
||
|
||
| Parameter | Type | Description |
|
||
| --- | --- | --- |
|
||
| sym | [StockSymbol](./bitburner.stocksymbol.md) | Stock symbol. |
|
||
|
||
<b>Returns:</b>
|
||
|
||
number
|
||
|
||
Probability that the specified stock’s price will increase (as opposed to decrease) during the next tick.
|
||
|
||
## Remarks
|
||
|
||
RAM cost: 2.5 GB The probability is returned as a decimal value, NOT a percentage (e.g. if a stock has a 60% chance of increasing, then this function will return 0.6, NOT 60).
|
||
|
||
In other words, if this function returned 0.30 for a stock, then this means that the stock’s price has a 30% chance of increasing and a 70% chance of decreasing during the next tick.
|
||
|
||
In order to use this function, you must first purchase access to the Four Sigma (4S) Market Data TIX API.
|
||
|