Personal_mirrors/bitburner-src
1
0
Fork 0
mirror of https://github.com/bitburner-official/bitburner-src.git synced 2024-12-30 01:47:33 +01:00
Code Issues Packages Projects Releases Wiki Activity
f5f5879fc3
bitburner-src/markdown/bitburner.tix.getforecast.md
Olivier Gagnon 2b79871c02 doc
2021-11-03 00:27:21 -04:00

1.1 KiB
Raw Blame History

Home > bitburner > TIX > getForecast

TIX.getForecast() method

Returns the probability that the specified stock’s price will increase (as opposed to decrease) during the next tick.

Signature:

getForecast(sym: string): number;

Parameters

Parameter Type Description
sym string Stock symbol.

Returns:

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.