diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 4596b446fcb..d3a9b8ade89 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -3,17 +3,17 @@ - [ ] Summary of the change / bug fix. - [ ] Link # issue, if applicable. - [ ] Screenshot of the feature or the bug before/after fix, if applicable. -- [ ] Relevant motivation and context. +- [ ] Relevant motivation and context. - [ ] List any dependencies that are required for this change. # How has this been tested? -* Please describe the tests that you ran to verify your changes. -* Provide instructions so we can reproduce. +* Please describe the tests that you ran to verify your changes. +* Provide instructions so we can reproduce. * Please also list any relevant details for your test configuration. - [ ] Make sure affected commands still run in terminal -- [ ] Ensure the api still works +- [ ] Ensure the SDK still works - [ ] Check any related reports diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 6b4d15aed63..546bafbe888 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -12,7 +12,7 @@ Use your best judgment, and feel free to propose changes to this document in a p - [Model](#model) - [View](#view) - [Controller](#controller) - - [Add API endpoint](#add-api-endpoint) + - [Add SDK endpoint](#add-sdk-endpoint) - [Add Documentation](#add-documentation) - [Open a Pull Request](#open-a-pull-request) - [Review Process](#review-process) @@ -305,11 +305,11 @@ The **import only occurs inside this menu call**, this is so that the loading ti In addition, note the `self.load_class` which allows to not create a new DarkPoolShortsController instance but re-load the previous created one. Unless the arguments `self.ticker, self.start, self.stock` have changed since. The `self.queue` list of commands is passed around as it contains the commands that the terminal must perform. -### Add API endpoint +### Add SDK endpoint -In order to add a command to the API, follow these steps: +In order to add a command to the SDK, follow these steps: -1. Go to the `api.py` file and scroll to the `functions` dictionary, it should look like this: +1. Go to the `sdk.py` file and scroll to the `functions` dictionary, it should look like this: ```python functions = { @@ -327,7 +327,7 @@ In order to add a command to the API, follow these steps: ... ``` -2. Add a new key to the dictionary, which corresponds to the way the added command shall be accessed from the api. +2. Add a new key to the dictionary, which corresponds to the way the added command shall be accessed from the sdk. This is called the `virtual path`. In this case it should be `stocks.dps.shorted`. 3. Now it is time to add the value to the key. This key shall be another dictionary with a `model` key and possibly a `view` key. @@ -481,7 +481,7 @@ CLI :computer: → `_controller.py` :robot: → `_view.py` :art:  &nbs                 ↑    -`api.py` :factory: +`sdk.py` :factory:   ↑ @@ -490,7 +490,7 @@ CLI :computer: → `_controller.py` :robot: → `_view.py` :art:  &nbs | **_controller.py** :robot: | The router/input validator | The controller file should hold the least amount of logic possible. Its role is to be a stupid (no logic) router and redirect the command correctly while checking the input with argparser. | | **_view.py** :art: | The artist | The view file should only output or visualise the data it gets from the `_model` file! The `_view` can limit the data coming from the `_model`, otherwise the data object should be identical in the `_view` and the `_model` files. | | **_model.py** 🧠 |The brain | The model file is where everything fun happens. The data is gathered (external APIs), processed and returned here. | -| **api.py** 🏭 |The API Factory | The API file is where the callable functions are created for the API. There is only one api file in the openbb_terminal folder. | +| **sdk.py** 🏭 |The SDK Factory | The SDK file is where the callable functions are created for the SDK. There is only one SDK file in the openbb_terminal folder. | ### Frontend @@ -550,7 +550,7 @@ With: 1. Each function should have default values for non critical kwargs - - Why? It increases code readability and acts as an input example for the functions arguments. This increases the ease of use of the functions through the api, but also just generally. + - Why? It increases code readability and acts as an input example for the functions arguments. This increases the ease of use of the functions through the SDK, but also just generally.
@@ -624,7 +624,7 @@ With: 3. Each function needs to have a docstring explaining what it does, its parameters and what it returns. - - Why? You can use the function without reading its source code. This improves the developing experience and api usage. The api factory also can’t handle functions with out docstrings. + - Why? You can use the function without reading its source code. This improves the developing experience and SDK usage. The SDK factory also can’t handle functions with out docstrings.
@@ -662,7 +662,7 @@ With: - Why? Two reasons: - These calculations can then be used outside of the class with custom data; for example via the api or for tests. + These calculations can then be used outside of the class with custom data; for example via the sdk or for tests. ```python from openbb_terminal.portfolio.portfolio_helper import get_gaintopain_ratio @@ -671,18 +671,18 @@ With: get_gaintopain_ratio(historical_trade_data, benchmark_trades, benchmark_returns) ``` - The function can be loaded in API factory as an endpoint and user can get result by passing the class instance. + The function can be loaded in SDK factory as an endpoint and user can get result by passing the class instance. ```python - from openbb_terminal.api import openbb - from openbb_terminal.api import Portfolio + from openbb_terminal.sdk import openbb + from openbb_terminal.sdk import Portfolio transactions = Portfolio.read_orderbook("../../portfolio/holdings/example.csv") P = Portfolio(transactions) P.generate_portfolio_data() P.load_benchmark() - # API endpoint access + # SDK endpoint access openbb.portfolio.gaintopain(P) ``` @@ -731,7 +731,7 @@ With: 6. Naming among related model and view functions should be obvious; just different prefix if possible - - Why? Eases API factory mapping and keeps code clean. + - Why? Eases SDK factory mapping and keeps code clean.
@@ -787,7 +787,7 @@ With: 1. No data altering in the view file or controller file (view and model with same args) - - Why? Consistency and good code structure. This also improves the api user experience. Thus follows that view and model files will have the same arguments (except for output options like raw, export, external_axes), since no data changes shall be done in the view file. + - Why? Consistency and good code structure. This also improves the SDK user experience. Thus follows that view and model files will have the same arguments (except for output options like raw, export, external_axes), since no data changes shall be done in the view file.
@@ -807,7 +807,7 @@ When in doubt, follow . #### OpenBB Style Guide -The style guide is a reverse dictionary for argument names, where a brief definition is mapped to an OpenBB recommended argument name and type. When helpful a code snippet example is added below. Following this guide will help keep argument naming consistent and improve API users experience. +The style guide is a reverse dictionary for argument names, where a brief definition is mapped to an OpenBB recommended argument name and type. When helpful a code snippet example is added below. Following this guide will help keep argument naming consistent and improve SDK users experience. Style guide structure: diff --git a/docs/generate.py b/docs/generate.py index 9605cadc716..099b12b787b 100644 --- a/docs/generate.py +++ b/docs/generate.py @@ -4,7 +4,7 @@ import importlib import os from ruamel.yaml import YAML -from openbb_terminal.api import functions +from openbb_terminal.sdk import functions # NOTE: The main.yml and documentation _index.md files are automaticallty overridden # every time this is ran. Folder level _index.md files are NOT overridden after creation @@ -14,8 +14,8 @@ yaml.indent(mapping=2, sequence=4, offset=2) def all_functions() -> List[Tuple[str, str, Callable[..., Any]]]: - """Uses the base api functions dictionary to get a list of all functions we have linked - in our API. + """Uses the base SDK functions dictionary to get a list of all functions we have linked + in our SDK. Returns ---------- @@ -165,11 +165,11 @@ def generate_dict(paths: List): final_dict: Dict[str, Any] = {} added_paths = [] for path, subs in paths: - if not final_dict and path == "api": - final_dict = {"name": "api", "ref": "/api", "sub": []} + if not final_dict and path == "sdk": + final_dict = {"name": "sdk", "ref": "/sdk", "sub": []} for sub in subs: final_dict["sub"].append({"name": sub, "ref": f"/{path}/{sub}"}) - added_paths.append("api") + added_paths.append("sdk") if path not in added_paths: final_dict = set_items(final_dict, path, subs) added_paths.append(path) @@ -189,9 +189,9 @@ def folder_documentation(path: str): if __name__ == "__main__": - base_folder_path = os.path.realpath("./website/content/api") + base_folder_path = os.path.realpath("./website/content/sdk") target_path = os.path.realpath("./website/data/menu/main.yml") - main_path = os.path.realpath("./website/content/api") + main_path = os.path.realpath("./website/content/sdk") folder_list = crawl_folders(main_path) for folder_path in [x[0] for x in folder_list]: folder_documentation(folder_path) diff --git a/openbb_terminal/API_README.md b/openbb_terminal/SDK_README.md similarity index 98% rename from openbb_terminal/API_README.md rename to openbb_terminal/SDK_README.md index 7baee346b10..de125a7eab5 100644 --- a/openbb_terminal/API_README.md +++ b/openbb_terminal/SDK_README.md @@ -62,18 +62,18 @@ you are using conda. First off, import OpenBB SDK into your python script or Jupyter Notebook with: ```python -from openbb_terminal.api import openbb +from openbb_terminal.sdk import openbb ``` This imports all Terminal commands at once. To see all the available commands, you can press `tab` in jupyter notebook. -Another approach is to check out [OpenBB SDK Documentation](https://openbb-finance.github.io/OpenBBTerminal/api/), where you can explore its capabilities +Another approach is to check out [OpenBB SDK Documentation](https://openbb-finance.github.io/OpenBBTerminal/sdk/), where you can explore its capabilities ### 2. Customize chart style With OpenBB SDK, you can customize your chart style. You can switch between `dark` and `light` easily using this block of code: ```python -from openbb_terminal.api import TerminalStyle +from openbb_terminal.sdk import TerminalStyle theme = TerminalStyle("light", "light", "light") ``` @@ -82,7 +82,7 @@ theme = TerminalStyle("light", "light", "light") OR ```python -from openbb_terminal.api import TerminalStyle +from openbb_terminal.sdk import TerminalStyle theme = TerminalStyle("dark", "dark", "dark") ``` @@ -178,7 +178,7 @@ Now, let's explore what OpenBB SDK can do. At a high level, you can break down O ### 1. Data Layer -### **Getting financial data from multiple data sources using one single API** +### **Getting financial data from multiple data sources using one single SDK** OpenBB SDK provides you access to normalized financial data from dozens of data sources, without having to built your own integration or relying on multiple third-party packages. Let's explore how we can do that. @@ -351,7 +351,7 @@ To display matplotlib charts inside the Jupyter notebook output cells, you can u ```python import matplotlib.pyplot as plt import matplotlib_inline.backend_inline -from openbb_terminal.api import openbb +from openbb_terminal.sdk import openbb %matplotlib inline matplotlib_inline.backend_inline.set_matplotlib_formats("svg") ``` @@ -362,7 +362,7 @@ The code below utilizes the `external_axes` parameter to get two axis in one cha ```python import matplotlib.pyplot as plt -from openbb_terminal.api import openbb +from openbb_terminal.sdk import openbb fig, (ax1, ax2) = plt.subplots(nrows=2, ncols=1, figsize=(11, 5), dpi=150) openbb.stocks.dps.dpotc( "aapl", diff --git a/openbb_terminal/dashboards/stream/forecast.py b/openbb_terminal/dashboards/stream/forecast.py index 5defda41e50..74bf6b8ec12 100644 --- a/openbb_terminal/dashboards/stream/forecast.py +++ b/openbb_terminal/dashboards/stream/forecast.py @@ -5,7 +5,7 @@ from inspect import signature import streamlit as st import pandas as pd import yfinance as yf -from openbb_terminal.api import openbb +from openbb_terminal.sdk import openbb from openbb_terminal.forecast import helpers from openbb_terminal.rich_config import console diff --git a/openbb_terminal/dashboards/voila/crypto.ipynb b/openbb_terminal/dashboards/voila/crypto.ipynb index 025bad396d6..e9166b0d46e 100644 --- a/openbb_terminal/dashboards/voila/crypto.ipynb +++ b/openbb_terminal/dashboards/voila/crypto.ipynb @@ -24,10 +24,9 @@ "from IPython.display import display\n", "import pandas as pd\n", "\n", - "from openbb_terminal import api\n", - "openbb = api.openbb\n", + "from openbb_terminal.sdk import openbb, widgets\n", "\n", - "ipw.HTML(f\"\")" + "ipw.HTML(f\"\")" ] }, { @@ -134,7 +133,7 @@ ], "metadata": { "kernelspec": { - "display_name": "Python 3 (ipykernel)", + "display_name": "Python 3.10.4 ('obb')", "language": "python", "name": "python3" }, @@ -148,10 +147,15 @@ "name": "python", "nbconvert_exporter": "python", "pygments_lexer": "ipython3", - "version": "3.9.6" + "version": "3.10.4" }, "voila": { "theme": "dark" + }, + "vscode": { + "interpreter": { + "hash": "1a8cc6b6e60740679b24fc1ea93bdeb94d949a22102a80c99b7fd3f0d572afd6" + } } }, "nbformat": 4, diff --git a/openbb_terminal/dashboards/voila/currencies.ipynb b/openbb_terminal/dashboards/voila/currencies.ipynb index dd3f5661365..a5936b1d43d 100644 --- a/openbb_terminal/dashboards/voila/currencies.ipynb +++ b/openbb_terminal/dashboards/voila/currencies.ipynb @@ -19,10 +19,10 @@ "import matplotlib_inline.backend_inline\n", "from openbb_terminal.dashboards.widget_helpers import price_card, stylesheet\n", "\n", - "from openbb_terminal import api as openbb\n", + "from openbb_terminal.sdk import openbb, theme\n", "\n", "%matplotlib widget\n", - "openbb.theme.applyMPLstyle()\n", + "theme.applyMPLstyle()\n", "ipw.HTML(f\"\")" ] }, @@ -259,7 +259,7 @@ ], "metadata": { "kernelspec": { - "display_name": "Python 3 (ipykernel)", + "display_name": "Python 3.10.4 ('obb')", "language": "python", "name": "python3" }, @@ -273,10 +273,15 @@ "name": "python", "nbconvert_exporter": "python", "pygments_lexer": "ipython3", - "version": "3.9.6" + "version": "3.10.4" }, "voila": { "theme": "dark" + }, + "vscode": { + "interpreter": { + "hash": "1a8cc6b6e60740679b24fc1ea93bdeb94d949a22102a80c99b7fd3f0d572afd6" + } } }, "nbformat": 4, diff --git a/openbb_terminal/dashboards/voila/forecast.ipynb b/openbb_terminal/dashboards/voila/forecast.ipynb index eb9abd8fee9..b26ae5536c6 100644 --- a/openbb_terminal/dashboards/voila/forecast.ipynb +++ b/openbb_terminal/dashboards/voila/forecast.ipynb @@ -54,12 +54,11 @@ "import pandas as pd\n", "from IPython.display import display\n", "\n", - "from openbb_terminal import api\n", - "openbb = api.openbb\n", + "from openbb_terminal.sdk import openbb, theme\n", "\n", "%matplotlib inline\n", "matplotlib_inline.backend_inline.set_matplotlib_formats(\"svg\")\n", - "api.theme.applyMPLstyle()" + "theme.applyMPLstyle()" ] }, { @@ -365,7 +364,7 @@ ], "metadata": { "kernelspec": { - "display_name": "Python 3 (ipykernel)", + "display_name": "Python 3.10.4 ('obb')", "language": "python", "name": "python3" }, @@ -379,12 +378,17 @@ "name": "python", "nbconvert_exporter": "python", "pygments_lexer": "ipython3", - "version": "3.9.6" + "version": "3.10.4" }, "metadata": { "interpreter": { "hash": "e896a00ead8b521528d79ac9ef24990696f2b751eb283ab8e0d078c9c4971ffc" } + }, + "vscode": { + "interpreter": { + "hash": "1a8cc6b6e60740679b24fc1ea93bdeb94d949a22102a80c99b7fd3f0d572afd6" + } } }, "nbformat": 4, diff --git a/openbb_terminal/dashboards/voila/vsurf.ipynb b/openbb_terminal/dashboards/voila/vsurf.ipynb index 906c382528b..3dfd598bde4 100644 --- a/openbb_terminal/dashboards/voila/vsurf.ipynb +++ b/openbb_terminal/dashboards/voila/vsurf.ipynb @@ -22,7 +22,7 @@ "if module_path not in sys.path:\n", " sys.path.append(module_path)\n", "\n", - "from openbb_terminal.api import openbb" + "from openbb_terminal.sdk import openbb" ] }, { @@ -140,7 +140,7 @@ ], "metadata": { "kernelspec": { - "display_name": "Python 3 (ipykernel)", + "display_name": "Python 3.10.4 ('obb')", "language": "python", "name": "python3" }, @@ -154,7 +154,12 @@ "name": "python", "nbconvert_exporter": "python", "pygments_lexer": "ipython3", - "version": "3.9.6" + "version": "3.10.4" + }, + "vscode": { + "interpreter": { + "hash": "1a8cc6b6e60740679b24fc1ea93bdeb94d949a22102a80c99b7fd3f0d572afd6" + } } }, "nbformat": 4, diff --git a/openbb_terminal/reports/crypto.ipynb b/openbb_terminal/reports/crypto.ipynb index ebd797a2e70..96a077ad35e 100644 --- a/openbb_terminal/reports/crypto.ipynb +++ b/openbb_terminal/reports/crypto.ipynb @@ -31,8 +31,8 @@ "# import sys\n", "# sys.path.append('../../')\n", "\n", - "from openbb_terminal.api import widgets\n", - "from openbb_terminal.api import openbb\n", + "from openbb_terminal.sdk import widgets\n", + "from openbb_terminal.sdk import openbb\n", "from openbb_terminal.helper_classes import TerminalStyle\n", "\n", "%matplotlib inline\n", @@ -1218,7 +1218,7 @@ "metadata": { "celltoolbar": "Tags", "kernelspec": { - "display_name": "Python 3 (ipykernel)", + "display_name": "Python 3.10.4 ('obb')", "language": "python", "name": "python3" }, @@ -1232,11 +1232,11 @@ "name": "python", "nbconvert_exporter": "python", "pygments_lexer": "ipython3", - "version": "3.9.13" + "version": "3.10.4" }, "vscode": { "interpreter": { - "hash": "ab0e87f2bc73919b75956d1b3e303320699d53da895be1bb46287d7dc67c6497" + "hash": "1a8cc6b6e60740679b24fc1ea93bdeb94d949a22102a80c99b7fd3f0d572afd6" } } }, diff --git a/openbb_terminal/reports/economy.ipynb b/openbb_terminal/reports/economy.ipynb index 7d1f6dd8279..6f404dd16f8 100644 --- a/openbb_terminal/reports/economy.ipynb +++ b/openbb_terminal/reports/economy.ipynb @@ -30,9 +30,9 @@ "\n", "from IPython.display import HTML\n", "\n", - "from openbb_terminal.api import widgets\n", - "from openbb_terminal.api import helper\n", - "from openbb_terminal.api import openbb\n", + "from openbb_terminal.sdk import widgets\n", + "from openbb_terminal.sdk import helper\n", + "from openbb_terminal.sdk import openbb\n", "from openbb_terminal.helper_classes import TerminalStyle\n", "\n", "\n", @@ -775,7 +775,7 @@ "metadata": { "celltoolbar": "Tags", "kernelspec": { - "display_name": "Python 3.9.13 ('obb')", + "display_name": "Python 3.10.4 ('obb')", "language": "python", "name": "python3" }, @@ -789,11 +789,11 @@ "name": "python", "nbconvert_exporter": "python", "pygments_lexer": "ipython3", - "version": "3.9.13" + "version": "3.10.4" }, "vscode": { "interpreter": { - "hash": "ab0e87f2bc73919b75956d1b3e303320699d53da895be1bb46287d7dc67c6497" + "hash": "1a8cc6b6e60740679b24fc1ea93bdeb94d949a22102a80c99b7fd3f0d572afd6" } } }, diff --git a/openbb_terminal/reports/equity.ipynb b/openbb_terminal/reports/equity.ipynb index 0ac2aca8be6..3e64ff57b1e 100644 --- a/openbb_terminal/reports/equity.ipynb +++ b/openbb_terminal/reports/equity.ipynb @@ -31,8 +31,8 @@ "# import sys\n", "# sys.path.append('../../')\n", "\n", - "from openbb_terminal.api import widgets\n", - "from openbb_terminal.api import openbb\n", + "from openbb_terminal.sdk import widgets\n", + "from openbb_terminal.sdk import openbb\n", "from openbb_terminal import config_terminal as cfg\n", "from openbb_terminal.helper_classes import TerminalStyle\n", "from openbb_terminal.core.config.paths import USER_ENV_FILE\n", @@ -1597,7 +1597,7 @@ "name": "python", "nbconvert_exporter": "python", "pygments_lexer": "ipython3", - "version": "3.9.6" + "version": "3.10.4" }, "vscode": { "interpreter": { diff --git a/openbb_terminal/reports/etf.ipynb b/openbb_terminal/reports/etf.ipynb index 84237e19cc9..e90eaebdff5 100644 --- a/openbb_terminal/reports/etf.ipynb +++ b/openbb_terminal/reports/etf.ipynb @@ -30,8 +30,8 @@ "# import sys\n", "# sys.path.append('../../')\n", "\n", - "from openbb_terminal.api import widgets\n", - "from openbb_terminal.api import openbb\n", + "from openbb_terminal.sdk import widgets\n", + "from openbb_terminal.sdk import openbb\n", "from openbb_terminal.helper_classes import TerminalStyle\n", "\n", "%matplotlib inline\n", diff --git a/openbb_terminal/reports/forecast.ipynb b/openbb_terminal/reports/forecast.ipynb index e9a14ca9431..b8a2ca8b261 100644 --- a/openbb_terminal/reports/forecast.ipynb +++ b/openbb_terminal/reports/forecast.ipynb @@ -27,8 +27,8 @@ "\n", "from IPython.display import HTML\n", "\n", - "from openbb_terminal.api import widgets\n", - "from openbb_terminal.api import openbb\n", + "from openbb_terminal.sdk import widgets\n", + "from openbb_terminal.sdk import openbb\n", "from openbb_terminal.helper_classes import TerminalStyle\n", "\n", "%matplotlib inline\n", @@ -273,7 +273,7 @@ "metadata": { "celltoolbar": "Tags", "kernelspec": { - "display_name": "Python 3 (ipykernel)", + "display_name": "Python 3.10.4 ('obb')", "language": "python", "name": "python3" }, @@ -287,11 +287,11 @@ "name": "python", "nbconvert_exporter": "python", "pygments_lexer": "ipython3", - "version": "3.9.6" + "version": "3.10.4" }, "vscode": { "interpreter": { - "hash": "ab0e87f2bc73919b75956d1b3e303320699d53da895be1bb46287d7dc67c6497" + "hash": "1a8cc6b6e60740679b24fc1ea93bdeb94d949a22102a80c99b7fd3f0d572afd6" } } }, diff --git a/openbb_terminal/reports/forex.ipynb b/openbb_terminal/reports/forex.ipynb index 29eb8832600..899c6489a70 100644 --- a/openbb_terminal/reports/forex.ipynb +++ b/openbb_terminal/reports/forex.ipynb @@ -31,8 +31,8 @@ "# import sys\n", "# sys.path.append('../../')\n", "\n", - "from openbb_terminal.api import widgets\n", - "from openbb_terminal.api import openbb\n", + "from openbb_terminal.sdk import widgets\n", + "from openbb_terminal.sdk import openbb\n", "from openbb_terminal.helper_classes import TerminalStyle\n", "\n", "%matplotlib inline\n", @@ -757,7 +757,7 @@ "metadata": { "celltoolbar": "Tags", "kernelspec": { - "display_name": "Python 3.9.13 ('obb')", + "display_name": "Python 3.10.4 ('obb')", "language": "python", "name": "python3" }, @@ -771,11 +771,11 @@ "name": "python", "nbconvert_exporter": "python", "pygments_lexer": "ipython3", - "version": "3.9.13" + "version": "3.10.4" }, "vscode": { "interpreter": { - "hash": "ab0e87f2bc73919b75956d1b3e303320699d53da895be1bb46287d7dc67c6497" + "hash": "1a8cc6b6e60740679b24fc1ea93bdeb94d949a22102a80c99b7fd3f0d572afd6" } } }, diff --git a/openbb_terminal/reports/portfolio.ipynb b/openbb_terminal/reports/portfolio.ipynb index a5f56373bd6..493cd34942c 100644 --- a/openbb_terminal/reports/portfolio.ipynb +++ b/openbb_terminal/reports/portfolio.ipynb @@ -33,10 +33,10 @@ "# import sys\n", "# sys.path.append('../../')\n", "\n", - "from openbb_terminal.api import widgets\n", - "from openbb_terminal.api import helper\n", - "from openbb_terminal.api import openbb\n", - "from openbb_terminal.api import Portfolio\n", + "from openbb_terminal.sdk import widgets\n", + "from openbb_terminal.sdk import helper\n", + "from openbb_terminal.sdk import openbb\n", + "from openbb_terminal.sdk import Portfolio\n", "from openbb_terminal.helper_classes import TerminalStyle\n", "\n", "%matplotlib inline\n", @@ -480,7 +480,7 @@ "metadata": { "celltoolbar": "Tags", "kernelspec": { - "display_name": "Python 3.9.13 ('obb')", + "display_name": "Python 3.10.4 ('obb')", "language": "python", "name": "python3" }, @@ -494,11 +494,11 @@ "name": "python", "nbconvert_exporter": "python", "pygments_lexer": "ipython3", - "version": "3.9.13" + "version": "3.10.4" }, "vscode": { "interpreter": { - "hash": "ab0e87f2bc73919b75956d1b3e303320699d53da895be1bb46287d7dc67c6497" + "hash": "1a8cc6b6e60740679b24fc1ea93bdeb94d949a22102a80c99b7fd3f0d572afd6" } } }, diff --git a/openbb_terminal/api.py b/openbb_terminal/sdk.py similarity index 99% rename from openbb_terminal/api.py rename to openbb_terminal/sdk.py index 90161cd44a6..0bb1f11e90a 100644 --- a/openbb_terminal/api.py +++ b/openbb_terminal/sdk.py @@ -1,4 +1,4 @@ -"""OpenBB Terminal API.""" +"""OpenBB Terminal SDK.""" # flake8: noqa # pylint: disable=unused-import,wrong-import-order # pylint: disable=C0302,W0611,not-callable,ungrouped-imports @@ -2098,7 +2098,7 @@ def change_docstring(api_callable, model: Callable, view=None): if view.__doc__ is not None: index = view.__doc__.find("Parameters") all_parameters = ( - "\nAPI function, use the chart kwarg for getting the view model and it's plot. " + "\nSDK function, use the chart kwarg for getting the view model and it's plot. " "See every parameter below:\n\n " + view.__doc__[index:] + """chart: bool @@ -2132,7 +2132,7 @@ def change_docstring(api_callable, model: Callable, view=None): class FunctionFactory: - """The API Function Factory, which creates the callable instance.""" + """The SDK Function Factory, which creates the callable instance.""" def __init__( self, model: Callable, view: Optional[Callable] = None, virtual_path: str = "" @@ -2205,10 +2205,10 @@ class MainMenu: def __repr__(self): """Get human readable representation.""" - return """This is the API of the OpenBB Terminal. - Use the API to get data directly into your jupyter notebook or directly use it in your application. + return """This is the OpenBB Terminal SDK. + Use the SDK to get data directly into your jupyter notebook or directly use it in your application. ... - For more information see the official documentation at: https://openbb-finance.github.io/OpenBBTerminal/api/ + For more information see the official documentation at: https://openbb-finance.github.io/OpenBBTerminal/sdk/ """ @@ -2218,7 +2218,7 @@ class Loader: def __init__(self, funcs: dict): print( "WARNING! Breaking changes incoming! Especially avoid using kwargs, since some of them will change.\n" - "For more information see the official documentation at: https://openbb-finance.github.io/OpenBBTerminal/api/" + "For more information see the official documentation at: https://openbb-finance.github.io/OpenBBTerminal/sdk/" ) self.__function_map = self.build_function_map(funcs=funcs) self.__initialize_logging() @@ -2230,8 +2230,8 @@ class Loader: def __repr__(self): """Get human readable representation.""" - return """This is the API of the OpenBB Terminal. - Use the API to get data directly into your jupyter notebook or directly use it in your application. + return """This is the OpenBB Terminal SDK. + Use the SDK to get data directly into your jupyter notebook or directly use it in your application. ... For more information see the official documentation at: https://openbb-finance.github.io/OpenBBTerminal/api/ """ @@ -2242,7 +2242,7 @@ class Loader: # pass def load_menus(self): - """Create the API structure by setting attributes and saving the functions. + """Create the SDK structure by setting attributes and saving the functions. See openbb.stocks.command """ @@ -2268,7 +2268,7 @@ class Loader: filtered_dict = {k: v for (k, v) in function_map.items() if path_str in k} def f(): - string = menu.upper() + " Menu\n\nThe api commands of the the menu:" + string = menu.upper() + " Menu\n\nThe SDK commands of the the menu:" for command in filtered_dict: string += "\n\t." + command return string @@ -2407,6 +2407,6 @@ class Loader: return function_map -# TO USE THE API DIRECTLY JUST IMPORT IT: -# from openbb_terminal.api import openbb (or: from openbb_terminal.api import openbb as api) +# TO USE THE SDK DIRECTLY JUST IMPORT IT: +# from openbb_terminal.sdk import openbb (or: from openbb_terminal.sdk import openbb as sdk) openbb = Loader(funcs=functions).openbb diff --git a/tests/openbb_terminal/api/test_api.py b/tests/openbb_terminal/api/test_api.py index 7e00851a69e..0962b4c3983 100644 --- a/tests/openbb_terminal/api/test_api.py +++ b/tests/openbb_terminal/api/test_api.py @@ -6,7 +6,6 @@ def test_load_api(): - # pylint: import-outside-toplevel - from openbb_terminal import api + from openbb_terminal import sdk - print(api) + print(sdk) diff --git a/website/content/sdk/_index.md b/website/content/sdk/_index.md index 0a72908aab5..168b54c097f 100644 --- a/website/content/sdk/_index.md +++ b/website/content/sdk/_index.md @@ -27,18 +27,18 @@ So that you can focus on designing and building your financial reports and appli First off, import OpenBB SDK into your python script or Jupyter Notebook with: ```python -from openbb_terminal.api import openbb +from openbb_terminal.sdk import openbb ``` This imports all Terminal commands at once. To see all the available commands, you can press `tab` in jupyter notebook. -Another approach is to check out [OpenBB SDK Documentation](https://openbb-finance.github.io/OpenBBTerminal/api/), where you can explore its capabilities +Another approach is to check out [OpenBB SDK Documentation](https://openbb-finance.github.io/OpenBBTerminal/sdk/), where you can explore its capabilities ### 2. Customize chart style With OpenBB SDK, you can customize your chart style. You can switch between `dark` and `light` easily using this block of code: ```python -from openbb_terminal.api import TerminalStyle +from openbb_terminal.sdk import TerminalStyle theme = TerminalStyle("light", "light", "light") ``` @@ -47,7 +47,7 @@ theme = TerminalStyle("light", "light", "light") OR ```python -from openbb_terminal.api import TerminalStyle +from openbb_terminal.sdk import TerminalStyle theme = TerminalStyle("dark", "dark", "dark") ``` @@ -316,7 +316,7 @@ To display matplotlib charts inside the Jupyter notebook output cells, you can u ```python import matplotlib.pyplot as plt import matplotlib_inline.backend_inline -from openbb_terminal.api import openbb +from openbb_terminal.sdk import openbb %matplotlib inline matplotlib_inline.backend_inline.set_matplotlib_formats("svg") ``` @@ -327,7 +327,7 @@ The code below utilizes the `external_axes` parameter to get two axis in one cha ```python import matplotlib.pyplot as plt -from openbb_terminal.api import openbb +from openbb_terminal.sdk import openbb fig, (ax1, ax2) = plt.subplots(nrows=2, ncols=1, figsize=(11, 5), dpi=150) openbb.stocks.dps.dpotc( "aapl", diff --git a/website/content/sdk/common/ta/cg/_index.md b/website/content/sdk/common/ta/cg/_index.md index c4524d06f77..aae2d5c47cc 100644 --- a/website/content/sdk/common/ta/cg/_index.md +++ b/website/content/sdk/common/ta/cg/_index.md @@ -13,7 +13,7 @@ Center of gravity Length for indicator window Returns ---------- - d.DataFrame + pd.DataFrame Dataframe of technical indicator ## Getting charts diff --git a/website/content/sdk/crypto/candles/_index.md b/website/content/sdk/crypto/candles/_index.md index 917dbdedee2..d1349b73ec7 100644 --- a/website/content/sdk/crypto/candles/_index.md +++ b/website/content/sdk/crypto/candles/_index.md @@ -1,5 +1,5 @@ ## Get underlying data -### crypto.candles(candles_df: 'pd.DataFrame', volume: 'bool' = True, ylabel: 'str' = '', title: 'str' = '', external_axes: 'list[plt.Axes] | None' = None) -> 'None' +### crypto.candles(candles_df: 'pd.DataFrame', volume: 'bool' = True, ylabel: 'str' = '', title: 'str' = '', external_axes: 'list[plt.Axes] | None' = None, yscale: 'str' = 'linear') -> 'None' Plot candle chart from dataframe. [Source: Binance] @@ -15,3 +15,5 @@ Plot candle chart from dataframe. [Source: Binance] Title of graph, by default "" external_axes : Optional[List[plt.Axes]], optional External axes (1 axis is expected in the list), by default None + yscale : str + Scaling for y axis. Either linear or log diff --git a/website/content/sdk/crypto/chart/_index.md b/website/content/sdk/crypto/chart/_index.md index b44cca5ebaf..321ee235bb6 100644 --- a/website/content/sdk/crypto/chart/_index.md +++ b/website/content/sdk/crypto/chart/_index.md @@ -1,7 +1,7 @@ To obtain charts, make sure to add `chart=True` as the last parameter ## Get underlying data -### crypto.chart(prices_df: 'pd.DataFrame', to_symbol: 'str' = '', from_symbol: 'str' = '', source: 'str' = '', exchange: 'str' = '', interval: 'str' = '', external_axes: 'list[plt.Axes] | None' = None) -> 'None' +### crypto.chart(prices_df: 'pd.DataFrame', to_symbol: 'str' = '', from_symbol: 'str' = '', source: 'str' = '', exchange: 'str' = '', interval: 'str' = '', external_axes: 'list[plt.Axes] | None' = None, yscale: 'str' = 'linear') -> 'None' Load data for Technical Analysis @@ -13,9 +13,11 @@ Load data for Technical Analysis Coin (only used for chart title), by default "" from_symbol: str Currency (only used for chart title), by default "" + yscale: str + Scale for y axis of plot Either linear or log ## Getting charts -### crypto.chart(prices_df: 'pd.DataFrame', to_symbol: 'str' = '', from_symbol: 'str' = '', source: 'str' = '', exchange: 'str' = '', interval: 'str' = '', external_axes: 'list[plt.Axes] | None' = None, chart=True) -> 'None' +### crypto.chart(prices_df: 'pd.DataFrame', to_symbol: 'str' = '', from_symbol: 'str' = '', source: 'str' = '', exchange: 'str' = '', interval: 'str' = '', external_axes: 'list[plt.Axes] | None' = None, yscale: 'str' = 'linear', chart=True) -> 'None' Load data for Technical Analysis @@ -27,3 +29,5 @@ Load data for Technical Analysis Coin (only used for chart title), by default "" from_symbol: str Currency (only used for chart title), by default "" + yscale: str + Scale for y axis of plot Either linear or log diff --git a/website/content/sdk/crypto/dd/active/_index.md b/website/content/sdk/crypto/dd/active/_index.md index 5f5b2ec2830..7473c7dec52 100644 --- a/website/content/sdk/crypto/dd/active/_index.md +++ b/website/content/sdk/crypto/dd/active/_index.md @@ -1,7 +1,7 @@ To obtain charts, make sure to add `chart=True` as the last parameter ## Get underlying data -### crypto.dd.active(symbol: str, interval: str = '24h', start_date: int = 1262304000, end_date: int = 1665471332) -> pandas.core.frame.DataFrame +### crypto.dd.active(symbol: str, interval: str = '24h', start_date: int = 1262304000, end_date: int = 1666094607) -> pandas.core.frame.DataFrame Returns active addresses of a certain symbol [Source: https://glassnode.com] diff --git a/website/content/sdk/crypto/dd/btcrb/_index.md b/website/content/sdk/crypto/dd/btcrb/_index.md index 4a934a689ca..e77d8bb6b5a 100644 --- a/website/content/sdk/crypto/dd/btcrb/_index.md +++ b/website/content/sdk/crypto/dd/btcrb/_index.md @@ -1,7 +1,7 @@ To obtain charts, make sure to add `chart=True` as the last parameter ## Get underlying data -### crypto.dd.btcrb(start_date: str = '2010-01-01', end_date: str = '2022-10-11') +### crypto.dd.btcrb(start_date: str = '2010-01-01', end_date: str = '2022-10-18') Get bitcoin price data [Price data from source: https://glassnode.com] @@ -15,7 +15,7 @@ Get bitcoin price data Final date, format YYYY-MM-DD ## Getting charts -### crypto.dd.btcrb(start_date: str = '2010-01-01', end_date: str = '2022-10-11', export: str = '', external_axes: Optional[List[matplotlib.axes._axes.Axes]] = None, chart=True) +### crypto.dd.btcrb(start_date: str = '2010-01-01', end_date: str = '2022-10-18', export: str = '', external_axes: Optional[List[matplotlib.axes._axes.Axes]] = None, chart=True) Displays bitcoin rainbow chart [Price data from source: https://glassnode.com] diff --git a/website/content/sdk/crypto/dd/change/_index.md b/website/content/sdk/crypto/dd/change/_index.md index 1cc771d11b1..e0be82d10ef 100644 --- a/website/content/sdk/crypto/dd/change/_index.md +++ b/website/content/sdk/crypto/dd/change/_index.md @@ -1,7 +1,7 @@ To obtain charts, make sure to add `chart=True` as the last parameter ## Get underlying data -### crypto.dd.change(symbol: str, exchange: str = 'binance', start_date: int = 1262304000, end_date: int = 1665471332) -> pandas.core.frame.DataFrame +### crypto.dd.change(symbol: str, exchange: str = 'binance', start_date: int = 1262304000, end_date: int = 1666094607) -> pandas.core.frame.DataFrame Returns 30d change of the supply held in exchange wallets of a certain symbol. [Source: https://glassnode.com] diff --git a/website/content/sdk/crypto/dd/close/_index.md b/website/content/sdk/crypto/dd/close/_index.md index 8187a1084fd..c3698874849 100644 --- a/website/content/sdk/crypto/dd/close/_index.md +++ b/website/content/sdk/crypto/dd/close/_index.md @@ -1,5 +1,5 @@ ## Get underlying data -### crypto.dd.close(symbol: str, start_date: str = '2010-01-01', end_date: str = '2022-10-11', print_errors: bool = True) -> pandas.core.frame.DataFrame +### crypto.dd.close(symbol: str, start_date: str = '2010-01-01', end_date: str = '2022-10-18', print_errors: bool = True) -> pandas.core.frame.DataFrame Returns the price of a cryptocurrency [Source: https://glassnode.com] diff --git a/website/content/sdk/crypto/dd/eb/_index.md b/website/content/sdk/crypto/dd/eb/_index.md index 7ab376ad543..dd94648484e 100644 --- a/website/content/sdk/crypto/dd/eb/_index.md +++ b/website/content/sdk/crypto/dd/eb/_index.md @@ -1,7 +1,7 @@ To obtain charts, make sure to add `chart=True` as the last parameter ## Get underlying data -### crypto.dd.eb(symbol: str, exchange: str = 'binance', start_date: int = 1262304000, end_date: int = 1665471332) -> pandas.core.frame.DataFrame +### crypto.dd.eb(symbol: str, exchange: str = 'binance', start_date: int = 1262304000, end_date: int = 1666094607) -> pandas.core.frame.DataFrame Returns the total amount of coins held on exchange addresses in units and percentage. [Source: https://glassnode.com] diff --git a/website/content/sdk/crypto/dd/gh/_index.md b/website/content/sdk/crypto/dd/gh/_index.md index 05a2ac9a21c..bf78ba849f0 100644 --- a/website/content/sdk/crypto/dd/gh/_index.md +++ b/website/content/sdk/crypto/dd/gh/_index.md @@ -1,7 +1,7 @@ To obtain charts, make sure to add `chart=True` as the last parameter ## Get underlying data -### crypto.dd.gh(symbol: str, dev_activity: bool = False, interval: str = '1d', start_date: str = '2021-10-11T07:55:32Z', end_date: str = '2022-10-11T07:55:32Z') -> pandas.core.frame.DataFrame +### crypto.dd.gh(symbol: str, dev_activity: bool = False, interval: str = '1d', start_date: str = '2021-10-18T13:03:27Z', end_date: str = '2022-10-18T13:03:27Z') -> pandas.core.frame.DataFrame Returns a list of developer activity for a given coin and time interval. @@ -26,7 +26,7 @@ Returns a list of developer activity for a given coin and time interval. developer activity over time ## Getting charts -### crypto.dd.gh(symbol: str, start_date: str = '2021-10-11T07:55:32Z', dev_activity: bool = False, end_date: str = '2022-10-11T07:55:32Z', interval: str = '1d', export: str = '', external_axes: Optional[List[matplotlib.axes._axes.Axes]] = None, chart=True) -> None +### crypto.dd.gh(symbol: str, start_date: str = '2021-10-18T13:03:27Z', dev_activity: bool = False, end_date: str = '2022-10-18T13:03:27Z', interval: str = '1d', export: str = '', external_axes: Optional[List[matplotlib.axes._axes.Axes]] = None, chart=True) -> None Returns a list of github activity for a given coin and time interval. diff --git a/website/content/sdk/crypto/dd/mcapdom/_index.md b/website/content/sdk/crypto/dd/mcapdom/_index.md index 375492d7e11..980e3b73872 100644 --- a/website/content/sdk/crypto/dd/mcapdom/_index.md +++ b/website/content/sdk/crypto/dd/mcapdom/_index.md @@ -1,7 +1,7 @@ To obtain charts, make sure to add `chart=True` as the last parameter ## Get underlying data -### crypto.dd.mcapdom(symbol: str, interval: str = '1d', start_date: str = '2021-10-11', end_date: str = '2022-10-11') -> pandas.core.frame.DataFrame +### crypto.dd.mcapdom(symbol: str, interval: str = '1d', start_date: str = '2021-10-18', end_date: str = '2022-10-18') -> pandas.core.frame.DataFrame Returns market dominance of a coin over time [Source: https://messari.io/] @@ -23,7 +23,7 @@ Returns market dominance of a coin over time market dominance percentage over time ## Getting charts -### crypto.dd.mcapdom(symbol: str, start_date: str = '2021-10-11', end_date: str = '2022-10-11', interval: str = '1d', export: str = '', external_axes: Optional[List[matplotlib.axes._axes.Axes]] = None, chart=True) -> None +### crypto.dd.mcapdom(symbol: str, start_date: str = '2021-10-18', end_date: str = '2022-10-18', interval: str = '1d', export: str = '', external_axes: Optional[List[matplotlib.axes._axes.Axes]] = None, chart=True) -> None Display market dominance of a coin over time [Source: https://messari.io/] diff --git a/website/content/sdk/crypto/dd/mt/_index.md b/website/content/sdk/crypto/dd/mt/_index.md index 16ee312cb64..70bbe2851fa 100644 --- a/website/content/sdk/crypto/dd/mt/_index.md +++ b/website/content/sdk/crypto/dd/mt/_index.md @@ -1,7 +1,7 @@ To obtain charts, make sure to add `chart=True` as the last parameter ## Get underlying data -### crypto.dd.mt(symbol: str, timeseries_id: str, interval: str = '1d', start_date: str = '2021-10-11', end_date: str = '2022-10-11') -> Tuple[pandas.core.frame.DataFrame, str] +### crypto.dd.mt(symbol: str, timeseries_id: str, interval: str = '1d', start_date: str = '2021-10-18', end_date: str = '2022-10-18') -> Tuple[pandas.core.frame.DataFrame, str] Returns messari timeseries [Source: https://messari.io/] @@ -27,7 +27,7 @@ Returns messari timeseries timeserie title ## Getting charts -### crypto.dd.mt(symbol: str, timeseries_id: str, start_date: str = '2021-10-11', end_date: str = '2022-10-11', interval: str = '1d', export: str = '', external_axes: Optional[List[matplotlib.axes._axes.Axes]] = None, chart=True) -> None +### crypto.dd.mt(symbol: str, timeseries_id: str, start_date: str = '2021-10-18', end_date: str = '2022-10-18', interval: str = '1d', export: str = '', external_axes: Optional[List[matplotlib.axes._axes.Axes]] = None, chart=True) -> None Display messari timeseries [Source: https://messari.io/] diff --git a/website/content/sdk/crypto/dd/nonzero/_index.md b/website/content/sdk/crypto/dd/nonzero/_index.md index a5a507651ca..4d6e2a25739 100644 --- a/website/content/sdk/crypto/dd/nonzero/_index.md +++ b/website/content/sdk/crypto/dd/nonzero/_index.md @@ -1,7 +1,7 @@ To obtain charts, make sure to add `chart=True` as the last parameter ## Get underlying data -### crypto.dd.nonzero(symbol: str, start_date: int = 1262304000, end_date: int = 1665471332) -> pandas.core.frame.DataFrame +### crypto.dd.nonzero(symbol: str, start_date: int = 1262304000, end_date: int = 1666094607) -> pandas.core.frame.DataFrame Returns addresses with non-zero balance of a certain symbol [Source: https://glassnode.com] diff --git a/website/content/sdk/crypto/load/_index.md b/website/content/sdk/crypto/load/_index.md index 2b208e46d24..bccece9d7c3 100644 --- a/website/content/sdk/crypto/load/_index.md +++ b/website/content/sdk/crypto/load/_index.md @@ -1,17 +1,26 @@ ## Get underlying data -### crypto.load(symbol: 'str', start_date: 'datetime' = datetime.datetime(2019, 10, 7, 7, 55, 32, 347659), interval: 'str' = '1440', exchange: 'str' = 'binance', vs_currency: 'str' = 'usdt', end_date: 'datetime' = datetime.datetime(2022, 10, 11, 7, 55, 32, 347665), source: 'str' = 'CCXT') -> 'pd.DataFrame' +### crypto.load(symbol: 'str', start_date: 'datetime' = datetime.datetime(2019, 10, 14, 13, 3, 27, 439509), interval: 'str' = '1440', exchange: 'str' = 'binance', vs_currency: 'str' = 'usdt', end_date: 'datetime' = datetime.datetime(2022, 10, 18, 13, 3, 27, 439515), source: 'str' = 'CCXT') -> 'pd.DataFrame' -Load crypto currency to perform analysis on CoinGecko is used as source for price and - YahooFinance for volume. +Load crypto currency to get data for. Parameters ---------- symbol: str Coin to get - vs: str - Quote Currency (usd or eur), by default usd - days: int - Data up to number of days ago, by default 365 + start_date: datetime + The datetime to start at + interval: str + The interval between data points in minutes. + Choose from: 1, 15, 30, 60, 240, 1440, 10080, 43200 + exchange: str: + The exchange to get data from. + vs_currency: str + Quote Currency (Defaults to usdt) + end_date: datetime + The datetime to end at + source: str + The source of the data + Choose from: CCXT, CoinGecko, YahooFinance Returns ------- diff --git a/website/content/sdk/crypto/onchain/btc_supply/_index.md b/website/content/sdk/crypto/onchain/btc_supply/_index.md index 7453445cc48..97b7893120e 100644 --- a/website/content/sdk/crypto/onchain/btc_supply/_index.md +++ b/website/content/sdk/crypto/onchain/btc_supply/_index.md @@ -11,7 +11,7 @@ Returns BTC circulating supply [Source: https://api.blockchain.info/] BTC circulating supply ## Getting charts -### crypto.onchain.btc_supply(start_date: int = 1262304000, end_date: int = 1665471332, export: str = '', external_axes: Optional[List[matplotlib.axes._axes.Axes]] = None, chart=True) -> None +### crypto.onchain.btc_supply(start_date: int = 1262304000, end_date: int = 1666094607, export: str = '', external_axes: Optional[List[matplotlib.axes._axes.Axes]] = None, chart=True) -> None Returns BTC circulating supply [Source: https://api.blockchain.info/] diff --git a/website/content/sdk/crypto/onchain/btc_transac/_index.md b/website/content/sdk/crypto/onchain/btc_transac/_index.md index 08cce915cf7..cdee4e96490 100644 --- a/website/content/sdk/crypto/onchain/btc_transac/_index.md +++ b/website/content/sdk/crypto/onchain/btc_transac/_index.md @@ -11,7 +11,7 @@ Returns BTC confirmed transactions [Source: https://api.blockchain.info/] BTC confirmed transactions ## Getting charts -### crypto.onchain.btc_transac(start_date: int = 1262304000, end_date: int = 1665471332, export: str = '', external_axes: Optional[List[matplotlib.axes._axes.Axes]] = None, chart=True) -> None +### crypto.onchain.btc_transac(start_date: int = 1262304000, end_date: int = 1666094607, export: str = '', external_axes: Optional[List[matplotlib.axes._axes.Axes]] = None, chart=True) -> None Returns BTC confirmed transactions [Source: https://api.blockchain.info/] diff --git a/website/content/sdk/crypto/onchain/hr/_index.md b/website/content/sdk/crypto/onchain/hr/_index.md new file mode 100644 index 00000000000..60d680b7334 --- /dev/null +++ b/website/content/sdk/crypto/onchain/hr/_index.md @@ -0,0 +1,44 @@ +To obtain charts, make sure to add `chart=True` as the last parameter + +## Get underlying data +### crypto.onchain.hr(symbol: str, interval: str = '24h', start_date: int = 1287662607, end_date: int = 1666094607) -> pandas.core.frame.DataFrame + +Returns dataframe with mean hashrate of btc or eth blockchain and symbol price + [Source: https://glassnode.com] + + Parameters + ---------- + symbol : str + Blockchain to check hashrate (BTC or ETH) + start_date : int + Initial date timestamp (e.g., 1_614_556_800) + end_date : int + End date timestamp (e.g., 1_614_556_800) + interval : str + Interval frequency (e.g., 24h) + + Returns + ------- + pd.DataFrame + mean hashrate and symbol price over time + +## Getting charts +### crypto.onchain.hr(symbol: str, start_date: int = 1634558607, end_date: int = 1666094607, interval: str = '24h', export: str = '', external_axes: Optional[List[matplotlib.axes._axes.Axes]] = None, chart=True) -> None + +Display dataframe with mean hashrate of btc or eth blockchain and symbol price. + [Source: https://glassnode.org] + + Parameters + ---------- + symbol : str + Blockchain to check mean hashrate (BTC or ETH) + start_date : int + Initial date timestamp (e.g., 1_614_556_800) + end_date : int + End date timestamp (e.g., 1_614_556_800) + interval : str + Interval frequency (possible values are: 24, 1w, 1month) + export : str + Export dataframe data to csv,json,xlsx file + external_axes : Optional[List[plt.Axes]], optional + External axes (2 axes are expected in the list), by default None diff --git a/website/content/sdk/crypto/ov/altindex/_index.md b/website/content/sdk/crypto/ov/altindex/_index.md index feac0bbdc6e..812207a805a 100644 --- a/website/content/sdk/crypto/ov/altindex/_index.md +++ b/website/content/sdk/crypto/ov/altindex/_index.md @@ -1,7 +1,7 @@ To obtain charts, make sure to add `chart=True` as the last parameter ## Get underlying data -### crypto.ov.altindex(period: int = 30, start_date: int = 1262304000, end_date: int = 1665471332) -> pandas.core.frame.DataFrame +### crypto.ov.altindex(period: int = 30, start_date: int = 1262304000, end_date: int = 1666094607) -> pandas.core.frame.DataFrame Get altcoin index overtime [Source: https://blockchaincenter.net] @@ -23,7 +23,7 @@ Get altcoin index overtime Date, Value (Altcoin Index) ## Getting charts -### crypto.ov.altindex(period: int = 365, start_date: int = 1262304000, end_date: int = 1665471332, export: str = '', external_axes: Optional[List[matplotlib.axes._axes.Axes]] = None, chart=True) -> None +### crypto.ov.altindex(period: int = 365, start_date: int = 1262304000, end_date: int = 1666094607, export: str = '', external_axes: Optional[List[matplotlib.axes._axes.Axes]] = None, chart=True) -> None Displays altcoin index overtime [Source: https://blockchaincenter.net] diff --git a/website/content/sdk/economy/bigmac/_index.md b/website/content/sdk/economy/bigmac/_index.md index 02047b00d1a..ae2659f06ec 100644 --- a/website/content/sdk/economy/bigmac/_index.md +++ b/website/content/sdk/economy/bigmac/_index.md @@ -1,7 +1,7 @@ To obtain charts, make sure to add `chart=True` as the last parameter ## Get underlying data -### economy.bigmac(country_codes: List[str]) -> pandas.core.frame.DataFrame +### economy.bigmac(country_codes: List[str] = None) -> pandas.core.frame.DataFrame Display Big Mac Index for given countries @@ -16,7 +16,7 @@ Display Big Mac Index for given countries Dataframe with Big Mac indices converted to USD equivalent. ## Getting charts -### economy.bigmac(country_codes: List[str], raw: bool = False, export: str = '', external_axes: Optional[List[matplotlib.axes._axes.Axes]] = None, chart=True) +### economy.bigmac(country_codes: List[str] = None, raw: bool = False, export: str = '', external_axes: Optional[List[matplotlib.axes._axes.Axes]] = None, chart=True) Display Big Mac Index for given countries diff --git a/website/content/sdk/economy/fred_yield_curve/_index.md b/website/content/sdk/economy/fred_yield_curve/_index.md index 43e0f499ef9..d49ebcbca6a 100644 --- a/website/content/sdk/economy/fred_yield_curve/_index.md +++ b/website/content/sdk/economy/fred_yield_curve/_index.md @@ -1,7 +1,7 @@ To obtain charts, make sure to add `chart=True` as the last parameter ## Get underlying data -### economy.fred_yield_curve(date: datetime.datetime = None) -> Tuple[pandas.core.frame.DataFrame, str] +### economy.fred_yield_curve(date: datetime.datetime = None) -> Tuple[pandas.core.frame.DataFrame, datetime.datetime] Gets yield curve data from FRED @@ -18,7 +18,7 @@ Gets yield curve data from FRED Date for which the yield curve is obtained ## Getting charts -### economy.fred_yield_curve(date: datetime.datetime = datetime.datetime(2022, 10, 11, 7, 55, 32, 575569, chart=True), external_axes: Optional[List[matplotlib.axes._axes.Axes]] = None, raw: bool = False, export: str = '') +### economy.fred_yield_curve(date: datetime.datetime = None, external_axes: Optional[List[matplotlib.axes._axes.Axes]] = None, raw: bool = False, export: str = '', chart=True) Display yield curve based on US Treasury rates for a specified date. diff --git a/website/content/sdk/economy/macro/_index.md b/website/content/sdk/economy/macro/_index.md index d8a8579504a..e48a43df893 100644 --- a/website/content/sdk/economy/macro/_index.md +++ b/website/content/sdk/economy/macro/_index.md @@ -1,7 +1,7 @@ To obtain charts, make sure to add `chart=True` as the last parameter ## Get underlying data -### economy.macro(parameters: list = None, countries: list = None, transform: str = '', start_date: str = '1900-01-01', end_date=datetime.date(2022, 10, 11), symbol: str = '') -> Tuple[Any, Dict[Any, Dict[Any, Any]], str] +### economy.macro(parameters: list = None, countries: list = None, transform: str = '', start_date: str = '1900-01-01', end_date=datetime.date(2022, 10, 18), symbol: str = '') -> Tuple[Any, Dict[Any, Dict[Any, Any]], str] This functions groups the data queried from the EconDB database [Source: EconDB] @@ -30,7 +30,7 @@ This functions groups the data queried from the EconDB database [Source: EconDB] Denomination which can be Trillions, Billions, Millions, Thousands ## Getting charts -### economy.macro(parameters: list = None, countries: list = None, transform: str = '', start_date: str = '1900-01-01', end_date: str = '2022-10-11', symbol: str = '', raw: bool = False, external_axes: Optional[List[axes]] = None, export: str = '', chart=True) +### economy.macro(parameters: list = None, countries: list = None, transform: str = '', start_date: str = '1900-01-01', end_date: str = '2022-10-18', symbol: str = '', raw: bool = False, external_axes: Optional[List[axes]] = None, export: str = '', chart=True) Show the received macro data about a company [Source: EconDB] diff --git a/website/content/sdk/economy/spread/_index.md b/website/content/sdk/economy/spread/_index.md new file mode 100644 index 00000000000..157807a583f --- /dev/null +++ b/website/content/sdk/economy/spread/_index.md @@ -0,0 +1,44 @@ +To obtain charts, make sure to add `chart=True` as the last parameter + +## Get underlying data +### economy.spread(countries: Union[str, List[str]] = 'G7', maturity: str = '10Y', change: bool = False) -> pandas.core.frame.DataFrame + +Get spread matrix. [Source: Investing.com] + + Parameters + ---------- + countries: Union[str, List[str]] + Countries or group of countries. List of available countries is accessible through get_ycrv_countries(). + maturity: str + Maturity to get data. By default 10Y. + change: bool + Flag to use 1 day change or not. By default False. + + Returns + ------- + pd.DataFrame + Spread matrix. + + +## Getting charts +### economy.spread(countries: Union[str, List[str]] = 'G7', maturity: str = '10Y', change: bool = False, color: str = 'openbb', raw: bool = False, external_axes: Optional[List[matplotlib.axes._axes.Axes]] = None, export: str = '', chart=True) + +Display spread matrix. [Source: Investing.com] + + Parameters + ---------- + countries: Union[str, List[str]] + Countries or group of countries. List of available countries is accessible through get_ycrv_countries(). + maturity: str + Maturity to get data. By default 10Y. + change: bool + Flag to use 1 day change or not. By default False. + color: str + Color theme to use on heatmap, from rgb, binary or openbb By default, openbb. + raw : bool + Output only raw data. + export : str + Export dataframe data to csv,json,xlsx file + external_axes : Optional[List[plt.Axes]], optional + External axes (1 axis is expected in the list), by default None + diff --git a/website/content/sdk/economy/treasury/_index.md b/website/content/sdk/economy/treasury/_index.md index 571fb1a7f11..25e1a2eed39 100644 --- a/website/content/sdk/economy/treasury/_index.md +++ b/website/content/sdk/economy/treasury/_index.md @@ -1,7 +1,7 @@ To obtain charts, make sure to add `chart=True` as the last parameter ## Get underlying data -### economy.treasury(instruments: list = None, maturities: list = None, frequency: str = 'monthly', start_date: str = '1900-01-01', end_date: str = '2022-10-11') -> pandas.core.frame.DataFrame +### economy.treasury(instruments: list = None, maturities: list = None, frequency: str = 'monthly', start_date: str = '1900-01-01', end_date: str = '2022-10-18') -> pandas.core.frame.DataFrame Get U.S. Treasury rates [Source: EconDB] @@ -25,7 +25,7 @@ Get U.S. Treasury rates [Source: EconDB] Holds data of the selected types and maturities ## Getting charts -### economy.treasury(instruments: list = None, maturities: list = None, frequency: str = 'monthly', start_date: str = '1900-01-01', end_date: str = '2022-10-11', raw: bool = False, external_axes: Optional[List[axes]] = None, export: str = '', chart=True) +### economy.treasury(instruments: list = None, maturities: list = None, frequency: str = 'monthly', start_date: str = '1900-01-01', end_date: str = '2022-10-18', raw: bool = False, external_axes: Optional[List[axes]] = None, export: str = '', chart=True) Display U.S. Treasury rates [Source: EconDB] diff --git a/website/content/sdk/economy/ycrv/_index.md b/website/content/sdk/economy/ycrv/_index.md index 4124bb4cd1e..5f459372f5d 100644 --- a/website/content/sdk/economy/ycrv/_index.md +++ b/website/content/sdk/economy/ycrv/_index.md @@ -1,7 +1,7 @@ To obtain charts, make sure to add `chart=True` as the last parameter ## Get underlying data -### economy.ycrv(country: str) -> pandas.core.frame.DataFrame +### economy.ycrv(country: str = 'United States') -> pandas.core.frame.DataFrame Get yield curve for specified country. [Source: Investing.com] @@ -16,7 +16,7 @@ Get yield curve for specified country. [Source: Investing.com] Country yield curve ## Getting charts -### economy.ycrv(country: str, external_axes: Optional[List[matplotlib.axes._axes.Axes]] = None, raw: bool = False, export: str = '', chart=True) +### economy.ycrv(country: str = 'United States', external_axes: Optional[List[matplotlib.axes._axes.Axes]] = None, raw: bool = False, export: str = '', chart=True) Display yield curve for specified country. [Source: Investing.com] diff --git a/website/content/sdk/etf/candle/_index.md b/website/content/sdk/etf/candle/_index.md index 4df1975aa99..71edcfa399b 100644 --- a/website/content/sdk/etf/candle/_index.md +++ b/website/content/sdk/etf/candle/_index.md @@ -1,5 +1,5 @@ ## Get underlying data -### etf.candle(symbol: str, data: pandas.core.frame.DataFrame = None, use_matplotlib: bool = True, intraday: bool = False, add_trend: bool = False, ma: Optional[Iterable[int]] = None, asset_type: str = '', start_date: datetime.datetime = datetime.datetime(2019, 10, 7, 7, 55, 32, 432614), interval: int = 1440, end_date: datetime.datetime = datetime.datetime(2022, 10, 11, 7, 55, 32, 432619), prepost: bool = False, source: str = 'YahooFinance', iexrange: str = 'ytd', weekly: bool = False, monthly: bool = False, external_axes: Optional[List[matplotlib.axes._axes.Axes]] = None, raw: bool = False) +### etf.candle(symbol: str, data: pandas.core.frame.DataFrame = None, use_matplotlib: bool = True, intraday: bool = False, add_trend: bool = False, ma: Optional[Iterable[int]] = None, asset_type: str = '', start_date: datetime.datetime = datetime.datetime(2019, 10, 14, 13, 3, 27, 493186), interval: int = 1440, end_date: datetime.datetime = datetime.datetime(2022, 10, 18, 13, 3, 27, 493190), prepost: bool = False, source: str = 'YahooFinance', iexrange: str = 'ytd', weekly: bool = False, monthly: bool = False, external_axes: Optional[List[matplotlib.axes._axes.Axes]] = None, raw: bool = False, yscale: str = 'linear') Shows candle plot of loaded ticker. [Source: Yahoo Finance, IEX Cloud or Alpha Vantage] @@ -41,3 +41,5 @@ Shows candle plot of loaded ticker. [Source: Yahoo Finance, IEX Cloud or Alpha V Flag to get monthly data raw : bool, optional Flag to display raw data, by default False + yscale: str + Linear or log for yscale diff --git a/website/content/sdk/etf/news/_index.md b/website/content/sdk/etf/news/_index.md index 073b1ee497d..783529a02e8 100644 --- a/website/content/sdk/etf/news/_index.md +++ b/website/content/sdk/etf/news/_index.md @@ -1,7 +1,7 @@ To obtain charts, make sure to add `chart=True` as the last parameter ## Get underlying data -### etf.news(query: str, limit: int = 10, start_date: str = '2022-10-04', show_newest: bool = True, sources: str = '') -> List[Tuple[Any, Any]] +### etf.news(query: str, limit: int = 10, start_date: str = '2022-10-11', show_newest: bool = True, sources: str = '') -> List[Tuple[Any, Any]] Get news for a given term. [Source: NewsAPI] @@ -22,7 +22,7 @@ Get news for a given term. [Source: NewsAPI] List of tuples containing news df in first index and dict containing title of news df ## Getting charts -### etf.news(query: str, limit: int = 3, start_date: str = '2022-10-04', show_newest: bool = True, sources: str = '', export: str = '', chart=True) -> None +### etf.news(query: str, limit: int = 3, start_date: str = '2022-10-11', show_newest: bool = True, sources: str = '', export: str = '', chart=True) -> None Display news for a given term. [Source: NewsAPI] diff --git a/website/content/sdk/forex/candle/_index.md b/website/content/sdk/forex/candle/_index.md index 6798ff57bc6..86c7a8955a9 100644 --- a/website/content/sdk/forex/candle/_index.md +++ b/website/content/sdk/forex/candle/_index.md @@ -11,5 +11,7 @@ Show candle plot for fx data. To forex symbol from_symbol : str From forex symbol + ma : Optional[Iterable[int]] + Moving averages external_axes: Optional[List[plt.Axes]] External axes (1 axis is expected in the list), by default None diff --git a/website/content/sdk/forex/load/_index.md b/website/content/sdk/forex/load/_index.md index 01ec256e00c..297c605fa26 100644 --- a/website/content/sdk/forex/load/_index.md +++ b/website/content/sdk/forex/load/_index.md @@ -1,5 +1,5 @@ ## Get underlying data -### forex.load(to_symbol: str, from_symbol: str, resolution: str = 'd', interval: str = '1day', start_date: str = '2021-10-11', source: str = 'YahooFinance') -> pandas.core.frame.DataFrame +### forex.load(to_symbol: str, from_symbol: str, resolution: str = 'd', interval: str = '1day', start_date: str = '2021-10-18', source: str = 'YahooFinance') -> pandas.core.frame.DataFrame Loads forex for two given symbols diff --git a/website/content/sdk/keys/shroom/_index.md b/website/content/sdk/keys/shroom/_index.md new file mode 100644 index 00000000000..31804261a1c --- /dev/null +++ b/website/content/sdk/keys/shroom/_index.md @@ -0,0 +1,17 @@ +## Get underlying data +### keys.shroom(key: str, persist: bool = False, show_output: bool = False) -> str + +Set Shroom key + Parameters + ---------- + key: str + API key + persist: bool + If False, api key change will be contained to where it was changed. For example, Jupyter notebook. + If True, api key change will be global, i.e. it will affect terminal environment variables. + By default, False. + show_output: bool + Display status string or not. By default, False. + Returns + ------- + status: str diff --git a/website/content/sdk/keys/tokenterminal/_index.md b/website/content/sdk/keys/tokenterminal/_index.md new file mode 100644 index 00000000000..831386bec7b --- /dev/null +++ b/website/content/sdk/keys/tokenterminal/_index.md @@ -0,0 +1,20 @@ +## Get underlying data +### keys.tokenterminal(key: str, persist: bool = False, show_output: bool = False) -> str + +Set Token Terminal key. + + Parameters + ---------- + key: str + API key + persist: bool + If False, api key change will be contained to where it was changed. For example, Jupyter notebook. + If True, api key change will be global, i.e. it will affect terminal environment variables. + By default, False. + show_output: bool + Display status string or not. By default, False. + + Returns + ------- + status: str + diff --git a/website/content/sdk/stocks/ba/cnews/_index.md b/website/content/sdk/stocks/ba/cnews/_index.md index 92ab28c8504..1161e8f76f9 100644 --- a/website/content/sdk/stocks/ba/cnews/_index.md +++ b/website/content/sdk/stocks/ba/cnews/_index.md @@ -1,5 +1,5 @@ ## Get underlying data -### stocks.ba.cnews(symbol: str, start_date: str = '2022-09-11', end_date: str = '2022-10-11') -> List[Dict] +### stocks.ba.cnews(symbol: str, start_date: str = '2022-09-18', end_date: str = '2022-10-18') -> List[Dict] Get news from a company. [Source: Finnhub] diff --git a/website/content/sdk/stocks/ba/hist/_index.md b/website/content/sdk/stocks/ba/hist/_index.md index 6ab266ab9ac..be5ee7fbcaa 100644 --- a/website/content/sdk/stocks/ba/hist/_index.md +++ b/website/content/sdk/stocks/ba/hist/_index.md @@ -1,7 +1,7 @@ To obtain charts, make sure to add `chart=True` as the last parameter ## Get underlying data -### stocks.ba.hist(symbol: str, start_date: str = '2022-10-04', end_date: str = '2022-10-11', number: int = 100) -> pandas.core.frame.DataFrame +### stocks.ba.hist(symbol: str, start_date: str = '2022-10-11', end_date: str = '2022-10-18', number: int = 100) -> pandas.core.frame.DataFrame Get hour-level sentiment data for the chosen symbol @@ -25,7 +25,7 @@ Get hour-level sentiment data for the chosen symbol Dataframe of historical sentiment ## Getting charts -### stocks.ba.hist(symbol: str, start_date: str = '2022-10-04', end_date: str = '2022-10-11', number: int = 100, raw: bool = False, limit: int = 10, export: str = '', external_axes: Optional[List[matplotlib.axes._axes.Axes]] = None, chart=True) +### stocks.ba.hist(symbol: str, start_date: str = '2022-10-11', end_date: str = '2022-10-18', number: int = 100, raw: bool = False, limit: int = 10, export: str = '', external_axes: Optional[List[matplotlib.axes._axes.Axes]] = None, chart=True) Display historical sentiment data of a ticker, and plot a chart with RHI and AHI. diff --git a/website/content/sdk/stocks/ba/sentiment/_index.md b/website/content/sdk/stocks/ba/sentiment/_index.md index bc6be9c9fb6..77531731ae5 100644 --- a/website/content/sdk/stocks/ba/sentiment/_index.md +++ b/website/content/sdk/stocks/ba/sentiment/_index.md @@ -1,7 +1,7 @@ To obtain charts, make sure to add `chart=True` as the last parameter ## Get underlying data -### stocks.ba.sentiment(symbol: str, n_tweets: int = 15, n_days_past: int = 2) +### stocks.ba.sentiment(symbol: str, n_tweets: int = 15, n_days_past: int = 2) -> pandas.core.frame.DataFrame Get sentiments from symbol diff --git a/website/content/sdk/stocks/ba/trend/_index.md b/website/content/sdk/stocks/ba/trend/_index.md index 171881be2aa..44d42d1d722 100644 --- a/website/content/sdk/stocks/ba/trend/_index.md +++ b/website/content/sdk/stocks/ba/trend/_index.md @@ -1,7 +1,7 @@ To obtain charts, make sure to add `chart=True` as the last parameter ## Get underlying data -### stocks.ba.trend(start_date: datetime.datetime = datetime.datetime(2022, 10, 11, 7, 55, 31, 933096), hour: int = 0, number: int = 10) -> pandas.core.frame.DataFrame +### stocks.ba.trend(start_date: datetime.datetime = datetime.datetime(2022, 10, 18, 13, 3, 27, 112924), hour: int = 0, number: int = 10) -> pandas.core.frame.DataFrame Get sentiment data on the most talked about tickers within the last hour @@ -24,7 +24,7 @@ Get sentiment data on the most talked about tickers Dataframe of trending data ## Getting charts -### stocks.ba.trend(start_date: datetime.datetime = datetime.datetime(2022, 10, 11, 7, 55, 31, 933301, chart=True), hour: int = 0, number: int = 10, limit: int = 10, export: str = '') +### stocks.ba.trend(start_date: datetime.datetime = datetime.datetime(2022, 10, 18, 13, 3, 27, 113091, chart=True), hour: int = 0, number: int = 10, limit: int = 10, export: str = '') Display most talked about tickers within the last hour together with their sentiment data. diff --git a/website/content/sdk/stocks/ca/hcorr/_index.md b/website/content/sdk/stocks/ca/hcorr/_index.md index c9593f51ee6..4d58756c34a 100644 --- a/website/content/sdk/stocks/ca/hcorr/_index.md +++ b/website/content/sdk/stocks/ca/hcorr/_index.md @@ -1,7 +1,7 @@ To obtain charts, make sure to add `chart=True` as the last parameter ## Get underlying data -### stocks.ca.hcorr(similar: List[str], start_date: str = '2021-10-10', candle_type: str = 'a') +### stocks.ca.hcorr(similar: List[str], start_date: str = '2021-10-17', candle_type: str = 'a') Get historical price correlation. [Source: Yahoo Finance] @@ -18,7 +18,7 @@ To obtain charts, make sure to add `chart=True` as the last parameter OHLCA column to use for candles or R for returns, by default "a" for Adjusted Close ## Getting charts -### stocks.ca.hcorr(similar: List[str], start_date: str = '2021-10-10', candle_type: str = 'a', display_full_matrix: bool = False, raw: bool = False, external_axes: Optional[List[matplotlib.axes._axes.Axes]] = None, export: str = '', chart=True) +### stocks.ca.hcorr(similar: List[str], start_date: str = '2021-10-17', candle_type: str = 'a', display_full_matrix: bool = False, raw: bool = False, external_axes: Optional[List[matplotlib.axes._axes.Axes]] = None, export: str = '', chart=True) Correlation heatmap based on historical price comparison diff --git a/website/content/sdk/stocks/ca/hist/_index.md b/website/content/sdk/stocks/ca/hist/_index.md index 184df131617..35344828783 100644 --- a/website/content/sdk/stocks/ca/hist/_index.md +++ b/website/content/sdk/stocks/ca/hist/_index.md @@ -1,7 +1,7 @@ To obtain charts, make sure to add `chart=True` as the last parameter ## Get underlying data -### stocks.ca.hist(similar: List[str], start_date: str = '2021-10-10', candle_type: str = 'a') -> pandas.core.frame.DataFrame +### stocks.ca.hist(similar: List[str], start_date: str = '2021-10-17', candle_type: str = 'a') -> pandas.core.frame.DataFrame Get historical prices for all comparison stocks @@ -22,7 +22,7 @@ Get historical prices for all comparison stocks Dataframe containing candle type variable for each ticker ## Getting charts -### stocks.ca.hist(similar: List[str], start_date: str = '2021-10-10', candle_type: str = 'a', normalize: bool = True, export: str = '', external_axes: Optional[List[matplotlib.axes._axes.Axes]] = None, chart=True) +### stocks.ca.hist(similar: List[str], start_date: str = '2021-10-17', candle_type: str = 'a', normalize: bool = True, export: str = '', external_axes: Optional[List[matplotlib.axes._axes.Axes]] = None, chart=True) Display historical stock prices. [Source: Yahoo Finance] diff --git a/website/content/sdk/stocks/ca/volume/_index.md b/website/content/sdk/stocks/ca/volume/_index.md index b9be0f99a25..9aa89f8df60 100644 --- a/website/content/sdk/stocks/ca/volume/_index.md +++ b/website/content/sdk/stocks/ca/volume/_index.md @@ -1,7 +1,7 @@ To obtain charts, make sure to add `chart=True` as the last parameter ## Get underlying data -### stocks.ca.volume(similar: List[str], start_date: str = '2021-10-10') -> pandas.core.frame.DataFrame +### stocks.ca.volume(similar: List[str], start_date: str = '2021-10-17') -> pandas.core.frame.DataFrame Get stock volume. [Source: Yahoo Finance] @@ -15,7 +15,7 @@ Get stock volume. [Source: Yahoo Finance] Start date of comparison, by default 1 year ago ## Getting charts -### stocks.ca.volume(similar: List[str], start_date: str = '2021-10-10', export: str = '', external_axes: Optional[List[matplotlib.axes._axes.Axes]] = None, chart=True) +### stocks.ca.volume(similar: List[str], start_date: str = '2021-10-17', export: str = '', external_axes: Optional[List[matplotlib.axes._axes.Axes]] = None, chart=True) Display stock volume. [Source: Yahoo Finance] diff --git a/website/content/sdk/stocks/candle/_index.md b/website/content/sdk/stocks/candle/_index.md index f0bf80e26a0..8fdc28b1e4f 100644 --- a/website/content/sdk/stocks/candle/_index.md +++ b/website/content/sdk/stocks/candle/_index.md @@ -1,5 +1,5 @@ ## Get underlying data -### stocks.candle(symbol: str, data: pandas.core.frame.DataFrame = None, use_matplotlib: bool = True, intraday: bool = False, add_trend: bool = False, ma: Optional[Iterable[int]] = None, asset_type: str = '', start_date: datetime.datetime = datetime.datetime(2019, 10, 7, 7, 55, 32, 432614), interval: int = 1440, end_date: datetime.datetime = datetime.datetime(2022, 10, 11, 7, 55, 32, 432619), prepost: bool = False, source: str = 'YahooFinance', iexrange: str = 'ytd', weekly: bool = False, monthly: bool = False, external_axes: Optional[List[matplotlib.axes._axes.Axes]] = None, raw: bool = False) +### stocks.candle(symbol: str, data: pandas.core.frame.DataFrame = None, use_matplotlib: bool = True, intraday: bool = False, add_trend: bool = False, ma: Optional[Iterable[int]] = None, asset_type: str = '', start_date: datetime.datetime = datetime.datetime(2019, 10, 14, 13, 3, 27, 493186), interval: int = 1440, end_date: datetime.datetime = datetime.datetime(2022, 10, 18, 13, 3, 27, 493190), prepost: bool = False, source: str = 'YahooFinance', iexrange: str = 'ytd', weekly: bool = False, monthly: bool = False, external_axes: Optional[List[matplotlib.axes._axes.Axes]] = None, raw: bool = False, yscale: str = 'linear') Shows candle plot of loaded ticker. [Source: Yahoo Finance, IEX Cloud or Alpha Vantage] @@ -41,3 +41,5 @@ Shows candle plot of loaded ticker. [Source: Yahoo Finance, IEX Cloud or Alpha V Flag to get monthly data raw : bool, optional Flag to display raw data, by default False + yscale: str + Linear or log for yscale diff --git a/website/content/sdk/stocks/dd/pt/_index.md b/website/content/sdk/stocks/dd/pt/_index.md index 0ab42e50d99..cdee9ec5fa8 100644 --- a/website/content/sdk/stocks/dd/pt/_index.md +++ b/website/content/sdk/stocks/dd/pt/_index.md @@ -16,7 +16,7 @@ Get analysts' price targets for a given stock. [Source: Business Insider] Analysts data ## Getting charts -### stocks.dd.pt(symbol: str, data: pandas.core.frame.DataFrame, start_date: str = '2022-10-11', limit: int = 10, raw: bool = False, export: str = '', external_axes: Optional[List[matplotlib.axes._axes.Axes]] = None, chart=True) +### stocks.dd.pt(symbol: str, data: pandas.core.frame.DataFrame, start_date: str = '2022-10-18', limit: int = 10, raw: bool = False, export: str = '', external_axes: Optional[List[matplotlib.axes._axes.Axes]] = None, chart=True) Display analysts' price targets for a given stock. [Source: Business Insider] diff --git a/website/content/sdk/stocks/disc/dividends/_index.md b/website/content/sdk/stocks/disc/dividends/_index.md index be7a42d9ab1..314b740f634 100644 --- a/website/content/sdk/stocks/disc/dividends/_index.md +++ b/website/content/sdk/stocks/disc/dividends/_index.md @@ -1,5 +1,5 @@ ## Get underlying data -### stocks.disc.dividends(date: str = '2022-10-11') -> pandas.core.frame.DataFrame +### stocks.disc.dividends(date: str = '2022-10-18') -> pandas.core.frame.DataFrame Gets dividend calendar for given date. Date represents Ex-Dividend Date diff --git a/website/content/sdk/stocks/disc/ipo/_index.md b/website/content/sdk/stocks/disc/ipo/_index.md index bc1107a11b8..38643dc150e 100644 --- a/website/content/sdk/stocks/disc/ipo/_index.md +++ b/website/content/sdk/stocks/disc/ipo/_index.md @@ -1,5 +1,5 @@ ## Get underlying data -### stocks.disc.ipo(start_date: str = '2022-10-06', end_date: str = '2022-10-11') -> pandas.core.frame.DataFrame +### stocks.disc.ipo(start_date: str = '2022-10-13', end_date: str = '2022-10-18') -> pandas.core.frame.DataFrame Get IPO calendar diff --git a/website/content/sdk/stocks/dps/ftd/_index.md b/website/content/sdk/stocks/dps/ftd/_index.md index 478af0abc46..f48975143aa 100644 --- a/website/content/sdk/stocks/dps/ftd/_index.md +++ b/website/content/sdk/stocks/dps/ftd/_index.md @@ -1,7 +1,7 @@ To obtain charts, make sure to add `chart=True` as the last parameter ## Get underlying data -### stocks.dps.ftd(symbol: str, start_date: str = '2022-08-12', end_date: str = '2022-10-11', limit: int = 0) -> pandas.core.frame.DataFrame +### stocks.dps.ftd(symbol: str, start_date: str = '2022-08-19', end_date: str = '2022-10-18', limit: int = 0) -> pandas.core.frame.DataFrame Display fails-to-deliver data for a given ticker. [Source: SEC] @@ -22,7 +22,7 @@ Display fails-to-deliver data for a given ticker. [Source: SEC] Fail to deliver data ## Getting charts -### stocks.dps.ftd(symbol: str, data: pandas.core.frame.DataFrame, start_date: str = '2022-08-12', end_date: str = '2022-10-11', limit: int = 0, raw: bool = False, export: str = '', external_axes: Optional[List[matplotlib.axes._axes.Axes]] = None, chart=True) +### stocks.dps.ftd(symbol: str, data: pandas.core.frame.DataFrame, start_date: str = '2022-08-19', end_date: str = '2022-10-18', limit: int = 0, raw: bool = False, export: str = '', external_axes: Optional[List[matplotlib.axes._axes.Axes]] = None, chart=True) Display fails-to-deliver data for a given ticker. [Source: SEC] diff --git a/website/content/sdk/stocks/fa/mktcap/_index.md b/website/content/sdk/stocks/fa/mktcap/_index.md index f8d7ad0b875..7b283b62936 100644 --- a/website/content/sdk/stocks/fa/mktcap/_index.md +++ b/website/content/sdk/stocks/fa/mktcap/_index.md @@ -1,7 +1,7 @@ To obtain charts, make sure to add `chart=True` as the last parameter ## Get underlying data -### stocks.fa.mktcap(symbol: str, start_date: str = '2019-10-09') -> Tuple[pandas.core.frame.DataFrame, str] +### stocks.fa.mktcap(symbol: str, start_date: str = '2019-10-16') -> Tuple[pandas.core.frame.DataFrame, str] Get market cap over time for ticker. [Source: Yahoo Finance] @@ -20,7 +20,7 @@ Get market cap over time for ticker. [Source: Yahoo Finance] Currency of ticker ## Getting charts -### stocks.fa.mktcap(symbol: str, start_date: str = '2019-10-09', export: str = '', external_axes: Optional[List[matplotlib.axes._axes.Axes]] = None, chart=True) +### stocks.fa.mktcap(symbol: str, start_date: str = '2019-10-16', export: str = '', external_axes: Optional[List[matplotlib.axes._axes.Axes]] = None, chart=True) Display market cap over time. [Source: Yahoo Finance] diff --git a/website/content/sdk/stocks/ins/act/_index.md b/website/content/sdk/stocks/ins/act/_index.md index e852affc3e5..be781fc2ea9 100644 --- a/website/content/sdk/stocks/ins/act/_index.md +++ b/website/content/sdk/stocks/ins/act/_index.md @@ -16,7 +16,7 @@ Get insider activity. [Source: Business Insider] Get insider activity data ## Getting charts -### stocks.ins.act(data: pandas.core.frame.DataFrame, symbol: str, start_date: str = '2019-10-07', interval: str = '1440min', limit: int = 10, raw: bool = False, export: str = '', external_axes: Optional[List[matplotlib.axes._axes.Axes]] = None, chart=True) +### stocks.ins.act(data: pandas.core.frame.DataFrame, symbol: str, start_date: str = '2019-10-14', interval: str = '1440min', limit: int = 10, raw: bool = False, export: str = '', external_axes: Optional[List[matplotlib.axes._axes.Axes]] = None, chart=True) Display insider activity. [Source: Business Insider] diff --git a/website/content/sdk/stocks/options/pcr/_index.md b/website/content/sdk/stocks/options/pcr/_index.md index 21ad63ed6d0..732bed632f4 100644 --- a/website/content/sdk/stocks/options/pcr/_index.md +++ b/website/content/sdk/stocks/options/pcr/_index.md @@ -1,7 +1,7 @@ To obtain charts, make sure to add `chart=True` as the last parameter ## Get underlying data -### stocks.options.pcr(symbol: str, window: int = 30, start_date: str = '2021-10-10') -> pandas.core.frame.DataFrame +### stocks.options.pcr(symbol: str, window: int = 30, start_date: str = '2021-10-17') -> pandas.core.frame.DataFrame Gets put call ratio over last time window [Source: AlphaQuery.com] @@ -15,7 +15,7 @@ Gets put call ratio over last time window [Source: AlphaQuery.com] Start date to plot, by default last 366 days ## Getting charts -### stocks.options.pcr(symbol: str, window: int = 30, start_date: str = '2021-10-10', export: str = '', external_axes: Optional[List[matplotlib.axes._axes.Axes]] = None, chart=True) +### stocks.options.pcr(symbol: str, window: int = 30, start_date: str = '2021-10-17', export: str = '', external_axes: Optional[List[matplotlib.axes._axes.Axes]] = None, chart=True) Display put call ratio [Source: AlphaQuery.com] diff --git a/website/content/sdk/stocks/screener/historical/_index.md b/website/content/sdk/stocks/screener/historical/_index.md index 51cc2a8d01a..9393dc017d5 100644 --- a/website/content/sdk/stocks/screener/historical/_index.md +++ b/website/content/sdk/stocks/screener/historical/_index.md @@ -1,7 +1,7 @@ To obtain charts, make sure to add `chart=True` as the last parameter ## Get underlying data -### stocks.screener.historical(preset_loaded: str = 'top_gainers', limit: int = 10, start_date: str = '2022-04-14', type_candle: str = 'a', normalize: bool = True) +### stocks.screener.historical(preset_loaded: str = 'top_gainers', limit: int = 10, start_date: str = '2022-04-21', type_candle: str = 'a', normalize: bool = True) View historical price of stocks that meet preset @@ -28,7 +28,7 @@ View historical price of stocks that meet preset Whether some random stock selection due to limitations ## Getting charts -### stocks.screener.historical(preset_loaded: str = 'top_gainers', limit: int = 10, start_date: str = '2022-04-14', type_candle: str = 'a', normalize: bool = True, export: str = '', external_axes: Optional[List[matplotlib.axes._axes.Axes]] = None, chart=True) -> List[str] +### stocks.screener.historical(preset_loaded: str = 'top_gainers', limit: int = 10, start_date: str = '2022-04-21', type_candle: str = 'a', normalize: bool = True, export: str = '', external_axes: Optional[List[matplotlib.axes._axes.Axes]] = None, chart=True) -> List[str] View historical price of stocks that meet preset diff --git a/website/content/sdk/stocks/tob/_index.md b/website/content/sdk/stocks/tob/_index.md new file mode 100644 index 00000000000..bd0c2967dd8 --- /dev/null +++ b/website/content/sdk/stocks/tob/_index.md @@ -0,0 +1,19 @@ +## Get underlying data +### stocks.tob(symbol: str, exchange: str = 'BZX') -> Tuple[pandas.core.frame.DataFrame, pandas.core.frame.DataFrame] + +Get top of book bid and ask for ticker on exchange [CBOE.com] + + Parameters + ---------- + symbol: str + Ticker to get + exchange: str + Exchange to look at. Can be `BZX`,`EDGX`, `BYX`, `EDGA` + + Returns + ------- + pd.DatatFrame + Dataframe of Bids + pd.DataFrame + Dataframe of asks + diff --git a/website/data/menu/main.yml b/website/data/menu/main.yml index 10609e62357..2c5b8127d63 100644 --- a/website/data/menu/main.yml +++ b/website/data/menu/main.yml @@ -1690,968 +1690,769 @@ main: - name: sdk ref: /sdk sub: - - name: forecast - ref: /sdk/forecast + - name: econometrics + ref: /sdk/econometrics sub: - - name: delta - ref: /sdk/forecast/delta - - name: ema - ref: /sdk/forecast/ema - - name: tcn - ref: /sdk/forecast/tcn - - name: plot - ref: /sdk/forecast/plot - - name: combine - ref: /sdk/forecast/combine - - name: brnn - ref: /sdk/forecast/brnn - - name: delete - ref: /sdk/forecast/delete - - name: desc - ref: /sdk/forecast/desc - - name: rsi - ref: /sdk/forecast/rsi - - name: linregr - ref: /sdk/forecast/linregr - - name: regr - ref: /sdk/forecast/regr - - name: show - ref: /sdk/forecast/show - - name: nbeats - ref: /sdk/forecast/nbeats - - name: expo - ref: /sdk/forecast/expo - - name: roc - ref: /sdk/forecast/roc + - name: ols + ref: /sdk/econometrics/ols + - name: options + ref: /sdk/econometrics/options + - name: granger + ref: /sdk/econometrics/granger + - name: re + ref: /sdk/econometrics/re + - name: fdols + ref: /sdk/econometrics/fdols + - name: root + ref: /sdk/econometrics/root + - name: load + ref: /sdk/econometrics/load + - name: get_regression_data + ref: /sdk/econometrics/get_regression_data + - name: norm + ref: /sdk/econometrics/norm + - name: dwat + ref: /sdk/econometrics/dwat + - name: coint + ref: /sdk/econometrics/coint + - name: bgod + ref: /sdk/econometrics/bgod + - name: pols + ref: /sdk/econometrics/pols - name: clean - ref: /sdk/forecast/clean - - name: load - ref: /sdk/forecast/load - - name: tft - ref: /sdk/forecast/tft - - name: corr - ref: /sdk/forecast/corr - - name: rename - ref: /sdk/forecast/rename - - name: atr - ref: /sdk/forecast/atr - - name: season - ref: /sdk/forecast/season - - name: trans - ref: /sdk/forecast/trans - - name: export - ref: /sdk/forecast/export - - name: theta - ref: /sdk/forecast/theta - - name: signal - ref: /sdk/forecast/signal - - name: sto - ref: /sdk/forecast/sto - - name: rnn - ref: /sdk/forecast/rnn - - name: mom - ref: /sdk/forecast/mom - - name: crypto - ref: /sdk/crypto + ref: /sdk/econometrics/clean + - name: fe + ref: /sdk/econometrics/fe + - name: panel + ref: /sdk/econometrics/panel + - name: comparison + ref: /sdk/econometrics/comparison + - name: bols + ref: /sdk/econometrics/bols + - name: bpag + ref: /sdk/econometrics/bpag + - name: keys + ref: /sdk/keys sub: - - name: tools - ref: /sdk/crypto/tools - sub: - - name: apy - ref: /sdk/crypto/tools/apy - - name: il - ref: /sdk/crypto/tools/il - - name: onchain - ref: /sdk/crypto/onchain - sub: - - name: top - ref: /sdk/crypto/onchain/top - - name: ttcp - ref: /sdk/crypto/onchain/ttcp - - name: dvcp - ref: /sdk/crypto/onchain/dvcp - - name: prices - ref: /sdk/crypto/onchain/prices - - name: holders - ref: /sdk/crypto/onchain/holders - - name: gwei - ref: /sdk/crypto/onchain/gwei - - name: ueat - ref: /sdk/crypto/onchain/ueat - - name: baas - ref: /sdk/crypto/onchain/baas - - name: dex_trades_monthly - ref: /sdk/crypto/onchain/dex_trades_monthly - - name: query_graph - ref: /sdk/crypto/onchain/query_graph - - name: balance - ref: /sdk/crypto/onchain/balance - - name: btc_supply - ref: /sdk/crypto/onchain/btc_supply - - name: tv - ref: /sdk/crypto/onchain/tv - - name: tx - ref: /sdk/crypto/onchain/tx - - name: info - ref: /sdk/crypto/onchain/info - - name: hist - ref: /sdk/crypto/onchain/hist - - name: whales - ref: /sdk/crypto/onchain/whales - - name: token_decimals - ref: /sdk/crypto/onchain/token_decimals - - name: lt - ref: /sdk/crypto/onchain/lt - - name: th - ref: /sdk/crypto/onchain/th - - name: btc_transac - ref: /sdk/crypto/onchain/btc_transac - - name: erc20_tokens - ref: /sdk/crypto/onchain/erc20_tokens - - name: nft - ref: /sdk/crypto/nft - sub: - - name: stats - ref: /sdk/crypto/nft/stats - - name: chart - ref: /sdk/crypto/chart - - name: ov - ref: /sdk/crypto/ov - sub: - - name: crypto_hacks - ref: /sdk/crypto/ov/crypto_hacks - - name: cgderivatives - ref: /sdk/crypto/ov/cgderivatives - - name: wfpe - ref: /sdk/crypto/ov/wfpe - - name: cpinfo - ref: /sdk/crypto/ov/cpinfo - - name: cgcategories - ref: /sdk/crypto/ov/cgcategories - - name: cpmarkets - ref: /sdk/crypto/ov/cpmarkets - - name: cpplatforms - ref: /sdk/crypto/ov/cpplatforms - - name: platforms - ref: /sdk/crypto/ov/platforms - - name: cgstables - ref: /sdk/crypto/ov/cgstables - - name: crypto_hack_slugs - ref: /sdk/crypto/ov/crypto_hack_slugs - - name: cpexchanges - ref: /sdk/crypto/ov/cpexchanges - - name: exchanges - ref: /sdk/crypto/ov/exchanges - - name: cpcontracts - ref: /sdk/crypto/ov/cpcontracts - - name: cr - ref: /sdk/crypto/ov/cr - - name: cgproducts - ref: /sdk/crypto/ov/cgproducts - - name: cgexrates - ref: /sdk/crypto/ov/cgexrates - - name: cghm - ref: /sdk/crypto/ov/cghm - - name: cgdefi - ref: /sdk/crypto/ov/cgdefi - - name: cghold - ref: /sdk/crypto/ov/cghold - - name: cpglobal - ref: /sdk/crypto/ov/cpglobal - - name: cgglobal - ref: /sdk/crypto/ov/cgglobal - - name: altindex - ref: /sdk/crypto/ov/altindex - - name: news - ref: /sdk/crypto/ov/news - - name: crypto_hack - ref: /sdk/crypto/ov/crypto_hack - - name: global_info - ref: /sdk/crypto/ov/global_info - - name: ewf - ref: /sdk/crypto/ov/ewf - - name: cpexmarkets - ref: /sdk/crypto/ov/cpexmarkets - - name: cbpairs - ref: /sdk/crypto/ov/cbpairs - - name: cgindexes - ref: /sdk/crypto/ov/cgindexes - - name: list_of_coins - ref: /sdk/crypto/ov/list_of_coins - - name: wf - ref: /sdk/crypto/ov/wf - - name: load - ref: /sdk/crypto/load - - name: candles - ref: /sdk/crypto/candles - - name: disc - ref: /sdk/crypto/disc - sub: - - name: cpsearch - ref: /sdk/crypto/disc/cpsearch - - name: coins_for_given_exchange - ref: /sdk/crypto/disc/coins_for_given_exchange - - name: categories_keys - ref: /sdk/crypto/disc/categories_keys - - name: gainers - ref: /sdk/crypto/disc/gainers - - name: top_dapps - ref: /sdk/crypto/disc/top_dapps - - name: gainers_or_losers - ref: /sdk/crypto/disc/gainers_or_losers - - name: coins - ref: /sdk/crypto/disc/coins - - name: losers - ref: /sdk/crypto/disc/losers - - name: top_dexes - ref: /sdk/crypto/disc/top_dexes - - name: coin_list - ref: /sdk/crypto/disc/coin_list - - name: trending - ref: /sdk/crypto/disc/trending - - name: top_nfts - ref: /sdk/crypto/disc/top_nfts - - name: cmctop - ref: /sdk/crypto/disc/cmctop - - name: top_games - ref: /sdk/crypto/disc/top_games - - name: dd - ref: /sdk/crypto/dd - sub: - - name: cbbook - ref: /sdk/crypto/dd/cbbook - - name: twitter - ref: /sdk/crypto/dd/twitter - - name: inv - ref: /sdk/crypto/dd/inv - - name: mkt - ref: /sdk/crypto/dd/mkt - - name: change - ref: /sdk/crypto/dd/change - - name: mt - ref: /sdk/crypto/dd/mt - - name: gh - ref: /sdk/crypto/dd/gh - - name: ohlc_historical - ref: /sdk/crypto/dd/ohlc_historical - - name: exchanges - ref: /sdk/crypto/dd/exchanges - - name: trades - ref: /sdk/crypto/dd/trades - - name: eb - ref: /sdk/crypto/dd/eb - - name: btcrb - ref: /sdk/crypto/dd/btcrb - - name: headlines - ref: /sdk/crypto/dd/headlines - - name: ex - ref: /sdk/crypto/dd/ex - - name: basic - ref: /sdk/crypto/dd/basic - - name: tk - ref: /sdk/crypto/dd/tk - - name: get_mt - ref: /sdk/crypto/dd/get_mt - - name: balance - ref: /sdk/crypto/dd/balance - - name: pr - ref: /sdk/crypto/dd/pr - - name: all_binance_trading_pairs - ref: /sdk/crypto/dd/all_binance_trading_pairs - - name: check_valid_binance_str - ref: /sdk/crypto/dd/check_valid_binance_str - - name: pi - ref: /sdk/crypto/dd/pi - - name: ps - ref: /sdk/crypto/dd/ps - - name: coin - ref: /sdk/crypto/dd/coin - - name: news - ref: /sdk/crypto/dd/news - - name: candles - ref: /sdk/crypto/dd/candles - - name: team - ref: /sdk/crypto/dd/team - - name: links - ref: /sdk/crypto/dd/links - - name: trading_pair_info - ref: /sdk/crypto/dd/trading_pair_info - - name: binance_available_quotes_for_each_coin - ref: /sdk/crypto/dd/binance_available_quotes_for_each_coin - - name: book - ref: /sdk/crypto/dd/book - - name: hr - ref: /sdk/crypto/dd/hr - - name: show_available_pairs_for_given_symbol - ref: /sdk/crypto/dd/show_available_pairs_for_given_symbol - - name: fr - ref: /sdk/crypto/dd/fr - - name: mcapdom - ref: /sdk/crypto/dd/mcapdom - - name: active - ref: /sdk/crypto/dd/active - - name: events - ref: /sdk/crypto/dd/events - - name: nonzero - ref: /sdk/crypto/dd/nonzero - - name: oi - ref: /sdk/crypto/dd/oi - - name: tokenomics - ref: /sdk/crypto/dd/tokenomics - - name: rm - ref: /sdk/crypto/dd/rm - - name: trading_pairs - ref: /sdk/crypto/dd/trading_pairs - - name: stats - ref: /sdk/crypto/dd/stats - - name: coin_market_chart - ref: /sdk/crypto/dd/coin_market_chart - - name: gov - ref: /sdk/crypto/dd/gov - - name: find - ref: /sdk/crypto/find - - name: defi - ref: /sdk/crypto/defi - sub: - - name: sratio - ref: /sdk/crypto/defi/sratio - - name: gacc - ref: /sdk/crypto/defi/gacc - - name: pools - ref: /sdk/crypto/defi/pools - - name: sinfo - ref: /sdk/crypto/defi/sinfo - - name: newsletters - ref: /sdk/crypto/defi/newsletters - - name: anchor_data - ref: /sdk/crypto/defi/anchor_data - - name: sreturn - ref: /sdk/crypto/defi/sreturn - - name: pairs - ref: /sdk/crypto/defi/pairs - - name: dpi - ref: /sdk/crypto/defi/dpi - - name: swaps - ref: /sdk/crypto/defi/swaps - - name: ldapps - ref: /sdk/crypto/defi/ldapps - - name: luna_supply - ref: /sdk/crypto/defi/luna_supply - - name: vaults - ref: /sdk/crypto/defi/vaults - - name: stvl - ref: /sdk/crypto/defi/stvl - - name: ayr - ref: /sdk/crypto/defi/ayr - - name: validators - ref: /sdk/crypto/defi/validators - - name: dtvl - ref: /sdk/crypto/defi/dtvl - - name: tokens - ref: /sdk/crypto/defi/tokens - - name: gov_proposals - ref: /sdk/crypto/defi/gov_proposals - - name: stats - ref: /sdk/crypto/defi/stats - - name: gdapps - ref: /sdk/crypto/defi/gdapps - - name: aterra - ref: /sdk/crypto/defi/aterra + - name: twitter + ref: /sdk/keys/twitter + - name: smartstake + ref: /sdk/keys/smartstake + - name: fred + ref: /sdk/keys/fred + - name: get_keys_info + ref: /sdk/keys/get_keys_info + - name: si + ref: /sdk/keys/si + - name: fmp + ref: /sdk/keys/fmp + - name: coinbase + ref: /sdk/keys/coinbase + - name: iex + ref: /sdk/keys/iex + - name: reddit + ref: /sdk/keys/reddit + - name: quandl + ref: /sdk/keys/quandl + - name: cpanic + ref: /sdk/keys/cpanic + - name: shroom + ref: /sdk/keys/shroom + - name: rh + ref: /sdk/keys/rh + - name: mykeys + ref: /sdk/keys/mykeys + - name: degiro + ref: /sdk/keys/degiro + - name: coinglass + ref: /sdk/keys/coinglass + - name: binance + ref: /sdk/keys/binance + - name: oanda + ref: /sdk/keys/oanda + - name: walert + ref: /sdk/keys/walert + - name: glassnode + ref: /sdk/keys/glassnode + - name: ethplorer + ref: /sdk/keys/ethplorer + - name: news + ref: /sdk/keys/news + - name: santiment + ref: /sdk/keys/santiment + - name: finnhub + ref: /sdk/keys/finnhub + - name: cmc + ref: /sdk/keys/cmc + - name: messari + ref: /sdk/keys/messari + - name: tradier + ref: /sdk/keys/tradier + - name: github + ref: /sdk/keys/github + - name: polygon + ref: /sdk/keys/polygon + - name: tokenterminal + ref: /sdk/keys/tokenterminal + - name: av + ref: /sdk/keys/av + - name: set_keys + ref: /sdk/keys/set_keys + - name: bitquery + ref: /sdk/keys/bitquery + - name: eodhd + ref: /sdk/keys/eodhd - name: economy ref: /sdk/economy sub: + - name: valuation + ref: /sdk/economy/valuation + - name: spectrum + ref: /sdk/economy/spectrum + - name: fred_series + ref: /sdk/economy/fred_series + - name: fred_yield_curve + ref: /sdk/economy/fred_yield_curve + - name: futures + ref: /sdk/economy/futures + - name: events + ref: /sdk/economy/events - name: gdpc ref: /sdk/economy/gdpc + - name: future + ref: /sdk/economy/future + - name: fred_ids + ref: /sdk/economy/fred_ids - name: gdp ref: /sdk/economy/gdp - name: macro_parameters ref: /sdk/economy/macro_parameters - - name: indices - ref: /sdk/economy/indices - - name: currencies - ref: /sdk/economy/currencies - - name: bigmac - ref: /sdk/economy/bigmac - - name: fred_notes - ref: /sdk/economy/fred_notes - - name: futures - ref: /sdk/economy/futures - - name: cpi - ref: /sdk/economy/cpi - - name: get_events_countries - ref: /sdk/economy/get_events_countries - - name: search_index - ref: /sdk/economy/search_index - - name: country_codes - ref: /sdk/economy/country_codes - - name: unemp - ref: /sdk/economy/unemp - - name: get_ycrv_countries - ref: /sdk/economy/get_ycrv_countries - - name: glbonds - ref: /sdk/economy/glbonds - - name: available_indices - ref: /sdk/economy/available_indices - - name: ycrv - ref: /sdk/economy/ycrv - - name: inf - ref: /sdk/economy/inf - name: rtps ref: /sdk/economy/rtps - - name: fred_series - ref: /sdk/economy/fred_series - - name: treasury_maturities - ref: /sdk/economy/treasury_maturities - - name: macro - ref: /sdk/economy/macro - - name: usbonds - ref: /sdk/economy/usbonds + - name: get_ycrv_countries + ref: /sdk/economy/get_ycrv_countries + - name: cpi + ref: /sdk/economy/cpi - name: index ref: /sdk/economy/index - - name: fred_yield_curve - ref: /sdk/economy/fred_yield_curve - - name: tyld - ref: /sdk/economy/tyld - - name: spectrum - ref: /sdk/economy/spectrum - - name: macro_countries - ref: /sdk/economy/macro_countries + - name: currencies + ref: /sdk/economy/currencies - name: treasury ref: /sdk/economy/treasury - - name: events - ref: /sdk/economy/events - - name: performance - ref: /sdk/economy/performance - - name: overview - ref: /sdk/economy/overview - - name: valuation - ref: /sdk/economy/valuation - - name: future - ref: /sdk/economy/future + - name: usbonds + ref: /sdk/economy/usbonds + - name: available_indices + ref: /sdk/economy/available_indices - name: perfmap ref: /sdk/economy/perfmap - - name: fred_ids - ref: /sdk/economy/fred_ids + - name: search_index + ref: /sdk/economy/search_index + - name: performance + ref: /sdk/economy/performance + - name: inf + ref: /sdk/economy/inf + - name: country_codes + ref: /sdk/economy/country_codes + - name: bigmac + ref: /sdk/economy/bigmac + - name: get_events_countries + ref: /sdk/economy/get_events_countries + - name: spread + ref: /sdk/economy/spread + - name: indices + ref: /sdk/economy/indices + - name: fred_notes + ref: /sdk/economy/fred_notes + - name: glbonds + ref: /sdk/economy/glbonds + - name: tyld + ref: /sdk/economy/tyld + - name: macro + ref: /sdk/economy/macro + - name: treasury_maturities + ref: /sdk/economy/treasury_maturities + - name: ycrv + ref: /sdk/economy/ycrv + - name: macro_countries + ref: /sdk/economy/macro_countries + - name: overview + ref: /sdk/economy/overview + - name: unemp + ref: /sdk/economy/unemp + - name: etf + ref: /sdk/etf + sub: + - name: disc + ref: /sdk/etf/disc + sub: + - name: mover + ref: /sdk/etf/disc/mover + - name: etf_by_category + ref: /sdk/etf/etf_by_category + - name: symbols + ref: /sdk/etf/symbols + - name: holdings + ref: /sdk/etf/holdings + - name: summary + ref: /sdk/etf/summary + - name: load + ref: /sdk/etf/load + - name: scr + ref: /sdk/etf/scr + sub: + - name: screen + ref: /sdk/etf/scr/screen + - name: news + ref: /sdk/etf/news + - name: ld + ref: /sdk/etf/ld + - name: candle + ref: /sdk/etf/candle + - name: weights + ref: /sdk/etf/weights + - name: overview + ref: /sdk/etf/overview + - name: etf_by_name + ref: /sdk/etf/etf_by_name + - name: ln + ref: /sdk/etf/ln - name: forex ref: /sdk/forex sub: - name: quote ref: /sdk/forex/quote - - name: candle - ref: /sdk/forex/candle - - name: get_currency_list - ref: /sdk/forex/get_currency_list - name: load ref: /sdk/forex/load + - name: get_currency_list + ref: /sdk/forex/get_currency_list - name: oanda ref: /sdk/forex/oanda sub: - - name: fwd - ref: /sdk/forex/oanda/fwd - - name: order - ref: /sdk/forex/oanda/order - - name: cancel - ref: /sdk/forex/oanda/cancel - - name: calendar - ref: /sdk/forex/oanda/calendar - - name: close - ref: /sdk/forex/oanda/close - - name: listorders - ref: /sdk/forex/oanda/listorders - - name: openpositions - ref: /sdk/forex/oanda/openpositions - - name: opentrades - ref: /sdk/forex/oanda/opentrades - - name: price - ref: /sdk/forex/oanda/price - - name: candles - ref: /sdk/forex/oanda/candles - name: orderbook ref: /sdk/forex/oanda/orderbook - - name: positionbook - ref: /sdk/forex/oanda/positionbook + - name: calendar + ref: /sdk/forex/oanda/calendar + - name: openpositions + ref: /sdk/forex/oanda/openpositions + - name: fwd + ref: /sdk/forex/oanda/fwd + - name: candles + ref: /sdk/forex/oanda/candles + - name: listorders + ref: /sdk/forex/oanda/listorders - name: summary ref: /sdk/forex/oanda/summary - name: pending ref: /sdk/forex/oanda/pending + - name: order + ref: /sdk/forex/oanda/order + - name: cancel + ref: /sdk/forex/oanda/cancel + - name: opentrades + ref: /sdk/forex/oanda/opentrades + - name: positionbook + ref: /sdk/forex/oanda/positionbook + - name: close + ref: /sdk/forex/oanda/close + - name: price + ref: /sdk/forex/oanda/price - name: hist ref: /sdk/forex/hist - - name: econometrics - ref: /sdk/econometrics - sub: - - name: options - ref: /sdk/econometrics/options - - name: panel - ref: /sdk/econometrics/panel - - name: bgod - ref: /sdk/econometrics/bgod - - name: bpag - ref: /sdk/econometrics/bpag - - name: bols - ref: /sdk/econometrics/bols - - name: fe - ref: /sdk/econometrics/fe - - name: fdols - ref: /sdk/econometrics/fdols - - name: coint - ref: /sdk/econometrics/coint - - name: pols - ref: /sdk/econometrics/pols - - name: granger - ref: /sdk/econometrics/granger - - name: clean - ref: /sdk/econometrics/clean - - name: norm - ref: /sdk/econometrics/norm - - name: load - ref: /sdk/econometrics/load - - name: get_regression_data - ref: /sdk/econometrics/get_regression_data - - name: root - ref: /sdk/econometrics/root - - name: dwat - ref: /sdk/econometrics/dwat - - name: comparison - ref: /sdk/econometrics/comparison - - name: re - ref: /sdk/econometrics/re - - name: ols - ref: /sdk/econometrics/ols + - name: candle + ref: /sdk/forex/candle - name: stocks ref: /sdk/stocks sub: + - name: dd + ref: /sdk/stocks/dd + sub: + - name: analyst + ref: /sdk/stocks/dd/analyst + - name: rating + ref: /sdk/stocks/dd/rating + - name: customer + ref: /sdk/stocks/dd/customer + - name: arktrades + ref: /sdk/stocks/dd/arktrades + - name: sec + ref: /sdk/stocks/dd/sec + - name: news + ref: /sdk/stocks/dd/news + - name: pt + ref: /sdk/stocks/dd/pt + - name: supplier + ref: /sdk/stocks/dd/supplier + - name: est + ref: /sdk/stocks/dd/est + - name: rot + ref: /sdk/stocks/dd/rot + - name: ta + ref: /sdk/stocks/ta + sub: + - name: summary + ref: /sdk/stocks/ta/summary + - name: view + ref: /sdk/stocks/ta/view + - name: recom + ref: /sdk/stocks/ta/recom - name: options ref: /sdk/stocks/options sub: + - name: process_chains + ref: /sdk/stocks/options/process_chains - name: vsurf ref: /sdk/stocks/options/vsurf - - name: pcr - ref: /sdk/stocks/options/pcr - - name: last_price - ref: /sdk/stocks/options/last_price - - name: chains_yf - ref: /sdk/stocks/options/chains_yf + - name: hist_tr + ref: /sdk/stocks/options/hist_tr + - name: closing + ref: /sdk/stocks/options/closing + - name: vol_yf + ref: /sdk/stocks/options/vol_yf - name: hedge ref: /sdk/stocks/options/hedge sub: - - name: add_hedge_option - ref: /sdk/stocks/options/hedge/add_hedge_option - - name: calc_vega - ref: /sdk/stocks/options/hedge/calc_vega - - name: calc_delta - ref: /sdk/stocks/options/hedge/calc_delta - name: calc_gamma ref: /sdk/stocks/options/hedge/calc_gamma + - name: calc_vega + ref: /sdk/stocks/options/hedge/calc_vega - name: calc_hedge ref: /sdk/stocks/options/hedge/calc_hedge - - name: hist_tr - ref: /sdk/stocks/options/hist_tr - - name: option_chain - ref: /sdk/stocks/options/option_chain - - name: hist_ce - ref: /sdk/stocks/options/hist_ce + - name: calc_delta + ref: /sdk/stocks/options/hedge/calc_delta + - name: add_hedge_option + ref: /sdk/stocks/options/hedge/add_hedge_option + - name: generate_data + ref: /sdk/stocks/options/generate_data - name: y_values ref: /sdk/stocks/options/y_values - - name: process_chains - ref: /sdk/stocks/options/process_chains - - name: vol_yf - ref: /sdk/stocks/options/vol_yf - - name: info - ref: /sdk/stocks/options/info + - name: dividend + ref: /sdk/stocks/options/dividend - name: dte ref: /sdk/stocks/options/dte - - name: price - ref: /sdk/stocks/options/price + - name: last_price + ref: /sdk/stocks/options/last_price + - name: info + ref: /sdk/stocks/options/info + - name: chains + ref: /sdk/stocks/options/chains + - name: x_values + ref: /sdk/stocks/options/x_values - name: grhist ref: /sdk/stocks/options/grhist + - name: hist_ce + ref: /sdk/stocks/options/hist_ce + - name: unu + ref: /sdk/stocks/options/unu + - name: pcr + ref: /sdk/stocks/options/pcr + - name: option_expirations + ref: /sdk/stocks/options/option_expirations + - name: voi_yf + ref: /sdk/stocks/options/voi_yf + - name: option_chain + ref: /sdk/stocks/options/option_chain - name: screen ref: /sdk/stocks/options/screen sub: - - name: screener_output - ref: /sdk/stocks/options/screen/screener_output - name: check_presets ref: /sdk/stocks/options/screen/check_presets - - name: unu - ref: /sdk/stocks/options/unu - - name: voi_yf - ref: /sdk/stocks/options/voi_yf - - name: dividend - ref: /sdk/stocks/options/dividend - - name: generate_data - ref: /sdk/stocks/options/generate_data - - name: chains - ref: /sdk/stocks/options/chains - - name: option_expirations - ref: /sdk/stocks/options/option_expirations - - name: closing - ref: /sdk/stocks/options/closing - - name: x_values - ref: /sdk/stocks/options/x_values - - name: screener - ref: /sdk/stocks/screener + - name: screener_output + ref: /sdk/stocks/options/screen/screener_output + - name: chains_yf + ref: /sdk/stocks/options/chains_yf + - name: price + ref: /sdk/stocks/options/price + - name: disc + ref: /sdk/stocks/disc sub: - - name: historical - ref: /sdk/stocks/screener/historical - - name: screener_data - ref: /sdk/stocks/screener/screener_data - - name: quote - ref: /sdk/stocks/quote - - name: candle - ref: /sdk/stocks/candle - - name: sia - ref: /sdk/stocks/sia - sub: - - name: sectors - ref: /sdk/stocks/sia/sectors - - name: filter_stocks - ref: /sdk/stocks/sia/filter_stocks - - name: cps - ref: /sdk/stocks/sia/cps - - name: industries - ref: /sdk/stocks/sia/industries - - name: cpic - ref: /sdk/stocks/sia/cpic - - name: maketcap - ref: /sdk/stocks/sia/maketcap - - name: stocks_data - ref: /sdk/stocks/sia/stocks_data - - name: countries - ref: /sdk/stocks/sia/countries - - name: cpci - ref: /sdk/stocks/sia/cpci - - name: cpis - ref: /sdk/stocks/sia/cpis - - name: cpcs - ref: /sdk/stocks/sia/cpcs + - name: gtech + ref: /sdk/stocks/disc/gtech + - name: upcoming + ref: /sdk/stocks/disc/upcoming + - name: trending + ref: /sdk/stocks/disc/trending + - name: lowfloat + ref: /sdk/stocks/disc/lowfloat + - name: gainers + ref: /sdk/stocks/disc/gainers + - name: asc + ref: /sdk/stocks/disc/asc + - name: ugs + ref: /sdk/stocks/disc/ugs + - name: active + ref: /sdk/stocks/disc/active + - name: pipo + ref: /sdk/stocks/disc/pipo + - name: fipo + ref: /sdk/stocks/disc/fipo + - name: ipo + ref: /sdk/stocks/disc/ipo + - name: losers + ref: /sdk/stocks/disc/losers + - name: dividends + ref: /sdk/stocks/disc/dividends + - name: arkord + ref: /sdk/stocks/disc/arkord + - name: ulc + ref: /sdk/stocks/disc/ulc + - name: news + ref: /sdk/stocks/disc/news + - name: rtat + ref: /sdk/stocks/disc/rtat + - name: hotpenny + ref: /sdk/stocks/disc/hotpenny - name: ca ref: /sdk/stocks/ca sub: - - name: scorr - ref: /sdk/stocks/ca/scorr - - name: polygon_peers - ref: /sdk/stocks/ca/polygon_peers - - name: screener - ref: /sdk/stocks/ca/screener - - name: income - ref: /sdk/stocks/ca/income - - name: balance - ref: /sdk/stocks/ca/balance - name: finviz_peers ref: /sdk/stocks/ca/finviz_peers + - name: volume + ref: /sdk/stocks/ca/volume + - name: income + ref: /sdk/stocks/ca/income + - name: polygon_peers + ref: /sdk/stocks/ca/polygon_peers + - name: hcorr + ref: /sdk/stocks/ca/hcorr + - name: balance + ref: /sdk/stocks/ca/balance - name: cashflow ref: /sdk/stocks/ca/cashflow - - name: finnhub_peers - ref: /sdk/stocks/ca/finnhub_peers - name: hist ref: /sdk/stocks/ca/hist - name: sentiment ref: /sdk/stocks/ca/sentiment - - name: volume - ref: /sdk/stocks/ca/volume - - name: hcorr - ref: /sdk/stocks/ca/hcorr - - name: qa - ref: /sdk/stocks/qa - sub: - - name: capm_information - ref: /sdk/stocks/qa/capm_information - - name: historical_5 - ref: /sdk/stocks/qa/historical_5 - - name: fama_raw - ref: /sdk/stocks/qa/fama_raw - - name: dps - ref: /sdk/stocks/dps - sub: - - name: prom - ref: /sdk/stocks/dps/prom - - name: ftd - ref: /sdk/stocks/dps/ftd - - name: psi_sg - ref: /sdk/stocks/dps/psi_sg - - name: shorted - ref: /sdk/stocks/dps/shorted - - name: dpotc - ref: /sdk/stocks/dps/dpotc - - name: pos - ref: /sdk/stocks/dps/pos - - name: sidtc - ref: /sdk/stocks/dps/sidtc - - name: volexch - ref: /sdk/stocks/dps/volexch - - name: ctb - ref: /sdk/stocks/dps/ctb - - name: hsi - ref: /sdk/stocks/dps/hsi - - name: psi_q - ref: /sdk/stocks/dps/psi_q - - name: spos - ref: /sdk/stocks/dps/spos - - name: search - ref: /sdk/stocks/search - - name: ins - ref: /sdk/stocks/ins - sub: - - name: lins - ref: /sdk/stocks/ins/lins - - name: print_insider_data - ref: /sdk/stocks/ins/print_insider_data - - name: act - ref: /sdk/stocks/ins/act + - name: finnhub_peers + ref: /sdk/stocks/ca/finnhub_peers + - name: screener + ref: /sdk/stocks/ca/screener + - name: scorr + ref: /sdk/stocks/ca/scorr + - name: quote + ref: /sdk/stocks/quote - name: load ref: /sdk/stocks/load - name: ba ref: /sdk/stocks/ba sub: - - name: wsb - ref: /sdk/stocks/ba/wsb - - name: cnews - ref: /sdk/stocks/ba/cnews - - name: spac - ref: /sdk/stocks/ba/spac - - name: regions - ref: /sdk/stocks/ba/regions + - name: trending + ref: /sdk/stocks/ba/trending + - name: text_sent + ref: /sdk/stocks/ba/text_sent + - name: infer + ref: /sdk/stocks/ba/infer + - name: mentions + ref: /sdk/stocks/ba/mentions - name: messages ref: /sdk/stocks/ba/messages - - name: snews - ref: /sdk/stocks/ba/snews + - name: popular + ref: /sdk/stocks/ba/popular + - name: cramer_ticker + ref: /sdk/stocks/ba/cramer_ticker + - name: bullbear + ref: /sdk/stocks/ba/bullbear + - name: wsb + ref: /sdk/stocks/ba/wsb - name: spac_c ref: /sdk/stocks/ba/spac_c - name: stalker ref: /sdk/stocks/ba/stalker - - name: trend - ref: /sdk/stocks/ba/trend - - name: reddit_sent - ref: /sdk/stocks/ba/reddit_sent - - name: headlines - ref: /sdk/stocks/ba/headlines - - name: queries - ref: /sdk/stocks/ba/queries - - name: mentions - ref: /sdk/stocks/ba/mentions - - name: text_sent - ref: /sdk/stocks/ba/text_sent - - name: getdd - ref: /sdk/stocks/ba/getdd - - name: bullbear - ref: /sdk/stocks/ba/bullbear - - name: popular - ref: /sdk/stocks/ba/popular - - name: infer - ref: /sdk/stocks/ba/infer - - name: hist - ref: /sdk/stocks/ba/hist - - name: trending - ref: /sdk/stocks/ba/trending - - name: cramer_ticker - ref: /sdk/stocks/ba/cramer_ticker + - name: spac + ref: /sdk/stocks/ba/spac - name: cramer ref: /sdk/stocks/ba/cramer + - name: queries + ref: /sdk/stocks/ba/queries + - name: reddit_sent + ref: /sdk/stocks/ba/reddit_sent + - name: watchlist + ref: /sdk/stocks/ba/watchlist + - name: regions + ref: /sdk/stocks/ba/regions + - name: trend + ref: /sdk/stocks/ba/trend + - name: hist + ref: /sdk/stocks/ba/hist + - name: headlines + ref: /sdk/stocks/ba/headlines - name: sentiment ref: /sdk/stocks/ba/sentiment - name: rise ref: /sdk/stocks/ba/rise - - name: watchlist - ref: /sdk/stocks/ba/watchlist - - name: bt - ref: /sdk/stocks/bt + - name: getdd + ref: /sdk/stocks/ba/getdd + - name: cnews + ref: /sdk/stocks/ba/cnews + - name: snews + ref: /sdk/stocks/ba/snews + - name: dps + ref: /sdk/stocks/dps sub: - - name: ema - ref: /sdk/stocks/bt/ema - - name: rsi - ref: /sdk/stocks/bt/rsi - - name: ema_cross - ref: /sdk/stocks/bt/ema_cross - - name: disc - ref: /sdk/stocks/disc + - name: ctb + ref: /sdk/stocks/dps/ctb + - name: psi_sg + ref: /sdk/stocks/dps/psi_sg + - name: prom + ref: /sdk/stocks/dps/prom + - name: volexch + ref: /sdk/stocks/dps/volexch + - name: dpotc + ref: /sdk/stocks/dps/dpotc + - name: shorted + ref: /sdk/stocks/dps/shorted + - name: spos + ref: /sdk/stocks/dps/spos + - name: pos + ref: /sdk/stocks/dps/pos + - name: psi_q + ref: /sdk/stocks/dps/psi_q + - name: ftd + ref: /sdk/stocks/dps/ftd + - name: sidtc + ref: /sdk/stocks/dps/sidtc + - name: hsi + ref: /sdk/stocks/dps/hsi + - name: gov + ref: /sdk/stocks/gov sub: - - name: asc - ref: /sdk/stocks/disc/asc - - name: ipo - ref: /sdk/stocks/disc/ipo - - name: gainers - ref: /sdk/stocks/disc/gainers - - name: gtech - ref: /sdk/stocks/disc/gtech - - name: hotpenny - ref: /sdk/stocks/disc/hotpenny - - name: losers - ref: /sdk/stocks/disc/losers - - name: news - ref: /sdk/stocks/disc/news - - name: ugs - ref: /sdk/stocks/disc/ugs - - name: lowfloat - ref: /sdk/stocks/disc/lowfloat - - name: rtat - ref: /sdk/stocks/disc/rtat - - name: pipo - ref: /sdk/stocks/disc/pipo - - name: trending - ref: /sdk/stocks/disc/trending - - name: upcoming - ref: /sdk/stocks/disc/upcoming - - name: ulc - ref: /sdk/stocks/disc/ulc - - name: active - ref: /sdk/stocks/disc/active - - name: dividends - ref: /sdk/stocks/disc/dividends - - name: arkord - ref: /sdk/stocks/disc/arkord - - name: fipo - ref: /sdk/stocks/disc/fipo - - name: dd - ref: /sdk/stocks/dd + - name: gtrades + ref: /sdk/stocks/gov/gtrades + - name: topbuys + ref: /sdk/stocks/gov/topbuys + - name: lobbying + ref: /sdk/stocks/gov/lobbying + - name: toplobbying + ref: /sdk/stocks/gov/toplobbying + - name: histcont + ref: /sdk/stocks/gov/histcont + - name: topsells + ref: /sdk/stocks/gov/topsells + - name: contracts + ref: /sdk/stocks/gov/contracts + - name: government_trading + ref: /sdk/stocks/gov/government_trading + - name: lasttrades + ref: /sdk/stocks/gov/lasttrades + - name: lastcontracts + ref: /sdk/stocks/gov/lastcontracts + - name: qtrcontracts + ref: /sdk/stocks/gov/qtrcontracts + - name: ins + ref: /sdk/stocks/ins sub: - - name: rot - ref: /sdk/stocks/dd/rot - - name: rating - ref: /sdk/stocks/dd/rating - - name: analyst - ref: /sdk/stocks/dd/analyst - - name: sec - ref: /sdk/stocks/dd/sec - - name: pt - ref: /sdk/stocks/dd/pt - - name: news - ref: /sdk/stocks/dd/news - - name: supplier - ref: /sdk/stocks/dd/supplier - - name: est - ref: /sdk/stocks/dd/est - - name: arktrades - ref: /sdk/stocks/dd/arktrades - - name: customer - ref: /sdk/stocks/dd/customer + - name: act + ref: /sdk/stocks/ins/act + - name: lins + ref: /sdk/stocks/ins/lins + - name: print_insider_data + ref: /sdk/stocks/ins/print_insider_data + - name: candle + ref: /sdk/stocks/candle + - name: process_candle + ref: /sdk/stocks/process_candle + - name: sia + ref: /sdk/stocks/sia + sub: + - name: cpcs + ref: /sdk/stocks/sia/cpcs + - name: cpis + ref: /sdk/stocks/sia/cpis + - name: cps + ref: /sdk/stocks/sia/cps + - name: countries + ref: /sdk/stocks/sia/countries + - name: cpic + ref: /sdk/stocks/sia/cpic + - name: cpci + ref: /sdk/stocks/sia/cpci + - name: sectors + ref: /sdk/stocks/sia/sectors + - name: maketcap + ref: /sdk/stocks/sia/maketcap + - name: industries + ref: /sdk/stocks/sia/industries + - name: filter_stocks + ref: /sdk/stocks/sia/filter_stocks + - name: stocks_data + ref: /sdk/stocks/sia/stocks_data + - name: tob + ref: /sdk/stocks/tob + - name: search + ref: /sdk/stocks/search + - name: qa + ref: /sdk/stocks/qa + sub: + - name: historical_5 + ref: /sdk/stocks/qa/historical_5 + - name: fama_raw + ref: /sdk/stocks/qa/fama_raw + - name: capm_information + ref: /sdk/stocks/qa/capm_information - name: fa ref: /sdk/stocks/fa sub: - - name: mgmt - ref: /sdk/stocks/fa/mgmt - - name: av_income - ref: /sdk/stocks/fa/av_income - - name: analysis - ref: /sdk/stocks/fa/analysis - - name: enterprise - ref: /sdk/stocks/fa/enterprise - - name: hq - ref: /sdk/stocks/fa/hq - - name: quote - ref: /sdk/stocks/fa/quote - - name: fraud - ref: /sdk/stocks/fa/fraud - name: dupont ref: /sdk/stocks/fa/dupont - - name: website - ref: /sdk/stocks/fa/website - - name: av_overview - ref: /sdk/stocks/fa/av_overview - - name: poly_financials - ref: /sdk/stocks/fa/poly_financials - - name: shrs - ref: /sdk/stocks/fa/shrs - - name: sust - ref: /sdk/stocks/fa/sust - - name: historical_5 - ref: /sdk/stocks/fa/historical_5 - - name: fmp_cash - ref: /sdk/stocks/fa/fmp_cash - - name: fmp_income - ref: /sdk/stocks/fa/fmp_income - - name: cal - ref: /sdk/stocks/fa/cal - - name: growth - ref: /sdk/stocks/fa/growth - - name: av_balance - ref: /sdk/stocks/fa/av_balance - - name: info - ref: /sdk/stocks/fa/info - - name: score - ref: /sdk/stocks/fa/score - - name: yf_financials - ref: /sdk/stocks/fa/yf_financials - - name: profile - ref: /sdk/stocks/fa/profile - - name: mktcap - ref: /sdk/stocks/fa/mktcap - - name: earnings - ref: /sdk/stocks/fa/earnings - name: fmp_metrics ref: /sdk/stocks/fa/fmp_metrics - - name: similar_dfs - ref: /sdk/stocks/fa/similar_dfs - - name: divs - ref: /sdk/stocks/fa/divs - - name: dcf - ref: /sdk/stocks/fa/dcf - - name: fmp_balance - ref: /sdk/stocks/fa/fmp_balance - - name: fmp_ratios - ref: /sdk/stocks/fa/fmp_ratios - - name: av_cash - ref: /sdk/stocks/fa/av_cash - - name: data - ref: /sdk/stocks/fa/data - - name: av_metrics - ref: /sdk/stocks/fa/av_metrics + - name: fmp_cash + ref: /sdk/stocks/fa/fmp_cash + - name: historical_5 + ref: /sdk/stocks/fa/historical_5 + - name: hq + ref: /sdk/stocks/fa/hq - name: fama_raw ref: /sdk/stocks/fa/fama_raw + - name: fraud + ref: /sdk/stocks/fa/fraud + - name: av_income + ref: /sdk/stocks/fa/av_income + - name: data + ref: /sdk/stocks/fa/data - name: fama_coe ref: /sdk/stocks/fa/fama_coe + - name: score + ref: /sdk/stocks/fa/score + - name: quote + ref: /sdk/stocks/fa/quote + - name: poly_financials + ref: /sdk/stocks/fa/poly_financials + - name: av_overview + ref: /sdk/stocks/fa/av_overview + - name: fmp_income + ref: /sdk/stocks/fa/fmp_income + - name: info + ref: /sdk/stocks/fa/info + - name: yf_financials + ref: /sdk/stocks/fa/yf_financials + - name: cal + ref: /sdk/stocks/fa/cal + - name: av_balance + ref: /sdk/stocks/fa/av_balance + - name: mgmt + ref: /sdk/stocks/fa/mgmt + - name: sust + ref: /sdk/stocks/fa/sust + - name: av_metrics + ref: /sdk/stocks/fa/av_metrics + - name: enterprise + ref: /sdk/stocks/fa/enterprise - name: splits ref: /sdk/stocks/fa/splits - - name: process_candle - ref: /sdk/stocks/process_candle - - name: ta - ref: /sdk/stocks/ta + - name: earnings + ref: /sdk/stocks/fa/earnings + - name: av_cash + ref: /sdk/stocks/fa/av_cash + - name: shrs + ref: /sdk/stocks/fa/shrs + - name: mktcap + ref: /sdk/stocks/fa/mktcap + - name: dcf + ref: /sdk/stocks/fa/dcf + - name: website + ref: /sdk/stocks/fa/website + - name: growth + ref: /sdk/stocks/fa/growth + - name: divs + ref: /sdk/stocks/fa/divs + - name: fmp_balance + ref: /sdk/stocks/fa/fmp_balance + - name: profile + ref: /sdk/stocks/fa/profile + - name: fmp_ratios + ref: /sdk/stocks/fa/fmp_ratios + - name: similar_dfs + ref: /sdk/stocks/fa/similar_dfs + - name: analysis + ref: /sdk/stocks/fa/analysis + - name: screener + ref: /sdk/stocks/screener sub: - - name: recom - ref: /sdk/stocks/ta/recom - - name: view - ref: /sdk/stocks/ta/view - - name: summary - ref: /sdk/stocks/ta/summary + - name: screener_data + ref: /sdk/stocks/screener/screener_data + - name: historical + ref: /sdk/stocks/screener/historical - name: th ref: /sdk/stocks/th sub: - name: exchange ref: /sdk/stocks/th/exchange + - name: closed + ref: /sdk/stocks/th/closed - name: check_if_open ref: /sdk/stocks/th/check_if_open - name: all ref: /sdk/stocks/th/all - - name: closed - ref: /sdk/stocks/th/closed - name: open ref: /sdk/stocks/th/open - - name: gov - ref: /sdk/stocks/gov + - name: bt + ref: /sdk/stocks/bt sub: - - name: topbuys - ref: /sdk/stocks/gov/topbuys - - name: lobbying - ref: /sdk/stocks/gov/lobbying - - name: government_trading - ref: /sdk/stocks/gov/government_trading - - name: contracts - ref: /sdk/stocks/gov/contracts - - name: topsells - ref: /sdk/stocks/gov/topsells - - name: lasttrades - ref: /sdk/stocks/gov/lasttrades - - name: histcont - ref: /sdk/stocks/gov/histcont - - name: toplobbying - ref: /sdk/stocks/gov/toplobbying - - name: lastcontracts - ref: /sdk/stocks/gov/lastcontracts - - name: gtrades - ref: /sdk/stocks/gov/gtrades - - name: qtrcontracts - ref: /sdk/stocks/gov/qtrcontracts + - name: ema + ref: /sdk/stocks/bt/ema + - name: ema_cross + ref: /sdk/stocks/bt/ema_cross + - name: rsi + ref: /sdk/stocks/bt/rsi + - name: funds + ref: /sdk/funds + sub: + - name: info + ref: /sdk/funds/info + - name: search + ref: /sdk/funds/search + - name: overview + ref: /sdk/funds/overview - name: common ref: /sdk/common sub: + - name: ta + ref: /sdk/common/ta + sub: + - name: ad + ref: /sdk/common/ta/ad + - name: aroon + ref: /sdk/common/ta/aroon + - name: ema + ref: /sdk/common/ta/ema + - name: adx + ref: /sdk/common/ta/adx + - name: cg + ref: /sdk/common/ta/cg + - name: sma + ref: /sdk/common/ta/sma + - name: ma + ref: /sdk/common/ta/ma + - name: rsi + ref: /sdk/common/ta/rsi + - name: fisher + ref: /sdk/common/ta/fisher + - name: hma + ref: /sdk/common/ta/hma + - name: cci + ref: /sdk/common/ta/cci + - name: adosc + ref: /sdk/common/ta/adosc + - name: obv + ref: /sdk/common/ta/obv + - name: vwap + ref: /sdk/common/ta/vwap + - name: wma + ref: /sdk/common/ta/wma + - name: donchian + ref: /sdk/common/ta/donchian + - name: kc + ref: /sdk/common/ta/kc + - name: fib + ref: /sdk/common/ta/fib + - name: bbands + ref: /sdk/common/ta/bbands + - name: macd + ref: /sdk/common/ta/macd + - name: zlma + ref: /sdk/common/ta/zlma + - name: stoch + ref: /sdk/common/ta/stoch - name: behavioural_analysis ref: /sdk/common/behavioural_analysis sub: @@ -2659,294 +2460,574 @@ main: ref: /sdk/common/behavioural_analysis/sentiment_stats - name: sentiment ref: /sdk/common/behavioural_analysis/sentiment + - name: news + ref: /sdk/common/news - name: qa ref: /sdk/common/qa sub: - - name: skew - ref: /sdk/common/qa/skew - - name: bw - ref: /sdk/common/qa/bw - - name: rolling - ref: /sdk/common/qa/rolling - - name: calculate_adjusted_var - ref: /sdk/common/qa/calculate_adjusted_var - - name: sharpe - ref: /sdk/common/qa/sharpe - - name: quantile - ref: /sdk/common/qa/quantile - - name: var - ref: /sdk/common/qa/var - - name: spread - ref: /sdk/common/qa/spread - - name: kurtosis - ref: /sdk/common/qa/kurtosis - - name: unitroot - ref: /sdk/common/qa/unitroot - - name: sortino - ref: /sdk/common/qa/sortino - - name: omega - ref: /sdk/common/qa/omega - name: es ref: /sdk/common/qa/es - - name: decompose - ref: /sdk/common/qa/decompose - - name: summary - ref: /sdk/common/qa/summary + - name: calculate_adjusted_var + ref: /sdk/common/qa/calculate_adjusted_var + - name: skew + ref: /sdk/common/qa/skew - name: normality ref: /sdk/common/qa/normality - - name: news - ref: /sdk/common/news - - name: ta - ref: /sdk/common/ta + - name: var + ref: /sdk/common/qa/var + - name: kurtosis + ref: /sdk/common/qa/kurtosis + - name: quantile + ref: /sdk/common/qa/quantile + - name: summary + ref: /sdk/common/qa/summary + - name: unitroot + ref: /sdk/common/qa/unitroot + - name: bw + ref: /sdk/common/qa/bw + - name: spread + ref: /sdk/common/qa/spread + - name: rolling + ref: /sdk/common/qa/rolling + - name: decompose + ref: /sdk/common/qa/decompose + - name: sharpe + ref: /sdk/common/qa/sharpe + - name: omega + ref: /sdk/common/qa/omega + - name: sortino + ref: /sdk/common/qa/sortino + - name: crypto + ref: /sdk/crypto + sub: + - name: defi + ref: /sdk/crypto/defi sub: - - name: ema - ref: /sdk/common/ta/ema - - name: obv - ref: /sdk/common/ta/obv - - name: fisher - ref: /sdk/common/ta/fisher - - name: aroon - ref: /sdk/common/ta/aroon - - name: kc - ref: /sdk/common/ta/kc - - name: ad - ref: /sdk/common/ta/ad - - name: wma - ref: /sdk/common/ta/wma - - name: ma - ref: /sdk/common/ta/ma - - name: sma - ref: /sdk/common/ta/sma - - name: cg - ref: /sdk/common/ta/cg - - name: rsi - ref: /sdk/common/ta/rsi - - name: hma - ref: /sdk/common/ta/hma - - name: macd - ref: /sdk/common/ta/macd - - name: stoch - ref: /sdk/common/ta/stoch - - name: bbands - ref: /sdk/common/ta/bbands - - name: donchian - ref: /sdk/common/ta/donchian - - name: vwap - ref: /sdk/common/ta/vwap - - name: zlma - ref: /sdk/common/ta/zlma - - name: adx - ref: /sdk/common/ta/adx - - name: fib - ref: /sdk/common/ta/fib - - name: adosc - ref: /sdk/common/ta/adosc - - name: cci - ref: /sdk/common/ta/cci + - name: stats + ref: /sdk/crypto/defi/stats + - name: newsletters + ref: /sdk/crypto/defi/newsletters + - name: gov_proposals + ref: /sdk/crypto/defi/gov_proposals + - name: sreturn + ref: /sdk/crypto/defi/sreturn + - name: anchor_data + ref: /sdk/crypto/defi/anchor_data + - name: aterra + ref: /sdk/crypto/defi/aterra + - name: ldapps + ref: /sdk/crypto/defi/ldapps + - name: pairs + ref: /sdk/crypto/defi/pairs + - name: luna_supply + ref: /sdk/crypto/defi/luna_supply + - name: tokens + ref: /sdk/crypto/defi/tokens + - name: validators + ref: /sdk/crypto/defi/validators + - name: sinfo + ref: /sdk/crypto/defi/sinfo + - name: ayr + ref: /sdk/crypto/defi/ayr + - name: dtvl + ref: /sdk/crypto/defi/dtvl + - name: gacc + ref: /sdk/crypto/defi/gacc + - name: swaps + ref: /sdk/crypto/defi/swaps + - name: pools + ref: /sdk/crypto/defi/pools + - name: sratio + ref: /sdk/crypto/defi/sratio + - name: dpi + ref: /sdk/crypto/defi/dpi + - name: gdapps + ref: /sdk/crypto/defi/gdapps + - name: stvl + ref: /sdk/crypto/defi/stvl + - name: vaults + ref: /sdk/crypto/defi/vaults + - name: dd + ref: /sdk/crypto/dd + sub: + - name: trades + ref: /sdk/crypto/dd/trades + - name: stats + ref: /sdk/crypto/dd/stats + - name: ohlc_historical + ref: /sdk/crypto/dd/ohlc_historical + - name: check_valid_binance_str + ref: /sdk/crypto/dd/check_valid_binance_str + - name: rm + ref: /sdk/crypto/dd/rm + - name: team + ref: /sdk/crypto/dd/team + - name: tokenomics + ref: /sdk/crypto/dd/tokenomics + - name: links + ref: /sdk/crypto/dd/links + - name: twitter + ref: /sdk/crypto/dd/twitter + - name: candles + ref: /sdk/crypto/dd/candles + - name: events + ref: /sdk/crypto/dd/events + - name: mt + ref: /sdk/crypto/dd/mt + - name: pr + ref: /sdk/crypto/dd/pr + - name: ps + ref: /sdk/crypto/dd/ps + - name: fr + ref: /sdk/crypto/dd/fr + - name: basic + ref: /sdk/crypto/dd/basic + - name: all_binance_trading_pairs + ref: /sdk/crypto/dd/all_binance_trading_pairs + - name: mcapdom + ref: /sdk/crypto/dd/mcapdom + - name: coin + ref: /sdk/crypto/dd/coin + - name: inv + ref: /sdk/crypto/dd/inv + - name: balance + ref: /sdk/crypto/dd/balance + - name: oi + ref: /sdk/crypto/dd/oi + - name: coin_market_chart + ref: /sdk/crypto/dd/coin_market_chart + - name: pi + ref: /sdk/crypto/dd/pi + - name: exchanges + ref: /sdk/crypto/dd/exchanges + - name: active + ref: /sdk/crypto/dd/active + - name: trading_pair_info + ref: /sdk/crypto/dd/trading_pair_info + - name: hr + ref: /sdk/crypto/dd/hr + - name: eb + ref: /sdk/crypto/dd/eb + - name: btcrb + ref: /sdk/crypto/dd/btcrb + - name: tk + ref: /sdk/crypto/dd/tk + - name: trading_pairs + ref: /sdk/crypto/dd/trading_pairs + - name: gov + ref: /sdk/crypto/dd/gov + - name: headlines + ref: /sdk/crypto/dd/headlines + - name: news + ref: /sdk/crypto/dd/news + - name: mkt + ref: /sdk/crypto/dd/mkt + - name: book + ref: /sdk/crypto/dd/book + - name: cbbook + ref: /sdk/crypto/dd/cbbook + - name: close + ref: /sdk/crypto/dd/close + - name: get_mt + ref: /sdk/crypto/dd/get_mt + - name: ex + ref: /sdk/crypto/dd/ex + - name: nonzero + ref: /sdk/crypto/dd/nonzero + - name: show_available_pairs_for_given_symbol + ref: /sdk/crypto/dd/show_available_pairs_for_given_symbol + - name: gh + ref: /sdk/crypto/dd/gh + - name: change + ref: /sdk/crypto/dd/change + - name: binance_available_quotes_for_each_coin + ref: /sdk/crypto/dd/binance_available_quotes_for_each_coin + - name: candles + ref: /sdk/crypto/candles + - name: ov + ref: /sdk/crypto/ov + sub: + - name: cgexrates + ref: /sdk/crypto/ov/cgexrates + - name: cr + ref: /sdk/crypto/ov/cr + - name: crypto_hacks + ref: /sdk/crypto/ov/crypto_hacks + - name: crypto_hack + ref: /sdk/crypto/ov/crypto_hack + - name: global_info + ref: /sdk/crypto/ov/global_info + - name: cgstables + ref: /sdk/crypto/ov/cgstables + - name: crypto_hack_slugs + ref: /sdk/crypto/ov/crypto_hack_slugs + - name: cpplatforms + ref: /sdk/crypto/ov/cpplatforms + - name: cpinfo + ref: /sdk/crypto/ov/cpinfo + - name: cgdefi + ref: /sdk/crypto/ov/cgdefi + - name: cbpairs + ref: /sdk/crypto/ov/cbpairs + - name: cpexmarkets + ref: /sdk/crypto/ov/cpexmarkets + - name: ewf + ref: /sdk/crypto/ov/ewf + - name: exchanges + ref: /sdk/crypto/ov/exchanges + - name: cgderivatives + ref: /sdk/crypto/ov/cgderivatives + - name: wfpe + ref: /sdk/crypto/ov/wfpe + - name: list_of_coins + ref: /sdk/crypto/ov/list_of_coins + - name: cgcategories + ref: /sdk/crypto/ov/cgcategories + - name: wf + ref: /sdk/crypto/ov/wf + - name: cpcontracts + ref: /sdk/crypto/ov/cpcontracts + - name: cgglobal + ref: /sdk/crypto/ov/cgglobal + - name: cghold + ref: /sdk/crypto/ov/cghold + - name: altindex + ref: /sdk/crypto/ov/altindex + - name: cgindexes + ref: /sdk/crypto/ov/cgindexes + - name: news + ref: /sdk/crypto/ov/news + - name: cghm + ref: /sdk/crypto/ov/cghm + - name: cpglobal + ref: /sdk/crypto/ov/cpglobal + - name: cpmarkets + ref: /sdk/crypto/ov/cpmarkets + - name: platforms + ref: /sdk/crypto/ov/platforms + - name: cgproducts + ref: /sdk/crypto/ov/cgproducts + - name: cpexchanges + ref: /sdk/crypto/ov/cpexchanges + - name: disc + ref: /sdk/crypto/disc + sub: + - name: top_dexes + ref: /sdk/crypto/disc/top_dexes + - name: trending + ref: /sdk/crypto/disc/trending + - name: categories_keys + ref: /sdk/crypto/disc/categories_keys + - name: coin_list + ref: /sdk/crypto/disc/coin_list + - name: gainers_or_losers + ref: /sdk/crypto/disc/gainers_or_losers + - name: gainers + ref: /sdk/crypto/disc/gainers + - name: top_games + ref: /sdk/crypto/disc/top_games + - name: cpsearch + ref: /sdk/crypto/disc/cpsearch + - name: coins_for_given_exchange + ref: /sdk/crypto/disc/coins_for_given_exchange + - name: losers + ref: /sdk/crypto/disc/losers + - name: coins + ref: /sdk/crypto/disc/coins + - name: cmctop + ref: /sdk/crypto/disc/cmctop + - name: top_nfts + ref: /sdk/crypto/disc/top_nfts + - name: top_dapps + ref: /sdk/crypto/disc/top_dapps + - name: find + ref: /sdk/crypto/find + - name: nft + ref: /sdk/crypto/nft + sub: + - name: stats + ref: /sdk/crypto/nft/stats + - name: load + ref: /sdk/crypto/load + - name: onchain + ref: /sdk/crypto/onchain + sub: + - name: erc20_tokens + ref: /sdk/crypto/onchain/erc20_tokens + - name: whales + ref: /sdk/crypto/onchain/whales + - name: prices + ref: /sdk/crypto/onchain/prices + - name: ueat + ref: /sdk/crypto/onchain/ueat + - name: dex_trades_monthly + ref: /sdk/crypto/onchain/dex_trades_monthly + - name: holders + ref: /sdk/crypto/onchain/holders + - name: token_decimals + ref: /sdk/crypto/onchain/token_decimals + - name: tx + ref: /sdk/crypto/onchain/tx + - name: query_graph + ref: /sdk/crypto/onchain/query_graph + - name: info + ref: /sdk/crypto/onchain/info + - name: balance + ref: /sdk/crypto/onchain/balance + - name: hr + ref: /sdk/crypto/onchain/hr + - name: gwei + ref: /sdk/crypto/onchain/gwei + - name: tv + ref: /sdk/crypto/onchain/tv + - name: hist + ref: /sdk/crypto/onchain/hist + - name: btc_transac + ref: /sdk/crypto/onchain/btc_transac + - name: lt + ref: /sdk/crypto/onchain/lt + - name: baas + ref: /sdk/crypto/onchain/baas + - name: dvcp + ref: /sdk/crypto/onchain/dvcp + - name: top + ref: /sdk/crypto/onchain/top + - name: btc_supply + ref: /sdk/crypto/onchain/btc_supply + - name: th + ref: /sdk/crypto/onchain/th + - name: ttcp + ref: /sdk/crypto/onchain/ttcp + - name: chart + ref: /sdk/crypto/chart + - name: tools + ref: /sdk/crypto/tools + sub: + - name: il + ref: /sdk/crypto/tools/il + - name: apy + ref: /sdk/crypto/tools/apy + - name: forecast + ref: /sdk/forecast + sub: + - name: season + ref: /sdk/forecast/season + - name: delete + ref: /sdk/forecast/delete + - name: regr + ref: /sdk/forecast/regr + - name: ema + ref: /sdk/forecast/ema + - name: plot + ref: /sdk/forecast/plot + - name: delta + ref: /sdk/forecast/delta + - name: brnn + ref: /sdk/forecast/brnn + - name: trans + ref: /sdk/forecast/trans + - name: show + ref: /sdk/forecast/show + - name: linregr + ref: /sdk/forecast/linregr + - name: load + ref: /sdk/forecast/load + - name: corr + ref: /sdk/forecast/corr + - name: rename + ref: /sdk/forecast/rename + - name: roc + ref: /sdk/forecast/roc + - name: expo + ref: /sdk/forecast/expo + - name: rsi + ref: /sdk/forecast/rsi + - name: tcn + ref: /sdk/forecast/tcn + - name: signal + ref: /sdk/forecast/signal + - name: export + ref: /sdk/forecast/export + - name: desc + ref: /sdk/forecast/desc + - name: rnn + ref: /sdk/forecast/rnn + - name: theta + ref: /sdk/forecast/theta + - name: clean + ref: /sdk/forecast/clean + - name: tft + ref: /sdk/forecast/tft + - name: combine + ref: /sdk/forecast/combine + - name: nhits + ref: /sdk/forecast/nhits + - name: nbeats + ref: /sdk/forecast/nbeats + - name: atr + ref: /sdk/forecast/atr + - name: sto + ref: /sdk/forecast/sto + - name: mom + ref: /sdk/forecast/mom - name: portfolio ref: /sdk/portfolio sub: - - name: dret - ref: /sdk/portfolio/dret - - name: skew - ref: /sdk/portfolio/skew - - name: information - ref: /sdk/portfolio/information - - name: calmar - ref: /sdk/portfolio/calmar - - name: maxdd - ref: /sdk/portfolio/maxdd - - name: rsquare - ref: /sdk/portfolio/rsquare - - name: payoff - ref: /sdk/portfolio/payoff - - name: sharpe - ref: /sdk/portfolio/sharpe - name: yret ref: /sdk/portfolio/yret - - name: rsharpe - ref: /sdk/portfolio/rsharpe - - name: jensens - ref: /sdk/portfolio/jensens - - name: kelly - ref: /sdk/portfolio/kelly - - name: om - ref: /sdk/portfolio/om - - name: profitfactor - ref: /sdk/portfolio/profitfactor + - name: maxdd + ref: /sdk/portfolio/maxdd + - name: es + ref: /sdk/portfolio/es + - name: distr + ref: /sdk/portfolio/distr - name: volatility ref: /sdk/portfolio/volatility - - name: trackerr - ref: /sdk/portfolio/trackerr + - name: holdv + ref: /sdk/portfolio/holdv + - name: skew + ref: /sdk/portfolio/skew + - name: mret + ref: /sdk/portfolio/mret + - name: holdp + ref: /sdk/portfolio/holdp - name: var ref: /sdk/portfolio/var - - name: tail - ref: /sdk/portfolio/tail + - name: kelly + ref: /sdk/portfolio/kelly + - name: perf + ref: /sdk/portfolio/perf - name: kurtosis ref: /sdk/portfolio/kurtosis + - name: jensens + ref: /sdk/portfolio/jensens + - name: profitfactor + ref: /sdk/portfolio/profitfactor + - name: summary + ref: /sdk/portfolio/summary + - name: rvol + ref: /sdk/portfolio/rvol + - name: information + ref: /sdk/portfolio/information + - name: dret + ref: /sdk/portfolio/dret + - name: rsortino + ref: /sdk/portfolio/rsortino + - name: gaintopain + ref: /sdk/portfolio/gaintopain + - name: commonsense + ref: /sdk/portfolio/commonsense + - name: maxdrawdown + ref: /sdk/portfolio/maxdrawdown + - name: max_drawdown_ratio + ref: /sdk/portfolio/max_drawdown_ratio + - name: rbeta + ref: /sdk/portfolio/rbeta + - name: om + ref: /sdk/portfolio/om + - name: rsharpe + ref: /sdk/portfolio/rsharpe + - name: tail + ref: /sdk/portfolio/tail - name: po ref: /sdk/portfolio/po sub: - - name: plot - ref: /sdk/portfolio/po/plot - - name: maxdecorr - ref: /sdk/portfolio/po/maxdecorr - - name: get_properties - ref: /sdk/portfolio/po/get_properties - - name: meanrisk - ref: /sdk/portfolio/po/meanrisk - - name: property - ref: /sdk/portfolio/po/property - - name: herc - ref: /sdk/portfolio/po/herc - - name: maxdiv - ref: /sdk/portfolio/po/maxdiv - - name: maxsharpe - ref: /sdk/portfolio/po/maxsharpe - - name: maxret - ref: /sdk/portfolio/po/maxret - - name: load_bl_views - ref: /sdk/portfolio/po/load_bl_views - - name: hrp - ref: /sdk/portfolio/po/hrp - - name: load - ref: /sdk/portfolio/po/load - - name: riskparity - ref: /sdk/portfolio/po/riskparity - - name: hcp - ref: /sdk/portfolio/po/hcp - - name: blacklitterman - ref: /sdk/portfolio/po/blacklitterman - - name: nco - ref: /sdk/portfolio/po/nco - - name: equal - ref: /sdk/portfolio/po/equal - - name: minrisk - ref: /sdk/portfolio/po/minrisk - - name: ef - ref: /sdk/portfolio/po/ef - - name: maxutil - ref: /sdk/portfolio/po/maxutil - name: relriskparity ref: /sdk/portfolio/po/relriskparity - - name: rsortino - ref: /sdk/portfolio/rsortino + - name: get_properties + ref: /sdk/portfolio/po/get_properties + - name: herc + ref: /sdk/portfolio/po/herc + - name: maxsharpe + ref: /sdk/portfolio/po/maxsharpe + - name: plot + ref: /sdk/portfolio/po/plot + - name: ef + ref: /sdk/portfolio/po/ef + - name: hrp + ref: /sdk/portfolio/po/hrp + - name: minrisk + ref: /sdk/portfolio/po/minrisk + - name: load + ref: /sdk/portfolio/po/load + - name: equal + ref: /sdk/portfolio/po/equal + - name: maxutil + ref: /sdk/portfolio/po/maxutil + - name: nco + ref: /sdk/portfolio/po/nco + - name: property + ref: /sdk/portfolio/po/property + - name: maxret + ref: /sdk/portfolio/po/maxret + - name: blacklitterman + ref: /sdk/portfolio/po/blacklitterman + - name: meanrisk + ref: /sdk/portfolio/po/meanrisk + - name: load_bl_views + ref: /sdk/portfolio/po/load_bl_views + - name: riskparity + ref: /sdk/portfolio/po/riskparity + - name: maxdiv + ref: /sdk/portfolio/po/maxdiv + - name: maxdecorr + ref: /sdk/portfolio/po/maxdecorr + - name: hcp + ref: /sdk/portfolio/po/hcp + - name: trackerr + ref: /sdk/portfolio/trackerr + - name: sharpe + ref: /sdk/portfolio/sharpe + - name: calmar + ref: /sdk/portfolio/calmar + - name: rsquare + ref: /sdk/portfolio/rsquare - name: sortino ref: /sdk/portfolio/sortino - - name: mret - ref: /sdk/portfolio/mret - - name: rbeta - ref: /sdk/portfolio/rbeta - - name: max_drawdown_ratio - ref: /sdk/portfolio/max_drawdown_ratio - - name: gaintopain - ref: /sdk/portfolio/gaintopain - - name: es - ref: /sdk/portfolio/es - - name: maxdrawdown - ref: /sdk/portfolio/maxdrawdown - - name: commonsense - ref: /sdk/portfolio/commonsense - - name: rvol - ref: /sdk/portfolio/rvol - - name: perf - ref: /sdk/portfolio/perf - - name: distr - ref: /sdk/portfolio/distr - - name: holdp - ref: /sdk/portfolio/holdp - - name: summary - ref: /sdk/portfolio/summary - - name: holdv - ref: /sdk/portfolio/holdv - - name: etf - ref: /sdk/etf - sub: - - name: ld - ref: /sdk/etf/ld - - name: candle - ref: /sdk/etf/candle - - name: weights - ref: /sdk/etf/weights - - name: scr - ref: /sdk/etf/scr - sub: - - name: screen - ref: /sdk/etf/scr/screen - - name: holdings - ref: /sdk/etf/holdings - - name: etf_by_name - ref: /sdk/etf/etf_by_name - - name: load - ref: /sdk/etf/load - - name: news - ref: /sdk/etf/news - - name: disc - ref: /sdk/etf/disc - sub: - - name: mover - ref: /sdk/etf/disc/mover - - name: symbols - ref: /sdk/etf/symbols - - name: ln - ref: /sdk/etf/ln - - name: etf_by_category - ref: /sdk/etf/etf_by_category - - name: overview - ref: /sdk/etf/overview - - name: summary - ref: /sdk/etf/summary - - name: funds - ref: /sdk/funds - sub: - - name: search - ref: /sdk/funds/search - - name: info - ref: /sdk/funds/info - - name: overview - ref: /sdk/funds/overview + - name: payoff + ref: /sdk/portfolio/payoff - name: alt ref: /sdk/alt sub: - name: oss ref: /sdk/alt/oss sub: - - name: top - ref: /sdk/alt/oss/top - - name: top_repos - ref: /sdk/alt/oss/top_repos - - name: repo_summary - ref: /sdk/alt/oss/repo_summary - - name: stars_history - ref: /sdk/alt/oss/stars_history - - name: search - ref: /sdk/alt/oss/search - - name: _make_request - ref: /sdk/alt/oss/_make_request - - name: history - ref: /sdk/alt/oss/history + - name: github_data + ref: /sdk/alt/oss/github_data - name: _retry_session ref: /sdk/alt/oss/_retry_session - name: search_repos ref: /sdk/alt/oss/search_repos - - name: github_data - ref: /sdk/alt/oss/github_data + - name: stars_history + ref: /sdk/alt/oss/stars_history - name: summary ref: /sdk/alt/oss/summary + - name: top_repos + ref: /sdk/alt/oss/top_repos + - name: repo_summary + ref: /sdk/alt/oss/repo_summary + - name: history + ref: /sdk/alt/oss/history + - name: _make_request + ref: /sdk/alt/oss/_make_request + - name: search + ref: /sdk/alt/oss/search + - name: top + ref: /sdk/alt/oss/top - name: ross ref: /sdk/alt/oss/ross - name: covid ref: /sdk/alt/covid sub: - - name: slopes - ref: /sdk/alt/covid/slopes - - name: global_deaths - ref: /sdk/alt/covid/global_deaths - - name: ov - ref: /sdk/alt/covid/ov - - name: global_cases - ref: /sdk/alt/covid/global_cases - name: stat ref: /sdk/alt/covid/stat + - name: slopes + ref: /sdk/alt/covid/slopes + - name: ov + ref: /sdk/alt/covid/ov - name: case_slopes ref: /sdk/alt/covid/case_slopes + - name: global_deaths + ref: /sdk/alt/covid/global_deaths + - name: global_cases + ref: /sdk/alt/covid/global_cases