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

40 lines
1.3 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!-- 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; [sellStock](./bitburner.tix.sellstock.md)
## TIX.sellStock() method
Sell stocks.
**Signature:**
```typescript
sellStock(sym: string, shares: number): number;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| sym | string | Stock symbol. |
| shares | number | Number of shares to sell. Must be positive. Will be rounded to nearest integer. |
**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 shares of a stock using a Market Order.
If the specified number of shares in the function 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.
The net profit made from selling stocks with this function is reflected in the scripts statistics. This net profit is calculated as:
shares \* (sell\_price - average\_price\_of\_purchased\_shares)
If the sale is successful, this function will return the stock price at which each share was sold. Otherwise, it will return 0.