Files
metrics/source/plugins/stock/README.md
2021-03-21 17:52:05 +01:00

34 lines
1.1 KiB
Markdown
Raw Blame History

This file contains invisible Unicode characters
This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
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.
### 💹 Stock prices
The *stock* plugin lets you display the stock market price of a given company.
<table>
<td align="center">
<img src="https://github.com/lowlighter/lowlighter/blob/master/metrics.plugin.stock.svg">
<img width="900" height="1" alt="">
</td>
</table>
<details>
<summary>💬 Obtaining a RapidAPI Yahoo Finance token</summary>
Create a [RapidAPI account](https://rapidapi.com) and subscribe to [Yahoo Finance API](https://rapidapi.com/apidojo/api/yahoo-finance1) to get a token.
![RapidAPI token](/.github/readme/imgs/plugin_stock_token.png)
</details>
#### Examples workflows
[➡️ Available options for this plugin](metadata.yml)
```yaml
- uses: lowlighter/metrics@latest
with:
# ... other options
plugin_stock: yes
plugin_stock_token: ${{ secrets.STOCK_TOKEN }} # RapidAPI Yahoo Finance token
plugin_stock_symbol: TSLA # Display Tesla stock price
plugin_stock_duration: 1d # Display last day of market
plugin_stock_interval: 5m # Use precision of 5 minutes for each record
```