bitburner-src/markdown/bitburner.tix.short.md
Olivier Gagnon feb0430aff work on doc
2021-10-30 15:46:34 -04:00

1.2 KiB

Home > bitburner > TIX > short

TIX.short() method

Attempts to purchase 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 player does not have enough money to purchase the specified number of shares, then no shares will be purchased. Remember that every transaction on the stock exchange costs a certain commission fee.

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

Signature:

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

Parameters

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

Returns:

number

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

Remarks

RAM cost: 2.5 GB