mirror of
https://github.com/bitburner-official/bitburner-src.git
synced 2026-04-16 06:18:42 +02:00
85 lines
1.4 KiB
Markdown
85 lines
1.4 KiB
Markdown
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
|
|
[Home](./index.md) > [bitburner](./bitburner.md) > [Stock](./bitburner.stock.md) > [sellShort](./bitburner.stock.sellshort.md)
|
|
|
|
## Stock.sellShort() method
|
|
|
|
Sell short stock.
|
|
|
|
**Signature:**
|
|
|
|
```typescript
|
|
sellShort(sym: string, shares: number): number;
|
|
```
|
|
|
|
## Parameters
|
|
|
|
<table><thead><tr><th>
|
|
|
|
Parameter
|
|
|
|
|
|
</th><th>
|
|
|
|
Type
|
|
|
|
|
|
</th><th>
|
|
|
|
Description
|
|
|
|
|
|
</th></tr></thead>
|
|
<tbody><tr><td>
|
|
|
|
sym
|
|
|
|
|
|
</td><td>
|
|
|
|
string
|
|
|
|
|
|
</td><td>
|
|
|
|
Stock symbol.
|
|
|
|
|
|
</td></tr>
|
|
<tr><td>
|
|
|
|
shares
|
|
|
|
|
|
</td><td>
|
|
|
|
number
|
|
|
|
|
|
</td><td>
|
|
|
|
Number of shares to sell. Must be positive. Will be rounded to the nearest integer.
|
|
|
|
|
|
</td></tr>
|
|
</tbody></table>
|
|
|
|
**Returns:**
|
|
|
|
number
|
|
|
|
The stock price at which each share was sold, otherwise 0 if the shares weren't sold.
|
|
|
|
## Remarks
|
|
|
|
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.
|
|
|