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

1.3 KiB
Raw Blame History

Home > bitburner > TIX > sellStock

TIX.sellStock() method

Sell stocks.

Signature:

sellStock(sym: string, shares: number): number;

Parameters

Parameter Type Description
sym string Stock symbol.
shares number Number of shares to sell. Must be positive. Will be rounded to nearest integer.

Returns:

number

The stock price at which each share was sold, otherwise 0 if the shares weren't sold.

Remarks

RAM cost: 2.5 GB Attempts to sell shares of a stock using a Market Order.

If the specified number of shares in the function exceeds the amount that the player actually owns, then this function will sell all owned shares. Remember that every transaction on the stock exchange costs a certain commission fee.

The net profit made from selling stocks with this function is reflected in the scripts statistics. This net profit is calculated as:

shares * (sell_price - average_price_of_purchased_shares)

If the sale is successful, this function will return the stock price at which each share was sold. Otherwise, it will return 0.