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

1.2 KiB

Home > bitburner > TIX > sellShort

TIX.sellShort() method

Attempts to sell a short position of a stock using a Market Order.

The ability to short a stock is **not** immediately available to the player and must be unlocked later on in the game.

If the specified number of shares 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.

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

Signature:

sellShort(sym: StockSymbol, shares: number): number;

Parameters

Parameter Type Description
sym StockSymbol 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

2.5 GB