bitburner-src/markdown/bitburner.tix.getsalegain.md
Olivier Gagnon 43fc5dfd48 work on doc
2021-10-30 12:34:14 -04:00

975 B

Home > bitburner > TIX > getSaleGain

TIX.getSaleGain() method

Calculates and returns how much you would gain from selling a given number of shares of a stock. This takes into account spread, large transactions influencing the price of the stock and commission fees.

Signature:

getSaleGain(sym: StockSymbol, shares: number, posType: OrderPos): number;

Parameters

Parameter Type Description
sym StockSymbol Stock symbol.
shares number Number of shares to sell.
posType OrderPos Specifies whether the order is a “Long” or “Short” position.

Returns:

number

Gain from selling a given number of shares of a stock.

Remarks

2 GB