mirror of
https://github.com/bitburner-official/bitburner-src.git
synced 2026-04-17 14:59:16 +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) > [buyShort](./bitburner.stock.buyshort.md)
|
|
|
|
## Stock.buyShort() method
|
|
|
|
Short stocks.
|
|
|
|
**Signature:**
|
|
|
|
```typescript
|
|
buyShort(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 short. Must be positive. Will be rounded to the nearest integer.
|
|
|
|
|
|
</td></tr>
|
|
</tbody></table>
|
|
|
|
**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.
|
|
|