# Welcome Stock bot is one of the fastest way to view stock markets, cryptocurrencies and your investments through Discord ## Welcome to Stock's Documentation! Stock is a bot where you can retrieve real-time stock quotes within seconds. You can also set price alerts to inform you when a ticker of your choice goes above or below a predetermined price, or you can create a price channel that changes the title of a Discord channel to the ticker and the price of a stock you would like to follow. Stock can do this and much more! ## Get started in under a minute! In order to quickly setup Stock bot you can view the step by step instructions by clicking [here](/usage/getting-started). If you have any questions/concerns about Stock visit the support server [here](https://dsc.gg/stocksupport). #### Have any other questions/suggestions? Please email # Getting Started A quick start guide for setting up Stock! ## How do I invite Stock to my Discord server? In order to invite Stock to your Discord server you must click [here ](https://dsc.gg/stockbot)and follow the instructions provided. ## Already have Stock added to your server? Great! Now that you have Stock added to your server you can finally start using it. If you would like to know what all Stock has to offer you can view all the available commands by clicking [here](/usage/commands). # Commands You can view all available commands for Stock here! {% hint style="warning" %} If a parameter is in (parenthesis) it is required, but if a parameter is in \ the parameter is optional. {% endhint %} ## Stock Market | Usage | Description | Example | | -------------------------------- | ----------------------------------------------- | ------------------ | | quote (ticker) | Provides a detailed quote for the chosen ticker | quote AAPL | | float (ticker) | Provides float data for the given ticker | float HD | | sum (ticker) | Provides a summary for the chosen ticker | sum GME | | chart (ticker) \ | Provides a chart for the chosen ticker | chart LCID 1d macd | | list (indicator) | Shows the top gainers/losers for the day | list gainers | | sectors | View current sector performance | sectors | {% hint style="info" %} Available studies for the chart command are bb, bbr, bbw, crsi, ichi, ichimoku, macd, ma, ema, dema, tema, moonphase, pphl, pivotshl, rsi, stoch, stochrsi, williamr, lr, hma, chande, mf, ao, vwap, line Available intervals for the chart command are 1, 3, 5, 15, 30, 60, 120, 180, 240, 1m, 3m, 5m, 15m, 30m, 1h, 2h, 3h, 4h, 1d, d, day, daily, 1w, w, week, weekly, 1mo, m, mo, month, monthly {% endhint %} ## Options | Usage | Description | Example | | ------------------------------------------------- | ------------------------------------------------ | -------------------------------- | | options (symbol) | Provides options data for the chosen stock | options CCIV20211217C00017500 | | options (ticker) (exp date) (type) (strike price) | Provides options data given different parameters | options AAPL 2023-01-20 call 170 | ## News | Usage | Description | Example | | ----------------------------------------- | ------------------------------------------------------------ | ---------------------- | | news (ticker) | Provides recent news articles based off of the chosen ticker | news AAPL | | sec (ticker) | Provides recent sec filings for the chosen company | sec AMC | | halts | View current trading halts | halts | | cpi \ | Provides a historical consumer price index chart | cpi | | ipo (timeframe) | View upcoming and current IPOs | ipo upcoming | | stocktwits (type) (user or symbol's name) | View recent StockTwits posts | stocktwits symbol AAPL | {% hint style="info" %} Valid parameters for the CPI command are percent, percentage, %, 10y, 9y, 8y, 7y, 6y, 5y, 4y, 3y, 2y, 1y {% endhint %} ## Portfolio | Usage | Description | Example | | ------------------------------------------ | --------------------------------------------------------- | -------------------- | | portfolio add (ticker) \ \ | Adds the selected amount of shares to your portfolio | portfolio add AMC | | portfolio remove (ticker) \ | Removes the selected amount of shares from your portfolio | portfolio remove AMC | | portfolio reset | Removes all tickers from your portfolio | portfolio reset | | portfolio | View all of your current positions | $portfolio | ## Price Alerts {% hint style="info" %} You can use the price alert command Stock's direct messages and the bot will direct message you once the alert has been filled {% endhint %} | Usage | Description | Example | | --------------------------------------------- | ------------------------------------------ | ------------------ | | alert set (ticker) (strike price) \ | Create a price alert for the chosen ticker | alert set AAPL 150 | | alert del (ticker) (strike price) | Delete a price alert | alert del AAPL 150 | | $alerts reset | Deletes all of your current price alerts | $alerts reset | | $alerts | View all of your current price alerts | $alerts | ## Price Channels | Usage | Description | Example | | --------------------------------------------------- | ------------------------------------------------------------------------------------- | --------------------------- | | channel set (ticker) \ | Creates a Discord channel that updates every time the chosen ticker price has changed | channel set AAPL | | channel remove (channel ticker) (disconnect/delete) | Remove one of your price channels | channel del AAPL disconnect | | channel nick (channel ticker) (nickname) | Give your price channel a custom nickname | channel nick aapl apple | | channels | View all current price channels you have setup | channels | ## Stock Satellites | Usage | Description | Example | | ---------------------- | --------------------------------------------------- | ------------------ | | satellite set (ticker) | Sets the bots nickname to the chosen ticker's price | satellite set AAPL | | satellite delete | Remove the bots current custom satellite | satellite del | ## Patreon Usage | Usage | Description | Example | | --------------- | ----------------------------------------------------------------------------------------- | ---------------------------------- | | activate | Recieve your Patreon perks | activate | | activate server | Give the server that the command has been used in Patreon benefits according to your tier | activate server | | activate view | View all of your Patreon enabled servers | activate view | | activate delete | Remove a Patreon servers benefits | activate delete 700113101353123923 | ## Utility | Usage | Description | Example | | -------------- | ---------------------------- | ----------------------- | | suggest (idea) | Suggest ideas or report bugs | suggest super cool idea | # FAQ View all frequently asked questions here! ## How do I add the bot to my server? You can use the invite link found [here](https://dsc.gg/stockbot). Also make sure you are logged into the correct Discord account on your browser as well. ## Why doesn't the bot work in certain channels? If this is happening to you the bot does not have the correct permissions, and to allow the bot to work in certain channels you need to enable the administrator privilege under its provided role. ## Does the bot support cryptocurrencies? Yes, it does. For example, Bitcoin's ticker is "BTC-USD" or you can alternatively use "bitcoin" # Terms of Service WHEREAS, “Stock” is a Discord bot that provides real-time stock quotes and services related to the stock market to users WHEREAS, “MarketAspect” is the entity responsible for ownership and maintenance of Stock ## Changes to the terms of service MarketAspect reserves all rights to change the terms of service at any time. If you decide to keep using our services you are signifying that you agree to the new terms and conditions. The last modification made to the Terms of Service was on May 16, 2021. ## Changes to MarketAspect All services that MarketAspect provide are subject to change without notice. ## Use of Stock Any service that we provide cannot be reused for profit and/or redistribution without explicit permission from MarketAspect. You may not use the data provided by Stock illegally. If you fail to comply with any of these terms your access to Stock may be subject to termination without prior notice. ## Content Any content or service provided by MarketAspect may not be redistributed without explicit permission from MarketAspect. Certain content such as price alerts, custom portfolios, and custom stock nicknames are made available through supporting MarketAspect via Patreon. ## Feedback disclaimer By submitting feedback to MarketAspect you agree that you are not entitled to any incentive. ## Information disclaimer Marketaspect is not liable for any capital loss or misinformation caused by any of our services or products. Marketaspect does not guarantee the accuracy of the data provided by our services. # Privacy Policy WHEREAS, “Stock” is a Discord bot that provides real-time stock quotes and services related to the stock market to users WHEREAS, “MarketAspect” is the entity responsible for ownership and maintenance of Stock ## Changes to the Privacy Policy MarketAspect reserves all rights to change the Privacy Policy at any time. If you decide to keep using our services you are signifying that you agree to the new Privacy Policy. The last modification made to the Privacy Policy was on May 17, 2021. ## Data that Stock collects Stock collects anonymous statistical information, which includes but is not limited to; the amount of times a certain stock ticker was used, how many price alerts are set for each user, and how many stock channels are set in total. ## Data disclaimer MarketAspect reserves the right to erase any of your data without prior notice. Any stock ticker that you may submit to Stock will be shared to 3rd party services but only to fulfill any information that you request. By using MarketAspect's services you are agreeing to the Privacy Policy. # About ## Data Providers * [Yahoo Finance](https://finance.yahoo.com/) * [IEX Cloud](https://iexcloud.io/) * [TradingView](https://www.tradingview.com/) * [Coingecko](https://www.coingecko.com/en) * [Finnhub](https://finnhub.io/)