Files
bitburner-src/markdown/bitburner.tix.buyshort.md
Michael Taylor dcd2f33f7c CODEBASE: Update api-documentor and api-extractor (#2320)
* Update api-documentor and api-extractor. #1566 follow-up.

I have verified that the HTML/markdown table generation bug in
[#4878](https://github.com/microsoft/rushstack/issues/4878) in rushstack
for api-documentor has been fixed as per rushstack#5256. The testcase
[repro](https://github.com/catloversg/api-documenter-bug-pr-4578) now
produces the correct expected output.

I have confirmed that the generated output in bitburner from
`npm run doc` now generated HTML tables, and correctly inserts
a blank line between the </table> and the follow line (e.g. Returns).

Stylisticly it could use some whitespace, but it is correctly rendered.

This commit is only the updated packages, not the updated generated
documentation. I assume that is automatically generated by the GitHub
workflow.

* Follow up to 5f732a6f35, include `npm run doc` changed docs.

* Add missing license info

* Fix React warning

---------

Co-authored-by: CatLover <152669316+catloversg@users.noreply.github.com>
2025-09-26 14:52:39 -07:00

1.3 KiB

Home > bitburner > TIX > buyShort

TIX.buyShort() method

Short stocks.

Signature:

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

Parameters

Parameter

Type

Description

sym

string

Stock symbol.

shares

number

Number of shares to short. Must be positive. Will be rounded to the 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 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.