mirror of
https://github.com/OpenBB-finance/OpenBB.git
synced 2026-10-30 22:11:55 +00:00
Move documentation to openbb-docs (#6539)
* Remove website/ directory * Remove GitHub pages deployment workflow * Update documentation related content * Cannot do this now * Update actions url
This commit is contained in:
montezdesousa
5
.github/labeler.yml
vendored
5
.github/labeler.yml
vendored
@@ -18,13 +18,10 @@ labels:
|
||||
- label: "bug"
|
||||
branch: "^bugfix/.*"
|
||||
|
||||
- label: "docs"
|
||||
branch: "^docs/.*"
|
||||
|
||||
- label: "excel"
|
||||
files:
|
||||
- "website/content/excel/.*"
|
||||
|
||||
|
||||
- label: "breaking_change"
|
||||
files:
|
||||
- "openbb_platform/core/openbb_core/provider/standard_models/.*"
|
||||
|
||||
105
.github/workflows/deploy-gh-pages.yml
vendored
105
.github/workflows/deploy-gh-pages.yml
vendored
@@ -1,105 +0,0 @@
|
||||
name: 📑 Deploy to GitHub Pages
|
||||
|
||||
on:
|
||||
push:
|
||||
branches:
|
||||
- main
|
||||
- release/*
|
||||
- "docs/*"
|
||||
pull_request:
|
||||
types: [opened, synchronize, reopened, closed]
|
||||
branches:
|
||||
- main
|
||||
- "docs/*"
|
||||
|
||||
concurrency:
|
||||
group: ${{ github.workflow }}-${{ github.ref }}
|
||||
cancel-in-progress: true
|
||||
|
||||
jobs:
|
||||
generate:
|
||||
name: Generate and Deploy documentation
|
||||
if: >
|
||||
github.event_name == 'push' ||
|
||||
(github.event_name == 'pull_request' &&
|
||||
startsWith(github.head_ref, 'docs/'))
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: Git checkout
|
||||
uses: actions/checkout@v3 # actions/checkout v3.0.2
|
||||
|
||||
- name: Setup Python 3.9
|
||||
uses: actions/setup-python@v4
|
||||
with:
|
||||
python-version: "3.9"
|
||||
architecture: x64
|
||||
|
||||
- name: Install Poetry
|
||||
uses: snok/install-poetry@v1
|
||||
with:
|
||||
version: 1.8.1
|
||||
virtualenvs-create: true
|
||||
virtualenvs-in-project: true
|
||||
|
||||
- name: Setup sudo apt installs for ubuntu-latest
|
||||
run: |
|
||||
sudo apt-get update
|
||||
sudo apt-get install -y \
|
||||
libgtk-3-dev \
|
||||
libwebkit2gtk-4.0-dev
|
||||
|
||||
- name: Generate Platform Markdown
|
||||
run: |
|
||||
poetry install -C openbb_platform --no-interaction
|
||||
source openbb_platform/.venv/bin/activate
|
||||
pip install -U poetry
|
||||
pip install toml
|
||||
python openbb_platform/dev_install.py -e all
|
||||
python -c "import openbb; openbb.build()"
|
||||
python website/generate_platform_v4_markdown.py
|
||||
|
||||
- name: Generate Excel Docs
|
||||
run: |
|
||||
pip install requests
|
||||
python website/generate_excel_markdown.py
|
||||
|
||||
- name: Generate Widgets Library
|
||||
run: |
|
||||
pip install requests
|
||||
python website/generate_widgets_library.py
|
||||
|
||||
- name: Setup Node
|
||||
uses: actions/setup-node@v3
|
||||
with:
|
||||
node-version: 18
|
||||
cache: yarn
|
||||
cache-dependency-path: website/yarn.lock
|
||||
|
||||
- name: Install dependencies
|
||||
run: yarn install
|
||||
working-directory: website
|
||||
|
||||
- name: Build website
|
||||
run: yarn build
|
||||
working-directory: website
|
||||
|
||||
# Popular action to deploy to GitHub Pages:
|
||||
# Docs: https://github.com/peaceiris/actions-gh-pages#%EF%B8%8F-docusaurus
|
||||
- name: Deploy to GitHub Pages
|
||||
uses: peaceiris/actions-gh-pages@v3
|
||||
if: >
|
||||
(startsWith(github.ref, 'refs/heads/main')) ||
|
||||
(github.event_name == 'pull_request' &&
|
||||
github.event.pull_request.merged == true &&
|
||||
github.event.pull_request.base.ref == 'main' &&
|
||||
startsWith(github.head_ref, 'docs/'))
|
||||
with:
|
||||
github_token: ${{ secrets.DEPLOY_TOKEN }}
|
||||
publish_dir: ./website/build
|
||||
# The following lines assign commit authorship to the official
|
||||
# GH-Actions bot for deploys to `gh-pages` branch:
|
||||
# https://github.com/actions/checkout/issues/13#issuecomment-724415212
|
||||
# The GH actions bot is used by default if you didn't specify the two fields.
|
||||
# You can swap them out with your own user credentials.
|
||||
user_name: github-actions[bot]
|
||||
user_email: 41898282+github-actions[bot]@users.noreply.github.com
|
||||
4
build/pypi/openbb_platform/PUBLISH.md
vendored
4
build/pypi/openbb_platform/PUBLISH.md
vendored
@@ -67,7 +67,7 @@
|
||||
> Also, sometimes there might be some delay in the PyPI API, so it might be necessary to wait a few minutes before publishing the next package.
|
||||
|
||||
2. Merge the `release/<package>-<version>` branch to the `main` branch.
|
||||
3. Check the `Deploy to GitHub Pages` GitHub action is completed successfully. Go to the [docs](https://docs.openbb.co) website to see the changes.
|
||||
3. Run the `Deploy to GitHub Pages` action in [openbb-docs](https://github.com/OpenBB-finance/openbb-docs/actions). Go to the [docs](https://docs.openbb.co) website to see the changes.
|
||||
|
||||
## Post-release procedure
|
||||
|
||||
@@ -87,4 +87,4 @@
|
||||
### Publish the CLI
|
||||
|
||||
1. Bump `openbb` dependency on `cli/pyproject.toml` to the latest version.
|
||||
2. Run `poetry publish --build` from `cli`
|
||||
2. Run `poetry publish --build` from `cli`
|
||||
|
||||
26
website/.gitignore
vendored
26
website/.gitignore
vendored
@@ -1,26 +0,0 @@
|
||||
# Dependencies
|
||||
/node_modules
|
||||
|
||||
# Production
|
||||
/build
|
||||
|
||||
# Generated files
|
||||
.docusaurus
|
||||
.cache-loader
|
||||
|
||||
# Misc
|
||||
.DS_Store
|
||||
.env.local
|
||||
.env.development.local
|
||||
.env.test.local
|
||||
.env.production.local
|
||||
|
||||
npm-debug.log*
|
||||
yarn-debug.log*
|
||||
yarn-error.log*
|
||||
|
||||
# Reference files
|
||||
content/excel/reference/*
|
||||
content/excel/reference/*/*
|
||||
content/platform/data_models/*
|
||||
content/platform/reference/*
|
||||
1
website/CNAME
vendored
1
website/CNAME
vendored
@@ -1 +0,0 @@
|
||||
docs.openbb.co
|
||||
140
website/README.md
vendored
140
website/README.md
vendored
@@ -1,140 +0,0 @@
|
||||
# OpenBB Documentation Website
|
||||
|
||||
This repository contains the source code for the OpenBB Documentation Website.
|
||||
|
||||
The website was built using [Docusaurus](https://docusaurus.io/), a modern static website generator and [TailwindCSS](https://tailwindcss.com) as styling solution. It uses algolia search for the search bar.
|
||||
The final website can be found at [https://docs.openbb.co](https://docs.openbb.co).
|
||||
|
||||
## Folder Structure
|
||||
|
||||
```bash
|
||||
website
|
||||
├── content # Markdown files
|
||||
| ├── sdk # SDK markdown files
|
||||
| ├── bot # bot markdown files
|
||||
| ├── platform # platform markdown files
|
||||
| └── terminal # Terminal markdown files
|
||||
├── src # react stuff for website
|
||||
├── static # Static files
|
||||
├── generate_sdk_markdown.py # Script to generate markdown files for SDK
|
||||
└── generate_terminal_markdown.py # Script to generate markdown files for Terminal
|
||||
```
|
||||
|
||||
### Markdown files
|
||||
|
||||
The markdown files are used to generate the website. The markdown files are located in the `content` folder. The markdown files are generated using the `generate_sdk_markdown.py` and `generate_terminal_markdown.py` scripts. The markdown files are generated from the docstrings in the SDK and Terminal code. Files inside `content/sdk/reference` and `content/terminal/reference` should not be changed manually because they are generated automatically on every commit.
|
||||
|
||||
### Syntax sugar
|
||||
|
||||
#### Code blocks
|
||||
|
||||
Code blocks are generated using the default markdown syntax:
|
||||
|
||||
```python
|
||||
print("Hello World")
|
||||
```
|
||||
|
||||
To generate a dynamic date for a certain code block (useful for options examples that need to have a valid date), you can use `2022-07-29` as a placeholder. The script will replace it with the third friday of the next month.
|
||||
|
||||
```txt
|
||||
/op oichart ticker:AMD expiry:2022-07-29
|
||||
```
|
||||
|
||||
#### Available options
|
||||
|
||||
This is great for huge lists. It opens a popup that contains the list and the search bar, so you can easily find what you are looking for. Everything is virtualized, so it's always fast no matter how many items you have.
|
||||
Check [crypto page](https://docs.openbb.co/bot/discord/crypto) for a demo of this component.
|
||||
|
||||
```md
|
||||
import AvailableOptions from "@site/src/components/General/AvailableOptions";
|
||||
|
||||
<AvailableOptions
|
||||
label="Exchanges"
|
||||
allOptions={[
|
||||
"aax",
|
||||
"ascendex",
|
||||
"bequant",
|
||||
"bibox",
|
||||
"bigone",
|
||||
"binance",
|
||||
"binancecoinm",
|
||||
"binanceus",
|
||||
"binanceusdm",
|
||||
"bit2c",
|
||||
"bitbank",
|
||||
"bitbay",
|
||||
"bitcoincom",
|
||||
"bitfinex",
|
||||
"bitfinex2",
|
||||
"bitflyer",
|
||||
"bitforex",
|
||||
"bitget",
|
||||
"bithumb",
|
||||
"bitmart",
|
||||
"bitmex",
|
||||
"bitopro",
|
||||
"bitpanda",
|
||||
"bitrue",
|
||||
"bitso",
|
||||
"bitstamp",
|
||||
"bitstamp1",
|
||||
"bittrex",
|
||||
"bitvavo",
|
||||
]}
|
||||
/>
|
||||
```
|
||||
|
||||
## Run locally
|
||||
|
||||
### Prerequisites
|
||||
|
||||
- [Node.js](https://nodejs.org/en/) >= 16.13.0
|
||||
To check if you have Node.js installed, run this command in your terminal:
|
||||
|
||||
```bash
|
||||
node --version # should be v16.13.0 or higher
|
||||
```
|
||||
|
||||
### Install dependencies
|
||||
|
||||
```bash
|
||||
npm install
|
||||
```
|
||||
|
||||
### Start development server
|
||||
|
||||
```bash
|
||||
npm start
|
||||
```
|
||||
|
||||
This command starts a local development server and open up a browser window in `http://localhost:3000`. Most changes are reflected live without having to restart the server.
|
||||
|
||||
### Build
|
||||
|
||||
```bash
|
||||
npm run build
|
||||
```
|
||||
|
||||
This command generates static content into the `build` directory and can be served using any static contents hosting service. We use Github Pages to host our website. It's deployed in the `gh-pages` branch.
|
||||
|
||||
## Run tests
|
||||
|
||||
```bash
|
||||
pytest tests/website --autodoc
|
||||
```
|
||||
|
||||
> If tests are run locally, the `--autodoc` flag is required, otherwise tests will be skipped.
|
||||
|
||||
> To install necessary dependencies for tests, run `poetry install -E doc` in the root directory of the repository.
|
||||
|
||||
## Notes
|
||||
|
||||
### iFrame
|
||||
|
||||
We are detecting whether the website is loaded inside an iframe. If it is, we are hiding the header and footer. This is done to have a better integration with our [hub website](https://my.openbb.co).
|
||||
|
||||
## Contributing
|
||||
|
||||
We welcome contributions to the OpenBB Documentation Website.
|
||||
|
||||
---
|
||||
3
website/babel.config.cjs
vendored
3
website/babel.config.cjs
vendored
@@ -1,3 +0,0 @@
|
||||
module.exports = {
|
||||
presets: [require.resolve('@docusaurus/core/lib/babel/preset')],
|
||||
};
|
||||
4
website/content/bot/_category_.json
vendored
4
website/content/bot/_category_.json
vendored
@@ -1,4 +0,0 @@
|
||||
{
|
||||
"label": "OpenBB Bot",
|
||||
"position": 3
|
||||
}
|
||||
@@ -1,4 +0,0 @@
|
||||
{
|
||||
"label": "Changelog",
|
||||
"position": 4
|
||||
}
|
||||
50
website/content/bot/changelog/index.mdx
vendored
50
website/content/bot/changelog/index.mdx
vendored
@@ -1,50 +0,0 @@
|
||||
---
|
||||
title: Changelog
|
||||
---
|
||||
import NewReferenceCard from "@site/src/components/General/NewReferenceCard";
|
||||
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
|
||||
|
||||
<HeadTitle title="Changelog | OpenBB Bot Docs" />
|
||||
|
||||
<ul className="grid grid-cols-1 gap-4 -ml-6">
|
||||
<NewReferenceCard
|
||||
title="Current - v2.0.0"
|
||||
url="changelog/version2_0_0"
|
||||
/>
|
||||
<NewReferenceCard
|
||||
title="v1.0.8"
|
||||
url="changelog/version1_0_8"
|
||||
/>
|
||||
<NewReferenceCard
|
||||
title="v1.0.7"
|
||||
url="changelog/version1_0_7"
|
||||
/>
|
||||
<NewReferenceCard
|
||||
title="v1.0.6"
|
||||
url="changelog/version1_0_6"
|
||||
/>
|
||||
<NewReferenceCard
|
||||
title="v1.0.5"
|
||||
url="changelog/version1_0_5"
|
||||
/>
|
||||
<NewReferenceCard
|
||||
title="v1.0.4"
|
||||
url="changelog/version1_0_4"
|
||||
/>
|
||||
<NewReferenceCard
|
||||
title="v1.0.3"
|
||||
url="changelog/version1_0_3"
|
||||
/>
|
||||
<NewReferenceCard
|
||||
title="v1.0.2"
|
||||
url="changelog/version1_0_2"
|
||||
/>
|
||||
<NewReferenceCard
|
||||
title="v1.0.1"
|
||||
url="changelog/version1_0_1"
|
||||
/>
|
||||
<NewReferenceCard
|
||||
title="v1.0.0"
|
||||
url="changelog/version1_0_0"
|
||||
/>
|
||||
</ul>
|
||||
34
website/content/bot/changelog/version1_0_0.mdx
vendored
34
website/content/bot/changelog/version1_0_0.mdx
vendored
@@ -1,34 +0,0 @@
|
||||
---
|
||||
title: v1.0.0
|
||||
version: "1.0.0"
|
||||
date: 2022-08-03
|
||||
description: v1.0.0
|
||||
sidebar_position: 9
|
||||
---
|
||||
|
||||
## Added
|
||||
|
||||
- Supports Discord
|
||||
- Charts menu including: chart, c3m, c5m, c15m, cd, cw, cm
|
||||
- Discovery menu including: contracts, senate, splits, fgindex, holidays, ipolist, fidelity, house
|
||||
- Due diligence menu including: ah, nexter, bio, pm, analyst, pt, est, sec, supplier, customer, instholdings, insiders, arktrades, splits, ermove, earnings
|
||||
- ETF menu including: tops, holdings
|
||||
- Economy menu including: calendar, glbonds, indices, commodiities, usbonds, currencies, revrepo, fedrates
|
||||
- General menu including: futures, ta, news, quote
|
||||
- Government menu including: contracts, senate, house
|
||||
- Information menu including: serverid, stats, support, about, help
|
||||
- Shorts menu including: borrowed, shortvol, topshortvol, hsi, shortrate
|
||||
- Screener menu including: ah, pm, all, technical
|
||||
- Premium Crypto menu including: prints, bigprints
|
||||
- Premium Darkpool menu including: allblocks, alldp, allprints, bigprints, levels. topsum, sectors, summary
|
||||
- Premium Flow menu including: sumexp, opening, unu, weekly, bigflow, prem, day, sumweek, sumtop, sectors, summary, sumday
|
||||
- Premium Stock Options including: equitypc, chains, oichart, indexpc, maxpain, stats, gamma, oi, topoichange, smile, info, unu, vol, topoi, vsurf, topvoletf, topstrikevol, topvol, itm, uoastock, hist, highiv
|
||||
- OpenBB Alerts including: list, create, update, delete
|
||||
|
||||
## Changed
|
||||
|
||||
- First release, no changes.
|
||||
|
||||
## Fixed
|
||||
|
||||
- First release, no fixes.
|
||||
21
website/content/bot/changelog/version1_0_1.mdx
vendored
21
website/content/bot/changelog/version1_0_1.mdx
vendored
@@ -1,21 +0,0 @@
|
||||
---
|
||||
title: v1.0.1
|
||||
version: "1.0.1"
|
||||
date: 2022-08-04
|
||||
description: v1.0.1
|
||||
sidebar_position: 8
|
||||
---
|
||||
|
||||
## Added
|
||||
|
||||
- Charts : new layout on charts "classic" theme - made this default
|
||||
- Discovery menu including: heatmap
|
||||
|
||||
## Changed
|
||||
|
||||
- Charts menu including: "classic" theme on charts
|
||||
|
||||
## Fixed
|
||||
|
||||
- Due diligence menu including : added ah and pm to ! commands
|
||||
- Premium Flow menu including : added weekly and opening to ! commands
|
||||
19
website/content/bot/changelog/version1_0_2.mdx
vendored
19
website/content/bot/changelog/version1_0_2.mdx
vendored
@@ -1,19 +0,0 @@
|
||||
---
|
||||
title: v1.0.2
|
||||
version: "1.0.2"
|
||||
date: 2022-08-05
|
||||
description: v1.0.2
|
||||
sidebar_position: 7
|
||||
---
|
||||
|
||||
## Added
|
||||
|
||||
- No changes
|
||||
|
||||
## Changed
|
||||
|
||||
- All Blue should now be Green - :)
|
||||
|
||||
## Fixed
|
||||
|
||||
- Futures Caching issue
|
||||
32
website/content/bot/changelog/version1_0_3.mdx
vendored
32
website/content/bot/changelog/version1_0_3.mdx
vendored
@@ -1,32 +0,0 @@
|
||||
---
|
||||
title: v1.0.3
|
||||
version: "1.0.3"
|
||||
date: 2022-08-12
|
||||
description: v1.0.3
|
||||
sidebar_position: 6
|
||||
---
|
||||
|
||||
## Added
|
||||
|
||||
Commands:
|
||||
- /chartfib
|
||||
- /disc wsb
|
||||
- /disc trendingst
|
||||
- /dd financials
|
||||
|
||||
You can run /help to see these.
|
||||
|
||||
## Changed
|
||||
|
||||
Chart Changes:
|
||||
- More Chart Style Settings changes - Should be almost done here
|
||||
- Sizing of chart is smaller now
|
||||
- Adjusted indicator opacity
|
||||
- Added AH change to chart
|
||||
- Made PM/AH/Price LARGER
|
||||
- Adjusted Candle Color to not be so bright on Green
|
||||
- Added Yest Close Line and fixed scaling
|
||||
|
||||
## Fixed
|
||||
|
||||
- PM Screener not getting correct data
|
||||
29
website/content/bot/changelog/version1_0_4.mdx
vendored
29
website/content/bot/changelog/version1_0_4.mdx
vendored
@@ -1,29 +0,0 @@
|
||||
---
|
||||
title: v1.0.4
|
||||
version: "1.0.4"
|
||||
date: 2022-08-16
|
||||
description: v1.0.4
|
||||
sidebar_position: 5
|
||||
---
|
||||
|
||||
## Added
|
||||
|
||||
Commands:
|
||||
- /dd divinfo
|
||||
- /dd ytd
|
||||
- /econ yieldcurve
|
||||
- /chartsr
|
||||
- /heatmap
|
||||
|
||||
You can run /help to see these.
|
||||
|
||||
## Changed
|
||||
|
||||
Changes:
|
||||
- old /heatmap is now /heatchart (makes more sense)
|
||||
- changed positioning of numbers on chartfib + expanding line
|
||||
- Added small candle border to Daily/Monthly/Weekly charts
|
||||
|
||||
## Fixed
|
||||
|
||||
- PM Screener not getting correct data - again...
|
||||
32
website/content/bot/changelog/version1_0_5.mdx
vendored
32
website/content/bot/changelog/version1_0_5.mdx
vendored
@@ -1,32 +0,0 @@
|
||||
---
|
||||
title: v1.0.5
|
||||
version: "1.0.5"
|
||||
date: 2022-08-30
|
||||
description: v1.0.5
|
||||
sidebar_position: 4
|
||||
---
|
||||
|
||||
## Added
|
||||
|
||||
Commands:
|
||||
- /pop 1d
|
||||
- /pop 1h
|
||||
- /watchlist - (Each user gets 3 stocks for free signup)
|
||||
- /heatmap crypto
|
||||
- /cc (for the quick c5m)
|
||||
- /fun urban
|
||||
- /fun flip
|
||||
- /fun 8ball
|
||||
|
||||
You can run /help to see these.
|
||||
|
||||
## Changed
|
||||
|
||||
Changes:
|
||||
- /alerts - Alerts have been refactored to include Stocks and Forex now
|
||||
- For most Flow and Darkpool commands you should now see much more data - Added Pages
|
||||
- Changed a few commands to be more mobile friendly - (TA - PM/AH Next update)
|
||||
|
||||
## Fixed
|
||||
- Chart bug with no PM data
|
||||
- "Change" column on one of the screeners
|
||||
27
website/content/bot/changelog/version1_0_6.mdx
vendored
27
website/content/bot/changelog/version1_0_6.mdx
vendored
@@ -1,27 +0,0 @@
|
||||
---
|
||||
title: v1.0.6
|
||||
version: "1.0.6"
|
||||
date: 2022-09-12
|
||||
description: v1.0.6
|
||||
sidebar_position: 3
|
||||
---
|
||||
|
||||
## Added
|
||||
|
||||
Commands:
|
||||
No changes
|
||||
|
||||
## Changed
|
||||
|
||||
### Charts
|
||||
- Candles should be easier to see now
|
||||
- Reduced gaps on candles
|
||||
- Charts should look more "zoomed"
|
||||
- Increased size of text in some areas
|
||||
### Tables
|
||||
- All text should be larger and easier to read for Mobile and Desktop
|
||||
- Tables will now use the same settings as your chart settings
|
||||
- Branding on charts is now consistent
|
||||
|
||||
## Fixed
|
||||
No changes
|
||||
41
website/content/bot/changelog/version1_0_7.mdx
vendored
41
website/content/bot/changelog/version1_0_7.mdx
vendored
@@ -1,41 +0,0 @@
|
||||
---
|
||||
title: v1.0.7
|
||||
version: "1.0.7"
|
||||
date: 2022-09-12
|
||||
description: v1.0.7
|
||||
sidebar_position: 2
|
||||
---
|
||||
|
||||
## Added
|
||||
|
||||
Commands:
|
||||
|
||||
### Stocks:
|
||||
- /markets - Provides a nice overview of the market with adv / decliners relative to change and 50d/200d MA
|
||||
- /scr pm_all - Displays all available pre-market screeners
|
||||
- /scr ah_all - Displays all available after-hours screeners
|
||||
|
||||
### Crypto:
|
||||
- /crypto tvl - Get protocols historical TVL.
|
||||
- /crypto defi table - Get top DeFi protocols
|
||||
- /crypto defi chart - Chart of top 20 defi protocols by TVL
|
||||
- /crypto top - Get top cryptos and info
|
||||
- /crypto bio - Get fundamental information about a crypto.
|
||||
- /crypto fees - Fees on a certain date of top crypto protocols
|
||||
- /crypto compfees - Get protocol fees over time.
|
||||
- /crypto ir - Returns a table of issuance rate of top crypto protocols.
|
||||
|
||||
### NFT:
|
||||
- /nft top - Get Top NFT Collections from Ethereum Chain
|
||||
- /nft collection - Get NFT collection data from Ethereum network for the specified slug.
|
||||
- /nft chart - Returns NFT chart for floor price and sales on the specified slug.
|
||||
|
||||
- REMOVE:
|
||||
- /fidelity - They made this so you have to be logged in now :(
|
||||
|
||||
## Changed
|
||||
No changes
|
||||
|
||||
## Fixed
|
||||
- Fixed small bug when saving watchlist
|
||||
- Adjusted some tickers sizing on charts
|
||||
18
website/content/bot/changelog/version1_0_8.mdx
vendored
18
website/content/bot/changelog/version1_0_8.mdx
vendored
@@ -1,18 +0,0 @@
|
||||
---
|
||||
title: v1.0.8
|
||||
version: "1.0.8"
|
||||
date: 2022-10-13
|
||||
description: v1.0.8
|
||||
sidebar_position: 1
|
||||
---
|
||||
|
||||
## Added
|
||||
|
||||
### Stocks
|
||||
- /scr technical - Added "Overbought" and "Oversold" to Screener - Calcs are based on RSI 14
|
||||
|
||||
## Changed
|
||||
- /flow day - Added ability to filter on - Expiration Date | Strike | Option Type - ex. "/flow day ticker:AMD expiry:2023-01-20 strike:75 opt_type:Calls"
|
||||
|
||||
## Fixed
|
||||
- No Changes
|
||||
30
website/content/bot/changelog/version2_0_0.mdx
vendored
30
website/content/bot/changelog/version2_0_0.mdx
vendored
@@ -1,30 +0,0 @@
|
||||
---
|
||||
title: Current - v2.0.0
|
||||
version: "2.0.0"
|
||||
date: 2022-10-26
|
||||
description: v2.0.0
|
||||
sidebar_position: 0
|
||||
---
|
||||
|
||||
## Added
|
||||
|
||||
### Telegram Support
|
||||
- OpenBB Bot is now available on telegram - you can add it <a href="https://openbb.co/bot-telegram" rel="noopener noreferrer" target="_blank" className="_hyper-link">here</a>
|
||||
|
||||
### Billboard Messages
|
||||
- With a premium server account you can now edit the billboard messages users see in your server. You can edit this on the [my.openbb.co](https://my.openbb.co) dash.
|
||||
|
||||
Commands:
|
||||
|
||||
|
||||
- /autopost add - Added Auto Posting to bot! (Finally :D ) You can now schedule autoposts for your server with a free server plan or premium plan
|
||||
|
||||
|
||||
## Changed
|
||||
|
||||
### Pricing
|
||||
- You can read more about the pricing change <a href="https://openbb.co/blog/openbb-bot-price-change" rel="noopener noreferrer" target="_blank" className="_hyper-link">here</a> - TLDR - It's cheaper now :)
|
||||
|
||||
## Fixed
|
||||
|
||||
No Changes
|
||||
103
website/content/bot/faqs.md
vendored
103
website/content/bot/faqs.md
vendored
@@ -1,103 +0,0 @@
|
||||
---
|
||||
title: FAQs
|
||||
sidebar_position: 5
|
||||
description:
|
||||
This page offers information about OpenBB Bot, covering topics such as
|
||||
linking your OpenBB Bot account, trying an OpenBB Bot plan, automatic plan renewals,
|
||||
refunds, access on different platforms, individual and server plans, and troubleshooting
|
||||
issues with slash commands.
|
||||
keywords:
|
||||
- OpenBB Bot
|
||||
- OpenBB Bot account
|
||||
- OpenBB plan
|
||||
- billing cycle
|
||||
- OpenBB Discord
|
||||
- server settings
|
||||
- integrations
|
||||
- refunds
|
||||
- subscription
|
||||
- individual plan
|
||||
- server plan
|
||||
- slash commands
|
||||
---
|
||||
|
||||
import HeadTitle from "@site/src/components/General/HeadTitle.tsx";
|
||||
|
||||
<HeadTitle title="FAQs | OpenBB Bot Docs" />
|
||||
|
||||
<details>
|
||||
<summary mdxType="summary">How Do I Link My OpenBB Bot Account?</summary>
|
||||
|
||||
After you signup for an OpenBB Bot plan you can link your accounts from <a href="https://my.openbb.co/app/bot" class="_hyper-link">here</a>
|
||||
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary mdxType="summary">Can I try an OpenBB Bot plan?</summary>
|
||||
|
||||
You can try a preview of any plan by just running commands on a server that has OpenBB Bot, like <a href='https://my.openbb.co/discord' class='_hyper-link'>OpenBB Discord</a>. We offer a limited amount of daily commands.
|
||||
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary mdxType="summary">Will my OpenBB Bot plan renew at the end of the billing cycle?</summary>
|
||||
|
||||
Yes, plans renew automatically at the end of the monthly and yearly billing cycles. You can cancel your plan at any time, before the end of the billing cycle, and it will not auto-renew anymore.
|
||||
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary mdxType="summary">Can I get a refund on my OpenBB Bot?</summary>
|
||||
|
||||
Since we offer a free command tier to try commands we don't offer refunds as you have had ample time to try the service and make a decision.
|
||||
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary mdxType="summary">If I sign up for OpenBB Bot do I get access on all platforms?</summary>
|
||||
|
||||
Yes! You will have access on Discord, and other platforms as we add support.
|
||||
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary mdxType="summary">If I cancel OpenBB Bot subscription do I still have access?</summary>
|
||||
|
||||
No, you will lose your access but you get a credit on your account of the prorated amount until the end of your current billing cycle.
|
||||
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary mdxType="summary">What's the difference between an individual plan and server plan on OpenBB Bot?</summary>
|
||||
|
||||
An individual plan gives your account access to OpenBB Bot while a server plan gives the whole server access. An individual plan carries more perks with it than a server plan, which you can find by clicking on the plan.
|
||||
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary mdxType="summary">I added the bot but still don't see slash commands, what do I do?</summary>
|
||||
|
||||
<img
|
||||
class="mb-8"
|
||||
src="https://assets-global.website-files.com/5f9072399b2640f14d6a2bf4/625ddbedd330d37960463537_Untitled.png"
|
||||
/>
|
||||
|
||||
Just head to <b>Server Settings → Integrations</b> and then <b>click ‘Manage’ next to an app</b>, where you will behold a new, shiny, and dare we say <i>dazzling</i>, new surface.
|
||||
|
||||
<ul class="list-disc my-4 ml-4">
|
||||
<li>Use toggles to modify which members can use commands</li>
|
||||
<li>Use toggles to modify which channels allow commands</li>
|
||||
</ul>
|
||||
|
||||
There’s also a command-specific list, where you can make customized permissions for each command.
|
||||
|
||||
<ul class="list-disc my-4 ml-4">
|
||||
<li>
|
||||
By default, these are all synced to the command permission at the top.
|
||||
</li>
|
||||
<li>You can unsync an individual command to make further customizations.</li>
|
||||
</ul>
|
||||
|
||||
For more information click <a rel="noreferrer noopener" target="_blank" href="https://discord.com/blog/slash-commands-permissions-discord-apps-bots" class="_hyper-link">here</a>.
|
||||
|
||||
</details>
|
||||
51
website/content/bot/index.md
vendored
51
website/content/bot/index.md
vendored
@@ -1,51 +0,0 @@
|
||||
---
|
||||
title: Introduction
|
||||
sidebar_position: 0
|
||||
description: OpenBB Bot - a chatbot providing access to high-quality financial data
|
||||
for both individual investors and online communities on Discord and Telegram. The
|
||||
bot provides actionable market data, including stock data, options, screeners, crypto,
|
||||
and more.
|
||||
keywords:
|
||||
- OpenBB Bot
|
||||
- chatting bot
|
||||
- Discord
|
||||
- Telegram
|
||||
- financial data
|
||||
- individual investors
|
||||
- online communities
|
||||
- stock data
|
||||
- options
|
||||
- screeners
|
||||
- darkpool info
|
||||
- crypto
|
||||
- nft
|
||||
- short data
|
||||
- market data
|
||||
- informed investors
|
||||
---
|
||||
|
||||
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
|
||||
|
||||
<HeadTitle title="OpenBB Bot Docs" />
|
||||
|
||||
Looking for investment research data and sharing it with your community has never been easier than with the OpenBB Bot. Our bot delivers high-quality data directly to your fingertips, promoting engagement and learning among your peers. Share your investment ideas and strategies with your friends and colleagues seamlessly by accessing the data you need through a simple text message. The OpenBB Bot is the perfect tool for collaborative investment research that helps you make informed decisions and achieve success.
|
||||
|
||||
<img width="819" alt="bot" src="https://github.com/OpenBB-finance/OpenBBTerminal/assets/25267873/f65788ea-cab6-40a2-a1d9-282051a27083" />
|
||||
|
||||
---
|
||||
|
||||
- **Investment discussions at 10x speed**
|
||||
|
||||
Say goodbye to the hassle of switching tabs or opening browsers just to share screenshots of market data with your friends. With the OpenBB Bot, you can access real-time market data instantly by using a simple bot command. Our bot allows you to visualize data easily within your preferred chatting platform, so you can keep up with the latest market trends without ever having to leave the chat window.
|
||||
|
||||
- **Chatting through multiple platforms**
|
||||
|
||||
Discover the power of the OpenBB Bot on Discord and Telegram, and stay tuned for new platform releases. We are always working to expand our reach, and are committed to bringing the OpenBB Bot to a wider audience. Our goal is to provide convenient access to investment research data for all users, and we are excited to announce that more platforms will be added in the near future. Keep an eye out for updates on new platform availability, and join us as we continue to revolutionize the way you access investment data.
|
||||
|
||||
- **Available on desktop, mobile or tablet**
|
||||
|
||||
By utilizing the chatting platform as the user interface, OpenBB Bot enables users access to investment research data on any device that is supported by the platform. This means that whether you are on your desktop, laptop, tablet, or smartphone, you can conveniently access the bot's research data without any additional software or hardware requirements. Enjoy seamless access to valuable investment insights across all your devices, anytime and anywhere.
|
||||
|
||||
- **Customizable for your community**
|
||||
|
||||
The OpenBB Bot provides users and server owners with the ability to personalize the bot according to their preferences. With a wide range of customization options, you can alter the color scheme, set up a watchlist, configure technical analysis indicators on your charts, and even schedule automatic market data posts. From market opening to closing, the OpenBB Bot has you covered with its flexible features and robust functionality.
|
||||
@@ -1,4 +0,0 @@
|
||||
{
|
||||
"label": "Installation",
|
||||
"position": 1
|
||||
}
|
||||
34
website/content/bot/installation/discord.md
vendored
34
website/content/bot/installation/discord.md
vendored
@@ -1,34 +0,0 @@
|
||||
---
|
||||
title: Discord bot
|
||||
sidebar_position: 2
|
||||
description: This page guides you on how to add a bot to your Discord server, through
|
||||
steps of login, bot authorization, and adjusting bot permissions.
|
||||
keywords:
|
||||
- Add bot to Discord
|
||||
- Discord bot setup
|
||||
- Authorize Discord bot
|
||||
- Bot permissions
|
||||
---
|
||||
|
||||
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
|
||||
|
||||
<HeadTitle title="Setting up Discord bot - Installation | OpenBB Bot Docs" />
|
||||
|
||||
import AddBotDialogDiscord from "@site/src/components/General/AddBotDiscord";
|
||||
|
||||
<AddBotDialogDiscord
|
||||
/>
|
||||
|
||||
After clicking on the "Add bot to Discord" button, a pop-up window will open, asking you to log in to your Discord account and allow the bot access.
|
||||
|
||||
<img src="https://openbb-assets.s3.amazonaws.com/docs/bot_docs/discord_step_1.png" alt="discord bot setup step 1" width="40%" height="40%" />
|
||||
|
||||
Once you log in, you’ll see a window asking for permission to access your account. Locate the “Add to Server” drop-down menu and click on it.
|
||||
<img src="https://openbb-assets.s3.amazonaws.com/docs/bot_docs/discord_step_2.png" alt="discord bot setup step 2" width="40%" height="40%" />
|
||||
|
||||
This will open a list of Discord servers where you can add a bot. Select your server and press “Continue”.
|
||||
|
||||
Review permissions that the bot requests on your server. Select and deselect based on your needs, we recommend all the default settings in order to experience everything the bot has to offer. Click on “Authorize” when you’re ready.
|
||||
<img src="https://openbb-assets.s3.amazonaws.com/docs/bot_docs/discord_step_3.png" alt="discord bot setup step 3" width="40%" height="40%" />
|
||||
|
||||
Congratulations! You’ve successfully added a bot to your Discord server.
|
||||
55
website/content/bot/installation/index.md
vendored
55
website/content/bot/installation/index.md
vendored
@@ -1,55 +0,0 @@
|
||||
---
|
||||
title: Installation
|
||||
sidebar_position: 1
|
||||
description: Learn how to use OpenBB Bot in Discord and Telegram. Understand the requirements
|
||||
for individual and server uses, and explore additional features by linking your
|
||||
account. Join the community today and leverage over 1.5 Million commands executed
|
||||
on OpenBB Bot.
|
||||
keywords:
|
||||
- OpenBB Bot
|
||||
- Discord
|
||||
- Telegram
|
||||
- chatting applications
|
||||
- link account
|
||||
- user metrics
|
||||
- commands
|
||||
- community
|
||||
- add bot
|
||||
- server requirements
|
||||
- individual requirements
|
||||
---
|
||||
|
||||
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
|
||||
|
||||
<HeadTitle title="Overview - Installation | OpenBB Bot Docs" />
|
||||
|
||||
import AddBotDialogDiscord from "@site/src/components/General/AddBotDiscord";
|
||||
import AddBotDialogTelegram from "@site/src/components/General/AddBotTelegram";
|
||||
|
||||
Currently we support [Discord](installation/discord) and [Telegram](installation/telegram) for the OpenBB Bot. More integrations are under way.
|
||||
|
||||
In order to use OpenBB Bot in one of these chatting applications you need to either:
|
||||
<div>
|
||||
<ul>
|
||||
<li>
|
||||
Belong to a server that has already added our bot (<strong>INDIVIDUAL</strong>)
|
||||
</li>
|
||||
<li>
|
||||
Own a server and you can easily add our bot (<strong>SERVER</strong>)
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
By using the [Linked Platforms page](https://my.openbb.co/app/bot/linked-platforms) you are also able to link your Discord/Telegram account to the OpenBB Bot and open up even more features.
|
||||
|
||||
<h2 className="tracking-widest uppercase text-lg lg:text-xl">
|
||||
What are you waiting for?
|
||||
</h2>
|
||||
|
||||
Over 1.5 Million commands have been run on the OpenBB Bot. Join the community and start using OpenBB Bot today!
|
||||
|
||||
Check our user metrics in our [Open page](https://openbb.co/open).
|
||||
|
||||
<AddBotDialogDiscord />
|
||||
|
||||
<AddBotDialogTelegram />
|
||||
39
website/content/bot/installation/telegram.md
vendored
39
website/content/bot/installation/telegram.md
vendored
@@ -1,39 +0,0 @@
|
||||
---
|
||||
title: Telegram bot
|
||||
sidebar_position: 3
|
||||
description: Step-by-step guide to add the OpenBB Bot to a Telegram group. From starting
|
||||
a chat with the bot to verifying its permissions, follow these steps to have your
|
||||
bot ready in your group.
|
||||
keywords:
|
||||
- Add bot to Telegram
|
||||
- OpenBB Bot
|
||||
- telegram bot setup
|
||||
- telegram group
|
||||
- chatbot permission
|
||||
---
|
||||
|
||||
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
|
||||
|
||||
<HeadTitle title="Setting up Telegram bot - Installation | OpenBB Bot Docs" />
|
||||
|
||||
|
||||
import AddBotDialogTelegram from "@site/src/components/General/AddBotTelegram";
|
||||
|
||||
<AddBotDialogTelegram
|
||||
/>
|
||||
|
||||
After clicking on the "Add bot to Telegram" button it should open a chat with our OpenBB Bot.
|
||||
|
||||
<img src="https://openbb-assets.s3.amazonaws.com/docs/bot_docs/telegram_step_1.png" alt="telegram bot setup step 1" width="40%" height="40%" />
|
||||
|
||||
Go to your Telegram chat and click/tap on the Top Bar of the OpenBB Bot chat window.
|
||||
|
||||
<img src="https://openbb-assets.s3.amazonaws.com/docs/bot_docs/telegram_step_2.png" alt="telegram bot setup step 2" width="40%" height="40%" />
|
||||
|
||||
Then, you need to click on “More” and select "Add to Group or Channel" or just click "Add to Group or Channel" and select the Telegram group you want to add the chatbot to:
|
||||
|
||||
<img src="https://openbb-assets.s3.amazonaws.com/docs/bot_docs/telegram_step_3.png" alt="telegram bot setup step 3" width="40%" height="40%" />
|
||||
|
||||
Now you can verify it has the permissions required, we recommend the ones already selected, and you are ready to go!
|
||||
|
||||
<img src="https://openbb-assets.s3.amazonaws.com/docs/bot_docs/telegram_step_4.png" alt="telegram bot setup step 4" width="40%" height="40%" />
|
||||
@@ -1,4 +0,0 @@
|
||||
{
|
||||
"label": "Commands",
|
||||
"position": 3
|
||||
}
|
||||
@@ -1,4 +0,0 @@
|
||||
{
|
||||
"label": "Discord",
|
||||
"position": 2
|
||||
}
|
||||
@@ -1,50 +0,0 @@
|
||||
---
|
||||
title: create
|
||||
description: This page provides instructions on how to use the 'create' command to
|
||||
set up price alerts for specific trading symbols. It includes usage examples and
|
||||
a detailed description of parameters involved such as the ticker, condition, and
|
||||
price.
|
||||
keywords:
|
||||
- price alerts
|
||||
- trading symbols
|
||||
- condition
|
||||
- price
|
||||
- creation command
|
||||
---
|
||||
|
||||
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
|
||||
|
||||
<HeadTitle title="alerts: create - Discord Reference | OpenBB Bot Docs" />
|
||||
|
||||
This command creates an alert for a given symbol (ex. BTCUSD) that will notify the user when the price is equal to or above the user defined price.
|
||||
|
||||
### Usage
|
||||
|
||||
```python wordwrap
|
||||
/alerts create ticker condition price
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Parameters
|
||||
|
||||
| Name | Description | Optional | Choices |
|
||||
| ---- | ----------- | -------- | ------- |
|
||||
| ticker | Ticker to set alert for | False | None |
|
||||
| condition | Condition to set alert for | False | Equal or Above, Equal or Below |
|
||||
| price | Price to set alert for | False | None |
|
||||
|
||||
|
||||
---
|
||||
|
||||
## Examples
|
||||
|
||||
```
|
||||
/alerts create ticker:BTCUSD condition:Equal or Above price:1000
|
||||
```
|
||||
|
||||
```
|
||||
/alerts create ticker:SPY condition:Equal or Below price:400
|
||||
```
|
||||
|
||||
---
|
||||
@@ -1,43 +0,0 @@
|
||||
---
|
||||
title: delete
|
||||
description: Learn how to delete an active alert using our user-friendly commands.
|
||||
This page provides detailed usage and examples of alert deletion.
|
||||
keywords:
|
||||
- delete
|
||||
- alert
|
||||
- commands
|
||||
- user guide
|
||||
- parameters
|
||||
- usage
|
||||
---
|
||||
|
||||
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
|
||||
|
||||
<HeadTitle title="alerts: delete - Discord Reference | OpenBB Bot Docs" />
|
||||
|
||||
This command allows the user to delete an active alert they have set.
|
||||
|
||||
### Usage
|
||||
|
||||
```python wordwrap
|
||||
/alerts delete alert
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Parameters
|
||||
|
||||
| Name | Description | Optional | Choices |
|
||||
| ---- | ----------- | -------- | ------- |
|
||||
| alert | Alert to delete | False | None |
|
||||
|
||||
|
||||
---
|
||||
|
||||
## Examples
|
||||
|
||||
```
|
||||
/alerts delete alert:
|
||||
```
|
||||
|
||||
---
|
||||
@@ -1,27 +0,0 @@
|
||||
# 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>
|
||||
@@ -1,41 +0,0 @@
|
||||
---
|
||||
title: list
|
||||
description: The '/alerts list' command page helps users understand how to view a
|
||||
list of their active alerts, including each alert's symbol, description, and threshold.
|
||||
keywords:
|
||||
- alerts list command
|
||||
- list active alerts
|
||||
- alert overview
|
||||
- alerts symbols
|
||||
- alerts threshold
|
||||
- using alerts list
|
||||
---
|
||||
|
||||
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
|
||||
|
||||
<HeadTitle title="alerts: list - Discord Reference | OpenBB Bot Docs" />
|
||||
|
||||
This command allows the user to view a list of all their active alerts. It displays each alert along with its symbol, description, and threshold, giving the user an overview of their active alerts at a glance.
|
||||
|
||||
### Usage
|
||||
|
||||
```python wordwrap
|
||||
/alerts list
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Parameters
|
||||
|
||||
This command has no parameters
|
||||
|
||||
|
||||
|
||||
---
|
||||
|
||||
## Examples
|
||||
|
||||
```
|
||||
/alerts list
|
||||
```
|
||||
---
|
||||
@@ -1,45 +0,0 @@
|
||||
---
|
||||
title: update
|
||||
description: This page provides description and usage of the 'update' command within
|
||||
the context of active alerts. It includes details on how to change the condition
|
||||
of an active alert, specifically for price alerts.
|
||||
keywords:
|
||||
- Update command
|
||||
- Price alert
|
||||
- Active alerts
|
||||
- Update condition
|
||||
- Deactivate alert
|
||||
---
|
||||
|
||||
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
|
||||
|
||||
<HeadTitle title="alerts: update - Discord Reference | OpenBB Bot Docs" />
|
||||
|
||||
This command allows the user to update the condition on an active alert, such as changing the value of a price alert. The command will update the alert with the new condition and keep the alert active until it is manually deactivated or the alert's condition is met.
|
||||
|
||||
### Usage
|
||||
|
||||
```python wordwrap
|
||||
/alerts update alerts condition price
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Parameters
|
||||
|
||||
| Name | Description | Optional | Choices |
|
||||
| ---- | ----------- | -------- | ------- |
|
||||
| alerts | Your active alerts | False | None |
|
||||
| condition | Update condition for alert | False | Equal or Above (above or equal), Equal or Below (below or equal) |
|
||||
| price | Update alert to this price | False | None |
|
||||
|
||||
|
||||
---
|
||||
|
||||
## Examples
|
||||
|
||||
```
|
||||
/alerts update alerts: condition: price:
|
||||
```
|
||||
|
||||
---
|
||||
@@ -1,48 +0,0 @@
|
||||
---
|
||||
title: commands add
|
||||
description: This documentation page provides in-depth insight on how to use the 'add'
|
||||
command in the context of autoposting with OpenBB bot. It gives details of usage,
|
||||
parameters and even provides a few illustrative examples.
|
||||
keywords:
|
||||
- OpenBB bot
|
||||
- autopost commands
|
||||
- autoposting
|
||||
- commands add
|
||||
- usage parameters
|
||||
- automated notifications
|
||||
---
|
||||
|
||||
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
|
||||
|
||||
<HeadTitle title="autopost: commands add - Discord Reference | OpenBB Bot Docs" />
|
||||
|
||||
This command allows the user to add an autopost command to a channel. It allows the user to receive notifications from OpenBB bot in the channel without having to manually query them. This can be used for all commands that appear in the list when you run "autopost commands add"
|
||||
|
||||
### Usage
|
||||
|
||||
```python wordwrap
|
||||
/autopost commands add cmd interval [start_time] [stop_time]
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Parameters
|
||||
|
||||
| Name | Description | Optional | Choices |
|
||||
| ---- | ----------- | -------- | ------- |
|
||||
| cmd | Pick the command you want to assign for autoposting | False | List of commands that allow auto posting |
|
||||
| interval | How oftern to post the autopost command | False | 5m, 15m, 30m, 1hr, 2hr, 4hr, 6hr |
|
||||
| start_time | Time to start the autopost command - ex. If I want to start at 8am I do 8 | True | 24hr time |
|
||||
| stop_time | Time to stop the autopost command - ex. If I want to stop at 6pm I do 18 | True | 24hr time |
|
||||
|
||||
---
|
||||
|
||||
## Examples
|
||||
|
||||
```
|
||||
/autopost commands add cmd:/cm interval:1 Hour
|
||||
```
|
||||
|
||||
```
|
||||
/autopost commands add cmd: /cm interval: 1 Hour start_time: 9 stop_time: 10
|
||||
```
|
||||
@@ -1,22 +0,0 @@
|
||||
# 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>
|
||||
@@ -1,40 +0,0 @@
|
||||
---
|
||||
title: list
|
||||
description: Learn about the 'autopost list' command which allows you to view all
|
||||
webhook feeds associated with a channel set up for automatic posting. Find out how
|
||||
and when it can be used, with examples provided.
|
||||
keywords:
|
||||
- autopost list
|
||||
- webhooks
|
||||
- automatic posting
|
||||
- channel
|
||||
---
|
||||
|
||||
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
|
||||
|
||||
<HeadTitle title="autopost: list - Discord Reference | OpenBB Bot Docs" />
|
||||
|
||||
This command allows users to view all webhook feeds associated with a particular channel that have been set up for automatic posting. It produces a list of all webhooks that have been configured to post content to the channel automatically, as well as information such as when they are scheduled.
|
||||
|
||||
### Usage
|
||||
|
||||
```python wordwrap
|
||||
/autopost list
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Parameters
|
||||
|
||||
This command has no parameters
|
||||
|
||||
|
||||
|
||||
---
|
||||
|
||||
## Examples
|
||||
|
||||
```
|
||||
/autopost list
|
||||
```
|
||||
---
|
||||
@@ -1,47 +0,0 @@
|
||||
---
|
||||
title: commands manage
|
||||
description: Documentation on how to use the 'commands manage' command for autoposts
|
||||
on Discord. This includes its usage, parameters, and examples for removing or listing
|
||||
feeds.
|
||||
keywords:
|
||||
- commands manage
|
||||
- autopost command
|
||||
- Discord autoposts
|
||||
- manage autoposts
|
||||
- remove autoposts
|
||||
- autopost parameters
|
||||
- autopost usage
|
||||
- list autoposts
|
||||
---
|
||||
|
||||
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
|
||||
|
||||
<HeadTitle title="autopost: commands manage - Discord Reference | OpenBB Bot Docs" />
|
||||
|
||||
This command allows the user to remove an autopost webhook feed from the channel. When executed, it will remove the feed from the channel and prevent any further autoposts from being sent.
|
||||
|
||||
### Usage
|
||||
|
||||
```python wordwrap
|
||||
/autopost commands manage action
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Parameters
|
||||
|
||||
| Name | Description | Optional | Choices |
|
||||
| ---- | ----------- | -------- | ------- |
|
||||
| action | Remove, or List your feeds for Discord autoposts | True | Remove, List |
|
||||
|
||||
---
|
||||
|
||||
## Examples
|
||||
|
||||
```
|
||||
/autopost commands manage action:List
|
||||
```
|
||||
|
||||
```
|
||||
/autopost commands manage action:Remove
|
||||
```
|
||||
@@ -1,44 +0,0 @@
|
||||
---
|
||||
title: c15m
|
||||
description: The c15m command page explains how to retrieve a 15-minute intraday chart
|
||||
for any given stock ticker. This tool allows users to conduct technical analysis
|
||||
and monitor short-term price fluctuations.
|
||||
keywords:
|
||||
- c15m command
|
||||
- intraday chart
|
||||
- technical analysis
|
||||
- stock trading
|
||||
- short-term price movements
|
||||
- stock ticker
|
||||
---
|
||||
|
||||
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
|
||||
|
||||
<HeadTitle title="charts: c15m - Discord Reference | OpenBB Bot Docs" />
|
||||
|
||||
This command allows the user to retrieve a 15-minute intraday chart for a given ticker. The chart will show the price and volume of the stock over the past 3 days in 15 minute intervals. This command is useful for performing technical analysis and tracking short-term price movements.
|
||||
|
||||
### Usage
|
||||
|
||||
```python wordwrap
|
||||
/c15m ticker
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Parameters
|
||||
|
||||
| Name | Description | Optional | Choices |
|
||||
| ---- | ----------- | -------- | ------- |
|
||||
| ticker | Stock Ticker | False | None |
|
||||
|
||||
|
||||
---
|
||||
|
||||
## Examples
|
||||
|
||||
```
|
||||
/c15m ticker:AMD
|
||||
```
|
||||
|
||||
---
|
||||
@@ -1,45 +0,0 @@
|
||||
---
|
||||
title: c3m
|
||||
description: The documentation page for /c3m command in stock market analysis tool.
|
||||
This command retrieves a 3-minute intraday chart, which provides visual representation
|
||||
of a stock's performance during the day, particularly useful for short-term investors.
|
||||
keywords:
|
||||
- 3 minute intraday chart
|
||||
- stock performance
|
||||
- candlestick chart
|
||||
- short-term investments
|
||||
- /c3m command
|
||||
- trading hours
|
||||
---
|
||||
|
||||
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
|
||||
|
||||
<HeadTitle title="charts: c3m - Discord Reference | OpenBB Bot Docs" />
|
||||
|
||||
This command allows users to retrieve a 3-minute intraday chart for the given ticker. This chart will display the candlestick chart for the day. It will provide a visual representation of the stock's performance over the current day, making it helpful for short-term investors.
|
||||
|
||||
### Usage
|
||||
|
||||
```python wordwrap
|
||||
/c3m ticker [extended_hours]
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Parameters
|
||||
|
||||
| Name | Description | Optional | Choices |
|
||||
| ---- | ----------- | -------- | ------- |
|
||||
| ticker | Stock Ticker | False | None |
|
||||
| extended_hours | Show Full 4am-8pm ET Trading Hours. Default: False | True | None |
|
||||
|
||||
|
||||
---
|
||||
|
||||
## Examples
|
||||
|
||||
```
|
||||
/c3m ticker:AMD
|
||||
```
|
||||
|
||||
---
|
||||
@@ -1,47 +0,0 @@
|
||||
---
|
||||
title: c5m
|
||||
description: Learn how to use the c5m command to retrieve an intraday 5 minute chart
|
||||
for a given ticker. This tool aids in performing technical analysis and monitoring
|
||||
short-term stock price movements.
|
||||
keywords:
|
||||
- c5m command
|
||||
- intraday 5 minute chart
|
||||
- technical analysis
|
||||
- stock performance
|
||||
- candlestick chart
|
||||
- short-term price movements
|
||||
- stock ticker
|
||||
- trading hours
|
||||
---
|
||||
|
||||
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
|
||||
|
||||
<HeadTitle title="charts: c5m - Discord Reference | OpenBB Bot Docs" />
|
||||
|
||||
This command allows the user to retrieve an intraday 5 minute chart for a given ticker. This chart will display the candlestick chart for the day. It will provide a visual representation of the stock's performance over the current day. This command is useful for performing technical analysis and tracking short-term price movements.
|
||||
|
||||
### Usage
|
||||
|
||||
```python wordwrap
|
||||
/c5m ticker [extended_hours]
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Parameters
|
||||
|
||||
| Name | Description | Optional | Choices |
|
||||
| ---- | ----------- | -------- | ------- |
|
||||
| ticker | Stock Ticker | False | None |
|
||||
| extended_hours | Show Full 4am-8pm ET Trading Hours. Default: False | True | None |
|
||||
|
||||
|
||||
---
|
||||
|
||||
## Examples
|
||||
|
||||
```
|
||||
/c5m ticker:AMD
|
||||
```
|
||||
|
||||
---
|
||||
@@ -1,47 +0,0 @@
|
||||
---
|
||||
title: cc
|
||||
description: This documentation page provides an in-depth explanation on the /cc command
|
||||
that retrieves an intraday 5 minute chart for a given ticker. It's a useful tool
|
||||
for technical analysis and tracking short-term price movements.
|
||||
keywords:
|
||||
- intraday 5 minute chart
|
||||
- candlestick chart
|
||||
- technical analysis
|
||||
- short-term price movements
|
||||
- /cc command
|
||||
- stock performance visualization
|
||||
- extended trading hours
|
||||
- stock ticker
|
||||
---
|
||||
|
||||
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
|
||||
|
||||
<HeadTitle title="charts: cc - Discord Reference | OpenBB Bot Docs" />
|
||||
|
||||
This command allows the user to retrieve an intraday 5 minute chart for a given ticker, /c5m also has the same effect. This chart will display the candlestick chart for the day. It will provide a visual representation of the stock's performance over the current day. This command is useful for performing technical analysis and tracking short-term price movements.
|
||||
|
||||
### Usage
|
||||
|
||||
```python wordwrap
|
||||
/cc ticker [extended_hours]
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Parameters
|
||||
|
||||
| Name | Description | Optional | Choices |
|
||||
| ---- | ----------- | -------- | ------- |
|
||||
| ticker | Stock Ticker | False | None |
|
||||
| extended_hours | Show Full 4am-8pm ET Trading Hours. Default: False | True | None |
|
||||
|
||||
|
||||
---
|
||||
|
||||
## Examples
|
||||
|
||||
```
|
||||
/cc ticker:AMD
|
||||
```
|
||||
|
||||
---
|
||||
@@ -1,47 +0,0 @@
|
||||
---
|
||||
title: cd
|
||||
description: This page provides comprehensive information about the 'cd' command,
|
||||
used to retrieve a daily candlestick chart for a specific stock ticker or coin.
|
||||
It also includes usage instructions, parameter details and examples.
|
||||
keywords:
|
||||
- cd command
|
||||
- daily candlestick chart
|
||||
- stock ticker
|
||||
- coin
|
||||
- opening and closing prices
|
||||
- high and low prices
|
||||
- performance analysis
|
||||
- command usage
|
||||
- parameter details
|
||||
---
|
||||
|
||||
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
|
||||
|
||||
<HeadTitle title="charts: cd - Discord Reference | OpenBB Bot Docs" />
|
||||
|
||||
This command allows the user to retrieve a daily candlestick chart for a particular ticker or coin. The candlestick chart provides information about the opening and closing prices of the day, as well as the high and low prices of the day. This data can then be used to analyze the performance of the ticker/coin over time. For example, if the user provides the command "/cd ticker:AMD", the chart will be generated for the ticker AMD.
|
||||
|
||||
### Usage
|
||||
|
||||
```python wordwrap
|
||||
/cd ticker
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Parameters
|
||||
|
||||
| Name | Description | Optional | Choices |
|
||||
| ---- | ----------- | -------- | ------- |
|
||||
| ticker | Stock Ticker | False | None |
|
||||
|
||||
|
||||
---
|
||||
|
||||
## Examples
|
||||
|
||||
```
|
||||
/cd ticker:AMD
|
||||
```
|
||||
|
||||
---
|
||||
@@ -1,52 +0,0 @@
|
||||
---
|
||||
title: chart
|
||||
description: Learn how to retrieve a candlestick chart for specified stock tickers,
|
||||
intervals, and for past days. The chart provides comprehensive trading data including
|
||||
opening and closing prices, as well as highs and lows, and volume.
|
||||
keywords:
|
||||
- stock ticker
|
||||
- candlestick chart
|
||||
- trading data
|
||||
- chart interval
|
||||
- data visualization
|
||||
- stock market
|
||||
- financial information
|
||||
---
|
||||
|
||||
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
|
||||
|
||||
<HeadTitle title="charts: chart - Discord Reference | OpenBB Bot Docs" />
|
||||
|
||||
This command will retrieve a candlestick chart for the ticker/interval provided, with data for the past number of days specified. The interval provided must be a valid time interval (e.g. 5 minute, 15 minute, etc.). The chart will be displayed to the user and will contain information such as the opening and closing prices, the high and low, the volume, and any other relevant information.
|
||||
|
||||
### Usage
|
||||
|
||||
```python wordwrap
|
||||
/chart ticker interval [past_days] [extended_hours]
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Parameters
|
||||
|
||||
| Name | Description | Optional | Choices |
|
||||
| ---- | ----------- | -------- | ------- |
|
||||
| ticker | Stock Ticker | False | None |
|
||||
| interval | Chart Interval | False | Daily (1440), Weekly (7200), Monthly (28800), 1 minute (1), 5 minute (5), 10 minute (10), 15 minute (15), 30 minute (30), 1 hour (60) |
|
||||
| past_days | Past Days to Display. Default: 0 | True | None |
|
||||
| extended_hours | Display Full 4am-8pm ET Trading Hours. Default: False | True | None |
|
||||
|
||||
|
||||
---
|
||||
|
||||
## Examples
|
||||
|
||||
```
|
||||
/chart ticker:AMD interval:5 minute past_days:0
|
||||
```
|
||||
|
||||
```
|
||||
/chart ticker:AMD interval:Daily
|
||||
```
|
||||
|
||||
---
|
||||
@@ -1,45 +0,0 @@
|
||||
---
|
||||
title: chartfib
|
||||
description: On this page, learn how to use the chartfib command in order to retrieve
|
||||
Fibonacci levels for a given ticker. This information can help identify potential
|
||||
support and resistance levels, ultimately aiding in identifying potential entry
|
||||
and exit points in the stock market.
|
||||
keywords:
|
||||
- chartfib command
|
||||
- Fibonacci levels
|
||||
- stock market
|
||||
- support and resistance levels
|
||||
- potential entry and exit points
|
||||
- Stock Ticker
|
||||
---
|
||||
|
||||
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
|
||||
|
||||
<HeadTitle title="charts: chartfib - Discord Reference | OpenBB Bot Docs" />
|
||||
|
||||
This command allows the user to retrieve Fibonacci levels for a given ticker. This data can be used to identify potential support and resistance levels and can be used to identify potential entry and exit points in the stock market.
|
||||
|
||||
### Usage
|
||||
|
||||
```python wordwrap
|
||||
/chartfib ticker
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Parameters
|
||||
|
||||
| Name | Description | Optional | Choices |
|
||||
| ---- | ----------- | -------- | ------- |
|
||||
| ticker | Stock Ticker | False | None |
|
||||
|
||||
|
||||
---
|
||||
|
||||
## Examples
|
||||
|
||||
```
|
||||
/chartfib ticker:AMD
|
||||
```
|
||||
|
||||
---
|
||||
@@ -1,47 +0,0 @@
|
||||
---
|
||||
title: chartsr
|
||||
description: The chartsr command allows the user to retrieve Displays Support and
|
||||
Resistance Levels for any given ticker. Useful in making informed trading decisions.
|
||||
keywords:
|
||||
- chartsr
|
||||
- Support and Resistance Levels
|
||||
- trading
|
||||
- trading decisions
|
||||
- Stock Ticker
|
||||
- Chart Interval
|
||||
---
|
||||
|
||||
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
|
||||
|
||||
<HeadTitle title="charts: chartsr - Discord Reference | OpenBB Bot Docs" />
|
||||
|
||||
This command allows the user to retrieve Displays Support and Resistance Levels for the ticker provided. It will display the support and resistance levels of a given ticker on the chart. These levels can help the user in making better trading decisions.
|
||||
|
||||
### Usage
|
||||
|
||||
```python wordwrap
|
||||
/chartsr ticker [interval]
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Parameters
|
||||
|
||||
| Name | Description | Optional | Choices |
|
||||
| ---- | ----------- | -------- | ------- |
|
||||
| ticker | Stock Ticker | False | None |
|
||||
| interval | Chart Interval | True | 5 minute (5), 15 minute (15) |
|
||||
|
||||
|
||||
---
|
||||
|
||||
## Examples
|
||||
|
||||
```
|
||||
/chartsr ticker:AMC
|
||||
```
|
||||
```
|
||||
/chartsr ticker:AMC interval:5 minute
|
||||
```
|
||||
|
||||
---
|
||||
@@ -1,48 +0,0 @@
|
||||
---
|
||||
title: cm
|
||||
description: Learn about the /cm command that allows you to view a monthly candlestick
|
||||
chart for a given stock or cryptocurrency, perfect for analyzing the long-term performance
|
||||
of your chosen ticker/coin.
|
||||
keywords:
|
||||
- Candlestick chart
|
||||
- Stock analysis
|
||||
- Cryptocurrency analysis
|
||||
- Open price
|
||||
- Close price
|
||||
- High price
|
||||
- Low price
|
||||
- Long-term performance
|
||||
- Stock ticker
|
||||
- Command
|
||||
---
|
||||
|
||||
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
|
||||
|
||||
<HeadTitle title="charts: cm - Discord Reference | OpenBB Bot Docs" />
|
||||
|
||||
This command allows you to view a monthly candlestick chart for a given stock or cryptocurrency. The chart displays the open, close, high and low prices for the selected ticker/coin each month. This command is useful for analyzing the long-term performance of a stock or cryptocurrency.
|
||||
|
||||
### Usage
|
||||
|
||||
```python wordwrap
|
||||
/cm ticker
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Parameters
|
||||
|
||||
| Name | Description | Optional | Choices |
|
||||
| ---- | ----------- | -------- | ------- |
|
||||
| ticker | Stock Ticker | False | None |
|
||||
|
||||
|
||||
---
|
||||
|
||||
## Examples
|
||||
|
||||
```
|
||||
/cm ticker:AMD
|
||||
```
|
||||
|
||||
---
|
||||
@@ -1,45 +0,0 @@
|
||||
---
|
||||
title: cw
|
||||
description: This page explains the usage of the 'cw' command, which enables the user
|
||||
to retrieve a weekly candlestick chart for a specified ticker or coin. This chart
|
||||
displays valuable trading information, including opening and closing prices, high
|
||||
and low prices, and overall trading volume.
|
||||
keywords:
|
||||
- cw command
|
||||
- weekly candlestick chart
|
||||
- stock ticker
|
||||
- trading volume
|
||||
- opening and closing prices
|
||||
- high and low prices
|
||||
---
|
||||
|
||||
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
|
||||
|
||||
<HeadTitle title="charts: cw - Discord Reference | OpenBB Bot Docs" />
|
||||
|
||||
This command allows the user to retrieve a weekly candlestick chart for the ticker/coin provided. The chart displays the opening and closing prices, the high and low prices, and the trading volume for the week for the specified ticker/coin.
|
||||
|
||||
### Usage
|
||||
|
||||
```python wordwrap
|
||||
/cw ticker
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Parameters
|
||||
|
||||
| Name | Description | Optional | Choices |
|
||||
| ---- | ----------- | -------- | ------- |
|
||||
| ticker | Stock Ticker | False | None |
|
||||
|
||||
|
||||
---
|
||||
|
||||
## Examples
|
||||
|
||||
```
|
||||
/cw ticker:AMD
|
||||
```
|
||||
|
||||
---
|
||||
@@ -1,57 +0,0 @@
|
||||
# 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>
|
||||
@@ -1,47 +0,0 @@
|
||||
---
|
||||
title: bigprints
|
||||
description: The documentation page explains the '/crypto bigprints coin:BTC-USD'
|
||||
command which retrieves last 15 large cryptocurrency prints. Informative for trading
|
||||
decisions.
|
||||
keywords:
|
||||
- Cryptocurrency
|
||||
- Crypto Trading
|
||||
- Trading decisions
|
||||
- Command documentation
|
||||
- Crypto bigprints
|
||||
- BTC-USD
|
||||
- Currency pair
|
||||
- Large crypto prints
|
||||
---
|
||||
|
||||
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
|
||||
|
||||
<HeadTitle title="crypto: bigprints - Discord Reference | OpenBB Bot Docs" />
|
||||
|
||||
This command allows the user to retrieve the last 15 large prints for a given cryptocurrency pair. The command uses the format "/crypto bigprints coin:BTC-USD" where BTC-USD is the currency pair for which the user wants to retrieve the large prints. This command is useful for analyzing the recent large prints of a given currency pair, which can be used to inform trading decisions.
|
||||
|
||||
### Usage
|
||||
|
||||
```python wordwrap
|
||||
/crypto bigprints coin [days]
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Parameters
|
||||
|
||||
| Name | Description | Optional | Choices |
|
||||
| ---- | ----------- | -------- | ------- |
|
||||
| coin | Coin from the list of supported coins | False | ADA-USD, AVAX-USD, BTC-USD, DAI-USD, DOGE-USD, DOT-USD, ETH-USD, LTC-USD, MATIC-USD, SHIB-USD, SOL-USD, TRX-USD, USDC-USD, USDT-USD, WBTC-USD, XRP-USD |
|
||||
| days | Number of days to look back. Default is 10. | True | None |
|
||||
|
||||
|
||||
---
|
||||
|
||||
## Examples
|
||||
|
||||
```
|
||||
/crypto bigprints coin:BTC-USD
|
||||
```
|
||||
|
||||
---
|
||||
@@ -1,47 +0,0 @@
|
||||
---
|
||||
title: bio
|
||||
description: The Crypto Bio command retrieves key information about a specific cryptocurrency,
|
||||
such as its current price, trading volume, and market cap. Excellent for getting
|
||||
a quick snapshot of any given cryptocurrency's performance.
|
||||
keywords:
|
||||
- crypto
|
||||
- crypto bio
|
||||
- symbol
|
||||
- btc
|
||||
- cryptocurrency information
|
||||
- market cap
|
||||
- trading volume
|
||||
- crypto price
|
||||
- crypto metrics
|
||||
---
|
||||
|
||||
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
|
||||
|
||||
<HeadTitle title="crypto: bio - Discord Reference | OpenBB Bot Docs" />
|
||||
|
||||
This command allows the user to retrieve fundamental information about a crypto, such as its current price, 24-hour trading volume, market cap, and other key metrics, by entering a specific crypto symbol (e.g. "BTC") as an argument.
|
||||
|
||||
### Usage
|
||||
|
||||
```python wordwrap
|
||||
/crypto bio symbol
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Parameters
|
||||
|
||||
| Name | Description | Optional | Choices |
|
||||
| ---- | ----------- | -------- | ------- |
|
||||
| symbol | Crypto symbol to check information (e.g., BTC) | False | None |
|
||||
|
||||
|
||||
---
|
||||
|
||||
## Examples
|
||||
|
||||
```
|
||||
/crypto bio symbol: btc
|
||||
```
|
||||
|
||||
---
|
||||
@@ -1,50 +0,0 @@
|
||||
---
|
||||
title: compfees
|
||||
description: Learn how to use the compfees command to retrieve Protocol fees with
|
||||
step-by-step examples. The command caters to various projects including btc, eth,
|
||||
doge, etc.
|
||||
keywords:
|
||||
- compfees
|
||||
- Protocol fees
|
||||
- btc
|
||||
- eth
|
||||
- doge
|
||||
- projects
|
||||
- /crypto command
|
||||
- crypto
|
||||
---
|
||||
|
||||
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
|
||||
|
||||
<HeadTitle title="crypto: compfees - Discord Reference | OpenBB Bot Docs" />
|
||||
|
||||
This command allows users to retrieve the Protocol fees over time for the given project.
|
||||
|
||||
### Usage
|
||||
|
||||
```python wordwrap
|
||||
/crypto compfees projects
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Parameters
|
||||
|
||||
| Name | Description | Optional | Choices |
|
||||
| ---- | ----------- | -------- | ------- |
|
||||
| projects | Comma separated list of protocols (e.g., btc,eth) | False | None |
|
||||
|
||||
|
||||
---
|
||||
|
||||
## Examples
|
||||
|
||||
```
|
||||
/crypto compfees projects: doge
|
||||
```
|
||||
|
||||
```
|
||||
/crypto compfees projects: btc,eth
|
||||
```
|
||||
|
||||
---
|
||||
@@ -1,51 +0,0 @@
|
||||
---
|
||||
title: chart
|
||||
description: This page provides a guide on how to retrieve a chart of the top DeFi
|
||||
protocols by market capitalization. It explains the usage, parameters, and examples
|
||||
of '/crypto defi chart' command to have a visual overview of the current DeFi landscape.
|
||||
keywords:
|
||||
- DeFi
|
||||
- market capitalization
|
||||
- visual representation
|
||||
- total DeFi market size
|
||||
- ' crypto'
|
||||
- chart
|
||||
- protocols
|
||||
- Total Value Locked
|
||||
- Market Cap
|
||||
- sort data
|
||||
- chain
|
||||
- sort order
|
||||
---
|
||||
|
||||
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
|
||||
|
||||
<HeadTitle title="defi - crypto: chart - Discord Reference | OpenBB Bot Docs" />
|
||||
|
||||
This command will retrieve a chart of the top DeFi protocols by market capitalization. It will provide a visual representation of the relative size of each protocol, as well as an overview of the total DeFi market size. This will enable users to get a better understanding of the current DeFi landscape and identify which protocols are leading the way.
|
||||
|
||||
### Usage
|
||||
|
||||
```python wordwrap
|
||||
/crypto defi chart
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Parameters
|
||||
|
||||
| Name | Description | Optional | Choices |
|
||||
| ---- | ----------- | -------- | ------- |
|
||||
| sortby | Column to sort data by (e.g., Total Value Locked) | True | Market Cap (MCap), Total Value Locked (TVL) |
|
||||
| chain | Chain to filter by (e.g., ethereum) | True | None |
|
||||
| reverse | Reverse the sort order | True | Yes |
|
||||
|
||||
|
||||
---
|
||||
|
||||
## Examples
|
||||
|
||||
```
|
||||
/crypto defi chart
|
||||
```
|
||||
---
|
||||
@@ -1,55 +0,0 @@
|
||||
---
|
||||
title: table
|
||||
description: This page provides commands and parameters for retrieving and managing
|
||||
data about top DeFi protocols including total value locked, 24-hour volume, and
|
||||
price. It also guides on how to sort and filter this data.
|
||||
keywords:
|
||||
- DeFi protocols
|
||||
- total value locked
|
||||
- /crypto defi table
|
||||
- 24 hour volume
|
||||
- price
|
||||
- sortby parameter
|
||||
- chain parameter
|
||||
- reverse parameter
|
||||
- crypto
|
||||
- table
|
||||
- sorted data
|
||||
- Market Cap
|
||||
- Total Value Locked
|
||||
- MCap
|
||||
- TVL
|
||||
- ethereum
|
||||
---
|
||||
|
||||
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
|
||||
|
||||
<HeadTitle title="defi - crypto: table - Discord Reference | OpenBB Bot Docs" />
|
||||
|
||||
This command allows the user to view a table of the top DeFi protocols and their associated information, such as the total value locked, 24 hour volume, and price. The table is sorted in descending order, with the top DeFi protocols at the top.
|
||||
|
||||
### Usage
|
||||
|
||||
```python wordwrap
|
||||
/crypto defi table [sortby] [chain] [reverse]
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Parameters
|
||||
|
||||
| Name | Description | Optional | Choices |
|
||||
| ---- | ----------- | -------- | ------- |
|
||||
| sortby | Column to sort data by (e.g., Total Value Locked) | True | Market Cap (MCap), Total Value Locked (TVL) |
|
||||
| chain | Chain to filter by (e.g., ethereum) | True | None |
|
||||
| reverse | Reverse the sort order | True | Yes |
|
||||
|
||||
|
||||
---
|
||||
|
||||
## Examples
|
||||
|
||||
```
|
||||
/crypto defi table
|
||||
```
|
||||
---
|
||||
@@ -1,44 +0,0 @@
|
||||
---
|
||||
title: fees
|
||||
description: The page provides information about how to fetch the fee rate of top
|
||||
crypto protocols on a specified date. It helps users to compare different protocols'
|
||||
fees, enhancing their decision-making process.
|
||||
keywords:
|
||||
- crypto
|
||||
- fees
|
||||
- comparison
|
||||
- date
|
||||
- crypto fees
|
||||
- protocol
|
||||
---
|
||||
|
||||
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
|
||||
|
||||
<HeadTitle title="crypto: fees - Discord Reference | OpenBB Bot Docs" />
|
||||
|
||||
This will provide the user with the fee rate of the top crypto protocols on a specified date, allowing the user to compare different protocols' fees and make an informed decision.
|
||||
|
||||
### Usage
|
||||
|
||||
```python wordwrap
|
||||
/crypto fees date
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Parameters
|
||||
|
||||
| Name | Description | Optional | Choices |
|
||||
| ---- | ----------- | -------- | ------- |
|
||||
| date | Date to get fees for (e.g., 2022-01-01) | False | None |
|
||||
|
||||
|
||||
---
|
||||
|
||||
## Examples
|
||||
|
||||
```
|
||||
/crypto fees date: 2022-09-19
|
||||
```
|
||||
|
||||
---
|
||||
@@ -1,52 +0,0 @@
|
||||
# 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>
|
||||
@@ -1,42 +0,0 @@
|
||||
---
|
||||
title: ir
|
||||
description: Learn about the /crypto ir command which allows users to retrieve the
|
||||
issuance rate of top crypto protocols. This is an essential tool for investors seeking
|
||||
to understand supply dynamics of crypto protocols and inform their investment decisions.
|
||||
keywords:
|
||||
- crypto protocols
|
||||
- issuance rate
|
||||
- /crypto ir command
|
||||
- investment decisions
|
||||
- supply dynamics
|
||||
---
|
||||
|
||||
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
|
||||
|
||||
<HeadTitle title="crypto: ir - Discord Reference | OpenBB Bot Docs" />
|
||||
|
||||
This command allows the user to retrieve the issuance rate of the top crypto protocols. The issuance rate is the amount of new tokens that are generated by the protocol over a given period of time. It is a useful metric for understanding the supply dynamics of crypto protocols and is used to inform investment decisions.
|
||||
|
||||
### Usage
|
||||
|
||||
```python wordwrap
|
||||
/crypto ir
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Parameters
|
||||
|
||||
This command has no parameters
|
||||
|
||||
|
||||
|
||||
---
|
||||
|
||||
## Examples
|
||||
|
||||
```
|
||||
/crypto ir
|
||||
```
|
||||
|
||||
---
|
||||
@@ -1,45 +0,0 @@
|
||||
---
|
||||
title: prints
|
||||
description: This tutorial explains the use of the command '/crypto prints coin' to
|
||||
retrieve the last 15 crypto prints over the last 24 hours for a specific coin. Charge
|
||||
into the world of crypto metrics, track prices, volumes, sizes, and other associated
|
||||
metrics.
|
||||
keywords:
|
||||
- Crypto Prints
|
||||
- Crypto metrics
|
||||
- Crypto commands
|
||||
- Bitcoin
|
||||
- Ethereum
|
||||
- Docusaurus SEO
|
||||
---
|
||||
|
||||
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
|
||||
|
||||
<HeadTitle title="crypto: prints - Discord Reference | OpenBB Bot Docs" />
|
||||
|
||||
This command allows the user to retrieve the Last 15 Crypto Prints over the last 24 hours for the specified coin. The command will provide information on the price, volume, size, and other metrics associated with the prints.
|
||||
|
||||
### Usage
|
||||
|
||||
```python wordwrap
|
||||
/crypto prints coin
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Parameters
|
||||
|
||||
| Name | Description | Optional | Choices |
|
||||
| ---- | ----------- | -------- | ------- |
|
||||
| coin | Coin from the list of supported coins | False | ADA-USD, AVAX-USD, BTC-USD, DAI-USD, DOGE-USD, DOT-USD, ETH-USD, LTC-USD, MATIC-USD, SHIB-USD, SOL-USD, TRX-USD, USDC-USD, USDT-USD, WBTC-USD, XRP-USD |
|
||||
|
||||
|
||||
---
|
||||
|
||||
## Examples
|
||||
|
||||
```
|
||||
/crypto prints coin:BTC-USD
|
||||
```
|
||||
|
||||
---
|
||||
@@ -1,53 +0,0 @@
|
||||
---
|
||||
title: top
|
||||
description: Command to retrieve the top cryptocurrencies by market cap, with optional
|
||||
sorting and filtering capabilities. It provides a quick snapshot of the current
|
||||
crypto market using specific commands.
|
||||
keywords:
|
||||
- crypto
|
||||
- top cryptocurrencies
|
||||
- market capitalization
|
||||
- market cap
|
||||
- stablecoins
|
||||
- manufacturing
|
||||
- sort
|
||||
- filter
|
||||
- reverse order
|
||||
- command usage
|
||||
---
|
||||
|
||||
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
|
||||
|
||||
<HeadTitle title="crypto: top - Discord Reference | OpenBB Bot Docs" />
|
||||
|
||||
This command will retrieve the top cryptocurrencies, ranked by market capitalization, allowing the user to quickly get a snapshot of the current market.
|
||||
|
||||
### Usage
|
||||
|
||||
```python wordwrap
|
||||
/crypto top [sortby] [category] [reverse]
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Parameters
|
||||
|
||||
| Name | Description | Optional | Choices |
|
||||
| ---- | ----------- | -------- | ------- |
|
||||
| sortby | Column to sort data by (e.g., Market Cap) | True | Market Cap (MCap) |
|
||||
| category | Category to filter by (e.g., stablecoins) | True | None |
|
||||
| reverse | Reverse the sort order | True | Yes |
|
||||
|
||||
|
||||
---
|
||||
|
||||
## Examples
|
||||
|
||||
```
|
||||
/crypto top
|
||||
```
|
||||
|
||||
```
|
||||
/crypto top sortby: Market Cap category: manufacturing
|
||||
```
|
||||
---
|
||||
@@ -1,51 +0,0 @@
|
||||
---
|
||||
title: tvl
|
||||
description: This page provides instructions on how to use the 'TVL' command to retrieve
|
||||
historical Total Value Locked (TVL) data for a given protocol. This data provides
|
||||
a snapshot of the total amount of capital locked in a protocol, enabling comparison
|
||||
of metrics between protocols and tracking their growth over time.
|
||||
keywords:
|
||||
- TVL
|
||||
- Total Value Locked
|
||||
- protocol
|
||||
- crypto
|
||||
- historical data
|
||||
- growth tracking
|
||||
- metrics comparison
|
||||
- capital
|
||||
---
|
||||
|
||||
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
|
||||
|
||||
<HeadTitle title="crypto: tvl - Discord Reference | OpenBB Bot Docs" />
|
||||
|
||||
This command allows users to retrieve historical TVL (Total Value Locked) data for any given protocol. It provides a snapshot of the total amount of capital that is currently locked in the protocol, allowing users to easily compare the metrics between different protocols and track their growth over time.
|
||||
|
||||
### Usage
|
||||
|
||||
```python wordwrap
|
||||
/crypto tvl protocols
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Parameters
|
||||
|
||||
| Name | Description | Optional | Choices |
|
||||
| ---- | ----------- | -------- | ------- |
|
||||
| protocols | comma separated list of protocols (e.g., curve,makerdao) | False | None |
|
||||
|
||||
|
||||
---
|
||||
|
||||
## Examples
|
||||
|
||||
```
|
||||
/crypto tvl
|
||||
```
|
||||
|
||||
```
|
||||
/crypto tvl protocols: curve
|
||||
```
|
||||
|
||||
---
|
||||
@@ -1,43 +0,0 @@
|
||||
---
|
||||
title: allblocks
|
||||
description: Learn how to use the allblocks command to retrieve the last 15 block
|
||||
trades of a given security, with details including the time, price, quantity, and
|
||||
total gross value of each trade.
|
||||
keywords:
|
||||
- block trades
|
||||
- security
|
||||
- trade summary
|
||||
- stock ticker
|
||||
- allblocks command
|
||||
---
|
||||
|
||||
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
|
||||
|
||||
<HeadTitle title="darkpool: allblocks - Discord Reference | OpenBB Bot Docs" />
|
||||
|
||||
The command allows the user to retrieve the last 15 block trades of a given security. This command will provide a summary of the last 15 block trades, including the time, price, quantity, and total gross value of each trade.
|
||||
|
||||
### Usage
|
||||
|
||||
```python wordwrap
|
||||
/dp allblocks ticker
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Parameters
|
||||
|
||||
| Name | Description | Optional | Choices |
|
||||
| ---- | ----------- | -------- | ------- |
|
||||
| ticker | Stock Ticker | False | None |
|
||||
|
||||
|
||||
---
|
||||
|
||||
## Examples
|
||||
|
||||
```
|
||||
/dp topsum
|
||||
```
|
||||
|
||||
---
|
||||
@@ -1,44 +0,0 @@
|
||||
---
|
||||
title: alldp
|
||||
description: This page provides the 'alldp' command usage to retrieve the last 15
|
||||
darkpool trades for a specific stock ticker. It presents how to efficiently trade
|
||||
on a private stock trading system.
|
||||
keywords:
|
||||
- alldp command
|
||||
- darkpool trades
|
||||
- stock ticker
|
||||
- private stock trading
|
||||
- efficient trades
|
||||
- retrieve trades
|
||||
---
|
||||
|
||||
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
|
||||
|
||||
<HeadTitle title="darkpool: alldp - Discord Reference | OpenBB Bot Docs" />
|
||||
|
||||
This command allows the user to retrieve the last 15 darkpool trades for the specified stock ticker. A darkpool is a private stock trading system that allows large trades to take place without affecting the public market, providing access to larger and more efficient trades.
|
||||
|
||||
### Usage
|
||||
|
||||
```python wordwrap
|
||||
/dp alldp ticker
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Parameters
|
||||
|
||||
| Name | Description | Optional | Choices |
|
||||
| ---- | ----------- | -------- | ------- |
|
||||
| ticker | Stock Ticker | False | None |
|
||||
|
||||
|
||||
---
|
||||
|
||||
## Examples
|
||||
|
||||
```
|
||||
/dp alldp ticker:AMD
|
||||
```
|
||||
|
||||
---
|
||||
@@ -1,42 +0,0 @@
|
||||
---
|
||||
title: allprints
|
||||
description: This page's content revolves around the 'allprints' command used for
|
||||
retrieving the last 15 combination of Dark Pool and Blocks for a specified ticker
|
||||
symbol. It covers usage, parameters, and examples.
|
||||
keywords:
|
||||
- allprints command
|
||||
- Dark Pool and Blocks
|
||||
- stock market trades
|
||||
- ticker symbol
|
||||
---
|
||||
|
||||
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
|
||||
|
||||
<HeadTitle title="darkpool: allprints - Discord Reference | OpenBB Bot Docs" />
|
||||
|
||||
This command retrieves the Last 15 Combination of Dark Pool and Blocks for a given ticker symbol. This can be used to view the most recent reported trades that involve Dark Pool and Blocks in the stock market. The results of this command will show the date, time, price, and volume of the trades.
|
||||
|
||||
### Usage
|
||||
|
||||
```python wordwrap
|
||||
/dp allprints ticker
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Parameters
|
||||
|
||||
| Name | Description | Optional | Choices |
|
||||
| ---- | ----------- | -------- | ------- |
|
||||
| ticker | Stock Ticker | False | None |
|
||||
|
||||
|
||||
---
|
||||
|
||||
## Examples
|
||||
|
||||
```
|
||||
/dp allprints ticker:AMD
|
||||
```
|
||||
|
||||
---
|
||||
@@ -1,42 +0,0 @@
|
||||
---
|
||||
title: bigprints
|
||||
description: Bigprints command provides a comprehensive view of the biggest dark pool
|
||||
and block trades over a specified number of days, offering insights into the market
|
||||
activity over that period.
|
||||
keywords:
|
||||
- bigprints
|
||||
- dark pool trades
|
||||
- block trades
|
||||
- /dp bigprints days
|
||||
- market activity
|
||||
---
|
||||
|
||||
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
|
||||
|
||||
<HeadTitle title="darkpool: bigprints - Discord Reference | OpenBB Bot Docs" />
|
||||
|
||||
This command will retrieve the largest combination of dark pool and block trades over a specified amount of days. It will provide a comprehensive view of the biggest dark pool and block trades over the specified number of days and give the user an idea of the market activity over that period.
|
||||
|
||||
### Usage
|
||||
|
||||
```python wordwrap
|
||||
/dp bigprints days
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Parameters
|
||||
|
||||
| Name | Description | Optional | Choices |
|
||||
| ---- | ----------- | -------- | ------- |
|
||||
| days | Number of days to look back | False | None |
|
||||
|
||||
|
||||
---
|
||||
|
||||
## Examples
|
||||
|
||||
```
|
||||
/dp bigprints days:6
|
||||
```
|
||||
---
|
||||
@@ -1,47 +0,0 @@
|
||||
# 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>
|
||||
@@ -1,48 +0,0 @@
|
||||
---
|
||||
title: levels
|
||||
description: This page provides information about the 'levels' command that allows
|
||||
users to retrieve the Biggest Levels for All Prints over the last x days for a given
|
||||
stock ticker. This command aids in evaluating stock performance.
|
||||
keywords:
|
||||
- levels command
|
||||
- DP levels
|
||||
- stock ticker
|
||||
- stock performance
|
||||
- All Prints
|
||||
- Biggest Levels
|
||||
- usage of levels command
|
||||
- parameters
|
||||
- examples
|
||||
---
|
||||
|
||||
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
|
||||
|
||||
<HeadTitle title="darkpool: levels - Discord Reference | OpenBB Bot Docs" />
|
||||
|
||||
This command allows the user to retrieve the Biggest Levels for All Prints over the last x days for the given ticker. This information is useful in assessing the overall performance of the stock, as it provides information on the largest levels of prints over the last x days.
|
||||
|
||||
### Usage
|
||||
|
||||
```python wordwrap
|
||||
/dp levels ticker days
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Parameters
|
||||
|
||||
| Name | Description | Optional | Choices |
|
||||
| ---- | ----------- | -------- | ------- |
|
||||
| ticker | Stock Ticker | False | None |
|
||||
| days | Number of days to look back | False | None |
|
||||
|
||||
|
||||
---
|
||||
|
||||
## Examples
|
||||
|
||||
```
|
||||
/dp levels ticker:TSLA days:10
|
||||
```
|
||||
|
||||
---
|
||||
@@ -1,56 +0,0 @@
|
||||
---
|
||||
title: sectors
|
||||
description: The page provides information on how to use the sectors command, which
|
||||
allows the user to view a summary of all prints by MarketCap of different sectors
|
||||
over a given period. The command provides significant insights into the darkpool
|
||||
activities of different sectors.
|
||||
keywords:
|
||||
- sectors command
|
||||
- MarketCap by Sector
|
||||
- darkpool activity
|
||||
- sector's market cap
|
||||
- accumulation
|
||||
- Basic Materials
|
||||
- Energy sector
|
||||
- Communication Services
|
||||
- Consumer Cyclical
|
||||
- Consumer Defensive
|
||||
- Financial sector
|
||||
- Healthcare sector
|
||||
- Industrials
|
||||
- Real Estate sector
|
||||
- Technology sector
|
||||
- Utilities sector
|
||||
---
|
||||
|
||||
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
|
||||
|
||||
<HeadTitle title="darkpool: sectors - Discord Reference | OpenBB Bot Docs" />
|
||||
|
||||
This command allows the user to retrieve a summary of all prints by % of MarketCap by Sector over the last x days. The user will be able to view the sector's market cap divided by total darkpool activity to see possible accumulation.
|
||||
|
||||
### Usage
|
||||
|
||||
```python wordwrap
|
||||
/dp sectors days sector
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Parameters
|
||||
|
||||
| Name | Description | Optional | Choices |
|
||||
| ---- | ----------- | -------- | ------- |
|
||||
| days | Number of days to look back | False | None |
|
||||
| sector | Sector to filter by | False | Basic Materials (BM), Energy (E), Communication Services (CS), Consumer Cyclical (CC), Consumer Defensive (CD), Financial (F), Healthcare (H), Industrials (I), Real Estate (RE), Technology (T), Utilities (U) |
|
||||
|
||||
|
||||
---
|
||||
|
||||
## Examples
|
||||
|
||||
```
|
||||
/dp sectors days:5 sector:Basic Materials
|
||||
```
|
||||
|
||||
---
|
||||
@@ -1,48 +0,0 @@
|
||||
---
|
||||
title: summary
|
||||
description: Learn how to retrieve a summary of all the prints by percentage of MarketCap
|
||||
over the last x days, sorted by MarketCap. Understand the usage, parameters, and
|
||||
see examples.
|
||||
keywords:
|
||||
- prints summary
|
||||
- MarketCap
|
||||
- Sort by MarketCap
|
||||
- /dp summary command
|
||||
- MarketCap over time
|
||||
- Market analysis
|
||||
- Financial Data Analysis
|
||||
- Short Percentage
|
||||
- Float
|
||||
---
|
||||
|
||||
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
|
||||
|
||||
<HeadTitle title="darkpool: summary - Discord Reference | OpenBB Bot Docs" />
|
||||
|
||||
This command retrieves a summary of all the prints by percentage of MarketCap over the last x days, sorted by MarketCap. The summary includes the total number of prints and their total percentage of MarketCap, as well as the float and short percentage.
|
||||
|
||||
### Usage
|
||||
|
||||
```python wordwrap
|
||||
/dp summary days sort
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Parameters
|
||||
|
||||
| Name | Description | Optional | Choices |
|
||||
| ---- | ----------- | -------- | ------- |
|
||||
| days | Number of days to look back | False | None |
|
||||
| sort | Sort by MarketCap, Float, Total, or Short Percentage | False | MarketCap (mc), Float (float), Total (sum), Short Percentage (short) |
|
||||
|
||||
|
||||
---
|
||||
|
||||
## Examples
|
||||
|
||||
```
|
||||
/dp summary days:10 sort:MarketCap
|
||||
```
|
||||
|
||||
---
|
||||
@@ -1,43 +0,0 @@
|
||||
---
|
||||
title: topsum
|
||||
description: The documentation page is about the 'topsum' command, which retrieves
|
||||
a total block and dark pool data summary. It also sums all darkpool prints and provides
|
||||
a table of the largest data by symbol along with a comparison graph. This command
|
||||
does not require any parameters.
|
||||
keywords:
|
||||
- topsum command
|
||||
- block and dark pool data summary
|
||||
- sum darkpool prints
|
||||
- largest data by symbol
|
||||
- comparison graph
|
||||
- command usage
|
||||
- no parameters command
|
||||
---
|
||||
|
||||
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
|
||||
|
||||
<HeadTitle title="darkpool: topsum - Discord Reference | OpenBB Bot Docs" />
|
||||
|
||||
This command allows the user to retrieve total block and dark pool data summary. It sums all darkpool prints and gives a table of the largest by symbol as well as a graph for comparison.
|
||||
|
||||
### Usage
|
||||
|
||||
```python wordwrap
|
||||
/dp topsum
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Parameters
|
||||
|
||||
This command has no parameters
|
||||
|
||||
|
||||
---
|
||||
|
||||
## Examples
|
||||
|
||||
```
|
||||
/dp topsum
|
||||
```
|
||||
---
|
||||
@@ -1,40 +0,0 @@
|
||||
---
|
||||
title: arktrades
|
||||
description: The page provides information about the arktrades command, which allows
|
||||
user to retrieve a list of all trades made by ARK.
|
||||
keywords:
|
||||
- arktrades
|
||||
- trades
|
||||
- ARK
|
||||
- data
|
||||
- table format
|
||||
---
|
||||
|
||||
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
|
||||
|
||||
<HeadTitle title="discovery: arktrades - Discord Reference | OpenBB Bot Docs" />
|
||||
|
||||
This command allows the user to retrieve a list of all trades made by ARK, including the time and amount of each trade. The data is presented in an easy-to-read table format so that the user can quickly analyze the trades made by ARK.
|
||||
|
||||
### Usage
|
||||
|
||||
```python wordwrap
|
||||
/disc arktrades
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Parameters
|
||||
|
||||
This command has no parameters
|
||||
|
||||
|
||||
|
||||
---
|
||||
|
||||
## Examples
|
||||
|
||||
```
|
||||
/disc arktrades
|
||||
```
|
||||
---
|
||||
@@ -1,43 +0,0 @@
|
||||
---
|
||||
title: contracts
|
||||
description: The page provides details on how to retrieve the top 15 Government contracts
|
||||
by amount for all tickers using the /disc contracts command. It gives insights into
|
||||
the total value of Government contracts awarded to various companies, helping users
|
||||
understand their financial health.
|
||||
keywords:
|
||||
- contracts
|
||||
- Government contracts
|
||||
- tickers
|
||||
- database
|
||||
- financial health
|
||||
- /disc contracts
|
||||
---
|
||||
|
||||
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
|
||||
|
||||
<HeadTitle title="discovery: contracts - Discord Reference | OpenBB Bot Docs" />
|
||||
|
||||
This command allows the user to retrieve the Top 15 Government contracts by amount for all tickers. This is a helpful tool for those who want to quickly get an overview of the total value of Government contracts awarded to various companies. The data is retrieved from a database of contracts and can be used to gain valuable insights into the financial health of those companies.
|
||||
|
||||
### Usage
|
||||
|
||||
```python wordwrap
|
||||
/disc contracts
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Parameters
|
||||
|
||||
This command has no parameters
|
||||
|
||||
|
||||
|
||||
---
|
||||
|
||||
## Examples
|
||||
|
||||
```
|
||||
/disc contracts
|
||||
```
|
||||
---
|
||||
@@ -1,45 +0,0 @@
|
||||
---
|
||||
title: fgindex
|
||||
description: The page defines the use of 'fgindex' command in getting the Fear & Greed
|
||||
Index. This is a key investor sentiment indicator by CNNMoney and offers insights
|
||||
into the stock market through analysis of momentum, sentiment, and trading volume.
|
||||
keywords:
|
||||
- fgindex
|
||||
- Fear & Greed Index
|
||||
- investor sentiment indicator
|
||||
- CNNMoney
|
||||
- stock market
|
||||
- market momentum
|
||||
- market sentiment
|
||||
- stock trading volume
|
||||
- score range 0-100
|
||||
---
|
||||
|
||||
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
|
||||
|
||||
<HeadTitle title="discovery: fgindex - Discord Reference | OpenBB Bot Docs" />
|
||||
|
||||
This command allows the user to retrieve the Fear & Greed Index, which is an investor sentiment indicator published by CNNMoney. The index measures the levels of fear and greed of the investors in the stock market by observing the momentum, sentiment and volume of stock trading. The index ranges from 0 to 100, with 0 being the most fearful and 100 being the most greedy.
|
||||
|
||||
### Usage
|
||||
|
||||
```python wordwrap
|
||||
/disc fgindex
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Parameters
|
||||
|
||||
This command has no parameters
|
||||
|
||||
|
||||
|
||||
---
|
||||
|
||||
## Examples
|
||||
|
||||
```
|
||||
/disc fgindex
|
||||
```
|
||||
---
|
||||
@@ -1,44 +0,0 @@
|
||||
---
|
||||
title: halts
|
||||
description: Improve your trading with the '/disc halts' command, allowing you to
|
||||
avoid significant losses due to temporary halts. The halt code and time of any halted
|
||||
or pending stock at the exchange are provided at your fingertips, excluding penny
|
||||
stocks.
|
||||
keywords:
|
||||
- Stock Market
|
||||
- Stocks
|
||||
- Pennystocks Exclusion
|
||||
- /disc halts Command
|
||||
- Stock Halt Code
|
||||
- Exchange
|
||||
- Stock Trading
|
||||
---
|
||||
|
||||
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
|
||||
|
||||
<HeadTitle title="discovery: halts - Discord Reference | OpenBB Bot Docs" />
|
||||
|
||||
This command allows the user to retrieve the time and halt code of stocks in the market, excluding penny stocks. The output of this command provides the user with the time and halt code of stock that is currently halted or in the process of being halted by the exchange.
|
||||
|
||||
### Usage
|
||||
|
||||
```python wordwrap
|
||||
/disc halts
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Parameters
|
||||
|
||||
This command has no parameters
|
||||
|
||||
|
||||
|
||||
---
|
||||
|
||||
## Examples
|
||||
|
||||
```
|
||||
/disc halts
|
||||
```
|
||||
---
|
||||
@@ -1,40 +0,0 @@
|
||||
---
|
||||
title: holidays
|
||||
description: The page provides detailed guidance on how to use the 'holidays' command
|
||||
to retrieve a list of upcoming market holidays, including their dates and types.
|
||||
This is particularly useful for users seeking to stay informed about upcoming events.
|
||||
keywords:
|
||||
- holidays
|
||||
- market holidays
|
||||
- upcoming holidays
|
||||
- national holidays
|
||||
---
|
||||
|
||||
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
|
||||
|
||||
<HeadTitle title="discovery: holidays - Discord Reference | OpenBB Bot Docs" />
|
||||
|
||||
This command allows the user to retrieve a list of upcoming market holidays. The command will return a list of holidays, including their respective dates, along with any other pertinent details, such as whether they are national holidays or not. This command is suitable for any user who needs to stay up to date with upcoming holidays.
|
||||
|
||||
### Usage
|
||||
|
||||
```python wordwrap
|
||||
/disc holidays
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Parameters
|
||||
|
||||
This command has no parameters
|
||||
|
||||
|
||||
|
||||
---
|
||||
|
||||
## Examples
|
||||
|
||||
```
|
||||
/disc holidays
|
||||
```
|
||||
---
|
||||
@@ -1,44 +0,0 @@
|
||||
---
|
||||
title: house
|
||||
description: This page provides a detailed explanation of the 'house' command in our
|
||||
platform, including its usage, parameters, and examples.
|
||||
keywords:
|
||||
- house command
|
||||
- recent house trades
|
||||
- trade time
|
||||
- trade size
|
||||
- trade price
|
||||
- command parameters
|
||||
- command usage
|
||||
- command examples
|
||||
- retrieve trades
|
||||
---
|
||||
|
||||
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
|
||||
|
||||
<HeadTitle title="discovery: house - Discord Reference | OpenBB Bot Docs" />
|
||||
|
||||
This command allows users to retrieve recent house trades for all tickers. The command will display the time of the trade, the ticker, the size of the trade, the price, and any other relevant details.
|
||||
|
||||
### Usage
|
||||
|
||||
```python wordwrap
|
||||
/disc house
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Parameters
|
||||
|
||||
This command has no parameters
|
||||
|
||||
|
||||
|
||||
---
|
||||
|
||||
## Examples
|
||||
|
||||
```
|
||||
/disc house
|
||||
```
|
||||
---
|
||||
@@ -1,62 +0,0 @@
|
||||
# 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>
|
||||
@@ -1,44 +0,0 @@
|
||||
---
|
||||
title: ipolist
|
||||
description: The ipolist command page provides details on how to use the command to
|
||||
get the latest and upcoming Initial Public Offerings (IPOs) information. The information
|
||||
includes the name of the company, IPO date, and the stock exchange.
|
||||
keywords:
|
||||
- ipolist command
|
||||
- initial public offerings
|
||||
- IPO updates
|
||||
- new companies
|
||||
- stock exchange
|
||||
- investment opportunities
|
||||
- upcoming IPOs
|
||||
- latest IPOs
|
||||
---
|
||||
|
||||
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
|
||||
|
||||
<HeadTitle title="discovery: ipolist - Discord Reference | OpenBB Bot Docs" />
|
||||
|
||||
This command allows the user to view 10 of the most recent and upcoming Initial Public Offerings (IPOs) including the company name, the IPO date, and the stock exchange. This information can help users stay up-to-date with the latest IPOs, and provide them with opportunities to invest in new companies.
|
||||
|
||||
### Usage
|
||||
|
||||
```python wordwrap
|
||||
/disc ipolist
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Parameters
|
||||
|
||||
This command has no parameters
|
||||
|
||||
|
||||
|
||||
---
|
||||
|
||||
## Examples
|
||||
|
||||
```
|
||||
/disc ipolist
|
||||
```
|
||||
---
|
||||
@@ -1,41 +0,0 @@
|
||||
---
|
||||
title: senate
|
||||
description: This page provides comprehensive information on the 'senate' command
|
||||
used to retrieve the most recent senate trades for all tickers. It includes details
|
||||
on usage, parameters, and examples.
|
||||
keywords:
|
||||
- senate command
|
||||
- trade retrieval
|
||||
- ticker information
|
||||
- price information
|
||||
- command usage
|
||||
---
|
||||
|
||||
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
|
||||
|
||||
<HeadTitle title="discovery: senate - Discord Reference | OpenBB Bot Docs" />
|
||||
|
||||
This command retrieves the most recent senate trades for all tickers including the date and time of the trade and the price information.
|
||||
|
||||
### Usage
|
||||
|
||||
```python wordwrap
|
||||
/disc senate
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Parameters
|
||||
|
||||
This command has no parameters
|
||||
|
||||
|
||||
|
||||
---
|
||||
|
||||
## Examples
|
||||
|
||||
```
|
||||
/disc senate
|
||||
```
|
||||
---
|
||||
@@ -1,44 +0,0 @@
|
||||
---
|
||||
title: splits
|
||||
description: The page provides a guide on using the /disc splits command to view a
|
||||
list of recent stock splits for all available tickers. It also provides insights
|
||||
on how to track past stock splits using this data. The information includes the
|
||||
ticker, date, and ratio of the split.
|
||||
keywords:
|
||||
- stock splits
|
||||
- view stock splits
|
||||
- track stock splits
|
||||
- /disc splits
|
||||
- stock splits data
|
||||
- ticker data
|
||||
- split ratio
|
||||
---
|
||||
|
||||
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
|
||||
|
||||
<HeadTitle title="discovery: splits - Discord Reference | OpenBB Bot Docs" />
|
||||
|
||||
This command allows users to view a list of recent stock splits for all available tickers. This list includes the ticker, the date of the split, and the ratio of the split. This data can be used to track how stocks have been split in the past.
|
||||
|
||||
### Usage
|
||||
|
||||
```python wordwrap
|
||||
/disc splits
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Parameters
|
||||
|
||||
This command has no parameters
|
||||
|
||||
|
||||
|
||||
---
|
||||
|
||||
## Examples
|
||||
|
||||
```
|
||||
/disc splits
|
||||
```
|
||||
---
|
||||
@@ -1,42 +0,0 @@
|
||||
---
|
||||
title: trendingst
|
||||
description: The docusaurus page explains how to use the 'trendingst' command to retrieve
|
||||
the top 15 trending stocks from StockTwits. It covers details on how the command
|
||||
works, its usage, and provides examples.
|
||||
keywords:
|
||||
- trending stocks
|
||||
- stocktwits
|
||||
- most discussed stocks
|
||||
- popular stocks
|
||||
- stock market trends
|
||||
- /disc trendingst
|
||||
---
|
||||
|
||||
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
|
||||
|
||||
<HeadTitle title="discovery: trendingst - Discord Reference | OpenBB Bot Docs" />
|
||||
|
||||
This command allows the user to retrieve the top 15 trending stocks from StockTwits according to the most recent discussions. The stocks are displayed in order of most trending, as determined by the most discussed stocks in the StockTwits community. This command is an efficient way to stay up to date on the most popular stocks in the market.
|
||||
|
||||
### Usage
|
||||
|
||||
```python wordwrap
|
||||
/disc trendingst
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Parameters
|
||||
|
||||
This command has no parameters
|
||||
|
||||
|
||||
|
||||
---
|
||||
|
||||
## Examples
|
||||
|
||||
```
|
||||
/disc trendingst
|
||||
```
|
||||
---
|
||||
@@ -1,43 +0,0 @@
|
||||
---
|
||||
title: wsb
|
||||
description: Learn how to view the top 15 trending stocks on r/WallStreetBets (WSB)
|
||||
by using the '/disc wsb' command. It provides mentions count for popular stocks,
|
||||
offering insights into the latest trends.
|
||||
keywords:
|
||||
- wsb command
|
||||
- trending stocks
|
||||
- Mentions count
|
||||
- /disc wsb
|
||||
- WallStreetBets
|
||||
- Popular stocks
|
||||
- Command parameters
|
||||
---
|
||||
|
||||
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
|
||||
|
||||
<HeadTitle title="discovery: wsb - Discord Reference | OpenBB Bot Docs" />
|
||||
|
||||
This command allows the user to view the top 15 trending stocks on r/WallStreetBets (WSB) using the /disc wsb command. It displays the mentions count for popular stocks on the platform.
|
||||
|
||||
### Usage
|
||||
|
||||
```python wordwrap
|
||||
/disc wsb
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Parameters
|
||||
|
||||
This command has no parameters
|
||||
|
||||
|
||||
|
||||
---
|
||||
|
||||
## Examples
|
||||
|
||||
```
|
||||
/disc wsb
|
||||
```
|
||||
---
|
||||
@@ -1,44 +0,0 @@
|
||||
---
|
||||
title: ah
|
||||
description: Documentation for the 'ah' command for retrieving afterhours data for
|
||||
a specific stock ticker, with usage, parameters, and examples.
|
||||
keywords:
|
||||
- Afterhours data
|
||||
- Stock ticker
|
||||
- Current stock price
|
||||
- Highest and lowest prices
|
||||
- Trade volume
|
||||
- Market change
|
||||
- Command usage
|
||||
- Python command
|
||||
---
|
||||
|
||||
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
|
||||
|
||||
<HeadTitle title="duedilligence: ah - Discord Reference | OpenBB Bot Docs" />
|
||||
|
||||
This command allows the user to retrieve afterhours data for a given stock ticker. The data retrieved will include the stock's current price, the highest and lowest prices of the ah session, the volume traded, and the change in the afterhours market.
|
||||
|
||||
### Usage
|
||||
|
||||
```python wordwrap
|
||||
/dd ah ticker
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Parameters
|
||||
|
||||
| Name | Description | Optional | Choices |
|
||||
| ---- | ----------- | -------- | ------- |
|
||||
| ticker | Stock Ticker | False | None |
|
||||
|
||||
|
||||
---
|
||||
|
||||
## Examples
|
||||
|
||||
```
|
||||
/dd ah ticker:AMD
|
||||
```
|
||||
---
|
||||
@@ -1,41 +0,0 @@
|
||||
---
|
||||
title: analyst
|
||||
description: The page defines the usage of the command 'analyst', which allows users
|
||||
to retrieve analyst recommendations for a specific stock ticker. Examples include
|
||||
finding recommendations for AMD stocks.
|
||||
keywords:
|
||||
- analyst command
|
||||
- stock ticker
|
||||
- retrieve analyst recommendations
|
||||
- AMD stock
|
||||
---
|
||||
|
||||
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
|
||||
|
||||
<HeadTitle title="duedilligence: analyst - Discord Reference | OpenBB Bot Docs" />
|
||||
|
||||
This command allows the user to retrieve analyst recommendations for a given stock ticker.
|
||||
|
||||
### Usage
|
||||
|
||||
```python wordwrap
|
||||
/dd analyst ticker
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Parameters
|
||||
|
||||
| Name | Description | Optional | Choices |
|
||||
| ---- | ----------- | -------- | ------- |
|
||||
| ticker | Stock Ticker | False | None |
|
||||
|
||||
|
||||
---
|
||||
|
||||
## Examples
|
||||
|
||||
```
|
||||
/dd analyst ticker:AMD
|
||||
```
|
||||
---
|
||||
@@ -1,46 +0,0 @@
|
||||
---
|
||||
title: bio
|
||||
description: This page provides information about 'bio' command that fetches a stock's
|
||||
company info such as name, description, sector, industry, CEO, etc. using a stock
|
||||
ticker.
|
||||
keywords:
|
||||
- bio command
|
||||
- stock's company info
|
||||
- stock ticker
|
||||
- stock information
|
||||
- company's name
|
||||
- company's description
|
||||
- company's sector
|
||||
- company's industry
|
||||
- company's CEO
|
||||
---
|
||||
|
||||
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
|
||||
|
||||
<HeadTitle title="duedilligence: bio - Discord Reference | OpenBB Bot Docs" />
|
||||
|
||||
This command retrieves a stock's company information and displays it to the user. It takes a stock ticker as an argument and returns information such as the company's name, description, sector, industry, CEO, and more.
|
||||
|
||||
### Usage
|
||||
|
||||
```python wordwrap
|
||||
/dd bio ticker
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Parameters
|
||||
|
||||
| Name | Description | Optional | Choices |
|
||||
| ---- | ----------- | -------- | ------- |
|
||||
| ticker | Stock Ticker | False | None |
|
||||
|
||||
|
||||
---
|
||||
|
||||
## Examples
|
||||
|
||||
```
|
||||
/dd bio ticker:AMD
|
||||
```
|
||||
---
|
||||
@@ -1,44 +0,0 @@
|
||||
---
|
||||
title: customer
|
||||
description: The page provides how to use the 'customer' command to display the customers
|
||||
of a company using a specific stock ticker. It includes a description of parameters
|
||||
and usage examples.
|
||||
keywords:
|
||||
- customer command
|
||||
- display customers
|
||||
- company customers
|
||||
- stock ticker
|
||||
- usage of customer command
|
||||
- parameters
|
||||
- examples
|
||||
---
|
||||
|
||||
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
|
||||
|
||||
<HeadTitle title="duedilligence: customer - Discord Reference | OpenBB Bot Docs" />
|
||||
|
||||
This command allows the user to display customers of the company using the given symbol.
|
||||
|
||||
### Usage
|
||||
|
||||
```python wordwrap
|
||||
/dd customer ticker
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Parameters
|
||||
|
||||
| Name | Description | Optional | Choices |
|
||||
| ---- | ----------- | -------- | ------- |
|
||||
| ticker | Stock Ticker | False | None |
|
||||
|
||||
|
||||
---
|
||||
|
||||
## Examples
|
||||
|
||||
```
|
||||
/dd customer ticker:AMD
|
||||
```
|
||||
---
|
||||
@@ -1,45 +0,0 @@
|
||||
---
|
||||
title: divinfo
|
||||
description: This page provides information about using the 'divinfo' command to retrieve
|
||||
dividend data, including rate, yield, and ex-div date for a specified stock ticker.
|
||||
keywords:
|
||||
- divinfo
|
||||
- dividend information
|
||||
- stock
|
||||
- dividend rate
|
||||
- yield
|
||||
- ex-div date
|
||||
- parameters
|
||||
- stock ticker
|
||||
- AAPL
|
||||
---
|
||||
|
||||
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
|
||||
|
||||
<HeadTitle title="duedilligence: divinfo - Discord Reference | OpenBB Bot Docs" />
|
||||
|
||||
This command retrieves dividend information for a given stock. The data includes dividend rate, yield, and ex-div date.
|
||||
|
||||
### Usage
|
||||
|
||||
```python wordwrap
|
||||
/dd divinfo ticker
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Parameters
|
||||
|
||||
| Name | Description | Optional | Choices |
|
||||
| ---- | ----------- | -------- | ------- |
|
||||
| ticker | Stock Ticker | False | None |
|
||||
|
||||
|
||||
---
|
||||
|
||||
## Examples
|
||||
|
||||
```
|
||||
/dd divinfo ticker:AAPL
|
||||
```
|
||||
---
|
||||
@@ -1,43 +0,0 @@
|
||||
---
|
||||
title: earnings
|
||||
description: Details on how to use the 'earnings' command to retrieve anticipated
|
||||
earnings for a specified business day. Information includes company ticker, expected
|
||||
time, sector, and float facilitating informed investment decisions.
|
||||
keywords:
|
||||
- earnings
|
||||
- investment decisions
|
||||
- company ticker
|
||||
- business day
|
||||
- sector
|
||||
- float
|
||||
---
|
||||
|
||||
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
|
||||
|
||||
<HeadTitle title="duedilligence: earnings - Discord Reference | OpenBB Bot Docs" />
|
||||
|
||||
This command allows the user to retrieve the expected earnings for the given business day. The displayed earnings will include company ticker, expected time, sector, and float of the company. This information can be used to help the user make informed decisions about their investments.
|
||||
|
||||
### Usage
|
||||
|
||||
```python wordwrap
|
||||
/dd earnings day
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Parameters
|
||||
|
||||
| Name | Description | Optional | Choices |
|
||||
| ---- | ----------- | -------- | ------- |
|
||||
| day | Date to get earnings for (YYYY-MM-DD) | False | None |
|
||||
|
||||
|
||||
---
|
||||
|
||||
## Examples
|
||||
|
||||
```
|
||||
/dd earnings day:2022-07-29
|
||||
```
|
||||
---
|
||||
@@ -1,45 +0,0 @@
|
||||
---
|
||||
title: ermove
|
||||
description: The documentation page provides a detailed explanation of the ermove
|
||||
command that allows users to fetch the implied stock move based on current option
|
||||
prices. It also guides on using the stock ticker to retrieve this information.
|
||||
keywords:
|
||||
- ermove command
|
||||
- retrieve implied move
|
||||
- stock
|
||||
- option prices
|
||||
- stock movement measure
|
||||
- option's expiration
|
||||
- stock ticker
|
||||
- stock market
|
||||
---
|
||||
|
||||
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
|
||||
|
||||
<HeadTitle title="duedilligence: ermove - Discord Reference | OpenBB Bot Docs" />
|
||||
|
||||
This command allows the user to retrieve the implied move for a stock based on the current option prices. The implied move is a measure of how far the stock is expected to move during the option's expiration.
|
||||
|
||||
### Usage
|
||||
|
||||
```python wordwrap
|
||||
/dd ermove ticker
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Parameters
|
||||
|
||||
| Name | Description | Optional | Choices |
|
||||
| ---- | ----------- | -------- | ------- |
|
||||
| ticker | Stock Ticker | False | None |
|
||||
|
||||
|
||||
---
|
||||
|
||||
## Examples
|
||||
|
||||
```
|
||||
/dd ermove ticker:AMD
|
||||
```
|
||||
---
|
||||
@@ -1,42 +0,0 @@
|
||||
---
|
||||
title: est
|
||||
description: Detailed guide on how to retrieve earning estimates with the 'est' command
|
||||
for various stock symbols. Ideal for investors seeking insights on potential stock
|
||||
performance.
|
||||
keywords:
|
||||
- est command guide
|
||||
- earning estimates
|
||||
- stock symbols
|
||||
- investor tools
|
||||
- stock performance
|
||||
---
|
||||
|
||||
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
|
||||
|
||||
<HeadTitle title="duedilligence: est - Discord Reference | OpenBB Bot Docs" />
|
||||
|
||||
This command allows the user to retrieve earning estimates for a given stock symbol. This can be used as a helpful tool for investors to get an idea of how a stock may perform in terms of earnings.
|
||||
|
||||
### Usage
|
||||
|
||||
```python wordwrap
|
||||
/dd est ticker
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Parameters
|
||||
|
||||
| Name | Description | Optional | Choices |
|
||||
| ---- | ----------- | -------- | ------- |
|
||||
| ticker | Stock Ticker | False | None |
|
||||
|
||||
|
||||
---
|
||||
|
||||
## Examples
|
||||
|
||||
```
|
||||
/dd est ticker:MMM
|
||||
```
|
||||
---
|
||||
@@ -1,45 +0,0 @@
|
||||
---
|
||||
title: financials
|
||||
description: This page provides information on the financials command which retrieves
|
||||
total assets, cash, debt, liabilities, and revenue of a company using its stock
|
||||
ticker. The data can be used to analyze a company's financial health.
|
||||
keywords:
|
||||
- financials
|
||||
- total assets
|
||||
- cash
|
||||
- debt
|
||||
- liabilities
|
||||
- revenue
|
||||
- company financial health
|
||||
- stock
|
||||
---
|
||||
|
||||
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
|
||||
|
||||
<HeadTitle title="duedilligence: financials - Discord Reference | OpenBB Bot Docs" />
|
||||
|
||||
This command will retrieve the financials of the company with the given ticker which includes total assets, cash, debt, liabilities, and revenue. This information can be used to analyze the financial health of the company.
|
||||
|
||||
### Usage
|
||||
|
||||
```python wordwrap
|
||||
/dd financials ticker
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Parameters
|
||||
|
||||
| Name | Description | Optional | Choices |
|
||||
| ---- | ----------- | -------- | ------- |
|
||||
| ticker | Stock Ticker | False | None |
|
||||
|
||||
|
||||
---
|
||||
|
||||
## Examples
|
||||
|
||||
```
|
||||
/dd financials ticker:AMD
|
||||
```
|
||||
---
|
||||
@@ -1,97 +0,0 @@
|
||||
# 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>
|
||||
@@ -1,44 +0,0 @@
|
||||
---
|
||||
title: insiders
|
||||
description: The Insiders page allows users to retrieve the 15 most recent insider
|
||||
transactions for a given stock, including the date of the transaction, the insider
|
||||
involved, the number of shares traded, the type of transaction, and the average
|
||||
price. You can run this command by entering '/dd insiders ticker:<ticker>'.
|
||||
keywords:
|
||||
- insiders command
|
||||
- recent insider transactions
|
||||
- stock information
|
||||
- shares traded
|
||||
- transaction type
|
||||
- average price
|
||||
---
|
||||
|
||||
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
|
||||
|
||||
<HeadTitle title="duedilligence: insiders - Discord Reference | OpenBB Bot Docs" />
|
||||
|
||||
This command allows the user to retrieve the 15 most recent insider transactions for a given stock. It will provide information such as the date of the transaction, the company insider involved, the number of shares traded, the type of transaction (buy/sell), and the average price of the transaction.
|
||||
|
||||
### Usage
|
||||
|
||||
```python wordwrap
|
||||
/dd insiders ticker
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Parameters
|
||||
|
||||
| Name | Description | Optional | Choices |
|
||||
| ---- | ----------- | -------- | ------- |
|
||||
| ticker | Stock Ticker | False | None |
|
||||
|
||||
|
||||
---
|
||||
|
||||
## Examples
|
||||
|
||||
```
|
||||
/dd insiders ticker:AMD
|
||||
```
|
||||
---
|
||||
@@ -1,43 +0,0 @@
|
||||
---
|
||||
title: instholdings
|
||||
description: This page provides details on the instholdings command which retrieves
|
||||
the top 15 institutional holdings for a given stock, as reported to the United States
|
||||
Securities and Exchange Commission.
|
||||
keywords:
|
||||
- instholdings command
|
||||
- institutional holdings
|
||||
- stock
|
||||
- United States Securities and Exchange Commission
|
||||
- SEC
|
||||
- stock ticker
|
||||
---
|
||||
|
||||
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
|
||||
|
||||
<HeadTitle title="duedilligence: instholdings - Discord Reference | OpenBB Bot Docs" />
|
||||
|
||||
This command allows the user to retrieve the top 15 institutional holdings for a given stock. This list is retrieved from the most recent available institutional holdings reported to the United States Securities and Exchange Commission.
|
||||
|
||||
### Usage
|
||||
|
||||
```python wordwrap
|
||||
/dd instholdings ticker
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Parameters
|
||||
|
||||
| Name | Description | Optional | Choices |
|
||||
| ---- | ----------- | -------- | ------- |
|
||||
| ticker | Stock Ticker | False | None |
|
||||
|
||||
|
||||
---
|
||||
|
||||
## Examples
|
||||
|
||||
```
|
||||
/dd instholdings ticker:AMD
|
||||
```
|
||||
---
|
||||
@@ -1,42 +0,0 @@
|
||||
---
|
||||
title: nexter
|
||||
description: This document provides guidance on how to use the nexter command to retrieve
|
||||
the next earnings date for a provided stock ticker symbol. Examples include usage
|
||||
with AMD stock.
|
||||
keywords:
|
||||
- nexter command
|
||||
- earnings date
|
||||
- stock ticker symbol
|
||||
- financial data
|
||||
- AMD stock
|
||||
---
|
||||
|
||||
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
|
||||
|
||||
<HeadTitle title="duedilligence: nexter - Discord Reference | OpenBB Bot Docs" />
|
||||
|
||||
This command will retrieve the next earnings date for the given stock ticker symbol.
|
||||
|
||||
### Usage
|
||||
|
||||
```python wordwrap
|
||||
/dd nexter ticker
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Parameters
|
||||
|
||||
| Name | Description | Optional | Choices |
|
||||
| ---- | ----------- | -------- | ------- |
|
||||
| ticker | Stock Ticker | False | None |
|
||||
|
||||
|
||||
---
|
||||
|
||||
## Examples
|
||||
|
||||
```
|
||||
/dd nexter ticker:AMD
|
||||
```
|
||||
---
|
||||
@@ -1,41 +0,0 @@
|
||||
---
|
||||
title: pm
|
||||
description: This page describes the command that retrieves premarket data for a given
|
||||
stock ticker. It is a valuable resource for those keen on understanding a stock's
|
||||
performance before the regular market commences.
|
||||
keywords:
|
||||
- stock
|
||||
- premarket data
|
||||
- stock ticker
|
||||
- market performance
|
||||
---
|
||||
|
||||
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
|
||||
|
||||
<HeadTitle title="duedilligence: pm - Discord Reference | OpenBB Bot Docs" />
|
||||
|
||||
This command allows the user to retrieve premarket data for a given stock ticker. It will fetch the latest price, the premarket change, and the premarket percentage change of the selected stock. This is useful for those who want to get an idea of the stock's performance before the regular market opens.
|
||||
|
||||
### Usage
|
||||
|
||||
```python wordwrap
|
||||
/dd pm ticker
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Parameters
|
||||
|
||||
| Name | Description | Optional | Choices |
|
||||
| ---- | ----------- | -------- | ------- |
|
||||
| ticker | Stock Ticker | False | None |
|
||||
|
||||
|
||||
---
|
||||
|
||||
## Examples
|
||||
|
||||
```
|
||||
/dd pm ticker:AMD
|
||||
```
|
||||
---
|
||||
@@ -1,44 +0,0 @@
|
||||
---
|
||||
title: pt
|
||||
description: This documentation page contains information about the pt command for
|
||||
retrieving a chart with stock price targets. By using this command, users can obtain
|
||||
crucial information about the current price, target prices, and analyst ratings
|
||||
of a specified ticker, thus enabling them to make more informed decisions.
|
||||
keywords:
|
||||
- pt command
|
||||
- stock price targets
|
||||
- current price
|
||||
- target prices
|
||||
- analyst ratings
|
||||
- informed decisions
|
||||
---
|
||||
|
||||
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
|
||||
|
||||
<HeadTitle title="duedilligence: pt - Discord Reference | OpenBB Bot Docs" />
|
||||
|
||||
This command allows the user to retrieve a chart with price targets for the specified ticker. The chart will provide information on the current price, target prices and analyst ratings, allowing the user to make more informed decisions.
|
||||
|
||||
### Usage
|
||||
|
||||
```python wordwrap
|
||||
/dd pt ticker
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Parameters
|
||||
|
||||
| Name | Description | Optional | Choices |
|
||||
| ---- | ----------- | -------- | ------- |
|
||||
| ticker | Stock Ticker | False | None |
|
||||
|
||||
|
||||
---
|
||||
|
||||
## Examples
|
||||
|
||||
```
|
||||
/dd pt ticker:AMD
|
||||
```
|
||||
---
|
||||
@@ -1,52 +0,0 @@
|
||||
---
|
||||
title: sec
|
||||
description: The sec documentation page details how to use a feature for retrieving
|
||||
the latest SEC filings related to a specific ticker symbol. Information available
|
||||
includes company financials, registration statements, and periodic reports such
|
||||
as 10-Ks, 8-Ks, and 10-Qs. Useful for investors and analysts needing current data
|
||||
on a company's financial performance or other corporate documents.
|
||||
keywords:
|
||||
- sec command
|
||||
- retrieve SEC filings
|
||||
- financial performance
|
||||
- corporate documents
|
||||
- stock ticker
|
||||
- company financials
|
||||
- 10-Ks
|
||||
- 8-Ks
|
||||
- 10-Qs
|
||||
- registration statements
|
||||
- investors
|
||||
- analysts
|
||||
- periodic reports
|
||||
---
|
||||
|
||||
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
|
||||
|
||||
<HeadTitle title="duedilligence: sec - Discord Reference | OpenBB Bot Docs" />
|
||||
|
||||
This command allows the user to retrieve the most recent SEC filings related to the specified ticker symbol. The filings can include company financials, registration statements, and periodic reports such as 10-Ks, 8-Ks, and 10-Qs. This command is especially useful for investors and analysts who need up-to-date information on a company's financial performance or other corporate documents.
|
||||
|
||||
### Usage
|
||||
|
||||
```python wordwrap
|
||||
/dd sec ticker
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Parameters
|
||||
|
||||
| Name | Description | Optional | Choices |
|
||||
| ---- | ----------- | -------- | ------- |
|
||||
| ticker | Stock Ticker | False | None |
|
||||
|
||||
|
||||
---
|
||||
|
||||
## Examples
|
||||
|
||||
```
|
||||
/dd sec ticker:AMD
|
||||
```
|
||||
---
|
||||
@@ -1,41 +0,0 @@
|
||||
---
|
||||
title: splits
|
||||
description: Learn how to use the splits command in Docusaurus to track recent stock
|
||||
splits for a given ticker over time. Detailed usage and examples provided.
|
||||
keywords:
|
||||
- stock splits
|
||||
- tracking stock splits
|
||||
- stock ticker
|
||||
- docusaurus command for stock splits
|
||||
---
|
||||
|
||||
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
|
||||
|
||||
<HeadTitle title="duedilligence: splits - Discord Reference | OpenBB Bot Docs" />
|
||||
|
||||
This command retrieves a list of recent stock splits for a given ticker. This command is useful for tracking the splits of a particular stock over time.
|
||||
|
||||
### Usage
|
||||
|
||||
```python wordwrap
|
||||
/dd splits ticker
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Parameters
|
||||
|
||||
| Name | Description | Optional | Choices |
|
||||
| ---- | ----------- | -------- | ------- |
|
||||
| ticker | Stock Ticker | False | None |
|
||||
|
||||
|
||||
---
|
||||
|
||||
## Examples
|
||||
|
||||
```
|
||||
/dd splits ticker:AMD
|
||||
```
|
||||
|
||||
---
|
||||
@@ -1,41 +0,0 @@
|
||||
---
|
||||
title: supplier
|
||||
description: This page provides information on the 'supplier' command, which allows
|
||||
users to retrieve the list of suppliers associated with a stock ticker. Usage, parameters,
|
||||
and examples are included for a clear understanding.
|
||||
keywords:
|
||||
- supplier
|
||||
- stock
|
||||
- company supplier retrieval
|
||||
- AMD
|
||||
---
|
||||
|
||||
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
|
||||
|
||||
<HeadTitle title="duedilligence: supplier - Discord Reference | OpenBB Bot Docs" />
|
||||
|
||||
This command allows users to retrieve the list of suppliers associated with the company with the given ticker.
|
||||
|
||||
### Usage
|
||||
|
||||
```python wordwrap
|
||||
/dd supplier ticker
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Parameters
|
||||
|
||||
| Name | Description | Optional | Choices |
|
||||
| ---- | ----------- | -------- | ------- |
|
||||
| ticker | Stock Ticker | False | None |
|
||||
|
||||
|
||||
---
|
||||
|
||||
## Examples
|
||||
|
||||
```
|
||||
/dd supplier ticker:AMD
|
||||
```
|
||||
---
|
||||
@@ -1,41 +0,0 @@
|
||||
---
|
||||
title: ytd
|
||||
description: A documentation page explaining the 'ytd' command that retrieves the
|
||||
year-to-date performance for a particular stock's ticker symbol. Includes usage,
|
||||
parameter information, and examples.
|
||||
keywords:
|
||||
- ytd command
|
||||
- stock performance
|
||||
- ticker symbol
|
||||
- AAPL
|
||||
---
|
||||
|
||||
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
|
||||
|
||||
<HeadTitle title="duedilligence: ytd - Discord Reference | OpenBB Bot Docs" />
|
||||
|
||||
This command allows the user to retrieve the stock's year-to-date performance for a particular ticker symbol. It displays the stock's performance over various periods of time, from 5 days to 5 years.
|
||||
|
||||
### Usage
|
||||
|
||||
```python wordwrap
|
||||
/dd ytd ticker
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Parameters
|
||||
|
||||
| Name | Description | Optional | Choices |
|
||||
| ---- | ----------- | -------- | ------- |
|
||||
| ticker | Stock Ticker | False | None |
|
||||
|
||||
|
||||
---
|
||||
|
||||
## Examples
|
||||
|
||||
```
|
||||
/dd ytd ticker:AAPL
|
||||
```
|
||||
---
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user