mirror of
https://github.com/OpenBB-finance/OpenBB.git
synced 2026-10-28 04:52:07 +00:00
fix docs (#5646)
This commit is contained in:
Andrew
27
website/content/bot/reference/discord/alerts/index.mdx
vendored
Normal file
27
website/content/bot/reference/discord/alerts/index.mdx
vendored
Normal file
@@ -0,0 +1,27 @@
|
||||
# alerts
|
||||
|
||||
import ReferenceCard from "@site/src/components/General/ReferenceCard";
|
||||
|
||||
<ul className="grid grid-cols-1 md:grid-cols-2 lg:grid-cols-3 xl:grid-cols-4 gap-4 -ml-6">
|
||||
|
||||
<ReferenceCard
|
||||
title="create"
|
||||
description="This command creates an alert for a given symbol (ex. BTCUSD) that will notify the user when the price is equal..."
|
||||
url="/bot/reference/discord/alerts/create"
|
||||
/>
|
||||
<ReferenceCard
|
||||
title="delete"
|
||||
description="This command allows the user to delete an active alert they have set."
|
||||
url="/bot/reference/discord/alerts/delete"
|
||||
/>
|
||||
<ReferenceCard
|
||||
title="list"
|
||||
description="This command allows the user to view a list of all their active alerts. It displays each alert along with its..."
|
||||
url="/bot/reference/discord/alerts/list"
|
||||
/>
|
||||
<ReferenceCard
|
||||
title="update"
|
||||
description="This command allows the user to update the condition on an active alert, such as changing the value of a price..."
|
||||
url="/bot/reference/discord/alerts/update"
|
||||
/>
|
||||
</ul>
|
||||
22
website/content/bot/reference/discord/autopost/index.mdx
vendored
Normal file
22
website/content/bot/reference/discord/autopost/index.mdx
vendored
Normal file
@@ -0,0 +1,22 @@
|
||||
# autopost
|
||||
|
||||
import ReferenceCard from "@site/src/components/General/ReferenceCard";
|
||||
|
||||
<ul className="grid grid-cols-1 md:grid-cols-2 lg:grid-cols-3 xl:grid-cols-4 gap-4 -ml-6">
|
||||
|
||||
<ReferenceCard
|
||||
title="add"
|
||||
description="This command allows the user to add an autopost command to a channel. It allows the user to receive notifications..."
|
||||
url="/bot/reference/discord/autopost/add"
|
||||
/>
|
||||
<ReferenceCard
|
||||
title="list"
|
||||
description="This command allows users to view all webhook feeds associated with a particular channel that have been set up..."
|
||||
url="/bot/reference/discord/autopost/list"
|
||||
/>
|
||||
<ReferenceCard
|
||||
title="remove"
|
||||
description="This command allows the user to remove an autopost webhook feed from the channel. When executed, it will remove..."
|
||||
url="/bot/reference/discord/autopost/remove"
|
||||
/>
|
||||
</ul>
|
||||
57
website/content/bot/reference/discord/charts/index.mdx
vendored
Normal file
57
website/content/bot/reference/discord/charts/index.mdx
vendored
Normal file
@@ -0,0 +1,57 @@
|
||||
# charts
|
||||
|
||||
import ReferenceCard from "@site/src/components/General/ReferenceCard";
|
||||
|
||||
<ul className="grid grid-cols-1 md:grid-cols-2 lg:grid-cols-3 xl:grid-cols-4 gap-4 -ml-6">
|
||||
|
||||
<ReferenceCard
|
||||
title="c15m"
|
||||
description="This command allows the user to retrieve a 15-minute intraday chart for a given ticker. The chart will show the..."
|
||||
url="/bot/reference/discord/charts/c15m"
|
||||
/>
|
||||
<ReferenceCard
|
||||
title="c3m"
|
||||
description="This command allows users to retrieve a 3-minute intraday chart for the given ticker. This chart will display the..."
|
||||
url="/bot/reference/discord/charts/c3m"
|
||||
/>
|
||||
<ReferenceCard
|
||||
title="c5m"
|
||||
description="This command allows the user to retrieve an intraday 5 minute chart for a given ticker. This chart will display..."
|
||||
url="/bot/reference/discord/charts/c5m"
|
||||
/>
|
||||
<ReferenceCard
|
||||
title="cc"
|
||||
description="This command allows the user to retrieve an intraday 5 minute chart for a given ticker, /c5m also has the same..."
|
||||
url="/bot/reference/discord/charts/cc"
|
||||
/>
|
||||
<ReferenceCard
|
||||
title="cd"
|
||||
description="This command allows the user to retrieve a daily candlestick chart for a particular ticker or coin. The..."
|
||||
url="/bot/reference/discord/charts/cd"
|
||||
/>
|
||||
<ReferenceCard
|
||||
title="chart"
|
||||
description="This command will retrieve a candlestick chart for the ticker/interval provided, with data for the past number of..."
|
||||
url="/bot/reference/discord/charts/chart"
|
||||
/>
|
||||
<ReferenceCard
|
||||
title="chartfib"
|
||||
description="This command allows the user to retrieve Fibonacci levels for a given ticker. This data can be used to identify..."
|
||||
url="/bot/reference/discord/charts/chartfib"
|
||||
/>
|
||||
<ReferenceCard
|
||||
title="chartsr"
|
||||
description="This command allows the user to retrieve Displays Support and Resistance Levels for the ticker provided. It will..."
|
||||
url="/bot/reference/discord/charts/chartsr"
|
||||
/>
|
||||
<ReferenceCard
|
||||
title="cm"
|
||||
description="This command allows you to view a monthly candlestick chart for a given stock or cryptocurrency. The chart..."
|
||||
url="/bot/reference/discord/charts/cm"
|
||||
/>
|
||||
<ReferenceCard
|
||||
title="cw"
|
||||
description="This command allows the user to retrieve a weekly candlestick chart for the ticker/coin provided. The chart..."
|
||||
url="/bot/reference/discord/charts/cw"
|
||||
/>
|
||||
</ul>
|
||||
52
website/content/bot/reference/discord/crypto/index.mdx
vendored
Normal file
52
website/content/bot/reference/discord/crypto/index.mdx
vendored
Normal file
@@ -0,0 +1,52 @@
|
||||
# crypto
|
||||
|
||||
import ReferenceCard from "@site/src/components/General/ReferenceCard";
|
||||
|
||||
<ul className="grid grid-cols-1 md:grid-cols-2 lg:grid-cols-3 xl:grid-cols-4 gap-4 -ml-6">
|
||||
|
||||
<ReferenceCard
|
||||
title="defi"
|
||||
description="chart table"
|
||||
url="/bot/reference/discord/crypto/defi"
|
||||
/>
|
||||
<ReferenceCard
|
||||
title="bigprints"
|
||||
description="This command allows the user to retrieve the last 15 large prints for a given cryptocurrency pair. The command..."
|
||||
url="/bot/reference/discord/crypto/bigprints"
|
||||
/>
|
||||
<ReferenceCard
|
||||
title="bio"
|
||||
description="This command allows the user to retrieve fundamental information about a crypto, such as its current price,..."
|
||||
url="/bot/reference/discord/crypto/bio"
|
||||
/>
|
||||
<ReferenceCard
|
||||
title="compfees"
|
||||
description="This command allows users to retrieve the Protocol fees over time for the given project."
|
||||
url="/bot/reference/discord/crypto/compfees"
|
||||
/>
|
||||
<ReferenceCard
|
||||
title="fees"
|
||||
description="This will provide the user with the fee rate of the top crypto protocols on a specified date, allowing the user..."
|
||||
url="/bot/reference/discord/crypto/fees"
|
||||
/>
|
||||
<ReferenceCard
|
||||
title="ir"
|
||||
description="This command allows the user to retrieve the issuance rate of the top crypto protocols. The issuance rate is the..."
|
||||
url="/bot/reference/discord/crypto/ir"
|
||||
/>
|
||||
<ReferenceCard
|
||||
title="prints"
|
||||
description="This command allows the user to retrieve the Last 15 Crypto Prints over the last 24 hours for the specified coin...."
|
||||
url="/bot/reference/discord/crypto/prints"
|
||||
/>
|
||||
<ReferenceCard
|
||||
title="top"
|
||||
description="This command will retrieve the top cryptocurrencies, ranked by market capitalization, allowing the user to..."
|
||||
url="/bot/reference/discord/crypto/top"
|
||||
/>
|
||||
<ReferenceCard
|
||||
title="tvl"
|
||||
description="This command allows users to retrieve historical TVL (Total Value Locked) data for any given protocol. It..."
|
||||
url="/bot/reference/discord/crypto/tvl"
|
||||
/>
|
||||
</ul>
|
||||
47
website/content/bot/reference/discord/darkpool/index.mdx
vendored
Normal file
47
website/content/bot/reference/discord/darkpool/index.mdx
vendored
Normal file
@@ -0,0 +1,47 @@
|
||||
# darkpool
|
||||
|
||||
import ReferenceCard from "@site/src/components/General/ReferenceCard";
|
||||
|
||||
<ul className="grid grid-cols-1 md:grid-cols-2 lg:grid-cols-3 xl:grid-cols-4 gap-4 -ml-6">
|
||||
|
||||
<ReferenceCard
|
||||
title="allblocks"
|
||||
description="The command allows the user to retrieve the last 15 block trades of a given security. This command will provide a..."
|
||||
url="/bot/reference/discord/darkpool/allblocks"
|
||||
/>
|
||||
<ReferenceCard
|
||||
title="alldp"
|
||||
description="This command allows the user to retrieve the last 15 darkpool trades for the specified stock ticker. A darkpool..."
|
||||
url="/bot/reference/discord/darkpool/alldp"
|
||||
/>
|
||||
<ReferenceCard
|
||||
title="allprints"
|
||||
description="This command retrieves the Last 15 Combination of Dark Pool and Blocks for a given ticker symbol. This can be..."
|
||||
url="/bot/reference/discord/darkpool/allprints"
|
||||
/>
|
||||
<ReferenceCard
|
||||
title="bigprints"
|
||||
description="This command will retrieve the largest combination of dark pool and block trades over a specified amount of days...."
|
||||
url="/bot/reference/discord/darkpool/bigprints"
|
||||
/>
|
||||
<ReferenceCard
|
||||
title="levels"
|
||||
description="This command allows the user to retrieve the Biggest Levels for All Prints over the last x days for the given..."
|
||||
url="/bot/reference/discord/darkpool/levels"
|
||||
/>
|
||||
<ReferenceCard
|
||||
title="sectors"
|
||||
description="This command allows the user to retrieve a summary of all prints by % of MarketCap by Sector over the last x..."
|
||||
url="/bot/reference/discord/darkpool/sectors"
|
||||
/>
|
||||
<ReferenceCard
|
||||
title="summary"
|
||||
description="This command retrieves a summary of all the prints by percentage of MarketCap over the last x days, sorted by..."
|
||||
url="/bot/reference/discord/darkpool/summary"
|
||||
/>
|
||||
<ReferenceCard
|
||||
title="topsum"
|
||||
description="This command allows the user to retrieve total block and dark pool data summary. It sums all darkpool prints and..."
|
||||
url="/bot/reference/discord/darkpool/topsum"
|
||||
/>
|
||||
</ul>
|
||||
62
website/content/bot/reference/discord/discovery/index.mdx
vendored
Normal file
62
website/content/bot/reference/discord/discovery/index.mdx
vendored
Normal file
@@ -0,0 +1,62 @@
|
||||
# discovery
|
||||
|
||||
import ReferenceCard from "@site/src/components/General/ReferenceCard";
|
||||
|
||||
<ul className="grid grid-cols-1 md:grid-cols-2 lg:grid-cols-3 xl:grid-cols-4 gap-4 -ml-6">
|
||||
|
||||
<ReferenceCard
|
||||
title="arktrades"
|
||||
description="This command allows the user to retrieve a list of all trades made by ARK, including the time and amount of each..."
|
||||
url="/bot/reference/discord/discovery/arktrades"
|
||||
/>
|
||||
<ReferenceCard
|
||||
title="contracts"
|
||||
description="This command allows the user to retrieve the Top 15 Government contracts by amount for all tickers. This is a..."
|
||||
url="/bot/reference/discord/discovery/contracts"
|
||||
/>
|
||||
<ReferenceCard
|
||||
title="fgindex"
|
||||
description="This command allows the user to retrieve the Fear & Greed Index, which is an investor sentiment indicator..."
|
||||
url="/bot/reference/discord/discovery/fgindex"
|
||||
/>
|
||||
<ReferenceCard
|
||||
title="halts"
|
||||
description="This command allows the user to retrieve the time and halt code of stocks in the market, excluding penny stocks...."
|
||||
url="/bot/reference/discord/discovery/halts"
|
||||
/>
|
||||
<ReferenceCard
|
||||
title="holidays"
|
||||
description="This command allows the user to retrieve a list of upcoming market holidays. The command will return a list of..."
|
||||
url="/bot/reference/discord/discovery/holidays"
|
||||
/>
|
||||
<ReferenceCard
|
||||
title="house"
|
||||
description="This command allows users to retrieve recent house trades for all tickers. The command will display the time of..."
|
||||
url="/bot/reference/discord/discovery/house"
|
||||
/>
|
||||
<ReferenceCard
|
||||
title="ipolist"
|
||||
description="This command allows the user to view 10 of the most recent and upcoming Initial Public Offerings (IPOs) including..."
|
||||
url="/bot/reference/discord/discovery/ipolist"
|
||||
/>
|
||||
<ReferenceCard
|
||||
title="senate"
|
||||
description="This command retrieves the most recent senate trades for all tickers including the date and time of the trade and..."
|
||||
url="/bot/reference/discord/discovery/senate"
|
||||
/>
|
||||
<ReferenceCard
|
||||
title="splits"
|
||||
description="This command allows users to view a list of recent stock splits for all available tickers. This list includes the..."
|
||||
url="/bot/reference/discord/discovery/splits"
|
||||
/>
|
||||
<ReferenceCard
|
||||
title="trendingst"
|
||||
description="This command allows the user to retrieve the top 15 trending stocks from StockTwits according to the most recent..."
|
||||
url="/bot/reference/discord/discovery/trendingst"
|
||||
/>
|
||||
<ReferenceCard
|
||||
title="wsb"
|
||||
description="This command allows the user to view the top 15 trending stocks on r/WallStreetBets (WSB) using the /disc wsb..."
|
||||
url="/bot/reference/discord/discovery/wsb"
|
||||
/>
|
||||
</ul>
|
||||
97
website/content/bot/reference/discord/duedilligence/index.mdx
vendored
Normal file
97
website/content/bot/reference/discord/duedilligence/index.mdx
vendored
Normal file
@@ -0,0 +1,97 @@
|
||||
# duedilligence
|
||||
|
||||
import ReferenceCard from "@site/src/components/General/ReferenceCard";
|
||||
|
||||
<ul className="grid grid-cols-1 md:grid-cols-2 lg:grid-cols-3 xl:grid-cols-4 gap-4 -ml-6">
|
||||
|
||||
<ReferenceCard
|
||||
title="ah"
|
||||
description="This command allows the user to retrieve afterhours data for a given stock ticker. The data retrieved will..."
|
||||
url="/bot/reference/discord/duedilligence/ah"
|
||||
/>
|
||||
<ReferenceCard
|
||||
title="analyst"
|
||||
description="This command allows the user to retrieve analyst recommendations for a given stock ticker."
|
||||
url="/bot/reference/discord/duedilligence/analyst"
|
||||
/>
|
||||
<ReferenceCard
|
||||
title="bio"
|
||||
description="This command retrieves a stock's company information and displays it to the user. It takes a stock ticker as an..."
|
||||
url="/bot/reference/discord/duedilligence/bio"
|
||||
/>
|
||||
<ReferenceCard
|
||||
title="customer"
|
||||
description="This command allows the user to display customers of the company using the given symbol."
|
||||
url="/bot/reference/discord/duedilligence/customer"
|
||||
/>
|
||||
<ReferenceCard
|
||||
title="divinfo"
|
||||
description="This command retrieves dividend information for a given stock. The data includes dividend rate, yield, and ex-div..."
|
||||
url="/bot/reference/discord/duedilligence/divinfo"
|
||||
/>
|
||||
<ReferenceCard
|
||||
title="earnings"
|
||||
description="This command allows the user to retrieve the expected earnings for the given business day. The displayed earnings..."
|
||||
url="/bot/reference/discord/duedilligence/earnings"
|
||||
/>
|
||||
<ReferenceCard
|
||||
title="ermove"
|
||||
description="This command allows the user to retrieve the implied move for a stock based on the current option prices. The..."
|
||||
url="/bot/reference/discord/duedilligence/ermove"
|
||||
/>
|
||||
<ReferenceCard
|
||||
title="est"
|
||||
description="This command allows the user to retrieve earning estimates for a given stock symbol. This can be used as a..."
|
||||
url="/bot/reference/discord/duedilligence/est"
|
||||
/>
|
||||
<ReferenceCard
|
||||
title="financials"
|
||||
description="This command will retrieve the financials of the company with the given ticker which includes total assets, cash,..."
|
||||
url="/bot/reference/discord/duedilligence/financials"
|
||||
/>
|
||||
<ReferenceCard
|
||||
title="insiders"
|
||||
description="This command allows the user to retrieve the 15 most recent insider transactions for a given stock. It will..."
|
||||
url="/bot/reference/discord/duedilligence/insiders"
|
||||
/>
|
||||
<ReferenceCard
|
||||
title="instholdings"
|
||||
description="This command allows the user to retrieve the top 15 institutional holdings for a given stock. This list is..."
|
||||
url="/bot/reference/discord/duedilligence/instholdings"
|
||||
/>
|
||||
<ReferenceCard
|
||||
title="nexter"
|
||||
description="This command will retrieve the next earnings date for the given stock ticker symbol."
|
||||
url="/bot/reference/discord/duedilligence/nexter"
|
||||
/>
|
||||
<ReferenceCard
|
||||
title="pm"
|
||||
description="This command allows the user to retrieve premarket data for a given stock ticker. It will fetch the latest price,..."
|
||||
url="/bot/reference/discord/duedilligence/pm"
|
||||
/>
|
||||
<ReferenceCard
|
||||
title="pt"
|
||||
description="This command allows the user to retrieve a chart with price targets for the specified ticker. The chart will..."
|
||||
url="/bot/reference/discord/duedilligence/pt"
|
||||
/>
|
||||
<ReferenceCard
|
||||
title="sec"
|
||||
description="This command allows the user to retrieve the most recent SEC filings related to the specified ticker symbol. The..."
|
||||
url="/bot/reference/discord/duedilligence/sec"
|
||||
/>
|
||||
<ReferenceCard
|
||||
title="splits"
|
||||
description="This command retrieves a list of recent stock splits for a given ticker. This command is useful for tracking the..."
|
||||
url="/bot/reference/discord/duedilligence/splits"
|
||||
/>
|
||||
<ReferenceCard
|
||||
title="supplier"
|
||||
description="This command allows users to retrieve the list of suppliers associated with the company with the given ticker."
|
||||
url="/bot/reference/discord/duedilligence/supplier"
|
||||
/>
|
||||
<ReferenceCard
|
||||
title="ytd"
|
||||
description="This command allows the user to retrieve the stock's year-to-date performance for a particular ticker symbol. It..."
|
||||
url="/bot/reference/discord/duedilligence/ytd"
|
||||
/>
|
||||
</ul>
|
||||
52
website/content/bot/reference/discord/economy/index.mdx
vendored
Normal file
52
website/content/bot/reference/discord/economy/index.mdx
vendored
Normal file
@@ -0,0 +1,52 @@
|
||||
# economy
|
||||
|
||||
import ReferenceCard from "@site/src/components/General/ReferenceCard";
|
||||
|
||||
<ul className="grid grid-cols-1 md:grid-cols-2 lg:grid-cols-3 xl:grid-cols-4 gap-4 -ml-6">
|
||||
|
||||
<ReferenceCard
|
||||
title="calendar"
|
||||
description="This command allows the user to retrieve an Economic Calendar for the day, which displays the upcoming economic..."
|
||||
url="/bot/reference/discord/economy/calendar"
|
||||
/>
|
||||
<ReferenceCard
|
||||
title="commodities"
|
||||
description="This command allows users to quickly and easily retrieve an overview of Futures and commodities. It provides the..."
|
||||
url="/bot/reference/discord/economy/commodities"
|
||||
/>
|
||||
<ReferenceCard
|
||||
title="currencies"
|
||||
description="This command allows the user to retrieve an overview of all available currencies. It will provide the user with..."
|
||||
url="/bot/reference/discord/economy/currencies"
|
||||
/>
|
||||
<ReferenceCard
|
||||
title="fedrates"
|
||||
description="This command allows users to quickly and easily retrieve upcoming Federal Rate decision dates and chances. It is..."
|
||||
url="/bot/reference/discord/economy/fedrates"
|
||||
/>
|
||||
<ReferenceCard
|
||||
title="glbonds"
|
||||
description="This command allows the user to retrieve an overview of global bonds. It includes information about the type of..."
|
||||
url="/bot/reference/discord/economy/glbonds"
|
||||
/>
|
||||
<ReferenceCard
|
||||
title="indices"
|
||||
description="This command provides a real-time overview of the major US stock indices, such as the Dow Jones Industrial..."
|
||||
url="/bot/reference/discord/economy/indices"
|
||||
/>
|
||||
<ReferenceCard
|
||||
title="revrepo"
|
||||
description="This command allows the user to retrieve Reverse Repo data for a default period of 35 days. This data includes..."
|
||||
url="/bot/reference/discord/economy/revrepo"
|
||||
/>
|
||||
<ReferenceCard
|
||||
title="usbonds"
|
||||
description="This command retrieves an overview of US bonds from the 1-Month to 30-Year bonds, providing the user with a list..."
|
||||
url="/bot/reference/discord/economy/usbonds"
|
||||
/>
|
||||
<ReferenceCard
|
||||
title="yieldcurve"
|
||||
description="This command allows the user to retrieve the US Bonds yield curve. The yield curve is a graph that plots the..."
|
||||
url="/bot/reference/discord/economy/yieldcurve"
|
||||
/>
|
||||
</ul>
|
||||
17
website/content/bot/reference/discord/etf/index.mdx
vendored
Normal file
17
website/content/bot/reference/discord/etf/index.mdx
vendored
Normal file
@@ -0,0 +1,17 @@
|
||||
# etf
|
||||
|
||||
import ReferenceCard from "@site/src/components/General/ReferenceCard";
|
||||
|
||||
<ul className="grid grid-cols-1 md:grid-cols-2 lg:grid-cols-3 xl:grid-cols-4 gap-4 -ml-6">
|
||||
|
||||
<ReferenceCard
|
||||
title="holdings"
|
||||
description="This command returns the holdings for an ETF sorted by percent of ETF."
|
||||
url="/bot/reference/discord/etf/holdings"
|
||||
/>
|
||||
<ReferenceCard
|
||||
title="tops"
|
||||
description="This command returns the top ETFs for the day - sorted by gainers, losers, or active."
|
||||
url="/bot/reference/discord/etf/tops"
|
||||
/>
|
||||
</ul>
|
||||
67
website/content/bot/reference/discord/flow/index.mdx
vendored
Normal file
67
website/content/bot/reference/discord/flow/index.mdx
vendored
Normal file
@@ -0,0 +1,67 @@
|
||||
# flow
|
||||
|
||||
import ReferenceCard from "@site/src/components/General/ReferenceCard";
|
||||
|
||||
<ul className="grid grid-cols-1 md:grid-cols-2 lg:grid-cols-3 xl:grid-cols-4 gap-4 -ml-6">
|
||||
|
||||
<ReferenceCard
|
||||
title="bigflow"
|
||||
description="This command retrieves the top 20 largest flow by premium for a stock. We calculate the largest flow by..."
|
||||
url="/bot/reference/discord/flow/bigflow"
|
||||
/>
|
||||
<ReferenceCard
|
||||
title="day"
|
||||
description="This command retrieves the most recent flow for a stock with the specified ticker symbol. The command will return..."
|
||||
url="/bot/reference/discord/flow/day"
|
||||
/>
|
||||
<ReferenceCard
|
||||
title="opening"
|
||||
description="This command allows the user to retrieve the Top 20 flows by premium for a stock with the Opening condition -..."
|
||||
url="/bot/reference/discord/flow/opening"
|
||||
/>
|
||||
<ReferenceCard
|
||||
title="prem"
|
||||
description="This command allows the user to retrieve a chart displaying the sum of premium for call/put options for a..."
|
||||
url="/bot/reference/discord/flow/prem"
|
||||
/>
|
||||
<ReferenceCard
|
||||
title="sectors"
|
||||
description="This command retrieves a summary of all flows by MarketCap percentage per sector over the past x days."
|
||||
url="/bot/reference/discord/flow/sectors"
|
||||
/>
|
||||
<ReferenceCard
|
||||
title="sumday"
|
||||
description="This command allows the user to retrieve the total premium of the given stock ticker for the current trading day...."
|
||||
url="/bot/reference/discord/flow/sumday"
|
||||
/>
|
||||
<ReferenceCard
|
||||
title="sumexp"
|
||||
description="This command allows the user to retrieve the total premium of the given stock ticker for the current trading day..."
|
||||
url="/bot/reference/discord/flow/sumexp"
|
||||
/>
|
||||
<ReferenceCard
|
||||
title="summary"
|
||||
description="This command allows the user to retrieve a summary of all the flow per stock over the last x days, with the..."
|
||||
url="/bot/reference/discord/flow/summary"
|
||||
/>
|
||||
<ReferenceCard
|
||||
title="sumtop"
|
||||
description="This command allows the user to retrieve the top flow for the day for Calls and Puts by stock. This will provide..."
|
||||
url="/bot/reference/discord/flow/sumtop"
|
||||
/>
|
||||
<ReferenceCard
|
||||
title="sumweek"
|
||||
description="This command allows the user to retrieve the top flow for the week for Calls and Puts by stock. This will provide..."
|
||||
url="/bot/reference/discord/flow/sumweek"
|
||||
/>
|
||||
<ReferenceCard
|
||||
title="unu"
|
||||
description="This command allows users to retrieve Unusual Options Trades over $100,000 premium and Total Volume exceeding..."
|
||||
url="/bot/reference/discord/flow/unu"
|
||||
/>
|
||||
<ReferenceCard
|
||||
title="weekly"
|
||||
description="This command allows the user to retrieve the Top 20 flow by Premium for a stock with an option contact expiring..."
|
||||
url="/bot/reference/discord/flow/weekly"
|
||||
/>
|
||||
</ul>
|
||||
22
website/content/bot/reference/discord/fun/index.mdx
vendored
Normal file
22
website/content/bot/reference/discord/fun/index.mdx
vendored
Normal file
@@ -0,0 +1,22 @@
|
||||
# fun
|
||||
|
||||
import ReferenceCard from "@site/src/components/General/ReferenceCard";
|
||||
|
||||
<ul className="grid grid-cols-1 md:grid-cols-2 lg:grid-cols-3 xl:grid-cols-4 gap-4 -ml-6">
|
||||
|
||||
<ReferenceCard
|
||||
title="8ball"
|
||||
description="This command allows the user to ask the 8-ball a question and receive an answer. The question must end in a..."
|
||||
url="/bot/reference/discord/fun/8ball"
|
||||
/>
|
||||
<ReferenceCard
|
||||
title="flip"
|
||||
description="This command allows the user to simulate a coin flip displaying either a 'Heads' or 'Tails'."
|
||||
url="/bot/reference/discord/fun/flip"
|
||||
/>
|
||||
<ReferenceCard
|
||||
title="urban"
|
||||
description="This command allows the user to search for a definition of a word on Urban Dictionary."
|
||||
url="/bot/reference/discord/fun/urban"
|
||||
/>
|
||||
</ul>
|
||||
47
website/content/bot/reference/discord/general/index.mdx
vendored
Normal file
47
website/content/bot/reference/discord/general/index.mdx
vendored
Normal file
@@ -0,0 +1,47 @@
|
||||
# general
|
||||
|
||||
import ReferenceCard from "@site/src/components/General/ReferenceCard";
|
||||
|
||||
<ul className="grid grid-cols-1 md:grid-cols-2 lg:grid-cols-3 xl:grid-cols-4 gap-4 -ml-6">
|
||||
|
||||
<ReferenceCard
|
||||
title="futures"
|
||||
description="This command allows the user to retrieve futures prices on the stock market."
|
||||
url="/bot/reference/discord/general/futures"
|
||||
/>
|
||||
<ReferenceCard
|
||||
title="heatchart"
|
||||
description="This command allows the user to retrieve a Daily Market Heat Chart (15 minute delayed). The heat chart shows a..."
|
||||
url="/bot/reference/discord/general/heatchart"
|
||||
/>
|
||||
<ReferenceCard
|
||||
title="heatmap"
|
||||
description="This command allows the user to retrieve Daily Heat Maps by Market and Sector. The Daily Heat Maps will allow the..."
|
||||
url="/bot/reference/discord/general/heatmap"
|
||||
/>
|
||||
<ReferenceCard
|
||||
title="markets"
|
||||
description="This command allows the user to retrieve a markets overview which provides a quick summary of current market..."
|
||||
url="/bot/reference/discord/general/markets"
|
||||
/>
|
||||
<ReferenceCard
|
||||
title="news"
|
||||
description="This command allows the user to retrieve the latest news for a given ticker."
|
||||
url="/bot/reference/discord/general/news"
|
||||
/>
|
||||
<ReferenceCard
|
||||
title="quote"
|
||||
description="This command allows the user to retrieve display quote stats for a stock - including the 52 week high/low, market..."
|
||||
url="/bot/reference/discord/general/quote"
|
||||
/>
|
||||
<ReferenceCard
|
||||
title="ta"
|
||||
description="This command allows the user to retrieve a technical analysis summary for a given stock ticker. The summary..."
|
||||
url="/bot/reference/discord/general/ta"
|
||||
/>
|
||||
<ReferenceCard
|
||||
title="watchlist"
|
||||
description="This command allows the user to retrieve an overview of their watchlist, which includes the current price,..."
|
||||
url="/bot/reference/discord/general/watchlist"
|
||||
/>
|
||||
</ul>
|
||||
22
website/content/bot/reference/discord/government/index.mdx
vendored
Normal file
22
website/content/bot/reference/discord/government/index.mdx
vendored
Normal file
@@ -0,0 +1,22 @@
|
||||
# government
|
||||
|
||||
import ReferenceCard from "@site/src/components/General/ReferenceCard";
|
||||
|
||||
<ul className="grid grid-cols-1 md:grid-cols-2 lg:grid-cols-3 xl:grid-cols-4 gap-4 -ml-6">
|
||||
|
||||
<ReferenceCard
|
||||
title="contracts"
|
||||
description="This command will allow the user to retrieve the top 15 government contracts by amount for a specific ticker."
|
||||
url="/bot/reference/discord/government/contracts"
|
||||
/>
|
||||
<ReferenceCard
|
||||
title="house"
|
||||
description="This command allows the user to retrieve recent house trades for a specific ticker."
|
||||
url="/bot/reference/discord/government/house"
|
||||
/>
|
||||
<ReferenceCard
|
||||
title="senate"
|
||||
description="This command allows a user to view the recent trades of senate members for a specific ticker."
|
||||
url="/bot/reference/discord/government/senate"
|
||||
/>
|
||||
</ul>
|
||||
102
website/content/bot/reference/discord/index.mdx
vendored
Normal file
102
website/content/bot/reference/discord/index.mdx
vendored
Normal file
@@ -0,0 +1,102 @@
|
||||
# OpenBB Discord Reference
|
||||
|
||||
import ReferenceCard from "@site/src/components/General/ReferenceCard";
|
||||
|
||||
<ul className="grid grid-cols-1 md:grid-cols-2 lg:grid-cols-3 xl:grid-cols-4 gap-4 -ml-6">
|
||||
|
||||
<ReferenceCard
|
||||
title="alerts"
|
||||
description="create delete list update"
|
||||
url="/bot/reference/discord/alerts"
|
||||
/>
|
||||
<ReferenceCard
|
||||
title="autopost"
|
||||
description="add list remove"
|
||||
url="/bot/reference/discord/autopost"
|
||||
/>
|
||||
<ReferenceCard
|
||||
title="charts"
|
||||
description="c15m c3m c5m cc cd chart chartfib chartsr cm cw"
|
||||
url="/bot/reference/discord/charts"
|
||||
/>
|
||||
<ReferenceCard
|
||||
title="crypto"
|
||||
description="bigprints bio compfees fees ir prints top tvl chart table"
|
||||
url="/bot/reference/discord/crypto"
|
||||
/>
|
||||
<ReferenceCard
|
||||
title="darkpool"
|
||||
description="allblocks alldp allprints bigprints levels sectors summary topsum"
|
||||
url="/bot/reference/discord/darkpool"
|
||||
/>
|
||||
<ReferenceCard
|
||||
title="discovery"
|
||||
description="arktrades contracts fgindex halts holidays house ipolist senate splits trendingst wsb"
|
||||
url="/bot/reference/discord/discovery"
|
||||
/>
|
||||
<ReferenceCard
|
||||
title="duedilligence"
|
||||
description="ah analyst bio customer divinfo earnings ermove est financials insiders instholdings nexter pm pt sec splits supplier ytd"
|
||||
url="/bot/reference/discord/duedilligence"
|
||||
/>
|
||||
<ReferenceCard
|
||||
title="economy"
|
||||
description="calendar commodities currencies fedrates glbonds indices revrepo usbonds yieldcurve"
|
||||
url="/bot/reference/discord/economy"
|
||||
/>
|
||||
<ReferenceCard
|
||||
title="etf"
|
||||
description="holdings tops"
|
||||
url="/bot/reference/discord/etf"
|
||||
/>
|
||||
<ReferenceCard
|
||||
title="flow"
|
||||
description="bigflow day opening prem sectors sumday sumexp summary sumtop sumweek unu weekly"
|
||||
url="/bot/reference/discord/flow"
|
||||
/>
|
||||
<ReferenceCard
|
||||
title="fun"
|
||||
description="8ball flip urban"
|
||||
url="/bot/reference/discord/fun"
|
||||
/>
|
||||
<ReferenceCard
|
||||
title="general"
|
||||
description="futures heatchart heatmap markets news quote ta watchlist"
|
||||
url="/bot/reference/discord/general"
|
||||
/>
|
||||
<ReferenceCard
|
||||
title="government"
|
||||
description="contracts house senate"
|
||||
url="/bot/reference/discord/government"
|
||||
/>
|
||||
<ReferenceCard
|
||||
title="info"
|
||||
description="about serverid stats support"
|
||||
url="/bot/reference/discord/info"
|
||||
/>
|
||||
<ReferenceCard
|
||||
title="nft"
|
||||
description="chart collection top"
|
||||
url="/bot/reference/discord/nft"
|
||||
/>
|
||||
<ReferenceCard
|
||||
title="options"
|
||||
description="chains equitypc gamma highiv hist indexpc info itm maxpain oi oichart smile stats topoi topoichange topstrikevol topvol topvoletf unu uoastock vol vsurf"
|
||||
url="/bot/reference/discord/options"
|
||||
/>
|
||||
<ReferenceCard
|
||||
title="pop"
|
||||
description="1d 1hr"
|
||||
url="/bot/reference/discord/pop"
|
||||
/>
|
||||
<ReferenceCard
|
||||
title="screeners"
|
||||
description="ah ah_all all pm pm_all technical"
|
||||
url="/bot/reference/discord/screeners"
|
||||
/>
|
||||
<ReferenceCard
|
||||
title="short_data"
|
||||
description="borrowed hsi shortrate shortvol topshortvol"
|
||||
url="/bot/reference/discord/short_data"
|
||||
/>
|
||||
</ul>
|
||||
27
website/content/bot/reference/discord/info/index.mdx
vendored
Normal file
27
website/content/bot/reference/discord/info/index.mdx
vendored
Normal file
@@ -0,0 +1,27 @@
|
||||
# info
|
||||
|
||||
import ReferenceCard from "@site/src/components/General/ReferenceCard";
|
||||
|
||||
<ul className="grid grid-cols-1 md:grid-cols-2 lg:grid-cols-3 xl:grid-cols-4 gap-4 -ml-6">
|
||||
|
||||
<ReferenceCard
|
||||
title="about"
|
||||
description="This command will provide users with a comprehensive overview of OpenBB Bot and links to our social media pages."
|
||||
url="/bot/reference/discord/info/about"
|
||||
/>
|
||||
<ReferenceCard
|
||||
title="serverid"
|
||||
description="This command allows the user to retrieve the Server ID of discord room. The Server ID is a unique identifier..."
|
||||
url="/bot/reference/discord/info/serverid"
|
||||
/>
|
||||
<ReferenceCard
|
||||
title="stats"
|
||||
description="This command allows the user to retrieve the current number of servers the bot is in."
|
||||
url="/bot/reference/discord/info/stats"
|
||||
/>
|
||||
<ReferenceCard
|
||||
title="support"
|
||||
description="This command allows the user to send a support ticket directly to our team."
|
||||
url="/bot/reference/discord/info/support"
|
||||
/>
|
||||
</ul>
|
||||
22
website/content/bot/reference/discord/nft/index.mdx
vendored
Normal file
22
website/content/bot/reference/discord/nft/index.mdx
vendored
Normal file
@@ -0,0 +1,22 @@
|
||||
# nft
|
||||
|
||||
import ReferenceCard from "@site/src/components/General/ReferenceCard";
|
||||
|
||||
<ul className="grid grid-cols-1 md:grid-cols-2 lg:grid-cols-3 xl:grid-cols-4 gap-4 -ml-6">
|
||||
|
||||
<ReferenceCard
|
||||
title="chart"
|
||||
description="This command allows the user to retrieve the NFT Collection Data related to the specified slug. The chart will..."
|
||||
url="/bot/reference/discord/nft/chart"
|
||||
/>
|
||||
<ReferenceCard
|
||||
title="collection"
|
||||
description="This command retrieves a collection of Non-Fungible Token (NFT) data associated with the specified slug. It..."
|
||||
url="/bot/reference/discord/nft/collection"
|
||||
/>
|
||||
<ReferenceCard
|
||||
title="top"
|
||||
description="This command allows users to retrieve the top NFT collections from Ethereum. It provides a list of the most..."
|
||||
url="/bot/reference/discord/nft/top"
|
||||
/>
|
||||
</ul>
|
||||
117
website/content/bot/reference/discord/options/index.mdx
vendored
Normal file
117
website/content/bot/reference/discord/options/index.mdx
vendored
Normal file
@@ -0,0 +1,117 @@
|
||||
# options
|
||||
|
||||
import ReferenceCard from "@site/src/components/General/ReferenceCard";
|
||||
|
||||
<ul className="grid grid-cols-1 md:grid-cols-2 lg:grid-cols-3 xl:grid-cols-4 gap-4 -ml-6">
|
||||
|
||||
<ReferenceCard
|
||||
title="chains"
|
||||
description="This command allows users to retrieve Options Chain by Expiry, which gives an overview of the bid, ask, and open..."
|
||||
url="/bot/reference/discord/options/chains"
|
||||
/>
|
||||
<ReferenceCard
|
||||
title="equitypc"
|
||||
description="This command retrieves the Equity Put/Call Volume Ratio from market-harmonics.com. This ratio is used to measure..."
|
||||
url="/bot/reference/discord/options/equitypc"
|
||||
/>
|
||||
<ReferenceCard
|
||||
title="gamma"
|
||||
description="This command allows the user to view the Options Gamma Levels for a particular stock. Options Gamma Levels are..."
|
||||
url="/bot/reference/discord/options/gamma"
|
||||
/>
|
||||
<ReferenceCard
|
||||
title="highiv"
|
||||
description="This command retrieves the 15 highest IV30 equity stocks by 30 day Implied Volatility. The IV30 metric is a..."
|
||||
url="/bot/reference/discord/options/highiv"
|
||||
/>
|
||||
<ReferenceCard
|
||||
title="hist"
|
||||
description="This command allows the user to retrieve the historical price of options for the given parameters of a ticker,..."
|
||||
url="/bot/reference/discord/options/hist"
|
||||
/>
|
||||
<ReferenceCard
|
||||
title="indexpc"
|
||||
description="This command allows the user to retrieve the Index Put/Call Ratio for the market from market-harmonics.com. This..."
|
||||
url="/bot/reference/discord/options/indexpc"
|
||||
/>
|
||||
<ReferenceCard
|
||||
title="info"
|
||||
description="This command allows the user to quickly and easily retrieve various option information (volatility, IV rank,..."
|
||||
url="/bot/reference/discord/options/info"
|
||||
/>
|
||||
<ReferenceCard
|
||||
title="itm"
|
||||
description="This command allows the user to retrieve a list of In-the-Money options for the stock ticker symbol sorted by..."
|
||||
url="/bot/reference/discord/options/itm"
|
||||
/>
|
||||
<ReferenceCard
|
||||
title="maxpain"
|
||||
description="This command retrieves the Max Pain on expiration date for a given stock. Max Pain is the strike price with the..."
|
||||
url="/bot/reference/discord/options/maxpain"
|
||||
/>
|
||||
<ReferenceCard
|
||||
title="oi"
|
||||
description="This command allows the user to retrieve the Open Interest and Call/Put ratio for a given stock. Optionally, the..."
|
||||
url="/bot/reference/discord/options/oi"
|
||||
/>
|
||||
<ReferenceCard
|
||||
title="oichart"
|
||||
description="This command allows users to retrieve a chart of Total Open Interest by Strike Price for the given ticker symbol...."
|
||||
url="/bot/reference/discord/options/oichart"
|
||||
/>
|
||||
<ReferenceCard
|
||||
title="smile"
|
||||
description="This command allows the user to retrieve the Options Volatility Smile for the given ticker and expiry. The..."
|
||||
url="/bot/reference/discord/options/smile"
|
||||
/>
|
||||
<ReferenceCard
|
||||
title="stats"
|
||||
description="This command allows the user to retrieve Options Statistics for a stock with the given ticker symbol. This..."
|
||||
url="/bot/reference/discord/options/stats"
|
||||
/>
|
||||
<ReferenceCard
|
||||
title="topoi"
|
||||
description="This command allows the user to retrieve Top Open Interest among all stocks. This command queries the current..."
|
||||
url="/bot/reference/discord/options/topoi"
|
||||
/>
|
||||
<ReferenceCard
|
||||
title="topoichange"
|
||||
description="This command allows the user to view the top 15 stocks with the highest OI Change. It will display the stock..."
|
||||
url="/bot/reference/discord/options/topoichange"
|
||||
/>
|
||||
<ReferenceCard
|
||||
title="topstrikevol"
|
||||
description="This command allows the user to retrieve the top option strike by volume for a given security with the ability to..."
|
||||
url="/bot/reference/discord/options/topstrikevol"
|
||||
/>
|
||||
<ReferenceCard
|
||||
title="topvol"
|
||||
description="This command allows the user to retrieve the Top 15 Highest stock options volumes by adding the call and put..."
|
||||
url="/bot/reference/discord/options/topvol"
|
||||
/>
|
||||
<ReferenceCard
|
||||
title="topvoletf"
|
||||
description="This command allows the user to retrieve the Top 15 Highest ETF options volumes by adding the call and put volume..."
|
||||
url="/bot/reference/discord/options/topvoletf"
|
||||
/>
|
||||
<ReferenceCard
|
||||
title="unu"
|
||||
description="This command allows a user to retrieve unusual options sorted by strike and expiration. It provides a list of the..."
|
||||
url="/bot/reference/discord/options/unu"
|
||||
/>
|
||||
<ReferenceCard
|
||||
title="uoastock"
|
||||
description="This command allows the user to retrieve the 20-day average options volume by ticker. The volume is based on the..."
|
||||
url="/bot/reference/discord/options/uoastock"
|
||||
/>
|
||||
<ReferenceCard
|
||||
title="vol"
|
||||
description="This command allows the user to retrieve a chart of Options Volume by Strike for a specified ticker. This data..."
|
||||
url="/bot/reference/discord/options/vol"
|
||||
/>
|
||||
<ReferenceCard
|
||||
title="vsurf"
|
||||
description="This command allows the user to retrieve an options volatility surface for the ticker symbol. Specifically, it..."
|
||||
url="/bot/reference/discord/options/vsurf"
|
||||
/>
|
||||
</ul>
|
||||
17
website/content/bot/reference/discord/pop/index.mdx
vendored
Normal file
17
website/content/bot/reference/discord/pop/index.mdx
vendored
Normal file
@@ -0,0 +1,17 @@
|
||||
# pop
|
||||
|
||||
import ReferenceCard from "@site/src/components/General/ReferenceCard";
|
||||
|
||||
<ul className="grid grid-cols-1 md:grid-cols-2 lg:grid-cols-3 xl:grid-cols-4 gap-4 -ml-6">
|
||||
|
||||
<ReferenceCard
|
||||
title="1d"
|
||||
description="This command retrieves the top 15 tickers for the day based on popularity on the OpenBB Bot across all our..."
|
||||
url="/bot/reference/discord/pop/1d"
|
||||
/>
|
||||
<ReferenceCard
|
||||
title="1hr"
|
||||
description="This command retrieves the top 15 stocks that have been traded in the past hour on the OpenBB Bot across all our..."
|
||||
url="/bot/reference/discord/pop/1hr"
|
||||
/>
|
||||
</ul>
|
||||
37
website/content/bot/reference/discord/screeners/index.mdx
vendored
Normal file
37
website/content/bot/reference/discord/screeners/index.mdx
vendored
Normal file
@@ -0,0 +1,37 @@
|
||||
# screeners
|
||||
|
||||
import ReferenceCard from "@site/src/components/General/ReferenceCard";
|
||||
|
||||
<ul className="grid grid-cols-1 md:grid-cols-2 lg:grid-cols-3 xl:grid-cols-4 gap-4 -ml-6">
|
||||
|
||||
<ReferenceCard
|
||||
title="ah"
|
||||
description="This command allows the user to retrieve After-Hours stock movers according to a chosen screener."
|
||||
url="/bot/reference/discord/screeners/ah"
|
||||
/>
|
||||
<ReferenceCard
|
||||
title="ah_all"
|
||||
description="This command retrieves all available after-hours screeners (gainers, losers, and most active). It is helpful for..."
|
||||
url="/bot/reference/discord/screeners/ah_all"
|
||||
/>
|
||||
<ReferenceCard
|
||||
title="all"
|
||||
description="This command allows the user to view all available screeners during market hours. The results can then be used to..."
|
||||
url="/bot/reference/discord/screeners/all"
|
||||
/>
|
||||
<ReferenceCard
|
||||
title="pm"
|
||||
description="This command offers the user the ability to view the top pre-market gainers, losers, and most active, giving the..."
|
||||
url="/bot/reference/discord/screeners/pm"
|
||||
/>
|
||||
<ReferenceCard
|
||||
title="pm_all"
|
||||
description="This command allows the user to retrieve all available pre-market screeners."
|
||||
url="/bot/reference/discord/screeners/pm_all"
|
||||
/>
|
||||
<ReferenceCard
|
||||
title="technical"
|
||||
description="This command allows the user to retrieve stock screener results according to the chosen technical signal."
|
||||
url="/bot/reference/discord/screeners/technical"
|
||||
/>
|
||||
</ul>
|
||||
32
website/content/bot/reference/discord/short_data/index.mdx
vendored
Normal file
32
website/content/bot/reference/discord/short_data/index.mdx
vendored
Normal file
@@ -0,0 +1,32 @@
|
||||
# short_data
|
||||
|
||||
import ReferenceCard from "@site/src/components/General/ReferenceCard";
|
||||
|
||||
<ul className="grid grid-cols-1 md:grid-cols-2 lg:grid-cols-3 xl:grid-cols-4 gap-4 -ml-6">
|
||||
|
||||
<ReferenceCard
|
||||
title="borrowed"
|
||||
description="This command allows the user to view the history of borrowed shares available and fees associated with the stock..."
|
||||
url="/bot/reference/discord/short_data/borrowed"
|
||||
/>
|
||||
<ReferenceCard
|
||||
title="hsi"
|
||||
description="This command retrieves the top high short interest stocks over a 20% ratio. This information can let an investor..."
|
||||
url="/bot/reference/discord/short_data/hsi"
|
||||
/>
|
||||
<ReferenceCard
|
||||
title="shortrate"
|
||||
description="This command allows the user to retrieve the Display Short Shares spot borrow rate from Interactive Brokers for..."
|
||||
url="/bot/reference/discord/short_data/shortrate"
|
||||
/>
|
||||
<ReferenceCard
|
||||
title="shortvol"
|
||||
description="This command allows the user to retrieve a graph of the 30 day history of the short volume versus the total..."
|
||||
url="/bot/reference/discord/short_data/shortvol"
|
||||
/>
|
||||
<ReferenceCard
|
||||
title="topshortvol"
|
||||
description="This command allows the user to retrieve the Top 15 Short Interest Stocks per Finra. It's typically measured as a..."
|
||||
url="/bot/reference/discord/short_data/topshortvol"
|
||||
/>
|
||||
</ul>
|
||||
@@ -1,85 +1,84 @@
|
||||
# import re
|
||||
# from pathlib import Path
|
||||
# from textwrap import shorten
|
||||
# from typing import Dict, List
|
||||
import re
|
||||
from pathlib import Path
|
||||
from textwrap import shorten
|
||||
from typing import Dict, List
|
||||
|
||||
# reference_import = """import ReferenceCard from "@site/src/components/General/ReferenceCard";
|
||||
reference_import = """import ReferenceCard from "@site/src/components/General/ReferenceCard";
|
||||
|
||||
# <ul className="grid grid-cols-1 md:grid-cols-2 lg:grid-cols-3 xl:grid-cols-4 gap-4 -ml-6">
|
||||
# """
|
||||
# wopen_kwargs = {"encoding": "utf-8", "newline": "\n"}
|
||||
<ul className="grid grid-cols-1 md:grid-cols-2 lg:grid-cols-3 xl:grid-cols-4 gap-4 -ml-6">
|
||||
"""
|
||||
wopen_kwargs = {"encoding": "utf-8", "newline": "\n"}
|
||||
|
||||
|
||||
# def create_cmd_cards(cmd_text: List[Dict[str, str]], url: str) -> str:
|
||||
# cmd_cards = ""
|
||||
# for cmd in cmd_text:
|
||||
# cmd["description"] = shorten(f"{cmd['description']}", 116, placeholder="...")
|
||||
# cmd_cards += f"""<ReferenceCard
|
||||
# title="{cmd["name"]}"
|
||||
# description="{cmd["description"]}"
|
||||
# url="/bot/reference/{url}/{cmd["name"]}"
|
||||
# />\n"""
|
||||
# return cmd_cards
|
||||
def create_cmd_cards(cmd_text: List[Dict[str, str]], url: str) -> str:
|
||||
cmd_cards = ""
|
||||
for cmd in cmd_text:
|
||||
cmd["description"] = shorten(f"{cmd['description']}", 116, placeholder="...")
|
||||
cmd_cards += f"""<ReferenceCard
|
||||
title="{cmd["name"]}"
|
||||
description="{cmd["description"]}"
|
||||
url="/bot/reference/{url}/{cmd["name"]}"
|
||||
/>\n"""
|
||||
return cmd_cards
|
||||
|
||||
|
||||
# def create_nested_subfolder_card(folder: Path, url: str) -> str:
|
||||
# nested_card = f"""<ReferenceCard
|
||||
# title="{folder.name}"
|
||||
# description="{' '.join([sub.stem for sub in folder.glob('**/*.md*') if sub.is_file() and sub.stem != 'index'])}"
|
||||
# url="/bot/reference/{url}/{folder.name}"
|
||||
# />\n"""
|
||||
# return nested_card
|
||||
def create_nested_subfolder_card(folder: Path, url: str) -> str:
|
||||
nested_card = f"""<ReferenceCard
|
||||
title="{folder.name}"
|
||||
description="{' '.join([sub.stem for sub in folder.glob('**/*.md*') if sub.is_file() and sub.stem != 'index'])}"
|
||||
url="/bot/reference/{url}/{folder.name}"
|
||||
/>\n"""
|
||||
return nested_card
|
||||
|
||||
|
||||
# for bot in ["discord", "telegram"]:
|
||||
# for folder in (Path(__file__).parent / bot).iterdir():
|
||||
# rel_path = folder.relative_to(Path(__file__).parent / bot)
|
||||
# cmd_cards: List[Dict[str, str]] = []
|
||||
for bot in ["discord", "telegram"]:
|
||||
for folder in (Path(__file__).parent / bot).iterdir():
|
||||
rel_path = folder.relative_to(Path(__file__).parent / bot)
|
||||
cmd_cards: List[Dict[str, str]] = []
|
||||
|
||||
# for file in folder.glob("*.md*"):
|
||||
# if file.stem == "index":
|
||||
# continue
|
||||
for file in folder.glob("*.md*"):
|
||||
if file.stem == "index":
|
||||
continue
|
||||
|
||||
# desc_regex = re.compile(
|
||||
# r"---\n\n# ([^\n]+)(.*)### Usage", (re.DOTALL | re.MULTILINE)
|
||||
# )
|
||||
# description = desc_regex.search(file.read_text()).group(2).strip() # type: ignore
|
||||
desc_regex = re.compile(r"([^>]+)(.*)### Usage", (re.MULTILINE))
|
||||
|
||||
# cmd_dict = dict(
|
||||
# name=file.stem,
|
||||
# description=description,
|
||||
# url=f"{bot}/{rel_path}",
|
||||
# )
|
||||
description = desc_regex.search(file.read_text()).group(1).strip() # type: ignore
|
||||
|
||||
# cmd_cards.append(cmd_dict)
|
||||
cmd_dict = dict(
|
||||
name=file.stem,
|
||||
description=description,
|
||||
url=f"{bot}/{rel_path}",
|
||||
)
|
||||
|
||||
# if not cmd_cards:
|
||||
# continue
|
||||
cmd_cards.append(cmd_dict)
|
||||
|
||||
# with open(
|
||||
# Path(__file__).parent / bot / rel_path / "index.mdx", "w", **wopen_kwargs # type: ignore
|
||||
# ) as subindex:
|
||||
# subindex.write(f"# {folder.name}\n\n{reference_import}\n")
|
||||
if not cmd_cards:
|
||||
continue
|
||||
|
||||
# for subfolder in folder.glob("*"):
|
||||
# if not subfolder.is_dir():
|
||||
# continue
|
||||
with open(
|
||||
Path(__file__).parent / bot / rel_path / "index.mdx", "w", **wopen_kwargs # type: ignore
|
||||
) as subindex:
|
||||
subindex.write(f"# {folder.name}\n\n{reference_import}\n")
|
||||
|
||||
# subindex.write(
|
||||
# create_nested_subfolder_card(subfolder, f"{bot}/{rel_path}")
|
||||
# )
|
||||
for subfolder in folder.glob("*"):
|
||||
if not subfolder.is_dir():
|
||||
continue
|
||||
|
||||
# subindex.write(
|
||||
# create_cmd_cards(cmd_cards, f'{bot}/{"/".join(rel_path.parts)}')
|
||||
# )
|
||||
# subindex.write("</ul>\n")
|
||||
subindex.write(
|
||||
create_nested_subfolder_card(subfolder, f"{bot}/{rel_path}")
|
||||
)
|
||||
|
||||
# with open(Path(__file__).parent / bot / "index.mdx", "w", **wopen_kwargs) as index: # type: ignore
|
||||
# index.write(f"# OpenBB {bot.title()} Reference\n\n{reference_import}\n")
|
||||
subindex.write(
|
||||
create_cmd_cards(cmd_cards, f'{bot}/{"/".join(rel_path.parts)}')
|
||||
)
|
||||
subindex.write("</ul>\n")
|
||||
|
||||
# for folder in (Path(__file__).parent / bot).glob("*"):
|
||||
# if not folder.is_dir():
|
||||
# continue
|
||||
with open(Path(__file__).parent / bot / "index.mdx", "w", **wopen_kwargs) as index: # type: ignore
|
||||
index.write(f"# OpenBB {bot.title()} Reference\n\n{reference_import}\n")
|
||||
|
||||
# index.write(create_nested_subfolder_card(folder, bot))
|
||||
# index.write("</ul>\n")
|
||||
for folder in (Path(__file__).parent / bot).glob("*"):
|
||||
if not folder.is_dir():
|
||||
continue
|
||||
|
||||
index.write(create_nested_subfolder_card(folder, bot))
|
||||
index.write("</ul>\n")
|
||||
|
||||
62
website/content/bot/reference/telegram/charts/index.mdx
vendored
Normal file
62
website/content/bot/reference/telegram/charts/index.mdx
vendored
Normal file
@@ -0,0 +1,62 @@
|
||||
# charts
|
||||
|
||||
import ReferenceCard from "@site/src/components/General/ReferenceCard";
|
||||
|
||||
<ul className="grid grid-cols-1 md:grid-cols-2 lg:grid-cols-3 xl:grid-cols-4 gap-4 -ml-6">
|
||||
|
||||
<ReferenceCard
|
||||
title="c"
|
||||
description="This command will retrieve a candlestick chart for the crypto coin provided. The interval provided must be a..."
|
||||
url="/bot/reference/telegram/charts/c"
|
||||
/>
|
||||
<ReferenceCard
|
||||
title="c15m"
|
||||
description="This command allows the user to retrieve a 15-minute intraday chart for a given ticker. The chart will show the..."
|
||||
url="/bot/reference/telegram/charts/c15m"
|
||||
/>
|
||||
<ReferenceCard
|
||||
title="c3m"
|
||||
description="This command allows users to retrieve a 3-minute intraday chart for the given ticker. This chart will display the..."
|
||||
url="/bot/reference/telegram/charts/c3m"
|
||||
/>
|
||||
<ReferenceCard
|
||||
title="c5m"
|
||||
description="This command allows the user to retrieve an intraday 5 minute chart for a given ticker. This chart will display..."
|
||||
url="/bot/reference/telegram/charts/c5m"
|
||||
/>
|
||||
<ReferenceCard
|
||||
title="cc"
|
||||
description="This command allows the user to retrieve an intraday 5 minute chart for a given ticker, /c5m also has the same..."
|
||||
url="/bot/reference/telegram/charts/cc"
|
||||
/>
|
||||
<ReferenceCard
|
||||
title="cd"
|
||||
description="This command allows the user to retrieve a daily candlestick chart for a particular ticker or coin. The..."
|
||||
url="/bot/reference/telegram/charts/cd"
|
||||
/>
|
||||
<ReferenceCard
|
||||
title="chart"
|
||||
description="This command will retrieve a candlestick chart for the ticker/interval provided, with data for the past number of..."
|
||||
url="/bot/reference/telegram/charts/chart"
|
||||
/>
|
||||
<ReferenceCard
|
||||
title="chartfib"
|
||||
description="This command allows the user to retrieve Fibonacci levels for a given ticker. This data can be used to identify..."
|
||||
url="/bot/reference/telegram/charts/chartfib"
|
||||
/>
|
||||
<ReferenceCard
|
||||
title="chartsr"
|
||||
description="This command allows the user to retrieve Displays Support and Resistance Levels for the ticker provided. It will..."
|
||||
url="/bot/reference/telegram/charts/chartsr"
|
||||
/>
|
||||
<ReferenceCard
|
||||
title="cm"
|
||||
description="This command allows the user to retrieve a weekly candlestick chart for the ticker/coin provided. The chart..."
|
||||
url="/bot/reference/telegram/charts/cm"
|
||||
/>
|
||||
<ReferenceCard
|
||||
title="cw"
|
||||
description="This command allows the user to retrieve a weekly candlestick chart for the ticker/coin provided. The chart..."
|
||||
url="/bot/reference/telegram/charts/cw"
|
||||
/>
|
||||
</ul>
|
||||
52
website/content/bot/reference/telegram/crypto/index.mdx
vendored
Normal file
52
website/content/bot/reference/telegram/crypto/index.mdx
vendored
Normal file
@@ -0,0 +1,52 @@
|
||||
# crypto
|
||||
|
||||
import ReferenceCard from "@site/src/components/General/ReferenceCard";
|
||||
|
||||
<ul className="grid grid-cols-1 md:grid-cols-2 lg:grid-cols-3 xl:grid-cols-4 gap-4 -ml-6">
|
||||
|
||||
<ReferenceCard
|
||||
title="bigprints"
|
||||
description="This command allows the user to retrieve the last 15 large prints for a given cryptocurrency pair. The command..."
|
||||
url="/bot/reference/telegram/crypto/bigprints"
|
||||
/>
|
||||
<ReferenceCard
|
||||
title="bio"
|
||||
description="This command allows the user to retrieve fundamental information about a crypto, such as its current price,..."
|
||||
url="/bot/reference/telegram/crypto/bio"
|
||||
/>
|
||||
<ReferenceCard
|
||||
title="compfees"
|
||||
description="This command allows users to retrieve the Protocol fees over time for the given project."
|
||||
url="/bot/reference/telegram/crypto/compfees"
|
||||
/>
|
||||
<ReferenceCard
|
||||
title="defi"
|
||||
description="This command will retrieve a chart or table of the top DeFi protocols by market capitalization. It will provide a..."
|
||||
url="/bot/reference/telegram/crypto/defi"
|
||||
/>
|
||||
<ReferenceCard
|
||||
title="fees"
|
||||
description="This will provide the user with the fee rate of the top crypto protocols on a specified date, allowing the user..."
|
||||
url="/bot/reference/telegram/crypto/fees"
|
||||
/>
|
||||
<ReferenceCard
|
||||
title="ir"
|
||||
description="This command allows the user to retrieve the issuance rate of the top crypto protocols. The issuance rate is the..."
|
||||
url="/bot/reference/telegram/crypto/ir"
|
||||
/>
|
||||
<ReferenceCard
|
||||
title="prints"
|
||||
description="This command allows the user to retrieve the Last 15 Crypto Prints over the last 24 hours for the specified coin...."
|
||||
url="/bot/reference/telegram/crypto/prints"
|
||||
/>
|
||||
<ReferenceCard
|
||||
title="top"
|
||||
description="This command will retrieve the top cryptocurrencies, ranked by market capitalization, allowing the user to..."
|
||||
url="/bot/reference/telegram/crypto/top"
|
||||
/>
|
||||
<ReferenceCard
|
||||
title="tvl"
|
||||
description="This command allows users to retrieve historical TVL (Total Value Locked) data for any given protocol. It..."
|
||||
url="/bot/reference/telegram/crypto/tvl"
|
||||
/>
|
||||
</ul>
|
||||
47
website/content/bot/reference/telegram/darkpool/index.mdx
vendored
Normal file
47
website/content/bot/reference/telegram/darkpool/index.mdx
vendored
Normal file
@@ -0,0 +1,47 @@
|
||||
# darkpool
|
||||
|
||||
import ReferenceCard from "@site/src/components/General/ReferenceCard";
|
||||
|
||||
<ul className="grid grid-cols-1 md:grid-cols-2 lg:grid-cols-3 xl:grid-cols-4 gap-4 -ml-6">
|
||||
|
||||
<ReferenceCard
|
||||
title="allblocks"
|
||||
description="The command allows the user to retrieve the last 15 block trades of a given security. This command will provide a..."
|
||||
url="/bot/reference/telegram/darkpool/allblocks"
|
||||
/>
|
||||
<ReferenceCard
|
||||
title="alldp"
|
||||
description="This command allows the user to retrieve the last 15 darkpool trades for the specified stock ticker. A darkpool..."
|
||||
url="/bot/reference/telegram/darkpool/alldp"
|
||||
/>
|
||||
<ReferenceCard
|
||||
title="allprints"
|
||||
description="This command retrieves the Last 15 Combination of Dark Pool and Blocks for a given ticker symbol. This can be..."
|
||||
url="/bot/reference/telegram/darkpool/allprints"
|
||||
/>
|
||||
<ReferenceCard
|
||||
title="bigprintsdp"
|
||||
description="This command will retrieve the largest combination of dark pool and block trades over a specified amount of days...."
|
||||
url="/bot/reference/telegram/darkpool/bigprintsdp"
|
||||
/>
|
||||
<ReferenceCard
|
||||
title="levels"
|
||||
description="This command allows the user to retrieve the Biggest Levels for All Prints over the last x days for the given..."
|
||||
url="/bot/reference/telegram/darkpool/levels"
|
||||
/>
|
||||
<ReferenceCard
|
||||
title="sectors"
|
||||
description="This command allows the user to retrieve a summary of all prints by % of MarketCap by Sector over the last x..."
|
||||
url="/bot/reference/telegram/darkpool/sectors"
|
||||
/>
|
||||
<ReferenceCard
|
||||
title="summary"
|
||||
description="This command retrieves a summary of all the prints by percentage of MarketCap over the last x days, sorted by..."
|
||||
url="/bot/reference/telegram/darkpool/summary"
|
||||
/>
|
||||
<ReferenceCard
|
||||
title="topsum"
|
||||
description="This command allows the user to retrieve total block and dark pool data summary. It sums all darkpool prints and..."
|
||||
url="/bot/reference/telegram/darkpool/topsum"
|
||||
/>
|
||||
</ul>
|
||||
47
website/content/bot/reference/telegram/discovery/index.mdx
vendored
Normal file
47
website/content/bot/reference/telegram/discovery/index.mdx
vendored
Normal file
@@ -0,0 +1,47 @@
|
||||
# discovery
|
||||
|
||||
import ReferenceCard from "@site/src/components/General/ReferenceCard";
|
||||
|
||||
<ul className="grid grid-cols-1 md:grid-cols-2 lg:grid-cols-3 xl:grid-cols-4 gap-4 -ml-6">
|
||||
|
||||
<ReferenceCard
|
||||
title="arktrades"
|
||||
description="This command allows the user to retrieve a list of all trades made by ARK, including the time and amount of each..."
|
||||
url="/bot/reference/telegram/discovery/arktrades"
|
||||
/>
|
||||
<ReferenceCard
|
||||
title="fgindex"
|
||||
description="This command allows the user to retrieve the Fear & Greed Index, which is an investor sentiment indicator..."
|
||||
url="/bot/reference/telegram/discovery/fgindex"
|
||||
/>
|
||||
<ReferenceCard
|
||||
title="halts"
|
||||
description="This command allows the user to retrieve the time and halt code of stocks in the market, excluding penny stocks...."
|
||||
url="/bot/reference/telegram/discovery/halts"
|
||||
/>
|
||||
<ReferenceCard
|
||||
title="holidays"
|
||||
description="This command allows the user to retrieve a list of upcoming market holidays. The command will return a list of..."
|
||||
url="/bot/reference/telegram/discovery/holidays"
|
||||
/>
|
||||
<ReferenceCard
|
||||
title="ipolist"
|
||||
description="This command allows the user to view 10 of the most recent and upcoming Initial Public Offerings (IPOs) including..."
|
||||
url="/bot/reference/telegram/discovery/ipolist"
|
||||
/>
|
||||
<ReferenceCard
|
||||
title="pop"
|
||||
description="This command retrieves the top 15 tickers for the day or hour based on popularity on the OpenBB Bot across all..."
|
||||
url="/bot/reference/telegram/discovery/pop"
|
||||
/>
|
||||
<ReferenceCard
|
||||
title="trendingst"
|
||||
description="This command allows the user to retrieve the top 15 trending stocks from StockTwits according to the most recent..."
|
||||
url="/bot/reference/telegram/discovery/trendingst"
|
||||
/>
|
||||
<ReferenceCard
|
||||
title="wsb"
|
||||
description="This command allows the user to view the top 15 trending stocks on r/WallStreetBets (WSB) using the /disc wsb..."
|
||||
url="/bot/reference/telegram/discovery/wsb"
|
||||
/>
|
||||
</ul>
|
||||
92
website/content/bot/reference/telegram/duediligence/index.mdx
vendored
Normal file
92
website/content/bot/reference/telegram/duediligence/index.mdx
vendored
Normal file
@@ -0,0 +1,92 @@
|
||||
# duediligence
|
||||
|
||||
import ReferenceCard from "@site/src/components/General/ReferenceCard";
|
||||
|
||||
<ul className="grid grid-cols-1 md:grid-cols-2 lg:grid-cols-3 xl:grid-cols-4 gap-4 -ml-6">
|
||||
|
||||
<ReferenceCard
|
||||
title="ah"
|
||||
description="This command allows the user to retrieve afterhours data for a given stock ticker. The data retrieved will..."
|
||||
url="/bot/reference/telegram/duediligence/ah"
|
||||
/>
|
||||
<ReferenceCard
|
||||
title="analyst"
|
||||
description="This command allows the user to retrieve analyst recommendations for a given stock ticker."
|
||||
url="/bot/reference/telegram/duediligence/analyst"
|
||||
/>
|
||||
<ReferenceCard
|
||||
title="bio_stocks"
|
||||
description="This command retrieves a stock's company information and displays it to the user. It takes a stock ticker as an..."
|
||||
url="/bot/reference/telegram/duediligence/bio_stocks"
|
||||
/>
|
||||
<ReferenceCard
|
||||
title="customer"
|
||||
description="This command allows the user to display customers of the company using the given symbol."
|
||||
url="/bot/reference/telegram/duediligence/customer"
|
||||
/>
|
||||
<ReferenceCard
|
||||
title="divinfo"
|
||||
description="This command retrieves dividend information for a given stock. The data includes dividend rate, yield, and ex-div..."
|
||||
url="/bot/reference/telegram/duediligence/divinfo"
|
||||
/>
|
||||
<ReferenceCard
|
||||
title="earnings"
|
||||
description="This command allows the user to retrieve the expected earnings for the given business day. The displayed earnings..."
|
||||
url="/bot/reference/telegram/duediligence/earnings"
|
||||
/>
|
||||
<ReferenceCard
|
||||
title="ermove"
|
||||
description="This command allows the user to retrieve the implied move for a stock based on the current option prices. The..."
|
||||
url="/bot/reference/telegram/duediligence/ermove"
|
||||
/>
|
||||
<ReferenceCard
|
||||
title="financials"
|
||||
description="This command will retrieve the financials of the company with the given ticker which includes total assets, cash,..."
|
||||
url="/bot/reference/telegram/duediligence/financials"
|
||||
/>
|
||||
<ReferenceCard
|
||||
title="insiders"
|
||||
description="This command allows the user to retrieve the 15 most recent insider transactions for a given stock. It will..."
|
||||
url="/bot/reference/telegram/duediligence/insiders"
|
||||
/>
|
||||
<ReferenceCard
|
||||
title="instholdings"
|
||||
description="This command allows the user to retrieve the top 15 institutional holdings for a given stock. This list is..."
|
||||
url="/bot/reference/telegram/duediligence/instholdings"
|
||||
/>
|
||||
<ReferenceCard
|
||||
title="nexter"
|
||||
description="This command will retrieve the next earnings date for the given stock ticker symbol."
|
||||
url="/bot/reference/telegram/duediligence/nexter"
|
||||
/>
|
||||
<ReferenceCard
|
||||
title="pm"
|
||||
description="This command allows the user to retrieve premarket data for a given stock ticker. It will fetch the latest price,..."
|
||||
url="/bot/reference/telegram/duediligence/pm"
|
||||
/>
|
||||
<ReferenceCard
|
||||
title="pt"
|
||||
description="This command allows the user to retrieve a chart with price targets for the specified ticker. The chart will..."
|
||||
url="/bot/reference/telegram/duediligence/pt"
|
||||
/>
|
||||
<ReferenceCard
|
||||
title="sec"
|
||||
description="This command allows the user to retrieve the most recent SEC filings related to the specified ticker symbol. The..."
|
||||
url="/bot/reference/telegram/duediligence/sec"
|
||||
/>
|
||||
<ReferenceCard
|
||||
title="splits"
|
||||
description="This command retrieves a list of recent stock splits for a given ticker. This command is useful for tracking the..."
|
||||
url="/bot/reference/telegram/duediligence/splits"
|
||||
/>
|
||||
<ReferenceCard
|
||||
title="supplier"
|
||||
description="This command allows users to retrieve the list of suppliers associated with the company with the given ticker."
|
||||
url="/bot/reference/telegram/duediligence/supplier"
|
||||
/>
|
||||
<ReferenceCard
|
||||
title="ytd"
|
||||
description="This command allows the user to retrieve the stock's year-to-date performance for a particular ticker symbol. It..."
|
||||
url="/bot/reference/telegram/duediligence/ytd"
|
||||
/>
|
||||
</ul>
|
||||
47
website/content/bot/reference/telegram/economy/index.mdx
vendored
Normal file
47
website/content/bot/reference/telegram/economy/index.mdx
vendored
Normal file
@@ -0,0 +1,47 @@
|
||||
# economy
|
||||
|
||||
import ReferenceCard from "@site/src/components/General/ReferenceCard";
|
||||
|
||||
<ul className="grid grid-cols-1 md:grid-cols-2 lg:grid-cols-3 xl:grid-cols-4 gap-4 -ml-6">
|
||||
|
||||
<ReferenceCard
|
||||
title="bonds"
|
||||
description="This command allows the user to retrieve an overview of Global or US bonds. It includes information about the..."
|
||||
url="/bot/reference/telegram/economy/bonds"
|
||||
/>
|
||||
<ReferenceCard
|
||||
title="calendar"
|
||||
description="This command allows the user to retrieve an Economic Calendar for the day, which displays the upcoming economic..."
|
||||
url="/bot/reference/telegram/economy/calendar"
|
||||
/>
|
||||
<ReferenceCard
|
||||
title="commodities"
|
||||
description="This command allows users to quickly and easily retrieve an overview of Futures and commodities. It provides the..."
|
||||
url="/bot/reference/telegram/economy/commodities"
|
||||
/>
|
||||
<ReferenceCard
|
||||
title="currencies"
|
||||
description="This command allows the user to retrieve an overview of all available currencies. It will provide the user with..."
|
||||
url="/bot/reference/telegram/economy/currencies"
|
||||
/>
|
||||
<ReferenceCard
|
||||
title="fedrates"
|
||||
description="This command allows users to quickly and easily retrieve upcoming Federal Rate decision dates and chances. It is..."
|
||||
url="/bot/reference/telegram/economy/fedrates"
|
||||
/>
|
||||
<ReferenceCard
|
||||
title="indices"
|
||||
description="This command provides a real-time overview of the major US stock indices, such as the Dow Jones Industrial..."
|
||||
url="/bot/reference/telegram/economy/indices"
|
||||
/>
|
||||
<ReferenceCard
|
||||
title="revrepo"
|
||||
description="This command allows the user to retrieve Reverse Repo data for a default period of 35 days. This data includes..."
|
||||
url="/bot/reference/telegram/economy/revrepo"
|
||||
/>
|
||||
<ReferenceCard
|
||||
title="yieldcurve"
|
||||
description="This command allows the user to retrieve the US Bonds yield curve. The yield curve is a graph that plots the..."
|
||||
url="/bot/reference/telegram/economy/yieldcurve"
|
||||
/>
|
||||
</ul>
|
||||
17
website/content/bot/reference/telegram/etf/index.mdx
vendored
Normal file
17
website/content/bot/reference/telegram/etf/index.mdx
vendored
Normal file
@@ -0,0 +1,17 @@
|
||||
# etf
|
||||
|
||||
import ReferenceCard from "@site/src/components/General/ReferenceCard";
|
||||
|
||||
<ul className="grid grid-cols-1 md:grid-cols-2 lg:grid-cols-3 xl:grid-cols-4 gap-4 -ml-6">
|
||||
|
||||
<ReferenceCard
|
||||
title="holdings"
|
||||
description="This command returns the holdings for an ETF sorted by percent of ETF."
|
||||
url="/bot/reference/telegram/etf/holdings"
|
||||
/>
|
||||
<ReferenceCard
|
||||
title="tops"
|
||||
description="This command returns the top ETFs for the day - sorted by gainers, losers, or active."
|
||||
url="/bot/reference/telegram/etf/tops"
|
||||
/>
|
||||
</ul>
|
||||
32
website/content/bot/reference/telegram/flow/index.mdx
vendored
Normal file
32
website/content/bot/reference/telegram/flow/index.mdx
vendored
Normal file
@@ -0,0 +1,32 @@
|
||||
# flow
|
||||
|
||||
import ReferenceCard from "@site/src/components/General/ReferenceCard";
|
||||
|
||||
<ul className="grid grid-cols-1 md:grid-cols-2 lg:grid-cols-3 xl:grid-cols-4 gap-4 -ml-6">
|
||||
|
||||
<ReferenceCard
|
||||
title="flow"
|
||||
description="day open prem unu wk"
|
||||
url="/bot/reference/telegram/flow/flow"
|
||||
/>
|
||||
<ReferenceCard
|
||||
title="flowsum"
|
||||
description="day exp top wk"
|
||||
url="/bot/reference/telegram/flow/flowsum"
|
||||
/>
|
||||
<ReferenceCard
|
||||
title="bigflow"
|
||||
description="This command retrieves the top 20 largest flow by premium for a stock. We calculate the largest flow by..."
|
||||
url="/bot/reference/telegram/flow/bigflow"
|
||||
/>
|
||||
<ReferenceCard
|
||||
title="sectorsflow"
|
||||
description="This command retrieves a summary of all flows by MarketCap percentage per sector over the past x days."
|
||||
url="/bot/reference/telegram/flow/sectorsflow"
|
||||
/>
|
||||
<ReferenceCard
|
||||
title="summaryflow"
|
||||
description="This command allows the user to retrieve a summary of all the flow per stock over the last x days, with the..."
|
||||
url="/bot/reference/telegram/flow/summaryflow"
|
||||
/>
|
||||
</ul>
|
||||
22
website/content/bot/reference/telegram/fun/index.mdx
vendored
Normal file
22
website/content/bot/reference/telegram/fun/index.mdx
vendored
Normal file
@@ -0,0 +1,22 @@
|
||||
# fun
|
||||
|
||||
import ReferenceCard from "@site/src/components/General/ReferenceCard";
|
||||
|
||||
<ul className="grid grid-cols-1 md:grid-cols-2 lg:grid-cols-3 xl:grid-cols-4 gap-4 -ml-6">
|
||||
|
||||
<ReferenceCard
|
||||
title="8ball"
|
||||
description="This command allows the user to ask the 8-ball a question and receive an answer. The question must end in a..."
|
||||
url="/bot/reference/telegram/fun/8ball"
|
||||
/>
|
||||
<ReferenceCard
|
||||
title="flip"
|
||||
description="This command allows the user to simulate a coin flip displaying either a 'Heads' or 'Tails'."
|
||||
url="/bot/reference/telegram/fun/flip"
|
||||
/>
|
||||
<ReferenceCard
|
||||
title="urban"
|
||||
description="This command allows the user to search for a definition of a word on Urban Dictionary."
|
||||
url="/bot/reference/telegram/fun/urban"
|
||||
/>
|
||||
</ul>
|
||||
27
website/content/bot/reference/telegram/general/index.mdx
vendored
Normal file
27
website/content/bot/reference/telegram/general/index.mdx
vendored
Normal file
@@ -0,0 +1,27 @@
|
||||
# general
|
||||
|
||||
import ReferenceCard from "@site/src/components/General/ReferenceCard";
|
||||
|
||||
<ul className="grid grid-cols-1 md:grid-cols-2 lg:grid-cols-3 xl:grid-cols-4 gap-4 -ml-6">
|
||||
|
||||
<ReferenceCard
|
||||
title="futures"
|
||||
description="This command allows the user to retrieve futures prices on the stock market."
|
||||
url="/bot/reference/telegram/general/futures"
|
||||
/>
|
||||
<ReferenceCard
|
||||
title="news"
|
||||
description="This command allows the user to retrieve the latest news for a given ticker."
|
||||
url="/bot/reference/telegram/general/news"
|
||||
/>
|
||||
<ReferenceCard
|
||||
title="quote"
|
||||
description="This command allows the user to retrieve display quote stats for a stock - including the 52 week high/low, market..."
|
||||
url="/bot/reference/telegram/general/quote"
|
||||
/>
|
||||
<ReferenceCard
|
||||
title="ta"
|
||||
description="This command allows the user to retrieve a technical analysis summary for a given stock ticker. The summary..."
|
||||
url="/bot/reference/telegram/general/ta"
|
||||
/>
|
||||
</ul>
|
||||
22
website/content/bot/reference/telegram/government/index.mdx
vendored
Normal file
22
website/content/bot/reference/telegram/government/index.mdx
vendored
Normal file
@@ -0,0 +1,22 @@
|
||||
# government
|
||||
|
||||
import ReferenceCard from "@site/src/components/General/ReferenceCard";
|
||||
|
||||
<ul className="grid grid-cols-1 md:grid-cols-2 lg:grid-cols-3 xl:grid-cols-4 gap-4 -ml-6">
|
||||
|
||||
<ReferenceCard
|
||||
title="contracts"
|
||||
description="This command will allow the user to retrieve the top 15 government contracts by amount for a specific ticker."
|
||||
url="/bot/reference/telegram/government/contracts"
|
||||
/>
|
||||
<ReferenceCard
|
||||
title="house"
|
||||
description="This command allows the user to retrieve recent house trades for a specific ticker."
|
||||
url="/bot/reference/telegram/government/house"
|
||||
/>
|
||||
<ReferenceCard
|
||||
title="senate"
|
||||
description="This command allows a user to view the recent trades of senate members for a specific ticker."
|
||||
url="/bot/reference/telegram/government/senate"
|
||||
/>
|
||||
</ul>
|
||||
92
website/content/bot/reference/telegram/index.mdx
vendored
Normal file
92
website/content/bot/reference/telegram/index.mdx
vendored
Normal file
@@ -0,0 +1,92 @@
|
||||
# OpenBB Telegram Reference
|
||||
|
||||
import ReferenceCard from "@site/src/components/General/ReferenceCard";
|
||||
|
||||
<ul className="grid grid-cols-1 md:grid-cols-2 lg:grid-cols-3 xl:grid-cols-4 gap-4 -ml-6">
|
||||
|
||||
<ReferenceCard
|
||||
title="charts"
|
||||
description="c c15m c3m c5m cc cd chart chartfib chartsr cm cw"
|
||||
url="/bot/reference/telegram/charts"
|
||||
/>
|
||||
<ReferenceCard
|
||||
title="crypto"
|
||||
description="bigprints bio compfees defi fees ir prints top tvl"
|
||||
url="/bot/reference/telegram/crypto"
|
||||
/>
|
||||
<ReferenceCard
|
||||
title="darkpool"
|
||||
description="allblocks alldp allprints bigprintsdp levels sectors summary topsum"
|
||||
url="/bot/reference/telegram/darkpool"
|
||||
/>
|
||||
<ReferenceCard
|
||||
title="discovery"
|
||||
description="arktrades fgindex halts holidays ipolist pop trendingst wsb"
|
||||
url="/bot/reference/telegram/discovery"
|
||||
/>
|
||||
<ReferenceCard
|
||||
title="duediligence"
|
||||
description="ah analyst bio_stocks customer divinfo earnings ermove financials insiders instholdings nexter pm pt sec splits supplier ytd"
|
||||
url="/bot/reference/telegram/duediligence"
|
||||
/>
|
||||
<ReferenceCard
|
||||
title="economy"
|
||||
description="bonds calendar commodities currencies fedrates indices revrepo yieldcurve"
|
||||
url="/bot/reference/telegram/economy"
|
||||
/>
|
||||
<ReferenceCard
|
||||
title="etf"
|
||||
description="holdings tops"
|
||||
url="/bot/reference/telegram/etf"
|
||||
/>
|
||||
<ReferenceCard
|
||||
title="flow"
|
||||
description="bigflow sectorsflow summaryflow day open prem unu wk day exp top wk"
|
||||
url="/bot/reference/telegram/flow"
|
||||
/>
|
||||
<ReferenceCard
|
||||
title="fun"
|
||||
description="8ball flip urban"
|
||||
url="/bot/reference/telegram/fun"
|
||||
/>
|
||||
<ReferenceCard
|
||||
title="general"
|
||||
description="futures news quote ta"
|
||||
url="/bot/reference/telegram/general"
|
||||
/>
|
||||
<ReferenceCard
|
||||
title="government"
|
||||
description="contracts house senate"
|
||||
url="/bot/reference/telegram/government"
|
||||
/>
|
||||
<ReferenceCard
|
||||
title="info"
|
||||
description="about start"
|
||||
url="/bot/reference/telegram/info"
|
||||
/>
|
||||
<ReferenceCard
|
||||
title="nft"
|
||||
description="nftcollection nfttop"
|
||||
url="/bot/reference/telegram/nft"
|
||||
/>
|
||||
<ReferenceCard
|
||||
title="options"
|
||||
description="chains equitypc gamma highiv hist indexpc itm iv maxpain oi oichart opstats smile topoi topoichange topstrikevol topvol topvoletf unu uoastock vol vsurf"
|
||||
url="/bot/reference/telegram/options"
|
||||
/>
|
||||
<ReferenceCard
|
||||
title="overview"
|
||||
description="heatchart heatmap markets watchlist watchlist_add watchlist_remove"
|
||||
url="/bot/reference/telegram/overview"
|
||||
/>
|
||||
<ReferenceCard
|
||||
title="screeners"
|
||||
description="screener ah all pm"
|
||||
url="/bot/reference/telegram/screeners"
|
||||
/>
|
||||
<ReferenceCard
|
||||
title="short_data"
|
||||
description="borrowed hsi shortrate shortvol topshortvol"
|
||||
url="/bot/reference/telegram/short_data"
|
||||
/>
|
||||
</ul>
|
||||
17
website/content/bot/reference/telegram/info/index.mdx
vendored
Normal file
17
website/content/bot/reference/telegram/info/index.mdx
vendored
Normal file
@@ -0,0 +1,17 @@
|
||||
# info
|
||||
|
||||
import ReferenceCard from "@site/src/components/General/ReferenceCard";
|
||||
|
||||
<ul className="grid grid-cols-1 md:grid-cols-2 lg:grid-cols-3 xl:grid-cols-4 gap-4 -ml-6">
|
||||
|
||||
<ReferenceCard
|
||||
title="about"
|
||||
description="This command will provide users with a comprehensive overview of OpenBB Bot and links to our social media pages."
|
||||
url="/bot/reference/telegram/info/about"
|
||||
/>
|
||||
<ReferenceCard
|
||||
title="start"
|
||||
description="List of commands for OpenBB Bot."
|
||||
url="/bot/reference/telegram/info/start"
|
||||
/>
|
||||
</ul>
|
||||
17
website/content/bot/reference/telegram/nft/index.mdx
vendored
Normal file
17
website/content/bot/reference/telegram/nft/index.mdx
vendored
Normal file
@@ -0,0 +1,17 @@
|
||||
# nft
|
||||
|
||||
import ReferenceCard from "@site/src/components/General/ReferenceCard";
|
||||
|
||||
<ul className="grid grid-cols-1 md:grid-cols-2 lg:grid-cols-3 xl:grid-cols-4 gap-4 -ml-6">
|
||||
|
||||
<ReferenceCard
|
||||
title="nftcollection"
|
||||
description="This command retrieves a collection of Non-Fungible Token (NFT) data associated with the specified slug. It..."
|
||||
url="/bot/reference/telegram/nft/nftcollection"
|
||||
/>
|
||||
<ReferenceCard
|
||||
title="nfttop"
|
||||
description="This command allows users to retrieve the top NFT collections from Ethereum. It provides a list of the most..."
|
||||
url="/bot/reference/telegram/nft/nfttop"
|
||||
/>
|
||||
</ul>
|
||||
117
website/content/bot/reference/telegram/options/index.mdx
vendored
Normal file
117
website/content/bot/reference/telegram/options/index.mdx
vendored
Normal file
@@ -0,0 +1,117 @@
|
||||
# options
|
||||
|
||||
import ReferenceCard from "@site/src/components/General/ReferenceCard";
|
||||
|
||||
<ul className="grid grid-cols-1 md:grid-cols-2 lg:grid-cols-3 xl:grid-cols-4 gap-4 -ml-6">
|
||||
|
||||
<ReferenceCard
|
||||
title="chains"
|
||||
description="This command allows users to retrieve Options Chain by Expiry, which gives an overview of the bid, ask, and open..."
|
||||
url="/bot/reference/telegram/options/chains"
|
||||
/>
|
||||
<ReferenceCard
|
||||
title="equitypc"
|
||||
description="This command retrieves the Equity Put/Call Volume Ratio from market-harmonics.com. This ratio is used to measure..."
|
||||
url="/bot/reference/telegram/options/equitypc"
|
||||
/>
|
||||
<ReferenceCard
|
||||
title="gamma"
|
||||
description="This command allows the user to view the Options Gamma Levels for a particular stock. Options Gamma Levels are..."
|
||||
url="/bot/reference/telegram/options/gamma"
|
||||
/>
|
||||
<ReferenceCard
|
||||
title="highiv"
|
||||
description="This command retrieves the 15 highest IV30 equity stocks by 30 day Implied Volatility. The IV30 metric is a..."
|
||||
url="/bot/reference/telegram/options/highiv"
|
||||
/>
|
||||
<ReferenceCard
|
||||
title="hist"
|
||||
description="This command allows the user to retrieve the historical price of options for the given parameters of a ticker,..."
|
||||
url="/bot/reference/telegram/options/hist"
|
||||
/>
|
||||
<ReferenceCard
|
||||
title="indexpc"
|
||||
description="This command allows the user to retrieve the Index Put/Call Ratio for the market from market-harmonics.com. This..."
|
||||
url="/bot/reference/telegram/options/indexpc"
|
||||
/>
|
||||
<ReferenceCard
|
||||
title="itm"
|
||||
description="This command allows the user to retrieve a list of In-the-Money options for the stock ticker symbol sorted by..."
|
||||
url="/bot/reference/telegram/options/itm"
|
||||
/>
|
||||
<ReferenceCard
|
||||
title="iv"
|
||||
description="This command allows the user to quickly and easily retrieve various option information (volatility, IV rank,..."
|
||||
url="/bot/reference/telegram/options/iv"
|
||||
/>
|
||||
<ReferenceCard
|
||||
title="maxpain"
|
||||
description="This command retrieves the Max Pain on expiration date for a given stock. Max Pain is the strike price with the..."
|
||||
url="/bot/reference/telegram/options/maxpain"
|
||||
/>
|
||||
<ReferenceCard
|
||||
title="oi"
|
||||
description="This command allows the user to retrieve the Open Interest and Call/Put ratio for a given stock. Optionally, the..."
|
||||
url="/bot/reference/telegram/options/oi"
|
||||
/>
|
||||
<ReferenceCard
|
||||
title="oichart"
|
||||
description="This command allows users to retrieve a chart of Total Open Interest by Strike Price for the given ticker symbol...."
|
||||
url="/bot/reference/telegram/options/oichart"
|
||||
/>
|
||||
<ReferenceCard
|
||||
title="opstats"
|
||||
description="This command allows the user to quickly and easily retrieve various option information (volatility, IV rank,..."
|
||||
url="/bot/reference/telegram/options/opstats"
|
||||
/>
|
||||
<ReferenceCard
|
||||
title="smile"
|
||||
description="This command allows the user to retrieve the Options Volatility Smile for the given ticker and expiry. The..."
|
||||
url="/bot/reference/telegram/options/smile"
|
||||
/>
|
||||
<ReferenceCard
|
||||
title="topoi"
|
||||
description="This command allows the user to retrieve Top Open Interest among all stocks. This command queries the current..."
|
||||
url="/bot/reference/telegram/options/topoi"
|
||||
/>
|
||||
<ReferenceCard
|
||||
title="topoichange"
|
||||
description="This command allows the user to view the top 15 stocks with the highest OI Change. It will display the stock..."
|
||||
url="/bot/reference/telegram/options/topoichange"
|
||||
/>
|
||||
<ReferenceCard
|
||||
title="topstrikevol"
|
||||
description="This command allows the user to retrieve the top option strike by volume for a given security with the ability to..."
|
||||
url="/bot/reference/telegram/options/topstrikevol"
|
||||
/>
|
||||
<ReferenceCard
|
||||
title="topvol"
|
||||
description="This command allows the user to retrieve the Top 15 Highest stock options volumes by adding the call and put..."
|
||||
url="/bot/reference/telegram/options/topvol"
|
||||
/>
|
||||
<ReferenceCard
|
||||
title="topvoletf"
|
||||
description="This command allows the user to retrieve the Top 15 Highest ETF options volumes by adding the call and put volume..."
|
||||
url="/bot/reference/telegram/options/topvoletf"
|
||||
/>
|
||||
<ReferenceCard
|
||||
title="unu"
|
||||
description="This command allows a user to retrieve unusual options sorted by strike and expiration. It provides a list of the..."
|
||||
url="/bot/reference/telegram/options/unu"
|
||||
/>
|
||||
<ReferenceCard
|
||||
title="uoastock"
|
||||
description="This command allows the user to retrieve the 20-day average options volume by ticker. The volume is based on the..."
|
||||
url="/bot/reference/telegram/options/uoastock"
|
||||
/>
|
||||
<ReferenceCard
|
||||
title="vol"
|
||||
description="This command allows the user to retrieve a chart of Options Volume by Strike for a specified ticker. This data..."
|
||||
url="/bot/reference/telegram/options/vol"
|
||||
/>
|
||||
<ReferenceCard
|
||||
title="vsurf"
|
||||
description="This command allows the user to retrieve an options volatility surface for the ticker symbol. Specifically, it..."
|
||||
url="/bot/reference/telegram/options/vsurf"
|
||||
/>
|
||||
</ul>
|
||||
37
website/content/bot/reference/telegram/overview/index.mdx
vendored
Normal file
37
website/content/bot/reference/telegram/overview/index.mdx
vendored
Normal file
@@ -0,0 +1,37 @@
|
||||
# overview
|
||||
|
||||
import ReferenceCard from "@site/src/components/General/ReferenceCard";
|
||||
|
||||
<ul className="grid grid-cols-1 md:grid-cols-2 lg:grid-cols-3 xl:grid-cols-4 gap-4 -ml-6">
|
||||
|
||||
<ReferenceCard
|
||||
title="heatchart"
|
||||
description="This command allows the user to retrieve a Daily Market Heat Chart (15 minute delayed). The heat chart shows a..."
|
||||
url="/bot/reference/telegram/overview/heatchart"
|
||||
/>
|
||||
<ReferenceCard
|
||||
title="heatmap"
|
||||
description="This command allows the user to retrieve Daily Heat Maps by Market and Sector. The Daily Heat Maps will allow the..."
|
||||
url="/bot/reference/telegram/overview/heatmap"
|
||||
/>
|
||||
<ReferenceCard
|
||||
title="markets"
|
||||
description="This command allows the user to retrieve a markets overview which provides a quick summary of current market..."
|
||||
url="/bot/reference/telegram/overview/markets"
|
||||
/>
|
||||
<ReferenceCard
|
||||
title="watchlist"
|
||||
description="This command allows the user to retrieve an overview of their watchlist, which includes the current price,..."
|
||||
url="/bot/reference/telegram/overview/watchlist"
|
||||
/>
|
||||
<ReferenceCard
|
||||
title="watchlist_add"
|
||||
description="This command allows the user to add a stock or stocks to their watchlist."
|
||||
url="/bot/reference/telegram/overview/watchlist_add"
|
||||
/>
|
||||
<ReferenceCard
|
||||
title="watchlist_remove"
|
||||
description="This command allows the user to remove a stock from their watchlist."
|
||||
url="/bot/reference/telegram/overview/watchlist_remove"
|
||||
/>
|
||||
</ul>
|
||||
17
website/content/bot/reference/telegram/screeners/index.mdx
vendored
Normal file
17
website/content/bot/reference/telegram/screeners/index.mdx
vendored
Normal file
@@ -0,0 +1,17 @@
|
||||
# screeners
|
||||
|
||||
import ReferenceCard from "@site/src/components/General/ReferenceCard";
|
||||
|
||||
<ul className="grid grid-cols-1 md:grid-cols-2 lg:grid-cols-3 xl:grid-cols-4 gap-4 -ml-6">
|
||||
|
||||
<ReferenceCard
|
||||
title="scr"
|
||||
description="ah all pm"
|
||||
url="/bot/reference/telegram/screeners/scr"
|
||||
/>
|
||||
<ReferenceCard
|
||||
title="screener"
|
||||
description="This command allows the user to retrieve stock screener results according to the chosen technical signal."
|
||||
url="/bot/reference/telegram/screeners/screener"
|
||||
/>
|
||||
</ul>
|
||||
32
website/content/bot/reference/telegram/short_data/index.mdx
vendored
Normal file
32
website/content/bot/reference/telegram/short_data/index.mdx
vendored
Normal file
@@ -0,0 +1,32 @@
|
||||
# short_data
|
||||
|
||||
import ReferenceCard from "@site/src/components/General/ReferenceCard";
|
||||
|
||||
<ul className="grid grid-cols-1 md:grid-cols-2 lg:grid-cols-3 xl:grid-cols-4 gap-4 -ml-6">
|
||||
|
||||
<ReferenceCard
|
||||
title="borrowed"
|
||||
description="This command allows the user to view the history of borrowed shares available and fees associated with the stock..."
|
||||
url="/bot/reference/telegram/short_data/borrowed"
|
||||
/>
|
||||
<ReferenceCard
|
||||
title="hsi"
|
||||
description="This command retrieves the top high short interest stocks over a 20% ratio. This information can let an investor..."
|
||||
url="/bot/reference/telegram/short_data/hsi"
|
||||
/>
|
||||
<ReferenceCard
|
||||
title="shortrate"
|
||||
description="This command allows the user to retrieve the Display Short Shares spot borrow rate from Interactive Brokers for..."
|
||||
url="/bot/reference/telegram/short_data/shortrate"
|
||||
/>
|
||||
<ReferenceCard
|
||||
title="shortvol"
|
||||
description="This command allows the user to retrieve a graph of the 30 day history of the short volume versus the total..."
|
||||
url="/bot/reference/telegram/short_data/shortvol"
|
||||
/>
|
||||
<ReferenceCard
|
||||
title="topshortvol"
|
||||
description="This command allows the user to retrieve the Top 15 Short Interest Stocks per Finra. It's typically measured as a..."
|
||||
url="/bot/reference/telegram/short_data/topshortvol"
|
||||
/>
|
||||
</ul>
|
||||
Reference in New Issue
Block a user