bitburner-src/markdown/bitburner.tix.getprice.md
Olivier Gagnon 43fc5dfd48 work on doc
2021-10-30 12:34:14 -04:00

40 lines
751 B
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; [getPrice](./bitburner.tix.getprice.md)
## TIX.getPrice() method
Returns the price of a stock, given its symbol (NOT the company name). The symbol is a sequence of two to four capital letters.
The stocks price is the average of its bid and ask price
<b>Signature:</b>
```typescript
getPrice(sym: StockSymbol): number;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| sym | [StockSymbol](./bitburner.stocksymbol.md) | Stock symbol. |
<b>Returns:</b>
number
The price of a stock.
## Remarks
2 GB
## Example
```js
getPrice("FISG");
```