diff --git a/website/content/bot/faqs/individual.md b/website/content/bot/faqs/individual.md deleted file mode 100644 index 032bce6263e0..000000000000 --- a/website/content/bot/faqs/individual.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -title: Individual -sidebar_position: 2 -description: TBD -keywords: - [ - installation, - installer, - install, - guide, - mac, - windows, - linux, - python, - github, - macos, - how to, - explanation, - openbb terminal, - ] ---- - -## Individual diff --git a/website/content/bot/faqs/server.md b/website/content/bot/faqs/server.md deleted file mode 100644 index 587fe5a4cc91..000000000000 --- a/website/content/bot/faqs/server.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -title: Server -sidebar_position: 3 -description: TBD -keywords: - [ - installation, - installer, - install, - guide, - mac, - windows, - linux, - python, - github, - macos, - how to, - explanation, - openbb terminal, - ] ---- - -## Server diff --git a/website/content/bot/guides.md b/website/content/bot/guides.md deleted file mode 100644 index 03257a54f4b3..000000000000 --- a/website/content/bot/guides.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -title: Guides -sidebar_position: 2 -description: TBD -keywords: [installation, installer, install, guide, mac, windows, linux, python, github, macos, how to, explanation, openbb, sdk, api, pip, pypi,] ---- - -## Guides - -TBD diff --git a/website/content/bot/guides/_category_.json b/website/content/bot/guides/_category_.json new file mode 100644 index 000000000000..4ffdf06c7ceb --- /dev/null +++ b/website/content/bot/guides/_category_.json @@ -0,0 +1,4 @@ +{ + "label": "Guides", + "position": 3 +} diff --git a/website/content/bot/guides/customizing/index.md b/website/content/bot/guides/customizing/index.md new file mode 100644 index 000000000000..fd8d3f6b437f --- /dev/null +++ b/website/content/bot/guides/customizing/index.md @@ -0,0 +1,15 @@ +--- +title: Customizing +sidebar_position: 3 +description: TBD +keywords: [discord, telegram, how to, explanation, openbb bot, openbb, guide, bot guide] +--- + +## Customizing your Bot Experience + +OpenBB offers many different customization options for your bot experience. We have two different accounts you can have and it all start by registering at the [OpenBB HUB](https://my.openbb.co) + +Once you are registered the next step is linking your account. You can find this under "Linked Platforms" on the Hub Page - an explanation of how to link is provided there. +linking platform openBB + +Now that your account is linked - lets dive into what you can do. diff --git a/website/content/bot/guides/customizing/individual.md b/website/content/bot/guides/customizing/individual.md new file mode 100644 index 000000000000..92c63a23d422 --- /dev/null +++ b/website/content/bot/guides/customizing/individual.md @@ -0,0 +1,33 @@ +--- +title: Individual +sidebar_position: 3 +description: TBD +keywords: [discord, telegram, individual, customizing, customization, how to, explanation, openbb bot, openbb, guide, bot guide] +--- +## Customizing your Individual Bot Experience + +The individual plan offers three different capabilities - Charting, Alerts, and Watchlist. In addition to these benefits you also get unlimited commands per month after registering. + +### Charting + +Our most popular commands center around the real-time charting capabilities we offer with OpenBB Bot. We allow you to customize many different aspects of your charts when you register with us. You can customize the chart theme and style as well as adding any on and off chart indicators you desire. These settings will apply across all platforms. + +charting openBB + +### Alerts + +Alerts are a powerful tool used by OpenBB users. Simply set the symbol and price you wish to be alerted at and we do the rest! + +alerts openBB + +### Watchlist + +OpenBB Watchlist is a great way to keep track of all your investments in once place. Add Crypto or Stock symbols and quickly see the prices at a glance when its convenient for you. +You can add your tickers through the HUB or run ```/watchlist``` in your respective platform to configure. + +watchlist openBB + +watchlist add openBB + +## Server (Discord Only) + diff --git a/website/content/bot/guides/customizing/server.md b/website/content/bot/guides/customizing/server.md new file mode 100644 index 000000000000..9f9ea5cf1e1e --- /dev/null +++ b/website/content/bot/guides/customizing/server.md @@ -0,0 +1,42 @@ +--- +title: Server +sidebar_position: 3 +description: TBD +keywords: [discord, telegram, server, customizing, customization, how to, explanation, openbb bot, openbb, guide, bot guide] +--- + +## Customizing your Server Bot Experience + +The Server plan for OpenBB Bot offers three different capabilities - Charting, BillBoard, and Auto Posting. Any server that registers with us on the [OpenBB HUB](https://my.openbb.co) gets access to set up one Auto Posting for free. Once you have paid plan you have full access to all these features. + +## Server + +### Auto Posting (Discord Only) + +Auto Posting is our most powerful feature for Discord Servers - We offer the ability to push updates into the server for Flow, Darkpool, or Heatmap/Charts. (more to come soon!) Once you set up your account you will be able to query the bot directly in your server like below : + +autoposting openBB + +Or you can manage them at the HUB : +autoposting openBB + +We currently offer the following Auto Posting Categories: + +| Category | Description | Choices | +| ---- | ----------- | ------- | +| Flow | Options Flow for all stocks | Opening, Golden Sweep, Large, Unusual, Weekly, Above Ask/Below Bid | +| Darkpool | Darkpool Data for the market | Large | +| Heatmap | Overview of the market | S&P 500, Dow Jones 30, NASDAQ 100, Russell 1000, Russell 2000, Crypto, Heatchart | + + +### Charting + +Custom charting works the same way as Individual charting but it will apply to your full server. If you want everyone in your server to use the "Classic" theme and have RSI + 50d SMA then it will display that way for all users in your server (unless they have already registered their own individual account). + +server charting openBB + +### BillBoard + +BillBoard is a way to advertise to your users when they run a command on the bot. Within your server you can set your own text to display on applicable commands as they are run. + +billboard openBB diff --git a/website/content/bot/guides/discord.md b/website/content/bot/guides/discord.md new file mode 100644 index 000000000000..dd56f571ba8d --- /dev/null +++ b/website/content/bot/guides/discord.md @@ -0,0 +1,24 @@ +--- +title: Discord +sidebar_position: 1 +description: TBD +keywords: [discord, how to, explanation, openbb bot, openbb, guide, bot guide] +--- + +## Getting Started with Discord + +Now that you have added the bot to your discord you can get started with running commands. + +If you're new to OpenBB Discord Bot, here's a quick guide to get you started. + +To use OpenBB, you need to use slash commands, which are special commands that start with a / symbol. To autoselect commands if you are on Desktop you can hit ```TAB``` + +You can type / in the chat to see a list of available slash commands for OpenBB Bot. One of the most useful slash commands is /help, which shows you all the commands and how to use them. Some of the most popular commands are: + +- ```/cd ticker: AMD``` Shows the daily chart for a given stock ticker. +- ```/c3m ticker: AMD``` Shows the 3-month chart for a given stock ticker. +- ```/flow ticker: AMD``` Shows the recent options flow for the given stock ticker. + +That's it! You're ready to explore the market with OpenBB Discord Bot! + +Check out the Reference section for more commands or type ```/help``` in your chat to see what else we can do! diff --git a/website/content/bot/guides/telegram.md b/website/content/bot/guides/telegram.md new file mode 100644 index 000000000000..d38de69cdd80 --- /dev/null +++ b/website/content/bot/guides/telegram.md @@ -0,0 +1,30 @@ +--- +title: Telegram +sidebar_position: 2 +description: TBD +keywords: [telegram, how to, explanation, openbb bot, openbb, guide, bot guide] +--- + +## Getting Started with Telegram + +Now that you have added the bot to your Telegram server you can get started with running commands. + +To use it, you need to type slash commands in the chat. A slash command starts with a / followed by a keyword and an optional argument. For example, ```/cd AAPL``` will show you the daily chart for Apple stock. + +
How do I select commands instead of typing? +If you are On mobile press and hold to select the command. + +On desktop press ```tab``` to select the command. +
+ + +To see all the available commands, you can type ```/help``` in the chat. This will show you a list of commands and their descriptions. You can also tap on any command to use it directly. Some of the most popular commands are: + +- ```/cd AMD``` Shows the daily chart for a given stock ticker. +- ```/c3m AMD``` Shows the 3-month chart for a given stock ticker. +- ```/flow AMD``` Shows the recent options flow for the given stock ticker. +- ```/c DOGE``` Shows a chart for the crypto symbol provided. + +That's it! You're ready to use OpenBB Telegram Bot and explore the markets. Have fun! + +Check out the Reference section for more commands or type ```/help``` in your chat to see what else we can do! diff --git a/website/content/bot/installation.md b/website/content/bot/installation.md index 7676bdfa0e28..30aff61ea0db 100644 --- a/website/content/bot/installation.md +++ b/website/content/bot/installation.md @@ -16,7 +16,7 @@ To add the bot to your server click on one of the links for your respective plat --- -# Discord - First Time Setup +## Discord - First Time Setup A pop-up window will open, asking you to log in to your Discord account and allow the bot access. @@ -34,7 +34,7 @@ Congratulations! You’ve successfully added a bot to your Discord server. --- -# Telegram - First Time Setup +## Telegram - First Time Setup After clicking on the Add to Telegram button it should open a chat with our OpenBB Bot. diff --git a/website/content/bot/reference/discord/alerts.mdx b/website/content/bot/reference/discord/alerts.mdx deleted file mode 100644 index a04062b32db8..000000000000 --- a/website/content/bot/reference/discord/alerts.mdx +++ /dev/null @@ -1,100 +0,0 @@ ---- -title: Alerts -description: create, list, update, delete -premium: false -commands: - - "/alerts create" - - "/alerts list" - - "/alerts update" - - "/alerts delete" ---- - -# Alerts - -## create - -> Create an alert with conditions for a symbol - -```format -/alerts create -``` - -**ticker** - -- The symbol/ticker/coin of the stock/coin you want to set the alert for - -**condition** - -- Condition to set alert for - (Equal or Above or Equal or Below) - -**price** - -- Price to set the alert for - -**Examples** - -``` -/alerts create ticker:BTCUSD condition:Equal or Above price:1000 -``` - -``` -/alerts create ticker:SPY condition:Equal or Below price:400 -``` - ---- - -## list - -> List all of your active alerts - -```format -/alerts list -``` - ---- - -## update - -> Update a condition on an active alert - -```format -/alerts update -``` - -**alerts** - -- The alert you want to update - -**condition** - -- Change condition here if needed - -**price** - -- To update the price send a new price - -**Examples** - -``` -/alerts update alerts: condition: price: -``` - ---- - -## delete - -> Delete an active alert you have set - -```format -/alerts delete -``` - -**alert** - -- The alert you want to remove/delete - -**Examples** - -``` -/alerts delete alert: -``` diff --git a/website/content/bot/reference/discord/alerts/index.md b/website/content/bot/reference/discord/alerts/index.md new file mode 100644 index 000000000000..cf66f5d4c662 --- /dev/null +++ b/website/content/bot/reference/discord/alerts/index.md @@ -0,0 +1,6 @@ +# Alerts + +- [create](/bot/reference/discord/alerts/create) +- [delete](/bot/reference/discord/alerts/delete) +- [list](/bot/reference/discord/alerts/list) +- [update](/bot/reference/discord/alerts/update) diff --git a/website/content/bot/reference/discord/autopost/index.md b/website/content/bot/reference/discord/autopost/index.md new file mode 100644 index 000000000000..c71ddbe37761 --- /dev/null +++ b/website/content/bot/reference/discord/autopost/index.md @@ -0,0 +1,5 @@ +# Autopost + +- [add](/bot/reference/discord/autopost/add) +- [list](/bot/reference/discord/autopost/list) +- [remove](/bot/reference/discord/autopost/remove) diff --git a/website/content/bot/reference/discord/charts.mdx b/website/content/bot/reference/discord/charts.mdx deleted file mode 100644 index 25a12dd63adf..000000000000 --- a/website/content/bot/reference/discord/charts.mdx +++ /dev/null @@ -1,214 +0,0 @@ ---- -title: Charting -description: c3m, c5m, c15m, cd, cw... -premium: false -commands: - - "/chart" - - "/c3m" - - "/c5m" - - "/c15m" - - "/cd" - - "/cw" - - "/cm" - - "/chartfib" - - "/chartsr" ---- - -# Charting - -## chart - -> Shows the candlestick chart for the ticker/interval provided - -```format -/chart [] -``` - -**ticker** - -- The symbol/ticker/coin of the stock you want the chart of - -**interval** - -- The interval you want to chart - Current valid options are : Daily, Weekly, Monthly, 1-5-10-15-30 Minute, 1 hour, or 4 hour. - -**[past_days]** - _optional_ - -- Amount of days to show for the Interval - -**Examples** - -``` -/chart ticker:AMD interval:5 minute past_days:0 -``` - -``` -/chart ticker:AMD interval:Daily -``` - ---- - -## c3m - -> Shows an intraday 3m candlestick chart for the ticker provided - -```format -/c3m -``` - -**ticker** - -- The symbol/ticker/coin of the stock you want the chart of - -**Examples** - -``` -/c3m ticker:AMD -``` - ---- - -## c5m - -> Shows an intraday 5m candlestick chart for the ticker/coin provided - -```format -/c5m -``` - -**ticker** - -- The symbol/ticker/coin of the ticker/coin you want the chart of - -**Examples** - -``` -/c5m ticker:AMD -``` - ---- - -## c15m - -> Shows an intraday 15m candlestick chart for the ticker provided - -```format -/c15m -``` - -**ticker** - -- The symbol/ticker/coin of the stock you want the chart of - -**Examples** - -``` -/c15m ticker:AMD -``` - ---- - -## cd - -> Shows a daily candlestick chart for the ticker/coin provided - -```format -/cd -``` - -**ticker** - -- The symbol/ticker/coin of the stock you want the chart of - -**Examples** - -``` -/cd ticker:AMD -``` - ---- - -## cw - -> Shows a weekly candlestick chart for the ticker/coin provided - -```format -/cw -``` - -**ticker** - -- The symbol/ticker/coin of the stock you want the chart of - -**Examples** - -``` -/cw ticker:AMD -``` - ---- - -## cm - -> Shows a monthly candlestick chart for the ticker/coin provided - -```format -/cm -``` - -**ticker** - -- The symbol/ticker/coin of the stock you want the chart of - -**Examples** - -``` -/cm ticker:AMD -``` - ---- - -## chartfib - -> Plots the Fibonacci levels for the ticker provided - -```format -/chartfib -``` - -**ticker** - -- The symbol/ticker/coin of the stock you want the chartfib of - -**Examples** - -``` -/chartfib ticker:AMD -``` - ---- - -## chartsr - -> Displays Support and Resistance Levels for the ticker provided - -```format -/chartsr **[interval]** -``` - -**ticker** - -- The symbol/ticker/coin of the stock you want the chartfib of - -**[interval]** - _optional_ - -- interval in minutes for the chart. Defaults to Daily with no selection - -**Examples** - -``` -/chartsr ticker:AMC -``` -``` -/chartsr ticker:AMC interval:5 minute -``` diff --git a/website/content/bot/reference/discord/charts/index.md b/website/content/bot/reference/discord/charts/index.md new file mode 100644 index 000000000000..095d60980084 --- /dev/null +++ b/website/content/bot/reference/discord/charts/index.md @@ -0,0 +1,12 @@ +# Charts + +- [c15m](/bot/reference/discord/charts/c15m) +- [c3m](/bot/reference/discord/charts/c3m) +- [c5m](/bot/reference/discord/charts/c5m) +- [cc](/bot/reference/discord/charts/cc) +- [cd](/bot/reference/discord/charts/cd) +- [chart](/bot/reference/discord/charts/chart) +- [chartfib](/bot/reference/discord/charts/chartfib) +- [chartsr](/bot/reference/discord/charts/chartsr) +- [cm](/bot/reference/discord/charts/cm) +- [cw](/bot/reference/discord/charts/cw) diff --git a/website/content/bot/reference/discord/crypto.mdx b/website/content/bot/reference/discord/crypto.mdx deleted file mode 100644 index 706ba8a41ac4..000000000000 --- a/website/content/bot/reference/discord/crypto.mdx +++ /dev/null @@ -1,2712 +0,0 @@ ---- -title: Crypto -description: prints, bigprints, bio, defi, fees, ir... -premium: false -commands: - - "/crypto prints" - - "/crypto bigprints" - - "/crypto tvl" - - "/crypto defi chart" - - "/crypto defi table" - - "/crypto bio" - - "/crypto fees" - - "/crypto compfees" - - "/crypto ir" ---- - -import AvailableOptions from "@site/src/components/General/AvailableOptions"; - -# Crypto - -## prints - -> Last 15 Crypto Prints over last 24hrs. - -```format -/crypto prints -``` - -**coin** - -- The coin you want the prints of - -**Examples** - -``` -/crypto prints coin:BTC-USD -``` - ---- - -## bigprints - -> Last 15 Large Crypto Prints. - -```format -/crypto bigprints -``` - -**coin** - -- The coin you want the large prints of - -**Examples** - -``` -/crypto bigprints coin:BTC-USD -``` - ---- - -## tvl - -> Get protocols historical TVL [Source: defillama.com] - -```format -/crypto tvl -``` - -**protocols** - -- comma separated list of protocols (e.g., curve,makerdaodwadwa) - - -**Examples** - -``` -/crypto tvl -``` - -``` -/crypto tvl protocols: curve -``` - ---- - -## defi table - -> Get top DeFi protocols - -```format -/crypto defi table [sortby] [chain] [reverse] -``` - -**[sortby]** - _optional_ - -- Column to sort data by (default="TVL") (e.g., Total Value Locked) - -**[chain]** - _optional_ - -- Chain to filter by (default="all") (e.g., ethereum) - - -**[reverse]** - _optional_ - -- Reverse the sort order (default: No) - Yes/No - -**Examples** - -``` -/crypto defi table -``` - -``` -/crypto defi table sortby: Change 1hr chain: Bitcoin -``` - ---- - -## defi chart - -> Chart of top 20 defi protocols by TVL - -```format -/crypto defi chart -``` - -**Examples** - -``` -/crypto defi chart -``` - ---- - -## top - -> Get top cryptos and info - -```format -/crypto top [sortby] [category] [reverse] -``` - -**[sortby]** - _optional_ - -- Column to sort data by (default="MCap") (e.g., Market Cap) - -**[category]** - _optional_ - -- Category to filter by (default="all") (e.g., stablecoins) - - -**[reverse]** - _optional_ - -- Reverse the sort order (default: No) - Yes/No - -**Examples** - -``` -/crypto top -``` - -``` -/crypto top sortby: Market Cap category: manufacturing -``` - ---- - -## bio - -> Get fundamental information about a crypto. - -```format -/crypto bio -``` - -**symbol** - -- Crypto symbol to check information (e.g., BTC) - - -**Examples** - -``` -/crypto bio symbol: btc -``` - ---- - -## fees - -> Fees on a certain date of top crypto protocols - -```format -/crypto fees -``` - -**date** - -- Date to get fees for (e.g., 2022-01-01) - -**Examples** - -``` -/crypto fees date: 2022-09-19 -``` - ---- - -## compfees - -> Get protocol fees over time. - -```format -/crypto compfees -``` - -**project** - -- Comma separated list of protocols (e.g., btc,eth) - - -**Examples** - -``` -/crypto compfees projects: doge -``` - -``` -/crypto compfees projects: btc,eth -``` - ---- - -## ir - -> Returns a table of issuance rate of top crypto protocols. - -```format -/crypto ir -``` - -**Examples** - -``` -/crypto ir -``` diff --git a/website/content/bot/reference/discord/crypto/defi/index.md b/website/content/bot/reference/discord/crypto/defi/index.md new file mode 100644 index 000000000000..69dbd32619db --- /dev/null +++ b/website/content/bot/reference/discord/crypto/defi/index.md @@ -0,0 +1,4 @@ +# defi + +- [chart](/bot/reference/discord/crypto/defi/chart) +- [table](/bot/reference/discord/crypto/defi/table) diff --git a/website/content/bot/reference/discord/crypto/index.md b/website/content/bot/reference/discord/crypto/index.md new file mode 100644 index 000000000000..d6b520cb663d --- /dev/null +++ b/website/content/bot/reference/discord/crypto/index.md @@ -0,0 +1,14 @@ +# Crypto + +- [bigprints](/bot/reference/discord/crypto/bigprints) +- [bio](/bot/reference/discord/crypto/bio) +- [compfees](/bot/reference/discord/crypto/compfees) + +### Defi +- [chart](/bot/reference/discord/crypto/defi/chart) +- [table](/bot/reference/discord/crypto/defi/table) +- [fees](/bot/reference/discord/crypto/fees) +- [ir](/bot/reference/discord/crypto/ir) +- [prints](/bot/reference/discord/crypto/prints) +- [top](/bot/reference/discord/crypto/top) +- [tvl](/bot/reference/discord/crypto/tvl) diff --git a/website/content/bot/reference/discord/darkpool.mdx b/website/content/bot/reference/discord/darkpool.mdx deleted file mode 100644 index d9602a25edc2..000000000000 --- a/website/content/bot/reference/discord/darkpool.mdx +++ /dev/null @@ -1,158 +0,0 @@ ---- -title: Darkpool -description: topsum, sectors, summary, allprints... -premium: true -commands: - - "/dp topsum" - - "/dp sectors" - - "/dp summary" - - "/dp allprints" - - "/dp allblocks" - - "/dp bigprints" ---- - -# darkpool - -## topsum - -> Top Total Block & Dark Pool data. - -```format -/dp topsum -``` - -**Examples** - -``` -/dp topsum -``` - ---- - -## levels - -> Biggest Levels for All Prints over last X days. - -```format -/dp levels -``` - -**ticker** - -- The ticker to query for - -**days** - -- The number of days to return - -**Examples** - -``` -/dp levels ticker:TSLA days:10 -``` - ---- - -## sectors - -> Summary of all prints by % of MarketCap by Sector - -```format -/dp sectors -``` - -**days** - -- The number of days to return - -**sector** - -- The sector to select for the query - -```format -/dp sectors days:5 sector:Basic Materials -``` - ---- - -## summary - -> Summary of all prints by % of MarketCap - -```format -/dp summary -``` - -**days** - -- The number of days to return - -**sort** - -- Sort by market cap, float, total or short percentage - -**Examples** - -``` -/dp summary days:10 sort:MarketCap -``` - ---- - -## allprints - -> Last 15 Combination of Dark Pool and Blocks. - -```format -/dp allprints -``` - -**ticker** - -- The symbol/ticker of the stock you want to lookup - -**Examples** - -``` -/dp allprints ticker:AMD -``` - ---- - -## allblocks - -> Last 15 Combination of Block Trades only - -```format -/dp allblocks -``` - -**ticker** - -- The symbol/ticker of the stock you want to lookup - -**Examples** - -``` -/dp allblocks ticker:AMD -``` - ---- - -## bigprints - -> Combination of Dark Pool and Blocks - Largest over x amount of days - -```format -/dp bigprints -``` - -**days** - -- The number of days to return - -**Examples** - -``` -/dp bigprints days:6 -``` diff --git a/website/content/bot/reference/discord/darkpool/index.md b/website/content/bot/reference/discord/darkpool/index.md new file mode 100644 index 000000000000..3a293254066d --- /dev/null +++ b/website/content/bot/reference/discord/darkpool/index.md @@ -0,0 +1,10 @@ +# Darkpool + +- [allblocks](/bot/reference/discord/darkpool/allblocks) +- [alldp](/bot/reference/discord/darkpool/alldp) +- [allprints](/bot/reference/discord/darkpool/allprints) +- [bigprints](/bot/reference/discord/darkpool/bigprints) +- [levels](/bot/reference/discord/darkpool/levels) +- [sectors](/bot/reference/discord/darkpool/sectors) +- [summary](/bot/reference/discord/darkpool/summary) +- [topsum](/bot/reference/discord/darkpool/topsum) diff --git a/website/content/bot/reference/discord/discovery.mdx b/website/content/bot/reference/discord/discovery.mdx deleted file mode 100644 index 94985ef438cf..000000000000 --- a/website/content/bot/reference/discord/discovery.mdx +++ /dev/null @@ -1,116 +0,0 @@ ---- -title: Discovery -description: splits, senate, house, fgindex, ipolist... -premium: false -commands: - - "/disc splits" - - "/disc senate" - - "/disc house" - - "/disc fgindex" - - "/disc ipolist" - - "/disc contracts" - - "/disc holidays" - - "/disc wsb" - - "/disc trendingst" ---- - -# Discovery - -## splits - -> List of recent Stock splits for all tickers. - -```format -/disc splits -``` - ---- - -## senate - -> Displays recent senate trades for all tickers. - -```format -/disc senate -``` - ---- - -## house - -> Displays recent House trades for all tickers - -```format -/disc house -``` - ---- - -## fgindex - -> Displays Fear & Greed Index - Investor Sentiment - CNNMoney - -```format -/disc fgindex -``` - ---- - -## ipolist - -> Displays 10 Upcoming and Recent IPO's. - -```format -/disc ipolist -``` - ---- - -## contracts - -> Displays Top 15 Government contracts by amount for all tickers. - -```format -/disc contracts -``` - ---- - -## holidays - -> Displays Upcoming Market Holidays. - -```format -/disc holidays -``` - ---- - -## arktrades - -> Displays trades made by ARK ETF - -```format -/disc arktrades -``` - ---- - -## wsb - -> Display Top 15 Trending Stocks - WSB (WallStreetBets) - -```format -/disc wsb -``` ---- - -## trendingst - -> Display top 15 Trending Stocks - StockTwits - -```format -/disc trendingst -``` - - diff --git a/website/content/bot/reference/discord/discovery/index.md b/website/content/bot/reference/discord/discovery/index.md new file mode 100644 index 000000000000..4ce8a0660304 --- /dev/null +++ b/website/content/bot/reference/discord/discovery/index.md @@ -0,0 +1,13 @@ +# Discovery + +- [arktrades](/bot/reference/discord/discovery/arktrades) +- [contracts](/bot/reference/discord/discovery/contracts) +- [fgindex](/bot/reference/discord/discovery/fgindex) +- [halts](/bot/reference/discord/discovery/halts) +- [holidays](/bot/reference/discord/discovery/holidays) +- [house](/bot/reference/discord/discovery/house) +- [ipolist](/bot/reference/discord/discovery/ipolist) +- [senate](/bot/reference/discord/discovery/senate) +- [splits](/bot/reference/discord/discovery/splits) +- [trendingst](/bot/reference/discord/discovery/trendingst) +- [wsb](/bot/reference/discord/discovery/wsb) diff --git a/website/content/bot/reference/discord/duedilligence.mdx b/website/content/bot/reference/discord/duedilligence.mdx deleted file mode 100644 index da80cd6cc9ee..000000000000 --- a/website/content/bot/reference/discord/duedilligence.mdx +++ /dev/null @@ -1,387 +0,0 @@ ---- -title: Due Diligence -description: ph, ah, shortrate, news, earnings, bio, ermove... -premium: false -commands: - - "/dd pm" - - "/dd ah" - - "/dd splits" - - "/dd earnings" - - "/dd nexter" - - "/dd bio" - - "/dd ermove" - - "/dd analyst" - - "/dd pt" - - "/dd est" - - "/dd supplier" - - "/dd customer" - - "/dd sec" - - "/dd insiders" - - "/dd arktrades" - - "/dd instholdings" - - "/dd financials" - - "/dd divinfo" - - "/dd ytd" ---- - -# Due Diligence - -## pm - -> Displays premarket data for a given stock ticker - -```format -/dd pm -``` - -**ticker** - -- The symbol/ticker of the stock you want the premarket info for - -**Examples** - -``` -/dd pm ticker:AMD -``` - ---- - -## ah - -> Displays afterhours data for a given stock ticker - -```format -/dd ah -``` - -**ticker** - -- The symbol/ticker of the stock you want the afterhours info for - -**Examples** - -``` -/dd ah ticker:AMD -``` - ---- - -## splits - -> List of recent Stock splits for a ticker - -**Command** - -```format -/dd splits -``` - -**ticker** - -- The symbol/ticker of the stock you want the splits for - -**Examples** - -``` -/dd splits ticker:AMD -``` - ---- - -## earnings - -> Display Earnings that are expected to occur in the next business days. (Sorted by market cap) - -```format -/dd earnings -``` - -**day** - -- The Date you want to see the earnings for. Format: YYYY-MM-DD - -**Examples** - -``` -/dd earnings day:2022-07-29 -``` - ---- - -## nexter - -> Returns next Earnings Date for a stock. - -```format -/dd nexter -``` - -**ticker** - -- The symbol/ticker of the stock you want the next earnings date for - -**Examples** - -``` -/dd nexter ticker:AMD -``` - ---- - -## bio - -> Displays a Stock's dd Info and other information. - -```format -/dd bio -``` - -**ticker** - -- The symbol/ticker of the stock you want the bio of - -**Examples** - -``` -/dd bio ticker:AMD -``` - ---- - -## ermove - -> Display implied move for a stock based on option prices. - -```format -/dd ermove -``` - -**ticker** - -- The symbol/ticker of the stock you want the earnings move of - -**Examples** - -``` -/dd ermove ticker:AMD -``` - ---- - -## analyst - -> Displays analyst recommendations. - -```format -/dd analyst -``` - -**ticker** - -- The symbol/ticker of the stock you want the analyst ratings for - -**Examples** - -``` -/dd analyst ticker:AMD -``` - ---- - -## pt - -> Displays chart with price targets. - -```format -/dd pt -``` - -**ticker** - -- The symbol/ticker of the stock you want to query - -**Examples** - -``` -/dd pt ticker:AMD -``` - ---- - -## est - -> Displays earning estimates. - -```format -/dd est -``` - -**ticker** - -- The symbol/ticker of the stock you want to query - -**Examples** - -``` -/dd est ticker:MMM -``` - ---- - -## supplier - -> Retrieve list of suppliers for specified company - -```format -/dd supplier -``` - -**ticker** - -- The symbol/ticker of the stock you want to query - -**Examples** - -``` -/dd supplier ticker:AMD -``` - ---- - -## customer - -> Retrieve list of customers for specified company - -```format -/dd customer -``` - -**ticker** - -- The symbol/ticker of the stock you want to query - -**Examples** - -``` -/dd customer ticker:AMD -``` - ---- - -## sec - -> Displays recent SEC filings. - -``` -/dd sec -``` - -**ticker** - -- The symbol/ticker of the stock you want to query - -**Examples** - -``` -/dd sec ticker:AMD -``` - ---- - -## insiders - -Displays 15 latest insider transactions for given stock - -```format -/dd insiders -``` - -**ticker** - -- The symbol/ticker of the stock you want to query - -**Examples** - -``` -/dd insiders ticker:AMD -``` - ---- - -## instholdings - -> Displays top 15 Institutional Holdings for given stock - -```format -/dd instholdings -``` - -**ticker** - -- The symbol/ticker of the stock you want to query - -**Examples** - -``` -/dd instholdings ticker:AMD -``` - ---- - -## financials - -> Gives Total Assets, Cash, Debt, Liabilities, Rev for Company - -```format -/dd financials -``` - -**ticker** - -- The symbol/ticker of the stock you want to query - -**Examples** - -``` -/dd financials ticker:AMD -``` - ---- - -## divinfo - -> Display dividend information for a stock. - -```format -/dd divinfo -``` - -**ticker** - -- The symbol/ticker of the stock you want to query - -**Examples** - -``` -/dd divinfo ticker:AAPL -``` - ---- - -## ytd - -> Displays Period Performance for a stock - -```format -/dd ytd -``` - -**ticker** - -- The symbol/ticker of the stock you want to query - -**Examples** - -``` -/dd ytd ticker:AAPL -``` diff --git a/website/content/bot/reference/discord/duedilligence/index.md b/website/content/bot/reference/discord/duedilligence/index.md new file mode 100644 index 000000000000..54b80dfb5978 --- /dev/null +++ b/website/content/bot/reference/discord/duedilligence/index.md @@ -0,0 +1,20 @@ +# Duedilligence + +- [ah](/bot/reference/discord/duedilligence/ah) +- [analyst](/bot/reference/discord/duedilligence/analyst) +- [bio](/bot/reference/discord/duedilligence/bio) +- [customer](/bot/reference/discord/duedilligence/customer) +- [divinfo](/bot/reference/discord/duedilligence/divinfo) +- [earnings](/bot/reference/discord/duedilligence/earnings) +- [ermove](/bot/reference/discord/duedilligence/ermove) +- [est](/bot/reference/discord/duedilligence/est) +- [financials](/bot/reference/discord/duedilligence/financials) +- [insiders](/bot/reference/discord/duedilligence/insiders) +- [instholdings](/bot/reference/discord/duedilligence/instholdings) +- [nexter](/bot/reference/discord/duedilligence/nexter) +- [pm](/bot/reference/discord/duedilligence/pm) +- [pt](/bot/reference/discord/duedilligence/pt) +- [sec](/bot/reference/discord/duedilligence/sec) +- [splits](/bot/reference/discord/duedilligence/splits) +- [supplier](/bot/reference/discord/duedilligence/supplier) +- [ytd](/bot/reference/discord/duedilligence/ytd) diff --git a/website/content/bot/reference/discord/economy.mdx b/website/content/bot/reference/discord/economy.mdx deleted file mode 100644 index b03642373ed3..000000000000 --- a/website/content/bot/reference/discord/economy.mdx +++ /dev/null @@ -1,119 +0,0 @@ ---- -title: Economy -description: calendar, currencies, indices, commodities... -premium: false -commands: - - "/econ calendar" - - "/econ currencies" - - "/econ indices" - - "/econ commodities" - - "/econ usbonds" - - "/econ glbonds" - - "/econ revrepo" - - "/econ fedrates" - - "/econ yieldcurve" ---- - -# Economy - -## calendar - -> Displays Economic Calendar of events - -```format -/econ calendar -``` - ---- - -## currencies - -> Create an alert with conditions for a symbol - -```format -/econ currencies -``` - ---- - -## indices - -> US indices overview - -```format -/econ indices -``` - ---- - -## commodities - -> Futures and commodities overview. - -```format -/econ commodities -``` - ---- - -## usbonds - -> US bonds overview. - -```format -/econ usbonds -``` - ---- - -## glbonds - -> Global bonds overview. - -```format -/econ glbonds -``` - ---- - -## revrepo - -> Displays Reverse Repo. - -```format -/econ revrepo [] -``` - -**[days]** - _optional_ -- The number of days to display. Default : 50 - -**Examples** - -``` -/econ revrepo days:35 -``` - -``` -/econ revrepo -``` - ---- - -## fedrates - -> Upcoming Federal Rate decision dates and chances - -```format -/econ fedrates -``` - ---- - -## yieldcurve - -> Displays US Bonds yield curve - -```format -/econ yieldcurve -``` - diff --git a/website/content/bot/reference/discord/economy/index.md b/website/content/bot/reference/discord/economy/index.md new file mode 100644 index 000000000000..2346c99fc694 --- /dev/null +++ b/website/content/bot/reference/discord/economy/index.md @@ -0,0 +1,11 @@ +# Economy + +- [calendar](/bot/reference/discord/economy/calendar) +- [commodities](/bot/reference/discord/economy/commodities) +- [currencies](/bot/reference/discord/economy/currencies) +- [fedrates](/bot/reference/discord/economy/fedrates) +- [glbonds](/bot/reference/discord/economy/glbonds) +- [indices](/bot/reference/discord/economy/indices) +- [revrepo](/bot/reference/discord/economy/revrepo) +- [usbonds](/bot/reference/discord/economy/usbonds) +- [yieldcurve](/bot/reference/discord/economy/yieldcurve) diff --git a/website/content/bot/reference/discord/etfs.mdx b/website/content/bot/reference/discord/etfs.mdx deleted file mode 100644 index 19616b3c7ce2..000000000000 --- a/website/content/bot/reference/discord/etfs.mdx +++ /dev/null @@ -1,53 +0,0 @@ ---- -title: ETFs -description: tops, holdings -premium: false -commands: - - "/etf tops" - - "/etf holdings" ---- - -# ETFs - -## tops - -> Displays ETF's Top Gainers/Decliners, Most Active. - -```format -/etf tops -``` - -**sort** -- Sort by Top Gainers, Top Decliners, or Most Active - -**Examples** - -``` -/etf tops sort:Top Gainers -``` - ---- - -## holdings - -> Displays ETF's Holdings. - -```format -/etf holdings [] -``` - -**etf** -- ETF Symbol - -**[num]** - _optional_ -- Amount of holdings to display. Default 15 - -**Examples** - -``` -/etf holdings etf:SPY -``` - -``` -/etf holdings etf:SPY num:25 -``` diff --git a/website/content/bot/reference/discord/etfs/index.md b/website/content/bot/reference/discord/etfs/index.md new file mode 100644 index 000000000000..df620d1a9588 --- /dev/null +++ b/website/content/bot/reference/discord/etfs/index.md @@ -0,0 +1,4 @@ +# ETFs + +- [holdings](/bot/reference/discord/etfs/holdings) +- [tops](/bot/reference/discord/etfs/tops) diff --git a/website/content/bot/reference/discord/flow.mdx b/website/content/bot/reference/discord/flow.mdx deleted file mode 100644 index 6629e9455ab9..000000000000 --- a/website/content/bot/reference/discord/flow.mdx +++ /dev/null @@ -1,278 +0,0 @@ ---- -title: Flow -description: opening, day, bigflow, prem, weekly, summary... -premium: true -commands: - - "/flow unu" - - "/flow opening" - - "/flow day" - - "/flow bigflow" - - "/flow prem" - - "/flow weekly" - - "/flow summary" - - "/flow sectors" - - "/flow sumexp" - - "/flow sumweek" - - "/flow sumday" - - "/flow sumtop" ---- - -# Flow - -## unu - -> Unusual Options Trades over 100k Prem. - Vol > OI - -```format -/flow unu -``` - ---- - -## opening - -> Top 20 flow by Premium for a stock with opening condition - Vol > OI - -```format -/flow opening -``` - -**ticker** - -- Ticker symbol you want to lookup - -Examples - -``` -/flow opening ticker:AMD -``` - ---- - -## day - -> Returns the most recent flow for a stock - -```format -/flow day [expiry] [strike] [opt_type] -``` - -**ticker** - -- Ticker symbol you want to lookup - -**[expiry]** - _optional_ - -- Filter last flow for the provided expiration date that happened today - YYYY-MM-DD format - -**[strike]** - _optional_ - -- Filter on the strike for flow - - -**[opt_type]** - _optional_ - -- Filter on option type - Can be "C" - Calls or "P" - Puts - -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 -``` - ---- - -## bigflow - -> Returns the top 20 largest flow by premium for a stock - -```format -/flow bigflow -``` - -**ticker** - -- Ticker symbol you want to lookup - -Examples - -``` -/flow bigflow ticker:AMD -``` - ---- - -## weekly - -> Top 20 flow by Premium for a stock with weekly expiration - -```format -/flow weekly -``` - -**ticker** - -- Ticker symbol you want to lookup - -Examples - -``` -/flow weekly ticker:AMD -``` - ---- - -## prem - -> Returns a chart with sum of premium per day by call/put - -```format -/flow prem -``` - -**ticker** - -- Ticker symbol you want to lookup - -Examples - -``` -/flow prem ticker:AMD -``` - ---- - -## summary - -> Summary of all flow by % of MarketCap - -```format -/flow summary -``` - -**days** - -- The number of days to look back - -**sort** - -- Field to sort by - Can be : MarketCap, Float, Total, Short Percentage - -Examples - -``` -/flow summary days:5 sort:Float -``` - -``` -/flow summary days:5 sort:Short Percentage -``` - ---- - -## sectors - -> Summary of all flow by % of MarketCap by Sector - -``` -/flow sectors -``` - -**days** - -- The number of days to look back - -**sector** - -- Sector to filter by - Basic Materials | Energy | Communication Services | Consumer Cyclical | Consumer Defensive | Financial | Healthcare | Industrials | Real Estate | Technology | Utilities - -Examples - -``` -/flow sectors days:5 sector:Energy -``` - -``` -/flow sectors days:2 sector:Communication Services -``` - ---- - -## sumday - -> Graph Today's Total Premium of a stock. - -```format -/flow sumday -``` - -**ticker** - -- The ticker/symbol to look up - -Examples - -``` -/flow sumday ticker:AMD -``` - ---- - -## sumweek - -> Graph Total Premium weekly summary of a stock. - -```format -/flow sumweek -``` - -**ticker** - -- The ticker/symbol to look up - -Examples - -``` -/flow sumweek ticker:AMD -``` - ---- - -## sumexp - -> Flow summary by expiration date - -```format -/flow sumexp -``` - -**ticker** - -- The ticker/symbol to look up - -**expiry** - -- The expiration date to lookup - -Examples - -``` -/flow sumexp ticker:AMD expiry:2022-07-29 -``` - ---- - -## sumtop - -> Top flow for the day Calls vs Puts by ticker - -```format -/flow sumtop -``` diff --git a/website/content/bot/reference/discord/flow/index.md b/website/content/bot/reference/discord/flow/index.md new file mode 100644 index 000000000000..cb72735d5056 --- /dev/null +++ b/website/content/bot/reference/discord/flow/index.md @@ -0,0 +1,14 @@ +# Flow + +- [bigflow](/bot/reference/discord/flow/bigflow) +- [day](/bot/reference/discord/flow/day) +- [opening](/bot/reference/discord/flow/opening) +- [prem](/bot/reference/discord/flow/prem) +- [sectors](/bot/reference/discord/flow/sectors) +- [sumday](/bot/reference/discord/flow/sumday) +- [sumexp](/bot/reference/discord/flow/sumexp) +- [summary](/bot/reference/discord/flow/summary) +- [sumtop](/bot/reference/discord/flow/sumtop) +- [sumweek](/bot/reference/discord/flow/sumweek) +- [unu](/bot/reference/discord/flow/unu) +- [weekly](/bot/reference/discord/flow/weekly) diff --git a/website/content/bot/reference/discord/fun.mdx b/website/content/bot/reference/discord/fun.mdx deleted file mode 100644 index f64f42567b3e..000000000000 --- a/website/content/bot/reference/discord/fun.mdx +++ /dev/null @@ -1,62 +0,0 @@ ---- -title: Fun -description: 8ball, flip, urban -premium: false -commands: - - "/fun 8ball" - - "/fun flip" - - "/fun urban" - ---- - -# Fun - -## 8ball - -> Ask 8ball a question - -```format -/fun 8ball -``` - -**question** -- Make sure its in the form of a question - -**Examples** - -``` -/fun 8ball question:Will I make money today? -``` ---- - -## flip - -> Flip a coin for your Witcher! - -```format -/fun flip -``` - -**Examples** - -``` -/fun flip -``` ---- -## Urban - -> Look up a word in the urban dictionary - be careful - -```format -/fun urban -``` - -**word** -- enjoy the lookup - -**Examples** - -``` -/fun urban word:Shill -``` ---- diff --git a/website/content/bot/reference/discord/fun/index.md b/website/content/bot/reference/discord/fun/index.md new file mode 100644 index 000000000000..d8ad8bc7c956 --- /dev/null +++ b/website/content/bot/reference/discord/fun/index.md @@ -0,0 +1,5 @@ +# Fun + +- [8ball](/bot/reference/discord/fun/8ball) +- [flip](/bot/reference/discord/fun/flip) +- [urban](/bot/reference/discord/fun/urban) diff --git a/website/content/bot/reference/discord/general.mdx b/website/content/bot/reference/discord/general.mdx deleted file mode 100644 index 8ac5f450f526..000000000000 --- a/website/content/bot/reference/discord/general.mdx +++ /dev/null @@ -1,213 +0,0 @@ ---- -title: General -description: autopost, watchlist, markets, news, quote, futures, ta, pop -premium: false -commands: - - "/autopost" - - "/watchlist" - - "/news" - - "/markets" - - "/quote" - - "/futures" - - "/ta" - - "/heatmap" - - "/heatchart" - - "/pop" ---- - -# General - -## autopost - -> Set up Autoposting for your server - (Server Only) - -```format -/autopost add -``` - -**add** - _optional_ -- If you want to add autoposts to your server - -**list** - _optional_ -- If you want to list all current autoposts - -**remove** - _optional_ -- If you want to remove an autopost from your server channel - -**Examples** - -``` -/autopost add -``` -``` -/autopost list -``` -``` -/autopost remove -``` - - -## watchlist - -> Display the tickers in your watchlist - Registered users get 3 for free! - -```format -/watchlist [] [] -``` - -**add** - _optional_ -- How to add more tickers to your watchlist - -**edit** - _optional_ -- If you want to remove symbols you can run add this optional parameter - -**Examples** - -``` -/watchlist -``` -``` -/watchlist add:AMD -``` -``` -/watchlist add:AMD,GOOG,TSLA -``` -``` -/watchlist edit:Remove -``` - -## news - -> Display the most recent news for ticker - -```format -/news -``` - -**ticker** -- The symbol/ticker/coin of the stock/coin you want to query - -**Examples** - -``` -/news ticker:AMD -``` - ---- - -## markets - -> Displays an overview of the market with adv / decliners relative to change and 50d/200d MA - -```format -/markets -``` - -**Examples** - -``` -/markets -``` - ---- - -## quote - -> Displays ticker quote info. - -```format -/quote -``` - -**ticker** -- The symbol/ticker/coin of the stock/coin you want to query - -**Examples** - -``` -/quote ticker:AMD -``` - ---- - -## futures - -> Displays Futures. - -```format -/futures -``` - ---- - -## ta - -> Displays a given stocks Technical Analysis summary. - -```format -/ta -``` - -**ticker** -- The symbol/ticker/coin of the stock/coin you want to query - -**Examples** - -``` -/ta ticker:AMD -``` - ---- - -## heatmap - -> Daily Heat Maps by Market. Sector is optional. - -```format -/heatmap -``` - -**market** -- Market to filter by. -**sector** -- Sector to filter by. If not specified, all sectors are returned. - -**Examples** - -``` -/heatmap market:S&P 500 -/heatmap market:S&P 500 sector:Services -``` - ---- - -## heatchart - -> Daily Market Heat Chart - 15m Delayed - -```format -/heatchart -``` - -**Examples** - -``` -/heatchart -``` -## pop - -> Display the most popular tickers over the last hour or day run on the bot - -```format -/pop -``` - -**Examples** - -``` -/pop 1hr -``` - -``` -/pop 1d -``` diff --git a/website/content/bot/reference/discord/general/index.md b/website/content/bot/reference/discord/general/index.md new file mode 100644 index 000000000000..400972fccd03 --- /dev/null +++ b/website/content/bot/reference/discord/general/index.md @@ -0,0 +1,10 @@ +# General + +- [futures](/bot/reference/discord/general/futures) +- [heatchart](/bot/reference/discord/general/heatchart) +- [heatmap](/bot/reference/discord/general/heatmap) +- [markets](/bot/reference/discord/general/markets) +- [news](/bot/reference/discord/general/news) +- [quote](/bot/reference/discord/general/quote) +- [ta](/bot/reference/discord/general/ta) +- [watchlist](/bot/reference/discord/general/watchlist) diff --git a/website/content/bot/reference/discord/government.mdx b/website/content/bot/reference/discord/government.mdx deleted file mode 100644 index da00daa93b2a..000000000000 --- a/website/content/bot/reference/discord/government.mdx +++ /dev/null @@ -1,66 +0,0 @@ ---- -title: Government -description: contracts, house, senate -premium: false -commands: - - "/gov contracts" - - "/gov house" - - "/gov senate" ---- - -# Government - -## contracts - -> Displays Top 15 Government contracts by amount for all tickers or for a specific ticker. - -```format -/gov contracts -``` - -**ticker** -- The symbol of the stock you want to query - -**Examples** - -``` -/gov contracts ticker:GE -``` - ---- - -## house - -> Displays recent house trades for all tickers or a specific ticker. - -```format -/gov house -``` - -**ticker** -- The symbol of the stock you want to query - -**Examples** - -``` -/gov house ticker:GE -``` - ----- - -## senate - -> Displays recent senate trades for all tickers or for a specific ticker - -```format -/gov senate -``` - -**ticker** -- The symbol of the stock you want to query - -**Examples** - -``` -/gov senate ticker:GE -``` diff --git a/website/content/bot/reference/discord/government/index.md b/website/content/bot/reference/discord/government/index.md new file mode 100644 index 000000000000..386db0bb2a2e --- /dev/null +++ b/website/content/bot/reference/discord/government/index.md @@ -0,0 +1,5 @@ +# Government + +- [contracts](/bot/reference/discord/government/contracts) +- [house](/bot/reference/discord/government/house) +- [senate](/bot/reference/discord/government/senate) diff --git a/website/content/bot/reference/discord/info.mdx b/website/content/bot/reference/discord/info.mdx deleted file mode 100644 index 64744cdba1ea..000000000000 --- a/website/content/bot/reference/discord/info.mdx +++ /dev/null @@ -1,61 +0,0 @@ ---- -title: Info -description: help, stats, about, serverid, support -premium: false -commands: - - "/help" - - "/info stats" - - "/info about" - - "/info serverid" - - "/info support" ---- - -# Info - -## help - -> Get started with OpenBB Bot. - -```format -/help -``` - ---- - -## stats - -> Bot Stats - -```format -/info stats -``` - ---- - -## about - -> About OpenBB Terminal - -```format -/info about -``` - ---- - -## serverid - -> Responds with your Server ID - -```format -/info serverid -``` - ---- - -## support - -> Send support ticket! - -```format -/info support -``` diff --git a/website/content/bot/reference/discord/info/index.md b/website/content/bot/reference/discord/info/index.md new file mode 100644 index 000000000000..0a2d9a86ca9f --- /dev/null +++ b/website/content/bot/reference/discord/info/index.md @@ -0,0 +1,6 @@ +# Info + +- [about](/bot/reference/discord/info/about) +- [serverid](/bot/reference/discord/info/serverid) +- [stats](/bot/reference/discord/info/stats) +- [support](/bot/reference/discord/info/support) diff --git a/website/content/bot/reference/discord/nft.mdx b/website/content/bot/reference/discord/nft.mdx deleted file mode 100644 index 336f0f07e780..000000000000 --- a/website/content/bot/reference/discord/nft.mdx +++ /dev/null @@ -1,921 +0,0 @@ ---- -title: NFT -description: top, collection... -premium: false -commands: - - "/nft top" - - "/nft collection" - - "/nft chart" ---- - -import AvailableOptions from "@site/src/components/General/AvailableOptions"; - -# NFT - -## top - -> Get Top NFT Collections from Ethereum - -```format -/nft top [sortby] [interval] [reverse] -``` - -**[sortby]** - _optional_ - -- Column to sort by (default: Market Cap) - can be one of : Market Cap/ Floor Price Change / Volume / Sales - -**[interval]** - _optional_ - -- Time interval to display Sales/Volume/Floor Price (default: 1d) - can be one of : 1d / 7d / 30d / 90d - -**[reverse]** - _optional_ - -- Reverse the sort order (default: No) - Yes/No - -**Examples** - -``` -/nft top -``` - -``` -/nft top sortby: Market Cap reverse: Yes -``` - ---- - -## collection - -> Get NFT collection data from Ethereum network for the specified slug. Returns ranking, price info, supply, and much more. - -```format -/nft collection -``` - -**slug** - -- The nft you want the collection info for - - -**Examples** - -``` -/nft collection slug: bent -``` - ---- - -## chart - -> Returns NFT chart for floor price and sales on the specified slug. - -```format -/nft chart -``` - -**slug** - -- The nft you want the chart for - - -**Examples** - -``` -/nft chart slug: bent -``` - -``` -/nft chart slug: bored-ape-yacht-club -``` diff --git a/website/content/bot/reference/discord/nft/index.md b/website/content/bot/reference/discord/nft/index.md new file mode 100644 index 000000000000..8a6d2fc5c613 --- /dev/null +++ b/website/content/bot/reference/discord/nft/index.md @@ -0,0 +1,5 @@ +# NFT + +- [chart](/bot/reference/discord/nft/chart) +- [collection](/bot/reference/discord/nft/collection) +- [top](/bot/reference/discord/nft/top) diff --git a/website/content/bot/reference/discord/options.mdx b/website/content/bot/reference/discord/options.mdx deleted file mode 100644 index 179c4fa442db..000000000000 --- a/website/content/bot/reference/discord/options.mdx +++ /dev/null @@ -1,471 +0,0 @@ ---- -title: Options -description: gamma, info, topoi, unu, vol, hist, oi, mp... -premium: true -commands: - - "/op gamma" - - "/op info" - - "/op topoi" - - "/op unu" - - "/op vol" - - "/op hist" - - "/op uoastock" - - "/op highiv" - - "/op topvol" - - "/op topvoletf" - - "/op topoichange" - - "/op oi" - - "/op stats" - - "/op mp" - - "/op smile" - - "/op vsurf" - - "/op chains" ---- - -# Options - -## itm - -> Displays In-The-Money (ITM) options by expiry for a stock. - -```format -/op itm -``` - -**ticker** - -- The ticker/symbol to look up - -Examples - -``` -/op itm ticker:AMD -``` - ---- - -## equitypc - -> Displays the Equity Put/Call Volume Ratio - from market-harmonics.com - -```format -/op equitypc -``` - ---- - -## indexpc - -> Displays the Index Put/Call Ratio for the market - from market-harmonics.com - -```format -/op indexpc -``` - ---- - -## oichart - -> Charts Total Open Interest by Strike Price. - -```format -/op oichart [] -``` - -**ticker** - -- The ticker/symbol to look up - -**[expiry]** - _optional_ - -- The ticker/symbol to look up - -Examples - -``` -/op oichart ticker:AMD -``` - -``` -/op oichart ticker:AMD expiry:2022-07-29 -``` - ---- - -## gamma - -> Displays Options Gamma Levels for a Stock. - -```format -/op gamma [] -``` - -**ticker** - -- The ticker/symbol to look up - -**[expiry]** - _optional_ - -- Gamma from now to expiration - -Examples - -``` -/op gamma ticker:AMD -``` - -``` -/op gamma ticker:AMD expiry:2022-07-29 -``` - ---- - -## info - -> Displays option information (volatility, IV rank etc). - -```format -/op info -``` - -**ticker** - -- The ticker/symbol to look up - -Examples - -``` -/op info ticker:AMD -``` - ---- - -## topoi - -> Displays Top Open Interest - -```format -/op topoi -``` - ---- - -## unu - -> Shows Unusual Options - -```format -/op unu -``` - ---- - -## vol - -> Displays Options Strike Volume can add EXP date for bigger breakdown - -```format -/op vol [] -``` - -**ticker** - -- The ticker/symbol to look up - -**expiry** - _optional_ - -- Expiration to query - -Examples - -``` -/op vol ticker:AMD -``` - -``` -/op vol ticker:AMD expiry:2022-07-29 -``` - ---- - -## hist - -> Displays Options Price History in a chart. - -``` -/op hist [] -``` - -**ticker** - -- The ticker/symbol to look up - -**expiry** - -- Expiration to query - -**strike** - -- Option Strike Price - -**opt_type** - -- Calls or Puts Calls | Puts - -**interval** - -- Chart Minute Interval | 1440 for Daily 15 | 30 - -**[past_days]** - _optional_ - -- Past Days to Display. Default: 5 - -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 -``` - ---- - -## uoastock - -> Display Top 20day Average Options Volume by ticker. - -```format -/op uoastock [] -``` - -**[price]** - _optional_ - -- Filter by stocks over a certain price - -Examples - -``` -/op uoastock -``` - -``` -/op uoastock price:50 -``` - ---- - -## highiv - -> Top 15 Highest IV30 Equity stocks. - -```format -/op highiv -``` - ---- - -## topvol - -> Top 15 Highest options volume. - -```format -/op topvol -``` - ---- - -## topvoletf - -> Top 15 Highest options volume ETF. - -``` -/op topvoletf -``` - ---- - -## topoichange - -> Displays Top 15 stocks with highest OI Change. - -```format -/op topoichange -``` - ---- - -## oi - -> Displays OI and call/put ratio for given stock - can add EXP date too for bigger breakdown - -```format -/op oi [] -``` - -**ticker** - -- The ticker/symbol to look up - -**[expiry]** - _optional_ - -- Expiration to query - -Examples - -``` -/op oi ticker:AMC -``` - -``` -/op oi ticker:AMC expiry:2022-07-29 -``` - ---- - -## stats - -> Displays Options Statistics for a stock. - -```format -/op stats -``` - -**ticker** - -- The ticker/symbol to look up - -Examples - -``` -/op stats ticker:AMC -``` - ---- - -## maxpain - -> Displays the Max Pain on expiration date for a given stock. - -```format -/op maxpain -``` - -**ticker** - -- The ticker/symbol to look up - -**expiry** - -- Expiration to query - -Examples - -``` -/op maxpain ticker:AMC expiry:2022-07-29 -``` - ---- - -## chains - -> Displays Options Chain by Expiry - -```format -/op chains [] [] -``` - -**ticker** - -- The ticker/symbol to look up - -**expiry** - -- Expiration to query - -**opt_type** - -- Calls or Puts - -**[min_sp]** - _optional_ - -- Minimum Strike Price - -**[max_sp]** - _optional_ - -- Maximum Strike Price - -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 -``` - ---- - -## vsurf - -> Displays Options Volatility Surface - -```format -/op vsurf -``` - -**ticker** - -- The ticker/symbol to look up - -**z** - -- Variable for the Z axis (Volatility, Open Interest, Last Price) - -Examples - -``` -/op vsurf ticker:AMD z:Volatility -``` - -``` -/op vsurf ticker:AMD z:Open Interest -``` - ---- - -## smile - -> Displays Options Volatility Smile - -```format -/op smile [] [] -``` - -**ticker** - -- The ticker/symbol to look up - -**expiry** - -- Expiration to query - -**[min_sp]** - _optional_ - -- Minimum Strike price - -**[max_sp]** - _optional_ - -- Maximum Strike Price - -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/index.md b/website/content/bot/reference/discord/options/index.md new file mode 100644 index 000000000000..6c5301696bef --- /dev/null +++ b/website/content/bot/reference/discord/options/index.md @@ -0,0 +1,24 @@ +# Options + +- [chains](/bot/reference/discord/options/chains) +- [equitypc](/bot/reference/discord/options/equitypc) +- [gamma](/bot/reference/discord/options/gamma) +- [highiv](/bot/reference/discord/options/highiv) +- [hist](/bot/reference/discord/options/hist) +- [indexpc](/bot/reference/discord/options/indexpc) +- [info](/bot/reference/discord/options/info) +- [itm](/bot/reference/discord/options/itm) +- [maxpain](/bot/reference/discord/options/maxpain) +- [oi](/bot/reference/discord/options/oi) +- [oichart](/bot/reference/discord/options/oichart) +- [smile](/bot/reference/discord/options/smile) +- [stats](/bot/reference/discord/options/stats) +- [topoi](/bot/reference/discord/options/topoi) +- [topoichange](/bot/reference/discord/options/topoichange) +- [topstrikevol](/bot/reference/discord/options/topstrikevol) +- [topvol](/bot/reference/discord/options/topvol) +- [topvoletf](/bot/reference/discord/options/topvoletf) +- [unu](/bot/reference/discord/options/unu) +- [uoastock](/bot/reference/discord/options/uoastock) +- [vol](/bot/reference/discord/options/vol) +- [vsurf](/bot/reference/discord/options/vsurf) diff --git a/website/content/bot/reference/discord/pop/index.md b/website/content/bot/reference/discord/pop/index.md new file mode 100644 index 000000000000..a36c09718887 --- /dev/null +++ b/website/content/bot/reference/discord/pop/index.md @@ -0,0 +1,4 @@ +# Pop + +- [1d](/bot/reference/discord/pop/1d) +- [1hr](/bot/reference/discord/pop/1hr) diff --git a/website/content/bot/reference/discord/screeners.mdx b/website/content/bot/reference/discord/screeners.mdx deleted file mode 100644 index cffb95069618..000000000000 --- a/website/content/bot/reference/discord/screeners.mdx +++ /dev/null @@ -1,80 +0,0 @@ ---- -title: Screeners -description: technical, all, pm, ah -premium: false -commands: - - "/scr technical" - - "/scr all" - - "/scr pm" - - "/scr ah" ---- - -# Screeners - -## technical - -> Displays stock screener results according to chosen signal. - -```format -/scr technical -``` - -**signal** -- Screener presets - Top Gainers | Top Losers | Most Active | Most Volatile | Relative Volatility | Golden Cross | Death Cross | New 52week High | New 52week Low | Unusual Volume | Overbought (RSI > 70) | Oversold (RSI < 14) - -**Examples** - -``` -/scr technical signal:Top Gainers -``` -``` -/scr technical signal:Death Cross -``` - ---- - -## all - -> Displays all available screeners - -```format -/scr all -``` - ---- - -## pm - -> Displays Pre-Market stocks according to chosen screener. - -```format -/scr pm -``` - -**signal** -- Screener preset - Pre-Market Top Gainers | Pre-Market Top Losers | Pre-Market Most Active - -**Examples** - -``` -/scr pm signal:Pre-Market Top Gainers -``` - ---- - -## ah - -> Displays After-Hours stocks according to chosen screener. - -```format -/scr ah -``` - -**signal** -- Screener preset - After-Hours Top Gainers | After-Hours Top Losers | After-Hours Most Active - -**Examples** - -``` -/scr ah signal:After-Hours Top Gainers -``` diff --git a/website/content/bot/reference/discord/screeners/index.md b/website/content/bot/reference/discord/screeners/index.md new file mode 100644 index 000000000000..2dfdfc53d8e0 --- /dev/null +++ b/website/content/bot/reference/discord/screeners/index.md @@ -0,0 +1,8 @@ +# Screeners + +- [ah](/bot/reference/discord/screeners/ah) +- [ah_all](/bot/reference/discord/screeners/ah_all) +- [all](/bot/reference/discord/screeners/all) +- [pm](/bot/reference/discord/screeners/pm) +- [pm_all](/bot/reference/discord/screeners/pm_all) +- [technical](/bot/reference/discord/screeners/technical) diff --git a/website/content/bot/reference/discord/short_data.mdx b/website/content/bot/reference/discord/short_data.mdx deleted file mode 100644 index 809489e23209..000000000000 --- a/website/content/bot/reference/discord/short_data.mdx +++ /dev/null @@ -1,101 +0,0 @@ ---- -title: Shorts -description: shotvol, shortint, topshortvol, hsi... -premium: false -commands: - - "/sh shortvol" - - "/sh shortint" - - "/sh topshortvol" - - "/sh hsi" - - "/sh shortrate" - - "/sh borrowed" ---- - -# Shorts - -## sh - -> Graph of 30 day history of short volume vs vol. - -```format -/sh shortvol -``` - -**ticker** -- The symbol/ticker of the stock you want the short interest for - -**Examples** - -``` -/sh shortvol ticker:AMD -``` - ---- - -## borrowed - -> Displays history of borrowed shares available and fee. - -```format -/sh borrowed -``` - -**ticker** -- The symbol/ticker of the stock you want the short interest for - -**Examples** - -``` -/sh borrowed ticker:AMD -``` - ---- - -## shortrate - -> Display Short shares spot borrow rate sourced from Interactive Brokers. - -```format -/sh shortrate -``` - -**ticker** -- The symbol/ticker of the stock you want the short interest for - -**Examples** - -``` -/sh shortrate ticker:AMD -``` - ---- - -## topshortvol - -> Top 15 Short Interest Stocks per Finra - -```format -/sh topshortvol -``` - ---- - -## hsi - -> Show top high short interest stocks of over 20% ratio - -``` -/sh hsi [] -``` - -**[num]** - _optional_ -- The number of stocks to print - -Examples - -``` -/sh hsi -``` -``` -/sh hsi num:4 -``` diff --git a/website/content/bot/reference/discord/short_data/index.md b/website/content/bot/reference/discord/short_data/index.md new file mode 100644 index 000000000000..e5a8eca8955c --- /dev/null +++ b/website/content/bot/reference/discord/short_data/index.md @@ -0,0 +1,7 @@ +# Short Data + +- [borrowed](/bot/reference/discord/short_data/borrowed) +- [hsi](/bot/reference/discord/short_data/hsi) +- [shortrate](/bot/reference/discord/short_data/shortrate) +- [shortvol](/bot/reference/discord/short_data/shortvol) +- [topshortvol](/bot/reference/discord/short_data/topshortvol) diff --git a/website/content/bot/reference/telegram/charts.mdx b/website/content/bot/reference/telegram/charts.mdx deleted file mode 100644 index 9cb175948467..000000000000 --- a/website/content/bot/reference/telegram/charts.mdx +++ /dev/null @@ -1,231 +0,0 @@ ---- -title: Charting -description: c3m, c5m, c15m, cd, cw... -premium: false -commands: - - "/chart" - - "/c3m" - - "/c5m" - - "/c15m" - - "/cd" - - "/cw" - - "/cm" - - "/chartfib" - - "/chartsr" ---- - -# Charting - -## chart - -> Shows the candlestick chart for the ticker/interval provided - -```format -/chart [] -``` - -**ticker** - -- The symbol/ticker/coin of the stock you want the chart of - -**interval** - -- The interval you want to chart - Current valid options are : 1m, 5m, 10m, 15m, 30m, 60m, 1d, 1wk, 1mo - -**[past_days]** - _optional_ - -- Amount of days to show for the Interval - -**Examples** - -``` -/chart AMD 1d 10 -``` - -``` -/chart AMD 1d -``` - ---- - -## c3m - -> Shows an intraday 3m candlestick chart for the ticker provided - -```format -/c3m -``` - -**ticker** - -- The symbol/ticker/coin of the stock you want the chart of - -**[extendedhours]** - _optional_ - -- Show the full extended hours chart from 4am to 8pm - -**Examples** - -``` -/c3m AMD -``` - -``` -/c3m AMD true -``` - ---- - -## c5m - -> Shows an intraday 5m candlestick chart for the ticker/coin provided - -```format -/c5m -``` - -**ticker** - -- The symbol/ticker/coin of the ticker/coin you want the chart of - -**[extendedhours]** - _optional_ - -- Show the full extended hours chart from 4am to 8pm - -**Examples** - -``` -/c5m AMD -``` - -``` -/c5m AMD true -``` - ---- - -## c15m - -> Shows an intraday 15m candlestick chart for the ticker provided - -```format -/c15m -``` - -**ticker** - -- The symbol/ticker/coin of the stock you want the chart of - -**Examples** - -``` -/c15m AMD -``` - ---- - -## cd - -> Shows a daily candlestick chart for the ticker/coin provided - -```format -/cd -``` - -**ticker** - -- The symbol/ticker/coin of the stock you want the chart of - -**Examples** - -``` -/cd AMD -``` - ---- - -## cw - -> Shows a weekly candlestick chart for the ticker/coin provided - -```format -/cw -``` - -**ticker** - -- The symbol/ticker/coin of the stock you want the chart of - -**Examples** - -``` -/cw AMD -``` - ---- - -## cm - -> Shows a monthly candlestick chart for the ticker/coin provided - -```format -/cm -``` - -**ticker** - -- The symbol/ticker/coin of the stock you want the chart of - -**Examples** - -``` -/cm AMD -``` - ---- - -## chartfib - -> Plots the Fibonacci levels for the ticker provided - -```format -/chartfib -``` - -**ticker** - -- The symbol/ticker/coin of the stock you want the chartfib of - -**Examples** - -``` -/chartfib AMD -``` - ---- - -## chartsr - -> Displays Support and Resistance Levels for the ticker provided - -```format -/chartsr **[interval]** -``` - -**ticker** - -- The symbol/ticker/coin of the stock you want the chartfib of - -**[interval]** - _optional_ - -- interval in minutes for the chart. Defaults to Daily with no selection - -**Examples** - -``` -/chartsr AMC -``` - -``` -/chartsr AMC 1d -``` diff --git a/website/content/bot/reference/telegram/charts/index.md b/website/content/bot/reference/telegram/charts/index.md new file mode 100644 index 000000000000..cddf56b94beb --- /dev/null +++ b/website/content/bot/reference/telegram/charts/index.md @@ -0,0 +1,13 @@ +# charts + +- [c](/bot/reference/telegram/charts/c) +- [c15m](/bot/reference/telegram/charts/c15m) +- [c3m](/bot/reference/telegram/charts/c3m) +- [c5m](/bot/reference/telegram/charts/c5m) +- [cc](/bot/reference/telegram/charts/cc) +- [cd](/bot/reference/telegram/charts/cd) +- [chart](/bot/reference/telegram/charts/chart) +- [chartfib](/bot/reference/telegram/charts/chartfib) +- [chartsr](/bot/reference/telegram/charts/chartsr) +- [cm](/bot/reference/telegram/charts/cm) +- [cw](/bot/reference/telegram/charts/cw) diff --git a/website/content/bot/reference/telegram/crypto.mdx b/website/content/bot/reference/telegram/crypto.mdx deleted file mode 100644 index c3206317623d..000000000000 --- a/website/content/bot/reference/telegram/crypto.mdx +++ /dev/null @@ -1,268 +0,0 @@ ---- -title: Crypto -description: c, prints, bigprints, bio, defi, fees, ir... -premium: false -commands: - - "/c" - - "/prints" - - "/bigprints" - - "/tvl" - - "/defi chart" - - "/defi" - - "/bio" - - "/fees" - - "/compfees" - - "/ir" ---- - -# Crypto - -## chart - -```format -/c -``` - -> Shows the candlestick chart for the ticker/interval provided - -**symbol** - - The Crypto Symbol want to chart - -**currency** - _optional_ - - Crypto Currency. Default: USDT - -**exchange** - _optional_ - - Crypto Exchange. Default: binanceus - -**interval** - _optional_ - - Chart Interval. Default: 15m - -**srlines** - _optional_ - - Show Support/Resistance Lines. Default: False - -**fibs** - _optional_ - - Show Fibonacci Retracement Levels. Default: False - - -```format -/c doge -``` - ---- - -## prints - -> Last 15 Crypto Prints over last 24hrs. - -```format -/prints -``` - -**coin** - - The coin you want the prints of - -**Examples** - -``` -/prints ada -``` - ---- - -## bigprints - -> Last 15 Large Crypto Prints. - -```format -/bigprints -``` - -**coin** - - The coin you want the large prints of - -**Examples** - -``` -/bigprints ada -``` - ---- - -## tvl - -> Get protocols historical TVL. - -```format -/crypto tvl -``` - -**protocols** - - comma separated list of protocols (e.g., curve,makerdao) - -**Examples** - -``` -/tvl -``` -``` -/tvl curve -``` - ---- - -## defi table - -> Get top DeFi protocols - -```format -/defi [sortby] [chain] [reverse] -``` - -**[sortby]** - _optional_ - -- Column to sort data by (default="TVL") (e.g., Total Value Locked) - -**[chain]** - _optional_ - -- Chain to filter by (default="all") (e.g., ethereum) - -**[reverse]** - _optional_ - -- Reverse the sort order (default: No) - Yes/No - -**Examples** - -``` -/defi -``` - -``` -/defi 1hr Bitcoin -``` - ---- - - -## defi chart - -> Chart of top 20 defi protocols by TVL - -```format -/defi chart -``` - -**Examples** - -``` -/defi chart -``` - ---- - -## top - -> Get top cryptos and info - -```format -/crypto top [sortby] [category] [reverse] -``` - -**[sortby]** - _optional_ - -- Column to sort data by (default="mc") (e.g., Market Cap) - -**[category]** - _optional_ - -- Category to filter by (default="all") (e.g., stablecoins) - -**[reverse]** - _optional_ - -- Reverse the sort order (default: No) - Yes/No - -**Examples** - -``` -/top -``` - -``` -/top mc marketing -``` - ---- - -## bio - -> Get fundamental information about a crypto. - -```format -/bio -``` - -**symbol** - - Crypto symbol to check information (e.g., BTC) - -**Examples** - -``` -/bio btc -``` - ---- - -## fees - -> Fees on a certain date of top crypto protocols - -```format -/fees -``` - -**date** - - Date to get fees for (e.g., 2022-01-01) - -**Examples** - -``` -/fees date: 2023-04-19 -``` - ---- - -## compfees - -> Get protocol fees over time. - -```format -/compfees -``` - -**project** - - Comma separated list of protocols (e.g., btc,eth) - -**Examples** - -``` -/compfees doge -``` - -``` -/compfees projects: btc,eth -``` - - ---- - -## ir - -> Returns a table of issuance rate of top crypto protocols. - -```format -/ir -``` - -**Examples** - -``` -/ir -``` diff --git a/website/content/bot/reference/telegram/crypto/index.md b/website/content/bot/reference/telegram/crypto/index.md new file mode 100644 index 000000000000..cc049b822d31 --- /dev/null +++ b/website/content/bot/reference/telegram/crypto/index.md @@ -0,0 +1,11 @@ +# crypto + +- [bigprints](/bot/reference/telegram/crypto/bigprints) +- [bio](/bot/reference/telegram/crypto/bio) +- [compfees](/bot/reference/telegram/crypto/compfees) +- [defi](/bot/reference/telegram/crypto/defi) +- [fees](/bot/reference/telegram/crypto/fees) +- [ir](/bot/reference/telegram/crypto/ir) +- [prints](/bot/reference/telegram/crypto/prints) +- [top](/bot/reference/telegram/crypto/top) +- [tvl](/bot/reference/telegram/crypto/tvl) diff --git a/website/content/bot/reference/telegram/darkpool.mdx b/website/content/bot/reference/telegram/darkpool.mdx deleted file mode 100644 index 5787c0d0d17b..000000000000 --- a/website/content/bot/reference/telegram/darkpool.mdx +++ /dev/null @@ -1,170 +0,0 @@ ---- -title: Darkpool -description: topsum, sectors, summary, allprints... -premium: true -commands: - - "/topsum" - - "/sectors" - - "/summary" - - "/allprints" - - "/allblocks" - - "/alldp" - - "/bigprintsdp" - - "/levels" ---- - -# darkpool - -## topsum - -> Top Total Block & Dark Pool data. - -```format -/topsum -``` - -**Examples** - -``` -/topsum -``` - ---- - -## levels - -> Biggest Levels for All Prints over last X days. - -```format -/levels -``` - -**ticker** - - The ticker to query for - -**days** - - The number of days to return - -**Examples** - -``` -/levels TSLA 10 -``` - ---- - -## sectors - -> Summary of all prints by % of MarketCap by Sector - -```format -/sectors -``` - -**days** - - The number of days to return - -**sector** - - The sector to select for the query - -```format -/sectors 5 bm -``` - ---- - -## summary - -> Summary of all prints by % of MarketCap - -```format -/summary -``` - -**days** - - The number of days to return - -**sort** - - Sort by market cap, float, total or short percentage - -**Examples** - -``` -/summary 10 mc -``` - ---- - -## allprints - -> Last 10 Combination of Dark Pool and Blocks. - -```format -/allprints -``` - -**ticker** - - The symbol/ticker of the stock you want to lookup - -**Examples** - -``` -/allprints AMD -``` - ---- - -## alldp - -> Last 15 Dark Pool Trades. - -```format -/alldp -``` - -**ticker** - - The symbol/ticker of the stock you want to lookup - -**Examples** - -``` -/alldp AMD -``` - ---- - -## allblocks - -> Last 15 Combination of Block Trades only - -```format -/allblocks -``` - -**ticker** - - The symbol/ticker of the stock you want to lookup - -**Examples** - -``` -/allblocks AMD -``` - ---- - -## bigprints - -> Combination of Dark Pool and Blocks - Largest over x amount of days - -```format -/bigprintsdp -``` - -**days** - - The number of days to return - -**Examples** - -``` -/bigprintsdp 6 -``` diff --git a/website/content/bot/reference/telegram/darkpool/index.md b/website/content/bot/reference/telegram/darkpool/index.md new file mode 100644 index 000000000000..c5320a97a182 --- /dev/null +++ b/website/content/bot/reference/telegram/darkpool/index.md @@ -0,0 +1,10 @@ +# darkpool + +- [allblocks](/bot/reference/telegram/darkpool/allblocks) +- [alldp](/bot/reference/telegram/darkpool/alldp) +- [allprints](/bot/reference/telegram/darkpool/allprints) +- [bigprintsdp](/bot/reference/telegram/darkpool/bigprintsdp) +- [levels](/bot/reference/telegram/darkpool/levels) +- [sectors](/bot/reference/telegram/darkpool/sectors) +- [summary](/bot/reference/telegram/darkpool/summary) +- [topsum](/bot/reference/telegram/darkpool/topsum) diff --git a/website/content/bot/reference/telegram/discovery.mdx b/website/content/bot/reference/telegram/discovery.mdx deleted file mode 100644 index f2d3f9c12182..000000000000 --- a/website/content/bot/reference/telegram/discovery.mdx +++ /dev/null @@ -1,114 +0,0 @@ ---- -title: Discovery -description: splits, senate, house, fgindex, ipolist... -premium: false -commands: - - "/splits" - - "/senate" - - "/house" - - "/fgindex" - - "/ipolist" - - "/contracts" - - "/holidays" - - "/wsb" - - "/trendingst" ---- - -# Discovery - -## splits - -> List of recent Stock splits for all tickers. - -```format -/splits -``` - ---- - -## senate - -> Displays recent senate trades for all tickers. - -```format -/senate -``` - ---- - -## house - -> Displays recent House trades for all tickers - -```format -/house -``` - ---- - -## fgindex - -> Displays Fear & Greed Index - Investor Sentiment - CNNMoney - -```format -/fgindex -``` - ---- - -## ipolist - -> Displays 10 Upcoming and Recent IPO's. - -```format -/ipolist -``` - ---- - -## contracts - -> Displays Top 15 Government contracts by amount for all tickers. - -```format -/contracts -``` - ---- - -## holidays - -> Displays Upcoming Market Holidays. - -```format -/holidays -``` - ---- - -## arktrades - -> Displays trades made by ARK ETF - -```format -/arktrades -``` - ---- - -## wsb - -> Display Top 15 Trending Stocks - WSB (WallStreetBets) - -```format -/wsb -``` ---- - -## trendingst - -> Display top 15 Trending Stocks - StockTwits - -```format -/trendingst -``` diff --git a/website/content/bot/reference/telegram/discovery/index.md b/website/content/bot/reference/telegram/discovery/index.md new file mode 100644 index 000000000000..cde4a7364ae5 --- /dev/null +++ b/website/content/bot/reference/telegram/discovery/index.md @@ -0,0 +1,10 @@ +# discovery + +- [arktrades](/bot/reference/telegram/discovery/arktrades) +- [fgindex](/bot/reference/telegram/discovery/fgindex) +- [halts](/bot/reference/telegram/discovery/halts) +- [holidays](/bot/reference/telegram/discovery/holidays) +- [ipolist](/bot/reference/telegram/discovery/ipolist) +- [pop](/bot/reference/telegram/discovery/pop) +- [trendingst](/bot/reference/telegram/discovery/trendingst) +- [wsb](/bot/reference/telegram/discovery/wsb) diff --git a/website/content/bot/reference/telegram/duediligence/index.md b/website/content/bot/reference/telegram/duediligence/index.md new file mode 100644 index 000000000000..32c1dc832c4a --- /dev/null +++ b/website/content/bot/reference/telegram/duediligence/index.md @@ -0,0 +1,19 @@ +# duediligence + +- [ah](/bot/reference/telegram/duediligence/ah) +- [analyst](/bot/reference/telegram/duediligence/analyst) +- [bio_stocks](/bot/reference/telegram/duediligence/bio_stocks) +- [customer](/bot/reference/telegram/duediligence/customer) +- [divinfo](/bot/reference/telegram/duediligence/divinfo) +- [earnings](/bot/reference/telegram/duediligence/earnings) +- [ermove](/bot/reference/telegram/duediligence/ermove) +- [financials](/bot/reference/telegram/duediligence/financials) +- [insiders](/bot/reference/telegram/duediligence/insiders) +- [instholdings](/bot/reference/telegram/duediligence/instholdings) +- [nexter](/bot/reference/telegram/duediligence/nexter) +- [pm](/bot/reference/telegram/duediligence/pm) +- [pt](/bot/reference/telegram/duediligence/pt) +- [sec](/bot/reference/telegram/duediligence/sec) +- [splits](/bot/reference/telegram/duediligence/splits) +- [supplier](/bot/reference/telegram/duediligence/supplier) +- [ytd](/bot/reference/telegram/duediligence/ytd) diff --git a/website/content/bot/reference/telegram/duedilligence.mdx b/website/content/bot/reference/telegram/duedilligence.mdx deleted file mode 100644 index 638336944fb8..000000000000 --- a/website/content/bot/reference/telegram/duedilligence.mdx +++ /dev/null @@ -1,349 +0,0 @@ ---- -title: Due Diligence -description: ph, ah, shortrate, news, earnings, bio, ermove... -premium: false -commands: - - "/pm" - - "/ah" - - "/splits" - - "/earnings" - - "/nexter" - - "/bio" - - "/ermove" - - "/analyst" - - "/pt" - - "/supplier" - - "/customer" - - "/insiders" - - "/arktrades" - - "/instholdings" - - "/financials" - - "/divinfo" - - "/ytd" ---- - -# Due Diligence - -## pm - -> Displays premarket data for a given stock ticker - -```format -/pm -``` - -**ticker** - -- The symbol/ticker of the stock you want the premarket info for - -**Examples** - -``` -/pm AMD -``` - ---- - -## ah - -> Displays afterhours data for a given stock ticker - -```format -/ah -``` - -**ticker** - -- The symbol/ticker of the stock you want the afterhours info for - -**Examples** - -``` -/ah AMD -``` - ---- - -## splits - -> List of recent Stock splits for a ticker - -### Command - -```format -/splits -``` - -**ticker** - -- The symbol/ticker of the stock you want the splits for - -**Examples** - -``` -/splits AMD -``` - ---- - -## earnings - -> Display Earnings that are expected to occur in the next business days. (Sorted by market cap) - -```format -/earnings -``` - -**day** - -- The Date you want to see the earnings for. Format: YYYY-MM-DD - -**Examples** - -``` -/earnings 2022-07-29 -``` - ---- - -## nexter - -> Returns next Earnings Date for a stock. - -```format -/nexter -``` - -**ticker** - -- The symbol/ticker of the stock you want the next earnings date for - -**Examples** - -``` -/nexter AMD -``` - ---- - -## bio - -> Displays a Crpyto's Info and other information or you can use bio_stocks to get Stock bio - -```format -/bio -``` - -**ticker** - -- The symbol/ticker of the stock you want the bio of - -**Examples** - -``` -/bio BTC -``` - -``` -/bio_stocks AMD -``` - ---- - -## ermove - -> Display implied move for a stock based on option prices. - -```format -/ermove -``` - -**ticker** - -- The symbol/ticker of the stock you want the earnings move of - -**Examples** - -``` -/ermove AMD -``` - ---- - -## analyst - -> Displays analyst recommendations. - -```format -/analyst -``` - -**ticker** - -- The symbol/ticker of the stock you want the analyst ratings for - -**Examples** - -``` -/analyst AMD -``` - ---- - -## pt - -> Displays chart with price targets. - -```format -/pt -``` - -**ticker** - -- The symbol/ticker of the stock you want to query - -**Examples** - -``` -/pt AMD -``` - ---- - -## supplier - -> Retrieve list of suppliers for specified company - -```format -/supplier -``` - -**ticker** - -- The symbol/ticker of the stock you want to query - -**Examples** - -``` -/supplier AMD -``` - ---- - -## customer - -> Retrieve list of customers for specified company - -```format -/customer -``` - -**ticker** - -- The symbol/ticker of the stock you want to query - -**Examples** - -``` -/customer AMD -``` - ---- - -## insiders - -Displays 15 latest insider transactions for given stock - -```format -/insiders -``` - -**ticker** - -- The symbol/ticker of the stock you want to query - -**Examples** - -``` -/insiders AMD -``` - ---- - -## instholdings - -> Displays top 15 Institutional Holdings for given stock - -```format -/instholdings -``` - -**ticker** - -- The symbol/ticker of the stock you want to query - -**Examples** - -``` -/instholdings AMD -``` - ---- - -## financials - -> Gives Total Assets, Cash, Debt, Liabilities, Rev for Company - -```format -/financials -``` - -**ticker** - -- The symbol/ticker of the stock you want to query - -**Examples** - -``` -/financials AMD -``` - ---- - -## divinfo - -> Display dividend information for a stock. - -```format -/divinfo -``` - -**ticker** - -- The symbol/ticker of the stock you want to query - -**Examples** - -``` -/divinfo AAPL -``` - ---- - -## ytd - -> Displays Period Performance for a stock - -```format -/ytd -``` - -**ticker** - -- The symbol/ticker of the stock you want to query - -**Examples** - -``` -/ytd AAPL -``` diff --git a/website/content/bot/reference/telegram/economy.mdx b/website/content/bot/reference/telegram/economy.mdx deleted file mode 100644 index 182caaec7050..000000000000 --- a/website/content/bot/reference/telegram/economy.mdx +++ /dev/null @@ -1,119 +0,0 @@ ---- -title: Economy -description: calendar, currencies, indices, commodities... -premium: false -commands: - - "/calendar" - - "/currencies" - - "/indices" - - "/commodities" - - "/bonds" - - "/fedrates" - - "/yieldcurve" ---- - -# Economy - -## calendar - -> Displays Economic Calendar of events - -```format -/calendar -``` - ---- - -## currencies - -> Create an alert with conditions for a symbol - -```format -/currencies -``` - ---- - -## indices - -> US indices overview - -```format -/indices -``` - ---- - -## commodities - -> Futures and commodities overview. - -```format -/commodities -``` - ---- - -## bonds - -> Global bonds overview. - -```format -/bonds -``` - -**market** - -- The market to get bonds for - us (US bonds) or gl (Global) - -**Examples** - -``` -/bonds us -``` - -``` -/bonds gl -``` - ---- - -## revrepo - -> Displays Reverse Repo. - -```format -/revrepo [] -``` - -**[days]** - _optional_ -- The number of days to display. Default : 50 - -**Examples** - -``` -/revrepo days:35 -``` - -``` -/revrepo -``` - ---- - -## fedrates - -> Upcoming Federal Rate decision dates and chances - -```format -/fedrates -``` - ---- - -## yieldcurve - -> Displays US Bonds yield curve - -```format -/yieldcurve -``` diff --git a/website/content/bot/reference/telegram/economy/index.md b/website/content/bot/reference/telegram/economy/index.md new file mode 100644 index 000000000000..abfb8644f167 --- /dev/null +++ b/website/content/bot/reference/telegram/economy/index.md @@ -0,0 +1,11 @@ +# economy + +- [bonds](/bot/reference/telegram/economy/bonds) +- [calendar](/bot/reference/telegram/economy/calendar) +- [commodities](/bot/reference/telegram/economy/commodities) +- [currencies](/bot/reference/telegram/economy/currencies) +- [fedrates](/bot/reference/telegram/economy/fedrates) +- [futures](/bot/reference/telegram/economy/futures) +- [indices](/bot/reference/telegram/economy/indices) +- [revrepo](/bot/reference/telegram/economy/revrepo) +- [yieldcurve](/bot/reference/telegram/economy/yieldcurve) diff --git a/website/content/bot/reference/telegram/etf/index.md b/website/content/bot/reference/telegram/etf/index.md new file mode 100644 index 000000000000..bf6d2566d01a --- /dev/null +++ b/website/content/bot/reference/telegram/etf/index.md @@ -0,0 +1,4 @@ +# etf + +- [holdings](/bot/reference/telegram/etf/holdings) +- [tops](/bot/reference/telegram/etf/tops) diff --git a/website/content/bot/reference/telegram/etfs.mdx b/website/content/bot/reference/telegram/etfs.mdx deleted file mode 100644 index 922e93b6b2fd..000000000000 --- a/website/content/bot/reference/telegram/etfs.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: ETFs -description: top etfs, etf holdings -premium: false -commands: - - "/etf" ---- - -# ETFs - -## tops/holdings - -> Displays ETF's Top Gainers/Decliners, Most Active or get holdings data for an ETF. - -```format -/etf tops -/etf holdings -``` - -**sort** -- Sort by Top Gainers, Top Decliners, or Most Active - -**ticker** -- Ticker to get holdings data for - -**Examples** - -``` -/etf holdings SPY -``` - -``` -/etf tops -``` diff --git a/website/content/bot/reference/telegram/flow.mdx b/website/content/bot/reference/telegram/flow.mdx deleted file mode 100644 index 3abe06ac0483..000000000000 --- a/website/content/bot/reference/telegram/flow.mdx +++ /dev/null @@ -1,184 +0,0 @@ ---- -title: Flow -description: flow, unusual, bigflow, summary... -premium: true -commands: - - "/flow" - - "/unu" - - "/bigflow" - - "/summary" - - "/sectors" - - "/sumexp" - - "/sumweek" - - "/sumday" - - "/sumtop" ---- - -# Flow - -## flow - -> Returns the most recent for a stock - -```format -/flow [subcmd] [expiry] [strike] [opt_type] -``` - -**[subcmd]** - _optional_ - -- Possible subcommands to run. If not provided, defaults to daily flow - - wk: Weekly flow by Premium for a stock with weekly expiration - - open: Flow by Premium for a stock with opening condition - Vol > OI - - unu: Unusual Options Trades over 100k Prem. - Vol > OI - - prem: Chart with sum of premium per day by call/put - -**ticker** -- Ticker symbol you want to lookup - -**[expiry]** - _optional_ - -- Filter last flow for the provided expiration date that happened today - YYYY-MM-DD format - -**[strike]** - _optional_ - -- Filter on the strike for flow - - -**[opt_type]** - _optional_ - -- Filter on option type - Can be "C" - Calls or "P" - Puts - -Examples - -``` -/flow AMD -``` - -``` -/flow wk AMD -``` - -``` -/flow prem AMD -``` - ---- - -## unu - -> Unusual Options Trades over 100k Prem. - Vol > OI - -```format -/unu -``` - ---- - -## bigflow - -> Returns the top 20 largest by premium for a stock - -```format -/bigflow -``` - -**ticker** -- Ticker symbol you want to lookup - -Examples - -``` -/bigflow AMD -``` - ---- - -## summary - -> Summary of all by % of MarketCap - -```format -/summaryflow -``` - -**days** -- The number of days to look back - -**sort** -- Field to sort by - Can be : MarketCap, Float, Total, Short Percentage - -Examples - -``` -/summaryflow 1 float -``` - -``` -/summaryflow 1 sum -``` - ---- - -## sectorsflow - -> Summary of all by % of MarketCap by Sector - -``` -/sectorsflow -``` - -**days** -- The number of days to look back - -**sector** -- Sector to filter by - Basic Materials (bm) | Energy (e) | Communication Services (cs) | Consumer Cyclical (cs) | Consumer Defensive (cd) | Financial (f) | Healthcare (h) | Industrials (i) | Real Estate (re) | Technology (t) | Utilities (u) - -Examples - -``` -/sectorsflow 5 cs -``` - -``` -/sectorsflow 5 bm -``` - ---- - -## flowsum - -> Graph Today's Total Premium of a stock. - -```format -/flowsum [subcmd] -``` - -**[subcmd]** - _optional_ - -- Possible subcommands, if not provided, defaults to daily sum - wk: Weekly flow by Premium for a stock with weekly expiration - exp: Flow summary by expiration date - top: Top flow for the day Calls vs Puts by stock - -**ticker** -- The ticker/symbol to look up - -**expiry** -- Expiration date - Only available/required for exp - -Examples - -``` -/flowsum AMD -``` - -``` -/flowsum wk AMD -``` - -``` -/flowsum top AMD -``` - -``` -/flowsum exp AMD 2022-07-29 -``` diff --git a/website/content/bot/reference/telegram/flow/flow/index.md b/website/content/bot/reference/telegram/flow/flow/index.md new file mode 100644 index 000000000000..1869f238c40f --- /dev/null +++ b/website/content/bot/reference/telegram/flow/flow/index.md @@ -0,0 +1,16 @@ +# flow + +- [bigflow](/bot/reference/telegram/flow/bigflow) +- [day](/bot/reference/telegram/flow/flow/day) +- [open](/bot/reference/telegram/flow/flow/open) +- [prem](/bot/reference/telegram/flow/flow/prem) +- [unu](/bot/reference/telegram/flow/flow/unu) +- [wk](/bot/reference/telegram/flow/flow/wk) + +### flowsum +- [day](/bot/reference/telegram/flow/flowsum/day) +- [exp](/bot/reference/telegram/flow/flowsum/exp) +- [top](/bot/reference/telegram/flow/flowsum/top) +- [wk](/bot/reference/telegram/flow/flowsum/wk) +- [sectorsflow](/bot/reference/telegram/flow/sectorsflow) +- [summaryflow](/bot/reference/telegram/flow/summaryflow) diff --git a/website/content/bot/reference/telegram/flow/flowsum/index.md b/website/content/bot/reference/telegram/flow/flowsum/index.md new file mode 100644 index 000000000000..0e9c2b6827cb --- /dev/null +++ b/website/content/bot/reference/telegram/flow/flowsum/index.md @@ -0,0 +1,6 @@ +# flowsum + +- [day](/bot/reference/telegram/flowsum/day) +- [exp](/bot/reference/telegram/flowsum/exp) +- [top](/bot/reference/telegram/flowsum/top) +- [wk](/bot/reference/telegram/flowsum/wk) diff --git a/website/content/bot/reference/telegram/flow/index.md b/website/content/bot/reference/telegram/flow/index.md new file mode 100644 index 000000000000..1869f238c40f --- /dev/null +++ b/website/content/bot/reference/telegram/flow/index.md @@ -0,0 +1,16 @@ +# flow + +- [bigflow](/bot/reference/telegram/flow/bigflow) +- [day](/bot/reference/telegram/flow/flow/day) +- [open](/bot/reference/telegram/flow/flow/open) +- [prem](/bot/reference/telegram/flow/flow/prem) +- [unu](/bot/reference/telegram/flow/flow/unu) +- [wk](/bot/reference/telegram/flow/flow/wk) + +### flowsum +- [day](/bot/reference/telegram/flow/flowsum/day) +- [exp](/bot/reference/telegram/flow/flowsum/exp) +- [top](/bot/reference/telegram/flow/flowsum/top) +- [wk](/bot/reference/telegram/flow/flowsum/wk) +- [sectorsflow](/bot/reference/telegram/flow/sectorsflow) +- [summaryflow](/bot/reference/telegram/flow/summaryflow) diff --git a/website/content/bot/reference/telegram/fun.mdx b/website/content/bot/reference/telegram/fun.mdx deleted file mode 100644 index 9245966b3732..000000000000 --- a/website/content/bot/reference/telegram/fun.mdx +++ /dev/null @@ -1,62 +0,0 @@ ---- -title: Fun -description: 8ball, flip, urban -premium: false -commands: - - "/8ball" - - "/flip" - - "/urban" - ---- - -# Fun - -## 8ball - -> Ask 8ball a question - -```format -/8ball -``` - -**question** -- Make sure its in the form of a question - -**Examples** - -``` -/8ball Will I make money today? -``` ---- - -## flip - -> Flip a coin for your Witcher! - -```format -/flip -``` - -**Examples** - -``` -/flip -``` ---- -## Urban - -> Look up a word in the urban dictionary - be careful - -```format -/urban -``` - -**word** -- enjoy the lookup - -**Examples** - -``` -/urban Shill -``` ---- diff --git a/website/content/bot/reference/telegram/fun/index.md b/website/content/bot/reference/telegram/fun/index.md new file mode 100644 index 000000000000..159ebbca6120 --- /dev/null +++ b/website/content/bot/reference/telegram/fun/index.md @@ -0,0 +1,5 @@ +# fun + +- [8ball](/bot/reference/telegram/fun/8ball) +- [flip](/bot/reference/telegram/fun/flip) +- [urban](/bot/reference/telegram/fun/urban) diff --git a/website/content/bot/reference/telegram/general.mdx b/website/content/bot/reference/telegram/general.mdx deleted file mode 100644 index cb64cbaed731..000000000000 --- a/website/content/bot/reference/telegram/general.mdx +++ /dev/null @@ -1,182 +0,0 @@ ---- -title: General -description: watchlist, markets, news, quote, futures, ta, pop -premium: false -commands: - - "/watchlist" - - "/news" - - "/markets" - - "/quote" - - "/futures" - - "/ta" - - "/heatmap" - - "/heatchart" - - "/pop" ---- - -# General - -## watchlist - -> Display the tickers in your watchlist - Registered users get 3 for free! - -```format -/watchlist -``` - -**_add** - _optional_ -- How to add more tickers to your watchlist - -**_remove** - _optional_ -- If you want to remove symbols - -**Examples** - -``` -/watchlist -``` -``` -/watchlist_add AMD,GOOG,TSLA -``` -``` -/watchlist_remove -``` - -## news - -> Display the most recent news for ticker - -```format -/news -``` - -**ticker** -- The symbol/ticker/coin of the stock/coin you want to query - -**Examples** - -``` -/news AMD -``` - ---- - -## markets - -> Displays an overview of the market with adv / decliners relative to change and 50d/200d MA - -```format -/markets -``` - -**Examples** - -``` -/markets -``` - ---- - -## quote - -> Displays ticker quote info. - -```format -/quote -``` - -**ticker** -- The symbol/ticker/coin of the stock/coin you want to query - -**Examples** - -``` -/quote AMD -``` - ---- - -## futures - -> Displays Futures. - -```format -/futures -``` - ---- - -## ta - -> Displays a given stocks Technical Analysis summary. - -```format -/ta -``` - -**ticker** -- The symbol/ticker/coin of the stock/coin you want to query - -**Examples** - -``` -/ta AMD -``` - ---- - -## heatmap - -> Daily Heat Maps by Market. Sector is optional. - -```format -/heatmap -``` - -**market** -- Market to filter by. (sp500, dow30, nasdaq, crypto, russel) -**sector** -- Sector to filter by. If not specified, all sectors are returned. (TODO : list sectors here) - -**Examples** - -``` -/heatmap sp500 -/heatmap sp500 services -``` - ---- - -## heatchart - -> Daily Market Heat Chart - 15m Delayed - -```format -/heatchart -``` - -**Examples** - -``` -/heatchart -``` -## pop - -> Display the most popular tickers over the last hour or day run on the bot - -```format -/pop -``` - -**interval** - -The interval you want to see the most popular commands for - 1d, 1h - -**Examples** - -``` -/pop 1d -``` - -``` -/pop 1h -``` diff --git a/website/content/bot/reference/telegram/general/index.md b/website/content/bot/reference/telegram/general/index.md new file mode 100644 index 000000000000..a8ec62a6463c --- /dev/null +++ b/website/content/bot/reference/telegram/general/index.md @@ -0,0 +1,5 @@ +# general + +- [news](/bot/reference/telegram/general/news) +- [quote](/bot/reference/telegram/general/quote) +- [ta](/bot/reference/telegram/general/ta) diff --git a/website/content/bot/reference/telegram/government.mdx b/website/content/bot/reference/telegram/government.mdx deleted file mode 100644 index 89aae552069f..000000000000 --- a/website/content/bot/reference/telegram/government.mdx +++ /dev/null @@ -1,66 +0,0 @@ ---- -title: Government -description: contracts, house, senate -premium: false -commands: - - "/contracts" - - "/house" - - "/senate" ---- - -# Government - -## contracts - -> Displays Top 15 Government contracts by amount for all tickers or for a specific ticker. - -```format -/contracts -``` - -**ticker** -- The symbol of the stock you want to query - -**Examples** - -``` -/contracts GE -``` - ---- - -## house - -> Displays recent house trades for all tickers or a specific ticker. - -```format -/house -``` - -**ticker** -- The symbol of the stock you want to query - -**Examples** - -``` -/house GE -``` - ----- - -## senate - -> Displays recent senate trades for all tickers or for a specific ticker - -```format -/senate -``` - -**ticker** -- The symbol of the stock you want to query - -**Examples** - -``` -/senate GE -``` diff --git a/website/content/bot/reference/telegram/government/index.md b/website/content/bot/reference/telegram/government/index.md new file mode 100644 index 000000000000..e50fbab2ccd9 --- /dev/null +++ b/website/content/bot/reference/telegram/government/index.md @@ -0,0 +1,5 @@ +# government + +- [contracts](/bot/reference/telegram/government/contracts) +- [house](/bot/reference/telegram/government/house) +- [senate](/bot/reference/telegram/government/senate) diff --git a/website/content/bot/reference/telegram/info.mdx b/website/content/bot/reference/telegram/info.mdx deleted file mode 100644 index 6acf449cc5d6..000000000000 --- a/website/content/bot/reference/telegram/info.mdx +++ /dev/null @@ -1,28 +0,0 @@ ---- -title: Info -description: help, about -premium: false -commands: - - "/help" - - "/about" ---- - -# Info - -## help - -> List of commands for OpenBB Bot. - -```format -/help -``` - ---- - -## about - -> About OpenBB Terminal - -```format -/about -``` diff --git a/website/content/bot/reference/telegram/info/index.md b/website/content/bot/reference/telegram/info/index.md new file mode 100644 index 000000000000..4eda94e3f78b --- /dev/null +++ b/website/content/bot/reference/telegram/info/index.md @@ -0,0 +1,5 @@ +# info + +- [about](/bot/reference/telegram/info/about) +- [serverid](/bot/reference/telegram/info/serverid) +- [start](/bot/reference/telegram/info/start) diff --git a/website/content/bot/reference/telegram/nft.mdx b/website/content/bot/reference/telegram/nft.mdx deleted file mode 100644 index c0cb7f38ab6e..000000000000 --- a/website/content/bot/reference/telegram/nft.mdx +++ /dev/null @@ -1,72 +0,0 @@ ---- -title: NFT -description: top, collection... -premium: false -commands: - - "/nfttop" - - "/nftcollection" ---- - -# NFT - -## top - -> Get Top NFT Collections from Ethereum - -```format -/nft top [sortby] [interval] [reverse] -``` - -**[sortby]** - _optional_ - -- Column to sort by (default: Market Cap) - can be one of : Market Cap/ Floor Price Change / Volume / Sales - -**[interval]** - _optional_ - -- Time interval to display Sales/Volume/Floor Price (default: 1d) - can be one of : 1d / 7d / 30d / 90d - -**[reverse]** - _optional_ - -- Reverse the sort order (default: No) - Yes/No - -**Examples** - -``` -/nfttop -``` - -``` -/nfttop mc y -``` - ---- - -## collection - -> Get NFT collection data from Ethereum network for the specified slug. Returns ranking, price info, supply, and much more. - -```format -/nftcollection -``` - -**slug** - -- The nft you want the collection info for - -**chart** -optional- - -- returns a chart for the selected nft - can also use y/yes/chart/true - -**Examples** - -``` -/nftcollection bent -``` - -``` -/nftcollection bent chart -``` - -``` -/nftcollection bent y -``` diff --git a/website/content/bot/reference/telegram/nft/index.md b/website/content/bot/reference/telegram/nft/index.md new file mode 100644 index 000000000000..eb5033c91267 --- /dev/null +++ b/website/content/bot/reference/telegram/nft/index.md @@ -0,0 +1,4 @@ +# nft + +- [nftcollection](/bot/reference/telegram/nft/nftcollection) +- [nfttop](/bot/reference/telegram/nft/nfttop) diff --git a/website/content/bot/reference/telegram/options.mdx b/website/content/bot/reference/telegram/options.mdx deleted file mode 100644 index 0bf88feee0c7..000000000000 --- a/website/content/bot/reference/telegram/options.mdx +++ /dev/null @@ -1,437 +0,0 @@ ---- -title: Options -description: gamma, iv, topoi, unu, vol, hist, oi, mp... -premium: true -commands: - - "/gamma" - - "/iv" - - "/topoi" - - "/unu" - - "/vol" - - "/hist" - - "/uoastock" - - "/highiv" - - "/topvol" - - "/topvoletf" - - "/topoichange" - - "/oi" - - "/stats" - - "/mp" - - "/smile" - - "/vsurf" - - "/chains" ---- - -# Options - -## itm - -> Displays In-The-Money (ITM) options by expiry for a stock. - -```format -/itm -``` - -**ticker** -- The ticker/symbol to look up - -Examples - -``` -/itm AMD -``` - ---- - -## equitypc - -> Displays the Equity Put/Call Volume Ratio - from market-harmonics.com - -```format -/equitypc -``` - ---- - -## indexpc - -> Displays the Index Put/Call Ratio for the market - from market-harmonics.com - -```format -/indexpc -``` - ---- - -## oichart - -> Charts Total Open Interest by Strike Price. - -```format -/oichart [] -``` - -**ticker** -- The ticker/symbol to look up - -**[expiry]** - _optional_ -- The ticker/symbol to look up - -Examples - -``` -/oichart AMD -``` - -``` -/oichart AMD 2022-07-29 -``` - ---- - -## gamma - -> Displays Options Gamma Levels for a Stock. - -```format -/gamma [] -``` - -**ticker** -- The ticker/symbol to look up - -**[expiry]** - _optional_ -- Gamma from now to expiration - -Examples - -``` -/gamma AMD -``` - -``` -/gamma AMD 2022-07-29 -``` - ---- - -## iv - -> Displays option information (volatility, IV rank etc). - -```format -/iv -``` - -**ticker** -- The ticker/symbol to look up - -Examples - -``` -/iv AMD -``` - ---- - -## topoi - -> Displays TOpen Interest - -```format -/topoi -``` - ---- - -## unu - -> Shows Unusual Options - -```format -/unu -``` - ---- - -## vol - -> Displays Options Strike Volume can add EXP date for bigger breakdown - -```format -/vol [] -``` - -**ticker** -- The ticker/symbol to look up - -**expiry** - _optional_ -- Expiration to query - -Examples - -``` -/vol AMD -``` - -``` -/vol AMD 2022-07-29 -``` - ---- - -## hist - -> Displays Options Price History in a chart. - -``` -/hist [] -``` - -**ticker** -- The ticker/symbol to look up - -**expiry** -- Expiration to query - -**strike** -- Option Strike Price - -**opt_type** -- Calls or Puts Calls | Puts - -**interval** -- Chart Minute Interval | 1440 for Daily 5 | 15 | 30 - -**[past_days]** - _optional_ -- Past Days to Display. Default: 5 - -Examples - -``` -/hist AMD 2022-07-29 18 Calls 5 5 -``` - -``` -/hist AMD 2022-07-29 18 Calls 5 -``` - ---- - -## uoastock - -> Display T20day Average Options Volume by ticker. - -```format -/uoastock [] -``` - -**[price]** - _optional_ -- Filter by stocks over a certain price - -Examples - -``` -/uoastock -``` - -``` -/uoastock 50 -``` - ---- - -## highiv - -> T15 Highest IV30 Equity stocks. - -```format -/highiv -``` - ---- - -## topvol - -> T15 Highest options volume. - -```format -/topvol -``` - ---- - -## topvoletf - -> T15 Highest options volume ETF. - -``` -/topvoletf -``` - ---- - -## topoichange - -> Displays T15 stocks with highest OI Change. - -```format -/topoichange -``` - ---- - -## oi - -> Displays OI and call/put ratio for given stock - can add EXP date too for bigger breakdown - -```format -/oi [] -``` - -**ticker** -- The ticker/symbol to look up - -**[expiry]** - _optional_ -- Expiration to query - -Examples - -``` -/oi AMC -``` - -``` -/oi AMC 2022-07-29 -``` - ---- - -## stats - -> Displays Options Statistics for a stock. - -```format -/stats -``` - -**ticker** -- The ticker/symbol to look up - -Examples - -``` -/stats AMC -``` - ---- - -## maxpain - -> Displays the Max Pain on expiration date for a given stock. - -```format -/maxpain -``` - -**ticker** -- The ticker/symbol to look up - -**expiry** -- Expiration to query - -Examples - -``` -/maxpain AMC 2022-07-29 -``` - ---- - -## chains - -> Displays Options Chain by Expiry - -```format -/chains [] [] -``` - -**ticker** -- The ticker/symbol to look up - -**expiry** -- Expiration to query - -**opt_type** -- Calls or Puts - -**[min_sp]** - _optional_ -- Minimum Strike Price - -**[max_sp]** - _optional_ -- Maximum Strike Price - -Examples - -``` -/chains AMD 2022-08-05 Calls -``` -``` -/chains AMD 2022-08-05 Calls 10 100 -``` - ---- - -## vsurf - -> Displays Options Volatility Surface - -```format -/vsurf -``` - -**ticker** -- The ticker/symbol to look up - -**z** -- Variable for the Z axis (Volatility (v), Open Interest (oi), Last Price (lp)) - -Examples - -``` -/vsurf AMD v -``` -``` -/vsurf AMD oi -``` - ---- - -## smile - -> Displays Options Volatility Smile - -```format -/smile [] [] -``` - -**ticker** -- The ticker/symbol to look up - -**expiry** -- Expiration to query - -**[min_sp]** - _optional_ -- Minimum Strike price - -**[max_sp]** - _optional_ -- Maximum Strike Price - -Examples - -``` -/smile AMD 2022-08-19 -``` -``` -/smile AMD 2022-08-19 10 100 -``` diff --git a/website/content/bot/reference/telegram/options/index.md b/website/content/bot/reference/telegram/options/index.md new file mode 100644 index 000000000000..24747dcefd93 --- /dev/null +++ b/website/content/bot/reference/telegram/options/index.md @@ -0,0 +1,24 @@ +# options + +- [chains](/bot/reference/telegram/options/chains) +- [equitypc](/bot/reference/telegram/options/equitypc) +- [gamma](/bot/reference/telegram/options/gamma) +- [highiv](/bot/reference/telegram/options/highiv) +- [hist](/bot/reference/telegram/options/hist) +- [indexpc](/bot/reference/telegram/options/indexpc) +- [itm](/bot/reference/telegram/options/itm) +- [iv](/bot/reference/telegram/options/iv) +- [maxpain](/bot/reference/telegram/options/maxpain) +- [oi](/bot/reference/telegram/options/oi) +- [oichart](/bot/reference/telegram/options/oichart) +- [opstats](/bot/reference/telegram/options/opstats) +- [smile](/bot/reference/telegram/options/smile) +- [topoi](/bot/reference/telegram/options/topoi) +- [topoichange](/bot/reference/telegram/options/topoichange) +- [topstrikevol](/bot/reference/telegram/options/topstrikevol) +- [topvol](/bot/reference/telegram/options/topvol) +- [topvoletf](/bot/reference/telegram/options/topvoletf) +- [unu](/bot/reference/telegram/options/unu) +- [uoastock](/bot/reference/telegram/options/uoastock) +- [vol](/bot/reference/telegram/options/vol) +- [vsurf](/bot/reference/telegram/options/vsurf) diff --git a/website/content/bot/reference/telegram/overview/index.md b/website/content/bot/reference/telegram/overview/index.md new file mode 100644 index 000000000000..89260bce0700 --- /dev/null +++ b/website/content/bot/reference/telegram/overview/index.md @@ -0,0 +1,8 @@ +# overview + +- [heatchart](/bot/reference/telegram/overview/heatchart) +- [heatmap](/bot/reference/telegram/overview/heatmap) +- [markets](/bot/reference/telegram/overview/markets) +- [watchlist](/bot/reference/telegram/overview/watchlist) +- [watchlist_add](/bot/reference/telegram/overview/watchlist_add) +- [watchlist_remove](/bot/reference/telegram/overview/watchlist_remove) diff --git a/website/content/bot/reference/telegram/screeners.mdx b/website/content/bot/reference/telegram/screeners.mdx deleted file mode 100644 index 66af6237b94b..000000000000 --- a/website/content/bot/reference/telegram/screeners.mdx +++ /dev/null @@ -1,52 +0,0 @@ ---- -title: Screeners -description: screener, scr -premium: false -commands: - - "/screener" - - "/scr" ---- - -# Screeners - -## screener - -> Displays stock screener results according to chosen signal. - -```format -/scr technical -``` - -**signal** (TODO : find these numbers) -- Screener presets - Top Gainers | Top Losers | Most Active | Most Volatile | Relative Volatility | Golden Cross | Death Cross | New 52week High | New 52week Low | Unusual Volume - -**Examples** - -``` -/screener 0 -``` -``` -/screener 4 -``` - ---- - -## all - -> Displays all available screeners - -```format -/scr - _optional_ -``` -**subcmd** -- Screener preset valid options are - pm | ah (default is all) - -**Examples** - -``` -/scr pm -``` - -``` -/scr pm -``` diff --git a/website/content/bot/reference/telegram/screeners/index.md b/website/content/bot/reference/telegram/screeners/index.md new file mode 100644 index 000000000000..2fdcfaa05366 --- /dev/null +++ b/website/content/bot/reference/telegram/screeners/index.md @@ -0,0 +1,8 @@ +# screeners + + +### scr +- [ah](/bot/reference/telegram/screener/scr/ah) +- [all](/bot/reference/telegram/screener/scr/all) +- [pm](/bot/reference/telegram/screener/scr/pm) +- [screener](/bot/reference/telegram/screener/screener) diff --git a/website/content/bot/reference/telegram/screeners/scr/index.md b/website/content/bot/reference/telegram/screeners/scr/index.md new file mode 100644 index 000000000000..f21e6e499f5d --- /dev/null +++ b/website/content/bot/reference/telegram/screeners/scr/index.md @@ -0,0 +1,5 @@ +# scr + +- [ah](/bot/reference/telegram/screener/scr/ah) +- [all](/bot/reference/telegram/screener/scr/all) +- [pm](/bot/reference/telegram/screener/scr/pm) diff --git a/website/content/bot/reference/telegram/short_data.mdx b/website/content/bot/reference/telegram/short_data.mdx deleted file mode 100644 index 4cf27a2a077b..000000000000 --- a/website/content/bot/reference/telegram/short_data.mdx +++ /dev/null @@ -1,101 +0,0 @@ ---- -title: Shorts -description: shotvol, shortint, topshortvol, hsi... -premium: false -commands: - - "/shortvol" - - "/shortint (TODO FIND ME)" - - "/topshortvol" - - "/hsi" - - "/shortrate" - - "/borrowed" ---- - -# Shorts - -## sh - -> Graph of 30 day history of short volume vs vol. - -```format -/shortvol -``` - -**ticker** -- The symbol/ticker of the stock you want the short interest for - -**Examples** - -``` -/shortvol AMD -``` - ---- - -## borrowed - -> Displays history of borrowed shares available and fee. - -```format -/borrowed -``` - -**ticker** -- The symbol/ticker of the stock you want the short interest for - -**Examples** - -``` -/borrowed AMD -``` - ---- - -## shortrate - -> Display Short shares spot borrow rate sourced from Interactive Brokers. - -```format -/shortrate -``` - -**ticker** -- The symbol/ticker of the stock you want the short interest for - -**Examples** - -``` -/shortrate AMD -``` - ---- - -## topshortvol - -> Top 15 Short Interest Stocks per Finra - -```format -/topshortvol -``` - ---- - -## hsi - -> Show top high short interest stocks of over 20% ratio - -``` -/hsi [] -``` - -**[num]** - _optional_ -- The number of stocks to print - -Examples - -``` -/hsi -``` -``` -/hsi 4 -``` diff --git a/website/content/bot/reference/telegram/short_data/index.md b/website/content/bot/reference/telegram/short_data/index.md new file mode 100644 index 000000000000..77a4af18b4f5 --- /dev/null +++ b/website/content/bot/reference/telegram/short_data/index.md @@ -0,0 +1,7 @@ +# shorts + +- [borrowed](/bot/reference/telegram/shorts/borrowed) +- [hsi](/bot/reference/telegram/shorts/hsi) +- [shortrate](/bot/reference/telegram/shorts/shortrate) +- [shortvol](/bot/reference/telegram/shorts/shortvol) +- [topshortvol](/bot/reference/telegram/shorts/topshortvol) diff --git a/website/content/sdk/changelog/_category_.json b/website/content/sdk/changelog/_category_.json deleted file mode 100644 index dd4aac394c8e..000000000000 --- a/website/content/sdk/changelog/_category_.json +++ /dev/null @@ -1,4 +0,0 @@ -{ - "label": "Changelog", - "position": 5 -} diff --git a/website/content/sdk/changelog/version1_0_0.mdx b/website/content/sdk/changelog/version1_0_0.mdx deleted file mode 100644 index 23a3448455b4..000000000000 --- a/website/content/sdk/changelog/version1_0_0.mdx +++ /dev/null @@ -1,21 +0,0 @@ ---- -title: Version 1.0.0 -version: "1.0.0" -date: 2022-08-03 -description: Version 1.0.0 ---- - -## Added - -- bullet 1 -- bullet 2 - -## Changed - -- bullet 1 -- bullet 2 - -## Fixed - -- bullet 1 -- bullet 2 diff --git a/website/content/sdk/changelog/version2_0_0.mdx b/website/content/sdk/changelog/version2_0_0.mdx deleted file mode 100644 index 7e95cb4e5f98..000000000000 --- a/website/content/sdk/changelog/version2_0_0.mdx +++ /dev/null @@ -1,22 +0,0 @@ ---- -title: Current - Version 2.0.0 -version: "2.0.0" -date: 2022-10-26 -description: Version 2.0.0 -sidebar_position: 0 ---- - -## Added - -- bullet 1 -- bullet 2 - -## Changed - -- bullet 1 -- bullet 2 - -## Fixed - -- bullet 1 -- bullet 2 diff --git a/website/content/sdk/faqs/troubleshooting.md b/website/content/sdk/faqs/troubleshooting.md deleted file mode 100644 index 51566d915eb2..000000000000 --- a/website/content/sdk/faqs/troubleshooting.md +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: General Troubleshooting -sidebar_position: 5 -description: TBD -keywords: - [ - installation, - installer, - install, - guide, - mac, - windows, - linux, - python, - github, - macos, - how to, - explanation, - openbb terminal, - ] ---- - -## General Troubleshooting - -Both Windows and MacOS provide a "developer mode", and enabling it may help. - -**MacOS**: Go to the System Settings, and under the "Privacy and Security" tab, scroll to the bottom and select the option to "Allow applications downloaded from App Store and identified developers". Then, scroll up to click on, "Developer Tools", and add `Terminal.app` and `Visual Studio Code` (or the preferred code editor) to the list of applications allowed to run software locally that does not meet the system's security policy. - -**Windows**: Go to the Control Panel, and under the "Privacy & Security" tab, click on, "For developers". Under this menu, turn "Developer Mode" on. - -From the Windows Security menu, click on the Firewall & Network Protection tab, then click on "Allow an app through firewall". If the applications below are not allowed to communicate through Windows Defender Firewall, change the settings to allow. - -- BranchCache -- Hyper-V -- VcXsrv -- Windows Terminal - -
Why does a specific menu or command not exist? - -It could be that you are running an outdated version in which the menu or command is not yet available. Please check the [installation guide](https://docs.openbb.co/terminal/quickstart/installation) to download the most recent release. - -Do note that it is also possible that the menu or command has been deprecated. If this is oversight, please reach out to us [here](https://openbb.co/support). - -
diff --git a/website/content/terminal/changelog/version1_0_0.mdx b/website/content/terminal/changelog/version1_0_0.mdx deleted file mode 100644 index 23a3448455b4..000000000000 --- a/website/content/terminal/changelog/version1_0_0.mdx +++ /dev/null @@ -1,21 +0,0 @@ ---- -title: Version 1.0.0 -version: "1.0.0" -date: 2022-08-03 -description: Version 1.0.0 ---- - -## Added - -- bullet 1 -- bullet 2 - -## Changed - -- bullet 1 -- bullet 2 - -## Fixed - -- bullet 1 -- bullet 2 diff --git a/website/src/theme/CodeBlock/Content/String.js b/website/src/theme/CodeBlock/Content/String.js index 2b0ed9f41156..c143af0fdb38 100644 --- a/website/src/theme/CodeBlock/Content/String.js +++ b/website/src/theme/CodeBlock/Content/String.js @@ -11,7 +11,6 @@ import { import Highlight, { defaultProps } from "prism-react-renderer"; import Line from "@theme/CodeBlock/Line"; import CopyButton from "@theme/CodeBlock/CopyButton"; -import PlayButton from "@site/src/components/General/PlayButton"; import WordWrapButton from "@theme/CodeBlock/WordWrapButton"; import Container from "@theme/CodeBlock/Container"; import styles from "./styles.module.css";