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

38 lines
1.2 KiB
Markdown
Raw Normal View History

2021-10-30 18:34:14 +02:00
<!-- 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; [sellShort](./bitburner.tix.sellshort.md)
## TIX.sellShort() method
2021-10-30 22:03:34 +02:00
Sell short stock.
2021-10-30 18:34:14 +02:00
<b>Signature:</b>
```typescript
2021-11-03 05:27:21 +01:00
sellShort(sym: string, shares: number): number;
2021-10-30 18:34:14 +02:00
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
2021-11-03 05:27:21 +01:00
| sym | string | Stock symbol. |
2021-10-30 18:34:14 +02:00
| shares | number | Number of shares to sell. Must be positive. Will be rounded to nearest integer. |
<b>Returns:</b>
number
The stock price at which each share was sold, otherwise 0 if the shares weren't sold.
## Remarks
2021-10-30 22:03:34 +02:00
RAM cost: 2.5 GB 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.
2021-10-30 18:34:14 +02:00