diff --git a/website/content/bot/reference/discord/alerts/create.md b/website/content/bot/reference/discord/alerts/create.md index ac7d95006934..9c5f13ba39ee 100644 --- a/website/content/bot/reference/discord/alerts/create.md +++ b/website/content/bot/reference/discord/alerts/create.md @@ -1,40 +1,40 @@ ---- -########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### -title: create -description: OpenBB Discord Command ---- - -# create - -Create an alert with conditions for a symbol - -### Usage - -```python wordwrap -/alerts create ticker condition price -``` - ---- - -## Parameters - -| Name | Description | Optional | Choices | -| ---- | ----------- | -------- | ------- | -| ticker | Ticker to set alert for | False | None | -| condition | Condition to set alert for | False | Equal or Above, Equal or Below | -| price | Price to set alert for | False | None | - - ---- - -## Examples - -``` -/alerts create ticker:BTCUSD condition:Equal or Above price:1000 -``` - -``` -/alerts create ticker:SPY condition:Equal or Below price:400 -``` - ---- +--- +########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### +title: create +description: OpenBB Discord Command +--- + +# create + +This command creates an alert for a given symbol (ex. BTCUSD) that will notify the user when the price is equal to or above the user defined price. + +### Usage + +```python wordwrap +/alerts create ticker condition price +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| ticker | Ticker to set alert for | False | None | +| condition | Condition to set alert for | False | Equal or Above, Equal or Below | +| price | Price to set alert for | False | None | + + +--- + +## Examples + +``` +/alerts create ticker:BTCUSD condition:Equal or Above price:1000 +``` + +``` +/alerts create ticker:SPY condition:Equal or Below price:400 +``` + +--- diff --git a/website/content/bot/reference/discord/alerts/delete.md b/website/content/bot/reference/discord/alerts/delete.md index 0410a1daa06e..e02a786bf609 100644 --- a/website/content/bot/reference/discord/alerts/delete.md +++ b/website/content/bot/reference/discord/alerts/delete.md @@ -1,34 +1,34 @@ ---- -########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### -title: delete -description: OpenBB Discord Command ---- - -# delete - -Delete an active alert you have set - -### Usage - -```python wordwrap -/alerts delete alert -``` - ---- - -## Parameters - -| Name | Description | Optional | Choices | -| ---- | ----------- | -------- | ------- | -| alert | Alert to delete | False | None | - - ---- - -## Examples - -``` -/alerts delete alert: -``` - ---- +--- +########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### +title: delete +description: OpenBB Discord Command +--- + +# delete + +This command allows the user to delete an active alert they have set. + +### Usage + +```python wordwrap +/alerts delete alert +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| alert | Alert to delete | False | None | + + +--- + +## Examples + +``` +/alerts delete alert: +``` + +--- diff --git a/website/content/bot/reference/discord/alerts/index.mdx b/website/content/bot/reference/discord/alerts/index.mdx index 5f18116f65e7..022b3069ac95 100644 --- a/website/content/bot/reference/discord/alerts/index.mdx +++ b/website/content/bot/reference/discord/alerts/index.mdx @@ -6,22 +6,22 @@ import ReferenceCard from "@site/src/components/General/ReferenceCard"; diff --git a/website/content/bot/reference/discord/alerts/list.md b/website/content/bot/reference/discord/alerts/list.md index 5f687d07b99d..96cb2752c2fb 100644 --- a/website/content/bot/reference/discord/alerts/list.md +++ b/website/content/bot/reference/discord/alerts/list.md @@ -1,32 +1,32 @@ ---- -########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### -title: list -description: OpenBB Discord Command ---- - -# list - -List all of your active alerts - -### Usage - -```python wordwrap -/alerts list -``` - ---- - -## Parameters - -This command has no parameters - - - ---- - -## Examples - -``` -/alerts list -``` ---- +--- +########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### +title: list +description: OpenBB Discord Command +--- + +# list + +This command allows the user to view a list of all their active alerts. It displays each alert along with its symbol, description, and threshold, giving the user an overview of their active alerts at a glance. + +### Usage + +```python wordwrap +/alerts list +``` + +--- + +## Parameters + +This command has no parameters + + + +--- + +## Examples + +``` +/alerts list +``` +--- diff --git a/website/content/bot/reference/discord/alerts/update.md b/website/content/bot/reference/discord/alerts/update.md index 8783b2404dcb..f19c8e9cd2fb 100644 --- a/website/content/bot/reference/discord/alerts/update.md +++ b/website/content/bot/reference/discord/alerts/update.md @@ -1,36 +1,36 @@ ---- -########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### -title: update -description: OpenBB Discord Command ---- - -# update - -Update a condition on an active alert - -### Usage - -```python wordwrap -/alerts update alerts condition price -``` - ---- - -## Parameters - -| Name | Description | Optional | Choices | -| ---- | ----------- | -------- | ------- | -| alerts | Your active alerts | False | None | -| condition | Update condition for alert | False | Equal or Above (above or equal), Equal or Below (below or equal) | -| price | Update alert to this price | False | None | - - ---- - -## Examples - -``` -/alerts update alerts: condition: price: -``` - ---- +--- +########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### +title: update +description: OpenBB Discord Command +--- + +# update + +This command allows the user to update the condition on an active alert, such as changing the value of a price alert. The command will update the alert with the new condition and keep the alert active until it is manually deactivated or the alert's condition is met. + +### Usage + +```python wordwrap +/alerts update alerts condition price +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| alerts | Your active alerts | False | None | +| condition | Update condition for alert | False | Equal or Above (above or equal), Equal or Below (below or equal) | +| price | Update alert to this price | False | None | + + +--- + +## Examples + +``` +/alerts update alerts: condition: price: +``` + +--- diff --git a/website/content/bot/reference/discord/autopost/add.md b/website/content/bot/reference/discord/autopost/add.md index 8be9096027f9..bbcb3a75bba4 100644 --- a/website/content/bot/reference/discord/autopost/add.md +++ b/website/content/bot/reference/discord/autopost/add.md @@ -1,32 +1,32 @@ ---- -########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### -title: add -description: OpenBB Discord Command ---- - -# add - -Add an autopost webhook feed to this channel. - -### Usage - -```python wordwrap -/autopost add -``` - ---- - -## Parameters - -This command has no parameters - - - ---- - -## Examples - -``` -/autopost add -``` ---- +--- +########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### +title: add +description: OpenBB Discord Command +--- + +# add + +This command allows the user to add an autopost webhook feed to a channel. It allows the user to receive notifications from OpenBB webhooks in the channel without having to manually post them. This can be used to keep track of flow, darkpool, market heatmap and more. + +### Usage + +```python wordwrap +/autopost add +``` + +--- + +## Parameters + +This command has no parameters + + + +--- + +## Examples + +``` +/autopost add +``` +--- diff --git a/website/content/bot/reference/discord/autopost/index.mdx b/website/content/bot/reference/discord/autopost/index.mdx index 557c2780b80d..91fc999e128f 100644 --- a/website/content/bot/reference/discord/autopost/index.mdx +++ b/website/content/bot/reference/discord/autopost/index.mdx @@ -6,17 +6,17 @@ import ReferenceCard from "@site/src/components/General/ReferenceCard"; diff --git a/website/content/bot/reference/discord/autopost/list.md b/website/content/bot/reference/discord/autopost/list.md index bd3345c6b4d9..1c4d55edb7de 100644 --- a/website/content/bot/reference/discord/autopost/list.md +++ b/website/content/bot/reference/discord/autopost/list.md @@ -1,32 +1,32 @@ ---- -########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### -title: list -description: OpenBB Discord Command ---- - -# list - -List all autopost webhook feeds in this channel. - -### Usage - -```python wordwrap -/autopost list -``` - ---- - -## Parameters - -This command has no parameters - - - ---- - -## Examples - -``` -/autopost list -``` ---- +--- +########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### +title: list +description: OpenBB Discord Command +--- + +# list + +This command allows users to view all webhook feeds associated with a particular channel that have been set up for automatic posting. It produces a list of all webhooks that have been configured to post content to the channel automatically, as well as information such as when they are scheduled. + +### Usage + +```python wordwrap +/autopost list +``` + +--- + +## Parameters + +This command has no parameters + + + +--- + +## Examples + +``` +/autopost list +``` +--- diff --git a/website/content/bot/reference/discord/autopost/remove.md b/website/content/bot/reference/discord/autopost/remove.md index 0064e75732bf..bccdc79482d7 100644 --- a/website/content/bot/reference/discord/autopost/remove.md +++ b/website/content/bot/reference/discord/autopost/remove.md @@ -1,32 +1,32 @@ ---- -########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### -title: remove -description: OpenBB Discord Command ---- - -# remove - -Remove an autopost webhook feed from this channel. - -### Usage - -```python wordwrap -/autopost remove -``` - ---- - -## Parameters - -This command has no parameters - - - ---- - -## Examples - -``` -/autopost remove -``` ---- +--- +########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### +title: remove +description: OpenBB Discord Command +--- + +# remove + +This command allows the user to remove an autopost webhook feed from the channel. When executed, it will remove the feed from the channel and prevent any further autoposts from being sent. + +### Usage + +```python wordwrap +/autopost remove +``` + +--- + +## Parameters + +This command has no parameters + + + +--- + +## Examples + +``` +/autopost remove +``` +--- diff --git a/website/content/bot/reference/discord/charts/c15m.md b/website/content/bot/reference/discord/charts/c15m.md index 6bd393dbaa1d..a2a30508fadd 100644 --- a/website/content/bot/reference/discord/charts/c15m.md +++ b/website/content/bot/reference/discord/charts/c15m.md @@ -1,34 +1,34 @@ ---- -########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### -title: c15m -description: OpenBB Discord Command ---- - -# c15m - -Shows an intraday 15m chart for the ticker provided. - -### Usage - -```python wordwrap -/c15m ticker -``` - ---- - -## Parameters - -| Name | Description | Optional | Choices | -| ---- | ----------- | -------- | ------- | -| ticker | Stock Ticker | False | None | - - ---- - -## Examples - -``` -/c15m ticker:AMD -``` - ---- +--- +########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### +title: c15m +description: OpenBB Discord Command +--- + +# c15m + +This command allows the user to retrieve a 15-minute intraday chart for a given ticker. The chart will show the price and volume of the stock over the past 3 days in 15 minute intervals. This command is useful for performing technical analysis and tracking short-term price movements. + +### Usage + +```python wordwrap +/c15m ticker +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| ticker | Stock Ticker | False | None | + + +--- + +## Examples + +``` +/c15m ticker:AMD +``` + +--- diff --git a/website/content/bot/reference/discord/charts/c3m.md b/website/content/bot/reference/discord/charts/c3m.md index a747467da091..253d03889ccc 100644 --- a/website/content/bot/reference/discord/charts/c3m.md +++ b/website/content/bot/reference/discord/charts/c3m.md @@ -1,35 +1,35 @@ ---- -########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### -title: c3m -description: OpenBB Discord Command ---- - -# c3m - -Shows an intraday 3m chart for the ticker provided. - -### Usage - -```python wordwrap -/c3m ticker [extended_hours] -``` - ---- - -## Parameters - -| Name | Description | Optional | Choices | -| ---- | ----------- | -------- | ------- | -| ticker | Stock Ticker | False | None | -| extended_hours | Show Full 4am-8pm ET Trading Hours. Default: False | True | None | - - ---- - -## Examples - -``` -/c3m ticker:AMD -``` - ---- +--- +########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### +title: c3m +description: OpenBB Discord Command +--- + +# c3m + +This command allows users to retrieve a 3-minute intraday chart for the given ticker. This chart will display the candlestick chart for the day. It will provide a visual representation of the stock's performance over the current day, making it helpful for short-term investors. + +### Usage + +```python wordwrap +/c3m ticker [extended_hours] +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| ticker | Stock Ticker | False | None | +| extended_hours | Show Full 4am-8pm ET Trading Hours. Default: False | True | None | + + +--- + +## Examples + +``` +/c3m ticker:AMD +``` + +--- diff --git a/website/content/bot/reference/discord/charts/c5m.md b/website/content/bot/reference/discord/charts/c5m.md index 474ab82957fe..915ae1cb3c7a 100644 --- a/website/content/bot/reference/discord/charts/c5m.md +++ b/website/content/bot/reference/discord/charts/c5m.md @@ -1,35 +1,35 @@ ---- -########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### -title: c5m -description: OpenBB Discord Command ---- - -# c5m - -Shows an intraday 5m chart for the ticker provided - /cc also works - -### Usage - -```python wordwrap -/c5m ticker [extended_hours] -``` - ---- - -## Parameters - -| Name | Description | Optional | Choices | -| ---- | ----------- | -------- | ------- | -| ticker | Stock Ticker | False | None | -| extended_hours | Show Full 4am-8pm ET Trading Hours. Default: False | True | None | - - ---- - -## Examples - -``` -/c5m ticker:AMD -``` - ---- +--- +########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### +title: c5m +description: OpenBB Discord Command +--- + +# c5m + +This command allows the user to retrieve an intraday 5 minute chart for a given ticker. This chart will display the candlestick chart for the day. It will provide a visual representation of the stock's performance over the current day. This command is useful for performing technical analysis and tracking short-term price movements. + +### Usage + +```python wordwrap +/c5m ticker [extended_hours] +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| ticker | Stock Ticker | False | None | +| extended_hours | Show Full 4am-8pm ET Trading Hours. Default: False | True | None | + + +--- + +## Examples + +``` +/c5m ticker:AMD +``` + +--- diff --git a/website/content/bot/reference/discord/charts/cc.md b/website/content/bot/reference/discord/charts/cc.md index b06385eaa035..cbfd12fb379f 100644 --- a/website/content/bot/reference/discord/charts/cc.md +++ b/website/content/bot/reference/discord/charts/cc.md @@ -1,35 +1,35 @@ ---- -########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### -title: cc -description: OpenBB Discord Command ---- - -# cc - -Shows an intraday 5m chart for the ticker provided - /c5m also works - -### Usage - -```python wordwrap -/cc ticker [extended_hours] -``` - ---- - -## Parameters - -| Name | Description | Optional | Choices | -| ---- | ----------- | -------- | ------- | -| ticker | Stock Ticker | False | None | -| extended_hours | Show Full 4am-8pm ET Trading Hours. Default: False | True | None | - - ---- - -## Examples - -``` -/cc ticker:AMD -``` - ---- +--- +########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### +title: cc +description: OpenBB Discord Command +--- + +# cc + +This command allows the user to retrieve an intraday 5 minute chart for a given ticker, /c5m also has the same effect. This chart will display the candlestick chart for the day. It will provide a visual representation of the stock's performance over the current day. This command is useful for performing technical analysis and tracking short-term price movements. + +### Usage + +```python wordwrap +/cc ticker [extended_hours] +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| ticker | Stock Ticker | False | None | +| extended_hours | Show Full 4am-8pm ET Trading Hours. Default: False | True | None | + + +--- + +## Examples + +``` +/cc ticker:AMD +``` + +--- diff --git a/website/content/bot/reference/discord/charts/cd.md b/website/content/bot/reference/discord/charts/cd.md index 5366e53d9ee3..0d27659f6be3 100644 --- a/website/content/bot/reference/discord/charts/cd.md +++ b/website/content/bot/reference/discord/charts/cd.md @@ -1,34 +1,34 @@ ---- -########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### -title: cd -description: OpenBB Discord Command ---- - -# cd - -Shows a daily candlestick chart for the ticker/coin provided. - -### Usage - -```python wordwrap -/cd ticker -``` - ---- - -## Parameters - -| Name | Description | Optional | Choices | -| ---- | ----------- | -------- | ------- | -| ticker | Stock Ticker | False | None | - - ---- - -## Examples - -``` -/cd ticker:AMD -``` - ---- +--- +########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### +title: cd +description: OpenBB Discord Command +--- + +# cd + +This command allows the user to retrieve a daily candlestick chart for a particular ticker or coin. The candlestick chart provides information about the opening and closing prices of the day, as well as the high and low prices of the day. This data can then be used to analyze the performance of the ticker/coin over time. For example, if the user provides the command "/cd ticker:AMD", the chart will be generated for the ticker AMD. + +### Usage + +```python wordwrap +/cd ticker +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| ticker | Stock Ticker | False | None | + + +--- + +## Examples + +``` +/cd ticker:AMD +``` + +--- diff --git a/website/content/bot/reference/discord/charts/chart.md b/website/content/bot/reference/discord/charts/chart.md index bd5a1d21d4cd..4262e64ff412 100644 --- a/website/content/bot/reference/discord/charts/chart.md +++ b/website/content/bot/reference/discord/charts/chart.md @@ -1,41 +1,41 @@ ---- -########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### -title: chart -description: OpenBB Discord Command ---- - -# chart - -Shows the candlestick chart for the ticker/interval provided - -### Usage - -```python wordwrap -/chart ticker interval [past_days] [extended_hours] -``` - ---- - -## Parameters - -| Name | Description | Optional | Choices | -| ---- | ----------- | -------- | ------- | -| ticker | Stock Ticker | False | None | -| interval | Chart Interval | False | Daily (1440), Weekly (7200), Monthly (28800), 1 minute (1), 5 minute (5), 10 minute (10), 15 minute (15), 30 minute (30), 1 hour (60) | -| past_days | Past Days to Display. Default: 0 | True | None | -| extended_hours | Display Full 4am-8pm ET Trading Hours. Default: False | True | None | - - ---- - -## Examples - -``` -/chart ticker:AMD interval:5 minute past_days:0 -``` - -``` -/chart ticker:AMD interval:Daily -``` - ---- +--- +########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### +title: chart +description: OpenBB Discord Command +--- + +# chart + +This command will retrieve a candlestick chart for the ticker/interval provided, with data for the past number of days specified. The interval provided must be a valid time interval (e.g. 5 minute, 15 minute, etc.). The chart will be displayed to the user and will contain information such as the opening and closing prices, the high and low, the volume, and any other relevant information. + +### Usage + +```python wordwrap +/chart ticker interval [past_days] [extended_hours] +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| ticker | Stock Ticker | False | None | +| interval | Chart Interval | False | Daily (1440), Weekly (7200), Monthly (28800), 1 minute (1), 5 minute (5), 10 minute (10), 15 minute (15), 30 minute (30), 1 hour (60) | +| past_days | Past Days to Display. Default: 0 | True | None | +| extended_hours | Display Full 4am-8pm ET Trading Hours. Default: False | True | None | + + +--- + +## Examples + +``` +/chart ticker:AMD interval:5 minute past_days:0 +``` + +``` +/chart ticker:AMD interval:Daily +``` + +--- diff --git a/website/content/bot/reference/discord/charts/chartfib.md b/website/content/bot/reference/discord/charts/chartfib.md index 0899debefa89..6879aff4e9c6 100644 --- a/website/content/bot/reference/discord/charts/chartfib.md +++ b/website/content/bot/reference/discord/charts/chartfib.md @@ -1,34 +1,34 @@ ---- -########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### -title: chartfib -description: OpenBB Discord Command ---- - -# chartfib - -Displays the Fibonacci levels for the ticker provided - -### Usage - -```python wordwrap -/chartfib ticker -``` - ---- - -## Parameters - -| Name | Description | Optional | Choices | -| ---- | ----------- | -------- | ------- | -| ticker | Stock Ticker | False | None | - - ---- - -## Examples - -``` -/chartfib ticker:AMD -``` - ---- +--- +########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### +title: chartfib +description: OpenBB Discord Command +--- + +# chartfib + +This command allows the user to retrieve Fibonacci levels for a given ticker. This data can be used to identify potential support and resistance levels and can be used to identify potential entry and exit points in the stock market. + +### Usage + +```python wordwrap +/chartfib ticker +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| ticker | Stock Ticker | False | None | + + +--- + +## Examples + +``` +/chartfib ticker:AMD +``` + +--- diff --git a/website/content/bot/reference/discord/charts/chartsr.md b/website/content/bot/reference/discord/charts/chartsr.md index c65a71185ff1..a678195dfbee 100644 --- a/website/content/bot/reference/discord/charts/chartsr.md +++ b/website/content/bot/reference/discord/charts/chartsr.md @@ -1,38 +1,38 @@ ---- -########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### -title: chartsr -description: OpenBB Discord Command ---- - -# chartsr - -Displays Support and Resistance Levels for the ticker provided - -### Usage - -```python wordwrap -/chartsr ticker [interval] -``` - ---- - -## Parameters - -| Name | Description | Optional | Choices | -| ---- | ----------- | -------- | ------- | -| ticker | Stock Ticker | False | None | -| interval | Chart Interval | True | 5 minute (5), 15 minute (15) | - - ---- - -## Examples - -``` -/chartsr ticker:AMC -``` -``` -/chartsr ticker:AMC interval:5 minute -``` - ---- +--- +########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### +title: chartsr +description: OpenBB Discord Command +--- + +# chartsr + +This command allows the user to retrieve Displays Support and Resistance Levels for the ticker provided. It will display the support and resistance levels of a given ticker on the chart. These levels can help the user in making better trading decisions. + +### Usage + +```python wordwrap +/chartsr ticker [interval] +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| ticker | Stock Ticker | False | None | +| interval | Chart Interval | True | 5 minute (5), 15 minute (15) | + + +--- + +## Examples + +``` +/chartsr ticker:AMC +``` +``` +/chartsr ticker:AMC interval:5 minute +``` + +--- diff --git a/website/content/bot/reference/discord/charts/cm.md b/website/content/bot/reference/discord/charts/cm.md index 0069d8cc6944..affefc58daf4 100644 --- a/website/content/bot/reference/discord/charts/cm.md +++ b/website/content/bot/reference/discord/charts/cm.md @@ -1,34 +1,34 @@ ---- -########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### -title: cm -description: OpenBB Discord Command ---- - -# cm - -Shows a monthly candlestick chart for the ticker/coin provided. - -### Usage - -```python wordwrap -/cm ticker -``` - ---- - -## Parameters - -| Name | Description | Optional | Choices | -| ---- | ----------- | -------- | ------- | -| ticker | Stock Ticker | False | None | - - ---- - -## Examples - -``` -/cm ticker:AMD -``` - ---- +--- +########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### +title: cm +description: OpenBB Discord Command +--- + +# cm + +This command allows you to view a monthly candlestick chart for a given stock or cryptocurrency. The chart displays the open, close, high and low prices for the selected ticker/coin each month. This command is useful for analyzing the long-term performance of a stock or cryptocurrency. + +### Usage + +```python wordwrap +/cm ticker +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| ticker | Stock Ticker | False | None | + + +--- + +## Examples + +``` +/cm ticker:AMD +``` + +--- diff --git a/website/content/bot/reference/discord/charts/cw.md b/website/content/bot/reference/discord/charts/cw.md index d1159377710a..41803493a28c 100644 --- a/website/content/bot/reference/discord/charts/cw.md +++ b/website/content/bot/reference/discord/charts/cw.md @@ -1,34 +1,34 @@ ---- -########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### -title: cw -description: OpenBB Discord Command ---- - -# cw - -Shows a weekly candlestick chart for the ticker/coin provided. - -### Usage - -```python wordwrap -/cw ticker -``` - ---- - -## Parameters - -| Name | Description | Optional | Choices | -| ---- | ----------- | -------- | ------- | -| ticker | Stock Ticker | False | None | - - ---- - -## Examples - -``` -/cw ticker:AMD -``` - ---- +--- +########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### +title: cw +description: OpenBB Discord Command +--- + +# cw + +This command allows the user to retrieve a weekly candlestick chart for the ticker/coin provided. The chart displays the opening and closing prices, the high and low prices, and the trading volume for the week for the specified ticker/coin. + +### Usage + +```python wordwrap +/cw ticker +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| ticker | Stock Ticker | False | None | + + +--- + +## Examples + +``` +/cw ticker:AMD +``` + +--- diff --git a/website/content/bot/reference/discord/charts/index.mdx b/website/content/bot/reference/discord/charts/index.mdx index 2d2abc15243f..b4e0b66bcf11 100644 --- a/website/content/bot/reference/discord/charts/index.mdx +++ b/website/content/bot/reference/discord/charts/index.mdx @@ -6,52 +6,52 @@ import ReferenceCard from "@site/src/components/General/ReferenceCard"; diff --git a/website/content/bot/reference/discord/crypto/bigprints.md b/website/content/bot/reference/discord/crypto/bigprints.md index a417d768631e..b4076fd698f1 100644 --- a/website/content/bot/reference/discord/crypto/bigprints.md +++ b/website/content/bot/reference/discord/crypto/bigprints.md @@ -1,35 +1,35 @@ ---- -########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### -title: bigprints -description: OpenBB Discord Command ---- - -# bigprints - -Last 15 Large Crypto Prints. - -### Usage - -```python wordwrap -/crypto bigprints coin [days] -``` - ---- - -## Parameters - -| Name | Description | Optional | Choices | -| ---- | ----------- | -------- | ------- | -| coin | Coin from the list of supported coins | False | ADA-USD, AVAX-USD, BTC-USD, DAI-USD, DOGE-USD, DOT-USD, ETH-USD, LTC-USD, MATIC-USD, SHIB-USD, SOL-USD, TRX-USD, USDC-USD, USDT-USD, WBTC-USD, XRP-USD | -| days | Number of days to look back. Default is 10. | True | None | - - ---- - -## Examples - -``` -/crypto bigprints coin:BTC-USD -``` - ---- +--- +########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### +title: bigprints +description: OpenBB Discord Command +--- + +# bigprints + +This command allows the user to retrieve the last 15 large prints for a given cryptocurrency pair. The command uses the format "/crypto bigprints coin:BTC-USD" where BTC-USD is the currency pair for which the user wants to retrieve the large prints. This command is useful for analyzing the recent large prints of a given currency pair, which can be used to inform trading decisions. + +### Usage + +```python wordwrap +/crypto bigprints coin [days] +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| coin | Coin from the list of supported coins | False | ADA-USD, AVAX-USD, BTC-USD, DAI-USD, DOGE-USD, DOT-USD, ETH-USD, LTC-USD, MATIC-USD, SHIB-USD, SOL-USD, TRX-USD, USDC-USD, USDT-USD, WBTC-USD, XRP-USD | +| days | Number of days to look back. Default is 10. | True | None | + + +--- + +## Examples + +``` +/crypto bigprints coin:BTC-USD +``` + +--- diff --git a/website/content/bot/reference/discord/crypto/bio.md b/website/content/bot/reference/discord/crypto/bio.md index 46c9070de0bc..147fdf41b635 100644 --- a/website/content/bot/reference/discord/crypto/bio.md +++ b/website/content/bot/reference/discord/crypto/bio.md @@ -1,34 +1,34 @@ ---- -########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### -title: bio -description: OpenBB Discord Command ---- - -# bio - -Get fundamental information about a crypto - -### Usage - -```python wordwrap -/crypto bio symbol -``` - ---- - -## Parameters - -| Name | Description | Optional | Choices | -| ---- | ----------- | -------- | ------- | -| symbol | Crypto symbol to check information (e.g., BTC) | False | None | - - ---- - -## Examples - -``` -/crypto bio symbol: btc -``` - ---- +--- +########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### +title: bio +description: OpenBB Discord Command +--- + +# bio + +This command allows the user to retrieve fundamental information about a crypto, such as its current price, 24-hour trading volume, market cap, and other key metrics, by entering a specific crypto symbol (e.g. "BTC") as an argument. + +### Usage + +```python wordwrap +/crypto bio symbol +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| symbol | Crypto symbol to check information (e.g., BTC) | False | None | + + +--- + +## Examples + +``` +/crypto bio symbol: btc +``` + +--- diff --git a/website/content/bot/reference/discord/crypto/compfees.md b/website/content/bot/reference/discord/crypto/compfees.md index 8279b327765a..164b734473c9 100644 --- a/website/content/bot/reference/discord/crypto/compfees.md +++ b/website/content/bot/reference/discord/crypto/compfees.md @@ -1,38 +1,38 @@ ---- -########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### -title: compfees -description: OpenBB Discord Command ---- - -# compfees - -Get protocol fees over time - -### Usage - -```python wordwrap -/crypto compfees projects -``` - ---- - -## Parameters - -| Name | Description | Optional | Choices | -| ---- | ----------- | -------- | ------- | -| projects | Comma separated list of protocols (e.g., btc,eth) | False | None | - - ---- - -## Examples - -``` -/crypto compfees projects: doge -``` - -``` -/crypto compfees projects: btc,eth -``` - ---- +--- +########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### +title: compfees +description: OpenBB Discord Command +--- + +# compfees + +This command allows users to retrieve the Protocol fees over time for the given project. + +### Usage + +```python wordwrap +/crypto compfees projects +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| projects | Comma separated list of protocols (e.g., btc,eth) | False | None | + + +--- + +## Examples + +``` +/crypto compfees projects: doge +``` + +``` +/crypto compfees projects: btc,eth +``` + +--- diff --git a/website/content/bot/reference/discord/crypto/defi/chart.md b/website/content/bot/reference/discord/crypto/defi/chart.md index df19b39daadd..2e18bd892a22 100644 --- a/website/content/bot/reference/discord/crypto/defi/chart.md +++ b/website/content/bot/reference/discord/crypto/defi/chart.md @@ -1,35 +1,35 @@ ---- -########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### -title: chart -description: OpenBB Discord Command ---- - -# chart - -Charts top DeFi protocols - -### Usage - -```python wordwrap -/crypto defi chart -``` - ---- - -## Parameters - -| Name | Description | Optional | Choices | -| ---- | ----------- | -------- | ------- | -| sortby | Column to sort data by (e.g., Total Value Locked) | True | Market Cap (MCap), Total Value Locked (TVL) | -| chain | Chain to filter by (e.g., ethereum) | True | None | -| reverse | Reverse the sort order | True | Yes | - - ---- - -## Examples - -``` -/crypto defi chart -``` ---- +--- +########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### +title: chart +description: OpenBB Discord Command +--- + +# chart + +This command will retrieve a chart of the top DeFi protocols by market capitalization. It will provide a visual representation of the relative size of each protocol, as well as an overview of the total DeFi market size. This will enable users to get a better understanding of the current DeFi landscape and identify which protocols are leading the way. + +### Usage + +```python wordwrap +/crypto defi chart +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| sortby | Column to sort data by (e.g., Total Value Locked) | True | Market Cap (MCap), Total Value Locked (TVL) | +| chain | Chain to filter by (e.g., ethereum) | True | None | +| reverse | Reverse the sort order | True | Yes | + + +--- + +## Examples + +``` +/crypto defi chart +``` +--- diff --git a/website/content/bot/reference/discord/crypto/defi/table.md b/website/content/bot/reference/discord/crypto/defi/table.md index 467247b71a3a..33c22153382f 100644 --- a/website/content/bot/reference/discord/crypto/defi/table.md +++ b/website/content/bot/reference/discord/crypto/defi/table.md @@ -1,35 +1,35 @@ ---- -########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### -title: table -description: OpenBB Discord Command ---- - -# table - -Get top DeFi protocols - -### Usage - -```python wordwrap -/crypto defi table [sortby] [chain] [reverse] -``` - ---- - -## Parameters - -| Name | Description | Optional | Choices | -| ---- | ----------- | -------- | ------- | -| sortby | Column to sort data by (e.g., Total Value Locked) | True | Market Cap (MCap), Total Value Locked (TVL) | -| chain | Chain to filter by (e.g., ethereum) | True | None | -| reverse | Reverse the sort order | True | Yes | - - ---- - -## Examples - -``` -/crypto defi table -``` ---- +--- +########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### +title: table +description: OpenBB Discord Command +--- + +# table + +This command allows the user to view a table of the top DeFi protocols and their associated information, such as the total value locked, 24 hour volume, and price. The table is sorted in descending order, with the top DeFi protocols at the top. + +### Usage + +```python wordwrap +/crypto defi table [sortby] [chain] [reverse] +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| sortby | Column to sort data by (e.g., Total Value Locked) | True | Market Cap (MCap), Total Value Locked (TVL) | +| chain | Chain to filter by (e.g., ethereum) | True | None | +| reverse | Reverse the sort order | True | Yes | + + +--- + +## Examples + +``` +/crypto defi table +``` +--- diff --git a/website/content/bot/reference/discord/crypto/fees.md b/website/content/bot/reference/discord/crypto/fees.md index e89ca6d3acd6..f1dbbbe8226b 100644 --- a/website/content/bot/reference/discord/crypto/fees.md +++ b/website/content/bot/reference/discord/crypto/fees.md @@ -1,34 +1,34 @@ ---- -########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### -title: fees -description: OpenBB Discord Command ---- - -# fees - -Fees on a certain date of top crypto protocols - -### Usage - -```python wordwrap -/crypto fees date -``` - ---- - -## Parameters - -| Name | Description | Optional | Choices | -| ---- | ----------- | -------- | ------- | -| date | Date to get fees for (e.g., 2022-01-01) | False | None | - - ---- - -## Examples - -``` -/crypto fees date: 2022-09-19 -``` - ---- +--- +########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### +title: fees +description: OpenBB Discord Command +--- + +# fees + +This will provide the user with the fee rate of the top crypto protocols on a specified date, allowing the user to compare different protocols' fees and make an informed decision. + +### Usage + +```python wordwrap +/crypto fees date +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| date | Date to get fees for (e.g., 2022-01-01) | False | None | + + +--- + +## Examples + +``` +/crypto fees date: 2022-09-19 +``` + +--- diff --git a/website/content/bot/reference/discord/crypto/index.mdx b/website/content/bot/reference/discord/crypto/index.mdx index db2aea94ce0d..699b20dca51f 100644 --- a/website/content/bot/reference/discord/crypto/index.mdx +++ b/website/content/bot/reference/discord/crypto/index.mdx @@ -11,42 +11,42 @@ import ReferenceCard from "@site/src/components/General/ReferenceCard"; /> diff --git a/website/content/bot/reference/discord/crypto/ir.md b/website/content/bot/reference/discord/crypto/ir.md index f44f427e9216..40ee9c2e34af 100644 --- a/website/content/bot/reference/discord/crypto/ir.md +++ b/website/content/bot/reference/discord/crypto/ir.md @@ -1,33 +1,33 @@ ---- -########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### -title: ir -description: OpenBB Discord Command ---- - -# ir - -Get issuance rate of top crypto protocols - -### Usage - -```python wordwrap -/crypto ir -``` - ---- - -## Parameters - -This command has no parameters - - - ---- - -## Examples - -``` -/crypto ir -``` - ---- +--- +########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### +title: ir +description: OpenBB Discord Command +--- + +# ir + +This command allows the user to retrieve the issuance rate of the top crypto protocols. The issuance rate is the amount of new tokens that are generated by the protocol over a given period of time. It is a useful metric for understanding the supply dynamics of crypto protocols and is used to inform investment decisions. + +### Usage + +```python wordwrap +/crypto ir +``` + +--- + +## Parameters + +This command has no parameters + + + +--- + +## Examples + +``` +/crypto ir +``` + +--- diff --git a/website/content/bot/reference/discord/crypto/prints.md b/website/content/bot/reference/discord/crypto/prints.md index 6d6d8e1bf38a..61161acb1541 100644 --- a/website/content/bot/reference/discord/crypto/prints.md +++ b/website/content/bot/reference/discord/crypto/prints.md @@ -1,34 +1,34 @@ ---- -########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### -title: prints -description: OpenBB Discord Command ---- - -# prints - -Last 15 Crypto Prints over last 24hrs. - -### Usage - -```python wordwrap -/crypto prints coin -``` - ---- - -## Parameters - -| Name | Description | Optional | Choices | -| ---- | ----------- | -------- | ------- | -| coin | Coin from the list of supported coins | False | ADA-USD, AVAX-USD, BTC-USD, DAI-USD, DOGE-USD, DOT-USD, ETH-USD, LTC-USD, MATIC-USD, SHIB-USD, SOL-USD, TRX-USD, USDC-USD, USDT-USD, WBTC-USD, XRP-USD | - - ---- - -## Examples - -``` -/crypto prints coin:BTC-USD -``` - ---- +--- +########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### +title: prints +description: OpenBB Discord Command +--- + +# prints + +This command allows the user to retrieve the Last 15 Crypto Prints over the last 24 hours for the specified coin. The command will provide information on the price, volume, size, and other metrics associated with the prints. + +### Usage + +```python wordwrap +/crypto prints coin +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| coin | Coin from the list of supported coins | False | ADA-USD, AVAX-USD, BTC-USD, DAI-USD, DOGE-USD, DOT-USD, ETH-USD, LTC-USD, MATIC-USD, SHIB-USD, SOL-USD, TRX-USD, USDC-USD, USDT-USD, WBTC-USD, XRP-USD | + + +--- + +## Examples + +``` +/crypto prints coin:BTC-USD +``` + +--- diff --git a/website/content/bot/reference/discord/crypto/top.md b/website/content/bot/reference/discord/crypto/top.md index 0b7a1539f707..84cff07f89e9 100644 --- a/website/content/bot/reference/discord/crypto/top.md +++ b/website/content/bot/reference/discord/crypto/top.md @@ -1,39 +1,39 @@ ---- -########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### -title: top -description: OpenBB Discord Command ---- - -# top - -Get top cryptos - -### Usage - -```python wordwrap -/crypto top [sortby] [category] [reverse] -``` - ---- - -## Parameters - -| Name | Description | Optional | Choices | -| ---- | ----------- | -------- | ------- | -| sortby | Column to sort data by (e.g., Market Cap) | True | Market Cap (MCap) | -| category | Category to filter by (e.g., stablecoins) | True | None | -| reverse | Reverse the sort order | True | Yes | - - ---- - -## Examples - -``` -/crypto top -``` - -``` -/crypto top sortby: Market Cap category: manufacturing -``` ---- +--- +########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### +title: top +description: OpenBB Discord Command +--- + +# top + +This command will retrieve the top cryptocurrencies, ranked by market capitalization, allowing the user to quickly get a snapshot of the current market. + +### Usage + +```python wordwrap +/crypto top [sortby] [category] [reverse] +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| sortby | Column to sort data by (e.g., Market Cap) | True | Market Cap (MCap) | +| category | Category to filter by (e.g., stablecoins) | True | None | +| reverse | Reverse the sort order | True | Yes | + + +--- + +## Examples + +``` +/crypto top +``` + +``` +/crypto top sortby: Market Cap category: manufacturing +``` +--- diff --git a/website/content/bot/reference/discord/crypto/tvl.md b/website/content/bot/reference/discord/crypto/tvl.md index 940563e098cb..61cc1ca1f6e3 100644 --- a/website/content/bot/reference/discord/crypto/tvl.md +++ b/website/content/bot/reference/discord/crypto/tvl.md @@ -1,38 +1,38 @@ ---- -########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### -title: tvl -description: OpenBB Discord Command ---- - -# tvl - -Get protocols historical TVL - -### Usage - -```python wordwrap -/crypto tvl protocols -``` - ---- - -## Parameters - -| Name | Description | Optional | Choices | -| ---- | ----------- | -------- | ------- | -| protocols | comma separated list of protocols (e.g., curve,makerdao) | False | None | - - ---- - -## Examples - -``` -/crypto tvl -``` - -``` -/crypto tvl protocols: curve -``` - ---- +--- +########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### +title: tvl +description: OpenBB Discord Command +--- + +# tvl + +This command allows users to retrieve historical TVL (Total Value Locked) data for any given protocol. It provides a snapshot of the total amount of capital that is currently locked in the protocol, allowing users to easily compare the metrics between different protocols and track their growth over time. + +### Usage + +```python wordwrap +/crypto tvl protocols +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| protocols | comma separated list of protocols (e.g., curve,makerdao) | False | None | + + +--- + +## Examples + +``` +/crypto tvl +``` + +``` +/crypto tvl protocols: curve +``` + +--- diff --git a/website/content/bot/reference/discord/darkpool/allblocks.md b/website/content/bot/reference/discord/darkpool/allblocks.md index 3a4b88be53d0..fc41ba78ca6e 100644 --- a/website/content/bot/reference/discord/darkpool/allblocks.md +++ b/website/content/bot/reference/discord/darkpool/allblocks.md @@ -1,34 +1,34 @@ ---- -########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### -title: allblocks -description: OpenBB Discord Command ---- - -# allblocks - -Last 15 Block Trades. - -### Usage - -```python wordwrap -/dp allblocks ticker -``` - ---- - -## Parameters - -| Name | Description | Optional | Choices | -| ---- | ----------- | -------- | ------- | -| ticker | Stock Ticker | False | None | - - ---- - -## Examples - -``` -/dp topsum -``` - ---- +--- +########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### +title: allblocks +description: OpenBB Discord Command +--- + +# allblocks + +The command allows the user to retrieve the last 15 block trades of a given security. This command will provide a summary of the last 15 block trades, including the time, price, quantity, and total gross value of each trade. + +### Usage + +```python wordwrap +/dp allblocks ticker +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| ticker | Stock Ticker | False | None | + + +--- + +## Examples + +``` +/dp topsum +``` + +--- diff --git a/website/content/bot/reference/discord/darkpool/alldp.md b/website/content/bot/reference/discord/darkpool/alldp.md index 09b265cb168f..5c6af6cd3403 100644 --- a/website/content/bot/reference/discord/darkpool/alldp.md +++ b/website/content/bot/reference/discord/darkpool/alldp.md @@ -1,34 +1,34 @@ ---- -########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### -title: alldp -description: OpenBB Discord Command ---- - -# alldp - -Last 15 Darkpool Trades - -### Usage - -```python wordwrap -/dp alldp ticker -``` - ---- - -## Parameters - -| Name | Description | Optional | Choices | -| ---- | ----------- | -------- | ------- | -| ticker | Stock Ticker | False | None | - - ---- - -## Examples - -``` -/dp alldp ticker:AMD -``` - ---- +--- +########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### +title: alldp +description: OpenBB Discord Command +--- + +# alldp + +This command allows the user to retrieve the last 15 darkpool trades for the specified stock ticker. A darkpool is a private stock trading system that allows large trades to take place without affecting the public market, providing access to larger and more efficient trades. + +### Usage + +```python wordwrap +/dp alldp ticker +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| ticker | Stock Ticker | False | None | + + +--- + +## Examples + +``` +/dp alldp ticker:AMD +``` + +--- diff --git a/website/content/bot/reference/discord/darkpool/allprints.md b/website/content/bot/reference/discord/darkpool/allprints.md index 96f9cc417841..80d3ae632a16 100644 --- a/website/content/bot/reference/discord/darkpool/allprints.md +++ b/website/content/bot/reference/discord/darkpool/allprints.md @@ -1,34 +1,34 @@ ---- -########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### -title: allprints -description: OpenBB Discord Command ---- - -# allprints - -Last 15 Combination of Dark Pool and Blocks. - -### Usage - -```python wordwrap -/dp allprints ticker -``` - ---- - -## Parameters - -| Name | Description | Optional | Choices | -| ---- | ----------- | -------- | ------- | -| ticker | Stock Ticker | False | None | - - ---- - -## Examples - -``` -/dp allprints ticker:AMD -``` - ---- +--- +########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### +title: allprints +description: OpenBB Discord Command +--- + +# allprints + +This command retrieves the Last 15 Combination of Dark Pool and Blocks for a given ticker symbol. This can be used to view the most recent reported trades that involve Dark Pool and Blocks in the stock market. The results of this command will show the date, time, price, and volume of the trades. + +### Usage + +```python wordwrap +/dp allprints ticker +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| ticker | Stock Ticker | False | None | + + +--- + +## Examples + +``` +/dp allprints ticker:AMD +``` + +--- diff --git a/website/content/bot/reference/discord/darkpool/bigprints.md b/website/content/bot/reference/discord/darkpool/bigprints.md index 113ace3c97d3..2091af45fca1 100644 --- a/website/content/bot/reference/discord/darkpool/bigprints.md +++ b/website/content/bot/reference/discord/darkpool/bigprints.md @@ -1,33 +1,33 @@ ---- -########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### -title: bigprints -description: OpenBB Discord Command ---- - -# bigprints - -Combination of Dark Pool and Blocks - Largest over x amount of days. - -### Usage - -```python wordwrap -/dp bigprints days -``` - ---- - -## Parameters - -| Name | Description | Optional | Choices | -| ---- | ----------- | -------- | ------- | -| days | Number of days to look back | False | None | - - ---- - -## Examples - -``` -/dp bigprints days:6 -``` ---- +--- +########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### +title: bigprints +description: OpenBB Discord Command +--- + +# bigprints + +This command will retrieve the largest combination of dark pool and block trades over a specified amount of days. It will provide a comprehensive view of the biggest dark pool and block trades over the specified number of days and give the user an idea of the market activity over that period. + +### Usage + +```python wordwrap +/dp bigprints days +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| days | Number of days to look back | False | None | + + +--- + +## Examples + +``` +/dp bigprints days:6 +``` +--- diff --git a/website/content/bot/reference/discord/darkpool/index.mdx b/website/content/bot/reference/discord/darkpool/index.mdx index b51fda1ebdef..999aef994477 100644 --- a/website/content/bot/reference/discord/darkpool/index.mdx +++ b/website/content/bot/reference/discord/darkpool/index.mdx @@ -6,42 +6,42 @@ import ReferenceCard from "@site/src/components/General/ReferenceCard"; diff --git a/website/content/bot/reference/discord/darkpool/levels.md b/website/content/bot/reference/discord/darkpool/levels.md index 740cfcac016c..d5d4d34d619e 100644 --- a/website/content/bot/reference/discord/darkpool/levels.md +++ b/website/content/bot/reference/discord/darkpool/levels.md @@ -1,35 +1,35 @@ ---- -########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### -title: levels -description: OpenBB Discord Command ---- - -# levels - -Biggest Levels for All Prints over last X days. - -### Usage - -```python wordwrap -/dp levels ticker days -``` - ---- - -## Parameters - -| Name | Description | Optional | Choices | -| ---- | ----------- | -------- | ------- | -| ticker | Stock Ticker | False | None | -| days | Number of days to look back | False | None | - - ---- - -## Examples - -``` -/dp levels ticker:TSLA days:10 -``` - ---- +--- +########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### +title: levels +description: OpenBB Discord Command +--- + +# levels + +This command allows the user to retrieve the Biggest Levels for All Prints over the last x days for the given ticker. This information is useful in assessing the overall performance of the stock, as it provides information on the largest levels of prints over the last x days. + +### Usage + +```python wordwrap +/dp levels ticker days +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| ticker | Stock Ticker | False | None | +| days | Number of days to look back | False | None | + + +--- + +## Examples + +``` +/dp levels ticker:TSLA days:10 +``` + +--- diff --git a/website/content/bot/reference/discord/darkpool/sectors.md b/website/content/bot/reference/discord/darkpool/sectors.md index 60c73c4f3451..db2e4fda4709 100644 --- a/website/content/bot/reference/discord/darkpool/sectors.md +++ b/website/content/bot/reference/discord/darkpool/sectors.md @@ -1,35 +1,35 @@ ---- -########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### -title: sectors -description: OpenBB Discord Command ---- - -# sectors - -Summary of all prints by % of MarketCap by Sector - -### Usage - -```python wordwrap -/dp sectors days sector -``` - ---- - -## Parameters - -| Name | Description | Optional | Choices | -| ---- | ----------- | -------- | ------- | -| days | Number of days to look back | False | None | -| sector | Sector to filter by | False | Basic Materials (BM), Energy (E), Communication Services (CS), Consumer Cyclical (CC), Consumer Defensive (CD), Financial (F), Healthcare (H), Industrials (I), Real Estate (RE), Technology (T), Utilities (U) | - - ---- - -## Examples - -``` -/dp sectors days:5 sector:Basic Materials -``` - ---- +--- +########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### +title: sectors +description: OpenBB Discord Command +--- + +# sectors + +This command allows the user to retrieve a summary of all prints by % of MarketCap by Sector over the last x days. The user will be able to view the sector's market cap divided by total darkpool activity to see possible accumulation. + +### Usage + +```python wordwrap +/dp sectors days sector +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| days | Number of days to look back | False | None | +| sector | Sector to filter by | False | Basic Materials (BM), Energy (E), Communication Services (CS), Consumer Cyclical (CC), Consumer Defensive (CD), Financial (F), Healthcare (H), Industrials (I), Real Estate (RE), Technology (T), Utilities (U) | + + +--- + +## Examples + +``` +/dp sectors days:5 sector:Basic Materials +``` + +--- diff --git a/website/content/bot/reference/discord/darkpool/summary.md b/website/content/bot/reference/discord/darkpool/summary.md index fc80cbdb007e..7612a09ffd32 100644 --- a/website/content/bot/reference/discord/darkpool/summary.md +++ b/website/content/bot/reference/discord/darkpool/summary.md @@ -1,35 +1,35 @@ ---- -########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### -title: summary -description: OpenBB Discord Command ---- - -# summary - -Summary of all prints by % of MarketCap - -### Usage - -```python wordwrap -/dp summary days sort -``` - ---- - -## Parameters - -| Name | Description | Optional | Choices | -| ---- | ----------- | -------- | ------- | -| days | Number of days to look back | False | None | -| sort | Sort by MarketCap, Float, Total, or Short Percentage | False | MarketCap (mc), Float (float), Total (sum), Short Percentage (short) | - - ---- - -## Examples - -``` -/dp summary days:10 sort:MarketCap -``` - ---- +--- +########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### +title: summary +description: OpenBB Discord Command +--- + +# summary + +This command retrieves a summary of all the prints by percentage of MarketCap over the last x days, sorted by MarketCap. The summary includes the total number of prints and their total percentage of MarketCap, as well as the float and short percentage. + +### Usage + +```python wordwrap +/dp summary days sort +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| days | Number of days to look back | False | None | +| sort | Sort by MarketCap, Float, Total, or Short Percentage | False | MarketCap (mc), Float (float), Total (sum), Short Percentage (short) | + + +--- + +## Examples + +``` +/dp summary days:10 sort:MarketCap +``` + +--- diff --git a/website/content/bot/reference/discord/darkpool/topsum.md b/website/content/bot/reference/discord/darkpool/topsum.md index c430a430d6b1..b464be2f8fd4 100644 --- a/website/content/bot/reference/discord/darkpool/topsum.md +++ b/website/content/bot/reference/discord/darkpool/topsum.md @@ -1,31 +1,31 @@ ---- -########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### -title: topsum -description: OpenBB Discord Command ---- - -# topsum - -Top Total Block & Dark Pool data. - -### Usage - -```python wordwrap -/dp topsum -``` - ---- - -## Parameters - -This command has no parameters - - ---- - -## Examples - -``` -/dp topsum -``` ---- +--- +########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### +title: topsum +description: OpenBB Discord Command +--- + +# topsum + +This command allows the user to retrieve total block and dark pool data summary. It sums all darkpool prints and gives a table of the largest by symbol as well as a graph for comparison. + +### Usage + +```python wordwrap +/dp topsum +``` + +--- + +## Parameters + +This command has no parameters + + +--- + +## Examples + +``` +/dp topsum +``` +--- diff --git a/website/content/bot/reference/discord/discovery/arktrades.md b/website/content/bot/reference/discord/discovery/arktrades.md index 658e90ea0dbd..eb69b0e2e97b 100644 --- a/website/content/bot/reference/discord/discovery/arktrades.md +++ b/website/content/bot/reference/discord/discovery/arktrades.md @@ -1,32 +1,32 @@ ---- -########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### -title: arktrades -description: OpenBB Discord Command ---- - -# arktrades - -Displays trades made by ARK. - -### Usage - -```python wordwrap -/disc arktrades -``` - ---- - -## Parameters - -This command has no parameters - - - ---- - -## Examples - -``` -/disc arktrades -``` ---- +--- +########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### +title: arktrades +description: OpenBB Discord Command +--- + +# arktrades + +This command allows the user to retrieve a list of all trades made by ARK, including the time and amount of each trade. The data is presented in an easy-to-read table format so that the user can quickly analyze the trades made by ARK. + +### Usage + +```python wordwrap +/disc arktrades +``` + +--- + +## Parameters + +This command has no parameters + + + +--- + +## Examples + +``` +/disc arktrades +``` +--- diff --git a/website/content/bot/reference/discord/discovery/contracts.md b/website/content/bot/reference/discord/discovery/contracts.md index 7be828237875..e95aea69515c 100644 --- a/website/content/bot/reference/discord/discovery/contracts.md +++ b/website/content/bot/reference/discord/discovery/contracts.md @@ -1,32 +1,32 @@ ---- -########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### -title: contracts -description: OpenBB Discord Command ---- - -# contracts - -Displays Top 15 Government contracts by amount for all tickers. - -### Usage - -```python wordwrap -/disc contracts -``` - ---- - -## Parameters - -This command has no parameters - - - ---- - -## Examples - -``` -/disc contracts -``` ---- +--- +########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### +title: contracts +description: OpenBB Discord Command +--- + +# contracts + +This command allows the user to retrieve the Top 15 Government contracts by amount for all tickers. This is a helpful tool for those who want to quickly get an overview of the total value of Government contracts awarded to various companies. The data is retrieved from a database of contracts and can be used to gain valuable insights into the financial health of those companies. + +### Usage + +```python wordwrap +/disc contracts +``` + +--- + +## Parameters + +This command has no parameters + + + +--- + +## Examples + +``` +/disc contracts +``` +--- diff --git a/website/content/bot/reference/discord/discovery/fgindex.md b/website/content/bot/reference/discord/discovery/fgindex.md index 8bbc2653450d..d5c374f651c0 100644 --- a/website/content/bot/reference/discord/discovery/fgindex.md +++ b/website/content/bot/reference/discord/discovery/fgindex.md @@ -1,32 +1,32 @@ ---- -########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### -title: fgindex -description: OpenBB Discord Command ---- - -# fgindex - -Displays Fear & Greed Index - Investor Sentiment - CNNMoney - -### Usage - -```python wordwrap -/disc fgindex -``` - ---- - -## Parameters - -This command has no parameters - - - ---- - -## Examples - -``` -/disc fgindex -``` ---- +--- +########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### +title: fgindex +description: OpenBB Discord Command +--- + +# fgindex + +This command allows the user to retrieve the Fear & Greed Index, which is an investor sentiment indicator published by CNNMoney. The index measures the levels of fear and greed of the investors in the stock market by observing the momentum, sentiment and volume of stock trading. The index ranges from 0 to 100, with 0 being the most fearful and 100 being the most greedy. + +### Usage + +```python wordwrap +/disc fgindex +``` + +--- + +## Parameters + +This command has no parameters + + + +--- + +## Examples + +``` +/disc fgindex +``` +--- diff --git a/website/content/bot/reference/discord/discovery/halts.md b/website/content/bot/reference/discord/discovery/halts.md index 614151dcddc6..cdbb69369223 100644 --- a/website/content/bot/reference/discord/discovery/halts.md +++ b/website/content/bot/reference/discord/discovery/halts.md @@ -1,32 +1,32 @@ ---- -########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### -title: halts -description: OpenBB Discord Command ---- - -# halts - -Gives Time and Halt Code of stocks in the market - doesn't work for pennys. - -### Usage - -```python wordwrap -/disc halts -``` - ---- - -## Parameters - -This command has no parameters - - - ---- - -## Examples - -``` -/disc halts -``` ---- +--- +########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### +title: halts +description: OpenBB Discord Command +--- + +# halts + +This command allows the user to retrieve the time and halt code of stocks in the market, excluding penny stocks. The output of this command provides the user with the time and halt code of stock that is currently halted or in the process of being halted by the exchange. + +### Usage + +```python wordwrap +/disc halts +``` + +--- + +## Parameters + +This command has no parameters + + + +--- + +## Examples + +``` +/disc halts +``` +--- diff --git a/website/content/bot/reference/discord/discovery/holidays.md b/website/content/bot/reference/discord/discovery/holidays.md index 810f11de571f..d7a1f18a6aeb 100644 --- a/website/content/bot/reference/discord/discovery/holidays.md +++ b/website/content/bot/reference/discord/discovery/holidays.md @@ -1,32 +1,32 @@ ---- -########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### -title: holidays -description: OpenBB Discord Command ---- - -# holidays - -Displays Upcoming Market Holidays. - -### Usage - -```python wordwrap -/disc holidays -``` - ---- - -## Parameters - -This command has no parameters - - - ---- - -## Examples - -``` -/disc holidays -``` ---- +--- +########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### +title: holidays +description: OpenBB Discord Command +--- + +# holidays + +This command allows the user to retrieve a list of upcoming market holidays. The command will return a list of holidays, including their respective dates, along with any other pertinent details, such as whether they are national holidays or not. This command is suitable for any user who needs to stay up to date with upcoming holidays. + +### Usage + +```python wordwrap +/disc holidays +``` + +--- + +## Parameters + +This command has no parameters + + + +--- + +## Examples + +``` +/disc holidays +``` +--- diff --git a/website/content/bot/reference/discord/discovery/house.md b/website/content/bot/reference/discord/discovery/house.md index cbe56d29d0ab..91d693bb7137 100644 --- a/website/content/bot/reference/discord/discovery/house.md +++ b/website/content/bot/reference/discord/discovery/house.md @@ -1,32 +1,32 @@ ---- -########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### -title: house -description: OpenBB Discord Command ---- - -# house - -Displays recent house trades for all tickers. - -### Usage - -```python wordwrap -/disc house -``` - ---- - -## Parameters - -This command has no parameters - - - ---- - -## Examples - -``` -/disc house -``` ---- +--- +########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### +title: house +description: OpenBB Discord Command +--- + +# house + +This command allows users to retrieve recent house trades for all tickers. The command will display the time of the trade, the ticker, the size of the trade, the price, and any other relevant details. + +### Usage + +```python wordwrap +/disc house +``` + +--- + +## Parameters + +This command has no parameters + + + +--- + +## Examples + +``` +/disc house +``` +--- diff --git a/website/content/bot/reference/discord/discovery/index.mdx b/website/content/bot/reference/discord/discovery/index.mdx index 42136ad89578..3eb71a4f48d3 100644 --- a/website/content/bot/reference/discord/discovery/index.mdx +++ b/website/content/bot/reference/discord/discovery/index.mdx @@ -6,57 +6,57 @@ import ReferenceCard from "@site/src/components/General/ReferenceCard"; diff --git a/website/content/bot/reference/discord/discovery/ipolist.md b/website/content/bot/reference/discord/discovery/ipolist.md index 3ad68ff7b7af..77485c615bb8 100644 --- a/website/content/bot/reference/discord/discovery/ipolist.md +++ b/website/content/bot/reference/discord/discovery/ipolist.md @@ -1,32 +1,32 @@ ---- -########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### -title: ipolist -description: OpenBB Discord Command ---- - -# ipolist - -Displays 10 Upcoming and Recent IPO's. - -### Usage - -```python wordwrap -/disc ipolist -``` - ---- - -## Parameters - -This command has no parameters - - - ---- - -## Examples - -``` -/disc ipolist -``` ---- +--- +########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### +title: ipolist +description: OpenBB Discord Command +--- + +# ipolist + +This command allows the user to view 10 of the most recent and upcoming Initial Public Offerings (IPOs) including the company name, the IPO date, and the stock exchange. This information can help users stay up-to-date with the latest IPOs, and provide them with opportunities to invest in new companies. + +### Usage + +```python wordwrap +/disc ipolist +``` + +--- + +## Parameters + +This command has no parameters + + + +--- + +## Examples + +``` +/disc ipolist +``` +--- diff --git a/website/content/bot/reference/discord/discovery/senate.md b/website/content/bot/reference/discord/discovery/senate.md index 0b9aac3d2c79..cc727118f70e 100644 --- a/website/content/bot/reference/discord/discovery/senate.md +++ b/website/content/bot/reference/discord/discovery/senate.md @@ -1,32 +1,32 @@ ---- -########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### -title: senate -description: OpenBB Discord Command ---- - -# senate - -Displays recent senate trades for all tickers. - -### Usage - -```python wordwrap -/disc senate -``` - ---- - -## Parameters - -This command has no parameters - - - ---- - -## Examples - -``` -/disc senate -``` ---- +--- +########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### +title: senate +description: OpenBB Discord Command +--- + +# senate + +This command retrieves the most recent senate trades for all tickers including the date and time of the trade and the price information. + +### Usage + +```python wordwrap +/disc senate +``` + +--- + +## Parameters + +This command has no parameters + + + +--- + +## Examples + +``` +/disc senate +``` +--- diff --git a/website/content/bot/reference/discord/discovery/splits.md b/website/content/bot/reference/discord/discovery/splits.md index cbc7fcb8d2f2..9292582c877c 100644 --- a/website/content/bot/reference/discord/discovery/splits.md +++ b/website/content/bot/reference/discord/discovery/splits.md @@ -1,32 +1,32 @@ ---- -########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### -title: splits -description: OpenBB Discord Command ---- - -# splits - -List of recent Stock splits for all tickers. - -### Usage - -```python wordwrap -/disc splits -``` - ---- - -## Parameters - -This command has no parameters - - - ---- - -## Examples - -``` -/disc splits -``` ---- +--- +########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### +title: splits +description: OpenBB Discord Command +--- + +# splits + +This command allows users to view a list of recent stock splits for all available tickers. This list includes the ticker, the date of the split, and the ratio of the split. This data can be used to track how stocks have been split in the past. + +### Usage + +```python wordwrap +/disc splits +``` + +--- + +## Parameters + +This command has no parameters + + + +--- + +## Examples + +``` +/disc splits +``` +--- diff --git a/website/content/bot/reference/discord/discovery/trendingst.md b/website/content/bot/reference/discord/discovery/trendingst.md index 560dc5d861f6..d86cf0e0743f 100644 --- a/website/content/bot/reference/discord/discovery/trendingst.md +++ b/website/content/bot/reference/discord/discovery/trendingst.md @@ -1,32 +1,32 @@ ---- -########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### -title: trendingst -description: OpenBB Discord Command ---- - -# trendingst - -Display Top 15 Trendings Stocks - StockTwits - -### Usage - -```python wordwrap -/disc trendingst -``` - ---- - -## Parameters - -This command has no parameters - - - ---- - -## Examples - -``` -/disc trendingst -``` ---- +--- +########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### +title: trendingst +description: OpenBB Discord Command +--- + +# trendingst + +This command allows the user to retrieve the top 15 trending stocks from StockTwits according to the most recent discussions. The stocks are displayed in order of most trending, as determined by the most discussed stocks in the StockTwits community. This command is an efficient way to stay up to date on the most popular stocks in the market. + +### Usage + +```python wordwrap +/disc trendingst +``` + +--- + +## Parameters + +This command has no parameters + + + +--- + +## Examples + +``` +/disc trendingst +``` +--- diff --git a/website/content/bot/reference/discord/discovery/wsb.md b/website/content/bot/reference/discord/discovery/wsb.md index 9bf86396029b..4c15c55ab760 100644 --- a/website/content/bot/reference/discord/discovery/wsb.md +++ b/website/content/bot/reference/discord/discovery/wsb.md @@ -1,32 +1,32 @@ ---- -########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### -title: wsb -description: OpenBB Discord Command ---- - -# wsb - -Display Top 15 Trendings Stocks - WSB - -### Usage - -```python wordwrap -/disc wsb -``` - ---- - -## Parameters - -This command has no parameters - - - ---- - -## Examples - -``` -/disc wsb -``` ---- +--- +########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### +title: wsb +description: OpenBB Discord Command +--- + +# wsb + +This command allows the user to view the top 15 trending stocks on r/WallStreetBets (WSB) using the /disc wsb command. It displays the mentions count for popular stocks on the platform. + +### Usage + +```python wordwrap +/disc wsb +``` + +--- + +## Parameters + +This command has no parameters + + + +--- + +## Examples + +``` +/disc wsb +``` +--- diff --git a/website/content/bot/reference/discord/duedilligence/ah.md b/website/content/bot/reference/discord/duedilligence/ah.md index d409e10670f6..f29528784e67 100644 --- a/website/content/bot/reference/discord/duedilligence/ah.md +++ b/website/content/bot/reference/discord/duedilligence/ah.md @@ -1,33 +1,33 @@ ---- -########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### -title: ah -description: OpenBB Discord Command ---- - -# ah - -Displays afterhours data for a given stock ticker - -### Usage - -```python wordwrap -/dd ah ticker -``` - ---- - -## Parameters - -| Name | Description | Optional | Choices | -| ---- | ----------- | -------- | ------- | -| ticker | Stock Ticker | False | None | - - ---- - -## Examples - -``` -/dd ah ticker:AMD -``` ---- +--- +########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### +title: ah +description: OpenBB Discord Command +--- + +# ah + +This command allows the user to retrieve afterhours data for a given stock ticker. The data retrieved will include the stock's current price, the highest and lowest prices of the ah session, the volume traded, and the change in the afterhours market. + +### Usage + +```python wordwrap +/dd ah ticker +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| ticker | Stock Ticker | False | None | + + +--- + +## Examples + +``` +/dd ah ticker:AMD +``` +--- diff --git a/website/content/bot/reference/discord/duedilligence/analyst.md b/website/content/bot/reference/discord/duedilligence/analyst.md index 2bbca48117f1..575cc4efe6e0 100644 --- a/website/content/bot/reference/discord/duedilligence/analyst.md +++ b/website/content/bot/reference/discord/duedilligence/analyst.md @@ -1,33 +1,33 @@ ---- -########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### -title: analyst -description: OpenBB Discord Command ---- - -# analyst - -Displays analyst recommendations. - -### Usage - -```python wordwrap -/dd analyst ticker -``` - ---- - -## Parameters - -| Name | Description | Optional | Choices | -| ---- | ----------- | -------- | ------- | -| ticker | Stock Ticker | False | None | - - ---- - -## Examples - -``` -/dd analyst ticker:AMD -``` ---- +--- +########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### +title: analyst +description: OpenBB Discord Command +--- + +# analyst + +This command allows the user to retrieve analyst recommendations for a given stock ticker. + +### Usage + +```python wordwrap +/dd analyst ticker +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| ticker | Stock Ticker | False | None | + + +--- + +## Examples + +``` +/dd analyst ticker:AMD +``` +--- diff --git a/website/content/bot/reference/discord/duedilligence/bio.md b/website/content/bot/reference/discord/duedilligence/bio.md index e84dddd54fdd..d0b48967efe5 100644 --- a/website/content/bot/reference/discord/duedilligence/bio.md +++ b/website/content/bot/reference/discord/duedilligence/bio.md @@ -1,33 +1,33 @@ ---- -########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### -title: bio -description: OpenBB Discord Command ---- - -# bio - -Displays a Stock's Company Info. - -### Usage - -```python wordwrap -/dd bio ticker -``` - ---- - -## Parameters - -| Name | Description | Optional | Choices | -| ---- | ----------- | -------- | ------- | -| ticker | Stock Ticker | False | None | - - ---- - -## Examples - -``` -/dd bio ticker:AMD -``` ---- +--- +########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### +title: bio +description: OpenBB Discord Command +--- + +# bio + +This command retrieves a stock's company information and displays it to the user. It takes a stock ticker as an argument and returns information such as the company's name, description, sector, industry, CEO, and more. + +### Usage + +```python wordwrap +/dd bio ticker +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| ticker | Stock Ticker | False | None | + + +--- + +## Examples + +``` +/dd bio ticker:AMD +``` +--- diff --git a/website/content/bot/reference/discord/duedilligence/customer.md b/website/content/bot/reference/discord/duedilligence/customer.md index d8264a650d3a..b5b90c6d1977 100644 --- a/website/content/bot/reference/discord/duedilligence/customer.md +++ b/website/content/bot/reference/discord/duedilligence/customer.md @@ -1,33 +1,33 @@ ---- -########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### -title: customer -description: OpenBB Discord Command ---- - -# customer - -Displays customers of the company. - -### Usage - -```python wordwrap -/dd customer ticker -``` - ---- - -## Parameters - -| Name | Description | Optional | Choices | -| ---- | ----------- | -------- | ------- | -| ticker | Stock Ticker | False | None | - - ---- - -## Examples - -``` -/dd customer ticker:AMD -``` ---- +--- +########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### +title: customer +description: OpenBB Discord Command +--- + +# customer + +This command allows the user to display customers of the company using the given symbol. + +### Usage + +```python wordwrap +/dd customer ticker +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| ticker | Stock Ticker | False | None | + + +--- + +## Examples + +``` +/dd customer ticker:AMD +``` +--- diff --git a/website/content/bot/reference/discord/duedilligence/divinfo.md b/website/content/bot/reference/discord/duedilligence/divinfo.md index 1ad556d20251..2e1299f5afb4 100644 --- a/website/content/bot/reference/discord/duedilligence/divinfo.md +++ b/website/content/bot/reference/discord/duedilligence/divinfo.md @@ -1,33 +1,33 @@ ---- -########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### -title: divinfo -description: OpenBB Discord Command ---- - -# divinfo - -Displays dividend information for a stock. - -### Usage - -```python wordwrap -/dd divinfo ticker -``` - ---- - -## Parameters - -| Name | Description | Optional | Choices | -| ---- | ----------- | -------- | ------- | -| ticker | Stock Ticker | False | None | - - ---- - -## Examples - -``` -/dd divinfo ticker:AAPL -``` ---- +--- +########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### +title: divinfo +description: OpenBB Discord Command +--- + +# divinfo + +This command retrieves dividend information for a given stock. The data includes dividend rate, yield, and ex-div date. + +### Usage + +```python wordwrap +/dd divinfo ticker +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| ticker | Stock Ticker | False | None | + + +--- + +## Examples + +``` +/dd divinfo ticker:AAPL +``` +--- diff --git a/website/content/bot/reference/discord/duedilligence/earnings.md b/website/content/bot/reference/discord/duedilligence/earnings.md index e3fd313f0d9b..c5b4522eb5cd 100644 --- a/website/content/bot/reference/discord/duedilligence/earnings.md +++ b/website/content/bot/reference/discord/duedilligence/earnings.md @@ -1,33 +1,33 @@ ---- -########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### -title: earnings -description: OpenBB Discord Command ---- - -# earnings - -Display Earnings that are expected to occur in the next business days. (Sorted by market cap) - -### Usage - -```python wordwrap -/dd earnings day -``` - ---- - -## Parameters - -| Name | Description | Optional | Choices | -| ---- | ----------- | -------- | ------- | -| day | Date to get earnings for (YYYY-MM-DD) | False | None | - - ---- - -## Examples - -``` -/dd earnings day:2022-07-29 -``` ---- +--- +########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### +title: earnings +description: OpenBB Discord Command +--- + +# earnings + +This command allows the user to retrieve the expected earnings for the given business day. The displayed earnings will include company ticker, expected time, sector, and float of the company. This information can be used to help the user make informed decisions about their investments. + +### Usage + +```python wordwrap +/dd earnings day +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| day | Date to get earnings for (YYYY-MM-DD) | False | None | + + +--- + +## Examples + +``` +/dd earnings day:2022-07-29 +``` +--- diff --git a/website/content/bot/reference/discord/duedilligence/ermove.md b/website/content/bot/reference/discord/duedilligence/ermove.md index 62a3baba3b62..7f65ae91caad 100644 --- a/website/content/bot/reference/discord/duedilligence/ermove.md +++ b/website/content/bot/reference/discord/duedilligence/ermove.md @@ -1,33 +1,33 @@ ---- -########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### -title: ermove -description: OpenBB Discord Command ---- - -# ermove - -Display implied move for a stock based on option prices. - -### Usage - -```python wordwrap -/dd ermove ticker -``` - ---- - -## Parameters - -| Name | Description | Optional | Choices | -| ---- | ----------- | -------- | ------- | -| ticker | Stock Ticker | False | None | - - ---- - -## Examples - -``` -/dd ermove ticker:AMD -``` ---- +--- +########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### +title: ermove +description: OpenBB Discord Command +--- + +# ermove + +This command allows the user to retrieve the implied move for a stock based on the current option prices. The implied move is a measure of how far the stock is expected to move during the option's expiration. + +### Usage + +```python wordwrap +/dd ermove ticker +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| ticker | Stock Ticker | False | None | + + +--- + +## Examples + +``` +/dd ermove ticker:AMD +``` +--- diff --git a/website/content/bot/reference/discord/duedilligence/est.md b/website/content/bot/reference/discord/duedilligence/est.md index e77cf836ec62..87f2a3c78f27 100644 --- a/website/content/bot/reference/discord/duedilligence/est.md +++ b/website/content/bot/reference/discord/duedilligence/est.md @@ -1,33 +1,33 @@ ---- -########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### -title: est -description: OpenBB Discord Command ---- - -# est - -Displays earning estimates. - -### Usage - -```python wordwrap -/dd est ticker -``` - ---- - -## Parameters - -| Name | Description | Optional | Choices | -| ---- | ----------- | -------- | ------- | -| ticker | Stock Ticker | False | None | - - ---- - -## Examples - -``` -/dd est ticker:MMM -``` ---- +--- +########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### +title: est +description: OpenBB Discord Command +--- + +# est + +This command allows the user to retrieve earning estimates for a given stock symbol. This can be used as a helpful tool for investors to get an idea of how a stock may perform in terms of earnings. + +### Usage + +```python wordwrap +/dd est ticker +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| ticker | Stock Ticker | False | None | + + +--- + +## Examples + +``` +/dd est ticker:MMM +``` +--- diff --git a/website/content/bot/reference/discord/duedilligence/financials.md b/website/content/bot/reference/discord/duedilligence/financials.md index f87464c74ce6..a28d23100860 100644 --- a/website/content/bot/reference/discord/duedilligence/financials.md +++ b/website/content/bot/reference/discord/duedilligence/financials.md @@ -1,33 +1,33 @@ ---- -########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### -title: financials -description: OpenBB Discord Command ---- - -# financials - -Gives Total Assets, Cash, Debt, Liabilities, Rev for Company. - -### Usage - -```python wordwrap -/dd financials ticker -``` - ---- - -## Parameters - -| Name | Description | Optional | Choices | -| ---- | ----------- | -------- | ------- | -| ticker | Stock Ticker | False | None | - - ---- - -## Examples - -``` -/dd financials ticker:AMD -``` ---- +--- +########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### +title: financials +description: OpenBB Discord Command +--- + +# financials + +This command will retrieve the financials of the company with the given ticker which includes total assets, cash, debt, liabilities, and revenue. This information can be used to analyze the financial health of the company. + +### Usage + +```python wordwrap +/dd financials ticker +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| ticker | Stock Ticker | False | None | + + +--- + +## Examples + +``` +/dd financials ticker:AMD +``` +--- diff --git a/website/content/bot/reference/discord/duedilligence/index.mdx b/website/content/bot/reference/discord/duedilligence/index.mdx index 576f474ccaee..b90861042640 100644 --- a/website/content/bot/reference/discord/duedilligence/index.mdx +++ b/website/content/bot/reference/discord/duedilligence/index.mdx @@ -6,92 +6,92 @@ import ReferenceCard from "@site/src/components/General/ReferenceCard"; diff --git a/website/content/bot/reference/discord/duedilligence/insiders.md b/website/content/bot/reference/discord/duedilligence/insiders.md index e06a18489e5f..7909649e9e7b 100644 --- a/website/content/bot/reference/discord/duedilligence/insiders.md +++ b/website/content/bot/reference/discord/duedilligence/insiders.md @@ -1,33 +1,33 @@ ---- -########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### -title: insiders -description: OpenBB Discord Command ---- - -# insiders - -Displays 15 latest insider transactions for given stock - -### Usage - -```python wordwrap -/dd insiders ticker -``` - ---- - -## Parameters - -| Name | Description | Optional | Choices | -| ---- | ----------- | -------- | ------- | -| ticker | Stock Ticker | False | None | - - ---- - -## Examples - -``` -/dd insiders ticker:AMD -``` ---- +--- +########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### +title: insiders +description: OpenBB Discord Command +--- + +# insiders + +This command allows the user to retrieve the 15 most recent insider transactions for a given stock. It will provide information such as the date of the transaction, the company insider involved, the number of shares traded, the type of transaction (buy/sell), and the average price of the transaction. + +### Usage + +```python wordwrap +/dd insiders ticker +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| ticker | Stock Ticker | False | None | + + +--- + +## Examples + +``` +/dd insiders ticker:AMD +``` +--- diff --git a/website/content/bot/reference/discord/duedilligence/instholdings.md b/website/content/bot/reference/discord/duedilligence/instholdings.md index 3bd5bdd583af..613cd4e5adc0 100644 --- a/website/content/bot/reference/discord/duedilligence/instholdings.md +++ b/website/content/bot/reference/discord/duedilligence/instholdings.md @@ -1,33 +1,33 @@ ---- -########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### -title: instholdings -description: OpenBB Discord Command ---- - -# instholdings - -Displays top 15 Institutional Holdings for given stock - -### Usage - -```python wordwrap -/dd instholdings ticker -``` - ---- - -## Parameters - -| Name | Description | Optional | Choices | -| ---- | ----------- | -------- | ------- | -| ticker | Stock Ticker | False | None | - - ---- - -## Examples - -``` -/dd instholdings ticker:AMD -``` ---- +--- +########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### +title: instholdings +description: OpenBB Discord Command +--- + +# instholdings + +This command allows the user to retrieve the top 15 institutional holdings for a given stock. This list is retrieved from the most recent available institutional holdings reported to the United States Securities and Exchange Commission. + +### Usage + +```python wordwrap +/dd instholdings ticker +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| ticker | Stock Ticker | False | None | + + +--- + +## Examples + +``` +/dd instholdings ticker:AMD +``` +--- diff --git a/website/content/bot/reference/discord/duedilligence/nexter.md b/website/content/bot/reference/discord/duedilligence/nexter.md index 4b81143cab21..aeac571d6d39 100644 --- a/website/content/bot/reference/discord/duedilligence/nexter.md +++ b/website/content/bot/reference/discord/duedilligence/nexter.md @@ -1,33 +1,33 @@ ---- -########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### -title: nexter -description: OpenBB Discord Command ---- - -# nexter - -Returns next Earnings Date for a stock. - -### Usage - -```python wordwrap -/dd nexter ticker -``` - ---- - -## Parameters - -| Name | Description | Optional | Choices | -| ---- | ----------- | -------- | ------- | -| ticker | Stock Ticker | False | None | - - ---- - -## Examples - -``` -/dd nexter ticker:AMD -``` ---- +--- +########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### +title: nexter +description: OpenBB Discord Command +--- + +# nexter + +This command will retrieve the next earnings date for the given stock ticker symbol. + +### Usage + +```python wordwrap +/dd nexter ticker +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| ticker | Stock Ticker | False | None | + + +--- + +## Examples + +``` +/dd nexter ticker:AMD +``` +--- diff --git a/website/content/bot/reference/discord/duedilligence/pm.md b/website/content/bot/reference/discord/duedilligence/pm.md index 534f76bf6337..d0abca4fa280 100644 --- a/website/content/bot/reference/discord/duedilligence/pm.md +++ b/website/content/bot/reference/discord/duedilligence/pm.md @@ -1,33 +1,33 @@ ---- -########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### -title: pm -description: OpenBB Discord Command ---- - -# pm - -Displays premarket data for a given stock ticker - -### Usage - -```python wordwrap -/dd pm ticker -``` - ---- - -## Parameters - -| Name | Description | Optional | Choices | -| ---- | ----------- | -------- | ------- | -| ticker | Stock Ticker | False | None | - - ---- - -## Examples - -``` -/dd pm ticker:AMD -``` ---- +--- +########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### +title: pm +description: OpenBB Discord Command +--- + +# pm + +This command allows the user to retrieve premarket data for a given stock ticker. It will fetch the latest price, the premarket change, and the premarket percentage change of the selected stock. This is useful for those who want to get an idea of the stock's performance before the regular market opens. + +### Usage + +```python wordwrap +/dd pm ticker +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| ticker | Stock Ticker | False | None | + + +--- + +## Examples + +``` +/dd pm ticker:AMD +``` +--- diff --git a/website/content/bot/reference/discord/duedilligence/pt.md b/website/content/bot/reference/discord/duedilligence/pt.md index 2713e25dbaa3..660df18ca32a 100644 --- a/website/content/bot/reference/discord/duedilligence/pt.md +++ b/website/content/bot/reference/discord/duedilligence/pt.md @@ -1,33 +1,33 @@ ---- -########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### -title: pt -description: OpenBB Discord Command ---- - -# pt - -Displays chart with price targets. - -### Usage - -```python wordwrap -/dd pt ticker -``` - ---- - -## Parameters - -| Name | Description | Optional | Choices | -| ---- | ----------- | -------- | ------- | -| ticker | Stock Ticker | False | None | - - ---- - -## Examples - -``` -/dd pt ticker:AMD -``` ---- +--- +########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### +title: pt +description: OpenBB Discord Command +--- + +# pt + +This command allows the user to retrieve a chart with price targets for the specified ticker. The chart will provide information on the current price, target prices and analyst ratings, allowing the user to make more informed decisions. + +### Usage + +```python wordwrap +/dd pt ticker +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| ticker | Stock Ticker | False | None | + + +--- + +## Examples + +``` +/dd pt ticker:AMD +``` +--- diff --git a/website/content/bot/reference/discord/duedilligence/sec.md b/website/content/bot/reference/discord/duedilligence/sec.md index 80d5f46e83e3..a31644dc2389 100644 --- a/website/content/bot/reference/discord/duedilligence/sec.md +++ b/website/content/bot/reference/discord/duedilligence/sec.md @@ -1,33 +1,33 @@ ---- -########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### -title: sec -description: OpenBB Discord Command ---- - -# sec - -Displays recent SEC filings. - -### Usage - -```python wordwrap -/dd sec ticker -``` - ---- - -## Parameters - -| Name | Description | Optional | Choices | -| ---- | ----------- | -------- | ------- | -| ticker | Stock Ticker | False | None | - - ---- - -## Examples - -``` -/dd sec ticker:AMD -``` ---- +--- +########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### +title: sec +description: OpenBB Discord Command +--- + +# sec + +This command allows the user to retrieve the most recent SEC filings related to the specified ticker symbol. The filings can include company financials, registration statements, and periodic reports such as 10-Ks, 8-Ks, and 10-Qs. This command is especially useful for investors and analysts who need up-to-date information on a company's financial performance or other corporate documents. + +### Usage + +```python wordwrap +/dd sec ticker +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| ticker | Stock Ticker | False | None | + + +--- + +## Examples + +``` +/dd sec ticker:AMD +``` +--- diff --git a/website/content/bot/reference/discord/duedilligence/splits.md b/website/content/bot/reference/discord/duedilligence/splits.md index 8b14ca0e72e1..7612ea1392e7 100644 --- a/website/content/bot/reference/discord/duedilligence/splits.md +++ b/website/content/bot/reference/discord/duedilligence/splits.md @@ -1,34 +1,34 @@ ---- -########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### -title: splits -description: OpenBB Discord Command ---- - -# splits - -List of recent Stock splits for all tickers or for a given ticker. - -### Usage - -```python wordwrap -/dd splits ticker -``` - ---- - -## Parameters - -| Name | Description | Optional | Choices | -| ---- | ----------- | -------- | ------- | -| ticker | Stock Ticker | False | None | - - ---- - -## Examples - -``` -/dd splits ticker:AMD -``` - ---- +--- +########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### +title: splits +description: OpenBB Discord Command +--- + +# splits + +This command retrieves a list of recent stock splits for a given ticker. This command is useful for tracking the splits of a particular stock over time. + +### Usage + +```python wordwrap +/dd splits ticker +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| ticker | Stock Ticker | False | None | + + +--- + +## Examples + +``` +/dd splits ticker:AMD +``` + +--- diff --git a/website/content/bot/reference/discord/duedilligence/supplier.md b/website/content/bot/reference/discord/duedilligence/supplier.md index fed720c3403b..bb89c5a0c7ea 100644 --- a/website/content/bot/reference/discord/duedilligence/supplier.md +++ b/website/content/bot/reference/discord/duedilligence/supplier.md @@ -1,33 +1,33 @@ ---- -########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### -title: supplier -description: OpenBB Discord Command ---- - -# supplier - -Displays suppliers of the company. - -### Usage - -```python wordwrap -/dd supplier ticker -``` - ---- - -## Parameters - -| Name | Description | Optional | Choices | -| ---- | ----------- | -------- | ------- | -| ticker | Stock Ticker | False | None | - - ---- - -## Examples - -``` -/dd supplier ticker:AMD -``` ---- +--- +########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### +title: supplier +description: OpenBB Discord Command +--- + +# supplier + +This command allows users to retrieve the list of suppliers associated with the company with the given ticker. + +### Usage + +```python wordwrap +/dd supplier ticker +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| ticker | Stock Ticker | False | None | + + +--- + +## Examples + +``` +/dd supplier ticker:AMD +``` +--- diff --git a/website/content/bot/reference/discord/duedilligence/ytd.md b/website/content/bot/reference/discord/duedilligence/ytd.md index 00f996c00f69..6e5abaab3b18 100644 --- a/website/content/bot/reference/discord/duedilligence/ytd.md +++ b/website/content/bot/reference/discord/duedilligence/ytd.md @@ -1,33 +1,33 @@ ---- -########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### -title: ytd -description: OpenBB Discord Command ---- - -# ytd - -Displays Period Performance for a stock. - -### Usage - -```python wordwrap -/dd ytd ticker -``` - ---- - -## Parameters - -| Name | Description | Optional | Choices | -| ---- | ----------- | -------- | ------- | -| ticker | Stock Ticker | False | None | - - ---- - -## Examples - -``` -/dd ytd ticker:AAPL -``` ---- +--- +########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### +title: ytd +description: OpenBB Discord Command +--- + +# ytd + +This command allows the user to retrieve the stock's year-to-date performance for a particular ticker symbol. It displays the stock's performance over various periods of time, from 5 days to 5 years. + +### Usage + +```python wordwrap +/dd ytd ticker +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| ticker | Stock Ticker | False | None | + + +--- + +## Examples + +``` +/dd ytd ticker:AAPL +``` +--- diff --git a/website/content/bot/reference/discord/economy/calendar.md b/website/content/bot/reference/discord/economy/calendar.md index 3de43eaeea2b..30753455fa5a 100644 --- a/website/content/bot/reference/discord/economy/calendar.md +++ b/website/content/bot/reference/discord/economy/calendar.md @@ -1,32 +1,32 @@ ---- -########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### -title: calendar -description: OpenBB Discord Command ---- - -# calendar - -Displays Economic Calendar of events - -### Usage - -```python wordwrap -/econ calendar -``` - ---- - -## Parameters - -This command has no parameters - - - ---- - -## Examples - -``` -/econ calendar -``` ---- +--- +########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### +title: calendar +description: OpenBB Discord Command +--- + +# calendar + +This command allows the user to retrieve an Economic Calendar for the day, which displays the upcoming economic events along with their expected impact. The Economic Calendar includes a list of key economic indicators such as GDP, inflation, employment, and more, which can provide insight into the future trajectory of the economy. + +### Usage + +```python wordwrap +/econ calendar +``` + +--- + +## Parameters + +This command has no parameters + + + +--- + +## Examples + +``` +/econ calendar +``` +--- diff --git a/website/content/bot/reference/discord/economy/commodities.md b/website/content/bot/reference/discord/economy/commodities.md index e1a5c29e6679..0071c70899a3 100644 --- a/website/content/bot/reference/discord/economy/commodities.md +++ b/website/content/bot/reference/discord/economy/commodities.md @@ -1,32 +1,32 @@ ---- -########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### -title: commodities -description: OpenBB Discord Command ---- - -# commodities - -Futures and commodities overview. - -### Usage - -```python wordwrap -/econ commodities -``` - ---- - -## Parameters - -This command has no parameters - - - ---- - -## Examples - -``` -/econ commodities -``` ---- +--- +########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### +title: commodities +description: OpenBB Discord Command +--- + +# commodities + +This command allows users to quickly and easily retrieve an overview of Futures and commodities. It provides the last price and change for the day. + +### Usage + +```python wordwrap +/econ commodities +``` + +--- + +## Parameters + +This command has no parameters + + + +--- + +## Examples + +``` +/econ commodities +``` +--- diff --git a/website/content/bot/reference/discord/economy/currencies.md b/website/content/bot/reference/discord/economy/currencies.md index d3e522ad1606..854618a46225 100644 --- a/website/content/bot/reference/discord/economy/currencies.md +++ b/website/content/bot/reference/discord/economy/currencies.md @@ -1,32 +1,32 @@ ---- -########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### -title: currencies -description: OpenBB Discord Command ---- - -# currencies - -Currencies overview. - -### Usage - -```python wordwrap -/econ currencies -``` - ---- - -## Parameters - -This command has no parameters - - - ---- - -## Examples - -``` -/econ currencies -``` ---- +--- +########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### +title: currencies +description: OpenBB Discord Command +--- + +# currencies + +This command allows the user to retrieve an overview of all available currencies. It will provide the user with information such as the currency name, price, and change. + +### Usage + +```python wordwrap +/econ currencies +``` + +--- + +## Parameters + +This command has no parameters + + + +--- + +## Examples + +``` +/econ currencies +``` +--- diff --git a/website/content/bot/reference/discord/economy/fedrates.md b/website/content/bot/reference/discord/economy/fedrates.md index 2f7c3e5b667d..1ec1748bb469 100644 --- a/website/content/bot/reference/discord/economy/fedrates.md +++ b/website/content/bot/reference/discord/economy/fedrates.md @@ -1,32 +1,32 @@ ---- -########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### -title: fedrates -description: OpenBB Discord Command ---- - -# fedrates - -Upcoming Federal Rate decision dates and chances - -### Usage - -```python wordwrap -/econ fedrates -``` - ---- - -## Parameters - -This command has no parameters - - - ---- - -## Examples - -``` -/econ fedrates -``` ---- +--- +########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### +title: fedrates +description: OpenBB Discord Command +--- + +# fedrates + +This command allows users to quickly and easily retrieve upcoming Federal Rate decision dates and chances. It is a convenient way to stay up to date with Federal Rate decisions. + +### Usage + +```python wordwrap +/econ fedrates +``` + +--- + +## Parameters + +This command has no parameters + + + +--- + +## Examples + +``` +/econ fedrates +``` +--- diff --git a/website/content/bot/reference/discord/economy/glbonds.md b/website/content/bot/reference/discord/economy/glbonds.md index 35fca4c429a0..d7d43714eb2e 100644 --- a/website/content/bot/reference/discord/economy/glbonds.md +++ b/website/content/bot/reference/discord/economy/glbonds.md @@ -1,32 +1,32 @@ ---- -########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### -title: glbonds -description: OpenBB Discord Command ---- - -# glbonds - -Global bonds overview. - -### Usage - -```python wordwrap -/econ glbonds -``` - ---- - -## Parameters - -This command has no parameters - - - ---- - -## Examples - -``` -/econ glbonds -``` ---- +--- +########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### +title: glbonds +description: OpenBB Discord Command +--- + +# glbonds + +This command allows the user to retrieve an overview of global bonds. It includes information about the type of bond, the rate of return, yield, and yield change. The data is presented in an easy to read format and can be used to inform decisions about investing in global bonds. + +### Usage + +```python wordwrap +/econ glbonds +``` + +--- + +## Parameters + +This command has no parameters + + + +--- + +## Examples + +``` +/econ glbonds +``` +--- diff --git a/website/content/bot/reference/discord/economy/index.mdx b/website/content/bot/reference/discord/economy/index.mdx index 2453d257a1a4..d071282690bc 100644 --- a/website/content/bot/reference/discord/economy/index.mdx +++ b/website/content/bot/reference/discord/economy/index.mdx @@ -6,47 +6,47 @@ import ReferenceCard from "@site/src/components/General/ReferenceCard"; diff --git a/website/content/bot/reference/discord/economy/indices.md b/website/content/bot/reference/discord/economy/indices.md index c73497b49ed4..a2c97b2659e0 100644 --- a/website/content/bot/reference/discord/economy/indices.md +++ b/website/content/bot/reference/discord/economy/indices.md @@ -1,32 +1,32 @@ ---- -########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### -title: indices -description: OpenBB Discord Command ---- - -# indices - -US indices overview. - -### Usage - -```python wordwrap -/econ indices -``` - ---- - -## Parameters - -This command has no parameters - - - ---- - -## Examples - -``` -/econ indices -``` ---- +--- +########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### +title: indices +description: OpenBB Discord Command +--- + +# indices + +This command provides a real-time overview of the major US stock indices, such as the Dow Jones Industrial Average, the S&P 500, and the NASDAQ Composite. It displays the most current index values, as well as the percentage change from the previous day. + +### Usage + +```python wordwrap +/econ indices +``` + +--- + +## Parameters + +This command has no parameters + + + +--- + +## Examples + +``` +/econ indices +``` +--- diff --git a/website/content/bot/reference/discord/economy/revrepo.md b/website/content/bot/reference/discord/economy/revrepo.md index 6c06ca132be7..fd4d0f5e0b24 100644 --- a/website/content/bot/reference/discord/economy/revrepo.md +++ b/website/content/bot/reference/discord/economy/revrepo.md @@ -1,37 +1,37 @@ ---- -########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### -title: revrepo -description: OpenBB Discord Command ---- - -# revrepo - -Displays Reverse Repo. - -### Usage - -```python wordwrap -/econ revrepo [days] -``` - ---- - -## Parameters - -| Name | Description | Optional | Choices | -| ---- | ----------- | -------- | ------- | -| days | Number of days to display. Default: 50 | True | None | - - ---- - -## Examples - -``` -/econ revrepo days:35 -``` - -``` -/econ revrepo -``` ---- +--- +########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### +title: revrepo +description: OpenBB Discord Command +--- + +# revrepo + +This command allows the user to retrieve Reverse Repo data for a default period of 35 days. This data includes information such as the total amount of Reverse Repo, the number of parties, the average, and difference. + +### Usage + +```python wordwrap +/econ revrepo [days] +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| days | Number of days to display. Default: 50 | True | None | + + +--- + +## Examples + +``` +/econ revrepo days:35 +``` + +``` +/econ revrepo +``` +--- diff --git a/website/content/bot/reference/discord/economy/usbonds.md b/website/content/bot/reference/discord/economy/usbonds.md index c5e7c711d54e..2ff808397ebb 100644 --- a/website/content/bot/reference/discord/economy/usbonds.md +++ b/website/content/bot/reference/discord/economy/usbonds.md @@ -1,32 +1,32 @@ ---- -########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### -title: usbonds -description: OpenBB Discord Command ---- - -# usbonds - -US bonds overview. - -### Usage - -```python wordwrap -/econ usbonds -``` - ---- - -## Parameters - -This command has no parameters - - - ---- - -## Examples - -``` -/econ usbonds -``` ---- +--- +########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### +title: usbonds +description: OpenBB Discord Command +--- + +# usbonds + +This command retrieves an overview of US bonds from the 1-Month to 30-Year bonds, providing the user with a list of the most recent bond rates, yields and change. + +### Usage + +```python wordwrap +/econ usbonds +``` + +--- + +## Parameters + +This command has no parameters + + + +--- + +## Examples + +``` +/econ usbonds +``` +--- diff --git a/website/content/bot/reference/discord/economy/yieldcurve.md b/website/content/bot/reference/discord/economy/yieldcurve.md index b5b09e642a5a..4977c0e207aa 100644 --- a/website/content/bot/reference/discord/economy/yieldcurve.md +++ b/website/content/bot/reference/discord/economy/yieldcurve.md @@ -1,30 +1,30 @@ ---- -########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### -title: yieldcurve -description: OpenBB Discord Command ---- - -# yieldcurve - -Displays US Bonds yield curve - -### Usage - -```python wordwrap -/econ yieldcurve -``` - ---- - -## Parameters - -This command has no parameters - ---- - -## Examples - -``` -/econ yieldcurve -``` ---- +--- +########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### +title: yieldcurve +description: OpenBB Discord Command +--- + +# yieldcurve + +This command allows the user to retrieve the US Bonds yield curve. The yield curve is a graph that plots the yields of different bonds with different maturities, providing an indication of the direction of interest rates. + +### Usage + +```python wordwrap +/econ yieldcurve +``` + +--- + +## Parameters + +This command has no parameters + +--- + +## Examples + +``` +/econ yieldcurve +``` +--- diff --git a/website/content/bot/reference/discord/etf/holdings.md b/website/content/bot/reference/discord/etf/holdings.md new file mode 100644 index 000000000000..ca1e97cace59 --- /dev/null +++ b/website/content/bot/reference/discord/etf/holdings.md @@ -0,0 +1,33 @@ +--- +########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### +title: holdings +description: OpenBB Discord Command +--- + +# etf holdings + +This command returns the holdings for an ETF sorted by percent of ETF. + +### Usage + +```python wordwrap +/etf holdings [etf] +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| etf | ETF ticker (only for `holdings`) | True | None | + + +--- + +## Examples + +``` +/etf holdings SPY +``` +--- diff --git a/website/content/bot/reference/discord/etf/index.mdx b/website/content/bot/reference/discord/etf/index.mdx new file mode 100644 index 000000000000..0efeaa587099 --- /dev/null +++ b/website/content/bot/reference/discord/etf/index.mdx @@ -0,0 +1,17 @@ +# etf + +import ReferenceCard from "@site/src/components/General/ReferenceCard"; + +
    + + + +
diff --git a/website/content/bot/reference/discord/etf/tops.md b/website/content/bot/reference/discord/etf/tops.md new file mode 100644 index 000000000000..4f76f41a230f --- /dev/null +++ b/website/content/bot/reference/discord/etf/tops.md @@ -0,0 +1,33 @@ +--- +########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### +title: tops +description: OpenBB Discord Command +--- + +# etf tops + +This command returns the top ETFs for the day - sorted by gainers, losers, or active. + +### Usage + +```python wordwrap +/etf tops [sort] +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| sort | Possible sort options to run. If not provided, defaults to gainers | True | gainers, losers, active | + + +--- + +## Examples + +``` +/etf tops +``` +--- diff --git a/website/content/bot/reference/discord/flow/bigflow.md b/website/content/bot/reference/discord/flow/bigflow.md index a7a044ef42c9..bbf289ef31ec 100644 --- a/website/content/bot/reference/discord/flow/bigflow.md +++ b/website/content/bot/reference/discord/flow/bigflow.md @@ -1,34 +1,34 @@ ---- -########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### -title: bigflow -description: OpenBB Discord Command ---- - -# bigflow - -Returns the top 20 largest flow by premium for a stock - -### Usage - -```python wordwrap -/flow bigflow ticker -``` - ---- - -## Parameters - -| Name | Description | Optional | Choices | -| ---- | ----------- | -------- | ------- | -| ticker | Stock Ticker | False | None | - - ---- - -## Examples - -``` -/flow bigflow ticker:AMD -``` - ---- +--- +########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### +title: bigflow +description: OpenBB Discord Command +--- + +# bigflow + +This command retrieves the top 20 largest flow by premium for a stock. We calculate the largest flow by multiplying the price of the option at the time of the trade by the volume of that trade. + +### Usage + +```python wordwrap +/flow bigflow ticker +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| ticker | Stock Ticker | False | None | + + +--- + +## Examples + +``` +/flow bigflow ticker:AMD +``` + +--- diff --git a/website/content/bot/reference/discord/flow/day.md b/website/content/bot/reference/discord/flow/day.md index 835079ce0563..d75d260527ef 100644 --- a/website/content/bot/reference/discord/flow/day.md +++ b/website/content/bot/reference/discord/flow/day.md @@ -1,45 +1,45 @@ ---- -########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### -title: day -description: OpenBB Discord Command ---- - -# day - -Returns the most recent flow for a stock. - -### Usage - -```python wordwrap -/flow day ticker [expiry] [strike] [opt_type] -``` - ---- - -## Parameters - -| Name | Description | Optional | Choices | -| ---- | ----------- | -------- | ------- | -| ticker | Stock Ticker | False | None | -| expiry | Expiry Date (YYYY-MM-DD) (Optional) | True | None | -| strike | Strike Price (Optional) | True | None | -| opt_type | Option Type (Calls or Puts) (Optional) | True | Calls (C), Puts (P) | - - ---- - -## Examples - -``` -/flow day ticker:AMD -``` - -``` -/flow day ticker:AMD expiry:2022-07-29 strike:60 opt_type:Puts -``` - -``` -/flow day ticker:AMD expiry:2022-07-29 strike:60 -``` - ---- +--- +########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### +title: day +description: OpenBB Discord Command +--- + +# day + +This command retrieves the most recent flow for a stock with the specified ticker symbol. The command will return the most up-to-date flow data for that stock over $25,000. + +### Usage + +```python wordwrap +/flow day ticker [expiry] [strike] [opt_type] +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| ticker | Stock Ticker | False | None | +| expiry | Expiry Date (YYYY-MM-DD) (Optional) | True | None | +| strike | Strike Price (Optional) | True | None | +| opt_type | Option Type (Calls or Puts) (Optional) | True | Calls (C), Puts (P) | + + +--- + +## Examples + +``` +/flow day ticker:AMD +``` + +``` +/flow day ticker:AMD expiry:2022-07-29 strike:60 opt_type:Puts +``` + +``` +/flow day ticker:AMD expiry:2022-07-29 strike:60 +``` + +--- diff --git a/website/content/bot/reference/discord/flow/index.mdx b/website/content/bot/reference/discord/flow/index.mdx index 8ddb10073e02..e8e8c0c58be1 100644 --- a/website/content/bot/reference/discord/flow/index.mdx +++ b/website/content/bot/reference/discord/flow/index.mdx @@ -6,62 +6,62 @@ import ReferenceCard from "@site/src/components/General/ReferenceCard"; diff --git a/website/content/bot/reference/discord/flow/opening.md b/website/content/bot/reference/discord/flow/opening.md index 099d053ac113..821ee85a8b30 100644 --- a/website/content/bot/reference/discord/flow/opening.md +++ b/website/content/bot/reference/discord/flow/opening.md @@ -1,33 +1,33 @@ ---- -########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### -title: opening -description: OpenBB Discord Command ---- - -# opening - -Top 20 flow by Premium for a stock with opening condition - Vol OI - -### Usage - -```python wordwrap -/flow opening ticker -``` - ---- - -## Parameters - -| Name | Description | Optional | Choices | -| ---- | ----------- | -------- | ------- | -| ticker | Stock Ticker | False | None | - - ---- - -## Examples - -``` -/flow opening ticker:AMD -``` ---- +--- +########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### +title: opening +description: OpenBB Discord Command +--- + +# opening + +This command allows the user to retrieve the Top 20 flows by premium for a stock with the "Opening" condition - Volume exceeding Open Interest on the trade. + +### Usage + +```python wordwrap +/flow opening ticker +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| ticker | Stock Ticker | False | None | + + +--- + +## Examples + +``` +/flow opening ticker:AMD +``` +--- diff --git a/website/content/bot/reference/discord/flow/prem.md b/website/content/bot/reference/discord/flow/prem.md index cfa6610288ca..d160a2677653 100644 --- a/website/content/bot/reference/discord/flow/prem.md +++ b/website/content/bot/reference/discord/flow/prem.md @@ -1,34 +1,34 @@ ---- -########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### -title: prem -description: OpenBB Discord Command ---- - -# prem - -Returns a chart with sum of premium per day by call/put - -### Usage - -```python wordwrap -/flow prem ticker -``` - ---- - -## Parameters - -| Name | Description | Optional | Choices | -| ---- | ----------- | -------- | ------- | -| ticker | Stock Ticker | False | None | - - ---- - -## Examples - -``` -/flow prem ticker:AMD -``` - ---- +--- +########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### +title: prem +description: OpenBB Discord Command +--- + +# prem + +This command allows the user to retrieve a chart displaying the sum of premium for call/put options for a particular ticker on a daily basis. This chart will help users quickly and easily visualize the changing premium amounts over time. + +### Usage + +```python wordwrap +/flow prem ticker +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| ticker | Stock Ticker | False | None | + + +--- + +## Examples + +``` +/flow prem ticker:AMD +``` + +--- diff --git a/website/content/bot/reference/discord/flow/sectors.md b/website/content/bot/reference/discord/flow/sectors.md index fdfd68e2ae60..54ac9e71e136 100644 --- a/website/content/bot/reference/discord/flow/sectors.md +++ b/website/content/bot/reference/discord/flow/sectors.md @@ -1,39 +1,39 @@ ---- -########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### -title: sectors -description: OpenBB Discord Command ---- - -# sectors - -Summary of all flow by % of MarketCap by Sector - -### Usage - -```python wordwrap -/flow sectors days sector -``` - ---- - -## Parameters - -| Name | Description | Optional | Choices | -| ---- | ----------- | -------- | ------- | -| days | Number of days to look back | False | None | -| sector | Sector to filter by | False | Basic Materials (BM), Energy (E), Communication Services (CS), Consumer Cyclical (CC), Consumer Defensive (CD), Financial (F), Healthcare (H), Industrials (I), Real Estate (RE), Technology (T), Utilities (U) | - - ---- - -## Examples - -``` -/flow sectors days:5 sector:Energy -``` - -``` -/flow sectors days:2 sector:Communication Services -``` - ---- +--- +########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### +title: sectors +description: OpenBB Discord Command +--- + +# sectors + +This command retrieves a summary of all flows by MarketCap percentage per sector over the past x days. + +### Usage + +```python wordwrap +/flow sectors days sector +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| days | Number of days to look back | False | None | +| sector | Sector to filter by | False | Basic Materials (BM), Energy (E), Communication Services (CS), Consumer Cyclical (CC), Consumer Defensive (CD), Financial (F), Healthcare (H), Industrials (I), Real Estate (RE), Technology (T), Utilities (U) | + + +--- + +## Examples + +``` +/flow sectors days:5 sector:Energy +``` + +``` +/flow sectors days:2 sector:Communication Services +``` + +--- diff --git a/website/content/bot/reference/discord/flow/sumday.md b/website/content/bot/reference/discord/flow/sumday.md index b8dbf52eb9f5..ce215ee77a7a 100644 --- a/website/content/bot/reference/discord/flow/sumday.md +++ b/website/content/bot/reference/discord/flow/sumday.md @@ -1,34 +1,34 @@ ---- -########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### -title: sumday -description: OpenBB Discord Command ---- - -# sumday - -Graph Today's Total Premium of a stock. - -### Usage - -```python wordwrap -/flow sumday ticker -``` - ---- - -## Parameters - -| Name | Description | Optional | Choices | -| ---- | ----------- | -------- | ------- | -| ticker | Stock Ticker | False | None | - - ---- - -## Examples - -``` -/flow sumday ticker:AMD -``` - ---- +--- +########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### +title: sumday +description: OpenBB Discord Command +--- + +# sumday + +This command allows the user to retrieve the total premium of the given stock ticker for the current trading day. We categorize the calls and puts by where the trade occurred on the bid/ask. For example, Above Ask, means the trade happened over the current Ask price. + +### Usage + +```python wordwrap +/flow sumday ticker +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| ticker | Stock Ticker | False | None | + + +--- + +## Examples + +``` +/flow sumday ticker:AMD +``` + +--- diff --git a/website/content/bot/reference/discord/flow/sumexp.md b/website/content/bot/reference/discord/flow/sumexp.md index 621d2dad9f00..97b9f8e2bb39 100644 --- a/website/content/bot/reference/discord/flow/sumexp.md +++ b/website/content/bot/reference/discord/flow/sumexp.md @@ -1,35 +1,35 @@ ---- -########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### -title: sumexp -description: OpenBB Discord Command ---- - -# sumexp - -Flow summary by expiration date. - -### Usage - -```python wordwrap -/flow sumexp ticker expiry -``` - ---- - -## Parameters - -| Name | Description | Optional | Choices | -| ---- | ----------- | -------- | ------- | -| ticker | Stock Ticker | False | None | -| expiry | Expiration Date | False | None | - - ---- - -## Examples - -``` -/flow sumexp ticker:AMD expiry:2022-07-29 -``` - ---- +--- +########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### +title: sumexp +description: OpenBB Discord Command +--- + +# sumexp + +This command allows the user to retrieve the total premium of the given stock ticker for the current trading day by expiration. We categorize the calls and puts by where the trade occurred on the bid/ask. For example, Above Ask, means the trade happened over the current Ask price. + +### Usage + +```python wordwrap +/flow sumexp ticker expiry +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| ticker | Stock Ticker | False | None | +| expiry | Expiration Date | False | None | + + +--- + +## Examples + +``` +/flow sumexp ticker:AMD expiry:2022-07-29 +``` + +--- diff --git a/website/content/bot/reference/discord/flow/summary.md b/website/content/bot/reference/discord/flow/summary.md index bf2118e0173f..730438e357d1 100644 --- a/website/content/bot/reference/discord/flow/summary.md +++ b/website/content/bot/reference/discord/flow/summary.md @@ -1,39 +1,39 @@ ---- -########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### -title: summary -description: OpenBB Discord Command ---- - -# summary - -Summary of all flow by % of MarketCap - -### Usage - -```python wordwrap -/flow summary days sort -``` - ---- - -## Parameters - -| Name | Description | Optional | Choices | -| ---- | ----------- | -------- | ------- | -| days | Number of days to look back | False | None | -| sort | Sort by MarketCap, Float, Total, or Short Percentage | False | MarketCap (mc), Float (float), Total (sum), Short Percentage (short) | - - ---- - -## Examples - -``` -/flow summary days:5 sort:Float -``` - -``` -/flow summary days:5 sort:Short Percentage -``` - ---- +--- +########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### +title: summary +description: OpenBB Discord Command +--- + +# summary + +This command allows the user to retrieve a summary of all the flow per stock over the last x days, with the result sorted in various ways. This summary will include the ratio to total market capitalization, the number of trades, and other information. + +### Usage + +```python wordwrap +/flow summary days sort +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| days | Number of days to look back | False | None | +| sort | Sort by MarketCap, Float, Total, or Short Percentage | False | MarketCap (mc), Float (float), Total (sum), Short Percentage (short) | + + +--- + +## Examples + +``` +/flow summary days:5 sort:Float +``` + +``` +/flow summary days:5 sort:Short Percentage +``` + +--- diff --git a/website/content/bot/reference/discord/flow/sumtop.md b/website/content/bot/reference/discord/flow/sumtop.md index 2638c49b0dc8..af55fdee9182 100644 --- a/website/content/bot/reference/discord/flow/sumtop.md +++ b/website/content/bot/reference/discord/flow/sumtop.md @@ -1,33 +1,33 @@ ---- -########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### -title: sumtop -description: OpenBB Discord Command ---- - -# sumtop - -Top flow for the day Calls vs Puts by stock. - -### Usage - -```python wordwrap -/flow sumtop -``` - ---- - -## Parameters - -This command has no parameters - - - ---- - -## Examples - -``` -/flow sumtop -``` - ---- +--- +########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### +title: sumtop +description: OpenBB Discord Command +--- + +# sumtop + +This command allows the user to retrieve the top flow for the day for Calls and Puts by stock. This will provide the user with an overview of the market's current sentiment towards a particular stock as well as an overall view of the market's sentiment towards all stocks. + +### Usage + +```python wordwrap +/flow sumtop +``` + +--- + +## Parameters + +This command has no parameters + + + +--- + +## Examples + +``` +/flow sumtop +``` + +--- diff --git a/website/content/bot/reference/discord/flow/sumweek.md b/website/content/bot/reference/discord/flow/sumweek.md index fd407b62b76b..6ef84401248b 100644 --- a/website/content/bot/reference/discord/flow/sumweek.md +++ b/website/content/bot/reference/discord/flow/sumweek.md @@ -1,34 +1,34 @@ ---- -########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### -title: sumweek -description: OpenBB Discord Command ---- - -# sumweek - -Graph Total Premium weekly summary of a stock. - -### Usage - -```python wordwrap -/flow sumweek ticker -``` - ---- - -## Parameters - -| Name | Description | Optional | Choices | -| ---- | ----------- | -------- | ------- | -| ticker | Stock Ticker | False | None | - - ---- - -## Examples - -``` -/flow sumweek ticker:AMD -``` - ---- +--- +########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### +title: sumweek +description: OpenBB Discord Command +--- + +# sumweek + +This command allows the user to retrieve the top flow for the week for Calls and Puts by stock. This will provide the user with an overview of the market's current sentiment towards a particular stock as well as an overall view of the market's sentiment towards all stocks. + +### Usage + +```python wordwrap +/flow sumweek ticker +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| ticker | Stock Ticker | False | None | + + +--- + +## Examples + +``` +/flow sumweek ticker:AMD +``` + +--- diff --git a/website/content/bot/reference/discord/flow/unu.md b/website/content/bot/reference/discord/flow/unu.md index de41d9365631..40ad07e69455 100644 --- a/website/content/bot/reference/discord/flow/unu.md +++ b/website/content/bot/reference/discord/flow/unu.md @@ -1,33 +1,33 @@ ---- -########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### -title: unu -description: OpenBB Discord Command ---- - -# unu - -Unusual Options Trades over 100k Prem. - Vol OI - -### Usage - -```python wordwrap -/flow unu -``` - ---- - -## Parameters - -This command has no parameters - - - ---- - -## Examples - -``` -/flow unu -``` - ---- +--- +########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### +title: unu +description: OpenBB Discord Command +--- + +# unu + +This command allows users to retrieve Unusual Options Trades over $100,000 premium and Total Volume exceeding Open Interest. This data can be used to identify potential opportunities in the options market allowing users to quickly and easily identify potential unusual activity. + +### Usage + +```python wordwrap +/flow unu +``` + +--- + +## Parameters + +This command has no parameters + + + +--- + +## Examples + +``` +/flow unu +``` + +--- diff --git a/website/content/bot/reference/discord/flow/weekly.md b/website/content/bot/reference/discord/flow/weekly.md index f09848700061..e58f5b8753ae 100644 --- a/website/content/bot/reference/discord/flow/weekly.md +++ b/website/content/bot/reference/discord/flow/weekly.md @@ -1,34 +1,34 @@ ---- -########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### -title: weekly -description: OpenBB Discord Command ---- - -# weekly - -Top 20 flow by Premium for a stock with weekly expiration. - -### Usage - -```python wordwrap -/flow weekly ticker -``` - ---- - -## Parameters - -| Name | Description | Optional | Choices | -| ---- | ----------- | -------- | ------- | -| ticker | Stock Ticker | False | None | - - ---- - -## Examples - -``` -/flow weekly ticker:AMD -``` - ---- +--- +########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### +title: weekly +description: OpenBB Discord Command +--- + +# weekly + +This command allows the user to retrieve the Top 20 flow by Premium for a stock with an option contact expiring that week. + +### Usage + +```python wordwrap +/flow weekly ticker +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| ticker | Stock Ticker | False | None | + + +--- + +## Examples + +``` +/flow weekly ticker:AMD +``` + +--- diff --git a/website/content/bot/reference/discord/fun/8ball.md b/website/content/bot/reference/discord/fun/8ball.md index 7aa64b9a7c0b..55eb8ead3166 100644 --- a/website/content/bot/reference/discord/fun/8ball.md +++ b/website/content/bot/reference/discord/fun/8ball.md @@ -1,34 +1,34 @@ ---- -########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### -title: 8ball -description: OpenBB Discord Command ---- - -# 8ball - -Ask 8 ball a question. - -### Usage - -```python wordwrap -/fun 8ball question -``` - ---- - -## Parameters - -| Name | Description | Optional | Choices | -| ---- | ----------- | -------- | ------- | -| question | Question to ask the 8 ball (must end with a question mark) | False | None | - - ---- - -## Examples - -``` -/fun 8ball question:Will I make money today? -``` - ---- +--- +########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### +title: 8ball +description: OpenBB Discord Command +--- + +# 8ball + +This command allows the user to ask the 8-ball a question and receive an answer. The question must end in a question mark. + +### Usage + +```python wordwrap +/fun 8ball question +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| question | Question to ask the 8 ball (must end with a question mark) | False | None | + + +--- + +## Examples + +``` +/fun 8ball question:Will I make money today? +``` + +--- diff --git a/website/content/bot/reference/discord/fun/flip.md b/website/content/bot/reference/discord/fun/flip.md index 6942e8f90f7b..e9d5d0ebb1c8 100644 --- a/website/content/bot/reference/discord/fun/flip.md +++ b/website/content/bot/reference/discord/fun/flip.md @@ -1,33 +1,33 @@ ---- -########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### -title: flip -description: OpenBB Discord Command ---- - -# flip - -Flip a coin for your witcher - -### Usage - -```python wordwrap -/fun flip -``` - ---- - -## Parameters - -This command has no parameters - - - ---- - -## Examples - -``` -/fun flip -``` - ---- +--- +########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### +title: flip +description: OpenBB Discord Command +--- + +# flip + +This command allows the user to simulate a coin flip displaying either a 'Heads' or 'Tails'. + +### Usage + +```python wordwrap +/fun flip +``` + +--- + +## Parameters + +This command has no parameters + + + +--- + +## Examples + +``` +/fun flip +``` + +--- diff --git a/website/content/bot/reference/discord/fun/index.mdx b/website/content/bot/reference/discord/fun/index.mdx index cb6988b11f8f..d3c5280e3268 100644 --- a/website/content/bot/reference/discord/fun/index.mdx +++ b/website/content/bot/reference/discord/fun/index.mdx @@ -6,17 +6,17 @@ import ReferenceCard from "@site/src/components/General/ReferenceCard"; diff --git a/website/content/bot/reference/discord/fun/urban.md b/website/content/bot/reference/discord/fun/urban.md index d4f27a682b4b..4e158ecd51d8 100644 --- a/website/content/bot/reference/discord/fun/urban.md +++ b/website/content/bot/reference/discord/fun/urban.md @@ -1,34 +1,34 @@ ---- -########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### -title: urban -description: OpenBB Discord Command ---- - -# urban - -Searches on the Urban Dictionary. - -### Usage - -```python wordwrap -/fun urban word -``` - ---- - -## Parameters - -| Name | Description | Optional | Choices | -| ---- | ----------- | -------- | ------- | -| word | The word or words to search for. | False | None | - - ---- - -## Examples - -``` -/fun urban word:Shill -``` - ---- +--- +########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### +title: urban +description: OpenBB Discord Command +--- + +# urban + +This command allows the user to search for a definition of a word on Urban Dictionary. + +### Usage + +```python wordwrap +/fun urban word +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| word | The word or words to search for. | False | None | + + +--- + +## Examples + +``` +/fun urban word:Shill +``` + +--- diff --git a/website/content/bot/reference/discord/general/futures.md b/website/content/bot/reference/discord/general/futures.md index fcea4dd782d3..3b205ccea5ef 100644 --- a/website/content/bot/reference/discord/general/futures.md +++ b/website/content/bot/reference/discord/general/futures.md @@ -6,7 +6,7 @@ description: OpenBB Discord Command # futures -Displays Futures. +This command allows the user to retrieve futures prices on the stock market. ### Usage diff --git a/website/content/bot/reference/discord/general/heatchart.md b/website/content/bot/reference/discord/general/heatchart.md index 209a5d14688d..77cd9ad76a2d 100644 --- a/website/content/bot/reference/discord/general/heatchart.md +++ b/website/content/bot/reference/discord/general/heatchart.md @@ -6,7 +6,7 @@ description: OpenBB Discord Command # heatchart -Daily Market Heat Chart - 15m Delayed +This command allows the user to retrieve a Daily Market Heat Chart (15 minute delayed). The heat chart shows a graphical representation of the performance of the market by sector for that day, with different colors indicating different levels of performance. ### Usage @@ -20,8 +20,6 @@ Daily Market Heat Chart - 15m Delayed This command has no parameters - - --- ## Examples diff --git a/website/content/bot/reference/discord/general/heatmap.md b/website/content/bot/reference/discord/general/heatmap.md index cf44f8210b20..2d77ba0318ac 100644 --- a/website/content/bot/reference/discord/general/heatmap.md +++ b/website/content/bot/reference/discord/general/heatmap.md @@ -6,7 +6,7 @@ description: OpenBB Discord Command # heatmap -Daily Heat Maps by Market. Sector is optional. +This command allows the user to retrieve Daily Heat Maps by Market and Sector. The Daily Heat Maps will allow the user a quick overview of current stock market performance. ### Usage diff --git a/website/content/bot/reference/discord/general/index.mdx b/website/content/bot/reference/discord/general/index.mdx index 3ab147103bef..ef68ba6f3402 100644 --- a/website/content/bot/reference/discord/general/index.mdx +++ b/website/content/bot/reference/discord/general/index.mdx @@ -6,42 +6,42 @@ import ReferenceCard from "@site/src/components/General/ReferenceCard"; diff --git a/website/content/bot/reference/discord/general/markets.md b/website/content/bot/reference/discord/general/markets.md index 37dd7f46284e..f2c5de1d58fd 100644 --- a/website/content/bot/reference/discord/general/markets.md +++ b/website/content/bot/reference/discord/general/markets.md @@ -6,7 +6,7 @@ description: OpenBB Discord Command # markets -Displays markets overview +This command allows the user to retrieve a markets overview which provides a quick summary of current market conditions. The overview includes prices of the largest ETFs, with the amount of stocks current above and below the SMA 200/50 and Advancers / Decliners. ### Usage diff --git a/website/content/bot/reference/discord/general/news.md b/website/content/bot/reference/discord/general/news.md index 676c1950acd7..1790e352daa1 100644 --- a/website/content/bot/reference/discord/general/news.md +++ b/website/content/bot/reference/discord/general/news.md @@ -6,7 +6,7 @@ description: OpenBB Discord Command # news -Display the most recent news for ticker +This command allows the user to retrieve the latest news for a given ticker. ### Usage diff --git a/website/content/bot/reference/discord/general/quote.md b/website/content/bot/reference/discord/general/quote.md index 372010c676e1..a110c484e0e9 100644 --- a/website/content/bot/reference/discord/general/quote.md +++ b/website/content/bot/reference/discord/general/quote.md @@ -6,7 +6,7 @@ description: OpenBB Discord Command # quote -Display quote stats for a stock, 52 week high/low, market cap/float, and 200/50 day MA +This command allows the user to retrieve display quote stats for a stock - including the 52 week high/low, market cap/float, and 200/50 day moving averages. The command allows you to quickly and easily access the requested quote stats for the given stock. ### Usage diff --git a/website/content/bot/reference/discord/general/ta.md b/website/content/bot/reference/discord/general/ta.md index 9649d1a7131d..9c9d2c4b3d7a 100644 --- a/website/content/bot/reference/discord/general/ta.md +++ b/website/content/bot/reference/discord/general/ta.md @@ -6,7 +6,7 @@ description: OpenBB Discord Command # ta -Displays a given stocks Technical Analysis summary. +This command allows the user to retrieve a technical analysis summary for a given stock ticker. The summary includes several indicators such as moving averages, fibonacci levels, support and resistance levels, and other technical metrics. ### Usage diff --git a/website/content/bot/reference/discord/general/watchlist.md b/website/content/bot/reference/discord/general/watchlist.md index 5d8d1866a5c5..d6b5ee9256de 100644 --- a/website/content/bot/reference/discord/general/watchlist.md +++ b/website/content/bot/reference/discord/general/watchlist.md @@ -6,7 +6,7 @@ description: OpenBB Discord Command # watchlist -Displays markets overview +This command allows the user to retrieve an overview of their watchlist, which includes the current price, high/low, volume, and change. You can also get other related information with a quick click like flow, darkpool data, technical analysis, and news - all from one spot. ### Usage diff --git a/website/content/bot/reference/discord/government/contracts.md b/website/content/bot/reference/discord/government/contracts.md index f3a0b4408139..0fe56ec96a59 100644 --- a/website/content/bot/reference/discord/government/contracts.md +++ b/website/content/bot/reference/discord/government/contracts.md @@ -1,34 +1,34 @@ ---- -########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### -title: contracts -description: OpenBB Discord Command ---- - -# contracts - -Displays Top 15 Government contracts by amount for all tickers or for a specific ticker. - -### Usage - -```python wordwrap -/gov contracts [ticker] -``` - ---- - -## Parameters - -| Name | Description | Optional | Choices | -| ---- | ----------- | -------- | ------- | -| ticker | Stock Ticker (optional) | True | None | - - ---- - -## Examples - -``` -/gov contracts ticker:GE -``` - ---- +--- +########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### +title: contracts +description: OpenBB Discord Command +--- + +# contracts + +This command will allow the user to retrieve the top 15 government contracts by amount for a specific ticker. + +### Usage + +```python wordwrap +/gov contracts [ticker] +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| ticker | Stock Ticker (optional) | True | None | + + +--- + +## Examples + +``` +/gov contracts ticker:GE +``` + +--- diff --git a/website/content/bot/reference/discord/government/house.md b/website/content/bot/reference/discord/government/house.md index 5d8dec9f521f..4f21c978627b 100644 --- a/website/content/bot/reference/discord/government/house.md +++ b/website/content/bot/reference/discord/government/house.md @@ -1,34 +1,34 @@ ---- -########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### -title: house -description: OpenBB Discord Command ---- - -# house - -Displays recent house trades for all tickers or a specific ticker. - -### Usage - -```python wordwrap -/gov house [ticker] -``` - ---- - -## Parameters - -| Name | Description | Optional | Choices | -| ---- | ----------- | -------- | ------- | -| ticker | Stock Ticker (optional) | True | None | - - ---- - -## Examples - -``` -/gov house ticker:GE -``` - ---- +--- +########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### +title: house +description: OpenBB Discord Command +--- + +# house + +This command allows the user to retrieve recent house trades for a specific ticker. + +### Usage + +```python wordwrap +/gov house [ticker] +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| ticker | Stock Ticker (optional) | True | None | + + +--- + +## Examples + +``` +/gov house ticker:GE +``` + +--- diff --git a/website/content/bot/reference/discord/government/index.mdx b/website/content/bot/reference/discord/government/index.mdx index 6804a9e1acec..990dad421e13 100644 --- a/website/content/bot/reference/discord/government/index.mdx +++ b/website/content/bot/reference/discord/government/index.mdx @@ -6,17 +6,17 @@ import ReferenceCard from "@site/src/components/General/ReferenceCard"; diff --git a/website/content/bot/reference/discord/government/senate.md b/website/content/bot/reference/discord/government/senate.md index 8e48824e0708..5df1677acf98 100644 --- a/website/content/bot/reference/discord/government/senate.md +++ b/website/content/bot/reference/discord/government/senate.md @@ -1,34 +1,34 @@ ---- -########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### -title: senate -description: OpenBB Discord Command ---- - -# senate - -Displays recent senate trades for all tickers or for a specific ticker - -### Usage - -```python wordwrap -/gov senate [ticker] -``` - ---- - -## Parameters - -| Name | Description | Optional | Choices | -| ---- | ----------- | -------- | ------- | -| ticker | Stock Ticker (optional) | True | None | - - ---- - -## Examples - -``` -/gov senate ticker:GE -``` - ---- +--- +########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### +title: senate +description: OpenBB Discord Command +--- + +# senate + +This command allows a user to view the recent trades of senate members for a specific ticker. + +### Usage + +```python wordwrap +/gov senate [ticker] +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| ticker | Stock Ticker (optional) | True | None | + + +--- + +## Examples + +``` +/gov senate ticker:GE +``` + +--- diff --git a/website/content/bot/reference/discord/index.mdx b/website/content/bot/reference/discord/index.mdx index e36771be6679..894b027fe444 100644 --- a/website/content/bot/reference/discord/index.mdx +++ b/website/content/bot/reference/discord/index.mdx @@ -44,6 +44,11 @@ import ReferenceCard from "@site/src/components/General/ReferenceCard"; description="calendar commodities currencies fedrates glbonds indices revrepo usbonds yieldcurve" url="/bot/reference/discord/economy" /> + diff --git a/website/content/bot/reference/discord/info/serverid.md b/website/content/bot/reference/discord/info/serverid.md index c9994c087a56..859261864dab 100644 --- a/website/content/bot/reference/discord/info/serverid.md +++ b/website/content/bot/reference/discord/info/serverid.md @@ -1,33 +1,33 @@ ---- -########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### -title: serverid -description: OpenBB Discord Command ---- - -# serverid - -Responds with Server ID - -### Usage - -```python wordwrap -/info serverid -``` - ---- - -## Parameters - -This command has no parameters - - - ---- - -## Examples - -``` -/info serverid -``` - ---- +--- +########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### +title: serverid +description: OpenBB Discord Command +--- + +# serverid + +This command allows the user to retrieve the Server ID of discord room. The Server ID is a unique identifier associated with the server and is needed for some autoposting features when you link your account. + +### Usage + +```python wordwrap +/info serverid +``` + +--- + +## Parameters + +This command has no parameters + + + +--- + +## Examples + +``` +/info serverid +``` + +--- diff --git a/website/content/bot/reference/discord/info/stats.md b/website/content/bot/reference/discord/info/stats.md index 0cf00d65b0eb..3d8e82770596 100644 --- a/website/content/bot/reference/discord/info/stats.md +++ b/website/content/bot/reference/discord/info/stats.md @@ -1,31 +1,31 @@ ---- -########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### -title: stats -description: OpenBB Discord Command ---- - -# stats - -Bot Stats - -### Usage - -```python wordwrap -/info stats -``` - ---- - -## Parameters - -This command has no parameters - ---- - -## Examples - -``` -/info stats -``` - ---- +--- +########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### +title: stats +description: OpenBB Discord Command +--- + +# stats + +This command allows the user to retrieve the current number of servers the bot is in. + +### Usage + +```python wordwrap +/info stats +``` + +--- + +## Parameters + +This command has no parameters + +--- + +## Examples + +``` +/info stats +``` + +--- diff --git a/website/content/bot/reference/discord/info/support.md b/website/content/bot/reference/discord/info/support.md index 2fd85f2ea78b..d9ed314f8f47 100644 --- a/website/content/bot/reference/discord/info/support.md +++ b/website/content/bot/reference/discord/info/support.md @@ -1,31 +1,31 @@ ---- -########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### -title: support -description: OpenBB Discord Command ---- - -# support - -Send support ticket! - -### Usage - -```python wordwrap -/info support -``` - ---- - -## Parameters - -This command has no parameters - ---- - -## Examples - -``` -/info support -``` - ---- +--- +########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### +title: support +description: OpenBB Discord Command +--- + +# support + +This command allows the user to send a support ticket directly to our team. + +### Usage + +```python wordwrap +/info support +``` + +--- + +## Parameters + +This command has no parameters + +--- + +## Examples + +``` +/info support +``` + +--- diff --git a/website/content/bot/reference/discord/nft/chart.md b/website/content/bot/reference/discord/nft/chart.md index 42449834c151..5a6fcd5c075d 100644 --- a/website/content/bot/reference/discord/nft/chart.md +++ b/website/content/bot/reference/discord/nft/chart.md @@ -1,38 +1,38 @@ ---- -########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### -title: chart -description: OpenBB Discord Command ---- - -# chart - -Charts NFT Collection Data - -### Usage - -```python wordwrap -/nft chart slug -``` - ---- - -## Parameters - -| Name | Description | Optional | Choices | -| ---- | ----------- | -------- | ------- | -| slug | NFT collection slug (e.g., cryptopunks) | False | None | - - ---- - -## Examples - -``` -/nft chart slug: bent -``` - -``` -/nft chart slug: bored-ape-yacht-club -``` - ---- +--- +########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### +title: chart +description: OpenBB Discord Command +--- + +# chart + +This command allows the user to retrieve the NFT Collection Data related to the specified slug. The chart will show the floor price over time and sales count. + +### Usage + +```python wordwrap +/nft chart slug +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| slug | NFT collection slug (e.g., cryptopunks) | False | None | + + +--- + +## Examples + +``` +/nft chart slug: bent +``` + +``` +/nft chart slug: bored-ape-yacht-club +``` + +--- diff --git a/website/content/bot/reference/discord/nft/collection.md b/website/content/bot/reference/discord/nft/collection.md index 7a5d116d8c98..925b6db813b5 100644 --- a/website/content/bot/reference/discord/nft/collection.md +++ b/website/content/bot/reference/discord/nft/collection.md @@ -1,34 +1,34 @@ ---- -########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### -title: collection -description: OpenBB Discord Command ---- - -# collection - -Get NFT Collection Data - -### Usage - -```python wordwrap -/nft collection slug -``` - ---- - -## Parameters - -| Name | Description | Optional | Choices | -| ---- | ----------- | -------- | ------- | -| slug | NFT collection slug (e.g., cryptopunks) | False | None | - - ---- - -## Examples - -``` -/nft collection slug: bent -``` - ---- +--- +########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### +title: collection +description: OpenBB Discord Command +--- + +# collection + +This command retrieves a collection of Non-Fungible Token (NFT) data associated with the specified slug. It returns the collection's metadata, including the owner, the number of items in the collection, the total NFTs minted, and various other data on the NFT. + +### Usage + +```python wordwrap +/nft collection slug +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| slug | NFT collection slug (e.g., cryptopunks) | False | None | + + +--- + +## Examples + +``` +/nft collection slug: bent +``` + +--- diff --git a/website/content/bot/reference/discord/nft/index.mdx b/website/content/bot/reference/discord/nft/index.mdx index 8c54edd216c4..896dc758e6bf 100644 --- a/website/content/bot/reference/discord/nft/index.mdx +++ b/website/content/bot/reference/discord/nft/index.mdx @@ -6,17 +6,17 @@ import ReferenceCard from "@site/src/components/General/ReferenceCard"; diff --git a/website/content/bot/reference/discord/nft/top.md b/website/content/bot/reference/discord/nft/top.md index 21ef69378f6a..3082fdc53972 100644 --- a/website/content/bot/reference/discord/nft/top.md +++ b/website/content/bot/reference/discord/nft/top.md @@ -1,40 +1,40 @@ ---- -########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### -title: top -description: OpenBB Discord Command ---- - -# top - -Get Top NFT Collections from Ethereum - -### Usage - -```python wordwrap -/nft top [sortby] [interval] [reverse] -``` - ---- - -## Parameters - -| Name | Description | Optional | Choices | -| ---- | ----------- | -------- | ------- | -| sortby | Column to sort by (default: Market Cap) | True | Market Cap (MCap), Floor Price Change (Floor Price) | -| interval | Time interval to display Sales/Volume/Floor Price (default: 1d) | True | 1d, 7d, 30d, 90d | -| reverse | Reverse the sort order (default: No) | True | Yes | - - ---- - -## Examples - -``` -/nft top -``` - -``` -/nft top sortby: Market Cap reverse: Yes -``` - ---- +--- +########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### +title: top +description: OpenBB Discord Command +--- + +# top + +This command allows users to retrieve the top NFT collections from Ethereum. It provides a list of the most popular and valuable NFT collections, helping users to keep abreast of the latest trends in the NFT space. + +### Usage + +```python wordwrap +/nft top [sortby] [interval] [reverse] +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| sortby | Column to sort by (default: Market Cap) | True | Market Cap (MCap), Floor Price Change (Floor Price) | +| interval | Time interval to display Sales/Volume/Floor Price (default: 1d) | True | 1d, 7d, 30d, 90d | +| reverse | Reverse the sort order (default: No) | True | Yes | + + +--- + +## Examples + +``` +/nft top +``` + +``` +/nft top sortby: Market Cap reverse: Yes +``` + +--- diff --git a/website/content/bot/reference/discord/options/chains.md b/website/content/bot/reference/discord/options/chains.md index 13802dc8fcb4..ca005490d357 100644 --- a/website/content/bot/reference/discord/options/chains.md +++ b/website/content/bot/reference/discord/options/chains.md @@ -1,42 +1,42 @@ ---- -########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### -title: chains -description: OpenBB Discord Command ---- - -# chains - -Displays Options Chain by Expiry. - -### Usage - -```python wordwrap -/op chains ticker expiry opt_type [min_sp] [max_sp] -``` - ---- - -## Parameters - -| Name | Description | Optional | Choices | -| ---- | ----------- | -------- | ------- | -| ticker | Stock Ticker | False | None | -| expiry | Expiration Date | False | None | -| opt_type | Calls or Puts | False | Calls, Puts | -| min_sp | Minimum Strike Price | True | None | -| max_sp | Maximum Strike Price | True | None | - - ---- - -## Examples - -``` -/op chains ticker:AMD expiry:2022-07-29 opt_type:Calls -``` - -``` -/op chains ticker:AMD expiry:2022-07-29 opt_type:Calls min_sp:10 max_sp:100 -``` - ---- +--- +########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### +title: chains +description: OpenBB Discord Command +--- + +# chains + +This command allows users to retrieve Options Chain by Expiry, which gives an overview of the bid, ask, and open interest of options contracts for a specific stock. + +### Usage + +```python wordwrap +/op chains ticker expiry opt_type [min_sp] [max_sp] +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| ticker | Stock Ticker | False | None | +| expiry | Expiration Date | False | None | +| opt_type | Calls or Puts | False | Calls, Puts | +| min_sp | Minimum Strike Price | True | None | +| max_sp | Maximum Strike Price | True | None | + + +--- + +## Examples + +``` +/op chains ticker:AMD expiry:2022-07-29 opt_type:Calls +``` + +``` +/op chains ticker:AMD expiry:2022-07-29 opt_type:Calls min_sp:10 max_sp:100 +``` + +--- diff --git a/website/content/bot/reference/discord/options/equitypc.md b/website/content/bot/reference/discord/options/equitypc.md index 72fbeca62cd1..9496281329bc 100644 --- a/website/content/bot/reference/discord/options/equitypc.md +++ b/website/content/bot/reference/discord/options/equitypc.md @@ -1,33 +1,33 @@ ---- -########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### -title: equitypc -description: OpenBB Discord Command ---- - -# equitypc - -Displays the Equity Put/Call Volume Ratio - from market-harmonics.com - -### Usage - -```python wordwrap -/op equitypc -``` - ---- - -## Parameters - -This command has no parameters - - - ---- - -## Examples - -``` -/op equitypc -``` - ---- +--- +########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### +title: equitypc +description: OpenBB Discord Command +--- + +# equitypc + +This command retrieves the Equity Put/Call Volume Ratio from market-harmonics.com. This ratio is used to measure the demand for puts versus calls in the equity market and can be a useful tool for traders to help gauge market sentiment. + +### Usage + +```python wordwrap +/op equitypc +``` + +--- + +## Parameters + +This command has no parameters + + + +--- + +## Examples + +``` +/op equitypc +``` + +--- diff --git a/website/content/bot/reference/discord/options/gamma.md b/website/content/bot/reference/discord/options/gamma.md index 87432d17a9e1..45b898586139 100644 --- a/website/content/bot/reference/discord/options/gamma.md +++ b/website/content/bot/reference/discord/options/gamma.md @@ -1,39 +1,39 @@ ---- -########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### -title: gamma -description: OpenBB Discord Command ---- - -# gamma - -Displays Options Gamma Levels for a Stock. - -### Usage - -```python wordwrap -/op gamma ticker [expiry] -``` - ---- - -## Parameters - -| Name | Description | Optional | Choices | -| ---- | ----------- | -------- | ------- | -| ticker | Stock Ticker | False | None | -| expiry | Gamma from now until expiry | True | None | - - ---- - -## Examples - -``` -/op gamma ticker:AMD -``` - -``` -/op gamma ticker:AMD expiry:2022-07-29 -``` - ---- +--- +########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### +title: gamma +description: OpenBB Discord Command +--- + +# gamma + +This command allows the user to view the Options Gamma Levels for a particular stock. Options Gamma Levels are important to understanding the rate of change for the option's Delta when the underlying stock price changes. Knowing this information can help traders make informed decisions about which options to purchase. + +### Usage + +```python wordwrap +/op gamma ticker [expiry] +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| ticker | Stock Ticker | False | None | +| expiry | Gamma from now until expiry | True | None | + + +--- + +## Examples + +``` +/op gamma ticker:AMD +``` + +``` +/op gamma ticker:AMD expiry:2022-07-29 +``` + +--- diff --git a/website/content/bot/reference/discord/options/highiv.md b/website/content/bot/reference/discord/options/highiv.md index 0a607b8bb434..c3a4aca188b2 100644 --- a/website/content/bot/reference/discord/options/highiv.md +++ b/website/content/bot/reference/discord/options/highiv.md @@ -1,33 +1,33 @@ ---- -########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### -title: highiv -description: OpenBB Discord Command ---- - -# highiv - -Top 15 Highest IV30 Equity stocks. - -### Usage - -```python wordwrap -/op highiv -``` - ---- - -## Parameters - -This command has no parameters - - - ---- - -## Examples - -``` -/op highiv -``` - ---- +--- +########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### +title: highiv +description: OpenBB Discord Command +--- + +# highiv + +This command retrieves the 15 highest IV30 equity stocks by 30 day Implied Volatility. The IV30 metric is a measure of the expected volatility of a stock over the next 30 days. This command is ideal for users looking to make investments with high potential return and is useful for traders looking to capitalize on market movements. + +### Usage + +```python wordwrap +/op highiv +``` + +--- + +## Parameters + +This command has no parameters + + + +--- + +## Examples + +``` +/op highiv +``` + +--- diff --git a/website/content/bot/reference/discord/options/hist.md b/website/content/bot/reference/discord/options/hist.md index a5db515196b4..2c06e6d561cb 100644 --- a/website/content/bot/reference/discord/options/hist.md +++ b/website/content/bot/reference/discord/options/hist.md @@ -1,43 +1,43 @@ ---- -########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### -title: hist -description: OpenBB Discord Command ---- - -# hist - -Displays Options Price History in a chart. - -### Usage - -```python wordwrap -/op hist ticker expiry strike opt_type interval [past_days] -``` - ---- - -## Parameters - -| Name | Description | Optional | Choices | -| ---- | ----------- | -------- | ------- | -| ticker | Stock Ticker | False | None | -| expiry | Expiration Date YYYY-MM-DD format | False | None | -| strike | Option Strike Price | False | None | -| opt_type | Calls or Puts | False | Calls, Puts | -| interval | Chart Minute Interval, 1440 for Daily | False | 15 (15), 30 (30), 60 (60), 1440 (1440) | -| past_days | Past Days to Display. Default: 5 | True | None | - - ---- - -## Examples - -``` -/op hist ticker:AMD expiry:2022-07-29 strike:80 opt_type:Calls interval:15 past_days:5 -``` - -``` -/op hist ticker:AMD expiry:2022-07-29 strike:80 opt_type:Calls interval:15 -``` - ---- +--- +########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### +title: hist +description: OpenBB Discord Command +--- + +# hist + +This command allows the user to retrieve the historical price of options for the given parameters of a ticker, expiry, strike , option type, and interval for the past x days in a chart format. + +### Usage + +```python wordwrap +/op hist ticker expiry strike opt_type interval [past_days] +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| ticker | Stock Ticker | False | None | +| expiry | Expiration Date YYYY-MM-DD format | False | None | +| strike | Option Strike Price | False | None | +| opt_type | Calls or Puts | False | Calls, Puts | +| interval | Chart Minute Interval, 1440 for Daily | False | 15 (15), 30 (30), 60 (60), 1440 (1440) | +| past_days | Past Days to Display. Default: 5 | True | None | + + +--- + +## Examples + +``` +/op hist ticker:AMD expiry:2022-07-29 strike:80 opt_type:Calls interval:15 past_days:5 +``` + +``` +/op hist ticker:AMD expiry:2022-07-29 strike:80 opt_type:Calls interval:15 +``` + +--- diff --git a/website/content/bot/reference/discord/options/index.mdx b/website/content/bot/reference/discord/options/index.mdx index 2a26d101c801..4344701563f4 100644 --- a/website/content/bot/reference/discord/options/index.mdx +++ b/website/content/bot/reference/discord/options/index.mdx @@ -6,112 +6,112 @@ import ReferenceCard from "@site/src/components/General/ReferenceCard"; diff --git a/website/content/bot/reference/discord/options/indexpc.md b/website/content/bot/reference/discord/options/indexpc.md index 241a8c756ac3..b796818c41c4 100644 --- a/website/content/bot/reference/discord/options/indexpc.md +++ b/website/content/bot/reference/discord/options/indexpc.md @@ -1,33 +1,33 @@ ---- -########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### -title: indexpc -description: OpenBB Discord Command ---- - -# indexpc - -Displays the Index Put/Call Ratio for the market - from market-harmonics.com - -### Usage - -```python wordwrap -/op indexpc -``` - ---- - -## Parameters - -This command has no parameters - - - ---- - -## Examples - -``` -/op indexpc -``` - ---- +--- +########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### +title: indexpc +description: OpenBB Discord Command +--- + +# indexpc + +This command allows the user to retrieve the Index Put/Call Ratio for the market from market-harmonics.com. This ratio is an indication of the market sentiment and can be used to help traders identify bearish and bullish market conditions. The command returns the ratio and can be used to inform trading decisions. + +### Usage + +```python wordwrap +/op indexpc +``` + +--- + +## Parameters + +This command has no parameters + + + +--- + +## Examples + +``` +/op indexpc +``` + +--- diff --git a/website/content/bot/reference/discord/options/info.md b/website/content/bot/reference/discord/options/info.md index 79075b352339..7f36dbcdd741 100644 --- a/website/content/bot/reference/discord/options/info.md +++ b/website/content/bot/reference/discord/options/info.md @@ -1,34 +1,34 @@ ---- -########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### -title: info -description: OpenBB Discord Command ---- - -# info - -Displays option information (volatility, IV rank etc). - -### Usage - -```python wordwrap -/op info ticker -``` - ---- - -## Parameters - -| Name | Description | Optional | Choices | -| ---- | ----------- | -------- | ------- | -| ticker | Stock Ticker | False | None | - - ---- - -## Examples - -``` -/op info ticker:AMD -``` - ---- +--- +########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### +title: info +description: OpenBB Discord Command +--- + +# info + +This command allows the user to quickly and easily retrieve various option information (volatility, IV rank, put/call ratio, etc.) for a specific ticker symbol. + +### Usage + +```python wordwrap +/op info ticker +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| ticker | Stock Ticker | False | None | + + +--- + +## Examples + +``` +/op info ticker:AMD +``` + +--- diff --git a/website/content/bot/reference/discord/options/itm.md b/website/content/bot/reference/discord/options/itm.md index e20be2b9c2b6..ebe322d3b8f6 100644 --- a/website/content/bot/reference/discord/options/itm.md +++ b/website/content/bot/reference/discord/options/itm.md @@ -1,34 +1,34 @@ ---- -########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### -title: itm -description: OpenBB Discord Command ---- - -# itm - -Displays In-the-Money options by expiry for a stock. - -### Usage - -```python wordwrap -/op itm ticker -``` - ---- - -## Parameters - -| Name | Description | Optional | Choices | -| ---- | ----------- | -------- | ------- | -| ticker | Stock Ticker | False | None | - - ---- - -## Examples - -``` -/op itm ticker:AMD -``` - ---- +--- +########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### +title: itm +description: OpenBB Discord Command +--- + +# itm + +This command allows the user to retrieve a list of In-the-Money options for the stock ticker symbol sorted by expiry date. The command compares the amount of Calls and Puts In-the-Money vs Out-the-Money and gives a total. + +### Usage + +```python wordwrap +/op itm ticker +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| ticker | Stock Ticker | False | None | + + +--- + +## Examples + +``` +/op itm ticker:AMD +``` + +--- diff --git a/website/content/bot/reference/discord/options/maxpain.md b/website/content/bot/reference/discord/options/maxpain.md index 24fda0aed82d..10c6be2f7560 100644 --- a/website/content/bot/reference/discord/options/maxpain.md +++ b/website/content/bot/reference/discord/options/maxpain.md @@ -1,35 +1,35 @@ ---- -########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### -title: maxpain -description: OpenBB Discord Command ---- - -# maxpain - -Displays the Max Pain on expiration date for a given stock. - -### Usage - -```python wordwrap -/op maxpain ticker expiry -``` - ---- - -## Parameters - -| Name | Description | Optional | Choices | -| ---- | ----------- | -------- | ------- | -| ticker | Stock Ticker | False | None | -| expiry | Expiration Date | False | None | - - ---- - -## Examples - -``` -/op maxpain ticker:AMC expiry:2022-07-29 -``` - ---- +--- +########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### +title: maxpain +description: OpenBB Discord Command +--- + +# maxpain + +This command retrieves the Max Pain on expiration date for a given stock. Max Pain is the strike price with the most open options contracts and it is the price at which the stock would cause financial losses for the largest number of option holders at expiration. + +### Usage + +```python wordwrap +/op maxpain ticker expiry +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| ticker | Stock Ticker | False | None | +| expiry | Expiration Date | False | None | + + +--- + +## Examples + +``` +/op maxpain ticker:AMC expiry:2022-07-29 +``` + +--- diff --git a/website/content/bot/reference/discord/options/oi.md b/website/content/bot/reference/discord/options/oi.md index d4a18faa20e9..94c43a071d09 100644 --- a/website/content/bot/reference/discord/options/oi.md +++ b/website/content/bot/reference/discord/options/oi.md @@ -1,39 +1,39 @@ ---- -########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### -title: oi -description: OpenBB Discord Command ---- - -# oi - -Displays OI and call/put ratio for given stock - can add EXP date too for bigger breakdown - -### Usage - -```python wordwrap -/op oi ticker [expiry] -``` - ---- - -## Parameters - -| Name | Description | Optional | Choices | -| ---- | ----------- | -------- | ------- | -| ticker | Stock Ticker | False | None | -| expiry | Expiration Date | True | None | - - ---- - -## Examples - -``` -/op oi ticker:AMC -``` - -``` -/op oi ticker:AMC expiry:2022-07-29 -``` - ---- +--- +########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### +title: oi +description: OpenBB Discord Command +--- + +# oi + +This command allows the user to retrieve the Open Interest and Call/Put ratio for a given stock. Optionally, the user can also specify an expiration date to get a more granular breakdown. + +### Usage + +```python wordwrap +/op oi ticker [expiry] +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| ticker | Stock Ticker | False | None | +| expiry | Expiration Date | True | None | + + +--- + +## Examples + +``` +/op oi ticker:AMC +``` + +``` +/op oi ticker:AMC expiry:2022-07-29 +``` + +--- diff --git a/website/content/bot/reference/discord/options/oichart.md b/website/content/bot/reference/discord/options/oichart.md index 7140a59c2ba4..d3b424bba816 100644 --- a/website/content/bot/reference/discord/options/oichart.md +++ b/website/content/bot/reference/discord/options/oichart.md @@ -1,39 +1,39 @@ ---- -########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### -title: oichart -description: OpenBB Discord Command ---- - -# oichart - -Charts Total Open Interest by Strike Price. - -### Usage - -```python wordwrap -/op oichart ticker [expiry] -``` - ---- - -## Parameters - -| Name | Description | Optional | Choices | -| ---- | ----------- | -------- | ------- | -| ticker | Stock Ticker | False | None | -| expiry | Expiration Date | True | None | - - ---- - -## Examples - -``` -/op oichart ticker:AMD -``` - -``` -/op oichart ticker:AMD expiry:2022-07-29 -``` - ---- +--- +########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### +title: oichart +description: OpenBB Discord Command +--- + +# oichart + +This command allows users to retrieve a chart of Total Open Interest by Strike Price for the given ticker symbol. This chart provides a visual representation of the open interest on various strike prices for the given ticker symbol, where the size of each point on the graph reflects the amount of open interest. This can be used to analyze the open interest on various strike prices and make informed decisions about the underlying security. + +### Usage + +```python wordwrap +/op oichart ticker [expiry] +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| ticker | Stock Ticker | False | None | +| expiry | Expiration Date | True | None | + + +--- + +## Examples + +``` +/op oichart ticker:AMD +``` + +``` +/op oichart ticker:AMD expiry:2022-07-29 +``` + +--- diff --git a/website/content/bot/reference/discord/options/smile.md b/website/content/bot/reference/discord/options/smile.md index dd7b173d7d96..6bc250cace95 100644 --- a/website/content/bot/reference/discord/options/smile.md +++ b/website/content/bot/reference/discord/options/smile.md @@ -1,41 +1,41 @@ ---- -########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### -title: smile -description: OpenBB Discord Command ---- - -# smile - -Displays Options Volatility Smile. - -### Usage - -```python wordwrap -/op smile ticker expiry [min_sp] [max_sp] -``` - ---- - -## Parameters - -| Name | Description | Optional | Choices | -| ---- | ----------- | -------- | ------- | -| ticker | Stock Ticker | False | None | -| expiry | Expiration Date | False | None | -| min_sp | Minimum Strike Price | True | None | -| max_sp | Maximum Strike Price | True | None | - - ---- - -## Examples - -``` -/op smile ticker:AMD expiry:2022-07-29 -``` - -``` -/op smile ticker:AMD expiry:2022-07-29 min_sp:10 max_sp:100 -``` - ---- +--- +########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### +title: smile +description: OpenBB Discord Command +--- + +# smile + +This command allows the user to retrieve the Options Volatility Smile for the given ticker and expiry. The Options Volatility Smile is a graphical representation of the implied volatility for a given option that can be used to gauge the market sentiment for a particular security. + +### Usage + +```python wordwrap +/op smile ticker expiry [min_sp] [max_sp] +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| ticker | Stock Ticker | False | None | +| expiry | Expiration Date | False | None | +| min_sp | Minimum Strike Price | True | None | +| max_sp | Maximum Strike Price | True | None | + + +--- + +## Examples + +``` +/op smile ticker:AMD expiry:2022-07-29 +``` + +``` +/op smile ticker:AMD expiry:2022-07-29 min_sp:10 max_sp:100 +``` + +--- diff --git a/website/content/bot/reference/discord/options/stats.md b/website/content/bot/reference/discord/options/stats.md index 36dd1c05dc0a..32393b0ab453 100644 --- a/website/content/bot/reference/discord/options/stats.md +++ b/website/content/bot/reference/discord/options/stats.md @@ -1,34 +1,34 @@ ---- -########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### -title: stats -description: OpenBB Discord Command ---- - -# stats - -Displays Options Statistics for a stock. - -### Usage - -```python wordwrap -/op stats ticker -``` - ---- - -## Parameters - -| Name | Description | Optional | Choices | -| ---- | ----------- | -------- | ------- | -| ticker | Stock Ticker | False | None | - - ---- - -## Examples - -``` -/op stats ticker:AMC -``` - ---- +--- +########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### +title: stats +description: OpenBB Discord Command +--- + +# stats + +This command allows the user to retrieve Options Statistics for a stock with the given ticker symbol. This includes information such as Open Interest, Volume, Implied Volatility, and Earnings move data. + +### Usage + +```python wordwrap +/op stats ticker +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| ticker | Stock Ticker | False | None | + + +--- + +## Examples + +``` +/op stats ticker:AMC +``` + +--- diff --git a/website/content/bot/reference/discord/options/topoi.md b/website/content/bot/reference/discord/options/topoi.md index df0ad4201fb1..8c54ac926271 100644 --- a/website/content/bot/reference/discord/options/topoi.md +++ b/website/content/bot/reference/discord/options/topoi.md @@ -1,33 +1,33 @@ ---- -########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### -title: topoi -description: OpenBB Discord Command ---- - -# topoi - -Displays Top Open Interest - -### Usage - -```python wordwrap -/op topoi -``` - ---- - -## Parameters - -This command has no parameters - - - ---- - -## Examples - -``` -/op topoi -``` - ---- +--- +########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### +title: topoi +description: OpenBB Discord Command +--- + +# topoi + +This command allows the user to retrieve Top Open Interest among all stocks. This command queries the current market data and provides a list of the most actively traded stocks and options in the current market. + +### Usage + +```python wordwrap +/op topoi +``` + +--- + +## Parameters + +This command has no parameters + + + +--- + +## Examples + +``` +/op topoi +``` + +--- diff --git a/website/content/bot/reference/discord/options/topoichange.md b/website/content/bot/reference/discord/options/topoichange.md index c2361bb6c2a6..b1cd540a214f 100644 --- a/website/content/bot/reference/discord/options/topoichange.md +++ b/website/content/bot/reference/discord/options/topoichange.md @@ -1,33 +1,31 @@ ---- -########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### -title: topoichange -description: OpenBB Discord Command ---- - -# topoichange - -Displays Top 15 stocks with highest OI Change. - -### Usage - -```python wordwrap -/op topoichange -``` - ---- - -## Parameters - -This command has no parameters - - - ---- - -## Examples - -``` -/op topoichange -``` - ---- +--- +########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### +title: topoichange +description: OpenBB Discord Command +--- + +# topoichange + +This command allows the user to view the top 15 stocks with the highest OI Change. It will display the stock name, the OI Change by put and call, and previous levels. This gives users a helpful overview of the stocks that have seen the most significant change in open interest. + +### Usage + +```python wordwrap +/op topoichange +``` + +--- + +## Parameters + +This command has no parameters + +--- + +## Examples + +``` +/op topoichange +``` + +--- diff --git a/website/content/bot/reference/discord/options/topstrikevol.md b/website/content/bot/reference/discord/options/topstrikevol.md index c9eeb3fd228f..2a5a3278ef60 100644 --- a/website/content/bot/reference/discord/options/topstrikevol.md +++ b/website/content/bot/reference/discord/options/topstrikevol.md @@ -1,35 +1,35 @@ ---- -########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### -title: topstrikevol -description: OpenBB Discord Command ---- - -# topstrikevol - -Displays Options Strike Volume can add EXP date for bigger breakdown - -### Usage - -```python wordwrap -/op topstrikevol ticker [expiry] -``` - ---- - -## Parameters - -| Name | Description | Optional | Choices | -| ---- | ----------- | -------- | ------- | -| ticker | Stock Ticker | False | None | -| expiry | Expiration Date (optional) | True | None | - - ---- - -## Examples - -```python wordwrap -/op topstrikevol ticker:AMD -``` - ---- +--- +########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### +title: topstrikevol +description: OpenBB Discord Command +--- + +# topstrikevol + +This command allows the user to retrieve the top option strike by volume for a given security with the ability to add an expiration date for a more detailed breakdown. + +### Usage + +```python wordwrap +/op topstrikevol ticker [expiry] +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| ticker | Stock Ticker | False | None | +| expiry | Expiration Date (optional) | True | None | + + +--- + +## Examples + +```python wordwrap +/op topstrikevol ticker:AMD +``` + +--- diff --git a/website/content/bot/reference/discord/options/topvol.md b/website/content/bot/reference/discord/options/topvol.md index fe3cead4858f..db6df92d3b39 100644 --- a/website/content/bot/reference/discord/options/topvol.md +++ b/website/content/bot/reference/discord/options/topvol.md @@ -1,33 +1,33 @@ ---- -########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### -title: topvol -description: OpenBB Discord Command ---- - -# topvol - -Top 15 Highest options volume. - -### Usage - -```python wordwrap -/op topvol -``` - ---- - -## Parameters - -This command has no parameters - - - ---- - -## Examples - -``` -/op topvol -``` - ---- +--- +########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### +title: topvol +description: OpenBB Discord Command +--- + +# topvol + +This command allows the user to retrieve the Top 15 Highest stock options volumes by adding the call and put volume together. This data can be used to identify the most liquid options for trading. + +### Usage + +```python wordwrap +/op topvol +``` + +--- + +## Parameters + +This command has no parameters + + + +--- + +## Examples + +``` +/op topvol +``` + +--- diff --git a/website/content/bot/reference/discord/options/topvoletf.md b/website/content/bot/reference/discord/options/topvoletf.md index 1e5e69bc4d8b..d2b665d6a9cf 100644 --- a/website/content/bot/reference/discord/options/topvoletf.md +++ b/website/content/bot/reference/discord/options/topvoletf.md @@ -1,32 +1,32 @@ ---- -########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### -title: topvoletf -description: OpenBB Discord Command ---- - -# topvoletf - -Top 15 Highest options volume ETFs. - -### Usage - -```python wordwrap -/op topvoletf -``` - ---- - -## Parameters - -This command has no parameters - - - ---- - -## Examples - -``` -/op topvoletf -``` ---- +--- +########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### +title: topvoletf +description: OpenBB Discord Command +--- + +# topvoletf + +This command allows the user to retrieve the Top 15 Highest ETF options volumes by adding the call and put volume together. This data can be used to identify the most liquid options for trading. + +### Usage + +```python wordwrap +/op topvoletf +``` + +--- + +## Parameters + +This command has no parameters + + + +--- + +## Examples + +``` +/op topvoletf +``` +--- diff --git a/website/content/bot/reference/discord/options/unu.md b/website/content/bot/reference/discord/options/unu.md index 243805c863da..630f1ae78006 100644 --- a/website/content/bot/reference/discord/options/unu.md +++ b/website/content/bot/reference/discord/options/unu.md @@ -1,33 +1,33 @@ ---- -########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### -title: unu -description: OpenBB Discord Command ---- - -# unu - -Shows Unusual Options - -### Usage - -```python wordwrap -/op unu -``` - ---- - -## Parameters - -This command has no parameters - - - ---- - -## Examples - -``` -/op unu -``` - ---- +--- +########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### +title: unu +description: OpenBB Discord Command +--- + +# unu + +This command allows a user to retrieve unusual options sorted by strike and expiration. It provides a list of the most unusual options in the market and can be used to identify potential trading opportunities. The results are sorted by the highest Volume to Open Interest ratio giving the user the ability to quickly identify potential trading opportunities. + +### Usage + +```python wordwrap +/op unu +``` + +--- + +## Parameters + +This command has no parameters + + + +--- + +## Examples + +``` +/op unu +``` + +--- diff --git a/website/content/bot/reference/discord/options/uoastock.md b/website/content/bot/reference/discord/options/uoastock.md index 63b6212b3b40..232cc5ff6128 100644 --- a/website/content/bot/reference/discord/options/uoastock.md +++ b/website/content/bot/reference/discord/options/uoastock.md @@ -1,38 +1,38 @@ ---- -########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### -title: uoastock -description: OpenBB Discord Command ---- - -# uoastock - -Display Top 20day Average Options Volume by ticker. - -### Usage - -```python wordwrap -/op uoastock [price] -``` - ---- - -## Parameters - -| Name | Description | Optional | Choices | -| ---- | ----------- | -------- | ------- | -| price | Filter by stocks over a certain price | True | None | - - ---- - -## Examples - -``` -/op uoastock -``` - -``` -/op uoastock price:50 -``` - ---- +--- +########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### +title: uoastock +description: OpenBB Discord Command +--- + +# uoastock + +This command allows the user to retrieve the 20-day average options volume by ticker. The volume is based on the total volume of all options traded in the given period of time, including calls and puts. + +### Usage + +```python wordwrap +/op uoastock [price] +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| price | Filter by stocks over a certain price | True | None | + + +--- + +## Examples + +``` +/op uoastock +``` + +``` +/op uoastock price:50 +``` + +--- diff --git a/website/content/bot/reference/discord/options/vol.md b/website/content/bot/reference/discord/options/vol.md index 20c723439ed1..6a7b1264dff8 100644 --- a/website/content/bot/reference/discord/options/vol.md +++ b/website/content/bot/reference/discord/options/vol.md @@ -1,39 +1,39 @@ ---- -########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### -title: vol -description: OpenBB Discord Command ---- - -# vol - -Displays Options Strike Volume can add EXP date for bigger breakdown - -### Usage - -```python wordwrap -/op vol ticker [expiry] -``` - ---- - -## Parameters - -| Name | Description | Optional | Choices | -| ---- | ----------- | -------- | ------- | -| ticker | Stock Ticker | False | None | -| expiry | Expiration Date (optional) | True | None | - - ---- - -## Examples - -``` -/op vol ticker:AMD -``` - -``` -/op vol ticker:AMD expiry:2022-07-29 -``` - ---- +--- +########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### +title: vol +description: OpenBB Discord Command +--- + +# vol + +This command allows the user to retrieve a chart of Options Volume by Strike for a specified ticker. This data can be broken down further by adding an expiration date for a more detailed breakdown. + +### Usage + +```python wordwrap +/op vol ticker [expiry] +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| ticker | Stock Ticker | False | None | +| expiry | Expiration Date (optional) | True | None | + + +--- + +## Examples + +``` +/op vol ticker:AMD +``` + +``` +/op vol ticker:AMD expiry:2022-07-29 +``` + +--- diff --git a/website/content/bot/reference/discord/options/vsurf.md b/website/content/bot/reference/discord/options/vsurf.md index b969ca04044e..e0a717a46062 100644 --- a/website/content/bot/reference/discord/options/vsurf.md +++ b/website/content/bot/reference/discord/options/vsurf.md @@ -1,39 +1,39 @@ ---- -########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### -title: vsurf -description: OpenBB Discord Command ---- - -# vsurf - -Display Options Volatility Surface. - -### Usage - -```python wordwrap -/op vsurf ticker z -``` - ---- - -## Parameters - -| Name | Description | Optional | Choices | -| ---- | ----------- | -------- | ------- | -| ticker | Stock Ticker | False | None | -| z | The variable for the Z axis | False | Volatility (IV), Open Interest (OI), Last Price (LP) | - - ---- - -## Examples - -``` -/op vsurf ticker:AMD z:Volatility -``` - -``` -/op vsurf ticker:AMD z:Open Interest -``` - ---- +--- +########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### +title: vsurf +description: OpenBB Discord Command +--- + +# vsurf + +This command allows the user to retrieve an options volatility surface for the ticker symbol. Specifically, it will provide a surface based on implied volatilities calculated from options prices, indicating the relationship between the stock price and the implied volatility of options on the stock. + +### Usage + +```python wordwrap +/op vsurf ticker z +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| ticker | Stock Ticker | False | None | +| z | The variable for the Z axis | False | Volatility (IV), Open Interest (OI), Last Price (LP) | + + +--- + +## Examples + +``` +/op vsurf ticker:AMD z:Volatility +``` + +``` +/op vsurf ticker:AMD z:Open Interest +``` + +--- diff --git a/website/content/bot/reference/discord/pop/1d.md b/website/content/bot/reference/discord/pop/1d.md index e16a46eed329..9b463a9680bf 100644 --- a/website/content/bot/reference/discord/pop/1d.md +++ b/website/content/bot/reference/discord/pop/1d.md @@ -1,32 +1,32 @@ ---- -########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### -title: 1d -description: OpenBB Discord Command ---- - -# 1d - -Displays Top 15 Tickers for today - -### Usage - -```python wordwrap -/pop 1d -``` - ---- - -## Parameters - -This command has no parameters - - - ---- - -## Examples - -``` -/pop 1d -``` ---- +--- +########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### +title: 1d +description: OpenBB Discord Command +--- + +# 1d + +This command retrieves the top 15 tickers for the day based on popularity on the OpenBB Bot across all our platforms. It allows users to get an overview of the most popular stocks in the market within the last 24 hours. + +### Usage + +```python wordwrap +/pop 1d +``` + +--- + +## Parameters + +This command has no parameters + + + +--- + +## Examples + +``` +/pop 1d +``` +--- diff --git a/website/content/bot/reference/discord/pop/1hr.md b/website/content/bot/reference/discord/pop/1hr.md index 8eb0db0b3eb2..220e22da734d 100644 --- a/website/content/bot/reference/discord/pop/1hr.md +++ b/website/content/bot/reference/discord/pop/1hr.md @@ -1,32 +1,32 @@ ---- -########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### -title: 1hr -description: OpenBB Discord Command ---- - -# 1hr - -Displays Top 15 Tickers in the last hour - -### Usage - -```python wordwrap -/pop 1hr -``` - ---- - -## Parameters - -This command has no parameters - - - ---- - -## Examples - -``` -/pop 1hr -``` ---- +--- +########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### +title: 1hr +description: OpenBB Discord Command +--- + +# 1hr + +This command retrieves the top 15 stocks that have been traded in the past hour on the OpenBB Bot across all our platforms. It provides the user with an up-to-date overview of the stocks that have been the most active over the past hour, allowing the user to quickly identify trends and potentially capitalize on them. + +### Usage + +```python wordwrap +/pop 1hr +``` + +--- + +## Parameters + +This command has no parameters + + + +--- + +## Examples + +``` +/pop 1hr +``` +--- diff --git a/website/content/bot/reference/discord/pop/index.mdx b/website/content/bot/reference/discord/pop/index.mdx index 0d42a7ed5f93..d069076d8d70 100644 --- a/website/content/bot/reference/discord/pop/index.mdx +++ b/website/content/bot/reference/discord/pop/index.mdx @@ -6,12 +6,12 @@ import ReferenceCard from "@site/src/components/General/ReferenceCard"; diff --git a/website/content/bot/reference/discord/screeners/ah.md b/website/content/bot/reference/discord/screeners/ah.md index 80c1645f7c9c..c9edf4a51ccd 100644 --- a/website/content/bot/reference/discord/screeners/ah.md +++ b/website/content/bot/reference/discord/screeners/ah.md @@ -1,34 +1,34 @@ ---- -########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### -title: ah -description: OpenBB Discord Command ---- - -# ah - -Displays After-Hours stocks according to chosen screener. - -### Usage - -```python wordwrap -/scr ah signal -``` - ---- - -## Parameters - -| Name | Description | Optional | Choices | -| ---- | ----------- | -------- | ------- | -| signal | screener preset | False | After-Hours Top Gainers (ahgainers), After-Hours Top Losers (ahlosers), After-Hours Most Active (ahmost_active) | - - ---- - -## Examples - -``` -/scr ah signal:After-Hours Top Gainers -``` - ---- +--- +########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### +title: ah +description: OpenBB Discord Command +--- + +# ah + +This command allows the user to retrieve After-Hours stock movers according to a chosen screener. + +### Usage + +```python wordwrap +/scr ah signal +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| signal | screener preset | False | After-Hours Top Gainers (ahgainers), After-Hours Top Losers (ahlosers), After-Hours Most Active (ahmost_active) | + + +--- + +## Examples + +``` +/scr ah signal:After-Hours Top Gainers +``` + +--- diff --git a/website/content/bot/reference/discord/screeners/ah_all.md b/website/content/bot/reference/discord/screeners/ah_all.md index 009103a695e1..c3edd1e06803 100644 --- a/website/content/bot/reference/discord/screeners/ah_all.md +++ b/website/content/bot/reference/discord/screeners/ah_all.md @@ -1,33 +1,33 @@ ---- -########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### -title: ah_all -description: OpenBB Discord Command ---- - -# ah_all - -Displays all available after-hours screeners - -### Usage - -```python wordwrap -/scr ah_all -``` - ---- - -## Parameters - -This command has no parameters - - - ---- - -## Examples - -``` -/scr ah_all -``` - ---- +--- +########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### +title: ah_all +description: OpenBB Discord Command +--- + +# ah_all + +This command retrieves all available after-hours screeners (gainers, losers, and most active). It is helpful for users who need to quickly access and review all the available after-hours screeners without having to search through a large list. + +### Usage + +```python wordwrap +/scr ah_all +``` + +--- + +## Parameters + +This command has no parameters + + + +--- + +## Examples + +``` +/scr ah_all +``` + +--- diff --git a/website/content/bot/reference/discord/screeners/all.md b/website/content/bot/reference/discord/screeners/all.md index a5d729c2b546..ecf870d5019d 100644 --- a/website/content/bot/reference/discord/screeners/all.md +++ b/website/content/bot/reference/discord/screeners/all.md @@ -1,32 +1,32 @@ ---- -########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### -title: all -description: OpenBB Discord Command ---- - -# all - -Displays all available screeners - -### Usage - -```python wordwrap -/scr all -``` - ---- - -## Parameters - -This command has no parameters - - - ---- - -## Examples - -``` -/scr all -``` ---- +--- +########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### +title: all +description: OpenBB Discord Command +--- + +# all + +This command allows the user to view all available screeners during market hours. The results can then be used to further analyze the data and make better-informed decisions. + +### Usage + +```python wordwrap +/scr all +``` + +--- + +## Parameters + +This command has no parameters + + + +--- + +## Examples + +``` +/scr all +``` +--- diff --git a/website/content/bot/reference/discord/screeners/index.mdx b/website/content/bot/reference/discord/screeners/index.mdx index 591722132d4c..8042e5ebc778 100644 --- a/website/content/bot/reference/discord/screeners/index.mdx +++ b/website/content/bot/reference/discord/screeners/index.mdx @@ -6,32 +6,32 @@ import ReferenceCard from "@site/src/components/General/ReferenceCard"; diff --git a/website/content/bot/reference/discord/screeners/pm.md b/website/content/bot/reference/discord/screeners/pm.md index aa5fdb134839..3fd8648dce98 100644 --- a/website/content/bot/reference/discord/screeners/pm.md +++ b/website/content/bot/reference/discord/screeners/pm.md @@ -1,34 +1,34 @@ ---- -########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### -title: pm -description: OpenBB Discord Command ---- - -# pm - -Displays Pre-Market stocks according to chosen screener. - -### Usage - -```python wordwrap -/scr pm signal -``` - ---- - -## Parameters - -| Name | Description | Optional | Choices | -| ---- | ----------- | -------- | ------- | -| signal | screener preset | False | Pre-Market Top Gainers (pmgainers), Pre-Market Top Losers (pmlosers), Pre-Market Most Active (pmmost_active) | - - ---- - -## Examples - -``` -/scr pm signal:Pre-Market Top Gainers -``` - ---- +--- +########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### +title: pm +description: OpenBB Discord Command +--- + +# pm + +This command offers the user the ability to view the top pre-market gainers, losers, and most active, giving the user a better understanding of the market’s movements before the market officially opens. + +### Usage + +```python wordwrap +/scr pm signal +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| signal | screener preset | False | Pre-Market Top Gainers (pmgainers), Pre-Market Top Losers (pmlosers), Pre-Market Most Active (pmmost_active) | + + +--- + +## Examples + +``` +/scr pm signal:Pre-Market Top Gainers +``` + +--- diff --git a/website/content/bot/reference/discord/screeners/pm_all.md b/website/content/bot/reference/discord/screeners/pm_all.md index f000ddb527a7..a25f70b42bb0 100644 --- a/website/content/bot/reference/discord/screeners/pm_all.md +++ b/website/content/bot/reference/discord/screeners/pm_all.md @@ -1,32 +1,31 @@ ---- -########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### -title: pm_all -description: OpenBB Discord Command ---- - -# pm_all - -Displays all available pre-market screeners - -### Usage - -```python wordwrap -/scr pm_all -``` - ---- - -## Parameters - -This command has no parameters - - - ---- - -## Examples - -``` -/scr pm_all -``` ---- +--- +########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### +title: pm_all +description: OpenBB Discord Command +--- + +# pm_all + +This command allows the user to retrieve all available pre-market screeners. + +### Usage + +```python wordwrap +/scr pm_all +``` + +--- + +## Parameters + +This command has no parameters + + +--- + +## Examples + +``` +/scr pm_all +``` +--- diff --git a/website/content/bot/reference/discord/screeners/technical.md b/website/content/bot/reference/discord/screeners/technical.md index f98c449b921f..42200e1eb6a5 100644 --- a/website/content/bot/reference/discord/screeners/technical.md +++ b/website/content/bot/reference/discord/screeners/technical.md @@ -1,37 +1,37 @@ ---- -########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### -title: technical -description: OpenBB Discord Command ---- - -# technical - -Displays stock screener results according to chosen signal. - -### Usage - -```python wordwrap -/scr technical signal -``` - ---- - -## Parameters - -| Name | Description | Optional | Choices | -| ---- | ----------- | -------- | ------- | -| signal | screener preset | False | Top Gainers (gainers), Top Losers (losers), Most Active (most_active), Most Volatile (most_volatile), Relative Volatility (relative_volatility), Oversold (RSI 30) (oversold), Overbought (RSI 70) (overbought), Golden Cross (golden_cross), Death Cross (death_cross), New 52week High (new_w52high), New 52week Low (new_w52low), Unusual Volume (unusual_volume) | - - ---- - -## Examples - -``` -/scr technical signal:Top Gainers -``` -``` -/scr technical signal:Death Cross -``` - ---- +--- +########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### +title: technical +description: OpenBB Discord Command +--- + +# technical + +This command allows the user to retrieve stock screener results according to the chosen technical signal. + +### Usage + +```python wordwrap +/scr technical signal +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| signal | screener preset | False | Top Gainers (gainers), Top Losers (losers), Most Active (most_active), Most Volatile (most_volatile), Relative Volatility (relative_volatility), Oversold (RSI 30) (oversold), Overbought (RSI 70) (overbought), Golden Cross (golden_cross), Death Cross (death_cross), New 52week High (new_w52high), New 52week Low (new_w52low), Unusual Volume (unusual_volume) | + + +--- + +## Examples + +``` +/scr technical signal:Top Gainers +``` +``` +/scr technical signal:Death Cross +``` + +--- diff --git a/website/content/bot/reference/discord/short_data/borrowed.md b/website/content/bot/reference/discord/short_data/borrowed.md index 71f0c6cc86df..2edb3adc33b8 100644 --- a/website/content/bot/reference/discord/short_data/borrowed.md +++ b/website/content/bot/reference/discord/short_data/borrowed.md @@ -1,34 +1,34 @@ ---- -########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### -title: borrowed -description: OpenBB Discord Command ---- - -# borrowed - -Displays history of borrowed shares available and fee. - -### Usage - -```python wordwrap -/sh borrowed ticker -``` - ---- - -## Parameters - -| Name | Description | Optional | Choices | -| ---- | ----------- | -------- | ------- | -| ticker | Stock Ticker | False | None | - - ---- - -## Examples - -``` -/sh borrowed ticker:AMD -``` - ---- +--- +########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### +title: borrowed +description: OpenBB Discord Command +--- + +# borrowed + +This command allows the user to view the history of borrowed shares available and fees associated with the stock with the ticker symbol. This can be a useful tool for traders and investors to track changes in share borrowing over time and to compare fees charged by different brokers. + +### Usage + +```python wordwrap +/sh borrowed ticker +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| ticker | Stock Ticker | False | None | + + +--- + +## Examples + +``` +/sh borrowed ticker:AMD +``` + +--- diff --git a/website/content/bot/reference/discord/short_data/hsi.md b/website/content/bot/reference/discord/short_data/hsi.md index 38e269e43893..dbd6a0b48581 100644 --- a/website/content/bot/reference/discord/short_data/hsi.md +++ b/website/content/bot/reference/discord/short_data/hsi.md @@ -1,37 +1,37 @@ ---- -########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### -title: hsi -description: OpenBB Discord Command ---- - -# hsi - -Show top high short interest stocks of over 20% ratio. - -### Usage - -```python wordwrap -/sh hsi [num] -``` - ---- - -## Parameters - -| Name | Description | Optional | Choices | -| ---- | ----------- | -------- | ------- | -| num | Number of top stocks to print | True | None | - - ---- - -## Examples - -``` -/sh hsi -``` -``` -/sh hsi num:4 -``` - ---- +--- +########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### +title: hsi +description: OpenBB Discord Command +--- + +# hsi + +This command retrieves the top high short interest stocks over a 20% ratio. This information can let an investor identify possible short squeeze potential. + +### Usage + +```python wordwrap +/sh hsi [num] +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| num | Number of top stocks to print | True | None | + + +--- + +## Examples + +``` +/sh hsi +``` +``` +/sh hsi num:4 +``` + +--- diff --git a/website/content/bot/reference/discord/short_data/index.mdx b/website/content/bot/reference/discord/short_data/index.mdx index 4f95beb3fdd7..e0316f824048 100644 --- a/website/content/bot/reference/discord/short_data/index.mdx +++ b/website/content/bot/reference/discord/short_data/index.mdx @@ -6,27 +6,27 @@ import ReferenceCard from "@site/src/components/General/ReferenceCard"; diff --git a/website/content/bot/reference/discord/short_data/shortrate.md b/website/content/bot/reference/discord/short_data/shortrate.md index 3d5adbd4029f..2aae2b9e9eac 100644 --- a/website/content/bot/reference/discord/short_data/shortrate.md +++ b/website/content/bot/reference/discord/short_data/shortrate.md @@ -1,34 +1,34 @@ ---- -########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### -title: shortrate -description: OpenBB Discord Command ---- - -# shortrate - -Display Short shares spot borrow rate sourced from Interactive Brokers - -### Usage - -```python wordwrap -/sh shortrate ticker -``` - ---- - -## Parameters - -| Name | Description | Optional | Choices | -| ---- | ----------- | -------- | ------- | -| ticker | Stock Ticker | False | None | - - ---- - -## Examples - -``` -/sh shortrate ticker:AMD -``` - ---- +--- +########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### +title: shortrate +description: OpenBB Discord Command +--- + +# shortrate + +This command allows the user to retrieve the Display Short Shares spot borrow rate from Interactive Brokers for the given ticker. The spot borrow rate is the rate at which a user may borrow shares from the broker in order to short sell the security. This command allows the user to check the current rate and make more informed decisions about their short selling activities. + +### Usage + +```python wordwrap +/sh shortrate ticker +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| ticker | Stock Ticker | False | None | + + +--- + +## Examples + +``` +/sh shortrate ticker:AMD +``` + +--- diff --git a/website/content/bot/reference/discord/short_data/shortvol.md b/website/content/bot/reference/discord/short_data/shortvol.md index d5c228d42a31..b4ea6b98c3eb 100644 --- a/website/content/bot/reference/discord/short_data/shortvol.md +++ b/website/content/bot/reference/discord/short_data/shortvol.md @@ -1,34 +1,34 @@ ---- -########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### -title: shortvol -description: OpenBB Discord Command ---- - -# shortvol - -Graph of 30 day history of short volume vs vol. - -### Usage - -```python wordwrap -/sh shortvol ticker -``` - ---- - -## Parameters - -| Name | Description | Optional | Choices | -| ---- | ----------- | -------- | ------- | -| ticker | Stock Ticker | False | None | - - ---- - -## Examples - -``` -/sh shortvol ticker:AMD -``` - ---- +--- +########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### +title: shortvol +description: OpenBB Discord Command +--- + +# shortvol + +This command allows the user to retrieve a graph of the 30 day history of the short volume versus the total volume of the stock ticker. The graph also displays the ratio of the total amount of shares that have been sold short versus the total amount of shares traded over the past 30 days. This data can be used to get a better understanding of the stock's trading activity and potential future price movements. + +### Usage + +```python wordwrap +/sh shortvol ticker +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| ticker | Stock Ticker | False | None | + + +--- + +## Examples + +``` +/sh shortvol ticker:AMD +``` + +--- diff --git a/website/content/bot/reference/discord/short_data/topshortvol.md b/website/content/bot/reference/discord/short_data/topshortvol.md index 48117b17b5f2..a27fd89bbda1 100644 --- a/website/content/bot/reference/discord/short_data/topshortvol.md +++ b/website/content/bot/reference/discord/short_data/topshortvol.md @@ -1,33 +1,33 @@ ---- -########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### -title: topshortvol -description: OpenBB Discord Command ---- - -# topshortvol - -Top 15 Short Interest Stocks per Finra - -### Usage - -```python wordwrap -/sh topshortvol -``` - ---- - -## Parameters - -This command has no parameters - - - ---- - -## Examples - -``` -/sh topshortvol -``` - ---- +--- +########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### +title: topshortvol +description: OpenBB Discord Command +--- + +# topshortvol + +This command allows the user to retrieve the Top 15 Short Interest Stocks per Finra. It's typically measured as a ratio of the stock's total short vol divided by the total volume for the trading day. This information is essential for traders to make informed decisions in the market. + +### Usage + +```python wordwrap +/sh topshortvol +``` + +--- + +## Parameters + +This command has no parameters + + + +--- + +## Examples + +``` +/sh topshortvol +``` + +--- diff --git a/website/content/bot/reference/telegram/charts/c.md b/website/content/bot/reference/telegram/charts/c.md index 8e85beb1ffd1..7ff0f7fb500d 100644 --- a/website/content/bot/reference/telegram/charts/c.md +++ b/website/content/bot/reference/telegram/charts/c.md @@ -6,7 +6,7 @@ description: OpenBB Telegram Command # c -Chart for the crypto pair provided Default: 15m +This command will retrieve a candlestick chart for the crypto coin provided. The interval provided must be a valid time interval (default 15 minutes). The chart will be displayed to the user and will contain information such as the opening and closing prices, the high and low, the volume, and any other relevant information. ### Usage diff --git a/website/content/bot/reference/telegram/charts/c15m.md b/website/content/bot/reference/telegram/charts/c15m.md index 3d6c1e8f63d4..9da33ba8f843 100644 --- a/website/content/bot/reference/telegram/charts/c15m.md +++ b/website/content/bot/reference/telegram/charts/c15m.md @@ -6,7 +6,7 @@ description: OpenBB Telegram Command # c15m -Intraday 15m chart for the ticker provided. +This command allows the user to retrieve a 15-minute intraday chart for a given ticker. The chart will show the price and volume of the stock over the past 3 days in 15 minute intervals. This command is useful for performing technical analysis and tracking short-term price movements. ### Usage diff --git a/website/content/bot/reference/telegram/charts/c3m.md b/website/content/bot/reference/telegram/charts/c3m.md index 994a543e96ea..72d6eec3a70d 100644 --- a/website/content/bot/reference/telegram/charts/c3m.md +++ b/website/content/bot/reference/telegram/charts/c3m.md @@ -6,7 +6,7 @@ description: OpenBB Telegram Command # c3m -Intraday 3m chart for the ticker provided. +This command allows users to retrieve a 3-minute intraday chart for the given ticker. This chart will display the candlestick chart for the day. It will provide a visual representation of the stock's performance over the current day, making it helpful for short-term investors. ### Usage diff --git a/website/content/bot/reference/telegram/charts/c5m.md b/website/content/bot/reference/telegram/charts/c5m.md index 245c2a50a6ab..80451f2db978 100644 --- a/website/content/bot/reference/telegram/charts/c5m.md +++ b/website/content/bot/reference/telegram/charts/c5m.md @@ -6,7 +6,7 @@ description: OpenBB Telegram Command # c5m -Intraday 5m chart for the ticker provided - /cc also works +This command allows the user to retrieve an intraday 5 minute chart for a given ticker. This chart will display the candlestick chart for the day. It will provide a visual representation of the stock's performance over the current day. This command is useful for performing technical analysis and tracking short-term price movements. ### Usage diff --git a/website/content/bot/reference/telegram/charts/cc.md b/website/content/bot/reference/telegram/charts/cc.md index 8d52756ab1aa..d3ff464da518 100644 --- a/website/content/bot/reference/telegram/charts/cc.md +++ b/website/content/bot/reference/telegram/charts/cc.md @@ -6,7 +6,7 @@ description: OpenBB Telegram Command # cc -Intraday 5m chart for the ticker provided +This command allows the user to retrieve an intraday 5 minute chart for a given ticker, /c5m also has the same effect. This chart will display the candlestick chart for the day. It will provide a visual representation of the stock's performance over the current day. This command is useful for performing technical analysis and tracking short-term price movements. ### Usage diff --git a/website/content/bot/reference/telegram/charts/cd.md b/website/content/bot/reference/telegram/charts/cd.md index 76e7a3f8de2a..7ff671264197 100644 --- a/website/content/bot/reference/telegram/charts/cd.md +++ b/website/content/bot/reference/telegram/charts/cd.md @@ -6,7 +6,7 @@ description: OpenBB Telegram Command # cd -Daily candlestick chart for the ticker/coin provided. +This command allows the user to retrieve a daily candlestick chart for a particular ticker or coin. The candlestick chart provides information about the opening and closing prices of the day, as well as the high and low prices of the day. This data can then be used to analyze the performance of the ticker/coin over time. For example, if the user provides the command "/cd AMD", the chart will be generated for the ticker AMD. ### Usage diff --git a/website/content/bot/reference/telegram/charts/chart.md b/website/content/bot/reference/telegram/charts/chart.md index 5124289554e2..d14778955df8 100644 --- a/website/content/bot/reference/telegram/charts/chart.md +++ b/website/content/bot/reference/telegram/charts/chart.md @@ -6,7 +6,7 @@ description: OpenBB Telegram Command # chart -Shows the candlestick chart for the ticker/interval provided +This command will retrieve a candlestick chart for the ticker/interval provided, with data for the past number of days specified. The interval provided must be a valid time interval (e.g. 5 minute, 15 minute, etc.). The chart will be displayed to the user and will contain information such as the opening and closing prices, the high and low, the volume, and any other relevant information. ### Usage diff --git a/website/content/bot/reference/telegram/charts/chartfib.md b/website/content/bot/reference/telegram/charts/chartfib.md index 85bf0eabb230..6502f4f819f2 100644 --- a/website/content/bot/reference/telegram/charts/chartfib.md +++ b/website/content/bot/reference/telegram/charts/chartfib.md @@ -6,7 +6,7 @@ description: OpenBB Telegram Command # chartfib -Fibonacci levels for the ticker provided +This command allows the user to retrieve Fibonacci levels for a given ticker. This data can be used to identify potential support and resistance levels and can be used to identify potential entry and exit points in the stock market. ### Usage diff --git a/website/content/bot/reference/telegram/charts/chartsr.md b/website/content/bot/reference/telegram/charts/chartsr.md index 9c5b55438936..cf0d44273ad3 100644 --- a/website/content/bot/reference/telegram/charts/chartsr.md +++ b/website/content/bot/reference/telegram/charts/chartsr.md @@ -6,7 +6,7 @@ description: OpenBB Telegram Command # chartsr -Support and Resistance Levels for the ticker provided +This command allows the user to retrieve Displays Support and Resistance Levels for the ticker provided. It will display the support and resistance levels of a given ticker on the chart. These levels can help the user in making better trading decisions. ### Usage diff --git a/website/content/bot/reference/telegram/charts/cm.md b/website/content/bot/reference/telegram/charts/cm.md index 81e5887a43ed..bb57aaa399b3 100644 --- a/website/content/bot/reference/telegram/charts/cm.md +++ b/website/content/bot/reference/telegram/charts/cm.md @@ -6,7 +6,7 @@ description: OpenBB Telegram Command # cm -Monthly candlestick chart for the ticker/coin provided. +This command allows the user to retrieve a weekly candlestick chart for the ticker/coin provided. The chart displays the opening and closing prices, the high and low prices, and the trading volume for the week for the specified ticker/coin. ### Usage diff --git a/website/content/bot/reference/telegram/charts/cw.md b/website/content/bot/reference/telegram/charts/cw.md index 2cd6b0632d12..49ad9fed956e 100644 --- a/website/content/bot/reference/telegram/charts/cw.md +++ b/website/content/bot/reference/telegram/charts/cw.md @@ -6,7 +6,7 @@ description: OpenBB Telegram Command # cw -Weekly candlestick chart for the ticker/coin provided. +This command allows the user to retrieve a weekly candlestick chart for the ticker/coin provided. The chart displays the opening and closing prices, the high and low prices, and the trading volume for the week for the specified ticker/coin. ### Usage diff --git a/website/content/bot/reference/telegram/charts/index.mdx b/website/content/bot/reference/telegram/charts/index.mdx index f80c54ec7518..7d2015206dfd 100644 --- a/website/content/bot/reference/telegram/charts/index.mdx +++ b/website/content/bot/reference/telegram/charts/index.mdx @@ -6,57 +6,57 @@ import ReferenceCard from "@site/src/components/General/ReferenceCard"; diff --git a/website/content/bot/reference/telegram/crypto/bigprints.md b/website/content/bot/reference/telegram/crypto/bigprints.md index 8b4a29c41a01..6ddf388fa117 100644 --- a/website/content/bot/reference/telegram/crypto/bigprints.md +++ b/website/content/bot/reference/telegram/crypto/bigprints.md @@ -6,7 +6,7 @@ description: OpenBB Telegram Command # bigprints -Last 15 Large Crypto Prints. +This command allows the user to retrieve the last 15 large prints for a given cryptocurrency pair. The command uses the format "/crypto bigprints coin:BTC-USD" where BTC-USD is the currency pair for which the user wants to retrieve the large prints. This command is useful for analyzing the recent large prints of a given currency pair, which can be used to inform trading decisions. ### Usage diff --git a/website/content/bot/reference/telegram/crypto/bio.md b/website/content/bot/reference/telegram/crypto/bio.md index 8a2040bb3e86..d62eb6424bb1 100644 --- a/website/content/bot/reference/telegram/crypto/bio.md +++ b/website/content/bot/reference/telegram/crypto/bio.md @@ -6,7 +6,7 @@ description: OpenBB Telegram Command # bio -Get fundamental information about a crypto +This command allows the user to retrieve fundamental information about a crypto, such as its current price, 24-hour trading volume, market cap, and other key metrics, by entering a specific crypto symbol (e.g. "BTC") as an argument. ### Usage diff --git a/website/content/bot/reference/telegram/crypto/compfees.md b/website/content/bot/reference/telegram/crypto/compfees.md index 097660d14650..959e21fd6841 100644 --- a/website/content/bot/reference/telegram/crypto/compfees.md +++ b/website/content/bot/reference/telegram/crypto/compfees.md @@ -6,7 +6,7 @@ description: OpenBB Telegram Command # compfees -Get protocol fees over time +This command allows users to retrieve the Protocol fees over time for the given project. ### Usage diff --git a/website/content/bot/reference/telegram/crypto/defi.md b/website/content/bot/reference/telegram/crypto/defi.md index 16f950f50c87..1f350d74a5c6 100644 --- a/website/content/bot/reference/telegram/crypto/defi.md +++ b/website/content/bot/reference/telegram/crypto/defi.md @@ -6,7 +6,7 @@ description: OpenBB Telegram Command # defi -Get top DeFi protocols +This command will retrieve a chart or table of the top DeFi protocols by market capitalization. It will provide a visual representation of the relative size of each protocol, as well as an overview of the total DeFi market size. This will enable users to get a better understanding of the current DeFi landscape and identify which protocols are leading the way. ### Usage diff --git a/website/content/bot/reference/telegram/crypto/fees.md b/website/content/bot/reference/telegram/crypto/fees.md index eae8fb9217c3..2e0be93243b9 100644 --- a/website/content/bot/reference/telegram/crypto/fees.md +++ b/website/content/bot/reference/telegram/crypto/fees.md @@ -6,7 +6,7 @@ description: OpenBB Telegram Command # fees -Fees on a certain date of top crypto protocols +This will provide the user with the fee rate of the top crypto protocols on a specified date, allowing the user to compare different protocols' fees and make an informed decision. ### Usage diff --git a/website/content/bot/reference/telegram/crypto/index.mdx b/website/content/bot/reference/telegram/crypto/index.mdx index 6ffe11c4b1f0..0f06daffffa5 100644 --- a/website/content/bot/reference/telegram/crypto/index.mdx +++ b/website/content/bot/reference/telegram/crypto/index.mdx @@ -6,47 +6,47 @@ import ReferenceCard from "@site/src/components/General/ReferenceCard"; diff --git a/website/content/bot/reference/telegram/crypto/ir.md b/website/content/bot/reference/telegram/crypto/ir.md index 21c73a70d9d7..56b12d3fd47b 100644 --- a/website/content/bot/reference/telegram/crypto/ir.md +++ b/website/content/bot/reference/telegram/crypto/ir.md @@ -6,7 +6,7 @@ description: OpenBB Telegram Command # ir -Get issuance rate of top crypto protocols +This command allows the user to retrieve the issuance rate of the top crypto protocols. The issuance rate is the amount of new tokens that are generated by the protocol over a given period of time. It is a useful metric for understanding the supply dynamics of crypto protocols and is used to inform investment decisions. ### Usage diff --git a/website/content/bot/reference/telegram/crypto/prints.md b/website/content/bot/reference/telegram/crypto/prints.md index 5c6e43358a56..b4f0f2529b92 100644 --- a/website/content/bot/reference/telegram/crypto/prints.md +++ b/website/content/bot/reference/telegram/crypto/prints.md @@ -6,7 +6,7 @@ description: OpenBB Telegram Command # prints -Last 15 Crypto Prints over last 24hrs. +This command allows the user to retrieve the Last 15 Crypto Prints over the last 24 hours for the specified coin. The command will provide information on the price, volume, size, and other metrics associated with the prints. ### Usage diff --git a/website/content/bot/reference/telegram/crypto/top.md b/website/content/bot/reference/telegram/crypto/top.md index f585cfe7a23d..aa5617f94c1b 100644 --- a/website/content/bot/reference/telegram/crypto/top.md +++ b/website/content/bot/reference/telegram/crypto/top.md @@ -6,7 +6,7 @@ description: OpenBB Telegram Command # top -Get top cryptos +This command will retrieve the top cryptocurrencies, ranked by market capitalization, allowing the user to quickly get a snapshot of the current market. ### Usage diff --git a/website/content/bot/reference/telegram/crypto/tvl.md b/website/content/bot/reference/telegram/crypto/tvl.md index f41d3e11944a..0d2b224c7977 100644 --- a/website/content/bot/reference/telegram/crypto/tvl.md +++ b/website/content/bot/reference/telegram/crypto/tvl.md @@ -6,7 +6,7 @@ description: OpenBB Telegram Command # tvl -Get protocols historical TVL +This command allows users to retrieve historical TVL (Total Value Locked) data for any given protocol. It provides a snapshot of the total amount of capital that is currently locked in the protocol, allowing users to easily compare the metrics between different protocols and track their growth over time. ### Usage diff --git a/website/content/bot/reference/telegram/darkpool/allblocks.md b/website/content/bot/reference/telegram/darkpool/allblocks.md index 01c868dbc2c8..215dd102bacd 100644 --- a/website/content/bot/reference/telegram/darkpool/allblocks.md +++ b/website/content/bot/reference/telegram/darkpool/allblocks.md @@ -6,7 +6,7 @@ description: OpenBB Telegram Command # allblocks -Last 15 Block Trades. +The command allows the user to retrieve the last 15 block trades of a given security. This command will provide a summary of the last 15 block trades, including the time, price, quantity, and total gross value of each trade. ### Usage diff --git a/website/content/bot/reference/telegram/darkpool/alldp.md b/website/content/bot/reference/telegram/darkpool/alldp.md index 1aa8be65968b..d98a768baeac 100644 --- a/website/content/bot/reference/telegram/darkpool/alldp.md +++ b/website/content/bot/reference/telegram/darkpool/alldp.md @@ -6,7 +6,7 @@ description: OpenBB Telegram Command # alldp -Last 15 Darkpool Trades +This command allows the user to retrieve the last 15 darkpool trades for the specified stock ticker. A darkpool is a private stock trading system that allows large trades to take place without affecting the public market, providing access to larger and more efficient trades. ### Usage diff --git a/website/content/bot/reference/telegram/darkpool/allprints.md b/website/content/bot/reference/telegram/darkpool/allprints.md index 386492a46bf3..45ef2477bda1 100644 --- a/website/content/bot/reference/telegram/darkpool/allprints.md +++ b/website/content/bot/reference/telegram/darkpool/allprints.md @@ -6,7 +6,7 @@ description: OpenBB Telegram Command # allprints -Last 15 Combination of Dark Pool and Blocks. +This command retrieves the Last 15 Combination of Dark Pool and Blocks for a given ticker symbol. This can be used to view the most recent reported trades that involve Dark Pool and Blocks in the stock market. The results of this command will show the date, time, price, and volume of the trades. ### Usage diff --git a/website/content/bot/reference/telegram/darkpool/bigprintsdp.md b/website/content/bot/reference/telegram/darkpool/bigprintsdp.md index 5f2f13a1ef7d..c94c67afca17 100644 --- a/website/content/bot/reference/telegram/darkpool/bigprintsdp.md +++ b/website/content/bot/reference/telegram/darkpool/bigprintsdp.md @@ -6,7 +6,7 @@ description: OpenBB Telegram Command # bigprintsdp -Combination of Dark Pool and Blocks - Largest over x amount of days. +This command will retrieve the largest combination of dark pool and block trades over a specified amount of days. It will provide a comprehensive view of the biggest dark pool and block trades over the specified number of days and give the user an idea of the market activity over that period. ### Usage diff --git a/website/content/bot/reference/telegram/darkpool/index.mdx b/website/content/bot/reference/telegram/darkpool/index.mdx index e7094856758d..d9ef10368d25 100644 --- a/website/content/bot/reference/telegram/darkpool/index.mdx +++ b/website/content/bot/reference/telegram/darkpool/index.mdx @@ -6,42 +6,42 @@ import ReferenceCard from "@site/src/components/General/ReferenceCard"; diff --git a/website/content/bot/reference/telegram/darkpool/levels.md b/website/content/bot/reference/telegram/darkpool/levels.md index 101d61f7f0fd..ab727a616fa3 100644 --- a/website/content/bot/reference/telegram/darkpool/levels.md +++ b/website/content/bot/reference/telegram/darkpool/levels.md @@ -6,7 +6,7 @@ description: OpenBB Telegram Command # levels -Biggest Levels for All Prints over last X days. +This command allows the user to retrieve the Biggest Levels for All Prints over the last x days for the given ticker. This information is useful in assessing the overall performance of the stock, as it provides information on the largest levels of prints over the last x days. ### Usage diff --git a/website/content/bot/reference/telegram/darkpool/sectors.md b/website/content/bot/reference/telegram/darkpool/sectors.md index 504357b84f2d..cdbf2a922a56 100644 --- a/website/content/bot/reference/telegram/darkpool/sectors.md +++ b/website/content/bot/reference/telegram/darkpool/sectors.md @@ -6,7 +6,7 @@ description: OpenBB Telegram Command # sectors -Summary of all prints by % of MarketCap by Sector +This command allows the user to retrieve a summary of all prints by % of MarketCap by Sector over the last x days. The user will be able to view the sector's market cap divided by total darkpool activity to see possible accumulation. ### Usage diff --git a/website/content/bot/reference/telegram/darkpool/summary.md b/website/content/bot/reference/telegram/darkpool/summary.md index 14133b52afec..970c411694c4 100644 --- a/website/content/bot/reference/telegram/darkpool/summary.md +++ b/website/content/bot/reference/telegram/darkpool/summary.md @@ -6,7 +6,7 @@ description: OpenBB Telegram Command # summary -Summary of all prints by % of MarketCap +This command retrieves a summary of all the prints by percentage of MarketCap over the last x days, sorted by MarketCap. The summary includes the total number of prints and their total percentage of MarketCap, as well as the float and short percentage. ### Usage diff --git a/website/content/bot/reference/telegram/darkpool/topsum.md b/website/content/bot/reference/telegram/darkpool/topsum.md index 9cd53ad78ce5..005bf88ea9e6 100644 --- a/website/content/bot/reference/telegram/darkpool/topsum.md +++ b/website/content/bot/reference/telegram/darkpool/topsum.md @@ -6,7 +6,7 @@ description: OpenBB Telegram Command # topsum -Top Total Block & Dark Pool data. +This command allows the user to retrieve total block and dark pool data summary. It sums all darkpool prints and gives a table of the largest by symbol as well as a graph for comparison. ### Usage diff --git a/website/content/bot/reference/telegram/discovery/arktrades.md b/website/content/bot/reference/telegram/discovery/arktrades.md index d820725e6e71..8b76658c5972 100644 --- a/website/content/bot/reference/telegram/discovery/arktrades.md +++ b/website/content/bot/reference/telegram/discovery/arktrades.md @@ -6,7 +6,7 @@ description: OpenBB Telegram Command # arktrades -Displays trades made by ARK. +This command allows the user to retrieve a list of all trades made by ARK, including the time and amount of each trade. The data is presented in an easy-to-read table format so that the user can quickly analyze the trades made by ARK. ### Usage diff --git a/website/content/bot/reference/telegram/discovery/fgindex.md b/website/content/bot/reference/telegram/discovery/fgindex.md index d295b6bef5f5..6a4e694c1d1e 100644 --- a/website/content/bot/reference/telegram/discovery/fgindex.md +++ b/website/content/bot/reference/telegram/discovery/fgindex.md @@ -6,7 +6,7 @@ description: OpenBB Telegram Command # fgindex -Displays Fear & Greed Index - Investor Sentiment - CNNMoney +This command allows the user to retrieve the Fear & Greed Index, which is an investor sentiment indicator published by CNNMoney. The index measures the levels of fear and greed of the investors in the stock market by observing the momentum, sentiment and volume of stock trading. The index ranges from 0 to 100, with 0 being the most fearful and 100 being the most greedy. ### Usage diff --git a/website/content/bot/reference/telegram/discovery/halts.md b/website/content/bot/reference/telegram/discovery/halts.md index 5011c15cceda..6ccdcc5a9ad2 100644 --- a/website/content/bot/reference/telegram/discovery/halts.md +++ b/website/content/bot/reference/telegram/discovery/halts.md @@ -6,7 +6,7 @@ description: OpenBB Telegram Command # halts -Gives Time and Halt Code of stocks in the market - doesn't work for pennys. +This command allows the user to retrieve the time and halt code of stocks in the market, excluding penny stocks. The output of this command provides the user with the time and halt code of stock that is currently halted or in the process of being halted by the exchange. ### Usage diff --git a/website/content/bot/reference/telegram/discovery/holidays.md b/website/content/bot/reference/telegram/discovery/holidays.md index f27a8fa4163b..07d400e0bc4e 100644 --- a/website/content/bot/reference/telegram/discovery/holidays.md +++ b/website/content/bot/reference/telegram/discovery/holidays.md @@ -6,7 +6,7 @@ description: OpenBB Telegram Command # holidays -Displays Upcoming Market Holidays. +This command allows the user to retrieve a list of upcoming market holidays. The command will return a list of holidays, including their respective dates, along with any other pertinent details, such as whether they are national holidays or not. This command is suitable for any user who needs to stay up to date with upcoming holidays. ### Usage @@ -20,8 +20,6 @@ Displays Upcoming Market Holidays. This command has no parameters - - --- ## Examples diff --git a/website/content/bot/reference/telegram/discovery/index.mdx b/website/content/bot/reference/telegram/discovery/index.mdx index 971cfc426862..e81b8988de73 100644 --- a/website/content/bot/reference/telegram/discovery/index.mdx +++ b/website/content/bot/reference/telegram/discovery/index.mdx @@ -6,42 +6,42 @@ import ReferenceCard from "@site/src/components/General/ReferenceCard"; diff --git a/website/content/bot/reference/telegram/discovery/ipolist.md b/website/content/bot/reference/telegram/discovery/ipolist.md index 7bba0e9de31e..1fa4c40b71fe 100644 --- a/website/content/bot/reference/telegram/discovery/ipolist.md +++ b/website/content/bot/reference/telegram/discovery/ipolist.md @@ -6,7 +6,7 @@ description: OpenBB Telegram Command # ipolist -Displays 10 Upcoming and Recent IPO's. +This command allows the user to view 10 of the most recent and upcoming Initial Public Offerings (IPOs) including the company name, the IPO date, and the stock exchange. This information can help users stay up-to-date with the latest IPOs, and provide them with opportunities to invest in new companies. ### Usage diff --git a/website/content/bot/reference/telegram/discovery/pop.md b/website/content/bot/reference/telegram/discovery/pop.md index df2ee0985102..b131c233cbb3 100644 --- a/website/content/bot/reference/telegram/discovery/pop.md +++ b/website/content/bot/reference/telegram/discovery/pop.md @@ -6,7 +6,7 @@ description: OpenBB Telegram Command # pop -Displays Top 15 Tickers in the last hour or today. /pop 1hr or /pop 1d +This command retrieves the top 15 tickers for the day or hour based on popularity on the OpenBB Bot across all our platforms. It allows users to get an overview of the most popular stocks in the market within the last 24 hours (1d) or 1 Hour (1hr). ### Usage diff --git a/website/content/bot/reference/telegram/discovery/trendingst.md b/website/content/bot/reference/telegram/discovery/trendingst.md index 850dd3dcb41d..b6008201c6b6 100644 --- a/website/content/bot/reference/telegram/discovery/trendingst.md +++ b/website/content/bot/reference/telegram/discovery/trendingst.md @@ -6,7 +6,7 @@ description: OpenBB Telegram Command # trendingst -Display Top 15 Trendings Stocks - StockTwits +This command allows the user to retrieve the top 15 trending stocks from StockTwits according to the most recent discussions. The stocks are displayed in order of most trending, as determined by the most discussed stocks in the StockTwits community. This command is an efficient way to stay up to date on the most popular stocks in the market. ### Usage diff --git a/website/content/bot/reference/telegram/discovery/wsb.md b/website/content/bot/reference/telegram/discovery/wsb.md index 668dbc60a1e3..3a8e3cd9dc8e 100644 --- a/website/content/bot/reference/telegram/discovery/wsb.md +++ b/website/content/bot/reference/telegram/discovery/wsb.md @@ -6,7 +6,7 @@ description: OpenBB Telegram Command # wsb -Display Top 15 Trendings Stocks - WSB +This command allows the user to view the top 15 trending stocks on r/WallStreetBets (WSB) using the /disc wsb command. It displays the mentions count for popular stocks on the platform. ### Usage diff --git a/website/content/bot/reference/telegram/duediligence/ah.md b/website/content/bot/reference/telegram/duediligence/ah.md index 209291b02161..830eaad9a73e 100644 --- a/website/content/bot/reference/telegram/duediligence/ah.md +++ b/website/content/bot/reference/telegram/duediligence/ah.md @@ -6,7 +6,7 @@ description: OpenBB Telegram Command # ah -Afterhours data for a given stock ticker +This command allows the user to retrieve afterhours data for a given stock ticker. The data retrieved will include the stock's current price, the highest and lowest prices of the ah session, the volume traded, and the change in the afterhours market. ### Usage diff --git a/website/content/bot/reference/telegram/duediligence/analyst.md b/website/content/bot/reference/telegram/duediligence/analyst.md index 16a494346f77..ed971eba90c5 100644 --- a/website/content/bot/reference/telegram/duediligence/analyst.md +++ b/website/content/bot/reference/telegram/duediligence/analyst.md @@ -6,7 +6,7 @@ description: OpenBB Telegram Command # analyst -Displays analyst recommendations. +This command allows the user to retrieve analyst recommendations for a given stock ticker. ### Usage diff --git a/website/content/bot/reference/telegram/duediligence/bio_stocks.md b/website/content/bot/reference/telegram/duediligence/bio_stocks.md index af56ee4622f2..2a2a7ee9d656 100644 --- a/website/content/bot/reference/telegram/duediligence/bio_stocks.md +++ b/website/content/bot/reference/telegram/duediligence/bio_stocks.md @@ -6,7 +6,7 @@ description: OpenBB Telegram Command # bio_stocks -Displays a Stock's Company Info. +This command retrieves a stock's company information and displays it to the user. It takes a stock ticker as an argument and returns information such as the company's name, description, sector, industry, CEO, and more. ### Usage diff --git a/website/content/bot/reference/telegram/duediligence/customer.md b/website/content/bot/reference/telegram/duediligence/customer.md index a8b02f4385b0..a9ec49f8915c 100644 --- a/website/content/bot/reference/telegram/duediligence/customer.md +++ b/website/content/bot/reference/telegram/duediligence/customer.md @@ -6,7 +6,7 @@ description: OpenBB Telegram Command # customer -Displays customers of the company. +This command allows the user to display customers of the company using the given symbol. ### Usage diff --git a/website/content/bot/reference/telegram/duediligence/divinfo.md b/website/content/bot/reference/telegram/duediligence/divinfo.md index 5cfc7f679549..3e8323a8db86 100644 --- a/website/content/bot/reference/telegram/duediligence/divinfo.md +++ b/website/content/bot/reference/telegram/duediligence/divinfo.md @@ -6,7 +6,7 @@ description: OpenBB Telegram Command # divinfo -Displays Dividend information for a stock. +This command retrieves dividend information for a given stock. The data includes dividend rate, yield, and ex-div date. ### Usage diff --git a/website/content/bot/reference/telegram/duediligence/earnings.md b/website/content/bot/reference/telegram/duediligence/earnings.md index 412caa2d7917..e3fdb7496f3f 100644 --- a/website/content/bot/reference/telegram/duediligence/earnings.md +++ b/website/content/bot/reference/telegram/duediligence/earnings.md @@ -6,7 +6,7 @@ description: OpenBB Telegram Command # earnings -Earnings that are expected to occur in the next business days. (Sorted by market cap) +This command allows the user to retrieve the expected earnings for the given business day. The displayed earnings will include company ticker, expected time, sector, and float of the company. This information can be used to help the user make informed decisions about their investments. ### Usage diff --git a/website/content/bot/reference/telegram/duediligence/ermove.md b/website/content/bot/reference/telegram/duediligence/ermove.md index f7983ac4f1ab..f2493029d918 100644 --- a/website/content/bot/reference/telegram/duediligence/ermove.md +++ b/website/content/bot/reference/telegram/duediligence/ermove.md @@ -6,7 +6,7 @@ description: OpenBB Telegram Command # ermove -Implied move for a stock based on option prices. +This command allows the user to retrieve the implied move for a stock based on the current option prices. The implied move is a measure of how far the stock is expected to move during the option's expiration. ### Usage diff --git a/website/content/bot/reference/telegram/duediligence/financials.md b/website/content/bot/reference/telegram/duediligence/financials.md index f771921bfd82..b6942e475a3a 100644 --- a/website/content/bot/reference/telegram/duediligence/financials.md +++ b/website/content/bot/reference/telegram/duediligence/financials.md @@ -6,7 +6,7 @@ description: OpenBB Telegram Command # financials -Gives Total Assets, Cash, Debt, Liabilities, Rev for Company. +This command will retrieve the financials of the company with the given ticker which includes total assets, cash, debt, liabilities, and revenue. This information can be used to analyze the financial health of the company. ### Usage diff --git a/website/content/bot/reference/telegram/duediligence/index.mdx b/website/content/bot/reference/telegram/duediligence/index.mdx index d42bd49031ae..72b972d1da4f 100644 --- a/website/content/bot/reference/telegram/duediligence/index.mdx +++ b/website/content/bot/reference/telegram/duediligence/index.mdx @@ -6,87 +6,87 @@ import ReferenceCard from "@site/src/components/General/ReferenceCard"; diff --git a/website/content/bot/reference/telegram/duediligence/insiders.md b/website/content/bot/reference/telegram/duediligence/insiders.md index 83c9d9104e63..0611bd3d6fe5 100644 --- a/website/content/bot/reference/telegram/duediligence/insiders.md +++ b/website/content/bot/reference/telegram/duediligence/insiders.md @@ -6,7 +6,7 @@ description: OpenBB Telegram Command # insiders -Displays 60 latest insider transactions for given stock +This command allows the user to retrieve the 15 most recent insider transactions for a given stock. It will provide information such as the date of the transaction, the company insider involved, the number of shares traded, the type of transaction (buy/sell), and the average price of the transaction. ### Usage diff --git a/website/content/bot/reference/telegram/duediligence/instholdings.md b/website/content/bot/reference/telegram/duediligence/instholdings.md index 602da66cf45a..92e00a0e1d08 100644 --- a/website/content/bot/reference/telegram/duediligence/instholdings.md +++ b/website/content/bot/reference/telegram/duediligence/instholdings.md @@ -6,7 +6,7 @@ description: OpenBB Telegram Command # instholdings -Displays top 15 Institutional Holdings for given stock +This command allows the user to retrieve the top 15 institutional holdings for a given stock. This list is retrieved from the most recent available institutional holdings reported to the United States Securities and Exchange Commission. ### Usage diff --git a/website/content/bot/reference/telegram/duediligence/nexter.md b/website/content/bot/reference/telegram/duediligence/nexter.md index 55fa0be6c2b6..f9e063b29a5a 100644 --- a/website/content/bot/reference/telegram/duediligence/nexter.md +++ b/website/content/bot/reference/telegram/duediligence/nexter.md @@ -6,7 +6,7 @@ description: OpenBB Telegram Command # nexter -Returns next Earnings Date for a stock. +This command will retrieve the next earnings date for the given stock ticker symbol. ### Usage diff --git a/website/content/bot/reference/telegram/duediligence/pm.md b/website/content/bot/reference/telegram/duediligence/pm.md index e923ad0a2d05..35f87f1182ea 100644 --- a/website/content/bot/reference/telegram/duediligence/pm.md +++ b/website/content/bot/reference/telegram/duediligence/pm.md @@ -6,7 +6,7 @@ description: OpenBB Telegram Command # pm -Premarket data for a given stock ticker +This command allows the user to retrieve premarket data for a given stock ticker. It will fetch the latest price, the premarket change, and the premarket percentage change of the selected stock. This is useful for those who want to get an idea of the stock's performance before the regular market opens. ### Usage diff --git a/website/content/bot/reference/telegram/duediligence/pt.md b/website/content/bot/reference/telegram/duediligence/pt.md index a03e0a705a4f..4a70ba333985 100644 --- a/website/content/bot/reference/telegram/duediligence/pt.md +++ b/website/content/bot/reference/telegram/duediligence/pt.md @@ -6,7 +6,7 @@ description: OpenBB Telegram Command # pt -Displays chart with price targets. +This command allows the user to retrieve a chart with price targets for the specified ticker. The chart will provide information on the current price, target prices and analyst ratings, allowing the user to make more informed decisions. ### Usage diff --git a/website/content/bot/reference/telegram/duediligence/sec.md b/website/content/bot/reference/telegram/duediligence/sec.md index d1e102ffddd5..52688209cea8 100644 --- a/website/content/bot/reference/telegram/duediligence/sec.md +++ b/website/content/bot/reference/telegram/duediligence/sec.md @@ -6,7 +6,7 @@ description: OpenBB Telegram Command # sec -Displays recent SEC filings. +This command allows the user to retrieve the most recent SEC filings related to the specified ticker symbol. The filings can include company financials, registration statements, and periodic reports such as 10-Ks, 8-Ks, and 10-Qs. This command is especially useful for investors and analysts who need up-to-date information on a company's financial performance or other corporate documents. ### Usage diff --git a/website/content/bot/reference/telegram/duediligence/splits.md b/website/content/bot/reference/telegram/duediligence/splits.md index 9d72adb9b1b0..6802807a7491 100644 --- a/website/content/bot/reference/telegram/duediligence/splits.md +++ b/website/content/bot/reference/telegram/duediligence/splits.md @@ -6,7 +6,7 @@ description: OpenBB Telegram Command # splits -List of recent Stock splits for all tickers or for a given ticker. +This command retrieves a list of recent stock splits for a given ticker. This command is useful for tracking the splits of a particular stock over time. ### Usage diff --git a/website/content/bot/reference/telegram/duediligence/supplier.md b/website/content/bot/reference/telegram/duediligence/supplier.md index 744f5769b078..e99f1586a33d 100644 --- a/website/content/bot/reference/telegram/duediligence/supplier.md +++ b/website/content/bot/reference/telegram/duediligence/supplier.md @@ -6,7 +6,7 @@ description: OpenBB Telegram Command # supplier -Displays suppliers of the company. +This command allows users to retrieve the list of suppliers associated with the company with the given ticker. ### Usage diff --git a/website/content/bot/reference/telegram/duediligence/ytd.md b/website/content/bot/reference/telegram/duediligence/ytd.md index a41995c09272..96b6e397046d 100644 --- a/website/content/bot/reference/telegram/duediligence/ytd.md +++ b/website/content/bot/reference/telegram/duediligence/ytd.md @@ -6,7 +6,7 @@ description: OpenBB Telegram Command # ytd -Period Performance for a stock. +This command allows the user to retrieve the stock's year-to-date performance for a particular ticker symbol. It displays the stock's performance over various periods of time, from 5 days to 5 years. ### Usage diff --git a/website/content/bot/reference/telegram/economy/bonds.md b/website/content/bot/reference/telegram/economy/bonds.md index 4a51bf35a262..86199da377b2 100644 --- a/website/content/bot/reference/telegram/economy/bonds.md +++ b/website/content/bot/reference/telegram/economy/bonds.md @@ -6,7 +6,7 @@ description: OpenBB Telegram Command # bonds -Bonds overview. Market can be US or Global. +This command allows the user to retrieve an overview of Global or US bonds. It includes information about the type of bond, the rate of return, yield, and yield change. The data is presented in an easy to read format and can be used to inform decisions about investing in Global or US bonds. ### Usage diff --git a/website/content/bot/reference/telegram/economy/calendar.md b/website/content/bot/reference/telegram/economy/calendar.md index 1999b79d8eda..c1e778eb85f1 100644 --- a/website/content/bot/reference/telegram/economy/calendar.md +++ b/website/content/bot/reference/telegram/economy/calendar.md @@ -6,7 +6,7 @@ description: OpenBB Telegram Command # calendar -Displays Economic Calendar of events +This command allows the user to retrieve an Economic Calendar for the day, which displays the upcoming economic events along with their expected impact. The Economic Calendar includes a list of key economic indicators such as GDP, inflation, employment, and more, which can provide insight into the future trajectory of the economy. ### Usage @@ -20,8 +20,6 @@ Displays Economic Calendar of events This command has no parameters - - --- ## Examples diff --git a/website/content/bot/reference/telegram/economy/commodities.md b/website/content/bot/reference/telegram/economy/commodities.md index 2fed388ac7b1..450c984ff1ac 100644 --- a/website/content/bot/reference/telegram/economy/commodities.md +++ b/website/content/bot/reference/telegram/economy/commodities.md @@ -6,7 +6,7 @@ description: OpenBB Telegram Command # commodities -Futures and commodities overview. +This command allows users to quickly and easily retrieve an overview of Futures and commodities. It provides the last price and change for the day. ### Usage diff --git a/website/content/bot/reference/telegram/economy/currencies.md b/website/content/bot/reference/telegram/economy/currencies.md index d265c32acce0..5e854f787991 100644 --- a/website/content/bot/reference/telegram/economy/currencies.md +++ b/website/content/bot/reference/telegram/economy/currencies.md @@ -6,7 +6,7 @@ description: OpenBB Telegram Command # currencies -Currencies overview. +This command allows the user to retrieve an overview of all available currencies. It will provide the user with information such as the currency name, price, and change. ### Usage diff --git a/website/content/bot/reference/telegram/economy/fedrates.md b/website/content/bot/reference/telegram/economy/fedrates.md index f7414eb5b391..2bc345d7f338 100644 --- a/website/content/bot/reference/telegram/economy/fedrates.md +++ b/website/content/bot/reference/telegram/economy/fedrates.md @@ -6,7 +6,7 @@ description: OpenBB Telegram Command # fedrates -Upcoming Federal Rate decision dates and chances +This command allows users to quickly and easily retrieve upcoming Federal Rate decision dates and chances. It is a convenient way to stay up to date with Federal Rate decisions. ### Usage diff --git a/website/content/bot/reference/telegram/economy/index.mdx b/website/content/bot/reference/telegram/economy/index.mdx index 84b6fa0a5033..ddb84ef68c6f 100644 --- a/website/content/bot/reference/telegram/economy/index.mdx +++ b/website/content/bot/reference/telegram/economy/index.mdx @@ -6,42 +6,42 @@ import ReferenceCard from "@site/src/components/General/ReferenceCard"; diff --git a/website/content/bot/reference/telegram/economy/indices.md b/website/content/bot/reference/telegram/economy/indices.md index 83acdda3df82..4e4ab062d7fa 100644 --- a/website/content/bot/reference/telegram/economy/indices.md +++ b/website/content/bot/reference/telegram/economy/indices.md @@ -6,7 +6,7 @@ description: OpenBB Telegram Command # indices -US indices overview. +This command provides a real-time overview of the major US stock indices, such as the Dow Jones Industrial Average, the S&P 500, and the NASDAQ Composite. It displays the most current index values, as well as the percentage change from the previous day. ### Usage diff --git a/website/content/bot/reference/telegram/economy/revrepo.md b/website/content/bot/reference/telegram/economy/revrepo.md index aa8fbacfb690..5a97495a024f 100644 --- a/website/content/bot/reference/telegram/economy/revrepo.md +++ b/website/content/bot/reference/telegram/economy/revrepo.md @@ -6,7 +6,7 @@ description: OpenBB Telegram Command # revrepo -Displays Reverse Repo. +This command allows the user to retrieve Reverse Repo data for a default period of 35 days. This data includes information such as the total amount of Reverse Repo, the number of parties, the average, and difference. ### Usage diff --git a/website/content/bot/reference/telegram/economy/yieldcurve.md b/website/content/bot/reference/telegram/economy/yieldcurve.md index ef7bdb07e563..168efbf909d9 100644 --- a/website/content/bot/reference/telegram/economy/yieldcurve.md +++ b/website/content/bot/reference/telegram/economy/yieldcurve.md @@ -6,7 +6,7 @@ description: OpenBB Telegram Command # yieldcurve -Displays US Bonds yield curve +This command allows the user to retrieve the US Bonds yield curve. The yield curve is a graph that plots the yields of different bonds with different maturities, providing an indication of the direction of interest rates. ### Usage @@ -20,8 +20,6 @@ Displays US Bonds yield curve This command has no parameters - - --- ## Examples diff --git a/website/content/bot/reference/telegram/etf/holdings.md b/website/content/bot/reference/telegram/etf/holdings.md index 5a976b43e901..5b06e67e16b6 100644 --- a/website/content/bot/reference/telegram/etf/holdings.md +++ b/website/content/bot/reference/telegram/etf/holdings.md @@ -6,7 +6,7 @@ description: OpenBB Telegram Command # etf holdings -ETF Commands `/etf tops`, `/etf holdings` +This command returns the holdings for an ETF sorted by percent of ETF. ### Usage diff --git a/website/content/bot/reference/telegram/etf/index.mdx b/website/content/bot/reference/telegram/etf/index.mdx index c3156d98bd1a..f3acfd72d7c6 100644 --- a/website/content/bot/reference/telegram/etf/index.mdx +++ b/website/content/bot/reference/telegram/etf/index.mdx @@ -6,12 +6,12 @@ import ReferenceCard from "@site/src/components/General/ReferenceCard"; diff --git a/website/content/bot/reference/telegram/etf/tops.md b/website/content/bot/reference/telegram/etf/tops.md index 7c7e0b7b330a..3656b89e7a6b 100644 --- a/website/content/bot/reference/telegram/etf/tops.md +++ b/website/content/bot/reference/telegram/etf/tops.md @@ -6,7 +6,7 @@ description: OpenBB Telegram Command # etf tops -ETF Commands `/etf tops`, `/etf holdings` +This command returns the top ETFs for the day - sorted by gainers, losers, or active. ### Usage diff --git a/website/content/bot/reference/telegram/flow/bigflow.md b/website/content/bot/reference/telegram/flow/bigflow.md index ee1b5ed8da63..202dda3b34b8 100644 --- a/website/content/bot/reference/telegram/flow/bigflow.md +++ b/website/content/bot/reference/telegram/flow/bigflow.md @@ -6,7 +6,7 @@ description: OpenBB Telegram Command # bigflow -Returns the top 20 largest flow by premium for a stock +This command retrieves the top 20 largest flow by premium for a stock. We calculate the largest flow by multiplying the price of the option at the time of the trade by the volume of that trade. ### Usage diff --git a/website/content/bot/reference/telegram/flow/flow/day.md b/website/content/bot/reference/telegram/flow/flow/day.md index f7cd621d2685..5d37a626dee7 100644 --- a/website/content/bot/reference/telegram/flow/flow/day.md +++ b/website/content/bot/reference/telegram/flow/flow/day.md @@ -6,7 +6,7 @@ description: OpenBB Telegram Command # flow -Returns the flow for a stock. /flow, /flow wk, /flow open, /flow unu, /flow prem +This command retrieves the most recent flow for a stock with the specified ticker symbol. The command will return the most up-to-date flow data for that stock over $25,000. ### Usage diff --git a/website/content/bot/reference/telegram/flow/flow/index.mdx b/website/content/bot/reference/telegram/flow/flow/index.mdx index 3a1bebe0b7ea..8eae011fe2be 100644 --- a/website/content/bot/reference/telegram/flow/flow/index.mdx +++ b/website/content/bot/reference/telegram/flow/flow/index.mdx @@ -6,27 +6,27 @@ import ReferenceCard from "@site/src/components/General/ReferenceCard"; diff --git a/website/content/bot/reference/telegram/flow/flow/open.md b/website/content/bot/reference/telegram/flow/flow/open.md index 56717ec600d1..0eee42ae9def 100644 --- a/website/content/bot/reference/telegram/flow/flow/open.md +++ b/website/content/bot/reference/telegram/flow/flow/open.md @@ -6,7 +6,7 @@ description: OpenBB Telegram Command # flow open -Returns the opening flow for a stock. (volume > open interest on the order) /flow open +This command allows the user to retrieve the Top 20 flows by premium for a stock with the "Opening" condition - Volume exceeding Open Interest on the trade. ### Usage diff --git a/website/content/bot/reference/telegram/flow/flow/prem.md b/website/content/bot/reference/telegram/flow/flow/prem.md index f4b88166b76e..8c38678179bc 100644 --- a/website/content/bot/reference/telegram/flow/flow/prem.md +++ b/website/content/bot/reference/telegram/flow/flow/prem.md @@ -6,7 +6,7 @@ description: OpenBB Telegram Command # flow prem -Returns a chart of premium for the day +This command allows the user to retrieve a chart displaying the sum of premium for call/put options for a particular ticker on a daily basis. This chart will help users quickly and easily visualize the changing premium amounts over time. ### Usage diff --git a/website/content/bot/reference/telegram/flow/flow/unu.md b/website/content/bot/reference/telegram/flow/flow/unu.md index c761ef5e13ec..ebf4d1f5ed91 100644 --- a/website/content/bot/reference/telegram/flow/flow/unu.md +++ b/website/content/bot/reference/telegram/flow/flow/unu.md @@ -6,7 +6,7 @@ description: OpenBB Telegram Command # flow unu -Returns the unusual flow for a stock (high ratio of volume to oi). /flow unu +This command allows users to retrieve Unusual Options Trades over $100,000 premium and Total Volume exceeding Open Interest. This data can be used to identify potential opportunities in the options market allowing users to quickly and easily identify potential unusual activity. ### Usage diff --git a/website/content/bot/reference/telegram/flow/flow/wk.md b/website/content/bot/reference/telegram/flow/flow/wk.md index 9edfc995c802..36fa7353414b 100644 --- a/website/content/bot/reference/telegram/flow/flow/wk.md +++ b/website/content/bot/reference/telegram/flow/flow/wk.md @@ -6,7 +6,7 @@ description: OpenBB Telegram Command # flow wk -Returns the weekly flow for a stock (options expiring that Friday). /flow wk +This command allows the user to retrieve the Top 20 flow by Premium for a stock with an option contact expiring that week. ### Usage diff --git a/website/content/bot/reference/telegram/flow/flowsum/day.md b/website/content/bot/reference/telegram/flow/flowsum/day.md index aedf61630316..60ef4f9efedc 100644 --- a/website/content/bot/reference/telegram/flow/flowsum/day.md +++ b/website/content/bot/reference/telegram/flow/flowsum/day.md @@ -6,7 +6,7 @@ description: OpenBB Telegram Command # flowsum -Graph Total Premium of a stock. /flowsum, /flowsum wk, /flowsum exp, /flowsum top +This command allows the user to retrieve the total premium of the given stock ticker for the current trading day. We categorize the calls and puts by where the trade occurred on the bid/ask. For example, Above Ask, means the trade happened over the current Ask price. ### Usage diff --git a/website/content/bot/reference/telegram/flow/flowsum/exp.md b/website/content/bot/reference/telegram/flow/flowsum/exp.md index 999194d1c84b..d7fdbecdea5b 100644 --- a/website/content/bot/reference/telegram/flow/flowsum/exp.md +++ b/website/content/bot/reference/telegram/flow/flowsum/exp.md @@ -6,7 +6,7 @@ description: OpenBB Telegram Command # flowsum exp -Graph Total Premium of a stock with a given expiration only. +This command allows the user to retrieve the total premium of the given stock ticker for the current trading day by expiration. We categorize the calls and puts by where the trade occurred on the bid/ask. For example, Above Ask, means the trade happened over the current Ask price. ### Usage diff --git a/website/content/bot/reference/telegram/flow/flowsum/index.mdx b/website/content/bot/reference/telegram/flow/flowsum/index.mdx index 324de4dc0d8a..78951f71d6bf 100644 --- a/website/content/bot/reference/telegram/flow/flowsum/index.mdx +++ b/website/content/bot/reference/telegram/flow/flowsum/index.mdx @@ -6,22 +6,22 @@ import ReferenceCard from "@site/src/components/General/ReferenceCard"; diff --git a/website/content/bot/reference/telegram/flow/flowsum/top.md b/website/content/bot/reference/telegram/flow/flowsum/top.md index 91c116aa008a..05230e69d8d9 100644 --- a/website/content/bot/reference/telegram/flow/flowsum/top.md +++ b/website/content/bot/reference/telegram/flow/flowsum/top.md @@ -6,7 +6,7 @@ description: OpenBB Telegram Command # flowsum top -Graph Total Premium of a top 10 stocks by calls and puts. +This command allows the user to retrieve the top flow for the day for Calls and Puts by stock. This will provide the user with an overview of the market's current sentiment towards a particular stock as well as an overall view of the market's sentiment towards all stocks. ### Usage diff --git a/website/content/bot/reference/telegram/flow/flowsum/wk.md b/website/content/bot/reference/telegram/flow/flowsum/wk.md index 416c388b94aa..1ebd57cbcf72 100644 --- a/website/content/bot/reference/telegram/flow/flowsum/wk.md +++ b/website/content/bot/reference/telegram/flow/flowsum/wk.md @@ -6,7 +6,7 @@ description: OpenBB Telegram Command # flowsum wk -Graph Total Premium of a stock for the week. /flowsum, /flowsum wk, /flowsum exp, /flowsum top +This command allows the user to retrieve the top flow for the week for Calls and Puts by stock. This will provide the user with an overview of the market's current sentiment towards a particular stock as well as an overall view of the market's sentiment towards all stocks. ### Usage diff --git a/website/content/bot/reference/telegram/flow/index.mdx b/website/content/bot/reference/telegram/flow/index.mdx index 024eae2e6d02..e2d61c2823f9 100644 --- a/website/content/bot/reference/telegram/flow/index.mdx +++ b/website/content/bot/reference/telegram/flow/index.mdx @@ -16,17 +16,17 @@ import ReferenceCard from "@site/src/components/General/ReferenceCard"; /> diff --git a/website/content/bot/reference/telegram/flow/sectorsflow.md b/website/content/bot/reference/telegram/flow/sectorsflow.md index 0eba52cb1369..c8ef8231f829 100644 --- a/website/content/bot/reference/telegram/flow/sectorsflow.md +++ b/website/content/bot/reference/telegram/flow/sectorsflow.md @@ -6,7 +6,7 @@ description: OpenBB Telegram Command # sectorsflow -Summary of all flow by % of MarketCap by Sector +This command retrieves a summary of all flows by MarketCap percentage per sector over the past x days. ### Usage diff --git a/website/content/bot/reference/telegram/flow/summaryflow.md b/website/content/bot/reference/telegram/flow/summaryflow.md index 244990d16ca7..f9007bdc4675 100644 --- a/website/content/bot/reference/telegram/flow/summaryflow.md +++ b/website/content/bot/reference/telegram/flow/summaryflow.md @@ -6,7 +6,7 @@ description: OpenBB Telegram Command # summaryflow -Summary of all flow by % of MarketCap +This command allows the user to retrieve a summary of all the flow per stock over the last x days, with the result sorted in various ways. This summary will include the ratio to total market capitalization, the number of trades, and other information. ### Usage diff --git a/website/content/bot/reference/telegram/fun/8ball.md b/website/content/bot/reference/telegram/fun/8ball.md index 374cb80b5a0e..8bf336fdd692 100644 --- a/website/content/bot/reference/telegram/fun/8ball.md +++ b/website/content/bot/reference/telegram/fun/8ball.md @@ -6,7 +6,7 @@ description: OpenBB Telegram Command # 8ball -Ask 8 ball a question. +This command allows the user to ask the 8-ball a question and receive an answer. The question must end in a question mark. ### Usage diff --git a/website/content/bot/reference/telegram/fun/flip.md b/website/content/bot/reference/telegram/fun/flip.md index a6204ba29e65..af6e35c06169 100644 --- a/website/content/bot/reference/telegram/fun/flip.md +++ b/website/content/bot/reference/telegram/fun/flip.md @@ -6,7 +6,7 @@ description: OpenBB Telegram Command # flip -Flip a coin for your witcher +This command allows the user to simulate a coin flip displaying either a 'Heads' or 'Tails'. ### Usage diff --git a/website/content/bot/reference/telegram/fun/index.mdx b/website/content/bot/reference/telegram/fun/index.mdx index ed9f27e8d55b..5bc15dce8ed3 100644 --- a/website/content/bot/reference/telegram/fun/index.mdx +++ b/website/content/bot/reference/telegram/fun/index.mdx @@ -6,17 +6,17 @@ import ReferenceCard from "@site/src/components/General/ReferenceCard"; diff --git a/website/content/bot/reference/telegram/fun/urban.md b/website/content/bot/reference/telegram/fun/urban.md index dc420974a962..689f34393706 100644 --- a/website/content/bot/reference/telegram/fun/urban.md +++ b/website/content/bot/reference/telegram/fun/urban.md @@ -6,7 +6,7 @@ description: OpenBB Telegram Command # urban -Searches on the Urban Dictionary. +This command allows the user to search for a definition of a word on Urban Dictionary. ### Usage diff --git a/website/content/bot/reference/telegram/general/futures.md b/website/content/bot/reference/telegram/general/futures.md index 9290b1704cf4..bf4592214a69 100644 --- a/website/content/bot/reference/telegram/general/futures.md +++ b/website/content/bot/reference/telegram/general/futures.md @@ -6,7 +6,7 @@ description: OpenBB Telegram Command # futures -Displays Futures. +This command allows the user to retrieve futures prices on the stock market. ### Usage diff --git a/website/content/bot/reference/telegram/general/index.mdx b/website/content/bot/reference/telegram/general/index.mdx index ff29b8519ac4..4982c6e6c950 100644 --- a/website/content/bot/reference/telegram/general/index.mdx +++ b/website/content/bot/reference/telegram/general/index.mdx @@ -6,27 +6,22 @@ import ReferenceCard from "@site/src/components/General/ReferenceCard"; - diff --git a/website/content/bot/reference/telegram/general/news.md b/website/content/bot/reference/telegram/general/news.md index 1695d85ee810..5d63e7650cf6 100644 --- a/website/content/bot/reference/telegram/general/news.md +++ b/website/content/bot/reference/telegram/general/news.md @@ -6,7 +6,7 @@ description: OpenBB Telegram Command # news -Display the most recent news for ticker +This command allows the user to retrieve the latest news for a given ticker. ### Usage diff --git a/website/content/bot/reference/telegram/general/quote.md b/website/content/bot/reference/telegram/general/quote.md index cdee5d19ac80..0ae64e278626 100644 --- a/website/content/bot/reference/telegram/general/quote.md +++ b/website/content/bot/reference/telegram/general/quote.md @@ -6,7 +6,7 @@ description: OpenBB Telegram Command # quote -Display quote stats for a stock, 52 week high/low, market cap/float, and 200/50 day MA +This command allows the user to retrieve display quote stats for a stock - including the 52 week high/low, market cap/float, and 200/50 day moving averages. The command allows you to quickly and easily access the requested quote stats for the given stock. ### Usage diff --git a/website/content/bot/reference/telegram/general/ta.md b/website/content/bot/reference/telegram/general/ta.md index 3508a9d8955b..8996d52b0e04 100644 --- a/website/content/bot/reference/telegram/general/ta.md +++ b/website/content/bot/reference/telegram/general/ta.md @@ -6,7 +6,7 @@ description: OpenBB Telegram Command # ta -Displays a given stocks Technical Analysis summary. +This command allows the user to retrieve a technical analysis summary for a given stock ticker. The summary includes several indicators such as moving averages, fibonacci levels, support and resistance levels, and other technical metrics. ### Usage diff --git a/website/content/bot/reference/telegram/general/watchlist.md b/website/content/bot/reference/telegram/general/watchlist.md deleted file mode 100644 index 352786635192..000000000000 --- a/website/content/bot/reference/telegram/general/watchlist.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### -title: watchlist -description: OpenBB Telegram Command ---- - -# watchlist - -Display the tickers in your watchlist - Registered users get 3 for free! - -### Usage - -```python wordwrap -/watchlist -``` - ---- - -## Parameters - -| Name | Description | Optional | Choices | -| ---- | ----------- | -------- | ------- | -| watchlist_add | How to add more tickers to your watchlist | True | None | -| watchlist_remove | If you want to remove symbols | True | None | - ---- - -## Examples - -``` -/watchlist -``` -``` -/watchlist_add AMD,GOOG,TSLA -``` -``` -/watchlist_remove -``` ---- diff --git a/website/content/bot/reference/telegram/government/contracts.md b/website/content/bot/reference/telegram/government/contracts.md index bb43d12c32a7..2c7a33f5eb27 100644 --- a/website/content/bot/reference/telegram/government/contracts.md +++ b/website/content/bot/reference/telegram/government/contracts.md @@ -6,7 +6,7 @@ description: OpenBB Telegram Command # contracts -Displays Top 15 Government contracts by amount for all tickers or for a specific ticker. +This command will allow the user to retrieve the top 15 government contracts by amount for a specific ticker. ### Usage diff --git a/website/content/bot/reference/telegram/government/house.md b/website/content/bot/reference/telegram/government/house.md index 092420cd33ee..3ca0100e2ce6 100644 --- a/website/content/bot/reference/telegram/government/house.md +++ b/website/content/bot/reference/telegram/government/house.md @@ -6,7 +6,7 @@ description: OpenBB Telegram Command # house -Displays recent house trades for all tickers or a specific ticker. +This command allows the user to retrieve recent house trades for a specific ticker. ### Usage diff --git a/website/content/bot/reference/telegram/government/index.mdx b/website/content/bot/reference/telegram/government/index.mdx index 07b24e39364a..445f5cb2d96e 100644 --- a/website/content/bot/reference/telegram/government/index.mdx +++ b/website/content/bot/reference/telegram/government/index.mdx @@ -6,17 +6,17 @@ import ReferenceCard from "@site/src/components/General/ReferenceCard"; diff --git a/website/content/bot/reference/telegram/government/senate.md b/website/content/bot/reference/telegram/government/senate.md index 7fe6657e2143..552c4b7f57e2 100644 --- a/website/content/bot/reference/telegram/government/senate.md +++ b/website/content/bot/reference/telegram/government/senate.md @@ -6,7 +6,7 @@ description: OpenBB Telegram Command # senate -Displays recent senate trades for all tickers or for a specific ticker +This command allows a user to view the recent trades of senate members for a specific ticker. ### Usage diff --git a/website/content/bot/reference/telegram/index.mdx b/website/content/bot/reference/telegram/index.mdx index d0bc7d29a2c3..916c0898c12a 100644 --- a/website/content/bot/reference/telegram/index.mdx +++ b/website/content/bot/reference/telegram/index.mdx @@ -51,7 +51,7 @@ import ReferenceCard from "@site/src/components/General/ReferenceCard"; /> diff --git a/website/content/bot/reference/telegram/nft/nftcollection.md b/website/content/bot/reference/telegram/nft/nftcollection.md index c3b08989cf2e..3f00859c834d 100644 --- a/website/content/bot/reference/telegram/nft/nftcollection.md +++ b/website/content/bot/reference/telegram/nft/nftcollection.md @@ -6,7 +6,7 @@ description: OpenBB Telegram Command # nftcollection -Get NFT Collection Data +This command retrieves a collection of Non-Fungible Token (NFT) data associated with the specified slug. It returns the collection's metadata, including the owner, the number of items in the collection, the total NFTs minted, and various other data on the NFT. ### Usage diff --git a/website/content/bot/reference/telegram/nft/nfttop.md b/website/content/bot/reference/telegram/nft/nfttop.md index 1dbbdc9eac2c..6f4a91526429 100644 --- a/website/content/bot/reference/telegram/nft/nfttop.md +++ b/website/content/bot/reference/telegram/nft/nfttop.md @@ -6,7 +6,7 @@ description: OpenBB Telegram Command # nfttop -Get Top NFT Collections from Ethereum +This command allows users to retrieve the top NFT collections from Ethereum. It provides a list of the most popular and valuable NFT collections, helping users to keep abreast of the latest trends in the NFT space. ### Usage diff --git a/website/content/bot/reference/telegram/options/chains.md b/website/content/bot/reference/telegram/options/chains.md index 25a18e46aa52..ea0c28017b79 100644 --- a/website/content/bot/reference/telegram/options/chains.md +++ b/website/content/bot/reference/telegram/options/chains.md @@ -6,7 +6,7 @@ description: OpenBB Telegram Command # chains -Displays Options Chain by Expiry. +This command allows users to retrieve Options Chain by Expiry, which gives an overview of the bid, ask, and open interest of options contracts for a specific stock. ### Usage diff --git a/website/content/bot/reference/telegram/options/equitypc.md b/website/content/bot/reference/telegram/options/equitypc.md index 0bd4a5e61142..1eeabbdb5863 100644 --- a/website/content/bot/reference/telegram/options/equitypc.md +++ b/website/content/bot/reference/telegram/options/equitypc.md @@ -6,7 +6,7 @@ description: OpenBB Telegram Command # equitypc -Displays the Equity Put/Call Volume Ratio - from market-harmonics.com +This command retrieves the Equity Put/Call Volume Ratio from market-harmonics.com. This ratio is used to measure the demand for puts versus calls in the equity market and can be a useful tool for traders to help gauge market sentiment. ### Usage diff --git a/website/content/bot/reference/telegram/options/gamma.md b/website/content/bot/reference/telegram/options/gamma.md index 1ae72f977bd4..165e3e07f4f2 100644 --- a/website/content/bot/reference/telegram/options/gamma.md +++ b/website/content/bot/reference/telegram/options/gamma.md @@ -6,7 +6,7 @@ description: OpenBB Telegram Command # gamma -Displays Options Gamma Levels for a Stock. +This command allows the user to view the Options Gamma Levels for a particular stock. Options Gamma Levels are important to understanding the rate of change for the option's Delta when the underlying stock price changes. Knowing this information can help traders make informed decisions about which options to purchase. ### Usage diff --git a/website/content/bot/reference/telegram/options/highiv.md b/website/content/bot/reference/telegram/options/highiv.md index 3b720ee5634c..41a59a00035c 100644 --- a/website/content/bot/reference/telegram/options/highiv.md +++ b/website/content/bot/reference/telegram/options/highiv.md @@ -6,7 +6,7 @@ description: OpenBB Telegram Command # highiv -Top 15 Highest IV30 Equity stocks. +This command retrieves the 15 highest IV30 equity stocks by 30 day Implied Volatility. The IV30 metric is a measure of the expected volatility of a stock over the next 30 days. This command is ideal for users looking to make investments with high potential return and is useful for traders looking to capitalize on market movements. ### Usage diff --git a/website/content/bot/reference/telegram/options/hist.md b/website/content/bot/reference/telegram/options/hist.md index 5822c7012599..25a74701fc7d 100644 --- a/website/content/bot/reference/telegram/options/hist.md +++ b/website/content/bot/reference/telegram/options/hist.md @@ -6,7 +6,7 @@ description: OpenBB Telegram Command # hist -Displays Options Price History in a chart. +This command allows the user to retrieve the historical price of options for the given parameters of a ticker, expiry, strike , option type, and interval for the past x days in a chart format. ### Usage diff --git a/website/content/bot/reference/telegram/options/index.mdx b/website/content/bot/reference/telegram/options/index.mdx index 1e48f510359f..2554d830cf5c 100644 --- a/website/content/bot/reference/telegram/options/index.mdx +++ b/website/content/bot/reference/telegram/options/index.mdx @@ -6,112 +6,112 @@ import ReferenceCard from "@site/src/components/General/ReferenceCard"; diff --git a/website/content/bot/reference/telegram/options/indexpc.md b/website/content/bot/reference/telegram/options/indexpc.md index 04c46cd52a5f..6c94fd2c69e8 100644 --- a/website/content/bot/reference/telegram/options/indexpc.md +++ b/website/content/bot/reference/telegram/options/indexpc.md @@ -6,7 +6,7 @@ description: OpenBB Telegram Command # indexpc -Displays the Index Put/Call Ratio for the market - from market-harmonics.com +This command allows the user to retrieve the Index Put/Call Ratio for the market from market-harmonics.com. This ratio is an indication of the market sentiment and can be used to help traders identify bearish and bullish market conditions. The command returns the ratio and can be used to inform trading decisions. ### Usage diff --git a/website/content/bot/reference/telegram/options/itm.md b/website/content/bot/reference/telegram/options/itm.md index eca552b9f95b..6b174fd622d3 100644 --- a/website/content/bot/reference/telegram/options/itm.md +++ b/website/content/bot/reference/telegram/options/itm.md @@ -6,7 +6,7 @@ description: OpenBB Telegram Command # itm -Displays In-the-Money options by expiry for a stock. +This command allows the user to retrieve a list of In-the-Money options for the stock ticker symbol sorted by expiry date. The command compares the amount of Calls and Puts In-the-Money vs Out-the-Money and gives a total. ### Usage diff --git a/website/content/bot/reference/telegram/options/iv.md b/website/content/bot/reference/telegram/options/iv.md index 7d76f2bdc7d3..416425c1f4b7 100644 --- a/website/content/bot/reference/telegram/options/iv.md +++ b/website/content/bot/reference/telegram/options/iv.md @@ -6,7 +6,7 @@ description: OpenBB Telegram Command # iv -Displays option information (volatility, IV rank etc). +This command allows the user to quickly and easily retrieve various option information (volatility, IV rank, put/call ratio, etc.) for a specific ticker symbol. ### Usage diff --git a/website/content/bot/reference/telegram/options/maxpain.md b/website/content/bot/reference/telegram/options/maxpain.md index 9232b0446fd8..84d05d8b9935 100644 --- a/website/content/bot/reference/telegram/options/maxpain.md +++ b/website/content/bot/reference/telegram/options/maxpain.md @@ -6,7 +6,7 @@ description: OpenBB Telegram Command # maxpain -Displays the Max Pain on expiration date for a given stock. +This command retrieves the Max Pain on expiration date for a given stock. Max Pain is the strike price with the most open options contracts and it is the price at which the stock would cause financial losses for the largest number of option holders at expiration. ### Usage diff --git a/website/content/bot/reference/telegram/options/oi.md b/website/content/bot/reference/telegram/options/oi.md index 6b6350df15af..4967b7e9ae24 100644 --- a/website/content/bot/reference/telegram/options/oi.md +++ b/website/content/bot/reference/telegram/options/oi.md @@ -6,7 +6,7 @@ description: OpenBB Telegram Command # oi -Displays OI and call/put ratio for given stock - can add EXP date too for bigger breakdown +This command allows the user to retrieve the Open Interest and Call/Put ratio for a given stock. Optionally, the user can also specify an expiration date to get a more granular breakdown. ### Usage diff --git a/website/content/bot/reference/telegram/options/oichart.md b/website/content/bot/reference/telegram/options/oichart.md index a8f6823e18fe..cf0eab82b372 100644 --- a/website/content/bot/reference/telegram/options/oichart.md +++ b/website/content/bot/reference/telegram/options/oichart.md @@ -6,7 +6,7 @@ description: OpenBB Telegram Command # oichart -Charts Total Open Interest by Strike Price. +This command allows users to retrieve a chart of Total Open Interest by Strike Price for the given ticker symbol. This chart provides a visual representation of the open interest on various strike prices for the given ticker symbol, where the size of each point on the graph reflects the amount of open interest. This can be used to analyze the open interest on various strike prices and make informed decisions about the underlying security. ### Usage diff --git a/website/content/bot/reference/telegram/options/opstats.md b/website/content/bot/reference/telegram/options/opstats.md index 36b479bdb81f..f552fef11f74 100644 --- a/website/content/bot/reference/telegram/options/opstats.md +++ b/website/content/bot/reference/telegram/options/opstats.md @@ -6,7 +6,7 @@ description: OpenBB Telegram Command # opstats -Displays Options Statistics for a stock. +This command allows the user to quickly and easily retrieve various option information (volatility, IV rank, put/call ratio, etc.) for a specific ticker symbol. ### Usage diff --git a/website/content/bot/reference/telegram/options/smile.md b/website/content/bot/reference/telegram/options/smile.md index 4ee2acb747cd..90547858b1ff 100644 --- a/website/content/bot/reference/telegram/options/smile.md +++ b/website/content/bot/reference/telegram/options/smile.md @@ -6,7 +6,7 @@ description: OpenBB Telegram Command # smile -Displays Options Volatility Smile. +This command allows the user to retrieve the Options Volatility Smile for the given ticker and expiry. The Options Volatility Smile is a graphical representation of the implied volatility for a given option that can be used to gauge the market sentiment for a particular security. ### Usage diff --git a/website/content/bot/reference/telegram/options/topoi.md b/website/content/bot/reference/telegram/options/topoi.md index 2f561f2f1746..ed317a3f0d55 100644 --- a/website/content/bot/reference/telegram/options/topoi.md +++ b/website/content/bot/reference/telegram/options/topoi.md @@ -6,7 +6,7 @@ description: OpenBB Telegram Command # topoi -Displays Top Open Interest +This command allows the user to retrieve Top Open Interest among all stocks. This command queries the current market data and provides a list of the most actively traded stocks and options in the current market. ### Usage diff --git a/website/content/bot/reference/telegram/options/topoichange.md b/website/content/bot/reference/telegram/options/topoichange.md index 5671c11f7a0b..ee075b317608 100644 --- a/website/content/bot/reference/telegram/options/topoichange.md +++ b/website/content/bot/reference/telegram/options/topoichange.md @@ -6,7 +6,7 @@ description: OpenBB Telegram Command # topoichange -Displays Top 15 stocks with highest OI Change. +This command allows the user to view the top 15 stocks with the highest OI Change. It will display the stock name, the OI Change by put and call, and previous levels. This gives users a helpful overview of the stocks that have seen the most significant change in open interest. ### Usage diff --git a/website/content/bot/reference/telegram/options/topstrikevol.md b/website/content/bot/reference/telegram/options/topstrikevol.md index d7cef9a9957f..9456f0905c57 100644 --- a/website/content/bot/reference/telegram/options/topstrikevol.md +++ b/website/content/bot/reference/telegram/options/topstrikevol.md @@ -6,7 +6,7 @@ description: OpenBB Telegram Command # topstrikevol -Displays Options Strike Volume can add EXP date for bigger breakdown +This command allows the user to retrieve the top option strike by volume for a given security with the ability to add an expiration date for a more detailed breakdown. ### Usage diff --git a/website/content/bot/reference/telegram/options/topvol.md b/website/content/bot/reference/telegram/options/topvol.md index f8544d661295..34a8b918094b 100644 --- a/website/content/bot/reference/telegram/options/topvol.md +++ b/website/content/bot/reference/telegram/options/topvol.md @@ -6,7 +6,7 @@ description: OpenBB Telegram Command # topvol -Top 15 Highest options volume. +This command allows the user to retrieve the Top 15 Highest stock options volumes by adding the call and put volume together. This data can be used to identify the most liquid options for trading. ### Usage diff --git a/website/content/bot/reference/telegram/options/topvoletf.md b/website/content/bot/reference/telegram/options/topvoletf.md index 27a7aa263da6..fbaef65cbac9 100644 --- a/website/content/bot/reference/telegram/options/topvoletf.md +++ b/website/content/bot/reference/telegram/options/topvoletf.md @@ -6,7 +6,7 @@ description: OpenBB Telegram Command # topvoletf -Top 15 Highest options volume ETFs. +This command allows the user to retrieve the Top 15 Highest ETF options volumes by adding the call and put volume together. This data can be used to identify the most liquid options for trading. ### Usage diff --git a/website/content/bot/reference/telegram/options/unu.md b/website/content/bot/reference/telegram/options/unu.md index e469a88291d4..a42750e5a313 100644 --- a/website/content/bot/reference/telegram/options/unu.md +++ b/website/content/bot/reference/telegram/options/unu.md @@ -6,7 +6,7 @@ description: OpenBB Telegram Command # unu -Shows Unusual Options +This command allows a user to retrieve unusual options sorted by strike and expiration. It provides a list of the most unusual options in the market and can be used to identify potential trading opportunities. The results are sorted by the highest Volume to Open Interest ratio giving the user the ability to quickly identify potential trading opportunities. ### Usage diff --git a/website/content/bot/reference/telegram/options/uoastock.md b/website/content/bot/reference/telegram/options/uoastock.md index 6e5682f2484a..0140174b9a64 100644 --- a/website/content/bot/reference/telegram/options/uoastock.md +++ b/website/content/bot/reference/telegram/options/uoastock.md @@ -6,7 +6,7 @@ description: OpenBB Telegram Command # uoastock -Display Top 20day Average Options Volume by ticker. +This command allows the user to retrieve the 20-day average options volume by ticker. The volume is based on the total volume of all options traded in the given period of time, including calls and puts. ### Usage diff --git a/website/content/bot/reference/telegram/options/vol.md b/website/content/bot/reference/telegram/options/vol.md index 471739c0deed..b7c364b9d70a 100644 --- a/website/content/bot/reference/telegram/options/vol.md +++ b/website/content/bot/reference/telegram/options/vol.md @@ -6,7 +6,7 @@ description: OpenBB Telegram Command # vol -Displays Options Strike Volume can add EXP date for bigger breakdown +This command allows the user to retrieve a chart of Options Volume by Strike for a specified ticker. This data can be broken down further by adding an expiration date for a more detailed breakdown. ### Usage diff --git a/website/content/bot/reference/telegram/options/vsurf.md b/website/content/bot/reference/telegram/options/vsurf.md index c6c973c2d281..c71b715eee45 100644 --- a/website/content/bot/reference/telegram/options/vsurf.md +++ b/website/content/bot/reference/telegram/options/vsurf.md @@ -6,7 +6,7 @@ description: OpenBB Telegram Command # vsurf -Display Options Volatility Surface. +This command allows the user to retrieve an options volatility surface for the ticker symbol. Specifically, it will provide a surface based on implied volatilities calculated from options prices, indicating the relationship between the stock price and the implied volatility of options on the stock. ### Usage diff --git a/website/content/bot/reference/telegram/overview/heatchart.md b/website/content/bot/reference/telegram/overview/heatchart.md index 49912c99bef6..a971e326e09f 100644 --- a/website/content/bot/reference/telegram/overview/heatchart.md +++ b/website/content/bot/reference/telegram/overview/heatchart.md @@ -6,7 +6,7 @@ description: OpenBB Telegram Command # heatchart -Daily Market Heat Chart - 15m Delayed +This command allows the user to retrieve a Daily Market Heat Chart (15 minute delayed). The heat chart shows a graphical representation of the performance of the market by sector for that day, with different colors indicating different levels of performance. ### Usage @@ -21,7 +21,6 @@ Daily Market Heat Chart - 15m Delayed This command has no parameters - --- ## Examples diff --git a/website/content/bot/reference/telegram/overview/heatmap.md b/website/content/bot/reference/telegram/overview/heatmap.md index 484f55360342..23c6bca5d9e9 100644 --- a/website/content/bot/reference/telegram/overview/heatmap.md +++ b/website/content/bot/reference/telegram/overview/heatmap.md @@ -6,7 +6,7 @@ description: OpenBB Telegram Command # heatmap -Daily Heat Maps by Market. Sector is optional. +This command allows the user to retrieve Daily Heat Maps by Market and Sector. The Daily Heat Maps will allow the user a quick overview of current stock market performance. ### Usage diff --git a/website/content/bot/reference/telegram/overview/index.mdx b/website/content/bot/reference/telegram/overview/index.mdx index 3d8de6cad765..a8f2de3c2b6b 100644 --- a/website/content/bot/reference/telegram/overview/index.mdx +++ b/website/content/bot/reference/telegram/overview/index.mdx @@ -6,22 +6,22 @@ import ReferenceCard from "@site/src/components/General/ReferenceCard"; diff --git a/website/content/bot/reference/telegram/overview/markets.md b/website/content/bot/reference/telegram/overview/markets.md index 2f2c8bce2244..a721617eba93 100644 --- a/website/content/bot/reference/telegram/overview/markets.md +++ b/website/content/bot/reference/telegram/overview/markets.md @@ -6,7 +6,7 @@ description: OpenBB Telegram Command # markets -Displays markets overview. +This command allows the user to retrieve a markets overview which provides a quick summary of current market conditions. The overview includes prices of the largest ETFs, with the amount of stocks current above and below the SMA 200/50 and Advancers / Decliners. ### Usage @@ -21,7 +21,6 @@ Displays markets overview. This command has no parameters - --- ## Examples diff --git a/website/content/bot/reference/telegram/overview/watchlist.md b/website/content/bot/reference/telegram/overview/watchlist.md index 869d44c21f1c..04ca555386c7 100644 --- a/website/content/bot/reference/telegram/overview/watchlist.md +++ b/website/content/bot/reference/telegram/overview/watchlist.md @@ -6,7 +6,7 @@ description: OpenBB Telegram Command # watchlist -Displays markets overview +This command allows the user to retrieve an overview of their watchlist, which includes the current price, high/low, volume, and change. You can also get other related information with a quick click like flow, darkpool data, technical analysis, and news - all from one spot. ### Usage diff --git a/website/content/bot/reference/telegram/overview/watchlist_add.md b/website/content/bot/reference/telegram/overview/watchlist_add.md index 105e5abb24f4..9c36ab74920b 100644 --- a/website/content/bot/reference/telegram/overview/watchlist_add.md +++ b/website/content/bot/reference/telegram/overview/watchlist_add.md @@ -6,7 +6,7 @@ description: OpenBB Telegram Command # watchlist_add -Adds a ticker to your watchlist. +This command allows the user to add a stock or stocks to their watchlist. ### Usage diff --git a/website/content/bot/reference/telegram/overview/watchlist_remove.md b/website/content/bot/reference/telegram/overview/watchlist_remove.md index 9ae0d3ca8126..8a27f26c51aa 100644 --- a/website/content/bot/reference/telegram/overview/watchlist_remove.md +++ b/website/content/bot/reference/telegram/overview/watchlist_remove.md @@ -6,7 +6,7 @@ description: OpenBB Telegram Command # watchlist_remove -Removes a ticker from your watchlist. +This command allows the user to remove a stock from their watchlist. ### Usage diff --git a/website/content/bot/reference/telegram/screeners/index.mdx b/website/content/bot/reference/telegram/screeners/index.mdx index e65d0d197eb0..dbb8e33af05e 100644 --- a/website/content/bot/reference/telegram/screeners/index.mdx +++ b/website/content/bot/reference/telegram/screeners/index.mdx @@ -11,7 +11,7 @@ import ReferenceCard from "@site/src/components/General/ReferenceCard"; /> diff --git a/website/content/bot/reference/telegram/screeners/scr/ah.md b/website/content/bot/reference/telegram/screeners/scr/ah.md index 1f6e9a72de9f..0d82ea7d65bb 100644 --- a/website/content/bot/reference/telegram/screeners/scr/ah.md +++ b/website/content/bot/reference/telegram/screeners/scr/ah.md @@ -6,7 +6,7 @@ description: OpenBB Telegram Command # ah -Displays all available screeners. /scr all, /scr pm, /scr ah +This command allows the user to retrieve After-Hours stock movers according to a chosen screener. ### Usage diff --git a/website/content/bot/reference/telegram/screeners/scr/all.md b/website/content/bot/reference/telegram/screeners/scr/all.md index d18a9191ceaa..d942210d5819 100644 --- a/website/content/bot/reference/telegram/screeners/scr/all.md +++ b/website/content/bot/reference/telegram/screeners/scr/all.md @@ -6,7 +6,7 @@ description: OpenBB Telegram Command # all -Displays all available screeners. /scr all, /scr pm, /scr ah +This command allows the user to view all available screeners during market hours. The results can then be used to further analyze the data and make better-informed decisions. ### Usage diff --git a/website/content/bot/reference/telegram/screeners/scr/index.mdx b/website/content/bot/reference/telegram/screeners/scr/index.mdx index 21f5820222bd..e61e320cdb85 100644 --- a/website/content/bot/reference/telegram/screeners/scr/index.mdx +++ b/website/content/bot/reference/telegram/screeners/scr/index.mdx @@ -6,17 +6,17 @@ import ReferenceCard from "@site/src/components/General/ReferenceCard"; diff --git a/website/content/bot/reference/telegram/screeners/scr/pm.md b/website/content/bot/reference/telegram/screeners/scr/pm.md index f585a748b237..831dc604b5a6 100644 --- a/website/content/bot/reference/telegram/screeners/scr/pm.md +++ b/website/content/bot/reference/telegram/screeners/scr/pm.md @@ -6,7 +6,7 @@ description: OpenBB Telegram Command # pm -Displays all available screeners. /scr all, /scr pm, /scr ah +This command offers the user the ability to view the top pre-market gainers, losers, and most active, giving the user a better understanding of the market’s movements before the market officially opens. ### Usage diff --git a/website/content/bot/reference/telegram/screeners/screener.md b/website/content/bot/reference/telegram/screeners/screener.md index fd9b7140692e..6c14ffc91b61 100644 --- a/website/content/bot/reference/telegram/screeners/screener.md +++ b/website/content/bot/reference/telegram/screeners/screener.md @@ -6,7 +6,7 @@ description: OpenBB Telegram Command # screener -Displays stock screener results according to chosen signal. +This command allows the user to retrieve stock screener results according to the chosen technical signal. ### Usage diff --git a/website/content/bot/reference/telegram/short_data/borrowed.md b/website/content/bot/reference/telegram/short_data/borrowed.md index b95663908646..143b52f8a1a8 100644 --- a/website/content/bot/reference/telegram/short_data/borrowed.md +++ b/website/content/bot/reference/telegram/short_data/borrowed.md @@ -6,7 +6,7 @@ description: OpenBB Telegram Command # borrowed -Displays history of borrowed shares available and fee. +This command allows the user to view the history of borrowed shares available and fees associated with the stock with the ticker symbol. This can be a useful tool for traders and investors to track changes in share borrowing over time and to compare fees charged by different brokers. ### Usage diff --git a/website/content/bot/reference/telegram/short_data/hsi.md b/website/content/bot/reference/telegram/short_data/hsi.md index 6a8ce86ce2f5..609fea969b27 100644 --- a/website/content/bot/reference/telegram/short_data/hsi.md +++ b/website/content/bot/reference/telegram/short_data/hsi.md @@ -6,7 +6,7 @@ description: OpenBB Telegram Command # hsi -Show top high short interest stocks of over 20% ratio. +This command retrieves the top high short interest stocks over a 20% ratio. This information can let an investor identify possible short squeeze potential. ### Usage diff --git a/website/content/bot/reference/telegram/short_data/index.mdx b/website/content/bot/reference/telegram/short_data/index.mdx index a18b762c1dcd..c246d06b2705 100644 --- a/website/content/bot/reference/telegram/short_data/index.mdx +++ b/website/content/bot/reference/telegram/short_data/index.mdx @@ -6,27 +6,27 @@ import ReferenceCard from "@site/src/components/General/ReferenceCard"; diff --git a/website/content/bot/reference/telegram/short_data/shortrate.md b/website/content/bot/reference/telegram/short_data/shortrate.md index 321b236a3f1d..0eedb7b91e51 100644 --- a/website/content/bot/reference/telegram/short_data/shortrate.md +++ b/website/content/bot/reference/telegram/short_data/shortrate.md @@ -6,7 +6,7 @@ description: OpenBB Telegram Command # shortrate -Display Short shares spot borrow rate sourced from Interactive Brokers +This command allows the user to retrieve the Display Short Shares spot borrow rate from Interactive Brokers for the given ticker. The spot borrow rate is the rate at which a user may borrow shares from the broker in order to short sell the security. This command allows the user to check the current rate and make more informed decisions about their short selling activities. ### Usage diff --git a/website/content/bot/reference/telegram/short_data/shortvol.md b/website/content/bot/reference/telegram/short_data/shortvol.md index 0bbb0167ac13..2d6db979e2f1 100644 --- a/website/content/bot/reference/telegram/short_data/shortvol.md +++ b/website/content/bot/reference/telegram/short_data/shortvol.md @@ -6,7 +6,7 @@ description: OpenBB Telegram Command # shortvol -Graph of 30 day history of short volume vs vol. +This command allows the user to retrieve a graph of the 30 day history of the short volume versus the total volume of the stock ticker. The graph also displays the ratio of the total amount of shares that have been sold short versus the total amount of shares traded over the past 30 days. This data can be used to get a better understanding of the stock's trading activity and potential future price movements. ### Usage diff --git a/website/content/bot/reference/telegram/short_data/topshortvol.md b/website/content/bot/reference/telegram/short_data/topshortvol.md index 30ed66b93f3d..f2f0c13a9152 100644 --- a/website/content/bot/reference/telegram/short_data/topshortvol.md +++ b/website/content/bot/reference/telegram/short_data/topshortvol.md @@ -6,7 +6,7 @@ description: OpenBB Telegram Command # topshortvol -Top 15 Short Interest Stocks per Finra +This command allows the user to retrieve the Top 15 Short Interest Stocks per Finra. It's typically measured as a ratio of the stock's total short vol divided by the total volume for the trading day. This information is essential for traders to make informed decisions in the market. ### Usage