bitburner-src/markdown/bitburner.tix.buyshort.md

38 lines
1.2 KiB
Markdown
Raw Normal View History

<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [TIX](./bitburner.tix.md) &gt; [buyShort](./bitburner.tix.buyshort.md)
## TIX.buyShort() method
Short stocks.
**Signature:**
```typescript
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.