mirror of
https://github.com/OpenBB-finance/OpenBB.git
synced 2026-10-27 04:31:13 +00:00
Docs fixes (#3530)
* fix(docs): added margin between sections * fix: images * readd old content for examples/images * fix: codespell * fix: codespell * fix: ga * fix: remove temp lorem ipsum * fix: docu config for edit page Co-authored-by: teh_coderer <me@tehcoderer.com>
This commit is contained in:
jose-donato
2
.github/workflows/gh-pages.yml
vendored
2
.github/workflows/gh-pages.yml
vendored
@@ -38,7 +38,7 @@ jobs:
|
||||
run: poetry install --no-interaction --no-root
|
||||
|
||||
- name: Install packages
|
||||
run: poetry install --no-interaction -E prediction -E docs
|
||||
run: poetry install --no-interaction -E prediction -E doc
|
||||
|
||||
- run: |
|
||||
source $VENV
|
||||
|
||||
8
.github/workflows/test.yml
vendored
8
.github/workflows/test.yml
vendored
@@ -13,7 +13,7 @@ jobs:
|
||||
if: github.event_name == 'push' || github.event.pull_request.head.repo.full_name != github.repository
|
||||
steps:
|
||||
- name: Checkout Code
|
||||
uses: actions/checkout@2541b1294d2704b0964813337f33b291d3f8596b # actions/checkout v3.0.2
|
||||
uses: actions/checkout@2541b1294d2704b0964813337f33b291d3f8596b # actions/checkout v3.0.2
|
||||
|
||||
- name: Setup Python 3.9
|
||||
uses: actions/setup-python@v4
|
||||
@@ -27,13 +27,11 @@ jobs:
|
||||
key: ${{ runner.os }}-v1-linting
|
||||
restore-keys: ${{ runner.os }}-v1-linting
|
||||
|
||||
|
||||
- run: python custom_pre_commit/check_doc.py --ignore-files=settings_controller.py,keys_controller.py,featflags_controller.py,degiro_controller.py,oanda_controller.py --ignore-commands=login,alswe,infoswe,goodness,resources,yf,yolo,featflags,guess,settings,survey,intro
|
||||
- run: pip install bandit black codespell flake8 mypy==0.982 pyupgrade safety pylint==2.15.2
|
||||
- run: pip install types-pytz types-requests types-termcolor types-tabulate types-PyYAML types-python-dateutil types-setuptools types-six
|
||||
- run: bandit -x ./tests -r . || true
|
||||
- run: black --diff --check .
|
||||
- run: codespell --ignore-words-list=commun,statics,ro,zar,zlot,ba,buil,coo,ether,hist,hsi,mape,navagation,operatio,pres,ser,yeld,shold,ist,varian,datas,ake,creat,vie,hel --quiet-level=2 --skip=./tests,.git,*.css,*.csv,*.html,*.ini,*.ipynb,*.js,*.json,*.lock,*.scss,*.txt,*.yaml,./build/pyinstaller,./website/config.toml
|
||||
- run: codespell --ignore-words-list=commun,statics,ro,zar,zlot,ba,buil,coo,ether,hist,hsi,mape,navagation,operatio,pres,ser,yeld,shold,ist,varian,datas,ake,creat,vie,hel,ket,toke,certi,buidl --quiet-level=2 --skip=./tests,.git,*.css,*.csv,*.html,*.ini,*.ipynb,*.js,*.json,*.lock,*.scss,*.txt,*.yaml,./build/pyinstaller,./website/config.toml
|
||||
- run: flake8 . --count --ignore=E203,W503 --max-line-length=122 --show-source --statistics --exclude ./build/pyinstaller,./website/content
|
||||
- run: mypy --ignore-missing-imports openbb_terminal
|
||||
- run: shopt -s globstar && pyupgrade --py38-plus **/*.py
|
||||
@@ -261,7 +259,7 @@ jobs:
|
||||
|
||||
- name: Run tests (Bash)
|
||||
env:
|
||||
MPLBACKEND: Agg
|
||||
MPLBACKEND: Agg
|
||||
shell: bash -l {0}
|
||||
run: pytest tests/ -m "not linux"
|
||||
|
||||
|
||||
2
.pre-commit-config.yaml
vendored
2
.pre-commit-config.yaml
vendored
@@ -25,7 +25,7 @@ repos:
|
||||
entry: codespell
|
||||
args:
|
||||
[
|
||||
"--ignore-words-list=commun,ro,zar,vie,hel,zlot,ba,buil,coo,ether,hist,hsi,mape,navagation,operatio,pres,ser,yeld,shold,ist,varian,datas,ake,creat,statics",
|
||||
"--ignore-words-list=commun,ro,zar,vie,hel,zlot,ba,buil,coo,ether,hist,hsi,mape,navagation,operatio,pres,ser,yeld,shold,ist,varian,datas,ake,creat,statics,ket,toke,certi,buidl",
|
||||
"--quiet-level=2",
|
||||
"--skip=./tests,.git,*.css,*.csv,*.html,*.ini,*.ipynb,*.js,*.json,*.lock,*.scss,*.txt,*.yaml,build/pyinstaller/*,./website/config.toml",
|
||||
]
|
||||
|
||||
34
CODE_OF_CONDUCT.md
vendored
34
CODE_OF_CONDUCT.md
vendored
@@ -20,28 +20,28 @@ If you see someone who is making an extra effort to ensure our community is welc
|
||||
|
||||
The following behaviors are expected and requested of all community members:
|
||||
|
||||
* Participate in an authentic and active way. In doing so, you contribute to the health and longevity of this community.
|
||||
* Exercise consideration and respect in your speech and actions.
|
||||
* Attempt collaboration before conflict.
|
||||
* Refrain from demeaning, discriminatory, or harassing behavior and speech.
|
||||
* Be mindful of your surroundings and of your fellow participants. Alert community leaders if you notice a dangerous situation, someone in distress, or violations of this Code of Conduct, even if they seem inconsequential.
|
||||
* Remember that community event venues may be shared with members of the public; please be respectful to all patrons of these locations.
|
||||
- Participate in an authentic and active way. In doing so, you contribute to the health and longevity of this community.
|
||||
- Exercise consideration and respect in your speech and actions.
|
||||
- Attempt collaboration before conflict.
|
||||
- Refrain from demeaning, discriminatory, or harassing behavior and speech.
|
||||
- Be mindful of your surroundings and of your fellow participants. Alert community leaders if you notice a dangerous situation, someone in distress, or violations of this Code of Conduct, even if they seem inconsequential.
|
||||
- Remember that community event venues may be shared with members of the public; please be respectful to all patrons of these locations.
|
||||
|
||||
## 4. Unacceptable Behavior
|
||||
|
||||
The following behaviors are considered harassment and are unacceptable within our community:
|
||||
|
||||
* Violence, threats of violence or violent language directed against another person.
|
||||
* Sexist, racist, homophobic, transphobic, ableist or otherwise discriminatory jokes and language.
|
||||
* Posting or displaying sexually explicit or violent material.
|
||||
* Posting or threatening to post other people's personally identifying information ("doxing").
|
||||
* Personal insults, particularly those related to gender, sexual orientation, race, religion, or disability.
|
||||
* Inappropriate photography or recording.
|
||||
* Inappropriate physical contact. You should have someone's consent before touching them.
|
||||
* Unwelcome sexual attention. This includes, sexualized comments or jokes; inappropriate touching, groping, and unwelcomed sexual advances.
|
||||
* Deliberate intimidation, stalking or following (online or in person).
|
||||
* Advocating for, or encouraging, any of the above behavior.
|
||||
* Sustained disruption of community events, including talks and presentations.
|
||||
- Violence, threats of violence or violent language directed against another person.
|
||||
- Sexist, racist, homophobic, transphobic, ableist or otherwise discriminatory jokes and language.
|
||||
- Posting or displaying sexually explicit or violent material.
|
||||
- Posting or threatening to post other people's personally identifying information ("doxing").
|
||||
- Personal insults, particularly those related to gender, sexual orientation, race, religion, or disability.
|
||||
- Inappropriate photography or recording.
|
||||
- Inappropriate physical contact. You should have someone's consent before touching them.
|
||||
- Unwelcome sexual attention. This includes, sexualized comments or jokes; inappropriate touching, groping, and unwelcomed sexual advances.
|
||||
- Deliberate intimidation, stalking or following (online or in person).
|
||||
- Advocating for, or encouraging, any of the above behavior.
|
||||
- Sustained disruption of community events, including talks and presentations.
|
||||
|
||||
## 6. Consequences of Unacceptable Behavior
|
||||
|
||||
|
||||
File diff suppressed because it is too large
Load Diff
@@ -17,24 +17,23 @@ obb.stocks.load(
|
||||
)
|
||||
```
|
||||
|
||||
| date | Open | High | Low | Close | Adj Close | Volume |
|
||||
|:--------------------|--------:|-------:|-------:|--------:|------------:|------------:|
|
||||
| 2022-11-15 15:00:00 | 398.68 | 399.4 | 398.13 | 398.47 | 398.47 | 2.46198e+06 |
|
||||
| 2022-11-15 15:15:00 | 398.475 | 399.52 | 398.46 | 398.913 | 398.913 | 2.8631e+06 |
|
||||
| 2022-11-15 15:30:00 | 398.93 | 399.27 | 397.82 | 399.11 | 399.11 | 3.03659e+06 |
|
||||
| 2022-11-15 15:45:00 | 399.114 | 399.13 | 397.46 | 398.53 | 398.53 | 6.46879e+06 |
|
||||
| 2022-11-15 16:00:00 | 398.54 | 399.06 | 395.01 | 398.175 | 398.175 | 1.99462e+06 |
|
||||
|
||||
| date | Open | High | Low | Close | Adj Close | Volume |
|
||||
| :------------------ | ------: | -----: | -----: | ------: | --------: | ----------: |
|
||||
| 2022-11-15 15:00:00 | 398.68 | 399.4 | 398.13 | 398.47 | 398.47 | 2.46198e+06 |
|
||||
| 2022-11-15 15:15:00 | 398.475 | 399.52 | 398.46 | 398.913 | 398.913 | 2.8631e+06 |
|
||||
| 2022-11-15 15:30:00 | 398.93 | 399.27 | 397.82 | 399.11 | 399.11 | 3.03659e+06 |
|
||||
| 2022-11-15 15:45:00 | 399.114 | 399.13 | 397.46 | 398.53 | 398.53 | 6.46879e+06 |
|
||||
| 2022-11-15 16:00:00 | 398.54 | 399.06 | 395.01 | 398.175 | 398.175 | 1.99462e+06 |
|
||||
|
||||
The choices for the `source` are currently:
|
||||
|
||||
- YahooFinance (default)
|
||||
- IEXCloud
|
||||
- AlphaVantage
|
||||
- Polygon
|
||||
- EODHD
|
||||
- YahooFinance (default)
|
||||
- IEXCloud
|
||||
- AlphaVantage
|
||||
- Polygon
|
||||
- EODHD
|
||||
|
||||
Each source may have unique arguments, consult the docstrings for specfic details. If the command syntax is not framed as a variable assignment, results are printed as a table. When assigned to a variable, the table is not displayed.
|
||||
Each source may have unique arguments, consult the docstrings for specific details. If the command syntax is not framed as a variable assignment, results are printed as a table. When assigned to a variable, the table is not displayed.
|
||||
|
||||
There are functions which return a Tuple, and they can be identified through the docstrings. It will also be evident when the returned data is not presented as a DataFrame. The list, highlighted in the right frame of the image below, provides guidance for unpacking the results.
|
||||
|
||||
@@ -56,11 +55,10 @@ spx_daily = pdr.get_data_stooq('^SPX', start = '1990-11-11')
|
||||
spx_daily.tail(5)
|
||||
```
|
||||
|
||||
| Date | Open | High | Low | Close | Volume |
|
||||
|:--------------------|-------:|-------:|-------:|--------:|------------:|
|
||||
| 1990-11-16 00:00:00 | 317.02 | 318.8 | 314.99 | 317.12 | 9.19111e+07 |
|
||||
| 1990-11-15 00:00:00 | 320.4 | 320.4 | 316.13 | 317.02 | 8.40944e+07 |
|
||||
| 1990-11-14 00:00:00 | 317.66 | 321.7 | 317.23 | 320.4 | 9.96167e+07 |
|
||||
| 1990-11-13 00:00:00 | 319.48 | 319.48 | 317.26 | 317.67 | 8.90222e+07 |
|
||||
| 1990-11-12 00:00:00 | 313.74 | 319.77 | 313.73 | 319.48 | 8.96611e+07 |
|
||||
|
||||
| Date | Open | High | Low | Close | Volume |
|
||||
| :------------------ | -----: | -----: | -----: | -----: | ----------: |
|
||||
| 1990-11-16 00:00:00 | 317.02 | 318.8 | 314.99 | 317.12 | 9.19111e+07 |
|
||||
| 1990-11-15 00:00:00 | 320.4 | 320.4 | 316.13 | 317.02 | 8.40944e+07 |
|
||||
| 1990-11-14 00:00:00 | 317.66 | 321.7 | 317.23 | 320.4 | 9.96167e+07 |
|
||||
| 1990-11-13 00:00:00 | 319.48 | 319.48 | 317.26 | 317.67 | 8.90222e+07 |
|
||||
| 1990-11-12 00:00:00 | 313.74 | 319.77 | 313.73 | 319.48 | 8.96611e+07 |
|
||||
|
||||
@@ -22,13 +22,13 @@ results = results.sort_values(ascending = False, by = ['Volume'])
|
||||
results.head(5)
|
||||
```
|
||||
|
||||
| | Ticker | Beta | ATR | SMA20 | SMA50 | SMA200 | 52W High | 52W Low | RSI | Price | Change | from Open | Gap | Volume |
|
||||
|---:|:---------|-------:|------:|--------:|--------:|---------:|-----------:|----------:|------:|--------:|---------:|------------:|--------:|------------:|
|
||||
| 48 | CUEN | 0.61 | 0.04 | -0.0367 | -0.2802 | -0.5626 | -0.8793 | 0.1505 | 39.65 | 0.35 | 0.0494 | -0.2249 | 0.3539 | 1.15487e+07 |
|
||||
| 16 | PDSB | 2.54 | 0.55 | 0.6788 | 1.0466 | 0.7899 | -0.248 | 2.0104 | 83.52 | 8.7 | 0.2323 | 0.1951 | 0.0312 | 6.32774e+06 |
|
||||
| 32 | IBTE | nan | 0.05 | 0.0025 | -0.0015 | -0.0214 | -0.0661 | 0.0076 | 53.72 | 23.89 | 0.0008 | 0.0004 | 0.0004 | 5.85758e+06 |
|
||||
| 11 | PTLO | nan | 1.28 | 0.033 | 0.038 | 0.0368 | -0.6097 | 0.5187 | 52.02 | 22.53 | -0.0941 | -0.004 | -0.0905 | 3.96768e+06 |
|
||||
| 65 | ABMD | 1.32 | 10.78 | 0.1822 | 0.3316 | 0.3296 | -0.0201 | 0.7027 | 78.79 | 374.32 | 0.0006 | -0.0006 | 0.0011 | 3.50787e+06 |
|
||||
| | Ticker | Beta | ATR | SMA20 | SMA50 | SMA200 | 52W High | 52W Low | RSI | Price | Change | from Open | Gap | Volume |
|
||||
| --: | :----- | ---: | ----: | ------: | ------: | ------: | -------: | ------: | ----: | -----: | ------: | --------: | ------: | ----------: |
|
||||
| 48 | CUEN | 0.61 | 0.04 | -0.0367 | -0.2802 | -0.5626 | -0.8793 | 0.1505 | 39.65 | 0.35 | 0.0494 | -0.2249 | 0.3539 | 1.15487e+07 |
|
||||
| 16 | PDSB | 2.54 | 0.55 | 0.6788 | 1.0466 | 0.7899 | -0.248 | 2.0104 | 83.52 | 8.7 | 0.2323 | 0.1951 | 0.0312 | 6.32774e+06 |
|
||||
| 32 | IBTE | nan | 0.05 | 0.0025 | -0.0015 | -0.0214 | -0.0661 | 0.0076 | 53.72 | 23.89 | 0.0008 | 0.0004 | 0.0004 | 5.85758e+06 |
|
||||
| 11 | PTLO | nan | 1.28 | 0.033 | 0.038 | 0.0368 | -0.6097 | 0.5187 | 52.02 | 22.53 | -0.0941 | -0.004 | -0.0905 | 3.96768e+06 |
|
||||
| 65 | ABMD | 1.32 | 10.78 | 0.1822 | 0.3316 | 0.3296 | -0.0201 | 0.7027 | 78.79 | 374.32 | 0.0006 | -0.0006 | 0.0011 | 3.50787e+06 |
|
||||
|
||||
This will fetch results from the options screener with the preset, `Highest_OI`:
|
||||
|
||||
@@ -40,13 +40,13 @@ results, title = openbb.stocks.options.screen.screener_output(preset='Highest_OI
|
||||
pd.DataFrame(results.head(5))
|
||||
```
|
||||
|
||||
| | Contract Symbol | Expiration | Ticker | Type | Strike | Vol | OI | IV | Delta | Gamma | Rho | Theta | Vega | Last Traded | Bid | Ask | Last | % Change | Underlying | P/B |
|
||||
|---:|:-------------------|:-------------|:---------|:-------|---------:|------:|-------:|----------:|------------:|------------:|------------:|-------------:|------------:|:--------------|------:|------:|-------:|-----------:|-------------:|---------:|
|
||||
| 0 | SLV230120C00035000 | 2023-01-20 | SLV | C | 35 | 338 | 389212 | 0.250008 | 2.65844e-09 | 8.21107e-09 | 8.20159e-11 | -2.63722e-10 | 1.23914e-09 | 2022-11-18 | 0 | 0 | 0.02 | 0 | 19.25 | 0.901724 |
|
||||
| 1 | EEM221216C00045000 | 2022-12-16 | EEM | C | 45 | 14086 | 341301 | 0.125009 | 1.13015e-07 | 4.91845e-07 | 2.86473e-09 | -1.52641e-08 | 5.96183e-08 | 2022-11-18 | 0 | 0 | 0.02 | 0 | 38.03 | 0.723568 |
|
||||
| 2 | SLV230120C00040000 | 2023-01-20 | SLV | C | 40 | 200 | 316800 | 0.500005 | 0.000228694 | 0.000221098 | 6.8245e-06 | -2.83253e-05 | 6.67309e-05 | 2022-11-18 | 0 | 0 | 0.01 | 0 | 19.25 | 0.901724 |
|
||||
| 3 | NOK230120C00007000 | 2023-01-20 | NOK | C | 7 | 557 | 257115 | 0.250008 | 0.00010857 | 0.000884296 | 8.27629e-07 | -1.74568e-06 | 8.2688e-06 | 2022-11-18 | 0 | 0 | 0.01 | 0 | 4.79 | 1.36273 |
|
||||
| 4 | EEM221216C00040000 | 2022-12-16 | EEM | C | 40 | 13302 | 247105 | 0.0625094 | 0.000969793 | 0.00531776 | 2.46164e-05 | -4.14814e-05 | 0.000322318 | 2022-11-18 | 0 | 0 | 0.23 | 0 | 38.03 | 0.723568 |
|
||||
| | Contract Symbol | Expiration | Ticker | Type | Strike | Vol | OI | IV | Delta | Gamma | Rho | Theta | Vega | Last Traded | Bid | Ask | Last | % Change | Underlying | P/B |
|
||||
| --: | :----------------- | :--------- | :----- | :--- | -----: | ----: | -----: | --------: | ----------: | ----------: | ----------: | -----------: | ----------: | :---------- | --: | --: | ---: | -------: | ---------: | -------: |
|
||||
| 0 | SLV230120C00035000 | 2023-01-20 | SLV | C | 35 | 338 | 389212 | 0.250008 | 2.65844e-09 | 8.21107e-09 | 8.20159e-11 | -2.63722e-10 | 1.23914e-09 | 2022-11-18 | 0 | 0 | 0.02 | 0 | 19.25 | 0.901724 |
|
||||
| 1 | EEM221216C00045000 | 2022-12-16 | EEM | C | 45 | 14086 | 341301 | 0.125009 | 1.13015e-07 | 4.91845e-07 | 2.86473e-09 | -1.52641e-08 | 5.96183e-08 | 2022-11-18 | 0 | 0 | 0.02 | 0 | 38.03 | 0.723568 |
|
||||
| 2 | SLV230120C00040000 | 2023-01-20 | SLV | C | 40 | 200 | 316800 | 0.500005 | 0.000228694 | 0.000221098 | 6.8245e-06 | -2.83253e-05 | 6.67309e-05 | 2022-11-18 | 0 | 0 | 0.01 | 0 | 19.25 | 0.901724 |
|
||||
| 3 | NOK230120C00007000 | 2023-01-20 | NOK | C | 7 | 557 | 257115 | 0.250008 | 0.00010857 | 0.000884296 | 8.27629e-07 | -1.74568e-06 | 8.2688e-06 | 2022-11-18 | 0 | 0 | 0.01 | 0 | 4.79 | 1.36273 |
|
||||
| 4 | EEM221216C00040000 | 2022-12-16 | EEM | C | 40 | 13302 | 247105 | 0.0625094 | 0.000969793 | 0.00531776 | 2.46164e-05 | -4.14814e-05 | 0.000322318 | 2022-11-18 | 0 | 0 | 0.23 | 0 | 38.03 | 0.723568 |
|
||||
|
||||
### Portfolio Files
|
||||
|
||||
@@ -55,24 +55,26 @@ User files are located in, `~/OpenBBUserData/portfolio/holdings/`, and can be lo
|
||||
```python
|
||||
port = openbb.portfolio.load(transactions_file_path='/users/username/OpenBBUserData/portfolio/holdings/test_port.csv')
|
||||
```
|
||||
|
||||
```console
|
||||
Preprocessing transactions: 100%|██████████| 14/14 [00:01<00:00, 7.20it/s]
|
||||
Loading price data: 100%|██████████| 1/1 [00:00<00:00, 2.09it/s]
|
||||
Calculating returns: 100%|██████████| 1/1 [00:00<00:00, 30.04it/s]
|
||||
Loading benchmark: 100%|██████████| 4/4 [00:04<00:00, 1.15s/it]
|
||||
```
|
||||
|
||||
```python
|
||||
openbb.portfolio.show(port)
|
||||
```
|
||||
|
||||
| | Date | Type | Ticker | Side | Price | Quantity | Fees | Investment | Currency | Sector | Industry | Country | Region |
|
||||
|---:|:-----------|:-------|:---------|:-------|--------:|-----------:|-------:|-------------:|:-----------|:-------------------|:-----------------|:---------------|:--------------|
|
||||
| 5 | 2021-11-04 | STOCK | ABX.TO | Buy | 23.46 | 1000 | 200 | 23660 | CAD | Basic Materials | Gold | Canada | North America |
|
||||
| 4 | 2021-11-04 | STOCK | PHYS.TO | Buy | 17.57 | 1400 | 200 | 24798 | CAD | Financial Services | Asset Management | Canada | North America |
|
||||
| 1 | 2021-10-29 | STOCK | WPM.TO | Buy | 51.23 | 300 | 200 | 15569 | CAD | Basic Materials | Gold | Canada | North America |
|
||||
| 3 | 2021-10-29 | STOCK | K.TO | Buy | 7.93 | 1900 | 200 | 15267 | CAD | Basic Materials | Gold | Canada | North America |
|
||||
| 2 | 2021-10-29 | STOCK | NGT.TO | Buy | 71.05 | 200 | 200 | 14410 | CAD | Basic Materials | Gold | United States | North America |
|
||||
| 0 | 2021-10-27 | STOCK | PHYS.TO | Buy | 17.65 | 3000 | 200 | 53150 | CAD | Financial Services | Asset Management | Canada | North America |
|
||||
| | Date | Type | Ticker | Side | Price | Quantity | Fees | Investment | Currency | Sector | Industry | Country | Region |
|
||||
| --: | :--------- | :---- | :------ | :--- | ----: | -------: | ---: | ---------: | :------- | :----------------- | :--------------- | :------------ | :------------ |
|
||||
| 5 | 2021-11-04 | STOCK | ABX.TO | Buy | 23.46 | 1000 | 200 | 23660 | CAD | Basic Materials | Gold | Canada | North America |
|
||||
| 4 | 2021-11-04 | STOCK | PHYS.TO | Buy | 17.57 | 1400 | 200 | 24798 | CAD | Financial Services | Asset Management | Canada | North America |
|
||||
| 1 | 2021-10-29 | STOCK | WPM.TO | Buy | 51.23 | 300 | 200 | 15569 | CAD | Basic Materials | Gold | Canada | North America |
|
||||
| 3 | 2021-10-29 | STOCK | K.TO | Buy | 7.93 | 1900 | 200 | 15267 | CAD | Basic Materials | Gold | Canada | North America |
|
||||
| 2 | 2021-10-29 | STOCK | NGT.TO | Buy | 71.05 | 200 | 200 | 14410 | CAD | Basic Materials | Gold | United States | North America |
|
||||
| 0 | 2021-10-27 | STOCK | PHYS.TO | Buy | 17.65 | 3000 | 200 | 53150 | CAD | Financial Services | Asset Management | Canada | North America |
|
||||
|
||||
### Importing Previously Exported Files
|
||||
|
||||
@@ -570,7 +572,7 @@ Pasted below is the default Matplotlib, `mplrc`, style sheet. Use this as a refe
|
||||
#xtick.color: black # color of the ticks
|
||||
#xtick.labelcolor: inherit # color of the tick labels or inherit from xtick.color
|
||||
#xtick.labelsize: medium # font size of the tick labels
|
||||
#xtick.direction: out # direction: {in, out, inout}
|
||||
#xtick.direction: out # direction: {in, out, input}
|
||||
#xtick.minor.visible: False # visibility of minor ticks on x-axis
|
||||
#xtick.major.top: True # draw x axis top major ticks
|
||||
#xtick.major.bottom: True # draw x axis bottom major ticks
|
||||
@@ -591,7 +593,7 @@ Pasted below is the default Matplotlib, `mplrc`, style sheet. Use this as a refe
|
||||
#ytick.color: black # color of the ticks
|
||||
#ytick.labelcolor: inherit # color of the tick labels or inherit from ytick.color
|
||||
#ytick.labelsize: medium # font size of the tick labels
|
||||
#ytick.direction: out # direction: {in, out, inout}
|
||||
#ytick.direction: out # direction: {in, out, input}
|
||||
#ytick.minor.visible: False # visibility of minor ticks on y-axis
|
||||
#ytick.major.left: True # draw y axis left major ticks
|
||||
#ytick.major.right: True # draw y axis right major ticks
|
||||
|
||||
56
website/content/sdk/guides/basics/index.md
vendored
56
website/content/sdk/guides/basics/index.md
vendored
@@ -62,13 +62,13 @@ To get started using the OpenBB SDK you can try the below code for your first fu
|
||||
openbb.economy.events()
|
||||
```
|
||||
|
||||
| | Time (GMT) | Country | Event | actual | consensus | previous | Date |
|
||||
|---:|:-------------|:---------------|:------------------------------|:---------|:------------|:-----------|:-----------|
|
||||
| 0 | 01:30 | France | French Unemployment Rate | 7.3% | 7.3% | 7.4% | 2022-11-15 |
|
||||
| 1 | 02:00 | United Kingdom | Average Earnings ex Bonus | 5.7% | 5.5% | 5.5% | 2022-11-15 |
|
||||
| 2 | 02:00 | United Kingdom | Average Earnings Index +Bonus | 6.0% | 5.9% | 6.1% | 2022-11-15 |
|
||||
| 3 | 02:00 | United Kingdom | Claimant Count Change | 3.3K | 17.3K | 3.9K | 2022-11-15 |
|
||||
| 4 | 02:00 | United Kingdom | Employment Change 3M/3M | -52K | -25K | -109K | 2022-11-15 |
|
||||
| | Time (GMT) | Country | Event | actual | consensus | previous | Date |
|
||||
| --: | :--------- | :------------- | :---------------------------- | :----- | :-------- | :------- | :--------- |
|
||||
| 0 | 01:30 | France | French Unemployment Rate | 7.3% | 7.3% | 7.4% | 2022-11-15 |
|
||||
| 1 | 02:00 | United Kingdom | Average Earnings ex Bonus | 5.7% | 5.5% | 5.5% | 2022-11-15 |
|
||||
| 2 | 02:00 | United Kingdom | Average Earnings Index +Bonus | 6.0% | 5.9% | 6.1% | 2022-11-15 |
|
||||
| 3 | 02:00 | United Kingdom | Claimant Count Change | 3.3K | 17.3K | 3.9K | 2022-11-15 |
|
||||
| 4 | 02:00 | United Kingdom | Employment Change 3M/3M | -52K | -25K | -109K | 2022-11-15 |
|
||||
|
||||
:::note - The results from data functions are not stored to memory unless explicitly instructed to. Most functions returning data are presented as a Pandas DataFrame.
|
||||
:::
|
||||
@@ -89,15 +89,15 @@ events = economic_calendar.filter(like = '9:00', axis = 0)
|
||||
events
|
||||
```
|
||||
|
||||
| | Country | Event | actual | consensus | previous | Date |
|
||||
|:------|:--------------|:---------------------------------------|:---------|:------------|:-----------|:-----------|
|
||||
| 09:00 | United States | Fed Governor Cook Speaks | - | - | - | 2022-11-15 |
|
||||
| 09:00 | Germany | German Buba Balz Speaks | - | - | - | 2022-11-15 |
|
||||
| 09:00 | Germany | German Buba Vice President Buch Speaks | - | - | - | 2022-11-15 |
|
||||
| | Country | Event | actual | consensus | previous | Date |
|
||||
| :---- | :------------ | :------------------------------------- | :----- | :-------- | :------- | :--------- |
|
||||
| 09:00 | United States | Fed Governor Cook Speaks | - | - | - | 2022-11-15 |
|
||||
| 09:00 | Germany | German Buba Balz Speaks | - | - | - | 2022-11-15 |
|
||||
| 09:00 | Germany | German Buba Vice President Buch Speaks | - | - | - | 2022-11-15 |
|
||||
|
||||
### Passing Results to Another Function
|
||||
|
||||
Let's take a look at another example where the input to a function is a list. It may be desireable to derive that list from a different function. This can be useful for screening tickers, or analyzing particular industries or sectors. The Comparison Analysis sub-module, within Stocks, is one set of functions that can benefit from this kind of workflow. Instead of something like:
|
||||
Let's take a look at another example where the input to a function is a list. It may be desirable to derive that list from a different function. This can be useful for screening tickers, or analyzing particular industries or sectors. The Comparison Analysis sub-module, within Stocks, is one set of functions that can benefit from this kind of workflow. Instead of something like:
|
||||
|
||||
```python
|
||||
openbb.stocks.ca.screener(similar = ['AAPL', 'NFLX', 'META', 'AMZN', 'MSFT', 'GOOGL', 'DIS', 'TSLA'], data_type = 'valuation')
|
||||
@@ -114,14 +114,13 @@ dia_valuation = dia_valuation.sort_values(by = ['Price'], ascending = False).con
|
||||
dia_valuation.head(5)
|
||||
```
|
||||
|
||||
| | Ticker | Market Cap | P/E | Fwd P/E | PEG | P/S | P/B | P/C | P/FCF | EPS this Y | EPS next Y | EPS past 5Y | EPS next 5Y | Sales past 5Y | Price | Change | Volume |
|
||||
|---:|:---------|-------------:|------:|----------:|:------|------:|:--------|-------:|--------:|-------------:|-------------:|--------------:|--------------:|----------------:|--------:|---------:|---------:|
|
||||
| 25 | UNH | 5.0033e+11 | 25.17 | 20.61 | 1.77 | 1.59 | 6.43 | 12.88 | 19.61 | 0.128 | 0.1315 | 0.201 | 0.1422 | 0.092 | 503.01 | -0.0209 | 5007787 |
|
||||
| 10 | GS | 1.282e+11 | 10.18 | 10.17 | N/A | 2.08 | 1.24 | 0.45 | 2.98 | 1.403 | 0.0976 | 0.296 | -0.0912 | 0.113 | 382.88 | 0.0014 | 3184768 |
|
||||
| 11 | HD | 3.1097e+11 | 18.86 | 17.86 | 1.2 | 2 | 1334.43 | 247 | 89.72 | 0.301 | 0.0361 | 0.192 | 0.157 | 0.098 | 311.93 | 0.0163 | 9239159 |
|
||||
| 1 | AMGN | 1.5543e+11 | 22.86 | 15.4 | 3.38 | 5.9 | 41.77 | 13.54 | 32.04 | -0.165 | 0.0486 | 0.001 | 0.0677 | 0.025 | 283.6 | -0.006 | 2761083 |
|
||||
| 18 | MCD | 2.0272e+11 | 34.3 | 26.01 | 5.14 | 8.71 | N/A | 71.67 | 118.65 | 0.591 | 0.0522 | 0.13 | 0.0667 | -0.012 | 267.84 | -0.0163 | 5421817 |
|
||||
|
||||
| | Ticker | Market Cap | P/E | Fwd P/E | PEG | P/S | P/B | P/C | P/FCF | EPS this Y | EPS next Y | EPS past 5Y | EPS next 5Y | Sales past 5Y | Price | Change | Volume |
|
||||
| --: | :----- | ---------: | ----: | ------: | :--- | ---: | :------ | ----: | -----: | ---------: | ---------: | ----------: | ----------: | ------------: | -----: | ------: | ------: |
|
||||
| 25 | UNH | 5.0033e+11 | 25.17 | 20.61 | 1.77 | 1.59 | 6.43 | 12.88 | 19.61 | 0.128 | 0.1315 | 0.201 | 0.1422 | 0.092 | 503.01 | -0.0209 | 5007787 |
|
||||
| 10 | GS | 1.282e+11 | 10.18 | 10.17 | N/A | 2.08 | 1.24 | 0.45 | 2.98 | 1.403 | 0.0976 | 0.296 | -0.0912 | 0.113 | 382.88 | 0.0014 | 3184768 |
|
||||
| 11 | HD | 3.1097e+11 | 18.86 | 17.86 | 1.2 | 2 | 1334.43 | 247 | 89.72 | 0.301 | 0.0361 | 0.192 | 0.157 | 0.098 | 311.93 | 0.0163 | 9239159 |
|
||||
| 1 | AMGN | 1.5543e+11 | 22.86 | 15.4 | 3.38 | 5.9 | 41.77 | 13.54 | 32.04 | -0.165 | 0.0486 | 0.001 | 0.0677 | 0.025 | 283.6 | -0.006 | 2761083 |
|
||||
| 18 | MCD | 2.0272e+11 | 34.3 | 26.01 | 5.14 | 8.71 | N/A | 71.67 | 118.65 | 0.591 | 0.0522 | 0.13 | 0.0667 | -0.012 | 267.84 | -0.0163 | 5421817 |
|
||||
|
||||
### Displaying Charts
|
||||
|
||||
@@ -154,14 +153,13 @@ Where functions in the Terminal display either a chart or raw data, the command
|
||||
openbb.ta.donchian(openbb.stocks.load('SPY', interval = 15))
|
||||
```
|
||||
|
||||
| date | DCL_20_20 | DCM_20_20 | DCU_20_20 |
|
||||
|:--------------------|------------:|------------:|------------:|
|
||||
| 2022-11-15 14:45:00 | 394.49 | 398.33 | 402.17 |
|
||||
| 2022-11-15 15:00:00 | 394.49 | 398.195 | 401.9 |
|
||||
| 2022-11-15 15:15:00 | 394.49 | 398.195 | 401.9 |
|
||||
| 2022-11-15 15:30:00 | 394.49 | 398.105 | 401.72 |
|
||||
| 2022-11-15 15:45:00 | 394.49 | 398.027 | 401.565 |
|
||||
|
||||
| date | DCL_20_20 | DCM_20_20 | DCU_20_20 |
|
||||
| :------------------ | --------: | --------: | --------: |
|
||||
| 2022-11-15 14:45:00 | 394.49 | 398.33 | 402.17 |
|
||||
| 2022-11-15 15:00:00 | 394.49 | 398.195 | 401.9 |
|
||||
| 2022-11-15 15:15:00 | 394.49 | 398.195 | 401.9 |
|
||||
| 2022-11-15 15:30:00 | 394.49 | 398.105 | 401.72 |
|
||||
| 2022-11-15 15:45:00 | 394.49 | 398.027 | 401.565 |
|
||||
|
||||
```python
|
||||
openbb.ta.donchian_chart(
|
||||
|
||||
447
website/content/sdk/guides/guides/crypto.md
vendored
447
website/content/sdk/guides/guides/crypto.md
vendored
@@ -9,19 +9,19 @@ The Crypto module wraps the functions of the OpenBB Terminal menu. This allows w
|
||||
|
||||
The list below are all the SDK functions at the `openbb.crypto` level:
|
||||
|
||||
|Path |Type |Description |
|
||||
|:--------------------|:----------:|-----------------:|
|
||||
|openbb.crypto.candles |Function |OHLC+V chart |
|
||||
|openbb.crypto.dd |Sub-Module |Due Dilligence |
|
||||
|openbb.crypto.defi |Sub-Module |DeFi |
|
||||
|openbb.crypto.disc |Sub-Module |Discovery |
|
||||
|openbb.crypto.find |Function |Find Digital Assets |
|
||||
|openbb.crypto.load |Function |Load Historical Data |
|
||||
|openbb.crypto.nft |Sub-Module |NFTs |
|
||||
|openbb.crypto.onchain |Sub-Module |Onchain Metrics |
|
||||
|openbb.crypto.ov |Sub-Module |Market Overview |
|
||||
|openbb.crypto.price |Function |Live Prices from Pyth |
|
||||
|openbb.crypto.tools |Sub-Module |Calculators |
|
||||
| Path | Type | Description |
|
||||
| :-------------------- | :--------: | --------------------: |
|
||||
| openbb.crypto.candles | Function | OHLC+V chart |
|
||||
| openbb.crypto.dd | Sub-Module | Due Diligence |
|
||||
| openbb.crypto.defi | Sub-Module | DeFi |
|
||||
| openbb.crypto.disc | Sub-Module | Discovery |
|
||||
| openbb.crypto.find | Function | Find Digital Assets |
|
||||
| openbb.crypto.load | Function | Load Historical Data |
|
||||
| openbb.crypto.nft | Sub-Module | NFTs |
|
||||
| openbb.crypto.onchain | Sub-Module | Onchain Metrics |
|
||||
| openbb.crypto.ov | Sub-Module | Market Overview |
|
||||
| openbb.crypto.price | Function | Live Prices from Pyth |
|
||||
| openbb.crypto.tools | Sub-Module | Calculators |
|
||||
|
||||
Alternatively, the contents of a menu is printed by running, `help(openbb.crypto)`. The objective of this guide is to introduce the high-level functions and provide a sample of examples from the sub-modules. Refer to the guides for each sub-module to learn more about them specifically.
|
||||
|
||||
@@ -77,123 +77,124 @@ Help on Operation in module openbb_terminal.core.library.operation:
|
||||
<details>
|
||||
<summary><code>CCXT Exchange List</code> <code>(expand to see list of exchanges supported by CCXT)</code></summary>
|
||||
|
||||
| |Exchange |
|
||||
|-----|----------:|
|
||||
| |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 |
|
||||
| |bkex |
|
||||
| |bl3p |
|
||||
| |btcalpha |
|
||||
| |btcbox |
|
||||
| |btcex |
|
||||
| |btcmarkets |
|
||||
| |btctradeua |
|
||||
| |btcturk |
|
||||
| |buda |
|
||||
| |bw |
|
||||
| |bybit |
|
||||
| |bytetrade |
|
||||
| |cex |
|
||||
| |coinbaseprime |
|
||||
| |coinbasepro |
|
||||
| |coincheck |
|
||||
| |coinex |
|
||||
| |coinfalcon |
|
||||
| |coinmate |
|
||||
| |coinone |
|
||||
| |coinspot |
|
||||
| |crex24 |
|
||||
| |cryptocom |
|
||||
| |currencycom |
|
||||
| |delta |
|
||||
| |deribit |
|
||||
| |digifinex |
|
||||
| |eqonex |
|
||||
| |exmo |
|
||||
| |flowbtc |
|
||||
| |fmfwio |
|
||||
| |ftx |
|
||||
| |ftxus |
|
||||
| |gate |
|
||||
| |gateio |
|
||||
| |gemini |
|
||||
| |hitbtc |
|
||||
| |bitbtc3 |
|
||||
| |hollaex |
|
||||
| |huobi |
|
||||
| |huobijp |
|
||||
| |idex |
|
||||
| |independentreserve |
|
||||
| |indodax |
|
||||
| |itbit |
|
||||
| |kraken |
|
||||
| |kucoin |
|
||||
| |kucoinfutures |
|
||||
| |kuna |
|
||||
| |latoken |
|
||||
| |lbank |
|
||||
| |lbank2 |
|
||||
| |liquid |
|
||||
| |luno |
|
||||
| |lykke |
|
||||
| |mercado |
|
||||
| |mexc |
|
||||
| |mexc3 |
|
||||
| |ndax |
|
||||
| |novadax |
|
||||
| |oceanex |
|
||||
| |okcoin |
|
||||
| |okex |
|
||||
| |okex5 |
|
||||
| |okx |
|
||||
| |paymium |
|
||||
| |phemex |
|
||||
| |poloniex |
|
||||
| |probit |
|
||||
| |qtrade |
|
||||
| |ripio |
|
||||
| |stex |
|
||||
| |therock |
|
||||
| |tidebit |
|
||||
| |tidex |
|
||||
| |timex |
|
||||
| |tokocrypto |
|
||||
| |upbit |
|
||||
| |wavesexchange |
|
||||
| |whitebit |
|
||||
| |woo |
|
||||
| |yobit |
|
||||
| |zaif |
|
||||
| |zb |
|
||||
| |zipmex |
|
||||
| |zonda |
|
||||
| | Exchange |
|
||||
| --- | -----------------: |
|
||||
| | 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 |
|
||||
| | bkex |
|
||||
| | bl3p |
|
||||
| | btcalpha |
|
||||
| | btcbox |
|
||||
| | btcex |
|
||||
| | btcmarkets |
|
||||
| | btctradeua |
|
||||
| | btcturk |
|
||||
| | buda |
|
||||
| | bw |
|
||||
| | bybit |
|
||||
| | bytetrade |
|
||||
| | cex |
|
||||
| | coinbaseprime |
|
||||
| | coinbasepro |
|
||||
| | coincheck |
|
||||
| | coinex |
|
||||
| | coinfalcon |
|
||||
| | coinmate |
|
||||
| | coinone |
|
||||
| | coinspot |
|
||||
| | crex24 |
|
||||
| | cryptocom |
|
||||
| | currencycom |
|
||||
| | delta |
|
||||
| | deribit |
|
||||
| | digifinex |
|
||||
| | eqonex |
|
||||
| | exmo |
|
||||
| | flowbtc |
|
||||
| | fmfwio |
|
||||
| | ftx |
|
||||
| | ftxus |
|
||||
| | gate |
|
||||
| | gateio |
|
||||
| | gemini |
|
||||
| | hitbtc |
|
||||
| | bitbtc3 |
|
||||
| | hollaex |
|
||||
| | huobi |
|
||||
| | huobijp |
|
||||
| | idex |
|
||||
| | independentreserve |
|
||||
| | indodax |
|
||||
| | itbit |
|
||||
| | kraken |
|
||||
| | kucoin |
|
||||
| | kucoinfutures |
|
||||
| | kuna |
|
||||
| | latoken |
|
||||
| | lbank |
|
||||
| | lbank2 |
|
||||
| | liquid |
|
||||
| | luno |
|
||||
| | lykke |
|
||||
| | mercado |
|
||||
| | mexc |
|
||||
| | mexc3 |
|
||||
| | ndax |
|
||||
| | novadax |
|
||||
| | oceanex |
|
||||
| | okcoin |
|
||||
| | okex |
|
||||
| | okex5 |
|
||||
| | okx |
|
||||
| | paymium |
|
||||
| | phemex |
|
||||
| | poloniex |
|
||||
| | probit |
|
||||
| | qtrade |
|
||||
| | ripio |
|
||||
| | stex |
|
||||
| | therock |
|
||||
| | tidebit |
|
||||
| | tidex |
|
||||
| | timex |
|
||||
| | tokocrypto |
|
||||
| | upbit |
|
||||
| | wavesexchange |
|
||||
| | whitebit |
|
||||
| | woo |
|
||||
| | yobit |
|
||||
| | zaif |
|
||||
| | zb |
|
||||
| | zipmex |
|
||||
| | zonda |
|
||||
|
||||
</details>
|
||||
|
||||
```python
|
||||
@@ -202,13 +203,13 @@ eth_df = openbb.crypto.load('ETH', source = 'CCXT', exchange = 'binance')
|
||||
eth_df.tail(5)
|
||||
```
|
||||
|
||||
| date | Open | High | Low | Close | Volume |
|
||||
|:--------------------|--------:|--------:|--------:|--------:|---------:|
|
||||
| 2022-11-14 00:00:00 | 1221.5 | 1291.2 | 1171.13 | 1243.28 | 934742 |
|
||||
| 2022-11-15 00:00:00 | 1243.29 | 1291 | 1234.01 | 1253.23 | 632826 |
|
||||
| 2022-11-16 00:00:00 | 1253.22 | 1268.67 | 1187.06 | 1216.17 | 673340 |
|
||||
| 2022-11-17 00:00:00 | 1216.16 | 1228.22 | 1181.05 | 1200.43 | 530537 |
|
||||
| 2022-11-18 00:00:00 | 1200.42 | 1234 | 1199.18 | 1206.11 | 306400 |
|
||||
| date | Open | High | Low | Close | Volume |
|
||||
| :------------------ | ------: | ------: | ------: | ------: | -----: |
|
||||
| 2022-11-14 00:00:00 | 1221.5 | 1291.2 | 1171.13 | 1243.28 | 934742 |
|
||||
| 2022-11-15 00:00:00 | 1243.29 | 1291 | 1234.01 | 1253.23 | 632826 |
|
||||
| 2022-11-16 00:00:00 | 1253.22 | 1268.67 | 1187.06 | 1216.17 | 673340 |
|
||||
| 2022-11-17 00:00:00 | 1216.16 | 1228.22 | 1181.05 | 1200.43 | 530537 |
|
||||
| 2022-11-18 00:00:00 | 1200.42 | 1234 | 1199.18 | 1206.11 | 306400 |
|
||||
|
||||
Adding the `interval` argument allows for intraday data or weekly/monthly periods to be loaded.
|
||||
|
||||
@@ -218,11 +219,11 @@ eth_df = openbb.crypto.load('ETH', source = 'CCXT', exchange = 'binance', interv
|
||||
eth_df.tail(3)
|
||||
```
|
||||
|
||||
| date | Open | High | Low | Close | Volume |
|
||||
|:--------------------|--------:|--------:|--------:|--------:|---------:|
|
||||
| 2022-11-18 17:00:00 | 1207.44 | 1208.35 | 1200.36 | 1205.35 | 11359.4 |
|
||||
| 2022-11-18 17:30:00 | 1205.36 | 1207.12 | 1202.5 | 1204.17 | 5878.59 |
|
||||
| 2022-11-18 18:00:00 | 1204.17 | 1207.28 | 1203.26 | 1206.37 | 1540.67 |
|
||||
| date | Open | High | Low | Close | Volume |
|
||||
| :------------------ | ------: | ------: | ------: | ------: | ------: |
|
||||
| 2022-11-18 17:00:00 | 1207.44 | 1208.35 | 1200.36 | 1205.35 | 11359.4 |
|
||||
| 2022-11-18 17:30:00 | 1205.36 | 1207.12 | 1202.5 | 1204.17 | 5878.59 |
|
||||
| 2022-11-18 18:00:00 | 1204.17 | 1207.28 | 1203.26 | 1206.37 | 1540.67 |
|
||||
|
||||
Loading monthly OHLC+V data looks like this:
|
||||
|
||||
@@ -233,10 +234,10 @@ eth_df.tail(3)
|
||||
```
|
||||
|
||||
| date | Open | High | Low | Close | Volume |
|
||||
|:--------------------|--------:|--------:|--------:|--------:|------------:|
|
||||
| 2022-09-01 00:00:00 | 1554.11 | 1789 | 1220 | 1328.72 | 2.25453e+07 |
|
||||
| 2022-10-01 00:00:00 | 1328.71 | 1663.06 | 1190 | 1572.69 | 1.67681e+07 |
|
||||
| 2022-11-01 00:00:00 | 1572.69 | 1680 | 1073.53 | 1204.78 | 1.6707e+07 |
|
||||
| :------------------ | ------: | ------: | ------: | ------: | ----------: |
|
||||
| 2022-09-01 00:00:00 | 1554.11 | 1789 | 1220 | 1328.72 | 2.25453e+07 |
|
||||
| 2022-10-01 00:00:00 | 1328.71 | 1663.06 | 1190 | 1572.69 | 1.67681e+07 |
|
||||
| 2022-11-01 00:00:00 | 1572.69 | 1680 | 1073.53 | 1204.78 | 1.6707e+07 |
|
||||
|
||||
### Candles
|
||||
|
||||
@@ -270,13 +271,13 @@ results = openbb.crypto.search(
|
||||
results.head(5)
|
||||
```
|
||||
|
||||
| | name | rank | id | symbol | type |
|
||||
|---:|:--------------|-------:|:-------------------|:---------|:-------|
|
||||
| 0 | Gnosis | 124 | gno-gnosis | GNO | token |
|
||||
| 1 | Gene | 4696 | gene-gene | GENE | token |
|
||||
| 2 | Nemesis | 4246 | nms-nemesis | NMS | token |
|
||||
| 3 | Genesis Token | 7763 | gent-genesis-token | GENT | token |
|
||||
| 4 | Alpha Genesis | 4732 | agen-alpha-genesis | AGEN | token |
|
||||
| | name | rank | id | symbol | type |
|
||||
| --: | :------------ | ---: | :----------------- | :----- | :---- |
|
||||
| 0 | Gnosis | 124 | gno-gnosis | GNO | token |
|
||||
| 1 | Gene | 4696 | gene-gene | GENE | token |
|
||||
| 2 | Nemesis | 4246 | nms-nemesis | NMS | token |
|
||||
| 3 | Genesis Token | 7763 | gent-genesis-token | GENT | token |
|
||||
| 4 | Alpha Genesis | 4732 | agen-alpha-genesis | AGEN | token |
|
||||
|
||||
### Active Addresses
|
||||
|
||||
@@ -291,13 +292,13 @@ active_eth.set_index(keys = ['Date'], inplace = True)
|
||||
active_eth.tail(5)
|
||||
```
|
||||
|
||||
| Date | Active Addresses |
|
||||
|:--------------------|-------------------:|
|
||||
| 2022-11-13 00:00:00 | 426441 |
|
||||
| 2022-11-14 00:00:00 | 474868 |
|
||||
| 2022-11-15 00:00:00 | 469880 |
|
||||
| 2022-11-16 00:00:00 | 448492 |
|
||||
| 2022-11-17 00:00:00 | 463467 |
|
||||
| Date | Active Addresses |
|
||||
| :------------------ | ---------------: |
|
||||
| 2022-11-13 00:00:00 | 426441 |
|
||||
| 2022-11-14 00:00:00 | 474868 |
|
||||
| 2022-11-15 00:00:00 | 469880 |
|
||||
| 2022-11-16 00:00:00 | 448492 |
|
||||
| 2022-11-17 00:00:00 | 463467 |
|
||||
|
||||
### Trades
|
||||
|
||||
@@ -309,13 +310,13 @@ trades_ethusdt = openbb.crypto.dd.trades(exchange_id = 'binance', symbol = 'ETH'
|
||||
trades_ethusdt.tail(5)
|
||||
```
|
||||
|
||||
| | Date | Price | Amount | Cost | Side |
|
||||
|----:|:---------------------------------|--------:|---------:|--------:|:-------|
|
||||
| 495 | 2022-11-18 19:16:15.959000+00:00 | 1204.02 | 2.7033 | 3254.83 | buy |
|
||||
| 496 | 2022-11-18 19:16:15.959000+00:00 | 1204.03 | 1.1769 | 1417.02 | buy |
|
||||
| 497 | 2022-11-18 19:16:15.981000+00:00 | 1204.03 | 5.0493 | 6079.51 | buy |
|
||||
| 498 | 2022-11-18 19:16:15.981000+00:00 | 1204.07 | 2.1126 | 2543.72 | buy |
|
||||
| 499 | 2022-11-18 19:16:15.981000+00:00 | 1204.08 | 5.2811 | 6358.87 | buy |
|
||||
| | Date | Price | Amount | Cost | Side |
|
||||
| --: | :------------------------------- | ------: | -----: | ------: | :--- |
|
||||
| 495 | 2022-11-18 19:16:15.959000+00:00 | 1204.02 | 2.7033 | 3254.83 | buy |
|
||||
| 496 | 2022-11-18 19:16:15.959000+00:00 | 1204.03 | 1.1769 | 1417.02 | buy |
|
||||
| 497 | 2022-11-18 19:16:15.981000+00:00 | 1204.03 | 5.0493 | 6079.51 | buy |
|
||||
| 498 | 2022-11-18 19:16:15.981000+00:00 | 1204.07 | 2.1126 | 2543.72 | buy |
|
||||
| 499 | 2022-11-18 19:16:15.981000+00:00 | 1204.08 | 5.2811 | 6358.87 | buy |
|
||||
|
||||
Use the `exchange_id` argument to return data from other venues, such as CoinBase.
|
||||
|
||||
@@ -325,13 +326,13 @@ trades_ethusdt = openbb.crypto.dd.trades(exchange_id = 'coinbaseprime', symbol =
|
||||
trades_ethusdt.tail(5)
|
||||
```
|
||||
|
||||
| | Date | Price | Amount | Cost | Side |
|
||||
|----:|:---------------------------------|--------:|---------:|---------------:|:-------|
|
||||
| 995 | 2022-11-18 19:20:15.176000+00:00 | 1204.65 | 3.89878 | 4696.67 | sell |
|
||||
| 996 | 2022-11-18 19:20:29.524000+00:00 | 1204.78 | 0.41545 | 500.526 | buy |
|
||||
| 997 | 2022-11-18 19:20:29.931000+00:00 | 1204.78 | 6.2e-07 | 0.000746964 | buy |
|
||||
| 998 | 2022-11-18 19:20:32.263000+00:00 | 1205.03 | 0.41536 | 500.521 | buy |
|
||||
| 999 | 2022-11-18 19:20:32.274000+00:00 | 1205.03 | 3.05e-06 | 0.00367534 | buy |
|
||||
| | Date | Price | Amount | Cost | Side |
|
||||
| --: | :------------------------------- | ------: | -------: | ----------: | :--- |
|
||||
| 995 | 2022-11-18 19:20:15.176000+00:00 | 1204.65 | 3.89878 | 4696.67 | sell |
|
||||
| 996 | 2022-11-18 19:20:29.524000+00:00 | 1204.78 | 0.41545 | 500.526 | buy |
|
||||
| 997 | 2022-11-18 19:20:29.931000+00:00 | 1204.78 | 6.2e-07 | 0.000746964 | buy |
|
||||
| 998 | 2022-11-18 19:20:32.263000+00:00 | 1205.03 | 0.41536 | 500.521 | buy |
|
||||
| 999 | 2022-11-18 19:20:32.274000+00:00 | 1205.03 | 3.05e-06 | 0.00367534 | buy |
|
||||
|
||||
### Coin_List
|
||||
|
||||
@@ -343,18 +344,18 @@ coins = openbb.crypto.ov.coin_list()
|
||||
coins.head(10)
|
||||
```
|
||||
|
||||
| | rank | id | name | symbol | type |
|
||||
|---:|-------:|:-----------------|:-------------|:---------|:-------|
|
||||
| 0 | 1 | btc-bitcoin | Bitcoin | BTC | coin |
|
||||
| 1 | 2 | eth-ethereum | Ethereum | ETH | coin |
|
||||
| 2 | 3 | usdt-tether | Tether | USDT | token |
|
||||
| 3 | 4 | usdc-usd-coin | USD Coin | USDC | token |
|
||||
| 4 | 5 | bnb-binance-coin | Binance Coin | BNB | coin |
|
||||
| 5 | 6 | busd-binance-usd | Binance USD | BUSD | token |
|
||||
| 6 | 7 | xrp-xrp | XRP | XRP | coin |
|
||||
| 7 | 8 | doge-dogecoin | Dogecoin | DOGE | coin |
|
||||
| 8 | 9 | ada-cardano | Cardano | ADA | coin |
|
||||
| 9 | 10 | hex-hex | HEX | HEX | token |
|
||||
| | rank | id | name | symbol | type |
|
||||
| --: | ---: | :--------------- | :----------- | :----- | :---- |
|
||||
| 0 | 1 | btc-bitcoin | Bitcoin | BTC | coin |
|
||||
| 1 | 2 | eth-ethereum | Ethereum | ETH | coin |
|
||||
| 2 | 3 | usdt-tether | Tether | USDT | token |
|
||||
| 3 | 4 | usdc-usd-coin | USD Coin | USDC | token |
|
||||
| 4 | 5 | bnb-binance-coin | Binance Coin | BNB | coin |
|
||||
| 5 | 6 | busd-binance-usd | Binance USD | BUSD | token |
|
||||
| 6 | 7 | xrp-xrp | XRP | XRP | coin |
|
||||
| 7 | 8 | doge-dogecoin | Dogecoin | DOGE | coin |
|
||||
| 8 | 9 | ada-cardano | Cardano | ADA | coin |
|
||||
| 9 | 10 | hex-hex | HEX | HEX | token |
|
||||
|
||||
### BAAS (Historical Bid-Ask Average Spread)
|
||||
|
||||
@@ -364,14 +365,14 @@ Measure liquidity over time for an asset with: `openbb.crypto.onchain.baas`
|
||||
openbb.crypto.onchain.baas(symbol = 'ETH', to_symbol = 'USDT')
|
||||
```
|
||||
|
||||
| | Date | Base currency | Quote currency | Daily spread | Average bid price | Average ask price |
|
||||
|---:|:-----------|:----------------|:-----------------|---------------:|--------------------:|--------------------:|
|
||||
| 0 | 2022-11-08 | ETH | USDT | 26.7961 | 1480.72 | 1453.93 |
|
||||
| 1 | 2022-11-09 | ETH | USDT | 87.9466 | 1255.58 | 1167.63 |
|
||||
| 2 | 2022-11-10 | ETH | USDT | 24.8262 | 1248.8 | 1273.62 |
|
||||
| 3 | 2022-11-11 | ETH | USDT | 365.65 | 877.792 | 1243.44 |
|
||||
| 4 | 2022-11-13 | ETH | USDT | 23.2032 | 1240.23 | 1217.02 |
|
||||
| 5 | 2022-11-14 | ETH | USDT | 22.5726 | 1221.92 | 1199.35 |
|
||||
| | Date | Base currency | Quote currency | Daily spread | Average bid price | Average ask price |
|
||||
| --: | :--------- | :------------ | :------------- | -----------: | ----------------: | ----------------: |
|
||||
| 0 | 2022-11-08 | ETH | USDT | 26.7961 | 1480.72 | 1453.93 |
|
||||
| 1 | 2022-11-09 | ETH | USDT | 87.9466 | 1255.58 | 1167.63 |
|
||||
| 2 | 2022-11-10 | ETH | USDT | 24.8262 | 1248.8 | 1273.62 |
|
||||
| 3 | 2022-11-11 | ETH | USDT | 365.65 | 877.792 | 1243.44 |
|
||||
| 4 | 2022-11-13 | ETH | USDT | 23.2032 | 1240.23 | 1217.02 |
|
||||
| 5 | 2022-11-14 | ETH | USDT | 22.5726 | 1221.92 | 1199.35 |
|
||||
|
||||
### Trending
|
||||
|
||||
@@ -381,15 +382,15 @@ Discover trending coins on CoinGecko with: `openbb.crypto.disc.trending()`
|
||||
openbb.crypto.disc.trending()
|
||||
```
|
||||
|
||||
| | Symbol | Name | market_cap Cap Rank |
|
||||
|---:|:--------------|:--------------------|----------------------:|
|
||||
| 0 | solana | Solana | 16 |
|
||||
| 1 | chiliz | Chiliz | 36 |
|
||||
| 2 | aptos | Aptos | 64 |
|
||||
| 3 | elrond-erd-2 | MultiversX (Elrond) | 43 |
|
||||
| 4 | algorand | Algorand | 29 |
|
||||
| 5 | matic-network | Polygon | 10 |
|
||||
| 6 | media-network | Media Network | 890 |
|
||||
| | Symbol | Name | market_cap Cap Rank |
|
||||
| --: | :------------ | :------------------ | ------------------: |
|
||||
| 0 | solana | Solana | 16 |
|
||||
| 1 | chiliz | Chiliz | 36 |
|
||||
| 2 | aptos | Aptos | 64 |
|
||||
| 3 | elrond-erd-2 | MultiversX (Elrond) | 43 |
|
||||
| 4 | algorand | Algorand | 29 |
|
||||
| 5 | matic-network | Polygon | 10 |
|
||||
| 6 | media-network | Media Network | 890 |
|
||||
|
||||
### News
|
||||
|
||||
@@ -399,23 +400,23 @@ Get crypto-focussed news with: `openbb.crypto.ov.news`
|
||||
openbb.crypto.ov.news(post_kind = 'news',region = 'en', filter_= 'important', ascend = False)
|
||||
```
|
||||
|
||||
| | published_at | domain | title | negative_votes | positive_votes | link |
|
||||
|---:|:---------------|:-------------------|:-------------------------------------------------------------------|-----------------:|-----------------:|:--------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| 0 | 2022-11-18 | decrypt.co | Edward Snowden: Sanctioning of Ethereum Mixer Tornado Cash Was | 0 | 2 | https://cryptopanic.com/news/16935211/Edward-Snowden-Sanctioning-of-Ethereum-Mixer-Tornado-Cash-Was-Deeply-Illiberal-and-Profoundly-Authoritarian |
|
||||
| | | | 'Deeply Illiberal and Profoundly Authoritarian' | | | |
|
||||
| 10 | 2022-11-18 | theblockcrypto.com | Cardano developer Emurgo to issue fiat-pegged stablecoin called | 3 | 21 | https://cryptopanic.com/news/16933998/Cardano-developer-Emurgo-to-issue-fiat-pegged-stablecoin-called-USDA |
|
||||
| | | | USDA | | | |
|
||||
| 1 | 2022-11-18 | beincrypto.com | SHIB Army Remains Positive as Memecoin Social Sentiment Index | 0 | 3 | https://cryptopanic.com/news/16935115/SHIB-Army-Remains-Positive-as-Memecoin-Social-Sentiment-Index-Remains-Positive |
|
||||
| | | | Remains Positive | | | |
|
||||
| 17 | 2022-11-18 | u.today | Is El Salvador's President's Decision to Buy One Bitcoin per Day a | 2 | 48 | https://cryptopanic.com/news/16925762/Is-El-Salvadors-Presidents-Decision-to-Buy-One-Bitcoin-per-Day-a-Good-Idea |
|
||||
| | | | Good Idea? | | | |
|
||||
| 15 | 2022-11-18 | dailyhodl.com | ‘Secret’ Altcoin Goes Parabolic After Rumors of European Ban on | 0 | 3 | https://cryptopanic.com/news/16925942/Secret-Altcoin-Goes-Parabolic-After-Rumors-of-European-Ban-on-Privacy-Coins-Swirl |
|
||||
| | | | Privacy Coins Swirl | | | |
|
||||
| 74 | 2022-11-15 | cryptopotato.com | OKX Announces $100 Million Fund to Support Distressed Projects | 0 | 4 | https://cryptopanic.com/news/16903760/OKX-Announces-100-Million-Fund-to-Support-Distressed-Projects-Following-FTX-Crash-Report |
|
||||
| | | | Following FTX Crash (Report) | | | |
|
||||
| 73 | 2022-11-15 | cointelegraph.com | Thousands petition for congressional investigation of alleged | 1 | 36 | https://cryptopanic.com/news/16904296/Thousands-petition-for-congressional-investigation-of-alleged-GenslerSBF-links |
|
||||
| | | | Gensler–SBF links | | | |
|
||||
| 72 | 2022-11-15 | cryptonews.com | XRP Price Forecast as XRP Pumps 9%, Becomes Top Performer | 0 | 13 | https://cryptopanic.com/news/16904392/XRP-Price-Forecast-as-XRP-Pumps-9-Becomes-Top-Performer |
|
||||
| 71 | 2022-11-15 | theblockcrypto.com | Kraken’s Ogilvie says staking adoption set to skyrocket | 0 | 4 | https://cryptopanic.com/news/16904805/Krakens-Ogilvie-says-staking-adoption-set-to-skyrocket |
|
||||
| 79 | 2022-11-15 | zycrypto.com | SEC vs. Ripple Case Sees New Twists And Turns As Whale Holdings In | 2 | 15 | https://cryptopanic.com/news/16903258/SEC-vs-Ripple-Case-Sees-New-Twists-And-Turns-As-Whale-Holdings-In-XRP-Skyrocket |
|
||||
| | | | XRP Skyrocket | | | |
|
||||
| | published_at | domain | title | negative_votes | positive_votes | link |
|
||||
| --: | :----------- | :----------------- | :----------------------------------------------------------------- | -------------: | -------------: | :------------------------------------------------------------------------------------------------------------------------------------------------ |
|
||||
| 0 | 2022-11-18 | decrypt.co | Edward Snowden: Sanctioning of Ethereum Mixer Tornado Cash Was | 0 | 2 | https://cryptopanic.com/news/16935211/Edward-Snowden-Sanctioning-of-Ethereum-Mixer-Tornado-Cash-Was-Deeply-Illiberal-and-Profoundly-Authoritarian |
|
||||
| | | | 'Deeply Illiberal and Profoundly Authoritarian' | | | |
|
||||
| 10 | 2022-11-18 | theblockcrypto.com | Cardano developer Emurgo to issue fiat-pegged stablecoin called | 3 | 21 | https://cryptopanic.com/news/16933998/Cardano-developer-Emurgo-to-issue-fiat-pegged-stablecoin-called-USDA |
|
||||
| | | | USDA | | | |
|
||||
| 1 | 2022-11-18 | beincrypto.com | SHIB Army Remains Positive as Memecoin Social Sentiment Index | 0 | 3 | https://cryptopanic.com/news/16935115/SHIB-Army-Remains-Positive-as-Memecoin-Social-Sentiment-Index-Remains-Positive |
|
||||
| | | | Remains Positive | | | |
|
||||
| 17 | 2022-11-18 | u.today | Is El Salvador's President's Decision to Buy One Bitcoin per Day a | 2 | 48 | https://cryptopanic.com/news/16925762/Is-El-Salvadors-Presidents-Decision-to-Buy-One-Bitcoin-per-Day-a-Good-Idea |
|
||||
| | | | Good Idea? | | | |
|
||||
| 15 | 2022-11-18 | dailyhodl.com | ‘Secret’ Altcoin Goes Parabolic After Rumors of European Ban on | 0 | 3 | https://cryptopanic.com/news/16925942/Secret-Altcoin-Goes-Parabolic-After-Rumors-of-European-Ban-on-Privacy-Coins-Swirl |
|
||||
| | | | Privacy Coins Swirl | | | |
|
||||
| 74 | 2022-11-15 | cryptopotato.com | OKX Announces $100 Million Fund to Support Distressed Projects | 0 | 4 | https://cryptopanic.com/news/16903760/OKX-Announces-100-Million-Fund-to-Support-Distressed-Projects-Following-FTX-Crash-Report |
|
||||
| | | | Following FTX Crash (Report) | | | |
|
||||
| 73 | 2022-11-15 | cointelegraph.com | Thousands petition for congressional investigation of alleged | 1 | 36 | https://cryptopanic.com/news/16904296/Thousands-petition-for-congressional-investigation-of-alleged-GenslerSBF-links |
|
||||
| | | | Gensler–SBF links | | | |
|
||||
| 72 | 2022-11-15 | cryptonews.com | XRP Price Forecast as XRP Pumps 9%, Becomes Top Performer | 0 | 13 | https://cryptopanic.com/news/16904392/XRP-Price-Forecast-as-XRP-Pumps-9-Becomes-Top-Performer |
|
||||
| 71 | 2022-11-15 | theblockcrypto.com | Kraken’s Ogilvie says staking adoption set to skyrocket | 0 | 4 | https://cryptopanic.com/news/16904805/Krakens-Ogilvie-says-staking-adoption-set-to-skyrocket |
|
||||
| 79 | 2022-11-15 | zycrypto.com | SEC vs. Ripple Case Sees New Twists And Turns As Whale Holdings In | 2 | 15 | https://cryptopanic.com/news/16903258/SEC-vs-Ripple-Case-Sees-New-Twists-And-Turns-As-Whale-Holdings-In-XRP-Skyrocket |
|
||||
| | | | XRP Skyrocket | | | |
|
||||
|
||||
292
website/content/sdk/guides/guides/econometrics.md
vendored
292
website/content/sdk/guides/guides/econometrics.md
vendored
@@ -1,8 +1,17 @@
|
||||
---
|
||||
title: Econometrics
|
||||
keywords: ['econometrics', 'statistics', 'regression', 'panel data', 'time series', 'research', 'thesis', 'university']
|
||||
keywords:
|
||||
[
|
||||
"econometrics",
|
||||
"statistics",
|
||||
"regression",
|
||||
"panel data",
|
||||
"time series",
|
||||
"research",
|
||||
"thesis",
|
||||
"university",
|
||||
]
|
||||
excerpt: "The Introduction to Econometrics explains how to use the menu"
|
||||
|
||||
---
|
||||
|
||||
The capabilities of the [Econometrics menu](/terminal/guides/econometrics) from the OpenBB Terminal are wrapped into a powerful SDK, enabling users to work with the data in a flexible environment that can be fully customized to meet the needs of any user. The Econometrics menu's purpose is to provide the user the ability to perform statistical research on custom datasets. The menu allows the user to load in his/her own dataset(s), modify the data by adding columns or setting indices, apply statistical tests (e.g. <a href="https://en.wikipedia.org/wiki/Breusch%E2%80%93Godfrey_test" target="_blank">Breusch-Godfrey autocorrelation tests</a>) as well as OLS regressions and Panel regressions (e.g. <a href="https://en.wikipedia.org/wiki/Random_effects_model" target="_blank">Random Effects</a> and <a href="https://en.wikipedia.org/wiki/Fixed_effects_model" target="_blank">Fixed Effects</a>)
|
||||
@@ -17,35 +26,35 @@ from openbb_terminal.sdk import openbb
|
||||
|
||||
Below is a brief description of each function within the Portfolio module:
|
||||
|
||||
| Path | Type | Description |
|
||||
| :----------------------------------------- | :--------: | ---------------------------------------------------------------------: |
|
||||
| openbb.econometrics.granger | Function | Check time-series for Granger causality (X causes Y) |
|
||||
| openbb.econometrics.granger_chart | Function | Obtain a nice table of Granger causality |
|
||||
| openbb.econometrics.fe | Function | Perform a Fixed Effects (fe) regression on Panel data |
|
||||
| openbb.econometrics.options | Function | Obtain all options that can be used for regression techniques |
|
||||
| openbb.econometrics.options_chart | Function | Get a nice table of the options |
|
||||
| openbb.econometrics.dwat | Function | Check for auto-correlation with Durbin Watson |
|
||||
| openbb.econometrics.dwat_chart | Function | Plot the residuals of the OLS model |
|
||||
| openbb.econometrics.coint | Function | Check whether time-series are cointegrated |
|
||||
| openbb.econometrics.coint_chart | Function | Show the error-correction terms plot |
|
||||
| openbb.econometrics.pols | Function | Perform a Pooled OLS (pols) regression on Panel data |
|
||||
| openbb.econometrics.root | Function | Check for unit root in the timeseries |
|
||||
| openbb.econometrics.root_chart | Function | Show a nice table of the unit root test results |
|
||||
| openbb.econometrics.bgod | Function | Check for autocorrelation with Breusch Godfrey |
|
||||
| openbb.econometrics.bgod_chart | Function | Show a nice table of the autocorrelation test results |
|
||||
| openbb.econometrics.re | Function | Perform a Random Effects (re) regression on Panel data |
|
||||
| openbb.econometrics.bols | Function | Perform a Between OLS (bols) regression on Panel data |
|
||||
| openbb.econometrics.panel | Function | Obtain the regression results wrapper |
|
||||
| openbb.econometrics.get_regression_data | Function | Obtain an OLS model wrapper |
|
||||
| openbb.econometrics.norm | Function | Check wether the time-series is normally distributed |
|
||||
| openbb.econometrics.norm_chart | Function | Show a histogram of the time-series |
|
||||
| openbb.econometrics.clean | Function | Apply either a fill or drop method to clean the data |
|
||||
| openbb.econometrics.bpag | Function | Test for heteroskedasticity with a Breusch-Pagan test |
|
||||
| openbb.econometrics.bpag_chart | Function | Get a nice table with Breusch-Pagan test results |
|
||||
| openbb.econometrics.fdols | Function | Perform a First Difference OLS (fdols) regression on Panel data |
|
||||
| openbb.econometrics.load | Function | Load in a dataset to be used within other functionalities |
|
||||
| openbb.econometrics.ols | Function | Perform an Ordinary Least Squares (ols) regression on time-series data |
|
||||
| openbb.econometrics.comparison | Function | Compare different regression models in one table |
|
||||
| Path | Type | Description |
|
||||
| :-------------------------------------- | :------: | ---------------------------------------------------------------------: |
|
||||
| openbb.econometrics.granger | Function | Check time-series for Granger causality (X causes Y) |
|
||||
| openbb.econometrics.granger_chart | Function | Obtain a nice table of Granger causality |
|
||||
| openbb.econometrics.fe | Function | Perform a Fixed Effects (fe) regression on Panel data |
|
||||
| openbb.econometrics.options | Function | Obtain all options that can be used for regression techniques |
|
||||
| openbb.econometrics.options_chart | Function | Get a nice table of the options |
|
||||
| openbb.econometrics.dwat | Function | Check for auto-correlation with Durbin Watson |
|
||||
| openbb.econometrics.dwat_chart | Function | Plot the residuals of the OLS model |
|
||||
| openbb.econometrics.coint | Function | Check whether time-series are cointegrated |
|
||||
| openbb.econometrics.coint_chart | Function | Show the error-correction terms plot |
|
||||
| openbb.econometrics.pols | Function | Perform a Pooled OLS (pols) regression on Panel data |
|
||||
| openbb.econometrics.root | Function | Check for unit root in the timeseries |
|
||||
| openbb.econometrics.root_chart | Function | Show a nice table of the unit root test results |
|
||||
| openbb.econometrics.bgod | Function | Check for autocorrelation with Breusch Godfrey |
|
||||
| openbb.econometrics.bgod_chart | Function | Show a nice table of the autocorrelation test results |
|
||||
| openbb.econometrics.re | Function | Perform a Random Effects (re) regression on Panel data |
|
||||
| openbb.econometrics.bols | Function | Perform a Between OLS (bols) regression on Panel data |
|
||||
| openbb.econometrics.panel | Function | Obtain the regression results wrapper |
|
||||
| openbb.econometrics.get_regression_data | Function | Obtain an OLS model wrapper |
|
||||
| openbb.econometrics.norm | Function | Check whether the time-series is normally distributed |
|
||||
| openbb.econometrics.norm_chart | Function | Show a histogram of the time-series |
|
||||
| openbb.econometrics.clean | Function | Apply either a fill or drop method to clean the data |
|
||||
| openbb.econometrics.bpag | Function | Test for heteroskedasticity with a Breusch-Pagan test |
|
||||
| openbb.econometrics.bpag_chart | Function | Get a nice table with Breusch-Pagan test results |
|
||||
| openbb.econometrics.fdols | Function | Perform a First Difference OLS (fdols) regression on Panel data |
|
||||
| openbb.econometrics.load | Function | Load in a dataset to be used within other functionalities |
|
||||
| openbb.econometrics.ols | Function | Perform an Ordinary Least Squares (ols) regression on time-series data |
|
||||
| openbb.econometrics.comparison | Function | Compare different regression models in one table |
|
||||
|
||||
Alteratively you can print the contents of the Econometrics SDK with:
|
||||
|
||||
@@ -58,46 +67,45 @@ help(openbb.econometrics)
|
||||
### Loading a dataset
|
||||
|
||||
The first step in using this menu is loading a dataset. This can be either an example dataset, see the list below, or any locally stored Excel file. To demonstrate the usage of the menu, the <a href="https://www.statsmodels.org/dev/datasets/generated/longley.html" target="_blank">longley</a>
|
||||
dataset is loaded in. This can be done with the following
|
||||
dataset is loaded in. This can be done with the following
|
||||
|
||||
```python
|
||||
example_load = openbb.econometrics.load("anes96")
|
||||
file_load = openbb.econometric.load("PATH_TO_FILE/FILE.xlsx")
|
||||
```
|
||||
|
||||
| File | Description |
|
||||
| :----------------- | --------------------------------------------------------: |
|
||||
| anes96 | American National Election Survey 1996 |
|
||||
| cancer | Breast Cancer Data |
|
||||
| ccard | Bill Greene’s credit scoring data. |
|
||||
| cancer_china | Smoking and lung cancer in eight cities in China. |
|
||||
| co2 | Mauna Loa Weekly Atmospheric CO2 Data |
|
||||
| committee | First 100 days of the US House of Representatives 1995 |
|
||||
| copper | World Copper Market 1951-1975 Dataset |
|
||||
| cpunish | US Capital Punishment dataset. |
|
||||
| danish_data | Danish Money Demand Data |
|
||||
| elnino | El Nino - Sea Surface Temperatures |
|
||||
| engel | Engel (1857) food expenditure data |
|
||||
| fair | Affairs dataset |
|
||||
| fertility | World Bank Fertility Data |
|
||||
| grunfeld | Grunfeld (1950) Investment Data |
|
||||
| heart | Transplant Survival Data |
|
||||
| interest_inflation | (West) German interest and inflation rate 1972-1998 |
|
||||
| longley | Longley dataset |
|
||||
| macrodata | United States Macroeconomic data |
|
||||
| modechoice | Travel Mode Choice |
|
||||
| nile | Nile River flows at Ashwan 1871-1970 |
|
||||
| randhie | RAND Health Insurance Experiment Data |
|
||||
| scotland | Taxation Powers Vote for the Scottish Parliament 1997 |
|
||||
| spector | Spector and Mazzeo (1980) - Program Effectiveness Data |
|
||||
| stackloss | Stack loss data |
|
||||
| star98 | Star98 Educational Dataset |
|
||||
| statecrim | Statewide Crime Data 2009 |
|
||||
| strikes | U.S. Strike Duration Data |
|
||||
| sunspots | Yearly sunspots data 1700-2008 |
|
||||
| File | Description |
|
||||
| :----------------- | --------------------------------------------------------: |
|
||||
| anes96 | American National Election Survey 1996 |
|
||||
| cancer | Breast Cancer Data |
|
||||
| ccard | Bill Greene’s credit scoring data. |
|
||||
| cancer_china | Smoking and lung cancer in eight cities in China. |
|
||||
| co2 | Mauna Loa Weekly Atmospheric CO2 Data |
|
||||
| committee | First 100 days of the US House of Representatives 1995 |
|
||||
| copper | World Copper Market 1951-1975 Dataset |
|
||||
| cpunish | US Capital Punishment dataset. |
|
||||
| danish_data | Danish Money Demand Data |
|
||||
| elnino | El Nino - Sea Surface Temperatures |
|
||||
| engel | Engel (1857) food expenditure data |
|
||||
| fair | Affairs dataset |
|
||||
| fertility | World Bank Fertility Data |
|
||||
| grunfeld | Grunfeld (1950) Investment Data |
|
||||
| heart | Transplant Survival Data |
|
||||
| interest_inflation | (West) German interest and inflation rate 1972-1998 |
|
||||
| longley | Longley dataset |
|
||||
| macrodata | United States Macroeconomic data |
|
||||
| modechoice | Travel Mode Choice |
|
||||
| nile | Nile River flows at Ashwan 1871-1970 |
|
||||
| randhie | RAND Health Insurance Experiment Data |
|
||||
| scotland | Taxation Powers Vote for the Scottish Parliament 1997 |
|
||||
| spector | Spector and Mazzeo (1980) - Program Effectiveness Data |
|
||||
| stackloss | Stack loss data |
|
||||
| star98 | Star98 Educational Dataset |
|
||||
| statecrim | Statewide Crime Data 2009 |
|
||||
| strikes | U.S. Strike Duration Data |
|
||||
| sunspots | Yearly sunspots data 1700-2008 |
|
||||
| wage_panel | Veila and M. Verbeek (1998): Whose Wages Do Unions Raise? |
|
||||
|
||||
|
||||
### Working with Time Series data
|
||||
|
||||
To demonstrate the usage of the Econometrics SDK for time series data, the
|
||||
@@ -112,25 +120,24 @@ longley = openbb.econometrics.load("longley")
|
||||
longley
|
||||
```
|
||||
|
||||
| | TOTEMP | GNPDEFL | GNP | UNEMP | ARMED | POP | YEAR |
|
||||
|---:|---------:|----------:|-------:|--------:|--------:|-------:|-------:|
|
||||
| 0 | 60323 | 83 | 234289 | 2356 | 1590 | 107608 | 1947 |
|
||||
| 1 | 61122 | 88.5 | 259426 | 2325 | 1456 | 108632 | 1948 |
|
||||
| 2 | 60171 | 88.2 | 258054 | 3682 | 1616 | 109773 | 1949 |
|
||||
| 3 | 61187 | 89.5 | 284599 | 3351 | 1650 | 110929 | 1950 |
|
||||
| 4 | 63221 | 96.2 | 328975 | 2099 | 3099 | 112075 | 1951 |
|
||||
| 5 | 63639 | 98.1 | 346999 | 1932 | 3594 | 113270 | 1952 |
|
||||
| 6 | 64989 | 99 | 365385 | 1870 | 3547 | 115094 | 1953 |
|
||||
| 7 | 63761 | 100 | 363112 | 3578 | 3350 | 116219 | 1954 |
|
||||
| 8 | 66019 | 101.2 | 397469 | 2904 | 3048 | 117388 | 1955 |
|
||||
| 9 | 67857 | 104.6 | 419180 | 2822 | 2857 | 118734 | 1956 |
|
||||
| 10 | 68169 | 108.4 | 442769 | 2936 | 2798 | 120445 | 1957 |
|
||||
| 11 | 66513 | 110.8 | 444546 | 4681 | 2637 | 121950 | 1958 |
|
||||
| 12 | 68655 | 112.6 | 482704 | 3813 | 2552 | 123366 | 1959 |
|
||||
| 13 | 69564 | 114.2 | 502601 | 3931 | 2514 | 125368 | 1960 |
|
||||
| 14 | 69331 | 115.7 | 518173 | 4806 | 2572 | 127852 | 1961 |
|
||||
| 15 | 70551 | 116.9 | 554894 | 4007 | 2827 | 130081 | 1962 |
|
||||
|
||||
| | TOTEMP | GNPDEFL | GNP | UNEMP | ARMED | POP | YEAR |
|
||||
| --: | -----: | ------: | -----: | ----: | ----: | -----: | ---: |
|
||||
| 0 | 60323 | 83 | 234289 | 2356 | 1590 | 107608 | 1947 |
|
||||
| 1 | 61122 | 88.5 | 259426 | 2325 | 1456 | 108632 | 1948 |
|
||||
| 2 | 60171 | 88.2 | 258054 | 3682 | 1616 | 109773 | 1949 |
|
||||
| 3 | 61187 | 89.5 | 284599 | 3351 | 1650 | 110929 | 1950 |
|
||||
| 4 | 63221 | 96.2 | 328975 | 2099 | 3099 | 112075 | 1951 |
|
||||
| 5 | 63639 | 98.1 | 346999 | 1932 | 3594 | 113270 | 1952 |
|
||||
| 6 | 64989 | 99 | 365385 | 1870 | 3547 | 115094 | 1953 |
|
||||
| 7 | 63761 | 100 | 363112 | 3578 | 3350 | 116219 | 1954 |
|
||||
| 8 | 66019 | 101.2 | 397469 | 2904 | 3048 | 117388 | 1955 |
|
||||
| 9 | 67857 | 104.6 | 419180 | 2822 | 2857 | 118734 | 1956 |
|
||||
| 10 | 68169 | 108.4 | 442769 | 2936 | 2798 | 120445 | 1957 |
|
||||
| 11 | 66513 | 110.8 | 444546 | 4681 | 2637 | 121950 | 1958 |
|
||||
| 12 | 68655 | 112.6 | 482704 | 3813 | 2552 | 123366 | 1959 |
|
||||
| 13 | 69564 | 114.2 | 502601 | 3931 | 2514 | 125368 | 1960 |
|
||||
| 14 | 69331 | 115.7 | 518173 | 4806 | 2572 | 127852 | 1961 |
|
||||
| 15 | 70551 | 116.9 | 554894 | 4007 | 2827 | 130081 | 1962 |
|
||||
|
||||
This can be extended by also showing the descriptive statistics, this can be
|
||||
done with a native command from Pandas as follows:
|
||||
@@ -139,16 +146,16 @@ done with a native command from Pandas as follows:
|
||||
longley.describe()
|
||||
```
|
||||
|
||||
| | TOTEMP | GNPDEFL | GNP | UNEMP | ARMED | POP | YEAR |
|
||||
|:------|---------:|----------:|---------:|---------:|--------:|---------:|-----------:|
|
||||
| count | 16 | 16 | 16 | 16 | 16 | 16 | 16 |
|
||||
| mean | 65317 | 101.681 | 387698 | 3193.31 | 2606.69 | 117424 | 1954.5 |
|
||||
| std | 3511.97 | 10.7916 | 99394.9 | 934.464 | 695.92 | 6956.1 | 4.76095 |
|
||||
| min | 60171 | 83 | 234289 | 1870 | 1456 | 107608 | 1947 |
|
||||
| 25% | 62712.5 | 94.525 | 317881 | 2348.25 | 2298 | 111788 | 1950.75 |
|
||||
| 50% | 65504 | 100.6 | 381427 | 3143.5 | 2717.5 | 116804 | 1954.5 |
|
||||
| 75% | 68290.5 | 111.25 | 454086 | 3842.5 | 3060.75 | 122304 | 1958.25 |
|
||||
| max | 70551 | 116.9 | 554894 | 4806 | 3594 | 130081 | 1962 |
|
||||
| | TOTEMP | GNPDEFL | GNP | UNEMP | ARMED | POP | YEAR |
|
||||
| :---- | ------: | ------: | ------: | ------: | ------: | -----: | ------: |
|
||||
| count | 16 | 16 | 16 | 16 | 16 | 16 | 16 |
|
||||
| mean | 65317 | 101.681 | 387698 | 3193.31 | 2606.69 | 117424 | 1954.5 |
|
||||
| std | 3511.97 | 10.7916 | 99394.9 | 934.464 | 695.92 | 6956.1 | 4.76095 |
|
||||
| min | 60171 | 83 | 234289 | 1870 | 1456 | 107608 | 1947 |
|
||||
| 25% | 62712.5 | 94.525 | 317881 | 2348.25 | 2298 | 111788 | 1950.75 |
|
||||
| 50% | 65504 | 100.6 | 381427 | 3143.5 | 2717.5 | 116804 | 1954.5 |
|
||||
| 75% | 68290.5 | 111.25 | 454086 | 3842.5 | 3060.75 | 122304 | 1958.25 |
|
||||
| max | 70551 | 116.9 | 554894 | 4806 | 3594 | 130081 | 1962 |
|
||||
|
||||
It is possible to check for a variety of assumptions, e.g. normality, unit root,
|
||||
granger and co-integration. The functions `openbb.econometric.norm` and `openb.econometrics.root` are shown below. Note
|
||||
@@ -159,23 +166,22 @@ statistically significant.
|
||||
openbb.econometrics.norm(longley['GNP'])
|
||||
```
|
||||
|
||||
| | Kurtosis | Skewness | Jarque-Bera | Shapiro-Wilk | Kolmogorov-Smirnov |
|
||||
|:----------|-----------:|-----------:|--------------:|---------------:|---------------------:|
|
||||
| Statistic | -1.1944 | 0.0525317 | 0.835092 | 0.962593 | 1 |
|
||||
| p-value | 0.23232 | 0.95811 | 0.65866 | 0.709 | 0 |
|
||||
|
||||
| | Kurtosis | Skewness | Jarque-Bera | Shapiro-Wilk | Kolmogorov-Smirnov |
|
||||
| :-------- | -------: | --------: | ----------: | -----------: | -----------------: |
|
||||
| Statistic | -1.1944 | 0.0525317 | 0.835092 | 0.962593 | 1 |
|
||||
| p-value | 0.23232 | 0.95811 | 0.65866 | 0.709 | 0 |
|
||||
|
||||
```python
|
||||
openbb.econometrics.root(longley['POP'])
|
||||
```
|
||||
|
||||
| | ADF | KPSS |
|
||||
|:---------------|-----------:|---------:|
|
||||
| Test Statistic | 2.35204 | 0.324887 |
|
||||
| P-Value | 0.998986 | 0.1 |
|
||||
| NLags | 6 | 0 |
|
||||
| Nobs | 9 | 0 |
|
||||
| ICBest | 113.054 | 0 |
|
||||
| | ADF | KPSS |
|
||||
| :------------- | -------: | -------: |
|
||||
| Test Statistic | 2.35204 | 0.324887 |
|
||||
| P-Value | 0.998986 | 0.1 |
|
||||
| NLags | 6 | 0 |
|
||||
| Nobs | 9 | 0 |
|
||||
| ICBest | 113.054 | 0 |
|
||||
|
||||
The longley dataset is known for the ability to create an OLS regression that results in a <a href="https://www.investopedia.com/terms/r/r-squared.asp" target="_blank">R-squared</a> of 1.0 due to the fact that the US macroeconomic variables are known to be highly collinear. See the following regression performed with `openbb.econometrics.ols` as follows:
|
||||
|
||||
@@ -188,7 +194,7 @@ ols_regression.summary()
|
||||
```
|
||||
|
||||
```
|
||||
OLS Regression Results
|
||||
OLS Regression Results
|
||||
=======================================================================================
|
||||
Dep. Variable: TOTEMP R-squared (uncentered): 1.000
|
||||
Model: OLS Adj. R-squared (uncentered): 1.000
|
||||
@@ -197,8 +203,8 @@ Date: Mon, 21 Nov 2022 Prob (F-statistic): 8
|
||||
Time: 10:54:19 Log-Likelihood: -117.56
|
||||
No. Observations: 16 AIC: 247.1
|
||||
Df Residuals: 10 BIC: 251.8
|
||||
Df Model: 6
|
||||
Covariance Type: nonrobust
|
||||
Df Model: 6
|
||||
Covariance Type: nonrobust
|
||||
==============================================================================
|
||||
coef std err t P>|t| [0.025 0.975]
|
||||
------------------------------------------------------------------------------
|
||||
@@ -229,12 +235,12 @@ After running the regression estimation, it is possible to perform tests on the
|
||||
openbb.econometrics.bgod(ols_regression)
|
||||
```
|
||||
|
||||
| | 0 |
|
||||
|:---------|-----------:|
|
||||
| lm-stat | 10.3471 |
|
||||
| p-value | 0.0158347 |
|
||||
| f-stat | 0.0970889 |
|
||||
| fp-value | 0.958799 |
|
||||
| | 0 |
|
||||
| :------- | --------: |
|
||||
| lm-stat | 10.3471 |
|
||||
| p-value | 0.0158347 |
|
||||
| f-stat | 0.0970889 |
|
||||
| fp-value | 0.958799 |
|
||||
|
||||
```python
|
||||
# Perform Breusch Pagan heteroskedacity test
|
||||
@@ -242,10 +248,10 @@ openbb.econometrics.bpag(ols_regression)
|
||||
```
|
||||
|
||||
| | 0 |
|
||||
|:---------|---------:|
|
||||
| lm-stat | 7.90331 |
|
||||
| :------- | -------: |
|
||||
| lm-stat | 7.90331 |
|
||||
| p-value | 0.161645 |
|
||||
| f-stat | 1.62686 |
|
||||
| f-stat | 1.62686 |
|
||||
| fp-value | 0.236596 |
|
||||
|
||||
### Working with Panel data
|
||||
@@ -260,13 +266,13 @@ wage_panel = openbb.econometrics.load("wage_panel")
|
||||
wage_panel
|
||||
```
|
||||
|
||||
| | nr | year | black | exper | hisp | hours | married | educ | union | lwage | expersq | occupation |
|
||||
|---:|-----:|-------:|--------:|--------:|-------:|--------:|----------:|-------:|--------:|--------:|----------:|-------------:|
|
||||
| 0 | 13 | 1980 | 0 | 1 | 0 | 2672 | 0 | 14 | 0 | 1.19754 | 1 | 9 |
|
||||
| 1 | 13 | 1981 | 0 | 2 | 0 | 2320 | 0 | 14 | 1 | 1.85306 | 4 | 9 |
|
||||
| 2 | 13 | 1982 | 0 | 3 | 0 | 2940 | 0 | 14 | 0 | 1.34446 | 9 | 9 |
|
||||
| 3 | 13 | 1983 | 0 | 4 | 0 | 2960 | 0 | 14 | 0 | 1.43321 | 16 | 9 |
|
||||
| 4 | 13 | 1984 | 0 | 5 | 0 | 3071 | 0 | 14 | 0 | 1.56812 | 25 | 5 |
|
||||
| | nr | year | black | exper | hisp | hours | married | educ | union | lwage | expersq | occupation |
|
||||
| --: | --: | ---: | ----: | ----: | ---: | ----: | ------: | ---: | ----: | ------: | ------: | ---------: |
|
||||
| 0 | 13 | 1980 | 0 | 1 | 0 | 2672 | 0 | 14 | 0 | 1.19754 | 1 | 9 |
|
||||
| 1 | 13 | 1981 | 0 | 2 | 0 | 2320 | 0 | 14 | 1 | 1.85306 | 4 | 9 |
|
||||
| 2 | 13 | 1982 | 0 | 3 | 0 | 2940 | 0 | 14 | 0 | 1.34446 | 9 | 9 |
|
||||
| 3 | 13 | 1983 | 0 | 4 | 0 | 2960 | 0 | 14 | 0 | 1.43321 | 16 | 9 |
|
||||
| 4 | 13 | 1984 | 0 | 5 | 0 | 3071 | 0 | 14 | 0 | 1.56812 | 25 | 5 |
|
||||
|
||||
4360 rows × 12 columns
|
||||
|
||||
@@ -293,7 +299,7 @@ wage_panel.dtypes
|
||||
```
|
||||
|
||||
| | 0 |
|
||||
|:-----------|:--------|
|
||||
| :--------- | :------ |
|
||||
| nr | int64 |
|
||||
| year | int64 |
|
||||
| black | int64 |
|
||||
@@ -316,7 +322,7 @@ wage_panel.dtypes
|
||||
```
|
||||
|
||||
| | 0 |
|
||||
|:-----------|:---------|
|
||||
| :--------- | :------- |
|
||||
| nr | int64 |
|
||||
| year | category |
|
||||
| black | int64 |
|
||||
@@ -332,19 +338,19 @@ wage_panel.dtypes
|
||||
|
||||
The dataset is now properly configured to allow for proper panel regressions. The Econometrics SDK supports the following regression techniques.
|
||||
|
||||
| Path | Description |
|
||||
| :------------------------- | ---------------------------------------------------------------------: |
|
||||
| openbb.econometrics.ols | Perform an Ordinary Least Squares (ols) regression on time-series data |
|
||||
| openbb.econometrics.pols | Perform a Pooled OLS (pols) regression on Panel data |
|
||||
| openbb.econometrics.bols | Perform a Between OLS (bols) regression on Panel data |
|
||||
| openbb.econometrics.fdols | Perform a First Difference OLS (fdols) regression on Panel data |
|
||||
| openbb.econometrics.fe | Perform a Fixed Effects (fe) regression on Panel data |
|
||||
| openbb.econometrics.re | Perform a Random Effects (re) regression on Panel data |
|
||||
| Path | Description |
|
||||
| :------------------------ | ---------------------------------------------------------------------: |
|
||||
| openbb.econometrics.ols | Perform an Ordinary Least Squares (ols) regression on time-series data |
|
||||
| openbb.econometrics.pols | Perform a Pooled OLS (pols) regression on Panel data |
|
||||
| openbb.econometrics.bols | Perform a Between OLS (bols) regression on Panel data |
|
||||
| openbb.econometrics.fdols | Perform a First Difference OLS (fdols) regression on Panel data |
|
||||
| openbb.econometrics.fe | Perform a Fixed Effects (fe) regression on Panel data |
|
||||
| openbb.econometrics.re | Perform a Random Effects (re) regression on Panel data |
|
||||
|
||||
As an example, a **Random Effects** regression is performed. This can be done as follows:
|
||||
|
||||
```python
|
||||
# Perform the Random Effects regresssion technique
|
||||
# Perform the Random Effects regression technique
|
||||
random_effects_regression = openbb.econometrics.re(wage_panel['lwage'], wage_panel[['black', 'hisp', 'exper', 'expersq', 'married', 'educ', 'union','year']])
|
||||
|
||||
# Show the results
|
||||
@@ -352,26 +358,26 @@ random_effects_regression.summary
|
||||
```
|
||||
|
||||
```
|
||||
RandomEffects Estimation Summary
|
||||
RandomEffects Estimation Summary
|
||||
================================================================================
|
||||
Dep. Variable: lwage R-squared: 0.1806
|
||||
Estimator: RandomEffects R-squared (Between): 0.1853
|
||||
No. Observations: 4360 R-squared (Within): 0.1799
|
||||
Date: Mon, Nov 21 2022 R-squared (Overall): 0.1828
|
||||
Time: 11:13:36 Log-likelihood -1622.5
|
||||
Cov. Estimator: Unadjusted
|
||||
Cov. Estimator: Unadjusted
|
||||
F-statistic: 68.409
|
||||
Entities: 545 P-value 0.0000
|
||||
Avg Obs: 8.0000 Distribution: F(14,4345)
|
||||
Min Obs: 8.0000
|
||||
Min Obs: 8.0000
|
||||
Max Obs: 8.0000 F-statistic (robust): 68.409
|
||||
P-value 0.0000
|
||||
Time periods: 8 Distribution: F(14,4345)
|
||||
Avg Obs: 545.00
|
||||
Min Obs: 545.00
|
||||
Max Obs: 545.00
|
||||
|
||||
Parameter Estimates
|
||||
Avg Obs: 545.00
|
||||
Min Obs: 545.00
|
||||
Max Obs: 545.00
|
||||
|
||||
Parameter Estimates
|
||||
==============================================================================
|
||||
Parameter Std. Err. T-stat P-value Lower CI Upper CI
|
||||
------------------------------------------------------------------------------
|
||||
@@ -391,4 +397,4 @@ year.1985 0.0577 0.0615 0.9383 0.3482 -0.0629 0.1782
|
||||
year.1986 0.0918 0.0716 1.2834 0.1994 -0.0485 0.2321
|
||||
year.1987 0.1348 0.0817 1.6504 0.0989 -0.0253 0.2950
|
||||
==============================================================================
|
||||
```
|
||||
```
|
||||
|
||||
280
website/content/sdk/guides/guides/economy.md
vendored
280
website/content/sdk/guides/guides/economy.md
vendored
@@ -21,52 +21,52 @@ obb.keys.av(key = 'REPLACE_ME', persist = True)
|
||||
|
||||
Below is brief description of each function within the Economy module:
|
||||
|
||||
|Path |Type |Description |
|
||||
|:------------------------------|:----------:|------------------------------:|
|
||||
|openbb.economy.available_indices |Dictionary |Curated List of Global Indices |
|
||||
|openbb.economy.bigmac |Function |The Big Mac Index |
|
||||
|openbb.economy.bigmac_chart |Function |Chart for `bigmac` |
|
||||
|openbb.economy.country_codes |Function |List of Three-Letter ISO Country Codes |
|
||||
|openbb.economy.cpi |Function |Monthly US CPI from AlphaVantage |
|
||||
|openbb.economy.cpi_chart |Function |Chart for `cpi` |
|
||||
|openbb.economy.currencies |Function |Currencies from WSJ |
|
||||
|openbb.economy.events |Function |Economic Calendar |
|
||||
|openbb.economy.fred_ids |Function |Search for a FRED series ID by keyword |
|
||||
|openbb.economy.fred_notes |Function |Search by Keyword for Series Information |
|
||||
|openbb.economy.fred_series |Function |Get Data for a FRED Series ID(s) |
|
||||
|openbb.economy.fred_series_chart |Function |Chart for `fred_series` |
|
||||
|openbb.economy.futures |Function |Current Prices of Commodities |
|
||||
|openbb.economy.gdpc |Function |US GDP per Capita from AlphaVantage |
|
||||
|openbb.economy.gdpc_chart |Function |Chart for `gdpc` |
|
||||
|openbb.economy.get_events_countries |List |List of Countries for Events Function |
|
||||
|openbb.economy.get_groups |List |List of Groups for Performance and Valuation Functions |
|
||||
|openbb.economy.glbonds |Function |Table of Select 10 Year Sovereign Bonds from WSJ |
|
||||
|openbb.economy.indices |Function |Top US Indices from WSJ |
|
||||
|openbb.economy.index |Function |Historical Daily Data for Indices from YahooFinance |
|
||||
|openbb.economy.index_chart |Function |Chart for `index` |
|
||||
|openbb.economy.inf |Function |US Inflation Prints from AlphaVantage |
|
||||
|openbb.economy.inf_chart |Function |Chart for `inf` |
|
||||
|openbb.economy.macro |Function |Gets Series Data from EconDB |
|
||||
|openbb.economy.macro_chart |Function |Chart for `macro` |
|
||||
|openbb.economy.macro_countries |List |List of Countries Accepted by Macro Function |
|
||||
|openbb.economy.macro_parameters |Dictionary |Dictionary of Parameters & Descriptions for Macro Function |
|
||||
|openbb.economy.overview |Function |General Market Overview from WSJ |
|
||||
|openbb.economy.perfmap |Function |Opens a Browser to Performance Map from Finviz |
|
||||
|openbb.economy.performance |Function |Performance Data (get_groups) |
|
||||
|openbb.economy.rtps |Function |Real-Time Performance by Sector (US Markets) from AlphaVantage |
|
||||
|openbb.economy.rtps_chart|Function |Chart of `rtps` |
|
||||
|openbb.economy.search_index |Function |Search for a Global Index by Name |
|
||||
|openbb.economy.treasury |Function |US Treasuries Data |
|
||||
|openbb.economy.treasury_chart |Function |Chart for `treasury` |
|
||||
|openbb.economy.treasury_maturities |Function |Table of Accepted Values for Maturities Argument in `treasury` |
|
||||
|openbb.economy.tyld |Function |Historical Treasury Yields from AlphaVantage |
|
||||
|openbb.economy.tyld_chart |Function |Chart of `tyld` |
|
||||
|openbb.economy.unemp |Function |Historical US Unemployment Data from AlphaVantage |
|
||||
|openbb.economy.unemp_chart |Function |Chart of `unemp` |
|
||||
|openbb.economy.usbonds |Function |Table of Current Rate, Yield, and Yield Change |
|
||||
|openbb.economy.valuation |Function |Valuation for Group from (get_gropus) |
|
||||
|openbb.economy.ycrv |Function |Current and Historical US Yield Curve Data from FRED|
|
||||
|openbb.economy.ycrv_chart |Function |Chart for `ycrv` |
|
||||
| Path | Type | Description |
|
||||
| :---------------------------------- | :--------: | -------------------------------------------------------------: |
|
||||
| openbb.economy.available_indices | Dictionary | Curated List of Global Indices |
|
||||
| openbb.economy.bigmac | Function | The Big Mac Index |
|
||||
| openbb.economy.bigmac_chart | Function | Chart for `bigmac` |
|
||||
| openbb.economy.country_codes | Function | List of Three-Letter ISO Country Codes |
|
||||
| openbb.economy.cpi | Function | Monthly US CPI from AlphaVantage |
|
||||
| openbb.economy.cpi_chart | Function | Chart for `cpi` |
|
||||
| openbb.economy.currencies | Function | Currencies from WSJ |
|
||||
| openbb.economy.events | Function | Economic Calendar |
|
||||
| openbb.economy.fred_ids | Function | Search for a FRED series ID by keyword |
|
||||
| openbb.economy.fred_notes | Function | Search by Keyword for Series Information |
|
||||
| openbb.economy.fred_series | Function | Get Data for a FRED Series ID(s) |
|
||||
| openbb.economy.fred_series_chart | Function | Chart for `fred_series` |
|
||||
| openbb.economy.futures | Function | Current Prices of Commodities |
|
||||
| openbb.economy.gdpc | Function | US GDP per Capita from AlphaVantage |
|
||||
| openbb.economy.gdpc_chart | Function | Chart for `gdpc` |
|
||||
| openbb.economy.get_events_countries | List | List of Countries for Events Function |
|
||||
| openbb.economy.get_groups | List | List of Groups for Performance and Valuation Functions |
|
||||
| openbb.economy.glbonds | Function | Table of Select 10 Year Sovereign Bonds from WSJ |
|
||||
| openbb.economy.indices | Function | Top US Indices from WSJ |
|
||||
| openbb.economy.index | Function | Historical Daily Data for Indices from YahooFinance |
|
||||
| openbb.economy.index_chart | Function | Chart for `index` |
|
||||
| openbb.economy.inf | Function | US Inflation Prints from AlphaVantage |
|
||||
| openbb.economy.inf_chart | Function | Chart for `inf` |
|
||||
| openbb.economy.macro | Function | Gets Series Data from EconDB |
|
||||
| openbb.economy.macro_chart | Function | Chart for `macro` |
|
||||
| openbb.economy.macro_countries | List | List of Countries Accepted by Macro Function |
|
||||
| openbb.economy.macro_parameters | Dictionary | Dictionary of Parameters & Descriptions for Macro Function |
|
||||
| openbb.economy.overview | Function | General Market Overview from WSJ |
|
||||
| openbb.economy.perfmap | Function | Opens a Browser to Performance Map from Finviz |
|
||||
| openbb.economy.performance | Function | Performance Data (get_groups) |
|
||||
| openbb.economy.rtps | Function | Real-Time Performance by Sector (US Markets) from AlphaVantage |
|
||||
| openbb.economy.rtps_chart | Function | Chart of `rtps` |
|
||||
| openbb.economy.search_index | Function | Search for a Global Index by Name |
|
||||
| openbb.economy.treasury | Function | US Treasuries Data |
|
||||
| openbb.economy.treasury_chart | Function | Chart for `treasury` |
|
||||
| openbb.economy.treasury_maturities | Function | Table of Accepted Values for Maturities Argument in `treasury` |
|
||||
| openbb.economy.tyld | Function | Historical Treasury Yields from AlphaVantage |
|
||||
| openbb.economy.tyld_chart | Function | Chart of `tyld` |
|
||||
| openbb.economy.unemp | Function | Historical US Unemployment Data from AlphaVantage |
|
||||
| openbb.economy.unemp_chart | Function | Chart of `unemp` |
|
||||
| openbb.economy.usbonds | Function | Table of Current Rate, Yield, and Yield Change |
|
||||
| openbb.economy.valuation | Function | Valuation for Group from (get_gropus) |
|
||||
| openbb.economy.ycrv | Function | Current and Historical US Yield Curve Data from FRED |
|
||||
| openbb.economy.ycrv_chart | Function | Chart for `ycrv` |
|
||||
|
||||
Alternatively, the contents of the economy, or function docstrings, is printed with:
|
||||
|
||||
@@ -96,13 +96,13 @@ indexes = pd.DataFrame.from_dict(openbb.economy.available_indices()).transpose()
|
||||
indexes
|
||||
```
|
||||
|
||||
| | name | ticker |
|
||||
|:--------|:-------------------------------|:---------|
|
||||
| sp500 | S&P 500 Index | ^GSPC |
|
||||
| sp400 | S&P 400 Mid Cap Index | ^SP400 |
|
||||
| sp600 | S&P 600 Small Cap Index | ^SP600 |
|
||||
| sp500tr | S&P 500 TR Index | ^SP500TR |
|
||||
| sp_xsp | S&P 500 Mini SPX Options Index | ^XSP |
|
||||
| | name | ticker |
|
||||
| :-------- | :------------------------------ | :------- |
|
||||
| sp500 | S&P 500 Index | ^GSPC |
|
||||
| sp400 | S&P 400 Mid Cap Index | ^SP400 |
|
||||
| sp600 | S&P 600 Small Cap Index | ^SP600 |
|
||||
| sp500tr | S&P 500 TR Index | ^SP500TR |
|
||||
| sp_xsp | S&P 500 Mini SPX Options Index | ^XSP |
|
||||
| cboe_tyx | CBOE 30 year Treasury Yields | ^TYX |
|
||||
| cboe_irx | CBOE 13 Week Treasury Bill | ^IRX |
|
||||
| move | ICE BofAML Move Index | ^MOVE |
|
||||
@@ -115,18 +115,18 @@ This list can be filtered:
|
||||
indexes.filter(like = 'sp_', axis = 0)
|
||||
```
|
||||
|
||||
| | name | ticker |
|
||||
|:-------------------------|:-------------------------------------------|:--------------|
|
||||
| sp_xsp | S&P 500 Mini SPX Options Index | ^XSP |
|
||||
| sp_energy_ig | S&P 500 Energy (Industry Group) Index | ^SP500-1010 |
|
||||
| sp_energy_equipment | S&P 500 Energy Equipment & Services Industry Index | ^SP500-101010 |
|
||||
| sp_energy_oil | S&P 500 Oil, Gas & Consumable Fuels Industry Index | ^SP500-101020 |
|
||||
| sp_materials_sector | S&P 500 Materials Sector Index | ^SP500-15 |
|
||||
| sp_utilities_sector | S&P 500 Utilities Sector Index | ^SP500-55 |
|
||||
| sp_utilities_electricity | S&P 500 Electric Utilities Index | ^SP500-551010 |
|
||||
| sp_utilities_multis | S&P 500 Multi-Utilities Industry Index | ^SP500-551030 |
|
||||
| sp_re_sector | S&P 500 Real Estate Sector Index | ^SP500-60 |
|
||||
| sp_re_ig | S&P 500 Real Estate (Industry Group) Index | ^SP500-6010 |
|
||||
| | name | ticker |
|
||||
| :----------------------- | :------------------------------------------------- | :------------ |
|
||||
| sp_xsp | S&P 500 Mini SPX Options Index | ^XSP |
|
||||
| sp_energy_ig | S&P 500 Energy (Industry Group) Index | ^SP500-1010 |
|
||||
| sp_energy_equipment | S&P 500 Energy Equipment & Services Industry Index | ^SP500-101010 |
|
||||
| sp_energy_oil | S&P 500 Oil, Gas & Consumable Fuels Industry Index | ^SP500-101020 |
|
||||
| sp_materials_sector | S&P 500 Materials Sector Index | ^SP500-15 |
|
||||
| sp_utilities_sector | S&P 500 Utilities Sector Index | ^SP500-55 |
|
||||
| sp_utilities_electricity | S&P 500 Electric Utilities Index | ^SP500-551010 |
|
||||
| sp_utilities_multis | S&P 500 Multi-Utilities Industry Index | ^SP500-551030 |
|
||||
| sp_re_sector | S&P 500 Real Estate Sector Index | ^SP500-60 |
|
||||
| sp_re_ig | S&P 500 Real Estate (Industry Group) Index | ^SP500-6010 |
|
||||
|
||||
One index, or multiple, can be requested as a single DataFrame:
|
||||
|
||||
@@ -136,11 +136,11 @@ df = openbb.economy.index(indices = ['sp_energy_oil', 'sp_energy_equipment', 'sp
|
||||
df.tail(3)
|
||||
```
|
||||
|
||||
| Date | sp_energy_oil | sp_energy_equipment | sp_energy_ig |
|
||||
|:--------------------|----------------:|----------------------:|---------------:|
|
||||
| 2022-11-14 00:00:00 | 800.76 | 330.53 | 712.28 |
|
||||
| 2022-11-15 00:00:00 | 809.27 | 335.84 | 720.16 |
|
||||
| 2022-11-16 00:00:00 | 792.32 | 326.49 | 704.68 |
|
||||
| Date | sp_energy_oil | sp_energy_equipment | sp_energy_ig |
|
||||
| :------------------ | ------------: | ------------------: | -----------: |
|
||||
| 2022-11-14 00:00:00 | 800.76 | 330.53 | 712.28 |
|
||||
| 2022-11-15 00:00:00 | 809.27 | 335.84 | 720.16 |
|
||||
| 2022-11-16 00:00:00 | 792.32 | 326.49 | 704.68 |
|
||||
|
||||
This can also be displayed as a chart:
|
||||
|
||||
@@ -158,16 +158,16 @@ Performance metrics for sectors, industries, and regions (US listed) are printed
|
||||
openbb.economy.performance(group = 'energy')
|
||||
```
|
||||
|
||||
| | Name | Week | Month | 3Month | 6Month | 1Year | YTD | Recom | AvgVolume [1M] | RelVolume | Change | Volume [1M] |
|
||||
|---:|:-------------------------------|--------:|--------:|---------:|---------:|--------:|-------:|--------:|-----------------:|------------:|---------:|--------------:|
|
||||
| 0 | Oil & Gas Drilling | 0.0106 | 0.2154 | 0.2501 | 0.1534 | 0.711 | 0.8991 | 1.92 | 33.58 | 0.71 | -0.013 | 16.93 |
|
||||
| 1 | Oil & Gas E&P | 0.0019 | 0.0618 | 0.1188 | 0.15 | 0.6602 | 0.6922 | 2.18 | 287.09 | 0.66 | -0.0059 | 136.36 |
|
||||
| 2 | Oil & Gas Equipment & Services | -0.0063 | 0.1613 | 0.305 | 0.1219 | 0.493 | 0.5702 | 2.1 | 74.1 | 0.52 | -0.0125 | 27.79 |
|
||||
| 3 | Oil & Gas Integrated | 0.0166 | 0.0557 | 0.0885 | 0.0462 | 0.4014 | 0.4114 | 2.23 | 122.44 | 0.71 | -0.0079 | 62.12 |
|
||||
| 4 | Oil & Gas Midstream | -0.0113 | 0.038 | -0.019 | 0.0045 | 0.1551 | 0.2027 | 2.3 | 105.55 | 0.65 | -0.0115 | 48.8 |
|
||||
| 5 | Oil & Gas Refining & Marketing | 0.0147 | 0.0929 | 0.1562 | 0.1585 | 0.6038 | 0.6084 | 2.13 | 30.59 | 0.61 | -0.0006 | 13.32 |
|
||||
| 6 | Thermal Coal | -0.0096 | 0.0291 | -0.0494 | 0.1289 | 1.2305 | 1.0504 | 1.97 | 8.74 | 0.69 | -0.0207 | 4.28 |
|
||||
| 7 | Uranium | -0.0176 | 0.0416 | 0.0856 | 0.0426 | -0.1746 | 0.0267 | 1.61 | 32.44 | 0.54 | -0.0125 | 12.58 |
|
||||
| | Name | Week | Month | 3Month | 6Month | 1Year | YTD | Recom | AvgVolume [1M] | RelVolume | Change | Volume [1M] |
|
||||
| --: | :----------------------------- | ------: | -----: | ------: | -----: | ------: | -----: | ----: | -------------: | --------: | ------: | ----------: |
|
||||
| 0 | Oil & Gas Drilling | 0.0106 | 0.2154 | 0.2501 | 0.1534 | 0.711 | 0.8991 | 1.92 | 33.58 | 0.71 | -0.013 | 16.93 |
|
||||
| 1 | Oil & Gas E&P | 0.0019 | 0.0618 | 0.1188 | 0.15 | 0.6602 | 0.6922 | 2.18 | 287.09 | 0.66 | -0.0059 | 136.36 |
|
||||
| 2 | Oil & Gas Equipment & Services | -0.0063 | 0.1613 | 0.305 | 0.1219 | 0.493 | 0.5702 | 2.1 | 74.1 | 0.52 | -0.0125 | 27.79 |
|
||||
| 3 | Oil & Gas Integrated | 0.0166 | 0.0557 | 0.0885 | 0.0462 | 0.4014 | 0.4114 | 2.23 | 122.44 | 0.71 | -0.0079 | 62.12 |
|
||||
| 4 | Oil & Gas Midstream | -0.0113 | 0.038 | -0.019 | 0.0045 | 0.1551 | 0.2027 | 2.3 | 105.55 | 0.65 | -0.0115 | 48.8 |
|
||||
| 5 | Oil & Gas Refining & Marketing | 0.0147 | 0.0929 | 0.1562 | 0.1585 | 0.6038 | 0.6084 | 2.13 | 30.59 | 0.61 | -0.0006 | 13.32 |
|
||||
| 6 | Thermal Coal | -0.0096 | 0.0291 | -0.0494 | 0.1289 | 1.2305 | 1.0504 | 1.97 | 8.74 | 0.69 | -0.0207 | 4.28 |
|
||||
| 7 | Uranium | -0.0176 | 0.0416 | 0.0856 | 0.0426 | -0.1746 | 0.0267 | 1.61 | 32.44 | 0.54 | -0.0125 | 12.58 |
|
||||
|
||||
Performance by sector:
|
||||
|
||||
@@ -175,23 +175,23 @@ Performance by sector:
|
||||
openbb.economy.performance(group = 'sector')
|
||||
```
|
||||
|
||||
| | Name | Week | Month | 3Month | 6Month | 1Year | YTD | Recom | AvgVolume [1M] | RelVolume | Change | Volume [1M] |
|
||||
|---:|:-----------------------|--------:|--------:|---------:|---------:|--------:|--------:|--------:|-----------------:|------------:|---------:|--------------:|
|
||||
| 0 | Basic Materials | -0.0032 | 0.129 | 0.0195 | -0.0572 | -0.0684 | -0.0928 | 2.22 | 469.94 | 0.66 | -0.0116 | 222.2 |
|
||||
| 1 | Communication Services | 0.0343 | 0.0128 | -0.1444 | -0.1297 | -0.3837 | -0.3529 | 1.97 | 731.34 | 0.72 | 0.0004 | 377.12 |
|
||||
| 2 | Consumer Cyclical | 0.0111 | 0.0266 | -0.1386 | -0.0182 | -0.3665 | -0.3221 | 2.14 | 1430 | 1.01 | -0.0034 | 1040 |
|
||||
| 3 | Consumer Defensive | 0.003 | 0.0757 | -0.0302 | 0.0573 | -0.019 | -0.0574 | 2.31 | 298.74 | 0.85 | -0.0019 | 181.95 |
|
||||
| 4 | Energy | 0.0067 | 0.0629 | 0.0913 | 0.0736 | 0.4208 | 0.4497 | 2.21 | 694.52 | 0.65 | -0.008 | 322.19 |
|
||||
| 5 | Financial | -0.0095 | 0.0934 | -0.0098 | 0.0339 | -0.1259 | -0.1137 | 2.24 | 861.74 | 0.79 | -0.005 | 489.78 |
|
||||
| 6 | Healthcare | -0.0121 | 0.0703 | -0.0125 | 0.0177 | -0.1074 | -0.1161 | 2.11 | 1180 | 0.87 | 0.0002 | 736.58 |
|
||||
| 7 | Industrials | -0.0118 | 0.0969 | -0.0223 | 0.0723 | -0.1138 | -0.101 | 2.32 | 573.08 | 0.7 | -0.005 | 285.24 |
|
||||
| 8 | Real Estate | -0.0259 | 0.0884 | -0.1441 | -0.0961 | -0.2413 | -0.2738 | 2.18 | 341.84 | 0.55 | -0.0055 | 134.66 |
|
||||
| 9 | Technology | 0.0149 | 0.0938 | -0.1095 | -0.0044 | -0.3024 | -0.2957 | 2.03 | 1460 | 0.86 | 0.0039 | 904.44 |
|
||||
| 10 | Utilities | -0.0235 | 0.0485 | -0.1212 | -0.0582 | -0.0054 | -0.0569 | 2.29 | 166.21 | 0.67 | -0.0142 | 79.25 |
|
||||
| | Name | Week | Month | 3Month | 6Month | 1Year | YTD | Recom | AvgVolume [1M] | RelVolume | Change | Volume [1M] |
|
||||
| --: | :--------------------- | ------: | -----: | ------: | ------: | ------: | ------: | ----: | -------------: | --------: | ------: | ----------: |
|
||||
| 0 | Basic Materials | -0.0032 | 0.129 | 0.0195 | -0.0572 | -0.0684 | -0.0928 | 2.22 | 469.94 | 0.66 | -0.0116 | 222.2 |
|
||||
| 1 | Communication Services | 0.0343 | 0.0128 | -0.1444 | -0.1297 | -0.3837 | -0.3529 | 1.97 | 731.34 | 0.72 | 0.0004 | 377.12 |
|
||||
| 2 | Consumer Cyclical | 0.0111 | 0.0266 | -0.1386 | -0.0182 | -0.3665 | -0.3221 | 2.14 | 1430 | 1.01 | -0.0034 | 1040 |
|
||||
| 3 | Consumer Defensive | 0.003 | 0.0757 | -0.0302 | 0.0573 | -0.019 | -0.0574 | 2.31 | 298.74 | 0.85 | -0.0019 | 181.95 |
|
||||
| 4 | Energy | 0.0067 | 0.0629 | 0.0913 | 0.0736 | 0.4208 | 0.4497 | 2.21 | 694.52 | 0.65 | -0.008 | 322.19 |
|
||||
| 5 | Financial | -0.0095 | 0.0934 | -0.0098 | 0.0339 | -0.1259 | -0.1137 | 2.24 | 861.74 | 0.79 | -0.005 | 489.78 |
|
||||
| 6 | Healthcare | -0.0121 | 0.0703 | -0.0125 | 0.0177 | -0.1074 | -0.1161 | 2.11 | 1180 | 0.87 | 0.0002 | 736.58 |
|
||||
| 7 | Industrials | -0.0118 | 0.0969 | -0.0223 | 0.0723 | -0.1138 | -0.101 | 2.32 | 573.08 | 0.7 | -0.005 | 285.24 |
|
||||
| 8 | Real Estate | -0.0259 | 0.0884 | -0.1441 | -0.0961 | -0.2413 | -0.2738 | 2.18 | 341.84 | 0.55 | -0.0055 | 134.66 |
|
||||
| 9 | Technology | 0.0149 | 0.0938 | -0.1095 | -0.0044 | -0.3024 | -0.2957 | 2.03 | 1460 | 0.86 | 0.0039 | 904.44 |
|
||||
| 10 | Utilities | -0.0235 | 0.0485 | -0.1212 | -0.0582 | -0.0054 | -0.0569 | 2.29 | 166.21 | 0.67 | -0.0142 | 79.25 |
|
||||
|
||||
### Events
|
||||
|
||||
A global economic calender is accessible through the `events` function:
|
||||
A global economic calendar is accessible through the `events` function:
|
||||
|
||||
```python
|
||||
help(openbb.economy.events)
|
||||
@@ -222,18 +222,18 @@ With no arguments, `events` will return the calendar from today:
|
||||
openbb.economy.events()
|
||||
```
|
||||
|
||||
| | Time (GMT) | Country | Event | actual | consensus | previous | Date |
|
||||
|---:|:-------------|:---------------|:-------------------------|:---------|:------------|:-----------|:-----------|
|
||||
| 0 | 02:00 | United Kingdom | Car Registration | -40.4% | - | 227.2% | 2022-11-17 |
|
||||
| 1 | 02:00 | United Kingdom | Car Registration | 26.4% | - | 4.6% | 2022-11-17 |
|
||||
| 2 | 02:00 | Italy | Italian Car Registration | 14.6% | - | 5.4% | 2022-11-17 |
|
||||
| 3 | 02:00 | Italy | Italian Car Registration | 4.4% | - | 55.9% | 2022-11-17 |
|
||||
| 4 | 02:00 | Switzerland | Trade Balance | 4.140B | - | 4.193B | 2022-11-17 |
|
||||
| 56 | 13:00 | United States | 10-Year TIPS Auction | 1.485% | - | 1.248% | 2022-11-17 |
|
||||
| 57 | 18:30 | Japan | CPI, n.s.a | - | - | 0.4% | 2022-11-17 |
|
||||
| 58 | 18:30 | Japan | National Core CPI | - | 3.5% | 3.0% | 2022-11-17 |
|
||||
| 59 | 18:30 | Japan | National CPI | - | - | 3.0% | 2022-11-17 |
|
||||
| 60 | 19:01 | United Kingdom | GfK Consumer Confidence | - | -52 | -47 | 2022-11-17 |
|
||||
| | Time (GMT) | Country | Event | actual | consensus | previous | Date |
|
||||
| --: | :--------- | :------------- | :----------------------- | :----- | :-------- | :------- | :--------- |
|
||||
| 0 | 02:00 | United Kingdom | Car Registration | -40.4% | - | 227.2% | 2022-11-17 |
|
||||
| 1 | 02:00 | United Kingdom | Car Registration | 26.4% | - | 4.6% | 2022-11-17 |
|
||||
| 2 | 02:00 | Italy | Italian Car Registration | 14.6% | - | 5.4% | 2022-11-17 |
|
||||
| 3 | 02:00 | Italy | Italian Car Registration | 4.4% | - | 55.9% | 2022-11-17 |
|
||||
| 4 | 02:00 | Switzerland | Trade Balance | 4.140B | - | 4.193B | 2022-11-17 |
|
||||
| 56 | 13:00 | United States | 10-Year TIPS Auction | 1.485% | - | 1.248% | 2022-11-17 |
|
||||
| 57 | 18:30 | Japan | CPI, n.s.a | - | - | 0.4% | 2022-11-17 |
|
||||
| 58 | 18:30 | Japan | National Core CPI | - | 3.5% | 3.0% | 2022-11-17 |
|
||||
| 59 | 18:30 | Japan | National CPI | - | - | 3.0% | 2022-11-17 |
|
||||
| 60 | 19:01 | United Kingdom | GfK Consumer Confidence | - | -52 | -47 | 2022-11-17 |
|
||||
|
||||
Calendar events can be requested for a specific countries and date ranges:
|
||||
|
||||
@@ -241,13 +241,13 @@ Calendar events can be requested for a specific countries and date ranges:
|
||||
openbb.economy.events(countries = ['United States'], start_date = '2022-11-18', end_date = '2022-11-18')
|
||||
```
|
||||
|
||||
| | Time (GMT) | Country | Event | actual | consensus | previous | Date |
|
||||
|---:|:-------------|:--------------|:----------------------------------|:---------|:------------|:-----------|:-----------|
|
||||
| 0 | 10:00 | United States | Existing Home Sales | - | 4.38M | 4.71M | 2022-11-18 |
|
||||
| 1 | 10:00 | United States | Existing Home Sales | - | - | -1.5% | 2022-11-18 |
|
||||
| 2 | 10:00 | United States | US Leading Index | - | -0.4% | -0.4% | 2022-11-18 |
|
||||
| 3 | 13:00 | United States | U.S. Baker Hughes Oil Rig Count | - | - | 622 | 2022-11-18 |
|
||||
| 4 | 13:00 | United States | U.S. Baker Hughes Total Rig Count | - | - | 779 | 2022-11-18 |
|
||||
| | Time (GMT) | Country | Event | actual | consensus | previous | Date |
|
||||
| --: | :--------- | :------------ | :-------------------------------- | :----- | :-------- | :------- | :--------- |
|
||||
| 0 | 10:00 | United States | Existing Home Sales | - | 4.38M | 4.71M | 2022-11-18 |
|
||||
| 1 | 10:00 | United States | Existing Home Sales | - | - | -1.5% | 2022-11-18 |
|
||||
| 2 | 10:00 | United States | US Leading Index | - | -0.4% | -0.4% | 2022-11-18 |
|
||||
| 3 | 13:00 | United States | U.S. Baker Hughes Oil Rig Count | - | - | 622 | 2022-11-18 |
|
||||
| 4 | 13:00 | United States | U.S. Baker Hughes Total Rig Count | - | - | 779 | 2022-11-18 |
|
||||
|
||||
### FRED
|
||||
|
||||
@@ -260,7 +260,7 @@ series_ids.head(5)
|
||||
```
|
||||
|
||||
| id | title |
|
||||
|:----------------|:----------------------------------------------------------------------------------------------------|
|
||||
| :-------------- | :-------------------------------------------------------------------------------------------------- |
|
||||
| PCU333132333132 | Producer Price Index by Industry: Oil and Gas Field Machinery and Equipment Manufacturing |
|
||||
| CES1021100001 | All Employees, Oil and Gas Extraction |
|
||||
| IPG211111CS | Industrial Production: Mining, Quarrying, and Oil and Gas Extraction: Crude Oil (NAICS = 211111pt.) |
|
||||
@@ -275,13 +275,13 @@ data,titles = openbb.economy.fred_series(series_ids=['A33DNO', 'PCU21112111'])
|
||||
data.tail(5)
|
||||
```
|
||||
|
||||
| | A33DNO | PCU21112111 |
|
||||
|:--------------------|---------:|--------------:|
|
||||
| 2022-05-01 00:00:00 | 1509 | 339.024 |
|
||||
| 2022-06-01 00:00:00 | 1534 | 374.936 |
|
||||
| 2022-07-01 00:00:00 | 1516 | 315.785 |
|
||||
| 2022-08-01 00:00:00 | 1661 | 350.329 |
|
||||
| 2022-09-01 00:00:00 | 1551 | 339.109 |
|
||||
| | A33DNO | PCU21112111 |
|
||||
| :------------------ | -----: | ----------: |
|
||||
| 2022-05-01 00:00:00 | 1509 | 339.024 |
|
||||
| 2022-06-01 00:00:00 | 1534 | 374.936 |
|
||||
| 2022-07-01 00:00:00 | 1516 | 315.785 |
|
||||
| 2022-08-01 00:00:00 | 1661 | 350.329 |
|
||||
| 2022-09-01 00:00:00 | 1551 | 339.109 |
|
||||
|
||||
Series can also be plotted together:
|
||||
|
||||
@@ -340,13 +340,13 @@ parameters = pd.DataFrame.from_dict(openbb.economy.macro_parameters()).transpose
|
||||
parameters.tail(5)
|
||||
```
|
||||
|
||||
| | name | period | description |
|
||||
|:--------|:--------------------------|:---------|:-------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| Y10YD | Long term yield (10-year) | Monthly | The 10-year yield is used as a proxy for mortgage rates. It's also seen as a sign of investor sentiment about the country's economy. |
|
||||
| M3YD | 3 month yield | Monthly | The yield received for investing in a government issued treasury security that has a maturity of 3 months |
|
||||
| HOU | House price index | Monthly | House price index defined with base 2015 for Europe with varying bases for others. See: https://www.econdb.com/main-indicators |
|
||||
| OILPROD | Oil production | Monthly | The amount of oil barrels produced per day in a month within a country. |
|
||||
| POP | Population | Monthly | The population of a country. This can be in thousands or, when relatively small, in actual units. |
|
||||
| | name | period | description |
|
||||
| :------ | :------------------------ | :------ | :----------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| Y10YD | Long term yield (10-year) | Monthly | The 10-year yield is used as a proxy for mortgage rates. It's also seen as a sign of investor sentiment about the country's economy. |
|
||||
| M3YD | 3 month yield | Monthly | The yield received for investing in a government issued treasury security that has a maturity of 3 months |
|
||||
| HOU | House price index | Monthly | House price index defined with base 2015 for Europe with varying bases for others. See: https://www.econdb.com/main-indicators |
|
||||
| OILPROD | Oil production | Monthly | The amount of oil barrels produced per day in a month within a country. |
|
||||
| POP | Population | Monthly | The population of a country. This can be in thousands or, when relatively small, in actual units. |
|
||||
|
||||
The data from the `macro` function is unpacked like:
|
||||
|
||||
@@ -356,15 +356,15 @@ data,units,denomination = openbb.economy.macro(parameters = ['Y10YD'], countries
|
||||
data.tail(10)
|
||||
```
|
||||
|
||||
| date | France | Germany | Italy | Poland | Spain | United States |
|
||||
|:--------------------|----------------------:|-----------------------:|---------------------:|----------------------:|---------------------:|-----------------------------:|
|
||||
| 2022-01-01 00:00:00 | 0.31 | -0.12 | 1.35 | 4 | 0.66 | 1.76 |
|
||||
| 2022-02-01 00:00:00 | 0.68 | 0.15 | 1.79 | 3.95 | 1.11 | 1.93 |
|
||||
| 2022-03-01 00:00:00 | 0.78 | 0.28 | 1.85 | 4.83 | 1.22 | 2.13 |
|
||||
| 2022-04-01 00:00:00 | 1.28 | 0.75 | 2.44 | 5.96 | 1.69 | 2.75 |
|
||||
| 2022-05-01 00:00:00 | 1.52 | 0.95 | 2.99 | 6.64 | 2.04 | 2.9 |
|
||||
| 2022-06-01 00:00:00 | 2.06 | 1.45 | 3.64 | 7.14 | 2.63 | 3.14 |
|
||||
| 2022-07-01 00:00:00 | 1.71 | 1.08 | 3.36 | 6.37 | 2.31 | 2.9 |
|
||||
| 2022-08-01 00:00:00 | 1.69 | 1.03 | 3.3 | 5.8 | 2.15 | 2.9 |
|
||||
| 2022-09-01 00:00:00 | 2.41 | 1.8 | 4.14 | 6.28 | 2.92 | 3.52 |
|
||||
| 2022-10-01 00:00:00 | 2.77 | 2.19 | 4.53 | 7.82 | 3.29 | 3.98 |
|
||||
| date | France | Germany | Italy | Poland | Spain | United States |
|
||||
| :------------------ | -----: | ------: | ----: | -----: | ----: | ------------: |
|
||||
| 2022-01-01 00:00:00 | 0.31 | -0.12 | 1.35 | 4 | 0.66 | 1.76 |
|
||||
| 2022-02-01 00:00:00 | 0.68 | 0.15 | 1.79 | 3.95 | 1.11 | 1.93 |
|
||||
| 2022-03-01 00:00:00 | 0.78 | 0.28 | 1.85 | 4.83 | 1.22 | 2.13 |
|
||||
| 2022-04-01 00:00:00 | 1.28 | 0.75 | 2.44 | 5.96 | 1.69 | 2.75 |
|
||||
| 2022-05-01 00:00:00 | 1.52 | 0.95 | 2.99 | 6.64 | 2.04 | 2.9 |
|
||||
| 2022-06-01 00:00:00 | 2.06 | 1.45 | 3.64 | 7.14 | 2.63 | 3.14 |
|
||||
| 2022-07-01 00:00:00 | 1.71 | 1.08 | 3.36 | 6.37 | 2.31 | 2.9 |
|
||||
| 2022-08-01 00:00:00 | 1.69 | 1.03 | 3.3 | 5.8 | 2.15 | 2.9 |
|
||||
| 2022-09-01 00:00:00 | 2.41 | 1.8 | 4.14 | 6.28 | 2.92 | 3.52 |
|
||||
| 2022-10-01 00:00:00 | 2.77 | 2.19 | 4.53 | 7.82 | 3.29 | 3.98 |
|
||||
|
||||
312
website/content/sdk/guides/guides/stocks/index.md
vendored
312
website/content/sdk/guides/guides/stocks/index.md
vendored
@@ -8,27 +8,27 @@ The capabilities of the Stocks menu from the OpenBB Terminal are wrapped into a
|
||||
|
||||
The list below are the SDK functions within the Stocks module and a short description:
|
||||
|
||||
|Path |Type |Description |
|
||||
|:----|:---------------------:|---------------------------------------------:|
|
||||
|openbb.stocks.ba | Sub-Module| Behavioural Analysis|
|
||||
|openbb.stocks.ca | Sub-Module| Comparison Analysis|
|
||||
|openbb.stocks.candle | Function| OHLC + Volume + Moving Averages Chart|
|
||||
|openbb.stocks.dd | Sub-Module| Due Dilligence|
|
||||
|openbb.stocks.disc | Sub-Module| Stock Discovery|
|
||||
|openbb.stocks.dps | Sub-Module| Dark Pools & Shorts|
|
||||
|openbb.stocks.fa | Sub-Module| Fundamental Analysis|
|
||||
|openbb.stocks.gov | Sub-Module| US Government, Lobbying & Representative Activity|
|
||||
|openbb.stocks.ins | Sub-Module| Corporate Insider Activity (SEC Form 4)|
|
||||
|openbb.stocks.load | Function| Load Data|
|
||||
|openbb.stocks.options | Sub-Module| Options|
|
||||
|openbb.stocks.qa | Sub-Module| Stocks-Only Quantitative Analysis|
|
||||
|openbb.stocks.quote | Function| Last Price (yFinance)|
|
||||
|openbb.stocks.screener | Sub-Module| Stock Screener|
|
||||
|openbb.stocks.search | Function| Find Stocks|
|
||||
|openbb.stocks.sia | Sub-Module| Sector & Industry Analysis|
|
||||
|openbb.stocks.ta | Sub-Module| Stocks-Only Technical Analysis|
|
||||
|openbb.stocks.th | Sub-Module| Trading Hours (Market Status)|
|
||||
|openbb.stocks.tob | Function| Top of Book (CBOE)|
|
||||
| Path | Type | Description |
|
||||
| :--------------------- | :--------: | ------------------------------------------------: |
|
||||
| openbb.stocks.ba | Sub-Module | Behavioural Analysis |
|
||||
| openbb.stocks.ca | Sub-Module | Comparison Analysis |
|
||||
| openbb.stocks.candle | Function | OHLC + Volume + Moving Averages Chart |
|
||||
| openbb.stocks.dd | Sub-Module | Due Diligence |
|
||||
| openbb.stocks.disc | Sub-Module | Stock Discovery |
|
||||
| openbb.stocks.dps | Sub-Module | Dark Pools & Shorts |
|
||||
| openbb.stocks.fa | Sub-Module | Fundamental Analysis |
|
||||
| openbb.stocks.gov | Sub-Module | US Government, Lobbying & Representative Activity |
|
||||
| openbb.stocks.ins | Sub-Module | Corporate Insider Activity (SEC Form 4) |
|
||||
| openbb.stocks.load | Function | Load Data |
|
||||
| openbb.stocks.options | Sub-Module | Options |
|
||||
| openbb.stocks.qa | Sub-Module | Stocks-Only Quantitative Analysis |
|
||||
| openbb.stocks.quote | Function | Last Price (yFinance) |
|
||||
| openbb.stocks.screener | Sub-Module | Stock Screener |
|
||||
| openbb.stocks.search | Function | Find Stocks |
|
||||
| openbb.stocks.sia | Sub-Module | Sector & Industry Analysis |
|
||||
| openbb.stocks.ta | Sub-Module | Stocks-Only Technical Analysis |
|
||||
| openbb.stocks.th | Sub-Module | Trading Hours (Market Status) |
|
||||
| openbb.stocks.tob | Function | Top of Book (CBOE) |
|
||||
|
||||
Alternatively, contents of the menu is printed by running:
|
||||
|
||||
@@ -73,11 +73,11 @@ spy_monthly = openbb.stocks.load(
|
||||
spy_monthly.head(3)
|
||||
```
|
||||
|
||||
| date | Open | High | Low | Close | Adj Close | Volume |
|
||||
|:--------------------|--------:|--------:|--------:|--------:|------------:|-----------:|
|
||||
| 1993-02-01 00:00:00 | 43.9688 | 45.125 | 42.8125 | 44.4062 | 25.6043 | 5.4176e+06 |
|
||||
| 1993-03-01 00:00:00 | 44.5625 | 45.8438 | 44.2188 | 45.1875 | 26.0548 | 3.0192e+06 |
|
||||
| 1993-04-01 00:00:00 | 45.25 | 45.25 | 43.2812 | 44.0312 | 25.508 | 2.6972e+06 |
|
||||
| date | Open | High | Low | Close | Adj Close | Volume |
|
||||
| :------------------ | ------: | ------: | ------: | ------: | --------: | ---------: |
|
||||
| 1993-02-01 00:00:00 | 43.9688 | 45.125 | 42.8125 | 44.4062 | 25.6043 | 5.4176e+06 |
|
||||
| 1993-03-01 00:00:00 | 44.5625 | 45.8438 | 44.2188 | 45.1875 | 26.0548 | 3.0192e+06 |
|
||||
| 1993-04-01 00:00:00 | 45.25 | 45.25 | 43.2812 | 44.0312 | 25.508 | 2.6972e+06 |
|
||||
|
||||
There are source-dependent differences to the DataFrame returned. For example, compare the above with below:
|
||||
|
||||
@@ -95,11 +95,11 @@ spy_monthly = openbb.stocks.load(
|
||||
spy_monthly.head(3)
|
||||
```
|
||||
|
||||
| date | Volume | vw | Open | Adj Close | High | Low | Transactions | Close |
|
||||
|:--------------------|------------:|--------:|-------:|------------:|-------:|-------:|---------------:|--------:|
|
||||
| 2022-09-01 04:00:00 | 1.99492e+09 | 382.507 | 392.89 | 357.18 | 411.73 | 357.04 | 1.35653e+07 | 357.18 |
|
||||
| 2022-10-01 04:00:00 | 2.02389e+09 | 370.918 | 361.08 | 386.21 | 389.52 | 348.11 | 1.38047e+07 | 386.21 |
|
||||
| 2022-11-01 04:00:00 | 1.17559e+09 | 386.119 | 390.14 | 394.28 | 402.31 | 368.79 | 8.34067e+06 | 394.28 |
|
||||
| date | Volume | vw | Open | Adj Close | High | Low | Transactions | Close |
|
||||
| :------------------ | ----------: | ------: | -----: | --------: | -----: | -----: | -----------: | -----: |
|
||||
| 2022-09-01 04:00:00 | 1.99492e+09 | 382.507 | 392.89 | 357.18 | 411.73 | 357.04 | 1.35653e+07 | 357.18 |
|
||||
| 2022-10-01 04:00:00 | 2.02389e+09 | 370.918 | 361.08 | 386.21 | 389.52 | 348.11 | 1.38047e+07 | 386.21 |
|
||||
| 2022-11-01 04:00:00 | 1.17559e+09 | 386.119 | 390.14 | 394.28 | 402.31 | 368.79 | 8.34067e+06 | 394.28 |
|
||||
|
||||
### Candle
|
||||
|
||||
@@ -111,7 +111,7 @@ openbb.stocks.candle(data = spy_monthly, symbol = 'SPY - Monthly Candles')
|
||||
|
||||
|
||||
|
||||
The `candle` function is also aware if a ticker is being passed. This makes it unneccessary to create a DataFrame if the objective is only to display the chart.
|
||||
The `candle` function is also aware if a ticker is being passed. This makes it unnecessary to create a DataFrame if the objective is only to display the chart.
|
||||
|
||||
```python
|
||||
openbb.stocks.candle('SPY')
|
||||
@@ -135,13 +135,14 @@ Search for companies by name with the `search` function, with optional filters f
|
||||
openbb.stocks.search(sector = 'Energy', country = 'United Kingdom', query = 'oil')
|
||||
```
|
||||
|
||||
| | | long_name | country | sector | industry | exchange |
|
||||
|---:|:-------------|:--------------------------------|:---------------|:---------|:--------------|-----------:|
|
||||
| 0 | 3NO.F | Nostrum Oil & Gas PLC | United Kingdom | Energy | Oil & Gas E&P | nan |
|
||||
| 1 | BOIL.L | Baron Oil Plc | United Kingdom | Energy | Oil & Gas E&P | nan |
|
||||
| 2 | EGN.F | Europa Oil & Gas (Holdings) plc | United Kingdom | Energy | Oil & Gas E&P | nan |
|
||||
| 3 | EOG.L | Europa Oil & Gas (Holdings) plc | United Kingdom | Energy | Oil & Gas E&P | nan |
|
||||
| 4 | GHA.F | Baron Oil Plc | United Kingdom | Energy | Oil & Gas E&P | nan |
|
||||
| | | long_name | country | sector | industry | exchange |
|
||||
| --: | :----- | :------------------------------ | :------------- | :----- | :------------ | -------: |
|
||||
| 0 | 3NO.F | Nostrum Oil & Gas PLC | United Kingdom | Energy | Oil & Gas E&P | nan |
|
||||
| 1 | BOIL.L | Baron Oil Plc | United Kingdom | Energy | Oil & Gas E&P | nan |
|
||||
| 2 | EGN.F | Europa Oil & Gas (Holdings) plc | United Kingdom | Energy | Oil & Gas E&P | nan |
|
||||
| 3 | EOG.L | Europa Oil & Gas (Holdings) plc | United Kingdom | Energy | Oil & Gas E&P | nan |
|
||||
| 4 | GHA.F | Baron Oil Plc | United Kingdom | Energy | Oil & Gas E&P | nan |
|
||||
|
||||
...continued
|
||||
|
||||
### Quote
|
||||
@@ -162,20 +163,20 @@ quotes = pd.concat(quotes)
|
||||
quotes
|
||||
```
|
||||
|
||||
| Symbol | Name | Price | Open | High | Low | Previous Close | Volume | 52 Week High | 52 Week Low | Change | Change % |
|
||||
|:---------|:--------------------------------|--------:|-------:|-------:|-------:|-----------------:|:-----------|---------------:|--------------:|---------:|:-----------|
|
||||
| SPY | SPDR S&P 500 | 399.62 | 396.66 | 400.18 | 395.92 | 398.51 | 42,786,020 | 479.98 | 348.11 | 1.11 | 0.28% |
|
||||
| XLE | SPDR Select Sector Fund - Energ | 94 | 92.86 | 94.7 | 92.86 | 93.13 | 14,593,450 | 94.7 | 51.66 | 0.87 | 0.93% |
|
||||
| XLB | Materials Select Sector SPDR | 81.97 | 80.98 | 82.25 | 80.9 | 81.25 | 4,544,573 | 92.31 | 66.85 | 0.72 | 0.89% |
|
||||
| XLI | SPDR Select Sector Fund - Indus | 100.07 | 99.24 | 100.26 | 99.16 | 99.53 | 6,186,242 | 107.88 | 82.75 | 0.54 | 0.54% |
|
||||
| XLP | SPDR Select Sector Fund - Consu | 73.81 | 73.45 | 74.11 | 73.48 | 73.52 | 9,557,986 | 81.34 | 66.18 | 0.29 | 0.39% |
|
||||
| XLY | SPDR Select Sector Fund - Consu | 144.43 | 143.83 | 145.08 | 142.68 | 145.09 | 3,614,077 | 215.06 | 131.9 | -0.66 | -0.45% |
|
||||
| XLV | SPDR Select Sector Fund - Healt | 134.67 | 133.53 | 134.84 | 133.53 | 133.13 | 7,913,382 | 143.42 | 118.75 | 1.54 | 1.16% |
|
||||
| XLF | SPDR Select Sector Fund - Finan | 35.67 | 35.77 | 35.8 | 35.54 | 35.87 | 22,587,218 | 41.7 | 29.59 | -0.2 | -0.56% |
|
||||
| XLK | SPDR Select Sector Fund - Techn | 133.42 | 132.09 | 133.65 | 131.37 | 133.14 | 4,010,764 | 177.04 | 112.97 | 0.28 | 0.21% |
|
||||
| XLC | The Communication Services Sele | 50.44 | 49.66 | 50.56 | 49.62 | 50.02 | 3,220,128 | 81.91 | 44.86 | 0.41 | 0.83% |
|
||||
| XLU | SPDR Select Sector Fund - Utili | 67.91 | 68.12 | 68.49 | 67.75 | 68.08 | 6,871,930 | 78.22 | 60.35 | -0.17 | -0.25% |
|
||||
| XLRE | Real Estate Select Sector SPDR | 38.09 | 38.52 | 38.55 | 38.03 | 38.74 | 4,769,207 | 52.17 | 33.12 | -0.65 | -1.68% |
|
||||
| Symbol | Name | Price | Open | High | Low | Previous Close | Volume | 52 Week High | 52 Week Low | Change | Change % |
|
||||
| :----- | :------------------------------ | -----: | -----: | -----: | -----: | -------------: | :--------- | -----------: | ----------: | -----: | :------- |
|
||||
| SPY | SPDR S&P 500 | 399.62 | 396.66 | 400.18 | 395.92 | 398.51 | 42,786,020 | 479.98 | 348.11 | 1.11 | 0.28% |
|
||||
| XLE | SPDR Select Sector Fund - Energ | 94 | 92.86 | 94.7 | 92.86 | 93.13 | 14,593,450 | 94.7 | 51.66 | 0.87 | 0.93% |
|
||||
| XLB | Materials Select Sector SPDR | 81.97 | 80.98 | 82.25 | 80.9 | 81.25 | 4,544,573 | 92.31 | 66.85 | 0.72 | 0.89% |
|
||||
| XLI | SPDR Select Sector Fund - Indus | 100.07 | 99.24 | 100.26 | 99.16 | 99.53 | 6,186,242 | 107.88 | 82.75 | 0.54 | 0.54% |
|
||||
| XLP | SPDR Select Sector Fund - Consu | 73.81 | 73.45 | 74.11 | 73.48 | 73.52 | 9,557,986 | 81.34 | 66.18 | 0.29 | 0.39% |
|
||||
| XLY | SPDR Select Sector Fund - Consu | 144.43 | 143.83 | 145.08 | 142.68 | 145.09 | 3,614,077 | 215.06 | 131.9 | -0.66 | -0.45% |
|
||||
| XLV | SPDR Select Sector Fund - Healt | 134.67 | 133.53 | 134.84 | 133.53 | 133.13 | 7,913,382 | 143.42 | 118.75 | 1.54 | 1.16% |
|
||||
| XLF | SPDR Select Sector Fund - Finan | 35.67 | 35.77 | 35.8 | 35.54 | 35.87 | 22,587,218 | 41.7 | 29.59 | -0.2 | -0.56% |
|
||||
| XLK | SPDR Select Sector Fund - Techn | 133.42 | 132.09 | 133.65 | 131.37 | 133.14 | 4,010,764 | 177.04 | 112.97 | 0.28 | 0.21% |
|
||||
| XLC | The Communication Services Sele | 50.44 | 49.66 | 50.56 | 49.62 | 50.02 | 3,220,128 | 81.91 | 44.86 | 0.41 | 0.83% |
|
||||
| XLU | SPDR Select Sector Fund - Utili | 67.91 | 68.12 | 68.49 | 67.75 | 68.08 | 6,871,930 | 78.22 | 60.35 | -0.17 | -0.25% |
|
||||
| XLRE | Real Estate Select Sector SPDR | 38.09 | 38.52 | 38.55 | 38.03 | 38.74 | 4,769,207 | 52.17 | 33.12 | -0.65 | -1.68% |
|
||||
|
||||
### TOB
|
||||
|
||||
@@ -188,13 +189,13 @@ quote_tob = bid.join(ask, lsuffix= ': Bid', rsuffix = ': Ask')
|
||||
quote_tob
|
||||
```
|
||||
|
||||
| | Size: Bid | Price: Bid | Size: Ask | Price: Ask |
|
||||
|---:|------------:|-------------:|------------:|-------------:|
|
||||
| 0 | 100 | 394.85 | 100 | 395 |
|
||||
| 1 | 100 | 394.8 | 300 | 395.05 |
|
||||
| 2 | 100 | 394.7 | 100 | 395.07 |
|
||||
| 3 | 100 | 394.68 | 200 | 395.25 |
|
||||
| 4 | 100 | 394.65 | 100 | 395.29 |
|
||||
| | Size: Bid | Price: Bid | Size: Ask | Price: Ask |
|
||||
| --: | --------: | ---------: | --------: | ---------: |
|
||||
| 0 | 100 | 394.85 | 100 | 395 |
|
||||
| 1 | 100 | 394.8 | 300 | 395.05 |
|
||||
| 2 | 100 | 394.7 | 100 | 395.07 |
|
||||
| 3 | 100 | 394.68 | 200 | 395.25 |
|
||||
| 4 | 100 | 394.65 | 100 | 395.29 |
|
||||
|
||||
### Upcoming Earnings
|
||||
|
||||
@@ -208,13 +209,14 @@ earnings_today = earnings.filter(like = datetime.now().strftime('%Y-%m-%d'), axi
|
||||
earnings_today.head(5)
|
||||
```
|
||||
|
||||
| Date | Ticker | Name |
|
||||
|:-----------|:---------|:---------------------------|
|
||||
| 2022-11-17 | DXLG | Destination XL Group, Inc. |
|
||||
| 2022-11-17 | CAMT | Camtek Ltd. |
|
||||
| 2022-11-17 | CLBT | Cellebrite DI Ltd. |
|
||||
| 2022-11-17 | HAYN | Haynes International, Inc. |
|
||||
| 2022-11-17 | ROST | Ross Stores, Inc. |
|
||||
| Date | Ticker | Name |
|
||||
| :--------- | :----- | :------------------------- |
|
||||
| 2022-11-17 | DXLG | Destination XL Group, Inc. |
|
||||
| 2022-11-17 | CAMT | Camtek Ltd. |
|
||||
| 2022-11-17 | CLBT | Cellebrite DI Ltd. |
|
||||
| 2022-11-17 | HAYN | Haynes International, Inc. |
|
||||
| 2022-11-17 | ROST | Ross Stores, Inc. |
|
||||
|
||||
...continued
|
||||
|
||||
### Screener
|
||||
@@ -229,13 +231,14 @@ screener_results.sort_values(by = ['EPS next Y'], ascending = False, inplace = T
|
||||
screener_results.head(5)
|
||||
```
|
||||
|
||||
| | Ticker | Market Cap | P/E | Fwd P/E | PEG | P/S | P/B | P/C | P/FCF | EPS this Y | EPS next Y | EPS past 5Y | EPS next 5Y | Sales past 5Y | Price | Change | Volume |
|
||||
|---:|:---------|-------------:|-------:|----------:|-------:|------:|------:|------:|--------:|-------------:|-------------:|--------------:|--------------:|----------------:|--------:|---------:|-----------------:|
|
||||
| 2 | CLBT | 8.8396e+08 | 6.18 | 31.91 | 1.21 | 3.42 | 37.31 | 8.22 | nan | -0.708 | 1.1111 | nan | 0.051 | nan | 4.85 | -0.0122 | 105214 |
|
||||
| 6 | GAMB | 3.4528e+08 | 34.84 | 18.92 | nan | 6.18 | 4.02 | 11.1 | 37.53 | -0.177 | 1.04 | nan | nan | nan | 9.65 | 0.0354 | 34618 |
|
||||
| 13 | STNE | 2.85e+09 | nan | 3.57 | nan | 1.69 | 1.31 | 2.43 | 5.05 | -2.513 | 0.9624 | -0.598 | 0.2815 | 0.694 | 9.87 | -0.0573 | 9.54896e+06 |
|
||||
| 0 | AMSWA | 5.415e+08 | 46.52 | 32.4 | 2.91 | 4.18 | 4.12 | 4.71 | 71.25 | 0.527 | 0.4318 | -0.04 | 0.16 | 0.037 | 16.33 | -0.0337 | 126062 |
|
||||
| 14 | WWD | 5.9e+09 | 37.68 | 27.41 | 3.66 | 2.55 | 3.11 | 59.37 | 43.51 | -0.15 | 0.3407 | 0.023 | 0.103 | 0.021 | 98.04 | 0.0007 | 455047 |
|
||||
| | Ticker | Market Cap | P/E | Fwd P/E | PEG | P/S | P/B | P/C | P/FCF | EPS this Y | EPS next Y | EPS past 5Y | EPS next 5Y | Sales past 5Y | Price | Change | Volume |
|
||||
| --: | :----- | ---------: | ----: | ------: | ---: | ---: | ----: | ----: | ----: | ---------: | ---------: | ----------: | ----------: | ------------: | ----: | ------: | ----------: |
|
||||
| 2 | CLBT | 8.8396e+08 | 6.18 | 31.91 | 1.21 | 3.42 | 37.31 | 8.22 | nan | -0.708 | 1.1111 | nan | 0.051 | nan | 4.85 | -0.0122 | 105214 |
|
||||
| 6 | GAMB | 3.4528e+08 | 34.84 | 18.92 | nan | 6.18 | 4.02 | 11.1 | 37.53 | -0.177 | 1.04 | nan | nan | nan | 9.65 | 0.0354 | 34618 |
|
||||
| 13 | STNE | 2.85e+09 | nan | 3.57 | nan | 1.69 | 1.31 | 2.43 | 5.05 | -2.513 | 0.9624 | -0.598 | 0.2815 | 0.694 | 9.87 | -0.0573 | 9.54896e+06 |
|
||||
| 0 | AMSWA | 5.415e+08 | 46.52 | 32.4 | 2.91 | 4.18 | 4.12 | 4.71 | 71.25 | 0.527 | 0.4318 | -0.04 | 0.16 | 0.037 | 16.33 | -0.0337 | 126062 |
|
||||
| 14 | WWD | 5.9e+09 | 37.68 | 27.41 | 3.66 | 2.55 | 3.11 | 59.37 | 43.51 | -0.15 | 0.3407 | 0.023 | 0.103 | 0.021 | 98.04 | 0.0007 | 455047 |
|
||||
|
||||
...continued
|
||||
|
||||
Along with the variety of screeners, the OpenBB SDK can create custom screeners. For example, the most popular tickers on Stocktwits:
|
||||
@@ -247,18 +250,18 @@ tickers = stocktwits['Ticker'].to_list()
|
||||
stocktwits.head(10)
|
||||
```
|
||||
|
||||
| | Ticker | Watchlist Count | Name |
|
||||
|---:|:---------|------------------:|:-------------------------------|
|
||||
| 18 | NVDA | 409301 | NVIDIA Corp |
|
||||
| 12 | AMC | 406952 | AMC Entertainment Holdings Inc |
|
||||
| 5 | WMT | 109864 | Walmart Inc |
|
||||
| 6 | MRNA | 100705 | Moderna Inc |
|
||||
| 21 | PFE | 87229 | Pfizer Inc. |
|
||||
| 4 | DWAC | 66122 | Digital World Acquisition Corp |
|
||||
| 29 | CSCO | 54458 | Cisco Systems, Inc. |
|
||||
| 0 | SAVA | 49063 | Cassava Sciences Inc |
|
||||
| 8 | TDOC | 38657 | Teladoc Health Inc |
|
||||
| 16 | PENN | 38277 | Penn National Gaming, Inc. |
|
||||
| | Ticker | Watchlist Count | Name |
|
||||
| --: | :----- | --------------: | :----------------------------- |
|
||||
| 18 | NVDA | 409301 | NVIDIA Corp |
|
||||
| 12 | AMC | 406952 | AMC Entertainment Holdings Inc |
|
||||
| 5 | WMT | 109864 | Walmart Inc |
|
||||
| 6 | MRNA | 100705 | Moderna Inc |
|
||||
| 21 | PFE | 87229 | Pfizer Inc. |
|
||||
| 4 | DWAC | 66122 | Digital World Acquisition Corp |
|
||||
| 29 | CSCO | 54458 | Cisco Systems, Inc. |
|
||||
| 0 | SAVA | 49063 | Cassava Sciences Inc |
|
||||
| 8 | TDOC | 38657 | Teladoc Health Inc |
|
||||
| 16 | PENN | 38277 | Penn National Gaming, Inc. |
|
||||
|
||||
Filter the results by market cap:
|
||||
|
||||
@@ -269,14 +272,15 @@ screener_results = screener_results.sort_values(by = ['Market Cap'], ascending =
|
||||
screener_results.head(5)
|
||||
```
|
||||
|
||||
| | Ticker | Company | Sector | Industry | Country | Market Cap | P/E | Price | Change | Volume |
|
||||
|---:|:---------|:----------------------------------------------------------------------------------|:-------------------|:-----------------------------|:----------|-------------:|-------:|--------:|---------:|-----------------:|
|
||||
| 15 | NVDA | NVIDIA Corporation | Technology | Semiconductors | USA | 3.9217e+11 | 53.53 | 163.66 | 0.0024 | 3.16641e+07 |
|
||||
| 26 | WMT | Walmart Inc. | Consumer Defensive | Discount Stores | USA | 3.864e+11 | 28.46 | 140.5 | -0.0146 | 5.33372e+06 |
|
||||
| 18 | PFE | Pfizer Inc. | Healthcare | Drug Manufacturers - General | USA | 2.6591e+11 | 9.03 | 49.36 | 0.037 | 1.07892e+07 |
|
||||
| 4 | BLK | BlackRock, Inc. | Financial | Asset Management | USA | 1.1412e+11 | 21.34 | 747.95 | -0.0346 | 742602 |
|
||||
| 25 | TGT | Target Corporation | Consumer Defensive | Discount Stores | USA | 7.566e+10 | 19.68 | 175.67 | 0.0136 | 2.45293e+06 |
|
||||
...continued
|
||||
| | Ticker | Company | Sector | Industry | Country | Market Cap | P/E | Price | Change | Volume |
|
||||
| --: | :----- | :----------------- | :----------------- | :--------------------------- | :------ | ---------: | ----: | -----: | ------: | ----------: |
|
||||
| 15 | NVDA | NVIDIA Corporation | Technology | Semiconductors | USA | 3.9217e+11 | 53.53 | 163.66 | 0.0024 | 3.16641e+07 |
|
||||
| 26 | WMT | Walmart Inc. | Consumer Defensive | Discount Stores | USA | 3.864e+11 | 28.46 | 140.5 | -0.0146 | 5.33372e+06 |
|
||||
| 18 | PFE | Pfizer Inc. | Healthcare | Drug Manufacturers - General | USA | 2.6591e+11 | 9.03 | 49.36 | 0.037 | 1.07892e+07 |
|
||||
| 4 | BLK | BlackRock, Inc. | Financial | Asset Management | USA | 1.1412e+11 | 21.34 | 747.95 | -0.0346 | 742602 |
|
||||
| 25 | TGT | Target Corporation | Consumer Defensive | Discount Stores | USA | 7.566e+10 | 19.68 | 175.67 | 0.0136 | 2.45293e+06 |
|
||||
|
||||
...continued
|
||||
|
||||
### SEC
|
||||
|
||||
@@ -286,17 +290,18 @@ Get the links for SEC filings belonging to a company:
|
||||
openbb.stocks.dd.sec(symbol = 'WMT')
|
||||
```
|
||||
|
||||
| Filing Date | Document Date | Type | Category | Amended | Link |
|
||||
|:--------------|:----------------|:---------|:------------------------|:----------|:-------------------------------------------------------------------------------------|
|
||||
| 09/09/2022 | 09/06/2022 | 8-K | Special Events | | https://www.marketwatch.com/investing/stock/wmt/financials/secfilings?docid=16074059 |
|
||||
| 09/02/2022 | 07/31/2022 | 10-Q | Quarterly Reports | | https://www.marketwatch.com/investing/stock/wmt/financials/secfilings?docid=16064659 |
|
||||
| 08/17/2022 | 08/17/2022 | 8-K | Special Events | | https://www.marketwatch.com/investing/stock/wmt/financials/secfilings?docid=16026629 |
|
||||
| 08/17/2022 | 08/17/2022 | 8-K | Special Events | | https://www.marketwatch.com/investing/stock/wmt/financials/secfilings?docid=16025172 |
|
||||
| 08/16/2022 | 08/16/2022 | 8-K | Special Events | | https://www.marketwatch.com/investing/stock/wmt/financials/secfilings?docid=16021891 |
|
||||
| 07/25/2022 | 07/25/2022 | 8-K | Special Events | | https://www.marketwatch.com/investing/stock/wmt/financials/secfilings?docid=15964414 |
|
||||
| 07/21/2022 | N/A | SC 13D/A | N/A | * | https://www.marketwatch.com/investing/stock/wmt/financials/secfilings?docid=15959675 |
|
||||
| 06/28/2022 | 06/28/2022 | 8-K | Special Events | | https://www.marketwatch.com/investing/stock/wmt/financials/secfilings?docid=15918852 |
|
||||
| 06/21/2022 | N/A | SC 13D | N/A | | https://www.marketwatch.com/investing/stock/wmt/financials/secfilings?docid=15900809 |
|
||||
| Filing Date | Document Date | Type | Category | Amended | Link |
|
||||
| :---------- | :------------ | :------- | :---------------- | :------ | :----------------------------------------------------------------------------------- |
|
||||
| 09/09/2022 | 09/06/2022 | 8-K | Special Events | | https://www.marketwatch.com/investing/stock/wmt/financials/secfilings?docid=16074059 |
|
||||
| 09/02/2022 | 07/31/2022 | 10-Q | Quarterly Reports | | https://www.marketwatch.com/investing/stock/wmt/financials/secfilings?docid=16064659 |
|
||||
| 08/17/2022 | 08/17/2022 | 8-K | Special Events | | https://www.marketwatch.com/investing/stock/wmt/financials/secfilings?docid=16026629 |
|
||||
| 08/17/2022 | 08/17/2022 | 8-K | Special Events | | https://www.marketwatch.com/investing/stock/wmt/financials/secfilings?docid=16025172 |
|
||||
| 08/16/2022 | 08/16/2022 | 8-K | Special Events | | https://www.marketwatch.com/investing/stock/wmt/financials/secfilings?docid=16021891 |
|
||||
| 07/25/2022 | 07/25/2022 | 8-K | Special Events | | https://www.marketwatch.com/investing/stock/wmt/financials/secfilings?docid=15964414 |
|
||||
| 07/21/2022 | N/A | SC 13D/A | N/A | \* | https://www.marketwatch.com/investing/stock/wmt/financials/secfilings?docid=15959675 |
|
||||
| 06/28/2022 | 06/28/2022 | 8-K | Special Events | | https://www.marketwatch.com/investing/stock/wmt/financials/secfilings?docid=15918852 |
|
||||
| 06/21/2022 | N/A | SC 13D | N/A | | https://www.marketwatch.com/investing/stock/wmt/financials/secfilings?docid=15900809 |
|
||||
|
||||
...continued
|
||||
|
||||
### Insiders Trading
|
||||
@@ -307,13 +312,14 @@ View insider activity on the stock:
|
||||
openbb.stocks.ins.lins(symbol = 'WMT')
|
||||
```
|
||||
|
||||
| Date | Relationship | Transaction | #Shares | Cost | Value ($) | #Shares Total | Insider Trading | SEC Form 4 |
|
||||
|:-------|:-------------------------|:--------------|:----------|-------:|:------------|:----------------|:-------------------|:----------------|
|
||||
| Oct 27 | President and CEO | Sale | 9,708 | 141.18 | 1,370,617 | 1,478,337 | McMillon C Douglas | Oct 28 06:14 PM |
|
||||
| Oct 27 | Executive Vice President | Sale | 4,375 | 140.94 | 616,612 | 263,809 | Furner John R. | Oct 28 06:11 PM |
|
||||
| Sep 22 | Executive Vice President | Sale | 4,375 | 134.38 | 587,912 | 268,183 | Furner John R. | Sep 23 05:21 PM |
|
||||
| Sep 22 | President and CEO | Sale | 9,708 | 134.04 | 1,301,309 | 1,488,043 | McMillon C Douglas | Sep 23 05:18 PM |
|
||||
| Aug 25 | Director | Sale | 347,542 | 135.66 | 47,145,880 | 282,330,635 | WALTON S ROBSON | Aug 26 06:36 PM |
|
||||
| Date | Relationship | Transaction | #Shares | Cost | Value ($) | #Shares Total | Insider Trading | SEC Form 4 |
|
||||
| :----- | :----------------------- | :---------- | :------ | -----: | :--------- | :------------ | :----------------- | :-------------- |
|
||||
| Oct 27 | President and CEO | Sale | 9,708 | 141.18 | 1,370,617 | 1,478,337 | McMillon C Douglas | Oct 28 06:14 PM |
|
||||
| Oct 27 | Executive Vice President | Sale | 4,375 | 140.94 | 616,612 | 263,809 | Furner John R. | Oct 28 06:11 PM |
|
||||
| Sep 22 | Executive Vice President | Sale | 4,375 | 134.38 | 587,912 | 268,183 | Furner John R. | Sep 23 05:21 PM |
|
||||
| Sep 22 | President and CEO | Sale | 9,708 | 134.04 | 1,301,309 | 1,488,043 | McMillon C Douglas | Sep 23 05:18 PM |
|
||||
| Aug 25 | Director | Sale | 347,542 | 135.66 | 47,145,880 | 282,330,635 | WALTON S ROBSON | Aug 26 06:36 PM |
|
||||
|
||||
...continued
|
||||
|
||||
### Income Statement Comparison
|
||||
@@ -324,28 +330,29 @@ Income statements from multiple companies can be easily referenced:
|
||||
openbb.stocks.ca.income(similar = ['WMT', 'TGT', 'AMZN'], quarter = True)
|
||||
```
|
||||
|
||||
| Item | 31-Jul-2022: WMT | 31-Jul-2022: TGT | 30-Sep-2022: AMZN |
|
||||
|:------------------------------------------|:-------------------------|:-------------------------|:--------------------------|
|
||||
| Sales/Revenue | 152.86B | 26.04B | 127.1B |
|
||||
| Sales Growth | 7.97% | 3.44% | 4.84% |
|
||||
| Cost of Goods Sold (COGS) incl. D&A | 115.84B | 20.71B | 70.27B |
|
||||
| COGS Growth | 8.41% | 8.67% | 5.79% |
|
||||
| COGS excluding D&A | 113.14B | 20.06B | 60.06B |
|
||||
| Depreciation & Amortization Expense | 2.7B | 650M | 10.2B |
|
||||
| Depreciation | 2.7B | - | - |
|
||||
| Amortization of Intangibles | - | - | - |
|
||||
| Gross Income | 37.02B | 5.32B | 56.83B |
|
||||
| Gross Income Growth | 6.62% | -12.85% | 3.69% |
|
||||
| Gross Profit Margin | 24.22% | 20.44% | 44.71% |
|
||||
| SG&A Expense | 30.17B | 4.98B | 54.14B |
|
||||
| SGA Growth | 3.30% | 4.98% | 5.33% |
|
||||
| Research & Development | - | - | 19.49B |
|
||||
| Other SG&A | - | - | - |
|
||||
| Other Operating Expense | - | - | - |
|
||||
| Unusual Expense | (238M) | 27M | (2.04B) |
|
||||
| EBIT after Unusual Expense | 238M | (27M) | 2.04B |
|
||||
| Non Operating Income/Expense | - | 8M | (1.45B) |
|
||||
| Non-Operating Interest Income | 31M | - | 277M |
|
||||
| Item | 31-Jul-2022: WMT | 31-Jul-2022: TGT | 30-Sep-2022: AMZN |
|
||||
| :---------------------------------- | :--------------- | :--------------- | :---------------- |
|
||||
| Sales/Revenue | 152.86B | 26.04B | 127.1B |
|
||||
| Sales Growth | 7.97% | 3.44% | 4.84% |
|
||||
| Cost of Goods Sold (COGS) incl. D&A | 115.84B | 20.71B | 70.27B |
|
||||
| COGS Growth | 8.41% | 8.67% | 5.79% |
|
||||
| COGS excluding D&A | 113.14B | 20.06B | 60.06B |
|
||||
| Depreciation & Amortization Expense | 2.7B | 650M | 10.2B |
|
||||
| Depreciation | 2.7B | - | - |
|
||||
| Amortization of Intangibles | - | - | - |
|
||||
| Gross Income | 37.02B | 5.32B | 56.83B |
|
||||
| Gross Income Growth | 6.62% | -12.85% | 3.69% |
|
||||
| Gross Profit Margin | 24.22% | 20.44% | 44.71% |
|
||||
| SG&A Expense | 30.17B | 4.98B | 54.14B |
|
||||
| SGA Growth | 3.30% | 4.98% | 5.33% |
|
||||
| Research & Development | - | - | 19.49B |
|
||||
| Other SG&A | - | - | - |
|
||||
| Other Operating Expense | - | - | - |
|
||||
| Unusual Expense | (238M) | 27M | (2.04B) |
|
||||
| EBIT after Unusual Expense | 238M | (27M) | 2.04B |
|
||||
| Non Operating Income/Expense | - | 8M | (1.45B) |
|
||||
| Non-Operating Interest Income | 31M | - | 277M |
|
||||
|
||||
...continued
|
||||
|
||||
### Ratios
|
||||
@@ -356,21 +363,22 @@ Get historical fundamental ratios for a company:
|
||||
openbb.stocks.fa.ratios(symbol = 'WMT')
|
||||
```
|
||||
|
||||
| | 2022 | 2021 | 2020 | 2019 | 2018 |
|
||||
|:-----------------------------------------|:-------|:-------|:-------|:-------|:-------|
|
||||
| Period | FY | FY | FY | FY | FY |
|
||||
| Current ratio | 0.928 | 0.972 | 0.795 | 0.799 | 0.760 |
|
||||
| Quick ratio | 0.264 | 0.262 | 0.202 | 0.181 | 0.158 |
|
||||
| Cash ratio | 0.169 | 0.191 | 0.122 | 0.100 | 0.086 |
|
||||
| Days of sales outstanding | 5.277 | 4.253 | 4.378 | 4.458 | 4.095 |
|
||||
| Days of inventory outstanding | 48.080 | 39.034 | 41.101 | 41.937 | 42.799 |
|
||||
| Operating cycle | 53.357 | 43.287 | 45.479 | 46.395 | 46.894 |
|
||||
| Days of payables outstanding | 47.017 | 42.674 | 43.449 | 44.580 | 45.056 |
|
||||
| Cash conversion cycle | 6.340 | 0.613 | 2.030 | 1.814 | 1.838 |
|
||||
| Gross profit margin | 0.251 | 0.248 | 0.247 | 0.251 | 0.254 |
|
||||
| Operating profit margin | 0.045 | 0.040 | 0.039 | 0.043 | 0.041 |
|
||||
| Pretax profit margin | 0.033 | 0.037 | 0.038 | 0.022 | 0.030 |
|
||||
| Net profit margin | 0.024 | 0.024 | 0.028 | 0.013 | 0.020 |
|
||||
| | 2022 | 2021 | 2020 | 2019 | 2018 |
|
||||
| :---------------------------- | :----- | :----- | :----- | :----- | :----- |
|
||||
| Period | FY | FY | FY | FY | FY |
|
||||
| Current ratio | 0.928 | 0.972 | 0.795 | 0.799 | 0.760 |
|
||||
| Quick ratio | 0.264 | 0.262 | 0.202 | 0.181 | 0.158 |
|
||||
| Cash ratio | 0.169 | 0.191 | 0.122 | 0.100 | 0.086 |
|
||||
| Days of sales outstanding | 5.277 | 4.253 | 4.378 | 4.458 | 4.095 |
|
||||
| Days of inventory outstanding | 48.080 | 39.034 | 41.101 | 41.937 | 42.799 |
|
||||
| Operating cycle | 53.357 | 43.287 | 45.479 | 46.395 | 46.894 |
|
||||
| Days of payables outstanding | 47.017 | 42.674 | 43.449 | 44.580 | 45.056 |
|
||||
| Cash conversion cycle | 6.340 | 0.613 | 2.030 | 1.814 | 1.838 |
|
||||
| Gross profit margin | 0.251 | 0.248 | 0.247 | 0.251 | 0.254 |
|
||||
| Operating profit margin | 0.045 | 0.040 | 0.039 | 0.043 | 0.041 |
|
||||
| Pretax profit margin | 0.033 | 0.037 | 0.038 | 0.022 | 0.030 |
|
||||
| Net profit margin | 0.024 | 0.024 | 0.028 | 0.013 | 0.020 |
|
||||
|
||||
...continued
|
||||
|
||||
Take just the ratio needed by filtering the index:
|
||||
@@ -380,8 +388,8 @@ ratios = openbb.stocks.fa.ratios(symbol = 'WMT', limit = 20)
|
||||
ratios.filter(like = 'Price earnings to growth ratio', axis = 0)
|
||||
```
|
||||
|
||||
| | 2022 | 2021 | 2020 | 2019 | 2018 | 2017 | 2016 | 2015 | 2014 | 2013 | 2012 | 2011 | 2010 | 2009 | 2008 | 2007 | 2006 | 2005 | 2004 | 2003 |
|
||||
|:-------------------------------|-------:|-------:|-------:|-------:|-------:|-------:|-------:|-------:|-------:|-------:|-------:|-------:|-------:|-------:|-------:|-------:|-------:|-------:|-------:|-------:|
|
||||
| Price earnings to growth ratio | 10.202 | -3.163 | 0.16 | -1.401 | -1.069 | -4.092 | -1.501 | 4.777 | -5.487 | 1.293 | 9.68 | 0.559 | 1.585 | 1.637 | 1.022 | 15.761 | 1.498 | 1.358 | 1.953 | 1.233 |
|
||||
| | 2022 | 2021 | 2020 | 2019 | 2018 | 2017 | 2016 | 2015 | 2014 | 2013 | 2012 | 2011 | 2010 | 2009 | 2008 | 2007 | 2006 | 2005 | 2004 | 2003 |
|
||||
| :----------------------------- | -----: | -----: | ---: | -----: | -----: | -----: | -----: | ----: | -----: | ----: | ---: | ----: | ----: | ----: | ----: | -----: | ----: | ----: | ----: | ----: |
|
||||
| Price earnings to growth ratio | 10.202 | -3.163 | 0.16 | -1.401 | -1.069 | -4.092 | -1.501 | 4.777 | -5.487 | 1.293 | 9.68 | 0.559 | 1.585 | 1.637 | 1.022 | 15.761 | 1.498 | 1.358 | 1.953 | 1.233 |
|
||||
|
||||
Be sure to check out the introduction guides for each sub-module as well.
|
||||
|
||||
111
website/content/sdk/guides/guides/ta.md
vendored
111
website/content/sdk/guides/guides/ta.md
vendored
@@ -14,45 +14,45 @@ The Technical Analysis module is a toolkit for analyzing time-series data, at an
|
||||
|
||||
## How to Use
|
||||
|
||||
Every SDK function also has a secondary `_chart` command. The table below is a brief description of each SDK function within the `ta` module; for simplicity, `_chart` has been ommitted. Technical Analysis functions specific to stocks are included as a sub-module, `openbb.stocks.ta`.
|
||||
Every SDK function also has a secondary `_chart` command. The table below is a brief description of each SDK function within the `ta` module; for simplicity, `_chart` has been omitted. Technical Analysis functions specific to stocks are included as a sub-module, `openbb.stocks.ta`.
|
||||
|
||||
|Path |Category |Description |
|
||||
|:----------|:----------:|------------------------------:|
|
||||
|openbb.ta.ad |Volume |Accumulation/Distribution Line |
|
||||
|openbb.ta.adosc |Volume |Chaikin Oscillator |
|
||||
|openbb.ta.adx |Trend |Average Directional Movement Index |
|
||||
|openbb.ta.aroon |Trend |Aroon Indicator |
|
||||
|openbb.ta.atr |Volatility |Average True Range |
|
||||
|openbb.ta.bbands |Voaltility |Bollinger Bands |
|
||||
|openbb.ta.cci |Momentum |Commodity Channel Index |
|
||||
|openbb.ta.cg |Momentum |Center of Gravity |
|
||||
|openbb.ta.clenow |Momentum |Clenow Volatility Adjusted Momentum |
|
||||
|openbb.ta.demark |Momentum |Tom Demark's Sequential Indicator (Unofficial) |
|
||||
|openbb.ta.donchian |Volatility |Donchian Channels |
|
||||
|openbb.ta.ema |Overlap |Exponential Moving Average |
|
||||
|openbb.ta.fib |Other |Fibonacci Retracement |
|
||||
|openbb.ta.fisher |Momentum |Fisher Transform |
|
||||
|openbb.ta.hma |Overlap |Hull Moving Average |
|
||||
|openbb.ta.kc |Volatility |Keltner Channnels |
|
||||
|openbb.ta.ma |Overlap |Moving Averages (For Charting) |
|
||||
|openbb.ta.macd |Momentum |Moving Average Convergence/Divergence |
|
||||
|openbb.ta.obv |Volume |On-Balance Volumne |
|
||||
|openbb.ta.rsi |Momentum |Relative Strength Index |
|
||||
|openbb.ta.sma |Overlap |Simple Moving Average |
|
||||
|openbb.ta.stoch |Momentum |Stochastic Oscillator |
|
||||
|openbb.ta.vwap |Overlap |Volume-Weighted Average Price |
|
||||
|openbb.ta.wma |Overlap |Weighted Moving Average |
|
||||
|openbb.ta.zlma |Overlap |Zero-Lag Moving Average |
|
||||
| Path | Category | Description |
|
||||
| :----------------- | :--------: | ---------------------------------------------: |
|
||||
| openbb.ta.ad | Volume | Accumulation/Distribution Line |
|
||||
| openbb.ta.adosc | Volume | Chaikin Oscillator |
|
||||
| openbb.ta.adx | Trend | Average Directional Movement Index |
|
||||
| openbb.ta.aroon | Trend | Aroon Indicator |
|
||||
| openbb.ta.atr | Volatility | Average True Range |
|
||||
| openbb.ta.bbands | Voaltility | Bollinger Bands |
|
||||
| openbb.ta.cci | Momentum | Commodity Channel Index |
|
||||
| openbb.ta.cg | Momentum | Center of Gravity |
|
||||
| openbb.ta.clenow | Momentum | Clenow Volatility Adjusted Momentum |
|
||||
| openbb.ta.demark | Momentum | Tom Demark's Sequential Indicator (Unofficial) |
|
||||
| openbb.ta.donchian | Volatility | Donchian Channels |
|
||||
| openbb.ta.ema | Overlap | Exponential Moving Average |
|
||||
| openbb.ta.fib | Other | Fibonacci Retracement |
|
||||
| openbb.ta.fisher | Momentum | Fisher Transform |
|
||||
| openbb.ta.hma | Overlap | Hull Moving Average |
|
||||
| openbb.ta.kc | Volatility | Keltner Channels |
|
||||
| openbb.ta.ma | Overlap | Moving Averages (For Charting) |
|
||||
| openbb.ta.macd | Momentum | Moving Average Convergence/Divergence |
|
||||
| openbb.ta.obv | Volume | On-Balance Volume |
|
||||
| openbb.ta.rsi | Momentum | Relative Strength Index |
|
||||
| openbb.ta.sma | Overlap | Simple Moving Average |
|
||||
| openbb.ta.stoch | Momentum | Stochastic Oscillator |
|
||||
| openbb.ta.vwap | Overlap | Volume-Weighted Average Price |
|
||||
| openbb.ta.wma | Overlap | Weighted Moving Average |
|
||||
| openbb.ta.zlma | Overlap | Zero-Lag Moving Average |
|
||||
|
||||
The syntax for the data argument can be:
|
||||
|
||||
- `data = ohlcv_df`
|
||||
|
||||
Where functions only require a single column, `data = ohlcv_df['Adj Close']`
|
||||
Where functions only require a single column, `data = ohlcv_df['Adj Close']`
|
||||
|
||||
- `data = openbb.stocks.load("ticker")`
|
||||
|
||||
Target intraday by adding the `interval` argument to the `load` syntax.
|
||||
Target intraday by adding the `interval` argument to the `load` syntax.
|
||||
|
||||
Best practice is to deploy the first method because the latter will work only with the commands requiring OHLC+V data as inputs. An error message will be returned if this is the case.
|
||||
|
||||
@@ -60,27 +60,28 @@ Best practice is to deploy the first method because the latter will work only wi
|
||||
openbb.ta.obv(data = openbb.stocks.load('QQQ'))
|
||||
```
|
||||
|
||||
| date | OBV |
|
||||
|:--------------------|------------------:|
|
||||
| 2019-11-15 00:00:00 | 1.84279e+07 |
|
||||
| 2019-11-18 00:00:00 | 3.67938e+07 |
|
||||
| 2019-11-19 00:00:00 | 5.37171e+07 |
|
||||
| 2019-11-20 00:00:00 | 1.70881e+07 |
|
||||
| 2022-11-15 00:00:00 | -1.09017e+08 |
|
||||
| 2022-11-16 00:00:00 | -1.57876e+08 |
|
||||
| 2022-11-17 00:00:00 | -2.13339e+08 |
|
||||
| 2022-11-18 00:00:00 | -1.59987e+08 |
|
||||
| date | OBV |
|
||||
| :------------------ | -----------: |
|
||||
| 2019-11-15 00:00:00 | 1.84279e+07 |
|
||||
| 2019-11-18 00:00:00 | 3.67938e+07 |
|
||||
| 2019-11-19 00:00:00 | 5.37171e+07 |
|
||||
| 2019-11-20 00:00:00 | 1.70881e+07 |
|
||||
| 2022-11-15 00:00:00 | -1.09017e+08 |
|
||||
| 2022-11-16 00:00:00 | -1.57876e+08 |
|
||||
| 2022-11-17 00:00:00 | -2.13339e+08 |
|
||||
| 2022-11-18 00:00:00 | -1.59987e+08 |
|
||||
|
||||
The error message:
|
||||
|
||||
```python
|
||||
openbb.ta.rsi(data = openbb.stocks.load('QQQ'))
|
||||
```
|
||||
|
||||
```console
|
||||
Please send a series and not a DataFrame.
|
||||
```
|
||||
|
||||
### _chart
|
||||
### \_chart
|
||||
|
||||
To display the chart, instead of raw data, add `_chart` to the syntax before the (`arguments`).
|
||||
|
||||
@@ -143,13 +144,13 @@ df_atr = openbb.ta.atr(data = openbb.stocks.load(f"{ticker}", start_date = f"{st
|
||||
df_atr.tail(5)
|
||||
```
|
||||
|
||||
| date | ATRe_6 |
|
||||
|:--------------------|---------:|
|
||||
| 2022-07-01 00:00:00 | 454.457 |
|
||||
| 2022-08-01 00:00:00 | 431.612 |
|
||||
| 2022-09-01 00:00:00 | 469.08 |
|
||||
| 2022-10-01 00:00:00 | 455.7 |
|
||||
| 2022-11-01 00:00:00 | 424.5 |
|
||||
| date | ATRe_6 |
|
||||
| :------------------ | ------: |
|
||||
| 2022-07-01 00:00:00 | 454.457 |
|
||||
| 2022-08-01 00:00:00 | 431.612 |
|
||||
| 2022-09-01 00:00:00 | 469.08 |
|
||||
| 2022-10-01 00:00:00 | 455.7 |
|
||||
| 2022-11-01 00:00:00 | 424.5 |
|
||||
|
||||
### Donchian
|
||||
|
||||
@@ -179,10 +180,10 @@ data_df = data_df.join(donchian)
|
||||
data_df.tail(5)
|
||||
```
|
||||
|
||||
| date | Open | High | Low | Close | Adj Close | Volume | DCL_20_20 | DCM_20_20 | DCU_20_20 |
|
||||
|:--------------------|--------:|--------:|--------:|--------:|------------:|------------:|------------:|------------:|------------:|
|
||||
| 2022-07-01 00:00:00 | 3782 | 4144 | 3723.75 | 4133.5 | 4133.5 | 3.40941e+07 | 3198 | 4003.12 | 4808.25 |
|
||||
| 2022-08-01 00:00:00 | 4137.5 | 4327.5 | 3953 | 3956.5 | 3956.5 | 3.84732e+07 | 3225 | 4016.62 | 4808.25 |
|
||||
| 2022-09-01 00:00:00 | 3958 | 4158 | 3595.25 | 3601.5 | 3601.5 | 4.68698e+07 | 3595.25 | 4201.75 | 4808.25 |
|
||||
| 2022-10-01 00:00:00 | 3593.25 | 3924.25 | 3502 | 3883 | 3883 | 4.80686e+07 | 3502 | 4155.12 | 4808.25 |
|
||||
| 2022-11-01 00:00:00 | 3884 | 4050.75 | 3704.25 | 3974 | 3974 | 2.65215e+07 | 3502 | 4155.12 | 4808.25 |
|
||||
| date | Open | High | Low | Close | Adj Close | Volume | DCL_20_20 | DCM_20_20 | DCU_20_20 |
|
||||
| :------------------ | ------: | ------: | ------: | -----: | --------: | ----------: | --------: | --------: | --------: |
|
||||
| 2022-07-01 00:00:00 | 3782 | 4144 | 3723.75 | 4133.5 | 4133.5 | 3.40941e+07 | 3198 | 4003.12 | 4808.25 |
|
||||
| 2022-08-01 00:00:00 | 4137.5 | 4327.5 | 3953 | 3956.5 | 3956.5 | 3.84732e+07 | 3225 | 4016.62 | 4808.25 |
|
||||
| 2022-09-01 00:00:00 | 3958 | 4158 | 3595.25 | 3601.5 | 3601.5 | 4.68698e+07 | 3595.25 | 4201.75 | 4808.25 |
|
||||
| 2022-10-01 00:00:00 | 3593.25 | 3924.25 | 3502 | 3883 | 3883 | 4.80686e+07 | 3502 | 4155.12 | 4808.25 |
|
||||
| 2022-11-01 00:00:00 | 3884 | 4050.75 | 3704.25 | 3974 | 3974 | 2.65215e+07 | 3502 | 4155.12 | 4808.25 |
|
||||
|
||||
42
website/content/sdk/quickstart/requirements.md
vendored
42
website/content/sdk/quickstart/requirements.md
vendored
@@ -15,23 +15,22 @@ The OpenBB SDK is a set of tools for financial and data analysis. We recommend s
|
||||
- 5GB free storage
|
||||
- A code editor, such as VS Code, with some extensions:
|
||||
|
||||
- Jupyter
|
||||
- Jupyter Power Toys
|
||||
- Python Environment Manager
|
||||
- Python Extension Pack
|
||||
- mplstyle
|
||||
- Jupyter
|
||||
- Jupyter Power Toys
|
||||
- Python Environment Manager
|
||||
- Python Extension Pack
|
||||
- mplstyle
|
||||
|
||||
- Chrome or Firefox
|
||||
- Open Office
|
||||
|
||||
### Minumum System Requirements
|
||||
### Minimum System Requirements
|
||||
|
||||
- 8GB RAM or more
|
||||
- 5GB free storage
|
||||
- A code editor, such as VS Code
|
||||
- Chrome or Firefox
|
||||
|
||||
|
||||
:::info OS Specific Requirements
|
||||
|
||||
<Tabs>
|
||||
@@ -47,9 +46,10 @@ The OpenBB SDK is a set of tools for financial and data analysis. We recommend s
|
||||
<TabItem value="Windows" label="Windows">
|
||||
<div class="gdoc-page">
|
||||
|
||||
</div><p>Windows 10 or higher is required, and the user account should be have administrator priviliges.
|
||||
</div><p>Windows 10 or higher is required, and the user account should be have administrator privileges.
|
||||
|
||||
Additionally, its recommended Windows users also install [Git for Windows](https://git-scm.com/download/win) and use `Git Bash` as the terminal application instead of CMD or PowerShell.
|
||||
|
||||
Additionaly, its reccomended Windows users also install [Git for Windows](https://git-scm.com/download/win) and use `Git Bash` as the terminal application instead of CMD or PowerShell.
|
||||
</p>
|
||||
<div class="gdoc-columns">
|
||||
|
||||
@@ -78,7 +78,7 @@ Virtual Python environments are containers for Python applications, and allows t
|
||||
|
||||
- Miniconda3 is installed and the version is specifically x86/x64 architecture, regardless of the CPU-type.
|
||||
- CMake must be installed within the environment created for the OpenBB installation.
|
||||
- `conda install -c conda-forge cmake`
|
||||
- `conda install -c conda-forge cmake`
|
||||
|
||||
It is not recommended to install in a Global environment, such as Homebrew or `usr/local/bin/python3`. Create and activate a new environment before installing the OpenBB SDK.
|
||||
|
||||
@@ -98,9 +98,10 @@ A good way to learn about the Python language is to recognize the libraries whic
|
||||
- URLlib3
|
||||
|
||||
The best way to learn is to get involved. Tinkering with the code from an open-source project is an excellent way to dabble.
|
||||
|
||||
### GitHub
|
||||
|
||||
[GitHub](https://github.com/OpenBB-finance/OpenBBTerminal) is where the OpenBB source code is maintained. Cloning the [repository](https://github.com/OpenBB-finance/OpenBBTerminal.git) is recommended for those wishing to develop functions, inspect the source code, or be on the bleeding-edge of development. Syncing the local folder - `git pull` - to the main branch of the repository will keep the installation up-to-date, and `git checkout` provides a way to test development or contributor branchs. GitHub can also be used as a personal storage vault and take advantage of automated actions. It's a great place to build, store, and maintain small databases for free.
|
||||
[GitHub](https://github.com/OpenBB-finance/OpenBBTerminal) is where the OpenBB source code is maintained. Cloning the [repository](https://github.com/OpenBB-finance/OpenBBTerminal.git) is recommended for those wishing to develop functions, inspect the source code, or be on the bleeding-edge of development. Syncing the local folder - `git pull` - to the main branch of the repository will keep the installation up-to-date, and `git checkout` provides a way to test development or contributor branches. GitHub can also be used as a personal storage vault and take advantage of automated actions. It's a great place to build, store, and maintain small databases for free.
|
||||
|
||||
Users encountering bugs are encouraged to report them [here](https://github.com/OpenBB-finance/OpenBBTerminal/issues/new/choose) by creating a new issue, if no open issue for the bug already exists.
|
||||
|
||||
@@ -113,16 +114,16 @@ For example:
|
||||
```
|
||||
openbb.economy.ycrv()
|
||||
```
|
||||
| | Maturity | Rate |
|
||||
|---:|-----------:|-------:|
|
||||
| 0 | 0.0833333 | 3.93 |
|
||||
| 1 | 0.25 | 4.34 |
|
||||
| 2 | 0.5 | 4.61 |
|
||||
| ...| ... | ... |
|
||||
| 8 | 10 | 3.82 |
|
||||
| 9 | 20 | 4.13 |
|
||||
| 10 | 30 | 3.92 |
|
||||
|
||||
| | Maturity | Rate |
|
||||
| --: | --------: | ---: |
|
||||
| 0 | 0.0833333 | 3.93 |
|
||||
| 1 | 0.25 | 4.34 |
|
||||
| 2 | 0.5 | 4.61 |
|
||||
| ... | ... | ... |
|
||||
| 8 | 10 | 3.82 |
|
||||
| 9 | 20 | 4.13 |
|
||||
| 10 | 30 | 3.92 |
|
||||
|
||||
Then the view:
|
||||
|
||||
@@ -137,6 +138,7 @@ Users should have some experience working with Python and be comfortable working
|
||||
- [Python.org](https://www.python.org/about/gettingstarted/)
|
||||
- [W3 Schools](https://www.w3schools.com/python/)
|
||||
- [Python Wiki](https://wiki.python.org/moin/BeginnersGuide)
|
||||
|
||||
## Resources for Finance
|
||||
|
||||
Below is a collection of useful websites:
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
{
|
||||
"label": "Terminal Reference",
|
||||
"position": 4
|
||||
{
|
||||
"label": "Terminal Reference",
|
||||
"position": 4
|
||||
}
|
||||
@@ -1,23 +1,23 @@
|
||||
---
|
||||
title: cases
|
||||
description: OpenBB Terminal Function
|
||||
---
|
||||
|
||||
# cases
|
||||
|
||||
Show historical cases for country.
|
||||
|
||||
### Usage
|
||||
|
||||
```python
|
||||
usage: cases
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Parameters
|
||||
|
||||
This command has no parameters
|
||||
|
||||
---
|
||||
|
||||
---
|
||||
title: cases
|
||||
description: OpenBB Terminal Function
|
||||
---
|
||||
|
||||
# cases
|
||||
|
||||
Show historical cases for country.
|
||||
|
||||
### Usage
|
||||
|
||||
```python
|
||||
usage: cases
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Parameters
|
||||
|
||||
This command has no parameters
|
||||
|
||||
---
|
||||
|
||||
|
||||
@@ -1,24 +1,24 @@
|
||||
---
|
||||
title: country
|
||||
description: OpenBB Terminal Function
|
||||
---
|
||||
|
||||
# country
|
||||
|
||||
Select a country to look at data for.
|
||||
|
||||
### Usage
|
||||
|
||||
```python
|
||||
usage: country [-c country_name]
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Parameters
|
||||
|
||||
| Name | Description | Default | Optional | Choices |
|
||||
| ---- | ----------- | ------- | -------- | ------- |
|
||||
| country | Country to get data for. | None | True | suriname, qatar, romania, cabo_verde, malawi, micronesia, belarus, denmark, fiji, cambodia, madagascar, saint_vincent_and_the_grenadines, paraguay, eritrea, barbados, ethiopia, laos, zimbabwe, lithuania, comoros, namibia, spain, papua_new_guinea, central_african_republic, honduras, equatorial_guinea, botswana, canada, italy, jordan, chad, czechia, uzbekistan, azerbaijan, poland, us, el_salvador, ghana, kiribati, kuwait, senegal, holy_see, mauritius, oman, sierra_leone, zambia, nigeria, kosovo, brunei, china, gabon, seychelles, guatemala, somalia, peru, sao_tome_and_principe, sweden, pakistan, moldova, togo, niger, ukraine, sudan, trinidad_and_tobago, netherlands, philippines, australia, burkina_faso, tajikistan, united_arab_emirates, kyrgyzstan, costa_rica, portugal, mozambique, mauritania, timor-leste, vietnam, montenegro, guyana, mongolia, bahrain, cameroon, palau, jamaica, new_zealand, iraq, mali, saint_kitts_and_nevis, brazil, belgium, maldives, egypt, panama, rwanda, israel, russia, nicaragua, switzerland, kazakhstan, guinea-bissau, albania, thailand, cuba, uruguay, liechtenstein, bosnia_and_herzegovina, haiti, andorra, taiwan*, dominica, congo_(kinshasa), ecuador, malta, vanuatu, dominican_republic, lesotho, morocco, west_bank_and_gaza, lebanon, south_sudan, armenia, afghanistan, grenada, indonesia, sri_lanka, iran, bolivia, luxembourg, north_macedonia, cyprus, iceland, serbia, greece, united_kingdom, georgia, saint_lucia, venezuela, austria, tonga, saudi_arabia, argentina, summer_olympics_2020, angola, algeria, latvia, yemen, singapore, turkey, belize, burundi, ireland, south_africa, bulgaria, india, diamond_princess, cote_d'ivoire, libya, slovenia, benin, djibouti, congo_(brazzaville), tunisia, nepal, bahamas, bhutan, colombia, hungary, malaysia, germany, tanzania, samoa, san_marino, syria, liberia, korea,_south, uganda, gambia, marshall_islands, kenya, finland, bangladesh, eswatini, slovakia, burma, ms_zaandam, japan, guinea, monaco, mexico, solomon_islands, estonia, chile, croatia, antigua_and_barbuda, norway, france, all |
|
||||
---
|
||||
|
||||
---
|
||||
title: country
|
||||
description: OpenBB Terminal Function
|
||||
---
|
||||
|
||||
# country
|
||||
|
||||
Select a country to look at data for.
|
||||
|
||||
### Usage
|
||||
|
||||
```python
|
||||
usage: country [-c country_name]
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Parameters
|
||||
|
||||
| Name | Description | Default | Optional | Choices |
|
||||
| ---- | ----------- | ------- | -------- | ------- |
|
||||
| country | Country to get data for. | None | True | suriname, qatar, romania, cabo_verde, malawi, micronesia, belarus, denmark, fiji, cambodia, madagascar, saint_vincent_and_the_grenadines, paraguay, eritrea, barbados, ethiopia, laos, zimbabwe, lithuania, comoros, namibia, spain, papua_new_guinea, central_african_republic, honduras, equatorial_guinea, botswana, canada, italy, jordan, chad, czechia, uzbekistan, azerbaijan, poland, us, el_salvador, ghana, kiribati, kuwait, senegal, holy_see, mauritius, oman, sierra_leone, zambia, nigeria, kosovo, brunei, china, gabon, seychelles, guatemala, somalia, peru, sao_tome_and_principe, sweden, pakistan, moldova, togo, niger, ukraine, sudan, trinidad_and_tobago, netherlands, philippines, australia, burkina_faso, tajikistan, united_arab_emirates, kyrgyzstan, costa_rica, portugal, mozambique, mauritania, timor-leste, vietnam, montenegro, guyana, mongolia, bahrain, cameroon, palau, jamaica, new_zealand, iraq, mali, saint_kitts_and_nevis, brazil, belgium, maldives, egypt, panama, rwanda, israel, russia, nicaragua, switzerland, kazakhstan, guinea-bissau, albania, thailand, cuba, uruguay, liechtenstein, bosnia_and_herzegovina, haiti, andorra, taiwan*, dominica, congo_(kinshasa), ecuador, malta, vanuatu, dominican_republic, lesotho, morocco, west_bank_and_gaza, lebanon, south_sudan, armenia, afghanistan, grenada, indonesia, sri_lanka, iran, bolivia, luxembourg, north_macedonia, cyprus, iceland, serbia, greece, united_kingdom, georgia, saint_lucia, venezuela, austria, tonga, saudi_arabia, argentina, summer_olympics_2020, angola, algeria, latvia, yemen, singapore, turkey, belize, burundi, ireland, south_africa, bulgaria, india, diamond_princess, cote_d'ivoire, libya, slovenia, benin, djibouti, congo_(brazzaville), tunisia, nepal, bahamas, bhutan, colombia, hungary, malaysia, germany, tanzania, samoa, san_marino, syria, liberia, korea,_south, uganda, gambia, marshall_islands, kenya, finland, bangladesh, eswatini, slovakia, burma, ms_zaandam, japan, guinea, monaco, mexico, solomon_islands, estonia, chile, croatia, antigua_and_barbuda, norway, france, all |
|
||||
---
|
||||
|
||||
|
||||
@@ -1,23 +1,23 @@
|
||||
---
|
||||
title: deaths
|
||||
description: OpenBB Terminal Function
|
||||
---
|
||||
|
||||
# deaths
|
||||
|
||||
Show historical deaths by country.
|
||||
|
||||
### Usage
|
||||
|
||||
```python
|
||||
usage: deaths
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Parameters
|
||||
|
||||
This command has no parameters
|
||||
|
||||
---
|
||||
|
||||
---
|
||||
title: deaths
|
||||
description: OpenBB Terminal Function
|
||||
---
|
||||
|
||||
# deaths
|
||||
|
||||
Show historical deaths by country.
|
||||
|
||||
### Usage
|
||||
|
||||
```python
|
||||
usage: deaths
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Parameters
|
||||
|
||||
This command has no parameters
|
||||
|
||||
---
|
||||
|
||||
|
||||
@@ -1,23 +1,23 @@
|
||||
---
|
||||
title: ov
|
||||
description: OpenBB Terminal Function
|
||||
---
|
||||
|
||||
# ov
|
||||
|
||||
Show historical cases and deaths by country.
|
||||
|
||||
### Usage
|
||||
|
||||
```python
|
||||
usage: ov
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Parameters
|
||||
|
||||
This command has no parameters
|
||||
|
||||
---
|
||||
|
||||
---
|
||||
title: ov
|
||||
description: OpenBB Terminal Function
|
||||
---
|
||||
|
||||
# ov
|
||||
|
||||
Show historical cases and deaths by country.
|
||||
|
||||
### Usage
|
||||
|
||||
```python
|
||||
usage: ov
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Parameters
|
||||
|
||||
This command has no parameters
|
||||
|
||||
---
|
||||
|
||||
|
||||
@@ -1,23 +1,23 @@
|
||||
---
|
||||
title: rates
|
||||
description: OpenBB Terminal Function
|
||||
---
|
||||
|
||||
# rates
|
||||
|
||||
Show historical death/cases rates for a country.
|
||||
|
||||
### Usage
|
||||
|
||||
```python
|
||||
usage: rates
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Parameters
|
||||
|
||||
This command has no parameters
|
||||
|
||||
---
|
||||
|
||||
---
|
||||
title: rates
|
||||
description: OpenBB Terminal Function
|
||||
---
|
||||
|
||||
# rates
|
||||
|
||||
Show historical death/cases rates for a country.
|
||||
|
||||
### Usage
|
||||
|
||||
```python
|
||||
usage: rates
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Parameters
|
||||
|
||||
This command has no parameters
|
||||
|
||||
---
|
||||
|
||||
|
||||
@@ -1,26 +1,26 @@
|
||||
---
|
||||
title: slopes
|
||||
description: OpenBB Terminal Function
|
||||
---
|
||||
|
||||
# slopes
|
||||
|
||||
Show countries with highest slopes.
|
||||
|
||||
### Usage
|
||||
|
||||
```python
|
||||
usage: slopes [-d DAYS] [-r] [-t THRESHOLD]
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Parameters
|
||||
|
||||
| Name | Description | Default | Optional | Choices |
|
||||
| ---- | ----------- | ------- | -------- | ------- |
|
||||
| days | Number of days back to look | 30 | True | None |
|
||||
| reverse | Data is sorted in descending order by default. Reverse flag will sort it in an ascending way. Only works when raw data is displayed. | False | True | None |
|
||||
| threshold | Threshold for total cases over period | 10000 | True | None |
|
||||
---
|
||||
|
||||
---
|
||||
title: slopes
|
||||
description: OpenBB Terminal Function
|
||||
---
|
||||
|
||||
# slopes
|
||||
|
||||
Show countries with highest slopes.
|
||||
|
||||
### Usage
|
||||
|
||||
```python
|
||||
usage: slopes [-d DAYS] [-r] [-t THRESHOLD]
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Parameters
|
||||
|
||||
| Name | Description | Default | Optional | Choices |
|
||||
| ---- | ----------- | ------- | -------- | ------- |
|
||||
| days | Number of days back to look | 30 | True | None |
|
||||
| reverse | Data is sorted in descending order by default. Reverse flag will sort it in an ascending way. Only works when raw data is displayed. | False | True | None |
|
||||
| threshold | Threshold for total cases over period | 10000 | True | None |
|
||||
---
|
||||
|
||||
|
||||
@@ -1,28 +1,28 @@
|
||||
---
|
||||
title: rossidx
|
||||
description: OpenBB Terminal Function
|
||||
---
|
||||
|
||||
# rossidx
|
||||
|
||||
Display list of startups from ross index [Source: https://runacap.com/] Use --chart to display chart and -t {stars,forks} to set chart type
|
||||
|
||||
### Usage
|
||||
|
||||
```python
|
||||
usage: rossidx [-s SORTBY [SORTBY ...]] [-r] [-c] [-g] [-t {stars,forks}]
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Parameters
|
||||
|
||||
| Name | Description | Default | Optional | Choices |
|
||||
| ---- | ----------- | ------- | -------- | ------- |
|
||||
| sortby | Sort startups by column | Stars AGR [%] | True | GitHub, Company, Country, City, Founded, Raised [$M], Stars, Forks, Stars AGR [%], Forks AGR [%] |
|
||||
| reverse | Data is sorted in descending order by default. Reverse flag will sort it in an ascending way. Only works when raw data is displayed. | False | True | None |
|
||||
| show_chart | Flag to show chart | False | True | None |
|
||||
| show_growth | Flag to show growth chart | False | True | None |
|
||||
| chart_type | Chart type: {stars, forks} | stars | True | stars, forks |
|
||||
---
|
||||
|
||||
---
|
||||
title: rossidx
|
||||
description: OpenBB Terminal Function
|
||||
---
|
||||
|
||||
# rossidx
|
||||
|
||||
Display list of startups from ross index [Source: https://runacap.com/] Use --chart to display chart and -t {stars,forks} to set chart type
|
||||
|
||||
### Usage
|
||||
|
||||
```python
|
||||
usage: rossidx [-s SORTBY [SORTBY ...]] [-r] [-c] [-g] [-t {stars,forks}]
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Parameters
|
||||
|
||||
| Name | Description | Default | Optional | Choices |
|
||||
| ---- | ----------- | ------- | -------- | ------- |
|
||||
| sortby | Sort startups by column | Stars AGR [%] | True | GitHub, Company, Country, City, Founded, Raised [$M], Stars, Forks, Stars AGR [%], Forks AGR [%] |
|
||||
| reverse | Data is sorted in descending order by default. Reverse flag will sort it in an ascending way. Only works when raw data is displayed. | False | True | None |
|
||||
| show_chart | Flag to show chart | False | True | None |
|
||||
| show_growth | Flag to show growth chart | False | True | None |
|
||||
| chart_type | Chart type: {stars, forks} | stars | True | stars, forks |
|
||||
---
|
||||
|
||||
|
||||
@@ -1,24 +1,24 @@
|
||||
---
|
||||
title: rs
|
||||
description: OpenBB Terminal Function
|
||||
---
|
||||
|
||||
# rs
|
||||
|
||||
Display a repo summary [Source: https://api.github.com]
|
||||
|
||||
### Usage
|
||||
|
||||
```python
|
||||
usage: rs -r REPO
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Parameters
|
||||
|
||||
| Name | Description | Default | Optional | Choices |
|
||||
| ---- | ----------- | ------- | -------- | ------- |
|
||||
| repo | Repository to search for repo summary. Format: org/repo, e.g., openbb-finance/openbbterminal | None | False | None |
|
||||
---
|
||||
|
||||
---
|
||||
title: rs
|
||||
description: OpenBB Terminal Function
|
||||
---
|
||||
|
||||
# rs
|
||||
|
||||
Display a repo summary [Source: https://api.github.com]
|
||||
|
||||
### Usage
|
||||
|
||||
```python
|
||||
usage: rs -r REPO
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Parameters
|
||||
|
||||
| Name | Description | Default | Optional | Choices |
|
||||
| ---- | ----------- | ------- | -------- | ------- |
|
||||
| repo | Repository to search for repo summary. Format: org/repo, e.g., openbb-finance/openbbterminal | None | False | None |
|
||||
---
|
||||
|
||||
|
||||
@@ -1,24 +1,24 @@
|
||||
---
|
||||
title: sh
|
||||
description: OpenBB Terminal Function
|
||||
---
|
||||
|
||||
# sh
|
||||
|
||||
Display a repo star history [Source: https://api.github.com]
|
||||
|
||||
### Usage
|
||||
|
||||
```python
|
||||
usage: sh -r REPO
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Parameters
|
||||
|
||||
| Name | Description | Default | Optional | Choices |
|
||||
| ---- | ----------- | ------- | -------- | ------- |
|
||||
| repo | Repository to search for star history. Format: org/repo, e.g., openbb-finance/openbbterminal | None | False | None |
|
||||
---
|
||||
|
||||
---
|
||||
title: sh
|
||||
description: OpenBB Terminal Function
|
||||
---
|
||||
|
||||
# sh
|
||||
|
||||
Display a repo star history [Source: https://api.github.com]
|
||||
|
||||
### Usage
|
||||
|
||||
```python
|
||||
usage: sh -r REPO
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Parameters
|
||||
|
||||
| Name | Description | Default | Optional | Choices |
|
||||
| ---- | ----------- | ------- | -------- | ------- |
|
||||
| repo | Repository to search for star history. Format: org/repo, e.g., openbb-finance/openbbterminal | None | False | None |
|
||||
---
|
||||
|
||||
|
||||
@@ -1,25 +1,25 @@
|
||||
---
|
||||
title: tr
|
||||
description: OpenBB Terminal Function
|
||||
---
|
||||
|
||||
# tr
|
||||
|
||||
Display top repositories [Source: https://api.github.com]
|
||||
|
||||
### Usage
|
||||
|
||||
```python
|
||||
usage: tr [-s {stars,forks}] [-c CATEGORIES]
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Parameters
|
||||
|
||||
| Name | Description | Default | Optional | Choices |
|
||||
| ---- | ----------- | ------- | -------- | ------- |
|
||||
| sortby | Sort repos by {stars, forks}. Default: stars | stars | True | stars, forks |
|
||||
| categories | Filter by repo categories. If more than one separate with a comma: e.g., finance,investment | | True | None |
|
||||
---
|
||||
|
||||
---
|
||||
title: tr
|
||||
description: OpenBB Terminal Function
|
||||
---
|
||||
|
||||
# tr
|
||||
|
||||
Display top repositories [Source: https://api.github.com]
|
||||
|
||||
### Usage
|
||||
|
||||
```python
|
||||
usage: tr [-s {stars,forks}] [-c CATEGORIES]
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Parameters
|
||||
|
||||
| Name | Description | Default | Optional | Choices |
|
||||
| ---- | ----------- | ------- | -------- | ------- |
|
||||
| sortby | Sort repos by {stars, forks}. Default: stars | stars | True | stars, forks |
|
||||
| categories | Filter by repo categories. If more than one separate with a comma: e.g., finance,investment | | True | None |
|
||||
---
|
||||
|
||||
|
||||
@@ -1,24 +1,24 @@
|
||||
---
|
||||
title: candle
|
||||
description: OpenBB Terminal Function
|
||||
---
|
||||
|
||||
# candle
|
||||
|
||||
Display chart for loaded coin. You can specify currency vs which you want to show chart and also number of days to get data for.
|
||||
|
||||
### Usage
|
||||
|
||||
```python
|
||||
usage: candle [--log]
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Parameters
|
||||
|
||||
| Name | Description | Default | Optional | Choices |
|
||||
| ---- | ----------- | ------- | -------- | ------- |
|
||||
| logy | Plot with y axis on log scale | False | True | None |
|
||||
---
|
||||
|
||||
---
|
||||
title: candle
|
||||
description: OpenBB Terminal Function
|
||||
---
|
||||
|
||||
# candle
|
||||
|
||||
Display chart for loaded coin. You can specify currency vs which you want to show chart and also number of days to get data for.
|
||||
|
||||
### Usage
|
||||
|
||||
```python
|
||||
usage: candle [--log]
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Parameters
|
||||
|
||||
| Name | Description | Default | Optional | Choices |
|
||||
| ---- | ----------- | ------- | -------- | ------- |
|
||||
| logy | Plot with y axis on log scale | False | True | None |
|
||||
---
|
||||
|
||||
|
||||
@@ -1,25 +1,25 @@
|
||||
---
|
||||
title: anchor
|
||||
description: OpenBB Terminal Function
|
||||
---
|
||||
|
||||
# anchor
|
||||
|
||||
Displays anchor protocol earnings data of a certain terra address --transactions flag can be passed to show history of previous transactions [Source: https://cryptosaurio.com/]
|
||||
|
||||
### Usage
|
||||
|
||||
```python
|
||||
usage: anchor --address ADDRESS [--transactions]
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Parameters
|
||||
|
||||
| Name | Description | Default | Optional | Choices |
|
||||
| ---- | ----------- | ------- | -------- | ------- |
|
||||
| address | Terra address. Valid terra addresses start with 'terra' | None | False | None |
|
||||
| transactions | Flag to show transactions history in anchor earn | False | True | None |
|
||||
---
|
||||
|
||||
---
|
||||
title: anchor
|
||||
description: OpenBB Terminal Function
|
||||
---
|
||||
|
||||
# anchor
|
||||
|
||||
Displays anchor protocol earnings data of a certain terra address --transactions flag can be passed to show history of previous transactions [Source: https://cryptosaurio.com/]
|
||||
|
||||
### Usage
|
||||
|
||||
```python
|
||||
usage: anchor --address ADDRESS [--transactions]
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Parameters
|
||||
|
||||
| Name | Description | Default | Optional | Choices |
|
||||
| ---- | ----------- | ------- | -------- | ------- |
|
||||
| address | Terra address. Valid terra addresses start with 'terra' | None | False | None |
|
||||
| transactions | Flag to show transactions history in anchor earn | False | True | None |
|
||||
---
|
||||
|
||||
|
||||
@@ -1,24 +1,24 @@
|
||||
---
|
||||
title: dtvl
|
||||
description: OpenBB Terminal Function
|
||||
---
|
||||
|
||||
# dtvl
|
||||
|
||||
Displays historical TVL of different dApps. [Source: https://docs.llama.fi/api]
|
||||
|
||||
### Usage
|
||||
|
||||
```python
|
||||
usage: dtvl -d DAPPS
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Parameters
|
||||
|
||||
| Name | Description | Default | Optional | Choices |
|
||||
| ---- | ----------- | ------- | -------- | ------- |
|
||||
| dapps | dApps to search historical TVL. Should be split by , e.g.: anchor,sushiswap,pancakeswap | None | False | None |
|
||||
---
|
||||
|
||||
---
|
||||
title: dtvl
|
||||
description: OpenBB Terminal Function
|
||||
---
|
||||
|
||||
# dtvl
|
||||
|
||||
Displays historical TVL of different dApps. [Source: https://docs.llama.fi/api]
|
||||
|
||||
### Usage
|
||||
|
||||
```python
|
||||
usage: dtvl -d DAPPS
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Parameters
|
||||
|
||||
| Name | Description | Default | Optional | Choices |
|
||||
| ---- | ----------- | ------- | -------- | ------- |
|
||||
| dapps | dApps to search historical TVL. Should be split by , e.g.: anchor,sushiswap,pancakeswap | None | False | None |
|
||||
---
|
||||
|
||||
|
||||
@@ -1,26 +1,26 @@
|
||||
---
|
||||
title: gacc
|
||||
description: OpenBB Terminal Function
|
||||
---
|
||||
|
||||
# gacc
|
||||
|
||||
Displays terra blockchain account growth history. [Source: https://fcd.terra.dev/swagger]
|
||||
|
||||
### Usage
|
||||
|
||||
```python
|
||||
usage: gacc [-l LIMIT] [--cumulative] [-k {active,total}]
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Parameters
|
||||
|
||||
| Name | Description | Default | Optional | Choices |
|
||||
| ---- | ----------- | ------- | -------- | ------- |
|
||||
| limit | Number of days to show | 90 | True | None |
|
||||
| cumulative | Show cumulative or discrete values. For active accounts only discrete value are available | True | True | None |
|
||||
| kind | Total account count or active account count. Default: total | total | True | active, total |
|
||||
---
|
||||
|
||||
---
|
||||
title: gacc
|
||||
description: OpenBB Terminal Function
|
||||
---
|
||||
|
||||
# gacc
|
||||
|
||||
Displays terra blockchain account growth history. [Source: https://fcd.terra.dev/swagger]
|
||||
|
||||
### Usage
|
||||
|
||||
```python
|
||||
usage: gacc [-l LIMIT] [--cumulative] [-k {active,total}]
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Parameters
|
||||
|
||||
| Name | Description | Default | Optional | Choices |
|
||||
| ---- | ----------- | ------- | -------- | ------- |
|
||||
| limit | Number of days to show | 90 | True | None |
|
||||
| cumulative | Show cumulative or discrete values. For active accounts only discrete value are available | True | True | None |
|
||||
| kind | Total account count or active account count. Default: total | total | True | active, total |
|
||||
---
|
||||
|
||||
|
||||
@@ -1,24 +1,24 @@
|
||||
---
|
||||
title: gdapps
|
||||
description: OpenBB Terminal Function
|
||||
---
|
||||
|
||||
# gdapps
|
||||
|
||||
Display top dApps (in terms of TVL) grouped by chain. [Source: https://docs.llama.fi/api]
|
||||
|
||||
### Usage
|
||||
|
||||
```python
|
||||
usage: gdapps [-l LIMIT]
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Parameters
|
||||
|
||||
| Name | Description | Default | Optional | Choices |
|
||||
| ---- | ----------- | ------- | -------- | ------- |
|
||||
| limit | Number of top dApps to display | 40 | True | None |
|
||||
---
|
||||
|
||||
---
|
||||
title: gdapps
|
||||
description: OpenBB Terminal Function
|
||||
---
|
||||
|
||||
# gdapps
|
||||
|
||||
Display top dApps (in terms of TVL) grouped by chain. [Source: https://docs.llama.fi/api]
|
||||
|
||||
### Usage
|
||||
|
||||
```python
|
||||
usage: gdapps [-l LIMIT]
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Parameters
|
||||
|
||||
| Name | Description | Default | Optional | Choices |
|
||||
| ---- | ----------- | ------- | -------- | ------- |
|
||||
| limit | Number of top dApps to display | 40 | True | None |
|
||||
---
|
||||
|
||||
|
||||
@@ -1,24 +1,24 @@
|
||||
---
|
||||
title: lcsc
|
||||
description: OpenBB Terminal Function
|
||||
---
|
||||
|
||||
# lcsc
|
||||
|
||||
Display Luna circulating supply changes stats. [Source: Smartstake.io] Follow these steps to get the key token: 1. Head to https://terra.smartstake.io/ 2. Right click on your browser and choose Inspect 3. Select Network tab (by clicking on the expand button next to Source tab) 4. Go to Fetch/XHR tab, and refresh the page 5. Get the option looks similar to the following: `listData?type=history&dayCount=30` 6. Extract the key and token out of the URL
|
||||
|
||||
### Usage
|
||||
|
||||
```python
|
||||
usage: lcsc [-d DAYS]
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Parameters
|
||||
|
||||
| Name | Description | Default | Optional | Choices |
|
||||
| ---- | ----------- | ------- | -------- | ------- |
|
||||
| days | Number of days to display. Default: 30 days | 30 | True | range(1, 1000) |
|
||||
---
|
||||
|
||||
---
|
||||
title: lcsc
|
||||
description: OpenBB Terminal Function
|
||||
---
|
||||
|
||||
# lcsc
|
||||
|
||||
Display Luna circulating supply changes stats. [Source: Smartstake.io] Follow these steps to get the key token: 1. Head to https://terra.smartstake.io/ 2. Right click on your browser and choose Inspect 3. Select Network tab (by clicking on the expand button next to Source tab) 4. Go to Fetch/XHR tab, and refresh the page 5. Get the option looks similar to the following: `listData?type=history&dayCount=30` 6. Extract the key and token out of the URL
|
||||
|
||||
### Usage
|
||||
|
||||
```python
|
||||
usage: lcsc [-d DAYS]
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Parameters
|
||||
|
||||
| Name | Description | Default | Optional | Choices |
|
||||
| ---- | ----------- | ------- | -------- | ------- |
|
||||
| days | Number of days to display. Default: 30 days | 30 | True | range(1, 1000) |
|
||||
---
|
||||
|
||||
|
||||
@@ -1,27 +1,27 @@
|
||||
---
|
||||
title: ldapps
|
||||
description: OpenBB Terminal Function
|
||||
---
|
||||
|
||||
# ldapps
|
||||
|
||||
Display information about listed dApps on DeFi Llama. [Source: https://docs.llama.fi/api]
|
||||
|
||||
### Usage
|
||||
|
||||
```python
|
||||
usage: ldapps [-l LIMIT] [-s {tvl,symbol,category,chains,change_1h,change_1d,change_7d,name}] [-r] [--desc]
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Parameters
|
||||
|
||||
| Name | Description | Default | Optional | Choices |
|
||||
| ---- | ----------- | ------- | -------- | ------- |
|
||||
| limit | Number of records to display | 10 | True | None |
|
||||
| sortby | Sort by given column. Default: tvl | tvl | True | tvl, symbol, category, chains, change_1h, change_1d, change_7d, name |
|
||||
| reverse | Data is sorted in descending order by default. Reverse flag will sort it in an ascending way. Only works when raw data is displayed. | False | True | None |
|
||||
| description | Flag to display description of protocol | False | True | None |
|
||||
---
|
||||
|
||||
---
|
||||
title: ldapps
|
||||
description: OpenBB Terminal Function
|
||||
---
|
||||
|
||||
# ldapps
|
||||
|
||||
Display information about listed dApps on DeFi Llama. [Source: https://docs.llama.fi/api]
|
||||
|
||||
### Usage
|
||||
|
||||
```python
|
||||
usage: ldapps [-l LIMIT] [-s {tvl,symbol,category,chains,change_1h,change_1d,change_7d,name}] [-r] [--desc]
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Parameters
|
||||
|
||||
| Name | Description | Default | Optional | Choices |
|
||||
| ---- | ----------- | ------- | -------- | ------- |
|
||||
| limit | Number of records to display | 10 | True | None |
|
||||
| sortby | Sort by given column. Default: tvl | tvl | True | tvl, symbol, category, chains, change_1h, change_1d, change_7d, name |
|
||||
| reverse | Data is sorted in descending order by default. Reverse flag will sort it in an ascending way. Only works when raw data is displayed. | False | True | None |
|
||||
| description | Flag to display description of protocol | False | True | None |
|
||||
---
|
||||
|
||||
|
||||
@@ -1,24 +1,24 @@
|
||||
---
|
||||
title: newsletter
|
||||
description: OpenBB Terminal Function
|
||||
---
|
||||
|
||||
# newsletter
|
||||
|
||||
Display DeFi related substack newsletters. [Source: substack.com]
|
||||
|
||||
### Usage
|
||||
|
||||
```python
|
||||
usage: newsletter [-l LIMIT]
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Parameters
|
||||
|
||||
| Name | Description | Default | Optional | Choices |
|
||||
| ---- | ----------- | ------- | -------- | ------- |
|
||||
| limit | Number of records to display | 10 | True | None |
|
||||
---
|
||||
|
||||
---
|
||||
title: newsletter
|
||||
description: OpenBB Terminal Function
|
||||
---
|
||||
|
||||
# newsletter
|
||||
|
||||
Display DeFi related substack newsletters. [Source: substack.com]
|
||||
|
||||
### Usage
|
||||
|
||||
```python
|
||||
usage: newsletter [-l LIMIT]
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Parameters
|
||||
|
||||
| Name | Description | Default | Optional | Choices |
|
||||
| ---- | ----------- | ------- | -------- | ------- |
|
||||
| limit | Number of records to display | 10 | True | None |
|
||||
---
|
||||
|
||||
|
||||
@@ -1,29 +1,29 @@
|
||||
---
|
||||
title: pairs
|
||||
description: OpenBB Terminal Function
|
||||
---
|
||||
|
||||
# pairs
|
||||
|
||||
Displays Lastly added pairs on Uniswap DEX. [Source: https://thegraph.com/en/]
|
||||
|
||||
### Usage
|
||||
|
||||
```python
|
||||
usage: pairs [-l LIMIT] [-v VOL] [-tx TX] [--days DAY] [-s {created,pair,token0,token1,volumeUSD,txCount,totalSupply}] [-r]
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Parameters
|
||||
|
||||
| Name | Description | Default | Optional | Choices |
|
||||
| ---- | ----------- | ------- | -------- | ------- |
|
||||
| limit | Number of records to display | 10 | True | None |
|
||||
| vol | Minimum trading volume | 100 | True | range(1, 1000) |
|
||||
| tx | Minimum number of transactions | 100 | True | range(1, 1000) |
|
||||
| days | Number of days the pair has been active, | 10 | True | range(1, 1000) |
|
||||
| sortby | Sort by given column. Default: created | created | True | created, pair, token0, token1, volumeUSD, txCount, totalSupply |
|
||||
| reverse | Data is sorted in descending order by default. Reverse flag will sort it in an ascending way. Only works when raw data is displayed. | False | True | None |
|
||||
---
|
||||
|
||||
---
|
||||
title: pairs
|
||||
description: OpenBB Terminal Function
|
||||
---
|
||||
|
||||
# pairs
|
||||
|
||||
Displays Lastly added pairs on Uniswap DEX. [Source: https://thegraph.com/en/]
|
||||
|
||||
### Usage
|
||||
|
||||
```python
|
||||
usage: pairs [-l LIMIT] [-v VOL] [-tx TX] [--days DAY] [-s {created,pair,token0,token1,volumeUSD,txCount,totalSupply}] [-r]
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Parameters
|
||||
|
||||
| Name | Description | Default | Optional | Choices |
|
||||
| ---- | ----------- | ------- | -------- | ------- |
|
||||
| limit | Number of records to display | 10 | True | None |
|
||||
| vol | Minimum trading volume | 100 | True | range(1, 1000) |
|
||||
| tx | Minimum number of transactions | 100 | True | range(1, 1000) |
|
||||
| days | Number of days the pair has been active, | 10 | True | range(1, 1000) |
|
||||
| sortby | Sort by given column. Default: created | created | True | created, pair, token0, token1, volumeUSD, txCount, totalSupply |
|
||||
| reverse | Data is sorted in descending order by default. Reverse flag will sort it in an ascending way. Only works when raw data is displayed. | False | True | None |
|
||||
---
|
||||
|
||||
|
||||
@@ -1,26 +1,26 @@
|
||||
---
|
||||
title: pools
|
||||
description: OpenBB Terminal Function
|
||||
---
|
||||
|
||||
# pools
|
||||
|
||||
Display uniswap pools by volume. [Source: https://thegraph.com/en/]
|
||||
|
||||
### Usage
|
||||
|
||||
```python
|
||||
usage: pairs [-l LIMIT] [-s {volumeUSD,token0.name,token0.symbol,token1.name,token1.symbol,volumeUSD,txCount}] [-r]
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Parameters
|
||||
|
||||
| Name | Description | Default | Optional | Choices |
|
||||
| ---- | ----------- | ------- | -------- | ------- |
|
||||
| limit | Number of records to display | 10 | True | None |
|
||||
| sortby | Sort by given column. Default: volumeUSD | volumeUSD | True | volumeUSD, token0.name, token0.symbol, token1.name, token1.symbol, volumeUSD, txCount |
|
||||
| reverse | Data is sorted in descending order by default. Reverse flag will sort it in an ascending way. Only works when raw data is displayed. | False | True | None |
|
||||
---
|
||||
|
||||
---
|
||||
title: pools
|
||||
description: OpenBB Terminal Function
|
||||
---
|
||||
|
||||
# pools
|
||||
|
||||
Display uniswap pools by volume. [Source: https://thegraph.com/en/]
|
||||
|
||||
### Usage
|
||||
|
||||
```python
|
||||
usage: pairs [-l LIMIT] [-s {volumeUSD,token0.name,token0.symbol,token1.name,token1.symbol,volumeUSD,txCount}] [-r]
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Parameters
|
||||
|
||||
| Name | Description | Default | Optional | Choices |
|
||||
| ---- | ----------- | ------- | -------- | ------- |
|
||||
| limit | Number of records to display | 10 | True | None |
|
||||
| sortby | Sort by given column. Default: volumeUSD | volumeUSD | True | volumeUSD, token0.name, token0.symbol, token1.name, token1.symbol, volumeUSD, txCount |
|
||||
| reverse | Data is sorted in descending order by default. Reverse flag will sort it in an ascending way. Only works when raw data is displayed. | False | True | None |
|
||||
---
|
||||
|
||||
|
||||
@@ -1,25 +1,25 @@
|
||||
---
|
||||
title: sinfo
|
||||
description: OpenBB Terminal Function
|
||||
---
|
||||
|
||||
# sinfo
|
||||
|
||||
Displays staking info of a certain terra address. [Source: https://fcd.terra.dev/swagger]
|
||||
|
||||
### Usage
|
||||
|
||||
```python
|
||||
usage: sinfo -a ADDRESS [-l LIMIT]
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Parameters
|
||||
|
||||
| Name | Description | Default | Optional | Choices |
|
||||
| ---- | ----------- | ------- | -------- | ------- |
|
||||
| address | Terra address. Valid terra addresses start with 'terra' | None | False | None |
|
||||
| limit | Number of delegations | 10 | True | None |
|
||||
---
|
||||
|
||||
---
|
||||
title: sinfo
|
||||
description: OpenBB Terminal Function
|
||||
---
|
||||
|
||||
# sinfo
|
||||
|
||||
Displays staking info of a certain terra address. [Source: https://fcd.terra.dev/swagger]
|
||||
|
||||
### Usage
|
||||
|
||||
```python
|
||||
usage: sinfo -a ADDRESS [-l LIMIT]
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Parameters
|
||||
|
||||
| Name | Description | Default | Optional | Choices |
|
||||
| ---- | ----------- | ------- | -------- | ------- |
|
||||
| address | Terra address. Valid terra addresses start with 'terra' | None | False | None |
|
||||
| limit | Number of delegations | 10 | True | None |
|
||||
---
|
||||
|
||||
|
||||
@@ -1,24 +1,24 @@
|
||||
---
|
||||
title: sratio
|
||||
description: OpenBB Terminal Function
|
||||
---
|
||||
|
||||
# sratio
|
||||
|
||||
Displays terra blockchain staking ratio history. [Source: https://fcd.terra.dev/swagger]
|
||||
|
||||
### Usage
|
||||
|
||||
```python
|
||||
usage: sratio [-l LIMIT]
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Parameters
|
||||
|
||||
| Name | Description | Default | Optional | Choices |
|
||||
| ---- | ----------- | ------- | -------- | ------- |
|
||||
| limit | Number of days to show | 90 | True | None |
|
||||
---
|
||||
|
||||
---
|
||||
title: sratio
|
||||
description: OpenBB Terminal Function
|
||||
---
|
||||
|
||||
# sratio
|
||||
|
||||
Displays terra blockchain staking ratio history. [Source: https://fcd.terra.dev/swagger]
|
||||
|
||||
### Usage
|
||||
|
||||
```python
|
||||
usage: sratio [-l LIMIT]
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Parameters
|
||||
|
||||
| Name | Description | Default | Optional | Choices |
|
||||
| ---- | ----------- | ------- | -------- | ------- |
|
||||
| limit | Number of days to show | 90 | True | None |
|
||||
---
|
||||
|
||||
|
||||
@@ -1,24 +1,24 @@
|
||||
---
|
||||
title: sreturn
|
||||
description: OpenBB Terminal Function
|
||||
---
|
||||
|
||||
# sreturn
|
||||
|
||||
Displays terra blockchain staking returns history. [Source: https://fcd.terra.dev/swagger]
|
||||
|
||||
### Usage
|
||||
|
||||
```python
|
||||
usage: sreturn [-l LIMIT]
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Parameters
|
||||
|
||||
| Name | Description | Default | Optional | Choices |
|
||||
| ---- | ----------- | ------- | -------- | ------- |
|
||||
| limit | Number of days to show | 90 | True | None |
|
||||
---
|
||||
|
||||
---
|
||||
title: sreturn
|
||||
description: OpenBB Terminal Function
|
||||
---
|
||||
|
||||
# sreturn
|
||||
|
||||
Displays terra blockchain staking returns history. [Source: https://fcd.terra.dev/swagger]
|
||||
|
||||
### Usage
|
||||
|
||||
```python
|
||||
usage: sreturn [-l LIMIT]
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Parameters
|
||||
|
||||
| Name | Description | Default | Optional | Choices |
|
||||
| ---- | ----------- | ------- | -------- | ------- |
|
||||
| limit | Number of days to show | 90 | True | None |
|
||||
---
|
||||
|
||||
|
||||
@@ -1,23 +1,23 @@
|
||||
---
|
||||
title: stats
|
||||
description: OpenBB Terminal Function
|
||||
---
|
||||
|
||||
# stats
|
||||
|
||||
Display base statistics about Uniswap DEX. [Source: https://thegraph.com/en/]
|
||||
|
||||
### Usage
|
||||
|
||||
```python
|
||||
usage: stats
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Parameters
|
||||
|
||||
This command has no parameters
|
||||
|
||||
---
|
||||
|
||||
---
|
||||
title: stats
|
||||
description: OpenBB Terminal Function
|
||||
---
|
||||
|
||||
# stats
|
||||
|
||||
Display base statistics about Uniswap DEX. [Source: https://thegraph.com/en/]
|
||||
|
||||
### Usage
|
||||
|
||||
```python
|
||||
usage: stats
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Parameters
|
||||
|
||||
This command has no parameters
|
||||
|
||||
---
|
||||
|
||||
|
||||
@@ -1,24 +1,24 @@
|
||||
---
|
||||
title: stvl
|
||||
description: OpenBB Terminal Function
|
||||
---
|
||||
|
||||
# stvl
|
||||
|
||||
Displays historical values of the total sum of TVLs from all listed dApps. [Source: https://docs.llama.fi/api]
|
||||
|
||||
### Usage
|
||||
|
||||
```python
|
||||
usage: stvl [-l LIMIT]
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Parameters
|
||||
|
||||
| Name | Description | Default | Optional | Choices |
|
||||
| ---- | ----------- | ------- | -------- | ------- |
|
||||
| limit | Number of records to display | 10 | True | None |
|
||||
---
|
||||
|
||||
---
|
||||
title: stvl
|
||||
description: OpenBB Terminal Function
|
||||
---
|
||||
|
||||
# stvl
|
||||
|
||||
Displays historical values of the total sum of TVLs from all listed dApps. [Source: https://docs.llama.fi/api]
|
||||
|
||||
### Usage
|
||||
|
||||
```python
|
||||
usage: stvl [-l LIMIT]
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Parameters
|
||||
|
||||
| Name | Description | Default | Optional | Choices |
|
||||
| ---- | ----------- | ------- | -------- | ------- |
|
||||
| limit | Number of records to display | 10 | True | None |
|
||||
---
|
||||
|
||||
|
||||
@@ -1,26 +1,26 @@
|
||||
---
|
||||
title: swaps
|
||||
description: OpenBB Terminal Function
|
||||
---
|
||||
|
||||
# swaps
|
||||
|
||||
Display last swaps done on Uniswap DEX. [Source: https://thegraph.com/en/]
|
||||
|
||||
### Usage
|
||||
|
||||
```python
|
||||
usage: pairs [-l LIMIT] [-s {Datetime,USD,From,To}] [-r]
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Parameters
|
||||
|
||||
| Name | Description | Default | Optional | Choices |
|
||||
| ---- | ----------- | ------- | -------- | ------- |
|
||||
| limit | Number of records to display | 10 | True | None |
|
||||
| sortby | Sort by given column. Default: timestamp | Datetime | True | Datetime, USD, From, To |
|
||||
| reverse | Data is sorted in descending order by default. Reverse flag will sort it in an ascending way. Only works when raw data is displayed. | False | True | None |
|
||||
---
|
||||
|
||||
---
|
||||
title: swaps
|
||||
description: OpenBB Terminal Function
|
||||
---
|
||||
|
||||
# swaps
|
||||
|
||||
Display last swaps done on Uniswap DEX. [Source: https://thegraph.com/en/]
|
||||
|
||||
### Usage
|
||||
|
||||
```python
|
||||
usage: pairs [-l LIMIT] [-s {Datetime,USD,From,To}] [-r]
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Parameters
|
||||
|
||||
| Name | Description | Default | Optional | Choices |
|
||||
| ---- | ----------- | ------- | -------- | ------- |
|
||||
| limit | Number of records to display | 10 | True | None |
|
||||
| sortby | Sort by given column. Default: timestamp | Datetime | True | Datetime, USD, From, To |
|
||||
| reverse | Data is sorted in descending order by default. Reverse flag will sort it in an ascending way. Only works when raw data is displayed. | False | True | None |
|
||||
---
|
||||
|
||||
|
||||
@@ -1,27 +1,27 @@
|
||||
---
|
||||
title: tokens
|
||||
description: OpenBB Terminal Function
|
||||
---
|
||||
|
||||
# tokens
|
||||
|
||||
Display tokens trade-able on Uniswap DEX [Source: https://thegraph.com/en/]
|
||||
|
||||
### Usage
|
||||
|
||||
```python
|
||||
usage: tokens [--skip SKIP] [--limit LIMIT] [-s {index,symbol,name,tradeVolumeUSD,totalLiquidity,txCount}] [-r]
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Parameters
|
||||
|
||||
| Name | Description | Default | Optional | Choices |
|
||||
| ---- | ----------- | ------- | -------- | ------- |
|
||||
| skip | Number of records to skip | 0 | True | range(1, 1000) |
|
||||
| limit | Number of records to display | 20 | True | None |
|
||||
| sortby | Sort by given column. Default: index | index | True | index, symbol, name, tradeVolumeUSD, totalLiquidity, txCount |
|
||||
| reverse | Data is sorted in descending order by default. Reverse flag will sort it in an ascending way. Only works when raw data is displayed. | False | True | None |
|
||||
---
|
||||
|
||||
---
|
||||
title: tokens
|
||||
description: OpenBB Terminal Function
|
||||
---
|
||||
|
||||
# tokens
|
||||
|
||||
Display tokens trade-able on Uniswap DEX [Source: https://thegraph.com/en/]
|
||||
|
||||
### Usage
|
||||
|
||||
```python
|
||||
usage: tokens [--skip SKIP] [--limit LIMIT] [-s {index,symbol,name,tradeVolumeUSD,totalLiquidity,txCount}] [-r]
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Parameters
|
||||
|
||||
| Name | Description | Default | Optional | Choices |
|
||||
| ---- | ----------- | ------- | -------- | ------- |
|
||||
| skip | Number of records to skip | 0 | True | range(1, 1000) |
|
||||
| limit | Number of records to display | 20 | True | None |
|
||||
| sortby | Sort by given column. Default: index | index | True | index, symbol, name, tradeVolumeUSD, totalLiquidity, txCount |
|
||||
| reverse | Data is sorted in descending order by default. Reverse flag will sort it in an ascending way. Only works when raw data is displayed. | False | True | None |
|
||||
---
|
||||
|
||||
|
||||
@@ -1,26 +1,26 @@
|
||||
---
|
||||
title: validators
|
||||
description: OpenBB Terminal Function
|
||||
---
|
||||
|
||||
# validators
|
||||
|
||||
Displays information about terra validators. [Source: https://fcd.terra.dev/swagger]
|
||||
|
||||
### Usage
|
||||
|
||||
```python
|
||||
usage: validators [-l LIMIT] [-s {validatorName,tokensAmount,votingPower,commissionRate,status,uptime}] [-r]
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Parameters
|
||||
|
||||
| Name | Description | Default | Optional | Choices |
|
||||
| ---- | ----------- | ------- | -------- | ------- |
|
||||
| limit | Number of validators to show | 10 | True | None |
|
||||
| sortby | Sort by given column. Default: votingPower | votingPower | True | validatorName, tokensAmount, votingPower, commissionRate, status, uptime |
|
||||
| reverse | Data is sorted in descending order by default. Reverse flag will sort it in an ascending way. Only works when raw data is displayed. | False | True | None |
|
||||
---
|
||||
|
||||
---
|
||||
title: validators
|
||||
description: OpenBB Terminal Function
|
||||
---
|
||||
|
||||
# validators
|
||||
|
||||
Displays information about terra validators. [Source: https://fcd.terra.dev/swagger]
|
||||
|
||||
### Usage
|
||||
|
||||
```python
|
||||
usage: validators [-l LIMIT] [-s {validatorName,tokensAmount,votingPower,commissionRate,status,uptime}] [-r]
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Parameters
|
||||
|
||||
| Name | Description | Default | Optional | Choices |
|
||||
| ---- | ----------- | ------- | -------- | ------- |
|
||||
| limit | Number of validators to show | 10 | True | None |
|
||||
| sortby | Sort by given column. Default: votingPower | votingPower | True | validatorName, tokensAmount, votingPower, commissionRate, status, uptime |
|
||||
| reverse | Data is sorted in descending order by default. Reverse flag will sort it in an ascending way. Only works when raw data is displayed. | False | True | None |
|
||||
---
|
||||
|
||||
|
||||
@@ -1,32 +1,33 @@
|
||||
---
|
||||
title: vaults
|
||||
description: OpenBB Terminal Function
|
||||
---
|
||||
|
||||
# vaults
|
||||
|
||||
Display Top DeFi Vaults. [Source: https://coindix.com/]
|
||||
|
||||
### Usage
|
||||
|
||||
```python
|
||||
usage: vaults [-c {ethereum,polygon,avalanche,bsc,terra,fantom,moonriver,celo,heco,okex,cronos,arbitrum,eth,harmony,fuse,defichain,solana,optimism,kusama,metis,osmosis}]
|
||||
[-p {aave,acryptos,alpaca,anchor,autofarm,balancer,bancor,beefy,belt,compound,convex,cream,curve,defichain,geist,lido,liquity,mirror,pancakeswap,raydium,sushi,tarot,traderjoe,tulip,ubeswap,uniswap,venus,yearn,osmosis,tulip}]
|
||||
[-k {lp,single,noimploss,stable}] [-t TOP] [-s {name,chain,protocol,apy,tvl,link}] [-r] [-l]
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Parameters
|
||||
|
||||
| Name | Description | Default | Optional | Choices |
|
||||
| ---- | ----------- | ------- | -------- | ------- |
|
||||
| chain | Blockchain name e.g. ethereum, terra | None | True | ethereum, polygon, avalanche, bsc, terra, fantom, moonriver, celo, heco, okex, cronos, arbitrum, eth, harmony, fuse, defichain, solana, optimism, kusama, metis, osmosis |
|
||||
| protocol | DeFi protocol name e.g. aave, uniswap | None | True | aave, acryptos, alpaca, anchor, autofarm, balancer, bancor, beefy, belt, compound, convex, cream, curve, defichain, geist, lido, liquity, mirror, pancakeswap, raydium, sushi, tarot, traderjoe, tulip, ubeswap, uniswap, venus, yearn, osmosis, tulip |
|
||||
| kind | Kind/type of vault e.g. lp, single, noimploss, stable | None | True | lp, single, noimploss, stable |
|
||||
| limit | Number of records to display | 10 | True | range(1, 1000) |
|
||||
| sortby | Sort by given column. Default: timestamp | apy | True | name, chain, protocol, apy, tvl, link |
|
||||
| reverse | Data is sorted in descending order by default. Reverse flag will sort it in an ascending way. Only works when raw data is displayed. | False | True | None |
|
||||
| link | Flag to show vault link | True | True | None |
|
||||
---
|
||||
|
||||
---
|
||||
title: vaults
|
||||
description: OpenBB Terminal Function
|
||||
---
|
||||
|
||||
# vaults
|
||||
|
||||
Display Top DeFi Vaults. [Source: https://coindix.com/]
|
||||
|
||||
### Usage
|
||||
|
||||
```python
|
||||
usage: vaults
|
||||
[-c {ethereum,polygon,avalanche,bsc,terra,fantom,moonriver,celo,heco,okex,cronos,arbitrum,eth,harmony,fuse,defichain,solana,optimism,kusama,metis,osmosis}]
|
||||
[-p {aave,acryptos,alpaca,anchor,autofarm,balancer,bancor,beefy,belt,compound,convex,cream,curve,defichain,geist,lido,liquity,mirror,pancakeswap,raydium,sushi,tarot,traderjoe,tulip,ubeswap,uniswap,venus,yearn,osmosis,tulip}]
|
||||
[-k {lp,single,noimploss,stable}] [-t TOP] [-s {name,chain,protocol,apy,tvl,link}] [-r] [-l]
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Parameters
|
||||
|
||||
| Name | Description | Default | Optional | Choices |
|
||||
| ---- | ----------- | ------- | -------- | ------- |
|
||||
| chain | Blockchain name e.g. ethereum, terra | None | True | ethereum, polygon, avalanche, bsc, terra, fantom, moonriver, celo, heco, okex, cronos, arbitrum, eth, harmony, fuse, defichain, solana, optimism, kusama, metis, osmosis |
|
||||
| protocol | DeFi protocol name e.g. aave, uniswap | None | True | aave, acryptos, alpaca, anchor, autofarm, balancer, bancor, beefy, belt, compound, convex, cream, curve, defichain, geist, lido, liquity, mirror, pancakeswap, raydium, sushi, tarot, traderjoe, tulip, ubeswap, uniswap, venus, yearn, osmosis, tulip |
|
||||
| kind | Kind/type of vault e.g. lp, single, noimploss, stable | None | True | lp, single, noimploss, stable |
|
||||
| limit | Number of records to display | 10 | True | range(1, 1000) |
|
||||
| sortby | Sort by given column. Default: timestamp | apy | True | name, chain, protocol, apy, tvl, link |
|
||||
| reverse | Data is sorted in descending order by default. Reverse flag will sort it in an ascending way. Only works when raw data is displayed. | False | True | None |
|
||||
| link | Flag to show vault link | True | True | None |
|
||||
---
|
||||
|
||||
|
||||
@@ -1,25 +1,25 @@
|
||||
---
|
||||
title: dapps
|
||||
description: OpenBB Terminal Function
|
||||
---
|
||||
|
||||
# dapps
|
||||
|
||||
Shows top decentralized applications [Source: https://dappradar.com/] Accepts --sort {Name,Category,Protocols,Daily Users,Daily Volume [$]} to sort by column
|
||||
|
||||
### Usage
|
||||
|
||||
```python
|
||||
usage: dapps [-l LIMIT] [-s SORTBY [SORTBY ...]]
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Parameters
|
||||
|
||||
| Name | Description | Default | Optional | Choices |
|
||||
| ---- | ----------- | ------- | -------- | ------- |
|
||||
| limit | Number of records to display | 15 | True | None |
|
||||
| sortby | Sort by given column. Default: Daily Volume [$] | Daily Volume [$] | True | Name, Category, Protocols, Daily Users, Daily Volume [$] |
|
||||
---
|
||||
|
||||
---
|
||||
title: dapps
|
||||
description: OpenBB Terminal Function
|
||||
---
|
||||
|
||||
# dapps
|
||||
|
||||
Shows top decentralized applications [Source: https://dappradar.com/] Accepts --sort {Name,Category,Protocols,Daily Users,Daily Volume [$]} to sort by column
|
||||
|
||||
### Usage
|
||||
|
||||
```python
|
||||
usage: dapps [-l LIMIT] [-s SORTBY [SORTBY ...]]
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Parameters
|
||||
|
||||
| Name | Description | Default | Optional | Choices |
|
||||
| ---- | ----------- | ------- | -------- | ------- |
|
||||
| limit | Number of records to display | 15 | True | None |
|
||||
| sortby | Sort by given column. Default: Daily Volume [$] | Daily Volume [$] | True | Name, Category, Protocols, Daily Users, Daily Volume [$] |
|
||||
---
|
||||
|
||||
|
||||
@@ -1,25 +1,25 @@
|
||||
---
|
||||
title: dex
|
||||
description: OpenBB Terminal Function
|
||||
---
|
||||
|
||||
# dex
|
||||
|
||||
Shows top decentralized exchanges [Source: https://dappradar.com/] Accepts --sort {Name,Daily Users,Daily Volume [$]} to sort by column
|
||||
|
||||
### Usage
|
||||
|
||||
```python
|
||||
usage: dex [-l LIMIT] [-s SORTBY [SORTBY ...]]
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Parameters
|
||||
|
||||
| Name | Description | Default | Optional | Choices |
|
||||
| ---- | ----------- | ------- | -------- | ------- |
|
||||
| limit | Number of records to display | 15 | True | None |
|
||||
| sortby | Sort by given column. Default: Daily Volume [$] | Daily Volume [$] | True | Name, Category, Daily Users, Daily Volume [$] |
|
||||
---
|
||||
|
||||
---
|
||||
title: dex
|
||||
description: OpenBB Terminal Function
|
||||
---
|
||||
|
||||
# dex
|
||||
|
||||
Shows top decentralized exchanges [Source: https://dappradar.com/] Accepts --sort {Name,Daily Users,Daily Volume [$]} to sort by column
|
||||
|
||||
### Usage
|
||||
|
||||
```python
|
||||
usage: dex [-l LIMIT] [-s SORTBY [SORTBY ...]]
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Parameters
|
||||
|
||||
| Name | Description | Default | Optional | Choices |
|
||||
| ---- | ----------- | ------- | -------- | ------- |
|
||||
| limit | Number of records to display | 15 | True | None |
|
||||
| sortby | Sort by given column. Default: Daily Volume [$] | Daily Volume [$] | True | Name, Category, Daily Users, Daily Volume [$] |
|
||||
---
|
||||
|
||||
|
||||
@@ -1,26 +1,26 @@
|
||||
---
|
||||
title: gainers
|
||||
description: OpenBB Terminal Function
|
||||
---
|
||||
|
||||
# gainers
|
||||
|
||||
Shows Largest Gainers - coins which gain the most in given period. You can use parameter --interval to set which timeframe are you interested in: {14d,1h,1y,200d,24h,30d,7d} You can look on only N number of records with --limit, You can sort by {Symbol,Name,Price [$],Market Cap,Market Cap Rank,Volume [$]} with --sort.
|
||||
|
||||
### Usage
|
||||
|
||||
```python
|
||||
usage: gainers [-i {14d,1h,1y,200d,24h,30d,7d}] [-l LIMIT] [-s SORTBY [SORTBY ...]]
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Parameters
|
||||
|
||||
| Name | Description | Default | Optional | Choices |
|
||||
| ---- | ----------- | ------- | -------- | ------- |
|
||||
| interval | time period, one from {14d,1h,1y,200d,24h,30d,7d} | 1h | True | 14d, 1h, 1y, 200d, 24h, 30d, 7d |
|
||||
| limit | Number of records to display | 15 | True | None |
|
||||
| sortby | Sort by given column. Default: Market Cap Rank | market_cap | True | Symbol, Name, Price [$], Market Cap, Market Cap Rank, Volume [$] |
|
||||
---
|
||||
|
||||
---
|
||||
title: gainers
|
||||
description: OpenBB Terminal Function
|
||||
---
|
||||
|
||||
# gainers
|
||||
|
||||
Shows Largest Gainers - coins which gain the most in given period. You can use parameter --interval to set which timeframe are you interested in: {14d,1h,1y,200d,24h,30d,7d} You can look on only N number of records with --limit, You can sort by {Symbol,Name,Price [$],Market Cap,Market Cap Rank,Volume [$]} with --sort.
|
||||
|
||||
### Usage
|
||||
|
||||
```python
|
||||
usage: gainers [-i {14d,1h,1y,200d,24h,30d,7d}] [-l LIMIT] [-s SORTBY [SORTBY ...]]
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Parameters
|
||||
|
||||
| Name | Description | Default | Optional | Choices |
|
||||
| ---- | ----------- | ------- | -------- | ------- |
|
||||
| interval | time period, one from {14d,1h,1y,200d,24h,30d,7d} | 1h | True | 14d, 1h, 1y, 200d, 24h, 30d, 7d |
|
||||
| limit | Number of records to display | 15 | True | None |
|
||||
| sortby | Sort by given column. Default: Market Cap Rank | market_cap | True | Symbol, Name, Price [$], Market Cap, Market Cap Rank, Volume [$] |
|
||||
---
|
||||
|
||||
|
||||
@@ -1,25 +1,25 @@
|
||||
---
|
||||
title: games
|
||||
description: OpenBB Terminal Function
|
||||
---
|
||||
|
||||
# games
|
||||
|
||||
Shows top blockchain games [Source: https://dappradar.com/] Accepts --sort {Name,Daily Users,Daily Volume [$]} to sort by column
|
||||
|
||||
### Usage
|
||||
|
||||
```python
|
||||
usage: games [-l LIMIT] [-s SORTBY [SORTBY ...]]
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Parameters
|
||||
|
||||
| Name | Description | Default | Optional | Choices |
|
||||
| ---- | ----------- | ------- | -------- | ------- |
|
||||
| limit | Number of records to display | 15 | True | None |
|
||||
| sortby | Sort by given column. Default: Daily Volume [$] | Daily Volume [$] | True | Name, Category, Daily Users, Daily Volume [$] |
|
||||
---
|
||||
|
||||
---
|
||||
title: games
|
||||
description: OpenBB Terminal Function
|
||||
---
|
||||
|
||||
# games
|
||||
|
||||
Shows top blockchain games [Source: https://dappradar.com/] Accepts --sort {Name,Daily Users,Daily Volume [$]} to sort by column
|
||||
|
||||
### Usage
|
||||
|
||||
```python
|
||||
usage: games [-l LIMIT] [-s SORTBY [SORTBY ...]]
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Parameters
|
||||
|
||||
| Name | Description | Default | Optional | Choices |
|
||||
| ---- | ----------- | ------- | -------- | ------- |
|
||||
| limit | Number of records to display | 15 | True | None |
|
||||
| sortby | Sort by given column. Default: Daily Volume [$] | Daily Volume [$] | True | Name, Category, Daily Users, Daily Volume [$] |
|
||||
---
|
||||
|
||||
|
||||
@@ -1,26 +1,26 @@
|
||||
---
|
||||
title: losers
|
||||
description: OpenBB Terminal Function
|
||||
---
|
||||
|
||||
# losers
|
||||
|
||||
Shows Largest Losers - coins which price dropped the most in given period You can use parameter --interval to set which timeframe are you interested in: {14d,1h,1y,200d,24h,30d,7d} You can look on only N number of records with --limit, You can sort by {Symbol,Name,Price [$],Market Cap,Market Cap Rank,Volume [$]} with --sort.
|
||||
|
||||
### Usage
|
||||
|
||||
```python
|
||||
usage: losers [-i {14d,1h,1y,200d,24h,30d,7d}] [-l LIMIT] [-s SORTBY [SORTBY ...]]
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Parameters
|
||||
|
||||
| Name | Description | Default | Optional | Choices |
|
||||
| ---- | ----------- | ------- | -------- | ------- |
|
||||
| interval | time period, one from {14d,1h,1y,200d,24h,30d,7d} | 1h | True | 14d, 1h, 1y, 200d, 24h, 30d, 7d |
|
||||
| limit | Number of records to display | 15 | True | None |
|
||||
| sortby | Sort by given column. Default: Market Cap Rank | Market Cap | True | Symbol, Name, Price [$], Market Cap, Market Cap Rank, Volume [$] |
|
||||
---
|
||||
|
||||
---
|
||||
title: losers
|
||||
description: OpenBB Terminal Function
|
||||
---
|
||||
|
||||
# losers
|
||||
|
||||
Shows Largest Losers - coins which price dropped the most in given period You can use parameter --interval to set which timeframe are you interested in: {14d,1h,1y,200d,24h,30d,7d} You can look on only N number of records with --limit, You can sort by {Symbol,Name,Price [$],Market Cap,Market Cap Rank,Volume [$]} with --sort.
|
||||
|
||||
### Usage
|
||||
|
||||
```python
|
||||
usage: losers [-i {14d,1h,1y,200d,24h,30d,7d}] [-l LIMIT] [-s SORTBY [SORTBY ...]]
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Parameters
|
||||
|
||||
| Name | Description | Default | Optional | Choices |
|
||||
| ---- | ----------- | ------- | -------- | ------- |
|
||||
| interval | time period, one from {14d,1h,1y,200d,24h,30d,7d} | 1h | True | 14d, 1h, 1y, 200d, 24h, 30d, 7d |
|
||||
| limit | Number of records to display | 15 | True | None |
|
||||
| sortby | Sort by given column. Default: Market Cap Rank | Market Cap | True | Symbol, Name, Price [$], Market Cap, Market Cap Rank, Volume [$] |
|
||||
---
|
||||
|
||||
|
||||
@@ -1,25 +1,25 @@
|
||||
---
|
||||
title: nft
|
||||
description: OpenBB Terminal Function
|
||||
---
|
||||
|
||||
# nft
|
||||
|
||||
Shows top NFT collections [Source: https://dappradar.com/] Accepts --sort {Name,Protocols,Floor Price [$],Avg Price [$],Market Cap,Volume [$]} to sort by column
|
||||
|
||||
### Usage
|
||||
|
||||
```python
|
||||
usage: nft [-l LIMIT] [-s SORTBY [SORTBY ...]]
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Parameters
|
||||
|
||||
| Name | Description | Default | Optional | Choices |
|
||||
| ---- | ----------- | ------- | -------- | ------- |
|
||||
| limit | Number of records to display | 15 | True | None |
|
||||
| sortby | Sort by given column. Default: Market Cap | Market Cap | True | Name, Protocols, Floor Price [$], Avg Price [$], Market Cap [$], Volume [$] |
|
||||
---
|
||||
|
||||
---
|
||||
title: nft
|
||||
description: OpenBB Terminal Function
|
||||
---
|
||||
|
||||
# nft
|
||||
|
||||
Shows top NFT collections [Source: https://dappradar.com/] Accepts --sort {Name,Protocols,Floor Price [$],Avg Price [$],Market Cap,Volume [$]} to sort by column
|
||||
|
||||
### Usage
|
||||
|
||||
```python
|
||||
usage: nft [-l LIMIT] [-s SORTBY [SORTBY ...]]
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Parameters
|
||||
|
||||
| Name | Description | Default | Optional | Choices |
|
||||
| ---- | ----------- | ------- | -------- | ------- |
|
||||
| limit | Number of records to display | 15 | True | None |
|
||||
| sortby | Sort by given column. Default: Market Cap | Market Cap | True | Name, Protocols, Floor Price [$], Avg Price [$], Market Cap [$], Volume [$] |
|
||||
---
|
||||
|
||||
|
||||
@@ -1,28 +1,28 @@
|
||||
---
|
||||
title: search
|
||||
description: OpenBB Terminal Function
|
||||
---
|
||||
|
||||
# search
|
||||
|
||||
Search over CoinPaprika API You can display only N number of results with --limit parameter. You can sort data by id, name , category --sort parameter and also with --reverse flag to sort descending. To choose category in which you are searching for use --cat/-c parameter. Available categories: currencies|exchanges|icos|people|tags|all Displays: id, name, category
|
||||
|
||||
### Usage
|
||||
|
||||
```python
|
||||
usage: search -q QUERY [QUERY ...] [-c {currencies,exchanges,icos,people,tags,all}] [-l LIMIT] [-s {category,id,name}] [-r]
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Parameters
|
||||
|
||||
| Name | Description | Default | Optional | Choices |
|
||||
| ---- | ----------- | ------- | -------- | ------- |
|
||||
| query | phrase for search | None | False | None |
|
||||
| category | Categories to search: currencies|exchanges|icos|people|tags|all. Default: all | all | True | currencies, exchanges, icos, people, tags, all |
|
||||
| limit | Limit of records | 10 | True | None |
|
||||
| sortby | Sort by given column. Default: id | id | True | category, id, name |
|
||||
| reverse | Data is sorted in descending order by default. Reverse flag will sort it in an ascending way. Only works when raw data is displayed. | False | True | None |
|
||||
---
|
||||
|
||||
---
|
||||
title: search
|
||||
description: OpenBB Terminal Function
|
||||
---
|
||||
|
||||
# search
|
||||
|
||||
Search over CoinPaprika API You can display only N number of results with --limit parameter. You can sort data by id, name , category --sort parameter and also with --reverse flag to sort descending. To choose category in which you are searching for use --cat/-c parameter. Available categories: currencies|exchanges|icos|people|tags|all Displays: id, name, category
|
||||
|
||||
### Usage
|
||||
|
||||
```python
|
||||
usage: search -q QUERY [QUERY ...] [-c {currencies,exchanges,icos,people,tags,all}] [-l LIMIT] [-s {category,id,name}] [-r]
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Parameters
|
||||
|
||||
| Name | Description | Default | Optional | Choices |
|
||||
| ---- | ----------- | ------- | -------- | ------- |
|
||||
| query | phrase for search | None | False | None |
|
||||
| category | Categories to search: currencies|exchanges|icos|people|tags|all. Default: all | all | True | currencies, exchanges, icos, people, tags, all |
|
||||
| limit | Limit of records | 10 | True | None |
|
||||
| sortby | Sort by given column. Default: id | id | True | category, id, name |
|
||||
| reverse | Data is sorted in descending order by default. Reverse flag will sort it in an ascending way. Only works when raw data is displayed. | False | True | None |
|
||||
---
|
||||
|
||||
|
||||
@@ -1,27 +1,27 @@
|
||||
---
|
||||
title: top
|
||||
description: OpenBB Terminal Function
|
||||
---
|
||||
|
||||
# top
|
||||
|
||||
Display N coins from the data source, if the data source is CoinGecko it can receive a category as argument (-c decentralized-finance-defi or -c stablecoins) and will show only the top coins in that category. can also receive sort arguments (these depend on the source), e.g., --sort Volume [$] You can sort by {Symbol,Name,Price [$],Market Cap,Market Cap Rank,Volume [$]} with CoinGecko Number of coins to show: -l 10
|
||||
|
||||
### Usage
|
||||
|
||||
```python
|
||||
usage: top [-c CATEGORY] [-l LIMIT] [-s SORTBY [SORTBY ...]] [-r]
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Parameters
|
||||
|
||||
| Name | Description | Default | Optional | Choices |
|
||||
| ---- | ----------- | ------- | -------- | ------- |
|
||||
| category | Category (e.g., stablecoins). Empty for no category. Only works for 'CoinGecko' source. | | True | aave-tokens, analytics, arbitrum-ecosystem, artificial-intelligence, asset-backed-tokens, asset-manager, augmented-reality, automated-market-maker-amm, avalanche-ecosystem, axie-infinity, big-data, binance-launchpool, binance-smart-chain, business-platform, business-services, cardano-ecosystem, celo-ecosystem, centralized-exchange-token-cex, charity, cny-stablecoin, collectibles, communication, compound-tokens, cosmos-ecosystem, cryptocurrency, daomaker-ecosystem, decentralized-exchange, decentralized-finance-defi, defi-index, decentralized-derivatives, education, energy, entertainment, etf, eth-2-0-staking, eur-stablecoin, exchange-based-tokens, fan-token, fantom-ecosystem, finance-banking, fractionalized-nft, gambling, gaming, gbp-stablecoin, gig-economy, xdai-ecosystem, governance, guild-scholarship, harmony-ecosystem, healthcare, heco-chain-ecosystem, impossible-launchpad, index-coin, infrastructure, insurance, internet-of-things-iot, investment, iotex-ecosystem, kardiachain-ecosystem, krw-stablecoin, launchpad, layer-1, legal, lending-borrowing, leveraged-token, lp-tokens, manufacturing, marketing, masternodes, media, meme-token, metaverse, mev-protection, mirrored-assets, moonriver-ecosystem, music, near-protocol-ecosystem, nft-index, niftex-shards, non-fungible-tokens-nft, number, oec-ecosystem, ohm-fork, olympus-pro, decentralized-options, oracle, decentralized-perpetuals, play-to-earn, dot-ecosystem, polygon-ecosystem, prediction-markets, privacy-coins, protocol, real-estate, realt-tokens, rebase-tokens, reddit-points, remittance, retail, seigniorage, smart-contract-platform, social-money, software, solana-ecosystem, sports, stablecoins, storage, structured-products, synthetic-assets, synths, technology-science, terra-ecosystem, tokenized-btc, tokenized-gold, tokenized-products, tokenized-stock, tokensets, tourism, usd-stablecoin, us-election-2020, utokens, virtual-reality, wallets, wrapped-tokens, yearn-yfi-partnerships-mergers, yield-aggregator, yield-farming, zilliqa-ecosystem |
|
||||
| limit | Limit of records | 10 | True | None |
|
||||
| sortby | Sort by given column. Default: Market Cap Rank | Market Cap Rank | True | Symbol, Name, Volume [$], Market Cap, Market Cap Rank, 7D Change [%], 24H Change [%] |
|
||||
| reverse | Data is sorted in descending order by default. Reverse flag will sort it in an ascending way. Only works when raw data is displayed. | False | True | None |
|
||||
---
|
||||
|
||||
---
|
||||
title: top
|
||||
description: OpenBB Terminal Function
|
||||
---
|
||||
|
||||
# top
|
||||
|
||||
Display N coins from the data source, if the data source is CoinGecko it can receive a category as argument (-c decentralized-finance-defi or -c stablecoins) and will show only the top coins in that category. can also receive sort arguments (these depend on the source), e.g., --sort Volume [$] You can sort by {Symbol,Name,Price [$],Market Cap,Market Cap Rank,Volume [$]} with CoinGecko Number of coins to show: -l 10
|
||||
|
||||
### Usage
|
||||
|
||||
```python
|
||||
usage: top [-c CATEGORY] [-l LIMIT] [-s SORTBY [SORTBY ...]] [-r]
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Parameters
|
||||
|
||||
| Name | Description | Default | Optional | Choices |
|
||||
| ---- | ----------- | ------- | -------- | ------- |
|
||||
| category | Category (e.g., stablecoins). Empty for no category. Only works for 'CoinGecko' source. | | True | aave-tokens, analytics, arbitrum-ecosystem, artificial-intelligence, asset-backed-tokens, asset-manager, augmented-reality, automated-market-maker-amm, avalanche-ecosystem, axie-infinity, big-data, binance-launchpool, binance-smart-chain, business-platform, business-services, cardano-ecosystem, celo-ecosystem, centralized-exchange-token-cex, charity, cny-stablecoin, collectibles, communication, compound-tokens, cosmos-ecosystem, cryptocurrency, daomaker-ecosystem, decentralized-exchange, decentralized-finance-defi, defi-index, decentralized-derivatives, education, energy, entertainment, etf, eth-2-0-staking, eur-stablecoin, exchange-based-tokens, fan-token, fantom-ecosystem, finance-banking, fractionalized-nft, gambling, gaming, gbp-stablecoin, gig-economy, xdai-ecosystem, governance, guild-scholarship, harmony-ecosystem, healthcare, heco-chain-ecosystem, impossible-launchpad, index-coin, infrastructure, insurance, internet-of-things-iot, investment, iotex-ecosystem, kardiachain-ecosystem, krw-stablecoin, launchpad, layer-1, legal, lending-borrowing, leveraged-token, lp-tokens, manufacturing, marketing, masternodes, media, meme-token, metaverse, mev-protection, mirrored-assets, moonriver-ecosystem, music, near-protocol-ecosystem, nft-index, niftex-shards, non-fungible-tokens-nft, number, oec-ecosystem, ohm-fork, olympus-pro, decentralized-options, oracle, decentralized-perpetuals, play-to-earn, dot-ecosystem, polygon-ecosystem, prediction-markets, privacy-coins, protocol, real-estate, realt-tokens, rebase-tokens, reddit-points, remittance, retail, seigniorage, smart-contract-platform, social-money, software, solana-ecosystem, sports, stablecoins, storage, structured-products, synthetic-assets, synths, technology-science, terra-ecosystem, tokenized-btc, tokenized-gold, tokenized-products, tokenized-stock, tokensets, tourism, usd-stablecoin, us-election-2020, utokens, virtual-reality, wallets, wrapped-tokens, yearn-yfi-partnerships-mergers, yield-aggregator, yield-farming, zilliqa-ecosystem |
|
||||
| limit | Limit of records | 10 | True | None |
|
||||
| sortby | Sort by given column. Default: Market Cap Rank | Market Cap Rank | True | Symbol, Name, Volume [$], Market Cap, Market Cap Rank, 7D Change [%], 24H Change [%] |
|
||||
| reverse | Data is sorted in descending order by default. Reverse flag will sort it in an ascending way. Only works when raw data is displayed. | False | True | None |
|
||||
---
|
||||
|
||||
|
||||
@@ -1,23 +1,23 @@
|
||||
---
|
||||
title: trending
|
||||
description: OpenBB Terminal Function
|
||||
---
|
||||
|
||||
# trending
|
||||
|
||||
Discover trending coins (Top-7) on CoinGecko in the last 24 hours
|
||||
|
||||
### Usage
|
||||
|
||||
```python
|
||||
usage: trending
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Parameters
|
||||
|
||||
This command has no parameters
|
||||
|
||||
---
|
||||
|
||||
---
|
||||
title: trending
|
||||
description: OpenBB Terminal Function
|
||||
---
|
||||
|
||||
# trending
|
||||
|
||||
Discover trending coins (Top-7) on CoinGecko in the last 24 hours
|
||||
|
||||
### Usage
|
||||
|
||||
```python
|
||||
usage: trending
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Parameters
|
||||
|
||||
This command has no parameters
|
||||
|
||||
---
|
||||
|
||||
|
||||
@@ -1,26 +1,26 @@
|
||||
---
|
||||
title: active
|
||||
description: OpenBB Terminal Function
|
||||
---
|
||||
|
||||
# active
|
||||
|
||||
Display active blockchain addresses over time [Source: https://glassnode.org]
|
||||
|
||||
### Usage
|
||||
|
||||
```python
|
||||
usage: active [-i {24h,1w,1month}] [-s SINCE] [-u UNTIL]
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Parameters
|
||||
|
||||
| Name | Description | Default | Optional | Choices |
|
||||
| ---- | ----------- | ------- | -------- | ------- |
|
||||
| interval | Frequency interval. Default: 24h | 24h | True | 24h, 1w, 1month |
|
||||
| since | Initial date. Default: 1 year ago | 2021-11-22 | True | None |
|
||||
| until | Final date. Default: Today | 2022-11-22 | True | None |
|
||||
---
|
||||
|
||||
---
|
||||
title: active
|
||||
description: OpenBB Terminal Function
|
||||
---
|
||||
|
||||
# active
|
||||
|
||||
Display active blockchain addresses over time [Source: https://glassnode.org]
|
||||
|
||||
### Usage
|
||||
|
||||
```python
|
||||
usage: active [-i {24h,1w,1month}] [-s SINCE] [-u UNTIL]
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Parameters
|
||||
|
||||
| Name | Description | Default | Optional | Choices |
|
||||
| ---- | ----------- | ------- | -------- | ------- |
|
||||
| interval | Frequency interval. Default: 24h | 24h | True | 24h, 1w, 1month |
|
||||
| since | Initial date. Default: 1 year ago | 2021-11-22 | True | None |
|
||||
| until | Final date. Default: Today | 2022-11-22 | True | None |
|
||||
---
|
||||
|
||||
|
||||
@@ -1,24 +1,24 @@
|
||||
---
|
||||
title: ath
|
||||
description: OpenBB Terminal Function
|
||||
---
|
||||
|
||||
# ath
|
||||
|
||||
All time high data for loaded coin
|
||||
|
||||
### Usage
|
||||
|
||||
```python
|
||||
usage: ath [--vs {usd,btc}]
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Parameters
|
||||
|
||||
| Name | Description | Default | Optional | Choices |
|
||||
| ---- | ----------- | ------- | -------- | ------- |
|
||||
| vs | currency | usd | True | usd, btc |
|
||||
---
|
||||
|
||||
---
|
||||
title: ath
|
||||
description: OpenBB Terminal Function
|
||||
---
|
||||
|
||||
# ath
|
||||
|
||||
All time high data for loaded coin
|
||||
|
||||
### Usage
|
||||
|
||||
```python
|
||||
usage: ath [--vs {usd,btc}]
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Parameters
|
||||
|
||||
| Name | Description | Default | Optional | Choices |
|
||||
| ---- | ----------- | ------- | -------- | ------- |
|
||||
| vs | currency | usd | True | usd, btc |
|
||||
---
|
||||
|
||||
|
||||
@@ -1,24 +1,24 @@
|
||||
---
|
||||
title: atl
|
||||
description: OpenBB Terminal Function
|
||||
---
|
||||
|
||||
# atl
|
||||
|
||||
All time low data for loaded coin
|
||||
|
||||
### Usage
|
||||
|
||||
```python
|
||||
usage: atl [--vs {usd,btc}]
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Parameters
|
||||
|
||||
| Name | Description | Default | Optional | Choices |
|
||||
| ---- | ----------- | ------- | -------- | ------- |
|
||||
| vs | currency | usd | True | usd, btc |
|
||||
---
|
||||
|
||||
---
|
||||
title: atl
|
||||
description: OpenBB Terminal Function
|
||||
---
|
||||
|
||||
# atl
|
||||
|
||||
All time low data for loaded coin
|
||||
|
||||
### Usage
|
||||
|
||||
```python
|
||||
usage: atl [--vs {usd,btc}]
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Parameters
|
||||
|
||||
| Name | Description | Default | Optional | Choices |
|
||||
| ---- | ----------- | ------- | -------- | ------- |
|
||||
| vs | currency | usd | True | usd, btc |
|
||||
---
|
||||
|
||||
|
||||
@@ -1,24 +1,24 @@
|
||||
---
|
||||
title: balance
|
||||
description: OpenBB Terminal Function
|
||||
---
|
||||
|
||||
# balance
|
||||
|
||||
Display balance
|
||||
|
||||
### Usage
|
||||
|
||||
```python
|
||||
usage: balance [--vs VS]
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Parameters
|
||||
|
||||
| Name | Description | Default | Optional | Choices |
|
||||
| ---- | ----------- | ------- | -------- | ------- |
|
||||
| vs | Quote currency (what to view coin vs) | USDT | True | None |
|
||||
---
|
||||
|
||||
---
|
||||
title: balance
|
||||
description: OpenBB Terminal Function
|
||||
---
|
||||
|
||||
# balance
|
||||
|
||||
Display balance
|
||||
|
||||
### Usage
|
||||
|
||||
```python
|
||||
usage: balance [--vs {USDT,BUSD,RUB,TRY,EUR,ZAR,GBP,UAH,BIDR,AUD,DAI,BRL,PLN}]
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Parameters
|
||||
|
||||
| Name | Description | Default | Optional | Choices |
|
||||
| ---- | ----------- | ------- | -------- | ------- |
|
||||
| vs | Quote currency (what to view coin vs) | USDT | True | USDT, BUSD, RUB, TRY, EUR, ZAR, GBP, UAH, BIDR, AUD, DAI, BRL, PLN |
|
||||
---
|
||||
|
||||
|
||||
@@ -1,23 +1,23 @@
|
||||
---
|
||||
title: basic
|
||||
description: OpenBB Terminal Function
|
||||
---
|
||||
|
||||
# basic
|
||||
|
||||
Get basic information for coin. Like: name, symbol, rank, type, description, platform, proof_type, contract, tags, parent
|
||||
|
||||
### Usage
|
||||
|
||||
```python
|
||||
usage: basic
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Parameters
|
||||
|
||||
This command has no parameters
|
||||
|
||||
---
|
||||
|
||||
---
|
||||
title: basic
|
||||
description: OpenBB Terminal Function
|
||||
---
|
||||
|
||||
# basic
|
||||
|
||||
Get basic information for coin. Like: name, symbol, rank, type, description, platform, proof_type, contract, tags, parent
|
||||
|
||||
### Usage
|
||||
|
||||
```python
|
||||
usage: basic
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Parameters
|
||||
|
||||
This command has no parameters
|
||||
|
||||
---
|
||||
|
||||
|
||||
@@ -1,23 +1,23 @@
|
||||
---
|
||||
title: bc
|
||||
description: OpenBB Terminal Function
|
||||
---
|
||||
|
||||
# bc
|
||||
|
||||
Blockchain explorers URLs for loaded coin. Those are sites like etherescan.io or polkascan.io in which you can see all blockchain data e.g. all txs, all tokens, all contracts...
|
||||
|
||||
### Usage
|
||||
|
||||
```python
|
||||
usage: bc
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Parameters
|
||||
|
||||
This command has no parameters
|
||||
|
||||
---
|
||||
|
||||
---
|
||||
title: bc
|
||||
description: OpenBB Terminal Function
|
||||
---
|
||||
|
||||
# bc
|
||||
|
||||
Blockchain explorers URLs for loaded coin. Those are sites like etherescan.io or polkascan.io in which you can see all blockchain data e.g. all txs, all tokens, all contracts...
|
||||
|
||||
### Usage
|
||||
|
||||
```python
|
||||
usage: bc
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Parameters
|
||||
|
||||
This command has no parameters
|
||||
|
||||
---
|
||||
|
||||
|
||||
@@ -1,26 +1,28 @@
|
||||
---
|
||||
title: change
|
||||
description: OpenBB Terminal Function
|
||||
---
|
||||
|
||||
# change
|
||||
|
||||
Display active blockchain addresses over time [Source: https://glassnode.org] Note that free api keys only allow fetching data with a 1y lag
|
||||
|
||||
### Usage
|
||||
|
||||
```python
|
||||
usage: change [-e {aggregated,binance,bittrex,coinex,gate.io,gemini,huobi,kucoin,poloniex,bibox,bigone,bitfinex,hitbtc,kraken,okex,bithumb,zb.com,cobinhood,bitmex,bitstamp,coinbase,coincheck,luno}] [-s SINCE] [-u UNTIL]
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Parameters
|
||||
|
||||
| Name | Description | Default | Optional | Choices |
|
||||
| ---- | ----------- | ------- | -------- | ------- |
|
||||
| exchange | Exchange to check change. Default: aggregated | aggregated | True | aggregated, binance, bittrex, coinex, gate.io, gemini, huobi, kucoin, poloniex, bibox, bigone, bitfinex, hitbtc, kraken, okex, bithumb, zb.com, cobinhood, bitmex, bitstamp, coinbase, coincheck, luno |
|
||||
| since | Initial date. Default: 2 years ago | 2020-11-22 | True | None |
|
||||
| until | Final date. Default: 1 year ago | 2021-11-20 | True | None |
|
||||
---
|
||||
|
||||
---
|
||||
title: change
|
||||
description: OpenBB Terminal Function
|
||||
---
|
||||
|
||||
# change
|
||||
|
||||
Display active blockchain addresses over time [Source: https://glassnode.org] Note that free api keys only allow fetching data with a 1y lag
|
||||
|
||||
### Usage
|
||||
|
||||
```python
|
||||
usage: change
|
||||
[-e {aggregated,binance,bittrex,coinex,gate.io,gemini,huobi,kucoin,poloniex,bibox,bigone,bitfinex,hitbtc,kraken,okex,bithumb,zb.com,cobinhood,bitmex,bitstamp,coinbase,coincheck,luno}]
|
||||
[-s SINCE] [-u UNTIL]
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Parameters
|
||||
|
||||
| Name | Description | Default | Optional | Choices |
|
||||
| ---- | ----------- | ------- | -------- | ------- |
|
||||
| exchange | Exchange to check change. Default: aggregated | aggregated | True | aggregated, binance, bittrex, coinex, gate.io, gemini, huobi, kucoin, poloniex, bibox, bigone, bitfinex, hitbtc, kraken, okex, bithumb, zb.com, cobinhood, bitmex, bitstamp, coinbase, coincheck, luno |
|
||||
| since | Initial date. Default: 2 years ago | 2020-11-22 | True | None |
|
||||
| until | Final date. Default: 1 year ago | 2021-11-20 | True | None |
|
||||
---
|
||||
|
||||
|
||||
@@ -1,25 +1,25 @@
|
||||
---
|
||||
title: desc
|
||||
description: OpenBB Terminal Function
|
||||
---
|
||||
|
||||
# desc
|
||||
|
||||
Display project description [Source: Token Terminal]
|
||||
|
||||
### Usage
|
||||
|
||||
```python
|
||||
usage: desc -p
|
||||
{0x,1inch,88mph,aave,abracadabra-money,alchemist,alchemix-finance,algorand,alpha-finance,arweave,autofarm,avalanche,axie-infinity,balancer,bancor,barnbridge,basket-dao,benqi,binance-smart-chain,bitcoin,cap,cardano,centrifuge,clipper,compound,convex-finance,cosmos,cryptex,curve,decentral-games,decred,dforce,dhedge,dodo,dogecoin,dydx,ellipsis-finance,elrond,enzyme-finance,erasure-protocol,ethereum,ethereum-name-service,euler,fantom,fei-protocol,filecoin,futureswap,gmx,goldfinch,harvest-finance,helium,hurricaneswap,idle-finance,index-cooperative,instadapp,integral-protocol,karura,keeperdao,keep-network,kusama,kyber,lido-finance,liquity,litecoin,livepeer,looksrare,loopring,maiar,makerdao,maple-finance,mcdex,metamask,mstable,near-protocol,nexus-mutual,nftx,notional-finance,opensea,optimism,osmosis,pancakeswap,pangolin,perpetual-protocol,piedao,pocket-network,polkadot,polygon,polymarket,pooltogether,powerpool,quickswap,rarible,rari-capital,reflexer,ren,ribbon-finance,rocket-pool,saddle-finance,set-protocol,solana,solend,spookyswap,stake-dao,stellar,sushiswap,synthetix,terra,tezos,the-graph,thorchain,tokemak,tokenlon,tornado-cash,trader-joe,uma,uniswap,unit-protocol,venus,vesper-finance,volmex,wakaswap,yearn-finance,yield-guild-games,yield-yak,zcash,zora}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Parameters
|
||||
|
||||
| Name | Description | Default | Optional | Choices |
|
||||
| ---- | ----------- | ------- | -------- | ------- |
|
||||
| project | Choose project of interest | None | False | 0x, 1inch, 88mph, aave, abracadabra-money, alchemist, alchemix-finance, algorand, alpha-finance, arweave, autofarm, avalanche, axie-infinity, balancer, bancor, barnbridge, basket-dao, benqi, binance-smart-chain, bitcoin, cap, cardano, centrifuge, clipper, compound, convex-finance, cosmos, cryptex, curve, decentral-games, decred, dforce, dhedge, dodo, dogecoin, dydx, ellipsis-finance, elrond, enzyme-finance, erasure-protocol, ethereum, ethereum-name-service, euler, fantom, fei-protocol, filecoin, futureswap, gmx, goldfinch, harvest-finance, helium, hurricaneswap, idle-finance, index-cooperative, instadapp, integral-protocol, karura, keeperdao, keep-network, kusama, kyber, lido-finance, liquity, litecoin, livepeer, looksrare, loopring, maiar, makerdao, maple-finance, mcdex, metamask, mstable, near-protocol, nexus-mutual, nftx, notional-finance, opensea, optimism, osmosis, pancakeswap, pangolin, perpetual-protocol, piedao, pocket-network, polkadot, polygon, polymarket, pooltogether, powerpool, quickswap, rarible, rari-capital, reflexer, ren, ribbon-finance, rocket-pool, saddle-finance, set-protocol, solana, solend, spookyswap, stake-dao, stellar, sushiswap, synthetix, terra, tezos, the-graph, thorchain, tokemak, tokenlon, tornado-cash, trader-joe, uma, uniswap, unit-protocol, venus, vesper-finance, volmex, wakaswap, yearn-finance, yield-guild-games, yield-yak, zcash, zora |
|
||||
---
|
||||
|
||||
---
|
||||
title: desc
|
||||
description: OpenBB Terminal Function
|
||||
---
|
||||
|
||||
# desc
|
||||
|
||||
Display project description [Source: Token Terminal]
|
||||
|
||||
### Usage
|
||||
|
||||
```python
|
||||
usage: desc -p
|
||||
{0x,1inch,88mph,aave,abracadabra-money,alchemist,alchemix-finance,algorand,alpha-finance,arweave,autofarm,avalanche,axie-infinity,balancer,bancor,barnbridge,basket-dao,benqi,binance-smart-chain,bitcoin,cap,cardano,centrifuge,clipper,compound,convex-finance,cosmos,cryptex,curve,decentral-games,decred,dforce,dhedge,dodo,dogecoin,dydx,ellipsis-finance,elrond,enzyme-finance,erasure-protocol,ethereum,ethereum-name-service,euler,fantom,fei-protocol,filecoin,futureswap,gmx,goldfinch,harvest-finance,helium,hurricaneswap,idle-finance,index-cooperative,instadapp,integral-protocol,karura,keeperdao,keep-network,kusama,kyber,lido-finance,liquity,litecoin,livepeer,looksrare,loopring,maiar,makerdao,maple-finance,mcdex,metamask,mstable,near-protocol,nexus-mutual,nftx,notional-finance,opensea,optimism,osmosis,pancakeswap,pangolin,perpetual-protocol,piedao,pocket-network,polkadot,polygon,polymarket,pooltogether,powerpool,quickswap,rarible,rari-capital,reflexer,ren,ribbon-finance,rocket-pool,saddle-finance,set-protocol,solana,solend,spookyswap,stake-dao,stellar,sushiswap,synthetix,terra,tezos,the-graph,thorchain,tokemak,tokenlon,tornado-cash,trader-joe,uma,uniswap,unit-protocol,venus,vesper-finance,volmex,wakaswap,yearn-finance,yield-guild-games,yield-yak,zcash,zora}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Parameters
|
||||
|
||||
| Name | Description | Default | Optional | Choices |
|
||||
| ---- | ----------- | ------- | -------- | ------- |
|
||||
| project | Choose project of interest | None | False | 0x, 1inch, 88mph, aave, abracadabra-money, alchemist, alchemix-finance, algorand, alpha-finance, arweave, autofarm, avalanche, axie-infinity, balancer, bancor, barnbridge, basket-dao, benqi, binance-smart-chain, bitcoin, cap, cardano, centrifuge, clipper, compound, convex-finance, cosmos, cryptex, curve, decentral-games, decred, dforce, dhedge, dodo, dogecoin, dydx, ellipsis-finance, elrond, enzyme-finance, erasure-protocol, ethereum, ethereum-name-service, euler, fantom, fei-protocol, filecoin, futureswap, gmx, goldfinch, harvest-finance, helium, hurricaneswap, idle-finance, index-cooperative, instadapp, integral-protocol, karura, keeperdao, keep-network, kusama, kyber, lido-finance, liquity, litecoin, livepeer, looksrare, loopring, maiar, makerdao, maple-finance, mcdex, metamask, mstable, near-protocol, nexus-mutual, nftx, notional-finance, opensea, optimism, osmosis, pancakeswap, pangolin, perpetual-protocol, piedao, pocket-network, polkadot, polygon, polymarket, pooltogether, powerpool, quickswap, rarible, rari-capital, reflexer, ren, ribbon-finance, rocket-pool, saddle-finance, set-protocol, solana, solend, spookyswap, stake-dao, stellar, sushiswap, synthetix, terra, tezos, the-graph, thorchain, tokemak, tokenlon, tornado-cash, trader-joe, uma, uniswap, unit-protocol, venus, vesper-finance, volmex, wakaswap, yearn-finance, yield-guild-games, yield-yak, zcash, zora |
|
||||
---
|
||||
|
||||
|
||||
@@ -1,23 +1,23 @@
|
||||
---
|
||||
title: dev
|
||||
description: OpenBB Terminal Function
|
||||
---
|
||||
|
||||
# dev
|
||||
|
||||
Developers data for loaded coin. If the development data is available you can see how the code development of given coin is going on. There are some statistics that shows number of stars, forks, subscribers, pull requests, commits, merges, contributors on github.
|
||||
|
||||
### Usage
|
||||
|
||||
```python
|
||||
usage: dev
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Parameters
|
||||
|
||||
This command has no parameters
|
||||
|
||||
---
|
||||
|
||||
---
|
||||
title: dev
|
||||
description: OpenBB Terminal Function
|
||||
---
|
||||
|
||||
# dev
|
||||
|
||||
Developers data for loaded coin. If the development data is available you can see how the code development of given coin is going on. There are some statistics that shows number of stars, forks, subscribers, pull requests, commits, merges, contributors on github.
|
||||
|
||||
### Usage
|
||||
|
||||
```python
|
||||
usage: dev
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Parameters
|
||||
|
||||
This command has no parameters
|
||||
|
||||
---
|
||||
|
||||
|
||||
@@ -1,27 +1,29 @@
|
||||
---
|
||||
title: eb
|
||||
description: OpenBB Terminal Function
|
||||
---
|
||||
|
||||
# eb
|
||||
|
||||
Display active blockchain addresses over time [Source: https://glassnode.org] Note that free api keys only allow fetching data with a 1y lag
|
||||
|
||||
### Usage
|
||||
|
||||
```python
|
||||
usage: eb [-p] [-e {aggregated,binance,bittrex,coinex,gate.io,gemini,huobi,kucoin,poloniex,bibox,bigone,bitfinex,hitbtc,kraken,okex,bithumb,zb.com,cobinhood,bitmex,bitstamp,coinbase,coincheck,luno}] [-s SINCE] [-u UNTIL]
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Parameters
|
||||
|
||||
| Name | Description | Default | Optional | Choices |
|
||||
| ---- | ----------- | ------- | -------- | ------- |
|
||||
| percentage | Show percentage instead of stacked value. Default: False | False | True | None |
|
||||
| exchange | Exchange to check change. Default: aggregated | aggregated | True | aggregated, binance, bittrex, coinex, gate.io, gemini, huobi, kucoin, poloniex, bibox, bigone, bitfinex, hitbtc, kraken, okex, bithumb, zb.com, cobinhood, bitmex, bitstamp, coinbase, coincheck, luno |
|
||||
| since | Initial date. Default: 2 years ago | 2020-11-22 | True | None |
|
||||
| until | Final date. Default: 1 year ago | 2021-11-20 | True | None |
|
||||
---
|
||||
|
||||
---
|
||||
title: eb
|
||||
description: OpenBB Terminal Function
|
||||
---
|
||||
|
||||
# eb
|
||||
|
||||
Display active blockchain addresses over time [Source: https://glassnode.org] Note that free api keys only allow fetching data with a 1y lag
|
||||
|
||||
### Usage
|
||||
|
||||
```python
|
||||
usage: eb [-p]
|
||||
[-e {aggregated,binance,bittrex,coinex,gate.io,gemini,huobi,kucoin,poloniex,bibox,bigone,bitfinex,hitbtc,kraken,okex,bithumb,zb.com,cobinhood,bitmex,bitstamp,coinbase,coincheck,luno}]
|
||||
[-s SINCE] [-u UNTIL]
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Parameters
|
||||
|
||||
| Name | Description | Default | Optional | Choices |
|
||||
| ---- | ----------- | ------- | -------- | ------- |
|
||||
| percentage | Show percentage instead of stacked value. Default: False | False | True | None |
|
||||
| exchange | Exchange to check change. Default: aggregated | aggregated | True | aggregated, binance, bittrex, coinex, gate.io, gemini, huobi, kucoin, poloniex, bibox, bigone, bitfinex, hitbtc, kraken, okex, bithumb, zb.com, cobinhood, bitmex, bitstamp, coinbase, coincheck, luno |
|
||||
| since | Initial date. Default: 2 years ago | 2020-11-22 | True | None |
|
||||
| until | Final date. Default: 1 year ago | 2021-11-20 | True | None |
|
||||
---
|
||||
|
||||
|
||||
@@ -1,27 +1,27 @@
|
||||
---
|
||||
title: events
|
||||
description: OpenBB Terminal Function
|
||||
---
|
||||
|
||||
# events
|
||||
|
||||
Show information about most important coins events. Most of coins doesn't have any events. You can display only top N number of events with --limit parameter. You can sort data by id, date , date_to, name, description, is_conference --sort parameter and also with --reverse flag to sort ascending. You can use additional flag --urls to see urls for each event Displays: date , date_to, name, description, is_conference, link, proof_image_link
|
||||
|
||||
### Usage
|
||||
|
||||
```python
|
||||
usage: events [-l LIMIT] [-s {date,date_to,name,description,is_conference}] [-r] [-u]
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Parameters
|
||||
|
||||
| Name | Description | Default | Optional | Choices |
|
||||
| ---- | ----------- | ------- | -------- | ------- |
|
||||
| limit | Limit of records | 10 | True | None |
|
||||
| sortby | Sort by given column. Default: date | date | True | date, date_to, name, description, is_conference |
|
||||
| reverse | Data is sorted in descending order by default. Reverse flag will sort it in an ascending way. Only works when raw data is displayed. | False | True | None |
|
||||
| urls | Flag to show urls. If you will use that flag you will see only date, name, link columns | False | True | None |
|
||||
---
|
||||
|
||||
---
|
||||
title: events
|
||||
description: OpenBB Terminal Function
|
||||
---
|
||||
|
||||
# events
|
||||
|
||||
Show information about most important coins events. Most of coins doesn't have any events. You can display only top N number of events with --limit parameter. You can sort data by id, date , date_to, name, description, is_conference --sort parameter and also with --reverse flag to sort ascending. You can use additional flag --urls to see urls for each event Displays: date , date_to, name, description, is_conference, link, proof_image_link
|
||||
|
||||
### Usage
|
||||
|
||||
```python
|
||||
usage: events [-l LIMIT] [-s {date,date_to,name,description,is_conference}] [-r] [-u]
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Parameters
|
||||
|
||||
| Name | Description | Default | Optional | Choices |
|
||||
| ---- | ----------- | ------- | -------- | ------- |
|
||||
| limit | Limit of records | 10 | True | None |
|
||||
| sortby | Sort by given column. Default: date | date | True | date, date_to, name, description, is_conference |
|
||||
| reverse | Data is sorted in descending order by default. Reverse flag will sort it in an ascending way. Only works when raw data is displayed. | False | True | None |
|
||||
| urls | Flag to show urls. If you will use that flag you will see only date, name, link columns | False | True | None |
|
||||
---
|
||||
|
||||
|
||||
@@ -1,26 +1,26 @@
|
||||
---
|
||||
title: ex
|
||||
description: OpenBB Terminal Function
|
||||
---
|
||||
|
||||
# ex
|
||||
|
||||
Get all exchanges found for given coin. You can display only top N number of exchanges with --top parameter. You can sort data by id, name, adjusted_volume_24h_share, fiats --sort parameter and also with --reverse flag to sort ascending. Displays: id, name, adjusted_volume_24h_share, fiats
|
||||
|
||||
### Usage
|
||||
|
||||
```python
|
||||
usage: ex [-l LIMIT] [-s {id,name,adjusted_volume_24h_share,fiats}] [-r]
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Parameters
|
||||
|
||||
| Name | Description | Default | Optional | Choices |
|
||||
| ---- | ----------- | ------- | -------- | ------- |
|
||||
| limit | Limit of records | 10 | True | None |
|
||||
| sortby | Sort by given column. Default: date | adjusted_volume_24h_share | True | id, name, adjusted_volume_24h_share, fiats |
|
||||
| reverse | Data is sorted in descending order by default. Reverse flag will sort it in an ascending way. Only works when raw data is displayed. | False | True | None |
|
||||
---
|
||||
|
||||
---
|
||||
title: ex
|
||||
description: OpenBB Terminal Function
|
||||
---
|
||||
|
||||
# ex
|
||||
|
||||
Get all exchanges found for given coin. You can display only top N number of exchanges with --top parameter. You can sort data by id, name, adjusted_volume_24h_share, fiats --sort parameter and also with --reverse flag to sort ascending. Displays: id, name, adjusted_volume_24h_share, fiats
|
||||
|
||||
### Usage
|
||||
|
||||
```python
|
||||
usage: ex [-l LIMIT] [-s {id,name,adjusted_volume_24h_share,fiats}] [-r]
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Parameters
|
||||
|
||||
| Name | Description | Default | Optional | Choices |
|
||||
| ---- | ----------- | ------- | -------- | ------- |
|
||||
| limit | Limit of records | 10 | True | None |
|
||||
| sortby | Sort by given column. Default: date | adjusted_volume_24h_share | True | id, name, adjusted_volume_24h_share, fiats |
|
||||
| reverse | Data is sorted in descending order by default. Reverse flag will sort it in an ascending way. Only works when raw data is displayed. | False | True | None |
|
||||
---
|
||||
|
||||
|
||||
@@ -1,23 +1,23 @@
|
||||
---
|
||||
title: fr
|
||||
description: OpenBB Terminal Function
|
||||
---
|
||||
|
||||
# fr
|
||||
|
||||
Display asset's fundraising details [Source: https://messari.io]
|
||||
|
||||
### Usage
|
||||
|
||||
```python
|
||||
usage: fr
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Parameters
|
||||
|
||||
This command has no parameters
|
||||
|
||||
---
|
||||
|
||||
---
|
||||
title: fr
|
||||
description: OpenBB Terminal Function
|
||||
---
|
||||
|
||||
# fr
|
||||
|
||||
Display asset's fundraising details [Source: https://messari.io]
|
||||
|
||||
### Usage
|
||||
|
||||
```python
|
||||
usage: fr
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Parameters
|
||||
|
||||
This command has no parameters
|
||||
|
||||
---
|
||||
|
||||
|
||||
@@ -1,23 +1,23 @@
|
||||
---
|
||||
title: fundrate
|
||||
description: OpenBB Terminal Function
|
||||
---
|
||||
|
||||
# fundrate
|
||||
|
||||
Displays funding rate by exchange for a certain asset [Source: https://coinglass.github.io/API-Reference/]
|
||||
|
||||
### Usage
|
||||
|
||||
```python
|
||||
usage: fundrate
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Parameters
|
||||
|
||||
This command has no parameters
|
||||
|
||||
---
|
||||
|
||||
---
|
||||
title: fundrate
|
||||
description: OpenBB Terminal Function
|
||||
---
|
||||
|
||||
# fundrate
|
||||
|
||||
Displays funding rate by exchange for a certain asset [Source: https://coinglass.github.io/API-Reference/]
|
||||
|
||||
### Usage
|
||||
|
||||
```python
|
||||
usage: fundrate
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Parameters
|
||||
|
||||
This command has no parameters
|
||||
|
||||
---
|
||||
|
||||
|
||||
@@ -1,26 +1,26 @@
|
||||
---
|
||||
title: funot
|
||||
description: OpenBB Terminal Function
|
||||
---
|
||||
|
||||
# funot
|
||||
|
||||
Display fundamental metric over time [Source: Token Terminal]
|
||||
|
||||
### Usage
|
||||
|
||||
```python
|
||||
usage: funot [-m {twitter_followers,gmv_annualized,market_cap,take_rate,revenue,revenue_protocol,tvl,pe,pe_circulating,ps,ps_circulating}] -p
|
||||
{0x,1inch,88mph,aave,abracadabra-money,alchemist,alchemix-finance,algorand,alpha-finance,arweave,autofarm,avalanche,axie-infinity,balancer,bancor,barnbridge,basket-dao,benqi,binance-smart-chain,bitcoin,cap,cardano,centrifuge,clipper,compound,convex-finance,cosmos,cryptex,curve,decentral-games,decred,dforce,dhedge,dodo,dogecoin,dydx,ellipsis-finance,elrond,enzyme-finance,erasure-protocol,ethereum,ethereum-name-service,euler,fantom,fei-protocol,filecoin,futureswap,gmx,goldfinch,harvest-finance,helium,hurricaneswap,idle-finance,index-cooperative,instadapp,integral-protocol,karura,keeperdao,keep-network,kusama,kyber,lido-finance,liquity,litecoin,livepeer,looksrare,loopring,maiar,makerdao,maple-finance,mcdex,metamask,mstable,near-protocol,nexus-mutual,nftx,notional-finance,opensea,optimism,osmosis,pancakeswap,pangolin,perpetual-protocol,piedao,pocket-network,polkadot,polygon,polymarket,pooltogether,powerpool,quickswap,rarible,rari-capital,reflexer,ren,ribbon-finance,rocket-pool,saddle-finance,set-protocol,solana,solend,spookyswap,stake-dao,stellar,sushiswap,synthetix,terra,tezos,the-graph,thorchain,tokemak,tokenlon,tornado-cash,trader-joe,uma,uniswap,unit-protocol,venus,vesper-finance,volmex,wakaswap,yearn-finance,yield-guild-games,yield-yak,zcash,zora}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Parameters
|
||||
|
||||
| Name | Description | Default | Optional | Choices |
|
||||
| ---- | ----------- | ------- | -------- | ------- |
|
||||
| metric | Choose metric of interest | | True | twitter_followers, gmv_annualized, market_cap, take_rate, revenue, revenue_protocol, tvl, pe, pe_circulating, ps, ps_circulating |
|
||||
| project | Choose project of interest | None | False | 0x, 1inch, 88mph, aave, abracadabra-money, alchemist, alchemix-finance, algorand, alpha-finance, arweave, autofarm, avalanche, axie-infinity, balancer, bancor, barnbridge, basket-dao, benqi, binance-smart-chain, bitcoin, cap, cardano, centrifuge, clipper, compound, convex-finance, cosmos, cryptex, curve, decentral-games, decred, dforce, dhedge, dodo, dogecoin, dydx, ellipsis-finance, elrond, enzyme-finance, erasure-protocol, ethereum, ethereum-name-service, euler, fantom, fei-protocol, filecoin, futureswap, gmx, goldfinch, harvest-finance, helium, hurricaneswap, idle-finance, index-cooperative, instadapp, integral-protocol, karura, keeperdao, keep-network, kusama, kyber, lido-finance, liquity, litecoin, livepeer, looksrare, loopring, maiar, makerdao, maple-finance, mcdex, metamask, mstable, near-protocol, nexus-mutual, nftx, notional-finance, opensea, optimism, osmosis, pancakeswap, pangolin, perpetual-protocol, piedao, pocket-network, polkadot, polygon, polymarket, pooltogether, powerpool, quickswap, rarible, rari-capital, reflexer, ren, ribbon-finance, rocket-pool, saddle-finance, set-protocol, solana, solend, spookyswap, stake-dao, stellar, sushiswap, synthetix, terra, tezos, the-graph, thorchain, tokemak, tokenlon, tornado-cash, trader-joe, uma, uniswap, unit-protocol, venus, vesper-finance, volmex, wakaswap, yearn-finance, yield-guild-games, yield-yak, zcash, zora |
|
||||
---
|
||||
|
||||
---
|
||||
title: funot
|
||||
description: OpenBB Terminal Function
|
||||
---
|
||||
|
||||
# funot
|
||||
|
||||
Display fundamental metric over time [Source: Token Terminal]
|
||||
|
||||
### Usage
|
||||
|
||||
```python
|
||||
usage: funot [-m {twitter_followers,gmv_annualized,market_cap,take_rate,revenue,revenue_protocol,tvl,pe,pe_circulating,ps,ps_circulating}] -p
|
||||
{0x,1inch,88mph,aave,abracadabra-money,alchemist,alchemix-finance,algorand,alpha-finance,arweave,autofarm,avalanche,axie-infinity,balancer,bancor,barnbridge,basket-dao,benqi,binance-smart-chain,bitcoin,cap,cardano,centrifuge,clipper,compound,convex-finance,cosmos,cryptex,curve,decentral-games,decred,dforce,dhedge,dodo,dogecoin,dydx,ellipsis-finance,elrond,enzyme-finance,erasure-protocol,ethereum,ethereum-name-service,euler,fantom,fei-protocol,filecoin,futureswap,gmx,goldfinch,harvest-finance,helium,hurricaneswap,idle-finance,index-cooperative,instadapp,integral-protocol,karura,keeperdao,keep-network,kusama,kyber,lido-finance,liquity,litecoin,livepeer,looksrare,loopring,maiar,makerdao,maple-finance,mcdex,metamask,mstable,near-protocol,nexus-mutual,nftx,notional-finance,opensea,optimism,osmosis,pancakeswap,pangolin,perpetual-protocol,piedao,pocket-network,polkadot,polygon,polymarket,pooltogether,powerpool,quickswap,rarible,rari-capital,reflexer,ren,ribbon-finance,rocket-pool,saddle-finance,set-protocol,solana,solend,spookyswap,stake-dao,stellar,sushiswap,synthetix,terra,tezos,the-graph,thorchain,tokemak,tokenlon,tornado-cash,trader-joe,uma,uniswap,unit-protocol,venus,vesper-finance,volmex,wakaswap,yearn-finance,yield-guild-games,yield-yak,zcash,zora}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Parameters
|
||||
|
||||
| Name | Description | Default | Optional | Choices |
|
||||
| ---- | ----------- | ------- | -------- | ------- |
|
||||
| metric | Choose metric of interest | | True | twitter_followers, gmv_annualized, market_cap, take_rate, revenue, revenue_protocol, tvl, pe, pe_circulating, ps, ps_circulating |
|
||||
| project | Choose project of interest | None | False | 0x, 1inch, 88mph, aave, abracadabra-money, alchemist, alchemix-finance, algorand, alpha-finance, arweave, autofarm, avalanche, axie-infinity, balancer, bancor, barnbridge, basket-dao, benqi, binance-smart-chain, bitcoin, cap, cardano, centrifuge, clipper, compound, convex-finance, cosmos, cryptex, curve, decentral-games, decred, dforce, dhedge, dodo, dogecoin, dydx, ellipsis-finance, elrond, enzyme-finance, erasure-protocol, ethereum, ethereum-name-service, euler, fantom, fei-protocol, filecoin, futureswap, gmx, goldfinch, harvest-finance, helium, hurricaneswap, idle-finance, index-cooperative, instadapp, integral-protocol, karura, keeperdao, keep-network, kusama, kyber, lido-finance, liquity, litecoin, livepeer, looksrare, loopring, maiar, makerdao, maple-finance, mcdex, metamask, mstable, near-protocol, nexus-mutual, nftx, notional-finance, opensea, optimism, osmosis, pancakeswap, pangolin, perpetual-protocol, piedao, pocket-network, polkadot, polygon, polymarket, pooltogether, powerpool, quickswap, rarible, rari-capital, reflexer, ren, ribbon-finance, rocket-pool, saddle-finance, set-protocol, solana, solend, spookyswap, stake-dao, stellar, sushiswap, synthetix, terra, tezos, the-graph, thorchain, tokemak, tokenlon, tornado-cash, trader-joe, uma, uniswap, unit-protocol, venus, vesper-finance, volmex, wakaswap, yearn-finance, yield-guild-games, yield-yak, zcash, zora |
|
||||
---
|
||||
|
||||
|
||||
@@ -1,27 +1,27 @@
|
||||
---
|
||||
title: gh
|
||||
description: OpenBB Terminal Function
|
||||
---
|
||||
|
||||
# gh
|
||||
|
||||
Display github activity over time for a given coin. Github activity includes the following actions: creating a Pull Request, an Issue, commenting on an issue / PR, and many more. See detailed definition at https://academy.santiment.net/metrics/development-activity/ [Source: https://santiment.net/]
|
||||
|
||||
### Usage
|
||||
|
||||
```python
|
||||
usage: gh [-i INTERVAL] [-d DEV] [-s START] [-end END]
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Parameters
|
||||
|
||||
| Name | Description | Default | Optional | Choices |
|
||||
| ---- | ----------- | ------- | -------- | ------- |
|
||||
| interval | Frequency interval. Default: 1d | 1d | True | None |
|
||||
| dev | Filter only for development activity. Default: False | False | True | None |
|
||||
| start | Initial date. Default: A year ago | 2021-11-22 | True | None |
|
||||
| end | End date. Default: Today | 2022-11-22 | True | None |
|
||||
---
|
||||
|
||||
---
|
||||
title: gh
|
||||
description: OpenBB Terminal Function
|
||||
---
|
||||
|
||||
# gh
|
||||
|
||||
Display github activity over time for a given coin. Github activity includes the following actions: creating a Pull Request, an Issue, commenting on an issue / PR, and many more. See detailed definition at https://academy.santiment.net/metrics/development-activity/ [Source: https://santiment.net/]
|
||||
|
||||
### Usage
|
||||
|
||||
```python
|
||||
usage: gh [-i INTERVAL] [-d DEV] [-s START] [-end END]
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Parameters
|
||||
|
||||
| Name | Description | Default | Optional | Choices |
|
||||
| ---- | ----------- | ------- | -------- | ------- |
|
||||
| interval | Frequency interval. Default: 1d | 1d | True | None |
|
||||
| dev | Filter only for development activity. Default: False | False | True | None |
|
||||
| start | Initial date. Default: A year ago | 2021-11-22 | True | None |
|
||||
| end | End date. Default: Today | 2022-11-22 | True | None |
|
||||
---
|
||||
|
||||
|
||||
@@ -1,23 +1,23 @@
|
||||
---
|
||||
title: gov
|
||||
description: OpenBB Terminal Function
|
||||
---
|
||||
|
||||
# gov
|
||||
|
||||
Display asset's governance [Source: https://messari.io]
|
||||
|
||||
### Usage
|
||||
|
||||
```python
|
||||
usage: gov
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Parameters
|
||||
|
||||
This command has no parameters
|
||||
|
||||
---
|
||||
|
||||
---
|
||||
title: gov
|
||||
description: OpenBB Terminal Function
|
||||
---
|
||||
|
||||
# gov
|
||||
|
||||
Display asset's governance [Source: https://messari.io]
|
||||
|
||||
### Usage
|
||||
|
||||
```python
|
||||
usage: gov
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Parameters
|
||||
|
||||
This command has no parameters
|
||||
|
||||
---
|
||||
|
||||
|
||||
@@ -1,23 +1,23 @@
|
||||
---
|
||||
title: info
|
||||
description: OpenBB Terminal Function
|
||||
---
|
||||
|
||||
# info
|
||||
|
||||
Shows basic information about loaded coin like: Name, Symbol, Description, Market Cap, Public Interest, Supply, and Price related metrics
|
||||
|
||||
### Usage
|
||||
|
||||
```python
|
||||
usage: info
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Parameters
|
||||
|
||||
This command has no parameters
|
||||
|
||||
---
|
||||
|
||||
---
|
||||
title: info
|
||||
description: OpenBB Terminal Function
|
||||
---
|
||||
|
||||
# info
|
||||
|
||||
Shows basic information about loaded coin like: Name, Symbol, Description, Market Cap, Public Interest, Supply, and Price related metrics
|
||||
|
||||
### Usage
|
||||
|
||||
```python
|
||||
usage: info
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Parameters
|
||||
|
||||
This command has no parameters
|
||||
|
||||
---
|
||||
|
||||
|
||||
@@ -1,23 +1,23 @@
|
||||
---
|
||||
title: inv
|
||||
description: OpenBB Terminal Function
|
||||
---
|
||||
|
||||
# inv
|
||||
|
||||
Display asset's investors [Source: https://messari.io]
|
||||
|
||||
### Usage
|
||||
|
||||
```python
|
||||
usage: inv
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Parameters
|
||||
|
||||
This command has no parameters
|
||||
|
||||
---
|
||||
|
||||
---
|
||||
title: inv
|
||||
description: OpenBB Terminal Function
|
||||
---
|
||||
|
||||
# inv
|
||||
|
||||
Display asset's investors [Source: https://messari.io]
|
||||
|
||||
### Usage
|
||||
|
||||
```python
|
||||
usage: inv
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Parameters
|
||||
|
||||
This command has no parameters
|
||||
|
||||
---
|
||||
|
||||
|
||||
@@ -1,23 +1,23 @@
|
||||
---
|
||||
title: links
|
||||
description: OpenBB Terminal Function
|
||||
---
|
||||
|
||||
# links
|
||||
|
||||
Display asset's links [Source: https://messari.io]
|
||||
|
||||
### Usage
|
||||
|
||||
```python
|
||||
usage: links
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Parameters
|
||||
|
||||
This command has no parameters
|
||||
|
||||
---
|
||||
|
||||
---
|
||||
title: links
|
||||
description: OpenBB Terminal Function
|
||||
---
|
||||
|
||||
# links
|
||||
|
||||
Display asset's links [Source: https://messari.io]
|
||||
|
||||
### Usage
|
||||
|
||||
```python
|
||||
usage: links
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Parameters
|
||||
|
||||
This command has no parameters
|
||||
|
||||
---
|
||||
|
||||
|
||||
@@ -1,23 +1,23 @@
|
||||
---
|
||||
title: liquidations
|
||||
description: OpenBB Terminal Function
|
||||
---
|
||||
|
||||
# liquidations
|
||||
|
||||
Displays liquidations data for the loaded crypto asset [Source: https://coinglass.github.io/API-Reference/#liquidation-chart]
|
||||
|
||||
### Usage
|
||||
|
||||
```python
|
||||
usage: liquidations
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Parameters
|
||||
|
||||
This command has no parameters
|
||||
|
||||
---
|
||||
|
||||
---
|
||||
title: liquidations
|
||||
description: OpenBB Terminal Function
|
||||
---
|
||||
|
||||
# liquidations
|
||||
|
||||
Displays liquidations data for the loaded crypto asset [Source: https://coinglass.github.io/API-Reference/#liquidation-chart]
|
||||
|
||||
### Usage
|
||||
|
||||
```python
|
||||
usage: liquidations
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Parameters
|
||||
|
||||
This command has no parameters
|
||||
|
||||
---
|
||||
|
||||
|
||||
@@ -1,31 +1,31 @@
|
||||
---
|
||||
title: load
|
||||
description: OpenBB Terminal Function
|
||||
---
|
||||
|
||||
# load
|
||||
|
||||
Load crypto currency to perform analysis on. Yahoo Finance is used as default source. Other sources can be used such as 'ccxt' or 'cg' with --source. If you select 'ccxt', you can then select any exchange with --exchange. You can also select a specific interval with --interval.
|
||||
|
||||
### Usage
|
||||
|
||||
```python
|
||||
usage: load -c COIN [-s START]
|
||||
[--exchange {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,bkex,bl3p,btcalpha,btcbox,btcex,btcmarkets,btctradeua,btcturk,buda,bw,bybit,bytetrade,cex,coinbaseprime,coinbasepro,coincheck,coinex,coinfalcon,coinmate,coinone,coinspot,crex24,cryptocom,currencycom,delta,deribit,digifinex,eqonex,exmo,flowbtc,fmfwio,ftx,ftxus,gate,gateio,gemini,hitbtc,hitbtc3,hollaex,huobi,huobijp,huobipro,idex,independentreserve,indodax,itbit,kraken,kucoin,kucoinfutures,kuna,latoken,lbank,lbank2,liquid,luno,lykke,mercado,mexc,mexc3,ndax,novadax,oceanex,okcoin,okex,okex5,okx,paymium,phemex,poloniex,probit,qtrade,ripio,stex,therock,tidebit,tidex,timex,tokocrypto,upbit,wavesexchange,whitebit,woo,yobit,zaif,zb,zipmex,zonda}]
|
||||
[-e END] [-i {1,5,15,30,60,240,1440,10080,43200}] [--vs VS]
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Parameters
|
||||
|
||||
| Name | Description | Default | Optional | Choices |
|
||||
| ---- | ----------- | ------- | -------- | ------- |
|
||||
| coin | Coin to get. Must be coin symbol (e.g., btc, eth) | None | False | None |
|
||||
| start | The starting date (format YYYY-MM-DD) of the crypto | 2019-11-18 | True | None |
|
||||
| exchange | Exchange to search | binance | True | 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, bkex, bl3p, btcalpha, btcbox, btcex, btcmarkets, btctradeua, btcturk, buda, bw, bybit, bytetrade, cex, coinbaseprime, coinbasepro, coincheck, coinex, coinfalcon, coinmate, coinone, coinspot, crex24, cryptocom, currencycom, delta, deribit, digifinex, eqonex, exmo, flowbtc, fmfwio, ftx, ftxus, gate, gateio, gemini, hitbtc, hitbtc3, hollaex, huobi, huobijp, huobipro, idex, independentreserve, indodax, itbit, kraken, kucoin, kucoinfutures, kuna, latoken, lbank, lbank2, liquid, luno, lykke, mercado, mexc, mexc3, ndax, novadax, oceanex, okcoin, okex, okex5, okx, paymium, phemex, poloniex, probit, qtrade, ripio, stex, therock, tidebit, tidex, timex, tokocrypto, upbit, wavesexchange, whitebit, woo, yobit, zaif, zb, zipmex, zonda |
|
||||
| end | The ending date (format YYYY-MM-DD) of the crypto | 2022-11-22 | True | None |
|
||||
| interval | The interval of the crypto | 1440 | True | 1, 5, 15, 30, 60, 240, 1440, 10080, 43200 |
|
||||
| vs | Quote currency (what to view coin vs). e.g., usdc, usdt, ... if source is ccxt, usd, eur, ... otherwise | usdt | True | None |
|
||||
---
|
||||
|
||||
---
|
||||
title: load
|
||||
description: OpenBB Terminal Function
|
||||
---
|
||||
|
||||
# load
|
||||
|
||||
Load crypto currency to perform analysis on. Yahoo Finance is used as default source. Other sources can be used such as 'ccxt' or 'cg' with --source. If you select 'ccxt', you can then select any exchange with --exchange. You can also select a specific interval with --interval.
|
||||
|
||||
### Usage
|
||||
|
||||
```python
|
||||
usage: load -c COIN [-s START]
|
||||
[--exchange {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,bkex,bl3p,btcalpha,btcbox,btcex,btcmarkets,btctradeua,btcturk,buda,bw,bybit,bytetrade,cex,coinbaseprime,coinbasepro,coincheck,coinex,coinfalcon,coinmate,coinone,coinspot,crex24,cryptocom,currencycom,delta,deribit,digifinex,eqonex,exmo,flowbtc,fmfwio,ftx,ftxus,gate,gateio,gemini,hitbtc,hitbtc3,hollaex,huobi,huobijp,huobipro,idex,independentreserve,indodax,itbit,kraken,kucoin,kucoinfutures,kuna,latoken,lbank,lbank2,liquid,luno,lykke,mercado,mexc,mexc3,ndax,novadax,oceanex,okcoin,okex,okex5,okx,paymium,phemex,poloniex,probit,qtrade,ripio,stex,therock,tidebit,tidex,timex,tokocrypto,upbit,wavesexchange,whitebit,woo,yobit,zaif,zb,zipmex,zonda}]
|
||||
[-e END] [-i {1,5,15,30,60,240,1440,10080,43200}] [--vs VS]
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Parameters
|
||||
|
||||
| Name | Description | Default | Optional | Choices |
|
||||
| ---- | ----------- | ------- | -------- | ------- |
|
||||
| coin | Coin to get. Must be coin symbol (e.g., btc, eth) | None | False | None |
|
||||
| start | The starting date (format YYYY-MM-DD) of the crypto | 2019-11-18 | True | None |
|
||||
| exchange | Exchange to search | binance | True | 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, bkex, bl3p, btcalpha, btcbox, btcex, btcmarkets, btctradeua, btcturk, buda, bw, bybit, bytetrade, cex, coinbaseprime, coinbasepro, coincheck, coinex, coinfalcon, coinmate, coinone, coinspot, crex24, cryptocom, currencycom, delta, deribit, digifinex, eqonex, exmo, flowbtc, fmfwio, ftx, ftxus, gate, gateio, gemini, hitbtc, hitbtc3, hollaex, huobi, huobijp, huobipro, idex, independentreserve, indodax, itbit, kraken, kucoin, kucoinfutures, kuna, latoken, lbank, lbank2, liquid, luno, lykke, mercado, mexc, mexc3, ndax, novadax, oceanex, okcoin, okex, okex5, okx, paymium, phemex, poloniex, probit, qtrade, ripio, stex, therock, tidebit, tidex, timex, tokocrypto, upbit, wavesexchange, whitebit, woo, yobit, zaif, zb, zipmex, zonda |
|
||||
| end | The ending date (format YYYY-MM-DD) of the crypto | 2022-11-22 | True | None |
|
||||
| interval | The interval of the crypto | 1440 | True | 1, 5, 15, 30, 60, 240, 1440, 10080, 43200 |
|
||||
| vs | Quote currency (what to view coin vs). e.g., usdc, usdt, ... if source is ccxt, usd, eur, ... otherwise | usdt | True | None |
|
||||
---
|
||||
|
||||
|
||||
@@ -1,23 +1,23 @@
|
||||
---
|
||||
title: market
|
||||
description: OpenBB Terminal Function
|
||||
---
|
||||
|
||||
# market
|
||||
|
||||
Market data for loaded coin. There you find metrics like: Market Cap, Supply, Circulating Supply, Price, Volume and many others.
|
||||
|
||||
### Usage
|
||||
|
||||
```python
|
||||
usage: market
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Parameters
|
||||
|
||||
This command has no parameters
|
||||
|
||||
---
|
||||
|
||||
---
|
||||
title: market
|
||||
description: OpenBB Terminal Function
|
||||
---
|
||||
|
||||
# market
|
||||
|
||||
Market data for loaded coin. There you find metrics like: Market Cap, Supply, Circulating Supply, Price, Volume and many others.
|
||||
|
||||
### Usage
|
||||
|
||||
```python
|
||||
usage: market
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Parameters
|
||||
|
||||
This command has no parameters
|
||||
|
||||
---
|
||||
|
||||
|
||||
@@ -1,26 +1,26 @@
|
||||
---
|
||||
title: mcapdom
|
||||
description: OpenBB Terminal Function
|
||||
---
|
||||
|
||||
# mcapdom
|
||||
|
||||
Display asset's percentage share of total crypto circulating market cap [Source: https://messari.io]
|
||||
|
||||
### Usage
|
||||
|
||||
```python
|
||||
usage: mcapdom [-i {5m,15m,30m,1h,1d,1w}] [-s START] [-end END]
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Parameters
|
||||
|
||||
| Name | Description | Default | Optional | Choices |
|
||||
| ---- | ----------- | ------- | -------- | ------- |
|
||||
| interval | Frequency interval. Default: 1d | 1d | True | 5m, 15m, 30m, 1h, 1d, 1w |
|
||||
| start | Initial date. Default: A year ago | 2021-11-22 | True | None |
|
||||
| end | End date. Default: Today | 2022-11-22 | True | None |
|
||||
---
|
||||
|
||||
---
|
||||
title: mcapdom
|
||||
description: OpenBB Terminal Function
|
||||
---
|
||||
|
||||
# mcapdom
|
||||
|
||||
Display asset's percentage share of total crypto circulating market cap [Source: https://messari.io]
|
||||
|
||||
### Usage
|
||||
|
||||
```python
|
||||
usage: mcapdom [-i {5m,15m,30m,1h,1d,1w}] [-s START] [-end END]
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Parameters
|
||||
|
||||
| Name | Description | Default | Optional | Choices |
|
||||
| ---- | ----------- | ------- | -------- | ------- |
|
||||
| interval | Frequency interval. Default: 1d | 1d | True | 5m, 15m, 30m, 1h, 1d, 1w |
|
||||
| start | Initial date. Default: A year ago | 2021-11-22 | True | None |
|
||||
| end | End date. Default: Today | 2022-11-22 | True | None |
|
||||
---
|
||||
|
||||
|
||||
@@ -1,29 +1,30 @@
|
||||
---
|
||||
title: mkt
|
||||
description: OpenBB Terminal Function
|
||||
---
|
||||
|
||||
# mkt
|
||||
|
||||
Get all markets found for given coin. You can display only N number of markets with --limt parameter. You can sort data by pct_volume_share, exchange, pair, trust_score, volume, price --sort parameter and also with --reverse flag to sort ascending. You can use additional flag --urls to see urls for each market Displays: exchange, pair, trust_score, volume, price, pct_volume_share,
|
||||
|
||||
### Usage
|
||||
|
||||
```python
|
||||
usage: mkt [--vs {BTC,ETH,USD,EUR,PLN,KRW,GBP,CAD,JPY,RUB,TRY,NZD,AUD,CHF,UAH,HKD,SGD,NGN,PHP,MXN,BRL,THB,CLP,CNY,CZK,DKK,HUF,IDR,ILS,INR,MYR,NOK,PKR,SEK,TWD,ZAR,VND,BOB,COP,PEN,ARS,ISK}] [-l LIMIT]
|
||||
[-s {pct_volume_share,exchange,pair,trust_score,volume,price}] [-r] [-u]
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Parameters
|
||||
|
||||
| Name | Description | Default | Optional | Choices |
|
||||
| ---- | ----------- | ------- | -------- | ------- |
|
||||
| vs | Quoted currency. Default USD | USD | True | BTC, ETH, USD, EUR, PLN, KRW, GBP, CAD, JPY, RUB, TRY, NZD, AUD, CHF, UAH, HKD, SGD, NGN, PHP, MXN, BRL, THB, CLP, CNY, CZK, DKK, HUF, IDR, ILS, INR, MYR, NOK, PKR, SEK, TWD, ZAR, VND, BOB, COP, PEN, ARS, ISK |
|
||||
| limit | Limit of records | 20 | True | None |
|
||||
| sortby | Sort by given column. Default: pct_volume_share | pct_volume_share | True | pct_volume_share, exchange, pair, trust_score, volume, price |
|
||||
| reverse | Data is sorted in descending order by default. Reverse flag will sort it in an ascending way. Only works when raw data is displayed. | False | True | None |
|
||||
| urls | Flag to show urls. If you will use that flag you will see only: exchange, pair, trust_score, market_url columns | False | True | None |
|
||||
---
|
||||
|
||||
---
|
||||
title: mkt
|
||||
description: OpenBB Terminal Function
|
||||
---
|
||||
|
||||
# mkt
|
||||
|
||||
Get all markets found for given coin. You can display only N number of markets with --limt parameter. You can sort data by pct_volume_share, exchange, pair, trust_score, volume, price --sort parameter and also with --reverse flag to sort ascending. You can use additional flag --urls to see urls for each market Displays: exchange, pair, trust_score, volume, price, pct_volume_share,
|
||||
|
||||
### Usage
|
||||
|
||||
```python
|
||||
usage: mkt
|
||||
[--vs {BTC,ETH,USD,EUR,PLN,KRW,GBP,CAD,JPY,RUB,TRY,NZD,AUD,CHF,UAH,HKD,SGD,NGN,PHP,MXN,BRL,THB,CLP,CNY,CZK,DKK,HUF,IDR,ILS,INR,MYR,NOK,PKR,SEK,TWD,ZAR,VND,BOB,COP,PEN,ARS,ISK}]
|
||||
[-l LIMIT] [-s {pct_volume_share,exchange,pair,trust_score,volume,price}] [-r] [-u]
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Parameters
|
||||
|
||||
| Name | Description | Default | Optional | Choices |
|
||||
| ---- | ----------- | ------- | -------- | ------- |
|
||||
| vs | Quoted currency. Default USD | USD | True | BTC, ETH, USD, EUR, PLN, KRW, GBP, CAD, JPY, RUB, TRY, NZD, AUD, CHF, UAH, HKD, SGD, NGN, PHP, MXN, BRL, THB, CLP, CNY, CZK, DKK, HUF, IDR, ILS, INR, MYR, NOK, PKR, SEK, TWD, ZAR, VND, BOB, COP, PEN, ARS, ISK |
|
||||
| limit | Limit of records | 20 | True | None |
|
||||
| sortby | Sort by given column. Default: pct_volume_share | pct_volume_share | True | pct_volume_share, exchange, pair, trust_score, volume, price |
|
||||
| reverse | Data is sorted in descending order by default. Reverse flag will sort it in an ascending way. Only works when raw data is displayed. | False | True | None |
|
||||
| urls | Flag to show urls. If you will use that flag you will see only: exchange, pair, trust_score, market_url columns | False | True | None |
|
||||
---
|
||||
|
||||
|
||||
@@ -1,30 +1,30 @@
|
||||
---
|
||||
title: mt
|
||||
description: OpenBB Terminal Function
|
||||
---
|
||||
|
||||
# mt
|
||||
|
||||
Display messari timeseries [Source: https://messari.io]
|
||||
|
||||
### Usage
|
||||
|
||||
```python
|
||||
usage: mt [--list] [-t TIMESERIES] [-i {5m,15m,30m,1h,1d,1w}] [-s START] [-end END] [--include-paid] [-q QUERY [QUERY ...]]
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Parameters
|
||||
|
||||
| Name | Description | Default | Optional | Choices |
|
||||
| ---- | ----------- | ------- | -------- | ------- |
|
||||
| list | Flag to show available timeseries | False | True | None |
|
||||
| timeseries | Messari timeseries id | | True | txn.tfr.erc721.cnt, exch.flow.in.usd.incl, iss.rate, txn.fee.avg, txn.tfr.val.adj.ntv, min.rev.usd, twitter.followers, act.addr.cnt, telegram.users, txn.tfr.avg.ntv, blk.size.bytes.avg, blk.cnt, reddit.subscribers, real.vol, txn.fee.avg.ntv, exch.flow.out.ntv, txn.tfr.val.ntv, mcap.dom, fees, txn.tsfr.cnt, fees.ntv, nvt.adj, txn.vol, txn.tfr.val.med.ntv, min.rev.ntv, exch.sply.ntv, txn.tfr.val.med, price, blk.size.byte, txn.tfr.erc20.cnt, reddit.active.users, exch.flow.in.usd, txn.tsfr.val.avg, exch.flow.out.ntv.incl, sply.total.iss, exch.sply.usd, txn.cnt, txn.tsfr.val.adj, txn.fee.med, txn.fee.med.ntv, hashrate, mcap.realized, daily.vol, daily.shp, mcap.out, cg.sply.circ, new.iss.usd, exch.flow.in.ntv, exch.flow.out.usd, sply.total.iss.ntv, exch.flow.out.usd.incl, nvt.adj.90d.ma, sply.out, new.iss.ntv, exch.flow.in.ntv.incl, mcap.circ, sply.liquid, diff.avg, sply.circ |
|
||||
| interval | Frequency interval | 1d | True | 5m, 15m, 30m, 1h, 1d, 1w |
|
||||
| start | Initial date. Default: A year ago | 2021-11-22 | True | None |
|
||||
| end | End date. Default: Today | 2022-11-22 | True | None |
|
||||
| include_paid | Flag to show both paid and free sources | False | True | None |
|
||||
| query | Query to search across all messari timeseries | | True | None |
|
||||
---
|
||||
|
||||
---
|
||||
title: mt
|
||||
description: OpenBB Terminal Function
|
||||
---
|
||||
|
||||
# mt
|
||||
|
||||
Display messari timeseries [Source: https://messari.io]
|
||||
|
||||
### Usage
|
||||
|
||||
```python
|
||||
usage: mt [--list] [-t TIMESERIES] [-i {5m,15m,30m,1h,1d,1w}] [-s START] [-end END] [--include-paid] [-q QUERY [QUERY ...]]
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Parameters
|
||||
|
||||
| Name | Description | Default | Optional | Choices |
|
||||
| ---- | ----------- | ------- | -------- | ------- |
|
||||
| list | Flag to show available timeseries | False | True | None |
|
||||
| timeseries | Messari timeseries id | | True | price, daily.shp, exch.flow.out.ntv.incl, fees.ntv, iss.rate, txn.tfr.erc721.cnt, sply.liquid, exch.sply.usd, mcap.realized, real.vol, act.addr.cnt, fees, txn.fee.avg.ntv, txn.tfr.val.med.ntv, mcap.circ, mcap.out, txn.tfr.avg.ntv, blk.cnt, blk.size.bytes.avg, txn.tfr.val.ntv, exch.flow.in.ntv, exch.flow.out.usd, diff.avg, txn.vol, nvt.adj.90d.ma, new.iss.usd, min.rev.usd, txn.fee.avg, sply.circ, twitter.followers, nvt.adj, txn.tsfr.cnt, txn.tsfr.val.adj, exch.flow.in.usd, txn.tfr.val.med, exch.flow.out.ntv, cg.sply.circ, sply.total.iss, exch.sply.ntv, daily.vol, sply.out, txn.tfr.erc20.cnt, txn.tfr.val.adj.ntv, sply.total.iss.ntv, reddit.subscribers, mcap.dom, hashrate, txn.fee.med, txn.cnt, exch.flow.in.usd.incl, txn.fee.med.ntv, exch.flow.in.ntv.incl, exch.flow.out.usd.incl, new.iss.ntv, min.rev.ntv, reddit.active.users, blk.size.byte, txn.tsfr.val.avg, telegram.users |
|
||||
| interval | Frequency interval | 1d | True | 5m, 15m, 30m, 1h, 1d, 1w |
|
||||
| start | Initial date. Default: A year ago | 2021-11-22 | True | None |
|
||||
| end | End date. Default: Today | 2022-11-22 | True | None |
|
||||
| include_paid | Flag to show both paid and free sources | False | True | None |
|
||||
| query | Query to search across all messari timeseries | | True | None |
|
||||
---
|
||||
|
||||
|
||||
@@ -1,30 +1,31 @@
|
||||
---
|
||||
title: news
|
||||
description: OpenBB Terminal Function
|
||||
---
|
||||
|
||||
# news
|
||||
|
||||
Display most recent news on the given coin from CryptoPanic aggregator platform. [Source: https://cryptopanic.com/]
|
||||
|
||||
### Usage
|
||||
|
||||
```python
|
||||
usage: news [-l LIMIT] [-k {news,media}] [--filter {rising,hot,bullish,bearish,important,saved,lol}] [-r {en,de,es,fr,nl,it,pt,ru}] [-s {published_at,domain,title,negative_votes,positive_votes}] [--reverse] [-u]
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Parameters
|
||||
|
||||
| Name | Description | Default | Optional | Choices |
|
||||
| ---- | ----------- | ------- | -------- | ------- |
|
||||
| limit | display N number records | 10 | True | None |
|
||||
| kind | Filter by category of news. Available values: news or media. | news | True | news, media |
|
||||
| filter | Filter by kind of news. From: rising|hot|bullish|bearish|important|saved|lol | None | True | rising, hot, bullish, bearish, important, saved, lol |
|
||||
| region | Filter news by regions. Available regions are: en (English), de (Deutsch), nl (Dutch), es (Español), fr (Français), it (Italiano), pt (Português), ru (Русский) | en | True | en, de, es, fr, nl, it, pt, ru |
|
||||
| sortby | Sort by given column. Default: published_at | published_at | True | published_at, domain, title, negative_votes, positive_votes |
|
||||
| reverse | Data is sorted in descending order by default. Reverse flag will sort it in an ascending way. Only works when raw data is displayed. | False | True | None |
|
||||
| urls | Flag to disable urls. Hides column with URL. | True | True | None |
|
||||
---
|
||||
|
||||
---
|
||||
title: news
|
||||
description: OpenBB Terminal Function
|
||||
---
|
||||
|
||||
# news
|
||||
|
||||
Display most recent news on the given coin from CryptoPanic aggregator platform. [Source: https://cryptopanic.com/]
|
||||
|
||||
### Usage
|
||||
|
||||
```python
|
||||
usage: news [-l LIMIT] [-k {news,media}] [--filter {rising,hot,bullish,bearish,important,saved,lol}] [-r {en,de,es,fr,nl,it,pt,ru}]
|
||||
[-s {published_at,domain,title,negative_votes,positive_votes}] [--reverse] [-u]
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Parameters
|
||||
|
||||
| Name | Description | Default | Optional | Choices |
|
||||
| ---- | ----------- | ------- | -------- | ------- |
|
||||
| limit | display N number records | 10 | True | None |
|
||||
| kind | Filter by category of news. Available values: news or media. | news | True | news, media |
|
||||
| filter | Filter by kind of news. From: rising|hot|bullish|bearish|important|saved|lol | None | True | rising, hot, bullish, bearish, important, saved, lol |
|
||||
| region | Filter news by regions. Available regions are: en (English), de (Deutsch), nl (Dutch), es (Español), fr (Français), it (Italiano), pt (Português), ru (Русский) | en | True | en, de, es, fr, nl, it, pt, ru |
|
||||
| sortby | Sort by given column. Default: published_at | published_at | True | published_at, domain, title, negative_votes, positive_votes |
|
||||
| reverse | Data is sorted in descending order by default. Reverse flag will sort it in an ascending way. Only works when raw data is displayed. | False | True | None |
|
||||
| urls | Flag to disable urls. Hides column with URL. | True | True | None |
|
||||
---
|
||||
|
||||
|
||||
@@ -1,25 +1,25 @@
|
||||
---
|
||||
title: nonzero
|
||||
description: OpenBB Terminal Function
|
||||
---
|
||||
|
||||
# nonzero
|
||||
|
||||
Display addresses with nonzero assets in a certain blockchain [Source: https://glassnode.org] Note that free api keys only allow fetching data with a 1y lag
|
||||
|
||||
### Usage
|
||||
|
||||
```python
|
||||
usage: nonzero [-s SINCE] [-u UNTIL]
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Parameters
|
||||
|
||||
| Name | Description | Default | Optional | Choices |
|
||||
| ---- | ----------- | ------- | -------- | ------- |
|
||||
| since | Initial date. Default: 2 years ago | 2020-11-22 | True | None |
|
||||
| until | Final date. Default: 1 year ago | 2021-11-20 | True | None |
|
||||
---
|
||||
|
||||
---
|
||||
title: nonzero
|
||||
description: OpenBB Terminal Function
|
||||
---
|
||||
|
||||
# nonzero
|
||||
|
||||
Display addresses with nonzero assets in a certain blockchain [Source: https://glassnode.org] Note that free api keys only allow fetching data with a 1y lag
|
||||
|
||||
### Usage
|
||||
|
||||
```python
|
||||
usage: nonzero [-s SINCE] [-u UNTIL]
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Parameters
|
||||
|
||||
| Name | Description | Default | Optional | Choices |
|
||||
| ---- | ----------- | ------- | -------- | ------- |
|
||||
| since | Initial date. Default: 2 years ago | 2020-11-22 | True | None |
|
||||
| until | Final date. Default: 1 year ago | 2021-11-20 | True | None |
|
||||
---
|
||||
|
||||
|
||||
@@ -1,27 +1,27 @@
|
||||
---
|
||||
title: ob
|
||||
description: OpenBB Terminal Function
|
||||
---
|
||||
|
||||
# ob
|
||||
|
||||
Get the order book for selected coin
|
||||
|
||||
### Usage
|
||||
|
||||
```python
|
||||
usage: ob
|
||||
[-e {aax,alpaca,ascendex,bequant,bibox,bigone,binance,binancecoinm,binanceus,binanceusdm,bit2c,bitbank,bitbay,bitbns,bitcoincom,bitfinex,bitfinex2,bitflyer,bitforex,bitget,bithumb,bitmart,bitmex,bitopro,bitpanda,bitrue,bitso,bitstamp,bitstamp1,bittrex,bitvavo,bkex,bl3p,blockchaincom,btcalpha,btcbox,btcex,btcmarkets,btctradeua,btcturk,buda,bw,bybit,bytetrade,cex,coinbase,coinbaseprime,coinbasepro,coincheck,coinex,coinfalcon,coinmate,coinone,coinspot,crex24,cryptocom,currencycom,delta,deribit,digifinex,eqonex,exmo,flowbtc,fmfwio,ftx,ftxus,gate,gateio,gemini,hitbtc,hitbtc3,hollaex,huobi,huobijp,huobipro,idex,independentreserve,indodax,itbit,kraken,kucoin,kucoinfutures,kuna,latoken,lbank,lbank2,liquid,luno,lykke,mercado,mexc,mexc3,ndax,novadax,oceanex,okcoin,okex,okex5,okx,paymium,phemex,poloniex,probit,qtrade,ripio,stex,therock,tidebit,tidex,timex,tokocrypto,upbit,wavesexchange,wazirx,whitebit,woo,yobit,zaif,zb,zipmex,zonda}]
|
||||
[--vs VS]
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Parameters
|
||||
|
||||
| Name | Description | Default | Optional | Choices |
|
||||
| ---- | ----------- | ------- | -------- | ------- |
|
||||
| exchange | Exchange to search for order book | binance | True | aax, alpaca, ascendex, bequant, bibox, bigone, binance, binancecoinm, binanceus, binanceusdm, bit2c, bitbank, bitbay, bitbns, bitcoincom, bitfinex, bitfinex2, bitflyer, bitforex, bitget, bithumb, bitmart, bitmex, bitopro, bitpanda, bitrue, bitso, bitstamp, bitstamp1, bittrex, bitvavo, bkex, bl3p, blockchaincom, btcalpha, btcbox, btcex, btcmarkets, btctradeua, btcturk, buda, bw, bybit, bytetrade, cex, coinbase, coinbaseprime, coinbasepro, coincheck, coinex, coinfalcon, coinmate, coinone, coinspot, crex24, cryptocom, currencycom, delta, deribit, digifinex, eqonex, exmo, flowbtc, fmfwio, ftx, ftxus, gate, gateio, gemini, hitbtc, hitbtc3, hollaex, huobi, huobijp, huobipro, idex, independentreserve, indodax, itbit, kraken, kucoin, kucoinfutures, kuna, latoken, lbank, lbank2, liquid, luno, lykke, mercado, mexc, mexc3, ndax, novadax, oceanex, okcoin, okex, okex5, okx, paymium, phemex, poloniex, probit, qtrade, ripio, stex, therock, tidebit, tidex, timex, tokocrypto, upbit, wavesexchange, wazirx, whitebit, woo, yobit, zaif, zb, zipmex, zonda |
|
||||
| vs | Quote currency (what to view coin vs) | usdt | True | AUD, BIDR, BKRW, BNB, BRL, BTC, BUSD, BVND, DAI, DOGE, DOT, ETH, EUR, GBP, IDRT, NGN, PAX, PLN, RUB, TRX, TRY, TUSD, UAH, USDC, USDP, USDS, USDT, UST, VAI, XRP, ZAR |
|
||||
---
|
||||
|
||||
---
|
||||
title: ob
|
||||
description: OpenBB Terminal Function
|
||||
---
|
||||
|
||||
# ob
|
||||
|
||||
Get the order book for selected coin
|
||||
|
||||
### Usage
|
||||
|
||||
```python
|
||||
usage: ob
|
||||
[-e {aax,alpaca,ascendex,bequant,bibox,bigone,binance,binancecoinm,binanceus,binanceusdm,bit2c,bitbank,bitbay,bitbns,bitcoincom,bitfinex,bitfinex2,bitflyer,bitforex,bitget,bithumb,bitmart,bitmex,bitopro,bitpanda,bitrue,bitso,bitstamp,bitstamp1,bittrex,bitvavo,bkex,bl3p,blockchaincom,btcalpha,btcbox,btcex,btcmarkets,btctradeua,btcturk,buda,bw,bybit,bytetrade,cex,coinbase,coinbaseprime,coinbasepro,coincheck,coinex,coinfalcon,coinmate,coinone,coinspot,crex24,cryptocom,currencycom,delta,deribit,digifinex,eqonex,exmo,flowbtc,fmfwio,ftx,ftxus,gate,gateio,gemini,hitbtc,hitbtc3,hollaex,huobi,huobijp,huobipro,idex,independentreserve,indodax,itbit,kraken,kucoin,kucoinfutures,kuna,latoken,lbank,lbank2,liquid,luno,lykke,mercado,mexc,mexc3,ndax,novadax,oceanex,okcoin,okex,okex5,okx,paymium,phemex,poloniex,probit,qtrade,ripio,stex,therock,tidebit,tidex,timex,tokocrypto,upbit,wavesexchange,wazirx,whitebit,woo,yobit,zaif,zb,zipmex,zonda}]
|
||||
[--vs VS]
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Parameters
|
||||
|
||||
| Name | Description | Default | Optional | Choices |
|
||||
| ---- | ----------- | ------- | -------- | ------- |
|
||||
| exchange | Exchange to search for order book | binance | True | aax, alpaca, ascendex, bequant, bibox, bigone, binance, binancecoinm, binanceus, binanceusdm, bit2c, bitbank, bitbay, bitbns, bitcoincom, bitfinex, bitfinex2, bitflyer, bitforex, bitget, bithumb, bitmart, bitmex, bitopro, bitpanda, bitrue, bitso, bitstamp, bitstamp1, bittrex, bitvavo, bkex, bl3p, blockchaincom, btcalpha, btcbox, btcex, btcmarkets, btctradeua, btcturk, buda, bw, bybit, bytetrade, cex, coinbase, coinbaseprime, coinbasepro, coincheck, coinex, coinfalcon, coinmate, coinone, coinspot, crex24, cryptocom, currencycom, delta, deribit, digifinex, eqonex, exmo, flowbtc, fmfwio, ftx, ftxus, gate, gateio, gemini, hitbtc, hitbtc3, hollaex, huobi, huobijp, huobipro, idex, independentreserve, indodax, itbit, kraken, kucoin, kucoinfutures, kuna, latoken, lbank, lbank2, liquid, luno, lykke, mercado, mexc, mexc3, ndax, novadax, oceanex, okcoin, okex, okex5, okx, paymium, phemex, poloniex, probit, qtrade, ripio, stex, therock, tidebit, tidex, timex, tokocrypto, upbit, wavesexchange, wazirx, whitebit, woo, yobit, zaif, zb, zipmex, zonda |
|
||||
| vs | Quote currency (what to view coin vs) | usdt | True | AUD, BIDR, BKRW, BNB, BRL, BTC, BUSD, BVND, DAI, DOGE, DOT, ETH, EUR, GBP, IDRT, NGN, PAX, PLN, RUB, TRX, TRY, TUSD, UAH, USDC, USDP, USDS, USDT, UST, VAI, XRP, ZAR |
|
||||
---
|
||||
|
||||
|
||||
@@ -1,24 +1,24 @@
|
||||
---
|
||||
title: oi
|
||||
description: OpenBB Terminal Function
|
||||
---
|
||||
|
||||
# oi
|
||||
|
||||
Displays open interest by exchange for a certain asset [Source: https://coinglass.github.io/API-Reference/]
|
||||
|
||||
### Usage
|
||||
|
||||
```python
|
||||
usage: oi [-i {0,1,2,4}]
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Parameters
|
||||
|
||||
| Name | Description | Default | Optional | Choices |
|
||||
| ---- | ----------- | ------- | -------- | ------- |
|
||||
| interval | Frequency interval. Default: 0 | 0 | True | 0, 1, 2, 4 |
|
||||
---
|
||||
|
||||
---
|
||||
title: oi
|
||||
description: OpenBB Terminal Function
|
||||
---
|
||||
|
||||
# oi
|
||||
|
||||
Displays open interest by exchange for a certain asset [Source: https://coinglass.github.io/API-Reference/]
|
||||
|
||||
### Usage
|
||||
|
||||
```python
|
||||
usage: oi [-i {0,1,2,4}]
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Parameters
|
||||
|
||||
| Name | Description | Default | Optional | Choices |
|
||||
| ---- | ----------- | ------- | -------- | ------- |
|
||||
| interval | Frequency interval. Default: 0 | 0 | True | 0, 1, 2, 4 |
|
||||
---
|
||||
|
||||
|
||||
@@ -1,23 +1,23 @@
|
||||
---
|
||||
title: pi
|
||||
description: OpenBB Terminal Function
|
||||
---
|
||||
|
||||
# pi
|
||||
|
||||
Display asset's project info [Source: https://messari.io]
|
||||
|
||||
### Usage
|
||||
|
||||
```python
|
||||
usage: pi
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Parameters
|
||||
|
||||
This command has no parameters
|
||||
|
||||
---
|
||||
|
||||
---
|
||||
title: pi
|
||||
description: OpenBB Terminal Function
|
||||
---
|
||||
|
||||
# pi
|
||||
|
||||
Display asset's project info [Source: https://messari.io]
|
||||
|
||||
### Usage
|
||||
|
||||
```python
|
||||
usage: pi
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Parameters
|
||||
|
||||
This command has no parameters
|
||||
|
||||
---
|
||||
|
||||
|
||||
@@ -1,24 +1,25 @@
|
||||
---
|
||||
title: ps
|
||||
description: OpenBB Terminal Function
|
||||
---
|
||||
|
||||
# ps
|
||||
|
||||
Get price and supply related metrics for given coin.
|
||||
|
||||
### Usage
|
||||
|
||||
```python
|
||||
usage: ps [--vs {BTC,ETH,USD,EUR,PLN,KRW,GBP,CAD,JPY,RUB,TRY,NZD,AUD,CHF,UAH,HKD,SGD,NGN,PHP,MXN,BRL,THB,CLP,CNY,CZK,DKK,HUF,IDR,ILS,INR,MYR,NOK,PKR,SEK,TWD,ZAR,VND,BOB,COP,PEN,ARS,ISK}]
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Parameters
|
||||
|
||||
| Name | Description | Default | Optional | Choices |
|
||||
| ---- | ----------- | ------- | -------- | ------- |
|
||||
| vs | Quoted currency. Default USD | USD | True | BTC, ETH, USD, EUR, PLN, KRW, GBP, CAD, JPY, RUB, TRY, NZD, AUD, CHF, UAH, HKD, SGD, NGN, PHP, MXN, BRL, THB, CLP, CNY, CZK, DKK, HUF, IDR, ILS, INR, MYR, NOK, PKR, SEK, TWD, ZAR, VND, BOB, COP, PEN, ARS, ISK |
|
||||
---
|
||||
|
||||
---
|
||||
title: ps
|
||||
description: OpenBB Terminal Function
|
||||
---
|
||||
|
||||
# ps
|
||||
|
||||
Get price and supply related metrics for given coin.
|
||||
|
||||
### Usage
|
||||
|
||||
```python
|
||||
usage: ps
|
||||
[--vs {BTC,ETH,USD,EUR,PLN,KRW,GBP,CAD,JPY,RUB,TRY,NZD,AUD,CHF,UAH,HKD,SGD,NGN,PHP,MXN,BRL,THB,CLP,CNY,CZK,DKK,HUF,IDR,ILS,INR,MYR,NOK,PKR,SEK,TWD,ZAR,VND,BOB,COP,PEN,ARS,ISK}]
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Parameters
|
||||
|
||||
| Name | Description | Default | Optional | Choices |
|
||||
| ---- | ----------- | ------- | -------- | ------- |
|
||||
| vs | Quoted currency. Default USD | USD | True | BTC, ETH, USD, EUR, PLN, KRW, GBP, CAD, JPY, RUB, TRY, NZD, AUD, CHF, UAH, HKD, SGD, NGN, PHP, MXN, BRL, THB, CLP, CNY, CZK, DKK, HUF, IDR, ILS, INR, MYR, NOK, PKR, SEK, TWD, ZAR, VND, BOB, COP, PEN, ARS, ISK |
|
||||
---
|
||||
|
||||
|
||||
@@ -1,24 +1,24 @@
|
||||
---
|
||||
title: rm
|
||||
description: OpenBB Terminal Function
|
||||
---
|
||||
|
||||
# rm
|
||||
|
||||
Display asset's roadmap [Source: https://messari.io]
|
||||
|
||||
### Usage
|
||||
|
||||
```python
|
||||
usage: rm [-r]
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Parameters
|
||||
|
||||
| Name | Description | Default | Optional | Choices |
|
||||
| ---- | ----------- | ------- | -------- | ------- |
|
||||
| reverse | Data is sorted in descending order by default. Reverse flag will sort it in an ascending way. Only works when raw data is displayed. | False | True | None |
|
||||
---
|
||||
|
||||
---
|
||||
title: rm
|
||||
description: OpenBB Terminal Function
|
||||
---
|
||||
|
||||
# rm
|
||||
|
||||
Display asset's roadmap [Source: https://messari.io]
|
||||
|
||||
### Usage
|
||||
|
||||
```python
|
||||
usage: rm [-r]
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Parameters
|
||||
|
||||
| Name | Description | Default | Optional | Choices |
|
||||
| ---- | ----------- | ------- | -------- | ------- |
|
||||
| reverse | Data is sorted in descending order by default. Reverse flag will sort it in an ascending way. Only works when raw data is displayed. | False | True | None |
|
||||
---
|
||||
|
||||
|
||||
@@ -1,23 +1,23 @@
|
||||
---
|
||||
title: score
|
||||
description: OpenBB Terminal Function
|
||||
---
|
||||
|
||||
# score
|
||||
|
||||
In this view you can find different kind of scores for loaded coin. Those scores represents different rankings, sentiment metrics, some user stats and others. You will see CoinGecko scores, Developer Scores, Community Scores, Sentiment, Reddit scores and many others.
|
||||
|
||||
### Usage
|
||||
|
||||
```python
|
||||
usage: score
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Parameters
|
||||
|
||||
This command has no parameters
|
||||
|
||||
---
|
||||
|
||||
---
|
||||
title: score
|
||||
description: OpenBB Terminal Function
|
||||
---
|
||||
|
||||
# score
|
||||
|
||||
In this view you can find different kind of scores for loaded coin. Those scores represents different rankings, sentiment metrics, some user stats and others. You will see CoinGecko scores, Developer Scores, Community Scores, Sentiment, Reddit scores and many others.
|
||||
|
||||
### Usage
|
||||
|
||||
```python
|
||||
usage: score
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Parameters
|
||||
|
||||
This command has no parameters
|
||||
|
||||
---
|
||||
|
||||
|
||||
@@ -1,23 +1,23 @@
|
||||
---
|
||||
title: social
|
||||
description: OpenBB Terminal Function
|
||||
---
|
||||
|
||||
# social
|
||||
|
||||
Shows social media corresponding to loaded coin. You can find there name of telegram channel, urls to twitter, reddit, bitcointalk, facebook and discord.
|
||||
|
||||
### Usage
|
||||
|
||||
```python
|
||||
usage: social
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Parameters
|
||||
|
||||
This command has no parameters
|
||||
|
||||
---
|
||||
|
||||
---
|
||||
title: social
|
||||
description: OpenBB Terminal Function
|
||||
---
|
||||
|
||||
# social
|
||||
|
||||
Shows social media corresponding to loaded coin. You can find there name of telegram channel, urls to twitter, reddit, bitcointalk, facebook and discord.
|
||||
|
||||
### Usage
|
||||
|
||||
```python
|
||||
usage: social
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Parameters
|
||||
|
||||
This command has no parameters
|
||||
|
||||
---
|
||||
|
||||
|
||||
@@ -1,24 +1,24 @@
|
||||
---
|
||||
title: stats
|
||||
description: OpenBB Terminal Function
|
||||
---
|
||||
|
||||
# stats
|
||||
|
||||
Display coin stats
|
||||
|
||||
### Usage
|
||||
|
||||
```python
|
||||
usage: stats [--vs {USDT,EUR,USDC,USD,GBP,USD}]
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Parameters
|
||||
|
||||
| Name | Description | Default | Optional | Choices |
|
||||
| ---- | ----------- | ------- | -------- | ------- |
|
||||
| vs | Quote currency (what to view coin vs) | USDT | True | USDT, EUR, USDC, USD, GBP, USD |
|
||||
---
|
||||
|
||||
---
|
||||
title: stats
|
||||
description: OpenBB Terminal Function
|
||||
---
|
||||
|
||||
# stats
|
||||
|
||||
Display coin stats
|
||||
|
||||
### Usage
|
||||
|
||||
```python
|
||||
usage: stats [--vs {USD,USDC,GBP,USDT,EUR,USD}]
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Parameters
|
||||
|
||||
| Name | Description | Default | Optional | Choices |
|
||||
| ---- | ----------- | ------- | -------- | ------- |
|
||||
| vs | Quote currency (what to view coin vs) | USDT | True | USD, USDC, GBP, USDT, EUR, USD |
|
||||
---
|
||||
|
||||
|
||||
@@ -1,23 +1,23 @@
|
||||
---
|
||||
title: team
|
||||
description: OpenBB Terminal Function
|
||||
---
|
||||
|
||||
# team
|
||||
|
||||
Display asset's team [Source: https://messari.io]
|
||||
|
||||
### Usage
|
||||
|
||||
```python
|
||||
usage: team
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Parameters
|
||||
|
||||
This command has no parameters
|
||||
|
||||
---
|
||||
|
||||
---
|
||||
title: team
|
||||
description: OpenBB Terminal Function
|
||||
---
|
||||
|
||||
# team
|
||||
|
||||
Display asset's team [Source: https://messari.io]
|
||||
|
||||
### Usage
|
||||
|
||||
```python
|
||||
usage: team
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Parameters
|
||||
|
||||
This command has no parameters
|
||||
|
||||
---
|
||||
|
||||
|
||||
@@ -1,23 +1,23 @@
|
||||
---
|
||||
title: tk
|
||||
description: OpenBB Terminal Function
|
||||
---
|
||||
|
||||
# tk
|
||||
|
||||
Display asset's tokenomics [Source: https://messari.io]
|
||||
|
||||
### Usage
|
||||
|
||||
```python
|
||||
usage: tk
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Parameters
|
||||
|
||||
This command has no parameters
|
||||
|
||||
---
|
||||
|
||||
---
|
||||
title: tk
|
||||
description: OpenBB Terminal Function
|
||||
---
|
||||
|
||||
# tk
|
||||
|
||||
Display asset's tokenomics [Source: https://messari.io]
|
||||
|
||||
### Usage
|
||||
|
||||
```python
|
||||
usage: tk
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Parameters
|
||||
|
||||
This command has no parameters
|
||||
|
||||
---
|
||||
|
||||
|
||||
@@ -1,27 +1,27 @@
|
||||
---
|
||||
title: trades
|
||||
description: OpenBB Terminal Function
|
||||
---
|
||||
|
||||
# trades
|
||||
|
||||
Get the latest trades for selected coin
|
||||
|
||||
### Usage
|
||||
|
||||
```python
|
||||
usage: trades
|
||||
[-e {aax,alpaca,ascendex,bequant,bibox,bigone,binance,binancecoinm,binanceus,binanceusdm,bit2c,bitbank,bitbay,bitbns,bitcoincom,bitfinex,bitfinex2,bitflyer,bitforex,bitget,bithumb,bitmart,bitmex,bitopro,bitpanda,bitrue,bitso,bitstamp,bitstamp1,bittrex,bitvavo,bkex,bl3p,blockchaincom,btcalpha,btcbox,btcex,btcmarkets,btctradeua,btcturk,buda,bw,bybit,bytetrade,cex,coinbase,coinbaseprime,coinbasepro,coincheck,coinex,coinfalcon,coinmate,coinone,coinspot,crex24,cryptocom,currencycom,delta,deribit,digifinex,eqonex,exmo,flowbtc,fmfwio,ftx,ftxus,gate,gateio,gemini,hitbtc,hitbtc3,hollaex,huobi,huobijp,huobipro,idex,independentreserve,indodax,itbit,kraken,kucoin,kucoinfutures,kuna,latoken,lbank,lbank2,liquid,luno,lykke,mercado,mexc,mexc3,ndax,novadax,oceanex,okcoin,okex,okex5,okx,paymium,phemex,poloniex,probit,qtrade,ripio,stex,therock,tidebit,tidex,timex,tokocrypto,upbit,wavesexchange,wazirx,whitebit,woo,yobit,zaif,zb,zipmex,zonda}]
|
||||
[--vs VS]
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Parameters
|
||||
|
||||
| Name | Description | Default | Optional | Choices |
|
||||
| ---- | ----------- | ------- | -------- | ------- |
|
||||
| exchange | Exchange to search for order book | binance | True | aax, alpaca, ascendex, bequant, bibox, bigone, binance, binancecoinm, binanceus, binanceusdm, bit2c, bitbank, bitbay, bitbns, bitcoincom, bitfinex, bitfinex2, bitflyer, bitforex, bitget, bithumb, bitmart, bitmex, bitopro, bitpanda, bitrue, bitso, bitstamp, bitstamp1, bittrex, bitvavo, bkex, bl3p, blockchaincom, btcalpha, btcbox, btcex, btcmarkets, btctradeua, btcturk, buda, bw, bybit, bytetrade, cex, coinbase, coinbaseprime, coinbasepro, coincheck, coinex, coinfalcon, coinmate, coinone, coinspot, crex24, cryptocom, currencycom, delta, deribit, digifinex, eqonex, exmo, flowbtc, fmfwio, ftx, ftxus, gate, gateio, gemini, hitbtc, hitbtc3, hollaex, huobi, huobijp, huobipro, idex, independentreserve, indodax, itbit, kraken, kucoin, kucoinfutures, kuna, latoken, lbank, lbank2, liquid, luno, lykke, mercado, mexc, mexc3, ndax, novadax, oceanex, okcoin, okex, okex5, okx, paymium, phemex, poloniex, probit, qtrade, ripio, stex, therock, tidebit, tidex, timex, tokocrypto, upbit, wavesexchange, wazirx, whitebit, woo, yobit, zaif, zb, zipmex, zonda |
|
||||
| vs | Quote currency (what to view coin vs) | usdt | True | AUD, BIDR, BKRW, BNB, BRL, BTC, BUSD, BVND, DAI, DOGE, DOT, ETH, EUR, GBP, IDRT, NGN, PAX, PLN, RUB, TRX, TRY, TUSD, UAH, USDC, USDP, USDS, USDT, UST, VAI, XRP, ZAR |
|
||||
---
|
||||
|
||||
---
|
||||
title: trades
|
||||
description: OpenBB Terminal Function
|
||||
---
|
||||
|
||||
# trades
|
||||
|
||||
Get the latest trades for selected coin
|
||||
|
||||
### Usage
|
||||
|
||||
```python
|
||||
usage: trades
|
||||
[-e {aax,alpaca,ascendex,bequant,bibox,bigone,binance,binancecoinm,binanceus,binanceusdm,bit2c,bitbank,bitbay,bitbns,bitcoincom,bitfinex,bitfinex2,bitflyer,bitforex,bitget,bithumb,bitmart,bitmex,bitopro,bitpanda,bitrue,bitso,bitstamp,bitstamp1,bittrex,bitvavo,bkex,bl3p,blockchaincom,btcalpha,btcbox,btcex,btcmarkets,btctradeua,btcturk,buda,bw,bybit,bytetrade,cex,coinbase,coinbaseprime,coinbasepro,coincheck,coinex,coinfalcon,coinmate,coinone,coinspot,crex24,cryptocom,currencycom,delta,deribit,digifinex,eqonex,exmo,flowbtc,fmfwio,ftx,ftxus,gate,gateio,gemini,hitbtc,hitbtc3,hollaex,huobi,huobijp,huobipro,idex,independentreserve,indodax,itbit,kraken,kucoin,kucoinfutures,kuna,latoken,lbank,lbank2,liquid,luno,lykke,mercado,mexc,mexc3,ndax,novadax,oceanex,okcoin,okex,okex5,okx,paymium,phemex,poloniex,probit,qtrade,ripio,stex,therock,tidebit,tidex,timex,tokocrypto,upbit,wavesexchange,wazirx,whitebit,woo,yobit,zaif,zb,zipmex,zonda}]
|
||||
[--vs VS]
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Parameters
|
||||
|
||||
| Name | Description | Default | Optional | Choices |
|
||||
| ---- | ----------- | ------- | -------- | ------- |
|
||||
| exchange | Exchange to search for order book | binance | True | aax, alpaca, ascendex, bequant, bibox, bigone, binance, binancecoinm, binanceus, binanceusdm, bit2c, bitbank, bitbay, bitbns, bitcoincom, bitfinex, bitfinex2, bitflyer, bitforex, bitget, bithumb, bitmart, bitmex, bitopro, bitpanda, bitrue, bitso, bitstamp, bitstamp1, bittrex, bitvavo, bkex, bl3p, blockchaincom, btcalpha, btcbox, btcex, btcmarkets, btctradeua, btcturk, buda, bw, bybit, bytetrade, cex, coinbase, coinbaseprime, coinbasepro, coincheck, coinex, coinfalcon, coinmate, coinone, coinspot, crex24, cryptocom, currencycom, delta, deribit, digifinex, eqonex, exmo, flowbtc, fmfwio, ftx, ftxus, gate, gateio, gemini, hitbtc, hitbtc3, hollaex, huobi, huobijp, huobipro, idex, independentreserve, indodax, itbit, kraken, kucoin, kucoinfutures, kuna, latoken, lbank, lbank2, liquid, luno, lykke, mercado, mexc, mexc3, ndax, novadax, oceanex, okcoin, okex, okex5, okx, paymium, phemex, poloniex, probit, qtrade, ripio, stex, therock, tidebit, tidex, timex, tokocrypto, upbit, wavesexchange, wazirx, whitebit, woo, yobit, zaif, zb, zipmex, zonda |
|
||||
| vs | Quote currency (what to view coin vs) | usdt | True | AUD, BIDR, BKRW, BNB, BRL, BTC, BUSD, BVND, DAI, DOGE, DOT, ETH, EUR, GBP, IDRT, NGN, PAX, PLN, RUB, TRX, TRY, TUSD, UAH, USDC, USDP, USDS, USDT, UST, VAI, XRP, ZAR |
|
||||
---
|
||||
|
||||
|
||||
@@ -1,26 +1,26 @@
|
||||
---
|
||||
title: twitter
|
||||
description: OpenBB Terminal Function
|
||||
---
|
||||
|
||||
# twitter
|
||||
|
||||
Show last 10 tweets for given coin. You can display only N number of tweets with --limit parameter. You can sort data by date, user_name, status, retweet_count, like_count --sort parameter and also with --reverse flag to sort ascending. Displays: date, user_name, status, retweet_count, like_count
|
||||
|
||||
### Usage
|
||||
|
||||
```python
|
||||
usage: twitter [-l LIMIT] [-s {date,user_name,status,retweet_count,like_count}] [-r]
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Parameters
|
||||
|
||||
| Name | Description | Default | Optional | Choices |
|
||||
| ---- | ----------- | ------- | -------- | ------- |
|
||||
| limit | Limit of records | 10 | True | None |
|
||||
| sortby | Sort by given column. Default: date | date | True | date, user_name, status, retweet_count, like_count |
|
||||
| reverse | Data is sorted in descending order by default. Reverse flag will sort it in an ascending way. Only works when raw data is displayed. | False | True | None |
|
||||
---
|
||||
|
||||
---
|
||||
title: twitter
|
||||
description: OpenBB Terminal Function
|
||||
---
|
||||
|
||||
# twitter
|
||||
|
||||
Show last 10 tweets for given coin. You can display only N number of tweets with --limit parameter. You can sort data by date, user_name, status, retweet_count, like_count --sort parameter and also with --reverse flag to sort ascending. Displays: date, user_name, status, retweet_count, like_count
|
||||
|
||||
### Usage
|
||||
|
||||
```python
|
||||
usage: twitter [-l LIMIT] [-s {date,user_name,status,retweet_count,like_count}] [-r]
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Parameters
|
||||
|
||||
| Name | Description | Default | Optional | Choices |
|
||||
| ---- | ----------- | ------- | -------- | ------- |
|
||||
| limit | Limit of records | 10 | True | None |
|
||||
| sortby | Sort by given column. Default: date | date | True | date, user_name, status, retweet_count, like_count |
|
||||
| reverse | Data is sorted in descending order by default. Reverse flag will sort it in an ascending way. Only works when raw data is displayed. | False | True | None |
|
||||
---
|
||||
|
||||
|
||||
@@ -1,23 +1,23 @@
|
||||
---
|
||||
title: web
|
||||
description: OpenBB Terminal Function
|
||||
---
|
||||
|
||||
# web
|
||||
|
||||
Websites found for given Coin. You can find there urls to homepage, forum, announcement site and others.
|
||||
|
||||
### Usage
|
||||
|
||||
```python
|
||||
usage: web
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Parameters
|
||||
|
||||
This command has no parameters
|
||||
|
||||
---
|
||||
|
||||
---
|
||||
title: web
|
||||
description: OpenBB Terminal Function
|
||||
---
|
||||
|
||||
# web
|
||||
|
||||
Websites found for given Coin. You can find there urls to homepage, forum, announcement site and others.
|
||||
|
||||
### Usage
|
||||
|
||||
```python
|
||||
usage: web
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Parameters
|
||||
|
||||
This command has no parameters
|
||||
|
||||
---
|
||||
|
||||
|
||||
@@ -1,27 +1,27 @@
|
||||
---
|
||||
title: find
|
||||
description: OpenBB Terminal Function
|
||||
---
|
||||
|
||||
# find
|
||||
|
||||
Find similar coin by name, symbol, or id. If you don't remember exact name or id of the Coin at CoinGecko, Binance, Coinbase or CoinPaprika you can use this command to display coins with similar name, symbol or id to your search query. Example of usage: coin name is something like "polka". So I can try: find -c polka -k name -t 25 It will search for coin that has similar name to polka and display top 25 matches. -c, --coin stands for coin - you provide here your search query -k, --key it's a searching key. You can search by symbol, id or name of coin -l, --limit it displays top N number of records. coins: Shows list of coins available on CoinGecko, CoinPaprika and Binance.If you provide name of coin then in result you will see ids of coins with best match for all mentioned services. If you provide "ALL" in your coin search query, then all coins will be displayed. To move over coins you can use pagination mechanism with skip, top params. E.g. coins ALL --skip 100 --limit 30 then all coins from 100 to 130 will be displayed. By default skip = 0, limit = 10. If you won't provide source of the data everything will be displayed (CoinGecko, CoinPaprika, Binance). If you want to search only in given source then use --source flag. E.g. if you want to find coin with name uniswap on CoinPaprika then use: coins uniswap --source cp --limit 10
|
||||
|
||||
### Usage
|
||||
|
||||
```python
|
||||
usage: find -c COIN [-k {id,symbol,name}] [-l LIMIT] [-s SKIP]
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Parameters
|
||||
|
||||
| Name | Description | Default | Optional | Choices |
|
||||
| ---- | ----------- | ------- | -------- | ------- |
|
||||
| coin | Symbol Name or Id of Coin | None | False | None |
|
||||
| key | Specify by which column you would like to search: symbol, name, id | symbol | True | id, symbol, name |
|
||||
| limit | Number of records to display | 10 | True | None |
|
||||
| skip | Skip n of records | 0 | True | range(1, 300) |
|
||||
---
|
||||
|
||||
---
|
||||
title: find
|
||||
description: OpenBB Terminal Function
|
||||
---
|
||||
|
||||
# find
|
||||
|
||||
Find similar coin by name, symbol, or id. If you don't remember exact name or id of the Coin at CoinGecko, Binance, Coinbase or CoinPaprika you can use this command to display coins with similar name, symbol or id to your search query. Example of usage: coin name is something like "polka". So I can try: find -c polka -k name -t 25 It will search for coin that has similar name to polka and display top 25 matches. -c, --coin stands for coin - you provide here your search query -k, --key it's a searching key. You can search by symbol, id or name of coin -l, --limit it displays top N number of records. coins: Shows list of coins available on CoinGecko, CoinPaprika and Binance.If you provide name of coin then in result you will see ids of coins with best match for all mentioned services. If you provide "ALL" in your coin search query, then all coins will be displayed. To move over coins you can use pagination mechanism with skip, top params. E.g. coins ALL --skip 100 --limit 30 then all coins from 100 to 130 will be displayed. By default skip = 0, limit = 10. If you won't provide source of the data everything will be displayed (CoinGecko, CoinPaprika, Binance). If you want to search only in given source then use --source flag. E.g. if you want to find coin with name uniswap on CoinPaprika then use: coins uniswap --source cp --limit 10
|
||||
|
||||
### Usage
|
||||
|
||||
```python
|
||||
usage: find -c COIN [-k {id,symbol,name}] [-l LIMIT] [-s SKIP]
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Parameters
|
||||
|
||||
| Name | Description | Default | Optional | Choices |
|
||||
| ---- | ----------- | ------- | -------- | ------- |
|
||||
| coin | Symbol Name or Id of Coin | None | False | None |
|
||||
| key | Specify by which column you would like to search: symbol, name, id | symbol | True | id, symbol, name |
|
||||
| limit | Number of records to display | 10 | True | None |
|
||||
| skip | Skip n of records | 0 | True | range(1, 300) |
|
||||
---
|
||||
|
||||
|
||||
@@ -1,25 +1,25 @@
|
||||
---
|
||||
title: headlines
|
||||
description: OpenBB Terminal Function
|
||||
---
|
||||
|
||||
# headlines
|
||||
|
||||
Display sentiment analysis from FinBrain for chosen Cryptocurrencies
|
||||
|
||||
### Usage
|
||||
|
||||
```python
|
||||
usage: headlines
|
||||
[-c {AAVE,ADA,ADX,AE,ANT,ARDR,ARK,ATOM,BAT,BCCOIN,BCH,BCN,BLOCK,BNB,BNT,BTC,BTCD,BTG,BTM,BTS,CVC,DASH,DCN,DCR,DGB,DGD,DNT,DOGE,DOT,EDG,EOS,ETH,ETP,FAIR,FCT,FUN,GAME,GAS,GBYTE,GNO,GNT,HSR,ICX,IOC,KIN,KMD,KNC,LINK,LKK,LRC,LSK,LTC,MAID,MCAP,MCO,MGO,MKR,MLN,MONA,MTL,NAV,NEBL,NEO,NLC2,NXS,NXT,OMG,PAY,PIVX,PPT,QASH,QRL,QTUM,REP,RLC,SALT,SC,SMART,SNGLS,STEEM,STORJ,SUB,SYS,TAAS,TRX,UBQ,UNI,USDT,VEN,VERI,VTC,WAVES,WINGS,WTC,XCP,XLM,XMR,XRP,XTZ,XVG,YFI,ZEC,ZEN,ZRX}]
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Parameters
|
||||
|
||||
| Name | Description | Default | Optional | Choices |
|
||||
| ---- | ----------- | ------- | -------- | ------- |
|
||||
| coin | Symbol of coin to load data for, ~100 symbols are available | BTC | True | AAVE, ADA, ADX, AE, ANT, ARDR, ARK, ATOM, BAT, BCCOIN, BCH, BCN, BLOCK, BNB, BNT, BTC, BTCD, BTG, BTM, BTS, CVC, DASH, DCN, DCR, DGB, DGD, DNT, DOGE, DOT, EDG, EOS, ETH, ETP, FAIR, FCT, FUN, GAME, GAS, GBYTE, GNO, GNT, HSR, ICX, IOC, KIN, KMD, KNC, LINK, LKK, LRC, LSK, LTC, MAID, MCAP, MCO, MGO, MKR, MLN, MONA, MTL, NAV, NEBL, NEO, NLC2, NXS, NXT, OMG, PAY, PIVX, PPT, QASH, QRL, QTUM, REP, RLC, SALT, SC, SMART, SNGLS, STEEM, STORJ, SUB, SYS, TAAS, TRX, UBQ, UNI, USDT, VEN, VERI, VTC, WAVES, WINGS, WTC, XCP, XLM, XMR, XRP, XTZ, XVG, YFI, ZEC, ZEN, ZRX |
|
||||
---
|
||||
|
||||
---
|
||||
title: headlines
|
||||
description: OpenBB Terminal Function
|
||||
---
|
||||
|
||||
# headlines
|
||||
|
||||
Display sentiment analysis from FinBrain for chosen Cryptocurrencies
|
||||
|
||||
### Usage
|
||||
|
||||
```python
|
||||
usage: headlines
|
||||
[-c {AAVE,ADA,ADX,AE,ANT,ARDR,ARK,ATOM,BAT,BCCOIN,BCH,BCN,BLOCK,BNB,BNT,BTC,BTCD,BTG,BTM,BTS,CVC,DASH,DCN,DCR,DGB,DGD,DNT,DOGE,DOT,EDG,EOS,ETH,ETP,FAIR,FCT,FUN,GAME,GAS,GBYTE,GNO,GNT,HSR,ICX,IOC,KIN,KMD,KNC,LINK,LKK,LRC,LSK,LTC,MAID,MCAP,MCO,MGO,MKR,MLN,MONA,MTL,NAV,NEBL,NEO,NLC2,NXS,NXT,OMG,PAY,PIVX,PPT,QASH,QRL,QTUM,REP,RLC,SALT,SC,SMART,SNGLS,STEEM,STORJ,SUB,SYS,TAAS,TRX,UBQ,UNI,USDT,VEN,VERI,VTC,WAVES,WINGS,WTC,XCP,XLM,XMR,XRP,XTZ,XVG,YFI,ZEC,ZEN,ZRX}]
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Parameters
|
||||
|
||||
| Name | Description | Default | Optional | Choices |
|
||||
| ---- | ----------- | ------- | -------- | ------- |
|
||||
| coin | Symbol of coin to load data for, ~100 symbols are available | BTC | True | AAVE, ADA, ADX, AE, ANT, ARDR, ARK, ATOM, BAT, BCCOIN, BCH, BCN, BLOCK, BNB, BNT, BTC, BTCD, BTG, BTM, BTS, CVC, DASH, DCN, DCR, DGB, DGD, DNT, DOGE, DOT, EDG, EOS, ETH, ETP, FAIR, FCT, FUN, GAME, GAS, GBYTE, GNO, GNT, HSR, ICX, IOC, KIN, KMD, KNC, LINK, LKK, LRC, LSK, LTC, MAID, MCAP, MCO, MGO, MKR, MLN, MONA, MTL, NAV, NEBL, NEO, NLC2, NXS, NXT, OMG, PAY, PIVX, PPT, QASH, QRL, QTUM, REP, RLC, SALT, SC, SMART, SNGLS, STEEM, STORJ, SUB, SYS, TAAS, TRX, UBQ, UNI, USDT, VEN, VERI, VTC, WAVES, WINGS, WTC, XCP, XLM, XMR, XRP, XTZ, XVG, YFI, ZEC, ZEN, ZRX |
|
||||
---
|
||||
|
||||
|
||||
@@ -1,31 +1,31 @@
|
||||
---
|
||||
title: load
|
||||
description: OpenBB Terminal Function
|
||||
---
|
||||
|
||||
# load
|
||||
|
||||
Load crypto currency to perform analysis on. Yahoo Finance is used as default source. Other sources can be used such as 'ccxt' or 'cg' with --source. If you select 'ccxt', you can then select any exchange with --exchange. You can also select a specific interval with --interval.
|
||||
|
||||
### Usage
|
||||
|
||||
```python
|
||||
usage: load -c COIN [-s START]
|
||||
[--exchange {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,bkex,bl3p,btcalpha,btcbox,btcex,btcmarkets,btctradeua,btcturk,buda,bw,bybit,bytetrade,cex,coinbaseprime,coinbasepro,coincheck,coinex,coinfalcon,coinmate,coinone,coinspot,crex24,cryptocom,currencycom,delta,deribit,digifinex,eqonex,exmo,flowbtc,fmfwio,ftx,ftxus,gate,gateio,gemini,hitbtc,hitbtc3,hollaex,huobi,huobijp,huobipro,idex,independentreserve,indodax,itbit,kraken,kucoin,kucoinfutures,kuna,latoken,lbank,lbank2,liquid,luno,lykke,mercado,mexc,mexc3,ndax,novadax,oceanex,okcoin,okex,okex5,okx,paymium,phemex,poloniex,probit,qtrade,ripio,stex,therock,tidebit,tidex,timex,tokocrypto,upbit,wavesexchange,whitebit,woo,yobit,zaif,zb,zipmex,zonda}]
|
||||
[-e END] [-i {1,5,15,30,60,240,1440,10080,43200}] [--vs VS]
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Parameters
|
||||
|
||||
| Name | Description | Default | Optional | Choices |
|
||||
| ---- | ----------- | ------- | -------- | ------- |
|
||||
| coin | Coin to get. Must be coin symbol (e.g., btc, eth) | None | False | None |
|
||||
| start | The starting date (format YYYY-MM-DD) of the crypto | 2019-11-18 | True | None |
|
||||
| exchange | Exchange to search | binance | True | 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, bkex, bl3p, btcalpha, btcbox, btcex, btcmarkets, btctradeua, btcturk, buda, bw, bybit, bytetrade, cex, coinbaseprime, coinbasepro, coincheck, coinex, coinfalcon, coinmate, coinone, coinspot, crex24, cryptocom, currencycom, delta, deribit, digifinex, eqonex, exmo, flowbtc, fmfwio, ftx, ftxus, gate, gateio, gemini, hitbtc, hitbtc3, hollaex, huobi, huobijp, huobipro, idex, independentreserve, indodax, itbit, kraken, kucoin, kucoinfutures, kuna, latoken, lbank, lbank2, liquid, luno, lykke, mercado, mexc, mexc3, ndax, novadax, oceanex, okcoin, okex, okex5, okx, paymium, phemex, poloniex, probit, qtrade, ripio, stex, therock, tidebit, tidex, timex, tokocrypto, upbit, wavesexchange, whitebit, woo, yobit, zaif, zb, zipmex, zonda |
|
||||
| end | The ending date (format YYYY-MM-DD) of the crypto | 2022-11-22 | True | None |
|
||||
| interval | The interval of the crypto | 1440 | True | 1, 5, 15, 30, 60, 240, 1440, 10080, 43200 |
|
||||
| vs | Quote currency (what to view coin vs). e.g., usdc, usdt, ... if source is ccxt, usd, eur, ... otherwise | usdt | True | None |
|
||||
---
|
||||
|
||||
---
|
||||
title: load
|
||||
description: OpenBB Terminal Function
|
||||
---
|
||||
|
||||
# load
|
||||
|
||||
Load crypto currency to perform analysis on. Yahoo Finance is used as default source. Other sources can be used such as 'ccxt' or 'cg' with --source. If you select 'ccxt', you can then select any exchange with --exchange. You can also select a specific interval with --interval.
|
||||
|
||||
### Usage
|
||||
|
||||
```python
|
||||
usage: load -c COIN [-s START]
|
||||
[--exchange {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,bkex,bl3p,btcalpha,btcbox,btcex,btcmarkets,btctradeua,btcturk,buda,bw,bybit,bytetrade,cex,coinbaseprime,coinbasepro,coincheck,coinex,coinfalcon,coinmate,coinone,coinspot,crex24,cryptocom,currencycom,delta,deribit,digifinex,eqonex,exmo,flowbtc,fmfwio,ftx,ftxus,gate,gateio,gemini,hitbtc,hitbtc3,hollaex,huobi,huobijp,huobipro,idex,independentreserve,indodax,itbit,kraken,kucoin,kucoinfutures,kuna,latoken,lbank,lbank2,liquid,luno,lykke,mercado,mexc,mexc3,ndax,novadax,oceanex,okcoin,okex,okex5,okx,paymium,phemex,poloniex,probit,qtrade,ripio,stex,therock,tidebit,tidex,timex,tokocrypto,upbit,wavesexchange,whitebit,woo,yobit,zaif,zb,zipmex,zonda}]
|
||||
[-e END] [-i {1,5,15,30,60,240,1440,10080,43200}] [--vs VS]
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Parameters
|
||||
|
||||
| Name | Description | Default | Optional | Choices |
|
||||
| ---- | ----------- | ------- | -------- | ------- |
|
||||
| coin | Coin to get. Must be coin symbol (e.g., btc, eth) | None | False | None |
|
||||
| start | The starting date (format YYYY-MM-DD) of the crypto | 2019-11-18 | True | None |
|
||||
| exchange | Exchange to search | binance | True | 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, bkex, bl3p, btcalpha, btcbox, btcex, btcmarkets, btctradeua, btcturk, buda, bw, bybit, bytetrade, cex, coinbaseprime, coinbasepro, coincheck, coinex, coinfalcon, coinmate, coinone, coinspot, crex24, cryptocom, currencycom, delta, deribit, digifinex, eqonex, exmo, flowbtc, fmfwio, ftx, ftxus, gate, gateio, gemini, hitbtc, hitbtc3, hollaex, huobi, huobijp, huobipro, idex, independentreserve, indodax, itbit, kraken, kucoin, kucoinfutures, kuna, latoken, lbank, lbank2, liquid, luno, lykke, mercado, mexc, mexc3, ndax, novadax, oceanex, okcoin, okex, okex5, okx, paymium, phemex, poloniex, probit, qtrade, ripio, stex, therock, tidebit, tidex, timex, tokocrypto, upbit, wavesexchange, whitebit, woo, yobit, zaif, zb, zipmex, zonda |
|
||||
| end | The ending date (format YYYY-MM-DD) of the crypto | 2022-11-22 | True | None |
|
||||
| interval | The interval of the crypto | 1440 | True | 1, 5, 15, 30, 60, 240, 1440, 10080, 43200 |
|
||||
| vs | Quote currency (what to view coin vs). e.g., usdc, usdt, ... if source is ccxt, usd, eur, ... otherwise | usdt | True | None |
|
||||
---
|
||||
|
||||
|
||||
@@ -1,25 +1,25 @@
|
||||
---
|
||||
title: collections
|
||||
description: OpenBB Terminal Function
|
||||
---
|
||||
|
||||
# collections
|
||||
|
||||
NFT Collections [Source: https://nftpricefloor.com/]
|
||||
|
||||
### Usage
|
||||
|
||||
```python
|
||||
usage: collections [--fp] [--sales]
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Parameters
|
||||
|
||||
| Name | Description | Default | Optional | Choices |
|
||||
| ---- | ----------- | ------- | -------- | ------- |
|
||||
| fp | Flag to display floor price over time for top collections | False | True | None |
|
||||
| sales | Flag to display sales over time for top collections | False | True | None |
|
||||
---
|
||||
|
||||
---
|
||||
title: collections
|
||||
description: OpenBB Terminal Function
|
||||
---
|
||||
|
||||
# collections
|
||||
|
||||
NFT Collections [Source: https://nftpricefloor.com/]
|
||||
|
||||
### Usage
|
||||
|
||||
```python
|
||||
usage: collections [--fp] [--sales]
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Parameters
|
||||
|
||||
| Name | Description | Default | Optional | Choices |
|
||||
| ---- | ----------- | ------- | -------- | ------- |
|
||||
| fp | Flag to display floor price over time for top collections | False | True | None |
|
||||
| sales | Flag to display sales over time for top collections | False | True | None |
|
||||
---
|
||||
|
||||
|
||||
File diff suppressed because one or more lines are too long
@@ -1,24 +1,24 @@
|
||||
---
|
||||
title: stats
|
||||
description: OpenBB Terminal Function
|
||||
---
|
||||
|
||||
# stats
|
||||
|
||||
Display stats about an opensea nft collection. e.g. alien-frens [Source: https://opensea.io]
|
||||
|
||||
### Usage
|
||||
|
||||
```python
|
||||
usage: info -s SLUG
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Parameters
|
||||
|
||||
| Name | Description | Default | Optional | Choices |
|
||||
| ---- | ----------- | ------- | -------- | ------- |
|
||||
| slug | Opensea collection slug (e.g., mutant-ape-yacht-club) | None | False | None |
|
||||
---
|
||||
|
||||
---
|
||||
title: stats
|
||||
description: OpenBB Terminal Function
|
||||
---
|
||||
|
||||
# stats
|
||||
|
||||
Display stats about an opensea nft collection. e.g. alien-frens [Source: https://opensea.io]
|
||||
|
||||
### Usage
|
||||
|
||||
```python
|
||||
usage: info -s SLUG
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Parameters
|
||||
|
||||
| Name | Description | Default | Optional | Choices |
|
||||
| ---- | ----------- | ------- | -------- | ------- |
|
||||
| slug | Opensea collection slug (e.g., mutant-ape-yacht-club) | None | False | None |
|
||||
---
|
||||
|
||||
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user