diff options
author | Andrew <andrew.kenreich@gmail.com> | 2023-11-01 13:53:18 -0400 |
---|---|---|
committer | GitHub <noreply@github.com> | 2023-11-01 17:53:18 +0000 |
commit | 478fd5ec2d6fcbc4bdc2e8a8f5f8263807970df9 (patch) | |
tree | ed306e7123b028885cf5c28fc3010c7dd7f78a2d | |
parent | b9c70ecdf410822a07bf2fa002fcebd20c4f6808 (diff) |
fix docs (#5646)
39 files changed, 1825 insertions, 85 deletions
diff --git a/website/content/bot/reference/discord/alerts/index.mdx b/website/content/bot/reference/discord/alerts/index.mdx new file mode 100644 index 00000000000..022b3069ac9 --- /dev/null +++ b/website/content/bot/reference/discord/alerts/index.mdx @@ -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> diff --git a/website/content/bot/reference/discord/autopost/index.mdx b/website/content/bot/reference/discord/autopost/index.mdx new file mode 100644 index 00000000000..34b19072200 --- /dev/null +++ b/website/content/bot/reference/discord/autopost/index.mdx @@ -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> diff --git a/website/content/bot/reference/discord/charts/index.mdx b/website/content/bot/reference/discord/charts/index.mdx new file mode 100644 index 00000000000..b4e0b66bcf1 --- /dev/null +++ b/website/content/bot/reference/discord/charts/index.mdx @@ -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> diff --git a/website/content/bot/reference/discord/crypto/index.mdx b/website/content/bot/reference/discord/crypto/index.mdx new file mode 100644 index 00000000000..699b20dca51 --- /dev/null +++ b/website/content/bot/reference/discord/crypto/index.mdx @@ -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> diff --git a/website/content/bot/reference/discord/darkpool/index.mdx b/website/content/bot/reference/discord/darkpool/index.mdx new file mode 100644 index 00000000000..999aef99447 --- /dev/null +++ b/website/content/bot/reference/discord/darkpool/index.mdx @@ -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> diff --git a/website/content/bot/reference/discord/discovery/index.mdx b/website/content/bot/reference/discord/discovery/index.mdx new file mode 100644 index 00000000000..3eb71a4f48d --- /dev/null +++ b/website/content/bot/reference/discord/discovery/index.mdx @@ -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> diff --git a/website/content/bot/reference/discord/duedilligence/index.mdx b/website/content/bot/reference/discord/duedilligence/index.mdx new file mode 100644 index 00000000000..b9086104264 --- /dev/null +++ b/website/content/bot/reference/discord/duedilligence/index.mdx @@ -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> diff --git a/website/content/bot/reference/discord/economy/index.mdx b/website/content/bot/reference/discord/economy/index.mdx new file mode 100644 index 00000000000..d071282690b --- /dev/null +++ b/website/content/bot/reference/discord/economy/index.mdx @@ -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" +/> |