bitburner-src/markdown/bitburner.tix.getforecast.md

35 lines
1.2 KiB
Markdown
Raw Normal View History

2021-10-30 18:34:14 +02:00
<!-- 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; [getForecast](./bitburner.tix.getforecast.md)
## TIX.getForecast() method
Returns the probability that the specified stocks 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 stocks price will increase (as opposed to decrease) during the next tick.
## Remarks
2021-10-30 22:03:34 +02:00
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 stocks 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.
2021-10-30 18:34:14 +02:00