bitburner-src/markdown/bitburner.tix.getprice.md
omuretsu 06a985bdf8 Revert "Remove markdown from git tracking (#139)"
This reverts commit bbb6e3f309935aebac74ddb1fbeec12dfb7540b1.
2022-10-21 11:16:00 -04:00

65 lines
1.2 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; [getPrice](./bitburner.tix.getprice.md)
## TIX.getPrice() method
Returns the price of a stock.
<b>Signature:</b>
```typescript
getPrice(sym: string): number;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| sym | string | Stock symbol. |
<b>Returns:</b>
number
The price of a stock.
## Remarks
RAM cost: 2 GB
The stocks price is the average of its bid and ask prices. This function requires that you have the following:
1. WSE Account
1. TIX API Access
## Example 1
```ts
// NS1
stock.getPrice("FSIG");
// Choose the first stock symbol from the array of stock symbols. Get the price
// of the corresponding stock.
var sym = stock.getSymbols()[0];
tprint("Stock symbol: " + sym);
tprint("Stock price: " + stock.getPrice(sym));
```
## Example 2
```ts
// NS2
ns.stock.getPrice("FSIG");
// Choose the first stock symbol from the array of stock symbols. Get the price
// of the corresponding stock.
const sym = ns.stock.getSymbols()[0];
ns.tprint("Stock symbol: " + sym);
ns.tprint("Stock price: " + ns.stock.getPrice(sym));
```