doc(plugins/stock): update
This commit is contained in:
@@ -1,24 +1,28 @@
|
|||||||
### 💹 Stock prices
|
<!--header-->
|
||||||
|
|
||||||
The *stock* plugin lets you display the stock market price of a given company.
|
|
||||||
|
|
||||||
<table>
|
<table>
|
||||||
<td align="center">
|
<tr><th colspan="2"><h3>💹 Stock prices</h3></th></tr>
|
||||||
<img src="https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.stock.svg">
|
<tr><td colspan="2" align="center"><p>This plugin displays the stock market price of a given company.</p>
|
||||||
|
</td></tr>
|
||||||
|
<tr>
|
||||||
|
<th rowspan="3">Supported features<br><sub><a href="metadata.yml">→ Full specification</a></sub></th>
|
||||||
|
<td><a href="/source/templates/classic"><code>📗 Classic template</code></a> <a href="/source/templates/repository"><code>📘 Repository template</code></a></td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td><code>👤 Users</code> <code>👥 Organizations</code> <code>📓 Repositories</code></td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td><code>🗝️ plugin_stock_token</code></td>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<td colspan="2" align="center">
|
||||||
|
<img src="https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.stock.svg" alt=""></img>
|
||||||
<img width="900" height="1" alt="">
|
<img width="900" height="1" alt="">
|
||||||
</td>
|
</td>
|
||||||
|
</tr>
|
||||||
</table>
|
</table>
|
||||||
|
<!--/header-->
|
||||||
|
|
||||||
<details>
|
## ➡️ Available options
|
||||||
<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.
|
|
||||||
|
|
||||||

|
|
||||||
|
|
||||||
</details>
|
|
||||||
|
|
||||||
#### ➡️ Available options
|
|
||||||
|
|
||||||
<!--options-->
|
<!--options-->
|
||||||
<table>
|
<table>
|
||||||
@@ -27,7 +31,7 @@ Create a [RapidAPI account](https://rapidapi.com) and subscribe to [Yahoo Financ
|
|||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td nowrap="nowrap"><code>plugin_stock</code></td>
|
<td nowrap="nowrap"><code>plugin_stock</code></td>
|
||||||
<td rowspan="2"><p>Display stock prices of a given company</p>
|
<td rowspan="2"><p>Enable stock plugin</p>
|
||||||
<img width="900" height="1" alt=""></td>
|
<img width="900" height="1" alt=""></td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
@@ -56,7 +60,20 @@ Create a [RapidAPI account](https://rapidapi.com) and subscribe to [Yahoo Financ
|
|||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td nowrap="nowrap"><code>plugin_stock_duration</code></td>
|
<td nowrap="nowrap"><code>plugin_stock_duration</code></td>
|
||||||
<td rowspan="2"><p>Time range to display</p>
|
<td rowspan="2"><p>Time window (relative to current date)</p>
|
||||||
|
<ul>
|
||||||
|
<li><code>1d</code>: Today</li>
|
||||||
|
<li><code>5d</code>: 5 days</li>
|
||||||
|
<li><code>1mo</code>: 1 month</li>
|
||||||
|
<li><code>3mo</code>: 3 months</li>
|
||||||
|
<li><code>6mo</code>: 6 months</li>
|
||||||
|
<li><code>1y</code>: 1 year</li>
|
||||||
|
<li><code>2y</code>: 2 years</li>
|
||||||
|
<li><code>5y</code>: 5 years</li>
|
||||||
|
<li><code>10y</code>: 10 years</li>
|
||||||
|
<li><code>ytd</code>: Year to date</li>
|
||||||
|
<li><code>max</code>: All time</li>
|
||||||
|
</ul>
|
||||||
<img width="900" height="1" alt=""></td>
|
<img width="900" height="1" alt=""></td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
@@ -67,7 +84,15 @@ Create a [RapidAPI account](https://rapidapi.com) and subscribe to [Yahoo Financ
|
|||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<td nowrap="nowrap"><code>plugin_stock_interval</code></td>
|
<td nowrap="nowrap"><code>plugin_stock_interval</code></td>
|
||||||
<td rowspan="2"><p>Time intervals between records</p>
|
<td rowspan="2"><p>Time interval between points</p>
|
||||||
|
<ul>
|
||||||
|
<li><code>1m</code>: 1 minute</li>
|
||||||
|
<li><code>2m</code>: 2 minutes</li>
|
||||||
|
<li><code>5m</code>: 5 minutes</li>
|
||||||
|
<li><code>15m</code>: 15 minutes</li>
|
||||||
|
<li><code>60m</code>: 60 minutes</li>
|
||||||
|
<li><code>1d</code>: 1 day</li>
|
||||||
|
</ul>
|
||||||
<img width="900" height="1" alt=""></td>
|
<img width="900" height="1" alt=""></td>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
@@ -79,9 +104,13 @@ Create a [RapidAPI account](https://rapidapi.com) and subscribe to [Yahoo Financ
|
|||||||
</table>
|
</table>
|
||||||
<!--/options-->
|
<!--/options-->
|
||||||
|
|
||||||
*[→ Full specification](metadata.yml)*
|
## 🗝️ Obtaining a RapidAPI Yahoo Finance token
|
||||||
|
|
||||||
#### ℹ️ Examples workflows
|
Create a [RapidAPI account](https://rapidapi.com) and subscribe to [Yahoo Finance API](https://rapidapi.com/apidojo/api/yahoo-finance1) to get a token.
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
## ℹ️ Examples workflows
|
||||||
|
|
||||||
<!--examples-->
|
<!--examples-->
|
||||||
```yaml
|
```yaml
|
||||||
|
|||||||
@@ -1,5 +1,8 @@
|
|||||||
name: "💹 Stock prices"
|
name: "💹 Stock prices"
|
||||||
category: social
|
category: social
|
||||||
|
description: This plugin displays the stock market price of a given company.
|
||||||
|
examples:
|
||||||
|
default: https://github.com/lowlighter/metrics/blob/examples/metrics.plugin.stock.svg
|
||||||
index: 8
|
index: 8
|
||||||
supports:
|
supports:
|
||||||
- user
|
- user
|
||||||
@@ -8,53 +11,66 @@ supports:
|
|||||||
scopes: []
|
scopes: []
|
||||||
inputs:
|
inputs:
|
||||||
|
|
||||||
# Enable or disable plugin
|
|
||||||
plugin_stock:
|
plugin_stock:
|
||||||
description: Display stock prices of a given company
|
description: Enable stock plugin
|
||||||
type: boolean
|
type: boolean
|
||||||
default: no
|
default: no
|
||||||
|
|
||||||
# RapidAPI Yahoo finance token
|
|
||||||
# Case insensitive
|
|
||||||
plugin_stock_token:
|
plugin_stock_token:
|
||||||
description: Yahoo Finance token
|
description: Yahoo Finance token
|
||||||
type: token
|
type: token
|
||||||
default: ""
|
default: ""
|
||||||
|
|
||||||
# Company stock symbol (required)
|
|
||||||
plugin_stock_symbol:
|
plugin_stock_symbol:
|
||||||
description: Company stock symbol
|
description: Company stock symbol
|
||||||
type: string
|
type: string
|
||||||
default: ""
|
default: ""
|
||||||
example: MSFT
|
example: MSFT
|
||||||
|
|
||||||
# Time range to display (relative to current date)
|
|
||||||
plugin_stock_duration:
|
plugin_stock_duration:
|
||||||
description: Time range to display
|
description: |
|
||||||
|
Time window (relative to current date)
|
||||||
|
- `1d`: Today
|
||||||
|
- `5d`: 5 days
|
||||||
|
- `1mo`: 1 month
|
||||||
|
- `3mo`: 3 months
|
||||||
|
- `6mo`: 6 months
|
||||||
|
- `1y`: 1 year
|
||||||
|
- `2y`: 2 years
|
||||||
|
- `5y`: 5 years
|
||||||
|
- `10y`: 10 years
|
||||||
|
- `ytd`: Year to date
|
||||||
|
- `max`: All time
|
||||||
type: string
|
type: string
|
||||||
default: 1d
|
default: 1d
|
||||||
values:
|
values:
|
||||||
- 1d # Today
|
- 1d
|
||||||
- 5d # 5 days
|
- 5d
|
||||||
- 1mo # 1 month
|
- 1mo
|
||||||
- 3mo # 3 months
|
- 3mo
|
||||||
- 6mo # 6 months
|
- 6mo
|
||||||
- 1y # 1 year
|
- 1y
|
||||||
- 2y # 2 years
|
- 2y
|
||||||
- 5y # 5 years
|
- 5y
|
||||||
- 10y # 10 years
|
- 10y
|
||||||
- ytd # Year to date
|
- ytd
|
||||||
- max # All time
|
- max
|
||||||
|
|
||||||
# Time invervals between each records over the given time range
|
|
||||||
plugin_stock_interval:
|
plugin_stock_interval:
|
||||||
description: Time intervals between records
|
description: |
|
||||||
|
Time interval between points
|
||||||
|
- `1m`: 1 minute
|
||||||
|
- `2m`: 2 minutes
|
||||||
|
- `5m`: 5 minutes
|
||||||
|
- `15m`: 15 minutes
|
||||||
|
- `60m`: 60 minutes
|
||||||
|
- `1d`: 1 day
|
||||||
type: string
|
type: string
|
||||||
default: 5m
|
default: 5m
|
||||||
values:
|
values:
|
||||||
- 1m # 1 minute
|
- 1m
|
||||||
- 2m # 2 minutes
|
- 2m
|
||||||
- 5m # 5 minutes
|
- 5m
|
||||||
- 15m # 15 minutes
|
- 15m
|
||||||
- 60m # 60 minutes
|
- 60m
|
||||||
- 1d # 1 day
|
- 1d
|
||||||
|
|||||||
Reference in New Issue
Block a user