diff --git a/.codespell.ignore b/.codespell.ignore index ea48d238a85e..56ee8c89f18b 100644 --- a/.codespell.ignore +++ b/.codespell.ignore @@ -1,4 +1,5 @@ ake +alle ba brin buda diff --git a/.secrets.baseline b/.secrets.baseline index dec467ff1fc2..f44eb0b419dd 100644 --- a/.secrets.baseline +++ b/.secrets.baseline @@ -121,7 +121,8 @@ { "path": "detect_secrets.filters.regex.should_exclude_secret", "pattern": [ - "example" + "example", + "REPLACE_ME" ] } ], diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index f62868a16f11..f83efc746a80 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -223,7 +223,7 @@ Now that we have added the model function getting, we need to specify that this If you are adding a new function with a new data source, make a new value in the file. If the data source requires an API key, please refer to the guide below for adding them. Instructions for obtaining the new api key -should be included in the file `OpenBBTerminal/website/content/terminal/usage/guides/api-keys.md`. +should be included in the file `OpenBBTerminal/website/content/terminal/usage/data/api-keys.md`. ### View @@ -529,7 +529,7 @@ Any new features that do not contain unit tests will not be accepted. ### Open a Pull Request -For starters, you should ensure that you branch is up to date with the `develop` branch. To do that, one can run the following commands: +For starters, you should ensure that your branch is up to date with the `develop` branch. To do that, one can run the following commands: ```bash git fetch upstream @@ -587,7 +587,7 @@ CLI :computer: → `_controller.py` :robot: → `_view.py` :art:  &nbs | **Item** | **Description** | **Example** | | :----------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :----------------------------------------------- | | **CONTEXT** | Specific instrument _world_ to analyse. | `stocks`, `crypto`, `economy` | -| **CATEGORY** | Group of similar COMMANDS to do on the instrument
There are the specialized categories, specific to each CONTEXT and there are common categories which are not specific to one CONTEXT. | `due_diligence`, `technical_analysis`, `insider` | +| **CATEGORY** | Group of similar COMMANDS to do on the instrument
There are specialized categories, specific to each CONTEXT and there are common categories which are not specific to one CONTEXT. | `due_diligence`, `technical_analysis`, `insider` | | **COMMAND** | Operation on one or no instrument that retrieves data in form of string, table or plot. | `rating`, `supplier`, `sentiment` | The following layout is expected: `///` @@ -630,7 +630,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 SDK, but also just generally. + - Why? It increases code readability and acts as an input example for the function's arguments. This increases the ease of use of the functions through the SDK, but also just generally. > Watch out, add default values whenever possible, but take care for not adding mutable default arguments! [More info](https://docs.python-guide.org/writing/gotchas/#mutable-default-arguments) @@ -706,7 +706,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 SDK usage. The SDK 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 without docstrings.
@@ -1404,12 +1404,12 @@ In the `_view.py` files it is common having at the end of each function `export_ Let's go into each of these arguments: - `export` corresponds to the type of file we are exporting. - - If the user doesn't has anything selected, then this function doesn't do anything. + - If the user doesn't have anything selected, then this function doesn't do anything. - The user can export multiple files and even name the files. - The allowed type of files `json,csv,xlsx` for raw data and `jpg,pdf,png,svg` for figures depends on the `export_allowed` variable defined in `parse_known_args_and_warn`. - `os.path.dirname(os.path.abspath(__file__))` corresponds to the directory path - This is important when `export folder` selected is the default because the data gets stored based on where it is called. - - If this is called from a `common` folder, we can use `os.path.dirname(os.path.abspath(__file__)).replace("common", "stocks")` insteaad + - If this is called from a `common` folder, we can use `os.path.dirname(os.path.abspath(__file__)).replace("common", "stocks")` instead - `"pt"` corresponds to the name of the exported file (+ unique datetime) if the user doesn't provide one - `df_analyst_data` corresponds to the dataframe with data. - `sheet_name` corresponds to the name of the sheet in the excel file. @@ -1528,7 +1528,7 @@ class ForexController(BaseController): In case the user is interested in a **DYNAMIC** list of options which changes based on user's state, then a class method must be defined. -The example below shows the an excerpt from `update_runtime_choices` method in the [`options` controller](/openbb_terminal/stocks/options/options_controller.py). +The example below shows an excerpt from `update_runtime_choices` method in the [`options` controller](/openbb_terminal/stocks/options/options_controller.py). ```python def update_runtime_choices(self): @@ -1559,8 +1559,8 @@ This is storing every logged message inside the following location : Where $HOME is the user home directory, for instance: -- `C:\Users\foo` if your are in Windows and your name is foo -- `/home/bar/` if you are is macOS or Linux and your name is bar +- `C:\Users\foo` if you are in Windows and your name is foo +- `/home/bar/` if you are in macOS or Linux and your name is bar The user can override this location using the settings key `OPENBB_USER_DATA_DIRECTORY`. @@ -1615,7 +1615,7 @@ becomes stocks/NEWS: mais recentes notícias da empresa ``` -Note: To speed up translation, the team developed a [script](/i18n/help_translation.ipynb) that uses Google translator API to help translating the entire `en.yml` document to the language of choice. Then the output still needs to be reviewed, but this can be an useful bootstrap. +Note: To speed up translation, the team developed a [script](/i18n/help_translation.ipynb) that uses Google translator API to help translating the entire `en.yml` document to the language of choice. Then the output still needs to be reviewed, but this can be a useful bootstrap. This is the convention in use for creating a new key/value pair: diff --git a/examples/googleColabInstallation.ipynb b/examples/googleColabInstallation.ipynb index 78d3f1532f5e..837b1befc726 100644 --- a/examples/googleColabInstallation.ipynb +++ b/examples/googleColabInstallation.ipynb @@ -1852,7 +1852,7 @@ "cell_type": "code", "source": [ "# The source for the data can be defined by using the `source` argument.\n", - "# Instructions for obtaining and entering API keys are found here: https://docs.openbb.co/sdk/usage/guides/api-keys\n", + "# Instructions for obtaining and entering API keys are found here: https://docs.openbb.co/sdk/usage/api-keys\n", "\n", "balance_sheet_growth = openbb.stocks.fa.balance(symbol, ratios = True).transpose()\n", "\n", @@ -2488,4 +2488,4 @@ ] } ] -} \ No newline at end of file +} diff --git a/openbb_platform/CONTRIBUTING.md b/openbb_platform/CONTRIBUTING.md index 458cd0fd2a5c..9ec74bbaa703 100644 --- a/openbb_platform/CONTRIBUTING.md +++ b/openbb_platform/CONTRIBUTING.md @@ -1,39 +1,79 @@ -- [Quick look into the OpenBB Platform](#quick-look-into-the-openbb-platform) - - [What is the Standardization Framework?](#what-is-the-standardization-framework) - - [Standardization Caveats](#standardization-caveats) - - [Standard QueryParams Example](#standard-queryparams-example) - - [Standard Data Example](#standard-data-example) - - [What is an extension?](#what-is-an-extension) - - [Types of extensions](#types-of-extensions) -- [How to build OpenBB extensions?](#how-to-build-openbb-extensions) - - [Add a custom data source](#add-a-custom-data-source) - - [OpenBB Platform commands](#openbb-platform-commands) - - [QA your extension](#qa-your-extension) - - [Unit tests](#unit-tests) - - [Integration tests](#integration-tests) - - [Import time](#import-time) - - [Sharing your extension](#sharing-your-extension) - - [Publish your extension to PyPI](#publish-your-extension-to-pypi) - - [Setup](#setup) - - [Release](#release) - - [Publish](#publish) -- [How to contribute to the OpenBB Platform?](#how-to-contribute-to-the-openbb-platform) - - [Manage environment and dependencies](#manage-environment-and-dependencies) - - [Add a new data point](#add-a-new-data-point) - - [Identify which type of data you want to add](#identify-which-type-of-data-you-want-to-add) +# Contributing to the OpenBB Platform + + + +- [Contributing to the OpenBB Platform](#contributing-to-the-openbb-platform) + - [Introduction](#introduction) + - [Quick look into the OpenBB Platform](#quick-look-into-the-openbb-platform) + - [What is the Standardization Framework?](#what-is-the-standardization-framework) + - [Standardization Caveats](#standardization-caveats) + - [Standard QueryParams Example](#standard-queryparams-example) + - [Standard Data Example](#standard-data-example) + - [What is an extension?](#what-is-an-extension) + - [Types of extensions](#types-of-extensions) + - [Dependency Management](#dependency-management) + - [High-Level Overview](#high-level-overview) + - [Core Dependency Management](#core-dependency-management) + - [Installation](#installation) + - [Using Poetry](#using-poetry) + - [Core and Extensions](#core-and-extensions) + - [Installation](#installation-1) + - [Dependency Management with Poetry](#dependency-management-with-poetry) + - [Developer Guidelines](#developer-guidelines) + - [Expectations for Developers](#expectations-for-developers) + - [How to build OpenBB extensions?](#how-to-build-openbb-extensions) + - [Building Extensions: Best Practices](#building-extensions-best-practices) + - [How to add a new data point?](#how-to-add-a-new-data-point) + - [Identify which type of data you want to add](#identify-which-type-of-data-you-want-to-add) - [Check if the standard model exists](#check-if-the-standard-model-exists) - - [Create Query Parameters model](#create-query-parameters-model) - - [Create Data Output model](#create-data-output-model) - - [Build the Fetcher](#build-the-fetcher) - - [Make the provider visible](#make-the-provider-visible) - - [Manage extensions](#manage-extensions) - - [Add an extension as a dependency](#add-an-extension-as-a-dependency) - - [How to create a PR?](#how-to-create-a-pr) - - [Install pre-commit hooks](#install-pre-commit-hooks) - - [Branch Naming Conventions](#branch-naming-conventions) - -# Quick look into the OpenBB Platform + - [Create Query Parameters model](#create-query-parameters-model) + - [Create Data Output model](#create-data-output-model) + - [Build the Fetcher](#build-the-fetcher) + - [Make the provider visible](#make-the-provider-visible) + - [How to add custom data sources?](#how-to-add-custom-data-sources) + - [OpenBB Platform commands](#openbb-platform-commands) + - [Architectural considerations](#architectural-considerations) + - [Important classes](#important-classes) + - [Import statements](#import-statements) + - [The TET pattern](#the-tet-pattern) + - [Data processing commands](#data-processing-commands) + - [Python Interface](#python-interface) + - [API Interface](#api-interface) + - [Contributor Guidelines](#contributor-guidelines) + - [Expectations for Contributors](#expectations-for-contributors) + - [Quality Assurance](#quality-assurance) + - [Unit tests](#unit-tests) + - [Integration tests](#integration-tests) + - [Import time](#import-time) + - [Sharing your extension](#sharing-your-extension) + - [Publish your extension to PyPI](#publish-your-extension-to-pypi) + - [Setup](#setup) + - [Release](#release) + - [Publish](#publish) + - [Manage extensions](#manage-extensions) + - [Add an extension as a dependency](#add-an-extension-as-a-dependency) + - [Write code and commit](#write-code-and-commit) + - [How to create a PR?](#how-to-create-a-pr) + - [Branch Naming Conventions](#branch-naming-conventions) + +## Introduction + +This document provides guidelines for contributing to the OpenBB Platform. +Throughout this document, we will be differentiating between two types of contributors: Developers and Contributors. + +1. **Developers**: Those who are building new features or extensions for the OpenBB Platform or leveraging the OpenBB Platform. +2. **Contributors**: Those who contribute to the existing codebase, by opening a [Pull Request](#how-to-create-a-pr) thus giving back to the community. + +**Why is this distinction important?** + +The OpenBB Platform is designed as a foundation for further development. We anticipate a wide range of creative use cases for it. Some use cases may be highly specific or detail-oriented, solving particular problems that may not necessarily fit within the OpenBB Platform Github repository. This is entirely acceptable and even encouraged. This document provides a comprehensive guide on how to build your own extensions, add new data points, and more. + +The **Developer** role, as defined in this document, can be thought of as the foundational role. Developers are those who use the OpenBB Platform as is or build upon it. + +Conversely, the **Contributor** role refers to those who enhance the OpenBB Platform codebase (either by directly adding to the OpenBB Platform or by extending the [extension repository](/openbb_platform/extensions/)). Contributors are willing to go the extra mile, spending additional time on quality assurance, testing, or collaborating with the OpenBB development team to ensure adherence to standards, thereby giving back to the community. + +### Quick look into the OpenBB Platform The OpenBB Platform is built by the Open-Source community and is characterized by its core and extensions. The core handles data integration and standardization, while the extensions enable customization and advanced functionalities. The OpenBB Platform is designed to be used both from a Python interface and a REST API. @@ -75,7 +115,7 @@ Before moving forward, please take a look at the high-level view of the OpenBB P OpenBB Platform High-Level Architecture -## What is the Standardization Framework? +#### What is the Standardization Framework? The Standardization Framework is a set of tools and guidelines that enable the user to query and obtain data in a consistent way across multiple providers. @@ -93,7 +133,7 @@ The standard models are defined under the `/OpenBBTerminal/openbb_platform/platf They define the [`QueryParams`](platform/provider/openbb_provider/abstract/query_params.py) and [`Data`](platform/provider/openbb_provider/abstract/data.py) models, which are used to query and output data. They are pydantic and you can leverage all the pydantic features such as validators. -### Standardization Caveats +##### Standardization Caveats The standardization framework is a very powerful tool, but it has some caveats that you should be aware of: @@ -101,7 +141,7 @@ The standardization framework is a very powerful tool, but it has some caveats t - When mapping the column names from a provider-specific model to the standard model, the CamelCase to snake_case conversion is done automatically. If the column names are not the same, you'll need to manually map them. (e.g. `o` -> `open`) - The standard models are created and maintained by the OpenBB team. If you want to add a new field to a standard model, you'll need to open a PR to the OpenBB Platform. -### Standard QueryParams Example +##### Standard QueryParams Example ```python class StockHistoricalQueryParams(QueryParams): @@ -119,7 +159,7 @@ The `QueryParams` is an abstract class that just tells us that we are dealing wi The OpenBB Platform dynamically knows where the standard models begin in the inheritance tree, so you don't need to worry about it. -### Standard Data Example +##### Standard Data Example ```python class StockHistoricalData(Data): @@ -136,11 +176,11 @@ class StockHistoricalData(Data): The `Data` class is an abstract class that tells us the expected output data. Here we can see a `vwap` field that is `Optional`. This is because not all providers share this field while it is shared between two or more providers. -## What is an extension? +#### What is an extension? An extension adds functionality to the OpenBB Platform. It can be a new data source, a new command, a new visualization, etc. -### Types of extensions +##### Types of extensions We primarily have 3 types of extensions: @@ -152,7 +192,76 @@ If your extension is of high quality and you think that it would be a good commu We encourage independent extensions to be shared with the community by publishing them to PyPI. -# How to build OpenBB extensions? +## Dependency Management + +### High-Level Overview + +- **Provider**: The base package with no dependencies on other `openbb` packages. +- **Core**: Depends on the Provider and serves as the main infrastructural package. +- **Extensions**: Utility packages that leverage Core's infrastructure. Each extension is its own package. +- **Providers**: Utility packages extending functionality to different providers, where each provider is its own package. + +### Core Dependency Management + +#### Installation + +- **pip**: `pip install -e OpenBBTerminal/openbb_platform/platform/core` +- **poetry**: `poetry install OpenBBTerminal/openbb_platform/platform/core` + +#### Using Poetry + +Ensure you're in a fresh conda environment before adjusting dependencies. + +- **Add a Dependency**: `poetry add ` +- **Update Dependencies**: + - All: `poetry update` + - Specific: `poetry update ` +- **Remove a Dependency**: `poetry remove ` + +### Core and Extensions + +#### Installation + +For development setup, use the provided script to install all extensions and their dependencies: + +- `python dev_install.py [-e|--extras]` + +> **Note**: If developing an extension, avoid installing all extensions to prevent unnecessary overhead. + +#### Dependency Management with Poetry + +- **Add Platform Extension**: `poetry add openbb-extension-name [--dev]` +- **Resolve Conflicts**: Adjust versions in `pyproject.toml` if notified by Poetry. +- **Lock Dependencies**: `poetry lock` +- **Update Platform**: `poetry update openbb-platform` +- **Documentation**: Maintain `pyproject.toml` and `poetry.lock` for a clear record of dependencies. + +## Developer Guidelines + +### Expectations for Developers + +1. Use Cases: + - Ensure that your extensions or features align with the broader goals of the application. + - Understand that the OpenBB Platform is designed to be foundational; build in a way that complements and doesn't conflict with its core functionalities. + +2. Documentation: + - Provide clear and comprehensive documentation for any new feature or extension you develop. + +3. Code Quality: + - Adhere to the coding standards and conventions of the OpenBB Platform. + - Ensure your code is maintainable, well-organized, and commented where necessary. + +4. Testing: + - Thoroughly test any new feature or extension to ensure it works as expected. + +5. Performance: + - Ensure that your extensions or features do not adversely affect the performance of the OpenBB Platform. + - Optimize for scalability, especially if you anticipate high demand for your feature. + +6. Collaboration: + - Engage with the OpenBB community to gather feedback on your developments. + +### How to build OpenBB extensions? We have a Cookiecutter template that will help you get started. It serves as a jumpstart for your extension development, so you can focus on the data and not on the boilerplate. @@ -169,7 +278,145 @@ The high level steps are: - QA your extension - Share your extension with the community -## Add a custom data source +### Building Extensions: Best Practices + +1. **Review Platform Dependencies**: Before adding any dependency, ensure it aligns with the Platform's existing dependencies. +2. **Use Loose Versioning**: If possible, specify a range to maintain compatibility. E.g., `>=1.4,<1.5`. +3. **Testing**: Test your extension with the Platform's core to avoid conflicts. Both unit and integration tests are recommended. +4. **Document Dependencies**: Use `pyproject.toml` and `poetry.lock` for clear, up-to-date records. + +### How to add a new data point? + +In this section, we'll be adding a new data point to the OpenBB Platform. We will add a new provider with an existing [standard data](platform/provider/openbb_provider/standard_models) model. + +#### Identify which type of data you want to add + +In this example, we'll be adding OHLC stock data that is used by the `obb.stocks.load` command. + +Note that, if no command exists for your data, we need to add one under the right router. +Each router is categorized under different extensions (stocks, forex, crypto, etc.). + +#### Check if the standard model exists + +Given the fact that there's already an endpoint for OHLCV stock data, we can check if the standard exists. + +In this case, it's `StockHistorical` which can be found inside the `/OpenBBTerminal/openbb_platform/platform/core/provider/openbb_provider/standard_models/` directory. + +If the standard model doesn't exist: + +- you won't need to inherit from it in the next steps. +- all your provider query parameters will be under the `**kwargs` in the python interface. +- it might not work out-of-the box with other extensions that follow standardization e.g. the `charting` extension + +##### Create Query Parameters model + +Query Parameters are the parameters that are passed to the API endpoint in order to make the request. + +For the `StockHistorical` example, this would look like the following: + +```python + +class StockHistoricalQueryParams(StockHistoricalQueryParams): + """ Stock Historical Query. + + Source: https://www..co/documentation/ + """ + + # provider specific query parameters if any + +``` + +##### Create Data Output model + +The data output is the data that is returned by the API endpoint. +For the `StockHistorical` example, this would look like the following: + +```python + +class StockHistoricalData(StockHistoricalData): + """ Stock End of Day Data. + + Source: https://www..co/documentation/ + """ + + # provider specific data output fields if any + +``` + +> Note that, since `StockHistoricalData` inherits from pydantic's `BaseModel`, we can leverage validators to perform additional checks on the output model. A very good example of this, would be to transform a string date into a datetime object. + +##### Build the Fetcher + +The `Fetcher` class is responsible for making the request to the API endpoint and providing the output. + +It will receive the Query Parameters, and it will return the output while leveraging the pydantic model schemas. + +For the `StockHistorical` example, this would look like the following: + +```python +class StockHistoricalFetcher( + Fetcher[ + StockHistoricalQueryParams, + List[StockHistoricalData], + ] +): + """Transform the query, extract and transform the data.""" + + @staticmethod + def transform_query(params: Dict[str, Any]) -> StockHistoricalQueryParams: + """Transform the query parameters.""" + + return StockHistoricalQueryParams(**transformed_params) + + @staticmethod + def extract_data( + query: StockHistoricalQueryParams, + credentials: Optional[Dict[str, str]], + **kwargs: Any, + ) -> dict: + """Return the raw data from the endpoint.""" + + obtained_data = my_request(query, credentials, **kwargs) + + return obtained_data + + @staticmethod + def transform_data( + data: dict, + ) -> List[StockHistoricalData]: + """Transform the data to the standard format.""" + + return [StockHistoricalData.model_validate(d) for d in data] +``` + +> Make sure that you're following the TET pattern when building a `Fetcher` - **Transform, Extract, Transform**. See more on this [here](#the-tet-pattern). + +#### Make the provider visible + +In order to make the new provider visible to the OpenBB Platform, you'll need to add it to the `__init__.py` file of the `providers//openbb_/` folder. + +```python +""" Provider module.""" +from openbb_provider.abstract.provider import Provider + +from openbb_.models.stock_eod import StockHistoricalFetcher + +_provider = Provider( + name="", + website="", + description="Provider description goes here", + required_credentials=["api_key"], + fetcher_dict={ + "StockHistorical": StockHistoricalFetcher, + }, +) +``` + +If the provider does not require any credentials, you can remove that parameter. On the other hand, if it requires more than 2 items to authenticate, you can add a list of all the required items to the `required_credentials` list. + +After running `pip install .` on `openbb_platform/providers/` your provider should be ready for usage, both from the Python interface and the API. + +### How to add custom data sources? You will get your data either from a CSV file, local database or from an API endpoint. @@ -201,7 +448,7 @@ Any command, that uses the `Fetcher` class you've just defined, will be calling If you're not sure what's a command and why is it even using the `Fetcher` class, follow along! -### OpenBB Platform commands +#### OpenBB Platform commands The OpenBB Platform will enable you to query and output your data in a very simple way. @@ -239,15 +486,203 @@ Let's break it down: You only need to change the `model` parameter to the name of the `Fetcher` dictionary key and everything else will be handled by the OpenBB Platform. -## QA your extension +### Architectural considerations + +#### Important classes + +#### Import statements + +```python + +# The `Data` class +from openbb_provider.abstract.data import Data + +# The `QueryParams` class +from openbb_provider.abstract.query_params import QueryParams + +# The `Fetcher` class +from openbb_provider.abstract.fetcher import Fetcher + +# The `OBBject` class +from openbb_core.app.model.obbject import OBBject + +# The `Router` class +from openbb_core.app.router import Router + +``` + +#### The TET pattern + +The TET pattern is a pattern that we use to build the `Fetcher` classes. It stands for **Transform, Extract, Transform**. +As the OpenBB Platform has its own standardization framework and the data fetcher are a very important part of it, we need to ensure that the data is transformed and extracted in a consistent way, to help us do that, we came up with the **TET** pattern, which helps us build and ship faster as we have a clear structure on how to build the `Fetcher` classes. + +1. Transform - `transform_query(params: Dict[str, Any])`: transforms the query parameters. Given a `params` dictionary this method should return the transformed query parameters as a [`QueryParams`](openbb_platform/platform/provider/openbb_provider/abstract/query_params.py) child so that we can leverage the pydantic model schemas and validation into the next step. This might also be the place do perform some transformations on any given parameter, i.e., if you want to transform an empty date into a `datetime.now().date()`. +2. Extract - `extract_data(query: ExampleQueryParams,credentials: Optional[Dict[str, str]],**kwargs: Any,) -> Dict`: makes the request to the API endpoint and returns the raw data. Given the transformed query parameters, the credentials and any other extra arguments, this method should return the raw data as a dictionary. +3. Transform - `transform_data(query: ExampleQueryParams, data: Dict, **kwargs: Any) -> List[ExampleHistoricalData]`: transforms the raw data into the defined data model. Given the transformed query parameters (might be useful for some filtering), the raw data and any other extra arguments, this method should return the transformed data as a list of [`Data`](openbb_platform/platform/provider/openbb_provider/abstract/data.py) children. + +#### Data processing commands + +The data processing commands are commands that are used to process the data that may or may not come from the OpenBB Platform. +In order to create a data processing framework general enough to be used by any extension, we've created a special abstract class called [`Data`](/openbb_platform/platform/provider/openbb_provider/abstract/data.py) which **all** standardized (and consequently its child classes) will inherit from. + +Why is this important? +So that we can ensure that all `OBBject.results` will share a common ground on which we can apply out-of-the-box data processing commands, such as the `ta`, `qa` or the `econometrics` menus. + +But what's really the `Data` class? +It's a pydantic model that inherits from the `BaseModel` and can contain any given number of extra fields. In practice, it looks as follows: + +```python + +>>> res = obb.stocks.load("AAPL") +>>> res.results[0] + +AVStockHistoricalData(date=2023-11-03 00:00:00, open=174.24, high=176.82, low=173.35, close=176.65, volume=79829246.0, vwap=None, adj_close=None, dividend_amount=None, split_coefficient=None) + +``` + +> The `AVStockHistoricalData` class, is a child class of the `Data` class. + +Note how we've indexed to get only the first element of the `results` list (which represents a single row, if we want to think about it as a tabular output). This simply means that we are getting a `List` of `AVStockHistoricalData` from the `obb.stocks.load` command. Or, we can also say that that's equivalent to `List[Data]`! + +This is very powerful, as we can now apply any data processing command to the `results` list, without worrying about the underlying data structure. +That's why, on data processing commands (such as the `ta` menu) we will find on its function signature the following: + +```python + +def ema( + self, + data: Union[List[Data], pandas.DataFrame], + target: str = "close", + index: str = "date", + length: int = 50, + offset: int = 0, + chart: bool = False, + ) -> OBBject[List[Data]]: + + ... + +``` + +> Note that `data` can actually be a different type, but we'll focus on the `List[Data]` case for now. + +Does that mean that I can only use the data processing commands if I instantiate a class that inherits from `Data`? +Not at all! Consider the following example: + +```python + +>>> from openbb_provider.abstract.data import Data +>>> my_data_item_1 = {"open": 1, "high": 2, "low": 3, "close": 4, "volume": 5, "date": "2020-01-01"} +>>> my_data_item_1_as_data = Data.model_validate(my_data_item_1) +>>> my_data_item_1_as_data + +Data(open=1, high=2, low=3, close=4, volume=5, date=2020-01-01) -We are strong believers in the QA process and we want to make sure that all the extensions that are added to the OpenBB Platform are of high quality. To ensure this, we have a set of QA tools that you can use to test your extension. +``` + +This means that the `Data` class is cleaver enough to understand that you are passing a dictionary and it will try to validate it for you. +In other words, if you're using data that doesn't come from the OpenBBPlatform, you only need to ensure it's parsable by the `Data` class and you'll be able to use the data processing commands. +In other words, imagine you have a dataframe that you want to use with the `ta` menu. You can do the following: + +```python + +>>> res = obb.stocks.load("AAPL") +>>> my_df = res.to_dataframe() # yes, you can convert your OBBject.results into a dataframe out-of-the-box! +>>> my_records = df.to_dict(orient="records") + +>>> obb.ta.ema(data=my_record) + +OBBject + +results: [{'close': 77.62, 'close_EMA_50': None}, {'close': 80.25, 'close_EMA_50': ... # this is a `List[Data]` yet again + +``` + +> Note that that for this example we've used the `OBBject.to_dataframe()` method to have an example dataframe, but it could be any other dataframe that you have. + +##### Python Interface + +When using the OpenBB Platform on a Python Interface, docstrings and type hints are your best friends as it provides plenty of context on how to use the commands. +Looking at an example on the `ta` menu: + +```python + +def ema( + self, + data: Union[List[Data], pandas.DataFrame], + target: str = "close", + index: str = "date", + length: int = 50, + offset: int = 0, + chart: bool = False, + ) -> OBBject[List[Data]]: + + ... + +``` + +We can easily deduct that the `ema` command accept data in the formats of `List[Data]` or `pandas.DataFrame`. + +> Note that other types might be added in the future. + +##### API Interface + +When using the OpenBB Platform on a API Interface, the types are a bit more limited than on the Python one, as, for example, we can't use `pandas.DataFrame` as a type. However the same principles apply for what `Data` means, i.e., any given data processing command, which are characterized as POST endpoints on the API, will accept data as a list of records on the **request body**, i.e.: + +```json + +[ + { + "open": 80, + "high": 80.69, + "low": 77.37, + "close": 77.62, + "volume": 2487300 + } + ... +] + +``` + +## Contributor Guidelines + +The Contributor Guidelines are intended to be a continuation of the [Developer Guidelines](#developer-guidelines). They are not a replacement, but rather an expansion, focusing specifically on those who seek to directly enhance the OpenBB Platform's codebase. It's crucial for Contributors to be familiar with both sets of guidelines to ensure a harmonious and productive engagement with the OpenBB Platform. + +There are many ways to contribute to the OpenBB Platform. You can add a [new data point](#how-to-add-a-new-data-point), add a [new command](#openbb-platform-commands), add a [new visualization](/openbb_platform/extensions/charting/README.md), add a [new extension](#how-to-build-openbb-extensions), fix a bug, improve or create documentation, etc. + +### Expectations for Contributors + +1. Use Cases: + - Ensure that your contributions directly enhance the OpenBB Platform's functionality or extension ecosystem. + +2. Documentation: + - All code contributions should come with relevant documentation, including the purpose of the contribution, how it works, and any changes it makes to existing functionalities. + - Update any existing documentation if your contribution alters the behavior of the OpenBB Platform. + +3. Code Quality: + - Your code should adhere strictly to the OpenBB Platform's coding standards and conventions. + - Ensure clarity, maintainability, and proper organization in your code. + +4. Testing: + - All contributions must be thoroughly tested to avoid introducing bugs to the OpenBB Platform. + - Contributions should include relevant automated tests (unit and integration), and any new feature should come with its test cases. + +5. Performance: + - Your contributions should be optimized for performance and should not degrade the overall efficiency of the OpenBB Platform. + - Address any potential bottlenecks and ensure scalability. + +6. Collaboration: + - Engage actively with the OpenBB development team to ensure that your contributions align with the platform's roadmap and standards. + - Welcome feedback and be open to making revisions based on reviews and suggestions from the community. + +### Quality Assurance + +We are strong believers in the Quality Assurance (QA) process and we want to make sure that all the extensions that are added to the OpenBB Platform are of high quality. To ensure this, we have a set of QA tools that you can use to test your extension. Primarily, we have tools that semi-automate the creation of unit and integration tests. > The QA tools are still in development and we are constantly improving them. -### Unit tests +#### Unit tests Each `Fetcher` comes equipped with a `test` method that will ensure that it is implemented correctly and that it is returning the expected data. It also ensures that all types are correct and that the data is valid. @@ -270,7 +705,7 @@ pytest --record=all > Note that sometimes manual intervention is needed. For example, adjusting out-of-top level imports or adding specific arguments for a given fetcher. -### Integration tests +#### Integration tests The integration tests are a bit more complex than the unit tests, as we want to test both the Python interface and the API interface. For this, we have two scripts that will help you generate the integration tests. @@ -314,7 +749,7 @@ pytest openbb_platform -m integration pytest openbb_platform ``` -### Import time +#### Import time We aim to have a short import time for the package. To measure that we use `tuna`. @@ -329,15 +764,15 @@ python -X importtime openbb/__init__.py 2> import.log tuna import.log ``` -## Sharing your extension +### Sharing your extension We encourage you to share your extension with the community. You can do that by publishing it to PyPI. -### Publish your extension to PyPI +#### Publish your extension to PyPI To publish your extension to PyPI, you'll need to have a PyPI account and a PyPI API token. -#### Setup +##### Setup Create an account and get an API token from Store the token with @@ -346,7 +781,7 @@ Store the token with poetry config pypi-token.pypi pypi-YYYYYYYY ``` -#### Release +##### Release `cd` into the directory where your extension `pyproject.toml` lives and make sure that the `pyproject.toml` specifies the version tag you want to release and run. @@ -362,7 +797,7 @@ If you want to test your package locally you can do it with pip install dist/openbb_[FILE_NAME].whl ``` -#### Publish +##### Publish To publish your package to PyPI run: @@ -376,200 +811,7 @@ Now, you can pip install your package from PyPI with: pip install openbb-some_ext ``` -# How to contribute to the OpenBB Platform? - -There are many ways to contribute to the OpenBB Platform. You can add a new data point, add a new command, add a new visualization, add a new extension, fix a bug etc. - -In this document, we'll be focusing on adding a new data point to the OpenBB Platform. - -## Manage environment and dependencies - -In order to contribute to the OpenBB Platform, you need to setup your environment to ensure a smooth development experience. - -
-Need help setting up Miniconda or Git? - -Sometimes, installing Miniconda or Git can be a bit tricky, so we've prepared a set of instructions to help you get started. - -Please refer to [OpenBBTerminal docs](https://docs.openbb.co/terminal/installation/source) for more information. -
- -1. Clone the repository: - - ```bash - git clone git@github.com:OpenBB-finance/OpenBBTerminal.git - ``` - -2. Create and activate a virtual environment: - - ```bash - conda create -n "obb-dev" python=3.9.13 - conda activate obb-dev - ``` - - > Supported python versions: python = ">=3.8,<3.12" - -3. Manage your environment with [Poetry](https://python-poetry.org/): - - ```bash - pip install poetry - ``` - -4. Install the packages using the `dev_install.py` script located in the `openbb_platform` folder: - - ```bash - python dev_install.py - ``` - - > To install all the packages, including extras, use the `-e` argument with the above script. - -5. Setup your API keys locally by adding them to the `~/.openbb_platform/user_settings.json` file. Populate this file with the following template and replace the values with your keys: - - ```json - { - "credentials": { - "fmp_api_key": "REPLACE_ME", - "polygon_api_key": "REPLACE_ME", - "benzinga_api_key": "REPLACE_ME", - "fred_api_key": "REPLACE_ME" - } - } - ``` - - > You can also setup and use your keys from the OpenBB Hub and the Python interface at runtime. Follow the steps in [API Keys](./README.md#api-keys) section to know more about it. - -## Add a new data point - -In this section, we'll be adding a new data point to the OpenBB Platform. We will add a new provider with an existing [standard data](platform/provider/openbb_provider/standard_models) model. - -### Identify which type of data you want to add - -In this example, we'll be adding OHLC stock data that is used by the `obb.stocks.load` command. - -Note that, if no command exists for your data, we need to add one under the right router. -Each router is categorized under different extensions (stocks, forex, crypto, etc.). - -#### Check if the standard model exists - -Given the fact that there's already an endpoint for OHLCV stock data, we can check if the standard exists. - -In this case, it's `StockHistorical` which can be found inside the `/OpenBBTerminal/openbb_platform/platform/core/provider/openbb_provider/standard_models/` directory. - -If the standard model doesn't exist: - -- you won't need to inherit from it in the next steps. -- all your provider query parameters will be under the `**kwargs` in the python interface. -- it might not work out-of-the box with other extensions that follow standardization e.g. the `charting` extension - -#### Create Query Parameters model - -Query Parameters are the parameters that are passed to the API endpoint in order to make the request. - -For the `StockHistorical` example, this would look like the following: - -```python - -class StockHistoricalQueryParams(StockHistoricalQueryParams): - """ Stock Historical Query. - - Source: https://www..co/documentation/ - """ - - # provider specific query parameters if any - -``` - -#### Create Data Output model - -The data output is the data that is returned by the API endpoint. -For the `StockHistorical` example, this would look like the following: - -```python - -class StockHistoricalData(StockHistoricalData): - """ Stock End of Day Data. - - Source: https://www..co/documentation/ - """ - - # provider specific data output fields if any - -``` - -> Note that, since `StockHistoricalData` inherits from pydantic's `BaseModel`, we can leverage validators to perform additional checks on the output model. A very good example of this, would be to transform a string date into a datetime object. - -#### Build the Fetcher - -The `Fetcher` class is responsible for making the request to the API endpoint and providing the output. - -It will receive the Query Parameters, and it will return the output while leveraging the pydantic model schemas. - -For the `StockHistorical` example, this would look like the following: - -```python -class StockHistoricalFetcher( - Fetcher[ - StockHistoricalQueryParams, - List[StockHistoricalData], - ] -): - """Transform the query, extract and transform the data.""" - - @staticmethod - def transform_query(params: Dict[str, Any]) -> StockHistoricalQueryParams: - """Transform the query parameters.""" - - return StockHistoricalQueryParams(**transformed_params) - - @staticmethod - def extract_data( - query: StockHistoricalQueryParams, - credentials: Optional[Dict[str, str]], - **kwargs: Any, - ) -> dict: - """Return the raw data from the endpoint.""" - - obtained_data = my_request(query, credentials, **kwargs) - - return obtained_data - - @staticmethod - def transform_data( - data: dict, - ) -> List[StockHistoricalData]: - """Transform the data to the standard format.""" - - return [StockHistoricalData.model_validate(d) for d in data] -``` - -> Make sure that you're following the TET pattern when building a `Fetcher` - **Transform, Extract, Transform**. - -### Make the provider visible - -In order to make the new provider visible to the OpenBB Platform, you'll need to add it to the `__init__.py` file of the `providers//openbb_/` folder. - -```python -""" Provider module.""" -from openbb_provider.abstract.provider import Provider - -from openbb_.models.stock_eod import StockHistoricalFetcher - -_provider = Provider( - name="", - website="", - description="Provider description goes here", - required_credentials=["api_key"], - fetcher_dict={ - "StockHistorical": StockHistoricalFetcher, - }, -) -``` - -If the provider does not require any credentials, you can remove that parameter. On the other hand, if it requires more than 2 items to authenticate, you can add a list of all the required items to the `required_credentials` list. - -After running `pip install .` on `openbb_platform/providers/` your provider should be ready for usage, both from the Python interface and the API. - -## Manage extensions +### Manage extensions To install an extension hosted on PyPI, use the `pip install ` command. @@ -587,7 +829,7 @@ openbb-extension = { path = "", develop = true } Now you can use the `python dev_install.py [-e]` command to install the local extension. -### Add an extension as a dependency +#### Add an extension as a dependency To add the `openbb-qa` extension as a dependency, you'll need to add it to the `pyproject.toml` file: @@ -598,7 +840,9 @@ openbb-qa = "^0.0.0a2" Then you can follow the same process as above to install the extension. -## How to create a PR? +### Write code and commit + +#### How to create a PR? To create a PR to the OpenBB Platform, you'll need to fork the repository and create a new branch. @@ -612,11 +856,7 @@ To create a PR to the OpenBB Platform, you'll need to fork the repository and cr these get linked. Note: If you installed pre-commit hooks and one of the formatters re-formats your code, you'll need to go back to step 3 to add these. -### Install pre-commit hooks - -To install pre-commit hooks, run `pre-commit install` in the root of the repository. - -### Branch Naming Conventions +##### Branch Naming Conventions The accepted branch naming conventions are: diff --git a/openbb_platform/platform/core/README.md b/openbb_platform/platform/core/README.md index b687d23fa531..0c3fe087e407 100644 --- a/openbb_platform/platform/core/README.md +++ b/openbb_platform/platform/core/README.md @@ -18,6 +18,7 @@ - [4.1.2. Utilities](#412-utilities) - [User settings](#user-settings) - [Preferences](#preferences) + - [Notes on preferences](#notes-on-preferences) - [System settings](#system-settings) - [Coverage](#coverage) - [4.1.3. OpenBB Hub Account](#413-openbb-hub-account) @@ -209,7 +210,7 @@ date } ``` -- `show`: displays `chart.content` to a chart +- `show`: displays the figure ```python >>> output.show() @@ -217,22 +218,13 @@ date # Python Interpreter: opens a PyWry window with the chart ``` -- `to_plotly_json`: proxy to `chart.content` +- `to_chart`: create or update the chart and returns the figure ```python ->>> output.to_plotly_json() -{ - 'data':[ - { - 'close': [260.02, 262.9, 291.26], - 'decreasing': {'line': {'width': 1.1}}, - 'high': [268.0, 280.93, 299.29], - 'increasing': {'line': {'width': 1.1}}, - ... - } - ... - ] -} +>>> fig = output.to_chart() +>>> fig = type(fig) + +openbb_charting.core.openbb_figure.OpenBBFigure ``` #### Extensions @@ -315,21 +307,27 @@ Here is an example of how your `user_settings.json` file can look like: These are the available preferences and respective descriptions: -|Preference |Default |Description | -|---------------------|--------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -|data_directory |/home/OpenBBUserData |When launching the application for the first time this directory will be created. It serves as the default location where the application stores usage artifacts such as logs and exports. | -|export_directory |/home/OpenBBUserData/exports |The OpenBB Charting Extension provides the capability to export images in various formats. This is the directory where it attempts to save such exports. | -|user_styles_directory|/home/OpenBBUserData/styles/user|The OpenBB Charting Extension supports custom stylization. This directory is the location where it looks for user-defined styles. If no user styles are found in this directory the application will proceed with the default styles. | -|charting_extension |openbb_charting |Name of the charting extension to be used with the application. | -|chart_style |dark |The default color style to use with the OpenBB Charting Extension plots. Options include "dark" and "light". | -|plot_enable_pywry |True |Whether the application should enable PyWry. If PyWry is disabled the image will open in your default browser otherwise it will be displayed within your editor or in a separate PyWry window. | -|plot_pywry_width |1400 |PyWry window width. | -|plot_pywry_height |762 |PyWry window height. | -|plot_open_export |False |Controls whether the "Save As" window should pop up as soon as the image is displayed. | -|table_style |dark |The default color style to use with the OpenBB Charting Extension tables. Options are "dark" and "light". | -|request_timeout |15 |Specifies the timeout duration for HTTP requests. | -|metadata |True |Enables or disables the collection of metadata which provides information about operations including arguments duration route and timestamp. Disabling this feature may improve performance in cases where contextual information is not needed or when the additional computation time and storage space are a concern.| -|output_type |OBBject |Specifies the type of data the application will output when a command or endpoint is accessed. Note that choosing data formats only available in Python such as `dataframe`, `numpy` or `polars` will render the application's API non-functional. | +| **Preference** | **Default** | **Options** | **Description** | **** | **** | **** | **** | **** | **** | +|-----------------------|----------------------------------|------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------|-----------|----------|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------| +| data_directory | /home/OpenBBUserData | Any path. | When launching the application for the first time this directory will be created. It serves as the default location where the application stores usage artifacts such as logs and exports. | | | | | | | +| export_directory | /home/OpenBBUserData/exports | Any path. | The OpenBB Charting Extension provides the capability to export images in various formats. This is the directory where it attempts to save such exports. | | | | | | | +| user_styles_directory | /home/OpenBBUserData/styles/user | Any path. | The OpenBB Charting Extension supports custom stylization. This directory is the location where it looks for user-defined styles. If no user styles are found in this directory the application will proceed with the default styles. | | | | | | | +| charting_extension | openbb_charting | ["openbb_charting"] | Name of the charting extension to be used with the application. | | | | | | | +| chart_style | dark | ["dark", "light"]" | "The default color style to use with the OpenBB Charting Extension plots. Options include "dark" and "light"." | | | | | | +| plot_enable_pywry | True | [True, False] | Whether the application should enable PyWry. If PyWry is disabled the image will open in your default browser otherwise it will be displayed within your editor or in a separate PyWry window. | | | | | | | +| plot_pywry_width | 1400 | Any positive integer. | PyWry window width. | | | | | | | +| plot_pywry_height | 762 | Any positive integer. | PyWry window height. | | | | | | | +| plot_open_export | False | [True, False] | "Controls whether the ""Save As"" window should pop up as soon as the image is displayed." | | | | | | | +| table_style | dark | ["dark", "light"]" | "The default color style to use with the OpenBB Charting Extension tables. Options are ""dark"" and ""light""." | | | | | | +| request_timeout | 15 | Any positive integer. | Specifies the timeout duration for HTTP requests. | | | | | | | +| metadata | True | [True, False] | Enables or disables the collection of metadata which provides information about operations including arguments duration route and timestamp. Disabling this feature may improve performance in cases where contextual information is not needed or when the additional computation time and storage space are a concern. | | | | | | | +| output_type | OBBject | ["OBBject", "numpy", "dict", "chart"] | Specifies the type of data the application will output when a command or endpoint is accessed. Note that choosing data formats only available in Python such as `dataframe` | `numpy` or `polars` will render the application's API non-functional. | + +##### Notes on preferences + +- If you don't have a `OpenBBUserData` folder in your home directory, the application will create one for you the first time you run it. The user preferences related with paths all default to this folder, be it exports, styles or data - this can be changed at any time to fit your needs. +- The `OpenBBUserData` will still be created even if you don't have your preferences pointing to it, this is because the application needs a place to store logs and other artifacts. +- One way of exporting files or images on the OpenBB Platform is to leverage that functionality on the OpenBB Charting Extension. The `export_directory` preference is the location where the extension will attempt to save such exports. #### System settings diff --git a/openbb_terminal/econometrics/econometrics_controller.py b/openbb_terminal/econometrics/econometrics_controller.py index e4c6ff9ba968..315deaccb447 100644 --- a/openbb_terminal/econometrics/econometrics_controller.py +++ b/openbb_terminal/econometrics/econometrics_controller.py @@ -458,7 +458,15 @@ def call_export(self, other_args: List[str]): type=str, ) - parser.add_argument( + export_group = parser.add_mutually_exclusive_group(required=False) + export_group.add_argument( + "-f", + "--file", + dest="file", + help="The name of the file you wish to export to", + type=str, + ) + export_group.add_argument( "-t", "--type", help="The file type you wish to export to", @@ -471,7 +479,7 @@ def call_export(self, other_args: List[str]): if other_args and "-" not in other_args[0][0]: other_args.insert(0, "-n") ns_parser = self.parse_known_args_and_warn( - parser, other_args, export_allowed=NO_EXPORT + parser, other_args, export_allowed=EXPORT_ONLY_RAW_DATA_ALLOWED ) if ns_parser: @@ -479,10 +487,13 @@ def call_export(self, other_args: List[str]): console.print("Please enter a valid dataset.") else: export_data( - ns_parser.type, + ns_parser.file if ns_parser.file else ns_parser.type, os.path.dirname(os.path.abspath(__file__)), ns_parser.name, self.datasets[ns_parser.name], + sheet_name=" ".join(ns_parser.sheet_name) + if ns_parser.sheet_name + else None, ) console.print() diff --git a/openbb_terminal/miscellaneous/documentation_scripts/documentation_commands.csv b/openbb_terminal/miscellaneous/documentation_scripts/documentation_commands.csv index 88e124ea2c61..e8571cb2702a 100644 --- a/openbb_terminal/miscellaneous/documentation_scripts/documentation_commands.csv +++ b/openbb_terminal/miscellaneous/documentation_scripts/documentation_commands.csv @@ -127,23 +127,23 @@ website/content/sdk/usage/basics/index.md,etf website/content/sdk/usage/basics/index.md,holdings website/content/sdk/usage/basics/index.md,dd website/content/sdk/usage/basics/index.md,all -website/content/sdk/usage/guides/api-keys.md,from -website/content/sdk/usage/guides/api-keys.md,global -website/content/sdk/usage/guides/api-keys.md,account -website/content/sdk/usage/guides/api-keys.md,fred -website/content/sdk/usage/guides/api-keys.md,degiro -website/content/sdk/usage/guides/api-keys.md,oanda -website/content/sdk/usage/guides/api-keys.md,change -website/content/sdk/usage/guides/api-keys.md,fmp -website/content/sdk/usage/guides/api-keys.md,mykeys -website/content/sdk/usage/guides/api-keys.md,to -website/content/sdk/usage/guides/api-keys.md,set -website/content/sdk/usage/guides/api-keys.md,news -website/content/sdk/usage/guides/api-keys.md,not defined -website/content/sdk/usage/guides/api-keys.md,keys -website/content/sdk/usage/guides/api-keys.md,stocks -website/content/sdk/usage/guides/api-keys.md,quote -website/content/sdk/usage/guides/api-keys.md,show +website/content/sdk/usage/api-keys.md,from +website/content/sdk/usage/api-keys.md,global +website/content/sdk/usage/api-keys.md,account +website/content/sdk/usage/api-keys.md,fred +website/content/sdk/usage/api-keys.md,degiro +website/content/sdk/usage/api-keys.md,oanda +website/content/sdk/usage/api-keys.md,change +website/content/sdk/usage/api-keys.md,fmp +website/content/sdk/usage/api-keys.md,mykeys +website/content/sdk/usage/api-keys.md,to +website/content/sdk/usage/api-keys.md,set +website/content/sdk/usage/api-keys.md,news +website/content/sdk/usage/api-keys.md,not defined +website/content/sdk/usage/api-keys.md,keys +website/content/sdk/usage/api-keys.md,stocks +website/content/sdk/usage/api-keys.md,quote +website/content/sdk/usage/api-keys.md,show website/content/sdk/usage/guides/changing-sources.md,stocks website/content/sdk/usage/guides/changing-sources.md,source website/content/sdk/usage/guides/changing-sources.md,load @@ -300,18 +300,18 @@ website/content/terminal/usage/basics/index.md,export website/content/terminal/usage/basics/index.md,file website/content/terminal/usage/basics/index.md,load website/content/terminal/usage/basics/index.md,raw -website/content/terminal/usage/guides/api-keys.md,options -website/content/terminal/usage/guides/api-keys.md,fa -website/content/terminal/usage/guides/api-keys.md,keys -website/content/terminal/usage/guides/api-keys.md,stocks -website/content/terminal/usage/guides/api-keys.md,not defined -website/content/terminal/usage/guides/api-keys.md,show -website/content/terminal/usage/guides/api-keys.md,fred -website/content/terminal/usage/guides/api-keys.md,oanda -website/content/terminal/usage/guides/api-keys.md,news -website/content/terminal/usage/guides/api-keys.md,degiro -website/content/terminal/usage/guides/api-keys.md,fmp -website/content/terminal/usage/guides/api-keys.md,mykeys +website/content/terminal/usage/data/api-keys.md,options +website/content/terminal/usage/data/api-keys.md,fa +website/content/terminal/usage/data/api-keys.md,keys +website/content/terminal/usage/data/api-keys.md,stocks +website/content/terminal/usage/data/api-keys.md,not defined +website/content/terminal/usage/data/api-keys.md,show +website/content/terminal/usage/data/api-keys.md,fred +website/content/terminal/usage/data/api-keys.md,oanda +website/content/terminal/usage/data/api-keys.md,news +website/content/terminal/usage/data/api-keys.md,degiro +website/content/terminal/usage/data/api-keys.md,fmp +website/content/terminal/usage/data/api-keys.md,mykeys website/content/terminal/usage/guides/changing-sources.md,save website/content/terminal/usage/guides/changing-sources.md,raw website/content/terminal/usage/guides/changing-sources.md,ticker diff --git a/openbb_terminal/miscellaneous/documentation_scripts/documentation_commands.json b/openbb_terminal/miscellaneous/documentation_scripts/documentation_commands.json index e373be2e8097..35951a6867ba 100644 --- a/openbb_terminal/miscellaneous/documentation_scripts/documentation_commands.json +++ b/openbb_terminal/miscellaneous/documentation_scripts/documentation_commands.json @@ -7,8 +7,8 @@ ], "news": [ "CONTRIBUTING.md", - "website/content/terminal/usage/guides/api-keys.md", - "website/content/sdk/usage/guides/api-keys.md" + "website/content/terminal/usage/data/api-keys.md", + "website/content/sdk/usage/api-keys.md" ], "show": [ "CONTRIBUTING.md", @@ -16,11 +16,11 @@ "website/content/terminal/usage/basics/index.md", "website/content/terminal/usage/guides/scripts-and-routines.md", "website/content/terminal/usage/guides/changing-sources.md", - "website/content/terminal/usage/guides/api-keys.md", + "website/content/terminal/usage/data/api-keys.md", "website/content/terminal/usage/intros/econometrics.md", "website/content/terminal/usage/intros/economy.md", "website/content/terminal/usage/intros/forecast.md", - "website/content/sdk/usage/guides/api-keys.md", + "website/content/sdk/usage/api-keys.md", "website/content/sdk/usage/intros/forecast.md" ], "list": [ @@ -44,8 +44,8 @@ ], "not defined": [ "CONTRIBUTING.md", - "website/content/terminal/usage/guides/api-keys.md", - "website/content/sdk/usage/guides/api-keys.md" + "website/content/terminal/usage/data/api-keys.md", + "website/content/sdk/usage/api-keys.md" ], "defined, test inconclusive": [ "CONTRIBUTING.md" @@ -60,7 +60,7 @@ "website/content/terminal/usage/guides/changing-sources.md", "website/content/terminal/usage/intros/econometrics.md", "website/content/terminal/usage/intros/forecast.md", - "website/content/sdk/usage/guides/api-keys.md" + "website/content/sdk/usage/api-keys.md" ], "cls": [ "CONTRIBUTING.md" @@ -84,12 +84,12 @@ "website/content/terminal/usage/guides/data.md", "website/content/terminal/usage/guides/scripts-and-routines.md", "website/content/terminal/usage/guides/changing-sources.md", - "website/content/terminal/usage/guides/api-keys.md", + "website/content/terminal/usage/data/api-keys.md", "website/content/terminal/usage/intros/economy.md", "website/content/terminal/usage/intros/forecast.md", "website/content/sdk/usage/basics/index.md", "website/content/sdk/usage/guides/changing-sources.md", - "website/content/sdk/usage/guides/api-keys.md", + "website/content/sdk/usage/api-keys.md", "website/content/sdk/usage/intros/etf.md", "website/content/sdk/usage/intros/ta.md", "website/content/sdk/usage/intros/forecast.md" @@ -150,7 +150,7 @@ "quote": [ "CONTRIBUTING.md", "website/content/terminal/usage/intros/forex.md", - "website/content/sdk/usage/guides/api-keys.md" + "website/content/sdk/usage/api-keys.md" ], "candle": [ "CONTRIBUTING.md", @@ -163,7 +163,7 @@ "options": [ "CONTRIBUTING.md", "website/content/terminal/usage/guides/scripts-and-routines.md", - "website/content/terminal/usage/guides/api-keys.md", + "website/content/terminal/usage/data/api-keys.md", "website/content/terminal/usage/intros/fixedincome.md", "website/content/sdk/usage/intros/fixedincome.md" ], @@ -178,7 +178,7 @@ "fa": [ "CONTRIBUTING.md", "website/content/terminal/usage/guides/changing-sources.md", - "website/content/terminal/usage/guides/api-keys.md", + "website/content/terminal/usage/data/api-keys.md", "website/content/sdk/usage/guides/changing-sources.md" ], "ta": [ @@ -328,8 +328,8 @@ ], "oanda": [ "CONTRIBUTING.md", - "website/content/terminal/usage/guides/api-keys.md", - "website/content/sdk/usage/guides/api-keys.md", + "website/content/terminal/usage/data/api-keys.md", + "website/content/sdk/usage/api-keys.md", "website/content/sdk/usage/intros/forex.md" ], "calendar": [ @@ -347,7 +347,7 @@ "website/content/terminal/usage/intros/economy.md", "website/content/sdk/usage/basics/index.md", "website/content/sdk/usage/guides/chart-styling.md", - "website/content/sdk/usage/guides/api-keys.md", + "website/content/sdk/usage/api-keys.md", "website/content/sdk/usage/intros/fixedincome.md", "website/content/sdk/usage/intros/econometrics.md", "website/content/sdk/usage/intros/futures.md", @@ -366,7 +366,7 @@ "website/content/terminal/usage/intros/economy.md", "website/content/terminal/usage/intros/forecast.md", "website/content/sdk/usage/basics/index.md", - "website/content/sdk/usage/guides/api-keys.md", + "website/content/sdk/usage/api-keys.md", "website/content/sdk/usage/intros/econometrics.md", "website/content/sdk/usage/intros/economy.md", "website/content/sdk/usage/intros/forecast.md" @@ -403,15 +403,15 @@ ], "keys": [ "openbb_terminal/SDK_README.md", - "website/content/terminal/usage/guides/api-keys.md", + "website/content/terminal/usage/data/api-keys.md", "website/content/sdk/usage/basics/index.md", - "website/content/sdk/usage/guides/api-keys.md", + "website/content/sdk/usage/api-keys.md", "website/content/sdk/usage/intros/economy.md" ], "mykeys": [ "openbb_terminal/SDK_README.md", - "website/content/terminal/usage/guides/api-keys.md", - "website/content/sdk/usage/guides/api-keys.md" + "website/content/terminal/usage/data/api-keys.md", + "website/content/sdk/usage/api-keys.md" ], "dpi": [ "openbb_terminal/SDK_README.md" @@ -433,8 +433,8 @@ ], "fmp": [ "openbb_terminal/SDK_README.md", - "website/content/terminal/usage/guides/api-keys.md", - "website/content/sdk/usage/guides/api-keys.md" + "website/content/terminal/usage/data/api-keys.md", + "website/content/sdk/usage/api-keys.md" ], "categories": [ "openbb_terminal/SDK_README.md", @@ -478,7 +478,7 @@ ], "global": [ "website/content/sdk/faqs/developer_issues.md", - "website/content/sdk/usage/guides/api-keys.md" + "website/content/sdk/usage/api-keys.md" ], "rm": [ "website/content/sdk/faqs/developer_issues.md" @@ -575,17 +575,17 @@ "website/content/terminal/usage/guides/changing-sources.md", "website/content/terminal/usage/intros/econometrics.md", "website/content/terminal/usage/intros/economy.md", - "website/content/sdk/usage/guides/api-keys.md" + "website/content/sdk/usage/api-keys.md" ], "fred": [ - "website/content/terminal/usage/guides/api-keys.md", + "website/content/terminal/usage/data/api-keys.md", "website/content/terminal/usage/intros/economy.md", - "website/content/sdk/usage/guides/api-keys.md", + "website/content/sdk/usage/api-keys.md", "website/content/sdk/usage/intros/economy.md" ], "degiro": [ - "website/content/terminal/usage/guides/api-keys.md", - "website/content/sdk/usage/guides/api-keys.md" + "website/content/terminal/usage/data/api-keys.md", + "website/content/sdk/usage/api-keys.md" ], "fixedincome": [ "website/content/terminal/usage/intros/fixedincome.md", @@ -761,7 +761,7 @@ "website/content/sdk/usage/intros/ta.md" ], "account": [ - "website/content/sdk/usage/guides/api-keys.md" + "website/content/sdk/usage/api-keys.md" ], "projection": [ "website/content/sdk/usage/intros/fixedincome.md" @@ -842,4 +842,4 @@ "sto": [ "website/content/sdk/usage/intros/forecast.md" ] -} \ No newline at end of file +} diff --git a/openbb_terminal/miscellaneous/documentation_scripts/documentation_commands_sdk.csv b/openbb_terminal/miscellaneous/documentation_scripts/documentation_commands_sdk.csv index 0f02f571c708..206bd1c007c2 100644 --- a/openbb_terminal/miscellaneous/documentation_scripts/documentation_commands_sdk.csv +++ b/openbb_terminal/miscellaneous/documentation_scripts/documentation_commands_sdk.csv @@ -25,35 +25,35 @@ website/content/sdk/usage/basics/index.md,economy.events website/content/sdk/usage/basics/index.md,ta.donchian website/content/sdk/usage/basics/index.md,stocks.load website/content/sdk/usage/basics/index.md,etf.holdings -website/content/sdk/usage/guides/api-keys.md,keys.github -website/content/sdk/usage/guides/api-keys.md,keys.glassnode -website/content/sdk/usage/guides/api-keys.md,keys.fred -website/content/sdk/usage/guides/api-keys.md,keys.finnhub -website/content/sdk/usage/guides/api-keys.md,keys.eodhd -website/content/sdk/usage/guides/api-keys.md,keys.degiro -website/content/sdk/usage/guides/api-keys.md,keys.databento -website/content/sdk/usage/guides/api-keys.md,keys.quandl -website/content/sdk/usage/guides/api-keys.md,keys.oanda -website/content/sdk/usage/guides/api-keys.md,keys.polygon -website/content/sdk/usage/guides/api-keys.md,keys.cpanic -website/content/sdk/usage/guides/api-keys.md,keys.santiment -website/content/sdk/usage/guides/api-keys.md,keys.stocksera -website/content/sdk/usage/guides/api-keys.md,keys.tokenterminal -website/content/sdk/usage/guides/api-keys.md,keys.tradier -website/content/sdk/usage/guides/api-keys.md,keys.walert -website/content/sdk/usage/guides/api-keys.md,stocks.quote -website/content/sdk/usage/guides/api-keys.md,keys.news -website/content/sdk/usage/guides/api-keys.md,keys.coinglass -website/content/sdk/usage/guides/api-keys.md,keys.messari -website/content/sdk/usage/guides/api-keys.md,keys.cmc -website/content/sdk/usage/guides/api-keys.md,keys.fmp -website/content/sdk/usage/guides/api-keys.md,keys.mykeys -website/content/sdk/usage/guides/api-keys.md,keys.reddit -website/content/sdk/usage/guides/api-keys.md,keys.coinbase -website/content/sdk/usage/guides/api-keys.md,news -website/content/sdk/usage/guides/api-keys.md,keys.av -website/content/sdk/usage/guides/api-keys.md,keys.binance -website/content/sdk/usage/guides/api-keys.md,keys.bitquery +website/content/sdk/usage/api-keys.md,keys.github +website/content/sdk/usage/api-keys.md,keys.glassnode +website/content/sdk/usage/api-keys.md,keys.fred +website/content/sdk/usage/api-keys.md,keys.finnhub +website/content/sdk/usage/api-keys.md,keys.eodhd +website/content/sdk/usage/api-keys.md,keys.degiro +website/content/sdk/usage/api-keys.md,keys.databento +website/content/sdk/usage/api-keys.md,keys.quandl +website/content/sdk/usage/api-keys.md,keys.oanda +website/content/sdk/usage/api-keys.md,keys.polygon +website/content/sdk/usage/api-keys.md,keys.cpanic +website/content/sdk/usage/api-keys.md,keys.santiment +website/content/sdk/usage/api-keys.md,keys.stocksera +website/content/sdk/usage/api-keys.md,keys.tokenterminal +website/content/sdk/usage/api-keys.md,keys.tradier +website/content/sdk/usage/api-keys.md,keys.walert +website/content/sdk/usage/api-keys.md,stocks.quote +website/content/sdk/usage/api-keys.md,keys.news +website/content/sdk/usage/api-keys.md,keys.coinglass +website/content/sdk/usage/api-keys.md,keys.messari +website/content/sdk/usage/api-keys.md,keys.cmc +website/content/sdk/usage/api-keys.md,keys.fmp +website/content/sdk/usage/api-keys.md,keys.mykeys +website/content/sdk/usage/api-keys.md,keys.reddit +website/content/sdk/usage/api-keys.md,keys.coinbase +website/content/sdk/usage/api-keys.md,news +website/content/sdk/usage/api-keys.md,keys.av +website/content/sdk/usage/api-keys.md,keys.binance +website/content/sdk/usage/api-keys.md,keys.bitquery website/content/sdk/usage/guides/changing-sources.md,stocks.load website/content/sdk/usage/intros/alternative.md,alt.covid.slopes website/content/sdk/usage/intros/alternative.md,alt.covid.global_deaths @@ -110,4 +110,4 @@ website/content/sdk/usage/intros/ta.md,ta.atr website/content/sdk/usage/intros/ta.md,ta.rsi website/content/sdk/usage/intros/ta.md,stocks.load website/content/sdk/usage/intros/ta.md,ta.donchian -website/content/terminal/usage/guides/api-keys.md,news +website/content/terminal/usage/data/api-keys.md,news diff --git a/openbb_terminal/miscellaneous/documentation_scripts/documentation_commands_sdk.json b/openbb_terminal/miscellaneous/documentation_scripts/documentation_commands_sdk.json index 50f5630fe2c2..243925ed3b1a 100644 --- a/openbb_terminal/miscellaneous/documentation_scripts/documentation_commands_sdk.json +++ b/openbb_terminal/miscellaneous/documentation_scripts/documentation_commands_sdk.json @@ -1,8 +1,8 @@ { "news": [ "CONTRIBUTING.md", - "website/content/terminal/usage/guides/api-keys.md", - "website/content/sdk/usage/guides/api-keys.md" + "website/content/terminal/usage/data/api-keys.md", + "website/content/sdk/usage/api-keys.md" ], "stocks.dps.shorted": [ "CONTRIBUTING.md" @@ -23,18 +23,18 @@ ], "keys.fmp": [ "openbb_terminal/SDK_README.md", - "website/content/sdk/usage/guides/api-keys.md" + "website/content/sdk/usage/api-keys.md" ], "keys.get_keys_info": [ "openbb_terminal/SDK_README.md" ], "keys.mykeys": [ "openbb_terminal/SDK_README.md", - "website/content/sdk/usage/guides/api-keys.md" + "website/content/sdk/usage/api-keys.md" ], "keys.reddit": [ "openbb_terminal/SDK_README.md", - "website/content/sdk/usage/guides/api-keys.md" + "website/content/sdk/usage/api-keys.md" ], "keys.set_keys": [ "openbb_terminal/SDK_README.md" @@ -88,85 +88,85 @@ "website/content/sdk/usage/intros/ta.md" ], "keys.av": [ - "website/content/sdk/usage/guides/api-keys.md", + "website/content/sdk/usage/api-keys.md", "website/content/sdk/usage/intros/economy.md" ], "keys.binance": [ - "website/content/sdk/usage/guides/api-keys.md" + "website/content/sdk/usage/api-keys.md" ], "keys.bitquery": [ - "website/content/sdk/usage/guides/api-keys.md" + "website/content/sdk/usage/api-keys.md" ], "keys.cmc": [ - "website/content/sdk/usage/guides/api-keys.md" + "website/content/sdk/usage/api-keys.md" ], "keys.coinbase": [ - "website/content/sdk/usage/guides/api-keys.md" + "website/content/sdk/usage/api-keys.md" ], "keys.coinglass": [ - "website/content/sdk/usage/guides/api-keys.md" + "website/content/sdk/usage/api-keys.md" ], "keys.cpanic": [ - "website/content/sdk/usage/guides/api-keys.md" + "website/content/sdk/usage/api-keys.md" ], "keys.databento": [ - "website/content/sdk/usage/guides/api-keys.md" + "website/content/sdk/usage/api-keys.md" ], "keys.degiro": [ - "website/content/sdk/usage/guides/api-keys.md" + "website/content/sdk/usage/api-keys.md" ], "keys.eodhd": [ - "website/content/sdk/usage/guides/api-keys.md" + "website/content/sdk/usage/api-keys.md" ], "keys.finnhub": [ - "website/content/sdk/usage/guides/api-keys.md" + "website/content/sdk/usage/api-keys.md" ], "keys.fred": [ - "website/content/sdk/usage/guides/api-keys.md", + "website/content/sdk/usage/api-keys.md", "website/content/sdk/usage/intros/economy.md" ], "keys.github": [ - "website/content/sdk/usage/guides/api-keys.md" + "website/content/sdk/usage/api-keys.md" ], "keys.glassnode": [ - "website/content/sdk/usage/guides/api-keys.md" + "website/content/sdk/usage/api-keys.md" ], "keys.messari": [ - "website/content/sdk/usage/guides/api-keys.md" + "website/content/sdk/usage/api-keys.md" ], "keys.news": [ - "website/content/sdk/usage/guides/api-keys.md" + "website/content/sdk/usage/api-keys.md" ], "keys.oanda": [ - "website/content/sdk/usage/guides/api-keys.md" + "website/content/sdk/usage/api-keys.md" ], "keys.polygon": [ - "website/content/sdk/usage/guides/api-keys.md" + "website/content/sdk/usage/api-keys.md" ], "keys.quandl": [ - "website/content/sdk/usage/guides/api-keys.md", + "website/content/sdk/usage/api-keys.md", "website/content/sdk/usage/intros/economy.md" ], "keys.santiment": [ - "website/content/sdk/usage/guides/api-keys.md" + "website/content/sdk/usage/api-keys.md" ], "keys.shroom": [ - "website/content/sdk/usage/guides/api-keys.md" + "website/content/sdk/usage/api-keys.md" ], "keys.stocksera": [ - "website/content/sdk/usage/guides/api-keys.md" + "website/content/sdk/usage/api-keys.md" ], "keys.tokenterminal": [ - "website/content/sdk/usage/guides/api-keys.md" + "website/content/sdk/usage/api-keys.md" ], "keys.tradier": [ - "website/content/sdk/usage/guides/api-keys.md" + "website/content/sdk/usage/api-keys.md" ], "keys.walert": [ - "website/content/sdk/usage/guides/api-keys.md" + "website/content/sdk/usage/api-keys.md" ], "stocks.quote": [ - "website/content/sdk/usage/guides/api-keys.md" + "website/content/sdk/usage/api-keys.md" ], "fixedincome.ameribor": [ "website/content/sdk/usage/intros/fixedincome.md" @@ -298,4 +298,4 @@ "forecast.sto": [ "website/content/sdk/usage/intros/forecast.md" ] -} \ No newline at end of file +} diff --git a/openbb_terminal/miscellaneous/documentation_scripts/generate_documentation_commands.py b/openbb_terminal/miscellaneous/documentation_scripts/generate_documentation_commands.py index 48e424d65a96..eb0e7a4d58c6 100644 --- a/openbb_terminal/miscellaneous/documentation_scripts/generate_documentation_commands.py +++ b/openbb_terminal/miscellaneous/documentation_scripts/generate_documentation_commands.py @@ -22,12 +22,12 @@ MD_FILES = ["CONTRIBUTING.md", "README.md", "openbb_terminal/SDK_README.md"] MD_FILES.extend(glob.glob("website/content/sdk/faqs/*.md", recursive=True)) -MD_FILES.extend(glob.glob("website/content/terminal/usage/basics/*.md", recursive=True)) -MD_FILES.extend(glob.glob("website/content/terminal/usage/guides/*.md", recursive=True)) -MD_FILES.extend(glob.glob("website/content/terminal/usage/intros/*.md", recursive=True)) -MD_FILES.extend(glob.glob("website/content/sdk/usage/basics/*.md", recursive=True)) -MD_FILES.extend(glob.glob("website/content/sdk/usage/guides/*.md", recursive=True)) -MD_FILES.extend(glob.glob("website/content/sdk/usage/intros/*.md", recursive=True)) +MD_FILES.extend(glob.glob("website/content/terminal/usage/*.md", recursive=True)) +MD_FILES.extend( + glob.glob("website/content/terminal/data-available/*.md", recursive=True) +) +MD_FILES.extend(glob.glob("website/content/sdk/usage/*.md", recursive=True)) +MD_FILES.extend(glob.glob("website/content/sdk/data-available/*.md", recursive=True)) EXPORT_FILE_PATH = ( "openbb_terminal/miscellaneous/documentation_scripts/documentation_commands" diff --git a/openbb_terminal/miscellaneous/integration_tests_scripts/etf/test_disc.openbb b/openbb_terminal/miscellaneous/integration_tests_scripts/etf/test_disc.openbb index 2d42cc2f39cf..8f2e115e9a0a 100644 --- a/openbb_terminal/miscellaneous/integration_tests_scripts/etf/test_disc.openbb +++ b/openbb_terminal/miscellaneous/integration_tests_scripts/etf/test_disc.openbb @@ -3,9 +3,4 @@ disc gainers decliners active -<<<<<<< Updated upstream:openbb_terminal/miscellaneous/integration_tests_scripts/etf/test_disc.openbb -======= -help -reset ->>>>>>> Stashed changes:openbb_terminal/miscellaneous/integration_tests_scripts/etf/test_etf_disc.openbb exit diff --git a/openbb_terminal/terminal_controller.py b/openbb_terminal/terminal_controller.py index 81b4a5a19a8e..abda862b6bd4 100644 --- a/openbb_terminal/terminal_controller.py +++ b/openbb_terminal/terminal_controller.py @@ -607,7 +607,9 @@ def call_funds(self, _): def call_intro(self, _): """Process intro command.""" - webbrowser.open("https://docs.openbb.co/terminal/usage/basics") + webbrowser.open( + "https://docs.openbb.co/terminal/usage/overview/structure-and-navigation" + ) def call_exe(self, other_args: List[str]): """Process exe command.""" @@ -830,7 +832,9 @@ def terminal(jobs_cmds: Optional[List[str]] = None, test_mode=False): if first_time_user(): with contextlib.suppress(EOFError): - webbrowser.open("https://docs.openbb.co/terminal/usage/basics") + webbrowser.open( + "https://docs.openbb.co/terminal/usage/overview/structure-and-navigation" + ) t_controller.print_help() check_for_updates() diff --git a/openbb_terminal/terminal_helper.py b/openbb_terminal/terminal_helper.py index 08fea1ac836d..51b7e1a8469e 100644 --- a/openbb_terminal/terminal_helper.py +++ b/openbb_terminal/terminal_helper.py @@ -140,61 +140,61 @@ def open_openbb_documentation( """Opens the documentation page based on your current location within the terminal. Make exceptions for menus that are considered 'common' by adjusting the path accordingly.""" if path == "/" and command is None: - path = "/usage?path=/usage/basics" + path = "/usage?path=/usage/structure-and-navigation" command = "" elif "keys" in path: - path = "/usage?path=/usage/guides/api-keys" + path = "/usage?path=/usage/data/api-keys" command = "" elif "settings" in path: - path = "/usage?path=/usage/guides/customizing-the-terminal" + path = "/usage?path=/usage/overview/customizing-the-terminal" command = "" elif "featflags" in path: - path = "/usage?path=/usage/guides/customizing-the-terminal#using-the-feature-flags-menu" + path = "/usage?path=/usage/overview/customizing-the-terminal#feature-flags-menu" command = "" elif "sources" in path: - path = "/usage?path=/usage/guides/changing-sources" + path = "/usage?path=/usage/usage/data/data-sources" command = "" elif "account" in path: - path = "/usage?path=/usage/guides/basics" + path = "/usage?path=/usage/hub" command = "" elif arg_type == "command": # user passed a command name if command in ["settings", "featflags"]: - path = "/usage?path=/usage/guides/customizing-the-terminal" + path = "/usage?path=/usage/overview/customizing-the-terminal" command = "" else: path = f"/commands?path={path}" elif arg_type == "menu": # user passed a menu name if command in ["ta", "ba", "qa"]: menu = path.split("/")[-2] - path = f"/usage?path=/usage/intros/common/{menu}" + path = f"/usage?path=/data-available/common/{menu}" elif command == "forecast": command = "" - path = "/usage?path=/usage/intros/forecast" + path = "/usage?path=/data-available/forecast" else: - path = f"/usage?path=/usage/intros/{path}" + path = f"/usage?path=/data-available/{path}" else: # user didn't pass argument and is in a menu menu = path.split("/")[-2] path = ( - f"/usage?path=/usage/intros/common/{menu}" + f"/usage?path=/data-available/common/{menu}" if menu in ["ta", "ba", "qa"] - else f"/usage?path=/usage/intros/{path}" + else f"/usage?path=/data-available/{path}" ) if command: if command == "keys": - path = "/usage?path=/usage/guides/api-keys" + path = "/usage?path=/usage/data/api-keys" command = "" elif "settings" in path or "featflags" in path: - path = "/usage?path=/usage/guides/customizing-the-terminal" + path = "/usage?path=/usage/overview/customizing-the-terminal" command = "" elif "sources" in path: - path = "/usage?path=/usage/guides/changing-sources" + path = "/usage?path=/usage/data/data-sources" command = "" elif command in ["record", "stop", "exe"]: - path = "/usage?path=/usage/guides/scripts-and-routines" + path = "/usage?path=/usage/routines/introduction-to-routines" command = "" elif command == "sources": - path = "/usage?path=/usage/guides/changing-sources" + path = "/usage?path=/usage/data/data-sources" command = "" elif command in [ "intro", @@ -209,7 +209,7 @@ def open_openbb_documentation( path = "/usage" command = "" elif command in ["ta", "ba", "qa"]: - path = f"/usage?path=/usage/intros/common/{command}" + path = f"/usage?path=/data-available/common/{command}" command = "" path += command diff --git a/website/README.md b/website/README.md index 695ad882c1a9..74ba27beeffd 100644 --- a/website/README.md +++ b/website/README.md @@ -30,13 +30,13 @@ The markdown files are used to generate the website. The markdown files are loca Code blocks are generated using the default markdown syntax: - ```python - print("Hello World") - ``` + ```python + print("Hello World") + ``` To generate a dynamic date for a certain code block (useful for options examples that need to have a valid date), you can use `2022-07-29` as a placeholder. The script will replace it with the third friday of the next month. -``` +```txt /op oichart ticker:AMD expiry:2022-07-29 ``` @@ -138,156 +138,3 @@ We are detecting whether the website is loaded inside an iframe. If it is, we ar We welcome contributions to the OpenBB Documentation Website. --- - -
DEPRECATED - OLD README -

- -# Hugo Server - -The current features can be found in [OpenBB Terminal Features](https://openbb-finance.github.io/OpenBBTerminal). - - -

Table of Contents

 -
    -
  1. Install Hugo
    2. -
  2. Run Locally
    3. -
  3. Adding Features
    4. - -
- -## Install Hugo - -Install [Hugo](https://gohugo.io/getting-started/installing/). - -## Run Locally - -Go into `website` directory with: - -```bash -cd website -``` - -And run: - -```bash -hugo server -D -``` - -If everything is working well, the following should appear: - -```txt -13:58 $ hugo server -D -Start building sites … -hugo v0.87.0+extended darwin/amd64 BuildDate=unknown - - | EN --------------------+------ - Pages | 853 - Paginator pages | 0 - Non-page files | 1 - Static files | 111 - Processed images | 4 - Aliases | 0 - Sitemaps | 1 - Cleaned | 0 - -Built in 14912 ms -Watching for changes in /Users/DidierRodriguesLopes/Documents/git/OpenBBTerminal/website/{archetypes,assets,content,data,static,themes} -Watching for config changes in /Users/DidierRodriguesLopes/Documents/git/OpenBBTerminal/website/config.toml -Environment: "development" -Serving pages from memory -Running in Fast Render Mode. For full rebuilds on change: hugo server --disableFastRender -Web Server is available at http://localhost:1313/ (bind address 127.0.0.1) -Press Ctrl+C to stop -``` - -And you should be able to access your local version at http://localhost:1313/. - -This will be important for the addition of features to the Hugo Server. - -## Adding Features - -### Structure - -This is the structure that the documentation follows: - -```txt -website/content/_index.md - /stocks/_index.md - /load/_index.md - /candle/_index.md - /discovery/_index.md - /ipo/_index.md - /... - /... - /... - /cryptocurrency/_index.md - /chart/_index.md - /defi/_index.md - /borrow/_index.md - /... - /... - /... - /common/_index.md - /technical_analysis/_index.md - /ema/_index.md - /... - /... -``` - -Note that the `common` folder holds features that are common across contexts, e.g. `technical analysis` can be performed on both `stocks` or `crypto`. - -### New Feature - -To add a new command, there are two main actions that need to be done: - -1. Create a directory with the name of the command and a `_index.md` file within. Examples: - - - When adding `ipo`, since this command belongs to context `stocks` and category `discovery`, we added a `ipo` folder with a `_index.md` file within to `website/content/stocks/discovery`. - - When adding `candle`, since this command belongs to context `stocks`, we added a `candle` folder with a `_index.md` file within to `website/content/stocks/`. - -2. The `_index.md` file should have the output of the `command -h` followed by a screenshot example (with white background) of what the user can expect. Note that you can now drag and drop the images while editing the readme file on the remote web version of your PR branch. Github will create a link for it with format (https://user-images.githubusercontent.com/***/***.file_format). - -Example: - ---- - -```shell -usage: ipo [--past PAST_DAYS] [--future FUTURE_DAYS] -``` - -Past and future IPOs. [Source: https://finnhub.io] - -- --past : Number of past days to look for IPOs. Default 0. -- --future : Number of future days to look for IPOs. Default 10. - - - ---- - -3. Update the Navigation bar to match the content you've added. This is done by adding 2 lines of code to `website/data/menu/`, i.e. a `name` and a `ref`. Example: - -``` ---- -main: - - name: stocks - ref: "/stocks" - sub: - - name: load - ref: "/stocks/load" - - name: candle - ref: "/stocks/candle" - - name: discovery - ref: "/stocks/discovery" - sub: - - name: ipo - ref: "/stocks/discovery/ipo" - - name: map - ref: "/stocks/discovery/map" -``` - -

-
diff --git a/website/versioned_docs/version-v3/bot/_category_.json b/website/content/bot/_category_.json similarity index 100% rename from website/versioned_docs/version-v3/bot/_category_.json rename to website/content/bot/_category_.json diff --git a/website/content/bot/changelog/_category_.json b/website/content/bot/changelog/_category_.json new file mode 100644 index 000000000000..faac8046e897 --- /dev/null +++ b/website/content/bot/changelog/_category_.json @@ -0,0 +1,4 @@ +{ + "label": "Changelog", + "position": 4 +} diff --git a/website/versioned_docs/version-v3/bot/changelog/version1_0_0.mdx b/website/content/bot/changelog/version1_0_0.mdx similarity index 100% rename from website/versioned_docs/version-v3/bot/changelog/version1_0_0.mdx rename to website/content/bot/changelog/version1_0_0.mdx diff --git a/website/versioned_docs/version-v3/bot/changelog/version1_0_1.mdx b/website/content/bot/changelog/version1_0_1.mdx similarity index 100% rename from website/versioned_docs/version-v3/bot/changelog/version1_0_1.mdx rename to website/content/bot/changelog/version1_0_1.mdx diff --git a/website/versioned_docs/version-v3/bot/changelog/version1_0_2.mdx b/website/content/bot/changelog/version1_0_2.mdx similarity index 100% rename from website/versioned_docs/version-v3/bot/changelog/version1_0_2.mdx rename to website/content/bot/changelog/version1_0_2.mdx diff --git a/website/versioned_docs/version-v3/bot/changelog/version1_0_3.mdx b/website/content/bot/changelog/version1_0_3.mdx similarity index 100% rename from website/versioned_docs/version-v3/bot/changelog/version1_0_3.mdx rename to website/content/bot/changelog/version1_0_3.mdx diff --git a/website/versioned_docs/version-v3/bot/changelog/version1_0_4.mdx b/website/content/bot/changelog/version1_0_4.mdx similarity index 100% rename from website/versioned_docs/version-v3/bot/changelog/version1_0_4.mdx rename to website/content/bot/changelog/version1_0_4.mdx diff --git a/website/versioned_docs/version-v3/bot/changelog/version1_0_5.mdx b/website/content/bot/changelog/version1_0_5.mdx similarity index 100% rename from website/versioned_docs/version-v3/bot/changelog/version1_0_5.mdx rename to website/content/bot/changelog/version1_0_5.mdx diff --git a/website/versioned_docs/version-v3/bot/changelog/version1_0_6.mdx b/website/content/bot/changelog/version1_0_6.mdx similarity index 100% rename from website/versioned_docs/version-v3/bot/changelog/version1_0_6.mdx rename to website/content/bot/changelog/version1_0_6.mdx diff --git a/website/versioned_docs/version-v3/bot/changelog/version1_0_7.mdx b/website/content/bot/changelog/version1_0_7.mdx similarity index 100% rename from website/versioned_docs/version-v3/bot/changelog/version1_0_7.mdx rename to website/content/bot/changelog/version1_0_7.mdx diff --git a/website/versioned_docs/version-v3/bot/changelog/version1_0_8.mdx b/website/content/bot/changelog/version1_0_8.mdx similarity index 100% rename from website/versioned_docs/version-v3/bot/changelog/version1_0_8.mdx rename to website/content/bot/changelog/version1_0_8.mdx diff --git a/website/versioned_docs/version-v3/bot/changelog/version2_0_0.mdx b/website/content/bot/changelog/version2_0_0.mdx similarity index 100% rename from website/versioned_docs/version-v3/bot/changelog/version2_0_0.mdx rename to website/content/bot/changelog/version2_0_0.mdx diff --git a/website/content/bot/faqs.md b/website/content/bot/faqs.md new file mode 100644 index 000000000000..3fe16bbf4199 --- /dev/null +++ b/website/content/bot/faqs.md @@ -0,0 +1,95 @@ +--- +title: FAQs +sidebar_position: 5 +description: This page offers information about OpenBB Bot, covering topics such as + linking your OpenBB Bot account, trying an OpenBB Bot plan, automatic plan renewals, + refunds, access on different platforms, individual and server plans, and troubleshooting + issues with slash commands. +keywords: +- OpenBB Bot +- OpenBB Bot account +- OpenBB plan +- billing cycle +- OpenBB Discord +- server settings +- integrations +- refunds +- subscription +- individual plan +- server plan +- slash commands +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +## Generic + +
How Do I Link My OpenBB Bot Account? + +After you signup for an OpenBB Bot plan you can link your accounts from here + +
+ +
Can I try an OpenBB Bot plan? + +You can try a preview of any plan by just running commands on a server that has OpenBB Bot, like OpenBB Discord. We offer a limited amount of daily commands. + +
+ + +
Will my OpenBB Bot plan renew at the end of the billing cycle? + +Yes, plans renew automatically at the end of the monthly and yearly billing cycles. You can cancel your plan at any time, before the end of the billing cycle, and it will not auto-renew anymore. + +
+ + +
Can I get a refund on my OpenBB Bot? + +Since we offer a free command tier to try commands we don't offer refunds as you have had ample time to try the service and make a decision. + +
+ + +
If I sign up for OpenBB Bot do I get access on all platforms? + +Yes! You will have access on Discord, and other platforms as we add support. + +
+ +
If I cancel OpenBB Bot subscription do I still have access? + +No, you will lose your access but you get a credit on your account of the prorated amount until the end of your current billing cycle. + +
+ + +
What's the difference in an individual plan and server plan on OpenBB Bot? + +An individual plan gives your account access to OpenBB Bot while a server plan gives the whole server access. An individual plan carries more perks with it than a server plan, which you can find by clicking on the plan. + +
+ + +
I added the bot but still don't see slash commands, what do I do? + + + +Just head to Server Settings → Integrations and then click ‘Manage’ next to an app, where you will behold a new, shiny, and dare we say dazzling, new surface. + +
    +
  • Use toggles to modify which members can use commands
    • +
  • Use toggles to modify which channels allow commands
    • +
+ +There’s also a command-specific list, where you can make customized permissions for each command. +
    +
  • By default, these are all synced to the command permission at the top.
    • +
  • You can unsync an individual command to make further customizations.
    • +
+ +For more information click here. + +
diff --git a/website/content/bot/index.md b/website/content/bot/index.md new file mode 100644 index 000000000000..5ec0cac94f01 --- /dev/null +++ b/website/content/bot/index.md @@ -0,0 +1,51 @@ +--- +title: Introduction +sidebar_position: 0 +description: OpenBB Bot - a chatbot providing access to high-quality financial data + for both individual investors and online communities on Discord and Telegram. The + bot provides actionable market data, including stock data, options, screeners, crypto, + and more. +keywords: +- OpenBB Bot +- chatting bot +- Discord +- Telegram +- financial data +- individual investors +- online communities +- stock data +- options +- screeners +- darkpool info +- crypto +- nft +- short data +- market data +- informed investors +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Looking for investment research data and sharing it with your community has never been easier than with the OpenBB Bot. Our bot delivers high-quality data directly to your fingertips, promoting engagement and learning among your peers. Share your investment ideas and strategies with your friends and colleagues seamlessly by accessing the data you need through a simple text message. The OpenBB Bot is the perfect tool for collaborative investment research that helps you make informed decisions and achieve success. + +bot + +--- + +- **Investment discussions at 10x speed** + +Say goodbye to the hassle of switching tabs or opening browsers just to share screenshots of market data with your friends. With the OpenBB Bot, you can access real-time market data instantly by using a simple bot command. Our bot allows you to visualize data easily within your preferred chatting platform, so you can keep up with the latest market trends without ever having to leave the chat window. + +- **Chatting through multiple platforms** + +Discover the power of the OpenBB Bot on Discord and Telegram, and stay tuned for new platform releases. We are always working to expand our reach, and are committed to bringing the OpenBB Bot to a wider audience. Our goal is to provide convenient access to investment research data for all users, and we are excited to announce that more platforms will be added in the near future. Keep an eye out for updates on new platform availability, and join us as we continue to revolutionize the way you access investment data. + +- **Available on desktop, mobile or tablet** + +By utilizing the chatting platform as the user interface, OpenBB Bot enables users access to investment research data on any device that is supported by the platform. This means that whether you are on your desktop, laptop, tablet, or smartphone, you can conveniently access the bot's research data without any additional software or hardware requirements. Enjoy seamless access to valuable investment insights across all your devices, anytime and anywhere. + +- **Customizable for your community** + +The OpenBB Bot provides users and server owners with the ability to personalize the bot according to their preferences. With a wide range of customization options, you can alter the color scheme, set up a watchlist, configure technical analysis indicators on your charts, and even schedule automatic market data posts. From market opening to closing, the OpenBB Bot has you covered with its flexible features and robust functionality. diff --git a/website/versioned_docs/version-v3/terminal/installation/_category_.json b/website/content/bot/installation/_category_.json similarity index 100% rename from website/versioned_docs/version-v3/terminal/installation/_category_.json rename to website/content/bot/installation/_category_.json diff --git a/website/content/bot/installation/discord.md b/website/content/bot/installation/discord.md new file mode 100644 index 000000000000..1e389dd673e8 --- /dev/null +++ b/website/content/bot/installation/discord.md @@ -0,0 +1,34 @@ +--- +title: Setting up Discord bot +sidebar_position: 2 +description: This page guides you on how to add a bot to your Discord server, through + steps of login, bot authorization, and adjusting bot permissions. +keywords: +- Add bot to Discord +- Discord bot setup +- Authorize Discord bot +- Bot permissions +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import AddBotDialogDiscord from "@site/src/components/General/AddBotDiscord"; + + + +After clicking on the "Add bot to Discord" button, a pop-up window will open, asking you to log in to your Discord account and allow the bot access. + +discord bot setup step 1 + +Once you log in, you’ll see a window asking for permission to access your account. Locate the “Add to Server” drop-down menu and click on it. +discord bot setup step 2 + +This will open a list of Discord servers where you can add a bot. Select your server and press “Continue”. + +Review permissions that the bot requests on your server. Select and deselect based on your needs, we recommend all the default settings in order to experience everything the bot has to offer. Click on “Authorize” when you’re ready. +discord bot setup step 3 + +Congratulations! You’ve successfully added a bot to your Discord server. diff --git a/website/content/bot/installation/overview.md b/website/content/bot/installation/overview.md new file mode 100644 index 000000000000..3ba49bea3c24 --- /dev/null +++ b/website/content/bot/installation/overview.md @@ -0,0 +1,55 @@ +--- +title: Overview +sidebar_position: 1 +description: Learn how to use OpenBB Bot in Discord and Telegram. Understand the requirements + for individual and server uses, and explore additional features by linking your + account. Join the community today and leverage over 1.5 Million commands executed + on OpenBB Bot. +keywords: +- OpenBB Bot +- Discord +- Telegram +- chatting applications +- link account +- user metrics +- commands +- community +- add bot +- server requirements +- individual requirements +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import AddBotDialogDiscord from "@site/src/components/General/AddBotDiscord"; +import AddBotDialogTelegram from "@site/src/components/General/AddBotTelegram"; + +Currently we support [Discord](installation/discord) and [Telegram](installation/telegram) for the OpenBB Bot. More integrations are under way. + +In order to use OpenBB Bot in one of these chatting applications you need to either: +
+
    +
  • + Belong to a server that has already added our bot (INDIVIDUAL) +
    • +
  • + Own a server and you can easily add our bot (SERVER) +
    • +
+
+ +By using the [Linked Platforms page](https://my.openbb.co/app/bot/linked-platforms) you are also able to link your Discord/Telegram account to the OpenBB Bot and open up even more features. + +

+ What are you waiting for? +

+ +Over 1.5 Million commands have been run on the OpenBB Bot. Join the community and start using OpenBB Bot today! + +Check our user metrics in our [Open page](https://openbb.co/open). + + + + diff --git a/website/content/bot/installation/telegram.md b/website/content/bot/installation/telegram.md new file mode 100644 index 000000000000..00e10176bac4 --- /dev/null +++ b/website/content/bot/installation/telegram.md @@ -0,0 +1,39 @@ +--- +title: Setting up Telegram bot +sidebar_position: 3 +description: Step-by-step guide to add the OpenBB Bot to a Telegram group. From starting + a chat with the bot to verifying its permissions, follow these steps to have your + bot ready in your group. +keywords: +- Add bot to Telegram +- OpenBB Bot +- telegram bot setup +- telegram group +- chatbot permission +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + + +import AddBotDialogTelegram from "@site/src/components/General/AddBotTelegram"; + + + +After clicking on the "Add bot to Telegram" button it should open a chat with our OpenBB Bot. + +telegram bot setup step 1 + +Go to your Telegram chat and click/tap on the Top Bar of the OpenBB Bot chat window. + +telegram bot setup step 2 + +Then, you need to click on “More” and select "Add to Group or Channel" or just click "Add to Group or Channel" and select the Telegram group you want to add the chatbot to: + +telegram bot setup step 3 + +Now you can verify it has the permissions required, we recommend the ones already selected, and you are ready to go! + +telegram bot setup step 4 diff --git a/website/versioned_docs/version-v3/bot/reference/_category_.json b/website/content/bot/reference/_category_.json similarity index 100% rename from website/versioned_docs/version-v3/bot/reference/_category_.json rename to website/content/bot/reference/_category_.json diff --git a/website/versioned_docs/version-v3/bot/reference/discord/_category_.json b/website/content/bot/reference/discord/_category_.json similarity index 100% rename from website/versioned_docs/version-v3/bot/reference/discord/_category_.json rename to website/content/bot/reference/discord/_category_.json diff --git a/website/content/bot/reference/discord/alerts/create.md b/website/content/bot/reference/discord/alerts/create.md new file mode 100644 index 000000000000..292190ab8b2b --- /dev/null +++ b/website/content/bot/reference/discord/alerts/create.md @@ -0,0 +1,50 @@ +--- +title: create +description: This page provides instructions on how to use the 'create' command to + set up price alerts for specific trading symbols. It includes usage examples and + a detailed description of parameters involved such as the ticker, condition, and + price. +keywords: +- price alerts +- trading symbols +- condition +- price +- creation command +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command creates an alert for a given symbol (ex. BTCUSD) that will notify the user when the price is equal to or above the user defined price. + +### Usage + +```python wordwrap +/alerts create ticker condition price +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| ticker | Ticker to set alert for | False | None | +| condition | Condition to set alert for | False | Equal or Above, Equal or Below | +| price | Price to set alert for | False | None | + + +--- + +## Examples + +``` +/alerts create ticker:BTCUSD condition:Equal or Above price:1000 +``` + +``` +/alerts create ticker:SPY condition:Equal or Below price:400 +``` + +--- diff --git a/website/content/bot/reference/discord/alerts/delete.md b/website/content/bot/reference/discord/alerts/delete.md new file mode 100644 index 000000000000..b4488183791a --- /dev/null +++ b/website/content/bot/reference/discord/alerts/delete.md @@ -0,0 +1,43 @@ +--- +title: delete +description: Learn how to delete an active alert using our user-friendly commands. + This page provides detailed usage and examples of alert deletion. +keywords: +- delete +- alert +- commands +- user guide +- parameters +- usage +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command allows the user to delete an active alert they have set. + +### Usage + +```python wordwrap +/alerts delete alert +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| alert | Alert to delete | False | None | + + +--- + +## Examples + +``` +/alerts delete alert: +``` + +--- diff --git a/website/content/bot/reference/discord/alerts/list.md b/website/content/bot/reference/discord/alerts/list.md new file mode 100644 index 000000000000..379814042cc4 --- /dev/null +++ b/website/content/bot/reference/discord/alerts/list.md @@ -0,0 +1,41 @@ +--- +title: list +description: The '/alerts list' command page helps users understand how to view a + list of their active alerts, including each alert's symbol, description, and threshold. +keywords: +- alerts list command +- list active alerts +- alert overview +- alerts symbols +- alerts threshold +- using alerts list +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command allows the user to view a list of all their active alerts. It displays each alert along with its symbol, description, and threshold, giving the user an overview of their active alerts at a glance. + +### Usage + +```python wordwrap +/alerts list +``` + +--- + +## Parameters + +This command has no parameters + + + +--- + +## Examples + +``` +/alerts list +``` +--- diff --git a/website/content/bot/reference/discord/alerts/update.md b/website/content/bot/reference/discord/alerts/update.md new file mode 100644 index 000000000000..f10b8caf2ee4 --- /dev/null +++ b/website/content/bot/reference/discord/alerts/update.md @@ -0,0 +1,45 @@ +--- +title: update +description: This page provides description and usage of the 'update' command within + the context of active alerts. It includes details on how to change the condition + of an active alert, specifically for price alerts. +keywords: +- Update command +- Price alert +- Active alerts +- Update condition +- Deactivate alert +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command allows the user to update the condition on an active alert, such as changing the value of a price alert. The command will update the alert with the new condition and keep the alert active until it is manually deactivated or the alert's condition is met. + +### Usage + +```python wordwrap +/alerts update alerts condition price +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| alerts | Your active alerts | False | None | +| condition | Update condition for alert | False | Equal or Above (above or equal), Equal or Below (below or equal) | +| price | Update alert to this price | False | None | + + +--- + +## Examples + +``` +/alerts update alerts: condition: price: +``` + +--- diff --git a/website/content/bot/reference/discord/autopost/add.md b/website/content/bot/reference/discord/autopost/add.md new file mode 100644 index 000000000000..381af6d3c26d --- /dev/null +++ b/website/content/bot/reference/discord/autopost/add.md @@ -0,0 +1,48 @@ +--- +title: commands add +description: This documentation page provides in-depth insight on how to use the 'add' + command in the context of autoposting with OpenBB bot. It gives details of usage, + parameters and even provides a few illustrative examples. +keywords: +- OpenBB bot +- autopost commands +- autoposting +- commands add +- usage parameters +- automated notifications +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command allows the user to add an autopost command to a channel. It allows the user to receive notifications from OpenBB bot in the channel without having to manually query them. This can be used for all commands that appear in the list when you run "autopost commands add" + +### Usage + +```python wordwrap +/autopost commands add cmd interval [start_time] [stop_time] +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| cmd | Pick the command you want to assign for autoposting | False | List of commands that allow auto posting | +| interval | How oftern to post the autopost command | False | 5m, 15m, 30m, 1hr, 2hr, 4hr, 6hr | +| start_time | Time to start the autopost command - ex. If I want to start at 8am I do 8 | True | 24hr time | +| stop_time | Time to stop the autopost command - ex. If I want to stop at 6pm I do 18 | True | 24hr time | + +--- + +## Examples + +``` +/autopost commands add cmd:/cm interval:1 Hour +``` + +``` +/autopost commands add cmd: /cm interval: 1 Hour start_time: 9 stop_time: 10 +``` diff --git a/website/content/bot/reference/discord/autopost/index.mdx b/website/content/bot/reference/discord/autopost/index.mdx new file mode 100644 index 000000000000..34b19072200f --- /dev/null +++ b/website/content/bot/reference/discord/autopost/index.mdx @@ -0,0 +1,22 @@ +# autopost + +import ReferenceCard from "@site/src/components/General/ReferenceCard"; + +
    + + + + +
diff --git a/website/content/bot/reference/discord/autopost/list.md b/website/content/bot/reference/discord/autopost/list.md new file mode 100644 index 000000000000..1e346c79cb7d --- /dev/null +++ b/website/content/bot/reference/discord/autopost/list.md @@ -0,0 +1,40 @@ +--- +title: list +description: Learn about the 'autopost list' command which allows you to view all + webhook feeds associated with a channel set up for automatic posting. Find out how + and when it can be used, with examples provided. +keywords: +- autopost list +- webhooks +- automatic posting +- channel +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command allows users to view all webhook feeds associated with a particular channel that have been set up for automatic posting. It produces a list of all webhooks that have been configured to post content to the channel automatically, as well as information such as when they are scheduled. + +### Usage + +```python wordwrap +/autopost list +``` + +--- + +## Parameters + +This command has no parameters + + + +--- + +## Examples + +``` +/autopost list +``` +--- diff --git a/website/content/bot/reference/discord/autopost/remove.md b/website/content/bot/reference/discord/autopost/remove.md new file mode 100644 index 000000000000..a496cdb2b7d3 --- /dev/null +++ b/website/content/bot/reference/discord/autopost/remove.md @@ -0,0 +1,47 @@ +--- +title: commands manage +description: Documentation on how to use the 'commands manage' command for autoposts + on Discord. This includes its usage, parameters, and examples for removing or listing + feeds. +keywords: +- commands manage +- autopost command +- Discord autoposts +- manage autoposts +- remove autoposts +- autopost parameters +- autopost usage +- list autoposts +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command allows the user to remove an autopost webhook feed from the channel. When executed, it will remove the feed from the channel and prevent any further autoposts from being sent. + +### Usage + +```python wordwrap +/autopost commands manage action +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| action | Remove, or List your feeds for Discord autoposts | True | Remove, List | + +--- + +## Examples + +``` +/autopost commands manage action:List +``` + +``` +/autopost commands manage action:Remove +``` diff --git a/website/content/bot/reference/discord/charts/c15m.md b/website/content/bot/reference/discord/charts/c15m.md new file mode 100644 index 000000000000..bf91965048be --- /dev/null +++ b/website/content/bot/reference/discord/charts/c15m.md @@ -0,0 +1,44 @@ +--- +title: c15m +description: The c15m command page explains how to retrieve a 15-minute intraday chart + for any given stock ticker. This tool allows users to conduct technical analysis + and monitor short-term price fluctuations. +keywords: +- c15m command +- intraday chart +- technical analysis +- stock trading +- short-term price movements +- stock ticker +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command allows the user to retrieve a 15-minute intraday chart for a given ticker. The chart will show the price and volume of the stock over the past 3 days in 15 minute intervals. This command is useful for performing technical analysis and tracking short-term price movements. + +### Usage + +```python wordwrap +/c15m ticker +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| ticker | Stock Ticker | False | None | + + +--- + +## Examples + +``` +/c15m ticker:AMD +``` + +--- diff --git a/website/content/bot/reference/discord/charts/c3m.md b/website/content/bot/reference/discord/charts/c3m.md new file mode 100644 index 000000000000..bc023289200f --- /dev/null +++ b/website/content/bot/reference/discord/charts/c3m.md @@ -0,0 +1,45 @@ +--- +title: c3m +description: The documentation page for /c3m command in stock market analysis tool. + This command retrieves a 3-minute intraday chart, which provides visual representation + of a stock's performance during the day, particularly useful for short-term investors. +keywords: +- 3 minute intraday chart +- stock performance +- candlestick chart +- short-term investments +- /c3m command +- trading hours +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command allows users to retrieve a 3-minute intraday chart for the given ticker. This chart will display the candlestick chart for the day. It will provide a visual representation of the stock's performance over the current day, making it helpful for short-term investors. + +### Usage + +```python wordwrap +/c3m ticker [extended_hours] +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| ticker | Stock Ticker | False | None | +| extended_hours | Show Full 4am-8pm ET Trading Hours. Default: False | True | None | + + +--- + +## Examples + +``` +/c3m ticker:AMD +``` + +--- diff --git a/website/content/bot/reference/discord/charts/c5m.md b/website/content/bot/reference/discord/charts/c5m.md new file mode 100644 index 000000000000..aeaaef32de85 --- /dev/null +++ b/website/content/bot/reference/discord/charts/c5m.md @@ -0,0 +1,47 @@ +--- +title: c5m +description: Learn how to use the c5m command to retrieve an intraday 5 minute chart + for a given ticker. This tool aids in performing technical analysis and monitoring + short-term stock price movements. +keywords: +- c5m command +- intraday 5 minute chart +- technical analysis +- stock performance +- candlestick chart +- short-term price movements +- stock ticker +- trading hours +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command allows the user to retrieve an intraday 5 minute chart for a given ticker. This chart will display the candlestick chart for the day. It will provide a visual representation of the stock's performance over the current day. This command is useful for performing technical analysis and tracking short-term price movements. + +### Usage + +```python wordwrap +/c5m ticker [extended_hours] +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| ticker | Stock Ticker | False | None | +| extended_hours | Show Full 4am-8pm ET Trading Hours. Default: False | True | None | + + +--- + +## Examples + +``` +/c5m ticker:AMD +``` + +--- diff --git a/website/content/bot/reference/discord/charts/cc.md b/website/content/bot/reference/discord/charts/cc.md new file mode 100644 index 000000000000..cc1dd0ff45c2 --- /dev/null +++ b/website/content/bot/reference/discord/charts/cc.md @@ -0,0 +1,47 @@ +--- +title: cc +description: This documentation page provides an in-depth explanation on the /cc command + that retrieves an intraday 5 minute chart for a given ticker. It's a useful tool + for technical analysis and tracking short-term price movements. +keywords: +- intraday 5 minute chart +- candlestick chart +- technical analysis +- short-term price movements +- /cc command +- stock performance visualization +- extended trading hours +- stock ticker +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command allows the user to retrieve an intraday 5 minute chart for a given ticker, /c5m also has the same effect. This chart will display the candlestick chart for the day. It will provide a visual representation of the stock's performance over the current day. This command is useful for performing technical analysis and tracking short-term price movements. + +### Usage + +```python wordwrap +/cc ticker [extended_hours] +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| ticker | Stock Ticker | False | None | +| extended_hours | Show Full 4am-8pm ET Trading Hours. Default: False | True | None | + + +--- + +## Examples + +``` +/cc ticker:AMD +``` + +--- diff --git a/website/content/bot/reference/discord/charts/cd.md b/website/content/bot/reference/discord/charts/cd.md new file mode 100644 index 000000000000..94c428d49480 --- /dev/null +++ b/website/content/bot/reference/discord/charts/cd.md @@ -0,0 +1,47 @@ +--- +title: cd +description: This page provides comprehensive information about the 'cd' command, + used to retrieve a daily candlestick chart for a specific stock ticker or coin. + It also includes usage instructions, parameter details and examples. +keywords: +- cd command +- daily candlestick chart +- stock ticker +- coin +- opening and closing prices +- high and low prices +- performance analysis +- command usage +- parameter details +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command allows the user to retrieve a daily candlestick chart for a particular ticker or coin. The candlestick chart provides information about the opening and closing prices of the day, as well as the high and low prices of the day. This data can then be used to analyze the performance of the ticker/coin over time. For example, if the user provides the command "/cd ticker:AMD", the chart will be generated for the ticker AMD. + +### Usage + +```python wordwrap +/cd ticker +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| ticker | Stock Ticker | False | None | + + +--- + +## Examples + +``` +/cd ticker:AMD +``` + +--- diff --git a/website/content/bot/reference/discord/charts/chart.md b/website/content/bot/reference/discord/charts/chart.md new file mode 100644 index 000000000000..be9305507795 --- /dev/null +++ b/website/content/bot/reference/discord/charts/chart.md @@ -0,0 +1,52 @@ +--- +title: chart +description: Learn how to retrieve a candlestick chart for specified stock tickers, + intervals, and for past days. The chart provides comprehensive trading data including + opening and closing prices, as well as highs and lows, and volume. +keywords: +- stock ticker +- candlestick chart +- trading data +- chart interval +- data visualization +- stock market +- financial information +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command will retrieve a candlestick chart for the ticker/interval provided, with data for the past number of days specified. The interval provided must be a valid time interval (e.g. 5 minute, 15 minute, etc.). The chart will be displayed to the user and will contain information such as the opening and closing prices, the high and low, the volume, and any other relevant information. + +### Usage + +```python wordwrap +/chart ticker interval [past_days] [extended_hours] +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| ticker | Stock Ticker | False | None | +| interval | Chart Interval | False | Daily (1440), Weekly (7200), Monthly (28800), 1 minute (1), 5 minute (5), 10 minute (10), 15 minute (15), 30 minute (30), 1 hour (60) | +| past_days | Past Days to Display. Default: 0 | True | None | +| extended_hours | Display Full 4am-8pm ET Trading Hours. Default: False | True | None | + + +--- + +## Examples + +``` +/chart ticker:AMD interval:5 minute past_days:0 +``` + +``` +/chart ticker:AMD interval:Daily +``` + +--- diff --git a/website/content/bot/reference/discord/charts/chartfib.md b/website/content/bot/reference/discord/charts/chartfib.md new file mode 100644 index 000000000000..a29ab9161342 --- /dev/null +++ b/website/content/bot/reference/discord/charts/chartfib.md @@ -0,0 +1,45 @@ +--- +title: chartfib +description: On this page, learn how to use the chartfib command in order to retrieve + Fibonacci levels for a given ticker. This information can help identify potential + support and resistance levels, ultimately aiding in identifying potential entry + and exit points in the stock market. +keywords: +- chartfib command +- Fibonacci levels +- stock market +- support and resistance levels +- potential entry and exit points +- Stock Ticker +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command allows the user to retrieve Fibonacci levels for a given ticker. This data can be used to identify potential support and resistance levels and can be used to identify potential entry and exit points in the stock market. + +### Usage + +```python wordwrap +/chartfib ticker +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| ticker | Stock Ticker | False | None | + + +--- + +## Examples + +``` +/chartfib ticker:AMD +``` + +--- diff --git a/website/content/bot/reference/discord/charts/chartsr.md b/website/content/bot/reference/discord/charts/chartsr.md new file mode 100644 index 000000000000..1e809c4c16fb --- /dev/null +++ b/website/content/bot/reference/discord/charts/chartsr.md @@ -0,0 +1,47 @@ +--- +title: chartsr +description: The chartsr command allows the user to retrieve Displays Support and + Resistance Levels for any given ticker. Useful in making informed trading decisions. +keywords: +- chartsr +- Support and Resistance Levels +- trading +- trading decisions +- Stock Ticker +- Chart Interval +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command allows the user to retrieve Displays Support and Resistance Levels for the ticker provided. It will display the support and resistance levels of a given ticker on the chart. These levels can help the user in making better trading decisions. + +### Usage + +```python wordwrap +/chartsr ticker [interval] +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| ticker | Stock Ticker | False | None | +| interval | Chart Interval | True | 5 minute (5), 15 minute (15) | + + +--- + +## Examples + +``` +/chartsr ticker:AMC +``` +``` +/chartsr ticker:AMC interval:5 minute +``` + +--- diff --git a/website/content/bot/reference/discord/charts/cm.md b/website/content/bot/reference/discord/charts/cm.md new file mode 100644 index 000000000000..8b1a945c01d4 --- /dev/null +++ b/website/content/bot/reference/discord/charts/cm.md @@ -0,0 +1,48 @@ +--- +title: cm +description: Learn about the /cm command that allows you to view a monthly candlestick + chart for a given stock or cryptocurrency, perfect for analyzing the long-term performance + of your chosen ticker/coin. +keywords: +- Candlestick chart +- Stock analysis +- Cryptocurrency analysis +- Open price +- Close price +- High price +- Low price +- Long-term performance +- Stock ticker +- Command +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command allows you to view a monthly candlestick chart for a given stock or cryptocurrency. The chart displays the open, close, high and low prices for the selected ticker/coin each month. This command is useful for analyzing the long-term performance of a stock or cryptocurrency. + +### Usage + +```python wordwrap +/cm ticker +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| ticker | Stock Ticker | False | None | + + +--- + +## Examples + +``` +/cm ticker:AMD +``` + +--- diff --git a/website/content/bot/reference/discord/charts/cw.md b/website/content/bot/reference/discord/charts/cw.md new file mode 100644 index 000000000000..b686bfec1148 --- /dev/null +++ b/website/content/bot/reference/discord/charts/cw.md @@ -0,0 +1,45 @@ +--- +title: cw +description: This page explains the usage of the 'cw' command, which enables the user + to retrieve a weekly candlestick chart for a specified ticker or coin. This chart + displays valuable trading information, including opening and closing prices, high + and low prices, and overall trading volume. +keywords: +- cw command +- weekly candlestick chart +- stock ticker +- trading volume +- opening and closing prices +- high and low prices +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command allows the user to retrieve a weekly candlestick chart for the ticker/coin provided. The chart displays the opening and closing prices, the high and low prices, and the trading volume for the week for the specified ticker/coin. + +### Usage + +```python wordwrap +/cw ticker +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| ticker | Stock Ticker | False | None | + + +--- + +## Examples + +``` +/cw ticker:AMD +``` + +--- diff --git a/website/content/bot/reference/discord/crypto/bigprints.md b/website/content/bot/reference/discord/crypto/bigprints.md new file mode 100644 index 000000000000..99a447570465 --- /dev/null +++ b/website/content/bot/reference/discord/crypto/bigprints.md @@ -0,0 +1,47 @@ +--- +title: bigprints +description: The documentation page explains the '/crypto bigprints coin:BTC-USD' + command which retrieves last 15 large cryptocurrency prints. Informative for trading + decisions. +keywords: +- Cryptocurrency +- Crypto Trading +- Trading decisions +- Command documentation +- Crypto bigprints +- BTC-USD +- Currency pair +- Large crypto prints +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command allows the user to retrieve the last 15 large prints for a given cryptocurrency pair. The command uses the format "/crypto bigprints coin:BTC-USD" where BTC-USD is the currency pair for which the user wants to retrieve the large prints. This command is useful for analyzing the recent large prints of a given currency pair, which can be used to inform trading decisions. + +### Usage + +```python wordwrap +/crypto bigprints coin [days] +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| coin | Coin from the list of supported coins | False | ADA-USD, AVAX-USD, BTC-USD, DAI-USD, DOGE-USD, DOT-USD, ETH-USD, LTC-USD, MATIC-USD, SHIB-USD, SOL-USD, TRX-USD, USDC-USD, USDT-USD, WBTC-USD, XRP-USD | +| days | Number of days to look back. Default is 10. | True | None | + + +--- + +## Examples + +``` +/crypto bigprints coin:BTC-USD +``` + +--- diff --git a/website/content/bot/reference/discord/crypto/bio.md b/website/content/bot/reference/discord/crypto/bio.md new file mode 100644 index 000000000000..23bb7fc1bae0 --- /dev/null +++ b/website/content/bot/reference/discord/crypto/bio.md @@ -0,0 +1,47 @@ +--- +title: bio +description: The Crypto Bio command retrieves key information about a specific cryptocurrency, + such as its current price, trading volume, and market cap. Excellent for getting + a quick snapshot of any given cryptocurrency's performance. +keywords: +- crypto +- crypto bio +- symbol +- btc +- cryptocurrency information +- market cap +- trading volume +- crypto price +- crypto metrics +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command allows the user to retrieve fundamental information about a crypto, such as its current price, 24-hour trading volume, market cap, and other key metrics, by entering a specific crypto symbol (e.g. "BTC") as an argument. + +### Usage + +```python wordwrap +/crypto bio symbol +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| symbol | Crypto symbol to check information (e.g., BTC) | False | None | + + +--- + +## Examples + +``` +/crypto bio symbol: btc +``` + +--- diff --git a/website/content/bot/reference/discord/crypto/compfees.md b/website/content/bot/reference/discord/crypto/compfees.md new file mode 100644 index 000000000000..2134888f1222 --- /dev/null +++ b/website/content/bot/reference/discord/crypto/compfees.md @@ -0,0 +1,50 @@ +--- +title: compfees +description: Learn how to use the compfees command to retrieve Protocol fees with + step-by-step examples. The command caters to various projects including btc, eth, + doge, etc. +keywords: +- compfees +- Protocol fees +- btc +- eth +- doge +- projects +- /crypto command +- crypto +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command allows users to retrieve the Protocol fees over time for the given project. + +### Usage + +```python wordwrap +/crypto compfees projects +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| projects | Comma separated list of protocols (e.g., btc,eth) | False | None | + + +--- + +## Examples + +``` +/crypto compfees projects: doge +``` + +``` +/crypto compfees projects: btc,eth +``` + +--- diff --git a/website/content/bot/reference/discord/crypto/defi/chart.md b/website/content/bot/reference/discord/crypto/defi/chart.md new file mode 100644 index 000000000000..708363123f66 --- /dev/null +++ b/website/content/bot/reference/discord/crypto/defi/chart.md @@ -0,0 +1,51 @@ +--- +title: chart +description: This page provides a guide on how to retrieve a chart of the top DeFi + protocols by market capitalization. It explains the usage, parameters, and examples + of '/crypto defi chart' command to have a visual overview of the current DeFi landscape. +keywords: +- DeFi +- market capitalization +- visual representation +- total DeFi market size +- ' crypto' +- chart +- protocols +- Total Value Locked +- Market Cap +- sort data +- chain +- sort order +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command will retrieve a chart of the top DeFi protocols by market capitalization. It will provide a visual representation of the relative size of each protocol, as well as an overview of the total DeFi market size. This will enable users to get a better understanding of the current DeFi landscape and identify which protocols are leading the way. + +### Usage + +```python wordwrap +/crypto defi chart +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| sortby | Column to sort data by (e.g., Total Value Locked) | True | Market Cap (MCap), Total Value Locked (TVL) | +| chain | Chain to filter by (e.g., ethereum) | True | None | +| reverse | Reverse the sort order | True | Yes | + + +--- + +## Examples + +``` +/crypto defi chart +``` +--- diff --git a/website/content/bot/reference/discord/crypto/defi/table.md b/website/content/bot/reference/discord/crypto/defi/table.md new file mode 100644 index 000000000000..b483d97c669a --- /dev/null +++ b/website/content/bot/reference/discord/crypto/defi/table.md @@ -0,0 +1,55 @@ +--- +title: table +description: This page provides commands and parameters for retrieving and managing + data about top DeFi protocols including total value locked, 24-hour volume, and + price. It also guides on how to sort and filter this data. +keywords: +- DeFi protocols +- total value locked +- /crypto defi table +- 24 hour volume +- price +- sortby parameter +- chain parameter +- reverse parameter +- crypto +- table +- sorted data +- Market Cap +- Total Value Locked +- MCap +- TVL +- ethereum +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command allows the user to view a table of the top DeFi protocols and their associated information, such as the total value locked, 24 hour volume, and price. The table is sorted in descending order, with the top DeFi protocols at the top. + +### Usage + +```python wordwrap +/crypto defi table [sortby] [chain] [reverse] +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| sortby | Column to sort data by (e.g., Total Value Locked) | True | Market Cap (MCap), Total Value Locked (TVL) | +| chain | Chain to filter by (e.g., ethereum) | True | None | +| reverse | Reverse the sort order | True | Yes | + + +--- + +## Examples + +``` +/crypto defi table +``` +--- diff --git a/website/content/bot/reference/discord/crypto/fees.md b/website/content/bot/reference/discord/crypto/fees.md new file mode 100644 index 000000000000..655293154451 --- /dev/null +++ b/website/content/bot/reference/discord/crypto/fees.md @@ -0,0 +1,44 @@ +--- +title: fees +description: The page provides information about how to fetch the fee rate of top + crypto protocols on a specified date. It helps users to compare different protocols' + fees, enhancing their decision-making process. +keywords: +- crypto +- fees +- comparison +- date +- crypto fees +- protocol +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This will provide the user with the fee rate of the top crypto protocols on a specified date, allowing the user to compare different protocols' fees and make an informed decision. + +### Usage + +```python wordwrap +/crypto fees date +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| date | Date to get fees for (e.g., 2022-01-01) | False | None | + + +--- + +## Examples + +``` +/crypto fees date: 2022-09-19 +``` + +--- diff --git a/website/content/bot/reference/discord/crypto/ir.md b/website/content/bot/reference/discord/crypto/ir.md new file mode 100644 index 000000000000..74a6ccdc02a8 --- /dev/null +++ b/website/content/bot/reference/discord/crypto/ir.md @@ -0,0 +1,42 @@ +--- +title: ir +description: Learn about the /crypto ir command which allows users to retrieve the + issuance rate of top crypto protocols. This is an essential tool for investors seeking + to understand supply dynamics of crypto protocols and inform their investment decisions. +keywords: +- crypto protocols +- issuance rate +- /crypto ir command +- investment decisions +- supply dynamics +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command allows the user to retrieve the issuance rate of the top crypto protocols. The issuance rate is the amount of new tokens that are generated by the protocol over a given period of time. It is a useful metric for understanding the supply dynamics of crypto protocols and is used to inform investment decisions. + +### Usage + +```python wordwrap +/crypto ir +``` + +--- + +## Parameters + +This command has no parameters + + + +--- + +## Examples + +``` +/crypto ir +``` + +--- diff --git a/website/content/bot/reference/discord/crypto/prints.md b/website/content/bot/reference/discord/crypto/prints.md new file mode 100644 index 000000000000..98547deccbc8 --- /dev/null +++ b/website/content/bot/reference/discord/crypto/prints.md @@ -0,0 +1,45 @@ +--- +title: prints +description: This tutorial explains the use of the command '/crypto prints coin' to + retrieve the last 15 crypto prints over the last 24 hours for a specific coin. Charge + into the world of crypto metrics, track prices, volumes, sizes, and other associated + metrics. +keywords: +- Crypto Prints +- Crypto metrics +- Crypto commands +- Bitcoin +- Ethereum +- Docusaurus SEO +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command allows the user to retrieve the Last 15 Crypto Prints over the last 24 hours for the specified coin. The command will provide information on the price, volume, size, and other metrics associated with the prints. + +### Usage + +```python wordwrap +/crypto prints coin +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| coin | Coin from the list of supported coins | False | ADA-USD, AVAX-USD, BTC-USD, DAI-USD, DOGE-USD, DOT-USD, ETH-USD, LTC-USD, MATIC-USD, SHIB-USD, SOL-USD, TRX-USD, USDC-USD, USDT-USD, WBTC-USD, XRP-USD | + + +--- + +## Examples + +``` +/crypto prints coin:BTC-USD +``` + +--- diff --git a/website/content/bot/reference/discord/crypto/top.md b/website/content/bot/reference/discord/crypto/top.md new file mode 100644 index 000000000000..39f53f4206c4 --- /dev/null +++ b/website/content/bot/reference/discord/crypto/top.md @@ -0,0 +1,53 @@ +--- +title: top +description: Command to retrieve the top cryptocurrencies by market cap, with optional + sorting and filtering capabilities. It provides a quick snapshot of the current + crypto market using specific commands. +keywords: +- crypto +- top cryptocurrencies +- market capitalization +- market cap +- stablecoins +- manufacturing +- sort +- filter +- reverse order +- command usage +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command will retrieve the top cryptocurrencies, ranked by market capitalization, allowing the user to quickly get a snapshot of the current market. + +### Usage + +```python wordwrap +/crypto top [sortby] [category] [reverse] +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| sortby | Column to sort data by (e.g., Market Cap) | True | Market Cap (MCap) | +| category | Category to filter by (e.g., stablecoins) | True | None | +| reverse | Reverse the sort order | True | Yes | + + +--- + +## Examples + +``` +/crypto top +``` + +``` +/crypto top sortby: Market Cap category: manufacturing +``` +--- diff --git a/website/content/bot/reference/discord/crypto/tvl.md b/website/content/bot/reference/discord/crypto/tvl.md new file mode 100644 index 000000000000..61405ae39b32 --- /dev/null +++ b/website/content/bot/reference/discord/crypto/tvl.md @@ -0,0 +1,51 @@ +--- +title: tvl +description: This page provides instructions on how to use the 'TVL' command to retrieve + historical Total Value Locked (TVL) data for a given protocol. This data provides + a snapshot of the total amount of capital locked in a protocol, enabling comparison + of metrics between protocols and tracking their growth over time. +keywords: +- TVL +- Total Value Locked +- protocol +- crypto +- historical data +- growth tracking +- metrics comparison +- capital +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command allows users to retrieve historical TVL (Total Value Locked) data for any given protocol. It provides a snapshot of the total amount of capital that is currently locked in the protocol, allowing users to easily compare the metrics between different protocols and track their growth over time. + +### Usage + +```python wordwrap +/crypto tvl protocols +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| protocols | comma separated list of protocols (e.g., curve,makerdao) | False | None | + + +--- + +## Examples + +``` +/crypto tvl +``` + +``` +/crypto tvl protocols: curve +``` + +--- diff --git a/website/content/bot/reference/discord/darkpool/allblocks.md b/website/content/bot/reference/discord/darkpool/allblocks.md new file mode 100644 index 000000000000..d4626dc03598 --- /dev/null +++ b/website/content/bot/reference/discord/darkpool/allblocks.md @@ -0,0 +1,43 @@ +--- +title: allblocks +description: Learn how to use the allblocks command to retrieve the last 15 block + trades of a given security, with details including the time, price, quantity, and + total gross value of each trade. +keywords: +- block trades +- security +- trade summary +- stock ticker +- allblocks command +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +The command allows the user to retrieve the last 15 block trades of a given security. This command will provide a summary of the last 15 block trades, including the time, price, quantity, and total gross value of each trade. + +### Usage + +```python wordwrap +/dp allblocks ticker +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| ticker | Stock Ticker | False | None | + + +--- + +## Examples + +``` +/dp topsum +``` + +--- diff --git a/website/content/bot/reference/discord/darkpool/alldp.md b/website/content/bot/reference/discord/darkpool/alldp.md new file mode 100644 index 000000000000..a6e0669c7b14 --- /dev/null +++ b/website/content/bot/reference/discord/darkpool/alldp.md @@ -0,0 +1,44 @@ +--- +title: alldp +description: This page provides the 'alldp' command usage to retrieve the last 15 + darkpool trades for a specific stock ticker. It presents how to efficiently trade + on a private stock trading system. +keywords: +- alldp command +- darkpool trades +- stock ticker +- private stock trading +- efficient trades +- retrieve trades +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command allows the user to retrieve the last 15 darkpool trades for the specified stock ticker. A darkpool is a private stock trading system that allows large trades to take place without affecting the public market, providing access to larger and more efficient trades. + +### Usage + +```python wordwrap +/dp alldp ticker +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| ticker | Stock Ticker | False | None | + + +--- + +## Examples + +``` +/dp alldp ticker:AMD +``` + +--- diff --git a/website/content/bot/reference/discord/darkpool/allprints.md b/website/content/bot/reference/discord/darkpool/allprints.md new file mode 100644 index 000000000000..66775c428a62 --- /dev/null +++ b/website/content/bot/reference/discord/darkpool/allprints.md @@ -0,0 +1,42 @@ +--- +title: allprints +description: This page's content revolves around the 'allprints' command used for + retrieving the last 15 combination of Dark Pool and Blocks for a specified ticker + symbol. It covers usage, parameters, and examples. +keywords: +- allprints command +- Dark Pool and Blocks +- stock market trades +- ticker symbol +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command retrieves the Last 15 Combination of Dark Pool and Blocks for a given ticker symbol. This can be used to view the most recent reported trades that involve Dark Pool and Blocks in the stock market. The results of this command will show the date, time, price, and volume of the trades. + +### Usage + +```python wordwrap +/dp allprints ticker +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| ticker | Stock Ticker | False | None | + + +--- + +## Examples + +``` +/dp allprints ticker:AMD +``` + +--- diff --git a/website/content/bot/reference/discord/darkpool/bigprints.md b/website/content/bot/reference/discord/darkpool/bigprints.md new file mode 100644 index 000000000000..2596ab670683 --- /dev/null +++ b/website/content/bot/reference/discord/darkpool/bigprints.md @@ -0,0 +1,42 @@ +--- +title: bigprints +description: Bigprints command provides a comprehensive view of the biggest dark pool + and block trades over a specified number of days, offering insights into the market + activity over that period. +keywords: +- bigprints +- dark pool trades +- block trades +- /dp bigprints days +- market activity +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command will retrieve the largest combination of dark pool and block trades over a specified amount of days. It will provide a comprehensive view of the biggest dark pool and block trades over the specified number of days and give the user an idea of the market activity over that period. + +### Usage + +```python wordwrap +/dp bigprints days +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| days | Number of days to look back | False | None | + + +--- + +## Examples + +``` +/dp bigprints days:6 +``` +--- diff --git a/website/content/bot/reference/discord/darkpool/levels.md b/website/content/bot/reference/discord/darkpool/levels.md new file mode 100644 index 000000000000..3f9795d05614 --- /dev/null +++ b/website/content/bot/reference/discord/darkpool/levels.md @@ -0,0 +1,48 @@ +--- +title: levels +description: This page provides information about the 'levels' command that allows + users to retrieve the Biggest Levels for All Prints over the last x days for a given + stock ticker. This command aids in evaluating stock performance. +keywords: +- levels command +- DP levels +- stock ticker +- stock performance +- All Prints +- Biggest Levels +- usage of levels command +- parameters +- examples +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command allows the user to retrieve the Biggest Levels for All Prints over the last x days for the given ticker. This information is useful in assessing the overall performance of the stock, as it provides information on the largest levels of prints over the last x days. + +### Usage + +```python wordwrap +/dp levels ticker days +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| ticker | Stock Ticker | False | None | +| days | Number of days to look back | False | None | + + +--- + +## Examples + +``` +/dp levels ticker:TSLA days:10 +``` + +--- diff --git a/website/content/bot/reference/discord/darkpool/sectors.md b/website/content/bot/reference/discord/darkpool/sectors.md new file mode 100644 index 000000000000..20a25f215fb7 --- /dev/null +++ b/website/content/bot/reference/discord/darkpool/sectors.md @@ -0,0 +1,56 @@ +--- +title: sectors +description: The page provides information on how to use the sectors command, which + allows the user to view a summary of all prints by MarketCap of different sectors + over a given period. The command provides significant insights into the darkpool + activities of different sectors. +keywords: +- sectors command +- MarketCap by Sector +- darkpool activity +- sector's market cap +- accumulation +- Basic Materials +- Energy sector +- Communication Services +- Consumer Cyclical +- Consumer Defensive +- Financial sector +- Healthcare sector +- Industrials +- Real Estate sector +- Technology sector +- Utilities sector +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command allows the user to retrieve a summary of all prints by % of MarketCap by Sector over the last x days. The user will be able to view the sector's market cap divided by total darkpool activity to see possible accumulation. + +### Usage + +```python wordwrap +/dp sectors days sector +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| days | Number of days to look back | False | None | +| sector | Sector to filter by | False | Basic Materials (BM), Energy (E), Communication Services (CS), Consumer Cyclical (CC), Consumer Defensive (CD), Financial (F), Healthcare (H), Industrials (I), Real Estate (RE), Technology (T), Utilities (U) | + + +--- + +## Examples + +``` +/dp sectors days:5 sector:Basic Materials +``` + +--- diff --git a/website/content/bot/reference/discord/darkpool/summary.md b/website/content/bot/reference/discord/darkpool/summary.md new file mode 100644 index 000000000000..024d3a36da66 --- /dev/null +++ b/website/content/bot/reference/discord/darkpool/summary.md @@ -0,0 +1,48 @@ +--- +title: summary +description: Learn how to retrieve a summary of all the prints by percentage of MarketCap + over the last x days, sorted by MarketCap. Understand the usage, parameters, and + see examples. +keywords: +- prints summary +- MarketCap +- Sort by MarketCap +- /dp summary command +- MarketCap over time +- Market analysis +- Financial Data Analysis +- Short Percentage +- Float +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command retrieves a summary of all the prints by percentage of MarketCap over the last x days, sorted by MarketCap. The summary includes the total number of prints and their total percentage of MarketCap, as well as the float and short percentage. + +### Usage + +```python wordwrap +/dp summary days sort +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| days | Number of days to look back | False | None | +| sort | Sort by MarketCap, Float, Total, or Short Percentage | False | MarketCap (mc), Float (float), Total (sum), Short Percentage (short) | + + +--- + +## Examples + +``` +/dp summary days:10 sort:MarketCap +``` + +--- diff --git a/website/content/bot/reference/discord/darkpool/topsum.md b/website/content/bot/reference/discord/darkpool/topsum.md new file mode 100644 index 000000000000..1ca112fa0a4d --- /dev/null +++ b/website/content/bot/reference/discord/darkpool/topsum.md @@ -0,0 +1,43 @@ +--- +title: topsum +description: The documentation page is about the 'topsum' command, which retrieves + a total block and dark pool data summary. It also sums all darkpool prints and provides + a table of the largest data by symbol along with a comparison graph. This command + does not require any parameters. +keywords: +- topsum command +- block and dark pool data summary +- sum darkpool prints +- largest data by symbol +- comparison graph +- command usage +- no parameters command +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command allows the user to retrieve total block and dark pool data summary. It sums all darkpool prints and gives a table of the largest by symbol as well as a graph for comparison. + +### Usage + +```python wordwrap +/dp topsum +``` + +--- + +## Parameters + +This command has no parameters + + +--- + +## Examples + +``` +/dp topsum +``` +--- diff --git a/website/content/bot/reference/discord/discovery/arktrades.md b/website/content/bot/reference/discord/discovery/arktrades.md new file mode 100644 index 000000000000..a09c71778512 --- /dev/null +++ b/website/content/bot/reference/discord/discovery/arktrades.md @@ -0,0 +1,40 @@ +--- +title: arktrades +description: The page provides information about the arktrades command, which allows + user to retrieve a list of all trades made by ARK. +keywords: +- arktrades +- trades +- ARK +- data +- table format +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command allows the user to retrieve a list of all trades made by ARK, including the time and amount of each trade. The data is presented in an easy-to-read table format so that the user can quickly analyze the trades made by ARK. + +### Usage + +```python wordwrap +/disc arktrades +``` + +--- + +## Parameters + +This command has no parameters + + + +--- + +## Examples + +``` +/disc arktrades +``` +--- diff --git a/website/content/bot/reference/discord/discovery/contracts.md b/website/content/bot/reference/discord/discovery/contracts.md new file mode 100644 index 000000000000..f9372c40a79d --- /dev/null +++ b/website/content/bot/reference/discord/discovery/contracts.md @@ -0,0 +1,43 @@ +--- +title: contracts +description: The page provides details on how to retrieve the top 15 Government contracts + by amount for all tickers using the /disc contracts command. It gives insights into + the total value of Government contracts awarded to various companies, helping users + understand their financial health. +keywords: +- contracts +- Government contracts +- tickers +- database +- financial health +- /disc contracts +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command allows the user to retrieve the Top 15 Government contracts by amount for all tickers. This is a helpful tool for those who want to quickly get an overview of the total value of Government contracts awarded to various companies. The data is retrieved from a database of contracts and can be used to gain valuable insights into the financial health of those companies. + +### Usage + +```python wordwrap +/disc contracts +``` + +--- + +## Parameters + +This command has no parameters + + + +--- + +## Examples + +``` +/disc contracts +``` +--- diff --git a/website/content/bot/reference/discord/discovery/fgindex.md b/website/content/bot/reference/discord/discovery/fgindex.md new file mode 100644 index 000000000000..810e61110d04 --- /dev/null +++ b/website/content/bot/reference/discord/discovery/fgindex.md @@ -0,0 +1,45 @@ +--- +title: fgindex +description: The page defines the use of 'fgindex' command in getting the Fear & Greed + Index. This is a key investor sentiment indicator by CNNMoney and offers insights + into the stock market through analysis of momentum, sentiment, and trading volume. +keywords: +- fgindex +- Fear & Greed Index +- investor sentiment indicator +- CNNMoney +- stock market +- market momentum +- market sentiment +- stock trading volume +- score range 0-100 +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command allows the user to retrieve the Fear & Greed Index, which is an investor sentiment indicator published by CNNMoney. The index measures the levels of fear and greed of the investors in the stock market by observing the momentum, sentiment and volume of stock trading. The index ranges from 0 to 100, with 0 being the most fearful and 100 being the most greedy. + +### Usage + +```python wordwrap +/disc fgindex +``` + +--- + +## Parameters + +This command has no parameters + + + +--- + +## Examples + +``` +/disc fgindex +``` +--- diff --git a/website/content/bot/reference/discord/discovery/halts.md b/website/content/bot/reference/discord/discovery/halts.md new file mode 100644 index 000000000000..08b951b85bc6 --- /dev/null +++ b/website/content/bot/reference/discord/discovery/halts.md @@ -0,0 +1,44 @@ +--- +title: halts +description: Improve your trading with the '/disc halts' command, allowing you to + avoid significant losses due to temporary halts. The halt code and time of any halted + or pending stock at the exchange are provided at your fingertips, excluding penny + stocks. +keywords: +- Stock Market +- Stocks +- Pennystocks Exclusion +- /disc halts Command +- Stock Halt Code +- Exchange +- Stock Trading +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command allows the user to retrieve the time and halt code of stocks in the market, excluding penny stocks. The output of this command provides the user with the time and halt code of stock that is currently halted or in the process of being halted by the exchange. + +### Usage + +```python wordwrap +/disc halts +``` + +--- + +## Parameters + +This command has no parameters + + + +--- + +## Examples + +``` +/disc halts +``` +--- diff --git a/website/content/bot/reference/discord/discovery/holidays.md b/website/content/bot/reference/discord/discovery/holidays.md new file mode 100644 index 000000000000..b6664dae39f1 --- /dev/null +++ b/website/content/bot/reference/discord/discovery/holidays.md @@ -0,0 +1,40 @@ +--- +title: holidays +description: The page provides detailed guidance on how to use the 'holidays' command + to retrieve a list of upcoming market holidays, including their dates and types. + This is particularly useful for users seeking to stay informed about upcoming events. +keywords: +- holidays +- market holidays +- upcoming holidays +- national holidays +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command allows the user to retrieve a list of upcoming market holidays. The command will return a list of holidays, including their respective dates, along with any other pertinent details, such as whether they are national holidays or not. This command is suitable for any user who needs to stay up to date with upcoming holidays. + +### Usage + +```python wordwrap +/disc holidays +``` + +--- + +## Parameters + +This command has no parameters + + + +--- + +## Examples + +``` +/disc holidays +``` +--- diff --git a/website/content/bot/reference/discord/discovery/house.md b/website/content/bot/reference/discord/discovery/house.md new file mode 100644 index 000000000000..c6eec79d3fce --- /dev/null +++ b/website/content/bot/reference/discord/discovery/house.md @@ -0,0 +1,44 @@ +--- +title: house +description: This page provides a detailed explanation of the 'house' command in our + platform, including its usage, parameters, and examples. +keywords: +- house command +- recent house trades +- trade time +- trade size +- trade price +- command parameters +- command usage +- command examples +- retrieve trades +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command allows users to retrieve recent house trades for all tickers. The command will display the time of the trade, the ticker, the size of the trade, the price, and any other relevant details. + +### Usage + +```python wordwrap +/disc house +``` + +--- + +## Parameters + +This command has no parameters + + + +--- + +## Examples + +``` +/disc house +``` +--- diff --git a/website/content/bot/reference/discord/discovery/ipolist.md b/website/content/bot/reference/discord/discovery/ipolist.md new file mode 100644 index 000000000000..feb31a2c586a --- /dev/null +++ b/website/content/bot/reference/discord/discovery/ipolist.md @@ -0,0 +1,44 @@ +--- +title: ipolist +description: The ipolist command page provides details on how to use the command to + get the latest and upcoming Initial Public Offerings (IPOs) information. The information + includes the name of the company, IPO date, and the stock exchange. +keywords: +- ipolist command +- initial public offerings +- IPO updates +- new companies +- stock exchange +- investment opportunities +- upcoming IPOs +- latest IPOs +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command allows the user to view 10 of the most recent and upcoming Initial Public Offerings (IPOs) including the company name, the IPO date, and the stock exchange. This information can help users stay up-to-date with the latest IPOs, and provide them with opportunities to invest in new companies. + +### Usage + +```python wordwrap +/disc ipolist +``` + +--- + +## Parameters + +This command has no parameters + + + +--- + +## Examples + +``` +/disc ipolist +``` +--- diff --git a/website/content/bot/reference/discord/discovery/senate.md b/website/content/bot/reference/discord/discovery/senate.md new file mode 100644 index 000000000000..772e9f7c3372 --- /dev/null +++ b/website/content/bot/reference/discord/discovery/senate.md @@ -0,0 +1,41 @@ +--- +title: senate +description: This page provides comprehensive information on the 'senate' command + used to retrieve the most recent senate trades for all tickers. It includes details + on usage, parameters, and examples. +keywords: +- senate command +- trade retrieval +- ticker information +- price information +- command usage +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command retrieves the most recent senate trades for all tickers including the date and time of the trade and the price information. + +### Usage + +```python wordwrap +/disc senate +``` + +--- + +## Parameters + +This command has no parameters + + + +--- + +## Examples + +``` +/disc senate +``` +--- diff --git a/website/content/bot/reference/discord/discovery/splits.md b/website/content/bot/reference/discord/discovery/splits.md new file mode 100644 index 000000000000..90a92ce061dd --- /dev/null +++ b/website/content/bot/reference/discord/discovery/splits.md @@ -0,0 +1,44 @@ +--- +title: splits +description: The page provides a guide on using the /disc splits command to view a + list of recent stock splits for all available tickers. It also provides insights + on how to track past stock splits using this data. The information includes the + ticker, date, and ratio of the split. +keywords: +- stock splits +- view stock splits +- track stock splits +- /disc splits +- stock splits data +- ticker data +- split ratio +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command allows users to view a list of recent stock splits for all available tickers. This list includes the ticker, the date of the split, and the ratio of the split. This data can be used to track how stocks have been split in the past. + +### Usage + +```python wordwrap +/disc splits +``` + +--- + +## Parameters + +This command has no parameters + + + +--- + +## Examples + +``` +/disc splits +``` +--- diff --git a/website/content/bot/reference/discord/discovery/trendingst.md b/website/content/bot/reference/discord/discovery/trendingst.md new file mode 100644 index 000000000000..180e03c47645 --- /dev/null +++ b/website/content/bot/reference/discord/discovery/trendingst.md @@ -0,0 +1,42 @@ +--- +title: trendingst +description: The docusaurus page explains how to use the 'trendingst' command to retrieve + the top 15 trending stocks from StockTwits. It covers details on how the command + works, its usage, and provides examples. +keywords: +- trending stocks +- stocktwits +- most discussed stocks +- popular stocks +- stock market trends +- /disc trendingst +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command allows the user to retrieve the top 15 trending stocks from StockTwits according to the most recent discussions. The stocks are displayed in order of most trending, as determined by the most discussed stocks in the StockTwits community. This command is an efficient way to stay up to date on the most popular stocks in the market. + +### Usage + +```python wordwrap +/disc trendingst +``` + +--- + +## Parameters + +This command has no parameters + + + +--- + +## Examples + +``` +/disc trendingst +``` +--- diff --git a/website/content/bot/reference/discord/discovery/wsb.md b/website/content/bot/reference/discord/discovery/wsb.md new file mode 100644 index 000000000000..b68f1e07b938 --- /dev/null +++ b/website/content/bot/reference/discord/discovery/wsb.md @@ -0,0 +1,43 @@ +--- +title: wsb +description: Learn how to view the top 15 trending stocks on r/WallStreetBets (WSB) + by using the '/disc wsb' command. It provides mentions count for popular stocks, + offering insights into the latest trends. +keywords: +- wsb command +- trending stocks +- Mentions count +- /disc wsb +- WallStreetBets +- Popular stocks +- Command parameters +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command allows the user to view the top 15 trending stocks on r/WallStreetBets (WSB) using the /disc wsb command. It displays the mentions count for popular stocks on the platform. + +### Usage + +```python wordwrap +/disc wsb +``` + +--- + +## Parameters + +This command has no parameters + + + +--- + +## Examples + +``` +/disc wsb +``` +--- diff --git a/website/content/bot/reference/discord/duedilligence/ah.md b/website/content/bot/reference/discord/duedilligence/ah.md new file mode 100644 index 000000000000..20cb680094cb --- /dev/null +++ b/website/content/bot/reference/discord/duedilligence/ah.md @@ -0,0 +1,44 @@ +--- +title: ah +description: Documentation for the 'ah' command for retrieving afterhours data for + a specific stock ticker, with usage, parameters, and examples. +keywords: +- Afterhours data +- Stock ticker +- Current stock price +- Highest and lowest prices +- Trade volume +- Market change +- Command usage +- Python command +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command allows the user to retrieve afterhours data for a given stock ticker. The data retrieved will include the stock's current price, the highest and lowest prices of the ah session, the volume traded, and the change in the afterhours market. + +### Usage + +```python wordwrap +/dd ah ticker +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| ticker | Stock Ticker | False | None | + + +--- + +## Examples + +``` +/dd ah ticker:AMD +``` +--- diff --git a/website/content/bot/reference/discord/duedilligence/analyst.md b/website/content/bot/reference/discord/duedilligence/analyst.md new file mode 100644 index 000000000000..cc6bfea3dcd9 --- /dev/null +++ b/website/content/bot/reference/discord/duedilligence/analyst.md @@ -0,0 +1,41 @@ +--- +title: analyst +description: The page defines the usage of the command 'analyst', which allows users + to retrieve analyst recommendations for a specific stock ticker. Examples include + finding recommendations for AMD stocks. +keywords: +- analyst command +- stock ticker +- retrieve analyst recommendations +- AMD stock +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command allows the user to retrieve analyst recommendations for a given stock ticker. + +### Usage + +```python wordwrap +/dd analyst ticker +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| ticker | Stock Ticker | False | None | + + +--- + +## Examples + +``` +/dd analyst ticker:AMD +``` +--- diff --git a/website/content/bot/reference/discord/duedilligence/bio.md b/website/content/bot/reference/discord/duedilligence/bio.md new file mode 100644 index 000000000000..fa1cb032cfb0 --- /dev/null +++ b/website/content/bot/reference/discord/duedilligence/bio.md @@ -0,0 +1,46 @@ +--- +title: bio +description: This page provides information about 'bio' command that fetches a stock's + company info such as name, description, sector, industry, CEO, etc. using a stock + ticker. +keywords: +- bio command +- stock's company info +- stock ticker +- stock information +- company's name +- company's description +- company's sector +- company's industry +- company's CEO +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command retrieves a stock's company information and displays it to the user. It takes a stock ticker as an argument and returns information such as the company's name, description, sector, industry, CEO, and more. + +### Usage + +```python wordwrap +/dd bio ticker +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| ticker | Stock Ticker | False | None | + + +--- + +## Examples + +``` +/dd bio ticker:AMD +``` +--- diff --git a/website/content/bot/reference/discord/duedilligence/customer.md b/website/content/bot/reference/discord/duedilligence/customer.md new file mode 100644 index 000000000000..ba3d28a83297 --- /dev/null +++ b/website/content/bot/reference/discord/duedilligence/customer.md @@ -0,0 +1,44 @@ +--- +title: customer +description: The page provides how to use the 'customer' command to display the customers + of a company using a specific stock ticker. It includes a description of parameters + and usage examples. +keywords: +- customer command +- display customers +- company customers +- stock ticker +- usage of customer command +- parameters +- examples +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command allows the user to display customers of the company using the given symbol. + +### Usage + +```python wordwrap +/dd customer ticker +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| ticker | Stock Ticker | False | None | + + +--- + +## Examples + +``` +/dd customer ticker:AMD +``` +--- diff --git a/website/content/bot/reference/discord/duedilligence/divinfo.md b/website/content/bot/reference/discord/duedilligence/divinfo.md new file mode 100644 index 000000000000..8250d437bf5a --- /dev/null +++ b/website/content/bot/reference/discord/duedilligence/divinfo.md @@ -0,0 +1,45 @@ +--- +title: divinfo +description: This page provides information about using the 'divinfo' command to retrieve + dividend data, including rate, yield, and ex-div date for a specified stock ticker. +keywords: +- divinfo +- dividend information +- stock +- dividend rate +- yield +- ex-div date +- parameters +- stock ticker +- AAPL +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command retrieves dividend information for a given stock. The data includes dividend rate, yield, and ex-div date. + +### Usage + +```python wordwrap +/dd divinfo ticker +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| ticker | Stock Ticker | False | None | + + +--- + +## Examples + +``` +/dd divinfo ticker:AAPL +``` +--- diff --git a/website/content/bot/reference/discord/duedilligence/earnings.md b/website/content/bot/reference/discord/duedilligence/earnings.md new file mode 100644 index 000000000000..ae522b055b7f --- /dev/null +++ b/website/content/bot/reference/discord/duedilligence/earnings.md @@ -0,0 +1,43 @@ +--- +title: earnings +description: Details on how to use the 'earnings' command to retrieve anticipated + earnings for a specified business day. Information includes company ticker, expected + time, sector, and float facilitating informed investment decisions. +keywords: +- earnings +- investment decisions +- company ticker +- business day +- sector +- float +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command allows the user to retrieve the expected earnings for the given business day. The displayed earnings will include company ticker, expected time, sector, and float of the company. This information can be used to help the user make informed decisions about their investments. + +### Usage + +```python wordwrap +/dd earnings day +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| day | Date to get earnings for (YYYY-MM-DD) | False | None | + + +--- + +## Examples + +``` +/dd earnings day:2022-07-29 +``` +--- diff --git a/website/content/bot/reference/discord/duedilligence/ermove.md b/website/content/bot/reference/discord/duedilligence/ermove.md new file mode 100644 index 000000000000..bd69b94073ef --- /dev/null +++ b/website/content/bot/reference/discord/duedilligence/ermove.md @@ -0,0 +1,45 @@ +--- +title: ermove +description: The documentation page provides a detailed explanation of the ermove + command that allows users to fetch the implied stock move based on current option + prices. It also guides on using the stock ticker to retrieve this information. +keywords: +- ermove command +- retrieve implied move +- stock +- option prices +- stock movement measure +- option's expiration +- stock ticker +- stock market +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command allows the user to retrieve the implied move for a stock based on the current option prices. The implied move is a measure of how far the stock is expected to move during the option's expiration. + +### Usage + +```python wordwrap +/dd ermove ticker +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| ticker | Stock Ticker | False | None | + + +--- + +## Examples + +``` +/dd ermove ticker:AMD +``` +--- diff --git a/website/content/bot/reference/discord/duedilligence/est.md b/website/content/bot/reference/discord/duedilligence/est.md new file mode 100644 index 000000000000..bd9cf1cf192d --- /dev/null +++ b/website/content/bot/reference/discord/duedilligence/est.md @@ -0,0 +1,42 @@ +--- +title: est +description: Detailed guide on how to retrieve earning estimates with the 'est' command + for various stock symbols. Ideal for investors seeking insights on potential stock + performance. +keywords: +- est command guide +- earning estimates +- stock symbols +- investor tools +- stock performance +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command allows the user to retrieve earning estimates for a given stock symbol. This can be used as a helpful tool for investors to get an idea of how a stock may perform in terms of earnings. + +### Usage + +```python wordwrap +/dd est ticker +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| ticker | Stock Ticker | False | None | + + +--- + +## Examples + +``` +/dd est ticker:MMM +``` +--- diff --git a/website/content/bot/reference/discord/duedilligence/financials.md b/website/content/bot/reference/discord/duedilligence/financials.md new file mode 100644 index 000000000000..242930e49bbd --- /dev/null +++ b/website/content/bot/reference/discord/duedilligence/financials.md @@ -0,0 +1,45 @@ +--- +title: financials +description: This page provides information on the financials command which retrieves + total assets, cash, debt, liabilities, and revenue of a company using its stock + ticker. The data can be used to analyze a company's financial health. +keywords: +- financials +- total assets +- cash +- debt +- liabilities +- revenue +- company financial health +- stock +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command will retrieve the financials of the company with the given ticker which includes total assets, cash, debt, liabilities, and revenue. This information can be used to analyze the financial health of the company. + +### Usage + +```python wordwrap +/dd financials ticker +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| ticker | Stock Ticker | False | None | + + +--- + +## Examples + +``` +/dd financials ticker:AMD +``` +--- diff --git a/website/content/bot/reference/discord/duedilligence/insiders.md b/website/content/bot/reference/discord/duedilligence/insiders.md new file mode 100644 index 000000000000..f7b2b7218bf0 --- /dev/null +++ b/website/content/bot/reference/discord/duedilligence/insiders.md @@ -0,0 +1,44 @@ +--- +title: insiders +description: The Insiders page allows users to retrieve the 15 most recent insider + transactions for a given stock, including the date of the transaction, the insider + involved, the number of shares traded, the type of transaction, and the average + price. You can run this command by entering '/dd insiders ticker:'. +keywords: +- insiders command +- recent insider transactions +- stock information +- shares traded +- transaction type +- average price +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command allows the user to retrieve the 15 most recent insider transactions for a given stock. It will provide information such as the date of the transaction, the company insider involved, the number of shares traded, the type of transaction (buy/sell), and the average price of the transaction. + +### Usage + +```python wordwrap +/dd insiders ticker +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| ticker | Stock Ticker | False | None | + + +--- + +## Examples + +``` +/dd insiders ticker:AMD +``` +--- diff --git a/website/content/bot/reference/discord/duedilligence/instholdings.md b/website/content/bot/reference/discord/duedilligence/instholdings.md new file mode 100644 index 000000000000..ba437be89308 --- /dev/null +++ b/website/content/bot/reference/discord/duedilligence/instholdings.md @@ -0,0 +1,43 @@ +--- +title: instholdings +description: This page provides details on the instholdings command which retrieves + the top 15 institutional holdings for a given stock, as reported to the United States + Securities and Exchange Commission. +keywords: +- instholdings command +- institutional holdings +- stock +- United States Securities and Exchange Commission +- SEC +- stock ticker +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command allows the user to retrieve the top 15 institutional holdings for a given stock. This list is retrieved from the most recent available institutional holdings reported to the United States Securities and Exchange Commission. + +### Usage + +```python wordwrap +/dd instholdings ticker +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| ticker | Stock Ticker | False | None | + + +--- + +## Examples + +``` +/dd instholdings ticker:AMD +``` +--- diff --git a/website/content/bot/reference/discord/duedilligence/nexter.md b/website/content/bot/reference/discord/duedilligence/nexter.md new file mode 100644 index 000000000000..d9201bd06d29 --- /dev/null +++ b/website/content/bot/reference/discord/duedilligence/nexter.md @@ -0,0 +1,42 @@ +--- +title: nexter +description: This document provides guidance on how to use the nexter command to retrieve + the next earnings date for a provided stock ticker symbol. Examples include usage + with AMD stock. +keywords: +- nexter command +- earnings date +- stock ticker symbol +- financial data +- AMD stock +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command will retrieve the next earnings date for the given stock ticker symbol. + +### Usage + +```python wordwrap +/dd nexter ticker +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| ticker | Stock Ticker | False | None | + + +--- + +## Examples + +``` +/dd nexter ticker:AMD +``` +--- diff --git a/website/content/bot/reference/discord/duedilligence/pm.md b/website/content/bot/reference/discord/duedilligence/pm.md new file mode 100644 index 000000000000..04198d3ac689 --- /dev/null +++ b/website/content/bot/reference/discord/duedilligence/pm.md @@ -0,0 +1,41 @@ +--- +title: pm +description: This page describes the command that retrieves premarket data for a given + stock ticker. It is a valuable resource for those keen on understanding a stock's + performance before the regular market commences. +keywords: +- stock +- premarket data +- stock ticker +- market performance +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command allows the user to retrieve premarket data for a given stock ticker. It will fetch the latest price, the premarket change, and the premarket percentage change of the selected stock. This is useful for those who want to get an idea of the stock's performance before the regular market opens. + +### Usage + +```python wordwrap +/dd pm ticker +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| ticker | Stock Ticker | False | None | + + +--- + +## Examples + +``` +/dd pm ticker:AMD +``` +--- diff --git a/website/content/bot/reference/discord/duedilligence/pt.md b/website/content/bot/reference/discord/duedilligence/pt.md new file mode 100644 index 000000000000..172e908a27e6 --- /dev/null +++ b/website/content/bot/reference/discord/duedilligence/pt.md @@ -0,0 +1,44 @@ +--- +title: pt +description: This documentation page contains information about the pt command for + retrieving a chart with stock price targets. By using this command, users can obtain + crucial information about the current price, target prices, and analyst ratings + of a specified ticker, thus enabling them to make more informed decisions. +keywords: +- pt command +- stock price targets +- current price +- target prices +- analyst ratings +- informed decisions +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command allows the user to retrieve a chart with price targets for the specified ticker. The chart will provide information on the current price, target prices and analyst ratings, allowing the user to make more informed decisions. + +### Usage + +```python wordwrap +/dd pt ticker +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| ticker | Stock Ticker | False | None | + + +--- + +## Examples + +``` +/dd pt ticker:AMD +``` +--- diff --git a/website/content/bot/reference/discord/duedilligence/sec.md b/website/content/bot/reference/discord/duedilligence/sec.md new file mode 100644 index 000000000000..d2b2ef721883 --- /dev/null +++ b/website/content/bot/reference/discord/duedilligence/sec.md @@ -0,0 +1,52 @@ +--- +title: sec +description: The sec documentation page details how to use a feature for retrieving + the latest SEC filings related to a specific ticker symbol. Information available + includes company financials, registration statements, and periodic reports such + as 10-Ks, 8-Ks, and 10-Qs. Useful for investors and analysts needing current data + on a company's financial performance or other corporate documents. +keywords: +- sec command +- retrieve SEC filings +- financial performance +- corporate documents +- stock ticker +- company financials +- 10-Ks +- 8-Ks +- 10-Qs +- registration statements +- investors +- analysts +- periodic reports +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command allows the user to retrieve the most recent SEC filings related to the specified ticker symbol. The filings can include company financials, registration statements, and periodic reports such as 10-Ks, 8-Ks, and 10-Qs. This command is especially useful for investors and analysts who need up-to-date information on a company's financial performance or other corporate documents. + +### Usage + +```python wordwrap +/dd sec ticker +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| ticker | Stock Ticker | False | None | + + +--- + +## Examples + +``` +/dd sec ticker:AMD +``` +--- diff --git a/website/content/bot/reference/discord/duedilligence/splits.md b/website/content/bot/reference/discord/duedilligence/splits.md new file mode 100644 index 000000000000..3d5decf54e0c --- /dev/null +++ b/website/content/bot/reference/discord/duedilligence/splits.md @@ -0,0 +1,41 @@ +--- +title: splits +description: Learn how to use the splits command in Docusaurus to track recent stock + splits for a given ticker over time. Detailed usage and examples provided. +keywords: +- stock splits +- tracking stock splits +- stock ticker +- docusaurus command for stock splits +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command retrieves a list of recent stock splits for a given ticker. This command is useful for tracking the splits of a particular stock over time. + +### Usage + +```python wordwrap +/dd splits ticker +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| ticker | Stock Ticker | False | None | + + +--- + +## Examples + +``` +/dd splits ticker:AMD +``` + +--- diff --git a/website/content/bot/reference/discord/duedilligence/supplier.md b/website/content/bot/reference/discord/duedilligence/supplier.md new file mode 100644 index 000000000000..6a69ce5231cf --- /dev/null +++ b/website/content/bot/reference/discord/duedilligence/supplier.md @@ -0,0 +1,41 @@ +--- +title: supplier +description: This page provides information on the 'supplier' command, which allows + users to retrieve the list of suppliers associated with a stock ticker. Usage, parameters, + and examples are included for a clear understanding. +keywords: +- supplier +- stock +- company supplier retrieval +- AMD +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command allows users to retrieve the list of suppliers associated with the company with the given ticker. + +### Usage + +```python wordwrap +/dd supplier ticker +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| ticker | Stock Ticker | False | None | + + +--- + +## Examples + +``` +/dd supplier ticker:AMD +``` +--- diff --git a/website/content/bot/reference/discord/duedilligence/ytd.md b/website/content/bot/reference/discord/duedilligence/ytd.md new file mode 100644 index 000000000000..d2658d100cf4 --- /dev/null +++ b/website/content/bot/reference/discord/duedilligence/ytd.md @@ -0,0 +1,41 @@ +--- +title: ytd +description: A documentation page explaining the 'ytd' command that retrieves the + year-to-date performance for a particular stock's ticker symbol. Includes usage, + parameter information, and examples. +keywords: +- ytd command +- stock performance +- ticker symbol +- AAPL +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command allows the user to retrieve the stock's year-to-date performance for a particular ticker symbol. It displays the stock's performance over various periods of time, from 5 days to 5 years. + +### Usage + +```python wordwrap +/dd ytd ticker +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| ticker | Stock Ticker | False | None | + + +--- + +## Examples + +``` +/dd ytd ticker:AAPL +``` +--- diff --git a/website/content/bot/reference/discord/economy/calendar.md b/website/content/bot/reference/discord/economy/calendar.md new file mode 100644 index 000000000000..69731924970a --- /dev/null +++ b/website/content/bot/reference/discord/economy/calendar.md @@ -0,0 +1,41 @@ +--- +title: calendar +description: Get an Economic Calendar for the day and read about the key economic + indicators with the /econ calendar command. +keywords: +- economic calendar +- economic events +- economic indicators +- GDP +- inflation +- employment +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command allows the user to retrieve an Economic Calendar for the day, which displays the upcoming economic events along with their expected impact. The Economic Calendar includes a list of key economic indicators such as GDP, inflation, employment, and more, which can provide insight into the future trajectory of the economy. + +### Usage + +```python wordwrap +/econ calendar +``` + +--- + +## Parameters + +This command has no parameters + + + +--- + +## Examples + +``` +/econ calendar +``` +--- diff --git a/website/content/bot/reference/discord/economy/commodities.md b/website/content/bot/reference/discord/economy/commodities.md new file mode 100644 index 000000000000..73c4bf2a7e9e --- /dev/null +++ b/website/content/bot/reference/discord/economy/commodities.md @@ -0,0 +1,42 @@ +--- +title: commodities +description: This page provides instructions on how to use the commodities command + to easily get an overview of Futures and commodities prices and changes on our trading + platform. +keywords: +- commodities +- Futures +- prices +- trading +- changes +- command usage +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command allows users to quickly and easily retrieve an overview of Futures and commodities. It provides the last price and change for the day. + +### Usage + +```python wordwrap +/econ commodities +``` + +--- + +## Parameters + +This command has no parameters + + + +--- + +## Examples + +``` +/econ commodities +``` +--- diff --git a/website/content/bot/reference/discord/economy/currencies.md b/website/content/bot/reference/discord/economy/currencies.md new file mode 100644 index 000000000000..1a3164cc584c --- /dev/null +++ b/website/content/bot/reference/discord/economy/currencies.md @@ -0,0 +1,43 @@ +--- +title: currencies +description: The /econ currencies command page where users learn how to retrieve an + overview of all available currencies including information such as name, price, + and changes. +keywords: +- currencies +- command overview +- currency name +- currency price +- /econ currencies +- change +- no parameters +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command allows the user to retrieve an overview of all available currencies. It will provide the user with information such as the currency name, price, and change. + +### Usage + +```python wordwrap +/econ currencies +``` + +--- + +## Parameters + +This command has no parameters + + + +--- + +## Examples + +``` +/econ currencies +``` +--- diff --git a/website/content/bot/reference/discord/economy/fedrates.md b/website/content/bot/reference/discord/economy/fedrates.md new file mode 100644 index 000000000000..9a9fbacd04c2 --- /dev/null +++ b/website/content/bot/reference/discord/economy/fedrates.md @@ -0,0 +1,41 @@ +--- +title: fedrates +description: The fedrates command allows users to retrieve upcoming Federal Rate decision + dates and chances. Stay updated with crucial financial information easily. +keywords: +- fedrates command +- Federal Rate decision dates +- chances of Federal Rate decisions +- stay up to date with Federal Rate decisions +- /econ fedrates +- no parameters command +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command allows users to quickly and easily retrieve upcoming Federal Rate decision dates and chances. It is a convenient way to stay up to date with Federal Rate decisions. + +### Usage + +```python wordwrap +/econ fedrates +``` + +--- + +## Parameters + +This command has no parameters + + + +--- + +## Examples + +``` +/econ fedrates +``` +--- diff --git a/website/content/bot/reference/discord/economy/glbonds.md b/website/content/bot/reference/discord/economy/glbonds.md new file mode 100644 index 000000000000..499569007be8 --- /dev/null +++ b/website/content/bot/reference/discord/economy/glbonds.md @@ -0,0 +1,43 @@ +--- +title: glbonds +description: The glbonds command page provides information about the retrieval of + an overview of global bonds which includes details such as type of bond, rate of + return, yield, and yield change. This command is fundamental in making informed + decisions about investing in global bonds. +keywords: +- glbonds command +- global bonds +- rate of return +- yield +- yield change +- investing in global bonds +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command allows the user to retrieve an overview of global bonds. It includes information about the type of bond, the rate of return, yield, and yield change. The data is presented in an easy to read format and can be used to inform decisions about investing in global bonds. + +### Usage + +```python wordwrap +/econ glbonds +``` + +--- + +## Parameters + +This command has no parameters + + + +--- + +## Examples + +``` +/econ glbonds +``` +--- diff --git a/website/content/bot/reference/discord/economy/indices.md b/website/content/bot/reference/discord/economy/indices.md new file mode 100644 index 000000000000..c348c7b0f4c6 --- /dev/null +++ b/website/content/bot/reference/discord/economy/indices.md @@ -0,0 +1,44 @@ +--- +title: indices +description: This page provides a command for a real-time overview of major US stock + indices like the Dow Jones Industrial Average, S&P 500, and NASDAQ Composite. It + shows current index values with percentage changes. +keywords: +- indices +- US stock indices +- Dow Jones Industrial Average +- S&P 500 +- NASDAQ Composite +- index values +- percentage change +- real-time overview +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command provides a real-time overview of the major US stock indices, such as the Dow Jones Industrial Average, the S&P 500, and the NASDAQ Composite. It displays the most current index values, as well as the percentage change from the previous day. + +### Usage + +```python wordwrap +/econ indices +``` + +--- + +## Parameters + +This command has no parameters + + + +--- + +## Examples + +``` +/econ indices +``` +--- diff --git a/website/content/bot/reference/discord/economy/revrepo.md b/website/content/bot/reference/discord/economy/revrepo.md new file mode 100644 index 000000000000..f8d7f27f242b --- /dev/null +++ b/website/content/bot/reference/discord/economy/revrepo.md @@ -0,0 +1,47 @@ +--- +title: revrepo +description: On this page, you can understand how to use the '/econ revrepo' command + to retrieve Reverse Repo data with flexibility on the number of days, specifically + catering to your needs. +keywords: +- RevRepo +- /econ revrepo +- Retrieving Reverse Repo data +- Command Usage +- Parameters +- Examples +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command allows the user to retrieve Reverse Repo data for a default period of 35 days. This data includes information such as the total amount of Reverse Repo, the number of parties, the average, and difference. + +### Usage + +```python wordwrap +/econ revrepo [days] +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| days | Number of days to display. Default: 50 | True | None | + + +--- + +## Examples + +``` +/econ revrepo days:35 +``` + +``` +/econ revrepo +``` +--- diff --git a/website/content/bot/reference/discord/economy/usbonds.md b/website/content/bot/reference/discord/economy/usbonds.md new file mode 100644 index 000000000000..3fbd759f3ad1 --- /dev/null +++ b/website/content/bot/reference/discord/economy/usbonds.md @@ -0,0 +1,44 @@ +--- +title: usbonds +description: The usbonds command page provides information on retrieving an overview + of US bonds ranging from 1-Month to 30-Year bonds, including the most recent bond + rates, yields, and changes. +keywords: +- US bonds +- bond rates +- bond yields +- usbonds command +- economic data +- financial markets +- economy +- money market +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command retrieves an overview of US bonds from the 1-Month to 30-Year bonds, providing the user with a list of the most recent bond rates, yields and change. + +### Usage + +```python wordwrap +/econ usbonds +``` + +--- + +## Parameters + +This command has no parameters + + + +--- + +## Examples + +``` +/econ usbonds +``` +--- diff --git a/website/content/bot/reference/discord/economy/yieldcurve.md b/website/content/bot/reference/discord/economy/yieldcurve.md new file mode 100644 index 000000000000..f16835222e63 --- /dev/null +++ b/website/content/bot/reference/discord/economy/yieldcurve.md @@ -0,0 +1,41 @@ +--- +title: yieldcurve +description: The page provides information on how to use the yieldcurve command to + retrieve the US Bonds yield curve, which gives an indication of the direction of + interest rates. +keywords: +- yieldcurve +- US Bonds +- interest rates +- /econ yieldcurve +- economics command +- financial data +- data retrieval +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command allows the user to retrieve the US Bonds yield curve. The yield curve is a graph that plots the yields of different bonds with different maturities, providing an indication of the direction of interest rates. + +### Usage + +```python wordwrap +/econ yieldcurve +``` + +--- + +## Parameters + +This command has no parameters + +--- + +## Examples + +``` +/econ yieldcurve +``` +--- diff --git a/website/content/bot/reference/discord/etf/holdings.md b/website/content/bot/reference/discord/etf/holdings.md new file mode 100644 index 000000000000..fe18738eb63f --- /dev/null +++ b/website/content/bot/reference/discord/etf/holdings.md @@ -0,0 +1,42 @@ +--- +title: holdings +description: The metadata for this page is optimized for SEO and pertains to the holdings + for an ETF, including its use, parameters and examples, using a specific command. +keywords: +- etf +- holdings +- ETF ticker +- usage +- parameters +- examples +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command returns the holdings for an ETF sorted by percent of ETF. + +### Usage + +```python wordwrap +/etf holdings [etf] +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| etf | ETF ticker (only for `holdings`) | True | None | + + +--- + +## Examples + +``` +/etf holdings SPY +``` +--- diff --git a/website/content/bot/reference/discord/etf/tops.md b/website/content/bot/reference/discord/etf/tops.md new file mode 100644 index 000000000000..bcd5d1e82f60 --- /dev/null +++ b/website/content/bot/reference/discord/etf/tops.md @@ -0,0 +1,43 @@ +--- +title: tops +description: The 'etf tops' command page gives advice on how to get the top ETFs of + the day with options to sort by gainers, losers, or active. Defaults to gainers + if no sort options are provided. +keywords: +- etf tops +- gainers +- losers +- active +- sort options +- ETF command +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command returns the top ETFs for the day - sorted by gainers, losers, or active. + +### Usage + +```python wordwrap +/etf tops [sort] +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| sort | Possible sort options to run. If not provided, defaults to gainers | True | gainers, losers, active | + + +--- + +## Examples + +``` +/etf tops +``` +--- diff --git a/website/content/bot/reference/discord/flow/bigflow.md b/website/content/bot/reference/discord/flow/bigflow.md new file mode 100644 index 000000000000..d397ddeb2cd3 --- /dev/null +++ b/website/content/bot/reference/discord/flow/bigflow.md @@ -0,0 +1,45 @@ +--- +title: bigflow +description: Detailed documentation on the use of the 'bigflow' command to retrieve + the top 20 largest flows by premium for a stock. Learn how to use it, understand + its parameters, and see examples to better your trading strategies. +keywords: +- bigflow command +- stock trading +- largest flow by premium +- trading strategy +- stock ticker +- option price +- trade volume +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command retrieves the top 20 largest flow by premium for a stock. We calculate the largest flow by multiplying the price of the option at the time of the trade by the volume of that trade. + +### Usage + +```python wordwrap +/flow bigflow ticker +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| ticker | Stock Ticker | False | None | + + +--- + +## Examples + +``` +/flow bigflow ticker:AMD +``` + +--- diff --git a/website/content/bot/reference/discord/flow/day.md b/website/content/bot/reference/discord/flow/day.md new file mode 100644 index 000000000000..746723519944 --- /dev/null +++ b/website/content/bot/reference/discord/flow/day.md @@ -0,0 +1,61 @@ +--- +title: day +description: This documentation page provides detailed instructions on how to use + the 'day' command to retrieve the most recent flow for a stock with a specified + ticker symbol. It includes a description of optional and mandatory parameters and + provides real-world usage examples. +keywords: +- stock market +- day command +- flow data +- ticker symbol +- expiry date +- strike price +- option type +- stock trading +- commands +- parameter +- examples +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command retrieves the most recent flow for a stock with the specified ticker symbol. The command will return the most up-to-date flow data for that stock over $25,000. + +### Usage + +```python wordwrap +/flow day ticker [expiry] [strike] [opt_type] +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| ticker | Stock Ticker | False | None | +| expiry | Expiry Date (YYYY-MM-DD) (Optional) | True | None | +| strike | Strike Price (Optional) | True | None | +| opt_type | Option Type (Calls or Puts) (Optional) | True | Calls (C), Puts (P) | + + +--- + +## Examples + +``` +/flow day ticker:AMD +``` + +``` +/flow day ticker:AMD expiry:2022-07-29 strike:60 opt_type:Puts +``` + +``` +/flow day ticker:AMD expiry:2022-07-29 strike:60 +``` + +--- diff --git a/website/content/bot/reference/discord/flow/opening.md b/website/content/bot/reference/discord/flow/opening.md new file mode 100644 index 000000000000..2798154b0def --- /dev/null +++ b/website/content/bot/reference/discord/flow/opening.md @@ -0,0 +1,46 @@ +--- +title: opening +description: Improve your stock market command game with this detailed guide on retrieving + the Top 20 flows by premium for a stock with an Opening condition - where Volume + exceeds Open Interest on the trade. Learn how to use trade parameters effectively, + with specific instructions on using the Stock Ticker parameter. Suitable for both + beginners and advanced traders. +keywords: +- Stock market commands +- Stock information retrieval +- Top 20 flows by premium +- Opening condition +- Volume exceeding Open Interest +- Trade parameters +- Stock Ticker +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command allows the user to retrieve the Top 20 flows by premium for a stock with the Opening condition - Volume exceeding Open Interest on the trade. + +### Usage + +```python wordwrap +/flow opening ticker +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| ticker | Stock Ticker | False | None | + + +--- + +## Examples + +``` +/flow opening ticker:AMD +``` +--- diff --git a/website/content/bot/reference/discord/flow/prem.md b/website/content/bot/reference/discord/flow/prem.md new file mode 100644 index 000000000000..75292222e33c --- /dev/null +++ b/website/content/bot/reference/discord/flow/prem.md @@ -0,0 +1,45 @@ +--- +title: prem +description: The page discusses the 'prem' command used for retrieving a chart displaying + the sum of premium for call/put options for a specific ticker. It provides usage + details, parameters, and examples for newcomers or experienced users to visualize + the changing premium amounts over time. +keywords: +- prem command +- options premium +- call/put options +- stock ticker +- premium chart +- /flow prem usage +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command allows the user to retrieve a chart displaying the sum of premium for call/put options for a particular ticker on a daily basis. This chart will help users quickly and easily visualize the changing premium amounts over time. + +### Usage + +```python wordwrap +/flow prem ticker +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| ticker | Stock Ticker | False | None | + + +--- + +## Examples + +``` +/flow prem ticker:AMD +``` + +--- diff --git a/website/content/bot/reference/discord/flow/sectors.md b/website/content/bot/reference/discord/flow/sectors.md new file mode 100644 index 000000000000..1871a90a74b2 --- /dev/null +++ b/website/content/bot/reference/discord/flow/sectors.md @@ -0,0 +1,59 @@ +--- +title: sectors +description: This page provides guidelines for using the 'sectors' command to retrieve + a summary of all flows by MarketCap percentage per sector over the specified number + of past days. The command allows you to filter by selected sectors such as Basic + Materials, Energy and Communication Services among others. +keywords: +- sectors +- flows +- MarketCap +- filtering +- Basic Materials +- Energy +- Communication Services +- Consumer Cyclical +- Consumer Defensive +- Financial +- Healthcare +- Industrials +- Real Estate +- Technology +- Utilities +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command retrieves a summary of all flows by MarketCap percentage per sector over the past x days. + +### Usage + +```python wordwrap +/flow sectors days sector +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| days | Number of days to look back | False | None | +| sector | Sector to filter by | False | Basic Materials (BM), Energy (E), Communication Services (CS), Consumer Cyclical (CC), Consumer Defensive (CD), Financial (F), Healthcare (H), Industrials (I), Real Estate (RE), Technology (T), Utilities (U) | + + +--- + +## Examples + +``` +/flow sectors days:5 sector:Energy +``` + +``` +/flow sectors days:2 sector:Communication Services +``` + +--- diff --git a/website/content/bot/reference/discord/flow/sumday.md b/website/content/bot/reference/discord/flow/sumday.md new file mode 100644 index 000000000000..4d0532aab9a5 --- /dev/null +++ b/website/content/bot/reference/discord/flow/sumday.md @@ -0,0 +1,44 @@ +--- +title: sumday +description: This documentation page details the use of the sumday command in a trading + platform, explaining its purpose, usage, and parameters, including the concept of + stock tickers, total premium, and trade categorization. +keywords: +- sumday command +- stock ticker +- total premium +- trading day +- trade categorization +- bid/ask +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command allows the user to retrieve the total premium of the given stock ticker for the current trading day. We categorize the calls and puts by where the trade occurred on the bid/ask. For example, Above Ask, means the trade happened over the current Ask price. + +### Usage + +```python wordwrap +/flow sumday ticker +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| ticker | Stock Ticker | False | None | + + +--- + +## Examples + +``` +/flow sumday ticker:AMD +``` + +--- diff --git a/website/content/bot/reference/discord/flow/sumexp.md b/website/content/bot/reference/discord/flow/sumexp.md new file mode 100644 index 000000000000..56fd8019104b --- /dev/null +++ b/website/content/bot/reference/discord/flow/sumexp.md @@ -0,0 +1,47 @@ +--- +title: sumexp +description: A documentation descriptor for the command 'sumexp', a function which + allows users to obtain total premium of a specified stock ticker in the current + trading day by expiration. Users can distinguish calls and puts depending on where + the trade happened on the bid/ask. +keywords: +- sumexp +- trading +- stock ticker +- option trading +- trade on bid/ask +- premium retrieval +- expiration date +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command allows the user to retrieve the total premium of the given stock ticker for the current trading day by expiration. We categorize the calls and puts by where the trade occurred on the bid/ask. For example, Above Ask, means the trade happened over the current Ask price. + +### Usage + +```python wordwrap +/flow sumexp ticker expiry +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| ticker | Stock Ticker | False | None | +| expiry | Expiration Date | False | None | + + +--- + +## Examples + +``` +/flow sumexp ticker:AMD expiry:2022-07-29 +``` + +--- diff --git a/website/content/bot/reference/discord/flow/summary.md b/website/content/bot/reference/discord/flow/summary.md new file mode 100644 index 000000000000..f27b2778e17d --- /dev/null +++ b/website/content/bot/reference/discord/flow/summary.md @@ -0,0 +1,52 @@ +--- +title: summary +description: The page offers instructions on using a command that retrieves a summary + of all the flow per stock in the last x days. The summary includes details like + the ratio to total market capitalization, number of trades, etc. and the result + can be sorted in various ways like MarketCap, Float, and more. +keywords: +- Flow per stock +- Total market capitalization +- Number of trades +- Sort by MarketCap +- Sort by Float +- Sort by Total +- Sort by Short Percentage +- Command usage +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command allows the user to retrieve a summary of all the flow per stock over the last x days, with the result sorted in various ways. This summary will include the ratio to total market capitalization, the number of trades, and other information. + +### Usage + +```python wordwrap +/flow summary days sort +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| days | Number of days to look back | False | None | +| sort | Sort by MarketCap, Float, Total, or Short Percentage | False | MarketCap (mc), Float (float), Total (sum), Short Percentage (short) | + + +--- + +## Examples + +``` +/flow summary days:5 sort:Float +``` + +``` +/flow summary days:5 sort:Short Percentage +``` + +--- diff --git a/website/content/bot/reference/discord/flow/sumtop.md b/website/content/bot/reference/discord/flow/sumtop.md new file mode 100644 index 000000000000..0c7717163138 --- /dev/null +++ b/website/content/bot/reference/discord/flow/sumtop.md @@ -0,0 +1,44 @@ +--- +title: sumtop +description: The sumtop command is a useful tool for retrieving the top flow for the + day for Calls and Puts by stock, providing an overview of the market's sentiment + towards a particular stock, as well as an overall view of the market's sentiment + towards all stocks. The page provides the command usage, examples, and details regarding + parameters. +keywords: +- sumtop command +- stock market overview +- market sentiment +- calls and puts +- flow sumtop usage +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command allows the user to retrieve the top flow for the day for Calls and Puts by stock. This will provide the user with an overview of the market's current sentiment towards a particular stock as well as an overall view of the market's sentiment towards all stocks. + +### Usage + +```python wordwrap +/flow sumtop +``` + +--- + +## Parameters + +This command has no parameters + + + +--- + +## Examples + +``` +/flow sumtop +``` + +--- diff --git a/website/content/bot/reference/discord/flow/sumweek.md b/website/content/bot/reference/discord/flow/sumweek.md new file mode 100644 index 000000000000..e2f390182eab --- /dev/null +++ b/website/content/bot/reference/discord/flow/sumweek.md @@ -0,0 +1,43 @@ +--- +title: sumweek +description: Explore how the sumweek command allows the user to view the most prevalent + option flows for a given stock over a week. Understand market sentiment with this + tool. +keywords: +- sumweek command +- stock market +- market sentiment +- option flow +- stock ticker +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command allows the user to retrieve the top flow for the week for Calls and Puts by stock. This will provide the user with an overview of the market's current sentiment towards a particular stock as well as an overall view of the market's sentiment towards all stocks. + +### Usage + +```python wordwrap +/flow sumweek ticker +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| ticker | Stock Ticker | False | None | + + +--- + +## Examples + +``` +/flow sumweek ticker:AMD +``` + +--- diff --git a/website/content/bot/reference/discord/flow/unu.md b/website/content/bot/reference/discord/flow/unu.md new file mode 100644 index 000000000000..4f724f4e5d4b --- /dev/null +++ b/website/content/bot/reference/discord/flow/unu.md @@ -0,0 +1,44 @@ +--- +title: unu +description: Learn how to use the 'unu' command to retrieve Unusual Options Trades + exceeding $100,000. Perfect tool to identify potential opportunities in the options + market with no extra parameters. +keywords: +- unu command +- Unusual Options Trades +- options market opportunities +- more than $100,000 premium +- total volume exceeding open interest +- potential unusual activity +- no parameters +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command allows users to retrieve Unusual Options Trades over $100,000 premium and Total Volume exceeding Open Interest. This data can be used to identify potential opportunities in the options market allowing users to quickly and easily identify potential unusual activity. + +### Usage + +```python wordwrap +/flow unu +``` + +--- + +## Parameters + +This command has no parameters + + + +--- + +## Examples + +``` +/flow unu +``` + +--- diff --git a/website/content/bot/reference/discord/flow/weekly.md b/website/content/bot/reference/discord/flow/weekly.md new file mode 100644 index 000000000000..be88842cb911 --- /dev/null +++ b/website/content/bot/reference/discord/flow/weekly.md @@ -0,0 +1,43 @@ +--- +title: weekly +description: The weekly page includes information on how to retrieve the top 20 flow + by Premium for a stock with an option contract expiring within the week using a + specific command. +keywords: +- weekly command +- retrieve top flow +- premium for stock +- option contract expiry +- stock ticker +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command allows the user to retrieve the Top 20 flow by Premium for a stock with an option contact expiring that week. + +### Usage + +```python wordwrap +/flow weekly ticker +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| ticker | Stock Ticker | False | None | + + +--- + +## Examples + +``` +/flow weekly ticker:AMD +``` + +--- diff --git a/website/content/bot/reference/discord/fun/8ball.md b/website/content/bot/reference/discord/fun/8ball.md new file mode 100644 index 000000000000..b1d21ac6c30d --- /dev/null +++ b/website/content/bot/reference/discord/fun/8ball.md @@ -0,0 +1,43 @@ +--- +title: 8ball +description: A documentation page about the 8ball command that permits users to ask + the 8-ball a question to get an answer. It includes usage and examples of the command. +keywords: +- 8ball command +- command usage +- usage examples +- interactive function +- fun commands +- programming documentation +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command allows the user to ask the 8-ball a question and receive an answer. The question must end in a question mark. + +### Usage + +```python wordwrap +/fun 8ball question +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| question | Question to ask the 8 ball (must end with a question mark) | False | None | + + +--- + +## Examples + +``` +/fun 8ball question:Will I make money today? +``` + +--- diff --git a/website/content/bot/reference/discord/fun/flip.md b/website/content/bot/reference/discord/fun/flip.md new file mode 100644 index 000000000000..16a290063cff --- /dev/null +++ b/website/content/bot/reference/discord/fun/flip.md @@ -0,0 +1,41 @@ +--- +title: flip +description: This documentation provides a guide to using the 'flip' command that + enables the user to simulate a coin flip. It displays how to execute the command, + and provides examples with no required parameters. +keywords: +- coin flip +- flip +- simulate flip +- fun flip +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command allows the user to simulate a coin flip displaying either a 'Heads' or 'Tails'. + +### Usage + +```python wordwrap +/fun flip +``` + +--- + +## Parameters + +This command has no parameters + + + +--- + +## Examples + +``` +/fun flip +``` + +--- diff --git a/website/content/bot/reference/discord/fun/urban.md b/website/content/bot/reference/discord/fun/urban.md new file mode 100644 index 000000000000..3c54ee9d6d83 --- /dev/null +++ b/website/content/bot/reference/discord/fun/urban.md @@ -0,0 +1,43 @@ +--- +title: urban +description: This page provides comprehensive instructions on the command '/fun urban + word', which allows users to search for word definitions on Urban Dictionary. It + includes parameter details, usage, and examples. +keywords: +- urban dictionary +- word search +- usage +- examples +- parameters +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command allows the user to search for a definition of a word on Urban Dictionary. + +### Usage + +```python wordwrap +/fun urban word +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| word | The word or words to search for. | False | None | + + +--- + +## Examples + +``` +/fun urban word:Shill +``` + +--- diff --git a/website/content/bot/reference/discord/general/futures.md b/website/content/bot/reference/discord/general/futures.md new file mode 100644 index 000000000000..96fc1d18ef79 --- /dev/null +++ b/website/content/bot/reference/discord/general/futures.md @@ -0,0 +1,42 @@ +--- +title: futures +description: Documentation for the futures command which allows users to retrieve + futures prices on the stock market. Helps in stock market automation. +keywords: +- futures command +- retrieve futures prices +- stock market automation +- stock market commands +- financial commands +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command allows the user to retrieve futures prices on the stock market. + +### Usage + +```python wordwrap +/futures [all_futures] +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| all_futures | Display all futures. Default False | True | None | + + +--- + +## Examples + +``` +/futures +``` + +--- diff --git a/website/content/bot/reference/discord/general/heatchart.md b/website/content/bot/reference/discord/general/heatchart.md new file mode 100644 index 000000000000..2602db88da1f --- /dev/null +++ b/website/content/bot/reference/discord/general/heatchart.md @@ -0,0 +1,39 @@ +--- +title: heatchart +description: This page provides documentation about the heatchart command that allows + users to retrieve a graphical representation of daily market performance by sector. +keywords: +- heatchart command +- daily market heat chart +- graphical market performance by sector +- command parameters +- usage examples +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command allows the user to retrieve a Daily Market Heat Chart (15 minute delayed). The heat chart shows a graphical representation of the performance of the market by sector for that day, with different colors indicating different levels of performance. + +### Usage + +```python wordwrap +/heatchart +``` + +--- + +## Parameters + +This command has no parameters + +--- + +## Examples + +``` +/heatchart +``` + +--- diff --git a/website/content/bot/reference/discord/general/heatmap.md b/website/content/bot/reference/discord/general/heatmap.md new file mode 100644 index 000000000000..eaf21b7c9ede --- /dev/null +++ b/website/content/bot/reference/discord/general/heatmap.md @@ -0,0 +1,64 @@ +--- +title: heatmap +description: Learn how to use the heatmap command to easily view stock market performance. + This guide outlines its usage, parameters, and provides examples for both the market + and sector filters. +keywords: +- heatmap command +- stock market performance +- market filter +- sector filter +- usage of heatmap +- parameters of heatmap +- example of heatmap command +- S&P 500 +- NASDAQ 100 +- Russell 2000 +- Russell 1000 +- Dow Jones 30 +- Crypto +- Basic Materials +- Conglomerates +- Consumer Goods +- Financial +- Healthcare +- Industrial Goods +- Services +- Technology +- Utilities +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command allows the user to retrieve Daily Heat Maps by Market and Sector. The Daily Heat Maps will allow the user a quick overview of current stock market performance. + +### Usage + +```python wordwrap +/heatmap market [sector] +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| market | Market to filter by. | False | S&P 500 (sp500), NASDAQ 100 (nasdaq100), Russell 2000 (iwm2000), Russell 1000 (iwb1000), Dow Jones 30 (dow30), Crypto (crypto) | +| sector | Sector to filter by. If not specified, all sectors are returned. | True | Basic Materials (1), Conglomerates (2), Consumer Goods (3), Financial (4), Healthcare (5), Industrial Goods (6), Services (7), Technology (8), Utilities (9) | + + +--- + +## Examples + +``` +/heatmap market:S&P 500 +``` +``` +/heatmap market:S&P 500 sector:Services +``` + +--- diff --git a/website/content/bot/reference/discord/general/markets.md b/website/content/bot/reference/discord/general/markets.md new file mode 100644 index 000000000000..2c66739f0908 --- /dev/null +++ b/website/content/bot/reference/discord/general/markets.md @@ -0,0 +1,46 @@ +--- +title: markets +description: The page provides an overview on the /markets command which allows users + to retrieve a summary of current market conditions including prices of the largest + ETFs and and the amount of stocks current above and below the SMA 200/50 and Advancers + / Decliners. +keywords: +- Markets +- ETF +- SMA 200/50 +- Advancers / Decliners +- market conditions +- /markets command +- stock market +- stock analysis +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command allows the user to retrieve a markets overview which provides a quick summary of current market conditions. The overview includes prices of the largest ETFs, with the amount of stocks current above and below the SMA 200/50 and Advancers / Decliners. + +### Usage + +```python wordwrap +/markets +``` + +--- + +## Parameters + +This command has no parameters + + + +--- + +## Examples + +``` +/markets +``` + +--- diff --git a/website/content/bot/reference/discord/general/news.md b/website/content/bot/reference/discord/general/news.md new file mode 100644 index 000000000000..d902000dbead --- /dev/null +++ b/website/content/bot/reference/discord/general/news.md @@ -0,0 +1,39 @@ +--- +title: news +description: A documentation page describing how to use the 'news' command to retrieve + the latest stock market news for a specific ticker symbol. +keywords: +- news +- stock market +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command allows the user to retrieve the latest news for a given ticker. + +### Usage + +```python wordwrap +/news ticker +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| ticker | Stock Ticker | False | None | + + +--- + +## Examples + +``` +/news ticker:AMD +``` + +--- diff --git a/website/content/bot/reference/discord/general/quote.md b/website/content/bot/reference/discord/general/quote.md new file mode 100644 index 000000000000..58d28fef5dc2 --- /dev/null +++ b/website/content/bot/reference/discord/general/quote.md @@ -0,0 +1,46 @@ +--- +title: quote +description: Page describing the 'quote' command, which retrieves display quote stats + for a stock. This includes information for 52 week high/low, market cap/float and + 200/50 day moving averages based on the specified stock ticker. +keywords: +- quote command +- display quote stats +- stock stats +- 52 week high/low +- market cap/float +- 200/50 day moving averages +- quick access +- stock ticker +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command allows the user to retrieve display quote stats for a stock - including the 52 week high/low, market cap/float, and 200/50 day moving averages. The command allows you to quickly and easily access the requested quote stats for the given stock. + +### Usage + +```python wordwrap +/quote ticker +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| ticker | Stock Ticker | False | None | + + +--- + +## Examples + +``` +/quote ticker:AMD +``` + +--- diff --git a/website/content/bot/reference/discord/general/ta.md b/website/content/bot/reference/discord/general/ta.md new file mode 100644 index 000000000000..e22e360c89dc --- /dev/null +++ b/website/content/bot/reference/discord/general/ta.md @@ -0,0 +1,45 @@ +--- +title: ta +description: The /ta ticker command analysizes a stock's technical metrics including + moving averages, fibonacci levels, support and resistance levels. Ideal for all + users interested in stock markets, specifically in technical analysis. +keywords: +- Technical analysis +- Stock ticker +- Moving averages +- Fibonacci levels +- /ta ticker +- Support and resistance levels +- Technical metrics +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command allows the user to retrieve a technical analysis summary for a given stock ticker. The summary includes several indicators such as moving averages, fibonacci levels, support and resistance levels, and other technical metrics. + +### Usage + +```python wordwrap +/ta ticker +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| ticker | Stock Ticker | False | None | + + +--- + +## Examples + +``` +/ta ticker:AMD +``` + +--- diff --git a/website/content/bot/reference/discord/general/watchlist.md b/website/content/bot/reference/discord/general/watchlist.md new file mode 100644 index 000000000000..6270a6f39572 --- /dev/null +++ b/website/content/bot/reference/discord/general/watchlist.md @@ -0,0 +1,59 @@ +--- +title: watchlist +description: 'Learn how to use the watchlist command: add or remove stock tickers, + retrieve an overview on current price, high/low, volume and change; get quick access + to related data like flow, darkpool data, technical analysis and news.' +keywords: +- watchlist +- stocks +- add ticker +- edit ticker +- technical analysis +- stock price +- high/low +- volume +- change +- darkpool data +- stock news +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command allows the user to retrieve an overview of their watchlist, which includes the current price, high/low, volume, and change. You can also get other related information with a quick click like flow, darkpool data, technical analysis, and news - all from one spot. + +### Usage + +```python wordwrap +/watchlist [add] [edit] +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| add | Add a ticker to your watchlist. You can add multiple tickers by separating them with a comma. | True | None | +| edit | Remove tickers from your watchlist. Choose Remove to bring up the interactive menu. | True | Remove | + + +--- + +## Examples + +``` +/watchlist +``` +``` +/watchlist add:AMD +``` +``` +/watchlist add:AMD,GOOG,TSLA +``` +``` +/watchlist edit:Remove +``` + +--- diff --git a/website/content/bot/reference/discord/government/contracts.md b/website/content/bot/reference/discord/government/contracts.md new file mode 100644 index 000000000000..f15c6aae5075 --- /dev/null +++ b/website/content/bot/reference/discord/government/contracts.md @@ -0,0 +1,40 @@ +--- +title: contracts +description: This documentation page is about the command that allows users to retrieve + the top 15 government contracts by amount for a specific stock ticker. +keywords: +- government contracts +- retrieve +- stock +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command will allow the user to retrieve the top 15 government contracts by amount for a specific ticker. + +### Usage + +```python wordwrap +/gov contracts [ticker] +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| ticker | Stock Ticker (optional) | True | None | + + +--- + +## Examples + +``` +/gov contracts ticker:GE +``` + +--- diff --git a/website/content/bot/reference/discord/government/house.md b/website/content/bot/reference/discord/government/house.md new file mode 100644 index 000000000000..dfe6cda6638b --- /dev/null +++ b/website/content/bot/reference/discord/government/house.md @@ -0,0 +1,42 @@ +--- +title: house +description: The page provides a detailed guide on the use of the 'house' command. + The command allows the user to check recent house trades for any specific ticker. +keywords: +- House +- /gov house +- Ticker +- Stock Ticker +- Command +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command allows the user to retrieve recent house trades for a specific ticker. + +### Usage + +```python wordwrap +/gov house [ticker] +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| ticker | Stock Ticker (optional) | True | None | + + +--- + +## Examples + +``` +/gov house ticker:GE +``` + +--- diff --git a/website/content/bot/reference/discord/government/senate.md b/website/content/bot/reference/discord/government/senate.md new file mode 100644 index 000000000000..c22e2a267be1 --- /dev/null +++ b/website/content/bot/reference/discord/government/senate.md @@ -0,0 +1,42 @@ +--- +title: senate +description: This metadata is about the '/gov senate' command in Docusaurus. It allows + the users to view recent trades of senate members for a specific stock ticker. The + user can apply the ticker of their choice. +keywords: +- senate +- trades +- senate members +- gov senate +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command allows a user to view the recent trades of senate members for a specific ticker. + +### Usage + +```python wordwrap +/gov senate [ticker] +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| ticker | Stock Ticker (optional) | True | None | + + +--- + +## Examples + +``` +/gov senate ticker:GE +``` + +--- diff --git a/website/content/bot/reference/discord/info/about.md b/website/content/bot/reference/discord/info/about.md new file mode 100644 index 000000000000..75a744ecb2a8 --- /dev/null +++ b/website/content/bot/reference/discord/info/about.md @@ -0,0 +1,41 @@ +--- +title: about +description: The 'about' page offers a detailed introduction about OpenBB Bot, including + pertinent links to our social media pages. Learn how to use this command effectively. +keywords: +- OpenBB Bot +- bot commands +- about page +- social media links +- usage guide +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command will provide users with a comprehensive overview of OpenBB Bot and links to our social media pages. + +### Usage + +```python wordwrap +/info about +``` + +--- + +## Parameters + +This command has no parameters + + + +--- + +## Examples + +``` +/info about +``` + +--- diff --git a/website/content/bot/reference/discord/info/serverid.md b/website/content/bot/reference/discord/info/serverid.md new file mode 100644 index 000000000000..ac53fccf531e --- /dev/null +++ b/website/content/bot/reference/discord/info/serverid.md @@ -0,0 +1,43 @@ +--- +title: serverid +description: /info serverid is a command in discord that retrieves the Server ID of + a discord room. This unique identifier is necessary for linkage and autoposting + features. +keywords: +- serverid +- discord room +- autoposting features +- unique identifier +- link account +- info command +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command allows the user to retrieve the Server ID of discord room. The Server ID is a unique identifier associated with the server and is needed for some autoposting features when you link your account. + +### Usage + +```python wordwrap +/info serverid +``` + +--- + +## Parameters + +This command has no parameters + + + +--- + +## Examples + +``` +/info serverid +``` + +--- diff --git a/website/content/bot/reference/discord/info/stats.md b/website/content/bot/reference/discord/info/stats.md new file mode 100644 index 000000000000..de3b3ae690ab --- /dev/null +++ b/website/content/bot/reference/discord/info/stats.md @@ -0,0 +1,40 @@ +--- +title: stats +description: This page offers the essential guide on how to utilize the 'stats' command + on Docusaurus. Learn how to retrieve the current number of servers the bot is in + effectively. +keywords: +- bot commands +- server stats +- docusaurus page +- /info stats +- usage parameters +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command allows the user to retrieve the current number of servers the bot is in. + +### Usage + +```python wordwrap +/info stats +``` + +--- + +## Parameters + +This command has no parameters + +--- + +## Examples + +``` +/info stats +``` + +--- diff --git a/website/content/bot/reference/discord/info/support.md b/website/content/bot/reference/discord/info/support.md new file mode 100644 index 000000000000..ab82249bf73e --- /dev/null +++ b/website/content/bot/reference/discord/info/support.md @@ -0,0 +1,39 @@ +--- +title: support +description: This page explains how to use the support command, including usage and + examples. This allows users to send a support ticket directly to our team. +keywords: +- Support command +- Support ticket +- Customer service +- User support +- Tech support +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command allows the user to send a support ticket directly to our team. + +### Usage + +```python wordwrap +/info support +``` + +--- + +## Parameters + +This command has no parameters + +--- + +## Examples + +``` +/info support +``` + +--- diff --git a/website/content/bot/reference/discord/nft/chart.md b/website/content/bot/reference/discord/nft/chart.md new file mode 100644 index 000000000000..5625f3fa595b --- /dev/null +++ b/website/content/bot/reference/discord/nft/chart.md @@ -0,0 +1,50 @@ +--- +title: chart +description: This documentation page provides user guidance on retrieving NFT collection + data using a slug-based chart command, showcasing floor price and sales count over + time. +keywords: +- NFT collection data +- chart command +- floor price +- sales count +- slug-based command +- cryptopunks +- bored-ape-yacht-club +- NFT chart +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command allows the user to retrieve the NFT Collection Data related to the specified slug. The chart will show the floor price over time and sales count. + +### Usage + +```python wordwrap +/nft chart slug +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| slug | NFT collection slug (e.g., cryptopunks) | False | None | + + +--- + +## Examples + +``` +/nft chart slug: bent +``` + +``` +/nft chart slug: bored-ape-yacht-club +``` + +--- diff --git a/website/content/bot/reference/discord/nft/collection.md b/website/content/bot/reference/discord/nft/collection.md new file mode 100644 index 000000000000..0d4266565102 --- /dev/null +++ b/website/content/bot/reference/discord/nft/collection.md @@ -0,0 +1,46 @@ +--- +title: collection +description: This documentation page details the procedure to retrieve a collection + of Non-Fungible Token (NFT) data, including metadata such as the owner and the number + of items in the collection. +keywords: +- NFT +- Non-Fungible Token +- cryptocurrency +- collection +- metadata +- ownership +- minted NFTs +- slug +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command retrieves a collection of Non-Fungible Token (NFT) data associated with the specified slug. It returns the collection's metadata, including the owner, the number of items in the collection, the total NFTs minted, and various other data on the NFT. + +### Usage + +```python wordwrap +/nft collection slug +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| slug | NFT collection slug (e.g., cryptopunks) | False | None | + + +--- + +## Examples + +``` +/nft collection slug: bent +``` + +--- diff --git a/website/content/bot/reference/discord/nft/top.md b/website/content/bot/reference/discord/nft/top.md new file mode 100644 index 000000000000..60fe8130da5c --- /dev/null +++ b/website/content/bot/reference/discord/nft/top.md @@ -0,0 +1,55 @@ +--- +title: top +description: A documentation page that provides users with instructions on how to + retrieve the top NFT collections from Ethereum using various parameters for sorting + and intervals. Great resource for staying updated with the latest trends in the + NFT market. +keywords: +- NFT Collections +- Ethereum +- Crypto Commands +- NFT Trends +- Top NFT Collections +- Market Cap +- Floor Price +- Sales Volume +- Reverse Sort +- Time Interval +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command allows users to retrieve the top NFT collections from Ethereum. It provides a list of the most popular and valuable NFT collections, helping users to keep abreast of the latest trends in the NFT space. + +### Usage + +```python wordwrap +/nft top [sortby] [interval] [reverse] +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| sortby | Column to sort by (default: Market Cap) | True | Market Cap (MCap), Floor Price Change (Floor Price) | +| interval | Time interval to display Sales/Volume/Floor Price (default: 1d) | True | 1d, 7d, 30d, 90d | +| reverse | Reverse the sort order (default: No) | True | Yes | + + +--- + +## Examples + +``` +/nft top +``` + +``` +/nft top sortby: Market Cap reverse: Yes +``` + +--- diff --git a/website/content/bot/reference/discord/options/chains.md b/website/content/bot/reference/discord/options/chains.md new file mode 100644 index 000000000000..55083b3bb5d5 --- /dev/null +++ b/website/content/bot/reference/discord/options/chains.md @@ -0,0 +1,53 @@ +--- +title: chains +description: "This docusaurus page explores the 'chains' command which allows users\ + \ to view Options Chains by Expiry for a specific stock. It also explains several\ + \ parameters such as Stock Ticker, Expiration Date, type of options \u2013 Calls\ + \ or Puts, and Strike Prices." +keywords: +- Options Chains by Expiry +- Stock Ticker +- Expiration Date +- Calls or Puts +- Minimum Strike Price +- Maximum Strike Price +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command allows users to retrieve Options Chain by Expiry, which gives an overview of the bid, ask, and open interest of options contracts for a specific stock. + +### Usage + +```python wordwrap +/op chains ticker expiry opt_type [min_sp] [max_sp] +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| ticker | Stock Ticker | False | None | +| expiry | Expiration Date | False | None | +| opt_type | Calls or Puts | False | Calls, Puts | +| min_sp | Minimum Strike Price | True | None | +| max_sp | Maximum Strike Price | True | None | + + +--- + +## Examples + +``` +/op chains ticker:AMD expiry:2022-07-29 opt_type:Calls +``` + +``` +/op chains ticker:AMD expiry:2022-07-29 opt_type:Calls min_sp:10 max_sp:100 +``` + +--- diff --git a/website/content/bot/reference/discord/options/equitypc.md b/website/content/bot/reference/discord/options/equitypc.md new file mode 100644 index 000000000000..d5517c479767 --- /dev/null +++ b/website/content/bot/reference/discord/options/equitypc.md @@ -0,0 +1,42 @@ +--- +title: equitypc +description: The documentation page provides details on how to utilize the 'equitypc' + command to retrieve the Equity Put/Call Volume Ratio data from market-harmonics.com, + a helpful tool for gauging market sentiment. +keywords: +- Equity Put/Call Volume Ratio +- Market Sentiment +- Market Harmonics +- Trading +- Traders Tools +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command retrieves the Equity Put/Call Volume Ratio from market-harmonics.com. This ratio is used to measure the demand for puts versus calls in the equity market and can be a useful tool for traders to help gauge market sentiment. + +### Usage + +```python wordwrap +/op equitypc +``` + +--- + +## Parameters + +This command has no parameters + + + +--- + +## Examples + +``` +/op equitypc +``` + +--- diff --git a/website/content/bot/reference/discord/options/gamma.md b/website/content/bot/reference/discord/options/gamma.md new file mode 100644 index 000000000000..22c001fef2de --- /dev/null +++ b/website/content/bot/reference/discord/options/gamma.md @@ -0,0 +1,59 @@ +--- +title: gamma +description: This page is a guide on how to view the Options Gamma Levels for a specific + stock using the '/op gamma' command. It provides an understanding of Delta's rate + of change with stock price variations and aids in making informed trading decisions. +keywords: +- options gamma levels +- stock price changes +- delta rate of change +- trading decisions +- call and put gamma +- put wall +- call wall +- stock ticker +- expiry date +- /op gamma +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command allows the user to view the Options Gamma Levels for a particular stock. Options Gamma Levels are important to understanding the rate of change for the option's Delta when the underlying stock price changes. Knowing this information can help traders make informed decisions about which options to purchase. + +| Name | Description | +| ---- | ----------- | +| Zero Gamma | Point closest to net zero of Call and Put Gamma | +| Put Wall | Strike with the largest NET Put Gamma | +| Call Wall | Strike with the largest NET Call Gamma | + +### Usage + +```python wordwrap +/op gamma ticker [expiry] +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| ticker | Stock Ticker | False | None | +| expiry | Gamma from now until expiry | True | None | + + +--- + +## Examples + +``` +/op gamma ticker:AMD +``` + +``` +/op gamma ticker:AMD expiry:2022-07-29 +``` + +--- diff --git a/website/content/bot/reference/discord/options/highiv.md b/website/content/bot/reference/discord/options/highiv.md new file mode 100644 index 000000000000..79d6193a2284 --- /dev/null +++ b/website/content/bot/reference/discord/options/highiv.md @@ -0,0 +1,43 @@ +--- +title: highiv +description: The highiv command retrieves the 15 highest IV30 equity stocks by 30 + day Implied Volatility. It's useful for traders looking to capitalize on market + movements. +keywords: +- highiv command +- IV30 equity stocks +- 30 day Implied Volatility +- high potential return +- traders +- market movements +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command retrieves the 15 highest IV30 equity stocks by 30 day Implied Volatility. The IV30 metric is a measure of the expected volatility of a stock over the next 30 days. This command is ideal for users looking to make investments with high potential return and is useful for traders looking to capitalize on market movements. + +### Usage + +```python wordwrap +/op highiv +``` + +--- + +## Parameters + +This command has no parameters + + + +--- + +## Examples + +``` +/op highiv +``` + +--- diff --git a/website/content/bot/reference/discord/options/hist.md b/website/content/bot/reference/discord/options/hist.md new file mode 100644 index 000000000000..04a207f845d5 --- /dev/null +++ b/website/content/bot/reference/discord/options/hist.md @@ -0,0 +1,57 @@ +--- +title: hist +description: Learn how to use the 'op hist' command to retrieve the historical price + of options given certain parameters such as ticker, expiry, strike, option type + and interval for the past x number of days in chart format. Includes examples and + descriptions of the parameters. +keywords: +- Stock Ticker +- Expiration Date +- Option Strike Price +- Calls or Puts +- Chart Minute Interval +- Past Days to Display +- op hist command +- historical price of options +- chart format +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command allows the user to retrieve the historical price of options for the given parameters of a ticker, expiry, strike , option type, and interval for the past x days in a chart format. + +### Usage + +```python wordwrap +/op hist ticker expiry strike opt_type interval [past_days] +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| ticker | Stock Ticker | False | None | +| expiry | Expiration Date YYYY-MM-DD format | False | None | +| strike | Option Strike Price | False | None | +| opt_type | Calls or Puts | False | Calls, Puts | +| interval | Chart Minute Interval, 1440 for Daily | False | 15 (15), 30 (30), 60 (60), 1440 (1440) | +| past_days | Past Days to Display. Default: 5 | True | None | + + +--- + +## Examples + +``` +/op hist ticker:AMD expiry:2022-07-29 strike:80 opt_type:Calls interval:15 past_days:5 +``` + +``` +/op hist ticker:AMD expiry:2022-07-29 strike:80 opt_type:Calls interval:15 +``` + +--- diff --git a/website/content/bot/reference/discord/options/indexpc.md b/website/content/bot/reference/discord/options/indexpc.md new file mode 100644 index 000000000000..91f892b0e6d3 --- /dev/null +++ b/website/content/bot/reference/discord/options/indexpc.md @@ -0,0 +1,43 @@ +--- +title: indexpc +description: Learn how to use the indexpc command to retrieve the Index Put/Call Ratio + for the market from market-harmonics.com, a valuable tool for identifying bearish + and bullish market conditions. +keywords: +- indexpc command +- Index Put/Call Ratio +- market sentiment +- bearish and bullish market conditions +- market-harmonics.com +- trading decisions +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command allows the user to retrieve the Index Put/Call Ratio for the market from market-harmonics.com. This ratio is an indication of the market sentiment and can be used to help traders identify bearish and bullish market conditions. The command returns the ratio and can be used to inform trading decisions. + +### Usage + +```python wordwrap +/op indexpc +``` + +--- + +## Parameters + +This command has no parameters + + + +--- + +## Examples + +``` +/op indexpc +``` + +--- diff --git a/website/content/bot/reference/discord/options/info.md b/website/content/bot/reference/discord/options/info.md new file mode 100644 index 000000000000..4410c481ebdd --- /dev/null +++ b/website/content/bot/reference/discord/options/info.md @@ -0,0 +1,44 @@ +--- +title: info +description: An in-depth guide on how to efficiently retrieve option information such + as volatility, IV rank, put/call ratio for a specific ticker symbol using the 'op + info ticker' command. +keywords: +- option information +- volatility +- IV rank +- put/call ratio +- ticker symbol +- stock ticker +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command allows the user to quickly and easily retrieve various option information (volatility, IV rank, put/call ratio, etc.) for a specific ticker symbol. + +### Usage + +```python wordwrap +/op info ticker +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| ticker | Stock Ticker | False | None | + + +--- + +## Examples + +``` +/op info ticker:AMD +``` + +--- diff --git a/website/content/bot/reference/discord/options/itm.md b/website/content/bot/reference/discord/options/itm.md new file mode 100644 index 000000000000..bcab54a672b8 --- /dev/null +++ b/website/content/bot/reference/discord/options/itm.md @@ -0,0 +1,42 @@ +--- +title: itm +description: A comprehensive guide on the 'itm' command that helps to acquire In-the-Money + options for chosen stock ticker. +keywords: +- itm command +- In-the-Money options +- stock ticker +- Calls and Puts +- Out-the-Money options +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command allows the user to retrieve a list of In-the-Money options for the stock ticker symbol sorted by expiry date. The command compares the amount of Calls and Puts In-the-Money vs Out-the-Money and gives a total. + +### Usage + +```python wordwrap +/op itm ticker +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| ticker | Stock Ticker | False | None | + + +--- + +## Examples + +``` +/op itm ticker:AMD +``` + +--- diff --git a/website/content/bot/reference/discord/options/maxpain.md b/website/content/bot/reference/discord/options/maxpain.md new file mode 100644 index 000000000000..71f4b9778c09 --- /dev/null +++ b/website/content/bot/reference/discord/options/maxpain.md @@ -0,0 +1,44 @@ +--- +title: maxpain +description: The page provides information on the maxpain function that finds the + maximum pain on expiration date for a particular stock. It includes usage, parameters, + and examples. +keywords: +- Max Pain +- Stock options +- Expiration date +- Option holders +- Financial losses +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command retrieves the Max Pain on expiration date for a given stock. Max Pain is the strike price with the most open options contracts and it is the price at which the stock would cause financial losses for the largest number of option holders at expiration. + +### Usage + +```python wordwrap +/op maxpain ticker expiry +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| ticker | Stock Ticker | False | None | +| expiry | Expiration Date | False | None | + + +--- + +## Examples + +``` +/op maxpain ticker:AMC expiry:2022-07-29 +``` + +--- diff --git a/website/content/bot/reference/discord/options/oi.md b/website/content/bot/reference/discord/options/oi.md new file mode 100644 index 000000000000..0e7196f38280 --- /dev/null +++ b/website/content/bot/reference/discord/options/oi.md @@ -0,0 +1,49 @@ +--- +title: oi +description: The documentation details about 'oi' command allows the user to retrieve + the Open Interest and Call/Put ratio for a specific stock. Additional functionality + includes setting an expiration date for a more granular breakdown. +keywords: +- oi command +- Open Interest +- Call/Put ratio +- stock +- expiry +- granular breakdown +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command allows the user to retrieve the Open Interest and Call/Put ratio for a given stock. Optionally, the user can also specify an expiration date to get a more granular breakdown. + +### Usage + +```python wordwrap +/op oi ticker [expiry] +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| ticker | Stock Ticker | False | None | +| expiry | Expiration Date | True | None | + + +--- + +## Examples + +``` +/op oi ticker:AMC +``` + +``` +/op oi ticker:AMC expiry:2022-07-29 +``` + +--- diff --git a/website/content/bot/reference/discord/options/oichart.md b/website/content/bot/reference/discord/options/oichart.md new file mode 100644 index 000000000000..92d5a22cfcd1 --- /dev/null +++ b/website/content/bot/reference/discord/options/oichart.md @@ -0,0 +1,53 @@ +--- +title: oichart +description: This documentation page gives a detailed explanation of the 'oichart' + command used to retrieve a chart of Total Open Interest by Strike Price for a specific + ticker symbol. The page provides usage, parameters, and examples to analyze the + open interest on various strike prices and make informed decisions about the underlying + security. +keywords: +- oichart +- Open Interest +- Strike Price +- Visual representation +- ticker symbol +- Stock Ticker +- Expiration Date +- Underlying security +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command allows users to retrieve a chart of Total Open Interest by Strike Price for the given ticker symbol. This chart provides a visual representation of the open interest on various strike prices for the given ticker symbol, where the size of each point on the graph reflects the amount of open interest. This can be used to analyze the open interest on various strike prices and make informed decisions about the underlying security. + +### Usage + +```python wordwrap +/op oichart ticker [expiry] +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| ticker | Stock Ticker | False | None | +| expiry | Expiration Date | True | None | + + +--- + +## Examples + +``` +/op oichart ticker:AMD +``` + +``` +/op oichart ticker:AMD expiry:2022-07-29 +``` + +--- diff --git a/website/content/bot/reference/discord/options/smile.md b/website/content/bot/reference/discord/options/smile.md new file mode 100644 index 000000000000..febfb2310b74 --- /dev/null +++ b/website/content/bot/reference/discord/options/smile.md @@ -0,0 +1,51 @@ +--- +title: smile +description: This page instructs users on how to use the '/op smile' command to retrieve + the Options Volatility Smile for given stock tickers and expiry dates. It is especially + beneficial for those seeking to understand market sentiments and implied volatility. +keywords: +- Options Volatility Smile +- Stock Ticker +- Expiration Date +- Strike Price +- Market Sentiment +- Implied Volatility +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command allows the user to retrieve the Options Volatility Smile for the given ticker and expiry. The Options Volatility Smile is a graphical representation of the implied volatility for a given option that can be used to gauge the market sentiment for a particular security. + +### Usage + +```python wordwrap +/op smile ticker expiry [min_sp] [max_sp] +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| ticker | Stock Ticker | False | None | +| expiry | Expiration Date | False | None | +| min_sp | Minimum Strike Price | True | None | +| max_sp | Maximum Strike Price | True | None | + + +--- + +## Examples + +``` +/op smile ticker:AMD expiry:2022-07-29 +``` + +``` +/op smile ticker:AMD expiry:2022-07-29 min_sp:10 max_sp:100 +``` + +--- diff --git a/website/content/bot/reference/discord/options/stats.md b/website/content/bot/reference/discord/options/stats.md new file mode 100644 index 000000000000..7cd6da6871b4 --- /dev/null +++ b/website/content/bot/reference/discord/options/stats.md @@ -0,0 +1,44 @@ +--- +title: stats +description: The page gives insight into the use of the command to retrieve Options + Statistics for a stock. It provides data on parameters like Open Interest, Volume, + Implied Volatility and Earnings Move. +keywords: +- Options Statistics +- Stock Ticker +- Open Interest +- Volume +- Implied Volatility +- Earnings Move Data +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command allows the user to retrieve Options Statistics for a stock with the given ticker symbol. This includes information such as Open Interest, Volume, Implied Volatility, and Earnings move data. + +### Usage + +```python wordwrap +/op stats ticker +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| ticker | Stock Ticker | False | None | + + +--- + +## Examples + +``` +/op stats ticker:AMC +``` + +--- diff --git a/website/content/bot/reference/discord/options/topoi.md b/website/content/bot/reference/discord/options/topoi.md new file mode 100644 index 000000000000..e3b979857a2b --- /dev/null +++ b/website/content/bot/reference/discord/options/topoi.md @@ -0,0 +1,42 @@ +--- +title: topoi +description: This page explains how to use the 'topoi' command, allowing users to + retrieve Top Open Interest among all stocks. It discusses the purpose, usage, and + provides examples of this command. +keywords: +- topoi command +- retrieve Top Open Interest +- most actively traded stocks +- current market data +- stocks and options +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command allows the user to retrieve Top Open Interest among all stocks. This command queries the current market data and provides a list of the most actively traded stocks and options in the current market. + +### Usage + +```python wordwrap +/op topoi +``` + +--- + +## Parameters + +This command has no parameters + + + +--- + +## Examples + +``` +/op topoi +``` + +--- diff --git a/website/content/bot/reference/discord/options/topoichange.md b/website/content/bot/reference/discord/options/topoichange.md new file mode 100644 index 000000000000..ad8c1affcd49 --- /dev/null +++ b/website/content/bot/reference/discord/options/topoichange.md @@ -0,0 +1,42 @@ +--- +title: topoichange +description: This page provides details on the topoichange command and its usage for + tracking the top 15 stocks with the highest OI Change. It can be used to monitor + significant changes in open interest of stocks. +keywords: +- topoichange +- stocks +- OI Change +- open interest +- stock market commands +- stock name +- stock change +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command allows the user to view the top 15 stocks with the highest OI Change. It will display the stock name, the OI Change by put and call, and previous levels. This gives users a helpful overview of the stocks that have seen the most significant change in open interest. + +### Usage + +```python wordwrap +/op topoichange +``` + +--- + +## Parameters + +This command has no parameters + +--- + +## Examples + +``` +/op topoichange +``` + +--- diff --git a/website/content/bot/reference/discord/options/topstrikevol.md b/website/content/bot/reference/discord/options/topstrikevol.md new file mode 100644 index 000000000000..6405110fec88 --- /dev/null +++ b/website/content/bot/reference/discord/options/topstrikevol.md @@ -0,0 +1,44 @@ +--- +title: topstrikevol +description: This documentation page explains how to use the topstrikevol command + to retrieve the top option strike by volume for a specific stock ticker. It includes + clear specifications of parameters and provides usage examples. +keywords: +- topstrikevol command +- stock ticker +- option strike by volume +- expiration date +- Python code usage +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command allows the user to retrieve the top option strike by volume for a given security with the ability to add an expiration date for a more detailed breakdown. + +### Usage + +```python wordwrap +/op topstrikevol ticker [expiry] +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| ticker | Stock Ticker | False | None | +| expiry | Expiration Date (optional) | True | None | + + +--- + +## Examples + +```python wordwrap +/op topstrikevol ticker:AMD +``` + +--- diff --git a/website/content/bot/reference/discord/options/topvol.md b/website/content/bot/reference/discord/options/topvol.md new file mode 100644 index 000000000000..9694310b90ab --- /dev/null +++ b/website/content/bot/reference/discord/options/topvol.md @@ -0,0 +1,41 @@ +--- +title: topvol +description: The page provides detailed instructions on how to use the 'topvol' command + to retrieve the Top 15 Highest stock options volumes for trading. The guide also + gives examples and usage for better understanding. +keywords: +- topvol +- stock options volumes +- most liquid options +- /op topvol +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command allows the user to retrieve the Top 15 Highest stock options volumes by adding the call and put volume together. This data can be used to identify the most liquid options for trading. + +### Usage + +```python wordwrap +/op topvol +``` + +--- + +## Parameters + +This command has no parameters + + + +--- + +## Examples + +``` +/op topvol +``` + +--- diff --git a/website/content/bot/reference/discord/options/topvoletf.md b/website/content/bot/reference/discord/options/topvoletf.md new file mode 100644 index 000000000000..8e1affce772f --- /dev/null +++ b/website/content/bot/reference/discord/options/topvoletf.md @@ -0,0 +1,41 @@ +--- +title: topvoletf +description: This documentation page provides an overview of the 'topvoletf' command. + This command retrieves the Top 15 Highest ETF options volumes, proving essential + for identifying the most liquid options for trading. +keywords: +- topvoletf +- ETF options volumes +- liquid options +- options trading +- trading data retrieval +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command allows the user to retrieve the Top 15 Highest ETF options volumes by adding the call and put volume together. This data can be used to identify the most liquid options for trading. + +### Usage + +```python wordwrap +/op topvoletf +``` + +--- + +## Parameters + +This command has no parameters + + + +--- + +## Examples + +``` +/op topvoletf +``` +--- diff --git a/website/content/bot/reference/discord/options/unu.md b/website/content/bot/reference/discord/options/unu.md new file mode 100644 index 000000000000..853744b6e7bd --- /dev/null +++ b/website/content/bot/reference/discord/options/unu.md @@ -0,0 +1,42 @@ +--- +title: unu +description: A documentation page about the Unu command, a tool that helps users retrieve + unusual options sorted by strike and expiration to identify potential trading opportunities. +keywords: +- unu command +- unusual options retrieval +- options sorting +- trading opportunities +- Volume to Open Interest ratio +- potential trading opportunities identification +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command allows a user to retrieve unusual options sorted by strike and expiration. It provides a list of the most unusual options in the market and can be used to identify potential trading opportunities. The results are sorted by the highest Volume to Open Interest ratio giving the user the ability to quickly identify potential trading opportunities. + +### Usage + +```python wordwrap +/op unu +``` + +--- + +## Parameters + +This command has no parameters + + + +--- + +## Examples + +``` +/op unu +``` + +--- diff --git a/website/content/bot/reference/discord/options/uoastock.md b/website/content/bot/reference/discord/options/uoastock.md new file mode 100644 index 000000000000..124ab3156e64 --- /dev/null +++ b/website/content/bot/reference/discord/options/uoastock.md @@ -0,0 +1,48 @@ +--- +title: uoastock +description: The uoastock command retrieves the 20-day average options volume by ticker, + including both calls and puts. This page provides instructions for its usage, including + how to filter stocks by price. +keywords: +- uoastock command +- options volume by ticker +- 20-day average options volume +- commands for stocks +- trading commands +- stock price filtering +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command allows the user to retrieve the 20-day average options volume by ticker. The volume is based on the total volume of all options traded in the given period of time, including calls and puts. + +### Usage + +```python wordwrap +/op uoastock [price] +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| price | Filter by stocks over a certain price | True | None | + + +--- + +## Examples + +``` +/op uoastock +``` + +``` +/op uoastock price:50 +``` + +--- diff --git a/website/content/bot/reference/discord/options/vol.md b/website/content/bot/reference/discord/options/vol.md new file mode 100644 index 000000000000..69a8f0ebc88d --- /dev/null +++ b/website/content/bot/reference/discord/options/vol.md @@ -0,0 +1,48 @@ +--- +title: vol +description: This page provides information on using the 'vol' command in retrieving + Options Volume by Strike for a specified ticker. It also includes usage examples + and how to add an expiration date for more specific data. +keywords: +- Options Volume +- Stock Ticker +- Expiration Date +- Command 'vol' +- Retrieve Ticker Data +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command allows the user to retrieve a chart of Options Volume by Strike for a specified ticker. This data can be broken down further by adding an expiration date for a more detailed breakdown. + +### Usage + +```python wordwrap +/op vol ticker [expiry] +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| ticker | Stock Ticker | False | None | +| expiry | Expiration Date (optional) | True | None | + + +--- + +## Examples + +``` +/op vol ticker:AMD +``` + +``` +/op vol ticker:AMD expiry:2022-07-29 +``` + +--- diff --git a/website/content/bot/reference/discord/options/vsurf.md b/website/content/bot/reference/discord/options/vsurf.md new file mode 100644 index 000000000000..9b184e8476f8 --- /dev/null +++ b/website/content/bot/reference/discord/options/vsurf.md @@ -0,0 +1,50 @@ +--- +title: vsurf +description: This page provides instructions on how to use the 'vsurf' command to + retrieve an options volatility surface for a specific stock ticker, detailing implied + volatilities, open interest, and last price. +keywords: +- vsurf command +- options volatility surface +- stock ticker +- implied volatilities +- open interest +- last price +- command usage +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command allows the user to retrieve an options volatility surface for the ticker symbol. Specifically, it will provide a surface based on implied volatilities calculated from options prices, indicating the relationship between the stock price and the implied volatility of options on the stock. + +### Usage + +```python wordwrap +/op vsurf ticker z +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| ticker | Stock Ticker | False | None | +| z | The variable for the Z axis | False | Volatility (IV), Open Interest (OI), Last Price (LP) | + + +--- + +## Examples + +``` +/op vsurf ticker:AMD z:Volatility +``` + +``` +/op vsurf ticker:AMD z:Open Interest +``` + +--- diff --git a/website/content/bot/reference/discord/pop/1d.md b/website/content/bot/reference/discord/pop/1d.md new file mode 100644 index 000000000000..31cceebd049b --- /dev/null +++ b/website/content/bot/reference/discord/pop/1d.md @@ -0,0 +1,43 @@ +--- +title: 1d +description: Understand how to use the /pop 1d command to retrieve the top 15 tickers + based on popularity. This command operates across all our platforms providing an + overview of the most popular stocks in the last 24 hours. +keywords: +- top 15 tickers +- day popularity +- OpenBB Bot +- popular stocks +- 24 hour stocks +- stock market overview +- /pop 1d command +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command retrieves the top 15 tickers for the day based on popularity on the OpenBB Bot across all our platforms. It allows users to get an overview of the most popular stocks in the market within the last 24 hours. + +### Usage + +```python wordwrap +/pop 1d +``` + +--- + +## Parameters + +This command has no parameters + + + +--- + +## Examples + +``` +/pop 1d +``` +--- diff --git a/website/content/bot/reference/discord/pop/1hr.md b/website/content/bot/reference/discord/pop/1hr.md new file mode 100644 index 000000000000..3fcd574dd0db --- /dev/null +++ b/website/content/bot/reference/discord/pop/1hr.md @@ -0,0 +1,45 @@ +--- +title: 1hr +description: The /pop 1hr command page is about a command associated with the OpenBB + Bot. This command shares information about the top 15 most traded stocks in the + past hour across all our platforms, helping users to monitor active stocks and anticipate + market trends. +keywords: +- OpenBB Bot +- active stocks +- stock trading +- stock trends +- /pop 1hr command +- trading platforms +- trading strategies +- trade updates +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command retrieves the top 15 stocks that have been traded in the past hour on the OpenBB Bot across all our platforms. It provides the user with an up-to-date overview of the stocks that have been the most active over the past hour, allowing the user to quickly identify trends and potentially capitalize on them. + +### Usage + +```python wordwrap +/pop 1hr +``` + +--- + +## Parameters + +This command has no parameters + + + +--- + +## Examples + +``` +/pop 1hr +``` +--- diff --git a/website/content/bot/reference/discord/screeners/ah.md b/website/content/bot/reference/discord/screeners/ah.md new file mode 100644 index 000000000000..9bef720e0e3f --- /dev/null +++ b/website/content/bot/reference/discord/screeners/ah.md @@ -0,0 +1,44 @@ +--- +title: ah +description: This page provides information on how to retrieve After-Hours stock movers + using a chosen screener with the command '/scr ah signal'. Examples and parameter + details are included. +keywords: +- After-Hours stock movers +- screener preset +- /scr ah signal +- After-Hours Top Gainers +- After-Hours Top Losers +- After-Hours Most Active +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command allows the user to retrieve After-Hours stock movers according to a chosen screener. + +### Usage + +```python wordwrap +/scr ah signal +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| signal | screener preset | False | After-Hours Top Gainers (ahgainers), After-Hours Top Losers (ahlosers), After-Hours Most Active (ahmost_active) | + + +--- + +## Examples + +``` +/scr ah signal:After-Hours Top Gainers +``` + +--- diff --git a/website/content/bot/reference/discord/screeners/ah_all.md b/website/content/bot/reference/discord/screeners/ah_all.md new file mode 100644 index 000000000000..7b909f0db283 --- /dev/null +++ b/website/content/bot/reference/discord/screeners/ah_all.md @@ -0,0 +1,44 @@ +--- +title: ah_all +description: The documentation page explains the usage, parameters, and examples of + the ah_all command used to retrieve all available after-hours stock market screeners, + including gainers, losers, and the most active ones. +keywords: +- after-hours screeners +- stock market +- trading +- ah_all command +- gainers +- losers +- most active +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command retrieves all available after-hours screeners (gainers, losers, and most active). It is helpful for users who need to quickly access and review all the available after-hours screeners without having to search through a large list. + +### Usage + +```python wordwrap +/scr ah_all +``` + +--- + +## Parameters + +This command has no parameters + + + +--- + +## Examples + +``` +/scr ah_all +``` + +--- diff --git a/website/content/bot/reference/discord/screeners/all.md b/website/content/bot/reference/discord/screeners/all.md new file mode 100644 index 000000000000..f47fe7cc2d96 --- /dev/null +++ b/website/content/bot/reference/discord/screeners/all.md @@ -0,0 +1,41 @@ +--- +title: all +description: This page provides information on using the '/scr all' command that allows + users to view all available screeners during market hours. This can aid in better + data analysis and decision making. +keywords: +- screener +- stock market +- market hours +- data analysis +- decision making +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command allows the user to view all available screeners during market hours. The results can then be used to further analyze the data and make better-informed decisions. + +### Usage + +```python wordwrap +/scr all +``` + +--- + +## Parameters + +This command has no parameters + + + +--- + +## Examples + +``` +/scr all +``` +--- diff --git a/website/content/bot/reference/discord/screeners/pm.md b/website/content/bot/reference/discord/screeners/pm.md new file mode 100644 index 000000000000..cba14ba4da4d --- /dev/null +++ b/website/content/bot/reference/discord/screeners/pm.md @@ -0,0 +1,46 @@ +--- +title: pm +description: "Our tool offers the ability to view the top pre-market gainers, losers,\ + \ and most active. This page will guide you on how to use the pm command to have\ + \ a better understanding of the market\u2019s movements before it officially opens." +keywords: +- Pre-Market Top Gainers +- Pre-Market Top Losers +- Pre-Market Most Active +- pm command +- Market Movement +- Financial Tools +- Market Analysis +- Stock Market +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command offers the user the ability to view the top pre-market gainers, losers, and most active, giving the user a better understanding of the market’s movements before the market officially opens. + +### Usage + +```python wordwrap +/scr pm signal +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| signal | screener preset | False | Pre-Market Top Gainers (pmgainers), Pre-Market Top Losers (pmlosers), Pre-Market Most Active (pmmost_active) | + + +--- + +## Examples + +``` +/scr pm signal:Pre-Market Top Gainers +``` + +--- diff --git a/website/content/bot/reference/discord/screeners/pm_all.md b/website/content/bot/reference/discord/screeners/pm_all.md new file mode 100644 index 000000000000..8f1d0e93a30d --- /dev/null +++ b/website/content/bot/reference/discord/screeners/pm_all.md @@ -0,0 +1,40 @@ +--- +title: pm_all +description: The documentation page describes the usage of the 'pm_all' command that + allows users to retrieve all available pre-market screeners. The page provides examples + of command usage without parameters. +keywords: +- pm_all +- retrieve +- pre-market screeners +- Parameters +- Usage +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command allows the user to retrieve all available pre-market screeners. + +### Usage + +```python wordwrap +/scr pm_all +``` + +--- + +## Parameters + +This command has no parameters + + +--- + +## Examples + +``` +/scr pm_all +``` +--- diff --git a/website/content/bot/reference/discord/screeners/technical.md b/website/content/bot/reference/discord/screeners/technical.md new file mode 100644 index 000000000000..cd8c4fc2b3f0 --- /dev/null +++ b/website/content/bot/reference/discord/screeners/technical.md @@ -0,0 +1,55 @@ +--- +title: technical +description: Learn how to use the command for retrieving stock screener results based + on your choice of a technical signal. Provides information on how to use technical + signals like Top Gainers, Top Losers, Most Active, among others. +keywords: +- stock screener +- technical signal +- Top Gainers +- Top Losers +- Most Active +- Most Volatile +- Relative Volatility +- Oversold (RSI 30) +- Overbought (RSI 70) +- Golden Cross +- Death Cross +- New 52week High +- New 52week Low +- Unusual Volume +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command allows the user to retrieve stock screener results according to the chosen technical signal. + +### Usage + +```python wordwrap +/scr technical signal +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| signal | screener preset | False | Top Gainers (gainers), Top Losers (losers), Most Active (most_active), Most Volatile (most_volatile), Relative Volatility (relative_volatility), Oversold (RSI 30) (oversold), Overbought (RSI 70) (overbought), Golden Cross (golden_cross), Death Cross (death_cross), New 52week High (new_w52high), New 52week Low (new_w52low), Unusual Volume (unusual_volume) | + + +--- + +## Examples + +``` +/scr technical signal:Top Gainers +``` +``` +/scr technical signal:Death Cross +``` + +--- diff --git a/website/content/bot/reference/discord/short_data/borrowed.md b/website/content/bot/reference/discord/short_data/borrowed.md new file mode 100644 index 000000000000..2694492db1f9 --- /dev/null +++ b/website/content/bot/reference/discord/short_data/borrowed.md @@ -0,0 +1,45 @@ +--- +title: borrowed +description: Learn how to use the borrowed command to track the history of borrowed + shares and associated fees. Useful for traders and investors for comparing broker + fees and tracking share borrowing over time. +keywords: +- Stock trading +- Share borrowing +- Stock ticker +- Investors +- Traders +- Borrowed shares +- Broker fees +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command allows the user to view the history of borrowed shares available and fees associated with the stock with the ticker symbol. This can be a useful tool for traders and investors to track changes in share borrowing over time and to compare fees charged by different brokers. + +### Usage + +```python wordwrap +/sh borrowed ticker +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| ticker | Stock Ticker | False | None | + + +--- + +## Examples + +``` +/sh borrowed ticker:AMD +``` + +--- diff --git a/website/content/bot/reference/discord/short_data/hsi.md b/website/content/bot/reference/discord/short_data/hsi.md new file mode 100644 index 000000000000..ff0ef4b7b4d2 --- /dev/null +++ b/website/content/bot/reference/discord/short_data/hsi.md @@ -0,0 +1,46 @@ +--- +title: hsi +description: This documentation helps understand the 'hsi' command, which retrieves + the top high short interest stocks over a 20% ratio, a crucial tool for investors + looking for possible short squeeze potential. +keywords: +- hsi command +- high short interest stocks +- short squeeze potential +- stock investing +- trading tools +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command retrieves the top high short interest stocks over a 20% ratio. This information can let an investor identify possible short squeeze potential. + +### Usage + +```python wordwrap +/sh hsi [num] +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| num | Number of top stocks to print | True | None | + + +--- + +## Examples + +``` +/sh hsi +``` +``` +/sh hsi num:4 +``` + +--- diff --git a/website/content/bot/reference/discord/short_data/shortrate.md b/website/content/bot/reference/discord/short_data/shortrate.md new file mode 100644 index 000000000000..265c049ce190 --- /dev/null +++ b/website/content/bot/reference/discord/short_data/shortrate.md @@ -0,0 +1,46 @@ +--- +title: shortrate +description: A comprehensive guide to using the shortrate command to check Interactive + Brokers' Display Short Shares spot borrow rates. Helps users make informed decisions + about short selling activities. +keywords: +- shortrate command +- Interactive Brokers +- spot borrow rates +- short selling +- Display Short Shares +- stock ticker +- shortrate usage +- shortrate examples +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command allows the user to retrieve the Display Short Shares spot borrow rate from Interactive Brokers for the given ticker. The spot borrow rate is the rate at which a user may borrow shares from the broker in order to short sell the security. This command allows the user to check the current rate and make more informed decisions about their short selling activities. + +### Usage + +```python wordwrap +/sh shortrate ticker +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| ticker | Stock Ticker | False | None | + + +--- + +## Examples + +``` +/sh shortrate ticker:AMD +``` + +--- diff --git a/website/content/bot/reference/discord/short_data/shortvol.md b/website/content/bot/reference/discord/short_data/shortvol.md new file mode 100644 index 000000000000..663ce9a10162 --- /dev/null +++ b/website/content/bot/reference/discord/short_data/shortvol.md @@ -0,0 +1,46 @@ +--- +title: shortvol +description: The page describes the 'shortvol' command used to retrieve 30-day history + of short volume vs total volume of a stock ticker. It can be a useful tool to predict + future price movements based on trade activity. +keywords: +- shortvol command +- stock ticker +- trade activity +- price movements +- total volume +- short volume +- trade data analysis +- stock trading +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command allows the user to retrieve a graph of the 30 day history of the short volume versus the total volume of the stock ticker. The graph also displays the ratio of the total amount of shares that have been sold short versus the total amount of shares traded over the past 30 days. This data can be used to get a better understanding of the stock's trading activity and potential future price movements. + +### Usage + +```python wordwrap +/sh shortvol ticker +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| ticker | Stock Ticker | False | None | + + +--- + +## Examples + +``` +/sh shortvol ticker:AMD +``` + +--- diff --git a/website/content/bot/reference/discord/short_data/topshortvol.md b/website/content/bot/reference/discord/short_data/topshortvol.md new file mode 100644 index 000000000000..7c43429c83bb --- /dev/null +++ b/website/content/bot/reference/discord/short_data/topshortvol.md @@ -0,0 +1,45 @@ +--- +title: topshortvol +description: This docusaurus page provides detailed information about the 'topshortvol' + command, which retrieves the Top 15 Short Interest Stocks per Finra, providing essential + data for traders. +keywords: +- topshortvol +- Finra +- trading data +- short vol +- Short Interest Stocks +- stock market +- trading day +- traders +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command allows the user to retrieve the Top 15 Short Interest Stocks per Finra. It's typically measured as a ratio of the stock's total short vol divided by the total volume for the trading day. This information is essential for traders to make informed decisions in the market. + +### Usage + +```python wordwrap +/sh topshortvol +``` + +--- + +## Parameters + +This command has no parameters + + + +--- + +## Examples + +``` +/sh topshortvol +``` + +--- diff --git a/website/versioned_docs/version-v3/bot/reference/generate_index.py b/website/content/bot/reference/generate_index.py similarity index 82% rename from website/versioned_docs/version-v3/bot/reference/generate_index.py rename to website/content/bot/reference/generate_index.py index a15ea1710538..f2b295b7ebce 100644 --- a/website/versioned_docs/version-v3/bot/reference/generate_index.py +++ b/website/content/bot/reference/generate_index.py @@ -11,22 +11,22 @@ def create_cmd_cards(cmd_text: List[Dict[str, str]], url: str) -> str: - cmd_cards = "" + _cmd_cards = "" for cmd in cmd_text: cmd["description"] = shorten(f"{cmd['description']}", 116, placeholder="...") - cmd_cards += f"""\n""" - return cmd_cards + return _cmd_cards -def create_nested_subfolder_card(folder: Path, url: str) -> str: +def create_nested_subfolder_card(_folder: Path, url: str) -> str: nested_card = f"""\n""" return nested_card @@ -40,10 +40,9 @@ def create_nested_subfolder_card(folder: Path, url: str) -> str: if file.stem == "index": continue - desc_regex = re.compile( - r"---\n\n# ([^\n]+)(.*)### Usage", (re.DOTALL | re.MULTILINE) - ) - description = desc_regex.search(file.read_text()).group(2).strip() # type: ignore + desc_regex = re.compile(r"([^>]+)(.*)### Usage", (re.MULTILINE)) + + description = desc_regex.search(file.read_text()).group(1).strip() # type: ignore cmd_dict = dict( name=file.stem, diff --git a/website/versioned_docs/version-v3/bot/reference/telegram/_category_.json b/website/content/bot/reference/telegram/_category_.json similarity index 100% rename from website/versioned_docs/version-v3/bot/reference/telegram/_category_.json rename to website/content/bot/reference/telegram/_category_.json diff --git a/website/content/bot/reference/telegram/charts/c.md b/website/content/bot/reference/telegram/charts/c.md new file mode 100644 index 000000000000..cee00ac40f10 --- /dev/null +++ b/website/content/bot/reference/telegram/charts/c.md @@ -0,0 +1,56 @@ +--- +title: c +description: Command for retrieving a detailed candlestick chart for the specified + cryptocurrency coin. This includes an opening and closing price, as well as the + high and low within a definite time interval. Options to include support/resistant + lines and Fibonacci retracement levels are available. +keywords: +- Crypto Currency +- Crypto Coin +- Candlestick Chart +- Crypto Exchange +- Trading Parameters +- Support Resistance Lines +- Fibonacci Retracement Levels +- Crypto Symbol +- Crypto Trading Command +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command will retrieve a candlestick chart for the crypto coin provided. The interval provided must be a valid time interval (default 15 minutes). The chart will be displayed to the user and will contain information such as the opening and closing prices, the high and low, the volume, and any other relevant information. + +### Usage + +```python wordwrap +/c symbol [currency] [exchange] [interval] [srlines] [fibs] +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| symbol | Crypto Symbol | False | None | +| currency | Crypto Currency. Default: USDT | True | None | +| exchange | Crypto Exchange. Default: binanceus | True | None | +| interval | 1m: 1 Minute 3m: 3 Minutes 5m: 5 Minutes 15m: 15 Minutes 30m: 30 Minutes 1hr: 1 Hour 1d: 1 Day 1wk: 1 Week 1mo: 1 Month | True | 1m, 3m, 5m, 15m, 30m, 1hr, 1d, 1wk, 1mo | +| srlines | Show Support/Resistance Lines. Default: False | True | None | +| fibs | Show Fibonacci Retracement Levels. Default: False | True | None | + + +--- + +## Examples + +``` +/c doge +``` + +``` +/c doge interval:3m +``` +--- diff --git a/website/content/bot/reference/telegram/charts/c15m.md b/website/content/bot/reference/telegram/charts/c15m.md new file mode 100644 index 000000000000..6bf5451a828d --- /dev/null +++ b/website/content/bot/reference/telegram/charts/c15m.md @@ -0,0 +1,45 @@ +--- +title: c15m +description: The c15m command helps to retrieve a 15-minute intraday chart for a specific + stock ticker, useful for technical analysis and tracking short-term price movements. +keywords: +- c15m command +- intraday chart +- stock ticker +- technical analysis +- short-term price movements +- stock tracking +- stock volume +- stock price +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command allows the user to retrieve a 15-minute intraday chart for a given ticker. The chart will show the price and volume of the stock over the past 3 days in 15 minute intervals. This command is useful for performing technical analysis and tracking short-term price movements. + +### Usage + +```python wordwrap +/c15m ticker +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| ticker | Stock Ticker | False | None | + + +--- + +## Examples + +``` +/c15m AMD +``` + +--- diff --git a/website/content/bot/reference/telegram/charts/c3m.md b/website/content/bot/reference/telegram/charts/c3m.md new file mode 100644 index 000000000000..f6bb1870e6b6 --- /dev/null +++ b/website/content/bot/reference/telegram/charts/c3m.md @@ -0,0 +1,51 @@ +--- +title: c3m +description: The c3m command allows users to generate a 3-minute intraday chart for + the provided ticker, offering a visual representation of stock performance for short-term + investors. The page also covers usage details, parameters, and example commands. +keywords: +- c3m command +- candlestick chart +- intraday chart +- stock performance +- short-term investors +- stock ticker +- trading hours +- AMD +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command allows users to retrieve a 3-minute intraday chart for the given ticker. This chart will display the candlestick chart for the day. It will provide a visual representation of the stock's performance over the current day, making it helpful for short-term investors. + +### Usage + +```python wordwrap +/c3m ticker [extended_hours] +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| ticker | Stock Ticker | False | None | +| extended_hours | Show Full 4am-8pm ET Trading Hours. True/False Default: False | True | None | + + +--- + +## Examples + +``` +/c3m AMD +``` + +``` +/c3m AMD true +``` + +--- diff --git a/website/content/bot/reference/telegram/charts/c5m.md b/website/content/bot/reference/telegram/charts/c5m.md new file mode 100644 index 000000000000..e7741dd150df --- /dev/null +++ b/website/content/bot/reference/telegram/charts/c5m.md @@ -0,0 +1,51 @@ +--- +title: c5m +description: The c5m command page details how to retrieve an intraday 5 minute chart + for a particular stock ticker. The chart serves as a valuable tool for technical + analysis and tracking short-term price movements. +keywords: +- c5m +- intraday chart +- 5 minute chart +- candlestick chart +- stock performance +- technical analysis +- short-term price movements +- extended hours +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command allows the user to retrieve an intraday 5 minute chart for a given ticker. This chart will display the candlestick chart for the day. It will provide a visual representation of the stock's performance over the current day. This command is useful for performing technical analysis and tracking short-term price movements. + +### Usage + +```python wordwrap +/c5m ticker [extended_hours] +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| ticker | Stock Ticker | False | None | +| extended_hours | Show Full 4am-8pm ET Trading Hours. Default: False | True | None | + + +--- + +## Examples + +``` +/c5m AMD +``` + +``` +/c5m AMD true +``` + +--- diff --git a/website/content/bot/reference/telegram/charts/cc.md b/website/content/bot/reference/telegram/charts/cc.md new file mode 100644 index 000000000000..d1fdffc7dcc7 --- /dev/null +++ b/website/content/bot/reference/telegram/charts/cc.md @@ -0,0 +1,48 @@ +--- +title: cc +description: This page provides information on how to utilize the /cc command, which + generates an intraday 5 minute chart for a given stock ticker. It allows users to + visually track the stock's performance throughout the day and aids in technical + analysis. +keywords: +- stock ticker +- /cc command +- intraday chart +- candlestick chart +- technical analysis +- short-term price movements +- stock's performance +- extended trading hours +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command allows the user to retrieve an intraday 5 minute chart for a given ticker, /c5m also has the same effect. This chart will display the candlestick chart for the day. It will provide a visual representation of the stock's performance over the current day. This command is useful for performing technical analysis and tracking short-term price movements. + +### Usage + +```python wordwrap +/cc ticker [extended_hours] +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| ticker | Stock Ticker | False | None | +| extended_hours | Show Full 4am-8pm ET Trading Hours. Default: False | True | None | + + +--- + +## Examples + +``` +/cc amd +``` + +--- diff --git a/website/content/bot/reference/telegram/charts/cd.md b/website/content/bot/reference/telegram/charts/cd.md new file mode 100644 index 000000000000..55d8976d8f08 --- /dev/null +++ b/website/content/bot/reference/telegram/charts/cd.md @@ -0,0 +1,49 @@ +--- +title: cd +description: This documentation page provides an understanding of how to use the 'cd' + command to retrieve daily candlestick chart for a particular stock ticker or coin. + Instructions for usage and examples are provided. +keywords: +- cd command +- candlestick chart +- stock ticker +- coin +- opening price +- closing price +- highs and lows +- performance analysis +- AMD ticker +- command usage +- docusaurus documentation +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command allows the user to retrieve a daily candlestick chart for a particular ticker or coin. The candlestick chart provides information about the opening and closing prices of the day, as well as the high and low prices of the day. This data can then be used to analyze the performance of the ticker/coin over time. For example, if the user provides the command "/cd AMD", the chart will be generated for the ticker AMD. + +### Usage + +```python wordwrap +/cd ticker +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| ticker | Stock Ticker | False | None | + + +--- + +## Examples + +``` +/cd AMD +``` + +--- diff --git a/website/content/bot/reference/telegram/charts/chart.md b/website/content/bot/reference/telegram/charts/chart.md new file mode 100644 index 000000000000..f4e09fe13cf8 --- /dev/null +++ b/website/content/bot/reference/telegram/charts/chart.md @@ -0,0 +1,52 @@ +--- +title: chart +description: This documentation page provides detailed information about the Chart + command in our tool. The command retrieves a candlestick chart based on the provided + ticker and time interval, displaying vital trading data such as opening/closing + prices and volume for the specified number of previous days. +keywords: +- Chart Command +- Candlestick Chart +- Stock Ticker +- Time Interval +- Opening and Closing Prices +- Trading Volume +- Past Days Display +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command will retrieve a candlestick chart for the ticker/interval provided, with data for the past number of days specified. The interval provided must be a valid time interval (e.g. 5 minute, 15 minute, etc.). The chart will be displayed to the user and will contain information such as the opening and closing prices, the high and low, the volume, and any other relevant information. + +### Usage + +```python wordwrap +/chart ticker interval [past_days] +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| ticker | Stock Ticker | False | None | +| interval | `1m`, `5m`, `10m`, `15m`, `30m`, `60m`, `1d`, `1wk`, `1mo` Default: `15m` | False | 1d, 1wk, 1mo, 1m, 5m, 10m, 15m, 30m, 1hr | +| past_days | Past Days to Display. Default: 0 | True | None | + + +--- + +## Examples + +``` +/chart AMD 1d 10 +``` + +``` +/chart AMD 1d +``` + +--- diff --git a/website/content/bot/reference/telegram/charts/chartfib.md b/website/content/bot/reference/telegram/charts/chartfib.md new file mode 100644 index 000000000000..559f4d83c16d --- /dev/null +++ b/website/content/bot/reference/telegram/charts/chartfib.md @@ -0,0 +1,44 @@ +--- +title: chartfib +description: The chartfib command page provides information on how to retrieve Fibonacci + levels for a given stock ticker. This can be used to identify potential support + and resistance levels for trading in the stock market. +keywords: +- chartfib +- Fibonacci levels +- stock ticker +- support and resistance levels +- potential entry and exit points +- stock market +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command allows the user to retrieve Fibonacci levels for a given ticker. This data can be used to identify potential support and resistance levels and can be used to identify potential entry and exit points in the stock market. + +### Usage + +```python wordwrap +/chartfib ticker +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| ticker | Stock Ticker | False | None | + + +--- + +## Examples + +``` +/chartfib AMD +``` + +--- diff --git a/website/content/bot/reference/telegram/charts/chartsr.md b/website/content/bot/reference/telegram/charts/chartsr.md new file mode 100644 index 000000000000..6baa4dfc3f83 --- /dev/null +++ b/website/content/bot/reference/telegram/charts/chartsr.md @@ -0,0 +1,51 @@ +--- +title: chartsr +description: The '/chartsr' command page provides insights on how the command can + be utilized by the user to retrieve data on support and resistance levels for the + given ticker. This can significantly improve their trading decisions. +keywords: +- chartsr command +- support and resistance levels +- ticker trading +- trade decision making +- stock ticker +- trading intervals +- AMC +- 1d interval +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command allows the user to retrieve Displays Support and Resistance Levels for the ticker provided. It will display the support and resistance levels of a given ticker on the chart. These levels can help the user in making better trading decisions. + +### Usage + +```python wordwrap +/chartsr ticker [interval] +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| ticker | Stock Ticker | False | None | +| interval | 5m, 15m, 1d. Default: 1d | True | 5m, 15m, 1d | + + +--- + +## Examples + +``` +/chartsr AMC +``` + +``` +/chartsr AMC 1d +``` + +--- diff --git a/website/content/bot/reference/telegram/charts/cm.md b/website/content/bot/reference/telegram/charts/cm.md new file mode 100644 index 000000000000..f22a6c4c8b97 --- /dev/null +++ b/website/content/bot/reference/telegram/charts/cm.md @@ -0,0 +1,46 @@ +--- +title: cm +description: This page provides information about using the /cm command to retrieve + a weekly candlestick chart for a specified ticker/coin. It presents the usage, parameters, + and examples of the command illuminating aspects such as opening and closing prices, + high and low prices, and the trading volume. +keywords: +- cm command +- candlestick chart +- trading volume +- high and low prices +- stock ticker +- opening and closing prices +- /cm command usage +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command allows the user to retrieve a weekly candlestick chart for the ticker/coin provided. The chart displays the opening and closing prices, the high and low prices, and the trading volume for the week for the specified ticker/coin. + +### Usage + +```python wordwrap +/cm ticker +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| ticker | Stock Ticker | False | None | + + +--- + +## Examples + +``` +/cm AMD +``` + +--- diff --git a/website/content/bot/reference/telegram/charts/cw.md b/website/content/bot/reference/telegram/charts/cw.md new file mode 100644 index 000000000000..d5baf82da7dc --- /dev/null +++ b/website/content/bot/reference/telegram/charts/cw.md @@ -0,0 +1,45 @@ +--- +title: cw +description: The page provides detailed information on using the 'cw' command to retrieve + the weekly candlestick chart for any specified ticker or coin. It contains parameters' + details and usage examples. +keywords: +- weekly candlestick chart +- trading volume +- stock ticker +- cw command +- opening and closing prices +- high and low prices +- ticker/coin +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command allows the user to retrieve a weekly candlestick chart for the ticker/coin provided. The chart displays the opening and closing prices, the high and low prices, and the trading volume for the week for the specified ticker/coin. + +### Usage + +```python wordwrap +/cw ticker +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| ticker | Stock Ticker | False | None | + + +--- + +## Examples + +``` +/cw AMD +``` + +--- diff --git a/website/content/bot/reference/telegram/crypto/bigprints.md b/website/content/bot/reference/telegram/crypto/bigprints.md new file mode 100644 index 000000000000..e43affb93b64 --- /dev/null +++ b/website/content/bot/reference/telegram/crypto/bigprints.md @@ -0,0 +1,50 @@ +--- +title: bigprints +description: The bigprints page offers detailed information about using the command + to retrieve the last 15 large print data points for a specified cryptocurrency pair. + This data can assist users in making informed trading decisions based on recent + trends. +keywords: +- bigprints +- cryptocurrency +- large prints +- trading decisions +- crypto +- coin +- days +- /bigprints ada +- BTC-USD +- /crypto bigprints coin:BTC-USD +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command allows the user to retrieve the last 15 large prints for a given cryptocurrency pair. The command uses the format "/crypto bigprints coin:BTC-USD" where BTC-USD is the currency pair for which the user wants to retrieve the large prints. This command is useful for analyzing the recent large prints of a given currency pair, which can be used to inform trading decisions. + +### Usage + +```python wordwrap +/bigprints coin [days] +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| coin | Coin to get prints for (e.g., btc) | False | ADA, AVAX, BTC, DAI, DOGE, DOT, ETH, LTC, MATIC, SHIB, SOL, TRX, USDC, USDT, WBTC, XRP | +| days | Number of days to get prints for (default: 10) | True | None | + + +--- + +## Examples + +``` +/bigprints ada +``` + +--- diff --git a/website/content/bot/reference/telegram/crypto/bio.md b/website/content/bot/reference/telegram/crypto/bio.md new file mode 100644 index 000000000000..7a23fe053d02 --- /dev/null +++ b/website/content/bot/reference/telegram/crypto/bio.md @@ -0,0 +1,45 @@ +--- +title: bio +description: The page provides instructions on how to use the /bio command to retrieve + key financial data of a particular cryptocurrency, including its current price, + 24-hour trading volume, market cap, and more, by using the crypto's specific symbol. +keywords: +- crypto info +- crypto symbol +- 24-hour trading volume +- /bio command +- market cap +- crypto trading +- BTC +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command allows the user to retrieve fundamental information about a crypto, such as its current price, 24-hour trading volume, market cap, and other key metrics, by entering a specific crypto symbol (e.g. "BTC") as an argument. + +### Usage + +```python wordwrap +/bio symbol +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| symbol | Crypto symbol to check information (e.g., BTC) | False | None | + + +--- + +## Examples + +``` +/bio btc +``` + +--- diff --git a/website/content/bot/reference/telegram/crypto/compfees.md b/website/content/bot/reference/telegram/crypto/compfees.md new file mode 100644 index 000000000000..06f35e7f6ca9 --- /dev/null +++ b/website/content/bot/reference/telegram/crypto/compfees.md @@ -0,0 +1,48 @@ +--- +title: compfees +description: Learn how to retrieve the Protocol fees over time for your projects using + the compfees command. Understand its usage, parameters, and see examples. +keywords: +- compfees command +- Protocol fees +- btc +- eth +- usage +- parameters +- examples +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command allows users to retrieve the Protocol fees over time for the given project. + +### Usage + +```python wordwrap +/compfees projects +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| projects | Comma separated list of protocols (e.g., btc,eth) | False | None | + + +--- + +## Examples + +``` +/compfees doge +``` + +``` +/compfees projects: btc,eth +``` + +--- diff --git a/website/content/bot/reference/telegram/crypto/defi.md b/website/content/bot/reference/telegram/crypto/defi.md new file mode 100644 index 000000000000..b9e6fedb3b0a --- /dev/null +++ b/website/content/bot/reference/telegram/crypto/defi.md @@ -0,0 +1,51 @@ +--- +title: defi +description: The page provides information about the '/defi' command which retrieves + a chart or table of top DeFi protocols by market cap. It includes details on how + to use the command, its parameters, and examples. +keywords: +- DeFi protocols +- market capitalization +- DeFi market size +- visual representation +- DeFi landscape +- /defi command +- sort data +- filter by chain +- reverse sort order +- show chart +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command will retrieve a chart or table of the top DeFi protocols by market capitalization. It will provide a visual representation of the relative size of each protocol, as well as an overview of the total DeFi market size. This will enable users to get a better understanding of the current DeFi landscape and identify which protocols are leading the way. + +### Usage + +```python wordwrap +/defi [sortby] [chain] [reverse] [chart] +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| sortby | Column to sort data by (e.g., tvl) | True | tvl, mc, 1hr, 1d, 1wk | +| chain | Chain to filter by (e.g., ethereum) | True | None | +| reverse | Reverse the sort order (e.g., True) (default: False) | True | None | +| chart | Show chart (e.g., True) (default: False) | True | None | + + +--- + +## Examples + +``` +/defi chart +``` + +--- diff --git a/website/content/bot/reference/telegram/crypto/fees.md b/website/content/bot/reference/telegram/crypto/fees.md new file mode 100644 index 000000000000..93bd783d71cf --- /dev/null +++ b/website/content/bot/reference/telegram/crypto/fees.md @@ -0,0 +1,45 @@ +--- +title: fees +description: Learn how the 'fees' function of the website provides users with the + fee rate of top crypto protocols on a specific date, allowing them to compare different + protocols' fees and make an informed decision about their crypto dealings. +keywords: +- fees +- crypto protocols +- compare fees +- crypto decision +- fee rate +- crypto fee rate +- protocol fees +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This will provide the user with the fee rate of the top crypto protocols on a specified date, allowing the user to compare different protocols' fees and make an informed decision. + +### Usage + +```python wordwrap +/fees [date] +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| date | Date to get fees for (e.g., 2021-01-01) (default: today) | True | None | + + +--- + +## Examples + +``` +/fees date: 2023-04-19 +``` + +--- diff --git a/website/content/bot/reference/telegram/crypto/ir.md b/website/content/bot/reference/telegram/crypto/ir.md new file mode 100644 index 000000000000..f321c4394290 --- /dev/null +++ b/website/content/bot/reference/telegram/crypto/ir.md @@ -0,0 +1,42 @@ +--- +title: ir +description: The /ir command enables the user to retrieve the issuance rate of the + top crypto protocols, helping to understand supply dynamics and inform investment + decisions. +keywords: +- crypto protocols +- issuance rate +- investment decisions +- /ir command +- supply dynamics +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command allows the user to retrieve the issuance rate of the top crypto protocols. The issuance rate is the amount of new tokens that are generated by the protocol over a given period of time. It is a useful metric for understanding the supply dynamics of crypto protocols and is used to inform investment decisions. + +### Usage + +```python wordwrap +/ir +``` + +--- + +## Parameters + +This command has no parameters + + + +--- + +## Examples + +``` +/ir +``` + +--- diff --git a/website/content/bot/reference/telegram/crypto/prints.md b/website/content/bot/reference/telegram/crypto/prints.md new file mode 100644 index 000000000000..6ce736c57860 --- /dev/null +++ b/website/content/bot/reference/telegram/crypto/prints.md @@ -0,0 +1,46 @@ +--- +title: prints +description: Documentation on the command allowing the user to retrieve the latest + 15 crypto prints for the specified coin over the last 24 hours. It includes information + on the price, volume size, and other trading metrics. +keywords: +- Crypto Prints +- Bitcoin prints +- Ethereum prints +- Cryptocurrency tracking +- 24 hours cryptocurrency metrics +- Prints command +- Cryptocurrency trade volume +- Cryptocurrency price tracking +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command allows the user to retrieve the Last 15 Crypto Prints over the last 24 hours for the specified coin. The command will provide information on the price, volume, size, and other metrics associated with the prints. + +### Usage + +```python wordwrap +/prints coin +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| coin | Coin to get prints for (e.g., btc) | False | ADA, AVAX, BTC, DAI, DOGE, DOT, ETH, LTC, MATIC, SHIB, SOL, TRX, USDC, USDT, WBTC, XRP | + + +--- + +## Examples + +``` +/prints ada +``` + +--- diff --git a/website/content/bot/reference/telegram/crypto/top.md b/website/content/bot/reference/telegram/crypto/top.md new file mode 100644 index 000000000000..d312d3424e18 --- /dev/null +++ b/website/content/bot/reference/telegram/crypto/top.md @@ -0,0 +1,52 @@ +--- +title: top +description: The page provides instructions on the use of the 'top' command, a feature + to retrieve top cryptocurrencies by market capitalization, inclusive of component + parameters and usage examples. +keywords: +- cryptocurrencies +- market capitalization +- top command +- user instructions +- command usage +- sortby parameter +- category filter +- reverse sort +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command will retrieve the top cryptocurrencies, ranked by market capitalization, allowing the user to quickly get a snapshot of the current market. + +### Usage + +```python wordwrap +/top [sortby] [category] [reverse] +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| sortby | Column to sort data by (e.g., mc) | True | mc, vol, 1hr, 1d, 1wk | +| category | Category to filter by (e.g., stablecoins) | True | None | +| reverse | Reverse the sort order (e.g., True) (default: False) | True | None | + + +--- + +## Examples + +``` +/top +``` + +``` +/top mc marketing +``` + +--- diff --git a/website/content/bot/reference/telegram/crypto/tvl.md b/website/content/bot/reference/telegram/crypto/tvl.md new file mode 100644 index 000000000000..f085b27f9f84 --- /dev/null +++ b/website/content/bot/reference/telegram/crypto/tvl.md @@ -0,0 +1,49 @@ +--- +title: tvl +description: On this page, users can learn how to retrieve historical TVL (Total Value + Locked) data for any given protocol, providing a snapshot of capital currently locked + in the protocol for comparison and tracking of growth over time. +keywords: +- TVL +- historical data +- total value locked +- protocol +- capital +- comparison +- tracking growth +- tvl command +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command allows users to retrieve historical TVL (Total Value Locked) data for any given protocol. It provides a snapshot of the total amount of capital that is currently locked in the protocol, allowing users to easily compare the metrics between different protocols and track their growth over time. + +### Usage + +```python wordwrap +/tvl [protocols] +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| protocols | comma separated list of protocols (e.g., curve,makerdao) | True | None | + + +--- + +## Examples + +``` +/tvl +``` +``` +/tvl curve +``` + +--- diff --git a/website/content/bot/reference/telegram/darkpool/allblocks.md b/website/content/bot/reference/telegram/darkpool/allblocks.md new file mode 100644 index 000000000000..540798eb3297 --- /dev/null +++ b/website/content/bot/reference/telegram/darkpool/allblocks.md @@ -0,0 +1,42 @@ +--- +title: allblocks +description: Page explaining the allblocks command in a trading platform, used to + retrieve and summarise the last 15 block trades of a specified security. +keywords: +- allblocks +- block trades +- security +- stock ticker +- trade summary +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +The command allows the user to retrieve the last 15 block trades of a given security. This command will provide a summary of the last 15 block trades, including the time, price, quantity, and total gross value of each trade. + +### Usage + +```python wordwrap +/allblocks ticker +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| ticker | Stock Ticker | False | None | + + +--- + +## Examples + +``` +/allblocks AMD +``` + +--- diff --git a/website/content/bot/reference/telegram/darkpool/alldp.md b/website/content/bot/reference/telegram/darkpool/alldp.md new file mode 100644 index 000000000000..c663691939a8 --- /dev/null +++ b/website/content/bot/reference/telegram/darkpool/alldp.md @@ -0,0 +1,43 @@ +--- +title: alldp +description: This page provides information on the alldp command which retrieves the + last 15 darkpool trades for the specified stock ticker. Basic guidelines on the + usage, parameters, and examples are also provided. +keywords: +- alldp command +- darkpool trades +- stock ticker +- private stock trading +- efficient trades +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command allows the user to retrieve the last 15 darkpool trades for the specified stock ticker. A darkpool is a private stock trading system that allows large trades to take place without affecting the public market, providing access to larger and more efficient trades. + +### Usage + +```python wordwrap +/alldp ticker +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| ticker | Stock Ticker | False | None | + + +--- + +## Examples + +``` +/alldp AMD +``` + +--- diff --git a/website/content/bot/reference/telegram/darkpool/allprints.md b/website/content/bot/reference/telegram/darkpool/allprints.md new file mode 100644 index 000000000000..81b617ffb970 --- /dev/null +++ b/website/content/bot/reference/telegram/darkpool/allprints.md @@ -0,0 +1,43 @@ +--- +title: allprints +description: This page provides a guide on the command 'allprints', which retrieves + the last 15 combinations of Dark Pool and Blocks for a given stock ticker symbol, + showing the date, time, price, and volume of the trades. +keywords: +- allprints command +- ticker symbol +- Dark Pool trades +- Blocks in stock market +- stock market trades +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command retrieves the Last 15 Combination of Dark Pool and Blocks for a given ticker symbol. This can be used to view the most recent reported trades that involve Dark Pool and Blocks in the stock market. The results of this command will show the date, time, price, and volume of the trades. + +### Usage + +```python wordwrap +/allprints ticker +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| ticker | Stock Ticker | False | None | + + +--- + +## Examples + +``` +/allprints AMD +``` + +--- diff --git a/website/content/bot/reference/telegram/darkpool/bigprintsdp.md b/website/content/bot/reference/telegram/darkpool/bigprintsdp.md new file mode 100644 index 000000000000..9a89f9789bd5 --- /dev/null +++ b/website/content/bot/reference/telegram/darkpool/bigprintsdp.md @@ -0,0 +1,46 @@ +--- +title: bigprintsdp +description: This documentation page discusses how to use the command /bigprintsdp + to retrieve the largest combination of dark pool and block trades, providing a comprehensive + view of market activities over a specified number of days. The page also covers + usage, parameters, and examples of the command. +keywords: +- bigprintsdp command +- dark pool trades +- block trades +- market activities +- command usage +- command parameters +- command examples +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command will retrieve the largest combination of dark pool and block trades over a specified amount of days. It will provide a comprehensive view of the biggest dark pool and block trades over the specified number of days and give the user an idea of the market activity over that period. + +### Usage + +```python wordwrap +/bigprintsdp days +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| days | Number of days to look back | False | None | + + +--- + +## Examples + +``` +/bigprintsdp 6 +``` + +--- diff --git a/website/content/bot/reference/telegram/darkpool/levels.md b/website/content/bot/reference/telegram/darkpool/levels.md new file mode 100644 index 000000000000..d6f4422b57b0 --- /dev/null +++ b/website/content/bot/reference/telegram/darkpool/levels.md @@ -0,0 +1,49 @@ +--- +title: levels +description: This documentation page explains the 'levels' command used to retrieve + the biggest levels for all prints over the last x days for a particular stock ticker. + It provides its usage, parameters, and examples to help enhance your stock assessment. +keywords: +- Levels Command +- Stock Ticker +- Print levels +- Stock Performance +- Stock Assessment +- Documentation +- Command +- Parameters +- Examples +- Stock Information +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command allows the user to retrieve the Biggest Levels for All Prints over the last x days for the given ticker. This information is useful in assessing the overall performance of the stock, as it provides information on the largest levels of prints over the last x days. + +### Usage + +```python wordwrap +/levels ticker days +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| ticker | Stock Ticker | False | None | +| days | Number of days to look back | False | None | + + +--- + +## Examples + +``` +/levels TSLA 10 +``` + +--- diff --git a/website/content/bot/reference/telegram/darkpool/sectors.md b/website/content/bot/reference/telegram/darkpool/sectors.md new file mode 100644 index 000000000000..ae43d327dec2 --- /dev/null +++ b/website/content/bot/reference/telegram/darkpool/sectors.md @@ -0,0 +1,46 @@ +--- +title: sectors +description: 'The page contains information about the ''sectors'' command that retrieves + a summary of all prints by % of MarketCap by Sector over the last x days. The details + include the command usage, parameters required and examples to follow. ' +keywords: +- sectors command +- MarketCap by sector +- darkpool activity +- sector market cap +- accumulation +- days parameter +- sector parameter +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command allows the user to retrieve a summary of all prints by % of MarketCap by Sector over the last x days. The user will be able to view the sector's market cap divided by total darkpool activity to see possible accumulation. + +### Usage + +```python wordwrap +/sectors days sector +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| days | Number of days to look back | False | None | +| sector | Sector to filter by: `bm`: (Basic Materials), `e`: (Energy), `cs`: (Communication Services), `cc`: (Consumer Cyclical), `cd`: (Consumer Defensive), `f`: (Financial), `h`: (Healthcare), `i`: (Industrials), `re`: (Real Estate), `t`: (Technology), `u`: (Utilities) | False | None | + + +--- + +## Examples + +``` +/sectors 5 bm +``` + +--- diff --git a/website/content/bot/reference/telegram/darkpool/summary.md b/website/content/bot/reference/telegram/darkpool/summary.md new file mode 100644 index 000000000000..6a9239ad349a --- /dev/null +++ b/website/content/bot/reference/telegram/darkpool/summary.md @@ -0,0 +1,50 @@ +--- +title: summary +description: Documentation page for the '/summary' command, which retrieves a summary + of all prints by MarketCap percentage. The command and its parameters 'days' and + 'sort' are explained. The description provides various options for sorting, i.e., + by MarketCap, float, sum, or short percentage. +keywords: +- MarketCap Summary +- Prints by MarketCap +- Prints Summary +- Command /summary +- Parameter days +- Parameter sort +- Sort by MarketCap +- Sort by float +- Sort by sum +- Sort by short percentage +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command retrieves a summary of all the prints by percentage of MarketCap over the last x days, sorted by MarketCap. The summary includes the total number of prints and their total percentage of MarketCap, as well as the float and short percentage. + +### Usage + +```python wordwrap +/summary days sort +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| days | Number of days to look back | False | None | +| sort | Sort by `mc` (MarketCap), `float`, `sum`, or `short` (Short Percentage) | False | None | + + +--- + +## Examples + +``` +/summary 10 mc +``` + +--- diff --git a/website/content/bot/reference/telegram/darkpool/topsum.md b/website/content/bot/reference/telegram/darkpool/topsum.md new file mode 100644 index 000000000000..44f6759bb540 --- /dev/null +++ b/website/content/bot/reference/telegram/darkpool/topsum.md @@ -0,0 +1,43 @@ +--- +title: topsum +description: The Topsum page provides comprehensive information on the topsum command, + which retrieves a summary of total block and dark pool data. The command sums all + darkpool prints and displays a table of the largest by symbol, together with a comparative + graph, without requiring any parameters. +keywords: +- topsum command +- retrieve total block +- dark pool data summary +- sums darkpool prints +- graph for comparison +- no parameters +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command allows the user to retrieve total block and dark pool data summary. It sums all darkpool prints and gives a table of the largest by symbol as well as a graph for comparison. + +### Usage + +```python wordwrap +/topsum +``` + +--- + +## Parameters + +This command has no parameters + + +--- + +## Examples + +``` +/topsum +``` + +--- diff --git a/website/content/bot/reference/telegram/discovery/arktrades.md b/website/content/bot/reference/telegram/discovery/arktrades.md new file mode 100644 index 000000000000..d7dfcc6038a9 --- /dev/null +++ b/website/content/bot/reference/telegram/discovery/arktrades.md @@ -0,0 +1,41 @@ +--- +title: arktrades +description: The page contains instructions on how to use the 'arktrades' command + to retrieve and analyze a comprehensive list of trades made by ARK. The trade data + is presented in a user-friendly table format. +keywords: +- arktrades command +- trade data +- ARK trades analysis +- retrieve ARK trades +- analyze trades +- Easy-to-read trade data +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command allows the user to retrieve a list of all trades made by ARK, including the time and amount of each trade. The data is presented in an easy-to-read table format so that the user can quickly analyze the trades made by ARK. + +### Usage + +```python wordwrap +/arktrades +``` + +--- + +## Parameters + +This command has no parameters + +--- + +## Examples + +```python +/arktrades +``` + +--- diff --git a/website/content/bot/reference/telegram/discovery/fgindex.md b/website/content/bot/reference/telegram/discovery/fgindex.md new file mode 100644 index 000000000000..13efb33c6cee --- /dev/null +++ b/website/content/bot/reference/telegram/discovery/fgindex.md @@ -0,0 +1,44 @@ +--- +title: fgindex +description: This page provides information about the fgindex command which enables + the user to retrieve the Fear & Greed Index. This investor sentiment indicator measures + the levels of fear and greed in the stock market by observing the momentum, sentiment + and volume of stock trading. +keywords: +- fgindex command +- Fear & Greed Index +- investor sentiment indicator +- CNNMoney +- stock market +- momentum +- sentiment +- volume of stock trading +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command allows the user to retrieve the Fear & Greed Index, which is an investor sentiment indicator published by CNNMoney. The index measures the levels of fear and greed of the investors in the stock market by observing the momentum, sentiment and volume of stock trading. The index ranges from 0 to 100, with 0 being the most fearful and 100 being the most greedy. + +### Usage + +```python wordwrap +/fgindex +``` + +--- + +## Parameters + +This command has no parameters + +--- + +## Examples + +``` +/fgindex +``` + +--- diff --git a/website/content/bot/reference/telegram/discovery/halts.md b/website/content/bot/reference/telegram/discovery/halts.md new file mode 100644 index 000000000000..a5ef89d0ef43 --- /dev/null +++ b/website/content/bot/reference/telegram/discovery/halts.md @@ -0,0 +1,40 @@ +--- +title: halts +description: The page provides information on the usage, parameters and examples of + the 'halts' command. This command helps users gather data on the time and halt code + of stocks in the exchange, excluding penny stocks. +keywords: +- Halts Command +- Stock Market +- Halt Code +- Python Command +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command allows the user to retrieve the time and halt code of stocks in the market, excluding penny stocks. The output of this command provides the user with the time and halt code of stock that is currently halted or in the process of being halted by the exchange. + +### Usage + +```python wordwrap +/halts +``` + +--- + +## Parameters + +This command has no parameters + + + +--- + +## Examples + +``` +/halts +``` +--- diff --git a/website/content/bot/reference/telegram/discovery/holidays.md b/website/content/bot/reference/telegram/discovery/holidays.md new file mode 100644 index 000000000000..6e732c49b444 --- /dev/null +++ b/website/content/bot/reference/telegram/discovery/holidays.md @@ -0,0 +1,39 @@ +--- +title: holidays +description: Know the upcoming holidays with the /holidays command. Retrieve a list + of market holidays with respective dates and details like their national status. + Stay informed with the /holidays command. +keywords: +- holidays +- market holidays +- upcoming holidays +- national holidays +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command allows the user to retrieve a list of upcoming market holidays. The command will return a list of holidays, including their respective dates, along with any other pertinent details, such as whether they are national holidays or not. This command is suitable for any user who needs to stay up to date with upcoming holidays. + +### Usage + +```python wordwrap +/holidays +``` + +--- + +## Parameters + +This command has no parameters + +--- + +## Examples + +``` +/holidays +``` + +--- diff --git a/website/content/bot/reference/telegram/discovery/ipolist.md b/website/content/bot/reference/telegram/discovery/ipolist.md new file mode 100644 index 000000000000..92b8dd52eec7 --- /dev/null +++ b/website/content/bot/reference/telegram/discovery/ipolist.md @@ -0,0 +1,44 @@ +--- +title: ipolist +description: The ipolist page provides information on viewing the 10 most recent and + upcoming IPOs, including the company name, the IPO date, and the stock exchange. + It serves as a tool for users to stay informed about new investment opportunities. +keywords: +- ipolist +- IPOs +- Initial Public Offerings +- stock exchange +- investment opportunities +- new companies +- upcoming IPOs +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command allows the user to view 10 of the most recent and upcoming Initial Public Offerings (IPOs) including the company name, the IPO date, and the stock exchange. This information can help users stay up-to-date with the latest IPOs, and provide them with opportunities to invest in new companies. + +### Usage + +```python wordwrap +/ipolist +``` + +--- + +## Parameters + +This command has no parameters + + + +--- + +## Examples + +``` +/ipolist +``` + +--- diff --git a/website/content/bot/reference/telegram/discovery/pop.md b/website/content/bot/reference/telegram/discovery/pop.md new file mode 100644 index 000000000000..8c403a87d21d --- /dev/null +++ b/website/content/bot/reference/telegram/discovery/pop.md @@ -0,0 +1,45 @@ +--- +title: pop +description: The 'pop' command on OpenBB Bot allows users to retrieve the top 15 most + popular stock tickers for the day or hour, providing an overview of current market + trends. +keywords: +- pop command +- OpenBB Bot +- popular stocks +- 1 Hour stocks +- 1 Day stocks +- top 15 tickers +- stock market +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command retrieves the top 15 tickers for the day or hour based on popularity on the OpenBB Bot across all our platforms. It allows users to get an overview of the most popular stocks in the market within the last 24 hours (1d) or 1 Hour (1hr). + +### Usage + +```python wordwrap +/pop interval +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| interval | Interval to filter by. `1hr`: "1 Hour", `1d`: "1 Day", | False | 1hr, 1d | + + +--- + +## Examples + +``` +/pop 1hr +``` + +--- diff --git a/website/content/bot/reference/telegram/discovery/trendingst.md b/website/content/bot/reference/telegram/discovery/trendingst.md new file mode 100644 index 000000000000..5f814763323b --- /dev/null +++ b/website/content/bot/reference/telegram/discovery/trendingst.md @@ -0,0 +1,43 @@ +--- +title: trendingst +description: The documentation page elaborates on /trendingst command usage for tracking + top 15 trending stocks in real-time based on discussions on StockTwits platform. +keywords: +- trending stocks +- stocktwits +- /trendingst command +- real-time tracking +- most discussed stocks +- stock market +- most popular stocks +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command allows the user to retrieve the top 15 trending stocks from StockTwits according to the most recent discussions. The stocks are displayed in order of most trending, as determined by the most discussed stocks in the StockTwits community. This command is an efficient way to stay up to date on the most popular stocks in the market. + +### Usage + +```python wordwrap +/trendingst +``` + +--- + +## Parameters + +This command has no parameters + + + +--- + +## Examples + +``` +/trendingst +``` + +--- diff --git a/website/content/bot/reference/telegram/discovery/wsb.md b/website/content/bot/reference/telegram/discovery/wsb.md new file mode 100644 index 000000000000..602089ab73d7 --- /dev/null +++ b/website/content/bot/reference/telegram/discovery/wsb.md @@ -0,0 +1,42 @@ +--- +title: wsb +description: The /wsb command allows users to view the top 15 trending stocks on r/WallStreetBets, + including the mentions count for popular stocks. +keywords: +- WSB +- /wsb command +- trending stocks +- WallStreetBets +- mentions count +- popular stocks +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command allows the user to view the top 15 trending stocks on r/WallStreetBets (WSB) using the /disc wsb command. It displays the mentions count for popular stocks on the platform. + +### Usage + +```python wordwrap +/wsb +``` + +--- + +## Parameters + +This command has no parameters + + + +--- + +## Examples + +``` +/wsb +``` + +--- diff --git a/website/content/bot/reference/telegram/duediligence/ah.md b/website/content/bot/reference/telegram/duediligence/ah.md new file mode 100644 index 000000000000..533807c177d1 --- /dev/null +++ b/website/content/bot/reference/telegram/duediligence/ah.md @@ -0,0 +1,44 @@ +--- +title: ah +description: This page provides information on how to use the command '/ah' for retrieving + afterhours data for a specified stock ticker. The presentation includes usage, parameters, + and examples. +keywords: +- stock ticker +- afterhours data +- lowest prices +- highest prices +- volume traded +- market change +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command allows the user to retrieve afterhours data for a given stock ticker. The data retrieved will include the stock's current price, the highest and lowest prices of the ah session, the volume traded, and the change in the afterhours market. + +### Usage + +```python wordwrap +/ah ticker +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| ticker | Stock Ticker | False | None | + + +--- + +## Examples + +``` +/ah AMD +``` + +--- diff --git a/website/content/bot/reference/telegram/duediligence/analyst.md b/website/content/bot/reference/telegram/duediligence/analyst.md new file mode 100644 index 000000000000..4826d7d17502 --- /dev/null +++ b/website/content/bot/reference/telegram/duediligence/analyst.md @@ -0,0 +1,40 @@ +--- +title: analyst +description: Analyze and retrieve analyst recommendations for any given stock ticker + using our user-friendly commands. +keywords: +- analyst recommendations +- stock ticker +- usage +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command allows the user to retrieve analyst recommendations for a given stock ticker. + +### Usage + +```python wordwrap +/analyst ticker +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| ticker | Stock Ticker | False | None | + + +--- + +## Examples + +``` +/analyst AMD +``` + +--- diff --git a/website/content/bot/reference/telegram/duediligence/bio_stocks.md b/website/content/bot/reference/telegram/duediligence/bio_stocks.md new file mode 100644 index 000000000000..f15dc4e95185 --- /dev/null +++ b/website/content/bot/reference/telegram/duediligence/bio_stocks.md @@ -0,0 +1,45 @@ +--- +title: bio_stocks +description: The bio_stocks command retrieves and displays a stock's key company information + by taking a ticker as an argument. Information such as the company's name, description, + sector, industry, CEO, and more can be returned. +keywords: +- bio_stocks +- stock ticker +- company information +- stock's company information +- stock command +- stock's CEO +- stock industry +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command retrieves a stock's company information and displays it to the user. It takes a stock ticker as an argument and returns information such as the company's name, description, sector, industry, CEO, and more. + +### Usage + +```python wordwrap +/bio_stocks ticker +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| ticker | Stock Ticker | False | None | + + +--- + +## Examples + +``` +/bio_stocks AMD +``` + +--- diff --git a/website/content/bot/reference/telegram/duediligence/customer.md b/website/content/bot/reference/telegram/duediligence/customer.md new file mode 100644 index 000000000000..3d83f352a4e8 --- /dev/null +++ b/website/content/bot/reference/telegram/duediligence/customer.md @@ -0,0 +1,42 @@ +--- +title: customer +description: Learn how to use the 'customer' command to display the customers of a + given company using a stock ticker symbol. Detailed usages and examples provided. +keywords: +- customer +- display customers +- stock ticker +- AMD +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command allows the user to display customers of the company using the given symbol. + +### Usage + +```python wordwrap +/customer ticker +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| ticker | Stock Ticker | False | None | + + +--- + +## Examples + + +``` +/customer AMD +``` + +--- diff --git a/website/content/bot/reference/telegram/duediligence/divinfo.md b/website/content/bot/reference/telegram/duediligence/divinfo.md new file mode 100644 index 000000000000..32359d447b46 --- /dev/null +++ b/website/content/bot/reference/telegram/duediligence/divinfo.md @@ -0,0 +1,45 @@ +--- +title: divinfo +description: This page provides instructions on how to use the divinfo command for + retrieving dividend information for any given stock, including dividend rate, yield, + and ex-div date. +keywords: +- divinfo command +- dividend information +- stock dividend rate +- stock dividend yield +- stock ex-div date +- stock ticker +- AAPL +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command retrieves dividend information for a given stock. The data includes dividend rate, yield, and ex-div date. + +### Usage + +```python wordwrap +/divinfo ticker +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| ticker | Stock Ticker | False | None | + + +--- + +## Examples + +``` +/divinfo AAPL +``` + +--- diff --git a/website/content/bot/reference/telegram/duediligence/earnings.md b/website/content/bot/reference/telegram/duediligence/earnings.md new file mode 100644 index 000000000000..be9831bbe8fe --- /dev/null +++ b/website/content/bot/reference/telegram/duediligence/earnings.md @@ -0,0 +1,44 @@ +--- +title: earnings +description: This command allows the user to retrieve the expected earnings for a + given business day including company ticker, and other details. This information + aids in making informed decisions about their investments. +keywords: +- expected earnings +- business day +- company ticker +- investment decisions +- parameters +- investment examples +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command allows the user to retrieve the expected earnings for the given business day. The displayed earnings will include company ticker, expected time, sector, and float of the company. This information can be used to help the user make informed decisions about their investments. + +### Usage + +```python wordwrap +/earnings day +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| day | Date to get earnings for (YYYY-MM-DD) | False | None | + + +--- + +## Examples + +``` +/earnings 2022-07-29 +``` + +--- diff --git a/website/content/bot/reference/telegram/duediligence/ermove.md b/website/content/bot/reference/telegram/duediligence/ermove.md new file mode 100644 index 000000000000..b983558c68bd --- /dev/null +++ b/website/content/bot/reference/telegram/duediligence/ermove.md @@ -0,0 +1,43 @@ +--- +title: ermove +description: The ermove command allows users to retrieve the implied move for any + given stock, based on current option prices. Learn more about its usage, parameters, + and examples. +keywords: +- ermove +- implied move +- option prices +- stock +- expiration +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command allows the user to retrieve the implied move for a stock based on the current option prices. The implied move is a measure of how far the stock is expected to move during the option's expiration. + +### Usage + +```python wordwrap +/ermove ticker +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| ticker | Stock Ticker | False | None | + + +--- + +## Examples + +``` +/ermove AMD +``` + +--- diff --git a/website/content/bot/reference/telegram/duediligence/financials.md b/website/content/bot/reference/telegram/duediligence/financials.md new file mode 100644 index 000000000000..b89eb6e05862 --- /dev/null +++ b/website/content/bot/reference/telegram/duediligence/financials.md @@ -0,0 +1,46 @@ +--- +title: financials +description: This page provides detailed information on how to retrieve the financials + of a company using a specified stock ticker. It includes insights on total assets, + cash, debt, liabilities, and revenue for a comprehensive analysis of a company's + financial health. +keywords: +- financials command +- stock ticker +- company assets +- company liabilities +- company revenue +- debt analysis +- financial health +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command will retrieve the financials of the company with the given ticker which includes total assets, cash, debt, liabilities, and revenue. This information can be used to analyze the financial health of the company. + +### Usage + +```python wordwrap +/financials ticker +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| ticker | Stock Ticker | False | None | + + +--- + +## Examples + +``` +/financials AMD +``` + +--- diff --git a/website/content/bot/reference/telegram/duediligence/insiders.md b/website/content/bot/reference/telegram/duediligence/insiders.md new file mode 100644 index 000000000000..7b3f91165438 --- /dev/null +++ b/website/content/bot/reference/telegram/duediligence/insiders.md @@ -0,0 +1,45 @@ +--- +title: insiders +description: This page provides information about retrieving insider transactions + for a given stock. It explains the /insiders command usage, parameters and provides + examples +keywords: +- insider transactions +- stock data +- stock ticker +- buy/sell transactions +- average price +- /insiders command +- command usage +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command allows the user to retrieve the 15 most recent insider transactions for a given stock. It will provide information such as the date of the transaction, the company insider involved, the number of shares traded, the type of transaction (buy/sell), and the average price of the transaction. + +### Usage + +```python wordwrap +/insiders ticker +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| ticker | Stock Ticker | False | None | + + +--- + +## Examples + +``` +/insiders AMD +``` + +--- diff --git a/website/content/bot/reference/telegram/duediligence/instholdings.md b/website/content/bot/reference/telegram/duediligence/instholdings.md new file mode 100644 index 000000000000..77633fbaf314 --- /dev/null +++ b/website/content/bot/reference/telegram/duediligence/instholdings.md @@ -0,0 +1,45 @@ +--- +title: instholdings +description: This page provides comprehensive details on the 'instholdings' command + used to access the top 15 institutional holdings for any given stock. It includes + usage instructions and examples. +keywords: +- instholdings command +- institutional holdings +- stock ticker +- Securities and Exchange Commission +- stock market data +- financial data retrieval +- docusaurus documentation +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command allows the user to retrieve the top 15 institutional holdings for a given stock. This list is retrieved from the most recent available institutional holdings reported to the United States Securities and Exchange Commission. + +### Usage + +```python wordwrap +/instholdings ticker +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| ticker | Stock Ticker | False | None | + + +--- + +## Examples + +``` +/instholdings AMD +``` + +--- diff --git a/website/content/bot/reference/telegram/duediligence/nexter.md b/website/content/bot/reference/telegram/duediligence/nexter.md new file mode 100644 index 000000000000..71eed3fafd70 --- /dev/null +++ b/website/content/bot/reference/telegram/duediligence/nexter.md @@ -0,0 +1,42 @@ +--- +title: nexter +description: Learn how to use the nexter command to retrieve the next earnings date + for given stock ticker symbols like 'AMD'. This page includes usage examples and + a list of parameters. +keywords: +- nexter +- stock ticker +- earnings date +- AMD +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command will retrieve the next earnings date for the given stock ticker symbol. + +### Usage + +```python wordwrap +/nexter ticker +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| ticker | Stock Ticker | False | None | + + +--- + +## Examples + +``` +/nexter AMD +``` + +--- diff --git a/website/content/bot/reference/telegram/duediligence/pm.md b/website/content/bot/reference/telegram/duediligence/pm.md new file mode 100644 index 000000000000..fead557bb46d --- /dev/null +++ b/website/content/bot/reference/telegram/duediligence/pm.md @@ -0,0 +1,44 @@ +--- +title: pm +description: The 'pm' command is a tool that retrieves premarket data about a certain + stock ticker. It gives information about the stock's latest price, the premarket + change and the premarket percentage change. +keywords: +- pm command +- premarket data +- stock ticker +- stock price +- premarket change +- market opens +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command allows the user to retrieve premarket data for a given stock ticker. It will fetch the latest price, the premarket change, and the premarket percentage change of the selected stock. This is useful for those who want to get an idea of the stock's performance before the regular market opens. + +### Usage + +```python wordwrap +/pm ticker +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| ticker | Stock Ticker | False | None | + + +--- + +## Examples + +``` +/pm AMD +``` + +--- diff --git a/website/content/bot/reference/telegram/duediligence/pt.md b/website/content/bot/reference/telegram/duediligence/pt.md new file mode 100644 index 000000000000..47237af9bc56 --- /dev/null +++ b/website/content/bot/reference/telegram/duediligence/pt.md @@ -0,0 +1,42 @@ +--- +title: pt +description: The /pt command allows users to retrieve charts showing price targets, + current prices, and analyst ratings. Perfect for making informed decisions on stock + trading. +keywords: +- pt command +- price targets +- stock information +- analyst ratings +- informed decisions +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command allows the user to retrieve a chart with price targets for the specified ticker. The chart will provide information on the current price, target prices and analyst ratings, allowing the user to make more informed decisions. + +### Usage + +```python wordwrap +/pt ticker +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| ticker | Stock Ticker | False | None | + + +--- + +## Examples + +``` +/pt AMD +``` +--- diff --git a/website/content/bot/reference/telegram/duediligence/sec.md b/website/content/bot/reference/telegram/duediligence/sec.md new file mode 100644 index 000000000000..52c49767e750 --- /dev/null +++ b/website/content/bot/reference/telegram/duediligence/sec.md @@ -0,0 +1,48 @@ +--- +title: sec +description: The documentation explains the 'sec' command for retrieving the latest + SEC filings related to a specified ticker symbol, which can include various types + of company financials. A valuable tool for investors and analysts requiring the + latest financial information or corporate documents +keywords: +- SEC filings +- ticker symbol +- stock ticker +- financial performance +- corporate documents +- 10-Ks +- 8-Ks +- 10-Qs +- analysts +- investors +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command allows the user to retrieve the most recent SEC filings related to the specified ticker symbol. The filings can include company financials, registration statements, and periodic reports such as 10-Ks, 8-Ks, and 10-Qs. This command is especially useful for investors and analysts who need up-to-date information on a company's financial performance or other corporate documents. + +### Usage + +```python wordwrap +/sec ticker +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| ticker | Stock Ticker | False | None | + + +--- + +## Examples + +``` +/sec AMD +``` +--- diff --git a/website/content/bot/reference/telegram/duediligence/splits.md b/website/content/bot/reference/telegram/duediligence/splits.md new file mode 100644 index 000000000000..e624a1c6ec58 --- /dev/null +++ b/website/content/bot/reference/telegram/duediligence/splits.md @@ -0,0 +1,45 @@ +--- +title: splits +description: Learn how to use the '/splits' command to retrieve a list of recent stock + splits for a given ticker. This helps in efficient tracking of stock splits over + time. +keywords: +- stock splits +- stock ticker +- market tracking +- stock tracking +- AAPL stock +- stock command +- market commands +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command retrieves a list of recent stock splits for a given ticker. This command is useful for tracking the splits of a particular stock over time. + +### Usage + +```python wordwrap +/splits [ticker] +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| ticker | Stock Ticker | True | None | + + +--- + +## Examples + +``` +/splits AAPL +``` + +--- diff --git a/website/content/bot/reference/telegram/duediligence/supplier.md b/website/content/bot/reference/telegram/duediligence/supplier.md new file mode 100644 index 000000000000..e9598985242a --- /dev/null +++ b/website/content/bot/reference/telegram/duediligence/supplier.md @@ -0,0 +1,41 @@ +--- +title: supplier +description: This page offers information about the 'supplier' command, which retrieves + a list of suppliers for a specified company using its stock ticker. +keywords: +- supplier command +- stock ticker +- company suppliers +- retrieve suppliers +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command allows users to retrieve the list of suppliers associated with the company with the given ticker. + +### Usage + +```python wordwrap +/supplier ticker +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| ticker | Stock Ticker | False | None | + + +--- + +## Examples + +``` +/supplier AMD +``` + +--- diff --git a/website/content/bot/reference/telegram/duediligence/ytd.md b/website/content/bot/reference/telegram/duediligence/ytd.md new file mode 100644 index 000000000000..93c479562449 --- /dev/null +++ b/website/content/bot/reference/telegram/duediligence/ytd.md @@ -0,0 +1,47 @@ +--- +title: ytd +description: This page discusses the usage of the /ytd command to retrieve year-to-date + performance of a particular stock using its ticker symbol. Examples and parameters + are also provided. +keywords: +- year-to-date performance +- stock +- ticker symbol +- stock's performance +- ytd +- parameters +- /ytd ticker +- examples +- AMD +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command allows the user to retrieve the stock's year-to-date performance for a particular ticker symbol. It displays the stock's performance over various periods of time, from 5 days to 5 years. + +### Usage + +```python wordwrap +/ytd ticker +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| ticker | Stock Ticker | False | None | + + +--- + +## Examples + +``` +/ytd AMD +``` + +--- diff --git a/website/content/bot/reference/telegram/economy/bonds.md b/website/content/bot/reference/telegram/economy/bonds.md new file mode 100644 index 000000000000..80f393857ec5 --- /dev/null +++ b/website/content/bot/reference/telegram/economy/bonds.md @@ -0,0 +1,46 @@ +--- +title: bonds +description: Learn to use the /bonds command to retrieve the overview of Global or + US bonds. The page includes details about the type of bond, the rate of return, + yield and yield change, which can aid in making informed decisions about investing + in bonds. +keywords: +- Bonds +- Global Bonds +- US Bonds +- Investing +- Rate of Return +- Yield +- Yield Change +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command allows the user to retrieve an overview of Global or US bonds. It includes information about the type of bond, the rate of return, yield, and yield change. The data is presented in an easy to read format and can be used to inform decisions about investing in Global or US bonds. + +### Usage + +```python wordwrap +/bonds market +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| market | Market to display: `gl` for global `us` for US | False | us, gl | + + +--- + +## Examples + +``` +/bonds +``` + +--- diff --git a/website/content/bot/reference/telegram/economy/calendar.md b/website/content/bot/reference/telegram/economy/calendar.md new file mode 100644 index 000000000000..32e1ef701416 --- /dev/null +++ b/website/content/bot/reference/telegram/economy/calendar.md @@ -0,0 +1,43 @@ +--- +title: calendar +description: The documentation page for the /calendar command which retrieves an Economic + Calendar for the day, providing insightful details about upcoming economic events + and key indicators like GDP, inflation, employment, etc. +keywords: +- economic calendar +- economic events +- GDP +- inflation +- employment +- economy trajectory +- calendar command +- economic indicators +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command allows the user to retrieve an Economic Calendar for the day, which displays the upcoming economic events along with their expected impact. The Economic Calendar includes a list of key economic indicators such as GDP, inflation, employment, and more, which can provide insight into the future trajectory of the economy. + +### Usage + +```python wordwrap +/calendar +``` + +--- + +## Parameters + +This command has no parameters + +--- + +## Examples + +``` +/calendar +``` + +--- diff --git a/website/content/bot/reference/telegram/economy/commodities.md b/website/content/bot/reference/telegram/economy/commodities.md new file mode 100644 index 000000000000..462673f8fd2e --- /dev/null +++ b/website/content/bot/reference/telegram/economy/commodities.md @@ -0,0 +1,42 @@ +--- +title: commodities +description: The page elaborates on the /commodities command, a tool for users to + access an overview of Futures and commodities along with the latest prices and day + changes. The command does not require any parameters. +keywords: +- commodities +- Futures +- price change +- day overview +- no parameters command +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command allows users to quickly and easily retrieve an overview of Futures and commodities. It provides the last price and change for the day. + +### Usage + +```python wordwrap +/commodities +``` + +--- + +## Parameters + +This command has no parameters + + + +--- + +## Examples + +``` +/commodities +``` + +--- diff --git a/website/content/bot/reference/telegram/economy/currencies.md b/website/content/bot/reference/telegram/economy/currencies.md new file mode 100644 index 000000000000..71c9dd6c8b0b --- /dev/null +++ b/website/content/bot/reference/telegram/economy/currencies.md @@ -0,0 +1,41 @@ +--- +title: currencies +description: This page gives a guide on the usage of the currencies command, providing + an overview of all available currencies including the currency name, price, and + changes. +keywords: +- currencies command usage +- currency overview +- currency information retrieval +- detailed guide on currency command +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command allows the user to retrieve an overview of all available currencies. It will provide the user with information such as the currency name, price, and change. + +### Usage + +```python wordwrap +/currencies +``` + +--- + +## Parameters + +This command has no parameters + + + +--- + +## Examples + +``` +/currencies +``` + +--- diff --git a/website/content/bot/reference/telegram/economy/fedrates.md b/website/content/bot/reference/telegram/economy/fedrates.md new file mode 100644 index 000000000000..63f34f974682 --- /dev/null +++ b/website/content/bot/reference/telegram/economy/fedrates.md @@ -0,0 +1,44 @@ +--- +title: fedrates +description: The 'fedrates' command provides easy and quick access to upcoming Federal + Rate decision dates. A tool with no parameters required, making it convenient for + users to stay informed. +keywords: +- fedrates +- Federal Rate decisions +- retrieve Federal Rate +- upcoming Federal Rate decisions +- rate decision dates +- easy retrieval +- No parameters command +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command allows users to quickly and easily retrieve upcoming Federal Rate decision dates and chances. It is a convenient way to stay up to date with Federal Rate decisions. + +### Usage + +```python wordwrap +/fedrates +``` + +--- + +## Parameters + +This command has no parameters + + + +--- + +## Examples + +``` +/fedrates +``` + +--- diff --git a/website/content/bot/reference/telegram/economy/indices.md b/website/content/bot/reference/telegram/economy/indices.md new file mode 100644 index 000000000000..0f8dab276e10 --- /dev/null +++ b/website/content/bot/reference/telegram/economy/indices.md @@ -0,0 +1,43 @@ +--- +title: indices +description: Get real-time information about major US stock indices like Dow Jones, + S&P 500, and NASDAQ Composite. The command provides the most current index values + and the percentage change from the previous day. +keywords: +- US stock indices +- Dow Jones +- S&P 500 +- NASDAQ Composite +- index values +- percentage change +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command provides a real-time overview of the major US stock indices, such as the Dow Jones Industrial Average, the S&P 500, and the NASDAQ Composite. It displays the most current index values, as well as the percentage change from the previous day. + +### Usage + +```python wordwrap +/indices +``` + +--- + +## Parameters + +This command has no parameters + + + +--- + +## Examples + +``` +/indices +``` + +--- diff --git a/website/content/bot/reference/telegram/economy/revrepo.md b/website/content/bot/reference/telegram/economy/revrepo.md new file mode 100644 index 000000000000..6f77e9a83dcc --- /dev/null +++ b/website/content/bot/reference/telegram/economy/revrepo.md @@ -0,0 +1,48 @@ +--- +title: revrepo +description: Revrepo is a command allowing the user to retrieve Reverse Repo data + statistics over specified days. It gives details such as Reverse Repo total, number + of parties, average and variations. +keywords: +- revrepo command +- Reverse Repo data +- data retrieval +- data statistics +- data averaging +- data difference +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command allows the user to retrieve Reverse Repo data for a default period of 35 days. This data includes information such as the total amount of Reverse Repo, the number of parties, the average, and difference. + +### Usage + +```python wordwrap +/revrepo [days] +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| days | Number of days to display. Default: 50 | True | None | + + +--- + +## Examples + +``` +/revrepo days:35 +``` + +``` +/revrepo +``` + +--- diff --git a/website/content/bot/reference/telegram/economy/yieldcurve.md b/website/content/bot/reference/telegram/economy/yieldcurve.md new file mode 100644 index 000000000000..fa4115ef447c --- /dev/null +++ b/website/content/bot/reference/telegram/economy/yieldcurve.md @@ -0,0 +1,39 @@ +--- +title: yieldcurve +description: The page provides instructions on how to use the /yieldcurve command + to retrieve the US Bonds yield curve, a financial graph plotting the bonds' yields + with different maturities, which gives an indication of interest rates direction. +keywords: +- yield curve +- US Bonds +- interest rates +- financial graph +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command allows the user to retrieve the US Bonds yield curve. The yield curve is a graph that plots the yields of different bonds with different maturities, providing an indication of the direction of interest rates. + +### Usage + +```python wordwrap +/yieldcurve +``` + +--- + +## Parameters + +This command has no parameters + +--- + +## Examples + +``` +/yieldcurve +``` + +--- diff --git a/website/content/bot/reference/telegram/etf/holdings.md b/website/content/bot/reference/telegram/etf/holdings.md new file mode 100644 index 000000000000..527852864848 --- /dev/null +++ b/website/content/bot/reference/telegram/etf/holdings.md @@ -0,0 +1,43 @@ +--- +title: holdings +description: This page provides information about the command that returns the holdings + for an ETF sorted by percent of ETF. This command can be particularly useful for + anyone interested in ETF and programming with Python. +keywords: +- ETF +- ETF Holdings +- ETF Ticker +- Holdings +- Programming +- Command +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command returns the holdings for an ETF sorted by percent of ETF. + +### Usage + +```python wordwrap +/etf holdings [etf] +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| etf | ETF ticker (only for `holdings`) | True | None | + + +--- + +## Examples + +``` +/etf holdings SPY +``` +--- diff --git a/website/content/bot/reference/telegram/etf/tops.md b/website/content/bot/reference/telegram/etf/tops.md new file mode 100644 index 000000000000..af6d1657b301 --- /dev/null +++ b/website/content/bot/reference/telegram/etf/tops.md @@ -0,0 +1,42 @@ +--- +title: tops +description: The page offers comprehensive details about the command 'ETF tops' which + enables users to fetch the top ETFs for the day, sorted by gainers, losers, or active. + The sort option is optional with default sort set to gainers. +keywords: +- ETF tops +- ETF gainers +- ETF losers +- active ETFs +- ETF sorting +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command returns the top ETFs for the day - sorted by gainers, losers, or active. + +### Usage + +```python wordwrap +/etf tops [sort] +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| sort | Possible sort options to run. If not provided, defaults to gainers | True | gainers, losers, active | + + +--- + +## Examples + +``` +/etf tops +``` +--- diff --git a/website/content/bot/reference/telegram/flow/bigflow.md b/website/content/bot/reference/telegram/flow/bigflow.md new file mode 100644 index 000000000000..1fc5deb6a596 --- /dev/null +++ b/website/content/bot/reference/telegram/flow/bigflow.md @@ -0,0 +1,42 @@ +--- +title: bigflow +description: The page illustrates the 'bigflow' command for retrieving the top 20 + largest flows by premium for a stock, considering the price of the option at the + time of the trade and the trade volume. +keywords: +- bigflow +- stock analysis +- option trading +- stock ticker +- trade volume +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command retrieves the top 20 largest flow by premium for a stock. We calculate the largest flow by multiplying the price of the option at the time of the trade by the volume of that trade. + +### Usage + +```python wordwrap +/bigflow ticker +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| ticker | Stock Ticker | False | None | + + +--- + +## Examples + +``` +/bigflow AMD +``` +--- diff --git a/website/content/bot/reference/telegram/flow/flow/day.md b/website/content/bot/reference/telegram/flow/flow/day.md new file mode 100644 index 000000000000..986303d36886 --- /dev/null +++ b/website/content/bot/reference/telegram/flow/flow/day.md @@ -0,0 +1,53 @@ +--- +title: day +description: Information on how to use the 'flow' command to retrieve the most recent + flow data for a stock. Learn how to specify the stock ticker, expiry date, strike + price, and opt_type for more tailored results. +keywords: +- flow command +- stock flow data +- retrieve stock data +- stock ticker symbol +- expiration date +- strike price +- opt_type +- calls and puts +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command retrieves the most recent flow for a stock with the specified ticker symbol. The command will return the most up-to-date flow data for that stock over $25,000. + +### Usage + +```python wordwrap +/flow [ticker] [expiry] [strike] [opt_type] +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| ticker | Stock Ticker - Not required for subcmd: unu | True | None | +| expiry | Expiration date - Only available for subcmd: day (default: None) | True | None | +| strike | Strike price - Only available for subcmd: day (default: None) | True | None | +| opt_type | call/put/calls/puts/c/p - Only available for subcmd: day (default: None) | True | Calls, Puts, c, p, call, put | + + +--- + +## Examples + +``` +/flow AMD +``` + +``` +/flow AMD 2022-07-29 +``` + +--- diff --git a/website/content/bot/reference/telegram/flow/flow/open.md b/website/content/bot/reference/telegram/flow/flow/open.md new file mode 100644 index 000000000000..8d02942ec7ad --- /dev/null +++ b/website/content/bot/reference/telegram/flow/flow/open.md @@ -0,0 +1,43 @@ +--- +title: open +description: Learn how to retrieve the Top 20 flows by premium for a stock with the + Opening condition - Volume exceeding Open Interest on the trade using the 'flow + open' command. +keywords: +- flow open command +- Top 20 flows by premium +- stock flow +- open interest on trade +- stock ticker +- volume exceeding open interest +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command allows the user to retrieve the Top 20 flows by premium for a stock with the Opening condition - Volume exceeding Open Interest on the trade. + +### Usage + +```python wordwrap +/flow open [ticker] +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| ticker | Stock Ticker - Not required for subcmd: unu | True | None | + + +--- + +## Examples + +``` +/flow open AMD +``` +--- diff --git a/website/content/bot/reference/telegram/flow/flow/prem.md b/website/content/bot/reference/telegram/flow/flow/prem.md new file mode 100644 index 000000000000..641d73951ea3 --- /dev/null +++ b/website/content/bot/reference/telegram/flow/flow/prem.md @@ -0,0 +1,45 @@ +--- +title: prem +description: This page provides instructions on how to use the 'flow prem' command + to retrieve a daily chart which visually represents the sum of premiums for call/put + options for a given stock ticker. A clear graphic visualization will make it easier + for users to understand the dynamics of premium changes. +keywords: +- flow prem command +- call/put options +- options premium chart +- daily premium data +- premium visualization +- stock ticker +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command allows the user to retrieve a chart displaying the sum of premium for call/put options for a particular ticker on a daily basis. This chart will help users quickly and easily visualize the changing premium amounts over time. + +### Usage + +```python wordwrap +/flow prem [ticker] +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| ticker | Stock Ticker - Not required for subcmd: unu | True | None | + + +--- + +## Examples + +``` +/flow prem AMD +``` + +--- diff --git a/website/content/bot/reference/telegram/flow/flow/unu.md b/website/content/bot/reference/telegram/flow/flow/unu.md new file mode 100644 index 000000000000..ecd1e9616826 --- /dev/null +++ b/website/content/bot/reference/telegram/flow/flow/unu.md @@ -0,0 +1,43 @@ +--- +title: unu +description: Learn how to use the /flow unu command to identify unusual options trades + exceeding $100,000 in premium and total volume. Understand the potential opportunities + in the options market. +keywords: +- unusual options trading +- /flow unu command +- options market opportunities +- trading strategies +- premium options trades +- total volume exceeding open interest +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command allows users to retrieve Unusual Options Trades over $100,000 premium and Total Volume exceeding Open Interest. This data can be used to identify potential opportunities in the options market allowing users to quickly and easily identify potential unusual activity. + +### Usage + +```python wordwrap +/flow unu +``` + +--- + +## Parameters + +This command has no parameters + + + +--- + +## Examples + +``` +/flow unu +``` + +--- diff --git a/website/content/bot/reference/telegram/flow/flow/wk.md b/website/content/bot/reference/telegram/flow/flow/wk.md new file mode 100644 index 000000000000..ea80a6973d28 --- /dev/null +++ b/website/content/bot/reference/telegram/flow/flow/wk.md @@ -0,0 +1,46 @@ +--- +title: wk +description: Page dedicated to explaining the 'flow wk' command, which allows users + to retrieve Top 20 flow by Premium for a stock with an option contact expiring that + week. The page provides usage, parameters, and example for the command. +keywords: +- flow wk command +- stock +- premium flow +- option contact +- stock ticker +- usage +- parameters +- example +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command allows the user to retrieve the Top 20 flow by Premium for a stock with an option contact expiring that week. + +### Usage + +```python wordwrap +/flow wk [ticker] +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| ticker | Stock Ticker - Not required for subcmd: unu | True | None | + + +--- + +## Examples + +```python +/flow wk AMD +``` + +--- diff --git a/website/content/bot/reference/telegram/flow/flowsum/day.md b/website/content/bot/reference/telegram/flow/flowsum/day.md new file mode 100644 index 000000000000..11a0ebcc6745 --- /dev/null +++ b/website/content/bot/reference/telegram/flow/flowsum/day.md @@ -0,0 +1,46 @@ +--- +title: day +description: The documentation page is about the 'flowsum' command that allows users + to retrieve the total premium of a given stock ticker on the current trading day. + It provides examples and parameters of the command and explains the trade categorization + on the bid/ask. +keywords: +- flowsum +- stock Ticker +- trade +- premium +- Above Ask +- current trading day +- bid/ask +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command allows the user to retrieve the total premium of the given stock ticker for the current trading day. We categorize the calls and puts by where the trade occurred on the bid/ask. For example, Above Ask, means the trade happened over the current Ask price. + +### Usage + +```python wordwrap +/flowsum [ticker] +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| ticker | Stock Ticker - Not available for subcmd: top | True | None | + + +--- + +## Examples + +``` +/flowsum AMD +``` + +--- diff --git a/website/content/bot/reference/telegram/flow/flowsum/exp.md b/website/content/bot/reference/telegram/flow/flowsum/exp.md new file mode 100644 index 000000000000..bd9289ddb5b4 --- /dev/null +++ b/website/content/bot/reference/telegram/flow/flowsum/exp.md @@ -0,0 +1,48 @@ +--- +title: exp +description: Detailed guide on the 'flowsum exp' command used for retrieving the total + premium of a given stock ticker for the current trading day, including example usage + and parameters explanation. +keywords: +- flowsum exp command +- option premium +- stock ticker +- trading day +- above ask +- expiry +- expiration date +- 'subcmd: exp' +- example usage +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command allows the user to retrieve the total premium of the given stock ticker for the current trading day by expiration. We categorize the calls and puts by where the trade occurred on the bid/ask. For example, Above Ask, means the trade happened over the current Ask price. + +### Usage + +```python wordwrap +/flowsum exp [ticker] [expiry] +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| ticker | Stock Ticker - Not available for subcmd: top | True | None | +| expiry | Expiration date - Only available/required for subcmd: exp | True | None | + + +--- + +## Examples + +``` +/flowsum exp AMD 2022-07-29 +``` + +--- diff --git a/website/content/bot/reference/telegram/flow/flowsum/top.md b/website/content/bot/reference/telegram/flow/flowsum/top.md new file mode 100644 index 000000000000..c73d4d4f1069 --- /dev/null +++ b/website/content/bot/reference/telegram/flow/flowsum/top.md @@ -0,0 +1,42 @@ +--- +title: top +description: The page provides instructions on using the 'flowsum top' command to + retrieve the daily top flow for Calls and Puts by stock, offering a snapshot of + market sentiment towards a specific stock and the overall market. +keywords: +- flowsum top command +- retrieve daily top flow +- Calls and Puts by stock +- market sentiment +- stock market overview +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command allows the user to retrieve the top flow for the day for Calls and Puts by stock. This will provide the user with an overview of the market's current sentiment towards a particular stock as well as an overall view of the market's sentiment towards all stocks. + +### Usage + +```python wordwrap +/flowsum top +``` + +--- + +## Parameters + +This command has no parameters + + + +--- + +## Examples + +``` +/flowsum top +``` + +--- diff --git a/website/content/bot/reference/telegram/flow/flowsum/wk.md b/website/content/bot/reference/telegram/flow/flowsum/wk.md new file mode 100644 index 000000000000..5e64f9774270 --- /dev/null +++ b/website/content/bot/reference/telegram/flow/flowsum/wk.md @@ -0,0 +1,43 @@ +--- +title: wk +description: "This page provides the documentation of 'flowsum wk' command. It explains\ + \ how to retrieve the top flow per week for Calls and Puts by stock for understanding\ + \ the market\u2019s sentiment towards a certain stock. Parameters and usage are\ + \ clearly detailed." +keywords: +- flowsum wk +- stock market sentiment +- Put and Call analysis +- top flow retrieval +- stock ticker +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command allows the user to retrieve the top flow for the week for Calls and Puts by stock. This will provide the user with an overview of the market's current sentiment towards a particular stock as well as an overall view of the market's sentiment towards all stocks. + +### Usage + +```python wordwrap +/flowsum wk [ticker] +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| ticker | Stock Ticker - Not available for subcmd: top | True | None | + + +--- + +## Examples + +``` +/flowsum wk AMD +``` +--- diff --git a/website/content/bot/reference/telegram/flow/sectorsflow.md b/website/content/bot/reference/telegram/flow/sectorsflow.md new file mode 100644 index 000000000000..06f3d0fb4884 --- /dev/null +++ b/website/content/bot/reference/telegram/flow/sectorsflow.md @@ -0,0 +1,58 @@ +--- +title: sectorsflow +description: The sectorsflow command page details how to retrieve a summary of all + flows by MarketCap percentage per sector over past specified days. It includes nuances + on usage and different parameters like sector and number of days. +keywords: +- sectorsflow +- MarketCap percentage +- sector +- days +- flow summary +- Basic Materials +- Energy +- Communication Services +- Consumer Cyclical +- Consumer Defensive +- Financial +- Healthcare +- Industrials +- Real Estate +- Technology +- Utilities +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command retrieves a summary of all flows by MarketCap percentage per sector over the past x days. + +### Usage + +```python wordwrap +/sectorsflow days sector +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| days | Number of days to look back | False | None | +| sector | Sector to filter by: `bm` (Basic Materials), `e` (Energy), `cs` (Communication Services), `cc` (Consumer Cyclical), `cd` (Consumer Defensive), `f` (Financial), `h` (Healthcare), `i` (Industrials), `re` (Real Estate), `t` (Technology), `u` (Utilities) | False | None | + + +--- + +## Examples + +``` +/sectorsflow 5 cs +``` + +``` +/sectorsflow 5 bm +``` +--- diff --git a/website/content/bot/reference/telegram/flow/summaryflow.md b/website/content/bot/reference/telegram/flow/summaryflow.md new file mode 100644 index 000000000000..cd53f86bdf1a --- /dev/null +++ b/website/content/bot/reference/telegram/flow/summaryflow.md @@ -0,0 +1,50 @@ +--- +title: summaryflow +description: The SummaryFlow page provides instruction on using the summaryflow command, + which compiles detailed summaries of the flow per stock over selected periods, sorted + in various ways. +keywords: +- SummaryFlow +- stock flow summary +- stock analysis +- MarketCap sort +- short sort +- /summaryflow usage +- trading +- trades tracking +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command allows the user to retrieve a summary of all the flow per stock over the last x days, with the result sorted in various ways. This summary will include the ratio to total market capitalization, the number of trades, and other information. + +### Usage + +```python wordwrap +/summaryflow days sort +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| days | Number of days to look back | False | None | +| sort | Sort by `mc` (MarketCap), `float`, `sum`, or `short` (Short Percentage) | False | mc, float, sum, short | + + +--- + +## Examples + +``` +/summaryflow 1 float +``` + +``` +/summaryflow 1 sum +``` +--- diff --git a/website/content/bot/reference/telegram/fun/8ball.md b/website/content/bot/reference/telegram/fun/8ball.md new file mode 100644 index 000000000000..82cb4f0b1a6a --- /dev/null +++ b/website/content/bot/reference/telegram/fun/8ball.md @@ -0,0 +1,45 @@ +--- +title: 8ball +description: Guidance on how to use 8ball command in the system to get an answer to + a specific question from the 8-ball. +keywords: +- 8ball +- question +- answer +- user +- usage +- parameters +- examples +- choices +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command allows the user to ask the 8-ball a question and receive an answer. The question must end in a question mark. + +### Usage + +```python wordwrap +/8ball question +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| question | Question to ask the 8 ball (must end with a question mark) | False | None | + + +--- + +## Examples + +``` +/8ball Will I make money today? +``` + +--- diff --git a/website/content/bot/reference/telegram/fun/flip.md b/website/content/bot/reference/telegram/fun/flip.md new file mode 100644 index 000000000000..e6cacfa9d647 --- /dev/null +++ b/website/content/bot/reference/telegram/fun/flip.md @@ -0,0 +1,41 @@ +--- +title: flip +description: Learn how to use the flip command to simulate a coin flip. Know the exact + usage, parameters and examples associated with it. +keywords: +- flip command +- coin flip simulation +- Heads or Tails command +- No parameters command +- Usage of flip command +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command allows the user to simulate a coin flip displaying either a 'Heads' or 'Tails'. + +### Usage + +```python wordwrap +/flip +``` + +--- + +## Parameters + +This command has no parameters + + + +--- + +## Examples + +``` +/flip +``` + +--- diff --git a/website/content/bot/reference/telegram/fun/urban.md b/website/content/bot/reference/telegram/fun/urban.md new file mode 100644 index 000000000000..556b44b3c26d --- /dev/null +++ b/website/content/bot/reference/telegram/fun/urban.md @@ -0,0 +1,42 @@ +--- +title: urban +description: Page documenting the 'urban' command to search word definitions on Urban + Dictionary. Includes usage, parameters and examples. +keywords: +- Urban Dictionary +- Search word +- Definition +- Command +- Parameters +- Examples +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command allows the user to search for a definition of a word on Urban Dictionary. + +### Usage + +```python wordwrap +/urban word +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| word | The word or words to search for. | False | None | + + +--- + +## Examples + +``` +/urban Shill +``` +--- diff --git a/website/content/bot/reference/telegram/general/futures.md b/website/content/bot/reference/telegram/general/futures.md new file mode 100644 index 000000000000..fc03118c6be6 --- /dev/null +++ b/website/content/bot/reference/telegram/general/futures.md @@ -0,0 +1,39 @@ +--- +title: futures +description: Learn how to use the futures command to retrieve futures prices on the + stock market accurately and quickly. Understand the usage and parameters for this + helpful tool. +keywords: +- futures +- stock market +- futures prices +- stock market command +- retrieve futures prices +- quote ticker +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command allows the user to retrieve futures prices on the stock market. + +### Usage + +```python wordwrap +/quote ticker +``` + +--- + +## Parameters + +This command has no parameters + +--- + +## Examples + +``` +/futures +``` diff --git a/website/content/bot/reference/telegram/general/news.md b/website/content/bot/reference/telegram/general/news.md new file mode 100644 index 000000000000..29626e3638c8 --- /dev/null +++ b/website/content/bot/reference/telegram/general/news.md @@ -0,0 +1,42 @@ +--- +title: news +description: Learn how to use the command to retrieve the latest news for a given + stock ticker. The guide provides usage procedures with examples. +keywords: +- news +- stock ticker +- latest news +- market news +- stock market updates +- AMD +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command allows the user to retrieve the latest news for a given ticker. + +### Usage + +```python wordwrap +/news ticker +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| ticker | Stock Ticker | False | None | + + +--- + +## Examples + +``` +/news AMD +``` +--- diff --git a/website/content/bot/reference/telegram/general/quote.md b/website/content/bot/reference/telegram/general/quote.md new file mode 100644 index 000000000000..6f464488bf56 --- /dev/null +++ b/website/content/bot/reference/telegram/general/quote.md @@ -0,0 +1,43 @@ +--- +title: quote +description: The 'Quote' command documentation provides detailed information on how + to retrieve display quote stats for a stock including the 52 week high/low, market + cap/float, and 200/50 day moving averages using a given stock ticker. +keywords: +- quote command +- stock stats +- 52 week high/low +- market cap/float +- 200/50 day moving averages +- stock ticker +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command allows the user to retrieve display quote stats for a stock - including the 52 week high/low, market cap/float, and 200/50 day moving averages. The command allows you to quickly and easily access the requested quote stats for the given stock. + +### Usage + +```python wordwrap +/quote ticker +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| ticker | Stock Ticker | False | None | + + +--- + +## Examples + +``` +/quote AMD +``` +--- diff --git a/website/content/bot/reference/telegram/general/ta.md b/website/content/bot/reference/telegram/general/ta.md new file mode 100644 index 000000000000..fd94f6783cd0 --- /dev/null +++ b/website/content/bot/reference/telegram/general/ta.md @@ -0,0 +1,43 @@ +--- +title: ta +description: Documentation page on command '/ta' which retrieves technical analysis + summary including indicators such as moving averages, fibonacci levels, etc for + a given stock ticker. +keywords: +- technical analysis +- stock ticker +- moving averages +- fibonacci levels +- support and resistance levels +- technical metrics +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command allows the user to retrieve a technical analysis summary for a given stock ticker. The summary includes several indicators such as moving averages, fibonacci levels, support and resistance levels, and other technical metrics. + +### Usage + +```python wordwrap +/ta ticker +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| ticker | Stock Ticker | False | None | + + +--- + +## Examples + +``` +/ta AMD +``` +--- diff --git a/website/content/bot/reference/telegram/government/contracts.md b/website/content/bot/reference/telegram/government/contracts.md new file mode 100644 index 000000000000..9dc3c6963b04 --- /dev/null +++ b/website/content/bot/reference/telegram/government/contracts.md @@ -0,0 +1,42 @@ +--- +title: contracts +description: Learn how to retrieve the top 15 government contracts by amount for a + specific ticker. This page guides you through the usage of the /contracts command, + including examples with optional parameters. +keywords: +- contracts +- government contracts +- specific ticker +- stock ticker +- optional parameter +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command will allow the user to retrieve the top 15 government contracts by amount for a specific ticker. + +### Usage + +```python wordwrap +/contracts [ticker] +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| ticker | Stock Ticker (optional) | True | None | + + +--- + +## Examples + +``` +/contracts GE +``` +--- diff --git a/website/content/bot/reference/telegram/government/house.md b/website/content/bot/reference/telegram/government/house.md new file mode 100644 index 000000000000..cdd76a0dfa09 --- /dev/null +++ b/website/content/bot/reference/telegram/government/house.md @@ -0,0 +1,39 @@ +--- +title: house +description: The page provides instructions on how to use the 'house' command to retrieve + recent house trades for a specific stock ticker. +keywords: +- house command +- retrieve house trades +- stock ticker +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command allows the user to retrieve recent house trades for a specific ticker. + +### Usage + +```python wordwrap +/house [ticker] +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| ticker | Stock Ticker (optional) | True | None | + + +--- + +## Examples + +``` +/house GE +``` +--- diff --git a/website/content/bot/reference/telegram/government/senate.md b/website/content/bot/reference/telegram/government/senate.md new file mode 100644 index 000000000000..796e095a492a --- /dev/null +++ b/website/content/bot/reference/telegram/government/senate.md @@ -0,0 +1,41 @@ +--- +title: senate +description: Detailed instructions on how to use the 'senate' command to track the + trades of senate members for specific stock tickers. +keywords: +- senate command +- trades of senate members +- specific ticker +- stock ticker +- financial commands +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command allows a user to view the recent trades of senate members for a specific ticker. + +### Usage + +```python wordwrap +/senate [ticker] +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| ticker | Stock Ticker (optional) | True | None | + + +--- + +## Examples + +``` +/senate GE +``` +--- diff --git a/website/content/bot/reference/telegram/info/about.md b/website/content/bot/reference/telegram/info/about.md new file mode 100644 index 000000000000..15bedd2bafcf --- /dev/null +++ b/website/content/bot/reference/telegram/info/about.md @@ -0,0 +1,38 @@ +--- +title: about +description: This page provides detailed information about the /about command of OpenBB + Bot, including its usage and examples. No parameters required. +keywords: +- OpenBB Bot +- bot command +- social media links +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command will provide users with a comprehensive overview of OpenBB Bot and links to our social media pages. + +### Usage + +```python wordwrap +/about +``` + +--- + +## Parameters + +This command has no parameters + + + +--- + +## Examples + +``` +/about +``` +--- diff --git a/website/content/bot/reference/telegram/info/start.md b/website/content/bot/reference/telegram/info/start.md new file mode 100644 index 000000000000..d0fb6eaee36a --- /dev/null +++ b/website/content/bot/reference/telegram/info/start.md @@ -0,0 +1,38 @@ +--- +title: help +description: This is a help documentation page for OpenBB Bot. It provides users with + the list of commands for potential usage. +keywords: +- OpenBB Bot +- commands +- usage +- help documentation +- parameters +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +List of commands for OpenBB Bot. + +### Usage + +```python wordwrap +/help +``` + +--- + +## Parameters + +This command has no parameters + +--- + +## Examples + +``` +/help +``` +--- diff --git a/website/content/bot/reference/telegram/nft/nftcollection.md b/website/content/bot/reference/telegram/nft/nftcollection.md new file mode 100644 index 000000000000..e0573a9357fc --- /dev/null +++ b/website/content/bot/reference/telegram/nft/nftcollection.md @@ -0,0 +1,57 @@ +--- +title: nftcollection +description: This page provides guidance on how to use the nftcollection command to + retrieve NFT data, including details such as owner, items number, total minted NFTs, + and more. +keywords: +- NFT +- nftcollection +- nft data retrieval +- nft metadata +- non-fungible token +- crypto +- cryptopunks +- chart +- floor price +- sales +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command retrieves a collection of Non-Fungible Token (NFT) data associated with the specified slug. It returns the collection's metadata, including the owner, the number of items in the collection, the total NFTs minted, and various other data on the NFT. + +### Usage + +```python wordwrap +/nftcollection slug [chart] +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| slug | NFT collection slug (e.g., cryptopunks) | False | None | +| chart | Show chart with Floor Price and Sales (True/False) (default: False) | True | None | + + +--- + +## Examples + +``` +/nftcollection bent +``` + +``` +/nftcollection bent chart +``` + +``` +/nftcollection bent y +``` + +--- diff --git a/website/content/bot/reference/telegram/nft/nfttop.md b/website/content/bot/reference/telegram/nft/nfttop.md new file mode 100644 index 000000000000..cb02be39f74a --- /dev/null +++ b/website/content/bot/reference/telegram/nft/nfttop.md @@ -0,0 +1,50 @@ +--- +title: nfttop +description: The page provides comprehensive details on the 'nfttop' command, which + fetches the top NFT collections from Ethereum. It includes parameter details and + command usage examples. +keywords: +- nfttop command +- NFT collections +- Ethereum +- popular NFTs +- nfttop parameters +- command usage +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command allows users to retrieve the top NFT collections from Ethereum. It provides a list of the most popular and valuable NFT collections, helping users to keep abreast of the latest trends in the NFT space. + +### Usage + +```python wordwrap +/nfttop [sortby] [interval] [reverse] +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| sortby | Sort by (default: mc) | True | mc, floor, vol, sales | +| interval | Interval (default: 1d) | True | 1d, 7d, 30d, 90d | +| reverse | Default: `false` | True | None | + + +--- + +## Examples + +``` +/nfttop +``` + +``` +/nfttop mc y +``` + +--- diff --git a/website/content/bot/reference/telegram/options/chains.md b/website/content/bot/reference/telegram/options/chains.md new file mode 100644 index 000000000000..3011c961dfd4 --- /dev/null +++ b/website/content/bot/reference/telegram/options/chains.md @@ -0,0 +1,55 @@ +--- +title: chains +description: This documentation page is about the /chains command, which helps users + retrieve Options Chain by Expiry. This crucial tool provides an overview of the + bid, ask, and open interest of options contracts for a specific stock. +keywords: +- chains command +- Options Chain by Expiry +- bid +- ask +- open interest +- stock options contracts +- stock ticker +- expiration date +- calls or puts +- strike price +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command allows users to retrieve Options Chain by Expiry, which gives an overview of the bid, ask, and open interest of options contracts for a specific stock. + +### Usage + +```python wordwrap +/chains ticker expiry opt_type [min_sp] [max_sp] +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| ticker | Stock Ticker | False | None | +| expiry | Expiration Date (YYYY-MM-DD) | False | None | +| opt_type | Calls or Puts (C or P) | False | calls, puts, C, P | +| min_sp | Minimum Strike Price | True | None | +| max_sp | Maximum Strike Price | True | None | + + +--- + +## Examples + +``` +/chains AMD 2022-07-29 Calls +``` +``` +/chains AMD 2022-07-29 Calls 10 100 +``` + +--- diff --git a/website/content/bot/reference/telegram/options/equitypc.md b/website/content/bot/reference/telegram/options/equitypc.md new file mode 100644 index 000000000000..7f0fd9e1d18e --- /dev/null +++ b/website/content/bot/reference/telegram/options/equitypc.md @@ -0,0 +1,43 @@ +--- +title: equitypc +description: The page documents the usage of equitypc command to retrieve the Equity + Put/Call Volume Ratio from market-harmonics.com. This is a crucial indicator for + traders to gauge market sentiment. +keywords: +- equitypc +- Equity Put/Call Volume Ratio +- market-harmonics.com +- equity market +- market sentiment +- traders +- trading tool +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command retrieves the Equity Put/Call Volume Ratio from market-harmonics.com. This ratio is used to measure the demand for puts versus calls in the equity market and can be a useful tool for traders to help gauge market sentiment. + +### Usage + +```python wordwrap +/equitypc +``` + +--- + +## Parameters + +This command has no parameters + + + +--- + +## Examples + +``` +/equitypc +``` +--- diff --git a/website/content/bot/reference/telegram/options/gamma.md b/website/content/bot/reference/telegram/options/gamma.md new file mode 100644 index 000000000000..6fce363d57b8 --- /dev/null +++ b/website/content/bot/reference/telegram/options/gamma.md @@ -0,0 +1,55 @@ +--- +title: gamma +description: This docusaurus page provides insights about the usage of gamma command + which allows the user to view the Options Gamma Levels for a particular stock. This + can be crucial to make informed trading decisions. +keywords: +- Options Gamma Levels +- Zero Gamma +- Put Wall +- Call Wall +- Gamma command +- underlying stock price changes +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command allows the user to view the Options Gamma Levels for a particular stock. Options Gamma Levels are important to understanding the rate of change for the option's Delta when the underlying stock price changes. Knowing this information can help traders make informed decisions about which options to purchase. + +| Name | Description | +| ---- | ----------- | +| Zero Gamma | Point closest to net zero of Call and Put Gamma | +| Put Wall | Strike with the largest NET Put Gamma | +| Call Wall | Strike with the largest NET Call Gamma | + +### Usage + +```python wordwrap +/gamma ticker [expiry] +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| ticker | Stock Ticker | False | None | +| expiry | Gamma from now until expiry | True | None | + + +--- + +## Examples + +``` +/gamma AMD +``` + +``` +/gamma AMD 2022-07-29 +``` + +--- diff --git a/website/content/bot/reference/telegram/options/highiv.md b/website/content/bot/reference/telegram/options/highiv.md new file mode 100644 index 000000000000..d1b3d0be28f5 --- /dev/null +++ b/website/content/bot/reference/telegram/options/highiv.md @@ -0,0 +1,45 @@ +--- +title: highiv +description: The /highiv command in trading pulls the 15 highest IV30 equity stocks + by 30 day Implied Volatility and is perfect for traders aiming to take advantage + of high-potential-return investments and capitalize on market movements. +keywords: +- high IV30 equity stocks +- 30 day Implied Volatility +- expected volatility +- high potential return investments +- /highiv command +- capitalize on market movements +- stock trading +- trading command +- investment strategies +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command retrieves the 15 highest IV30 equity stocks by 30 day Implied Volatility. The IV30 metric is a measure of the expected volatility of a stock over the next 30 days. This command is ideal for users looking to make investments with high potential return and is useful for traders looking to capitalize on market movements. + +### Usage + +```python wordwrap +/highiv +``` + +--- + +## Parameters + +This command has no parameters + + + +--- + +## Examples + +``` +/highiv +``` +--- diff --git a/website/content/bot/reference/telegram/options/hist.md b/website/content/bot/reference/telegram/options/hist.md new file mode 100644 index 000000000000..9bbd98c8167b --- /dev/null +++ b/website/content/bot/reference/telegram/options/hist.md @@ -0,0 +1,52 @@ +--- +title: hist +description: Learn how to retrieve the historical price of options using the '/hist' + command, considering parameters such as ticker, expiry, strike, option type, interval, + and past days. This page includes examples and a detailed description of each parameter. +keywords: +- stock options +- historical data +- stock ticker +- expiry date +- option type +- /hist command +- strike price +- chart minute interval +- past days +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command allows the user to retrieve the historical price of options for the given parameters of a ticker, expiry, strike , option type, and interval for the past x days in a chart format. + +### Usage + +```python wordwrap +/hist ticker expiry strike opt_type interval [past_days] +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| ticker | Stock Ticker | False | None | +| expiry | Expiration Date YYYY-MM-DD format | False | None | +| strike | Option Strike Price | False | None | +| opt_type | Calls or Puts (C or P) | False | calls, puts, C, P | +| interval | Chart Minute Interval. 15m, 30m, 1hr, 1d | False | 1d, 15m, 30m, 1hr | +| past_days | Past Days to Display. Default: 5 | True | None | + + +--- + +## Examples + +``` +/hist AMD 2022-07-29 70 Calls 15m 5 +``` + +--- diff --git a/website/content/bot/reference/telegram/options/indexpc.md b/website/content/bot/reference/telegram/options/indexpc.md new file mode 100644 index 000000000000..f7121133c052 --- /dev/null +++ b/website/content/bot/reference/telegram/options/indexpc.md @@ -0,0 +1,44 @@ +--- +title: indexpc +description: The page provides an understanding for the /indexpc command and how it + can be used to retrieve the Index Put/Call Ratio from market-harmonics.com. The + relevance of this ratio in identifying the market sentiment for making tactical + trading decisions is also explained. +keywords: +- indexpc command +- market sentiment +- Index Put/Call Ratio +- trading decisions +- market-harmonics.com +- bearish market conditions +- bullish market conditions +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command allows the user to retrieve the Index Put/Call Ratio for the market from market-harmonics.com. This ratio is an indication of the market sentiment and can be used to help traders identify bearish and bullish market conditions. The command returns the ratio and can be used to inform trading decisions. + +### Usage + +```python wordwrap +/indexpc +``` + +--- + +## Parameters + +This command has no parameters + + + +--- + +## Examples + +``` +/indexpc +``` +--- diff --git a/website/content/bot/reference/telegram/options/itm.md b/website/content/bot/reference/telegram/options/itm.md new file mode 100644 index 000000000000..bd37d6ddf958 --- /dev/null +++ b/website/content/bot/reference/telegram/options/itm.md @@ -0,0 +1,46 @@ +--- +title: itm +description: The page provides detailed instructions on using the 'itm' command to + retrieve a list of In-the-Money options for a given stock ticker symbol. The command + compares and delivers a total of In-the-Money and Out-the-Money Calls and Puts. +keywords: +- In-the-Money options +- stock ticker symbol +- expiry date +- Calls and Puts +- Out-the-Money +- options retrieval command +- python command +- stock ticker +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command allows the user to retrieve a list of In-the-Money options for the stock ticker symbol sorted by expiry date. The command compares the amount of Calls and Puts In-the-Money vs Out-the-Money and gives a total. + +### Usage + +```python wordwrap +/itm ticker +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| ticker | Stock Ticker | False | None | + + +--- + +## Examples + +``` +/itm AMD +``` + +--- diff --git a/website/content/bot/reference/telegram/options/iv.md b/website/content/bot/reference/telegram/options/iv.md new file mode 100644 index 000000000000..4fdc16f38af3 --- /dev/null +++ b/website/content/bot/reference/telegram/options/iv.md @@ -0,0 +1,46 @@ +--- +title: iv +description: This page guides the user on how to use the 'iv' command to retrieve + important information like volatility, IV rank, put/call ratios for specific ticker + symbols like 'AMD'. Great resource for individuals who want to extract specific + stock information. +keywords: +- information retrieval +- option information +- ticker symbol +- volatility +- IV rank +- put/call ratio +- stock ticker +- AMD +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command allows the user to quickly and easily retrieve various option information (volatility, IV rank, put/call ratio, etc.) for a specific ticker symbol. + +### Usage + +```python wordwrap +/iv ticker +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| ticker | Stock Ticker | False | None | + + +--- + +## Examples + +``` +/iv AMD +``` +--- diff --git a/website/content/bot/reference/telegram/options/maxpain.md b/website/content/bot/reference/telegram/options/maxpain.md new file mode 100644 index 000000000000..454977bb0395 --- /dev/null +++ b/website/content/bot/reference/telegram/options/maxpain.md @@ -0,0 +1,47 @@ +--- +title: maxpain +description: This page provides instructions on how to use the maxpain command to + retrieve the max pain on expiration date for any given stock. It is the most efficient + guide to using the maxpain feature for tracking a stock's strike price where maximum + financial losses may occur for the largest number of option holders. +keywords: +- maxpain command +- max pain +- stock options +- strike price +- expiration date +- financial losses +- option holders +- stock ticker +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command retrieves the Max Pain on expiration date for a given stock. Max Pain is the strike price with the most open options contracts and it is the price at which the stock would cause financial losses for the largest number of option holders at expiration. + +### Usage + +```python wordwrap +/maxpain ticker expiry +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| ticker | Stock Ticker | False | None | +| expiry | Expiration Date | False | None | + + +--- + +## Examples + +``` +/maxpain AMC 2022-07-29 +``` +--- diff --git a/website/content/bot/reference/telegram/options/oi.md b/website/content/bot/reference/telegram/options/oi.md new file mode 100644 index 000000000000..513fe5cf60b0 --- /dev/null +++ b/website/content/bot/reference/telegram/options/oi.md @@ -0,0 +1,48 @@ +--- +title: oi +description: This documentation page provides an understanding about the oi command + which allows users to retrieve the Open Interest and Call/Put ratio for a given + stock. One can also specify an expiration date to get a more specific breakdown. +keywords: +- Open Interest +- Call/Put ratio +- Stock Ticker +- Expiration Date +- oi command +- AMC +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command allows the user to retrieve the Open Interest and Call/Put ratio for a given stock. Optionally, the user can also specify an expiration date to get a more granular breakdown. + +### Usage + +```python wordwrap +/oi ticker [expiry] +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| ticker | Stock Ticker | False | None | +| expiry | Expiration Date | True | None | + + +--- + +## Examples + +``` +/oi AMC +``` + +``` +/oi AMC 2022-07-29 +``` +--- diff --git a/website/content/bot/reference/telegram/options/oichart.md b/website/content/bot/reference/telegram/options/oichart.md new file mode 100644 index 000000000000..aafed331a030 --- /dev/null +++ b/website/content/bot/reference/telegram/options/oichart.md @@ -0,0 +1,52 @@ +--- +title: oichart +description: Learn how to retrieve a chart of Total Open Interest by Strike Price + for any given ticker symbol using the 'oichart' command. This guide covers usage, + parameters, and examples to help you make informed decisions about the underlying + security. +keywords: +- Open Interest Chart +- Ticker Symbol +- Strike Price +- Stock +- Expiration Date +- oichart command +- Open Interest analysis +- Stock Market Analysis +- Python command +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command allows users to retrieve a chart of Total Open Interest by Strike Price for the given ticker symbol. This chart provides a visual representation of the open interest on various strike prices for the given ticker symbol, where the size of each point on the graph reflects the amount of open interest. This can be used to analyze the open interest on various strike prices and make informed decisions about the underlying security. + +### Usage + +```python wordwrap +/oichart ticker [expiry] +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| ticker | Stock Ticker | False | None | +| expiry | Expiration Date (YYYY-MM-DD) - Optional | True | None | + + +--- + +## Examples + +``` +/oichart AMD +``` + +``` +/oichart AMD 2022-07-29 +``` +--- diff --git a/website/content/bot/reference/telegram/options/opstats.md b/website/content/bot/reference/telegram/options/opstats.md new file mode 100644 index 000000000000..901e6fe978a1 --- /dev/null +++ b/website/content/bot/reference/telegram/options/opstats.md @@ -0,0 +1,43 @@ +--- +title: opstats +description: The page provides a detailed description of the 'opstats' command which + allows the user to retrieve option information like volatility, IV rank, put/call + ratio for a specific stock ticker. +keywords: +- opstats +- volatility +- IV rank +- put/call ratio +- ticker symbol +- Stock Ticker +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command allows the user to quickly and easily retrieve various option information (volatility, IV rank, put/call ratio, etc.) for a specific ticker symbol. + +### Usage + +```python wordwrap +/opstats ticker +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| ticker | Stock Ticker | False | None | + + +--- + +## Examples + +``` +/opstats AMD +``` +--- diff --git a/website/content/bot/reference/telegram/options/smile.md b/website/content/bot/reference/telegram/options/smile.md new file mode 100644 index 000000000000..a1eb14f65a4c --- /dev/null +++ b/website/content/bot/reference/telegram/options/smile.md @@ -0,0 +1,49 @@ +--- +title: smile +description: The page provides a user guide on how to retrieve the Options Volatility + Smile for a specific stock ticker and expiry, offering examples and parameters for + enhanced understanding. +keywords: +- Options Volatility Smile +- Volatility +- Market Sentiment +- expiry +- Minimum Strike Price +- Maximum Strike Price +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command allows the user to retrieve the Options Volatility Smile for the given ticker and expiry. The Options Volatility Smile is a graphical representation of the implied volatility for a given option that can be used to gauge the market sentiment for a particular security. + +### Usage + +```python wordwrap +/smile ticker expiry [min_sp] [max_sp] +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| ticker | Stock Ticker | False | None | +| expiry | Expiration Date | False | None | +| min_sp | Minimum Strike Price | True | None | +| max_sp | Maximum Strike Price | True | None | + + +--- + +## Examples + +``` +/smile AMD 2022-07-29 +``` +``` +/smile AMD 2022-07-29 10 100 +``` +--- diff --git a/website/content/bot/reference/telegram/options/topoi.md b/website/content/bot/reference/telegram/options/topoi.md new file mode 100644 index 000000000000..2576c6e57cdb --- /dev/null +++ b/website/content/bot/reference/telegram/options/topoi.md @@ -0,0 +1,42 @@ +--- +title: topoi +description: Understand how to use the topoi command to retrieve the Top Open Interest + among all stocks. Learn how it queries current market data to provide a list of + the most actively traded stocks and options. +keywords: +- topoi +- Open Interest +- stocks +- trading +- market data +- options +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command allows the user to retrieve Top Open Interest among all stocks. This command queries the current market data and provides a list of the most actively traded stocks and options in the current market. + +### Usage + +```python wordwrap +/topoi +``` + +--- + +## Parameters + +This command has no parameters + + + +--- + +## Examples + +``` +/topoi +``` +--- diff --git a/website/content/bot/reference/telegram/options/topoichange.md b/website/content/bot/reference/telegram/options/topoichange.md new file mode 100644 index 000000000000..3444914a20e5 --- /dev/null +++ b/website/content/bot/reference/telegram/options/topoichange.md @@ -0,0 +1,43 @@ +--- +title: topoichange +description: The topoichange command allows the user to view the top 15 stocks with + the highest OI Change. It displays the stock name, the OI Change by put and call, + and previous levels to provide an overview of the most significant changes in the + stock market. +keywords: +- topoichange command +- stock market +- highest OI Change +- OI Change by put and call +- stock name +- open interest +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command allows the user to view the top 15 stocks with the highest OI Change. It will display the stock name, the OI Change by put and call, and previous levels. This gives users a helpful overview of the stocks that have seen the most significant change in open interest. + +### Usage + +```python wordwrap +/topoichange +``` + +--- + +## Parameters + +This command has no parameters + + + +--- + +## Examples + +``` +/topoichange +``` +--- diff --git a/website/content/bot/reference/telegram/options/topstrikevol.md b/website/content/bot/reference/telegram/options/topstrikevol.md new file mode 100644 index 000000000000..bef1fb7f30fd --- /dev/null +++ b/website/content/bot/reference/telegram/options/topstrikevol.md @@ -0,0 +1,46 @@ +--- +title: topstrikevol +description: This page provides information on the 'topstrikevol' command allowing + users to retrieve the top option strike by volume for a given security. It includes + the option to add an expiration date for a more detailed breakdown. +keywords: +- topstrikevol +- option strike +- stock ticker +- expiration date +- security +- volume +- /topstrikevol AMD +- detail breakdown +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command allows the user to retrieve the top option strike by volume for a given security with the ability to add an expiration date for a more detailed breakdown. + +### Usage + +```python wordwrap +/topstrikevol ticker [expiry] +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| ticker | Stock Ticker | False | None | +| expiry | Expiration Date (optional) | True | None | + + +--- + +## Examples + +``` +/topstrikevol AMD +``` +--- diff --git a/website/content/bot/reference/telegram/options/topvol.md b/website/content/bot/reference/telegram/options/topvol.md new file mode 100644 index 000000000000..527c7b277b63 --- /dev/null +++ b/website/content/bot/reference/telegram/options/topvol.md @@ -0,0 +1,41 @@ +--- +title: topvol +description: The 'topvol' command retrieves the Top 15 Highest stock options volumes + by combining the call and put volume. This information can be utilized to identify + the most liquid options for trading. +keywords: +- topvol +- stock options +- options volume +- trading +- liquid options +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command allows the user to retrieve the Top 15 Highest stock options volumes by adding the call and put volume together. This data can be used to identify the most liquid options for trading. + +### Usage + +```python wordwrap +/topvol +``` + +--- + +## Parameters + +This command has no parameters + + + +--- + +## Examples + +``` +/topvol +``` +--- diff --git a/website/content/bot/reference/telegram/options/topvoletf.md b/website/content/bot/reference/telegram/options/topvoletf.md new file mode 100644 index 000000000000..d100a198d3eb --- /dev/null +++ b/website/content/bot/reference/telegram/options/topvoletf.md @@ -0,0 +1,39 @@ +--- +title: topvoletf +description: Learn how to use the topvoletf command to retrieve the Top 15 Highest + ETF options volumes for identifying the most liquid options for trading. +keywords: +- topvoletf +- ETF options volumes +- most liquid options +- trading +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command allows the user to retrieve the Top 15 Highest ETF options volumes by adding the call and put volume together. This data can be used to identify the most liquid options for trading. + +### Usage + +```python wordwrap +/topvoletf +``` + +--- + +## Parameters + +This command has no parameters + + + +--- + +## Examples + +``` +/topvoletf +``` +--- diff --git a/website/content/bot/reference/telegram/options/unu.md b/website/content/bot/reference/telegram/options/unu.md new file mode 100644 index 000000000000..f44f90f7a5b1 --- /dev/null +++ b/website/content/bot/reference/telegram/options/unu.md @@ -0,0 +1,41 @@ +--- +title: unu +description: The unu command is a tool that retrieves unusual options sorted by strike + and expiration, helping users identify potential trading opportunities. The command + displays options having the highest Volume to Open Interest ratio. +keywords: +- unu command +- unusual options +- trading opportunities +- Volume to Open Interest ratio +- strike and expiration +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command allows a user to retrieve unusual options sorted by strike and expiration. It provides a list of the most unusual options in the market and can be used to identify potential trading opportunities. The results are sorted by the highest Volume to Open Interest ratio giving the user the ability to quickly identify potential trading opportunities. + +### Usage + +```python wordwrap +/unu +``` + +--- + +## Parameters + +This command has no parameters + + + +--- + +## Examples + +``` +/unu +``` +--- diff --git a/website/content/bot/reference/telegram/options/uoastock.md b/website/content/bot/reference/telegram/options/uoastock.md new file mode 100644 index 000000000000..4f09c1f6bfdd --- /dev/null +++ b/website/content/bot/reference/telegram/options/uoastock.md @@ -0,0 +1,46 @@ +--- +title: uoastock +description: Learn how to use the command to fetch the 20-day average options volume + by ticker using the /uoastock command, including special features and detailed usage + examples. +keywords: +- uoastock command +- options volume +- average options volume +- 20-day average +- trading volume +- calls and puts +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command allows the user to retrieve the 20-day average options volume by ticker. The volume is based on the total volume of all options traded in the given period of time, including calls and puts. + +### Usage + +```python wordwrap +/uoastock [price] +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| price | Filter by stocks over a certain price | True | None | + + +--- + +## Examples + +``` +/uoastock +``` +``` +/uoastock 50 +``` +--- diff --git a/website/content/bot/reference/telegram/options/vol.md b/website/content/bot/reference/telegram/options/vol.md new file mode 100644 index 000000000000..b4d412196a42 --- /dev/null +++ b/website/content/bot/reference/telegram/options/vol.md @@ -0,0 +1,48 @@ +--- +title: vol +description: The documentation explores the 'vol' command used to retrieve a chart + of Options Volume by Strike for a specific ticker. Explains usage, parameters, and + provides examples. +keywords: +- vol command +- Options Volume by Strike +- expiry +- stock ticker +- Expiration Date +- Market Analysis +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command allows the user to retrieve a chart of Options Volume by Strike for a specified ticker. This data can be broken down further by adding an expiration date for a more detailed breakdown. + +### Usage + +```python wordwrap +/vol ticker [expiry] +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| ticker | Stock Ticker | False | None | +| expiry | Expiration Date (optional) | True | None | + + +--- + +## Examples + +``` +/vol AMD +``` + +``` +/vol AMD 2022-07-29 +``` +--- diff --git a/website/content/bot/reference/telegram/options/vsurf.md b/website/content/bot/reference/telegram/options/vsurf.md new file mode 100644 index 000000000000..c185863da9a0 --- /dev/null +++ b/website/content/bot/reference/telegram/options/vsurf.md @@ -0,0 +1,47 @@ +--- +title: vsurf +description: This page provides a guide on how to use the 'vsurf' command to retrieve + an options volatility surface for a ticker symbol, displaying the relationship between + stock price and the implied volatility of options. +keywords: +- vsurf command +- options volatility surface +- ticker symbol +- implied volatilities +- stock price +- stock options +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command allows the user to retrieve an options volatility surface for the ticker symbol. Specifically, it will provide a surface based on implied volatilities calculated from options prices, indicating the relationship between the stock price and the implied volatility of options on the stock. + +### Usage + +```python wordwrap +/vsurf ticker z +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| ticker | Stock Ticker | False | None | +| z | iv: Volatility oi: Open Interest lp: Last Price | False | iv, oi, lp | + + +--- + +## Examples + +``` +/vsurf AMD iv +``` +``` +/vsurf AMD oi +``` +--- diff --git a/website/content/bot/reference/telegram/overview/heatchart.md b/website/content/bot/reference/telegram/overview/heatchart.md new file mode 100644 index 000000000000..8e573e70b5e6 --- /dev/null +++ b/website/content/bot/reference/telegram/overview/heatchart.md @@ -0,0 +1,40 @@ +--- +title: heatchart +description: The heatchart command page explains how to retrieve a Daily Market Heat + Chart for day trading, illustrating performance by sector with different colors + indicating different performance levels. +keywords: +- heatchart command +- Daily Market Heat Chart +- market performance visualization +- day trading +- sectoral trading performance +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command allows the user to retrieve a Daily Market Heat Chart (15 minute delayed). The heat chart shows a graphical representation of the performance of the market by sector for that day, with different colors indicating different levels of performance. + +### Usage + +```python wordwrap +/heatchart +``` + +--- + +## Parameters + +This command has no parameters + + +--- + +## Examples + +``` +/heatchart +``` +--- diff --git a/website/content/bot/reference/telegram/overview/heatmap.md b/website/content/bot/reference/telegram/overview/heatmap.md new file mode 100644 index 000000000000..cba8ab6634c8 --- /dev/null +++ b/website/content/bot/reference/telegram/overview/heatmap.md @@ -0,0 +1,47 @@ +--- +title: heatmap +description: Documentation for the 'heatmap' command which retrieves Daily Heat Maps + based on Market and Sector. This provides a quick overview of current stock market + performance. +keywords: +- Heatmap Command +- Daily Heat Maps +- Stock Market Performance +- Market Filter +- Sector Filter +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command allows the user to retrieve Daily Heat Maps by Market and Sector. The Daily Heat Maps will allow the user a quick overview of current stock market performance. + +### Usage + +```python wordwrap +/heatmap market [sector] +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| market | Market to filter by. `sp500`: "S&P 500", `nasdaq100`: "NASDAQ 100", `iwm2000`: "Russell 2000", `iwb1000`: "Russell 1000", `dow30`: "Dow Jones 30", `crypto`: "Crypto" | False | sp500, nasdaq100, iwm2000, iwb1000, dow30, crypto | +| sector | Sector to filter by. If not specified, all sectors are returned. `1`: "Basic Materials" `2`: "Conglomerates" `3`: "Consumer Goods" `4`: "Financial" `5`: "Healthcare" `6`: "Industrial Goods" `7`: "Services" `8`: "Technology" `9`: "Utilities" | True | 0, 1, 2, 3, 4, 5, 6, 7, 8, 9 | + + +--- + +## Examples + +``` +/heatmap sp500 +``` + +``` +/heatmap sp500 services +``` +--- diff --git a/website/content/bot/reference/telegram/overview/index.mdx b/website/content/bot/reference/telegram/overview/index.mdx new file mode 100644 index 000000000000..828ad3baedb4 --- /dev/null +++ b/website/content/bot/reference/telegram/overview/index.mdx @@ -0,0 +1,37 @@ +# overview + +import ReferenceCard from "@site/src/components/General/ReferenceCard"; + +
    + + + + + + + +
diff --git a/website/content/bot/reference/telegram/overview/markets.md b/website/content/bot/reference/telegram/overview/markets.md new file mode 100644 index 000000000000..55dafc893429 --- /dev/null +++ b/website/content/bot/reference/telegram/overview/markets.md @@ -0,0 +1,41 @@ +--- +title: markets +description: This documentation page is about the '/markets' command which allows + the user to retrieve a quick summary of current market conditions, including prices + of the largest ETFs, and movements of stocks relative to the SMA 200/50. +keywords: +- /markets command +- market conditions overview +- largest ETFs prices +- stocks movements +- SMA 200/50 +- Advancers / Decliners +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command allows the user to retrieve a markets overview which provides a quick summary of current market conditions. The overview includes prices of the largest ETFs, with the amount of stocks current above and below the SMA 200/50 and Advancers / Decliners. + +### Usage + +```python wordwrap +/markets +``` + +--- + +## Parameters + +This command has no parameters + + +--- + +## Examples + +``` +/markets +``` +--- diff --git a/website/content/bot/reference/telegram/overview/watchlist.md b/website/content/bot/reference/telegram/overview/watchlist.md new file mode 100644 index 000000000000..deccd828aa3f --- /dev/null +++ b/website/content/bot/reference/telegram/overview/watchlist.md @@ -0,0 +1,47 @@ +--- +title: watchlist +description: This page provides comprehensive information about the watchlist command, + which allows you to retrieve an overview of your watchlist, including current price, + high/low, volume, and change. It also covers how to obtain other related information + such as flow, darkpool data, technical analysis, and news. +keywords: +- Watchlist +- Current price +- High/low +- Volume +- Change +- Flow +- Darkpool data +- Technical analysis +- News +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command allows the user to retrieve an overview of their watchlist, which includes the current price, high/low, volume, and change. You can also get other related information with a quick click like flow, darkpool data, technical analysis, and news - all from one spot. + +### Usage + +```python wordwrap +/watchlist +``` + +--- + +## Parameters + +This command has no parameters + + + +--- + +## Examples + +``` +/watchlist +``` + +--- diff --git a/website/content/bot/reference/telegram/overview/watchlist_add.md b/website/content/bot/reference/telegram/overview/watchlist_add.md new file mode 100644 index 000000000000..9104a7263eca --- /dev/null +++ b/website/content/bot/reference/telegram/overview/watchlist_add.md @@ -0,0 +1,42 @@ +--- +title: watchlist_add +description: This page explains the usage of watchlist_add command which lets the + user add one or more stocks to their watchlist in a finance related application. +keywords: +- watchlist_add command +- adding stocks to watchlist +- finance application commands +- stock market applications +- user guide for watchlist_add +- usage of watchlist_add +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command allows the user to add a stock or stocks to their watchlist. + +### Usage + +```python wordwrap +/watchlist_add tickers +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| tickers | Add a ticker to your watchlist. You can add multiple tickers by separating them with a comma. | False | None | + + +--- + +## Examples + +``` +/watchlist_add AMD,GOOG,TSLA +``` +--- diff --git a/website/content/bot/reference/telegram/overview/watchlist_remove.md b/website/content/bot/reference/telegram/overview/watchlist_remove.md new file mode 100644 index 000000000000..b11af6bca740 --- /dev/null +++ b/website/content/bot/reference/telegram/overview/watchlist_remove.md @@ -0,0 +1,41 @@ +--- +title: watchlist_remove +description: The page describes how to use the watchlist_remove command, which allows + users to take a stock off their watchlist. It includes information on command usage + and informs that the command does not require parameters. +keywords: +- watchlist_remove command +- remove stock from watchlist +- command usage +- no parameters command +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command allows the user to remove a stock from their watchlist. + +### Usage + +```python wordwrap +/watchlist_remove +``` + +--- + +## Parameters + +This command has no parameters + + + +--- + +## Examples + +``` +/watchlist_remove +``` +--- +--- diff --git a/website/content/bot/reference/telegram/screeners/scr/ah.md b/website/content/bot/reference/telegram/screeners/scr/ah.md new file mode 100644 index 000000000000..38408b0615a0 --- /dev/null +++ b/website/content/bot/reference/telegram/screeners/scr/ah.md @@ -0,0 +1,39 @@ +--- +title: ah +description: Documentation page on the 'ah' command for retrieving After-Hours stock + movers with a chosen screener. It includes information on usage and examples with + no parameters. +keywords: +- After-Hours stock movers +- stock screener +- ah command +- stock market data retrieval +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command allows the user to retrieve After-Hours stock movers according to a chosen screener. + +### Usage + +```python wordwrap +/scr ah +``` + +--- + +## Parameters + +This command has no parameters + + +--- + +## Examples + +``` +/scr ah +``` +--- diff --git a/website/content/bot/reference/telegram/screeners/scr/all.md b/website/content/bot/reference/telegram/screeners/scr/all.md new file mode 100644 index 000000000000..d00e1720711a --- /dev/null +++ b/website/content/bot/reference/telegram/screeners/scr/all.md @@ -0,0 +1,41 @@ +--- +title: all +description: Learn how to use the /scr all command to view all available screeners + during market hours and make data-driven investment decisions. +keywords: +- screener +- market hours +- data analysis +- informed decisions +- parameters +- /scr all +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command allows the user to view all available screeners during market hours. The results can then be used to further analyze the data and make better-informed decisions. + +### Usage + +```python wordwrap +/scr all +``` + +--- + +## Parameters + +This command has no parameters + + + +--- + +## Examples + +``` +/scr all +``` +--- diff --git a/website/content/bot/reference/telegram/screeners/scr/pm.md b/website/content/bot/reference/telegram/screeners/scr/pm.md new file mode 100644 index 000000000000..5b9cc202f17e --- /dev/null +++ b/website/content/bot/reference/telegram/screeners/scr/pm.md @@ -0,0 +1,41 @@ +--- +title: pm +description: The PM command page provides a guide for users to understand and use + the PM command to view the top pre-market gainers, losers, and most active stocks, + facilitating a comprehensive pre-market analysis. +keywords: +- pm command +- pre-market gainers +- pre-market losers +- market movements +- stock market +- market opens +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command offers the user the ability to view the top pre-market gainers, losers, and most active, giving the user a better understanding of the market’s movements before the market officially opens. + +### Usage + +```python wordwrap +/scr pm +``` + +--- + +## Parameters + +This command has no parameters + + +--- + +## Examples + +``` +/scr pm +``` +--- diff --git a/website/content/bot/reference/telegram/screeners/screener.md b/website/content/bot/reference/telegram/screeners/screener.md new file mode 100644 index 000000000000..b06177dbe8a0 --- /dev/null +++ b/website/content/bot/reference/telegram/screeners/screener.md @@ -0,0 +1,45 @@ +--- +title: screener +description: The screener command page offers guidance to users on how to retrieve + stock screener results using different technical signals. It includes various screener + signals like Top Gainers, Top Losers, Most Active, etc. +keywords: +- Screener Command +- Stock Screener Results +- Technical Signals +- Top Gainers +- Top Losers +- Most Active +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command allows the user to retrieve stock screener results according to the chosen technical signal. + +### Usage + +```python wordwrap +/screener signal +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| signal | Screener Signal | False | 1 : Top Gainers, 2 : Top Losers, 3 : Most Active, 4 : Most Volatile, 5 : Relative Volatility, 6 : Golden Cross, 7 : Death Cross, 8 : New 52week High, 9 : New 52week Low, 10 : Unusual Volume | + +--- + +## Examples + +``` +/screener 0 +``` +``` +/screener 4 +``` +--- diff --git a/website/content/bot/reference/telegram/short_data/borrowed.md b/website/content/bot/reference/telegram/short_data/borrowed.md new file mode 100644 index 000000000000..1250f78730a9 --- /dev/null +++ b/website/content/bot/reference/telegram/short_data/borrowed.md @@ -0,0 +1,42 @@ +--- +title: borrowed +description: The borrowed page outlines how to track changes in share borrowing using + a particular command. It is a handy tool for investors and traders, assisting with + comparison of broker fees and observing historic data of borrowed shares. +keywords: +- stock market +- share borrowing +- trading +- stock ticker +- broker fees +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command allows the user to view the history of borrowed shares available and fees associated with the stock with the ticker symbol. This can be a useful tool for traders and investors to track changes in share borrowing over time and to compare fees charged by different brokers. + +### Usage + +```python wordwrap +/borrowed ticker +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| ticker | Stock Ticker | False | None | + + +--- + +## Examples + +``` +/borrowed AMD +``` +--- diff --git a/website/content/bot/reference/telegram/short_data/hsi.md b/website/content/bot/reference/telegram/short_data/hsi.md new file mode 100644 index 000000000000..8bc479ca5b57 --- /dev/null +++ b/website/content/bot/reference/telegram/short_data/hsi.md @@ -0,0 +1,45 @@ +--- +title: hsi +description: The page describes the 'hsi' command used to retrieve the top high short + interest stocks over a 20% ratio, offering a tool for investors to identify possible + short squeeze potential. +keywords: +- hsi command +- short interest stocks +- investor +- short squeeze potential +- top stocks +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command retrieves the top high short interest stocks over a 20% ratio. This information can let an investor identify possible short squeeze potential. + +### Usage + +```python wordwrap +/hsi [num] +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| num | Number of top stocks to print | True | None | + + +--- + +## Examples + +``` +/hsi +``` +``` +/hsi 4 +``` +--- diff --git a/website/content/bot/reference/telegram/short_data/shortrate.md b/website/content/bot/reference/telegram/short_data/shortrate.md new file mode 100644 index 000000000000..375e2ead80dc --- /dev/null +++ b/website/content/bot/reference/telegram/short_data/shortrate.md @@ -0,0 +1,42 @@ +--- +title: shortrate +description: Informative guide on how to use the shortrate command that retrieves + Display Short Shares spot borrow rate from Interactive Brokers for a specific ticker. + With this command, users can make more informed decisions in short selling processes. +keywords: +- stock +- short sell +- shortrate command +- borrow rate +- interactive brokers +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command allows the user to retrieve the Display Short Shares spot borrow rate from Interactive Brokers for the given ticker. The spot borrow rate is the rate at which a user may borrow shares from the broker in order to short sell the security. This command allows the user to check the current rate and make more informed decisions about their short selling activities. + +### Usage + +```python wordwrap +/shortrate ticker +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| ticker | Stock Ticker | False | None | + + +--- + +## Examples + +``` +/shortrate AMD +``` +--- diff --git a/website/content/bot/reference/telegram/short_data/shortvol.md b/website/content/bot/reference/telegram/short_data/shortvol.md new file mode 100644 index 000000000000..3861c3ae6661 --- /dev/null +++ b/website/content/bot/reference/telegram/short_data/shortvol.md @@ -0,0 +1,44 @@ +--- +title: shortvol +description: Provides a 30 day history graph of the short volume vs the total volume + of a stock ticker. It gives an understanding of trading activity & potential future + price movements. +keywords: +- short volume +- stock +- trading +- stock ticker +- shares sold short +- shares traded +- future price movements +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command allows the user to retrieve a graph of the 30 day history of the short volume versus the total volume of the stock ticker. The graph also displays the ratio of the total amount of shares that have been sold short versus the total amount of shares traded over the past 30 days. This data can be used to get a better understanding of the stock's trading activity and potential future price movements. + +### Usage + +```python wordwrap +/shortvol ticker +``` + +--- + +## Parameters + +| Name | Description | Optional | Choices | +| ---- | ----------- | -------- | ------- | +| ticker | Stock Ticker | False | None | + + +--- + +## Examples + +``` +/shortvol AMD +``` +--- diff --git a/website/content/bot/reference/telegram/short_data/topshortvol.md b/website/content/bot/reference/telegram/short_data/topshortvol.md new file mode 100644 index 000000000000..e5bf90627574 --- /dev/null +++ b/website/content/bot/reference/telegram/short_data/topshortvol.md @@ -0,0 +1,44 @@ +--- +title: topshortvol +description: This documentation page for the 'topshortvol' command allows users to + understand the use and function of this command, i.e., retrieving the Top 15 Short + Interest Stocks per Finra. It's crucial for traders for making informed market decisions. +keywords: +- topshortvol +- Short Interest Stocks +- Finra +- trading +- traders +- market decisions +- stock's total short vol +- total volume +- trading day +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command allows the user to retrieve the Top 15 Short Interest Stocks per Finra. It's typically measured as a ratio of the stock's total short vol divided by the total volume for the trading day. This information is essential for traders to make informed decisions in the market. + +### Usage + +```python wordwrap +/topshortvol +``` + +--- + +## Parameters + +This command has no parameters + + +--- + +## Examples + +``` +/topshortvol +``` +--- diff --git a/website/versioned_docs/version-v3/bot/usage/_category_.json b/website/content/bot/usage/_category_.json similarity index 100% rename from website/versioned_docs/version-v3/bot/usage/_category_.json rename to website/content/bot/usage/_category_.json diff --git a/website/content/bot/usage/customizing/_category_.json b/website/content/bot/usage/customizing/_category_.json new file mode 100644 index 000000000000..2e5642342010 --- /dev/null +++ b/website/content/bot/usage/customizing/_category_.json @@ -0,0 +1,4 @@ +{ + "label": "Customization", + "position": 3 +} diff --git a/website/versioned_docs/version-v3/bot/usage/customizing/individual.md b/website/content/bot/usage/customizing/individual.md similarity index 79% rename from website/versioned_docs/version-v3/bot/usage/customizing/individual.md rename to website/content/bot/usage/customizing/individual.md index dc3ffb74ccbd..8b5b9bb96843 100644 --- a/website/versioned_docs/version-v3/bot/usage/customizing/individual.md +++ b/website/content/bot/usage/customizing/individual.md @@ -1,16 +1,26 @@ --- title: Individual sidebar_position: 3 -description: Learn to customize your individual OpenBB Bot experience -keywords: [discord, telegram, individual, customizing, customization, how to, explanation, openbb bot, openbb, guide, bot guide] +description: Explore OpenBB's individual plan features that offer real-time charting, + price alerts, and a customizable watchlist to track your crypto and stock investments. + Register today to unlock unlimited commands +keywords: +- OpenBB Bot +- OpenBB Watchlist +- OpenBB Alerts +- OpenBB Charting +- Crypto Tracking +- Stock Tracking +- Real-time charting +- Custom chart +- Investment tracking +- Price Alerts --- - import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - + -## Customizing your Individual Bot Experience The individual plan offers three different capabilities - Charting, Alerts, and Watchlist. In addition to these benefits you also get unlimited commands per month after registering. @@ -22,19 +32,19 @@ The individual plan offers three different capabilities - Charting, Alerts, and /> -### Charting +## Charting Our most popular commands center around the real-time charting capabilities we offer with OpenBB Bot. We allow you to customize many different aspects of your charts when you register with us. You can customize the chart theme and style as well as adding any on and off chart indicators you desire. These settings will apply across all platforms. charting openBB -### Alerts +## Alerts Alerts are a powerful tool used by OpenBB users. Simply set the symbol and price you wish to be alerted at and we do the rest! alerts openBB -### Watchlist +## Watchlist OpenBB Watchlist is a great way to keep track of all your investments in once place. Add Crypto or Stock symbols and quickly see the prices at a glance when its convenient for you. You can add your tickers through the [HUB](https://my.openbb.co/app/bot/watchlist) or run ```/watchlist``` in your respective platform to configure. diff --git a/website/content/bot/usage/customizing/overview.md b/website/content/bot/usage/customizing/overview.md new file mode 100644 index 000000000000..fc35dc706abf --- /dev/null +++ b/website/content/bot/usage/customizing/overview.md @@ -0,0 +1,46 @@ +--- +title: Overview +sidebar_position: 1 +description: A guide to OpenBB Bot settings customization, including chart themes, + alerts, autoposting, and more. Learn how to link your account and start personalizing + your experience now. +keywords: +- OpenBB Bot settings +- customization +- chart themes +- technical analysis indicators +- alerts +- watchlists +- autoposting +- billboard message +- Linked Platforms +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +For the best user experience, you will want to customize the OpenBB Bot settings. Different types of customizations we offer are: + +
+
    +
  • + INDIVIDUAL: Allows to customize chart themes, add technical analysis indicators in the chart, create alerts and watchlists +
    • +
  • + SERVER: Allows to customize chart settings, autoposting for members of your server and billboard message (for announcements). +
    • +
+
+ +In Order to you customize you will need to link your account. You can find this under [Linked Platforms](https://my.openbb.co/app/bot/linked-platforms) on the Hub Page - an explanation of how to link is provided there. + +
+gif describing step +
+ +Now that your account is linked - lets dive into what you can do on the next pages. diff --git a/website/versioned_docs/version-v3/bot/usage/customizing/server.md b/website/content/bot/usage/customizing/server.md similarity index 86% rename from website/versioned_docs/version-v3/bot/usage/customizing/server.md rename to website/content/bot/usage/customizing/server.md index 3103f4a09c63..0a9bd4c824ec 100644 --- a/website/versioned_docs/version-v3/bot/usage/customizing/server.md +++ b/website/content/bot/usage/customizing/server.md @@ -1,21 +1,26 @@ --- title: Server sidebar_position: 3 -description: Learn to customize your OpenBB Bot server experience. -keywords: [discord, telegram, server, customizing, customization, how to, explanation, openbb bot, openbb, guide, bot guide] +description: Learn about OpenBB Bot's Server plan that offers powerful features such + as auto posting for Discord, custom charting, and a billboard for advertising. Perfect + for optimizing your server operations. +keywords: +- OpenBB Bot Server Plan +- Discord Server Optimisation +- Auto Posting in Discord +- OpenBB Auto Posting Categories +- Custom Charting +- OpenBB Bot Billboard +- OpenBB HUB --- import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - - -## Customizing your Server Bot Experience + The Server plan for OpenBB Bot offers three different capabilities - Charting, BillBoard, and Auto Posting. Any server that registers with us on the [OpenBB HUB](https://my.openbb.co) gets access to set up one Auto Posting for free. Once you have paid plan you have full access to all these features. -## Server - -### Auto Posting (Feeds) (Discord Only) +## Auto Posting (Feeds) (Discord Only) Auto Posting is our most powerful feature for Discord Servers - We offer the ability to push updates into the server for Flow, Darkpool, or Heatmap/Charts. Once you set up your account you will be able to query the bot directly in your server like below : @@ -47,7 +52,7 @@ For a further breakdown on what each Flow Auto Post entails - See below | Whale | "Premium > $1.000,000" & "Days to Expiration < 45" | -### Auto Posting (Commands) (Discord Only) +## Auto Posting (Commands) (Discord Only) Much like Feeds we now offer Commands to be set up as autoposts as well - These behave in the same way but can be setup to autopost bot commands. @@ -65,14 +70,14 @@ Below are a few examples of autoposts set up as commands in a server : earnings command autopost openBB -### Charting +## Charting Custom charting works the same way as Individual charting but it will apply to your full server. If you want everyone in your server to use the "Classic" theme and have RSI + 50d SMA then it will display that way for all users in your server (unless they have already registered their own individual account). server charting openBB -### BillBoard +## Billboard -BillBoard is a way to advertise to your users when they run a command on the bot. Within your server you can set your own text to display on applicable commands as they are run. +Billboard is a way to advertise to your users when they run a command on the bot. Within your server you can set your own text to display on applicable commands as they are run. billboard openBB diff --git a/website/content/bot/usage/discord.md b/website/content/bot/usage/discord.md new file mode 100644 index 000000000000..ff42bc8425c5 --- /dev/null +++ b/website/content/bot/usage/discord.md @@ -0,0 +1,43 @@ +--- +title: Discord +sidebar_position: 1 +description: Learn how to use the OpenBB Discord Bot using slash commands to explore + stock market data. Discover the most popular commands like /help, /cd, /c3m, and + /flow for daily charts, 3-month charts, and options flow, respectively. +keywords: +- OpenBB Discord Bot +- slash commands +- /help command +- stock ticker +- daily chart +- 3-month chart +- options flow +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Now that you have added the bot to your Discord you can get started with running commands. + +If you're new to OpenBB Discord Bot, here's a quick guide to get you started. + +To use OpenBB, you need to use slash commands, which are special commands that start with a / symbol. To autoselect commands if you are on Desktop you can hit ```TAB``` + +
+ gif describing step +
+ +You can type / in the chat to see a list of available slash commands for OpenBB Bot. One of the most useful slash commands is ```/help```, which shows you all the commands and how to use them. Some of the most popular commands are: + +- ```/cd ticker: AMD``` Shows the daily chart for a given stock ticker. +- ```/c3m ticker: AMD``` Shows the 3-month chart for a given stock ticker. +- ```/flow ticker: AMD``` Shows the recent options flow for the given stock ticker. + +That's it! You're ready to explore the market with OpenBB Discord Bot! + +Check out the Reference section for more commands or type ```/help``` in your chat to see what else we can do! diff --git a/website/content/bot/usage/telegram.md b/website/content/bot/usage/telegram.md new file mode 100644 index 000000000000..c36c5ccaf2e4 --- /dev/null +++ b/website/content/bot/usage/telegram.md @@ -0,0 +1,53 @@ +--- +title: Telegram +sidebar_position: 2 +description: A complete guide on how to use the OpenBB Telegram Bot for stock and + crypto market exploration. Learn how to use slash commands, including /cd, /c3m, + /flow, and /c for market insights. +keywords: +- Telegram +- /cd command +- /c3m command +- /flow command +- /c command +- OpenBB Telegram Bot +- stock ticker +- crypto symbol +- market exploration +- using bots +- Telegram commands +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Now that you have added the bot to your Telegram server you can get started with running commands. + +To use it, you need to type slash commands in the chat. A slash command starts with a / followed by a keyword and an optional argument. For example, ```/cd AAPL``` will show you the daily chart for Apple stock. + +
+ gif describing step +
+ +
How do I select commands instead of typing? +If you are On mobile press and hold to select the command. + +On desktop press ```tab``` to select the command. +
+ + +To see all the available commands, you can type ```/help``` in the chat. This will show you a list of commands and their descriptions. You can also tap on any command to use it directly. Some of the most popular commands are: + +- ```/cd AMD``` Shows the daily chart for a given stock ticker. +- ```/c3m AMD``` Shows the 3-month chart for a given stock ticker. +- ```/flow AMD``` Shows the recent options flow for the given stock ticker. +- ```/c DOGE``` Shows a chart for the crypto symbol provided. + +That's it! You're ready to use OpenBB Telegram Bot and explore the markets. Have fun! + +Check out the Reference section for more commands or type ```/help``` in your chat to see what else we can do! diff --git a/website/content/platform/contributing/_category_.json b/website/content/platform/contributing/_category_.json index d6b490c4bee8..6801deb7f5c0 100644 --- a/website/content/platform/contributing/_category_.json +++ b/website/content/platform/contributing/_category_.json @@ -1,4 +1,4 @@ { "label": "Contributing", - "position": 2 + "position": 6 } diff --git a/website/content/platform/contributing/introduction/data_standardization.md b/website/content/platform/contributing/data_standardization.md similarity index 84% rename from website/content/platform/contributing/introduction/data_standardization.md rename to website/content/platform/contributing/data_standardization.md index bcf3478f1ed8..c958568adf52 100644 --- a/website/content/platform/contributing/introduction/data_standardization.md +++ b/website/content/platform/contributing/data_standardization.md @@ -1,13 +1,29 @@ --- title: Data Standardization -sidebar_position: 1 -description: Learn what is data standardization and how does it work inside the OpenBB Platform. -keywords: [openbb platform, introduction, data standardization, contributing, documentation] +sidebar_position: 2 +description: Our OpenBB Platform's Standardization Framework provides a set of tools + and guidelines that ensure consistently structured data across multiple providers. + Usage of these models will provide numerous benefits, such as query and output standardization, + out-of-the-box extensions, transparently defined schemas, consistent data types + and validation. +keywords: +- Standardization Framework +- OpenBB Platform +- Data consistency +- Data Validation +- API schemas +- Standard Models +- QueryParams +- Data +- pydantic +- Stock Historical Query +- Stock Historical Data +- OpenBB Standardization Caveats --- import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - + The Standardization Framework is a set of tools and guidelines that enable the user to query and obtain data in a consistent way across multiple providers. diff --git a/website/content/platform/contributing/extension-development/_category_.json b/website/content/platform/contributing/extension-development/_category_.json index e5d78b7a1e97..7d3fad834ed2 100644 --- a/website/content/platform/contributing/extension-development/_category_.json +++ b/website/content/platform/contributing/extension-development/_category_.json @@ -1,4 +1,4 @@ { "label": "Extension Development", - "position": 2 + "position": 4 } diff --git a/website/content/platform/contributing/extension-development/cookie-cutter.md b/website/content/platform/contributing/extension-development/cookie-cutter.md new file mode 100644 index 000000000000..aa4adaffa329 --- /dev/null +++ b/website/content/platform/contributing/extension-development/cookie-cutter.md @@ -0,0 +1,32 @@ +--- +title: Cookie Cutter +sidebar_position: 1 +description: Walkthrough guide on using the Cookiecutter template for easy extension + development on the OpenBB Platform with a focus on data efficiency, instructions, + and sharing your extension with the community. +keywords: +- Cookiecutter template +- extensions development +- OpenBB Platform +- API interface +- new extension +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +We have a Cookiecutter template that will help you get started. It serves as a jumpstart for your extensions development, so you can focus on the data and not on the boilerplate. + +Please refer to the [Cookiecutter template](https://github.com/OpenBB-finance/openbb-cookiecutter) and follow the instructions there. + +This section will walk you through the steps of adding a new extension to the OpenBB Platform. + +The high level steps are: + +- Generate the extension structure +- Install your dependencies +- Install your new package +- Use your extension (either from Python or the API interface) +- QA your extension +- Share your extension with the community diff --git a/website/content/platform/contributing/extension-development/custom_data.md b/website/content/platform/contributing/extension-development/custom_data.md index 5c1dcb4a4af6..5f5673c8450b 100644 --- a/website/content/platform/contributing/extension-development/custom_data.md +++ b/website/content/platform/contributing/extension-development/custom_data.md @@ -1,13 +1,31 @@ --- title: Add a custom data source sidebar_position: 2 -description: Add a custom data source to the OpenBB Platform. -keywords: [openbb platform, extension, custom data source, contributing, documentation] +description: This page provides comprehensive guidance on using the OpenBB Platform + for data sourcing from a CSV file, local database or API endpoint. It details the + standardization framework, the use of Pydantic models for data extraction, and the + importance of the Fetcher class. It also includes steps to define FastAPI endpoints, + and utilize OpenBB commands for data querying and output. +keywords: +- OpenBB Platform +- standardization framework +- data validation +- type checking +- data schema +- query parameters +- Fetcher class +- OpenBB commands +- FastAPI endpoints +- data extraction +- API endpoint +- CSV file +- local database +- pydantic models --- import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - + You will get your data either from a CSV file, local database or from an API endpoint. diff --git a/website/content/platform/contributing/extension-development/index.md b/website/content/platform/contributing/extension-development/index.md deleted file mode 100644 index eee1083d324a..000000000000 --- a/website/content/platform/contributing/extension-development/index.md +++ /dev/null @@ -1,25 +0,0 @@ ---- -title: Extension Development -sidebar_position: 1 -description: Learn how to develop Extensions inside the OpenBB Platform. -keywords: [openbb platform, introduction, extensions, contributing, documentation] ---- - -import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - - - -We have a Cookiecutter template that will help you get started. It serves as a jumpstart for your extensions development, so you can focus on the data and not on the boilerplate. - -Please refer to the [Cookiecutter template](https://github.com/OpenBB-finance/openbb-cookiecutter) and follow the instructions there. - -This section will walk you through the steps of adding a new extension to the OpenBB Platform. - -The high level steps are: - -- Generate the extension structure -- Install your dependencies -- Install your new package -- Use your extension (either from Python or the API interface) -- QA your extension -- Share your extension with the community diff --git a/website/content/platform/contributing/extension-development/qa.md b/website/content/platform/contributing/extension-development/qa.md index 562ac7d7394b..bfb7f207067d 100644 --- a/website/content/platform/contributing/extension-development/qa.md +++ b/website/content/platform/contributing/extension-development/qa.md @@ -1,13 +1,27 @@ --- title: Extension QA sidebar_position: 3 -description: Learn how to QA your extension. -keywords: [openbb platform, introduction, qa, contributing, extension, documentation] +description: This documentation page provides detailed instructions on creating and + executing automated unit and integration tests on the OpenBB Platform. It covers + the process for fetching data, testing the Python and API interfaces, and generating + these tests. +keywords: +- OpenBB Platform +- unit tests +- integration tests +- python interface +- API interface +- test generator +- QA process +- quality assurance +- testing tools +- automated testing +- tuna import time --- import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - + We are strong believers in the QA process and we want to make sure that all the extensions that are added to the OpenBB Platform are of high quality. To ensure this, we have a set of QA tools that you can use to test your extension. diff --git a/website/content/platform/contributing/extension-development/share_extension.md b/website/content/platform/contributing/extension-development/share_extension.md index d6ad45a2ebb1..7eb75140f5d6 100644 --- a/website/content/platform/contributing/extension-development/share_extension.md +++ b/website/content/platform/contributing/extension-development/share_extension.md @@ -1,14 +1,29 @@ --- title: Share your extension sidebar_position: 4 -description: How to share your extension with the community. -keywords: [openbb platform, introduction, share, extension, contributing, - documentation, PyPI, community] +description: A guide on how to publish, release and install an extension on PyPI using + commands like poetry build and poetry publish. Part of the developer setup includes + generating an API token. +keywords: +- extension +- publish +- PyPI +- API token +- poetry +- pyproject.toml +- pip install +- release +- .whl +- tar.gz +- poetry build +- poetry publish +- dist +- openbb --- import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - + We encourage you to share your extension with the community. You can do that by publishing it to PyPI. diff --git a/website/content/platform/contributing/extensions.md b/website/content/platform/contributing/extensions.md new file mode 100644 index 000000000000..13542b0c084c --- /dev/null +++ b/website/content/platform/contributing/extensions.md @@ -0,0 +1,35 @@ +--- +title: Extensions in the OpenBB Platform +sidebar_position: 3 +description: Learn about the different types of extensions that add functionality + to the OpenBB Platform, including OpenBB extensions, community extensions, and independent + extensions. +keywords: +- OpenBB Platform +- extensions +- OpenBB extensions +- Community Extensions +- Independent Extensions +- openbb-stocks +- openbb-yfinance +- PR +- PyPI +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Extensions add functionality to the OpenBB Platform. They can be a new data source, a new command, a new visualization, etc. + +## Types of extensions + +We primarily have 3 types of extensions: + +1. OpenBB Extensions - built and maintained by the OpenBB team (e.g. `openbb-stocks`) +2. Community Extensions - built by anyone and primarily maintained by OpenBB (e.g. `openbb-yfinance`) +3. Independent Extensions - built and maintained independently by anyone + +If your extension is of high quality and you think that it would be a good community extension, you can open a PR to the OpenBB Platform repository and we'll review it. + +We encourage independent extensions to be shared with the community by publishing them to PyPI. diff --git a/website/content/platform/contributing/index.md b/website/content/platform/contributing/index.md deleted file mode 100644 index b0d1f5c9c8ea..000000000000 --- a/website/content/platform/contributing/index.md +++ /dev/null @@ -1,50 +0,0 @@ ---- -title: OpenBB Platform - An Introduction -sidebar_position: 1 -description: Learn how to contribute to the OpenBB Platform. -keywords: [openbb platform, introduction, contributing, documentation] ---- - -import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - - - -The OpenBB Platform is built by the Open-Source community and is characterized by its core and extensions. The core handles data integration and standardization, while the extensions enable customization and advanced functionalities. The OpenBB Platform is designed to be used both from a Python interface and a REST API. - -The REST API is built on top of FastAPI and can be started by running the following command from the root: - -```bash -uvicorn openbb_platform.platform.core.openbb_core.api.rest_api:app --host 0.0.0.0 --port 8000 --reload -``` - -The Python interfaces we provide to users is the `openbb` python package. - -The code you will find in this package is generated from a script and it is just a wrapper around the `openbb-core` and any installed extensions. - -When the user runs `import openbb`, `from openbb import obb` or other variants, the script that generates the package code is triggered. It detects if there are new openbb extensions installed in the environment and rebuilds the package code accordingly. If new extensions are not found, it just uses the current package version. - -When you are developing chances are you want to manually trigger the package rebuild. - -You can do that with: - -```python -python -c "import openbb; openbb.build()" -``` - -The Python interface can be imported with: - -```python -from openbb import obb -``` - -This section will take you through two types of contributions: - -1. Building a custom extension -2. Contributing directly to the OpenBB Platform - -Before moving forward, please take a look at the high-level view of the OpenBB Platform architecture. We will go over each bit in the following sections. - - - - OpenBB Platform High-Level Architecture - diff --git a/website/content/platform/contributing/introduction.md b/website/content/platform/contributing/introduction.md new file mode 100644 index 000000000000..cb634401f806 --- /dev/null +++ b/website/content/platform/contributing/introduction.md @@ -0,0 +1,64 @@ +--- +title: Introduction +sidebar_position: 1 +description: Learn about the OpenBB Platform, an open-source solution built by the + community. Understand its use via Python interface and REST API, and acquaint yourself + with how to build a custom extension or contribute directly to the platform +keywords: +- OpenBB Platform +- Open source +- Python interface +- REST API +- Data integration +- Data standardization +- OpenBB extensions +- openbb-core +- Python package +- High-Level Architecture +- Custom extension +- Contribution +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +The OpenBB Platform is built by the Open-Source community and is characterized by its core and extensions. The core handles data integration and standardization, while the extensions enable customization and advanced functionalities. The OpenBB Platform is designed to be used both from a Python interface and a REST API. + +The REST API is built on top of FastAPI and can be started by running the following command from the root: + +```bash +uvicorn openbb_platform.platform.core.openbb_core.api.rest_api:app --host 0.0.0.0 --port 8000 --reload +``` + +The Python interfaces we provide to users is the `openbb` python package. + +The code you will find in this package is generated from a script and it is just a wrapper around the `openbb-core` and any installed extensions. + +When the user runs `import openbb`, `from openbb import obb` or other variants, the script that generates the package code is triggered. It detects if there are new openbb extensions installed in the environment and rebuilds the package code accordingly. If new extensions are not found, it just uses the current package version. + +When you are developing chances are you want to manually trigger the package rebuild. + +You can do that with: + +```python +python -c "import openbb; openbb.build()" +``` + +The Python interface can be imported with: + +```python +from openbb import obb +``` + +This section will take you through two types of contributions: + +1. Building a custom extension +2. Contributing directly to the OpenBB Platform + +Before moving forward, please take a look at the high-level view of the OpenBB Platform architecture. We will go over each bit in the following sections. + + + + OpenBB Platform High-Level Architecture + diff --git a/website/content/platform/contributing/introduction/_category_.json b/website/content/platform/contributing/introduction/_category_.json deleted file mode 100644 index 5672045964cc..000000000000 --- a/website/content/platform/contributing/introduction/_category_.json +++ /dev/null @@ -1,4 +0,0 @@ -{ - "label": "Introduction", - "position": 1 -} diff --git a/website/content/platform/contributing/introduction/extensions.md b/website/content/platform/contributing/introduction/extensions.md deleted file mode 100644 index c9b5840d9806..000000000000 --- a/website/content/platform/contributing/introduction/extensions.md +++ /dev/null @@ -1,24 +0,0 @@ ---- -title: Extensions in the OpenBB Platform -sidebar_position: 2 -description: Learn about the Extensions inside the OpenBB Platform. -keywords: [openbb platform, introduction, extensions, contributing, documentation] ---- - -import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - - - -Extensions add functionality to the OpenBB Platform. They can be a new data source, a new command, a new visualization, etc. - -## Types of extensions - -We primarily have 3 types of extensions: - -1. OpenBB Extensions - built and maintained by the OpenBB team (e.g. `openbb-stocks`) -2. Community Extensions - built by anyone and primarily maintained by OpenBB (e.g. `openbb-yfinance`) -3. Independent Extensions - built and maintained independently by anyone - -If your extension is of high quality and you think that it would be a good community extension, you can open a PR to the OpenBB Platform repository and we'll review it. - -We encourage independent extensions to be shared with the community by publishing them to PyPI. diff --git a/website/content/platform/contributing/platform-development/_category_.json b/website/content/platform/contributing/platform-development/_category_.json index 5832b96bf414..0268c503c8cf 100644 --- a/website/content/platform/contributing/platform-development/_category_.json +++ b/website/content/platform/contributing/platform-development/_category_.json @@ -1,4 +1,4 @@ { "label": "Platform Development", - "position": 3 + "position": 5 } diff --git a/website/content/platform/contributing/platform-development/add_data_point.md b/website/content/platform/contributing/platform-development/add_data_point.md index 06ade5368f0f..71d3970793aa 100644 --- a/website/content/platform/contributing/platform-development/add_data_point.md +++ b/website/content/platform/contributing/platform-development/add_data_point.md @@ -1,14 +1,26 @@ --- title: Add a new data point sidebar_position: 3 -description: Learn how to add a new data point to the OpenBB Platform. -keywords: [openbb platform, introduction, data point, contributing, documentation, -provider, QueryParams, Data, Fetcher, transform, extract] +description: This documentation page explains how to add a new data point to the OpenBB + platform, with a focus on adding a new provider using an existing standard data + model. It walks through steps of identifying data types, checking standard models, + creating query parameters model, building the fetcher, and making the provider visible. +keywords: +- OpenBB platform +- data point +- provider +- standard data model +- query parameters model +- OHLC stock data +- StockHistorical +- Fetcher class +- Python +- API endpoint --- import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - + In this section, we'll be adding a new data point to the OpenBB Platform. We will add a new provider with an existing [standard data](https://github.com/OpenBB-finance/OpenBBTerminal/tree/feature/openbb-sdk-v4/openbb_platform/platform/provider/openbb_provider/standard_models) model. diff --git a/website/content/platform/contributing/platform-development/create_pr.md b/website/content/platform/contributing/platform-development/create_pr.md index ba6aa70471b2..da5b341d4db4 100644 --- a/website/content/platform/contributing/platform-development/create_pr.md +++ b/website/content/platform/contributing/platform-development/create_pr.md @@ -1,13 +1,27 @@ --- title: Create a Pull Request sidebar_position: 5 -description: Learn how to create a Pull Request to the OpenBB Platform. -keywords: [openbb platform, introduction, pull request, contributing, documentation, github] +description: Learn how to create a Pull Request to the OpenBB Platform, including + steps like creating a feature branch, staging files, writing commit messages, and + more. Also learn about the installation of pre-commit hooks and the conventions + for branch naming. +keywords: +- OpenBB Platform +- Pull Request +- branch +- fork repository +- feature branch +- git status +- git add +- commit message +- pre-commit hooks +- branch naming conventions +- develop branch --- import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - + To create a Pull Request to the OpenBB Platform, you'll need to fork the repository and create a new branch. diff --git a/website/content/platform/contributing/platform-development/environments_dependencies.md b/website/content/platform/contributing/platform-development/environments_dependencies.md index d049e08ec21e..1815543444a6 100644 --- a/website/content/platform/contributing/platform-development/environments_dependencies.md +++ b/website/content/platform/contributing/platform-development/environments_dependencies.md @@ -1,13 +1,31 @@ --- title: Setup your development environment sidebar_position: 2 -description: Learn how to setup your development environment for the OpenBB Platform. -keywords: [openbb platform, introduction, environment, setup, contributing, documentation] +description: Detailed instructions on setting up the development environment for contributing + to the OpenBB Platform. This includes sections on setting up Miniconda, Git, cloning + the repository, creating a virtual environment, managing the environment with Poetry, + installing packages, and setting up API keys. +keywords: +- OpenBB Platform contribution +- environment setup +- Miniconda +- Git +- repository clone +- virtual environment +- python versions +- Poetry +- packages installation +- API keys setup +- OpenBB Hub +- Python interface +- API Keys --- + + import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - + In order to contribute to the OpenBB Platform, you need to setup your environment to ensure a smooth development experience. @@ -50,6 +68,7 @@ Please refer to [OpenBBTerminal docs](https://docs.openbb.co/terminal/installati 5. Setup your API keys locally by adding them to the `~/.openbb_platform/user_settings.json` file. Populate this file with the following template and replace the values with your keys: + ```json { "credentials": { @@ -61,4 +80,4 @@ Please refer to [OpenBBTerminal docs](https://docs.openbb.co/terminal/installati } ``` - > You can also setup and use your keys from the OpenBB Hub and the Python interface at runtime. Follow the steps in [API Keys](./README.md#api-keys) section to know more about it. + > You can also setup and use your keys from the OpenBB Hub. Follow the instructions on [API Keys](https://my.openbb.co/app/sdk/api-keys)) page to know more about it. diff --git a/website/content/platform/contributing/platform-development/index.md b/website/content/platform/contributing/platform-development/index.md deleted file mode 100644 index 1200f520311e..000000000000 --- a/website/content/platform/contributing/platform-development/index.md +++ /dev/null @@ -1,16 +0,0 @@ ---- -title: OpenBB Platform Development -sidebar_position: 1 -description: Introduction to the OpenBB Platform. -keywords: [openbb platform, introduction, development, contributing, documentation] ---- - -import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - - - -There are many ways to contribute to the OpenBB Platform. You can add a new data point, add a new command, add a new visualization, add a new extension, fix a bug etc. - -In this section, we'll be focusing on adding a new data point to the OpenBB Platform. - -Before that, we will need to setup our development environment. diff --git a/website/content/platform/contributing/platform-development/manage_extensions.md b/website/content/platform/contributing/platform-development/manage_extensions.md index 4458d1e5926f..f7c4df8dcc21 100644 --- a/website/content/platform/contributing/platform-development/manage_extensions.md +++ b/website/content/platform/contributing/platform-development/manage_extensions.md @@ -1,14 +1,23 @@ --- title: Manage Extensions sidebar_position: 4 -description: Learn how to manage extensions in the OpenBB Platform. -keywords: [openbb, platform, introduction, manage extensions, contributing, - documentation, pypi] +description: This page provides detailed guidance on how to install locally developed + extensions and external extensions hosted on PyPI, including the use of pip install + commands, how to add an extension as a dependency, and instructions for using the + LOCAL_DEPS variable in the dev_install.py file and the pyproject.toml file. +keywords: +- pip install extension +- pyproject.toml +- LOCAL_DEPS +- python dev_install.py +- poetry.dependencies +- openbb-extension +- openbb-qa --- import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - + To install extensions hosted on PyPI, use the `pip install ` command. diff --git a/website/content/platform/contributing/platform-development/setting-dev-environment.md b/website/content/platform/contributing/platform-development/setting-dev-environment.md new file mode 100644 index 000000000000..9687b6ae086c --- /dev/null +++ b/website/content/platform/contributing/platform-development/setting-dev-environment.md @@ -0,0 +1,25 @@ +--- +title: Contributing to Platform Development +sidebar_position: 1 +description: 'Learn how to contribute to the OpenBB Platform: add a new data point, + command, visualization, extension, fix a bug, and setup your development environment' +keywords: +- OpenBB Platform +- contribute +- new data point +- command +- visualization +- extension +- bug fix +- development environment setup +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +There are many ways to contribute to the OpenBB Platform. You can add a new data point, add a new command, add a new visualization, add a new extension, fix a bug etc. + +In this section, we'll be focusing on adding a new data point to the OpenBB Platform. + +Before that, we will need to setup our development environment. diff --git a/website/content/platform/data_models/AMERIBOR.md b/website/content/platform/data_models/AMERIBOR.md index 710b5eb5f385..95fa8ed84248 100644 --- a/website/content/platform/data_models/AMERIBOR.md +++ b/website/content/platform/data_models/AMERIBOR.md @@ -1,8 +1,29 @@ --- title: Ameribor -description: OpenBB Platform Data Model +description: "This page provides essential details on the implementation, including\ + \ class names, parameter terminology, import statements, and data types. \u0399\ + t focuses especially on the AMERIBOR, AMERIBORQueryParams, and AMERIBORData. It\ + \ also demonstrates the use of tabs for clean display of data parameters and types.\ + \ Ideal for users needing to dig into the specifics of these classes or understand\ + \ the AMERIBOR rate application." +keywords: +- AMERIBOR +- AMERIBORQueryParams +- AMERIBORData +- openbb_provider +- data class +- parameters class +- implementation details +- tab integration +- parameter types +- data types +- fred provider --- +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; @@ -63,4 +84,3 @@ AMERIBORQueryParams, - diff --git a/website/content/platform/data_models/AnalystEstimates.md b/website/content/platform/data_models/AnalystEstimates.md index e6259d5956e9..b80c79003c2f 100644 --- a/website/content/platform/data_models/AnalystEstimates.md +++ b/website/content/platform/data_models/AnalystEstimates.md @@ -1,8 +1,29 @@ --- title: Analyst Estimates -description: OpenBB Platform Data Model +description: This page provides detailed information on the Analyst Estimates standard + models - AnalystEstimatesData and AnalystEstimatesQueryParams. Find import statements, + parameters, and data schemas for these classes. +keywords: +- Analyst Estimates +- Standard Models +- AnalystEstimatesData +- AnalystEstimatesQueryParams +- Python +- Import Statement +- Parameters +- Data Schema +- Estimated Revenue +- Estimated EBITDA +- Estimated EBIT +- Estimated Net Income +- Estimated SGA Expense +- Estimated EPS --- +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; @@ -74,4 +95,3 @@ AnalystEstimatesQueryParams, - diff --git a/website/content/platform/data_models/AvailableIndices.md b/website/content/platform/data_models/AvailableIndices.md index c644d8b10089..02f2184d03a2 100644 --- a/website/content/platform/data_models/AvailableIndices.md +++ b/website/content/platform/data_models/AvailableIndices.md @@ -1,8 +1,30 @@ --- title: Available Indices -description: OpenBB Platform Data Model +description: This page provides an in-depth look into the features and details of + working with AvailableIndices, including parameters and data details. It also provides + the class names that encapsulate these details and a guide on how to use them in + your project. +keywords: +- Implementation details +- Class names +- Import Statement +- Parameters +- Data +- AvailableIndices +- AvailableIndicesQueryParams +- AvailableIndicesData +- provider +- fmp +- name +- currency +- stock_exchange +- exchange_short_name --- +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; @@ -61,4 +83,3 @@ AvailableIndicesQueryParams, - diff --git a/website/content/platform/data_models/BalanceSheet.md b/website/content/platform/data_models/BalanceSheet.md index fe2d612b8aee..82dab4d593d6 100644 --- a/website/content/platform/data_models/BalanceSheet.md +++ b/website/content/platform/data_models/BalanceSheet.md @@ -1,8 +1,31 @@ --- title: Balance Sheet -description: OpenBB Platform Data Model +description: This page provides comprehensive details on parameters and data for balance + sheets. It includes import statements, class names, and specific figures required + for data fetching from financial data providers 'standard', 'fmp', 'intrinio', and + 'polygon'. +keywords: +- balance sheet +- financial data +- OpenBB provider +- standard models +- Python +- financial data fetching +- data provider +- financial statement +- import statement +- class names +- parameters +- data +- fmp +- intrinio +- polygon --- +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; @@ -210,4 +233,3 @@ BalanceSheetQueryParams, - diff --git a/website/content/platform/data_models/BalanceSheetGrowth.md b/website/content/platform/data_models/BalanceSheetGrowth.md index e12145f096ed..6f01eacba0aa 100644 --- a/website/content/platform/data_models/BalanceSheetGrowth.md +++ b/website/content/platform/data_models/BalanceSheetGrowth.md @@ -1,8 +1,55 @@ --- title: Balance Sheet Statement Growth -description: OpenBB Platform Data Model +description: This documentation page provides detailed implementation guidelines for + `BalanceSheetGrowth` including class parameters, import statement, data entries + and much more. It it designed to make it easy even for beginners to understand and + work on `BalanceSheetGrowth`. +keywords: +- BalanceSheetGrowth +- BalanceSheetGrowthData +- BalanceSheetGrowthQueryParams +- import statement +- parameters +- data entries +- growth rate +- symbol +- limit +- provider +- date +- period +- cash and cash equivalents +- short-term investments +- net receivables +- inventory +- other current assets +- net property, plant, and equipment +- goodwill +- intangible assets +- long-term investments +- tax assets +- other non-current assets +- other assets +- accounts payable +- short-term debt +- tax payables +- deferred revenue +- long-term debt +- other current liabilities +- non-current liabilities +- common stock +- retained earnings +- accumulated other comprehensive income/loss +- total stockholders' equity +- total liabilities +- total investments +- total debt +- net debt --- +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; @@ -93,4 +140,3 @@ BalanceSheetGrowthQueryParams, - diff --git a/website/content/platform/data_models/CPI.md b/website/content/platform/data_models/CPI.md index ef0cbf6b2a31..14088d4d8e34 100644 --- a/website/content/platform/data_models/CPI.md +++ b/website/content/platform/data_models/CPI.md @@ -1,8 +1,33 @@ --- title: CPI -description: OpenBB Platform Data Model +description: Deep dive into the CPI implementation, model names, parameters, import + statements, and data values. Explore how we handle countries, frequency, units, + dates, harmonized data, and providers. +keywords: +- CPI +- CPIData +- CPIQueryParams +- parameters +- implementation details +- import statement +- data +- countries +- frequency +- units +- harmonized +- start date +- end date +- provider +- Python +- data class +- model name +- parameters class --- +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; @@ -57,4 +82,3 @@ CPIQueryParams, - diff --git a/website/content/platform/data_models/CashFlowStatement.md b/website/content/platform/data_models/CashFlowStatement.md index a3f77a698552..e0327916b59d 100644 --- a/website/content/platform/data_models/CashFlowStatement.md +++ b/website/content/platform/data_models/CashFlowStatement.md @@ -1,8 +1,30 @@ --- title: Cash Flow Statement -description: OpenBB Platform Data Model +description: This document helps understand how the standard models like CashFlowStatement, + CashFlowStatementQueryParams, and CashFlowStatementData are used to retrieve financial + data. It provides clear guidelines on how to use the query parameters to fetch data + from different finance data providers like fmp, intrinio, and polygon. +keywords: +- CashFlowStatement +- CashFlowStatementQueryParams +- CashFlowStatementData +- Docusaurus +- Python +- financial models +- economic data +- query parameters +- finance +- financial reporting +- financial data providers +- fmp +- intrinio +- polygon --- +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; @@ -186,4 +208,3 @@ CashFlowStatementQueryParams, - diff --git a/website/content/platform/data_models/CashFlowStatementGrowth.md b/website/content/platform/data_models/CashFlowStatementGrowth.md index 1869ded7fa1a..7806d9e93571 100644 --- a/website/content/platform/data_models/CashFlowStatementGrowth.md +++ b/website/content/platform/data_models/CashFlowStatementGrowth.md @@ -1,8 +1,25 @@ --- title: Cash Flow Statement Growth -description: OpenBB Platform Data Model +description: This page details the implementation and parameters related to Cash Flow + Statement Growth, including queries, data points, and related metrics. +keywords: +- Cash Flow Statement Growth +- financial data +- financial metrics +- financial growth +- API documentation +- financial data queries +- growth rate calculations +- financial market analysis +- financial programming +- openbb_provider +- financial data provider --- +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; @@ -84,4 +101,3 @@ CashFlowStatementGrowthQueryParams, - diff --git a/website/content/platform/data_models/CompanyFilings.md b/website/content/platform/data_models/CompanyFilings.md index d444e51418f0..26cb6ce1572b 100644 --- a/website/content/platform/data_models/CompanyFilings.md +++ b/website/content/platform/data_models/CompanyFilings.md @@ -1,8 +1,29 @@ --- title: Company Filings -description: OpenBB Platform Data Model +description: This page provides implementation details for the CompanyFilings class, + including models, import statement, parameters, and data. The parameters details + include fields such as symbol, limit, provider, type, and page. The data details + include fields such as date, type, link, symbol, cik, accepted_date, and final_link. +keywords: +- CompanyFilingsData +- CompanyFilingsQueryParams +- openbb_provider.standard_models.company_filings +- symbol +- limit +- provider +- type +- page +- date +- link +- cik +- accepted_date +- final_link --- +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; @@ -78,4 +99,3 @@ CompanyFilingsQueryParams, - diff --git a/website/content/platform/data_models/CompanyOverview.md b/website/content/platform/data_models/CompanyOverview.md index 099185743385..477a2576c736 100644 --- a/website/content/platform/data_models/CompanyOverview.md +++ b/website/content/platform/data_models/CompanyOverview.md @@ -1,8 +1,28 @@ --- title: Company Overview -description: OpenBB Platform Data Model +description: This page of our documentation provides detailed implementation details, + import statements, parameters, and data for the 'CompanyOverview' model used in + our application. This includes fields such as symbol, price, beta, company name, + currency, etc. Our API allows you to fetch extensive company overview data for various + companies. +keywords: +- Docusaurus +- SEO +- Company Overview +- Documentation +- Parameters +- API +- Data +- Implementation +- Python +- Model +- Marketing --- +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; @@ -86,4 +106,3 @@ CompanyOverviewQueryParams, - diff --git a/website/content/platform/data_models/CryptoHistorical.md b/website/content/platform/data_models/CryptoHistorical.md index 6b7dabb732c2..0d52af90f7fc 100644 --- a/website/content/platform/data_models/CryptoHistorical.md +++ b/website/content/platform/data_models/CryptoHistorical.md @@ -1,8 +1,38 @@ --- title: Crypto Historical Price -description: OpenBB Platform Data Model +description: Detailed documentation on Crypto Historical Data including model classes, + query parameters, and data. Information on import statements and tabulated data + for standard, fmp and polygon parameters are also provided. +keywords: +- CryptoHistorical +- CryptoHistoricalQueryParams +- CryptoHistoricalData +- openbb_provider.standard_models.crypto_historical +- symbol +- start_date +- end_date +- provider +- timeseries +- interval +- multiplier +- timespan +- sort +- limit +- adjusted +- date +- open +- high +- low +- close +- volume +- vwap +- transactions --- +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; @@ -119,4 +149,3 @@ CryptoHistoricalQueryParams, - diff --git a/website/content/platform/data_models/DividendCalendar.md b/website/content/platform/data_models/DividendCalendar.md index 812f70f159c4..bbaaa6b25b62 100644 --- a/website/content/platform/data_models/DividendCalendar.md +++ b/website/content/platform/data_models/DividendCalendar.md @@ -1,8 +1,37 @@ --- title: Dividend Calendar -description: OpenBB Platform Data Model +description: This documentation page provides comprehensive details on the implementation, + parameters and data for the DividendCalendar, DividendCalendarQueryParams, and DividendCalendarData + models from the openbb_provider's Python standard models. It includes a detailed + breakdown of parameter and data types such as start_date, end_date, provider, symbol, + dates, and dividends. +keywords: +- DividendCalendar +- DividendCalendarQueryParams +- DividendCalendarData +- parameters +- data class +- Python +- openbb_provider +- dividend +- provider +- start_date +- end_date +- fmp +- symbol +- date +- label +- adj_dividend +- dividend +- record_date +- payment_date +- declaration_date --- +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; @@ -59,4 +88,3 @@ DividendCalendarQueryParams, - diff --git a/website/content/platform/data_models/ESTR.md b/website/content/platform/data_models/ESTR.md index a0ea9221b86b..ad7df7cb4158 100644 --- a/website/content/platform/data_models/ESTR.md +++ b/website/content/platform/data_models/ESTR.md @@ -1,8 +1,34 @@ --- title: Euro Short-Term Rate -description: OpenBB Platform Data Model +description: Instructions on how to use the ESTR Query Parameters and Data Classes + in Python. Includes information on importing the classes, setting parameters and + interpreting the data. +keywords: +- ESTR +- query parameters +- data class +- Python +- import statement +- start date +- end date +- provider +- fred +- data interpretation +- volume weighted trimmed mean rate +- number of transactions +- number of active banks +- total volume +- share of volume of the 5 largest active banks +- rate at 75th percentile of volume +- rate at 25th percentile of volume +- rate +- date --- +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; @@ -63,4 +89,3 @@ ESTRQueryParams, - diff --git a/website/content/platform/data_models/EarningsCalendar.md b/website/content/platform/data_models/EarningsCalendar.md index e52404f8da5d..3d1f084caf49 100644 --- a/website/content/platform/data_models/EarningsCalendar.md +++ b/website/content/platform/data_models/EarningsCalendar.md @@ -1,8 +1,25 @@ --- title: Earnings Calendar -description: OpenBB Platform Data Model +description: This page provides detailed implementation of a financial Earnings Calendar + using the OpenBB Provider in Python. It covers model names, import statements, standard + parameters, and data types including EPS, revenue, and fiscal dates. +keywords: +- Earnings Calendar +- OpenBB Provider +- Data Models +- Query Parameters +- Estimated Earnings +- Revenue +- EPS +- Fiscal Date +- Python +- Coding --- +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; @@ -60,4 +77,3 @@ EarningsCalendarQueryParams, - diff --git a/website/content/platform/data_models/EarningsCallTranscript.md b/website/content/platform/data_models/EarningsCallTranscript.md index afef494eb3bf..11b7f3075ac8 100644 --- a/website/content/platform/data_models/EarningsCallTranscript.md +++ b/website/content/platform/data_models/EarningsCallTranscript.md @@ -1,8 +1,31 @@ --- title: Earnings Call Transcript -description: OpenBB Platform Data Model +description: This page describes the implementation of the Earnings Call Transcript + model in the OpenBB Provider library. It provides details about the Python import + statements, class names, parameters, and data associated with this model. This includes + the relevant parameters for querying financial data like symbol, year, and quarter, + and data fields such as content of the earnings call transcript. +keywords: +- Earnings Call Transcript +- EarningsCallTranscriptData +- EarningsCallTranscriptQueryParams +- OpenBB Provider +- FMP provider +- Python import statement +- Python standard models +- Data Query Params +- Financial data +- Financial Model +- Yearly earnings call transcript +- Quarterly earnings call transcript +- Earnings data +- Earnings data content --- +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; @@ -57,4 +80,3 @@ EarningsCallTranscriptQueryParams, - diff --git a/website/content/platform/data_models/ExecutiveCompensation.md b/website/content/platform/data_models/ExecutiveCompensation.md index 1b926082c3e7..827108a7fe4e 100644 --- a/website/content/platform/data_models/ExecutiveCompensation.md +++ b/website/content/platform/data_models/ExecutiveCompensation.md @@ -1,8 +1,47 @@ --- title: Executive Compensation -description: OpenBB Platform Data Model +description: This page provides detailed information about the 'Executive Compensation' + model that includes specific names, parameters, and data associated with it. The + content provides details of different executive compensations including salary, + bonuses, stock awards, and total compensation for specific company executives referenced + via symbols and Central Index Key (CIK). It defines the classes, import statement, + parameters and data specification. +keywords: +- Executive Compensation +- Python +- ExecutiveCompensationQueryParams +- ExecutiveCompensationData +- Implementation details +- Class names +- Data class +- Parameters class +- Model name +- Import Statement +- Parameters +- fmp +- CIK +- symbol +- provider +- Data +- salary +- bonus +- stock award +- incentive plan compensation +- total compensation +- filing date +- accepted date +- name and position +- year +- all other compensation +- url +- Tabs +- TabItem --- +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; @@ -63,4 +102,3 @@ ExecutiveCompensationQueryParams, - diff --git a/website/content/platform/data_models/FEDFUNDS.md b/website/content/platform/data_models/FEDFUNDS.md index 922f28d54476..4c404a0a1c9b 100644 --- a/website/content/platform/data_models/FEDFUNDS.md +++ b/website/content/platform/data_models/FEDFUNDS.md @@ -1,8 +1,26 @@ --- title: Fed Funds Rate -description: OpenBB Platform Data Model +description: This page provides detailed information on the implementation, parameters + and data associated with FEDFUNDS, including FEDFUNDSQueryParams and FEDFUNDSData. + Learn how to effectively use the FED rate and familiarize yourself with the Python + Import Statement. +keywords: +- FEDFUNDS +- FEDFUNDSQueryParams +- FEDFUNDSData +- FED rate +- Implementation details +- Python +- Import Statement +- Parameters +- Data +- Class names --- +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; @@ -63,4 +81,3 @@ FEDFUNDSQueryParams, - diff --git a/website/content/platform/data_models/FinancialRatios.md b/website/content/platform/data_models/FinancialRatios.md index 60f89ba72ca3..dc28cf6be508 100644 --- a/website/content/platform/data_models/FinancialRatios.md +++ b/website/content/platform/data_models/FinancialRatios.md @@ -1,8 +1,31 @@ --- title: Extensive set of ratios over time -description: OpenBB Platform Data Model +description: This documentation contains details about extracting financial ratios + data using FinancialRatiosData and FinancialRatiosQueryParams. Specific parameters + and data for standard and 'fmp' provider are provided. The import statement is also + included for ease of implementation. +keywords: +- Docusaurus SEO +- Financial Ratios +- FinancialRatiosData +- FinancialRatiosQueryParams +- financial data +- Python import +- Data parameters +- annual financial data +- quarter financial data +- fmp provider +- Standard financial data +- Financial data provider +- Financial ratios details +- Debt ratio +- Pretax profit margin --- +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; @@ -120,4 +143,3 @@ FinancialRatiosQueryParams, - diff --git a/website/content/platform/data_models/ForexHistorical.md b/website/content/platform/data_models/ForexHistorical.md index 9b2651db70de..768f1e64a8f4 100644 --- a/website/content/platform/data_models/ForexHistorical.md +++ b/website/content/platform/data_models/ForexHistorical.md @@ -1,8 +1,45 @@ --- title: Forex Historical Price -description: OpenBB Platform Data Model +description: This documentation presents implementation details and usage of Forex + Historical Data and Query Parameters class in Python. It provides an overview of + parameters and data attributes used for Forex Historical queries. The guide includes + specifics as per different providers such as Standard, FMP, and Polygon. +keywords: +- Forex Historical Data +- Python +- Forex Historical Query Parameters +- Data Class and Model +- Implementation Details +- Parameters +- Data +- Standard Models +- FMP +- Polygon +- Openbb Provider +- Symbol Pair +- Start date +- End date +- Provider +- Interval +- Multiplier +- Timespan +- Sort order +- Data Entries +- Adjusted Data +- Date +- Open Price +- High Price +- Low Price +- Close Price +- Volume +- VWAP +- Transactions --- +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; @@ -118,4 +155,3 @@ ForexHistoricalQueryParams, - diff --git a/website/content/platform/data_models/ForexPairs.md b/website/content/platform/data_models/ForexPairs.md index 6af24e1e64b3..0a8f05a91d4a 100644 --- a/website/content/platform/data_models/ForexPairs.md +++ b/website/content/platform/data_models/ForexPairs.md @@ -1,8 +1,39 @@ --- title: Forex Pairs -description: OpenBB Platform Data Model +description: This documentation page provides comprehensive details about how to use + the 'ForexPairs' models in our openbb_provider package, including parameter details, + import statements, and data models for standard, fmp, intrinio, and polygon forex + pairs. +keywords: +- OpenBB Provider +- ForexPairs +- API Documentation +- Python +- Forex Pairs Data models +- Standard +- FMP +- Intrinio +- Polygon +- Query Parameters +- Data classes +- Currency Pair +- Stock Exchange +- Exchange Words +- Currency Code +- ISO 4217 +- Currency Symbol +- Base Currency +- Quote Currency +- Trading Market +- Locale +- Updated Timestamp +- Delisted Timestamp --- +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; @@ -100,4 +131,3 @@ ForexPairsQueryParams, - diff --git a/website/content/platform/data_models/FredHistorical.md b/website/content/platform/data_models/FredHistorical.md index 905f3063e114..16e569b811bd 100644 --- a/website/content/platform/data_models/FredHistorical.md +++ b/website/content/platform/data_models/FredHistorical.md @@ -1,8 +1,29 @@ --- title: Fred Historical -description: OpenBB Platform Data Model +description: This page provides a detailed description of the FredHistorical data + model including its class names, import statement, parameters, and data structure. + This model is used for managing historical data with considerations for standard + or intrinio options. It covers various parameters like symbol, start_date, end_date, + limit, provider, next_page, and all_pages. +keywords: +- FredHistorical Data Model +- Openbb_Provider Standard Models +- Import Statement +- Data Class +- Query parameters +- Historical Data Handling +- Start Date +- End Date +- Data Limit +- Intrinio Provider +- Insights on Next Page +- Options for all_pages --- +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; @@ -68,4 +89,3 @@ FredHistoricalQueryParams, - diff --git a/website/content/platform/data_models/GlobalNews.md b/website/content/platform/data_models/GlobalNews.md index 6a14b69fbb03..df3453c785f2 100644 --- a/website/content/platform/data_models/GlobalNews.md +++ b/website/content/platform/data_models/GlobalNews.md @@ -1,8 +1,37 @@ --- title: Global News -description: OpenBB Platform Data Model +description: This page provides implementation details for retrieving global news + data using OpenBB provider models. Different parameters and datas are documented + for different news providers such as Benzinga, FMP, and Intrinio. Understanding + and using the parameters included here will allow for more efficient and targeted + news retrieval. +keywords: +- OpenBB +- Global News +- GlobalNewsData +- GlobalNewsQueryParams +- Python +- docusaurus +- Benzinga +- FMP +- Intrinio +- ISIN +- Cusip +- News parameters +- News retrieval +- News attributes +- Class names +- Import statement +- News providers +- News Data +- API +- Documentation --- +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; @@ -121,4 +150,3 @@ GlobalNewsQueryParams, - diff --git a/website/content/platform/data_models/HistoricalDividends.md b/website/content/platform/data_models/HistoricalDividends.md index d09d8d2ac456..cbb5162a24e3 100644 --- a/website/content/platform/data_models/HistoricalDividends.md +++ b/website/content/platform/data_models/HistoricalDividends.md @@ -1,8 +1,32 @@ --- title: Historical Dividends -description: OpenBB Platform Data Model +description: Documentation page about implementation details of historical dividends + in OpenBB Provider. The page dives into class names, import statement, parameters, + and data. +keywords: +- OpenBB Provider +- Historical Dividends +- Parameters +- Data +- Python +- Import Statement +- HistoricalDividendsQueryParams +- HistoricalDividendsData +- fmp provider +- Dividends +- Date +- Label +- Adj Dividend +- Dividend +- Record Date +- Payment Date +- Declaration Date --- +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; @@ -57,4 +81,3 @@ HistoricalDividendsQueryParams, - diff --git a/website/content/platform/data_models/HistoricalEmployees.md b/website/content/platform/data_models/HistoricalEmployees.md index 13b7a647fa3c..012f3e843047 100644 --- a/website/content/platform/data_models/HistoricalEmployees.md +++ b/website/content/platform/data_models/HistoricalEmployees.md @@ -1,8 +1,31 @@ --- title: Historical Employees -description: OpenBB Platform Data Model +description: Details on the implementation of HistoricalEmployees model including + class names, parameters information (such as symbol, provider), and data information + (like cik, acceptance_time, period_of_report, company_name, form_type, filing_date, + employee_count and source). +keywords: +- HistoricalEmployees +- HistoricalEmployeesData +- HistoricalEmployeesQueryParams +- Parameters +- Data +- symbol +- provider +- cik +- acceptance_time +- period_of_report +- company_name +- form_type +- filing_date +- employee_count +- source --- +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; @@ -59,4 +82,3 @@ HistoricalEmployeesQueryParams, - diff --git a/website/content/platform/data_models/HistoricalStockSplits.md b/website/content/platform/data_models/HistoricalStockSplits.md index eba0c565fa31..3369438b8c42 100644 --- a/website/content/platform/data_models/HistoricalStockSplits.md +++ b/website/content/platform/data_models/HistoricalStockSplits.md @@ -1,8 +1,27 @@ --- title: Historical Stock Splits -description: OpenBB Platform Data Model +description: This page provides implementation details for the HistoricalStockSplits + model, including descriptions and details for data class and query parameters. It + also includes the import statement required to fetch and display stock splits data + from a defined provider. +keywords: +- Historical Stock Splits +- OpenBB provider +- Stock Data Implementation +- Stock Splits Query Params +- Historical Stock Splits Data Class +- Stock Splits Parameters +- Stock Splits Data +- stock splits label +- stock splits numerator +- stock splits denominator +- stock data date --- +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; @@ -54,4 +73,3 @@ HistoricalStockSplitsQueryParams, - diff --git a/website/content/platform/data_models/IORB.md b/website/content/platform/data_models/IORB.md index 83c0d5587a0c..bc91ff77fd35 100644 --- a/website/content/platform/data_models/IORB.md +++ b/website/content/platform/data_models/IORB.md @@ -1,8 +1,26 @@ --- title: Interest on Reserve Balances -description: OpenBB Platform Data Model +description: This page provides detailed information about implementation and parameters + of IORB classes including IORB, IORBQueryParams, and IORBData and the way to import + them using Python. It also explains different parameters like start_date, end_date, + provider, and how to use them. +keywords: +- IORB +- IORBQueryParams +- IORBData +- Python +- Start_date +- End_date +- Provider +- fred +- Data +- Rate --- +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; @@ -53,4 +71,3 @@ IORBQueryParams, - diff --git a/website/content/platform/data_models/IncomeStatement.md b/website/content/platform/data_models/IncomeStatement.md index 03bdd873e52c..ac28b613369a 100644 --- a/website/content/platform/data_models/IncomeStatement.md +++ b/website/content/platform/data_models/IncomeStatement.md @@ -1,8 +1,36 @@ --- title: Income Statement -description: OpenBB Platform Data Model +description: This page provides comprehensive information about the implementation + of the IncomeStatement model, its parameters, data features, and details about its + use with different providers like FMP, Intrinio, and Polygon. It contains essential + items such as class names and import statements, standard, FMP, Intrinio, and Polygon + parameters, alongside the standard, FMP, and Polygon data parameters. +keywords: +- IncomeStatement model +- Finance +- SEO +- Class names +- Import Statements +- FMP +- Intrinio +- Polygon +- Python +- Documentation +- API +- Implementation details +- Parameters +- Data +- Standard +- Parameters class +- Data class +- IncomeStatementData +- IncomeStatementQueryParams --- +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; @@ -228,4 +256,3 @@ IncomeStatementQueryParams, - diff --git a/website/content/platform/data_models/IncomeStatementGrowth.md b/website/content/platform/data_models/IncomeStatementGrowth.md index 8cdde5382398..3afba726c16a 100644 --- a/website/content/platform/data_models/IncomeStatementGrowth.md +++ b/website/content/platform/data_models/IncomeStatementGrowth.md @@ -1,8 +1,30 @@ --- title: Income Statement Growth -description: OpenBB Platform Data Model +description: This page provides information about the Income Statement Growth class + in the openbb_provider standard models. It outlines the specific parameters and + their types for queries, as well as the returned data fields upon executing the + queries. +keywords: +- OpenBB Provider +- Standard Models +- Income Statement Growth +- Query Parameters +- Returned Data Fields +- Financial Data +- Growth Rate of Revenue +- Growth Rate of Expenses +- Earnings Per Share +- Diluted Earnings Per Share +- Income Before Taxes +- Net Income +- Operating Expenses +- Depreciation and Amortization Expenses --- +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; @@ -81,4 +103,3 @@ IncomeStatementGrowthQueryParams, - diff --git a/website/content/platform/data_models/InstitutionalOwnership.md b/website/content/platform/data_models/InstitutionalOwnership.md index a1ddcf29e2e7..ca9b79e84c11 100644 --- a/website/content/platform/data_models/InstitutionalOwnership.md +++ b/website/content/platform/data_models/InstitutionalOwnership.md @@ -1,8 +1,28 @@ --- title: Institutional Ownership -description: OpenBB Platform Data Model +description: Documentation for the Institutional Ownership model, its associated query + parameters, and data fields. Contains import details, parameter specifications, + and data field explanations, including investors holding, number of 13F shares, + total invested, and the change in ownership percent. +keywords: +- Docusaurus +- Marketing Strategy +- SEO +- Institutional Ownership +- Python +- OpenBB Provider +- Model Classes +- Data Representation +- Query Parameters +- 13F Shares +- Ownership Percent +- Investors Holding --- +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; @@ -88,4 +108,3 @@ InstitutionalOwnershipQueryParams, - diff --git a/website/content/platform/data_models/KeyExecutives.md b/website/content/platform/data_models/KeyExecutives.md index 3c58f3665796..5052ea3598f9 100644 --- a/website/content/platform/data_models/KeyExecutives.md +++ b/website/content/platform/data_models/KeyExecutives.md @@ -1,8 +1,28 @@ --- title: Key Executives -description: OpenBB Platform Data Model +description: This page provides detailed information on how to use the KeyExecutives + model in openbb_provider, including parameter specifications and the data structure. +keywords: +- KeyExecutives +- openbb_provider +- KeyExecutivesQueryParams +- KeyExecutivesData +- Symbol +- Provider +- Fmp +- Parameters +- Data +- Python +- Standard models +- Gender +- Title +- Query --- +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; @@ -57,4 +77,3 @@ KeyExecutivesQueryParams, - diff --git a/website/content/platform/data_models/KeyMetrics.md b/website/content/platform/data_models/KeyMetrics.md index e7e9b34292fc..e7b910b1f835 100644 --- a/website/content/platform/data_models/KeyMetrics.md +++ b/website/content/platform/data_models/KeyMetrics.md @@ -1,8 +1,48 @@ --- title: Key Metrics -description: OpenBB Platform Data Model +description: A documentation page for the OpenBB Provider KeyMetrics with class details, + parameters for both standard and fmp data, and the import statement. The classes + include KeyMetricsData and KeyMetricsQueryParams, and the metrics reported include + everything from basic revenue per share, net income per share, to more detailed + metrics like return on invested capital (ROIC), return on equity (ROE), and many + others. +keywords: +- OpenBB Provider +- Key Metrics +- KeyMetricsData +- KeyMetricsQueryParams +- Python +- Docusaurus +- Implementation Details +- Parameters +- Data +- class names +- import statement +- Tabs +- TabItem +- standard +- fmp +- symbol +- data +- return +- limit +- provider +- ttm +- roic +- return on invested capital +- roe +- return on equity +- graham number +- stock-based compensation to revenue +- enterprise value to EBITDA +- debt to equity ratio +- net debt to EBITDA --- +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; @@ -190,4 +230,3 @@ KeyMetricsQueryParams, - diff --git a/website/content/platform/data_models/MajorIndicesConstituents.md b/website/content/platform/data_models/MajorIndicesConstituents.md index f478e4faea47..96ec4f2ce170 100644 --- a/website/content/platform/data_models/MajorIndicesConstituents.md +++ b/website/content/platform/data_models/MajorIndicesConstituents.md @@ -1,8 +1,29 @@ --- title: Major Indices Constituents -description: OpenBB Platform Data Model +description: This documentation page provides details about the implementation of + MajorIndicesConstituents, including parameters and data classes. It describes how + to retrieve information about the companies listed on major indices. +keywords: +- implementation +- major indices constituents +- parameters +- data +- index +- standard_models +- sector +- provider +- constituent company +- sub-sector +- headquarter +- date first added +- central index key +- founded --- +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; @@ -58,4 +79,3 @@ MajorIndicesConstituentsQueryParams, - diff --git a/website/content/platform/data_models/MajorIndicesHistorical.md b/website/content/platform/data_models/MajorIndicesHistorical.md index bc00cb7c994a..208fd33d7996 100644 --- a/website/content/platform/data_models/MajorIndicesHistorical.md +++ b/website/content/platform/data_models/MajorIndicesHistorical.md @@ -1,8 +1,37 @@ --- title: Major Indices Historical -description: OpenBB Platform Data Model +description: This is a documentation page for major indices historical data. It outlines + details on how to import and use the MajorIndicesHistoricalData and MajorIndicesHistoricalQueryParams + classes in Python, with detailed explanations on parameters and data. +keywords: +- major indices historical data +- openbb provider +- python +- data class +- parameters class +- query parameters +- symbol +- start date +- end date +- provider +- timeseries +- interval +- timespan +- sort +- limit +- adjusted +- multiplier +- open price +- close price +- high price +- low price +- volume --- +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; @@ -116,4 +145,3 @@ MajorIndicesHistoricalQueryParams, - diff --git a/website/content/platform/data_models/OptionsChains.md b/website/content/platform/data_models/OptionsChains.md index f0438fcc7f0b..074b4ef8f264 100644 --- a/website/content/platform/data_models/OptionsChains.md +++ b/website/content/platform/data_models/OptionsChains.md @@ -1,8 +1,40 @@ --- title: Get the complete options chain for a ticker -description: OpenBB Platform Data Model +description: This documentation page details the implementation of OptionsChains, + including class names, import statements, parameters, and data. It explains various + aspects such as contract symbols, expiration dates, strike prices and more. This + resource is especially beneficial for users interested in options trading data and + how to query them using the openbb_provider python package. +keywords: +- OptionsChains +- OptionsChainsQueryParams +- OptionsChainsData +- parameters +- data +- contract symbol +- symbol +- expiration date +- strike price +- call or put +- class names +- implementation details +- python +- openbb_provider +- intrinio +- date +- provider +- open interest +- implied volatility +- delta +- gamma +- theta +- vega --- +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; @@ -85,4 +117,3 @@ OptionsChainsQueryParams, - diff --git a/website/content/platform/data_models/PROJECTIONS.md b/website/content/platform/data_models/PROJECTIONS.md index 283c38f717fd..32c204adfa75 100644 --- a/website/content/platform/data_models/PROJECTIONS.md +++ b/website/content/platform/data_models/PROJECTIONS.md @@ -1,8 +1,27 @@ --- title: Fed Funds Rate Projections -description: OpenBB Platform Data Model +description: This page provides implementation details and descriptions of parameters + and data for the PROJECTIONS feature on our website. Discover how to use queries + using 'fred' as the provider, understand data projections, and get to grips with + different types of rates. +keywords: +- projections +- implementation +- query parameters +- data class +- fred provider +- data projections +- high projection rates +- central tendency rates +- median projection rates +- midpoint projections +- low projection rates --- +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; @@ -65,4 +84,3 @@ PROJECTIONSQueryParams, - diff --git a/website/content/platform/data_models/PriceTarget.md b/website/content/platform/data_models/PriceTarget.md index 16544429f630..bd2e88a851f4 100644 --- a/website/content/platform/data_models/PriceTarget.md +++ b/website/content/platform/data_models/PriceTarget.md @@ -1,8 +1,23 @@ --- title: Price Target -description: OpenBB Platform Data Model +description: This page provides implementation details and parameters for the PriceTarget + model in the OpenBB Provider. You can also find import statements and data parameters + for Standard and FMP solutions. +keywords: +- OpenBB Provider API +- PriceTarget +- Python +- Standard +- FMP +- Implementation details +- Data Parameters +- Class Names --- +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; @@ -90,4 +105,3 @@ PriceTargetQueryParams, - diff --git a/website/content/platform/data_models/PriceTargetConsensus.md b/website/content/platform/data_models/PriceTargetConsensus.md index 5a6518f1bffa..5bc94a606639 100644 --- a/website/content/platform/data_models/PriceTargetConsensus.md +++ b/website/content/platform/data_models/PriceTargetConsensus.md @@ -1,8 +1,31 @@ --- title: Price Target Consensus -description: OpenBB Platform Data Model +description: Documentation for the implementation of PriceTargetConsensus including + class names, parameters, and data details with their types and descriptions. +keywords: +- Implementation details +- Class names +- Import Statement +- Parameters +- Data +- Tabs +- TabItem +- PriceTargetConsensus +- PriceTargetConsensusQueryParams +- PriceTargetConsensusData +- Symbol +- Provider +- fmp +- Target_high +- Target_low +- Target_consensus +- Target_median --- +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; @@ -55,4 +78,3 @@ PriceTargetConsensusQueryParams, - diff --git a/website/content/platform/data_models/RevenueBusinessLine.md b/website/content/platform/data_models/RevenueBusinessLine.md index 1f2c5241c78a..cc824cbdd586 100644 --- a/website/content/platform/data_models/RevenueBusinessLine.md +++ b/website/content/platform/data_models/RevenueBusinessLine.md @@ -1,8 +1,23 @@ --- title: Revenue Business Line -description: OpenBB Platform Data Model +description: The page includes implementation details of 'RevenueBusinessLine', 'RevenueBusinessLineQueryParams' + and 'RevenueBusinessLineData' classes from 'openbb_provider.standard_models.revenue_business_line'. + It also provides comprehensive details on related parameters and software data. +keywords: +- RevenueBusinessLine +- RevenueBusinessLineQueryParams +- RevenueBusinessLineData +- openbb_provider.standard_models.revenue_business_line +- Docusaurus page metadata +- Software implementation details +- Software parameters +- Software data --- +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; @@ -54,4 +69,3 @@ RevenueBusinessLineQueryParams, - diff --git a/website/content/platform/data_models/RevenueGeographic.md b/website/content/platform/data_models/RevenueGeographic.md index f9c59e832514..fec2d21475f5 100644 --- a/website/content/platform/data_models/RevenueGeographic.md +++ b/website/content/platform/data_models/RevenueGeographic.md @@ -1,8 +1,24 @@ --- title: Revenue Geographic -description: OpenBB Platform Data Model +description: This page provides implementation details and parameters related to the + RevenueGeographic data model. This includes parameters for querying data, the data + structure, provider options, as well as data output details about global revenue + distribution. +keywords: +- RevenueGeographic +- RevenueGeographicQueryParams +- RevenueGeographicData +- data model +- implementation details +- revenue distribution +- parameters +- geographic segment data --- +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; @@ -59,4 +75,3 @@ RevenueGeographicQueryParams, - diff --git a/website/content/platform/data_models/RiskPremium.md b/website/content/platform/data_models/RiskPremium.md index ab9b057ab619..7b243bf9c6b1 100644 --- a/website/content/platform/data_models/RiskPremium.md +++ b/website/content/platform/data_models/RiskPremium.md @@ -1,8 +1,31 @@ --- title: Market Risk Premium -description: OpenBB Platform Data Model +description: This page provides technical documentation on the implementation of the + 'RiskPremium' class with parameters and data attributes. It involves understanding + Python syntax and detailed explanation of each attribute. +keywords: +- Docusaurus +- Metadata +- SEO +- Risk +- Premium +- Implementation +- Python +- Parameters +- Data +- Class names +- Query +- Country +- Continent +- Market +- Equity +- FMP --- +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; @@ -53,4 +76,3 @@ RiskPremiumQueryParams, - diff --git a/website/content/platform/data_models/SOFR.md b/website/content/platform/data_models/SOFR.md index 104385288a50..3582857042cf 100644 --- a/website/content/platform/data_models/SOFR.md +++ b/website/content/platform/data_models/SOFR.md @@ -1,8 +1,25 @@ --- title: Secured Overnight Financing Rate -description: OpenBB Platform Data Model +description: This page provides implementation details for SOFR rates. It contains + code snippets to import the related classes, the parameters and data details. It + is organized in tabs, separating 'standard' and 'fred' information. +keywords: +- SOFR +- SOFRData +- SOFRQueryParams +- Python +- code snippets +- implementation details +- parameters +- data +- fred +- standard --- +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; @@ -63,4 +80,3 @@ SOFRQueryParams, - diff --git a/website/content/platform/data_models/SONIA.md b/website/content/platform/data_models/SONIA.md index a26da978308e..ec71960523b9 100644 --- a/website/content/platform/data_models/SONIA.md +++ b/website/content/platform/data_models/SONIA.md @@ -1,8 +1,28 @@ --- title: Sterling Overnight Index Average -description: OpenBB Platform Data Model +description: This page provides detailed information on the implementation of the + SONIA model, its parameters, data structure and how to use it. It includes class + names, import statements and parameter options. +keywords: +- SONIA +- Implementation details +- Import Statement +- Parameters +- Data +- Model name +- Parameters class +- Data class +- start_date +- end_date +- provider +- date +- rate --- +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; @@ -63,4 +83,3 @@ SONIAQueryParams, - diff --git a/website/content/platform/data_models/ShareStatistics.md b/website/content/platform/data_models/ShareStatistics.md index e18d6d5a3ebc..3e36856df33b 100644 --- a/website/content/platform/data_models/ShareStatistics.md +++ b/website/content/platform/data_models/ShareStatistics.md @@ -1,8 +1,23 @@ --- title: Share Statistics -description: OpenBB Platform Data Model +description: This page provides detailed implementation methods for ShareStatistics. + It includes parameters and data involved, such as symbol, provider, date, and shares + data. +keywords: +- ShareStatistics +- symbol +- provider +- date +- free_float +- float_shares +- outstanding_shares +- source --- +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; @@ -56,4 +71,3 @@ ShareStatisticsQueryParams, - diff --git a/website/content/platform/data_models/StockHistorical.md b/website/content/platform/data_models/StockHistorical.md index d81f81c747ec..d0da263a9650 100644 --- a/website/content/platform/data_models/StockHistorical.md +++ b/website/content/platform/data_models/StockHistorical.md @@ -1,8 +1,33 @@ --- title: Stock Historical price -description: OpenBB Platform Data Model +description: This is a detailed documentation page on how to fetch historical stock + data using openbb_provider library in Python. It provides implementation details, + parameters to be passed and data it returns for 'fmp', 'intrinio', 'polygon' stock + data providers. It also provides import statements and example class names. +keywords: +- openbb_provider +- Python +- historical stock data +- data fetching +- fmp +- intrinio +- polygon +- implementation +- parameters +- stock data provider +- class names +- import statement +- documentation +- SEO +- marketing +- keywords +- description --- +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; @@ -151,4 +176,3 @@ StockHistoricalQueryParams, - diff --git a/website/content/platform/data_models/StockInsiderTrading.md b/website/content/platform/data_models/StockInsiderTrading.md index 72eca4a85190..994f263f06d4 100644 --- a/website/content/platform/data_models/StockInsiderTrading.md +++ b/website/content/platform/data_models/StockInsiderTrading.md @@ -1,8 +1,32 @@ --- title: Stock Insider Trading -description: OpenBB Platform Data Model +description: This page provides in-depth details about Stock Insider Trading including + data classes, parameters and structure. The content is a part of the official documentation + for the OpenBB Provider Standard Models. +keywords: +- Docusaurus +- SEO +- Metadata +- Stock Insider Trading +- StockInsiderTradingData +- StockInsiderTradingQueryParams +- Symbol +- Transaction Type +- Filing Date +- Reporting CIK +- Securities Owned +- Type of Owner +- Acquisition or Disposition +- Securities Transacted +- Security Name +- Price +- Link --- +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; @@ -67,4 +91,3 @@ StockInsiderTradingQueryParams, - diff --git a/website/content/platform/data_models/StockMultiples.md b/website/content/platform/data_models/StockMultiples.md index 2b1921371217..36337ac155f0 100644 --- a/website/content/platform/data_models/StockMultiples.md +++ b/website/content/platform/data_models/StockMultiples.md @@ -1,8 +1,29 @@ --- title: Stock Multiples -description: OpenBB Platform Data Model +description: This page provides detailed information on the implementation of the + StockMultiples class including the names of the parameters and data classes, lists + of the parameters and the data with their types and descriptions. The page also + includes an import statement for granularity when building different applications. +keywords: +- StockMultiples +- StockMultiplesQueryParams +- StockMultiplesData +- OpenBB Provider +- Implementation Details +- Python +- SEO +- SEO Marketing +- Docusaurus +- Parameters +- Data +- Financial Data +- Trailing Twelve Months --- +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; @@ -111,4 +132,3 @@ StockMultiplesQueryParams, - diff --git a/website/content/platform/data_models/StockNews.md b/website/content/platform/data_models/StockNews.md index 95302cb17df5..716370e03bdd 100644 --- a/website/content/platform/data_models/StockNews.md +++ b/website/content/platform/data_models/StockNews.md @@ -1,8 +1,28 @@ --- title: Stock News -description: OpenBB Platform Data Model +description: This page provides a detailed overview of using the 'StockNewsData' and + 'StockNewsQueryParams' classes in the OpenBB provider to fetch stock-related news. + It describes variable parameters, default values, and variations across different + news providers. It also outlines the data structure returned from each provider. +keywords: +- OpenBB provider +- Stock News +- Benzinga +- FMP +- Intrinio +- Polygon +- StockNewsData +- StockNewsQueryParams +- Metadata +- SEO +- news providers +- stock market data --- +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; @@ -152,4 +172,3 @@ StockNewsQueryParams, - diff --git a/website/content/platform/data_models/StockOwnership.md b/website/content/platform/data_models/StockOwnership.md index 642592a683ae..379842608d05 100644 --- a/website/content/platform/data_models/StockOwnership.md +++ b/website/content/platform/data_models/StockOwnership.md @@ -1,8 +1,33 @@ --- title: Stock Ownership -description: OpenBB Platform Data Model +description: This site provides detailed information on implementation and parameters + for Stock Ownership data models. It covers attributes such as symbol, date, provider, + investor name, security name, type of security, shares type, and more. +keywords: +- Stock Ownership +- Stock Ownership Data +- Stock Ownership Query Params +- Security attributes +- Investor Name +- Security Name +- Shares Number +- Type of Security +- Performance +- Market Value +- Change in Market Value +- Ownership +- Holding Period +- Change in Performance +- Provider +- Parameters +- Implementation Details +- Data Models --- +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; @@ -91,4 +116,3 @@ StockOwnershipQueryParams, - diff --git a/website/content/platform/data_models/StockPeers.md b/website/content/platform/data_models/StockPeers.md index 3a682d342731..2dd49b84371d 100644 --- a/website/content/platform/data_models/StockPeers.md +++ b/website/content/platform/data_models/StockPeers.md @@ -1,8 +1,25 @@ --- title: Stock Peers -description: OpenBB Platform Data Model +description: The documentation gives an overview about the 'StockPeers', 'StockPeersData' + and 'StockPeersQueryParams' of openbb_provider package. It elaborates the parameters + such as 'symbol' and 'provider', and provides details about the types and functions + of the 'stock_peers' class. +keywords: +- StockPeers +- stock_peers +- StockPeersData +- StockPeersQueryParams +- symbol +- provider +- fmp +- peers_list +- openbb_provider --- +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; @@ -52,4 +69,3 @@ StockPeersQueryParams, - diff --git a/website/content/platform/data_models/StockQuote.md b/website/content/platform/data_models/StockQuote.md index 1c4825b7c4b3..d2a76dd62b9d 100644 --- a/website/content/platform/data_models/StockQuote.md +++ b/website/content/platform/data_models/StockQuote.md @@ -1,8 +1,47 @@ --- title: Stock Quote -description: OpenBB Platform Data Model +description: An informative Python module documentation on obtaining stock quote data + using the openbb_provider library. The page details the class names, parameters, + and data fetched, demonstrating variability depending on chosen data provider ('fmp' + or 'intrinio'). +keywords: +- StockQuote +- StockQuoteQueryParams +- StockQuoteData +- python +- openbb_provider +- stock data +- documentation +- implementation details +- parameters +- data +- class names +- import statement +- stock quote +- trading details +- trading volume +- stock price +- stock symbols +- provider +- source +- market cap +- price avg50 +- price avg200 +- volume +- avg volume +- exchange +- eps +- pe ratio +- earnings announcement +- shares outstanding +- intrinio +- fmp --- +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; @@ -121,4 +160,3 @@ StockQuoteQueryParams, - diff --git a/website/content/platform/data_models/StockSplitCalendar.md b/website/content/platform/data_models/StockSplitCalendar.md index e942475cc08b..c7a6c114b575 100644 --- a/website/content/platform/data_models/StockSplitCalendar.md +++ b/website/content/platform/data_models/StockSplitCalendar.md @@ -1,8 +1,33 @@ --- title: Stock Split Calendar -description: OpenBB Platform Data Model +description: Documentation regarding StockSplitCalendarData, StockSplitCalendarQueryParams + classes by openbb_provider. The page includes implementation details, parameters, + data, and usage explanations for stock splits in Python. +keywords: +- StockSplitCalendar +- StockSplitCalendarQueryParams +- StockSplitCalendarData +- openbb_provider +- python +- class +- parameters +- data +- stock splits +- start_date +- end_date +- provider +- fmp +- date +- label +- symbol +- numerator +- denominator --- +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; @@ -56,4 +81,3 @@ StockSplitCalendarQueryParams, - diff --git a/website/content/platform/data_models/TreasuryRates.md b/website/content/platform/data_models/TreasuryRates.md index d3c9b6898cb3..13ad3e9286ce 100644 --- a/website/content/platform/data_models/TreasuryRates.md +++ b/website/content/platform/data_models/TreasuryRates.md @@ -1,8 +1,37 @@ --- title: Treasury Rates -description: OpenBB Platform Data Model +description: Documentation on how to use the TreasuryRates model within our software. + Explains how to import the necessary classes and define parameters and data. +keywords: +- TreasuryRates +- TreasuryRatesQueryParams +- TreasuryRatesData +- start_date +- end_date +- provider +- date +- month_1 +- month_2 +- month_3 +- month_6 +- year_1 +- year_2 +- year_3 +- year_5 +- year_7 +- year_10 +- year_20 +- year_30 +- treasury rate +- financial data +- data query +- import classes --- +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; @@ -64,4 +93,3 @@ TreasuryRatesQueryParams, - diff --git a/website/content/platform/data_models/USYieldCurve.md b/website/content/platform/data_models/USYieldCurve.md index e101fae05cc8..ecfe80b81b73 100644 --- a/website/content/platform/data_models/USYieldCurve.md +++ b/website/content/platform/data_models/USYieldCurve.md @@ -1,8 +1,33 @@ --- title: US Yield Curve -description: OpenBB Platform Data Model +description: This page provides detailed implementation information for the USYieldCurve + model, including parameters, data class, and import statements. It primarily explores + the use of the 'fred' provider, the maturity and rate of the treasury, and getting + inflation-adjusted rates. +keywords: +- USYieldCurve +- USYieldCurveData +- USYieldCurveQueryParams +- Parameters +- Data +- fred +- inflation adjusted rates +- maturity +- treasury rate +- maturity of the treasury rate +- associated rate +- Implementation details +- model name +- parameters class +- data class +- import statement +- Python --- +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; @@ -53,4 +78,3 @@ USYieldCurveQueryParams, - diff --git a/website/content/platform/data_models/_category_.json b/website/content/platform/data_models/_category_.json new file mode 100644 index 000000000000..ca5edad8bd8e --- /dev/null +++ b/website/content/platform/data_models/_category_.json @@ -0,0 +1,4 @@ +{ + "label": "Data Models", + "position": 4 +} diff --git a/website/content/platform/data_models/index.mdx b/website/content/platform/data_models/index.mdx deleted file mode 100644 index 4a176b85be4c..000000000000 --- a/website/content/platform/data_models/index.mdx +++ /dev/null @@ -1,324 +0,0 @@ -# Data Models - -import ReferenceCard from "@site/src/components/General/ReferenceCard"; - -
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
diff --git a/website/content/platform/faqs/_category_.json b/website/content/platform/faqs/_category_.json index 6c26249e6048..e4157c1e437d 100644 --- a/website/content/platform/faqs/_category_.json +++ b/website/content/platform/faqs/_category_.json @@ -1,4 +1,4 @@ { "label": "FAQs", - "position": 4 + "position": 8 } diff --git a/website/content/platform/faqs/bugs_support_feedback.md b/website/content/platform/faqs/bugs_support_feedback.md deleted file mode 100644 index 8dc47ebe54ed..000000000000 --- a/website/content/platform/faqs/bugs_support_feedback.md +++ /dev/null @@ -1,66 +0,0 @@ ---- -title: Bugs, Support, and Feedback -sidebar_position: 6 -description: Submit a bug report or support ticket. -keywords: - [ - installation, - installer, - install, - guide, - mac, - windows, - linux, - python, - github, - macos, - how to, - explanation, - openbb sdk, - sdk - ] ---- - -import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - - - -## Bugs, Support, and Feedback - -When an error is encountered, it is always a good idea to check the open issues on [GitHub](https://github.com/OpenBB-finance/OpenBBTerminal/issues). There may be a workaround solution for the specific problem until a patch is released. - -
How often are patches for bugs released? - -The installer versions are packaged approximately every two-weeks. Those working with a cloned GitHub version can checkout the Develop branch to get the latest fixes and releases before they are pushed to the main branch. - -```console -git checkout develop -``` - -
- -
How do I report a bug? - -First, search the open issues for another report. If one already exists, attach any relevant information and screenshots as a comment. If one does not exist, start one with this [link](https://github.com/OpenBB-finance/OpenBBTerminal/issues/new?assignees=&labels=type%3Abug&template=bug_report.md&title=%5BBug%5D) - -
- -
How can I get help with OpenBB Terminal? - -You can get help with OpenBB Terminal by joining our [Discord server](https://openbb.co/discord) or contact us in our support form [here](https://openbb.co/support). - -
- -
How can I give feedback about the OpenBB Terminal, or request specific functionality? - -Being an open source platform that wishes to tailor to the needs of any type of investor, we highly encourage anyone to share with us their experience and/or how we can further improve the OpenBB Terminal. This can be anything from a very small bug, a new feature, or the implementation of a highly advanced Machine Learning model. - -You are able to directly send us information about a bug or a question/suggestion from inside the terminal by using the `support` command which is available everywhere in the terminal. Here you can select which command you want to report a bug on, ask a question or make a suggestion. After entering `support`, when you press `ENTER` (⏎), you are taken to the Support form which is automatically filled with your input. You are only required to include the type (e.g. bug, suggestion or question) and message in the form, although this can also be set directly from inside the terminal (see `support -h`). - -Alternatively, you can contact us via the following routes: - -- If you notice that a feature is missing inside the terminal, please fill in the [Request a Feature](https://openbb.co/request-a-feature) form. -- If you wish to report a bug, have a question/suggestion or anything else, please fill in the [Support](https://openbb.co/support) form. -- If you wish to speak to us directly, please contact us on [Discord](https://openbb.co/discord). - -
diff --git a/website/content/platform/faqs/data_sources.md b/website/content/platform/faqs/data_sources.md deleted file mode 100644 index 77890fbeef3c..000000000000 --- a/website/content/platform/faqs/data_sources.md +++ /dev/null @@ -1,80 +0,0 @@ ---- -title: Data and Sources -sidebar_position: 4 -description: Information about data sources and providers offered through the OpenBB Platform. -keywords: - [ - installation, - installer, - install, - guide, - mac, - windows, - linux, - python, - github, - macos, - how to, - explanation, - openbb sdk, - data, - data provider, - india, - binance - ] ---- -import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - - - -## Data and Sources - -Please note that OpenBB does not provide any data, it is an aggregator which provides users access to data from a variety of sources. OpenBB does not maintain or have any control over the raw data supplied. If there is a specific problem with the output from a data provider, please consider contacting them first. - -
Is there a list of all data providers? - -The complete list is found [here](https://docs.openbb.co/terminal/usage/guides/api-keys) - -
- -
How do I load a ticker symbol from India? - -Ticker symbols listed on exchanges outside of the US will have a suffix attached, for example, Rico Auto Industries Limited: - -```console -df = openbb.stocks.load("ricoauto.ns") -``` - -The precise naming convention will differ by source, reference each source's own documentation for specific details. - -
- -
Data from today is missing. - -By default, the load function requests end-of-day daily data and is not included until the EOD summary has been published. The current day's data is considered intraday and is loaded when the `interval` argument is present. - -```console -df = openbb.stocks.load(SPY, interval = 60) -``` - -
- -
Can I stream live prices and news feeds? - -It is not currently possible to stream live feeds with the OpenBB Platform. - -
- -
"Pair BTC/USDT not found in binance" - -US-based users are currently unable to access the Binance API. Please try loading the pair from a different source, for example: - -`load btc --source CCXT --exchange kraken` - -
- -
How can I request adding endpoints from a specific data source? - -Please [request a feature](https://openbb.co/request-a-feature) by submitting a new request. - -
diff --git a/website/content/platform/faqs/developer_issues.md b/website/content/platform/faqs/developer_issues.md deleted file mode 100644 index ab28fae63728..000000000000 --- a/website/content/platform/faqs/developer_issues.md +++ /dev/null @@ -1,180 +0,0 @@ ---- -title: Developer Issues -sidebar_position: 7 -description: Help with issues commonly faced by developers. -keywords: - [ - installation, - installer, - install, - guide, - mac, - windows, - linux, - python, - github, - macos, - how to, - explanation, - openbb sdk, - error, - branch, - VS Code, - .whl - ] ---- - -import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - - - -## Developer Issues - -
How do I launch in debug mode? - -The PyWry window can be run in debug mode for identifying specific issues. Use the code block below - with the `obb` Python environment active - to import the OpenBB Platform in debug mode. - -```python -import os -from openbb_terminal.core.plots.backend import plots_backend - -os.environ["DEBUG_MODE"] = "True" -plots_backend().start(True) - -from openbb_terminal.sdk import openbb -``` - -The charts and tables will now include a developer tools button, located at the top-left of the window. - -
- -
What branch on GitHub should pull requests be submitted to? - -Pull requests submitted to the Main branch will not be merged, please create branches from the `develop` branch. - -To switch to the develop branch: - -```console -git checkout develop -``` - -Branches must also follow the naming convention: - -- /feature/name_your_branch - - For developing functionality. -- /hotfix/name_your_patch - - For bug patches. - -
- -
Error: "git pull" fails because of a hot fix: cannot lock ref - -If the error message looks something like: - -```console -cannot lock ref: 'refs/remotes/origin/hotfix' exists; cannot create -``` - -Try: - -```console -git remote prune origin -git pull -``` - -
- -
What does it mean if it says wheel is missing? - -If you receive any notifications regarding `wheel` missing, this could be due to this dependency missing. - -`conda install -c conda-forge wheel` or `pip install wheel` - -
- -
Why do these .whl files not exist? - -If you get errors about .whl files not existing (usually on Windows) you have to reinitialize the following folder. -Just removing the 'artifacts' folder could also be enough: - -| Platform | Location | -| -------- | ------------------------------- | -| Linux | "~/.cache/pypoetry" | -| Mac | "~/Library/Caches/pypoetry" | -| Windows | "%localappdata%/pypoetry/cache" | - -When you try to add a package to Poetry it is possible that it causes a similar issue. Here you can remove the -'artifacts' folder again to reinitialize Poetry. - -If you run into trouble with Poetry, and the advice above did not help, your best bet is to try - -- `poetry update --lock` -- `conda deactivate` -> `conda activate obb`, then try again -- Track down the offensive package and purge it from your anaconda `` folder, then try again - -| Platform | Location | -| --------- | ------------------------------------------- | -| Linux/Mac | ~/anaconda3/envs, or , ~/opt/anaconda3/envs | -| Windows | %userprofile%/anaconda3/envs | - -- Completely nuke your conda environment folder and make a new environment from scratch - - - `conda deactivate` - - `conda env remove -n obb` - - `conda clean -a` - - Make a new environment and install dependencies again. -- Reboot your computer and try again -- Submit a ticket on GitHub - -
- -
What does the JSONDecodeError mean during poetry install? - -Sometimes poetry can throw a `JSONDecodeError` on random packages while running `poetry install`. This can be observed on macOS 10.14+ running python 3.8+. This is because of the use of an experimental installer that can be switched off to avoid the mentioned error. Run the code below as advised [here](https://github.com/python-poetry/poetry/issues/4210) and it should fix the installation process. - -```bash -poetry config experimental.new-installer false -``` - -_Commands that may help you in case of an error:_ - -- `python -m pip install --upgrade pip` -- `poetry update --lock` -- `poetry install` - -
- -
How do I deal with errors regarding CRLF? - -When trying to commit code changes, pylint will prevent you from doing so if your line break settings are set to -CRLF (default for Windows). -This is because the entire package uses LF (default for Linux/Mac), and it is therefore -important that you change this setting to LF _before_ you make any changes to the code. - -It is possible that CRLF automatically turns back on, you can correct this with: - -```bash -git config --global core.autocrlf false -``` - -In case you already made coding adjustments, you have to reset your cache, and the changes you made to the code with -the following: - -```bash -git rm --cached -r . -git reset --hard -``` - -
- -
Why can't I run OpenBB via the VS Code integrated terminal? - -This occurs when VS Code terminal python version/path is different from the terminal version. - -To fix it add this to vscode JSON settings ([ref](https://stackoverflow.com/questions/54582361/vscode-terminal-shows-incorrect-python-version-and-path-launching-terminal-from)): - -```bash - "terminal.integrated.inheritEnv": false, -``` - -
diff --git a/website/content/platform/faqs/general_operation.md b/website/content/platform/faqs/general_operation.md deleted file mode 100644 index a3d947f3d4cb..000000000000 --- a/website/content/platform/faqs/general_operation.md +++ /dev/null @@ -1,120 +0,0 @@ ---- -title: General Operation -sidebar_position: 3 -description: General operation and troubleshooting for the OpenBB Platform. -keywords: - [ - installation, - installer, - install, - guide, - mac, - windows, - linux, - python, - github, - macos, - how to, - explanation, - openbb sdk, - developer, - OS, - BranchCache, - Hyper-V, - VcXsrv, - code block - ] ---- - -import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - - - -Both Windows and MacOS provide a "developer mode", and enabling it may help to overcome system-related issues. - -**MacOS**: Go to the System Settings, and under the "Privacy and Security" tab, scroll to the bottom and select the option to "Allow applications downloaded from App Store and identified developers". Then, scroll up to click on, "Developer Tools", and add `Terminal.app` and `Visual Studio Code` (or the preferred code editor) to the list of applications allowed to run software locally that does not meet the system's security policy. - -**Windows**: Go to the Control Panel, and under the "Privacy & Security" tab, click on, "For developers". Under this menu, turn "Developer Mode" on. - -From the Windows Security menu, click on the Firewall & Network Protection tab, then click on "Allow an app through firewall". If the applications below are not allowed to communicate through Windows Defender Firewall, change the settings to allow. - -- BranchCache -- Hyper-V -- VcXsrv -- Windows Terminal - -
An example code block does not work. - -We try to keep example code up-to-date, but sometimes a specific example is left behind. Please submit a bug report and so that we are aware of the issue. Submit a bug report [here](https://openbb.co/support) - -
- -
Why does a specific menu or command not exist? - -It could be that you are running an outdated version in which the menu or command is not yet available. Please check the [installation guide](https://my.openbb.co/app/sdk/installation) to download the most recent release. - -Do note that it is also possible that the menu or command has been deprecated. If this is oversight, please reach out to us [here](https://openbb.co/support). - -
- -
What is the correct format for entering dates to function variables? - -Dates should be entered as a string variable, inside of quotation marks, formatted as `%Y-%m-%d` - YYYY-MM-DD. - -
- -
Does the portfolio menu allow for dividends, interest, or other distributions? - -Currently, this is only possible by manually updating the portfolio file. - -
- -
Why does my Portfolio file fail to load? - -This can be the result of a formatting error, check the file in a simple text editor to observe any abnormalities in the formatting; or, it could be a bug - check the [GitHub issues page](https://github.com/OpenBB-finance/OpenBBTerminal/issues) for similar errors. - -- Check that all the necessary column titles are present. -- Inspect the file to see if cells left blank have been filled unintentionally with 0 or NaN values. -- A particular asset may not be able to load data. Check for valid historical data from the Stocks menu. -- Format ticker symbols according to yFinance naming convention. -- All dates must be entered as YYYY-MM-DD. -- Transactions dated for today will fail to load historical data. -- MacOS users should attempt to avoid using the Numbers application as it has a habit of changing the formatting while saving. - -Files can be formatted as either `.csv` or `.xlsx` files, and the required column headers are: - -`[Date,Type,Ticker,Side,Price,Quantity,Fees,Investment,Currency,Sector,Industry,Country,Region]` - -See the guide [here](https://docs.openbb.co/sdk/guides/intros/portfolio) for more information. - -
- -
How do I change the chart styles? - -Place style sheets in this folder: `OpenBBUserData/styles/user` - -To select the light themes: - -```python -from openbb_terminal.sdk import TerminalStyle -theme = TerminalStyle("light", "light", "light") -``` - -To select the dark themes: - -```python -from openbb_terminal.sdk import TerminalStyle -theme = TerminalStyle("dark", "dark", "dark") -``` - -
- -
Where are the included stock screener presets located? - -The files are located in the folder with the code, under: - -`~/openbb_terminal/miscellaneous/stocks/screener` - -Alternatively, the source code on GitHub is [here](https://github.com/OpenBB-finance/OpenBBTerminal/tree/develop/openbb_terminal/miscellaneous/stocks/screener) - -
diff --git a/website/content/platform/faqs/import_errors.md b/website/content/platform/faqs/import_errors.md deleted file mode 100644 index a8573633a761..000000000000 --- a/website/content/platform/faqs/import_errors.md +++ /dev/null @@ -1,96 +0,0 @@ ---- -title: Import Errors -sidebar_position: 2 -description: Troubleshoot common issues with import errors in the OpenBB Platform. -keywords: - [ - installation, - installer, - install, - guide, - mac, - windows, - linux, - python, - github, - macos, - how to, - explanation, - openbb sdk, - import error, - error, - ssl certificate, - proxy connection, - modulenotfounderror, - no module named, - ] ---- - -import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - - - -## Import Errors - -When packages not included in the OpenBB installation are installed to the same environment as the Platform, it is possible that an incompatible build of a specific library (like SciPy) has overwritten the existing and creating a conflict. In this event, try creating a new environment containing only the OpenBB dependencies. - -
ModuleNotFoundError: No module named '______' - -Before troubleshooting please verify that the recommended installation instructions were followed. These errors often can occur when the virtual environment has not been activated, or the `poetry install` command was skipped. Activate the OpenBB virtual environment created during the installation process prior to launching or importing the Platform. - -**Terminal**: - -```console -conda activate obb -python terminal.py -``` - -**Platform**: - -```console -conda activate obb -ipython -from openbb_terminal.sdk import openbb -``` - -**Jupyter**: - -Check that the kernel selected for the session is the OpenBB virtual environment created during the installation process and then re-run the cell. - -```console -from openbb_terminal.sdk import openbb -``` - -There is also a possibility that a new dependency has been added to the code and it has not yet been installed in the environment. This may happen after updating the code from GitHub, but before running the `poetry install` install command. - -```console -poetry install -E all -``` - -
- -
SSL certificates fail to authorize - -```console -SSL: CERTIFICATE_VERIFY_FAILED -``` - -An error message, similar to above, is usually encountered while attempting to use the OpenBB Platform from behind a firewall. A workplace environment is typically the most common occurrence. Try connecting to the internet directly through a home network to test the connection. If using a work computer and/or network, we recommend speaking with the company's IT department prior to installing or running any software. - -A potential solution is to try: - -```console -pip install pip-system-certs -``` - -
- -
Cannot connect due to proxy connection. - -Find the `.env` file (located at the root of the user account folder: (`~/.openbb_terminal/.env`), and add a line at the bottom of the file with: - -```console -HTTP_PROXY="
" or HTTPS_PROXY="
” -``` - -
diff --git a/website/content/platform/faqs/index.md b/website/content/platform/faqs/index.md index 9a6b6ecea611..a4778c9d08a1 100644 --- a/website/content/platform/faqs/index.md +++ b/website/content/platform/faqs/index.md @@ -1,60 +1,31 @@ --- title: FAQs sidebar_position: 1 -description: Frequently Asked Questions about the OpenBB Platform +description: Discover how to deal with installations, updates, import errors, and + general operation. Learn more about data sources and how to handle bugs, support + and various developer issues. keywords: - [ - faqs, - questions, - troubleshooting, - answers, - installation, - updates, - general operation, - data sources, - bug, - support, - feedback, - developer issues, - issue, - ] +- Installation +- Updates +- Import errors +- General operation +- Data and sources +- Bugs support +- Feedback +- Developer issues +- LinkCard component --- import LinkCard from "@site/src/components/General/LinkCard"; - - - - - - +## Installation and Updates + +## Import errors + +## General Operation + +## Data and Sources + +## Bugs, Support and Feedback + +## Developer Issues diff --git a/website/content/platform/faqs/installation_updates.md b/website/content/platform/faqs/installation_updates.md deleted file mode 100644 index 6e5329532f2d..000000000000 --- a/website/content/platform/faqs/installation_updates.md +++ /dev/null @@ -1,125 +0,0 @@ ---- -title: Installation and Updates -sidebar_position: 1 -description: Installation and Updates to the OpenBB Platform. -keywords: - [ - installation, - installer, - install, - guide, - mac, - windows, - linux, - python, - github, - macos, - how to, - explanation, - openbb sdk, - pypi, - miniconda, - library, - C++, - library, - error - ] ---- - -import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - - - -## Installation and Updates - -
"Microsoft Visual C++ 14.0 or greater is required" - -Download and install [C++ Build Tools](https://visualstudio.microsoft.com/visual-cpp-build-tools/), restart the machine, then try again. - -![image](https://github.com/OpenBB-finance/OpenBBTerminal/assets/85772166/ceb57be0-6dae-42f2-aca6-bf62ce7d6135) - -![image](https://github.com/OpenBB-finance/OpenBBTerminal/assets/85772166/f8aef8fc-a080-4164-bd36-460714ec44f3) - -
- -
Do I have to use Miniconda? - -There are certain dependencies which are sourced exclusively from the `conda-forge` directory. Other virtual environment managers, such a `venv`, may not solve the environment properly, resulting in failed package installations or incorrect builds. We highly recommend using Miniconda as the Python virtual environment manager for installing the OpenBB Platform. - -
- -
How do I update my installation to the latest version? - -The code is constantly being updated with new features and bug fixes. The process for updating will vary by the installation type: - -- For a `pip` installation, when a new version is published: `pip install -U openbb[all]` -- Upgrade a cloned version of the GitHub repo with: - -```console -git fetch -git pull -poetry install -E all -``` - -**Notes:** If the cloned repository is a fork, pull from: `git pull origin main`, or, `git pull origin develop`. If there are changes locally to the files that conflict with the incoming changes from GitHub, stash them before pulling from main with `git stash`. - -
- -### PyPi Nightly - -The nightly build can be installed with: - -```console -pip install openbb-terminal-nightly[all] -``` - -**Note**: This version may not be stable and should not be used in a production setting. - -
"Microsoft Visual C++ 14.0 or greater is required" - -Download and install [C++ Build Tools](https://visualstudio.microsoft.com/visual-cpp-build-tools/), restart the machine, then try again. - -
- -
Error: failed building wheel for bt - -There may be an additional message that is printed from this error, stating: "Microsoft Visual C++ 14.0 or greater is required. Get it with "Microsoft C++ Build Tools". - -Download and install it. [https://visualstudio.microsoft.com/visual-cpp-build-tools/](https://visualstudio.microsoft.com/visual-cpp-build-tools/) - -Mac and Linux users may also encounter a similar error because a C++ compiler is not installed. Install Homebrew: - -```console -/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)" -``` - -Then run: - -```console -brew install gcc -brew install cmake -``` - -Additionally, Mac users should install Rosetta: - -```console -softwareupdate --install-rosetta -``` - -
- -
Miniconda3 will not install on ARM/Linux Raspberry Pi machines. - -Refer to this issue on the Conda [GitHub](https://github.com/conda/conda/issues/10723) page. - -
- -
Error: Library not loaded: '/usr/local/opt/libomp/lib/libomp.dylib' - -This error is resolved by installing libomp from Homebrew: - -```console -brew install libomp -``` - -
diff --git a/website/content/platform/index.md b/website/content/platform/index.md index b024d2a2e0b6..0ed11fcbaf6f 100644 --- a/website/content/platform/index.md +++ b/website/content/platform/index.md @@ -1,76 +1,27 @@ --- -sidebar_position: 1 +title: Introduction +sidebar_position: 0 +description: Introduction to OpenBB Platform; a convenient and powerful tool that + provides pre-built data connectors and libraries to design and build financial reports + and applications. Learn more about contributing to the platform. keywords: - [ - getting started, - openbb, - api, - beginner guide, - how to use openbb, - openbb keys, - openbb terminal, - introduction, - intro, - how-to, - how to, - openbb, - sdk, - learn, - guide, - data, - financial data, - analysis, - open source, - visualization, - dashboard, - report, - custom, - jupyter, - jupyter notebook - ] -description: The OpenBB Documentation provides guidance on how to use the OpenBB Platform, a free, custom built financial Platform that will help you make more informed decisions, faster. +- OpenBB Platform +- investment research infrastructure +- data connectors +- financial reports +- OpenBB team +- third-party data providers +- CONTRIBUTING GUIDELINES --- -import Card from "@site/src/components/General/Card"; + -# OpenBB Platform +OpenBB Platform is created and maintained by the OpenBB team together with the contributions from hundreds of community members. This gives us an unrivaled speed of development and the ability to maintain stable integrations with numerous third-party data providers. -OpenBB Platform gives you direct and programmatic access to all capabilities from OpenBB Terminal. You will have the necessary building blocks to create your own financial tools and applications, whether that be a visualization dashboard or a custom report on Jupyter Notebook. +Developing and maintaining a full-blown investment research infrastructure from the ground up takes a lot of time and effort. However, it does not have to be this way. By taking advantage of OpenBB Platform with its out-of-the-box data connectors and library of extensions, you can focus on designing and building your financial reports and applications. -With OpenBB Platform, you can gain access to normalized financial data from dozens of data providers, without having to develop your own integrations from scratch. On top of financial data feeds, OpenBB Platform also provides you with a toolbox to perform financial analysis on a variety of asset classes, including stocks, crypto, ETFs, funds, and the economy as well as portfolio optimization and attribution. - -OpenBB Platform is created and maintained by the OpenBB team together with the contributions from hundreds of community members. This gives us an unrivaled speed of development and the ability to maintain stable integrations with numerous third-party data providers. Developing and maintaining a full-blown investment research infrastructure from the ground up takes a lot of time and effort. However, it does not have to be this way. By taking advantage of OpenBB Platform with its out-of-the-box data connectors and financial analysis toolkit, now you can focus on designing and building your financial reports and applications. - ---- - - - - +sdk --- -### Getting Started - -To know more about OpenBB Platform, you can start by reading the [Installation Guide](https://docs.openbb.co/platform/installation). - -### Using OpenBB Platform - -To learn how to use OpenBB Platform, you can start by reading the [Basics Guide](https://docs.openbb.co/platform/usage/basics). - -### Platform Reference - -Platform Reference is a complete list of all functions available in OpenBB Platform. It is automatically generated and updated every time a new version of OpenBB Platform is released. It can be found [here](https://docs.openbb.co/platform/reference). - -### Showcase - -OpenBB Platform is used by many financial analysts, data scientists, and developers to build financial applications and reports. Here are some examples of what you can do with OpenBB Platform: [Showcase](https://docs.openbb.co/platform/showcase). +Want to contribute? Check out our [CONTRIBUTING GUIDELINES](https://github.com/OpenBB-finance/OpenBBTerminal/blob/main/CONTRIBUTING.md). diff --git a/website/content/platform/installation.md b/website/content/platform/installation.md index 6213a6569289..0510e8db61ff 100644 --- a/website/content/platform/installation.md +++ b/website/content/platform/installation.md @@ -1,16 +1,226 @@ --- title: Installation sidebar_position: 1 -description: The OpenBB Platform provides programmatic access to all Terminal functions. This layer of code allows users to build their own tools and applications on top of the existing architecture. Follow these steps to install on a local machine. -keywords: [installation, installer, install, guide, mac, windows, linux, python, github, macos, how to, explanation, openbb, sdk, api, pip, pypi,] +description: This page presents the general system requirements, supported environments, + installation procedures, and setup for running the OpenBB Platform. It discusses + the prerequisites including Python version, operating system requirements, Docker + usage, and the process of building the platform from source. +keywords: +- OpenBB Platform +- Python +- System requirements +- Supported environments +- Installation +- Docker +- Python virtual environment +- Installation from source +- Windows 10 +- Mac OS Big Sur +- Linux +- Package installation +- VS Code +- PyCharm +- Jupyter +- GitHub +- Conda +- venv +- API +- Repository +- pip +- Poetry +- Toml +- PyPI +- Node.js +- npm --- import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - + -The OpenBB Platform provides programmatic access to all Terminal functions and much more. This layer of code allows users to build their own tools and applications on top of the existing architecture. +## General System Requirements + +Most systems capable of running Python 3.8-3.11 will be compatible with the OpenBB Platform. A modern processor (five years or less), running an up-to-date operating system, with at least 4GB of RAM, is recommended. Maintaining the system with current patches ensures maximum compatibility. At a minimum, Windows and macOS should be: + +- Windows 10 +- Mac OS Big Sur + +Linux users should run the command line update for the package manager, prior to installation. + +## Supported Environments + +The OpenBB Platform is installed within a Python virtual environment. It is compatible with versions of Python between 3.8 and 3.11, inclusively. The method for creating the environment will be a matter of user preference, from the command line - [Conda](https://docs.conda.io/projects/miniconda/en/latest/miniconda-install.html), [venv](https://docs.python.org/3/library/venv.html), [Docker](https://hub.docker.com/), etc. - or in a code editor and IDE - [VS Code](https://code.visualstudio.com/docs/languages/python), [PyCharm](https://www.jetbrains.com/pycharm/), [Jupyter](https://jupyter.org/). + +[Docker](/platform/installation#docker) builds the environment during the installation process, skip ahead to the specific section [below](/platform/installation#docker). + +For those new to Python, [this article](https://www.infoworld.com/article/3306656/python-virtualenv-and-venv-dos-and-donts.html) shares some tips on getting started and why environments are important. + +See [this guide](https://code.visualstudio.com/docs/python/environments) for creating a Python environment in VS Code. + +With the container created, and activated, begin the installation process. + +## Installation + +Before installation, update the package manager so that `pip` is current, then create the environment with the desired version of Python and install the following packages: + +:::note +Installing packages directly to the system Python or `base` environment is not recommended. Create a new environment. +::: + +```console +pip install poetry toml +``` + +### PyPI + +Install from PyPI with: + +```console +pip install openbb==4.0.0a4 +``` + +:::note +While still under active development, the version number is required to install the core OpenBB Platform. +::: + +To install all of the extensions and providers: + +```console +pip install openbb[all]==4.0.0a4 +``` + +To install a single extension: + +```console +pip install openbb[charting]==4.0.0a4 +``` + +```console +pip install openbb[ta]==4.0.0a4 +``` + +Import the package with: + +```console +from openbb import obb +``` + +### Docker + +OpenBB supplies a `.dockerfile` on [GitHub](https://github.com/OpenBB-finance/OpenBBTerminal). + +Run the following command from the repo root to build the image: + +```bash +docker build -f build/docker/api.dockerfile -t openbb-platform:latest . +``` + +To run it: + +```bash +docker run --rm -p 8000:8000 -v ~/.openbb_platform:/root/.openbb_platform openbb-platform:latest +``` + +This will mount the local `~/.openbb_platform` directory into the Docker container to use with the API keys and preferences from there, and it will expose the API on port `8000`. + +### Source + +To build the OpenBB Platform from the source code, first install `git`: + +```console +pip install git +``` + +Next, clone the repository from GitHub: + +```console +git clone git@github.com:OpenBB-finance/OpenBBTerminal.git +``` + +When it is done, checkout the branch where the code is living: + +```console +git checkout feature/openbb-sdk-v4 +``` + +Then, `cd` into the directory: + +```console +cd openbb_platform +``` + +Finally, run the developer installation script: + +```console +python dev_install.py +``` :::note -The OpenBB Platform is a part of the OpenBB Terminal when installed via [source code](/terminal/installation/source) or [PyPI](/terminal/installation/pypi). +To install all extensions and providers, run: `python dev_install.py -e` ::: + +With a fresh installation, or upon installing or uninstalling extensions, the Python interface needs to be built. This is done automatically, but can be manually triggered if required. Start a Python session and then `import openbb`: + +```console +python + +import openbb + +exit() +``` + +To manually trigger the build: + +```python +import openbb +openbb.build() +``` + +Restart the Python interpreter and then begin using the OpenBB Platform. + +```python +from openbb import obb +``` + +Start the REST API with: + +```console +uvicorn openbb_core.api.rest_api:app --host 0.0.0.0 --port 8000 --reload +``` + +## Documentation + +The documentation and packages are kept in the `/website` folder, at the base of the repository. Navigate there to install the dependencies and start the development server. + +#### Node.js + +- [Node.js](https://nodejs.org/en/) >= 16.13.0 + To check if Node.js installed, run this command: + +```bash +node --version # should be v16.13.0 or higher +``` + +#### Install Dependencies + +```bash +npm install +``` + +#### Start Development Server + +```bash +npm start +``` + +This starts a local development server at: [http://localhost:3000](http://localhost:3000) + +Most changes are reflected live without having to restart the server. + +#### Build + +```bash +npm run build +``` + +This command generates static content into the `build` directory and can be served using any static contents hosting service. OpenBB uses Github Pages to host our website, it's deployed in the `gh-pages` branch. diff --git a/website/content/platform/reference/ca/index.mdx b/website/content/platform/reference/ca/index.mdx deleted file mode 100644 index ac5d7a47cc8b..000000000000 --- a/website/content/platform/reference/ca/index.mdx +++ /dev/null @@ -1,12 +0,0 @@ -# ca - -import ReferenceCard from "@site/src/components/General/ReferenceCard"; - -
    - -
diff --git a/website/content/platform/reference/ca/peers.md b/website/content/platform/reference/ca/peers.md index 236523511d7e..ab04b437e5b6 100644 --- a/website/content/platform/reference/ca/peers.md +++ b/website/content/platform/reference/ca/peers.md @@ -1,13 +1,28 @@ --- title: peers -description: OpenBB Platform Function +description: This documentation page provides detailed information about stock peers + including the market sector, exchange and market cap. The data is provided by the + 'fmp' provider and includes metadata about the command execution. +keywords: +- stock market +- stock peers +- finance +- fmp +- data provider +- stock metadata +- symbol +- market sector +- market cap +- exchange --- +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; -# peers - Stock Peers. Company peers. ```python wordwrap @@ -65,4 +80,3 @@ OBBject - diff --git a/website/content/platform/reference/crypto/index.mdx b/website/content/platform/reference/crypto/index.mdx deleted file mode 100644 index 2531ae6539ae..000000000000 --- a/website/content/platform/reference/crypto/index.mdx +++ /dev/null @@ -1,12 +0,0 @@ -# crypto - -import ReferenceCard from "@site/src/components/General/ReferenceCard"; - -
    - -
diff --git a/website/content/platform/reference/crypto/load.md b/website/content/platform/reference/crypto/load.md index cf9c0681d46e..ff67d1eeac8d 100644 --- a/website/content/platform/reference/crypto/load.md +++ b/website/content/platform/reference/crypto/load.md @@ -1,13 +1,44 @@ --- title: load -description: OpenBB Platform Function +description: This page provides comprehensive data about Crypto Historical Price where + users can load cryptocurrency historical price data, including symbol, provider, + date, and timespan. It features different options for data providers such as fmp + and polygon. Users can modify the data request according to the parameters given, + including timeseries, interval, multiplier, timespan, sort, and limit. The page + also outlines the data that will be returned, such as open, high, low, close, volume, + vwap, and for specific providers additional data like transactions. +keywords: +- Crypto Historical Price +- cryptocurrency +- data +- fmp +- polygon +- symbol +- date +- provider +- timeseries +- interval +- multiplier +- timespan +- sort +- limit +- adjusted +- open +- high +- low +- close +- volume +- vwap +- transactions --- +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; -# load - Crypto Historical Price. Cryptocurrency historical price data. ```python wordwrap @@ -132,4 +163,3 @@ OBBject - diff --git a/website/content/platform/reference/economy/available_indices.md b/website/content/platform/reference/economy/available_indices.md index 01dba4bdc6fd..8f59b7ba88f3 100644 --- a/website/content/platform/reference/economy/available_indices.md +++ b/website/content/platform/reference/economy/available_indices.md @@ -1,13 +1,27 @@ --- title: available_indices -description: OpenBB Platform Function +description: Documentation page explains 'Available Indices' including standard and + FMP parameters, wherein details such as index name, currency, the stock exchange + they are listed on, and detailed metadata about command execution are discussed. +keywords: +- Available Indices +- Provider Query +- FMP +- Index Name +- Index Currency +- Stock Exchange +- Exchange Short Name +- Metadata +- Command Execution --- +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; -# available_indices - Available Indices. Available indices for a given provider. ```python wordwrap @@ -74,4 +88,3 @@ OBBject - diff --git a/website/content/platform/reference/economy/const.md b/website/content/platform/reference/economy/const.md index 0cbbec65abd7..2b0b4cfa2ea2 100644 --- a/website/content/platform/reference/economy/const.md +++ b/website/content/platform/reference/economy/const.md @@ -1,13 +1,34 @@ --- title: const -description: OpenBB Platform Function +description: This documentation is about fetching the list of major index constituents + including details like the constituent's name, sector, sub-sector, headquarter location, + date of addition to index, Central Index Key (CIK), and the founding year. +keywords: +- major index +- major indices constituents +- index constituents +- index details +- fetch index data +- data provider +- nasdaq +- sp500 +- dowjones +- symbol +- sector +- sub-sector +- headquarter location +- date of addition to index +- Central Index Key (CIK) +- founding year --- +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; -# const - Major Indices Constituents. Constituents of an index. ```python wordwrap @@ -71,4 +92,3 @@ OBBject - diff --git a/website/content/platform/reference/economy/cpi.md b/website/content/platform/reference/economy/cpi.md index ba4e135c85e7..dbdb981b06a0 100644 --- a/website/content/platform/reference/economy/cpi.md +++ b/website/content/platform/reference/economy/cpi.md @@ -1,13 +1,37 @@ --- title: cpi -description: OpenBB Platform Function +description: This page offers detailed API documentation for retrieving Consumer Price + Index (CPI) from various countries using the Python 'cpi' function. The function + parameters, return objects and corresponding data fields are thoroughly explained. +keywords: +- cpi +- Consumer Price Index +- python wordwrap +- parameters +- countries +- units +- frequency +- harmonized +- start_date +- end_date +- provider +- returns +- results +- warnings +- chart +- metadata +- data +- date +- value --- +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; -# cpi - CPI. Consumer Price Index. ```python wordwrap @@ -70,4 +94,3 @@ OBBject - diff --git a/website/content/platform/reference/economy/fred_index.md b/website/content/platform/reference/economy/fred_index.md index cb62f9f57a7b..5a2121ab1d9a 100644 --- a/website/content/platform/reference/economy/fred_index.md +++ b/website/content/platform/reference/economy/fred_index.md @@ -1,13 +1,29 @@ --- title: fred_index -description: OpenBB Platform Function +description: Documentation about Fred Historical function, a feature to retrieve historical + close values for selected Fred indices. The page contains detailed parameters description + and data structure including the provider, date range, limit, and symbol for data + retrieval. +keywords: +- Fred Historical +- Fred indices +- Data retrieval +- Data API +- start_date +- end_date +- limit +- provider +- intrinio +- symbol --- +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; -# fred_index - Fred Historical. Historical close values for selected Fred indices. ```python wordwrap @@ -81,4 +97,3 @@ OBBject - diff --git a/website/content/platform/reference/economy/index.mdx b/website/content/platform/reference/economy/index.mdx deleted file mode 100644 index 3ff8571b16bf..000000000000 --- a/website/content/platform/reference/economy/index.mdx +++ /dev/null @@ -1,42 +0,0 @@ -# economy - -import ReferenceCard from "@site/src/components/General/ReferenceCard"; - -
    - - - - - - -
diff --git a/website/content/platform/reference/economy/index_cmd.md b/website/content/platform/reference/economy/index_cmd.md index cd57a371e93e..7f757b552080 100644 --- a/website/content/platform/reference/economy/index_cmd.md +++ b/website/content/platform/reference/economy/index_cmd.md @@ -1,13 +1,29 @@ --- title: index -description: OpenBB Platform Function +description: Docusaurus page detailing how to retrieve historical index data using + Python. Explains various parameters such as symbol, start date, end date, provider + to use for the query, and various provider-specific options. +keywords: +- Docusaurus +- Historical index data +- Python +- Parameters +- Symbol +- Start date +- End date +- Provider +- fmp +- polygon +- Data retrieval --- +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; -# index - Major Indices Historical. Historical levels for an index. ```python wordwrap @@ -129,4 +145,3 @@ OBBject - diff --git a/website/content/platform/reference/economy/risk.md b/website/content/platform/reference/economy/risk.md index a292d955237d..abe3f7954bbf 100644 --- a/website/content/platform/reference/economy/risk.md +++ b/website/content/platform/reference/economy/risk.md @@ -1,13 +1,29 @@ --- title: risk -description: OpenBB Platform Function +description: This page provides detailed information about the calculation of market + risk premium including its historical data. It includes parameters for provider + selection, returns comprising of results, provider name, warning lists, chart object, + and metadata. Also, it provides a data section explaining the country and continental + data and their respective risk premiums. +keywords: +- market risk premium +- historical market risk premium +- risk parameters +- provider selection +- warning list +- chart object +- continental data +- country-specific risk premium +- metadata information --- +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; -# risk - Market Risk Premium. Historical market risk premium. ```python wordwrap @@ -66,4 +82,3 @@ OBBject - diff --git a/website/content/platform/reference/fa/balance.md b/website/content/platform/reference/fa/balance.md index 2101572e9a4d..d308e28e43cd 100644 --- a/website/content/platform/reference/fa/balance.md +++ b/website/content/platform/reference/fa/balance.md @@ -1,13 +1,41 @@ --- title: balance -description: OpenBB Platform Function +description: The balance page provides a comprehensive guide on how to obtain information + about a company's balance sheet. It offers various parameters you can use to fetch + data from different providers like FMP, Intrinio, or Polygon. The documentation + is detailed, offering full information about returns, data types, defaults, and + optional parameters. +keywords: +- balance sheet +- financial data +- parameters +- data providers +- FMP +- Intrinio +- Polygon +- symbol +- period +- CIK +- type +- year +- company name +- SIC +- filing date +- report date +- sources +- order +- sort +- Docusaurus page optimization +- SEO for Docusaurus --- +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; -# balance - Balance Sheet. Balance sheet statement. ```python wordwrap @@ -223,4 +251,3 @@ OBBject - diff --git a/website/content/platform/reference/fa/balance_growth.md b/website/content/platform/reference/fa/balance_growth.md index a33e6fbbd9e5..23d08df93462 100644 --- a/website/content/platform/reference/fa/balance_growth.md +++ b/website/content/platform/reference/fa/balance_growth.md @@ -1,13 +1,68 @@ --- title: balance_growth -description: OpenBB Platform Function +description: This page is about the function 'balance_growth' which provides information + about the growth of company balance sheets. It mentions the parameters and returns + associated with the function, as well as specific data points and their descriptions + related to balance sheet growth. +keywords: +- balance_growth +- Union[str, List[str]] +- fmp +- symbol +- limit +- provider +- BalanceSheetGrowth +- List[Warning_] +- Chart +- Metadata +- growth_cash_and_cash_equivalents +- growth_short_term_investments +- growth_cash_and_short_term_investments +- growth_net_receivables +- growth_inventory +- growth_other_current_assets +- growth_total_current_assets +- growth_property_plant_equipment_net +- growth_goodwill +- growth_intangible_assets +- growth_goodwill_and_intangible_assets +- growth_long_term_investments +- growth_tax_assets +- growth_other_non_current_assets +- growth_total_non_current_assets +- growth_other_assets +- growth_total_assets +- growth_account_payables +- growth_short_term_debt +- growth_tax_payables +- growth_deferred_revenue +- growth_other_current_liabilities +- growth_total_current_liabilities +- growth_long_term_debt +- growth_deferred_revenue_non_current +- growth_deferrred_tax_liabilities_non_current +- growth_other_non_current_liabilities +- growth_total_non_current_liabilities +- growth_other_liabilities +- growth_total_liabilities +- growth_common_stock +- growth_retained_earnings +- growth_accumulated_other_comprehensive_income_loss +- growth_othertotal_stockholders_equity +- growth_total_stockholders_equity +- growth_total_liabilities_and_stockholders_equity +- growth_total_investments +- growth_total_debt +- growth_net_debt --- +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; -# balance_growth - Balance Sheet Statement Growth. Information about the growth of the company balance sheet. ```python wordwrap @@ -106,4 +161,3 @@ OBBject - diff --git a/website/content/platform/reference/fa/cal.md b/website/content/platform/reference/fa/cal.md index 0aa75b8f355b..4b82b095088f 100644 --- a/website/content/platform/reference/fa/cal.md +++ b/website/content/platform/reference/fa/cal.md @@ -1,13 +1,34 @@ --- title: cal -description: OpenBB Platform Function +description: This is a guide to using the 'cal' function to display a dividend calendar + between a range of start and end dates. It provides full details of parameters, + return values, and data labels. +keywords: +- Dividend calendar +- Cal Function +- Python +- Data +- Start date +- End date +- Provider +- Results +- Chart +- Metadata +- Symbol +- Adjusted Dividend +- Dividend amount +- Record date +- Payment date +- Declaration date --- +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; -# cal - Dividend Calendar. Show Dividend Calendar for a given start and end dates. ```python wordwrap @@ -72,4 +93,3 @@ OBBject - diff --git a/website/content/platform/reference/fa/cash.md b/website/content/platform/reference/fa/cash.md index cb8f2252cdb8..401c12ac973a 100644 --- a/website/content/platform/reference/fa/cash.md +++ b/website/content/platform/reference/fa/cash.md @@ -1,13 +1,31 @@ --- title: cash -description: OpenBB Platform Function +description: This is a docusaurus page about the Cash Flow Statement API. Here you + can find information about parameters and data returns from popular providers such + as FMP, Intrinio, and Polygon. The page explains the procedures for fetching financial + data and conditions attached to each data provider. +keywords: +- Docusaurus +- Cash Flow Statement +- Data Fetching +- Provider Parameters +- Financial Data +- FMP +- Intrinio +- Polygon +- Data Returns +- Financial Statements +- Metadata Information +- Financial Analytics --- +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; -# cash - Cash Flow Statement. Information about the cash flow statement. ```python wordwrap @@ -199,4 +217,3 @@ OBBject - diff --git a/website/content/platform/reference/fa/cash_growth.md b/website/content/platform/reference/fa/cash_growth.md index 0dda2d7e71af..c6939ea8b455 100644 --- a/website/content/platform/reference/fa/cash_growth.md +++ b/website/content/platform/reference/fa/cash_growth.md @@ -1,13 +1,50 @@ --- title: cash_growth -description: OpenBB Platform Function +description: This page provides information about the cash growth API method, which + provides detailed data for financial metrics, including a variety of growth rates. + This is important for data analysis and understanding of company growth. +keywords: +- cash flow statement +- company growth +- financial metrics +- financial data +- data analysis +- Python +- financial provider +- warnings +- charting +- command execution +- growth rate of net income +- growth rate of depreciation and amortization +- growth rate of deferred income tax +- growth in working capital +- growth rate accounts receivables +- growth rate inventory +- growth rate accounts payables +- growth rate of investments in property, plant, and equipment +- growth rate of net acquisitions +- growth rate of net cash used for investing activities +- growth rate of debt repayment +- growth rate of common stock issued +- growth rate of common stock repurchased +- growth rate of dividends paid +- growth rate of other financing activities +- growth rate of the effect of foreign exchange changes on cash +- growth rate of net change in cash +- growth rate of cash at the end of the period +- growth rate of cash at the beginning of the period +- growth rate of operating cash flow +- growth rate of capital expenditure +- growth rate of free cash flow --- +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; -# cash_growth - Cash Flow Statement Growth. Information about the growth of the company cash flow statement. ```python wordwrap @@ -97,4 +134,3 @@ OBBject - diff --git a/website/content/platform/reference/fa/comp.md b/website/content/platform/reference/fa/comp.md index 28fea85d07bb..72ae925f8ff4 100644 --- a/website/content/platform/reference/fa/comp.md +++ b/website/content/platform/reference/fa/comp.md @@ -1,13 +1,29 @@ --- title: comp -description: OpenBB Platform Function +description: Page providing in-depth information on Executive Compensation for a given + company. It includes data about bonuses, salaries, stock awards, as well as other + compensations provided to the executive. The page uses the docusaurus tool and conducts + comprehensive keyword research to ensure optimal search engine optimization. +keywords: +- Executive Compensation +- company information +- SEO +- SEO services +- keyword research +- search engine optimization +- metadata +- docusaurus +- content marketing +- digital marketing --- +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; -# comp - Executive Compensation. Information about the executive compensation for a given company. ```python wordwrap @@ -76,4 +92,3 @@ OBBject - diff --git a/website/content/platform/reference/fa/comsplit.md b/website/content/platform/reference/fa/comsplit.md index cc8dd3f86d72..23f364a367e7 100644 --- a/website/content/platform/reference/fa/comsplit.md +++ b/website/content/platform/reference/fa/comsplit.md @@ -1,13 +1,33 @@ --- title: comsplit -description: OpenBB Platform Function +description: This documentation page provides information about the 'comsplit' function + that fetches a Stock Split Calendar. It includes parameters to be set, what the + function returns, and the format of the data. +keywords: +- comsplit +- documentation +- Stock Split Calendar +- start_date +- end_date +- provider +- results +- warnings +- chart +- metadata +- data format +- date +- symbol +- numerator +- denominator --- +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; -# comsplit - Stock Split Calendar. Show Stock Split Calendar. ```python wordwrap @@ -69,4 +89,3 @@ OBBject - diff --git a/website/content/platform/reference/fa/divs.md b/website/content/platform/reference/fa/divs.md index 4add2d10ed9d..3199f7a27763 100644 --- a/website/content/platform/reference/fa/divs.md +++ b/website/content/platform/reference/fa/divs.md @@ -1,13 +1,30 @@ --- title: divs -description: OpenBB Platform Function +description: A detailed documentation page outlining how to fetch historical dividends + data for specific companies using the divs function. The page contains explanations + on functions parameters, the return values, and the data that can be obtained. +keywords: +- Historical Dividends +- divs +- provider +- symbol +- data +- date +- label +- adjusted dividend +- dividend +- record date +- payment date +- declaration_date --- +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; -# divs - Historical Dividends. Historical dividends data for a given company. ```python wordwrap @@ -70,4 +87,3 @@ OBBject - diff --git a/website/content/platform/reference/fa/earning.md b/website/content/platform/reference/fa/earning.md index 89b4f3bb8760..8fbfbf2812be 100644 --- a/website/content/platform/reference/fa/earning.md +++ b/website/content/platform/reference/fa/earning.md @@ -1,13 +1,29 @@ --- title: earning -description: OpenBB Platform Function +description: The Documentation describes the use of 'Earnings Calendar' for retrieving + earnings data for a specified company symbol. It includes data entries like EPS, + Estimated EPS, Revenue, Estimated Revenue, etc. Provider 'fmp' is used for data + retrieval. +keywords: +- Earnings Calendar +- EPS +- Revenue +- Python +- Earnings Calendar Data +- Estimated EPS +- Estimated Revenue +- Fiscal Date Ending +- Provider +- Symbol --- +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; -# earning - Earnings Calendar. Earnings calendar for a given company. ```python wordwrap @@ -73,4 +89,3 @@ OBBject - diff --git a/website/content/platform/reference/fa/emp.md b/website/content/platform/reference/fa/emp.md index 12a7957d4f19..9d9460a70b7f 100644 --- a/website/content/platform/reference/fa/emp.md +++ b/website/content/platform/reference/fa/emp.md @@ -1,13 +1,32 @@ --- title: emp -description: OpenBB Platform Function +description: 'This page provides you with the historical number of employees in a + company. It includes information about the company symbol, the provider, and specific + details such as: CIK of the company, time of acceptance, date of report, name of + the company, form type, filing date, employee count, and the source URL. Perfect + for those looking to query historical business data.' +keywords: +- Historical Employees +- symbol +- provider +- fmp +- CIK +- acceptance_time +- period_of_report +- company_name +- form_type +- filing_date +- employee_count +- source --- +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; -# emp - Historical Employees. Historical number of employees. ```python wordwrap @@ -72,4 +91,3 @@ OBBject - diff --git a/website/content/platform/reference/fa/est.md b/website/content/platform/reference/fa/est.md index 8ce68d3c6ee8..1a8c2fc26311 100644 --- a/website/content/platform/reference/fa/est.md +++ b/website/content/platform/reference/fa/est.md @@ -1,13 +1,30 @@ --- title: est -description: OpenBB Platform Function +description: This page provides detailed parameters and data options for retrieving + Analyst Estimates and stock recommendations using the est function. It further explains + the returned objects including results, provider name, warnings, chart object, and + metadata. The page also provides an enumeration of the estimated data types like + revenue, EBITDA, net income amongst others that can be obtained. +keywords: +- Analyst Estimates +- stock recommendations +- analyst data +- data query +- financial market provider +- estimated revenue +- estimated EBITDA +- estimated net income +- estimated EPS +- fmp provider --- +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; -# est - Analyst Estimates. Analyst stock recommendations. ```python wordwrap @@ -87,4 +104,3 @@ OBBject - diff --git a/website/content/platform/reference/fa/filings.md b/website/content/platform/reference/fa/filings.md index 47f171e319b2..cc1619f0f55e 100644 --- a/website/content/platform/reference/fa/filings.md +++ b/website/content/platform/reference/fa/filings.md @@ -1,13 +1,34 @@ --- title: filings -description: OpenBB Platform Function +description: "This page provides information on how to query company filings data,\ + \ including the parameters necessary for extraction. It details parameters and returned\ + \ data for both standard and \u2018fmp\u2019 method types. Queries yield a variety\ + \ of data including document type and URL, ticker symbol, CIK, accepted date, and\ + \ final link of the SEC filing." +keywords: +- company filings +- data parameters +- data entries +- query provider +- SEC filing form +- fmp +- metadata +- chart object +- document type +- document url +- ticker symbol +- CIK +- accepted date +- final link --- +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; -# filings - Company Filings. Company filings data. ```python wordwrap @@ -91,4 +112,3 @@ OBBject - diff --git a/website/content/platform/reference/fa/income.md b/website/content/platform/reference/fa/income.md index 876febbb34b7..a3db29fac751 100644 --- a/website/content/platform/reference/fa/income.md +++ b/website/content/platform/reference/fa/income.md @@ -1,13 +1,28 @@ --- title: income -description: OpenBB Platform Function +description: This page provides detailed information about income statements and the + parameters required to optimize the retrieval of financial data for different providers. + It also covers return data and warnings. +keywords: +- income statement +- SEO optimization +- financial data +- keywords +- docusaurus +- financial performance +- fmp +- intrinio +- polygon +- metadata --- +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; -# income - Income Statement. Report on a company's finanacial performance. ```python wordwrap @@ -241,4 +256,3 @@ OBBject - diff --git a/website/content/platform/reference/fa/income_growth.md b/website/content/platform/reference/fa/income_growth.md index e6f2dcd2e744..ace7e0bd37b6 100644 --- a/website/content/platform/reference/fa/income_growth.md +++ b/website/content/platform/reference/fa/income_growth.md @@ -1,13 +1,30 @@ --- title: income_growth -description: OpenBB Platform Function +description: Documentation covering the income_growth function which is responsible + for generating and understanding of a company's income statement growth over time. + It includes parameters to filter data entries by provider, period or data limit + and returns information such as growth rate of total revenue, cost of goods, gross + profit, operating expenses, net income, and more. +keywords: +- income_growth +- income statement growth +- company financial growth +- financial data +- financial metrics +- income statement data +- financial measurements +- financial performance +- financial analysis +- income growth analytics --- +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; -# income_growth - Income Statement Growth. Information about the growth of the company income statement. ```python wordwrap @@ -94,4 +111,3 @@ OBBject - diff --git a/website/content/platform/reference/fa/index.mdx b/website/content/platform/reference/fa/index.mdx deleted file mode 100644 index 479af4ac9eb3..000000000000 --- a/website/content/platform/reference/fa/index.mdx +++ /dev/null @@ -1,174 +0,0 @@ -# fa - -import ReferenceCard from "@site/src/components/General/ReferenceCard"; - -
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
diff --git a/website/content/platform/reference/fa/ins.md b/website/content/platform/reference/fa/ins.md index 3652246860cf..59091b5551bd 100644 --- a/website/content/platform/reference/fa/ins.md +++ b/website/content/platform/reference/fa/ins.md @@ -1,13 +1,32 @@ --- title: ins -description: OpenBB Platform Function +description: This page provides comprehensive insights into stock insider trading. + It provides detailed parameters and data explanations for specific symbols, transaction + types, and more. +keywords: +- Stock Insider Trading +- Symbol data +- Transaction type +- Filing date +- Transaction date +- Securities Owned +- Company CIK +- Type of owner +- Acquisition or disposition +- Form type +- Securities transacted +- Price +- Security name +- Market analysis --- +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; -# ins - Stock Insider Trading. Information about insider trading. ```python wordwrap @@ -80,4 +99,3 @@ OBBject - diff --git a/website/content/platform/reference/fa/ins_own.md b/website/content/platform/reference/fa/ins_own.md index b6558244db2a..6e536c7822db 100644 --- a/website/content/platform/reference/fa/ins_own.md +++ b/website/content/platform/reference/fa/ins_own.md @@ -1,13 +1,28 @@ --- title: ins_own -description: OpenBB Platform Function +description: This page is about Institutional Ownership, which offers data related + to the ownership shares in a company including various parameters like number of + investors, number of shares, total invested amount and more. It also includes an + API function call to retrieve this data. +keywords: +- institutional ownership +- investors holding +- number of shares +- total invested amount +- ownership percent +- put call ratio +- institutional ownership data +- API function call +- data retrieve --- +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; -# ins_own - Institutional Ownership. Institutional ownership data. ```python wordwrap @@ -101,4 +116,3 @@ OBBject - diff --git a/website/content/platform/reference/fa/metrics.md b/website/content/platform/reference/fa/metrics.md index 89575b609415..7ccd64d837d6 100644 --- a/website/content/platform/reference/fa/metrics.md +++ b/website/content/platform/reference/fa/metrics.md @@ -1,13 +1,35 @@ --- title: metrics -description: OpenBB Platform Function +description: This is a documentation page describing Key Metrics for a given company. + It defines parameters including symbol, limit, provider, period among others. It + lays out the standard and specific data fields of the company's financial metrics + such as revenue per share, net income per share, operating cash flow per share and + so on. +keywords: +- Key Metrics +- Documentation +- parameters +- returns +- data +- symbol +- period +- limit +- provider +- revenue_per_share +- net_income_per_share +- operating_cash_flow_per_share +- free_cash_flow_per_share +- cash_per_share +- price_to_sales_ratio --- +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; -# metrics - Key Metrics. Key metrics for a given company. ```python wordwrap @@ -203,4 +225,3 @@ OBBject - diff --git a/website/content/platform/reference/fa/mgmt.md b/website/content/platform/reference/fa/mgmt.md index 55ef17771a4c..e90ba844e2c2 100644 --- a/website/content/platform/reference/fa/mgmt.md +++ b/website/content/platform/reference/fa/mgmt.md @@ -1,13 +1,28 @@ --- title: mgmt -description: OpenBB Platform Function +description: Documentation for the 'mgmt' function for retrieving information about + key executives of a given company using python with support for different data providers. + The function returns a list of executives along with their respective details. +keywords: +- Key Executives +- Company data +- Python +- FMP Provider +- Data Query +- UML +- mgmt function +- Management +- SEO +- Metadata --- +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; -# mgmt - Key Executives. Key executives for a given company. ```python wordwrap @@ -70,4 +85,3 @@ OBBject - diff --git a/website/content/platform/reference/fa/overview.md b/website/content/platform/reference/fa/overview.md index 529c46cb2214..a8042f04d27b 100644 --- a/website/content/platform/reference/fa/overview.md +++ b/website/content/platform/reference/fa/overview.md @@ -1,13 +1,49 @@ --- title: overview -description: OpenBB Platform Function +description: This page provides information about the functionality of the 'company + overview' feature, detailing its parameters, returns, and data types. It extensively + discusses attributes like symbol, provider, market capitalization, beta, volume + average, dividends, and more. It's a comprehensive guide for understanding the data + this function outputs. +keywords: +- company overview +- data +- provider +- symbol +- parameters +- returns +- data types +- fmp +- market capitalization +- beta +- volume average +- dividend +- changes +- cik +- isin +- exchange +- industry +- ceo +- sector +- country +- full time employees +- phone number +- address +- discounted cash flow +- ipo date +- trading +- fund +- etf +- adr --- +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; -# overview - Company Overview. General information about a company. ```python wordwrap @@ -99,4 +135,3 @@ OBBject - diff --git a/website/content/platform/reference/fa/own.md b/website/content/platform/reference/fa/own.md index 9d56b8bc0764..cafe293704ee 100644 --- a/website/content/platform/reference/fa/own.md +++ b/website/content/platform/reference/fa/own.md @@ -1,13 +1,34 @@ --- title: own -description: OpenBB Platform Function +description: Details about company stock ownership that includes information about + securities, industries, investments, market values, shares, performance, and more. + It also provides information on querying these data from specified providers. +keywords: +- Stock Ownership +- Company Ownership +- Metadata +- Symbol +- Market Value +- Shares Number +- Investor name +- Security Name +- Type of Security +- Shares Type +- Industry Title +- Holding Period +- Performance +- Last Performance +- Investment Discretion +- Data Query Provider --- +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; -# own - Stock Ownership. Information about the company ownership. ```python wordwrap @@ -104,4 +125,3 @@ OBBject - diff --git a/website/content/platform/reference/fa/pt.md b/website/content/platform/reference/fa/pt.md index a6f768710c29..74e712c23143 100644 --- a/website/content/platform/reference/fa/pt.md +++ b/website/content/platform/reference/fa/pt.md @@ -1,13 +1,31 @@ --- title: pt -description: OpenBB Platform Function +description: This page provides insights on how to query and retrieve 'Price Target + Consensus' data for selected symbols using a specified provider. It includes explanations + for the parameters needed, the data returned, and how to handle specific sequences + of commands. +keywords: +- Price Target Consensus +- Data Provider +- FMP +- Symbol Data +- Price Target +- Consensus Target +- High Target +- Low Target +- Median Target +- Chart Object +- Command Execution +- Python Wordwrap --- +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; -# pt - Price Target Consensus. Price target consensus data. ```python wordwrap @@ -68,4 +86,3 @@ OBBject - diff --git a/website/content/platform/reference/fa/pta.md b/website/content/platform/reference/fa/pta.md index 98414ca7aa06..6070897d6a23 100644 --- a/website/content/platform/reference/fa/pta.md +++ b/website/content/platform/reference/fa/pta.md @@ -1,13 +1,31 @@ --- title: pta -description: OpenBB Platform Function +description: This is documentation on how to obtain Price Target data using 'pta'. + This function allows querying by symbol and provider. It can return a variety of + fields including analyst information, news related to the target price, grades and + more. The data can be retrieved from a standard or 'fmp' provider option. +keywords: +- Price Target +- pta +- fmp +- Price Target data +- Python +- Documentation +- Parameters +- Grading company +- Analyst name +- Analyst company +- News URL +- News Title --- +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; -# pta - Price Target. Price target data. ```python wordwrap @@ -103,4 +121,3 @@ OBBject - diff --git a/website/content/platform/reference/fa/ratios.md b/website/content/platform/reference/fa/ratios.md index 8ed9a58ea0cf..cdfcce387db4 100644 --- a/website/content/platform/reference/fa/ratios.md +++ b/website/content/platform/reference/fa/ratios.md @@ -1,13 +1,30 @@ --- title: ratios -description: OpenBB Platform Function +description: Documentation about getting financial ratios for a specific company over + time. This includes a detailed explanation about parameters for standard and fmp + providers, results and data definitions. +keywords: +- ratios +- financial ratios +- financial data +- financial analytics +- company data +- financial data provider +- fmp +- profit margin +- debt ratio +- data query +- financial information +- financial parameters --- +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; -# ratios - Extensive set of ratios over time. Financial ratios for a given company. ```python wordwrap @@ -133,4 +150,3 @@ OBBject - diff --git a/website/content/platform/reference/fa/revgeo.md b/website/content/platform/reference/fa/revgeo.md index d9358774830c..1a7f7d9676cf 100644 --- a/website/content/platform/reference/fa/revgeo.md +++ b/website/content/platform/reference/fa/revgeo.md @@ -1,13 +1,33 @@ --- title: revgeo -description: OpenBB Platform Function +description: The revgeo page provides information about the Revenue Geographic, a + function that returns geographic revenue data. Parameters, returns and data structure + are covered in details. +keywords: +- revgeo +- Revenue Geographic +- geographic revenue data +- data query +- Docusaurus documentation +- provider +- period +- structure +- symbol +- geographic segment +- Revenue from the America +- Revenue from Europe +- Revenue from Greater China +- Revenue from Japan +- Revenue from Rest of Asia Pacific --- +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; -# revgeo - Revenue Geographic. Geographic revenue data. ```python wordwrap @@ -72,4 +92,3 @@ OBBject - diff --git a/website/content/platform/reference/fa/revseg.md b/website/content/platform/reference/fa/revseg.md index ca736cca9fea..223808b1861c 100644 --- a/website/content/platform/reference/fa/revseg.md +++ b/website/content/platform/reference/fa/revseg.md @@ -1,13 +1,30 @@ --- title: revseg -description: OpenBB Platform Function +description: Metadata for revseg page - a revenue business line data page. Describes + parameters like symbol, period, structure and provider for data querying. Also provides + info on returned data. +keywords: +- revseg +- revenue business line data +- business line revenue +- data query +- parameters +- symbol +- period +- structure +- provider +- returned data +- warnings +- metadata --- +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; -# revseg - Revenue Business Line. Business line revenue data. ```python wordwrap @@ -67,4 +84,3 @@ OBBject - diff --git a/website/content/platform/reference/fa/shrs.md b/website/content/platform/reference/fa/shrs.md index 817ff18b81ee..2f6661d38bfa 100644 --- a/website/content/platform/reference/fa/shrs.md +++ b/website/content/platform/reference/fa/shrs.md @@ -1,13 +1,31 @@ --- title: shrs -description: OpenBB Platform Function +description: This page provides detailed information about the 'shrs' functionality. + It allows users to share statistics of a specific company utilizing specified parameters. + It also details the process of fetching and interpreting data, understanding parameters + such as symbols, data, and share types. +keywords: +- shrs +- share Statistics +- symbol +- Macroaxis +- OBBject +- Chart object +- Metadata +- Data +- free_float +- float_shares +- outstanding_shares +- source --- +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; -# shrs - Share Statistics. Share statistics for a given company. ```python wordwrap @@ -69,4 +87,3 @@ OBBject - diff --git a/website/content/platform/reference/fa/split.md b/website/content/platform/reference/fa/split.md index b9b576099516..323ba785019e 100644 --- a/website/content/platform/reference/fa/split.md +++ b/website/content/platform/reference/fa/split.md @@ -1,13 +1,29 @@ --- title: split -description: OpenBB Platform Function +description: Page providing detailed documentation about Historical Stock Splits function + in our API. Contains information about parameters such as stock symbol and data + provider, return values, and detailed data descriptions. The page is particularly + useful for finance professionals and developers interacting with finance APIs. +keywords: +- Historical Stock Splits +- Stock data +- Stock split data +- SEO for Finance +- Stock Symbols +- Stock Market +- Market Data +- Python Code +- Data Providers +- Finance API --- +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; -# split - Historical Stock Splits. Historical stock splits data. ```python wordwrap @@ -67,4 +83,3 @@ OBBject - diff --git a/website/content/platform/reference/fa/transcript.md b/website/content/platform/reference/fa/transcript.md index 7f07a8ff512b..62d16303c1c6 100644 --- a/website/content/platform/reference/fa/transcript.md +++ b/website/content/platform/reference/fa/transcript.md @@ -1,13 +1,26 @@ --- title: transcript -description: OpenBB Platform Function +description: The documentation page provides details about fetching earnings call + transcripts for any company by specifying the symbol, year, and quarter. It also + provides information about the data provider and the metadata returned along with + the query results. +keywords: +- Earnings call transcript +- Data provider +- FMP +- symbol +- quarter +- year +- Metadata --- +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; -# transcript - Earnings Call Transcript. Earnings call transcript for a given company. ```python wordwrap @@ -70,4 +83,3 @@ OBBject - diff --git a/website/content/platform/reference/fixedincome/ameribor.md b/website/content/platform/reference/fixedincome/ameribor.md index a4d0ed74e09e..25c1b0308247 100644 --- a/website/content/platform/reference/fixedincome/ameribor.md +++ b/website/content/platform/reference/fixedincome/ameribor.md @@ -1,13 +1,29 @@ --- title: ameribor -description: OpenBB Platform Function +description: Explore in-depth the Ameribor or the American interbank offered rate + that reflects the cost of short-term interbank borrowing based on transactions in + overnight unsecured loans conducted on the American Financial Exchange (AFX). This + page provides a comprehensive overview of its parameters, returns and data. +keywords: +- Ameribor +- American interbank offered rate +- Interest rate +- AFX +- American Financial Exchange +- Short-term interbank borrowing +- Unsecured loans +- Financial data +- Data provider +- Date format --- +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; -# ameribor - Ameribor. Ameribor (short for the American interbank offered rate) is a benchmark interest rate that reflects the true cost of short-term interbank borrowing. This rate is based on transactions in overnight unsecured loans conducted on the @@ -79,4 +95,3 @@ OBBject - diff --git a/website/content/platform/reference/fixedincome/estr.md b/website/content/platform/reference/fixedincome/estr.md index 38c4ff9be362..e134e42c3924 100644 --- a/website/content/platform/reference/fixedincome/estr.md +++ b/website/content/platform/reference/fixedincome/estr.md @@ -1,13 +1,25 @@ --- title: estr -description: OpenBB Platform Function +description: "Detailed documentation page about the Euro Short-Term Rate (\u20ACSTR)\ + \ function, including its parameters, return values, and data structure." +keywords: +- Euro Short-Term Rate +- "\u20ACSTR" +- finance +- economic data +- SEO +- metadata +- functions +- parameters --- +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; -# estr - Euro Short-Term Rate. The euro short-term rate (€STR) reflects the wholesale euro unsecured overnight borrowing costs of banks located in the euro area. The €STR is published on each TARGET2 business day based on transactions conducted and settled on @@ -80,4 +92,3 @@ OBBject - diff --git a/website/content/platform/reference/fixedincome/fed.md b/website/content/platform/reference/fixedincome/fed.md index f3b8b51fbd91..4a9644dd52f9 100644 --- a/website/content/platform/reference/fixedincome/fed.md +++ b/website/content/platform/reference/fixedincome/fed.md @@ -1,13 +1,29 @@ --- title: fed -description: OpenBB Platform Function +description: This page provides comprehensive details about the Federal Funds Rate + (FED), its parameters and usage. It provides guidance on how to use 'fed' commands + in Python, the start and end dates, and how to choose a provider for the query. +keywords: +- Federal Funds Rate +- FED +- bank rate +- Federal Reserve System +- Python commands +- query provider +- '''fred'' provider' +- start date +- end date +- '''fred'' parameters' +- data rate --- +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; -# fed - Fed Funds Rate. Get Effective Federal Funds Rate data. A bank rate is the interest rate a nation's central bank charges to its domestic banks to borrow money. The rates central banks charge are set to stabilize the economy. In the @@ -79,4 +95,3 @@ OBBject - diff --git a/website/content/platform/reference/fixedincome/index.mdx b/website/content/platform/reference/fixedincome/index.mdx deleted file mode 100644 index 0f04776d1950..000000000000 --- a/website/content/platform/reference/fixedincome/index.mdx +++ /dev/null @@ -1,60 +0,0 @@ -# fixedincome - -import ReferenceCard from "@site/src/components/General/ReferenceCard"; - -
    - - - - - - - - - -
diff --git a/website/content/platform/reference/fixedincome/iorb.md b/website/content/platform/reference/fixedincome/iorb.md index aa41d84ae760..1b7f89aa21e1 100644 --- a/website/content/platform/reference/fixedincome/iorb.md +++ b/website/content/platform/reference/fixedincome/iorb.md @@ -1,13 +1,34 @@ --- title: iorb -description: OpenBB Platform Function +description: A documentation page that provides detailed instructions on how to retrieve + Interest Rate on Reserve Balances (IORB) data using the 'iorb' function. The page + explains the parameters, returns, and data for the function. +keywords: +- IORB +- Interest Rate on Reserve Balances +- bank rate +- central bank +- Federal Reserve System +- discount rate +- start_date +- end_date +- provider +- OBBject +- results +- warnings +- chart +- metadata +- iorb function +- economic data retrieval --- +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; -# iorb - Interest on Reserve Balances. Get Interest Rate on Reserve Balances data A bank rate is the interest rate a nation's central bank charges to its domestic banks to borrow money. The rates central banks charge are set to stabilize the economy. In the @@ -69,4 +90,3 @@ OBBject - diff --git a/website/content/platform/reference/fixedincome/projections.md b/website/content/platform/reference/fixedincome/projections.md index 567ae17ff35a..b691ce059075 100644 --- a/website/content/platform/reference/fixedincome/projections.md +++ b/website/content/platform/reference/fixedincome/projections.md @@ -1,13 +1,33 @@ --- title: projections -description: OpenBB Platform Function +description: Browse through this comprehensive guide on federal funds rate projections + inclusive of parameters, data, and returns. Useful commands and searches provided + for providers such as 'fred'. Includes python wordwrap for ease. Get details on + the target range, central tendencies and projection of rates. +keywords: +- projections +- federal funds rate +- target range +- python wordwrap +- parameters +- provider +- fred +- long_run +- returns +- OBBject results +- data +- date +- central tendency +- projection of rates --- +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; -# projections - Fed Funds Rate Projections. The projections for the federal funds rate are the value of the midpoint of the projected appropriate target range for the federal funds rate or the projected @@ -82,4 +102,3 @@ OBBject - diff --git a/website/content/platform/reference/fixedincome/sofr.md b/website/content/platform/reference/fixedincome/sofr.md index 7f3785614606..290571cc2c4a 100644 --- a/website/content/platform/reference/fixedincome/sofr.md +++ b/website/content/platform/reference/fixedincome/sofr.md @@ -1,13 +1,24 @@ --- title: sofr -description: OpenBB Platform Function +description: This documentation page provides information about the Secured Overnight + Financing Rate (SOFR), along with details on how to fetch the data using different + parameters from the Fred provider. +keywords: +- Secured Overnight Financing Rate +- SOFR +- Treasury securities +- Data retrieval +- Fred provider +- SOFR rate --- +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; -# sofr - Secured Overnight Financing Rate. The Secured Overnight Financing Rate (SOFR) is a broad measure of the cost of borrowing cash overnight collateralized by Treasury securities. @@ -78,4 +89,3 @@ OBBject - diff --git a/website/content/platform/reference/fixedincome/sonia.md b/website/content/platform/reference/fixedincome/sonia.md index 761639374890..2e6845f49230 100644 --- a/website/content/platform/reference/fixedincome/sonia.md +++ b/website/content/platform/reference/fixedincome/sonia.md @@ -1,13 +1,32 @@ --- title: sonia -description: OpenBB Platform Function +description: This page provides details on SONIA (Sterling Overnight Index Average), + an interest rate benchmark based on the rates that banks pay to borrow sterling + overnight from other institutions. It includes Python code and parameters for obtaining + data related to SONIA. +keywords: +- SONIA +- Sterling Overnight Index Average +- interest rate benchmark +- financial institutions +- sterling overnight borrow +- Python +- parameters +- start date +- end date +- provider +- fred +- data +- SONIA rate --- +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; -# sonia - Sterling Overnight Index Average. SONIA (Sterling Overnight Index Average) is an important interest rate benchmark. SONIA is based on actual transactions and reflects the average of the interest rates that banks pay to borrow sterling overnight from other @@ -79,4 +98,3 @@ OBBject - diff --git a/website/content/platform/reference/fixedincome/treasury.md b/website/content/platform/reference/fixedincome/treasury.md index ce92c669ceb3..6a1decf555e8 100644 --- a/website/content/platform/reference/fixedincome/treasury.md +++ b/website/content/platform/reference/fixedincome/treasury.md @@ -1,13 +1,33 @@ --- title: treasury -description: OpenBB Platform Function +description: This page provides comprehensive details on accessing Treasury rates + data, parameters involved in data retrieval, types of return values and data format. + It provides specific insights on month and year treasury rates. +keywords: +- Treasury rates data +- parameters +- returns +- data +- start date +- end date +- provider +- OBBject results +- provider name +- warnings +- chart +- metadata +- month treasury rate +- year treasury rate +- date of the data --- +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; -# treasury - Treasury Rates. Treasury rates data. ```python wordwrap @@ -77,4 +97,3 @@ OBBject - diff --git a/website/content/platform/reference/fixedincome/ycrv.md b/website/content/platform/reference/fixedincome/ycrv.md index f75665a73503..6e877df152cb 100644 --- a/website/content/platform/reference/fixedincome/ycrv.md +++ b/website/content/platform/reference/fixedincome/ycrv.md @@ -1,13 +1,28 @@ --- title: ycrv -description: OpenBB Platform Function +description: The YCRV documentation page details how to fetch US Yield Curve data. + The page includes parameters for date and inflation adjustment. It showcases the + use of 'fred' - a provider for the data query. +keywords: +- Yield Curve +- US Yield Curve +- YCRV +- FRED +- Inflation adjusted rates +- Financial data provider +- Maturity +- Treasury rate +- Rate +- Date --- +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; -# ycrv - US Yield Curve. Get United States yield curve. ```python wordwrap @@ -66,4 +81,3 @@ OBBject - diff --git a/website/content/platform/reference/forex/index.mdx b/website/content/platform/reference/forex/index.mdx deleted file mode 100644 index 3d9690cd244a..000000000000 --- a/website/content/platform/reference/forex/index.mdx +++ /dev/null @@ -1,18 +0,0 @@ -# forex - -import ReferenceCard from "@site/src/components/General/ReferenceCard"; - -
    - - -
diff --git a/website/content/platform/reference/forex/load.md b/website/content/platform/reference/forex/load.md index 5b330e25c75d..6dd5d456404d 100644 --- a/website/content/platform/reference/forex/load.md +++ b/website/content/platform/reference/forex/load.md @@ -1,13 +1,42 @@ --- title: load -description: OpenBB Platform Function +description: Documentation on how to load Forex Historical Price data using different + providers and parameters, and what type of data to expect in return, including date, + volume, price, and possible warnings. +keywords: +- Forex Historical Price +- Forex data +- load function +- price data +- date format +- data provider +- fmp +- polygon +- symbol pair +- data granularity +- timespan of data +- sort order +- adjusted data +- Volume Weighted Average Price +- open price +- high price +- low price +- close price +- start date +- end date +- results +- warnings +- chart object +- metadata --- +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; -# load - Forex Historical Price. Forex historical data. ```python wordwrap @@ -131,4 +160,3 @@ OBBject - diff --git a/website/content/platform/reference/forex/pairs.md b/website/content/platform/reference/forex/pairs.md index 49ddfe1e47d8..16330bd2d483 100644 --- a/website/content/platform/reference/forex/pairs.md +++ b/website/content/platform/reference/forex/pairs.md @@ -1,13 +1,45 @@ --- title: pairs -description: OpenBB Platform Function +description: This page provides meticulous information about the Forex Pairs documentation, + including the choice of provider, parameters, return values, and data types. It + describes how to query based on various factors such as symbols, dates, and specific + search terms. It also includes definitions of terms and codes used in different + currency markets. +keywords: +- Forex Pairs +- provider +- query +- symbol +- date +- search +- active +- order +- sort +- limit +- currency +- stock_exchange +- exchange_short_name +- ISO 4217 currency code +- market +- locale +- currency_symbol +- currency_name +- base_currency_symbol +- base_currency_name +- last_updated_utc +- delisted_utc +- fmp +- intrinio +- polygon --- +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; -# pairs - Forex Pairs. Forex available pairs. ```python wordwrap @@ -113,4 +145,3 @@ OBBject - diff --git a/website/content/platform/reference/index.mdx b/website/content/platform/reference/index.mdx deleted file mode 100644 index 0f22f5cd918f..000000000000 --- a/website/content/platform/reference/index.mdx +++ /dev/null @@ -1,51 +0,0 @@ -# OpenBB Platform Reference - -import ReferenceCard from "@site/src/components/General/ReferenceCard"; - -
    - - - - - - - - - -
diff --git a/website/content/platform/reference/news/globalnews.md b/website/content/platform/reference/news/globalnews.md index 3b2a2c738246..6bfa038e0655 100644 --- a/website/content/platform/reference/news/globalnews.md +++ b/website/content/platform/reference/news/globalnews.md @@ -1,13 +1,29 @@ --- title: globalnews -description: OpenBB Platform Function +description: This page provides the necessary details to retrieve global news data + from different providers such as benzinga, fmp and intrinio using various parameters. + This is useful for python programmers and developers seeking to implement the function. +keywords: +- global news +- news data +- data provider +- benzinga +- fmp +- intrinio +- news query +- news parameters +- python programmer +- developer documentation +- articles retriever --- +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; -# globalnews - Global News. Global news data. ```python wordwrap @@ -134,4 +150,3 @@ OBBject - diff --git a/website/content/platform/reference/news/index.mdx b/website/content/platform/reference/news/index.mdx deleted file mode 100644 index c08d76e71396..000000000000 --- a/website/content/platform/reference/news/index.mdx +++ /dev/null @@ -1,12 +0,0 @@ -# news - -import ReferenceCard from "@site/src/components/General/ReferenceCard"; - -
    - -
diff --git a/website/content/platform/reference/options/chains.md b/website/content/platform/reference/options/chains.md index fcd5f15fd35c..df0caae583f2 100644 --- a/website/content/platform/reference/options/chains.md +++ b/website/content/platform/reference/options/chains.md @@ -1,13 +1,37 @@ --- title: chains -description: OpenBB Platform Function +description: This page documents the usage of the 'chains' function, which retrieves + complete options chains for a ticker. It details the parameters required, such as + symbol, provider, and date, and the data returned, including contract symbol, expiration, + strike price, and others. The default provider is intrinio. +keywords: +- chains +- ticker +- options chain +- intrinio +- symbol +- provider +- date +- contract symbol +- expiration +- strike price +- call or put +- volume +- open interest +- implied volatility +- delta +- gamma +- theta +- vega --- +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; -# chains - Get the complete options chain for a ticker. ```python wordwrap @@ -98,4 +122,3 @@ OBBject - diff --git a/website/content/platform/reference/options/index.mdx b/website/content/platform/reference/options/index.mdx deleted file mode 100644 index 3ad4bfe7f8f0..000000000000 --- a/website/content/platform/reference/options/index.mdx +++ /dev/null @@ -1,12 +0,0 @@ -# options - -import ReferenceCard from "@site/src/components/General/ReferenceCard"; - -
    - -
diff --git a/website/content/platform/reference/stocks/index.mdx b/website/content/platform/reference/stocks/index.mdx deleted file mode 100644 index d38903fd8b64..000000000000 --- a/website/content/platform/reference/stocks/index.mdx +++ /dev/null @@ -1,30 +0,0 @@ -# stocks - -import ReferenceCard from "@site/src/components/General/ReferenceCard"; - -
    - - - - -
diff --git a/website/content/platform/reference/stocks/load.md b/website/content/platform/reference/stocks/load.md index 53f5563361ed..52158399af1f 100644 --- a/website/content/platform/reference/stocks/load.md +++ b/website/content/platform/reference/stocks/load.md @@ -1,13 +1,59 @@ --- title: load -description: OpenBB Platform Function +description: Information related to the 'load' function for obtaining stock historical + price data for specific ticker symbols. Covering parameters, returns, and data across + the standard, 'fmp', 'intrinio', and 'polygon' functions. +keywords: +- Docusaurus +- SEO +- metadata +- load function +- stock historical price +- ticker symbols +- fmp +- intrinio +- polygon +- stock data +- parameters +- returns +- open price +- high price +- low price +- close price +- volume +- vwap +- Volume Weighted Average Price +- start date +- end date +- provider +- timeseries +- data granularity +- timezone +- interval size +- multiplier +- timespan +- sort order +- data entries +- adjusted +- trading times +- data source +- interval starting and stopping time +- data time frequency +- adjusted close price +- unadjusted volume +- price change +- change over time +- average trade price +- transaction numbers --- +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; -# load - Stock Historical price. Load stock data for a specific ticker. ```python wordwrap @@ -164,4 +210,3 @@ OBBject - diff --git a/website/content/platform/reference/stocks/multiples.md b/website/content/platform/reference/stocks/multiples.md index 58a2de07d4e2..adbf438b7744 100644 --- a/website/content/platform/reference/stocks/multiples.md +++ b/website/content/platform/reference/stocks/multiples.md @@ -1,13 +1,51 @@ --- title: multiples -description: OpenBB Platform Function +description: This page provides a detailed description of stock multiples and valuation + multiples for a stock ticker. It covers parameters for obtaining data, returns, + and data related to share values, share ratios, capitalization, earnings, debts, + and cash flows. +keywords: +- Stock Multiples +- Valuation multiples +- Stock ticker +- Data Entries +- Provider +- FMP +- Revenue Per Share +- Net Income Per Share +- Operating Cash Flow Per Share +- Free Cash Flow Per Share +- Cash Per Share +- Book Value Per Share +- Tangible Book Value Per Share +- Shareholders Equity Per Share +- Interest Debt Per Share +- Market Cap +- Enterprise Value +- PE Ratio +- Price to Sales Ratio +- POCF Ratio +- PFCF Ratio +- PB Ratio +- PTB Ratio +- EV to Sales Ratio +- Enterprise Value Over EBITDA Ratio +- EV to Operating Cash Flow +- EV to Free Cash Flow +- Earnings Yield +- Free Cash Flow Yield +- Debt to Equity +- Debt to Assets +- Net Debt to EBITDA --- +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; -# multiples - Stock Multiples. Valuation multiples for a stock ticker. ```python wordwrap @@ -124,4 +162,3 @@ OBBject - diff --git a/website/content/platform/reference/stocks/news.md b/website/content/platform/reference/stocks/news.md index 266e0fac42f2..57b68ce7d06a 100644 --- a/website/content/platform/reference/stocks/news.md +++ b/website/content/platform/reference/stocks/news.md @@ -1,13 +1,29 @@ --- title: news -description: OpenBB Platform Function +description: This page provides information on how to get stock news for a particular + ticker or a list of tickers. It features options to customize the query through + different providers including benzinga, fmp, intrinio, and polygon. It also outlines + the parameters for standard, benzinga and polygon providers as well as the returned + data for each provider. +keywords: +- stock news +- stock tickers +- news providers +- benzinga +- fmp +- intrinio +- polygon +- Docusaurus +- SEO --- +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; -# news - Stock News. Get news for one or more stock tickers. ```python wordwrap @@ -165,4 +181,3 @@ OBBject - diff --git a/website/content/platform/reference/stocks/quote.md b/website/content/platform/reference/stocks/quote.md index d10c2fc7046a..b86765478978 100644 --- a/website/content/platform/reference/stocks/quote.md +++ b/website/content/platform/reference/stocks/quote.md @@ -1,13 +1,27 @@ --- title: quote -description: OpenBB Platform Function +description: This page provides comprehensive documentation about the Stock Quote + function. It covers parameters including different providers and data sources, the + return structure, and detailed data obtained using the function. +keywords: +- Stock Quote +- FMP +- Intrinio +- API +- Stock data +- Data provider +- Darkpool +- Earnings per share +- Market cap --- +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; -# quote - Stock Quote. Load stock data for a specific ticker. ```python wordwrap @@ -134,4 +148,3 @@ OBBject - diff --git a/website/content/platform/showcase.md b/website/content/platform/showcase.md index bdb94c85a5db..74f8a1eaaa70 100644 --- a/website/content/platform/showcase.md +++ b/website/content/platform/showcase.md @@ -1,21 +1,24 @@ --- title: Showcase sidebar_position: 6 -description: Showcasing apps created by users using the OpenBB Platform -keywords: [Showcasing, showcase, OpenBB, openbb, sdk, api, pip, pypi, platform] +description: Stay updated with our upcoming open source projects on GitHub. Visit + https://github.com/search?q=topic:openbb&type=Repositories&l=&l= for more open source + projects under the topic OpenBB. +keywords: +- Open Source Projects +- GitHub +- Upcoming Projects +- OpenBB +- Showcase Item --- import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - + import ShowcaseItem from "@site/src/components/General/ShowcaseItem" -This page contains a list of projects that use the OpenBB Platform. - -If you have a project that uses the OpenBB Platform, please contact us via [Discord](https://discord.com/invite/Up2QGbMKHY) or [hello@openbb.co](mailto:hello@openbb.co). - ---- +## Coming Soon --- diff --git a/website/content/platform/usage/basic_syntax.md b/website/content/platform/usage/basic_syntax.md new file mode 100644 index 000000000000..a3e6df76b125 --- /dev/null +++ b/website/content/platform/usage/basic_syntax.md @@ -0,0 +1,209 @@ +--- +title: Basic Syntax +sidebar_position: 2 +description: This page provides comprehensive information about standardized command + syntax for an open-source platform. Topics discussed include the structure of command + syntax, use of standardized parameters, usage of provider and symbol parameters, + handling of date and limit parameters, and more. Also explored, are the methods + for selecting data sources, handling different list and ticker symbol formats, and + dealing with command responses and warnings. +keywords: +- command syntax +- standardized parameters +- date format +- provider parameter +- data source selection +- symbol parameter +- list formats +- ticker symbols +- date parameter +- time series +- limit parameter +- keyword arguments +- endpoint parameters +- command response +- data models +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +The structure of command syntax is standardized across common fields. This ensures that a `date` is always a `date` and the format remains consistent throughout. Standardized parameters include, but are not limited to: + +- [provider](/platform/usage/syntax_structure#provider) +- [symbol](/platform/usage/syntax_structure#symbol) +- [start_date](/platform/usage/syntax_structure#dates) +- [end_date](/platform/usage/syntax_structure#dates) +- [date](/platform/usage/syntax_structure#dates) +- [limit](/platform/usage/syntax_structure#limit) + +When looking at a function's docstring, the standard parameters (shared across multiple providers) are positioned first. Provider-specific parameters positionally follow the `provider` argument. The example below is from, `obb.stocks.quote`: + +```console +Parameters +---------- +symbol : str + Symbol to get data for. In this case, the comma separated list of symbols. +provider : Optional[Literal['fmp', 'intrinio']] + The provider to use for the query, by default None. + If None, the provider specified in defaults is selected or 'fmp' if there is + no default. +source : Literal['iex', 'bats', 'bats_delayed', 'utp_delayed', 'cta_a_delayed', 'cta_b_delayed', 'intrinio_mx', 'intrinio_mx_plus', 'delayed_sip'] + Source of the data. (provider: intrinio) +``` + +:::note +Examples below assume that the Python interface has been imported in the current session, and/or the Fast API has been started. + +```python +from openbb import obb +``` + +```python +uvicorn openbb_core.api.rest_api:app +``` + +::: + +## Provider + +The `provider` parameter is the way to select the specific source of the data from the endpoint. If a [preference for the default provider](/platform/usage/overview#user-settings) has not been defined, the default will be the first, alphabetically, installed provider. Provider values are entered in lower-case, with an underscore for multiple words - for example: + +```python +historical_prices = obb.stocks.load("aapl", provider="alpha_vantage") +``` + +Provider coverage can be ascertained with the command below: + +```python +obb.coverage.providers +``` + +Refer to, [Data Providers](/platform/usage/data_providers), for instructions on installing data provider extensions. + +## Symbol + +Symbols are not case-sensitive, and where the function allows, can be entered as a `string`, `List[str]`, or a comma-separated `string`. The exact format of the symbol may vary between providers - for example, share classes, exchange suffixes, and global composities. An example of this difference is shown below: + +```python +obb.stocks.load("brk.b", provider="polygon") +``` + +```python +obb.stocks.load("brk-b", provider="fmp") +``` + +While some providers handle the different formats on their end, others do not. This is something to consider when no results are returned from one source. + +With providers supporting market data from multiple jurisdictions, the most common method for requesting data outside of US-listings is to append a suffix to the ticker symbol (e.g., `RELIANCE.NS`). Formats may be unique to a provider, so it is best to review the source's documentation for an overview of their specific conventions. [This page](https://help.yahoo.com/kb/SLN2310.html) on Yahoo describes how they format symbols, which many others follow to some degree. + +### One Symbol + +```python +quote = obb.stocks.quote(symbol="td", provider="fmp") +``` + +### Multiple Symbols + +The OpenBB Provider module enforces REST-compliant lists that can be entered in either format through the Python interface. + +#### Comma-Separated String + +This is the format required by the Fast API, when creating new data endpoints, it is important that the Python interface is able to accept both formats. + +```python +quotes = obb.stocks.quote("td,schw,jpm,ms", provider="fmp") +``` + +```python +import requests +r = requests.get("http://127.0.0.1:8000/api/v1/stocks/quote?provider=fmp&symbol=td,schw,ms,jpm") +r.json() +``` + +#### Python List + +Entering a list will provide the same outcome as above. + +```python +quotes = obb.stocks.quote(["td","schw","jpm","ms"], provider="fmp") +``` + +Lists of symbols can be generated from the results of other functions, and then passed to the input. + +```python +symbol="spgi" +symbols = obb.stocks.ca.peers(symbol).results.peers_list+[symbol] +quotes = obb.stocks.quote(symbols) +``` + +:::note +To accomplish this same task through the Fast API, convert the list to a comma-separated string. +::: + +```python +import requests +symbol="spgi" +r = requests.get(f"http://127.0.0.1:8000/api/v1/stocks/ca/peers?provider=fmp&symbol={symbol}") +symbols_list = r.json()["results"]["peers_list"]+[symbol] +symbols = ",".join(symbols_list) +response = requests.get(f"http://127.0.0.1:8000/api/v1/stocks/quote?provider=fmp&symbol={symbols}") +response.json() +``` + +## Dates + +Dates are entered everywhere as a string, formatted as, "YYYY-MM-DD". If the function has only the `date` parameter, the data will be a snapshot instead of a time series. + +```python +historical_prices = obb.stocks.load(symbol="qqq", start_date="2023-01-10", end_date="2023-01-31", provider="fmp") +``` + +For flexibility and programmatic purposes, a `datetime` object is also accepted. + +```python +from datetime import datetime +symbol="qqq" +start = datetime.strptime("100123", "%d%m%y") +end = datetime.strptime("2023-01-31","%Y-%m-%d") +historical_prices = obb.stocks.load(symbol, start_date=start, end_date=end, provider="fmp") +``` + +```python +import requests +response = requests.get(f"http://127.0.0.1:8000/api/v1/stocks/load?provider=fmp&symbol={symbol}&start_date={start}&end_date={end}") +response.json() +``` + +## Limit + +Where, optional, `limit` parameters are supplied, they are likely to have sensible default states that return N results starting from the most recent entry or the `start_date`. Enter these values as an integer. + +```python +income = obb.stocks.fa.income("AAPL", period="quarter", provider="fmp", limit=4) +``` + +## **kwargs + +All endpoints accept additional keyword arguments, but non-existent parameters will be ignored. Invalid parameters are communicated via the `warnings` field in the command response. Parameters can be stored as a dictionary and fed to the command as `**kwargs`. If a provider, or function, has an undocumented parameter it can still be accessed by supplying the additional kwargs. + +```python +kwargs = {"symbol":"msft","start_date":"2023-01-01","provider":"polygon"} +historical_prices = obb.stocks.load(**kwargs) +``` + +```python +data = obb.stocks.quote("brk-b", provider="fmp", source="bats") +data.warnings +``` + +```console +[Warning_(category='OpenBBWarning', message="Parameter 'source' is not supported by fmp. Available for: intrinio.")] +``` + +## References + +All functions, parameters, and responses are detailed under the [Reference pages](/platform/reference/fixedincome/ycrv). The data models for each provider source are described within the [Data Models](/platform/data_models/StockHistorical) pages. + +These pages are a quick way to cross-reference differences between providers. The same information is provided in a function's signature and docstring. diff --git a/website/content/platform/usage/charting.md b/website/content/platform/usage/charting.md new file mode 100644 index 000000000000..03fc6f5f3b55 --- /dev/null +++ b/website/content/platform/usage/charting.md @@ -0,0 +1,75 @@ +--- +title: Charting Extension +sidebar_position: 4 +description: Learn how to install and use the powerful OpenBB Charting Extension for + the OpenBB Platform. It utilizes PyWry and Plotly for the display of interactive + charts and tables - an essential tool for developers. +keywords: +- OpenBB Charting Extension +- OpenBB Platform +- REST API +- Python Client +- PyWry +- Plotly +- interactive charts +- router pipeline +- python interface +- Interactive tables +- Installation +- OpenBBFigure +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + + +The OpenBB Charting Extension supplies charting infrastructure and services to the OpenBB Platform. Figure objects are served via REST API or Python Client. It utilizes PyWry for handling the display of interactive charts and tables in a separate window, with a Plotly library. The extension framework allows developers to easily insert other Python charting libraries into the router pipeline. + +## Installation + +To install the extension, run the following command in this folder: + +```bash +pip install openbb-charting +``` + +After installation, the Python interface will automatically rebuild on initialization. This process can also be triggered manually with: + +```python +import openbb +openbb.build() +``` + +The Python interpreter may require a restart. + +### PyWry dependency in Linux + +When using Linux distributions, the PyWry dependency requires certain dependencies to be installed first. + +- Debian-based / Ubuntu / Mint: +`sudo apt install libwebkit2gtk-4.0-dev` + +- Arch Linux / Manjaro: +`sudo pacman -S webkit2gtk` + +- Fedora: +`sudo dnf install gtk3-devel webkit2gtk3-devel` + +## Usage + +The OpenBB Charting Extension can be used in different ways: + +- A base class in the Python interface. +- An easy way to get started working with Plotly charts. +- The basic infrastructure for generating REST-compliant charts. +- Parameterized in existing router endpoints. +- Interactive tables. + +### Python Interface + +Import the `OpenBBFigure` class with: + +```python +from openbb_charting.core.openbb_figure import OpenBBFigure +``` diff --git a/website/content/platform/usage/data_providers.md b/website/content/platform/usage/data_providers.md new file mode 100644 index 000000000000..71fbea48e0fb --- /dev/null +++ b/website/content/platform/usage/data_providers.md @@ -0,0 +1,31 @@ +--- +title: Data Providers +sidebar_position: 3 +description: Learn about the OpenBB Platform and its extension framework that allows + seamless integration of modules like 'openbb-yfinance'. Discover how installations + and removals automatically update the router when the Python interpreter is refreshed. +keywords: +- OpenBB Platform +- extension framework +- yFinance +- install openbb-yfinance +- Python interpreter +- PyPI +- openbb-qa +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +When the core OpenBB Platform package is installed, familiar components might be missing. The extension framework allows individual pieces to be installed and removed seamlessly within the environment. + +For example, yFinance. + +```console +pip install openbb-yfinance +``` + +Additions and removals update the router automatically to reflect the changes when the Python interpreter is refreshed. + +Search [PyPI](https://pypi.org/search/?q=openbb-) to find more, like `openbb-qa`. diff --git a/website/content/platform/usage/guides/_category_.json b/website/content/platform/usage/guides/_category_.json index 82e09efaafd2..0b978658f6b3 100644 --- a/website/content/platform/usage/guides/_category_.json +++ b/website/content/platform/usage/guides/_category_.json @@ -2,3 +2,4 @@ "label": "Guides", "position": 2 } + diff --git a/website/content/platform/usage/guides/api-keys.md b/website/content/platform/usage/guides/api-keys.md deleted file mode 100644 index c2f60bff8420..000000000000 --- a/website/content/platform/usage/guides/api-keys.md +++ /dev/null @@ -1,867 +0,0 @@ ---- -title: Setting API Keys -sidebar_position: 1 -description: API (Application Programming Interface) keys are access credentials for accessing data from a particular source. Learn how to set, manage, and access data APIs for the OpenBB Platform. -keywords: [api, keys, api keys, data provider, data, free, alpha vantage, fred, iex, twitter, degiro, binance, coinglass, polygon, intrinio, sdk, alphavantage, bitquery, coinbase, databento, finnhub, FRED, github, glassnode, iex cloud, news API, robinhood, santiment, shroomdk, token terminal, tradier, twitter, whale alert] ---- - -import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - - - -## The Keys Module - -API (Application Programming Interface) keys are access credentials for obtaining data from a particular source. They are a string of random characters assigned, by the data provider, to an individual account. Most vendors offer a free tier requiring only a valid email address, some will require an account with proper KYC (Know Your Customer). Each source is entered into the Platform with the `openbb.keys` module, using the syntax described in the sections below. Wrapping the command with `help()` will print the docstrings to the screen. For example: - -```console -help(openbb.keys.reddit) -``` - -Which prints: - -```console - Set Reddit key - - Parameters - ---------- - client_id: str - Client ID - client_secret: str - Client secret - password: str - User password - username: str - User username - useragent: str - User useragent - persist: bool, optional - If False, api key change will be contained to where it was changed. For example, a Jupyter notebook session. - If True, api key change will be global, i.e. it will affect terminal environment variables. - By default, False. - show_output: bool, optional - - Returns - ------- - str - Status of key set - - Examples - -------- - >>> from openbb_terminal.sdk import openbb - >>> openbb.keys.reddit( - client_id="example_id", - client_secret="example_secret", - password="example_password", - username="example_username", - useragent="example_useragent" - ) -``` - -A message similar to the one below will be printed when a function requesting data from an API is called but the key has not yet been entered. - -```console -openbb.stocks.quote("AAPL") -API_KEY_FINANCIALMODELINGPREP not defined. Set API Keys in ~/.openbb_terminal/.env or under keys menu. -``` - -The menu also provides a method for testing the validity of a key upon entry. It can be easy to copy & paste the string with a missing character; so, if the test fails, check that the values were correctly recorded with the command: - -```console -openbb.keys.mykeys(show = True) -``` - -**We recommend gradually obtaining keys, when the use of a specific function requires it.** - -## Instructions by Source - -This section covers all API keys listed above and include detailed instructions how to obtain each API key. By clicking on each name, the section will expand and instructions are provided. Include, `persist = True` in the syntax to permanently store the key on the machine. - -### AlphaVantage - -> Alpha Vantage provides enterprise-grade financial market data through a set of powerful and developer-friendly data APIs and spreadsheets. From traditional asset classes (e.g., stocks, ETFs, mutual funds) to economic indicators, from foreign exchange rates to commodities, from fundamental data to technical indicators, Alpha Vantage is your one-stop-shop for real-time and historical global market data delivered through cloud-based APIs, Excel, and Google Sheets. - -
-Instructions - -Go to: https://www.alphavantage.co/support/#api-key - -[AlphaVantage](https://www.alphavantage.co/support/#api-key) - -![AlphaVantage](https://user-images.githubusercontent.com/46355364/207820936-46c2ba00-81ff-4cd3-98a4-4fa44412996f.png) - -Fill out the form, pass Captcha, and click on, "GET FREE API KEY". The issued key can be entered into the OpenBB Platform with: - -```console -openbb.keys.av(key = 'REPLACE_WITH_KEY', persist = True) -``` - -
- -### Binance - -> Binance cryptocurrency exchange - We operate the worlds biggest bitcoin exchange and altcoin crypto exchange in the world by volume - -
-Instructions - -Go to: https://www.binance.com/en/support/faq/how-to-create-api-360002502072 - -![Binance](https://user-images.githubusercontent.com/46355364/207839805-f71cf12a-62d2-41cb-ba19-0c35917abc40.png) - -These instructions should provide clear guidance for obtaining an API Key. Enter the issued credentials into the OpenBB Platform with: - -```console -openbb.keys.binance( - key = 'REPLACE_WITH_KEY', - secret = 'REPLACE_WITH_SECRET', - persist = True -) -``` - -
- -### Bitquery - -> Bitquery is an API-first product company dedicated to power and solve blockchain data problems using the ground truth of on-chain data. - -
-Instructions - -Go to: https://bitquery.io/< - -![Bitquery](https://user-images.githubusercontent.com/46355364/207840322-5532a3f9-739f-4e28-9839-a58db932882e.png) - -Click "Try GraphQL API", which opens the following screen: - -![Try GraphQL API](https://user-images.githubusercontent.com/46355364/207840576-2c51a538-dd9b-484d-b11d-40e3e424df62.png) - -After creating an account and verifying the email address, get the value for the key by clicking on the "API Key" tab. - -![Get Bitquery API Key](https://user-images.githubusercontent.com/46355364/207840833-35c1b12c-9b4b-43fe-a33e-f7b92c43a011.png) - -Enter this API key into the OpenBB Platform with: - -```console -openbb.keys.bitquery(key = 'REPLACE_WITH_KEY', persist = True) -``` - -
- -### BizToc - -> BizToc is the one-stop business and finance news hub, encapsulating the top 200 US news providers in real time. - -
-Instructions - -The BizToc API is hosted on RapidAPI. To set up, go to: https://rapidapi.com/thma/api/biztoc. - -![biztoc0](https://github.com/marban/OpenBBTerminal/assets/18151143/04cdd423-f65e-4ad8-ad5a-4a59b0f5ddda) - -In the top right, select "Sign Up". After answering some questions, you will be prompted to select one of their plans. - -![biztoc1](https://github.com/marban/OpenBBTerminal/assets/18151143/9f3b72ea-ded7-48c5-aa33-bec5c0de8422) - -After signing up, navigate back to https://rapidapi.com/thma/api/biztoc. If you are logged in, you will see a header called X-RapidAPI-Key. - -![biztoc2](https://github.com/marban/OpenBBTerminal/assets/18151143/0f3b6c91-07e0-447a-90cd-a9e23522929f) - -Copy the key to the clipboard, and enter this key into the OpenBB Terminal with: - -```console -openbb.keys.biztoc(key = "REPLACE_WITH_KEY", persist=True) -``` - -
- -### CoinMarketCap - -### CoinMarketCap - -> CoinMarketCap is the world's most-referenced price-tracking website for cryptoassets in the rapidly growing cryptocurrency space. Its mission is to make crypto discoverable and efficient globally by empowering retail users with unbiased, high quality and accurate information for drawing their own informed conclusions. - -
-Instructions - -Go to: https://coinmarketcap.com/api - -![CoinMarketCap](https://user-images.githubusercontent.com/46355364/207831111-3f09ed75-740e-4121-a67e-6e1f36e8ab9a.png) - -Click on, "Get Your Free API Key Now", which opens to the page: - -![CoinMarketCap](https://user-images.githubusercontent.com/46355364/207831345-06a48efe-63b2-4804-bcf9-52fa4a73f7db.png) - -Once the account has been created, copy the API key displayed within the dashboard. - -![CoinMarketCap](https://user-images.githubusercontent.com/46355364/207831705-e9f95018-bba7-49a9-b057-3443bc839861.png) - -Enter the API key into the OpenBB Platform with: - -```console -openbb.keys.cmc(key = 'REPLACE_WITH_KEY', persist = True) -``` - -
- -### Coinbase - -> Coinbase is a secure online platform for buying, selling, transferring, and storing cryptocurrency. - -
-Instructions - -Go to: https://help.coinbase.com/en/exchange/managing-my-account/how-to-create-an-api-key - -![Coinbase](https://user-images.githubusercontent.com/46355364/207841901-647f0aef-0c74-454d-b99e-367d784259f0.png) - -Follow the instructions to obtain the credentials for the specific account. Enter the three values into the OpenBB Platform with: - -```console -openbb.keys.coinbase( - key = 'REPLACE_WITH_KEY', - secret = 'REPLACE_WITH_SECRET', - passphrase = 'REPLACE_WITH_PASSPHRASE', - persist = True -) -``` - -
- -### Coinglass - -> Coinglass is a cryptocurrency futures trading & information platform,where you can find the Bitcoin Liquidations ,Bitcoin open interest, Grayscale Bitcoin Trust，Bitcoin longs vs shorts ratio and actively compare funding rates for crypto futures.Above all the quantities are shown as per their respective contract value. - -
-Instructions - -Go to: https://www.coinglass.com/ - -![Coinglass](https://user-images.githubusercontent.com/46355364/207844601-8510687a-e54f-49b9-961f-5ef6718f58ab.png) - -Click, "Log in", and then sign up for an account. This opens the page: - -![Coinglass](https://user-images.githubusercontent.com/46355364/207844637-a9321889-c4d8-4d44-95fe-a6288a17ad19.png) - -With the account created, find the assigned API key within the account profile page. Enter this value into the OpenBB Platform with: - -```console -openbb.keys.coinglass(key = 'REPLACE_WITH_KEY', persist = True) -``` - -
- -### Crypto Panic - -> CryptoPanic is a news aggregator platform indicating impact on price and market for traders and cryptocurrency enthusiasts. - -
-Instructions - -Go to: https://cryptopanic.com/developers/api/ - -![Crypto Panic](https://user-images.githubusercontent.com/46355364/207848733-27e5a804-7ae7-4ca2-88b2-848b32929b6f.png) - -Click on, ["Sign up"](https://cryptopanic.com/accounts/signup/?next=/developers/api/), and after creating, the API Key will be displayed on the documentation page, "Your free API auth token". - -![Crypto Panic](https://user-images.githubusercontent.com/46355364/207848971-3e4771b7-1faa-45fe-955f-81bd736b16b7.png) - -Enter that value in the OpenBB Platform with: - -```console -openbb.keys.cpanic(key = 'REPLACE_WITH_KEY', persist = True) -``` - -
- -### Databento - -> Databento eliminates tens of thousands of dollars in upfront expenses per dataset without sacrificing data integrity. We give you the flexibility to pick up real-time full exchange feeds and terabytes of historical data, whenever you need it. - -
-Instructions - -Go to: https://docs.databento.com/getting-started - -![Databento](https://user-images.githubusercontent.com/85772166/221944000-394e7123-5bb3-4218-b949-f0958b6353da.png) - -Click on, [Sign up](https://databento.com/signup), and after creating an account, the API key is found in the [account portal](https://databento.com/portal/keys). - -![Databento](https://user-images.githubusercontent.com/85772166/221944057-c2314909-7b7d-4f65-8e9e-287a957f54f8.png) - -Enter this into the terminal with: - -```console -openbb.keys.databento(key = 'REPLACE_WITH_KEY') -``` - -
- -### Degiro - -> DEGIRO is Europe's fastest growing online stock broker. DEGIRO distinguishes itself from its competitors by offering extremely low trading commissions. - -
-Instructions - -Go to: https://www.degiro.com/ - -![Degiro](https://user-images.githubusercontent.com/46355364/207838353-001d350c-872c-4770-a586-fb21318122eb.png) - -Click on, "Open an account", and then go through the registration process. After setting up the account, the login credentials can be entered in the OpenBB Platform with: - -```console -openbb.keys.degiro( - username = 'USERNAME', - password = 'PASSWORD', - persist = True -) -``` - -Instructions for setting up 2FA authorization are [here](https://github.com/Chavithra/degiro-connector#35-how-to-use-2fa-). - -
- -### EODHD - -> Historical End of Day, Intraday, and Live prices API, with Fundamental Financial data API for more than 120000 stocks, ETFs and funds all over the world. - -
-Instructions - -Go to: https://eodhistoricaldata.com/r/?ref=869U7F4J - -![EODHD](https://user-images.githubusercontent.com/46355364/207849214-23763c95-7314-42ae-b97d-cb5810686498.png) - -Clicking on, "Registration", opens the page: - -![EODHD](https://user-images.githubusercontent.com/46355364/207849324-00d4a916-8260-45c0-9714-289e0a0574c0.png) - -Once registered, the API Key will be next to "API TOKEN". - -![EODHD](https://user-images.githubusercontent.com/46355364/207849462-37471270-929a-45c5-a164-a84249b19231.png) - -Enter this string into the OpenBB Platform with: - -```console -openbb.keys.eodhd(key = 'REPLACE_WITH_KEY', persist = True) -``` - -
- -### Finnhub - -> With the sole mission of democratizing financial data, we are proud to offer a FREE realtime API for stocks, forex and cryptocurrency. - -
-Instructions - -Go to: https://finnhub.io/ - -![Finnhub](https://user-images.githubusercontent.com/46355364/207832028-283c3321-8c05-4ee8-b4d2-41cdc940f408.png) - -Click on, "Get free api key", to open the page: - -![Finnhub](https://user-images.githubusercontent.com/46355364/207832185-f4c8406a-3b75-4acc-b3e8-3c4b3272d4da.png) - -Once the account has been created, find the API key in the account dashboard. - -![Finnhub](https://user-images.githubusercontent.com/46355364/207832601-62007d95-410c-4d03-a5a3-b177d1894a4c.png) - -Add this key to the OpenBB Platform with: - -```console -openbb.keys.finnhub(key = 'REPLACE_WITH_KEY', persist = True) -``` - -
- -### Financial Modeling Prep - -> Enhance your application with our data that goes up to 30 years back in history. Earnings calendar, financial statements, multiple exchanges and more! - -
-Instructions - -Go to: https://site.financialmodelingprep.com/developer/docs - -[FinancialModelingPrep](https://site.financialmodelingprep.com/developer/docs) - -![FinancialModelingPrep](https://user-images.githubusercontent.com/46355364/207821920-64553d05-d461-4984-b0fe-be0368c71186.png) - -Click on, "Get my API KEY here", and sign up for a free account. - -![FinancialModelingPrep](https://user-images.githubusercontent.com/46355364/207822184-a723092e-ef42-4f87-8c55-db150f09741b.png) - -With an account created, sign in and navigate to the Dashboard, which shows the assigned token. by pressing the "Dashboard" button which will show the API key. - -![FinancialModelingPrep](https://user-images.githubusercontent.com/46355364/207823170-dd8191db-e125-44e5-b4f3-2df0e115c91d.png) - -Enter the key into the OpenBB Platform with: - -```console -openbb.keys.fmp(key = 'REPLACE_WITH_KEY', persist = True) -``` - -
- -### FRED - -> FRED is the trusted source for economic data since 1991. Download, graph, and track 819,000 US and international time series from 110 sources. - -
-Instructions - -Go to: https://fred.stlouisfed.org - -![FRED](https://user-images.githubusercontent.com/46355364/207827137-d143ba4c-72cb-467d-a7f4-5cc27c597aec.png) - -Click on, "My Account", create a new account or sign in with Google: - -![FRED](https://user-images.githubusercontent.com/46355364/207827011-65cdd501-27e3-436f-bd9d-b0d8381d46a7.png) - -After completing the sign-up, go to "My Account", and select "API Keys". Then, click on, "Request API Key". - -![FRED](https://user-images.githubusercontent.com/46355364/207827577-c869f989-4ef4-4949-ab57-6f3931f2ae9d.png) - -Fill in the box for information about the use-case for FRED, and by clicking, "Request API key", at the bottom of the page, the API key will be issued. - -![FRED](https://user-images.githubusercontent.com/46355364/207828032-0a32d3b8-1378-4db2-9064-aa1eb2111632.png) - -Enter the API key into the OpenBB Platform with: - -```console -openbb.keys.fred(key = 'REPLACE_WITH_KEY', persist = True) -``` - -
- -### GitHub - -> GitHub is where over 100 million developers shape the future of software. - -
-Instructions - -![GitHub](https://user-images.githubusercontent.com/46355364/207846953-7feae777-3c3b-4f21-9dcf-84817c732618.png) - -Sign up for, or sign in to, GitHub. Once logged in, navigate to the [apps](https://github.com/settings/apps) page, under account settings. - -![GitHub](https://user-images.githubusercontent.com/46355364/207847215-3c04003f-26ea-4e62-9c13-ea35176bb5e3.png) - -Select, "New GitHub App": - -![GitHub](https://user-images.githubusercontent.com/46355364/207847383-d24416c6-18be-43f2-ae7c-455e8372a6ed.png) - -After creating the app, the key will be issued. Enter this token into the OpenBB Platform with: - -```console -openbb.keys.github(key = 'REPLACE_WITH_KEY', persist = True) -``` - -
- -### Glassnode - -> Glassnode makes blockchain data accessible for everyone. We source and carefully dissect on-chain data, to deliver contextualized and actionable insights. - -
-Instructions - -Go to: https://studio.glassnode.com - -![Glassnode](https://user-images.githubusercontent.com/46355364/207843761-799078ff-fa64-4d39-a6eb-ba01d250be69.png) - -Click on, "Sign up", and create an account: - -![Glassnode](https://user-images.githubusercontent.com/46355364/207843795-dd2cdbdb-45eb-4c7d-b967-ae9857d4ea5d.png) - -After creating an account, navigate to the [account settings](https://studio.glassnode.com/settings/api) and generate an API Key. - -![Glassnode](https://user-images.githubusercontent.com/46355364/207843950-5f33f37d-0203-4302-a67f-198808f18e06.png) - -Enter this key in the OpenBB Platform with: - -```console -openbb.keys.glassnode(key = 'REPLACE_WITH_KEY', persist = True) -``` - -
- -### Intrinio - -> Intrinio is more than a financial data API provider – we're a real time data partner. That means we're your guide to every step of the financial data. - -
-Instructions - -Go to: https://intrinio.com/starter-plan - -![Intrinio](https://user-images.githubusercontent.com/85772166/219207307-d6605460-ae2c-46d3-8b4e-f82057cfce59.png) - -An API key will be issued with a subscription. Find the token value within the account dashboard, and enter it into the OpenBB Platform with: - -```console -openbb.keys.intrinio(key = 'REPLACE_WITH_KEY', persist = True) -``` - -
- -### Messari - -> Gain an edge over the crypto market with professional grade data, tools, and research. - -
-Instructions - -Go to: https://messari.io - -![Messari](https://user-images.githubusercontent.com/46355364/207848122-ec6a41e4-76b7-4620-adc3-1f1c19f4bca6.png) - -Click on, "Sign up", and create an account. - -![Messari](https://user-images.githubusercontent.com/46355364/207848160-6a962e3c-3007-40a3-9431-cd5ddfe5bb8e.png) - -After creating the account, navigate to the [account page](https://messari.io/account/api), and click on the tab for, API Access. - -![Messari](https://user-images.githubusercontent.com/46355364/207848324-ade5bede-8e6b-4b87-bdec-eade3217c0d8.png) - -Copy the API key and add it to the OpenBB Platform with: - -```console -openbb.keys.messari(key = 'REPLACE_WITH_KEY', persist = True) -``` - -
- -### News API - -> News API is a simple, easy-to-use REST API that returns JSON search results for current and historic news articles published by over 80,000 worldwide sources. - -
-Instructions - -Go to: https://newsapi.org - -![News API](https://user-images.githubusercontent.com/46355364/207828250-0c5bc38c-90b4-427d-a611-b43c98c8e7ab.png) - -Click on, "Get API Key", and fill out the form. - -![News API](https://user-images.githubusercontent.com/46355364/207828421-76922bc2-cde0-493f-9eed-7f90eb831779.png) - -Register for an account and the next screen will provide the API Key. - -![News API](https://user-images.githubusercontent.com/46355364/207828736-f0fce53b-f302-4456-adf9-8d50ac41fbe2.png) - -Add this API key into the OpenBB Platform with: - -```console -openbb.keys.news(key = 'REPLACE_WITH_KEY', persist = True) -``` - -
- -### Oanda - -> OANDA's Currency Converter allows you to check the latest foreign exchange average bid/ask rates and convert all major world currencies. - -
-Instructions - -Go to: https://developer.oanda.com - -![Oanda](https://user-images.githubusercontent.com/46355364/207839324-d30aa2b6-be83-41ff-9b1b-146cac566789.png) - -After creating an account, follow the steps below. - -![Oanda](https://user-images.githubusercontent.com/46355364/207839246-eb40f093-b583-4edd-b178-99fe399bfb66.png) - -Upon completion of the account setup, enter the credentials into the OpenBB Platform with: - -```console -openbb.keys.oanda( - account = 'REPLACE_WITH_ACCOUNT', - access_token = 'REPLACE_WITH_TOKEN', - account_type = 'REPLACE_WITH_LIVE_OR_PRACTICE', - persist = True -) -``` - -
- -### Polygon - -> Live & historical data for US stocks for all 19 exchanges. Instant access to real-time and historical stock market data. - -
-Instructions - -Go to: https://polygon.io - -![Polygon](https://user-images.githubusercontent.com/46355364/207825623-fcd7f0a3-131a-4294-808c-754c13e38e2a.png) - -Click on, "Get your Free API Key". - -![Polygon](https://user-images.githubusercontent.com/46355364/207825952-ca5540ec-6ed2-4cef-a0ed-bb50b813932c.png) - -After signing up, the API Key is found at the bottom of the account dashboard page. - -![Polygon](https://user-images.githubusercontent.com/46355364/207826258-b1f318fa-fd9c-41d9-bf5c-fe16722e6601.png) - -Enter the key into the OpenBB Platform with: - -```console -openbb.keys.polygon(key = 'REPLACE_WITH_KEY', persist = True) -``` - -
- -### Quandl - -> The premier source for financial, economic, and alternative datasets, serving investment professionals. Quandl’s platform is used by over 400,000 people, including analysts from the world’s top hedge funds, asset managers and investment banks. - -
-Instructions - -![Quandl](https://user-images.githubusercontent.com/46355364/207823899-208a3952-f557-4b73-aee6-64ac00faedb7.png) - -Click on, "Sign Up", and register a new account. - -![Quandl](https://user-images.githubusercontent.com/46355364/207824214-4b6b2b74-e709-4ed4-adf2-14803e6f3568.png) - -Follow the sign-up instructions, and upon completion the API key will be assigned. - -![Quandl](https://user-images.githubusercontent.com/46355364/207824664-3c82befb-9c69-42df-8a82-510d85c19a97.png) - -Enter the key into the OpenBB Platform with: - -```console -openbb.keys.quandl(key = 'REPLACE_WITH_KEY', persist = True) -``` - -
- -### Reddit - -> Reddit is a network of communities where people can dive into their interests, hobbies and passions. - -
-Instructions - -Sign in to Reddit, and then go to: https://old.reddit.com/prefs/apps/ - -![Reddit](https://preview.redd.it/540vrn3k0cn91.png?width=986&format=png&auto=webp&v=enabled&s=88228cd0cf4415b3487b8d35e1097f0caa804e15) - -Scroll down and click on "create application", selecting "script". - -![Reddit](https://preview.redd.it/7je4ehqa1cn91.png?width=916&format=png&auto=webp&v=enabled&s=dbdf65ccc0820cfe28eff8e81cba056f4fd8263e) - -Once the application is created, you must register it [here](https://old.reddit.com/wiki/api) - -![Reddit](https://user-images.githubusercontent.com/46355364/207834105-665180be-c2b6-43c8-b1c9-477729905010.png) - -Click on, "Read the full API terms and sign up for usage", and fill out the form. - -![Reddit](https://user-images.githubusercontent.com/46355364/207834850-32a0d4c8-9990-4919-94e3-abad1487a3bd.png) - -After submitting the form, check for a confirmation email. The credentials will be displayed [here](https://old.reddit.com/prefs/apps/), add them to the OpenBB Platform with: - -```console -openbb.keys.reddit( - client_id = 'REPLACE_WITH_CLIENT_ID', - client_secret = 'REPLACE_WITH_CLIENT_SECRET', - username = 'REPLACE_WITH_REDDIT_USERNAME', - password = 'REPLACE_WITH_REDDIT_PASSWORD', - useragent = 'REPLACE_WITH_USER_AGENT', - persist = True -) -``` - -
- -### Robinhood - -> Robinhood has commission-free investing, and tools to help shape your financial future. - -
-Instructions - -Go to: https://robinhood.com/us/en - -![Robinhood](https://user-images.githubusercontent.com/46355364/207838058-a2311632-6459-4cfd-bc0a-639ee3931574.png) - -After registering for an account, it can be added to the OpenBB Platform with: - -```console -openbb.keys.rb( - username = 'REPLACE_WITH_USERNAME', - password = 'REPLACE_WITH_PASSWORD', - persist = True -``` - -The first login will request 2FA authorization from the device connected to the account. - -
- -### Santiment - -> We provide tools to help you analyze crypto markets and find data-driven opportunities to optimize your investing. - -
-Instructions - -Go to: https://app.santiment.net - -![Santiment](https://user-images.githubusercontent.com/46355364/207849709-a5f10b03-138c-4e09-89f6-8a18cfbaf008.png) - -Click on, "Sign up", and register for an account. - -![Santiment](https://user-images.githubusercontent.com/46355364/207849732-4bae61de-2f62-4919-b85d-f418f1bbd0c4.png) - -Navigate to the [account dashboard](https://app.santiment.net/account#api-keys) and generate a key. - -![Santiment](https://user-images.githubusercontent.com/46355364/207849839-31d1d0a7-6936-4ebd-a7f8-1292f6317b07.png) - -Add it to the OpenBB Platform with: - -```console -openbb.keys.santiment(key = 'REPLACE_WITH_KEY', persist = True) -``` - -
- -### ShroomDK - -> ShroomDK (Platform), by Flipside Crypto gives you programmatic query access to the most comprehensive blockchain data sets in Web3, for free. - -
-Instructions - -Go to: https://sdk.flipsidecrypto.xyz/shroomdk - -![ShroomDK](https://user-images.githubusercontent.com/46355364/207850122-b8cd225e-0a65-4ea8-8069-0b40fff1600e.png) - -Click "Mint Your ShroomDK API Key", and sign up for an account. - -![ShroomDK](https://user-images.githubusercontent.com/46355364/207850176-f29cc73b-2b55-46e8-bce3-62c9342b6599.png) - -Once created, connect a wallet to complete minting the NFT license. The API key will be displayed under the account. - -![ShroomDK](https://user-images.githubusercontent.com/46355364/207850380-b59554af-1e65-4616-921d-e02c9ecf1aad.png) - -Enter it into the OpenBB Platform with: - -```console -openbb.keys.shroom(key = 'REPLACE_WITH_KEY', persist = True) -``` - -
- -### Stocksera - -> Empowering investors to take advantage of alternative data. We track trending tickers on social media and provide alternative data for easy due-diligence & analysis. - -
-Instructions - -Go to: https://stocksera.pythonanywhere.com - -![Stocksera](https://user-images.githubusercontent.com/46355364/207853896-ee233569-26bb-4244-b115-43ac8885757a.png) - -Click on, "Log in", and create an account. - -![Stocksera](https://user-images.githubusercontent.com/46355364/207853985-46a7a17f-b6b2-442b-886d-f68b3ba2ad5a.png) - -Once logged in, navigate to the "Developers" tab and copy the API key. - -![Stocksera](https://user-images.githubusercontent.com/46355364/207854224-e5ddace0-15d1-491c-b616-263cca0bef02.png) - -Add the key to the OpenBB Platform with: - -```console -openbb.keys.stocksera(key = 'REPLACE_WITH_KEY', persist = True) -``` - -
- -### Token Terminal - -> Token Terminal is a platform that aggregates financial data on the leading blockchains and decentralized applications. - -
-Instructions - -Go to: https://tokenterminal.com - -![Token Terminal](https://user-images.githubusercontent.com/46355364/207850735-69368b4f-6a3e-46b8-ba69-3b79d9231f15.png) - -Click on, "Log in" and sign up for an account. - -![Token Terminal](https://user-images.githubusercontent.com/46355364/207850774-2071df78-3289-4c8e-9d64-156b9ec8ad81.png) - -Verify the email address, and then navigate go to the "API" tab and copy the API key to the clipboard. - -![Token Terminal](https://user-images.githubusercontent.com/46355364/207851035-71ea3eff-a11f-4835-8592-c07b3aa3f800.png) - -Add the key to the OpenBB Platform with: - -```console -openbb.keys.tokenterminal(key = 'REPLACE_WITH_KEY', persist = True) -``` - -
- -### Tradier - -> Tradier, the home of active traders. Our open collaboration platform allows investors to truly customize their trading experience like never before. - -
-Instructions - -Go to: https://documentation.tradier.com - -![Tradier](https://user-images.githubusercontent.com/46355364/207829178-a8bba770-f2ea-4480-b28e-efd81cf30980.png) - -Click on, "Open Account", to start the sign-up process. After the account has been setup, navigate to [Tradier Broker Dash](https://dash.tradier.com/login?redirect=settings.api) and create the application. Request a sandbox access token, and enter this key into the OpenBB Platform with: - -```console -openbb.keys.tradier(key = 'REPLACE_WITH_KEY', persist = True) -``` - -
- -### Twitter - -> From breaking news and entertainment to sports and politics, get the full story with all the live commentary. - -
-Upcoming changes to the Twitter API will deprecate the current functionality, it is uncertain if the features will continue to work. - -![Twitter API](https://pbs.twimg.com/media/FooIJF3agAIU8SN?format=png&name=medium) - -
- -### Whale Alert - -> Whale Alert continuously collects and analyzes billions of blockchain transactions and related-off chain data from hundreds of reliable sources and converts it into an easy to use standardized format. Our world-class analytics and custom high speed database solutions process transactions the moment they are made, resulting in the largest and most up-to-date blockchain dataset in the world. - -
-Instructions - -Go to: https://docs.whale-alert.io -![Whale Alert](https://user-images.githubusercontent.com/46355364/207842892-3f71ee7a-6cd3-48a2-82e4-fa5ec5b13807.png) - -Click on, "sign up here". - -![Whale Alert](https://user-images.githubusercontent.com/46355364/207842992-427f1d2c-b34e-41c9-85fd-18511805fd16.png) - -After creating the account, click on, "Create", to issue the API Key. - -![Whale Alert](https://user-images.githubusercontent.com/46355364/207843214-20232465-9a52-4b66-b01a-0b8cecbdd612.png) - -Enter the key into the OpenBB Platform with: - -```console -openbb.keys.walert(key = 'REPLACE_WITH_KEY', persist = True) -``` - -
diff --git a/website/content/platform/usage/index.md b/website/content/platform/usage/index.md deleted file mode 100644 index 5fde1ff6b3ce..000000000000 --- a/website/content/platform/usage/index.md +++ /dev/null @@ -1,393 +0,0 @@ ---- -title: Basics -sidebar_position: 1 -description: The OpenBB Platform is a modern investment research platform for everyone. It is a Software Development Kit that allows you to access all the data and tools you need to make better investment decisions. -keywords: [basics, installation, commands, menus, your own data, introduction, openbb sdk, explanation, basic usage, usage, how to, openbb terminal, importing, navigation, docstrings, function, charts, display] ---- -import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - - - -## Overview - -The OpenBB Platform provides programmatic access to nearly all Terminal commands, allowing custom scripts and functions to power creations built on top of the core platform. It is easy to use and as flexible as one's imagination. The sections below will outline how to get started using it. If it isn't already installed, follow the instructions to install via [PyPi (pip)](https://docs.openbb.co/terminal/installation/pypi) or from the [source code](https://docs.openbb.co/terminal/installation/source). - -## Importing the OpenBB Platform - -No additional software is required to use the OpenBB Platform, it can be consumed directly from the command line Terminal within the virtual environment created during the installation process. - -### Terminal Command Line - -The `obb` virtual environment has both `python` and `ipython` as methods for starting a new session from scratch. - -- Step 1: Activate the `obb` virtual environment. - - `conda activate obb` - -:::note - -If this doesn't work, there may be an obvious reason why. - -- The installation was not completed. -- The terminal being used is different than the one which was used for installation. For example, Miniconda was installed using `CMD.exe` or `Anaconda Prompt`, but the current terminal is PowerShell. - -Open the same terminal used for installation and activate the `obb` environment, then enter: - -```console -conda init --all --system -``` - -`Exit` and re-open. Conda should now be callable from all terminal shell profiles. -::: - -- Step 2: Start a new Python or iPython session. - - `python` - - `ipython` - -This will display a similar message to the one below. - -```console -(obb) Steves-MacBook-Pro:OpenBBTerminal steve$ python -Python 3.10.8 | packaged by conda-forge | (main, Nov 22 2022, 08:25:13) [Clang 14.0.6 ] on darwin -Type "help", "copyright", "credits" or "license" for more information. ->>> from openbb_terminal.sdk import openbb -``` - -`ipython` will look slightly different. - -```console -(obb) Steves-MacBook-Pro:OpenBBTerminal steve$ ipython -Python 3.10.8 | packaged by conda-forge | (main, Nov 22 2022, 08:25:13) [Clang 14.0.6 ] -Type 'copyright', 'credits' or 'license' for more information -IPython 8.11.0 -- An enhanced Interactive Python. Type '?' for help. - -In [1]: from openbb_terminal.sdk import openbb -``` - -`ipython` is a good choice for exploring and working on scripts without saving them as a new file, while the plain command line version, `python`, is what a scripted `.py` file would use to run. - -### Jupyter - -Jupyter is a code editor and IDE that runs in a web browser, served over localhost. No additional installation steps are required to use it, in two flavours, `notebook` and `lab`. Both are launched from the terminal command line, after activating the `obb` virtual Python environment. - -```console -conda activate obb -jupyter lab -``` - -Or - -```console -conda activate obb -jupyter notebook -``` - -This will launch the Jupyter server and open a browser window with the application. - -![Jupyter Lab](https://github.com/OpenBB-finance/OpenBBTerminal/assets/85772166/4a289ef0-11af-4909-af7a-66fe97e9ffea) - -There will be only one choice for the kernel, `Python3 (ipykernel)`. Click on, `Select`. - -In the console window (or a new Notebook file) the OpenBB Platform is imported by entering: - -```console -from openbb_terminal.sdk import openbb -``` - -Docstrings can be viewed in a pop-up with the key command, `shift+tab`. The contents of each module (similar to the menus in the OpenBB Terminal) can be browsed by hitting the `tab` key. - -![Jupyter Lab Import](https://github.com/OpenBB-finance/OpenBBTerminal/assets/85772166/7cc04e49-57fe-4bbf-bb5e-4cfbdab62eaf) - -The `Contextual Help` window displays more details, and also previews DataFrames after they are assigned. These tools are an excellent way to understand the structure of the Platform along with the syntax for each command and argument. - -### Code Editors and IDEs - -Regardless of the code editor of choice, the program must know that the `obb` virtual Python environment exists. The steps for setting it up will vary by platform, consult the manual for the specific editor. VS Code is a recommended choice because it is free, flexible, and has integrations with GitHub and Jupyter, and has a plugin marketplace that can enhance a workspace with tools like GitHub Co-Pilot. Some code editing and IDE suites will charge a subscription for Jupyter integrations, which make them less ideal. - -:::note -Spyder is not recommended for installing or operating the OpenBB Platform. -::: - -#### Helpful VS Code Extensions - -Installing a few extensions in VS Code will improve the user experience and provide enhanced functionality. - -- Python Extension Pack (Don Jayamanne) -- Jupyter PowerToys (Microsoft) -- Jupyter Notebook Renderers -- Codeium - -Icons on the sidebar for Jupyter and Python provide quick access to the virtual environments, and a new notebook or interactive window are created with a mouse click. - -![VS Code](https://github.com/OpenBB-finance/OpenBBTerminal/assets/85772166/bf04c707-a591-47c8-a5e9-c4c0e60e302a) - -When opening a Notebook file, or a new interactive window, ensure that the correct environment is being used. If the selected environment is not the one created during installation, the OpenBB Platform will not import. - -Click on the item in the top-right of the window to select or change the environment. - -![VS Code environment](https://github.com/OpenBB-finance/OpenBBTerminal/assets/85772166/0e4904cf-4ff7-4130-b965-30b3de140392) - -The OpenBB Platform is imported with: - -```python -from openbb_terminal.sdk import openbb -``` - -## Navigation - -The layout of the OpenBB Platform is similar to the menus in the OpenBB Terminal, with each one represented as a module. Instead of a `/` in the path, it is `.`. For example, `openbb.stocks.gov` is the Government sub-module of `stocks`. - -![Navigation](https://github.com/OpenBB-finance/OpenBBTerminal/assets/85772166/ad3617fe-b84c-4bbd-9139-2563702849ba) - -The attributes for each module - and docstrings for a function - can also be printed directly to the screen, insert a question mark at the end of the string. - -```python -openbb.stocks.gov.contracts? -``` - -**Note**: For a regular `python` session, the syntax is: `help(openbb.stocks.gov.contracts)` - -```python -Signature: openbb.stocks.gov.contracts(symbol: str, past_transaction_days: int = 10) -> pandas.core.frame.DataFrame -Call signature: openbb.stocks.gov.contracts(*args: Any, **kwargs: Any) -> Any -Type: get_contracts -String form: -File: ~/GitHub/OpenBBTerminal/openbb_terminal/stocks/government/quiverquant_model.py -Docstring: -Get government contracts for ticker [Source: quiverquant.com] - -Parameters ----------- -symbol: str - Ticker to get congress trading data from -past_transaction_days: int - Number of days to get transactions for - -Returns -------- -pd.DataFrame - Most recent transactions by members of U.S. Congress -``` - -## Docstrings - -Docstrings are the Platform equivalent to the Terminal's `--help` argument. They contain information on the functions, its input parameters, and the type of data being returned. The Contextual Help window, in Jupyter, is a very convenient way to keep this information on hand. Referencing the docstrings will greatly reduce the need to consult the online documentation pages. - -![Docstrings](https://github.com/OpenBB-finance/OpenBBTerminal/assets/85772166/ffbfcdec-c16e-41e7-8828-b099325910a5) - -## API Keys - -The `keys` module provides methods for managing access credentials to data sources. If the API keys have already been set in a locally installed OpenBB Terminal application, no further action is required. A new installation can be authorized using the OpenBB Hub, or they can be entered manually in the Platform. For instructions on obtaining and authorizing each individual source, see the guide [here](https://docs.openbb.co/platform/usage/guides/api-keys). A key can be stored permanently, or only for the active session. Use the `persist` boolean argument to remember or forget it. - -```python -openbb.keys.fred(key= "REPLACE_WITH_YOUR_KEY", persist=True) -``` - -### Authorize With the OpenBB Hub - -API keys can be imported to the session by logging in to an [OpenBB Hub account](https://my.openbb.co/app/sdk/api-keys). The session can persist, if desired, otherwise they will be valid only for the current session. We recommend connecting to Hub by generating a Personal Access Token. Follow the [link](https://my.openbb.co/app/sdk/api-keys), scroll to the bottom of the page, and click the "Generate" button. - -![OpenBB Personal Access Token](https://github.com/OpenBB-finance/OpenBBTerminal/assets/85772166/8c3988b4-cba9-4008-b8f3-04eef72878be) - -Copy the generated token and enter as the value for the `token` parameter, ignoring the email and password fields. By default, the credentials will be forgotten when the Platform session is terminated. - -```python -openbb.login? -``` - -```python -Signature: -openbb.login( - email: str = '', - password: str = '', - token: str = '', - keep_session: bool = False, - silent: bool = False, -) -Docstring: -Login and load user info. -If there is a saved session it will be used (this can be achieved by `keep_session=True`). -If there's not a local session, -the user can use either email and password or the OpenBB Personal Access Token. - -Parameters ----------- -email : str - The email. -password : str - The password. -token : str - The OpenBB Personal Access Token. -keep_session : bool - Keep the session, i.e., next time the user logs in, - there is no need to enter the email and password or the token. -silent : bool - If True, the console print will be silent. - -Examples --------- ->>> from openbb_terminal.sdk import openbb ->>> openbb.login(email="your_email", password="your_password") -File: ~/GitHub/OpenBBTerminal/openbb_terminal/core/session/sdk_session.py -Type: function -``` - -Login with an access token with the syntax: - -```python -openbb.login(token = "REPLACE_WITH_THE_PERSONAL_ACCESS_TOKEN") -``` - -The token can be revoked from the OpenBB Hub API Keys page, by clicking on the `Regenerate` button, which will invalidate the current one. - -## How to Use the Platform - -The syntax examples provided assume that the Platform has already been imported. - -```python -from openbb_terminal.sdk import openbb -``` - -### Function Inputs - -The majority of parameters accept a string as the input. The docstrings will describe the expected inputs, but most will follow these general guidelines, unless otherwise stated: - -- String values are surrounded by quotation marks, or a single apostrophe. - - `"the string"`, or `'the string to enter'` -- Some commands expect a list for the main input, and are contained within square brackets, with each item separated by a comma. - - `["the first string", "the second string"]` - - `openbb.stocks.quote(["SPY", "QQQ", "IWM", "AAPL", "MSFT", "TSLA", "GOOG", "META", "AMZN"])` -- Dates are entered as a string, and follow the format: "YYYY-MM-DD". - - `openbb.stocks.load("SPY", start_date="1994-01-01")` -- When the expected input of a parameter is an integer or float value, they are enertered without quotes. - - `limit = 10` -- Boolean arguments are always capitalized. - - True - - False - -### Function Responses - -Most data objects returned by functions are Pandas DataFrames, and the results will be printed without first assigning it to a variable. - -```python -openbb.stocks.quote("SPY") -``` - -![Data Response](https://github.com/OpenBB-finance/OpenBBTerminal/assets/85772166/cb932ee1-3a87-4744-81a5-840c452eac51) - -The presentation of the responses will vary by platform, the sample above is from Jupyter Lab. When the same function in the Terminal outputs a chart, the response is separated into the model and view components. The Platform map will show two functions for the same command where the second has `_chart` added on. Using this second command will display the chart while the former returns the raw Pandas DataFrame. - -![Model and View](https://github.com/OpenBB-finance/OpenBBTerminal/assets/85772166/08bccaae-13f3-4fcd-857c-13cd30250492) - -```python -data = openbb.stocks.load("SPY", weekly = True) -openbb.ta.atr_chart(data, symbol = "SPY") -``` - -If the Platform session is from the command line (`python` or `ipython`), a window will open to display the chart. Within an IDE, or Jupyter Notebook, they will be displayed inline and will not have the same toolbars. - -![openbb.ta.atr_chart](https://github.com/OpenBB-finance/OpenBBTerminal/assets/85772166/b668556b-27a5-49cc-989b-8d7de1e420e2) - -### Passing Data Through - -Using the output of one function to feed another input will be a common workflow. Basic operations do not require importing any Python packages. The example below adds a new column, with the 20-day simple moving average, to the existing DataFrame. - -```python -data = openbb.stocks.load('VOO', start_date = "2022-05-15") -data["SMA"] = openbb.ta.sma(data = data["Close"], length = 20) -``` - -The code block below takes the top ten results from the `unusual_volume` [screener preset](https://docs.openbb.co/platform/usage/intros/stocks/stocks-screener), gets a single DataFrame with the daily returns for each ticker YTD, then identifies the date of the best performing day. These operations will require importing the Pandas library to the session. - -```python -import pandas as pd - -results = openbb.stocks.screener.screener_data('unusual_volume') -tickers = results.sort_values(by = "Volume", ascending = False).head(10)["Ticker"].to_list() -openbb.stocks.quote(tickers) -ytd_returns = openbb.stocks.ca.hist(tickers, start_date = '2023-01-01', candle_type = 'r') -date = ytd_returns.idxmax() -returns = ytd_returns.max() -max_returns = pd.concat([date,returns], axis = 1) -max_returns.columns = ["Date", "Returns"] - -max_returns -``` - -| | Date | Returns | -|:-----|:--------------------|----------:| -| GSIT | 2023-05-12 00:00:00 | 2.10366 | -| WISA | 2023-03-27 00:00:00 | 0.894737 | -| LMFA | 2023-05-15 00:00:00 | 0.399731 | -| OKE | 2023-05-05 00:00:00 | 0.0300176 | -| GETR | 2023-05-12 00:00:00 | 0.450151 | -| MMP | 2023-05-15 00:00:00 | 0.12994 | -| ORMP | 2023-05-15 00:00:00 | 0.106007 | -| MGOL | 2023-03-28 00:00:00 | 0.322957 | -| TIVC | 2023-01-12 00:00:00 | 0.19 | -| REAL | 2023-05-08 00:00:00 | 0.191304 | - -### OpenBB Figure Objects - -Functions returning a chart will have a boolean argument labeled, `external_axes`. When this is set as `True`, and the function's output is assigned to a variable, a Plotly figure object is returned, which can be manipulated accordingly. Copy the block below to see all of the parameters that can be set. - -```python -data = openbb.stocks.candle("SPY", external_axes = True) -data? -``` - -![OpenBB Figure](https://github.com/OpenBB-finance/OpenBBTerminal/assets/85772166/71f272f4-49eb-42c7-bd93-bd06f364ce32) - -Charts called from a command line session, will open a new window and appear the same as they are in the OpenBB Terminal application. - -![OpenBB Terminal Charts](https://user-images.githubusercontent.com/85772166/233247951-e011fe2c-23a6-4518-bd17-3f43a9c2011a.png) - -See the page [here](https://docs.openbb.co/terminal/usage/basics#charts) for a detailed explanation of the toolbar. - -To create an empty figure object, import the `OpenBBFigure` class directly. - -```python -from openbb_terminal.core.plots import OpenBBFigure -fig = OpenBBFigure() -``` - -### Chart Themes - -Themes used by the charting and tables libraries are accessible in the Platform through a separate import statement. - -```python -from openbb_terminal import theme -``` - -Print the path to the location of the style files with: - -```python -theme.plt_styles_available -``` - -Set the charts theme as light or dark: - -```python -theme.apply_style('light') -``` - -Refer to the [Plotly documentation](https://plotly.com/python/templates/) for details on customizing style sheets. - -### Chart Cheat Sheet - -![OpenBB Chart Cheat Sheet](https://user-images.githubusercontent.com/85772166/234313541-3d725e1c-ce48-4413-9267-b03571e0eccd.png) - -### Changing Data Sources - -The source of the data can be specified - where more than one is available - by including the `source` argument in the syntax. - -```python -polygon = openbb.stocks.load("SPY", source = "Polygon") -eodhd = openbb.stocks.load("SPY", source = "EODHD") -av = openbb.stocks.load("SPY", source = "AlphaVantage") -intrinio = openbb.stocks.load("SPY", source = "Intrinio") -databento = openbb.stocks.load("SPY", source = "DataBento") -``` - -## Support, Bug Reports & Feedback - -Issues can be raised through the [support page](https://my.openbb.co/app/sdk/support) or on [GitHub](https://github.com/OpenBB-finance/OpenBBTerminal/issues/new/choose). You can also chat with the community on [Discord](https://openbb.co/discord) to find help or inspiration. Feedback is always welcome. diff --git a/website/content/platform/usage/intros/_category_.json b/website/content/platform/usage/intros/_category_.json deleted file mode 100644 index f93c4207f740..000000000000 --- a/website/content/platform/usage/intros/_category_.json +++ /dev/null @@ -1,4 +0,0 @@ -{ - "label": "Intros", - "position": 2 -} diff --git a/website/content/platform/usage/intros/alternative.md b/website/content/platform/usage/intros/alternative.md deleted file mode 100644 index c533e1a8e39f..000000000000 --- a/website/content/platform/usage/intros/alternative.md +++ /dev/null @@ -1,181 +0,0 @@ ---- -title: Alternative -keywords: [alternative data, alternative, data, alt, openbb terminal, sdk, how to, usage, oss, covid, examples] -description: The Alternative module provides programmatic access to the commands from within the OpenBB Terminal. Import the OpenBB Platform module, and then access the functions similarly to how the Terminal menus are navigated. ---- - -import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - - - -The Alternative module provides programmatic access to the commands from within the OpenBB Terminal. Import the OpenBB Platform module, and then access the functions similarly to how the Terminal menus are navigated. The code completion will be activated upon entering `.`, after, `openbb.alt` - -## How to Use -​ -The examples provided below will assume that the following import block is included at the beginning of the Python script or Notebook file: -​ -```python -from openbb_terminal.sdk import openbb -import pandas as pd -``` - -A brief description below highlights the main Functions and Modules available in the Alternative Platform - -### OSS - -|Path |Type | Description | -| :--------- | :---------: | ----------: | -|openbb.alt.oss.top |Function |Get top repositories | -|openbb.alt.oss.search |Function |Search repositories | -|openbb.alt.oss.history |Function |Display a repo star history | -|openbb.alt.oss.ross |Function |Startups from ross index | -|openbb.alt.oss.github_data |Function |Get repository stats | -|openbb.alt.oss.summary |Function |Get repository summary | -### Covid - -|Path |Type | Description | -| :--------- | :---------: | ----------: | -|openbb.alt.covid.global_deaths |Function |historical deaths for given country | -|openbb.alt.covid.slopes |Function |Load cases and find slope over period | -|openbb.alt.covid.stat |Function |Show historical cases and deaths by country | -|openbb.alt.covid.global_cases |Function |historical cases for given country | -|openbb.alt.covid.ov |Function | overview historical cases and deaths by country | - - -Alternatively you can print the contents of the Alternative Platform with: -​ -```python -help(openbb.alt.covid) -help(openbb.alt.oss) -``` - -## Examples - OSS - - -:::note - -To use some of the OSS Platform commands you will need a GitHub API key - you can get one [here](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token) - - -::: -### alt.oss.top -​ -The alt.oss.top Platform command lets you display top repositories - You can pass different parameters like `sortby` `categories` and `limit` to enhance the output. -​ -```python -summary = pd.DataFrame.from_dict(openbb.alt.oss.top(sortby='stars', categories='finance', limit=10)) -print(summary[['full_name', 'open_issues', 'stargazers_count']]) -``` - -|full_name |open_issues |stargazers_count| -| :--------- | :---------: | ----------: | -| vnpy/vnpy | 8 | 19487| -| OpenBB-finance/OpenBBTerminal | 149 | 17645| -| plotly/dash | 707 | 17645| -| waditu/tushare | 556 | 11829| -| wilsonfreitas/awesome-quant | 9 | 10874| -| microsoft/qlib | 232 | 9926| -| firefly-iii/firefly-iii | 103 | 9228| -| ranaroussi/yfinance | 441 | 7938| -| mrjbq7/ta-lib | 181 | 7157| -| QuantConnect/Lean | 417 | 6773| - -### alt.oss.summary - -The alt.oss.summary Platform command gets you some info on a reposity - You just pass the repo path and can see all kinds of interesting information. - -```python -summary = pd.DataFrame.from_dict(openbb.alt.oss.summary(repo="openbb-finance/openbbterminal")) -print(summary) -``` - -|Metric |Value | -| :--------- | ---------: | -| Name | OpenBBTerminal | -| Owner | OpenBB-finance | -| Creation Date | 2020-12-20 | -| Last Update | 2022-11-17 | -| Topics | artificial-intelligence, crypto, cryptocurrenc... | -| Stars | 17643 | -| Forks | 1849 | -| Open Issues | 152 | -| Language | Python | -| License | MIT License | -| Releases | 10 | -| Last Release Downloads | 10201 | -​ -## Examples - Covid - -### alt.covid.global_deaths - -The global_deaths command lets you check quickly the global deaths for any `country` -​ -```python -global_deaths = pd.DataFrame.from_dict(openbb.alt.covid.global_deaths(country="US")) -print(global_deaths) -``` - -|Date |US | -| :--------- | ---------: | -| 2020-01-23 | 0.0| -| 2020-01-24 | 0.0| -| 2020-01-25 | 0.0| -| 2020-01-26 | 0.0| -| 2020-01-27 | 0.0| -| ... | ...| -| 2022-11-12 | -40.0| -| 2022-11-13 | 1.0| -| 2022-11-14 | 216.0| -| 2022-11-15 | 387.0| -| 2022-11-16 | 825.0| - -### alt.covid.slopes - -The slopes command lets you check the slopes per country - -```python -covid_slopes = pd.DataFrame.from_dict(openbb.alt.covid.slopes()) -print(covid_slopes) -``` -|Country |Slope | -| :--------- | ---------: | -|Japan | 52199.941713| -|Korea, South | 42252.945717| -|Germany | 40376.811123| -|US | 38365.586207| -|Taiwan* | 28677.574861| -|France | 24898.053393| -|Italy | 20608.297664| -|Greece | 7841.223359| -|Australia | 6222.661846| -|Russia | 5837.264739| -|Chile | 5792.311457| -|Brazil | 5605.621802| -|United Kingdom | 4755.022692| -|Singapore | 3867.323471| -|Switzerland | 3393.054950| -|Malaysia | 3154.148387| -|... | ... | - - -You can pass `days_back` `limit` and `ascend` to further drill down in your data. - -```python -covid_slopes_params = pd.DataFrame.from_dict( - openbb.alt.covid.slopes(days_back=30, limit=10, ascend=True) -) -print(covid_slopes_params) -``` - -|Country |Slope | -| :--------- | ---------: | -| Colombia | -9917.200222| -| Iran | -4000.273415| -| Slovakia | -3553.934372| -| Poland | -563.439600| -| Lebanon | -364.833815| -| Bangladesh| -175.475640| -| Albania | -96.862736| -| Bulgaria | -39.990656| -| Turkey | -31.636263| -| Belarus | -21.939043| diff --git a/website/content/platform/usage/intros/crypto/discovery.md b/website/content/platform/usage/intros/crypto/discovery.md deleted file mode 100644 index fd937ce5d8f2..000000000000 --- a/website/content/platform/usage/intros/crypto/discovery.md +++ /dev/null @@ -1,130 +0,0 @@ ---- -title: Discovery -keywords: [cryptocurrency, discovery, nft, app, decentralized, coins, function, sub-module, openbb.crypto, openbb sdk, sdk, import statement, load, candles, find, active address, trades, coin_list, baas, trending, news] -description: An Introduction to Cryptocurrency Discovery, within the Cryptocurrency Menu, with a brief overview of the features. ---- - -import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - - - -The Discovery sub-module contains the tools for finding new trends in Crpyto markets and making new discoveries. The commands within the menu are listed below along with a short description. The module is accessed by entering, `openbb.crypto.disc`, and then a `.` activates code completion and type hints. - -## How to Use - -|Path |Description | -|:----|-----------:| -|openbb.crypto.disc.categories_keys |A List of Categories for Searching Coins | -|openbb.crypto.disc.coin_list |A List of Coins Available on CoinGecko | -|openbb.crypto.disc.coins |Search Coins on CoinGecko by Category | -|openbb.crypto.disc.coins_for_given_exchange |A Dictionary of all Trading Pairs on Binance | -|openbb.crypto.disc.cpsearch |Search CoinPaprika | -|openbb.crypto.disc.gainers |Top Gainers Over Different Periods | -|openbb.crypto.disc.losers |Top Losers Over Different Periods | -|openbb.crypto.disc.top_coins |The Top Movers | -|openbb.crypto.disc.top_dapps |The Top DeFi Applications by Daily Volume and Users | -|openbb.crypto.disc.top_dexes |The Top DeFi Exchanges | -|openbb.crypto.disc.top_games |The Top DeFi Games | -|openbb.crypto.disc.top_nfts |The Top NFTs | -|openbb.crypto.disc.trending |Trending Coins on CoinGecko | - -## Examples - -The examples below will assume the import statement block is included at the top of the file. - -```python -from openbb_terminal.sdk import openbb -``` - -### Coins - -Search coins on CoinGecko, or compare them all. - -```python -openbb.crypto.disc.coins().head(5) -``` - -| | id | symbol | name | image | current_price | market_cap | market_cap_rank | fully_diluted_valuation | total_volume | high_24h | low_24h | price_change_24h | price_change_percentage_24h | market_cap_change_24h | market_cap_change_percentage_24h | circulating_supply | total_supply | max_supply | ath | ath_change_percentage | ath_date | atl | atl_change_percentage | atl_date | roi | last_updated | price_change_percentage_14d_in_currency | price_change_percentage_1h_in_currency | price_change_percentage_1y_in_currency | price_change_percentage_200d_in_currency | price_change_percentage_24h_in_currency | price_change_percentage_30d_in_currency | price_change_percentage_7d_in_currency | -|----:|:--------------|:---------|:--------------|:--------------------------------------------------------------------------------------|----------------:|-------------:|------------------:|--------------------------:|---------------:|-------------:|-------------:|-------------------:|------------------------------:|------------------------:|-----------------------------------:|---------------------:|---------------:|-------------:|-------------:|------------------------:|:-------------------------|------------:|------------------------:|:-------------------------|:----------------------------------------------------------------------------------|:-------------------------|------------------------------------------:|-----------------------------------------:|-----------------------------------------:|-------------------------------------------:|------------------------------------------:|------------------------------------------:|-----------------------------------------:| -| 170 | 0x | zrx | 0x | https://assets.coingecko.com/coins/images/863/large/0x.png?1547034672 | 0.192066 | 162596592 | 171 | 1.91855e+08 | 7.92999e+06 | 0.198545 | 0.190939 | -0.00511834 | -2.59572 | -4.64766e+06 | -2.77897 | 8.47496e+08 | 1e+09 | 1e+09 | 2.5 | -92.3016 | 2018-01-13T00:00:00.000Z | 0.120667 | 59.3019 | 2020-03-13T02:27:49.563Z | {'times': 3.00137262387235, 'currency': 'usd', 'percentage': 300.137262387235} | 2022-12-05T22:57:31.604Z | 6.39773 | 0.236744 | -78.329 | -48.4052 | -2.59572 | -31.7183 | -0.08195 | -| 97 | zilliqa | zil | Zilliqa | https://assets.coingecko.com/coins/images/2687/large/Zilliqa-logo.png?1547036894 | 0.0227407 | 344299494 | 98 | 4.77046e+08 | 1.92004e+07 | 0.0235163 | 0.0226905 | -0.000172456 | -0.75265 | -2.93894e+06 | -0.84638 | 1.51564e+10 | 2.1e+10 | 2.1e+10 | 0.255376 | -91.0876 | 2021-05-06T17:33:45.940Z | 0.00239616 | 849.86 | 2020-03-13T02:22:55.161Z | {'times': 1.131460045428967, 'currency': 'eth', 'percentage': 113.14600454289669} | 2022-12-05T22:57:22.010Z | 7.01544 | -0.119826 | -67.7389 | -52.7247 | -0.752652 | -30.9379 | -0.991144 | -| 189 | zencash | zen | Horizen | https://assets.coingecko.com/coins/images/691/large/horizen.png?1555052241 | 10.64 | 139250373 | 190 | 2.22972e+08 | 5.44128e+06 | 11.07 | 10.62 | -0.264045 | -2.42165 | -3.61206e+06 | -2.52835 | 1.31149e+07 | 2.1e+07 | 2.1e+07 | 165.92 | -93.5817 | 2021-05-08T06:00:30.087Z | 3.26 | 226.208 | 2019-10-17T00:00:00.000Z | | 2022-12-05T22:57:34.376Z | 21.2037 | -0.57332 | -86.651 | -44.0292 | -2.42165 | -25.8735 | 11.1271 | -| 63 | zcash | zec | Zcash | https://assets.coingecko.com/coins/images/486/large/circle-zcash-color.png?1547034197 | 46.24 | 602735976 | 64 | 9.69752e+08 | 3.57518e+07 | 47.32 | 45.31 | 0.479718 | 1.04838 | 5.91658e+06 | 0.99135 | 1.30523e+07 | 2.1e+07 | 2.1e+07 | 3191.93 | -98.5521 | 2016-10-29T00:00:00.000Z | 19.75 | 133.959 | 2020-03-13T02:20:55.002Z | | 2022-12-05T22:57:30.607Z | 21.4551 | 0.502131 | -75.4374 | -53.9461 | 1.04838 | -14.1037 | 13.3262 | -| 141 | yearn-finance | yfi | yearn.finance | https://assets.coingecko.com/coins/images/11849/large/yfi-192x192.png?1598325330 | 7082.34 | 220754373 | 142 | 2.59099e+08 | 4.54938e+07 | 7472.6 | 7052.76 | -157.22 | -2.17168 | -5.96275e+06 | -2.63004 | 31239.8 | 36666 | 36666 | 90787 | -92.1948 | 2021-05-12T00:29:37.713Z | 31.65 | 22292.3 | 2020-07-18T12:26:27.150Z | | 2022-12-05T22:57:24.815Z | 15.7094 | -0.124164 | -71.239 | -22.0297 | -2.17168 | -15.4178 | 13.2592 | - -Coins can be filtered by category. For a list of defined categories enter: - -```python -categories:dict = openbb.crypto.disc.categories_keys() -``` - -The category chosen below is called, `big-data`. - -```python -openbb.crypto.disc.coins(category = categories[10], sortby = 'market_cap').head(5) -``` - -| | id | symbol | name | image | current_price | market_cap | market_cap_rank | fully_diluted_valuation | total_volume | high_24h | low_24h | price_change_24h | price_change_percentage_24h | market_cap_change_24h | market_cap_change_percentage_24h | circulating_supply | total_supply | max_supply | ath | ath_change_percentage | ath_date | atl | atl_change_percentage | atl_date | roi | last_updated | price_change_percentage_14d_in_currency | price_change_percentage_1h_in_currency | price_change_percentage_1y_in_currency | price_change_percentage_200d_in_currency | price_change_percentage_24h_in_currency | price_change_percentage_30d_in_currency | price_change_percentage_7d_in_currency | -|---:|:-----------------|:---------|:---------|:-----------------------------------------------------------------------------------------|----------------:|-------------:|------------------:|--------------------------:|-----------------:|-----------:|----------:|-------------------:|------------------------------:|------------------------:|-----------------------------------:|---------------------:|---------------:|-------------:|----------:|------------------------:|:-------------------------|-----------:|------------------------:|:-------------------------|:------------------------------------------------------------------------------------|:-------------------------|------------------------------------------:|-----------------------------------------:|-----------------------------------------:|-------------------------------------------:|------------------------------------------:|------------------------------------------:|-----------------------------------------:| -| 0 | dock | dock | Dock | https://assets.coingecko.com/coins/images/3978/large/dock-icon-dark-large.png?1623764407 | 0.0163913 | 7.04484e+07 | 295 | nan | 567668 | 0.0170636 | 0.0163263 | -0.00031004 | -1.85637 | -2.34457e+06 | -3.22088 | 0 | 1e+09 | nan | 0.241848 | -93.2225 | 2018-05-04T05:29:09.155Z | 0.00259319 | 532.083 | 2020-03-13T02:24:35.312Z | {'times': -0.8420344706449371, 'currency': 'eth', 'percentage': -84.20344706449372} | 2022-12-05T23:04:48.481Z | 11.105 | 0.113349 | -79.607 | -17.3245 | -1.85637 | -19.6563 | 0.481131 | -| 1 | covalent | cqt | Covalent | https://assets.coingecko.com/coins/images/14168/large/covalent-cqt.png?1624545218 | 0.099484 | 4.18854e+07 | 431 | 9.95348e+07 | 997478 | 0.112201 | 0.095826 | -0.0110446 | -9.99251 | -4.62241e+06 | -9.93901 | 4.20811e+08 | 1e+09 | 1e+09 | 2.08 | -95.2091 | 2021-08-14T05:30:40.858Z | 0.051932 | 91.5619 | 2022-08-01T23:38:54.301Z | | 2022-12-05T23:04:47.896Z | 16.5464 | 1.49149 | -87.4469 | -34.8706 | -9.99251 | -21.1618 | -16.3863 | -| 2 | gxchain | gxc | GXChain | https://assets.coingecko.com/coins/images/1089/large/26296223.png?1571192241 | 0.46468 | 3.48511e+07 | 476 | nan | 114097 | 0.797016 | 0.359858 | -0.331496 | -41.636 | -2.48954e+07 | -41.6683 | 7.5e+07 | 1e+08 | nan | 10.61 | -95.62 | 2018-01-13T00:00:00.000Z | 0.189778 | 144.839 | 2020-03-13T02:24:02.919Z | | 2022-12-05T23:04:01.358Z | 25.3322 | 3.68092 | -83.5683 | 13.1713 | -41.636 | -0.22209 | 31.9026 | -| 3 | insights-network | instar | INSTAR | https://assets.coingecko.com/coins/images/3504/large/2558.png?1547038269 | 0.0362529 | 2.85208e+07 | 534 | nan | 19.93 | 0.0370935 | 0.0359575 | -0.000214289 | -0.58762 | -5.51571e+06 | -16.2053 | 0 | 3e+08 | nan | 0.27882 | -86.9978 | 2022-10-02T09:16:16.012Z | 0.00467988 | 674.655 | 2020-03-13T02:22:38.395Z | {'times': -0.7583139455766651, 'currency': 'usd', 'percentage': -75.83139455766651} | 2022-12-05T18:39:15.686Z | -1.2191 | nan | 27.2158 | 113.695 | -0.587622 | -44.2698 | 3.3329 | -| 4 | bonfida | fida | Bonfida | https://assets.coingecko.com/coins/images/13395/large/bonfida.png?1658327819 | 0.392327 | 2.36672e+07 | 585 | 3.92307e+08 | 6.01989e+06 | 0.401193 | 0.386429 | -0.00802685 | -2.00494 | -441335 | -1.83062 | 6.03284e+07 | 1e+09 | 1e+09 | 18.77 | -97.9102 | 2021-11-03T20:34:33.492Z | 0.113165 | 246.695 | 2020-12-22T10:58:52.143Z | | 2022-12-05T23:04:56.497Z | -31.5948 | -0.13385 | -94.9581 | -30.7982 | -2.00494 | -5.84654 | -12.1443 | - -### Trending - -Print the trending coins on CoinGecko: - -```python -openbb.crypto.disc.trending() -``` - -| | Symbol | Name | market_cap Cap Rank | -|---:|:--------------|:--------------|----------------------:| -| 0 | chainlink | Chainlink | 21 | -| 1 | magiccraft | MagicCraft | 806 | -| 2 | apollo | Apollo | 858 | -| 3 | gmx | GMX | 86 | -| 4 | dawn-protocol | Dawn Protocol | 406 | -| 5 | evmos | Evmos | 149 | -| 6 | maple | Maple | 443 | -| 7 | aptos | Aptos | 59 | - -### Losers - -Filter coins by the changes over various windows of time, from an hour to a year. - -```python -openbb.crypto.disc.losers().head(3) -``` - -| | Symbol | Name | Price [$] | Market Cap | Market Cap Rank | Volume [$] | Change 1h [%] | -|---:|:---------|:--------------------|---------------:|-------------:|------------------:|-------------:|----------------:| -| 34 | ape | ApeCoin | 3.95 | 1430668301 | 35 | 225914151 | -0.613265 | -| 48 | theta | Theta Network | 0.879573 | 880099193 | 49 | 19024380 | -0.159237 | -| 12 | ltc | Litecoin | 80.28 | 5764526837 | 13 | 1079151325 | -0.147648 | - -Compared to the last fourteen days: - -```python -openbb.crypto.disc.losers(interval = '14d').head(3) -``` - -| | Symbol | Name | Price [$] | Market Cap | Market Cap Rank | Volume [$] | Change 14d [%] | -|---:|:---------|:----------|------------:|-------------:|------------------:|-------------:|-----------------:| -| 31 | algo | Algorand | 0.237655 | 1691877131 | 32 | 79911891 | -3.84964 | -| 22 | leo | LEO Token | 3.79 | 3541787576 | 23 | 2082712 | -2.70556 | -| 38 | flow | Flow | 1.11 | 1150005942 | 39 | 44608861 | -2.16063 | - -Over one-year: - -```python -openbb.crypto.disc.losers(interval = '1y').head(3) -``` - -| | Symbol | Name | Price [$] | Market Cap | Market Cap Rank | Volume [$] | Change 1y [%] | -|---:|:---------|:-------------------|------------:|-------------:|------------------:|-------------:|----------------:| -| 39 | lunc | Terra Luna Classic | 0.00017433 | 1042097683 | 40 | 75780496 | -99.9997 | -| 16 | sol | Solana | 13.87 | 5045641411 | 17 | 382220595 | -92.9463 | -| 43 | axs | Axie Infinity | 8.92 | 1004779023 | 44 | 707998935 | -91.6799 | diff --git a/website/content/platform/usage/intros/crypto/index.md b/website/content/platform/usage/intros/crypto/index.md deleted file mode 100644 index 26ae1d0d2ff6..000000000000 --- a/website/content/platform/usage/intros/crypto/index.md +++ /dev/null @@ -1,427 +0,0 @@ ---- -title: Crypto -keywords: [crypto, web3, nft, blockchain, cryptocurrency, sub-module, openbb.crypto, openbb sdk, sdk, import statement, load, candles, find, active address, trades, coin_list, baas, trending, news] -description: The Introduction to Cryptocurrency explains how to use the Cryptocurrency menu and provides a brief description of its sub-menus ---- - -import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - - - -The Crypto module wraps the functions of the OpenBB Terminal menu. This allows web applications and dashboards to be built quickly on top of the existing infrastructure. Navigating the functions is similar to operating the OpenBB Terminal. - -## How to Use - -The list below are all the Platform functions at the `openbb.crypto` level: - -| Path | Type | Description | -| :-------------------- | :--------: | --------------------: | -| openbb.crypto.candle | Function | OHLC+V chart | -| openbb.crypto.dd | Sub-Module | Due Diligence | -| openbb.crypto.defi | Sub-Module | DeFi | -| openbb.crypto.disc | Sub-Module | Discovery | -| openbb.crypto.find | Function | Find Digital Assets | -| openbb.crypto.load | Function | Load Historical Data | -| openbb.crypto.nft | Sub-Module | NFTs | -| openbb.crypto.onchain | Sub-Module | Onchain Metrics | -| openbb.crypto.ov | Sub-Module | Market Overview | -| openbb.crypto.price | Function | Live Prices from Pyth | -| openbb.crypto.tools | Sub-Module | Calculators | - -Alternatively, the contents of a menu is printed by running, `help(openbb.crypto)`. The objective of this guide is to introduce the high-level functions and provide a sample of examples from the sub-modules. Refer to the guides for each sub-module to learn more about them specifically. - -## Examples - -### Import Statements - -The examples in this guide will assume that the code block below is at the beginning of the Python script or Jupyter Notebook file. - -```python -import pandas as pd -from openbb_terminal.sdk import openbb -%matplotlib inline -``` - -### Load - -The `load` function is capable of loading from a variety of sources, one of which is CCXT. When `CCXT` is `source`, an additional argument, `exchange`, is required. - -```python -help(openbb.crypto.load) - -Help on Operation in module openbb_terminal.core.library.operation: - - - Load crypto currency to get data for - - Parameters - ---------- - symbol: str - Coin to get - start_date: str or datetime, optional - Start date to get data from with. - datetime or string format (YYYY-MM-DD) - 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: str or datetime, optional - End date to get data from with. - datetime or string format (YYYY-MM-DD) - source: str - The source of the data - Choose from: CCXT, CoinGecko, YahooFinance - - Returns - ------- - pd.DataFrame - Dataframe consisting of price and volume data -``` - -
- CCXT Exchange List (expand to see list of exchanges supported by CCXT) - -| | Exchange | -| --- | -----------------: | -| | aax | -| | ascendex | -| | bequant | -| | bibox | -| | bigone | -| | binance | -| | binancecoinm | -| | binanceus | -| | binanceusdm | -| | bit2c | -| | bitbank | -| | bitbay | -| | bitcoincom | -| | bitfinex | -| | bitfinex2 | -| | bitflyer | -| | bitforex | -| | bitget | -| | bithumb | -| | bitmart | -| | bitmex | -| | bitopro | -| | bitpanda | -| | bitrue | -| | bitso | -| | bitstamp | -| | bitstamp1 | -| | bittrex | -| | bitvavo | -| | bkex | -| | bl3p | -| | btcalpha | -| | btcbox | -| | btcex | -| | btcmarkets | -| | btctradeua | -| | btcturk | -| | buda | -| | bw | -| | bybit | -| | bytetrade | -| | cex | -| | coinbaseprime | -| | coinbasepro | -| | coincheck | -| | coinex | -| | coinfalcon | -| | coinmate | -| | coinone | -| | coinspot | -| | crex24 | -| | cryptocom | -| | currencycom | -| | delta | -| | deribit | -| | digifinex | -| | eqonex | -| | exmo | -| | flowbtc | -| | fmfwio | -| | ftx | -| | ftxus | -| | gate | -| | gateio | -| | gemini | -| | hitbtc | -| | bitbtc3 | -| | hollaex | -| | huobi | -| | huobijp | -| | idex | -| | independentreserve | -| | indodax | -| | itbit | -| | kraken | -| | kucoin | -| | kucoinfutures | -| | kuna | -| | latoken | -| | lbank | -| | lbank2 | -| | liquid | -| | luno | -| | lykke | -| | mercado | -| | mexc | -| | mexc3 | -| | ndax | -| | novadax | -| | oceanex | -| | okcoin | -| | okex | -| | okex5 | -| | okx | -| | paymium | -| | phemex | -| | poloniex | -| | probit | -| | qtrade | -| | ripio | -| | stex | -| | therock | -| | tidebit | -| | tidex | -| | timex | -| | tokocrypto | -| | upbit | -| | wavesexchange | -| | whitebit | -| | woo | -| | yobit | -| | zaif | -| | zb | -| | zipmex | -| | zonda | - -
- -```python -eth_df = openbb.crypto.load('ETH', source = 'CCXT', exchange = 'binance') - -eth_df.tail(5) -``` - -| date | Open | High | Low | Close | Volume | -| :------------------ | ------: | ------: | ------: | ------: | -----: | -| 2022-11-14 00:00:00 | 1221.5 | 1291.2 | 1171.13 | 1243.28 | 934742 | -| 2022-11-15 00:00:00 | 1243.29 | 1291 | 1234.01 | 1253.23 | 632826 | -| 2022-11-16 00:00:00 | 1253.22 | 1268.67 | 1187.06 | 1216.17 | 673340 | -| 2022-11-17 00:00:00 | 1216.16 | 1228.22 | 1181.05 | 1200.43 | 530537 | -| 2022-11-18 00:00:00 | 1200.42 | 1234 | 1199.18 | 1206.11 | 306400 | - -Adding the `interval` argument allows for intraday data or weekly/monthly periods to be loaded. - -```python -eth_df = openbb.crypto.load('ETH', source = 'CCXT', exchange = 'binance', interval = '30') - -eth_df.tail(3) -``` - -| date | Open | High | Low | Close | Volume | -| :------------------ | ------: | ------: | ------: | ------: | ------: | -| 2022-11-18 17:00:00 | 1207.44 | 1208.35 | 1200.36 | 1205.35 | 11359.4 | -| 2022-11-18 17:30:00 | 1205.36 | 1207.12 | 1202.5 | 1204.17 | 5878.59 | -| 2022-11-18 18:00:00 | 1204.17 | 1207.28 | 1203.26 | 1206.37 | 1540.67 | - -Loading monthly OHLC+V data looks like this: - -```python -eth_df = openbb.crypto.load('ETH', source = 'CCXT', exchange = 'binance', interval = '43200') - -eth_df.tail(3) -``` - -| date | Open | High | Low | Close | Volume | -| :------------------ | ------: | ------: | ------: | ------: | ----------: | -| 2022-09-01 00:00:00 | 1554.11 | 1789 | 1220 | 1328.72 | 2.25453e+07 | -| 2022-10-01 00:00:00 | 1328.71 | 1663.06 | 1190 | 1572.69 | 1.67681e+07 | -| 2022-11-01 00:00:00 | 1572.69 | 1680 | 1073.53 | 1204.78 | 1.6707e+07 | - -### Candles - -A loaded DataFrame is used as the input for the `candles` function: - -```python -openbb.crypto.candle(eth_df) -``` - -![openbb.crypto.candle](https://user-images.githubusercontent.com/85772166/202791587-d69c7568-69ff-46b3-b41f-146ed8796f7e.png "openbb.crypto.candle") - -Notice that the chart has no title. It can be added using the `title` argument. - -```python -openbb.crypto.candles(eth_df, title = 'ETH/USDT (Monthly)') -``` - -![openbb.crypto.candle](https://user-images.githubusercontent.com/85772166/202791726-b4a775d9-5a00-4d92-8fbc-bd26aeff62d2.png "openbb.crypto.candle") - -### Find - -Find similar coins by name, symbol, or ID. - -```python -results = openbb.crypto.find( - query = 'Genesis', - source = 'CoinPaprika', - key = 'name', -) - -results.head(5) -``` - -| | name | rank | id | symbol | type | -| --: | :------------ | ---: | :----------------- | :----- | :---- | -| 0 | Gnosis | 124 | gno-gnosis | GNO | token | -| 1 | Gene | 4696 | gene-gene | GENE | token | -| 2 | Nemesis | 4246 | nms-nemesis | NMS | token | -| 3 | Genesis Token | 7763 | gent-genesis-token | GENT | token | -| 4 | Alpha Genesis | 4732 | agen-alpha-genesis | AGEN | token | - -### Active Addresses - -Get the historical number of active wallet addresses for a token with: `openbb.crypto.dd.active`. - -```python -active_eth = openbb.crypto.dd.active(symbol = 'ETH', interval = '24h', start_date = '2017-09-01') -active_eth = active_eth.reset_index() -active_eth.rename(columns = {'v': 'Active Addresses', 't': 'Date'}, inplace = True) -active_eth.set_index(keys = ['Date'], inplace = True) - -active_eth.tail(5) -``` - -| Date | Active Addresses | -| :------------------ | ---------------: | -| 2022-11-13 00:00:00 | 426441 | -| 2022-11-14 00:00:00 | 474868 | -| 2022-11-15 00:00:00 | 469880 | -| 2022-11-16 00:00:00 | 448492 | -| 2022-11-17 00:00:00 | 463467 | - -### Trades - -Get trade-level data from a specific exchange with: `openbb.crypto.dd.trades` - -```python -trades_ethusdt = openbb.crypto.dd.trades(exchange_id = 'binance', symbol = 'ETH', to_symbol = 'USDT') - -trades_ethusdt.tail(5) -``` - -| | Date | Price | Amount | Cost | Side | -| --: | :------------------------------- | ------: | -----: | ------: | :--- | -| 495 | 2022-11-18 19:16:15.959000+00:00 | 1204.02 | 2.7033 | 3254.83 | buy | -| 496 | 2022-11-18 19:16:15.959000+00:00 | 1204.03 | 1.1769 | 1417.02 | buy | -| 497 | 2022-11-18 19:16:15.981000+00:00 | 1204.03 | 5.0493 | 6079.51 | buy | -| 498 | 2022-11-18 19:16:15.981000+00:00 | 1204.07 | 2.1126 | 2543.72 | buy | -| 499 | 2022-11-18 19:16:15.981000+00:00 | 1204.08 | 5.2811 | 6358.87 | buy | - -Use the `exchange_id` argument to return data from other venues, such as CoinBase. - -```python -trades_ethusdt = openbb.crypto.dd.trades(exchange_id = 'coinbaseprime', symbol = 'ETH', to_symbol = 'USDT') - -trades_ethusdt.tail(5) -``` - -| | Date | Price | Amount | Cost | Side | -| --: | :------------------------------- | ------: | -------: | ----------: | :--- | -| 995 | 2022-11-18 19:20:15.176000+00:00 | 1204.65 | 3.89878 | 4696.67 | sell | -| 996 | 2022-11-18 19:20:29.524000+00:00 | 1204.78 | 0.41545 | 500.526 | buy | -| 997 | 2022-11-18 19:20:29.931000+00:00 | 1204.78 | 6.2e-07 | 0.000746964 | buy | -| 998 | 2022-11-18 19:20:32.263000+00:00 | 1205.03 | 0.41536 | 500.521 | buy | -| 999 | 2022-11-18 19:20:32.274000+00:00 | 1205.03 | 3.05e-06 | 0.00367534 | buy | - -### Coin_List - -Retrieve a list of all coins available from CoinPaprika with: `openbb.crypto.ov.coin_list()` - -```python -coins = openbb.crypto.ov.coin_list() - -coins.head(10) -``` - -| | rank | id | name | symbol | type | -| --: | ---: | :--------------- | :----------- | :----- | :---- | -| 0 | 1 | btc-bitcoin | Bitcoin | BTC | coin | -| 1 | 2 | eth-ethereum | Ethereum | ETH | coin | -| 2 | 3 | usdt-tether | Tether | USDT | token | -| 3 | 4 | usdc-usd-coin | USD Coin | USDC | token | -| 4 | 5 | bnb-binance-coin | Binance Coin | BNB | coin | -| 5 | 6 | busd-binance-usd | Binance USD | BUSD | token | -| 6 | 7 | xrp-xrp | XRP | XRP | coin | -| 7 | 8 | doge-dogecoin | Dogecoin | DOGE | coin | -| 8 | 9 | ada-cardano | Cardano | ADA | coin | -| 9 | 10 | hex-hex | HEX | HEX | token | - -### BAAS (Historical Bid-Ask Average Spread) - -Measure liquidity over time for an asset with: `openbb.crypto.onchain.baas` - -```python -openbb.crypto.onchain.baas(symbol = 'ETH', to_symbol = 'USDT') -``` - -| | Date | Base currency | Quote currency | Daily spread | Average bid price | Average ask price | -| --: | :--------- | :------------ | :------------- | -----------: | ----------------: | ----------------: | -| 0 | 2022-11-08 | ETH | USDT | 26.7961 | 1480.72 | 1453.93 | -| 1 | 2022-11-09 | ETH | USDT | 87.9466 | 1255.58 | 1167.63 | -| 2 | 2022-11-10 | ETH | USDT | 24.8262 | 1248.8 | 1273.62 | -| 3 | 2022-11-11 | ETH | USDT | 365.65 | 877.792 | 1243.44 | -| 4 | 2022-11-13 | ETH | USDT | 23.2032 | 1240.23 | 1217.02 | -| 5 | 2022-11-14 | ETH | USDT | 22.5726 | 1221.92 | 1199.35 | - -### Trending - -Discover trending coins on CoinGecko with: `openbb.crypto.disc.trending()` - -```python -openbb.crypto.disc.trending() -``` - -| | Symbol | Name | market_cap Cap Rank | -| --: | :------------ | :------------------ | ------------------: | -| 0 | solana | Solana | 16 | -| 1 | chiliz | Chiliz | 36 | -| 2 | aptos | Aptos | 64 | -| 3 | elrond-erd-2 | MultiversX (Elrond) | 43 | -| 4 | algorand | Algorand | 29 | -| 5 | matic-network | Polygon | 10 | -| 6 | media-network | Media Network | 890 | - -### News - -Get crypto-focussed news with: `openbb.crypto.ov.news` - -```python -openbb.crypto.ov.news(post_kind = 'news',region = 'en', filter_= 'important', ascend = False) -``` - -| | published_at | domain | title | negative_votes | positive_votes | link | -| --: | :----------- | :----------------- | :----------------------------------------------------------------- | -------------: | -------------: | :------------------------------------------------------------------------------------------------------------------------------------------------ | -| 0 | 2022-11-18 | decrypt.co | Edward Snowden: Sanctioning of Ethereum Mixer Tornado Cash Was | 0 | 2 | https://cryptopanic.com/news/16935211/Edward-Snowden-Sanctioning-of-Ethereum-Mixer-Tornado-Cash-Was-Deeply-Illiberal-and-Profoundly-Authoritarian | -| | | | 'Deeply Illiberal and Profoundly Authoritarian' | | | | -| 10 | 2022-11-18 | theblockcrypto.com | Cardano developer Emurgo to issue fiat-pegged stablecoin called | 3 | 21 | https://cryptopanic.com/news/16933998/Cardano-developer-Emurgo-to-issue-fiat-pegged-stablecoin-called-USDA | -| | | | USDA | | | | -| 1 | 2022-11-18 | beincrypto.com | SHIB Army Remains Positive as Memecoin Social Sentiment Index | 0 | 3 | https://cryptopanic.com/news/16935115/SHIB-Army-Remains-Positive-as-Memecoin-Social-Sentiment-Index-Remains-Positive | -| | | | Remains Positive | | | | -| 17 | 2022-11-18 | u.today | Is El Salvador's President's Decision to Buy One Bitcoin per Day a | 2 | 48 | https://cryptopanic.com/news/16925762/Is-El-Salvadors-Presidents-Decision-to-Buy-One-Bitcoin-per-Day-a-Good-Idea | -| | | | Good Idea? | | | | -| 15 | 2022-11-18 | dailyhodl.com | ‘Secret’ Altcoin Goes Parabolic After Rumors of European Ban on | 0 | 3 | https://cryptopanic.com/news/16925942/Secret-Altcoin-Goes-Parabolic-After-Rumors-of-European-Ban-on-Privacy-Coins-Swirl | -| | | | Privacy Coins Swirl | | | | -| 74 | 2022-11-15 | cryptopotato.com | OKX Announces $100 Million Fund to Support Distressed Projects | 0 | 4 | https://cryptopanic.com/news/16903760/OKX-Announces-100-Million-Fund-to-Support-Distressed-Projects-Following-FTX-Crash-Report | -| | | | Following FTX Crash (Report) | | | | -| 73 | 2022-11-15 | cointelegraph.com | Thousands petition for congressional investigation of alleged | 1 | 36 | https://cryptopanic.com/news/16904296/Thousands-petition-for-congressional-investigation-of-alleged-GenslerSBF-links | -| | | | Gensler–SBF links | | | | -| 72 | 2022-11-15 | cryptonews.com | XRP Price Forecast as XRP Pumps 9%, Becomes Top Performer | 0 | 13 | https://cryptopanic.com/news/16904392/XRP-Price-Forecast-as-XRP-Pumps-9-Becomes-Top-Performer | -| 71 | 2022-11-15 | theblockcrypto.com | Kraken’s Ogilvie says staking adoption set to skyrocket | 0 | 4 | https://cryptopanic.com/news/16904805/Krakens-Ogilvie-says-staking-adoption-set-to-skyrocket | -| 79 | 2022-11-15 | zycrypto.com | SEC vs. Ripple Case Sees New Twists And Turns As Whale Holdings In | 2 | 15 | https://cryptopanic.com/news/16903258/SEC-vs-Ripple-Case-Sees-New-Twists-And-Turns-As-Whale-Holdings-In-XRP-Skyrocket | -| | | | XRP Skyrocket | | | | diff --git a/website/content/platform/usage/intros/econometrics.md b/website/content/platform/usage/intros/econometrics.md deleted file mode 100644 index bb332df7f3c7..000000000000 --- a/website/content/platform/usage/intros/econometrics.md +++ /dev/null @@ -1,393 +0,0 @@ ---- -title: Econometrics -keywords: [econometrics, statistics, regression, panel data, time series, research, thesis, university, how to, usage, examples, random effects, fixed effects, path, description, loading, dataset, ] -description: Learn about functionality and using the Econometrics menu. Its purpose is to provide the user the ability to perform statistical research on custom datasets. ---- - -import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - - - -The capabilities of the [Econometrics menu](/terminal/usage/intros/econometrics) in the OpenBB Terminal are wrapped into a powerful Platform, enabling users to work with the data in a flexible environment that can be fully customized to meet the needs of any user. The Econometrics menu's purpose is to provide the user the ability to perform statistical research on custom datasets. The menu allows the user to load in his/her own dataset(s), modify the data by adding columns or setting indices, apply statistical tests (e.g. Breusch-Godfrey autocorrelation tests) as well as OLS regressions and Panel regressions (e.g. Random Effects and Fixed Effects) - -## How to use - -Start a Python script or Notebook file and import the Platform module: - -```python -from openbb_terminal.sdk import openbb -``` - -Below is a brief description of each function within the Portfolio module: - -| Path | Type | Description | -| :-------------------------------------- | :------: | ---------------------------------------------------------------------: | -| openbb.econometrics.granger | Function | Check time-series for Granger causality (X causes Y) | -| openbb.econometrics.granger_chart | Function | Obtain a nice table of Granger causality | -| openbb.econometrics.fe | Function | Perform a Fixed Effects (fe) regression on Panel data | -| openbb.econometrics.options | Function | Obtain all options that can be used for regression techniques | -| openbb.econometrics.options_chart | Function | Get a nice table of the options | -| openbb.econometrics.dwat | Function | Check for auto-correlation with Durbin Watson | -| openbb.econometrics.dwat_chart | Function | Plot the residuals of the OLS model | -| openbb.econometrics.coint | Function | Check whether time-series are cointegrated | -| openbb.econometrics.coint_chart | Function | Show the error-correction terms plot | -| openbb.econometrics.pols | Function | Perform a Pooled OLS (pols) regression on Panel data | -| openbb.econometrics.root | Function | Check for unit root in the timeseries | -| openbb.econometrics.root_chart | Function | Show a nice table of the unit root test results | -| openbb.econometrics.bgod | Function | Check for autocorrelation with Breusch Godfrey | -| openbb.econometrics.bgod_chart | Function | Show a nice table of the autocorrelation test results | -| openbb.econometrics.re | Function | Perform a Random Effects (re) regression on Panel data | -| openbb.econometrics.bols | Function | Perform a Between OLS (bols) regression on Panel data | -| openbb.econometrics.panel | Function | Obtain the regression results wrapper | -| openbb.econometrics.get_regression_data | Function | Obtain an OLS model wrapper | -| openbb.econometrics.norm | Function | Check whether the time-series is normally distributed | -| openbb.econometrics.norm_chart | Function | Show a histogram of the time-series | -| openbb.econometrics.clean | Function | Apply either a fill or drop method to clean the data | -| openbb.econometrics.bpag | Function | Test for heteroskedasticity with a Breusch-Pagan test | -| openbb.econometrics.bpag_chart | Function | Get a nice table with Breusch-Pagan test results | -| openbb.econometrics.fdols | Function | Perform a First Difference OLS (fdols) regression on Panel data | -| openbb.econometrics.load | Function | Load in a dataset to be used within other functionalities | -| openbb.econometrics.ols | Function | Perform an Ordinary Least Squares (ols) regression on time-series data | -| openbb.econometrics.comparison | Function | Compare different regression models in one table | - -Alternatively you can print the contents of the Econometrics Platform with: - -```python -help(openbb.econometrics) -``` - -## Examples - -### Loading a dataset - -The first step in using this menu is loading a dataset. This can be either an example dataset, see the list below, or any locally stored Excel file. To demonstrate the usage of the menu, the longley - dataset is loaded in. This can be done with the following - -```python -example_load = openbb.econometrics.load("anes96") -file_load = openbb.econometric.load("PATH_TO_FILE/FILE.xlsx") -``` - -| File | Description | -| :----------------- | --------------------------------------------------------: | -| anes96 | American National Election Survey 1996 | -| cancer | Breast Cancer Data | -| ccard | Bill Greene’s credit scoring data. | -| cancer_china | Smoking and lung cancer in eight cities in China. | -| co2 | Mauna Loa Weekly Atmospheric CO2 Data | -| committee | First 100 days of the US House of Representatives 1995 | -| copper | World Copper Market 1951-1975 Dataset | -| cpunish | US Capital Punishment dataset. | -| danish_data | Danish Money Demand Data | -| elnino | El Nino - Sea Surface Temperatures | -| engel | Engel (1857) food expenditure data | -| fair | Affairs dataset | -| fertility | World Bank Fertility Data | -| grunfeld | Grunfeld (1950) Investment Data | -| heart | Transplant Survival Data | -| interest_inflation | (West) German interest and inflation rate 1972-1998 | -| longley | Longley dataset | -| macrodata | United States Macroeconomic data | -| modechoice | Travel Mode Choice | -| nile | Nile River flows at Ashwan 1871-1970 | -| randhie | RAND Health Insurance Experiment Data | -| scotland | Taxation Powers Vote for the Scottish Parliament 1997 | -| spector | Spector and Mazzeo (1980) - Program Effectiveness Data | -| stackloss | Stack loss data | -| star98 | Star98 Educational Dataset | -| statecrim | Statewide Crime Data 2009 | -| strikes | U.S. Strike Duration Data | -| sunspots | Yearly sunspots data 1700-2008 | -| wage_panel | Veila and M. Verbeek (1998): Whose Wages Do Unions Raise? | - -### Working with Time Series data - -To demonstrate the usage of the Econometrics Platform for time series data, the -longley dataset is loaded in. - -```python -# Load the data -longley = openbb.econometrics.load("longley") - -# Show the data -longley -``` - -| | TOTEMP | GNPDEFL | GNP | UNEMP | ARMED | POP | YEAR | -| --: | -----: | ------: | -----: | ----: | ----: | -----: | ---: | -| 0 | 60323 | 83 | 234289 | 2356 | 1590 | 107608 | 1947 | -| 1 | 61122 | 88.5 | 259426 | 2325 | 1456 | 108632 | 1948 | -| 2 | 60171 | 88.2 | 258054 | 3682 | 1616 | 109773 | 1949 | -| 3 | 61187 | 89.5 | 284599 | 3351 | 1650 | 110929 | 1950 | -| 4 | 63221 | 96.2 | 328975 | 2099 | 3099 | 112075 | 1951 | -| 5 | 63639 | 98.1 | 346999 | 1932 | 3594 | 113270 | 1952 | -| 6 | 64989 | 99 | 365385 | 1870 | 3547 | 115094 | 1953 | -| 7 | 63761 | 100 | 363112 | 3578 | 3350 | 116219 | 1954 | -| 8 | 66019 | 101.2 | 397469 | 2904 | 3048 | 117388 | 1955 | -| 9 | 67857 | 104.6 | 419180 | 2822 | 2857 | 118734 | 1956 | -| 10 | 68169 | 108.4 | 442769 | 2936 | 2798 | 120445 | 1957 | -| 11 | 66513 | 110.8 | 444546 | 4681 | 2637 | 121950 | 1958 | -| 12 | 68655 | 112.6 | 482704 | 3813 | 2552 | 123366 | 1959 | -| 13 | 69564 | 114.2 | 502601 | 3931 | 2514 | 125368 | 1960 | -| 14 | 69331 | 115.7 | 518173 | 4806 | 2572 | 127852 | 1961 | -| 15 | 70551 | 116.9 | 554894 | 4007 | 2827 | 130081 | 1962 | - -This can be extended by also showing the descriptive statistics, this can be -done with a native command from Pandas as follows: - -```python -longley.describe() -``` - -| | TOTEMP | GNPDEFL | GNP | UNEMP | ARMED | POP | YEAR | -| :---- | ------: | ------: | ------: | ------: | ------: | -----: | ------: | -| count | 16 | 16 | 16 | 16 | 16 | 16 | 16 | -| mean | 65317 | 101.681 | 387698 | 3193.31 | 2606.69 | 117424 | 1954.5 | -| std | 3511.97 | 10.7916 | 99394.9 | 934.464 | 695.92 | 6956.1 | 4.76095 | -| min | 60171 | 83 | 234289 | 1870 | 1456 | 107608 | 1947 | -| 25% | 62712.5 | 94.525 | 317881 | 2348.25 | 2298 | 111788 | 1950.75 | -| 50% | 65504 | 100.6 | 381427 | 3143.5 | 2717.5 | 116804 | 1954.5 | -| 75% | 68290.5 | 111.25 | 454086 | 3842.5 | 3060.75 | 122304 | 1958.25 | -| max | 70551 | 116.9 | 554894 | 4806 | 3594 | 130081 | 1962 | - -It is possible to check for a variety of assumptions, e.g. normality, unit root, -granger and co-integration. The functions `openbb.econometric.norm` and `openb.econometrics.root` are shown below. Note -that due to the small size of the dataset, many of these tests are not -statistically significant. - -```python -openbb.econometrics.norm(longley['GNP']) -``` - -| | Kurtosis | Skewness | Jarque-Bera | Shapiro-Wilk | Kolmogorov-Smirnov | -| :-------- | -------: | --------: | ----------: | -----------: | -----------------: | -| Statistic | -1.1944 | 0.0525317 | 0.835092 | 0.962593 | 1 | -| p-value | 0.23232 | 0.95811 | 0.65866 | 0.709 | 0 | - -```python -openbb.econometrics.root(longley['POP']) -``` - -| | ADF | KPSS | -| :------------- | -------: | -------: | -| Test Statistic | 2.35204 | 0.324887 | -| P-Value | 0.998986 | 0.1 | -| NLags | 6 | 0 | -| Nobs | 9 | 0 | -| ICBest | 113.054 | 0 | - -The longley dataset is known for the ability to create an OLS regression that results in a R-squared of 1.0 due to the fact that the US macroeconomic variables are known to be highly collinear. See the following regression performed with `openbb.econometrics.ols` as follows: - -```python -# Perform the regression technique. TOTEMP is dependent, all others independent -ols_regression = openbb.econometrics.ols(longley['TOTEMP'], longley.drop('TOTEMP', axis=1)) - -# Show the model summary -ols_regression.summary() -``` - -``` - OLS Regression Results -======================================================================================= -Dep. Variable: TOTEMP R-squared (uncentered): 1.000 -Model: OLS Adj. R-squared (uncentered): 1.000 -Method: Least Squares F-statistic: 5.052e+04 -Date: Mon, 21 Nov 2022 Prob (F-statistic): 8.20e-22 -Time: 10:54:19 Log-Likelihood: -117.56 -No. Observations: 16 AIC: 247.1 -Df Residuals: 10 BIC: 251.8 -Df Model: 6 -Covariance Type: nonrobust -============================================================================== - coef std err t P>|t| [0.025 0.975] ------------------------------------------------------------------------------- -GNPDEFL -52.9936 129.545 -0.409 0.691 -341.638 235.650 -GNP 0.0711 0.030 2.356 0.040 0.004 0.138 -UNEMP -0.4235 0.418 -1.014 0.335 -1.354 0.507 -ARMED -0.5726 0.279 -2.052 0.067 -1.194 0.049 -POP -0.4142 0.321 -1.289 0.226 -1.130 0.302 -YEAR 48.4179 17.689 2.737 0.021 9.003 87.832 -============================================================================== -Omnibus: 1.443 Durbin-Watson: 1.277 -Prob(Omnibus): 0.486 Jarque-Bera (JB): 0.605 -Skew: 0.476 Prob(JB): 0.739 -Kurtosis: 3.031 Cond. No. 4.56e+05 -============================================================================== - -Notes: -[1] R² is computed without centering (uncentered) since the model does not contain a constant. -[2] Standard Errors assume that the covariance matrix of the errors is correctly specified. -[3] The condition number is large, 4.56e+05. This might indicate that there are -strong multicollinearity or other numerical problems. -``` - -After running the regression estimation, it is possible to perform tests on the residuals of the model. E.g. for autocorrelation and heteroscedasity as shown below with the `openbb.econometrics.bgod` and `openbb.econometrics.bpag` functions. - -```python -# Perform Breusch Goodfrey auto-correlation test -openbb.econometrics.bgod(ols_regression) -``` - -| | 0 | -| :------- | --------: | -| lm-stat | 10.3471 | -| p-value | 0.0158347 | -| f-stat | 0.0970889 | -| fp-value | 0.958799 | - -```python -# Perform Breusch Pagan heteroskedacity test -openbb.econometrics.bpag(ols_regression) -``` - -| | 0 | -| :------- | -------: | -| lm-stat | 7.90331 | -| p-value | 0.161645 | -| f-stat | 1.62686 | -| fp-value | 0.236596 | - -### Working with Panel data - -Within the examples there is one panel dataset available named `wage_panel`. This is a dataset from the paper by Vella and M. Verbeek (1998), “Whose Wages Do Unions Raise? A Dynamic Model of Unionism and Wage Rate Determination for Young Men,” Journal of Applied Econometrics 13, 163-183. This is a well-known dataset also used within Chapter 14 of Introduction to Econometrics by Jeffrey Wooldridge. - -```python -# Load the data -wage_panel = openbb.econometrics.load("wage_panel") - -# Show the data -wage_panel -``` - -| | nr | year | black | exper | hisp | hours | married | educ | union | lwage | expersq | occupation | -| --: | --: | ---: | ----: | ----: | ---: | ----: | ------: | ---: | ----: | ------: | ------: | ---------: | -| 0 | 13 | 1980 | 0 | 1 | 0 | 2672 | 0 | 14 | 0 | 1.19754 | 1 | 9 | -| 1 | 13 | 1981 | 0 | 2 | 0 | 2320 | 0 | 14 | 1 | 1.85306 | 4 | 9 | -| 2 | 13 | 1982 | 0 | 3 | 0 | 2940 | 0 | 14 | 0 | 1.34446 | 9 | 9 | -| 3 | 13 | 1983 | 0 | 4 | 0 | 2960 | 0 | 14 | 0 | 1.43321 | 16 | 9 | -| 4 | 13 | 1984 | 0 | 5 | 0 | 3071 | 0 | 14 | 0 | 1.56812 | 25 | 5 | - -4360 rows × 12 columns - -To run panel regressions, it is important to define both _entity_ (e.g. company) and _time_ (e.g. year). -Trying to run the `openbb.econometrics.re` function would right now result in the following: - -``` -openbb.econometrics.re(wage_panel['black'], wage_panel.drop('black', axis=1)) - -Error: Series can only be used with a 2-level MultiIndex -``` - -This can be corrected by setting a multi-index, this can be done with the following: - -```python -wage_panel = wage_panel.set_index(['nr', 'year'], drop=False) -``` - -The columns `nr` and `year` still exists within the dataset and could have been dropped with the if desired. However, in this case the `year` column is relevant for generating time effects in Pooled OLS, Fixed Effects and Random Effects estimations. To be able to do this, the type of the year column needs to be changed accordingly to 'category' so it is perceived as categorical data. This can be done with the following: - -```python -# Observe the current types -wage_panel.dtypes -``` - -| | 0 | -| :--------- | :------ | -| nr | int64 | -| year | int64 | -| black | int64 | -| exper | int64 | -| hisp | int64 | -| hours | int64 | -| married | int64 | -| educ | int64 | -| union | int64 | -| lwage | float64 | -| expersq | int64 | -| occupation | int64 | - -```python -# Change the type of year to categorical -wage_panel['year'] = wage_panel['year'].astype('category') - -# Observe the changed types -wage_panel.dtypes -``` - -| | 0 | -| :--------- | :------- | -| nr | int64 | -| year | category | -| black | int64 | -| exper | int64 | -| hisp | int64 | -| hours | int64 | -| married | int64 | -| educ | int64 | -| union | int64 | -| lwage | float64 | -| expersq | int64 | -| occupation | int64 | - -The dataset is now properly configured to allow for proper panel regressions. The Econometrics Platform supports the following regression techniques. - -| Path | Description | -| :------------------------ | ---------------------------------------------------------------------: | -| openbb.econometrics.ols | Perform an Ordinary Least Squares (ols) regression on time-series data | -| openbb.econometrics.pols | Perform a Pooled OLS (pols) regression on Panel data | -| openbb.econometrics.bols | Perform a Between OLS (bols) regression on Panel data | -| openbb.econometrics.fdols | Perform a First Difference OLS (fdols) regression on Panel data | -| openbb.econometrics.fe | Perform a Fixed Effects (fe) regression on Panel data | -| openbb.econometrics.re | Perform a Random Effects (re) regression on Panel data | - -As an example, a **Random Effects** regression is performed. This can be done as follows: - -```python -# Perform the Random Effects regression technique -random_effects_regression = openbb.econometrics.re(wage_panel['lwage'], wage_panel[['black', 'hisp', 'exper', 'expersq', 'married', 'educ', 'union','year']]) - -# Show the results -random_effects_regression.summary -``` - -``` - RandomEffects Estimation Summary -================================================================================ -Dep. Variable: lwage R-squared: 0.1806 -Estimator: RandomEffects R-squared (Between): 0.1853 -No. Observations: 4360 R-squared (Within): 0.1799 -Date: Mon, Nov 21 2022 R-squared (Overall): 0.1828 -Time: 11:13:36 Log-likelihood -1622.5 -Cov. Estimator: Unadjusted - F-statistic: 68.409 -Entities: 545 P-value 0.0000 -Avg Obs: 8.0000 Distribution: F(14,4345) -Min Obs: 8.0000 -Max Obs: 8.0000 F-statistic (robust): 68.409 - P-value 0.0000 -Time periods: 8 Distribution: F(14,4345) -Avg Obs: 545.00 -Min Obs: 545.00 -Max Obs: 545.00 - - Parameter Estimates -============================================================================== - Parameter Std. Err. T-stat P-value Lower CI Upper CI ------------------------------------------------------------------------------- -const 0.0234 0.1514 0.1546 0.8771 -0.2735 0.3203 -black -0.1394 0.0480 -2.9054 0.0037 -0.2334 -0.0453 -hisp 0.0217 0.0428 0.5078 0.6116 -0.0622 0.1057 -exper 0.1058 0.0154 6.8706 0.0000 0.0756 0.1361 -expersq -0.0047 0.0007 -6.8623 0.0000 -0.0061 -0.0034 -married 0.0638 0.0168 3.8035 0.0001 0.0309 0.0967 -educ 0.0919 0.0107 8.5744 0.0000 0.0709 0.1129 -union 0.1059 0.0179 5.9289 0.0000 0.0709 0.1409 -year.1981 0.0404 0.0247 1.6362 0.1019 -0.0080 0.0889 -year.1982 0.0309 0.0324 0.9519 0.3412 -0.0327 0.0944 -year.1983 0.0202 0.0417 0.4840 0.6284 -0.0616 0.1020 -year.1984 0.0430 0.0515 0.8350 0.4037 -0.0580 0.1440 -year.1985 0.0577 0.0615 0.9383 0.3482 -0.0629 0.1782 -year.1986 0.0918 0.0716 1.2834 0.1994 -0.0485 0.2321 -year.1987 0.1348 0.0817 1.6504 0.0989 -0.0253 0.2950 -============================================================================== -``` diff --git a/website/content/platform/usage/intros/economy.md b/website/content/platform/usage/intros/economy.md deleted file mode 100644 index 7cdbdb293751..000000000000 --- a/website/content/platform/usage/intros/economy.md +++ /dev/null @@ -1,359 +0,0 @@ ---- -title: Economy -keywords: [economy, macro, index, treasury, fred, market, econdb, index, yield, curve, economic, indicators, micro, inflation, interest rate, interest, unemploymeny, gdp, gross domestic product, openbb sdk, fred, quandl, nasdaq, alphavantage] -description: Learn and see examples for the Economy menu, which enables users to obtain market overviews, see yield curves of any country and discover sector, industry and country performance. ---- - -import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - - - -The Economy module wraps the functions from the Economy menu of the OpenBB Terminal, and provides the user with more control over their workflow. In a Jupyter Notebook environment, it is quick and easy to get going. To get the most out of these functions, it is highly recommended to acquire API keys for: - -- [FRED](https://fred.stlouisfed.org) -- [Quandl/Nasdaq Data Link](https://data.nasdaq.com) -- [AlphaVantage](https://www.alphavantage.co/) - -Define the keys for the OpenBB installation with: - -```python - -openbb.keys.fred(key = 'REPLACE_ME', persist = True) -openbb.keys.quandl(key = 'REPLACE_ME', persist = True) -openbb.keys.av(key = 'REPLACE_ME', persist = True) -``` - -## How to Use - -Below is brief description of each function within the Economy module: - -| Path | Type | Description | -| :---------------------------------- | :--------: | -------------------------------------------------------------: | -| openbb.economy.available_indices | Dictionary | Curated List of Global Indices | -| openbb.economy.balance | Function | Global Government Deficit/Surplus | -| openbb.economy.balance_chart | Function | Chart for `balance` | -| openbb.economy.bigmac | Function | The Big Mac Index | -| openbb.economy.bigmac_chart | Function | Chart for `bigmac` | -| openbb.economy.ccpi | Function | CPI Components Data by Country | -| openbb.economy.ccpi_chart | Function | Chart for `ccpi` | -| openbb.economy.country_codes | Function | List of Three-Letter ISO Country Codes | -| openbb.economy.cpi | Function | Harmonized CPI Data by Country | -| openbb.economy.cpi_chart | Function | Chart for `cpi` | -| openbb.economy.currencies | Function | Currencies from WSJ | -| openbb.economy.debt | Function | Government Debt-to-GDP Ratio | -| openbb.economy.debt_chart | Function | Chart for `debt` | -| openbb.economy.events | Function | Economic Calendar | -| openbb.economy.fgdp | Function | Real GDP Forecast by Country | -| openbb.economy.fgdp_chart | Function | Chart for `fgdp` | -| openbb.economy.fred | Function | Get FRED series data | -| openbb.economy.fred_ids | Function | Search for a FRED series ID by keyword | -| openbb.economy.fred_notes | Function | Search by Keyword for Series Information | -| openbb.economy.future | Function | Current Prices of Commodities and Futures from FinViz | -| openbb.economy.futures | Function | Current Prices of Commodities and Futures from WSJ | -| openbb.economy.gdp | Function | US GDP per Capita from AlphaVantage | -| openbb.economy.gdp_chart | Function | Chart for `gdp` | -| openbb.economy.get_groups | List | List of Groups for Performance and Valuation Functions | -| openbb.economy.glbonds | Function | Table of Select 10 Year Sovereign Bonds from WSJ | -| openbb.economy.index | Function | Historical Daily Data for Indices from YahooFinance | -| openbb.economy.index_chart | Function | Chart for `index` | -| openbb.economy.indices | Function | Top US Indices from WSJ | -| openbb.economy.macro | Function | Gets Series Data from EconDB | -| openbb.economy.macro_chart | Function | Chart for `macro` | -| openbb.economy.macro_countries | List | List of Countries Accepted by Macro Function | -| openbb.economy.macro_parameters | Dictionary | Dictionary of Parameters & Descriptions for Macro Function | -| openbb.economy.overview | Function | General Market Overview from WSJ | -| openbb.economy.perfmap | Function | Opens a Browser to Performance Map from Finviz | -| openbb.economy.performance | Function | Performance Data (get_groups) | -| openbb.economy.revenue | Function | Government Revenues by Country | -| openbb.economy.revenue_chart | Function | Chart for `revenue` | -| openbb.economy.rgdp | Function | Real GDP by Country | -| openbb.economy.rgdp_chart | Function | Chart for `rgdp` | -| openbb.economy.search_index | Function | Search for a Global Index by Name | -| openbb.economy.spending | Function | General Government Spending by Year and Country | -| openbb.economy.spending_chart | Function | Chart for `spending` | -| openbb.economy.treasury | Function | US Treasuries Data | -| openbb.economy.treasury_chart | Function | Chart for `treasury` | -| openbb.economy.treasury_maturities | Function | Table of Accepted Values for Maturities Argument in `treasury` | -| openbb.economy.trust | Function | Trust in Government (OECD) as a % by Country | -| openbb.economy.trust_chart | Function | Chart for `trust` | -| openbb.economy.usbonds | Function | Table of Current Rate, Yield, and Yield Change | -| openbb.economy.usdli | Function | The USD Liquidity Index | -| openbb.economy.usdli_chart | Function | Chart for `usdli` | -| openbb.economy.valuation | Function | Valuation for Group from (get_gropus) | - -Alternatively, the contents of the economy, or function docstrings, is printed with: - -```python -help(openbb.economy) -``` - -## Examples - -### Import Statements - -The examples will assume that this code block is included with the import statements: - -```python -from openbb_terminal.sdk import openbb -import pandas as pd -``` - -### Index - -The `index` function can request data using a couple of methods. There is a curated list of global indexes which can be entered by symbol or values from the left column of the table below. - -```python -indexes = pd.DataFrame.from_dict(openbb.economy.available_indices()).transpose() - -indexes -``` - -| | name | ticker | -| :-------- | :------------------------------ | :------- | -| sp500 | S&P 500 Index | ^GSPC | -| sp400 | S&P 400 Mid Cap Index | ^SP400 | -| sp600 | S&P 600 Small Cap Index | ^SP600 | -| sp500tr | S&P 500 TR Index | ^SP500TR | -| sp_xsp | S&P 500 Mini SPX Options Index | ^XSP | -| cboe_tyx | CBOE 30 year Treasury Yields | ^TYX | -| cboe_irx | CBOE 13 Week Treasury Bill | ^IRX | -| move | ICE BofAML Move Index | ^MOVE | -| dxy | US Dollar Index | DX-Y.NYB | -| crypto200 | CMC Crypto 200 Index by Solacti | ^CMC200 | - -This list can be filtered: - -```python -filtered = indexes.name.str.contains('s&p', case = False) -indexes[filtered].head(10) -``` - -| | name | ticker | -|:----------|:------------------------------------|:---------| -| sp500 | S&P 500 Index | ^GSPC | -| sp400 | S&P 400 Mid Cap Index | ^SP400 | -| sp600 | S&P 600 Small Cap Index | ^SP600 | -| sp500tr | S&P 500 TR Index | ^SP500TR | -| sp_xsp | S&P 500 Mini SPX Options Index | ^XSP | -| ca_banks | S&P/TSX Composite Banks Index (CAD) | TXBA.TS | -| ar_mervel | S&P MERVAL TR Index (USD) | M.BA | -| eu_speup | S&P Europe 350 Index (EUR) | ^SPEUP | -| uk_spuk | S&P United Kingdom Index (PDS) | ^SPUK | -| in_bse | S&P Bombay SENSEX (INR) | ^BSESN | - -One index, or multiple, can be requested as a single DataFrame: - -```python -df = openbb.economy.index(indices = ['sp_energy_oil', 'sp_energy_equipment', 'sp_energy_ig']) - -df.tail(3) -``` - -| Date | sp_energy_oil | sp_energy_equipment | sp_energy_ig | -| :------------------ | ------------: | ------------------: | -----------: | -| 2022-11-14 00:00:00 | 800.76 | 330.53 | 712.28 | -| 2022-11-15 00:00:00 | 809.27 | 335.84 | 720.16 | -| 2022-11-16 00:00:00 | 792.32 | 326.49 | 704.68 | - -This can also be displayed as a chart: - -```python -openbb.economy.index_chart(indices = ['sp_energy_oil', 'sp_energy_equipment', 'sp_energy_ig']) -``` - -![openbb.economy.index_chart](https://user-images.githubusercontent.com/85772166/231894118-c3773acc-a40f-482d-838b-81118a011b0e.png "openbb.economy.index_chart") - -### Performance - -Performance metrics for sectors, industries, and regions (US listed) are printed with: - -```python -openbb.economy.performance(group = 'energy') -``` - -| | Name | Week | Month | 3Month | 6Month | 1Year | YTD | Recom | AvgVolume [1M] | RelVolume | Change | Volume [1M] | -| --: | :----------------------------- | ------: | -----: | ------: | -----: | ------: | -----: | ----: | -------------: | --------: | ------: | ----------: | -| 0 | Oil & Gas Drilling | 0.0106 | 0.2154 | 0.2501 | 0.1534 | 0.711 | 0.8991 | 1.92 | 33.58 | 0.71 | -0.013 | 16.93 | -| 1 | Oil & Gas E&P | 0.0019 | 0.0618 | 0.1188 | 0.15 | 0.6602 | 0.6922 | 2.18 | 287.09 | 0.66 | -0.0059 | 136.36 | -| 2 | Oil & Gas Equipment & Services | -0.0063 | 0.1613 | 0.305 | 0.1219 | 0.493 | 0.5702 | 2.1 | 74.1 | 0.52 | -0.0125 | 27.79 | -| 3 | Oil & Gas Integrated | 0.0166 | 0.0557 | 0.0885 | 0.0462 | 0.4014 | 0.4114 | 2.23 | 122.44 | 0.71 | -0.0079 | 62.12 | -| 4 | Oil & Gas Midstream | -0.0113 | 0.038 | -0.019 | 0.0045 | 0.1551 | 0.2027 | 2.3 | 105.55 | 0.65 | -0.0115 | 48.8 | -| 5 | Oil & Gas Refining & Marketing | 0.0147 | 0.0929 | 0.1562 | 0.1585 | 0.6038 | 0.6084 | 2.13 | 30.59 | 0.61 | -0.0006 | 13.32 | -| 6 | Thermal Coal | -0.0096 | 0.0291 | -0.0494 | 0.1289 | 1.2305 | 1.0504 | 1.97 | 8.74 | 0.69 | -0.0207 | 4.28 | -| 7 | Uranium | -0.0176 | 0.0416 | 0.0856 | 0.0426 | -0.1746 | 0.0267 | 1.61 | 32.44 | 0.54 | -0.0125 | 12.58 | - -Performance by sector: - -```python -openbb.economy.performance(group = 'sector') -``` - -| | Name | Week | Month | 3Month | 6Month | 1Year | YTD | Recom | AvgVolume [1M] | RelVolume | Change | Volume [1M] | -| --: | :--------------------- | ------: | -----: | ------: | ------: | ------: | ------: | ----: | -------------: | --------: | ------: | ----------: | -| 0 | Basic Materials | -0.0032 | 0.129 | 0.0195 | -0.0572 | -0.0684 | -0.0928 | 2.22 | 469.94 | 0.66 | -0.0116 | 222.2 | -| 1 | Communication Services | 0.0343 | 0.0128 | -0.1444 | -0.1297 | -0.3837 | -0.3529 | 1.97 | 731.34 | 0.72 | 0.0004 | 377.12 | -| 2 | Consumer Cyclical | 0.0111 | 0.0266 | -0.1386 | -0.0182 | -0.3665 | -0.3221 | 2.14 | 1430 | 1.01 | -0.0034 | 1040 | -| 3 | Consumer Defensive | 0.003 | 0.0757 | -0.0302 | 0.0573 | -0.019 | -0.0574 | 2.31 | 298.74 | 0.85 | -0.0019 | 181.95 | -| 4 | Energy | 0.0067 | 0.0629 | 0.0913 | 0.0736 | 0.4208 | 0.4497 | 2.21 | 694.52 | 0.65 | -0.008 | 322.19 | -| 5 | Financial | -0.0095 | 0.0934 | -0.0098 | 0.0339 | -0.1259 | -0.1137 | 2.24 | 861.74 | 0.79 | -0.005 | 489.78 | -| 6 | Healthcare | -0.0121 | 0.0703 | -0.0125 | 0.0177 | -0.1074 | -0.1161 | 2.11 | 1180 | 0.87 | 0.0002 | 736.58 | -| 7 | Industrials | -0.0118 | 0.0969 | -0.0223 | 0.0723 | -0.1138 | -0.101 | 2.32 | 573.08 | 0.7 | -0.005 | 285.24 | -| 8 | Real Estate | -0.0259 | 0.0884 | -0.1441 | -0.0961 | -0.2413 | -0.2738 | 2.18 | 341.84 | 0.55 | -0.0055 | 134.66 | -| 9 | Technology | 0.0149 | 0.0938 | -0.1095 | -0.0044 | -0.3024 | -0.2957 | 2.03 | 1460 | 0.86 | 0.0039 | 904.44 | -| 10 | Utilities | -0.0235 | 0.0485 | -0.1212 | -0.0582 | -0.0054 | -0.0569 | 2.29 | 166.21 | 0.67 | -0.0142 | 79.25 | - -### Events - -A global economic calendar is accessible through the `events` function: - -```python -help(openbb.economy.events) - -Help on Operation in module openbb_terminal.core.library.operation: - - - Get economic calendar for countries between specified dates - - Parameters - ---------- - countries : [List[str],str] - List of countries to include in calendar. Empty returns all - start_date : str - Start date for calendar - end_date : str - End date for calendar - - Returns - ------- - pd.DataFrame - Economic calendar -``` - -With no arguments, `events` will return the calendar from today: - -```python -openbb.economy.events().head(10) -``` - -| | Time (ET) | Country | Event | Actual | Consensus | Previous | Date | -|---:|:------------|:---------------|:---------------------------------------|:---------|:------------|:-----------|:-----------| -| 0 | 01:45 | Germany | German Buba President Nagel Speaks | - | - | - | 2023-04-13 | -| 1 | 01:45 | Germany | German Buba Vice President Buch Speaks | - | - | - | 2023-04-13 | -| 2 | 02:00 | United Kingdom | Construction Output | 2.4% | 0.9% | -1.7% | 2023-04-13 | -| 3 | 02:00 | United Kingdom | U.K. Construction Output | 5.7% | 1.6% | 3.3% | 2023-04-13 | -| 4 | 02:00 | United Kingdom | GDP | 0.0% | 0.1% | 0.4% | 2023-04-13 | -| 5 | 02:00 | United Kingdom | Index of Services | 0.1% | -0.2% | 0.1% | 2023-04-13 | -| 6 | 02:00 | United Kingdom | Industrial Production | -0.2% | 0.2% | -0.5% | 2023-04-13 | -| 7 | 02:00 | United Kingdom | Industrial Production | -3.1% | -3.7% | -3.2% | 2023-04-13 | -| 8 | 02:00 | United Kingdom | Manufacturing Production | -2.4% | -4.7% | -2.8% | 2023-04-13 | -| 9 | 02:00 | United Kingdom | Manufacturing Production | 0.0% | 0.2% | -0.1% | 2023-04-13 | - -Calendar events can be requested for a specific countries and date ranges: - -```python -openbb.economy.events(countries = ['United States'], start_date = '2022-11-18', end_date = '2022-11-18').head(5) -``` - -| | Time (ET) | Country | Event | Actual | Consensus | Previous | Date | -|---:|:------------|:--------------|:--------------------------------|:---------|:------------|:-----------|:-----------| -| 0 | 09:40 | United States | Fed Collins Speaks | - | - | - | 2022-11-18 | -| 1 | 11:00 | United States | Existing Home Sales | -5.9% | - | -1.5% | 2022-11-18 | -| 2 | 11:00 | United States | Existing Home Sales | 4.43M | 4.38M | 4.71M | 2022-11-18 | -| 3 | 11:00 | United States | US Leading Index | -0.8% | -0.4% | -0.5% | 2022-11-18 | -| 4 | 14:00 | United States | U.S. Baker Hughes Oil Rig Count | 623 | - | 622 | 2022-11-18 | - -### FRED - -Search the FRED database for a series titles containing keywords: - -```python -series_ids = openbb.economy.fred_ids(search_query = 'Oil and Gas') - -series_ids.head(5) -``` - -| id | title | -| :-------------- | :-------------------------------------------------------------------------------------------------- | -| PCU333132333132 | Producer Price Index by Industry: Oil and Gas Field Machinery and Equipment Manufacturing | -| CES1021100001 | All Employees, Oil and Gas Extraction | -| IPG211111CS | Industrial Production: Mining, Quarrying, and Oil and Gas Extraction: Crude Oil (NAICS = 211111pt.) | -| A33DNO | Manufacturers' New Orders: Mining, Oil, and Gas Field Machinery Manufacturing | -| PCU21112111 | Producer Price Index by Industry: Oil and Gas Extraction | - -### Macro - -The `macro` function will return a Tuple. See refer to the docstring below to see the input arguments: - -```python -help(openbb.economy.macro) - -Help on Operation in module openbb_terminal.core.library.operation: - - - Use 'economy.macro_chart' to access the view. - This functions groups the data queried from the EconDB database [Source: EconDB] - - Parameters - ---------- - parameters: list - The type of data you wish to download. Available parameters can be accessed through economy.macro_parameters(). - countries : list - The selected country or countries. Available countries can be accessed through economy.macro_countries(). - transform : str - The selected transform. Available transforms can be accessed through get_macro_transform(). - start_date : str - The starting date, format "YEAR-MONTH-DAY", i.e. 2010-12-31. - end_date : str - The end date, format "YEAR-MONTH-DAY", i.e. 2020-06-05. - symbol : str - In what currency you wish to convert all values. - - Returns - ------- - Tuple[pd.DataFrame, Dict[Any, Dict[Any, Any]], str] - A DataFrame with the requested macro data of all chosen countries, - A dictionary containing the units of each country's parameter (e.g. EUR), - A string denomination which can be Trillions, Billions, Millions, Thousands - - Examples - -------- - >>> from openbb_terminal.sdk import openbb - >>> macro_df = openbb.economy.macro() -``` - -`openbb.economy.macro_parameters()` will return a list of dictionaries. Read it as a DataFrame with: - -```python -parameters = pd.DataFrame.from_dict(openbb.economy.macro_parameters()).transpose() - -parameters.tail(5) -``` - -| | name | period | description | -| :------ | :------------------------ | :------ | :----------------------------------------------------------------------------------------------------------------------------------- | -| Y10YD | Long term yield (10-year) | Monthly | The 10-year yield is used as a proxy for mortgage rates. It's also seen as a sign of investor sentiment about the country's economy. | -| M3YD | 3 month yield | Monthly | The yield received for investing in a government issued treasury security that has a maturity of 3 months | -| HOU | House price index | Monthly | House price index defined with base 2015 for Europe with varying bases for others. See: https://www.econdb.com/main-indicators | -| OILPROD | Oil production | Monthly | The amount of oil barrels produced per day in a month within a country. | -| POP | Population | Monthly | The population of a country. This can be in thousands or, when relatively small, in actual units. | - -The data from the `macro` function is unpacked like: - -```python -data,units,denomination = openbb.economy.macro(parameters = ['Y10YD'], countries = ['United States', 'Poland', 'France', 'Italy', 'Spain', 'Germany']) - -data.tail(10) -``` - -| date | France | Germany | Italy | Poland | Spain | United States | -|:--------------------|----------------------:|-----------------------:|---------------------:|----------------------:|---------------------:|-----------------------------:| -| 2022-05-01 | 1.52 | 0.95 | 2.99 | 6.64 | 2.04 | 2.9 | -| 2022-06-01 | 2.06 | 1.45 | 3.64 | 7.14 | 2.63 | 3.14 | -| 2022-07-01 | 1.71 | 1.08 | 3.36 | 6.37 | 2.31 | 2.9 | -| 2022-08-01 | 1.69 | 1.03 | 3.3 | 5.8 | 2.15 | 2.9 | -| 2022-09-01 | 2.41 | 1.8 | 4.14 | 6.28 | 2.92 | 3.52 | -| 2022-10-01 | 2.77 | 2.19 | 4.53 | 7.82 | 3.29 | 3.98 | -| 2022-11-01 | 2.58 | 2.07 | 4.24 | 7.24 | 3.07 | 3.89 | -| 2022-12-01 | 2.62 | 2.09 | 4.26 | 6.61 | 3.09 | 3.62 | -| 2023-01-01 | 2.69 | 2.19 | 4.24 | 6.02 | 3.2 | 3.53 | -| 2023-02-01 | 2.87 | 2.37 | 4.27 | 6.18 | 3.39 | 3.75 | diff --git a/website/content/platform/usage/intros/etf.md b/website/content/platform/usage/intros/etf.md deleted file mode 100644 index 9acfffc483db..000000000000 --- a/website/content/platform/usage/intros/etf.md +++ /dev/null @@ -1,186 +0,0 @@ ---- -title: ETF -keywords: [etfs, exchange traded funds, fund, basket, retail, stocks, openbb terminal, sdk, how to, usage, examples, path, type, description, category, tickers, performance, metrics, holdings, screener, disc, ] -description: Learn how to lookup any ETF and obtain an overview about the chosen ETF in the OpenBB Terminal. ---- - -import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - - - -The ETF module provides programmatic access to the commands from within the OpenBB Terminal. Import the OpenBB Platform module, and then access the functions similarly to how the Terminal menus are navigated. The code completion will be activated upon entering `.`, after, `openbb.etf` -​ - -## How to Use - -​The examples provided below will assume that the following import block is included at the beginning of the Python script or Notebook file: -​ - -```python -from openbb_terminal.sdk import openbb -import pandas as pd -``` - -​Below is a brief description of each function within the ETF module: - -|Path |Type |Description | -|:---------|:---------:|------------------------------:| -|openbb.etf.candle |Function |Chart OHLC + Volume + Moving Averages | -|openbb.etf.disc |Sub-Module |Best/Worst/Highest Volume ETFs Today | -|openbb.etf.etf_by_category |Function |Lookup by Category | -|openbb.etf.etf_by_name |Function |Lookup by Name | -|openbb.etf.holdings |Function |Holdings and Weights | -|openbb.etf.ld |Function |Lookup by Description | -|openbb.etf.load |Function |Get Historical Price Data | -|openbb.etf.ln |Function |Lookup by Name (More Details Than `by_name`) | -|openbb.etf.news |Function |News Headlines for a Ticker | -|openbb.etf.overview |Function |Basic Statistics for an ETF | -|openbb.etf.scr |Sub-Module |ETF Screener | -|openbb.etf.summary |Function |Text Description and Summary of an ETF | -|openbb.etf.symbols |Dictionary |Dictionary of {Ticker:Name} | -|openbb.etf.weights |Function |Table or Pie Graph of Sector Weightings | - -Alternatively you can print the contents of the ETF Platform with: -​ - -```python -help(openbb.etf) -``` - -## Examples - -### etf_by_category - -​ -ETFs are categorized into different buckets. Use the code block below as a way to generate a list of all categories: -​ - -```python -etf_list = pd.DataFrame.from_dict(openbb.etf.etf_by_category('')).transpose() -categories = list(etf_list['category'].drop_duplicates()) -categories = pd.DataFrame(categories[1::], columns = ['Type']) - -categories.head(6) -``` - -| | Type | -| --: | :------------------------ | -| 0 | Pacific/Asia ex-Japan Stk | -| 1 | Large Value | -| 2 | Equity Energy | -| 3 | Foreign Large Blend | -| 4 | Large Blend | -| 5 | Multisector Bond | - -​Replacing the empty category in the syntax above will return the ETFs within that category: -​ - -```python -etf_category = pd.DataFrame.from_dict(openbb.etf.etf_by_category('Foreign Large Blend')).transpose() -etf_category = etf_category.sort_values(by=['total_assets'], ascending = False) - -etf_category.head(2) -``` - -| | short_name | long_name | currency | summary | category | family | exchange | market | total_assets | -| :--- | :------------------------------ | :------------------------------------------------------- | :------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :------------------ | :------- | :------- | :-------- | -----------: | -| VXUS | Vanguard Total International St | Vanguard Total International Stock Index Fund ETF Shares | USD | The investment seeks to track the performance of a benchmark index that measures the investment return of stocks issued by companies located in developed and emerging markets, excluding the United States. | Foreign Large Blend | Vanguard | NGM | us_market | 379067924480 | -| | | | | The fund employs an indexing investment approach designed to track the performance of the FTSE Global All Cap ex US Index, a float-adjusted market-capitalization-weighted index designed to measure equity market performance of companies located in developed and emerging markets, excluding the United States. It invests all, or substantially all, of its assets in the common stocks included in its target index. | | | | | | -| VEA | Vanguard FTSE Developed Markets | Vanguard FTSE Developed Markets Index Fund ETF Shares | USD | The investment seeks to track the performance of the FTSE Developed All Cap ex US Index. | Foreign Large Blend | Vanguard | PCX | us_market | 150540566528 | -| | | | | The fund employs an indexing investment approach designed to track the performance of the FTSE Developed All Cap ex US Index, a market-capitalization-weighted index that is made up of approximately 3865 common stocks of large-, mid-, and small-cap companies located in Canada and the major markets of Europe and the Pacific region. The adviser attempts to replicate the target index by investing all, or substantially all, of its assets in the stocks that make up the index, holding each stock in approximately the same proportion as its weighting in the index. | | | | | | - -​ -### ETF Tickers - -A list of all tickers in the specific category can be generated from the index of the above DataFrame, `etf_category`: - -```python -symbols = etf_category.index.to_list() -``` - -### Performance Metrics - -This list of tickers can then be used for comparison analysis, or portfolio optimization. For example, comparing the performance metrics of the Foreign Large Blend category: - -```python -performance = openbb.stocks.ca.screener(similar = symbols, data_type = 'performance') -performance = performance.sort_values(by=['Perf Quart']) -performance.head(5) -``` - -| | Ticker | Perf Week | Perf Month | Perf Quart | Perf Half | Perf Year | Perf YTD | Volatility W | Volatility M | Recom | Avg Volume | Rel Volume | Price | Change | Volume | -|---:|:---------|------------:|-------------:|-------------:|------------:|------------:|-----------:|---------------:|---------------:|:--------|-------------:|-------------:|--------:|---------:|---------:| -| 22 | IFV | 0.0057 | 0.0531 | -0.0873 | -0.122 | -0.2817 | -0.2657 | 0.0188 | 0.0194 | | 26410 | 1.44 | 16.78 | -0.0158 | 13090 | -| 20 | IDLV | 0.0326 | 0.0814 | -0.0836 | -0.1162 | -0.1756 | -0.1758 | 0.0113 | 0.0121 | | 152070 | 0.57 | 26.39 | 0.003 | 29698 | -| 18 | HDMV | 0.0456 | 0.0873 | -0.0728 | -0.1071 | -0.1709 | -0.1683 | 0.0087 | 0.0081 | | 4330 | 1.35 | 26.44 | 0.0006 | 2011 | -| 7 | DEEF | 0.0457 | 0.1061 | -0.0612 | -0.0997 | -0.2099 | -0.2071 | 0.0067 | 0.0122 | | 8350 | 0.08 | 25 | -0.0031 | 244 | -| 38 | RODM | 0.0424 | 0.1106 | -0.0428 | -0.1012 | -0.2015 | -0.1827 | 0.0141 | 0.0139 | | 345640 | 1.05 | 24.64 | 0.0011 | 125217 | - -### Holdings - -To peer into the holdings of a specific ETF: - -```python -holdings = openbb.etf.holdings('DIA').reset_index() -holdings.head(5) -``` - -| | Symbol | Name | % Of Etf | Shares | -|---:|:---------|:--------------------------------|:-----------|---------:| -| 0 | UNH | UnitedHealth Group Incorporated | 10.09% | 5985297 | -| 1 | GS | The Goldman Sachs Group, Inc. | 7.51% | 5985297 | -| 2 | HD | The Home Depot, Inc. | 6.03% | 5985297 | -| 3 | AMGN | Amgen Inc. | 5.61% | 5985297 | -| 4 | MCD | McDonald's Corporation | 5.35% | 5985297 | - -### ETF Screener - -The ETF screener is also accessible through the Platform. Variables for the screener are set in preset files. The path to their location will depend on the type of installation and operating system; it will be similar to: - -- For a pip/PyPi installation: `~/path_to/miniconda3/envs/obb/Lib/site-packages/openbb_terminal/etf/screener/presets/etf_config.ini` -- For a Git Clone & Conda installation: `~/path_to/cloned_folder/OpenBBTerminal/openbb_terminal/etf/screener/presets/etf_config.ini` -- For a the EXE/DMG installer bundles: `~/path_to_installation/OpenBB Terminal/.OpenBB/openbb_terminal/etf/screener/etf_config.ini` - -This file can be copied to the user data folder, `~/OpenBBUserData/presets/etf/screener/`, along with any other user-generated screener presets. - -```python -results = openbb.etf.scr.screen(preset='etf_config.ini') -results.head(5) -``` - -In this example, the configuration file is set to return results with a maximum Beta value of -2. - -| | index | Assets | NAV | Expense | PE | SharesOut | Div | DivYield | Volume | Open | PrevClose | YrLow | YrHigh | Beta | N_Hold | -|---:|:--------|---------:|------:|----------:|-----:|:------------|-------:|-----------:|---------------:|-------:|------------:|--------:|---------:|-------:|---------:| -| 0 | CLDS | 14.15 | 28.3 | 0.99 | N/A | 500,000 | N/A | N/A | 7815 | 28.58 | 28.05 | 14.79 | 46.43 | -2.12 | 6 | -| 1 | CTEX | 3.95 | 39.52 | 0.58 | N/A | 100,000 | N/A | N/A | 1161 | 39.56 | 39.48 | 24.48 | 51.3 | -2.07 | 31 | -| 2 | KLNE | 5.7 | 22.81 | 1.29 | N/A | 250,000 | 0.08 | 0.37 | 5580 | 21.55 | 21.7 | 12 | 31.38 | -2.79 | 5 | -| 3 | LABD | 97.16 | 18.61 | 1 | N/A | 5.22 | N/A | N/A | 8.12293e+06 | 22.26 | 21.35 | 15.7 | 85.28 | -2.67 | 17 | -| 4 | MJIN | 2.79 | 17.45 | 0.95 | N/A | 160,000 | 0.88 | 4.45 | 282 | 19.81 | 19.07 | 7.87 | 26.73 | -3.23 | 2 | - -### Disc - -The current top gainers, losers, and volume for ETFs is returned with: - -```python -openbb.etf.disc.mover(sort_type = 'decliners') - -openbb.etf.disc.mover(sort_type = 'gainers') - -openbb.etf.disc.mover(sort_type = 'active') -``` - -With no `sort_type` chosen, it will default to `gainers`: - -```python -movers = openbb.etf.disc.mover() -movers.head(5) -``` - -| | | Price | Chg | %Chg | Vol | -|---:|:---------------------------------------------------------|--------:|-------:|-------:|:-------| -| 0 | Direxion Daily Semiconductor Bear 3X Shares | 35.3101 | 3.3101 | 10.34 | 24.5M | -| 1 | ProShares UltraShort Bloomberg Natural Gas | 18.09 | 1.19 | 7.04 | 4.4M | -| 2 | MicroSectors FANG & Innovation -3x Inverse Leveraged ETN | 28.98 | 1.83 | 6.74 | 160.1K | -| 3 | Direxion Daily Dow Jones Internet Bear 3X Shares | 32.14 | 1.91 | 6.32 | 554.2K | -| 4 | Direxion Daily S&P 500 High Beta Bear 3X Shares | 6.4652 | 0.3752 | 6.16 | 1.2M | diff --git a/website/content/platform/usage/intros/fixedincome.md b/website/content/platform/usage/intros/fixedincome.md deleted file mode 100644 index 57096b7c6d08..000000000000 --- a/website/content/platform/usage/intros/fixedincome.md +++ /dev/null @@ -1,239 +0,0 @@ ---- -title: Fixed Income -keywords: [fixed income, government bonds, bonds, corporate bonds, fixed, income, interest, rates, inflation, central bank, reference, rates, sofr, sonia, ester, estr, how to, usage, examples, deposit, lending, refinancing, maturity, rate] -description: Learn how to use and see examples of the Fixed Income menu in the OpenBB Platform. It is the high-level menu for the Fixed Income asset class. It contains reference rates, central bank rates, government bonds, yield curves, corporate bond benchmarks and more. ---- - -import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - - - -The Fixed Income module is the high-level menu for the Fixed Income asset class. It contains reference rates (ESTER, SOFR, SONIA and Ameribor), central bank rates (FRED, FOMC projections and ECB key interest rates), government bonds (treasury rates for any country, us-specific rates, yield curves), corporate bonds (ICE BofA Corporate Indices, Moody's AAA and BAA Corporate Indices, Commercial Paper, Spot Rates and HQM Corporate Yield Curve) and spread (ICE BofA spreads, constant maturity spreads, and federal funds rate) - -## How to Use - -​The examples provided below will assume that the following import block is included at the beginning of the Python script or Notebook file: -​ - -```python -from openbb_terminal.sdk import openbb -import pandas as pd -``` - -​Below is a brief description of each function within the Fixed Income module: - -|Path |Type |Description | -|:---------|:---------:|------------------------------:| -|openbb.fixedincome.ameribor |Function | Obtain data for American Interbank Offered Rate (AMERIBOR) | -|openbb.fixedincome.cp | Function | Obtain Commercial Paper data | -|openbb.fixedincome.dwpcr |Function | Obtain data for the Discount Window Primary Credit Rate | -|openbb.fixedincome.ecb |Function | Obtain data for ECB interest rates | -|openbb.fixedincome.ecbycrv |Function | Gets euro area yield curve data from ECB | -|openbb.fixedincome.estr |Function | Obtain data for Euro Short-Term Rate (ESTR) | -|openbb.fixedincome.fed |Function | Obtain data for Effective Federal Funds Rate | -|openbb.fixedincome.ffrmc |Function | Get data for Selected Treasury Constant Maturity Minus Federal Funds Rate | -|openbb.fixedincome.hqm |Function | Obtain the HQM yield curve | -|openbb.fixedincome.icebofa |Function | Get data for ICE BofA US Corporate Bond Indices | -|openbb.fixedincome.icespread |Function | Get data for ICE BofA US Corporate Bond Spreads | -|openbb.fixedincome.iorb |Function | Obtain data for Interest Rate on Reserve Balances. | -|openbb.fixedincome.moody |Function | Get data for Moody Corporate Bond Index | -|openbb.fixedincome.projection |Function | Obtain data for the Federal Reserve's projection of the federal funds rate | -|openbb.fixedincome.sofr |Function | Obtain data for Secured Overnight Financing Rate (SOFR)| -|openbb.fixedincome.sonia |Function | Obtain data for Sterling Overnight Index Average (SONIA) | -|openbb.fixedincome.spot |Function | Obtain HQM spot rate data | -|openbb.fixedincome.tbffr |Function | Get data for Selected Treasury Bill Minus Federal Funds Rate | -|openbb.fixedincome.tmc |Function | Get data for 10-Year Treasury Constant Maturity Minus Selected Treasury Constant Maturity | -|openbb.fixedincome.treasury |Function | Obtain 3-month or 10-year treasury rates for any country | -|openbb.fixedincome.usrates |Function | Plot various treasury rates from the United States | -|openbb.fixedincome.ycrv |Function | Gets yield curve data from FRED | - -Alternatively you can print the contents of the Fixed Income Platform with: -​ -```python -help(openbb.fixedincome) -``` - -## Examples -Starting off by calling some reference rates, these can be either `estr`, `sofr`, `sonia` or `ameribor`. For example the 1 year term structure of Ameribor is plotted with `openbb.fixedincome.ameribor('1_year_term_structure')` as shown below, showing only the last 10 periods in this example: - - -| | AMERIBOR| -|:--------------------|--------:| -| 2023-02-12 00:00:00 | 5.13275 | -| 2023-02-13 00:00:00 | 5.15549 | -| 2023-02-14 00:00:00 | 5.22839 | -| 2023-02-15 00:00:00 | 5.20813 | -| 2023-02-16 00:00:00 | 5.20832 | -| 2023-02-17 00:00:00 | 5.2491 | -| 2023-02-19 00:00:00 | 5.2491 | -| 2023-02-20 00:00:00 | 5.2491 | -| 2023-02-21 00:00:00 | 5.32425 | -| 2023-02-22 00:00:00 | 5.32988 | - - -The two most prominent central bank rates, those of the Federal Reserve and the European Central Bank can be obtained with `openbb.fixedincome.fed` and `openbb.fixedincome.ecb` respectively. For instance `openbb.fixedincome.fed` shows the monthly Federal Funds Rate, showing only the last 10 periods in this example: - -| | FED | -|:--------------------|-----:| -| 2022-04-01 00:00:00 | 0.33 | -| 2022-05-01 00:00:00 | 0.77 | -| 2022-06-01 00:00:00 | 1.21 | -| 2022-07-01 00:00:00 | 1.68 | -| 2022-08-01 00:00:00 | 2.33 | -| 2022-09-01 00:00:00 | 2.56 | -| 2022-10-01 00:00:00 | 3.08 | -| 2022-11-01 00:00:00 | 3.78 | -| 2022-12-01 00:00:00 | 4.1 | -| 2023-01-01 00:00:00 | 4.33 | - -This can be accompanied with the projections, officially published by the FOMC. Here the long run expectations are plotted, which also backtracks several years, with `openbb.fixedincome.projection(long_run=True)`, showing only the last 5 periods in this example: - -| | Range High | Central tendency High | Median | Range Midpoint | Central tendency Midpoint | Range Low | Central tendency Low | -|:-----------|-------------:|------------------------:|---------:|-----------------:|----------------------------:|------------:|-----------------------:| -| 2021-12-15 | 3 | 2.5 | 2.5 | 2.5 | 2.4 | 2 | 2.3 | -| 2022-03-16 | 3 | 2.5 | 2.4 | 2.5 | 2.4 | 2 | 2.3 | -| 2022-06-15 | 3 | 2.5 | 2.5 | 2.5 | 2.4 | 2 | 2.3 | -| 2022-09-21 | 3 | 2.5 | 2.5 | 2.65 | 2.4 | 2.3 | 2.3 | -| 2022-12-14 | 3.3 | 2.5 | 2.5 | 2.8 | 2.4 | 2.3 | 2.3 | - -The European Central Bank rates can be shown with `openbb.fixedincome.ecb`. The ECB publishes three different rates that can be shown separately with `openbb.fixedincome.ecb('deposit)` for example or plotted together with `openbb.fixedincome.ecb` as shown below, showing only the last 10 periods in this example: - -| | Deposit | Lending | Refinancing | -|:-----------|----------:|----------:|--------------:| -| 2023-02-14 | 2.5 | 3.25 | 3 | -| 2023-02-15 | 2.5 | 3.25 | 3 | -| 2023-02-16 | 2.5 | 3.25 | 3 | -| 2023-02-17 | 2.5 | 3.25 | 3 | -| 2023-02-18 | 2.5 | 3.25 | 3 | -| 2023-02-19 | 2.5 | 3.25 | 3 | -| 2023-02-20 | 2.5 | 3.25 | 3 | -| 2023-02-21 | 2.5 | 3.25 | 3 | -| 2023-02-22 | 2.5 | 3.25 | 3 | -| 2023-02-23 | 2.5 | 3.25 | 3 | - -In terms of government bonds, any combination of short term (3 month) and long term (10 year) government bonds for any country can be plotted with `openbb.fixedincome.treasury` for example `openbb.fixedincome.treasury(short_term=['canada', 'united_states'], long_term=['canada', 'united_states'])` as shown below, showing only the last 10 periods in this example: - -| | canada (3 month) | united_states (3 month) | canada (10 year) | united_states (10 year) | -|:-----------|-------------------:|--------------------------:|-------------------:|--------------------------:| -| 2022-04-01 | 2.704 | 2.75 | 1.34664 | 0.91 | -| 2022-05-01 | 2.91857 | 2.9 | 1.78189 | 1.33 | -| 2022-06-01 | 3.31545 | 3.14 | 2.24735 | 1.87 | -| 2022-07-01 | 3.04316 | 2.9 | 3.01411 | 2.5 | -| 2022-08-01 | 2.85909 | 2.9 | 3.38221 | 2.76 | -| 2022-09-01 | 3.1479 | 3.52 | 3.79193 | 3.21 | -| 2022-10-01 | 3.38053 | 3.98 | 4.23083 | 3.85 | -| 2022-11-01 | 3.16619 | 3.89 | 4.37634 | 4.46 | -| 2022-12-01 | 2.9415 | 3.62 | 4.55302 | 4.51 | -| 2023-01-01 | 2.93762 | 3.53 | 4.7638 | 4.61 | - - -For both the United States and the Eurozone, it is possible to see the current government bond yield curve. For the Eurozone, it is an aggregation of countries that match a specific credit rating, by default AAA, as shown with `openbb.fixedincome.ecbycrv`. - -| | Maturity | Rate | -|---:|-----------:|--------:| -| 0 | 0.25 | 2.61446 | -| 1 | 0.5 | 2.86441 | -| 2 | 1 | 2.97514 | -| 3 | 2 | 2.82012 | -| 4 | 3 | 2.68811 | -| 5 | 5 | 2.58939 | -| 6 | 7 | 2.57123 | -| 7 | 10 | 2.57545 | -| 8 | 20 | 2.55717 | -| 9 | 30 | 2.45648 | - -When it comes to Corporate Bonds, the major indices are included. These are the ICE BofA indices and the Moody's Aaa and Baa indices. Based on a query, specific benchmarks can be found. For example a collection of indices matching a variety of bond maturities with `openbb.fixedincome.icebofa(category='duration')`, showing only the last 5 periods in this example: - -| | ICE BofA 1-3 Year US Corporate Index Effective Yield | ICE BofA 3-5 Year US Corporate Index Effective Yield | ICE BofA 5-7 Year US Corporate Index Effective Yield | ICE BofA 7-10 Year US Corporate Index Effective Yield | ICE BofA 10-15 Year US Corporate Index Effective Yield | ICE BofA 15+ Year US Corporate Index Effective Yield | -|:-----------|-------------------------------------------------------:|-------------------------------------------------------:|-------------------------------------------------------:|--------------------------------------------------------:|---------------------------------------------------------:|-------------------------------------------------------:| -| 2023-02-09 | 5.22 | 5.04 | 5.12 | 5.2 | 5.34 | 5.32 | -| 2023-02-10 | 5.27 | 5.11 | 5.21 | 5.3 | 5.43 | 5.41 | -| 2023-02-13 | 5.28 | 5.14 | 5.2 | 5.28 | 5.41 | 5.38 | -| 2023-02-14 | 5.36 | 5.23 | 5.28 | 5.32 | 5.44 | 5.39 | -| 2023-02-15 | 5.36 | 5.26 | 5.31 | 5.36 | 5.48 | 5.43 | -| 2023-02-16 | 5.38 | 5.29 | 5.35 | 5.42 | 5.54 | 5.52 | -| 2023-02-17 | 5.37 | 5.26 | 5.33 | 5.42 | 5.53 | 5.5 | -| 2023-02-20 | 5.39 | 5.27 | 5.33 | 5.42 | 5.53 | 5.5 | -| 2023-02-21 | 5.49 | 5.41 | 5.49 | 5.58 | 5.68 | 5.63 | -| 2023-02-22 | 5.49 | 5.4 | 5.48 | 5.56 | 5.65 | 5.59 | - -The Moody's Aaa is often referred to as a great alternative to the federal ten-year Treasury bill as an indicator for interest rates and can be plotted with `openbb.fixedincome.moody`, showing only the last 5 periods in this example: - -| | aaa_index | -|:-----------|------------:| -| 2023-02-15 | 4.59 | -| 2023-02-16 | 4.64 | -| 2023-02-17 | 4.65 | -| 2023-02-21 | 4.76 | -| 2023-02-22 | 4.71 | - -Next to that, there are spot rates available for the High Quality Market (HQM) ranging from 1 year to a 100 years through `openbb.fixedincome.spot`. With this, it is also possible to plot the yield curve with `openbb.fixedincome.hqm` for any date in the past. For example `openbb.fixedincome.hqm(date='2020-01-01')` as shown below: - -| Maturity | spot | -|-----------:|-------:| -| 0.5 | 1.76 | -| 1 | 1.8 | -| 2 | 1.86 | -| 3 | 1.91 | -| 5 | 2.07 | -| 7 | 2.35 | -| 10 | 2.79 | -| 20 | 3.35 | -| 30 | 3.48 | -| 50 | 3.6 | -| 75 | 3.65 | -| 100 | 3.68 | - -Furthermore, it is possible to see spreads between a variety of assets. For example the Emerging Markets spread can be shown with `openbb.fixedincome.icespread(category='all', area='emea')`. This is based on the spot treasury curve. Showing only the last 5 periods in this example: - -| | ICE BofA EMEA Emerging Markets Corporate Plus Index Option-Adjusted Spread | -|:-----------|-----------------------------------------------------------------------------:| -| 2023-02-16 | 2.66 | -| 2023-02-17 | 2.75 | -| 2023-02-20 | 2.75 | -| 2023-02-21 | 2.74 | -| 2023-02-22 | 2.77 | - -For both `openbb.fixedincome.icebofa` and `openbb.fixedincome.icespread` it is possible to see all the options with `options`. Find an example for `openbb.fixedincome.icespread(options=True)` below. - - -| | Type | Category | Area | Grade | Title | -|----:|:-------|:-----------|:--------------|:---------------|:------------------------------------------------------------------------------------------------------| -| 2 | spread | duration | us | non_sovereign | ICE BofA 1-3 Year US Corporate Index Option-Adjusted Spread | -| 6 | spread | duration | us | non_sovereign | ICE BofA 3-5 Year US Corporate Index Option-Adjusted Spread | -| 10 | spread | duration | us | non_sovereign | ICE BofA 5-7 Year US Corporate Index Option-Adjusted Spread | -| 14 | spread | duration | us | non_sovereign | ICE BofA 7-10 Year US Corporate Index Option-Adjusted Spread | -| 18 | spread | duration | us | non_sovereign | ICE BofA 10-15 Year US Corporate Index Option-Adjusted Spread | -| 22 | spread | duration | us | non_sovereign | ICE BofA 15+ Year US Corporate Index Option-Adjusted Spread | -| 26 | spread | all | us | non_sovereign | ICE BofA US Corporate Index Option-Adjusted Spread | -| 30 | spread | usd | us | high_yield | ICE BofA US High Yield Index Option-Adjusted Spread | -| 34 | spread | eur | eu | high_yield | ICE BofA Euro High Yield Index Option-Adjusted Spread | -| 38 | spread | all | ex_g10 | non_sovereign | ICE BofA Emerging Markets Corporate Plus Index Option-Adjusted Spread | -| 42 | spread | all | ex_g10 | private_sector | ICE BofA Private Sector Financial Emerging Markets Corporate Plus Index Option-Adjusted Spread | -| 46 | spread | usd | ex_g10 | non_sovereign | ICE BofA US Emerging Markets Corporate Plus Index Option-Adjusted Spread | -| 50 | spread | eur | ex_g10 | non_sovereign | ICE BofA Euro Emerging Markets Corporate Plus Index Option-Adjusted Spread | -| 54 | spread | usd | ex_g10 | non_sovereign | ICE BofA US Emerging Markets Liquid Corporate Plus Index Option-Adjusted Spread | -| 58 | spread | usd | ex_g10 | non_financial | ICE BofA Non-Financial US Emerging Markets Liquid Corporate Plus Index Option-Adjusted Spread | -| 62 | spread | usd | ex_g10 | public_sector | ICE BofA Public Sector Issuers US Emerging Markets Liquid Corporate Plus Index Option-Adjusted Spread | -| 66 | spread | all | emea | non_sovereign | ICE BofA EMEA Emerging Markets Corporate Plus Index Option-Adjusted Spread | -| 70 | spread | usd | emea | non_sovereign | ICE BofA EMEA US Emerging Markets Liquid Corporate Plus Index Option-Adjusted Spread | -| 74 | spread | all | asia | non_sovereign | ICE BofA Asia Emerging Markets Corporate Plus Index Option-Adjusted Spread | -| 78 | spread | usd | asia | non_sovereign | ICE BofA Asia US Emerging Markets Liquid Corporate Plus Index Option-Adjusted Spread | -| 82 | spread | all | latin_america | non_sovereign | ICE BofA Latin America Emerging Markets Corporate Plus Index Option-Adjusted Spread | -| 86 | spread | usd | latin_america | non_sovereign | ICE BofA Latin America US Emerging Markets Liquid Corporate Plus Index Option-Adjusted Spread | -| 90 | spread | all | ex_g10 | aaa | ICE BofA AAA-A Emerging Markets Corporate Plus Index Option-Adjusted Spread | -| 94 | spread | usd | ex_g10 | aaa | ICE BofA AAA-A US Emerging Markets Liquid Corporate Plus Index Option-Adjusted Spread | -| 98 | spread | all | ex_g10 | high_grade | ICE BofA High Grade Emerging Markets Corporate Plus Index Option-Adjusted Spread | -| 102 | spread | all | ex_g10 | bbb | ICE BofA BBB Emerging Markets Corporate Plus Index Option-Adjusted Spread | -| 106 | spread | usd | ex_g10 | bbb | ICE BofA BBB US Emerging Markets Liquid Corporate Plus Index Option-Adjusted Spread | -| 110 | spread | all | ex_g10 | crossover | ICE BofA Crossover Emerging Markets Corporate Plus Index Option-Adjusted Spread | -| 114 | spread | all | ex_g10 | bb | ICE BofA BB Emerging Markets Corporate Plus Index Option-Adjusted Spread | -| 118 | spread | all | ex_g10 | high_yield | ICE BofA High Yield Emerging Markets Corporate Plus Index Option-Adjusted Spread | -| 122 | spread | all | ex_g10 | b | ICE BofA B & Lower Emerging Markets Corporate Plus Index Option-Adjusted Spread | -| 126 | spread | usd | us | aaa | ICE BofA AAA US Corporate Index Option-Adjusted Spread | -| 130 | spread | usd | us | aa | ICE BofA AA US Corporate Index Option-Adjusted Spread | -| 134 | spread | usd | us | a | ICE BofA Single-A US Corporate Index Option-Adjusted Spread | -| 138 | spread | usd | us | bbb | ICE BofA BBB US Corporate Index Option-Adjusted Spread | -| 142 | spread | usd | us | bb | ICE BofA BB US High Yield Index Option-Adjusted Spread | -| 146 | spread | usd | us | b | ICE BofA Single-B US High Yield Index Option-Adjusted Spread | -| 150 | spread | usd | us | ccc | ICE BofA CCC & Lower US High Yield Index Option-Adjusted Spread | diff --git a/website/content/platform/usage/intros/forecast.md b/website/content/platform/usage/intros/forecast.md deleted file mode 100644 index fa711e1c83b3..000000000000 --- a/website/content/platform/usage/intros/forecast.md +++ /dev/null @@ -1,594 +0,0 @@ ---- -title: Forecast -keywords: [machine learning, statistics, artificial intelligence, deep learning, neural networks, time series, research, feature engineering, hyperparameters, ai, ml, openbb sdk, forecast, how to, usage, examples, model, exploration, path, type, description, import, loading data, plot, theta, ema, rsi, sto, delete, models, regr_chart, combine, corr, hyper parameter] -description: The Forecast menu is a machine learning toolkit that provides practitioners with high-level components that can quickly provide state-of-the-art results, be it with with classical or deep learning models, while also providing researchers with low-level components to build new approaches and custom tuned models. ---- - -import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - - - -The Forecast module provides programmatic access to the same commands found in the OpenBB Terminal Forecast menu. The extensive library of models, built on top of the [u8darts](https://unit8co.github.io/darts/) library, are easily tuned with hyper-parameters. - -## How to Use - -The Forecast menu was designed specifically for the CLI application, and consequently, the operation of these commands do not mirror the workflow of the OpenBB Terminal. This will be improved in the future to more closely resemble it, and this guide will highlight some notable differences. - -Commands within the `forecast` module are representatives from three broad categories: - -- Exploration -- Feature Engineering -- Model - -Each command is listed below with a short description. A majority of functions will also have an additional syntax, `_chart`, for displaying the generated charts inline. For ease of use, we recommend using the `_chart` version for Model functions. - -|Path |Type | Description | -| :--------- | :---------: | ----------: | -|openbb.forecast.atr |Feature Engineering |Add a Column for the Average True Range | -|openbb.forecast.autoces |Model |Automatic Complex Exponential Smoothing Model | -|openbb.forecast.autoets |Model |Automatic ETS (Error, Trend, Seasonality) Model | -|openbb.forecast.autoselect |Model |Automatically Selects the Best Statistical Model From AutoARIMA, AutoETS, AutoCES, MSTL, etc. | -|openbb.forecast.brnn |Model |Block Recurrent Neural Network (RNN, LSTM, GRU) (feat. Past covariates) | -|openbb.forecast.clean |Exploration |Fill or Drop NaN Values | -|openbb.forecast.combine |Exploration |Combine Columns From Different Datasets | -|openbb.forecast.corr |Exploration | Correlation Coefficients Between Columns of a Dataset | -|openbb.forecast.delete |Exploration |Delete Columns From a Dataset | -|openbb.forecast.delta |Feature Engineering |Add a Column for % Change | -|openbb.forecast.desc |Exploration |Show Descriptive Statistics for a Dataset | -|openbb.forecast.ema |Feature Engineering |Add a Column for Exponentially Weighted Moving Average | -|openbb.forecast.expo |Model |Probabilistic Exponential Smoothing | -|openbb.forecast.export |Export |Export a Processed Dataset as a CSV or XLSX File | -|openbb.forecast.linregr |Model |Probabilistic Linear Regression (feat. Past covariates and Explainability) | -|openbb.forecast.load |Import |Import a Local CSV or XLSX File | -|openbb.forecast.mom |Feature Engineering |Add a Column for Momentum | -|openbb.forecast.nbeats |Model |Neural Bayesian Estimation (feat. Past covariates) | -|openbb.forecast.nhits |Model |Neural Hierarchical Interpolation (feat. Past covariates) | -|openbb.forecast.plot |Exploration |Plots Specific Columns From a Loaded Dataset | -|openbb.forecast.regr |Model |Regression (feat. Past covariates and Explainability) | -|openbb.forecast.rename |Exploration |Rename Columns in a Dataset | -|openbb.forecast.rnn |Model |Probabilistic Recurrent Neural Network (RNN, LSTM, GRU) | -|openbb.forecast.roc |Feature Engineering |Add a Column for Rate of Change | -|openbb.forecast.rsi |Feature Engineering |Add a Column for Relative Strength Index | -|openbb.forecast.rwd |Model |Random Walk with Drift Model | -|openbb.forecast.season |Exploration |Plot Seasonality of a Column in a Dataset | -|openbb.forecast.seasonalnaive |Model |Seasonal Naive Model | -|openbb.forecast.signal |Feature Engineering |Add a Column for Price Signal (Short vs. Long Term) | -|openbb.forecast.sto |Feature Engineering |Add a Column for Stochastic Oscillator %K and %D | -|openbb.forecast.tcn |Model |Temporal Convolutional Neural Network (feat. Past covariates) | -|openbb.forecast.tft |Model |Temporal Fusion Transformer Network(feat. Past covariates) | -|openbb.forecast.theta |Model |Theta Method | -|openbb.forecast.trans |Model |Transformer Network (feat. Past covariates) | - -Alternatively, the contents of the menu is printed with: - -```python -help(openbb.forecast) -``` - -Type hints and code completion will be activated upon entering the `.`, after, `openbb.forecast`. The first step is always going to involve loading some data. Let's walk through a procedure for procuring a DataFrame with some examples below. - -## Examples - -### Import Statements - -The examples provided below will assume that the following import block is included at the beginning of the Python script or Notebook file: - -```python -from openbb_terminal.sdk import openbb -import pandas as pd -# %matplotlib inline (uncomment if using a Jupyter Interactive Terminal or Notebook) -``` - -### Loading Data - -This library of models are specifically for time-series, and consequently, the data must follow some formatting guidelines: - -- If the index is not a date, it must be sequentially ordered and evenly spaced - i.e., it can't be indexed like: `[1,2,5,11,50]` -- A datetime index must be spaced evenly - i.e., monthly data is better handled when the interval date is the first of the month. -- If the datetime index is a weekly interval, use a Monday-Friday format. -- Intraday data is not officially supported at this time. - -The equities market revolves around the S&P 500, so let's take a look at the ETF, `SPY`, from inception: - -```python -spy = openbb.stocks.load('SPY', start_date = '1990-01-01') -``` - -```console -Loading Daily data for SPY with starting period 1993-01-29. -``` - -The printed message indicates that the first day of available data is not the same as the requested start date. [Wikipedia](https://en.wikipedia.org/wiki/SPDR_S%26P_500_Trust_ETF) shows the fund was launched on January 22, 1993. The product was marketed and sold to liquidity providers prior to trading on a public exchange, so this DataFrame is pretty darn close to the inception date. We can confirm that this data arrived as expected by printing the created DataFrame. - -```python -spy.head(5) -``` - -| date | Open | High | Low | Close | Adj Close | Volume | -|:--------------------|--------:|--------:|--------:|--------:|------------:|----------------:| -| 1993-01-29 00:00:00 | 43.9688 | 43.9688 | 43.75 | 43.9375 | 25.334 | 1.0032e+06 | -| 1993-02-01 00:00:00 | 43.9688 | 44.25 | 43.9688 | 44.25 | 25.5142 | 480500 | -| 1993-02-02 00:00:00 | 44.2188 | 44.375 | 44.125 | 44.3438 | 25.5683 | 201300 | -| 1993-02-03 00:00:00 | 44.4062 | 44.8438 | 44.375 | 44.8125 | 25.8385 | 529400 | -| 1993-02-04 00:00:00 | 44.9688 | 45.0938 | 44.4688 | 45 | 25.9467 | 531500 | - -### Plot - -The data can also be inspected visually, `openbb.forecast.plot`: - -```python -openbb.forecast.plot(data=spy, columns = ['Adj Close']) -``` - -![openbb.forecast.plot](https://user-images.githubusercontent.com/85772166/203671651-e7d5776f-c2ab-4a2a-8600-a5f6b6f2aa93.png "openbb.forecast.plot") - -### Theta - -Data consisting of a numeric value and a datetime index is sufficient enough for feeding the inputs to a forecast model. One important distinction between the Terminal and Platform is that the `target_column` must be explicitly declared when using the Platform, if it is not labeled as "close". It is case-sensitive. - -To use a forecast model with default parameters, all that is required in the syntax is: - -- The name of the dataset. -- The target column for the forecast. - -A basic, default, syntax will look like: - -```python -openbb.forecast.theta_chart(data = spy, target_column = 'Adj Close') -``` - -The default number of days to predict for all models is five. If the interval of the time-series is not daily, days equates to the interval of the index. - -```console -Theta Model obtains MAPE: 1.91% -``` - -![openbb.forecast.theta_chart](https://user-images.githubusercontent.com/85772166/203897200-f2d3938c-f3a9-4ee4-bf67-0398d8d3bce6.png) - -|Datetime |Prediction| -|:----------|--------:| -|2022-11-24 |402.62| -|2022-11-25 |402.92| -|2022-11-28 |403.14| -|2022-11-29 |403.38| -|2022-11-30 |403.59| - -Refer to the docstrings to learn about each model's unique set of arguments. - -```python -help(openbb.forecast.theta_chart) -``` - -## Feature Engineering - -This category of functions are for adding columns to a dataset that are the results of calculations, like technical and quantitative analysis. Individual parameters will vary slightly between functions, but syntax construction will be similar. - -### EMA - -A moving average provides an indication of the trend of the price movement by cutting down the amount of "noise" in a price chart. - -```console -help(openbb.forecast.ema) - - Parameters - ---------- - dataset : pd.DataFrame - The dataset you wish to clean - target_column : str - The column you wish to add the EMA to - period : int - Time Span - - Returns - ------- - pd.DataFrame - Dataframe with added EMA column -``` - -The example below adds a column to the `spy` dataset for the 150-day exponential moving average of the adjusted-close price. - -```python -spy = openbb.forecast.ema(spy, target_column = 'Adj Close', period = 150) - -spy.tail(3) -``` - -| | date | Open | High | Low | Close | Adj Close | Volume | EMA_150 | -|-----:|:-----------|-------:|-------:|-------:|--------:|------------:|---------:|----------:| -| 7508 | 2022-11-21 | 394.64 | 395.82 | 392.66 | 394.59 | 394.59 | 51243200 | 394.923 | -| 7509 | 2022-11-22 | 396.63 | 400.07 | 395.15 | 399.9 | 399.9 | 60429000 | 394.989 | -| 7510 | 2022-11-23 | 399.55 | 402.93 | 399.31 | 402.42 | 402.42 | 68161400 | 395.087 | - -Additional columns can be added for each desired period length of the calculation: - -```python -spy = openbb.forecast.ema(spy, target_column = 'Adj Close', period = 20) - -spy.tail(3) -``` - -| | date | Open | High | Low | Close | Adj Close | Volume | EMA_150 | EMA_20 | -|-----:|:-----------|-------:|-------:|-------:|--------:|------------:|---------:|----------:|---------:| -| 7508 | 2022-11-21 | 394.64 | 395.82 | 392.66 | 394.59 | 394.59 | 51243200 | 394.923 | 387.237 | -| 7509 | 2022-11-22 | 396.63 | 400.07 | 395.15 | 399.9 | 399.9 | 60429000 | 394.989 | 388.443 | -| 7510 | 2022-11-23 | 399.55 | 402.93 | 399.31 | 402.42 | 402.42 | 68161400 | 395.087 | 389.775 | - -The process can be repeated as required. - -### RSI - -Similar to `ema`, `rsi` adds a column for the Relative Strength Index. The three variables are the same here as above. A period of ten equates to ten trading days, or two-weeks. - -```python -spy = openbb.forecast.rsi(spy, target_column = 'Adj Close', period = 10) - -spy.tail(3) -``` - -| | date | Open | High | Low | Close | Adj Close | Volume | EMA_150 | EMA_20 | RSI_10_Adj Close | -|-----:|:-----------|-------:|-------:|-------:|--------:|------------:|---------:|----------:|---------:|-------------------:| -| 7508 | 2022-11-21 | 394.64 | 395.82 | 392.66 | 394.59 | 394.59 | 51243200 | 394.923 | 387.237 | 58.837 | -| 7509 | 2022-11-22 | 396.63 | 400.07 | 395.15 | 399.9 | 399.9 | 60429000 | 394.989 | 388.443 | 63.7145 | -| 7510 | 2022-11-23 | 399.55 | 402.93 | 399.31 | 402.42 | 402.42 | 68161400 | 395.087 | 389.775 | 65.8484 | - -Let's add another column for a twelve-week period: - -```python -spy = openbb.forecast.rsi(spy, target_column = 'Adj Close', period = 60) - -spy.tail(3) -``` - -| | date | Open | High | Low | Close | Adj Close | Volume | EMA_150 | EMA_20 | RSI_10_Adj Close | RSI_60_Adj Close | -|-----:|:-----------|-------:|-------:|-------:|--------:|------------:|---------:|----------:|---------:|-------------------:|-------------------:| -| 7508 | 2022-11-21 | 394.64 | 395.82 | 392.66 | 394.59 | 394.59 | 51243200 | 394.923 | 387.237 | 58.837 | 50.5453 | -| 7509 | 2022-11-22 | 396.63 | 400.07 | 395.15 | 399.9 | 399.9 | 60429000 | 394.989 | 388.443 | 63.7145 | 51.4456 | -| 7510 | 2022-11-23 | 399.55 | 402.93 | 399.31 | 402.42 | 402.42 | 68161400 | 395.087 | 389.775 | 65.8484 | 51.8685 | - -### STO - -Some of the Feature Engineering commands require multiple columns, `openbb.forecast.sto` is one of them. - -```python -help(openbb.forecast.sto) -``` - -```console -Stochastic Oscillator %K and %D : A stochastic oscillator is a momentum indicator comparing a particular closing price of a security to a range of its prices over a certain period of time. %K and %D are slow and fast indicators. - -Requires Low/High/Close columns. -Note: This will drop first rows equal to period due to how this metric is calculated. - -Parameters ----------- -close_column: str - Column name for closing price -high_column: str - Column name for high price -low_column: str - Column name for low price -dataset : pd.DataFrame - The dataset you wish to calculate for -period : int - Span - -Returns - ------- -pd.DataFrame - Dataframe with added STO K & D columns -``` - -The results of these calculations appends the dataset with two additional columns. - -```python -spy = openbb.forecast.sto( - dataset = spy, - high_column='High', - low_column = 'Low', - close_column = 'Adj Close', - period = 20 -) - -spy.tail(3) -``` - -| date | Open | High | Low | Close | Adj Close | Volume | EMA_150 | EMA_20 | RSI_10_Adj Close | RSI_60_Adj Close | SO%K_20 | SO%D_20 | -|:--------------------|-------:|-------:|-------:|--------:|------------:|------------:|----------:|---------:|-------------------:|-------------------:|----------:|----------:| -| 2022-11-21 00:00:00 | 394.64 | 395.82 | 392.66 | 394.59 | 394.59 | 5.12432e+07 | 394.923 | 387.237 | 58.837 | 50.5453 | 76.969 | 79.1396 | -| 2022-11-22 00:00:00 | 396.63 | 400.07 | 395.15 | 399.9 | 399.9 | 6.0429e+07 | 394.989 | 388.443 | 63.7145 | 51.4456 | 92.8102 | 83.6814 | -| 2022-11-23 00:00:00 | 399.55 | 402.93 | 399.31 | 402.42 | 402.42 | 6.81614e+07 | 395.087 | 389.775 | 65.8484 | 51.8685 | 98.5062 | 89.4285 | - -## Exploration - -As made evident by the composite dataset created, the name of a column can be undesirable. The exploration functions provide some tools for managing and maintaining the dataset. - -### Rename - -Column names can be altered with `openbb.forecast.rename`. One column can be changed: - -```python -spy = openbb.forecast.rename(spy, 'RSI_10_Adj Close', 'RSI_10') - -spy.tail(1) -``` - -| date | Open | High | Low | Close | Adj Close | Volume | EMA_150 | EMA_20 | RSI_10 | RSI_60_Adj Close | SO%K_20 | SO%D_20 | -|:--------------------|-------:|-------:|-------:|--------:|------------:|------------:|----------:|---------:|---------:|-------------------:|----------:|----------:| -| 2022-11-23 00:00:00 | 399.55 | 402.93 | 399.31 | 402.42 | 402.42 | 6.81614e+07 | 395.087 | 389.775 | 65.8484 | 51.8685 | 98.5062 | 89.4285 | - -Let's rename a few more to make working with them a little easier, this time using the Python-method: - -```python -spy.rename(columns = { - 'RSI_60_Adj Close': 'RSI_60', - 'SO%K_20': 'STO_Slow', - 'SO%D_20': 'STO_Fast'}, inplace = True) -``` - -Verify the names were updated as intended with a console print: - -```console -spy.columns - - Index(['Open', 'High', 'Low', 'Close', 'Adj Close', 'Volume', 'EMA_150', 'EMA_20', 'RSI_10', 'RSI_60', STO_Slow', 'STO_Fast'], dtype='object') -``` - -### Delete - -Say, for example, that we would like to eliminate the `Close` column in favour of the adjusted-close values. First, delete the desired column: - -```python -openbb.forecast.delete(spy, 'Close') -``` - -Then, let's rename, 'Adj Close', as, 'Close', and verify the results: - -```python -spy = openbb.forecast.rename(spy, 'Adj Close', 'Close') - -spy.tail(1) -``` - -| date | Open | High | Low | Close | Volume | EMA_150 | EMA_20 | RSI_10 | RSI_60 | STO_Slow | STO_Fast | -|:--------------------|-------:|-------:|-------:|--------:|------------:|----------:|---------:|---------:|---------:|-----------:|-----------:| -| 2022-11-23 00:00:00 | 399.55 | 402.93 | 399.31 | 402.42 | 6.81614e+07 | 395.087 | 389.775 | 65.8484 | 51.8685 | 98.5062 | 89.4285 | - -## Models - -Some models are more taxing on system resources than others, and some take considerably longer to run. Changes to parameters can have dramatic effects on the forecast, be sure to make note of the changes while tuning the hyper-parameters. There are also two distinct types of models: - -- Those with the ability to target past-covariates. -- Those without the ability to target past-covarites. - -We currently recommend using the `_chart` version for every model. - -Models of the former type are: - -- `linregr` -- `regr` -- `brnn` -- `nbeats` -- `nhits` -- `tcn` -- `trans` -- `tft` - -All models default to `past-covariates = None`, and targets for past covariates are selected with a comma-separated list of names, as demonstrated below. - -### regr_chart - -`openbb.forecast.regr_chart` is a regression model which can forecast with, or without, past-covariates. The first example below is without. - -```python -openbb.forecast.regr_chart(spy, target_column = 'Close') -``` - -```console -Predicting Regression for 5 days - -Regression model obtains MAPE: 1.90% -``` - -![openbb.forecast.regr_chart](https://user-images.githubusercontent.com/85772166/203897290-330de1a6-056b-475b-9206-44658ebe5239.png "openbb.forecast.regr_chart") - -|Datetime |Prediction| -|:----------|--------:| -|2022-11-24 |403.06| -|2022-11-25 |401.95| -|2022-11-28 |402.69| -|2022-11-29 |402.55| -|2022-11-30 |399.84| - -Then, targeting both EMA columns as past-covariates: - -```python -openbb.forecast.regr_chart(spy, target_column = 'Close', past_covariates= "EMA_150,EMA_20") -``` - -```console -Warning: when using past covariates n_predict must equal output_chunk_length. We have changed your output_chunk_length to 5 to match your n_predict - -Covariate #0: EMA_150 -Covariate #1: EMA_20 - -Predicting Regression for 5 days - -Regression model obtains MAPE: 1.85% -``` - -![openbb.forecast.regr_chart](https://user-images.githubusercontent.com/85772166/203897358-1111b8f6-e907-4ac6-a97d-327c87e07f1e.png "openbb.forecast.regr_chart") - -|Datetime |Prediction| -|:----------|--------:| -|2022-11-24 |403.20| -|2022-11-25 |401.95| -|2022-11-28 |402.15| -|2022-11-29 |400.99| -|2022-11-30 |398.01| - -Adding these past-covariates has improved the MAPE by 0.05%, which is a good thing; like golf, a lower score is better. - -A second chart displayed by a regression model is for "explainability", SHAP values. It is an illustration of which past-covariates have the most impact on the model output. - -![Explainability](https://user-images.githubusercontent.com/85772166/203897584-37898fee-611f-47c1-abd0-23e2ef21613a.png "Explainability") - -Targeting the `Volume` column as a past-covariate reveals it to be negatively impacting the forecast, in this particular instance and application. - -```python -openbb.forecast.regr_chart(spy, target_column = 'Close', past_covariates="Volume") -``` - -![openbb.forecast.regr_chart](https://user-images.githubusercontent.com/85772166/203897625-9a71960a-29a1-40e1-8c5e-2950bddd1a9c.png "openbb.forecast.regr_chart") - -### Combine - -Let's add another potential past-covariate to the dataset by taking the adjusted-close value of `XOM`, and using `combine` to join the column with our existing DataFrame. - -```python -xom = openbb.stocks.load("XOM", start_date = '1993-01-29') -spy = openbb.forecast.combine(df1 = spy, df2 = xom, column = 'Adj Close', dataset = 'XOM' ) -spy.rename(columns = {'XOM_Adj Close': 'XOM'}, inplace = True) -``` - -### Corr - -`openbb.forecast.corr` calculates the correlation between all columns in a dataset. - -```python -openbb.forecast.corr(spy) -``` - -| | Open | High | Low | Close | Volume | EMA_150 | EMA_20 | RSI_10_Adj Close | RSI_60 | STO_Slow | STO_Fast | XOM | -|:-----------------|----------:|----------:|----------:|----------:|-----------:|-----------:|----------:|-------------------:|------------:|------------:|------------:|-----------:| -| Open | 1 | 0.999928 | 0.999907 | 0.996296 | 0.102601 | 0.990844 | 0.995626 | 0.0485853 | 0.0685473 | 0.631412 | 0.635814 | 0.725111 | -| High | 0.999928 | 1 | 0.999845 | 0.996388 | 0.105301 | 0.991371 | 0.995819 | 0.0468199 | 0.0648085 | 0.63298 | 0.637221 | 0.724806 | -| Low | 0.999907 | 0.999845 | 1 | 0.996337 | 0.0988936 | 0.990313 | 0.995387 | 0.0548303 | 0.0740719 | 0.630126 | 0.634485 | 0.725668 | -| Close | 0.996296 | 0.996388 | 0.996337 | 1 | 0.115854 | 0.995506 | 0.99931 | 0.0544362 | 0.0708491 | 0.62215 | 0.626235 | 0.725945 | -| Volume | 0.102601 | 0.105301 | 0.0988936 | 0.115854 | 1 | 0.143554 | 0.125322 | -0.255959 | -0.3392 | 0.387554 | 0.384561 | 0.470041 | -| EMA_150 | 0.990844 | 0.991371 | 0.990313 | 0.995506 | 0.143554 | 1 | 0.997117 | 0.00795085 | 0.00294935 | 0.63139 | 0.635393 | 0.737946 | -| EMA_20 | 0.995626 | 0.995819 | 0.995387 | 0.99931 | 0.125322 | 0.997117 | 1 | 0.0295848 | 0.0530582 | 0.621829 | 0.625925 | 0.726945 | -| RSI_10_Adj Close | 0.0485853 | 0.0468199 | 0.0548303 | 0.0544362 | -0.255959 | 0.00795085 | 0.0295848 | 1 | 0.707723 | 0.00550661 | 0.00475805 | 0.0316687 | -| RSI_60 | 0.0685473 | 0.0648085 | 0.0740719 | 0.0708491 | -0.3392 | 0.00294935 | 0.0530582 | 0.707723 | 1 | -0.203022 | -0.201585 | 0.00254247 | -| STO_Slow | 0.631412 | 0.63298 | 0.630126 | 0.62215 | 0.387554 | 0.63139 | 0.621829 | 0.00550661 | -0.203022 | 1 | 0.991231 | 0.609652 | -| STO_Fast | 0.635814 | 0.637221 | 0.634485 | 0.626235 | 0.384561 | 0.635393 | 0.625925 | 0.00475805 | -0.201585 | 0.991231 | 1 | 0.613626 | -| XOM | 0.725111 | 0.724806 | 0.725668 | 0.725945 | 0.470041 | 0.737946 | 0.726945 | 0.0316687 | 0.00254247 | 0.609652 | 0.613626 | 1 | - -Let's see how Exxon impacts our previous forecast. - -```python -openbb.forecast.regr_chart(data = spy, target_column = "Close", dataset_name = 'SPY', past_covariates = "EMA_20,EMA_150,XOM") -``` - -```console -Warning: when using past covariates n_predict must equal output_chunk_length. We have changed your output_chunk_length to 5 to match your n_predict - -Covariate #0: EMA_20 -Covariate #1: EMA_150 -Covariate #2: XOM - -Predicting Regression for 5 days - -Regression model obtains MAPE: 1.80% -``` - -|Datetime |Prediction | -|:--------|------:| -|2022-11-24 |401.70 | -|2022-11-25 |402.02 | -|2022-11-26 |402.25 | -|2022-11-27 |401.48 | -|2022-11-28 |397.16 | - -![openbb.forecast.regr_chart](https://user-images.githubusercontent.com/85772166/203897681-e2bfb592-c832-477a-8f24-2604e5ed8254.png "openbb.forecast.regr_chart") - -To include pan/zoom functionality for charts, substitute `%matplotlib widget` in the import statement block. The code block below will recreate the DataFrame as shown in the examples above: - -```python -from openbb_terminal.sdk import openbb -import pandas as pd -# %matplotlib widget (uncomment if using a Jupyter Interactive Terminal or Notebook) - -spy:pd.DataFrame = [] - -spy = openbb.stocks.load('SPY', start_date = '1990-01-01') - -spy = openbb.forecast.ema(spy, target_column = 'Adj Close', period = 150) - -spy = openbb.forecast.ema(spy, target_column = 'Adj Close', period = 20) - -spy = openbb.forecast.rsi(spy, target_column = 'Adj Close', period = 10) - -spy = openbb.forecast.rsi(spy, target_column = 'Adj Close', period = 60) - -spy = openbb.forecast.sto( - dataset = spy, - high_column='High', - low_column = 'Low', - close_column = 'Adj Close', - period = 20 -) - -openbb.forecast.delete(spy, 'Close') - -spy.rename(columns = { - 'Adj Close': 'Close', - 'RSI_60_Adj Close': 'RSI_10', - 'RSI_60_Adj Close': 'RSI_60', - 'SO%K_20': 'STO_Slow', - 'SO%D_20': 'STO_Fast'}, inplace = True) - -xom = openbb.stocks.load("XOM", start_date = '1993-01-29') -openbb.forecast.combine(df1 = spy, df2 = xom, column = 'Adj Close', dataset = 'XOM' ) -spy.rename(columns = {'XOM_Adj Close': 'XOM'}, inplace = True) - -spy -``` - -## Hyper-Parameters - -Hyper-parameters are the fine-tune dials for each model. Refer to the docstrings for the extensive list. The parameters below are the ways in which the regression model can be altered. Each model will be different, and their responses will vary. The demonstrated workflow is a simple way to begin experimenting with the functions. The same general processes can be applied for all models. The purpose of this guide is to help users get going with using the Forecast module, some assembly required. - -```python -help(openbb.forecast.regr_chart) - -Help on Operation in module openbb_terminal.core.library.operation: - - - Display Regression Forecasting - - Parameters - ---------- - data: Union[pd.Series, pd.DataFrame] - Input Data - target_column: str - Target column to forecast. Defaults to "close". - dataset_name: str - The name of the ticker to be predicted - n_predict: int - Days to predict. Defaults to 5. - train_split: float - Train/val split. Defaults to 0.85. - past_covariates: str - Multiple secondary columns to factor in when forecasting. Defaults to None. - forecast_horizon: int - Forecast horizon when performing historical forecasting. Defaults to 5. - output_chunk_length: int - The length of the forecast of the model. Defaults to 1. - lags: Union[int, List[int]] - lagged target values to predict the next time step - export: str - Format to export data - residuals: bool - Whether to show residuals for the model. Defaults to False. - forecast_only: bool - Whether to only show dates in the forecasting range. Defaults to False. - start_date: Optional[datetime] - The starting date to perform analysis, data before this is trimmed. Defaults to None. - end_date: Optional[datetime] - The ending date to perform analysis, data after this is trimmed. Defaults to None. - naive: bool - Whether to show the naive baseline. This just assumes the closing price will be the same - as the previous day's closing price. Defaults to False. - external_axes: Optional[List[plt.axes]] - External axes to plot on -``` diff --git a/website/content/platform/usage/intros/forex.md b/website/content/platform/usage/intros/forex.md deleted file mode 100644 index 2861256b2da9..000000000000 --- a/website/content/platform/usage/intros/forex.md +++ /dev/null @@ -1,220 +0,0 @@ ---- -title: Forex -keywords: [forex, currency, money, hedge, dollar, euro, pound, currencies, market, openbb sdk, how to, usage, examples, import statement, load, average true range, forward rate, path, type, description] -description: The Forex menu enables you to load any combination of currencies (e.g. USDEUR or JPYGBP), show current quote and historical data as well as forward rates. ---- - -import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - - - -The Forex module provides a way for users to get currency pair data, from a number of sources. API keys for them are handled by the Keys module. After importing the entire OpenBB Platform, no further action is required to authorize the sources. This module also provides Oanda account holders with broker integration. - -## How to Use - -Below is a brief description of each function within the Forex module: - -|Path |Type |Description | -|:------------------------------|:----------:|------------------------------:| -|openbb.forex.candle |Function |OHLC Chart & Optional Moving Averages | -|openbb.forex.fwd |Function |Forward Rates of Currency Pairs | -|openbb.forex.get_currency_list |List |List of Currency Symbols | -|openbb.forex.load |Function |Load Historical OHLC Data for Currency Pairs | -|openbb.forex.oanda |Sub-Module |Oanda Broker Integration | -|openbb.forex.quote |Function |Realtime Currency Exchange Rate | - -The contents of the menu is printed with: - -```python -help(openbb.forex) -``` - -## Examples - -### Import Statements - -The examples in this guide will assume that the import statements below are present: - -```python -from openbb_terminal.sdk import openbb -import pandas as pd -``` - -### Load - -The `load` function has the ability to request data from multiple sources: - -- AlphaVantage -- Polygon -- YahooFinance (default) - -Using the default source: - -```python -currency_pair = openbb.forex.load( - from_symbol='USD', - to_symbol='EUR', - start_date = '2000-01-01', - interval = '1week') - -currency_pair.head(3) -``` - -| date | Open | High | Low | Close | Adj Close | Volume | -|:--------------------|--------:|--------:|--------:|--------:|------------:|---------:| -| 2003-12-01 00:00:00 | 0.83098 | 0.83724 | 0.82028 | 0.82163 | 0.82163 | 0 | -| 2003-12-08 00:00:00 | 0.82183 | 0.82488 | 0.81261 | 0.82068 | 0.82068 | 0 | -| 2003-12-15 00:00:00 | 0.82055 | 0.82115 | 0.80373 | 0.80919 | 0.80919 | 0 | - -To use an alternate source, add the `source` argument to the syntax: - -```python -currency_pair = openbb.forex.load( - from_symbol= 'USD', - to_symbol= 'EUR', - source = 'Polygon', - start_date = '2000-01-01', - interval = '1week') - -currency_pair.head(3) -``` - -| date | Volume | vw | Open | Close | High | Low | Transactions | -|:--------------------|---------:|-------:|-------:|--------:|--------:|--------:|---------------:| -| 2012-01-29 00:00:00 | 3758 | 0.761 | 0.7565 | 0.7597 | 0.7676 | 0.7565 | 3758 | -| 2012-02-05 00:00:00 | 5605 | 0.7566 | 0.762 | 0.7581 | 0.7672 | 0.75081 | 5605 | -| 2012-02-12 00:00:00 | 9045 | 0.7611 | 0.757 | 0.7603 | 0.77053 | 0.75278 | 9045 | - -The amount and granularity of historical data available will vary by source. The two tables above illustrate some of those differences. - -### Average True Range - -The loaded data can now be used as inputs for other functions and calculations, such as the average true range over a four week window. - -```python -weekly_atr = openbb.ta.atr(data = currency_pair, window = 4) -currency_pair = currency_pair.join(weekly_atr) - -currency_pair.tail(1) -``` - -| date | Volume | vw | Open | Close | High | Low | Transactions | ATRe_4 | -|:--------------------|---------:|------:|--------:|--------:|--------:|------:|---------------:|----------:| -| 2022-11-13 00:00:00 | 481918 | 0.965 | 0.96479 | 0.96205 | 0.97351 | 0.954 | 481918 | 0.0281756 | - -### Quote - -Get real-time exchange rates. - -```python -openbb.forex.quote("EURUSD", source = "AlphaVantage") -``` - -| | Realtime Currency Exchange Rate | -|:----------------------|:----------------------------------| -| 1. From_Currency Code | USD | -| 2. From_Currency Name | United States Dollar | -| 3. To_Currency Code | EUR | -| 4. To_Currency Name | Euro | -| 5. Exchange Rate | 0.91580000 | -| 6. Last Refreshed | 2023-07-03 17:00:01 | -| 7. Time Zone | UTC | -| 8. Bid Price | 0.91576000 | -| 9. Ask Price | 0.91580000 | - -### Forward Rates - -```python -fwd_usdeur = openbb.forex.fwd('EUR', 'USD') - -fwd_usdeur -``` - -| Expiration | Ask | Bid | Mid | Points | -|:--------------|--------:|--------:|--------:|---------:| -| Overnight | 0.91608 | 0.91602 | 0.91605 | -0.825 | -| Tomorrow Next | 0.91608 | 0.91601 | 0.91604 | -0.855 | -| Spot Next | 0.91612 | 0.91606 | 0.91609 | -0.425 | -| One Week | 0.91586 | 0.9158 | 0.91583 | -2.995 | -| Two Weeks | 0.91557 | 0.9155 | 0.91553 | -5.985 | -| Three Weeks | 0.91526 | 0.91519 | 0.91523 | -9.05 | -| One Month | 0.9147 | 0.91463 | 0.91466 | -14.685 | -| Two Months | 0.91339 | 0.91331 | 0.91335 | -27.81 | -| Three Months | 0.91201 | 0.91194 | 0.91198 | -41.54 | -| Four Months | 0.91064 | 0.91055 | 0.9106 | -55.34 | -| Five Months | 0.90939 | 0.9093 | 0.90934 | -67.885 | -| Six Months | 0.90743 | 0.90732 | 0.90737 | -87.555 | -| Seven Months | 0.90616 | 0.90604 | 0.9061 | -100.32 | -| Eight Months | 0.90501 | 0.90489 | 0.90495 | -111.795 | -| Nine Months | 0.9037 | 0.90358 | 0.90364 | -124.88 | -| Ten Months | 0.90254 | 0.9024 | 0.90247 | -136.6 | -| Eleven Months | 0.90146 | 0.90132 | 0.90139 | -147.375 | -| One Year | 0.90041 | 0.90025 | 0.90033 | -158.025 | -| Two Years | 0.89063 | 0.89017 | 0.8904 | -257.31 | - -Currency pairs will have different term structure composition in the other direction: - -```python -fwd_eurusd = openbb.forex.fwd('USD', 'EUR') - -fwd_eurusd -``` - -| Expiration | Ask | Bid | Mid | Points | -|:--------------|--------:|--------:|--------:|----------:| -| Overnight | 1.09166 | 1.09164 | 1.09165 | 0.985 | -| Tomorrow Next | 1.09161 | 1.09159 | 1.0916 | 0.515 | -| Spot Next | 1.09161 | 1.09159 | 1.0916 | 0.5085 | -| One Week | 1.09192 | 1.09189 | 1.09191 | 3.565 | -| Two Weeks | 1.09228 | 1.09225 | 1.09226 | 7.13 | -| Three Weeks | 1.09264 | 1.09261 | 1.09263 | 10.78 | -| One Month | 1.09332 | 1.09329 | 1.09331 | 17.549 | -| Two Months | 1.09488 | 1.09484 | 1.09486 | 33.14 | -| Three Months | 1.09655 | 1.0965 | 1.09653 | 49.7665 | -| Four Months | 1.09822 | 1.09815 | 1.09818 | 66.32 | -| Five Months | 1.09974 | 1.09967 | 1.09971 | 81.56 | -| Six Months | 1.10215 | 1.10208 | 1.10211 | 105.6 | -| Seven Months | 1.10372 | 1.1036 | 1.10366 | 121.08 | -| Eight Months | 1.10512 | 1.105 | 1.10506 | 135.06 | -| Nine Months | 1.10673 | 1.10661 | 1.10667 | 151.23 | -| Ten Months | 1.10817 | 1.10805 | 1.10811 | 165.64 | -| Eleven Months | 1.10951 | 1.10941 | 1.10946 | 179.09 | -| One Year | 1.11082 | 1.1107 | 1.11076 | 192.08 | -| Two Years | 1.12338 | 1.12296 | 1.12317 | 316.24 | -| Three Years | 1.13422 | 1.1332 | 1.13371 | 421.62 | -| Four Years | 1.14476 | 1.14374 | 1.14425 | 527 | -| Five Years | 1.15647 | 1.15445 | 1.15546 | 639.1 | -| Six Years | 1.16796 | 1.16644 | 1.1672 | 756.5 | -| Seven Years | 1.17936 | 1.17734 | 1.17835 | 868 | -| Ten Years | 1.21166 | 1.20664 | 1.20915 | 1176 | - -Not all currency pairs will have the same length of term structure. - -```python -fwd_eurjpy = openbb.forex.fwd('JPY', 'EUR') -fwd_pairs = fwd_eurjpy.join(fwd_usdeur, on = ['Expiration'], lsuffix = ' EUR/JPY', rsuffix=' USD/EUR') - -fwd_pairs -``` - -| Expiration | Ask EUR/JPY | Bid EUR/JPY | Mid EUR/JPY | Points EUR/JPY | Ask USD/EUR | Bid USD/EUR | Mid USD/EUR | Points USD/EUR | -|:--------------|--------------:|--------------:|--------------:|-----------------:|--------------:|--------------:|--------------:|-----------------:| -| Overnight | 157.959 | 157.951 | 157.955 | -3.17 | 0.91608 | 0.91602 | 0.91605 | -0.825 | -| Tomorrow Next | 157.959 | 157.951 | 157.955 | 0 | 0.91608 | 0.91601 | 0.91604 | -0.855 | -| Spot Next | 157.959 | 157.951 | 157.955 | -1.585 | 0.91612 | 0.91606 | 0.91609 | -0.425 | -| One Week | 157.958 | 157.95 | 157.954 | -11.12 | 0.91586 | 0.9158 | 0.91583 | -2.995 | -| Two Weeks | 157.957 | 157.949 | 157.953 | -22.34 | 0.91557 | 0.9155 | 0.91553 | -5.985 | -| Three Weeks | 157.956 | 157.948 | 157.952 | -33.41 | 0.91526 | 0.91519 | 0.91523 | -9.05 | -| One Month | 157.954 | 157.946 | 157.95 | -53.221 | 0.9147 | 0.91463 | 0.91466 | -14.685 | -| Two Months | 157.949 | 157.941 | 157.945 | -102.35 | 0.91339 | 0.91331 | 0.91335 | -27.81 | -| Three Months | 157.944 | 157.936 | 157.94 | -153.575 | 0.91201 | 0.91194 | 0.91198 | -41.54 | -| Four Months | 157.938 | 157.93 | 157.934 | -209.635 | 0.91064 | 0.91055 | 0.9106 | -55.34 | -| Five Months | 157.933 | 157.925 | 157.929 | -260.55 | 0.90939 | 0.9093 | 0.90934 | -67.885 | -| Six Months | 157.927 | 157.919 | 157.923 | -318.365 | 0.90743 | 0.90732 | 0.90737 | -87.555 | -| Seven Months | 157.922 | 157.913 | 157.918 | -374.29 | 0.90616 | 0.90604 | 0.9061 | -100.32 | -| Eight Months | 157.917 | 157.908 | 157.912 | -425.68 | 0.90501 | 0.90489 | 0.90495 | -111.795 | -| Nine Months | 157.911 | 157.903 | 157.907 | -479.26 | 0.9037 | 0.90358 | 0.90364 | -124.88 | -| Ten Months | 157.906 | 157.897 | 157.901 | -536.525 | 0.90254 | 0.9024 | 0.90247 | -136.6 | -| Eleven Months | 157.9 | 157.892 | 157.896 | -586.775 | 0.90146 | 0.90132 | 0.90139 | -147.375 | -| One Year | 157.895 | 157.887 | 157.891 | -637.185 | 0.90041 | 0.90025 | 0.90033 | -158.025 | -| Two Years | 157.841 | 157.831 | 157.836 | -1190.55 | 0.89063 | 0.89017 | 0.8904 | -257.31 | diff --git a/website/content/platform/usage/intros/futures.md b/website/content/platform/usage/intros/futures.md deleted file mode 100644 index c2359133dda8..000000000000 --- a/website/content/platform/usage/intros/futures.md +++ /dev/null @@ -1,123 +0,0 @@ ---- -title: Futures -keywords: [forex, currency, money, hedge, dollar, euro, futures, future, interest, rates, forwards, commodities, bonds, treasuries, bond, gold, oil, openbb terminal, sdk, how to, usage, examples, path, type, description, import statement, search, curve, historical] -description: Learn how to use and see examples of the Futures menu, which provides historical prices and the current term structure for an asset. ---- - -import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - - - -The functions from the OpenBB Terminal Futures menu is part of the Platform layer, and provides methods for programmatically accessing the data and charts associated with them. Get started by importing the OpenBB Platform to the Python script or Jupyter Notebook file. - - -## How to Use - -Below is a brief description of each function within the Futures module: - -|Path |Type |Description | -|:---------|:---------:|------------------------------:| -|openbb.futures.curve |Function |Futures Forward Curve Data -|openbb.futures.curve_chart |Function |Futures Forward Curve Chart -|openbb.futures.search |Function |Search Available Futures -|openbb.futures.historical |Function |Historical OHLC+V Data -|openbb.futures.historical_chart |Function |Chart Historical Price of Individual Contracts - -## Examples - -### Import Statements - -The examples here will assume that the block below is included at the top of the file: - -```python -from openbb_terminal.sdk import openbb -import pandas as pd -%matplotlib inline -``` - -### Search - -Futures can be searched by description, exchange, or category. - -```python -openbb.futures.search(description = 'Eurodollar') -``` - -| | Ticker | Description | Exchange | Category | -|----:|:---------|:-------------------------------------|:-----------|:-----------| -| 66 | GE | Eurodollar Futures | CME | currency | -| 67 | GLB | One-Month Eurodollar Futures | CME | currency | -| 152 | SED | SED (SOFR-Eurodollar) Spread Futures | CME | bonds | - -The historical front-month price is captured to a DataFrame with: - -### Curve - -The forward curve data for a symbol is fetched with: - -```python -eurodollar = openbb.futures.curve('GE') -``` - -|Expiration | Futures | -|:--------------------|----------:| -| 2022-11-01 00:00:00 | 95.3561 | -| 2022-12-01 00:00:00 | 94.9925 | -| 2023-01-01 00:00:00 | 94.985 | -| 2023-02-01 00:00:00 | 94.9 | -| 2023-03-01 00:00:00 | 94.825 | - -To display a chart of the data, use `curve_chart`: - -```python -openbb.futures.curve_chart(symbol = 'GE') -``` - -![openbb.futures.curve_chart](https://user-images.githubusercontent.com/85772166/202352342-eecf872d-8934-42e7-8b53-4e3415bc2993.png "openbb.futures.curve_chart") - -### Historical - -The `historical` function can fetch the historical front-month price: - -```python -wti_continuous = obb.futures.historical('CL') -``` - -Or, while actively trading, individual contracts. The example below requests historical data for the December WTI contract from 2023 to 2030, starting at the first recorded trading day of the December 2030 contract. - -```python -cl_2312 = openbb.futures.historical(symbols = ['CL'], expiry = '2023-12') -cl_2312 = cl_2312.rename(columns={'Adj Close':'2023-12'}) -cl_2412 = openbb.futures.historical(symbols = ['CL'], expiry = '2024-12') -cl_2412 = cl_2412.rename(columns={'Adj Close':'2024-12'}) -cl_2512 = openbb.futures.historical(symbols = ['CL'], expiry = '2025-12') -cl_2512 = cl_2512.rename(columns={'Adj Close':'2025-12'}) -cl_2612 = openbb.futures.historical(symbols = ['CL'], expiry = '2026-12') -cl_2612 = cl_2612.rename(columns={'Adj Close':'2026-12'}) -cl_2712 = openbb.futures.historical(symbols = ['CL'], expiry = '2027-12') -cl_2712 = cl_2712.rename(columns={'Adj Close':'2027-12'}) -cl_2812 = openbb.futures.historical(symbols = ['CL'], expiry = '2028-12') -cl_2812 = cl_2812.rename(columns={'Adj Close':'2028-12'}) -cl_2912 = openbb.futures.historical(symbols = ['CL'], expiry = '2029-12') -cl_2912 = cl_2912.rename(columns={'Adj Close':'2029-12'}) -cl_3012 = openbb.futures.historical(symbols = ['CL'], expiry = '2030-12') -cl_3012 = cl_3012.rename(columns={'Adj Close':'2030-12'}) - -historical = pd.DataFrame(data = [cl_2312['2023-12'],cl_2412['2024-12'],cl_2512['2025-12'],cl_2612['2026-12'],cl_2712['2027-12'],cl_2812['2028-12'],cl_2912['2029-12'],cl_3012['2030-12']]).transpose() -historical = historical.dropna() - -historical -``` - -| Date | 2023-12 | 2024-12 | 2025-12 | 2026-12 | 2027-12 | 2028-12 | 2029-12 | 2030-12 | -|:--------------------|----------:|----------:|----------:|----------:|----------:|----------:|----------:|----------:| -| 2020-01-24 00:00:00 | 49.61 | 50.14 | 50.7 | 51.56 | 51.63 | 51.63 | 51.63 | 51.63 | -| 2020-01-27 00:00:00 | 49.94 | 50.6 | 51.18 | 51.05 | 51.12 | 51.12 | 51.12 | 51.12 | -| 2020-01-28 00:00:00 | 50.17 | 50.78 | 51.23 | 51.55 | 51.62 | 51.62 | 51.62 | 51.62 | -| 2020-01-29 00:00:00 | 50.07 | 50.64 | 51.13 | 51.6 | 51.67 | 51.67 | 51.67 | 51.67 | -| 2020-01-30 00:00:00 | 50.27 | 50.91 | 51.44 | 51.49 | 51.56 | 51.56 | 51.56 | 51.56 | -| 2022-11-09 00:00:00 | 76.69 | 71.62 | 68.01 | 65.1 | 62.52 | 60.17 | 58.12 | 56.49 | -| 2022-11-10 00:00:00 | 77 | 71.64 | 67.89 | 64.86 | 62.26 | 59.91 | 57.86 | 56.23 | -| 2022-11-11 00:00:00 | 78.81 | 73.1 | 69.22 | 66.19 | 63.6 | 61.25 | 59.2 | 57.57 | -| 2022-11-14 00:00:00 | 77.4 | 72.35 | 68.89 | 66.15 | 63.62 | 61.25 | 59.13 | 57.5 | -| 2022-11-15 00:00:00 | 78.82 | 73.66 | 70.14 | 67.36 | 64.94 | 62.62 | 60.49 | 58.68 | diff --git a/website/content/platform/usage/intros/portfolio/index.md b/website/content/platform/usage/intros/portfolio/index.md deleted file mode 100644 index 6ff58fe53741..000000000000 --- a/website/content/platform/usage/intros/portfolio/index.md +++ /dev/null @@ -1,307 +0,0 @@ ---- -title: Portfolio -keywords: [portfolio, attribution, optimization, pnl, benchmark, return, volatility, metrics, broker, integration, report, optimization, risk, benchmark, brokers, function, holdings, assets, returns, examples, import statement, load, show, perf, summary, maxdd, resharpe, rvol, dret] -description: The Portfolio menu, and its sub-menus, are dedicated to properly explaining and optimizing your own portfolio. ---- - -import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - - - -The [Portfolio menu](/terminal/usage/intros/portfolio), from the OpenBB Terminal, is wrapped into a Python Platform layer, enabling users to programmatically work with the data in a flexible environment, fully customizable for the needs of any user. This guide will introduce the functions within the main Portfolio module, and walk through examples demonstrating how to work with a portfolio file and object. - -## How to Use - -Below is a brief description of each function within the Portfolio module: - -| Path | Type | Description | -| :------------------------- | :--------: | -------------------------------------------: | -| openbb.portfolio.alloc | Sub-Module | Allocation Metrics Compared to the Benchmark | -| openbb.portfolio.bench | Function | Select a Benchmark for the Portfolio | -| openbb.portfolio.distr | Function | Distribution of Daily Returns | -| openbb.portfolio.dret | Function | Daily Returns | -| openbb.portfolio.es | Function | Expected Shortfall | -| openbb.portfolio.holdp | Function | Holdings of Assets as a % | -| openbb.portfolio.holdv | Function | Holdings of Assets as an Absolute Value | -| openbb.portfolio.load | Function | Load a Portfolio File | -| openbb.portfolio.maxdd | Function | Maximum Drawdown | -| openbb.portfolio.metric | Sub-Module | Risk and Portfolio Metrics | -| openbb.portfolio.mret | Function | Monthly Returns | -| openbb.portfolio.om | Function | Omega Ratio | -| openbb.portfolio.perf | Function | Portfolio Performance vs Benchmark | -| openbb.portfolio.po | Sub-Module | Portfolio Optimization Sub Menu | -| openbb.portfolio.rbeta | Function | Rolling Beta of Portfolio and Benchmark Returns | -| openbb.portfolio.rsharpe | Function | Rolling Sharpe Ratio | -| openbb.portfolio.rsort | Function | Rolling Sortino Ratio | -| openbb.portfolio.rvol | Function | Rolling Volatility | -| openbb.portfolio.show | Function | Portfolio Transactions | -| openbb.portfolio.summary | Function | Summary of Portfolio and Benchmark Returns | -| openbb.portfolio.var | Function | Portfolio VaR | -| openbb.portfolio.yret | Function | Yearly Returns | - -Alternatively, the contents of the Porfolio module is printed with: - -```python -help(openbb.portfolio) -``` - -Many of the functions in this module will also have a companion command, `_chart`. - -### Portfolio Files - -Portfolio files are spreadsheets (xlsx or csv files) containing historical trades which add up to represent a net balance in the Portfolio Engine. Users should keep their collection of holdings files in the OpenBBUserData folder, `~/OpenBBUserData/portfolio/holdings`. - -:::note If you wish to load in your own Excel holdings file, please follow the following steps: -1. Download the Excel file that can be used as a template [here](https://www.dropbox.com/s/03wjjf1lfkqjmtn/holdings_example.xlsx?dl=0). -2. Move the file inside the `portfolio/holdings` folder within the [OpenBBUserData](https://docs.openbb.co/terminal/usage/advanceddata) folder and, optionally, adjust the name to your liking. -3. Open the Excel file and remove, edit or add to the values as you desire (e.g. your own orders). This is the default template that is also loaded in with `load --example`. -4. Open up the OpenBB Terminal, go to `portfolio` and type `load --file`. Your Excel file should then be one of the options. -::: - -Note that the Excel sheet requires the following columns: - -- **Date** - The date the trade occurred -- **Name** - The name of the security -- **Type** - The type of the security. Use Cash/Stock/Crypto/ETF as appropriate -- **Price** - The price the security was added or removed at, on a per-unit - basis -- **Quantity** - How much of the security in question was added or removed -- **Side** - Whether you bought or sold. Use Buy/Deposit/1 to add to the - portfolio or Sell/Withdrawal/0 to remove from the portfolio a search criteria, - country, sector or industry. - - -The table below illustrates the required column titles: - -| Date | Type | Ticker | Side | Price | Quantity | Fees | Investment | Currency | Sector | Industry | Country | Region | -|:-----------|:-------|:---------|:-------|--------:|-----------:|-------:|-------------:|:-----------|:-----------------------|:-------------------------------|:--------------|:--------------| -| 2021-10-29 | STOCK | K.TO | Buy | 7.93 | 190 | 20 | 1526.7 | CAD | Basic Materials | Gold | Canada | North America | -| 2015-01-02 | ETF | SPY | Buy | 178.28 | 5.6 | 0 | 998.368 | USD | - | - | - | - | -| 2015-01-01 | CRYPTO | BTC-USD | Buy | 1000 | 2 | 0 | 2000 | USD | Crypto | Crypto | Crypto | Crypto | -| 2011-01-03 | STOCK | AMZN | Buy | 9.22 | 100 | 0 | 922 | USD | Consumer Cyclical | Internet Retail | United States | North America | -| 2011-01-03 | STOCK | AAPL | Buy | 11.74 | 100 | 0 | 1174 | USD | Technology | Consumer Electronics | United States | North America | -| 2011-01-03 | STOCK | MSFT | Buy | 28.04 | 100 | 0 | 2804 | USD | Technology | Software-Infrastructure | United States | North America | -| 2011-01-03 | STOCK | TSLA | Buy | 1.76 | 100 | 0 | 176 | USD | Consumer Cyclical | Auto Manufacturers | United States | North America | -| 2011-01-03 | STOCK | GOOG | Buy | 15.01 | 100 | 0 | 1501 | USD | Communication Services | Internet Content & Information | United States | North America | - -The template Excel file also has additional columns but these are _optional_. The OpenBB Platform can figure out by itself what industry, sector, country and region belongs to the loaded in Equity. So the field can be left blank if your holdings do not include this information. - -## Examples - -The examples in this guide will assume that the import statements below are included at the top of the Python script or Jupyter Notebook. - -### Import Statements - -```python -from openbb_terminal.sdk import openbb -import pandas as pd -# %matplotlib inline (uncomment if using a Jupyter Notebook or an Interactive Window) -``` - -### Load - -Taking the downloaded `holdings_example.xlsx` file from the previous section, let's load it into the Portfolio Engine. There are a few parameters available for this function, and an object is returned. - -```python -help(openbb.portfolio.load) -``` - -```console - Get PortfolioEngine object - - Parameters - ---------- - transactions_file_path : str - Path to transactions file - benchmark_symbol : str - Benchmark ticker to download data - full_shares : bool - Whether to mimic the portfolio trades exactly (partial shares) or round down the - quantity to the nearest number - risk_free_rate : float - Risk free rate in float format - - Returns - ------- - PortfolioEngine - PortfolioEngine class instance, this will hold transactions and perform calculations - - Examples - -------- - >>> from openbb_terminal.sdk import openbb - >>> p = openbb.portfolio.load("openbb_terminal/miscellaneous/portfolio_examples/holdings/example.csv") -``` - -The syntax should resemble something like the sample below; don't forget to modify the path to match the local path. - -```python -P = openbb.portfolio.load( - transactions_file_path = '/Users/path_to/OpenBBUserData/portfolio/holdings/holdings_example.xlsx', - benchmark_symbol = 'VTI', - full_shares = False, - risk_free_rate = 3.0 -) -``` - -```console -Preprocessing transactions: 100%|██████████| 14/14 [00:01<00:00, 8.82it/s] - Loading price data: 100%|██████████| 3/3 [00:01<00:00, 2.64it/s] - Calculating returns: 100%|██████████| 1/1 [00:00<00:00, 14.52it/s] - Loading benchmark: 100%|██████████| 4/4 [00:04<00:00, 1.21s/it] -``` - -### The Portfolio Object - -A Portfolio Object is assigned to the variable, `P`. The created object, or parts of it, are used as inputs to the other functions in this module. It can also be interacted with directly, for example, to change the benchmark ticker. `SPY` is a holding in the example portfolio, so let's stick with `VTI` as the performance benchmark. - -```python -P.set_benchmark(symbol = 'SPY') - - Loading benchmark: 50%|█████ | 2/4 [00:00<00:00, 5.69it/s] - -print(P.benchmark_ticker) - -SPY -``` - -Populating a list of tickers from the Portfolio Object is accomplished by assigning a variable to it: - -```python -tickers = P.tickers_list -print(tickers) - -['SPY', 'TSLA', 'K.TO', 'AAPL', 'AMZN', 'MSFT', 'BTC-USD', 'GOOG'] -``` - -### Show - -`openbb.portfolio.show` is for displaying the transactions from the loaded portfolio file. Scroll back up to view the output of this function again. - -```python -openbb.portfolio.show(P) -``` - -### Perf - -Performance against the benchmark is summarized in a table with, `openbb.portfolio.perf`. - -```python -print(openbb.portfolio.perf(P)) -``` - -| | Portfolio | Benchmark | Difference | -|:-----------------|:-------------------|:-------------------|:------------------| -| Total Investment | 11102.07 | 11102.07 | - | -| Total Value | 114027.38 | 36203.96 | 77823.43 | -| Total % Return | 927.08% | 226.10% | 700.98% | -| Total Abs Return | 102925.31 | 25101.89 | 77823.43 | - -### Summary - -`openbb.portfolio.summary` prints a table of risk metrics, comparing the portfolio against the benchmark. - -```python -print(openbb.portfolio.summary(P)) -``` - -| | Portfolio | Benchmark | Difference | -|:-----------------|:---------------------|:--------------------|:---------------------| -| Volatility | 1.65% | 0.99% | 0.66% | -| Skew | -0.32 | -0.61 | 0.29 | -| Kurtosis | 8.80 | 16.87 | -8.079 | -| Maximum Drawdown | -59.05% | -35.00% | -24.05% | -| Sharpe ratio | 0.05 | 0.039 | 0.011 | -| Sortino ratio | 0.06 | 0.04 | 0.021 | -| R2 Score | 41.36% | 41.36% | 0.00% | - -### MaxDD - -`openbb.portfolio.maxdd` calculates the maximum drawdown as price and % value; it returns a Tuple. - -```python -holdings,dd = openbb.portfolio.maxdd(P) -dd = pd.DataFrame(dd) -dd.rename(columns = {'Total': 'Portfolio % Drawdown'}, inplace = True) -holdings = pd.DataFrame(holdings) -holdings.rename(columns = {'Total': 'Portfolio Value'}, inplace = True) -dd = dd.join(holdings) -dd.index = dd.index.strftime(date_format='%Y-%m-%d') -print(dd.tail(5)) -``` - -| Date | Portfolio % Drawdown | Portfolio Value | -|:-----------|-------------:|-----------:| -| 2022-11-21 | -0.58 | 109442 | -| 2022-11-22 | -0.57 | 111257 | -| 2022-11-23 | -0.56 | 114017 | -| 2022-11-24 | -0.56 | 114027 | -| 2022-11-25 | -0.56 | 113302 | - -MaxDD also has a `_chart` command, and is called with: - -```python -openbb.portfolio.maxdd_chart(P) -``` - -![openbb.portfolio.maxdd_chart](https://user-images.githubusercontent.com/85772166/204072456-f6b8e038-08ef-4ac5-9920-14a9c1e4197f.png "openbb.portfolio.maxdd_chart") - -### RSharpe - -Calculate a rolling sharpe ratio over a specified window. - -```python -rs = openbb.portfolio.rsharpe(P, window = '3m') -rs.rename(columns = {'portfolio': 'Portfolio Sharpe', 'benchmark': 'Benchmark Sharpe'}, inplace = True) -rs.index = rs.index.strftime(date_format='%Y-%m-%d') -print(rs.tail(5)) -``` - -| Date | Portfolio Sharpe | Benchmark Sharpe | -|:-----------|-------------------:|-------------------:| -| 2022-11-21 | -0.15 | 0.02 | -| 2022-11-22 | -0.13 | 0.05 | -| 2022-11-23 | -0.09 | 0.07 | -| 2022-11-24 | -0.09 | 0.08 | -| 2022-11-25 | -0.09 | 0.11 | - -### RVol - -`openbb.portfolio.rvol` has the same input parameters as `rsharpe`. - -```python -rv = openbb.portfolio.rvol(P, window = '3m') -rv.rename(columns={'portfolio': 'Portfolio Volatility', 'benchmark': 'Benchmark Volatility'}, inplace = True) -rv.index = rv.index.strftime(date_format='%Y-%m-%d') - -print(rv.tail(5)) -``` - -| Date | Portfolio Volatility | Benchmark Volatility | -|:-----------|-----------------------:|---------------------:| -|2022-11-23 | 0.021727 | 0.014490| -|2022-11-24 | 0.021715 | 0.014439| -|2022-11-25 | 0.021596 | 0.014256| -|2022-11-26 | 0.021591 | 0.014256| -|2022-11-27 | 0.021592 | 0.014256| - -### DRet - -`openbb.portfolio.dret` returns a DataFrame with daily returns of the portfolio and benchmark. - -```python -returns = openbb.portfolio.dret(P) -returns.rename(columns = {'portfolio': 'Portfolio % Returns', 'benchmark': 'Benchmark % Returns'}, inplace = True) -returns.index = returns.index.rename('Date') - -print(returns.tail(5)) -``` - -| Date | Portfolio % Returns | Benchmark % Returns | -|:-----------|----------------------:|----------------------:| -| 2022-11-21 | -0.03 | -0.00 | -| 2022-11-22 | 0.02 | 0.01 | -| 2022-11-23 | 0.02 | 0.01 | -| 2022-11-24 | 0.00 | 0.00 | -| 2022-11-25 | -0.01 | 0.00 | - -Read the [Portfolio Optimization Intro](https://docs.openbb.co/platform/usage/intros/portfolio/po) to learn about the optimization features, and the parameters preset template. diff --git a/website/content/platform/usage/intros/portfolio/po.md b/website/content/platform/usage/intros/portfolio/po.md deleted file mode 100644 index 4f409b13cc09..000000000000 --- a/website/content/platform/usage/intros/portfolio/po.md +++ /dev/null @@ -1,187 +0,0 @@ ---- -title: Portfolio Optimization -keywords: [portfolio, attribution, optimization, pnl, benchmark, return, volatility, metrics, broker, integration, report, how to, parameters, template, examples] -description: The Portfolio Optimization menu allows the user to apply advanced optimization techniques to a portfolio of any type and of any size. ---- - -import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - - - -The Portfolio Optimization menu allows the user to apply advanced optimization techniques to a portfolio of any type and of any size. It does so by introducing a multitude of optimization techniques ranging from mean-variance optimization to risk parity models and hierarchical clustering models. By providing Excel templates, the user can make sense of the vast array of parameters that each command has. E.g. think of the historic period you wish to use or which of the more than 10 risk measures and covariance methods should be used? These are questions the templates make easier to answer. - -The capabilities of the [Portfolio Optiminzation menu](/terminal/usage/intros/portfolio/po) from the OpenBB Terminal are wrapped into a powerful Platform, enabling users to work with the data in a flexible environment that can be fully customized to meet the needs of any user. These functionalities allow the user to apply advanced optimization techniques to a portfolio of any type and of any size. It does so by introducing a multitude of optimization techniques ranging from mean-variance optimization to risk parity models and hierarchical clustering models. By providing Excel templates, the user can make sense of the vast array of parameters that each command has. E.g. think of the historic period you wish to use or which of the more than 10 risk measures and covariance methods should be used? These are questions the templates make easier to answer. - -## How to use -Start a Python script or Notebook file by importing the module: - -```python -from openbb_terminal.sdk import openbb -``` - -This menu requires the usage of the Excel templates to work properly. As there is a lot of complexity involved around these techniques, these templates allow the user to understand what values for each parameter are actually used and allow for an easy way to define the allocation. - -:::note If you wish to load in your own Excel allocation file, please follow the following steps: -1. Download the Excel file that can be used as a template [here](https://www.dropbox.com/s/wp1lcq86exyngjy/allocation_example.xlsx?dl=0). -2. Move the file inside the `portfolio/allocation` folder within the [OpenBBUserData](https://docs.openbb.co/terminal/usage/guides///data) folder and, optionally, adjust the name to your liking. -3. Open the Excel file and remove, edit or add to the values as you desire (e.g. your own allocation). This is the default template that is also loaded in with `load --example`. -4. The file can now be used by following the guide. -::: - -Furthermore, given the amount of options you can choose from in each command and giving the complexity of the topic, we also provide a parameter file (both .xlsx and .ini to adjust parameters in a user-friendly way). - -:::note If you wish to load in your own Excel or ini parameter file, please follow the following steps: -1. Download the file that can be used as a template: [xlsx](https://www.dropbox.com/s/qfhd7ntj7mlwsuc/parameters_template.xlsx?dl=0) (recommended) or [ini](https://www.dropbox.com/s/3ehwg3hiwm89hgo/parameters_template.ini?dl=0) (advanced). -2. Move the file inside the `portfolio/optimization` folder within the [OpenBBUserData](https://docs.openbb.co/terminal/usage/guides/data) folder and, optionally, adjust the name to your liking. -3. Open the file and set parameters as you wish. -4. Open up the OpenBB Terminal, go to `portfolio/po` and type `file --file`. The file should then be one of the options. -::: - -### OpenBB Parameters Template -This template provides the user with the ability to set define values for each parameter based on the optimization technique that is deployed. E.g. if you select `riskparity` for the `technique` parameter, you will notice that some parameters turn grey. This means that the parameter is irrelevant for the selected method. - -The OpenBB Terminal does, however, allow the user to run any model despite the `technique` you selected. Therefore, if you are interested in running multiple models, consider removing the value for `technique`. Do note that this makes it more difficult to understand which values are used for which model. - -OpenBB Parameters Template - -### OpenBB Portfolio Template -This template hands the user a format to work with it to define the portfolio. Here, categorization is applied based on asset class, sector, industry, country and currency. By using the dropdown menus within this Excel, you are able to apply the proper categorization. This is based on the same methodology as found in other areas of the terminal. - -OpenBB Portfolio Template - -You can load in the portfolio template with the following code: - -```python -import pandas as pd - -# Define your own orderbook path here, current value won't work -order_book_path = "allocation_example.xlsx" - -# Read in the file -order_book = pd.read_excel(order_book_path) - -# Adjust the columns accordingly -order_book_cols = ['Ticker', 'Asset Class', 'Sector', 'Industry', 'Country', - 'Current Invested Amount', 'Currency'] - -order_book = order_book[order_book_cols] - -# Load in the portfolio -p = openbb.portfolio.po.load(symbols_file_path=order_book_path) -weights, performance = openbb.portfolio.po.equal(portfolio_engine=p) -``` - -### Performing optimization -Based on the parameters and allocation the user has set, the optimization process begins. What optimization technique is ideal depends entirely on the user's risk profile and objectives. As an illustration, Risk Parity is presented below: - -```python -# Perform calculations -weights_riskparity, data_returns_riskparity = openbb.portfolio.po.riskparity(p) - -weights_riskparity -``` - -Which returns: - -| | Risk Parity | -|:------|--------------:| -| AAPL | 0.0462 | -| AMZN | 0.04545 | -| APTV | 0.03177 | -| ASML | 0.03328 | -| BABA | 0.04192 | -| GOOGL | 0.04758 | -| HYG | 0.13093 | -| NKE | 0.04909 | -| TIP | 0.30826 | -| TLT | 0.21927 | -| TSM | 0.04626 | - -It is possible to use the commands without loading in the parameters template or by using the parameters template but changing some arguments directly into the terminal. For example, using the same method as described above, the risk measure is changed to Conditional Value at Risk (CVaR) and the used historic period is increased to 10 years (keeping all other parameters unchanged): - -```python -# Perform calculations -weights_riskparity, data_returns_riskparity = openbb.portfolio.po.riskparity(p, interval="5y", risk_measure="CVaR") - -weights_riskparity -``` - -Which returns: - -| | Risk Parity | -|:------|--------------:| -| AAPL | 0.04843 | -| AMZN | 0.04302 | -| APTV | 0.03907 | -| ASML | 0.03717 | -| GOOGL | 0.04877 | -| HYG | 0.14643 | -| NKE | 0.05275 | -| TIP | 0.33264 | -| TLT | 0.20371 | -| TSM | 0.04802 | - - - -## Examples -Starting by loading in the same dataset again with the following: - -```python -import pandas as pd - -# Define your own orderbook path here, current value won't work -order_book_path = "allocation_example.xlsx" - -# Read in the file -order_book = pd.read_excel(order_book_path) - -# Adjust the columns accordingly -order_book_cols = ['Ticker', 'Asset Class', 'Sector', 'Industry', 'Country', - 'Current Invested Amount', 'Currency'] - -order_book = order_book[order_book_cols] - -# Load in the portfolio -P = openbb.portfolio.po.load(symbols_file_path=order_book_path) -``` - -Then, the Hierarchical Risk Parity technique is applied by using the following: - -```python -riskparity, data_returns_riskparity = openbb.portfolio.po.hrp(p, interval="5y", - risk_measure='SLPM', - risk_aversion=0.8) - -print(riskparity) -print(data_returns_riskparity) -``` - -This results in a similar result as the following: - -| | Hierarchical Risk Parity | -|:------|---------------------------:| -| A | 0.00199 | -| AAL | 0.00104 | -| AAP | 0.00185 | -| AAPL | 0.00184 | -| ABBV | 0.0028 | -| ... | ... | -| NOC | 0.00228 | -| XOM | 0.00167 | -| ZBRA | 0.00156 | -| ZION | 0.0014 | -| ZTS | 0.00225 | - -It is possible to delve further into these findings with the `plot` functionality for example done by looking at the portfolio's returns histogram which also includes a variety of risk measures as well as the portfolio's drawdowns. - -```` -openbb.portfolio.po.plot(p, category='SECTOR', chart_type="hist") -```` - -Portfokio Returns Histogram - -```` -openbb.portfolio.po.plot(p, category='SECTOR', chart_type="dd") -```` - -Portfolio Drawdowns diff --git a/website/content/platform/usage/intros/quantitative-analysis.md b/website/content/platform/usage/intros/quantitative-analysis.md deleted file mode 100644 index b461c4bc7949..000000000000 --- a/website/content/platform/usage/intros/quantitative-analysis.md +++ /dev/null @@ -1,168 +0,0 @@ ---- -title: Quantitative Analysis -keywords: [quantitative, analysis, qa, q/a, daily, indicators, signals, average, summary, normality, line, hist, cdf, bw, acf, qqplot, rolling, spread, quantile, skew, kurtosis, var, es, sh, so, om, raw, decompose, cusum, capm, beta, histogram, auto-correlation, value, median, crypto, forex, fx, cryptocurrency, stocks, how to, usage, examples, import statement, get data, unit root test] -description: Learn how to use and see examples of the Quantitative Analysis menu, which is common across many sections of the OpenBB Terminal. This guide describes the features and commands. ---- - -import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - - - -The `qa` module is the Terminal's Quantitative Analysis menu for the Platform environment. It provides users with more ways to interact with the library of functions, and provides cross-disciplinary utility. To activate the code completion for the menu, enter `.` after, `openbb.qa`. - -## How to Use - -The functions of the `qa` module are grouped into categories, listed below along with a short description. - -|Path |Type |Description | -|:----------|:----------:|--------------------:| -|openbb.qa.acf |Plot |Plots Auto and Partial Correlation of Returns and Change in Returns| -|openbb.qa.bw |Plot |Box and Whisker Plot | -|openbb.qa.calculate_adjusted_var |Risk |Calculates VaR, adjusted for skew and kurtosis (Cornish-Fisher-Expansion) | -|openbb.qa.cdf |Plot |Plots the Cumulative Distribution Function | -|openbb.qa.cusum |Plot |Plots the Cumulative Sum Algorithm | -|openbb.qa.decompose |Plot |Decomposition in Cyclic-Trend, Season & Residuals of Prices | -|openbb.qa.es |Statistics |Expected Shortfall per percentile | -|openbb.qa.kurtosis |Rolling Metrics |Rolling Kurtosis of Distribution of Prices | -|openbb.qa.line |Plot |Customizable Line Plot, With Annotations | -|openbb.qa.normality |Statistics |Normality Statistics and Tests | -|openbb.qa.omega |Risk |Omega Ratio (Risk/Return Performance Measure) | -|openbb.qa.quantile |Rolling Metrics |Rolling Median and Quantile of Prices | -|openbb.qa.qqplot |Plot |QQ Plot for Data Against Normal Quantiles | -|openbb.qa.rolling |Rolling Metrics |Rolling Mean and Standard Deviation of Prices | -|openbb.qa.sharpe |Risk |Sharpe Ratio (Measure of Risk-Adjusted Return) | -|openbb.qa.skew |Rolling Metrics |Rolling Skewness of Distribution of Prices | -|openbb.qa.sortino |Risk |Sortino Ratio Risk Adjustment Metric | -|openbb.qa.spread |Rolling Metrics |Rolling Variance and Standard Deviation of Prices | -|openbb.qa.summary |Statistics |A Brief Summary of Statistics for the DataFrame | -|openbb.qa.unitroot |Statistics |Normality Statistics and Tests | -|openbb.qa.var |Risk |Value at Risk | - -## Examples - -### Import Statements - -The examples below will assume that the following statements are included in the first block of code: - -```python -import quandl -import pandas as pd -from openbb_terminal.sdk import openbb -from openbb_terminal import config_terminal as cfg - -# %matplotlib inline (uncomment if using a Jupyter environment) -``` - -### Get Data - -This example collects data from Nasdaq Data Link, and requires registering for a free API key. Qunadl is the Python client for the Nasdaq Data Link API. - -```python -shiller_pe_rdiff = quandl.get('MULTPL/SHILLER_PE_RATIO_MONTH', collapse = 'monthly', transform = 'rdiff', api_key = cfg.API_KEY_QUANDL) -shiller_pe_rdiff.rename(columns={'Value':'P/E % Change'}, inplace = True) -shiller_pe_ratio = quandl.get('MULTPL/SHILLER_PE_RATIO_MONTH', collapse = 'monthly', api_key = cfg.API_KEY_QUANDL) -shiller_pe_ratio.rename(columns={'Value':'P/E Ratio'}, inplace = True) - -sp500_inf_adj = quandl.get('MULTPL/SP500_INFLADJ_MONTH', collapse = 'monthly', api_key = cfg.API_KEY_QUANDL) -sp500_inf_adj.rename(columns = {'Value': 'S&P Inflation-Adjusted Value'}, inplace = True) -sp500_inf_adj_rdiff = quandl.get('MULTPL/SP500_INFLADJ_MONTH', collapse = 'monthly', transform = 'rdiff', api_key = cfg.API_KEY_QUANDL) -sp500_inf_adj_rdiff.rename(columns = {'Value':'S&P 500 % Change'}, inplace = True) - -shiller_pe = shiller_pe_ratio.join(shiller_pe_rdiff) -sp500_inf_adj = sp500_inf_adj.join(sp500_inf_adj_rdiff) - -sp500_df = sp500_inf_adj.join(shiller_pe) - -sp500_df -``` - -| Date | S&P Inflation-Adjusted Value | S&P 500 % Change | P/E Ratio | P/E % Change | -|:--------------------|-------------------------------:|-------------------:|------------:|---------------:| -| 2022-08-31 00:00:00 | 3955 | 0.0092504 | 29.64 | 0.022069 | -| 2022-09-30 00:00:00 | 3585.62 | -0.0933957 | 26.84 | -0.0944669 | -| 2022-10-31 00:00:00 | 3871.98 | 0.0798635 | 28.53 | 0.0629657 | -| 2022-11-30 00:00:00 | 3856.1 | -0.00410126 | 28.37 | -0.00560813 | - -This particular data series contains 150 years of monthly values. It is among the longest uninterrupted timeseries available in the public domain, and it is cited frequently in macroeconomic research. - -### Summary - -Get a summary of statistics for each column with `qa.summary`: - -```python -openbb.qa.summary(sp500_df) -``` - -| | S&P Inflation-Adjusted Value | S&P 500 % Change | P/E Ratio | P/E % Change | -|:------|-------------------------------:|-------------------:|------------:|---------------:| -| count | 1823 | 1822 | 1822 | 1821 | -| mean | 697.396 | 0.0028703 | 16.9914 | 0.00137084 | -| std | 834.501 | 0.0424378 | 7.07094 | 0.0412196 | -| min | 80.31 | -0.264738 | 4.78 | -0.268992 | -| 10% | 152.404 | -0.0447494 | 9.31 | -0.0449735 | -| 25% | 203.47 | -0.0172803 | 11.7 | -0.0183028 | -| 50% | 309.83 | 0.00553122 | 15.895 | 0.00446999 | -| 75% | 778.42 | 0.0260009 | 20.5575 | 0.0246575 | -| 90% | 1907.87 | 0.04505 | 26.467 | 0.0426357 | -| max | 4786.79 | 0.514085 | 44.19 | 0.511986 | -| var | 696392 | 0.00180097 | 49.9982 | 0.00169906 | - -### Spread - -Add the variance and standard deviation, over a specified window (three-months), to the DataFrame: - -```python -std,variance = openbb.qa.spread(data = sp500_df['S&P 500 % Change'], window = 3) -std.rename(columns = {'STDEV_3':'Three-Month Standard Deviation'}, inplace = True) -variance.rename(columns = {'VAR_3': 'Three-Month Variance'}, inplace =True) -sp500_df = sp500_df.join([std,variance]) -sp500_df.rename_axis('date', inplace = True) -sp500_df.tail(2) -``` - -| date | S&P Inflation-Adjusted Value | S&P 500 % Change | P/E Ratio | P/E % Change | Three-Month Standard Deviation | Three-Month Variance | -|:--------------------|-------------------------------:|-------------------:|------------:|---------------:|---------------------------------:|-----------------------:| -| 2022-10-31 00:00:00 | 3871.98 | 0.0798635 | 28.53 | 0.0629657 | 0.0871217 | 0.00759019 | -| 2022-11-30 00:00:00 | 3856.1 | -0.00410126 | 28.37 | -0.00560813 | 0.0866432 | 0.00750705 | - -The rolling mean average and standard deviation is calculated with the `rolling` command. Adding, `_chart`, to this will return an inline chart within a Jupyter Notebook. For the example below, window, `60`, represents a five-year period. - -### Rolling - -```python -openbb.qa.rolling_chart(sp500_df, target = 'P/E Ratio', window = 60, symbol = '') -``` - -![openbb.qa.rolling_chart](https://user-images.githubusercontent.com/85772166/202975615-4400ae87-9cd7-4481-94f1-dfb69de784d6.png "openbb.qa.rolling_chart") - -### Unit Root Test - -Perform a unit root test with `unitroot`: - -```python -help(openbb.qa.unitroot) - - Parameters - ---------- - data : pd.DataFrame - DataFrame of target variable - fuller_reg : str - Type of regression of ADF test. Can be ‘c’,’ct’,’ctt’,’nc’ 'c' - Constant and t - trend order - kpss_reg : str - Type of regression for KPSS test. Can be ‘c’,’ct' - - Returns - ------- - pd.DataFrame - Dataframe with results of ADF test and KPSS test - -openbb.qa.unitroot(sp500_df['P/E % Change']) -``` - -| | ADF | KPSS | -|:---------------|---------------:|:--------------------| -| Test Statistic | -10.7075 | 0.34061374135067696 | -| P-Value | 3.3972e-19 | 0.1 | -| NLags | 20 | 2 | -| Nobs | 1800 | | -| ICBest | -6491.14 | | diff --git a/website/content/platform/usage/intros/stocks/behavioral-analysis.md b/website/content/platform/usage/intros/stocks/behavioral-analysis.md deleted file mode 100644 index 63c2df4d499d..000000000000 --- a/website/content/platform/usage/intros/stocks/behavioral-analysis.md +++ /dev/null @@ -1,144 +0,0 @@ ---- -title: Behavioral Analysis -keywords: [stocks, behaviour, analysis, ba, headlines, snews, wsb, watchlist, popular, spac, trending, stalking, bullbear, messages, inter, sentiment, Google, Twitter, Reddit, Stocktwits, SentimentInvestor, Cramer, Jim, mentions, regions, interest, queries, rise, trend, hist, jcrd, jctr, how to, usage] -description: The Behavioural Analysis menu offers the user tools for gauging the overall public sentiment of a company online. The complexity of the tools range from message board scrapers to deep learning algorithms for financial analysis and prediction. ---- - -import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - - - -The BA module provides programmatic access to the commands from within the OpenBB Terminal. Import the OpenBB Platform module, and then access the functions similarly to how the Terminal menus are navigated. The code completion will be activated upon entering `.`, after, `openbb.ba` -​ - -## How to Use - -​ -The examples provided below will assume that the following import block is included at the beginning of the Python script or Notebook file: -​ - -```python -from openbb_terminal.sdk import openbb -``` - -​ -A brief description below highlights the main Functions and Modules available in the BA Platform - -| Path | Type | Description | -| :------------------------- | :--------: | -------------------------------------------: | -| openbb.stocks.ba.bullbear | Function | Estimate Quick Sentiment | -| openbb.stocks.ba.headlines | Function | Sentiment from 15+ News Headlines | -| openbb.stocks.ba.spacc | Function | Shows SPAC announcements from SPAC subreddit | -| openbb.stocks.ba.watchlist | Function | Show Other User's Watchlists | -| openbb.stocks.ba.messages | Function | Output last 30 messages on the board | -| openbb.stocks.ba.mentions | Function | Interest Over Time Based on Mentions | -| openbb.stocks.ba.hist | Function | Plot Historical RHI and AHI | -| openbb.stocks.ba.snews | Function | Stock Price Plotted Over Sentiment | -| openbb.stocks.ba.redditsent | Function | Search for Tickers and Find Sentiment | -| openbb.stocks.ba.popular | Function | Show Popular Tickers | -| openbb.stocks.ba.spac | Function | Shows Other User's SPAC Announcements | -| openbb.stocks.ba.getdd | Function | Get Due Diligence | -| openbb.stocks.ba.regions | Function | Regions Showing the Highest Interest | -| openbb.stocks.ba.trending | Function | Trending Stocks | -| openbb.stocks.ba.wsb | Function | Highlights from WSB Subreddit | -| openbb.stocks.ba.queries | Function | Top Related Queries | -| openbb.stocks.ba.sentiment | Function | Stock Sentiment Prediction from Last Tweets | -| openbb.stocks.ba.infer | Function | Stock Sentiment from Last Tweets | -| openbb.stocks.ba.stalker | Function | Stocktwit's last messages | -| openbb.stocks.ba.rise | Function | Top Rising Related Queries | - -Alternatively you can print the contents of the BA Platform with: - -```python -help(openbb.stocks.ba) -``` - -## Examples - -### headlines - -Sentiment from over 15 news headlines for each day. This data can be used for further analysis of the stock - -```python -openbb.stocks.ba.headlines("TSLA") -``` - -| date | Sentiment Analysis | -|:--------------------|---------------------:| -| 2022-11-09 00:00:00 | 0.209 | -| 2022-11-10 00:00:00 | -0.025 | -| 2022-11-11 00:00:00 | 0.027 | -| 2022-11-14 00:00:00 | -0.402 | -| 2022-11-15 00:00:00 | -0.122 | -| 2022-11-16 00:00:00 | -0.35 | -| 2022-11-17 00:00:00 | 0.156 | -| 2022-11-18 00:00:00 | 0.216 | -| 2022-11-21 00:00:00 | -0.071 | -| 2022-11-22 00:00:00 | -0.003 | - -### regions - -See the top regions where a stock is searched - -```python -openbb.stocks.ba.regions("TSLA") -``` - -| geoName | TSLA | -|:---------------------------------------|-------:| -| Canada | 100 | -| United States | 95 | -| Singapore | 94 | -| Estonia | 51 | -| Taiwan | 50 | -| Slovenia | 40 | -| Switzerland | 36 | -| Denmark | 36 | -| New Zealand | 33 | -| Sweden | 31 | -| Finland | 24 | -| Australia | 24 | -| Belgium | 22 | -| Czechia | 20 | -| Bulgaria | 18 | -| United Arab Emirates | 17 | -| United Kingdom | 15 | -| Portugal | 12 | -| Austria | 11 | -| Romania | 10 | -| South Africa | 7 | -| Saudi Arabia | 7 | -| Germany | 7 | -| Argentina | 6 | -| Spain | 6 | -| France | 4 | -| Colombia | 4 | -| Philippines | 4 | -| Brazil | 4 | -| Thailand | 4 | -| Poland | 3 | -| Vietnam | 2 | -| Russia | 2 | -| Turkey | 2 | -| Pakistan | 0 | - -### rise - -See which search queries are popular right now - -```python -openbb.stocks.ba.rise("AAPL") -``` - -| | query | value | -|---:|:----------------|--------:| -| 0 | nio | 220300 | -| 1 | nio stock | 106650 | -| 2 | pltr stock | 64750 | -| 3 | mrna stock | 59750 | -| 4 | nio stock price | 53450 | -| 5 | zm stock | 49500 | -| 6 | bynd | 44850 | -| 7 | pltr | 41000 | -| 8 | spce | 37350 | -| 9 | zm | 31650 | diff --git a/website/content/platform/usage/intros/stocks/comparison-analysis.md b/website/content/platform/usage/intros/stocks/comparison-analysis.md deleted file mode 100644 index bdbb3c112718..000000000000 --- a/website/content/platform/usage/intros/stocks/comparison-analysis.md +++ /dev/null @@ -1,146 +0,0 @@ ---- -title: Comparison Analysis -keywords: [comparison, analysis, ca, menu, submenu, stocks, compare, correlation, similar, historical, hcorr, volume, income, balance, cashflow, sentiment, scorr, overview, valuation, financial, ownership, performance, technical, tsne, get --source Polygon, get --source Finnhub, get, set, add, rmv, Polygon, Finnhub, Finviz, Yahoo, yFinance, FinBrain, market, watch, openbb terminal, sdk, how to, usage] -description: The Comparison Analysis menu provides the user with tools for comparison (similar) stocks. It is not necessary to load a ticker from the Stocks menu to use these features. ---- - -import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - - - -The CA module provides programmatic access to the commands from within the OpenBB Terminal menu. Import the OpenBB Platform module, and then access the functions similarly to how the Terminal menus are navigated. The code completion will be activated upon entering `.`, after, `openbb.ca` - -## How to Use - -The examples provided below will assume that the following import block is included at the beginning of the Python script or Notebook file: - -```python -from openbb_terminal.sdk import openbb -``` - -A brief description below highlights the functions available within the module: - -| Path | Type | Description | -| :-------------------------------- | :--------: | -------------------------------------------: | -| openbb.stocks.ca.balance | Function | Balance Financials Comparison | -| openbb.stocks.ca.cashflow | Function | Cashflow Financials Comparison | -| openbb.stocks.ca.hcorr | Function | Historical Price Correlation | -| openbb.stocks.ca.hist | Function | Historical Price Data Comparison | -| openbb.stocks.ca.income | Function | Income Financials Comparison | -| openbb.stocks.ca.scorr | Function | Sentiment Correlation | -| openbb.stocks.ca.screener | Function | Screener Overview | -| openbb.stocks.ca.sentiment | Function | Sentiment Analysis Comparison | -| openbb.stocks.ca.similar | Function | Get a List of Similar Companies | -| openbb.stocks.ca.volume | Function | Historical Volume Data Comparison | - -Alternatively, the contents of the menu is printed with: - -```python -help(openbb.stocks.ca) -``` - -## Examples - -### Balance - -`openbb.stocks.ca.balance` compares the balance sheets for a list of companies. - -```python -openbb.stocks.ca.balance(["TSLA","F", "GE"], timeframe = '2021') -``` - -| Item | TSLA | F | GE | -|:-------------------------------------|:-------|:--------|:--------| -| Cash & Short Term Investments | 18.05B | 49.59B | 28.07B | -| Cash & Short Term Investments Growth | -8.00% | -0.74% | -35.99% | -| Cash Only | 17.92B | 20.54B | 15.77B | -| Short-Term Investments | - | - | - | -| Cash & ST Investments / Total Assets | 29.05% | 19.29% | 14.11% | -| Total Accounts Receivable | 1.91B | 44.04B | 20.5B | -| Total Accounts Receivable Growth | 1.43% | -16.24% | -8.70% | -| Accounts Receivables, Net | 1.91B | 43.91B | 20.5B | -| Accounts Receivables, Gross | 1.91B | 44.28B | 21.58B | -| Bad Debt/Doubtful Accounts | - | (366M) | (1.07B) | -| Other Receivable | - | - | - | -| Accounts Receivable Turnover | 28.14 | 3.10 | 3.62 | -| Inventories | 5.76B | 12.07B | 15.85B | -| Finished Goods | 1.28B | 6.28B | 4.93B | -| Work in Progress | 1.09B | - | - | -| Raw Materials | 3.39B | 5.79B | 8.71B | -| Progress Payments & Other | - | - | 2.21B | -| Other Current Assets | 1.38B | 3.3B | 1.93B | -| Miscellaneous Current Assets | 1.38B | 3.3B | 1.93B | -| Total Current Assets | 27.1B | 109B | 66.35B | -| Net Property, Plant & Equipment | 31.18B | 64.84B | 15.61B | -| Property, Plant & Equipment - Gross | 39.87B | 101.99B | 31.9B | -| Buildings | 4.68B | 12.44B | 8.31B | -| Land & Improvements | - | 450M | 585M | -| Computer Software and Equipment | 1.41B | 4.6B | - | -| Other Property, Plant & Equipment | 18.73B | 11.4B | - | -| Accumulated Depreciation | 8.69B | 37.16B | 16.3B | -| Total Investments and Advances | 223M | 5.64B | 42.21B | -| Other Long-Term Investments | 223M | 197M | 42.21B | -| Long-Term Note Receivables | 299M | 51.26B | - | -| Intangible Assets | 1.72B | 619M | 35.51B | -| Net Goodwill | 200M | 619M | 26.18B | -| Net Other Intangibles | - | - | - | -| Other Assets | 1.62B | 11.89B | 28.34B | -| Total Assets | 62.13B | 257.04B | 198.87B | -| Total Assets Growth | 19.14% | -3.83% | -22.38% | - -### Sentiment - -Social sentiment over time, for a list of tickers: - -```python -openbb.stocks.ca.sentiment(["tsla", "f", "ge"]) -``` - -| | TSLA | F | GE | -|:-----------|-------:|------:|------:| -| 2022-11-08 | -0.028 | 0.382 | 0.328 | -| 2022-11-09 | 0.209 | 0.199 | 0.242 | -| 2022-11-10 | -0.025 | 0.178 | 0.112 | -| 2022-11-11 | 0.027 | 0.086 | 0.056 | -| 2022-11-14 | -0.402 | 0.105 | 0.104 | -| 2022-11-15 | -0.122 | 0.081 | 0.075 | -| 2022-11-16 | -0.35 | 0.179 | 0.086 | -| 2022-11-17 | 0.156 | 0.387 | 0.025 | -| 2022-11-18 | 0.216 | 0.093 | 0.019 | -| 2022-11-21 | -0.071 | 0.069 | 0.01 | - -### Screener - -Show a high-level overview of company information for tickers in a given list - -```python -openbb.stocks.ca.screener(["f", "ge", "tsla"]) -``` - -| | Ticker | Company | Sector | Industry | Country | Market Cap | P/E | Price | Change | Volume | -|---:|:---------|:-------------------------|:------------------|:-------------------------------|:----------|-------------:|-------:|--------:|---------:|------------:| -| 0 | F | Ford Motor Company | Consumer Cyclical | Auto Manufacturers | USA | 5.577e+10 | 6.31 | 13.95 | -0.0029 | 3.40871e+07 | -| 1 | GE | General Electric Company | Industrials | Specialty Industrial Machinery | USA | 9.375e+10 | nan | 85.89 | 0.0048 | 3.26976e+06 | -| 2 | TSLA | Tesla, Inc. | Consumer Cyclical | Auto Manufacturers | USA | 5.3886e+11 | 51.72 | 167.87 | -0.0684 | 9.28827e+07 | - - -### HCorr - -Calculates the historical price (or returns) correlation for a list of tickers, over a specified window. - -```python -correlation,historical = ( - openbb.stocks.ca.hcorr(similar = openbb.stocks.ca.similar('TSLA', source = 'Polygon'), - candle_type = 'R', - start_date = '2018-11-01' - ) -) -correlation -``` - -| | HMC | TM | F | GM | -|:----|---------:|---------:|---------:|---------:| -| HMC | 1 | 0.74425 | 0.596182 | 0.62178 | -| TM | 0.74425 | 1 | 0.532589 | 0.539333 | -| F | 0.596182 | 0.532589 | 1 | 0.787406 | -| GM | 0.62178 | 0.539333 | 0.787406 | 1 | diff --git a/website/content/platform/usage/intros/stocks/dark-pool-shorts.md b/website/content/platform/usage/intros/stocks/dark-pool-shorts.md deleted file mode 100644 index b886a11379c8..000000000000 --- a/website/content/platform/usage/intros/stocks/dark-pool-shorts.md +++ /dev/null @@ -1,218 +0,0 @@ ---- -title: Dark Pools and Short Data -keywords: [darkpools, dps, dark, pools, dp, short, shorts, naked, selling, sales, SEC, disclosure, ATS, OTC, OTCE, NMS, borrowed, shorted, ftd, fails-to-deliver, volume, how to, usage, examples, CTB, POS, spos, psi, hsi] -description: The Introduction to Dark Pools & Short Data, within the Stocks menu, which explains how to use the menu and provides a brief explanation of the features. ---- - -import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - - - -The `DPS` sub-module contains the commands from the [Dark Pools and Short Data menu](https://docs.openbb.co/terminal/usage/intros/stocks/dark-pool-shorts) within the OpenBB Terminal. These functions are meant to supplement other research on technical trading factors, settlement schedules, market flow, and volume dynamics. Commands are specifically for US-listed equities, and the data is reported to [FINRA](https://www.finra.org/#/) on a lagging schedule. Some will also have a `_chart` companion. - -## How to Use - -Each function contained within the `openbb.stocks.dps` module is listed below with a short description. - -|Path |Description | -|:----|-----------:| -|openbb.stocks.dps.ctb |Current Borrow Rates from Interactive Brokers | -|openbb.stocks.dps.dpotc |Weekly Volume Totals for a Ticker on ATS and OTC Venues | -|openbb.stocks.dps.ftd |Historical Fails-to-Deliver Numbers | -|openbb.stocks.dps.hsi |Stocks With High Reported Short Interest | -|openbb.stocks.dps.pos |Top Short Volumes From Last Trading Day | -|openbb.stocks.dps.prom |Tickers With Growing Trade Activity on ATS Tapes | -|openbb.stocks.dps.psi |Price vs. Short Volume | -|openbb.stocks.dps.shorted |Most Shorted Stocks According to Yahoo Finance | -|openbb.stocks.dps.sidtc |Short Interest and Days-to-Cover | -|openbb.stocks.dps.spos |Rolling 20-Day Net Short Volume of a Single Stock| - -## Examples - -### Import Statements - -Start out the Python script or Notebook file with the familiar statements: - -```python -from openbb_terminal.sdk import openbb -import pandas as pd -``` - -### CTB - -`openbb.stocks.dps.ctb` gets the current borrow rate and availability, on Interactive Brokers, for all tickers. - -```python -ctb_df = openbb.stocks.dps.ctb() - -ctb_df -``` - -| | Symbol | Fees | Available | -|---:|:---------|:----------|------------:| -| 0 | PCF | 864.8795% | 100000 | -| 1 | EPR PRE | 625.0102% | 80000 | -| 2 | KITT | 574.4353% | 100 | -| 3 | EFSH | 439.7636% | 2000 | -| 4 | EVTL | 434.336% | 9000 | -| 17655 | DSAIF | 0.0% | 1000 | -| 17656 | DRREF | 0.0% | 25000 | -| 17657 | DOSEF | 0.0% | 100 | -| 17658 | DMYY | 0.0% | 100000 | -| 17659 | DLICY | 0.0% | 100 | - -### POS - -`openbb.stocks.dps.pos` represents the cumulative net short dollar volume (Dark Pool Position $) by security. Is it calculated by taking the net short volume (short volume minus buy volume - a positive number means that the short volume was higher than the buy volume) times the closing price and taking the 20-day cumulative sum of this series. [Source: Stockgrid.io](https://www.stockgrid.io/darkpools) - -- Net Short Volume: Short volume minus buy volume. -- Net Short Volume $: Net short volume multiplied by the last close. -- Position: The sum of the net short volume over the last 20 trading days. -- Position $: Position multiplied by the last close. - -Data is updated at 6pm EST. - -The function returns up to 400 results, applying `ascend = True` unlocks the most negative values. - -```python -pos_high = openbb.stocks.dps.pos() -pos_high = pos_high.convert_dtypes() -pos_high.set_index('Date', inplace = True) -pos_low = openbb.stocks.dps.pos(ascend = True) -pos_low = pos_low.convert_dtypes() -pos_low.set_index('Date', inplace = True) -pos_df = pd.concat([pos_low,pos_high]) -pos_df.sort_values(by=['Dark Pools Position $'], ascending = False, inplace = True) - -pos_df -``` - -| Date | Ticker | Short Volume | Short Volume % | Net Short Volume | Net Short Volume $ | Dark Pools Position | Dark Pools Position $ | -|:-----------|:---------|---------------:|-----------------:|-------------------:|---------------------:|----------------------:|------------------------:| -| 2022-11-25 | SPY | 10511774 | 0.638082 | 4549536 | 1.83041e+09 | 109490269 | 4.27107e+10 | -| 2022-11-25 | QQQ | 2952642 | 0.490496 | -114422 | -3.283e+07 | 130622909 | 3.6231e+10 | -| 2022-11-25 | NVDA | 6264211 | 0.62147 | 2448753 | 3.98412e+08 | 61850799 | 1.00604e+10 | -| 2022-11-25 | IWM | 3932703 | 0.541717 | 605706 | 1.12407e+08 | 34431260 | 6.31318e+09 | -| 2022-11-25 | HYG | 1170511 | 0.523497 | 105076 | 7.88175e+06 | 75184813 | 5.53232e+09 | -| 2022-11-25 | META | 1652587 | 0.359614 | -1290276 | -1.4375e+08 | -88892626 | -8.17035e+09 | -| 2022-11-25 | SQQQ | 6198104 | 0.358094 | -4912392 | -2.20223e+08 | -160324410 | -8.81487e+09 | -| 2022-11-25 | MSFT | 1246644 | 0.356497 | -1003640 | -2.48391e+08 | -60211625 | -1.41156e+10 | -| 2022-11-25 | TSLA | 14145558 | 0.480631 | -1140119 | -2.08482e+08 | -106217407 | -2.06849e+10 | -| 2022-11-25 | AMZN | 9907246 | 0.467855 | -1361394 | -1.27168e+08 | -238062247 | -2.26635e+10 | - -### SPOS - -`openbb.stocks.dps.spos` is a section of the same data above, but as a time-series for individual tickers. There is one-year of daily historical data available. - -```python -spy_spos = openbb.stocks.dps.spos('SPY') - -spy_spos.tail(5) -``` - -| | dates | Net Short Vol. (1k $) | Position (1M $) | -|---:|:--------------------|------------------------:|------------------:| -| 4 | 2021-12-03 00:00:00 | 1218.48 | 10786 | -| 3 | 2021-12-02 00:00:00 | 3224.17 | 9567.52 | -| 2 | 2021-12-01 00:00:00 | 2558.79 | 6343.35 | -| 1 | 2021-11-30 00:00:00 | 2737.27 | 3784.56 | -| 0 | 2021-11-29 00:00:00 | 1047.29 | 1047.29 | - -### PSI - -Price vs.Short Interest. This function has two data sources, with their own syntax. `openbb.stocks.dps.psi_sg` will return the other columns `openbb.stocks.dps.spos` is missing. The example below puts them all together. - -```python -spy_spos = openbb.stocks.dps.spos('SPY') -spy_spos.rename(columns = {'dates':'date'}, inplace= True) -spy_spos.set_index(keys = 'date', inplace =True) -spy_psi,spy_price = openbb.stocks.dps.psi_sg('SPY') -spy_psi.set_index('date', inplace = True) -spy_pos = spy_psi.join(spy_spos) - -spy_pos -``` - -| date | Short Vol. [1M] | Short Vol. % | Short Exempt Vol. [1k] | Total Vol. [1M] | Net Short Vol. (1k $) | Position (1M $) | -|:--------------------|------------------:|---------------:|-------------------------:|------------------:|------------------------:|------------------:| -| 2022-11-25 00:00:00 | 10.5118 | 63.81 | 37.129 | 16.474 | 1830.41 | 42710.7 | -| 2022-11-23 00:00:00 | 13.6484 | 60.55 | 91.552 | 22.5399 | 1914.28 | 42099.3 | -| 2022-11-22 00:00:00 | 10.0279 | 53.85 | 52.335 | 18.6233 | 572.874 | 42444.8 | -| 2022-11-21 00:00:00 | 9.42557 | 57.6 | 61.242 | 16.3632 | 981.734 | 42187.3 | -| 2022-11-18 00:00:00 | 18.445 | 60.68 | 112.603 | 30.3973 | 2571.31 | 42352.3 | -| 2022-02-16 00:00:00 | 11.0333 | 52.77 | 7.958 | 20.909 | 516.966 | 19836.2 | -| 2022-02-15 00:00:00 | 11.8138 | 57.01 | 36.259 | 20.7236 | 1295.52 | 21808.3 | -| 2022-02-14 00:00:00 | 12.744 | 53.08 | 50.473 | 24.0105 | 648.705 | 19105.9 | -| 2022-02-11 00:00:00 | 14.1183 | 46.63 | 55.511 | 30.2776 | -898.962 | 17553.7 | -| 2022-02-10 00:00:00 | 22.5696 | 62.98 | 46.454 | 35.834 | 4181.07 | 21316.8 | - -The other version of this command is, `openbb.stocks.dps.psi_q`. It returns daily short volume from Nasdaq and NYSE separately, with daily historic data going back to 2013, and is sourced by Quandl. The first table below is the short volume and from Nasdaq. - -```python -nasdaq_psi = openbb.stocks.dps.psi_q(nyse=False, symbol = 'SPY') - -nasdaq_psi.head(5) -``` - -| Date | ShortVolume | ShortExemptVolume | TotalVolume | -|:--------------------|--------------:|--------------------:|--------------:| -| 2013-04-01 00:00:00 | 8.99908e+06 | 3500 | 1.92365e+07 | -| 2013-04-02 00:00:00 | 1.15943e+07 | 6600 | 2.09414e+07 | -| 2013-04-03 00:00:00 | 1.89638e+07 | 13418 | 2.83739e+07 | -| 2013-04-04 00:00:00 | 1.29551e+07 | 7586 | 1.99661e+07 | -| 2013-04-05 00:00:00 | 1.43612e+07 | 0 | 2.81504e+07 | - -The second table is from NYSE - -```python -nyse_psi = openbb.stocks.dps.psi_q(nyse=True, symbol = 'SPY') - -nyse_psi.head(5) -``` - -| Date | ShortVolume | ShortExemptVolume | TotalVolume | -|:--------------------|--------------:|--------------------:|--------------:| -| 2013-04-01 00:00:00 | 1.04127e+06 | 3800 | 1.61224e+06 | -| 2013-04-02 00:00:00 | 1.47136e+06 | 4500 | 1.9255e+06 | -| 2013-04-03 00:00:00 | 2.43128e+06 | 0 | 3.23342e+06 | -| 2013-04-04 00:00:00 | 1.55106e+06 | 800 | 2.28563e+06 | -| 2013-04-05 00:00:00 | 1.94417e+06 | 300 | 2.93733e+06 | - -Let's join them together: - -```python -nyse_psi.join(nasdaq_psi, lsuffix = ' (NYSE)', rsuffix = ' (NQ)') -``` - -| Date | ShortVolume (NYSE) | ShortExemptVolume (NYSE) | TotalVolume (NYSE) | ShortVolume (NQ) | ShortExemptVolume (NQ) | TotalVolume (NQ) | -|:--------------------|---------------------:|---------------------------:|---------------------:|-------------------:|-------------------------:|-------------------:| -| 2013-04-01 00:00:00 | 1.04127e+06 | 3800 | 1.61224e+06 | 8.99908e+06 | 3500 | 1.92365e+07 | -| 2013-04-02 00:00:00 | 1.47136e+06 | 4500 | 1.9255e+06 | 1.15943e+07 | 6600 | 2.09414e+07 | -| 2013-04-03 00:00:00 | 2.43128e+06 | 0 | 3.23342e+06 | 1.89638e+07 | 13418 | 2.83739e+07 | -| 2013-04-04 00:00:00 | 1.55106e+06 | 800 | 2.28563e+06 | 1.29551e+07 | 7586 | 1.99661e+07 | -| 2013-04-05 00:00:00 | 1.94417e+06 | 300 | 2.93733e+06 | 1.43612e+07 | 0 | 2.81504e+07 | -| 2022-11-21 00:00:00 | 838081 | 171 | 2.05784e+06 | 8.47984e+06 | 61071 | 1.41414e+07 | -| 2022-11-22 00:00:00 | 1.24058e+06 | 273 | 2.45227e+06 | 8.70804e+06 | 52062 | 1.60467e+07 | -| 2022-11-23 00:00:00 | 1.82258e+06 | 524 | 3.35511e+06 | 1.17129e+07 | 91028 | 1.90024e+07 | -| 2022-11-25 00:00:00 | 410318 | 353 | 804984 | 1.00677e+07 | 36776 | 1.56151e+07 | - -### HSI - -`openbb.stocks.dps.hsi` lists the stocks with the highest reported short interest from NYSE or Nasdaq. - -```python -openbb.stocks.dps.hsi() -``` - -| | Ticker | Company | Exchange | ShortInt | Float | Outstd | Industry | -|---:|:---------|:-------------------------------|:-----------|:-----------|:--------|:---------|:-------------------------------------------| -| 0 | | | | | | | | -| 1 | BBBY | Bed Bath & Beyond Inc. | Nasdaq | 45.11% | 76.45M | 80.36M | Retail (Specialty Non-Apparel) | -| 2 | CVNA | Carvana Co | NYSE | 44.24% | 93.40M | 105.95M | Retail (Specialty Non-Apparel) | -| 3 | BYND | Beyond Meat Inc | Nasdaq | 42.75% | 57.25M | 63.74M | Food Processing | -| 4 | MSTR | MicroStrategy Inc | Nasdaq | 40.51% | 9.34M | 9.35M | Software & Programming | -| 31 | SPCE | Virgin Galactic Holdings Inc | NYSE | 20.98% | 208.85M | 274.56M | Aerospace & Defense | -| 32 | PETS | Petmed Express Inc | Nasdaq | 20.83% | 19.74M | 21.08M | Retail (Drugs) | -| 33 | RIDE | Lordstown Motors Corp | Nasdaq | 20.69% | 162.40M | 216.98M | Auto & Truck Manufacturers | -| 34 | FFIE | Faraday Future Intelligent Ele | Nasdaq | 20.67% | 242.00M | 386.26M | Auto & Truck Manufacturers | -| 35 | IGMS | IGM Biosciences Inc | Nasdaq | 20.57% | 17.31M | 29.14M | Biotechnology & Medical Research | diff --git a/website/content/platform/usage/intros/stocks/discovery.md b/website/content/platform/usage/intros/stocks/discovery.md deleted file mode 100644 index 8e41a638394b..000000000000 --- a/website/content/platform/usage/intros/stocks/discovery.md +++ /dev/null @@ -1,168 +0,0 @@ ---- -title: Discovery -keywords: [stocks, discovery, disc, menu, submenu, pipo, fipo, gainers, losers, ugs, gtech, active, ulc, asc, ford, arkord, upcoming, trending, lowfloat, hotpenny, rtat, divcal, dividends, short, trending, news, how to, usage, examples, filings, screener, overview] -description: Introducing the Discovery menu, within the Stocks menu. This guide will empower the user to get the most out of this set of features. ---- - -import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - - - -The Disc module provides programmatic access to the commands from within the OpenBB Terminal. Import the OpenBB Platform module, and then access the functions similarly to how the Terminal menus are navigated. The code completion will be activated upon entering `.`, after, `openbb.disc` -​ - -## How to Use - -​ -The examples provided below will assume that the following import block is included at the beginning of the Python script or Notebook file: -​ - -```python -from openbb_terminal.sdk import openbb -``` - -​ -A brief description below highlights the main Functions and Modules available in the ETF Platform - -| Path | Type | Description | -| :------------------------- | :--------: | -------------------------------------------: | -| openbb.stocks.disc.filings | Function | Feed of new filings to the SEC | -| openbb.stocks.disc.pipo | Function | Past IPO Dates | -| openbb.stocks.disc.active | Function | Stocks with Highest Trade Volumes | -| openbb.stocks.disc.gainers | Function | Latest Top Gainers | -| openbb.stocks.disc.asc | Function | Small Caps with Earnings Growth Above 25% | -| openbb.stocks.disc.lowfloat | Function | Stocks with Under 10M Shares Float | -| openbb.stocks.disc.fipo | Function | Future IPO Dates | -| openbb.stocks.disc.upcoming | Function | Upcoming Earnings Release Dates | -| openbb.stocks.disc.trending | Function | Trending News | -| openbb.stocks.disc.ulc | Function | Potentially Undervalued Large Cap Stocks | -| openbb.stocks.disc.arkord | Function | Orders of ARK Investment Management LLC | -| openbb.stocks.disc.hotpenny | Function | Hot Penny Stocks | -| openbb.stocks.disc.gtech | Function | Tech Stocks with Earnings Growth Over 25% | -| openbb.stocks.disc.losers | Function | Show Top Losers | -| openbb.stocks.disc.ugs | Function | Undervalueds with Earnings Growth Over 25% | -| openbb.stocks.disc.rtat | Function | Top 10 Retail Traded Stocks | -| openbb.stocks.disc.dividends | Function | Screener Overview | - -Alternatively you can print the contents of the Disc Platform with: - -```python -help(openbb.stocks.disc) -``` - -## Examples - -## filings - -Get the most-recent form submissions to the SEC. - -```python -filings = openbb.stocks.disc.filings() -filings.head(3) -``` - -| Date | Ticker | CIK | Form Type | Title | URL | -|:--------------------|:---------|--------:|:------------|:------------------------------------------------|:--------------------------------------------------------------------------------------------------| -| 2023-01-12 14:09:25 | CYBN | 1833141 | 6-K | 6-K - CYBIN INC. (0001833141) (Filer) | https://www.sec.gov/Archives/edgar/data/1833141/000162828023000949/0001628280-23-000949-index.htm | -| 2023-01-12 13:39:25 | RYAOF | 1038683 | 6-K | 6-K - RYANAIR HOLDINGS PLC (0001038683) (Filer) | https://www.sec.gov/Archives/edgar/data/1038683/000165495423000350/0001654954-23-000350-index.htm | -| 2023-01-12 13:39:25 | RYAAY | 1038683 | 6-K | 6-K - RYANAIR HOLDINGS PLC (0001038683) (Filer) | https://www.sec.gov/Archives/edgar/data/1038683/000165495423000350/0001654954-23-000350-index.htm | - - -```` - -### pipo - -Gives information on companies that recently had an IPO (Initial Public Offering) - -```python -openbb.stocks.disc.pipo() -``` - -| | Past | Exchange | Name | Number of Shares | Price | Status | symbol | Total Shares Value | -|---:|:-----------|:---------------|:-------------------------------|:-------------------|:----------|:----------|:---------|:---------------------| -| 0 | 2022-11-22 | NASDAQ Capital | Adamas One Corp. | 7165904.0 | 4.50-5.00 | expected | JEWL | 38192020.0 | -| 1 | 2022-11-21 | | Solta Medical Corp | | | withdrawn | | | -| 2 | 2022-11-18 | | MGO Global Inc. | | | filed | MGOL | 8625000.0 | -| 3 | 2022-11-18 | | CytoMed Therapeutics Pte. Ltd. | | | filed | GDTC | 15000000.0 | -| 4 | 2022-11-18 | | BKV Corp | | | filed | BKV | 100000000.0 | -| 5 | 2022-11-18 | | Coya Therapeutics, Inc. | | | filed | COYA | 17250000.0 | - -### gainers - -Shows stocks with the biggest percent change in daily growth - -```python -openbb.stocks.disc.gainers() -``` - -| | Symbol | Name | Price (Intraday) | Change | % Change | Volume | Avg Vol (3 month) | Market Cap | PE Ratio (TTM) | -|---:|:---------|:------------------------------------------------|-------------------:|---------:|:-----------|:---------|:--------------------|:-------------|:-----------------| -| 0 | MPCFF | Metro Pacific Investments Corporation | 0.1021 | 0.0273 | +36.50% | 20000 | 24674 | 2.963B | 10.21 | -| 1 | JBARF | Julius Bär Gruppe AG | 56.66 | 11.5 | +25.47% | 47922 | 276 | 14.48B | 12.26 | -| 2 | BURL | Burlington Stores, Inc. | 189.96 | 32.32 | +20.50% | 5.369M | 1.431M | 12.451B | 75.38 | -| 3 | PSNY | Polestar Automotive Holding UK PLC | 7.82 | 1.33 | +20.49% | 8.878M | 2.611M | 16.495B | 4.25 | -| 4 | AEO | American Eagle Outfitters, Inc. | 15.36 | 2.36 | +18.15% | 18.426M | 6.448M | 2.877B | 16.52 | -| 5 | MMS | Maximus, Inc. | 70.34 | 9.8 | +16.19% | 1.016M | 380221 | 4.259B | 23.45 | -| 6 | MRTX | Mirati Therapeutics, Inc. | 86.11 | 11.57 | +15.52% | 5.41M | 857355 | 4.959B | | -| 7 | WMG | Warner Music Group Corp. | 31.09 | 4.11 | +15.23% | 3.496M | 1.209M | 16.007B | 37.91 | -| 8 | TIAOF | Telecom Italia S.p.A. | 0.2477 | 0.0317 | +14.68% | 20000 | 37835 | 5.578B | | -| 9 | MANU | Manchester United plc | 14.94 | 1.91 | +14.66% | 5.253M | 500920 | 2.436B | | -| 10 | BBY | Best Buy Co., Inc. | 79.88 | 9.05 | +12.78% | 17.487M | 3.047M | 17.983B | 10.69 | -| 11 | SGIOY | Shionogi & Co., Ltd. | 13.8 | 1.55 | +12.65% | 217546 | 253257 | 16.545B | 20.0 | -| 12 | DKS | DICK'S Sporting Goods, Inc. | 117.76 | 10.82 | +10.12% | 6.403M | 1.735M | 9.326B | 10.14 | -| 13 | BCDRF | Banco Santander, S.A. | 2.85 | 0.25 | +9.62% | 1.001M | 230746 | 49.706B | 5.09 | -| 14 | EE | Excelerate Energy, Inc. | 30 | 2.63 | +9.61% | 842088 | 466600 | 3.248B | 16.39 | -| 15 | URBN | Urban Outfitters, Inc. | 27.8 | 2.27 | +8.89% | 7.168M | 2.121M | 2.562B | 11.26 | -| 16 | WHITF | Whitehaven Coal Limited | 6.2 | 0.5 | +8.77% | 39639 | 62464 | 5.762B | 4.37 | -| 17 | LINRF | Liontown Resources Limited | 1.5 | 0.12 | +8.70% | 36150 | 4637 | 3.295B | 150.0 | -| 18 | MBLY | Mobileye Global Inc. | 29.55 | 2.33 | +8.56% | 1.327M | 1.848M | 23.837B | | -| 19 | A | Agilent Technologies, Inc. | 156.86 | 11.72 | +8.07% | 3.468M | 1.406M | 46.437B | 35.81 | -| 20 | FUTU | Futu Holdings Limited | 54.39 | 3.99 | +7.92% | 4.094M | 2.489M | 7.995B | 27.61 | -| 21 | SYM | Symbotic Inc. | 10.77 | 0.79 | +7.92% | 442139 | 215487 | 5.983B | | -| 22 | KAEPF | The Kansai Electric Power Company, Incorporated | 8.36 | 0.6 | +7.73% | 21794 | 5106 | 7.93B | 17.79 | -| 23 | HL | Hecla Mining Company | 5.17 | 0.37 | +7.71% | 11.242M | 8.056M | 3.134B | 172.33 | -| 24 | RKLIF | Rentokil Initial plc | 6.52 | 0.47 | +7.68% | 29704 | 3911 | 16.434B | 36.23 | - -​ - -### rtat - -Shows information on how retail investors are trading a particular ticker - -```python -openbb.stocks.disc.rtat() -``` - -| | Date | Ticker | Activity | Sentiment | -|-----:|:-----------|:---------|-----------:|------------:| -| 0 | 2022-11-22 | TSLA | 0.0681 | 1 | -| 1 | 2022-11-22 | TQQQ | 0.0159 | -2 | -| 2 | 2022-11-22 | SQQQ | 0.0219 | 0 | -| 3 | 2022-11-22 | SPY | 0.0387 | 1 | -| 4 | 2022-11-22 | QQQ | 0.019 | -1 | -| 5 | 2022-11-22 | NVDA | 0.0427 | -3 | -| 6 | 2022-11-22 | META | 0.0137 | -1 | -| 7 | 2022-11-22 | AMZN | 0.0333 | -1 | -| 8 | 2022-11-22 | AMD | 0.0317 | -3 | -| 9 | 2022-11-22 | AAPL | 0.0307 | -5 | -| 10 | 2022-11-21 | TSLA | 0.0763 | 0 | -| 11 | 2022-11-21 | TQQQ | 0.0169 | 1 | -| 12 | 2022-11-21 | SQQQ | 0.0249 | -3 | -| 13 | 2022-11-21 | SPY | 0.0354 | 2 | -| 14 | 2022-11-21 | QQQ | 0.0203 | 2 | -| 15 | 2022-11-21 | NVDA | 0.0312 | -3 | -| 16 | 2022-11-21 | DIS | 0.0367 | 1 | -| 17 | 2022-11-21 | AMZN | 0.035 | 0 | -| 18 | 2022-11-21 | AMD | 0.0275 | -1 | -| 19 | 2022-11-21 | AAPL | 0.0322 | -3 | -| 20 | 2022-11-18 | TSLA | 0.0621 | -1 | -| 21 | 2022-11-18 | TQQQ | 0.0246 | -1 | -| 22 | 2022-11-18 | SQQQ | 0.0274 | -1 | -| 23 | 2022-11-18 | SPY | 0.0456 | 1 | -| 24 | 2022-11-18 | QQQ | 0.0235 | -3 | -| 25 | 2022-11-18 | NVDA | 0.0376 | -5 | -| 26 | 2022-11-18 | META | 0.0141 | 3 | -| 27 | 2022-11-18 | AMZN | 0.0338 | 0 | -| 28 | 2022-11-18 | AMD | 0.0379 | 0 | -| 29 | 2022-11-18 | AAPL | 0.0403 | -3 | -| 30 | 2022-11-17 | TSLA | 0.0563 | -1 | diff --git a/website/content/platform/usage/intros/stocks/fundamental-analysis.md b/website/content/platform/usage/intros/stocks/fundamental-analysis.md deleted file mode 100644 index e21554d87785..000000000000 --- a/website/content/platform/usage/intros/stocks/fundamental-analysis.md +++ /dev/null @@ -1,371 +0,0 @@ ---- -title: Fundamental Analysis -keywords: [fundamentals, fundamental, fa, ratios, earnings, balance, income, cash, statement, statements, sec, multiples, price, ebitda, ebitdam, revenue, quarter, annual, change, company, performance, filing, filings, 10K, 8K, audit, audited, due diligence, research, company, ticker, analyst, rating, rot, pt, est, sec, supplier, customer, arktrades, ratings, analysts, filings, form, forms, customers, suppliers, alphavantage, EODHD, financial modeling prep, polygon, how to, usage, examples, sdk] -description: This guide introduces the Fundamental Analysis menu within the Stocks menu, briefly explains the features, and provides examples in context. ---- -import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - -`` - -The FA module provides programmatic access to the commands from within the OpenBB Terminal. To get the most out of these functions, we recommend obtaining API keys from: - -- AlphaVantage -- EODHD (premium subscribers only) -- Financial Modeling Prep -- Polygon - -View [this page](https://docs.openbb.co/platform/usage/guides/api-keys) for a list of all API sources used across the platform. - -## The FA Module - -A brief description below highlights the properties of the `fa` module. - -| Path | Description | -| :---------------------------- | -----------------------------------------------: | -| openbb.stocks.fa.analysis | Analysis of SEC disclosure statements | -| openbb.stocks.fa.balance | Company balance sheet | -| openbb.stocks.fa.cal | Calendar earnings and estimates | -| openbb.stocks.fa.cash | Company cash flows statements | -| openbb.stocks.fa.customer | Lists other public companies who are customers | -| openbb.stocks.fa.dcfc | Historical DCF Values for a ticker | -| openbb.stocks.fa.divs | Historical Dividends for a company | -| openbb.stocks.fa.divs_chart | A chart for `divs` | -| openbb.stocks.fa.dupont | DuPont ratios | -| openbb.stocks.fa.earnings | Earnings data and EPS | -| openbb.stocks.fa.enterprise | Company enterprise value | -| openbb.stocks.fa.epsfc | Forward EPS estimates | -| openbb.stocks.fa.fama_coe | Fama/French value for cost of equity | -| openbb.stocks.fa.fraud | Key fraud ratios | -| openbb.stocks.fa.growth | Growth of financial statement ratios | -| openbb.stocks.fa.income | Company income statements | -| openbb.stocks.fa.key | Company Key Metrics | -| openbb.stocks.fa.metrics | Key Metrics Over Time | -| openbb.stocks.fa.mgmt | Company Management Team | -| openbb.stocks.fa.mktcap | Estimated Market Cap | -| openbb.stocks.fa.mktcap_chart | Chart for `mktcap` | -| openbb.stocks.fa.overview | Overview of the company | -| openbb.stocks.fa.pt | Analyst price targets | -| openbb.stocks.fa.pt_chart | Chart for `pt` | -| openbb.stocks.fa.rating | Historical buy/sell/hold ratings based on ratios | -| openbb.stocks.fa.ratios | Historical financial statements ratios | -| openbb.stocks.fa.revfc | Forward revenue estimates | -| openbb.stocks.fa.score | Investing Score from Warren Buffet | -| openbb.stocks.fa.shrs | Major shareholders | -| openbb.stocks.fa.splits | Stock Splits and Reverse Splits Since IPO | -| openbb.stocks.fa.splits_chart | Chart for `splits` | -| openbb.stocks.fa.supplier | Lists other public companies who are suppliers | - -This can be printed to the screen with: - -```python -help(openbb.stocks.fa) -``` - -Parameters for each function are displayed using the same syntax. - -```python -help(openbb.stocks.fa.balance) - -Signature: -openbb.stocks.fa.balance( - symbol: str, - quarterly: bool = False, - ratios: bool = False, - source: str = 'YahooFinance', - limit: int = 10, -) -> pandas.core.frame.DataFrame -Call signature: openbb.stocks.fa.balance(*args: Any, **kwargs: Any) -> Any -Type: get_balance_sheet -String form: -File: ~/GitHub/OpenBBTerminal/openbb_terminal/stocks/fundamental_analysis/sdk_helpers.py -Docstring: -Get balance sheet. - -Parameters ----------- -symbol : str - Symbol to get balance sheet for -source : str, optional - Data source for balance sheet, by default "YahooFinance" - Sources: YahooFinance, AlphaVantage, FinancialModelingPrep, Polygon, EODHD -quarterly : bool, optional - Flag to get quarterly data -ratios : bool, optional - Flag to return data as a percent change. -limit : int - Number of statements to return (free tiers may be limited to 5 years) - -Returns -------- -pd.DataFrame - Dataframe of balance sheet - -Examples --------- ->>> from openbb_terminal.sdk import openbb ->>> balance_sheet = openbb.stocks.fa.balance("AAPL", source="YahooFinance") - -If you have a premium AlphaVantage key, you can use the quarterly flag to get quarterly statements ->>> quarterly_income_statement = openbb.stocks.fa.balance("AAPL", source="AlphaVantage", quarterly=True) -``` - -This information is also displayed in the contextual help window, when using Jupyter Lab or VS Code. - -## Examples - -The examples provided below will assume that the following import block is included at the beginning of the Python script or Notebook file: - -```python -import pandas as pd -from openbb_terminal.sdk import openbb -``` - -### Earnings - -The `openbb.stocks.fa.earnings` function returns upcoming earnings dates and estimates for EPS. There are two data sources available - YahooFinance or AlphaVantage, both of which provide historical context. - -```python -openbb.stocks.fa.earnings('COST', quarterly = True) -``` - -| Earnings Date | EPS Estimate | Reported EPS | Surprise(%) | -| :------------ | :----------- | :----------- | :---------- | -| 2024-02-29 | - | - | - | -| 2023-12-06 | - | - | - | -| 2023-09-20 | - | - | - | -| 2023-05-25 | 3.21 | - | - | -| 2023-05-25 | - | - | - | -| 2023-03-02 | 3.21 | 3.3 | 0.0288 | -| 2022-12-08 | 3.11 | 3.1 | -0.00451 | -| 2022-09-22 | 4.17 | 4.2 | 0.0084 | -| 2022-05-26 | 3.03 | 3.17 | 0.0449 | -| 2022-03-03 | 2.74 | 2.92 | 0.0647 | -| 2021-12-09 | 2.64 | 2.98 | 0.12890 | - -### Growth - -`openbb.stocks.fa.growth` provides annualized financial ratios as growth metrics. - -```python -openbb.stocks.fa.growth('COST') -``` - -**Note**: This returns thirty-five ratios, the table below is truncated for illustrative purposes. - -| | 2018 | 2019 | 2020 | 2021 | 2022 | -| :---------------------- | :---- | :----- | :---- | :---- | :---- | -| Period | FY | FY | FY | FY | FY | -| Revenue growth | 0.097 | 0.079 | 0.092 | 0.175 | 0.158 | -| Gross profit growth | 0.075 | 0.076 | 0.101 | 0.157 | 0.092 | -| Ebitgrowth | 0.090 | -0.236 | 0.134 | 0.306 | 0.203 | -| Operating income growth | 0.090 | -0.236 | 0.134 | 0.306 | 0.203 | - -### Analysis - -The `openbb.stocks.fa.analysis` function scans 10K SEC filings with NLP to highlight risk factors and statements provided in the Discussion and Analysis sections. Summarizations by, [elclect.us](https://eclect.us/) - -```python -openbb.stocks.fa.analysis('COST').head(1) -``` - -| Group | Good | Sentence | -| :----------- | :---- | :-------------------------------------------------------------------------------------------------------------------------------------- | -| Risk factors | False | During 2022, our international operations, including Canada, generated 27% and 32% of our net sales and operating income, respectively. | - -```python -df = openbb.stocks.fa.analysis('COST') -hp = df["Group"].str.contains('Discussion') -df[hp].head(1) -``` - -| Group | Good | Sentence | -| :---------------------- | :--- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| Discussion and Analysis | True | Cash Flows from Operating ActivitiesNet cash provided by operating activities totaled $5,802 in the first half of 2023, compared to $3,659 in the first half of 2022. | - -### Key - -Use `openbb.stocks.fa.key` for a small table of key statistics. - -```python -openbb.stocks.fa.key('COST') -``` - -| | | -| :----------------------- | :-------- | -| Market capitalization | 219.440 B | -| EBITDA | 9.891 B | -| EPS | 13.62 | -| PE ratio | 36.33 | -| PEG ratio | 3.433 | -| Price to book ratio | 10.39 | -| Return on equity TTM | 0.284 | -| Price to sales ratio TTM | 0.891 | -| Dividend yield | 0.0083 | -| 50 day moving average | 491.41 | -| Analyst target price | 547.64 | -| Beta | 0.787 | - -### SHRS - -The top 10 mutual funds holding the stock are retrieved with: - -```python -openbb.stocks.fa.shrs(symbol = 'COST', holder = 'mutualfund') -``` - -| Holder | Shares | Date Reported | Stake | Value | -| :--------------------------------------------------------- | :------- | :------------------ | :----- | :------ | -| Vanguard Total Stock Market Index Fund | 13.453 M | 2022-12-30 00:00:00 | 3.03 % | 6.591 B | -| Vanguard 500 Index Fund | 10.232 M | 2022-12-30 00:00:00 | 2.31 % | 5.012 B | -| Invesco ETF Tr-Invesco QQQ Tr, Series 1 ETF | 5.834 M | 2023-03-30 00:00:00 | 1.32 % | 2.858 B | -| Fidelity 500 Index Fund | 4.852 M | 2023-02-27 00:00:00 | 1.09 % | 2.377 B | -| SPDR S&P 500 ETF Trust | 4.804 M | 2023-03-30 00:00:00 | 1.08 % | 2.353 B | -| iShares Core S&P 500 ETF | 3.950 M | 2023-02-27 00:00:00 | 0.89 % | 1.935 B | -| Vanguard Growth Index Fund | 3.736 M | 2022-12-30 00:00:00 | 0.84 % | 1.830 B | -| Select Sector SPDR Fund-Consumer Staples | 3.241 M | 2023-02-27 00:00:00 | 0.73 % | 1.588 B | -| Vanguard Institutional Index Fund-Institutional Index Fund | 3.102 M | 2022-12-30 00:00:00 | 0.70 % | 1.519 B | -| Vanguard Specialized-Dividend Appreciation Index Fund | 2.804 M | 2023-01-30 00:00:00 | 0.63 % | 1.374 B | - -### Balance - -Financial statement items can be displayed as their reported value or as a percent change. - -```python -openbb.stocks.fa.balance(symbol = 'COST', ratios=True) -``` - -| Breakdown | 2022-08-31 | 2021-08-31 | 2020-08-31 | -| :----------------------------------------- | ---------: | ---------: | ---------: | -| Cash and cash equivalents | -0.0937111 | -0.0830007 | 0.464337 | -| Other short-term investments | -0.0774264 | -0.107977 | -0.0301887 | -| Total cash | -0.0924846 | -0.0849305 | 0.408831 | -| Net receivables | 0.242928 | 0.163226 | 0.00977199 | -| Inventory | 0.259726 | 0.161166 | 0.0743308 | -| Other current assets | 0.14253 | 0.282502 | -0.0792079 | -| Total current assets | 0.108151 | 0.0492532 | 0.19736 | -| Gross property, plant and equipment | 0.0532209 | 0.0815396 | 0.149114 | -| Accumulated depreciation | 0.0790625 | 0.0984801 | 0.0988412 | -| Net property, plant and equipment | 0.039345 | 0.072657 | 0.177358 | -| Other long-term assets | 0.19787 | 0.190074 | 1.77171 | -| Total non-current assets | 0.0573531 | 0.0848156 | 0.251928 | -| Total assets | 0.0826416 | 0.0668155 | 0.2237 | -| Current debt | -0.908636 | 7.41053 | -0.944085 | -| Accounts payable | 0.0964492 | 0.148603 | 0.21346 | -| Accrued liabilities | 0.0921715 | 0.152661 | 0.147383 | -| Other current liabilities | 0.230213 | 0.223444 | -0.0168776 | -| Total current liabilities | 0.0868517 | 0.185035 | 0.0691569 | -| Long-term debt | -0.0310819 | -0.109396 | 0.466432 | -| Other long-term liabilities | 0.057971 | 0.248062 | 0.329897 | -| Total non-current liabilities | -0.0194059 | -0.0214875 | 0.825049 | -| Total liabilities | 0.0565429 | 0.117744 | 0.235947 | -| Common stock | -0.5 | 0 | 0 | -| Retained earnings | 0.335933 | -0.0941843 | 0.255508 | -| Accumulated other comprehensive income | 0.608619 | -0.123362 | -0.0967967 | -| Total stockholders' equity | 0.175245 | -0.0393787 | 0.199501 | -| Total liabilities and stockholders' equity | 0.0826416 | 0.0668155 | 0.2237 | - -Cashflow and Income statements are requested in the same way. - -### Cash - -Get the company's cash statements. - -```python -openbb.stocks.fa.cash(symbol = 'COST').tail(4) -``` - -| Breakdown | ttm | 2022-08-31 | 2021-08-31 | 2020-08-31 | 2019-08-31 | -| :-------------------- | ---------: | ---------: | ---------: | ---------: | ---------: | -| Cash at end of period | 13136000.0 | 10203000.0 | 11258000.0 | 12277000.0 | 8384000.0 | -| Operating cash flow | 9535000.0 | 7392000.0 | 8958000.0 | 8861000.0 | 6356000.0 | -| Capital expenditure | -4060000.0 | -3891000.0 | -3588000.0 | -2810000.0 | -2998000.0 | -| Free cash flow | 5475000.0 | 3501000.0 | 5370000.0 | 6051000.0 | 3358000.0 | - -### Income - -Get the company's income statements. - -```python -openbb.stocks.fa.income('COST').tail(4) -``` - -| Breakdown | 2022-08-31 | 2021-08-31 | 2020-08-31 | 2019-08-31 | -| :--------------------- | :--------: | :--------: | :--------: | ---------: | -| Diluted EPS | 13.14 | 11.27 | 9.02 | 8.26 | -| Basic average shares | 443651.00 | 443089.00 | 442297.00 | 439755.00 | -| Diluted average shares | 444757.00 | 444346.00 | 443901.00 | 442923.00 | -| EBITDA | 7998000.00 | 6851000.00 | 5527000.00 | 4915000.00 | - -### Supplier - -`openbb.stocks.fa.supplier` will return a list of suppliers for the compnay, that are also listed US stocks. - -```python -openbb.stocks.fa.supplier('COST').head(5) -``` - -| TICKER | Company Name | Revenue | Net Income | Net Margin | Cash Flow | -| :----- | :---------------------- | ------: | ---------: | :--------- | --------: | -| BRKA | Berkshire Hathaway Inc | 78165 | 18321 | 23.44 % | -52307 | -| ULVR | Unilever Plc | 58737.3 | 7415.52 | 12.62 % | 0 | -| COST | Costco Wholesale Corp | 54437 | 1364 | 2.51 % | 653 | -| BUD | Anheuser busch Inbev Sa | 54304 | 6114 | 11.26 % | 0 | -| DEO | Diageo Plc | 22448 | 3338 | 14.87 % | 2749 | - -### EPSFC - -Returns a DataFrame of forward EPS estimates consensus. - -```python -openbb.stocks.fa.epsfc('COST') -``` - -| fiscalyear | consensus_mean | change % | analysts | actual | consensus_low | consensus_high | -|-------------:|-----------------:|-----------:|-----------:|---------:|----------------:|-----------------:| -| 2022 | 13.151 | 18.6918 | 20 | 13.27 | 12.43 | 13.43 | -| 2023 | 14.5 | 9.2679 | 13 | 0 | 14.22 | 15.18 | -| 2024 | 15.801 | 8.97478 | 20 | 0 | 14.75 | 17.09 | -| 2025 | 17.337 | 9.71807 | 10 | 0 | 16.47 | 18.92 | -| 2026 | 19.332 | 11.5088 | 5 | 0 | 17.55 | 21.84 | -| 2027 | 21.408 | 10.7387 | 5 | 0 | 18.6 | 25.72 | -| 2028 | 23.625 | 10.3559 | 2 | 0 | 22.19 | 25.06 | -| 2029 | 27.2 | 15.1323 | 1 | 0 | 27.2 | 27.2 | -| 2030 | 29.6 | 8.82353 | 1 | 0 | 29.6 | 29.6 | -| 2031 | 32.05 | 8.27703 | 1 | 0 | 32.05 | 32.05 | -| 2032 | 34.87 | 8.79875 | 1 | 0 | 34.87 | 34.87 | - -### SEC - -`openbb.stocks.fa.sec` SEC forms filed by year and type. - -```python -openbb.stocks.fa.sec('COST').head(4) -``` - -|Filed |Company Name |Reporting Owner |Form Type |Period |View | -|:-----------|:--------------------------|:------------|:------------|:-----------|:-----------| -|04/19/2023 |Costco Wholesale Corporation | |8-K |04/19/2023 |https://app.quotemedia.com/data/downloadFiling...| -|04/13/2023 |Costco Wholesale Corporation | |4 |04/11/2023 |https://app.quotemedia.com/data/downloadFiling...| -|03/15/2023 |Costco Wholesale Corporation |JELINEK W CRAIG |4 |03/13/2022 |https://app.quotemedia.com/data/downloadFiling...| -|03/15/2023 |Costco Wholesale Corporation |GALANTI RICHARD A |4 |03/14/2023 |https://app.quotemedia.com/data/downloadFiling...| - -### PT - -`openbb.stocks.fa.pt` returns historical ratings and price targets, by firm. - -```python -openbb.stocks.fa.pt('COST').tail(10) -``` - -| Date | Company | Rating | Price Target | -|:------------|:-----------------------|:---------|---------------:| -| 2023-02-08 | Barclays Capital | HOLD | 510 | -| 2023-02-27 | Telsey Advisory Group | BUY | 580 | -| 2023-03-03 | Baird Patrick & Co | BUY | 535 | -| 2023-03-03 | Telsey Advisory Group | BUY | 540 | -| 2023-03-03 | Morgan Stanley | BUY | 520 | -| 2023-03-07 | Northcoast | BUY | 560 | -| 2023-03-28 | Telsey Advisory Group | BUY | 540 | -| 2023-04-06 | Telsey Advisory Group | BUY | 540 | -| 2023-04-06 | Oppenheimer & Co. Inc. | BUY | 550 | -| 2023-05-01 | Telsey Advisory Group | BUY | 540 | diff --git a/website/content/platform/usage/intros/stocks/government.md b/website/content/platform/usage/intros/stocks/government.md deleted file mode 100644 index b74ef1c0ca97..000000000000 --- a/website/content/platform/usage/intros/stocks/government.md +++ /dev/null @@ -1,131 +0,0 @@ ---- -title: Government -keywords: [government, house, senate, politician, lobby, lobbyist, contract, contractor, spending, budget, treasury, trading, buys, sells, ticker, tickers, companies, listing, exchange, how to, usage, examples, import, statement, contracts, histcont, lobbying, lastcontracts, ] -description: This guide introduces the Government submenu, within the Stocks menu, by briefly explaining the features and how to use them, showing examples in context. ---- - -import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - - - -The Government module provides programmatic access to the same functions from the [OpenBB Terminal](https://docs.openbb.co/terminal/usage/intros/stocks/gov). They provide an excellent supplement to fundamental and macroeconomic research. Please note that this module will only return data from the USA. - -## How to Use - -Below is a list of all the commands and a brief description. There are two types of function: ticker-specific, and non-specific. Many of these tables also have a companion `_chart` function. - -|Path |Type| Description | -|:----------------|:------:|----------------------------:| -|openbb.stocks.gov.contracts|Ticker |Contracts Awarded to a Company | -|openbb.stocks.gov.gtrades |Ticker |Reported Trades in a Company's Stock by Members of the US Congress and Senate | -|openbb.stocks.gov.histcont|Ticker |The Quarterly Total Amount Paid to a Company by the Government | -|openbb.stocks.gov.lastcontracts |All |The Latest Invoices Paid by the US Treasury Department | -|openbb.stocks.gov.lasttrades| All|The Latest Reported Trades Made by Members of the US Congress and Senate | -|openbb.stocks.gov.lobbying|Ticker | Recorded Lobbying Efforts by a Company | -|openbb.stocks.gov.qtrcontracts|All |Ranking Companies by Total Amount Rewarded | -|openbb.stocks.gov.topbuys|All |The Top Buyers in Office | -|openbb.stocks.gov.toplobbying|All |Corporate Lobbyist Activity and the Specific Issues | -|openbb.stocks.gov.topsells|All |The Top Sellers in Office | - -Alternatively, Python's built-in help will display the contents of the module, or specific function. - -```python -help(openbb.stocks.gov) -``` - -## Examples - -### Import Statements - -The examples below will assume that this block is included at the top of the file: - -```python -from openbb_terminal.sdk import openbb -``` - -### Toplobbying - -This command shows who is spending money in Washington and what their intentions are. - -```python -openbb.stocks.gov.toplobbying() -``` - -| | Date | Ticker | Client | Amount | Issue | Specific_Issue | -|---:|:-----------|:---------|:--------------------------------|---------:|:-------------------------------------|:--------------------| -| 495 | 2022-10-20 | DKNG | DRAFTKINGS INC. | 20000 | Taxation/Internal Revenue Code | Tax characterization of daily fantasy sports. | -| 496 | 2022-10-20 | ELVT | ELEVATE CREDIT SERVICE, LLC | 90000 | Banking | Monitored issues concerning online lending proposals. | -| 497 | 2022-10-20 | HGV | HILTON GRAND VACATIONS | 20000 | Financial Institutions/Investments/Securities | GENERAL DISCUSSIONS RELATED TO DEBT SERVICING | -| 498 | 2022-10-20 | SO | SOUTHERN CALIFORNIA TRIBAL CHAIRMEN'S ASSOCIATION | 40000 | Indian/Native American Affairs | Fee to trust issues. Issues surrounding federal programs for Indian tribes. | -| 499 | 2022-10-20 | ONCS | ONCOSEC MEDICAL INCORPORATED | 0 | | | - -### Contracts - -Get a list of contracts awarded to a company and the agency authorizing it. - -```python -openbb.stocks.gov.contracts('AMT') -``` - -| | Date | Description | Agency | Amount | -|---:|:-----------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:--------------------------------------|---------:| -| 0 | 2022-10-16 | RENTAL TOWER SITE | DEPARTMENT OF JUSTICE (DOJ) | 0 | -| 1 | 2022-10-01 | ANTENNA LEASE SITE 43 AMERICAN TOWER | DEPARTMENT OF HOMELAND SECURITY (DHS) | 13699.9 | -| 2 | 2022-10-01 | IGF::OT::IGF | DEPARTMENT OF JUSTICE (DOJ) | 5100 | -| 3 | 2022-10-01 | LEASE OF RADIO REPEATER SITE | DEPARTMENT OF THE TREASURY (TREAS) | 9787.84 | -| 4 | 2022-10-01 | IGF::OT::IGF::-RECUR SERVICE FOR ANTENNA SITE J ACCOUNT LEASE AT: MARIETTA, GA (BLACKWELL SITE) | DEPARTMENT OF JUSTICE (DOJ) | 0 | -| 5 | 2022-10-01 | FUNDING FOR FY 2018 THROUGH FY 2019 ANTENNA SITE AGREEMENTS | DEPARTMENT OF STATE (DOS) | 30000 | - -### Histcont - -Get the historic (from 2008) quarterly sum paid to a company by the US Treasury department. - -```python -openbb.stocks.gov.histcont('AMT') -``` - -| | Qtr | Year | Amount | -|---:|------:|-------:|---------:| -| 0 | 4 | 2021 | 127282 | -| 1 | 3 | 2021 | 564310 | -| 2 | 2 | 2021 | 564645 | -| 52 | 4 | 2008 | 110021 | -| 53 | 3 | 2008 | 240877 | -| 54 | 2 | 2008 | 907099 | -| 55 | 1 | 2008 | 320620 | - -### Lobbying - -Find the records of a company's lobbying efforts. - -```python -openbb.stocks.gov.lobbying('AMT') -``` - -| | Date | Ticker | Client | Amount | Issue | Specific_Issue | -|---:|:-----------|:---------|:---------------------------|---------:|:---------------------------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| 0 | 2022-12-01 | AMT | AMERICAN TOWER CORPORATION | 440000 | Trade (domestic/foreign) | Issues pertaining to global trade, global development, AID and the World Bank including trade policy with India - no specific legislation. | -| | | | | | Communications/Broadcasting/Radio/TV | Telecommunication infrastructure issues including those related to the Federal Communications Commission - no specific legislation. Issues related to NTIA - including implementation of broadband funding programs in the Infrastructure Investment and Jobs Act, HR 3684. Issues related to 5G and wireless communications deployment - no specific legislation. Issues related to the definition of eligible project costs - no specific legislation. Issues pertaining to broadband deployment, including relevant provisions in the Infrastructure Investment and Jobs Act, HR 3684 and related legislation. | -| | | | | | Telecommunications | Issues pertaining to telecommunications tower real estate - no specific legislation. Issues related to global telecommunications policy - no specific legislation. | -| | | | | | Taxation/Internal Revenue Code | Issues related to international and domestic tax provisions as applied to real estate investment trusts and Public Law 115-97 (Tax Cuts and Jobs Act), including H.R. 5376, the Inflation Reduction Act of 2022. | - -### Lastcontracts - -Find out who is selling ink, toner cartridges, or other seemingly mundane items, to the Federal government. - -```python -openbb.stocks.gov.lastcontracts() -``` - -| | Date | Ticker | Amount | Description | Agency | -|---:|:--------------------|:---------|---------:|:--------------------------------------------------|:--------------------------------------| -| 0 | 2022-12-02 00:00:00 | DNOW | 81.3 | CASE, FILING, TRANSFER: ITEM NAME CASE, FILING, | GENERAL SERVICES ADMINISTRATION (GSA) | -| | | | | TRANSFER INSIDE WIDTH 8.250 INCHES INSIDE LENGTH | | -| | | | | 5.500 INCHES INSIDE DEPTH 10.75 INCHES CARD WIDTH | | -| | | | | 8.000 INCHES CARD LENGTH 5.000 INCHES CARD | | -| | | | | CAPACITY 1,200 UNIT TYPE BOX UNIT DESIGN NON- | | -| | | | | COLLAPSIBL | | -| 1 | 2022-12-02 00:00:00 | DNOW | 855.6 | CARTRIDGE,TONER | GENERAL SERVICES ADMINISTRATION (GSA) | -| 2 | 2022-12-02 00:00:00 | DNOW | 169.84 | TONER,HP 508X HY, LJ,YL | GENERAL SERVICES ADMINISTRATION (GSA) | -| 3 | 2022-12-02 00:00:00 | DNOW | 519.5 | CARTRIDGE,INK | GENERAL SERVICES ADMINISTRATION (GSA) | -| 4 | 2022-12-02 00:00:00 | DNOW | 1778.1 | OEM HP HY TONER, YELLOW, YLD 23K | GENERAL SERVICES ADMINISTRATION (GSA) | diff --git a/website/content/platform/usage/intros/stocks/index.md b/website/content/platform/usage/intros/stocks/index.md deleted file mode 100644 index 35f87e51ae96..000000000000 --- a/website/content/platform/usage/intros/stocks/index.md +++ /dev/null @@ -1,392 +0,0 @@ ---- -title: Stocks -keywords: [stocks, fundamental analysis, analysis, Behavioural, strategy, comparison, due diligence, discovery, dark pool, short, data, forecasting, fundamental, quantitative, government, forecating, ml, ai, machine learning, artificial intelligence, insider, trading, research, sector, industry, technical, trading hours, quote, market data, close, adjusted close, download, export, tools, openbb sdk] -description: Learn about the Stocks menu - the high-level menu for the Public Equity asset class. It contains functions for searching and loading company market data, showing candle charts, quotes and company specifics via a large selection of sub-menus. Refer to each sub-menu's introductory guide for a more detailed explanation of the functions within. ---- - -import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - - - -The Stocks module provides the functionality of the Stocks menu from the OpenBB Terminal. The list below are the Platform functions within the Stocks module and a short description: - -| Path | Type | Description | -| :--------------------- | :--------: | ------------------------------------------------------: | -| openbb.stocks.ba | Sub-Module | Behavioural Analysis | -| openbb.stocks.ca | Sub-Module | Comparison Analysis | -| openbb.stocks.candle | Function | OHLC + Volume + Moving Averages Chart | -| openbb.stocks.disc | Sub-Module | Stock Discovery | -| openbb.stocks.dps | Sub-Module | Dark Pools & Shorts | -| openbb.stocks.fa | Sub-Module | Fundamental Analysis & Future Estimations | -| openbb.stocks.gov | Sub-Module | US Government, Lobbying & Representative Activity | -| openbb.stocks.ins | Sub-Module | Corporate Insider Activity (SEC Form 4) | -| openbb.stocks.load | Function | Load Historical OHLC+V Data | -| openbb.stocks.options | Sub-Module | Options | -| openbb.stocks.qa | Sub-Module | Stocks-Only Quantitative Analysis | -| openbb.stocks.quote | Function | Last Price and Performance Data (FinancialModelingPrep) | -| openbb.stocks.screener | Sub-Module | Stock Screener | -| openbb.stocks.search | Function | Find Stocks | -| openbb.stocks.sia | Sub-Module | Sector & Industry Analysis | -| openbb.stocks.ta | Sub-Module | Stocks-Only Technical Analysis | -| openbb.stocks.th | Sub-Module | Trading Hours (Market Status) | -| openbb.stocks.tob | Function | Top of Book (CBOE) | - -## How to use - -```python -help(openbb.stocks) -``` - -Most items in `openbb.stocks` are sub-modules. The objective of this guide is to introduce the functions at the top-level and to demonstrate a selection of functions from the sub-modules. - -## Examples - -The code snippets in the following section will assume that the import block contains: - -```python -import pandas as pd -from datetime import datetime -from openbb_terminal.sdk import openbb - -``` - -### Load - -The first step in a workflow might be to collect historical price data. The `load` function has the ability to request data from multiple sources. The choices for `source` are currently: - -- YahooFinance (default) -- AlphaVantage -- Polygon -- EODHD - -```python -spy_monthly = openbb.stocks.load( - symbol = 'SPY', - start_date = '1990-01-01', - interval = 1440, - prepost = False, - source = 'YahooFinance', - weekly = False, - monthly = True, -) -spy_monthly.head(3) -``` - -| date | Open | High | Low | Close | Adj Close | Volume | -| :------------------ | ------: | ------: | ------: | ------: | --------: | ---------: | -| 1993-02-01 00:00:00 | 43.9688 | 45.125 | 42.8125 | 44.4062 | 25.6043 | 5.4176e+06 | -| 1993-03-01 00:00:00 | 44.5625 | 45.8438 | 44.2188 | 45.1875 | 26.0548 | 3.0192e+06 | -| 1993-04-01 00:00:00 | 45.25 | 45.25 | 43.2812 | 44.0312 | 25.508 | 2.6972e+06 | - -There are source-dependent differences to the DataFrame returned. For example, compare the above with below: - -```python -spy_monthly = openbb.stocks.load( - symbol = 'SPY', - start_date = '1990-01-01', - interval = 1440, - prepost = False, - source = 'Polygon', - weekly = False, - monthly = True, -) -spy_monthly.head(3) -``` - -| date | Volume | vw | Open | Adj Close | High | Low | Transactions | Close | -| :------------------ | ----------: | ------: | -----: | --------: | -----: | -----: | -----------: | -----: | -| 2022-09-01 04:00:00 | 1.99492e+09 | 382.507 | 392.89 | 357.18 | 411.73 | 357.04 | 1.35653e+07 | 357.18 | -| 2022-10-01 04:00:00 | 2.02389e+09 | 370.918 | 361.08 | 386.21 | 389.52 | 348.11 | 1.38047e+07 | 386.21 | -| 2022-11-01 04:00:00 | 1.17559e+09 | 386.119 | 390.14 | 394.28 | 402.31 | 368.79 | 8.34067e+06 | 394.28 | - -### Candle - -OHLC DataFrames can be passed through the `Candle` function to display a chart. - -```python -openbb.stocks.candle(data = spy_monthly, symbol = 'SPY - Monthly Candles') -``` - -![openbb.stocks.candle](https://user-images.githubusercontent.com/85772166/201727311-e42f5ec3-bfdd-4d5d-ae4d-7e113f4b455d.png "openbb.stocks.candle") - -The `candle` function is also aware if a ticker is being passed. This makes it unnecessary to create a DataFrame if the objective is only to display the chart. - -```python -openbb.stocks.candle('SPY') -``` - -![openbb.stocks.candle](https://user-images.githubusercontent.com/85772166/202576993-08bfb90c-2254-423e-b599-8c86a1ea1e12.png "openbb.stocks.candle") - -Add moving averages to the chart with: - -```python -openbb.stocks.candle('SPY', ma = [50,150]) -``` - -![openbb.stocks.candle](https://user-images.githubusercontent.com/85772166/202576848-27e86f9a-e9bd-49b4-9008-2ad374e07abb.png "openbb.stocks.candle") - -### Search - -Search for companies by name with the `search` function, with optional filters for sector, industry, and region: - -```python -openbb.stocks.search(sector = 'Energy', country = 'United Kingdom', query = 'oil') -``` - -| | | long_name | country | sector | industry | exchange | -| -: | :----- | :------------------------------ | :------------- | :----- | :------------ | -------: | -| 0 | 3NO.F | Nostrum Oil & Gas PLC | United Kingdom | Energy | Oil & Gas E&P | nan | -| 1 | BOIL.L | Baron Oil Plc | United Kingdom | Energy | Oil & Gas E&P | nan | -| 2 | EGN.F | Europa Oil & Gas (Holdings) plc | United Kingdom | Energy | Oil & Gas E&P | nan | -| 3 | EOG.L | Europa Oil & Gas (Holdings) plc | United Kingdom | Energy | Oil & Gas E&P | nan | -| 4 | GHA.F | Baron Oil Plc | United Kingdom | Energy | Oil & Gas E&P | nan | - -...continued - -### Quote - -Watchlists are easy to make. Get the last price and performance data for multiple tickers by looping the `quote` function: - -```python -spdr_sectors = ['SPY', 'XLE', 'XLB', 'XLI', 'XLP', 'XLY', 'XLV', 'XLF', 'XLK', 'XLC', 'XLU', 'XLRE'] - -quotes: object = [] -symbols = spdr_sectors -for symbols in spdr_sectors: - quote = openbb.stocks.quote(symbols).transpose() - quotes.append(quote) - -quotes = pd.concat(quotes) - -quotes -``` - -| | Symbol | Name | Price | Changes percentage | Change | Day low | Day high | Year high | Year low | Market cap | Price avg50 | Price avg200 | Exchange | Volume | Avg volume | Open | Previous close | Eps | Pe | Earnings announcement | Shares outstanding | Timestamp | -|---:|:---------|:-----------------------------------------------|--------:|---------------------:|---------:|----------:|-----------:|------------:|-----------:|:-------------|--------------:|---------------:|:-----------|:---------|-------------:|-------:|-----------------:|---------:|------:|:------------------------|:---------------------|------------:| -| 0 | SPY | SPDR S&P 500 ETF Trust | 393.74 | 0.9616 | 3.75 | 390.08 | 394.17 | 462.07 | 348.11 | 361.367 B | 399.841 | 392.797 | AMEX | 88.857 M | 89590689 | 390.8 | 389.99 | 19.9365 | 19.75 | | 917.782 M | 1679342401 | -| 0 | XLE | Energy Select Sector SPDR Fund | 77.7 | 2.0024 | 1.5253 | 76.1 | 78.2 | 94.71 | 65.48 | 14.485 B | 86.6584 | 82.6697 | AMEX | 25.791 M | 19906166 | 76.1 | 76.1747 | 10.86 | 7.15 | | 186.424 M | 1679342400 | -| 0 | XLB | Materials Select Sector SPDR Fund | 76.73 | 2.0581 | 1.5473 | 75.77 | 76.77 | 91.49 | 66.85 | 5.519 B | 81.7186 | 77.8203 | AMEX | 7.327 M | 5830645 | 75.77 | 75.1827 | 5.16256 | 14.86 | | 71.924 M | 1679342400 | -| 0 | XLI | Industrial Select Sector SPDR Fund | 97.55 | 1.3242 | 1.2749 | 96.71 | 97.79 | 105.23 | 82.75 | 13.328 B | 101.103 | 95.1877 | AMEX | 14.078 M | 11957477 | 96.71 | 96.2751 | 4.6974 | 20.77 | | 136.626 M | 1679342400 | -| 0 | XLP | Consumer Staples Select Sector SPDR Fund | 72.76 | 1.386 | 0.9947 | 72.01 | 72.83 | 81.34 | 66.18 | 15.292 B | 73.092 | 72.9574 | AMEX | 14.127 M | 10950449 | 72.04 | 71.7653 | 2.88675 | 25.2 | | 210.172 M | 1679342400 | -| 0 | XLY | Consumer Discretionary Select Sector SPDR Fund | 141.52 | 0.433 | 0.6102 | 139.75 | 142.39 | 192.19 | 126 | 17.018 B | 143.901 | 146.454 | AMEX | 5.863 M | 5416313 | 140.74 | 140.91 | 6.27203 | 22.56 | | 120.253 M | 1679342400 | -| 0 | XLV | Health Care Select Sector SPDR Fund | 126.96 | 1.2675 | 1.5891 | 125.58 | 127.145 | 143.42 | 118.75 | 25.064 B | 131.092 | 130.376 | AMEX | 10.584 M | 8826462 | 125.58 | 125.371 | 5.92017 | 21.45 | | 197.415 M | 1679342400 | -| 0 | XLF | Financial Select Sector SPDR Fund | 31.17 | 1.1114 | 0.3426 | 31.025 | 31.44 | 40.01 | 29.59 | 27.537 B | 35.4068 | 33.8593 | AMEX | 74.917 M | 50017188 | 31.07 | 30.8274 | 2.57075 | 12.12 | | 883.445 M | 1679342400 | -| 0 | XLK | Technology Select Sector SPDR Fund | 143.53 | 0.2693 | 0.3855 | 141.82 | 143.7 | 163.65 | 112.97 | 39.048 B | 136.542 | 132.924 | AMEX | 5.924 M | 7283266 | 142.89 | 143.145 | 5.1111 | 28.08 | | 272.056 M | 1679342400 | -| 0 | XLC | Communication Services Select Sector SPDR Fund | 55.27 | 0.7474 | 0.41 | 54.71 | 55.41 | 71.57 | 44.86 | 0 | 54.1118 | 52.9782 | AMEX | 7.189 M | 6117298 | 54.91 | 54.86 | 2.87114 | 19.25 | | 0 | 1679342400 | -| 0 | XLU | Utilities Select Sector SPDR Fund | 67 | 0.7818 | 0.5197 | 66.56 | 67.22 | 78.22 | 60.35 | 10.939 B | 68.0158 | 69.9207 | AMEX | 19.265 M | 12304022 | 66.58 | 66.4803 | 2.88295 | 23.24 | | 163.274 M | 1679342400 | -| 0 | XLRE | The Real Estate Select Sector SPDR Fund | 36.36 | 1.0727 | 0.3859 | 35.87 | 36.4932 | 50.97 | 33.125 | 0 | 38.953 | 39.4885 | AMEX | 4.963 M | 6039455 | 36.06 | 35.9741 | 1.30938 | 27.77 | | 0 | 1679342400 | - -### TOB - -Top of Book gets the size and price at the top of the order book. - -```python -bid,ask = openbb.stocks.tob('SPY') -quote_tob = bid.join(ask, lsuffix= ': Bid', rsuffix = ': Ask') - -quote_tob -``` - -| | Size: Bid | Price: Bid | Size: Ask | Price: Ask | -| -: | --------: | ---------: | --------: | ---------: | -| 0 | 100 | 394.85 | 100 | 395 | -| 1 | 100 | 394.8 | 300 | 395.05 | -| 2 | 100 | 394.7 | 100 | 395.07 | -| 3 | 100 | 394.68 | 200 | 395.25 | -| 4 | 100 | 394.65 | 100 | 395.29 | - -### Filings - -Get the most-recent form submissions to the SEC. - -```python -filings = openbb.stocks.disc.filings() -filings.head(3) -``` - -| Date | Ticker | CIK | Form Type | Title | URL | -|:--------------------|:---------|--------:|:------------|:------------------------------------------------------|:--------------------------------------------------------------------------------------------------| -| 2023-03-20 17:30:26 | TLGA | 1827871 | 10-K | 10-K - TLG Acquisition One Corp. (0001827871) (Filer) | https://www.sec.gov/Archives/edgar/data/1827871/000119312523074903/0001193125-23-074903-index.htm | -| 2023-03-20 17:30:26 | TLGA | 1827871 | 10-K | 10-K - TLG Acquisition One Corp. (0001827871) (Filer) | https://www.sec.gov/Archives/edgar/data/1827871/000119312523074903/0001193125-23-074903-index.htm | -| 2023-03-20 17:30:26 | TLGA-UN | 1827871 | 10-K | 10-K - TLG Acquisition One Corp. (0001827871) (Filer) | https://www.sec.gov/Archives/edgar/data/1827871/000119312523074903/0001193125-23-074903-index.htm | -| 2023-03-20 17:30:26 | TLGA-UN | 1827871 | 10-K | 10-K - TLG Acquisition One Corp. (0001827871) (Filer) | https://www.sec.gov/Archives/edgar/data/1827871/000119312523074903/0001193125-23-074903-index.htm | -| 2023-03-20 17:30:26 | TLGA-WT | 1827871 | 10-K | 10-K - TLG Acquisition One Corp. (0001827871) (Filer) | https://www.sec.gov/Archives/edgar/data/1827871/000119312523074903/0001193125-23-074903-index.htm | - -Filter them to be from the current day only: - -```python -today = filings.filter(like = datetime.now().strftime("%Y-%m-%d"), axis = 0) -``` - -### Screener - -Grab the list of filtered tickers and put them through the comparison analysis screener and get an overview: - -```python -tickers = today['Ticker'].to_list() -screener_results = openbb.stocks.ca.screener(similar = tickers, data_type = 'overview') -screener_results = screener_results.sort_values(by = ['Market Cap'], ascending = False).convert_dtypes() - -screener_results.head(5) -``` - -| | Ticker | Company | Sector | Industry | Country | Market Cap | P/E | Price | Change | Volume | -|----:|:---------|:-----------------|:-----------------------|:-----------------------------|:---------------|-------------:|------:|--------:|---------:|---------:| -| 72 | NVO | Novo Nordisk A/S | Healthcare | Biotechnology | Denmark | 2.4814e+11 | 41.42 | 143.59 | 0.0298 | 1242167 | -| 34 | EQNR | Equinor ASA | Energy | Oil & Gas Integrated | Norway | 8.591e+10 | 3.02 | 27.34 | 0.0096 | 4154740 | -| 46 | GSK | GSK plc | Healthcare | Drug Manufacturers - General | United Kingdom | 7.026e+10 | 12.29 | 34.93 | 0.0252 | 2973805 | -| 105 | UBS | UBS Group AG | Financial | Banks - Diversified | Switzerland | 6.783e+10 | 8.39 | 18.8 | 0.033 | 40598414 | -| 83 | RELX | RELX PLC | Communication Services | Publishing | United Kingdom | 5.97e+10 | 30.52 | 31.31 | 0.0205 | 620949 | - -This type of framework can be used to create any type of custom screener. For example, the most popular tickers on Stocktwits: - -```python -stocktwits = openbb.stocks.ba.trending() -stocktwits = pd.DataFrame(stocktwits).sort_values(by = 'Watchlist Count', ascending = False) -tickers = stocktwits['Ticker'].to_list() -stocktwits.head(10) -``` - -| | Ticker | Watchlist Count | Name | -| -: | :----- | --------------: | :----------------------------- | -| 18 | NVDA | 409301 | NVIDIA Corp | -| 12 | AMC | 406952 | AMC Entertainment Holdings Inc | -| 5 | WMT | 109864 | Walmart Inc | -| 6 | MRNA | 100705 | Moderna Inc | -| 21 | PFE | 87229 | Pfizer Inc. | -| 4 | DWAC | 66122 | Digital World Acquisition Corp | -| 29 | CSCO | 54458 | Cisco Systems, Inc. | -| 0 | SAVA | 49063 | Cassava Sciences Inc | -| 8 | TDOC | 38657 | Teladoc Health Inc | -| 16 | PENN | 38277 | Penn National Gaming, Inc. | - -Filter the results by market cap: - -```python -screener_results = openbb.stocks.ca.screener(similar = tickers, data_type = 'overview') -screener_results = screener_results.sort_values(by = ['Market Cap'], ascending = False) - -screener_results.head(5) -``` - -| | Ticker | Company | Sector | Industry | Country | Market Cap | P/E | Price | Change | Volume | -| -: | :----- | :----------------- | :----------------- | :--------------------------- | :------ | ---------: | ----: | -----: | ------: | ----------: | -| 15 | NVDA | NVIDIA Corporation | Technology | Semiconductors | USA | 3.9217e+11 | 53.53 | 163.66 | 0.0024 | 3.16641e+07 | -| 26 | WMT | Walmart Inc. | Consumer Defensive | Discount Stores | USA | 3.864e+11 | 28.46 | 140.5 | -0.0146 | 5.33372e+06 | -| 18 | PFE | Pfizer Inc. | Healthcare | Drug Manufacturers - General | USA | 2.6591e+11 | 9.03 | 49.36 | 0.037 | 1.07892e+07 | -| 4 | BLK | BlackRock, Inc. | Financial | Asset Management | USA | 1.1412e+11 | 21.34 | 747.95 | -0.0346 | 742602 | -| 25 | TGT | Target Corporation | Consumer Defensive | Discount Stores | USA | 7.566e+10 | 19.68 | 175.67 | 0.0136 | 2.45293e+06 | - -...continued - -### SEC - -Get the links for SEC filings belonging to a company: - -```python -openbb.stocks.fa.sec(symbol = 'WMT') -``` - -| Filing Date | Document Date | Type | Category | Amended | Link | -| :---------- | :------------ | :------- | :---------------- | :------ | :----------------------------------------------------------------------------------- | -| 09/09/2022 | 09/06/2022 | 8-K | Special Events | | https://www.marketwatch.com/investing/stock/wmt/financials/secfilings?docid=16074059 | -| 09/02/2022 | 07/31/2022 | 10-Q | Quarterly Reports | | https://www.marketwatch.com/investing/stock/wmt/financials/secfilings?docid=16064659 | -| 08/17/2022 | 08/17/2022 | 8-K | Special Events | | https://www.marketwatch.com/investing/stock/wmt/financials/secfilings?docid=16026629 | -| 08/17/2022 | 08/17/2022 | 8-K | Special Events | | https://www.marketwatch.com/investing/stock/wmt/financials/secfilings?docid=16025172 | -| 08/16/2022 | 08/16/2022 | 8-K | Special Events | | https://www.marketwatch.com/investing/stock/wmt/financials/secfilings?docid=16021891 | -| 07/25/2022 | 07/25/2022 | 8-K | Special Events | | https://www.marketwatch.com/investing/stock/wmt/financials/secfilings?docid=15964414 | -| 07/21/2022 | N/A | SC 13D/A | N/A | \* | https://www.marketwatch.com/investing/stock/wmt/financials/secfilings?docid=15959675 | -| 06/28/2022 | 06/28/2022 | 8-K | Special Events | | https://www.marketwatch.com/investing/stock/wmt/financials/secfilings?docid=15918852 | -| 06/21/2022 | N/A | SC 13D | N/A | | https://www.marketwatch.com/investing/stock/wmt/financials/secfilings?docid=15900809 | - -...continued - -### Insiders Trading - -View insider activity on the stock: - -```python -openbb.stocks.ins.lins(symbol = 'WMT') -``` - -| Date | Relationship | Transaction | #Shares | Cost | Value ($) | #Shares Total | Insider Trading | SEC Form 4 | -| :----- | :----------------------- | :---------- | :------ | -----: | :--------- | :------------ | :----------------- | :-------------- | -| Oct 27 | President and CEO | Sale | 9,708 | 141.18 | 1,370,617 | 1,478,337 | McMillon C Douglas | Oct 28 06:14 PM | -| Oct 27 | Executive Vice President | Sale | 4,375 | 140.94 | 616,612 | 263,809 | Furner John R. | Oct 28 06:11 PM | -| Sep 22 | Executive Vice President | Sale | 4,375 | 134.38 | 587,912 | 268,183 | Furner John R. | Sep 23 05:21 PM | -| Sep 22 | President and CEO | Sale | 9,708 | 134.04 | 1,301,309 | 1,488,043 | McMillon C Douglas | Sep 23 05:18 PM | -| Aug 25 | Director | Sale | 347,542 | 135.66 | 47,145,880 | 282,330,635 | WALTON S ROBSON | Aug 26 06:36 PM | - -...continued - -### Income Statement Comparison - -Income statements from multiple companies can be easily referenced: - -```python -openbb.stocks.ca.income(similar = ['WMT', 'TGT', 'AMZN'], quarter = True) -``` - -| Item | 31-Jul-2022: WMT | 31-Jul-2022: TGT | 30-Sep-2022: AMZN | -| :---------------------------------- | :--------------- | :--------------- | :---------------- | -| Sales/Revenue | 152.86B | 26.04B | 127.1B | -| Sales Growth | 7.97% | 3.44% | 4.84% | -| Cost of Goods Sold (COGS) incl. D&A | 115.84B | 20.71B | 70.27B | -| COGS Growth | 8.41% | 8.67% | 5.79% | -| COGS excluding D&A | 113.14B | 20.06B | 60.06B | -| Depreciation & Amortization Expense | 2.7B | 650M | 10.2B | -| Depreciation | 2.7B | - | - | -| Amortization of Intangibles | - | - | - | -| Gross Income | 37.02B | 5.32B | 56.83B | -| Gross Income Growth | 6.62% | -12.85% | 3.69% | -| Gross Profit Margin | 24.22% | 20.44% | 44.71% | -| SG&A Expense | 30.17B | 4.98B | 54.14B | -| SGA Growth | 3.30% | 4.98% | 5.33% | -| Research & Development | - | - | 19.49B | -| Other SG&A | - | - | - | -| Other Operating Expense | - | - | - | -| Unusual Expense | (238M) | 27M | (2.04B) | -| EBIT after Unusual Expense | 238M | (27M) | 2.04B | -| Non Operating Income/Expense | - | 8M | (1.45B) | -| Non-Operating Interest Income | 31M | - | 277M | - -...continued - -### Ratios - -Get historical fundamental ratios for a company: - -```python -openbb.stocks.fa.ratios(symbol = 'WMT') -``` - -| | 2022 | 2021 | 2020 | 2019 | 2018 | -| :---------------------------- | :----- | :----- | :----- | :----- | :----- | -| Period | FY | FY | FY | FY | FY | -| Current ratio | 0.928 | 0.972 | 0.795 | 0.799 | 0.760 | -| Quick ratio | 0.264 | 0.262 | 0.202 | 0.181 | 0.158 | -| Cash ratio | 0.169 | 0.191 | 0.122 | 0.100 | 0.086 | -| Days of sales outstanding | 5.277 | 4.253 | 4.378 | 4.458 | 4.095 | -| Days of inventory outstanding | 48.080 | 39.034 | 41.101 | 41.937 | 42.799 | -| Operating cycle | 53.357 | 43.287 | 45.479 | 46.395 | 46.894 | -| Days of payables outstanding | 47.017 | 42.674 | 43.449 | 44.580 | 45.056 | -| Cash conversion cycle | 6.340 | 0.613 | 2.030 | 1.814 | 1.838 | -| Gross profit margin | 0.251 | 0.248 | 0.247 | 0.251 | 0.254 | -| Operating profit margin | 0.045 | 0.040 | 0.039 | 0.043 | 0.041 | -| Pretax profit margin | 0.033 | 0.037 | 0.038 | 0.022 | 0.030 | -| Net profit margin | 0.024 | 0.024 | 0.028 | 0.013 | 0.020 | - -...continued - -Take just the ratio needed by filtering the index: - -```python -ratios = openbb.stocks.fa.ratios(symbol = 'WMT', limit = 20) -ratios.filter(like = 'Price earnings to growth ratio', axis = 0) -``` - -| | 2022 | 2021 | 2020 | 2019 | 2018 | 2017 | 2016 | 2015 | 2014 | 2013 | 2012 | 2011 | 2010 | 2009 | 2008 | 2007 | 2006 | 2005 | 2004 | 2003 | -| :----------------------------- | -----: | -----: | ---: | -----: | -----: | -----: | -----: | ----: | -----: | ----: | ---: | ----: | ----: | ----: | ----: | -----: | ----: | ----: | ----: | ----: | -| Price earnings to growth ratio | 10.202 | -3.163 | 0.16 | -1.401 | -1.069 | -4.092 | -1.501 | 4.777 | -5.487 | 1.293 | 9.68 | 0.559 | 1.585 | 1.637 | 1.022 | 15.761 | 1.498 | 1.358 | 1.953 | 1.233 | - -Be sure to check out the introduction guides for each sub-module as well. diff --git a/website/content/platform/usage/intros/stocks/insiders.md b/website/content/platform/usage/intros/stocks/insiders.md deleted file mode 100644 index a0ecba339939..000000000000 --- a/website/content/platform/usage/intros/stocks/insiders.md +++ /dev/null @@ -1,270 +0,0 @@ ---- -title: Insiders -keywords: [stocks, insiders, transactions, form-4, sec, ceo, cfo, major holder, director, sale, award, grant, option] -description: This guide introduces the Stocks Insiders module by briefly explaining the functions and how to use them. ---- -import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - -`` - -## Overview - -The Insiders module provides endpoints to the [Insiders Trading menu in the OpenBB Terminal](https://docs.openbb.co/terminal/usage/intros/stocks/ins). The contents of the module are displayed on screen with: - -```python -openbb.stocks.ins? -``` - -or: - -```python -help(openbb.stocks.ins) -``` - -```python -Type: property -String form: -Docstring: -Stocks Insiders Submodule - -Attributes: - - `act`: Get insider activity. [Source: Business Insider] - - `act_chart`: Display insider activity. [Source: Business Insider] - - `blcp`: Get latest CEO/CFO purchases > 25k - - `blcs`: Get latest CEO/CFO sales > 100k - - `blip`: Get latest insider purchases > 25k - - `blis`: Get latest insider sales > 100k - - `blop`: Get latest officer purchases > 25k - - `blos`: Get latest officer sales > 100k - - `filter`: Get insider trades based on preset filter - - `lcb`: Get latest cluster buys - - `lins`: Get last insider activity for a given stock ticker. [Source: Finviz] - - `lins_chart`: Display insider activity for a given stock ticker. [Source: Finviz] - - `lip`: Get latest insider purchases - - `lis`: Get latest insider sales - - `lit`: Get latest insider trades - - `lpsb`: Get latest penny stock buys - - `print_insider_data`: Print insider data - - `print_insider_data_chart`: Print insider data - - `stats`: Get OpenInsider stats for ticker -``` - -## How to Use - -Try the next two commands for ticker-specific information. - -### stats - -The last 100 results are returned. - -```python -openbb.stocks.ins.stats('wmt') -``` - -| | X | Filing Date | Trading Date | Ticker | Insider | Title | Trade Type | Price | Quantity | Owned | Delta Own | Value | Filing Link | Ticker Link | Insider Link | -| -: | :- | :------------------ | :----------- | :----- | :-------------- | :------- | :--------- | :----------------------------------------------------------------- | :------------------------------------------------------------------------------------ | :------------------------- | :----------------------------------------------------- | :---- | :---------- | :---------- | :----------- | -| 0 | | 2023-05-01 17:18:33 | 2023-04-27 | WMT | Furner John R. | EVP | S - Sale | $151.00 | -4,375 | 288,434 | -1% | -$660,625 | http://www.sec.gov/Archives/edgar/data/104169/000112760223013917/xslF345X03/form4.xml | http://openinsider.com/WMT | http://openinsider.com/insider/Furner-John-R./1696737 | | | | | -| 1 | M | 2023-03-30 18:36:05 | 2023-03-29 | WMT | Walton S Robson | Dir, 10% | S - Sale | $144.75 | -3,412,370 | 1,249,821,970 | 0% | -$493,930,674 | http://www.sec.gov/Archives/edgar/data/104169/000112760223011663/xslF345X03/form4.xml | http://openinsider.com/WMT | http://openinsider.com/insider/Walton-S-Robson/1219112 | | | | | - -### act - -This command returns the information a bit differently. - -```python -openbb.stocks.ins.act('wmt') -``` - -| Date | Shares Traded | Shares Held | Price | Type | Option | Insider | -| :------------------ | :------------ | :------------- | -----: | :--- | :----- | :-------------- | -| 2023-03-27 00:00:00 | 341,149.00 | 249,123,886.00 | 144.23 | Sell | No | WALTON S ROBSON | -| 2023-03-27 00:00:00 | 341,149.00 | 249,123,886.00 | 144.23 | Sell | No | WALTON ALICE L | -| 2023-03-27 00:00:00 | 1,259,851.00 | 249,465,035.00 | 143.71 | Sell | No | WALTON ALICE L | -| 2023-03-28 00:00:00 | 1,640,457.00 | 247,483,429.00 | 144.06 | Sell | No | WALTON S ROBSON | -| 2023-03-28 00:00:00 | 267,874.00 | 247,215,555.00 | 144.7 | Sell | No | WALTON S ROBSON | -| 2023-03-28 00:00:00 | 1,640,457.00 | 247,483,429.00 | 144.06 | Sell | No | WALTON ALICE L | - -Other functions in this module return all tickers, based on the latest SEC Form-4 filings. - -### lpsb - -Short for, Latest Penny Stock Buys, this command filters for insider purchases of penny stocks. - -```python -openbb.stocks.ins.lpsb().head(3) -``` - -| | X | Filing Date | Trade Date | Ticker | Company Name | Insider Name | Title | Trade Type | Price | Qty | Owned | Diff Own | Value | -| -: | :- | :---------- | :--------- | :----- | :------------------- | :------------------ | :-------- | :----------- | :-------------------------------------------------- | --: | ----: | :------- | :---- | -| 0 | M | 2023-05-17 | 2023-05-15 | ADV | Advantage Solutions | Peacock David A | CEO | P - Purchase | $1.61 | 160000 | 1858112 | +9% | +$257,752 | | | | | -| | | 16:30:22 | | | Inc. | | | | | | | | | -| 1 | - | 2023-05-17 | 2023-05-17 | SOND | Sonder Holdings Inc. | Rothenberg Philip L | GC, | P - Purchase | $0.45 | 300000 | 300000 | New | +$135,000 | | | | | -| | | 16:17:31 | | | | | Secretary | | | | | | | -| 2 | M | 2023-05-17 | 2023-05-15 | SOND | Sonder Holdings Inc. | Davidson Francis | CEO | P - Purchase | $0.41 | 615645 | 4060224 | +18% | +$249,596 | | | | | -| | | 16:15:08 | | | | | | | | | | | | - -### lit - -Stands for, Latest Insider Trades, and returns the last one-hundred insider trades, market-wide. - -```python -openbb.stocks.ins.lit().head(3) -``` - -| | X | Filing Date | Trade Date | Ticker | Company Name | Insider Name | Title | Trade Type | Price | Qty | Owned | Diff Own | Value | -| -: | :- | :---------- | :--------- | :----- | :------------------- | :--------------- | :--------- | :---------- | :----------------------------------------------------- | --: | ----: | :------- | :---- | -| 0 | DM | 2023-05-17 | 2023-05-15 | AMZN | Amazon Com Inc | Selipsky Adam | CEO Amazon | S - Sale+OE | $110.47 | -11260 | 150103 | -7% | -$1,243,914 | | | | | -| | | 16:40:35 | | | | | Web | | | | | | | -| | | | | | | | Services | | | | | | | -| 1 | D | 2023-05-17 | 2023-05-15 | TDUP | Thredup Inc. | Nakache Patricia | Dir, 10% | S - Sale+OE | $3.01 | -28123 | 76976 | -27% | -$84,650 | | | | | -| | | 16:39:59 | | | | | | | | | | | | -| 2 | - | 2023-05-17 | 2023-05-15 | RRC | Range Resources Corp | Scucchi Mark | EVP, CFO | S - Sale | $27.39 | -153000 | 772540 | -17% | -$4,190,670 | | | | | -| | | 16:39:52 | | | | | | | | | | | | - -`lip` & `lis` filter for purchases and sales, respectively. - -### filter - -The `filter` function is a customizable screener that allows scanning in greater detail. User-generated presets are saved in the OpenBBUserData folder, under: `~/OpenBBUserData/presets/stocks/insider`. Presets included with the code are located in the source code, [here](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/miscellaneous/stocks/insider). Use, [template.ini](https://github.com/OpenBB-finance/OpenBBTerminal/blob/main/openbb_terminal/miscellaneous/stocks/insider/template.ini), as a starting point. The following fields are allowed: - -```console -[General] -# Symbols or CIKs -Tickers = -# Insider Name or CIK -Insider = -SharePriceMin = -SharePriceMax = -LiquidityMinM = -LiquidityMaxM = - -[Date] -# All dates, Custom, Latest Day, Last 3 days, Last 1 week, Last 2 weeks, Last 1 month, Last 2 months, Last 3 months, Last 6 months, Last 1 year, Last 2 years, Last 4 years. -FilingDate = All dates -# This is only regarded if FillingDate = Custom, format: dd/mm/yyyy -FilingDateFrom = -FilingDateTo = -# All dates, Custom, Latest Day, Last 3 days, Last 1 week, Last 2 weeks, Last 1 month, Last 2 months, Last 3 months, Last 6 months, Last 1 year, Last 2 years, Last 4 years. -TradingDate = All dates -# This is only regarded if FillingDate = Custom, format: dd/mm/yyyy -TradingDateFrom = -TradingDateTo = -# These values need to be smaller than 100 -FilingDelayMin = -FilingDelayMax = -NDaysAgo = - -[TransactionFiling] -# The following values are meant to be either: 'true' or empty for False. -P_Purchase = true -S_Sale = true -A_Grant = -D_SaleToLoss = -G_Gift = -NoDeriv = -F_Tax = -M_OptionEx = -X_OptionEx = -C_CnvDeriv = -W_Inherited = -MultipleDays = -# These values need to be multiples of 5 -TradedMinK = -TradedMaxK = -# These values need to be between 0 and 100% -OwnChangeMinPct = -OwnChangeMaxPct = - -[Industry] -# Available industry options at bottom of the file. -# Sector -> Subsector -> Industry -SectorSubsectorIndustry = All Sectors (except Funds) - -[InsiderTitle] -# The following values are meant to be either: 'true' or empty for False. -COB = -CEO = -Pres = -COO = -CFO = -GC = -VP = -# 'Officer' includes all of the above: COB, CEO, Pres, COO, CFO, GC, VP -Officer = -Director = -10PctOwn = -Other = - -[Others] -# Filing, Company. -GroupBy = Filing -# Filing Date, Trade Date, Ticker Symbol, Trade Value. -SortBy = Filing Date -# 100, 200, 300, 400, 500, 600, 700, 800, 900, 1000. -MaxResults = 100 -# Between 1 and 99, inclusive. -Page = 1 - -# This only exists if GroupBy = Company -[CompanyTotals] -# These values need to be smaller than 100 -FilingsMin = -FilingsMax = -# These values need to be smaller than 10 -InsidersMin = -InsidersMax = -OfficersMin = -OfficersMax = -# These values need to be multiples of 5 -TradedMinK = -TradedMaxK = -# These values need to be between 0 and 100% -OwnChangeMinPct = -OwnChangeMaxPct = -``` - -The sector industrial classification is also selectable. Most of the included presets are for filtering by industry. For example, `Mortgages`. - -**Do not include `.ini` in the preset name.** - -```python -openbb.stocks.ins.filter("Mortgages") -``` - -| | X | Filing Date | Trading Date | Ticker | Insider | Title | Trade Type | Price | Quantity | Owned | Delta Own | Value | Filing Link | Ticker Link | Insider Link | Company | -| -: | :- | :------------------ | :----------- | :----- | :------------------------------------------------------- | :------- | :----------- | :-------------------------------------------------------------- | :------------------------------------------------------------------------------------- | :-------------------------- | :---------------------------------------------------------------------------------------------- | :-------------------------------- | :---------- | :---------- | :----------- | :------ | -| 0 | | 2023-04-05 18:25:23 | 2023-04-04 | PFSI | Spector David | COB, CEO | S - Sale | $59.71 | -15,000 | 1,070,787 | -1% | -$895,713 | http://www.sec.gov/Archives/edgar/data/1745916/000112760223012621/xslF345X03/form4.xml | http://openinsider.com/PFSI | http://openinsider.com/insider/Spector-David/1275713 | Pennymac Financial Services, Inc. | | | | | -| 1 | D | 2023-04-04 17:32:57 | 2023-03-31 | FOA | Blackstone Tactical Opportunities Associates - Nq L.L.C. | 10% | P - Purchase | $1.38 | +10,869,566 | 24,386,710 | +80% | +$15,000,001 | http://www.sec.gov/Archives/edgar/data/1828937/000089924323010452/xslF345X03/doc4.xml | http://openinsider.com/FOA | http://openinsider.com/insider/Blackstone-Tactical-Opportunities-Associates---Nq-L.L.C./1844883 | Finance of America Companies Inc. | | | | | -| 2 | D | 2023-04-04 17:31:43 | 2023-03-31 | FOA | Bto Urban Holdings L.L.C. | 10% | P - Purchase | $1.38 | +10,869,566 | 24,386,710 | +80% | +$15,000,001 | http://www.sec.gov/Archives/edgar/data/1828937/000089924323010448/xslF345X03/doc4.xml | http://openinsider.com/FOA | http://openinsider.com/insider/Bto-Urban-Holdings-L.L.C./1854686 | Finance of America Companies Inc. | | | | | -| 3 | D | 2023-04-04 17:27:24 | 2023-03-31 | FOA | Blackstone Tactical Opportunities Fund - U - Nq L.L.C. | 10% | P - Purchase | $1.38 | +10,869,566 | 24,386,710 | +80% | +$15,000,001 | http://www.sec.gov/Archives/edgar/data/1828937/000089924323010444/xslF345X03/doc4.xml | http://openinsider.com/FOA | http://openinsider.com/insider/Blackstone-Tactical-Opportunities-Fund---U---Nq-L.L.C./1853348 | Finance of America Companies Inc. | | | | | - -Try the `whales` preset to track some of the big money: - -```python -openbb.stocks.ins.filter("whales") -``` - -| | X | Filing Date | Trading Date | Ticker | Insider | Title | Trade Type | Price | Quantity | Owned | Delta Own | Value | Filing Link | Ticker Link | Insider Link | Company | -| -: | :- | :------------------ | :----------- | :----- | :------------------------ | :------------------------ | :----------- | :--------------------------------------------------------------- | :------------------------------------------------------------------------------------- | :------------------------- | :--------------------------------------------------------------- | :----------------------------- | :---------- | :---------- | :----------- | :------ | -| 0 | DM | 2023-05-15 21:26:39 | 2023-05-11 | OXY | Berkshire Hathaway Inc | 10% | P - Purchase | $58.06 | +2,165,792 | 213,966,443 | +1% | +$125,746,876 | http://www.sec.gov/Archives/edgar/data/797468/000089924323013028/xslF345X03/doc4.xml | http://openinsider.com/OXY | http://openinsider.com/insider/Berkshire-Hathaway-Inc/1067983 | Occidental Petroleum Corp /De/ | | | | | -| 1 | M | 2023-05-15 16:32:03 | 2023-05-11 | MA | Mastercard Foundation | 10% | S - Sale | $381.83 | -377,448 | 99,808,197 | 0% | -$144,121,385 | http://www.sec.gov/Archives/edgar/data/1141391/000089534523000297/xslF345X03/form4.xml | http://openinsider.com/MA | http://openinsider.com/insider/Mastercard-Foundation/1421897 | Mastercard Inc | | | | | -| 2 | | 2023-05-12 19:50:56 | 2023-05-10 | STZ | Ajb Business Holdings LP | Member of 10% owner group | S - Sale | $223.53 | -650,000 | 3,365,715 | -16% | -$145,294,500 | http://www.sec.gov/Archives/edgar/data/16918/000089924323012892/xslF345X03/doc4.xml | http://openinsider.com/STZ | http://openinsider.com/insider/Ajb-Business-Holdings-LP/1955386 | Constellation Brands, Inc. | | | | | -| 3 | | 2023-05-12 19:46:15 | 2023-05-10 | STZ | Zmss Business Holdings LP | Member of 10% owner group | S - Sale | $223.53 | -650,000 | 3,365,715 | -16% | -$145,294,500 | http://www.sec.gov/Archives/edgar/data/16918/000089924323012888/xslF345X03/doc4.xml | http://openinsider.com/STZ | http://openinsider.com/insider/Zmss-Business-Holdings-LP/1955193 | Constellation Brands, Inc. | | | | | diff --git a/website/content/platform/usage/intros/stocks/options-chains.md b/website/content/platform/usage/intros/stocks/options-chains.md deleted file mode 100644 index e3eec200bf23..000000000000 --- a/website/content/platform/usage/intros/stocks/options-chains.md +++ /dev/null @@ -1,551 +0,0 @@ ---- -title: Options Chains -keywords: [OpenBB, sdk, Options, stocks, derivatives, puts, calls, oi, vol, greeks, voi, volatility, chains, usage, iv, gamma, delta, theta, strategies, skew, straddle, strangle, spread, vertical, horizontal] -excerpt: This guide introduces the Options class and data object. ---- - -import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - - - -## Overview - -### Options Data Object - -Options chains data is loaded to memory by using the function, `openbb.stocks.options.load_options_chains()`, and is available from six sources: - -- CBOE -- Intrinio (no free data) -- Nasdaq -- TMX -- Tradier (requires Sandbox developer key) -- YahooFinance - -Every source will return the same object which has data and additional callable functions bound to the class. They are methods for filtering, sorting, and analyzing the data contained within. - -```python -from openbb_terminal.sdk import openbb -openbb.stocks.options.load_options_chains? -``` - -```python -Parameters ----------- -symbol: str - The ticker symbol to load the data for. -source: str - The source for the data. Defaults to "CBOE". ["CBOE", "Intrinio", "Nasdaq", "TMX", "Tradier", "YahooFinance"] -date: str - The date for EOD chains data. Only available for "Intrinio" and "TMX". -pydantic: bool - Whether to return as a Pydantic Model or as a Pandas object. Defaults to False. - -Returns ------- -OptionsChains - chains: pd.DataFrame - The complete options chain for the ticker. Returns as a dictionary if pydantic is True. - expirations: list[str] - List of unique expiration dates. (YYYY-MM-DD) - strikes: list[float] - List of unique strike prices. - last_price: float - The last price of the underlying asset. - underlying_name: str - The name of the underlying asset. - underlying_price: pd.Series - The price and recent performance of the underlying asset. Returns as a dictionary if pydantic is True. - hasIV: bool - Returns implied volatility. - hasGreeks: bool - Returns greeks data. - symbol: str - The symbol entered by the user. - source: str - The source of the data. - date: str - The date, when the chains data is historical EOD. - SYMBOLS: pd.DataFrame - The symbol directory for the source, when available. Returns as a dictionary if pydantic is True. - - Methods - ------ - chart_skew: Callable - Function to chart the implied volatility skew. - chart_stats: Callable - Function to chart a variety of volume and open interest statistics. - chart_surface: Callable - Function to chart the volatility as a 3-D surface. - chart_volatility: Callable - Function to chart the implied volatility smile. - get_skew: Callable - Function to calculate horizontal and vertical skewness. - get_stats: Callable - Function to return a table of summary statistics, by strike or by expiration. - get_straddle: Callable - Function to calculate straddles and the payoff profile. - get_strangle: Callable - Function to calculate strangles and the payoff profile. - get_synthetic_long: Callable - Function to calculate a synthetic long position. - get_synthetic_short: Callable - Function to calculate a synthetic short position. - get_vertical_call_spread: Callable - Function to calculate vertical call spreads. - get_vertical_put_spreads: Callable - Function to calculate vertical put spreads. - get_strategies: Callable - Function for calculating multiple straddles and strangles at different expirations and moneyness. -``` - -## Loading Data - -### `load_options_chains()` - -The default source to load data from is, `CBOE`. Use the command below to get started. - -```python -from openbb_terminal.sdk import openbb -spy = openbb.stocks.options.load_options_chains("SPY") -``` - -The result is returned as the object described in the previous section. - -![Options Data Object](https://github.com/deeleeramone/OpenBBTerminal/assets/85772166/704e6d60-b148-442d-b4b2-689ceca6f55c) - -The object is still returned if an unsupported symbol is requested and a message will be printed. - -```python -In [4]: data = openbb.stocks.options.load_options_chains("spyyy") -The symbol, SPYYY, was not found in the CBOE directory. - -In [5]: data.chains -Out[5]: pandas.core.frame.DataFrame -``` - -Where available, symbols are verified against a source-specific symbol directory. This is accessible from the Options data object as the attribute named, `SYMBOLS`. - -```python -data.SYMBOLS.filter(like = "SPY", axis = 0) -``` - -| Symbol | Company Name | DPM Name | Post/Station | -|:---------|:-------------------------------|:-------------------------|:---------------| -| SPY | SPDR S&P 500 ETF TR TR UNIT | Morgan Stanley & Co. LLC | 8/1 | -| SPYG | SPDR SER TR PRTFLO S&P500 GW | Belvedere Trading LLC | 6/1 | -| SPYD | SPDR SER TR PRTFLO S&P500 HI | Citadel Securities LLC | 6/1 | -| SPYV | SPDR SER TR PRTFLO S&P500 VL | Belvedere Trading LLC | 6/1 | -| NSPY | UNIFIED SER TR NIGHTSHARES 500 | Wolverine Trading, LLC | 3/1 | - -:::note -A valid symbol will not always have listed options. -::: - -Key information for the underlying asset are stored in the object as `last_price`, `underlying_name`, and `underlying_price`. The information returned to `underlying_price` will vary by source, but all column headers and index names related to the raw data are formatted in camelCase. - -CBOE: - -```python -In [7]: data.underlying_price -Out[7]: -type stock -tick down -bid 449.18 -bidSize 1 -askSize 5 -ask 449.2 -price 449.28 -open 450.56 -high 451.36 -low 448.49 -close 449.28 -volume 69772484 -previousClose 449.28 -change -0.28 -changePercent -0.0623 -ivThirty 10.947 -ivThirtyChange 0.0 -lastTradeTimestamp 2023-07-14T16:00:00 -ivThirtyOneYearHigh 30.646999 -hvThirtyOneYearHigh 30.648199 -ivThirtyOneYearLow 10.692 -hvThirtyOneYearLow 10.0721 -ivSixtyOneYearHigh 28.674999 -hvSixtyOneYearHigh 29.5842 -ivSixtyOneYearLow 11.245 -hvsixtyOneYearLow 11.833 -ivNinetyOneYearHigh 27.862 -hvNinetyOneYearHigh 26.808901 -ivNinetyOneYearLow 11.827 -hvNinetyOneYearLow 13.3855 -Name: SPY, dtype: object -``` - -TMX: - -```python -In [8]: data = openbb.stocks.options.load_options_chains("XIU", "TMX") - -In [9]: data.underlying_price -Out[9]: -time 15:59:56.910 -previousClose 30.86 -transactions 393 -volume 50751 -value 1567628 -valueCAD 1567628 -open 30.97 -price 30.85 -change -0.01 -changePercent -0.03 -tick 0.01 -low 30.835 -high 30.97 -vwap 30.89 -fiftyTwoWeekHigh 31.86 -fiftyTwoWeekLow 27.375 -Name: XIU, dtype: object -``` - -Not every source will return implied volatility or Greeks data. The two object attributes, `hasGreeks` and `hasIV`, act as validators for downstream functions. - -```python -In [10]: data.hasIV -Out[10]: False - -In [11]: data.get_skew() -Options data object does not have Implied Volatility and is required for this function. -``` - -#### Historical EOD Chains - -Historical EOD chains data is currently available from `Intrinio` or `TMX`. The amount of historical data will depend on the subscription status with `Intrinio`, but is available from the beginning of 2009 from `TMX`. Add the `date` argument when loading the data. The price data of the underlying asset will reflect the closing price on the date entered. - -```python -In [12]: data = openbb.stocks.options.load_options_chains("CCO", "TMX", date = "2016-06-29") - -In [13]: data.underlying_price -Out[13]: -date 2016-06-29 -bid 13.99 -ask 14.01 -bidSize 29 -askSize 20 -price 14.0 -volume 801176 -previousClose 13.73 -change 0.27 -open 13.88 -high 14.09 -low 13.8 -valueCAD 11198995 -transactions 3283 -symbol CCO -Name: Cameco Corporation, dtype: object -``` - -## Additional Class Methods - -The class methods work with the Options data object to query the loaded chains data in different ways. Column headers at this stage are cleaned and presentable for view. There are two types of operations, `get` and `chart`, with the latter being a subset of the former. The docstring (`data?` - and as shown in a section above) lists them all, as Methods, with a short description. The nuances of the functions are explained within the docstrings of each. Variations to the combinations of parameters will yield over thirty unique charts and provide nearly infinite ways to query to data stored in the object. - -:::note - -All `chart_` methods have boolean arguments for `raw` and `external_axes`. These return an interactive table in the PyWry window or the Plotly figure object, respectively. In a Jupyter Notebook, they will be displayed inline. - -Returning the command to a variable provides the ability to style and customize charts as desired. - -```python -fig = data.chart_volatility(expirations=data.expirations[1], external_axes = True) -``` - -::: - -### `get_stats()` - -```python -Parameters ----------- -by: str - Whether to calculate by strike or expiration. Default is expiration. -query: DataFrame - Entry point to perform DataFrame operations on self.chains at the input stage. - -Returns -------- -pd.DataFrame - Pandas DataFrame with the calculated statistics. -``` - -Ratios are defined as Put/Call. - -```python -data = openbb.stocks.options.load_options_chains("VIX") -data.get_stats().iloc[1] -``` - -| | 2023-07-26 | -|:-------------|-------------:| -| Puts OI | 2018 | -| Calls OI | 45875 | -| Total OI | 47893 | -| OI Ratio | 0.04 | -| Puts OTM | 873 | -| Calls OTM | 45747 | -| Puts ITM | 1145 | -| Calls ITM | 128 | -| OTM Ratio | 0.02 | -| ITM Percent | 2.66 | -| Puts Volume | 264 | -| Calls Volume | 2156 | -| Total Volume | 2420 | -| Volume Ratio | 0.12 | -| Vol-OI Ratio | 0.05 | - -The `query` parameter provides an entry point for DataFrame operations to take place prior to calculating. For example, filtering for only the options which traded during the last session. - -```python -data.get_stats(query = data.chains[vix.chains["lastTradeTimestamp"] > "2023-07-14"]) -``` - -| Expiration | Puts OI | Calls OI | Total OI | OI Ratio | Puts Volume | Calls Volume | Total Volume | Volume Ratio | Vol-OI Ratio | -|:-------------|-----------------:|-----------------:|-----------------:|-----------:|--------------:|---------------:|---------------:|---------------:|---------------:| -| 2023-07-19 | 1569778 | 3323396 | 4893174 | 0.47 | 113460 | 130416 | 243876 | 0.87 | 0.05 | -| 2023-07-26 | 1855 | 29273 | 31128 | 0.06 | 264 | 2156 | 2420 | 0.12 | 0.08 | -| 2023-08-02 | 1154 | 2498 | 3652 | 0.46 | 12 | 786 | 798 | 0.02 | 0.22 | -| 2023-08-09 | 330 | 961 | 1291 | 0.34 | 43 | 354 | 397 | 0.12 | 0.31 | -| 2023-08-16 | 907980 | 2246707 | 3154687 | 0.4 | 48668 | 197148 | 245816 | 0.25 | 0.08 | -| 2023-08-23 | 0 | 49 | 49 | 0 | 7 | 145 | 152 | 0.05 | 3.1 | -| 2023-09-20 | 614369 | 2097742 | 2712111 | 0.29 | 20750 | 19260 | 40010 | 1.08 | 0.01 | -| 2023-10-18 | 165239 | 1099858 | 1265097 | 0.15 | 3304 | 14912 | 18216 | 0.22 | 0.01 | -| 2023-11-15 | 70142 | 742698 | 812840 | 0.09 | 82 | 514 | 596 | 0.16 | 0 | -| 2023-12-20 | 44580 | 259815 | 304395 | 0.17 | 10797 | 12471 | 23268 | 0.87 | 0.08 | -| 2024-01-17 | 20860 | 43733 | 64593 | 0.48 | 23574 | 23690 | 47264 | 1 | 0.73 | -| 2024-02-14 | 1347 | 6567 | 7914 | 0.21 | 67 | 203 | 270 | 0.33 | 0.03 | -| 2024-03-20 | 63 | 1861 | 1924 | 0.03 | 8 | 219 | 227 | 0.04 | 0.12 | - -### chart_stats() - -The volume and open interest metrics can be visualized in a number of ways. In general, they are bucketed as volume and open interest by strike or expiration. - -```python -data.chart_stats() -``` - -![Vix % of Total Volume vs. Strike](https://github.com/deeleeramone/OpenBBTerminal/assets/85772166/70d55645-7510-4c1e-9e56-c6b37ef40249) - -```python -data.chart_stats(by="strike", oi=True) -``` - -![VIX % of Total Open Interest vs. Strike](https://github.com/deeleeramone/OpenBBTerminal/assets/85772166/9798ed44-23c3-4a54-9c20-ea6450c035d9) - -```python -data.chart_stats(by="strike", oi=True, percent=False) -``` - -![VIX Open Interest vs. Strike](https://github.com/deeleeramone/OpenBBTerminal/assets/85772166/b1bed9c5-4338-4fb5-8ffe-a67eba6c5219) - -```python -data.chart_stats(ratios=True) -``` - -![VIX Volume and Open Interest Ratios](https://github.com/deeleeramone/OpenBBTerminal/assets/85772166/0c459c96-267b-472e-8323-cb547af0e0e4) - -### Options Strategies - -These methods calculate common, single-leg, strategies and return one result. The target expiry date is expressed as the number of days until expiration, and the closest expiry to supplied value will be returned. There are six types of strategies currently supported: - -- `get_straddle()` -- `get_strangle()` -- `get_synthetic_long()` -- `get_synthetic_short()` -- `get_vertical_call_spread()` -- `get_vertical_put_spread()` - -:::note - -Looking for a place to get started as a contributor, and enjoy trading options? Strategies are an excellent starting point! - -::: - -All strategies share a common default setting, `days=30`. Vertical spreads require two strike prices, and they are entered as `sold`, `bought`. A bull call or put spread is entered with a bought price lower than the sold price. - -```python -data.get_vertical_call_spread(30,13,12.50) -``` - -| | Bull Call Spread | -|:------------------------|:-------------------| -| Symbol | VIX | -| Underlying Price | 13.34 | -| Expiration | 2023-08-16 | -| DTE | 31 | -| Strike 1 | 13.0 | -| Strike 2 | 12.5 | -| Strike 1 Premium | 2.9 | -| Strike 2 Premium | 3.4 | -| Cost | 0.5 | -| Cost Percent | 3.7481 | -| Breakeven Lower | 13.0 | -| Breakeven Lower Percent | -2.5487 | -| Breakeven Upper | nan | -| Breakeven Upper Percent | nan | -| Max Profit | 0.0 | -| Max Loss | -0.5 | -| Payoff Ratio | 0.0 | - -```python -data.get_vertical_put_spread(30,13,12.5) -``` - -| | Bull Put Spread | -|:------------------------|:---------------------| -| Symbol | VIX | -| Underlying Price | 13.34 | -| Expiration | 2023-08-16 | -| DTE | 31 | -| Strike 1 | 13.0 | -| Strike 2 | 12.5 | -| Strike 1 Premium | -0.17 | -| Strike 2 Premium | 0.12 | -| Cost | -0.05 | -| Cost Percent | 0.3748 | -| Breakeven Lower | nan | -| Breakeven Lower Percent | nan | -| Breakeven Upper | 12.95 | -| Breakeven Upper Percent | 2.92 | -| Max Profit | 0.05 | -| Max Loss | -0.45 | -| Payoff Ratio | 0.1111 | - -#### `get_strategies()` - -This takes all of the individual strategies and combines them into a single endpoint that can iterate over all expiry dates. - -```python -data.get_strategies(days = 30, straddle_strike = data.last_price, strangle_moneyness = 30, vertical_calls = [20,15], vertical_puts = [12,15], synthetic_longs = 16, synthetic_shrots = 14) -``` - -| | 2023-08-16 | 2023-08-16 | 2023-08-16 | 2023-08-16 | 2023-08-16 | 2023-08-16 | -|:------------------------|:--------------------|:------------------|:---------------|:----------------|:-----------------|:-------------------| -| DTE | 31 | 31 | 31 | 31 | 31 | 31 | -| Strategy | Long Straddle | Long Strangle | Synthetic Long | Synthetic Short | Bull Call Spread | Bear Put Spread | -| Underlying Price | 13.34 | 13.34 | 13.34 | 13.34 | 13.34 | 13.34 | -| Strike 1 | 13.5 | 17.0 | 14.0 | 16.0 | 20.0 | 12.0 | -| Strike 2 | 13.5 | 10.0 | 14.0 | 16.0 | 15.0 | 15.0 | -| Strike 1 Premium | 2.62 | 1.28 | 2.31 | -1.46 | -0.83 | -0.04 | -| Strike 2 Premium | 0.33 | 0.01 | -0.49 | 1.74 | 1.83 | 1.04 | -| Cost | 2.95 | 1.29 | 1.82 | 0.28 | 1.0 | 1.0 | -| Cost Percent | 22.1139 | 9.6702 | 13.6432 | 2.099 | 7.4963 | 7.4963 | -| Breakeven Upper | 16.45 | 18.29 | 15.82 | nan | nan | nan | -| Breakeven Upper Percent | 23.3133 | 37.1064 | 18.5907 | nan | nan | nan | -| Breakeven Lower | 10.55 | 8.71 | nan | 15.72 | 16.0 | 14.0 | -| Breakeven Lower Percent | -20.9145 | -34.7076 | nan | 17.8411 | 19.94 | 17.5412 | -| Max Profit | inf | inf | inf | 15.72 | 4.0 | 2.0 | -| Max Loss | -2.95 | -1.29 | -15.82 | inf | -1.0 | -1.0 | -| Payoff Ratio | inf | inf | nan | nan | 4.0 | 2.0 | - -The default state of `get_strategies()` is to return all ATM straddles. This information can be useful for charting the term structure and expected move of the underlying asset. - -### Volatility - -There are two types of views for volatility, smiles and surfaces. - -#### `chart_volatility()` - -As a default state, the put and call volatility smiles from the expiration in position 1, contained in the list `data.expirations[1]`, are displayed. - -```python -data.chart_volatility() -``` - -![VIX IV Smile](https://github.com/deeleeramone/OpenBBTerminal/assets/85772166/1bf4534a-7ae8-4770-9b07-5e793889beb9) - -The implied volatility can also be visualized as the forward curve at a specific strike or % moneyness. - -```python -data.chart_volatility(strike=20) -``` - -![VIX Volatility at $20 Strike](https://github.com/deeleeramone/OpenBBTerminal/assets/85772166/e2b0dba6-2a51-4ff2-9e43-3667de15ae21) - -```python -data.chart_volatility(moneyness=30) -``` - -![VIX Volatility at 30% OTM](https://github.com/deeleeramone/OpenBBTerminal/assets/85772166/c344724b-8544-4cd1-8cab-25e1924137a5) - -#### `chart_surface()` - -A portion, or the entire, volatility surface is presented as a 3-D chart. The data is arranged by types, selectable with the `option_type` parameter, choosing one of: `otm`, `itm`, `calls`, `puts`. The default state is `otm`. The X and Y axes can be narrowed to focus on a range of time and strike. - -```python -data.chart_surface(dte_range = [30,300], strike_range = [10,30]) -``` - -![VIX OTM IV Surface](https://github.com/deeleeramone/OpenBBTerminal/assets/85772166/410769fe-b7da-40bf-915e-68901b3caf13) - -### Skew - -Unlike volatility, there are both model and view components for the IV skew of the chain. - -#### `get_skew()` - -By default, this callable calculates the skew of every option. It can return either vertical or horizontal skew. Vertical skew can be narrowed to a specific expiry, and horizontal skew is determined by % OTM. - -```python -data.get_skew(data.expirations[1]).query("12 <= `Strike` <= 15") -``` - -| | Expiration | Strike | Option Type | IV | ATM IV | Skew | -|----:|:-------------|---------:|:--------------|-------:|---------:|--------:| -| 116 | 2023-07-26 | 12 | put | 1.1136 | 0.9283 | 0.1853 | -| 117 | 2023-07-26 | 12.5 | put | 1.0246 | 0.9283 | 0.0963 | -| 118 | 2023-07-26 | 13 | put | 0.9666 | 0.9283 | 0.0383 | -| 119 | 2023-07-26 | 13.5 | put | 0.9283 | 0.9283 | 0 | -| 120 | 2023-07-26 | 14 | call | 0.4994 | 0.4994 | 0 | -| 121 | 2023-07-26 | 14 | put | 0.8702 | 0.9283 | -0.0581 | -| 122 | 2023-07-26 | 14.5 | call | 0.6156 | 0.4994 | 0.1162 | -| 123 | 2023-07-26 | 14.5 | put | 0.8899 | 0.9283 | -0.0384 | -| 124 | 2023-07-26 | 15 | call | 0.6245 | 0.4994 | 0.1251 | -| 125 | 2023-07-26 | 15 | put | 0.9002 | 0.9283 | -0.0281 | - -```python -vix.get_skew(moneyness=20) -``` - -| expiration | Call Strike | Call IV | Call ATM IV | Call Skew | Put Strike | Put IV | Put ATM IV | Put Skew | ATM Skew | IV Skew | -|:-------------|--------------:|----------:|--------------:|------------:|-------------:|---------:|-------------:|-----------:|-----------:|----------:| -| 2023-07-19 | 16 | 1.0996 | 0.599 | 0.5006 | 10.5 | 1.0505 | 0.6328 | 0.4177 | -0.0338 | 0.0829 | -| 2023-07-26 | 16 | 0.8708 | 0.4994 | 0.3714 | 10.5 | 0.9101 | 0.9283 | -0.0182 | -0.4289 | 0.3896 | -| 2023-08-02 | 16 | 0.855 | 0.5026 | 0.3524 | 10.5 | 0.7438 | 0.6755 | 0.0683 | -0.1729 | 0.2841 | -| 2023-08-09 | 16 | 0.7861 | 0.4926 | 0.2935 | 10.5 | 0.6712 | 0.6575 | 0.0137 | -0.1649 | 0.2798 | -| 2023-08-16 | 16 | 0.8364 | 0.6284 | 0.208 | 10.5 | 0.6041 | 0.6117 | -0.0076 | 0.0167 | 0.2156 | -| 2023-08-23 | 16 | 0.9273 | 0.8918 | 0.0355 | 10.5 | 0.5492 | 0.6356 | -0.0864 | 0.2562 | 0.1219 | -| 2023-09-20 | 16 | 0.7023 | 0.5481 | 0.1542 | 10 | 0.5344 | 0.548 | -0.0136 | 0.0001 | 0.1678 | -| 2023-10-18 | 16 | 0.6447 | 0.5183 | 0.1264 | 10 | 0.4751 | 0.5178 | -0.0427 | 0.0005 | 0.1691 | -| 2023-11-15 | 16 | 0.6064 | 0.5069 | 0.0995 | 10 | 0.4548 | 0.4947 | -0.0399 | 0.0122 | 0.1394 | -| 2023-12-20 | 16 | 0.5716 | 0.4754 | 0.0962 | 10 | 0.426 | 0.4734 | -0.0474 | 0.002 | 0.1436 | -| 2024-01-17 | 16 | 0.5224 | 0.4248 | 0.0976 | 10 | 0.4372 | 0.4372 | 0 | -0.0124 | 0.0976 | -| 2024-02-14 | 16 | 0.494 | 0.4228 | 0.0712 | 10 | 0.4136 | 0.4258 | -0.0122 | -0.003 | 0.0834 | -| 2024-03-20 | 16 | 0.4533 | 0.4008 | 0.0525 | 10 | 0.4665 | 0.4162 | 0.0503 | -0.0154 | 0.0022 | - -#### chart_skew() - -As a default state, the put and call skew smiles from the expiration in position 1, contained in the list `data.expirations[1]`, are displayed. - -`data.chart_skew()` - -![VIX IV Skew](https://github.com/deeleeramone/OpenBBTerminal/assets/85772166/509ac801-85bc-41e9-9f6c-7654e471db77) - -Multiple expirations can be displayed by entering a list to the `expirations` parameter. - -`data.chart_skew(expirations=[data.expirations[6],data.expirations[10]])` - -![Multiple Expirations - VIX IV Skew](https://github.com/deeleeramone/OpenBBTerminal/assets/85772166/604407aa-bb0a-44dd-8051-0665ddb90b96) - -The forward curve is also callable by strike. - -`data.chart_skew(strike = 20)` - -![VIX IV Skew at $20 Strike](https://github.com/deeleeramone/OpenBBTerminal/assets/85772166/949674b9-7366-4beb-b278-2ee5c0d5dd71) diff --git a/website/content/platform/usage/intros/stocks/options.md b/website/content/platform/usage/intros/stocks/options.md deleted file mode 100644 index a1627f89817e..000000000000 --- a/website/content/platform/usage/intros/stocks/options.md +++ /dev/null @@ -1,108 +0,0 @@ ---- -title: Options -keywords: [OpenBB, sdk, Options, stocks, derivatives, puts, calls, oi, vol, greeks, voi, volatility, vsurf, chains, parity, binom, screen, pricing, hedge, pcr, info, hist, grhist, plot, parity, how to, usage, examples, path, import, unusual options, options] -excerpt: This guide introduces the user to Options submenu within the Stocks menu. ---- - -import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - - - -The Options module wraps the Terminal commands for the Platform layer, providing programmatic access and greater flexibility for processing data. - -## How to Use - -The functions in the Options sub-module are listed below, along with a short description. - -|Path |Description | -|:----|-----------:| -|stocks.options.pcr| Put-Call Ratio | -|stocks.options.info| Option Information | -|stocks.options.unu| Unusual Options Activity| -|stocks.options.hist|Historical Option Data| -|stocks.options.chains | Option Chain Data| -||stocks.options.eodchain | Get End of Day Option Chain Data| -|stocks.options.vol| Display Volume plot| -|stocks.options.oi| Display open interest plot| -|stocks.options.voi| Display plot of volume and open interest| -|stocks.options.expirations| Get Option Expirations| -|stocks.options.vsurf|Show volatility surface| - -Alternatively, the contents of the menu or a function's docstrings can be printed using Python's built-in help. - -```python -help(openbb.stocks.options) -``` - -## Examples - -### Import Statements - -The examples in this section will assume these statements are included at the top of the file: - -```python -from openbb_terminal.sdk import openbb -import pandas as pd -``` - -### Unusual Options - -`openbb.stocks.options.unu` returns a DataFrame with the current day's unusual options, those having a very high volume/open interest ratio. This function returns a Tuple containing the DataFrame and a string. Unpack it like this: - -```python -unu_df,unu_ts = openbb.stocks.options.unu(limit = 500) -unu_df = unu_df.sort_values(by = 'Vol/OI', ascending = False) - -unu_df -``` - -| | Ticker | Exp | Strike | Type | Vol/OI | Vol | OI | Bid | Ask | -|---:|:---------|:-----------|---------:|:-------|---------:|-------:|-----:|------:|------:| -| 0 | T | 2023-01-06 | 21 | Call | 61 | 8598 | 141 | 0.03 | 0.04 | -| 1 | T | 2023-01-06 | 19 | Put | 40.7 | 10173 | 250 | 0.39 | 0.42 | -| 2 | SCHW | 2023-03-17 | 87.5 | Call | 35.1 | 4317 | 123 | 3.2 | 3.35 | -| 3 | TSLA | 2022-12-02 | 192.5 | Put | 31.1 | 179688 | 5774 | 0.01 | 0.02 | -| 4 | FDX | 2022-12-09 | 190 | Call | 29.2 | 7098 | 243 | 0.67 | 0.69 | -| 403 | FCX | 2022-12-09 | 36 | Put | 2.1 | 1513 | 729 | 0.04 | 0.06 | -| 402 | CAT | 2022-12-09 | 227.5 | Put | 2.1 | 601 | 280 | 0.94 | 1.14 | -| 401 | NKE | 2022-12-02 | 111 | Put | 2.1 | 651 | 306 | 0 | 0.01 | -| 400 | NVDA | 2022-12-09 | 160 | Put | 2.1 | 8668 | 4059 | 1.06 | 1.08 | -| 425 | PG | 2022-12-09 | 149 | Put | 2.1 | 241 | 113 | 0.64 | 0.69 | - -### PCR - -Get up to ten years of historical Put-Call Ratios. - -```python -openbb.stocks.options.pcr(start_date = '2012-01-01', window = 10, symbol = 'SPY') -``` - -| Date | PCR | -|:--------------------|-------:| -| 2012-12-05 00:00:00 | 1.1815 | -| 2012-12-06 00:00:00 | 1.7403 | -| 2012-12-07 00:00:00 | 1.7023 | -| 2012-12-10 00:00:00 | 1.8997 | -| 2012-12-11 00:00:00 | 1.5384 | -| 2022-11-28 00:00:00 | 1.2491 | -| 2022-11-29 00:00:00 | 2.135 | -| 2022-11-30 00:00:00 | 1.5901 | -| 2022-12-01 00:00:00 | 0.9842 | -| 2022-12-02 00:00:00 | 2.1346 | - -### Chains - -Get the current option chain for a selected ticker. We support the following sources: YahooFinance, Nasdaq, -Tradier (Sandbox) and Intrinio. Note that each API returns slightly different data fields. - -```python -openbb.stocks.options.chains(symbol = 'SPY') -``` - -| | contractSymbol | optionType | expiration | strike | lastPrice | bid | ask | openInterest | volume | impliedVolatility | -|---:|:--------------------|:-------------|:-------------|---------:|------------:|-------:|-------:|---------------:|---------:|--------------------:| -| 0 | AAPL230210C00050000 | call | 2023-02-10 | 50 | 101.95 | 101.15 | 102.8 | 153 | 44 | 4.73438 | -| 1 | AAPL230210C00055000 | call | 2023-02-10 | 55 | 96.6 | 96.15 | 97.85 | 81 | 3 | 4.53125 | -| 2 | AAPL230210C00070000 | call | 2023-02-10 | 70 | 76.39 | 81.1 | 82.95 | 0 | 1 | 3.63281 | -| 3 | AAPL230210C00075000 | call | 2023-02-10 | 75 | 79.45 | 76.1 | 78.05 | 2 | 1 | 3.50781 | -| 4 | AAPL230210C00080000 | call | 2023-02-10 | 80 | 72.55 | 71.1 | 73.05 | 2 | 2 | 3.21094 | diff --git a/website/content/platform/usage/intros/stocks/stocks-screener.md b/website/content/platform/usage/intros/stocks/stocks-screener.md deleted file mode 100644 index ad300463e2c2..000000000000 --- a/website/content/platform/usage/intros/stocks/stocks-screener.md +++ /dev/null @@ -1,362 +0,0 @@ ---- -title: Stocks Screener -keywords: [screen, screener, stock, stocks, historical, overview, valuation, financial, ownership, performance, technical, view, set, preset, presets, ini, scan, compare, tickers, metrics, amex, nasdaq, nyse, default, description, how to, example] -description: This guide introduces the Stock Screener, within the context of the OpenBB Platform. ---- - -import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - - - -The Stocks Screener module imports the same screener found in the OpenBB Terminal. The screener utilizes presets (.ini files) to scan for stocks meeting the defined criteria. User-generated files are kept in the `stocks/screener` folder within the [OpenBBUserData](https://docs.openbb.co/platform/usage/guides/data) folder. - -This screener can find stocks on three exchanges: - -- AMEX -- NASDAQ -- NYSE - -The data returned is grouped into six categories: - -- Overview -- Financial -- Ownership -- Performance -- Technical -- Valuation - -The default preset is, `top_gainers`, and the default data type is, `overview`. Without the use of arguments, the screener will return results using those default values. - -```python -openbb.stocks.screener.screener_data() -``` - -This preset, like some of the others, contain no parameters other than a signal - the name of the preset - and has no corresponding file which can be edited. All signals are listed in the table below. - -| Preset and Signal Name | Description | -| :--------------------- | --------------------------------------------------------------------------: | -| top_gainers | stocks with the highest % price gain today | -| top_losers | stocks with the highest % price loss today | -| new_high | stocks making 52-week high today | -| new_low | stocks making 52-week low today | -| most_volatile | stocks with the highest widest high/low trading range today | -| most_active | stocks with the highest trading volume today | -| unusual_volume | stocks with unusually high volume today - the highest relative volume ratio | -| overbought | stock is becoming overvalued and may experience a pullback. | -| oversold | oversold stocks may represent a buying opportunity for investors | -| downgrades | stocks downgraded by analysts today | -| upgrades | stocks upgraded by analysts today | -| earnings_before | companies reporting earnings today, before market open | -| earnings_after | companies reporting earnings today, after market close | -| recent_insider_buying | stocks with recent insider buying activity | -| recent_insider_selling | stocks with recent insider selling activity | -| major_news | stocks with the highest news coverage today | -| horizontal_sr | horizontal channel of price range between support and resistance trendlines | -| tl_resistance | once a rising trendline is broken | -| tl_support | once a falling trendline is broken | -| wedge_up | upward trendline support and upward trendline resistance (reversal) | -| wedge_down | downward trendline support and downward trendline resistance (reversal) | -| wedge | upward trendline support, downward trendline resistance (contiunation) | -| triangle_ascending | upward trendline support and horizontal trendline resistance | -| triangle_descending | horizontal trendline support and downward trendline resistance | -| channel_up | both support and resistance trendlines slope upward | -| channel_down | both support and resistance trendlines slope downward | -| channel | both support and resistance trendlines are horizontal | -| double_top | stock with 'M' shape that indicates a bearish reversal in trend | -| double_bottom | stock with 'W' shape that indicates a bullish reversal in trend | -| multiple_top | same as double_top hitting more highs | -| multiple_bottom | same as double_bottom hitting more lows | -| head_shoulders | chart formation that predicts a bullish-to-bearish trend reversal | -| head_shoulders_inverse | chart formation that predicts a bearish-to-bullish trend reversal | - -These signals offer a good starting point, and results can be narrowed by creating a custom preset with defined parameters. - -## How to Use - -:::note - -Refer to the template file [here](https://github.com/OpenBB-finance/OpenBBTerminal/files/11153280/all_parameters.txt) for all of the available parameters and accepted values. - -All of the included presets can be viewed online [here](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/miscellaneous/stocks/screener) -::: - -Without any parameters, a screener preset file must contain the following at a minimum: - -```console -# Author of preset: -# Description: - -[General] - -[Descriptive] - -[Fundamental] - -[Technical] -``` - -Parameters should be added as required, and they all have pre-defined values; for example, Price/Free Cash Flow: - -```console -# Any, Low (<15), High (>50), Under 5, Under 10, Under 15, Under 20, Under 25, Under 30, Under 35, -# Under 40, Under 45, Under 50, Under 60, Under 70, Under 80, Under 90, Under 100, Over 5, Over 10, -# Over 15, Over 20, Over 25, Over 30, Over 35, Over 40, Over 45, Over 50, Over 60, Over 70, Over 80, -# Over 90, Over 100 - -Price/Free Cash Flow = Any -``` - -## Examples - -### List All Presets - -The name of each available preset and the local path to the file can be imported as a dictionary. - -```python -from openbb_terminal.stocks.screener.finviz_model import preset_choices - -preset choices -``` - -Print only the name of each preset as a list: - -```python -list(preset_choices) -``` - -### Creating a Preset - -To make a screener with only a few filters, it should look something like this: - -```console -# Author of preset: OpenBB -# Description: Platform Demo Screener - -[General] -Order = Relative Volume -Signal = Major News - -[Descriptive] -Average Volume = Over 500K -Price = Over $5 - -[Fundamental] -Price/Free Cash Flow = Low (<15) - -[Technical] -Beta = Under 1 -``` - -Copy the block above to a new text file in any editor, and save the file to the [OpenBBUserData](https://docs.openbb.co/platform/usage/guides/data) folder, naming it something like, `sdk_guide_preset.ini`. **This preset has also been included with the installation**. Declaring the path to the preset file, when located in the OpenBBUserData folder, is not required. The kernel must be restarted when a file is renamed or created; however, changes to the preset itself will be reflected immediately and without restarting. - -It is a good idea to test choices made before making it too complicated. Start with a handful of filters and modify, or add, them one-at-a-time. Let's pass what we have so far through the screener with `performance` selected as the `data_type`. - -### Performance - -```python -openbb.stocks.screener.screener_data(preset_loaded='sdk_guide_preset', data_type = 'performance') -``` - -| | Ticker | Perf Week | Perf Month | Perf Quart | Perf Half | Perf Year | Perf YTD | Volatility W | Volatility M | Recom | Avg Volume | Rel Volume | Price | Change | Volume | -| -: | :----- | --------: | ---------: | ---------: | --------: | --------: | -------: | -----------: | -----------: | ----: | ---------: | ---------: | -----: | ------: | ----------: | -| 0 | GEO | 0.1389 | 0.4005 | 0.4589 | 0.6723 | 0.3955 | 0.5342 | 0.0574 | 0.0558 | 2.5 | 2.09e+06 | 4.23 | 11.89 | 0.1623 | 8.86013e+06 | -| 1 | EBS | -0.0059 | -0.4513 | -0.5136 | -0.6429 | -0.7204 | -0.7292 | 0.0452 | 0.0827 | 2.7 | 753610 | 2.91 | 11.77 | 0.0138 | 2.19107e+06 | -| 2 | TME | 0.1871 | 0.7984 | 0.3721 | 0.5789 | -0.0531 | -0.0365 | 0.0681 | 0.0756 | 2.3 | 9.95e+06 | 2.2 | 6.6 | 0.0611 | 2.18486e+07 | -| 3 | QFIN | 0.0874 | 0.4331 | -0.0738 | -0.0744 | -0.389 | -0.365 | 0.0472 | 0.0787 | 1.4 | 997070 | 1.62 | 14.56 | 0.0849 | 1.61386e+06 | -| 4 | ATHM | 0.0229 | 0.0391 | -0.1772 | -0.2256 | -0.1971 | -0.0455 | 0.0492 | 0.0579 | 2.2 | 577050 | 1.6 | 28.14 | 0.0484 | 922812 | -| 93 | TGNA | 0.0093 | -0.0514 | -0.0882 | -0.1073 | -0.0528 | 0.0533 | 0.0133 | 0.0286 | 2.3 | 1.38e+06 | 0.45 | 19.55 | 0.0046 | 620767 | -| 94 | AMN | 0.0096 | -0.0365 | 0.1685 | 0.2591 | 0.0558 | -0.0026 | 0.0243 | 0.0464 | 1.7 | 607420 | 0.43 | 122.01 | -0.0078 | 264138 | -| 95 | MCY | -0.0028 | 0.2416 | 0.1165 | -0.2619 | -0.3014 | -0.3191 | 0.0206 | 0.0386 | 2 | 565130 | 0.43 | 36.13 | 0.0036 | 241950 | -| 96 | FIBK | -0.0138 | -0.0355 | 0.079 | 0.1411 | 0.0616 | 0.0681 | 0.0168 | 0.0206 | 2.2 | 596280 | 0.41 | 43.44 | -0.0044 | 243947 | -| 97 | BPOP | 0.0217 | 0.0126 | -0.0777 | -0.1245 | -0.1108 | -0.128 | 0.0158 | 0.0236 | 2 | 596460 | 0.4 | 71.54 | 0.0007 | 238605 | - -It found just under 100 tickers meeting the criteria. Let's dial down the beta value to see how many remain at less than 0.5. - -Change the one argument: - -```console -[Technical] -Beta = Under 0.5 -``` - -Running the exact same command as before trims down the list to only eleven. - -```python -openbb.stocks.screener.screener_data(preset_loaded='sdk_guide_preset', data_type = 'performance') -``` - -| | Ticker | Perf Week | Perf Month | Perf Quart | Perf Half | Perf Year | Perf YTD | Volatility W | Volatility M | Recom | Avg Volume | Rel Volume | Price | Change | Volume | -| -: | :----- | --------: | ---------: | ---------: | --------: | --------: | -------: | -----------: | -----------: | ----: | ---------: | ---------: | -----: | ------: | ----------: | -| 0 | QFIN | 0.0874 | 0.4331 | -0.0738 | -0.0744 | -0.389 | -0.365 | 0.0472 | 0.0787 | 1.4 | 997070 | 1.62 | 14.56 | 0.0849 | 1.61386e+06 | -| 1 | ATHM | 0.0229 | 0.0391 | -0.1772 | -0.2256 | -0.1971 | -0.0455 | 0.0492 | 0.0579 | 2.2 | 577050 | 1.6 | 28.14 | 0.0484 | 922812 | -| 2 | JD | 0.0143 | 0.4065 | -0.1343 | -0.0511 | -0.379 | -0.2209 | 0.029 | 0.0454 | 1.8 | 9.14e+06 | 1.47 | 53.25 | 0.0669 | 1.34395e+07 | -| 3 | NI | 0.0256 | 0.0518 | -0.0844 | -0.1342 | 0.0784 | -0.0138 | 0.0151 | 0.0257 | 1.9 | 4.61e+06 | 1.36 | 27.23 | 0.0004 | 6.2667e+06 | -| 4 | ZTO | 0.1176 | 0.3862 | -0.0572 | -0.1073 | -0.216 | -0.1393 | 0.0447 | 0.0437 | 1.7 | 3.21e+06 | 0.96 | 24.05 | 0.0217 | 3.06905e+06 | -| 5 | QDEL | -0.058 | -0.0614 | 0.077 | -0.1232 | -0.4438 | -0.3828 | 0.0335 | 0.0408 | 2.3 | 642680 | 0.79 | 83.32 | -0.018 | 508575 | -| 6 | ED | 0.0228 | 0.0888 | -0.0203 | -0.0298 | 0.1985 | 0.1287 | 0.0149 | 0.0202 | 3.5 | 1.73e+06 | 0.77 | 96.3 | -0.0025 | 1.3419e+06 | -| 7 | SFM | 0.027 | 0.1279 | 0.1656 | 0.237 | 0.237 | 0.129 | 0.0249 | 0.034 | 3.2 | 1.54e+06 | 0.74 | 33.51 | -0.0095 | 1.14442e+06 | -| 8 | PINC | 0.0244 | -0.0549 | -0.0635 | -0.1125 | -0.1377 | -0.1936 | 0.0158 | 0.0217 | 2.6 | 519290 | 0.72 | 33.2 | 0.0097 | 373171 | -| 9 | AEP | 0.0161 | 0.0587 | -0.066 | -0.0723 | 0.1361 | 0.0638 | 0.018 | 0.022 | 2.2 | 3.19e+06 | 0.64 | 94.65 | -0.006 | 2.04444e+06 | -| 10 | LRN | -0.0025 | 0.0796 | -0.0594 | -0.0846 | 0.0398 | 0.0741 | 0.0207 | 0.0288 | 1.4 | 587770 | 0.46 | 35.8 | -0.0047 | 270842 | -| 11 | AMN | 0.0096 | -0.0365 | 0.1685 | 0.2591 | 0.0558 | -0.0026 | 0.0243 | 0.0464 | 1.7 | 607420 | 0.43 | 122.01 | -0.0078 | 264138 | - -### Overview - -We know know that these eleven companies have a beta relative to the S&P of under 0.5, and that they all have a price-to-free-cashflow ratio under 15. The `signal` argument has also been set as `Major News`, so we know at least this much about the companies and their relative performance over the last year. Setting the `data_type` to 'overview', will fetch the data which helps us understand who these companies are. - -```python -openbb.stocks.screener.screener_data(preset_loaded='sdk_guide_preset', data_type = 'overview') -``` - -| | Ticker | Company | Sector | Industry | Country | Market Cap | P/E | Price | Change | Volume | -| -: | :----- | :------------------------------------ | :--------------------- | :----------------------------- | :------ | ---------: | -----: | -----: | ------: | ----------: | -| 0 | QFIN | 360 DigiTech, Inc. | Financial | Credit Services | China | 2.19e+09 | 3.73 | 14.56 | 0.0849 | 1.61386e+06 | -| 1 | ATHM | Autohome Inc. | Communication Services | Internet Content & Information | China | 3.49e+09 | 16.96 | 28.14 | 0.0484 | 922812 | -| 2 | JD | JD.com, Inc. | Consumer Cyclical | Internet Retail | China | 8.152e+10 | 300.85 | 53.25 | 0.0669 | 1.34395e+07 | -| 3 | NI | NiSource Inc. | Utilities | Utilities - Regulated Gas | USA | 1.09e+10 | 17.69 | 27.23 | 0.0004 | 6.2667e+06 | -| 4 | ZTO | ZTO Express (Cayman) Inc. | Industrials | Integrated Freight & Logistics | China | 1.947e+10 | 24.67 | 24.05 | 0.0217 | 3.06905e+06 | -| 5 | QDEL | QuidelOrtho Corporation | Healthcare | Diagnostics & Research | USA | 5.53e+09 | 4.96 | 83.32 | -0.018 | 508575 | -| 6 | ED | Consolidated Edison, Inc. | Utilities | Utilities - Regulated Electric | USA | 3.366e+10 | 20.21 | 96.3 | -0.0025 | 1.3419e+06 | -| 7 | SFM | Sprouts Farmers Market, Inc. | Consumer Defensive | Grocery Stores | USA | 3.57e+09 | 14.67 | 33.51 | -0.0095 | 1.14442e+06 | -| 8 | PINC | Premier, Inc. | Healthcare | Health Information Services | USA | 3.92e+09 | 21.52 | 33.2 | 0.0097 | 373171 | -| 9 | AEP | American Electric Power Company, Inc. | Utilities | Utilities - Regulated Electric | USA | 4.791e+10 | 19.63 | 94.65 | -0.006 | 2.04444e+06 | -| 10 | LRN | Stride, Inc. | Consumer Defensive | Education & Training Services | USA | 1.54e+09 | 16.74 | 35.8 | -0.0047 | 270842 | -| 11 | AMN | AMN Healthcare Services, Inc. | Healthcare | Medical Care Facilities | USA | 5.4e+09 | 11.76 | 122.01 | -0.0078 | 264138 | - -### Ownership - -When `data_type = 'ownership'`, data presented are statistics for the general float, insider, institutional, and the short ratio. - -```python -openbb.stocks.screener.screener_data(preset_loaded='sdk_guide_preset', data_type = 'ownership') -``` - -| | Ticker | Market Cap | Outstanding | Float | Insider Own | Insider Trans | Inst Own | Inst Trans | Float Short | Short Ratio | Avg Volume | Price | Change | Volume | -| -: | :----- | ---------: | ----------: | ---------: | ----------: | ------------: | -------: | ---------: | ----------: | ----------: | ---------: | -----: | ------: | ----------: | -| 0 | QFIN | 2.19e+09 | 1.5624e+08 | 1.2743e+08 | 0.0654 | 0 | 0.691 | 0.0034 | 0.0226 | 2.89 | 997070 | 14.56 | 0.0849 | 1.61386e+06 | -| 1 | ATHM | 3.49e+09 | 1.246e+08 | 6.846e+07 | nan | nan | 0.513 | -0.0397 | 0.0213 | 2.53 | 577050 | 28.14 | 0.0484 | 922812 | -| 2 | JD | 8.152e+10 | 1.56e+09 | 1.26e+09 | 0.049 | 0 | 0.161 | -0.1149 | 0.0136 | 1.88 | 9.14e+06 | 53.25 | 0.0669 | 1.34395e+07 | -| 3 | NI | 1.09e+10 | 4.065e+08 | 4.0459e+08 | 0.001 | 0 | 0.948 | -0.0254 | 0.0345 | 3.04 | 4.61e+06 | 27.23 | 0.0004 | 6.2667e+06 | -| 4 | ZTO | 1.947e+10 | 8.0973e+08 | 6.4491e+08 | 0.0071 | 0 | 0.315 | 0.0345 | 0.0241 | 4.83 | 3.21e+06 | 24.05 | 0.0217 | 3.06905e+06 | -| 5 | QDEL | 5.53e+09 | 6.69e+07 | 6.092e+07 | 0.011 | 0 | 0.973 | 0.0058 | 0.0515 | 4.88 | 642680 | 83.32 | -0.018 | 508575 | -| 6 | ED | 3.366e+10 | 3.546e+08 | 3.5443e+08 | 0.001 | 0.0056 | 0.684 | 0.0082 | 0.0206 | 4.22 | 1.73e+06 | 96.3 | -0.0025 | 1.3419e+06 | -| 7 | SFM | 3.57e+09 | 1.0723e+08 | 1.0362e+08 | 0.008 | -0.1276 | nan | -0.0287 | 0.1386 | 9.31 | 1.54e+06 | 33.51 | -0.0095 | 1.14442e+06 | -| 8 | PINC | 3.92e+09 | 1.1835e+08 | 1.1817e+08 | 0.008 | 0 | 0.707 | -0.0044 | 0.0136 | 3.1 | 519290 | 33.2 | 0.0097 | 373171 | -| 9 | AEP | 4.791e+10 | 5.1373e+08 | 5.137e+08 | 0.0003 | -0.0336 | 0.758 | 0.0033 | 0.0129 | 2.07 | 3.19e+06 | 94.65 | -0.006 | 2.04444e+06 | -| 10 | LRN | 1.54e+09 | 4.208e+07 | 4.082e+07 | 0.04 | 0 | nan | 0.0158 | 0.0808 | 5.61 | 587770 | 35.8 | -0.0047 | 270842 | -| 11 | AMN | 5.4e+09 | 4.378e+07 | 4.299e+07 | 0.003 | -0.0868 | nan | 0.0148 | 0.0983 | 6.96 | 607420 | 122.01 | -0.0078 | 264138 | - -### Technical - -With `data_type` set to `technical`, aspects of technical analysis is returned. - -```python -openbb.stocks.screener.screener_data(preset_loaded='sdk_guide_preset', data_type = 'technical') -``` - -| | Ticker | Beta | ATR | SMA20 | SMA50 | SMA200 | 52W High | 52W Low | RSI | Price | Change | from Open | Gap | Volume | -| -: | :----- | ----: | ---: | ------: | ------: | ------: | -------: | ------: | ----: | -----: | ------: | --------: | ------: | ----------: | -| 0 | QFIN | 0.37 | 1.11 | 0.1061 | 0.1107 | -0.0206 | -0.3953 | 0.5375 | 56.6 | 14.56 | 0.0849 | 0.0341 | 0.0492 | 1.61386e+06 | -| 1 | ATHM | 0.19 | 1.89 | -0.0324 | -0.0405 | -0.1047 | -0.3118 | 0.3734 | 47.13 | 28.14 | 0.0484 | 0.0057 | 0.0425 | 922812 | -| 2 | JD | 0.39 | 3.3 | 0.1141 | 0.1183 | -0.0584 | -0.386 | 0.6054 | 58.07 | 53.25 | 0.0669 | -0.0039 | 0.0711 | 1.34395e+07 | -| 3 | NI | 0.44 | 0.62 | 0.049 | 0.0498 | -0.0598 | -0.1643 | 0.1451 | 61.62 | 27.23 | 0.0004 | 0.0052 | -0.0048 | 6.2667e+06 | -| 4 | ZTO | -0.09 | 1.14 | 0.1724 | 0.0968 | -0.0412 | -0.2565 | 0.4782 | 65.44 | 24.05 | 0.0217 | 0.0021 | 0.0195 | 3.06905e+06 | -| 5 | QDEL | 0.29 | 3.46 | -0.0666 | 0.0262 | -0.1185 | -0.5373 | 0.2458 | 42.18 | 83.32 | -0.018 | -0.018 | 0 | 508575 | -| 6 | ED | 0.32 | 1.83 | 0.0574 | 0.0843 | 0.0365 | -0.0578 | 0.2426 | 66.88 | 96.3 | -0.0025 | 0.002 | -0.0045 | 1.3419e+06 | -| 7 | SFM | 0.41 | 1.12 | 0.0584 | 0.1446 | 0.1605 | -0.0518 | 0.4854 | 63.99 | 33.51 | -0.0095 | -0.0053 | -0.0041 | 1.14442e+06 | -| 8 | PINC | 0.36 | 0.7 | 0.0322 | -0.0004 | -0.0711 | -0.2042 | 0.0773 | 55.19 | 33.2 | 0.0097 | 0.0125 | -0.0027 | 373171 | -| 9 | AEP | 0.41 | 2.07 | 0.0456 | 0.0559 | -0.0117 | -0.1037 | 0.1799 | 61.62 | 94.65 | -0.006 | 0.0005 | -0.0065 | 2.04444e+06 | -| 10 | LRN | 0.25 | 1.36 | 0.0302 | -0.0923 | -0.0562 | -0.2439 | 0.3957 | 44.85 | 35.8 | -0.0047 | -0.0014 | -0.0033 | 270842 | -| 11 | AMN | 0.3 | 4.85 | 0.011 | 0.0599 | 0.1431 | -0.0551 | 0.4744 | 54.13 | 122.01 | -0.0078 | -0.0059 | -0.0019 | 264138 | - -### Valuation - -Lastly, `valuation` gets the basic fundamental ratios. - -| | Ticker | Price | Change | Volume | Market Cap | P/E | Fwd P/E | PEG | P/S | P/B | P/C | P/FCF | EPS this Y | EPS next Y | EPS past 5Y | EPS next 5Y | Sales past 5Y | -| -----------: | :----- | -----: | ------: | -------: | ----------: | ----: | ------: | ---: | ---: | ----: | :---- | :---- | ---------: | ---------: | ----------: | ----------: | :------------ | -| 0 | AAPL | 141.17 | -0.0211 | 83578852 | 2.23252e+12 | 23.14 | 20.74 | 2.6 | 5.66 | 44.67 | 46.22 | 23.11 | 0.089 | 0.0898 | 0.216 | 0.0889 | 0.115 | -| 1 | MSFT | 240.33 | -0.0059 | 17929705 | 1.77308e+12 | 25.9 | 21.49 | 1.99 | 8.73 | 10.32 | 16.53 | 39.59 | 0.198 | 0.1709 | 0.243 | 0.1301 | 0.155 | -| 2 | GOOG | 95.44 | -0.0084 | 20145081 | 1.23434e+12 | 18.68 | 18.04 | 2.09 | 4.38 | 4.88 | N/A | N/A | -0.159 | 0.121 | 0.2848 | 0.0895 | N/A | -| 3 | GOOGL | 95.19 | -0.009 | 20047848 | 1.21605e+12 | 19.51 | 18.12 | 2.18 | 4.31 | 4.89 | 10.46 | 19.44 | 0.914 | 0.1139 | 0.321 | 0.0895 | 0.233 | -| 4 | AMZN | 92.42 | -0.0163 | 65245723 | 9.3352e+11 | 85.26 | 55.08 | 3.28 | 1.86 | 6.85 | 15.91 | N/A | 0.549 | 0.8239 | 0.676 | 0.26 | 0.281 | -| ...continued | | | | | | | | | | | | | | | | | | - -Combined, the five DataFrames provide an outline of who they are, which segment of the market they belong to, and how they are currently trading. - -### Unconventional Applications - -One way to use the screener is to feed it the least amount of variables possible. In this next example, the preset file contains only one filter; requesting data for all constituents of the S&P 500 Index. - -```console -# Author of preset: OpenBB -# Description: S&P Index - -[General] -Order = Market Cap. - -[Descriptive] -Index = S&P 500 - -[Fundamental] - -[Technical] -``` - -Copy and past the block above into any text editor; then save the file, as `sp500_filter.ini`, to the `~/OpenBBUserData/presets/stocks/screener` folder. The sample code below combines all five DataFrames for the entire S&P 500 into one, fifty-column, DataFrame. **It will likely take over two-minutes to collect the data.** - -```python -from openbb_terminal.sdk import openbb -import pandas as pd - -sp500_overview = openbb.stocks.screener.screener_data(preset_loaded='sp500_filter', data_type = 'overview') -sp500_ownership = openbb.stocks.screener.screener_data(preset_loaded='sp500_filter', data_type = 'ownership') -sp500_performance = openbb.stocks.screener.screener_data(preset_loaded='sp500_filter', data_type = 'performance') -sp500_technical = openbb.stocks.screener.screener_data(preset_loaded='sp500_filter', data_type = 'technical') -sp500_valuation = openbb.stocks.screener.screener_data(preset_loaded='sp500_filter', data_type = 'valuation') - -sp500_overview = sp500_overview.convert_dtypes() -sp500_ownership = sp500_ownership.convert_dtypes() -sp500_performance = sp500_performance.convert_dtypes() -sp500_technical = sp500_technical.convert_dtypes() -sp500_valuation = sp500_valuation.convert_dtypes() - -sp500_overview.drop(columns = ['P/E'], inplace = True) -sp500_overview.set_index(keys = ['Ticker', 'Price', 'Change', 'Volume'], inplace = True) -sp500_performance.drop(columns = ['Avg Volume', 'Price', 'Change', 'Volume'], inplace = True) -sp500_performance.set_index(keys = ['Ticker'], inplace = True) -sp500_ownership.drop(columns = ['Price', 'Change', 'Volume', 'Market Cap'], inplace = True) -sp500_ownership.set_index(keys = ['Ticker'], inplace = True) -sp500_technical.drop(columns = ['Price', 'Change', 'Volume'], inplace = True) -sp500_technical.set_index(keys = ['Ticker'], inplace = True) -sp500_valuation.drop(columns = ['Price', 'Change', 'Volume', 'Market Cap'], inplace = True) -sp500_valuation.set_index(keys = ['Ticker'], inplace = True) - -sp500_df = sp500_overview.join(sp500_valuation) -sp500_df = sp500_df.join(sp500_ownership) -sp500_df = sp500_df.join(sp500_performance) -sp500_df = sp500_df.join(sp500_technical) - -sp500_df.reset_index(inplace = True) - -sp500_df -``` - -A summary of the output: - -```console - Ticker Price Change Volume ... 52W Low RSI from Open Gap -0 AAPL 141.17 -0.0211 83578852 ... 0.094 42.47 -0.0211 0.0 -1 MSFT 240.33 -0.0059 17929705 ... 0.126 50.94 -0.0044 -0.0015 -2 GOOG 95.44 -0.0084 20145081 ... 0.1437 48.17 -0.0052 -0.0032 -3 GOOGL 95.19 -0.009 20047848 ... 0.1422 48.24 -0.0063 -0.0027 -4 AMZN 92.42 -0.0163 65245723 ... 0.0763 38.54 -0.0167 0.0004 -.. ... ... ... ... ... ... ... ... ... -498 LUMN 5.47 -0.0091 31885469 ... 0.0018 30.19 -0.0036 -0.0054 -499 PENN 34.07 0.0119 1689121 ... 0.3366 50.3 0.0068 0.005 -500 NWL 12.87 -0.0191 5725896 ... 0.051 40.29 -0.01 -0.0091 -501 VNO 25.31 0.0218 2560781 ... 0.2636 59.59 0.0181 0.0036 -502 PVH 64.88 0.0399 1100532 ... 0.4918 66.83 0.0328 0.0069 - -[503 rows x 50 columns] -``` diff --git a/website/content/platform/usage/intros/stocks/trading-hours.md b/website/content/platform/usage/intros/stocks/trading-hours.md deleted file mode 100644 index 1a083fcd409b..000000000000 --- a/website/content/platform/usage/intros/stocks/trading-hours.md +++ /dev/null @@ -1,86 +0,0 @@ ---- -title: Trading Hours -keywords: [markets, trading, hours, stocks, time, global, world, location, open, close, exchange, how to, usage, examples] -description: An Introduction to the Trading Hours menu, within the Stocks menu. This set of features displays the status of international markets. ---- - -import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - - - -The Trading Hours sub-module is a set of functions for checking the status and hours of operation for markets globally. - -## How to Use - -There are only a handful of commands in the set, and they are listed below with a short description. - -|Path |Description | -|:-----|----------:| -|openbb.stocks.th.open | Which Exchanges are Currently Open | -|openbb.stocks.th.all | All Exchanges and Their Status | -|openbb.stocks.th.exchange | Details for Individual Exchanges | -|openbb.stocks.th.closed | List of Closed Exchanges | - -Alternatively, print the contents sub-module by entering: - -```python -help(openbb.stocks.th) -``` - -## Examples - -### All - -Get a list of global exchanges and their current status. - -```python -openbb.stocks.th.all() -``` - -| | name | short_name | open | -|:----|:-----------------------|:-------------|:-------| -| SHZ | Shenzen Stock Exchange | SHZE | False | -| KSC | Korea Exchange | KRX | False | -| KOE | Korea Exchange | KRX | False | -| CAI | The Egyptian Exchange | CA | False | -| PCX | NYSE Arca | ARCA | False | -| SAT | Nasdaq OMX Stockholm | ST | False | - -### Open - -See which exchanges are open right now. - -```python -openbb.stocks.th.open() -``` - -| | name | short_name | -|:----|:----------------------------------|:-------------| -| CNQ | Canadian Securities Exchange: CSE | CN | -| NZE | NZX | NZ | -| MCX | MOEX | ME | - -### Exchange - -Get the schedule of an individual exchange. - -```python -openbb.stocks.th.exchange('CNQ') -``` - -| | CNQ | -|:----------------------|:----------------------------------------------------------------------------------------| -| name | Canadian Securities Exchange: CSE | -| short_name | CN | -| website | https://www.thecse.com/en/trading/trading-rules-and-links/trading-rules-and-regulations | -| market_open | 08:00:00 | -| market_close | 18:00:00 | -| lunchbreak_start | | -| lunchbreak_end | | -| opening_auction_start | | -| opening_auction_end | | -| closing_auction_start | | -| closing_auction_end | | -| timezone | Canada/Eastern | -| flag | 🇨🇦 | -| open | True | diff --git a/website/content/platform/usage/intros/ta.md b/website/content/platform/usage/intros/ta.md deleted file mode 100644 index 541213f5a266..000000000000 --- a/website/content/platform/usage/intros/ta.md +++ /dev/null @@ -1,194 +0,0 @@ ---- -title: Technical Analysis -keywords: [technical, analysis, ta, t/a, intraday, daily, indicators, signals, average, moving, exponential, rsi, fibonacci, retracement, bollinger, heltner, accumulation, distribution, obv, on-balance, volume, volatility, trend, momentum, overlap, crypto, stocks, funds, etf, etfs, how to, examples, usage, function, _chart, import statement, moving average, average true range, donchian] -description: This guide introduces the Technical Analysis menu, which is common across many sections of the OpenBB Terminal. ---- - -import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - - - -The Technical Analysis module is a toolkit for analyzing time-series data, at any resolution. The functions are a collection of formulas that fit into broad categories, and they are mostly derived from the pandas_ta library: - -- Momentum -- Overlap (Moving Averages) -- Trend -- Volatility -- Volume -- Other (Fibonacci) - -## How to Use - -Every Platform function also has a secondary `_chart` command. The table below is a brief description of each Platform function within the `ta` module; for simplicity, `_chart` has been omitted. Technical Analysis functions specific to stocks are included as a sub-module, `openbb.stocks.ta`. - -| Path | Category | Description | -| :----------------- | :--------: | ---------------------------------------------: | -| openbb.ta.ad | Volume | Accumulation/Distribution Line | -| openbb.ta.adosc | Volume | Chaikin Oscillator | -| openbb.ta.adx | Trend | Average Directional Movement Index | -| openbb.ta.aroon | Trend | Aroon Indicator | -| openbb.ta.atr | Volatility | Average True Range | -| openbb.ta.bbands | Voaltility | Bollinger Bands | -| openbb.ta.cci | Momentum | Commodity Channel Index | -| openbb.ta.cg | Momentum | Center of Gravity | -| openbb.ta.clenow | Momentum | Clenow Volatility Adjusted Momentum | -| openbb.ta.demark | Momentum | Tom Demark's Sequential Indicator (Unofficial) | -| openbb.ta.donchian | Volatility | Donchian Channels | -| openbb.ta.ema | Overlap | Exponential Moving Average | -| openbb.ta.fib | Other | Fibonacci Retracement | -| openbb.ta.fisher | Momentum | Fisher Transform | -| openbb.ta.hma | Overlap | Hull Moving Average | -| openbb.ta.kc | Volatility | Keltner Channels | -| openbb.ta.ma | Overlap | Moving Averages (For Charting) | -| openbb.ta.macd | Momentum | Moving Average Convergence/Divergence | -| openbb.ta.obv | Volume | On-Balance Volume | -| openbb.ta.rsi | Momentum | Relative Strength Index | -| openbb.ta.sma | Overlap | Simple Moving Average | -| openbb.ta.stoch | Momentum | Stochastic Oscillator | -| openbb.ta.vwap | Overlap | Volume-Weighted Average Price | -| openbb.ta.wma | Overlap | Weighted Moving Average | -| openbb.ta.zlma | Overlap | Zero-Lag Moving Average | - -The syntax for the data argument can be: - -- `data = ohlcv_df` - - Where functions only require a single column, `data = ohlcv_df['Adj Close']` - -- `data = openbb.stocks.load("ticker")` - - Target intraday by adding the `interval` argument to the `load` syntax. - -Best practice is to deploy the first method because the latter will work only with the commands requiring OHLC+V data as inputs. An error message will be returned if this is the case. - -```python -openbb.ta.obv(data = openbb.stocks.load('QQQ')) -``` - -| date | OBV | -| :------------------ | -----------: | -| 2019-11-15 00:00:00 | 1.84279e+07 | -| 2019-11-18 00:00:00 | 3.67938e+07 | -| 2019-11-19 00:00:00 | 5.37171e+07 | -| 2019-11-20 00:00:00 | 1.70881e+07 | -| 2022-11-15 00:00:00 | -1.09017e+08 | -| 2022-11-16 00:00:00 | -1.57876e+08 | -| 2022-11-17 00:00:00 | -2.13339e+08 | -| 2022-11-18 00:00:00 | -1.59987e+08 | - -The error message: - -```python -openbb.ta.rsi(data = openbb.stocks.load('QQQ')) -``` - -```console -Please send a series and not a DataFrame. -``` - -### _chart - -To display the chart, instead of raw data, add `_chart` to the syntax before the (`arguments`). - -```python -openbb.ta.obv_chart(data= openbb.stocks.load('QQQ', start_date = '2022-11-18', interval = 5, prepost = True)) -``` - -![openbb.ta.obv_chart](https://user-images.githubusercontent.com/85772166/202889106-4caa882b-5e29-41a8-8cd2-b2a2a01d1fca.png "openbb.ta.obv_chart") - -## Examples - -### Import Statements - -The examples here assume that this code block is at the top of the Python script of Notebook file: - -```python -import pandas as pd -from openbb_terminal.sdk import openbb -# %matplotlib inline (uncomment for Jupyter environments) -``` - -### MA (Moving Averages) - -The different types of moving averages, which also are individual functions (e.g., `openbb.ta.ema`), are available as an argument (`ma_type`) to the `ma` command. There are five accepted arguments, they are listed below in brackets: - -- Simple (SMA) -- Exponential (EMA) -- Hull (HMA) -- Weighted (WMA) -- Zero-Lag (ZLMA) - -The `window` argument anticipates a list of integers representing the interval (minutes, days, weeks, months, etc.) to measure against the timestamp of the DataFrame's index. The example below is a daily timeseries of S&P E-Mini Futures: - -```python -es = openbb.stocks.load("ES=F") - -openbb.ta.ma_chart( - data = es['Adj Close'], - symbol = 'E-Mini S&P Futures', - ma_type = 'SMA', - window = [21, 150]) -``` - -![openbb.ta.ma_chart](https://user-images.githubusercontent.com/85772166/202889200-c6a3e895-f49d-4348-8635-68dd1456340d.png "openbb.ta.ma_chart") - -Changing, `ma_type`, to, `ZLMA`: - -![openbb.ta.ma_chart](https://user-images.githubusercontent.com/85772166/202889214-359d5d37-f8c0-49e0-9dd9-70afe970ae5f.png "openbb.ta.ma_chart") - -### ATR (Average True Range) - -The `atr` command requires OHLC data, the data argument can be the `load` function. - -```python -ticker = 'ES=F' -start = '2000-01-01' - -df_atr = openbb.ta.atr(data = openbb.stocks.load(f"{ticker}", start_date = f"{start}", monthly = True), window = 6) - -df_atr.tail(5) -``` - -| date | ATRe_6 | -| :------------------ | ------: | -| 2022-07-01 00:00:00 | 454.457 | -| 2022-08-01 00:00:00 | 431.612 | -| 2022-09-01 00:00:00 | 469.08 | -| 2022-10-01 00:00:00 | 455.7 | -| 2022-11-01 00:00:00 | 424.5 | - -### Donchian - -To use the same data for multiple functions, it is more efficient to first load to a Pandas DataFrame: - -```python -ticker = 'ES=F' -start = '2000-01-01' -data_df: pd.DataFrame = openbb.stocks.load(f"{ticker}", start_date = f"{start}", monthly = True) - -openbb.ta.donchian_chart(data_df) -``` - -![openbb.ta.donchian_chart](https://user-images.githubusercontent.com/85772166/202889227-a985d788-a320-4193-af96-0357afe9a11d.png "openbb.ta.donchian_chart") - -The output from a function can be joined to the OHLC data: - -```python -ticker = 'ES=F' -start = '2000-01-01' -data_df: pd.DataFrame = openbb.stocks.load(f"{ticker}", start_date = f"{start}", monthly = True) - -donchian = openbb.ta.donchian(data_df) - -data_df = data_df.join(donchian) - -data_df.tail(5) -``` - -| date | Open | High | Low | Close | Adj Close | Volume | DCL_20_20 | DCM_20_20 | DCU_20_20 | -| :------------------ | ------: | ------: | ------: | -----: | --------: | ----------: | --------: | --------: | --------: | -| 2022-07-01 00:00:00 | 3782 | 4144 | 3723.75 | 4133.5 | 4133.5 | 3.40941e+07 | 3198 | 4003.12 | 4808.25 | -| 2022-08-01 00:00:00 | 4137.5 | 4327.5 | 3953 | 3956.5 | 3956.5 | 3.84732e+07 | 3225 | 4016.62 | 4808.25 | -| 2022-09-01 00:00:00 | 3958 | 4158 | 3595.25 | 3601.5 | 3601.5 | 4.68698e+07 | 3595.25 | 4201.75 | 4808.25 | -| 2022-10-01 00:00:00 | 3593.25 | 3924.25 | 3502 | 3883 | 3883 | 4.80686e+07 | 3502 | 4155.12 | 4808.25 | -| 2022-11-01 00:00:00 | 3884 | 4050.75 | 3704.25 | 3974 | 3974 | 2.65215e+07 | 3502 | 4155.12 | 4808.25 | diff --git a/website/content/platform/usage/overview.md b/website/content/platform/usage/overview.md new file mode 100644 index 000000000000..30049d1583d7 --- /dev/null +++ b/website/content/platform/usage/overview.md @@ -0,0 +1,344 @@ +--- +title: Overview +sidebar_position: 1 +description: Information about OpenBB Platform's Python client and Fast API; details + on authorization, data providers, settings, responses, commands, logging, and features + such as dynamic command execution. +keywords: +- OpenBB Platform +- Python client +- Fast API +- authorization +- data providers +- OpenBB Hub +- local environment +- environment variables +- user settings +- command execution +- API response +- logging +- proxy networks +- data cleaning +- technical analysis +- quantitative analysis +- charting libraries +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +At its base, the OpenBB Platform supplies core architecture and services for connecting data providers and extensions, consumable as a Python client and Fast API. The extension framework provides interoperability between as many, or few, services required. Optional extras are not included with the base installation, and these include: + +- Charting libraries and views +- Data cleaning +- Technical/Quantitative Analysis +- Community data providers +- CLI Terminal + +## Authorization + +By default, authorization is not required to initialize and use the core services. Most data providers, however, require an API key to access their data. They can be stored locally, or securely on the OpenBB Hub for convenient remote access. Refer to our Developer Guidelines for best practices within a production environment. + +### OpenBB Hub + +Data provider credentials and user preferences can be securely stored on the OpenBB Hub and accessed via a revokable Personal Access Token (PAT). Login to the [Hub](https://my.openbb.co/) to manage this method of remote authorization. + +#### Python Client + +The OpenBB Hub is a convenient solution for accessing data in temporary environments, like Google Colab. Login using the Python client with: + +```jupyterpython +from openbb import obb + +# Login with personal access token +obb.account.login(pat="your_pat", remember_me=True) + +# Login with email and password +obb.account.login(email="your_email", password="your_password", remember_me=True) + +# Change a credential +obb.user.credentials.polygon_api_key = "new_key" + +# Save account changes +obb.account.save() + +# Refresh account with latest changes +obb.account.refresh() + +# Logout +obb.account.logout() +``` + +Set `remember_me` as `False` to discard all credentials at the end of the session. + +### Fast API + +Activate the Python environment and then start the server from a Terminal command line with: + +```console +uvicorn openbb_core.api.rest_api:app +``` + +To use the Fast API documentation page, navigate to [http://127.0.0.1:8000/docs](http://127.0.0.1:8000/docs). By default, no authorization is required. Basic authorization can be enabled with environment variables. In the home folder, along with `user_settings.json`, create a new file, `.env`, if it does not yet exist. + +```.env +OPENBB_API_AUTH="True" +OPENBB_API_USERNAME="some_user" +OPENBB_API_PASSWORD="some_pass" +``` + +The application will expect a header that contains username and password in the form of `Basic `, where "username:password" is encoded in Base64. Pass this in every request to the API inside the headers "Authorization" field. + +```python +import base64 +import requests + +msg = "some_user:some_pass" +msg_bytes = msg.encode('ascii') +base64_bytes = base64.b64encode(msg_bytes) +base64_msg = base64_bytes.decode('ascii') + + +symbol="SPY" +url = f"http://127.0.0.1:8000/api/v1/stocks/quote?provider=intrinio&symbol={symbol}&source=intrinio_mx" +headers = {"accept": "application/json", "Authorization": f"Basic {base64_msg}"} + +response = requests.get(url=url, headers=headers) + +response.json() +``` + +Refer to the Developer Guidelines for custom authorization procedures. + +### Local Environment + +Credentials and user preferences are stored locally, `~/.openbb_platform/`, as a JSON file, `user_settings.json`. It is read upon initializing the Python client, or when the Fast API is authorized. If the file does not exist, create it with any text editor. The schema below can be copy/pasted if required, providers not listed here are added using the same format: + +```json +{ + "credentials": { + "fmp_api_key": "REPLACE", + "polygon_api_key": "REPLACE", + "benzinga_api_key": "REPLACE", + "fred_api_key": "REPLACE", + "quandl_api_key": "REPLACE", + "intrinio_api_key": "REPLACE", + "alpha_vantage_api_key": "REPLACE", + } +} +``` + +To set keys from the Python client for the current session only, access the Credentials class: + +```python +obb.user.credentials.intrinio_api_key = "REPLACE_WITH_KEY" +``` + +## Environment Variables + +Environment variables are defined in a `.env` file. If this file does not exist, create it inside the same folder `user_settings.json` is located. + +- `OPENBB_DEBUG_MODE`: enables verbosity while running the program +- `OPENBB_DEVELOP_MODE`: points hub service to .co or .dev +- `OPENBB_AUTO_BUILD`: enables automatic SDK package build on import +- `OPENBB_CHARTING_EXTENSION`: specifies which charting extension to use +- `OPENBB_API_AUTH_EXTENSION`: specifies which authentication extension to use +- `OPENBB_API_AUTH`: enables API authentication for command endpoints +- `OPENBB_API_USERNAME`: sets API username +- `OPENBB_API_PASSWORD`: sets API password + +Variables can be defined for current session only. + +```python +import os +os.environ["OPENBB_DEBUG_MODE"] = "True" +from openbb import obb +``` + +### Proxy Networks + +An environment variable can be set, in the `.env` file, to direct the Requests library to a specific address and port. + +```env +HTTP_PROXY="
" or HTTPS_PROXY="
” +``` + +For example: + +```env +HTTP_PROXY="http://10.10.10.10:8000" +``` + +## User Settings + +User settings can be set from the Python interface directly. + +```python +from openbb import obb + +obb.user.profile +obb.user.credentials +obb.user.preferences +obb.user.defaults +``` + +Notably, `obb.user.defaults`, defines default providers for any command. They are stored in the `user_settings.json` file, under `routes`. + +```json +{ + "credentials": { + "benzinga_api_key": null, + "fmp_api_key": null, + "polygon_api_key": null, + "fred_api_key": null + }, + "defaults": { + "routes": { + "/stocks/fa/balance": { + "provider": "polygon" + }, + "/stocks/load": { + "provider": "fmp" + }, + "/stocks/news": { + "provider": "benzinga" + } + } + }, + { + "data_directory": "~/.openbb_platform", // Where to store data + "export_directory": "~/.openbb_platform/exports", // Where to store exports + "user_styles_directory": "~/.openbb_platform/styles/user", // Where to store user styles + "charting_extension": "openbb_charting", // Charting extension to use + "chart_style": "dark", // Chart style to use (dark or light) + "plot_enable_pywry": true, // Whether to enable PyWry + "plot_pywry_width": 1400, // PyWry width + "plot_pywry_height": 762, // PyWry height + "plot_open_export": false, // Whether to open plot image exports after they are created + "table_style": "dark", // Table style to use (dark or light) + "request_timeout": 15, // Request timeout + "metadata": true, // Whether to include metadata in the output + "output_type": "OBBject" // Our default output type (OBBject, dataframe, polars, numpy, dict, chart) + } +} +``` + +## Basic Response + +The output of every command is an object which contains the results of the request, along with additional information. It is a custom class, `OBBject`, and always returns with the fields listed below: + +```console +id: ... # UUID Tag +results: ... # Serializable results. +provider: ... # Provider name. +warnings: ... # List of warnings. +chart: ... # Chart object. +extra: ... # Extra info. +``` + +```python +from openbb import obb + +data = obb.stocks.load("SPY", provider="polygon") + +data +``` + +```console +OBBject + +id: 06520558-d54a-7e53-8000-7aafc8a42694 +results: [{'date': datetime.datetime(2022, 10, 5, 0, 0), 'open': 375.62, 'high': 37... +provider: polygon +warnings: None +chart: None +extra: {'metadata': {'arguments': {'provider_choices': {'provider': 'polygon'}, 'st... +``` + +Additional class methods are helpers for converting the results to a variety of formats. + +- `to_dict()`: converts to a dictionary of lists. +- `to_df()` / `to_dataframe()`: converts to a Pandas DataFrame. +- `to_numpy()`: converts to a Numpy array. +- `to_polars()`: converts to a Polars table. + +The output from the Fast API is a serialized version of this object, and these methods are lost on conversion. OBBject can be reconstructed to recover the helpers by importing the model and validating the data. + +```python +import requests +from openbb_core.app.model.obbject import OBBject + +data = [] +symbol="SPY" +url = f"http://127.0.0.1:8000/api/v1/stocks/load?provider=polygon&symbol={symbol}" +headers = {"accept": "application/json"} + +response = requests.get(url, headers=headers, timeout=3) + +if response.status_code == 200: + data = OBBject.model_validate(response.json()) + +data.to_df() +``` + +## Dynamic Command Execution + +Dynamic execution provides an alternate entry point to functions. This method requires formatting the query as demonstrated below. + +```python +from openbb_core.app.command_runner import CommandRunner +runner = CommandRunner() +output = runner.run( + "/stocks/fa/ratios", + provider_choices={ + "provider": "fmp", + }, + standard_params={ + "symbol" : "TSLA", + "period" : "quarter", + }, + extra_params={} +) +``` + +```console +>>> output +OBBject + +id: 065241b7-bd9d-7313-8000-9406d8afab75 +results: [{'symbol': 'TSLA', 'date': '2023-06-30', 'period': 'Q2', 'current_ratio':... +provider: fmp +warnings: None +chart: None +extra: {'metadata': {'arguments': {'provider_choices': {'provider': 'fmp'}, 'standa... +``` + +## Commands and Provider Coverage + +The installed commands and data providers are found under, `obb.coverage`. + +```python +obb.coverage +``` + +```console +/coverage + providers + commands +``` + +`obb.coverage.providers` is a dictionary of the installed provider extensions, each with its own list of available commands. + +`obb.coverage.commands` is a dictionary of commands, each with its own list of available providers for the data. + +## Logging Out + +Logging out and saving changes to preferences is done in the account module. + +```python +obb.account.save() +obb.account.logout() +``` + +Any saved changes will be pulled to a new session after logging in. If `remember_me=False`, ending the Python session will be an equivalent to logging out. diff --git a/website/content/pro/_category_.json b/website/content/pro/_category_.json new file mode 100644 index 000000000000..362d5e9435a6 --- /dev/null +++ b/website/content/pro/_category_.json @@ -0,0 +1,4 @@ +{ + "label": "OpenBB Terminal Pro", + "position": 0 +} diff --git a/website/content/pro/advanced-search.md b/website/content/pro/advanced-search.md new file mode 100644 index 000000000000..f300a3ceaa1e --- /dev/null +++ b/website/content/pro/advanced-search.md @@ -0,0 +1,40 @@ +--- +title: Advanced Search +sidebar_position: 6 +description: Learn about the functionality of the advanced search in OpenBB Terminal + Pro. Discover the six main categories including Securities, Templates, Widgets, + Actions, News, and the All option that enhances research and productivity. +keywords: +- Advanced Search +- Securities +- Widgets +- Templates +- Actions +- News +- Financial Data +- Dashboards +- Data Connectors +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + + +275681118-b5ed496a-5822-49c9-bc56-958dab886f59 + +OpenBB Terminal Pro's advanced search is a powerful tool that enables you to perform a wide range of tasks swiftly and efficiently. + +The search is divided into six main categories: + +* **Securities**: This category displays securities that match your search criteria. It's not limited to symbol matches; it also includes company names. For instance, a search for 'Sales' will return 'Salesforce', which has the ticker symbol 'CRM'. + +* **Templates**: These are pre-designed layouts developed by OpenBB, but you can also create your own. Templates save the location of widgets in a dashboard, allowing you to quickly set up a dashboard with your chosen ticker. + +* **Widgets**: These are the primary components of the dashboards. Each widget contains financial data that can enhance your research. This category is your go-to place for such data. + +* **Actions**: If you're unable to locate a specific action like 'settings', 'data connectors', 'change theme', etc., you can find it directly in the actions category. + +* **News**: This category allows you to search through the latest news for topics that best match your search. + +* **All**: This category combines results from all of the above categories. diff --git a/website/content/pro/copilot.md b/website/content/pro/copilot.md new file mode 100644 index 000000000000..5f1015330bd9 --- /dev/null +++ b/website/content/pro/copilot.md @@ -0,0 +1,29 @@ +--- +title: Copilot +sidebar_position: 7 +description: Learn how to use OpenBB Copilot to interact with the OpenBB Terminal + Pro, execute basic commands, and customize your dashboard. +keywords: +- OpenBB Copilot +- voice command +- change theme mode +- load templates +- TSLA +- Natural language processing +- Large language model +- OpenAI +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + + +OpenBB copilot is your companion to interact with the OpenBB Terminal Pro. + +![image](https://github.com/OpenBB-finance/OpenBBTerminal/assets/25267873/d7023765-7fcd-4bcb-bded-7ed44d4f7c18) + + +To initiate a dialogue with the OpenBB Copilot, simply click on the icon located at the top left of your screen. You have the option to input your request either through typing or voice command. + +The scope of your request can range from basic commands such as "change theme mode to light", to more intricate requests like "load my equity template with TSLA" or "Add insider trading and ownership widgets to this dashboard". diff --git a/website/content/pro/dashboards/_category_.json b/website/content/pro/dashboards/_category_.json new file mode 100644 index 000000000000..c805f86dfa3a --- /dev/null +++ b/website/content/pro/dashboards/_category_.json @@ -0,0 +1,4 @@ +{ + "label": "Dashboards", + "position": 5 +} \ No newline at end of file diff --git a/website/content/pro/dashboards/folders.md b/website/content/pro/dashboards/folders.md new file mode 100644 index 000000000000..11ff73309f39 --- /dev/null +++ b/website/content/pro/dashboards/folders.md @@ -0,0 +1,32 @@ +--- +title: Folders +sidebar_position: 4 +description: This documentation page explains how to create and organize dashboards + and folders in OpenBB Terminal Pro. This is an essential step to arrange investment + research and manage the workspace efficiently. +keywords: +- Folder creation +- Dashboard creation +- Investment research +- Dashboard organization +- Dashboard settings +- Move dashboard to folder +--- + + + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +On the sidebar, users have a plus icon where they are able to create a new dashboard or folder. + +275686370-ef2aadeb-3cc8-44ac-8680-dc6d8d776f79 + +This allows the creation of a new dashboard to perform investment research, or creating a folder to organize multiple dashboards. + +Below is an example of a folder that contains multiple dashboards. + +275686285-e3f429a3-e24e-4221-83d6-ed0a0cfdb831 + +A dashboard can be moved into a folder through the dashboard settings with the "Move to", or by dragging the dashboard into the folder. diff --git a/website/content/pro/dashboards/grouping.md b/website/content/pro/dashboards/grouping.md new file mode 100644 index 000000000000..ad76e073cec4 --- /dev/null +++ b/website/content/pro/dashboards/grouping.md @@ -0,0 +1,46 @@ +--- +title: Grouping Mechanism +sidebar_position: 1 +description: Learn about the powerful grouping mechanism in OpenBB Terminal Pro. Understand + how widgets can be grouped based on equity categories and tickers, and also how + the watchlist widget's unique grouping property works. +keywords: +- Grouping +- Widgets +- Ticker +- Symbol +- Dashboard +- Watchlist +- Relationship +--- + + + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +The grouping mechanism is extremely powerful as it allows widgets to be grouped together through one of their parameters based on the category they belong to. + +For instance, for the equity category, widgets can be connected through their ticker / symbol. Examples are: AAPL to symbolize Apple, TSLA for Tesla and so on. + +276163819-b4c80035-8ead-4fc9-b65b-c5b2c4b8e062 + +This is an example of 3 widgets that belong to the same group, note the dark yellow 1 on the top right. + +In addition, when clicking on the grouping icon you can see that they are grouped around the MSFT ticker. + +This means that if a user changes the ticker on any of these widgets, the remaining ones will get updated accordingly. + +Also note that the grouping is visible on the sidebar, immediately under the dashboard naming. + +276164492-b773f4ec-6b7d-432a-8e2b-0beb55982857 + + +### Watchlist and grouping + +The watchlist widget has a special property in relation to grouping. Since this widget doesn't have a single symbol but many, users can select the row of their ticker of interest, and widgets that are grouped with the watchlist will get updated accordingly. + +276165201-9f52500e-5e83-44ba-b5ab-d19c2951a4ea + +If a user selects a new ticker in another widget that is grouped with the watchlist, that ticker will be added to the watchlist and will become the one selected by default. diff --git a/website/content/pro/dashboards/index.md b/website/content/pro/dashboards/index.md new file mode 100644 index 000000000000..5f014f287780 --- /dev/null +++ b/website/content/pro/dashboards/index.md @@ -0,0 +1,59 @@ +--- +title: Dashboards +sidebar_position: 0 +description: This documentation page explains the functionalities of OpenBB Terminal + Pro's dashboard feature. Learn how to add widgets, text, rename, duplicate, and + interact with dashboards in various ways for efficient data visualization. +keywords: +- Dashboard Usage +- Data Visualization +- Add Widgets +- Manage Dashboards +- Dashboard export +- Dashboard settings +- Create new dashboard +--- + + + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +275685305-db3b650a-5e33-4709-acc7-0f86f9522c06 + +Dashboards are a collection of widgets. In the image above you can see that there are 3 different dashboards and the one selected can be seen in the working area. + +There are 2 ways to interact with dashboards. + +### The plus icon at the bottom right + +275685682-b4fd638e-2b4d-4216-96a6-31605a0c991a + +This allows to: + +* Add widget - Allows to add widgets to dashboard +* Add text - Allows to add text to the dashboard +* Export report - Exports dashboard into a PDF or PNG format + + +### The settings icon on the Dashboard's sidebar + +275685893-b48b8016-dfb0-48ac-9d85-2fefeb3facb1 + + +This allows to: + +* Rename - Rename dashboard's name +* Move to - Move that dashboard into a folder +* Duplicate - Duplicate dashboard +* Open in a new window - For users wanting to leverage multiple screens +* Delete - Delete dashboard +* Export report - Exports dashboard into a PDF or PNG format + + +### The plus icon on the sidebar + +275686811-6d7daa4d-6b09-4eb9-8972-626950fc7f6d + +Which allows the creation of a new dashboard, or a new folder. diff --git a/website/content/pro/dashboards/report.md b/website/content/pro/dashboards/report.md new file mode 100644 index 000000000000..025015d81a31 --- /dev/null +++ b/website/content/pro/dashboards/report.md @@ -0,0 +1,30 @@ +--- +title: Report +sidebar_position: 3 +description: Learn how to create a report out of a dashboard in OpenBB Terminal Pro. + Discover the power of static reports in PDF or PNG format with additional insights + and how to export it. +keywords: +- Report creation +- Export dashboard as report +- Export report as PDF +- Export report as PNG +- Insights on report +- Report from dashboard +--- + + + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +275687043-c79f8643-3c34-43fd-bc77-a53384471e7b + +A report can be created out of a dashboard so that you have a static report of the interactive dashboard. This report can be a PDF or PNG format. This can be very powerful to record a moment in time, particularly when adding the text widget with additional insights from a user. + +You can export a dashboard as a report through the bottom right plus icon on the working area or through the dashboard's settings on the sidebar. + +275687512-66e63a3c-c662-4726-b514-195e5df4e1d4 + +275687535-53d5aa1c-0d9f-480b-9eb9-581475910f66 diff --git a/website/content/pro/dashboards/templates.md b/website/content/pro/dashboards/templates.md new file mode 100644 index 000000000000..17db9ccc63ed --- /dev/null +++ b/website/content/pro/dashboards/templates.md @@ -0,0 +1,32 @@ +--- +title: Templates +sidebar_position: 2 +description: Learn how to use and manage dashboard templates on OpenBB Terminal Pro. + Save your widget layouts, set default templates, and use the advanced search to + optimize your experience. +keywords: +- dashboard templates +- advanced search +- template library +- default template +- widget layouts +- security +--- + + + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +275687647-683f47e3-0ad6-45bc-a026-01884cfabd3f + +The widget layouts in dashboards can be saved as templates. This capability allows users to save dashboard layouts for future dashboards where another ticker is used, or to share with colleagues. + +Using the advanced search, users can find their template library. + +275688104-e0a66c9d-7f4e-4b81-851c-b15a0a04e547 + +More importantly, once a template is defined as "default" that means that whenever a security is selected in the advanced search - that security will be loaded as a dashboard from the default template. + +275688498-6d9dcb68-9717-4ed4-962d-2e534d4ddca2 diff --git a/website/content/pro/getting-started/_category_.json b/website/content/pro/getting-started/_category_.json new file mode 100644 index 000000000000..8a60d16f641c --- /dev/null +++ b/website/content/pro/getting-started/_category_.json @@ -0,0 +1,4 @@ +{ + "label": "Getting started", + "position": 1 +} diff --git a/website/content/pro/getting-started/free-trial.md b/website/content/pro/getting-started/free-trial.md new file mode 100644 index 000000000000..3e3154e34095 --- /dev/null +++ b/website/content/pro/getting-started/free-trial.md @@ -0,0 +1,45 @@ +--- +title: Free trial +sidebar_position: 1 +description: The free trial of OpenBB Terminal Pro provides full access to its features + for 2 weeks with a potential 1-week extension. Steps to get early access and personalized + onboarding process are also explained. +keywords: +- Free Trial +- OpenBB Hub account +- early access code +- product development +- free trial extension +- Personalized Onboarding +- investment interests +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +To unlock the powerful features of **OpenBB Terminal Pro**, follow these steps: + +1. Create an OpenBB Hub account. It's free and easy. Sign up here: https://my.openbb.co. +2. Obtain an early access code. + +You can get the early access code in one of the following ways: +1. Join the waitlist at https://my.openbb.co/app/pro/early-access +2. Get an invite code from a colleague who already has access +3. Become a design partner and contribute to our product development + +The free trial of **OpenBB Terminal Pro** grants you full access to all features and data for a period of 2 weeks. + +To continue using the product after the trial period, you will be allowed to request a 1 week extension for free. After that you will need to contact sales@openbb.finance to extend your trial. + +As an early adopter, your feedback is invaluable. The OpenBB team may reach out to understand your experience and gather insights for improvement. + +Note: For your security, you'll need to set up 2-Factor authentication when you log in. + +## Personalized Onboarding + +Upon your first login, we'll ask a few questions about your investment interests, background, and workflow. + +Your responses will help us tailor your experience, ensuring a smooth and effective start with the app. + +Note: You can update these responses anytime should your interests evolve. diff --git a/website/content/pro/getting-started/index.md b/website/content/pro/getting-started/index.md new file mode 100644 index 000000000000..4f3399faa981 --- /dev/null +++ b/website/content/pro/getting-started/index.md @@ -0,0 +1,37 @@ +--- +title: Getting Started +sidebar_position: 0 +description: Get started with OpenBB Terminal Pro, your comprehensive tool for investment + research. Understand the layout and powerful features that can enhance your research + capabilities. +keywords: +- investment research +- sidebar +- main menu +- charting +- news +- data connectors +- dashboards +- working area +- widgets +- investment decisions +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Welcome to the OpenBB Terminal Pro, your comprehensive tool for investment research. Let's get you started by understanding the layout of the Terminal Pro. + +275680756-5738aae0-23cd-4cfa-8150-77150a1d5086 + +The interface is divided into two main areas: + +* **Sidebar**: Here, you'll find your main menu and your dashboards. + + * **Main Menu**: This is your command center, housing the Home, Charting, News, and Data Connectors sections. Each section serves a unique purpose, designed to enhance your research capabilities. Learn more about the Main Menu [here](link to Main Menu). + * **Dashboards**: This is where all your dashboards (and folders) are organized. To understand more about how dashboards can streamline your workflow, visit [this page](link to Dashboards). + +* **Working Area**: This is your research canvas. It's where you'll interact with widgets that provide valuable insights to inform your investment decisions through dashboards, or where you'll access one of the views available from the main menu. + +Now that you're familiar with the layout, let's dive into the powerful features of OpenBB Terminal Pro. diff --git a/website/content/pro/index.md b/website/content/pro/index.md new file mode 100644 index 000000000000..f4c99012f549 --- /dev/null +++ b/website/content/pro/index.md @@ -0,0 +1,79 @@ +--- +title: Overview +sidebar_position: 0 +description: OpenBB Terminal Pro offers advanced investment research capabilities + with powerful features like high-quality financial data, customizability, collaborative + tools, generative AI, and more. +keywords: +- investment research platform +- high-quality financial data +- customizable +- collaborative tools +- generative AI +- user experience +- investment decisions +- financial data analysis +- investment research reports +- user efficiency +- investment analysis +- financial dashboard +- visual insights +- data visualization +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Discover the superior investment research capabilities of the OpenBB Terminal Pro. Built on top of the open-source OpenBB Terminal, our platform provides a sleek graphical interface that is intuitive and fully customizable, making it easier for you to access and analyze financial information with ease. + +Plus, with built-in access to high-quality financial data curated from official partnerships with data providers, you can conduct comprehensive analysis and gain valuable insights that inform your investment decisions. + +
+ +
+ +--- + +- **Improved User Experience** + +We've focused on improving the user experience (UX) of the OpenBB Terminal Pro based on feedback from dozens of users. The platform features a better user interface that is visually appealing, while keeping the keyboard-centric workflow of the OpenBB Terminal for quick and efficient information access. + +- **Customizable and Collaborative** + +Unlike traditional investment research dashboards, the OpenBB Terminal Pro is a fully integrated and customizable environment that allows you to optimize your workflow to your preferences. Plus, take advantage of advanced collaboration features to share insights, exchange ideas, and make informed decisions with your team in real time. + +- **Built-in access to high-quality financial data** + +The OpenBB Terminal Pro is powered by an extensive data marketplace that allows you to make use of any dataset that exists. With an abundance of data at your fingertips, you can conduct a comprehensive analysis and gain valuable insights that inform your investment decisions. You can subscribe to only the datasets you need and access the raw data for deeper analysis, whether you're looking for financial, economic, or market data. + +--- + +## Features + +### Bring your own data + +The OpenBB Terminal Pro allows professionals to bring any data into their research environment. Whether that is a .csv file, a private endpoint, a RSS feed or even embed a SEC filing directly. The only limit is the user's creativity. + +### Your terminal, your whiteboard + +The OpenBB Terminal Pro is the most flexible investment research platform. It allows users to create their preferred dashboards with their preferred widgets. Never be limited again by what a platform allows you to create. + +### Generative AI to summarize content + +Our most popular feature includes chatting with financial data through state-of-the-art large language models (LLMs). For instance, instead of spending minutes reading news articles or hours reading earnings transcripts, create a summary in seconds and ask how that impacts your investments. + +### Build investment research reports in seconds + +The OpenBB Terminal Pro allows to add notes next to each widget and render the tab into a custom report that can be used to share with the team or manager., share with team + +### Create charts from raw data + +The OpenBB Terminal Pro allows to create charts directly from raw data in seconds. This effectively increases user efficiency by 10x, as visual insights are much more powerful. diff --git a/website/content/pro/main-menu/_category_.json b/website/content/pro/main-menu/_category_.json new file mode 100644 index 000000000000..7a8da94b45e4 --- /dev/null +++ b/website/content/pro/main-menu/_category_.json @@ -0,0 +1,4 @@ +{ + "label": "Main menu", + "position": 4 +} \ No newline at end of file diff --git a/website/content/pro/main-menu/charting.md b/website/content/pro/main-menu/charting.md new file mode 100644 index 000000000000..62219cd8e675 --- /dev/null +++ b/website/content/pro/main-menu/charting.md @@ -0,0 +1,50 @@ +--- +title: Charting +sidebar_position: 3 +description: Learn about the charting feature of OpenBB Terminal Pro, powered by TradingView + charting library. The page provides instructions for adjusting time intervals and + timelines, using technical analysis indicators, and accessing editing tools. Learn + how to overlay charts in forex, crypto, equity, and macroeconomics. The page also + discusses overlay financials to understand the correlation between a company's financial + performance and its stock price. +keywords: +- Charting +- TradingView charting library +- financial analysis +- technical analysis indicators +- editing tools +- overlay charts +- forex +- crypto +- equity +- macroeconomics +- financial data +- stock price +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +273497041-34665daf-a145-44c5-ab1e-285c34d29bda + +Our charting feature is powered by the renowned TradingView charting library, offering you a comprehensive and intuitive platform for financial analysis. With this feature, you can access all the functionalities typically available on TradingView. To get the most out of this feature, we recommend familiarizing yourself with TradingView's capabilities here: https://www.tradingview.com/charting-library-docs/latest/getting_started/ + +Here's a quick rundown of what you can do with our charting feature: + +* Adjust the time interval and timeline based on your preferred data vendor + +* Utilize TradingView's robust suite of technical analysis indicators for in-depth market insights + +* Access a variety of editing tools for annotations, line drawings, measurements, Fibonacci retracements, and more + +* Overlay charts of other tickers of interest, whether they're in forex, crypto, equity, or macroeconomics + +275673750-ecf872a5-1331-46d8-baa0-a4d95d752b53 + + +## Overlay Financials + +When analyzing equity data, you'll notice the "Financial" text above the chart. This powerful tool allows you to overlay financial data (e.g., revenue, cost of goods, etc.) over time, providing a visual representation of how financials impact the equity price trajectory. It's a powerful way to understand the correlation between a company's financial performance and its stock price. + +275673910-ecc258ae-6baa-439a-81a3-a332afaeab88 diff --git a/website/content/pro/main-menu/data-connectors/_category_.json b/website/content/pro/main-menu/data-connectors/_category_.json new file mode 100644 index 000000000000..4462097d884e --- /dev/null +++ b/website/content/pro/main-menu/data-connectors/_category_.json @@ -0,0 +1,4 @@ +{ + "label": "Data Connectors", + "position": 4 +} diff --git a/website/content/pro/main-menu/data-connectors/index.md b/website/content/pro/main-menu/data-connectors/index.md new file mode 100644 index 000000000000..1618a9a0f29a --- /dev/null +++ b/website/content/pro/main-menu/data-connectors/index.md @@ -0,0 +1,42 @@ +--- +title: Introduction +sidebar_position: 0 +description: Learn about the Data Connectors feature of OpenBB Terminal Pro which + allows integration of private datasets via different methods such as No code, Advanced + and Third-party. For any further assistance, contact us at support@openbb.finance. +keywords: +- Data Connectors +- private datasets +- no code +- advanced +- third-party +- integrate +- API +- data warehouse +- database +- support +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +273497891-d9436d87-422c-4d73-a81c-bdc746695a28 + +OpenBB Terminal Pro's Data Connectors are designed to empower teams by allowing them to integrate their own private datasets. This feature enhances the platform's capabilities by providing a seamless experience alongside the data that matters most to you. + +We offer three distinct methods for importing your data into the platform. + +## No code + +This method allows users to import an API endpoint that is directly rendered into a table format. While customization is limited, it provides a quick and easy way to visualize your data. More information can be found here (add link) + +## Advanced + +For those who prefer a more hands-on approach, you can create your own backend. You can either leverage OpenBB's cookiecutter or build a language-agnostic API. More information can be found here (add link) + +## Third-party + +OpenBB has established partnerships with several companies to streamline the process of importing external data. This includes data providers that require an API key, or integration with a data warehouse or database. More information can be found here (add link) + +For further assistance in creating your Backend API or adding a single widget endpoint, please contact us at support@openbb.finance diff --git a/website/content/pro/main-menu/data-connectors/integrate-your-own-backend.md b/website/content/pro/main-menu/data-connectors/integrate-your-own-backend.md new file mode 100644 index 000000000000..d71c9dcf5b4c --- /dev/null +++ b/website/content/pro/main-menu/data-connectors/integrate-your-own-backend.md @@ -0,0 +1,50 @@ +--- +title: Integrate your own backend +sidebar_position: 2 +description: Learn how to integrate your own backend with OpenBB Terminal Pro using + the cookiecutter or language-agnostic API approaches, with illustrative guides + and principles for handling widget.json files, APIs, interfaces, Python, FastAPI + and more. +keywords: +- OpenBB cookiecutter +- widgets.json +- OpenBB API +- Endpoint integration +- widget configuration +- Language-Agnostic API +- API implementation +- Python +- FastAPI +- Terminal Pro widgets +- Widget definitions +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +## Using OpenBB cookiecutter + +The OpenBB cookiecutter approach provides a standardized way to host your data and integrate it into widgets. This method is versatile and can be used whether your data is hosted internally or externally. Here's how to get started: + +1. **Prepare the `widgets.json` file**: This file defines widget properties such as name, description, category, type, endpoint, and more. Make sure it's well-structured. See an example below. + +2. **Set up the OpenBB API**: Follow the OpenBB API documentation to set up your API. Implement the necessary endpoints that align with the widget definitions in the `widgets.json` file. + +3. **Integrate endpoints**: Define the appropriate endpoint for each custom widget in the `widgets.json` file. This endpoint connects your API to the widget. + +4. **Configure widgets**: Users can add the custom widgets using the Terminal Pro interface by providing the relevant endpoint details. + +## Using Language-Agnostic API + +The language-agnostic API approach offers flexibility by allowing you to use the programming language and tools that best suit your needs. You can host this API internally or externally, making it accessible to the Terminal Pro widgets. Here's how: + +1. **Design and implement your API**: Choose your preferred programming language and framework. Ensure that the API can return data in JSON format, which is required for widget integration. + +2. **Create widget definitions**: As with the OpenBB API approach, create corresponding definitions for your custom widgets in the `widgets.json` file. Specify the API endpoint, name, description, category, type, etc. + +3. **Connect widgets to your API**: Once your API is up and running, users can add the custom widgets using the Terminal Pro interface. They just need to input the endpoint details, and the widget will fetch and display the data from your API. + +### Quick Start with Python and FastAPI + +The example below demonstrates how you can quickly get started with Python and FastAPI. diff --git a/website/content/pro/main-menu/data-connectors/native-integrations.md b/website/content/pro/main-menu/data-connectors/native-integrations.md new file mode 100644 index 000000000000..f282aab19ace --- /dev/null +++ b/website/content/pro/main-menu/data-connectors/native-integrations.md @@ -0,0 +1,29 @@ +--- +title: Native integrations +sidebar_position: 3 +description: Get in-depth documentation on Native Integrations provided by OpenBB + Terminal Pro including API key connections to data providers and database/warehouse + connections for an enhanced data analysis experience. +keywords: +- Native Integrations +- API key +- Data Providers +- Data Warehouse +- Database Connections +- SQL queries +- Data Analysis +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +OpenBB Terminal Pro allows seamless integration with two types of third-party data providers. + +## API Key Connections + +To access certain data providers and their associated widgets, you'll need an API key obtained directly from the data provider. We provide step-by-step instructions for each use case to guide you through this process. + +## Data Warehouse/Database Connections + +For a more robust integration, OpenBB Terminal Pro offers connections to your data warehouse or database. Simply use your login credentials to access your warehouse or database, and swiftly run SQL queries. The queried data can then be rendered as a table within the Terminal Pro interface, providing you with a powerful tool for data analysis. diff --git a/website/content/pro/main-menu/data-connectors/single-widget.md b/website/content/pro/main-menu/data-connectors/single-widget.md new file mode 100644 index 000000000000..f32078a73382 --- /dev/null +++ b/website/content/pro/main-menu/data-connectors/single-widget.md @@ -0,0 +1,32 @@ +--- +title: Single widget +sidebar_position: 1 +description: Learn how to use the Single Widget of OpenBB Terminal Pro for seamless + integration with your API Endpoints, enabling custom data to be fetched and displayed + in an accessible format. Includes features like additional headers and addressing + nested JSON data. +keywords: +- Single Widget +- Data Connectors +- API Endpoints +- Data Integration +- User-friendly Table Format +- Additional Headers +- Data Key Parameter +- Nested JSON +- Custom Backend +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +The single widget is the most straightforward method to integrate your custom data into OpenBB Terminal Pro. Simply paste your API endpoint into the data connectors tab, and voila! Your data is fetched and displayed in a user-friendly table format. + +To use this feature, input your API endpoint and any necessary connection information. The widget will then dynamically load and present your data within the Terminal Pro interface. + +If your endpoint requires additional headers, don't worry. You can easily add them using the '+ Add Additional Headers' button. + +In addition, if your API endpoint doesn't return a a simple JSON but a nested architecture, you will be prompted with a "Data Key" parameter which you can use to grab the data of interest. + +If you want to do something more custom, you should look into creating [your own backend](/pro/main-menu/data-connectors/integrate-your-own-backend), or reach out to OpenBB for support. diff --git a/website/content/pro/main-menu/homepage.md b/website/content/pro/main-menu/homepage.md new file mode 100644 index 000000000000..f3db2d11afdd --- /dev/null +++ b/website/content/pro/main-menu/homepage.md @@ -0,0 +1,35 @@ +--- +title: Homepage +sidebar_position: 1 +description: Homepage of OpenBB Terminal Pro, your comprehensive hub for tutorials, + updates, partnerships, webinars, and more. Enhance your understanding of our financial + data terminal and stay up-to-date with the latest improvements. +keywords: +- financial data terminal +- financial software tutorials +- OpenBB updates +- OpenBB partnerships +- OpenBB webinars +- financial data providers +- financial software features +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +273495206-3e6e9b81-41fd-499a-b026-defe7baab5d7 + +Welcome to the homepage of OpenBB Terminal Pro, your one-stop hub for all things related to the terminal. + +Here's what you can find: + +* **Tutorials**: Step-by-step guides on how to leverage the powerful features of our platform, tailored to specific workflows crafted by our team. + +* **Updates**: Stay up-to-date with the latest enhancements, bug fixes, and improvements made to the OpenBB Terminal Pro. + +* **Partnerships**: Learn about our new collaborations and data providers that help us deliver high-quality financial data. + +* **Webinars**: Sign up for our webinars to gain deeper insights into specific topics and enhance your knowledge. + +* **And much more**: We're constantly adding new features and resources to help you get the most out of OpenBB Terminal Pro. diff --git a/website/content/pro/main-menu/index.md b/website/content/pro/main-menu/index.md new file mode 100644 index 000000000000..c71ab9a72baa --- /dev/null +++ b/website/content/pro/main-menu/index.md @@ -0,0 +1,40 @@ +--- +title: Main Menu +sidebar_position: 0 +description: The main menu is the gateway to the powerful features of the OpenBB Terminal + Pro. Find the latest updates from the OpenBB team, financial news articles, and + use tools for data visualization and analysis across equities, macroeconomics, and + cryptocurrencies. Integrate your own data with Data connectors for better financial + decisions. +keywords: +- Homepage +- News +- Charting +- Data connectors +- Financial data +- Financial news articles +- Financial decisions +- Macroeconomics +- Cryptocurrencies +- Equities +- Roadmap +- Events +- Technical analysis +- Data visualization +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +275680163-74bdd6f4-f54d-4ff2-8db0-75c075854e3f + +The main menu is your gateway to the powerful features of the OpenBB Terminal Pro. It comprises four key sections: + +* **Homepage**: This is your OpenBB homepage, where you'll find the latest updates and insights from the OpenBB team. This includes announcements, roadmap, events and others. + +* **News**: Stay informed with the latest financial news articles, curated and presented for easy consumption. + +* **Charting**: A versatile tool that allows you to visualize and analyze data across various domains - equities, macroeconomics, or cryptocurrencies. Use it for technical analysis or overlay financials for equities to gain deeper insights. + +* **Data Connectors**: This feature empowers you to integrate your own data into Terminal Pro. Leverage this alongside the vast financial data accessible from Terminal Pro to make informed decisions. diff --git a/website/content/pro/main-menu/news.md b/website/content/pro/main-menu/news.md new file mode 100644 index 000000000000..4903ace540d0 --- /dev/null +++ b/website/content/pro/main-menu/news.md @@ -0,0 +1,42 @@ +--- +title: News +sidebar_position: 2 +description: The News section in OpenBB Terminal Pro provides users with the latest + updates in financial markets. It offers diverse topics, along with features like + Interactive Chat and Ticker Analysis for comprehensive news experience. +keywords: +- Financial news +- Market trends +- News section +- Interactive Chat +- Ticker Analysis +- Investments +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +273495463-5d5ed1cf-f108-469d-9c36-94aa982e6944 + +Welcome to the News section of OpenBB Terminal Pro. This is your hub for staying updated with the latest financial news and market trends. + +Our News section is divided into various topics such as Overview, Markets, Economics, Industries, Events, Tech, Politics, Ratings, and Opinion. Each topic further branches into subcategories, allowing you to navigate and explore news articles based on your interests. + +273495761-0b5d2ec5-f7e8-43b8-b2bf-36b677a14f7b + +Every news article can be opened for a detailed read. But that's not all. We've integrated two additional features to enhance your news reading experience: + +1. **Interactive Chat** - Click on the chat icon at the top left of the news article to ask questions related to the article. For example, you can ask for a summary of the article or inquire about its impact on your investments. + +273495862-4f52b95c-3113-4f6e-937d-b3f24337c194 + +2. **Ticker Analysis** - The top right of the news article displays a list of tickers mentioned in the article. Hover over a ticker to get a quick overview including price, volume, market cap, day price range, 52-week price range, and an interactive chart of the stock price since the previous day. + +273496116-8d59bd44-b338-4e53-bc45-067b131ec164 + +Click on "See profile" to open a comprehensive dashboard for the ticker. + +273496498-71709b8a-cdc0-4f8d-a28a-c796f2835785 + +Please note, the News section is not customizable. diff --git a/website/content/pro/settings.md b/website/content/pro/settings.md new file mode 100644 index 000000000000..7540cf85ec6a --- /dev/null +++ b/website/content/pro/settings.md @@ -0,0 +1,15 @@ +--- +title: Settings +sidebar_position: 2 +description: Find detailed information on how to navigate and customize your settings + in the OpenBB Terminal Pro. Learn the full capabilities and features + available to enhance your user experience. +keywords: +- Settings +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +to be added diff --git a/website/content/pro/widgets-library/_category_.json b/website/content/pro/widgets-library/_category_.json new file mode 100644 index 000000000000..7e0a7839329d --- /dev/null +++ b/website/content/pro/widgets-library/_category_.json @@ -0,0 +1,4 @@ +{ + "label": "Widgets library", + "position": 8 +} \ No newline at end of file diff --git a/website/content/pro/widgets-library/index.md b/website/content/pro/widgets-library/index.md new file mode 100644 index 000000000000..6fe972f06e8d --- /dev/null +++ b/website/content/pro/widgets-library/index.md @@ -0,0 +1,17 @@ +--- +sidebar_position: 7 +description: Explore the Widgets Library and learn more about widget creation, access + and use. This includes comprehensive documentation on the range of widgets users + can interact with. +keywords: +- Widgets Library +- Widget Documentation +- User Widgets +- Access Widgets +- Widget Creation +- Documentation Library +--- + +# Widgets Library + +Create documentation on all widgets users have access to under this \ No newline at end of file diff --git a/website/content/pro/widgets/_category_.json b/website/content/pro/widgets/_category_.json new file mode 100644 index 000000000000..e76371f2e074 --- /dev/null +++ b/website/content/pro/widgets/_category_.json @@ -0,0 +1,4 @@ +{ + "label": "Widgets", + "position": 4 +} diff --git a/website/content/pro/widgets/chat-with-widget.md b/website/content/pro/widgets/chat-with-widget.md new file mode 100644 index 000000000000..d254a2ecb30e --- /dev/null +++ b/website/content/pro/widgets/chat-with-widget.md @@ -0,0 +1,29 @@ +--- +title: Chat with widgets +sidebar_position: 3 +description: Learn about OpenBB Terminal Pro's innovative feature, the Chat Widget. + This generative AI tool enhances efficiency and productivity in investment research + by offering direct data interaction. +keywords: +- Chat Widget +- generative AI +- investment research tools +- data interaction +- efficiency +- productivity +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + + +275683124-b19067d7-abf1-4efb-9abb-93bb7bc3b03d + +Experience the power of our unique generative AI feature, the Chat Widget. This tool empowers you to interact directly with your data, asking questions to gain deeper insights. + +Imagine asking the widget to summarize its contents, or to explain how the data it presents could impact your investment positions in related tickers. The possibilities are endless. + +This innovative feature, a first in the realm of investment research tools, is designed to enhance your efficiency and productivity, potentially boosting your performance by up to 10x. + +275683456-51bf5ace-906e-4319-84a0-19f3a495e6ad diff --git a/website/content/pro/widgets/data-provider.md b/website/content/pro/widgets/data-provider.md new file mode 100644 index 000000000000..56e901716f95 --- /dev/null +++ b/website/content/pro/widgets/data-provider.md @@ -0,0 +1,31 @@ +--- +title: Data providers +sidebar_position: 2 +description: OpenBB Terminal Pro remains a leading platform in aggregating and standardizing + financial data. Be at the helm of choosing quality and affordable data vendors through + OpenBB. +keywords: +- Financial data aggregation +- Standardizing financial data +- Data vendors +- Data quality +- Data availability +- Data cost +- Data transparency +- Data freshness +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + + +275681258-09d976c7-7c3f-417f-9c86-14bd5659bfab + +OpenBB's primary role is to aggregate and standardize financial data. So, we empower data vendors by showcasing their data through our products, providing them with an application where they are able to monetize their offerings to OpenBB users. + +Each widget in OpenBB is powered by a specific data provider. In some instances, multiple data vendors may supply the same type of data. You are in control to choose the right data vendor based on factors such as data quality, availability, trustworthiness, and cost. + +To enhance transparency, OpenBB allows you to see the source of your data and the last time the data endpoint was accessed. With the help of the staleness indicator, you can easily determine the freshness of your data. + +275681459-4fc08c44-4e03-44ee-90ac-a865707dacc5 diff --git a/website/content/pro/widgets/index.md b/website/content/pro/widgets/index.md new file mode 100644 index 000000000000..12fc8e16b22e --- /dev/null +++ b/website/content/pro/widgets/index.md @@ -0,0 +1,105 @@ +--- +title: Widgets +sidebar_position: 0 +description: The page contains detailed information about the interactive elements + and functionalities of OpenBB Terminal Pro widgets. From grouping mechanisms to + settings, these widgets offer an interactive dashboard experience for users to track + and analyze their investments and data. The widgets support both raw data and chart + interpretations for data visualization. +keywords: +- Widgets +- Upper Tab +- Interactive elements +- Additional information +- Symbol +- Group +- Staleness Indicator +- Chat with Widget +- Grouping Mechanism +- Settings +- Close +- Content +- Raw Data +- Charts +- Interactive dashboard +- Investment positions +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + + +275681758-87fda536-c62c-4b3b-a6c0-42b4b2a3a3cc + +## Upper Tab + +The upper tab houses all the interactive elements and additional information related to the widget's content. + +### Left Side + +#### Title + +The title identifies the widget and is used when adding the same widget to another dashboard via advanced search. + +#### Symbol + +Some widgets are associated with a symbol. Changing this symbol updates the table content to reflect the new symbol. + +#### Group + +The group (if any) that the widget belongs to. If multiple widgets belong to the same group, updating the symbol in one will automatically update the symbol in the others. + +### Right Side + +#### Staleness Indicator + +This indicator shows the freshness of the data: + +* Green - updated within the last 30 seconds + +* Yellow - updated between 30 seconds and 5 minutes ago + +* Red - updated over 5 minutes ago + +#### Chat with Widget + +Our proprietary generative AI feature allows you to interact with the widget. Ask it to summarize its contents or explain how its data could impact your investment positions. + +#### Grouping Mechanism + +This feature allows you to group widgets together. When widgets are grouped, they share a color and number. You can see which dashboards have which groupings by looking at the text below the dashboard title in the sidebar. + +#### Settings + +275681803-98815926-3d46-4555-a81a-8832c1b50a05 + +* Settings - View the data source and select or hide columns. +* Share - Share this widget with your team. +* Duplicate - Create a copy of this widget on the same dashboard. +* Export - Export data in various formats, such as csv, xlsx, png, or jpeg. +* Maximize - View the widget in full-screen mode. +* Copy to - Copy the widget to a different dashboard. + +#### Close + +This option removes the widget from the dashboard. + +## Content + +OpenBB widgets support two main types of content: + +#### Raw Data + +Displayed in a table format. This is powerful as it allows to leverage the charting from raw data capabilities of the application. + +275682032-e314c938-8069-4bf1-9aea-a0c2e4e239ff + + +#### Charts + +Visual representations of data, including line charts, bar charts, pie charts, and other custom charts. Some examples below, + +275682286-bb6b2323-afec-42ff-bbc0-f07f92e8978e + +275682325-d8c1a586-3348-4814-b2e6-20930822de7a diff --git a/website/content/pro/widgets/tabular-data/_category_.json b/website/content/pro/widgets/tabular-data/_category_.json new file mode 100644 index 000000000000..25900809a70f --- /dev/null +++ b/website/content/pro/widgets/tabular-data/_category_.json @@ -0,0 +1,4 @@ +{ + "label": "Tabular data", + "position": 1 +} \ No newline at end of file diff --git a/website/content/pro/widgets/tabular-data/chart-from-raw-data.md b/website/content/pro/widgets/tabular-data/chart-from-raw-data.md new file mode 100644 index 000000000000..8dd682ed6b4f --- /dev/null +++ b/website/content/pro/widgets/tabular-data/chart-from-raw-data.md @@ -0,0 +1,25 @@ +--- +title: Chart from raw data +sidebar_position: 1 +description: Learn how to transform raw data into informative charts using OpenBB + Terminal Pro. This tool simplifies data visualization, aiding quants and analysts + in their investment research. +keywords: +- investment research +- data visualization +- charting tool +- quants +- analysts +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +In the world of investment research, data is king. But raw, tabular data can be overwhelming and difficult to interpret. That's where charts come in. They transform complex data sets into visual narratives, making it easier to spot trends, compare variables, and make informed decisions. + +With OpenBB Terminal Pro, you can create charts directly from your tabular data. Simply select the data you want to visualize, choose your preferred charting style, and let the software do the rest. It's a powerful tool for quants and analysts alike. + +Here are a few examples to get you started: + +(insert examples) diff --git a/website/content/pro/widgets/tabular-data/forecasting.md b/website/content/pro/widgets/tabular-data/forecasting.md new file mode 100644 index 000000000000..13c78717c3c3 --- /dev/null +++ b/website/content/pro/widgets/tabular-data/forecasting.md @@ -0,0 +1,29 @@ +--- +title: Forecasting +sidebar_position: 2 +description: Comprehensive documentation page about forecasting using OpenBB Terminal + Pro. Including out-of-the-box solutions such as Linear Regression and Nixtla's GPT. +keywords: +- forecasting +- investment research +- financial time series +- financial model +- Linear Regression +- Nixtla's GPT +- machine learning +- time series +- API key +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + + +In the dynamic world of investment research, the ability to accurately model and forecast financial time series is a crucial skill. OpenBB Terminal Pro empowers you to do just that, right from our user-friendly interface. Simply select the time series you wish to model or forecast, choose your preferred model, and voila! A chart is generated, displaying your selected time series alongside the forecast or model you've chosen. + +To get you started, we offer the following out-of-the-box solutions: + +* **Linear Regression**: This is a fundamental statistical and machine learning method. It's used to understand the relationship between two variables, with one being the predictor or independent variable and the other being the response or dependent variable. + +* **Nixtla's GPT (API key required)**: This is a state-of-the-art forecasting model. It's designed to handle a wide range of time series patterns, making it a versatile tool for your forecasting needs. Please note that an API key is required to use this feature. diff --git a/website/content/pro/widgets/tabular-data/index.md b/website/content/pro/widgets/tabular-data/index.md new file mode 100644 index 000000000000..297c21ca9184 --- /dev/null +++ b/website/content/pro/widgets/tabular-data/index.md @@ -0,0 +1,44 @@ +--- +title: Tabular data +sidebar_position: 0 +description: Explore OpenBB Terminal Pro Docs and learn about tabular data manipulation. + Discover features like column resizing, reorganization, filtering, sorting, and + transposing. Enhance your navigation and analysis of investment research data. +keywords: +- tabular data +- data manipulation +- column resizing +- column reorganization +- column filtering +- sorting +- transposing +- investment research +- financial data +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + + +In the realm of investment research, financial data often comes in tabular form. This is because it's predominantly quantitative, and analysts and quants frequently need to delve into the raw data to make informed decisions. To enhance your navigation experience through this data, we've incorporated basic data manipulation capabilities. + +## Column Resizing + +You have the flexibility to manually adjust the width of the table columns. Alternatively, you can use the "Autosize all columns" feature for automatic resizing. + +## Column Reorganization + +Reorganize your columns effortlessly with our drag-and-drop feature. Simply click and hold the mouse on the column header and drag it to your desired position. + +## Column Filtering + +To reduce visual clutter, you can temporarily hide any columns that aren't currently relevant to your analysis. This can be done easily in the column settings. + +## Sorting + +By clicking on a column header, you can sort the data in ascending or descending order based on that column's values. + +## Transposing + +Our platform allows you to transpose tables, turning columns into rows and vice versa. This feature can be particularly useful for rendering time series from tabular data. diff --git a/website/content/sdk/_category_.json b/website/content/sdk/_category_.json new file mode 100644 index 000000000000..f410e0980156 --- /dev/null +++ b/website/content/sdk/_category_.json @@ -0,0 +1,4 @@ +{ + "label": "OpenBB SDK", + "position": 4 +} diff --git a/website/content/sdk/data-available/_category_.json b/website/content/sdk/data-available/_category_.json new file mode 100644 index 000000000000..fc61fac4dbb1 --- /dev/null +++ b/website/content/sdk/data-available/_category_.json @@ -0,0 +1,4 @@ +{ + "label": "Data Available", + "position": 3 +} diff --git a/website/content/sdk/data-available/alternative.md b/website/content/sdk/data-available/alternative.md new file mode 100644 index 000000000000..881e4ec582bc --- /dev/null +++ b/website/content/sdk/data-available/alternative.md @@ -0,0 +1,193 @@ +--- +title: Alternative +description: This documentation page explains the functionalities provided by the + Alternative module of the OpenBB SDK, offering programmatic access to commands within + the OpenBB Terminal. It covers functions related to open source software (OSS) and + Covid data, and provides examples of usage using the Python language. +keywords: +- OpenBB SDK +- Alternative module +- open source software +- Covid data +- programmatic access +- GitHub API key +- repositories statistics +- global deaths +- cases slope +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +The Alternative module provides programmatic access to the commands from within the OpenBB Terminal. Import the OpenBB SDK module, and then access the functions similarly to how the Terminal menus are navigated. The code completion will be activated upon entering `.`, after, `openbb.alt` + +## How to Use +​ +The examples provided below will assume that the following import block is included at the beginning of the Python script or Notebook file: +​ +```python +from openbb_terminal.sdk import openbb +import pandas as pd +``` + +A brief description below highlights the main Functions and Modules available in the Alternative SDK + +### OSS + +|Path |Type | Description | +| :--------- | :---------: | ----------: | +|openbb.alt.oss.top |Function |Get top repositories | +|openbb.alt.oss.search |Function |Search repositories | +|openbb.alt.oss.history |Function |Display a repo star history | +|openbb.alt.oss.ross |Function |Startups from ross index | +|openbb.alt.oss.github_data |Function |Get repository stats | +|openbb.alt.oss.summary |Function |Get repository summary | +### Covid + +|Path |Type | Description | +| :--------- | :---------: | ----------: | +|openbb.alt.covid.global_deaths |Function |historical deaths for given country | +|openbb.alt.covid.slopes |Function |Load cases and find slope over period | +|openbb.alt.covid.stat |Function |Show historical cases and deaths by country | +|openbb.alt.covid.global_cases |Function |historical cases for given country | +|openbb.alt.covid.ov |Function | overview historical cases and deaths by country | + + +Alternatively you can print the contents of the Alternative SDK with: +​ +```python +help(openbb.alt.covid) +help(openbb.alt.oss) +``` + +## Examples - OSS + + +:::note + +To use some of the OSS SDK commands you will need a GitHub API key - you can get one [here](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token) + + +::: +### alt.oss.top +​ +The alt.oss.top SDK command lets you display top repositories - You can pass different parameters like `sortby` `categories` and `limit` to enhance the output. +​ +```python +summary = pd.DataFrame.from_dict(openbb.alt.oss.top(sortby='stars', categories='finance', limit=10)) +print(summary[['full_name', 'open_issues', 'stargazers_count']]) +``` + +|full_name |open_issues |stargazers_count| +| :--------- | :---------: | ----------: | +| vnpy/vnpy | 8 | 19487| +| OpenBB-finance/OpenBBTerminal | 149 | 17645| +| plotly/dash | 707 | 17645| +| waditu/tushare | 556 | 11829| +| wilsonfreitas/awesome-quant | 9 | 10874| +| microsoft/qlib | 232 | 9926| +| firefly-iii/firefly-iii | 103 | 9228| +| ranaroussi/yfinance | 441 | 7938| +| mrjbq7/ta-lib | 181 | 7157| +| QuantConnect/Lean | 417 | 6773| + +### alt.oss.summary + +The alt.oss.summary SDK command gets you some info on a reposity - You just pass the repo path and can see all kinds of interesting information. + +```python +summary = pd.DataFrame.from_dict(openbb.alt.oss.summary(repo="openbb-finance/openbbterminal")) +print(summary) +``` + +|Metric |Value | +| :--------- | ---------: | +| Name | OpenBBTerminal | +| Owner | OpenBB-finance | +| Creation Date | 2020-12-20 | +| Last Update | 2022-11-17 | +| Topics | artificial-intelligence, crypto, cryptocurrenc... | +| Stars | 17643 | +| Forks | 1849 | +| Open Issues | 152 | +| Language | Python | +| License | MIT License | +| Releases | 10 | +| Last Release Downloads | 10201 | +​ +## Examples - Covid + +### alt.covid.global_deaths + +The global_deaths command lets you check quickly the global deaths for any `country` +​ +```python +global_deaths = pd.DataFrame.from_dict(openbb.alt.covid.global_deaths(country="US")) +print(global_deaths) +``` + +|Date |US | +| :--------- | ---------: | +| 2020-01-23 | 0.0| +| 2020-01-24 | 0.0| +| 2020-01-25 | 0.0| +| 2020-01-26 | 0.0| +| 2020-01-27 | 0.0| +| ... | ...| +| 2022-11-12 | -40.0| +| 2022-11-13 | 1.0| +| 2022-11-14 | 216.0| +| 2022-11-15 | 387.0| +| 2022-11-16 | 825.0| + +### alt.covid.slopes + +The slopes command lets you check the slopes per country + +```python +covid_slopes = pd.DataFrame.from_dict(openbb.alt.covid.slopes()) +print(covid_slopes) +``` +|Country |Slope | +| :--------- | ---------: | +|Japan | 52199.941713| +|Korea, South | 42252.945717| +|Germany | 40376.811123| +|US | 38365.586207| +|Taiwan* | 28677.574861| +|France | 24898.053393| +|Italy | 20608.297664| +|Greece | 7841.223359| +|Australia | 6222.661846| +|Russia | 5837.264739| +|Chile | 5792.311457| +|Brazil | 5605.621802| +|United Kingdom | 4755.022692| +|Singapore | 3867.323471| +|Switzerland | 3393.054950| +|Malaysia | 3154.148387| +|... | ... | + + +You can pass `days_back` `limit` and `ascend` to further drill down in your data. + +```python +covid_slopes_params = pd.DataFrame.from_dict( + openbb.alt.covid.slopes(days_back=30, limit=10, ascend=True) +) +print(covid_slopes_params) +``` + +|Country |Slope | +| :--------- | ---------: | +| Colombia | -9917.200222| +| Iran | -4000.273415| +| Slovakia | -3553.934372| +| Poland | -563.439600| +| Lebanon | -364.833815| +| Bangladesh| -175.475640| +| Albania | -96.862736| +| Bulgaria | -39.990656| +| Turkey | -31.636263| +| Belarus | -21.939043| diff --git a/website/content/sdk/data-available/crypto/_category_.json b/website/content/sdk/data-available/crypto/_category_.json new file mode 100644 index 000000000000..5fa0dc863137 --- /dev/null +++ b/website/content/sdk/data-available/crypto/_category_.json @@ -0,0 +1,3 @@ +{ + "label": "Crypto" +} diff --git a/website/content/sdk/data-available/crypto/discovery.md b/website/content/sdk/data-available/crypto/discovery.md new file mode 100644 index 000000000000..1488fb5b04a1 --- /dev/null +++ b/website/content/sdk/data-available/crypto/discovery.md @@ -0,0 +1,150 @@ +--- +title: Discovery +sidebar_position: 2 +description: This page provides detailed instructions on how to use the Discovery + sub-module within the 'openbb.crypto.disc' to find new trends in Crypto markets. + The module enables users to search coins on CoinGecko by category, access a list + of coins available on CoinGecko, search CoinPaprika, view top coins, DeFi applications, + NFTs, and games by daily volume and users, and more. It also provides examples in + Python for better understanding. +keywords: +- openbb.crypto.disc +- Crypto markets +- CoinGecko +- Coins search +- DeFi applications +- Python Examples +- NFTs +- Crypto trends +- Market insights +- Crypto trading pairs +- market_cap +- trending coins +- Top DeFi games +- CoinPaprika search +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +The Discovery sub-module contains the tools for finding new trends in Crpyto markets and making new discoveries. The commands within the menu are listed below along with a short description. The module is accessed by entering, `openbb.crypto.disc`, and then a `.` activates code completion and type hints. + +## How to Use + +|Path |Description | +|:----|-----------:| +|openbb.crypto.disc.categories_keys |A List of Categories for Searching Coins | +|openbb.crypto.disc.coin_list |A List of Coins Available on CoinGecko | +|openbb.crypto.disc.coins |Search Coins on CoinGecko by Category | +|openbb.crypto.disc.coins_for_given_exchange |A Dictionary of all Trading Pairs on Binance | +|openbb.crypto.disc.cpsearch |Search CoinPaprika | +|openbb.crypto.disc.gainers |Top Gainers Over Different Periods | +|openbb.crypto.disc.losers |Top Losers Over Different Periods | +|openbb.crypto.disc.top_coins |The Top Movers | +|openbb.crypto.disc.top_dapps |The Top DeFi Applications by Daily Volume and Users | +|openbb.crypto.disc.top_dexes |The Top DeFi Exchanges | +|openbb.crypto.disc.top_games |The Top DeFi Games | +|openbb.crypto.disc.top_nfts |The Top NFTs | +|openbb.crypto.disc.trending |Trending Coins on CoinGecko | + +## Examples + +The examples below will assume the import statement block is included at the top of the file. + +```python +from openbb_terminal.sdk import openbb +``` + +### Coins + +Search coins on CoinGecko, or compare them all. + +```python +openbb.crypto.disc.coins().head(5) +``` + +| | id | symbol | name | image | current_price | market_cap | market_cap_rank | fully_diluted_valuation | total_volume | high_24h | low_24h | price_change_24h | price_change_percentage_24h | market_cap_change_24h | market_cap_change_percentage_24h | circulating_supply | total_supply | max_supply | ath | ath_change_percentage | ath_date | atl | atl_change_percentage | atl_date | roi | last_updated | price_change_percentage_14d_in_currency | price_change_percentage_1h_in_currency | price_change_percentage_1y_in_currency | price_change_percentage_200d_in_currency | price_change_percentage_24h_in_currency | price_change_percentage_30d_in_currency | price_change_percentage_7d_in_currency | +|----:|:--------------|:---------|:--------------|:--------------------------------------------------------------------------------------|----------------:|-------------:|------------------:|--------------------------:|---------------:|-------------:|-------------:|-------------------:|------------------------------:|------------------------:|-----------------------------------:|---------------------:|---------------:|-------------:|-------------:|------------------------:|:-------------------------|------------:|------------------------:|:-------------------------|:----------------------------------------------------------------------------------|:-------------------------|------------------------------------------:|-----------------------------------------:|-----------------------------------------:|-------------------------------------------:|------------------------------------------:|------------------------------------------:|-----------------------------------------:| +| 170 | 0x | zrx | 0x | https://assets.coingecko.com/coins/images/863/large/0x.png?1547034672 | 0.192066 | 162596592 | 171 | 1.91855e+08 | 7.92999e+06 | 0.198545 | 0.190939 | -0.00511834 | -2.59572 | -4.64766e+06 | -2.77897 | 8.47496e+08 | 1e+09 | 1e+09 | 2.5 | -92.3016 | 2018-01-13T00:00:00.000Z | 0.120667 | 59.3019 | 2020-03-13T02:27:49.563Z | {'times': 3.00137262387235, 'currency': 'usd', 'percentage': 300.137262387235} | 2022-12-05T22:57:31.604Z | 6.39773 | 0.236744 | -78.329 | -48.4052 | -2.59572 | -31.7183 | -0.08195 | +| 97 | zilliqa | zil | Zilliqa | https://assets.coingecko.com/coins/images/2687/large/Zilliqa-logo.png?1547036894 | 0.0227407 | 344299494 | 98 | 4.77046e+08 | 1.92004e+07 | 0.0235163 | 0.0226905 | -0.000172456 | -0.75265 | -2.93894e+06 | -0.84638 | 1.51564e+10 | 2.1e+10 | 2.1e+10 | 0.255376 | -91.0876 | 2021-05-06T17:33:45.940Z | 0.00239616 | 849.86 | 2020-03-13T02:22:55.161Z | {'times': 1.131460045428967, 'currency': 'eth', 'percentage': 113.14600454289669} | 2022-12-05T22:57:22.010Z | 7.01544 | -0.119826 | -67.7389 | -52.7247 | -0.752652 | -30.9379 | -0.991144 | +| 189 | zencash | zen | Horizen | https://assets.coingecko.com/coins/images/691/large/horizen.png?1555052241 | 10.64 | 139250373 | 190 | 2.22972e+08 | 5.44128e+06 | 11.07 | 10.62 | -0.264045 | -2.42165 | -3.61206e+06 | -2.52835 | 1.31149e+07 | 2.1e+07 | 2.1e+07 | 165.92 | -93.5817 | 2021-05-08T06:00:30.087Z | 3.26 | 226.208 | 2019-10-17T00:00:00.000Z | | 2022-12-05T22:57:34.376Z | 21.2037 | -0.57332 | -86.651 | -44.0292 | -2.42165 | -25.8735 | 11.1271 | +| 63 | zcash | zec | Zcash | https://assets.coingecko.com/coins/images/486/large/circle-zcash-color.png?1547034197 | 46.24 | 602735976 | 64 | 9.69752e+08 | 3.57518e+07 | 47.32 | 45.31 | 0.479718 | 1.04838 | 5.91658e+06 | 0.99135 | 1.30523e+07 | 2.1e+07 | 2.1e+07 | 3191.93 | -98.5521 | 2016-10-29T00:00:00.000Z | 19.75 | 133.959 | 2020-03-13T02:20:55.002Z | | 2022-12-05T22:57:30.607Z | 21.4551 | 0.502131 | -75.4374 | -53.9461 | 1.04838 | -14.1037 | 13.3262 | +| 141 | yearn-finance | yfi | yearn.finance | https://assets.coingecko.com/coins/images/11849/large/yfi-192x192.png?1598325330 | 7082.34 | 220754373 | 142 | 2.59099e+08 | 4.54938e+07 | 7472.6 | 7052.76 | -157.22 | -2.17168 | -5.96275e+06 | -2.63004 | 31239.8 | 36666 | 36666 | 90787 | -92.1948 | 2021-05-12T00:29:37.713Z | 31.65 | 22292.3 | 2020-07-18T12:26:27.150Z | | 2022-12-05T22:57:24.815Z | 15.7094 | -0.124164 | -71.239 | -22.0297 | -2.17168 | -15.4178 | 13.2592 | + +Coins can be filtered by category. For a list of defined categories enter: + +```python +categories:dict = openbb.crypto.disc.categories_keys() +``` + +The category chosen below is called, `big-data`. + +```python +openbb.crypto.disc.coins(category = categories[10], sortby = 'market_cap').head(5) +``` + +| | id | symbol | name | image | current_price | market_cap | market_cap_rank | fully_diluted_valuation | total_volume | high_24h | low_24h | price_change_24h | price_change_percentage_24h | market_cap_change_24h | market_cap_change_percentage_24h | circulating_supply | total_supply | max_supply | ath | ath_change_percentage | ath_date | atl | atl_change_percentage | atl_date | roi | last_updated | price_change_percentage_14d_in_currency | price_change_percentage_1h_in_currency | price_change_percentage_1y_in_currency | price_change_percentage_200d_in_currency | price_change_percentage_24h_in_currency | price_change_percentage_30d_in_currency | price_change_percentage_7d_in_currency | +|---:|:-----------------|:---------|:---------|:-----------------------------------------------------------------------------------------|----------------:|-------------:|------------------:|--------------------------:|-----------------:|-----------:|----------:|-------------------:|------------------------------:|------------------------:|-----------------------------------:|---------------------:|---------------:|-------------:|----------:|------------------------:|:-------------------------|-----------:|------------------------:|:-------------------------|:------------------------------------------------------------------------------------|:-------------------------|------------------------------------------:|-----------------------------------------:|-----------------------------------------:|-------------------------------------------:|------------------------------------------:|------------------------------------------:|-----------------------------------------:| +| 0 | dock | dock | Dock | https://assets.coingecko.com/coins/images/3978/large/dock-icon-dark-large.png?1623764407 | 0.0163913 | 7.04484e+07 | 295 | nan | 567668 | 0.0170636 | 0.0163263 | -0.00031004 | -1.85637 | -2.34457e+06 | -3.22088 | 0 | 1e+09 | nan | 0.241848 | -93.2225 | 2018-05-04T05:29:09.155Z | 0.00259319 | 532.083 | 2020-03-13T02:24:35.312Z | {'times': -0.8420344706449371, 'currency': 'eth', 'percentage': -84.20344706449372} | 2022-12-05T23:04:48.481Z | 11.105 | 0.113349 | -79.607 | -17.3245 | -1.85637 | -19.6563 | 0.481131 | +| 1 | covalent | cqt | Covalent | https://assets.coingecko.com/coins/images/14168/large/covalent-cqt.png?1624545218 | 0.099484 | 4.18854e+07 | 431 | 9.95348e+07 | 997478 | 0.112201 | 0.095826 | -0.0110446 | -9.99251 | -4.62241e+06 | -9.93901 | 4.20811e+08 | 1e+09 | 1e+09 | 2.08 | -95.2091 | 2021-08-14T05:30:40.858Z | 0.051932 | 91.5619 | 2022-08-01T23:38:54.301Z | | 2022-12-05T23:04:47.896Z | 16.5464 | 1.49149 | -87.4469 | -34.8706 | -9.99251 | -21.1618 | -16.3863 | +| 2 | gxchain | gxc | GXChain | https://assets.coingecko.com/coins/images/1089/large/26296223.png?1571192241 | 0.46468 | 3.48511e+07 | 476 | nan | 114097 | 0.797016 | 0.359858 | -0.331496 | -41.636 | -2.48954e+07 | -41.6683 | 7.5e+07 | 1e+08 | nan | 10.61 | -95.62 | 2018-01-13T00:00:00.000Z | 0.189778 | 144.839 | 2020-03-13T02:24:02.919Z | | 2022-12-05T23:04:01.358Z | 25.3322 | 3.68092 | -83.5683 | 13.1713 | -41.636 | -0.22209 | 31.9026 | +| 3 | insights-network | instar | INSTAR | https://assets.coingecko.com/coins/images/3504/large/2558.png?1547038269 | 0.0362529 | 2.85208e+07 | 534 | nan | 19.93 | 0.0370935 | 0.0359575 | -0.000214289 | -0.58762 | -5.51571e+06 | -16.2053 | 0 | 3e+08 | nan | 0.27882 | -86.9978 | 2022-10-02T09:16:16.012Z | 0.00467988 | 674.655 | 2020-03-13T02:22:38.395Z | {'times': -0.7583139455766651, 'currency': 'usd', 'percentage': -75.83139455766651} | 2022-12-05T18:39:15.686Z | -1.2191 | nan | 27.2158 | 113.695 | -0.587622 | -44.2698 | 3.3329 | +| 4 | bonfida | fida | Bonfida | https://assets.coingecko.com/coins/images/13395/large/bonfida.png?1658327819 | 0.392327 | 2.36672e+07 | 585 | 3.92307e+08 | 6.01989e+06 | 0.401193 | 0.386429 | -0.00802685 | -2.00494 | -441335 | -1.83062 | 6.03284e+07 | 1e+09 | 1e+09 | 18.77 | -97.9102 | 2021-11-03T20:34:33.492Z | 0.113165 | 246.695 | 2020-12-22T10:58:52.143Z | | 2022-12-05T23:04:56.497Z | -31.5948 | -0.13385 | -94.9581 | -30.7982 | -2.00494 | -5.84654 | -12.1443 | + +### Trending + +Print the trending coins on CoinGecko: + +```python +openbb.crypto.disc.trending() +``` + +| | Symbol | Name | market_cap Cap Rank | +|---:|:--------------|:--------------|----------------------:| +| 0 | chainlink | Chainlink | 21 | +| 1 | magiccraft | MagicCraft | 806 | +| 2 | apollo | Apollo | 858 | +| 3 | gmx | GMX | 86 | +| 4 | dawn-protocol | Dawn Protocol | 406 | +| 5 | evmos | Evmos | 149 | +| 6 | maple | Maple | 443 | +| 7 | aptos | Aptos | 59 | + +### Losers + +Filter coins by the changes over various windows of time, from an hour to a year. + +```python +openbb.crypto.disc.losers().head(3) +``` + +| | Symbol | Name | Price [$] | Market Cap | Market Cap Rank | Volume [$] | Change 1h [%] | +|---:|:---------|:--------------------|---------------:|-------------:|------------------:|-------------:|----------------:| +| 34 | ape | ApeCoin | 3.95 | 1430668301 | 35 | 225914151 | -0.613265 | +| 48 | theta | Theta Network | 0.879573 | 880099193 | 49 | 19024380 | -0.159237 | +| 12 | ltc | Litecoin | 80.28 | 5764526837 | 13 | 1079151325 | -0.147648 | + +Compared to the last fourteen days: + +```python +openbb.crypto.disc.losers(interval = '14d').head(3) +``` + +| | Symbol | Name | Price [$] | Market Cap | Market Cap Rank | Volume [$] | Change 14d [%] | +|---:|:---------|:----------|------------:|-------------:|------------------:|-------------:|-----------------:| +| 31 | algo | Algorand | 0.237655 | 1691877131 | 32 | 79911891 | -3.84964 | +| 22 | leo | LEO Token | 3.79 | 3541787576 | 23 | 2082712 | -2.70556 | +| 38 | flow | Flow | 1.11 | 1150005942 | 39 | 44608861 | -2.16063 | + +Over one-year: + +```python +openbb.crypto.disc.losers(interval = '1y').head(3) +``` + +| | Symbol | Name | Price [$] | Market Cap | Market Cap Rank | Volume [$] | Change 1y [%] | +|---:|:---------|:-------------------|------------:|-------------:|------------------:|-------------:|----------------:| +| 39 | lunc | Terra Luna Classic | 0.00017433 | 1042097683 | 40 | 75780496 | -99.9997 | +| 16 | sol | Solana | 13.87 | 5045641411 | 17 | 382220595 | -92.9463 | +| 43 | axs | Axie Infinity | 8.92 | 1004779023 | 44 | 707998935 | -91.6799 | diff --git a/website/content/sdk/data-available/crypto/introduction.md b/website/content/sdk/data-available/crypto/introduction.md new file mode 100644 index 000000000000..ccd44106e051 --- /dev/null +++ b/website/content/sdk/data-available/crypto/introduction.md @@ -0,0 +1,442 @@ +--- +title: Introduction +sidebar_position: 1 +description: This Docusaurus page is dedicated to providing a detailed guide on how + Cryptocurrency applications and dashboards can be built quickly using the OpenBB + Terminal's Crypto Module. It provides an outline on how to use SDK functions at + the 'openbb.crypto' level, rundown of functions and modules, along with sample Python + codes on loading data, finding similar coins, measuring liquidity, identifying trending + coins and more. This page can be useful for those working on Cryptocurrency applications, + particularly those relying on Python or OpenBB Terminal. +keywords: +- Docusaurus +- Cryptocurrency +- Web Application +- Crypto Module +- SDK Functions +- Digital Assets +- Onchain Metrics +- Data visualisation +- CCXT +- Trending Coins +- Liquidity Measurement +- Coin Ranking +--- + +The Crypto module wraps the functions of the OpenBB Terminal menu. This allows web applications and dashboards to be built quickly on top of the existing infrastructure. Navigating the functions is similar to operating the OpenBB Terminal. + +## How to Use + +The list below are all the SDK functions at the `openbb.crypto` level: + +| Path | Type | Description | +| :-------------------- | :--------: | --------------------: | +| openbb.crypto.candle | Function | OHLC+V chart | +| openbb.crypto.dd | Sub-Module | Due Diligence | +| openbb.crypto.defi | Sub-Module | DeFi | +| openbb.crypto.disc | Sub-Module | Discovery | +| openbb.crypto.find | Function | Find Digital Assets | +| openbb.crypto.load | Function | Load Historical Data | +| openbb.crypto.nft | Sub-Module | NFTs | +| openbb.crypto.onchain | Sub-Module | Onchain Metrics | +| openbb.crypto.ov | Sub-Module | Market Overview | +| openbb.crypto.price | Function | Live Prices from Pyth | +| openbb.crypto.tools | Sub-Module | Calculators | + +Alternatively, the contents of a menu is printed by running, `help(openbb.crypto)`. The objective of this guide is to introduce the high-level functions and provide a sample of examples from the sub-modules. Refer to the guides for each sub-module to learn more about them specifically. + +## Examples + +### Import Statements + +The examples in this guide will assume that the code block below is at the beginning of the Python script or Jupyter Notebook file. + +```python +import pandas as pd +from openbb_terminal.sdk import openbb +%matplotlib inline +``` + +### Load + +The `load` function is capable of loading from a variety of sources, one of which is CCXT. When `CCXT` is `source`, an additional argument, `exchange`, is required. + +```python +help(openbb.crypto.load) + +Help on Operation in module openbb_terminal.core.library.operation: + + + Load crypto currency to get data for + + Parameters + ---------- + symbol: str + Coin to get + start_date: str or datetime, optional + Start date to get data from with. - datetime or string format (YYYY-MM-DD) + 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: str or datetime, optional + End date to get data from with. - datetime or string format (YYYY-MM-DD) + source: str + The source of the data + Choose from: CCXT, CoinGecko, YahooFinance + + Returns + ------- + pd.DataFrame + Dataframe consisting of price and volume data +``` + +
+ CCXT Exchange List (expand to see list of exchanges supported by CCXT) + +| | Exchange | +| --- | -----------------: | +| | aax | +| | ascendex | +| | bequant | +| | bibox | +| | bigone | +| | binance | +| | binancecoinm | +| | binanceus | +| | binanceusdm | +| | bit2c | +| | bitbank | +| | bitbay | +| | bitcoincom | +| | bitfinex | +| | bitfinex2 | +| | bitflyer | +| | bitforex | +| | bitget | +| | bithumb | +| | bitmart | +| | bitmex | +| | bitopro | +| | bitpanda | +| | bitrue | +| | bitso | +| | bitstamp | +| | bitstamp1 | +| | bittrex | +| | bitvavo | +| | bkex | +| | bl3p | +| | btcalpha | +| | btcbox | +| | btcex | +| | btcmarkets | +| | btctradeua | +| | btcturk | +| | buda | +| | bw | +| | bybit | +| | bytetrade | +| | cex | +| | coinbaseprime | +| | coinbasepro | +| | coincheck | +| | coinex | +| | coinfalcon | +| | coinmate | +| | coinone | +| | coinspot | +| | crex24 | +| | cryptocom | +| | currencycom | +| | delta | +| | deribit | +| | digifinex | +| | eqonex | +| | exmo | +| | flowbtc | +| | fmfwio | +| | ftx | +| | ftxus | +| | gate | +| | gateio | +| | gemini | +| | hitbtc | +| | bitbtc3 | +| | hollaex | +| | huobi | +| | huobijp | +| | idex | +| | independentreserve | +| | indodax | +| | itbit | +| | kraken | +| | kucoin | +| | kucoinfutures | +| | kuna | +| | latoken | +| | lbank | +| | lbank2 | +| | liquid | +| | luno | +| | lykke | +| | mercado | +| | mexc | +| | mexc3 | +| | ndax | +| | novadax | +| | oceanex | +| | okcoin | +| | okex | +| | okex5 | +| | okx | +| | paymium | +| | phemex | +| | poloniex | +| | probit | +| | qtrade | +| | ripio | +| | stex | +| | therock | +| | tidebit | +| | tidex | +| | timex | +| | tokocrypto | +| | upbit | +| | wavesexchange | +| | whitebit | +| | woo | +| | yobit | +| | zaif | +| | zb | +| | zipmex | +| | zonda | + +
+ +```python +eth_df = openbb.crypto.load('ETH', source = 'CCXT', exchange = 'binance') + +eth_df.tail(5) +``` + +| date | Open | High | Low | Close | Volume | +| :------------------ | ------: | ------: | ------: | ------: | -----: | +| 2022-11-14 00:00:00 | 1221.5 | 1291.2 | 1171.13 | 1243.28 | 934742 | +| 2022-11-15 00:00:00 | 1243.29 | 1291 | 1234.01 | 1253.23 | 632826 | +| 2022-11-16 00:00:00 | 1253.22 | 1268.67 | 1187.06 | 1216.17 | 673340 | +| 2022-11-17 00:00:00 | 1216.16 | 1228.22 | 1181.05 | 1200.43 | 530537 | +| 2022-11-18 00:00:00 | 1200.42 | 1234 | 1199.18 | 1206.11 | 306400 | + +Adding the `interval` argument allows for intraday data or weekly/monthly periods to be loaded. + +```python +eth_df = openbb.crypto.load('ETH', source = 'CCXT', exchange = 'binance', interval = '30') + +eth_df.tail(3) +``` + +| date | Open | High | Low | Close | Volume | +| :------------------ | ------: | ------: | ------: | ------: | ------: | +| 2022-11-18 17:00:00 | 1207.44 | 1208.35 | 1200.36 | 1205.35 | 11359.4 | +| 2022-11-18 17:30:00 | 1205.36 | 1207.12 | 1202.5 | 1204.17 | 5878.59 | +| 2022-11-18 18:00:00 | 1204.17 | 1207.28 | 1203.26 | 1206.37 | 1540.67 | + +Loading monthly OHLC+V data looks like this: + +```python +eth_df = openbb.crypto.load('ETH', source = 'CCXT', exchange = 'binance', interval = '43200') + +eth_df.tail(3) +``` + +| date | Open | High | Low | Close | Volume | +| :------------------ | ------: | ------: | ------: | ------: | ----------: | +| 2022-09-01 00:00:00 | 1554.11 | 1789 | 1220 | 1328.72 | 2.25453e+07 | +| 2022-10-01 00:00:00 | 1328.71 | 1663.06 | 1190 | 1572.69 | 1.67681e+07 | +| 2022-11-01 00:00:00 | 1572.69 | 1680 | 1073.53 | 1204.78 | 1.6707e+07 | + +### Candles + +A loaded DataFrame is used as the input for the `candles` function: + +```python +openbb.crypto.candle(eth_df) +``` + +![openbb.crypto.candle](https://user-images.githubusercontent.com/85772166/202791587-d69c7568-69ff-46b3-b41f-146ed8796f7e.png "openbb.crypto.candle") + +Notice that the chart has no title. It can be added using the `title` argument. + +```python +openbb.crypto.candles(eth_df, title = 'ETH/USDT (Monthly)') +``` + +![openbb.crypto.candle](https://user-images.githubusercontent.com/85772166/202791726-b4a775d9-5a00-4d92-8fbc-bd26aeff62d2.png "openbb.crypto.candle") + +### Find + +Find similar coins by name, symbol, or ID. + +```python +results = openbb.crypto.find( + query = 'Genesis', + source = 'CoinPaprika', + key = 'name', +) + +results.head(5) +``` + +| | name | rank | id | symbol | type | +| --: | :------------ | ---: | :----------------- | :----- | :---- | +| 0 | Gnosis | 124 | gno-gnosis | GNO | token | +| 1 | Gene | 4696 | gene-gene | GENE | token | +| 2 | Nemesis | 4246 | nms-nemesis | NMS | token | +| 3 | Genesis Token | 7763 | gent-genesis-token | GENT | token | +| 4 | Alpha Genesis | 4732 | agen-alpha-genesis | AGEN | token | + +### Active Addresses + +Get the historical number of active wallet addresses for a token with: `openbb.crypto.dd.active`. + +```python +active_eth = openbb.crypto.dd.active(symbol = 'ETH', interval = '24h', start_date = '2017-09-01') +active_eth = active_eth.reset_index() +active_eth.rename(columns = {'v': 'Active Addresses', 't': 'Date'}, inplace = True) +active_eth.set_index(keys = ['Date'], inplace = True) + +active_eth.tail(5) +``` + +| Date | Active Addresses | +| :------------------ | ---------------: | +| 2022-11-13 00:00:00 | 426441 | +| 2022-11-14 00:00:00 | 474868 | +| 2022-11-15 00:00:00 | 469880 | +| 2022-11-16 00:00:00 | 448492 | +| 2022-11-17 00:00:00 | 463467 | + +### Trades + +Get trade-level data from a specific exchange with: `openbb.crypto.dd.trades` + +```python +trades_ethusdt = openbb.crypto.dd.trades(exchange_id = 'binance', symbol = 'ETH', to_symbol = 'USDT') + +trades_ethusdt.tail(5) +``` + +| | Date | Price | Amount | Cost | Side | +| --: | :------------------------------- | ------: | -----: | ------: | :--- | +| 495 | 2022-11-18 19:16:15.959000+00:00 | 1204.02 | 2.7033 | 3254.83 | buy | +| 496 | 2022-11-18 19:16:15.959000+00:00 | 1204.03 | 1.1769 | 1417.02 | buy | +| 497 | 2022-11-18 19:16:15.981000+00:00 | 1204.03 | 5.0493 | 6079.51 | buy | +| 498 | 2022-11-18 19:16:15.981000+00:00 | 1204.07 | 2.1126 | 2543.72 | buy | +| 499 | 2022-11-18 19:16:15.981000+00:00 | 1204.08 | 5.2811 | 6358.87 | buy | + +Use the `exchange_id` argument to return data from other venues, such as CoinBase. + +```python +trades_ethusdt = openbb.crypto.dd.trades(exchange_id = 'coinbaseprime', symbol = 'ETH', to_symbol = 'USDT') + +trades_ethusdt.tail(5) +``` + +| | Date | Price | Amount | Cost | Side | +| --: | :------------------------------- | ------: | -------: | ----------: | :--- | +| 995 | 2022-11-18 19:20:15.176000+00:00 | 1204.65 | 3.89878 | 4696.67 | sell | +| 996 | 2022-11-18 19:20:29.524000+00:00 | 1204.78 | 0.41545 | 500.526 | buy | +| 997 | 2022-11-18 19:20:29.931000+00:00 | 1204.78 | 6.2e-07 | 0.000746964 | buy | +| 998 | 2022-11-18 19:20:32.263000+00:00 | 1205.03 | 0.41536 | 500.521 | buy | +| 999 | 2022-11-18 19:20:32.274000+00:00 | 1205.03 | 3.05e-06 | 0.00367534 | buy | + +### Coin_List + +Retrieve a list of all coins available from CoinPaprika with: `openbb.crypto.ov.coin_list()` + +```python +coins = openbb.crypto.ov.coin_list() + +coins.head(10) +``` + +| | rank | id | name | symbol | type | +| --: | ---: | :--------------- | :----------- | :----- | :---- | +| 0 | 1 | btc-bitcoin | Bitcoin | BTC | coin | +| 1 | 2 | eth-ethereum | Ethereum | ETH | coin | +| 2 | 3 | usdt-tether | Tether | USDT | token | +| 3 | 4 | usdc-usd-coin | USD Coin | USDC | token | +| 4 | 5 | bnb-binance-coin | Binance Coin | BNB | coin | +| 5 | 6 | busd-binance-usd | Binance USD | BUSD | token | +| 6 | 7 | xrp-xrp | XRP | XRP | coin | +| 7 | 8 | doge-dogecoin | Dogecoin | DOGE | coin | +| 8 | 9 | ada-cardano | Cardano | ADA | coin | +| 9 | 10 | hex-hex | HEX | HEX | token | + +### BAAS (Historical Bid-Ask Average Spread) + +Measure liquidity over time for an asset with: `openbb.crypto.onchain.baas` + +```python +openbb.crypto.onchain.baas(symbol = 'ETH', to_symbol = 'USDT') +``` + +| | Date | Base currency | Quote currency | Daily spread | Average bid price | Average ask price | +| --: | :--------- | :------------ | :------------- | -----------: | ----------------: | ----------------: | +| 0 | 2022-11-08 | ETH | USDT | 26.7961 | 1480.72 | 1453.93 | +| 1 | 2022-11-09 | ETH | USDT | 87.9466 | 1255.58 | 1167.63 | +| 2 | 2022-11-10 | ETH | USDT | 24.8262 | 1248.8 | 1273.62 | +| 3 | 2022-11-11 | ETH | USDT | 365.65 | 877.792 | 1243.44 | +| 4 | 2022-11-13 | ETH | USDT | 23.2032 | 1240.23 | 1217.02 | +| 5 | 2022-11-14 | ETH | USDT | 22.5726 | 1221.92 | 1199.35 | + +### Trending + +Discover trending coins on CoinGecko with: `openbb.crypto.disc.trending()` + +```python +openbb.crypto.disc.trending() +``` + +| | Symbol | Name | market_cap Cap Rank | +| --: | :------------ | :------------------ | ------------------: | +| 0 | solana | Solana | 16 | +| 1 | chiliz | Chiliz | 36 | +| 2 | aptos | Aptos | 64 | +| 3 | elrond-erd-2 | MultiversX (Elrond) | 43 | +| 4 | algorand | Algorand | 29 | +| 5 | matic-network | Polygon | 10 | +| 6 | media-network | Media Network | 890 | + +### News + +Get crypto-focussed news with: `openbb.crypto.ov.news` + +```python +openbb.crypto.ov.news(post_kind = 'news',region = 'en', filter_= 'important', ascend = False) +``` + +| | published_at | domain | title | negative_votes | positive_votes | link | +| --: | :----------- | :----------------- | :----------------------------------------------------------------- | -------------: | -------------: | :------------------------------------------------------------------------------------------------------------------------------------------------ | +| 0 | 2022-11-18 | decrypt.co | Edward Snowden: Sanctioning of Ethereum Mixer Tornado Cash Was | 0 | 2 | https://cryptopanic.com/news/16935211/Edward-Snowden-Sanctioning-of-Ethereum-Mixer-Tornado-Cash-Was-Deeply-Illiberal-and-Profoundly-Authoritarian | +| | | | 'Deeply Illiberal and Profoundly Authoritarian' | | | | +| 10 | 2022-11-18 | theblockcrypto.com | Cardano developer Emurgo to issue fiat-pegged stablecoin called | 3 | 21 | https://cryptopanic.com/news/16933998/Cardano-developer-Emurgo-to-issue-fiat-pegged-stablecoin-called-USDA | +| | | | USDA | | | | +| 1 | 2022-11-18 | beincrypto.com | SHIB Army Remains Positive as Memecoin Social Sentiment Index | 0 | 3 | https://cryptopanic.com/news/16935115/SHIB-Army-Remains-Positive-as-Memecoin-Social-Sentiment-Index-Remains-Positive | +| | | | Remains Positive | | | | +| 17 | 2022-11-18 | u.today | Is El Salvador's President's Decision to Buy One Bitcoin per Day a | 2 | 48 | https://cryptopanic.com/news/16925762/Is-El-Salvadors-Presidents-Decision-to-Buy-One-Bitcoin-per-Day-a-Good-Idea | +| | | | Good Idea? | | | | +| 15 | 2022-11-18 | dailyhodl.com | ‘Secret’ Altcoin Goes Parabolic After Rumors of European Ban on | 0 | 3 | https://cryptopanic.com/news/16925942/Secret-Altcoin-Goes-Parabolic-After-Rumors-of-European-Ban-on-Privacy-Coins-Swirl | +| | | | Privacy Coins Swirl | | | | +| 74 | 2022-11-15 | cryptopotato.com | OKX Announces $100 Million Fund to Support Distressed Projects | 0 | 4 | https://cryptopanic.com/news/16903760/OKX-Announces-100-Million-Fund-to-Support-Distressed-Projects-Following-FTX-Crash-Report | +| | | | Following FTX Crash (Report) | | | | +| 73 | 2022-11-15 | cointelegraph.com | Thousands petition for congressional investigation of alleged | 1 | 36 | https://cryptopanic.com/news/16904296/Thousands-petition-for-congressional-investigation-of-alleged-GenslerSBF-links | +| | | | Gensler–SBF links | | | | +| 72 | 2022-11-15 | cryptonews.com | XRP Price Forecast as XRP Pumps 9%, Becomes Top Performer | 0 | 13 | https://cryptopanic.com/news/16904392/XRP-Price-Forecast-as-XRP-Pumps-9-Becomes-Top-Performer | +| 71 | 2022-11-15 | theblockcrypto.com | Kraken’s Ogilvie says staking adoption set to skyrocket | 0 | 4 | https://cryptopanic.com/news/16904805/Krakens-Ogilvie-says-staking-adoption-set-to-skyrocket | +| 79 | 2022-11-15 | zycrypto.com | SEC vs. Ripple Case Sees New Twists And Turns As Whale Holdings In | 2 | 15 | https://cryptopanic.com/news/16903258/SEC-vs-Ripple-Case-Sees-New-Twists-And-Turns-As-Whale-Holdings-In-XRP-Skyrocket | +| | | | XRP Skyrocket | | | | diff --git a/website/content/sdk/data-available/econometrics.md b/website/content/sdk/data-available/econometrics.md new file mode 100644 index 000000000000..7f1b50c68b40 --- /dev/null +++ b/website/content/sdk/data-available/econometrics.md @@ -0,0 +1,407 @@ +--- +title: Econometrics +description: This documentation page guides users in the usage of the openbb Terminal's + Econometrics menu that allows users to load, modify, and perform statistical tests + on their datasets via a powerful SDK. The article explains the process of running + various regression models, performing tests on residuals, and how to overcome potential + errors during the process. +keywords: +- openbb Terminal +- Econometrics menu +- statistical tests +- regression models +- OLS regression +- Panel regression +- Custom datasets +- Descriptive Statistics +- Unit root +- Multicollinearity +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +The capabilities of the [Econometrics menu](/terminal/data-available/econometrics) in the OpenBB Terminal are wrapped into a powerful SDK, enabling users to work with the data in a flexible environment that can be fully customized to meet the needs of any user. The Econometrics menu's purpose is to provide the user the ability to perform statistical research on custom datasets. The menu allows the user to load in his/her own dataset(s), modify the data by adding columns or setting indices, apply statistical tests (e.g. Breusch-Godfrey autocorrelation tests) as well as OLS regressions and Panel regressions (e.g. Random Effects and Fixed Effects) + +## How to use + +Start a Python script or Notebook file and import the SDK module: + +```python +from openbb_terminal.sdk import openbb +``` + +Below is a brief description of each function within the Portfolio module: + +| Path | Type | Description | +| :-------------------------------------- | :------: | ---------------------------------------------------------------------: | +| openbb.econometrics.granger | Function | Check time-series for Granger causality (X causes Y) | +| openbb.econometrics.granger_chart | Function | Obtain a nice table of Granger causality | +| openbb.econometrics.fe | Function | Perform a Fixed Effects (fe) regression on Panel data | +| openbb.econometrics.options | Function | Obtain all options that can be used for regression techniques | +| openbb.econometrics.options_chart | Function | Get a nice table of the options | +| openbb.econometrics.dwat | Function | Check for auto-correlation with Durbin Watson | +| openbb.econometrics.dwat_chart | Function | Plot the residuals of the OLS model | +| openbb.econometrics.coint | Function | Check whether time-series are cointegrated | +| openbb.econometrics.coint_chart | Function | Show the error-correction terms plot | +| openbb.econometrics.pols | Function | Perform a Pooled OLS (pols) regression on Panel data | +| openbb.econometrics.root | Function | Check for unit root in the timeseries | +| openbb.econometrics.root_chart | Function | Show a nice table of the unit root test results | +| openbb.econometrics.bgod | Function | Check for autocorrelation with Breusch Godfrey | +| openbb.econometrics.bgod_chart | Function | Show a nice table of the autocorrelation test results | +| openbb.econometrics.re | Function | Perform a Random Effects (re) regression on Panel data | +| openbb.econometrics.bols | Function | Perform a Between OLS (bols) regression on Panel data | +| openbb.econometrics.panel | Function | Obtain the regression results wrapper | +| openbb.econometrics.get_regression_data | Function | Obtain an OLS model wrapper | +| openbb.econometrics.norm | Function | Check whether the time-series is normally distributed | +| openbb.econometrics.norm_chart | Function | Show a histogram of the time-series | +| openbb.econometrics.clean | Function | Apply either a fill or drop method to clean the data | +| openbb.econometrics.bpag | Function | Test for heteroskedasticity with a Breusch-Pagan test | +| openbb.econometrics.bpag_chart | Function | Get a nice table with Breusch-Pagan test results | +| openbb.econometrics.fdols | Function | Perform a First Difference OLS (fdols) regression on Panel data | +| openbb.econometrics.load | Function | Load in a dataset to be used within other functionalities | +| openbb.econometrics.ols | Function | Perform an Ordinary Least Squares (ols) regression on time-series data | +| openbb.econometrics.comparison | Function | Compare different regression models in one table | + +Alternatively you can print the contents of the Econometrics SDK with: + +```python +help(openbb.econometrics) +``` + +## Examples + +### Loading a dataset + +The first step in using this menu is loading a dataset. This can be either an example dataset, see the list below, or any locally stored Excel file. To demonstrate the usage of the menu, the longley + dataset is loaded in. This can be done with the following + +```python +example_load = openbb.econometrics.load("anes96") +file_load = openbb.econometric.load("PATH_TO_FILE/FILE.xlsx") +``` + +| File | Description | +| :----------------- | --------------------------------------------------------: | +| anes96 | American National Election Survey 1996 | +| cancer | Breast Cancer Data | +| ccard | Bill Greene’s credit scoring data. | +| cancer_china | Smoking and lung cancer in eight cities in China. | +| co2 | Mauna Loa Weekly Atmospheric CO2 Data | +| committee | First 100 days of the US House of Representatives 1995 | +| copper | World Copper Market 1951-1975 Dataset | +| cpunish | US Capital Punishment dataset. | +| danish_data | Danish Money Demand Data | +| elnino | El Nino - Sea Surface Temperatures | +| engel | Engel (1857) food expenditure data | +| fair | Affairs dataset | +| fertility | World Bank Fertility Data | +| grunfeld | Grunfeld (1950) Investment Data | +| heart | Transplant Survival Data | +| interest_inflation | (West) German interest and inflation rate 1972-1998 | +| longley | Longley dataset | +| macrodata | United States Macroeconomic data | +| modechoice | Travel Mode Choice | +| nile | Nile River flows at Ashwan 1871-1970 | +| randhie | RAND Health Insurance Experiment Data | +| scotland | Taxation Powers Vote for the Scottish Parliament 1997 | +| spector | Spector and Mazzeo (1980) - Program Effectiveness Data | +| stackloss | Stack loss data | +| star98 | Star98 Educational Dataset | +| statecrim | Statewide Crime Data 2009 | +| strikes | U.S. Strike Duration Data | +| sunspots | Yearly sunspots data 1700-2008 | +| wage_panel | Veila and M. Verbeek (1998): Whose Wages Do Unions Raise? | + +### Working with Time Series data + +To demonstrate the usage of the Econometrics SDK for time series data, the +longley dataset is loaded in. + +```python +# Load the data +longley = openbb.econometrics.load("longley") + +# Show the data +longley +``` + +| | TOTEMP | GNPDEFL | GNP | UNEMP | ARMED | POP | YEAR | +| --: | -----: | ------: | -----: | ----: | ----: | -----: | ---: | +| 0 | 60323 | 83 | 234289 | 2356 | 1590 | 107608 | 1947 | +| 1 | 61122 | 88.5 | 259426 | 2325 | 1456 | 108632 | 1948 | +| 2 | 60171 | 88.2 | 258054 | 3682 | 1616 | 109773 | 1949 | +| 3 | 61187 | 89.5 | 284599 | 3351 | 1650 | 110929 | 1950 | +| 4 | 63221 | 96.2 | 328975 | 2099 | 3099 | 112075 | 1951 | +| 5 | 63639 | 98.1 | 346999 | 1932 | 3594 | 113270 | 1952 | +| 6 | 64989 | 99 | 365385 | 1870 | 3547 | 115094 | 1953 | +| 7 | 63761 | 100 | 363112 | 3578 | 3350 | 116219 | 1954 | +| 8 | 66019 | 101.2 | 397469 | 2904 | 3048 | 117388 | 1955 | +| 9 | 67857 | 104.6 | 419180 | 2822 | 2857 | 118734 | 1956 | +| 10 | 68169 | 108.4 | 442769 | 2936 | 2798 | 120445 | 1957 | +| 11 | 66513 | 110.8 | 444546 | 4681 | 2637 | 121950 | 1958 | +| 12 | 68655 | 112.6 | 482704 | 3813 | 2552 | 123366 | 1959 | +| 13 | 69564 | 114.2 | 502601 | 3931 | 2514 | 125368 | 1960 | +| 14 | 69331 | 115.7 | 518173 | 4806 | 2572 | 127852 | 1961 | +| 15 | 70551 | 116.9 | 554894 | 4007 | 2827 | 130081 | 1962 | + +This can be extended by also showing the descriptive statistics, this can be +done with a native command from Pandas as follows: + +```python +longley.describe() +``` + +| | TOTEMP | GNPDEFL | GNP | UNEMP | ARMED | POP | YEAR | +| :---- | ------: | ------: | ------: | ------: | ------: | -----: | ------: | +| count | 16 | 16 | 16 | 16 | 16 | 16 | 16 | +| mean | 65317 | 101.681 | 387698 | 3193.31 | 2606.69 | 117424 | 1954.5 | +| std | 3511.97 | 10.7916 | 99394.9 | 934.464 | 695.92 | 6956.1 | 4.76095 | +| min | 60171 | 83 | 234289 | 1870 | 1456 | 107608 | 1947 | +| 25% | 62712.5 | 94.525 | 317881 | 2348.25 | 2298 | 111788 | 1950.75 | +| 50% | 65504 | 100.6 | 381427 | 3143.5 | 2717.5 | 116804 | 1954.5 | +| 75% | 68290.5 | 111.25 | 454086 | 3842.5 | 3060.75 | 122304 | 1958.25 | +| max | 70551 | 116.9 | 554894 | 4806 | 3594 | 130081 | 1962 | + +It is possible to check for a variety of assumptions, e.g. normality, unit root, +granger and co-integration. The functions `openbb.econometric.norm` and `openb.econometrics.root` are shown below. Note +that due to the small size of the dataset, many of these tests are not +statistically significant. + +```python +openbb.econometrics.norm(longley['GNP']) +``` + +| | Kurtosis | Skewness | Jarque-Bera | Shapiro-Wilk | Kolmogorov-Smirnov | +| :-------- | -------: | --------: | ----------: | -----------: | -----------------: | +| Statistic | -1.1944 | 0.0525317 | 0.835092 | 0.962593 | 1 | +| p-value | 0.23232 | 0.95811 | 0.65866 | 0.709 | 0 | + +```python +openbb.econometrics.root(longley['POP']) +``` + +| | ADF | KPSS | +| :------------- | -------: | -------: | +| Test Statistic | 2.35204 | 0.324887 | +| P-Value | 0.998986 | 0.1 | +| NLags | 6 | 0 | +| Nobs | 9 | 0 | +| ICBest | 113.054 | 0 | + +The longley dataset is known for the ability to create an OLS regression that results in a R-squared of 1.0 due to the fact that the US macroeconomic variables are known to be highly collinear. See the following regression performed with `openbb.econometrics.ols` as follows: + +```python +# Perform the regression technique. TOTEMP is dependent, all others independent +ols_regression = openbb.econometrics.ols(longley['TOTEMP'], longley.drop('TOTEMP', axis=1)) + +# Show the model summary +ols_regression.summary() +``` + +``` + OLS Regression Results +======================================================================================= +Dep. Variable: TOTEMP R-squared (uncentered): 1.000 +Model: OLS Adj. R-squared (uncentered): 1.000 +Method: Least Squares F-statistic: 5.052e+04 +Date: Mon, 21 Nov 2022 Prob (F-statistic): 8.20e-22 +Time: 10:54:19 Log-Likelihood: -117.56 +No. Observations: 16 AIC: 247.1 +Df Residuals: 10 BIC: 251.8 +Df Model: 6 +Covariance Type: nonrobust +============================================================================== + coef std err t P>|t| [0.025 0.975] +------------------------------------------------------------------------------ +GNPDEFL -52.9936 129.545 -0.409 0.691 -341.638 235.650 +GNP 0.0711 0.030 2.356 0.040 0.004 0.138 +UNEMP -0.4235 0.418 -1.014 0.335 -1.354 0.507 +ARMED -0.5726 0.279 -2.052 0.067 -1.194 0.049 +POP -0.4142 0.321 -1.289 0.226 -1.130 0.302 +YEAR 48.4179 17.689 2.737 0.021 9.003 87.832 +============================================================================== +Omnibus: 1.443 Durbin-Watson: 1.277 +Prob(Omnibus): 0.486 Jarque-Bera (JB): 0.605 +Skew: 0.476 Prob(JB): 0.739 +Kurtosis: 3.031 Cond. No. 4.56e+05 +============================================================================== + +Notes: +[1] R² is computed without centering (uncentered) since the model does not contain a constant. +[2] Standard Errors assume that the covariance matrix of the errors is correctly specified. +[3] The condition number is large, 4.56e+05. This might indicate that there are +strong multicollinearity or other numerical problems. +``` + +After running the regression estimation, it is possible to perform tests on the residuals of the model. E.g. for autocorrelation and heteroscedasity as shown below with the `openbb.econometrics.bgod` and `openbb.econometrics.bpag` functions. + +```python +# Perform Breusch Goodfrey auto-correlation test +openbb.econometrics.bgod(ols_regression) +``` + +| | 0 | +| :------- | --------: | +| lm-stat | 10.3471 | +| p-value | 0.0158347 | +| f-stat | 0.0970889 | +| fp-value | 0.958799 | + +```python +# Perform Breusch Pagan heteroskedacity test +openbb.econometrics.bpag(ols_regression) +``` + +| | 0 | +| :------- | -------: | +| lm-stat | 7.90331 | +| p-value | 0.161645 | +| f-stat | 1.62686 | +| fp-value | 0.236596 | + +### Working with Panel data + +Within the examples there is one panel dataset available named `wage_panel`. This is a dataset from the paper by Vella and M. Verbeek (1998), “Whose Wages Do Unions Raise? A Dynamic Model of Unionism and Wage Rate Determination for Young Men,” Journal of Applied Econometrics 13, 163-183. This is a well-known dataset also used within Chapter 14 of Introduction to Econometrics by Jeffrey Wooldridge. + +```python +# Load the data +wage_panel = openbb.econometrics.load("wage_panel") + +# Show the data +wage_panel +``` + +| | nr | year | black | exper | hisp | hours | married | educ | union | lwage | expersq | occupation | +| --: | --: | ---: | ----: | ----: | ---: | ----: | ------: | ---: | ----: | ------: | ------: | ---------: | +| 0 | 13 | 1980 | 0 | 1 | 0 | 2672 | 0 | 14 | 0 | 1.19754 | 1 | 9 | +| 1 | 13 | 1981 | 0 | 2 | 0 | 2320 | 0 | 14 | 1 | 1.85306 | 4 | 9 | +| 2 | 13 | 1982 | 0 | 3 | 0 | 2940 | 0 | 14 | 0 | 1.34446 | 9 | 9 | +| 3 | 13 | 1983 | 0 | 4 | 0 | 2960 | 0 | 14 | 0 | 1.43321 | 16 | 9 | +| 4 | 13 | 1984 | 0 | 5 | 0 | 3071 | 0 | 14 | 0 | 1.56812 | 25 | 5 | + +4360 rows × 12 columns + +To run panel regressions, it is important to define both _entity_ (e.g. company) and _time_ (e.g. year). +Trying to run the `openbb.econometrics.re` function would right now result in the following: + +``` +openbb.econometrics.re(wage_panel['black'], wage_panel.drop('black', axis=1)) + +Error: Series can only be used with a 2-level MultiIndex +``` + +This can be corrected by setting a multi-index, this can be done with the following: + +```python +wage_panel = wage_panel.set_index(['nr', 'year'], drop=False) +``` + +The columns `nr` and `year` still exists within the dataset and could have been dropped with the if desired. However, in this case the `year` column is relevant for generating time effects in Pooled OLS, Fixed Effects and Random Effects estimations. To be able to do this, the type of the year column needs to be changed accordingly to 'category' so it is perceived as categorical data. This can be done with the following: + +```python +# Observe the current types +wage_panel.dtypes +``` + +| | 0 | +| :--------- | :------ | +| nr | int64 | +| year | int64 | +| black | int64 | +| exper | int64 | +| hisp | int64 | +| hours | int64 | +| married | int64 | +| educ | int64 | +| union | int64 | +| lwage | float64 | +| expersq | int64 | +| occupation | int64 | + +```python +# Change the type of year to categorical +wage_panel['year'] = wage_panel['year'].astype('category') + +# Observe the changed types +wage_panel.dtypes +``` + +| | 0 | +| :--------- | :------- | +| nr | int64 | +| year | category | +| black | int64 | +| exper | int64 | +| hisp | int64 | +| hours | int64 | +| married | int64 | +| educ | int64 | +| union | int64 | +| lwage | float64 | +| expersq | int64 | +| occupation | int64 | + +The dataset is now properly configured to allow for proper panel regressions. The Econometrics SDK supports the following regression techniques. + +| Path | Description | +| :------------------------ | ---------------------------------------------------------------------: | +| openbb.econometrics.ols | Perform an Ordinary Least Squares (ols) regression on time-series data | +| openbb.econometrics.pols | Perform a Pooled OLS (pols) regression on Panel data | +| openbb.econometrics.bols | Perform a Between OLS (bols) regression on Panel data | +| openbb.econometrics.fdols | Perform a First Difference OLS (fdols) regression on Panel data | +| openbb.econometrics.fe | Perform a Fixed Effects (fe) regression on Panel data | +| openbb.econometrics.re | Perform a Random Effects (re) regression on Panel data | + +As an example, a **Random Effects** regression is performed. This can be done as follows: + +```python +# Perform the Random Effects regression technique +random_effects_regression = openbb.econometrics.re(wage_panel['lwage'], wage_panel[['black', 'hisp', 'exper', 'expersq', 'married', 'educ', 'union','year']]) + +# Show the results +random_effects_regression.summary +``` + +``` + RandomEffects Estimation Summary +================================================================================ +Dep. Variable: lwage R-squared: 0.1806 +Estimator: RandomEffects R-squared (Between): 0.1853 +No. Observations: 4360 R-squared (Within): 0.1799 +Date: Mon, Nov 21 2022 R-squared (Overall): 0.1828 +Time: 11:13:36 Log-likelihood -1622.5 +Cov. Estimator: Unadjusted + F-statistic: 68.409 +Entities: 545 P-value 0.0000 +Avg Obs: 8.0000 Distribution: F(14,4345) +Min Obs: 8.0000 +Max Obs: 8.0000 F-statistic (robust): 68.409 + P-value 0.0000 +Time periods: 8 Distribution: F(14,4345) +Avg Obs: 545.00 +Min Obs: 545.00 +Max Obs: 545.00 + + Parameter Estimates +============================================================================== + Parameter Std. Err. T-stat P-value Lower CI Upper CI +------------------------------------------------------------------------------ +const 0.0234 0.1514 0.1546 0.8771 -0.2735 0.3203 +black -0.1394 0.0480 -2.9054 0.0037 -0.2334 -0.0453 +hisp 0.0217 0.0428 0.5078 0.6116 -0.0622 0.1057 +exper 0.1058 0.0154 6.8706 0.0000 0.0756 0.1361 +expersq -0.0047 0.0007 -6.8623 0.0000 -0.0061 -0.0034 +married 0.0638 0.0168 3.8035 0.0001 0.0309 0.0967 +educ 0.0919 0.0107 8.5744 0.0000 0.0709 0.1129 +union 0.1059 0.0179 5.9289 0.0000 0.0709 0.1409 +year.1981 0.0404 0.0247 1.6362 0.1019 -0.0080 0.0889 +year.1982 0.0309 0.0324 0.9519 0.3412 -0.0327 0.0944 +year.1983 0.0202 0.0417 0.4840 0.6284 -0.0616 0.1020 +year.1984 0.0430 0.0515 0.8350 0.4037 -0.0580 0.1440 +year.1985 0.0577 0.0615 0.9383 0.3482 -0.0629 0.1782 +year.1986 0.0918 0.0716 1.2834 0.1994 -0.0485 0.2321 +year.1987 0.1348 0.0817 1.6504 0.0989 -0.0253 0.2950 +============================================================================== +``` diff --git a/website/content/sdk/data-available/economy.md b/website/content/sdk/data-available/economy.md new file mode 100644 index 000000000000..bf1e554f1268 --- /dev/null +++ b/website/content/sdk/data-available/economy.md @@ -0,0 +1,373 @@ +--- +title: Economy +description: This page offers detailed instructions and examples on how to use the + Economy module of the OpenBB terminal. This module provides user-friendly control + over various financial and economic functionalities and metrics, enabling users + to streamline their workflows in areas such as the management of API keys, data + analysis with the many available functions, and querying data from prominent economic + and financial databases including FRED and AlphaVantage. +keywords: +- Economy +- jupyter notebook +- API +- FRED +- AlphaVantage +- Financial analysis +- Data Visualization +- Quandl +- Nasdaq +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +The Economy module wraps the functions from the Economy menu of the OpenBB Terminal, and provides the user with more control over their workflow. In a Jupyter Notebook environment, it is quick and easy to get going. To get the most out of these functions, it is highly recommended to acquire API keys for: + +- [FRED](https://fred.stlouisfed.org) +- [Quandl/Nasdaq Data Link](https://data.nasdaq.com) +- [AlphaVantage](https://www.alphavantage.co/) + +Define the keys for the OpenBB installation with: + +```python + +openbb.keys.fred(key = 'REPLACE_ME', persist = True) +openbb.keys.quandl(key = 'REPLACE_ME', persist = True) +openbb.keys.av(key = 'REPLACE_ME', persist = True) +``` + +## How to Use + +Below is brief description of each function within the Economy module: + +| Path | Type | Description | +| :---------------------------------- | :--------: | -------------------------------------------------------------: | +| openbb.economy.available_indices | Dictionary | Curated List of Global Indices | +| openbb.economy.balance | Function | Global Government Deficit/Surplus | +| openbb.economy.balance_chart | Function | Chart for `balance` | +| openbb.economy.bigmac | Function | The Big Mac Index | +| openbb.economy.bigmac_chart | Function | Chart for `bigmac` | +| openbb.economy.ccpi | Function | CPI Components Data by Country | +| openbb.economy.ccpi_chart | Function | Chart for `ccpi` | +| openbb.economy.country_codes | Function | List of Three-Letter ISO Country Codes | +| openbb.economy.cpi | Function | Harmonized CPI Data by Country | +| openbb.economy.cpi_chart | Function | Chart for `cpi` | +| openbb.economy.currencies | Function | Currencies from WSJ | +| openbb.economy.debt | Function | Government Debt-to-GDP Ratio | +| openbb.economy.debt_chart | Function | Chart for `debt` | +| openbb.economy.events | Function | Economic Calendar | +| openbb.economy.fgdp | Function | Real GDP Forecast by Country | +| openbb.economy.fgdp_chart | Function | Chart for `fgdp` | +| openbb.economy.fred | Function | Get FRED series data | +| openbb.economy.fred_ids | Function | Search for a FRED series ID by keyword | +| openbb.economy.fred_notes | Function | Search by Keyword for Series Information | +| openbb.economy.future | Function | Current Prices of Commodities and Futures from FinViz | +| openbb.economy.futures | Function | Current Prices of Commodities and Futures from WSJ | +| openbb.economy.gdp | Function | US GDP per Capita from AlphaVantage | +| openbb.economy.gdp_chart | Function | Chart for `gdp` | +| openbb.economy.get_groups | List | List of Groups for Performance and Valuation Functions | +| openbb.economy.glbonds | Function | Table of Select 10 Year Sovereign Bonds from WSJ | +| openbb.economy.index | Function | Historical Daily Data for Indices from YahooFinance | +| openbb.economy.index_chart | Function | Chart for `index` | +| openbb.economy.indices | Function | Top US Indices from WSJ | +| openbb.economy.macro | Function | Gets Series Data from EconDB | +| openbb.economy.macro_chart | Function | Chart for `macro` | +| openbb.economy.macro_countries | List | List of Countries Accepted by Macro Function | +| openbb.economy.macro_parameters | Dictionary | Dictionary of Parameters & Descriptions for Macro Function | +| openbb.economy.overview | Function | General Market Overview from WSJ | +| openbb.economy.perfmap | Function | Opens a Browser to Performance Map from Finviz | +| openbb.economy.performance | Function | Performance Data (get_groups) | +| openbb.economy.revenue | Function | Government Revenues by Country | +| openbb.economy.revenue_chart | Function | Chart for `revenue` | +| openbb.economy.rgdp | Function | Real GDP by Country | +| openbb.economy.rgdp_chart | Function | Chart for `rgdp` | +| openbb.economy.search_index | Function | Search for a Global Index by Name | +| openbb.economy.spending | Function | General Government Spending by Year and Country | +| openbb.economy.spending_chart | Function | Chart for `spending` | +| openbb.economy.treasury | Function | US Treasuries Data | +| openbb.economy.treasury_chart | Function | Chart for `treasury` | +| openbb.economy.treasury_maturities | Function | Table of Accepted Values for Maturities Argument in `treasury` | +| openbb.economy.trust | Function | Trust in Government (OECD) as a % by Country | +| openbb.economy.trust_chart | Function | Chart for `trust` | +| openbb.economy.usbonds | Function | Table of Current Rate, Yield, and Yield Change | +| openbb.economy.usdli | Function | The USD Liquidity Index | +| openbb.economy.usdli_chart | Function | Chart for `usdli` | +| openbb.economy.valuation | Function | Valuation for Group from (get_gropus) | + +Alternatively, the contents of the economy, or function docstrings, is printed with: + +```python +help(openbb.economy) +``` + +## Examples + +### Import Statements + +The examples will assume that this code block is included with the import statements: + +```python +from openbb_terminal.sdk import openbb +import pandas as pd +``` + +### Index + +The `index` function can request data using a couple of methods. There is a curated list of global indexes which can be entered by symbol or values from the left column of the table below. + +```python +indexes = pd.DataFrame.from_dict(openbb.economy.available_indices()).transpose() + +indexes +``` + +| | name | ticker | +| :-------- | :------------------------------ | :------- | +| sp500 | S&P 500 Index | ^GSPC | +| sp400 | S&P 400 Mid Cap Index | ^SP400 | +| sp600 | S&P 600 Small Cap Index | ^SP600 | +| sp500tr | S&P 500 TR Index | ^SP500TR | +| sp_xsp | S&P 500 Mini SPX Options Index | ^XSP | +| cboe_tyx | CBOE 30 year Treasury Yields | ^TYX | +| cboe_irx | CBOE 13 Week Treasury Bill | ^IRX | +| move | ICE BofAML Move Index | ^MOVE | +| dxy | US Dollar Index | DX-Y.NYB | +| crypto200 | CMC Crypto 200 Index by Solacti | ^CMC200 | + +This list can be filtered: + +```python +filtered = indexes.name.str.contains('s&p', case = False) +indexes[filtered].head(10) +``` + +| | name | ticker | +|:----------|:------------------------------------|:---------| +| sp500 | S&P 500 Index | ^GSPC | +| sp400 | S&P 400 Mid Cap Index | ^SP400 | +| sp600 | S&P 600 Small Cap Index | ^SP600 | +| sp500tr | S&P 500 TR Index | ^SP500TR | +| sp_xsp | S&P 500 Mini SPX Options Index | ^XSP | +| ca_banks | S&P/TSX Composite Banks Index (CAD) | TXBA.TS | +| ar_mervel | S&P MERVAL TR Index (USD) | M.BA | +| eu_speup | S&P Europe 350 Index (EUR) | ^SPEUP | +| uk_spuk | S&P United Kingdom Index (PDS) | ^SPUK | +| in_bse | S&P Bombay SENSEX (INR) | ^BSESN | + +One index, or multiple, can be requested as a single DataFrame: + +```python +df = openbb.economy.index(indices = ['sp_energy_oil', 'sp_energy_equipment', 'sp_energy_ig']) + +df.tail(3) +``` + +| Date | sp_energy_oil | sp_energy_equipment | sp_energy_ig | +| :------------------ | ------------: | ------------------: | -----------: | +| 2022-11-14 00:00:00 | 800.76 | 330.53 | 712.28 | +| 2022-11-15 00:00:00 | 809.27 | 335.84 | 720.16 | +| 2022-11-16 00:00:00 | 792.32 | 326.49 | 704.68 | + +This can also be displayed as a chart: + +```python +openbb.economy.index_chart(indices = ['sp_energy_oil', 'sp_energy_equipment', 'sp_energy_ig']) +``` + +![openbb.economy.index_chart](https://user-images.githubusercontent.com/85772166/231894118-c3773acc-a40f-482d-838b-81118a011b0e.png "openbb.economy.index_chart") + +### Performance + +Performance metrics for sectors, industries, and regions (US listed) are printed with: + +```python +openbb.economy.performance(group = 'energy') +``` + +| | Name | Week | Month | 3Month | 6Month | 1Year | YTD | Recom | AvgVolume [1M] | RelVolume | Change | Volume [1M] | +| --: | :----------------------------- | ------: | -----: | ------: | -----: | ------: | -----: | ----: | -------------: | --------: | ------: | ----------: | +| 0 | Oil & Gas Drilling | 0.0106 | 0.2154 | 0.2501 | 0.1534 | 0.711 | 0.8991 | 1.92 | 33.58 | 0.71 | -0.013 | 16.93 | +| 1 | Oil & Gas E&P | 0.0019 | 0.0618 | 0.1188 | 0.15 | 0.6602 | 0.6922 | 2.18 | 287.09 | 0.66 | -0.0059 | 136.36 | +| 2 | Oil & Gas Equipment & Services | -0.0063 | 0.1613 | 0.305 | 0.1219 | 0.493 | 0.5702 | 2.1 | 74.1 | 0.52 | -0.0125 | 27.79 | +| 3 | Oil & Gas Integrated | 0.0166 | 0.0557 | 0.0885 | 0.0462 | 0.4014 | 0.4114 | 2.23 | 122.44 | 0.71 | -0.0079 | 62.12 | +| 4 | Oil & Gas Midstream | -0.0113 | 0.038 | -0.019 | 0.0045 | 0.1551 | 0.2027 | 2.3 | 105.55 | 0.65 | -0.0115 | 48.8 | +| 5 | Oil & Gas Refining & Marketing | 0.0147 | 0.0929 | 0.1562 | 0.1585 | 0.6038 | 0.6084 | 2.13 | 30.59 | 0.61 | -0.0006 | 13.32 | +| 6 | Thermal Coal | -0.0096 | 0.0291 | -0.0494 | 0.1289 | 1.2305 | 1.0504 | 1.97 | 8.74 | 0.69 | -0.0207 | 4.28 | +| 7 | Uranium | -0.0176 | 0.0416 | 0.0856 | 0.0426 | -0.1746 | 0.0267 | 1.61 | 32.44 | 0.54 | -0.0125 | 12.58 | + +Performance by sector: + +```python +openbb.economy.performance(group = 'sector') +``` + +| | Name | Week | Month | 3Month | 6Month | 1Year | YTD | Recom | AvgVolume [1M] | RelVolume | Change | Volume [1M] | +| --: | :--------------------- | ------: | -----: | ------: | ------: | ------: | ------: | ----: | -------------: | --------: | ------: | ----------: | +| 0 | Basic Materials | -0.0032 | 0.129 | 0.0195 | -0.0572 | -0.0684 | -0.0928 | 2.22 | 469.94 | 0.66 | -0.0116 | 222.2 | +| 1 | Communication Services | 0.0343 | 0.0128 | -0.1444 | -0.1297 | -0.3837 | -0.3529 | 1.97 | 731.34 | 0.72 | 0.0004 | 377.12 | +| 2 | Consumer Cyclical | 0.0111 | 0.0266 | -0.1386 | -0.0182 | -0.3665 | -0.3221 | 2.14 | 1430 | 1.01 | -0.0034 | 1040 | +| 3 | Consumer Defensive | 0.003 | 0.0757 | -0.0302 | 0.0573 | -0.019 | -0.0574 | 2.31 | 298.74 | 0.85 | -0.0019 | 181.95 | +| 4 | Energy | 0.0067 | 0.0629 | 0.0913 | 0.0736 | 0.4208 | 0.4497 | 2.21 | 694.52 | 0.65 | -0.008 | 322.19 | +| 5 | Financial | -0.0095 | 0.0934 | -0.0098 | 0.0339 | -0.1259 | -0.1137 | 2.24 | 861.74 | 0.79 | -0.005 | 489.78 | +| 6 | Healthcare | -0.0121 | 0.0703 | -0.0125 | 0.0177 | -0.1074 | -0.1161 | 2.11 | 1180 | 0.87 | 0.0002 | 736.58 | +| 7 | Industrials | -0.0118 | 0.0969 | -0.0223 | 0.0723 | -0.1138 | -0.101 | 2.32 | 573.08 | 0.7 | -0.005 | 285.24 | +| 8 | Real Estate | -0.0259 | 0.0884 | -0.1441 | -0.0961 | -0.2413 | -0.2738 | 2.18 | 341.84 | 0.55 | -0.0055 | 134.66 | +| 9 | Technology | 0.0149 | 0.0938 | -0.1095 | -0.0044 | -0.3024 | -0.2957 | 2.03 | 1460 | 0.86 | 0.0039 | 904.44 | +| 10 | Utilities | -0.0235 | 0.0485 | -0.1212 | -0.0582 | -0.0054 | -0.0569 | 2.29 | 166.21 | 0.67 | -0.0142 | 79.25 | + +### Events + +A global economic calendar is accessible through the `events` function: + +```python +help(openbb.economy.events) + +Help on Operation in module openbb_terminal.core.library.operation: + + + Get economic calendar for countries between specified dates + + Parameters + ---------- + countries : [List[str],str] + List of countries to include in calendar. Empty returns all + start_date : str + Start date for calendar + end_date : str + End date for calendar + + Returns + ------- + pd.DataFrame + Economic calendar +``` + +With no arguments, `events` will return the calendar from today: + +```python +openbb.economy.events().head(10) +``` + +| | Time (ET) | Country | Event | Actual | Consensus | Previous | Date | +|---:|:------------|:---------------|:---------------------------------------|:---------|:------------|:-----------|:-----------| +| 0 | 01:45 | Germany | German Buba President Nagel Speaks | - | - | - | 2023-04-13 | +| 1 | 01:45 | Germany | German Buba Vice President Buch Speaks | - | - | - | 2023-04-13 | +| 2 | 02:00 | United Kingdom | Construction Output | 2.4% | 0.9% | -1.7% | 2023-04-13 | +| 3 | 02:00 | United Kingdom | U.K. Construction Output | 5.7% | 1.6% | 3.3% | 2023-04-13 | +| 4 | 02:00 | United Kingdom | GDP | 0.0% | 0.1% | 0.4% | 2023-04-13 | +| 5 | 02:00 | United Kingdom | Index of Services | 0.1% | -0.2% | 0.1% | 2023-04-13 | +| 6 | 02:00 | United Kingdom | Industrial Production | -0.2% | 0.2% | -0.5% | 2023-04-13 | +| 7 | 02:00 | United Kingdom | Industrial Production | -3.1% | -3.7% | -3.2% | 2023-04-13 | +| 8 | 02:00 | United Kingdom | Manufacturing Production | -2.4% | -4.7% | -2.8% | 2023-04-13 | +| 9 | 02:00 | United Kingdom | Manufacturing Production | 0.0% | 0.2% | -0.1% | 2023-04-13 | + +Calendar events can be requested for a specific countries and date ranges: + +```python +openbb.economy.events(countries = ['United States'], start_date = '2022-11-18', end_date = '2022-11-18').head(5) +``` + +| | Time (ET) | Country | Event | Actual | Consensus | Previous | Date | +|---:|:------------|:--------------|:--------------------------------|:---------|:------------|:-----------|:-----------| +| 0 | 09:40 | United States | Fed Collins Speaks | - | - | - | 2022-11-18 | +| 1 | 11:00 | United States | Existing Home Sales | -5.9% | - | -1.5% | 2022-11-18 | +| 2 | 11:00 | United States | Existing Home Sales | 4.43M | 4.38M | 4.71M | 2022-11-18 | +| 3 | 11:00 | United States | US Leading Index | -0.8% | -0.4% | -0.5% | 2022-11-18 | +| 4 | 14:00 | United States | U.S. Baker Hughes Oil Rig Count | 623 | - | 622 | 2022-11-18 | + +### FRED + +Search the FRED database for a series titles containing keywords: + +```python +series_ids = openbb.economy.fred_ids(search_query = 'Oil and Gas') + +series_ids.head(5) +``` + +| id | title | +| :-------------- | :-------------------------------------------------------------------------------------------------- | +| PCU333132333132 | Producer Price Index by Industry: Oil and Gas Field Machinery and Equipment Manufacturing | +| CES1021100001 | All Employees, Oil and Gas Extraction | +| IPG211111CS | Industrial Production: Mining, Quarrying, and Oil and Gas Extraction: Crude Oil (NAICS = 211111pt.) | +| A33DNO | Manufacturers' New Orders: Mining, Oil, and Gas Field Machinery Manufacturing | +| PCU21112111 | Producer Price Index by Industry: Oil and Gas Extraction | + +### Macro + +The `macro` function will return a Tuple. See refer to the docstring below to see the input arguments: + +```python +help(openbb.economy.macro) + +Help on Operation in module openbb_terminal.core.library.operation: + + + Use 'economy.macro_chart' to access the view. + This functions groups the data queried from the EconDB database [Source: EconDB] + + Parameters + ---------- + parameters: list + The type of data you wish to download. Available parameters can be accessed through economy.macro_parameters(). + countries : list + The selected country or countries. Available countries can be accessed through economy.macro_countries(). + transform : str + The selected transform. Available transforms can be accessed through get_macro_transform(). + start_date : str + The starting date, format "YEAR-MONTH-DAY", i.e. 2010-12-31. + end_date : str + The end date, format "YEAR-MONTH-DAY", i.e. 2020-06-05. + symbol : str + In what currency you wish to convert all values. + + Returns + ------- + Tuple[pd.DataFrame, Dict[Any, Dict[Any, Any]], str] + A DataFrame with the requested macro data of all chosen countries, + A dictionary containing the units of each country's parameter (e.g. EUR), + A string denomination which can be Trillions, Billions, Millions, Thousands + + Examples + -------- + >>> from openbb_terminal.sdk import openbb + >>> macro_df = openbb.economy.macro() +``` + +`openbb.economy.macro_parameters()` will return a list of dictionaries. Read it as a DataFrame with: + +```python +parameters = pd.DataFrame.from_dict(openbb.economy.macro_parameters()).transpose() + +parameters.tail(5) +``` + +| | name | period | description | +| :------ | :------------------------ | :------ | :----------------------------------------------------------------------------------------------------------------------------------- | +| Y10YD | Long term yield (10-year) | Monthly | The 10-year yield is used as a proxy for mortgage rates. It's also seen as a sign of investor sentiment about the country's economy. | +| M3YD | 3 month yield | Monthly | The yield received for investing in a government issued treasury security that has a maturity of 3 months | +| HOU | House price index | Monthly | House price index defined with base 2015 for Europe with varying bases for others. See: https://www.econdb.com/main-indicators | +| OILPROD | Oil production | Monthly | The amount of oil barrels produced per day in a month within a country. | +| POP | Population | Monthly | The population of a country. This can be in thousands or, when relatively small, in actual units. | + +The data from the `macro` function is unpacked like: + +```python +data,units,denomination = openbb.economy.macro(parameters = ['Y10YD'], countries = ['United States', 'Poland', 'France', 'Italy', 'Spain', 'Germany']) + +data.tail(10) +``` + +| date | France | Germany | Italy | Poland | Spain | United States | +|:--------------------|----------------------:|-----------------------:|---------------------:|----------------------:|---------------------:|-----------------------------:| +| 2022-05-01 | 1.52 | 0.95 | 2.99 | 6.64 | 2.04 | 2.9 | +| 2022-06-01 | 2.06 | 1.45 | 3.64 | 7.14 | 2.63 | 3.14 | +| 2022-07-01 | 1.71 | 1.08 | 3.36 | 6.37 | 2.31 | 2.9 | +| 2022-08-01 | 1.69 | 1.03 | 3.3 | 5.8 | 2.15 | 2.9 | +| 2022-09-01 | 2.41 | 1.8 | 4.14 | 6.28 | 2.92 | 3.52 | +| 2022-10-01 | 2.77 | 2.19 | 4.53 | 7.82 | 3.29 | 3.98 | +| 2022-11-01 | 2.58 | 2.07 | 4.24 | 7.24 | 3.07 | 3.89 | +| 2022-12-01 | 2.62 | 2.09 | 4.26 | 6.61 | 3.09 | 3.62 | +| 2023-01-01 | 2.69 | 2.19 | 4.24 | 6.02 | 3.2 | 3.53 | +| 2023-02-01 | 2.87 | 2.37 | 4.27 | 6.18 | 3.39 | 3.75 | diff --git a/website/content/sdk/data-available/etf.md b/website/content/sdk/data-available/etf.md new file mode 100644 index 000000000000..6217b8d7201f --- /dev/null +++ b/website/content/sdk/data-available/etf.md @@ -0,0 +1,201 @@ +--- +title: ETF +description: This documentation page provides a comprehensive guide on how to use + the ETF module of the OpenBB Terminal SDK for programmatic access. It covers a list + of functions within the ETF module, how to import the SDK, how to print contents + of the SDK, how to use the ETF module in various situations such as getting list + of ETF categories, getting ETF tickers, comparing performance metrics, getting the + holdings of a specific ETF, performing ETF screening, and retrieving current top + gainers, losers, and volume for ETFs. +keywords: +- OpenBB Terminal SDK +- ETF module +- programmatic access +- import SDK +- perform ETF screening +- get ETF holdings +- compare performance metrics +- retrieve top gainers and losers +- retrieve top volume for ETFs +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +The ETF module provides programmatic access to the commands from within the OpenBB Terminal. Import the OpenBB SDK module, and then access the functions similarly to how the Terminal menus are navigated. The code completion will be activated upon entering `.`, after, `openbb.etf` +​ + +## How to Use + +​The examples provided below will assume that the following import block is included at the beginning of the Python script or Notebook file: +​ + +```python +from openbb_terminal.sdk import openbb +import pandas as pd +``` + +​Below is a brief description of each function within the ETF module: + +|Path |Type |Description | +|:---------|:---------:|------------------------------:| +|openbb.etf.candle |Function |Chart OHLC + Volume + Moving Averages | +|openbb.etf.disc |Sub-Module |Best/Worst/Highest Volume ETFs Today | +|openbb.etf.etf_by_category |Function |Lookup by Category | +|openbb.etf.etf_by_name |Function |Lookup by Name | +|openbb.etf.holdings |Function |Holdings and Weights | +|openbb.etf.ld |Function |Lookup by Description | +|openbb.etf.load |Function |Get Historical Price Data | +|openbb.etf.ln |Function |Lookup by Name (More Details Than `by_name`) | +|openbb.etf.news |Function |News Headlines for a Ticker | +|openbb.etf.overview |Function |Basic Statistics for an ETF | +|openbb.etf.scr |Sub-Module |ETF Screener | +|openbb.etf.summary |Function |Text Description and Summary of an ETF | +|openbb.etf.symbols |Dictionary |Dictionary of {Ticker:Name} | +|openbb.etf.weights |Function |Table or Pie Graph of Sector Weightings | + +Alternatively you can print the contents of the ETF SDK with: +​ + +```python +help(openbb.etf) +``` + +## Examples + +### etf_by_category + +​ +ETFs are categorized into different buckets. Use the code block below as a way to generate a list of all categories: +​ + +```python +etf_list = pd.DataFrame.from_dict(openbb.etf.etf_by_category('')).transpose() +categories = list(etf_list['category'].drop_duplicates()) +categories = pd.DataFrame(categories[1::], columns = ['Type']) + +categories.head(6) +``` + +| | Type | +| --: | :------------------------ | +| 0 | Pacific/Asia ex-Japan Stk | +| 1 | Large Value | +| 2 | Equity Energy | +| 3 | Foreign Large Blend | +| 4 | Large Blend | +| 5 | Multisector Bond | + +​Replacing the empty category in the syntax above will return the ETFs within that category: +​ + +```python +etf_category = pd.DataFrame.from_dict(openbb.etf.etf_by_category('Foreign Large Blend')).transpose() +etf_category = etf_category.sort_values(by=['total_assets'], ascending = False) + +etf_category.head(2) +``` + +| | short_name | long_name | currency | summary | category | family | exchange | market | total_assets | +| :--- | :------------------------------ | :------------------------------------------------------- | :------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :------------------ | :------- | :------- | :-------- | -----------: | +| VXUS | Vanguard Total International St | Vanguard Total International Stock Index Fund ETF Shares | USD | The investment seeks to track the performance of a benchmark index that measures the investment return of stocks issued by companies located in developed and emerging markets, excluding the United States. | Foreign Large Blend | Vanguard | NGM | us_market | 379067924480 | +| | | | | The fund employs an indexing investment approach designed to track the performance of the FTSE Global All Cap ex US Index, a float-adjusted market-capitalization-weighted index designed to measure equity market performance of companies located in developed and emerging markets, excluding the United States. It invests all, or substantially all, of its assets in the common stocks included in its target index. | | | | | | +| VEA | Vanguard FTSE Developed Markets | Vanguard FTSE Developed Markets Index Fund ETF Shares | USD | The investment seeks to track the performance of the FTSE Developed All Cap ex US Index. | Foreign Large Blend | Vanguard | PCX | us_market | 150540566528 | +| | | | | The fund employs an indexing investment approach designed to track the performance of the FTSE Developed All Cap ex US Index, a market-capitalization-weighted index that is made up of approximately 3865 common stocks of large-, mid-, and small-cap companies located in Canada and the major markets of Europe and the Pacific region. The adviser attempts to replicate the target index by investing all, or substantially all, of its assets in the stocks that make up the index, holding each stock in approximately the same proportion as its weighting in the index. | | | | | | + +​ +### ETF Tickers + +A list of all tickers in the specific category can be generated from the index of the above DataFrame, `etf_category`: + +```python +symbols = etf_category.index.to_list() +``` + +### Performance Metrics + +This list of tickers can then be used for comparison analysis, or portfolio optimization. For example, comparing the performance metrics of the Foreign Large Blend category: + +```python +performance = openbb.stocks.ca.screener(similar = symbols, data_type = 'performance') +performance = performance.sort_values(by=['Perf Quart']) +performance.head(5) +``` + +| | Ticker | Perf Week | Perf Month | Perf Quart | Perf Half | Perf Year | Perf YTD | Volatility W | Volatility M | Recom | Avg Volume | Rel Volume | Price | Change | Volume | +|---:|:---------|------------:|-------------:|-------------:|------------:|------------:|-----------:|---------------:|---------------:|:--------|-------------:|-------------:|--------:|---------:|---------:| +| 22 | IFV | 0.0057 | 0.0531 | -0.0873 | -0.122 | -0.2817 | -0.2657 | 0.0188 | 0.0194 | | 26410 | 1.44 | 16.78 | -0.0158 | 13090 | +| 20 | IDLV | 0.0326 | 0.0814 | -0.0836 | -0.1162 | -0.1756 | -0.1758 | 0.0113 | 0.0121 | | 152070 | 0.57 | 26.39 | 0.003 | 29698 | +| 18 | HDMV | 0.0456 | 0.0873 | -0.0728 | -0.1071 | -0.1709 | -0.1683 | 0.0087 | 0.0081 | | 4330 | 1.35 | 26.44 | 0.0006 | 2011 | +| 7 | DEEF | 0.0457 | 0.1061 | -0.0612 | -0.0997 | -0.2099 | -0.2071 | 0.0067 | 0.0122 | | 8350 | 0.08 | 25 | -0.0031 | 244 | +| 38 | RODM | 0.0424 | 0.1106 | -0.0428 | -0.1012 | -0.2015 | -0.1827 | 0.0141 | 0.0139 | | 345640 | 1.05 | 24.64 | 0.0011 | 125217 | + +### Holdings + +To peer into the holdings of a specific ETF: + +```python +holdings = openbb.etf.holdings('DIA').reset_index() +holdings.head(5) +``` + +| | Symbol | Name | % Of Etf | Shares | +|---:|:---------|:--------------------------------|:-----------|---------:| +| 0 | UNH | UnitedHealth Group Incorporated | 10.09% | 5985297 | +| 1 | GS | The Goldman Sachs Group, Inc. | 7.51% | 5985297 | +| 2 | HD | The Home Depot, Inc. | 6.03% | 5985297 | +| 3 | AMGN | Amgen Inc. | 5.61% | 5985297 | +| 4 | MCD | McDonald's Corporation | 5.35% | 5985297 | + +### ETF Screener + +The ETF screener is also accessible through the SDK. Variables for the screener are set in preset files. The path to their location will depend on the type of installation and operating system; it will be similar to: + +- For a pip/PyPi installation: `~/path_to/miniconda3/envs/obb/Lib/site-packages/openbb_terminal/etf/screener/presets/etf_config.ini` +- For a Git Clone & Conda installation: `~/path_to/cloned_folder/OpenBBTerminal/openbb_terminal/etf/screener/presets/etf_config.ini` +- For a the EXE/DMG installer bundles: `~/path_to_installation/OpenBB Terminal/.OpenBB/openbb_terminal/etf/screener/etf_config.ini` + +This file can be copied to the user data folder, `~/OpenBBUserData/presets/etf/screener/`, along with any other user-generated screener presets. + +```python +results = openbb.etf.scr.screen(preset='etf_config.ini') +results.head(5) +``` + +In this example, the configuration file is set to return results with a maximum Beta value of -2. + +| | index | Assets | NAV | Expense | PE | SharesOut | Div | DivYield | Volume | Open | PrevClose | YrLow | YrHigh | Beta | N_Hold | +|---:|:--------|---------:|------:|----------:|-----:|:------------|-------:|-----------:|---------------:|-------:|------------:|--------:|---------:|-------:|---------:| +| 0 | CLDS | 14.15 | 28.3 | 0.99 | N/A | 500,000 | N/A | N/A | 7815 | 28.58 | 28.05 | 14.79 | 46.43 | -2.12 | 6 | +| 1 | CTEX | 3.95 | 39.52 | 0.58 | N/A | 100,000 | N/A | N/A | 1161 | 39.56 | 39.48 | 24.48 | 51.3 | -2.07 | 31 | +| 2 | KLNE | 5.7 | 22.81 | 1.29 | N/A | 250,000 | 0.08 | 0.37 | 5580 | 21.55 | 21.7 | 12 | 31.38 | -2.79 | 5 | +| 3 | LABD | 97.16 | 18.61 | 1 | N/A | 5.22 | N/A | N/A | 8.12293e+06 | 22.26 | 21.35 | 15.7 | 85.28 | -2.67 | 17 | +| 4 | MJIN | 2.79 | 17.45 | 0.95 | N/A | 160,000 | 0.88 | 4.45 | 282 | 19.81 | 19.07 | 7.87 | 26.73 | -3.23 | 2 | + +### Disc + +The current top gainers, losers, and volume for ETFs is returned with: + +```python +openbb.etf.disc.mover(sort_type = 'decliners') + +openbb.etf.disc.mover(sort_type = 'gainers') + +openbb.etf.disc.mover(sort_type = 'active') +``` + +With no `sort_type` chosen, it will default to `gainers`: + +```python +movers = openbb.etf.disc.mover() +movers.head(5) +``` + +| | | Price | Chg | %Chg | Vol | +|---:|:---------------------------------------------------------|--------:|-------:|-------:|:-------| +| 0 | Direxion Daily Semiconductor Bear 3X Shares | 35.3101 | 3.3101 | 10.34 | 24.5M | +| 1 | ProShares UltraShort Bloomberg Natural Gas | 18.09 | 1.19 | 7.04 | 4.4M | +| 2 | MicroSectors FANG & Innovation -3x Inverse Leveraged ETN | 28.98 | 1.83 | 6.74 | 160.1K | +| 3 | Direxion Daily Dow Jones Internet Bear 3X Shares | 32.14 | 1.91 | 6.32 | 554.2K | +| 4 | Direxion Daily S&P 500 High Beta Bear 3X Shares | 6.4652 | 0.3752 | 6.16 | 1.2M | diff --git a/website/content/sdk/data-available/fixedincome.md b/website/content/sdk/data-available/fixedincome.md new file mode 100644 index 000000000000..d5f37621867a --- /dev/null +++ b/website/content/sdk/data-available/fixedincome.md @@ -0,0 +1,262 @@ +--- +title: Fixed Income +description: Learn how to use the Fixed Income module of the openbb Terminal Python + SDK for data related to fixed income assets, including central bank rates, government + bonds, corporate bonds, spread data and more. Make effective use of the various + functions available within this SDK, illustrated with detailed examples. +keywords: +- Fixed Income +- ESTER +- SOFR +- SONIA +- Ameribor +- FRED +- FOMC projections +- ECB key interest rates +- government bonds +- treasury rates +- yield curves +- corporate bonds +- ICE BofA Corporate Indices +- Moody's AAA and BAA Corporate Indices +- Commercial Paper +- Spot Rates +- HQM Corporate Yield Curve +- openbb.fixedincome module +- python SDK +- bond indices +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +The Fixed Income module is the high-level menu for the Fixed Income asset class. It contains reference rates (ESTER, SOFR, SONIA and Ameribor), central bank rates (FRED, FOMC projections and ECB key interest rates), government bonds (treasury rates for any country, us-specific rates, yield curves), corporate bonds (ICE BofA Corporate Indices, Moody's AAA and BAA Corporate Indices, Commercial Paper, Spot Rates and HQM Corporate Yield Curve) and spread (ICE BofA spreads, constant maturity spreads, and federal funds rate) + +## How to Use + +​The examples provided below will assume that the following import block is included at the beginning of the Python script or Notebook file: +​ + +```python +from openbb_terminal.sdk import openbb +import pandas as pd +``` + +​Below is a brief description of each function within the Fixed Income module: + +|Path |Type |Description | +|:---------|:---------:|------------------------------:| +|openbb.fixedincome.ameribor |Function | Obtain data for American Interbank Offered Rate (AMERIBOR) | +|openbb.fixedincome.cp | Function | Obtain Commercial Paper data | +|openbb.fixedincome.dwpcr |Function | Obtain data for the Discount Window Primary Credit Rate | +|openbb.fixedincome.ecb |Function | Obtain data for ECB interest rates | +|openbb.fixedincome.ecbycrv |Function | Gets euro area yield curve data from ECB | +|openbb.fixedincome.estr |Function | Obtain data for Euro Short-Term Rate (ESTR) | +|openbb.fixedincome.fed |Function | Obtain data for Effective Federal Funds Rate | +|openbb.fixedincome.ffrmc |Function | Get data for Selected Treasury Constant Maturity Minus Federal Funds Rate | +|openbb.fixedincome.hqm |Function | Obtain the HQM yield curve | +|openbb.fixedincome.icebofa |Function | Get data for ICE BofA US Corporate Bond Indices | +|openbb.fixedincome.icespread |Function | Get data for ICE BofA US Corporate Bond Spreads | +|openbb.fixedincome.iorb |Function | Obtain data for Interest Rate on Reserve Balances. | +|openbb.fixedincome.moody |Function | Get data for Moody Corporate Bond Index | +|openbb.fixedincome.projection |Function | Obtain data for the Federal Reserve's projection of the federal funds rate | +|openbb.fixedincome.sofr |Function | Obtain data for Secured Overnight Financing Rate (SOFR)| +|openbb.fixedincome.sonia |Function | Obtain data for Sterling Overnight Index Average (SONIA) | +|openbb.fixedincome.spot |Function | Obtain HQM spot rate data | +|openbb.fixedincome.tbffr |Function | Get data for Selected Treasury Bill Minus Federal Funds Rate | +|openbb.fixedincome.tmc |Function | Get data for 10-Year Treasury Constant Maturity Minus Selected Treasury Constant Maturity | +|openbb.fixedincome.treasury |Function | Obtain 3-month or 10-year treasury rates for any country | +|openbb.fixedincome.usrates |Function | Plot various treasury rates from the United States | +|openbb.fixedincome.ycrv |Function | Gets yield curve data from FRED | + +Alternatively you can print the contents of the Fixed Income SDK with: +​ +```python +help(openbb.fixedincome) +``` + +## Examples +Starting off by calling some reference rates, these can be either `estr`, `sofr`, `sonia` or `ameribor`. For example the 1 year term structure of Ameribor is plotted with `openbb.fixedincome.ameribor('1_year_term_structure')` as shown below, showing only the last 10 periods in this example: + + +| | AMERIBOR| +|:--------------------|--------:| +| 2023-02-12 00:00:00 | 5.13275 | +| 2023-02-13 00:00:00 | 5.15549 | +| 2023-02-14 00:00:00 | 5.22839 | +| 2023-02-15 00:00:00 | 5.20813 | +| 2023-02-16 00:00:00 | 5.20832 | +| 2023-02-17 00:00:00 | 5.2491 | +| 2023-02-19 00:00:00 | 5.2491 | +| 2023-02-20 00:00:00 | 5.2491 | +| 2023-02-21 00:00:00 | 5.32425 | +| 2023-02-22 00:00:00 | 5.32988 | + + +The two most prominent central bank rates, those of the Federal Reserve and the European Central Bank can be obtained with `openbb.fixedincome.fed` and `openbb.fixedincome.ecb` respectively. For instance `openbb.fixedincome.fed` shows the monthly Federal Funds Rate, showing only the last 10 periods in this example: + +| | FED | +|:--------------------|-----:| +| 2022-04-01 00:00:00 | 0.33 | +| 2022-05-01 00:00:00 | 0.77 | +| 2022-06-01 00:00:00 | 1.21 | +| 2022-07-01 00:00:00 | 1.68 | +| 2022-08-01 00:00:00 | 2.33 | +| 2022-09-01 00:00:00 | 2.56 | +| 2022-10-01 00:00:00 | 3.08 | +| 2022-11-01 00:00:00 | 3.78 | +| 2022-12-01 00:00:00 | 4.1 | +| 2023-01-01 00:00:00 | 4.33 | + +This can be accompanied with the projections, officially published by the FOMC. Here the long run expectations are plotted, which also backtracks several years, with `openbb.fixedincome.projection(long_run=True)`, showing only the last 5 periods in this example: + +| | Range High | Central tendency High | Median | Range Midpoint | Central tendency Midpoint | Range Low | Central tendency Low | +|:-----------|-------------:|------------------------:|---------:|-----------------:|----------------------------:|------------:|-----------------------:| +| 2021-12-15 | 3 | 2.5 | 2.5 | 2.5 | 2.4 | 2 | 2.3 | +| 2022-03-16 | 3 | 2.5 | 2.4 | 2.5 | 2.4 | 2 | 2.3 | +| 2022-06-15 | 3 | 2.5 | 2.5 | 2.5 | 2.4 | 2 | 2.3 | +| 2022-09-21 | 3 | 2.5 | 2.5 | 2.65 | 2.4 | 2.3 | 2.3 | +| 2022-12-14 | 3.3 | 2.5 | 2.5 | 2.8 | 2.4 | 2.3 | 2.3 | + +The European Central Bank rates can be shown with `openbb.fixedincome.ecb`. The ECB publishes three different rates that can be shown separately with `openbb.fixedincome.ecb('deposit)` for example or plotted together with `openbb.fixedincome.ecb` as shown below, showing only the last 10 periods in this example: + +| | Deposit | Lending | Refinancing | +|:-----------|----------:|----------:|--------------:| +| 2023-02-14 | 2.5 | 3.25 | 3 | +| 2023-02-15 | 2.5 | 3.25 | 3 | +| 2023-02-16 | 2.5 | 3.25 | 3 | +| 2023-02-17 | 2.5 | 3.25 | 3 | +| 2023-02-18 | 2.5 | 3.25 | 3 | +| 2023-02-19 | 2.5 | 3.25 | 3 | +| 2023-02-20 | 2.5 | 3.25 | 3 | +| 2023-02-21 | 2.5 | 3.25 | 3 | +| 2023-02-22 | 2.5 | 3.25 | 3 | +| 2023-02-23 | 2.5 | 3.25 | 3 | + +In terms of government bonds, any combination of short term (3 month) and long term (10 year) government bonds for any country can be plotted with `openbb.fixedincome.treasury` for example `openbb.fixedincome.treasury(short_term=['canada', 'united_states'], long_term=['canada', 'united_states'])` as shown below, showing only the last 10 periods in this example: + +| | canada (3 month) | united_states (3 month) | canada (10 year) | united_states (10 year) | +|:-----------|-------------------:|--------------------------:|-------------------:|--------------------------:| +| 2022-04-01 | 2.704 | 2.75 | 1.34664 | 0.91 | +| 2022-05-01 | 2.91857 | 2.9 | 1.78189 | 1.33 | +| 2022-06-01 | 3.31545 | 3.14 | 2.24735 | 1.87 | +| 2022-07-01 | 3.04316 | 2.9 | 3.01411 | 2.5 | +| 2022-08-01 | 2.85909 | 2.9 | 3.38221 | 2.76 | +| 2022-09-01 | 3.1479 | 3.52 | 3.79193 | 3.21 | +| 2022-10-01 | 3.38053 | 3.98 | 4.23083 | 3.85 | +| 2022-11-01 | 3.16619 | 3.89 | 4.37634 | 4.46 | +| 2022-12-01 | 2.9415 | 3.62 | 4.55302 | 4.51 | +| 2023-01-01 | 2.93762 | 3.53 | 4.7638 | 4.61 | + + +For both the United States and the Eurozone, it is possible to see the current government bond yield curve. For the Eurozone, it is an aggregation of countries that match a specific credit rating, by default AAA, as shown with `openbb.fixedincome.ecbycrv`. + +| | Maturity | Rate | +|---:|-----------:|--------:| +| 0 | 0.25 | 2.61446 | +| 1 | 0.5 | 2.86441 | +| 2 | 1 | 2.97514 | +| 3 | 2 | 2.82012 | +| 4 | 3 | 2.68811 | +| 5 | 5 | 2.58939 | +| 6 | 7 | 2.57123 | +| 7 | 10 | 2.57545 | +| 8 | 20 | 2.55717 | +| 9 | 30 | 2.45648 | + +When it comes to Corporate Bonds, the major indices are included. These are the ICE BofA indices and the Moody's Aaa and Baa indices. Based on a query, specific benchmarks can be found. For example a collection of indices matching a variety of bond maturities with `openbb.fixedincome.icebofa(category='duration')`, showing only the last 5 periods in this example: + +| | ICE BofA 1-3 Year US Corporate Index Effective Yield | ICE BofA 3-5 Year US Corporate Index Effective Yield | ICE BofA 5-7 Year US Corporate Index Effective Yield | ICE BofA 7-10 Year US Corporate Index Effective Yield | ICE BofA 10-15 Year US Corporate Index Effective Yield | ICE BofA 15+ Year US Corporate Index Effective Yield | +|:-----------|-------------------------------------------------------:|-------------------------------------------------------:|-------------------------------------------------------:|--------------------------------------------------------:|---------------------------------------------------------:|-------------------------------------------------------:| +| 2023-02-09 | 5.22 | 5.04 | 5.12 | 5.2 | 5.34 | 5.32 | +| 2023-02-10 | 5.27 | 5.11 | 5.21 | 5.3 | 5.43 | 5.41 | +| 2023-02-13 | 5.28 | 5.14 | 5.2 | 5.28 | 5.41 | 5.38 | +| 2023-02-14 | 5.36 | 5.23 | 5.28 | 5.32 | 5.44 | 5.39 | +| 2023-02-15 | 5.36 | 5.26 | 5.31 | 5.36 | 5.48 | 5.43 | +| 2023-02-16 | 5.38 | 5.29 | 5.35 | 5.42 | 5.54 | 5.52 | +| 2023-02-17 | 5.37 | 5.26 | 5.33 | 5.42 | 5.53 | 5.5 | +| 2023-02-20 | 5.39 | 5.27 | 5.33 | 5.42 | 5.53 | 5.5 | +| 2023-02-21 | 5.49 | 5.41 | 5.49 | 5.58 | 5.68 | 5.63 | +| 2023-02-22 | 5.49 | 5.4 | 5.48 | 5.56 | 5.65 | 5.59 | + +The Moody's Aaa is often referred to as a great alternative to the federal ten-year Treasury bill as an indicator for interest rates and can be plotted with `openbb.fixedincome.moody`, showing only the last 5 periods in this example: + +| | aaa_index | +|:-----------|------------:| +| 2023-02-15 | 4.59 | +| 2023-02-16 | 4.64 | +| 2023-02-17 | 4.65 | +| 2023-02-21 | 4.76 | +| 2023-02-22 | 4.71 | + +Next to that, there are spot rates available for the High Quality Market (HQM) ranging from 1 year to a 100 years through `openbb.fixedincome.spot`. With this, it is also possible to plot the yield curve with `openbb.fixedincome.hqm` for any date in the past. For example `openbb.fixedincome.hqm(date='2020-01-01')` as shown below: + +| Maturity | spot | +|-----------:|-------:| +| 0.5 | 1.76 | +| 1 | 1.8 | +| 2 | 1.86 | +| 3 | 1.91 | +| 5 | 2.07 | +| 7 | 2.35 | +| 10 | 2.79 | +| 20 | 3.35 | +| 30 | 3.48 | +| 50 | 3.6 | +| 75 | 3.65 | +| 100 | 3.68 | + +Furthermore, it is possible to see spreads between a variety of assets. For example the Emerging Markets spread can be shown with `openbb.fixedincome.icespread(category='all', area='emea')`. This is based on the spot treasury curve. Showing only the last 5 periods in this example: + +| | ICE BofA EMEA Emerging Markets Corporate Plus Index Option-Adjusted Spread | +|:-----------|-----------------------------------------------------------------------------:| +| 2023-02-16 | 2.66 | +| 2023-02-17 | 2.75 | +| 2023-02-20 | 2.75 | +| 2023-02-21 | 2.74 | +| 2023-02-22 | 2.77 | + +For both `openbb.fixedincome.icebofa` and `openbb.fixedincome.icespread` it is possible to see all the options with `options`. Find an example for `openbb.fixedincome.icespread(options=True)` below. + + +| | Type | Category | Area | Grade | Title | +|----:|:-------|:-----------|:--------------|:---------------|:------------------------------------------------------------------------------------------------------| +| 2 | spread | duration | us | non_sovereign | ICE BofA 1-3 Year US Corporate Index Option-Adjusted Spread | +| 6 | spread | duration | us | non_sovereign | ICE BofA 3-5 Year US Corporate Index Option-Adjusted Spread | +| 10 | spread | duration | us | non_sovereign | ICE BofA 5-7 Year US Corporate Index Option-Adjusted Spread | +| 14 | spread | duration | us | non_sovereign | ICE BofA 7-10 Year US Corporate Index Option-Adjusted Spread | +| 18 | spread | duration | us | non_sovereign | ICE BofA 10-15 Year US Corporate Index Option-Adjusted Spread | +| 22 | spread | duration | us | non_sovereign | ICE BofA 15+ Year US Corporate Index Option-Adjusted Spread | +| 26 | spread | all | us | non_sovereign | ICE BofA US Corporate Index Option-Adjusted Spread | +| 30 | spread | usd | us | high_yield | ICE BofA US High Yield Index Option-Adjusted Spread | +| 34 | spread | eur | eu | high_yield | ICE BofA Euro High Yield Index Option-Adjusted Spread | +| 38 | spread | all | ex_g10 | non_sovereign | ICE BofA Emerging Markets Corporate Plus Index Option-Adjusted Spread | +| 42 | spread | all | ex_g10 | private_sector | ICE BofA Private Sector Financial Emerging Markets Corporate Plus Index Option-Adjusted Spread | +| 46 | spread | usd | ex_g10 | non_sovereign | ICE BofA US Emerging Markets Corporate Plus Index Option-Adjusted Spread | +| 50 | spread | eur | ex_g10 | non_sovereign | ICE BofA Euro Emerging Markets Corporate Plus Index Option-Adjusted Spread | +| 54 | spread | usd | ex_g10 | non_sovereign | ICE BofA US Emerging Markets Liquid Corporate Plus Index Option-Adjusted Spread | +| 58 | spread | usd | ex_g10 | non_financial | ICE BofA Non-Financial US Emerging Markets Liquid Corporate Plus Index Option-Adjusted Spread | +| 62 | spread | usd | ex_g10 | public_sector | ICE BofA Public Sector Issuers US Emerging Markets Liquid Corporate Plus Index Option-Adjusted Spread | +| 66 | spread | all | emea | non_sovereign | ICE BofA EMEA Emerging Markets Corporate Plus Index Option-Adjusted Spread | +| 70 | spread | usd | emea | non_sovereign | ICE BofA EMEA US Emerging Markets Liquid Corporate Plus Index Option-Adjusted Spread | +| 74 | spread | all | asia | non_sovereign | ICE BofA Asia Emerging Markets Corporate Plus Index Option-Adjusted Spread | +| 78 | spread | usd | asia | non_sovereign | ICE BofA Asia US Emerging Markets Liquid Corporate Plus Index Option-Adjusted Spread | +| 82 | spread | all | latin_america | non_sovereign | ICE BofA Latin America Emerging Markets Corporate Plus Index Option-Adjusted Spread | +| 86 | spread | usd | latin_america | non_sovereign | ICE BofA Latin America US Emerging Markets Liquid Corporate Plus Index Option-Adjusted Spread | +| 90 | spread | all | ex_g10 | aaa | ICE BofA AAA-A Emerging Markets Corporate Plus Index Option-Adjusted Spread | +| 94 | spread | usd | ex_g10 | aaa | ICE BofA AAA-A US Emerging Markets Liquid Corporate Plus Index Option-Adjusted Spread | +| 98 | spread | all | ex_g10 | high_grade | ICE BofA High Grade Emerging Markets Corporate Plus Index Option-Adjusted Spread | +| 102 | spread | all | ex_g10 | bbb | ICE BofA BBB Emerging Markets Corporate Plus Index Option-Adjusted Spread | +| 106 | spread | usd | ex_g10 | bbb | ICE BofA BBB US Emerging Markets Liquid Corporate Plus Index Option-Adjusted Spread | +| 110 | spread | all | ex_g10 | crossover | ICE BofA Crossover Emerging Markets Corporate Plus Index Option-Adjusted Spread | +| 114 | spread | all | ex_g10 | bb | ICE BofA BB Emerging Markets Corporate Plus Index Option-Adjusted Spread | +| 118 | spread | all | ex_g10 | high_yield | ICE BofA High Yield Emerging Markets Corporate Plus Index Option-Adjusted Spread | +| 122 | spread | all | ex_g10 | b | ICE BofA B & Lower Emerging Markets Corporate Plus Index Option-Adjusted Spread | +| 126 | spread | usd | us | aaa | ICE BofA AAA US Corporate Index Option-Adjusted Spread | +| 130 | spread | usd | us | aa | ICE BofA AA US Corporate Index Option-Adjusted Spread | +| 134 | spread | usd | us | a | ICE BofA Single-A US Corporate Index Option-Adjusted Spread | +| 138 | spread | usd | us | bbb | ICE BofA BBB US Corporate Index Option-Adjusted Spread | +| 142 | spread | usd | us | bb | ICE BofA BB US High Yield Index Option-Adjusted Spread | +| 146 | spread | usd | us | b | ICE BofA Single-B US High Yield Index Option-Adjusted Spread | +| 150 | spread | usd | us | ccc | ICE BofA CCC & Lower US High Yield Index Option-Adjusted Spread | diff --git a/website/content/sdk/data-available/forecast.md b/website/content/sdk/data-available/forecast.md new file mode 100644 index 000000000000..29aaa84522e4 --- /dev/null +++ b/website/content/sdk/data-available/forecast.md @@ -0,0 +1,610 @@ +--- +title: Forecast +description: This documentation page describes the forecast module which provides programmatic access to state-of-the-art forecasting from Nixtla and u8darts. +keywords: +- forecasting +- prediction +- modeling +- modelling +- nixtla +- u8darts +- arima +- ets +- nhits +- regression +- rnn +- lstm +- gru +- theta +- transformer +- moving average +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +The Forecast module provides programmatic access to the same commands found in the OpenBB Terminal Forecast menu. The extensive library of models, built on top of the [u8darts](https://unit8co.github.io/darts/) library, are easily tuned with hyper-parameters. + +## How to Use + +The Forecast menu was designed specifically for the CLI application, and consequently, the operation of these commands do not mirror the workflow of the OpenBB Terminal. This will be improved in the future to more closely resemble it, and this guide will highlight some notable differences. + +Commands within the `forecast` module are representatives from three broad categories: + +- Exploration +- Feature Engineering +- Model + +Each command is listed below with a short description. A majority of functions will also have an additional syntax, `_chart`, for displaying the generated charts inline. For ease of use, we recommend using the `_chart` version for Model functions. + +|Path |Type | Description | +| :--------- | :---------: | ----------: | +|openbb.forecast.atr |Feature Engineering |Add a Column for the Average True Range | +|openbb.forecast.autoces |Model |Automatic Complex Exponential Smoothing Model | +|openbb.forecast.autoets |Model |Automatic ETS (Error, Trend, Seasonality) Model | +|openbb.forecast.autoselect |Model |Automatically Selects the Best Statistical Model From AutoARIMA, AutoETS, AutoCES, MSTL, etc. | +|openbb.forecast.brnn |Model |Block Recurrent Neural Network (RNN, LSTM, GRU) (feat. Past covariates) | +|openbb.forecast.clean |Exploration |Fill or Drop NaN Values | +|openbb.forecast.combine |Exploration |Combine Columns From Different Datasets | +|openbb.forecast.corr |Exploration | Correlation Coefficients Between Columns of a Dataset | +|openbb.forecast.delete |Exploration |Delete Columns From a Dataset | +|openbb.forecast.delta |Feature Engineering |Add a Column for % Change | +|openbb.forecast.desc |Exploration |Show Descriptive Statistics for a Dataset | +|openbb.forecast.ema |Feature Engineering |Add a Column for Exponentially Weighted Moving Average | +|openbb.forecast.expo |Model |Probabilistic Exponential Smoothing | +|openbb.forecast.export |Export |Export a Processed Dataset as a CSV or XLSX File | +|openbb.forecast.linregr |Model |Probabilistic Linear Regression (feat. Past covariates and Explainability) | +|openbb.forecast.load |Import |Import a Local CSV or XLSX File | +|openbb.forecast.mom |Feature Engineering |Add a Column for Momentum | +|openbb.forecast.nbeats |Model |Neural Bayesian Estimation (feat. Past covariates) | +|openbb.forecast.nhits |Model |Neural Hierarchical Interpolation (feat. Past covariates) | +|openbb.forecast.plot |Exploration |Plots Specific Columns From a Loaded Dataset | +|openbb.forecast.regr |Model |Regression (feat. Past covariates and Explainability) | +|openbb.forecast.rename |Exploration |Rename Columns in a Dataset | +|openbb.forecast.rnn |Model |Probabilistic Recurrent Neural Network (RNN, LSTM, GRU) | +|openbb.forecast.roc |Feature Engineering |Add a Column for Rate of Change | +|openbb.forecast.rsi |Feature Engineering |Add a Column for Relative Strength Index | +|openbb.forecast.rwd |Model |Random Walk with Drift Model | +|openbb.forecast.season |Exploration |Plot Seasonality of a Column in a Dataset | +|openbb.forecast.seasonalnaive |Model |Seasonal Naive Model | +|openbb.forecast.signal |Feature Engineering |Add a Column for Price Signal (Short vs. Long Term) | +|openbb.forecast.sto |Feature Engineering |Add a Column for Stochastic Oscillator %K and %D | +|openbb.forecast.tcn |Model |Temporal Convolutional Neural Network (feat. Past covariates) | +|openbb.forecast.tft |Model |Temporal Fusion Transformer Network(feat. Past covariates) | +|openbb.forecast.theta |Model |Theta Method | +|openbb.forecast.trans |Model |Transformer Network (feat. Past covariates) | + +Alternatively, the contents of the menu is printed with: + +```python +help(openbb.forecast) +``` + +Type hints and code completion will be activated upon entering the `.`, after, `openbb.forecast`. The first step is always going to involve loading some data. Let's walk through a procedure for procuring a DataFrame with some examples below. + +## Examples + +### Import Statements + +The examples provided below will assume that the following import block is included at the beginning of the Python script or Notebook file: + +```python +from openbb_terminal.sdk import openbb +import pandas as pd +# %matplotlib inline (uncomment if using a Jupyter Interactive Terminal or Notebook) +``` + +### Loading Data + +This library of models are specifically for time-series, and consequently, the data must follow some formatting guidelines: + +- If the index is not a date, it must be sequentially ordered and evenly spaced - i.e., it can't be indexed like: `[1,2,5,11,50]` +- A datetime index must be spaced evenly - i.e., monthly data is better handled when the interval date is the first of the month. +- If the datetime index is a weekly interval, use a Monday-Friday format. +- Intraday data is not officially supported at this time. + +The equities market revolves around the S&P 500, so let's take a look at the ETF, `SPY`, from inception: + +```python +spy = openbb.stocks.load('SPY', start_date = '1990-01-01') +``` + +```console +Loading Daily data for SPY with starting period 1993-01-29. +``` + +The printed message indicates that the first day of available data is not the same as the requested start date. [Wikipedia](https://en.wikipedia.org/wiki/SPDR_S%26P_500_Trust_ETF) shows the fund was launched on January 22, 1993. The product was marketed and sold to liquidity providers prior to trading on a public exchange, so this DataFrame is pretty darn close to the inception date. We can confirm that this data arrived as expected by printing the created DataFrame. + +```python +spy.head(5) +``` + +| date | Open | High | Low | Close | Adj Close | Volume | +|:--------------------|--------:|--------:|--------:|--------:|------------:|----------------:| +| 1993-01-29 00:00:00 | 43.9688 | 43.9688 | 43.75 | 43.9375 | 25.334 | 1.0032e+06 | +| 1993-02-01 00:00:00 | 43.9688 | 44.25 | 43.9688 | 44.25 | 25.5142 | 480500 | +| 1993-02-02 00:00:00 | 44.2188 | 44.375 | 44.125 | 44.3438 | 25.5683 | 201300 | +| 1993-02-03 00:00:00 | 44.4062 | 44.8438 | 44.375 | 44.8125 | 25.8385 | 529400 | +| 1993-02-04 00:00:00 | 44.9688 | 45.0938 | 44.4688 | 45 | 25.9467 | 531500 | + +### Plot + +The data can also be inspected visually, `openbb.forecast.plot`: + +```python +openbb.forecast.plot(data=spy, columns = ['Adj Close']) +``` + +![openbb.forecast.plot](https://user-images.githubusercontent.com/85772166/203671651-e7d5776f-c2ab-4a2a-8600-a5f6b6f2aa93.png "openbb.forecast.plot") + +### Theta + +Data consisting of a numeric value and a datetime index is sufficient enough for feeding the inputs to a forecast model. One important distinction between the Terminal and SDK is that the `target_column` must be explicitly declared when using the SDK, if it is not labeled as "close". It is case-sensitive. + +To use a forecast model with default parameters, all that is required in the syntax is: + +- The name of the dataset. +- The target column for the forecast. + +A basic, default, syntax will look like: + +```python +openbb.forecast.theta_chart(data = spy, target_column = 'Adj Close') +``` + +The default number of days to predict for all models is five. If the interval of the time-series is not daily, days equates to the interval of the index. + +```console +Theta Model obtains MAPE: 1.91% +``` + +![openbb.forecast.theta_chart](https://user-images.githubusercontent.com/85772166/203897200-f2d3938c-f3a9-4ee4-bf67-0398d8d3bce6.png) + +|Datetime |Prediction| +|:----------|--------:| +|2022-11-24 |402.62| +|2022-11-25 |402.92| +|2022-11-28 |403.14| +|2022-11-29 |403.38| +|2022-11-30 |403.59| + +Refer to the docstrings to learn about each model's unique set of arguments. + +```python +help(openbb.forecast.theta_chart) +``` + +## Feature Engineering + +This category of functions are for adding columns to a dataset that are the results of calculations, like technical and quantitative analysis. Individual parameters will vary slightly between functions, but syntax construction will be similar. + +### EMA + +A moving average provides an indication of the trend of the price movement by cutting down the amount of "noise" in a price chart. + +```console +help(openbb.forecast.ema) + + Parameters + ---------- + dataset : pd.DataFrame + The dataset you wish to clean + target_column : str + The column you wish to add the EMA to + period : int + Time Span + + Returns + ------- + pd.DataFrame + Dataframe with added EMA column +``` + +The example below adds a column to the `spy` dataset for the 150-day exponential moving average of the adjusted-close price. + +```python +spy = openbb.forecast.ema(spy, target_column = 'Adj Close', period = 150) + +spy.tail(3) +``` + +| | date | Open | High | Low | Close | Adj Close | Volume | EMA_150 | +|-----:|:-----------|-------:|-------:|-------:|--------:|------------:|---------:|----------:| +| 7508 | 2022-11-21 | 394.64 | 395.82 | 392.66 | 394.59 | 394.59 | 51243200 | 394.923 | +| 7509 | 2022-11-22 | 396.63 | 400.07 | 395.15 | 399.9 | 399.9 | 60429000 | 394.989 | +| 7510 | 2022-11-23 | 399.55 | 402.93 | 399.31 | 402.42 | 402.42 | 68161400 | 395.087 | + +Additional columns can be added for each desired period length of the calculation: + +```python +spy = openbb.forecast.ema(spy, target_column = 'Adj Close', period = 20) + +spy.tail(3) +``` + +| | date | Open | High | Low | Close | Adj Close | Volume | EMA_150 | EMA_20 | +|-----:|:-----------|-------:|-------:|-------:|--------:|------------:|---------:|----------:|---------:| +| 7508 | 2022-11-21 | 394.64 | 395.82 | 392.66 | 394.59 | 394.59 | 51243200 | 394.923 | 387.237 | +| 7509 | 2022-11-22 | 396.63 | 400.07 | 395.15 | 399.9 | 399.9 | 60429000 | 394.989 | 388.443 | +| 7510 | 2022-11-23 | 399.55 | 402.93 | 399.31 | 402.42 | 402.42 | 68161400 | 395.087 | 389.775 | + +The process can be repeated as required. + +### RSI + +Similar to `ema`, `rsi` adds a column for the Relative Strength Index. The three variables are the same here as above. A period of ten equates to ten trading days, or two-weeks. + +```python +spy = openbb.forecast.rsi(spy, target_column = 'Adj Close', period = 10) + +spy.tail(3) +``` + +| | date | Open | High | Low | Close | Adj Close | Volume | EMA_150 | EMA_20 | RSI_10_Adj Close | +|-----:|:-----------|-------:|-------:|-------:|--------:|------------:|---------:|----------:|---------:|-------------------:| +| 7508 | 2022-11-21 | 394.64 | 395.82 | 392.66 | 394.59 | 394.59 | 51243200 | 394.923 | 387.237 | 58.837 | +| 7509 | 2022-11-22 | 396.63 | 400.07 | 395.15 | 399.9 | 399.9 | 60429000 | 394.989 | 388.443 | 63.7145 | +| 7510 | 2022-11-23 | 399.55 | 402.93 | 399.31 | 402.42 | 402.42 | 68161400 | 395.087 | 389.775 | 65.8484 | + +Let's add another column for a twelve-week period: + +```python +spy = openbb.forecast.rsi(spy, target_column = 'Adj Close', period = 60) + +spy.tail(3) +``` + +| | date | Open | High | Low | Close | Adj Close | Volume | EMA_150 | EMA_20 | RSI_10_Adj Close | RSI_60_Adj Close | +|-----:|:-----------|-------:|-------:|-------:|--------:|------------:|---------:|----------:|---------:|-------------------:|-------------------:| +| 7508 | 2022-11-21 | 394.64 | 395.82 | 392.66 | 394.59 | 394.59 | 51243200 | 394.923 | 387.237 | 58.837 | 50.5453 | +| 7509 | 2022-11-22 | 396.63 | 400.07 | 395.15 | 399.9 | 399.9 | 60429000 | 394.989 | 388.443 | 63.7145 | 51.4456 | +| 7510 | 2022-11-23 | 399.55 | 402.93 | 399.31 | 402.42 | 402.42 | 68161400 | 395.087 | 389.775 | 65.8484 | 51.8685 | + +### STO + +Some of the Feature Engineering commands require multiple columns, `openbb.forecast.sto` is one of them. + +```python +help(openbb.forecast.sto) +``` + +```console +Stochastic Oscillator %K and %D : A stochastic oscillator is a momentum indicator comparing a particular closing price of a security to a range of its prices over a certain period of time. %K and %D are slow and fast indicators. + +Requires Low/High/Close columns. +Note: This will drop first rows equal to period due to how this metric is calculated. + +Parameters +---------- +close_column: str + Column name for closing price +high_column: str + Column name for high price +low_column: str + Column name for low price +dataset : pd.DataFrame + The dataset you wish to calculate for +period : int + Span + +Returns + ------- +pd.DataFrame + Dataframe with added STO K & D columns +``` + +The results of these calculations appends the dataset with two additional columns. + +```python +spy = openbb.forecast.sto( + dataset = spy, + high_column='High', + low_column = 'Low', + close_column = 'Adj Close', + period = 20 +) + +spy.tail(3) +``` + +| date | Open | High | Low | Close | Adj Close | Volume | EMA_150 | EMA_20 | RSI_10_Adj Close | RSI_60_Adj Close | SO%K_20 | SO%D_20 | +|:--------------------|-------:|-------:|-------:|--------:|------------:|------------:|----------:|---------:|-------------------:|-------------------:|----------:|----------:| +| 2022-11-21 00:00:00 | 394.64 | 395.82 | 392.66 | 394.59 | 394.59 | 5.12432e+07 | 394.923 | 387.237 | 58.837 | 50.5453 | 76.969 | 79.1396 | +| 2022-11-22 00:00:00 | 396.63 | 400.07 | 395.15 | 399.9 | 399.9 | 6.0429e+07 | 394.989 | 388.443 | 63.7145 | 51.4456 | 92.8102 | 83.6814 | +| 2022-11-23 00:00:00 | 399.55 | 402.93 | 399.31 | 402.42 | 402.42 | 6.81614e+07 | 395.087 | 389.775 | 65.8484 | 51.8685 | 98.5062 | 89.4285 | + +## Exploration + +As made evident by the composite dataset created, the name of a column can be undesirable. The exploration functions provide some tools for managing and maintaining the dataset. + +### Rename + +Column names can be altered with `openbb.forecast.rename`. One column can be changed: + +```python +spy = openbb.forecast.rename(spy, 'RSI_10_Adj Close', 'RSI_10') + +spy.tail(1) +``` + +| date | Open | High | Low | Close | Adj Close | Volume | EMA_150 | EMA_20 | RSI_10 | RSI_60_Adj Close | SO%K_20 | SO%D_20 | +|:--------------------|-------:|-------:|-------:|--------:|------------:|------------:|----------:|---------:|---------:|-------------------:|----------:|----------:| +| 2022-11-23 00:00:00 | 399.55 | 402.93 | 399.31 | 402.42 | 402.42 | 6.81614e+07 | 395.087 | 389.775 | 65.8484 | 51.8685 | 98.5062 | 89.4285 | + +Let's rename a few more to make working with them a little easier, this time using the Python-method: + +```python +spy.rename(columns = { + 'RSI_60_Adj Close': 'RSI_60', + 'SO%K_20': 'STO_Slow', + 'SO%D_20': 'STO_Fast'}, inplace = True) +``` + +Verify the names were updated as intended with a console print: + +```console +spy.columns + + Index(['Open', 'High', 'Low', 'Close', 'Adj Close', 'Volume', 'EMA_150', 'EMA_20', 'RSI_10', 'RSI_60', STO_Slow', 'STO_Fast'], dtype='object') +``` + +### Delete + +Say, for example, that we would like to eliminate the `Close` column in favour of the adjusted-close values. First, delete the desired column: + +```python +openbb.forecast.delete(spy, 'Close') +``` + +Then, let's rename, 'Adj Close', as, 'Close', and verify the results: + +```python +spy = openbb.forecast.rename(spy, 'Adj Close', 'Close') + +spy.tail(1) +``` + +| date | Open | High | Low | Close | Volume | EMA_150 | EMA_20 | RSI_10 | RSI_60 | STO_Slow | STO_Fast | +|:--------------------|-------:|-------:|-------:|--------:|------------:|----------:|---------:|---------:|---------:|-----------:|-----------:| +| 2022-11-23 00:00:00 | 399.55 | 402.93 | 399.31 | 402.42 | 6.81614e+07 | 395.087 | 389.775 | 65.8484 | 51.8685 | 98.5062 | 89.4285 | + +## Models + +Some models are more taxing on system resources than others, and some take considerably longer to run. Changes to parameters can have dramatic effects on the forecast, be sure to make note of the changes while tuning the hyper-parameters. There are also two distinct types of models: + +- Those with the ability to target past-covariates. +- Those without the ability to target past-covarites. + +We currently recommend using the `_chart` version for every model. + +Models of the former type are: + +- `linregr` +- `regr` +- `brnn` +- `nbeats` +- `nhits` +- `tcn` +- `trans` +- `tft` + +All models default to `past-covariates = None`, and targets for past covariates are selected with a comma-separated list of names, as demonstrated below. + +### regr_chart + +`openbb.forecast.regr_chart` is a regression model which can forecast with, or without, past-covariates. The first example below is without. + +```python +openbb.forecast.regr_chart(spy, target_column = 'Close') +``` + +```console +Predicting Regression for 5 days + +Regression model obtains MAPE: 1.90% +``` + +![openbb.forecast.regr_chart](https://user-images.githubusercontent.com/85772166/203897290-330de1a6-056b-475b-9206-44658ebe5239.png "openbb.forecast.regr_chart") + +|Datetime |Prediction| +|:----------|--------:| +|2022-11-24 |403.06| +|2022-11-25 |401.95| +|2022-11-28 |402.69| +|2022-11-29 |402.55| +|2022-11-30 |399.84| + +Then, targeting both EMA columns as past-covariates: + +```python +openbb.forecast.regr_chart(spy, target_column = 'Close', past_covariates= "EMA_150,EMA_20") +``` + +```console +Warning: when using past covariates n_predict must equal output_chunk_length. We have changed your output_chunk_length to 5 to match your n_predict + +Covariate #0: EMA_150 +Covariate #1: EMA_20 + +Predicting Regression for 5 days + +Regression model obtains MAPE: 1.85% +``` + +![openbb.forecast.regr_chart](https://user-images.githubusercontent.com/85772166/203897358-1111b8f6-e907-4ac6-a97d-327c87e07f1e.png "openbb.forecast.regr_chart") + +|Datetime |Prediction| +|:----------|--------:| +|2022-11-24 |403.20| +|2022-11-25 |401.95| +|2022-11-28 |402.15| +|2022-11-29 |400.99| +|2022-11-30 |398.01| + +Adding these past-covariates has improved the MAPE by 0.05%, which is a good thing; like golf, a lower score is better. + +A second chart displayed by a regression model is for "explainability", SHAP values. It is an illustration of which past-covariates have the most impact on the model output. + +![Explainability](https://user-images.githubusercontent.com/85772166/203897584-37898fee-611f-47c1-abd0-23e2ef21613a.png "Explainability") + +Targeting the `Volume` column as a past-covariate reveals it to be negatively impacting the forecast, in this particular instance and application. + +```python +openbb.forecast.regr_chart(spy, target_column = 'Close', past_covariates="Volume") +``` + +![openbb.forecast.regr_chart](https://user-images.githubusercontent.com/85772166/203897625-9a71960a-29a1-40e1-8c5e-2950bddd1a9c.png "openbb.forecast.regr_chart") + +### Combine + +Let's add another potential past-covariate to the dataset by taking the adjusted-close value of `XOM`, and using `combine` to join the column with our existing DataFrame. + +```python +xom = openbb.stocks.load("XOM", start_date = '1993-01-29') +spy = openbb.forecast.combine(df1 = spy, df2 = xom, column = 'Adj Close', dataset = 'XOM' ) +spy.rename(columns = {'XOM_Adj Close': 'XOM'}, inplace = True) +``` + +### Corr + +`openbb.forecast.corr` calculates the correlation between all columns in a dataset. + +```python +openbb.forecast.corr(spy) +``` + +| | Open | High | Low | Close | Volume | EMA_150 | EMA_20 | RSI_10_Adj Close | RSI_60 | STO_Slow | STO_Fast | XOM | +|:-----------------|----------:|----------:|----------:|----------:|-----------:|-----------:|----------:|-------------------:|------------:|------------:|------------:|-----------:| +| Open | 1 | 0.999928 | 0.999907 | 0.996296 | 0.102601 | 0.990844 | 0.995626 | 0.0485853 | 0.0685473 | 0.631412 | 0.635814 | 0.725111 | +| High | 0.999928 | 1 | 0.999845 | 0.996388 | 0.105301 | 0.991371 | 0.995819 | 0.0468199 | 0.0648085 | 0.63298 | 0.637221 | 0.724806 | +| Low | 0.999907 | 0.999845 | 1 | 0.996337 | 0.0988936 | 0.990313 | 0.995387 | 0.0548303 | 0.0740719 | 0.630126 | 0.634485 | 0.725668 | +| Close | 0.996296 | 0.996388 | 0.996337 | 1 | 0.115854 | 0.995506 | 0.99931 | 0.0544362 | 0.0708491 | 0.62215 | 0.626235 | 0.725945 | +| Volume | 0.102601 | 0.105301 | 0.0988936 | 0.115854 | 1 | 0.143554 | 0.125322 | -0.255959 | -0.3392 | 0.387554 | 0.384561 | 0.470041 | +| EMA_150 | 0.990844 | 0.991371 | 0.990313 | 0.995506 | 0.143554 | 1 | 0.997117 | 0.00795085 | 0.00294935 | 0.63139 | 0.635393 | 0.737946 | +| EMA_20 | 0.995626 | 0.995819 | 0.995387 | 0.99931 | 0.125322 | 0.997117 | 1 | 0.0295848 | 0.0530582 | 0.621829 | 0.625925 | 0.726945 | +| RSI_10_Adj Close | 0.0485853 | 0.0468199 | 0.0548303 | 0.0544362 | -0.255959 | 0.00795085 | 0.0295848 | 1 | 0.707723 | 0.00550661 | 0.00475805 | 0.0316687 | +| RSI_60 | 0.0685473 | 0.0648085 | 0.0740719 | 0.0708491 | -0.3392 | 0.00294935 | 0.0530582 | 0.707723 | 1 | -0.203022 | -0.201585 | 0.00254247 | +| STO_Slow | 0.631412 | 0.63298 | 0.630126 | 0.62215 | 0.387554 | 0.63139 | 0.621829 | 0.00550661 | -0.203022 | 1 | 0.991231 | 0.609652 | +| STO_Fast | 0.635814 | 0.637221 | 0.634485 | 0.626235 | 0.384561 | 0.635393 | 0.625925 | 0.00475805 | -0.201585 | 0.991231 | 1 | 0.613626 | +| XOM | 0.725111 | 0.724806 | 0.725668 | 0.725945 | 0.470041 | 0.737946 | 0.726945 | 0.0316687 | 0.00254247 | 0.609652 | 0.613626 | 1 | + +Let's see how Exxon impacts our previous forecast. + +```python +openbb.forecast.regr_chart(data = spy, target_column = "Close", dataset_name = 'SPY', past_covariates = "EMA_20,EMA_150,XOM") +``` + +```console +Warning: when using past covariates n_predict must equal output_chunk_length. We have changed your output_chunk_length to 5 to match your n_predict + +Covariate #0: EMA_20 +Covariate #1: EMA_150 +Covariate #2: XOM + +Predicting Regression for 5 days + +Regression model obtains MAPE: 1.80% +``` + +|Datetime |Prediction | +|:--------|------:| +|2022-11-24 |401.70 | +|2022-11-25 |402.02 | +|2022-11-26 |402.25 | +|2022-11-27 |401.48 | +|2022-11-28 |397.16 | + +![openbb.forecast.regr_chart](https://user-images.githubusercontent.com/85772166/203897681-e2bfb592-c832-477a-8f24-2604e5ed8254.png "openbb.forecast.regr_chart") + +To include pan/zoom functionality for charts, substitute `%matplotlib widget` in the import statement block. The code block below will recreate the DataFrame as shown in the examples above: + +```python +from openbb_terminal.sdk import openbb +import pandas as pd +# %matplotlib widget (uncomment if using a Jupyter Interactive Terminal or Notebook) + +spy:pd.DataFrame = [] + +spy = openbb.stocks.load('SPY', start_date = '1990-01-01') + +spy = openbb.forecast.ema(spy, target_column = 'Adj Close', period = 150) + +spy = openbb.forecast.ema(spy, target_column = 'Adj Close', period = 20) + +spy = openbb.forecast.rsi(spy, target_column = 'Adj Close', period = 10) + +spy = openbb.forecast.rsi(spy, target_column = 'Adj Close', period = 60) + +spy = openbb.forecast.sto( + dataset = spy, + high_column='High', + low_column = 'Low', + close_column = 'Adj Close', + period = 20 +) + +openbb.forecast.delete(spy, 'Close') + +spy.rename(columns = { + 'Adj Close': 'Close', + 'RSI_60_Adj Close': 'RSI_10', + 'RSI_60_Adj Close': 'RSI_60', + 'SO%K_20': 'STO_Slow', + 'SO%D_20': 'STO_Fast'}, inplace = True) + +xom = openbb.stocks.load("XOM", start_date = '1993-01-29') +openbb.forecast.combine(df1 = spy, df2 = xom, column = 'Adj Close', dataset = 'XOM' ) +spy.rename(columns = {'XOM_Adj Close': 'XOM'}, inplace = True) + +spy +``` + +## Hyper-Parameters + +Hyper-parameters are the fine-tune dials for each model. Refer to the docstrings for the extensive list. The parameters below are the ways in which the regression model can be altered. Each model will be different, and their responses will vary. The demonstrated workflow is a simple way to begin experimenting with the functions. The same general processes can be applied for all models. The purpose of this guide is to help users get going with using the Forecast module, some assembly required. + +```python +help(openbb.forecast.regr_chart) + +Help on Operation in module openbb_terminal.core.library.operation: + + + Display Regression Forecasting + + Parameters + ---------- + data: Union[pd.Series, pd.DataFrame] + Input Data + target_column: str + Target column to forecast. Defaults to "close". + dataset_name: str + The name of the ticker to be predicted + n_predict: int + Days to predict. Defaults to 5. + train_split: float + Train/val split. Defaults to 0.85. + past_covariates: str + Multiple secondary columns to factor in when forecasting. Defaults to None. + forecast_horizon: int + Forecast horizon when performing historical forecasting. Defaults to 5. + output_chunk_length: int + The length of the forecast of the model. Defaults to 1. + lags: Union[int, List[int]] + lagged target values to predict the next time step + export: str + Format to export data + residuals: bool + Whether to show residuals for the model. Defaults to False. + forecast_only: bool + Whether to only show dates in the forecasting range. Defaults to False. + start_date: Optional[datetime] + The starting date to perform analysis, data before this is trimmed. Defaults to None. + end_date: Optional[datetime] + The ending date to perform analysis, data after this is trimmed. Defaults to None. + naive: bool + Whether to show the naive baseline. This just assumes the closing price will be the same + as the previous day's closing price. Defaults to False. + external_axes: Optional[List[plt.axes]] + External axes to plot on +``` diff --git a/website/content/sdk/data-available/forex.md b/website/content/sdk/data-available/forex.md new file mode 100644 index 000000000000..baa225a47337 --- /dev/null +++ b/website/content/sdk/data-available/forex.md @@ -0,0 +1,241 @@ +--- +title: Forex +description: This page describes the Forex module provided by OpenBB SDK, demonstrating + its functionalities such as getting currency pair data, loading historical OHLC + data, executing broker integration for Oanda account holders, etc. It explains how + to use and showcases relevant examples of these functions for improved understanding. +keywords: +- OpenBB SDK +- Forex module +- currency pair data +- Keys module +- Oanda broker integration +- OHLC Chart +- Forward Rates +- list of currency symbols +- Load historical OHLC Data +- Realtime Currency Exchange Rate +- Forex functions +- AlphaVantage +- Polygon +- YahooFinance +- Real-time exchange rates +- Average True Range +- Forward Rates +- Term structure +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +The Forex module provides a way for users to get currency pair data, from a number of sources. API keys for them are handled by the Keys module. After importing the entire OpenBB SDK, no further action is required to authorize the sources. This module also provides Oanda account holders with broker integration. + +## How to Use + +Below is a brief description of each function within the Forex module: + +|Path |Type |Description | +|:------------------------------|:----------:|------------------------------:| +|openbb.forex.candle |Function |OHLC Chart & Optional Moving Averages | +|openbb.forex.fwd |Function |Forward Rates of Currency Pairs | +|openbb.forex.get_currency_list |List |List of Currency Symbols | +|openbb.forex.load |Function |Load Historical OHLC Data for Currency Pairs | +|openbb.forex.oanda |Sub-Module |Oanda Broker Integration | +|openbb.forex.quote |Function |Realtime Currency Exchange Rate | + +The contents of the menu is printed with: + +```python +help(openbb.forex) +``` + +## Examples + +### Import Statements + +The examples in this guide will assume that the import statements below are present: + +```python +from openbb_terminal.sdk import openbb +import pandas as pd +``` + +### Load + +The `load` function has the ability to request data from multiple sources: + +- AlphaVantage +- Polygon +- YahooFinance (default) + +Using the default source: + +```python +currency_pair = openbb.forex.load( + from_symbol='USD', + to_symbol='EUR', + start_date = '2000-01-01', + interval = '1week') + +currency_pair.head(3) +``` + +| date | Open | High | Low | Close | Adj Close | Volume | +|:--------------------|--------:|--------:|--------:|--------:|------------:|---------:| +| 2003-12-01 00:00:00 | 0.83098 | 0.83724 | 0.82028 | 0.82163 | 0.82163 | 0 | +| 2003-12-08 00:00:00 | 0.82183 | 0.82488 | 0.81261 | 0.82068 | 0.82068 | 0 | +| 2003-12-15 00:00:00 | 0.82055 | 0.82115 | 0.80373 | 0.80919 | 0.80919 | 0 | + +To use an alternate source, add the `source` argument to the syntax: + +```python +currency_pair = openbb.forex.load( + from_symbol= 'USD', + to_symbol= 'EUR', + source = 'Polygon', + start_date = '2000-01-01', + interval = '1week') + +currency_pair.head(3) +``` + +| date | Volume | vw | Open | Close | High | Low | Transactions | +|:--------------------|---------:|-------:|-------:|--------:|--------:|--------:|---------------:| +| 2012-01-29 00:00:00 | 3758 | 0.761 | 0.7565 | 0.7597 | 0.7676 | 0.7565 | 3758 | +| 2012-02-05 00:00:00 | 5605 | 0.7566 | 0.762 | 0.7581 | 0.7672 | 0.75081 | 5605 | +| 2012-02-12 00:00:00 | 9045 | 0.7611 | 0.757 | 0.7603 | 0.77053 | 0.75278 | 9045 | + +The amount and granularity of historical data available will vary by source. The two tables above illustrate some of those differences. + +### Average True Range + +The loaded data can now be used as inputs for other functions and calculations, such as the average true range over a four week window. + +```python +weekly_atr = openbb.ta.atr(data = currency_pair, window = 4) +currency_pair = currency_pair.join(weekly_atr) + +currency_pair.tail(1) +``` + +| date | Volume | vw | Open | Close | High | Low | Transactions | ATRe_4 | +|:--------------------|---------:|------:|--------:|--------:|--------:|------:|---------------:|----------:| +| 2022-11-13 00:00:00 | 481918 | 0.965 | 0.96479 | 0.96205 | 0.97351 | 0.954 | 481918 | 0.0281756 | + +### Quote + +Get real-time exchange rates. + +```python +openbb.forex.quote("EURUSD", source = "AlphaVantage") +``` + +| | Realtime Currency Exchange Rate | +|:----------------------|:----------------------------------| +| 1. From_Currency Code | USD | +| 2. From_Currency Name | United States Dollar | +| 3. To_Currency Code | EUR | +| 4. To_Currency Name | Euro | +| 5. Exchange Rate | 0.91580000 | +| 6. Last Refreshed | 2023-07-03 17:00:01 | +| 7. Time Zone | UTC | +| 8. Bid Price | 0.91576000 | +| 9. Ask Price | 0.91580000 | + +### Forward Rates + +```python +fwd_usdeur = openbb.forex.fwd('EUR', 'USD') + +fwd_usdeur +``` + +| Expiration | Ask | Bid | Mid | Points | +|:--------------|--------:|--------:|--------:|---------:| +| Overnight | 0.91608 | 0.91602 | 0.91605 | -0.825 | +| Tomorrow Next | 0.91608 | 0.91601 | 0.91604 | -0.855 | +| Spot Next | 0.91612 | 0.91606 | 0.91609 | -0.425 | +| One Week | 0.91586 | 0.9158 | 0.91583 | -2.995 | +| Two Weeks | 0.91557 | 0.9155 | 0.91553 | -5.985 | +| Three Weeks | 0.91526 | 0.91519 | 0.91523 | -9.05 | +| One Month | 0.9147 | 0.91463 | 0.91466 | -14.685 | +| Two Months | 0.91339 | 0.91331 | 0.91335 | -27.81 | +| Three Months | 0.91201 | 0.91194 | 0.91198 | -41.54 | +| Four Months | 0.91064 | 0.91055 | 0.9106 | -55.34 | +| Five Months | 0.90939 | 0.9093 | 0.90934 | -67.885 | +| Six Months | 0.90743 | 0.90732 | 0.90737 | -87.555 | +| Seven Months | 0.90616 | 0.90604 | 0.9061 | -100.32 | +| Eight Months | 0.90501 | 0.90489 | 0.90495 | -111.795 | +| Nine Months | 0.9037 | 0.90358 | 0.90364 | -124.88 | +| Ten Months | 0.90254 | 0.9024 | 0.90247 | -136.6 | +| Eleven Months | 0.90146 | 0.90132 | 0.90139 | -147.375 | +| One Year | 0.90041 | 0.90025 | 0.90033 | -158.025 | +| Two Years | 0.89063 | 0.89017 | 0.8904 | -257.31 | + +Currency pairs will have different term structure composition in the other direction: + +```python +fwd_eurusd = openbb.forex.fwd('USD', 'EUR') + +fwd_eurusd +``` + +| Expiration | Ask | Bid | Mid | Points | +|:--------------|--------:|--------:|--------:|----------:| +| Overnight | 1.09166 | 1.09164 | 1.09165 | 0.985 | +| Tomorrow Next | 1.09161 | 1.09159 | 1.0916 | 0.515 | +| Spot Next | 1.09161 | 1.09159 | 1.0916 | 0.5085 | +| One Week | 1.09192 | 1.09189 | 1.09191 | 3.565 | +| Two Weeks | 1.09228 | 1.09225 | 1.09226 | 7.13 | +| Three Weeks | 1.09264 | 1.09261 | 1.09263 | 10.78 | +| One Month | 1.09332 | 1.09329 | 1.09331 | 17.549 | +| Two Months | 1.09488 | 1.09484 | 1.09486 | 33.14 | +| Three Months | 1.09655 | 1.0965 | 1.09653 | 49.7665 | +| Four Months | 1.09822 | 1.09815 | 1.09818 | 66.32 | +| Five Months | 1.09974 | 1.09967 | 1.09971 | 81.56 | +| Six Months | 1.10215 | 1.10208 | 1.10211 | 105.6 | +| Seven Months | 1.10372 | 1.1036 | 1.10366 | 121.08 | +| Eight Months | 1.10512 | 1.105 | 1.10506 | 135.06 | +| Nine Months | 1.10673 | 1.10661 | 1.10667 | 151.23 | +| Ten Months | 1.10817 | 1.10805 | 1.10811 | 165.64 | +| Eleven Months | 1.10951 | 1.10941 | 1.10946 | 179.09 | +| One Year | 1.11082 | 1.1107 | 1.11076 | 192.08 | +| Two Years | 1.12338 | 1.12296 | 1.12317 | 316.24 | +| Three Years | 1.13422 | 1.1332 | 1.13371 | 421.62 | +| Four Years | 1.14476 | 1.14374 | 1.14425 | 527 | +| Five Years | 1.15647 | 1.15445 | 1.15546 | 639.1 | +| Six Years | 1.16796 | 1.16644 | 1.1672 | 756.5 | +| Seven Years | 1.17936 | 1.17734 | 1.17835 | 868 | +| Ten Years | 1.21166 | 1.20664 | 1.20915 | 1176 | + +Not all currency pairs will have the same length of term structure. + +```python +fwd_eurjpy = openbb.forex.fwd('JPY', 'EUR') +fwd_pairs = fwd_eurjpy.join(fwd_usdeur, on = ['Expiration'], lsuffix = ' EUR/JPY', rsuffix=' USD/EUR') + +fwd_pairs +``` + +| Expiration | Ask EUR/JPY | Bid EUR/JPY | Mid EUR/JPY | Points EUR/JPY | Ask USD/EUR | Bid USD/EUR | Mid USD/EUR | Points USD/EUR | +|:--------------|--------------:|--------------:|--------------:|-----------------:|--------------:|--------------:|--------------:|-----------------:| +| Overnight | 157.959 | 157.951 | 157.955 | -3.17 | 0.91608 | 0.91602 | 0.91605 | -0.825 | +| Tomorrow Next | 157.959 | 157.951 | 157.955 | 0 | 0.91608 | 0.91601 | 0.91604 | -0.855 | +| Spot Next | 157.959 | 157.951 | 157.955 | -1.585 | 0.91612 | 0.91606 | 0.91609 | -0.425 | +| One Week | 157.958 | 157.95 | 157.954 | -11.12 | 0.91586 | 0.9158 | 0.91583 | -2.995 | +| Two Weeks | 157.957 | 157.949 | 157.953 | -22.34 | 0.91557 | 0.9155 | 0.91553 | -5.985 | +| Three Weeks | 157.956 | 157.948 | 157.952 | -33.41 | 0.91526 | 0.91519 | 0.91523 | -9.05 | +| One Month | 157.954 | 157.946 | 157.95 | -53.221 | 0.9147 | 0.91463 | 0.91466 | -14.685 | +| Two Months | 157.949 | 157.941 | 157.945 | -102.35 | 0.91339 | 0.91331 | 0.91335 | -27.81 | +| Three Months | 157.944 | 157.936 | 157.94 | -153.575 | 0.91201 | 0.91194 | 0.91198 | -41.54 | +| Four Months | 157.938 | 157.93 | 157.934 | -209.635 | 0.91064 | 0.91055 | 0.9106 | -55.34 | +| Five Months | 157.933 | 157.925 | 157.929 | -260.55 | 0.90939 | 0.9093 | 0.90934 | -67.885 | +| Six Months | 157.927 | 157.919 | 157.923 | -318.365 | 0.90743 | 0.90732 | 0.90737 | -87.555 | +| Seven Months | 157.922 | 157.913 | 157.918 | -374.29 | 0.90616 | 0.90604 | 0.9061 | -100.32 | +| Eight Months | 157.917 | 157.908 | 157.912 | -425.68 | 0.90501 | 0.90489 | 0.90495 | -111.795 | +| Nine Months | 157.911 | 157.903 | 157.907 | -479.26 | 0.9037 | 0.90358 | 0.90364 | -124.88 | +| Ten Months | 157.906 | 157.897 | 157.901 | -536.525 | 0.90254 | 0.9024 | 0.90247 | -136.6 | +| Eleven Months | 157.9 | 157.892 | 157.896 | -586.775 | 0.90146 | 0.90132 | 0.90139 | -147.375 | +| One Year | 157.895 | 157.887 | 157.891 | -637.185 | 0.90041 | 0.90025 | 0.90033 | -158.025 | +| Two Years | 157.841 | 157.831 | 157.836 | -1190.55 | 0.89063 | 0.89017 | 0.8904 | -257.31 | diff --git a/website/content/sdk/data-available/futures.md b/website/content/sdk/data-available/futures.md new file mode 100644 index 000000000000..cd14ae44bf9f --- /dev/null +++ b/website/content/sdk/data-available/futures.md @@ -0,0 +1,136 @@ +--- +title: Futures +description: Learn how to use the Futures module of the OpenBB SDK in a Python script + or Jupyter Notebook. This guide includes descriptions of each function and examples + of how to access futures forward curve data and chart, search available futures, + and fetch and visualize historical data. +keywords: +- OpenBB SDK +- Python Script +- Futures module +- Futures Forward Curve Data +- Futures Forward Curve Chart +- Search Available Futures +- Historical OHLC+V Data +- Chart Historical Price +- Individual Contracts +- Jupyter Notebook +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +The functions from the OpenBB Terminal Futures menu is part of the SDK layer, and provides methods for programmatically accessing the data and charts associated with them. Get started by importing the OpenBB SDK to the Python script or Jupyter Notebook file. + + +## How to Use + +Below is a brief description of each function within the Futures module: + +|Path |Type |Description | +|:---------|:---------:|------------------------------:| +|openbb.futures.curve |Function |Futures Forward Curve Data +|openbb.futures.curve_chart |Function |Futures Forward Curve Chart +|openbb.futures.search |Function |Search Available Futures +|openbb.futures.historical |Function |Historical OHLC+V Data +|openbb.futures.historical_chart |Function |Chart Historical Price of Individual Contracts + +## Examples + +### Import Statements + +The examples here will assume that the block below is included at the top of the file: + +```python +from openbb_terminal.sdk import openbb +import pandas as pd +%matplotlib inline +``` + +### Search + +Futures can be searched by description, exchange, or category. + +```python +openbb.futures.search(description = 'Eurodollar') +``` + +| | Ticker | Description | Exchange | Category | +|----:|:---------|:-------------------------------------|:-----------|:-----------| +| 66 | GE | Eurodollar Futures | CME | currency | +| 67 | GLB | One-Month Eurodollar Futures | CME | currency | +| 152 | SED | SED (SOFR-Eurodollar) Spread Futures | CME | bonds | + +The historical front-month price is captured to a DataFrame with: + +### Curve + +The forward curve data for a symbol is fetched with: + +```python +eurodollar = openbb.futures.curve('GE') +``` + +|Expiration | Futures | +|:--------------------|----------:| +| 2022-11-01 00:00:00 | 95.3561 | +| 2022-12-01 00:00:00 | 94.9925 | +| 2023-01-01 00:00:00 | 94.985 | +| 2023-02-01 00:00:00 | 94.9 | +| 2023-03-01 00:00:00 | 94.825 | + +To display a chart of the data, use `curve_chart`: + +```python +openbb.futures.curve_chart(symbol = 'GE') +``` + +![openbb.futures.curve_chart](https://user-images.githubusercontent.com/85772166/202352342-eecf872d-8934-42e7-8b53-4e3415bc2993.png "openbb.futures.curve_chart") + +### Historical + +The `historical` function can fetch the historical front-month price: + +```python +wti_continuous = obb.futures.historical('CL') +``` + +Or, while actively trading, individual contracts. The example below requests historical data for the December WTI contract from 2023 to 2030, starting at the first recorded trading day of the December 2030 contract. + +```python +cl_2312 = openbb.futures.historical(symbols = ['CL'], expiry = '2023-12') +cl_2312 = cl_2312.rename(columns={'Adj Close':'2023-12'}) +cl_2412 = openbb.futures.historical(symbols = ['CL'], expiry = '2024-12') +cl_2412 = cl_2412.rename(columns={'Adj Close':'2024-12'}) +cl_2512 = openbb.futures.historical(symbols = ['CL'], expiry = '2025-12') +cl_2512 = cl_2512.rename(columns={'Adj Close':'2025-12'}) +cl_2612 = openbb.futures.historical(symbols = ['CL'], expiry = '2026-12') +cl_2612 = cl_2612.rename(columns={'Adj Close':'2026-12'}) +cl_2712 = openbb.futures.historical(symbols = ['CL'], expiry = '2027-12') +cl_2712 = cl_2712.rename(columns={'Adj Close':'2027-12'}) +cl_2812 = openbb.futures.historical(symbols = ['CL'], expiry = '2028-12') +cl_2812 = cl_2812.rename(columns={'Adj Close':'2028-12'}) +cl_2912 = openbb.futures.historical(symbols = ['CL'], expiry = '2029-12') +cl_2912 = cl_2912.rename(columns={'Adj Close':'2029-12'}) +cl_3012 = openbb.futures.historical(symbols = ['CL'], expiry = '2030-12') +cl_3012 = cl_3012.rename(columns={'Adj Close':'2030-12'}) + +historical = pd.DataFrame(data = [cl_2312['2023-12'],cl_2412['2024-12'],cl_2512['2025-12'],cl_2612['2026-12'],cl_2712['2027-12'],cl_2812['2028-12'],cl_2912['2029-12'],cl_3012['2030-12']]).transpose() +historical = historical.dropna() + +historical +``` + +| Date | 2023-12 | 2024-12 | 2025-12 | 2026-12 | 2027-12 | 2028-12 | 2029-12 | 2030-12 | +|:--------------------|----------:|----------:|----------:|----------:|----------:|----------:|----------:|----------:| +| 2020-01-24 00:00:00 | 49.61 | 50.14 | 50.7 | 51.56 | 51.63 | 51.63 | 51.63 | 51.63 | +| 2020-01-27 00:00:00 | 49.94 | 50.6 | 51.18 | 51.05 | 51.12 | 51.12 | 51.12 | 51.12 | +| 2020-01-28 00:00:00 | 50.17 | 50.78 | 51.23 | 51.55 | 51.62 | 51.62 | 51.62 | 51.62 | +| 2020-01-29 00:00:00 | 50.07 | 50.64 | 51.13 | 51.6 | 51.67 | 51.67 | 51.67 | 51.67 | +| 2020-01-30 00:00:00 | 50.27 | 50.91 | 51.44 | 51.49 | 51.56 | 51.56 | 51.56 | 51.56 | +| 2022-11-09 00:00:00 | 76.69 | 71.62 | 68.01 | 65.1 | 62.52 | 60.17 | 58.12 | 56.49 | +| 2022-11-10 00:00:00 | 77 | 71.64 | 67.89 | 64.86 | 62.26 | 59.91 | 57.86 | 56.23 | +| 2022-11-11 00:00:00 | 78.81 | 73.1 | 69.22 | 66.19 | 63.6 | 61.25 | 59.2 | 57.57 | +| 2022-11-14 00:00:00 | 77.4 | 72.35 | 68.89 | 66.15 | 63.62 | 61.25 | 59.13 | 57.5 | +| 2022-11-15 00:00:00 | 78.82 | 73.66 | 70.14 | 67.36 | 64.94 | 62.62 | 60.49 | 58.68 | diff --git a/website/content/sdk/data-available/portfolio/_category_.json b/website/content/sdk/data-available/portfolio/_category_.json new file mode 100644 index 000000000000..57f2b3495e01 --- /dev/null +++ b/website/content/sdk/data-available/portfolio/_category_.json @@ -0,0 +1,3 @@ +{ + "label": "Portfolio" +} diff --git a/website/content/sdk/data-available/portfolio/introduction.md b/website/content/sdk/data-available/portfolio/introduction.md new file mode 100644 index 000000000000..f07f7aa44920 --- /dev/null +++ b/website/content/sdk/data-available/portfolio/introduction.md @@ -0,0 +1,313 @@ +--- +title: Introduction +sidebar_position: 1 +description: Docusaurus page focuses on the usage of the OpenBB Terminal Portfolio + module, detailing its features and examples of use like portfolio performance benchmarking, + risk metrics calculation or maximum drawdown calculation. +keywords: +- portfolio module +- performance benchmarking +- risk metrics +- maximum drawdown +- portfolio loading +- OpenBB SDK +- portfolio transactions +--- + +The [Portfolio menu](/terminal/data-available/portfolio), from the OpenBB Terminal, is wrapped into a Python SDK layer, enabling users to programmatically work with the data in a flexible environment, fully customizable for the needs of any user. This guide will introduce the functions within the main Portfolio module, and walk through examples demonstrating how to work with a portfolio file and object. + +## How to Use + +Below is a brief description of each function within the Portfolio module: + +| Path | Type | Description | +| :------------------------- | :--------: | -------------------------------------------: | +| openbb.portfolio.alloc | Sub-Module | Allocation Metrics Compared to the Benchmark | +| openbb.portfolio.bench | Function | Select a Benchmark for the Portfolio | +| openbb.portfolio.distr | Function | Distribution of Daily Returns | +| openbb.portfolio.dret | Function | Daily Returns | +| openbb.portfolio.es | Function | Expected Shortfall | +| openbb.portfolio.holdp | Function | Holdings of Assets as a % | +| openbb.portfolio.holdv | Function | Holdings of Assets as an Absolute Value | +| openbb.portfolio.load | Function | Load a Portfolio File | +| openbb.portfolio.maxdd | Function | Maximum Drawdown | +| openbb.portfolio.metric | Sub-Module | Risk and Portfolio Metrics | +| openbb.portfolio.mret | Function | Monthly Returns | +| openbb.portfolio.om | Function | Omega Ratio | +| openbb.portfolio.perf | Function | Portfolio Performance vs Benchmark | +| openbb.portfolio.po | Sub-Module | Portfolio Optimization Sub Menu | +| openbb.portfolio.rbeta | Function | Rolling Beta of Portfolio and Benchmark Returns | +| openbb.portfolio.rsharpe | Function | Rolling Sharpe Ratio | +| openbb.portfolio.rsort | Function | Rolling Sortino Ratio | +| openbb.portfolio.rvol | Function | Rolling Volatility | +| openbb.portfolio.show | Function | Portfolio Transactions | +| openbb.portfolio.summary | Function | Summary of Portfolio and Benchmark Returns | +| openbb.portfolio.var | Function | Portfolio VaR | +| openbb.portfolio.yret | Function | Yearly Returns | + +Alternatively, the contents of the Porfolio module is printed with: + +```python +help(openbb.portfolio) +``` + +Many of the functions in this module will also have a companion command, `_chart`. + +### Portfolio Files + +Portfolio files are spreadsheets (xlsx or csv files) containing historical trades which add up to represent a net balance in the Portfolio Engine. Users should keep their collection of holdings files in the OpenBBUserData folder, `~/OpenBBUserData/portfolio/holdings`. + +:::note If you wish to load in your own Excel holdings file, please follow the following steps: +1. Download the Excel file that can be used as a template [here](https://www.dropbox.com/s/03wjjf1lfkqjmtn/holdings_example.xlsx?dl=0). +2. Move the file inside the `portfolio/holdings` folder within the [OpenBBUserData](/terminal/usage/advanceddata) folder and, optionally, adjust the name to your liking. +3. Open the Excel file and remove, edit or add to the values as you desire (e.g. your own orders). This is the default template that is also loaded in with `load --example`. +4. Open up the OpenBB Terminal, go to `portfolio` and type `load --file`. Your Excel file should then be one of the options. +::: + +Note that the Excel sheet requires the following columns: + +- **Date** - The date the trade occurred +- **Name** - The name of the security +- **Type** - The type of the security. Use Cash/Stock/Crypto/ETF as appropriate +- **Price** - The price the security was added or removed at, on a per-unit + basis +- **Quantity** - How much of the security in question was added or removed +- **Side** - Whether you bought or sold. Use Buy/Deposit/1 to add to the + portfolio or Sell/Withdrawal/0 to remove from the portfolio a search criteria, + country, sector or industry. + + +The table below illustrates the required column titles: + +| Date | Type | Ticker | Side | Price | Quantity | Fees | Investment | Currency | Sector | Industry | Country | Region | +|:-----------|:-------|:---------|:-------|--------:|-----------:|-------:|-------------:|:-----------|:-----------------------|:-------------------------------|:--------------|:--------------| +| 2021-10-29 | STOCK | K.TO | Buy | 7.93 | 190 | 20 | 1526.7 | CAD | Basic Materials | Gold | Canada | North America | +| 2015-01-02 | ETF | SPY | Buy | 178.28 | 5.6 | 0 | 998.368 | USD | - | - | - | - | +| 2015-01-01 | CRYPTO | BTC-USD | Buy | 1000 | 2 | 0 | 2000 | USD | Crypto | Crypto | Crypto | Crypto | +| 2011-01-03 | STOCK | AMZN | Buy | 9.22 | 100 | 0 | 922 | USD | Consumer Cyclical | Internet Retail | United States | North America | +| 2011-01-03 | STOCK | AAPL | Buy | 11.74 | 100 | 0 | 1174 | USD | Technology | Consumer Electronics | United States | North America | +| 2011-01-03 | STOCK | MSFT | Buy | 28.04 | 100 | 0 | 2804 | USD | Technology | Software-Infrastructure | United States | North America | +| 2011-01-03 | STOCK | TSLA | Buy | 1.76 | 100 | 0 | 176 | USD | Consumer Cyclical | Auto Manufacturers | United States | North America | +| 2011-01-03 | STOCK | GOOG | Buy | 15.01 | 100 | 0 | 1501 | USD | Communication Services | Internet Content & Information | United States | North America | + +The template Excel file also has additional columns but these are _optional_. The OpenBB SDK can figure out by itself what industry, sector, country and region belongs to the loaded in Equity. So the field can be left blank if your holdings do not include this information. + +## Examples + +The examples in this guide will assume that the import statements below are included at the top of the Python script or Jupyter Notebook. + +### Import Statements + +```python +from openbb_terminal.sdk import openbb +import pandas as pd +# %matplotlib inline (uncomment if using a Jupyter Notebook or an Interactive Window) +``` + +### Load + +Taking the downloaded `holdings_example.xlsx` file from the previous section, let's load it into the Portfolio Engine. There are a few parameters available for this function, and an object is returned. + +```python +help(openbb.portfolio.load) +``` + +```console + Get PortfolioEngine object + + Parameters + ---------- + transactions_file_path : str + Path to transactions file + benchmark_symbol : str + Benchmark ticker to download data + full_shares : bool + Whether to mimic the portfolio trades exactly (partial shares) or round down the + quantity to the nearest number + risk_free_rate : float + Risk free rate in float format + + Returns + ------- + PortfolioEngine + PortfolioEngine class instance, this will hold transactions and perform calculations + + Examples + -------- + >>> from openbb_terminal.sdk import openbb + >>> p = openbb.portfolio.load("openbb_terminal/miscellaneous/portfolio_examples/holdings/example.csv") +``` + +The syntax should resemble something like the sample below; don't forget to modify the path to match the local path. + +```python +P = openbb.portfolio.load( + transactions_file_path = '/Users/path_to/OpenBBUserData/portfolio/holdings/holdings_example.xlsx', + benchmark_symbol = 'VTI', + full_shares = False, + risk_free_rate = 3.0 +) +``` + +```console +Preprocessing transactions: 100%|██████████| 14/14 [00:01<00:00, 8.82it/s] + Loading price data: 100%|██████████| 3/3 [00:01<00:00, 2.64it/s] + Calculating returns: 100%|██████████| 1/1 [00:00<00:00, 14.52it/s] + Loading benchmark: 100%|██████████| 4/4 [00:04<00:00, 1.21s/it] +``` + +### The Portfolio Object + +A Portfolio Object is assigned to the variable, `P`. The created object, or parts of it, are used as inputs to the other functions in this module. It can also be interacted with directly, for example, to change the benchmark ticker. `SPY` is a holding in the example portfolio, so let's stick with `VTI` as the performance benchmark. + +```python +P.set_benchmark(symbol = 'SPY') + + Loading benchmark: 50%|█████ | 2/4 [00:00<00:00, 5.69it/s] + +print(P.benchmark_ticker) + +SPY +``` + +Populating a list of tickers from the Portfolio Object is accomplished by assigning a variable to it: + +```python +tickers = P.tickers_list +print(tickers) + +['SPY', 'TSLA', 'K.TO', 'AAPL', 'AMZN', 'MSFT', 'BTC-USD', 'GOOG'] +``` + +### Show + +`openbb.portfolio.show` is for displaying the transactions from the loaded portfolio file. Scroll back up to view the output of this function again. + +```python +openbb.portfolio.show(P) +``` + +### Perf + +Performance against the benchmark is summarized in a table with, `openbb.portfolio.perf`. + +```python +print(openbb.portfolio.perf(P)) +``` + +| | Portfolio | Benchmark | Difference | +|:-----------------|:-------------------|:-------------------|:------------------| +| Total Investment | 11102.07 | 11102.07 | - | +| Total Value | 114027.38 | 36203.96 | 77823.43 | +| Total % Return | 927.08% | 226.10% | 700.98% | +| Total Abs Return | 102925.31 | 25101.89 | 77823.43 | + +### Summary + +`openbb.portfolio.summary` prints a table of risk metrics, comparing the portfolio against the benchmark. + +```python +print(openbb.portfolio.summary(P)) +``` + +| | Portfolio | Benchmark | Difference | +|:-----------------|:---------------------|:--------------------|:---------------------| +| Volatility | 1.65% | 0.99% | 0.66% | +| Skew | -0.32 | -0.61 | 0.29 | +| Kurtosis | 8.80 | 16.87 | -8.079 | +| Maximum Drawdown | -59.05% | -35.00% | -24.05% | +| Sharpe ratio | 0.05 | 0.039 | 0.011 | +| Sortino ratio | 0.06 | 0.04 | 0.021 | +| R2 Score | 41.36% | 41.36% | 0.00% | + +### MaxDD + +`openbb.portfolio.maxdd` calculates the maximum drawdown as price and % value; it returns a Tuple. + +```python +holdings,dd = openbb.portfolio.maxdd(P) +dd = pd.DataFrame(dd) +dd.rename(columns = {'Total': 'Portfolio % Drawdown'}, inplace = True) +holdings = pd.DataFrame(holdings) +holdings.rename(columns = {'Total': 'Portfolio Value'}, inplace = True) +dd = dd.join(holdings) +dd.index = dd.index.strftime(date_format='%Y-%m-%d') +print(dd.tail(5)) +``` + +| Date | Portfolio % Drawdown | Portfolio Value | +|:-----------|-------------:|-----------:| +| 2022-11-21 | -0.58 | 109442 | +| 2022-11-22 | -0.57 | 111257 | +| 2022-11-23 | -0.56 | 114017 | +| 2022-11-24 | -0.56 | 114027 | +| 2022-11-25 | -0.56 | 113302 | + +MaxDD also has a `_chart` command, and is called with: + +```python +openbb.portfolio.maxdd_chart(P) +``` + +![openbb.portfolio.maxdd_chart](https://user-images.githubusercontent.com/85772166/204072456-f6b8e038-08ef-4ac5-9920-14a9c1e4197f.png "openbb.portfolio.maxdd_chart") + +### RSharpe + +Calculate a rolling sharpe ratio over a specified window. + +```python +rs = openbb.portfolio.rsharpe(P, window = '3m') +rs.rename(columns = {'portfolio': 'Portfolio Sharpe', 'benchmark': 'Benchmark Sharpe'}, inplace = True) +rs.index = rs.index.strftime(date_format='%Y-%m-%d') +print(rs.tail(5)) +``` + +| Date | Portfolio Sharpe | Benchmark Sharpe | +|:-----------|-------------------:|-------------------:| +| 2022-11-21 | -0.15 | 0.02 | +| 2022-11-22 | -0.13 | 0.05 | +| 2022-11-23 | -0.09 | 0.07 | +| 2022-11-24 | -0.09 | 0.08 | +| 2022-11-25 | -0.09 | 0.11 | + +### RVol + +`openbb.portfolio.rvol` has the same input parameters as `rsharpe`. + +```python +rv = openbb.portfolio.rvol(P, window = '3m') +rv.rename(columns={'portfolio': 'Portfolio Volatility', 'benchmark': 'Benchmark Volatility'}, inplace = True) +rv.index = rv.index.strftime(date_format='%Y-%m-%d') + +print(rv.tail(5)) +``` + +| Date | Portfolio Volatility | Benchmark Volatility | +|:-----------|-----------------------:|---------------------:| +|2022-11-23 | 0.021727 | 0.014490| +|2022-11-24 | 0.021715 | 0.014439| +|2022-11-25 | 0.021596 | 0.014256| +|2022-11-26 | 0.021591 | 0.014256| +|2022-11-27 | 0.021592 | 0.014256| + +### DRet + +`openbb.portfolio.dret` returns a DataFrame with daily returns of the portfolio and benchmark. + +```python +returns = openbb.portfolio.dret(P) +returns.rename(columns = {'portfolio': 'Portfolio % Returns', 'benchmark': 'Benchmark % Returns'}, inplace = True) +returns.index = returns.index.rename('Date') + +print(returns.tail(5)) +``` + +| Date | Portfolio % Returns | Benchmark % Returns | +|:-----------|----------------------:|----------------------:| +| 2022-11-21 | -0.03 | -0.00 | +| 2022-11-22 | 0.02 | 0.01 | +| 2022-11-23 | 0.02 | 0.01 | +| 2022-11-24 | 0.00 | 0.00 | +| 2022-11-25 | -0.01 | 0.00 | + +Read the [Portfolio Optimization Intro](/sdk/data-available/portfolio/po) to learn about the optimization features, and the parameters preset template. diff --git a/website/content/sdk/data-available/portfolio/po.md b/website/content/sdk/data-available/portfolio/po.md new file mode 100644 index 000000000000..2ee4d4a60114 --- /dev/null +++ b/website/content/sdk/data-available/portfolio/po.md @@ -0,0 +1,201 @@ +--- +title: Portfolio Optimization +description: This page provides comprehensive instructions on Portfolio Optimization, + ranging from mean-variance optimization to risk parity models and hierarchical clustering + models. Detailed Python script examples are provided to guide the user through the + optimization process using methods like Risk Parity, applying Hierarchical Risk + Parity, and calculating portfolio returns and drawdowns. +keywords: +- Portfolio Optimization +- mean-variance optimization +- risk parity models +- hierarchical clustering models +- Python scripting +- Risk Parity +- CVaR +- Hierarchical Risk Parity +- portfolio returns histogram +- portfolio drawdowns +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +The Portfolio Optimization menu allows the user to apply advanced optimization techniques to a portfolio of any type and of any size. It does so by introducing a multitude of optimization techniques ranging from mean-variance optimization to risk parity models and hierarchical clustering models. By providing Excel templates, the user can make sense of the vast array of parameters that each command has. E.g. think of the historic period you wish to use or which of the more than 10 risk measures and covariance methods should be used? These are questions the templates make easier to answer. + +The capabilities of the [Portfolio Optiminzation menu](/terminal/data-available/portfolio/po) from the OpenBB Terminal are wrapped into a powerful SDK, enabling users to work with the data in a flexible environment that can be fully customized to meet the needs of any user. These functionalities allow the user to apply advanced optimization techniques to a portfolio of any type and of any size. It does so by introducing a multitude of optimization techniques ranging from mean-variance optimization to risk parity models and hierarchical clustering models. By providing Excel templates, the user can make sense of the vast array of parameters that each command has. E.g. think of the historic period you wish to use or which of the more than 10 risk measures and covariance methods should be used? These are questions the templates make easier to answer. + +## How to use +Start a Python script or Notebook file by importing the module: + +```python +from openbb_terminal.sdk import openbb +``` + +This menu requires the usage of the Excel templates to work properly. As there is a lot of complexity involved around these techniques, these templates allow the user to understand what values for each parameter are actually used and allow for an easy way to define the allocation. + +:::note If you wish to load in your own Excel allocation file, please follow the following steps: +1. Download the Excel file that can be used as a template [here](https://www.dropbox.com/s/wp1lcq86exyngjy/allocation_example.xlsx?dl=0). +2. Move the file inside the `portfolio/allocation` folder within the [OpenBBUserData](/terminal/usage/data/custom-data) folder and, optionally, adjust the name to your liking. +3. Open the Excel file and remove, edit or add to the values as you desire (e.g. your own allocation). This is the default template that is also loaded in with `load --example`. +4. The file can now be used by following the guide. +::: + +Furthermore, given the amount of options you can choose from in each command and giving the complexity of the topic, we also provide a parameter file (both .xlsx and .ini to adjust parameters in a user-friendly way). + +:::note If you wish to load in your own Excel or ini parameter file, please follow the following steps: +1. Download the file that can be used as a template: [xlsx](https://www.dropbox.com/s/qfhd7ntj7mlwsuc/parameters_template.xlsx?dl=0) (recommended) or [ini](https://www.dropbox.com/s/3ehwg3hiwm89hgo/parameters_template.ini?dl=0) (advanced). +2. Move the file inside the `portfolio/optimization` folder within the [OpenBBUserData](/terminal/usage/data/custom-data) folder and, optionally, adjust the name to your liking. +3. Open the file and set parameters as you wish. +4. Open up the OpenBB Terminal, go to `portfolio/po` and type `file --file`. The file should then be one of the options. +::: + +### OpenBB Parameters Template +This template provides the user with the ability to set define values for each parameter based on the optimization technique that is deployed. E.g. if you select `riskparity` for the `technique` parameter, you will notice that some parameters turn grey. This means that the parameter is irrelevant for the selected method. + +The OpenBB Terminal does, however, allow the user to run any model despite the `technique` you selected. Therefore, if you are interested in running multiple models, consider removing the value for `technique`. Do note that this makes it more difficult to understand which values are used for which model. + +OpenBB Parameters Template + +### OpenBB Portfolio Template +This template hands the user a format to work with it to define the portfolio. Here, categorization is applied based on asset class, sector, industry, country and currency. By using the dropdown menus within this Excel, you are able to apply the proper categorization. This is based on the same methodology as found in other areas of the terminal. + +OpenBB Portfolio Template + +You can load in the portfolio template with the following code: + +```python +import pandas as pd + +# Define your own orderbook path here, current value won't work +order_book_path = "allocation_example.xlsx" + +# Read in the file +order_book = pd.read_excel(order_book_path) + +# Adjust the columns accordingly +order_book_cols = ['Ticker', 'Asset Class', 'Sector', 'Industry', 'Country', + 'Current Invested Amount', 'Currency'] + +order_book = order_book[order_book_cols] + +# Load in the portfolio +p = openbb.portfolio.po.load(symbols_file_path=order_book_path) +weights, performance = openbb.portfolio.po.equal(portfolio_engine=p) +``` + +### Performing optimization +Based on the parameters and allocation the user has set, the optimization process begins. What optimization technique is ideal depends entirely on the user's risk profile and objectives. As an illustration, Risk Parity is presented below: + +```python +# Perform calculations +weights_riskparity, data_returns_riskparity = openbb.portfolio.po.riskparity(p) + +weights_riskparity +``` + +Which returns: + +| | Risk Parity | +|:------|--------------:| +| AAPL | 0.0462 | +| AMZN | 0.04545 | +| APTV | 0.03177 | +| ASML | 0.03328 | +| BABA | 0.04192 | +| GOOGL | 0.04758 | +| HYG | 0.13093 | +| NKE | 0.04909 | +| TIP | 0.30826 | +| TLT | 0.21927 | +| TSM | 0.04626 | + +It is possible to use the commands without loading in the parameters template or by using the parameters template but changing some arguments directly into the terminal. For example, using the same method as described above, the risk measure is changed to Conditional Value at Risk (CVaR) and the used historic period is increased to 10 years (keeping all other parameters unchanged): + +```python +# Perform calculations +weights_riskparity, data_returns_riskparity = openbb.portfolio.po.riskparity(p, interval="5y", risk_measure="CVaR") + +weights_riskparity +``` + +Which returns: + +| | Risk Parity | +|:------|--------------:| +| AAPL | 0.04843 | +| AMZN | 0.04302 | +| APTV | 0.03907 | +| ASML | 0.03717 | +| GOOGL | 0.04877 | +| HYG | 0.14643 | +| NKE | 0.05275 | +| TIP | 0.33264 | +| TLT | 0.20371 | +| TSM | 0.04802 | + + + +## Examples +Starting by loading in the same dataset again with the following: + +```python +import pandas as pd + +# Define your own orderbook path here, current value won't work +order_book_path = "allocation_example.xlsx" + +# Read in the file +order_book = pd.read_excel(order_book_path) + +# Adjust the columns accordingly +order_book_cols = ['Ticker', 'Asset Class', 'Sector', 'Industry', 'Country', + 'Current Invested Amount', 'Currency'] + +order_book = order_book[order_book_cols] + +# Load in the portfolio +P = openbb.portfolio.po.load(symbols_file_path=order_book_path) +``` + +Then, the Hierarchical Risk Parity technique is applied by using the following: + +```python +riskparity, data_returns_riskparity = openbb.portfolio.po.hrp(p, interval="5y", + risk_measure='SLPM', + risk_aversion=0.8) + +print(riskparity) +print(data_returns_riskparity) +``` + +This results in a similar result as the following: + +| | Hierarchical Risk Parity | +|:------|---------------------------:| +| A | 0.00199 | +| AAL | 0.00104 | +| AAP | 0.00185 | +| AAPL | 0.00184 | +| ABBV | 0.0028 | +| ... | ... | +| NOC | 0.00228 | +| XOM | 0.00167 | +| ZBRA | 0.00156 | +| ZION | 0.0014 | +| ZTS | 0.00225 | + +It is possible to delve further into these findings with the `plot` functionality for example done by looking at the portfolio's returns histogram which also includes a variety of risk measures as well as the portfolio's drawdowns. + +```` +openbb.portfolio.po.plot(p, category='SECTOR', chart_type="hist") +```` + +Portfokio Returns Histogram + +```` +openbb.portfolio.po.plot(p, category='SECTOR', chart_type="dd") +```` + +Portfolio Drawdowns diff --git a/website/content/sdk/data-available/quantitative-analysis.md b/website/content/sdk/data-available/quantitative-analysis.md new file mode 100644 index 000000000000..8a3250ae9b91 --- /dev/null +++ b/website/content/sdk/data-available/quantitative-analysis.md @@ -0,0 +1,182 @@ +--- +title: Quantitative Analysis +description: The page provides a comprehensive guide on how to use the 'qa' module + of the Terminal's Quantitative Analysis menu for SDK environment. It contains detailed + information about the grouping of functions into categories, examples on their usage, + and how they provide users more ways to interact with the function library. +keywords: +- Quantitative Analysis +- SDK Environment +- Library of Functions +- Code Completion +- Statistics +- Risk Management +- API Integration +- Data Relation +- Nasdaq Data Link API +- Risk-Adjusted Return +- openbb.qa +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +The `qa` module is the Terminal's Quantitative Analysis menu for the SDK environment. It provides users with more ways to interact with the library of functions, and provides cross-disciplinary utility. To activate the code completion for the menu, enter `.` after, `openbb.qa`. + +## How to Use + +The functions of the `qa` module are grouped into categories, listed below along with a short description. + +|Path |Type |Description | +|:----------|:----------:|--------------------:| +|openbb.qa.acf |Plot |Plots Auto and Partial Correlation of Returns and Change in Returns| +|openbb.qa.bw |Plot |Box and Whisker Plot | +|openbb.qa.calculate_adjusted_var |Risk |Calculates VaR, adjusted for skew and kurtosis (Cornish-Fisher-Expansion) | +|openbb.qa.cdf |Plot |Plots the Cumulative Distribution Function | +|openbb.qa.cusum |Plot |Plots the Cumulative Sum Algorithm | +|openbb.qa.decompose |Plot |Decomposition in Cyclic-Trend, Season & Residuals of Prices | +|openbb.qa.es |Statistics |Expected Shortfall per percentile | +|openbb.qa.kurtosis |Rolling Metrics |Rolling Kurtosis of Distribution of Prices | +|openbb.qa.line |Plot |Customizable Line Plot, With Annotations | +|openbb.qa.normality |Statistics |Normality Statistics and Tests | +|openbb.qa.omega |Risk |Omega Ratio (Risk/Return Performance Measure) | +|openbb.qa.quantile |Rolling Metrics |Rolling Median and Quantile of Prices | +|openbb.qa.qqplot |Plot |QQ Plot for Data Against Normal Quantiles | +|openbb.qa.rolling |Rolling Metrics |Rolling Mean and Standard Deviation of Prices | +|openbb.qa.sharpe |Risk |Sharpe Ratio (Measure of Risk-Adjusted Return) | +|openbb.qa.skew |Rolling Metrics |Rolling Skewness of Distribution of Prices | +|openbb.qa.sortino |Risk |Sortino Ratio Risk Adjustment Metric | +|openbb.qa.spread |Rolling Metrics |Rolling Variance and Standard Deviation of Prices | +|openbb.qa.summary |Statistics |A Brief Summary of Statistics for the DataFrame | +|openbb.qa.unitroot |Statistics |Normality Statistics and Tests | +|openbb.qa.var |Risk |Value at Risk | + +## Examples + +### Import Statements + +The examples below will assume that the following statements are included in the first block of code: + +```python +import quandl +import pandas as pd +from openbb_terminal.sdk import openbb +from openbb_terminal import config_terminal as cfg + +# %matplotlib inline (uncomment if using a Jupyter environment) +``` + +### Get Data + +This example collects data from Nasdaq Data Link, and requires registering for a free API key. Qunadl is the Python client for the Nasdaq Data Link API. + +```python +shiller_pe_rdiff = quandl.get('MULTPL/SHILLER_PE_RATIO_MONTH', collapse = 'monthly', transform = 'rdiff', api_key = cfg.API_KEY_QUANDL) +shiller_pe_rdiff.rename(columns={'Value':'P/E % Change'}, inplace = True) +shiller_pe_ratio = quandl.get('MULTPL/SHILLER_PE_RATIO_MONTH', collapse = 'monthly', api_key = cfg.API_KEY_QUANDL) +shiller_pe_ratio.rename(columns={'Value':'P/E Ratio'}, inplace = True) + +sp500_inf_adj = quandl.get('MULTPL/SP500_INFLADJ_MONTH', collapse = 'monthly', api_key = cfg.API_KEY_QUANDL) +sp500_inf_adj.rename(columns = {'Value': 'S&P Inflation-Adjusted Value'}, inplace = True) +sp500_inf_adj_rdiff = quandl.get('MULTPL/SP500_INFLADJ_MONTH', collapse = 'monthly', transform = 'rdiff', api_key = cfg.API_KEY_QUANDL) +sp500_inf_adj_rdiff.rename(columns = {'Value':'S&P 500 % Change'}, inplace = True) + +shiller_pe = shiller_pe_ratio.join(shiller_pe_rdiff) +sp500_inf_adj = sp500_inf_adj.join(sp500_inf_adj_rdiff) + +sp500_df = sp500_inf_adj.join(shiller_pe) + +sp500_df +``` + +| Date | S&P Inflation-Adjusted Value | S&P 500 % Change | P/E Ratio | P/E % Change | +|:--------------------|-------------------------------:|-------------------:|------------:|---------------:| +| 2022-08-31 00:00:00 | 3955 | 0.0092504 | 29.64 | 0.022069 | +| 2022-09-30 00:00:00 | 3585.62 | -0.0933957 | 26.84 | -0.0944669 | +| 2022-10-31 00:00:00 | 3871.98 | 0.0798635 | 28.53 | 0.0629657 | +| 2022-11-30 00:00:00 | 3856.1 | -0.00410126 | 28.37 | -0.00560813 | + +This particular data series contains 150 years of monthly values. It is among the longest uninterrupted timeseries available in the public domain, and it is cited frequently in macroeconomic research. + +### Summary + +Get a summary of statistics for each column with `qa.summary`: + +```python +openbb.qa.summary(sp500_df) +``` + +| | S&P Inflation-Adjusted Value | S&P 500 % Change | P/E Ratio | P/E % Change | +|:------|-------------------------------:|-------------------:|------------:|---------------:| +| count | 1823 | 1822 | 1822 | 1821 | +| mean | 697.396 | 0.0028703 | 16.9914 | 0.00137084 | +| std | 834.501 | 0.0424378 | 7.07094 | 0.0412196 | +| min | 80.31 | -0.264738 | 4.78 | -0.268992 | +| 10% | 152.404 | -0.0447494 | 9.31 | -0.0449735 | +| 25% | 203.47 | -0.0172803 | 11.7 | -0.0183028 | +| 50% | 309.83 | 0.00553122 | 15.895 | 0.00446999 | +| 75% | 778.42 | 0.0260009 | 20.5575 | 0.0246575 | +| 90% | 1907.87 | 0.04505 | 26.467 | 0.0426357 | +| max | 4786.79 | 0.514085 | 44.19 | 0.511986 | +| var | 696392 | 0.00180097 | 49.9982 | 0.00169906 | + +### Spread + +Add the variance and standard deviation, over a specified window (three-months), to the DataFrame: + +```python +std,variance = openbb.qa.spread(data = sp500_df['S&P 500 % Change'], window = 3) +std.rename(columns = {'STDEV_3':'Three-Month Standard Deviation'}, inplace = True) +variance.rename(columns = {'VAR_3': 'Three-Month Variance'}, inplace =True) +sp500_df = sp500_df.join([std,variance]) +sp500_df.rename_axis('date', inplace = True) +sp500_df.tail(2) +``` + +| date | S&P Inflation-Adjusted Value | S&P 500 % Change | P/E Ratio | P/E % Change | Three-Month Standard Deviation | Three-Month Variance | +|:--------------------|-------------------------------:|-------------------:|------------:|---------------:|---------------------------------:|-----------------------:| +| 2022-10-31 00:00:00 | 3871.98 | 0.0798635 | 28.53 | 0.0629657 | 0.0871217 | 0.00759019 | +| 2022-11-30 00:00:00 | 3856.1 | -0.00410126 | 28.37 | -0.00560813 | 0.0866432 | 0.00750705 | + +The rolling mean average and standard deviation is calculated with the `rolling` command. Adding, `_chart`, to this will return an inline chart within a Jupyter Notebook. For the example below, window, `60`, represents a five-year period. + +### Rolling + +```python +openbb.qa.rolling_chart(sp500_df, target = 'P/E Ratio', window = 60, symbol = '') +``` + +![openbb.qa.rolling_chart](https://user-images.githubusercontent.com/85772166/202975615-4400ae87-9cd7-4481-94f1-dfb69de784d6.png "openbb.qa.rolling_chart") + +### Unit Root Test + +Perform a unit root test with `unitroot`: + +```python +help(openbb.qa.unitroot) + + Parameters + ---------- + data : pd.DataFrame + DataFrame of target variable + fuller_reg : str + Type of regression of ADF test. Can be ‘c’,’ct’,’ctt’,’nc’ 'c' - Constant and t - trend order + kpss_reg : str + Type of regression for KPSS test. Can be ‘c’,’ct' + + Returns + ------- + pd.DataFrame + Dataframe with results of ADF test and KPSS test + +openbb.qa.unitroot(sp500_df['P/E % Change']) +``` + +| | ADF | KPSS | +|:---------------|---------------:|:--------------------| +| Test Statistic | -10.7075 | 0.34061374135067696 | +| P-Value | 3.3972e-19 | 0.1 | +| NLags | 20 | 2 | +| Nobs | 1800 | | +| ICBest | -6491.14 | | diff --git a/website/content/sdk/data-available/stocks/_category_.json b/website/content/sdk/data-available/stocks/_category_.json new file mode 100644 index 000000000000..297211823a46 --- /dev/null +++ b/website/content/sdk/data-available/stocks/_category_.json @@ -0,0 +1,3 @@ +{ + "label": "Stocks" +} diff --git a/website/content/sdk/data-available/stocks/behavioral-analysis.md b/website/content/sdk/data-available/stocks/behavioral-analysis.md new file mode 100644 index 000000000000..6bd8c106e040 --- /dev/null +++ b/website/content/sdk/data-available/stocks/behavioral-analysis.md @@ -0,0 +1,158 @@ +--- +title: Behavioral Analysis +description: This page provides insightful information on how to use the BA module + within the OpenBB Terminal. It gives detailed examples of utilizing various functions + in Python for stock sentiment analysis, region-based popularity, trending queries, + and more. +keywords: +- BA module +- Stock sentiment analysis +- Region-based popularity +- Trending queries +- Stocktwit's messages +- stock due diligence +- function and modules +- stock market +- sentiment prediction +- programming +- code completion +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +The BA module provides programmatic access to the commands from within the OpenBB Terminal. Import the OpenBB SDK module, and then access the functions similarly to how the Terminal menus are navigated. The code completion will be activated upon entering `.`, after, `openbb.ba` +​ + +## How to Use + +​ +The examples provided below will assume that the following import block is included at the beginning of the Python script or Notebook file: +​ + +```python +from openbb_terminal.sdk import openbb +``` + +​ +A brief description below highlights the main Functions and Modules available in the BA SDK + +| Path | Type | Description | +| :------------------------- | :--------: | -------------------------------------------: | +| openbb.stocks.ba.bullbear | Function | Estimate Quick Sentiment | +| openbb.stocks.ba.headlines | Function | Sentiment from 15+ News Headlines | +| openbb.stocks.ba.spacc | Function | Shows SPAC announcements from SPAC subreddit | +| openbb.stocks.ba.watchlist | Function | Show Other User's Watchlists | +| openbb.stocks.ba.messages | Function | Output last 30 messages on the board | +| openbb.stocks.ba.mentions | Function | Interest Over Time Based on Mentions | +| openbb.stocks.ba.hist | Function | Plot Historical RHI and AHI | +| openbb.stocks.ba.snews | Function | Stock Price Plotted Over Sentiment | +| openbb.stocks.ba.redditsent | Function | Search for Tickers and Find Sentiment | +| openbb.stocks.ba.popular | Function | Show Popular Tickers | +| openbb.stocks.ba.spac | Function | Shows Other User's SPAC Announcements | +| openbb.stocks.ba.getdd | Function | Get Due Diligence | +| openbb.stocks.ba.regions | Function | Regions Showing the Highest Interest | +| openbb.stocks.ba.trending | Function | Trending Stocks | +| openbb.stocks.ba.wsb | Function | Highlights from WSB Subreddit | +| openbb.stocks.ba.queries | Function | Top Related Queries | +| openbb.stocks.ba.sentiment | Function | Stock Sentiment Prediction from Last Tweets | +| openbb.stocks.ba.infer | Function | Stock Sentiment from Last Tweets | +| openbb.stocks.ba.stalker | Function | Stocktwit's last messages | +| openbb.stocks.ba.rise | Function | Top Rising Related Queries | + +Alternatively you can print the contents of the BA SDK with: + +```python +help(openbb.stocks.ba) +``` + +## Examples + +### headlines + +Sentiment from over 15 news headlines for each day. This data can be used for further analysis of the stock + +```python +openbb.stocks.ba.headlines("TSLA") +``` + +| date | Sentiment Analysis | +|:--------------------|---------------------:| +| 2022-11-09 00:00:00 | 0.209 | +| 2022-11-10 00:00:00 | -0.025 | +| 2022-11-11 00:00:00 | 0.027 | +| 2022-11-14 00:00:00 | -0.402 | +| 2022-11-15 00:00:00 | -0.122 | +| 2022-11-16 00:00:00 | -0.35 | +| 2022-11-17 00:00:00 | 0.156 | +| 2022-11-18 00:00:00 | 0.216 | +| 2022-11-21 00:00:00 | -0.071 | +| 2022-11-22 00:00:00 | -0.003 | + +### regions + +See the top regions where a stock is searched + +```python +openbb.stocks.ba.regions("TSLA") +``` + +| geoName | TSLA | +|:---------------------------------------|-------:| +| Canada | 100 | +| United States | 95 | +| Singapore | 94 | +| Estonia | 51 | +| Taiwan | 50 | +| Slovenia | 40 | +| Switzerland | 36 | +| Denmark | 36 | +| New Zealand | 33 | +| Sweden | 31 | +| Finland | 24 | +| Australia | 24 | +| Belgium | 22 | +| Czechia | 20 | +| Bulgaria | 18 | +| United Arab Emirates | 17 | +| United Kingdom | 15 | +| Portugal | 12 | +| Austria | 11 | +| Romania | 10 | +| South Africa | 7 | +| Saudi Arabia | 7 | +| Germany | 7 | +| Argentina | 6 | +| Spain | 6 | +| France | 4 | +| Colombia | 4 | +| Philippines | 4 | +| Brazil | 4 | +| Thailand | 4 | +| Poland | 3 | +| Vietnam | 2 | +| Russia | 2 | +| Turkey | 2 | +| Pakistan | 0 | + +### rise + +See which search queries are popular right now + +```python +openbb.stocks.ba.rise("AAPL") +``` + +| | query | value | +|---:|:----------------|--------:| +| 0 | nio | 220300 | +| 1 | nio stock | 106650 | +| 2 | pltr stock | 64750 | +| 3 | mrna stock | 59750 | +| 4 | nio stock price | 53450 | +| 5 | zm stock | 49500 | +| 6 | bynd | 44850 | +| 7 | pltr | 41000 | +| 8 | spce | 37350 | +| 9 | zm | 31650 | diff --git a/website/content/sdk/data-available/stocks/comparison-analysis.md b/website/content/sdk/data-available/stocks/comparison-analysis.md new file mode 100644 index 000000000000..b772d0be4e66 --- /dev/null +++ b/website/content/sdk/data-available/stocks/comparison-analysis.md @@ -0,0 +1,162 @@ +--- +title: Comparison Analysis +description: Learn how to use the CA module of the OpenBB Terminal SDK for functionalities + like balance financials comparison, historical price correlation, sentiment analysis + comparison and more using Python. Discover the list of similar companies, historical + volume data comparison and more. +keywords: +- OpenBB Terminal SDK +- CA module OpenBB +- Python SDK for OpenBB Terminal +- financial analysis using Python +- stock data analysis +- Python stock data +- market sentiment analysis +- financial comparison using Python +- openbb.stocks.ca functions +- historical price correlation +- sentiment analysis comparison +- similar companies list +- historical volume data comparison +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +The CA module provides programmatic access to the commands from within the OpenBB Terminal menu. Import the OpenBB SDK module, and then access the functions similarly to how the Terminal menus are navigated. The code completion will be activated upon entering `.`, after, `openbb.ca` + +## How to Use + +The examples provided below will assume that the following import block is included at the beginning of the Python script or Notebook file: + +```python +from openbb_terminal.sdk import openbb +``` + +A brief description below highlights the functions available within the module: + +| Path | Type | Description | +| :-------------------------------- | :--------: | -------------------------------------------: | +| openbb.stocks.ca.balance | Function | Balance Financials Comparison | +| openbb.stocks.ca.cashflow | Function | Cashflow Financials Comparison | +| openbb.stocks.ca.hcorr | Function | Historical Price Correlation | +| openbb.stocks.ca.hist | Function | Historical Price Data Comparison | +| openbb.stocks.ca.income | Function | Income Financials Comparison | +| openbb.stocks.ca.scorr | Function | Sentiment Correlation | +| openbb.stocks.ca.screener | Function | Screener Overview | +| openbb.stocks.ca.sentiment | Function | Sentiment Analysis Comparison | +| openbb.stocks.ca.similar | Function | Get a List of Similar Companies | +| openbb.stocks.ca.volume | Function | Historical Volume Data Comparison | + +Alternatively, the contents of the menu is printed with: + +```python +help(openbb.stocks.ca) +``` + +## Examples + +### Balance + +`openbb.stocks.ca.balance` compares the balance sheets for a list of companies. + +```python +openbb.stocks.ca.balance(["TSLA","F", "GE"], timeframe = '2021') +``` + +| Item | TSLA | F | GE | +|:-------------------------------------|:-------|:--------|:--------| +| Cash & Short Term Investments | 18.05B | 49.59B | 28.07B | +| Cash & Short Term Investments Growth | -8.00% | -0.74% | -35.99% | +| Cash Only | 17.92B | 20.54B | 15.77B | +| Short-Term Investments | - | - | - | +| Cash & ST Investments / Total Assets | 29.05% | 19.29% | 14.11% | +| Total Accounts Receivable | 1.91B | 44.04B | 20.5B | +| Total Accounts Receivable Growth | 1.43% | -16.24% | -8.70% | +| Accounts Receivables, Net | 1.91B | 43.91B | 20.5B | +| Accounts Receivables, Gross | 1.91B | 44.28B | 21.58B | +| Bad Debt/Doubtful Accounts | - | (366M) | (1.07B) | +| Other Receivable | - | - | - | +| Accounts Receivable Turnover | 28.14 | 3.10 | 3.62 | +| Inventories | 5.76B | 12.07B | 15.85B | +| Finished Goods | 1.28B | 6.28B | 4.93B | +| Work in Progress | 1.09B | - | - | +| Raw Materials | 3.39B | 5.79B | 8.71B | +| Progress Payments & Other | - | - | 2.21B | +| Other Current Assets | 1.38B | 3.3B | 1.93B | +| Miscellaneous Current Assets | 1.38B | 3.3B | 1.93B | +| Total Current Assets | 27.1B | 109B | 66.35B | +| Net Property, Plant & Equipment | 31.18B | 64.84B | 15.61B | +| Property, Plant & Equipment - Gross | 39.87B | 101.99B | 31.9B | +| Buildings | 4.68B | 12.44B | 8.31B | +| Land & Improvements | - | 450M | 585M | +| Computer Software and Equipment | 1.41B | 4.6B | - | +| Other Property, Plant & Equipment | 18.73B | 11.4B | - | +| Accumulated Depreciation | 8.69B | 37.16B | 16.3B | +| Total Investments and Advances | 223M | 5.64B | 42.21B | +| Other Long-Term Investments | 223M | 197M | 42.21B | +| Long-Term Note Receivables | 299M | 51.26B | - | +| Intangible Assets | 1.72B | 619M | 35.51B | +| Net Goodwill | 200M | 619M | 26.18B | +| Net Other Intangibles | - | - | - | +| Other Assets | 1.62B | 11.89B | 28.34B | +| Total Assets | 62.13B | 257.04B | 198.87B | +| Total Assets Growth | 19.14% | -3.83% | -22.38% | + +### Sentiment + +Social sentiment over time, for a list of tickers: + +```python +openbb.stocks.ca.sentiment(["tsla", "f", "ge"]) +``` + +| | TSLA | F | GE | +|:-----------|-------:|------:|------:| +| 2022-11-08 | -0.028 | 0.382 | 0.328 | +| 2022-11-09 | 0.209 | 0.199 | 0.242 | +| 2022-11-10 | -0.025 | 0.178 | 0.112 | +| 2022-11-11 | 0.027 | 0.086 | 0.056 | +| 2022-11-14 | -0.402 | 0.105 | 0.104 | +| 2022-11-15 | -0.122 | 0.081 | 0.075 | +| 2022-11-16 | -0.35 | 0.179 | 0.086 | +| 2022-11-17 | 0.156 | 0.387 | 0.025 | +| 2022-11-18 | 0.216 | 0.093 | 0.019 | +| 2022-11-21 | -0.071 | 0.069 | 0.01 | + +### Screener + +Show a high-level overview of company information for tickers in a given list + +```python +openbb.stocks.ca.screener(["f", "ge", "tsla"]) +``` + +| | Ticker | Company | Sector | Industry | Country | Market Cap | P/E | Price | Change | Volume | +|---:|:---------|:-------------------------|:------------------|:-------------------------------|:----------|-------------:|-------:|--------:|---------:|------------:| +| 0 | F | Ford Motor Company | Consumer Cyclical | Auto Manufacturers | USA | 5.577e+10 | 6.31 | 13.95 | -0.0029 | 3.40871e+07 | +| 1 | GE | General Electric Company | Industrials | Specialty Industrial Machinery | USA | 9.375e+10 | nan | 85.89 | 0.0048 | 3.26976e+06 | +| 2 | TSLA | Tesla, Inc. | Consumer Cyclical | Auto Manufacturers | USA | 5.3886e+11 | 51.72 | 167.87 | -0.0684 | 9.28827e+07 | + + +### HCorr + +Calculates the historical price (or returns) correlation for a list of tickers, over a specified window. + +```python +correlation,historical = ( + openbb.stocks.ca.hcorr(similar = openbb.stocks.ca.similar('TSLA', source = 'Polygon'), + candle_type = 'R', + start_date = '2018-11-01' + ) +) +correlation +``` + +| | HMC | TM | F | GM | +|:----|---------:|---------:|---------:|---------:| +| HMC | 1 | 0.74425 | 0.596182 | 0.62178 | +| TM | 0.74425 | 1 | 0.532589 | 0.539333 | +| F | 0.596182 | 0.532589 | 1 | 0.787406 | +| GM | 0.62178 | 0.539333 | 0.787406 | 1 | diff --git a/website/content/sdk/data-available/stocks/dark-pool-shorts.md b/website/content/sdk/data-available/stocks/dark-pool-shorts.md new file mode 100644 index 000000000000..9491fcc09ff6 --- /dev/null +++ b/website/content/sdk/data-available/stocks/dark-pool-shorts.md @@ -0,0 +1,235 @@ +--- +title: Dark Pools and Short Data +description: This is SEO data for a documentation page for the DPS sub-module within + the OpenBB Terminal. The page provides details on using commands for US-listed equities + with data reported to FINRA. It covers various areas of technical trading such as + settlement schedules, market flow, and volume dynamics, and specifically emphasizes + the use of the module in conducting dark pools and shorts research. +keywords: +- DPS sub-module +- OpenBB terminal +- US-listed equities +- FINRA +- Interactive Brokers +- dark pools and shorts +- short volume +- dark pool position +- technical trading +- settlement schedules +- market flow +- volume dynamics +- stock market research +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +The `DPS` sub-module contains the commands from the [Dark Pools and Short Data menu](/terminal/data-available/stocks/dark-pool-shorts) within the OpenBB Terminal. These functions are meant to supplement other research on technical trading factors, settlement schedules, market flow, and volume dynamics. Commands are specifically for US-listed equities, and the data is reported to [FINRA](https://www.finra.org/#/) on a lagging schedule. Some will also have a `_chart` companion. + +## How to Use + +Each function contained within the `openbb.stocks.dps` module is listed below with a short description. + +|Path |Description | +|:----|-----------:| +|openbb.stocks.dps.ctb |Current Borrow Rates from Interactive Brokers | +|openbb.stocks.dps.dpotc |Weekly Volume Totals for a Ticker on ATS and OTC Venues | +|openbb.stocks.dps.ftd |Historical Fails-to-Deliver Numbers | +|openbb.stocks.dps.hsi |Stocks With High Reported Short Interest | +|openbb.stocks.dps.pos |Top Short Volumes From Last Trading Day | +|openbb.stocks.dps.prom |Tickers With Growing Trade Activity on ATS Tapes | +|openbb.stocks.dps.psi |Price vs. Short Volume | +|openbb.stocks.dps.shorted |Most Shorted Stocks According to Yahoo Finance | +|openbb.stocks.dps.sidtc |Short Interest and Days-to-Cover | +|openbb.stocks.dps.spos |Rolling 20-Day Net Short Volume of a Single Stock| + +## Examples + +### Import Statements + +Start out the Python script or Notebook file with the familiar statements: + +```python +from openbb_terminal.sdk import openbb +import pandas as pd +``` + +### CTB + +`openbb.stocks.dps.ctb` gets the current borrow rate and availability, on Interactive Brokers, for all tickers. + +```python +ctb_df = openbb.stocks.dps.ctb() + +ctb_df +``` + +| | Symbol | Fees | Available | +|---:|:---------|:----------|------------:| +| 0 | PCF | 864.8795% | 100000 | +| 1 | EPR PRE | 625.0102% | 80000 | +| 2 | KITT | 574.4353% | 100 | +| 3 | EFSH | 439.7636% | 2000 | +| 4 | EVTL | 434.336% | 9000 | +| 17655 | DSAIF | 0.0% | 1000 | +| 17656 | DRREF | 0.0% | 25000 | +| 17657 | DOSEF | 0.0% | 100 | +| 17658 | DMYY | 0.0% | 100000 | +| 17659 | DLICY | 0.0% | 100 | + +### POS + +`openbb.stocks.dps.pos` represents the cumulative net short dollar volume (Dark Pool Position $) by security. Is it calculated by taking the net short volume (short volume minus buy volume - a positive number means that the short volume was higher than the buy volume) times the closing price and taking the 20-day cumulative sum of this series. [Source: Stockgrid.io](https://www.stockgrid.io/darkpools) + +- Net Short Volume: Short volume minus buy volume. +- Net Short Volume $: Net short volume multiplied by the last close. +- Position: The sum of the net short volume over the last 20 trading days. +- Position $: Position multiplied by the last close. + +Data is updated at 6pm EST. + +The function returns up to 400 results, applying `ascend = True` unlocks the most negative values. + +```python +pos_high = openbb.stocks.dps.pos() +pos_high = pos_high.convert_dtypes() +pos_high.set_index('Date', inplace = True) +pos_low = openbb.stocks.dps.pos(ascend = True) +pos_low = pos_low.convert_dtypes() +pos_low.set_index('Date', inplace = True) +pos_df = pd.concat([pos_low,pos_high]) +pos_df.sort_values(by=['Dark Pools Position $'], ascending = False, inplace = True) + +pos_df +``` + +| Date | Ticker | Short Volume | Short Volume % | Net Short Volume | Net Short Volume $ | Dark Pools Position | Dark Pools Position $ | +|:-----------|:---------|---------------:|-----------------:|-------------------:|---------------------:|----------------------:|------------------------:| +| 2022-11-25 | SPY | 10511774 | 0.638082 | 4549536 | 1.83041e+09 | 109490269 | 4.27107e+10 | +| 2022-11-25 | QQQ | 2952642 | 0.490496 | -114422 | -3.283e+07 | 130622909 | 3.6231e+10 | +| 2022-11-25 | NVDA | 6264211 | 0.62147 | 2448753 | 3.98412e+08 | 61850799 | 1.00604e+10 | +| 2022-11-25 | IWM | 3932703 | 0.541717 | 605706 | 1.12407e+08 | 34431260 | 6.31318e+09 | +| 2022-11-25 | HYG | 1170511 | 0.523497 | 105076 | 7.88175e+06 | 75184813 | 5.53232e+09 | +| 2022-11-25 | META | 1652587 | 0.359614 | -1290276 | -1.4375e+08 | -88892626 | -8.17035e+09 | +| 2022-11-25 | SQQQ | 6198104 | 0.358094 | -4912392 | -2.20223e+08 | -160324410 | -8.81487e+09 | +| 2022-11-25 | MSFT | 1246644 | 0.356497 | -1003640 | -2.48391e+08 | -60211625 | -1.41156e+10 | +| 2022-11-25 | TSLA | 14145558 | 0.480631 | -1140119 | -2.08482e+08 | -106217407 | -2.06849e+10 | +| 2022-11-25 | AMZN | 9907246 | 0.467855 | -1361394 | -1.27168e+08 | -238062247 | -2.26635e+10 | + +### SPOS + +`openbb.stocks.dps.spos` is a section of the same data above, but as a time-series for individual tickers. There is one-year of daily historical data available. + +```python +spy_spos = openbb.stocks.dps.spos('SPY') + +spy_spos.tail(5) +``` + +| | dates | Net Short Vol. (1k $) | Position (1M $) | +|---:|:--------------------|------------------------:|------------------:| +| 4 | 2021-12-03 00:00:00 | 1218.48 | 10786 | +| 3 | 2021-12-02 00:00:00 | 3224.17 | 9567.52 | +| 2 | 2021-12-01 00:00:00 | 2558.79 | 6343.35 | +| 1 | 2021-11-30 00:00:00 | 2737.27 | 3784.56 | +| 0 | 2021-11-29 00:00:00 | 1047.29 | 1047.29 | + +### PSI + +Price vs.Short Interest. This function has two data sources, with their own syntax. `openbb.stocks.dps.psi_sg` will return the other columns `openbb.stocks.dps.spos` is missing. The example below puts them all together. + +```python +spy_spos = openbb.stocks.dps.spos('SPY') +spy_spos.rename(columns = {'dates':'date'}, inplace= True) +spy_spos.set_index(keys = 'date', inplace =True) +spy_psi,spy_price = openbb.stocks.dps.psi_sg('SPY') +spy_psi.set_index('date', inplace = True) +spy_pos = spy_psi.join(spy_spos) + +spy_pos +``` + +| date | Short Vol. [1M] | Short Vol. % | Short Exempt Vol. [1k] | Total Vol. [1M] | Net Short Vol. (1k $) | Position (1M $) | +|:--------------------|------------------:|---------------:|-------------------------:|------------------:|------------------------:|------------------:| +| 2022-11-25 00:00:00 | 10.5118 | 63.81 | 37.129 | 16.474 | 1830.41 | 42710.7 | +| 2022-11-23 00:00:00 | 13.6484 | 60.55 | 91.552 | 22.5399 | 1914.28 | 42099.3 | +| 2022-11-22 00:00:00 | 10.0279 | 53.85 | 52.335 | 18.6233 | 572.874 | 42444.8 | +| 2022-11-21 00:00:00 | 9.42557 | 57.6 | 61.242 | 16.3632 | 981.734 | 42187.3 | +| 2022-11-18 00:00:00 | 18.445 | 60.68 | 112.603 | 30.3973 | 2571.31 | 42352.3 | +| 2022-02-16 00:00:00 | 11.0333 | 52.77 | 7.958 | 20.909 | 516.966 | 19836.2 | +| 2022-02-15 00:00:00 | 11.8138 | 57.01 | 36.259 | 20.7236 | 1295.52 | 21808.3 | +| 2022-02-14 00:00:00 | 12.744 | 53.08 | 50.473 | 24.0105 | 648.705 | 19105.9 | +| 2022-02-11 00:00:00 | 14.1183 | 46.63 | 55.511 | 30.2776 | -898.962 | 17553.7 | +| 2022-02-10 00:00:00 | 22.5696 | 62.98 | 46.454 | 35.834 | 4181.07 | 21316.8 | + +The other version of this command is, `openbb.stocks.dps.psi_q`. It returns daily short volume from Nasdaq and NYSE separately, with daily historic data going back to 2013, and is sourced by Quandl. The first table below is the short volume and from Nasdaq. + +```python +nasdaq_psi = openbb.stocks.dps.psi_q(nyse=False, symbol = 'SPY') + +nasdaq_psi.head(5) +``` + +| Date | ShortVolume | ShortExemptVolume | TotalVolume | +|:--------------------|--------------:|--------------------:|--------------:| +| 2013-04-01 00:00:00 | 8.99908e+06 | 3500 | 1.92365e+07 | +| 2013-04-02 00:00:00 | 1.15943e+07 | 6600 | 2.09414e+07 | +| 2013-04-03 00:00:00 | 1.89638e+07 | 13418 | 2.83739e+07 | +| 2013-04-04 00:00:00 | 1.29551e+07 | 7586 | 1.99661e+07 | +| 2013-04-05 00:00:00 | 1.43612e+07 | 0 | 2.81504e+07 | + +The second table is from NYSE + +```python +nyse_psi = openbb.stocks.dps.psi_q(nyse=True, symbol = 'SPY') + +nyse_psi.head(5) +``` + +| Date | ShortVolume | ShortExemptVolume | TotalVolume | +|:--------------------|--------------:|--------------------:|--------------:| +| 2013-04-01 00:00:00 | 1.04127e+06 | 3800 | 1.61224e+06 | +| 2013-04-02 00:00:00 | 1.47136e+06 | 4500 | 1.9255e+06 | +| 2013-04-03 00:00:00 | 2.43128e+06 | 0 | 3.23342e+06 | +| 2013-04-04 00:00:00 | 1.55106e+06 | 800 | 2.28563e+06 | +| 2013-04-05 00:00:00 | 1.94417e+06 | 300 | 2.93733e+06 | + +Let's join them together: + +```python +nyse_psi.join(nasdaq_psi, lsuffix = ' (NYSE)', rsuffix = ' (NQ)') +``` + +| Date | ShortVolume (NYSE) | ShortExemptVolume (NYSE) | TotalVolume (NYSE) | ShortVolume (NQ) | ShortExemptVolume (NQ) | TotalVolume (NQ) | +|:--------------------|---------------------:|---------------------------:|---------------------:|-------------------:|-------------------------:|-------------------:| +| 2013-04-01 00:00:00 | 1.04127e+06 | 3800 | 1.61224e+06 | 8.99908e+06 | 3500 | 1.92365e+07 | +| 2013-04-02 00:00:00 | 1.47136e+06 | 4500 | 1.9255e+06 | 1.15943e+07 | 6600 | 2.09414e+07 | +| 2013-04-03 00:00:00 | 2.43128e+06 | 0 | 3.23342e+06 | 1.89638e+07 | 13418 | 2.83739e+07 | +| 2013-04-04 00:00:00 | 1.55106e+06 | 800 | 2.28563e+06 | 1.29551e+07 | 7586 | 1.99661e+07 | +| 2013-04-05 00:00:00 | 1.94417e+06 | 300 | 2.93733e+06 | 1.43612e+07 | 0 | 2.81504e+07 | +| 2022-11-21 00:00:00 | 838081 | 171 | 2.05784e+06 | 8.47984e+06 | 61071 | 1.41414e+07 | +| 2022-11-22 00:00:00 | 1.24058e+06 | 273 | 2.45227e+06 | 8.70804e+06 | 52062 | 1.60467e+07 | +| 2022-11-23 00:00:00 | 1.82258e+06 | 524 | 3.35511e+06 | 1.17129e+07 | 91028 | 1.90024e+07 | +| 2022-11-25 00:00:00 | 410318 | 353 | 804984 | 1.00677e+07 | 36776 | 1.56151e+07 | + +### HSI + +`openbb.stocks.dps.hsi` lists the stocks with the highest reported short interest from NYSE or Nasdaq. + +```python +openbb.stocks.dps.hsi() +``` + +| | Ticker | Company | Exchange | ShortInt | Float | Outstd | Industry | +|---:|:---------|:-------------------------------|:-----------|:-----------|:--------|:---------|:-------------------------------------------| +| 0 | | | | | | | | +| 1 | BBBY | Bed Bath & Beyond Inc. | Nasdaq | 45.11% | 76.45M | 80.36M | Retail (Specialty Non-Apparel) | +| 2 | CVNA | Carvana Co | NYSE | 44.24% | 93.40M | 105.95M | Retail (Specialty Non-Apparel) | +| 3 | BYND | Beyond Meat Inc | Nasdaq | 42.75% | 57.25M | 63.74M | Food Processing | +| 4 | MSTR | MicroStrategy Inc | Nasdaq | 40.51% | 9.34M | 9.35M | Software & Programming | +| 31 | SPCE | Virgin Galactic Holdings Inc | NYSE | 20.98% | 208.85M | 274.56M | Aerospace & Defense | +| 32 | PETS | Petmed Express Inc | Nasdaq | 20.83% | 19.74M | 21.08M | Retail (Drugs) | +| 33 | RIDE | Lordstown Motors Corp | Nasdaq | 20.69% | 162.40M | 216.98M | Auto & Truck Manufacturers | +| 34 | FFIE | Faraday Future Intelligent Ele | Nasdaq | 20.67% | 242.00M | 386.26M | Auto & Truck Manufacturers | +| 35 | IGMS | IGM Biosciences Inc | Nasdaq | 20.57% | 17.31M | 29.14M | Biotechnology & Medical Research | diff --git a/website/content/sdk/data-available/stocks/discovery.md b/website/content/sdk/data-available/stocks/discovery.md new file mode 100644 index 000000000000..97619bad1d97 --- /dev/null +++ b/website/content/sdk/data-available/stocks/discovery.md @@ -0,0 +1,181 @@ +--- +title: Discovery +description: Documentation for the OpenBB SDK Disc module. The Disc module provides + programmatic access for Python to navigate the OpenBB Terminal, examples of functions + and modules aimed at stock trading operations. +keywords: +- OpenBB SDK Disc +- programmatic access +- stock trading +- terminal menus +- code completion +- IPO dates +- ' Penny Stocks' +- Top Gainers +- Tech Stocks +- Secure filings +- Earnings Growth +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +The Disc module provides programmatic access to the commands from within the OpenBB Terminal. Import the OpenBB SDK module, and then access the functions similarly to how the Terminal menus are navigated. The code completion will be activated upon entering `.`, after, `openbb.disc` +​ + +## How to Use + +​ +The examples provided below will assume that the following import block is included at the beginning of the Python script or Notebook file: +​ + +```python +from openbb_terminal.sdk import openbb +``` + +​ +A brief description below highlights the main Functions and Modules available in the ETF SDK + +| Path | Type | Description | +| :------------------------- | :--------: | -------------------------------------------: | +| openbb.stocks.disc.filings | Function | Feed of new filings to the SEC | +| openbb.stocks.disc.pipo | Function | Past IPO Dates | +| openbb.stocks.disc.active | Function | Stocks with Highest Trade Volumes | +| openbb.stocks.disc.gainers | Function | Latest Top Gainers | +| openbb.stocks.disc.asc | Function | Small Caps with Earnings Growth Above 25% | +| openbb.stocks.disc.lowfloat | Function | Stocks with Under 10M Shares Float | +| openbb.stocks.disc.fipo | Function | Future IPO Dates | +| openbb.stocks.disc.upcoming | Function | Upcoming Earnings Release Dates | +| openbb.stocks.disc.trending | Function | Trending News | +| openbb.stocks.disc.ulc | Function | Potentially Undervalued Large Cap Stocks | +| openbb.stocks.disc.arkord | Function | Orders of ARK Investment Management LLC | +| openbb.stocks.disc.hotpenny | Function | Hot Penny Stocks | +| openbb.stocks.disc.gtech | Function | Tech Stocks with Earnings Growth Over 25% | +| openbb.stocks.disc.losers | Function | Show Top Losers | +| openbb.stocks.disc.ugs | Function | Undervalueds with Earnings Growth Over 25% | +| openbb.stocks.disc.rtat | Function | Top 10 Retail Traded Stocks | +| openbb.stocks.disc.dividends | Function | Screener Overview | + +Alternatively you can print the contents of the Disc SDK with: + +```python +help(openbb.stocks.disc) +``` + +## Examples + +## filings + +Get the most-recent form submissions to the SEC. + +```python +filings = openbb.stocks.disc.filings() +filings.head(3) +``` + +| Date | Ticker | CIK | Form Type | Title | URL | +|:--------------------|:---------|--------:|:------------|:------------------------------------------------|:--------------------------------------------------------------------------------------------------| +| 2023-01-12 14:09:25 | CYBN | 1833141 | 6-K | 6-K - CYBIN INC. (0001833141) (Filer) | https://www.sec.gov/Archives/edgar/data/1833141/000162828023000949/0001628280-23-000949-index.htm | +| 2023-01-12 13:39:25 | RYAOF | 1038683 | 6-K | 6-K - RYANAIR HOLDINGS PLC (0001038683) (Filer) | https://www.sec.gov/Archives/edgar/data/1038683/000165495423000350/0001654954-23-000350-index.htm | +| 2023-01-12 13:39:25 | RYAAY | 1038683 | 6-K | 6-K - RYANAIR HOLDINGS PLC (0001038683) (Filer) | https://www.sec.gov/Archives/edgar/data/1038683/000165495423000350/0001654954-23-000350-index.htm | + + +```` + +### pipo + +Gives information on companies that recently had an IPO (Initial Public Offering) + +```python +openbb.stocks.disc.pipo() +``` + +| | Past | Exchange | Name | Number of Shares | Price | Status | symbol | Total Shares Value | +|---:|:-----------|:---------------|:-------------------------------|:-------------------|:----------|:----------|:---------|:---------------------| +| 0 | 2022-11-22 | NASDAQ Capital | Adamas One Corp. | 7165904.0 | 4.50-5.00 | expected | JEWL | 38192020.0 | +| 1 | 2022-11-21 | | Solta Medical Corp | | | withdrawn | | | +| 2 | 2022-11-18 | | MGO Global Inc. | | | filed | MGOL | 8625000.0 | +| 3 | 2022-11-18 | | CytoMed Therapeutics Pte. Ltd. | | | filed | GDTC | 15000000.0 | +| 4 | 2022-11-18 | | BKV Corp | | | filed | BKV | 100000000.0 | +| 5 | 2022-11-18 | | Coya Therapeutics, Inc. | | | filed | COYA | 17250000.0 | + +### gainers + +Shows stocks with the biggest percent change in daily growth + +```python +openbb.stocks.disc.gainers() +``` + +| | Symbol | Name | Price (Intraday) | Change | % Change | Volume | Avg Vol (3 month) | Market Cap | PE Ratio (TTM) | +|---:|:---------|:------------------------------------------------|-------------------:|---------:|:-----------|:---------|:--------------------|:-------------|:-----------------| +| 0 | MPCFF | Metro Pacific Investments Corporation | 0.1021 | 0.0273 | +36.50% | 20000 | 24674 | 2.963B | 10.21 | +| 1 | JBARF | Julius Bär Gruppe AG | 56.66 | 11.5 | +25.47% | 47922 | 276 | 14.48B | 12.26 | +| 2 | BURL | Burlington Stores, Inc. | 189.96 | 32.32 | +20.50% | 5.369M | 1.431M | 12.451B | 75.38 | +| 3 | PSNY | Polestar Automotive Holding UK PLC | 7.82 | 1.33 | +20.49% | 8.878M | 2.611M | 16.495B | 4.25 | +| 4 | AEO | American Eagle Outfitters, Inc. | 15.36 | 2.36 | +18.15% | 18.426M | 6.448M | 2.877B | 16.52 | +| 5 | MMS | Maximus, Inc. | 70.34 | 9.8 | +16.19% | 1.016M | 380221 | 4.259B | 23.45 | +| 6 | MRTX | Mirati Therapeutics, Inc. | 86.11 | 11.57 | +15.52% | 5.41M | 857355 | 4.959B | | +| 7 | WMG | Warner Music Group Corp. | 31.09 | 4.11 | +15.23% | 3.496M | 1.209M | 16.007B | 37.91 | +| 8 | TIAOF | Telecom Italia S.p.A. | 0.2477 | 0.0317 | +14.68% | 20000 | 37835 | 5.578B | | +| 9 | MANU | Manchester United plc | 14.94 | 1.91 | +14.66% | 5.253M | 500920 | 2.436B | | +| 10 | BBY | Best Buy Co., Inc. | 79.88 | 9.05 | +12.78% | 17.487M | 3.047M | 17.983B | 10.69 | +| 11 | SGIOY | Shionogi & Co., Ltd. | 13.8 | 1.55 | +12.65% | 217546 | 253257 | 16.545B | 20.0 | +| 12 | DKS | DICK'S Sporting Goods, Inc. | 117.76 | 10.82 | +10.12% | 6.403M | 1.735M | 9.326B | 10.14 | +| 13 | BCDRF | Banco Santander, S.A. | 2.85 | 0.25 | +9.62% | 1.001M | 230746 | 49.706B | 5.09 | +| 14 | EE | Excelerate Energy, Inc. | 30 | 2.63 | +9.61% | 842088 | 466600 | 3.248B | 16.39 | +| 15 | URBN | Urban Outfitters, Inc. | 27.8 | 2.27 | +8.89% | 7.168M | 2.121M | 2.562B | 11.26 | +| 16 | WHITF | Whitehaven Coal Limited | 6.2 | 0.5 | +8.77% | 39639 | 62464 | 5.762B | 4.37 | +| 17 | LINRF | Liontown Resources Limited | 1.5 | 0.12 | +8.70% | 36150 | 4637 | 3.295B | 150.0 | +| 18 | MBLY | Mobileye Global Inc. | 29.55 | 2.33 | +8.56% | 1.327M | 1.848M | 23.837B | | +| 19 | A | Agilent Technologies, Inc. | 156.86 | 11.72 | +8.07% | 3.468M | 1.406M | 46.437B | 35.81 | +| 20 | FUTU | Futu Holdings Limited | 54.39 | 3.99 | +7.92% | 4.094M | 2.489M | 7.995B | 27.61 | +| 21 | SYM | Symbotic Inc. | 10.77 | 0.79 | +7.92% | 442139 | 215487 | 5.983B | | +| 22 | KAEPF | The Kansai Electric Power Company, Incorporated | 8.36 | 0.6 | +7.73% | 21794 | 5106 | 7.93B | 17.79 | +| 23 | HL | Hecla Mining Company | 5.17 | 0.37 | +7.71% | 11.242M | 8.056M | 3.134B | 172.33 | +| 24 | RKLIF | Rentokil Initial plc | 6.52 | 0.47 | +7.68% | 29704 | 3911 | 16.434B | 36.23 | + +​ + +### rtat + +Shows information on how retail investors are trading a particular ticker + +```python +openbb.stocks.disc.rtat() +``` + +| | Date | Ticker | Activity | Sentiment | +|-----:|:-----------|:---------|-----------:|------------:| +| 0 | 2022-11-22 | TSLA | 0.0681 | 1 | +| 1 | 2022-11-22 | TQQQ | 0.0159 | -2 | +| 2 | 2022-11-22 | SQQQ | 0.0219 | 0 | +| 3 | 2022-11-22 | SPY | 0.0387 | 1 | +| 4 | 2022-11-22 | QQQ | 0.019 | -1 | +| 5 | 2022-11-22 | NVDA | 0.0427 | -3 | +| 6 | 2022-11-22 | META | 0.0137 | -1 | +| 7 | 2022-11-22 | AMZN | 0.0333 | -1 | +| 8 | 2022-11-22 | AMD | 0.0317 | -3 | +| 9 | 2022-11-22 | AAPL | 0.0307 | -5 | +| 10 | 2022-11-21 | TSLA | 0.0763 | 0 | +| 11 | 2022-11-21 | TQQQ | 0.0169 | 1 | +| 12 | 2022-11-21 | SQQQ | 0.0249 | -3 | +| 13 | 2022-11-21 | SPY | 0.0354 | 2 | +| 14 | 2022-11-21 | QQQ | 0.0203 | 2 | +| 15 | 2022-11-21 | NVDA | 0.0312 | -3 | +| 16 | 2022-11-21 | DIS | 0.0367 | 1 | +| 17 | 2022-11-21 | AMZN | 0.035 | 0 | +| 18 | 2022-11-21 | AMD | 0.0275 | -1 | +| 19 | 2022-11-21 | AAPL | 0.0322 | -3 | +| 20 | 2022-11-18 | TSLA | 0.0621 | -1 | +| 21 | 2022-11-18 | TQQQ | 0.0246 | -1 | +| 22 | 2022-11-18 | SQQQ | 0.0274 | -1 | +| 23 | 2022-11-18 | SPY | 0.0456 | 1 | +| 24 | 2022-11-18 | QQQ | 0.0235 | -3 | +| 25 | 2022-11-18 | NVDA | 0.0376 | -5 | +| 26 | 2022-11-18 | META | 0.0141 | 3 | +| 27 | 2022-11-18 | AMZN | 0.0338 | 0 | +| 28 | 2022-11-18 | AMD | 0.0379 | 0 | +| 29 | 2022-11-18 | AAPL | 0.0403 | -3 | +| 30 | 2022-11-17 | TSLA | 0.0563 | -1 | diff --git a/website/content/sdk/data-available/stocks/fundamental-analysis.md b/website/content/sdk/data-available/stocks/fundamental-analysis.md new file mode 100644 index 000000000000..08a69b1471c4 --- /dev/null +++ b/website/content/sdk/data-available/stocks/fundamental-analysis.md @@ -0,0 +1,396 @@ +--- +title: Fundamental Analysis +description: Documentation for the FA module in the OpenBB Terminal - providing programmatic + access to financial analysis commands. Includes a comprehensive list of functionalities, + such as analysis of SEC disclosure statements, company balance sheet information, + earnings data, key metrics over time, estimate market cap and more. Detailed information + for each function and plenty of examples demonstrating their usage. +keywords: +- FA module +- API keys +- AlphaVantage +- EODHD +- Financial Modeling Prep +- Polygon +- SEC disclosure statements +- balance sheet +- earnings data +- company metrics +- market cap +- Jupyter Lab +- VS Code +- financial statement ratios +- EPS estimates +- cash flow +- income statements +- key statistics +- stock suppliers +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + + +The FA module provides programmatic access to the commands from within the OpenBB Terminal. To get the most out of these functions, we recommend obtaining API keys from: + +- AlphaVantage +- EODHD (premium subscribers only) +- Financial Modeling Prep +- Polygon + +View [this page](/sdk/usage/api-keys) for a list of all API sources used across the platform. + +## The FA Module + +A brief description below highlights the properties of the `fa` module. + +| Path | Description | +| :---------------------------- | -----------------------------------------------: | +| openbb.stocks.fa.analysis | Analysis of SEC disclosure statements | +| openbb.stocks.fa.balance | Company balance sheet | +| openbb.stocks.fa.cal | Calendar earnings and estimates | +| openbb.stocks.fa.cash | Company cash flows statements | +| openbb.stocks.fa.customer | Lists other public companies who are customers | +| openbb.stocks.fa.dcfc | Historical DCF Values for a ticker | +| openbb.stocks.fa.divs | Historical Dividends for a company | +| openbb.stocks.fa.divs_chart | A chart for `divs` | +| openbb.stocks.fa.dupont | DuPont ratios | +| openbb.stocks.fa.earnings | Earnings data and EPS | +| openbb.stocks.fa.enterprise | Company enterprise value | +| openbb.stocks.fa.epsfc | Forward EPS estimates | +| openbb.stocks.fa.fama_coe | Fama/French value for cost of equity | +| openbb.stocks.fa.fraud | Key fraud ratios | +| openbb.stocks.fa.growth | Growth of financial statement ratios | +| openbb.stocks.fa.income | Company income statements | +| openbb.stocks.fa.key | Company Key Metrics | +| openbb.stocks.fa.metrics | Key Metrics Over Time | +| openbb.stocks.fa.mgmt | Company Management Team | +| openbb.stocks.fa.mktcap | Estimated Market Cap | +| openbb.stocks.fa.mktcap_chart | Chart for `mktcap` | +| openbb.stocks.fa.overview | Overview of the company | +| openbb.stocks.fa.pt | Analyst price targets | +| openbb.stocks.fa.pt_chart | Chart for `pt` | +| openbb.stocks.fa.rating | Historical buy/sell/hold ratings based on ratios | +| openbb.stocks.fa.ratios | Historical financial statements ratios | +| openbb.stocks.fa.revfc | Forward revenue estimates | +| openbb.stocks.fa.score | Investing Score from Warren Buffet | +| openbb.stocks.fa.shrs | Major shareholders | +| openbb.stocks.fa.splits | Stock Splits and Reverse Splits Since IPO | +| openbb.stocks.fa.splits_chart | Chart for `splits` | +| openbb.stocks.fa.supplier | Lists other public companies who are suppliers | + +This can be printed to the screen with: + +```python +help(openbb.stocks.fa) +``` + +Parameters for each function are displayed using the same syntax. + +```python +help(openbb.stocks.fa.balance) + +Signature: +openbb.stocks.fa.balance( + symbol: str, + quarterly: bool = False, + ratios: bool = False, + source: str = 'YahooFinance', + limit: int = 10, +) -> pandas.core.frame.DataFrame +Call signature: openbb.stocks.fa.balance(*args: Any, **kwargs: Any) -> Any +Type: get_balance_sheet +String form: +File: ~/GitHub/OpenBBTerminal/openbb_terminal/stocks/fundamental_analysis/sdk_helpers.py +Docstring: +Get balance sheet. + +Parameters +---------- +symbol : str + Symbol to get balance sheet for +source : str, optional + Data source for balance sheet, by default "YahooFinance" + Sources: YahooFinance, AlphaVantage, FinancialModelingPrep, Polygon, EODHD +quarterly : bool, optional + Flag to get quarterly data +ratios : bool, optional + Flag to return data as a percent change. +limit : int + Number of statements to return (free tiers may be limited to 5 years) + +Returns +------- +pd.DataFrame + Dataframe of balance sheet + +Examples +-------- +>>> from openbb_terminal.sdk import openbb +>>> balance_sheet = openbb.stocks.fa.balance("AAPL", source="YahooFinance") + +If you have a premium AlphaVantage key, you can use the quarterly flag to get quarterly statements +>>> quarterly_income_statement = openbb.stocks.fa.balance("AAPL", source="AlphaVantage", quarterly=True) +``` + +This information is also displayed in the contextual help window, when using Jupyter Lab or VS Code. + +## Examples + +The examples provided below will assume that the following import block is included at the beginning of the Python script or Notebook file: + +```python +import pandas as pd +from openbb_terminal.sdk import openbb +``` + +### Earnings + +The `openbb.stocks.fa.earnings` function returns upcoming earnings dates and estimates for EPS. There are two data sources available - YahooFinance or AlphaVantage, both of which provide historical context. + +```python +openbb.stocks.fa.earnings('COST', quarterly = True) +``` + +| Earnings Date | EPS Estimate | Reported EPS | Surprise(%) | +| :------------ | :----------- | :----------- | :---------- | +| 2024-02-29 | - | - | - | +| 2023-12-06 | - | - | - | +| 2023-09-20 | - | - | - | +| 2023-05-25 | 3.21 | - | - | +| 2023-05-25 | - | - | - | +| 2023-03-02 | 3.21 | 3.3 | 0.0288 | +| 2022-12-08 | 3.11 | 3.1 | -0.00451 | +| 2022-09-22 | 4.17 | 4.2 | 0.0084 | +| 2022-05-26 | 3.03 | 3.17 | 0.0449 | +| 2022-03-03 | 2.74 | 2.92 | 0.0647 | +| 2021-12-09 | 2.64 | 2.98 | 0.12890 | + +### Growth + +`openbb.stocks.fa.growth` provides annualized financial ratios as growth metrics. + +```python +openbb.stocks.fa.growth('COST') +``` + +**Note**: This returns thirty-five ratios, the table below is truncated for illustrative purposes. + +| | 2018 | 2019 | 2020 | 2021 | 2022 | +| :---------------------- | :---- | :----- | :---- | :---- | :---- | +| Period | FY | FY | FY | FY | FY | +| Revenue growth | 0.097 | 0.079 | 0.092 | 0.175 | 0.158 | +| Gross profit growth | 0.075 | 0.076 | 0.101 | 0.157 | 0.092 | +| Ebitgrowth | 0.090 | -0.236 | 0.134 | 0.306 | 0.203 | +| Operating income growth | 0.090 | -0.236 | 0.134 | 0.306 | 0.203 | + +### Analysis + +The `openbb.stocks.fa.analysis` function scans 10K SEC filings with NLP to highlight risk factors and statements provided in the Discussion and Analysis sections. Summarizations by, [elclect.us](https://eclect.us/) + +```python +openbb.stocks.fa.analysis('COST').head(1) +``` + +| Group | Good | Sentence | +| :----------- | :---- | :-------------------------------------------------------------------------------------------------------------------------------------- | +| Risk factors | False | During 2022, our international operations, including Canada, generated 27% and 32% of our net sales and operating income, respectively. | + +```python +df = openbb.stocks.fa.analysis('COST') +hp = df["Group"].str.contains('Discussion') +df[hp].head(1) +``` + +| Group | Good | Sentence | +| :---------------------- | :--- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| Discussion and Analysis | True | Cash Flows from Operating ActivitiesNet cash provided by operating activities totaled $5,802 in the first half of 2023, compared to $3,659 in the first half of 2022. | + +### Key + +Use `openbb.stocks.fa.key` for a small table of key statistics. + +```python +openbb.stocks.fa.key('COST') +``` + +| | | +| :----------------------- | :-------- | +| Market capitalization | 219.440 B | +| EBITDA | 9.891 B | +| EPS | 13.62 | +| PE ratio | 36.33 | +| PEG ratio | 3.433 | +| Price to book ratio | 10.39 | +| Return on equity TTM | 0.284 | +| Price to sales ratio TTM | 0.891 | +| Dividend yield | 0.0083 | +| 50 day moving average | 491.41 | +| Analyst target price | 547.64 | +| Beta | 0.787 | + +### SHRS + +The top 10 mutual funds holding the stock are retrieved with: + +```python +openbb.stocks.fa.shrs(symbol = 'COST', holder = 'mutualfund') +``` + +| Holder | Shares | Date Reported | Stake | Value | +| :--------------------------------------------------------- | :------- | :------------------ | :----- | :------ | +| Vanguard Total Stock Market Index Fund | 13.453 M | 2022-12-30 00:00:00 | 3.03 % | 6.591 B | +| Vanguard 500 Index Fund | 10.232 M | 2022-12-30 00:00:00 | 2.31 % | 5.012 B | +| Invesco ETF Tr-Invesco QQQ Tr, Series 1 ETF | 5.834 M | 2023-03-30 00:00:00 | 1.32 % | 2.858 B | +| Fidelity 500 Index Fund | 4.852 M | 2023-02-27 00:00:00 | 1.09 % | 2.377 B | +| SPDR S&P 500 ETF Trust | 4.804 M | 2023-03-30 00:00:00 | 1.08 % | 2.353 B | +| iShares Core S&P 500 ETF | 3.950 M | 2023-02-27 00:00:00 | 0.89 % | 1.935 B | +| Vanguard Growth Index Fund | 3.736 M | 2022-12-30 00:00:00 | 0.84 % | 1.830 B | +| Select Sector SPDR Fund-Consumer Staples | 3.241 M | 2023-02-27 00:00:00 | 0.73 % | 1.588 B | +| Vanguard Institutional Index Fund-Institutional Index Fund | 3.102 M | 2022-12-30 00:00:00 | 0.70 % | 1.519 B | +| Vanguard Specialized-Dividend Appreciation Index Fund | 2.804 M | 2023-01-30 00:00:00 | 0.63 % | 1.374 B | + +### Balance + +Financial statement items can be displayed as their reported value or as a percent change. + +```python +openbb.stocks.fa.balance(symbol = 'COST', ratios=True) +``` + +| Breakdown | 2022-08-31 | 2021-08-31 | 2020-08-31 | +| :----------------------------------------- | ---------: | ---------: | ---------: | +| Cash and cash equivalents | -0.0937111 | -0.0830007 | 0.464337 | +| Other short-term investments | -0.0774264 | -0.107977 | -0.0301887 | +| Total cash | -0.0924846 | -0.0849305 | 0.408831 | +| Net receivables | 0.242928 | 0.163226 | 0.00977199 | +| Inventory | 0.259726 | 0.161166 | 0.0743308 | +| Other current assets | 0.14253 | 0.282502 | -0.0792079 | +| Total current assets | 0.108151 | 0.0492532 | 0.19736 | +| Gross property, plant and equipment | 0.0532209 | 0.0815396 | 0.149114 | +| Accumulated depreciation | 0.0790625 | 0.0984801 | 0.0988412 | +| Net property, plant and equipment | 0.039345 | 0.072657 | 0.177358 | +| Other long-term assets | 0.19787 | 0.190074 | 1.77171 | +| Total non-current assets | 0.0573531 | 0.0848156 | 0.251928 | +| Total assets | 0.0826416 | 0.0668155 | 0.2237 | +| Current debt | -0.908636 | 7.41053 | -0.944085 | +| Accounts payable | 0.0964492 | 0.148603 | 0.21346 | +| Accrued liabilities | 0.0921715 | 0.152661 | 0.147383 | +| Other current liabilities | 0.230213 | 0.223444 | -0.0168776 | +| Total current liabilities | 0.0868517 | 0.185035 | 0.0691569 | +| Long-term debt | -0.0310819 | -0.109396 | 0.466432 | +| Other long-term liabilities | 0.057971 | 0.248062 | 0.329897 | +| Total non-current liabilities | -0.0194059 | -0.0214875 | 0.825049 | +| Total liabilities | 0.0565429 | 0.117744 | 0.235947 | +| Common stock | -0.5 | 0 | 0 | +| Retained earnings | 0.335933 | -0.0941843 | 0.255508 | +| Accumulated other comprehensive income | 0.608619 | -0.123362 | -0.0967967 | +| Total stockholders' equity | 0.175245 | -0.0393787 | 0.199501 | +| Total liabilities and stockholders' equity | 0.0826416 | 0.0668155 | 0.2237 | + +Cashflow and Income statements are requested in the same way. + +### Cash + +Get the company's cash statements. + +```python +openbb.stocks.fa.cash(symbol = 'COST').tail(4) +``` + +| Breakdown | ttm | 2022-08-31 | 2021-08-31 | 2020-08-31 | 2019-08-31 | +| :-------------------- | ---------: | ---------: | ---------: | ---------: | ---------: | +| Cash at end of period | 13136000.0 | 10203000.0 | 11258000.0 | 12277000.0 | 8384000.0 | +| Operating cash flow | 9535000.0 | 7392000.0 | 8958000.0 | 8861000.0 | 6356000.0 | +| Capital expenditure | -4060000.0 | -3891000.0 | -3588000.0 | -2810000.0 | -2998000.0 | +| Free cash flow | 5475000.0 | 3501000.0 | 5370000.0 | 6051000.0 | 3358000.0 | + +### Income + +Get the company's income statements. + +```python +openbb.stocks.fa.income('COST').tail(4) +``` + +| Breakdown | 2022-08-31 | 2021-08-31 | 2020-08-31 | 2019-08-31 | +| :--------------------- | :--------: | :--------: | :--------: | ---------: | +| Diluted EPS | 13.14 | 11.27 | 9.02 | 8.26 | +| Basic average shares | 443651.00 | 443089.00 | 442297.00 | 439755.00 | +| Diluted average shares | 444757.00 | 444346.00 | 443901.00 | 442923.00 | +| EBITDA | 7998000.00 | 6851000.00 | 5527000.00 | 4915000.00 | + +### Supplier + +`openbb.stocks.fa.supplier` will return a list of suppliers for the compnay, that are also listed US stocks. + +```python +openbb.stocks.fa.supplier('COST').head(5) +``` + +| TICKER | Company Name | Revenue | Net Income | Net Margin | Cash Flow | +| :----- | :---------------------- | ------: | ---------: | :--------- | --------: | +| BRKA | Berkshire Hathaway Inc | 78165 | 18321 | 23.44 % | -52307 | +| ULVR | Unilever Plc | 58737.3 | 7415.52 | 12.62 % | 0 | +| COST | Costco Wholesale Corp | 54437 | 1364 | 2.51 % | 653 | +| BUD | Anheuser busch Inbev Sa | 54304 | 6114 | 11.26 % | 0 | +| DEO | Diageo Plc | 22448 | 3338 | 14.87 % | 2749 | + +### EPSFC + +Returns a DataFrame of forward EPS estimates consensus. + +```python +openbb.stocks.fa.epsfc('COST') +``` + +| fiscalyear | consensus_mean | change % | analysts | actual | consensus_low | consensus_high | +|-------------:|-----------------:|-----------:|-----------:|---------:|----------------:|-----------------:| +| 2022 | 13.151 | 18.6918 | 20 | 13.27 | 12.43 | 13.43 | +| 2023 | 14.5 | 9.2679 | 13 | 0 | 14.22 | 15.18 | +| 2024 | 15.801 | 8.97478 | 20 | 0 | 14.75 | 17.09 | +| 2025 | 17.337 | 9.71807 | 10 | 0 | 16.47 | 18.92 | +| 2026 | 19.332 | 11.5088 | 5 | 0 | 17.55 | 21.84 | +| 2027 | 21.408 | 10.7387 | 5 | 0 | 18.6 | 25.72 | +| 2028 | 23.625 | 10.3559 | 2 | 0 | 22.19 | 25.06 | +| 2029 | 27.2 | 15.1323 | 1 | 0 | 27.2 | 27.2 | +| 2030 | 29.6 | 8.82353 | 1 | 0 | 29.6 | 29.6 | +| 2031 | 32.05 | 8.27703 | 1 | 0 | 32.05 | 32.05 | +| 2032 | 34.87 | 8.79875 | 1 | 0 | 34.87 | 34.87 | + +### SEC + +`openbb.stocks.fa.sec` SEC forms filed by year and type. + +```python +openbb.stocks.fa.sec('COST').head(4) +``` + +|Filed |Company Name |Reporting Owner |Form Type |Period |View | +|:-----------|:--------------------------|:------------|:------------|:-----------|:-----------| +|04/19/2023 |Costco Wholesale Corporation | |8-K |04/19/2023 |https://app.quotemedia.com/data/downloadFiling...| +|04/13/2023 |Costco Wholesale Corporation | |4 |04/11/2023 |https://app.quotemedia.com/data/downloadFiling...| +|03/15/2023 |Costco Wholesale Corporation |JELINEK W CRAIG |4 |03/13/2022 |https://app.quotemedia.com/data/downloadFiling...| +|03/15/2023 |Costco Wholesale Corporation |GALANTI RICHARD A |4 |03/14/2023 |https://app.quotemedia.com/data/downloadFiling...| + +### PT + +`openbb.stocks.fa.pt` returns historical ratings and price targets, by firm. + +```python +openbb.stocks.fa.pt('COST').tail(10) +``` + +| Date | Company | Rating | Price Target | +|:------------|:-----------------------|:---------|---------------:| +| 2023-02-08 | Barclays Capital | HOLD | 510 | +| 2023-02-27 | Telsey Advisory Group | BUY | 580 | +| 2023-03-03 | Baird Patrick & Co | BUY | 535 | +| 2023-03-03 | Telsey Advisory Group | BUY | 540 | +| 2023-03-03 | Morgan Stanley | BUY | 520 | +| 2023-03-07 | Northcoast | BUY | 560 | +| 2023-03-28 | Telsey Advisory Group | BUY | 540 | +| 2023-04-06 | Telsey Advisory Group | BUY | 540 | +| 2023-04-06 | Oppenheimer & Co. Inc. | BUY | 550 | +| 2023-05-01 | Telsey Advisory Group | BUY | 540 | diff --git a/website/content/sdk/data-available/stocks/government.md b/website/content/sdk/data-available/stocks/government.md new file mode 100644 index 000000000000..ce516fb198c7 --- /dev/null +++ b/website/content/sdk/data-available/stocks/government.md @@ -0,0 +1,153 @@ +--- +title: Government +description: "The page provides comprehensive information about the Government module\u2014\ + that offers programmatic access to OpenBB Terminal functions. It includes details\ + \ about commands available, how to use them with Python, and examples. It serves\ + \ as a vital resource for those interested in examining US government data related\ + \ to publicly traded companies." +keywords: +- Government module +- programmatic access +- fundamental and macroeconomic research +- US data +- commands +- ticker-specific +- non-specific +- openbb.stocks.gov +- Contracts Awarded to a Company +- Reported Trades in a Company's Stock +- US Congress and Senate +- Quarterly Total Amount Paid to a Company by the Government +- Latest Invoices Paid by the US Treasury Department +- Recorded Lobbying Efforts by a Company +- Ranking Companies by Total Amount Rewarded +- Top Buyers in Office +- Corporate Lobbyist Activity +- Top Sellers in Office +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +The Government module provides programmatic access to the same functions from the [OpenBB Terminal](/terminal/data-available/stocks/gov). They provide an excellent supplement to fundamental and macroeconomic research. Please note that this module will only return data from the USA. + +## How to Use + +Below is a list of all the commands and a brief description. There are two types of function: ticker-specific, and non-specific. Many of these tables also have a companion `_chart` function. + +|Path |Type| Description | +|:----------------|:------:|----------------------------:| +|openbb.stocks.gov.contracts|Ticker |Contracts Awarded to a Company | +|openbb.stocks.gov.gtrades |Ticker |Reported Trades in a Company's Stock by Members of the US Congress and Senate | +|openbb.stocks.gov.histcont|Ticker |The Quarterly Total Amount Paid to a Company by the Government | +|openbb.stocks.gov.lastcontracts |All |The Latest Invoices Paid by the US Treasury Department | +|openbb.stocks.gov.lasttrades| All|The Latest Reported Trades Made by Members of the US Congress and Senate | +|openbb.stocks.gov.lobbying|Ticker | Recorded Lobbying Efforts by a Company | +|openbb.stocks.gov.qtrcontracts|All |Ranking Companies by Total Amount Rewarded | +|openbb.stocks.gov.topbuys|All |The Top Buyers in Office | +|openbb.stocks.gov.toplobbying|All |Corporate Lobbyist Activity and the Specific Issues | +|openbb.stocks.gov.topsells|All |The Top Sellers in Office | + +Alternatively, Python's built-in help will display the contents of the module, or specific function. + +```python +help(openbb.stocks.gov) +``` + +## Examples + +### Import Statements + +The examples below will assume that this block is included at the top of the file: + +```python +from openbb_terminal.sdk import openbb +``` + +### Toplobbying + +This command shows who is spending money in Washington and what their intentions are. + +```python +openbb.stocks.gov.toplobbying() +``` + +| | Date | Ticker | Client | Amount | Issue | Specific_Issue | +|---:|:-----------|:---------|:--------------------------------|---------:|:-------------------------------------|:--------------------| +| 495 | 2022-10-20 | DKNG | DRAFTKINGS INC. | 20000 | Taxation/Internal Revenue Code | Tax characterization of daily fantasy sports. | +| 496 | 2022-10-20 | ELVT | ELEVATE CREDIT SERVICE, LLC | 90000 | Banking | Monitored issues concerning online lending proposals. | +| 497 | 2022-10-20 | HGV | HILTON GRAND VACATIONS | 20000 | Financial Institutions/Investments/Securities | GENERAL DISCUSSIONS RELATED TO DEBT SERVICING | +| 498 | 2022-10-20 | SO | SOUTHERN CALIFORNIA TRIBAL CHAIRMEN'S ASSOCIATION | 40000 | Indian/Native American Affairs | Fee to trust issues. Issues surrounding federal programs for Indian tribes. | +| 499 | 2022-10-20 | ONCS | ONCOSEC MEDICAL INCORPORATED | 0 | | | + +### Contracts + +Get a list of contracts awarded to a company and the agency authorizing it. + +```python +openbb.stocks.gov.contracts('AMT') +``` + +| | Date | Description | Agency | Amount | +|---:|:-----------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:--------------------------------------|---------:| +| 0 | 2022-10-16 | RENTAL TOWER SITE | DEPARTMENT OF JUSTICE (DOJ) | 0 | +| 1 | 2022-10-01 | ANTENNA LEASE SITE 43 AMERICAN TOWER | DEPARTMENT OF HOMELAND SECURITY (DHS) | 13699.9 | +| 2 | 2022-10-01 | IGF::OT::IGF | DEPARTMENT OF JUSTICE (DOJ) | 5100 | +| 3 | 2022-10-01 | LEASE OF RADIO REPEATER SITE | DEPARTMENT OF THE TREASURY (TREAS) | 9787.84 | +| 4 | 2022-10-01 | IGF::OT::IGF::-RECUR SERVICE FOR ANTENNA SITE J ACCOUNT LEASE AT: MARIETTA, GA (BLACKWELL SITE) | DEPARTMENT OF JUSTICE (DOJ) | 0 | +| 5 | 2022-10-01 | FUNDING FOR FY 2018 THROUGH FY 2019 ANTENNA SITE AGREEMENTS | DEPARTMENT OF STATE (DOS) | 30000 | + +### Histcont + +Get the historic (from 2008) quarterly sum paid to a company by the US Treasury department. + +```python +openbb.stocks.gov.histcont('AMT') +``` + +| | Qtr | Year | Amount | +|---:|------:|-------:|---------:| +| 0 | 4 | 2021 | 127282 | +| 1 | 3 | 2021 | 564310 | +| 2 | 2 | 2021 | 564645 | +| 52 | 4 | 2008 | 110021 | +| 53 | 3 | 2008 | 240877 | +| 54 | 2 | 2008 | 907099 | +| 55 | 1 | 2008 | 320620 | + +### Lobbying + +Find the records of a company's lobbying efforts. + +```python +openbb.stocks.gov.lobbying('AMT') +``` + +| | Date | Ticker | Client | Amount | Issue | Specific_Issue | +|---:|:-----------|:---------|:---------------------------|---------:|:---------------------------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 0 | 2022-12-01 | AMT | AMERICAN TOWER CORPORATION | 440000 | Trade (domestic/foreign) | Issues pertaining to global trade, global development, AID and the World Bank including trade policy with India - no specific legislation. | +| | | | | | Communications/Broadcasting/Radio/TV | Telecommunication infrastructure issues including those related to the Federal Communications Commission - no specific legislation. Issues related to NTIA - including implementation of broadband funding programs in the Infrastructure Investment and Jobs Act, HR 3684. Issues related to 5G and wireless communications deployment - no specific legislation. Issues related to the definition of eligible project costs - no specific legislation. Issues pertaining to broadband deployment, including relevant provisions in the Infrastructure Investment and Jobs Act, HR 3684 and related legislation. | +| | | | | | Telecommunications | Issues pertaining to telecommunications tower real estate - no specific legislation. Issues related to global telecommunications policy - no specific legislation. | +| | | | | | Taxation/Internal Revenue Code | Issues related to international and domestic tax provisions as applied to real estate investment trusts and Public Law 115-97 (Tax Cuts and Jobs Act), including H.R. 5376, the Inflation Reduction Act of 2022. | + +### Lastcontracts + +Find out who is selling ink, toner cartridges, or other seemingly mundane items, to the Federal government. + +```python +openbb.stocks.gov.lastcontracts() +``` + +| | Date | Ticker | Amount | Description | Agency | +|---:|:--------------------|:---------|---------:|:--------------------------------------------------|:--------------------------------------| +| 0 | 2022-12-02 00:00:00 | DNOW | 81.3 | CASE, FILING, TRANSFER: ITEM NAME CASE, FILING, | GENERAL SERVICES ADMINISTRATION (GSA) | +| | | | | TRANSFER INSIDE WIDTH 8.250 INCHES INSIDE LENGTH | | +| | | | | 5.500 INCHES INSIDE DEPTH 10.75 INCHES CARD WIDTH | | +| | | | | 8.000 INCHES CARD LENGTH 5.000 INCHES CARD | | +| | | | | CAPACITY 1,200 UNIT TYPE BOX UNIT DESIGN NON- | | +| | | | | COLLAPSIBL | | +| 1 | 2022-12-02 00:00:00 | DNOW | 855.6 | CARTRIDGE,TONER | GENERAL SERVICES ADMINISTRATION (GSA) | +| 2 | 2022-12-02 00:00:00 | DNOW | 169.84 | TONER,HP 508X HY, LJ,YL | GENERAL SERVICES ADMINISTRATION (GSA) | +| 3 | 2022-12-02 00:00:00 | DNOW | 519.5 | CARTRIDGE,INK | GENERAL SERVICES ADMINISTRATION (GSA) | +| 4 | 2022-12-02 00:00:00 | DNOW | 1778.1 | OEM HP HY TONER, YELLOW, YLD 23K | GENERAL SERVICES ADMINISTRATION (GSA) | diff --git a/website/content/sdk/data-available/stocks/insiders.md b/website/content/sdk/data-available/stocks/insiders.md new file mode 100644 index 000000000000..91504b76faae --- /dev/null +++ b/website/content/sdk/data-available/stocks/insiders.md @@ -0,0 +1,285 @@ +--- +title: Insiders +description: This page of our marketing website gives a detailed overview of how to + use the 'Insiders' module of the OpenBB Terminal. It teaches users how to access + and utilize various functions of the module to gather information about insider + trading activity, latest CEO/CFO purchases and sales, insider transactions based + on predetermined filters and much more. The guide also provides information on how + to pull up ticker-specific details and covers how to use different commands. +keywords: +- Insiders module +- Insider trading activity +- CEOs purchases and sales +- Insider transactions filter +- Ticker-specific details +- Python commands +- Stock data +- Insider data +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + + +## Overview + +The Insiders module provides endpoints to the [Insiders Trading menu in the OpenBB Terminal](/terminal/data-available/stocks/ins). The contents of the module are displayed on screen with: + +```python +openbb.stocks.ins? +``` + +or: + +```python +help(openbb.stocks.ins) +``` + +```python +Type: property +String form: +Docstring: +Stocks Insiders Submodule + +Attributes: + + `act`: Get insider activity. [Source: Business Insider] + + `act_chart`: Display insider activity. [Source: Business Insider] + + `blcp`: Get latest CEO/CFO purchases > 25k + + `blcs`: Get latest CEO/CFO sales > 100k + + `blip`: Get latest insider purchases > 25k + + `blis`: Get latest insider sales > 100k + + `blop`: Get latest officer purchases > 25k + + `blos`: Get latest officer sales > 100k + + `filter`: Get insider trades based on preset filter + + `lcb`: Get latest cluster buys + + `lins`: Get last insider activity for a given stock ticker. [Source: Finviz] + + `lins_chart`: Display insider activity for a given stock ticker. [Source: Finviz] + + `lip`: Get latest insider purchases + + `lis`: Get latest insider sales + + `lit`: Get latest insider trades + + `lpsb`: Get latest penny stock buys + + `print_insider_data`: Print insider data + + `print_insider_data_chart`: Print insider data + + `stats`: Get OpenInsider stats for ticker +``` + +## How to Use + +Try the next two commands for ticker-specific information. + +### stats + +The last 100 results are returned. + +```python +openbb.stocks.ins.stats('wmt') +``` + +| | X | Filing Date | Trading Date | Ticker | Insider | Title | Trade Type | Price | Quantity | Owned | Delta Own | Value | Filing Link | Ticker Link | Insider Link | +| -: | :- | :------------------ | :----------- | :----- | :-------------- | :------- | :--------- | :----------------------------------------------------------------- | :------------------------------------------------------------------------------------ | :------------------------- | :----------------------------------------------------- | :---- | :---------- | :---------- | :----------- | +| 0 | | 2023-05-01 17:18:33 | 2023-04-27 | WMT | Furner John R. | EVP | S - Sale | $151.00 | -4,375 | 288,434 | -1% | -$660,625 | http://www.sec.gov/Archives/edgar/data/104169/000112760223013917/xslF345X03/form4.xml | http://openinsider.com/WMT | http://openinsider.com/insider/Furner-John-R./1696737 | | | | | +| 1 | M | 2023-03-30 18:36:05 | 2023-03-29 | WMT | Walton S Robson | Dir, 10% | S - Sale | $144.75 | -3,412,370 | 1,249,821,970 | 0% | -$493,930,674 | http://www.sec.gov/Archives/edgar/data/104169/000112760223011663/xslF345X03/form4.xml | http://openinsider.com/WMT | http://openinsider.com/insider/Walton-S-Robson/1219112 | | | | | + +### act + +This command returns the information a bit differently. + +```python +openbb.stocks.ins.act('wmt') +``` + +| Date | Shares Traded | Shares Held | Price | Type | Option | Insider | +| :------------------ | :------------ | :------------- | -----: | :--- | :----- | :-------------- | +| 2023-03-27 00:00:00 | 341,149.00 | 249,123,886.00 | 144.23 | Sell | No | WALTON S ROBSON | +| 2023-03-27 00:00:00 | 341,149.00 | 249,123,886.00 | 144.23 | Sell | No | WALTON ALICE L | +| 2023-03-27 00:00:00 | 1,259,851.00 | 249,465,035.00 | 143.71 | Sell | No | WALTON ALICE L | +| 2023-03-28 00:00:00 | 1,640,457.00 | 247,483,429.00 | 144.06 | Sell | No | WALTON S ROBSON | +| 2023-03-28 00:00:00 | 267,874.00 | 247,215,555.00 | 144.7 | Sell | No | WALTON S ROBSON | +| 2023-03-28 00:00:00 | 1,640,457.00 | 247,483,429.00 | 144.06 | Sell | No | WALTON ALICE L | + +Other functions in this module return all tickers, based on the latest SEC Form-4 filings. + +### lpsb + +Short for, Latest Penny Stock Buys, this command filters for insider purchases of penny stocks. + +```python +openbb.stocks.ins.lpsb().head(3) +``` + +| | X | Filing Date | Trade Date | Ticker | Company Name | Insider Name | Title | Trade Type | Price | Qty | Owned | Diff Own | Value | +| -: | :- | :---------- | :--------- | :----- | :------------------- | :------------------ | :-------- | :----------- | :-------------------------------------------------- | --: | ----: | :------- | :---- | +| 0 | M | 2023-05-17 | 2023-05-15 | ADV | Advantage Solutions | Peacock David A | CEO | P - Purchase | $1.61 | 160000 | 1858112 | +9% | +$257,752 | | | | | +| | | 16:30:22 | | | Inc. | | | | | | | | | +| 1 | - | 2023-05-17 | 2023-05-17 | SOND | Sonder Holdings Inc. | Rothenberg Philip L | GC, | P - Purchase | $0.45 | 300000 | 300000 | New | +$135,000 | | | | | +| | | 16:17:31 | | | | | Secretary | | | | | | | +| 2 | M | 2023-05-17 | 2023-05-15 | SOND | Sonder Holdings Inc. | Davidson Francis | CEO | P - Purchase | $0.41 | 615645 | 4060224 | +18% | +$249,596 | | | | | +| | | 16:15:08 | | | | | | | | | | | | + +### lit + +Stands for, Latest Insider Trades, and returns the last one-hundred insider trades, market-wide. + +```python +openbb.stocks.ins.lit().head(3) +``` + +| | X | Filing Date | Trade Date | Ticker | Company Name | Insider Name | Title | Trade Type | Price | Qty | Owned | Diff Own | Value | +| -: | :- | :---------- | :--------- | :----- | :------------------- | :--------------- | :--------- | :---------- | :----------------------------------------------------- | --: | ----: | :------- | :---- | +| 0 | DM | 2023-05-17 | 2023-05-15 | AMZN | Amazon Com Inc | Selipsky Adam | CEO Amazon | S - Sale+OE | $110.47 | -11260 | 150103 | -7% | -$1,243,914 | | | | | +| | | 16:40:35 | | | | | Web | | | | | | | +| | | | | | | | Services | | | | | | | +| 1 | D | 2023-05-17 | 2023-05-15 | TDUP | Thredup Inc. | Nakache Patricia | Dir, 10% | S - Sale+OE | $3.01 | -28123 | 76976 | -27% | -$84,650 | | | | | +| | | 16:39:59 | | | | | | | | | | | | +| 2 | - | 2023-05-17 | 2023-05-15 | RRC | Range Resources Corp | Scucchi Mark | EVP, CFO | S - Sale | $27.39 | -153000 | 772540 | -17% | -$4,190,670 | | | | | +| | | 16:39:52 | | | | | | | | | | | | + +`lip` & `lis` filter for purchases and sales, respectively. + +### filter + +The `filter` function is a customizable screener that allows scanning in greater detail. User-generated presets are saved in the OpenBBUserData folder, under: `~/OpenBBUserData/presets/stocks/insider`. Presets included with the code are located in the source code, [here](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/miscellaneous/stocks/insider). Use, [template.ini](https://github.com/OpenBB-finance/OpenBBTerminal/blob/main/openbb_terminal/miscellaneous/stocks/insider/template.ini), as a starting point. The following fields are allowed: + +```console +[General] +# Symbols or CIKs +Tickers = +# Insider Name or CIK +Insider = +SharePriceMin = +SharePriceMax = +LiquidityMinM = +LiquidityMaxM = + +[Date] +# All dates, Custom, Latest Day, Last 3 days, Last 1 week, Last 2 weeks, Last 1 month, Last 2 months, Last 3 months, Last 6 months, Last 1 year, Last 2 years, Last 4 years. +FilingDate = All dates +# This is only regarded if FillingDate = Custom, format: dd/mm/yyyy +FilingDateFrom = +FilingDateTo = +# All dates, Custom, Latest Day, Last 3 days, Last 1 week, Last 2 weeks, Last 1 month, Last 2 months, Last 3 months, Last 6 months, Last 1 year, Last 2 years, Last 4 years. +TradingDate = All dates +# This is only regarded if FillingDate = Custom, format: dd/mm/yyyy +TradingDateFrom = +TradingDateTo = +# These values need to be smaller than 100 +FilingDelayMin = +FilingDelayMax = +NDaysAgo = + +[TransactionFiling] +# The following values are meant to be either: 'true' or empty for False. +P_Purchase = true +S_Sale = true +A_Grant = +D_SaleToLoss = +G_Gift = +NoDeriv = +F_Tax = +M_OptionEx = +X_OptionEx = +C_CnvDeriv = +W_Inherited = +MultipleDays = +# These values need to be multiples of 5 +TradedMinK = +TradedMaxK = +# These values need to be between 0 and 100% +OwnChangeMinPct = +OwnChangeMaxPct = + +[Industry] +# Available industry options at bottom of the file. +# Sector -> Subsector -> Industry +SectorSubsectorIndustry = All Sectors (except Funds) + +[InsiderTitle] +# The following values are meant to be either: 'true' or empty for False. +COB = +CEO = +Pres = +COO = +CFO = +GC = +VP = +# 'Officer' includes all of the above: COB, CEO, Pres, COO, CFO, GC, VP +Officer = +Director = +10PctOwn = +Other = + +[Others] +# Filing, Company. +GroupBy = Filing +# Filing Date, Trade Date, Ticker Symbol, Trade Value. +SortBy = Filing Date +# 100, 200, 300, 400, 500, 600, 700, 800, 900, 1000. +MaxResults = 100 +# Between 1 and 99, inclusive. +Page = 1 + +# This only exists if GroupBy = Company +[CompanyTotals] +# These values need to be smaller than 100 +FilingsMin = +FilingsMax = +# These values need to be smaller than 10 +InsidersMin = +InsidersMax = +OfficersMin = +OfficersMax = +# These values need to be multiples of 5 +TradedMinK = +TradedMaxK = +# These values need to be between 0 and 100% +OwnChangeMinPct = +OwnChangeMaxPct = +``` + +The sector industrial classification is also selectable. Most of the included presets are for filtering by industry. For example, `Mortgages`. + +**Do not include `.ini` in the preset name.** + +```python +openbb.stocks.ins.filter("Mortgages") +``` + +| | X | Filing Date | Trading Date | Ticker | Insider | Title | Trade Type | Price | Quantity | Owned | Delta Own | Value | Filing Link | Ticker Link | Insider Link | Company | +| -: | :- | :------------------ | :----------- | :----- | :------------------------------------------------------- | :------- | :----------- | :-------------------------------------------------------------- | :------------------------------------------------------------------------------------- | :-------------------------- | :---------------------------------------------------------------------------------------------- | :-------------------------------- | :---------- | :---------- | :----------- | :------ | +| 0 | | 2023-04-05 18:25:23 | 2023-04-04 | PFSI | Spector David | COB, CEO | S - Sale | $59.71 | -15,000 | 1,070,787 | -1% | -$895,713 | http://www.sec.gov/Archives/edgar/data/1745916/000112760223012621/xslF345X03/form4.xml | http://openinsider.com/PFSI | http://openinsider.com/insider/Spector-David/1275713 | Pennymac Financial Services, Inc. | | | | | +| 1 | D | 2023-04-04 17:32:57 | 2023-03-31 | FOA | Blackstone Tactical Opportunities Associates - Nq L.L.C. | 10% | P - Purchase | $1.38 | +10,869,566 | 24,386,710 | +80% | +$15,000,001 | http://www.sec.gov/Archives/edgar/data/1828937/000089924323010452/xslF345X03/doc4.xml | http://openinsider.com/FOA | http://openinsider.com/insider/Blackstone-Tactical-Opportunities-Associates---Nq-L.L.C./1844883 | Finance of America Companies Inc. | | | | | +| 2 | D | 2023-04-04 17:31:43 | 2023-03-31 | FOA | Bto Urban Holdings L.L.C. | 10% | P - Purchase | $1.38 | +10,869,566 | 24,386,710 | +80% | +$15,000,001 | http://www.sec.gov/Archives/edgar/data/1828937/000089924323010448/xslF345X03/doc4.xml | http://openinsider.com/FOA | http://openinsider.com/insider/Bto-Urban-Holdings-L.L.C./1854686 | Finance of America Companies Inc. | | | | | +| 3 | D | 2023-04-04 17:27:24 | 2023-03-31 | FOA | Blackstone Tactical Opportunities Fund - U - Nq L.L.C. | 10% | P - Purchase | $1.38 | +10,869,566 | 24,386,710 | +80% | +$15,000,001 | http://www.sec.gov/Archives/edgar/data/1828937/000089924323010444/xslF345X03/doc4.xml | http://openinsider.com/FOA | http://openinsider.com/insider/Blackstone-Tactical-Opportunities-Fund---U---Nq-L.L.C./1853348 | Finance of America Companies Inc. | | | | | + +Try the `whales` preset to track some of the big money: + +```python +openbb.stocks.ins.filter("whales") +``` + +| | X | Filing Date | Trading Date | Ticker | Insider | Title | Trade Type | Price | Quantity | Owned | Delta Own | Value | Filing Link | Ticker Link | Insider Link | Company | +| -: | :- | :------------------ | :----------- | :----- | :------------------------ | :------------------------ | :----------- | :--------------------------------------------------------------- | :------------------------------------------------------------------------------------- | :------------------------- | :--------------------------------------------------------------- | :----------------------------- | :---------- | :---------- | :----------- | :------ | +| 0 | DM | 2023-05-15 21:26:39 | 2023-05-11 | OXY | Berkshire Hathaway Inc | 10% | P - Purchase | $58.06 | +2,165,792 | 213,966,443 | +1% | +$125,746,876 | http://www.sec.gov/Archives/edgar/data/797468/000089924323013028/xslF345X03/doc4.xml | http://openinsider.com/OXY | http://openinsider.com/insider/Berkshire-Hathaway-Inc/1067983 | Occidental Petroleum Corp /De/ | | | | | +| 1 | M | 2023-05-15 16:32:03 | 2023-05-11 | MA | Mastercard Foundation | 10% | S - Sale | $381.83 | -377,448 | 99,808,197 | 0% | -$144,121,385 | http://www.sec.gov/Archives/edgar/data/1141391/000089534523000297/xslF345X03/form4.xml | http://openinsider.com/MA | http://openinsider.com/insider/Mastercard-Foundation/1421897 | Mastercard Inc | | | | | +| 2 | | 2023-05-12 19:50:56 | 2023-05-10 | STZ | Ajb Business Holdings LP | Member of 10% owner group | S - Sale | $223.53 | -650,000 | 3,365,715 | -16% | -$145,294,500 | http://www.sec.gov/Archives/edgar/data/16918/000089924323012892/xslF345X03/doc4.xml | http://openinsider.com/STZ | http://openinsider.com/insider/Ajb-Business-Holdings-LP/1955386 | Constellation Brands, Inc. | | | | | +| 3 | | 2023-05-12 19:46:15 | 2023-05-10 | STZ | Zmss Business Holdings LP | Member of 10% owner group | S - Sale | $223.53 | -650,000 | 3,365,715 | -16% | -$145,294,500 | http://www.sec.gov/Archives/edgar/data/16918/000089924323012888/xslF345X03/doc4.xml | http://openinsider.com/STZ | http://openinsider.com/insider/Zmss-Business-Holdings-LP/1955193 | Constellation Brands, Inc. | | | | | diff --git a/website/content/sdk/data-available/stocks/introduction.md b/website/content/sdk/data-available/stocks/introduction.md new file mode 100644 index 000000000000..4e0f030124e3 --- /dev/null +++ b/website/content/sdk/data-available/stocks/introduction.md @@ -0,0 +1,399 @@ +--- +title: Stocks +sidebar_position: 1 +description: This documentation page describes all the modules that are within the stocks menu of OpenBB. +keywords: +- stocks +- behavioural analysis +- comparison analysis +- discovery +- dark pool +- short data +- government trading +- insider trading +- fundamental analysis +- technical analysis +--- + +The Stocks module provides the functionality of the Stocks menu from the OpenBB Terminal. The list below are the SDK functions within the Stocks module and a short description: + +| Path | Type | Description | +| :--------------------- | :--------: | ------------------------------------------------------: | +| openbb.stocks.ba | Sub-Module | Behavioural Analysis | +| openbb.stocks.ca | Sub-Module | Comparison Analysis | +| openbb.stocks.candle | Function | OHLC + Volume + Moving Averages Chart | +| openbb.stocks.disc | Sub-Module | Stock Discovery | +| openbb.stocks.dps | Sub-Module | Dark Pools & Shorts | +| openbb.stocks.fa | Sub-Module | Fundamental Analysis & Future Estimations | +| openbb.stocks.gov | Sub-Module | US Government, Lobbying & Representative Activity | +| openbb.stocks.ins | Sub-Module | Corporate Insider Activity (SEC Form 4) | +| openbb.stocks.load | Function | Load Historical OHLC+V Data | +| openbb.stocks.options | Sub-Module | Options | +| openbb.stocks.qa | Sub-Module | Stocks-Only Quantitative Analysis | +| openbb.stocks.quote | Function | Last Price and Performance Data (FinancialModelingPrep) | +| openbb.stocks.screener | Sub-Module | Stock Screener | +| openbb.stocks.search | Function | Find Stocks | +| openbb.stocks.sia | Sub-Module | Sector & Industry Analysis | +| openbb.stocks.ta | Sub-Module | Stocks-Only Technical Analysis | +| openbb.stocks.th | Sub-Module | Trading Hours (Market Status) | +| openbb.stocks.tob | Function | Top of Book (CBOE) | + +## How to use + +```python +help(openbb.stocks) +``` + +Most items in `openbb.stocks` are sub-modules. The objective of this guide is to introduce the functions at the top-level and to demonstrate a selection of functions from the sub-modules. + +## Examples + +The code snippets in the following section will assume that the import block contains: + +```python +import pandas as pd +from datetime import datetime +from openbb_terminal.sdk import openbb + +``` + +### Load + +The first step in a workflow might be to collect historical price data. The `load` function has the ability to request data from multiple sources. The choices for `source` are currently: + +- YahooFinance (default) +- AlphaVantage +- Polygon +- EODHD + +```python +spy_monthly = openbb.stocks.load( + symbol = 'SPY', + start_date = '1990-01-01', + interval = 1440, + prepost = False, + source = 'YahooFinance', + weekly = False, + monthly = True, +) +spy_monthly.head(3) +``` + +| date | Open | High | Low | Close | Adj Close | Volume | +| :------------------ | ------: | ------: | ------: | ------: | --------: | ---------: | +| 1993-02-01 00:00:00 | 43.9688 | 45.125 | 42.8125 | 44.4062 | 25.6043 | 5.4176e+06 | +| 1993-03-01 00:00:00 | 44.5625 | 45.8438 | 44.2188 | 45.1875 | 26.0548 | 3.0192e+06 | +| 1993-04-01 00:00:00 | 45.25 | 45.25 | 43.2812 | 44.0312 | 25.508 | 2.6972e+06 | + +There are source-dependent differences to the DataFrame returned. For example, compare the above with below: + +```python +spy_monthly = openbb.stocks.load( + symbol = 'SPY', + start_date = '1990-01-01', + interval = 1440, + prepost = False, + source = 'Polygon', + weekly = False, + monthly = True, +) +spy_monthly.head(3) +``` + +| date | Volume | vw | Open | Adj Close | High | Low | Transactions | Close | +| :------------------ | ----------: | ------: | -----: | --------: | -----: | -----: | -----------: | -----: | +| 2022-09-01 04:00:00 | 1.99492e+09 | 382.507 | 392.89 | 357.18 | 411.73 | 357.04 | 1.35653e+07 | 357.18 | +| 2022-10-01 04:00:00 | 2.02389e+09 | 370.918 | 361.08 | 386.21 | 389.52 | 348.11 | 1.38047e+07 | 386.21 | +| 2022-11-01 04:00:00 | 1.17559e+09 | 386.119 | 390.14 | 394.28 | 402.31 | 368.79 | 8.34067e+06 | 394.28 | + +### Candle + +OHLC DataFrames can be passed through the `Candle` function to display a chart. + +```python +openbb.stocks.candle(data = spy_monthly, symbol = 'SPY - Monthly Candles') +``` + +![openbb.stocks.candle](https://user-images.githubusercontent.com/85772166/201727311-e42f5ec3-bfdd-4d5d-ae4d-7e113f4b455d.png "openbb.stocks.candle") + +The `candle` function is also aware if a ticker is being passed. This makes it unnecessary to create a DataFrame if the objective is only to display the chart. + +```python +openbb.stocks.candle('SPY') +``` + +![openbb.stocks.candle](https://user-images.githubusercontent.com/85772166/202576993-08bfb90c-2254-423e-b599-8c86a1ea1e12.png "openbb.stocks.candle") + +Add moving averages to the chart with: + +```python +openbb.stocks.candle('SPY', ma = [50,150]) +``` + +![openbb.stocks.candle](https://user-images.githubusercontent.com/85772166/202576848-27e86f9a-e9bd-49b4-9008-2ad374e07abb.png "openbb.stocks.candle") + +### Search + +Search for companies by name with the `search` function, with optional filters for sector, industry, and region: + +```python +openbb.stocks.search(sector = 'Energy', country = 'United Kingdom', query = 'oil') +``` + +| | | long_name | country | sector | industry | exchange | +| -: | :----- | :------------------------------ | :------------- | :----- | :------------ | -------: | +| 0 | 3NO.F | Nostrum Oil & Gas PLC | United Kingdom | Energy | Oil & Gas E&P | nan | +| 1 | BOIL.L | Baron Oil Plc | United Kingdom | Energy | Oil & Gas E&P | nan | +| 2 | EGN.F | Europa Oil & Gas (Holdings) plc | United Kingdom | Energy | Oil & Gas E&P | nan | +| 3 | EOG.L | Europa Oil & Gas (Holdings) plc | United Kingdom | Energy | Oil & Gas E&P | nan | +| 4 | GHA.F | Baron Oil Plc | United Kingdom | Energy | Oil & Gas E&P | nan | + +...continued + +### Quote + +Watchlists are easy to make. Get the last price and performance data for multiple tickers by looping the `quote` function: + +```python +spdr_sectors = ['SPY', 'XLE', 'XLB', 'XLI', 'XLP', 'XLY', 'XLV', 'XLF', 'XLK', 'XLC', 'XLU', 'XLRE'] + +quotes: object = [] +symbols = spdr_sectors +for symbols in spdr_sectors: + quote = openbb.stocks.quote(symbols).transpose() + quotes.append(quote) + +quotes = pd.concat(quotes) + +quotes +``` + +| | Symbol | Name | Price | Changes percentage | Change | Day low | Day high | Year high | Year low | Market cap | Price avg50 | Price avg200 | Exchange | Volume | Avg volume | Open | Previous close | Eps | Pe | Earnings announcement | Shares outstanding | Timestamp | +|---:|:---------|:-----------------------------------------------|--------:|---------------------:|---------:|----------:|-----------:|------------:|-----------:|:-------------|--------------:|---------------:|:-----------|:---------|-------------:|-------:|-----------------:|---------:|------:|:------------------------|:---------------------|------------:| +| 0 | SPY | SPDR S&P 500 ETF Trust | 393.74 | 0.9616 | 3.75 | 390.08 | 394.17 | 462.07 | 348.11 | 361.367 B | 399.841 | 392.797 | AMEX | 88.857 M | 89590689 | 390.8 | 389.99 | 19.9365 | 19.75 | | 917.782 M | 1679342401 | +| 0 | XLE | Energy Select Sector SPDR Fund | 77.7 | 2.0024 | 1.5253 | 76.1 | 78.2 | 94.71 | 65.48 | 14.485 B | 86.6584 | 82.6697 | AMEX | 25.791 M | 19906166 | 76.1 | 76.1747 | 10.86 | 7.15 | | 186.424 M | 1679342400 | +| 0 | XLB | Materials Select Sector SPDR Fund | 76.73 | 2.0581 | 1.5473 | 75.77 | 76.77 | 91.49 | 66.85 | 5.519 B | 81.7186 | 77.8203 | AMEX | 7.327 M | 5830645 | 75.77 | 75.1827 | 5.16256 | 14.86 | | 71.924 M | 1679342400 | +| 0 | XLI | Industrial Select Sector SPDR Fund | 97.55 | 1.3242 | 1.2749 | 96.71 | 97.79 | 105.23 | 82.75 | 13.328 B | 101.103 | 95.1877 | AMEX | 14.078 M | 11957477 | 96.71 | 96.2751 | 4.6974 | 20.77 | | 136.626 M | 1679342400 | +| 0 | XLP | Consumer Staples Select Sector SPDR Fund | 72.76 | 1.386 | 0.9947 | 72.01 | 72.83 | 81.34 | 66.18 | 15.292 B | 73.092 | 72.9574 | AMEX | 14.127 M | 10950449 | 72.04 | 71.7653 | 2.88675 | 25.2 | | 210.172 M | 1679342400 | +| 0 | XLY | Consumer Discretionary Select Sector SPDR Fund | 141.52 | 0.433 | 0.6102 | 139.75 | 142.39 | 192.19 | 126 | 17.018 B | 143.901 | 146.454 | AMEX | 5.863 M | 5416313 | 140.74 | 140.91 | 6.27203 | 22.56 | | 120.253 M | 1679342400 | +| 0 | XLV | Health Care Select Sector SPDR Fund | 126.96 | 1.2675 | 1.5891 | 125.58 | 127.145 | 143.42 | 118.75 | 25.064 B | 131.092 | 130.376 | AMEX | 10.584 M | 8826462 | 125.58 | 125.371 | 5.92017 | 21.45 | | 197.415 M | 1679342400 | +| 0 | XLF | Financial Select Sector SPDR Fund | 31.17 | 1.1114 | 0.3426 | 31.025 | 31.44 | 40.01 | 29.59 | 27.537 B | 35.4068 | 33.8593 | AMEX | 74.917 M | 50017188 | 31.07 | 30.8274 | 2.57075 | 12.12 | | 883.445 M | 1679342400 | +| 0 | XLK | Technology Select Sector SPDR Fund | 143.53 | 0.2693 | 0.3855 | 141.82 | 143.7 | 163.65 | 112.97 | 39.048 B | 136.542 | 132.924 | AMEX | 5.924 M | 7283266 | 142.89 | 143.145 | 5.1111 | 28.08 | | 272.056 M | 1679342400 | +| 0 | XLC | Communication Services Select Sector SPDR Fund | 55.27 | 0.7474 | 0.41 | 54.71 | 55.41 | 71.57 | 44.86 | 0 | 54.1118 | 52.9782 | AMEX | 7.189 M | 6117298 | 54.91 | 54.86 | 2.87114 | 19.25 | | 0 | 1679342400 | +| 0 | XLU | Utilities Select Sector SPDR Fund | 67 | 0.7818 | 0.5197 | 66.56 | 67.22 | 78.22 | 60.35 | 10.939 B | 68.0158 | 69.9207 | AMEX | 19.265 M | 12304022 | 66.58 | 66.4803 | 2.88295 | 23.24 | | 163.274 M | 1679342400 | +| 0 | XLRE | The Real Estate Select Sector SPDR Fund | 36.36 | 1.0727 | 0.3859 | 35.87 | 36.4932 | 50.97 | 33.125 | 0 | 38.953 | 39.4885 | AMEX | 4.963 M | 6039455 | 36.06 | 35.9741 | 1.30938 | 27.77 | | 0 | 1679342400 | + +### TOB + +Top of Book gets the size and price at the top of the order book. + +```python +bid,ask = openbb.stocks.tob('SPY') +quote_tob = bid.join(ask, lsuffix= ': Bid', rsuffix = ': Ask') + +quote_tob +``` + +| | Size: Bid | Price: Bid | Size: Ask | Price: Ask | +| -: | --------: | ---------: | --------: | ---------: | +| 0 | 100 | 394.85 | 100 | 395 | +| 1 | 100 | 394.8 | 300 | 395.05 | +| 2 | 100 | 394.7 | 100 | 395.07 | +| 3 | 100 | 394.68 | 200 | 395.25 | +| 4 | 100 | 394.65 | 100 | 395.29 | + +### Filings + +Get the most-recent form submissions to the SEC. + +```python +filings = openbb.stocks.disc.filings() +filings.head(3) +``` + +| Date | Ticker | CIK | Form Type | Title | URL | +|:--------------------|:---------|--------:|:------------|:------------------------------------------------------|:--------------------------------------------------------------------------------------------------| +| 2023-03-20 17:30:26 | TLGA | 1827871 | 10-K | 10-K - TLG Acquisition One Corp. (0001827871) (Filer) | https://www.sec.gov/Archives/edgar/data/1827871/000119312523074903/0001193125-23-074903-index.htm | +| 2023-03-20 17:30:26 | TLGA | 1827871 | 10-K | 10-K - TLG Acquisition One Corp. (0001827871) (Filer) | https://www.sec.gov/Archives/edgar/data/1827871/000119312523074903/0001193125-23-074903-index.htm | +| 2023-03-20 17:30:26 | TLGA-UN | 1827871 | 10-K | 10-K - TLG Acquisition One Corp. (0001827871) (Filer) | https://www.sec.gov/Archives/edgar/data/1827871/000119312523074903/0001193125-23-074903-index.htm | +| 2023-03-20 17:30:26 | TLGA-UN | 1827871 | 10-K | 10-K - TLG Acquisition One Corp. (0001827871) (Filer) | https://www.sec.gov/Archives/edgar/data/1827871/000119312523074903/0001193125-23-074903-index.htm | +| 2023-03-20 17:30:26 | TLGA-WT | 1827871 | 10-K | 10-K - TLG Acquisition One Corp. (0001827871) (Filer) | https://www.sec.gov/Archives/edgar/data/1827871/000119312523074903/0001193125-23-074903-index.htm | + +Filter them to be from the current day only: + +```python +today = filings.filter(like = datetime.now().strftime("%Y-%m-%d"), axis = 0) +``` + +### Screener + +Grab the list of filtered tickers and put them through the comparison analysis screener and get an overview: + +```python +tickers = today['Ticker'].to_list() +screener_results = openbb.stocks.ca.screener(similar = tickers, data_type = 'overview') +screener_results = screener_results.sort_values(by = ['Market Cap'], ascending = False).convert_dtypes() + +screener_results.head(5) +``` + +| | Ticker | Company | Sector | Industry | Country | Market Cap | P/E | Price | Change | Volume | +|----:|:---------|:-----------------|:-----------------------|:-----------------------------|:---------------|-------------:|------:|--------:|---------:|---------:| +| 72 | NVO | Novo Nordisk A/S | Healthcare | Biotechnology | Denmark | 2.4814e+11 | 41.42 | 143.59 | 0.0298 | 1242167 | +| 34 | EQNR | Equinor ASA | Energy | Oil & Gas Integrated | Norway | 8.591e+10 | 3.02 | 27.34 | 0.0096 | 4154740 | +| 46 | GSK | GSK plc | Healthcare | Drug Manufacturers - General | United Kingdom | 7.026e+10 | 12.29 | 34.93 | 0.0252 | 2973805 | +| 105 | UBS | UBS Group AG | Financial | Banks - Diversified | Switzerland | 6.783e+10 | 8.39 | 18.8 | 0.033 | 40598414 | +| 83 | RELX | RELX PLC | Communication Services | Publishing | United Kingdom | 5.97e+10 | 30.52 | 31.31 | 0.0205 | 620949 | + +This type of framework can be used to create any type of custom screener. For example, the most popular tickers on Stocktwits: + +```python +stocktwits = openbb.stocks.ba.trending() +stocktwits = pd.DataFrame(stocktwits).sort_values(by = 'Watchlist Count', ascending = False) +tickers = stocktwits['Ticker'].to_list() +stocktwits.head(10) +``` + +| | Ticker | Watchlist Count | Name | +| -: | :----- | --------------: | :----------------------------- | +| 18 | NVDA | 409301 | NVIDIA Corp | +| 12 | AMC | 406952 | AMC Entertainment Holdings Inc | +| 5 | WMT | 109864 | Walmart Inc | +| 6 | MRNA | 100705 | Moderna Inc | +| 21 | PFE | 87229 | Pfizer Inc. | +| 4 | DWAC | 66122 | Digital World Acquisition Corp | +| 29 | CSCO | 54458 | Cisco Systems, Inc. | +| 0 | SAVA | 49063 | Cassava Sciences Inc | +| 8 | TDOC | 38657 | Teladoc Health Inc | +| 16 | PENN | 38277 | Penn National Gaming, Inc. | + +Filter the results by market cap: + +```python +screener_results = openbb.stocks.ca.screener(similar = tickers, data_type = 'overview') +screener_results = screener_results.sort_values(by = ['Market Cap'], ascending = False) + +screener_results.head(5) +``` + +| | Ticker | Company | Sector | Industry | Country | Market Cap | P/E | Price | Change | Volume | +| -: | :----- | :----------------- | :----------------- | :--------------------------- | :------ | ---------: | ----: | -----: | ------: | ----------: | +| 15 | NVDA | NVIDIA Corporation | Technology | Semiconductors | USA | 3.9217e+11 | 53.53 | 163.66 | 0.0024 | 3.16641e+07 | +| 26 | WMT | Walmart Inc. | Consumer Defensive | Discount Stores | USA | 3.864e+11 | 28.46 | 140.5 | -0.0146 | 5.33372e+06 | +| 18 | PFE | Pfizer Inc. | Healthcare | Drug Manufacturers - General | USA | 2.6591e+11 | 9.03 | 49.36 | 0.037 | 1.07892e+07 | +| 4 | BLK | BlackRock, Inc. | Financial | Asset Management | USA | 1.1412e+11 | 21.34 | 747.95 | -0.0346 | 742602 | +| 25 | TGT | Target Corporation | Consumer Defensive | Discount Stores | USA | 7.566e+10 | 19.68 | 175.67 | 0.0136 | 2.45293e+06 | + +...continued + +### SEC + +Get the links for SEC filings belonging to a company: + +```python +openbb.stocks.fa.sec(symbol = 'WMT') +``` + +| Filing Date | Document Date | Type | Category | Amended | Link | +| :---------- | :------------ | :------- | :---------------- | :------ | :----------------------------------------------------------------------------------- | +| 09/09/2022 | 09/06/2022 | 8-K | Special Events | | https://www.marketwatch.com/investing/stock/wmt/financials/secfilings?docid=16074059 | +| 09/02/2022 | 07/31/2022 | 10-Q | Quarterly Reports | | https://www.marketwatch.com/investing/stock/wmt/financials/secfilings?docid=16064659 | +| 08/17/2022 | 08/17/2022 | 8-K | Special Events | | https://www.marketwatch.com/investing/stock/wmt/financials/secfilings?docid=16026629 | +| 08/17/2022 | 08/17/2022 | 8-K | Special Events | | https://www.marketwatch.com/investing/stock/wmt/financials/secfilings?docid=16025172 | +| 08/16/2022 | 08/16/2022 | 8-K | Special Events | | https://www.marketwatch.com/investing/stock/wmt/financials/secfilings?docid=16021891 | +| 07/25/2022 | 07/25/2022 | 8-K | Special Events | | https://www.marketwatch.com/investing/stock/wmt/financials/secfilings?docid=15964414 | +| 07/21/2022 | N/A | SC 13D/A | N/A | \* | https://www.marketwatch.com/investing/stock/wmt/financials/secfilings?docid=15959675 | +| 06/28/2022 | 06/28/2022 | 8-K | Special Events | | https://www.marketwatch.com/investing/stock/wmt/financials/secfilings?docid=15918852 | +| 06/21/2022 | N/A | SC 13D | N/A | | https://www.marketwatch.com/investing/stock/wmt/financials/secfilings?docid=15900809 | + +...continued + +### Insiders Trading + +View insider activity on the stock: + +```python +openbb.stocks.ins.lins(symbol = 'WMT') +``` + +| Date | Relationship | Transaction | #Shares | Cost | Value ($) | #Shares Total | Insider Trading | SEC Form 4 | +| :----- | :----------------------- | :---------- | :------ | -----: | :--------- | :------------ | :----------------- | :-------------- | +| Oct 27 | President and CEO | Sale | 9,708 | 141.18 | 1,370,617 | 1,478,337 | McMillon C Douglas | Oct 28 06:14 PM | +| Oct 27 | Executive Vice President | Sale | 4,375 | 140.94 | 616,612 | 263,809 | Furner John R. | Oct 28 06:11 PM | +| Sep 22 | Executive Vice President | Sale | 4,375 | 134.38 | 587,912 | 268,183 | Furner John R. | Sep 23 05:21 PM | +| Sep 22 | President and CEO | Sale | 9,708 | 134.04 | 1,301,309 | 1,488,043 | McMillon C Douglas | Sep 23 05:18 PM | +| Aug 25 | Director | Sale | 347,542 | 135.66 | 47,145,880 | 282,330,635 | WALTON S ROBSON | Aug 26 06:36 PM | + +...continued + +### Income Statement Comparison + +Income statements from multiple companies can be easily referenced: + +```python +openbb.stocks.ca.income(similar = ['WMT', 'TGT', 'AMZN'], quarter = True) +``` + +| Item | 31-Jul-2022: WMT | 31-Jul-2022: TGT | 30-Sep-2022: AMZN | +| :---------------------------------- | :--------------- | :--------------- | :---------------- | +| Sales/Revenue | 152.86B | 26.04B | 127.1B | +| Sales Growth | 7.97% | 3.44% | 4.84% | +| Cost of Goods Sold (COGS) incl. D&A | 115.84B | 20.71B | 70.27B | +| COGS Growth | 8.41% | 8.67% | 5.79% | +| COGS excluding D&A | 113.14B | 20.06B | 60.06B | +| Depreciation & Amortization Expense | 2.7B | 650M | 10.2B | +| Depreciation | 2.7B | - | - | +| Amortization of Intangibles | - | - | - | +| Gross Income | 37.02B | 5.32B | 56.83B | +| Gross Income Growth | 6.62% | -12.85% | 3.69% | +| Gross Profit Margin | 24.22% | 20.44% | 44.71% | +| SG&A Expense | 30.17B | 4.98B | 54.14B | +| SGA Growth | 3.30% | 4.98% | 5.33% | +| Research & Development | - | - | 19.49B | +| Other SG&A | - | - | - | +| Other Operating Expense | - | - | - | +| Unusual Expense | (238M) | 27M | (2.04B) | +| EBIT after Unusual Expense | 238M | (27M) | 2.04B | +| Non Operating Income/Expense | - | 8M | (1.45B) | +| Non-Operating Interest Income | 31M | - | 277M | + +...continued + +### Ratios + +Get historical fundamental ratios for a company: + +```python +openbb.stocks.fa.ratios(symbol = 'WMT') +``` + +| | 2022 | 2021 | 2020 | 2019 | 2018 | +| :---------------------------- | :----- | :----- | :----- | :----- | :----- | +| Period | FY | FY | FY | FY | FY | +| Current ratio | 0.928 | 0.972 | 0.795 | 0.799 | 0.760 | +| Quick ratio | 0.264 | 0.262 | 0.202 | 0.181 | 0.158 | +| Cash ratio | 0.169 | 0.191 | 0.122 | 0.100 | 0.086 | +| Days of sales outstanding | 5.277 | 4.253 | 4.378 | 4.458 | 4.095 | +| Days of inventory outstanding | 48.080 | 39.034 | 41.101 | 41.937 | 42.799 | +| Operating cycle | 53.357 | 43.287 | 45.479 | 46.395 | 46.894 | +| Days of payables outstanding | 47.017 | 42.674 | 43.449 | 44.580 | 45.056 | +| Cash conversion cycle | 6.340 | 0.613 | 2.030 | 1.814 | 1.838 | +| Gross profit margin | 0.251 | 0.248 | 0.247 | 0.251 | 0.254 | +| Operating profit margin | 0.045 | 0.040 | 0.039 | 0.043 | 0.041 | +| Pretax profit margin | 0.033 | 0.037 | 0.038 | 0.022 | 0.030 | +| Net profit margin | 0.024 | 0.024 | 0.028 | 0.013 | 0.020 | + +...continued + +Take just the ratio needed by filtering the index: + +```python +ratios = openbb.stocks.fa.ratios(symbol = 'WMT', limit = 20) +ratios.filter(like = 'Price earnings to growth ratio', axis = 0) +``` + +| | 2022 | 2021 | 2020 | 2019 | 2018 | 2017 | 2016 | 2015 | 2014 | 2013 | 2012 | 2011 | 2010 | 2009 | 2008 | 2007 | 2006 | 2005 | 2004 | 2003 | +| :----------------------------- | -----: | -----: | ---: | -----: | -----: | -----: | -----: | ----: | -----: | ----: | ---: | ----: | ----: | ----: | ----: | -----: | ----: | ----: | ----: | ----: | +| Price earnings to growth ratio | 10.202 | -3.163 | 0.16 | -1.401 | -1.069 | -4.092 | -1.501 | 4.777 | -5.487 | 1.293 | 9.68 | 0.559 | 1.585 | 1.637 | 1.022 | 15.761 | 1.498 | 1.358 | 1.953 | 1.233 | + +Be sure to check out the introduction guides for each sub-module as well. diff --git a/website/content/sdk/data-available/stocks/options-chains.md b/website/content/sdk/data-available/stocks/options-chains.md new file mode 100644 index 000000000000..8c7d4b4c95c4 --- /dev/null +++ b/website/content/sdk/data-available/stocks/options-chains.md @@ -0,0 +1,561 @@ +--- +title: Options Chains +description: A technical guide detailing how to load options chains data from six + different sources into memory using openbb. Reviews how to properly filter, sort, + and analyze this kind of data, and outlines the process for implementing various + options strategies. This document is heavily focused on technical processes within + a financial context. +keywords: +- Options Chains Data +- Option Strategies +- Financial Data +- Data Filtering +- Data Sorting +- Data Visualization +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +## Overview + +### Options Data Object + +Options chains data is loaded to memory by using the function, `openbb.stocks.options.load_options_chains()`, and is available from six sources: + +- CBOE +- Intrinio (no free data) +- Nasdaq +- TMX +- Tradier (requires Sandbox developer key) +- YahooFinance + +Every source will return the same object which has data and additional callable functions bound to the class. They are methods for filtering, sorting, and analyzing the data contained within. + +```python +from openbb_terminal.sdk import openbb +openbb.stocks.options.load_options_chains? +``` + +```python +Parameters +---------- +symbol: str + The ticker symbol to load the data for. +source: str + The source for the data. Defaults to "CBOE". ["CBOE", "Intrinio", "Nasdaq", "TMX", "Tradier", "YahooFinance"] +date: str + The date for EOD chains data. Only available for "Intrinio" and "TMX". +pydantic: bool + Whether to return as a Pydantic Model or as a Pandas object. Defaults to False. + +Returns +------ +OptionsChains + chains: pd.DataFrame + The complete options chain for the ticker. Returns as a dictionary if pydantic is True. + expirations: list[str] + List of unique expiration dates. (YYYY-MM-DD) + strikes: list[float] + List of unique strike prices. + last_price: float + The last price of the underlying asset. + underlying_name: str + The name of the underlying asset. + underlying_price: pd.Series + The price and recent performance of the underlying asset. Returns as a dictionary if pydantic is True. + hasIV: bool + Returns implied volatility. + hasGreeks: bool + Returns greeks data. + symbol: str + The symbol entered by the user. + source: str + The source of the data. + date: str + The date, when the chains data is historical EOD. + SYMBOLS: pd.DataFrame + The symbol directory for the source, when available. Returns as a dictionary if pydantic is True. + + Methods + ------ + chart_skew: Callable + Function to chart the implied volatility skew. + chart_stats: Callable + Function to chart a variety of volume and open interest statistics. + chart_surface: Callable + Function to chart the volatility as a 3-D surface. + chart_volatility: Callable + Function to chart the implied volatility smile. + get_skew: Callable + Function to calculate horizontal and vertical skewness. + get_stats: Callable + Function to return a table of summary statistics, by strike or by expiration. + get_straddle: Callable + Function to calculate straddles and the payoff profile. + get_strangle: Callable + Function to calculate strangles and the payoff profile. + get_synthetic_long: Callable + Function to calculate a synthetic long position. + get_synthetic_short: Callable + Function to calculate a synthetic short position. + get_vertical_call_spread: Callable + Function to calculate vertical call spreads. + get_vertical_put_spreads: Callable + Function to calculate vertical put spreads. + get_strategies: Callable + Function for calculating multiple straddles and strangles at different expirations and moneyness. +``` + +## Loading Data + +### `load_options_chains()` + +The default source to load data from is, `CBOE`. Use the command below to get started. + +```python +from openbb_terminal.sdk import openbb +spy = openbb.stocks.options.load_options_chains("SPY") +``` + +The result is returned as the object described in the previous section. + +![Options Data Object](https://github.com/deeleeramone/OpenBBTerminal/assets/85772166/704e6d60-b148-442d-b4b2-689ceca6f55c) + +The object is still returned if an unsupported symbol is requested and a message will be printed. + +```python +In [4]: data = openbb.stocks.options.load_options_chains("spyyy") +The symbol, SPYYY, was not found in the CBOE directory. + +In [5]: data.chains +Out[5]: pandas.core.frame.DataFrame +``` + +Where available, symbols are verified against a source-specific symbol directory. This is accessible from the Options data object as the attribute named, `SYMBOLS`. + +```python +data.SYMBOLS.filter(like = "SPY", axis = 0) +``` + +| Symbol | Company Name | DPM Name | Post/Station | +|:---------|:-------------------------------|:-------------------------|:---------------| +| SPY | SPDR S&P 500 ETF TR TR UNIT | Morgan Stanley & Co. LLC | 8/1 | +| SPYG | SPDR SER TR PRTFLO S&P500 GW | Belvedere Trading LLC | 6/1 | +| SPYD | SPDR SER TR PRTFLO S&P500 HI | Citadel Securities LLC | 6/1 | +| SPYV | SPDR SER TR PRTFLO S&P500 VL | Belvedere Trading LLC | 6/1 | +| NSPY | UNIFIED SER TR NIGHTSHARES 500 | Wolverine Trading, LLC | 3/1 | + +:::note +A valid symbol will not always have listed options. +::: + +Key information for the underlying asset are stored in the object as `last_price`, `underlying_name`, and `underlying_price`. The information returned to `underlying_price` will vary by source, but all column headers and index names related to the raw data are formatted in camelCase. + +CBOE: + +```python +In [7]: data.underlying_price +Out[7]: +type stock +tick down +bid 449.18 +bidSize 1 +askSize 5 +ask 449.2 +price 449.28 +open 450.56 +high 451.36 +low 448.49 +close 449.28 +volume 69772484 +previousClose 449.28 +change -0.28 +changePercent -0.0623 +ivThirty 10.947 +ivThirtyChange 0.0 +lastTradeTimestamp 2023-07-14T16:00:00 +ivThirtyOneYearHigh 30.646999 +hvThirtyOneYearHigh 30.648199 +ivThirtyOneYearLow 10.692 +hvThirtyOneYearLow 10.0721 +ivSixtyOneYearHigh 28.674999 +hvSixtyOneYearHigh 29.5842 +ivSixtyOneYearLow 11.245 +hvsixtyOneYearLow 11.833 +ivNinetyOneYearHigh 27.862 +hvNinetyOneYearHigh 26.808901 +ivNinetyOneYearLow 11.827 +hvNinetyOneYearLow 13.3855 +Name: SPY, dtype: object +``` + +TMX: + +```python +In [8]: data = openbb.stocks.options.load_options_chains("XIU", "TMX") + +In [9]: data.underlying_price +Out[9]: +time 15:59:56.910 +previousClose 30.86 +transactions 393 +volume 50751 +value 1567628 +valueCAD 1567628 +open 30.97 +price 30.85 +change -0.01 +changePercent -0.03 +tick 0.01 +low 30.835 +high 30.97 +vwap 30.89 +fiftyTwoWeekHigh 31.86 +fiftyTwoWeekLow 27.375 +Name: XIU, dtype: object +``` + +Not every source will return implied volatility or Greeks data. The two object attributes, `hasGreeks` and `hasIV`, act as validators for downstream functions. + +```python +In [10]: data.hasIV +Out[10]: False + +In [11]: data.get_skew() +Options data object does not have Implied Volatility and is required for this function. +``` + +#### Historical EOD Chains + +Historical EOD chains data is currently available from `Intrinio` or `TMX`. The amount of historical data will depend on the subscription status with `Intrinio`, but is available from the beginning of 2009 from `TMX`. Add the `date` argument when loading the data. The price data of the underlying asset will reflect the closing price on the date entered. + +```python +In [12]: data = openbb.stocks.options.load_options_chains("CCO", "TMX", date = "2016-06-29") + +In [13]: data.underlying_price +Out[13]: +date 2016-06-29 +bid 13.99 +ask 14.01 +bidSize 29 +askSize 20 +price 14.0 +volume 801176 +previousClose 13.73 +change 0.27 +open 13.88 +high 14.09 +low 13.8 +valueCAD 11198995 +transactions 3283 +symbol CCO +Name: Cameco Corporation, dtype: object +``` + +## Additional Class Methods + +The class methods work with the Options data object to query the loaded chains data in different ways. Column headers at this stage are cleaned and presentable for view. There are two types of operations, `get` and `chart`, with the latter being a subset of the former. The docstring (`data?` - and as shown in a section above) lists them all, as Methods, with a short description. The nuances of the functions are explained within the docstrings of each. Variations to the combinations of parameters will yield over thirty unique charts and provide nearly infinite ways to query to data stored in the object. + +:::note + +All `chart_` methods have boolean arguments for `raw` and `external_axes`. These return an interactive table in the PyWry window or the Plotly figure object, respectively. In a Jupyter Notebook, they will be displayed inline. + +Returning the command to a variable provides the ability to style and customize charts as desired. + +```python +fig = data.chart_volatility(expirations=data.expirations[1], external_axes = True) +``` + +::: + +### `get_stats()` + +```python +Parameters +---------- +by: str + Whether to calculate by strike or expiration. Default is expiration. +query: DataFrame + Entry point to perform DataFrame operations on self.chains at the input stage. + +Returns +------- +pd.DataFrame + Pandas DataFrame with the calculated statistics. +``` + +Ratios are defined as Put/Call. + +```python +data = openbb.stocks.options.load_options_chains("VIX") +data.get_stats().iloc[1] +``` + +| | 2023-07-26 | +|:-------------|-------------:| +| Puts OI | 2018 | +| Calls OI | 45875 | +| Total OI | 47893 | +| OI Ratio | 0.04 | +| Puts OTM | 873 | +| Calls OTM | 45747 | +| Puts ITM | 1145 | +| Calls ITM | 128 | +| OTM Ratio | 0.02 | +| ITM Percent | 2.66 | +| Puts Volume | 264 | +| Calls Volume | 2156 | +| Total Volume | 2420 | +| Volume Ratio | 0.12 | +| Vol-OI Ratio | 0.05 | + +The `query` parameter provides an entry point for DataFrame operations to take place prior to calculating. For example, filtering for only the options which traded during the last session. + +```python +data.get_stats(query = data.chains[vix.chains["lastTradeTimestamp"] > "2023-07-14"]) +``` + +| Expiration | Puts OI | Calls OI | Total OI | OI Ratio | Puts Volume | Calls Volume | Total Volume | Volume Ratio | Vol-OI Ratio | +|:-------------|-----------------:|-----------------:|-----------------:|-----------:|--------------:|---------------:|---------------:|---------------:|---------------:| +| 2023-07-19 | 1569778 | 3323396 | 4893174 | 0.47 | 113460 | 130416 | 243876 | 0.87 | 0.05 | +| 2023-07-26 | 1855 | 29273 | 31128 | 0.06 | 264 | 2156 | 2420 | 0.12 | 0.08 | +| 2023-08-02 | 1154 | 2498 | 3652 | 0.46 | 12 | 786 | 798 | 0.02 | 0.22 | +| 2023-08-09 | 330 | 961 | 1291 | 0.34 | 43 | 354 | 397 | 0.12 | 0.31 | +| 2023-08-16 | 907980 | 2246707 | 3154687 | 0.4 | 48668 | 197148 | 245816 | 0.25 | 0.08 | +| 2023-08-23 | 0 | 49 | 49 | 0 | 7 | 145 | 152 | 0.05 | 3.1 | +| 2023-09-20 | 614369 | 2097742 | 2712111 | 0.29 | 20750 | 19260 | 40010 | 1.08 | 0.01 | +| 2023-10-18 | 165239 | 1099858 | 1265097 | 0.15 | 3304 | 14912 | 18216 | 0.22 | 0.01 | +| 2023-11-15 | 70142 | 742698 | 812840 | 0.09 | 82 | 514 | 596 | 0.16 | 0 | +| 2023-12-20 | 44580 | 259815 | 304395 | 0.17 | 10797 | 12471 | 23268 | 0.87 | 0.08 | +| 2024-01-17 | 20860 | 43733 | 64593 | 0.48 | 23574 | 23690 | 47264 | 1 | 0.73 | +| 2024-02-14 | 1347 | 6567 | 7914 | 0.21 | 67 | 203 | 270 | 0.33 | 0.03 | +| 2024-03-20 | 63 | 1861 | 1924 | 0.03 | 8 | 219 | 227 | 0.04 | 0.12 | + +### chart_stats() + +The volume and open interest metrics can be visualized in a number of ways. In general, they are bucketed as volume and open interest by strike or expiration. + +```python +data.chart_stats() +``` + +![Vix % of Total Volume vs. Strike](https://github.com/deeleeramone/OpenBBTerminal/assets/85772166/70d55645-7510-4c1e-9e56-c6b37ef40249) + +```python +data.chart_stats(by="strike", oi=True) +``` + +![VIX % of Total Open Interest vs. Strike](https://github.com/deeleeramone/OpenBBTerminal/assets/85772166/9798ed44-23c3-4a54-9c20-ea6450c035d9) + +```python +data.chart_stats(by="strike", oi=True, percent=False) +``` + +![VIX Open Interest vs. Strike](https://github.com/deeleeramone/OpenBBTerminal/assets/85772166/b1bed9c5-4338-4fb5-8ffe-a67eba6c5219) + +```python +data.chart_stats(ratios=True) +``` + +![VIX Volume and Open Interest Ratios](https://github.com/deeleeramone/OpenBBTerminal/assets/85772166/0c459c96-267b-472e-8323-cb547af0e0e4) + +### Options Strategies + +These methods calculate common, single-leg, strategies and return one result. The target expiry date is expressed as the number of days until expiration, and the closest expiry to supplied value will be returned. There are six types of strategies currently supported: + +- `get_straddle()` +- `get_strangle()` +- `get_synthetic_long()` +- `get_synthetic_short()` +- `get_vertical_call_spread()` +- `get_vertical_put_spread()` + +:::note + +Looking for a place to get started as a contributor, and enjoy trading options? Strategies are an excellent starting point! + +::: + +All strategies share a common default setting, `days=30`. Vertical spreads require two strike prices, and they are entered as `sold`, `bought`. A bull call or put spread is entered with a bought price lower than the sold price. + +```python +data.get_vertical_call_spread(30,13,12.50) +``` + +| | Bull Call Spread | +|:------------------------|:-------------------| +| Symbol | VIX | +| Underlying Price | 13.34 | +| Expiration | 2023-08-16 | +| DTE | 31 | +| Strike 1 | 13.0 | +| Strike 2 | 12.5 | +| Strike 1 Premium | 2.9 | +| Strike 2 Premium | 3.4 | +| Cost | 0.5 | +| Cost Percent | 3.7481 | +| Breakeven Lower | 13.0 | +| Breakeven Lower Percent | -2.5487 | +| Breakeven Upper | nan | +| Breakeven Upper Percent | nan | +| Max Profit | 0.0 | +| Max Loss | -0.5 | +| Payoff Ratio | 0.0 | + +```python +data.get_vertical_put_spread(30,13,12.5) +``` + +| | Bull Put Spread | +|:------------------------|:---------------------| +| Symbol | VIX | +| Underlying Price | 13.34 | +| Expiration | 2023-08-16 | +| DTE | 31 | +| Strike 1 | 13.0 | +| Strike 2 | 12.5 | +| Strike 1 Premium | -0.17 | +| Strike 2 Premium | 0.12 | +| Cost | -0.05 | +| Cost Percent | 0.3748 | +| Breakeven Lower | nan | +| Breakeven Lower Percent | nan | +| Breakeven Upper | 12.95 | +| Breakeven Upper Percent | 2.92 | +| Max Profit | 0.05 | +| Max Loss | -0.45 | +| Payoff Ratio | 0.1111 | + +#### `get_strategies()` + +This takes all of the individual strategies and combines them into a single endpoint that can iterate over all expiry dates. + +```python +data.get_strategies(days = 30, straddle_strike = data.last_price, strangle_moneyness = 30, vertical_calls = [20,15], vertical_puts = [12,15], synthetic_longs = 16, synthetic_shrots = 14) +``` + +| | 2023-08-16 | 2023-08-16 | 2023-08-16 | 2023-08-16 | 2023-08-16 | 2023-08-16 | +|:------------------------|:--------------------|:------------------|:---------------|:----------------|:-----------------|:-------------------| +| DTE | 31 | 31 | 31 | 31 | 31 | 31 | +| Strategy | Long Straddle | Long Strangle | Synthetic Long | Synthetic Short | Bull Call Spread | Bear Put Spread | +| Underlying Price | 13.34 | 13.34 | 13.34 | 13.34 | 13.34 | 13.34 | +| Strike 1 | 13.5 | 17.0 | 14.0 | 16.0 | 20.0 | 12.0 | +| Strike 2 | 13.5 | 10.0 | 14.0 | 16.0 | 15.0 | 15.0 | +| Strike 1 Premium | 2.62 | 1.28 | 2.31 | -1.46 | -0.83 | -0.04 | +| Strike 2 Premium | 0.33 | 0.01 | -0.49 | 1.74 | 1.83 | 1.04 | +| Cost | 2.95 | 1.29 | 1.82 | 0.28 | 1.0 | 1.0 | +| Cost Percent | 22.1139 | 9.6702 | 13.6432 | 2.099 | 7.4963 | 7.4963 | +| Breakeven Upper | 16.45 | 18.29 | 15.82 | nan | nan | nan | +| Breakeven Upper Percent | 23.3133 | 37.1064 | 18.5907 | nan | nan | nan | +| Breakeven Lower | 10.55 | 8.71 | nan | 15.72 | 16.0 | 14.0 | +| Breakeven Lower Percent | -20.9145 | -34.7076 | nan | 17.8411 | 19.94 | 17.5412 | +| Max Profit | inf | inf | inf | 15.72 | 4.0 | 2.0 | +| Max Loss | -2.95 | -1.29 | -15.82 | inf | -1.0 | -1.0 | +| Payoff Ratio | inf | inf | nan | nan | 4.0 | 2.0 | + +The default state of `get_strategies()` is to return all ATM straddles. This information can be useful for charting the term structure and expected move of the underlying asset. + +### Volatility + +There are two types of views for volatility, smiles and surfaces. + +#### `chart_volatility()` + +As a default state, the put and call volatility smiles from the expiration in position 1, contained in the list `data.expirations[1]`, are displayed. + +```python +data.chart_volatility() +``` + +![VIX IV Smile](https://github.com/deeleeramone/OpenBBTerminal/assets/85772166/1bf4534a-7ae8-4770-9b07-5e793889beb9) + +The implied volatility can also be visualized as the forward curve at a specific strike or % moneyness. + +```python +data.chart_volatility(strike=20) +``` + +![VIX Volatility at $20 Strike](https://github.com/deeleeramone/OpenBBTerminal/assets/85772166/e2b0dba6-2a51-4ff2-9e43-3667de15ae21) + +```python +data.chart_volatility(moneyness=30) +``` + +![VIX Volatility at 30% OTM](https://github.com/deeleeramone/OpenBBTerminal/assets/85772166/c344724b-8544-4cd1-8cab-25e1924137a5) + +#### `chart_surface()` + +A portion, or the entire, volatility surface is presented as a 3-D chart. The data is arranged by types, selectable with the `option_type` parameter, choosing one of: `otm`, `itm`, `calls`, `puts`. The default state is `otm`. The X and Y axes can be narrowed to focus on a range of time and strike. + +```python +data.chart_surface(dte_range = [30,300], strike_range = [10,30]) +``` + +![VIX OTM IV Surface](https://github.com/deeleeramone/OpenBBTerminal/assets/85772166/410769fe-b7da-40bf-915e-68901b3caf13) + +### Skew + +Unlike volatility, there are both model and view components for the IV skew of the chain. + +#### `get_skew()` + +By default, this callable calculates the skew of every option. It can return either vertical or horizontal skew. Vertical skew can be narrowed to a specific expiry, and horizontal skew is determined by % OTM. + +```python +data.get_skew(data.expirations[1]).query("12 <= `Strike` <= 15") +``` + +| | Expiration | Strike | Option Type | IV | ATM IV | Skew | +|----:|:-------------|---------:|:--------------|-------:|---------:|--------:| +| 116 | 2023-07-26 | 12 | put | 1.1136 | 0.9283 | 0.1853 | +| 117 | 2023-07-26 | 12.5 | put | 1.0246 | 0.9283 | 0.0963 | +| 118 | 2023-07-26 | 13 | put | 0.9666 | 0.9283 | 0.0383 | +| 119 | 2023-07-26 | 13.5 | put | 0.9283 | 0.9283 | 0 | +| 120 | 2023-07-26 | 14 | call | 0.4994 | 0.4994 | 0 | +| 121 | 2023-07-26 | 14 | put | 0.8702 | 0.9283 | -0.0581 | +| 122 | 2023-07-26 | 14.5 | call | 0.6156 | 0.4994 | 0.1162 | +| 123 | 2023-07-26 | 14.5 | put | 0.8899 | 0.9283 | -0.0384 | +| 124 | 2023-07-26 | 15 | call | 0.6245 | 0.4994 | 0.1251 | +| 125 | 2023-07-26 | 15 | put | 0.9002 | 0.9283 | -0.0281 | + +```python +vix.get_skew(moneyness=20) +``` + +| expiration | Call Strike | Call IV | Call ATM IV | Call Skew | Put Strike | Put IV | Put ATM IV | Put Skew | ATM Skew | IV Skew | +|:-------------|--------------:|----------:|--------------:|------------:|-------------:|---------:|-------------:|-----------:|-----------:|----------:| +| 2023-07-19 | 16 | 1.0996 | 0.599 | 0.5006 | 10.5 | 1.0505 | 0.6328 | 0.4177 | -0.0338 | 0.0829 | +| 2023-07-26 | 16 | 0.8708 | 0.4994 | 0.3714 | 10.5 | 0.9101 | 0.9283 | -0.0182 | -0.4289 | 0.3896 | +| 2023-08-02 | 16 | 0.855 | 0.5026 | 0.3524 | 10.5 | 0.7438 | 0.6755 | 0.0683 | -0.1729 | 0.2841 | +| 2023-08-09 | 16 | 0.7861 | 0.4926 | 0.2935 | 10.5 | 0.6712 | 0.6575 | 0.0137 | -0.1649 | 0.2798 | +| 2023-08-16 | 16 | 0.8364 | 0.6284 | 0.208 | 10.5 | 0.6041 | 0.6117 | -0.0076 | 0.0167 | 0.2156 | +| 2023-08-23 | 16 | 0.9273 | 0.8918 | 0.0355 | 10.5 | 0.5492 | 0.6356 | -0.0864 | 0.2562 | 0.1219 | +| 2023-09-20 | 16 | 0.7023 | 0.5481 | 0.1542 | 10 | 0.5344 | 0.548 | -0.0136 | 0.0001 | 0.1678 | +| 2023-10-18 | 16 | 0.6447 | 0.5183 | 0.1264 | 10 | 0.4751 | 0.5178 | -0.0427 | 0.0005 | 0.1691 | +| 2023-11-15 | 16 | 0.6064 | 0.5069 | 0.0995 | 10 | 0.4548 | 0.4947 | -0.0399 | 0.0122 | 0.1394 | +| 2023-12-20 | 16 | 0.5716 | 0.4754 | 0.0962 | 10 | 0.426 | 0.4734 | -0.0474 | 0.002 | 0.1436 | +| 2024-01-17 | 16 | 0.5224 | 0.4248 | 0.0976 | 10 | 0.4372 | 0.4372 | 0 | -0.0124 | 0.0976 | +| 2024-02-14 | 16 | 0.494 | 0.4228 | 0.0712 | 10 | 0.4136 | 0.4258 | -0.0122 | -0.003 | 0.0834 | +| 2024-03-20 | 16 | 0.4533 | 0.4008 | 0.0525 | 10 | 0.4665 | 0.4162 | 0.0503 | -0.0154 | 0.0022 | + +#### chart_skew() + +As a default state, the put and call skew smiles from the expiration in position 1, contained in the list `data.expirations[1]`, are displayed. + +`data.chart_skew()` + +![VIX IV Skew](https://github.com/deeleeramone/OpenBBTerminal/assets/85772166/509ac801-85bc-41e9-9f6c-7654e471db77) + +Multiple expirations can be displayed by entering a list to the `expirations` parameter. + +`data.chart_skew(expirations=[data.expirations[6],data.expirations[10]])` + +![Multiple Expirations - VIX IV Skew](https://github.com/deeleeramone/OpenBBTerminal/assets/85772166/604407aa-bb0a-44dd-8051-0665ddb90b96) + +The forward curve is also callable by strike. + +`data.chart_skew(strike = 20)` + +![VIX IV Skew at $20 Strike](https://github.com/deeleeramone/OpenBBTerminal/assets/85772166/949674b9-7366-4beb-b278-2ee5c0d5dd71) diff --git a/website/content/sdk/data-available/stocks/options.md b/website/content/sdk/data-available/stocks/options.md new file mode 100644 index 000000000000..053b4ce53b66 --- /dev/null +++ b/website/content/sdk/data-available/stocks/options.md @@ -0,0 +1,121 @@ +--- +title: Options +description: This documentation page explains how to use the Options module in the + OpenBB SDK that allows programmatic access to trading data. It covers a range of + functions that correspond to many aspects of stock option data, from Unusual Options + Activity to Put-Call Ratios. +keywords: +- Options Module +- OpenBB SDK +- Trading Data +- Stock Option Data +- Unusual Options Activity +- Put-Call Ratios +- Programmatic Access +- Terminal Commands +- Data Processing +- Documentation +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +The Options module wraps the Terminal commands for the SDK layer, providing programmatic access and greater flexibility for processing data. + +## How to Use + +The functions in the Options sub-module are listed below, along with a short description. + +|Path |Description | +|:----|-----------:| +|stocks.options.pcr| Put-Call Ratio | +|stocks.options.info| Option Information | +|stocks.options.unu| Unusual Options Activity| +|stocks.options.hist|Historical Option Data| +|stocks.options.chains | Option Chain Data| +||stocks.options.eodchain | Get End of Day Option Chain Data| +|stocks.options.vol| Display Volume plot| +|stocks.options.oi| Display open interest plot| +|stocks.options.voi| Display plot of volume and open interest| +|stocks.options.expirations| Get Option Expirations| +|stocks.options.vsurf|Show volatility surface| + +Alternatively, the contents of the menu or a function's docstrings can be printed using Python's built-in help. + +```python +help(openbb.stocks.options) +``` + +## Examples + +### Import Statements + +The examples in this section will assume these statements are included at the top of the file: + +```python +from openbb_terminal.sdk import openbb +import pandas as pd +``` + +### Unusual Options + +`openbb.stocks.options.unu` returns a DataFrame with the current day's unusual options, those having a very high volume/open interest ratio. This function returns a Tuple containing the DataFrame and a string. Unpack it like this: + +```python +unu_df,unu_ts = openbb.stocks.options.unu(limit = 500) +unu_df = unu_df.sort_values(by = 'Vol/OI', ascending = False) + +unu_df +``` + +| | Ticker | Exp | Strike | Type | Vol/OI | Vol | OI | Bid | Ask | +|---:|:---------|:-----------|---------:|:-------|---------:|-------:|-----:|------:|------:| +| 0 | T | 2023-01-06 | 21 | Call | 61 | 8598 | 141 | 0.03 | 0.04 | +| 1 | T | 2023-01-06 | 19 | Put | 40.7 | 10173 | 250 | 0.39 | 0.42 | +| 2 | SCHW | 2023-03-17 | 87.5 | Call | 35.1 | 4317 | 123 | 3.2 | 3.35 | +| 3 | TSLA | 2022-12-02 | 192.5 | Put | 31.1 | 179688 | 5774 | 0.01 | 0.02 | +| 4 | FDX | 2022-12-09 | 190 | Call | 29.2 | 7098 | 243 | 0.67 | 0.69 | +| 403 | FCX | 2022-12-09 | 36 | Put | 2.1 | 1513 | 729 | 0.04 | 0.06 | +| 402 | CAT | 2022-12-09 | 227.5 | Put | 2.1 | 601 | 280 | 0.94 | 1.14 | +| 401 | NKE | 2022-12-02 | 111 | Put | 2.1 | 651 | 306 | 0 | 0.01 | +| 400 | NVDA | 2022-12-09 | 160 | Put | 2.1 | 8668 | 4059 | 1.06 | 1.08 | +| 425 | PG | 2022-12-09 | 149 | Put | 2.1 | 241 | 113 | 0.64 | 0.69 | + +### PCR + +Get up to ten years of historical Put-Call Ratios. + +```python +openbb.stocks.options.pcr(start_date = '2012-01-01', window = 10, symbol = 'SPY') +``` + +| Date | PCR | +|:--------------------|-------:| +| 2012-12-05 00:00:00 | 1.1815 | +| 2012-12-06 00:00:00 | 1.7403 | +| 2012-12-07 00:00:00 | 1.7023 | +| 2012-12-10 00:00:00 | 1.8997 | +| 2012-12-11 00:00:00 | 1.5384 | +| 2022-11-28 00:00:00 | 1.2491 | +| 2022-11-29 00:00:00 | 2.135 | +| 2022-11-30 00:00:00 | 1.5901 | +| 2022-12-01 00:00:00 | 0.9842 | +| 2022-12-02 00:00:00 | 2.1346 | + +### Chains + +Get the current option chain for a selected ticker. We support the following sources: YahooFinance, Nasdaq, +Tradier (Sandbox) and Intrinio. Note that each API returns slightly different data fields. + +```python +openbb.stocks.options.chains(symbol = 'SPY') +``` + +| | contractSymbol | optionType | expiration | strike | lastPrice | bid | ask | openInterest | volume | impliedVolatility | +|---:|:--------------------|:-------------|:-------------|---------:|------------:|-------:|-------:|---------------:|---------:|--------------------:| +| 0 | AAPL230210C00050000 | call | 2023-02-10 | 50 | 101.95 | 101.15 | 102.8 | 153 | 44 | 4.73438 | +| 1 | AAPL230210C00055000 | call | 2023-02-10 | 55 | 96.6 | 96.15 | 97.85 | 81 | 3 | 4.53125 | +| 2 | AAPL230210C00070000 | call | 2023-02-10 | 70 | 76.39 | 81.1 | 82.95 | 0 | 1 | 3.63281 | +| 3 | AAPL230210C00075000 | call | 2023-02-10 | 75 | 79.45 | 76.1 | 78.05 | 2 | 1 | 3.50781 | +| 4 | AAPL230210C00080000 | call | 2023-02-10 | 80 | 72.55 | 71.1 | 73.05 | 2 | 2 | 3.21094 | diff --git a/website/content/sdk/data-available/stocks/stocks-screener.md b/website/content/sdk/data-available/stocks/stocks-screener.md new file mode 100644 index 000000000000..36e4e37c830d --- /dev/null +++ b/website/content/sdk/data-available/stocks/stocks-screener.md @@ -0,0 +1,366 @@ +--- +title: Stocks Screener +description: This documentation page describes the stock screener module which allows the user to utilize presets (.ini files) to scan for stocks meeting the defined criteria. +keywords: +- screener +- stocks screener +- criteria +- presets +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +The Stocks Screener module imports the same screener found in the OpenBB Terminal. The screener utilizes presets (.ini files) to scan for stocks meeting the defined criteria. User-generated files are kept in the `stocks/screener` folder within the [OpenBBUserData](/sdk/usage/data/custom-data) folder. + +This screener can find stocks on three exchanges: + +- AMEX +- NASDAQ +- NYSE + +The data returned is grouped into six categories: + +- Overview +- Financial +- Ownership +- Performance +- Technical +- Valuation + +The default preset is, `top_gainers`, and the default data type is, `overview`. Without the use of arguments, the screener will return results using those default values. + +```python +openbb.stocks.screener.screener_data() +``` + +This preset, like some of the others, contain no parameters other than a signal - the name of the preset - and has no corresponding file which can be edited. All signals are listed in the table below. + +| Preset and Signal Name | Description | +| :--------------------- | --------------------------------------------------------------------------: | +| top_gainers | stocks with the highest % price gain today | +| top_losers | stocks with the highest % price loss today | +| new_high | stocks making 52-week high today | +| new_low | stocks making 52-week low today | +| most_volatile | stocks with the highest widest high/low trading range today | +| most_active | stocks with the highest trading volume today | +| unusual_volume | stocks with unusually high volume today - the highest relative volume ratio | +| overbought | stock is becoming overvalued and may experience a pullback. | +| oversold | oversold stocks may represent a buying opportunity for investors | +| downgrades | stocks downgraded by analysts today | +| upgrades | stocks upgraded by analysts today | +| earnings_before | companies reporting earnings today, before market open | +| earnings_after | companies reporting earnings today, after market close | +| recent_insider_buying | stocks with recent insider buying activity | +| recent_insider_selling | stocks with recent insider selling activity | +| major_news | stocks with the highest news coverage today | +| horizontal_sr | horizontal channel of price range between support and resistance trendlines | +| tl_resistance | once a rising trendline is broken | +| tl_support | once a falling trendline is broken | +| wedge_up | upward trendline support and upward trendline resistance (reversal) | +| wedge_down | downward trendline support and downward trendline resistance (reversal) | +| wedge | upward trendline support, downward trendline resistance (contiunation) | +| triangle_ascending | upward trendline support and horizontal trendline resistance | +| triangle_descending | horizontal trendline support and downward trendline resistance | +| channel_up | both support and resistance trendlines slope upward | +| channel_down | both support and resistance trendlines slope downward | +| channel | both support and resistance trendlines are horizontal | +| double_top | stock with 'M' shape that indicates a bearish reversal in trend | +| double_bottom | stock with 'W' shape that indicates a bullish reversal in trend | +| multiple_top | same as double_top hitting more highs | +| multiple_bottom | same as double_bottom hitting more lows | +| head_shoulders | chart formation that predicts a bullish-to-bearish trend reversal | +| head_shoulders_inverse | chart formation that predicts a bearish-to-bullish trend reversal | + +These signals offer a good starting point, and results can be narrowed by creating a custom preset with defined parameters. + +## How to Use + +:::note + +Refer to the template file [here](https://github.com/OpenBB-finance/OpenBBTerminal/files/11153280/all_parameters.txt) for all of the available parameters and accepted values. + +All of the included presets can be viewed online [here](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/miscellaneous/stocks/screener) +::: + +Without any parameters, a screener preset file must contain the following at a minimum: + +```console +# Author of preset: +# Description: + +[General] + +[Descriptive] + +[Fundamental] + +[Technical] +``` + +Parameters should be added as required, and they all have pre-defined values; for example, Price/Free Cash Flow: + +```console +# Any, Low (<15), High (>50), Under 5, Under 10, Under 15, Under 20, Under 25, Under 30, Under 35, +# Under 40, Under 45, Under 50, Under 60, Under 70, Under 80, Under 90, Under 100, Over 5, Over 10, +# Over 15, Over 20, Over 25, Over 30, Over 35, Over 40, Over 45, Over 50, Over 60, Over 70, Over 80, +# Over 90, Over 100 + +Price/Free Cash Flow = Any +``` + +## Examples + +### List All Presets + +The name of each available preset and the local path to the file can be imported as a dictionary. + +```python +from openbb_terminal.stocks.screener.finviz_model import preset_choices + +preset choices +``` + +Print only the name of each preset as a list: + +```python +list(preset_choices) +``` + +### Creating a Preset + +To make a screener with only a few filters, it should look something like this: + +```console +# Author of preset: OpenBB +# Description: SDK Demo Screener + +[General] +Order = Relative Volume +Signal = Major News + +[Descriptive] +Average Volume = Over 500K +Price = Over $5 + +[Fundamental] +Price/Free Cash Flow = Low (<15) + +[Technical] +Beta = Under 1 +``` + +Copy the block above to a new text file in any editor, and save the file to the [OpenBBUserData](/terminal/usage/data/custom-data) folder, naming it something like, `sdk_guide_preset.ini`. **This preset has also been included with the installation**. Declaring the path to the preset file, when located in the OpenBBUserData folder, is not required. The kernel must be restarted when a file is renamed or created; however, changes to the preset itself will be reflected immediately and without restarting. + +It is a good idea to test choices made before making it too complicated. Start with a handful of filters and modify, or add, them one-at-a-time. Let's pass what we have so far through the screener with `performance` selected as the `data_type`. + +### Performance + +```python +openbb.stocks.screener.screener_data(preset_loaded='sdk_guide_preset', data_type = 'performance') +``` + +| | Ticker | Perf Week | Perf Month | Perf Quart | Perf Half | Perf Year | Perf YTD | Volatility W | Volatility M | Recom | Avg Volume | Rel Volume | Price | Change | Volume | +| -: | :----- | --------: | ---------: | ---------: | --------: | --------: | -------: | -----------: | -----------: | ----: | ---------: | ---------: | -----: | ------: | ----------: | +| 0 | GEO | 0.1389 | 0.4005 | 0.4589 | 0.6723 | 0.3955 | 0.5342 | 0.0574 | 0.0558 | 2.5 | 2.09e+06 | 4.23 | 11.89 | 0.1623 | 8.86013e+06 | +| 1 | EBS | -0.0059 | -0.4513 | -0.5136 | -0.6429 | -0.7204 | -0.7292 | 0.0452 | 0.0827 | 2.7 | 753610 | 2.91 | 11.77 | 0.0138 | 2.19107e+06 | +| 2 | TME | 0.1871 | 0.7984 | 0.3721 | 0.5789 | -0.0531 | -0.0365 | 0.0681 | 0.0756 | 2.3 | 9.95e+06 | 2.2 | 6.6 | 0.0611 | 2.18486e+07 | +| 3 | QFIN | 0.0874 | 0.4331 | -0.0738 | -0.0744 | -0.389 | -0.365 | 0.0472 | 0.0787 | 1.4 | 997070 | 1.62 | 14.56 | 0.0849 | 1.61386e+06 | +| 4 | ATHM | 0.0229 | 0.0391 | -0.1772 | -0.2256 | -0.1971 | -0.0455 | 0.0492 | 0.0579 | 2.2 | 577050 | 1.6 | 28.14 | 0.0484 | 922812 | +| 93 | TGNA | 0.0093 | -0.0514 | -0.0882 | -0.1073 | -0.0528 | 0.0533 | 0.0133 | 0.0286 | 2.3 | 1.38e+06 | 0.45 | 19.55 | 0.0046 | 620767 | +| 94 | AMN | 0.0096 | -0.0365 | 0.1685 | 0.2591 | 0.0558 | -0.0026 | 0.0243 | 0.0464 | 1.7 | 607420 | 0.43 | 122.01 | -0.0078 | 264138 | +| 95 | MCY | -0.0028 | 0.2416 | 0.1165 | -0.2619 | -0.3014 | -0.3191 | 0.0206 | 0.0386 | 2 | 565130 | 0.43 | 36.13 | 0.0036 | 241950 | +| 96 | FIBK | -0.0138 | -0.0355 | 0.079 | 0.1411 | 0.0616 | 0.0681 | 0.0168 | 0.0206 | 2.2 | 596280 | 0.41 | 43.44 | -0.0044 | 243947 | +| 97 | BPOP | 0.0217 | 0.0126 | -0.0777 | -0.1245 | -0.1108 | -0.128 | 0.0158 | 0.0236 | 2 | 596460 | 0.4 | 71.54 | 0.0007 | 238605 | + +It found just under 100 tickers meeting the criteria. Let's dial down the beta value to see how many remain at less than 0.5. + +Change the one argument: + +```console +[Technical] +Beta = Under 0.5 +``` + +Running the exact same command as before trims down the list to only eleven. + +```python +openbb.stocks.screener.screener_data(preset_loaded='sdk_guide_preset', data_type = 'performance') +``` + +| | Ticker | Perf Week | Perf Month | Perf Quart | Perf Half | Perf Year | Perf YTD | Volatility W | Volatility M | Recom | Avg Volume | Rel Volume | Price | Change | Volume | +| -: | :----- | --------: | ---------: | ---------: | --------: | --------: | -------: | -----------: | -----------: | ----: | ---------: | ---------: | -----: | ------: | ----------: | +| 0 | QFIN | 0.0874 | 0.4331 | -0.0738 | -0.0744 | -0.389 | -0.365 | 0.0472 | 0.0787 | 1.4 | 997070 | 1.62 | 14.56 | 0.0849 | 1.61386e+06 | +| 1 | ATHM | 0.0229 | 0.0391 | -0.1772 | -0.2256 | -0.1971 | -0.0455 | 0.0492 | 0.0579 | 2.2 | 577050 | 1.6 | 28.14 | 0.0484 | 922812 | +| 2 | JD | 0.0143 | 0.4065 | -0.1343 | -0.0511 | -0.379 | -0.2209 | 0.029 | 0.0454 | 1.8 | 9.14e+06 | 1.47 | 53.25 | 0.0669 | 1.34395e+07 | +| 3 | NI | 0.0256 | 0.0518 | -0.0844 | -0.1342 | 0.0784 | -0.0138 | 0.0151 | 0.0257 | 1.9 | 4.61e+06 | 1.36 | 27.23 | 0.0004 | 6.2667e+06 | +| 4 | ZTO | 0.1176 | 0.3862 | -0.0572 | -0.1073 | -0.216 | -0.1393 | 0.0447 | 0.0437 | 1.7 | 3.21e+06 | 0.96 | 24.05 | 0.0217 | 3.06905e+06 | +| 5 | QDEL | -0.058 | -0.0614 | 0.077 | -0.1232 | -0.4438 | -0.3828 | 0.0335 | 0.0408 | 2.3 | 642680 | 0.79 | 83.32 | -0.018 | 508575 | +| 6 | ED | 0.0228 | 0.0888 | -0.0203 | -0.0298 | 0.1985 | 0.1287 | 0.0149 | 0.0202 | 3.5 | 1.73e+06 | 0.77 | 96.3 | -0.0025 | 1.3419e+06 | +| 7 | SFM | 0.027 | 0.1279 | 0.1656 | 0.237 | 0.237 | 0.129 | 0.0249 | 0.034 | 3.2 | 1.54e+06 | 0.74 | 33.51 | -0.0095 | 1.14442e+06 | +| 8 | PINC | 0.0244 | -0.0549 | -0.0635 | -0.1125 | -0.1377 | -0.1936 | 0.0158 | 0.0217 | 2.6 | 519290 | 0.72 | 33.2 | 0.0097 | 373171 | +| 9 | AEP | 0.0161 | 0.0587 | -0.066 | -0.0723 | 0.1361 | 0.0638 | 0.018 | 0.022 | 2.2 | 3.19e+06 | 0.64 | 94.65 | -0.006 | 2.04444e+06 | +| 10 | LRN | -0.0025 | 0.0796 | -0.0594 | -0.0846 | 0.0398 | 0.0741 | 0.0207 | 0.0288 | 1.4 | 587770 | 0.46 | 35.8 | -0.0047 | 270842 | +| 11 | AMN | 0.0096 | -0.0365 | 0.1685 | 0.2591 | 0.0558 | -0.0026 | 0.0243 | 0.0464 | 1.7 | 607420 | 0.43 | 122.01 | -0.0078 | 264138 | + +### Overview + +We know know that these eleven companies have a beta relative to the S&P of under 0.5, and that they all have a price-to-free-cashflow ratio under 15. The `signal` argument has also been set as `Major News`, so we know at least this much about the companies and their relative performance over the last year. Setting the `data_type` to 'overview', will fetch the data which helps us understand who these companies are. + +```python +openbb.stocks.screener.screener_data(preset_loaded='sdk_guide_preset', data_type = 'overview') +``` + +| | Ticker | Company | Sector | Industry | Country | Market Cap | P/E | Price | Change | Volume | +| -: | :----- | :------------------------------------ | :--------------------- | :----------------------------- | :------ | ---------: | -----: | -----: | ------: | ----------: | +| 0 | QFIN | 360 DigiTech, Inc. | Financial | Credit Services | China | 2.19e+09 | 3.73 | 14.56 | 0.0849 | 1.61386e+06 | +| 1 | ATHM | Autohome Inc. | Communication Services | Internet Content & Information | China | 3.49e+09 | 16.96 | 28.14 | 0.0484 | 922812 | +| 2 | JD | JD.com, Inc. | Consumer Cyclical | Internet Retail | China | 8.152e+10 | 300.85 | 53.25 | 0.0669 | 1.34395e+07 | +| 3 | NI | NiSource Inc. | Utilities | Utilities - Regulated Gas | USA | 1.09e+10 | 17.69 | 27.23 | 0.0004 | 6.2667e+06 | +| 4 | ZTO | ZTO Express (Cayman) Inc. | Industrials | Integrated Freight & Logistics | China | 1.947e+10 | 24.67 | 24.05 | 0.0217 | 3.06905e+06 | +| 5 | QDEL | QuidelOrtho Corporation | Healthcare | Diagnostics & Research | USA | 5.53e+09 | 4.96 | 83.32 | -0.018 | 508575 | +| 6 | ED | Consolidated Edison, Inc. | Utilities | Utilities - Regulated Electric | USA | 3.366e+10 | 20.21 | 96.3 | -0.0025 | 1.3419e+06 | +| 7 | SFM | Sprouts Farmers Market, Inc. | Consumer Defensive | Grocery Stores | USA | 3.57e+09 | 14.67 | 33.51 | -0.0095 | 1.14442e+06 | +| 8 | PINC | Premier, Inc. | Healthcare | Health Information Services | USA | 3.92e+09 | 21.52 | 33.2 | 0.0097 | 373171 | +| 9 | AEP | American Electric Power Company, Inc. | Utilities | Utilities - Regulated Electric | USA | 4.791e+10 | 19.63 | 94.65 | -0.006 | 2.04444e+06 | +| 10 | LRN | Stride, Inc. | Consumer Defensive | Education & Training Services | USA | 1.54e+09 | 16.74 | 35.8 | -0.0047 | 270842 | +| 11 | AMN | AMN Healthcare Services, Inc. | Healthcare | Medical Care Facilities | USA | 5.4e+09 | 11.76 | 122.01 | -0.0078 | 264138 | + +### Ownership + +When `data_type = 'ownership'`, data presented are statistics for the general float, insider, institutional, and the short ratio. + +```python +openbb.stocks.screener.screener_data(preset_loaded='sdk_guide_preset', data_type = 'ownership') +``` + +| | Ticker | Market Cap | Outstanding | Float | Insider Own | Insider Trans | Inst Own | Inst Trans | Float Short | Short Ratio | Avg Volume | Price | Change | Volume | +| -: | :----- | ---------: | ----------: | ---------: | ----------: | ------------: | -------: | ---------: | ----------: | ----------: | ---------: | -----: | ------: | ----------: | +| 0 | QFIN | 2.19e+09 | 1.5624e+08 | 1.2743e+08 | 0.0654 | 0 | 0.691 | 0.0034 | 0.0226 | 2.89 | 997070 | 14.56 | 0.0849 | 1.61386e+06 | +| 1 | ATHM | 3.49e+09 | 1.246e+08 | 6.846e+07 | nan | nan | 0.513 | -0.0397 | 0.0213 | 2.53 | 577050 | 28.14 | 0.0484 | 922812 | +| 2 | JD | 8.152e+10 | 1.56e+09 | 1.26e+09 | 0.049 | 0 | 0.161 | -0.1149 | 0.0136 | 1.88 | 9.14e+06 | 53.25 | 0.0669 | 1.34395e+07 | +| 3 | NI | 1.09e+10 | 4.065e+08 | 4.0459e+08 | 0.001 | 0 | 0.948 | -0.0254 | 0.0345 | 3.04 | 4.61e+06 | 27.23 | 0.0004 | 6.2667e+06 | +| 4 | ZTO | 1.947e+10 | 8.0973e+08 | 6.4491e+08 | 0.0071 | 0 | 0.315 | 0.0345 | 0.0241 | 4.83 | 3.21e+06 | 24.05 | 0.0217 | 3.06905e+06 | +| 5 | QDEL | 5.53e+09 | 6.69e+07 | 6.092e+07 | 0.011 | 0 | 0.973 | 0.0058 | 0.0515 | 4.88 | 642680 | 83.32 | -0.018 | 508575 | +| 6 | ED | 3.366e+10 | 3.546e+08 | 3.5443e+08 | 0.001 | 0.0056 | 0.684 | 0.0082 | 0.0206 | 4.22 | 1.73e+06 | 96.3 | -0.0025 | 1.3419e+06 | +| 7 | SFM | 3.57e+09 | 1.0723e+08 | 1.0362e+08 | 0.008 | -0.1276 | nan | -0.0287 | 0.1386 | 9.31 | 1.54e+06 | 33.51 | -0.0095 | 1.14442e+06 | +| 8 | PINC | 3.92e+09 | 1.1835e+08 | 1.1817e+08 | 0.008 | 0 | 0.707 | -0.0044 | 0.0136 | 3.1 | 519290 | 33.2 | 0.0097 | 373171 | +| 9 | AEP | 4.791e+10 | 5.1373e+08 | 5.137e+08 | 0.0003 | -0.0336 | 0.758 | 0.0033 | 0.0129 | 2.07 | 3.19e+06 | 94.65 | -0.006 | 2.04444e+06 | +| 10 | LRN | 1.54e+09 | 4.208e+07 | 4.082e+07 | 0.04 | 0 | nan | 0.0158 | 0.0808 | 5.61 | 587770 | 35.8 | -0.0047 | 270842 | +| 11 | AMN | 5.4e+09 | 4.378e+07 | 4.299e+07 | 0.003 | -0.0868 | nan | 0.0148 | 0.0983 | 6.96 | 607420 | 122.01 | -0.0078 | 264138 | + +### Technical + +With `data_type` set to `technical`, aspects of technical analysis is returned. + +```python +openbb.stocks.screener.screener_data(preset_loaded='sdk_guide_preset', data_type = 'technical') +``` + +| | Ticker | Beta | ATR | SMA20 | SMA50 | SMA200 | 52W High | 52W Low | RSI | Price | Change | from Open | Gap | Volume | +| -: | :----- | ----: | ---: | ------: | ------: | ------: | -------: | ------: | ----: | -----: | ------: | --------: | ------: | ----------: | +| 0 | QFIN | 0.37 | 1.11 | 0.1061 | 0.1107 | -0.0206 | -0.3953 | 0.5375 | 56.6 | 14.56 | 0.0849 | 0.0341 | 0.0492 | 1.61386e+06 | +| 1 | ATHM | 0.19 | 1.89 | -0.0324 | -0.0405 | -0.1047 | -0.3118 | 0.3734 | 47.13 | 28.14 | 0.0484 | 0.0057 | 0.0425 | 922812 | +| 2 | JD | 0.39 | 3.3 | 0.1141 | 0.1183 | -0.0584 | -0.386 | 0.6054 | 58.07 | 53.25 | 0.0669 | -0.0039 | 0.0711 | 1.34395e+07 | +| 3 | NI | 0.44 | 0.62 | 0.049 | 0.0498 | -0.0598 | -0.1643 | 0.1451 | 61.62 | 27.23 | 0.0004 | 0.0052 | -0.0048 | 6.2667e+06 | +| 4 | ZTO | -0.09 | 1.14 | 0.1724 | 0.0968 | -0.0412 | -0.2565 | 0.4782 | 65.44 | 24.05 | 0.0217 | 0.0021 | 0.0195 | 3.06905e+06 | +| 5 | QDEL | 0.29 | 3.46 | -0.0666 | 0.0262 | -0.1185 | -0.5373 | 0.2458 | 42.18 | 83.32 | -0.018 | -0.018 | 0 | 508575 | +| 6 | ED | 0.32 | 1.83 | 0.0574 | 0.0843 | 0.0365 | -0.0578 | 0.2426 | 66.88 | 96.3 | -0.0025 | 0.002 | -0.0045 | 1.3419e+06 | +| 7 | SFM | 0.41 | 1.12 | 0.0584 | 0.1446 | 0.1605 | -0.0518 | 0.4854 | 63.99 | 33.51 | -0.0095 | -0.0053 | -0.0041 | 1.14442e+06 | +| 8 | PINC | 0.36 | 0.7 | 0.0322 | -0.0004 | -0.0711 | -0.2042 | 0.0773 | 55.19 | 33.2 | 0.0097 | 0.0125 | -0.0027 | 373171 | +| 9 | AEP | 0.41 | 2.07 | 0.0456 | 0.0559 | -0.0117 | -0.1037 | 0.1799 | 61.62 | 94.65 | -0.006 | 0.0005 | -0.0065 | 2.04444e+06 | +| 10 | LRN | 0.25 | 1.36 | 0.0302 | -0.0923 | -0.0562 | -0.2439 | 0.3957 | 44.85 | 35.8 | -0.0047 | -0.0014 | -0.0033 | 270842 | +| 11 | AMN | 0.3 | 4.85 | 0.011 | 0.0599 | 0.1431 | -0.0551 | 0.4744 | 54.13 | 122.01 | -0.0078 | -0.0059 | -0.0019 | 264138 | + +### Valuation + +Lastly, `valuation` gets the basic fundamental ratios. + +| | Ticker | Price | Change | Volume | Market Cap | P/E | Fwd P/E | PEG | P/S | P/B | P/C | P/FCF | EPS this Y | EPS next Y | EPS past 5Y | EPS next 5Y | Sales past 5Y | +| -----------: | :----- | -----: | ------: | -------: | ----------: | ----: | ------: | ---: | ---: | ----: | :---- | :---- | ---------: | ---------: | ----------: | ----------: | :------------ | +| 0 | AAPL | 141.17 | -0.0211 | 83578852 | 2.23252e+12 | 23.14 | 20.74 | 2.6 | 5.66 | 44.67 | 46.22 | 23.11 | 0.089 | 0.0898 | 0.216 | 0.0889 | 0.115 | +| 1 | MSFT | 240.33 | -0.0059 | 17929705 | 1.77308e+12 | 25.9 | 21.49 | 1.99 | 8.73 | 10.32 | 16.53 | 39.59 | 0.198 | 0.1709 | 0.243 | 0.1301 | 0.155 | +| 2 | GOOG | 95.44 | -0.0084 | 20145081 | 1.23434e+12 | 18.68 | 18.04 | 2.09 | 4.38 | 4.88 | N/A | N/A | -0.159 | 0.121 | 0.2848 | 0.0895 | N/A | +| 3 | GOOGL | 95.19 | -0.009 | 20047848 | 1.21605e+12 | 19.51 | 18.12 | 2.18 | 4.31 | 4.89 | 10.46 | 19.44 | 0.914 | 0.1139 | 0.321 | 0.0895 | 0.233 | +| 4 | AMZN | 92.42 | -0.0163 | 65245723 | 9.3352e+11 | 85.26 | 55.08 | 3.28 | 1.86 | 6.85 | 15.91 | N/A | 0.549 | 0.8239 | 0.676 | 0.26 | 0.281 | +| ...continued | | | | | | | | | | | | | | | | | | + +Combined, the five DataFrames provide an outline of who they are, which segment of the market they belong to, and how they are currently trading. + +### Unconventional Applications + +One way to use the screener is to feed it the least amount of variables possible. In this next example, the preset file contains only one filter; requesting data for all constituents of the S&P 500 Index. + +```console +# Author of preset: OpenBB +# Description: S&P Index + +[General] +Order = Market Cap. + +[Descriptive] +Index = S&P 500 + +[Fundamental] + +[Technical] +``` + +Copy and past the block above into any text editor; then save the file, as `sp500_filter.ini`, to the `~/OpenBBUserData/presets/stocks/screener` folder. The sample code below combines all five DataFrames for the entire S&P 500 into one, fifty-column, DataFrame. **It will likely take over two-minutes to collect the data.** + +```python +from openbb_terminal.sdk import openbb +import pandas as pd + +sp500_overview = openbb.stocks.screener.screener_data(preset_loaded='sp500_filter', data_type = 'overview') +sp500_ownership = openbb.stocks.screener.screener_data(preset_loaded='sp500_filter', data_type = 'ownership') +sp500_performance = openbb.stocks.screener.screener_data(preset_loaded='sp500_filter', data_type = 'performance') +sp500_technical = openbb.stocks.screener.screener_data(preset_loaded='sp500_filter', data_type = 'technical') +sp500_valuation = openbb.stocks.screener.screener_data(preset_loaded='sp500_filter', data_type = 'valuation') + +sp500_overview = sp500_overview.convert_dtypes() +sp500_ownership = sp500_ownership.convert_dtypes() +sp500_performance = sp500_performance.convert_dtypes() +sp500_technical = sp500_technical.convert_dtypes() +sp500_valuation = sp500_valuation.convert_dtypes() + +sp500_overview.drop(columns = ['P/E'], inplace = True) +sp500_overview.set_index(keys = ['Ticker', 'Price', 'Change', 'Volume'], inplace = True) +sp500_performance.drop(columns = ['Avg Volume', 'Price', 'Change', 'Volume'], inplace = True) +sp500_performance.set_index(keys = ['Ticker'], inplace = True) +sp500_ownership.drop(columns = ['Price', 'Change', 'Volume', 'Market Cap'], inplace = True) +sp500_ownership.set_index(keys = ['Ticker'], inplace = True) +sp500_technical.drop(columns = ['Price', 'Change', 'Volume'], inplace = True) +sp500_technical.set_index(keys = ['Ticker'], inplace = True) +sp500_valuation.drop(columns = ['Price', 'Change', 'Volume', 'Market Cap'], inplace = True) +sp500_valuation.set_index(keys = ['Ticker'], inplace = True) + +sp500_df = sp500_overview.join(sp500_valuation) +sp500_df = sp500_df.join(sp500_ownership) +sp500_df = sp500_df.join(sp500_performance) +sp500_df = sp500_df.join(sp500_technical) + +sp500_df.reset_index(inplace = True) + +sp500_df +``` + +A summary of the output: + +```console + Ticker Price Change Volume ... 52W Low RSI from Open Gap +0 AAPL 141.17 -0.0211 83578852 ... 0.094 42.47 -0.0211 0.0 +1 MSFT 240.33 -0.0059 17929705 ... 0.126 50.94 -0.0044 -0.0015 +2 GOOG 95.44 -0.0084 20145081 ... 0.1437 48.17 -0.0052 -0.0032 +3 GOOGL 95.19 -0.009 20047848 ... 0.1422 48.24 -0.0063 -0.0027 +4 AMZN 92.42 -0.0163 65245723 ... 0.0763 38.54 -0.0167 0.0004 +.. ... ... ... ... ... ... ... ... ... +498 LUMN 5.47 -0.0091 31885469 ... 0.0018 30.19 -0.0036 -0.0054 +499 PENN 34.07 0.0119 1689121 ... 0.3366 50.3 0.0068 0.005 +500 NWL 12.87 -0.0191 5725896 ... 0.051 40.29 -0.01 -0.0091 +501 VNO 25.31 0.0218 2560781 ... 0.2636 59.59 0.0181 0.0036 +502 PVH 64.88 0.0399 1100532 ... 0.4918 66.83 0.0328 0.0069 + +[503 rows x 50 columns] +``` diff --git a/website/content/sdk/data-available/stocks/trading-hours.md b/website/content/sdk/data-available/stocks/trading-hours.md new file mode 100644 index 000000000000..61e74fea4628 --- /dev/null +++ b/website/content/sdk/data-available/stocks/trading-hours.md @@ -0,0 +1,96 @@ +--- +title: Trading Hours +description: The Trading Hours sub-module provides functions for checking the status + and hours of operation for markets globally. It allows users to understand which + exchanges are currently open, all exchanges and their status, details for individual + exchanges, and a list of closed exchanges. +keywords: +- Trading Hours +- Market Status +- Stock Exchanges +- Open Exchanges +- Closed Exchanges +- Individual Exchange Details +- Global Markets +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +The Trading Hours sub-module is a set of functions for checking the status and hours of operation for markets globally. + +## How to Use + +There are only a handful of commands in the set, and they are listed below with a short description. + +|Path |Description | +|:-----|----------:| +|openbb.stocks.th.open | Which Exchanges are Currently Open | +|openbb.stocks.th.all | All Exchanges and Their Status | +|openbb.stocks.th.exchange | Details for Individual Exchanges | +|openbb.stocks.th.closed | List of Closed Exchanges | + +Alternatively, print the contents sub-module by entering: + +```python +help(openbb.stocks.th) +``` + +## Examples + +### All + +Get a list of global exchanges and their current status. + +```python +openbb.stocks.th.all() +``` + +| | name | short_name | open | +|:----|:-----------------------|:-------------|:-------| +| SHZ | Shenzen Stock Exchange | SHZE | False | +| KSC | Korea Exchange | KRX | False | +| KOE | Korea Exchange | KRX | False | +| CAI | The Egyptian Exchange | CA | False | +| PCX | NYSE Arca | ARCA | False | +| SAT | Nasdaq OMX Stockholm | ST | False | + +### Open + +See which exchanges are open right now. + +```python +openbb.stocks.th.open() +``` + +| | name | short_name | +|:----|:----------------------------------|:-------------| +| CNQ | Canadian Securities Exchange: CSE | CN | +| NZE | NZX | NZ | +| MCX | MOEX | ME | + +### Exchange + +Get the schedule of an individual exchange. + +```python +openbb.stocks.th.exchange('CNQ') +``` + +| | CNQ | +|:----------------------|:----------------------------------------------------------------------------------------| +| name | Canadian Securities Exchange: CSE | +| short_name | CN | +| website | https://www.thecse.com/en/trading/trading-rules-and-links/trading-rules-and-regulations | +| market_open | 08:00:00 | +| market_close | 18:00:00 | +| lunchbreak_start | | +| lunchbreak_end | | +| opening_auction_start | | +| opening_auction_end | | +| closing_auction_start | | +| closing_auction_end | | +| timezone | Canada/Eastern | +| flag | 🇨🇦 | +| open | True | diff --git a/website/content/sdk/data-available/ta.md b/website/content/sdk/data-available/ta.md new file mode 100644 index 000000000000..cca3da3063bc --- /dev/null +++ b/website/content/sdk/data-available/ta.md @@ -0,0 +1,219 @@ +--- +title: Technical Analysis +description: This documentation page provides a comprehensive guide on using the Technical + Analysis Module in Openbb, which is used for analyzing time-series data. It provides + detailed usage of functions within the ta module, demonstrating features such as + Momentum, Overlap, Trend, Volatility and Volume analysis plus many more techniques. + It also showcases how to display the chart, instead of raw data, and best practices + on using the module. +keywords: +- Technical Analysis +- time-series data +- pandas_ta library +- datascience +- Momentum +- Overlap +- Trend +- Volatility +- Volume +- Fibonacci +- charting +- ta module +- SMA +- EMA +- HMA +- WMA +- ZLMA +- Moving Average +- ATR +- Donchian +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +The Technical Analysis module is a toolkit for analyzing time-series data, at any resolution. The functions are a collection of formulas that fit into broad categories, and they are mostly derived from the pandas_ta library: + +- Momentum +- Overlap (Moving Averages) +- Trend +- Volatility +- Volume +- Other (Fibonacci) + +## How to Use + +Every SDK function also has a secondary `_chart` command. The table below is a brief description of each SDK function within the `ta` module; for simplicity, `_chart` has been omitted. Technical Analysis functions specific to stocks are included as a sub-module, `openbb.stocks.ta`. + +| Path | Category | Description | +| :----------------- | :--------: | ---------------------------------------------: | +| openbb.ta.ad | Volume | Accumulation/Distribution Line | +| openbb.ta.adosc | Volume | Chaikin Oscillator | +| openbb.ta.adx | Trend | Average Directional Movement Index | +| openbb.ta.aroon | Trend | Aroon Indicator | +| openbb.ta.atr | Volatility | Average True Range | +| openbb.ta.bbands | Voaltility | Bollinger Bands | +| openbb.ta.cci | Momentum | Commodity Channel Index | +| openbb.ta.cg | Momentum | Center of Gravity | +| openbb.ta.clenow | Momentum | Clenow Volatility Adjusted Momentum | +| openbb.ta.demark | Momentum | Tom Demark's Sequential Indicator (Unofficial) | +| openbb.ta.donchian | Volatility | Donchian Channels | +| openbb.ta.ema | Overlap | Exponential Moving Average | +| openbb.ta.fib | Other | Fibonacci Retracement | +| openbb.ta.fisher | Momentum | Fisher Transform | +| openbb.ta.hma | Overlap | Hull Moving Average | +| openbb.ta.kc | Volatility | Keltner Channels | +| openbb.ta.ma | Overlap | Moving Averages (For Charting) | +| openbb.ta.macd | Momentum | Moving Average Convergence/Divergence | +| openbb.ta.obv | Volume | On-Balance Volume | +| openbb.ta.rsi | Momentum | Relative Strength Index | +| openbb.ta.sma | Overlap | Simple Moving Average | +| openbb.ta.stoch | Momentum | Stochastic Oscillator | +| openbb.ta.vwap | Overlap | Volume-Weighted Average Price | +| openbb.ta.wma | Overlap | Weighted Moving Average | +| openbb.ta.zlma | Overlap | Zero-Lag Moving Average | + +The syntax for the data argument can be: + +- `data = ohlcv_df` + + Where functions only require a single column, `data = ohlcv_df['Adj Close']` + +- `data = openbb.stocks.load("ticker")` + + Target intraday by adding the `interval` argument to the `load` syntax. + +Best practice is to deploy the first method because the latter will work only with the commands requiring OHLC+V data as inputs. An error message will be returned if this is the case. + +```python +openbb.ta.obv(data = openbb.stocks.load('QQQ')) +``` + +| date | OBV | +| :------------------ | -----------: | +| 2019-11-15 00:00:00 | 1.84279e+07 | +| 2019-11-18 00:00:00 | 3.67938e+07 | +| 2019-11-19 00:00:00 | 5.37171e+07 | +| 2019-11-20 00:00:00 | 1.70881e+07 | +| 2022-11-15 00:00:00 | -1.09017e+08 | +| 2022-11-16 00:00:00 | -1.57876e+08 | +| 2022-11-17 00:00:00 | -2.13339e+08 | +| 2022-11-18 00:00:00 | -1.59987e+08 | + +The error message: + +```python +openbb.ta.rsi(data = openbb.stocks.load('QQQ')) +``` + +```console +Please send a series and not a DataFrame. +``` + +### _chart + +To display the chart, instead of raw data, add `_chart` to the syntax before the (`arguments`). + +```python +openbb.ta.obv_chart(data= openbb.stocks.load('QQQ', start_date = '2022-11-18', interval = 5, prepost = True)) +``` + +![openbb.ta.obv_chart](https://user-images.githubusercontent.com/85772166/202889106-4caa882b-5e29-41a8-8cd2-b2a2a01d1fca.png "openbb.ta.obv_chart") + +## Examples + +### Import Statements + +The examples here assume that this code block is at the top of the Python script of Notebook file: + +```python +import pandas as pd +from openbb_terminal.sdk import openbb +# %matplotlib inline (uncomment for Jupyter environments) +``` + +### MA (Moving Averages) + +The different types of moving averages, which also are individual functions (e.g., `openbb.ta.ema`), are available as an argument (`ma_type`) to the `ma` command. There are five accepted arguments, they are listed below in brackets: + +- Simple (SMA) +- Exponential (EMA) +- Hull (HMA) +- Weighted (WMA) +- Zero-Lag (ZLMA) + +The `window` argument anticipates a list of integers representing the interval (minutes, days, weeks, months, etc.) to measure against the timestamp of the DataFrame's index. The example below is a daily timeseries of S&P E-Mini Futures: + +```python +es = openbb.stocks.load("ES=F") + +openbb.ta.ma_chart( + data = es['Adj Close'], + symbol = 'E-Mini S&P Futures', + ma_type = 'SMA', + window = [21, 150]) +``` + +![openbb.ta.ma_chart](https://user-images.githubusercontent.com/85772166/202889200-c6a3e895-f49d-4348-8635-68dd1456340d.png "openbb.ta.ma_chart") + +Changing, `ma_type`, to, `ZLMA`: + +![openbb.ta.ma_chart](https://user-images.githubusercontent.com/85772166/202889214-359d5d37-f8c0-49e0-9dd9-70afe970ae5f.png "openbb.ta.ma_chart") + +### ATR (Average True Range) + +The `atr` command requires OHLC data, the data argument can be the `load` function. + +```python +ticker = 'ES=F' +start = '2000-01-01' + +df_atr = openbb.ta.atr(data = openbb.stocks.load(f"{ticker}", start_date = f"{start}", monthly = True), window = 6) + +df_atr.tail(5) +``` + +| date | ATRe_6 | +| :------------------ | ------: | +| 2022-07-01 00:00:00 | 454.457 | +| 2022-08-01 00:00:00 | 431.612 | +| 2022-09-01 00:00:00 | 469.08 | +| 2022-10-01 00:00:00 | 455.7 | +| 2022-11-01 00:00:00 | 424.5 | + +### Donchian + +To use the same data for multiple functions, it is more efficient to first load to a Pandas DataFrame: + +```python +ticker = 'ES=F' +start = '2000-01-01' +data_df: pd.DataFrame = openbb.stocks.load(f"{ticker}", start_date = f"{start}", monthly = True) + +openbb.ta.donchian_chart(data_df) +``` + +![openbb.ta.donchian_chart](https://user-images.githubusercontent.com/85772166/202889227-a985d788-a320-4193-af96-0357afe9a11d.png "openbb.ta.donchian_chart") + +The output from a function can be joined to the OHLC data: + +```python +ticker = 'ES=F' +start = '2000-01-01' +data_df: pd.DataFrame = openbb.stocks.load(f"{ticker}", start_date = f"{start}", monthly = True) + +donchian = openbb.ta.donchian(data_df) + +data_df = data_df.join(donchian) + +data_df.tail(5) +``` + +| date | Open | High | Low | Close | Adj Close | Volume | DCL_20_20 | DCM_20_20 | DCU_20_20 | +| :------------------ | ------: | ------: | ------: | -----: | --------: | ----------: | --------: | --------: | --------: | +| 2022-07-01 00:00:00 | 3782 | 4144 | 3723.75 | 4133.5 | 4133.5 | 3.40941e+07 | 3198 | 4003.12 | 4808.25 | +| 2022-08-01 00:00:00 | 4137.5 | 4327.5 | 3953 | 3956.5 | 3956.5 | 3.84732e+07 | 3225 | 4016.62 | 4808.25 | +| 2022-09-01 00:00:00 | 3958 | 4158 | 3595.25 | 3601.5 | 3601.5 | 4.68698e+07 | 3595.25 | 4201.75 | 4808.25 | +| 2022-10-01 00:00:00 | 3593.25 | 3924.25 | 3502 | 3883 | 3883 | 4.80686e+07 | 3502 | 4155.12 | 4808.25 | +| 2022-11-01 00:00:00 | 3884 | 4050.75 | 3704.25 | 3974 | 3974 | 2.65215e+07 | 3502 | 4155.12 | 4808.25 | diff --git a/website/content/sdk/faqs/_category_.json b/website/content/sdk/faqs/_category_.json new file mode 100644 index 000000000000..687f5482dac6 --- /dev/null +++ b/website/content/sdk/faqs/_category_.json @@ -0,0 +1,4 @@ +{ + "label": "FAQs", + "position": 5 +} diff --git a/website/content/sdk/faqs/bugs_support_feedback.md b/website/content/sdk/faqs/bugs_support_feedback.md new file mode 100644 index 000000000000..00ff14e55bed --- /dev/null +++ b/website/content/sdk/faqs/bugs_support_feedback.md @@ -0,0 +1,62 @@ +--- +title: Bugs, Support, and Feedback +sidebar_position: 6 +description: This page provides information on how to deal with bugs, get support, + and provide feedback for the OpenBB Terminal. It includes details on the release + process for patches, how to report a bug, and ways to request new features or provide + suggestions for improvements. +keywords: +- bug reporting +- support +- feedback +- patches +- GitHub +- open source platform +- investors +- feature request +- machine learning +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +## Bugs, Support, and Feedback + +When an error is encountered, it is always a good idea to check the open issues on [GitHub](https://github.com/OpenBB-finance/OpenBBTerminal/issues). There may be a workaround solution for the specific problem until a patch is released. + +
How often are patches for bugs released? + +The installer versions are packaged approximately every two-weeks. Those working with a cloned GitHub version can checkout the Develop branch to get the latest fixes and releases before they are pushed to the main branch. + +```console +git checkout develop +``` + +
+ +
How do I report a bug? + +First, search the open issues for another report. If one already exists, attach any relevant information and screenshots as a comment. If one does not exist, start one with this [link](https://github.com/OpenBB-finance/OpenBBTerminal/issues/new?assignees=&labels=type%3Abug&template=bug_report.md&title=%5BBug%5D) + +
+ +
How can I get help with OpenBB Terminal? + +You can get help with OpenBB Terminal by joining our [Discord server](https://openbb.co/discord) or contact us in our support form [here](https://openbb.co/support). + +
+ +
How can I give feedback about the OpenBB Terminal, or request specific functionality? + +Being an open source platform that wishes to tailor to the needs of any type of investor, we highly encourage anyone to share with us their experience and/or how we can further improve the OpenBB Terminal. This can be anything from a very small bug, a new feature, or the implementation of a highly advanced Machine Learning model. + +You are able to directly send us information about a bug or a question/suggestion from inside the terminal by using the `support` command which is available everywhere in the terminal. Here you can select which command you want to report a bug on, ask a question or make a suggestion. After entering `support`, when you press `ENTER` (⏎), you are taken to the Support form which is automatically filled with your input. You are only required to include the type (e.g. bug, suggestion or question) and message in the form, although this can also be set directly from inside the terminal (see `support -h`). + +Alternatively, you can contact us via the following routes: + +- If you notice that a feature is missing inside the terminal, please fill in the [Request a Feature](https://openbb.co/request-a-feature) form. +- If you wish to report a bug, have a question/suggestion or anything else, please fill in the [Support](https://openbb.co/support) form. +- If you wish to speak to us directly, please contact us on [Discord](https://openbb.co/discord). + +
diff --git a/website/content/sdk/faqs/data_sources.md b/website/content/sdk/faqs/data_sources.md new file mode 100644 index 000000000000..4dd246992233 --- /dev/null +++ b/website/content/sdk/faqs/data_sources.md @@ -0,0 +1,74 @@ +--- +title: Data and Sources +sidebar_position: 4 +description: OpenBB is a data aggregator that provides access to data from various + sources. It is important to understand how to load ticker symbols, end-of-day daily + data, and handle certain limitations like accessing the Binance API. Feature request + options are available for specific data source endpoints. +keywords: +- data aggregators +- data providers +- ticker symbols +- end-of-day daily data +- Binance API +- feature request +- live feeds +- load function +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + + +## Data and Sources + +Please note that OpenBB does not provide any data, it is an aggregator which provides users access to data from a variety of sources. OpenBB does not maintain or have any control over the raw data supplied. If there is a specific problem with the output from a data provider, please consider contacting them first. + +
Is there a list of all data providers? + +The complete list is found [here](/terminal/usage/data/api-keys) + +
+ +
How do I load a ticker symbol from India? + +Ticker symbols listed on exchanges outside of the US will have a suffix attached, for example, Rico Auto Industries Limited: + +```console +df = openbb.stocks.load("ricoauto.ns") +``` + +The precise naming convention will differ by source, reference each source's own documentation for specific details. + +
+ +
Data from today is missing. + +By default, the load function requests end-of-day daily data and is not included until the EOD summary has been published. The current day's data is considered intraday and is loaded when the `interval` argument is present. + +```console +df = openbb.stocks.load(SPY, interval = 60) +``` + +
+ +
Can I stream live prices and news feeds? + +It is not currently possible to stream live feeds with the OpenBB SDK. + +
+ +
"Pair BTC/USDT not found in binance" + +US-based users are currently unable to access the Binance API. Please try loading the pair from a different source, for example: + +`load btc --source CCXT --exchange kraken` + +
+ +
How can I request adding endpoints from a specific data source? + +Please [request a feature](https://openbb.co/request-a-feature) by submitting a new request. + +
diff --git a/website/content/sdk/faqs/developer_issues.md b/website/content/sdk/faqs/developer_issues.md new file mode 100644 index 000000000000..76a985aefb23 --- /dev/null +++ b/website/content/sdk/faqs/developer_issues.md @@ -0,0 +1,173 @@ +--- +title: Developer Issues +sidebar_position: 7 +description: A comprehensive troubleshooting guide for developers regarding common + issues such as launching in debug mode, dealing with GitHub pull requests, git pull + errors, missing 'wheel', non-existent .whl files, handling JSONDecodeError, correcting + CRLF errors, running OpenBB via VS Code integrated terminal, and more. +keywords: +- Developer Issues +- Debug mode +- GitHub pull requests +- git pull error +- wheel missing +- whl files +- JSONDecodeError +- CRLF error +- VS Code integrated terminal +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +## Developer Issues + +
How do I launch in debug mode? + +The PyWry window can be run in debug mode for identifying specific issues. Use the code block below - with the `obb` Python environment active - to import the OpenBB SDK in debug mode. + +```python +import os +from openbb_terminal.core.plots.backend import plots_backend + +os.environ["DEBUG_MODE"] = "True" +plots_backend().start(True) + +from openbb_terminal.sdk import openbb +``` + +The charts and tables will now include a developer tools button, located at the top-left of the window. + +
+ +
What branch on GitHub should pull requests be submitted to? + +Pull requests submitted to the Main branch will not be merged, please create branches from the `develop` branch. + +To switch to the develop branch: + +```console +git checkout develop +``` + +Branches must also follow the naming convention: + +- /feature/name_your_branch + - For developing functionality. +- /hotfix/name_your_patch + - For bug patches. + +
+ +
Error: "git pull" fails because of a hot fix: cannot lock ref + +If the error message looks something like: + +```console +cannot lock ref: 'refs/remotes/origin/hotfix' exists; cannot create +``` + +Try: + +```console +git remote prune origin +git pull +``` + +
+ +
What does it mean if it says wheel is missing? + +If you receive any notifications regarding `wheel` missing, this could be due to this dependency missing. + +`conda install -c conda-forge wheel` or `pip install wheel` + +
+ +
Why do these .whl files not exist? + +If you get errors about .whl files not existing (usually on Windows) you have to reinitialize the following folder. +Just removing the 'artifacts' folder could also be enough: + +| Platform | Location | +| -------- | ------------------------------- | +| Linux | "~/.cache/pypoetry" | +| Mac | "~/Library/Caches/pypoetry" | +| Windows | "%localappdata%/pypoetry/cache" | + +When you try to add a package to Poetry it is possible that it causes a similar issue. Here you can remove the +'artifacts' folder again to reinitialize Poetry. + +If you run into trouble with Poetry, and the advice above did not help, your best bet is to try + +- `poetry update --lock` +- `conda deactivate` -> `conda activate obb`, then try again +- Track down the offensive package and purge it from your anaconda `` folder, then try again + +| Platform | Location | +| --------- | ------------------------------------------- | +| Linux/Mac | ~/anaconda3/envs, or , ~/opt/anaconda3/envs | +| Windows | %userprofile%/anaconda3/envs | + +- Completely nuke your conda environment folder and make a new environment from scratch + + - `conda deactivate` + - `conda env remove -n obb` + - `conda clean -a` + - Make a new environment and install dependencies again. +- Reboot your computer and try again +- Submit a ticket on GitHub + +
+ +
What does the JSONDecodeError mean during poetry install? + +Sometimes poetry can throw a `JSONDecodeError` on random packages while running `poetry install`. This can be observed on macOS 10.14+ running python 3.8+. This is because of the use of an experimental installer that can be switched off to avoid the mentioned error. Run the code below as advised [here](https://github.com/python-poetry/poetry/issues/4210) and it should fix the installation process. + +```bash +poetry config experimental.new-installer false +``` + +_Commands that may help you in case of an error:_ + +- `python -m pip install --upgrade pip` +- `poetry update --lock` +- `poetry install` + +
+ +
How do I deal with errors regarding CRLF? + +When trying to commit code changes, pylint will prevent you from doing so if your line break settings are set to +CRLF (default for Windows). +This is because the entire package uses LF (default for Linux/Mac), and it is therefore +important that you change this setting to LF _before_ you make any changes to the code. + +It is possible that CRLF automatically turns back on, you can correct this with: + +```bash +git config --global core.autocrlf false +``` + +In case you already made coding adjustments, you have to reset your cache, and the changes you made to the code with +the following: + +```bash +git rm --cached -r . +git reset --hard +``` + +
+ +
Why can't I run OpenBB via the VS Code integrated terminal? + +This occurs when VS Code terminal python version/path is different from the terminal version. + +To fix it add this to vscode JSON settings ([ref](https://stackoverflow.com/questions/54582361/vscode-terminal-shows-incorrect-python-version-and-path-launching-terminal-from)): + +```bash + "terminal.integrated.inheritEnv": false, +``` + +
diff --git a/website/content/sdk/faqs/general_operation.md b/website/content/sdk/faqs/general_operation.md new file mode 100644 index 000000000000..38d88c316a14 --- /dev/null +++ b/website/content/sdk/faqs/general_operation.md @@ -0,0 +1,118 @@ +--- +title: General Operation +sidebar_position: 3 +description: A page providing comprehensive tutorial and help information on enabling + developer mode and resolving system-related issues on both Windows and MacOS for + OpenBB's software. +keywords: +- OpenBB software +- Developer mode +- System-related issues +- Windows +- MacOS +- Security policy +- Software troubleshooting +- Firewall & Network Protection +- OpenBB's tutorials +- Software installation +- Coding tools +- Terminal.app +- Visual Studio Code +- User manuals +- FAQs +- Instructions +- How-to guide +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Both Windows and MacOS provide a "developer mode", and enabling it may help to overcome system-related issues. + +**MacOS**: Go to the System Settings, and under the "Privacy and Security" tab, scroll to the bottom and select the option to "Allow applications downloaded from App Store and identified developers". Then, scroll up to click on, "Developer Tools", and add `Terminal.app` and `Visual Studio Code` (or the preferred code editor) to the list of applications allowed to run software locally that does not meet the system's security policy. + +**Windows**: Go to the Control Panel, and under the "Privacy & Security" tab, click on, "For developers". Under this menu, turn "Developer Mode" on. + +From the Windows Security menu, click on the Firewall & Network Protection tab, then click on "Allow an app through firewall". If the applications below are not allowed to communicate through Windows Defender Firewall, change the settings to allow. + +- BranchCache +- Hyper-V +- VcXsrv +- Windows Terminal + +
An example code block does not work. + +We try to keep example code up-to-date, but sometimes a specific example is left behind. Please submit a bug report and so that we are aware of the issue. Submit a bug report [here](https://openbb.co/support) + +
+ +
Why does a specific menu or command not exist? + +It could be that you are running an outdated version in which the menu or command is not yet available. Please check the [installation guide](https://my.openbb.co/app/sdk/installation) to download the most recent release. + +Do note that it is also possible that the menu or command has been deprecated. If this is oversight, please reach out to us [here](https://openbb.co/support). + +
+ +
What is the correct format for entering dates to function variables? + +Dates should be entered as a string variable, inside of quotation marks, formatted as `%Y-%m-%d` - YYYY-MM-DD. + +
+ +
Does the portfolio menu allow for dividends, interest, or other distributions? + +Currently, this is only possible by manually updating the portfolio file. + +
+ +
Why does my Portfolio file fail to load? + +This can be the result of a formatting error, check the file in a simple text editor to observe any abnormalities in the formatting; or, it could be a bug - check the [GitHub issues page](https://github.com/OpenBB-finance/OpenBBTerminal/issues) for similar errors. + +- Check that all the necessary column titles are present. +- Inspect the file to see if cells left blank have been filled unintentionally with 0 or NaN values. +- A particular asset may not be able to load data. Check for valid historical data from the Stocks menu. +- Format ticker symbols according to yFinance naming convention. +- All dates must be entered as YYYY-MM-DD. +- Transactions dated for today will fail to load historical data. +- MacOS users should attempt to avoid using the Numbers application as it has a habit of changing the formatting while saving. + +Files can be formatted as either `.csv` or `.xlsx` files, and the required column headers are: + +`[Date,Type,Ticker,Side,Price,Quantity,Fees,Investment,Currency,Sector,Industry,Country,Region]` + +See the guide [here](/sdk/data-available/portfolio/introduction) for more information. + +
+ +
How do I change the chart styles? + +Place style sheets in this folder: `OpenBBUserData/styles/user` + +To select the light themes: + +```python +from openbb_terminal.sdk import TerminalStyle +theme = TerminalStyle("light", "light", "light") +``` + +To select the dark themes: + +```python +from openbb_terminal.sdk import TerminalStyle +theme = TerminalStyle("dark", "dark", "dark") +``` + +
+ +
Where are the included stock screener presets located? + +The files are located in the folder with the code, under: + +`~/openbb_terminal/miscellaneous/stocks/screener` + +Alternatively, the source code on GitHub is [here](https://github.com/OpenBB-finance/OpenBBTerminal/tree/develop/openbb_terminal/miscellaneous/stocks/screener) + +
diff --git a/website/content/sdk/faqs/import_errors.md b/website/content/sdk/faqs/import_errors.md new file mode 100644 index 000000000000..24a0fac5595a --- /dev/null +++ b/website/content/sdk/faqs/import_errors.md @@ -0,0 +1,90 @@ +--- +title: Import Errors +sidebar_position: 2 +description: This page provides solutions for common import errors when installing + the OpenBB SDK, including guidance on managing virtual environments, handling ModuleNotFoundError, + dealing with SSL certificate authorization, and configuring proxy connections. +keywords: +- Import Errors +- SciPy +- ModuleNotFoundError +- virtual environment +- poetry install +- conda activate +- Jupyter +- GitHub +- SSL certificates +- firewall +- pip-system-certs +- proxy connection +- .env file +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +## Import Errors + +When packages not included in the OpenBB installation are installed to the same environment as the SDK, it is possible that an incompatible build of a specific library (like SciPy) has overwritten the existing and creating a conflict. In this event, try creating a new environment containing only the OpenBB dependencies. + +
ModuleNotFoundError: No module named '______' + +Before troubleshooting please verify that the recommended installation instructions were followed. These errors often can occur when the virtual environment has not been activated, or the `poetry install` command was skipped. Activate the OpenBB virtual environment created during the installation process prior to launching or importing the SDK. + +**Terminal**: + +```console +conda activate obb +python terminal.py +``` + +**SDK**: + +```console +conda activate obb +ipython +from openbb_terminal.sdk import openbb +``` + +**Jupyter**: + +Check that the kernel selected for the session is the OpenBB virtual environment created during the installation process and then re-run the cell. + +```console +from openbb_terminal.sdk import openbb +``` + +There is also a possibility that a new dependency has been added to the code and it has not yet been installed in the environment. This may happen after updating the code from GitHub, but before running the `poetry install` install command. + +```console +poetry install -E all +``` + +
+ +
SSL certificates fail to authorize + +```console +SSL: CERTIFICATE_VERIFY_FAILED +``` + +An error message, similar to above, is usually encountered while attempting to use the OpenBB Platform from behind a firewall. A workplace environment is typically the most common occurrence. Try connecting to the internet directly through a home network to test the connection. If using a work computer and/or network, we recommend speaking with the company's IT department prior to installing or running any software. + +A potential solution is to try: + +```console +pip install pip-system-certs +``` + +
+ +
Cannot connect due to proxy connection. + +Find the `.env` file (located at the root of the user account folder: (`~/.openbb_terminal/.env`), and add a line at the bottom of the file with: + +```console +HTTP_PROXY="
" or HTTPS_PROXY="
” +``` + +
diff --git a/website/content/sdk/faqs/installation_updates.md b/website/content/sdk/faqs/installation_updates.md new file mode 100644 index 000000000000..77f41680eab7 --- /dev/null +++ b/website/content/sdk/faqs/installation_updates.md @@ -0,0 +1,118 @@ +--- +title: Installation and Updates +sidebar_position: 1 +description: This page provides detailed instructions for the installation and updating + processes for software, addressing frequently encountered installation issues. These + instructions include resolving Microsoft Visual C++ 14.0 dependencies, benefits + of using Miniconda for package management, methods to update installations, and + solutions for other common installation errors. +keywords: +- Installation +- Updates +- Microsoft Visual C++ 14.0 +- Miniconda +- pip install +- PyPi Nightly +- C++ Build Tools +- Homebrew +- bt wheel build failure +- ARM/Linux Raspberry Pi machines +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +## Installation and Updates + +
"Microsoft Visual C++ 14.0 or greater is required" + +Download and install [C++ Build Tools](https://visualstudio.microsoft.com/visual-cpp-build-tools/), restart the machine, then try again. + +![image](https://github.com/OpenBB-finance/OpenBBTerminal/assets/85772166/ceb57be0-6dae-42f2-aca6-bf62ce7d6135) + +![image](https://github.com/OpenBB-finance/OpenBBTerminal/assets/85772166/f8aef8fc-a080-4164-bd36-460714ec44f3) + +
+ +
Do I have to use Miniconda? + +There are certain dependencies which are sourced exclusively from the `conda-forge` directory. Other virtual environment managers, such a `venv`, may not solve the environment properly, resulting in failed package installations or incorrect builds. We highly recommend using Miniconda as the Python virtual environment manager for installing the OpenBB SDK. + +
+ +
How do I update my installation to the latest version? + +The code is constantly being updated with new features and bug fixes. The process for updating will vary by the installation type: + +- For a `pip` installation, when a new version is published: `pip install -U openbb[all]` +- Upgrade a cloned version of the GitHub repo with: + +```console +git fetch +git pull +poetry install -E all +``` + +**Notes:** If the cloned repository is a fork, pull from: `git pull origin main`, or, `git pull origin develop`. If there are changes locally to the files that conflict with the incoming changes from GitHub, stash them before pulling from main with `git stash`. + +
+ +### PyPi Nightly + +The nightly build can be installed with: + +```console +pip install openbb-terminal-nightly[all] +``` + +**Note**: This version may not be stable and should not be used in a production setting. + +
"Microsoft Visual C++ 14.0 or greater is required" + +Download and install [C++ Build Tools](https://visualstudio.microsoft.com/visual-cpp-build-tools/), restart the machine, then try again. + +
+ +
Error: failed building wheel for bt + +There may be an additional message that is printed from this error, stating: "Microsoft Visual C++ 14.0 or greater is required. Get it with "Microsoft C++ Build Tools". + +Download and install it. [https://visualstudio.microsoft.com/visual-cpp-build-tools/](https://visualstudio.microsoft.com/visual-cpp-build-tools/) + +Mac and Linux users may also encounter a similar error because a C++ compiler is not installed. Install Homebrew: + +```console +/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)" +``` + +Then run: + +```console +brew install gcc +brew install cmake +``` + +Additionally, Mac users should install Rosetta: + +```console +softwareupdate --install-rosetta +``` + +
+ +
Miniconda3 will not install on ARM/Linux Raspberry Pi machines. + +Refer to this issue on the Conda [GitHub](https://github.com/conda/conda/issues/10723) page. + +
+ +
Error: Library not loaded: '/usr/local/opt/libomp/lib/libomp.dylib' + +This error is resolved by installing libomp from Homebrew: + +```console +brew install libomp +``` + +
diff --git a/website/content/sdk/index.md b/website/content/sdk/index.md new file mode 100644 index 000000000000..2b608e5cd024 --- /dev/null +++ b/website/content/sdk/index.md @@ -0,0 +1,42 @@ +--- +title: Introduction +sidebar_position: 0 +description: OpenBB Platform is a comprehensive solution built with the contribution + of numerous community members, facilitating the development of stable integrations + with third-party data providers for a robust investment research infrastructure. +keywords: +- OpenBB Platform +- investment research infrastructure +- third-party data providers +- financial reports +- applications +- community contributions +- data connectors +- extensions +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +The OpenBB SDK is the core engine of the entire OpenBB platform. It provides programmatic access to the OpenBB Terminal commands directly in a Python script or Jupyter Notebook. Through a nearly 1-to-1 relationship, the OpenBB SDK syntax is instantly recognizable by the same Terminal commands. + +sdk + +--- + +- **A single endpoint for accessing financial data** + +Accessing investment research data can be a struggle, requiring significant time and effort. The OpenBB SDK simplifies this process by providing a single endpoint to connect with close to 100 different data sources. With just one line of code, you can access 30+ years of fundamental data for any company, making data collection fast and easy. + +- **Integrate your own workflow** + +The OpenBB SDK can be inserted into any investment research workflow. This could be to convey the performance of the portfolio to your portfolio manager or as an extension of your models to provide you with up-to-date financial data that can be pivotal for modeling and visualization. In addition, any other package can be utilized to process and analyze the data without any limitation. + +- **Generate insights from datasets 10 times faster** + +With our SDK, you can effortlessly access raw financial data programmatically, reducing the time and effort required to gather relevant information. Moreover, our SDK features built-in charting capabilities for most datasets, allowing you to analyze and visualize data directly from a Jupyter Notebook. This powerful feature streamlines your workflow and allows you to quickly create custom plots, providing insights that are valuable for informed decision making. + +--- + +Want to contribute? Check out our [CONTRIBUTING GUIDELINES](https://github.com/OpenBB-finance/OpenBBTerminal/blob/main/CONTRIBUTING.md). diff --git a/website/content/sdk/installation.md b/website/content/sdk/installation.md new file mode 100644 index 000000000000..ffe8aaa3bb2b --- /dev/null +++ b/website/content/sdk/installation.md @@ -0,0 +1,27 @@ +--- +title: Installation +sidebar_position: 1 +description: Learn about the OpenBB SDK that provides programmatic access to all Terminal + functions, allowing users to build their own tools and applications on the existing + architecture. Understand how it is part of the OpenBB Terminal and the installation + process. +keywords: +- OpenBB SDK +- programmatic access +- Terminal functions +- build tools +- build applications +- existing architecture +- installation source code +- PyPI +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +The OpenBB SDK provides programmatic access to all Terminal functions and much more. This layer of code allows users to build their own tools and applications on top of the existing architecture. + +:::note +The OpenBB SDK is a part of the OpenBB Terminal when installed via [source code](/terminal/installation/source) or [PyPI](/terminal/installation/pypi). +::: diff --git a/website/content/sdk/reference/_category_.json b/website/content/sdk/reference/_category_.json new file mode 100644 index 000000000000..9b5c74a02005 --- /dev/null +++ b/website/content/sdk/reference/_category_.json @@ -0,0 +1,4 @@ +{ + "label": "Reference", + "position": 4 +} diff --git a/website/content/sdk/reference/alt/covid/global_cases.md b/website/content/sdk/reference/alt/covid/global_cases.md new file mode 100644 index 000000000000..3b424aae3c06 --- /dev/null +++ b/website/content/sdk/reference/alt/covid/global_cases.md @@ -0,0 +1,68 @@ +--- +title: global_cases +description: The 'global_cases' page provides code and instructions for getting historical + Covid-19 case data for any country. Utilize the provided Python function to retrieve + a DataFrame of historical data. +keywords: +- Covid-19 +- historical data +- openbb.alt.covid.global_cases +- global cases +- country specific data +- programming +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Get historical cases for given country. + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/alternative/covid/covid_model.py#L26)] + +```python +openbb.alt.covid.global_cases(country: str) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| country | str | Country to search for | None | False | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | Dataframe of historical cases | +--- + +## Examples + +```python +df = get_global_cases("United States") +``` + +``` +Dataframe of historical cases for United States +``` +```python +df = get_global_cases("Portugal") +``` + +``` +Dataframe of historical cases for Portugal +``` +```python +df = get_global_cases("Spain") +``` + +``` +Dataframe of historical cases for Spain +``` +--- diff --git a/website/content/sdk/reference/alt/covid/global_deaths.md b/website/content/sdk/reference/alt/covid/global_deaths.md new file mode 100644 index 000000000000..e21bc553b61e --- /dev/null +++ b/website/content/sdk/reference/alt/covid/global_deaths.md @@ -0,0 +1,44 @@ +--- +title: global_deaths +description: This page provides understanding about the function 'global_deaths' from + OpenBB.terminals used to fetch historical death statistics for a specified country + due to covid. +keywords: +- OpenBB.terminals +- global_deaths +- covid +- historical death data +- python function +- dataframe +- country specific statistics +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Get historical deaths for given country. + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/alternative/covid/covid_model.py#L73)] + +```python +openbb.alt.covid.global_deaths(country: str) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| country | str | Country to search for | None | False | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | Dataframe of historical deaths | +--- diff --git a/website/content/sdk/reference/alt/covid/ov.md b/website/content/sdk/reference/alt/covid/ov.md new file mode 100644 index 000000000000..cad4241206ce --- /dev/null +++ b/website/content/sdk/reference/alt/covid/ov.md @@ -0,0 +1,88 @@ +--- +title: ov +description: This documentation page provides detailed information on the 'ov' models + used for retrieving historical cases and deaths-by-country data. It also explains + the parameters required to run these models, and returns in the form of a DataFrame. +keywords: +- docusaurus +- ov model +- historical data +- cases +- deaths +- country-specific +- dataframe +- parameters +- functions +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + +Get historical cases and deaths by country. + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/alternative/covid/covid_model.py#L105)] + +```python +openbb.alt.covid.ov(country: str, limit: int = 100) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| country | str | Country to get data for | None | False | +| limit | int | Number of raw data to show | 100 | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | Dataframe of historical cases and deaths | +--- + + + + +Prints table showing historical cases and deaths by country. + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/alternative/covid/covid_view.py#L131)] + +```python +openbb.alt.covid.ov_chart(country: str, raw: bool = False, limit: int = 10, export: str = "", plot: bool = True) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| country | str | Country to get data for | None | False | +| raw | bool | Flag to display raw data | False | True | +| limit | int | Number of raw data to show | 10 | True | +| export | str | Format to export data | | True | +| plot | bool | Flag to display historical plot | True | True | + + +--- + +## Returns + +This function does not return anything + +--- + + + diff --git a/website/content/sdk/reference/alt/covid/slopes.md b/website/content/sdk/reference/alt/covid/slopes.md new file mode 100644 index 000000000000..d32002a8cb55 --- /dev/null +++ b/website/content/sdk/reference/alt/covid/slopes.md @@ -0,0 +1,87 @@ +--- +title: slopes +description: Our site offers extensive information on how to use slopes models to + analyze COVID-19 data. The models provide detailed data frames based on historical + data to help with the analysis and prediction. Learn how to manipulate these models + to suit your specific needs. +keywords: +- slopes models +- COVID-19 data analysis +- data frames +- historical data +- OpenBB finance +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + +Load cases and find slope over period. + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/alternative/covid/covid_model.py#L173)] + +```python +openbb.alt.covid.slopes(days_back: int = 30, limit: int = 50, threshold: int = 10000, ascend: bool = False) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| days_back | int | Number of historical days to consider | 30 | True | +| limit | int | Number of rows to show | 50 | True | +| threshold | int | Threshold for total number of cases | 10000 | True | +| ascend | bool | Flag to sort in ascending order | False | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | Dataframe containing slopes | +--- + + + + +Prints table showing countries with the highest case slopes. + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/alternative/covid/covid_view.py#L220)] + +```python +openbb.alt.covid.slopes_chart(days_back: int = 30, limit: int = 10, threshold: int = 10000, ascend: bool = False, export: str = "") +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| days_back | int | Number of historical days to get slope for | 30 | True | +| limit | int | Number to show in table | 10 | True | +| ascend | bool | Flag to sort in ascending order | False | True | +| threshold | int | Threshold for total cases over period | 10000 | True | +| export | str | Format to export data | | True | + + +--- + +## Returns + +This function does not return anything + +--- + + + diff --git a/website/versioned_docs/version-v3/sdk/reference/alt/covid/stat.md b/website/content/sdk/reference/alt/covid/stat.md similarity index 77% rename from website/versioned_docs/version-v3/sdk/reference/alt/covid/stat.md rename to website/content/sdk/reference/alt/covid/stat.md index 210136fcac23..71676b02971d 100644 --- a/website/versioned_docs/version-v3/sdk/reference/alt/covid/stat.md +++ b/website/content/sdk/reference/alt/covid/stat.md @@ -1,13 +1,25 @@ --- title: stat -description: OpenBB SDK Function +description: This page provides a comprehensive guide on how to use two functions, + stat and chart, in the OpenBBTerminal for COVID-19 data analysis. They are used + for retrieving and visualising historical cases and deaths by country. +keywords: +- stat function +- chart function +- COVID-19 data analysis +- historical cases and deaths +- Country-wise data +- Data visualisation +- pandas DataFrame --- +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; -# stat - @@ -39,8 +51,6 @@ openbb.alt.covid.stat(country: str, stat: str = "cases", limit: int = 10) | pd.DataFrame | Dataframe of data for given country and statistic | --- - - @@ -74,7 +84,5 @@ This function does not return anything --- - - - \ No newline at end of file + diff --git a/website/content/sdk/reference/alt/oss/_make_request.md b/website/content/sdk/reference/alt/oss/_make_request.md new file mode 100644 index 000000000000..895d3b896c3e --- /dev/null +++ b/website/content/sdk/reference/alt/oss/_make_request.md @@ -0,0 +1,43 @@ +--- +title: _make_request +description: This is a documentation page for the '_make_request' helper method used + for scraping in Python. The method takes a URL as parameter and returns a BeautifulSoup + object or None. +keywords: +- make_request +- scraping +- code +- BeautifulSoup +- URL +- helper method +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Helper method to scrap. + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/alternative/oss/runa_model.py#L67)] + +```python +openbb.alt.oss._make_request(url: str) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| url | str | url to scrape | None | False | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| Union[BeautifulSoup, None] | BeautifulSoup object or None | +--- diff --git a/website/content/sdk/reference/alt/oss/_retry_session.md b/website/content/sdk/reference/alt/oss/_retry_session.md new file mode 100644 index 000000000000..0f9ebe76b57c --- /dev/null +++ b/website/content/sdk/reference/alt/oss/_retry_session.md @@ -0,0 +1,47 @@ +--- +title: _retry_session +description: The _retry_session function in OpenBBTerminal is a Python helper method + that attempts to mount a session given a URL, implementing a retry scheme with parameters + for number of retries and a backoff factor. It returns a session object from the + requests library. +keywords: +- _retry_session +- url +- retries +- backoff_factor +- requests.Session +- session mount +- retry scheme +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Helper methods that retries to make request. + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/alternative/oss/runa_model.py#L32)] + +```python +openbb.alt.oss._retry_session(url: str, retries: int = 3, backoff_factor: float = 1.0) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| url | str | Url to mount a session | None | False | +| retries | int | How many retries | 3 | True | +| backoff_factor | float | Backoff schema - time periods between retry | 1.0 | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| requests.Session | Mounted session | +--- diff --git a/website/content/sdk/reference/alt/oss/github_data.md b/website/content/sdk/reference/alt/oss/github_data.md new file mode 100644 index 000000000000..1b567464c417 --- /dev/null +++ b/website/content/sdk/reference/alt/oss/github_data.md @@ -0,0 +1,45 @@ +--- +title: github_data +description: This page provides the function 'openbb.alt.oss.github_data' to retrieve + repository stats from a specified GitHub API endpoint using Python. It includes + a list of parameters for this function and explains what data you will retrieve. +keywords: +- github data +- repository stats +- openbb.alt.oss.github_data +- github api endpoint +- params +- api endpoint +- dictionary data +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Get repository stats. + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/alternative/oss/github_model.py#L21)] + +```python +openbb.alt.oss.github_data(url: str, kwargs: Any) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| url | str | github api endpoint | None | False | +| params | dict | params to pass to api endpoint | None | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| Dict[str, Any] | Dictionary with data | +--- diff --git a/website/content/sdk/reference/alt/oss/history.md b/website/content/sdk/reference/alt/oss/history.md new file mode 100644 index 000000000000..ba2ee96a54a0 --- /dev/null +++ b/website/content/sdk/reference/alt/oss/history.md @@ -0,0 +1,84 @@ +--- +title: history +description: This documentation page provides detailed information about using the + openbb software's history feature, with sections for its model and chart display. + It illustrates how to retrieve repository star history, search for specific repositories, + and plot repo summaries. +keywords: +- openbb software +- repository star history +- github +- chart display +- repo summary plot +- export dataframe +- software documentation +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + +Get repository star history. + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/alternative/oss/github_model.py#L88)] + +```python +openbb.alt.oss.history(repo: str) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| repo | str | Repo to search for Format: org/repo, e.g., openbb-finance/openbbterminal | None | False | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | Dataframe with star history - Columns: Date, Stars | +--- + + + + +Plots repo summary [Source: https://api.github.com]. + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/alternative/oss/github_view.py#L28)] + +```python +openbb.alt.oss.history_chart(repo: str, export: str = "", external_axes: Optional[List[matplotlib.axes._axes.Axes]] = None) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| repo | str | Repository to display star history. Format: org/repo, e.g., openbb-finance/openbbterminal | None | False | +| export | str | Export dataframe data to csv,json,xlsx file | | True | +| external_axes | Optional[List[plt.Axes]] | External axes (1 axis is expected in the list), by default None | None | True | + + +--- + +## Returns + +This function does not return anything + +--- + + + diff --git a/website/versioned_docs/version-v3/sdk/reference/alt/oss/ross.md b/website/content/sdk/reference/alt/oss/ross.md similarity index 78% rename from website/versioned_docs/version-v3/sdk/reference/alt/oss/ross.md rename to website/content/sdk/reference/alt/oss/ross.md index c96c6d2ad61d..24270b138b18 100644 --- a/website/versioned_docs/version-v3/sdk/reference/alt/oss/ross.md +++ b/website/content/sdk/reference/alt/oss/ross.md @@ -1,13 +1,28 @@ --- title: ross -description: OpenBB SDK Function +description: This documentation page provides detailed information about the 'ross' + functions of the OpenBB Terminal. These functions help to retrieve and visualize + data about startups from the ROSS index. +keywords: +- ross function +- data retrieval +- startups data +- ROSS index +- visualization +- dataframe +- chart +- data sort +- growth line chart +- data export --- +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; -# ross - @@ -34,8 +49,6 @@ This function does not take any parameters. | pd.DataFrame | list of startups | --- - - @@ -71,7 +84,5 @@ This function does not return anything --- - - - \ No newline at end of file + diff --git a/website/content/sdk/reference/alt/oss/search.md b/website/content/sdk/reference/alt/oss/search.md new file mode 100644 index 000000000000..8a2ff8ec7b3b --- /dev/null +++ b/website/content/sdk/reference/alt/oss/search.md @@ -0,0 +1,47 @@ +--- +title: search +description: Discover OpenBB's robust functionality to sort repos by stars or forks, + with an additional category filter feature. The result is straightforwardly produced + as a DataFrame. Source code available. +keywords: +- OpenBB finance +- Repo sorter +- Star ranking +- Fork ranking +- Category filter +- Python API +- Financial data extraction +- Dataframe results +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Get repos sorted by stars or forks. Can be filtered by categories. + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/alternative/oss/github_model.py#L56)] + +```python +openbb.alt.oss.search(sortby: str = "stars", page: int = 1, categories: str = "") +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| sortby | str | Sort repos by {stars, forks} | stars | True | +| categories | str | Check for repo categories. If more than one separate with a comma: e.g., finance,investment. Default: None | | True | +| page | int | Page number to get repos | 1 | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | Dataframe with repos | +--- diff --git a/website/content/sdk/reference/alt/oss/summary.md b/website/content/sdk/reference/alt/oss/summary.md new file mode 100644 index 000000000000..08964af579ed --- /dev/null +++ b/website/content/sdk/reference/alt/oss/summary.md @@ -0,0 +1,82 @@ +--- +title: summary +description: This documentation page contains comprehensive information on OpenBB's + repository summary and chart view options. You can retrieve a summary with OpenBB + library and display it in a chart view. Includes source code links and detailed + parameter descriptions for usage. +keywords: +- Repository Summary +- Chart View +- Source Code +- Github +- Docusaurus +- API +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + +Get repository summary. + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/alternative/oss/github_model.py#L179)] + +```python +openbb.alt.oss.summary(repo: str) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| repo | str | Repo to search for Format: org/repo, e.g., openbb-finance/openbbterminal | None | False | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | Dataframe with repo summary - Columns: Metric, Value | +--- + + + + +Prints table showing repo summary [Source: https://api.github.com]. + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/alternative/oss/github_view.py#L123)] + +```python +openbb.alt.oss.summary_chart(repo: str, export: str = "") +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| repo | str | Repository to display summary. Format: org/repo, e.g., openbb-finance/openbbterminal | None | False | +| export | str | Export dataframe data to csv,json,xlsx file | | True | + + +--- + +## Returns + +This function does not return anything + +--- + + + diff --git a/website/content/sdk/reference/alt/oss/top.md b/website/content/sdk/reference/alt/oss/top.md new file mode 100644 index 000000000000..e77cdcff042d --- /dev/null +++ b/website/content/sdk/reference/alt/oss/top.md @@ -0,0 +1,94 @@ +--- +title: top +description: 'This content describes two features: ''Model'' and ''Chart''. ''Model'' + gets repositories sorted by stars or forks with possible category filtering. ''Chart'' + plots a repo summary. Both procedures involve parameters like ''sortby'', ''categories'', + ''limit'', ''export'', and ''external_axes''.' +keywords: +- Documentation +- Model +- Chart +- Repositories +- Stars +- Forks +- Filtering +- Parameters +- Sortby +- Categories +- Limit +- Export +- External_axes +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + +Get repos sorted by stars or forks. Can be filtered by categories. + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/alternative/oss/github_model.py#L135)] + +```python +openbb.alt.oss.top(sortby: str, limit: int = 50, categories: str = "") +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| sortby | str | Sort repos by {stars, forks} | None | False | +| categories | str | Check for repo categories. If more than one separate with a comma: e.g., finance,investment. Default: None | | True | +| limit | int | Number of repos to search for | 50 | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | Dataframe with repos | +--- + + + + +Plots repo summary [Source: https://api.github.com]. + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/alternative/oss/github_view.py#L65)] + +```python +openbb.alt.oss.top_chart(sortby: str, categories: str = "", limit: int = 10, export: str = "", external_axes: Optional[List[matplotlib.axes._axes.Axes]] = None) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| sortby | str | Sort repos by {stars, forks} | None | False | +| categories | str | Check for repo categories. If more than one separate with a comma: e.g., finance,investment. Default: None | | True | +| limit | int | Number of repos to look at | 10 | True | +| export | str | Export dataframe data to csv,json,xlsx file | | True | +| external_axes | Optional[List[plt.Axes]] | External axes (1 axis is expected in the list), by default None | None | True | + + +--- + +## Returns + +This function does not return anything + +--- + + + diff --git a/website/content/sdk/reference/crypto/candles.md b/website/content/sdk/reference/crypto/candles.md new file mode 100644 index 000000000000..ec14b24c97a2 --- /dev/null +++ b/website/content/sdk/reference/crypto/candles.md @@ -0,0 +1,49 @@ +--- +title: candles +description: The page provides documentation for the 'candles' function in the OpenBB + crypto module. It describes how a candle chart can be plotted from a provided DataFrame, + and the various parameters that can be adjusted. +keywords: +- crypto.candles +- candle chart +- Binance source +- Python script +- data visualization +- OpenBB crypto module +- matplotlib +- OHLCV +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Plot candle chart from dataframe. [Source: Binance] + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/cryptocurrency/cryptocurrency_helpers.py#L799)] + +```python +openbb.crypto.candles(candles_df: pd.DataFrame, volume: bool = True, ylabel: str = "", title: str = "", external_axes: Optional[list[matplotlib.axes._axes.Axes]] = None, yscale: str = "linear") +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| candles_df | pd.DataFrame | Dataframe containing time and OHLCV | None | False | +| volume | bool | If volume data shall be plotted, by default True | True | True | +| ylabel | str | Y-label of the graph, by default "" | | True | +| title | str | Title of graph, by default "" | | True | +| external_axes | Optional[List[plt.Axes]] | External axes (1 axis is expected in the list), by default None | None | True | +| yscale | str | Scaling for y axis. Either linear or log | linear | True | + + +--- + +## Returns + +This function does not return anything + +--- diff --git a/website/content/sdk/reference/crypto/chart.md b/website/content/sdk/reference/crypto/chart.md new file mode 100644 index 000000000000..a0fe30e4aab8 --- /dev/null +++ b/website/content/sdk/reference/crypto/chart.md @@ -0,0 +1,46 @@ +--- +title: chart +description: Extend your technical analysis with the OpenBB crypto chart function. + This feature allows loading of cryptocurrency data, optional title configuration + based on Coin and Currency, and control over plot scale (linear or log). Source + code is available. +keywords: +- Technical Analysis +- OpenBB crypto chart +- Cryptocurrency data +- matplotlib axes +- linear plot scale +- log plot scale +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Load data for Technical Analysis + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/cryptocurrency/cryptocurrency_helpers.py#L747)] + +```python +openbb.crypto.chart(prices_df: pd.DataFrame, to_symbol: str = "", from_symbol: str = "", source: str = "", exchange: str = "", interval: str = "", external_axes: Optional[list[matplotlib.axes._axes.Axes]] = None, yscale: str = "linear") +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| prices_df | pd.DataFrame | Cryptocurrency | None | False | +| to_symbol | str | Coin (only used for chart title), by default "" | | True | +| from_symbol | str | Currency (only used for chart title), by default "" | | True | +| yscale | str | Scale for y axis of plot Either linear or log | linear | True | + + +--- + +## Returns + +This function does not return anything + +--- diff --git a/website/content/sdk/reference/crypto/dd/active.md b/website/content/sdk/reference/crypto/dd/active.md new file mode 100644 index 000000000000..72507aa5bc1b --- /dev/null +++ b/website/content/sdk/reference/crypto/dd/active.md @@ -0,0 +1,89 @@ +--- +title: active +description: Documentation for the activation and visualization of active addresses + of a certain cryptocurrency symbol. Explains how to both retrieve and chart data + concerning active addresses within specific time frames. +keywords: +- cryptocurrency +- active addresses +- data visualization +- docusaurus documentation +- due diligence +- time intervals +- data export +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + +Returns active addresses of a certain symbol + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/cryptocurrency/due_diligence/glassnode_model.py#L311)] + +```python +openbb.crypto.dd.active(symbol: str, interval: str = "24h", start_date: str = "2010-01-01", end_date: Optional[str] = None) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| symbol | str | Asset to search active addresses (e.g., BTC) | None | False | +| interval | str | Interval frequency (e.g., 24h) | 24h | True | +| start_date | str | Initial date, format YYYY-MM-DD | 2010-01-01 | True | +| end_date | str | Final date, format YYYY-MM-DD | None | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | active addresses over time | +--- + + + + +Plots active addresses of a certain symbol over time + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/cryptocurrency/due_diligence/glassnode_view.py#L32)] + +```python +openbb.crypto.dd.active_chart(symbol: str, start_date: str = "2010-01-01", end_date: Optional[str] = None, interval: str = "24h", export: str = "", external_axes: Optional[List[matplotlib.axes._axes.Axes]] = None) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| symbol | str | Asset to search active addresses (e.g., BTC) | None | False | +| start_date | str | Initial date, format YYYY-MM-DD | 2010-01-01 | True | +| end_date | Optional[str] | Final date, format YYYY-MM-DD | None | True | +| interval | str | Interval frequency (possible values are: 24h, 1w, 1month) | 24h | True | +| export | str | Export dataframe data to csv,json,xlsx file | | True | +| external_axes | Optional[List[plt.Axes]] | External axes (1 axis is expected in the list), by default None | None | True | + + +--- + +## Returns + +This function does not return anything + +--- + + + diff --git a/website/content/sdk/reference/crypto/dd/all_binance_trading_pairs.md b/website/content/sdk/reference/crypto/dd/all_binance_trading_pairs.md new file mode 100644 index 000000000000..3d0bf620c71b --- /dev/null +++ b/website/content/sdk/reference/crypto/dd/all_binance_trading_pairs.md @@ -0,0 +1,39 @@ +--- +title: all_binance_trading_pairs +description: This page provides the function to get all available trading pairs on + Binance in DataFrame format with columns including symbol, baseAsset, and quoteAsset. + This function does not require any parameters. +keywords: +- Binance +- Trading pairs +- baseAsset +- quoteAsset +- Crypto Trading +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Returns all available pairs on Binance in DataFrame format. DataFrame has 3 columns symbol, baseAsset, quoteAsset + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/cryptocurrency/due_diligence/binance_model.py#L58)] + +```python +openbb.crypto.dd.all_binance_trading_pairs() +``` + +--- + +## Parameters + +This function does not take any parameters. + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | All available pairs on Binance
Columns: symbol, baseAsset, quoteAsset | +--- diff --git a/website/content/sdk/reference/crypto/dd/balance.md b/website/content/sdk/reference/crypto/dd/balance.md new file mode 100644 index 000000000000..0c5d3aa8eb82 --- /dev/null +++ b/website/content/sdk/reference/crypto/dd/balance.md @@ -0,0 +1,87 @@ +--- +title: balance +description: This page provides documentation on the 'balance' functions, enabling + users to view account holdings for particular assets. It dives into the specifics + of how to use these functions to retrieve data from Binance and display it efficiently. +keywords: +- balance functions +- account holdings +- asset +- Binance +- cryptocurrency +- dataframe +- parameters +- balance_chart function +- export dataframe +- USDT +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + +Get account holdings for asset. [Source: Binance] + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/cryptocurrency/due_diligence/binance_model.py#L179)] + +```python +openbb.crypto.dd.balance(from_symbol: str, to_symbol: str = "USDT") +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| from_symbol | str | Cryptocurrency | None | False | +| to_symbol | str | Cryptocurrency | USDT | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | Dataframe with account holdings for an asset | +--- + + + + +Prints table showing account holdings for asset. [Source: Binance] + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/cryptocurrency/due_diligence/binance_view.py#L64)] + +```python +openbb.crypto.dd.balance_chart(from_symbol: str, to_symbol: str = "USDT", export: str = "") +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| from_symbol | str | Cryptocurrency | None | False | +| to_symbol | str | Cryptocurrency | USDT | True | +| export | str | Export dataframe data to csv,json,xlsx | | True | + + +--- + +## Returns + +This function does not return anything + +--- + + + diff --git a/website/content/sdk/reference/crypto/dd/basic.md b/website/content/sdk/reference/crypto/dd/basic.md new file mode 100644 index 000000000000..55047f1cfbd0 --- /dev/null +++ b/website/content/sdk/reference/crypto/dd/basic.md @@ -0,0 +1,86 @@ +--- +title: basic +description: This documentation page provides insights into how to use basic functions + of the OpenBB terminal for cryptocurrency tracking and analysis. It also provides + source code links and parameters information for two of its functions - 'coinpaprika_model' + and 'coinpaprika_view', dealing with basic information retrieval and chart generation + for cryptocurrencies respectively. +keywords: +- OpenBB terminal +- cryptocurrency analysis +- coinpaprika_model +- basic coin information +- coinpaprika_view +- cryptocurrency chart generation +- cryptocurrency tracking +- cryptocurrency parameters +- BTC +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + +Basic coin information [Source: CoinPaprika] + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/cryptocurrency/due_diligence/coinpaprika_model.py#L379)] + +```python +openbb.crypto.dd.basic(symbol: str = "BTC") +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| symbol | str | Cryptocurrency symbol (e.g. BTC) | BTC | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | Metric, Value | +--- + + + + +Prints table showing basic information for coin. Like: + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/cryptocurrency/due_diligence/coinpaprika_view.py#L325)] + +```python +openbb.crypto.dd.basic_chart(symbol: str = "BTC", export: str = "") +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| symbol | str | Cryptocurrency symbol (e.g. BTC) | BTC | True | +| export | str | Export dataframe data to csv,json,xlsx | | True | + + +--- + +## Returns + +This function does not return anything + +--- + + + diff --git a/website/content/sdk/reference/crypto/dd/binance_available_quotes_for_each_coin.md b/website/content/sdk/reference/crypto/dd/binance_available_quotes_for_each_coin.md new file mode 100644 index 000000000000..05398caf76fd --- /dev/null +++ b/website/content/sdk/reference/crypto/dd/binance_available_quotes_for_each_coin.md @@ -0,0 +1,42 @@ +--- +title: binance_available_quotes_for_each_coin +description: This page provides a detailed guide to the helper methods in OpenBB Terminal + that, for every coin available on Binance, add all quote assets. It includes how + to use the function and what it will return. +keywords: +- Binance +- cryptocurrency +- quote assets +- helper methods +- coin +- function +- parameters +- returns +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Helper methods that for every coin available on Binance add all quote assets. [Source: Binance] + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/cryptocurrency/due_diligence/binance_model.py#L77)] + +```python +openbb.crypto.dd.binance_available_quotes_for_each_coin() +``` + +--- + +## Parameters + +This function does not take any parameters. + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| dict | All quote assets for given coin
{'ETH' : ['BTC', 'USDT' ...], 'UNI' : ['ETH', 'BTC','BUSD', ...] | +--- diff --git a/website/content/sdk/reference/crypto/dd/candles.md b/website/content/sdk/reference/crypto/dd/candles.md new file mode 100644 index 000000000000..0d3057abb8e7 --- /dev/null +++ b/website/content/sdk/reference/crypto/dd/candles.md @@ -0,0 +1,87 @@ +--- +title: candles +description: This page provides documentation on how to get or chart candles for a + chosen trading pair and time interval on Coinbase using the OpenBB crypto library. + It includes the Python code for these functions and the parameters to use. +keywords: +- OpenBB crypto library +- candles trading pair +- time interval +- Coinbase +- Python function +- Cryptocurrency trading +- Crypto trading analysis +- Cryptocurrency pairs +- Trade charting +- Data export +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + +Get candles for chosen trading pair and time interval. [Source: Coinbase] + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/cryptocurrency/due_diligence/coinbase_model.py#L143)] + +```python +openbb.crypto.dd.candles(symbol: str, interval: str = "24h") +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| symbol | str | Trading pair of coins on Coinbase e.g ETH-USDT or UNI-ETH | None | False | +| interval | str | Time interval. One from 1min, 5min ,15min, 1hour, 6hour, 24hour | 24h | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | Candles for chosen trading pair. | +--- + + + + +Prints table showing candles for chosen trading pair and time interval. [Source: Coinbase] + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/cryptocurrency/due_diligence/coinbase_view.py#L76)] + +```python +openbb.crypto.dd.candles_chart(symbol: str, interval: str = "24h", export: str = "") +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| symbol | str | Trading pair of coins on Coinbase e.g ETH-USDT or UNI-ETH | None | False | +| interval | str | Time interval. One from 1m, 5m ,15m, 1h, 6h, 24h | 24h | True | +| export | str | Export dataframe data to csv,json,xlsx file | | True | + + +--- + +## Returns + +This function does not return anything + +--- + + + diff --git a/website/content/sdk/reference/crypto/dd/change.md b/website/content/sdk/reference/crypto/dd/change.md new file mode 100644 index 000000000000..339300ca5dd5 --- /dev/null +++ b/website/content/sdk/reference/crypto/dd/change.md @@ -0,0 +1,94 @@ +--- +title: change +description: This page provides detailed documentation on how to track the 30-day + change in the supply held in exchange wallets using our function 'openbb.crypto.dd.change'. + It also includes steps on how to visualize these changes by plotting a chart using + the function 'openbb.crypto.dd.change_chart'. The page contains explanations about + each function parameter, return types, and default values along with links to the + source code. +keywords: +- SEO optimization +- Metadata +- Cryptocurrency Supply Change +- Exchange Wallets +- OpenBB Crypto DD Change +- Plot Change Chart +- OpenBB Crypto DD Change Chart +- Documentation +- Source Code Link +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + +Returns 30d change of the supply held in exchange wallets of a certain symbol. + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/cryptocurrency/due_diligence/glassnode_model.py#L555)] + +```python +openbb.crypto.dd.change(symbol: str, exchange: str = "binance", start_date: str = "2010-01-01", end_date: Optional[str] = None) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| symbol | str | Asset symbol to search supply (e.g., BTC) | None | False | +| exchange | str | Exchange to check net position change (e.g., binance) | binance | True | +| start_date | Optional[str] | Initial date, format YYYY-MM-DD | 2010-01-01 | True | +| end_date | Optional[str] | Final date, format YYYY-MM-DD | None | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | supply change in exchange wallets of a certain symbol over time | +--- + + + + +Plots 30d change of the supply held in exchange wallets. + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/cryptocurrency/due_diligence/glassnode_view.py#L157)] + +```python +openbb.crypto.dd.change_chart(symbol: str, exchange: str = "binance", start_date: str = "2010-01-01", end_date: Optional[str] = None, export: str = "", external_axes: Optional[List[matplotlib.axes._axes.Axes]] = None) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| symbol | str | Asset to search active addresses (e.g., BTC) | None | False | +| exchange | str | Exchange to check net position change (possible values are: aggregated, binance,
bittrex, coinex, gate.io, gemini, huobi, kucoin, poloniex, bibox, bigone, bitfinex,
hitbtc, kraken, okex, bithumb, zb.com, cobinhood, bitmex, bitstamp, coinbase, coincheck, luno) | binance | True | +| start_date | str | Initial date, format YYYY-MM-DD | 2010-01-01 | True | +| end_date | Optional[str] | Final date, format YYYY-MM-DD | None | True | +| export | str | Export dataframe data to csv,json,xlsx file | | True | +| external_axes | Optional[List[plt.Axes]] | External axes (1 axis is expected in the list), by default None | None | True | + + +--- + +## Returns + +This function does not return anything + +--- + + + diff --git a/website/content/sdk/reference/crypto/dd/check_valid_binance_str.md b/website/content/sdk/reference/crypto/dd/check_valid_binance_str.md new file mode 100644 index 000000000000..205e053c2ccf --- /dev/null +++ b/website/content/sdk/reference/crypto/dd/check_valid_binance_str.md @@ -0,0 +1,38 @@ +--- +title: check_valid_binance_str +description: Learn about the check_valid_binance_str Python function from OpenBB. + This function checks if symbols are defined in binance. Source code provided. +keywords: +- binance +- symbol +- cryptocurrency +- due diligence +- check_valid_binance_str +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Check if symbol is in defined binance. [Source: Binance] + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/cryptocurrency/due_diligence/binance_model.py#L96)] + +```python +openbb.crypto.dd.check_valid_binance_str(symbol: str) +``` + +--- + +## Parameters + +This function does not take any parameters. + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| str | Symbol | +--- diff --git a/website/content/sdk/reference/crypto/dd/close.md b/website/content/sdk/reference/crypto/dd/close.md new file mode 100644 index 000000000000..c981400c1501 --- /dev/null +++ b/website/content/sdk/reference/crypto/dd/close.md @@ -0,0 +1,46 @@ +--- +title: close +description: This page details the use of the 'close' function in the OpenBB crypto + library which provides the closing price of a cryptocurrency within a specified + time range. +keywords: +- crypto +- cryptocurrency +- BTC +- ETH +- closing price +- OpenBB crypto library +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Returns the price of a cryptocurrency + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/cryptocurrency/due_diligence/glassnode_model.py#L181)] + +```python +openbb.crypto.dd.close(symbol: str, start_date: str = "2010-01-01", end_date: Optional[str] = None, print_errors: bool = True) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| symbol | str | Crypto to check close price (BTC or ETH) | None | False | +| start_date | str | Initial date, format YYYY-MM-DD | 2010-01-01 | True | +| end_date | str | Final date, format YYYY-MM-DD | None | True | +| print_errors | bool | Flag to print errors. Default: True | True | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | price over time | +--- diff --git a/website/content/sdk/reference/crypto/dd/coin.md b/website/content/sdk/reference/crypto/dd/coin.md new file mode 100644 index 000000000000..26928ae24fc7 --- /dev/null +++ b/website/content/sdk/reference/crypto/dd/coin.md @@ -0,0 +1,43 @@ +--- +title: coin +description: This page details how to fetch specific coin data by ID using the CoinPaprika + API in the OpenBBTerminal. Use this information to explore the specific parameters + and returns. +keywords: +- coin +- cryptocurrency +- CoinPaprika +- coin data +- API +- coin id +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Get coin by id [Source: CoinPaprika] + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/cryptocurrency/due_diligence/coinpaprika_model.py#L427)] + +```python +openbb.crypto.dd.coin(symbol: str = "eth-ethereum") +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| symbol | str | id of coin from coinpaprika e.g. Ethereum - > 'eth-ethereum' | eth-ethereum | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| dict | Coin response | +--- diff --git a/website/content/sdk/reference/crypto/dd/coin_market_chart.md b/website/content/sdk/reference/crypto/dd/coin_market_chart.md new file mode 100644 index 000000000000..96ebd8bded9a --- /dev/null +++ b/website/content/sdk/reference/crypto/dd/coin_market_chart.md @@ -0,0 +1,48 @@ +--- +title: coin_market_chart +description: The page provides details about the 'coin_market_chart' function in the + OpenBB crypto module. This function fetches and displays coin prices based on specified + parameters. +keywords: +- coin market chart +- cryptocurrency prices +- openbb crypto +- Python data fetching +- coin prices API +- data frame +- pycoingecko model +- currency +- coin pricing data +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Get prices for given coin. [Source: CoinGecko] + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/cryptocurrency/due_diligence/pycoingecko_model.py#L222)] + +```python +openbb.crypto.dd.coin_market_chart(symbol: str = "", vs_currency: str = "usd", days: int = 30, kwargs: Any) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| vs_currency | str | currency vs which display data | usd | True | +| days | int | number of days to display the data | 30 | True | +| kwargs | None | unspecified keyword arguments | None | None | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | Prices for given coin
Columns: time, price, currency | +--- diff --git a/website/content/sdk/reference/crypto/dd/eb.md b/website/content/sdk/reference/crypto/dd/eb.md new file mode 100644 index 000000000000..75ce8cd733f8 --- /dev/null +++ b/website/content/sdk/reference/crypto/dd/eb.md @@ -0,0 +1,111 @@ +--- +title: eb +description: This page provides documentation on how to use the OpenBBTerminal's 'eb' + function in cryptocurrency due diligence. Users can return and plot the total amount + of coins held on exchange addresses in Python - an essential tool for data analysis + in the crypto market. +keywords: +- OpenBB finance +- OpenBB crypto +- Cryptocurrency due diligence +- Glassnode model +- Glassnode view +- Data analysis +- Bitcoin +- Exchange addresses +- EB chart +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + +Returns the total amount of coins held on exchange addresses in units and percentage. + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/cryptocurrency/due_diligence/glassnode_model.py#L453)] + +```python +openbb.crypto.dd.eb(symbol: str, exchange: str = "aggregated", start_date: Optional[str] = None, end_date: Optional[str] = None) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| symbol | str | Asset to search active addresses (e.g., BTC) | None | False | +| exchange | str | Exchange to check net position change (possible values are: aggregated, binance, bittrex,
coinex, gate.io, gemini, huobi, kucoin, poloniex, bibox, bigone, bitfinex, hitbtc, kraken,
okex, bithumb, zb.com, cobinhood, bitmex, bitstamp, coinbase, coincheck, luno), by default "aggregated" | aggregated | True | +| start_date | Optional[str] | Initial date (format YYYY-MM-DD) by default 2 years ago | None | True | +| end_date | Optional[str] | Final date (format YYYY-MM-DD) by default 1 year ago | None | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | total amount of coins in units/percentage and symbol price over time | +--- + +## Examples + +```python +from openbb_terminal.sdk import openbb +df = openbb.crypto.dd.eb(symbol="BTC") +``` + +--- + + + + +Plots total amount of coins held on exchange addresses in units and percentage. + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/cryptocurrency/due_diligence/glassnode_view.py#L238)] + +```python +openbb.crypto.dd.eb_chart(symbol: str, exchange: str = "aggregated", start_date: Optional[str] = None, end_date: Optional[str] = None, percentage: bool = False, export: str = "", external_axes: Optional[List[matplotlib.axes._axes.Axes]] = None) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| symbol | str | Asset to search active addresses (e.g., BTC) | None | False | +| exchange | str | Exchange to check net position change (possible values are: aggregated, binance, bittrex,
coinex, gate.io, gemini, huobi, kucoin, poloniex, bibox, bigone, bitfinex, hitbtc, kraken,
okex, bithumb, zb.com, cobinhood, bitmex, bitstamp, coinbase, coincheck, luno), by default "aggregated" | aggregated | True | +| start_date | Optional[str] | Initial date (format YYYY-MM-DD) by default 2 years ago | None | True | +| end_date | Optional[str] | Final date (format YYYY-MM-DD) by default 1 year ago | None | True | +| percentage | bool | Show percentage instead of stacked value. | False | True | +| export | str | Export dataframe data to csv,json,xlsx file | | True | +| external_axes | Optional[List[plt.Axes]] | External axes (2 axes are expected in the list), by default None | None | True | + + +--- + +## Returns + +This function does not return anything + +--- + +## Examples + +```python +from openbb_terminal.sdk import openbb +openbb.crypto.dd.eb_chart(symbol="BTC") +``` + +--- + + + diff --git a/website/content/sdk/reference/crypto/dd/events.md b/website/content/sdk/reference/crypto/dd/events.md new file mode 100644 index 000000000000..7672eed24e80 --- /dev/null +++ b/website/content/sdk/reference/crypto/dd/events.md @@ -0,0 +1,91 @@ +--- +title: events +description: The page provides detailed documentation on how to get all events related + to a given cryptocurrency like conferences, start date of futures trading. It also + provides insights into how to sort, limit and export these events using the OpenBBTerminal + methods. +keywords: +- cryptocurrency events +- cryptocurrency futures trading +- cryptocurrency conferences +- sorting cryptocurrency data +- exporting cryptocurrency data +- cryptocurrency +- data frame +- python cryptocurrency project +- CoinPaprika API +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + +Get all events related to given coin like conferences, start date of futures trading etc. + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/cryptocurrency/due_diligence/coinpaprika_model.py#L74)] + +```python +openbb.crypto.dd.events(symbol: str = "BTC", sortby: str = "date", ascend: bool = False) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| symbol | str | Cryptocurrency symbol (e.g. BTC) | BTC | True | +| sortby | str | Key by which to sort data. Every column name is valid
(see for possible values:
https://api.coinpaprika.com/docs#tag/Coins/paths/~1coins~1%7Bcoin_id%7D~1events/get). | date | True | +| ascend | bool | Flag to sort data ascending | False | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | Events found for given coin
Columns: id, date , date_to, name, description, is_conference, link, proof_image_link | +--- + + + + +Prints table showing all events for given coin id. [Source: CoinPaprika] + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/cryptocurrency/due_diligence/coinpaprika_view.py#L132)] + +```python +openbb.crypto.dd.events_chart(symbol: str = "BTC", limit: int = 10, sortby: str = "date", ascend: bool = False, links: bool = False, export: str = "") +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| symbol | str | Cryptocurrency symbol (e.g. BTC) | BTC | True | +| limit | int | Number of records to display | 10 | True | +| sortby | str | Key by which to sort data. Every column name is valid
(see for possible values:
https://api.coinpaprika.com/docs#tag/Coins/paths/~1coins~1%7Bcoin_id%7D~1events/get). | date | True | +| ascend | bool | Flag to sort data ascending | False | True | +| links | bool | Flag to display urls | False | True | +| export | str | Export dataframe data to csv,json,xlsx file | | True | + + +--- + +## Returns + +This function does not return anything + +--- + + + diff --git a/website/content/sdk/reference/crypto/dd/ex.md b/website/content/sdk/reference/crypto/dd/ex.md new file mode 100644 index 000000000000..8893de39c826 --- /dev/null +++ b/website/content/sdk/reference/crypto/dd/ex.md @@ -0,0 +1,89 @@ +--- +title: ex +description: This page provides code documentation and examples for retrieving and + visualizing data about cryptocurrency exchanges for a given coin, using the CoinPaprika + API. The OpenBBTerminal project developed by OpenBB-finance allows sorting the data + and exports it for further analysis. +keywords: +- cryptocurrency +- CoinPaprika +- cryptocurrency exchanges +- data sort +- data visualization +- BTC +- volume share +- data export +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + +Get all exchanges for given coin id. [Source: CoinPaprika] + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/cryptocurrency/due_diligence/coinpaprika_model.py#L137)] + +```python +openbb.crypto.dd.ex(symbol: str = "BTC", sortby: str = "adjusted_volume_24h_share", ascend: bool = True) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| symbol | str | Cryptocurrency symbol (e.g. BTC) | BTC | True | +| sortby | str | Key by which to sort data. Every column name is valid (see for possible values:
https://api.coinpaprika.com/v1). | adjusted_volume_24h_share | True | +| ascend | bool | Flag to sort data ascending | True | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | All exchanges for given coin
Columns: id, name, adjusted_volume_24h_share, fiats | +--- + + + + +Prints table showing all exchanges for given coin id. [Source: CoinPaprika] + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/cryptocurrency/due_diligence/coinpaprika_view.py#L185)] + +```python +openbb.crypto.dd.ex_chart(symbol: str = "btc", limit: int = 10, sortby: str = "adjusted_volume_24h_share", ascend: bool = True, export: str = "") +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| symbol | str | Cryptocurrency symbol (e.g. BTC) | btc | True | +| limit | int | Number of records to display | 10 | True | +| sortby | str | Key by which to sort data. Every column name is valid (see for possible values:
https://api.coinpaprika.com/v1). | adjusted_volume_24h_share | True | +| ascend | bool | Flag to sort data ascending | True | True | +| export | str | Export dataframe data to csv,json,xlsx file | | True | + + +--- + +## Returns + +This function does not return anything + +--- + + + diff --git a/website/content/sdk/reference/crypto/dd/exchanges.md b/website/content/sdk/reference/crypto/dd/exchanges.md new file mode 100644 index 000000000000..514c4cd5a673 --- /dev/null +++ b/website/content/sdk/reference/crypto/dd/exchanges.md @@ -0,0 +1,36 @@ +--- +title: exchanges +description: This page provides the guide on how to use the helper method, which gets + all the exchanges supported by CCXT. +keywords: +- helper method +- CCXT +- exchanges +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Helper method to get all the exchanges supported by ccxt + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/cryptocurrency/due_diligence/ccxt_model.py#L10)] + +```python +openbb.crypto.dd.exchanges() +``` + +--- + +## Parameters + +This function does not take any parameters. + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| List[str] | list of all the exchanges supported by ccxt | +--- diff --git a/website/content/sdk/reference/crypto/dd/fr.md b/website/content/sdk/reference/crypto/dd/fr.md new file mode 100644 index 000000000000..0ea9b0c6d271 --- /dev/null +++ b/website/content/sdk/reference/crypto/dd/fr.md @@ -0,0 +1,85 @@ +--- +title: fr +description: Our docusaurus page provides Python functions that return and display + crypto coin fundraising data. It deals with launch summary, sales rounds, treasury + accounts and metric value launch details. The page also showcases how to export + the data to different file formats. +keywords: +- Crypto coin fundraising data +- Python functions +- Launch Summary +- Sales rounds +- Treasury accounts +- Metric value launch details +- Export data +- Docusaurus page +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + +Returns coin fundraising + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/cryptocurrency/due_diligence/messari_model.py#L637)] + +```python +openbb.crypto.dd.fr(symbol: str) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| symbol | str | Crypto symbol to check fundraising | None | False | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| Tuple[str, pd.DataFrame, pd.DataFrame, pd.DataFrame] | Launch summary,
Sales rounds,
Treasury Accounts,
Metric Value launch details | +--- + + + + +Display coin fundraising + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/cryptocurrency/due_diligence/messari_view.py#L639)] + +```python +openbb.crypto.dd.fr_chart(symbol: str, export: str = "", external_axes: Optional[List[matplotlib.axes._axes.Axes]] = None) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| symbol | str | Crypto symbol to check coin fundraising | None | False | +| export | str | Export dataframe data to csv,json,xlsx file | | True | +| external_axes | Optional[List[plt.Axes]] | External axes (1 axis is expected in the list), by default None | None | True | + + +--- + +## Returns + +This function does not return anything + +--- + + + diff --git a/website/versioned_docs/version-v3/sdk/reference/crypto/dd/get_mt.md b/website/content/sdk/reference/crypto/dd/get_mt.md similarity index 76% rename from website/versioned_docs/version-v3/sdk/reference/crypto/dd/get_mt.md rename to website/content/sdk/reference/crypto/dd/get_mt.md index 3d4c97da07da..1e0eba020a28 100644 --- a/website/versioned_docs/version-v3/sdk/reference/crypto/dd/get_mt.md +++ b/website/content/sdk/reference/crypto/dd/get_mt.md @@ -1,13 +1,26 @@ --- title: get_mt -description: OpenBB SDK Function +description: This page covers the get_mt function, its usage, parameters and return + types. It defines the method to retrieve available messari timeseries in two different + views; Model and Chart. +keywords: +- get_mt function +- messari timeseries +- Model +- Chart +- Source code +- query +- export dataframe +- crypto dd --- +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; -# get_mt - @@ -37,8 +50,6 @@ openbb.crypto.dd.get_mt(only_free: bool = True) | pd.DataFrame | available timeseries | --- - - @@ -70,7 +81,5 @@ This function does not return anything --- - - - \ No newline at end of file + diff --git a/website/content/sdk/reference/crypto/dd/gh.md b/website/content/sdk/reference/crypto/dd/gh.md new file mode 100644 index 000000000000..adccf2d2829c --- /dev/null +++ b/website/content/sdk/reference/crypto/dd/gh.md @@ -0,0 +1,93 @@ +--- +title: gh +description: This is a documentation for GH development activity tool by OpenBB which + includes detailed functionality on how to return lists of Github activity for a + given cryptocurrency with adjustable time intervals. Source codes for model and + chart representations are included. +keywords: +- GH tool +- developer activity +- cryptocurrency +- Github activity +- time interval +- model +- chart +- dataframe +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + +Returns a list of developer activity for a given coin and time interval. + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/cryptocurrency/due_diligence/santiment_model.py#L29)] + +```python +openbb.crypto.dd.gh(symbol: str, dev_activity: bool = False, interval: str = "1d", start_date: Optional[str] = None, end_date: Optional[str] = None) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| symbol | str | Crypto symbol to check github activity | None | False | +| dev_activity | bool | Whether to filter only for development activity | False | True | +| interval | str | Interval frequency (e.g., 1d) | 1d | True | +| start_date | Optional[str] | Initial date like string (e.g., 2021-10-01) | None | True | +| end_date | Optional[str] | End date like string (e.g., 2021-10-01) | None | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | developer activity over time | +--- + + + + +Returns a list of github activity for a given coin and time interval. + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/cryptocurrency/due_diligence/santiment_view.py#L25)] + +```python +openbb.crypto.dd.gh_chart(symbol: str, start_date: Optional[str] = None, dev_activity: bool = False, end_date: Optional[str] = None, interval: str = "1d", export: str = "", external_axes: Optional[List[matplotlib.axes._axes.Axes]] = None) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| symbol | str | Crypto symbol to check github activity | None | False | +| dev_activity | bool | Whether to filter only for development activity | False | True | +| start_date | Optional[str] | Initial date like string (e.g., 2021-10-01) | None | True | +| end_date | Optional[str] | End date like string (e.g., 2021-10-01) | None | True | +| interval | str | Interval frequency (some possible values are: 1h, 1d, 1w) | 1d | True | +| export | str | Export dataframe data to csv,json,xlsx file | | True | +| external_axes | Optional[List[plt.Axes]] | External axes (1 axis is expected in the list), by default None | None | True | + + +--- + +## Returns + +This function does not return anything + +--- + + + diff --git a/website/content/sdk/reference/crypto/dd/gov.md b/website/content/sdk/reference/crypto/dd/gov.md new file mode 100644 index 000000000000..2a967f599950 --- /dev/null +++ b/website/content/sdk/reference/crypto/dd/gov.md @@ -0,0 +1,83 @@ +--- +title: gov +description: This page provides functions for retrieving and viewing data on cryptocurrency + governance using OpenBB's Gov and Gov Chart functions. Check a crypto symbol's governance + and view it in a table or chart format. Also includes option to export data. +keywords: +- cryptocurrency +- governance +- data analysis +- python functions +- gov function +- gov chart function +- crypto symbol +- data export +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + +Returns coin governance + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/cryptocurrency/due_diligence/messari_model.py#L567)] + +```python +openbb.crypto.dd.gov(symbol: str) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| symbol | str | Crypto symbol to check governance | None | False | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| Tuple[str, pd.DataFrame] | Governance summary,
Metric Value with governance details | +--- + + + + +Prints table showing coin governance + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/cryptocurrency/due_diligence/messari_view.py#L602)] + +```python +openbb.crypto.dd.gov_chart(symbol: str, export: str = "") +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| symbol | str | Crypto symbol to check coin governance | None | False | +| export | str | Export dataframe data to csv,json,xlsx file | | True | + + +--- + +## Returns + +This function does not return anything + +--- + + + diff --git a/website/content/sdk/reference/crypto/dd/headlines.md b/website/content/sdk/reference/crypto/dd/headlines.md new file mode 100644 index 000000000000..fc675f665c2b --- /dev/null +++ b/website/content/sdk/reference/crypto/dd/headlines.md @@ -0,0 +1,87 @@ +--- +title: headlines +description: This documentation page details how to implement sentiment analysis for + financial asset symbols using FinBrain's API through the OpenBB Terminal's Python + protocols. It explains the parameters and returns for two functions that handle + model and chart views, showing raw table data and enabling exportation. +keywords: +- sentiment analysis +- financial assets +- ticker symbols +- FinBrain's API +- Python protocols +- model view +- chart view +- raw table data +- exportation +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + +Gets Sentiment analysis provided by FinBrain's API [Source: finbrain]. + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/common/behavioural_analysis/finbrain_model.py#L15)] + +```python +openbb.crypto.dd.headlines(symbol: str) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| symbol | str | Ticker symbol to get the sentiment analysis from | None | False | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | Empty if there was an issue with data retrieval | +--- + + + + +Sentiment analysis from FinBrain for Cryptocurrencies + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/cryptocurrency/due_diligence/finbrain_crypto_view.py#L39)] + +```python +openbb.crypto.dd.headlines_chart(symbol: str, raw: bool = False, export: str = "", external_axes: Optional[List[matplotlib.axes._axes.Axes]] = None) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| symbol | str | Cryptocurrency | None | False | +| raw | False | Display raw table data | False | True | +| export | str | Export dataframe data to csv,json,xlsx file | | True | +| external_axes | Optional[List[plt.Axes]] | External axes (1 axis is expected in the list), by default None | None | True | + + +--- + +## Returns + +This function does not return anything + +--- + + + diff --git a/website/content/sdk/reference/crypto/dd/inv.md b/website/content/sdk/reference/crypto/dd/inv.md new file mode 100644 index 000000000000..0f8f786d3419 --- /dev/null +++ b/website/content/sdk/reference/crypto/dd/inv.md @@ -0,0 +1,89 @@ +--- +title: inv +description: Our inv function provides an overview of coin investors. It provides + a comprehensive list of individual and organizational investors for a specific cryptocurrency. + Additionally, our inv chart function prints a table of these coin investors and + offers the option of exporting this data to various file formats. +keywords: +- coin investors +- cryptocurrency +- investors +- docusaurus page SEO +- functions +- crypto symbols +- data export +- csv +- json +- xlsx +- due diligence +- messari model +- messari view +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + +Returns coin investors + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/cryptocurrency/due_diligence/messari_model.py#L494)] + +```python +openbb.crypto.dd.inv(symbol: str) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| symbol | str | Crypto symbol to check investors | None | False | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| Tuple[pd.DataFrame, pd.DataFrame] | Individuals,
Organizations | +--- + + + + +Prints table showing coin investors + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/cryptocurrency/due_diligence/messari_view.py#L510)] + +```python +openbb.crypto.dd.inv_chart(symbol: str, export: str = "") +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| symbol | str | Crypto symbol to check coin investors | None | False | +| export | str | Export dataframe data to csv,json,xlsx file | | True | + + +--- + +## Returns + +This function does not return anything + +--- + + + diff --git a/website/content/sdk/reference/crypto/dd/links.md b/website/content/sdk/reference/crypto/dd/links.md new file mode 100644 index 000000000000..7395b4a23f44 --- /dev/null +++ b/website/content/sdk/reference/crypto/dd/links.md @@ -0,0 +1,83 @@ +--- +title: links +description: 'This documentation page includes instructions on how to use two specific + functions: ''links'' and ''links_chart'', part of OpenBB''s crypto asset due diligence + utilities. These functions help users understand and demonstrate how to handle crypto + asset links using Python within the OpenBB terminal.' +keywords: +- OpenBB crypto due diligence +- Crypto asset links utility +- Python cryptocurrency utilities +- Crypto symbol link checking +- Dataframe export to CSV, JSON, XLS +- External axes in Python +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + +Returns asset's links + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/cryptocurrency/due_diligence/messari_model.py#L197)] + +```python +openbb.crypto.dd.links(symbol: str) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| symbol | str | Crypto symbol to check links | None | False | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | asset links | +--- + + + + +Prints table showing coin links + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/cryptocurrency/due_diligence/messari_view.py#L249)] + +```python +openbb.crypto.dd.links_chart(symbol: str, export: str = "") +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| symbol | str | Crypto symbol to check links | None | False | +| export | str | Export dataframe data to csv,json,xlsx file | | True | +| external_axes | Optional[List[plt.Axes]] | External axes (1 axis is expected in the list), by default None | None | True | + + +--- + +## Returns + +This function does not return anything + +--- + + + diff --git a/website/content/sdk/reference/crypto/dd/mcapdom.md b/website/content/sdk/reference/crypto/dd/mcapdom.md new file mode 100644 index 000000000000..d74007faca66 --- /dev/null +++ b/website/content/sdk/reference/crypto/dd/mcapdom.md @@ -0,0 +1,95 @@ +--- +title: mcapdom +description: Documentation for mcapdom function in OpenBBTerminal Python package, + providing the tools to retrieve and visualize market dominance data for any given + cryptocurrency over time. The page describes parameters, return values and provides + direct links to the source code. +keywords: +- mcapdom +- market dominance +- crypto dominance +- crypto symbol +- market cap dominance chart +- OpenBB Python functions +- cryptocurrency due diligence +- cryptocurrency market data +- cryptocurrency trading analysis +- financial data visualization +- python finance +- cryptocurrency interval data +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + +Returns market dominance of a coin over time + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/cryptocurrency/due_diligence/messari_model.py#L81)] + +```python +openbb.crypto.dd.mcapdom(symbol: str, interval: str = "1d", start_date: Optional[str] = None, end_date: Optional[str] = None) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| symbol | str | Crypto symbol to check market cap dominance | None | False | +| interval | str | Interval frequency (possible values are: 5m, 15m, 30m, 1h, 1d, 1w) | 1d | True | +| start_date | Optional[str] | Initial date like string (e.g., 2021-10-01) | None | True | +| end_date | Optional[str] | End date like string (e.g., 2021-10-01) | None | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | market dominance percentage over time | +--- + + + + +Plots market dominance of a coin over time + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/cryptocurrency/due_diligence/messari_view.py#L181)] + +```python +openbb.crypto.dd.mcapdom_chart(symbol: str, start_date: Optional[str] = None, end_date: Optional[str] = None, interval: str = "1d", export: str = "", external_axes: Optional[List[matplotlib.axes._axes.Axes]] = None) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| symbol | str | Crypto symbol to check market cap dominance | None | False | +| start_date | Optional[str] | Initial date like string (e.g., 2021-10-01) | None | True | +| end_date | Optional[str] | End date like string (e.g., 2021-10-01) | None | True | +| interval | str | Interval frequency (possible values are: 5m, 15m, 30m, 1h, 1d, 1w) | 1d | True | +| export | str | Export dataframe data to csv,json,xlsx file | | True | +| external_axes | Optional[List[plt.Axes]] | External axes (1 axis is expected in the list), by default None | None | True | + + +--- + +## Returns + +This function does not return anything + +--- + + + diff --git a/website/content/sdk/reference/crypto/dd/mkt.md b/website/content/sdk/reference/crypto/dd/mkt.md new file mode 100644 index 000000000000..2373f1ab843d --- /dev/null +++ b/website/content/sdk/reference/crypto/dd/mkt.md @@ -0,0 +1,90 @@ +--- +title: mkt +description: An extensive guide and source code for working with cryptocurrency market + data from the CoinPaprika API using Python with OpenBB finance. It includes sections + on how to fetch all markets for a given cryptocurrency and print tables that display + market information. +keywords: +- CoinPaprika API +- cryptocurrency market data +- OpenBB finance +- cryptocurrency +- data fetching +- market tables +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + +All markets for given coin and currency [Source: CoinPaprika] + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/cryptocurrency/due_diligence/coinpaprika_model.py#L176)] + +```python +openbb.crypto.dd.mkt(symbol: str = "BTC", quotes: str = "USD", sortby: str = "pct_volume_share", ascend: bool = True) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| symbol | str | Cryptocurrency symbol (e.g. BTC) | BTC | True | +| quotes | str | Comma separated list of quotes to return.
Example: quotes=USD,BTC
Allowed values:
BTC, ETH, USD, EUR, PLN, KRW, GBP, CAD, JPY, RUB, TRY, NZD, AUD, CHF, UAH, HKD, SGD, NGN,
PHP, MXN, BRL, THB, CLP, CNY, CZK, DKK, HUF, IDR, ILS, INR, MYR, NOK, PKR, SEK, TWD, ZAR,
VND, BOB, COP, PEN, ARS, ISK | USD | True | +| sortby | str | Key by which to sort data. Every column name is valid (see for possible values:
https://api.coinpaprika.com/v1). | pct_volume_share | True | +| ascend | bool | Flag to sort data ascending | True | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | All markets for given coin and currency | +--- + + + + +Prints table showing all markets for given coin id. [Source: CoinPaprika] + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/cryptocurrency/due_diligence/coinpaprika_view.py#L230)] + +```python +openbb.crypto.dd.mkt_chart(from_symbol: str = "BTC", to_symbol: str = "USD", limit: int = 20, sortby: str = "pct_volume_share", ascend: bool = True, links: bool = False, export: str = "") +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| from_symbol | str | Cryptocurrency symbol (e.g. BTC) | BTC | True | +| to_symbol | str | Quoted currency | USD | True | +| limit | int | Number of records to display | 20 | True | +| sortby | str | Key by which to sort data. Every column name is valid (see for possible values:
https://api.coinpaprika.com/v1). | pct_volume_share | True | +| ascend | bool | Flag to sort data ascending | True | True | +| links | bool | Flag to display urls | False | True | +| export | str | Export dataframe data to csv,json,xlsx file | | True | + + +--- + +## Returns + +This function does not return anything + +--- + + + diff --git a/website/content/sdk/reference/crypto/dd/mt.md b/website/content/sdk/reference/crypto/dd/mt.md new file mode 100644 index 000000000000..079df8539f8d --- /dev/null +++ b/website/content/sdk/reference/crypto/dd/mt.md @@ -0,0 +1,97 @@ +--- +title: mt +description: The page includes details about different functions used in cryptocurrency + due diligence, specifically handling and plotting Messari timeseries data. This + includes parameters and return values for each function, including the crypto symbol, + timeseries_id, interval frequency, start and end date. Also discusses exporting + these dataframes and using matplotlib for visualizing data. +keywords: +- messari_timeseries +- crypto_symbol +- timeseries_id +- start_date +- end_date +- interval_frequency +- export_dataframe +- cryptocurrency_due_diligence +- openbb_terminal +- OpenBB-finance +- matplotlib +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + +Returns messari timeseries + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/cryptocurrency/due_diligence/messari_model.py#L124)] + +```python +openbb.crypto.dd.mt(symbol: str, timeseries_id: str, interval: str = "1d", start_date: Optional[str] = None, end_date: Optional[str] = None) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| symbol | str | Crypto symbol to check messari timeseries | None | False | +| timeseries_id | str | Messari timeserie id | None | False | +| interval | str | Interval frequency (possible values are: 5m, 15m, 30m, 1h, 1d, 1w) | 1d | True | +| start | Optional[str] | Initial date like string (e.g., 2021-10-01) | None | True | +| end | Optional[str] | End date like string (e.g., 2021-10-01) | None | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| Tuple[pd.DataFrame, str] | Messari timeseries over time,
Timeseries title | +--- + + + + +Plots messari timeseries + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/cryptocurrency/due_diligence/messari_view.py#L103)] + +```python +openbb.crypto.dd.mt_chart(symbol: str, timeseries_id: str, start_date: Optional[str] = None, end_date: Optional[str] = None, interval: str = "1d", export: str = "", external_axes: Optional[List[matplotlib.axes._axes.Axes]] = None) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| symbol | str | Crypto symbol to check market cap dominance | None | False | +| timeseries_id | str | Obtained by api.crypto.dd.get_mt command | None | False | +| start_date | Optional[str] | Initial date like string (e.g., 2021-10-01) | None | True | +| end_date | Optional[str] | End date like string (e.g., 2021-10-01) | None | True | +| interval | str | Interval frequency (possible values are: 5m, 15m, 30m, 1h, 1d, 1w) | 1d | True | +| export | str | Export dataframe data to csv,json,xlsx file | | True | +| external_axes | Optional[List[plt.Axes]] | External axes (1 axis is expected in the list), by default None | None | True | + + +--- + +## Returns + +This function does not return anything + +--- + + + diff --git a/website/content/sdk/reference/crypto/dd/news.md b/website/content/sdk/reference/crypto/dd/news.md new file mode 100644 index 000000000000..7fcb0716ca4d --- /dev/null +++ b/website/content/sdk/reference/crypto/dd/news.md @@ -0,0 +1,90 @@ +--- +title: news +description: Detailed information on how to fetch recent cryptocurrency posts from + CryptoPanic news aggregator using OpenBB in Python. Also, understand about the news + filtering parameters available and how to display the news content. +keywords: +- CryptoPanic +- News Aggregator +- News Filtering +- Python Code +- Cryptocurrency News +- Github Source Code +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + +Get recent posts from CryptoPanic news aggregator platform. [Source: https://cryptopanic.com/] + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/cryptocurrency/overview/cryptopanic_model.py#L158)] + +```python +openbb.crypto.dd.news(limit: int = 60, post_kind: str = "news", filter_: Optional[str] = None, region: str = "en", source: Optional[str] = None, symbol: Optional[str] = None, sortby: str = "published_at", ascend: bool = True) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| limit | int | number of news to fetch | 60 | True | +| post_kind | str | Filter by category of news. Available values: news or media. | news | True | +| filter_ | Optional[str] | Filter by kind of news. One from list: rising|hot|bullish|bearish|important|saved|lol | None | True | +| region | str | Filter news by regions. Available regions are: en (English), de (Deutsch), nl (Dutch),
es (Español), fr (Français), it (Italiano), pt (Português), ru (Русский) | en | True | +| sortby | str | Key to sort by. | published_at | True | +| ascend | bool | Sort in ascend order. | True | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | DataFrame with recent news from different sources filtered by provided parameters. | +--- + + + + +Prints table showing recent posts from CryptoPanic news aggregator platform. + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/cryptocurrency/due_diligence/cryptopanic_view.py#L18)] + +```python +openbb.crypto.dd.news_chart(post_kind: str = "news", region: str = "en", filter_: Optional[str] = None, source: Optional[str] = None, symbol: Optional[str] = None, limit: int = 25, ascend: bool = True, export: str = "") +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| limit | int | number of news to display | 25 | True | +| post_kind | str | Filter by category of news. Available values: news or media. | news | True | +| filter_ | Optional[str] | Filter by kind of news. One from list: rising|hot|bullish|bearish|important|saved|lol | None | True | +| region | str | Filter news by regions. Available regions are: en (English), de (Deutsch), nl (Dutch),
es (Español), fr (Français), it (Italiano), pt (Português), ru (Русский) | en | True | +| ascend | bool | Sort in ascending order. | True | True | +| export | str | Export dataframe data to csv,json,xlsx file | | True | + + +--- + +## Returns + +This function does not return anything + +--- + + + diff --git a/website/content/sdk/reference/crypto/dd/nonzero.md b/website/content/sdk/reference/crypto/dd/nonzero.md new file mode 100644 index 000000000000..44e73a3dbd7a --- /dev/null +++ b/website/content/sdk/reference/crypto/dd/nonzero.md @@ -0,0 +1,89 @@ +--- +title: nonzero +description: Documentation page for OpenBB's nonzero function and nonzero_chart function. + These functions are used to retrieve addresses with a non-zero balance of a certain + symbol and plot them respectively. +keywords: +- nonzero function +- nonzero_chart function +- addresses with non-zero balance +- cryptocurrency +- dataframe +- BTC +- chart plotting +- export data +- due diligence +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + +Returns addresses with non-zero balance of a certain symbol + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/cryptocurrency/due_diligence/glassnode_model.py#L249)] + +```python +openbb.crypto.dd.nonzero(symbol: str, start_date: str = "2010-01-01", end_date: Optional[str] = None) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| symbol | str | Asset to search (e.g., BTC) | None | False | +| start_date | str | Initial date, format YYYY-MM-DD | 2010-01-01 | True | +| end_date | str | Final date, format YYYY-MM-DD | None | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | addresses with non-zero balances | +--- + + + + +Plots addresses with non-zero balance of a certain symbol + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/cryptocurrency/due_diligence/glassnode_view.py#L96)] + +```python +openbb.crypto.dd.nonzero_chart(symbol: str, start_date: str = "2010-01-01", end_date: Optional[str] = None, export: str = "", external_axes: Optional[List[matplotlib.axes._axes.Axes]] = None) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| symbol | str | Asset to search (e.g., BTC) | None | False | +| start_date | str | Initial date, format YYYY-MM-DD | 2010-01-01 | True | +| end_date | Optional[str] | Final date, format YYYY-MM-DD | None | True | +| export | str | Export dataframe data to csv,json,xlsx file | | True | +| external_axes | Optional[List[plt.Axes]] | External axes (1 axis is expected in the list), by default None | None | True | + + +--- + +## Returns + +This function does not return anything + +--- + + + diff --git a/website/content/sdk/reference/crypto/dd/ob.md b/website/content/sdk/reference/crypto/dd/ob.md new file mode 100644 index 000000000000..c8f3fd67f78f --- /dev/null +++ b/website/content/sdk/reference/crypto/dd/ob.md @@ -0,0 +1,90 @@ +--- +title: ob +description: This documentation page provides detailed information about operation + of generating and viewing order book for a coin in a given exchange using OpenBB + library. Learn about the parameters required and the response for each function + call. +keywords: +- orderbook +- openbb.crypto.dd +- cryptocurrency +- coin exchange +- ob +- ob_chart +- coin symbol +- exchange id +- crypto trading +- matplotlib.axes._axes.Axes +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + +Returns orderbook for a coin in a given exchange + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/cryptocurrency/due_diligence/ccxt_model.py#L46)] + +```python +openbb.crypto.dd.ob(exchange: str, symbol: str, to_symbol: str) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| exchange | str | exchange id | None | False | +| symbol | str | coin symbol | None | False | +| to_symbol | str | currency to compare coin against | None | False | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| Dict[str, Any] | With bids and asks | +--- + + + + +Plots order book for a coin in a given exchange + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/cryptocurrency/due_diligence/ccxt_view.py#L19)] + +```python +openbb.crypto.dd.ob_chart(exchange: str, symbol: str, to_symbol: str, export: str = "", external_axes: Optional[List[matplotlib.axes._axes.Axes]] = None) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| exchange | str | exchange id | None | False | +| symbol | str | coin symbol | None | False | +| vs | str | currency to compare coin against | None | True | +| export | str | Export dataframe data to csv,json,xlsx file | | True | + + +--- + +## Returns + +This function does not return anything + +--- + + + diff --git a/website/content/sdk/reference/crypto/dd/oi.md b/website/content/sdk/reference/crypto/dd/oi.md new file mode 100644 index 000000000000..870fdcf5a307 --- /dev/null +++ b/website/content/sdk/reference/crypto/dd/oi.md @@ -0,0 +1,98 @@ +--- +title: oi +description: This page deals with open interest (OI) in cryptocurrency using OpenBB + terminal. The models and charts displaying open interest by exchange, frequency + and crypto symbol (BTC for instance) are available. You can also review the source + code and instructions on how to use related Python functions. +keywords: +- OI +- Open Interest +- crypto +- symbol +- crypto symbol +- cryptocurrency +- exchange +- price +- frequency +- model +- chart +- parameter +- View +- Source Code +- dataframe +- BTC +- return +- export +- openbb.crypto.dd.oi +- openbb.crypto.dd.oi_chart +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + +Returns open interest by exchange for a certain symbol + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/cryptocurrency/due_diligence/coinglass_model.py#L148)] + +```python +openbb.crypto.dd.oi(symbol: str, interval: int = 0) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| symbol | str | Crypto Symbol to search open interest futures (e.g., BTC) | None | False | +| interval | int | Frequency (possible values are: 0 for ALL, 2 for 1H, 1 for 4H, 4 for 12H), by default 0 | 0 | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | open interest by exchange and price | +--- + + + + +Plots open interest by exchange for a certain cryptocurrency + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/cryptocurrency/due_diligence/coinglass_view.py#L55)] + +```python +openbb.crypto.dd.oi_chart(symbol: str, interval: int = 0, export: str = "") +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| symbol | str | Crypto symbol to search open interest (e.g., BTC) | None | False | +| interval | int | Frequency (possible values are: 0 for ALL, 2 for 1H, 1 for 4H, 4 for 12H), by default 0 | 0 | True | +| export | str | Export dataframe data to csv,json,xlsx file | | True | + + +--- + +## Returns + +This function does not return anything + +--- + + + diff --git a/website/content/sdk/reference/crypto/dd/pi.md b/website/content/sdk/reference/crypto/dd/pi.md new file mode 100644 index 000000000000..f3cdc5475660 --- /dev/null +++ b/website/content/sdk/reference/crypto/dd/pi.md @@ -0,0 +1,85 @@ +--- +title: pi +description: Details about the PI function used in OpenBB crypto due diligence. It + covers aspects like fetching coin product info and presenting it as tables and charts. + Also, includes links to the source code. +keywords: +- Cryptocurrency +- Due Diligence +- pi Function +- Project Info +- Tables +- Charts +- Docusaurus +- Metadata +- Source Code +- Github +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + +Returns coin product info + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/cryptocurrency/due_diligence/messari_model.py#L353)] + +```python +openbb.crypto.dd.pi(symbol: str) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| symbol | str | Crypto symbol to check product info | None | False | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| Tuple[pd.DataFrame, pd.DataFrame, pd.DataFrame, pd.DataFrame] | Metric, Value with project and technology details,
Coin public repos,
Coin audits,
Coin known exploits/vulns | +--- + + + + +Prints table showing project info + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/cryptocurrency/due_diligence/messari_view.py#L470)] + +```python +openbb.crypto.dd.pi_chart(symbol: str, export: str = "") +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| symbol | str | Crypto symbol to check project info | None | False | +| export | str | Export dataframe data to csv,json,xlsx file | | True | + + +--- + +## Returns + +This function does not return anything + +--- + + + diff --git a/website/versioned_docs/version-v3/sdk/reference/crypto/dd/pr.md b/website/content/sdk/reference/crypto/dd/pr.md similarity index 80% rename from website/versioned_docs/version-v3/sdk/reference/crypto/dd/pr.md rename to website/content/sdk/reference/crypto/dd/pr.md index b32bdea84672..15f10cb47945 100644 --- a/website/versioned_docs/version-v3/sdk/reference/crypto/dd/pr.md +++ b/website/content/sdk/reference/crypto/dd/pr.md @@ -1,13 +1,29 @@ --- title: pr -description: OpenBB SDK Function +description: The documentation explains how to leverage APIs for calculating and comparing + potential returns of cryptocurrencies. It details requirements and parameters for + two functions - fetching data for potential returns calculation and function to + record these returns. +keywords: +- cryptocurrency +- potential returns +- coin comparison +- fetch data +- APIs usage +- python functions +- coin calculation +- pr model +- pr chart +- CoinGecko source --- +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; -# pr - @@ -40,8 +56,6 @@ openbb.crypto.dd.pr(main_coin: str, to_symbol: Optional[str] = None, limit: Opti | pd.DataFrame | Potential returns data
Columns: Coin, Current Price, Target Coin, Potential Price, Potential Market Cap ($), Change (%) | --- - - @@ -74,7 +88,5 @@ This function does not return anything --- - - - \ No newline at end of file + diff --git a/website/content/sdk/reference/crypto/dd/ps.md b/website/content/sdk/reference/crypto/dd/ps.md new file mode 100644 index 000000000000..21e5ff02c06e --- /dev/null +++ b/website/content/sdk/reference/crypto/dd/ps.md @@ -0,0 +1,90 @@ +--- +title: ps +description: This page includes an overview of the OpenBB Terminal cryptocurrency + functions ps and ps_chart. The ps function obtains ticker-related information for + a given cryptocurrency and the ps_chart function visualizes trading data for a particular + cryptocurrency. The documentation is inclusive of source code, input parameters, + and expected returns. +keywords: +- Cryptocurrency +- CoinPaprika API +- Python programming +- Market ticker related information +- Cryptocurrency symbols +- Crypto trading data +- Cryptocurrency chart +- Data export +- CSV +- JSON +- XSLX +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + +Get all most important ticker related information for given coin id [Source: CoinPaprika] + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/cryptocurrency/due_diligence/coinpaprika_model.py#L290)] + +```python +openbb.crypto.dd.ps(symbol: str = "BTC", quotes: str = "USD") +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| symbol | str | Cryptocurrency symbol (e.g. BTC) | BTC | True | +| quotes | str | Comma separated quotes to return e.g quotes = USD, BTC | USD | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | Most important ticker related information
Columns: Metric, Value | +--- + + + + +Prints table showing ticker information for single coin [Source: CoinPaprika] + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/cryptocurrency/due_diligence/coinpaprika_view.py#L287)] + +```python +openbb.crypto.dd.ps_chart(from_symbol: str = "BTC", to_symbol: str = "USD", export: str = "") +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| from_symbol | str | Cryptocurrency symbol (e.g. BTC) | BTC | True | +| to_symbol | str | Quoted currency | USD | True | +| export | str | Export dataframe data to csv,json,xlsx | | True | + + +--- + +## Returns + +This function does not return anything + +--- + + + diff --git a/website/content/sdk/reference/crypto/dd/rm.md b/website/content/sdk/reference/crypto/dd/rm.md new file mode 100644 index 000000000000..e1e9a8ad8888 --- /dev/null +++ b/website/content/sdk/reference/crypto/dd/rm.md @@ -0,0 +1,93 @@ +--- +title: rm +description: The page consists of two main components or features. Initially, it details + a function designed to return the roadmap for each individual cryptocurrency, explaining + how data can be sorted and what the output will look like. Later, it describes a + function aimed at plotting the roadmap for each cryptocurrency, including details + on the parameters users will need to understand and adjust for the purpose of the + function. +keywords: +- cryptocurrency +- roadmap +- data sorting +- function parameters +- plotting +- matplotlib +- crypto symbol +- python programming +- dataframe +- reverse order +- export data +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + +Returns coin roadmap + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/cryptocurrency/due_diligence/messari_model.py#L236)] + +```python +openbb.crypto.dd.rm(symbol: str, ascend: bool = True) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| symbol | str | Crypto symbol to check roadmap | None | False | +| ascend | bool | reverse order | True | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | roadmap | +--- + + + + +Plots coin roadmap + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/cryptocurrency/due_diligence/messari_view.py#L284)] + +```python +openbb.crypto.dd.rm_chart(symbol: str, ascend: bool = True, limit: int = 5, export: str = "", external_axes: Optional[List[matplotlib.axes._axes.Axes]] = None) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| symbol | str | Crypto symbol to check roadmap | None | False | +| ascend | bool | reverse order | True | True | +| limit | int | number to show | 5 | True | +| export | str | Export dataframe data to csv,json,xlsx file | | True | +| external_axes | Optional[List[plt.Axes]] | External axes (1 axis is expected in the list), by default None | None | True | + + +--- + +## Returns + +This function does not return anything + +--- + + + diff --git a/website/content/sdk/reference/crypto/dd/show_available_pairs_for_given_symbol.md b/website/content/sdk/reference/crypto/dd/show_available_pairs_for_given_symbol.md new file mode 100644 index 000000000000..20606b2de14b --- /dev/null +++ b/website/content/sdk/reference/crypto/dd/show_available_pairs_for_given_symbol.md @@ -0,0 +1,46 @@ +--- +title: show_available_pairs_for_given_symbol +description: Documentation on the function of showing available pairs for a given + symbol in the OpenBB crypto framework at Coinbase. Default symbol is 'ETH'. Other + symbols include BTC, UNI, LUNA, DOT and more. +keywords: +- crypto +- BTC +- ETH +- UNI +- LUNA +- DOT +- coinbase +- available pairs +- symbol +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Return all available quoted assets for given symbol. [Source: Coinbase] + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/cryptocurrency/due_diligence/coinbase_model.py#L21)] + +```python +openbb.crypto.dd.show_available_pairs_for_given_symbol(symbol: str = "ETH") +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| symbol | str | Uppercase symbol of coin e.g BTC, ETH, UNI, LUNA, DOT ... | ETH | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| Tuple[str, list] | Symbol and list of available pairs | +--- diff --git a/website/content/sdk/reference/crypto/dd/stats.md b/website/content/sdk/reference/crypto/dd/stats.md new file mode 100644 index 000000000000..84bb00a92132 --- /dev/null +++ b/website/content/sdk/reference/crypto/dd/stats.md @@ -0,0 +1,84 @@ +--- +title: stats +description: Discover the statistics module of openbb.crypto.dd using symbol trading + pair and explore the possibility of exporting data to desired file format. Find + detailed parameters and return values to improve your experience. +keywords: +- crypto stats +- coinbase trading +- data export +- API parameters +- dataframe +- crypto trading +- base currency +- ETH-USDT +- UNI-ETH +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + +Get 24 hr stats for the product. Volume is in base currency units. + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/cryptocurrency/due_diligence/coinbase_model.py#L202)] + +```python +openbb.crypto.dd.stats(symbol: str) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| symbol | str | Trading pair of coins on Coinbase e.g ETH-USDT or UNI-ETH | None | False | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | 24h stats for chosen trading pair | +--- + + + + +Prints table showing 24 hr stats for the product. Volume is in base currency units. + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/cryptocurrency/due_diligence/coinbase_view.py#L99)] + +```python +openbb.crypto.dd.stats_chart(symbol: str, export: str = "") +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| symbol | str | Trading pair of coins on Coinbase e.g ETH-USDT or UNI-ETH | None | False | +| export | str | Export dataframe data to csv,json,xlsx file | | True | + + +--- + +## Returns + +This function does not return anything + +--- + + + diff --git a/website/content/sdk/reference/crypto/dd/team.md b/website/content/sdk/reference/crypto/dd/team.md new file mode 100644 index 000000000000..66b2113c77aa --- /dev/null +++ b/website/content/sdk/reference/crypto/dd/team.md @@ -0,0 +1,84 @@ +--- +title: team +description: This page provides documentation on functions used to retrieve and visualize + information about the team behind a specific cryptocurrency. These functions provide + details on individuals and organizations involved in the coin selected, with options + for exporting the data. +keywords: +- cryptocurrency +- team information +- data visualization +- OpenBB crypto +- crypto team analysis +- Python functions +- export data +- crypto due diligence +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + +Returns coin team + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/cryptocurrency/due_diligence/messari_model.py#L419)] + +```python +openbb.crypto.dd.team(symbol: str) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| symbol | str | Crypto symbol to check team | None | False | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| Tuple[pd.DataFrame, pd.DataFrame] | Individuals,
Organizations | +--- + + + + +Prints table showing coin team + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/cryptocurrency/due_diligence/messari_view.py#L556)] + +```python +openbb.crypto.dd.team_chart(symbol: str, export: str = "") +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| symbol | str | Crypto symbol to check coin team | None | False | +| export | str | Export dataframe data to csv,json,xlsx file | | True | + + +--- + +## Returns + +This function does not return anything + +--- + + + diff --git a/website/content/sdk/reference/crypto/dd/tk.md b/website/content/sdk/reference/crypto/dd/tk.md new file mode 100644 index 000000000000..b1ee673f1242 --- /dev/null +++ b/website/content/sdk/reference/crypto/dd/tk.md @@ -0,0 +1,84 @@ +--- +title: tk +description: This page provides documentation for the tk model and chart functions + from the openbb.crypto.dd library. The model function returns coin tokenomics for + a specific cryptocurrency while the chart function plots the same. +keywords: +- cryptocurrency +- tokenomics +- openbb.crypto.dd +- coin tokenomics +- coin tokenomics plot +- programming +- function documentation +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + +Returns coin tokenomics + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/cryptocurrency/due_diligence/messari_model.py#L283)] + +```python +openbb.crypto.dd.tk(symbol: str, coingecko_id: str) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| symbol | str | Crypto symbol to check tokenomics | None | False | +| coingecko_id | str | ID from coingecko | None | False | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| Tuple[pd.DataFrame, pd.DataFrame] | Metric Value tokenomics,
Circulating supply overtime | +--- + + + + +Plots coin tokenomics + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/cryptocurrency/due_diligence/messari_view.py#L386)] + +```python +openbb.crypto.dd.tk_chart(symbol: str, export: str = "", external_axes: Optional[List[matplotlib.axes._axes.Axes]] = None) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| symbol | str | Crypto symbol to check tokenomics | None | False | +| export | str | Export dataframe data to csv,json,xlsx file | | True | +| external_axes | Optional[List[plt.Axes]] | External axes (2 axes are expected in the list), by default None | None | True | + + +--- + +## Returns + +This function does not return anything + +--- + + + diff --git a/website/content/sdk/reference/crypto/dd/tokenomics.md b/website/content/sdk/reference/crypto/dd/tokenomics.md new file mode 100644 index 000000000000..fd4aaef31d2f --- /dev/null +++ b/website/content/sdk/reference/crypto/dd/tokenomics.md @@ -0,0 +1,48 @@ +--- +title: tokenomics +description: Documentation page for the tokenomics function in OpenBBTerminal's cryptocurrency + due diligence module. This Python method takes a coin symbol and gives back the + tokenomics for that coin. +keywords: +- tokenomics +- coin +- cryptocurrency +- pycoingecko_model +- crypto +- dd +- symbol +- coin symbol +- tokenomics source code +- Metric +- Value +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Get tokenomics for given coin. [Source: CoinGecko] + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/cryptocurrency/due_diligence/pycoingecko_model.py#L253)] + +```python +openbb.crypto.dd.tokenomics(symbol: str = "") +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| symbol | str | coin symbol to check tokenomics | | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | Metric, Value with tokenomics | +--- diff --git a/website/content/sdk/reference/crypto/dd/trades.md b/website/content/sdk/reference/crypto/dd/trades.md new file mode 100644 index 000000000000..cf7938127cb0 --- /dev/null +++ b/website/content/sdk/reference/crypto/dd/trades.md @@ -0,0 +1,90 @@ +--- +title: trades +description: Documentation of 'trades' in OpenBB.finance. It includes various functions + for obtaining and displaying trades for a coin in a given exchange. It covers both + the model and view and provides detailed description of each parameter involved. +keywords: +- trades +- exchange +- coin +- currency +- symbol +- OpenBB.finance +- ccxt model +- ccxt view +- trade chart +- crypto +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + +Returns trades for a coin in a given exchange + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/cryptocurrency/due_diligence/ccxt_model.py#L70)] + +```python +openbb.crypto.dd.trades(exchange_id: str, symbol: str, to_symbol: str) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| exchange_id | str | exchange id | None | False | +| symbol | str | coin symbol | None | False | +| to_symbol | str | currency to compare coin against | None | False | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | trades for a coin in a given exchange | +--- + + + + +Prints table showing trades for a coin in a given exchange + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/cryptocurrency/due_diligence/ccxt_view.py#L63)] + +```python +openbb.crypto.dd.trades_chart(exchange: str, symbol: str, to_symbol: str, limit: int = 10, export: str = "") +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| exchange | str | exchange id | None | False | +| symbol | str | coin symbol | None | False | +| to_symbol | str | currency to compare coin against | None | False | +| limit | int | number of trades to display | 10 | True | +| export | str | Export dataframe data to csv,json,xlsx file | | True | + + +--- + +## Returns + +This function does not return anything + +--- + + + diff --git a/website/content/sdk/reference/crypto/dd/trading_pair_info.md b/website/content/sdk/reference/crypto/dd/trading_pair_info.md new file mode 100644 index 000000000000..bd259dd3072b --- /dev/null +++ b/website/content/sdk/reference/crypto/dd/trading_pair_info.md @@ -0,0 +1,47 @@ +--- +title: trading_pair_info +description: The trading_pair_info page provides a detailed guide on how to get essential + trading pair information from Coinbase using the OpenBB API. The tool supports all + significant trading pairs such as ETH-USDT and UNI-ETH. Retrieve the needed data + in a convenient DataFrame format. Check out the source code to learn more. +keywords: +- trading pair info +- coinbase +- crypto trading +- cryptocurrency trading +- API +- ETH-USDT +- UNI-ETH +- dataframe +- due diligence +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Get information about chosen trading pair. [Source: Coinbase] + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/cryptocurrency/due_diligence/coinbase_model.py#L48)] + +```python +openbb.crypto.dd.trading_pair_info(symbol: str) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| symbol | str | Trading pair of coins on Coinbase e.g ETH-USDT or UNI-ETH | None | False | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | Basic information about given trading pair | +--- diff --git a/website/versioned_docs/version-v3/sdk/reference/crypto/dd/trading_pairs.md b/website/content/sdk/reference/crypto/dd/trading_pairs.md similarity index 78% rename from website/versioned_docs/version-v3/sdk/reference/crypto/dd/trading_pairs.md rename to website/content/sdk/reference/crypto/dd/trading_pairs.md index 8ea76d473d96..5a0c65433fac 100644 --- a/website/versioned_docs/version-v3/sdk/reference/crypto/dd/trading_pairs.md +++ b/website/content/sdk/reference/crypto/dd/trading_pairs.md @@ -1,9 +1,23 @@ --- title: trading_pairs -description: OpenBB SDK Function +description: Information and code snippet on how to get all trading pairs on binance + using openbb.crypto.dd.trading_pairs(). Details parameters and returns. +keywords: +- trading pairs +- binance +- openbb.crypto.dd +- cryptocurrency +- due diligence +- openbb terminal +- trading parameters +- API +- ETHBTC symbol +- trading functionality --- -# trading_pairs +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + Helper method that return all trading pairs on binance. Methods ause this data for input for e.g @@ -27,4 +41,3 @@ This function does not take any parameters. | ---- | ----------- | | List[dict] | list of dictionaries in format:
[
{'symbol': 'ETHBTC', 'status': 'TRADING', 'baseAsset': 'ETH', 'baseAssetPrecision': 8,
'quoteAsset': 'BTC', 'quotePrecision': 8, 'quoteAssetPrecision': 8,
'baseCommissionPrecision': 8, 'quoteCommissionPrecision': 8,
'orderTypes': ['LIMIT', 'LIMIT_MAKER', 'MARKET', 'STOP_LOSS_LIMIT', 'TAKE_PROFIT_LIMIT'],
'icebergAllowed': True,
'ocoAllowed': True,
'quoteOrderQtyMarketAllowed': True,
'isSpotTradingAllowed': True,
'isMarginTradingAllowed': True,
'filters': [{'filterType': 'PRICE_FILTER', 'minPrice': '0.00000100',
'maxPrice': '922327.00000000', 'tickSize': '0.00000100'},
{'filterType': 'PERCENT_PRICE', 'multiplierUp': '5', 'multiplierDown': '0.2', 'avgPriceMins': 5},
{'filterType': 'LOT_SIZE', 'minQty': '0.00100000', 'maxQty': '100000.00000000', 'stepSize': '0.00100000'},
{'filterType': 'MIN_NOTIONAL', 'minNotional': '0.00010000', 'applyToMarket': True, 'avgPriceMins': 5},
{'filterType': 'ICEBERG_PARTS', 'limit': 10}, {'filterType': 'MARKET_LOT_SIZE', 'minQty': '0.00000000',
'maxQty': '930.49505347', 'stepSize': '0.00000000'}, {'filterType': 'MAX_NUM_ORDERS', 'maxNumOrders': 200},
{'filterType': 'MAX_NUM_ALGO_ORDERS', 'maxNumAlgoOrders': 5}], 'permissions': ['SPOT', 'MARGIN']},
...
] | --- - diff --git a/website/content/sdk/reference/crypto/dd/twitter.md b/website/content/sdk/reference/crypto/dd/twitter.md new file mode 100644 index 000000000000..1a911d4c9489 --- /dev/null +++ b/website/content/sdk/reference/crypto/dd/twitter.md @@ -0,0 +1,89 @@ +--- +title: twitter +description: Learn how to implement twitter functions for cryptocurrency through our + OpenBB Terminal documentation. Access information such as code usage, parameters, + return types etc. +keywords: +- Cryptocurrency +- Twitter +- Code Documentation +- Sort Data +- CSV +- JSON +- XLSX +- Export Dataframe +- CoinPaprika API +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + +Get twitter timeline for given coin id. Not more than last 50 tweets [Source: CoinPaprika] + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/cryptocurrency/due_diligence/coinpaprika_model.py#L23)] + +```python +openbb.crypto.dd.twitter(symbol: str = "BTC", sortby: str = "date", ascend: bool = True) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| symbol | str | Cryptocurrency symbol (e.g. BTC) | BTC | True | +| sortby | str | Key by which to sort data. Every column name is valid
(see for possible values:
https://api.coinpaprika.com/docs#tag/Coins/paths/~1coins~1%7Bcoin_id%7D~1twitter/get). | date | True | +| ascend | bool | Flag to sort data descending | True | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | Twitter timeline for given coin.
Columns: date, user_name, status, retweet_count, like_count | +--- + + + + +Prints table showing twitter timeline for given coin id. Not more than last 50 tweets [Source: CoinPaprika] + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/cryptocurrency/due_diligence/coinpaprika_view.py#L86)] + +```python +openbb.crypto.dd.twitter_chart(symbol: str = "BTC", limit: int = 10, sortby: str = "date", ascend: bool = True, export: str = "") +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| symbol | str | Cryptocurrency symbol (e.g. BTC) | BTC | True | +| limit | int | Number of records to display | 10 | True | +| sortby | str | Key by which to sort data. Every column name is valid
(see for possible values:
https://api.coinpaprika.com/docs#tag/Coins/paths/~1coins~1%7Bcoin_id%7D~1twitter/get). | date | True | +| ascend | bool | Flag to sort data ascending | True | True | +| export | str | Export dataframe data to csv,json,xlsx file | | True | + + +--- + +## Returns + +This function does not return anything + +--- + + + diff --git a/website/versioned_docs/version-v3/sdk/reference/crypto/defi/anchor_data.md b/website/content/sdk/reference/crypto/defi/anchor_data.md similarity index 76% rename from website/versioned_docs/version-v3/sdk/reference/crypto/defi/anchor_data.md rename to website/content/sdk/reference/crypto/defi/anchor_data.md index 2faaefbd7790..696658718cd8 100644 --- a/website/versioned_docs/version-v3/sdk/reference/crypto/defi/anchor_data.md +++ b/website/content/sdk/reference/crypto/defi/anchor_data.md @@ -1,13 +1,30 @@ --- title: anchor_data -description: OpenBB SDK Function +description: Improve your understanding of the Anchor protocol with the help of our + documentation providing detailed instructions on how to retrieve and plot earnings + data for a specific Terra address. Skim through the parameters, the types, the given + descriptions, and the functionality. +keywords: +- docusaurus +- anchor protocol +- earnings data +- terra address +- parameters +- returns +- model +- view chart +- plot +- transactions history +- export --- +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; -# anchor_data - @@ -37,8 +54,6 @@ openbb.crypto.defi.anchor_data(address: str = "") | Tuple[pd.DataFrame, pd.DataFrame, str] | - pd.DataFrame: Earnings over time in UST
- pd.DataFrame: History of transactions
- str: Overall statistics | --- - - @@ -71,7 +86,5 @@ This function does not return anything --- - - - \ No newline at end of file + diff --git a/website/versioned_docs/version-v3/sdk/reference/crypto/defi/aterra.md b/website/content/sdk/reference/crypto/defi/aterra.md similarity index 78% rename from website/versioned_docs/version-v3/sdk/reference/crypto/defi/aterra.md rename to website/content/sdk/reference/crypto/defi/aterra.md index da5a6645bf55..58de67c57cd5 100644 --- a/website/versioned_docs/version-v3/sdk/reference/crypto/defi/aterra.md +++ b/website/content/sdk/reference/crypto/defi/aterra.md @@ -1,13 +1,27 @@ --- title: aterra -description: OpenBB SDK Function +description: This document provides information about how to fetch historical data + for a specific Terra asset, plot the 30-day history of that asset and explains the + usage of each function. Also includes source code links. +keywords: +- Terra assets +- historical data +- address +- GET request +- Draw chart +- aterra +- meta data +- parameters +- returns --- +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; -# aterra - @@ -38,8 +52,6 @@ openbb.crypto.defi.aterra(asset: str = "ust", address: str = "terra1tmnqgvg567yp | pd.DataFrame | historical data | --- - - @@ -71,7 +83,5 @@ This function does not return anything --- - - - \ No newline at end of file + diff --git a/website/content/sdk/reference/crypto/defi/ayr.md b/website/content/sdk/reference/crypto/defi/ayr.md new file mode 100644 index 000000000000..ee4231c7cf5d --- /dev/null +++ b/website/content/sdk/reference/crypto/defi/ayr.md @@ -0,0 +1,86 @@ +--- +title: ayr +description: This documentation page provides a detailed overview of the Anchor Yield + Reserve's 30-day history. It provides the source code and usage for the `ayr` and + `ayr_chart` functions from the `openbb.crypto.defi` namespace, including parameters + and returns. +keywords: +- docusaurus +- metadata page +- Anchor Yield Reserve +- crypto +- defi +- ayr +- ayr_chart +- crypto.defi +- matplotlib +- dataframe +- parameters +- returns +- 30-day history +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + +Displays the 30-day history of the Anchor Yield Reserve. + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/cryptocurrency/defi/terraengineer_model.py#L63)] + +```python +openbb.crypto.defi.ayr() +``` + +--- + +## Parameters + +This function does not take any parameters. + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | Dataframe containing historical data | +--- + + + + +Plots the 30-day history of the Anchor Yield Reserve. + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/cryptocurrency/defi/terraengineer_view.py#L85)] + +```python +openbb.crypto.defi.ayr_chart(export: str = "", external_axes: Optional[List[matplotlib.axes._axes.Axes]] = None) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| export | str | Export dataframe data to csv,json,xlsx file, by default False | | True | +| external_axes | Optional[List[plt.Axes]] | External axes (1 axis is expected in the list), by default None | None | True | + + +--- + +## Returns + +This function does not return anything + +--- + + + diff --git a/website/content/sdk/reference/crypto/defi/dtvl.md b/website/content/sdk/reference/crypto/defi/dtvl.md new file mode 100644 index 000000000000..482396a22c36 --- /dev/null +++ b/website/content/sdk/reference/crypto/defi/dtvl.md @@ -0,0 +1,90 @@ +--- +title: dtvl +description: This page of the documentation provides information about OpenBB's dtvl + model and view functions. The model function returns details about the historical + Total Value Locked (TVL) of a specified DeFi protocol, while the view function allows + for the plotting of TVL data across various decentralized applications (dApps). +keywords: +- dtvl model +- dtvl view +- DeFi protocol +- historical TVL +- decentralized applications +- dApps +- crypto +- dataframe +- matplotlib +- export data +- function parameters +- digital assets +- crypto analytics +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + +Returns information about historical tvl of a defi protocol. + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/cryptocurrency/defi/llama_model.py#L124)] + +```python +openbb.crypto.defi.dtvl(protocol: str) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| protocol | str | Name of the protocol | None | False | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | Historical tvl | +--- + + + + +Plots historical TVL of different dApps + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/cryptocurrency/defi/llama_view.py#L131)] + +```python +openbb.crypto.defi.dtvl_chart(dapps: str = "", export: str = "", external_axes: Optional[List[matplotlib.axes._axes.Axes]] = None) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| dapps | str | dApps to search historical TVL. Should be split by , e.g.: anchor,sushiswap,pancakeswap | | True | +| export | str | Export dataframe data to csv,json,xlsx file | | True | +| external_axes | Optional[List[plt.Axes]] | External axes (1 axis is expected in the list), by default None | None | True | + + +--- + +## Returns + +This function does not return anything + +--- + + + diff --git a/website/content/sdk/reference/crypto/defi/gacc.md b/website/content/sdk/reference/crypto/defi/gacc.md new file mode 100644 index 000000000000..58ac3fe4237a --- /dev/null +++ b/website/content/sdk/reference/crypto/defi/gacc.md @@ -0,0 +1,86 @@ +--- +title: gacc +description: A detailed insight into the gacc function of Terra Blockchain. This documentation + shows how to effectively fetch Terra blockchain account growth history and how to + plot the related charts using openbb.crypto.defi. +keywords: +- Terra Blockchain +- Account growth history +- openbb.crypto.defi +- gacc function +- Plotting blockchain data +- Cryptocurrency +- Crypto defi +- Blockchain technology +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + +Get terra blockchain account growth history [Source: https://fcd.terra.dev/swagger] + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/cryptocurrency/defi/terramoney_fcd_model.py#L263)] + +```python +openbb.crypto.defi.gacc(cumulative: bool = True) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| cumulative | bool | distinguish between periodical and cumulative account growth data | True | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | historical data of accounts growth | +--- + + + + +Plots terra blockchain account growth history [Source: https://fcd.terra.dev/swagger] + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/cryptocurrency/defi/terramoney_fcd_view.py#L139)] + +```python +openbb.crypto.defi.gacc_chart(kind: str = "total", cumulative: bool = False, limit: int = 90, export: str = "", external_axes: Optional[List[matplotlib.axes._axes.Axes]] = None) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| limit | int | Number of records to display | 90 | True | +| kind | str | display total account count or active account count. One from list [active, total] | total | True | +| cumulative | bool | Flag to show cumulative or discrete values. For active accounts only discrete value are available. | False | True | +| export | str | Export dataframe data to csv,json,xlsx file | | True | +| external_axes | Optional[List[plt.Axes]] | External axes (1 axis is expected in the list), by default None | None | True | + + +--- + +## Returns + +This function does not return anything + +--- + + + diff --git a/website/content/sdk/reference/crypto/defi/gdapps.md b/website/content/sdk/reference/crypto/defi/gdapps.md new file mode 100644 index 000000000000..8cd40e47dbbe --- /dev/null +++ b/website/content/sdk/reference/crypto/defi/gdapps.md @@ -0,0 +1,86 @@ +--- +title: gdapps +description: This page presents features such as the displaying and plotting of top + dApps by TVL, which are part of the DeFi module of the openbb crypto module. Detailed + guides on how to use these features with service parameters such as limit, export + type, and others are included. Links to source code are also provided. +keywords: +- dApps +- TVL +- gdapps +- openbb.crypto.defi +- DeFi protocols +- Chart +- matplotlib +- Export dataframe +- Source code +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + +Display top dApps (in terms of TVL) grouped by chain. + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/cryptocurrency/defi/llama_model.py#L149)] + +```python +openbb.crypto.defi.gdapps(limit: int = 50) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| limit | int | Number of top dApps to display | 50 | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | Information about DeFi protocols grouped by chain | +--- + + + + +Plots top dApps (in terms of TVL) grouped by chain. + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/cryptocurrency/defi/llama_view.py#L28)] + +```python +openbb.crypto.defi.gdapps_chart(limit: int = 50, export: str = "", external_axes: Optional[List[matplotlib.axes._axes.Axes]] = None) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| num | int | Number of top dApps to display | None | True | +| export | str | Export dataframe data to csv,json,xlsx file | | True | +| external_axes | Optional[List[plt.Axes]] | External axes (1 axis is expected in the list), by default None | None | True | + + +--- + +## Returns + +This function does not return anything + +--- + + + diff --git a/website/versioned_docs/version-v3/sdk/reference/crypto/defi/gov_proposals.md b/website/content/sdk/reference/crypto/defi/gov_proposals.md similarity index 79% rename from website/versioned_docs/version-v3/sdk/reference/crypto/defi/gov_proposals.md rename to website/content/sdk/reference/crypto/defi/gov_proposals.md index bdfac6929a15..99550f4b57e6 100644 --- a/website/versioned_docs/version-v3/sdk/reference/crypto/defi/gov_proposals.md +++ b/website/content/sdk/reference/crypto/defi/gov_proposals.md @@ -1,13 +1,26 @@ --- title: gov_proposals -description: OpenBB SDK Function +description: Docusaurus page about Terra blockchain governance proposals, detailing + parameters and functionalities such as sorting, ascending/descending and exporting + data. Includes links to original source and GitHub source. +keywords: +- Terra Blockchain +- Governance Proposals +- Sorting Data +- Ascending +- Descending +- Exporting Data +- Source Code +- Docusaurus Page SEO --- +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; -# gov_proposals - @@ -40,8 +53,6 @@ openbb.crypto.defi.gov_proposals(status: str = "", sortby: str = "id", ascend: b | pd.DataFrame | Terra blockchain governance proposals list | --- - - @@ -74,7 +85,5 @@ This function does not return anything --- - - - \ No newline at end of file + diff --git a/website/content/sdk/reference/crypto/defi/ldapps.md b/website/content/sdk/reference/crypto/defi/ldapps.md new file mode 100644 index 000000000000..e39855c09e33 --- /dev/null +++ b/website/content/sdk/reference/crypto/defi/ldapps.md @@ -0,0 +1,88 @@ +--- +title: ldapps +description: This page provides documentation for ldapps functions used in the OpenBB + finance terminal. These functions retrieve and display information about listed + DeFi protocols, their current Total Valued Locked (TVL), and changes to it. +keywords: +- DeFi protocols +- ldapps +- dApps +- cryptocurrency +- Total Valued Locked (TVL) +- dataframe +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + +Returns information about listed DeFi protocols, their current TVL and changes to it in the last hour/day/week. + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/cryptocurrency/defi/llama_model.py#L35)] + +```python +openbb.crypto.defi.ldapps(limit: int = 100, sortby: str = "", ascend: bool = False, description: bool = False, drop_chain: bool = True) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| limit | int | The number of dApps to display | 100 | True | +| sortby | str | Key by which to sort data | | True | +| ascend | bool | Flag to sort data descending | False | True | +| description | bool | Flag to display description of protocol | False | True | +| drop_chain | bool | Whether to drop the chain column | True | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | Information about DeFi protocols | +--- + + + + +Prints table showing information about listed DeFi protocols, their current TVL and changes to it in + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/cryptocurrency/defi/llama_view.py#L94)] + +```python +openbb.crypto.defi.ldapps_chart(sortby: str, limit: int = 20, ascend: bool = False, description: bool = False, export: str = "") +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| limit | int | Number of records to display | 20 | True | +| sortby | str | Key by which to sort data | None | False | +| ascend | bool | Flag to sort data descending | False | True | +| description | bool | Flag to display description of protocol | False | True | +| export | str | Export dataframe data to csv,json,xlsx file | | True | + + +--- + +## Returns + +This function does not return anything + +--- + + + diff --git a/website/versioned_docs/version-v3/sdk/reference/crypto/defi/luna_supply.md b/website/content/sdk/reference/crypto/defi/luna_supply.md similarity index 77% rename from website/versioned_docs/version-v3/sdk/reference/crypto/defi/luna_supply.md rename to website/content/sdk/reference/crypto/defi/luna_supply.md index 3f20ba0550fa..cd6911e590d0 100644 --- a/website/versioned_docs/version-v3/sdk/reference/crypto/defi/luna_supply.md +++ b/website/content/sdk/reference/crypto/defi/luna_supply.md @@ -1,13 +1,27 @@ --- title: luna_supply -description: OpenBB SDK Function +description: 'Luna Supply documentation: Features two functions that offer supply + history data of the Terra ecosystem, in both numerical (DataFrame) and visual (Chart) + formats. Each function has customisable parameters providing flexibility to users.' +keywords: +- Luna supply +- Terra ecosystem +- Supply history data +- Chart +- Supply type +- Day count +- Export type +- Result limit +- External axes --- +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; -# luna_supply - @@ -38,8 +52,6 @@ openbb.crypto.defi.luna_supply(supply_type: str = "lunaSupplyChallengeStats", da | pd.DataFrame | Dataframe of supply history data | --- - - @@ -72,7 +84,5 @@ This function does not return anything --- - - - \ No newline at end of file + diff --git a/website/content/sdk/reference/crypto/defi/newsletters.md b/website/content/sdk/reference/crypto/defi/newsletters.md new file mode 100644 index 000000000000..117e476be6d6 --- /dev/null +++ b/website/content/sdk/reference/crypto/defi/newsletters.md @@ -0,0 +1,80 @@ +--- +title: newsletters +description: This page provides an understanding of how to scrape all substack newsletters + related to DeFi from a list of urls, and how to print a table of these newsletters. + Users can also learn how to limit the number of records displayed and export the + data to different file formats. +keywords: +- Substack newsletters scrape +- DeFi related newsletters +- openbb.crypto.defi.newsletters() +- Display newsletters table +- Limit records +- Export data +- openbb.crypto.defi.newsletters_chart() +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + +Scrape all substack newsletters from url list. + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/cryptocurrency/defi/substack_model.py#L54)] + +```python +openbb.crypto.defi.newsletters() +``` + +--- + +## Parameters + +This function does not take any parameters. + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | DataFrame with recent news from most popular DeFi related newsletters. | +--- + + + + +Prints table showing DeFi related substack newsletters. + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/cryptocurrency/defi/substack_view.py#L16)] + +```python +openbb.crypto.defi.newsletters_chart(limit: int = 10, export: str = "") +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| limit | int | Number of records to display | 10 | True | +| export | str | Export dataframe data to csv,json,xlsx file | | True | + + +--- + +## Returns + +This function does not return anything + +--- + + + diff --git a/website/content/sdk/reference/crypto/defi/sinfo.md b/website/content/sdk/reference/crypto/defi/sinfo.md new file mode 100644 index 000000000000..5e9fe1c0e3c3 --- /dev/null +++ b/website/content/sdk/reference/crypto/defi/sinfo.md @@ -0,0 +1,87 @@ +--- +title: sinfo +description: Learn how to get staking info for a given Terra account using OpenBB's + API. Explore functionality like viewing luna delegations and summary reports for + the chosen address, displaying staking info for the provided Terra account address, + and exporting dataframe data to csv, json, or xlsx file. +keywords: +- Terra blockchain +- staking info +- luna delegations +- summary report +- export to csv +- export to json +- export to xlsx +- defi +- cryptocurrency +- dataframe +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + +Get staking info for provided terra account [Source: https://fcd.terra.dev/swagger] + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/cryptocurrency/defi/terramoney_fcd_model.py#L105)] + +```python +openbb.crypto.defi.sinfo(address: str = "") +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| address | str | terra blockchain address e.g. terra1jvwelvs7rdk6j3mqdztq5tya99w8lxk6l9hcqg | | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| Tuple[pd.DataFrame, str] | luna delegations and summary report for given address | +--- + + + + +Prints table showing staking info for provided terra account address [Source: https://fcd.terra.dev/swagger] + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/cryptocurrency/defi/terramoney_fcd_view.py#L32)] + +```python +openbb.crypto.defi.sinfo_chart(address: str = "", limit: int = 10, export: str = "") +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| address | str | terra blockchain address e.g. terra1jvwelvs7rdk6j3mqdztq5tya99w8lxk6l9hcqg | | True | +| limit | int | Number of records to display | 10 | True | +| export | str | Export dataframe data to csv,json,xlsx file | | True | + + +--- + +## Returns + +This function does not return anything + +--- + + + diff --git a/website/content/sdk/reference/crypto/defi/sratio.md b/website/content/sdk/reference/crypto/defi/sratio.md new file mode 100644 index 000000000000..ad49cebf2571 --- /dev/null +++ b/website/content/sdk/reference/crypto/defi/sratio.md @@ -0,0 +1,83 @@ +--- +title: sratio +description: This page provides a detailed guide on how to use OpenBB finance's sratio + and sratio_chart functions. These functions retrieve and plot staking ratio history + from terra blockchain which can be useful for DeFi applications. +keywords: +- terra blockchain +- staking ratio history +- OpenBB finance +- openbb crypto defi +- sratio function +- dataframe +- matplotlib +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + +Get terra blockchain staking ratio history [Source: https://fcd.terra.dev/swagger] + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/cryptocurrency/defi/terramoney_fcd_model.py#L287)] + +```python +openbb.crypto.defi.sratio(limit: int = 200) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| limit | int | The number of ratios to show | 200 | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | historical staking ratio | +--- + + + + +Plots terra blockchain staking ratio history [Source: https://fcd.terra.dev/v1] + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/cryptocurrency/defi/terramoney_fcd_view.py#L207)] + +```python +openbb.crypto.defi.sratio_chart(limit: int = 90, export: str = "", external_axes: Optional[List[matplotlib.axes._axes.Axes]] = None) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| limit | int | Number of records to display | 90 | True | +| export | str | Export dataframe data to csv,json,xlsx file | | True | +| external_axes | Optional[List[plt.Axes]] | External axes (1 axis is expected in the list), by default None | None | True | + + +--- + +## Returns + +This function does not return anything + +--- + + + diff --git a/website/content/sdk/reference/crypto/defi/sreturn.md b/website/content/sdk/reference/crypto/defi/sreturn.md new file mode 100644 index 000000000000..9ca0856f5459 --- /dev/null +++ b/website/content/sdk/reference/crypto/defi/sreturn.md @@ -0,0 +1,78 @@ +--- +title: sreturn +description: "Get terra blockchain staking returns history" +keywords: +- blockchain +- terra +- staking +- defi +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + +Get terra blockchain staking returns history [Source: https://fcd.terra.dev/v1] + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/cryptocurrency/defi/terramoney_fcd_model.py#L312)] + +```python +openbb.crypto.defi.sreturn(limit: int = 200) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| limit | int | The number of returns to show | 200 | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | historical staking returns | +--- + + + + +Plots terra blockchain staking returns history [Source: https://fcd.terra.dev/swagger] + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/cryptocurrency/defi/terramoney_fcd_view.py#L254)] + +```python +openbb.crypto.defi.sreturn_chart(limit: int = 90, export: str = "", external_axes: Optional[List[matplotlib.axes._axes.Axes]] = None) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| limit | int | Number of records to display | 90 | True | +| export | str | Export dataframe data to csv,json,xlsx file | | True | +| external_axes | Optional[List[plt.Axes]] | External axes (1 axis is expected in the list), by default None | None | True | + + +--- + +## Returns + +This function does not return anything + +--- + + + diff --git a/website/content/sdk/reference/crypto/defi/stvl.md b/website/content/sdk/reference/crypto/defi/stvl.md new file mode 100644 index 000000000000..2290feebc57f --- /dev/null +++ b/website/content/sdk/reference/crypto/defi/stvl.md @@ -0,0 +1,84 @@ +--- +title: stvl +description: 'The documentation explores the stvl functionality: a tool for returning + and plotting historical values of the total sum of Total Value Locked (TVL) from + all listed protocols. Source code links are included.' +keywords: +- stvl +- Total Value Locked +- cryptocurrency +- historical values +- OpenBB-terminal +- defi +- dataframe +- plotting +- export +- returns +- protocols +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + +Returns historical values of the total sum of TVLs from all listed protocols. + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/cryptocurrency/defi/llama_model.py#L170)] + +```python +openbb.crypto.defi.stvl() +``` + +--- + +## Parameters + +This function does not take any parameters. + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | Historical values of total sum of Total Value Locked from all listed protocols. | +--- + + + + +Plots historical values of the total sum of TVLs from all listed protocols. + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/cryptocurrency/defi/llama_view.py#L188)] + +```python +openbb.crypto.defi.stvl_chart(limit: int = 5, export: str = "", external_axes: Optional[List[matplotlib.axes._axes.Axes]] = None) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| limit | int | Number of records to display, by default 5 | 5 | True | +| export | str | Export dataframe data to csv,json,xlsx file | | True | +| external_axes | Optional[List[plt.Axes]] | External axes (1 axis is expected in the list), by default None | None | True | + + +--- + +## Returns + +This function does not return anything + +--- + + + diff --git a/website/content/sdk/reference/crypto/defi/validators.md b/website/content/sdk/reference/crypto/defi/validators.md new file mode 100644 index 000000000000..2b4ad4c0d907 --- /dev/null +++ b/website/content/sdk/reference/crypto/defi/validators.md @@ -0,0 +1,87 @@ +--- +title: validators +description: The page details the usage and parameters of two functions that work + with 'validators' in the terra system. The 'validators' function provides terra + validators details while the 'validators_chart' function sorts data and provides + the option to export dataframe data. +keywords: +- validators +- terra validators +- terramoney_fcd_model +- openbb.crypto.defi +- votingPower +- voting Power +- terra validators details +- validators chart +- sorting data +- key by which to sort data +- terramoney_fcd_view +- export dataframe data +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + +Get information about terra validators [Source: https://fcd.terra.dev/swagger] + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/cryptocurrency/defi/terramoney_fcd_model.py#L155)] + +```python +openbb.crypto.defi.validators(sortby: str = "votingPower", ascend: bool = True) +``` + +--- + +## Parameters + +This function does not take any parameters. + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | terra validators details | +--- + + + + +Prints table showing information about terra validators [Source: https://fcd.terra.dev/swagger] + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/cryptocurrency/defi/terramoney_fcd_view.py#L64)] + +```python +openbb.crypto.defi.validators_chart(limit: int = 10, sortby: str = "votingPower", ascend: bool = True, export: str = "") +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| limit | int | Number of records to display | 10 | True | +| sortby | str | Key by which to sort data. Choose from:
validatorName, tokensAmount, votingPower, commissionRate, status, uptime | votingPower | True | +| ascend | bool | Flag to sort data descending | True | True | +| export | str | Export dataframe data to csv,json,xlsx file | | True | + + +--- + +## Returns + +This function does not return anything + +--- + + + diff --git a/website/content/sdk/reference/crypto/defi/vaults.md b/website/content/sdk/reference/crypto/defi/vaults.md new file mode 100644 index 000000000000..8a8322f366c6 --- /dev/null +++ b/website/content/sdk/reference/crypto/defi/vaults.md @@ -0,0 +1,131 @@ +--- +title: vaults +description: This page provides detailed information on DeFi Vaults including functions + to get data and tools to visualize this data. The provided functions allow querying + various blockchains and DeFi protocols, and sorting by key metrics such as APY. +keywords: +- DeFi Vaults Information +- openbb.crypto.defi.vaults +- openbb.crypto.defi.vaults_chart +- Blockchain +- DeFi protocol +- Kind of vault +- APY +- ethereum +- polygon +- avalanche +- bsc +- terra +- fantom +- moonriver +- celo +- heco +- okex +- cronos +- arbitrum +- eth +- harmony +- fuse +- defichain +- solana +- optimism +- aave +- acryptos +- alpaca +- anchor +- autofarm +- balancer +- bancor +- beefy +- belt +- compound +- convex +- cream +- curve +- defichain +- geist +- lido +- liquity +- mirror +- pancakeswap +- raydium +- sushi +- tarot +- traderjoe +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + +Get DeFi Vaults Information. DeFi Vaults are pools of funds with an assigned strategy which main goal is to + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/cryptocurrency/defi/coindix_model.py#L107)] + +```python +openbb.crypto.defi.vaults(chain: Optional[str] = None, protocol: Optional[str] = None, kind: Optional[str] = None, ascend: bool = True, sortby: str = "apy") +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| chain | str | Blockchain - one from list [
'ethereum', 'polygon', 'avalanche', 'bsc', 'terra', 'fantom',
'moonriver', 'celo', 'heco', 'okex', 'cronos', 'arbitrum', 'eth',
'harmony', 'fuse', 'defichain', 'solana', 'optimism'
] | None | True | +| protocol | str | DeFi protocol - one from list: [
'aave', 'acryptos', 'alpaca', 'anchor', 'autofarm', 'balancer', 'bancor',
'beefy', 'belt', 'compound', 'convex', 'cream', 'curve', 'defichain', 'geist',
'lido', 'liquity', 'mirror', 'pancakeswap', 'raydium', 'sushi', 'tarot', 'traderjoe',
'tulip', 'ubeswap', 'uniswap', 'venus', 'yearn'
] | None | True | +| kind | str | Kind/type of vault - one from list: ['lp','single','noimploss','stable'] | None | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | Top 100 DeFi Vaults for given chain/protocol sorted by APY. | +--- + + + + +Prints table showing Top DeFi Vaults - pools of funds with an assigned strategy which main goal is to + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/cryptocurrency/defi/coindix_view.py#L19)] + +```python +openbb.crypto.defi.vaults_chart(chain: Optional[str] = None, protocol: Optional[str] = None, kind: Optional[str] = None, limit: int = 10, sortby: str = "apy", ascend: bool = True, link: bool = False, export: str = "") +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| chain | str | Blockchain - one from list [
'ethereum', 'polygon', 'avalanche', 'bsc', 'terra', 'fantom',
'moonriver', 'celo', 'heco', 'okex', 'cronos', 'arbitrum', 'eth',
'harmony', 'fuse', 'defichain', 'solana', 'optimism'
] | None | True | +| protocol | str | DeFi protocol - one from list: [
'aave', 'acryptos', 'alpaca', 'anchor', 'autofarm', 'balancer', 'bancor',
'beefy', 'belt', 'compound', 'convex', 'cream', 'curve', 'defichain', 'geist',
'lido', 'liquity', 'mirror', 'pancakeswap', 'raydium', 'sushi', 'tarot', 'traderjoe',
'tulip', 'ubeswap', 'uniswap', 'venus', 'yearn'
] | None | True | +| kind | str | Kind/type of vault - one from list: ['lp','single','noimploss','stable'] | None | True | +| limit | int | Number of records to display | 10 | True | +| sortby | str | Key by which to sort data | apy | True | +| ascend | bool | Flag to sort data descending | True | True | +| link | bool | Flag to show links | False | True | +| export | str | Export dataframe data to csv,json,xlsx file | | True | + + +--- + +## Returns + +This function does not return anything + +--- + + + diff --git a/website/content/sdk/reference/crypto/disc/categories_keys.md b/website/content/sdk/reference/crypto/disc/categories_keys.md new file mode 100644 index 000000000000..6ee0c16b45e5 --- /dev/null +++ b/website/content/sdk/reference/crypto/disc/categories_keys.md @@ -0,0 +1,38 @@ +--- +title: categories_keys +description: This page provides documentation on the 'categories_keys' function from + OpenBB, which retrieves a list of categories keys in the cryptocurrency domain. +keywords: +- categories_keys +- cryptocurrency +- category keys +- crypto categories +- function +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Get list of categories keys + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/cryptocurrency/discovery/pycoingecko_model.py#L115)] + +```python +openbb.crypto.disc.categories_keys() +``` + +--- + +## Parameters + +This function does not take any parameters. + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| List[str] | List of categories keys | +--- diff --git a/website/content/sdk/reference/crypto/disc/coin_list.md b/website/content/sdk/reference/crypto/disc/coin_list.md new file mode 100644 index 000000000000..23e45547874d --- /dev/null +++ b/website/content/sdk/reference/crypto/disc/coin_list.md @@ -0,0 +1,39 @@ +--- +title: coin_list +description: Technical documentation on how to get a list of coins available on CoinGecko + using the OpenBBTerminal. It includes parameters and returns in form of a pd.DataFrame. +keywords: +- Coin List +- CoinGecko +- Source Code +- Cryptocurrency +- Discovery +- pycoingecko_model +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Get list of coins available on CoinGecko [Source: CoinGecko] + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/cryptocurrency/discovery/pycoingecko_model.py#L339)] + +```python +openbb.crypto.disc.coin_list() +``` + +--- + +## Parameters + +This function does not take any parameters. + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | Coins available on CoinGecko
Columns: id, symbol, name | +--- diff --git a/website/versioned_docs/version-v3/sdk/reference/crypto/disc/coins.md b/website/content/sdk/reference/crypto/disc/coins.md similarity index 78% rename from website/versioned_docs/version-v3/sdk/reference/crypto/disc/coins.md rename to website/content/sdk/reference/crypto/disc/coins.md index c730f8b1c6a7..44459e12f373 100644 --- a/website/versioned_docs/version-v3/sdk/reference/crypto/disc/coins.md +++ b/website/content/sdk/reference/crypto/disc/coins.md @@ -1,13 +1,29 @@ --- title: coins -description: OpenBB SDK Function +description: This page documents the functions for retrieving and displaying cryptocurrency + coin data using the OpenBB Terminal. The main categories explained are 'model' and + 'view', each with descriptions of available parameters and returns. +keywords: +- docusaurus +- metadata +- cryptocurrency +- CoinGecko +- coins data +- dataframe +- model +- view +- sort data +- export data +- coins chart --- +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; -# coins - @@ -40,8 +56,6 @@ openbb.crypto.disc.coins(limit: int = 250, category: str = "", sortby: str = "Sy | pd.DataFrame | N coins | --- - - @@ -74,7 +88,5 @@ This function does not return anything --- - - - \ No newline at end of file + diff --git a/website/content/sdk/reference/crypto/disc/coins_for_given_exchange.md b/website/content/sdk/reference/crypto/disc/coins_for_given_exchange.md new file mode 100644 index 000000000000..72adee14c95f --- /dev/null +++ b/website/content/sdk/reference/crypto/disc/coins_for_given_exchange.md @@ -0,0 +1,44 @@ +--- +title: coins_for_given_exchange +description: The documentation page for the helper method openbb.crypto.disc.coins_for_given_exchange() + for getting all coins available on binance exchange sourced from CoinGecko. Information + includes parameters, returns and source code. +keywords: +- cryptocurrency +- openbb.crypto.disc.coins_for_given_exchange +- binance +- CoinGecko +- trading pairs +- page paging +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Helper method to get all coins available on binance exchange [Source: CoinGecko] + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/cryptocurrency/discovery/pycoingecko_model.py#L357)] + +```python +openbb.crypto.disc.coins_for_given_exchange(exchange_id: str = "binance", page: int = 1) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| exchange_id | str | id of exchange | binance | True | +| page | int | number of page. One page contains 100 records | 1 | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| dict | dictionary with all trading pairs on binance | +--- diff --git a/website/versioned_docs/version-v3/sdk/reference/crypto/disc/cpsearch.md b/website/content/sdk/reference/crypto/disc/cpsearch.md similarity index 83% rename from website/versioned_docs/version-v3/sdk/reference/crypto/disc/cpsearch.md rename to website/content/sdk/reference/crypto/disc/cpsearch.md index b5218d952d6d..85238a22af1e 100644 --- a/website/versioned_docs/version-v3/sdk/reference/crypto/disc/cpsearch.md +++ b/website/content/sdk/reference/crypto/disc/cpsearch.md @@ -1,13 +1,27 @@ --- title: cpsearch -description: OpenBB SDK Function +description: Documentation for 'cpsearch', a cryptocurrency discovery function in + OpenBBTerminal using the CoinPaprika API. This page provides details about parameters, + source code links and data return types. +keywords: +- docusaurus +- cpsearch +- coinPaprika +- cryptocurrency +- search +- crypto discovery +- search parameters +- coinPaprika API +- data analytics --- +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; -# cpsearch - @@ -41,8 +55,6 @@ openbb.crypto.disc.cpsearch(query: str, category: Optional[Any] = None, modifier | pd.DataFrame | Search Results
Columns: Metric, Value | --- - - @@ -76,7 +88,5 @@ This function does not return anything --- - - - \ No newline at end of file + diff --git a/website/content/sdk/reference/crypto/disc/gainers.md b/website/content/sdk/reference/crypto/disc/gainers.md new file mode 100644 index 000000000000..abb1315bb1bf --- /dev/null +++ b/website/content/sdk/reference/crypto/disc/gainers.md @@ -0,0 +1,89 @@ +--- +title: gainers +description: The page provides functionalities regarding Largest Gainers in cryptocurrency, + powered by CoinGecko's API. It contains Python models and charts to display the + coins which gain the most in a given period. Additionally, it provides details on + how to sort and display data, and export data to different file formats. +keywords: +- gainers +- crypto +- coingecko +- model +- chart +- dataframe +- price +- volume +- export +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + +Shows Largest Gainers - coins which gain the most in given period. [Source: CoinGecko] + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/cryptocurrency/discovery/pycoingecko_model.py#L260)] + +```python +openbb.crypto.disc.gainers(interval: str = "1h", limit: int = 50, sortby: str = "market_cap_rank") +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| interval | str | Time interval by which data is displayed. One from [1h, 24h, 7d, 14d, 30d, 60d, 1y] | 1h | True | +| limit | int | Number of records to display | 50 | True | +| sortby | str | Key to sort data. The table can be sorted by every of its columns. Refer to
API documentation (see /coins/markets in https://www.coingecko.com/en/api/documentation) | market_cap_rank | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | Top Gainers - coins which gain most in price in given period of time.
Columns: Symbol, Name, Volume, Price, %Change_{interval}, Url | +--- + + + + +Prints table showing Largest Gainers - coins which gain the most in given period. [Source: CoinGecko] + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/cryptocurrency/discovery/pycoingecko_view.py#L100)] + +```python +openbb.crypto.disc.gainers_chart(interval: str = "1h", limit: int = 20, sortby: str = "market_cap_rank", export: str = "") +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| interval | str | Time period by which data is displayed. One from [1h, 24h, 7d, 14d, 30d, 60d, 1y] | 1h | True | +| limit | int | Number of records to display | 20 | True | +| sortby | str | Key to sort data. The table can be sorted by every of its columns. Refer to
API documentation (see /coins/markets in https://www.coingecko.com/en/api/documentation) | market_cap_rank | True | +| export | str | Export dataframe data to csv,json,xlsx file | | True | + + +--- + +## Returns + +This function does not return anything + +--- + + + diff --git a/website/content/sdk/reference/crypto/disc/losers.md b/website/content/sdk/reference/crypto/disc/losers.md new file mode 100644 index 000000000000..184bef0c90d6 --- /dev/null +++ b/website/content/sdk/reference/crypto/disc/losers.md @@ -0,0 +1,86 @@ +--- +title: losers +description: The 'Losers' page on OpenBBTerminal provides functions that allow users + to find out which cryptocurrencies suffered the largest losses during a given time + period. Documentation includes information on parameters, return types, and source + code. +keywords: +- Cryptocurrency +- Losers +- Price changes +- CoinGecko +- API +- Crypto analysis +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + +Shows Largest Losers - coins which lose the most in given period. [Source: CoinGecko] + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/cryptocurrency/discovery/pycoingecko_model.py#L288)] + +```python +openbb.crypto.disc.losers(interval: str = "1h", limit: int = 50, sortby: str = "market_cap_rank") +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| interval | str | Time interval by which data is displayed. One from [1h, 24h, 7d, 14d, 30d, 60d, 1y] | 1h | True | +| limit | int | Number of records to display | 50 | True | +| sortby | str | Key to sort data. The table can be sorted by every of its columns. Refer to
API documentation (see /coins/markets in https://www.coingecko.com/en/api/documentation) | market_cap_rank | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | Top Losers - coins which lost most in price in given period of time.
Columns: Symbol, Name, Volume, Price, %Change_{interval}, Url | +--- + + + + +Prints table showing Largest Losers - coins which lost the most in given period of time. [Source: CoinGecko] + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/cryptocurrency/discovery/pycoingecko_view.py#L146)] + +```python +openbb.crypto.disc.losers_chart(interval: str = "1h", limit: int = 20, export: str = "", sortby: str = "Market Cap Rank") +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| interval | str | Time period by which data is displayed. One from [1h, 24h, 7d, 14d, 30d, 60d, 1y] | 1h | True | +| limit | int | Number of records to display | 20 | True | +| sortby | str | Key to sort data. The table can be sorted by every of its columns. Refer to
API documentation (see /coins/markets in https://www.coingecko.com/en/api/documentation) | Market Cap Rank | True | +| export | str | Export dataframe data to csv,json,xlsx file | | True | + + +--- + +## Returns + +This function does not return anything + +--- + + + diff --git a/website/content/sdk/reference/crypto/disc/top_coins.md b/website/content/sdk/reference/crypto/disc/top_coins.md new file mode 100644 index 000000000000..0b4db659025f --- /dev/null +++ b/website/content/sdk/reference/crypto/disc/top_coins.md @@ -0,0 +1,62 @@ +--- +title: top_coins +description: This OpenBBTerminal page provides insights on how to get top crypto coins + from sources like CoinGecko and CoinMarketCap using the 'openbb.crypto.disc.top_coins' + function. Parameters, return types, and usage examples are clearly illustrated. +keywords: +- top cryptp coins +- CoinGecko +- openbb.crypto.disc.top_coins +- parameters +- returns +- examples +- CoinMarketCap +- limit parameter +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Get top cryptp coins. + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/cryptocurrency/discovery/sdk_helpers.py#L11)] + +```python +openbb.crypto.disc.top_coins(source: str = "CoinGecko", limit: int = 10) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| source | str | Source of data, by default "CoinGecko" | CoinGecko | True | +| limit | int | Number of coins to return, by default 10 | 10 | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | DataFrame with top coins | +--- + +## Examples + +```python +from openbb_terminal.sdk import openbb +top_coins = openbb.crypto.disc.top_coins() +``` + +``` +To get 30 results from coinmarketcap, use the source parameter and the limit parameter: +``` +```python +top_coins = openbb.crypto.disc.top_coins(source="CoinMarketCap", limit=30) +``` + +--- diff --git a/website/content/sdk/reference/crypto/disc/top_dapps.md b/website/content/sdk/reference/crypto/disc/top_dapps.md new file mode 100644 index 000000000000..390c8544dcd0 --- /dev/null +++ b/website/content/sdk/reference/crypto/disc/top_dapps.md @@ -0,0 +1,87 @@ +--- +title: top_dapps +description: This documentation page provides detailed instructions on how to get + top decentralized applications by daily volume and users. Also includes code for + creating and displaying a chart of such applications. +keywords: +- docusaurus page +- top decentralized applications +- Metadata +- daily volume +- daily users +- chart +- cryptocurrency +- dataframe +- data sorting +- DappRadar +- export dataframe +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + +Get top decentralized applications by daily volume and users [Source: https://dappradar.com/] + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/cryptocurrency/discovery/dappradar_model.py#L209)] + +```python +openbb.crypto.disc.top_dapps(sortby: str = "", limit: int = 10) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| sortby | str | Key by which to sort data | | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | Top decentralized exchanges.
Columns: Name, Category, Protocols, Daily Users, Daily Volume [$] | +--- + + + + +Prints table showing top decentralized exchanges [Source: https://dappradar.com/] + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/cryptocurrency/discovery/dappradar_view.py#L133)] + +```python +openbb.crypto.disc.top_dapps_chart(limit: int = 10, export: str = "", sortby: str = "") +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| limit | int | Number of records to display | 10 | True | +| sortby | str | Key by which to sort data | | True | +| export | str | Export dataframe data to csv,json,xlsx file | | True | + + +--- + +## Returns + +This function does not return anything + +--- + + + diff --git a/website/content/sdk/reference/crypto/disc/top_dexes.md b/website/content/sdk/reference/crypto/disc/top_dexes.md new file mode 100644 index 000000000000..d1bc8f29b84e --- /dev/null +++ b/website/content/sdk/reference/crypto/disc/top_dexes.md @@ -0,0 +1,83 @@ +--- +title: top_dexes +description: The 'top_dexes' page contains information and source code for obtaining + and viewing decentralized exchange data, including daily volume and users. The first + tab shows a model for getting top dexes by specified parameters, while the second + tab displays a function that prints this data in tabular format. +keywords: +- dexes +- decetralized exchange +- daily volume +- data model +- data view +- dappradar +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + +Get top dexes by daily volume and users [Source: https://dappradar.com/] + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/cryptocurrency/discovery/dappradar_model.py#L124)] + +```python +openbb.crypto.disc.top_dexes(sortby: str = "", limit: int = 10) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| sortby | str | Key by which to sort data | | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | Top decentralized exchanges. Columns: Name, Daily Users, Daily Volume [$] | +--- + + + + +Prints table showing top decentralized exchanges [Source: https://dappradar.com/] + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/cryptocurrency/discovery/dappradar_view.py#L97)] + +```python +openbb.crypto.disc.top_dexes_chart(limit: int = 10, export: str = "", sortby: str = "") +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| limit | int | Number of records to display | 10 | True | +| sortby | str | Key by which to sort data | | True | +| export | str | Export dataframe data to csv,json,xlsx file | | True | + + +--- + +## Returns + +This function does not return anything + +--- + + + diff --git a/website/versioned_docs/version-v3/sdk/reference/crypto/disc/top_games.md b/website/content/sdk/reference/crypto/disc/top_games.md similarity index 75% rename from website/versioned_docs/version-v3/sdk/reference/crypto/disc/top_games.md rename to website/content/sdk/reference/crypto/disc/top_games.md index 674cb9dd2fb0..40b99e50f952 100644 --- a/website/versioned_docs/version-v3/sdk/reference/crypto/disc/top_games.md +++ b/website/content/sdk/reference/crypto/disc/top_games.md @@ -1,13 +1,26 @@ --- title: top_games -description: OpenBB SDK Function +description: This page is about the 'top_games' function that fetches the top blockchain + games based on daily volume and users. It provides information about the parameters + needed for the function, its source code and what the function will return. +keywords: +- blockchain games +- daily volume +- daily users +- parameters +- data sorting +- data limit +- data export +- OpenBB crypto --- +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; -# top_games - @@ -38,8 +51,6 @@ openbb.crypto.disc.top_games(sortby: str = "", limit: int = 10) | pd.DataFrame | Top blockchain games. Columns: Name, Daily Users, Daily Volume [$] | --- - - @@ -70,7 +81,5 @@ This function does not return anything --- - - - \ No newline at end of file + diff --git a/website/versioned_docs/version-v3/sdk/reference/crypto/disc/top_nfts.md b/website/content/sdk/reference/crypto/disc/top_nfts.md similarity index 78% rename from website/versioned_docs/version-v3/sdk/reference/crypto/disc/top_nfts.md rename to website/content/sdk/reference/crypto/disc/top_nfts.md index ebcdb122a366..3667f5c282f6 100644 --- a/website/versioned_docs/version-v3/sdk/reference/crypto/disc/top_nfts.md +++ b/website/content/sdk/reference/crypto/disc/top_nfts.md @@ -1,13 +1,24 @@ --- title: top_nfts -description: OpenBB SDK Function +description: Learn how to get and sort top NFT collections data by using OpenBB crypto + discovery tools. Source code, and parameters for customization are provided. +keywords: +- nfts +- Top NFTs +- crypto +- cryptocurrency +- DappRadar +- crypto discovery +- NFT collections --- +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; -# top_nfts - @@ -37,8 +48,6 @@ openbb.crypto.disc.top_nfts(sortby: str = "", limit: int = 10) | pd.DataFrame | NFTs Columns: Name, Protocols, Floor Price [$], Avg Price [$], Market Cap [$], Volume [$] | --- - - @@ -69,7 +78,5 @@ This function does not return anything --- - - - \ No newline at end of file + diff --git a/website/content/sdk/reference/crypto/disc/trending.md b/website/content/sdk/reference/crypto/disc/trending.md new file mode 100644 index 000000000000..5a1ba6a05a8e --- /dev/null +++ b/website/content/sdk/reference/crypto/disc/trending.md @@ -0,0 +1,77 @@ +--- +title: trending +description: This page provides detailed information on trending coins. Users can + learn how to return and view a table of trending coins from CoinGecko using OpenBB's + Python functions. +keywords: +- CoinGecko +- trending coins +- Python functions +- cryptocurrency +- crypto trends +- dataframe +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + +Returns trending coins [Source: CoinGecko] + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/cryptocurrency/discovery/pycoingecko_model.py#L317)] + +```python +openbb.crypto.disc.trending() +``` + +--- + +## Parameters + +This function does not take any parameters. + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | Trending Coins | +--- + + + + +Prints table showing trending coins [Source: CoinGecko] + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/cryptocurrency/discovery/pycoingecko_view.py#L192)] + +```python +openbb.crypto.disc.trending_chart(export: str = "") +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| export | str | Export dataframe data to csv,json,xlsx file | | True | + + +--- + +## Returns + +This function does not return anything + +--- + + + diff --git a/website/content/sdk/reference/crypto/find.md b/website/content/sdk/reference/crypto/find.md new file mode 100644 index 000000000000..05109c130c48 --- /dev/null +++ b/website/content/sdk/reference/crypto/find.md @@ -0,0 +1,61 @@ +--- +title: find +description: 'The page provides the information about a function that can find similar + coins by coin name, symbol or id. The tool supports multiple data sources including: + CoinGecko, CoinPaprika, Binance, and Coinbase and can return the data in a Pandas + DataFrame format.' +keywords: +- find similar coin +- cryptocurrency +- Cryptocurrency search +- CoinGecko +- CoinPaprika +- Binance +- Coinbase +- Data source of coins +- data frame +- openbb.crypto.find +- Crypto search function +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Find similar coin by coin name,symbol or id. + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/cryptocurrency/crypto_models.py#L9)] + +```python +openbb.crypto.find(query: str, source: str = "CoinGecko", key: str = "symbol", limit: int = 10) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| query | str | Cryptocurrency | None | False | +| source | str | Data source of coins. CoinGecko or CoinPaprika or Binance or Coinbase | CoinGecko | True | +| key | str | Searching key (symbol, id, name) | symbol | True | +| limit | int | Number of records to display | 10 | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | DataFrame with 'limit' similar coins | +--- + +## Examples + +```python +from openbb_terminal.sdk import openbb +openbb.crypto.find("polka", "CoinGecko", "name", 25) +``` + +--- diff --git a/website/content/sdk/reference/crypto/load.md b/website/content/sdk/reference/crypto/load.md new file mode 100644 index 000000000000..f06b4259429c --- /dev/null +++ b/website/content/sdk/reference/crypto/load.md @@ -0,0 +1,57 @@ +--- +title: load +description: The documentation page describes the crypto currency load function in + OpenBB's Terminal. It helps to get data for any crypto currency by specifying parameters + such as symbol, start date, interval, exchange, vs_currency, end_date and the source + of the data. It then returns a PD DataFrame with price and volume data. +keywords: +- cryptocurrency +- crypto load +- crypto currency data +- parameters +- CCXT +- CoinGecko +- YahooFinance +- Binance +- PD Dataframe +- interval +- exchange +- vs currency +- symbol +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Load crypto currency to get data for + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/cryptocurrency/cryptocurrency_helpers.py#L488)] + +```python +openbb.crypto.load(symbol: str, start_date: Union[datetime.datetime, str, NoneType] = None, interval: Union[str, int] = "1440", exchange: str = "binance", vs_currency: str = "usdt", end_date: Union[datetime.datetime, str, NoneType] = None, source: str = "CCXT") +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| symbol | str | Coin to get | None | False | +| start_date | Union[datetime, Union[str, None]] | Start date to get data from with. - datetime or string format (YYYY-MM-DD) | None | True | +| interval | Union[str, int] | The interval between data points in minutes.
Choose from: 1, 15, 30, 60, 240, 1440, 10080, 43200 | 1440 | True | +| exchange | str: | The exchange to get data from. | binance | True | +| vs_currency | str | Quote Currency (Defaults to usdt) | usdt | True | +| end_date | Union[datetime, Union[str, None]] | End date to get data from with. - datetime or string format (YYYY-MM-DD) | None | True | +| source | str | The source of the data
Choose from: CCXT, CoinGecko, YahooFinance | CCXT | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | Dataframe consisting of price and volume data | +--- diff --git a/website/content/sdk/reference/crypto/nft/collections.md b/website/content/sdk/reference/crypto/nft/collections.md new file mode 100644 index 000000000000..44d72cc56607 --- /dev/null +++ b/website/content/sdk/reference/crypto/nft/collections.md @@ -0,0 +1,79 @@ +--- +title: collections +description: This documentation page provides methods to get NFT collections, its + source code and ways to visualize the data via charts. The content primarily revolves + around usage, parameters, and the return type of the functions. +keywords: +- Docusaurus +- Marketing +- NFT +- Collections +- Chart +- nftpricefloor +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + +Get nft collections [Source: https://nftpricefloor.com/] + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/cryptocurrency/nft/nftpricefloor_model.py#L24)] + +```python +openbb.crypto.nft.collections() +``` + +--- + +## Parameters + +This function does not take any parameters. + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | nft collections | +--- + + + + +Display NFT collections. [Source: https://nftpricefloor.com/] + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/cryptocurrency/nft/nftpricefloor_view.py#L27)] + +```python +openbb.crypto.nft.collections_chart(show_fp: bool = False, show_sales: bool = False, limit: int = 5, export: str = "") +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| show_fp | bool | Show NFT Price Floor for top collections | False | True | +| limit | int | Number of NFT collections to display | 5 | True | +| export | str | Export dataframe data to csv,json,xlsx file | | True | + + +--- + +## Returns + +This function does not return anything + +--- + + + diff --git a/website/content/sdk/reference/crypto/nft/fp.md b/website/content/sdk/reference/crypto/nft/fp.md new file mode 100644 index 000000000000..83c8c3d3a1f5 --- /dev/null +++ b/website/content/sdk/reference/crypto/nft/fp.md @@ -0,0 +1,84 @@ +--- +title: fp +description: The page provides detailed documentation on the functionality of nftpricefloor + model and view. The model helps to fetch NFT collections and the view function displays + the collection's floor price overtime. +keywords: +- NFT collection +- nftpricefloor +- openbb.crypto.nft.fp +- openbb.crypto.nft.fp_chart +- Data Visualization +- Data Modelling +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + +Get nft collections [Source: https://nftpricefloor.com/] + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/cryptocurrency/nft/nftpricefloor_model.py#L46)] + +```python +openbb.crypto.nft.fp(slug: str) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| slug | str | nft collection slug | None | False | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | nft collections | +--- + + + + +Display NFT collection floor price over time. [Source: https://nftpricefloor.com/] + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/cryptocurrency/nft/nftpricefloor_view.py#L88)] + +```python +openbb.crypto.nft.fp_chart(slug: str, limit: int = 10, export: str = "", external_axes: Optional[List[matplotlib.axes._axes.Axes]] = None, raw: bool = False) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| slug | str | NFT collection slug | None | False | +| raw | bool | Flag to display raw data | False | True | +| limit | int | Number of raw data to show | 10 | True | +| export | str | Format to export data | | True | +| external_axes | Optional[List[plt.Axes]] | External axes (2 axes are expected in the list), by default None | None | True | + + +--- + +## Returns + +This function does not return anything + +--- + + + diff --git a/website/content/sdk/reference/crypto/nft/stats.md b/website/content/sdk/reference/crypto/nft/stats.md new file mode 100644 index 000000000000..ca756f876546 --- /dev/null +++ b/website/content/sdk/reference/crypto/nft/stats.md @@ -0,0 +1,83 @@ +--- +title: stats +description: This page consists of detailed guidelines on how to utilise stats and + stats_chart functions. It shows how one can leverage these functions to get NFT + collection stats and print tables showcasing these stats, respectively sourced from + opensea.io. +keywords: +- stats function +- stats_chart function +- NFT collection stats +- OpenSea data +- NFT data +- slug +- data export +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + +Get stats of a nft collection [Source: opensea.io] + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/cryptocurrency/nft/opensea_model.py#L17)] + +```python +openbb.crypto.nft.stats(slug: str) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| slug | str | Opensea collection slug. If the name of the collection is Mutant Ape Yacht Club the slug is mutant-ape-yacht-club | None | False | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | collection stats | +--- + + + + +Prints table showing collection stats. [Source: opensea.io] + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/cryptocurrency/nft/opensea_view.py#L15)] + +```python +openbb.crypto.nft.stats_chart(slug: str, export: str) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| slug | str | Opensea collection slug.
If the name of the collection is Mutant Ape Yacht Club the slug is mutant-ape-yacht-club | None | False | +| export | str | Export dataframe data to csv,json,xlsx file | None | False | + + +--- + +## Returns + +This function does not return anything + +--- + + + diff --git a/website/content/sdk/reference/crypto/onchain/baas.md b/website/content/sdk/reference/crypto/onchain/baas.md new file mode 100644 index 000000000000..efb2202409d3 --- /dev/null +++ b/website/content/sdk/reference/crypto/onchain/baas.md @@ -0,0 +1,94 @@ +--- +title: baas +description: The 'baas' page details how to get average bid and ask prices, as well + as the average spread for a given crypto pair over a chosen time period in OpenBBTerminal. + It explains how to use various parameters for sorting and exporting data. +keywords: +- baas +- crypto pair +- average bid and ask prices +- average spread +- time period +- ERC20 token symbol +- Quoted currency +- sort data +- data ascending +- Export dataframe +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + +Get an average bid and ask prices, average spread for given crypto pair for chosen time period. + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/cryptocurrency/onchain/bitquery_model.py#L725)] + +```python +openbb.crypto.onchain.baas(symbol: str = "WETH", to_symbol: str = "USDT", limit: int = 10, sortby: str = "date", ascend: bool = True) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| symbol | str | ERC20 token symbol | WETH | True | +| to_symbol | str | Quoted currency. | USDT | True | +| limit | int | Last n days to query data | 10 | True | +| sortby | str | Key by which to sort data | date | True | +| ascend | bool | Flag to sort data ascending | True | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | Average bid and ask prices, spread for given crypto pair for chosen time period | +--- + + + + +Prints table showing an average bid and ask prices, average spread for given crypto pair for chosen + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/cryptocurrency/onchain/bitquery_view.py#L346)] + +```python +openbb.crypto.onchain.baas_chart(symbol: str = "WETH", to_symbol: str = "USDT", limit: int = 10, sortby: str = "date", ascend: bool = True, export: str = "") +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| symbol | str | ERC20 token symbol | WETH | True | +| to_symbol | str | Quoted currency. | USDT | True | +| limit | int | Last n days to query data | 10 | True | +| sortby | str | Key by which to sort data | date | True | +| ascend | bool | Flag to sort data ascending | True | True | +| export | str | Export dataframe data to csv,json,xlsx file | | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | Average bid and ask prices, spread for given crypto pair for chosen time period | +--- + + + diff --git a/website/content/sdk/reference/crypto/onchain/balance.md b/website/content/sdk/reference/crypto/onchain/balance.md new file mode 100644 index 000000000000..faa47b9342ff --- /dev/null +++ b/website/content/sdk/reference/crypto/onchain/balance.md @@ -0,0 +1,89 @@ +--- +title: balance +description: This page provides information on how to use OpenBB's onchain tools for + interacting with the Ethereum blockchain. It includes instructions on how to get + information about token balances and displaying this information in a chart format. + Relevant Python code is also provided. +keywords: +- Docusaurus +- Onchain +- ethplorer +- Ethereum blockchain +- Blockchain balance +- Tokens +- ETH balance +- Source code +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + +Get info about tokens on you ethereum blockchain balance. Eth balance, balance of all tokens which + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/cryptocurrency/onchain/ethplorer_model.py#L196)] + +```python +openbb.crypto.onchain.balance(address: str, sortby: str = "index", ascend: bool = False) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| address | str | Blockchain balance e.g. 0x3cD751E6b0078Be393132286c442345e5DC49699 | None | False | +| sortby | str | Key to sort by. | index | True | +| ascend | str | Sort in descending order. | False | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | DataFrame with list of tokens and their balances. | +--- + + + + +Display info about tokens for given ethereum blockchain balance e.g. ETH balance, + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/cryptocurrency/onchain/ethplorer_view.py#L21)] + +```python +openbb.crypto.onchain.balance_chart(address: str, limit: int = 15, sortby: str = "index", ascend: bool = False, export: str = "") +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| address | str | Ethereum balance. | None | False | +| limit | int | Limit of transactions. Maximum 100 | 15 | True | +| sortby | str | Key to sort by. | index | True | +| ascend | str | Sort in descending order. | False | True | +| export | str | Export dataframe data to csv,json,xlsx file | | True | + + +--- + +## Returns + +This function does not return anything + +--- + + + diff --git a/website/content/sdk/reference/crypto/onchain/btc_supply.md b/website/content/sdk/reference/crypto/onchain/btc_supply.md new file mode 100644 index 000000000000..6534468c8f4f --- /dev/null +++ b/website/content/sdk/reference/crypto/onchain/btc_supply.md @@ -0,0 +1,86 @@ +--- +title: btc_supply +description: This documentation page provides codes and guidelines on how to obtain + information about the circulating supply of Bitcoin (BTC) through OpenBBTerminal's + onchain modules. It details the function to use, parameters needed, and the expected + returns. +keywords: +- Bitcoin circulating supply +- BTC supply +- Blockchain information +- Cryptocurrency +- Onchain +- Data +- API +- Source code +- Function +- Parameters +- Returns +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + +Returns BTC circulating supply [Source: https://api.blockchain.info/] + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/cryptocurrency/onchain/blockchain_model.py#L43)] + +```python +openbb.crypto.onchain.btc_supply() +``` + +--- + +## Parameters + +This function does not take any parameters. + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | BTC circulating supply | +--- + + + + +Returns BTC circulating supply [Source: https://api.blockchain.info/] + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/cryptocurrency/onchain/blockchain_view.py#L28)] + +```python +openbb.crypto.onchain.btc_supply_chart(start_date: str = "2010-01-01", end_date: Optional[str] = None, export: str = "", external_axes: Optional[List[matplotlib.axes._axes.Axes]] = None) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| start_date | str | Initial date, format YYYY-MM-DD | 2010-01-01 | True | +| end_date | Optional[str] | Final date, format YYYY-MM-DD | None | True | +| export | str | Export dataframe data to csv,json,xlsx file | | True | +| external_axes | Optional[List[plt.Axes]] | External axes (1 axis is expected in the list), by default None | None | True | + + +--- + +## Returns + +This function does not return anything + +--- + + + diff --git a/website/content/sdk/reference/crypto/onchain/btc_transac.md b/website/content/sdk/reference/crypto/onchain/btc_transac.md new file mode 100644 index 000000000000..872ee0338689 --- /dev/null +++ b/website/content/sdk/reference/crypto/onchain/btc_transac.md @@ -0,0 +1,81 @@ +--- +title: btc_transac +description: This documentation page provides code and information about retrieving + and visualizing BTC confirmed transactions using OpenBB. It includes python code + and detailed parameters' description for the functions. +keywords: +- BTC confirmed transactions +- API +- blockchain.info +- Data Export +- Data Visualization +- crypto.onchain.btc_transac +- crypto.onchain.btc_transac_chart +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + +Returns BTC confirmed transactions [Source: https://api.blockchain.info/] + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/cryptocurrency/onchain/blockchain_model.py#L62)] + +```python +openbb.crypto.onchain.btc_transac() +``` + +--- + +## Parameters + +This function does not take any parameters. + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | BTC confirmed transactions | +--- + + + + +Returns BTC confirmed transactions [Source: https://api.blockchain.info/] + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/cryptocurrency/onchain/blockchain_view.py#L88)] + +```python +openbb.crypto.onchain.btc_transac_chart(start_date: str = "2010-01-01", end_date: Optional[str] = None, export: str = "", external_axes: Optional[List[matplotlib.axes._axes.Axes]] = None) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| start_date | str | Initial date, format YYYY-MM-DD | 2010-01-01 | True | +| end_date | Optional[str] | Final date, format YYYY-MM-DD | None | True | +| export | str | Export dataframe data to csv,json,xlsx file | | True | +| external_axes | Optional[List[plt.Axes]] | External axes (1 axis is expected in the list), by default None | None | True | + + +--- + +## Returns + +This function does not return anything + +--- + + + diff --git a/website/content/sdk/reference/crypto/onchain/dex_trades_monthly.md b/website/content/sdk/reference/crypto/onchain/dex_trades_monthly.md new file mode 100644 index 000000000000..d80d3afab4c8 --- /dev/null +++ b/website/content/sdk/reference/crypto/onchain/dex_trades_monthly.md @@ -0,0 +1,47 @@ +--- +title: dex_trades_monthly +description: Provides access to aggregated data of trades executed on Decentralized + Exchanges. You can set the currency of trade amount, limit the number of days and + even sort the data as required. +keywords: +- dex_trades_monthly +- Decentralized Exchanges +- Trades data +- openbb_crypto_onchain +- trade_amount_currency +- USD +- limit +- ascend +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Get list of trades on Decentralized Exchanges monthly aggregated. + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/cryptocurrency/onchain/bitquery_model.py#L333)] + +```python +openbb.crypto.onchain.dex_trades_monthly(trade_amount_currency: str = "USD", limit: int = 90, ascend: bool = True) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| trade_amount_currency | str | Currency of displayed trade amount. Default: USD | USD | True | +| limit | int | Last n days to query data. Maximum 365 (bigger numbers can cause timeouts
on server side) | 90 | True | +| ascend | bool | Flag to sort data ascending | True | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | Trades on Decentralized Exchanges monthly aggregated | +--- diff --git a/website/content/sdk/reference/crypto/onchain/dvcp.md b/website/content/sdk/reference/crypto/onchain/dvcp.md new file mode 100644 index 000000000000..99c3a251c2c2 --- /dev/null +++ b/website/content/sdk/reference/crypto/onchain/dvcp.md @@ -0,0 +1,93 @@ +--- +title: dvcp +description: This documentation page contains information about dvcp, a function from + the OpenBB framework that provides data about the daily volume of a specific cryptocurrency + pair. Both the data model and a chart view are presented. The documentation includes + source code links, detailed information about parameters and returned data. +keywords: +- dvcp +- cryptocurrency +- daily volume +- ERC20 token +- data model +- chart view +- parameters +- returned data +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + +Get daily volume for given pair [Source: https://graphql.bitquery.io/] + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/cryptocurrency/onchain/bitquery_model.py#L400)] + +```python +openbb.crypto.onchain.dvcp(limit: int = 100, symbol: str = "UNI", to_symbol: str = "USDT", sortby: str = "date", ascend: bool = True) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| limit | int | Last n days to query data | 100 | True | +| symbol | str | ERC20 token symbol | UNI | True | +| to_symbol | str | Quote currency. | USDT | True | +| sortby | str | Key by which to sort data | date | True | +| ascend | bool | Flag to sort data ascending | True | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | Daily volume for given pair | +--- + + + + +Prints table showing daily volume for given pair + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/cryptocurrency/onchain/bitquery_view.py#L87)] + +```python +openbb.crypto.onchain.dvcp_chart(symbol: str = "WBTC", to_symbol: str = "USDT", limit: int = 20, sortby: str = "date", ascend: bool = True, export: str = "") +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| symbol | str | ERC20 token symbol or address | WBTC | True | +| to_symbol | str | Quote currency. | USDT | True | +| limit | int | Number of records to display | 20 | True | +| sortby | str | Key by which to sort data | date | True | +| ascend | bool | Flag to sort data ascending | True | True | +| export | str | Export dataframe data to csv,json,xlsx file | | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | Token volume on different decentralized exchanges | +--- + + + diff --git a/website/content/sdk/reference/crypto/onchain/erc20_tokens.md b/website/content/sdk/reference/crypto/onchain/erc20_tokens.md new file mode 100644 index 000000000000..8d483d0c9b2c --- /dev/null +++ b/website/content/sdk/reference/crypto/onchain/erc20_tokens.md @@ -0,0 +1,42 @@ +--- +title: erc20_tokens +description: This page provides a helper method that loads the most traded erc20 tokens. + It contains source code, parameters and returns for the OpenBBTerminal project's + cryptocurrency bitquery model. +keywords: +- erc20 tokens +- most traded erc20 token +- cryptocurrency +- bitquery model +- OpenBBFinance +- token address +- token symbol +- token name +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Helper method that loads ~1500 most traded erc20 token. + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/cryptocurrency/onchain/bitquery_model.py#L210)] + +```python +openbb.crypto.onchain.erc20_tokens() +``` + +--- + +## Parameters + +This function does not take any parameters. + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | ERC20 tokens with address, symbol and name | +--- diff --git a/website/content/sdk/reference/crypto/onchain/gwei.md b/website/content/sdk/reference/crypto/onchain/gwei.md new file mode 100644 index 000000000000..9e78ddd5b492 --- /dev/null +++ b/website/content/sdk/reference/crypto/onchain/gwei.md @@ -0,0 +1,78 @@ +--- +title: gwei +description: This documentation page details the 'gwei' functionality of OpenBB's + crypto onchain operations. It contains code snippets and function descriptions for + retrieving Ethereum gas fees data, along with export methods for the same. +keywords: +- crypto onchain operations +- gwei +- Ethereum gas fees data +- data export +- Source Code +- function documentation +- onchain data +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + +Returns the most recent Ethereum gas fees in gwei + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/cryptocurrency/onchain/ethgasstation_model.py#L13)] + +```python +openbb.crypto.onchain.gwei() +``` + +--- + +## Parameters + +This function does not take any parameters. + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | four gas fees and durations
(fees for slow, average, fast and
fastest transactions in gwei and
its average durations in seconds) | +--- + + + + +Current gwei fees + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/cryptocurrency/onchain/ethgasstation_view.py#L14)] + +```python +openbb.crypto.onchain.gwei_chart(export: str = "") +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| export | str | Export dataframe data to csv,json,xlsx file | | True | + + +--- + +## Returns + +This function does not return anything + +--- + + + diff --git a/website/content/sdk/reference/crypto/onchain/hist.md b/website/content/sdk/reference/crypto/onchain/hist.md new file mode 100644 index 000000000000..502626ab07d6 --- /dev/null +++ b/website/content/sdk/reference/crypto/onchain/hist.md @@ -0,0 +1,92 @@ +--- +title: hist +description: This page provides detailed information on how to retrieve and display + information about balance historical transactions using OpenBB's crypto.onchain + functionality. Learn how to use On-chain model's parameters to sort and limit transactions + as required for Ethplorer, including the export of data. +keywords: +- OpenBB Crypto OnChain +- Blockchain balance +- Historical transactions +- OnChain Model +- OnChain View +- Ethplorer +- Balance historical transactions +- Sort by timestamp +- Sort in ascending order +- export dataframe to file +- Crypto +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + +Get information about balance historical transactions. [Source: Ethplorer] + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/cryptocurrency/onchain/ethplorer_model.py#L336)] + +```python +openbb.crypto.onchain.hist(address: str, sortby: str = "timestamp", ascend: bool = True) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| address | str | Blockchain balance e.g. 0x3cD751E6b0078Be393132286c442345e5DC49699 | None | False | +| sortby | str | Key to sort by. | timestamp | True | +| ascend | str | Sort in ascending order. | True | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | DataFrame with balance historical transactions (last 100) | +--- + + + + +Display information about balance historical transactions. [Source: Ethplorer] + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/cryptocurrency/onchain/ethplorer_view.py#L158)] + +```python +openbb.crypto.onchain.hist_chart(address: str, limit: int = 10, sortby: str = "timestamp", ascend: bool = True, export: str = "") +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| address | str | Ethereum blockchain balance e.g. 0x3cD751E6b0078Be393132286c442345e5DC49699 | None | False | +| limit | int | Limit of transactions. Maximum 100 | 10 | True | +| sortby | str | Key to sort by. | timestamp | True | +| ascend | str | Sort in ascending order. | True | True | +| export | str | Export dataframe data to csv,json,xlsx file | | True | + + +--- + +## Returns + +This function does not return anything + +--- + + + diff --git a/website/content/sdk/reference/crypto/onchain/holders.md b/website/content/sdk/reference/crypto/onchain/holders.md new file mode 100644 index 000000000000..58dccb4d8ed9 --- /dev/null +++ b/website/content/sdk/reference/crypto/onchain/holders.md @@ -0,0 +1,88 @@ +--- +title: holders +description: This documentation page provides insights on obtaining and displaying + the top token holder information using Ethplorer. It explains the crypto-onchain + methods used for data extraction and its process. +keywords: +- crypto onchain +- Ethplorer +- token holders +- ERC20 tokens +- data extraction +- data frame +- data processing +- data visualization +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + +Get info about top token holders. [Source: Ethplorer] + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/cryptocurrency/onchain/ethplorer_model.py#L305)] + +```python +openbb.crypto.onchain.holders(address: str, sortby: str = "balance", ascend: bool = True) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| address | str | Token balance e.g. 0x1f9840a85d5aF5bf1D1762F925BDADdC4201F984 | None | False | +| sortby | str | Key to sort by. | balance | True | +| ascend | str | Sort in descending order. | True | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | DataFrame with list of top token holders. | +--- + + + + +Display info about top ERC20 token holders. [Source: Ethplorer] + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/cryptocurrency/onchain/ethplorer_view.py#L114)] + +```python +openbb.crypto.onchain.holders_chart(address: str, limit: int = 10, sortby: str = "balance", ascend: bool = True, export: str = "") +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| address | str | Token balance e.g. 0x1f9840a85d5aF5bf1D1762F925BDADdC4201F984 | None | False | +| limit | int | Limit of transactions. Maximum 100 | 10 | True | +| sortby | str | Key to sort by. | balance | True | +| ascend | str | Sort in descending order. | True | True | +| export | str | Export dataframe data to csv,json,xlsx file | | True | + + +--- + +## Returns + +This function does not return anything + +--- + + + diff --git a/website/content/sdk/reference/crypto/onchain/hr.md b/website/content/sdk/reference/crypto/onchain/hr.md new file mode 100644 index 000000000000..51c4e87d7afa --- /dev/null +++ b/website/content/sdk/reference/crypto/onchain/hr.md @@ -0,0 +1,93 @@ +--- +title: hr +description: The hr Tab provides functionalities to return a dataframe with the mean + hashrate of either btc or eth blockchain along with the symbol's price, over a specified + interval. Additionally, the hr_chart function provides the ability to plot this + data as a chart. +keywords: +- OpenBB.crypto.onchain.hr +- OpenBB.crypto.onchain.hr_chart +- mean hashrate +- blockchain +- btc +- eth +- symbol price +- dataframe +- plot +- chart +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + +Returns dataframe with mean hashrate of btc or eth blockchain and symbol price + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/cryptocurrency/due_diligence/glassnode_model.py#L375)] + +```python +openbb.crypto.onchain.hr(symbol: str, interval: str = "24h", start_date: str = "2010-01-01", end_date: Optional[str] = None) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| symbol | str | Blockchain to check hashrate (BTC or ETH) | None | False | +| start_date | str | Initial date, format YYYY-MM-DD | 2010-01-01 | True | +| end_date | str | Final date, format YYYY-MM-DD | None | True | +| interval | str | Interval frequency (e.g., 24h) | 24h | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | mean hashrate and symbol price over time | +--- + + + + +Plots dataframe with mean hashrate of btc or eth blockchain and symbol price. + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/cryptocurrency/due_diligence/glassnode_view.py#L320)] + +```python +openbb.crypto.onchain.hr_chart(symbol: str, start_date: str = "2010-01-01", end_date: Optional[str] = None, interval: str = "24h", export: str = "", external_axes: Optional[List[matplotlib.axes._axes.Axes]] = None) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| symbol | str | Blockchain to check mean hashrate (BTC or ETH) | None | False | +| start_date | str | Initial date, format YYYY-MM-DD | 2010-01-01 | True | +| end_date | Optional[str] | Final date, format YYYY-MM-DD | None | True | +| interval | str | Interval frequency (possible values are: 24, 1w, 1month) | 24h | True | +| export | str | Export dataframe data to csv,json,xlsx file | | True | +| external_axes | Optional[List[plt.Axes]] | External axes (2 axes are expected in the list), by default None | None | True | + + +--- + +## Returns + +This function does not return anything + +--- + + + diff --git a/website/content/sdk/reference/crypto/onchain/info.md b/website/content/sdk/reference/crypto/onchain/info.md new file mode 100644 index 000000000000..8b37837a778a --- /dev/null +++ b/website/content/sdk/reference/crypto/onchain/info.md @@ -0,0 +1,83 @@ +--- +title: info +description: This documentation page provides information and source code regarding + getting info about ERC20 tokens, and displaying it. Covered aspects include related + parameters and returns. +keywords: +- ERC20 token info +- Ethplorer +- parameters +- returns +- OpenBB finance +- cryptocurrency +- onchain +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + +Get info about ERC20 token. [Source: Ethplorer] + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/cryptocurrency/onchain/ethplorer_model.py#L380)] + +```python +openbb.crypto.onchain.info(address: Any) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| address | str | Token balance e.g. 0x1f9840a85d5aF5bf1D1762F925BDADdC4201F984 | None | False | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | DataFrame with information about provided ERC20 token. | +--- + + + + +Display info about ERC20 token. [Source: Ethplorer] + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/cryptocurrency/onchain/ethplorer_view.py#L206)] + +```python +openbb.crypto.onchain.info_chart(address: str, social: bool = False, export: str = "") +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| address | str | Token balance e.g. 0x1f9840a85d5aF5bf1D1762F925BDADdC4201F984 | None | False | +| social | bool | Flag to display social media links | False | True | +| export | str | Export dataframe data to csv,json,xlsx file | | True | + + +--- + +## Returns + +This function does not return anything + +--- + + + diff --git a/website/content/sdk/reference/crypto/onchain/lt.md b/website/content/sdk/reference/crypto/onchain/lt.md new file mode 100644 index 000000000000..db29bbd60a46 --- /dev/null +++ b/website/content/sdk/reference/crypto/onchain/lt.md @@ -0,0 +1,94 @@ +--- +title: lt +description: Docusaurus page containing OpenBBTerminal's onchain lt model and view + that depict trades happening on Decentralized Exchanges - aggregated per DEX or + time. Also includes code snippets, parameter details, and return values. +keywords: +- onchain +- lt model +- Decentralized Exchanges +- DEX +- lt view +- onchain trading +- trades aggregation +- code snippets +- parameter details +- return values +- Bitcoin +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + +Get trades on Decentralized Exchanges aggregated by DEX [Source: https://graphql.bitquery.io/] + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/cryptocurrency/onchain/bitquery_model.py#L266)] + +```python +openbb.crypto.onchain.lt(trade_amount_currency: str = "USD", limit: int = 90, sortby: str = "tradeAmount", ascend: bool = True) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| trade_amount_currency | str | Currency of displayed trade amount. Default: USD | USD | True | +| limit | int | Last n days to query data. Maximum 365 (bigger numbers can cause timeouts
on server side) | 90 | True | +| sortby | str | Key by which to sort data | tradeAmount | True | +| ascend | bool | Flag to sort data ascending | True | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | Trades on Decentralized Exchanges aggregated by DEX | +--- + + + + +Prints table showing Trades on Decentralized Exchanges aggregated by DEX or Month + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/cryptocurrency/onchain/bitquery_view.py#L22)] + +```python +openbb.crypto.onchain.lt_chart(trade_amount_currency: str = "USD", kind: str = "dex", limit: int = 20, days: int = 90, sortby: str = "tradeAmount", ascend: bool = True, export: str = "") +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| kind | str | Aggregate trades by dex or time | dex | True | +| trade_amount_currency | str | Currency of displayed trade amount. Default: USD | USD | True | +| limit | int | Number of records to display | 20 | True | +| sortby | str | Key by which to sort data | tradeAmount | True | +| ascend | bool | Flag to sort data ascending | True | True | +| days | int | Last n days to query data. Maximum 365 (bigger numbers can cause timeouts
on server side) | 90 | True | +| export | str | Export dataframe data to csv,json,xlsx file | | True | + + +--- + +## Returns + +This function does not return anything + +--- + + + diff --git a/website/content/sdk/reference/crypto/onchain/prices.md b/website/content/sdk/reference/crypto/onchain/prices.md new file mode 100644 index 000000000000..2f566a5b2719 --- /dev/null +++ b/website/content/sdk/reference/crypto/onchain/prices.md @@ -0,0 +1,90 @@ +--- +title: prices +description: The 'prices' page shows how to use our API to obtain and display information + about historic prices of different cryptocurrencies. This includes parameters and + return types. +keywords: +- historical prices +- volume +- market cap +- average price +- onchain +- tokens +- Ethplorer +- cryptocurrency +- API +- dataframe +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + +Get token historical prices with volume and market cap, and average price. [Source: Ethplorer] + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/cryptocurrency/onchain/ethplorer_model.py#L545)] + +```python +openbb.crypto.onchain.prices(address: str, sortby: str = "date", ascend: bool = False) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| address | str | Token e.g. 0xf3db5fa2c66b7af3eb0c0b782510816cbe4813b8 | None | False | +| sortby | str | Key to sort by. | date | True | +| ascend | str | Sort in descending order. | False | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | DataFrame with token historical prices. | +--- + + + + +Display token historical prices with volume and market cap, and average price. + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/cryptocurrency/onchain/ethplorer_view.py#L334)] + +```python +openbb.crypto.onchain.prices_chart(address: str, limit: int = 30, sortby: str = "date", ascend: bool = False, export: str = "") +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| address | str | Token balance e.g. 0x1f9840a85d5aF5bf1D1762F925BDADdC4201F984 | None | False | +| limit | int | Limit of transactions. Maximum 100 | 30 | True | +| sortby | str | Key to sort by. | date | True | +| ascend | str | Sort in descending order. | False | True | +| export | str | Export dataframe data to csv,json,xlsx file | | True | + + +--- + +## Returns + +This function does not return anything + +--- + + + diff --git a/website/content/sdk/reference/crypto/onchain/query_graph.md b/website/content/sdk/reference/crypto/onchain/query_graph.md new file mode 100644 index 000000000000..6ae8db10b867 --- /dev/null +++ b/website/content/sdk/reference/crypto/onchain/query_graph.md @@ -0,0 +1,48 @@ +--- +title: query_graph +description: This page provides a detailed explanation of the query_graph helper methods + for querying a graphql api, including the Python source code and parameters required, + from openbb.crypto.onchain.query_graph. The response data is a dictionary. +keywords: +- query_graph +- helper methods +- graphql api +- bitquery.io +- openbb.crypto.onchain.query_graph +- parameters +- url +- query +- returns +- dictionary response data +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Helper methods for querying graphql api. [Source: https://bitquery.io/] + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/cryptocurrency/onchain/bitquery_model.py#L159)] + +```python +openbb.crypto.onchain.query_graph(url: str, query: str) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| url | str | Endpoint url | None | False | +| query | str | Graphql query | None | False | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| dict | Dictionary with response data | +--- diff --git a/website/content/sdk/reference/crypto/onchain/th.md b/website/content/sdk/reference/crypto/onchain/th.md new file mode 100644 index 000000000000..ebd39711ae76 --- /dev/null +++ b/website/content/sdk/reference/crypto/onchain/th.md @@ -0,0 +1,97 @@ +--- +title: th +description: This page provides a detailed description and source code for two main + features provided by OpenBB-finance. These are the functionalities to acquire token + historical transactions data and display information about token history. The page + further provides detailed explanations for parameters required for both functions + and what each function returns. +keywords: +- OpenBB-finance +- token historical transactions +- Ethplorer +- cryptocurrency +- onchain +- coding +- dataframe +- token balance +- python function +- parameters +- returns +- string +- integer +- boolean +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + +Get info about token historical transactions. [Source: Ethplorer] + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/cryptocurrency/onchain/ethplorer_model.py#L489)] + +```python +openbb.crypto.onchain.th(address: str, sortby: str = "timestamp", ascend: bool = False) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| address | str | Token e.g. 0xf3db5fa2c66b7af3eb0c0b782510816cbe4813b8 | None | False | +| sortby | str | Key to sort by. | timestamp | True | +| ascend | str | Sort in descending order. | False | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | DataFrame with token historical transactions. | +--- + + + + +Display info about token history. [Source: Ethplorer] + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/cryptocurrency/onchain/ethplorer_view.py#L276)] + +```python +openbb.crypto.onchain.th_chart(address: str, limit: int = 10, sortby: str = "timestamp", ascend: bool = False, hash_: bool = False, export: str = "") +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| address | str | Token balance e.g. 0x1f9840a85d5aF5bf1D1762F925BDADdC4201F984 | None | False | +| limit | int | Limit of transactions. Maximum 100 | 10 | True | +| sortby | str | Key to sort by. | timestamp | True | +| ascend | str | Sort in descending order. | False | True | +| hash_ | bool, | Flag to show transaction hash. | False | True | +| export | str | Export dataframe data to csv,json,xlsx file | | True | + + +--- + +## Returns + +This function does not return anything + +--- + + + diff --git a/website/content/sdk/reference/crypto/onchain/token_decimals.md b/website/content/sdk/reference/crypto/onchain/token_decimals.md new file mode 100644 index 000000000000..3b639d3aee30 --- /dev/null +++ b/website/content/sdk/reference/crypto/onchain/token_decimals.md @@ -0,0 +1,44 @@ +--- +title: token_decimals +description: The page provides a detailed guide on using helper methods to identify + token decimal number using OpenBB Crypto's Onchain and Ethplorer model. It provides + insightful information about token decimals and how to fetch this information using + a given address. Ideal for users interacting with Ethereum-based tokens. +keywords: +- token decimals +- blockchain balance +- OpenBB crypto +- onchain +- ethplorer model +- crypto token decimals +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Helper methods that gets token decimals number. [Source: Ethplorer] + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/cryptocurrency/onchain/ethplorer_model.py#L176)] + +```python +openbb.crypto.onchain.token_decimals(address: str) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| address | str | Blockchain balance e.g. 0x1f9840a85d5af5bf1d1762f925bdaddc4201f984 | None | False | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| Optional[int] | Number of decimals for given token. | +--- diff --git a/website/content/sdk/reference/crypto/onchain/top.md b/website/content/sdk/reference/crypto/onchain/top.md new file mode 100644 index 000000000000..b13e6616f5b9 --- /dev/null +++ b/website/content/sdk/reference/crypto/onchain/top.md @@ -0,0 +1,86 @@ +--- +title: top +description: Documentation for the OpenBB project's top 50 crypto tokens function. + This is implemented in Python and uses Docusaurus to organize and render the documentation. + It covers the parameters required and the expected result, including the sort order + and the type of data rendered. +keywords: +- Docusaurus +- Metadata +- Top 50 Tokens +- Cryptocurrency +- ERC20 +- Ethplorer +- Cryptocurrency Rank +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + +Get top 50 tokens. [Source: Ethplorer] + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/cryptocurrency/onchain/ethplorer_model.py#L268)] + +```python +openbb.crypto.onchain.top(sortby: str = "rank", ascend: bool = False) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| sortby | str | Key to sort by. | rank | True | +| ascend | str | Sort in descending order. | False | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | DataFrame with list of top 50 tokens. | +--- + + + + +Display top ERC20 tokens [Source: Ethplorer] + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/cryptocurrency/onchain/ethplorer_view.py#L70)] + +```python +openbb.crypto.onchain.top_chart(limit: int = 15, sortby: str = "rank", ascend: bool = True, export: str = "") +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| limit | int | Limit of transactions. Maximum 100 | 15 | True | +| sortby | str | Key to sort by. | rank | True | +| ascend | str | Sort in descending order. | True | True | +| export | str | Export dataframe data to csv,json,xlsx file | | True | + + +--- + +## Returns + +This function does not return anything + +--- + + + diff --git a/website/content/sdk/reference/crypto/onchain/ttcp.md b/website/content/sdk/reference/crypto/onchain/ttcp.md new file mode 100644 index 000000000000..70f21473182d --- /dev/null +++ b/website/content/sdk/reference/crypto/onchain/ttcp.md @@ -0,0 +1,95 @@ +--- +title: ttcp +description: The ttcp (Top Traded Crypto Pairs) page provides details about two backend + functions that analyze trading data from decentralized exchanges like Uniswap. This + page includes python source-codes and parameters for the functions, which help in + viewing and analyzing the most traded crypto pairs within a chosen timeframe. +keywords: +- ttcp +- Crypto Trade +- Crypto Pairs +- Decentralized Exchange +- Onchain Data +- Trade Analysis +- Ethereum +- Uniswap +- Bitquery Model +- Bitquery View +- Data Visualization +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + +Get most traded crypto pairs on given decentralized exchange in chosen time period. + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/cryptocurrency/onchain/bitquery_model.py#L658)] + +```python +openbb.crypto.onchain.ttcp(network: str = "ethereum", exchange: str = "Uniswap", limit: int = 90, sortby: str = "tradeAmount", ascend: bool = True) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| network | str | EVM network. One from list: bsc (binance smart chain), ethereum or matic | ethereum | True | +| exchange | st | Decentralized exchange name | Uniswap | True | +| limit | int | Number of days taken into calculation account. | 90 | True | +| sortby | str | Key by which to sort data | tradeAmount | True | +| ascend | bool | Flag to sort data ascending | True | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | Most traded crypto pairs on given decentralized exchange in chosen time period. | +--- + + + + +Prints table showing most traded crypto pairs on given decentralized exchange in chosen time period. + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/cryptocurrency/onchain/bitquery_view.py#L286)] + +```python +openbb.crypto.onchain.ttcp_chart(exchange: str = "Uniswap", days: int = 10, limit: int = 10, sortby: str = "tradeAmount", ascend: bool = True, export: str = "") +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| exchange | str | Decentralized exchange name | Uniswap | True | +| days | int | Number of days taken into calculation account. | 10 | True | +| sortby | str | Key by which to sort data | tradeAmount | True | +| ascend | bool | Flag to sort data ascending | True | True | +| export | str | Export dataframe data to csv,json,xlsx file | | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | Most traded crypto pairs on given decentralized exchange in chosen time period. | +--- + + + diff --git a/website/content/sdk/reference/crypto/onchain/tv.md b/website/content/sdk/reference/crypto/onchain/tv.md new file mode 100644 index 000000000000..2c58b8792eb0 --- /dev/null +++ b/website/content/sdk/reference/crypto/onchain/tv.md @@ -0,0 +1,94 @@ +--- +title: tv +description: 'This documentation provides coding references and details about two + functions related to the OpenBB Crypto Onchain Decentralized Exchange: one function + to get token volume and another to view and print this data. Available parameters + and return types are also discussed.' +keywords: +- Decentralized Exchange +- Token Volume +- OpenBB Crypto Onchain +- ERC20 token symbol +- Trade amount currency +- Sort data +- Data ascending +- Parameter details +- Return types +- Source code +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + +Get token volume on different Decentralized Exchanges. [Source: https://graphql.bitquery.io/] + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/cryptocurrency/onchain/bitquery_model.py#L513)] + +```python +openbb.crypto.onchain.tv(symbol: str = "UNI", trade_amount_currency: str = "USD", sortby: str = "tradeAmount", ascend: bool = True) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| symbol | str | ERC20 token symbol. | UNI | True | +| trade_amount_currency | str | Currency to display trade amount in. | USD | True | +| sortby | str | Key by which to sort data | tradeAmount | True | +| ascend | bool | Flag to sort data ascending | True | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | Token volume on Decentralized Exchanges | +--- + + + + +Prints table showing token volume on different Decentralized Exchanges. + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/cryptocurrency/onchain/bitquery_view.py#L160)] + +```python +openbb.crypto.onchain.tv_chart(symbol: str = "WBTC", trade_amount_currency: str = "USD", limit: int = 10, sortby: str = "tradeAmount", ascend: bool = True, export: str = "") +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| symbol | str | ERC20 token symbol or address | WBTC | True | +| trade_amount_currency | str | Currency of displayed trade amount. Default: USD | USD | True | +| limit | int | Number of records to display | 10 | True | +| sortby | str | Key by which to sort data | tradeAmount | True | +| ascend | bool | Flag to sort data ascending | True | True | +| export | str | Export dataframe data to csv,json,xlsx file | | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | Token volume on different decentralized exchanges | +--- + + + diff --git a/website/content/sdk/reference/crypto/onchain/tx.md b/website/content/sdk/reference/crypto/onchain/tx.md new file mode 100644 index 000000000000..ccc857d09e3b --- /dev/null +++ b/website/content/sdk/reference/crypto/onchain/tx.md @@ -0,0 +1,84 @@ +--- +title: tx +description: This is an intricate page pertaining to transaction information sourcing + from Ethplorer. It lays out comprehensive details about model and chart transactions, + offering Python source codes and linked GitHub resource. It elucidates transaction + hash parameters and the formats to export data frames, among others. +keywords: +- Ethplorer transactions +- transaction information +- model transactions +- chart transactions +- Python source code +- transaction hash parameters +- export data frame formats +- GitHub resource +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + +Get info about transaction. [Source: Ethplorer] + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/cryptocurrency/onchain/ethplorer_model.py#L444)] + +```python +openbb.crypto.onchain.tx(tx_hash: str) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| tx_hash | str | Transaction hash e.g. 0x9dc7b43ad4288c624fdd236b2ecb9f2b81c93e706b2ffd1d19b112c1df7849e6 | None | False | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | DataFrame with information about ERC20 token transaction. | +--- + + + + +Display info about transaction. [Source: Ethplorer] + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/cryptocurrency/onchain/ethplorer_view.py#L249)] + +```python +openbb.crypto.onchain.tx_chart(tx_hash: str, export: str = "") +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| tx_hash | str | Transaction hash e.g. 0x9dc7b43ad4288c624fdd236b2ecb9f2b81c93e706b2ffd1d19b112c1df7849e6 | None | False | +| export | str | Export dataframe data to csv,json,xlsx file | | True | + + +--- + +## Returns + +This function does not return anything + +--- + + + diff --git a/website/content/sdk/reference/crypto/onchain/ueat.md b/website/content/sdk/reference/crypto/onchain/ueat.md new file mode 100644 index 000000000000..f1a53ef4f2a9 --- /dev/null +++ b/website/content/sdk/reference/crypto/onchain/ueat.md @@ -0,0 +1,87 @@ +--- +title: ueat +description: Learn how to monitor unique ethereum address transactions using OpenBB's + ueat. Explore how to use the ueat function and chart for effective insights. +keywords: +- ueat +- ethereum address transactions +- crypto onchain +- bitquery model +- bitquery view +- monitor ethereum transactions +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + +Get number of unique ethereum addresses which made a transaction in given time interval. + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/cryptocurrency/onchain/bitquery_model.py#L584)] + +```python +openbb.crypto.onchain.ueat(interval: str = "day", limit: int = 90, sortby: str = "tradeAmount", ascend: bool = True) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| interval | str | Time interval in which count unique ethereum addresses which made transaction. day,
month or week. | day | True | +| limit | int | Number of records for data query. | 90 | True | +| sortby | str | Key by which to sort data | tradeAmount | True | +| ascend | bool | Flag to sort data ascending | True | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | Unique ethereum addresses which made a transaction | +--- + + + + +Prints table showing number of unique ethereum addresses which made a transaction in given time interval + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/cryptocurrency/onchain/bitquery_view.py#L225)] + +```python +openbb.crypto.onchain.ueat_chart(interval: str = "days", limit: int = 10, sortby: str = "date", ascend: bool = True, export: str = "") +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| interval | str | Time interval in which ethereum address made transaction. month, week or day | days | True | +| limit | int | Number of records to display. It's calculated base on provided interval.
If interval is month then calculation is made in the way: limit * 30 = time period,
in case if interval is set to week, then time period is calculated as limit * 7.
For better user experience maximum time period in days is equal to 90. | 10 | True | +| sortby | str | Key by which to sort data | date | True | +| ascend | bool | Flag to sort data ascending | True | True | +| export | str | Export dataframe data to csv,json,xlsx file | | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | Number of unique ethereum addresses which made a transaction in given time interval | +--- + + + diff --git a/website/content/sdk/reference/crypto/onchain/whales.md b/website/content/sdk/reference/crypto/onchain/whales.md new file mode 100644 index 000000000000..c571cd14c922 --- /dev/null +++ b/website/content/sdk/reference/crypto/onchain/whales.md @@ -0,0 +1,92 @@ +--- +title: whales +description: Learn how to utilise Whale Alert's API with OpenBB Terminal for tracking + high value transactions on major blockchains. This page contains detailed information + on how to implement and use this feature to retrieve both live and historical onchain + data from various cryptocurrencies. +keywords: +- Whale Alert API +- blockchain transactions +- onchain data +- cryptocurrency +- major blockchains +- crypto whales +- high value transactions +- transaction tracking +- data retrieval +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + +Whale Alert's API allows you to retrieve live and historical transaction data from major blockchains. + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/cryptocurrency/onchain/whale_alert_model.py#L86)] + +```python +openbb.crypto.onchain.whales(min_value: int = 800000, limit: int = 100, sortby: str = "date", ascend: bool = False) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| min_value | int | Minimum value of trade to track. | 800000 | True | +| limit | int | Limit of transactions. Max 100 | 100 | True | +| sortby | str | Key to sort by. | date | True | +| ascend | str | Sort in ascending order. | False | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | Crypto wales transactions | +--- + + + + +Display huge value transactions from major blockchains. [Source: https://docs.whale-alert.io/] + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/cryptocurrency/onchain/whale_alert_view.py#L21)] + +```python +openbb.crypto.onchain.whales_chart(min_value: int = 800000, limit: int = 100, sortby: str = "date", ascend: bool = False, show_address: bool = False, export: str = "") +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| min_value | int | Minimum value of trade to track. | 800000 | True | +| limit | int | Limit of transactions. Maximum 100 | 100 | True | +| sortby | str | Key to sort by. | date | True | +| ascend | str | Sort in ascending order. | False | True | +| show_address | bool | Flag to show addresses of transactions. | False | True | +| export | str | Export dataframe data to csv,json,xlsx file | | True | + + +--- + +## Returns + +This function does not return anything + +--- + + + diff --git a/website/content/sdk/reference/crypto/ov/altindex.md b/website/content/sdk/reference/crypto/ov/altindex.md new file mode 100644 index 000000000000..4654339ea809 --- /dev/null +++ b/website/content/sdk/reference/crypto/ov/altindex.md @@ -0,0 +1,88 @@ +--- +title: altindex +description: Page featuring the altindex function of the OpenBB library, enabling + the tracking of altcoin performance over various periods of time. +keywords: +- altindex +- altcoin tracking +- cryptocurrency +- altcoin index +- Python crypto library +- blockchain documentation +- crypto charting +- scripting +- crypto data export +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + +Get altcoin index overtime + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/cryptocurrency/overview/blockchaincenter_model.py#L20)] + +```python +openbb.crypto.ov.altindex(period: int = 30, start_date: str = "2010-01-01", end_date: Optional[str] = None) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| period | int | Number of days {30,90,365} to check performance of coins and calculate the altcoin index.
E.g., 365 checks yearly performance, 90 will check seasonal performance (90 days),
30 will check monthly performance (30 days). | 30 | True | +| start_date | str | Initial date, format YYYY-MM-DD | 2010-01-01 | True | +| end_date | Optional[str] | Final date, format YYYY-MM-DD | None | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | Date, Value (Altcoin Index) | +--- + + + + +Displays altcoin index overtime + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/cryptocurrency/overview/blockchaincenter_view.py#L27)] + +```python +openbb.crypto.ov.altindex_chart(period: int = 365, start_date: str = "2010-01-01", end_date: Optional[str] = None, export: str = "", external_axes: Optional[List[matplotlib.axes._axes.Axes]] = None) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| start_date | str | Initial date, format YYYY-MM-DD | 2010-01-01 | True | +| end_date | Optional[str] | Final date, format YYYY-MM-DD | None | True | +| period | int | Number of days to check the performance of coins and calculate the altcoin index.
E.g., 365 will check yearly performance , 90 will check seasonal performance (90 days),
30 will check monthly performance (30 days). | 365 | True | +| export | str | Export dataframe data to csv,json,xlsx file | | True | +| external_axes | Optional[List[plt.Axes]] | External axes (1 axis is expected in the list), by default None | None | True | + + +--- + +## Returns + +This function does not return anything + +--- + + + diff --git a/website/content/sdk/reference/crypto/ov/btcrb.md b/website/content/sdk/reference/crypto/ov/btcrb.md new file mode 100644 index 000000000000..8cdc610fb1d2 --- /dev/null +++ b/website/content/sdk/reference/crypto/ov/btcrb.md @@ -0,0 +1,87 @@ +--- +title: btcrb +description: btcrb is a feature of the OpenBB Terminal that allows users to access + historical bitcoin price data and view it in a rainbow chart. At its core, btcrb + provides Python methods for retrieving this data over a specified date range and + visualizing it using Matplotlib. +keywords: +- Bitcoin +- btcrb +- Price Data +- Rainbow Chart +- Data Retrieval +- Historical Bitcoin Data +- Matplotlib Visualization +- Cryptocurrency +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + +Get bitcoin price data + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/cryptocurrency/overview/glassnode_model.py#L19)] + +```python +openbb.crypto.ov.btcrb(start_date: str = "2010-01-01", end_date: Optional[str] = None) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| start_date | str | Initial date, format YYYY-MM-DD | 2010-01-01 | True | +| end_date | Optional[str] | Final date, format YYYY-MM-DD | None | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | price over time | +--- + + + + +Displays bitcoin rainbow chart + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/cryptocurrency/overview/glassnode_view.py#L29)] + +```python +openbb.crypto.ov.btcrb_chart(start_date: str = "2010-01-01", end_date: Optional[str] = None, export: str = "", external_axes: Optional[List[matplotlib.axes._axes.Axes]] = None) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| start_date | str | Initial date, format YYYY-MM-DD | 2010-01-01 | True | +| end_date | Optional[str] | Final date, format YYYY-MM-DD | None | True | +| export | str | Export dataframe data to csv,json,xlsx file | | True | +| external_axes | Optional[List[plt.Axes]] | External axes (1 axis is expected in the list), by default None | None | True | + + +--- + +## Returns + +This function does not return anything + +--- + + + diff --git a/website/content/sdk/reference/crypto/ov/categories.md b/website/content/sdk/reference/crypto/ov/categories.md new file mode 100644 index 000000000000..bb61dae03d49 --- /dev/null +++ b/website/content/sdk/reference/crypto/ov/categories.md @@ -0,0 +1,86 @@ +--- +title: categories +description: 'This page provides information about top crypto categories from the + CoinGecko source. Detailed explanations of the two main functions are provided: + the ''categories'' function, which returns top crypto categories based on various + filters, and the ''categories_chart'' function, which displays the top cryptocurrency + categories by market capitalization.' +keywords: +- crypto categories +- CoinGecko +- crypto market capitalization +- data sorting +- data visualization +- openbb.crypto.ov.categories +- openbb.crypto.ov.categories_chart +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + +Returns top crypto categories [Source: CoinGecko] + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/cryptocurrency/overview/pycoingecko_model.py#L157)] + +```python +openbb.crypto.ov.categories(sort_filter: str = "market_cap_desc") +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| sort_filter | str | Can be one of - "market_cap_desc", "market_cap_asc", "name_desc", "name_asc",
"market_cap_change_24h_desc", "market_cap_change_24h_asc" | market_cap_desc | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | Rank, Name, Change_1h, Change_7d, Market_Cap, Volume_24h,Coins, Url | +--- + + + + +Shows top cryptocurrency categories by market capitalization + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/cryptocurrency/overview/pycoingecko_view.py#L416)] + +```python +openbb.crypto.ov.categories_chart(sortby: str = "market_cap_desc", limit: int = 15, export: str = "", pie: bool = False) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| sortby | str | Key by which to sort data | market_cap_desc | True | +| limit | int | Number of records to display | 15 | True | +| export | str | Export dataframe data to csv,json,xlsx file | | True | +| pie | bool | Whether to show the pie chart | False | True | + + +--- + +## Returns + +This function does not return anything + +--- + + + diff --git a/website/versioned_docs/version-v3/sdk/reference/crypto/ov/cbpairs.md b/website/content/sdk/reference/crypto/ov/cbpairs.md similarity index 77% rename from website/versioned_docs/version-v3/sdk/reference/crypto/ov/cbpairs.md rename to website/content/sdk/reference/crypto/ov/cbpairs.md index cf459d5d2fd8..8e4ef890a3df 100644 --- a/website/versioned_docs/version-v3/sdk/reference/crypto/ov/cbpairs.md +++ b/website/content/sdk/reference/crypto/ov/cbpairs.md @@ -1,13 +1,27 @@ --- title: cbpairs -description: OpenBB SDK Function +description: This page provides in-depth information on how to use different functions + to get a list of available trading pairs or visualize it in a chart form with source + code supplied from OpenBB-finance/OpenBBTerminal project on GitHub. +keywords: +- OpenBB-finance +- GitHub +- cryptocurrency +- trading pairs +- coinbase +- model +- view +- charts +- visualization --- +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; -# cbpairs - @@ -39,8 +53,6 @@ openbb.crypto.ov.cbpairs(limit: int = 50, sortby: str = "quote_increment", ascen | pd.DataFrame | Available trading pairs on Coinbase | --- - - @@ -72,7 +84,5 @@ This function does not return anything --- - - - \ No newline at end of file + diff --git a/website/content/sdk/reference/crypto/ov/coin_list.md b/website/content/sdk/reference/crypto/ov/coin_list.md new file mode 100644 index 000000000000..e4b9bfad72bb --- /dev/null +++ b/website/content/sdk/reference/crypto/ov/coin_list.md @@ -0,0 +1,38 @@ +--- +title: coin_list +description: The coin_list page is a documentation of the function that returns the + list of all available coins on CoinPaprika. It includes source code and is part + of the OpenBBTerminal project. +keywords: +- coin_list +- CoinPaprika +- crypto +- pandas.DataFrame +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Get list of all available coins on CoinPaprika [Source: CoinPaprika] + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/cryptocurrency/due_diligence/coinpaprika_model.py#L452)] + +```python +openbb.crypto.ov.coin_list() +``` + +--- + +## Parameters + +This function does not take any parameters. + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pandas.DataFrame | Available coins on CoinPaprika
rank, id, name, symbol, type | +--- diff --git a/website/content/sdk/reference/crypto/ov/contracts.md b/website/content/sdk/reference/crypto/ov/contracts.md new file mode 100644 index 000000000000..2e0a6cfca80f --- /dev/null +++ b/website/content/sdk/reference/crypto/ov/contracts.md @@ -0,0 +1,91 @@ +--- +title: contracts +description: This page provides technical documentation around functions related to + cryptocurrency contract addresses. It includes information on how to use Python + functions for obtaining and sorting contract addresses for any given blockchain + platform using CoinPaprika as the data source. +keywords: +- cryptocurrency +- contracts +- CoinPaprika +- Python functions +- blockchain platform +- contract addresses +- crypto data +- technical documentation +- sort data +- data export +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + +Gets all contract addresses for given platform [Source: CoinPaprika] + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/cryptocurrency/overview/coinpaprika_model.py#L400)] + +```python +openbb.crypto.ov.contracts(platform_id: str = "eth-ethereum", sortby: str = "active", ascend: bool = True) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| platform_id | str | Blockchain platform like eth-ethereum | eth-ethereum | True | +| sortby | str | Key by which to sort data | active | True | +| ascend | bool | Flag to sort data ascend | True | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | id, type, active | +--- + + + + +Gets all contract addresses for given platform. [Source: CoinPaprika] + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/cryptocurrency/overview/coinpaprika_view.py#L349)] + +```python +openbb.crypto.ov.contracts_chart(symbol: str, sortby: str = "active", ascend: bool = True, limit: int = 15, export: str = "") +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| platform | str | Blockchain platform like eth-ethereum | None | True | +| limit | int | Number of records to display | 15 | True | +| sortby | str | Key by which to sort data | active | True | +| ascend | bool | Flag to sort data ascending | True | True | +| export | str | Export dataframe data to csv,json,xlsx file | | True | + + +--- + +## Returns + +This function does not return anything + +--- + + + diff --git a/website/content/sdk/reference/crypto/ov/cr.md b/website/content/sdk/reference/crypto/ov/cr.md new file mode 100644 index 000000000000..33807cb76dd3 --- /dev/null +++ b/website/content/sdk/reference/crypto/ov/cr.md @@ -0,0 +1,85 @@ +--- +title: cr +description: Documentation for two functions providing cryptocurrency interest rates + for both borrowing and supplying.You can use the functions to export data or generate + charts. Several platforms are covered including BlockFi, Ledn, SwissBorg, and Youhodler. +keywords: +- Cryptocurrency +- Crypto Interest Rates +- Crypto Borrowing +- Crypto Supplying +- Interest Rate Platforms +- Crypto Charts +- Crypto Data Export +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + +Returns crypto {borrow,supply} interest rates for cryptocurrencies across several platforms + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/cryptocurrency/overview/loanscan_model.py#L267)] + +```python +openbb.crypto.ov.cr(rate_type: str = "borrow") +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| rate_type | str | Interest rate type: {borrow, supply}. Default: supply | borrow | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | crypto interest rates per platform | +--- + + + + +Displays crypto {borrow,supply} interest rates for cryptocurrencies across several platforms + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/cryptocurrency/overview/loanscan_view.py#L24)] + +```python +openbb.crypto.ov.cr_chart(symbols: str, platforms: str, rate_type: str = "borrow", limit: int = 10, export: str = "", external_axes: Optional[List[matplotlib.axes._axes.Axes]] = None) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| rate_type | str | Interest rate type: {borrow, supply}. Default: supply | borrow | True | +| symbols | str | Crypto separated by commas. Default: BTC,ETH,USDT,USDC | None | False | +| platforms | str | Platforms separated by commas. Default: BlockFi,Ledn,SwissBorg,Youhodler | None | False | +| limit | int | Number of records to show | 10 | True | +| export | str | Export dataframe data to csv,json,xlsx file | | True | + + +--- + +## Returns + +This function does not return anything + +--- + + + diff --git a/website/content/sdk/reference/crypto/ov/crypto_hack.md b/website/content/sdk/reference/crypto/ov/crypto_hack.md new file mode 100644 index 000000000000..dfae9a70b81d --- /dev/null +++ b/website/content/sdk/reference/crypto/ov/crypto_hack.md @@ -0,0 +1,42 @@ +--- +title: crypto_hack +description: Documentation page that describes the crypto hack function of the OpenBBTerminal, + its parameters and return values. Ideal for those who interact with OpenBB-finance's + cryptocurrency scripts. +keywords: +- crypto hack +- crypto hack slug +- cryptocurrency +- rekt model +- OpenBB-finance +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Get crypto hack + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/cryptocurrency/overview/rekt_model.py#L139)] + +```python +openbb.crypto.ov.crypto_hack(slug: str) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| slug | str | slug of crypto hack | None | False | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| Union[str, None] | Crypto hack | +--- diff --git a/website/content/sdk/reference/crypto/ov/crypto_hack_slugs.md b/website/content/sdk/reference/crypto/ov/crypto_hack_slugs.md new file mode 100644 index 000000000000..9f2b489a7651 --- /dev/null +++ b/website/content/sdk/reference/crypto/ov/crypto_hack_slugs.md @@ -0,0 +1,36 @@ +--- +title: crypto_hack_slugs +description: This page provides details on the crypto_hack_slugs function of the OpenBB + finance platform. The function retrieves a list of cryptocurrency hack slugs. +keywords: +- crypto hack slugs +- OpenBB finance +- cryptocurrency +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Get all crypto hack slugs + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/cryptocurrency/overview/rekt_model.py#L182)] + +```python +openbb.crypto.ov.crypto_hack_slugs() +``` + +--- + +## Parameters + +This function does not take any parameters. + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| List[str] | List with slugs | +--- diff --git a/website/versioned_docs/version-v3/sdk/reference/crypto/ov/crypto_hacks.md b/website/content/sdk/reference/crypto/ov/crypto_hacks.md similarity index 80% rename from website/versioned_docs/version-v3/sdk/reference/crypto/ov/crypto_hacks.md rename to website/content/sdk/reference/crypto/ov/crypto_hacks.md index 3d5792567df3..33fce677a15a 100644 --- a/website/versioned_docs/version-v3/sdk/reference/crypto/ov/crypto_hacks.md +++ b/website/content/sdk/reference/crypto/ov/crypto_hacks.md @@ -1,13 +1,24 @@ --- title: crypto_hacks -description: OpenBB SDK Function +description: Deep dive into major cryptocurrency-related hacks with OpenBB's crypto + hacks models. Evaluate, sort by key parameters and view intricate details about + each crypto hack. +keywords: +- Crypto hacks +- Crypto security +- Cryptocurrency +- OpenBB crypto +- Crypto hack data +- Crypto data sorting --- +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; -# crypto_hacks - @@ -38,8 +49,6 @@ openbb.crypto.ov.crypto_hacks(sortby: str = "Platform", ascend: bool = False) | pd.DataFrame | Hacks with columns {Platform,Date,Amount [$],Audited,Slug,URL} | --- - - @@ -72,7 +81,5 @@ This function does not return anything --- - - - \ No newline at end of file + diff --git a/website/content/sdk/reference/crypto/ov/defi.md b/website/content/sdk/reference/crypto/ov/defi.md new file mode 100644 index 000000000000..b27599663a36 --- /dev/null +++ b/website/content/sdk/reference/crypto/ov/defi.md @@ -0,0 +1,77 @@ +--- +title: defi +description: This documents discusses useful functionalities for understanding global + Decentralized Finances. The content includes source code, parameters, and the returns. +keywords: +- Decentralized Finances +- cryptocurrency +- CoinGecko +- parameters +- returns +- dataframe +- defi +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + +Get global statistics about Decentralized Finances [Source: CoinGecko] + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/cryptocurrency/overview/pycoingecko_model.py#L514)] + +```python +openbb.crypto.ov.defi() +``` + +--- + +## Parameters + +This function does not take any parameters. + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | Metric, Value | +--- + + + + +Shows global statistics about Decentralized Finances. [Source: CoinGecko] + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/cryptocurrency/overview/pycoingecko_view.py#L301)] + +```python +openbb.crypto.ov.defi_chart(export: str = "") +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| export | str | Export dataframe data to csv,json,xlsx file | | True | + + +--- + +## Returns + +This function does not return anything + +--- + + + diff --git a/website/content/sdk/reference/crypto/ov/derivatives.md b/website/content/sdk/reference/crypto/ov/derivatives.md new file mode 100644 index 000000000000..9ccfece30d32 --- /dev/null +++ b/website/content/sdk/reference/crypto/ov/derivatives.md @@ -0,0 +1,84 @@ +--- +title: derivatives +description: This page provides instructions on how to extract crypto derivatives + data from CoinGecko API using Python. It provides detailed information on the parameters + used in the extraction code for both 'Model' and 'Chart' categories, along with + the return data format. +keywords: +- CoinGecko API +- crypto derivatives +- data extraction +- cryptocurrency +- data sorting +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + +Get list of crypto derivatives from CoinGecko API [Source: CoinGecko] + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/cryptocurrency/overview/pycoingecko_model.py#L375)] + +```python +openbb.crypto.ov.derivatives(sortby: str = "Rank", ascend: bool = False) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| sortby | str | Key by which to sort data | Rank | True | +| ascend | bool | Flag to sort data descending | False | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | Rank, Market, Symbol, Price, Pct_Change_24h, Contract_Type, Basis, Spread,
Funding_Rate, Volume_24h, | +--- + + + + +Shows list of crypto derivatives. [Source: CoinGecko] + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/cryptocurrency/overview/pycoingecko_view.py#L645)] + +```python +openbb.crypto.ov.derivatives_chart(sortby: str = "Rank", ascend: bool = False, limit: int = 15, export: str = "") +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| limit | int | Number of records to display | 15 | True | +| sortby | str | Key by which to sort data | Rank | True | +| ascend | bool | Flag to sort data descending | False | True | +| export | str | Export dataframe data to csv,json,xlsx file | | True | + + +--- + +## Returns + +This function does not return anything + +--- + + + diff --git a/website/content/sdk/reference/crypto/ov/ewf.md b/website/content/sdk/reference/crypto/ov/ewf.md new file mode 100644 index 000000000000..5f0f28a0dd62 --- /dev/null +++ b/website/content/sdk/reference/crypto/ov/ewf.md @@ -0,0 +1,81 @@ +--- +title: ewf +description: The documentation page discusses two functions - openbb.crypto.ov.ewf + and openbb.crypto.ov.ewf_chart. The first function scrapes exchange withdrawal fees + and returns a DataFrame with details on Exchange, Coins, and various statistics. + The second function allows users to export this data into different formats. The + source code and use cases of both functions are included. +keywords: +- openbb.crypto.ov.ewf +- Exchange withdrawal fees +- Scrapes exchange withdrawal fees +- openbb.crypto.ov.ewf_chart +- Model +- Chart +- Source Code +- Export dataframe data +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + +Scrapes exchange withdrawal fees + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/cryptocurrency/overview/withdrawalfees_model.py#L182)] + +```python +openbb.crypto.ov.ewf() +``` + +--- + +## Parameters + +This function does not take any parameters. + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | Exchange, Coins, Lowest, Average, Median, Highest | +--- + + + + +Exchange withdrawal fees + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/cryptocurrency/overview/withdrawalfees_view.py#L53)] + +```python +openbb.crypto.ov.ewf_chart(export: str = "") +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| export | str | Export dataframe data to csv,json,xlsx file | | True | + + +--- + +## Returns + +This function does not return anything + +--- + + + diff --git a/website/content/sdk/reference/crypto/ov/exchanges.md b/website/content/sdk/reference/crypto/ov/exchanges.md new file mode 100644 index 000000000000..1f16104eaaff --- /dev/null +++ b/website/content/sdk/reference/crypto/ov/exchanges.md @@ -0,0 +1,49 @@ +--- +title: exchanges +description: This page provides information about how to show top crypto exchanges + through OpenBB's API with detailed parameters, return types and examples. +keywords: +- crypto exchanges +- OpenBB API +- CoinGecko +- cryptocurrency +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Show top crypto exchanges. + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/cryptocurrency/overview/sdk_helpers.py#L42)] + +```python +openbb.crypto.ov.exchanges(source: str = "CoinGecko") +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| source | str | Source to get exchanges, by default "CoinGecko" | CoinGecko | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | DataFrame with top crypto exchanges | +--- + +## Examples + +```python +from openbb_terminal.sdk import openbb +exchanges = openbb.crypto.ov.exchanges() +``` + +--- diff --git a/website/content/sdk/reference/crypto/ov/exmarkets.md b/website/content/sdk/reference/crypto/ov/exmarkets.md new file mode 100644 index 000000000000..d3fc91091c8a --- /dev/null +++ b/website/content/sdk/reference/crypto/ov/exmarkets.md @@ -0,0 +1,87 @@ +--- +title: exmarkets +description: Documentation for the exmarkets API functions from OpenBBTerminal's Cryptocurrency + Overview tool. Lists markets by exchange ID and manages charts. +keywords: +- exmarkets +- API +- Cryptocurrency Overview Tool +- Markets by Exchange ID +- Cryptocurrency +- CoinPaprika +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + +List markets by exchange ID [Source: CoinPaprika] + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/cryptocurrency/overview/coinpaprika_model.py#L328)] + +```python +openbb.crypto.ov.exmarkets(exchange_id: str = "binance", symbols: str = "USD", sortby: str = "pair", ascend: bool = True) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| exchange_id | str | identifier of exchange e.g for Binance Exchange -> binance | binance | True | +| symbols | str | Comma separated quotes to return e.g quotes=USD,BTC | USD | True | +| sortby | str | Key by which to sort data | pair | True | +| ascend | bool | Flag to sort data ascending | True | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | pair, base_currency_name, quote_currency_name, market_url,
category, reported_volume_24h_share, trust_score, | +--- + + + + +Get all markets for given exchange [Source: CoinPaprika] + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/cryptocurrency/overview/coinpaprika_view.py#L267)] + +```python +openbb.crypto.ov.exmarkets_chart(exchange: str = "binance", sortby: str = "pair", ascend: bool = True, limit: int = 15, links: bool = False, export: str = "") +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| exchange | str | Exchange identifier e.g Binance | binance | True | +| limit | int | Number of records to display | 15 | True | +| sortby | str | Key by which to sort data | pair | True | +| ascend | bool | Flag to sort data descending | True | True | +| links | bool | Flag to display urls | False | True | +| export | str | Export dataframe data to csv,json,xlsx file | | True | + + +--- + +## Returns + +This function does not return anything + +--- + + + diff --git a/website/content/sdk/reference/crypto/ov/exrates.md b/website/content/sdk/reference/crypto/ov/exrates.md new file mode 100644 index 000000000000..116f012ba274 --- /dev/null +++ b/website/content/sdk/reference/crypto/ov/exrates.md @@ -0,0 +1,89 @@ +--- +title: exrates +description: Explanation and source code of 'exrates', a feature from OpenBB-finance + which fetches a list of cryptocurrency, fiat, and commodity exchange rates from + the CoinGecko API. This page includes how to use the function, its parameters, and + its returns. +keywords: +- exrates +- OpenBB-finance +- CoinGecko API +- cryptocurrency +- exchange rates +- crypto +- fiats +- commodity +- parameters +- returns +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + +Get list of crypto, fiats, commodity exchange rates from CoinGecko API [Source: CoinGecko] + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/cryptocurrency/overview/pycoingecko_model.py#L423)] + +```python +openbb.crypto.ov.exrates(sortby: str = "Name", ascend: bool = False) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| sortby | str | Key by which to sort data | Name | True | +| ascend | bool | Flag to sort data ascending | False | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | Index, Name, Unit, Value, Type | +--- + + + + +Shows list of crypto, fiats, commodity exchange rates. [Source: CoinGecko] + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/cryptocurrency/overview/pycoingecko_view.py#L200)] + +```python +openbb.crypto.ov.exrates_chart(sortby: str = "Name", ascend: bool = False, limit: int = 15, export: str = "") +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| limit | int | Number of records to display | 15 | True | +| sortby | str | Key by which to sort data | Name | True | +| ascend | bool | Flag to sort data ascending | False | True | +| export | str | Export dataframe data to csv,json,xlsx file | | True | + + +--- + +## Returns + +This function does not return anything + +--- + + + diff --git a/website/content/sdk/reference/crypto/ov/globe.md b/website/content/sdk/reference/crypto/ov/globe.md new file mode 100644 index 000000000000..65f651840afe --- /dev/null +++ b/website/content/sdk/reference/crypto/ov/globe.md @@ -0,0 +1,58 @@ +--- +title: globe +description: This docusaurus page represents the 'globe' function of OpenBBTerminal + which retrieves a DataFrame with global cryptocurrency market data from a specified + source; default is CoinGecko. +keywords: +- crypto market data +- globe function +- CoinGecko +- coinpaprika +- global crypto data +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Get global crypto market data. + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/cryptocurrency/overview/sdk_helpers.py#L11)] + +```python +openbb.crypto.ov.globe(source: str = "CoinGecko") +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| source | str | Source of data, by default "CoinGecko" | CoinGecko | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | DataFrame with global crypto market data | +--- + +## Examples + +```python +from openbb_terminal.sdk import openbb +global_market_data = openbb.crypto.ov.globals() +``` + +``` +To get data from CoinPaprika, use the source parameter: +``` +```python +global_market_data = openbb.crypto.ov.globals(source="coinpaprika") +``` + +--- diff --git a/website/content/sdk/reference/crypto/ov/hm.md b/website/content/sdk/reference/crypto/ov/hm.md new file mode 100644 index 000000000000..9dd80b8e8cc0 --- /dev/null +++ b/website/content/sdk/reference/crypto/ov/hm.md @@ -0,0 +1,87 @@ +--- +title: hm +description: The page provides detailed documentation for OpenBB crypto functions + that interact with CoinGecko to retrieve and visualise cryptocurrency data. It includes + code examples, a list of parameters and their descriptions for each function, and + source code links. +keywords: +- cryptocurrency +- CoinGecko +- heatmap +- docusaurus +- dataframe +- metadata +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + +Get N coins from CoinGecko [Source: CoinGecko] + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/cryptocurrency/discovery/pycoingecko_model.py#L128)] + +```python +openbb.crypto.ov.hm(limit: int = 250, category: str = "", sortby: str = "Symbol", ascend: bool = False) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| limit | int | Number of top coins to grab from CoinGecko | 250 | True | +| category | str | Category of the coins we want to retrieve | | True | +| sortby | str | Key to sort data | Symbol | True | +| ascend | bool | Sort data in ascending order | False | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | N coins | +--- + + + + +Shows cryptocurrencies heatmap [Source: CoinGecko] + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/cryptocurrency/overview/pycoingecko_view.py#L36)] + +```python +openbb.crypto.ov.hm_chart(category: str = "", limit: int = 15, export: str = "", external_axes: Optional[List[matplotlib.axes._axes.Axes]] = None) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| caterogy | str | Category (e.g., stablecoins). Empty for no category (default: ) | None | True | +| limit | int | Number of top cryptocurrencies to display | 15 | True | +| export | str | Export dataframe data to csv,json,xlsx | | True | +| external_axes | Optional[List[plt.Axes]] | External axes (1 axis is expected in the list), by default None | None | True | + + +--- + +## Returns + +This function does not return anything + +--- + + + diff --git a/website/content/sdk/reference/crypto/ov/hold.md b/website/content/sdk/reference/crypto/ov/hold.md new file mode 100644 index 000000000000..f4dbafda9f3b --- /dev/null +++ b/website/content/sdk/reference/crypto/ov/hold.md @@ -0,0 +1,90 @@ +--- +title: hold +description: Comprehensive guides to holding Bitcoin and Ethereum by public companies. + Details on visualizing the hold data and exporting it to your preferred data format + (csv, json, xlsx). Source references to CoinGecko. Includes links to source codes. +keywords: +- cryptocurrency +- bitcoin +- ethereum +- public companies +- data visualization +- CoinGecko +- bar graph +- dataframe +- openbb.crypto.ov.hold +- openbb.crypto.ov.hold_chart +- csv +- json +- xlsx +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + +Returns public companies that holds ethereum or bitcoin [Source: CoinGecko] + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/cryptocurrency/overview/pycoingecko_model.py#L102)] + +```python +openbb.crypto.ov.hold(endpoint: str = "bitcoin") +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| endpoint | str | "bitcoin" or "ethereum" | bitcoin | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| List[Union[str, pd.DataFrame]] | - str: Overall statistics
- pd.DataFrame: Companies holding crypto | +--- + + + + +Shows overview of public companies that holds ethereum or bitcoin. [Source: CoinGecko] + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/cryptocurrency/overview/pycoingecko_view.py#L135)] + +```python +openbb.crypto.ov.hold_chart(symbol: str, show_bar: bool = False, export: str = "", limit: int = 15) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| symbol | str | Cryptocurrency: ethereum or bitcoin | None | False | +| show_bar | bool | Whether to show a bar graph for the data | False | True | +| export | str | Export dataframe data to csv,json,xlsx | | True | +| limit | int | The number of rows to show | 15 | True | + + +--- + +## Returns + +This function does not return anything + +--- + + + diff --git a/website/content/sdk/reference/crypto/ov/indexes.md b/website/content/sdk/reference/crypto/ov/indexes.md new file mode 100644 index 000000000000..1606cd57f3ff --- /dev/null +++ b/website/content/sdk/reference/crypto/ov/indexes.md @@ -0,0 +1,85 @@ +--- +title: indexes +description: The documentation page covers the retrieval and visualization of crypto + indexes using the CoinGecko API in the OpenBB platform. It details parameters, source + code, and return values for related methods. +keywords: +- CoinGecko API +- crypto indexes +- pycoingecko_model +- pycoingecko_view +- data sort +- crypto data visualization +- data export +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + +Get list of crypto indexes from CoinGecko API [Source: CoinGecko] + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/cryptocurrency/overview/pycoingecko_model.py#L350)] + +```python +openbb.crypto.ov.indexes(sortby: str = "Name", ascend: bool = True) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| sortby | str | Key by which to sort data | Name | True | +| ascend | bool | Flag to sort data ascending | True | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | Name, Id, Market, Last, MultiAsset | +--- + + + + +Shows list of crypto indexes. [Source: CoinGecko] + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/cryptocurrency/overview/pycoingecko_view.py#L608)] + +```python +openbb.crypto.ov.indexes_chart(sortby: str = "Name", ascend: bool = True, limit: int = 15, export: str = "") +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| limit | int | Number of records to display | 15 | True | +| sortby | str | Key by which to sort data | Name | True | +| ascend | bool | Flag to sort data descending | True | True | +| export | str | Export dataframe data to csv,json,xlsx file | | True | + + +--- + +## Returns + +This function does not return anything + +--- + + + diff --git a/website/content/sdk/reference/crypto/ov/info.md b/website/content/sdk/reference/crypto/ov/info.md new file mode 100644 index 000000000000..d3a2ec650267 --- /dev/null +++ b/website/content/sdk/reference/crypto/ov/info.md @@ -0,0 +1,95 @@ +--- +title: info +description: This page provides detailed documentation on retrieving and visualizing + cryptocurrency data from the CoinPaprika API using methods from the OpenBB crypto + module. The page includes parameters and return values, data sorting, and export + options. Source codes are also linked for better understanding. +keywords: +- CoinPaprika API +- crypto coin data +- cryptocurrency information +- openbb.crypto.ov.info +- data modeling +- data sorting +- ascending and descending sorting +- data visualization +- data export formats +- python coding +- coin market cap +- coin volume +- price chart +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + +Returns basic coin information for all coins from CoinPaprika API [Source: CoinPaprika] + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/cryptocurrency/overview/coinpaprika_model.py#L183)] + +```python +openbb.crypto.ov.info(symbols: str = "USD", sortby: str = "rank", ascend: bool = True) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| symbols | str | Comma separated quotes to return e.g quotes=USD,BTC | USD | True | +| sortby | str | Key by which to sort data | rank | True | +| ascend | bool | Flag to sort data descending | True | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | rank, name, symbol, price, volume_24h, circulating_supply, total_supply,
max_supply, market_cap, beta_value, ath_price, | +--- + + + + +Displays basic coin information for all coins from CoinPaprika API. [Source: CoinPaprika] + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/cryptocurrency/overview/coinpaprika_view.py#L159)] + +```python +openbb.crypto.ov.info_chart(symbol: str, sortby: str = "rank", ascend: bool = True, limit: int = 15, export: str = "") +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| symbol | str | Quoted currency | None | False | +| limit | int | Number of records to display | 15 | True | +| sortby | str | Key by which to sort data | rank | True | +| ascend | bool | Flag to sort data descending | True | True | +| links | bool | Flag to display urls | None | True | +| export | str | Export dataframe data to csv,json,xlsx file | | True | + + +--- + +## Returns + +This function does not return anything + +--- + + + diff --git a/website/content/sdk/reference/crypto/ov/markets.md b/website/content/sdk/reference/crypto/ov/markets.md new file mode 100644 index 000000000000..14314ab57414 --- /dev/null +++ b/website/content/sdk/reference/crypto/ov/markets.md @@ -0,0 +1,88 @@ +--- +title: markets +description: The markets page provides detailed information on how to use the OpenBB + crypto market API functions. The high-level cryptocurrency data from CoinPaprika + API allows the user to import and view detailed coin information, with the functionality + of sorting the data based on different parameters. +keywords: +- cryptocurrency +- API +- CoinPaprika +- crypto market +- coin information +- data sorting +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + +Returns basic coin information for all coins from CoinPaprika API [Source: CoinPaprika] + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/cryptocurrency/overview/coinpaprika_model.py#L223)] + +```python +openbb.crypto.ov.markets(symbols: str = "USD", sortby: str = "rank", ascend: bool = True) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| symbols | str | Comma separated quotes to return e.g quotes=USD,BTC | USD | True | +| sortby | str | Key by which to sort data | rank | True | +| ascend | bool | Flag to sort data ascend | True | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | rank, name, symbol, price, volume_24h, mcap_change_24h,
pct_change_1h, pct_change_24h, ath_price, pct_from_ath, | +--- + + + + +Displays basic market information for all coins from CoinPaprika API. [Source: CoinPaprika] + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/cryptocurrency/overview/coinpaprika_view.py#L105)] + +```python +openbb.crypto.ov.markets_chart(symbol: str, sortby: str = "rank", ascend: bool = True, limit: int = 15, export: str = "") +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| symbol | str | Quoted currency | None | False | +| limit | int | Number of records to display | 15 | True | +| sortby | str | Key by which to sort data | rank | True | +| ascend | bool | Flag to sort data ascending | True | True | +| links | bool | Flag to display urls | None | True | +| export | str | Export dataframe data to csv,json,xlsx file | | True | + + +--- + +## Returns + +This function does not return anything + +--- + + + diff --git a/website/content/sdk/reference/crypto/ov/news.md b/website/content/sdk/reference/crypto/ov/news.md new file mode 100644 index 000000000000..bca6be955f35 --- /dev/null +++ b/website/content/sdk/reference/crypto/ov/news.md @@ -0,0 +1,92 @@ +--- +title: news +description: This documentation is for a news aggregator platform on the OpenBB Terminal + which fetches recent posts from CryptoPanic. It details available functions, parameters, + returns and the source code link. +keywords: +- CryptoPanic +- news aggregator +- parameters +- returns +- crypto news +- filter options +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + +Get recent posts from CryptoPanic news aggregator platform. [Source: https://cryptopanic.com/] + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/cryptocurrency/overview/cryptopanic_model.py#L158)] + +```python +openbb.crypto.ov.news(limit: int = 60, post_kind: str = "news", filter_: Optional[str] = None, region: str = "en", source: Optional[str] = None, symbol: Optional[str] = None, sortby: str = "published_at", ascend: bool = True) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| limit | int | number of news to fetch | 60 | True | +| post_kind | str | Filter by category of news. Available values: news or media. | news | True | +| filter_ | Optional[str] | Filter by kind of news. One from list: rising|hot|bullish|bearish|important|saved|lol | None | True | +| region | str | Filter news by regions. Available regions are: en (English), de (Deutsch), nl (Dutch),
es (Español), fr (Français), it (Italiano), pt (Português), ru (Русский) | en | True | +| sortby | str | Key to sort by. | published_at | True | +| ascend | bool | Sort in ascend order. | True | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | DataFrame with recent news from different sources filtered by provided parameters. | +--- + + + + +Display recent posts from CryptoPanic news aggregator platform. + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/cryptocurrency/overview/cryptopanic_view.py#L17)] + +```python +openbb.crypto.ov.news_chart(post_kind: str = "news", region: str = "en", filter_: Optional[str] = None, limit: int = 25, sortby: str = "published_at", ascend: bool = False, links: bool = False, export: str = "") +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| limit | int | number of news to display | 25 | True | +| post_kind | str | Filter by category of news. Available values: news or media. | news | True | +| filter_ | Optional[str] | Filter by kind of news. One from list: rising|hot|bullish|bearish|important|saved|lol | None | True | +| region | str | Filter news by regions. Available regions are: en (English), de (Deutsch), nl (Dutch),
es (Español), fr (Français), it (Italiano), pt (Português), ru (Русский) | en | True | +| sortby | str | Key to sort by. | published_at | True | +| ascend | bool | Sort in ascending order. | False | True | +| links | bool | Show urls for news | False | True | +| export | str | Export dataframe data to csv,json,xlsx file | | True | + + +--- + +## Returns + +This function does not return anything + +--- + + + diff --git a/website/content/sdk/reference/crypto/ov/platforms.md b/website/content/sdk/reference/crypto/ov/platforms.md new file mode 100644 index 000000000000..fac1a7f73456 --- /dev/null +++ b/website/content/sdk/reference/crypto/ov/platforms.md @@ -0,0 +1,84 @@ +--- +title: platforms +description: "This page contains a directory of all smart contract platforms such\ + \ as Ethereum, Solana, Cosmos, Polkadot, and Kusama. The page provides source codes\ + \ and instructs the use of functionalities in two formats \u2014 model and chart." +keywords: +- smart contract platforms +- Ethereum +- Solana +- Cosmos +- Polkadot +- Kusama +- model view +- chart view +- cryptocurrency +- openbb.crypto.ov.platforms() +- openbb.crypto.ov.platforms_chart() +- CoinPaprika +- dataframe export +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + +List all smart contract platforms like ethereum, solana, cosmos, polkadot, kusama ... [Source: CoinPaprika] + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/cryptocurrency/overview/coinpaprika_model.py#L379)] + +```python +openbb.crypto.ov.platforms() +``` + +--- + +## Parameters + +This function does not take any parameters. + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | index, platform_id | +--- + + + + +List all smart contract platforms like ethereum, solana, cosmos, polkadot, kusama. + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/cryptocurrency/overview/coinpaprika_view.py#L324)] + +```python +openbb.crypto.ov.platforms_chart(export: str) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| export | str | Export dataframe data to csv,json,xlsx file | None | False | + + +--- + +## Returns + +This function does not return anything + +--- + + + diff --git a/website/content/sdk/reference/crypto/ov/products.md b/website/content/sdk/reference/crypto/ov/products.md new file mode 100644 index 000000000000..7b6606d09805 --- /dev/null +++ b/website/content/sdk/reference/crypto/ov/products.md @@ -0,0 +1,87 @@ +--- +title: products +description: Documentation for the functions related to the retrieval and visualization + of financial products using the OpenBBTerminal and CoinGecko API. Covers aspects + such as sorting of data, ascending and descending configuration, product charts + and exporting data. +keywords: +- OpenBBTerminal financial products +- CoinGecko API +- openbb.crypto.ov.products +- Financial data sorting +- Data ascending and descending +- products_chart +- Financial products chart +- Data export +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + +Get list of financial products from CoinGecko API + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/cryptocurrency/overview/pycoingecko_model.py#L317)] + +```python +openbb.crypto.ov.products(sortby: str = "Name", ascend: bool = True) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| sortby | str | Key by which to sort data | Name | True | +| ascend | bool | Flag to sort data ascending | True | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | Rank, Platform, Identifier, Supply_Rate, Borrow_Rate | +--- + + + + +Shows list of financial products. [Source: CoinGecko] + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/cryptocurrency/overview/pycoingecko_view.py#L570)] + +```python +openbb.crypto.ov.products_chart(sortby: str = "Platform", ascend: bool = False, limit: int = 15, export: str = "") +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| limit | int | Number of records to display | 15 | True | +| sortby | str | Key by which to sort data | Platform | True | +| ascend | bool | Flag to sort data descending | False | True | +| export | str | Export dataframe data to csv,json,xlsx file | | True | + + +--- + +## Returns + +This function does not return anything + +--- + + + diff --git a/website/content/sdk/reference/crypto/ov/stables.md b/website/content/sdk/reference/crypto/ov/stables.md new file mode 100644 index 000000000000..2842b01e4d8c --- /dev/null +++ b/website/content/sdk/reference/crypto/ov/stables.md @@ -0,0 +1,109 @@ +--- +title: stables +description: Documentation for the stable coins API provided by OpenBB, including + how to use the model endpoints for data extraction and the chart endpoints for data + visualization. +keywords: +- OpenBB stable coins API +- cryptocurrency documentation +- data extraction +- data visualization +- metadata SEO +- python cryptocurrency API +- OpenBB documentation +- CoinGecko API +- programming examples +- SDK usage +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + +Returns top stable coins [Source: CoinGecko] + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/cryptocurrency/overview/pycoingecko_model.py#L191)] + +```python +openbb.crypto.ov.stables(limit: int = 15, sortby: str = "Market_Cap_[$]", ascend: bool = False) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| limit | int | How many rows to show | 15 | True | +| sortby | str | Key by which to sort data, default is Market_Cap_[$] | Market_Cap_[$] | True | +| ascend | bool | Flag to sort data ascending | False | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | Dataframe with stable coins data | +--- + +## Examples + +```python +from openbb_terminal.sdk import openbb +openbb.crypto.ov.stables(sortby="Volume_[$]", ascend=True, limit=10) +``` + +--- + + + + +Shows stablecoins data [Source: CoinGecko] + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/cryptocurrency/overview/pycoingecko_view.py#L331)] + +```python +openbb.crypto.ov.stables_chart(limit: int = 15, export: str = "", sortby: str = "Market_Cap_[$]", ascend: bool = False, pie: bool = True) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| limit | int | Number of records to display | 15 | True | +| sortby | str | Key by which to sort data, default is Market_Cap_[$] | Market_Cap_[$] | True | +| ascend | bool | Flag to sort data ascending | False | True | +| pie | bool | Whether to show a pie chart, default is True | True | True | +| export | str | Export dataframe data to csv,json,xlsx file | | True | +| pie | bool | Whether to show a pie chart | True | True | + + +--- + +## Returns + +This function does not return anything + +--- + +## Examples + +```python +from openbb_terminal.sdk import openbb +openbb.crypto.ov.stables_chart(sortby="Volume_[$]", ascend=True, limit=10) +``` + +--- + + + diff --git a/website/content/sdk/reference/crypto/ov/wf.md b/website/content/sdk/reference/crypto/ov/wf.md new file mode 100644 index 000000000000..88a4612a95a6 --- /dev/null +++ b/website/content/sdk/reference/crypto/ov/wf.md @@ -0,0 +1,86 @@ +--- +title: wf +description: This documentation page discusses two features of the software, focusing + on top coins withdrawal fees. The first tab details the 'Model' feature, which scrapes + data for top coins' withdrawal fees by employing specific python code. The code + parameters and return objects are clearly defined. The second tab is about 'Chart', + the feature to visualize top coins withdrawal fees. Also elaborates on how to limit + searches, export data, with the inclusion of python script. +keywords: +- python code +- withdrawal fees +- crypto coins +- scraping data +- data visualization +- parameters +- data export +- coin search +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + +Scrapes top coins withdrawal fees + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/cryptocurrency/overview/withdrawalfees_model.py#L120)] + +```python +openbb.crypto.ov.wf(limit: int = 100) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| limit | int | Number of coins to search, by default n=100, one page has 100 coins, so 1 page is scraped. | 100 | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | Coin, Lowest, Average, Median, Highest, Exchanges Compared | +--- + + + + +Top coins withdrawal fees + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/cryptocurrency/overview/withdrawalfees_view.py#L18)] + +```python +openbb.crypto.ov.wf_chart(limit: int = 15, export: str = "") +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| limit | int | Number of coins to search | 15 | True | +| export | str | Export dataframe data to csv,json,xlsx file | | True | + + +--- + +## Returns + +This function does not return anything + +--- + + + diff --git a/website/content/sdk/reference/crypto/ov/wfpe.md b/website/content/sdk/reference/crypto/ov/wfpe.md new file mode 100644 index 000000000000..67f895ec520a --- /dev/null +++ b/website/content/sdk/reference/crypto/ov/wfpe.md @@ -0,0 +1,85 @@ +--- +title: wfpe +description: This page explains how to use OpenBB's wfpe function, which scrapes coin + withdrawal fees per exchange and presents them visually or in data format. It provides + detailed parameters and returns information for both the model and view aspects + of the function. +keywords: +- wfpe function +- coin withdrawal fees +- crypto exchange +- data scraping +- data visualization +- parameters +- returns +- Model +- View +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + +Scrapes coin withdrawal fees per exchange + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/cryptocurrency/overview/withdrawalfees_model.py#L207)] + +```python +openbb.crypto.ov.wfpe(symbol: str) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| symbol | str | Coin to check withdrawal fees. By default bitcoin | None | False | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| List | - str: Overall statistics (exchanges, lowest, average and median)
- pd.DataFrame: Exchange, Withdrawal Fee, Minimum Withdrawal Amount | +--- + + + + +Coin withdrawal fees per exchange + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/cryptocurrency/overview/withdrawalfees_view.py#L86)] + +```python +openbb.crypto.ov.wfpe_chart(symbol: str, export: str = "") +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| symbol | str | Coin to check withdrawal fees | None | False | +| export | str | Export dataframe data to csv,json,xlsx file | | True | + + +--- + +## Returns + +This function does not return anything + +--- + + + diff --git a/website/content/sdk/reference/crypto/price.md b/website/content/sdk/reference/crypto/price.md new file mode 100644 index 000000000000..d72666a3e19d --- /dev/null +++ b/website/content/sdk/reference/crypto/price.md @@ -0,0 +1,43 @@ +--- +title: price +description: Get the price and confidence interval from the Pyth live feed for any + given crypto asset. It also provides the previous price of the asset for comparison. +keywords: +- price +- confidence interval +- Pyth live feed +- crypto price +- asset price +- confidence level +- previous price +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Returns price and confidence interval from pyth live feed. [Source: Pyth] + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/cryptocurrency/pyth_model.py#L76)] + +```python +openbb.crypto.price(symbol: str) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| symbol | str | Symbol of the asset to get price and confidence interval from | None | False | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| Tuple[float, float, float] | Price of the asset,
Confidence level,
Previous price of the asset | +--- diff --git a/website/versioned_docs/version-v3/sdk/reference/crypto/tools/apy.md b/website/content/sdk/reference/crypto/tools/apy.md similarity index 76% rename from website/versioned_docs/version-v3/sdk/reference/crypto/tools/apy.md rename to website/content/sdk/reference/crypto/tools/apy.md index 5d9e03b13d58..b5a141c670ea 100644 --- a/website/versioned_docs/version-v3/sdk/reference/crypto/tools/apy.md +++ b/website/content/sdk/reference/crypto/tools/apy.md @@ -1,13 +1,26 @@ --- title: apy -description: OpenBB SDK Function +description: This documentation page provides information about the apy and apr functions + in openbb.crypto.tools. It features source code links, parameter descriptions, return + values, and the option to view the chart or export data. +keywords: +- apy +- apr +- compounding times +- cryptocurrency +- openbb.crypto.tools +- dataframe +- narrative version +- export data --- +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; -# apy - @@ -38,8 +51,6 @@ openbb.crypto.tools.apy(apr: float, compounding_times: int) | Tuple[pd.DataFrame, str] | - pd.DataFrame: dataframe with results
- str: narrative version of results | --- - - @@ -71,7 +82,5 @@ This function does not return anything --- - - - \ No newline at end of file + diff --git a/website/content/sdk/reference/crypto/tools/il.md b/website/content/sdk/reference/crypto/tools/il.md new file mode 100644 index 000000000000..9a16e02f2377 --- /dev/null +++ b/website/content/sdk/reference/crypto/tools/il.md @@ -0,0 +1,91 @@ +--- +title: il +description: 'This page provides technical documentation for two imperative features + in OpenBB''s cryptocurrency tool suite: the Impermanent Loss calculation model and + its corresponding chart display. Learn about their parameters, return types, and + source code.' +keywords: +- Cryptocurrency +- Impermanent Loss +- Impermanent Loss Model +- Impermanent Loss Chart Display +- Crypto Tool Suite +- Crypto A +- Crypto B +- Liquidity Pool +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + +Calculates Impermanent Loss in a custom liquidity pool + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/cryptocurrency/tools/tools_model.py#L57)] + +```python +openbb.crypto.tools.il(price_changeA: float, price_changeB: float, proportion: float, initial_pool_value: float) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| price_changeA | float | price change of crypto A in percentage | None | False | +| price_changeB | float | price change of crypto B in percentage | None | False | +| proportion | float | percentage of first token in pool | None | False | +| initial_pool_value | float | initial value that pool contains | None | False | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| Tuple[pd.DataFrame, str] | - pd.DataFrame: dataframe with results
- str: narrative version of results | +--- + + + + +Displays Impermanent Loss in a custom liquidity pool + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/cryptocurrency/tools/tools_view.py#L56)] + +```python +openbb.crypto.tools.il_chart(price_changeA: int, price_changeB: int, proportion: int, initial_pool_value: int, narrative: bool = False, export: str = "") +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| price_changeA | float | price change of crypto A in percentage | None | False | +| price_changeB | float | price change of crypto B in percentage | None | False | +| proportion | float | percentage of first token in pool | None | False | +| initial_pool_value | float | initial value that pool contains | None | False | +| narrative | str | display narrative version instead of dataframe | False | True | +| export | str | Export dataframe data to csv,json,xlsx file | | True | + + +--- + +## Returns + +This function does not return anything + +--- + + + diff --git a/website/content/sdk/reference/econometrics/bgod.md b/website/content/sdk/reference/econometrics/bgod.md new file mode 100644 index 000000000000..cbf65c3d3e6a --- /dev/null +++ b/website/content/sdk/reference/econometrics/bgod.md @@ -0,0 +1,85 @@ +--- +title: bgod +description: This page provides documentation for bgod and bgod_chart methods of OpenBB. + The bgod method calculates test statistics for autocorrelation in an OLS model, + and bgod_chart displays the Breusch-Godfrey autocorrelation test. +keywords: +- bgod +- bgod_chart +- autocorrelation +- Breusch-Godfrey Test +- OLS model +- statistics +- data analysis +- econometrics +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + +Calculate test statistics for autocorrelation + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/econometrics/regression_model.py#L525)] + +```python +openbb.econometrics.bgod(model: pd.DataFrame, lags: int = 3) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| model | OLS Model | OLS model that has been fit. | None | False | +| lags | int | The amount of lags. | 3 | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | Test results from the Breusch-Godfrey Test | +--- + + + + +Show Breusch-Godfrey autocorrelation test + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/econometrics/regression_view.py#L141)] + +```python +openbb.econometrics.bgod_chart(model: statsmodels.regression.linear_model.RegressionResultsWrapper, lags: int = 3, export: str = "") +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| model | OLS Model | OLS model that has been fit. | None | False | +| lags | int | The amount of lags included. | 3 | True | +| export | str | Format to export data | | True | + + +--- + +## Returns + +This function does not return anything + +--- + + + diff --git a/website/content/sdk/reference/econometrics/bols.md b/website/content/sdk/reference/econometrics/bols.md new file mode 100644 index 000000000000..fbf629fc53d5 --- /dev/null +++ b/website/content/sdk/reference/econometrics/bols.md @@ -0,0 +1,43 @@ +--- +title: bols +description: The page provides detailed instructions on how to use the 'Between estimator', + which is part of the openbb.econometrics.bols Python function. It covers parameters, + return values, and the code to be used. +keywords: +- Between estimator +- OLS model +- Dependent variable +- Independent variable +- openbb.econometrics.bols +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +The between estimator is an alternative, usually less efficient estimator, can can be used to + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/econometrics/regression_model.py#L314)] + +```python +openbb.econometrics.bols(Y: pd.DataFrame, X: pd.DataFrame) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| regression_variables | list | The regressions variables entered where the first variable is
the dependent variable. | None | True | +| data | dict | A dictionary containing the datasets. | None | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| Tuple[DataFrame, Any, List[Any], Any] | The dataset used,
Dependent variable,
Independent variable,
Between OLS model. | +--- diff --git a/website/content/sdk/reference/econometrics/bpag.md b/website/content/sdk/reference/econometrics/bpag.md new file mode 100644 index 000000000000..21cdb83b97c1 --- /dev/null +++ b/website/content/sdk/reference/econometrics/bpag.md @@ -0,0 +1,84 @@ +--- +title: bpag +description: The 'bpag' page provides comprehensive information about the Breusch-Pagan + test calculation in econometrics. The page contains source code and models for heteroscedasticity + and regression, including parameters, return types, and export format for data. +keywords: +- bpag +- heteroscedasticity +- Breusch-Pagan Test +- OLS Model +- econometrics +- regression model +- bpag_chart +- export data +- statsmodels +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + +Calculate test statistics for heteroscedasticity + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/econometrics/regression_model.py#L550)] + +```python +openbb.econometrics.bpag(model: statsmodels.regression.linear_model.RegressionResultsWrapper) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| model | OLS Model | Model containing residual values. | None | False | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | Test results from the Breusch-Pagan Test | +--- + + + + +Show Breusch-Pagan heteroscedasticity test + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/econometrics/regression_view.py#L182)] + +```python +openbb.econometrics.bpag_chart(model: statsmodels.regression.linear_model.RegressionResultsWrapper, export: str = "") +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| model | OLS Model | OLS model that has been fit. | None | False | +| export | str | Format to export data | | True | + + +--- + +## Returns + +This function does not return anything + +--- + + + diff --git a/website/content/sdk/reference/econometrics/clean.md b/website/content/sdk/reference/econometrics/clean.md new file mode 100644 index 000000000000..19d6fb2782ba --- /dev/null +++ b/website/content/sdk/reference/econometrics/clean.md @@ -0,0 +1,48 @@ +--- +title: clean +description: This documentation details how to use OpenBBTerminal's 'clean' function + to clean up NaNs in a pandas DataFrame. It outlines the parameters, return values, + and available methods for filling and dropping NaN values. +keywords: +- econometrics +- clean data +- NaN handling +- machine learning +- dataset cleaning +- fill method +- drop method +- data pre-processing +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Clean up NaNs from the dataset + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/econometrics/econometrics_model.py#L65)] + +```python +openbb.econometrics.clean(dataset: pd.DataFrame, fill: str = "", drop: str = "", limit: Optional[int] = None) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| dataset | pd.DataFrame | The dataset you wish to clean | None | False | +| fill | str | The method of filling NaNs. Choose from:
rfill, cfill, rbfill, cbfill, rffill, cffill | | True | +| drop | str | The method of dropping NaNs. Choose from:
rdrop, cdrop | | True | +| limit | int | The maximum limit you wish to apply that can be forward or backward filled | None | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | Dataframe with cleaned up data | +--- diff --git a/website/content/sdk/reference/econometrics/coint.md b/website/content/sdk/reference/econometrics/coint.md new file mode 100644 index 000000000000..faaa383a0e97 --- /dev/null +++ b/website/content/sdk/reference/econometrics/coint.md @@ -0,0 +1,89 @@ +--- +title: coint +description: This page is dedicated to the `coint` functionality of OpenBB Terminal. + Users can calculate cointegration tests between variable number of input series, + and get the results back as a Dataframe or a dictionary. This page provides the + source code and detailed description of parameters specific to the function. +keywords: +- cointegration tests +- coint +- data analysis +- pd.Series +- dataframe +- Dict +- openbb.econometrics.coint +- openbb.econometrics.coint_chart +- parameters description +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + +Calculate cointegration tests between variable number of input series + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/econometrics/econometrics_model.py#L249)] + +```python +openbb.econometrics.coint(datasets: pd.Series, return_z: bool = False) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| datasets | pd.Series | Input series to test cointegration for | None | False | +| return_z | bool | Flag to return the z data to plot | False | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| Union[pd.DataFrame,Dict] | Dataframe with results of cointegration tests or a Dict of the z results | +--- + + + + +Estimates long-run and short-run cointegration relationship for series y and x and apply + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/econometrics/econometrics_view.py#L314)] + +```python +openbb.econometrics.coint_chart(datasets: pd.Series, significant: bool = False, plot: bool = True, export: str = "", external_axes: Optional[List[axes]] = None) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| datasets | pd.Series | Variable number of series to test for cointegration | None | False | +| significant | float | Show only companies that have p-values lower than this percentage | False | True | +| plot | bool | Whether you wish to plot the z-values of all pairs. | True | True | +| export | str | Format to export data | | True | +| external_axes | Optional[List[plt.axes]] | External axes to plot on | None | True | + + +--- + +## Returns + +This function does not return anything + +--- + + + diff --git a/website/content/sdk/reference/econometrics/comparison.md b/website/content/sdk/reference/econometrics/comparison.md new file mode 100644 index 000000000000..8a6bb8b244a5 --- /dev/null +++ b/website/content/sdk/reference/econometrics/comparison.md @@ -0,0 +1,44 @@ +--- +title: comparison +description: This page provides a comparison function for Panel Data regression results + in the openbb terminal. It allows exporting the comparison data and returns an overview + of the different regression results as a PanelModelComparison. +keywords: +- Panel Data regression +- regression results comparison +- econometrics +- openbb terminal +- export data +- PanelModelComparison +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Compare regression results between Panel Data regressions. + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/econometrics/regression_model.py#L437)] + +```python +openbb.econometrics.comparison(regressions: Dict, export: str = "") +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| regressions | Dict | Dictionary with regression results. | None | False | +| export | str | Format to export data | | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| dict | Returns a PanelModelComparison which shows an overview of the different regression results. | +--- diff --git a/website/content/sdk/reference/econometrics/dwat.md b/website/content/sdk/reference/econometrics/dwat.md new file mode 100644 index 000000000000..d61a28841ee5 --- /dev/null +++ b/website/content/sdk/reference/econometrics/dwat.md @@ -0,0 +1,99 @@ +--- +title: dwat +description: Detailed explanation of Durbin Watson autocorrelation test calculations + and chart visualisation using OpenBBTerminal's econometrics functions. +keywords: +- Docusaurus +- Econometrics +- Durbin Watson +- Autocorrelation +- Statistical modelling +- Regression +- Data visualisation +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + +Calculate test statistics for Durbin Watson autocorrelation + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/econometrics/regression_model.py#L486)] + +```python +openbb.econometrics.dwat(model: statsmodels.regression.linear_model.RegressionResultsWrapper) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| model | statsmodels.regression.linear_model.RegressionResultsWrapper | Previously fit statsmodels OLS. | None | False | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| float | Test statistic of the Durbin Watson test. | +--- + +## Examples + +```python +from openbb_terminal.sdk import openbb +df = openbb.econometrics.load("wage_panel") +Y, X = df["lwage"], df[["exper","educ"]] +model = openbb.econometrics.ols(Y,X) +durbin_watson_value = openbb.econometrics.dwat(model) +``` + +``` +0.96 +``` +--- + + + + +Show Durbin-Watson autocorrelation tests + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/econometrics/regression_view.py#L81)] + +```python +openbb.econometrics.dwat_chart(model: statsmodels.regression.linear_model.RegressionResultsWrapper, dependent_variable: pd.Series, plot: bool = True, export: str = "", external_axes: Optional[List[axes]] = None) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| model | OLS Model | A fit statsmodels OLS model. | None | False | +| dependent_variable | pd.Series | The dependent variable for plotting | None | False | +| plot | bool | Whether to plot the residuals | True | True | +| export | str | Format to export data | | True | +| external_axes | Optional[List[plt.axes]] | External axes to plot on | None | True | + + +--- + +## Returns + +This function does not return anything + +--- + + + diff --git a/website/content/sdk/reference/econometrics/fdols.md b/website/content/sdk/reference/econometrics/fdols.md new file mode 100644 index 000000000000..f5fadc446533 --- /dev/null +++ b/website/content/sdk/reference/econometrics/fdols.md @@ -0,0 +1,45 @@ +--- +title: fdols +description: This documentation page provides information on First Differencing (fdols) + - an alternative to using fixed effects when there is possible correlation. It contains + the source code link, explanation of parameters and return details. +keywords: +- First Differencing +- fdols +- Fixed effects +- Dependent variable +- Independent variable +- Regression variables +- OLS model +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +First differencing is an alternative to using fixed effects when there might be correlation. + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/econometrics/regression_model.py#L399)] + +```python +openbb.econometrics.fdols(Y: pd.DataFrame, X: pd.DataFrame) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| regression_variables | list | The regressions variables entered where the first variable is
the dependent variable. | None | True | +| data | dict | A dictionary containing the datasets. | None | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| Tuple[DataFrame, Any, List[Any], Any] | The dataset used,
Dependent variable,
Independent variable,
First Difference OLS model | +--- diff --git a/website/content/sdk/reference/econometrics/fe.md b/website/content/sdk/reference/econometrics/fe.md new file mode 100644 index 000000000000..f911f9a7d08e --- /dev/null +++ b/website/content/sdk/reference/econometrics/fe.md @@ -0,0 +1,48 @@ +--- +title: fe +description: This page presents the fe function of the OpenBB Econometrics Module, + explaining its parameters and their functionality. Here, users can find about entity + effects, time effects, and regressors. +keywords: +- OpenBB Econometrics +- fe function +- entity effects +- time effects +- regressors +- Fixed Effects +- PanelOLS model +- regression model +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +When effects are correlated with the regressors the RE and BE estimators are not consistent. + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/econometrics/regression_model.py#L351)] + +```python +openbb.econometrics.fe(Y: pd.DataFrame, X: pd.DataFrame, entity_effects: bool = False, time_effects: bool = False) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| regression_variables | list | The regressions variables entered where the first variable is
the dependent variable. | None | True | +| data | dict | A dictionary containing the datasets. | None | True | +| entity_effects | bool | Whether to include entity effects | False | True | +| time_effects | bool | Whether to include time effects | False | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| Tuple[DataFrame, Any, List[Any], Any] | The dataset used,
Dependent variable,
Independent variable,
PanelOLS model with Fixed Effects | +--- diff --git a/website/content/sdk/reference/econometrics/get_regression_data.md b/website/content/sdk/reference/econometrics/get_regression_data.md new file mode 100644 index 000000000000..3a2b6f9a1cb6 --- /dev/null +++ b/website/content/sdk/reference/econometrics/get_regression_data.md @@ -0,0 +1,49 @@ +--- +title: get_regression_data +description: The 'get_regression_data' page offers a detailed overview of OpenBB finance's + function for regression data creation. It provides the source code link, describes + the parameters like regression variables and type, and explains the returned results, + such as the used dataset, dependent and independent variables, and the OLS model. +keywords: +- get_regression_data +- OpenBB finance +- regression variables +- source code link +- regression type +- OLS model +- dependent variable +- independent variable +- econometrics +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This function creates a DataFrame with the required regression data as + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/econometrics/regression_model.py#L112)] + +```python +openbb.econometrics.get_regression_data(regression_variables: List[tuple], data: Dict[str, pd.DataFrame], regression_type: str = "") +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| regression_variables | list | The regressions variables entered where the first variable is
the dependent variable. | None | False | +| data | dict | A dictionary containing the datasets. | None | False | +| regression_type | str | The type of regression that is executed. | | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| Tuple[DataFrame, Any, List[Any]] | The dataset used,
Dependent variable,
Independent variable,
OLS model. | +--- diff --git a/website/content/sdk/reference/econometrics/granger.md b/website/content/sdk/reference/econometrics/granger.md new file mode 100644 index 000000000000..6b4c3337fdd9 --- /dev/null +++ b/website/content/sdk/reference/econometrics/granger.md @@ -0,0 +1,85 @@ +--- +title: granger +description: Documentation about Granger test functions to calculate and visualize + Econometrics models in OpenBB terminal. Covers usage, parameters and return types. +keywords: +- Granger test +- Econometrics +- OpenBB terminal +- Source code +- Function parameters +- function return +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + +Calculate granger tests + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/econometrics/econometrics_model.py#L210)] + +```python +openbb.econometrics.granger(dependent_series: pd.Series, independent_series: pd.Series, lags: int = 3) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| dependent_series | Series | The series you want to test Granger Causality for. | None | False | +| independent_series | Series | The series that you want to test whether it Granger-causes time_series_y | None | False | +| lags | int | The amount of lags for the Granger test. By default, this is set to 3. | 3 | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| dict | Dictionary containing results of Granger test | +--- + + + + +Show granger tests + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/econometrics/econometrics_view.py#L247)] + +```python +openbb.econometrics.granger_chart(dependent_series: pd.Series, independent_series: pd.Series, lags: int = 3, confidence_level: float = 0.05, export: str = "") +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| dependent_series | Series | The series you want to test Granger Causality for. | None | False | +| independent_series | Series | The series that you want to test whether it Granger-causes dependent_series | None | False | +| lags | int | The amount of lags for the Granger test. By default, this is set to 3. | 3 | True | +| confidence_level | float | The confidence level you wish to use. By default, this is set to 0.05. | 0.05 | True | +| export | str | Format to export data | | True | + + +--- + +## Returns + +This function does not return anything + +--- + + + diff --git a/website/content/sdk/reference/econometrics/load.md b/website/content/sdk/reference/econometrics/load.md new file mode 100644 index 000000000000..d8fcc8d06423 --- /dev/null +++ b/website/content/sdk/reference/econometrics/load.md @@ -0,0 +1,45 @@ +--- +title: load +description: The page provides information on loading custom files into a dataframe + in OpenBB. It offers the function definition, parameters, and returns +keywords: +- dataframe +- load function +- custom files +- parameters +- returns +- Statsmodels examples +- Export folder +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Load custom file into dataframe. + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/common/common_model.py#L53)] + +```python +openbb.econometrics.load(file: str, data_files: Optional[Dict[Any, Any]] = None, data_examples: Optional[Dict[Any, Any]] = None) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| file | str | Path to file | None | False | +| data_files | dict | Contains all available data files within the Export folder | None | True | +| data_examples | dict | Contains all available examples from Statsmodels | None | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | Dataframe with custom data | +--- diff --git a/website/content/sdk/reference/econometrics/norm.md b/website/content/sdk/reference/econometrics/norm.md new file mode 100644 index 000000000000..07892c35eb63 --- /dev/null +++ b/website/content/sdk/reference/econometrics/norm.md @@ -0,0 +1,89 @@ +--- +title: norm +description: This page provides a detailed guide for testing normality in data series + using Python with a graphical representation of normal distribution. It also explains + how to export data and use external axes for plotting. +keywords: +- Econometrics +- OpenBB-finance +- Data normality test +- Timeseries +- Histogram +- Data exporting +- Data plotting +- Data Science +- Statistics +- Normal distribution +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + +The distribution of returns and generate statistics on the relation to the normal curve. + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/econometrics/econometrics_model.py#L113)] + +```python +openbb.econometrics.norm(data: pd.Series) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| data | pd.Series | A series or column of a DataFrame to test normality for | None | False | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | Dataframe containing statistics of normality | +--- + + + + +Determine the normality of a timeseries. + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/econometrics/econometrics_view.py#L129)] + +```python +openbb.econometrics.norm_chart(data: pd.Series, dataset: str = "", column: str = "", plot: bool = True, export: str = "", external_axes: Optional[List[axes]] = None) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| data | pd.Series | Series of custom data | None | False | +| dataset | str | Dataset name | | True | +| column | str | Column for y data | | True | +| plot | bool | Whether you wish to plot a histogram | True | True | +| export | str | Format to export data. | | True | +| external_axes | Optional[List[plt.axes]] | External axes to plot on | None | True | + + +--- + +## Returns + +This function does not return anything + +--- + + + diff --git a/website/content/sdk/reference/econometrics/ols.md b/website/content/sdk/reference/econometrics/ols.md new file mode 100644 index 000000000000..3f687eba348c --- /dev/null +++ b/website/content/sdk/reference/econometrics/ols.md @@ -0,0 +1,96 @@ +--- +title: ols +description: Perform OLS regression on timeseries data using the 'ols' function from + OpenBB's econometrics module. The page includes parameters description, return type, + and a practical example with code. +keywords: +- ols +- timeseries data +- statsmodels +- regression +- openbb.econometrics.ols +- Dependent variable series +- Independent variables series +- RegressionResultsWrapper +- OLS Regression Results +- R-squared +- Least Squares +- F-statistic +- Prob (F-statistic) +- Log-Likelihood +- AIC +- BIC +- Df Residuals +- Df Model +- Covariance Type +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Performs an OLS regression on timeseries data. [Source: Statsmodels] + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/econometrics/regression_model.py#L176)] + +```python +openbb.econometrics.ols(Y: pd.DataFrame, X: pd.DataFrame) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| Y | pd.DataFrame | Dependent variable series. | None | False | +| X | pd.DataFrame | Dataframe of independent variables series. | None | False | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| statsmodels.regression.linear_model.RegressionResultsWrapper | Regression model wrapper from statsmodels. | +--- + +## Examples + +```python +import openbb_terminal.sdk as openbb +df = openbb.econometrics.load("wage_panel") +OLS_model = openbb.econometrics.OLS(df["lwage"], df[["educ", "exper", "expersq"]]) +print(OLS_model.summary())` +``` + +``` +OLS Regression Results +======================================================================================= +Dep. Variable: lwage R-squared (uncentered): 0.920 +Model: OLS Adj. R-squared (uncentered): 0.919 +Method: Least Squares F-statistic: 1.659e+04 +Date: Thu, 10 Nov 2022 Prob (F-statistic): 0.00 +Time: 15:28:11 Log-Likelihood: -3091.3 +No. Observations: 4360 AIC: 6189. +Df Residuals: 4357 BIC: 6208. +Df Model: 3 +Covariance Type: nonrobust +============================================================================== + coef std err t P>|t| [0.025 0.975] +------------------------------------------------------------------------------ +educ 0.0986 0.002 39.879 0.000 0.094 0.103 +exper 0.1018 0.009 10.737 0.000 0.083 0.120 +expersq -0.0034 0.001 -4.894 0.000 -0.005 -0.002 +============================================================================== +Omnibus: 1249.642 Durbin-Watson: 0.954 +Prob(Omnibus): 0.000 Jarque-Bera (JB): 9627.436 +Skew: -1.152 Prob(JB): 0.00 +Kurtosis: 9.905 Cond. No. 86.4 +============================================================================== +Notes: +[1] R² is computed without centering (uncentered) since the model does not contain a constant. +[2] Standard Errors assume that the covariance matrix of the errors is correctly specified. +``` +--- diff --git a/website/content/sdk/reference/econometrics/options.md b/website/content/sdk/reference/econometrics/options.md new file mode 100644 index 000000000000..94fba4b889cb --- /dev/null +++ b/website/content/sdk/reference/econometrics/options.md @@ -0,0 +1,86 @@ +--- +title: options +description: This page details two main functionalities of OpenBB-finance's model + and chart components - obtaining columns-dataset combinations from datasets for + use in commands and plotting custom data. Code snippets, links to source code, parameters + involved, and return types are provided. +keywords: +- OpenBB finance +- data visualization +- data modelling +- datasets +- econometrics +- tabs +- chart +- options +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + +Obtain columns-dataset combinations from loaded in datasets that can be used in other commands + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/econometrics/econometrics_model.py#L23)] + +```python +openbb.econometrics.options(datasets: Dict[str, pd.DataFrame], dataset_name: str = "") +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| datasets | dict | The available datasets. | None | False | +| dataset_name | str | The dataset you wish to show the options for. | | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| Dict[Union[str, Any], pd.DataFrame] | A dictionary with a DataFrame for each option. With dataset_name set, only shows one
options table. | +--- + + + + +Plot custom data + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/econometrics/econometrics_view.py#L27)] + +```python +openbb.econometrics.options_chart(datasets: Dict[str, pd.DataFrame], dataset_name: str = None, export: str = "") +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| datasets | dict | The loaded in datasets | None | False | +| dataset_name | str | The name of the dataset you wish to show options for | None | True | +| export | str | Format to export image | | True | + + +--- + +## Returns + +This function does not return anything + +--- + + + diff --git a/website/content/sdk/reference/econometrics/panel.md b/website/content/sdk/reference/econometrics/panel.md new file mode 100644 index 000000000000..4cffc13a2290 --- /dev/null +++ b/website/content/sdk/reference/econometrics/panel.md @@ -0,0 +1,140 @@ +--- +title: panel +description: Tutorial on how to use OpenBB Terminal's econometric functions with focus + on running panel regression models. This includes choosing the type of regression, + setting entity and time effects, and interacting with the Python SDK. Provides examples + using the 'openbb.econometrics.panel' function, which allows selection of OLS or + pooled OLS models, and demonstrates how to read and interpret the model summary. + Also explains the 'openbb.econometrics.panel_chart' function, which visualizes regression + outcomes. +keywords: +- Docusaurus +- Econometrics +- Panel Regression +- Fixed Effects +- Python SDK +- OLS Regression +- Regression Model +- Pooled OLS +- Regression Chart +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + +Based on the regression type, this function decides what regression to run. + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/econometrics/regression_model.py#L34)] + +```python +openbb.econometrics.panel(Y: pd.DataFrame, X: pd.DataFrame, regression_type: str = "OLS", entity_effects: bool = False, time_effects: bool = False) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| Y | pd.DataFrame | Dataframe containing the dependent variable. | None | False | +| X | pd.DataFrame | Dataframe containing the independent variables. | None | False | +| regression_type | str | The type of regression you wish to execute. | OLS | True | +| entity_effects | bool | Whether to apply Fixed Effects on entities. | False | True | +| time_effects | bool | Whether to apply Fixed Effects on time. | False | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| Any | A regression model | +--- + +## Examples + +```python +from openbb_terminal.sdk import openbb +df = openbb.econometrics.load("wage_panel") +df = df.set_index(["nr","year"]) +X = df[["exper","educ","union"]] +Y = df["lwage"] +pooled_ols_model = openbb.econometrics.panel(Y,X,"POLS") +print(pooled_ols_model.summary) +``` + +``` +PooledOLS Estimation Summary +================================================================================ +Dep. Variable: lwage R-squared: 0.1634 +Estimator: PooledOLS R-squared (Between): 0.1686 +No. Observations: 4360 R-squared (Within): 0.1575 +Date: Sun, Nov 13 2022 R-squared (Overall): 0.1634 +Time: 13:04:02 Log-likelihood -3050.4 +Cov. Estimator: Unadjusted + F-statistic: 283.68 +Entities: 545 P-value 0.0000 +Avg Obs: 8.0000 Distribution: F(3,4356) +Min Obs: 8.0000 +Max Obs: 8.0000 F-statistic (robust): 283.68 + P-value 0.0000 +Time periods: 8 Distribution: F(3,4356) +Avg Obs: 545.00 +Min Obs: 545.00 +Max Obs: 545.00 + Parameter Estimates +============================================================================== + Parameter Std. Err. T-stat P-value Lower CI Upper CI +------------------------------------------------------------------------------ +const -0.0308 0.0620 -0.4965 0.6196 -0.1523 0.0908 +exper 0.0561 0.0028 20.220 0.0000 0.0507 0.0616 +educ 0.1080 0.0045 24.034 0.0000 0.0992 0.1168 +union 0.1777 0.0172 10.344 0.0000 0.1441 0.2114 +============================================================================== +``` +--- + + + + +Based on the regression type, this function decides what regression to run. + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/econometrics/regression_view.py#L23)] + +```python +openbb.econometrics.panel_chart(Y: pd.DataFrame, X: pd.DataFrame, regression_type: str = "OLS", entity_effects: bool = False, time_effects: bool = False, export: str = "") +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| data | dict | A dictionary containing the datasets. | None | True | +| regression_variables | list | The regressions variables entered where the first variable is
the dependent variable.
each column/dataset combination. | None | True | +| regression_type | str | The type of regression you wish to execute. Choose from:
OLS, POLS, RE, BOLS, FE | OLS | True | +| entity_effects | bool | Whether to apply Fixed Effects on entities. | False | True | +| time_effects | bool | Whether to apply Fixed Effects on time. | False | True | +| export | str | Format to export data | | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| The dataset used, the dependent variable, the independent variable and | | +--- + + + diff --git a/website/content/sdk/reference/econometrics/pols.md b/website/content/sdk/reference/econometrics/pols.md new file mode 100644 index 000000000000..668929976f7d --- /dev/null +++ b/website/content/sdk/reference/econometrics/pols.md @@ -0,0 +1,48 @@ +--- +title: pols +description: The page provides detailed information on using PooledOLS in OpenBB, + a plain OLS that can comprehend various panel data structures. It includes parameters + and return types for the 'openbb.econometrics.pols' function. +keywords: +- pols +- PooledOLS +- OLS +- panel data structures +- openbb.econometrics.pols +- regression_variables +- data +- PooledOLS model +- Dependent variable +- Independent variable +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +PooledOLS is just plain OLS that understands that various panel data structures. + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/econometrics/regression_model.py#L239)] + +```python +openbb.econometrics.pols(Y: pd.DataFrame, X: pd.DataFrame) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| regression_variables | list | The regressions variables entered where the first variable is
the dependent variable. | None | True | +| data | dict | A dictionary containing the datasets. | None | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| Tuple[DataFrame, Any, List[Any], Any] | The dataset used,
Dependent variable,
Independent variable,
PooledOLS model | +--- diff --git a/website/content/sdk/reference/econometrics/re.md b/website/content/sdk/reference/econometrics/re.md new file mode 100644 index 000000000000..0b7d0153c071 --- /dev/null +++ b/website/content/sdk/reference/econometrics/re.md @@ -0,0 +1,49 @@ +--- +title: re +description: This page provides a detailed look into the Random Effects Model developed + by OpenBB. It covers the parameters involved such as regression variables and data + sets, the return type, and a link is provided to access the source code, making + it a valuable resource for any data scientist interested in econometrics. +keywords: +- random effects model +- regression variables +- data science +- Python code +- econometrics +- pooled OLS model +- independent variable +- dependent variable +- dataset +- github +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +The random effects model is virtually identical to the pooled OLS model except that is accounts for the + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/econometrics/regression_model.py#L276)] + +```python +openbb.econometrics.re(Y: pd.DataFrame, X: pd.DataFrame) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| regression_variables | list | The regressions variables entered where the first variable is
the dependent variable. | None | True | +| data | dict | A dictionary containing the datasets. | None | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| Tuple[DataFrame, Any, List[Any], Any] | The dataset used,
Dependent variable,
Independent variable,
RandomEffects model | +--- diff --git a/website/content/sdk/reference/econometrics/root.md b/website/content/sdk/reference/econometrics/root.md new file mode 100644 index 000000000000..c76fdb36aa4d --- /dev/null +++ b/website/content/sdk/reference/econometrics/root.md @@ -0,0 +1,87 @@ +--- +title: root +description: Detailed explanation of OpenBB's econometrics Python library focusing + on the functionality of unit root tests including ADF and KPSS tests. The page features + instructions on how to conduct these tests with Python, making it beneficial for + data analysts and those interested in data series analysis. +keywords: +- Docusaurus +- Econometrics +- ADF test +- KPSS test +- Data series +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + +Calculate test statistics for unit roots + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/econometrics/econometrics_model.py#L168)] + +```python +openbb.econometrics.root(data: pd.Series, fuller_reg: str = "c", kpss_reg: str = "c") +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| data | pd.Series | Series or column of DataFrame of target variable | None | False | +| fuller_reg | str | Type of regression of ADF test | c | True | +| kpss_reg | str | Type of regression for KPSS test | c | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | Dataframe with results of ADF test and KPSS test | +--- + + + + +Determine the normality of a timeseries. + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/econometrics/econometrics_view.py#L197)] + +```python +openbb.econometrics.root_chart(data: pd.Series, dataset: str = "", column: str = "", fuller_reg: str = "c", kpss_reg: str = "c", export: str = "") +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| data | pd.Series | Series of target variable | None | False | +| dataset | str | Name of the dataset | | True | +| column | str | Name of the column | | True | +| fuller_reg | str | Type of regression of ADF test. Choose c, ct, ctt, or nc | c | True | +| kpss_reg | str | Type of regression for KPSS test. Choose c or ct | c | True | +| export | str | Format to export data. | | True | + + +--- + +## Returns + +This function does not return anything + +--- + + + diff --git a/website/content/sdk/reference/economy/available_indices.md b/website/content/sdk/reference/economy/available_indices.md new file mode 100644 index 000000000000..112591c55878 --- /dev/null +++ b/website/content/sdk/reference/economy/available_indices.md @@ -0,0 +1,38 @@ +--- +title: available_indices +description: A documentation page for the available_indices function in the OpenBBTerminal + module. This function returns the available indices without requiring parameters. +keywords: +- available_indices +- indices +- function +- no parameters +- dictionary +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Get available indices + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/economy/yfinance_model.py#L660)] + +```python +openbb.economy.available_indices() +``` + +--- + +## Parameters + +This function does not take any parameters. + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| Dict[str, Dict[str, str]] | Dictionary with available indices and respective detail | +--- diff --git a/website/content/sdk/reference/economy/bigmac.md b/website/content/sdk/reference/economy/bigmac.md new file mode 100644 index 000000000000..6780ede9351e --- /dev/null +++ b/website/content/sdk/reference/economy/bigmac.md @@ -0,0 +1,88 @@ +--- +title: bigmac +description: This page provides documentation for the Big Mac Index functionality + in OpenBB. It includes details on how to use the 'bigmac' function and its parameters, + along with source code links and return information. This information is useful + for individuals looking to utilize the OpenBB economic dataset for data analysis. +keywords: +- bigmac +- docusaurus +- Big Mac Index +- economy +- country_codes +- dataframe +- matplotlib +- USD equivalent +- parameters +- returns +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + +Display Big Mac Index for given countries + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/economy/nasdaq_model.py#L183)] + +```python +openbb.economy.bigmac(country_codes: List[str] = None) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| country_codes | List[str] | List of country codes (ISO-3 letter country code). Codes available through economy.country_codes(). | None | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | Dataframe with Big Mac indices converted to USD equivalent. | +--- + + + + +Display Big Mac Index for given countries + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/economy/nasdaq_view.py#L59)] + +```python +openbb.economy.bigmac_chart(country_codes: List[str] = None, raw: bool = False, export: str = "", external_axes: Optional[List[matplotlib.axes._axes.Axes]] = None) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| country_codes | List[str] | List of country codes (ISO-3 letter country code). Codes available through economy.country_codes(). | None | True | +| raw | bool | Flag to display raw data, by default False | False | True | +| export | str | Format data, by default "" | | True | +| external_axes | Optional[List[plt.Axes]] | External axes (1 axis is expected in the list), by default None | None | True | + + +--- + +## Returns + +This function does not return anything + +--- + + + diff --git a/website/content/sdk/reference/economy/country_codes.md b/website/content/sdk/reference/economy/country_codes.md new file mode 100644 index 000000000000..0e2cdb68419e --- /dev/null +++ b/website/content/sdk/reference/economy/country_codes.md @@ -0,0 +1,43 @@ +--- +title: country_codes +description: This is the Country Codes page for the Bigmac index in the OpenBBTerminal. + It provides available country codes, specified as ISO-3 letter country codes, and + requires no parameters. +keywords: +- Country codes +- Bigmac index +- OpenBB finance +- Economy +- ISO-3 codes +- Source Code +- Parameters +- Returns +- Nasdaq model +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Get available country codes for Bigmac index + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/economy/nasdaq_model.py#L125)] + +```python +openbb.economy.country_codes() +``` + +--- + +## Parameters + +This function does not take any parameters. + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| List[str] | List of ISO-3 letter country codes. | +--- diff --git a/website/versioned_docs/version-v3/sdk/reference/economy/cpi.md b/website/content/sdk/reference/economy/cpi.md similarity index 76% rename from website/versioned_docs/version-v3/sdk/reference/economy/cpi.md rename to website/content/sdk/reference/economy/cpi.md index 973f0f908ad6..466de817114f 100644 --- a/website/versioned_docs/version-v3/sdk/reference/economy/cpi.md +++ b/website/content/sdk/reference/economy/cpi.md @@ -1,13 +1,28 @@ --- title: cpi -description: OpenBB SDK Function +description: This page provides documentation on the cpi command within the OpenBBTerminal. + It explains how to use the command to fetch Consumer Price Index data from Alpha + Vantage and to display the US Consumer Price Index as a chart. It lists all parameters + and returns for this command. +keywords: +- cpi +- consumer price index +- Alpha Vantage +- dataframe +- matplotlib +- economy +- chart +- parameters +- returns --- +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; -# cpi - @@ -38,8 +53,6 @@ openbb.economy.cpi(interval: str = "m", start_year: int = 2010) | pd.DataFrame | Dataframe of CPI | --- - - @@ -72,7 +85,5 @@ This function does not return anything --- - - - \ No newline at end of file + diff --git a/website/content/sdk/reference/economy/currencies.md b/website/content/sdk/reference/economy/currencies.md new file mode 100644 index 000000000000..470bec96a242 --- /dev/null +++ b/website/content/sdk/reference/economy/currencies.md @@ -0,0 +1,40 @@ +--- +title: currencies +description: This page provides information about accessing global currencies data + through a Python function. The function returns a DataFrame with the name, price, + net change, and percent change of multiple currencies. +keywords: +- global currencies data +- data scraping +- economy.currencies +- price +- net change +- percent change +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Scrape data for global currencies + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/economy/wsj_model.py#L242)] + +```python +openbb.economy.currencies() +``` + +--- + +## Parameters + +This function does not take any parameters. + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | Dataframe containing name, price, net change and percent change | +--- diff --git a/website/content/sdk/reference/economy/events.md b/website/content/sdk/reference/economy/events.md new file mode 100644 index 000000000000..195abbc5f13b --- /dev/null +++ b/website/content/sdk/reference/economy/events.md @@ -0,0 +1,70 @@ +--- +title: events +description: Implement our economic calendar for selected countries and specific dates + functionality in your application using OpenBB. Use it to analyze global economic + trends or forecast market movements. +keywords: +- economic calendar +- financial market events +- global economy +- market analysis +- economic forecast +- economic events +- countries economy +- economic data retrieval +- market trends +- predictive analytics +- economic indicators +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Get economic calendar for countries between specified dates + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/economy/nasdaq_model.py#L21)] + +```python +openbb.economy.events(countries: Union[List[str], str] = "", start_date: Optional[str] = None, end_date: Optional[str] = None) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| countries | [List[str],str] | List of countries to include in calendar. Empty returns all | | True | +| start_date | Optional[str] | Start date for calendar | None | True | +| end_date | Optional[str] | End date for calendar | None | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | Economic calendar | +--- + +## Examples + + +Get todays economic calendar for the United States + +```python +from openbb_terminal.sdk import openbb +calendar = openbb.economy.events("United States") +``` + + +To get multiple countries for a given date, pass the same start and end date as well as +a list of countries + +```python +calendars = openbb.economy.events(["United States","Canada"], start_date="2022-11-18", end_date="2022-11-18") +``` + +--- diff --git a/website/content/sdk/reference/economy/fred.md b/website/content/sdk/reference/economy/fred.md new file mode 100644 index 000000000000..9de6924baa27 --- /dev/null +++ b/website/content/sdk/reference/economy/fred.md @@ -0,0 +1,95 @@ +--- +title: fred +description: The page includes detailed information on the 'fred' function in the + OpenBBTerminal software. With this function, users can acquire and visualize economic + series data from the Federal Reserve Economic Data (FRED) database. It also lists + out function parameters and return type. +keywords: +- fred function +- Federal Reserve Economic Data +- FRED +- economy +- series data +- parameters +- return type +- visualization +- code +- metadata +- data retrieval +- data analysis +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + +Get Series data. [Source: FRED] + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/economy/fred_model.py#L208)] + +```python +openbb.economy.fred(series_ids: List[str], start_date: Optional[str] = None, end_date: Optional[str] = None) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| series_ids | List[str] | Series ID to get data from | None | False | +| start_date | str | Start date to get data from, format yyyy-mm-dd | None | True | +| end_date | str | End data to get from, format yyyy-mm-dd | None | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | Series data | +--- + + + + +Display (multiple) series from https://fred.stlouisfed.org. [Source: FRED] + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/economy/fred_view.py#L76)] + +```python +openbb.economy.fred_chart(series_ids: List[str], start_date: Optional[str] = None, end_date: Optional[str] = None, limit: int = 10, get_data: bool = False, raw: bool = False, export: str = "", external_axes: Optional[List[matplotlib.axes._axes.Axes]] = None) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| series_ids | List[str] | FRED Series ID from https://fred.stlouisfed.org. For multiple series use: series1,series2,series3 | None | False | +| start_date | Optional[str] | Starting date (YYYY-MM-DD) of data | None | True | +| end_date | Optional[str] | Ending date (YYYY-MM-DD) of data | None | True | +| limit | int | Number of data points to display. | 10 | True | +| raw | bool | Output only raw data | False | True | +| export | str | Export data to csv,json,xlsx or png,jpg,pdf,svg file | | True | +| external_axes | Optional[List[plt.Axes]] | External axes (1 axis is expected in the list), by default None | None | True | + + +--- + +## Returns + +This function does not return anything + +--- + + + diff --git a/website/content/sdk/reference/economy/fred_ids.md b/website/content/sdk/reference/economy/fred_ids.md new file mode 100644 index 000000000000..fe18afe698d5 --- /dev/null +++ b/website/content/sdk/reference/economy/fred_ids.md @@ -0,0 +1,44 @@ +--- +title: fred_ids +description: This page helps to understand the 'openbb.economy.fred_ids' function, + which is a text query method for getting series IDs on FRED via OpenBB-finance. + Includes parameters, return information and link to the source code. +keywords: +- FRED +- OpenBB-finance +- Series ID +- Information retrieval +- FRED series notes database +- openbb.economy.fred_ids +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Get Series IDs. [Source: FRED] + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/economy/fred_model.py#L126)] + +```python +openbb.economy.fred_ids(search_query: str, limit: int = -1) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| search_query | str | Text query to search on fred series notes database | None | False | +| limit | int | Maximum number of series IDs to output | -1 | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.Dataframe | Dataframe with series IDs and titles | +--- diff --git a/website/content/sdk/reference/economy/fred_notes.md b/website/content/sdk/reference/economy/fred_notes.md new file mode 100644 index 000000000000..29d7ed661764 --- /dev/null +++ b/website/content/sdk/reference/economy/fred_notes.md @@ -0,0 +1,45 @@ +--- +title: fred_notes +description: Learn about OpenBB's FRED model and how it makes searching the series + notes database easier. This page also talks about the search and limit parameters + involved when querying the FRED database, and the DataFrame of matched series it + returns. +keywords: +- FRED series notes +- OpenBB economy +- FRED model +- data searching +- text query +- series notes database +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Get series notes. [Source: FRED] + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/economy/fred_model.py#L68)] + +```python +openbb.economy.fred_notes(search_query: str, limit: int = -1) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| search_query | str | Text query to search on fred series notes database | None | False | +| limit | int | Maximum number of series notes to display | -1 | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | DataFrame of matched series | +--- diff --git a/website/content/sdk/reference/economy/future.md b/website/content/sdk/reference/economy/future.md new file mode 100644 index 000000000000..d6b7fea916fb --- /dev/null +++ b/website/content/sdk/reference/economy/future.md @@ -0,0 +1,51 @@ +--- +title: future +description: This page provides detailed documentation on how to use OpenBB's 'future' + function in Python script. It explains parameters and returns related to different + financial instruments. +keywords: +- OpenBB future function +- Python script +- financial instruments +- Indices +- Energy +- Metals +- Meats +- Grains +- Softs +- Bonds +- Currencies +- Finviz +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Get futures data. [Source: Finviz] + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/economy/finviz_model.py#L187)] + +```python +openbb.economy.future(future_type: str = "Indices", sortby: str = "ticker", ascend: bool = False) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| future_type | str | From the following: Indices, Energy, Metals, Meats, Grains, Softs, Bonds, Currencies | Indices | True | +| sortby | str | Column to sort by | ticker | True | +| ascend | bool | Flag to sort in ascending order | False | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.Dataframe | Indices, Energy, Metals, Meats, Grains, Softs, Bonds, Currencies | +--- diff --git a/website/content/sdk/reference/economy/futures.md b/website/content/sdk/reference/economy/futures.md new file mode 100644 index 000000000000..c22d71ce10ea --- /dev/null +++ b/website/content/sdk/reference/economy/futures.md @@ -0,0 +1,73 @@ +--- +title: futures +description: This page provides information on how to retrieve and manipulate futures + data using the OpenBB economy function. It includes examples and descriptions for + parameters such as data source and future type. +keywords: +- economy +- futures data +- Finviz +- WSJ +- Indices +- Energy +- Metals +- Meats +- Grains +- Softs +- Bonds +- Currencies +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Get futures data. + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/economy/sdk_helpers.py#L8)] + +```python +openbb.economy.futures(source: Any = "WSJ", future_type: str = "Indices") +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| source | str | Data source for futures data. From the following: WSJ, Finviz | WSJ | True | +| future_type | str | (Finviz only) Future type to get. Can be: Indices, Energy, Metals, Meats, Grains, Softs, Bonds, Currencies. | Indices | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | Dataframe of futures data. | +--- + +## Examples + +```python +from openbb_terminal.sdk import openbb +wsj_futures = openbb.economy.futures() +``` + +``` +To sort by the largest percent change: +``` +```python +futures_sorted = openbb.economy.futures().sort_values(by="%Chg", ascending=False) +``` + +``` +FinViz provides different options for future types. We can get Meats with the following command: +``` +```python +meat_futures = openbb.economy.futures(source="Finviz", future_type="Meats") +``` + +--- diff --git a/website/versioned_docs/version-v3/sdk/reference/economy/gdp.md b/website/content/sdk/reference/economy/gdp.md similarity index 77% rename from website/versioned_docs/version-v3/sdk/reference/economy/gdp.md rename to website/content/sdk/reference/economy/gdp.md index c0cc660fb72f..c14286bc41eb 100644 --- a/website/versioned_docs/version-v3/sdk/reference/economy/gdp.md +++ b/website/content/sdk/reference/economy/gdp.md @@ -1,13 +1,26 @@ --- title: gdp -description: OpenBB SDK Function +description: This page provides in-depth documentation about the 'gdp' function in + the openbb economy package. It details how to retrieve real GDP data for the U.S. + on a yearly or quarterly basis, and how to produce a chart visualizing this data. +keywords: +- economy +- gdp +- data retrieval +- visualization +- API documentation +- yearly data +- quarterly data +- AlphaVantage --- +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; -# gdp - @@ -38,8 +51,6 @@ openbb.economy.gdp(interval: str = "q", start_year: int = 2010) | pd.DataFrame | Dataframe of GDP | --- - - @@ -72,7 +83,5 @@ This function does not return anything --- - - - \ No newline at end of file + diff --git a/website/content/sdk/reference/economy/gdpc.md b/website/content/sdk/reference/economy/gdpc.md new file mode 100644 index 000000000000..fb0e0da464c9 --- /dev/null +++ b/website/content/sdk/reference/economy/gdpc.md @@ -0,0 +1,88 @@ +--- +title: gdpc +description: The page provides details on using the 'gdpc' function of OpenBBTerminal. + It allows plotting and exporting United States' GDP per Capita data. The page also + gives link to the source code and gives examples of how to use the functions with + Python. +keywords: +- GDP per Capita +- gdpc +- Real GDP +- United States Economy +- plotting tool +- economy model +- Data visualization +- Raw data +- Export data +- Source code +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + +Real GDP per Capita for United States + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/economy/alphavantage_model.py#L96)] + +```python +openbb.economy.gdpc(start_year: int = 2010) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| start_year | int | Start year for plot, by default 2010 | 2010 | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | DataFrame of GDP per Capita | +--- + + + + +Display US GDP per Capita from AlphaVantage + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/economy/alphavantage_view.py#L146)] + +```python +openbb.economy.gdpc_chart(start_year: int = 2010, raw: bool = False, export: str = "", external_axes: Optional[List[matplotlib.axes._axes.Axes]] = None) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| start_year | int | Start year for plot, by default 2010 | 2010 | True | +| raw | bool | Flag to show raw data, by default False | False | True | +| export | str | Format to export data, by default | | True | +| external_axes | Optional[List[plt.Axes]] | External axes (1 axis is expected in the list), by default None | None | True | + + +--- + +## Returns + +This function does not return anything + +--- + + + diff --git a/website/content/sdk/reference/economy/get_groups.md b/website/content/sdk/reference/economy/get_groups.md new file mode 100644 index 000000000000..ab17c328ec07 --- /dev/null +++ b/website/content/sdk/reference/economy/get_groups.md @@ -0,0 +1,38 @@ +--- +title: get_groups +description: This page provides content about the openbb.economy.get_groups() function, + sourced from OpenBB-Finance. The function doesn't take any parameters nor returns + any output. +keywords: +- openbb.economy.get_groups() +- OpenBB-Finance +- No-parameters +- No-return +- Source-code +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Get group available + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/economy/finviz_model.py#L60)] + +```python +openbb.economy.get_groups() +``` + +--- + +## Parameters + +This function does not take any parameters. + +--- + +## Returns + +This function does not return anything + +--- diff --git a/website/content/sdk/reference/economy/glbonds.md b/website/content/sdk/reference/economy/glbonds.md new file mode 100644 index 000000000000..8550f09592a2 --- /dev/null +++ b/website/content/sdk/reference/economy/glbonds.md @@ -0,0 +1,39 @@ +--- +title: glbonds +description: Webpage on 'glbonds' function - a data scraping tool for global bonds + information. It returns name, coupon rate, yield and change in yield. +keywords: +- glbonds +- data scraping +- global bonds +- yield +- rate +- change +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Scrape data for global bonds + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/economy/wsj_model.py#L204)] + +```python +openbb.economy.glbonds() +``` + +--- + +## Parameters + +This function does not take any parameters. + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | Dataframe containing name, coupon rate, yield and change in yield | +--- diff --git a/website/content/sdk/reference/economy/index_cmd.md b/website/content/sdk/reference/economy/index_cmd.md new file mode 100644 index 000000000000..96a5002c032c --- /dev/null +++ b/website/content/sdk/reference/economy/index_cmd.md @@ -0,0 +1,109 @@ +--- +title: index +description: This page provides documentation for the OpenBB Terminal SDK functions + for fetching and visualizing economic indices data from Yahoo Finance. It provides + Python code examples and explains parameters and returns in detail. +keywords: +- Docusaurus documentation +- OpenBB Terminal SDK +- Economy indices +- Yahoo Finance data +- Data visualization +- Python code examples +- Data intervals +- Data start and end dates +- Adjusted Close +- Cumulative returns on index +- Export data +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + +Get data on selected indices over time [Source: Yahoo Finance] + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/economy/yfinance_model.py#L672)] + +```python +openbb.economy.index(indices: list, interval: str = "1d", start_date: int = None, end_date: int = None, column: str = "Adj Close", returns: bool = False) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| indices | list | A list of indices to get data. Available indices can be accessed through economy.available_indices(). | None | False | +| interval | str | Valid intervals: 1m,2m,5m,15m,30m,60m,90m,1h,1d,5d,1wk,1mo,3mo
Intraday data cannot extend last 60 days | 1d | True | +| start_date | str | The starting date, format "YEAR-MONTH-DAY", i.e. 2010-12-31. | None | True | +| end_date | str | The end date, format "YEAR-MONTH-DAY", i.e. 2020-06-05. | None | True | +| column | str | Which column to load in, by default "Adjusted Close". | Adj Close | True | +| returns | bool | Flag to show cumulative returns on index | False | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.Dataframe | Dataframe with historical data on selected indices. | +--- + +## Examples + +```python +from openbb_terminal.sdk import openbb +openbb.economy.available_indices() +openbb.economy.index(["^GSPC", "sp400"]) +``` + +--- + + + + +Load (and show) the selected indices over time [Source: Yahoo Finance] + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/economy/yfinance_view.py#L30)] + +```python +openbb.economy.index_chart(indices: list, interval: str = "1d", start_date: int = None, end_date: int = None, column: str = "Adj Close", returns: bool = False, raw: bool = False, external_axes: Optional[List[axes]] = None, export: str = "") +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| indices | list | A list of indices you wish to load (and plot).
Available indices can be accessed through economy.available_indices(). | None | False | +| interval | str | Valid intervals: 1m,2m,5m,15m,30m,60m,90m,1h,1d,5d,1wk,1mo,3mo
Intraday data cannot extend last 60 days | 1d | True | +| start_date | str | The starting date, format "YEAR-MONTH-DAY", i.e. 2010-12-31. | None | True | +| end_date | str | The end date, format "YEAR-MONTH-DAY", i.e. 2020-06-05. | None | True | +| column | str | Which column to load in, by default this is the Adjusted Close. | Adj Close | True | +| returns | bool | Flag to show cumulative returns on index | False | True | +| raw | bool | Whether to display the raw output. | False | True | +| external_axes | Optional[List[plt.axes]] | External axes to plot on | None | True | +| export | str | Export data to csv,json,xlsx or png,jpg,pdf,svg file | | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| Plots the Series. | | +--- + + + diff --git a/website/content/sdk/reference/economy/indices.md b/website/content/sdk/reference/economy/indices.md new file mode 100644 index 000000000000..4e783e5a9bc3 --- /dev/null +++ b/website/content/sdk/reference/economy/indices.md @@ -0,0 +1,42 @@ +--- +title: indices +description: This documentation page provides detailed information about how to use + the openbb.economy.indices() function to get the top US indices. The function returns + a DataFrame containing the name, price, net change, and percent change. +keywords: +- openbb.economy.indices() +- US indices +- Documentation +- Name +- Price +- Net change +- Percent change +- Source code +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Get the top US indices + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/economy/wsj_model.py#L16)] + +```python +openbb.economy.indices() +``` + +--- + +## Parameters + +This function does not take any parameters. + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | Dataframe containing name, price, net change and percent change | +--- diff --git a/website/content/sdk/reference/economy/inf.md b/website/content/sdk/reference/economy/inf.md new file mode 100644 index 000000000000..b2e6ffec5215 --- /dev/null +++ b/website/content/sdk/reference/economy/inf.md @@ -0,0 +1,81 @@ +--- +title: inf +description: 'This page discusses two main functions of the OpenBBTerminal: one for + gathering US inflation data and the other for displaying this data in a chart. The + model function retrieves historical inflation data from AlphaVantage and returns + a DataFrame, while the chart function presents this data using a customizable interface.' +keywords: +- Inflation Data +- AlphaVantage +- Data Visualization +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + +Get historical Inflation for United States from AlphaVantage + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/economy/alphavantage_model.py#L139)] + +```python +openbb.economy.inf(start_year: int = 2010) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| start_year | int | Start year for plot, by default 2010 | 2010 | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | DataFrame of inflation rates | +--- + + + + +Display US Inflation from AlphaVantage + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/economy/alphavantage_view.py#L202)] + +```python +openbb.economy.inf_chart(start_year: int = 2010, raw: bool = False, export: str = "", external_axes: Optional[List[matplotlib.axes._axes.Axes]] = None) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| start_year | int | Start year for plot, by default 2010 | 2010 | True | +| raw | bool | Flag to show raw data, by default False | False | True | +| export | str | Format to export data, by default "" | | True | +| external_axes | Optional[List[plt.Axes]] | External axes (1 axis is expected in the list), by default None | None | True | + + +--- + +## Returns + +This function does not return anything + +--- + + + diff --git a/website/content/sdk/reference/economy/macro.md b/website/content/sdk/reference/economy/macro.md new file mode 100644 index 000000000000..8e2112810019 --- /dev/null +++ b/website/content/sdk/reference/economy/macro.md @@ -0,0 +1,117 @@ +--- +title: macro +description: This Docusaurus page offers detailed resources related to the 'macro' + function within the OpenBBTerminal Python package. It presents function parameters, + provides source code links, and offers examples of two functions that handle querying + macroeconomic data from the EconDB database and visualizing the received macro data. +keywords: +- docusaurus page +- metadata +- macro function +- EconDB database +- parameters +- countries +- transform +- start_date +- end_date +- symbol +- macro data +- macro chart +- raw +- econdb_model.py +- econdb_view.py +- economy +- macro parameters +- macro countries +- economical data visualization +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + +This functions groups the data queried from the EconDB database [Source: EconDB] + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/economy/econdb_model.py#L655)] + +```python +openbb.economy.macro(parameters: list = None, countries: list = None, transform: str = "", start_date: str = "1900-01-01", end_date: Optional[str] = None, symbol: str = "") +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| parameters | list | The type of data you wish to download. Available parameters can be accessed through economy.macro_parameters(). | None | True | +| countries | list | The selected country or countries. Available countries can be accessed through economy.macro_countries(). | None | True | +| transform | str | The selected transform. Available transforms can be accessed through get_macro_transform(). | | True | +| start_date | str | The starting date, format "YEAR-MONTH-DAY", i.e. 2010-12-31. | 1900-01-01 | True | +| end_date | Optional[str] | The end date, format "YEAR-MONTH-DAY", i.e. 2020-06-05. | None | True | +| symbol | str | In what currency you wish to convert all values. | | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| Tuple[pd.DataFrame, Dict[Any, Dict[Any, Any]], str] | A DataFrame with the requested macro data of all chosen countries,
A dictionary containing the units of each country's parameter (e.g. EUR),
A string denomination which can be Trillions, Billions, Millions, Thousands | +--- + +## Examples + +```python +from openbb_terminal.sdk import openbb +macro_df = openbb.economy.macro() +``` + +--- + + + + +Show the received macro data about a company [Source: EconDB] + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/economy/econdb_view.py#L25)] + +```python +openbb.economy.macro_chart(parameters: list = None, countries: list = None, transform: str = "", start_date: str = "1900-01-01", end_date: Optional[str] = None, symbol: str = "", raw: bool = False, external_axes: Optional[List[axes]] = None, export: str = "") +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| parameters | list | The type of data you wish to display. Available parameters can be accessed through get_macro_parameters(). | None | True | +| countries | list | The selected country or countries. Available countries can be accessed through get_macro_countries(). | None | True | +| transform | str | select data transformation from:
'' - no transformation
'TPOP' - total percentage change on period,
'TOYA' - total percentage since 1 year ago,
'TUSD' - level USD,
'TPGP' - Percentage of GDP,
'TNOR' - Start = 100 | | True | +| start_date | str | The starting date, format "YEAR-MONTH-DAY", i.e. 2010-12-31. | 1900-01-01 | True | +| end_date | Optional[str] | The end date, format "YEAR-MONTH-DAY", i.e. 2020-06-05. | None | True | +| symbol | str | In what currency you wish to convert all values. | | True | +| raw | bool | Whether to display the raw output. | False | True | +| external_axes | Optional[List[plt.axes]] | External axes to plot on | None | True | +| export | str | Export data to csv,json,xlsx or png,jpg,pdf,svg file | | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| Plots the Series. | | +--- + + + diff --git a/website/content/sdk/reference/economy/macro_countries.md b/website/content/sdk/reference/economy/macro_countries.md new file mode 100644 index 000000000000..ee75075c4f26 --- /dev/null +++ b/website/content/sdk/reference/economy/macro_countries.md @@ -0,0 +1,40 @@ +--- +title: macro_countries +description: Get a digest of the macro_countries function in OpenBB's economy module + that provides a dictionary of available countries with their respective currencies. + Includes details on function parameters and returns. +keywords: +- economy module +- macro_countries function +- country currency +- dictionary +- function parameters +- function returns +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This function returns the available countries and respective currencies. + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/economy/econdb_model.py#L643)] + +```python +openbb.economy.macro_countries() +``` + +--- + +## Parameters + +This function does not take any parameters. + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| Dict[str, str] | A dictionary with the available countries and respective currencies. | +--- diff --git a/website/content/sdk/reference/economy/macro_parameters.md b/website/content/sdk/reference/economy/macro_parameters.md new file mode 100644 index 000000000000..dd60cd53ea99 --- /dev/null +++ b/website/content/sdk/reference/economy/macro_parameters.md @@ -0,0 +1,37 @@ +--- +title: macro_parameters +description: The macro_parameters function in openbb economy section. It does not + take any parameters and returns a dictionary with the available macro parameters. + Find the source code here. +keywords: +- macro parameters +- economy +- dictionary +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This function returns the available macro parameters with detail. + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/economy/econdb_model.py#L631)] + +```python +openbb.economy.macro_parameters() +``` + +--- + +## Parameters + +This function does not take any parameters. + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| Dict[str, Dict[str, str]] | A dictionary with the available macro parameters. | +--- diff --git a/website/content/sdk/reference/economy/overview.md b/website/content/sdk/reference/economy/overview.md new file mode 100644 index 000000000000..cf797d768478 --- /dev/null +++ b/website/content/sdk/reference/economy/overview.md @@ -0,0 +1,49 @@ +--- +title: overview +description: This page provides documentation for the OpenBBTerminal's economy overview + feature. The function scrapes market data, returning a DataFrame with the name, + price, net change, and percentage change. No parameters needed. +keywords: +- data scraping +- economy overview +- market data +- pandas DataFrame +- net change +- percent change +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Scrape data for market overview + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/economy/wsj_model.py#L62)] + +```python +openbb.economy.overview() +``` + +--- + +## Parameters + +This function does not take any parameters. + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | Dataframe containing name, price, net change and percent change | +--- + +## Examples + +```python +from openbb_terminal.sdk import openbb +ov_df = openbb.economy.overview() +``` + +--- diff --git a/website/content/sdk/reference/economy/perfmap.md b/website/content/sdk/reference/economy/perfmap.md new file mode 100644 index 000000000000..9c660fd6be19 --- /dev/null +++ b/website/content/sdk/reference/economy/perfmap.md @@ -0,0 +1,45 @@ +--- +title: perfmap +description: This is the documentation page of perfmap, a tool that opens Finviz performance + map in the browser. It supports various performance periods and map filters. +keywords: +- Finviz +- performance map +- economy model +- SP500 +- ETF +- world map +- perfmap +- period +- map filter +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Opens Finviz map website in a browser. [Source: Finviz] + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/economy/finviz_model.py#L42)] + +```python +openbb.economy.perfmap(period: str = "1d", map_filter: str = "sp500") +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| period | str | Performance period. Available periods are 1d, 1w, 1m, 3m, 6m, 1y. | 1d | True | +| scope | str | Map filter. Available map filters are sp500, world, full, etf. | None | True | + + +--- + +## Returns + +This function does not return anything + +--- diff --git a/website/content/sdk/reference/economy/performance.md b/website/content/sdk/reference/economy/performance.md new file mode 100644 index 000000000000..5bd8a2e6a196 --- /dev/null +++ b/website/content/sdk/reference/economy/performance.md @@ -0,0 +1,45 @@ +--- +title: performance +description: This page provides detailed information on retrieving group performance + data using OpenBB's economy module. It provides explanations on parameters and return + types along with a link to the source code. +keywords: +- OpenBB economy module +- group performance data +- Finviz +- Performance data retrieval +- Source code +- Programming +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Get group (sectors, industry or country) performance data. [Source: Finviz] + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/economy/finviz_model.py#L112)] + +```python +openbb.economy.performance(group: str = "sector", sortby: str = "Name", ascend: bool = True) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| group | str | Group by category. Available groups can be accessed through get_groups(). | sector | True | +| sortby | str | Column to sort by | Name | True | +| ascend | bool | Flag to sort in ascending order | True | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | dataframe with performance data | +--- diff --git a/website/content/sdk/reference/economy/search_index.md b/website/content/sdk/reference/economy/search_index.md new file mode 100644 index 000000000000..a3fd22352125 --- /dev/null +++ b/website/content/sdk/reference/economy/search_index.md @@ -0,0 +1,45 @@ +--- +title: search_index +description: This Docusaurus page provides information about how to use the 'search_index' + function from the OpenBB finance package. It explains the parameters and returns + of this function, which helps to search indices by keyword in the finance database. + Source code is also provided. +keywords: +- search_index +- OpenBB finance package +- finance database +- keyword search +- parameters +- returns +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Search indices by keyword. [Source: FinanceDatabase] + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/economy/yfinance_model.py#L725)] + +```python +openbb.economy.search_index(keyword: list, limit: int = 10) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| keyword | list | The keyword you wish to search for. This can include spaces. | None | False | +| limit | int | The amount of views you want to show, by default this is set to 10. | 10 | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.Dataframe | Dataframe with the available options. | +--- diff --git a/website/content/sdk/reference/economy/spectrum.md b/website/content/sdk/reference/economy/spectrum.md new file mode 100644 index 000000000000..52bf0b10a85c --- /dev/null +++ b/website/content/sdk/reference/economy/spectrum.md @@ -0,0 +1,44 @@ +--- +title: spectrum +description: Learn how to use the OpenBB economy spectrum function to display the + finviz spectrum in your system viewer. Understand parameters like group and export, + and learn how to customize them for your needs. +keywords: +- spectrum +- finviz +- openbb.economy.spectrum +- group +- export +- get_groups() +- sector +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Display finviz spectrum in system viewer [Source: Finviz] + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/economy/finviz_view.py#L111)] + +```python +openbb.economy.spectrum(group: str = "sector", export: str = "") +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| group | str | Group by category. Available groups can be accessed through get_groups(). | sector | True | +| export | str | Format to export data | | True | + + +--- + +## Returns + +This function does not return anything + +--- diff --git a/website/content/sdk/reference/economy/treasury.md b/website/content/sdk/reference/economy/treasury.md new file mode 100644 index 000000000000..ff4000430b58 --- /dev/null +++ b/website/content/sdk/reference/economy/treasury.md @@ -0,0 +1,105 @@ +--- +title: treasury +description: The page provides comprehensive documentation and source code for fetching + and visualizing U.S. treasury rates data with different options for type of treasuries, + maturities, and data frequencies. +keywords: +- U.S. treasury rates +- EconDB +- data frequency +- treasury maturities +- economy.treasury +- economy.treasury_chart +- Data Visualization +- Source Code +- Parameters +- Returns +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + +Get U.S. Treasury rates [Source: EconDB] + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/economy/econdb_model.py#L736)] + +```python +openbb.economy.treasury(instruments: list = None, maturities: list = None, frequency: str = "monthly", start_date: str = "1900-01-01", end_date: Optional[str] = None) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| instruments | list | Type(s) of treasuries, nominal, inflation-adjusted (long term average) or secondary market.
Available options can be accessed through economy.treasury_maturities(). | None | True | +| maturities | list | Treasury maturities to get. Available options can be accessed through economy.treasury_maturities(). | None | True | +| frequency | str | Frequency of the data, this can be annually, monthly, weekly or daily. | monthly | True | +| start_date | str | Starting date, format "YEAR-MONTH-DAY", i.e. 2010-12-31. | 1900-01-01 | True | +| end_date | Optional[str] | End date, format "YEAR-MONTH-DAY", i.e. 2020-06-05. | None | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.Dataframe | Holds data of the selected types and maturities | +--- + +## Examples + +```python +from openbb_terminal.sdk import openbb +openbb.economy.treasury() +``` + +--- + + + + +Display U.S. Treasury rates [Source: EconDB] + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/economy/econdb_view.py#L145)] + +```python +openbb.economy.treasury_chart(instruments: list = None, maturities: list = None, frequency: str = "monthly", start_date: str = "1900-01-01", end_date: Optional[str] = None, raw: bool = False, external_axes: Optional[List[axes]] = None, export: str = "") +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| instruments | list | Type(s) of treasuries, nominal, inflation-adjusted or secondary market.
Available options can be accessed through economy.treasury_maturities(). | None | True | +| maturities | list | Treasury maturities to display. Available options can be accessed through economy.treasury_maturities(). | None | True | +| frequency | str | Frequency of the data, this can be daily, weekly, monthly or annually | monthly | True | +| start_date | str | Starting date, format "YEAR-MONTH-DAY", i.e. 2010-12-31. | 1900-01-01 | True | +| end_date | Optional[str] | End date, format "YEAR-MONTH-DAY", i.e. 2020-06-05. | None | True | +| raw | bool | Whether to display the raw output. | False | True | +| external_axes | Optional[List[plt.axes]] | External axes to plot on | None | True | +| export | str | Export data to csv,json,xlsx or png,jpg,pdf,svg file | | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| Plots the Treasury Series. | | +--- + + + diff --git a/website/content/sdk/reference/economy/treasury_maturities.md b/website/content/sdk/reference/economy/treasury_maturities.md new file mode 100644 index 000000000000..36450fef68cd --- /dev/null +++ b/website/content/sdk/reference/economy/treasury_maturities.md @@ -0,0 +1,44 @@ +--- +title: treasury_maturities +description: This page covers the documentation of OpenBB finance's treasury_maturities + function, providing details on the source code and its returns. This function returns + a DataFrame containing the name of the financial instruments and a string containing + all options. +keywords: +- OpenBB finance +- Documentation +- Treasury Maturities +- EconDB +- Source Code +- Python Code +- Economy +- Financial Instruments +- Data Frame +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Get treasury maturity options [Source: EconDB] + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/economy/econdb_model.py#L849)] + +```python +openbb.economy.treasury_maturities() +``` + +--- + +## Parameters + +This function does not take any parameters. + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | Contains the name of the instruments and a string containing all options. | +--- diff --git a/website/versioned_docs/version-v3/sdk/reference/economy/tyld.md b/website/content/sdk/reference/economy/tyld.md similarity index 77% rename from website/versioned_docs/version-v3/sdk/reference/economy/tyld.md rename to website/content/sdk/reference/economy/tyld.md index 75f8633defa3..53a1b62af345 100644 --- a/website/versioned_docs/version-v3/sdk/reference/economy/tyld.md +++ b/website/content/sdk/reference/economy/tyld.md @@ -1,13 +1,26 @@ --- title: tyld -description: OpenBB SDK Function +description: This page provides documentation for retrieving and displaying historical + yield data using the 'tyld' and 'tyld_chart' functions in the OpenBB finance module. + This data can be filtered based on various parameters including the interval, maturity + and start date. For more in-depth details and access to the source code, please + refer to the respective sections. +keywords: +- OpenBB finance module +- historical yield +- tyld function +- tyld_chart function +- data retrieval +- data display --- +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; -# tyld - @@ -39,8 +52,6 @@ openbb.economy.tyld(interval: str = "m", maturity: str = "10y", start_date: str | pd.DataFrame | Dataframe of historical yields | --- - - @@ -74,7 +85,5 @@ This function does not return anything --- - - - \ No newline at end of file + diff --git a/website/versioned_docs/version-v3/sdk/reference/economy/unemp.md b/website/content/sdk/reference/economy/unemp.md similarity index 76% rename from website/versioned_docs/version-v3/sdk/reference/economy/unemp.md rename to website/content/sdk/reference/economy/unemp.md index 9ec684b865db..30a1877c9396 100644 --- a/website/versioned_docs/version-v3/sdk/reference/economy/unemp.md +++ b/website/content/sdk/reference/economy/unemp.md @@ -1,13 +1,24 @@ --- title: unemp -description: OpenBB SDK Function +description: This page provides full documentation on using unemp functions in OpenBB + to get US unemployment historical data and visualize it using charts. Includes information + on function parameters and return types. +keywords: +- OpenBB documentation +- unemp function +- US unemployment data +- historical unemployment data +- AlphaVantage +- data visualization --- +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; -# unemp - @@ -37,8 +48,6 @@ openbb.economy.unemp(start_year: int = 2010) | pd.DataFrame | Dataframe of historical yields | --- - - @@ -70,7 +79,5 @@ This function does not return anything --- - - - \ No newline at end of file + diff --git a/website/content/sdk/reference/economy/usbonds.md b/website/content/sdk/reference/economy/usbonds.md new file mode 100644 index 000000000000..0bb1519a20cc --- /dev/null +++ b/website/content/sdk/reference/economy/usbonds.md @@ -0,0 +1,46 @@ +--- +title: usbonds +description: This page provides a comprehensive guide on how to use OpenBB-finance's + us bonds data scraping function from OpenBBTerminal's wsj_model python script. The + function returns a dataframe containing bond's name, its coupon rate, yield and + change in yield. +keywords: +- us bonds +- data scraping +- OpenBB-finance +- economy +- wsj_model +- parameters +- dataframe +- name +- coupon rate +- yield +- change in yield +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Scrape data for us bonds + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/economy/wsj_model.py#L161)] + +```python +openbb.economy.usbonds() +``` + +--- + +## Parameters + +This function does not take any parameters. + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | Dataframe containing name, coupon rate, yield and change in yield | +--- diff --git a/website/content/sdk/reference/economy/valuation.md b/website/content/sdk/reference/economy/valuation.md new file mode 100644 index 000000000000..e5b62b51b124 --- /dev/null +++ b/website/content/sdk/reference/economy/valuation.md @@ -0,0 +1,47 @@ +--- +title: valuation +description: This is a documentation page about the openbb.economy.valuation function + from OpenBB that uses Finviz data to get group valuation data. It allows for sorting + by column and in ascending order, returning these results in a dataframe. +keywords: +- group valuation data +- finance sector +- performance data +- sort by column +- ascending order +- Finviz +- GitHub +- dataframe +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Get group (sectors, industry or country) valuation data. [Source: Finviz] + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/economy/finviz_model.py#L66)] + +```python +openbb.economy.valuation(group: str = "sector", sortby: str = "Name", ascend: bool = True) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| group | str | Group by category. Available groups can be accessed through get_groups(). | sector | True | +| sortby | str | Column to sort by | Name | True | +| ascend | bool | Flag to sort in ascending order | True | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | dataframe with valuation/performance data | +--- diff --git a/website/content/sdk/reference/economy/ycrv.md b/website/content/sdk/reference/economy/ycrv.md new file mode 100644 index 000000000000..421bdfa1a322 --- /dev/null +++ b/website/content/sdk/reference/economy/ycrv.md @@ -0,0 +1,91 @@ +--- +title: ycrv +description: This documentation page guides users on how to use the 'ycrv' function + in OpenBB software to retrieve and display yield curve data. +keywords: +- ycrv +- yield curve +- Treasury rates +- data retrieval +- data display +- frontend development +- FRED source code +- economic data visualization +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + +Gets yield curve data from FRED + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/economy/fred_model.py#L257)] + +```python +openbb.economy.ycrv(date: datetime.datetime = None) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| date | datetime | Date to get curve for. If None, gets most recent date | None | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| Tuple[pd.DataFrame, datetime] | Dataframe of yields and maturities,
Date for which the yield curve is obtained | +--- + +## Examples + +```python +from openbb_terminal.sdk import openbb +ycrv_df = openbb.economy.ycrv() +``` + +--- + + + + +Display yield curve based on US Treasury rates for a specified date. + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/economy/fred_view.py#L187)] + +```python +openbb.economy.ycrv_chart(date: datetime.datetime = None, external_axes: Optional[List[matplotlib.axes._axes.Axes]] = None, raw: bool = False, export: str = "") +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| date | datetime | Date to get yield curve for | None | True | +| external_axes | Optional[List[plt.Axes]] | External axes to plot data on | None | True | + + +--- + +## Returns + +This function does not return anything + +--- + + + diff --git a/website/content/sdk/reference/etf/candle.md b/website/content/sdk/reference/etf/candle.md new file mode 100644 index 000000000000..90be712ec89c --- /dev/null +++ b/website/content/sdk/reference/etf/candle.md @@ -0,0 +1,66 @@ +--- +title: candle +description: This page provides a comprehensive guide on how to use the 'candle' function + in OpenBB Terminal. This function, primarily meant for stock evaluations, provides + a detailed candle plot of any given ticker. Features include adjustable parameters + for added customizability. +keywords: +- stock evaluation +- candle function +- candle plot +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Show candle plot of loaded ticker. + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/stocks/stocks_helper.py#L443)] + +```python +openbb.etf.candle(symbol: str, data: pd.DataFrame = None, use_matplotlib: bool = True, intraday: bool = False, add_trend: bool = False, ma: Optional[Iterable[int]] = None, asset_type: str = "", start_date: Union[datetime.datetime, str, NoneType] = None, interval: int = 1440, end_date: Union[datetime.datetime, str, NoneType] = None, prepost: bool = False, source: str = "YahooFinance", weekly: bool = False, monthly: bool = False, external_axes: Optional[List[matplotlib.axes._axes.Axes]] = None, raw: bool = False, yscale: str = "linear") +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| symbol | str | Ticker name | None | False | +| data | pd.DataFrame | Stock dataframe | None | True | +| use_matplotlib | bool | Flag to use matplotlib instead of interactive plotly chart | True | True | +| intraday | bool | Flag for intraday data for plotly range breaks | False | True | +| add_trend | bool | Flag to add high and low trends to chart | False | True | +| ma | Tuple[int] | Moving averages to add to the candle | None | True | +| asset_type_ | str | String to include in title | None | True | +| external_axes | Optional[List[plt.Axes]] | External axes (2 axes are expected in the list), by default None | None | True | +| asset_type_ | str | String to include in title | None | True | +| start_date | str or datetime | Start date to get data from with. - datetime or string format (YYYY-MM-DD) | None | True | +| interval | int | Interval (in minutes) to get data 1, 5, 15, 30, 60 or 1440 | 1440 | True | +| end_date | str or datetime | End date to get data from with. - datetime or string format (YYYY-MM-DD) | None | True | +| prepost | bool | Pre and After hours data | False | True | +| source | str | Source of data extracted | YahooFinance | True | +| weekly | bool | Flag to get weekly data | False | True | +| monthly | bool | Flag to get monthly data | False | True | +| raw | bool | Flag to display raw data, by default False | False | True | +| yscale | str | Linear or log for yscale | linear | True | + + +--- + +## Returns + +This function does not return anything + +--- + +## Examples + +```python +from openbb_terminal.sdk import openbb +openbb.stocks.candle("AAPL") +``` + +--- diff --git a/website/content/sdk/reference/etf/disc/mover.md b/website/content/sdk/reference/etf/disc/mover.md new file mode 100644 index 000000000000..26d419be2cc5 --- /dev/null +++ b/website/content/sdk/reference/etf/disc/mover.md @@ -0,0 +1,46 @@ +--- +title: mover +description: This page provides details and source code documentation for a function + titled 'mover', used in scraping data for top etf movers. There's also a description + of its parameters and returned values. +keywords: +- mover function +- scrape top etf movers +- source code documentation +- gainers +- decliners +- active +- etf volume +- etf price +- etf change +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Scrape data for top etf movers. + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/etf/discovery/wsj_model.py#L15)] + +```python +openbb.etf.disc.mover(sort_type: str = "gainers", export: bool = False) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| sort_type | str | Data to get. Can be "gainers", "decliners" or "active" | gainers | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | Datafame containing the name, price, change and the volume of the etf | +--- diff --git a/website/content/sdk/reference/etf/etf_by_category.md b/website/content/sdk/reference/etf/etf_by_category.md new file mode 100644 index 000000000000..6b3fcbff7e0c --- /dev/null +++ b/website/content/sdk/reference/etf/etf_by_category.md @@ -0,0 +1,44 @@ +--- +title: etf_by_category +description: This page provides information on how to retrieve a selection of ETFs + based on category filtered by total assets, using the OpenBB finance platform. +keywords: +- OpenBB finance +- ETFs +- category filter +- total assets +- ETF selection +- financial data +- finance database model +- etf_by_category function +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Return a selection of ETFs based on category filtered by total assets. + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/etf/financedatabase_model.py#L56)] + +```python +openbb.etf.etf_by_category(category: str) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| category | str | Search by category to find ETFs matching the criteria. | None | False | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| Dict[str, Any] | Dictionary with ETFs that match a certain description | +--- diff --git a/website/content/sdk/reference/etf/etf_by_name.md b/website/content/sdk/reference/etf/etf_by_name.md new file mode 100644 index 000000000000..1cacdfcae896 --- /dev/null +++ b/website/content/sdk/reference/etf/etf_by_name.md @@ -0,0 +1,43 @@ +--- +title: etf_by_name +description: A detailed documentation page that explains how to get ETF symbol and + name based on a string to search. The page includes a link to the source code and + illustrates how the function 'etf_by_name' used in the StockAnalysis can be implemented + to fetch ETF names and their corresponding symbols. This function returns a data + frame with symbols and names. +keywords: +- ETF +- Symbol +- Name Search +- StockAnalysis +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Get an ETF symbol and name based on ETF string to search. [Source: StockAnalysis] + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/etf/stockanalysis_model.py#L132)] + +```python +openbb.etf.etf_by_name(name_to_search: str) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| name_to_search | str | ETF name to match | None | False | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.Dataframe | Dataframe with symbols and names | +--- diff --git a/website/content/sdk/reference/etf/holdings.md b/website/content/sdk/reference/etf/holdings.md new file mode 100644 index 000000000000..51971e5aa189 --- /dev/null +++ b/website/content/sdk/reference/etf/holdings.md @@ -0,0 +1,43 @@ +--- +title: holdings +description: The page provides functions to fetch ETF holdings with Python using a + specific symbol. It includes source code, parameter information, and return values + represented in a dataframe. +keywords: +- ETF holdings +- Source Code +- Parameters +- Returns +- Symbol +- Dataframe of holdings +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Get ETF holdings + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/etf/stockanalysis_model.py#L82)] + +```python +openbb.etf.holdings(symbol: str) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| symbol | str | Symbol to get holdings for | None | False | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | Dataframe of holdings | +--- diff --git a/website/content/sdk/reference/etf/ld.md b/website/content/sdk/reference/etf/ld.md new file mode 100644 index 000000000000..bcb4ef8cb631 --- /dev/null +++ b/website/content/sdk/reference/etf/ld.md @@ -0,0 +1,43 @@ +--- +title: ld +description: This page of the OpenBB Terminal documentation provides details on how + to return a selection of ETFs based on description filtered by total assets using + the 'ld' function. It includes source code links, input parameters, and their returns. +keywords: +- ETF selection +- description filter +- total assets filter +- '''ld'' function' +- parameter description +- ETF return +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Return a selection of ETFs based on description filtered by total assets. + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/etf/financedatabase_model.py#L35)] + +```python +openbb.etf.ld(description: str) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| description | str | Search by description to find ETFs matching the criteria. | None | False | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| Dict[str, Any] | Dictionary with ETFs that match a certain description | +--- diff --git a/website/content/sdk/reference/etf/ln.md b/website/content/sdk/reference/etf/ln.md new file mode 100644 index 000000000000..ac1f1c41aff6 --- /dev/null +++ b/website/content/sdk/reference/etf/ln.md @@ -0,0 +1,41 @@ +--- +title: ln +description: An OpenBBTerminal documentation page describing how to use the openbb.etf.ln + Python function, which filters and retrieves ETFs from the Finance Database based + on names. +keywords: +- ETF +- Finance Database +- name filter +- Information Retrieval +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Return a selection of ETFs based on name filtered by total assets. [Source: Finance Database] + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/etf/financedatabase_model.py#L15)] + +```python +openbb.etf.ln(name: str) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| name | str | Search by name to find ETFs matching the criteria. | None | False | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| Dict[str, Any] | Dictionary with ETFs that match a certain name | +--- diff --git a/website/content/sdk/reference/etf/load.md b/website/content/sdk/reference/etf/load.md new file mode 100644 index 000000000000..793d5ea2af3f --- /dev/null +++ b/website/content/sdk/reference/etf/load.md @@ -0,0 +1,51 @@ +--- +title: load +description: This page presents the 'load' function, used to perform analysis on a + symbol. The function details with parameters and returns are described in a comprehensive + manner. +keywords: +- load function +- symbol analysis +- YahooFinance data extraction +- weekly and monthly data +- verbose information +- data analysis +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Load a symbol to perform analysis using the string above as a template. + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/stocks/stocks_helper.py#L223)] + +```python +openbb.etf.load(symbol: str, start_date: Union[datetime.datetime, str, NoneType] = None, interval: int = 1440, end_date: Union[datetime.datetime, str, NoneType] = None, prepost: bool = False, source: str = "YahooFinance", weekly: bool = False, monthly: bool = False, verbose: bool = True) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| symbol | str | Ticker to get data | None | False | +| start_date | str or datetime | Start date to get data from with. - datetime or string format (YYYY-MM-DD) | None | True | +| interval | int | Interval (in minutes) to get data 1, 5, 15, 30, 60 or 1440 | 1440 | True | +| end_date | str or datetime | End date to get data from with. - datetime or string format (YYYY-MM-DD) | None | True | +| prepost | bool | Pre and After hours data | False | True | +| source | str | Source of data extracted | YahooFinance | True | +| weekly | bool | Flag to get weekly data | False | True | +| monthly | bool | Flag to get monthly data | False | True | +| verbose | bool | Display verbose information on what was the symbol that was loaded | True | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | Dataframe of data | +--- diff --git a/website/content/sdk/reference/etf/news.md b/website/content/sdk/reference/etf/news.md new file mode 100644 index 000000000000..befe4907173d --- /dev/null +++ b/website/content/sdk/reference/etf/news.md @@ -0,0 +1,88 @@ +--- +title: news +description: The page provides documentation on how to get and display news for a + given term using OpenBB's Python functions. It also describes parameters used in + these functions and links to the related source codes. +keywords: +- Documentation +- Python functions +- News retrieval +- NewsAPI +- Source code +- Parameters +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + +Get news for a given term. [Source: NewsAPI] + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/common/newsapi_model.py#L18)] + +```python +openbb.etf.news(query: str, limit: int = 10, start_date: Optional[str] = None, show_newest: bool = True, sources: str = "") +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| query | str | term to search on the news articles | None | False | +| start_date | Optional[str] | date to start searching articles from formatted YYYY-MM-DD | None | True | +| show_newest | bool | flag to show newest articles first | True | True | +| sources | str | sources to exclusively show news from (comma separated) | | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| List[Tuple[pd.DataFrame, dict]] | List of tuples containing news df in first index,
dict containing title of news df. | +--- + + + + +Prints table showing news for a given term. [Source: NewsAPI] + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/common/newsapi_view.py#L20)] + +```python +openbb.etf.news_chart(query: str, limit: int = 3, start_date: Optional[str] = None, show_newest: bool = True, sources: str = "", export: str = "") +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| query | str | term to search on the news articles | None | False | +| start_date | Optional[str] | date to start searching articles from formatted YYYY-MM-DD | None | True | +| limit | int | number of articles to display | 3 | True | +| show_newest | bool | flag to show newest articles first | True | True | +| sources | str | sources to exclusively show news from | | True | +| export | str | Export dataframe data to csv,json,xlsx file | | True | + + +--- + +## Returns + +This function does not return anything + +--- + + + diff --git a/website/content/sdk/reference/etf/overview.md b/website/content/sdk/reference/etf/overview.md new file mode 100644 index 000000000000..31a0247c1ac5 --- /dev/null +++ b/website/content/sdk/reference/etf/overview.md @@ -0,0 +1,40 @@ +--- +title: overview +description: This page provides an overview of how to get ETF data using OpenBB's + Python library. It includes detailed explanations on parameters and returns, and + even a link to the source code. +keywords: +- ETF +- overview data +- stock overview data +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Get overview data for selected etf + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/etf/stockanalysis_model.py#L48)] + +```python +openbb.etf.overview(symbol: str) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| etf_symbol | str | Etf symbol to get overview for | None | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | Dataframe of stock overview data | +--- diff --git a/website/content/sdk/reference/etf/scr/screen.md b/website/content/sdk/reference/etf/scr/screen.md new file mode 100644 index 000000000000..9e23e93a93b3 --- /dev/null +++ b/website/content/sdk/reference/etf/scr/screen.md @@ -0,0 +1,87 @@ +--- +title: screen +description: 'This page of the documentation is dedicated to the OpenBB''s etf screener; + it provides an overview of the functionality, parameters, and return types for two + core methods: the ETF ''screen'' and ''screen_chart'' functions. The website guides + the users through the use of these functions as well as their source code, helping + them better understand and utilize the ETF screener.' +keywords: +- ETF screening +- Source code +- ETF scraping +- Data sorting +- Data visualization +- Financial data analysis +- Data export +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + +Screens the etfs pulled from my repo (https://github.com/jmaslek/etf_scraper), + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/etf/screener/screener_model.py#L43)] + +```python +openbb.etf.scr.screen(preset: str) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| preset | str | Screener to use from presets | None | False | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | Screened dataframe | +--- + + + + +Display screener output + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/etf/screener/screener_view.py#L18)] + +```python +openbb.etf.scr.screen_chart(preset: str, num_to_show: int, sortby: str, ascend: bool, export: str = "") +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| preset | str | Preset to use | None | False | +| num_to_show | int | Number of etfs to show | None | False | +| sortby | str | Column to sort by | None | False | +| ascend | bool | Ascend when sorted | None | False | +| export | str | Output format of export | | True | + + +--- + +## Returns + +This function does not return anything + +--- + + + diff --git a/website/content/sdk/reference/etf/summary.md b/website/content/sdk/reference/etf/summary.md new file mode 100644 index 000000000000..9ba56fa8b6ca --- /dev/null +++ b/website/content/sdk/reference/etf/summary.md @@ -0,0 +1,43 @@ +--- +title: summary +description: An in-depth overview of ETF summaries using the OpenBB ETF module. This + tool fetches ETF data from Yahoo Finance, providing a comprehensive summary based + on specified ETF name. +keywords: +- ETF +- OpenBB ETF module +- Yahoo Finance +- ETF Summary +- ETF data +- ETF name +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Return summary description of ETF. [Source: Yahoo Finance] + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/etf/yfinance_model.py#L44)] + +```python +openbb.etf.summary(name: str) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| name | str | ETF name | None | False | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| str | Summary description of the ETF | +--- diff --git a/website/content/sdk/reference/etf/symbols.md b/website/content/sdk/reference/etf/symbols.md new file mode 100644 index 000000000000..a5449ffcc92b --- /dev/null +++ b/website/content/sdk/reference/etf/symbols.md @@ -0,0 +1,38 @@ +--- +title: symbols +description: This documentation page provides a detailed guide on how to get all ETF + names and symbols using the openbb.etf.symbols() function. It also includes a link + to the source code. +keywords: +- ETF +- symbols +- names +- openbb.etf.symbols() +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Gets all etf names and symbols + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/etf/stockanalysis_model.py#L19)] + +```python +openbb.etf.symbols() +``` + +--- + +## Parameters + +This function does not take any parameters. + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| Tuple[List[str], List[str]] | List of all available etf symbols, List of all available etf names | +--- diff --git a/website/content/sdk/reference/etf/weights.md b/website/content/sdk/reference/etf/weights.md new file mode 100644 index 000000000000..eb1c5b17a990 --- /dev/null +++ b/website/content/sdk/reference/etf/weights.md @@ -0,0 +1,40 @@ +--- +title: weights +description: This page provides the function to return the sector weightings allocation + of any ETF using the OpenBB's yfinance model. It includes a link to the source code + on GitHub. +keywords: +- ETF +- sector weightings allocation +- yfinance model +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Return sector weightings allocation of ETF. [Source: Yahoo Finance] + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/etf/yfinance_model.py#L15)] + +```python +openbb.etf.weights(name: str) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| name | str | ETF name | None | False | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| Dict[str, Any] | Dictionary with sector weightings allocation | +--- diff --git a/website/content/sdk/reference/forecast/atr.md b/website/content/sdk/reference/forecast/atr.md new file mode 100644 index 000000000000..f8c9f2a974e2 --- /dev/null +++ b/website/content/sdk/reference/forecast/atr.md @@ -0,0 +1,35 @@ +--- +title: atr +description: The page provides details on how to calculate the Average True Range + using a specific stock ticker with the help of the Python package, OpenBB. +keywords: +- Average True Range +- stock ticker +- forecast +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Calculate the Average True Range of a variable based on a a specific stock ticker. + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/forecast/forecast_model.py#L349)] + +```python +openbb.forecast.atr(dataset: pd.DataFrame, close_column: str = "close", high_column: str = "high", low_column: str = "low") +``` + +--- + +## Parameters + +This function does not take any parameters. + +--- + +## Returns + +This function does not return anything + +--- diff --git a/website/content/sdk/reference/forecast/autoarima.md b/website/content/sdk/reference/forecast/autoarima.md new file mode 100644 index 000000000000..149dcc1dc3c5 --- /dev/null +++ b/website/content/sdk/reference/forecast/autoarima.md @@ -0,0 +1,103 @@ +--- +title: autoarima +description: This documentation page discusses the use of the automatic ARIMA (AutoARIMA) + model for forecasting. It provides a detailed insight into the parameters involved, + the return types, model structures, and links to the source code. This page is specifically + valuable for individuals seeking understanding of OpenBB's financial forecasting + abilities based on time series data using Python. +keywords: +- ARIMA +- Forecasting +- AutoARIMA +- TimeSeries +- Source Code +- Parameters +- Returns +- Model +- Chart +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + +Performs Automatic ARIMA forecasting + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/forecast/autoarima_model.py#L27)] + +```python +openbb.forecast.autoarima(data: Union[pd.Series, pd.DataFrame], target_column: str = "close", seasonal_periods: int = 7, n_predict: int = 5, start_window: float = 0.85, forecast_horizon: int = 5) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| data | Union[pd.Series, np.ndarray] | Input data. | None | False | +| target_column | Optional[str] | Target column to forecast. Defaults to "close". | close | True | +| seasonal_periods | int | Number of seasonal periods in a year (7 for daily data)
If not set, inferred from frequency of the series. | 7 | True | +| n_predict | int | Number of days to forecast | 5 | True | +| start_window | float | Size of sliding window from start of timeseries and onwards | 0.85 | True | +| forecast_horizon | int | Number of days to forecast when backtesting and retraining historical | 5 | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| Tuple[List[TimeSeries], List[TimeSeries], List[TimeSeries], float, StatsForecast] | Adjusted Data series,
List of historical fcast values,
List of predicted fcast values,
Optional[float] - precision
Fit AutoaRIMA model object. | +--- + + + + +Display Automatic ARIMA model. + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/forecast/autoarima_view.py#L20)] + +```python +openbb.forecast.autoarima_chart(data: Union[pd.DataFrame, pd.Series], target_column: str = "close", dataset_name: str = "", seasonal_periods: int = 7, n_predict: int = 5, start_window: float = 0.85, forecast_horizon: int = 5, export: str = "", residuals: bool = False, forecast_only: bool = False, start_date: Optional[datetime.datetime] = None, end_date: Optional[datetime.datetime] = None, naive: bool = False, export_pred_raw: bool = False, external_axes: Optional[List[axes]] = None) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| data | Union[pd.Series, np.array] | Data to forecast | None | False | +| dataset_name str | None | The name of the ticker to be predicted | None | True | +| target_column | Optional[str]: | Target column to forecast. Defaults to "close". | close | True | +| seasonal_periods | int | Number of seasonal periods in a year
If not set, inferred from frequency of the series. | 7 | True | +| n_predict | int | Number of days to forecast | 5 | True | +| start_window | float | Size of sliding window from start of timeseries and onwards | 0.85 | True | +| forecast_horizon | int | Number of days to forecast when backtesting and retraining historical | 5 | True | +| export | str | Format to export data | | True | +| residuals | bool | Whether to show residuals for the model. Defaults to False. | False | True | +| forecast_only | bool | Whether to only show dates in the forecasting range. Defaults to False. | False | True | +| start_date | Optional[datetime] | The starting date to perform analysis, data before this is trimmed. Defaults to None. | None | True | +| end_date | Optional[datetime] | The ending date to perform analysis, data after this is trimmed. Defaults to None. | None | True | +| naive | bool | Whether to show the naive baseline. This just assumes the closing price will be the same
as the previous day's closing price. Defaults to False. | False | True | +| external_axes | Optional[List[plt.axes]] | External axes to plot on | None | True | + + +--- + +## Returns + +This function does not return anything + +--- + + + diff --git a/website/content/sdk/reference/forecast/autoces.md b/website/content/sdk/reference/forecast/autoces.md new file mode 100644 index 000000000000..4be37686534b --- /dev/null +++ b/website/content/sdk/reference/forecast/autoces.md @@ -0,0 +1,98 @@ +--- +title: autoces +description: An in-depth look into OpenBB's autoces module that performs Automatic + Complex Exponential Smoothing on time series, particularly useful for stock market + prediction. It provides functionality for data forecasting and visualization. +keywords: +- forecasting +- autoces +- exponential smoothing +- stock market prediction +- timeseries analysis +- data visualization +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + +Performs Automatic Complex Exponential Smoothing forecasting + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/forecast/autoces_model.py#L28)] + +```python +openbb.forecast.autoces(data: Union[pd.Series, pd.DataFrame], target_column: str = "close", seasonal_periods: int = 7, n_predict: int = 5, start_window: float = 0.85, forecast_horizon: int = 5) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| data | Union[pd.Series, np.ndarray] | Input data. | None | False | +| target_column | Optional[str]: | Target column to forecast. Defaults to "close". | close | True | +| seasonal_periods | int | Number of seasonal periods in a year (7 for daily data)
If not set, inferred from frequency of the series. | 7 | True | +| n_predict | int | Number of days to forecast | 5 | True | +| start_window | float | Size of sliding window from start of timeseries and onwards | 0.85 | True | +| forecast_horizon | int | Number of days to forecast when backtesting and retraining historical | 5 | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| Tuple[List[TimeSeries], List[TimeSeries], List[TimeSeries], Optional[float], StatsForecast] | Adjusted Data series,
List of historical fcast values,
List of predicted fcast values,
Optional[float] - precision,
Fit CES model object. | +--- + + + + +Display Automatic Complex Exponential Smoothing Model + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/forecast/autoces_view.py#L20)] + +```python +openbb.forecast.autoces_chart(data: Union[pd.DataFrame, pd.Series], target_column: str = "close", dataset_name: str = "", seasonal_periods: int = 7, n_predict: int = 5, start_window: float = 0.85, forecast_horizon: int = 5, export: str = "", residuals: bool = False, forecast_only: bool = False, start_date: Optional[datetime.datetime] = None, end_date: Optional[datetime.datetime] = None, naive: bool = False, export_pred_raw: bool = False, external_axes: Optional[List[axes]] = None) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| data | Union[pd.Series, np.array] | Data to forecast | None | False | +| dataset_name str | None | The name of the ticker to be predicted | None | True | +| target_column | Optional[str]: | Target column to forecast. Defaults to "close". | close | True | +| seasonal_periods | int | Number of seasonal periods in a year
If not set, inferred from frequency of the series. | 7 | True | +| n_predict | int | Number of days to forecast | 5 | True | +| start_window | float | Size of sliding window from start of timeseries and onwards | 0.85 | True | +| forecast_horizon | int | Number of days to forecast when backtesting and retraining historical | 5 | True | +| export | str | Format to export data | | True | +| residuals | bool | Whether to show residuals for the model. Defaults to False. | False | True | +| forecast_only | bool | Whether to only show dates in the forecasting range. Defaults to False. | False | True | +| start_date | Optional[datetime] | The starting date to perform analysis, data before this is trimmed. Defaults to None. | None | True | +| end_date | Optional[datetime] | The ending date to perform analysis, data after this is trimmed. Defaults to None. | None | True | +| naive | bool | Whether to show the naive baseline. This just assumes the closing price will be the same
as the previous day's closing price. Defaults to False. | False | True | +| external_axes | Optional[List[plt.axes]] | External axes to plot on | None | True | + + +--- + +## Returns + +This function does not return anything + +--- + + + diff --git a/website/content/sdk/reference/forecast/autoets.md b/website/content/sdk/reference/forecast/autoets.md new file mode 100644 index 000000000000..bbb8b065ca78 --- /dev/null +++ b/website/content/sdk/reference/forecast/autoets.md @@ -0,0 +1,101 @@ +--- +title: autoets +description: This documentation page provides comprehensive information about OpenBB's + 'autoets' model and view function for forecasting. The documentation contains source + code links, parameters definitions, and expected returns for financial data. +keywords: +- autoets +- forecasting +- Error Trend Seasonality model +- financial data +- time series +- chart +- parameters +- returns +- StatsForecast +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + +Performs Automatic ETS forecasting + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/forecast/autoets_model.py#L27)] + +```python +openbb.forecast.autoets(data: Union[pd.Series, pd.DataFrame], target_column: str = "close", seasonal_periods: int = 7, n_predict: int = 5, start_window: float = 0.85, forecast_horizon: int = 5) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| data | Union[pd.Series, np.ndarray] | Input data. | None | False | +| target_column | Optional[str]: | Target column to forecast. Defaults to "close". | close | True | +| seasonal_periods | int | Number of seasonal periods in a year (7 for daily data)
If not set, inferred from frequency of the series. | 7 | True | +| n_predict | int | Number of days to forecast | 5 | True | +| start_window | float | Size of sliding window from start of timeseries and onwards | 0.85 | True | +| forecast_horizon | int | Number of days to forecast when backtesting and retraining historical | 5 | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| Tuple[List[TimeSeries], List[TimeSeries], List[TimeSeries], Optional[float], StatsForecast] | Adjusted Data series,
List of historical fcast values,
List of predicted fcast values,
Optional[float] - precision,
Fit ETS model object. | +--- + + + + +Display Automatic ETS (Error, Trend, Sesonality) Model + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/forecast/autoets_view.py#L20)] + +```python +openbb.forecast.autoets_chart(data: Union[pd.DataFrame, pd.Series], target_column: str = "close", dataset_name: str = "", seasonal_periods: int = 7, n_predict: int = 5, start_window: float = 0.85, forecast_horizon: int = 5, export: str = "", residuals: bool = False, forecast_only: bool = False, start_date: Optional[datetime.datetime] = None, end_date: Optional[datetime.datetime] = None, naive: bool = False, export_pred_raw: bool = False, external_axes: Optional[List[axes]] = None) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| data | Union[pd.Series, np.array] | Data to forecast | None | False | +| dataset_name str | None | The name of the ticker to be predicted | None | True | +| target_column | Optional[str]: | Target column to forecast. Defaults to "close". | close | True | +| seasonal_periods | int | Number of seasonal periods in a year
If not set, inferred from frequency of the series. | 7 | True | +| n_predict | int | Number of days to forecast | 5 | True | +| start_window | float | Size of sliding window from start of timeseries and onwards | 0.85 | True | +| forecast_horizon | int | Number of days to forecast when backtesting and retraining historical | 5 | True | +| export | str | Format to export data | | True | +| residuals | bool | Whether to show residuals for the model. Defaults to False. | False | True | +| forecast_only | bool | Whether to only show dates in the forecasting range. Defaults to False. | False | True | +| start_date | Optional[datetime] | The starting date to perform analysis, data before this is trimmed. Defaults to None. | None | True | +| end_date | Optional[datetime] | The ending date to perform analysis, data after this is trimmed. Defaults to None. | None | True | +| naive | bool | Whether to show the naive baseline. This just assumes the closing price will be the same
as the previous day's closing price. Defaults to False. | False | True | +| external_axes | Optional[List[plt.axes]] | External axes to plot on | None | True | + + +--- + +## Returns + +This function does not return anything + +--- + + + diff --git a/website/content/sdk/reference/forecast/autoselect.md b/website/content/sdk/reference/forecast/autoselect.md new file mode 100644 index 000000000000..074ad31dabf4 --- /dev/null +++ b/website/content/sdk/reference/forecast/autoselect.md @@ -0,0 +1,98 @@ +--- +title: autoselect +description: This page provides detailed information about autoselect feature in OpenBB + Terminal with its source code. It outlines parameters and returns of statistical + forecasting model and autoselect chart module in python. +keywords: +- autoselect +- statistical forecasting +- parameters +- returns +- forecasting model +- chart +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + +Performs Automatic Statistical forecasting + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/forecast/autoselect_model.py#L32)] + +```python +openbb.forecast.autoselect(data: Union[pd.Series, pd.DataFrame], target_column: str = "close", seasonal_periods: int = 7, n_predict: int = 5, start_window: float = 0.85, forecast_horizon: int = 5) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| data | Union[pd.Series, np.ndarray] | Input data. | None | False | +| target_column | Optional[str]: | Target column to forecast. Defaults to "close". | close | True | +| seasonal_periods | int | Number of seasonal periods in a year (7 for daily data)
If not set, inferred from frequency of the series. | 7 | True | +| n_predict | int | Number of days to forecast | 5 | True | +| start_window | float | Size of sliding window from start of timeseries and onwards | 0.85 | True | +| forecast_horizon | int | Number of days to forecast when backtesting and retraining historical | 5 | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| Tuple[List[TimeSeries], List[TimeSeries], List[TimeSeries], Optional[float], StatsForecast, Union[int, str]] | list[np.ndarray] - Adjusted Data series
list[np.ndarray] - List of historical fcast values
list[np.ndarray] - List of predicted fcast values
Optional[float] - precision
StatsForecast - Fit ETS model object.
Union[int, str] - Best model | +--- + + + + +Display Automatic Statistical Forecasting Model + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/forecast/autoselect_view.py#L20)] + +```python +openbb.forecast.autoselect_chart(data: Union[pd.DataFrame, pd.Series], target_column: str = "close", dataset_name: str = "", seasonal_periods: int = 7, n_predict: int = 5, start_window: float = 0.85, forecast_horizon: int = 5, export: str = "", residuals: bool = False, forecast_only: bool = False, start_date: Optional[datetime.datetime] = None, end_date: Optional[datetime.datetime] = None, naive: bool = False, export_pred_raw: bool = False, external_axes: Optional[List[axes]] = None) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| data | Union[pd.Series, np.array] | Data to forecast | None | False | +| dataset_name str | None | The name of the ticker to be predicted | None | True | +| target_column | Optional[str]: | Target column to forecast. Defaults to "close". | close | True | +| seasonal_periods | int | Number of seasonal periods in a year
If not set, inferred from frequency of the series. | 7 | True | +| n_predict | int | Number of days to forecast | 5 | True | +| start_window | float | Size of sliding window from start of timeseries and onwards | 0.85 | True | +| forecast_horizon | int | Number of days to forecast when backtesting and retraining historical | 5 | True | +| export | str | Format to export data | | True | +| residuals | bool | Whether to show residuals for the model. Defaults to False. | False | True | +| forecast_only | bool | Whether to only show dates in the forecasting range. Defaults to False. | False | True | +| start_date | Optional[datetime] | The starting date to perform analysis, data before this is trimmed. Defaults to None. | None | True | +| end_date | Optional[datetime] | The ending date to perform analysis, data after this is trimmed. Defaults to None. | None | True | +| naive | bool | Whether to show the naive baseline. This just assumes the closing price will be the same
as the previous day's closing price. Defaults to False. | False | True | +| external_axes | Optional[List[plt.axes]] | External axes to plot on | None | True | + + +--- + +## Returns + +This function does not return anything + +--- + + + diff --git a/website/content/sdk/reference/forecast/brnn.md b/website/content/sdk/reference/forecast/brnn.md new file mode 100644 index 000000000000..e62398a7cf3e --- /dev/null +++ b/website/content/sdk/reference/forecast/brnn.md @@ -0,0 +1,124 @@ +--- +title: brnn +description: This page provides comprehensive information about the BRNN function + in the OpenBB finance library. It details how to perform Block RNN forecasting and + display the forecast with parameters and examples. The page is highly specific to + Python developers working in finance and forecasting. +keywords: +- BRNN Forecast +- OpenBB Forecast +- Python forecasting +- Data series forecasting +- RNN +- LSTM +- GRU +- Chart Display +- Forecasting parameters +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + +Performs Block RNN forecasting + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/forecast/brnn_model.py#L22)] + +```python +openbb.forecast.brnn(data: Union[pd.Series, pd.DataFrame], target_column: str = "close", n_predict: int = 5, train_split: float = 0.85, past_covariates: str = None, forecast_horizon: int = 5, input_chunk_length: int = 14, output_chunk_length: int = 5, model_type: str = "LSTM", n_rnn_layers: int = 1, dropout: float = 0.0, batch_size: int = 32, n_epochs: int = 100, learning_rate: float = 0.001, model_save_name: str = "brnn_model", force_reset: bool = True, save_checkpoints: bool = True) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| data | Union[pd.Series, pd.DataFrame] | Input Data | None | False | +| target_column | str | Target column to forecast. Defaults to "close". | close | True | +| n_predict | int | Days to predict. Defaults to 5. | 5 | True | +| train_split | float | Train/val split. Defaults to 0.85. | 0.85 | True | +| past_covariates | str | Multiple secondary columns to factor in when forecasting. Defaults to None. | None | True | +| forecast_horizon | int | Forecast horizon when performing historical forecasting. Defaults to 5. | 5 | True | +| input_chunk_length | int | Number of past time steps that are fed to the forecasting module at prediction time. Defaults to 14. | 14 | True | +| output_chunk_length | int | The length of the forecast of the model. Defaults to 5. | 5 | True | +| model_type | str | Either a string specifying the RNN module type ("RNN", "LSTM" or "GRU"). Defaults to "LSTM". | LSTM | True | +| n_rnn_layers | int | Number of layers in the RNN module. Defaults to 1. | 1 | True | +| dropout | float | Fraction of neurons affected by Dropout. Defaults to 0.0. | 0.0 | True | +| batch_size | int | Number of time series (input and output sequences) used in each training pass. Defaults to 32. | 32 | True | +| n_epochs | int | Number of epochs over which to train the model. Defaults to 100. | 100 | True | +| learning_rate | float | Defaults to 1e-3. | 0.001 | True | +| model_save_name | str | Name for model. Defaults to "brnn_model". | brnn_model | True | +| force_reset | bool | If set to True, any previously-existing model with the same name will be reset (all checkpoints will be
discarded). Defaults to True. | True | True | +| save_checkpoints | bool | Whether or not to automatically save the untrained model and checkpoints from training. Defaults to True. | True | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| E501 | Adjusted Data series,
Historical forecast by best RNN model,
list of Predictions,
Mean average precision error,
Best BRNN Model. | +--- + + + + +Display BRNN forecast + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/forecast/brnn_view.py#L20)] + +```python +openbb.forecast.brnn_chart(data: Union[pd.Series, pd.DataFrame], target_column: str = "close", dataset_name: str = "", n_predict: int = 5, past_covariates: str = None, train_split: float = 0.85, forecast_horizon: int = 5, input_chunk_length: int = 14, output_chunk_length: int = 5, model_type: str = "LSTM", n_rnn_layers: int = 1, dropout: float = 0.0, batch_size: int = 16, n_epochs: int = 100, learning_rate: float = 0.001, model_save_name: str = "rnn_model", force_reset: bool = True, save_checkpoints: bool = True, export: str = "", residuals: bool = False, forecast_only: bool = False, start_date: Optional[datetime.datetime] = None, end_date: Optional[datetime.datetime] = None, naive: bool = False, export_pred_raw: bool = False, external_axes: Optional[List[axes]] = None) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| data | Union[pd.Series, pd.DataFrame] | Input Data | None | False | +| target_column | str | Target column to forecast. Defaults to "close". | close | True | +| dataset_name | str | The name of the ticker to be predicted | | True | +| n_predict | int | Days to predict. Defaults to 5. | 5 | True | +| train_split | float | Train/val split. Defaults to 0.85. | 0.85 | True | +| past_covariates | str | Multiple secondary columns to factor in when forecasting. Defaults to None. | None | True | +| forecast_horizon | int | Forecast horizon when performing historical forecasting. Defaults to 5. | 5 | True | +| input_chunk_length | int | Number of past time steps that are fed to the forecasting module at prediction time. Defaults to 14. | 14 | True | +| output_chunk_length | int | The length of the forecast of the model. Defaults to 5. | 5 | True | +| model_type | str | Either a string specifying the RNN module type ("RNN", "LSTM" or "GRU"). Defaults to "LSTM". | LSTM | True | +| n_rnn_layers | int | Number of layers in the RNN module. Defaults to 1. | 1 | True | +| dropout | float | Fraction of neurons affected by Dropout. Defaults to 0.0. | 0.0 | True | +| batch_size | int | Number of time series (input and output sequences) used in each training pass. Defaults to 32. | 16 | True | +| n_epochs | int | Number of epochs over which to train the model. Defaults to 101. | 100 | True | +| learning_rate | float | Defaults to 1e-3. | 0.001 | True | +| model_save_name | str | Name for model. Defaults to "brnn_model". | rnn_model | True | +| force_reset | bool | If set to True, any previously-existing model with the same name will be reset
(all checkpoints will be discarded). Defaults to True. | True | True | +| save_checkpoints | bool | Whether or not to automatically save the untrained model and checkpoints from training.
Defaults to True. | True | True | +| export | str | Format to export data | | True | +| residuals | bool | Whether to show residuals for the model. Defaults to False. | False | True | +| forecast_only | bool | Whether to only show dates in the forecasting range. Defaults to False. | False | True | +| start_date | Optional[datetime] | The starting date to perform analysis, data before this is trimmed. Defaults to None. | None | True | +| end_date | Optional[datetime] | The ending date to perform analysis, data after this is trimmed. Defaults to None. | None | True | +| naive | bool | Whether to show the naive baseline. This just assumes the closing price will be the same
as the previous day's closing price. Defaults to False. | False | True | +| external_axes | Optional[List[plt.axes]] | External axes to plot on | None | True | + + +--- + +## Returns + +This function does not return anything + +--- + + + diff --git a/website/content/sdk/reference/forecast/clean.md b/website/content/sdk/reference/forecast/clean.md new file mode 100644 index 000000000000..1379d8477d2b --- /dev/null +++ b/website/content/sdk/reference/forecast/clean.md @@ -0,0 +1,46 @@ +--- +title: clean +description: The clean function in OpenBB's forecasting toolkit fills or drops NaN + values on a given dataset, improving data quality. +keywords: +- clean function OpenBB +- forecasting toolkit +- data cleaning +- fill NaN values +- drop NaN values +- dataset +- data quality improvement +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Clean up NaNs from the dataset + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/forecast/forecast_model.py#L100)] + +```python +openbb.forecast.clean(dataset: pd.DataFrame, fill: Optional[str] = None, drop: Optional[str] = None, limit: Optional[int] = None) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| dataset | pd.DataFrame | The dataset you wish to clean | None | False | +| fill | Optional[str] | The method of filling NaNs | None | True | +| drop | Optional[str] | The method of dropping NaNs | None | True | +| limit | Optional[int] | The maximum limit you wish to apply that can be forward or backward filled | None | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | Dataframe with cleaned up data | +--- diff --git a/website/content/sdk/reference/forecast/combine.md b/website/content/sdk/reference/forecast/combine.md new file mode 100644 index 000000000000..2907425233c6 --- /dev/null +++ b/website/content/sdk/reference/forecast/combine.md @@ -0,0 +1,49 @@ +--- +title: combine +description: Learn how to use the combine function in OpenBB programming library to + add columns to dataframes. This page provides details on parameters, returns, and + even source code. +keywords: +- Combine function +- Data manipulation +- Dataframes +- Forecasting model +- Python library +- Programming +- Source code +- Add column +- Data analysis +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Adds the given column of df2 to df1 + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/forecast/forecast_model.py#L409)] + +```python +openbb.forecast.combine(df1: pd.DataFrame, df2: pd.DataFrame, column: str, dataset: str = "") +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| df1 | pd.DataFrame | The dataframe to add a column to | None | False | +| df2 | pd.DataFrame | The dataframe to lose a column | None | False | +| column | str | The column to transfer | None | False | +| dataset | str | A name for df2 (shows in name of new column) | | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | The new dataframe | +--- diff --git a/website/content/sdk/reference/forecast/corr.md b/website/content/sdk/reference/forecast/corr.md new file mode 100644 index 000000000000..0ff118ab9db0 --- /dev/null +++ b/website/content/sdk/reference/forecast/corr.md @@ -0,0 +1,83 @@ +--- +title: corr +description: This page shares details on how to use 'corr' and 'corr_chart' functions + of OpenBB Terminal's forecast module. The 'corr' function returns correlation for + a given DataFrame, and 'corr_chart' function plots correlation coefficients for + dataset features. +keywords: +- forecast module +- corr function +- correlation coefficients +- data analysis +- corr_chart function +- plot correlation coefficients +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + +Returns correlation for a given df + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/forecast/forecast_model.py#L521)] + +```python +openbb.forecast.corr(data: pd.DataFrame) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| data | pd.DataFrame | The df to produce statistics for | None | False | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | The df with the new data | +--- + + + + +Plot correlation coefficients for dataset features + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/forecast/forecast_view.py#L170)] + +```python +openbb.forecast.corr_chart(dataset: pd.DataFrame, export: str = "", external_axes: Optional[List[axes]] = None) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| dataset | pd.DataFrame | The dataset fore calculating correlation coefficients | None | False | +| export | str | Format to export image | | True | +| external_axes | Optional[List[plt.axes]] | External axes to plot on | None | True | + + +--- + +## Returns + +This function does not return anything + +--- + + + diff --git a/website/content/sdk/reference/forecast/delete.md b/website/content/sdk/reference/forecast/delete.md new file mode 100644 index 000000000000..d7ee1114c080 --- /dev/null +++ b/website/content/sdk/reference/forecast/delete.md @@ -0,0 +1,36 @@ +--- +title: delete +description: OpenBB's delete function page. The function takes the data and column + parameters. There are no return values. +keywords: +- openbb.forecast.delete +- delete function +- data parameter +- column parameter +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +None + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/forecast/forecast_model.py#L466)] + +```python +openbb.forecast.delete(data: pd.DataFrame, column: str) +``` + +--- + +## Parameters + +This function does not take any parameters. + +--- + +## Returns + +This function does not return anything + +--- diff --git a/website/content/sdk/reference/forecast/delta.md b/website/content/sdk/reference/forecast/delta.md new file mode 100644 index 000000000000..adf5ae4a1cf6 --- /dev/null +++ b/website/content/sdk/reference/forecast/delta.md @@ -0,0 +1,39 @@ +--- +title: delta +description: The page is a detailed guide on how to calculate the percent change of + a variable using the 'delta' function in the OpenBBTerminal's forecast model. It + demonstrates how to use the 'openbb.forecast.delta' function through Python code. +keywords: +- delta +- '%change calculation' +- variable change +- forecast model +- openbb.forecast.delta +- target_column +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Calculate the %change of a variable based on a specific column + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/forecast/forecast_model.py#L335)] + +```python +openbb.forecast.delta(dataset: pd.DataFrame, target_column: str = "close") +``` + +--- + +## Parameters + +This function does not take any parameters. + +--- + +## Returns + +This function does not return anything + +--- diff --git a/website/content/sdk/reference/forecast/desc.md b/website/content/sdk/reference/forecast/desc.md new file mode 100644 index 000000000000..25c489b567dc --- /dev/null +++ b/website/content/sdk/reference/forecast/desc.md @@ -0,0 +1,77 @@ +--- +title: desc +description: Detailed information on how to use the 'desc' function of the OpenBB + finance package in Python. The function returns statistics for a specified data + frame. +keywords: +- OpenBB finance package +- data frame +- statistics +- forecasting +- parameters +- returns +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + +Returns statistics for a given df + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/forecast/forecast_model.py#L504)] + +```python +openbb.forecast.desc(data: pd.DataFrame) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| data | pd.DataFrame | The df to produce statistics for | None | False | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | The df with the new data | +--- + + + + +None + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/forecast/forecast_view.py#L257)] + +```python +openbb.forecast.desc_chart(data: pd.DataFrame, name: str = "", export: str = "") +``` + +--- + +## Parameters + +This function does not take any parameters. + +--- + +## Returns + +This function does not return anything + +--- + + + diff --git a/website/content/sdk/reference/forecast/ema.md b/website/content/sdk/reference/forecast/ema.md new file mode 100644 index 000000000000..52ae906d95d8 --- /dev/null +++ b/website/content/sdk/reference/forecast/ema.md @@ -0,0 +1,45 @@ +--- +title: ema +description: Documentation on how to use the EMA (Exponential Moving Average) function + with OpenBB Terminal. The function receives a dataset and returns a DataFrame with + an added EMA column, providing an indication of price trend movement. +keywords: +- EMA +- Moving average +- Price trend +- Forecast +- Dataset +- Source code +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +A moving average provides an indication of the trend of the price movement + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/forecast/forecast_model.py#L159)] + +```python +openbb.forecast.ema(dataset: pd.DataFrame, target_column: str = "close", period: int = 10) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| dataset | pd.DataFrame | The dataset you wish to clean | None | False | +| target_column | str | The column you wish to add the EMA to | close | True | +| period | int | Time Span | 10 | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | Dataframe with added EMA column | +--- diff --git a/website/content/sdk/reference/forecast/expo.md b/website/content/sdk/reference/forecast/expo.md new file mode 100644 index 000000000000..aba47d6ffa71 --- /dev/null +++ b/website/content/sdk/reference/forecast/expo.md @@ -0,0 +1,105 @@ +--- +title: expo +description: The page explores the functionalities and parameters of the 'expo' model + and 'chart' functions used in Probabilistic Exponential Smoothing forecasting. These + functions take data as input and perform operations like backtesting, retraining + historical and prediction. Source code links are also shared. +keywords: +- Exponential Smoothing forecasting +- expo model function +- expo chart function +- Probabilistic forecasting +- data series operations +- parameters +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + +Performs Probabilistic Exponential Smoothing forecasting + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/forecast/expo_model.py#L34)] + +```python +openbb.forecast.expo(data: Union[pd.Series, pd.DataFrame], target_column: str = "close", trend: str = "A", seasonal: str = "A", seasonal_periods: int = 7, dampen: str = "F", n_predict: int = 5, start_window: float = 0.85, forecast_horizon: int = 5) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| data | Union[pd.Series, np.ndarray] | Input data. | None | False | +| target_column | Optional[str]: | Target column to forecast. Defaults to "close". | close | True | +| trend | str | Trend component. One of [N, A, M]
Defaults to ADDITIVE. | A | True | +| seasonal | str | Seasonal component. One of [N, A, M]
Defaults to ADDITIVE. | A | True | +| seasonal_periods | int | Number of seasonal periods in a year (7 for daily data)
If not set, inferred from frequency of the series. | 7 | True | +| dampen | str | Dampen the function | F | True | +| n_predict | int | Number of days to forecast | 5 | True | +| start_window | float | Size of sliding window from start of timeseries and onwards | 0.85 | True | +| forecast_horizon | int | Number of days to forecast when backtesting and retraining historical | 5 | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| Tuple[List[TimeSeries], List[TimeSeries], List[TimeSeries], Optional[Union[float, ndarray]], ExponentialSmoothing] | Adjusted Data series,
List of historical fcast values,
List of predicted fcast values,
Optional[float] - precision,
Fit Prob. Expo model object. | +--- + + + + +Display Probabilistic Exponential Smoothing forecast + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/forecast/expo_view.py#L20)] + +```python +openbb.forecast.expo_chart(data: Union[pd.DataFrame, pd.Series], target_column: str = "close", dataset_name: str = "", trend: str = "A", seasonal: str = "A", seasonal_periods: int = 7, dampen: str = "F", n_predict: int = 5, start_window: float = 0.85, forecast_horizon: int = 5, export: str = "", residuals: bool = False, forecast_only: bool = False, start_date: Optional[datetime.datetime] = None, end_date: Optional[datetime.datetime] = None, naive: bool = False, export_pred_raw: bool = False, external_axes: Optional[List[axes]] = None) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| data | Union[pd.Series, np.array] | Data to forecast | None | False | +| dataset_name str | None | The name of the ticker to be predicted | None | True | +| target_column | Optional[str]: | Target column to forecast. Defaults to "close". | close | True | +| trend | str | Trend component. One of [N, A, M]
Defaults to ADDITIVE. | A | True | +| seasonal | str | Seasonal component. One of [N, A, M]
Defaults to ADDITIVE. | A | True | +| seasonal_periods | int | Number of seasonal periods in a year
If not set, inferred from frequency of the series. | 7 | True | +| dampen | str | Dampen the function | F | True | +| n_predict | int | Number of days to forecast | 5 | True | +| start_window | float | Size of sliding window from start of timeseries and onwards | 0.85 | True | +| forecast_horizon | int | Number of days to forecast when backtesting and retraining historical | 5 | True | +| export | str | Format to export data | | True | +| residuals | bool | Whether to show residuals for the model. Defaults to False. | False | True | +| forecast_only | bool | Whether to only show dates in the forecasting range. Defaults to False. | False | True | +| start_date | Optional[datetime] | The starting date to perform analysis, data before this is trimmed. Defaults to None. | None | True | +| end_date | Optional[datetime] | The ending date to perform analysis, data after this is trimmed. Defaults to None. | None | True | +| naive | bool | Whether to show the naive baseline. This just assumes the closing price will be the same
as the previous day's closing price. Defaults to False. | False | True | +| external_axes | Optional[List[plt.axes]] | External axes to plot on | None | True | + + +--- + +## Returns + +This function does not return anything + +--- + + + diff --git a/website/content/sdk/reference/forecast/export.md b/website/content/sdk/reference/forecast/export.md new file mode 100644 index 000000000000..9a5705911a53 --- /dev/null +++ b/website/content/sdk/reference/forecast/export.md @@ -0,0 +1,36 @@ +--- +title: export +description: Enhance your grasp of the openbb.forecast.export function from the OpenBBTerminal, + which is employed to export forecasting data. This function takes no parameters + and does not return anything. Chances to learn more about Python source code. +keywords: +- openbb.forecast.export +- forecasting +- data export +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +None + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/forecast/forecast_view.py#L270)] + +```python +openbb.forecast.export(data: pd.DataFrame, export: str, name: str = "") +``` + +--- + +## Parameters + +This function does not take any parameters. + +--- + +## Returns + +This function does not return anything + +--- diff --git a/website/content/sdk/reference/forecast/linregr.md b/website/content/sdk/reference/forecast/linregr.md new file mode 100644 index 000000000000..a303e53b4521 --- /dev/null +++ b/website/content/sdk/reference/forecast/linregr.md @@ -0,0 +1,102 @@ +--- +title: linregr +description: Perform or display linear regression forecasting with OpenBB. The page + provides the function parameters and their explanations, as well as the return values. +keywords: +- linear regression +- forecasting +- data analysis +- parameters +- returns +- prediction +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + +Perform Linear Regression Forecasting + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/forecast/linregr_model.py#L22)] + +```python +openbb.forecast.linregr(data: Union[pd.Series, pd.DataFrame], target_column: str = "close", n_predict: int = 5, past_covariates: str = None, train_split: float = 0.85, forecast_horizon: int = 5, output_chunk_length: int = 5, lags: Union[int, List[int]] = 14, random_state: Optional[int] = None) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| data | Union[pd.Series, pd.DataFrame] | Input Data | None | False | +| target_column | str | Target column to forecast. Defaults to "close". | close | True | +| n_predict | int | Days to predict. Defaults to 5. | 5 | True | +| train_split | float | Train/val split. Defaults to 0.85. | 0.85 | True | +| past_covariates | str | Multiple secondary columns to factor in when forecasting. Defaults to None. | None | True | +| forecast_horizon | int | Forecast horizon when performing historical forecasting. Defaults to 5. | 5 | True | +| output_chunk_length | int | The length of the forecast of the model. Defaults to 1. | 5 | True | +| lags | Union[int, List[int]] | lagged target values to predict the next time step | 14 | True | +| random_state | Optional[int] | The state for the model | None | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| Tuple[List[TimeSeries], List[TimeSeries], List[TimeSeries], float, LinearRegressionModel] | Adjusted Data series,
Historical forecast by best RNN model,
list of Predictions,
Mean average precision error,
Best Linear Regression Model. | +--- + + + + +Display Linear Regression Forecasting + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/forecast/linregr_view.py#L20)] + +```python +openbb.forecast.linregr_chart(data: Union[pd.Series, pd.DataFrame], target_column: str = "close", dataset_name: str = "", n_predict: int = 5, past_covariates: str = None, train_split: float = 0.85, forecast_horizon: int = 5, output_chunk_length: int = 1, lags: Union[int, List[int]] = 72, export: str = "", residuals: bool = False, forecast_only: bool = False, start_date: Optional[datetime.datetime] = None, end_date: Optional[datetime.datetime] = None, naive: bool = False, explainability_raw: bool = False, export_pred_raw: bool = False, external_axes: Optional[List[axes]] = None) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| data | Union[pd.Series, pd.DataFrame] | Input Data | None | False | +| dataset_name | str | The name of the ticker to be predicted | | True | +| n_predict | int | Days to predict. Defaults to 5. | 5 | True | +| target_col | str | Target column to forecast. Defaults to "close". | None | True | +| train_split (float, optional) | | Train/val split. Defaults to 0.85. | None | True | +| past_covariates | str | Multiple secondary columns to factor in when forecasting. Defaults to None. | None | True | +| forecast_horizon | int | Forecast horizon when performing historical forecasting. Defaults to 5. | 5 | True | +| output_chunk_length | int | The length of the forecast of the model. Defaults to 1. | 1 | True | +| lags | Union[int, List[int]] | lagged target values to predict the next time step | 72 | True | +| export | str | Format to export data | | True | +| residuals | bool | Whether to show residuals for the model. Defaults to False. | False | True | +| forecast_only | bool | Whether to only show dates in the forecasting range. Defaults to False. | False | True | +| start_date | Optional[datetime] | The starting date to perform analysis, data before this is trimmed. Defaults to None. | None | True | +| end_date | Optional[datetime] | The ending date to perform analysis, data after this is trimmed. Defaults to None. | None | True | +| naive | bool | Whether to show the naive baseline. This just assumes the closing price will be the
same as the previous day's closing price. Defaults to False. | False | True | +| external_axes | Optional[List[plt.axes]] | External axes to plot on | None | True | + + +--- + +## Returns + +This function does not return anything + +--- + + + diff --git a/website/content/sdk/reference/forecast/load.md b/website/content/sdk/reference/forecast/load.md new file mode 100644 index 000000000000..6996dcef892b --- /dev/null +++ b/website/content/sdk/reference/forecast/load.md @@ -0,0 +1,46 @@ +--- +title: load +description: Documentation for the 'load' function from the OpenBB forecast library. + This function permits to load a custom file into a DataFrame within Python. It covers + instructions, source code, parameters, and returns. +keywords: +- load +- custom file +- dataframe +- forecast +- parameters +- data_files +- data_examples +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Load custom file into dataframe. + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/common/common_model.py#L53)] + +```python +openbb.forecast.load(file: str, data_files: Optional[Dict[Any, Any]] = None, data_examples: Optional[Dict[Any, Any]] = None) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| file | str | Path to file | None | False | +| data_files | dict | Contains all available data files within the Export folder | None | True | +| data_examples | dict | Contains all available examples from Statsmodels | None | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | Dataframe with custom data | +--- diff --git a/website/content/sdk/reference/forecast/mom.md b/website/content/sdk/reference/forecast/mom.md new file mode 100644 index 000000000000..ad51a1687199 --- /dev/null +++ b/website/content/sdk/reference/forecast/mom.md @@ -0,0 +1,44 @@ +--- +title: mom +description: This page provides information about the momentum oscillator 'mom' function + in the OpenBB forecast module. It explains the parameters and returns a DataFrame + with an added MOM column. +keywords: +- momentum oscillator +- mom function +- OpenBB forecast module +- MOM column +- parameters +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +A momentum oscillator, which measures the percentage change between the current + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/forecast/forecast_model.py#L308)] + +```python +openbb.forecast.mom(dataset: pd.DataFrame, target_column: str = "close", period: int = 10) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| dataset | pd.DataFrame | The dataset you wish to calculate with | None | False | +| target_column | str | The column you wish to add the MOM to | close | True | +| period | int | Time Span | 10 | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | Dataframe with added MOM column | +--- diff --git a/website/content/sdk/reference/forecast/mstl.md b/website/content/sdk/reference/forecast/mstl.md new file mode 100644 index 000000000000..d5c235eb63fc --- /dev/null +++ b/website/content/sdk/reference/forecast/mstl.md @@ -0,0 +1,100 @@ +--- +title: mstl +description: MSTL model forecasting and charting documentation, including code and + parameter documentation. Details the use of OpenBB.forecast.mstl function in processing + time-series data for predictive analysis. +keywords: +- MSTL +- forecasting +- OpenBB.forecast.mstl +- time-series data +- predictive analysis +- code +- model +- parameters +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + +Performs MSTL forecasting + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/forecast/mstl_model.py#L26)] + +```python +openbb.forecast.mstl(data: Union[pd.Series, pd.DataFrame], target_column: str = "close", seasonal_periods: int = 7, n_predict: int = 5, start_window: float = 0.85, forecast_horizon: int = 5) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| data | Union[pd.Series, np.ndarray] | Input data. | None | False | +| target_column | Optional[str]: | Target column to forecast. Defaults to "close". | close | True | +| seasonal_periods | int | Number of seasonal periods in a year (7 for daily data)
If not set, inferred from frequency of the series. | 7 | True | +| n_predict | int | Number of days to forecast | 5 | True | +| start_window | float | Size of sliding window from start of timeseries and onwards | 0.85 | True | +| forecast_horizon | int | Number of days to forecast when backtesting and retraining historical | 5 | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| | Adjusted Data series,
List of historical fcast values,
List of predicted fcast values,
Optional[float] - precision,
Fit MSTL model object. | +--- + + + + +Display MSTL Model + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/forecast/mstl_view.py#L20)] + +```python +openbb.forecast.mstl_chart(data: Union[pd.DataFrame, pd.Series], target_column: str = "close", dataset_name: str = "", seasonal_periods: int = 7, n_predict: int = 5, start_window: float = 0.85, forecast_horizon: int = 5, export: str = "", residuals: bool = False, forecast_only: bool = False, start_date: Optional[datetime.datetime] = None, end_date: Optional[datetime.datetime] = None, naive: bool = False, export_pred_raw: bool = False, external_axes: Optional[List[axes]] = None) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| data | Union[pd.Series, np.array] | Data to forecast | None | False | +| dataset_name str | None | The name of the ticker to be predicted | None | True | +| target_column | Optional[str]: | Target column to forecast. Defaults to "close". | close | True | +| seasonal_periods | int | Number of seasonal periods in a year
If not set, inferred from frequency of the series. | 7 | True | +| n_predict | int | Number of days to forecast | 5 | True | +| start_window | float | Size of sliding window from start of timeseries and onwards | 0.85 | True | +| forecast_horizon | int | Number of days to forecast when backtesting and retraining historical | 5 | True | +| export | str | Format to export data | | True | +| residuals | bool | Whether to show residuals for the model. Defaults to False. | False | True | +| forecast_only | bool | Whether to only show dates in the forecasting range. Defaults to False. | False | True | +| start_date | Optional[datetime] | The starting date to perform analysis, data before this is trimmed. Defaults to None. | None | True | +| end_date | Optional[datetime] | The ending date to perform analysis, data after this is trimmed. Defaults to None. | None | True | +| naive | bool | Whether to show the naive baseline. This just assumes the closing price will be the same
as the previous day's closing price. Defaults to False. | False | True | +| external_axes | Optional[List[plt.axes]] | External axes to plot on | None | True | + + +--- + +## Returns + +This function does not return anything + +--- + + + diff --git a/website/content/sdk/reference/forecast/nbeats.md b/website/content/sdk/reference/forecast/nbeats.md new file mode 100644 index 000000000000..b59745fb5bf5 --- /dev/null +++ b/website/content/sdk/reference/forecast/nbeats.md @@ -0,0 +1,123 @@ +--- +title: nbeats +description: Learn how to perform NBEATS Forecasting with OpenBB Finance. Explore + the parameters, their descriptions, and learn how to properly tune them for optimal + forecasting results. +keywords: +- NBEATS Forecasting +- OpenBB Finance +- forecast parameters +- training models +- machine learning +- data science +- time series prediction +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + +Perform NBEATS Forecasting + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/forecast/nbeats_model.py#L21)] + +```python +openbb.forecast.nbeats(data: Union[pd.Series, pd.DataFrame], target_column: str = "close", n_predict: int = 5, past_covariates: str = None, train_split: float = 0.85, forecast_horizon: int = 5, input_chunk_length: int = 14, output_chunk_length: int = 5, num_stacks: int = 10, num_blocks: int = 3, num_layers: int = 4, layer_widths: int = 512, batch_size: int = 800, n_epochs: int = 100, learning_rate: float = 0.001, model_save_name: str = "nbeats_model", force_reset: bool = True, save_checkpoints: bool = True) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| data | Union[pd.Series, pd.DataFrame] | Input Data | None | False | +| target_column | str | Target column to forecast. Defaults to "close". | close | True | +| n_predict | int | Days to predict. Defaults to 5. | 5 | True | +| train_split | float | Train/val split. Defaults to 0.85. | 0.85 | True | +| past_covariates | str | Multiple secondary columns to factor in when forecasting. Defaults to None. | None | True | +| forecast_horizon | int | Forecast horizon when performing historical forecasting. Defaults to 5. | 5 | True | +| input_chunk_length | int | Number of past time steps that are fed to the forecasting module at prediction time. Defaults to 14. | 14 | True | +| output_chunk_length | int | The length of the forecast of the model. Defaults to 5. | 5 | True | +| num_stacks | int | The number of stacks that make up the whole model. Defaults to 10. | 10 | True | +| num_blocks | int | The number of blocks making up every stack. Defaults to 3. | 3 | True | +| num_layers | int | The number of fully connected layers preceding the final forking layers in each block
of every stack. Defaults to 4. | 4 | True | +| layer_widths | int | Determines the number of neurons that make up each fully connected layer in each block
of every stack. Defaults to 512. | 512 | True | +| batch_size | int | Number of time series (input and output sequences) used in each training pass. Defaults to 32. | 800 | True | +| n_epochs | int | Number of epochs over which to train the model. Defaults to 100. | 100 | True | +| learning_rate | float | Defaults to 1e-3. | 0.001 | True | +| model_save_name | str | Name for model. Defaults to "brnn_model". | nbeats_model | True | +| force_reset | bool | If set to True, any previously-existing model with the same name will be reset
(all checkpoints will be discarded). Defaults to True. | True | True | +| save_checkpoints | bool | Whether or not to automatically save the untrained model and checkpoints from training.
Defaults to True. | True | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| Tuple[List[TimeSeries], List[TimeSeries], List[TimeSeries], Optional[float], type[NBEATSModel]] | Adjusted Data series,
Historical forecast by best RNN model,
list of Predictions,
Mean average precision error,
Best NBEATS Model. | +--- + + + + +Display NBEATS forecast + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/forecast/nbeats_view.py#L20)] + +```python +openbb.forecast.nbeats_chart(data: Union[pd.DataFrame, pd.Series], target_column: str = "close", dataset_name: str = "", n_predict: int = 5, past_covariates: str = None, train_split: float = 0.85, forecast_horizon: int = 5, input_chunk_length: int = 14, output_chunk_length: int = 5, num_stacks: int = 10, num_blocks: int = 3, num_layers: int = 4, layer_widths: int = 512, n_epochs: int = 100, learning_rate: float = 0.001, batch_size: int = 800, model_save_name: str = "nbeats_model", force_reset: bool = True, save_checkpoints: bool = True, export: str = "", residuals: bool = False, forecast_only: bool = False, start_date: Optional[datetime.datetime] = None, end_date: Optional[datetime.datetime] = None, naive: bool = False, export_pred_raw: bool = False, external_axes: Optional[List[axes]] = None) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| data | Union[pd.Series, pd.DataFrame] | Input Data | None | False | +| target_column | str | Target column to forecast. Defaults to "close". | close | True | +| dataset_name | str | The name of the ticker to be predicted | | True | +| n_predict | int | Days to predict. Defaults to 5. | 5 | True | +| train_split | float | Train/val split. Defaults to 0.85. | 0.85 | True | +| past_covariates | str | Multiple secondary columns to factor in when forecasting. Defaults to None. | None | True | +| forecast_horizon | int | Forecast horizon when performing historical forecasting. Defaults to 5. | 5 | True | +| input_chunk_length | int | Number of past time steps that are fed to the forecasting module at prediction time. Defaults to 14. | 14 | True | +| output_chunk_length | int | The length of the forecast of the model. Defaults to 5. | 5 | True | +| num_stacks | int | The number of stacks that make up the whole model. Defaults to 10. | 10 | True | +| num_blocks | int | The number of blocks making up every stack. Defaults to 3. | 3 | True | +| num_layers | int | The number of fully connected layers preceding the final forking layers in each block
of every stack. Defaults to 4. | 4 | True | +| layer_widths | int | Determines the number of neurons that make up each fully connected layer in each block
of every stack. Defaults to 512. | 512 | True | +| batch_size | int | Number of time series (input and output sequences) used in each training pass. Defaults
to 32. | 800 | True | +| n_epochs | int | Number of epochs over which to train the model. Defaults to 100. | 100 | True | +| learning_rate | float | Defaults to 1e-3. | 0.001 | True | +| model_save_name | str | Name for model. Defaults to "brnn_model". | nbeats_model | True | +| force_reset | bool | If set to True, any previously-existing model with the same name will be reset (all
checkpoints will be discarded). Defaults to True. | True | True | +| save_checkpoints | bool | Whether or not to automatically save the untrained model and checkpoints from training.
Defaults to True. | True | True | +| export | str | Format to export data | | True | +| residuals | bool | Whether to show residuals for the model. Defaults to False. | False | True | +| forecast_only | bool | Whether to only show dates in the forecasting range. Defaults to False. | False | True | +| start_date | Optional[datetime] | The starting date to perform analysis, data before this is trimmed. Defaults to None. | None | True | +| end_date | Optional[datetime] | The ending date to perform analysis, data after this is trimmed. Defaults to None. | None | True | +| naive | bool | Whether to show the naive baseline. This just assumes the closing price will be the same
as the previous day's closing price. Defaults to False. | False | True | +| external_axes | Optional[List[plt.axes]] | External axes to plot on | None | True | + + +--- + +## Returns + +This function does not return anything + +--- + + + diff --git a/website/content/sdk/reference/forecast/nhits.md b/website/content/sdk/reference/forecast/nhits.md new file mode 100644 index 000000000000..aef2bd490b02 --- /dev/null +++ b/website/content/sdk/reference/forecast/nhits.md @@ -0,0 +1,140 @@ +--- +title: nhits +description: This is a Docusaurus page that displays in-depth information on forecasting + using the OpenBB's NhitsModel. It provides details on parameters, returns and also + provides source code links to the OpenBB finance's Github repository. +keywords: +- Docusaurus +- nhits +- forecasting +- NhitsModel +- nhits_chart +- pd.Series +- title +- description +- keywords +- metadata +- marketing +- analysis +- TimeSeries +- NHiTSModel +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + +Performs Nhits forecasting + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/forecast/nhits_model.py#L22)] + +```python +openbb.forecast.nhits(data: Union[pd.Series, pd.DataFrame], target_column: str = "close", n_predict: int = 5, train_split: float = 0.85, past_covariates: str = None, forecast_horizon: int = 5, input_chunk_length: int = 14, output_chunk_length: int = 5, num_stacks: int = 3, num_blocks: int = 1, num_layers: int = 2, layer_widths: int = 512, pooling_kernel_sizes: Optional[Tuple[Tuple[int]]] = None, n_freq_downsample: Optional[Tuple[Tuple[int]]] = None, dropout: float = 0.1, activation: str = "ReLU", max_pool_1d: bool = True, batch_size: int = 32, n_epochs: int = 100, learning_rate: float = 0.001, model_save_name: str = "brnn_model", force_reset: bool = True, save_checkpoints: bool = True) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| data | Union[pd.Series, pd.DataFrame] | Input Data | None | False | +| target_column | str | Target column to forecast. Defaults to "close". | close | True | +| n_predict | int | Days to predict. Defaults to 5. | 5 | True | +| train_split | float | Train/val split. Defaults to 0.85. | 0.85 | True | +| past_covariates | str | Multiple secondary columns to factor in when forecasting. Defaults to None. | None | True | +| forecast_horizon | int | Forecast horizon when performing historical forecasting. Defaults to 5. | 5 | True | +| input_chunk_length | int | Number of past time steps that are fed to the forecasting module at prediction time. Defaults to 14. | 14 | True | +| output_chunk_length | int | The length of the forecast of the model. Defaults to 5. | 5 | True | +| num_stacks | int | The number of stacks that make up the whole model. | 3 | True | +| num_blocks | int | The number of blocks making up every stack. | 1 | True | +| num_layers | int | The number of fully connected layers preceding the final forking layers in each block
of every stack. | 2 | True | +| layer_widths | int | Determines the number of neurons that make up each fully connected layer in each
block of every stack. If a list is passed, it must have a length equal to num_stacks
and every entry in that list corresponds to the layer width of the corresponding stack.
If an integer is passed, every stack will have blocks with FC layers of the same width. | 512 | True | +| pooling_kernel_size | Optional[Tuple[Tuple[int]]]: | If set, this parameter must be a tuple of tuples, of size (num_stacks x num_blocks),
specifying the kernel size for each block in each stack used for the input pooling
layer. If left to None, some default values will be used based on input_chunk_length. | None | True | +| n_freq_downsample | Optional[Tuple[Tuple[int]]] | If set, this parameter must be a tuple of tuples, of size (num_stacks x num_blocks),
specifying the downsampling factors before interpolation, for each block in each stack.
If left to None, some default values will be used based on output_chunk_length. | None | True | +| dropout | float | The dropout probability to be used in fully connected layers. | 0.1 | True | +| activation | str | Supported activations: [‘ReLU’,’RReLU’, ‘PReLU’, ‘Softplus’, ‘Tanh’, ‘SELU’, ‘LeakyReLU’, ‘Sigmoid’] | ReLU | True | +| max_pool_1d | bool | Use max_pool_1d pooling. False uses AvgPool1d. | True | True | +| batch_size | int | Number of time series (input and output sequences) used in each training pass. Defaults to 32. | 32 | True | +| n_epochs | int | Number of epochs over which to train the model. Defaults to 100. | 100 | True | +| learning_rate | float | Defaults to 1e-3. | 0.001 | True | +| model_save_name | str | Name for model. Defaults to "brnn_model". | brnn_model | True | +| force_reset | bool | If set to True, any previously-existing model with the same name will be reset (all checkpoints will be
discarded). Defaults to True. | True | True | +| save_checkpoints | bool | Whether or not to automatically save the untrained model and checkpoints from training. Defaults to True. | True | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| Tuple[List[TimeSeries], List[TimeSeries], List[TimeSeries], Optional[float], type[NHiTSModel]] | Adjusted Data series,
Historical forecast by best RNN model,
list of Predictions,
Mean average precision error,
Best BRNN Model. | +--- + + + + +Display Nhits forecast + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/forecast/nhits_view.py#L20)] + +```python +openbb.forecast.nhits_chart(data: Union[pd.Series, pd.DataFrame], target_column: str = "close", dataset_name: str = "", n_predict: int = 5, past_covariates: str = None, train_split: float = 0.85, forecast_horizon: int = 5, input_chunk_length: int = 14, output_chunk_length: int = 5, num_stacks: int = 3, num_blocks: int = 1, num_layers: int = 2, layer_widths: int = 512, pooling_kernel_sizes: Optional[Tuple[Tuple[int]]] = None, n_freq_downsample: Optional[Tuple[Tuple[int]]] = None, dropout: float = 0.1, activation: str = "ReLU", max_pool_1d: bool = True, batch_size: int = 32, n_epochs: int = 100, learning_rate: float = 0.001, model_save_name: str = "rnn_model", force_reset: bool = True, save_checkpoints: bool = True, export: str = "", residuals: bool = False, forecast_only: bool = False, start_date: Optional[datetime.datetime] = None, end_date: Optional[datetime.datetime] = None, naive: bool = False, export_pred_raw: bool = False, external_axes: Optional[List[axes]] = None) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| data | Union[pd.Series, pd.DataFrame] | Input Data | None | False | +| target_column | str | Target column to forecast. Defaults to "close". | close | True | +| dataset_name | str | The name of the ticker to be predicted | | True | +| n_predict | int | Days to predict. Defaults to 5. | 5 | True | +| train_split | float | Train/val split. Defaults to 0.85. | 0.85 | True | +| past_covariates | str | Multiple secondary columns to factor in when forecasting. Defaults to None. | None | True | +| forecast_horizon | int | Forecast horizon when performing historical forecasting. Defaults to 5. | 5 | True | +| input_chunk_length | int | Number of past time steps that are fed to the forecasting module at prediction time. Defaults to 14. | 14 | True | +| output_chunk_length | int | The length of the forecast of the model. Defaults to 5. | 5 | True | +| num_stacks | int | The number of stacks that make up the whole model. | 3 | True | +| num_blocks | int | The number of blocks making up every stack. | 1 | True | +| num_layers | int | The number of fully connected layers preceding the final forking layers in each block
of every stack. | 2 | True | +| layer_widths | int | Determines the number of neurons that make up each fully connected layer in each
block of every stack. If a list is passed, it must have a length equal to num_stacks
and every entry in that list corresponds to the layer width of the corresponding stack.
If an integer is passed, every stack will have blocks with FC layers of the same width. | 512 | True | +| pooling_kernel_size | Optional[Tuple[Tuple[int]]] | If set, this parameter must be a tuple of tuples, of size (num_stacks x num_blocks),
specifying the kernel size for each block in each stack used for the input pooling
layer. If left to None, some default values will be used based on input_chunk_length. | None | True | +| n_freq_downsample | Optional[Tuple[Tuple[int]]] | If set, this parameter must be a tuple of tuples, of size (num_stacks x num_blocks),
specifying the downsampling factors before interpolation, for each block in each stack.
If left to None, some default values will be used based on output_chunk_length. | None | True | +| dropout | float | The dropout probability to be used in fully connected layers. | 0.1 | True | +| activation | str | Supported activations: [[‘ReLU’,’RReLU’, ‘PReLU’, ‘Softplus’, ‘Tanh’, ‘SELU’, ‘LeakyReLU’, ‘Sigmoid’] | ReLU | True | +| max_pool_1d | bool | Use max_pool_1d pooling. False uses AvgPool1d. | True | True | +| batch_size | int | Number of time series (input and output sequences) used in each training pass. Defaults to 32. | 32 | True | +| n_epochs | int | Number of epochs over which to train the model. Defaults to 100. | 100 | True | +| learning_rate | float | Defaults to 1e-3. | 0.001 | True | +| model_save_name | str | Name for model. Defaults to "brnn_model". | rnn_model | True | +| force_reset | bool | If set to True, any previously-existing model with the same name will be reset
(all checkpoints will be discarded). Defaults to True. | True | True | +| save_checkpoints | bool | Whether or not to automatically save the untrained model and checkpoints from training.
Defaults to True. | True | True | +| export | str | Format to export data | | True | +| residuals | bool | Whether to show residuals for the model. Defaults to False. | False | True | +| forecast_only | bool | Whether to only show dates in the forecasting range. Defaults to False. | False | True | +| start_date | Optional[datetime] | The starting date to perform analysis, data before this is trimmed. Defaults to None. | None | True | +| end_date | Optional[datetime] | The ending date to perform analysis, data after this is trimmed. Defaults to None. | None | True | +| naive | bool | Whether to show the naive baseline. This just assumes the closing price will be the same
as the previous day's closing price. Defaults to False. | False | True | +| external_axes | Optional[List[plt.axes]] | External axes to plot on | None | True | + + +--- + +## Returns + +This function does not return anything + +--- + + + diff --git a/website/content/sdk/reference/forecast/plot.md b/website/content/sdk/reference/forecast/plot.md new file mode 100644 index 000000000000..bbe2f2bc0706 --- /dev/null +++ b/website/content/sdk/reference/forecast/plot.md @@ -0,0 +1,86 @@ +--- +title: plot +description: Learn how to harness the power of OpenBB's financial forecasting functions + such as the plot and plot_chart to visualize data. These Python functions extract + dataframes and accept options for export format and external plot axes. +keywords: +- plot data visualization +- OpenBB finance +- forecast +- dataframe +- export format +- docusaurus tabs +- optional axes +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + +Plot data from a dataset + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/forecast/forecast_view.py#L74)] + +```python +openbb.forecast.plot(data: pd.DataFrame, columns: List[str], export: str = "", external_axes: Optional[List[axes]] = None) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| data | pd.DataFrame | The dataframe to plot | None | False | +| columns | List[str] | The columns to show | None | False | +| export | str | Format to export image | | True | +| external_axes | Optional[List[plt.axes]] | External axes to plot on | None | True | + + +--- + +## Returns + +This function does not return anything + +--- + + + + +Plot data from a dataset + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/forecast/forecast_view.py#L74)] + +```python +openbb.forecast.plot_chart(data: pd.DataFrame, columns: List[str], export: str = "", external_axes: Optional[List[axes]] = None) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| data | pd.DataFrame | The dataframe to plot | None | False | +| columns | List[str] | The columns to show | None | False | +| export | str | Format to export image | | True | +| external_axes | Optional[List[plt.axes]] | External axes to plot on | None | True | + + +--- + +## Returns + +This function does not return anything + +--- + + + diff --git a/website/content/sdk/reference/forecast/regr.md b/website/content/sdk/reference/forecast/regr.md new file mode 100644 index 000000000000..b78630671ebe --- /dev/null +++ b/website/content/sdk/reference/forecast/regr.md @@ -0,0 +1,113 @@ +--- +title: regr +description: 'The page covers two main aspects of the OpenBB finance platform: Regression + Forecasting and Displaying Regression Forecasting. It provides source codes, defines + parameters and returns related to the regression model and data. Users can find + additional features like forecasting horizon, historical forecasting, and prediction + capabilities. The option of view-chart allows users to visualise the data forecast.' +keywords: +- Regression Forecasting +- Source code +- OpenBB finance +- parameters +- returns +- charts +- perform analysis +- forecast horizon +- historical forecasting +- data series +- Regression Model +- mean average precision error +- RNN model +- Predictions +- Adjusted Data +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + +Perform Regression Forecasting + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/forecast/regr_model.py#L22)] + +```python +openbb.forecast.regr(data: Union[pd.Series, pd.DataFrame], target_column: str = "close", n_predict: int = 5, past_covariates: str = None, train_split: float = 0.85, forecast_horizon: int = 5, output_chunk_length: int = 1, lags: Union[int, List[int]] = 72) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| data | Union[pd.Series, pd.DataFrame] | Input Data | None | False | +| n_predict | int | Days to predict. Defaults to 5. | 5 | True | +| target_column | str | Target column to forecast. Defaults to "close". | close | True | +| train_split | float | Train/val split. Defaults to 0.85. | 0.85 | True | +| past_covariates | str | Multiple secondary columns to factor in when forecasting. Defaults to None. | None | True | +| forecast_horizon | int | Forecast horizon when performing historical forecasting. Defaults to 5. | 5 | True | +| output_chunk_length | int | The length of the forecast of the model. Defaults to 1. | 1 | True | +| lags | Union[int, List[int]] | lagged target values to predict the next time step | 72 | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| Tuple[List[TimeSeries], List[TimeSeries], List[TimeSeries], float, type[RegressionModel]] | Adjusted Data series,
Historical forecast by best RNN model,
list of Predictions,
Mean average precision error,
Best Regression Model. | +--- + + + + +Display Regression Forecasting + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/forecast/regr_view.py#L20)] + +```python +openbb.forecast.regr_chart(data: Union[pd.Series, pd.DataFrame], target_column: str = "close", dataset_name: str = "", n_predict: int = 5, past_covariates: str = None, train_split: float = 0.85, forecast_horizon: int = 5, output_chunk_length: int = 1, lags: Union[int, List[int]] = 72, export: str = "", residuals: bool = False, forecast_only: bool = False, start_date: Optional[datetime.datetime] = None, end_date: Optional[datetime.datetime] = None, naive: bool = False, explainability_raw: bool = False, export_pred_raw: bool = False, external_axes: Optional[List[axes]] = None) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| data | Union[pd.Series, pd.DataFrame] | Input Data | None | False | +| target_column | str | Target column to forecast. Defaults to "close". | close | True | +| dataset_name | str | The name of the ticker to be predicted | | True | +| n_predict | int | Days to predict. Defaults to 5. | 5 | True | +| train_split | float | Train/val split. Defaults to 0.85. | 0.85 | True | +| past_covariates | str | Multiple secondary columns to factor in when forecasting. Defaults to None. | None | True | +| forecast_horizon | int | Forecast horizon when performing historical forecasting. Defaults to 5. | 5 | True | +| output_chunk_length | int | The length of the forecast of the model. Defaults to 1. | 1 | True | +| lags | Union[int, List[int]] | lagged target values to predict the next time step | 72 | True | +| export | str | Format to export data | | True | +| residuals | bool | Whether to show residuals for the model. Defaults to False. | False | True | +| forecast_only | bool | Whether to only show dates in the forecasting range. Defaults to False. | False | True | +| start_date | Optional[datetime] | The starting date to perform analysis, data before this is trimmed. Defaults to None. | None | True | +| end_date | Optional[datetime] | The ending date to perform analysis, data after this is trimmed. Defaults to None. | None | True | +| naive | bool | Whether to show the naive baseline. This just assumes the closing price will be the same
as the previous day's closing price. Defaults to False. | False | True | +| external_axes | Optional[List[plt.axes]] | External axes to plot on | None | True | + + +--- + +## Returns + +This function does not return anything + +--- + + + diff --git a/website/content/sdk/reference/forecast/rename.md b/website/content/sdk/reference/forecast/rename.md new file mode 100644 index 000000000000..0994674b9a5c --- /dev/null +++ b/website/content/sdk/reference/forecast/rename.md @@ -0,0 +1,42 @@ +--- +title: rename +description: The rename function in openbb.forecast allows the renaming of a column + in a dataframe. Contains details on parameters, returns and a link to the source + code. +keywords: +- rename column +- dataframe +- openbb forecast +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Rename a column in a dataframe + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/forecast/forecast_model.py#L477)] + +```python +openbb.forecast.rename(data: pd.DataFrame, old_column: str, new_column: str) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| data | pd.DataFrame | The dataframe to have a column renamed | None | False | +| old_column | str | The column that will have its name changed | None | False | +| new_column | str | The name to update to | None | False | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | The dataframe with the renamed column | +--- diff --git a/website/content/sdk/reference/forecast/rnn.md b/website/content/sdk/reference/forecast/rnn.md new file mode 100644 index 000000000000..ee8e3766280e --- /dev/null +++ b/website/content/sdk/reference/forecast/rnn.md @@ -0,0 +1,118 @@ +--- +title: rnn +description: Learn about our Recurrent Neural Networks (RNN) forecasting models in + OpenBB Terminal's documentation. This includes instructions on how to perform RNN + forecasting, parameters used, returns and how to display an RNN forecast chart. +keywords: +- RNN +- forecasting +- training model +- Parameters +- Returns +- chart +- machine learning +- predict +- AI +- Neural networks +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + +Perform RNN forecasting + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/forecast/rnn_model.py#L21)] + +```python +openbb.forecast.rnn(data: Union[pd.Series, pd.DataFrame], target_column: str = "close", n_predict: int = 5, train_split: float = 0.85, forecast_horizon: int = 5, model_type: str = "LSTM", hidden_dim: int = 20, dropout: float = 0.0, batch_size: int = 16, n_epochs: int = 100, learning_rate: float = 0.001, model_save_name: str = "rnn_model", training_length: int = 20, input_chunk_size: int = 14, force_reset: bool = True, save_checkpoints: bool = True) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| data | Union[pd.Series, pd.DataFrame] | Input Data | None | False | +| n_predict | int | Days to predict. Defaults to 5. | 5 | True | +| target_column | str | Target column to forecast. Defaults to "close". | close | True | +| train_split | float | Train/val split. Defaults to 0.85. | 0.85 | True | +| forecast_horizon | int | Forecast horizon when performing historical forecasting. Defaults to 5. | 5 | True | +| model_type | str | Either a string specifying the RNN module type ("RNN", "LSTM" or "GRU"). Defaults to "LSTM". | LSTM | True | +| hidden_dim | int | Size for feature maps for each hidden RNN layer.. Defaults to 20. | 20 | True | +| dropout | float | Fraction of neurons affected by Dropout. Defaults to 0.0. | 0.0 | True | +| batch_size | int | Number of time series (input and output sequences) used in each training pass. Defaults to 32. | 16 | True | +| n_epochs | int | Number of epochs over which to train the model. Defaults to 100. | 100 | True | +| learning_rate | float | Defaults to 1e-3. | 0.001 | True | +| model_save_name | str | Name for model. Defaults to "brnn_model". | rnn_model | True | +| force_reset | bool | If set to True, any previously-existing model with the same name will be reset
(all checkpoints will be discarded). Defaults to True. | True | True | +| save_checkpoints | bool | Whether or not to automatically save the untrained model and checkpoints from training.
Defaults to True. | True | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| Tuple[List[TimeSeries], List[TimeSeries], List[TimeSeries], Optional[float], type[RNNModel]] | Adjusted Data series,
Historical forecast by best RNN model,
list of Predictions,
Mean average precision error,
Best RNN Model | +--- + + + + +Display RNN forecast + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/forecast/rnn_view.py#L20)] + +```python +openbb.forecast.rnn_chart(data: Union[pd.DataFrame, pd.Series], target_column: str = "close", dataset_name: str = "", n_predict: int = 5, train_split: float = 0.85, forecast_horizon: int = 5, model_type: str = "LSTM", hidden_dim: int = 20, dropout: float = 0.0, batch_size: int = 16, n_epochs: int = 100, learning_rate: float = 0.001, model_save_name: str = "rnn_model", training_length: int = 20, input_chunk_size: int = 14, force_reset: bool = True, save_checkpoints: bool = True, export: str = "", residuals: bool = False, forecast_only: bool = False, start_date: Optional[datetime.datetime] = None, end_date: Optional[datetime.datetime] = None, naive: bool = False, export_pred_raw: bool = False, external_axes: Optional[List[axes]] = None) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| data | Union[pd.Series, pd.DataFrame] | Input Data | None | False | +| dataset_name | str | The name of the ticker to be predicted | | True | +| n_predict | int | Days to predict. Defaults to 5. | 5 | True | +| target_column | str | Target column to forecast. Defaults to "close". | close | True | +| train_split | float | Train/val split. Defaults to 0.85. | 0.85 | True | +| forecast_horizon | int | Forecast horizon when performing historical forecasting. Defaults to 5. | 5 | True | +| model_type | str | Either a string specifying the RNN module type ("RNN", "LSTM" or "GRU"). Defaults to "LSTM". | LSTM | True | +| hidden_dim | int | Size for feature maps for each hidden RNN layer.. Defaults to 20. | 20 | True | +| dropout | float | Fraction of neurons affected by Dropout. Defaults to 0.0. | 0.0 | True | +| batch_size | int | Number of time series (input and output sequences) used in each training pass. Defaults to 32. | 16 | True | +| n_epochs | int | Number of epochs over which to train the model. Defaults to 100. | 100 | True | +| learning_rate | float | Defaults to 1e-3. | 0.001 | True | +| model_save_name | str | Name for model. Defaults to "brnn_model". | rnn_model | True | +| force_reset | bool | If set to True, any previously-existing model with the same name will be reset
(all checkpoints will be discarded). Defaults to True. | True | True | +| save_checkpoints | bool | Whether or not to automatically save the untrained model and checkpoints from training. Defaults to True. | True | True | +| forecast_only | bool | Whether to only show dates in the forecasting range. Defaults to False. | False | True | +| export | str | Format to export data | | True | +| residuals | bool | Whether to show residuals for the model. Defaults to False. | False | True | +| start_date | Optional[datetime] | The starting date to perform analysis, data before this is trimmed. Defaults to None. | None | True | +| end_date | Optional[datetime] | The ending date to perform analysis, data after this is trimmed. Defaults to None. | None | True | +| naive | bool | Whether to show the naive baseline. This just assumes the closing price will be the same
as the previous day's closing price. Defaults to False. | False | True | +| external_axes | Optional[List[plt.axes]] | External axes to plot on | None | True | + + +--- + +## Returns + +This function does not return anything + +--- + + + diff --git a/website/content/sdk/reference/forecast/roc.md b/website/content/sdk/reference/forecast/roc.md new file mode 100644 index 000000000000..07edb51b6e6d --- /dev/null +++ b/website/content/sdk/reference/forecast/roc.md @@ -0,0 +1,44 @@ +--- +title: roc +description: This documentation page provides information and implementation details + about the 'roc' (Rate of Change) function in OpenBB, used to calculate momentum + oscillations in a given dataset. +keywords: +- roc function +- Rate of Change +- openbb.forecast.roc +- momentum oscillation +- Forecasting +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +A momentum oscillator, which measures the percentage change between the current + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/forecast/forecast_model.py#L279)] + +```python +openbb.forecast.roc(dataset: pd.DataFrame, target_column: str = "close", period: int = 10) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| dataset | pd.DataFrame | The dataset you wish to calculate with | None | False | +| target_column | str | The column you wish to add the ROC to | close | True | +| period | int | Time Span | 10 | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | Dataframe with added ROC column | +--- diff --git a/website/content/sdk/reference/forecast/rsi.md b/website/content/sdk/reference/forecast/rsi.md new file mode 100644 index 000000000000..630761cecfc8 --- /dev/null +++ b/website/content/sdk/reference/forecast/rsi.md @@ -0,0 +1,48 @@ +--- +title: rsi +description: This document provides detailed information about the RSI (Relative Strength + Index) function in OpenBB.finance, including how to use this momentum indicator + to measure recent price changes. The function uses a Pandas DataFrame to calculate + the RSI and add it back to your dataset. The page also links to the function's source + code. +keywords: +- RSI +- momentum indicator +- price changes +- OpenBB.finance +- forecast +- Pandas DataFrame +- RSI calculation +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +A momentum indicator that measures the magnitude of recent price changes to evaluate + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/forecast/forecast_model.py#L237)] + +```python +openbb.forecast.rsi(dataset: pd.DataFrame, target_column: str = "close", period: int = 10) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| dataset | pd.DataFrame | The dataset you wish to calculate for | None | False | +| target_column | str | The column you wish to add the RSI to | close | True | +| period | int | Time Span | 10 | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | Dataframe with added RSI column | +--- diff --git a/website/content/sdk/reference/forecast/rwd.md b/website/content/sdk/reference/forecast/rwd.md new file mode 100644 index 000000000000..5fa7c86fbeb1 --- /dev/null +++ b/website/content/sdk/reference/forecast/rwd.md @@ -0,0 +1,107 @@ +--- +title: rwd +description: This page represents the functions for Random Walk with Drift (RWD) forecasting + including the model and chart view. It provides parameters, their types, descriptions, + and default settings, and explains the purpose and results of each function. +keywords: +- rwd +- Random Walk with Drift forecasting +- forecasting model +- parameter description +- OpenBB-finance +- model object +- rwd view +- chart display +- data series +- fcast values +- predict +- start window +- forecast horizon +- export +- residuals +- forecast only +- naive +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + +Performs Random Walk with Drift forecasting + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/forecast/rwd_model.py#L27)] + +```python +openbb.forecast.rwd(data: Union[pd.Series, pd.DataFrame], target_column: str = "close", n_predict: int = 5, start_window: float = 0.85, forecast_horizon: int = 5) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| data | Union[pd.Series, np.ndarray] | Input data. | None | False | +| target_column | Optional[str]: | Target column to forecast. Defaults to "close". | close | True | +| n_predict | int | Number of days to forecast | 5 | True | +| start_window | float | Size of sliding window from start of timeseries and onwards | 0.85 | True | +| forecast_horizon | int | Number of days to forecast when backtesting and retraining historical | 5 | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| | Adjusted Data series,
List of historical fcast values,
List of predicted fcast values,
Optional[float] precision,
Fit RWD model object. | +--- + + + + +Display Random Walk with Drift Model + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/forecast/rwd_view.py#L20)] + +```python +openbb.forecast.rwd_chart(data: Union[pd.DataFrame, pd.Series], target_column: str = "close", dataset_name: str = "", n_predict: int = 5, start_window: float = 0.85, forecast_horizon: int = 5, export: str = "", residuals: bool = False, forecast_only: bool = False, start_date: Optional[datetime.datetime] = None, end_date: Optional[datetime.datetime] = None, naive: bool = False, export_pred_raw: bool = False, external_axes: Optional[List[axes]] = None) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| data | Union[pd.Series, np.array] | Data to forecast | None | False | +| dataset_name str | None | The name of the ticker to be predicted | None | True | +| target_column | Optional[str]: | Target column to forecast. Defaults to "close". | close | True | +| n_predict | int | Number of days to forecast | 5 | True | +| start_window | float | Size of sliding window from start of timeseries and onwards | 0.85 | True | +| forecast_horizon | int | Number of days to forecast when backtesting and retraining historical | 5 | True | +| export | str | Format to export data | | True | +| residuals | bool | Whether to show residuals for the model. Defaults to False. | False | True | +| forecast_only | bool | Whether to only show dates in the forecasting range. Defaults to False. | False | True | +| start_date | Optional[datetime] | The starting date to perform analysis, data before this is trimmed. Defaults to None. | None | True | +| end_date | Optional[datetime] | The ending date to perform analysis, data after this is trimmed. Defaults to None. | None | True | +| naive | bool | Whether to show the naive baseline. This just assumes the closing price will be the same
as the previous day's closing price. Defaults to False. | False | True | +| external_axes | Optional[List[plt.axes]] | External axes to plot on | None | True | + + +--- + +## Returns + +This function does not return anything + +--- + + + diff --git a/website/content/sdk/reference/forecast/season.md b/website/content/sdk/reference/forecast/season.md new file mode 100644 index 000000000000..4d5c4ddbbec6 --- /dev/null +++ b/website/content/sdk/reference/forecast/season.md @@ -0,0 +1,50 @@ +--- +title: season +description: The page provides details on the 'openbb.forecast.season_chart' function. + This function is used to plot seasonality from a dataset. It includes information + about the parameters, the return value, and a link to the source code. +keywords: +- openbb.forecast.season_chart +- season chart +- plot seasonality +- dataset +- dataframe +- time lag +- max lag +- confidence interval +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Plot seasonality from a dataset + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/forecast/forecast_view.py#L120)] + +```python +openbb.forecast.season_chart(data: pd.DataFrame, column: str = "close", export: str = "", m: Optional[int] = None, max_lag: int = 24, alpha: float = 0.05, external_axes: Optional[List[axes]] = None) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| data | pd.DataFrame | The dataframe to plot | None | False | +| column | str | The column of the dataframe to analyze | close | True | +| export | str | Format to export image | | True | +| m | Optional[int] | Optionally, a time lag to highlight on the plot. Default is none. | None | True | +| max_lag | int | The maximal lag order to consider. Default is 24. | 24 | True | +| alpha | float | The confidence interval to display. Default is 0.05. | 0.05 | True | +| external_axes | Optional[List[plt.axes]] | External axes to plot on | None | True | + + +--- + +## Returns + +This function does not return anything + +--- diff --git a/website/content/sdk/reference/forecast/seasonalnaive.md b/website/content/sdk/reference/forecast/seasonalnaive.md new file mode 100644 index 000000000000..8e5fa809f6bb --- /dev/null +++ b/website/content/sdk/reference/forecast/seasonalnaive.md @@ -0,0 +1,107 @@ +--- +title: seasonalnaive +description: The Seasonal Naive forecasting page provides thorough documentation for + using and interpreting the results of the Seasonal Naive model and the Seasonal + Naive chart. It includes details on parameters, returns, and source code locations. + The page is enriched with appropriate examples aiding in easy understanding and + implementation of the functionalities. +keywords: +- Seasonal Naive forecasting +- Source Code +- forecast.seasonalnaive +- forecast.seasonalnaive_chart +- Parameters +- Returns +- data series +- forecast values +- precision +- Display SeasonalNaive Model +- residuals +- forecast only +- naive +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + +Performs Seasonal Naive forecasting + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/forecast/seasonalnaive_model.py#L28)] + +```python +openbb.forecast.seasonalnaive(data: Union[pd.Series, pd.DataFrame], target_column: str = "close", seasonal_periods: int = 7, n_predict: int = 5, start_window: float = 0.85, forecast_horizon: int = 5) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| data | Union[pd.Series, np.ndarray] | Input data. | None | False | +| target_column | Optional[str]: | Target column to forecast. Defaults to "close". | close | True | +| seasonal_periods | int | Number of seasonal periods in a year (7 for daily data)
If not set, inferred from frequency of the series. | 7 | True | +| n_predict | int | Number of days to forecast | 5 | True | +| start_window | float | Size of sliding window from start of timeseries and onwards | 0.85 | True | +| forecast_horizon | int | Number of days to forecast when backtesting and retraining historical | 5 | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| Tuple[List[TimeSeries], List[TimeSeries], List[TimeSeries], Optional[float], StatsForecast] | Adjusted Data series,
List of historical fcast values,
List of predicted fcast values,
Optional[float] - precision,
Fit SeasonalNaive model object. | +--- + + + + +Display SeasonalNaive Model + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/forecast/seasonalnaive_view.py#L20)] + +```python +openbb.forecast.seasonalnaive_chart(data: Union[pd.DataFrame, pd.Series], target_column: str = "close", dataset_name: str = "", seasonal_periods: int = 7, n_predict: int = 5, start_window: float = 0.85, forecast_horizon: int = 5, export: str = "", residuals: bool = False, forecast_only: bool = False, start_date: Optional[datetime.datetime] = None, end_date: Optional[datetime.datetime] = None, naive: bool = False, export_pred_raw: bool = False, external_axes: Optional[List[axes]] = None) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| data | Union[pd.Series, np.array] | Data to forecast | None | False | +| dataset_name str | None | The name of the ticker to be predicted | None | True | +| target_column | Optional[str]: | Target column to forecast. Defaults to "close". | close | True | +| seasonal_periods | int | Number of seasonal periods in a year
If not set, inferred from frequency of the series. | 7 | True | +| n_predict | int | Number of days to forecast | 5 | True | +| start_window | float | Size of sliding window from start of timeseries and onwards | 0.85 | True | +| forecast_horizon | int | Number of days to forecast when backtesting and retraining historical | 5 | True | +| export | str | Format to export data | | True | +| residuals | bool | Whether to show residuals for the model. Defaults to False. | False | True | +| forecast_only | bool | Whether to only show dates in the forecasting range. Defaults to False. | False | True | +| start_date | Optional[datetime] | The starting date to perform analysis, data before this is trimmed. Defaults to None. | None | True | +| end_date | Optional[datetime] | The ending date to perform analysis, data after this is trimmed. Defaults to None. | None | True | +| naive | bool | Whether to show the naive baseline. This just assumes the closing price will be the same
as the previous day's closing price. Defaults to False. | False | True | +| external_axes | Optional[List[plt.axes]] | External axes to plot on | None | True | + + +--- + +## Returns + +This function does not return anything + +--- + + + diff --git a/website/content/sdk/reference/forecast/show.md b/website/content/sdk/reference/forecast/show.md new file mode 100644 index 000000000000..4e2efdcfab89 --- /dev/null +++ b/website/content/sdk/reference/forecast/show.md @@ -0,0 +1,73 @@ +--- +title: show +description: Detailed documentation of OpenBB finance's 'show' and 'show_chart' functions. + Learn how to effectively use these functions in your data analysis with clear instructions + and direct source code links. +keywords: +- OpenBB finance +- Documentation +- Programming +- show function +- show_chart function +- Source Code +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + +None + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/forecast/forecast_view.py#L227)] + +```python +openbb.forecast.show(data: pd.DataFrame, limit: int = 15, limit_col: int = 10, name: str = "", export: str = "") +``` + +--- + +## Parameters + +This function does not take any parameters. + +--- + +## Returns + +This function does not return anything + +--- + + + + +None + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/forecast/forecast_view.py#L227)] + +```python +openbb.forecast.show_chart(data: pd.DataFrame, limit: int = 15, limit_col: int = 10, name: str = "", export: str = "") +``` + +--- + +## Parameters + +This function does not take any parameters. + +--- + +## Returns + +This function does not return anything + +--- + + + diff --git a/website/content/sdk/reference/forecast/signal.md b/website/content/sdk/reference/forecast/signal.md new file mode 100644 index 000000000000..44ff9d0f1774 --- /dev/null +++ b/website/content/sdk/reference/forecast/signal.md @@ -0,0 +1,45 @@ +--- +title: signal +description: This documentation page provides detailed insight on 'signal', a price + signal based on short/long term price, with instructions on parameters to be entered + and returns received. +keywords: +- price signal +- short/long term price +- openbb.forecast.signal +- parameters +- returns +- dataframe +- signal column +- dataset +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +A price signal based on short/long term price. + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/forecast/forecast_model.py#L374)] + +```python +openbb.forecast.signal(dataset: pd.DataFrame, target_column: str = "close") +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| dataset | pd.DataFrame | The dataset you wish to calculate with | None | False | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | Dataframe with added signal column | +--- diff --git a/website/content/sdk/reference/forecast/sto.md b/website/content/sdk/reference/forecast/sto.md new file mode 100644 index 000000000000..7a9448004132 --- /dev/null +++ b/website/content/sdk/reference/forecast/sto.md @@ -0,0 +1,44 @@ +--- +title: sto +description: Page about the Stochastic Oscillator (STO) function in the OpenBB library. + It includes information about calculating momentum indicators, source code, parameters, + and what it returns. +keywords: +- sto +- stochastic oscillator +- momentum indicator +- forecasting +- k & d columns +- dataset +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Stochastic Oscillator %K and %D : A stochastic oscillator is a momentum indicator comparing a particular closing + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/forecast/forecast_model.py#L187)] + +```python +openbb.forecast.sto(dataset: pd.DataFrame, close_column: str = "close", high_column: str = "high", low_column: str = "low", period: int = 10) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| dataset | pd.DataFrame | The dataset you wish to calculate for | None | False | +| period | int | Span | 10 | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | Dataframe with added STO K & D columns | +--- diff --git a/website/content/sdk/reference/forecast/tcn.md b/website/content/sdk/reference/forecast/tcn.md new file mode 100644 index 000000000000..10c60d164b3b --- /dev/null +++ b/website/content/sdk/reference/forecast/tcn.md @@ -0,0 +1,125 @@ +--- +title: tcn +description: This documentation page provides information on how to use the 'tcn' + functionality of OpenBBTerminal. This enables you to perform Temporal Convolutional + Network (TCN) forecasting and display the forecast using OpenBB Platform's resources. +keywords: +- Temporal Convolutional Network +- TCN forecasting +- OpenBB platform +- tcn_model.py +- tcn_view.py +- time series prediction +- Forecast visualization +- Source code +- Predictive analytics +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + +Perform TCN forecasting + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/forecast/tcn_model.py#L20)] + +```python +openbb.forecast.tcn(data: Union[pd.Series, pd.DataFrame], target_column: str = "close", n_predict: int = 5, past_covariates: str = None, train_split: float = 0.85, forecast_horizon: int = 5, input_chunk_length: int = 14, output_chunk_length: int = 5, dropout: float = 0.1, num_filters: int = 6, weight_norm: bool = True, dilation_base: int = 2, n_epochs: int = 100, learning_rate: float = 0.001, batch_size: int = 800, model_save_name: str = "tcn_model", force_reset: bool = True, save_checkpoints: bool = True) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| data | Union[pd.Series, pd.DataFrame] | Input Data | None | False | +| target_column | str | Target column to forecast. Defaults to "close". | close | True | +| n_predict | int | Days to predict. Defaults to 5. | 5 | True | +| train_split | float | Train/val split. Defaults to 0.85. | 0.85 | True | +| past_covariates | str | Multiple secondary columns to factor in when forecasting. Defaults to None. | None | True | +| forecast_horizon | int | Forecast horizon when performing historical forecasting. Defaults to 5. | 5 | True | +| input_chunk_length | int | Number of past time steps that are fed to the forecasting module at prediction time. Defaults to 14. | 14 | True | +| output_chunk_length | int | The length of the forecast of the model. Defaults to 5. | 5 | True | +| dropout | float | Fraction of neurons affected by Dropout. Defaults to 0.1. | 0.1 | True | +| num_filters | int | The number of filters in a convolutional layer of the TCN. Defaults to 6. | 6 | True | +| weight_norm | bool | Boolean value indicating whether to use weight normalization. Defaults to True. | True | True | +| dilation_base | int | The base of the exponent that will determine the dilation on every level. Defaults to 2. | 2 | True | +| batch_size | int | Number of time series (input and output sequences) used in each training pass. Defaults to 32. | 800 | True | +| n_epochs | int | Number of epochs over which to train the model. Defaults to 100. | 100 | True | +| learning_rate | float | Defaults to 1e-3. | 0.001 | True | +| model_save_name | str | Name for model. Defaults to "brnn_model". | tcn_model | True | +| force_reset | bool | If set to True, any previously-existing model with the same name will be reset
(all checkpoints will be discarded). Defaults to True. | True | True | +| save_checkpoints | bool | Whether or not to automatically save the untrained model and checkpoints from training.
Defaults to True. | True | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| Tuple[List[TimeSeries], List[TimeSeries], List[TimeSeries], Optional[float], type[TCNModel]] | Adjusted Data series,
Historical forecast by best RNN model,
list of Predictions,
Mean average precision error,
Best TCN Model. | +--- + + + + +Display TCN forecast + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/forecast/tcn_view.py#L20)] + +```python +openbb.forecast.tcn_chart(data: Union[pd.DataFrame, pd.Series], target_column: str = "close", dataset_name: str = "", n_predict: int = 5, past_covariates: str = None, train_split: float = 0.85, forecast_horizon: int = 5, input_chunk_length: int = 14, output_chunk_length: int = 5, dropout: float = 0.1, num_filters: int = 6, weight_norm: bool = True, dilation_base: int = 2, n_epochs: int = 100, learning_rate: float = 0.001, batch_size: int = 800, model_save_name: str = "tcn_model", force_reset: bool = True, save_checkpoints: bool = True, export: str = "", residuals: bool = False, forecast_only: bool = False, start_date: Optional[datetime.datetime] = None, end_date: Optional[datetime.datetime] = None, naive: bool = False, export_pred_raw: bool = False, external_axes: Optional[List[axes]] = None) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| data | Union[pd.Series, pd.DataFrame] | Input Data | None | False | +| target_column | str | Target column to forecast. Defaults to "close". | close | True | +| dataset_name | str | The name of the ticker to be predicted | | True | +| n_predict | int | Days to predict. Defaults to 5. | 5 | True | +| train_split | float | Train/val split. Defaults to 0.85. | 0.85 | True | +| past_covariates | str | Multiple secondary columns to factor in when forecasting. Defaults to None. | None | True | +| forecast_horizon | int | Forecast horizon when performing historical forecasting. Defaults to 5. | 5 | True | +| input_chunk_length | int | Number of past time steps that are fed to the forecasting module at prediction time. Defaults to 14. | 14 | True | +| output_chunk_length | int | The length of the forecast of the model. Defaults to 5. | 5 | True | +| dropout | float | Fraction of neurons affected by Dropout. Defaults to 0.1. | 0.1 | True | +| num_filters | int | The number of filters in a convolutional layer of the TCN. Defaults to 6. | 6 | True | +| weight_norm | bool | Boolean value indicating whether to use weight normalization. Defaults to True. | True | True | +| dilation_base | int | The base of the exponent that will determine the dilation on every level. Defaults to 2. | 2 | True | +| batch_size | int | Number of time series (input and output sequences) used in each training pass. Defaults to 32. | 800 | True | +| n_epochs | int | Number of epochs over which to train the model. Defaults to 100. | 100 | True | +| learning_rate | float | Defaults to 1e-3. | 0.001 | True | +| model_save_name | str | Name for model. Defaults to "brnn_model". | tcn_model | True | +| force_reset | bool | If set to True, any previously-existing model with the same name will be reset
(all checkpoints will be discarded). Defaults to True. | True | True | +| save_checkpoints | bool | Whether or not to automatically save the untrained model and checkpoints from training. Defaults to True. | True | True | +| export | str | Format to export data | | True | +| residuals | bool | Whether to show residuals for the model. Defaults to False. | False | True | +| forecast_only | bool | Whether to only show dates in the forecasting range. Defaults to False. | False | True | +| start_date | Optional[datetime] | The starting date to perform analysis, data before this is trimmed. Defaults to None. | None | True | +| end_date | Optional[datetime] | The ending date to perform analysis, data after this is trimmed. Defaults to None. | None | True | +| naive | bool | Whether to show the naive baseline. This just assumes the closing price will be the same
as the previous day's closing price. Defaults to False. | False | True | +| external_axes | Optional[List[plt.axes]] | External axes to plot on | None | True | + + +--- + +## Returns + +This function does not return anything + +--- + + + diff --git a/website/content/sdk/reference/forecast/tft.md b/website/content/sdk/reference/forecast/tft.md new file mode 100644 index 000000000000..5cb8f969523d --- /dev/null +++ b/website/content/sdk/reference/forecast/tft.md @@ -0,0 +1,128 @@ +--- +title: tft +description: This Docusaurus page provides in-depth information on the use of Temporal + Fusion Transformer for forecasting purposes, as implemented through OpenBB finance. + It includes details on the model's parameters, usage, and output, along with the + source code and chart visualization capabilities. The page is of high relevance + for developers, data analysts, and professionals dealing with predictive modeling + and data analysis tasks. +keywords: +- Temporal Fusion Transformer forecasting +- OpenBB finance +- Temporal Fusion Transformer chart +- Machine Learning +- Data analysis +- Predictive modeling +- Predictive analytics +- Data modeling +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + +Performs Temporal Fusion Transformer forecasting + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/forecast/tft_model.py#L26)] + +```python +openbb.forecast.tft(data: Union[pd.Series, pd.DataFrame], target_column: str = "close", n_predict: int = 5, past_covariates: str = None, train_split: float = 0.85, forecast_horizon: int = 5, input_chunk_length: int = 14, output_chunk_length: int = 5, hidden_size: int = 16, lstm_layers: int = 1, num_attention_heads: int = 4, full_attention: bool = False, dropout: float = 0.1, hidden_continuous_size: int = 8, n_epochs: int = 200, batch_size: int = 32, model_save_name: str = "tft_model", force_reset: bool = True, save_checkpoints: bool = True) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| data (Union[pd.Series, pd.DataFrame]) | | Input Data | None | True | +| target_column | Optional[str]: | Target column to forecast. Defaults to "close". | close | True | +| n_predict (int, optional) | | Days to predict. Defaults to 5. | None | True | +| train_split (float, optional) | | Train/val split. Defaults to 0.85. | None | True | +| past_covariates (str, optional) | | Multiple secondary columns to factor in when forecasting. Defaults to None. | None | True | +| forecast_horizon (int, optional) | | Forecast horizon when performing historical forecasting. Defaults to 5. | None | True | +| input_chunk_length (int, optional) | | Number of past time steps that are fed to the forecasting module at prediction time.
Defaults to 14. | None | True | +| output_chunk_length (int, optional) | | The length of the forecast of the model. Defaults to 5. | None | True | +| hidden_size (int, optional) | | Hidden state size of the TFT. Defaults to 16. | None | True | +| lstm_layers (int, optional) | | Number of layers for the Long Short Term Memory Encoder and Decoder. Defaults to 16. | None | True | +| num_attention_headers (int, optional) | | Number of attention heads. Defaults to 4. | None | True | +| full_attention (bool, optional) | | Whether to apply a multi-head attention query. Defaults to False> | None | True | +| dropout (float, optional) | | Fraction of neurons affected by dropout. Defaults to 0.1. | None | True | +| hidden_continuous_size (int, optional) | | Default hidden size for processing continuous variables. Defaults to 8. | None | True | +| n_epochs (int, optional) | | Number of epochs to run during training. Defaults to 200. | None | True | +| batch_size (int, optional) | | Number of samples to pass through network during a single epoch. Defaults to 32. | None | True | +| model_save_name (str, optional) | | The name for the model. Defaults to tft_model | None | True | +| force_reset (bool, optional) | | If set to True, any previously-existing model with the same name will be reset
(all checkpoints will be discarded). Defaults to True. | None | True | +| save_checkpoints (bool, optional) | | Whether or not to automatically save the untrained model and checkpoints from training.
Defaults to True. | None | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| | Adjusted Data series,
List of historical fcast values,
List of predicted fcast values,
Optional[float] - precision,
Fit Prob. TFT model object. | +--- + + + + +Display Temporal Fusion Transformer forecast + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/forecast/tft_view.py#L20)] + +```python +openbb.forecast.tft_chart(data: Union[pd.Series, pd.DataFrame], target_column: str = "close", dataset_name: str = "", n_predict: int = 5, past_covariates: str = None, train_split: float = 0.85, forecast_horizon: int = 5, input_chunk_length: int = 14, output_chunk_length: int = 5, hidden_size: int = 16, lstm_layers: int = 1, num_attention_heads: int = 4, full_attention: bool = False, dropout: float = 0.1, hidden_continuous_size: int = 8, n_epochs: int = 200, batch_size: int = 32, model_save_name: str = "tft_model", force_reset: bool = True, save_checkpoints: bool = True, export: str = "", residuals: bool = False, forecast_only: bool = False, start_date: Optional[datetime.datetime] = None, end_date: Optional[datetime.datetime] = None, naive: bool = False, export_pred_raw: bool = False, external_axes: Optional[List[axes]] = None) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| data (Union[pd.Series, pd.DataFrame]) | | Input Data | None | True | +| target_column | Optional[str]: | Target column to forecast. Defaults to "close". | close | True | +| dataset_name str | None | The name of the ticker to be predicted | None | True | +| n_predict (int, optional) | | Days to predict. Defaults to 5. | None | True | +| train_split (float, optional) | | Train/val split. Defaults to 0.85. | None | True | +| past_covariates (str, optional) | | Multiple secondary columns to factor in when forecasting. Defaults to None. | None | True | +| forecast_horizon (int, optional) | | Forecast horizon when performing historical forecasting. Defaults to 5. | None | True | +| input_chunk_length (int, optional) | | Number of past time steps that are fed to the forecasting module at prediction time.
Defaults to 14. | None | True | +| output_chunk_length (int, optional) | | The length of the forecast of the model. Defaults to 5. | None | True | +| hidden_size (int, optional) | | Hidden state size of the TFT. Defaults to 16. | None | True | +| lstm_layers (int, optional) | | Number of layers for the Long Short Term Memory Encoder and Decoder. Defaults to 16. | None | True | +| num_attention_headers (int, optional) | | Number of attention heads. Defaults to 4. | None | True | +| full_attention (bool, optional) | | Whether to apply a multi-head attention query. Defaults to False> | None | True | +| dropout (float, optional) | | Fraction of neurons affected by dropout. Defaults to 0.1. | None | True | +| hidden_continuous_size (int, optional) | | Default hidden size for processing continuous variables. Defaults to 8. | None | True | +| n_epochs (int, optional) | | Number of epochs to run during training. Defaults to 200. | None | True | +| batch_size (int, optional) | | Number of samples to pass through network during a single epoch. Defaults to 32. | None | True | +| model_save_name (str, optional) | | The name for the model. Defaults to tft_model | None | True | +| force_reset (bool, optional) | | If set to True, any previously-existing model with the same name will be reset
(all checkpoints will be discarded). Defaults to True. | None | True | +| save_checkpoints (bool, optional) | | Whether or not to automatically save the untrained model and checkpoints from training.
Defaults to True. | None | True | +| residuals | bool | Whether to show residuals for the model. Defaults to False. | False | True | +| forecast_only | bool | Whether to only show dates in the forecasting range. Defaults to False. | False | True | +| start_date | Optional[datetime] | The starting date to perform analysis, data before this is trimmed. Defaults to None. | None | True | +| end_date | Optional[datetime] | The ending date to perform analysis, data after this is trimmed. Defaults to None. | None | True | +| naive | bool | Whether to show the naive baseline. This just assumes the closing price will be the same
as the previous day's closing price. Defaults to False. | False | True | +| external_axes | Optional[List[plt.axes]] | External axes to plot on | None | True | + + +--- + +## Returns + +This function does not return anything + +--- + + + diff --git a/website/content/sdk/reference/forecast/theta.md b/website/content/sdk/reference/forecast/theta.md new file mode 100644 index 000000000000..10c921c6bbe7 --- /dev/null +++ b/website/content/sdk/reference/forecast/theta.md @@ -0,0 +1,101 @@ +--- +title: theta +description: This page provides detailed information on how to use the 'Theta' model + and 'Theta' chart for financial forecasting with OpenBB. It explains various parameters + for accurate prediction and chart display, alongside respective source code examples. +keywords: +- Theta model +- Theta chart +- Forecasting +- Financial prediction +- Source code +- Model parameters +- Chart display +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + +Performs Theta forecasting + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/forecast/theta_model.py#L29)] + +```python +openbb.forecast.theta(data: Union[pd.Series, pd.DataFrame], target_column: str = "close", seasonal: str = "M", seasonal_periods: int = 7, n_predict: int = 5, start_window: float = 0.85, forecast_horizon: int = 5) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| data | Union[pd.Series, np.ndarray] | Input data. | None | False | +| target_column | Optional[str]: | Target column to forecast. Defaults to "close". | close | True | +| seasonal | str | Seasonal component. One of [N, A, M]
Defaults to MULTIPLICATIVE. | M | True | +| seasonal_periods | int | Number of seasonal periods in a year
If not set, inferred from frequency of the series. | 7 | True | +| n_predict | int | Number of days to forecast | 5 | True | +| start_window | float | Size of sliding window from start of timeseries and onwards | 0.85 | True | +| forecast_horizon | int | Number of days to forecast when backtesting and retraining historical | 5 | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| Tuple[List[TimeSeries], List[TimeSeries], List[TimeSeries], float, float, type[Theta]] | Adjusted Data series,
Historical forecast by best theta,
list of Predictions,
Mean average precision error,
Best Theta,
Theta Model. | +--- + + + + +Display Theta forecast + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/forecast/theta_view.py#L21)] + +```python +openbb.forecast.theta_chart(data: Union[pd.DataFrame, pd.Series], target_column: str = "close", dataset_name: str = "", seasonal: str = "M", seasonal_periods: int = 7, n_predict: int = 5, start_window: float = 0.85, forecast_horizon: int = 5, export: str = "", residuals: bool = False, forecast_only: bool = False, start_date: Optional[datetime.datetime] = None, end_date: Optional[datetime.datetime] = None, naive: bool = False, export_pred_raw: bool = False, external_axes: Optional[List[axes]] = None) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| data | Union[pd.Series, np.array] | Data to forecast | None | False | +| target_column | Optional[str]: | Target column to forecast. Defaults to "close". | close | True | +| dataset_name str | None | The name of the ticker to be predicted | None | True | +| seasonal | str | Seasonal component. One of [N, A, M]
Defaults to MULTIPLICATIVE. | M | True | +| seasonal_periods | int | Number of seasonal periods in a year
If not set, inferred from frequency of the series. | 7 | True | +| n_predict | int | Number of days to forecast | 5 | True | +| start_window | float | Size of sliding window from start of timeseries and onwards | 0.85 | True | +| forecast_horizon | int | Number of days to forecast when backtesting and retraining historical | 5 | True | +| export | str | Format to export data | | True | +| residuals | bool | Whether to show residuals for the model. Defaults to False. | False | True | +| forecast_only | bool | Whether to only show dates in the forecasting range. Defaults to False. | False | True | +| start_date | Optional[datetime] | The starting date to perform analysis, data before this is trimmed. Defaults to None. | None | True | +| end_date | Optional[datetime] | The ending date to perform analysis, data after this is trimmed. Defaults to None. | None | True | +| naive | bool | Whether to show the naive baseline. This just assumes the closing price will be the same
as the previous day's closing price. Defaults to False. | False | True | +| external_axes | Optional[List[plt.axes]] | External axes to plot on | None | True | + + +--- + +## Returns + +This function does not return anything + +--- + + + diff --git a/website/content/sdk/reference/forecast/trans.md b/website/content/sdk/reference/forecast/trans.md new file mode 100644 index 000000000000..b743ec9975e7 --- /dev/null +++ b/website/content/sdk/reference/forecast/trans.md @@ -0,0 +1,134 @@ +--- +title: trans +description: This section emphasizes on Transformer forecasting method implementation + and visualization used in OpenBB Terminal. It explains functions like how to apply + the approach on data, various parameters to adjust for better forecasting and display + the results in chart. +keywords: +- Transformer Forecasting +- Time-Series Prediction +- Forecasting Parameters +- Data Visualization +- pandas series +- pandas dataframe +- Machine Learning +- Activation Function +- Multi-head Attention Mechanism +- Encoder layers +- Decoder layers +- Feedforward Network +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + +Performs Transformer forecasting + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/forecast/trans_model.py#L20)] + +```python +openbb.forecast.trans(data: Union[pd.Series, pd.DataFrame], target_column: str = "close", n_predict: int = 5, train_split: float = 0.85, past_covariates: str = None, forecast_horizon: int = 5, input_chunk_length: int = 14, output_chunk_length: int = 5, d_model: int = 64, nhead: int = 4, num_encoder_layers: int = 3, num_decoder_layers: int = 3, dim_feedforward: int = 512, activation: str = "relu", dropout: float = 0.0, batch_size: int = 32, n_epochs: int = 100, learning_rate: float = 0.001, model_save_name: str = "trans_model", force_reset: bool = True, save_checkpoints: bool = True) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| data | Union[pd.Series, pd.DataFrame] | Input Data | None | False | +| n_predict | int | Days to predict. Defaults to 5. | 5 | True | +| target_column | str | Target column to forecast. Defaults to "close". | close | True | +| train_split | float | Train/val split. Defaults to 0.85. | 0.85 | True | +| past_covariates | str | Multiple secondary columns to factor in when forecasting. Defaults to None. | None | True | +| forecast_horizon | int | Forecast horizon when performing historical forecasting. Defaults to 5. | 5 | True | +| input_chunk_length | int | Number of past time steps that are fed to the forecasting module at prediction time. Defaults to 14. | 14 | True | +| output_chunk_length | int | The length of the forecast of the model. Defaults to 5. | 5 | True | +| d_model | int | The number of expected features in the encoder/decoder inputs. Defaults to 64. | 64 | True | +| nhead | int | The number of heads in the multi-head attention mechanism. Defaults to 4. | 4 | True | +| num_encoder_layers | int | The number of encoder layers in the encoder. Defaults to 3. | 3 | True | +| num_decoder_layers | int | The number of decoder layers in the encoder. Defaults to 3. | 3 | True | +| dim_feedforward | int | The dimension of the feedforward network model. Defaults to 512. | 512 | True | +| activation | str | The activation function of encoder/decoder intermediate layer, ‘relu’ or ‘gelu’. Defaults to 'relu'. | relu | True | +| dropout | float | Fraction of neurons affected by Dropout. Defaults to 0.0. | 0.0 | True | +| batch_size | int | Number of time series (input and output sequences) used in each training pass. Defaults to 32. | 32 | True | +| n_epochs | int | Number of epochs over which to train the model. Defaults to 100. | 100 | True | +| learning_rate | float | Defaults to 1e-3. | 0.001 | True | +| model_save_name | str | Name for model. Defaults to "brnn_model". | trans_model | True | +| force_reset | bool | If set to True, any previously-existing model with the same name will be reset (all checkpoints will be
discarded). Defaults to True. | True | True | +| save_checkpoints | bool | Whether or not to automatically save the untrained model and checkpoints from training. Defaults to True. | True | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| Tuple[List[TimeSeries], List[TimeSeries], List[TimeSeries], Optional[float], type[TransformerModel]] | Adjusted Data series,
Historical forecast by best RNN model,
list of Predictions,
Mean average precision error,
Best transformer Model. | +--- + + + + +Display Transformer forecast + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/forecast/trans_view.py#L20)] + +```python +openbb.forecast.trans_chart(data: Union[pd.Series, pd.DataFrame], target_column: str = "close", dataset_name: str = "", n_predict: int = 5, past_covariates: str = None, train_split: float = 0.85, forecast_horizon: int = 5, input_chunk_length: int = 14, output_chunk_length: int = 5, d_model: int = 64, nhead: int = 4, num_encoder_layers: int = 3, num_decoder_layers: int = 3, dim_feedforward: int = 512, activation: str = "relu", dropout: float = 0.1, batch_size: int = 16, n_epochs: int = 100, learning_rate: float = 0.001, model_save_name: str = "trans_model", force_reset: bool = True, save_checkpoints: bool = True, export: str = "", residuals: bool = False, forecast_only: bool = False, start_date: Optional[datetime.datetime] = None, end_date: Optional[datetime.datetime] = None, naive: bool = False, export_pred_raw: bool = False, external_axes: Optional[List[axes]] = None) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| data | Union[pd.Series, pd.DataFrame] | Input Data | None | False | +| dataset_name | str | The name of the ticker to be predicted | | True | +| n_predict | int | Days to predict. Defaults to 5. | 5 | True | +| target_column | str | Target column to forecast. Defaults to "close". | close | True | +| train_split | float | Train/val split. Defaults to 0.85. | 0.85 | True | +| past_covariates | str | Multiple secondary columns to factor in when forecasting. Defaults to None. | None | True | +| forecast_horizon | int | Forecast horizon when performing historical forecasting. Defaults to 5. | 5 | True | +| input_chunk_length | int | Number of past time steps that are fed to the forecasting module at prediction time. Defaults to 14. | 14 | True | +| output_chunk_length | int | The length of the forecast of the model. Defaults to 5. | 5 | True | +| d_model | int | The number of expected features in the encoder/decoder inputs. Defaults to 64. | 64 | True | +| nhead | int | The number of heads in the multi-head attention mechanism. Defaults to 4. | 4 | True | +| num_encoder_layers | int | The number of encoder layers in the encoder. Defaults to 3. | 3 | True | +| num_decoder_layers | int | The number of decoder layers in the encoder. Defaults to 3. | 3 | True | +| dim_feedforward | int | The dimension of the feedforward network model. Defaults to 512. | 512 | True | +| activation | str | The activation function of encoder/decoder intermediate layer, ‘relu’ or ‘gelu’. Defaults to 'relu'. | relu | True | +| dropout | float | Fraction of neurons affected by Dropout. Defaults to 0.1. | 0.1 | True | +| batch_size_ | int | Number of time series (input and output sequences) used in each training pass. Defaults to 32. | None | True | +| n_epochs | int | Number of epochs over which to train the model. Defaults to 100. | 100 | True | +| model_save_name | str | Name for model. Defaults to "brnn_model". | trans_model | True | +| force_reset | bool | If set to True, any previously-existing model with the same name will be reset
(all checkpoints will be discarded). Defaults to True. | True | True | +| save_checkpoints | bool | Whether or not to automatically save the untrained model and checkpoints from training.
Defaults to True. | True | True | +| export | str | Format to export data | | True | +| residuals | bool | Whether to show residuals for the model. Defaults to False. | False | True | +| forecast_only | bool | Whether to only show dates in the forecasting range. Defaults to False. | False | True | +| start_date | Optional[datetime] | The starting date to perform analysis, data before this is trimmed. Defaults to None. | None | True | +| end_date | Optional[datetime] | The ending date to perform analysis, data after this is trimmed. Defaults to None. | None | True | +| naive | bool | Whether to show the naive baseline. This just assumes the closing price will be the same
as the previous day's closing price. Defaults to False. | False | True | +| external_axes | Optional[List[plt.axes]] | External axes to plot on | None | True | + + +--- + +## Returns + +This function does not return anything + +--- + + + diff --git a/website/content/sdk/reference/forex/candle.md b/website/content/sdk/reference/forex/candle.md new file mode 100644 index 000000000000..1f4dd4664a98 --- /dev/null +++ b/website/content/sdk/reference/forex/candle.md @@ -0,0 +1,46 @@ +--- +title: candle +description: Discover how to implement candle plotting for forex data using the OpenBB + platform. The page includes necessary parameters for creating a candle plot and + source code for reference. +keywords: +- forex +- candle +- fx data +- moving averages +- matplotlib +- OpenBB.finance +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Show candle plot for fx data. + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/forex/forex_helper.py#L235)] + +```python +openbb.forex.candle(data: pd.DataFrame, to_symbol: str = "", from_symbol: str = "", ma: Optional[Iterable[int]] = None, external_axes: Optional[List[matplotlib.axes._axes.Axes]] = None, use_matplotlib: bool = True, add_trend: bool = False, yscale: str = "linear") +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| data | pd.DataFrame | Loaded fx historical data | None | False | +| to_symbol | str | To forex symbol | | True | +| from_symbol | str | From forex symbol | | True | +| ma | Optional[Iterable[int]] | Moving averages | None | True | +| external_axes | Optional[List[plt.Axes]] | External axes (1 axis is expected in the list), by default None | None | True | + + +--- + +## Returns + +This function does not return anything + +--- diff --git a/website/content/sdk/reference/forex/fwd.md b/website/content/sdk/reference/forex/fwd.md new file mode 100644 index 000000000000..7c7fbd3191e2 --- /dev/null +++ b/website/content/sdk/reference/forex/fwd.md @@ -0,0 +1,49 @@ +--- +title: fwd +description: This documentation page provides the syntax and details for extracting + forward rates from fxempire using the OpenBB.finance OpenBBTerminal, including the + parameters required and the return type. The page is of significant utility to users + seeking to navigate the forex section of the OpenBBTerminal. +keywords: +- fwd function +- fxempire +- Forward rates +- forex +- OpenBB.finance +- currency conversion +- USD +- EUR +- parameters +- returns +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Gets forward rates from fxempire + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/forex/fxempire_model.py#L14)] + +```python +openbb.forex.fwd(to_symbol: str = "USD", from_symbol: str = "EUR") +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| to_symbol | str | To currency | USD | True | +| from_symbol | str | From currency | EUR | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | Dataframe containing forward rates | +--- diff --git a/website/content/sdk/reference/forex/get_currency_list.md b/website/content/sdk/reference/forex/get_currency_list.md new file mode 100644 index 000000000000..1e8136a493a4 --- /dev/null +++ b/website/content/sdk/reference/forex/get_currency_list.md @@ -0,0 +1,40 @@ +--- +title: get_currency_list +description: Documentation page for the get_currency_list function which loads currency + codes from a local file in the OpenBB finance platform. +keywords: +- get_currency_list function +- OpenBB finance platform +- Currency codes +- Local file +- Forex +- Open source finance platform +- Finance +- Function Documentation +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Load AV currency codes from a local file. + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/forex/av_model.py#L19)] + +```python +openbb.forex.get_currency_list() +``` + +--- + +## Parameters + +This function does not take any parameters. + +--- + +## Returns + +This function does not return anything + +--- diff --git a/website/content/sdk/reference/forex/load.md b/website/content/sdk/reference/forex/load.md new file mode 100644 index 000000000000..c7535f8da856 --- /dev/null +++ b/website/content/sdk/reference/forex/load.md @@ -0,0 +1,53 @@ +--- +title: load +description: The page provides an explanation of the 'load' feature that is used to + load forex data for two given symbols. It includes the source code link and details + about the parameters including to_symbol, from_symbol, resolution, interval, start_date, + source, and verbose. +keywords: +- forex data +- currency symbols +- forex parameters +- load forex data +- forex data source +- YahooFinance forex data +- data resolution +- data interval +- verbose data loading +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Load forex for two given symbols. + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/forex/forex_helper.py#L95)] + +```python +openbb.forex.load(to_symbol: str, from_symbol: str, resolution: str = "d", interval: str = "1day", start_date: Optional[str] = None, source: str = "YahooFinance", verbose: bool = False) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| to_symbol | str | The from currency symbol. Ex: USD, EUR, GBP, YEN | None | False | +| from_symbol | str | The from currency symbol. Ex: USD, EUR, GBP, YEN | None | False | +| resolution | str | The resolution for the data, by default "d" | d | True | +| interval | str | What interval to get data for, by default "1day" | 1day | True | +| start_date | Optional[str] | When to begin loading in data, by default last_year.strftime("%Y-%m-%d") | None | True | +| source | str | Where to get data from, by default "YahooFinance" | YahooFinance | True | +| verbose | bool | Display verbose information on what was the pair that was loaded, by default True | False | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | The loaded data | +--- diff --git a/website/content/sdk/reference/forex/oanda/calendar.md b/website/content/sdk/reference/forex/oanda/calendar.md new file mode 100644 index 000000000000..e9b0b75fb358 --- /dev/null +++ b/website/content/sdk/reference/forex/oanda/calendar.md @@ -0,0 +1,88 @@ +--- +title: calendar +description: Provides a comprehensive guide on the Oanda calendar functionality in + the OpenBB finance package. Details include how to request data of significant events, + parameters for currency pair and days, model and view interfaces, and corresponding + source code. +keywords: +- oanda +- forex +- calendar +- events +- data +- currency pair +- advance +- model +- view +- chart +- OpenBB-finance +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + +Request data of significant events calendar. + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/forex/oanda/oanda_model.py#L645)] + +```python +openbb.forex.oanda.calendar(days: int = 14, instrument: Optional[str] = None) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| instrument | Union[str, None] | The loaded currency pair, by default None | None | True | +| days | int | Number of days in advance | 14 | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| Union[pd.DataFrame, bool] | Calendar events data or False | +--- + + + + +View calendar of significant events. + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/forex/oanda/oanda_view.py#L383)] + +```python +openbb.forex.oanda.calendar_chart(instrument: str, days: int = 7) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| instrument | str | The loaded currency pair | None | False | +| days | int | Number of days in advance | 7 | True | + + +--- + +## Returns + +This function does not return anything + +--- + + + diff --git a/website/content/sdk/reference/forex/oanda/cancel.md b/website/content/sdk/reference/forex/oanda/cancel.md new file mode 100644 index 000000000000..61948e2ef2a4 --- /dev/null +++ b/website/content/sdk/reference/forex/oanda/cancel.md @@ -0,0 +1,79 @@ +--- +title: cancel +description: This page describes two methods to cancel a pending order in OpenBB's + forex trading system using Oanda. It includes Python functions to cancel an order + by ID from either the model or chart view. +keywords: +- cancel pending order +- Oanda +- forex +- python function +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + +Request cancellation of a pending order. + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/forex/oanda/oanda_model.py#L346)] + +```python +openbb.forex.oanda.cancel(orderID: str, accountID: str = "REPLACE_ME") +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| orderID | str | The pending order ID to cancel. | None | False | +| accountID | str | Oanda account ID, by default cfg.OANDA_ACCOUNT | REPLACE_ME | True | + + +--- + +## Returns + +This function does not return anything + +--- + + + + +Cancel a Pending Order. + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/forex/oanda/oanda_view.py#L197)] + +```python +openbb.forex.oanda.cancel_chart(accountID: str, orderID: str = "") +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| accountID | str | Oanda user account ID | None | False | +| orderID | str | The pending order ID to cancel. | | True | + + +--- + +## Returns + +This function does not return anything + +--- + + + diff --git a/website/content/sdk/reference/forex/oanda/candles.md b/website/content/sdk/reference/forex/oanda/candles.md new file mode 100644 index 000000000000..e575073958d0 --- /dev/null +++ b/website/content/sdk/reference/forex/oanda/candles.md @@ -0,0 +1,91 @@ +--- +title: candles +description: The page provides detailed info on 'candles' functions within the OpenBB + forex category for Oanda. It covers methods to request candle chart data and display + the candle chart, along with their respective parameters and return types. Source + links for Python code are included. +keywords: +- candles +- chart +- Forex +- granularity +- data points +- Oanda +- currency pair +- Source Code +- matplotlib +- additional charts +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + +Request data for candle chart. + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/forex/oanda/oanda_model.py#L581)] + +```python +openbb.forex.oanda.candles(instrument: Optional[str] = None, granularity: str = "D", candlecount: int = 180) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| instrument | str | Loaded currency pair code | None | True | +| granularity | str | Data granularity, by default "D" | D | True | +| candlecount | int | Limit for the number of data points, by default 180 | 180 | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| Union[pd.DataFrame, bool] | Candle chart data or False | +--- + + + + +Show candle chart. + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/forex/oanda/oanda_view.py#L294)] + +```python +openbb.forex.oanda.candles_chart(instrument: str = "", granularity: str = "D", candlecount: int = 180, additional_charts: Optional[Dict[str, bool]] = None, external_axes: Optional[List[matplotlib.axes._axes.Axes]] = None) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| instrument | str | The loaded currency pair | | True | +| granularity | str | The timeframe to get for the candle chart. Seconds: S5, S10, S15, S30
Minutes: M1, M2, M4, M5, M10, M15, M30 Hours: H1, H2, H3, H4, H6, H8, H12
Day (default): D, Week: W Month: M, | D | True | +| candlecount | int | Limit for the number of data points | 180 | True | +| additional_charts | Dict[str, bool] | A dictionary of flags to include additional charts | None | True | +| external_axes | Optional[List[plt.Axes]] | External axes (2 axes are expected in the list), by default None | None | True | + + +--- + +## Returns + +This function does not return anything + +--- + + + diff --git a/website/content/sdk/reference/forex/oanda/close.md b/website/content/sdk/reference/forex/oanda/close.md new file mode 100644 index 000000000000..01d44542d617 --- /dev/null +++ b/website/content/sdk/reference/forex/oanda/close.md @@ -0,0 +1,84 @@ +--- +title: close +description: Documentation for methods used in closing trades and viewing charts in + the OpenBB fin-tech software. The page gives a detailed explanation about their + use, parameters, and return values. +keywords: +- finance software +- trade +- chart +- Oanda +- forex +- function +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + +Close a trade. + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/forex/oanda/oanda_model.py#L526)] + +```python +openbb.forex.oanda.close(orderID: str, units: Optional[int] = 0, accountID: str = "REPLACE_ME") +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| orderID | str | ID of the order to close | None | False | +| units | Union[int, None] | Number of units to close. If empty default to all. | 0 | True | +| accountID | str | Oanda account ID, by default cfg.OANDA_ACCOUNT | REPLACE_ME | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| Union[pd.DataFrame, bool] | Close trades data or False | +--- + + + + +Close a trade. + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/forex/oanda/oanda_view.py#L271)] + +```python +openbb.forex.oanda.close_chart(accountID: str, orderID: str = "", units: Optional[int] = None) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| accountID | str | Oanda user account ID | None | False | +| orderID | str | ID of the order to close | | True | +| units | Union[int, None] | Number of units to close. If empty default to all. | None | True | + + +--- + +## Returns + +This function does not return anything + +--- + + + diff --git a/website/versioned_docs/version-v3/sdk/reference/forex/oanda/listorders.md b/website/content/sdk/reference/forex/oanda/listorders.md similarity index 77% rename from website/versioned_docs/version-v3/sdk/reference/forex/oanda/listorders.md rename to website/content/sdk/reference/forex/oanda/listorders.md index 87d19fa57173..a43b1f4dd30e 100644 --- a/website/versioned_docs/version-v3/sdk/reference/forex/oanda/listorders.md +++ b/website/content/sdk/reference/forex/oanda/listorders.md @@ -1,13 +1,25 @@ --- title: listorders -description: OpenBB SDK Function +description: Detailed documentation page explaining how to request the orders list + from Oanda using OpenBB's terminal. It covers both Model and Chart methods, each + with separate tabs explaining the parameters needed. +keywords: +- Oanda +- orders list +- Forex +- API documentation +- order_state +- order_count +- accountID --- +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; -# listorders - @@ -38,8 +50,6 @@ This function does not return anything --- - - @@ -70,7 +80,5 @@ This function does not return anything --- - - - \ No newline at end of file + diff --git a/website/content/sdk/reference/forex/oanda/openpositions.md b/website/content/sdk/reference/forex/oanda/openpositions.md new file mode 100644 index 000000000000..ccf03847b1ea --- /dev/null +++ b/website/content/sdk/reference/forex/oanda/openpositions.md @@ -0,0 +1,79 @@ +--- +title: openpositions +description: This documentation page provides details about the OpenBB 'open positions' + function in forex trading with Oanda. Learn about the parameters including account + ID and review the source code in Python. +keywords: +- open positions +- forex +- Oanda +- account ID +- function parameters +- python code +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + +Request information on open positions. + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/forex/oanda/oanda_model.py#L378)] + +```python +openbb.forex.oanda.openpositions(accountID: str = "REPLACE_ME") +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| accountID | str | Oanda account ID, by default cfg.OANDA_ACCOUNT | REPLACE_ME | True | + + +--- + +## Returns + +This function does not return anything + +--- + + + + +Get information about open positions. + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/forex/oanda/oanda_view.py#L216)] + +```python +openbb.forex.oanda.openpositions_chart(accountID: str) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| accountID | str | Oanda user account ID | None | False | + + +--- + +## Returns + +This function does not return anything + +--- + + + diff --git a/website/content/sdk/reference/forex/oanda/opentrades.md b/website/content/sdk/reference/forex/oanda/opentrades.md new file mode 100644 index 000000000000..1641791e5d8f --- /dev/null +++ b/website/content/sdk/reference/forex/oanda/opentrades.md @@ -0,0 +1,79 @@ +--- +title: opentrades +description: This page provides information on the 'opentrades' function in the OpenBB + Python library. It provides sections on how to request open trades data and view + open trades using the forex Oanda module, complete with source code for reference. +keywords: +- opentrades +- forex +- Oanda +- trade data +- open trades chart +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + +Request open trades data. + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/forex/oanda/oanda_model.py#L470)] + +```python +openbb.forex.oanda.opentrades(accountID: str = "REPLACE_ME") +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| accountID | str | Oanda account ID, by default cfg.OANDA_ACCOUNT | REPLACE_ME | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| Union[pd.DataFrame, bool] | Open trades data or False | +--- + + + + +View open trades. + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/forex/oanda/oanda_view.py#L252)] + +```python +openbb.forex.oanda.opentrades_chart(accountID: str) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| accountID | str | Oanda user account ID | None | False | + + +--- + +## Returns + +This function does not return anything + +--- + + + diff --git a/website/content/sdk/reference/forex/oanda/order.md b/website/content/sdk/reference/forex/oanda/order.md new file mode 100644 index 000000000000..a88540a3eb54 --- /dev/null +++ b/website/content/sdk/reference/forex/oanda/order.md @@ -0,0 +1,90 @@ +--- +title: order +description: This page provides detailed documentation on how to create buy/sell trade + orders using OpenBB Terminal's 'forex.oanda' module. It includes source code, function + definitions, parameters, and return information to successfully place orders. +keywords: +- Forex +- Oanda +- Order +- Buy Order +- Sell Order +- Account ID +- Currency Pair +- Price +- Units +- Order Chart +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + +Request creation of buy/sell trade order. + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/forex/oanda/oanda_model.py#L270)] + +```python +openbb.forex.oanda.order(price: int = 0, units: int = 0, instrument: Optional[str] = None, accountID: str = "REPLACE_ME") +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| instrument | Union[str, None] | The loaded currency pair, by default None | None | True | +| price | int | The price to set for the limit order. | 0 | True | +| units | int | The number of units to place in the order request. | 0 | True | +| accountID | str | Oanda account ID, by default cfg.OANDA_ACCOUNT | REPLACE_ME | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| Union[pd.DataFrame, bool] | Orders data or False | +--- + + + + +Create a buy/sell order. + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/forex/oanda/oanda_view.py#L174)] + +```python +openbb.forex.oanda.order_chart(accountID: str, instrument: str = "", price: int = 0, units: int = 0) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| accountID | str | Oanda user account ID | None | False | +| instrument | str | The loaded currency pair | | True | +| price | int | The price to set for the limit order. | 0 | True | +| units | int | The number of units to place in the order request. | 0 | True | + + +--- + +## Returns + +This function does not return anything + +--- + + + diff --git a/website/content/sdk/reference/forex/oanda/orderbook.md b/website/content/sdk/reference/forex/oanda/orderbook.md new file mode 100644 index 000000000000..29a8dcf5fce8 --- /dev/null +++ b/website/content/sdk/reference/forex/oanda/orderbook.md @@ -0,0 +1,86 @@ +--- +title: orderbook +description: This documentation page hosts information on 'Orderbook' operations in + forex trading using the 'Oanda' platform, powered by 'OpenBB'. It includes Python + source code, various parameters, and return types. Also addressed is plotting an + 'Orderbook' chart with 'matplotlib'. +keywords: +- orderbook +- oanda +- forex +- currency pair +- accountID +- orderbook chart +- matplotlib +- pandas DataFrame +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + +Request order book data for plotting. + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/forex/oanda/oanda_model.py#L137)] + +```python +openbb.forex.oanda.orderbook(instrument: Optional[str] = None, accountID: str = "REPLACE_ME") +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| instrument | Union[str, None] | The loaded currency pair, by default None | None | True | +| accountID | str | Oanda account ID, by default cfg.OANDA_ACCOUNT | REPLACE_ME | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| Union[pd.DataFrame, bool] | Order book data or False | +--- + + + + +Plot the orderbook for the instrument if Oanda provides one. + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/forex/oanda/oanda_view.py#L79)] + +```python +openbb.forex.oanda.orderbook_chart(accountID: str, instrument: str = "", external_axes: Optional[List[matplotlib.axes._axes.Axes]] = None) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| accountID | str | Oanda user account ID | None | False | +| instrument | str | The loaded currency pair | | True | +| external_axes | Optional[List[plt.Axes]] | External axes (1 axis is expected in the list), by default None | None | True | + + +--- + +## Returns + +This function does not return anything + +--- + + + diff --git a/website/content/sdk/reference/forex/oanda/pending.md b/website/content/sdk/reference/forex/oanda/pending.md new file mode 100644 index 000000000000..f882e2a7d46a --- /dev/null +++ b/website/content/sdk/reference/forex/oanda/pending.md @@ -0,0 +1,82 @@ +--- +title: pending +description: This page explains how to get information on pending orders using the + OpenBB Terminal. The documentation includes specific source code for the Forex market + with OANDA, detailing parameters and returns including the AccountID. The page also + provides a link to the relevant source code on GitHub. +keywords: +- Forex +- OANDA +- AccountID +- Pending orders +- OpenBB Forex OANDA Pending +- Source Code +- Pending chart +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + +Request information on pending orders. + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/forex/oanda/oanda_model.py#L421)] + +```python +openbb.forex.oanda.pending(accountID: str = "REPLACE_ME") +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| accountID | str | Oanda account ID, by default cfg.OANDA_ACCOUNT | REPLACE_ME | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| Union[pd.DataFrame, bool] | Pending orders data or False | +--- + + + + +Get information about pending orders. + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/forex/oanda/oanda_view.py#L233)] + +```python +openbb.forex.oanda.pending_chart(accountID: str) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| accountID | str | Oanda user account ID | None | False | + + +--- + +## Returns + +This function does not return anything + +--- + + + diff --git a/website/content/sdk/reference/forex/oanda/positionbook.md b/website/content/sdk/reference/forex/oanda/positionbook.md new file mode 100644 index 000000000000..61bc28b54b45 --- /dev/null +++ b/website/content/sdk/reference/forex/oanda/positionbook.md @@ -0,0 +1,87 @@ +--- +title: positionbook +description: Improve your understanding of the positionbook functionality on the OpenBBTerminal. + Discover how to request position book data and plot a position book for an instrument + if Oanda provides one. Detailed source codes and parameter descriptions are provided + to facilitate its usage. +keywords: +- positionbook +- plotting +- Oanda +- forex +- data frame +- parameters +- currency pair +- matplotlib +- axes +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + +Request position book data for plotting. + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/forex/oanda/oanda_model.py#L182)] + +```python +openbb.forex.oanda.positionbook(instrument: Optional[str] = None, accountID: str = "REPLACE_ME") +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| instrument | Union[str, None] | The loaded currency pair, by default None | None | True | +| accountID | str | Oanda account ID, by default cfg.OANDA_ACCOUNT | REPLACE_ME | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| Union[pd.DataFrame, bool] | Position book data or False | +--- + + + + +Plot a position book for an instrument if Oanda provides one. + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/forex/oanda/oanda_view.py#L116)] + +```python +openbb.forex.oanda.positionbook_chart(accountID: str, instrument: str = "", external_axes: Optional[List[matplotlib.axes._axes.Axes]] = None) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| accountID | str | Oanda user account ID | None | False | +| instrument | str | The loaded currency pair | | True | +| external_axes | Optional[List[plt.Axes]] | External axes (1 axis is expected in the list), by default None | None | True | + + +--- + +## Returns + +This function does not return anything + +--- + + + diff --git a/website/content/sdk/reference/forex/oanda/price.md b/website/content/sdk/reference/forex/oanda/price.md new file mode 100644 index 000000000000..ed524060d29d --- /dev/null +++ b/website/content/sdk/reference/forex/oanda/price.md @@ -0,0 +1,85 @@ +--- +title: price +description: This marketing page provides information on how to request and view forex + prices with the modules in OpenBB-finance. It outlines parameters and returns for + each featured function. +keywords: +- OpenBB-finance +- forex prices +- oanda +- price request +- price view +- currency pair +- functions +- parameters +- returns +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + +Request price for a forex pair. + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/forex/oanda/oanda_model.py#L36)] + +```python +openbb.forex.oanda.price(accountID: str = "REPLACE_ME", instrument: Optional[str] = None) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| accountID | str | Oanda account ID, by default cfg.OANDA_ACCOUNT | REPLACE_ME | True | +| instrument | Union[str, None] | The loaded currency pair, by default None | None | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| Union[Dict[str, str], bool] | The currency pair price or False | +--- + + + + +View price for loaded currency pair. + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/forex/oanda/oanda_view.py#L40)] + +```python +openbb.forex.oanda.price_chart(account: str, instrument: Optional[str] = "") +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| accountID | str | Oanda account ID | None | True | +| instrument | Union[str, None] | Instrument code or None | | True | + + +--- + +## Returns + +This function does not return anything + +--- + + + diff --git a/website/content/sdk/reference/forex/oanda/summary.md b/website/content/sdk/reference/forex/oanda/summary.md new file mode 100644 index 000000000000..aa3f414724f8 --- /dev/null +++ b/website/content/sdk/reference/forex/oanda/summary.md @@ -0,0 +1,85 @@ +--- +title: summary +description: This is a comprehensive documentation on the functionality of creating + an Oanda account summary using OpenBB-Finance. Covers Python source codes, parameters + and returns on model and chart tabs for summary creation. +keywords: +- Oanda account summary +- Source Code +- OpenBB finance +- forex +- oanda_model.py +- oanda_view.py +- account ID +- TabItem +- Tabs +- Union +- summary chart +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + +Request Oanda account summary. + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/forex/oanda/oanda_model.py#L74)] + +```python +openbb.forex.oanda.summary(accountID: str = "REPLACE_ME") +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| accountID | str | Oanda account ID, by default cfg.OANDA_ACCOUNT | REPLACE_ME | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| Union[pd.DataFrame, bool] | Account summary data or False | +--- + + + + +Print Oanda account summary. + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/forex/oanda/oanda_view.py#L62)] + +```python +openbb.forex.oanda.summary_chart(accountID: str) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| accountID | str | Oanda user account ID | None | False | + + +--- + +## Returns + +This function does not return anything + +--- + + + diff --git a/website/content/sdk/reference/forex/quote.md b/website/content/sdk/reference/forex/quote.md new file mode 100644 index 000000000000..212dc17b1bbe --- /dev/null +++ b/website/content/sdk/reference/forex/quote.md @@ -0,0 +1,61 @@ +--- +title: quote +description: Documentation on how to get forex quotes using the OpenBB Terminal. It + covers the different parameters that can be used, return types and also gives example + usage. +keywords: +- OpenBB Terminal Documentation +- Forex Quotes +- Python SDK +- OpenBB forex.quote function +- Forex Quote Parameter Instructions +- YahooFinance Forex API +- AlphaVantage Forex API +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Get forex quote. + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/forex/sdk_helpers.py#L9)] + +```python +openbb.forex.quote(symbol: str, source: str = "YahooFinance") +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| symbol | str | Forex symbol to get quote for. | None | False | +| source | str | Source to get quote from, by default "YahooFinance" | YahooFinance | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | DataFrame of quote data. | +--- + +## Examples + +```python +from openbb_terminal.sdk import openbb +EUR_USD_quote = openbb.forex.quote("EURUSD") +``` + +``` +This also supports AlphaVantage and will handle different conventions +``` +```python +EUR_USD= openbb.forex.quote("EUR/USD", source="AlphaVantage") +``` + +--- diff --git a/website/content/sdk/reference/futures/curve.md b/website/content/sdk/reference/futures/curve.md new file mode 100644 index 000000000000..ab481868d6d8 --- /dev/null +++ b/website/content/sdk/reference/futures/curve.md @@ -0,0 +1,84 @@ +--- +title: curve +description: The documentation page provides detailed instructions on how to retrieve + and display curve futures using the OpenBB Python library, with source code provided. + The API functions interact with data from Yahoo Finance and include customization + options for data representation and export format. +keywords: +- curve futures +- Yahoo Finance +- futures data +- data visualization +- matplotlib +- API documentation +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + +Get curve futures [Source: Yahoo Finance] + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/futures/yfinance_model.py#L118)] + +```python +openbb.futures.curve(symbol: str = "") +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| symbol | str | symbol to get forward curve | | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | Dictionary with sector weightings allocation | +--- + + + + +Display curve futures [Source: Yahoo Finance] + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/futures/yfinance_view.py#L232)] + +```python +openbb.futures.curve_chart(symbol: str, raw: bool = False, export: str = "", external_axes: Optional[List[matplotlib.axes._axes.Axes]] = None) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| symbol | str | Curve future symbol to display | None | False | +| raw | bool | Display futures timeseries in raw format | False | True | +| export | str | Type of format to export data | | True | +| external_axes | Optional[List[plt.Axes]] | External axes (1 axis is expected in the list), by default None | None | True | + + +--- + +## Returns + +This function does not return anything + +--- + + + diff --git a/website/content/sdk/reference/futures/historical.md b/website/content/sdk/reference/futures/historical.md new file mode 100644 index 000000000000..5cc00d317ccc --- /dev/null +++ b/website/content/sdk/reference/futures/historical.md @@ -0,0 +1,88 @@ +--- +title: historical +description: The documentation provides comprehensive details on sourcing historical + data from Yahoo Finance using the OpenBB Python library. It covers the use of future + timeseries symbols and the ways to display, format and export the data. +keywords: +- historical data +- Yahoo Finance +- future timeseries +- futures +- expiry date +- matplotlib.axes._axes.Axes +- export data +- raw format +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + +Get historical futures [Source: Yahoo Finance] + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/futures/yfinance_model.py#L79)] + +```python +openbb.futures.historical(symbols: List[str], expiry: str = "") +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| symbols | List[str] | List of future timeseries symbols to display | None | False | +| expiry | str | Future expiry date with format YYYY-MM | | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | Dictionary with sector weightings allocation | +--- + + + + +Display historical futures [Source: Yahoo Finance] + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/futures/yfinance_view.py#L65)] + +```python +openbb.futures.historical_chart(symbols: List[str], expiry: str = "", start_date: Optional[str] = None, raw: bool = False, export: str = "", external_axes: Optional[List[matplotlib.axes._axes.Axes]] = None) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| symbols | List[str] | List of future timeseries symbols to display | None | False | +| expiry | str | Future expiry date with format YYYY-MM | | True | +| start_date | Optional[str] | Initial date like string (e.g., 2021-10-01) | None | True | +| raw | bool | Display futures timeseries in raw format | False | True | +| export | str | Type of format to export data | | True | +| external_axes | Optional[List[plt.Axes]] | External axes (1 axis is expected in the list), by default None | None | True | + + +--- + +## Returns + +This function does not return anything + +--- + + + diff --git a/website/content/sdk/reference/futures/search.md b/website/content/sdk/reference/futures/search.md new file mode 100644 index 000000000000..64fe0e065d25 --- /dev/null +++ b/website/content/sdk/reference/futures/search.md @@ -0,0 +1,43 @@ +--- +title: search +description: This documentation page provides details on the 'search' function related + to future investments as available on OpenBB-finance. It covers information on various + parameters like 'category', 'exchange', and 'description' to refine search. +keywords: +- openbb.finance search function +- future investments search +- Yahoo finance +- finance function Source code +- search parameters +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Get search futures [Source: Yahoo Finance] + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/futures/yfinance_model.py#L50)] + +```python +openbb.futures.search(category: str = "", exchange: str = "", description: str = "") +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| category | str | Select the category where the future exists | | True | +| exchange | str | Select the exchange where the future exists | | True | +| description | str | Select the description where the future exists | | True | + + +--- + +## Returns + +This function does not return anything + +--- diff --git a/website/content/sdk/reference/keys/av.md b/website/content/sdk/reference/keys/av.md new file mode 100644 index 000000000000..316fef681b70 --- /dev/null +++ b/website/content/sdk/reference/keys/av.md @@ -0,0 +1,54 @@ +--- +title: av +description: This documentation page provides detailed instructions on how to set + the Alpha Vantage key using OpenBB Terminal. It includes descriptions for parameters, + information on returns, and usage examples. +keywords: +- Alpha Vantage key +- API key +- Functions +- Global settings +- Environment variables +- Jupyter notebook +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Set Alpha Vantage key + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/keys_model.py#L289)] + +```python +openbb.keys.av(key: str, persist: bool = False, show_output: bool = False) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| key | str | API key | None | False | +| persist | bool | If False, api key change will be contained to where it was changed. For example, a Jupyter notebook session.
If True, api key change will be global, i.e. it will affect terminal environment variables.
By default, False. | False | True | +| show_output | bool | Display status string or not. By default, False. | False | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| str | Status of key set | +--- + +## Examples + +```python +from openbb_terminal.sdk import openbb +openbb.keys.av(key="example_key") +``` + +--- diff --git a/website/content/sdk/reference/keys/binance.md b/website/content/sdk/reference/keys/binance.md new file mode 100644 index 000000000000..d16f107d5d53 --- /dev/null +++ b/website/content/sdk/reference/keys/binance.md @@ -0,0 +1,60 @@ +--- +title: binance +description: This documentation page provides information on how to set Binance keys + using the openbb_terminal sdk, including a detailed overlook of the parameters and + returns. +keywords: +- binance +- API key +- API secret +- openbb_terminal sdk +- Jupyter notebook session +- terminal environment variables +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Set Binance key + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/keys_model.py#L1473)] + +```python +openbb.keys.binance(key: str, secret: str, persist: bool = False, show_output: bool = False) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| key | str | API key | None | False | +| secret | str | API secret | None | False | +| persist | bool | If False, api key change will be contained to where it was changed. For example, a Jupyter notebook session.
If True, api key change will be global, i.e. it will affect terminal environment variables.
By default, False. | False | True | +| show_output | bool | Display status string or not. By default, False. | False | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| str | Status of key set | +--- + +## Examples + +```python +from openbb_terminal.sdk import openbb +openbb.keys.binance( +``` + +``` +key="example_key", + secret="example_secret" + ) +``` +--- diff --git a/website/content/sdk/reference/keys/bitquery.md b/website/content/sdk/reference/keys/bitquery.md new file mode 100644 index 000000000000..3a85c5656dce --- /dev/null +++ b/website/content/sdk/reference/keys/bitquery.md @@ -0,0 +1,55 @@ +--- +title: bitquery +description: This documentation page is dedicated to the Bitquery key setting process + in the OpenBB Terminal application. Learn how to set API keys, understand the use + of environment variables, and follow practical examples using the Python language + in a Jupyter Notebook environment. +keywords: +- Bitquery +- API Key +- Setting Key +- Environment Variables +- Jupyter Notebook +- Terminal +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Set Bitquery key + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/keys_model.py#L1059)] + +```python +openbb.keys.bitquery(key: str, persist: bool = False, show_output: bool = False) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| key | str | API key | None | False | +| persist | bool | If False, api key change will be contained to where it was changed. For example, a Jupyter notebook session.
If True, api key change will be global, i.e. it will affect terminal environment variables.
By default, False. | False | True | +| show_output | bool | Display status string or not. By default, False. | False | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| str | Status of key set | +--- + +## Examples + +```python +from openbb_terminal.sdk import openbb +openbb.keys.bitquery(key="example_key") +``` + +--- diff --git a/website/content/sdk/reference/keys/cmc.md b/website/content/sdk/reference/keys/cmc.md new file mode 100644 index 000000000000..e51b4be87fc4 --- /dev/null +++ b/website/content/sdk/reference/keys/cmc.md @@ -0,0 +1,54 @@ +--- +title: cmc +description: This page provides the process of setting the Coinmarketcap key, it explains + the parameters involved and gives an example of how it can be done. The topic is + important for users who want to integrate their projects with Coinmarketcap's API. +keywords: +- Coinmarketcap +- API +- key setting +- Jupyter notebook +- openbb_terminal +- environment variables +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Set Coinmarketcap key + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/keys_model.py#L751)] + +```python +openbb.keys.cmc(key: str, persist: bool = False, show_output: bool = False) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| key | str | API key | None | False | +| persist | bool | If False, api key change will be contained to where it was changed. For example, a Jupyter notebook session.
If True, api key change will be global, i.e. it will affect terminal environment variables.
By default, False. | False | True | +| show_output | bool | Display status string or not. By default, False. | False | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| str | Status of key set | +--- + +## Examples + +```python +from openbb_terminal.sdk import openbb +openbb.keys.cmc(key="example_key") +``` + +--- diff --git a/website/content/sdk/reference/keys/coinbase.md b/website/content/sdk/reference/keys/coinbase.md new file mode 100644 index 000000000000..401f77d908aa --- /dev/null +++ b/website/content/sdk/reference/keys/coinbase.md @@ -0,0 +1,65 @@ +--- +title: coinbase +description: This page provides a detailed guide on setting up a Coinbase key using + the OpenBBTerminal. Learn how to input your API key, secret, and passphrase. Understand + the functionality of persist and show_output parameters in the context of your Jupyter + notebook session and terminal environment variables. +keywords: +- coinbase +- coinbase key setup +- API key set +- openbb_terminal +- terminal environment variables +- coinbase API +- API secret +- coinbase passphrase +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Set Coinbase key + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/keys_model.py#L1622)] + +```python +openbb.keys.coinbase(key: str, secret: str, passphrase: str, persist: bool = False, show_output: bool = False) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| key | str | API key | None | False | +| secret | str | API secret | None | False | +| passphrase | str | Account passphrase | None | False | +| persist | bool | If False, api key change will be contained to where it was changed. For example, a Jupyter notebook session.
If True, api key change will be global, i.e. it will affect terminal environment variables.
By default, False. | False | True | +| show_output | bool | Display status string or not. By default, False. | False | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| str | Status of key set | +--- + +## Examples + +```python +from openbb_terminal.sdk import openbb +openbb.keys.coinbase( +``` + +``` +key="example_key", + secret="example_secret", + passphrase="example_passphrase" + ) +``` +--- diff --git a/website/content/sdk/reference/keys/coinglass.md b/website/content/sdk/reference/keys/coinglass.md new file mode 100644 index 000000000000..4f5b73d01fed --- /dev/null +++ b/website/content/sdk/reference/keys/coinglass.md @@ -0,0 +1,53 @@ +--- +title: coinglass +description: The page provides instructions on how to set the Coinglass key using + the openbb module of the OpenBBTerminal. It gives details on the parameters used + and their functionality, return types, and examples. +keywords: +- Coinglass key +- openbb module +- API key +- Jupyter notebook session +- terminal environment variables +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Set Coinglass key. + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/keys_model.py#L1853)] + +```python +openbb.keys.coinglass(key: str, persist: bool = False, show_output: bool = False) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| key | str | API key | None | False | +| persist | bool | If False, api key change will be contained to where it was changed. For example, a Jupyter notebook session.
If True, api key change will be global, i.e. it will affect terminal environment variables.
By default, False. | False | True | +| show_output | bool | Display status string or not. By default, False. | False | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| str | Status of key set | +--- + +## Examples + +```python +from openbb_terminal.sdk import openbb +openbb.keys.coinglass(key="example_key") +``` + +--- diff --git a/website/content/sdk/reference/keys/cpanic.md b/website/content/sdk/reference/keys/cpanic.md new file mode 100644 index 000000000000..740072a39292 --- /dev/null +++ b/website/content/sdk/reference/keys/cpanic.md @@ -0,0 +1,53 @@ +--- +title: cpanic +description: This page contains detailed information regarding the cpanic function + of OpenBB Terminal. It explains how to set the Cpanic key including parameters, + results, and examples. +keywords: +- Python SDK +- API key management +- cpanic function +- environment variables +- Jupyter notebook +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Set Cpanic key. + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/keys_model.py#L1924)] + +```python +openbb.keys.cpanic(key: str, persist: bool = False, show_output: bool = False) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| key | str | API key | None | False | +| persist | bool | If False, api key change will be contained to where it was changed. For example, a Jupyter notebook session.
If True, api key change will be global, i.e. it will affect terminal environment variables.
By default, False. | False | True | +| show_output | bool | Display status string or not. By default, False. | False | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| str | Status of key set | +--- + +## Examples + +```python +from openbb_terminal.sdk import openbb +openbb.keys.cpanic(key="example_key") +``` + +--- diff --git a/website/content/sdk/reference/keys/degiro.md b/website/content/sdk/reference/keys/degiro.md new file mode 100644 index 000000000000..27dd7b333afc --- /dev/null +++ b/website/content/sdk/reference/keys/degiro.md @@ -0,0 +1,65 @@ +--- +title: degiro +description: This page provides information on how to set the Degiro key using the + OpenBB terminal. You'll learn about parameters like username, password, and optional + fields like secret, persist and show_output. It also includes code examples for + better understanding. +keywords: +- Degiro key +- Set Degiro key +- username +- password +- persist +- show_output +- Jupyter notebook +- terminal environment variables +- api key change +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Set Degiro key + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/keys_model.py#L1296)] + +```python +openbb.keys.degiro(username: str, password: str, secret: str = "", persist: bool = False, show_output: bool = False) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| username | str | User username | None | False | +| password | str | User password | None | False | +| secret | str | User secret | | True | +| persist | bool | If False, api key change will be contained to where it was changed. For example, a Jupyter notebook session.
If True, api key change will be global, i.e. it will affect terminal environment variables.
By default, False. | False | True | +| show_output | bool | Display status string or not. By default, False. | False | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| str | Status of key set | +--- + +## Examples + +```python +from openbb_terminal.sdk import openbb +openbb.keys.degiro( +``` + +``` +username="example_username", + password="example_password" + ) +``` +--- diff --git a/website/content/sdk/reference/keys/eodhd.md b/website/content/sdk/reference/keys/eodhd.md new file mode 100644 index 000000000000..a3a07ffa6c58 --- /dev/null +++ b/website/content/sdk/reference/keys/eodhd.md @@ -0,0 +1,55 @@ +--- +title: eodhd +description: This is a documentation page for the 'set Eodhd key' functionality of + the OpenBB software. It provides the Python code, parameters and their descriptions, + return values, and an example on how to use the function. +keywords: +- eodhd +- api key +- parameters +- returns +- examples +- jupyter +- terminal environment variables +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Set Eodhd key. + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/keys_model.py#L2273)] + +```python +openbb.keys.eodhd(key: str, persist: bool = False, show_output: bool = False) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| key | str | API key | None | False | +| persist | bool | If False, api key change will be contained to where it was changed. For example, a Jupyter notebook session.
If True, api key change will be global, i.e. it will affect terminal environment variables.
By default, False. | False | True | +| show_output | bool | Display status string or not. By default, False. | False | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| str | Status of key set | +--- + +## Examples + +```python +from openbb_terminal.sdk import openbb +openbb.keys.eodhd(key="example_key") +``` + +--- diff --git a/website/content/sdk/reference/keys/ethplorer.md b/website/content/sdk/reference/keys/ethplorer.md new file mode 100644 index 000000000000..063fed1926d8 --- /dev/null +++ b/website/content/sdk/reference/keys/ethplorer.md @@ -0,0 +1,55 @@ +--- +title: ethplorer +description: This page provides documentation on how to set the Ethplorer key in the + OpenBB finance terminal. It includes explanations of the parameters and gives examples + of how to use this function. +keywords: +- Ethplorer +- API key +- Documentation +- Finance +- Example +- Source Code +- Parameters +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Set Ethplorer key. + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/keys_model.py#L1987)] + +```python +openbb.keys.ethplorer(key: str, persist: bool = False, show_output: bool = False) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| key | str | API key | None | False | +| persist | bool | If False, api key change will be contained to where it was changed. For example, a Jupyter notebook session.
If True, api key change will be global, i.e. it will affect terminal environment variables.
By default, False. | False | True | +| show_output | bool | Display status string or not. By default, False. | False | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| str | Status of key set | +--- + +## Examples + +```python +from openbb_terminal.sdk import openbb +openbb.keys.ethplorer(key="example_key") +``` + +--- diff --git a/website/content/sdk/reference/keys/finnhub.md b/website/content/sdk/reference/keys/finnhub.md new file mode 100644 index 000000000000..285ea22f12dc --- /dev/null +++ b/website/content/sdk/reference/keys/finnhub.md @@ -0,0 +1,53 @@ +--- +title: finnhub +description: This page provides information on setting up the Finnhub API key in the + OpenBB terminal environment, with code implementation examples. +keywords: +- Finnhub +- API key +- OpenBB terminal +- Python SDK +- Jupyter notebook +- Environment variables +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Set Finnhub key + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/keys_model.py#L813)] + +```python +openbb.keys.finnhub(key: str, persist: bool = False, show_output: bool = False) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| key | str | API key | None | False | +| persist | bool | If False, api key change will be contained to where it was changed. For example, a Jupyter notebook session.
If True, api key change will be global, i.e. it will affect terminal environment variables.
By default, False. | False | True | +| show_output | bool | Display status string or not. By default, False. | False | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| str | Status of key set | +--- + +## Examples + +```python +from openbb_terminal.sdk import openbb +openbb.keys.finnhub(key="example_key") +``` + +--- diff --git a/website/content/sdk/reference/keys/fmp.md b/website/content/sdk/reference/keys/fmp.md new file mode 100644 index 000000000000..46f1921110fc --- /dev/null +++ b/website/content/sdk/reference/keys/fmp.md @@ -0,0 +1,54 @@ +--- +title: fmp +description: This page provides a guide for setting the Financial Modeling Prep API + key using the OpenBB Terminal. It covers parameters to set the key, adjusting the + persist and show_output options, and an example of usage. +keywords: +- Financial Modeling Prep +- API key +- set api key +- openbb.keys.fmp +- persist +- show_output +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Set Financial Modeling Prep key + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/keys_model.py#L352)] + +```python +openbb.keys.fmp(key: str, persist: bool = False, show_output: bool = False) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| key | str | API key | None | False | +| persist | bool | If False, api key change will be contained to where it was changed. For example, a Jupyter notebook session.
If True, api key change will be global, i.e. it will affect terminal environment variables.
By default, False. | False | True | +| show_output | bool | Display status string or not. By default, False. | False | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| str | Status of key set | +--- + +## Examples + +```python +from openbb_terminal.sdk import openbb +openbb.keys.fmp(key="example_key") +``` + +--- diff --git a/website/content/sdk/reference/keys/fred.md b/website/content/sdk/reference/keys/fred.md new file mode 100644 index 000000000000..803aff642280 --- /dev/null +++ b/website/content/sdk/reference/keys/fred.md @@ -0,0 +1,56 @@ +--- +title: fred +description: This page provides thorough instructions for setting up a FRED key in + the OpenBB Terminal Python environment, including guidelines for its use within + a Jupyter notebook session or as a global terminal environment variable. Examples + of correct usage and behaviors are also provided. +keywords: +- FRED Key +- OpenBB terminal +- API key +- Jupyter notebook session +- terminal environment variables +- Status of key set +- openbb_terminal.sdk +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Set FRED key + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/keys_model.py#L548)] + +```python +openbb.keys.fred(key: str, persist: bool = False, show_output: bool = False) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| key | str | API key | None | False | +| persist | bool | If False, api key change will be contained to where it was changed. For example, a Jupyter notebook session.
If True, api key change will be global, i.e. it will affect terminal environment variables.
By default, False. | False | True | +| show_output | bool | Display status string or not. By default, False. | False | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| str | Status of key set | +--- + +## Examples + +```python +from openbb_terminal.sdk import openbb +openbb.keys.fred(key="example_key") +``` + +--- diff --git a/website/content/sdk/reference/keys/get_keys_info.md b/website/content/sdk/reference/keys/get_keys_info.md new file mode 100644 index 000000000000..f9f6ce702212 --- /dev/null +++ b/website/content/sdk/reference/keys/get_keys_info.md @@ -0,0 +1,46 @@ +--- +title: get_keys_info +description: Understand more about the get_keys_info function in OpenBBTerminal, which + provides info on available APIs usable in set_keys. Find the source code link, how + to use the function, the parameter it takes, and what it returns. +keywords: +- get_keys_info +- APIs +- set_keys +- openbb.keys +- parameters +- returns +- type +- description +- Dict[str, List[str]] +- Dictionary +- API keys +- arguments +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Get info on available APIs to use in set_keys. + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/keys_model.py#L177)] + +```python +openbb.keys.get_keys_info() +``` + +--- + +## Parameters + +This function does not take any parameters. + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| Dict[str, List[str]] | Dictionary of expected API keys and arguments | +--- diff --git a/website/content/sdk/reference/keys/github.md b/website/content/sdk/reference/keys/github.md new file mode 100644 index 000000000000..f0c6aefade29 --- /dev/null +++ b/website/content/sdk/reference/keys/github.md @@ -0,0 +1,55 @@ +--- +title: github +description: The page guides users on how to set a GitHub API key using the OpenBBTerminal. + It provides explanations about the parameters involved and gives a brief glimpse + into the possible return values. The page also includes code examples as useful + guidance. +keywords: +- github +- API key +- key set +- terminal environment variables +- Jupyter notebook session +- key persistence +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Set GitHub key. + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/keys_model.py#L2148)] + +```python +openbb.keys.github(key: str, persist: bool = False, show_output: bool = False) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| key | str | API key | None | False | +| persist | bool | If False, api key change will be contained to where it was changed. For example, a Jupyter notebook session.
If True, api key change will be global, i.e. it will affect terminal environment variables.
By default, False. | False | True | +| show_output | bool | Display status string or not. By default, False. | False | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| str | Status of key set | +--- + +## Examples + +```python +from openbb_terminal.sdk import openbb +openbb.keys.github(key="example_key") +``` + +--- diff --git a/website/content/sdk/reference/keys/glassnode.md b/website/content/sdk/reference/keys/glassnode.md new file mode 100644 index 000000000000..e681a9acfb94 --- /dev/null +++ b/website/content/sdk/reference/keys/glassnode.md @@ -0,0 +1,52 @@ +--- +title: glassnode +description: This documentation page provides a detailed guide on how to set the Glassnode + API key using the openbb.keys.glassnode method in the OpenBB Python library. It + includes a breakdown of parameters, return values, and a code example for easy comprehension. +keywords: +- Glassnode +- API key +- Environment variable +- Jupyter notebook +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Set Glassnode key. + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/keys_model.py#L1780)] + +```python +openbb.keys.glassnode(key: str, persist: bool = False, show_output: bool = False) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| key | str | API key | None | False | +| persist | bool | If False, api key change will be contained to where it was changed. For example, a Jupyter notebook session.
If True, api key change will be global, i.e. it will affect terminal environment variables.
By default, False. | False | True | +| show_output | bool | Display status string or not. By default, False. | False | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| str | Status of key set | +--- + +## Examples + +```python +from openbb_terminal.sdk import openbb +openbb.keys.glassnode(key="example_key") +``` + +--- diff --git a/website/content/sdk/reference/keys/iex.md b/website/content/sdk/reference/keys/iex.md new file mode 100644 index 000000000000..6e5ec9acb032 --- /dev/null +++ b/website/content/sdk/reference/keys/iex.md @@ -0,0 +1,62 @@ +--- +title: iex +description: This documentation provides information about the 'iex' function for + setting the IEX Cloud key using the OpenBB terminal. The function helps users to + set their API key with optional parameters such as persist and show_output for additional + functionality. Use this function to easily integrate your application with the IEX + Cloud services. +keywords: +- iex +- OpenBB terminal +- API key +- IEX Cloud +- api key setting +- openbb.keys.iex +- code documentation +- coding +- programming +- software development +- persist +- show_output +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Set IEX Cloud key + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/keys_model.py#L879)] + +```python +openbb.keys.iex(key: str, persist: bool = False, show_output: bool = False) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| key | str | API key | None | False | +| persist | bool | If False, api key change will be contained to where it was changed. For example, a Jupyter notebook session.
If True, api key change will be global, i.e. it will affect terminal environment variables.
By default, False. | False | True | +| show_output | bool | Display status string or not. By default, False. | False | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| str | Status of key set | +--- + +## Examples + +```python +from openbb_terminal.sdk import openbb +openbb.keys.iex(key="example_key") +``` + +--- diff --git a/website/content/sdk/reference/keys/messari.md b/website/content/sdk/reference/keys/messari.md new file mode 100644 index 000000000000..33dd4a6a23e9 --- /dev/null +++ b/website/content/sdk/reference/keys/messari.md @@ -0,0 +1,56 @@ +--- +title: messari +description: This page deals with details on setting the Messari key in the OpenBB + finance terminal. It highlights on parameters such as API key, the persist and show_output + options and also provides an example of how to use the openbb.keys.messari function. +keywords: +- OpenBB terminal +- Messari key +- API key +- Parameters +- openbb.keys.messari function +- example usage +- persist +- show_output +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Set Messari key. + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/keys_model.py#L2205)] + +```python +openbb.keys.messari(key: str, persist: bool = False, show_output: bool = False) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| key | str | API key | None | False | +| persist | bool | If False, api key change will be contained to where it was changed. For example, a Jupyter notebook session.
If True, api key change will be global, i.e. it will affect terminal environment variables.
By default, False. | False | True | +| show_output | bool | Display status string or not. By default, False. | False | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| str | Status of key set | +--- + +## Examples + +```python +from openbb_terminal.sdk import openbb +openbb.keys.messari(key="example_key") +``` + +--- diff --git a/website/content/sdk/reference/keys/mykeys.md b/website/content/sdk/reference/keys/mykeys.md new file mode 100644 index 000000000000..98df0288cd4d --- /dev/null +++ b/website/content/sdk/reference/keys/mykeys.md @@ -0,0 +1,59 @@ +--- +title: mykeys +description: This documentation page offers detailed instructions on how to get currently + set API keys using the OpenBB finance mykeys function. Includes parameter descriptions, + return types, and usage examples. +keywords: +- API keys +- OpenBB finance +- mykeys function +- Parameters +- Return types +- Examples +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Get currently set API keys. + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/keys_model.py#L241)] + +```python +openbb.keys.mykeys(show: bool = False) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| show | bool | Flag to choose whether to show actual keys or not.
By default, False. | False | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | Currents keys | +--- + +## Examples + +```python +from openbb_terminal.sdk import openbb +openbb.keys.mykeys() +``` + +``` +Key + API + BITQUERY_KEY ******* + CMC_KEY ******* +COINGLASS_KEY ******* +``` +--- diff --git a/website/content/sdk/reference/keys/news.md b/website/content/sdk/reference/keys/news.md new file mode 100644 index 000000000000..f596cdf140ca --- /dev/null +++ b/website/content/sdk/reference/keys/news.md @@ -0,0 +1,56 @@ +--- +title: news +description: This page provides information about the 'Set News key' feature in the + OpenBB Terminal. Learn how to use the function, understand the parameters and returns, + and see use-cases in Python code examples. +keywords: +- OpenBB Terminal documentation +- Set News key function +- API keys +- Python code examples +- OpenBB SDK +- terminal environment variables +- Change API key +- Jupyter notebook sessions +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Set News key + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/keys_model.py#L614)] + +```python +openbb.keys.news(key: str, persist: bool = False, show_output: bool = False) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| key | str | API key | None | False | +| persist | bool | If False, api key change will be contained to where it was changed. For example, a Jupyter notebook session.
If True, api key change will be global, i.e. it will affect terminal environment variables.
By default, False. | False | True | +| show_output | bool | Display status string or not. By default, False. | False | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| str | Status of key set | +--- + +## Examples + +```python +from openbb_terminal.sdk import openbb +openbb.keys.news(key="example_key") +``` + +--- diff --git a/website/versioned_docs/version-v3/sdk/reference/keys/oanda.md b/website/content/sdk/reference/keys/oanda.md similarity index 77% rename from website/versioned_docs/version-v3/sdk/reference/keys/oanda.md rename to website/content/sdk/reference/keys/oanda.md index b07a00172efe..d4752f3fb3ba 100644 --- a/website/versioned_docs/version-v3/sdk/reference/keys/oanda.md +++ b/website/content/sdk/reference/keys/oanda.md @@ -1,9 +1,22 @@ --- title: oanda -description: OpenBB SDK Function +description: This page explains how to set the Oanda key using the OpenBB Terminal. + It includes parameters and examples. +keywords: +- oanda +- set key +- parameters +- examples +- account +- access token +- account type +- persist +- show output --- -# oanda +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + Set Oanda key @@ -49,4 +62,3 @@ account="example_account", ) ``` --- - diff --git a/website/content/sdk/reference/keys/polygon.md b/website/content/sdk/reference/keys/polygon.md new file mode 100644 index 000000000000..0562e8604cc3 --- /dev/null +++ b/website/content/sdk/reference/keys/polygon.md @@ -0,0 +1,54 @@ +--- +title: polygon +description: This documentation is about the 'polygon' function in the OpenBB Terminal + Python SDK. It details how the function accepts a polygon API key, and settings + to persist or show output. +keywords: +- OpenBB Terminal SDK +- Polygon API key +- openbb.keys.polygon function +- Python SDK +- API key management +- Environment variables +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Set Polygon key + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/keys_model.py#L481)] + +```python +openbb.keys.polygon(key: str, persist: bool = False, show_output: bool = False) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| key | str | API key | None | False | +| persist | bool | If False, api key change will be contained to where it was changed. For example, a Jupyter notebook session.
If True, api key change will be global, i.e. it will affect terminal environment variables.
By default, False. | False | True | +| show_output | bool | Display status string or not. By default, False. | False | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| str | Status of key set | +--- + +## Examples + +```python +from openbb_terminal.sdk import openbb +openbb.keys.polygon(key="example_key") +``` + +--- diff --git a/website/content/sdk/reference/keys/quandl.md b/website/content/sdk/reference/keys/quandl.md new file mode 100644 index 000000000000..464f931580b9 --- /dev/null +++ b/website/content/sdk/reference/keys/quandl.md @@ -0,0 +1,55 @@ +--- +title: quandl +description: This documentation page describes how to set the Quandl Key in OpenBB + finance using Python. It provides parameters, return types, and code examples. +keywords: +- Quandl Key +- OpenBB finance +- API key +- Jupyter notebook +- terminal environment variables +- parameters +- return types +- code examples +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Set Quandl key + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/keys_model.py#L419)] + +```python +openbb.keys.quandl(key: str, persist: bool = False, show_output: bool = False) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| key | str | API key | None | False | +| persist | bool | If False, api key change will be contained to where it was changed. For example, a Jupyter notebook session.
If True, api key change will be global, i.e. it will affect terminal environment variables.
By default, False. | False | True | +| show_output | bool | Display status string or not. By default, False. | False | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| str | Status of key set | +--- + +## Examples + +```python +from openbb_terminal.sdk import openbb +openbb.keys.quandl(key="example_key") +``` + +--- diff --git a/website/content/sdk/reference/keys/reddit.md b/website/content/sdk/reference/keys/reddit.md new file mode 100644 index 000000000000..a027dd8226eb --- /dev/null +++ b/website/content/sdk/reference/keys/reddit.md @@ -0,0 +1,75 @@ +--- +title: reddit +description: The documentation page provides information on how to set Reddit API + keys using openbb_terminal's Python SDK. It lays out detailed procedures to establish + Reddit's client id and client secret for authentication. The page also explains + defaults and optional parameters including user credentials and options for API + key persistence. +keywords: +- Reddit API +- openbb keys +- Reddit client id +- Reddit client secret +- Reddit authentication +- openbb_terminal +- Python SDK +- API setting +- API key +- User credentials +- Jupyter notebook +- Environment variables +- Status string +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Set Reddit key + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/keys_model.py#L942)] + +```python +openbb.keys.reddit(client_id: str, client_secret: str, password: str, username: str, useragent: str, persist: bool = False, show_output: bool = False) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| client_id | str | Client ID | None | False | +| client_secret | str | Client secret | None | False | +| password | str | User password | None | False | +| username | str | User username | None | False | +| useragent | str | User useragent | None | False | +| persist | bool | If False, api key change will be contained to where it was changed. For example, a Jupyter notebook session.
If True, api key change will be global, i.e. it will affect terminal environment variables.
By default, False. | False | True | +| show_output | bool | Display status string or not. By default, False. | False | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| str | Status of key set | +--- + +## Examples + +```python +from openbb_terminal.sdk import openbb +openbb.keys.reddit( +``` + +``` +client_id="example_id", + client_secret="example_secret", + password="example_password", + username="example_username", + useragent="example_useragent" + ) +``` +--- diff --git a/website/content/sdk/reference/keys/rh.md b/website/content/sdk/reference/keys/rh.md new file mode 100644 index 000000000000..821fdf441796 --- /dev/null +++ b/website/content/sdk/reference/keys/rh.md @@ -0,0 +1,62 @@ +--- +title: rh +description: This page provides detailed information on setting the Robinhood key + using the openbb keys function. It includes source code, parameters description, + return types, and usage examples. This Python SDK function allows users to handle + their Robinhood key in different environments including Jupyter notebook sessions + and terminal environment variables. +keywords: +- Robinhood +- keys +- username and password +- API key +- Jupyter notebook session +- terminal environment variables +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Set Robinhood key + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/keys_model.py#L1227)] + +```python +openbb.keys.rh(username: str, password: str, persist: bool = False, show_output: bool = False) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| username | str | User username | None | False | +| password | str | User password | None | False | +| persist | bool | If False, api key change will be contained to where it was changed. For example, a Jupyter notebook session.
If True, api key change will be global, i.e. it will affect terminal environment variables.
By default, False. | False | True | +| show_output | bool | Display status string or not. By default, False. | False | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| str | Status of key set | +--- + +## Examples + +```python +from openbb_terminal.sdk import openbb +openbb.keys.rh( +``` + +``` +username="example_username", + password="example_password" + ) +``` +--- diff --git a/website/content/sdk/reference/keys/santiment.md b/website/content/sdk/reference/keys/santiment.md new file mode 100644 index 000000000000..4d0969ef14fd --- /dev/null +++ b/website/content/sdk/reference/keys/santiment.md @@ -0,0 +1,56 @@ +--- +title: santiment +description: Detailed documentation on how to set the Santiment API key using the + OpenBB-Terminal SDK. Instructions and examples are provided, including parameters + for optional persistence and output display. +keywords: +- Santiment key +- API key +- OpenBB-Terminal +- SEO for Documentation +- Document SEO +- Persist Key +- Show Output +- Jupyter Notebook +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Set Santiment key. + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/keys_model.py#L2335)] + +```python +openbb.keys.santiment(key: str, persist: bool = False, show_output: bool = False) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| key | str | API key | None | False | +| persist | bool | If False, api key change will be contained to where it was changed. For example, a Jupyter notebook session.
If True, api key change will be global, i.e. it will affect terminal environment variables.
By default, False. | False | True | +| show_output | bool | Display status string or not. By default, False. | False | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| str | Status of key set | +--- + +## Examples + +```python +from openbb_terminal.sdk import openbb +openbb.keys.santiment(key="example_key") +``` + +--- diff --git a/website/content/sdk/reference/keys/set_keys.md b/website/content/sdk/reference/keys/set_keys.md new file mode 100644 index 000000000000..29111e803465 --- /dev/null +++ b/website/content/sdk/reference/keys/set_keys.md @@ -0,0 +1,65 @@ +--- +title: set_keys +description: Guide on how to set API keys in bundle with OpenBB finance terminal, + including parameters, return values and examples. Contains source code link +keywords: +- OpenBB terminal +- API keys +- Set keys +- Python code +- Source code +- Jupyter notebook +- Finance +- Environment variables +- Programming guide +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Set API keys in bundle. + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/keys_model.py#L116)] + +```python +openbb.keys.set_keys(keys_dict: Dict[str, Dict[str, Union[str, bool]]], persist: bool = False, show_output: bool = False) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| keys_dict | Dict[str, Dict[str, Union[str, bool]]] | More info on the required inputs for each API can be found on `keys.get_keys_info()` | None | False | +| persist | bool | If False, api key change will be contained to where it was changed. For example, a Jupyter notebook session.
If True, api key change will be global, i.e. it will affect terminal environment variables.
By default, False. | False | True | +| show_output | bool | Display status string or not. By default, False. | False | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| Dict | Status of each key set. | +--- + +## Examples + +```python +from openbb_terminal.sdk import openbb +d = { +``` + +``` +"fred": {"key": "XXXXX"}, + "binance": {"key": "YYYYY", "secret": "ZZZZZ"}, + } +``` +```python +openbb.keys.set_keys(keys_dict=d) +``` + +--- diff --git a/website/content/sdk/reference/keys/si.md b/website/content/sdk/reference/keys/si.md new file mode 100644 index 000000000000..e5174c9979aa --- /dev/null +++ b/website/content/sdk/reference/keys/si.md @@ -0,0 +1,53 @@ +--- +title: si +description: This page provides a guide on how to set the Sentimentinvestor key using + OpenBB terminal. It explains the parameters and returns of the function, including + examples demonstrating its use. +keywords: +- Sentimentinvestor +- API key +- OpenBB terminal +- terminal environment variables +- Jupyter notebook +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Set Sentimentinvestor key. + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/keys_model.py#L1548)] + +```python +openbb.keys.si(key: str, persist: bool = False, show_output: bool = False) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| key | str | API key | None | False | +| persist | bool | If False, api key change will be contained to where it was changed. For example, a Jupyter notebook session.
If True, api key change will be global, i.e. it will affect terminal environment variables.
By default, False. | False | True | +| show_output | bool | Display status string or not. By default, False. | False | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| str | Status of key set | +--- + +## Examples + +```python +from openbb_terminal.sdk import openbb +openbb.keys.si(key="example_key") +``` + +--- diff --git a/website/content/sdk/reference/keys/smartstake.md b/website/content/sdk/reference/keys/smartstake.md new file mode 100644 index 000000000000..f709973b185d --- /dev/null +++ b/website/content/sdk/reference/keys/smartstake.md @@ -0,0 +1,61 @@ +--- +title: smartstake +description: The page provides detailed documentation on 'smartstake' function of + the OpenBB Python SDK. This function is used to set the SmartStake API key for the + current session or globally in terminal environment. Includes examples of usage + and link to source code. +keywords: +- SmartStake API key +- API key setting +- Python function +- docusaurus documentation +- programming +- environment variables +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Set Smartstake key. + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/keys_model.py#L2057)] + +```python +openbb.keys.smartstake(key: str, access_token: str, persist: bool = False, show_output: bool = False) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| key | str | API key | None | False | +| access_token | str | API token | None | False | +| persist | bool | If False, api key change will be contained to where it was changed. For example, a Jupyter notebook session.
If True, api key change will be global, i.e. it will affect terminal environment variables.
By default, False. | False | True | +| show_output | bool | Display status string or not. By default, False. | False | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| str | Status of key set | +--- + +## Examples + +```python +from openbb_terminal.sdk import openbb +openbb.keys.smartstake( +``` + +``` +key="example_key", + access_token="example_access_token", + ) +``` +--- diff --git a/website/content/sdk/reference/keys/stocksera.md b/website/content/sdk/reference/keys/stocksera.md new file mode 100644 index 000000000000..b13053de41fc --- /dev/null +++ b/website/content/sdk/reference/keys/stocksera.md @@ -0,0 +1,52 @@ +--- +title: stocksera +description: 'The OpenBB project: how to set your Stocksera API key using Python. + Documentation provides information about parameters, return types, and examples + for the stocksera method.' +keywords: +- Stocksera +- API Key +- Jupyter Notebook +- Environment Variables +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Set Stocksera key. + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/keys_model.py#L2545)] + +```python +openbb.keys.stocksera(key: str, persist: bool = False, show_output: bool = False) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| key | str | API key | None | False | +| persist | bool | If False, api key change will be contained to where it was changed. For example, a Jupyter notebook session.
If True, api key change will be global, i.e. it will affect terminal environment variables.
By default, False. | False | True | +| show_output | bool | Display status string or not. By default, False. | False | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| str | Status of key set | +--- + +## Examples + +```python +from openbb_terminal.sdk import openbb +openbb.keys.stocksera(key="example_key") +``` + +--- diff --git a/website/content/sdk/reference/keys/tokenterminal.md b/website/content/sdk/reference/keys/tokenterminal.md new file mode 100644 index 000000000000..aef23ec13637 --- /dev/null +++ b/website/content/sdk/reference/keys/tokenterminal.md @@ -0,0 +1,55 @@ +--- +title: tokenterminal +description: This documentation page deals with the 'tokenterminal' function of the + OpenBB finance terminal. It allows users to set a Token Terminal key, which, depending + on the parameters, can be limited to the current session or applied globally. A + use-case example is also included. +keywords: +- Token Terminal Key +- API Key +- Finance Terminal +- tokenterminal Function +- Terminal Environment Variables +- Jupyter Notebook +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Set Token Terminal key. + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/keys_model.py#L2483)] + +```python +openbb.keys.tokenterminal(key: str, persist: bool = False, show_output: bool = False) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| key | str | API key | None | False | +| persist | bool | If False, api key change will be contained to where it was changed. For example, a Jupyter notebook session.
If True, api key change will be global, i.e. it will affect terminal environment variables.
By default, False. | False | True | +| show_output | bool | Display status string or not. By default, False. | False | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| str | Status of key set | +--- + +## Examples + +```python +from openbb_terminal.sdk import openbb +openbb.keys.tokenterminal(key="example_key") +``` + +--- diff --git a/website/content/sdk/reference/keys/tradier.md b/website/content/sdk/reference/keys/tradier.md new file mode 100644 index 000000000000..eb68b0e3252a --- /dev/null +++ b/website/content/sdk/reference/keys/tradier.md @@ -0,0 +1,56 @@ +--- +title: tradier +description: Learn how to set a Tradier API key in the OpenBB terminal using the 'openbb.keys.tradier' + Python function. This documentation provides parameter info, function usage, and + examples. +keywords: +- tradier +- api key +- openbb terminal +- sdk +- openbb keys tradier +- terminal environment variables +- function usage +- examples +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Set Tradier key + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/keys_model.py#L680)] + +```python +openbb.keys.tradier(key: str, persist: bool = False, show_output: bool = False) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| key | str | API key | None | False | +| persist | bool | If False, api key change will be contained to where it was changed. For example, a Jupyter notebook session.
If True, api key change will be global, i.e. it will affect terminal environment variables.
By default, False. | False | True | +| show_output | bool | Display status string or not. By default, False. | False | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| str | Status of key set | +--- + +## Examples + +```python +from openbb_terminal.sdk import openbb +openbb.keys.tradier(key="example_key") +``` + +--- diff --git a/website/content/sdk/reference/keys/twitter.md b/website/content/sdk/reference/keys/twitter.md new file mode 100644 index 000000000000..79aa00bc5307 --- /dev/null +++ b/website/content/sdk/reference/keys/twitter.md @@ -0,0 +1,66 @@ +--- +title: twitter +description: This page explains how to set a Twitter API key in OpenBB Terminal, including + a detailed explanation of parameters and example code. Learn how to use OpenBB to + interact with Twitter's API. +keywords: +- Twitter API +- API key +- Coding examples +- Jupyter notebook +- openbb keys twitter +- Environment variables +- API secret +- API token +- persist +- show_output +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Set Twitter key + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/keys_model.py#L1132)] + +```python +openbb.keys.twitter(key: str, secret: str, access_token: str, persist: bool = False, show_output: bool = False) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| key | str | API key | None | False | +| secret | str | API secret | None | False | +| access_token | str | API token | None | False | +| persist | bool | If False, api key change will be contained to where it was changed. For example, a Jupyter notebook session.
If True, api key change will be global, i.e. it will affect terminal environment variables.
By default, False. | False | True | +| show_output | bool | Display status string or not. By default, False. | False | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| str | Status of key set | +--- + +## Examples + +```python +from openbb_terminal.sdk import openbb +openbb.keys.twitter( +``` + +``` +key="example_key", + secret="example_secret", + access_token="example_access_token" + ) +``` +--- diff --git a/website/content/sdk/reference/keys/walert.md b/website/content/sdk/reference/keys/walert.md new file mode 100644 index 000000000000..05d5bfdf411e --- /dev/null +++ b/website/content/sdk/reference/keys/walert.md @@ -0,0 +1,57 @@ +--- +title: walert +description: This documentation page describes how to set the Walert key in OpenBB + finance's Terminal. It details the parameters, return types and provides examples + for setting the API key. +keywords: +- API key set +- Walert key +- Python code +- Source code +- terminal environment variables +- Jupyter notebook session +- financial software +- web development +- SEO optimization +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Set Walert key + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/keys_model.py#L1711)] + +```python +openbb.keys.walert(key: str, persist: bool = False, show_output: bool = False) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| key | str | API key | None | False | +| persist | bool | If False, api key change will be contained to where it was changed. For example, a Jupyter notebook session.
If True, api key change will be global, i.e. it will affect terminal environment variables.
By default, False. | False | True | +| show_output | bool | Display status string or not. By default, False. | False | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| str | Status of key set | +--- + +## Examples + +```python +from openbb_terminal.sdk import openbb +openbb.keys.walert(key="example_key") +``` + +--- diff --git a/website/content/sdk/reference/news.md b/website/content/sdk/reference/news.md new file mode 100644 index 000000000000..cdcea9c569ab --- /dev/null +++ b/website/content/sdk/reference/news.md @@ -0,0 +1,54 @@ +--- +title: news +description: This documentation page provides detailed information on how to retrieve + news articles using the OpenBBTerminal's function 'openbb.news'. The function allows + users to specify search terms, sources, and sorting parameters. Examples of using + the function are also provided. +keywords: +- News +- Feedparser +- Source Code +- openbb news +- News Article Search +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Get news for a given term and source. [Source: Feedparser] + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/common/feedparser_model.py#L13)] + +```python +openbb.news(term: str = "", sources: str = "", sort: str = "published") +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| term | str | term to search on the news articles | | True | +| sources | str | sources to exclusively show news from (separated by commas) | | True | +| sort | str | the column to sort by | published | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | term to search on the news articles | +--- + +## Examples + +```python +from openbb_terminal.sdk import openbb +openbb.news() +``` + +--- diff --git a/website/content/sdk/reference/portfolio/alloc/assets.md b/website/content/sdk/reference/portfolio/alloc/assets.md new file mode 100644 index 000000000000..0e24073c6c26 --- /dev/null +++ b/website/content/sdk/reference/portfolio/alloc/assets.md @@ -0,0 +1,56 @@ +--- +title: assets +description: This tutorial page provides information about the 'assets' function in + the OpenBB Terminal's Portfolio module, how to implement it and its parameters. + The 'assets' function is used to display a portfolio's asset allocation as compared + to the benchmark. +keywords: +- Portfolio module +- assets function +- portfolio asset allocation +- benchmark comparison +- function parameters +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Display portfolio asset allocation compared to the benchmark + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/portfolio/portfolio_model.py#L770)] + +```python +openbb.portfolio.alloc.assets(portfolio_engine: portfolio_engine.PortfolioEngine, tables: bool = False, limit: int = 10, recalculate: bool = False) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| portfolio_engine | PortfolioEngine | PortfolioEngine class instance, this will hold transactions and perform calculations.
Use `portfolio.load` to create a PortfolioEngine. | None | False | +| tables | bool | Whether to include separate allocation tables | False | True | +| limit | int | The amount of assets you wish to show, by default this is set to 10 | 10 | True | +| recalculate | bool | Flag to force recalculate allocation if already exists | False | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| Union[pd.DataFrame, Tuple[pd.DataFrame, pd.DataFrame, pd.DataFrame]] | DataFrame with combined allocation plus individual allocation if tables is `True`. | +--- + +## Examples + +```python +from openbb_terminal.sdk import openbb +p = openbb.portfolio.load("openbb_terminal/miscellaneous/portfolio_examples/holdings/example.csv") +output = openbb.portfolio.alloc.assets(p) +``` + +--- diff --git a/website/content/sdk/reference/portfolio/alloc/countries.md b/website/content/sdk/reference/portfolio/alloc/countries.md new file mode 100644 index 000000000000..f0ab514961fc --- /dev/null +++ b/website/content/sdk/reference/portfolio/alloc/countries.md @@ -0,0 +1,55 @@ +--- +title: countries +description: This documentation page provides detailed information about the use of + the 'openbb.portfolio.alloc.countries' function from OpenBB Finance, which compares + portfolio country allocation with a benchmark. +keywords: +- OpenBB Finance +- portfolio country allocation +- portfolio management +- financial modelling +- function documentation +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Display portfolio country allocation compared to the benchmark + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/portfolio/portfolio_model.py#L858)] + +```python +openbb.portfolio.alloc.countries(portfolio_engine: portfolio_engine.PortfolioEngine, limit: int = 10, tables: bool = False, recalculate: bool = False) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| portfolio_engine | PortfolioEngine | PortfolioEngine class instance, this will hold transactions and perform calculations.
Use `portfolio.load` to create a PortfolioEngine. | None | False | +| tables | bool | Whether to include separate allocation tables | False | True | +| limit | int | The amount of assets you wish to show, by default this is set to 10 | 10 | True | +| recalculate | bool | Flag to force recalculate allocation if already exists | False | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| Union[pd.DataFrame, Tuple[pd.DataFrame, pd.DataFrame, pd.DataFrame]] | DataFrame with combined allocation plus individual allocation if tables is `True`. | +--- + +## Examples + +```python +from openbb_terminal.sdk import openbb +p = openbb.portfolio.load("openbb_terminal/miscellaneous/portfolio_examples/holdings/example.csv") +output = openbb.portfolio.alloc.countries(p) +``` + +--- diff --git a/website/content/sdk/reference/portfolio/alloc/regions.md b/website/content/sdk/reference/portfolio/alloc/regions.md new file mode 100644 index 000000000000..4bfa3a9b054c --- /dev/null +++ b/website/content/sdk/reference/portfolio/alloc/regions.md @@ -0,0 +1,58 @@ +--- +title: regions +description: This page provides details about the 'regions' function of the OpenBB + finance platform. The said function displays the portfolio region allocation in + comparison to the benchmark. It includes a brief overview, parameters, return values, + and an example usage. +keywords: +- OpenBB finance platform +- portfolio region allocation +- benchmark comparison +- portfolio management +- portfolio allocation +- parameters +- example usage +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Display portfolio region allocation compared to the benchmark + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/portfolio/portfolio_model.py#L902)] + +```python +openbb.portfolio.alloc.regions(portfolio_engine: portfolio_engine.PortfolioEngine, limit: int = 10, tables: bool = False, recalculate: bool = False) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| portfolio_engine | PortfolioEngine | PortfolioEngine class instance, this will hold transactions and perform calculations.
Use `portfolio.load` to create a PortfolioEngine. | None | False | +| tables | bool | Whether to include separate allocation tables | False | True | +| limit | int | The amount of assets you wish to show, by default this is set to 10 | 10 | True | +| recalculate | bool | Flag to force recalculate allocation if already exists | False | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| Union[pd.DataFrame, Tuple[pd.DataFrame, pd.DataFrame, pd.DataFrame]] | DataFrame with combined allocation plus individual allocation if tables is `True`. | +--- + +## Examples + +```python +from openbb_terminal.sdk import openbb +p = openbb.portfolio.load("openbb_terminal/miscellaneous/portfolio_examples/holdings/example.csv") +output = openbb.portfolio.alloc.regions(p) +``` + +--- diff --git a/website/content/sdk/reference/portfolio/alloc/sectors.md b/website/content/sdk/reference/portfolio/alloc/sectors.md new file mode 100644 index 000000000000..2a15b58dddf9 --- /dev/null +++ b/website/content/sdk/reference/portfolio/alloc/sectors.md @@ -0,0 +1,58 @@ +--- +title: sectors +description: SEO for the 'sectors' documentation page of the OpenBB finance that elaborates + about portfolio sector allocation compared to the benchmark. +keywords: +- portfolio +- sector allocation +- benchmark +- parameters +- returns +- examples +- portfolio engine +- allocation tables +- recalculate allocation +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Display portfolio sector allocation compared to the benchmark + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/portfolio/portfolio_model.py#L814)] + +```python +openbb.portfolio.alloc.sectors(portfolio_engine: portfolio_engine.PortfolioEngine, limit: int = 10, tables: bool = False, recalculate: bool = False) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| portfolio_engine | PortfolioEngine | PortfolioEngine class instance, this will hold transactions and perform calculations.
Use `portfolio.load` to create a PortfolioEngine. | None | False | +| tables | bool | Whether to include separate allocation tables | False | True | +| limit | int | The amount of assets you wish to show, by default this is set to 10 | 10 | True | +| recalculate | bool | Flag to force recalculate allocation if already exists | False | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| Union[pd.DataFrame, Tuple[pd.DataFrame, pd.DataFrame, pd.DataFrame]] | DataFrame with combined allocation plus individual allocation if tables is `True`. | +--- + +## Examples + +```python +from openbb_terminal.sdk import openbb +p = openbb.portfolio.load("openbb_terminal/miscellaneous/portfolio_examples/holdings/example.csv") +output = openbb.portfolio.alloc.sectors(p) +``` + +--- diff --git a/website/content/sdk/reference/portfolio/bench.md b/website/content/sdk/reference/portfolio/bench.md new file mode 100644 index 000000000000..eba0f169da32 --- /dev/null +++ b/website/content/sdk/reference/portfolio/bench.md @@ -0,0 +1,54 @@ +--- +title: bench +description: This page discusses the 'bench' function, part of the OpenBB Terminal, + which allows users to load benchmarks into their portfolio. It provides details + on the parameters, method of application, and examples utilizing Python for portfolio + management. +keywords: +- portfolio benchmark +- portfolio management +- portfolio load +- financial data +- portfolio operations +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Load benchmark into portfolio + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/portfolio/portfolio_model.py#L93)] + +```python +openbb.portfolio.bench(portfolio_engine: portfolio_engine.PortfolioEngine, symbol: str, full_shares: bool = False) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| portfolio_engine | PortfolioEngine | PortfolioEngine class instance, this will hold transactions and perform calculations.
Use `portfolio.load` to create a PortfolioEngine. | None | False | +| symbol | str | Benchmark symbol to download data | None | False | +| full_shares | bool | Whether to mimic the portfolio trades exactly (partial shares) or round down the
quantity to the nearest number | False | True | + + +--- + +## Returns + +This function does not return anything + +--- + +## Examples + +```python +from openbb_terminal.sdk import openbb +p = openbb.portfolio.load("openbb_terminal/miscellaneous/portfolio_examples/holdings/example.csv") +output = openbb.portfolio.bench(p, symbol="SPY") +``` + +--- diff --git a/website/content/sdk/reference/portfolio/distr.md b/website/content/sdk/reference/portfolio/distr.md new file mode 100644 index 000000000000..0e100669b089 --- /dev/null +++ b/website/content/sdk/reference/portfolio/distr.md @@ -0,0 +1,98 @@ +--- +title: distr +description: This page provides documentation on using the 'distr' and 'distr_chart' + functions in OpenBB Terminal's Portfolio module. Learn how to display daily returns + and configure parameters like the PortfolioEngine instance and return intervals. +keywords: +- OpenBB Terminal documentation +- Portfolio Module +- Display Daily Returns +- PortfolioEngine instance +- Return intervals +- distr function +- distr_chart function +- Source Code +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + +Display daily returns + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/portfolio/portfolio_model.py#L441)] + +```python +openbb.portfolio.distr(portfolio_engine: portfolio_engine.PortfolioEngine, window: str = "all") +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| portfolio_engine | PortfolioEngine | PortfolioEngine class instance, this will hold transactions and perform calculations.
Use `portfolio.load` to create a PortfolioEngine. | None | False | +| window | str | interval to compare cumulative returns and benchmark | all | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | DataFrame of returns distribution | +--- + +## Examples + +```python +from openbb_terminal.sdk import openbb +p = openbb.portfolio.load("openbb_terminal/miscellaneous/portfolio_examples/holdings/example.csv") +output = openbb.portfolio.distr(p) +``` + +--- + + + + +Display daily returns + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/portfolio/portfolio_view.py#L626)] + +```python +openbb.portfolio.distr_chart(portfolio_engine: portfolio_engine.PortfolioEngine, window: str = "all", raw: bool = False, export: str = "", external_axes: Optional[matplotlib.axes._axes.Axes] = None) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| portfolio_returns | pd.Series | Returns of the portfolio | None | True | +| benchmark_returns | pd.Series | Returns of the benchmark | None | True | +| interval | str | interval to compare cumulative returns and benchmark | None | True | +| raw | False | Display raw data from cumulative return | False | True | +| export | str | Export certain type of data | | True | +| external_axes | plt.Axes | Optional axes to display plot on | None | True | + + +--- + +## Returns + +This function does not return anything + +--- + + + diff --git a/website/content/sdk/reference/portfolio/dret.md b/website/content/sdk/reference/portfolio/dret.md new file mode 100644 index 000000000000..4a0aca709082 --- /dev/null +++ b/website/content/sdk/reference/portfolio/dret.md @@ -0,0 +1,98 @@ +--- +title: dret +description: Detailed documentation for 'dret' function of OpenBB Terminal, allows + calculation of daily returns and visualization of these returns through charts. + This function manipulates and interprets portfolio data. +keywords: +- dret +- portfolio +- returns +- PortfolioEngine +- visualization +- dret_chart +- daily returns +- data analysis +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + +Get daily returns + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/portfolio/portfolio_model.py#L373)] + +```python +openbb.portfolio.dret(portfolio_engine: portfolio_engine.PortfolioEngine, window: str = "all") +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| portfolio_engine | PortfolioEngine | PortfolioEngine class instance, this will hold transactions and perform calculations.
Use `portfolio.load` to create a PortfolioEngine. | None | False | +| window | str | interval to compare cumulative returns and benchmark | all | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | DataFrame with daily returns | +--- + +## Examples + +```python +from openbb_terminal.sdk import openbb +p = openbb.portfolio.load("openbb_terminal/miscellaneous/portfolio_examples/holdings/example.csv") +output = openbb.portfolio.dret(p) +``` + +--- + + + + +Display daily returns + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/portfolio/portfolio_view.py#L557)] + +```python +openbb.portfolio.dret_chart(portfolio_engine: portfolio_engine.PortfolioEngine, window: str = "all", raw: bool = False, limit: int = 10, export: str = "", external_axes: Optional[matplotlib.axes._axes.Axes] = None) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| portfolio_engine | PortfolioEngine | PortfolioEngine class instance, this will hold transactions and perform calculations.
Use `portfolio.load` to create a PortfolioEngine. | None | False | +| window | str | interval to compare cumulative returns and benchmark | all | True | +| raw | False | Display raw data from cumulative return | False | True | +| limit | int | Last daily returns to display | 10 | True | +| export | str | Export certain type of data | | True | +| external_axes | plt.Axes | Optional axes to display plot on | None | True | + + +--- + +## Returns + +This function does not return anything + +--- + + + diff --git a/website/content/sdk/reference/portfolio/es.md b/website/content/sdk/reference/portfolio/es.md new file mode 100644 index 000000000000..7bcfd05e569d --- /dev/null +++ b/website/content/sdk/reference/portfolio/es.md @@ -0,0 +1,58 @@ +--- +title: es +description: Learn how to use the openbb.portfolio.es function to calculate the portfolio + expected shortfall. It allows the use of different distributions and custom percentiles. +keywords: +- openbb.portfolio.es +- Portfolio expected shortfall +- PortfolioEngine class +- Calculations on portfolio +- Portfolio distributions +- Portfolio percentiles +- openbb.portfolio.load +- Portfolio examples +- Python portfolio calculations +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Get portfolio expected shortfall + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/portfolio/portfolio_model.py#L1797)] + +```python +openbb.portfolio.es(portfolio_engine: portfolio_engine.PortfolioEngine, use_mean: bool = False, distribution: str = "normal", percentile: float = 99.9) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| portfolio_engine | PortfolioEngine | PortfolioEngine class instance, this will hold transactions and perform calculations.
Use `portfolio.load` to create a PortfolioEngine. | None | False | +| use_mean | | if one should use the data mean return | False | True | +| distribution | str | choose distribution to use: logistic, laplace, normal | normal | True | +| percentile | float | es percentile (%) | 99.9 | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | DataFrame with portfolio expected shortfall | +--- + +## Examples + +```python +from openbb_terminal.sdk import openbb +p = openbb.portfolio.load("openbb_terminal/miscellaneous/portfolio_examples/holdings/example.csv") +output = openbb.portfolio.es(p) +``` + +--- diff --git a/website/content/sdk/reference/portfolio/holdp.md b/website/content/sdk/reference/portfolio/holdp.md new file mode 100644 index 000000000000..bbd8305dda1f --- /dev/null +++ b/website/content/sdk/reference/portfolio/holdp.md @@ -0,0 +1,97 @@ +--- +title: holdp +description: This page provides comprehensive details on 'holdp', a function of the + OpenBBTerminal. It includes information on how to get holdings of assets in percentage, + parameters for the function, and examples of its use. +keywords: +- holdp function +- asset holding +- Percentage of assets +- PortfolioEngine +- Portfolio management +- Python functions +- openbb.portfolio +- Holdings calculation +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + +Get holdings of assets (in percentage) + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/portfolio/portfolio_model.py#L167)] + +```python +openbb.portfolio.holdp(portfolio_engine: portfolio_engine.PortfolioEngine) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| portfolio_engine | PortfolioEngine | PortfolioEngine class instance, this will hold transactions and perform calculations.
Use `portfolio.load` to create a PortfolioEngine. | None | False | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | DataFrame of holdings percentage | +--- + +## Examples + +```python +from openbb_terminal.sdk import openbb +p = openbb.portfolio.load("openbb_terminal/miscellaneous/portfolio_examples/holdings/example.csv") +output = openbb.portfolio.holdp(p) +``` + +--- + + + + +Display holdings of assets (in percentage) + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/portfolio/portfolio_view.py#L792)] + +```python +openbb.portfolio.holdp_chart(portfolio_engine: portfolio_engine.PortfolioEngine, unstack: bool = False, raw: bool = False, limit: int = 10, export: str = "", external_axes: Optional[matplotlib.axes._axes.Axes] = None) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| portfolio_engine | PortfolioEngine | PortfolioEngine class instance, this will hold transactions and perform calculations.
Use `portfolio.load` to create a PortfolioEngine. | None | False | +| unstack | bool | Individual assets over time | False | True | +| raw | bool | To display raw data | False | True | +| limit | int | Number of past market days to display holdings | 10 | True | +| export | str | Format to export plot | | True | +| external_axes | plt.Axes | Optional axes to display plot on | None | True | + + +--- + +## Returns + +This function does not return anything + +--- + + + diff --git a/website/content/sdk/reference/portfolio/holdv.md b/website/content/sdk/reference/portfolio/holdv.md new file mode 100644 index 000000000000..1568cbd4385a --- /dev/null +++ b/website/content/sdk/reference/portfolio/holdv.md @@ -0,0 +1,99 @@ +--- +title: holdv +description: Detailed documentation of the holdv function in portfolio module of OpenBB + finance dealing with getting and displaying holdings of assets. Learn how to use + and understand the parameters, source code and examples included. +keywords: +- OpenBB finance documentation +- holdv function OpenBB +- portfolio module OpenBB +- portfolio engine +- get holdings value +- holdv chart display +- assets holdings +- Python finance tools +- portfolio management OpenBB +- OpenBB assets management +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + +Get holdings of assets (absolute value) + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/portfolio/portfolio_model.py#L135)] + +```python +openbb.portfolio.holdv(portfolio_engine: portfolio_engine.PortfolioEngine) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| portfolio_engine | PortfolioEngine | PortfolioEngine class instance, this will hold transactions and perform calculations.
Use `portfolio.load` to create a PortfolioEngine. | None | False | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | DataFrame of holdings value | +--- + +## Examples + +```python +from openbb_terminal.sdk import openbb +p = openbb.portfolio.load("openbb_terminal/miscellaneous/portfolio_examples/holdings/example.csv") +output = openbb.portfolio.holdv(p) +``` + +--- + + + + +Display holdings of assets (absolute value) + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/portfolio/portfolio_view.py#L713)] + +```python +openbb.portfolio.holdv_chart(portfolio_engine: portfolio_engine.PortfolioEngine, unstack: bool = False, raw: bool = False, limit: int = 10, export: str = "", external_axes: Optional[matplotlib.axes._axes.Axes] = None) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| portfolio_engine | PortfolioEngine | PortfolioEngine class instance, this will hold transactions and perform calculations.
Use `portfolio.load` to create a PortfolioEngine. | None | False | +| unstack | bool | Individual assets over time | False | True | +| raw | bool | To display raw data | False | True | +| limit | int | Number of past market days to display holdings | 10 | True | +| export | str | Format to export plot | | True | +| external_axes | plt.Axes | Optional axes to display plot on | None | True | + + +--- + +## Returns + +This function does not return anything + +--- + + + diff --git a/website/content/sdk/reference/portfolio/load.md b/website/content/sdk/reference/portfolio/load.md new file mode 100644 index 000000000000..daa06a929003 --- /dev/null +++ b/website/content/sdk/reference/portfolio/load.md @@ -0,0 +1,58 @@ +--- +title: load +description: Docusaurus documentation for the load function from the openbb portfolio + module. Provides details about parameters and examples of how to use this function + to create a PortfolioEngine instance and perform portfolio calculations. +keywords: +- PortfolioEngine object +- openbb portfolio +- transactions file path +- benchmark symbol +- full shares +- risk free rate +- portfolio calculations +- openbb_terminal sdk +- Portfolio management +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Get PortfolioEngine object + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/portfolio/portfolio_model.py#L27)] + +```python +openbb.portfolio.load(transactions_file_path: str, benchmark_symbol: str = "SPY", full_shares: bool = False, risk_free_rate: float = 0) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| transactions_file_path | str | Path to transactions file | None | False | +| benchmark_symbol | str | Benchmark ticker to download data | SPY | True | +| full_shares | bool | Whether to mimic the portfolio trades exactly (partial shares) or round down the
quantity to the nearest number | False | True | +| risk_free_rate | float | Risk free rate in float format | 0 | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| PortfolioEngine | PortfolioEngine class instance, this will hold transactions and perform calculations | +--- + +## Examples + +```python +from openbb_terminal.sdk import openbb +p = openbb.portfolio.load("openbb_terminal/miscellaneous/portfolio_examples/holdings/example.csv") +``` + +--- diff --git a/website/content/sdk/reference/portfolio/maxdd.md b/website/content/sdk/reference/portfolio/maxdd.md new file mode 100644 index 000000000000..6f5a842a9070 --- /dev/null +++ b/website/content/sdk/reference/portfolio/maxdd.md @@ -0,0 +1,93 @@ +--- +title: maxdd +description: Documentation page providing details about the maximum drawdown calculation + in historical series and how to display the drawdown curve. Contains examples, parameters, + returns, and source code links. +keywords: +- maxdd +- PortfolioEngine +- maximum drawdown +- portfolio +- examples +- parameters +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + +Calculate the drawdown (MDD) of historical series. Note that the calculation is done + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/portfolio/portfolio_model.py#L482)] + +```python +openbb.portfolio.maxdd(portfolio_engine: portfolio_engine.PortfolioEngine, is_returns: bool = False) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| data | pd.Series | Series of input values | None | True | +| is_returns | bool | Flag to indicate inputs are returns | False | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.Series | Holdings series | +--- + +## Examples + +```python +from openbb_terminal.sdk import openbb +p = openbb.portfolio.load("openbb_terminal/miscellaneous/portfolio_examples/holdings/example.csv") +output = openbb.portfolio.maxdd(p) +``` + +--- + + + + +Display maximum drawdown curve + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/portfolio/portfolio_view.py#L1111)] + +```python +openbb.portfolio.maxdd_chart(portfolio_engine: portfolio_engine.PortfolioEngine, export: str = "", external_axes: Optional[List[matplotlib.axes._axes.Axes]] = None) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| portfolio | PortfolioEngine | PortfolioEngine object | None | True | +| export | str | Format to export data | | True | +| external_axes | plt.Axes | Optional axes to display plot on | None | True | + + +--- + +## Returns + +This function does not return anything + +--- + + + diff --git a/website/content/sdk/reference/portfolio/metric/calmar.md b/website/content/sdk/reference/portfolio/metric/calmar.md new file mode 100644 index 000000000000..4e35981b566e --- /dev/null +++ b/website/content/sdk/reference/portfolio/metric/calmar.md @@ -0,0 +1,58 @@ +--- +title: calmar +description: Documentation for the Calmar Ratio function in OpenBB Terminal, a Python + library. It includes parameters, type of return, and examples of use. This function + is a key tool for risk measurement in portfolio management, calculating the ratio + of the portfolio's performance to its downside risk. +keywords: +- calmar ratio +- OpenBB finance +- portfolio metrics +- portfolio analysis +- portfolio management +- risk measurement +- Python library +- benchmark performance +- financial data analysis +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Get calmar ratio + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/portfolio/portfolio_model.py#L1522)] + +```python +openbb.portfolio.metric.calmar(portfolio_engine: portfolio_engine.PortfolioEngine, window: int = 756) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| portfolio_engine | PortfolioEngine | PortfolioEngine class instance, this will hold transactions and perform calculations.
Use `portfolio.load` to create a PortfolioEngine. | None | False | +| window | int | Interval used for rolling values | 756 | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | DataFrame of calmar ratio of the benchmark and portfolio during different time periods | +--- + +## Examples + +```python +from openbb_terminal.sdk import openbb +p = openbb.portfolio.load("openbb_terminal/miscellaneous/portfolio_examples/holdings/example.csv") +output = openbb.portfolio.metric.calmar(p) +``` + +--- diff --git a/website/content/sdk/reference/portfolio/metric/commonsense.md b/website/content/sdk/reference/portfolio/metric/commonsense.md new file mode 100644 index 000000000000..5c19aa473b3d --- /dev/null +++ b/website/content/sdk/reference/portfolio/metric/commonsense.md @@ -0,0 +1,52 @@ +--- +title: commonsense +description: This documentation page includes details on how to get the commonsense + ratio for a portfolio within the OpenBB-framework using Python. It explains the + use of the PortfolioEngine class and provides examples using the openbb.portfolio.load + and openbb.portfolio.metric.commonsense functions. +keywords: +- commonsense ratio +- PortfolioEngine +- openbb.portfolio.load +- openbb.portfolio.metric.commonsense +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Get common sense ratio + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/portfolio/portfolio_model.py#L1448)] + +```python +openbb.portfolio.metric.commonsense(portfolio_engine: portfolio_engine.PortfolioEngine) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| portfolio_engine | PortfolioEngine | PortfolioEngine class instance, this will hold transactions and perform calculations.
Use `portfolio.load` to create a PortfolioEngine. | None | False | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | DataFrame of the portfolios and the benchmarks common sense ratio during different time periods | +--- + +## Examples + +```python +from openbb_terminal.sdk import openbb +p = openbb.portfolio.load("openbb_terminal/miscellaneous/portfolio_examples/holdings/example.csv") +output = openbb.portfolio.metric.commonsense(p) +``` + +--- diff --git a/website/content/sdk/reference/portfolio/metric/gaintopain.md b/website/content/sdk/reference/portfolio/metric/gaintopain.md new file mode 100644 index 000000000000..6d09ca709e86 --- /dev/null +++ b/website/content/sdk/reference/portfolio/metric/gaintopain.md @@ -0,0 +1,51 @@ +--- +title: gaintopain +description: On this page, learn how to use the gaintopain function from the openbb.portfolio.metric + package to compute a portfolio's gain-to-pain ratio based on historical data. Examples + and source code are provided. +keywords: +- openbb.portfolio.metric.gaintopain function +- portfolio's gain-to-pain ratio +- PortfolioEngine class +- compute gain-to-pain ratio +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Get Pain-to-Gain ratio based on historical data + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/portfolio/portfolio_model.py#L1313)] + +```python +openbb.portfolio.metric.gaintopain(portfolio_engine: portfolio_engine.PortfolioEngine) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| portfolio_engine | PortfolioEngine | PortfolioEngine class instance, this will hold transactions and perform calculations.
Use `portfolio.load` to create a PortfolioEngine. | None | False | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | DataFrame of the portfolio's gain-to-pain ratio | +--- + +## Examples + +```python +from openbb_terminal.sdk import openbb +p = openbb.portfolio.load("openbb_terminal/miscellaneous/portfolio_examples/holdings/example.csv") +output = openbb.portfolio.metric.gaintopain(p) +``` + +--- diff --git a/website/content/sdk/reference/portfolio/metric/information.md b/website/content/sdk/reference/portfolio/metric/information.md new file mode 100644 index 000000000000..90f25a366bf3 --- /dev/null +++ b/website/content/sdk/reference/portfolio/metric/information.md @@ -0,0 +1,52 @@ +--- +title: information +description: Documentation for the 'information' function of the OpenBB financial + library. It calculates the information ratio for different time periods based on + portfolio transactions. +keywords: +- financial library +- information ratio +- portfolio transactions +- portfolio metrics +- PortfolioEngine +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Get information ratio + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/portfolio/portfolio_model.py#L1379)] + +```python +openbb.portfolio.metric.information(portfolio_engine: portfolio_engine.PortfolioEngine) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| portfolio_engine | PortfolioEngine | PortfolioEngine class instance, this will hold transactions and perform calculations.
Use `portfolio.load` to create a PortfolioEngine. | None | False | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | DataFrame of the information ratio during different time periods | +--- + +## Examples + +```python +from openbb_terminal.sdk import openbb +p = openbb.portfolio.load("openbb_terminal/miscellaneous/portfolio_examples/holdings/example.csv") +output = openbb.portfolio.metric.information(p) +``` + +--- diff --git a/website/content/sdk/reference/portfolio/metric/jensens.md b/website/content/sdk/reference/portfolio/metric/jensens.md new file mode 100644 index 000000000000..95dda1803683 --- /dev/null +++ b/website/content/sdk/reference/portfolio/metric/jensens.md @@ -0,0 +1,58 @@ +--- +title: jensens +description: The jensen's alpha function allows evaluation of portfolio performance, + taking into account a risk-free rate and an interval for rolling values. Supported + by OpenBB portfolio, a source for open source finance tools. +keywords: +- jensen's alpha +- openbb portfolio +- portfolio evaluation +- portfolio metrics +- portfolio analysis +- portfolio performance +- risk free rate +- rolling values +- open source finance +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Get jensen's alpha + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/portfolio/portfolio_model.py#L1480)] + +```python +openbb.portfolio.metric.jensens(portfolio_engine: portfolio_engine.PortfolioEngine, risk_free_rate: float = 0, window: str = "1y") +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| portfolio_engine | PortfolioEngine | PortfolioEngine class instance, this will hold transactions and perform calculations.
Use `portfolio.load` to create a PortfolioEngine. | None | False | +| window | str | Interval used for rolling values | 1y | True | +| risk_free_rate | float | Risk free rate | 0 | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | DataFrame of jensens's alpha during different time windows | +--- + +## Examples + +```python +from openbb_terminal.sdk import openbb +p = openbb.portfolio.load("openbb_terminal/miscellaneous/portfolio_examples/holdings/example.csv") +output = openbb.portfolio.metric.jensens(p) +``` + +--- diff --git a/website/content/sdk/reference/portfolio/metric/kelly.md b/website/content/sdk/reference/portfolio/metric/kelly.md new file mode 100644 index 000000000000..f9e52167ad32 --- /dev/null +++ b/website/content/sdk/reference/portfolio/metric/kelly.md @@ -0,0 +1,53 @@ +--- +title: kelly +description: This page provides information on how to use the 'kelly' function from + the OpenBB portfolio management library. With detailed parameter explanations to + calculate the kelly criterion and examples of usage, it is a valuable reference + for portfolio management within the OpenBB environment. +keywords: +- kelly criterion +- portfolio management +- openbb.portfolio.metric.kelly +- portfolio engine +- portfolio load +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Get kelly criterion + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/portfolio/portfolio_model.py#L1561)] + +```python +openbb.portfolio.metric.kelly(portfolio_engine: portfolio_engine.PortfolioEngine) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| portfolio_engine | PortfolioEngine | PortfolioEngine class instance, this will hold transactions and perform calculations.
Use `portfolio.load` to create a PortfolioEngine. | None | False | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | DataFrame of kelly criterion of the portfolio during different time periods | +--- + +## Examples + +```python +from openbb_terminal.sdk import openbb +p = openbb.portfolio.load("openbb_terminal/miscellaneous/portfolio_examples/holdings/example.csv") +output = openbb.portfolio.metric.kelly(p) +``` + +--- diff --git a/website/content/sdk/reference/portfolio/metric/kurtosis.md b/website/content/sdk/reference/portfolio/metric/kurtosis.md new file mode 100644 index 000000000000..ee6f9dd5a4c3 --- /dev/null +++ b/website/content/sdk/reference/portfolio/metric/kurtosis.md @@ -0,0 +1,54 @@ +--- +title: kurtosis +description: This documentation page provides information on how to get the kurtosis + for portfolio and benchmark selected using the OpenBB finance portfolio engine. + The page contains source code, parameters, return types and examples. +keywords: +- OpenBB finance portfolio engine +- portfolio metrics +- kurtosis +- portfolio and benchmark +- data analysis +- PortfolioEngine class instance +- portfolio load +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Get kurtosis for portfolio and benchmark selected + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/portfolio/portfolio_model.py#L1032)] + +```python +openbb.portfolio.metric.kurtosis(portfolio_engine: portfolio_engine.PortfolioEngine) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| portfolio_engine | PortfolioEngine | PortfolioEngine class instance, this will hold transactions and perform calculations.
Use `portfolio.load` to create a PortfolioEngine. | None | False | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | DataFrame with kurtosis for portfolio and benchmark for different periods | +--- + +## Examples + +```python +from openbb_terminal.sdk import openbb +p = openbb.portfolio.load("openbb_terminal/miscellaneous/portfolio_examples/holdings/example.csv") +output = openbb.portfolio.metric.kurtosis(p) +``` + +--- diff --git a/website/content/sdk/reference/portfolio/metric/maxdrawdown.md b/website/content/sdk/reference/portfolio/metric/maxdrawdown.md new file mode 100644 index 000000000000..f2d47ef60d2c --- /dev/null +++ b/website/content/sdk/reference/portfolio/metric/maxdrawdown.md @@ -0,0 +1,55 @@ +--- +title: maxdrawdown +description: This page provides details on how to get the maximum drawdown ratio for + a selected portfolio and benchmark using the 'maxdrawdown' function in the OpenBB + application. Learn how to effectively use and apply this feature in your portfolio + management practice. +keywords: +- Portfolio Management +- Benchmarking +- Maximum Drawdown +- Metrics +- PortfolioEngine +- Portfolio analysis +- Market analysis +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Get maximum drawdown ratio for portfolio and benchmark selected + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/portfolio/portfolio_model.py#L1266)] + +```python +openbb.portfolio.metric.maxdrawdown(portfolio_engine: portfolio_engine.PortfolioEngine) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| portfolio_engine | PortfolioEngine | PortfolioEngine class instance, this will hold transactions and perform calculations.
Use `portfolio.load` to create a PortfolioEngine. | None | False | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | DataFrame with maximum drawdown for portfolio and benchmark for different periods | +--- + +## Examples + +```python +from openbb_terminal.sdk import openbb +p = openbb.portfolio.load("openbb_terminal/miscellaneous/portfolio_examples/holdings/example.csv") +output = openbb.portfolio.metric.maxdrawdown(p) +``` + +--- diff --git a/website/content/sdk/reference/portfolio/metric/payoff.md b/website/content/sdk/reference/portfolio/metric/payoff.md new file mode 100644 index 000000000000..087a1f38f9b7 --- /dev/null +++ b/website/content/sdk/reference/portfolio/metric/payoff.md @@ -0,0 +1,52 @@ +--- +title: payoff +description: Documentation for openbb.portfolio.metric.payoff function. This function + allows to get the payoff ratio of a portfolio during different time periods. The + function does not take any parameters and returns a DataFrame with values. +keywords: +- payoff ratio +- portfolio +- time periods +- portfolio metric +- no losing trades +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Get payoff ratio + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/portfolio/portfolio_model.py#L1590)] + +```python +openbb.portfolio.metric.payoff(portfolio_engine: portfolio_engine.PortfolioEngine) +``` + +--- + +## Parameters + +This function does not take any parameters. + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | DataFrame of payoff ratio of the portfolio during different time periods | +--- + +## Examples + +```python +from openbb_terminal.sdk import openbb +p = openbb.portfolio.load("openbb_terminal/miscellaneous/portfolio_examples/holdings/example.csv") +output = openbb.portfolio.metric.payoff(p) +``` + +``` +During some time periods there were no losing trades. Thus some values could not be calculated. +``` +--- diff --git a/website/content/sdk/reference/portfolio/metric/profitfactor.md b/website/content/sdk/reference/portfolio/metric/profitfactor.md new file mode 100644 index 000000000000..b6def111d945 --- /dev/null +++ b/website/content/sdk/reference/portfolio/metric/profitfactor.md @@ -0,0 +1,57 @@ +--- +title: profitfactor +description: This page provides detailed information regarding the 'profitfactor' + function in the openbb.portfolio.metric package. It includes a brief description, + parameters details, returns types, and some examples of usage. +keywords: +- openbb portfolio metric +- profitfactor function +- PortfolioEngine +- code example +- openbb.portfolio.load +- trading portfolio +- profit factor +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Get profit factor + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/portfolio/portfolio_model.py#L1612)] + +```python +openbb.portfolio.metric.profitfactor(portfolio_engine: portfolio_engine.PortfolioEngine) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| portfolio_engine | PortfolioEngine | PortfolioEngine class instance, this will hold transactions and perform calculations.
Use `portfolio.load` to create a PortfolioEngine. | None | False | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | DataFrame of profit factor of the portfolio during different time periods | +--- + +## Examples + +```python +from openbb_terminal.sdk import openbb +p = openbb.portfolio.load("openbb_terminal/miscellaneous/portfolio_examples/holdings/example.csv") +output = openbb.portfolio.metric.profitfactor(p) +``` + +``` +During some time periods there were no losing trades. Thus some values could not be calculated. +``` +--- diff --git a/website/content/sdk/reference/portfolio/metric/rsquare.md b/website/content/sdk/reference/portfolio/metric/rsquare.md new file mode 100644 index 000000000000..aafa026fce0a --- /dev/null +++ b/website/content/sdk/reference/portfolio/metric/rsquare.md @@ -0,0 +1,53 @@ +--- +title: rsquare +description: Detailed information about using the 'rsquare' function in the 'openbb' + portfolio metric, which calculates the R2 Score between a portfolio and a selected + benchmark. The page includes examples of usage. +keywords: +- portfolio +- benchmark +- R2 Score +- PortfolioEngine +- openbb.portfolio.metric.rsquare +- openbb.portfolio.load +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Get R2 Score for portfolio and benchmark selected + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/portfolio/portfolio_model.py#L947)] + +```python +openbb.portfolio.metric.rsquare(portfolio_engine: portfolio_engine.PortfolioEngine) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| portfolio_engine | PortfolioEngine | PortfolioEngine class instance, this will hold transactions and perform calculations.
Use `portfolio.load` to create a PortfolioEngine. | None | False | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | DataFrame with R2 Score between portfolio and benchmark for different periods | +--- + +## Examples + +```python +from openbb_terminal.sdk import openbb +p = openbb.portfolio.load("openbb_terminal/miscellaneous/portfolio_examples/holdings/example.csv") +output = openbb.portfolio.metric.rsquare(p) +``` + +--- diff --git a/website/content/sdk/reference/portfolio/metric/sharpe.md b/website/content/sdk/reference/portfolio/metric/sharpe.md new file mode 100644 index 000000000000..b945bc3e7561 --- /dev/null +++ b/website/content/sdk/reference/portfolio/metric/sharpe.md @@ -0,0 +1,59 @@ +--- +title: sharpe +description: Get sharpe ratio for a portfolio and benchmark using the OpenBB Terminal. + This page provides a detailed description of how to use the Sharpe ratio function + with code examples in Python. +keywords: +- Sharpe ratio +- portfolio +- PortfolioEngine +- risk_free_rate +- openbb.portfolio.metric.sharpe +- financial metrics +- OpenBB finance +- portfolio analysis +- benchmark +- portfolio management +- risk analysis +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Get sharpe ratio for portfolio and benchmark selected + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/portfolio/portfolio_model.py#L1160)] + +```python +openbb.portfolio.metric.sharpe(portfolio_engine: portfolio_engine.PortfolioEngine, risk_free_rate: float = 0) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| portfolio_engine | PortfolioEngine | PortfolioEngine class instance, this will hold transactions and perform calculations.
Use `portfolio.load` to create a PortfolioEngine. | None | False | +| risk_free_rate | float | Risk free rate value | 0 | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | DataFrame with sharpe ratio for portfolio and benchmark for different periods | +--- + +## Examples + +```python +from openbb_terminal.sdk import openbb +p = openbb.portfolio.load("openbb_terminal/miscellaneous/portfolio_examples/holdings/example.csv") +output = openbb.portfolio.metric.sharpe(p) +``` + +--- diff --git a/website/content/sdk/reference/portfolio/metric/skew.md b/website/content/sdk/reference/portfolio/metric/skew.md new file mode 100644 index 000000000000..5a4546af782d --- /dev/null +++ b/website/content/sdk/reference/portfolio/metric/skew.md @@ -0,0 +1,52 @@ +--- +title: skew +description: Understand how to calculate portfolio and benchmark skewness with the + OpenBBTerminal. Explore source code examples demonstrating how to harness Python + for financial metric calculations. +keywords: +- portfolio skewness +- benchmark skewness +- OpenBB finance +- financial metrics +- portfolio metrics +- Python financial analysis +- skew function +- OpenBBTerminal examples +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Get skewness for portfolio and benchmark selected + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/portfolio/portfolio_model.py#L987)] + +```python +openbb.portfolio.metric.skew(portfolio_engine: portfolio_engine.PortfolioEngine) +``` + +--- + +## Parameters + +This function does not take any parameters. + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | DataFrame with skewness for portfolio and benchmark for different periods | +--- + +## Examples + +```python +from openbb_terminal.sdk import openbb +p = openbb.portfolio.load("openbb_terminal/miscellaneous/portfolio_examples/holdings/example.csv") +output = openbb.portfolio.metric.skew(p) +``` + +--- diff --git a/website/content/sdk/reference/portfolio/metric/sortino.md b/website/content/sdk/reference/portfolio/metric/sortino.md new file mode 100644 index 000000000000..004a558c6593 --- /dev/null +++ b/website/content/sdk/reference/portfolio/metric/sortino.md @@ -0,0 +1,54 @@ +--- +title: sortino +description: This page includes a comprehensive coverage of how to determine the Sortino + ratio of a portfolio with reference to a selected benchmark using OpenBB. The page + contains the source code and specific examples to better illustrate the process. +keywords: +- sortino ratio +- portfolio analysis +- risk free rate +- openbb.portfolio.metric.sortino +- portfolio +- benchmark +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Get sortino ratio for portfolio and benchmark selected + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/portfolio/portfolio_model.py#L1213)] + +```python +openbb.portfolio.metric.sortino(portfolio_engine: portfolio_engine.PortfolioEngine, risk_free_rate: float = 0) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| portfolio_engine | PortfolioEngine | PortfolioEngine class instance, this will hold transactions and perform calculations.
Use `portfolio.load` to create a PortfolioEngine. | None | False | +| risk_free_rate | float | Risk free rate value | 0 | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | DataFrame with sortino ratio for portfolio and benchmark for different periods | +--- + +## Examples + +```python +from openbb_terminal.sdk import openbb +p = openbb.portfolio.load("openbb_terminal/miscellaneous/portfolio_examples/holdings/example.csv") +output = openbb.portfolio.metric.sortino(p) +``` + +--- diff --git a/website/content/sdk/reference/portfolio/metric/tail.md b/website/content/sdk/reference/portfolio/metric/tail.md new file mode 100644 index 000000000000..4eacd0a94baa --- /dev/null +++ b/website/content/sdk/reference/portfolio/metric/tail.md @@ -0,0 +1,55 @@ +--- +title: tail +description: Documentation about the OpenBB terminal's 'tail' function. The function + retrieves the tail ratio of portfolios, handling transactions and performing calculations. + Also gives details about its parameters, return types, and example usage. +keywords: +- OpenBB terminal +- tail function +- PortfolioEngine class instance +- portfolio metrics +- transactions +- calculations +- tail ratio +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Get tail ratio + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/portfolio/portfolio_model.py#L1411)] + +```python +openbb.portfolio.metric.tail(portfolio_engine: portfolio_engine.PortfolioEngine, window: int = 252) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| portfolio_engine | PortfolioEngine | PortfolioEngine class instance, this will hold transactions and perform calculations.
Use `portfolio.load` to create a PortfolioEngine. | None | False | +| window | int | Interval used for rolling values | 252 | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | DataFrame of the portfolios and the benchmarks tail ratio during different time windows | +--- + +## Examples + +```python +from openbb_terminal.sdk import openbb +p = openbb.portfolio.load("openbb_terminal/miscellaneous/portfolio_examples/holdings/example.csv") +output = openbb.portfolio.metric.tail(p) +``` + +--- diff --git a/website/content/sdk/reference/portfolio/metric/trackerr.md b/website/content/sdk/reference/portfolio/metric/trackerr.md new file mode 100644 index 000000000000..d83e7b5de578 --- /dev/null +++ b/website/content/sdk/reference/portfolio/metric/trackerr.md @@ -0,0 +1,60 @@ +--- +title: trackerr +description: The 'trackerr' method in openbb.portfolio.metric provides tracking errors + over different time windows for a given portfolio. It uses the PortfolioEngine instance + and has an optional window parameter for rolling values. You need to call portfolio.load + to create a PortfolioEngine instance. +keywords: +- trackerr +- PortfolioEngine +- tracking errors +- openbb portfolio +- portfolio metrics +- Portfolio calculation +- python portfolio +- openbb_terminal.sdk +- openbb portfolio load +- openbb portfolio metric +- Finance portfolio +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Get tracking error + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/portfolio/portfolio_model.py#L1344)] + +```python +openbb.portfolio.metric.trackerr(portfolio_engine: portfolio_engine.PortfolioEngine, window: int = 252) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| portfolio_engine | PortfolioEngine | PortfolioEngine class instance, this will hold transactions and perform calculations.
Use `portfolio.load` to create a PortfolioEngine. | None | False | +| window | int | Interval used for rolling values | 252 | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | DataFrame of tracking errors during different time windows | +--- + +## Examples + +```python +from openbb_terminal.sdk import openbb +p = openbb.portfolio.load("openbb_terminal/miscellaneous/portfolio_examples/holdings/example.csv") +output = openbb.portfolio.metric.trackerr(p) +``` + +--- diff --git a/website/content/sdk/reference/portfolio/metric/volatility.md b/website/content/sdk/reference/portfolio/metric/volatility.md new file mode 100644 index 000000000000..5c4e3ea6df57 --- /dev/null +++ b/website/content/sdk/reference/portfolio/metric/volatility.md @@ -0,0 +1,53 @@ +--- +title: volatility +description: The volatility documentation page covers the important use of volatility + method for portfolio and benchmark selected using the Python module openbb. Key + concepts include usage of PortfolioEngine, DataFrame and function calls. +keywords: +- volatility +- portfolio +- benchmark +- openbb.portfolio.metric.volatility +- portfolio_engine +- openbb.portfolio.load +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Get volatility for portfolio and benchmark selected + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/portfolio/portfolio_model.py#L1111)] + +```python +openbb.portfolio.metric.volatility(portfolio_engine: portfolio_engine.PortfolioEngine) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| portfolio_engine | PortfolioEngine | PortfolioEngine class instance, this will hold transactions and perform calculations.
Use `portfolio.load` to create a PortfolioEngine. | None | False | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | DataFrame with volatility for portfolio and benchmark for different periods | +--- + +## Examples + +```python +from openbb_terminal.sdk import openbb +p = openbb.portfolio.load("openbb_terminal/miscellaneous/portfolio_examples/holdings/example.csv") +output = openbb.portfolio.metric.volatility(p) +``` + +--- diff --git a/website/content/sdk/reference/portfolio/mret.md b/website/content/sdk/reference/portfolio/mret.md new file mode 100644 index 000000000000..dc4daf83f0a6 --- /dev/null +++ b/website/content/sdk/reference/portfolio/mret.md @@ -0,0 +1,97 @@ +--- +title: mret +description: This page provides comprehensive guides and source codes on how to get + and display monthly returns using the functions 'mret' and 'mret_chart' respectively, + both under openbb.portfolio of the OpenBB Terminal. +keywords: +- portfolio +- mret +- mret_chart +- Monthly returns +- PortfolioEngine +- portfolio.load +- openbb.portfolio.load +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + +Get monthly returns + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/portfolio/portfolio_model.py#L267)] + +```python +openbb.portfolio.mret(portfolio_engine: portfolio_engine.PortfolioEngine, window: str = "all") +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| portfolio_engine | PortfolioEngine | PortfolioEngine class instance, this will hold transactions and perform calculations.
Use `portfolio.load` to create a PortfolioEngine. | None | False | +| window | str | interval to compare cumulative returns and benchmark | all | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | DataFrame with monthly returns | +--- + +## Examples + +```python +from openbb_terminal.sdk import openbb +p = openbb.portfolio.load("openbb_terminal/miscellaneous/portfolio_examples/holdings/example.csv") +output = openbb.portfolio.mret(p) +``` + +--- + + + + +Display monthly returns + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/portfolio/portfolio_view.py#L457)] + +```python +openbb.portfolio.mret_chart(portfolio_engine: portfolio_engine.PortfolioEngine, window: str = "all", raw: bool = False, show_vals: bool = False, export: str = "", external_axes: Optional[matplotlib.axes._axes.Axes] = None) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| portfolio_engine | PortfolioEngine | PortfolioEngine class instance, this will hold transactions and perform calculations.
Use `portfolio.load` to create a PortfolioEngine. | None | False | +| window | str | interval to compare cumulative returns and benchmark | all | True | +| raw | False | Display raw data from cumulative return | False | True | +| show_vals | False | Show values on heatmap | False | True | +| export | str | Export certain type of data | | True | +| external_axes | plt.Axes | Optional axes to display plot on | None | True | + + +--- + +## Returns + +This function does not return anything + +--- + + + diff --git a/website/content/sdk/reference/portfolio/om.md b/website/content/sdk/reference/portfolio/om.md new file mode 100644 index 000000000000..fcb56727ed79 --- /dev/null +++ b/website/content/sdk/reference/portfolio/om.md @@ -0,0 +1,96 @@ +--- +title: om +description: Learn how to use the omega ratio function to guide your portfolio management. + This page provides details about parameters, returns, and examples on how to apply + the omega ratio method in your transaction calculations using both model and chart + views. +keywords: +- omega ratio +- portfolio management +- PortfolioEngine class +- financial transactions +- annualized target return +- portfolio load +- chart view +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + +Get omega ratio + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/portfolio/portfolio_model.py#L1839)] + +```python +openbb.portfolio.om(portfolio_engine: portfolio_engine.PortfolioEngine, threshold_start: float = 0, threshold_end: float = 1.5) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| portfolio_engine | PortfolioEngine | PortfolioEngine class instance, this will hold transactions and perform calculations.
Use `portfolio.load` to create a PortfolioEngine. | None | False | +| threshold_start | float | annualized target return threshold start of plotted threshold range | 0 | True | +| threshold_end | float | annualized target return threshold end of plotted threshold range | 1.5 | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | DataFrame with portfolio omega ratio | +--- + +## Examples + +```python +from openbb_terminal.sdk import openbb +p = openbb.portfolio.load("openbb_terminal/miscellaneous/portfolio_examples/holdings/example.csv") +output = openbb.portfolio.om(p) +``` + +--- + + + + +Display omega ratio + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/portfolio/portfolio_view.py#L1802)] + +```python +openbb.portfolio.om_chart(portfolio_engine: portfolio_engine.PortfolioEngine, threshold_start: float = 0, threshold_end: float = 1.5) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| portfolio_engine | PortfolioEngine | PortfolioEngine class instance, this will hold transactions and perform calculations.
Use `portfolio.load` to create a PortfolioEngine. | None | False | +| threshold_start | float | annualized target return threshold start of plotted threshold range | 0 | True | +| threshold_end | float | annualized target return threshold end of plotted threshold range | 1.5 | True | + + +--- + +## Returns + +This function does not return anything + +--- + + + diff --git a/website/content/sdk/reference/portfolio/perf.md b/website/content/sdk/reference/portfolio/perf.md new file mode 100644 index 000000000000..8073b40bd683 --- /dev/null +++ b/website/content/sdk/reference/portfolio/perf.md @@ -0,0 +1,55 @@ +--- +title: perf +description: This page is a guide on how to get a portfolio's performance vs the benchmark + with the OpenBB Terminal's perf function. It includes function usage, parameters + explanation, return values, and examples. +keywords: +- portfolio performance +- benchmark +- portfolio engine +- openbb portfolio perf +- performance calculations +- trades performance +- portfolio load +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Get portfolio performance vs the benchmark + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/portfolio/portfolio_model.py#L1640)] + +```python +openbb.portfolio.perf(portfolio_engine: portfolio_engine.PortfolioEngine, show_all_trades: bool = False) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| portfolio_engine | PortfolioEngine | PortfolioEngine class instance, this will hold transactions and perform calculations.
Use `portfolio.load` to create a PortfolioEngine. | None | False | +| show_all_trades | bool | Whether to also show all trades made and their performance (default is False) | False | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | DataFrame with portfolio performance vs the benchmark | +--- + +## Examples + +```python +from openbb_terminal.sdk import openbb +p = openbb.portfolio.load("openbb_terminal/miscellaneous/portfolio_examples/holdings/example.csv") +output = openbb.portfolio.perf(p) +``` + +--- diff --git a/website/content/sdk/reference/portfolio/po/blacklitterman.md b/website/content/sdk/reference/portfolio/po/blacklitterman.md new file mode 100644 index 000000000000..60aed8e9237e --- /dev/null +++ b/website/content/sdk/reference/portfolio/po/blacklitterman.md @@ -0,0 +1,90 @@ +--- +title: blacklitterman +description: The page describes the Python method for the Black Litterman model implemented + in the OpenBB library for optimizing portfolio weights. This method provides an + advanced approach in risk management and return estimation by taking into account + various parameters like risk-free rate, risk aversion factor, and objectives like + maximizing Sharpe ratio or minimizing risk. +keywords: +- Black Litterman model +- Portfolio optimization +- Portfolio weights +- Risk management +- Return estimates +- Sharpe ratio +- Equilibrium portfolio +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Optimize decorrelation weights + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/portfolio/portfolio_optimization/po_model.py#L1019)] + +```python +openbb.portfolio.po.blacklitterman(portfolio_engine: portfolio_optimization.po_engine.PoEngine = None, symbols: List[str] = None, kwargs: Any) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| portfolio_engine | PoEngine | Portfolio optimization engine, by default None
Use `portfolio.po.load` to load a portfolio engine | None | True | +| symbols | List[str] | List of symbols, by default None | None | True | +| interval | str | Interval to get data, by default '3y' | None | True | +| start_date | str | If not using interval, start date string (YYYY-MM-DD), by default "" | None | True | +| end_date | str | If not using interval, end date string (YYYY-MM-DD). If empty use last weekday, by default "" | None | True | +| log_returns | bool | If True use log returns, else arithmetic returns, by default False | None | True | +| freq | str | Frequency of returns, by default 'D'. Options: 'D' for daily, 'W' for weekly, 'M' for monthly | None | True | +| maxnan | float | Maximum percentage of NaNs allowed in the data, by default 0.05 | None | True | +| threshold | float | Value used to replace outliers that are higher than threshold, by default 0.0 | None | True | +| method | str | Method used to fill nan values, by default 'time'
For more information see `interpolate `__. | None | True | +| value | float | Amount to allocate to portfolio in long positions, by default 1.0 | None | True | +| value_short | float | Amount to allocate to portfolio in short positions, by default 0.0 | None | True | +| benchmark | Dict | Dict of portfolio weights, by default None | None | True | +| p_views | List | Matrix P of views that shows relationships among assets and returns, by default None | None | True | +| q_views | List | Matrix Q of expected returns of views, by default None | None | True | +| objective | str | Objective function of the optimization model, by default 'Sharpe'
Possible values are:

- 'MinRisk': Minimize the selected risk measure.
- 'Utility': Maximize the risk averse utility function.
- 'Sharpe': Maximize the risk adjusted return ratio based on the selected risk measure.
- 'MaxRet': Maximize the expected return of the portfolio. | None | True | +| risk_free_rate | float | Risk free rate, annualized. Used for 'FLPM' and 'SLPM' and Sharpe objective function, by default 0.0 | None | True | +| risk_aversion | float | Risk aversion factor of the 'Utility' objective function, by default 1.0 | None | True | +| delta | float | Risk aversion factor of Black Litterman model, by default None | None | True | +| equilibrium | bool | If True excess returns are based on equilibrium market portfolio, if False
excess returns are calculated as historical returns minus risk free rate, by default True | None | True | +| optimize | bool | If True Black Litterman estimates are used as inputs of mean variance model,
if False returns equilibrium weights from Black Litterman model, by default True | None | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| Tuple[pd.DataFrame, Dict] | Tuple with weights and performance dictionary | +--- + +## Examples + +```python +from openbb_terminal.sdk import openbb +openbb.portfolio.po.blacklitterman(symbols=["AAPL", "MSFT", "AMZN"]) +``` + +``` +( value + AAPL 0.48920 + MSFT 0.28391 + AMZN 0.22689, + {'Return': 0.2563301105112327, + 'Volatility': 0.33132073874339424, + 'Sharpe ratio': 0.7736615325784322}) +``` +```python +from openbb_terminal.sdk import openbb +p = openbb.portfolio.po.load(symbols_file_path="~/openbb_terminal/miscellaneous/portfolio_examples/allocation/60_40_Portfolio.xlsx") +weights, performance = openbb.portfolio.po.blacklitterman(portfolio_engine=p) +``` + +--- diff --git a/website/content/sdk/reference/portfolio/po/dividend.md b/website/content/sdk/reference/portfolio/po/dividend.md new file mode 100644 index 000000000000..8c151b7d7617 --- /dev/null +++ b/website/content/sdk/reference/portfolio/po/dividend.md @@ -0,0 +1,79 @@ +--- +title: dividend +description: The 'dividend' feature of the OpenBB library allows optimized weight + allocation in portfolio based on dividend yield. The document offers detailed examples + and parameters of the implementation. +keywords: +- dividend +- portfolio optimization +- po model +- portfolio engine +- weights allocation +- AAPL +- MSFT +- AMZN +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Optimize weighted according to dividend yield + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/portfolio/portfolio_optimization/po_model.py#L2207)] + +```python +openbb.portfolio.po.dividend(symbols: List[str] = None, portfolio_engine: portfolio_optimization.po_engine.PoEngine = None, kwargs: Any) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| portfolio_engine | PoEngine | Portfolio optimization engine, by default None
Use `portfolio.po.load` to load a portfolio engine | None | True | +| symbols | List[str] | List of symbols, by default None | None | True | +| interval | str | Interval to get data, by default '3y' | None | True | +| start_date | str | If not using interval, start date string (YYYY-MM-DD), by default "" | None | True | +| end_date | str | If not using interval, end date string (YYYY-MM-DD). If empty use last weekday, by default "" | None | True | +| log_returns | bool | If True use log returns, else arithmetic returns, by default False | None | True | +| freq | str | Frequency of returns, by default 'D'. Options: 'D' for daily, 'W' for weekly, 'M' for monthly | None | True | +| maxnan | float | Maximum percentage of NaNs allowed in the data, by default 0.05 | None | True | +| threshold | float | Value used to replace outliers that are higher than threshold, by default 0.0 | None | True | +| method | str | Method used to fill nan values, by default 'time'
For more information see `interpolate `__. | None | True | +| value | float | Amount to allocate to portfolio in long positions, by default 1.0 | None | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| Tuple[pd.DataFrame, Dict] | Tuple with weights and performance dictionary | +--- + +## Examples + +```python +from openbb_terminal.sdk import openbb +openbb.portfolio.po.dividend(symbols=["AAPL", "MSFT", "AMZN"]) +``` + +``` +( value + AAPL 0.350575 + MSFT 0.649425 + AMZN 0.000000, + {'Return': 0.26879215033541076, + 'Volatility': 0.3348681656035649, + 'Sharpe ratio': 0.8026805111526232}) +``` +```python +from openbb_terminal.sdk import openbb +p = openbb.portfolio.po.load(symbols_file_path="~/openbb_terminal/miscellaneous/portfolio_examples/allocation/60_40_Portfolio.xlsx") +weights, performance = openbb.portfolio.po.dividend(portfolio_engine=p) +``` + +--- diff --git a/website/content/sdk/reference/portfolio/po/ef.md b/website/content/sdk/reference/portfolio/po/ef.md new file mode 100644 index 000000000000..c458568a37b7 --- /dev/null +++ b/website/content/sdk/reference/portfolio/po/ef.md @@ -0,0 +1,145 @@ +--- +title: ef +description: The page highlights the use and functioning of the efficient frontier + model in portfolio optimization. It includes explanations about parameters used, + type of returns, and examples. Furthermore, it details the process for displaying + the efficient frontier chart. +keywords: +- Efficient Frontier +- Portfolio Optimization +- Financial Models +- Risk Measure +- Portfolio Simulation +- Stock Portfolio +- Data Visualization +- Financial Software +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + +Get Efficient Frontier + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/portfolio/portfolio_optimization/po_model.py#L1120)] + +```python +openbb.portfolio.po.ef(portfolio_engine: portfolio_optimization.po_engine.PoEngine = None, symbols: List[str] = None, kwargs: Any) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| portfolio_engine | PoEngine | Portfolio optimization engine, by default None
Use `portfolio.po.load` to load a portfolio engine | None | True | +| symbols | List[str] | List of symbols, by default None | None | True | +| interval | str | Interval to get data, by default '3y' | None | True | +| start_date | str | If not using interval, start date string (YYYY-MM-DD), by default "" | None | True | +| end_date | str | If not using interval, end date string (YYYY-MM-DD). If empty use last weekday, by default "" | None | True | +| log_returns | bool | If True use log returns, else arithmetic returns, by default False | None | True | +| freq | str | Frequency of returns, by default 'D'. Options: 'D' for daily, 'W' for weekly, 'M' for monthly | None | True | +| maxnan | float | Maximum percentage of NaNs allowed in the data, by default 0.05 | None | True | +| threshold | float | Value used to replace outliers that are higher than threshold, by default 0.0 | None | True | +| method | str | Method used to fill nan values, by default 'time'
For more information see `interpolate `__. | None | True | +| value | float | Amount to allocate to portfolio in long positions, by default 1.0 | None | True | +| value_short | float | Amount to allocate to portfolio in short positions, by default 0.0 | None | True | +| risk_measure | str | The risk measure used to optimize the portfolio, by default 'MV'
Possible values are:

- 'MV': Standard Deviation.
- 'MAD': Mean Absolute Deviation.
- 'MSV': Semi Standard Deviation.
- 'FLPM': First Lower Partial Moment (Omega Ratio).
- 'SLPM': Second Lower Partial Moment (Sortino Ratio).
- 'CVaR': Conditional Value at Risk.
- 'EVaR': Entropic Value at Risk.
- 'WR': Worst Realization.
- 'ADD': Average Drawdown of uncompounded cumulative returns.
- 'UCI': Ulcer Index of uncompounded cumulative returns.
- 'CDaR': Conditional Drawdown at Risk of uncompounded cumulative returns.
- 'EDaR': Entropic Drawdown at Risk of uncompounded cumulative returns.
- 'MDD': Maximum Drawdown of uncompounded cumulative returns. | None | True | +| risk_free_rate | float | Risk free rate, annualized. Used for 'FLPM' and 'SLPM' and Sharpe objective function, by default 0.0 | None | True | +| alpha | float | Significance level of VaR, CVaR, EDaR, DaR, CDaR, EDaR, Tail Gini of losses, by default 0.05 | None | True | +| n_portfolios | int | Number of portfolios to simulate, by default 100 | None | True | +| seed | int | Seed used to generate random portfolios, by default 123 | None | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| Tuple[ | pd.DataFrame,
pd.DataFrame,
pd.DataFrame,
pd.DataFrame,
Optional[pd.DataFrame],
NDArray[floating],
NDArray[floating],
rp.Portfolio, | +--- + +## Examples + +```python +from openbb_terminal.sdk import openbb +frontier = openbb.portfolio.po.ef(symbols=["AAPL", "MSFT", "AMZN"]) +``` + +```python +from openbb_terminal.sdk import openbb +p = openbb.portfolio.po.load(symbols_file_path="~/openbb_terminal/miscellaneous/portfolio_examples/allocation/60_40_Portfolio.xlsx") +frontier = openbb.portfolio.po.ef(portfolio_engine=p) +``` + +--- + + + + +Display efficient frontier + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/portfolio/portfolio_optimization/po_view.py#L41)] + +```python +openbb.portfolio.po.ef_chart(portfolio_engine: portfolio_optimization.po_engine.PoEngine = None, symbols: List[str] = None, kwargs: Any) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| portfolio_engine | PoEngine | Portfolio optimization engine, by default None
Use `portfolio.po.load` to load a portfolio engine | None | True | +| symbols | List[str] | List of symbols, by default None | None | True | +| interval | str | Interval to get data, by default '3y' | None | True | +| start_date | str | If not using interval, start date string (YYYY-MM-DD), by default "" | None | True | +| end_date | str | If not using interval, end date string (YYYY-MM-DD). If empty use last weekday, by default "" | None | True | +| log_returns | bool | If True use log returns, else arithmetic returns, by default False | None | True | +| freq | str | Frequency of returns, by default 'D'. Options: 'D' for daily, 'W' for weekly, 'M' for monthly | None | True | +| maxnan | float | Maximum percentage of NaNs allowed in the data, by default 0.05 | None | True | +| threshold | float | Value used to replace outliers that are higher than threshold, by default 0.0 | None | True | +| method | str | Method used to fill nan values, by default 'time'
For more information see `interpolate `__. | None | True | +| value | float | Amount to allocate to portfolio in long positions, by default 1.0 | None | True | +| value_short | float | Amount to allocate to portfolio in short positions, by default 0.0 | None | True | +| risk_measure | str | The risk measure used to optimize the portfolio, by default 'MV'
Possible values are:

- 'MV': Standard Deviation.
- 'MAD': Mean Absolute Deviation.
- 'MSV': Semi Standard Deviation.
- 'FLPM': First Lower Partial Moment (Omega Ratio).
- 'SLPM': Second Lower Partial Moment (Sortino Ratio).
- 'CVaR': Conditional Value at Risk.
- 'EVaR': Entropic Value at Risk.
- 'WR': Worst Realization.
- 'ADD': Average Drawdown of uncompounded cumulative returns.
- 'UCI': Ulcer Index of uncompounded cumulative returns.
- 'CDaR': Conditional Drawdown at Risk of uncompounded cumulative returns.
- 'EDaR': Entropic Drawdown at Risk of uncompounded cumulative returns.
- 'MDD': Maximum Drawdown of uncompounded cumulative returns. | None | True | +| risk_free_rate | float | Risk free rate, annualized. Used for 'FLPM' and 'SLPM' and Sharpe objective function, by default 0.0 | None | True | +| alpha | float | Significance level of VaR, CVaR, EDaR, DaR, CDaR, EDaR, Tail Gini of losses, by default 0.05 | None | True | +| n_portfolios | int | Number of portfolios to simulate, by default 100 | None | True | +| seed | int | Seed used to generate random portfolios, by default 123 | None | True | + + +--- + +## Returns + +This function does not return anything + +--- + +## Examples + +```python +from openbb_terminal.sdk import openbb +frontier = openbb.portfolio.po.ef_chart(symbols=["AAPL", "MSFT", "AMZN"]) +``` + +```python +from openbb_terminal.sdk import openbb +p = openbb.portfolio.po.load(symbols_file_path="openbb_terminal/miscellaneous/portfolio_examples/allocation/60_40_Portfolio.xlsx") +frontier = openbb.portfolio.po.ef_chart(portfolio_engine=p) +``` + +--- + + + diff --git a/website/content/sdk/reference/portfolio/po/equal.md b/website/content/sdk/reference/portfolio/po/equal.md new file mode 100644 index 000000000000..734ba6e00744 --- /dev/null +++ b/website/content/sdk/reference/portfolio/po/equal.md @@ -0,0 +1,80 @@ +--- +title: equal +description: The page provides detailed information about the equally weighted portfolio + (a type of portfolio optimization) in OpenBB Finance with parameters, returns and + python example codes. +keywords: +- OpenBB Finance documentation +- Equally weighted portfolio +- Portfolio optimization +- OpenBB Portfolio po.equal function +- Portfolio symbols +- Interval, start date, end date in portfolio +- Returns in investment +- Python Finance library +- Portfolio performance +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Equally weighted portfolio, where weight = 1/# of symbols + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/portfolio/portfolio_optimization/po_model.py#L2063)] + +```python +openbb.portfolio.po.equal(portfolio_engine: portfolio_optimization.po_engine.PoEngine = None, symbols: List[str] = None, kwargs: Any) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| portfolio_engine | PoEngine | Portfolio optimization engine, by default None
Use `portfolio.po.load` to load a portfolio engine | None | True | +| symbols | List[str] | List of symbols, by default None | None | True | +| interval | str | Interval to get data, by default '3y' | None | True | +| start_date | str | If not using interval, start date string (YYYY-MM-DD), by default "" | None | True | +| end_date | str | If not using interval, end date string (YYYY-MM-DD). If empty use last weekday, by default "" | None | True | +| log_returns | bool | If True use log returns, else arithmetic returns, by default False | None | True | +| freq | str | Frequency of returns, by default 'D'. Options: 'D' for daily, 'W' for weekly, 'M' for monthly | None | True | +| maxnan | float | Maximum percentage of NaNs allowed in the data, by default 0.05 | None | True | +| threshold | float | Value used to replace outliers that are higher than threshold, by default 0.0 | None | True | +| method | str | Method used to fill nan values, by default 'time'
For more information see `interpolate `__. | None | True | +| value | float | Amount to allocate to portfolio in long positions, by default 1.0 | None | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| Tuple[pd.DataFrame, Dict] | Tuple with weights and performance dictionary | +--- + +## Examples + +```python +from openbb_terminal.sdk import openbb +openbb.portfolio.po.equal(symbols=["AAPL", "MSFT", "AMZN"]) +``` + +``` +( value + AAPL 0.33333 + MSFT 0.33333 + AMZN 0.33333, + {'Return': 0.22459515482054027, + 'Volatility': 0.32898777497511816, + 'Sharpe ratio': 0.6826854123607685}) +``` +```python +from openbb_terminal.sdk import openbb +p = openbb.portfolio.po.load(symbols_file_path="~/openbb_terminal/miscellaneous/portfolio_examples/allocation/60_40_Portfolio.xlsx") +weights, performance = openbb.portfolio.po.equal(portfolio_engine=p) +``` + +--- diff --git a/website/content/sdk/reference/portfolio/po/file.md b/website/content/sdk/reference/portfolio/po/file.md new file mode 100644 index 000000000000..ccb375c8e43c --- /dev/null +++ b/website/content/sdk/reference/portfolio/po/file.md @@ -0,0 +1,102 @@ +--- +title: file +description: This page provides detailed information on the functionality and usage + of the 'Load portfolio optimization engine from file' method in the OpenBB Terminal + application. Examples and parameters are discussed extensively to ensure user familiarity + with the method. +keywords: +- portfolio optimization +- load portfolio +- PoEngine +- parameters +- examples +- maxsharpe +- risk_free_rate +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Load portfolio optimization engine from file + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/portfolio/portfolio_optimization/po_model.py#L108)] + +```python +openbb.portfolio.po.file(portfolio_engine: portfolio_optimization.po_engine.PoEngine, parameters_file_path: str) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| portfolio_engine | PoEngine | Portfolio optimization engine, by default None
Use `portfolio.po.load` to load a portfolio engine | None | False | +| parameters_file_path | str | Parameters file full path, by default None | None | False | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| Dict | Loaded parameters | +--- + +## Examples + +```python +from openbb_terminal.sdk import openbb +p = openbb.portfolio.po.load(symbols_file_path="~/openbb_terminal/miscellaneous/portfolio_examples/allocation/60_40_Portfolio.xlsx") +p.get_params() +``` + +``` +{} +``` +```python +parameters = openbb.portfolio.po.file(portfolio_engine=p, parameters_file_path="~/openbb_terminal/miscellaneous/portfolio_examples/optimization/defaults.ini") +``` + +``` +Parameters: + interval : 3y + log_returns : 0 + freq : d + maxnan : 0.05 + threshold : 0.3 + alpha : 0.05 +``` +```python +p.get_params() +``` + +``` +{'interval': '3y', + 'log_returns': '0', + 'freq': 'd', + 'maxnan': '0.05', + 'threshold': '0.3', + 'alpha': '0.05'} +``` +```python +p.set_params({"risk_free_rate": 0.05}) +p.get_params() +``` + +``` +{'interval': '3y', +'log_returns': '0', +'freq': 'd', +'maxnan': '0.05', +'threshold': '0.3', +'alpha': '0.05', +'risk_free_rate': 0.05} +``` +```python +weights, performance = openbb.portfolio.po.maxsharpe(portfolio_engine=p) +``` + +--- diff --git a/website/content/sdk/reference/portfolio/po/get_properties.md b/website/content/sdk/reference/portfolio/po/get_properties.md new file mode 100644 index 000000000000..649ec9e9b493 --- /dev/null +++ b/website/content/sdk/reference/portfolio/po/get_properties.md @@ -0,0 +1,39 @@ +--- +title: get_properties +description: The get_properties function in OpenBB's portfolio optimization module + provides a list of available properties for property optimization purposes. No parameters + are required for this function. +keywords: +- property optimization +- get_properties +- openbb_portfolio +- Python code +- optimizer_model +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Get properties to use on property optimization. + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/portfolio/portfolio_optimization/optimizer_model.py#L2872)] + +```python +openbb.portfolio.po.get_properties() +``` + +--- + +## Parameters + +This function does not take any parameters. + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| | List of available properties to use on property optimization. | +--- diff --git a/website/versioned_docs/version-v3/sdk/reference/portfolio/po/hcp.md b/website/content/sdk/reference/portfolio/po/hcp.md similarity index 92% rename from website/versioned_docs/version-v3/sdk/reference/portfolio/po/hcp.md rename to website/content/sdk/reference/portfolio/po/hcp.md index acc4fda23e48..822ba7eca283 100644 --- a/website/versioned_docs/version-v3/sdk/reference/portfolio/po/hcp.md +++ b/website/content/sdk/reference/portfolio/po/hcp.md @@ -1,9 +1,25 @@ --- title: hcp -description: OpenBB SDK Function +description: The page provides details on hierarchical clustering based portfolios + (HCP) in the OpenBBTerminal, a python tool for advanced investment strategies. It + describes parameters for portfolio optimization including risk measures, covariance + estimations, and clustering techniques. The return outcomes include portfolio weights + and stock returns. +keywords: +- portfolio optimization +- hierarchical clustering +- stock returns +- Hierarchical Risk Parity +- Nested Clustered Optimization +- covariance matrix +- risk measures +- stocks +- portfolio management --- -# hcp +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + Builds hierarchical clustering based portfolios @@ -57,4 +73,3 @@ openbb.portfolio.po.hcp(symbols: List[str], kwargs: Any) | ---- | ----------- | | Tuple[Optional[dict], pd.DataFrame] | Dictionary of portfolio weights,
DataFrame of stock returns. | --- - diff --git a/website/content/sdk/reference/portfolio/po/herc.md b/website/content/sdk/reference/portfolio/po/herc.md new file mode 100644 index 000000000000..f854460ccd5e --- /dev/null +++ b/website/content/sdk/reference/portfolio/po/herc.md @@ -0,0 +1,95 @@ +--- +title: herc +description: The page provides detailed documentation for the Hierarchical Equal Risk + Contribution (HERC) method in the OpenBB Terminal's portfolio optimization module. + The method is used for the optimized allocation of resources in a portfolio to minimize + risk. The page includes a detailed explanation of input parameters, return types, + and code examples. +keywords: +- HERC Method +- Portfolio Optimization +- Risk Management +- Hierarchical Equal Risk Contribution +- Financial Modelling +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Optimize with Hierarchical Equal Risk Contribution (HERC) method. + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/portfolio/portfolio_optimization/po_model.py#L1679)] + +```python +openbb.portfolio.po.herc(portfolio_engine: portfolio_optimization.po_engine.PoEngine = None, symbols: List[str] = None, kwargs: Any) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| portfolio_engine | PoEngine | Portfolio optimization engine, by default None
Use `portfolio.po.load` to load a portfolio engine | None | True | +| symbols | List[str] | List of symbols, by default None | None | True | +| interval | str | Interval to get data, by default '3y' | None | True | +| start_date | str | If not using interval, start date string (YYYY-MM-DD), by default "" | None | True | +| end_date | str | If not using interval, end date string (YYYY-MM-DD). If empty use last weekday, by default "" | None | True | +| log_returns | bool | If True use log returns, else arithmetic returns, by default False | None | True | +| freq | str | Frequency of returns, by default 'D'. Options: 'D' for daily, 'W' for weekly, 'M' for monthly | None | True | +| maxnan | float | Maximum percentage of NaNs allowed in the data, by default 0.05 | None | True | +| threshold | float | Value used to replace outliers that are higher than threshold, by default 0.0 | None | True | +| method | str | Method used to fill nan values, by default 'time'
For more information see `interpolate `__. | None | True | +| value | float | Amount to allocate to portfolio in long positions, by default 1.0 | None | True | +| objective | str | Objective function of the optimization model, by default 'MinRisk'
Possible values are:

- 'MinRisk': Minimize the selected risk measure.
- 'Utility': Maximize the risk averse utility function.
- 'Sharpe': Maximize the risk adjusted return ratio based on the selected risk measure.
- 'MaxRet': Maximize the expected return of the portfolio. | None | True | +| risk_measure | str | The risk measure used to optimize the portfolio, by default 'MV'
If model is 'NCO', the risk measures available depends on the objective function.
Possible values are:

- 'MV': Variance.
- 'MAD': Mean Absolute Deviation.
- 'MSV': Semi Standard Deviation.
- 'FLPM': First Lower Partial Moment (Omega Ratio).
- 'SLPM': Second Lower Partial Moment (Sortino Ratio).
- 'VaR': Value at Risk.
- 'CVaR': Conditional Value at Risk.
- 'TG': Tail Gini.
- 'EVaR': Entropic Value at Risk.
- 'WR': Worst Realization (Minimax).
- 'RG': Range of returns.
- 'CVRG': CVaR range of returns.
- 'TGRG': Tail Gini range of returns.
- 'MDD': Maximum Drawdown of uncompounded cumulative returns (Calmar Ratio).
- 'ADD': Average Drawdown of uncompounded cumulative returns.
- 'DaR': Drawdown at Risk of uncompounded cumulative returns.
- 'CDaR': Conditional Drawdown at Risk of uncompounded cumulative returns.
- 'EDaR': Entropic Drawdown at Risk of uncompounded cumulative returns.
- 'UCI': Ulcer Index of uncompounded cumulative returns.
- 'MDD_Rel': Maximum Drawdown of compounded cumulative returns (Calmar Ratio).
- 'ADD_Rel': Average Drawdown of compounded cumulative returns.
- 'DaR_Rel': Drawdown at Risk of compounded cumulative returns.
- 'CDaR_Rel': Conditional Drawdown at Risk of compounded cumulative returns.
- 'EDaR_Rel': Entropic Drawdown at Risk of compounded cumulative returns.
- 'UCI_Rel': Ulcer Index of compounded cumulative returns. | None | True | +| risk_free_rate | float | Risk free rate, annualized. Used for 'FLPM' and 'SLPM' and Sharpe objective function, by default 0.0 | None | True | +| risk_aversion | float | Risk aversion factor of the 'Utility' objective function, by default 1.0 | None | True | +| alpha | float | Significance level of VaR, CVaR, EDaR, DaR, CDaR, EDaR, Tail Gini of losses, by default 0.05 | None | True | +| a_sim | float | Number of CVaRs used to approximate Tail Gini of losses, by default 100 | None | True | +| beta | float | Significance level of CVaR and Tail Gini of gains. If None it duplicates alpha value, by default None | None | True | +| b_sim | float | Number of CVaRs used to approximate Tail Gini of gains. If None it duplicates a_sim value, by default None | None | True | +| covariance | str | The method used to estimate the covariance matrix, by default 'hist'
Possible values are:

- 'hist': use historical estimates.
- 'ewma1': use ewma with adjust=True. For more information see `EWM `__.
- 'ewma2': use ewma with adjust=False. For more information see `EWM `__.
- 'ledoit': use the Ledoit and Wolf Shrinkage method.
- 'oas': use the Oracle Approximation Shrinkage method.
- 'shrunk': use the basic Shrunk Covariance method.
- 'gl': use the basic Graphical Lasso Covariance method.
- 'jlogo': use the j-LoGo Covariance method. For more information see: `a-jLogo`.
- 'fixed': denoise using fixed method. For more information see chapter 2 of `a-MLforAM`.
- 'spectral': denoise using spectral method. For more information see chapter 2 of `a-MLforAM`.
- 'shrink': denoise using shrink method. For more information see chapter 2 of `a-MLforAM`. | None | True | +| d_ewma | float | The smoothing factor of ewma methods, by default 0.94 | None | True | +| codependence | str | The codependence or similarity matrix used to build the distance
metric and clusters. The default is 'pearson'. Possible values are:

- 'pearson': pearson correlation matrix. Distance formula:
.. math:: D_{i,j} = \sqrt{0.5(1-\rho^{pearson}_{i,j})}
- 'spearman': spearman correlation matrix. Distance formula:
.. math:: D_{i,j} = \sqrt{0.5(1-\rho^{spearman}_{i,j})}
- 'abs_pearson': absolute value pearson correlation matrix. Distance formula:
.. math:: D_{i,j} = \sqrt{(1-|\rho^{pearson}_{i,j}|)}
- 'abs_spearman': absolute value spearman correlation matrix. Distance formula:
.. math:: D_{i,j} = \sqrt{(1-|\rho^{spearman}_{i,j}|)}
- 'distance': distance correlation matrix. Distance formula:
.. math:: D_{i,j} = \sqrt{(1-\rho^{distance}_{i,j})}
- 'mutual_info': mutual information matrix. Distance used is variation information matrix.
- 'tail': lower tail dependence index matrix. Dissimilarity formula:
.. math:: D_{i,j} = -\log{\lambda_{i,j}} | None | True | +| linkage | str | Linkage method of hierarchical clustering. For more information see `linkage cluster.hierarchy.linkage.html?highlight=linkage#scipy.cluster.hierarchy.linkage>`__.
The default is 'single'. Possible values are:

- 'single'.
- 'complete'.
- 'average'.
- 'weighted'.
- 'centroid'.
- 'median'.
- 'ward'.
- 'dbht': Direct Bubble Hierarchical Tree. | None | True | +| k | int | Number of clusters. This value is took instead of the optimal number
of clusters calculated with the two difference gap statistic, by default None | None | True | +| max_k | int | Max number of clusters used by the two difference gap statistic
to find the optimal number of clusters, by default 10 | None | True | +| bins_info | str | Number of bins used to calculate variation of information, by default 'KN'.
Possible values are:

- 'KN': Knuth's choice method. For more information see `knuth_bin_width `__.
- 'FD': Freedman–Diaconis' choice method. For more information see `freedman_bin_width `__.
- 'SC': Scotts' choice method. For more information see `scott_bin_width `__.
- 'HGR': Hacine-Gharbi and Ravier' choice method. | None | True | +| alpha_tail | float | Significance level for lower tail dependence index, by default 0.05 | None | True | +| leaf_order | bool | Indicates if the cluster are ordered so that the distance between
successive leaves is minimal, by default True | None | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| Tuple[pd.DataFrame, Dict] | Tuple with weights and performance dictionary | +--- + +## Examples + +```python +from openbb_terminal.sdk import openbb +openbb.portfolio.po.herc(symbols=["AAPL", "MSFT", "AMZN"]) +``` + +``` +( value + AAPL 0.17521 + MSFT 0.19846 + AMZN 0.62633, + {'Return': 0.16899696275924703, + 'Volatility': 0.34337400112782096, + 'Sharpe ratio': 0.49216586638525933}) +``` +```python +from openbb_terminal.sdk import openbb +p = openbb.portfolio.po.load(symbols_file_path="~/openbb_terminal/miscellaneous/portfolio_examples/allocation/60_40_Portfolio.xlsx") +weights, performance = openbb.portfolio.po.herc(portfolio_engine=p) +``` + +--- diff --git a/website/content/sdk/reference/portfolio/po/hrp.md b/website/content/sdk/reference/portfolio/po/hrp.md new file mode 100644 index 000000000000..9930993ad2e7 --- /dev/null +++ b/website/content/sdk/reference/portfolio/po/hrp.md @@ -0,0 +1,96 @@ +--- +title: hrp +description: This page provides information about the Hierarchical Risk Parity (HRP) + function in the openbb.portfolio.po module. This function allows for portfolio optimization + using HRP. Detailed parameter explanations, return values, and usage examples are + provided. +keywords: +- portfolio optimization +- Hierarchical Risk Parity +- openbb.portfolio.po +- risk management +- asset allocation +- portfolio management +- financial modeling +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Optimize with Hierarchical Risk Parity + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/portfolio/portfolio_optimization/po_model.py#L1487)] + +```python +openbb.portfolio.po.hrp(portfolio_engine: portfolio_optimization.po_engine.PoEngine = None, symbols: List[str] = None, kwargs: Any) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| portfolio_engine | PoEngine | Portfolio optimization engine, by default None
Use `portfolio.po.load` to load a portfolio engine | None | True | +| symbols | List[str] | List of symbols, by default None | None | True | +| interval | str | Interval to get data, by default '3y' | None | True | +| start_date | str | If not using interval, start date string (YYYY-MM-DD), by default "" | None | True | +| end_date | str | If not using interval, end date string (YYYY-MM-DD). If empty use last weekday, by default "" | None | True | +| log_returns | bool | If True use log returns, else arithmetic returns, by default False | None | True | +| freq | str | Frequency of returns, by default 'D'. Options: 'D' for daily, 'W' for weekly, 'M' for monthly | None | True | +| maxnan | float | Maximum percentage of NaNs allowed in the data, by default 0.05 | None | True | +| threshold | float | Value used to replace outliers that are higher than threshold, by default 0.0 | None | True | +| method | str | Method used to fill nan values, by default 'time'
For more information see `interpolate `__. | None | True | +| value | float | Amount to allocate to portfolio in long positions, by default 1.0 | None | True | +| objective | str | Objective function of the optimization model, by default 'MinRisk'
Possible values are:

- 'MinRisk': Minimize the selected risk measure.
- 'Utility': Maximize the risk averse utility function.
- 'Sharpe': Maximize the risk adjusted return ratio based on the selected risk measure.
- 'MaxRet': Maximize the expected return of the portfolio. | None | True | +| risk_measure | str | The risk measure used to optimize the portfolio, by default 'MV'
If model is 'NCO', the risk measures available depends on the objective function.
Possible values are:

- 'MV': Variance.
- 'MAD': Mean Absolute Deviation.
- 'MSV': Semi Standard Deviation.
- 'FLPM': First Lower Partial Moment (Omega Ratio).
- 'SLPM': Second Lower Partial Moment (Sortino Ratio).
- 'VaR': Value at Risk.
- 'CVaR': Conditional Value at Risk.
- 'TG': Tail Gini.
- 'EVaR': Entropic Value at Risk.
- 'WR': Worst Realization (Minimax).
- 'RG': Range of returns.
- 'CVRG': CVaR range of returns.
- 'TGRG': Tail Gini range of returns.
- 'MDD': Maximum Drawdown of uncompounded cumulative returns (Calmar Ratio).
- 'ADD': Average Drawdown of uncompounded cumulative returns.
- 'DaR': Drawdown at Risk of uncompounded cumulative returns.
- 'CDaR': Conditional Drawdown at Risk of uncompounded cumulative returns.
- 'EDaR': Entropic Drawdown at Risk of uncompounded cumulative returns.
- 'UCI': Ulcer Index of uncompounded cumulative returns.
- 'MDD_Rel': Maximum Drawdown of compounded cumulative returns (Calmar Ratio).
- 'ADD_Rel': Average Drawdown of compounded cumulative returns.
- 'DaR_Rel': Drawdown at Risk of compounded cumulative returns.
- 'CDaR_Rel': Conditional Drawdown at Risk of compounded cumulative returns.
- 'EDaR_Rel': Entropic Drawdown at Risk of compounded cumulative returns.
- 'UCI_Rel': Ulcer Index of compounded cumulative returns. | None | True | +| risk_free_rate | float | Risk free rate, annualized. Used for 'FLPM' and 'SLPM' and Sharpe objective function, by default 0.0 | None | True | +| risk_aversion | float | Risk aversion factor of the 'Utility' objective function, by default 1.0 | None | True | +| alpha | float | Significance level of VaR, CVaR, EDaR, DaR, CDaR, EDaR, Tail Gini of losses, by default 0.05 | None | True | +| a_sim | float | Number of CVaRs used to approximate Tail Gini of losses, by default 100 | None | True | +| beta | float | Significance level of CVaR and Tail Gini of gains. If None it duplicates alpha value, by default None | None | True | +| b_sim | float | Number of CVaRs used to approximate Tail Gini of gains. If None it duplicates a_sim value, by default None | None | True | +| covariance | str | The method used to estimate the covariance matrix, by default 'hist'
Possible values are:

- 'hist': use historical estimates.
- 'ewma1': use ewma with adjust=True. For more information see `EWM `__.
- 'ewma2': use ewma with adjust=False. For more information see `EWM `__.
- 'ledoit': use the Ledoit and Wolf Shrinkage method.
- 'oas': use the Oracle Approximation Shrinkage method.
- 'shrunk': use the basic Shrunk Covariance method.
- 'gl': use the basic Graphical Lasso Covariance method.
- 'jlogo': use the j-LoGo Covariance method. For more information see: `a-jLogo`.
- 'fixed': denoise using fixed method. For more information see chapter 2 of `a-MLforAM`.
- 'spectral': denoise using spectral method. For more information see chapter 2 of `a-MLforAM`.
- 'shrink': denoise using shrink method. For more information see chapter 2 of `a-MLforAM`. | None | True | +| d_ewma | float | The smoothing factor of ewma methods, by default 0.94 | None | True | +| codependence | str | The codependence or similarity matrix used to build the distance
metric and clusters. The default is 'pearson'. Possible values are:

- 'pearson': pearson correlation matrix. Distance formula:
.. math:: D_{i,j} = \sqrt{0.5(1-\rho^{pearson}_{i,j})}
- 'spearman': spearman correlation matrix. Distance formula:
.. math:: D_{i,j} = \sqrt{0.5(1-\rho^{spearman}_{i,j})}
- 'abs_pearson': absolute value pearson correlation matrix. Distance formula:
.. math:: D_{i,j} = \sqrt{(1-|\rho^{pearson}_{i,j}|)}
- 'abs_spearman': absolute value spearman correlation matrix. Distance formula:
.. math:: D_{i,j} = \sqrt{(1-|\rho^{spearman}_{i,j}|)}
- 'distance': distance correlation matrix. Distance formula:
.. math:: D_{i,j} = \sqrt{(1-\rho^{distance}_{i,j})}
- 'mutual_info': mutual information matrix. Distance used is variation information matrix.
- 'tail': lower tail dependence index matrix. Dissimilarity formula:
.. math:: D_{i,j} = -\log{\lambda_{i,j}} | None | True | +| linkage | str | Linkage method of hierarchical clustering. For more information see `linkage cluster.hierarchy.linkage.html?highlight=linkage#scipy.cluster.hierarchy.linkage>`__.
The default is 'single'. Possible values are:

- 'single'.
- 'complete'.
- 'average'.
- 'weighted'.
- 'centroid'.
- 'median'.
- 'ward'.
- 'dbht': Direct Bubble Hierarchical Tree. | None | True | +| k | int | Number of clusters. This value is took instead of the optimal number
of clusters calculated with the two difference gap statistic, by default None | None | True | +| max_k | int | Max number of clusters used by the two difference gap statistic
to find the optimal number of clusters, by default 10 | None | True | +| bins_info | str | Number of bins used to calculate variation of information, by default 'KN'.
Possible values are:

- 'KN': Knuth's choice method. For more information see `knuth_bin_width `__.
- 'FD': Freedman–Diaconis' choice method. For more information see `freedman_bin_width `__.
- 'SC': Scotts' choice method. For more information see `scott_bin_width `__.
- 'HGR': Hacine-Gharbi and Ravier' choice method. | None | True | +| alpha_tail | float | Significance level for lower tail dependence index, by default 0.05 | None | True | +| leaf_order | bool | Indicates if the cluster are ordered so that the distance between
successive leaves is minimal, by default True | None | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| Tuple[pd.DataFrame, Dict] | Tuple with weights and performance dictionary | +--- + +## Examples + +```python +from openbb_terminal.sdk import openbb +openbb.portfolio.po.hrp(symbols=["AAPL", "MSFT", "AMZN"]) +``` + +``` +( value + AAPL 0.26729 + MSFT 0.30277 + AMZN 0.42994, + {'Return': 0.20463517260107467, + 'Volatility': 0.3313935169747041, + 'Sharpe ratio': 0.6174990219156727}) +``` +```python +from openbb_terminal.sdk import openbb +p = openbb.portfolio.po.load(symbols_file_path="~/openbb_terminal/miscellaneous/portfolio_examples/allocation/60_40_Portfolio.xlsx") +weights, performance = openbb.portfolio.po.hrp(portfolio_engine=p) +``` + +--- diff --git a/website/content/sdk/reference/portfolio/po/load.md b/website/content/sdk/reference/portfolio/po/load.md new file mode 100644 index 000000000000..e9e895e50fe5 --- /dev/null +++ b/website/content/sdk/reference/portfolio/po/load.md @@ -0,0 +1,68 @@ +--- +title: load +description: This page provides detailed documentation for the 'load' function of + the OpenBB portfolio optimization engine. It includes source code, parameters detail, + return type, and coding examples. +keywords: +- portfolio optimization +- po.load function +- OpenBB portfolio +- PoEngine +- openbb_terminal.sdk +- coding examples +- software documentation +- parameters detail +- portfolio allocation +- AAPL +- MSFT +- AMZN +- Python code +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Load portfolio optimization engine + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/portfolio/portfolio_optimization/po_model.py#L61)] + +```python +openbb.portfolio.po.load(symbols: List[str] = None, symbols_file_path: str = None, parameters_file_path: str = None) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| symbols | List[str] | List of symbols, by default None | None | True | +| symbols_file_path | str | Symbols file full path, by default None | None | True | +| parameters_file_path | str | Parameters file full path, by default None | None | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| PoEngine | Portfolio optimization engine | +--- + +## Examples + +```python +from openbb_terminal.sdk import openbb +p = openbb.portfolio.po.load(symbols_file_path="~/openbb_terminal/miscellaneous/portfolio_examples/allocation/60_40_Portfolio.xlsx") +weights, performance = openbb.portfolio.po.equal(portfolio_engine=p) +``` + +```python +from openbb_terminal.sdk import openbb +p = openbb.portfolio.po.load(symbols=["AAPL", "MSFT", "AMZN"]) +weights, performance = openbb.portfolio.po.equal(portfolio_engine=p) +``` + +--- diff --git a/website/content/sdk/reference/portfolio/po/load_bl_views.md b/website/content/sdk/reference/portfolio/po/load_bl_views.md new file mode 100644 index 000000000000..6c1484ee2667 --- /dev/null +++ b/website/content/sdk/reference/portfolio/po/load_bl_views.md @@ -0,0 +1,42 @@ +--- +title: load_bl_views +description: This page documents the 'load_bl_views' function, part of the OpenBB's + portfolio optimization toolset which allows users to load an Excel file with views + for the Black Litterman model. Learn about inputs, outputs and usage. +keywords: +- load_bl_views +- OpenBB portfolio optimization +- Black Litterman model +- Excel file loading +- p_views matrix +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Load a Excel file with views for Black Litterman model. + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/portfolio/portfolio_optimization/excel_model.py#L101)] + +```python +openbb.portfolio.po.load_bl_views(excel_file: str = "") +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| excel_file | str | The location of the Excel file that needs to be loaded. | | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| list | Returns a list with p_views matrix | +--- diff --git a/website/content/sdk/reference/portfolio/po/maxdecorr.md b/website/content/sdk/reference/portfolio/po/maxdecorr.md new file mode 100644 index 000000000000..3fb6154feb8f --- /dev/null +++ b/website/content/sdk/reference/portfolio/po/maxdecorr.md @@ -0,0 +1,86 @@ +--- +title: maxdecorr +description: The page details the function openbb.portfolio.po.maxdecorr(), an optimization + tool for decorrelation weights in a portfolio. Explains parameters, returns, and + provides examples. +keywords: +- maxdecorr +- portfolio optimization +- portfolio_engine +- log_returns +- covariance +- Ledoit and Wolf Shrinkage method +- Oracle Approximation Shrinkage method +- Shrunk Covariance method +- Graphical Lasso Covariance method +- j-LoGo Covariance method +- spectral method +- programming +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Optimize decorrelation weights + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/portfolio/portfolio_optimization/po_model.py#L927)] + +```python +openbb.portfolio.po.maxdecorr(portfolio_engine: portfolio_optimization.po_engine.PoEngine = None, symbols: List[str] = None, kwargs: Any) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| portfolio_engine | PoEngine | Portfolio optimization engine, by default None
Use `portfolio.po.load` to load a portfolio engine | None | True | +| symbols | List[str] | List of symbols, by default None | None | True | +| interval | str | Interval to get data, by default '3y' | None | True | +| start_date | str | If not using interval, start date string (YYYY-MM-DD), by default "" | None | True | +| end_date | str | If not using interval, end date string (YYYY-MM-DD). If empty use last weekday, by default "" | None | True | +| log_returns | bool | If True use log returns, else arithmetic returns, by default False | None | True | +| freq | str | Frequency of returns, by default 'D'. Options: 'D' for daily, 'W' for weekly, 'M' for monthly | None | True | +| maxnan | float | Maximum percentage of NaNs allowed in the data, by default 0.05 | None | True | +| threshold | float | Value used to replace outliers that are higher than threshold, by default 0.0 | None | True | +| method | str | Method used to fill nan values, by default 'time'
For more information see `interpolate `__. | None | True | +| value | float | Amount to allocate to portfolio in long positions, by default 1.0 | None | True | +| value_short | float | Amount to allocate to portfolio in short positions, by default 0.0 | None | True | +| covariance | str | The method used to estimate the covariance matrix, by default 'hist'
Possible values are:

- 'hist': use historical estimates.
- 'ewma1': use ewma with adjust=True. For more information see `EWM `__.
- 'ewma2': use ewma with adjust=False. For more information see `EWM `__.
- 'ledoit': use the Ledoit and Wolf Shrinkage method.
- 'oas': use the Oracle Approximation Shrinkage method.
- 'shrunk': use the basic Shrunk Covariance method.
- 'gl': use the basic Graphical Lasso Covariance method.
- 'jlogo': use the j-LoGo Covariance method. For more information see: `a-jLogo`.
- 'fixed': denoise using fixed method. For more information see chapter 2 of `a-MLforAM`.
- 'spectral': denoise using spectral method. For more information see chapter 2 of `a-MLforAM`.
- 'shrink': denoise using shrink method. For more information see chapter 2 of `a-MLforAM`. | None | True | +| d_ewma | float | The smoothing factor of ewma methods, by default 0.94 | None | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| Tuple[pd.DataFrame, Dict] | Tuple with weights and performance dictionary | +--- + +## Examples + +```python +from openbb_terminal.sdk import openbb +openbb.portfolio.po.maxdecorr(symbols=["AAPL", "MSFT", "AMZN"]) +``` + +``` +( value + AAPL 0.33444 + MSFT 0.24963 + AMZN 0.41593, + {'Return': 0.2142767096699773, + 'Volatility': 0.33184082287769623, + 'Sharpe ratio': 0.6457213666835423}) +``` +```python +from openbb_terminal.sdk import openbb +p = openbb.portfolio.po.load(symbols_file_path="~/openbb_terminal/miscellaneous/portfolio_examples/allocation/60_40_Portfolio.xlsx") +weights, performance = openbb.portfolio.po.maxdecorr(portfolio_engine=p) +``` + +--- diff --git a/website/content/sdk/reference/portfolio/po/maxdiv.md b/website/content/sdk/reference/portfolio/po/maxdiv.md new file mode 100644 index 000000000000..81f0d16a7307 --- /dev/null +++ b/website/content/sdk/reference/portfolio/po/maxdiv.md @@ -0,0 +1,90 @@ +--- +title: maxdiv +description: This page is about the function 'maxdiv' of the openbb.portfolio.po. + It provides an overview, parameters, returns and examples of this function, which + is used to optimize diversification weights for portfolio. Use 'maxdiv' to maximize + diversity across various assets in your portfolio. +keywords: +- maxdiv +- portfolio optimization +- diversification +- OpenBB portfolio +- OpenBB maxdiv +- maximize diversity +- portfolio weights +- portfolio performance +- portfolio examples +- Risk measures +- Portfolio risk +- Covariance estimation methods +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Optimize diversification weights + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/portfolio/portfolio_optimization/po_model.py#L813)] + +```python +openbb.portfolio.po.maxdiv(portfolio_engine: portfolio_optimization.po_engine.PoEngine = None, symbols: List[str] = None, kwargs: Any) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| portfolio_engine | PoEngine | Portfolio optimization engine, by default None
Use `portfolio.po.load` to load a portfolio engine | None | True | +| symbols | List[str] | List of symbols, by default None | None | True | +| interval | str | Interval to get data, by default '3y' | None | True | +| start_date | str | If not using interval, start date string (YYYY-MM-DD), by default "" | None | True | +| end_date | str | If not using interval, end date string (YYYY-MM-DD). If empty use last weekday, by default "" | None | True | +| log_returns | bool | If True use log returns, else arithmetic returns, by default False | None | True | +| freq | str | Frequency of returns, by default 'D'. Options: 'D' for daily, 'W' for weekly, 'M' for monthly | None | True | +| maxnan | float | Maximum percentage of NaNs allowed in the data, by default 0.05 | None | True | +| threshold | float | Value used to replace outliers that are higher than threshold, by default 0.0 | None | True | +| method | str | Method used to fill nan values, by default 'time'
For more information see `interpolate `__. | None | True | +| value | float | Amount to allocate to portfolio in long positions, by default 1.0 | None | True | +| value_short | float | Amount to allocate to portfolio in short positions, by default 0.0 | None | True | +| covariance | str | The method used to estimate the covariance matrix, by default 'hist'
Possible values are:

- 'hist': use historical estimates.
- 'ewma1': use ewma with adjust=True. For more information see `EWM `__.
- 'ewma2': use ewma with adjust=False. For more information see `EWM `__.
- 'ledoit': use the Ledoit and Wolf Shrinkage method.
- 'oas': use the Oracle Approximation Shrinkage method.
- 'shrunk': use the basic Shrunk Covariance method.
- 'gl': use the basic Graphical Lasso Covariance method.
- 'jlogo': use the j-LoGo Covariance method. For more information see: `a-jLogo`.
- 'fixed': denoise using fixed method. For more information see chapter 2 of `a-MLforAM`.
- 'spectral': denoise using spectral method. For more information see chapter 2 of `a-MLforAM`.
- 'shrink': denoise using shrink method. For more information see chapter 2 of `a-MLforAM`. | None | True | +| d_ewma | float | The smoothing factor of ewma methods, by default 0.94 | None | True | +| risk_measure | str | The risk measure used to optimize the portfolio, by default 'MV'
Possible values are:

- 'MV': Standard Deviation.
- 'MAD': Mean Absolute Deviation.
- 'MSV': Semi Standard Deviation.
- 'FLPM': First Lower Partial Moment (Omega Ratio).
- 'SLPM': Second Lower Partial Moment (Sortino Ratio).
- 'CVaR': Conditional Value at Risk.
- 'EVaR': Entropic Value at Risk.
- 'WR': Worst Realization.
- 'ADD': Average Drawdown of uncompounded cumulative returns.
- 'UCI': Ulcer Index of uncompounded cumulative returns.
- 'CDaR': Conditional Drawdown at Risk of uncompounded cumulative returns.
- 'EDaR': Entropic Drawdown at Risk of uncompounded cumulative returns.
- 'MDD': Maximum Drawdown of uncompounded cumulative returns. | None | True | +| risk_free_rate | float | Risk free rate, annualized. Used for 'FLPM' and 'SLPM' and Sharpe objective function, by default 0.0 | None | True | +| alpha | float | Significance level of VaR, CVaR, EDaR, DaR, CDaR, EDaR, Tail Gini of losses, by default 0.05 | None | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| Tuple[pd.DataFrame, Dict] | Tuple with weights and performance dictionary | +--- + +## Examples + +```python +from openbb_terminal.sdk import openbb +openbb.portfolio.po.maxdiv(symbols=["AAPL", "MSFT", "AMZN"]) +``` + +``` +( value + AAPL 0.33696 + MSFT 0.26766 + AMZN 0.39538, + {'Return': 0.21717206203731806, + 'Volatility': 0.3310292858117002, + 'Sharpe ratio': 0.6560509034866852}) +``` +```python +from openbb_terminal.sdk import openbb +p = openbb.portfolio.po.load(symbols_file_path="~/openbb_terminal/miscellaneous/portfolio_examples/allocation/60_40_Portfolio.xlsx") +weights, performance = openbb.portfolio.po.maxdiv(portfolio_engine=p) +``` + +--- diff --git a/website/content/sdk/reference/portfolio/po/maxret.md b/website/content/sdk/reference/portfolio/po/maxret.md new file mode 100644 index 000000000000..5935a203d061 --- /dev/null +++ b/website/content/sdk/reference/portfolio/po/maxret.md @@ -0,0 +1,94 @@ +--- +title: maxret +description: This documentation page provides detailed information on the maxret function + of the OpenBB Terminal library. The function helps in optimizing maximum return + weights for a given stock portfolio based on several parameters. +keywords: +- maxret function +- Stock portfolio optimization +- Maximum return weights +- Python library +- PoEngine +- Portfolio engine +- Pandas DataFrame +- Portfolio returns +- Performance dictionary +- Risk measures +- Sharpe ratio +- Risk free rate +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Optimize maximum return weights + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/portfolio/portfolio_optimization/po_model.py#L676)] + +```python +openbb.portfolio.po.maxret(portfolio_engine: portfolio_optimization.po_engine.PoEngine = None, symbols: List[str] = None, kwargs: Any) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| portfolio_engine | PoEngine | Portfolio optimization engine, by default None
Use `portfolio.po.load` to load a portfolio engine | None | True | +| symbols | List[str] | List of symbols, by default None | None | True | +| interval | str | Interval to get data, by default '3y' | None | True | +| start_date | str | If not using interval, start date string (YYYY-MM-DD), by default "" | None | True | +| end_date | str | If not using interval, end date string (YYYY-MM-DD). If empty use last weekday, by default "" | None | True | +| log_returns | bool | If True use log returns, else arithmetic returns, by default False | None | True | +| freq | str | Frequency of returns, by default 'D'. Options: 'D' for daily, 'W' for weekly, 'M' for monthly | None | True | +| maxnan | float | Maximum percentage of NaNs allowed in the data, by default 0.05 | None | True | +| threshold | float | Value used to replace outliers that are higher than threshold, by default 0.0 | None | True | +| method | str | Method used to fill nan values, by default 'time'
For more information see `interpolate `__. | None | True | +| value | float | Amount to allocate to portfolio in long positions, by default 1.0 | None | True | +| value_short | float | Amount to allocate to portfolio in short positions, by default 0.0 | None | True | +| objective | str | Objective function of the optimization model, by default 'Sharpe'
Possible values are:

- 'MinRisk': Minimize the selected risk measure.
- 'Utility': Maximize the risk averse utility function.
- 'Sharpe': Maximize the risk adjusted return ratio based on the selected risk measure.
- 'MaxRet': Maximize the expected return of the portfolio. | None | True | +| risk_measure | str | The risk measure used to optimize the portfolio, by default 'MV'
Possible values are:

- 'MV': Standard Deviation.
- 'MAD': Mean Absolute Deviation.
- 'MSV': Semi Standard Deviation.
- 'FLPM': First Lower Partial Moment (Omega Ratio).
- 'SLPM': Second Lower Partial Moment (Sortino Ratio).
- 'CVaR': Conditional Value at Risk.
- 'EVaR': Entropic Value at Risk.
- 'WR': Worst Realization.
- 'ADD': Average Drawdown of uncompounded cumulative returns.
- 'UCI': Ulcer Index of uncompounded cumulative returns.
- 'CDaR': Conditional Drawdown at Risk of uncompounded cumulative returns.
- 'EDaR': Entropic Drawdown at Risk of uncompounded cumulative returns.
- 'MDD': Maximum Drawdown of uncompounded cumulative returns. | None | True | +| risk_free_rate | float | Risk free rate, annualized. Used for 'FLPM' and 'SLPM' and Sharpe objective function, by default 0.0 | None | True | +| risk_aversion | float | Risk aversion factor of the 'Utility' objective function, by default 1.0 | None | True | +| alpha | float | Significance level of VaR, CVaR, EDaR, DaR, CDaR, EDaR, Tail Gini of losses, by default 0.05 | None | True | +| target_return | float | Constraint on minimum level of portfolio's return, by default -1.0 | None | True | +| target_risk | float | Constraint on maximum level of portfolio's risk, by default -1.0 | None | True | +| mean | str | The method used to estimate the expected returns, by default 'hist'
Possible values are:

- 'hist': use historical estimates.
- 'ewma1': use ewma with adjust=True. For more information see `EWM `__.
- 'ewma2': use ewma with adjust=False. For more information see `EWM `__. | None | True | +| covariance | str | The method used to estimate the covariance matrix, by default 'hist'
Possible values are:

- 'hist': use historical estimates.
- 'ewma1': use ewma with adjust=True. For more information see `EWM `__.
- 'ewma2': use ewma with adjust=False. For more information see `EWM `__.
- 'ledoit': use the Ledoit and Wolf Shrinkage method.
- 'oas': use the Oracle Approximation Shrinkage method.
- 'shrunk': use the basic Shrunk Covariance method.
- 'gl': use the basic Graphical Lasso Covariance method.
- 'jlogo': use the j-LoGo Covariance method. For more information see: `a-jLogo`.
- 'fixed': denoise using fixed method. For more information see chapter 2 of `a-MLforAM`.
- 'spectral': denoise using spectral method. For more information see chapter 2 of `a-MLforAM`.
- 'shrink': denoise using shrink method. For more information see chapter 2 of `a-MLforAM`. | None | True | +| d_ewma | float | The smoothing factor of ewma methods, by default 0.94 | None | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| Tuple[pd.DataFrame, Dict] | Tuple with weights and performance dictionary | +--- + +## Examples + +```python +from openbb_terminal.sdk import openbb +openbb.portfolio.po.maxret(symbols=["AAPL", "MSFT", "AMZN"]) +``` + +``` +( value + AAPL 1.0 + MSFT 0.0 + AMZN 0.0, + {'Return': 0.3448948339574538, + 'Volatility': 0.36513261935342495, + 'Sharpe ratio': 0.9445741510802071}) +``` +```python +from openbb_terminal.sdk import openbb +p = openbb.portfolio.po.load(symbols_file_path="~/openbb_terminal/miscellaneous/portfolio_examples/allocation/60_40_Portfolio.xlsx") +weights, performance = openbb.portfolio.po.maxret(portfolio_engine=p) +``` + +--- diff --git a/website/content/sdk/reference/portfolio/po/maxsharpe.md b/website/content/sdk/reference/portfolio/po/maxsharpe.md new file mode 100644 index 000000000000..bda0abcbc037 --- /dev/null +++ b/website/content/sdk/reference/portfolio/po/maxsharpe.md @@ -0,0 +1,88 @@ +--- +title: maxsharpe +description: This page provides comprehensive details about the openbb.portfolio.po.maxsharpe + function. It's a key part of OpenBB's portfolio optimization module, designed to + optimize the Sharpe ratio of portfolio weights. You'll also find information about + the parameters used by the function and examples of how to use it in portfolio management. +keywords: +- openbb.portfolio.po.maxsharpe +- Portfolio Optimization +- Sharpe Ratio +- Portfolio Management +- Financial Risk Measure +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Optimize Sharpe ratio weights + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/portfolio/portfolio_optimization/po_model.py#L265)] + +```python +openbb.portfolio.po.maxsharpe(portfolio_engine: portfolio_optimization.po_engine.PoEngine = None, symbols: List[str] = None, kwargs: Any) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| portfolio_engine | PoEngine | Portfolio optimization engine, by default None
Use `portfolio.po.load` to load a portfolio engine | None | True | +| symbols | List[str] | List of symbols, by default None | None | True | +| interval | str | Interval to get data, by default '3y' | None | True | +| start_date | str | If not using interval, start date string (YYYY-MM-DD), by default "" | None | True | +| end_date | str | If not using interval, end date string (YYYY-MM-DD). If empty use last weekday, by default "" | None | True | +| log_returns | bool | If True use log returns, else arithmetic returns, by default False | None | True | +| freq | str | Frequency of returns, by default 'D'. Options: 'D' for daily, 'W' for weekly, 'M' for monthly | None | True | +| maxnan | float | Maximum percentage of NaNs allowed in the data, by default 0.05 | None | True | +| threshold | float | Value used to replace outliers that are higher than threshold, by default 0.0 | None | True | +| method | str | Method used to fill nan values, by default 'time'
For more information see `interpolate `__. | None | True | +| value | float | Amount to allocate to portfolio in long positions, by default 1.0 | None | True | +| value_short | float | Amount to allocate to portfolio in short positions, by default 0.0 | None | True | +| objective | str | Objective function of the optimization model, by default 'Sharpe'
Possible values are:

- 'MinRisk': Minimize the selected risk measure.
- 'Utility': Maximize the risk averse utility function.
- 'Sharpe': Maximize the risk adjusted return ratio based on the selected risk measure.
- 'MaxRet': Maximize the expected return of the portfolio. | None | True | +| risk_measure | str | The risk measure used to optimize the portfolio, by default 'MV'
Possible values are:

- 'MV': Standard Deviation.
- 'MAD': Mean Absolute Deviation.
- 'MSV': Semi Standard Deviation.
- 'FLPM': First Lower Partial Moment (Omega Ratio).
- 'SLPM': Second Lower Partial Moment (Sortino Ratio).
- 'CVaR': Conditional Value at Risk.
- 'EVaR': Entropic Value at Risk.
- 'WR': Worst Realization.
- 'ADD': Average Drawdown of uncompounded cumulative returns.
- 'UCI': Ulcer Index of uncompounded cumulative returns.
- 'CDaR': Conditional Drawdown at Risk of uncompounded cumulative returns.
- 'EDaR': Entropic Drawdown at Risk of uncompounded cumulative returns.
- 'MDD': Maximum Drawdown of uncompounded cumulative returns. | None | True | +| risk_free_rate | float | Risk free rate, annualized. Used for 'FLPM' and 'SLPM' and Sharpe objective function, by default 0.0 | None | True | +| risk_aversion | float | Risk aversion factor of the 'Utility' objective function, by default 1.0 | None | True | +| alpha | float | Significance level of VaR, CVaR, EDaR, DaR, CDaR, EDaR, Tail Gini of losses, by default 0.05 | None | True | +| target_return | float | Constraint on minimum level of portfolio's return, by default -1.0 | None | True | +| target_risk | float | Constraint on maximum level of portfolio's risk, by default -1.0 | None | True | +| mean | str | The method used to estimate the expected returns, by default 'hist'
Possible values are:

- 'hist': use historical estimates.
- 'ewma1': use ewma with adjust=True. For more information see `EWM `__.
- 'ewma2': use ewma with adjust=False. For more information see `EWM `__. | None | True | +| covariance | str | The method used to estimate the covariance matrix, by default 'hist'
Possible values are:

- 'hist': use historical estimates.
- 'ewma1': use ewma with adjust=True. For more information see `EWM `__.
- 'ewma2': use ewma with adjust=False. For more information see `EWM `__.
- 'ledoit': use the Ledoit and Wolf Shrinkage method.
- 'oas': use the Oracle Approximation Shrinkage method.
- 'shrunk': use the basic Shrunk Covariance method.
- 'gl': use the basic Graphical Lasso Covariance method.
- 'jlogo': use the j-LoGo Covariance method. For more information see: `a-jLogo`.
- 'fixed': denoise using fixed method. For more information see chapter 2 of `a-MLforAM`.
- 'spectral': denoise using spectral method. For more information see chapter 2 of `a-MLforAM`.
- 'shrink': denoise using shrink method. For more information see chapter 2 of `a-MLforAM`. | None | True | +| d_ewma | float | The smoothing factor of ewma methods, by default 0.94 | None | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| Tuple[pd.DataFrame, Dict] | Tuple with weights and performance dictionary | +--- + +## Examples + +```python +from openbb_terminal.sdk import openbb +openbb.portfolio.po.maxsharpe(symbols=["AAPL", "MSFT", "AMZN"]) +``` + +``` +( value + AAPL 1.0 + MSFT 0.0 + AMZN 0.0, + {'Return': 0.3448948339574538, + 'Volatility': 0.36513261935342495, + 'Sharpe ratio': 0.9445741510802071}) +``` +```python +from openbb_terminal.sdk import openbb +p = openbb.portfolio.po.load(symbols_file_path="~/openbb_terminal/miscellaneous/portfolio_examples/allocation/60_40_Portfolio.xlsx") +weights, performance = openbb.portfolio.po.maxsharpe(portfolio_engine=p) +``` + +--- diff --git a/website/content/sdk/reference/portfolio/po/maxutil.md b/website/content/sdk/reference/portfolio/po/maxutil.md new file mode 100644 index 000000000000..3303cb54a869 --- /dev/null +++ b/website/content/sdk/reference/portfolio/po/maxutil.md @@ -0,0 +1,91 @@ +--- +title: maxutil +description: Documentation page of the maxutil module in the OpenBB Terminal's portfolio + optimization tool. It includes the module's function signature with its parameters, + default values, and optional indicators. Specializations like risk measures and + return calculations are also detailed. Examples of use are provided for better understanding. +keywords: +- Docusaurus SEO +- Portfolio Optimization +- maxutil function +- Portfolio Management Tools +- Python in Finance +- Algorithmic Trading +- Risk Measures +- OpenBB maxutil +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Optimize maximum utility weights + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/portfolio/portfolio_optimization/po_model.py#L539)] + +```python +openbb.portfolio.po.maxutil(portfolio_engine: portfolio_optimization.po_engine.PoEngine = None, symbols: List[str] = None, kwargs: Any) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| portfolio_engine | PoEngine | Portfolio optimization engine, by default None
Use `portfolio.po.load` to load a portfolio engine | None | True | +| symbols | List[str] | List of symbols, by default None | None | True | +| interval | str | Interval to get data, by default '3y' | None | True | +| start_date | str | If not using interval, start date string (YYYY-MM-DD), by default "" | None | True | +| end_date | str | If not using interval, end date string (YYYY-MM-DD). If empty use last weekday, by default "" | None | True | +| log_returns | bool | If True use log returns, else arithmetic returns, by default False | None | True | +| freq | str | Frequency of returns, by default 'D'. Options: 'D' for daily, 'W' for weekly, 'M' for monthly | None | True | +| maxnan | float | Maximum percentage of NaNs allowed in the data, by default 0.05 | None | True | +| threshold | float | Value used to replace outliers that are higher than threshold, by default 0.0 | None | True | +| method | str | Method used to fill nan values, by default 'time'
For more information see `interpolate `__. | None | True | +| value | float | Amount to allocate to portfolio in long positions, by default 1.0 | None | True | +| value_short | float | Amount to allocate to portfolio in short positions, by default 0.0 | None | True | +| objective | str | Objective function of the optimization model, by default 'Sharpe'
Possible values are:

- 'MinRisk': Minimize the selected risk measure.
- 'Utility': Maximize the risk averse utility function.
- 'Sharpe': Maximize the risk adjusted return ratio based on the selected risk measure.
- 'MaxRet': Maximize the expected return of the portfolio. | None | True | +| risk_measure | str | The risk measure used to optimize the portfolio, by default 'MV'
Possible values are:

- 'MV': Standard Deviation.
- 'MAD': Mean Absolute Deviation.
- 'MSV': Semi Standard Deviation.
- 'FLPM': First Lower Partial Moment (Omega Ratio).
- 'SLPM': Second Lower Partial Moment (Sortino Ratio).
- 'CVaR': Conditional Value at Risk.
- 'EVaR': Entropic Value at Risk.
- 'WR': Worst Realization.
- 'ADD': Average Drawdown of uncompounded cumulative returns.
- 'UCI': Ulcer Index of uncompounded cumulative returns.
- 'CDaR': Conditional Drawdown at Risk of uncompounded cumulative returns.
- 'EDaR': Entropic Drawdown at Risk of uncompounded cumulative returns.
- 'MDD': Maximum Drawdown of uncompounded cumulative returns. | None | True | +| risk_free_rate | float | Risk free rate, annualized. Used for 'FLPM' and 'SLPM' and Sharpe objective function, by default 0.0 | None | True | +| risk_aversion | float | Risk aversion factor of the 'Utility' objective function, by default 1.0 | None | True | +| alpha | float | Significance level of VaR, CVaR, EDaR, DaR, CDaR, EDaR, Tail Gini of losses, by default 0.05 | None | True | +| target_return | float | Constraint on minimum level of portfolio's return, by default -1.0 | None | True | +| target_risk | float | Constraint on maximum level of portfolio's risk, by default -1.0 | None | True | +| mean | str | The method used to estimate the expected returns, by default 'hist'
Possible values are:

- 'hist': use historical estimates.
- 'ewma1': use ewma with adjust=True. For more information see `EWM `__.
- 'ewma2': use ewma with adjust=False. For more information see `EWM `__. | None | True | +| covariance | str | The method used to estimate the covariance matrix, by default 'hist'
Possible values are:

- 'hist': use historical estimates.
- 'ewma1': use ewma with adjust=True. For more information see `EWM `__.
- 'ewma2': use ewma with adjust=False. For more information see `EWM `__.
- 'ledoit': use the Ledoit and Wolf Shrinkage method.
- 'oas': use the Oracle Approximation Shrinkage method.
- 'shrunk': use the basic Shrunk Covariance method.
- 'gl': use the basic Graphical Lasso Covariance method.
- 'jlogo': use the j-LoGo Covariance method. For more information see: `a-jLogo`.
- 'fixed': denoise using fixed method. For more information see chapter 2 of `a-MLforAM`.
- 'spectral': denoise using spectral method. For more information see chapter 2 of `a-MLforAM`.
- 'shrink': denoise using shrink method. For more information see chapter 2 of `a-MLforAM`. | None | True | +| d_ewma | float | The smoothing factor of ewma methods, by default 0.94 | None | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| Tuple[pd.DataFrame, Dict] | Tuple with weights and performance dictionary | +--- + +## Examples + +```python +from openbb_terminal.sdk import openbb +openbb.portfolio.po.maxutil(symbols=["AAPL", "MSFT", "AMZN"]) +``` + +``` +( value + AAPL 1.0 + MSFT 0.0 + AMZN 0.0, + {'Return': 0.3448948339574538, + 'Volatility': 0.36513261935342495, + 'Sharpe ratio': 0.9445741510802071}) +``` +```python +from openbb_terminal.sdk import openbb +p = openbb.portfolio.po.load(symbols_file_path="~/openbb_terminal/miscellaneous/portfolio_examples/allocation/60_40_Portfolio.xlsx") +weights, performance = openbb.portfolio.po.maxutil(portfolio_engine=p) +``` + +--- diff --git a/website/content/sdk/reference/portfolio/po/minrisk.md b/website/content/sdk/reference/portfolio/po/minrisk.md new file mode 100644 index 000000000000..8be755c32236 --- /dev/null +++ b/website/content/sdk/reference/portfolio/po/minrisk.md @@ -0,0 +1,93 @@ +--- +title: minrisk +description: This page provides a detailed explanation of the 'minrisk' function provided + by OpenBB, used in portfolio optimization to decrease risk. It includes information + about the function's parameters, return structure, and usage examples. +keywords: +- portfolio optimization +- minrisk function +- risk minimization +- portfolio weights +- instructions +- parameters +- returns +- examples +- sharpe ratio +- return volatility +- financial portfolio +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Optimize minimum risk weights + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/portfolio/portfolio_optimization/po_model.py#L402)] + +```python +openbb.portfolio.po.minrisk(portfolio_engine: portfolio_optimization.po_engine.PoEngine = None, symbols: List[str] = None, kwargs: Any) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| portfolio_engine | PoEngine | Portfolio optimization engine, by default None
Use `portfolio.po.load` to load a portfolio engine | None | True | +| symbols | List[str] | List of symbols, by default None | None | True | +| interval | str | Interval to get data, by default '3y' | None | True | +| start_date | str | If not using interval, start date string (YYYY-MM-DD), by default "" | None | True | +| end_date | str | If not using interval, end date string (YYYY-MM-DD). If empty use last weekday, by default "" | None | True | +| log_returns | bool | If True use log returns, else arithmetic returns, by default False | None | True | +| freq | str | Frequency of returns, by default 'D'. Options: 'D' for daily, 'W' for weekly, 'M' for monthly | None | True | +| maxnan | float | Maximum percentage of NaNs allowed in the data, by default 0.05 | None | True | +| threshold | float | Value used to replace outliers that are higher than threshold, by default 0.0 | None | True | +| method | str | Method used to fill nan values, by default 'time'
For more information see `interpolate `__. | None | True | +| value | float | Amount to allocate to portfolio in long positions, by default 1.0 | None | True | +| value_short | float | Amount to allocate to portfolio in short positions, by default 0.0 | None | True | +| objective | str | Objective function of the optimization model, by default 'Sharpe'
Possible values are:

- 'MinRisk': Minimize the selected risk measure.
- 'Utility': Maximize the risk averse utility function.
- 'Sharpe': Maximize the risk adjusted return ratio based on the selected risk measure.
- 'MaxRet': Maximize the expected return of the portfolio. | None | True | +| risk_measure | str | The risk measure used to optimize the portfolio, by default 'MV'
Possible values are:

- 'MV': Standard Deviation.
- 'MAD': Mean Absolute Deviation.
- 'MSV': Semi Standard Deviation.
- 'FLPM': First Lower Partial Moment (Omega Ratio).
- 'SLPM': Second Lower Partial Moment (Sortino Ratio).
- 'CVaR': Conditional Value at Risk.
- 'EVaR': Entropic Value at Risk.
- 'WR': Worst Realization.
- 'ADD': Average Drawdown of uncompounded cumulative returns.
- 'UCI': Ulcer Index of uncompounded cumulative returns.
- 'CDaR': Conditional Drawdown at Risk of uncompounded cumulative returns.
- 'EDaR': Entropic Drawdown at Risk of uncompounded cumulative returns.
- 'MDD': Maximum Drawdown of uncompounded cumulative returns. | None | True | +| risk_free_rate | float | Risk free rate, annualized. Used for 'FLPM' and 'SLPM' and Sharpe objective function, by default 0.0 | None | True | +| risk_aversion | float | Risk aversion factor of the 'Utility' objective function, by default 1.0 | None | True | +| alpha | float | Significance level of VaR, CVaR, EDaR, DaR, CDaR, EDaR, Tail Gini of losses, by default 0.05 | None | True | +| target_return | float | Constraint on minimum level of portfolio's return, by default -1.0 | None | True | +| target_risk | float | Constraint on maximum level of portfolio's risk, by default -1.0 | None | True | +| mean | str | The method used to estimate the expected returns, by default 'hist'
Possible values are:

- 'hist': use historical estimates.
- 'ewma1': use ewma with adjust=True. For more information see `EWM `__.
- 'ewma2': use ewma with adjust=False. For more information see `EWM `__. | None | True | +| covariance | str | The method used to estimate the covariance matrix, by default 'hist'
Possible values are:

- 'hist': use historical estimates.
- 'ewma1': use ewma with adjust=True. For more information see `EWM `__.
- 'ewma2': use ewma with adjust=False. For more information see `EWM `__.
- 'ledoit': use the Ledoit and Wolf Shrinkage method.
- 'oas': use the Oracle Approximation Shrinkage method.
- 'shrunk': use the basic Shrunk Covariance method.
- 'gl': use the basic Graphical Lasso Covariance method.
- 'jlogo': use the j-LoGo Covariance method. For more information see: `a-jLogo`.
- 'fixed': denoise using fixed method. For more information see chapter 2 of `a-MLforAM`.
- 'spectral': denoise using spectral method. For more information see chapter 2 of `a-MLforAM`.
- 'shrink': denoise using shrink method. For more information see chapter 2 of `a-MLforAM`. | None | True | +| d_ewma | float | The smoothing factor of ewma methods, by default 0.94 | None | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| Tuple[pd.DataFrame, Dict] | Tuple with weights and performance dictionary | +--- + +## Examples + +```python +from openbb_terminal.sdk import openbb +openbb.portfolio.po.minrisk(symbols=["AAPL", "MSFT", "AMZN"]) +``` + +``` +( value + AAPL 0.25044 + MSFT 0.49509 + AMZN 0.25447, + {'Return': 0.2248615963428331, + 'Volatility': 0.32736590080425004, + 'Sharpe ratio': 0.6868815468880802}) +``` +```python +from openbb_terminal.sdk import openbb +p = openbb.portfolio.po.load(symbols_file_path="~/openbb_terminal/miscellaneous/portfolio_examples/allocation/60_40_Portfolio.xlsx") +weights, performance = openbb.portfolio.po.minrisk(portfolio_engine=p) +``` + +--- diff --git a/website/content/sdk/reference/portfolio/po/mktcap.md b/website/content/sdk/reference/portfolio/po/mktcap.md new file mode 100644 index 000000000000..c5c372f7ef55 --- /dev/null +++ b/website/content/sdk/reference/portfolio/po/mktcap.md @@ -0,0 +1,83 @@ +--- +title: mktcap +description: The page explains the 'mktcap' function of OpenBB Terminal's portfolio + optimization module. It includes detailed parametric descriptions and examples showing + how to use the function. The 'mktcap' function optimizes a specified portfolio according + to market capitalization. +keywords: +- market capitalization +- portfolio optimization +- PoEngine +- portfolio engine +- frequency of returns +- arithmetic returns +- log returns +- outliers threshold +- nan values +- data interpolation +- allocation +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Optimize weighted according to market capitalization + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/portfolio/portfolio_optimization/po_model.py#L2135)] + +```python +openbb.portfolio.po.mktcap(symbols: List[str] = None, portfolio_engine: portfolio_optimization.po_engine.PoEngine = None, kwargs: Any) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| portfolio_engine | PoEngine | Portfolio optimization engine, by default None
Use `portfolio.po.load` to load a portfolio engine | None | True | +| symbols | List[str] | List of symbols, by default None | None | True | +| interval | str | Interval to get data, by default '3y' | None | True | +| start_date | str | If not using interval, start date string (YYYY-MM-DD), by default "" | None | True | +| end_date | str | If not using interval, end date string (YYYY-MM-DD). If empty use last weekday, by default "" | None | True | +| log_returns | bool | If True use log returns, else arithmetic returns, by default False | None | True | +| freq | str | Frequency of returns, by default 'D'. Options: 'D' for daily, 'W' for weekly, 'M' for monthly | None | True | +| maxnan | float | Maximum percentage of NaNs allowed in the data, by default 0.05 | None | True | +| threshold | float | Value used to replace outliers that are higher than threshold, by default 0.0 | None | True | +| method | str | Method used to fill nan values, by default 'time'
For more information see `interpolate `__. | None | True | +| value | float | Amount to allocate to portfolio in long positions, by default 1.0 | None | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| Tuple[pd.DataFrame, Dict] | Tuple with weights and performance dictionary | +--- + +## Examples + +```python +from openbb_terminal.sdk import openbb +openbb.portfolio.po.mktcap(symbols=["AAPL", "MSFT", "AMZN"]) +``` + +``` +( value + AAPL 0.465338 + MSFT 0.345488 + AMZN 0.189175, + {'Return': 0.25830567048487474, + 'Volatility': 0.33058479906988086, + 'Sharpe ratio': 0.7813597939519071}) +``` +```python +from openbb_terminal.sdk import openbb +p = openbb.portfolio.po.load(symbols_file_path="~/openbb_terminal/miscellaneous/portfolio_examples/allocation/60_40_Portfolio.xlsx") +weights, performance = openbb.portfolio.po.mktcap(portfolio_engine=p) +``` + +--- diff --git a/website/content/sdk/reference/portfolio/po/nco.md b/website/content/sdk/reference/portfolio/po/nco.md new file mode 100644 index 000000000000..dbf6407ff61d --- /dev/null +++ b/website/content/sdk/reference/portfolio/po/nco.md @@ -0,0 +1,97 @@ +--- +title: nco +description: This page is about the Non-Convex Optimization (NCO) model used for portfolio + optimization. It includes a detailed explanation of the function parameters, return + values, and examples of usage using the OpenBB financial software. +keywords: +- Non-Convex Optimization +- portfolio optimization +- financial software +- financial modeling +- risk measures +- portfolio performance measures +- Sharpe ratio +- Value at Risk +- Maximum Drawdown +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Optimize with Non-Convex Optimization (NCO) model. + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/portfolio/portfolio_optimization/po_model.py#L1871)] + +```python +openbb.portfolio.po.nco(portfolio_engine: portfolio_optimization.po_engine.PoEngine = None, symbols: List[str] = None, kwargs: Any) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| portfolio_engine | PoEngine | Portfolio optimization engine, by default None
Use `portfolio.po.load` to load a portfolio engine | None | True | +| symbols | List[str] | List of symbols, by default None | None | True | +| interval | str | Interval to get data, by default '3y' | None | True | +| start_date | str | If not using interval, start date string (YYYY-MM-DD), by default "" | None | True | +| end_date | str | If not using interval, end date string (YYYY-MM-DD). If empty use last weekday, by default "" | None | True | +| log_returns | bool | If True use log returns, else arithmetic returns, by default False | None | True | +| freq | str | Frequency of returns, by default 'D'. Options: 'D' for daily, 'W' for weekly, 'M' for monthly | None | True | +| maxnan | float | Maximum percentage of NaNs allowed in the data, by default 0.05 | None | True | +| threshold | float | Value used to replace outliers that are higher than threshold, by default 0.0 | None | True | +| method | str | Method used to fill nan values, by default 'time'
For more information see `interpolate `__. | None | True | +| value | float | Amount to allocate to portfolio in long positions, by default 1.0 | None | True | +| objective | str | Objective function of the optimization model, by default 'MinRisk'
Possible values are:

- 'MinRisk': Minimize the selected risk measure.
- 'Utility': Maximize the risk averse utility function.
- 'Sharpe': Maximize the risk adjusted return ratio based on the selected risk measure.
- 'MaxRet': Maximize the expected return of the portfolio. | None | True | +| risk_measure | str | The risk measure used to optimize the portfolio, by default 'MV'
If model is 'NCO', the risk measures available depends on the objective function.
Possible values are:

- 'MV': Variance.
- 'MAD': Mean Absolute Deviation.
- 'MSV': Semi Standard Deviation.
- 'FLPM': First Lower Partial Moment (Omega Ratio).
- 'SLPM': Second Lower Partial Moment (Sortino Ratio).
- 'VaR': Value at Risk.
- 'CVaR': Conditional Value at Risk.
- 'TG': Tail Gini.
- 'EVaR': Entropic Value at Risk.
- 'WR': Worst Realization (Minimax).
- 'RG': Range of returns.
- 'CVRG': CVaR range of returns.
- 'TGRG': Tail Gini range of returns.
- 'MDD': Maximum Drawdown of uncompounded cumulative returns (Calmar Ratio).
- 'ADD': Average Drawdown of uncompounded cumulative returns.
- 'DaR': Drawdown at Risk of uncompounded cumulative returns.
- 'CDaR': Conditional Drawdown at Risk of uncompounded cumulative returns.
- 'EDaR': Entropic Drawdown at Risk of uncompounded cumulative returns.
- 'UCI': Ulcer Index of uncompounded cumulative returns.
- 'MDD_Rel': Maximum Drawdown of compounded cumulative returns (Calmar Ratio).
- 'ADD_Rel': Average Drawdown of compounded cumulative returns.
- 'DaR_Rel': Drawdown at Risk of compounded cumulative returns.
- 'CDaR_Rel': Conditional Drawdown at Risk of compounded cumulative returns.
- 'EDaR_Rel': Entropic Drawdown at Risk of compounded cumulative returns.
- 'UCI_Rel': Ulcer Index of compounded cumulative returns. | None | True | +| risk_free_rate | float | Risk free rate, annualized. Used for 'FLPM' and 'SLPM' and Sharpe objective function, by default 0.0 | None | True | +| risk_aversion | float | Risk aversion factor of the 'Utility' objective function, by default 1.0 | None | True | +| alpha | float | Significance level of VaR, CVaR, EDaR, DaR, CDaR, EDaR, Tail Gini of losses, by default 0.05 | None | True | +| a_sim | float | Number of CVaRs used to approximate Tail Gini of losses, by default 100 | None | True | +| beta | float | Significance level of CVaR and Tail Gini of gains. If None it duplicates alpha value, by default None | None | True | +| b_sim | float | Number of CVaRs used to approximate Tail Gini of gains. If None it duplicates a_sim value, by default None | None | True | +| covariance | str | The method used to estimate the covariance matrix, by default 'hist'
Possible values are:

- 'hist': use historical estimates.
- 'ewma1': use ewma with adjust=True. For more information see `EWM `__.
- 'ewma2': use ewma with adjust=False. For more information see `EWM `__.
- 'ledoit': use the Ledoit and Wolf Shrinkage method.
- 'oas': use the Oracle Approximation Shrinkage method.
- 'shrunk': use the basic Shrunk Covariance method.
- 'gl': use the basic Graphical Lasso Covariance method.
- 'jlogo': use the j-LoGo Covariance method. For more information see: `a-jLogo`.
- 'fixed': denoise using fixed method. For more information see chapter 2 of `a-MLforAM`.
- 'spectral': denoise using spectral method. For more information see chapter 2 of `a-MLforAM`.
- 'shrink': denoise using shrink method. For more information see chapter 2 of `a-MLforAM`. | None | True | +| d_ewma | float | The smoothing factor of ewma methods, by default 0.94 | None | True | +| codependence | str | The codependence or similarity matrix used to build the distance
metric and clusters. The default is 'pearson'. Possible values are:

- 'pearson': pearson correlation matrix. Distance formula:
.. math:: D_{i,j} = \sqrt{0.5(1-\rho^{pearson}_{i,j})}
- 'spearman': spearman correlation matrix. Distance formula:
.. math:: D_{i,j} = \sqrt{0.5(1-\rho^{spearman}_{i,j})}
- 'abs_pearson': absolute value pearson correlation matrix. Distance formula:
.. math:: D_{i,j} = \sqrt{(1-|\rho^{pearson}_{i,j}|)}
- 'abs_spearman': absolute value spearman correlation matrix. Distance formula:
.. math:: D_{i,j} = \sqrt{(1-|\rho^{spearman}_{i,j}|)}
- 'distance': distance correlation matrix. Distance formula:
.. math:: D_{i,j} = \sqrt{(1-\rho^{distance}_{i,j})}
- 'mutual_info': mutual information matrix. Distance used is variation information matrix.
- 'tail': lower tail dependence index matrix. Dissimilarity formula:
.. math:: D_{i,j} = -\log{\lambda_{i,j}} | None | True | +| linkage | str | Linkage method of hierarchical clustering. For more information see `linkage cluster.hierarchy.linkage.html?highlight=linkage#scipy.cluster.hierarchy.linkage>`__.
The default is 'single'. Possible values are:

- 'single'.
- 'complete'.
- 'average'.
- 'weighted'.
- 'centroid'.
- 'median'.
- 'ward'.
- 'dbht': Direct Bubble Hierarchical Tree. | None | True | +| k | int | Number of clusters. This value is took instead of the optimal number
of clusters calculated with the two difference gap statistic, by default None | None | True | +| max_k | int | Max number of clusters used by the two difference gap statistic
to find the optimal number of clusters, by default 10 | None | True | +| bins_info | str | Number of bins used to calculate variation of information, by default 'KN'.
Possible values are:

- 'KN': Knuth's choice method. For more information see `knuth_bin_width `__.
- 'FD': Freedman–Diaconis' choice method. For more information see `freedman_bin_width `__.
- 'SC': Scotts' choice method. For more information see `scott_bin_width `__.
- 'HGR': Hacine-Gharbi and Ravier' choice method. | None | True | +| alpha_tail | float | Significance level for lower tail dependence index, by default 0.05 | None | True | +| leaf_order | bool | Indicates if the cluster are ordered so that the distance between
successive leaves is minimal, by default True | None | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| Tuple[pd.DataFrame, Dict] | Tuple with weights and performance dictionary | +--- + +## Examples + +```python +from openbb_terminal.sdk import openbb +openbb.portfolio.po.nco(symbols=["AAPL", "MSFT", "AMZN"]) +``` + +``` +( value + AAPL 0.25044 + MSFT 0.49509 + AMZN 0.25447, + {'Return': 0.2248615963428331, + 'Volatility': 0.32736590080425004, + 'Sharpe ratio': 0.6868815468880802}) +``` +```python +from openbb_terminal.sdk import openbb +p = openbb.portfolio.po.load(symbols_file_path="~/openbb_terminal/miscellaneous/portfolio_examples/allocation/60_40_Portfolio.xlsx") +weights, performance = openbb.portfolio.po.nco(portfolio_engine=p) +``` + +--- diff --git a/website/content/sdk/reference/portfolio/po/plot.md b/website/content/sdk/reference/portfolio/po/plot.md new file mode 100644 index 000000000000..6308679cef1b --- /dev/null +++ b/website/content/sdk/reference/portfolio/po/plot.md @@ -0,0 +1,227 @@ +--- +title: plot +description: This documentation page outlines the functions related to plotting and + charting an investment portfolio using the OpenBB's po module. The page provides + examples of different chart types such as pie, hist, dd, and rc. It includes necessary + parameters for the functions and discusses the usage of a portfolio engine. +keywords: +- plot +- tab +- po +- chart +- portfolio +- example +- pie +- hist +- dd +- rc +- engine +- type +- category +- parameters +- returns +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + +Display efficient frontier + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/portfolio/portfolio_optimization/po_view.py#L237)] + +```python +openbb.portfolio.po.plot(portfolio_engine: portfolio_optimization.po_engine.PoEngine = None, chart_type: str = "pie", kwargs: Any) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| portfolio_engine | PoEngine | Portfolio optimization engine, by default None
Use `portfolio.po.load` to load a portfolio engine | None | True | +| chart_type | str | Chart type, by default "pie"
Options are "pie", "hist", "dd" or "rc" | pie | True | + + +--- + +## Returns + +This function does not return anything + +--- + +## Examples + +```python +from openbb_terminal.sdk import openbb +p = openbb.portfolio.po.load(symbols=["AAPL", "MSFT", "AMZN"]) +d = { +``` + +``` +"SECTOR": { + "AAPL": "INFORMATION TECHNOLOGY", + "MSFT": "INFORMATION TECHNOLOGY", + "AMZN": "CONSUMER DISCRETIONARY", + }, + "CURRENT_INVESTED_AMOUNT": { + "AAPL": "100000.0", + "MSFT": "200000.0", + "AMZN": "300000.0", + }, + "CURRENCY": { + "AAPL": "USD", + "MSFT": "USD", + "AMZN": "USD", + }, + } +``` +```python +p.set_categories_dict(categories=d) +weights, performance = openbb.portfolio.po.equal(portfolio_engine=p) +p.get_available_categories() +``` + +``` +['SECTOR'] +``` +```python +openbb.portfolio.po.plot(portfolio_engine=p, category="SECTOR", chart_type="pie") +openbb.portfolio.po.plot(portfolio_engine=p, category="SECTOR", chart_type="hist") +openbb.portfolio.po.plot(portfolio_engine=p, category="SECTOR", chart_type="dd") +openbb.portfolio.po.plot(portfolio_engine=p, category="SECTOR", chart_type="rc") +openbb.portfolio.po.plot(portfolio_engine=p, category="SECTOR", chart_type="heat") +``` + +```python +from openbb_terminal.sdk import openbb +p = openbb.portfolio.po.load(symbols_file_path="openbb_terminal/miscellaneous/portfolio_examples/allocation/60_40_Portfolio.xlsx") +weights, performance = openbb.portfolio.po.equal(portfolio_engine=p) +p.get_available_categories() +``` + +``` +['ASSET_CLASS', + 'SECTOR', + 'INDUSTRY', + 'COUNTRY', + 'CURRENT_INVESTED_AMOUNT', + 'CURRENCY'] +``` +```python +openbb.portfolio.po.plot(portfolio_engine=p, category="ASSET_CLASS", chart_type="pie") +openbb.portfolio.po.plot(portfolio_engine=p, category="SECTOR", chart_type="hist") +openbb.portfolio.po.plot(portfolio_engine=p, category="INDUSTRY", chart_type="dd") +openbb.portfolio.po.plot(portfolio_engine=p, category="COUNTRY", chart_type="rc") +openbb.portfolio.po.plot(portfolio_engine=p, category="ASSET_CLASS", chart_type="heat") +``` + +--- + + + + +Display efficient frontier + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/portfolio/portfolio_optimization/po_view.py#L237)] + +```python +openbb.portfolio.po.plot_chart(portfolio_engine: portfolio_optimization.po_engine.PoEngine = None, chart_type: str = "pie", kwargs: Any) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| portfolio_engine | PoEngine | Portfolio optimization engine, by default None
Use `portfolio.po.load` to load a portfolio engine | None | True | +| chart_type | str | Chart type, by default "pie"
Options are "pie", "hist", "dd" or "rc" | pie | True | + + +--- + +## Returns + +This function does not return anything + +--- + +## Examples + +```python +from openbb_terminal.sdk import openbb +p = openbb.portfolio.po.load(symbols=["AAPL", "MSFT", "AMZN"]) +d = { +``` + +``` +"SECTOR": { + "AAPL": "INFORMATION TECHNOLOGY", + "MSFT": "INFORMATION TECHNOLOGY", + "AMZN": "CONSUMER DISCRETIONARY", + }, + "CURRENT_INVESTED_AMOUNT": { + "AAPL": "100000.0", + "MSFT": "200000.0", + "AMZN": "300000.0", + }, + "CURRENCY": { + "AAPL": "USD", + "MSFT": "USD", + "AMZN": "USD", + }, + } +``` +```python +p.set_categories_dict(categories=d) +weights, performance = openbb.portfolio.po.equal(portfolio_engine=p) +p.get_available_categories() +``` + +``` +['SECTOR'] +``` +```python +openbb.portfolio.po.plot(portfolio_engine=p, category="SECTOR", chart_type="pie") +openbb.portfolio.po.plot(portfolio_engine=p, category="SECTOR", chart_type="hist") +openbb.portfolio.po.plot(portfolio_engine=p, category="SECTOR", chart_type="dd") +openbb.portfolio.po.plot(portfolio_engine=p, category="SECTOR", chart_type="rc") +openbb.portfolio.po.plot(portfolio_engine=p, category="SECTOR", chart_type="heat") +``` + +```python +from openbb_terminal.sdk import openbb +p = openbb.portfolio.po.load(symbols_file_path="openbb_terminal/miscellaneous/portfolio_examples/allocation/60_40_Portfolio.xlsx") +weights, performance = openbb.portfolio.po.equal(portfolio_engine=p) +p.get_available_categories() +``` + +``` +['ASSET_CLASS', + 'SECTOR', + 'INDUSTRY', + 'COUNTRY', + 'CURRENT_INVESTED_AMOUNT', + 'CURRENCY'] +``` +```python +openbb.portfolio.po.plot(portfolio_engine=p, category="ASSET_CLASS", chart_type="pie") +openbb.portfolio.po.plot(portfolio_engine=p, category="SECTOR", chart_type="hist") +openbb.portfolio.po.plot(portfolio_engine=p, category="INDUSTRY", chart_type="dd") +openbb.portfolio.po.plot(portfolio_engine=p, category="COUNTRY", chart_type="rc") +openbb.portfolio.po.plot(portfolio_engine=p, category="ASSET_CLASS", chart_type="heat") +``` + +--- + + + diff --git a/website/content/sdk/reference/portfolio/po/property.md b/website/content/sdk/reference/portfolio/po/property.md new file mode 100644 index 000000000000..4b0757e8bb25 --- /dev/null +++ b/website/content/sdk/reference/portfolio/po/property.md @@ -0,0 +1,76 @@ +--- +title: property +description: This documentation discusses the use of 'property' function in OpenBB + Terminal's portfolio optimization module. It elaborates on how to call this function + with different parameters, its returns, and provides usage examples. +keywords: +- Portfolio Optimization +- Financial Data +- OpenBB Portfolio +- Property Function +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Optimize weighted according to property + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/portfolio/portfolio_optimization/po_model.py#L2279)] + +```python +openbb.portfolio.po.property(symbols: List[str] = None, portfolio_engine: portfolio_optimization.po_engine.PoEngine = None, prop: str = "marketCap", kwargs: Any) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| portfolio_engine | PoEngine | Portfolio optimization engine, by default None
Use `portfolio.po.load` to load a portfolio engine | None | True | +| symbols | List[str] | List of symbols, by default None | None | True | +| prop | str | Property to use for optimization, by default 'marketCap'
Use `portfolio.po.get_properties() to get a list of available properties | marketCap | True | +| interval | str | Interval to get data, by default '3y' | None | True | +| start_date | str | If not using interval, start date string (YYYY-MM-DD), by default "" | None | True | +| end_date | str | If not using interval, end date string (YYYY-MM-DD). If empty use last weekday, by default "" | None | True | +| log_returns | bool | If True use log returns, else arithmetic returns, by default False | None | True | +| freq | str | Frequency of returns, by default 'D'. Options: 'D' for daily, 'W' for weekly, 'M' for monthly | None | True | +| maxnan | float | Maximum percentage of NaNs allowed in the data, by default 0.05 | None | True | +| threshold | float | Value used to replace outliers that are higher than threshold, by default 0.0 | None | True | +| method | str | Method used to fill nan values, by default 'time'
For more information see `interpolate `__. | None | True | +| value | float | Amount to allocate to portfolio in long positions, by default 1.0 | None | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| Tuple[pd.DataFrame, Dict] | Tuple with weights and performance dictionary | +--- + +## Examples + +```python +from openbb_terminal.sdk import openbb +openbb.portfolio.po.property(symbols=["AAPL", "MSFT", "AMZN"], prop="forwardPE") +``` + +``` +( value + AAPL 0.223192 + MSFT 0.215707 + AMZN 0.561101, + {'Return': 0.18287266638517774, + 'Volatility': 0.3386418179319469, + 'Sharpe ratio': 0.5400179679578959}) +``` +```python +from openbb_terminal.sdk import openbb +p = openbb.portfolio.po.load(symbols_file_path="~/openbb_terminal/miscellaneous/portfolio_examples/allocation/60_40_Portfolio.xlsx") +weights, performance = openbb.portfolio.po.property(portfolio_engine=p, prop="forwardPE") +``` + +--- diff --git a/website/content/sdk/reference/portfolio/po/relriskparity.md b/website/content/sdk/reference/portfolio/po/relriskparity.md new file mode 100644 index 000000000000..6ffd03ea5d93 --- /dev/null +++ b/website/content/sdk/reference/portfolio/po/relriskparity.md @@ -0,0 +1,89 @@ +--- +title: relriskparity +description: This page provides comprehensive details of the 'relriskparity' function + in OpenBB Terminal's portfolio optimization module. It contains a thorough explanation + of parameters and return value, along with Python code examples demonstrating its + usage. +keywords: +- Relriskparity function +- Portfolio optimization +- Relaxed Risk Parity +- openbb.portfolio.po.relriskparity function +- Function parameters +- Python code example +- po_model.py +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Optimize with Relaxed Risk Parity using the least squares approach + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/portfolio/portfolio_optimization/po_model.py#L1352)] + +```python +openbb.portfolio.po.relriskparity(portfolio_engine: portfolio_optimization.po_engine.PoEngine = None, symbols: List[str] = None, kwargs: Any) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| portfolio_engine | PoEngine | Portfolio optimization engine, by default None
Use `portfolio.po.load` to load a portfolio engine | None | True | +| symbols | List[str] | List of symbols, by default None | None | True | +| interval | str | Interval to get data, by default '3y' | None | True | +| start_date | str | If not using interval, start date string (YYYY-MM-DD), by default "" | None | True | +| end_date | str | If not using interval, end date string (YYYY-MM-DD). If empty use last weekday, by default "" | None | True | +| log_returns | bool | If True use log returns, else arithmetic returns, by default False | None | True | +| freq | str | Frequency of returns, by default 'D'. Options: 'D' for daily, 'W' for weekly, 'M' for monthly | None | True | +| maxnan | float | Maximum percentage of NaNs allowed in the data, by default 0.05 | None | True | +| threshold | float | Value used to replace outliers that are higher than threshold, by default 0.0 | None | True | +| method | str | Method used to fill nan values, by default 'time'
For more information see `interpolate `__. | None | True | +| value | float | Amount to allocate to portfolio in long positions, by default 1.0 | None | True | +| risk_measure | str | The risk measure used to optimize the portfolio, by default 'MV'
Possible values are:

- 'MV': Standard Deviation.
- 'MAD': Mean Absolute Deviation.
- 'MSV': Semi Standard Deviation.
- 'FLPM': First Lower Partial Moment (Omega Ratio).
- 'SLPM': Second Lower Partial Moment (Sortino Ratio).
- 'CVaR': Conditional Value at Risk.
- 'EVaR': Entropic Value at Risk.
- 'WR': Worst Realization.
- 'ADD': Average Drawdown of uncompounded cumulative returns.
- 'UCI': Ulcer Index of uncompounded cumulative returns.
- 'CDaR': Conditional Drawdown at Risk of uncompounded cumulative returns.
- 'EDaR': Entropic Drawdown at Risk of uncompounded cumulative returns.
- 'MDD': Maximum Drawdown of uncompounded cumulative returns. | None | True | +| risk_free_rate | float | Risk free rate, annualized. Used for 'FLPM' and 'SLPM' and Sharpe objective function, by default 0.0 | None | True | +| alpha | float | Significance level of VaR, CVaR, EDaR, DaR, CDaR, EDaR, Tail Gini of losses, by default 0.05 | None | True | +| target_return | float | Constraint on minimum level of portfolio's return, by default -1.0 | None | True | +| mean | str | The method used to estimate the expected returns, by default 'hist'
Possible values are:

- 'hist': use historical estimates.
- 'ewma1': use ewma with adjust=True. For more information see `EWM `__.
- 'ewma2': use ewma with adjust=False. For more information see `EWM `__. | None | True | +| covariance | str | The method used to estimate the covariance matrix, by default 'hist'
Possible values are:

- 'hist': use historical estimates.
- 'ewma1': use ewma with adjust=True. For more information see `EWM `__.
- 'ewma2': use ewma with adjust=False. For more information see `EWM `__.
- 'ledoit': use the Ledoit and Wolf Shrinkage method.
- 'oas': use the Oracle Approximation Shrinkage method.
- 'shrunk': use the basic Shrunk Covariance method.
- 'gl': use the basic Graphical Lasso Covariance method.
- 'jlogo': use the j-LoGo Covariance method. For more information see: `a-jLogo`.
- 'fixed': denoise using fixed method. For more information see chapter 2 of `a-MLforAM`.
- 'spectral': denoise using spectral method. For more information see chapter 2 of `a-MLforAM`.
- 'shrink': denoise using shrink method. For more information see chapter 2 of `a-MLforAM`. | None | True | +| d_ewma | float | The smoothing factor of ewma methods, by default 0.94 | None | True | +| risk_cont | List[str] | The vector of risk contribution per asset, by default 1/n (number of assets) | None | True | +| version | str | Relaxed risk parity model version, by default 'A'
Possible values are:

- 'A': without regularization and penalization constraints.
- 'B': with regularization constraint but without penalization constraint.
- 'C': with regularization and penalization constraints. | None | True | +| penal_factor | float | The penalization factor of penalization constraints. Only used with
version 'C', by default 1.0 | None | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| Tuple[pd.DataFrame, Dict] | Tuple with weights and performance dictionary | +--- + +## Examples + +```python +from openbb_terminal.sdk import openbb +openbb.portfolio.po.relriskparity(symbols=["AAPL", "MSFT", "AMZN"]) +``` + +``` +( value + AAPL 0.33204 + MSFT 0.34949 + AMZN 0.31847, + {'Return': 0.19946844097475216, + 'Volatility': 0.290746544981364, + 'Sharpe ratio': 0.6860561008129521}) +``` +```python +from openbb_terminal.sdk import openbb +p = openbb.portfolio.po.load(symbols_file_path="~/openbb_terminal/miscellaneous/portfolio_examples/allocation/60_40_Portfolio.xlsx") +weights, performance = openbb.portfolio.po.relriskparity(portfolio_engine=p) +``` + +--- diff --git a/website/content/sdk/reference/portfolio/po/riskparity.md b/website/content/sdk/reference/portfolio/po/riskparity.md new file mode 100644 index 000000000000..40358b97eb15 --- /dev/null +++ b/website/content/sdk/reference/portfolio/po/riskparity.md @@ -0,0 +1,84 @@ +--- +title: riskparity +description: Documentation page on how to optimize portfolio with Risk Parity using + the risk budgeting approach in the OpenBB Terminal Python package. It includes parameters + specifications, return values, and usage examples. +keywords: +- Risk Parity +- Portfolio Optimization +- Risk Budgeting Approach +- Portfolio Engine +- Investment Strategies +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Optimize with Risk Parity using the risk budgeting approach + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/portfolio/portfolio_optimization/po_model.py#L1228)] + +```python +openbb.portfolio.po.riskparity(portfolio_engine: portfolio_optimization.po_engine.PoEngine = None, symbols: List[str] = None, kwargs: Any) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| portfolio_engine | PoEngine | Portfolio optimization engine, by default None
Use `portfolio.po.load` to load a portfolio engine | None | True | +| symbols | List[str] | List of symbols, by default None | None | True | +| interval | str | Interval to get data, by default '3y' | None | True | +| start_date | str | If not using interval, start date string (YYYY-MM-DD), by default "" | None | True | +| end_date | str | If not using interval, end date string (YYYY-MM-DD). If empty use last weekday, by default "" | None | True | +| log_returns | bool | If True use log returns, else arithmetic returns, by default False | None | True | +| freq | str | Frequency of returns, by default 'D'. Options: 'D' for daily, 'W' for weekly, 'M' for monthly | None | True | +| maxnan | float | Maximum percentage of NaNs allowed in the data, by default 0.05 | None | True | +| threshold | float | Value used to replace outliers that are higher than threshold, by default 0.0 | None | True | +| method | str | Method used to fill nan values, by default 'time'
For more information see `interpolate `__. | None | True | +| value | float | Amount to allocate to portfolio in long positions, by default 1.0 | None | True | +| risk_measure | str | The risk measure used to optimize the portfolio, by default 'MV'
Possible values are:

- 'MV': Standard Deviation.
- 'MAD': Mean Absolute Deviation.
- 'MSV': Semi Standard Deviation.
- 'FLPM': First Lower Partial Moment (Omega Ratio).
- 'SLPM': Second Lower Partial Moment (Sortino Ratio).
- 'CVaR': Conditional Value at Risk.
- 'EVaR': Entropic Value at Risk.
- 'WR': Worst Realization.
- 'ADD': Average Drawdown of uncompounded cumulative returns.
- 'UCI': Ulcer Index of uncompounded cumulative returns.
- 'CDaR': Conditional Drawdown at Risk of uncompounded cumulative returns.
- 'EDaR': Entropic Drawdown at Risk of uncompounded cumulative returns.
- 'MDD': Maximum Drawdown of uncompounded cumulative returns. | None | True | +| risk_free_rate | float | Risk free rate, annualized. Used for 'FLPM' and 'SLPM' and Sharpe objective function, by default 0.0 | None | True | +| alpha | float | Significance level of VaR, CVaR, EDaR, DaR, CDaR, EDaR, Tail Gini of losses, by default 0.05 | None | True | +| target_return | float | Constraint on minimum level of portfolio's return, by default -1.0 | None | True | +| mean | str | The method used to estimate the expected returns, by default 'hist'
Possible values are:

- 'hist': use historical estimates.
- 'ewma1': use ewma with adjust=True. For more information see `EWM `__.
- 'ewma2': use ewma with adjust=False. For more information see `EWM `__. | None | True | +| covariance | str | The method used to estimate the covariance matrix, by default 'hist'
Possible values are:

- 'hist': use historical estimates.
- 'ewma1': use ewma with adjust=True. For more information see `EWM `__.
- 'ewma2': use ewma with adjust=False. For more information see `EWM `__.
- 'ledoit': use the Ledoit and Wolf Shrinkage method.
- 'oas': use the Oracle Approximation Shrinkage method.
- 'shrunk': use the basic Shrunk Covariance method.
- 'gl': use the basic Graphical Lasso Covariance method.
- 'jlogo': use the j-LoGo Covariance method. For more information see: `a-jLogo`.
- 'fixed': denoise using fixed method. For more information see chapter 2 of `a-MLforAM`.
- 'spectral': denoise using spectral method. For more information see chapter 2 of `a-MLforAM`.
- 'shrink': denoise using shrink method. For more information see chapter 2 of `a-MLforAM`. | None | True | +| d_ewma | float | The smoothing factor of ewma methods, by default 0.94 | None | True | +| risk_cont | List[str] | The vector of risk contribution per asset, by default 1/n (number of assets) | None | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| Tuple[pd.DataFrame, Dict] | Tuple with weights and performance dictionary | +--- + +## Examples + +```python +from openbb_terminal.sdk import openbb +openbb.portfolio.po.riskparity(symbols=["AAPL", "MSFT", "AMZN"]) +``` + +``` +( value + AAPL 0.33201 + MSFT 0.34953 + AMZN 0.31846, + {'Return': 0.19946644069106015, + 'Volatility': 0.29074583524705444, + 'Sharpe ratio': 0.6860508956957826}) +``` +```python +from openbb_terminal.sdk import openbb +p = openbb.portfolio.po.load(symbols_file_path="~/openbb_terminal/miscellaneous/portfolio_examples/allocation/60_40_Portfolio.xlsx") +weights, performance = openbb.portfolio.po.riskparity(portfolio_engine=p) +``` + +--- diff --git a/website/content/sdk/reference/portfolio/po/show.md b/website/content/sdk/reference/portfolio/po/show.md new file mode 100644 index 000000000000..8d17eaed97dc --- /dev/null +++ b/website/content/sdk/reference/portfolio/po/show.md @@ -0,0 +1,107 @@ +--- +title: show +description: This documentation page talks about the 'show' function from OpenBB's + portfolio optimization module. It details how to display portfolio optimization + results using categories and portfolio engines. +keywords: +- portfolio optimization +- portfolio engine +- show function +- investment categories +- usage examples +- weights +- performance +- get available categories +- set categories dict +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Show portfolio optimization results + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/portfolio/portfolio_optimization/po_model.py#L2361)] + +```python +openbb.portfolio.po.show(portfolio_engine: portfolio_optimization.po_engine.PoEngine, category: str = None) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| portfolio_engine | PoEngine | Portfolio optimization engine
Use `portfolio.po.load` to load a portfolio engine | None | False | +| category | str | Category to show, by default None
After loading a portfolio with `portfolio.po.load` you can use
the object method `get_available_categories()` to get a list of available categories.
You can also use the object method `set_categories_dict()` to set a custom dictionary
of categories. The dictionary must contain "CURRENT_INVESTED_AMOUNT" and "CURRENT_WEIGHTS"
as keys as shown in the example below. | None | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| Union[pd.DataFrame, Tuple[pd.DataFrame, pd.DataFrame]] | Portfolio weights and categories | +--- + +## Examples + +```python +from openbb_terminal.sdk import openbb +p = openbb.portfolio.po.load(symbols=["AAPL", "MSFT", "AMZN"]) +d = { +``` + +``` +"SECTOR": { + "AAPL": "INFORMATION TECHNOLOGY", + "MSFT": "INFORMATION TECHNOLOGY", + "AMZN": "CONSUMER DISCRETIONARY", + }, + "CURRENT_INVESTED_AMOUNT": { + "AAPL": "100000.0", + "MSFT": "200000.0", + "AMZN": "300000.0", + }, + "CURRENCY": { + "AAPL": "USD", + "MSFT": "USD", + "AMZN": "USD", + }, + } +``` +```python +p.set_categories_dict(categories=d) +weights, performance = openbb.portfolio.po.equal(portfolio_engine=p) +p.get_available_categories() +``` + +``` +['SECTOR'] +``` +```python +weights_df, category_df = openbb.portfolio.po.show(portfolio_engine=p, category="SECTOR") +``` + +```python +from openbb_terminal.sdk import openbb +p = openbb.portfolio.po.load(symbols_file_path="~/openbb_terminal/miscellaneous/portfolio_examples/allocation/60_40_Portfolio.xlsx") +weights, performance = openbb.portfolio.po.equal(portfolio_engine=p) +p.get_available_categories() +``` + +``` +['ASSET_CLASS', + 'SECTOR', + 'INDUSTRY', + 'COUNTRY', + 'CURRENT_INVESTED_AMOUNT', + 'CURRENCY'] +``` +```python +weights_df, category_df = openbb.portfolio.po.show(portfolio_engine=p, category="ASSET_CLASS") +``` + +--- diff --git a/website/content/sdk/reference/portfolio/rbeta.md b/website/content/sdk/reference/portfolio/rbeta.md new file mode 100644 index 000000000000..9b7b6fc94079 --- /dev/null +++ b/website/content/sdk/reference/portfolio/rbeta.md @@ -0,0 +1,100 @@ +--- +title: rbeta +description: 'The page provides a comprehensive guide to using the PortfolioEngine + for analyzing rolling beta. It discusses two key methods: calculating the rolling + beta using ''rbeta'' function and visualizing it using ''rbeta_chart'' function. + The page also provides detailed information about parameters for both methods, and + examples.' +keywords: +- OpenBB portfolio +- PortfolioEngine +- rbeta +- rbeta_chart +- rolling beta +- SEO metadata +- metadata optimization +- code examples +- parameters +- function usage +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + +Get rolling beta using portfolio and benchmark returns + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/portfolio/portfolio_model.py#L659)] + +```python +openbb.portfolio.rbeta(portfolio_engine: portfolio_engine.PortfolioEngine, window: str = "1y") +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| portfolio | PortfolioEngine | PortfolioEngine object | None | True | +| window | string | Interval used for rolling values.
Possible options: mtd, qtd, ytd, 1d, 5d, 10d, 1m, 3m, 6m, 1y, 3y, 5y, 10y. | 1y | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | DataFrame of the portfolio's rolling beta | +--- + +## Examples + +```python +from openbb_terminal.sdk import openbb +p = openbb.portfolio.load("openbb_terminal/miscellaneous/portfolio_examples/holdings/example.csv") +output = openbb.portfolio.rbeta(p) +``` + +--- + + + + +Display rolling beta + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/portfolio/portfolio_view.py#L1050)] + +```python +openbb.portfolio.rbeta_chart(portfolio_engine: portfolio_engine.PortfolioEngine, window: str = "1y", export: str = "", external_axes: Optional[List[matplotlib.axes._axes.Axes]] = None) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| portfolio | PortfolioEngine | PortfolioEngine object | None | True | +| window | str | interval for window to consider
Possible options: mtd, qtd, ytd, 1d, 5d, 10d, 1m, 3m, 6m, 1y, 3y, 5y, 10y. | 1y | True | +| export | str | Export to file | | True | +| external_axes | Optional[List[plt.Axes]] | Optional axes to display plot on | None | True | + + +--- + +## Returns + +This function does not return anything + +--- + + + diff --git a/website/content/sdk/reference/portfolio/rsharpe.md b/website/content/sdk/reference/portfolio/rsharpe.md new file mode 100644 index 000000000000..c0529daf684b --- /dev/null +++ b/website/content/sdk/reference/portfolio/rsharpe.md @@ -0,0 +1,97 @@ +--- +title: rsharpe +description: This page talks about the rsharpe function of the OpenBB Finance. The + page describes two methods to get a rolling sharpe ratio and to display it. It includes + the source code, parameter descriptions, and usage examples. +keywords: +- OpenBB Finance +- portfolio returns +- rsharpe function +- risk-free rate +- rolling sharpe ratio +- chart display +- plotting +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + +Get rolling sharpe ratio + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/portfolio/portfolio_model.py#L564)] + +```python +openbb.portfolio.rsharpe(portfolio_engine: pd.DataFrame, risk_free_rate: float = 0, window: str = "1y") +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| portfolio_returns | pd.Series | Series of portfolio returns | None | True | +| risk_free_rate | float | Risk free rate | 0 | True | +| window | str | Rolling window to use
Possible options: mtd, qtd, ytd, 1d, 5d, 10d, 1m, 3m, 6m, 1y, 3y, 5y, 10y | 1y | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | Rolling sharpe ratio DataFrame | +--- + +## Examples + +```python +from openbb_terminal.sdk import openbb +p = openbb.portfolio.load("openbb_terminal/miscellaneous/portfolio_examples/holdings/example.csv") +output = openbb.portfolio.rsharpe(p) +``` + +--- + + + + +Display rolling sharpe + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/portfolio/portfolio_view.py#L932)] + +```python +openbb.portfolio.rsharpe_chart(portfolio_engine: portfolio_engine.PortfolioEngine, risk_free_rate: float = 0, window: str = "1y", export: str = "", external_axes: Optional[List[matplotlib.axes._axes.Axes]] = None) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| portfolio | PortfolioEngine | PortfolioEngine object | None | True | +| risk_free_rate | float | Value to use for risk free rate in sharpe/other calculations | 0 | True | +| window | str | interval for window to consider | 1y | True | +| export | str | Export to file | | True | +| external_axes | Optional[List[plt.Axes]] | Optional axes to display plot on | None | True | + + +--- + +## Returns + +This function does not return anything + +--- + + + diff --git a/website/content/sdk/reference/portfolio/rsort.md b/website/content/sdk/reference/portfolio/rsort.md new file mode 100644 index 000000000000..8f5518c07ff9 --- /dev/null +++ b/website/content/sdk/reference/portfolio/rsort.md @@ -0,0 +1,98 @@ +--- +title: rsort +description: This documentation page provides details about the rsort functions in + the OpenBB portfolio application. The rsort function calculates the rolling sortino + ratio for a portfolio and rsort_chart function displays this data graphically. +keywords: +- Portfolio Management +- Rolling Sortino Ratio +- Portfolio Analysis +- Financial Data Visualization +- Python Financial Libraries +- Portfolio Optimization +- Risk Analysis +- Portfolio Risk Management +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + +Get rolling sortino + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/portfolio/portfolio_model.py#L610)] + +```python +openbb.portfolio.rsort(portfolio_engine: portfolio_engine.PortfolioEngine, risk_free_rate: float = 0, window: str = "1y") +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| portfolio | PortfolioEngine | PortfolioEngine object | None | True | +| window | str | interval for window to consider
Possible options: mtd, qtd, ytd, 1d, 5d, 10d, 1m, 3m, 6m, 1y, 3y, 5y, 10y | 1y | True | +| risk_free_rate | float | Value to use for risk free rate in sharpe/other calculations | 0 | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | Rolling sortino ratio DataFrame | +--- + +## Examples + +```python +from openbb_terminal.sdk import openbb +p = openbb.portfolio.load("openbb_terminal/miscellaneous/portfolio_examples/holdings/example.csv") +output = openbb.portfolio.rsort(p) +``` + +--- + + + + +Display rolling sortino + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/portfolio/portfolio_view.py#L991)] + +```python +openbb.portfolio.rsort_chart(portfolio_engine: portfolio_engine.PortfolioEngine, risk_free_rate: float = 0, window: str = "1y", export: str = "", external_axes: Optional[List[matplotlib.axes._axes.Axes]] = None) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| portfolio | PortfolioEngine | PortfolioEngine object | None | True | +| risk_free_rate | float | Value to use for risk free rate in sharpe/other calculations | 0 | True | +| window | str | interval for window to consider | 1y | True | +| export | str | Export to file | | True | +| external_axes | Optional[List[plt.Axes]] | Optional axes to display plot on | None | True | + + +--- + +## Returns + +This function does not return anything + +--- + + + diff --git a/website/content/sdk/reference/portfolio/rvol.md b/website/content/sdk/reference/portfolio/rvol.md new file mode 100644 index 000000000000..da44bfa3c1b0 --- /dev/null +++ b/website/content/sdk/reference/portfolio/rvol.md @@ -0,0 +1,98 @@ +--- +title: rvol +description: This page provides documentation for rvol, a feature of the OpenBB Terminal. + It includes details about how to get rolling volatility and display a chart of it, + including the use of the PortfolioEngine class and various window sizes. +keywords: +- rolling volatility +- portfolio engine +- rvol +- charting +- volatility calculation +- portfolio risk analysis +- OpenBB SDK +- OpenBB rvol +- matplotlib +- rvol chart +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + +Get rolling volatility + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/portfolio/portfolio_model.py#L521)] + +```python +openbb.portfolio.rvol(portfolio_engine: portfolio_engine.PortfolioEngine, window: str = "1y") +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| portfolio_engine | PortfolioEngine | PortfolioEngine class instance, this will hold transactions and perform calculations.
Use `portfolio.load` to create a PortfolioEngine. | None | False | +| window | str | Rolling window size to use
Possible options: mtd, qtd, ytd, 1d, 5d, 10d, 1m, 3m, 6m, 1y, 3y, 5y, 10y | 1y | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | Rolling volatility DataFrame | +--- + +## Examples + +```python +from openbb_terminal.sdk import openbb +p = openbb.portfolio.load("openbb_terminal/miscellaneous/portfolio_examples/holdings/example.csv") +output = openbb.portfolio.rvol(p) +``` + +--- + + + + +Display rolling volatility + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/portfolio/portfolio_view.py#L876)] + +```python +openbb.portfolio.rvol_chart(portfolio_engine: portfolio_engine.PortfolioEngine, window: str = "1y", export: str = "", external_axes: Optional[List[matplotlib.axes._axes.Axes]] = None) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| portfolio | PortfolioEngine | PortfolioEngine object | None | True | +| interval | str | interval for window to consider | None | True | +| export | str | Export to file | | True | +| external_axes | Optional[List[plt.Axes]] | Optional axes to display plot on | None | True | + + +--- + +## Returns + +This function does not return anything + +--- + + + diff --git a/website/content/sdk/reference/portfolio/show.md b/website/content/sdk/reference/portfolio/show.md new file mode 100644 index 000000000000..8a7f731b3e71 --- /dev/null +++ b/website/content/sdk/reference/portfolio/show.md @@ -0,0 +1,53 @@ +--- +title: show +description: The OpenBB Terminal's documentation page for the 'show' function, which + provides details on retrieving portfolio transactions using the 'PortfolioEngine' + class instance. It includes parameters, return types and example usage. +keywords: +- Portfolio transactions +- PortfolioEngine class instance +- Portfolio engine +- pandas DataFrame +- openbb.portfolio.show +- portfolio load +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Get portfolio transactions + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/portfolio/portfolio_model.py#L68)] + +```python +openbb.portfolio.show(portfolio_engine: portfolio_engine.PortfolioEngine) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| portfolio_engine | PortfolioEngine | PortfolioEngine class instance, this will hold transactions and perform calculations.
Use `portfolio.load` to create a PortfolioEngine. | None | False | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | Portfolio transactions | +--- + +## Examples + +```python +from openbb_terminal.sdk import openbb +p = openbb.portfolio.load("openbb_terminal/miscellaneous/portfolio_examples/holdings/example.csv") +output = openbb.portfolio.show(p) +``` + +--- diff --git a/website/content/sdk/reference/portfolio/summary.md b/website/content/sdk/reference/portfolio/summary.md new file mode 100644 index 000000000000..28da10bee8b4 --- /dev/null +++ b/website/content/sdk/reference/portfolio/summary.md @@ -0,0 +1,60 @@ +--- +title: summary +description: OpenBB finance page detailing the functionality to gather portfolio and + benchmark return summaries. Documentation includes function parameters, return types + and examples. The core function openbb.portfolio.summary can perform complex calculations + and return a data frame of portfolio and benchmark returns summary. +keywords: +- OpenBB finance +- portfolio summary +- benchmark returns +- portfolio transactions +- portfolio calculations +- cumulative returns +- risk free rate +- data frame +- openbb.portfolio +- portfolio engine +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Get portfolio and benchmark returns summary + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/portfolio/portfolio_model.py#L692)] + +```python +openbb.portfolio.summary(portfolio_engine: portfolio_engine.PortfolioEngine, window: str = "all", risk_free_rate: float = 0) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| portfolio_engine | PortfolioEngine | PortfolioEngine class instance, this will hold transactions and perform calculations.
Use `portfolio.load` to create a PortfolioEngine. | None | False | +| window | str | interval to compare cumulative returns and benchmark | all | True | +| risk_free_rate | float | Risk free rate for calculations | 0 | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | DataFrame with portfolio and benchmark returns summary | +--- + +## Examples + +```python +from openbb_terminal.sdk import openbb +p = openbb.portfolio.load("openbb_terminal/miscellaneous/portfolio_examples/holdings/example.csv") +output = openbb.portfolio.summary(p) +``` + +--- diff --git a/website/content/sdk/reference/portfolio/var.md b/website/content/sdk/reference/portfolio/var.md new file mode 100644 index 000000000000..d74917cddb0c --- /dev/null +++ b/website/content/sdk/reference/portfolio/var.md @@ -0,0 +1,57 @@ +--- +title: var +description: This documentation page describes the portfolio variance function in + OpenBB finance. It provides information on parameters, return values and usage examples + of the function. +keywords: +- OpenBB finance +- Portfolio variance +- Python finance library +- Python code examples +- Financial data analysis +- Financial risk assessment +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Get portfolio VaR + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/portfolio/portfolio_model.py#L1751)] + +```python +openbb.portfolio.var(portfolio_engine: portfolio_engine.PortfolioEngine, use_mean: bool = False, adjusted_var: bool = False, student_t: bool = False, percentile: float = 99.9) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| portfolio_engine | PortfolioEngine | PortfolioEngine class instance, this will hold transactions and perform calculations.
Use `portfolio.load` to create a PortfolioEngine. | None | False | +| use_mean | bool | if one should use the data mean return | False | True | +| adjusted_var | bool | if one should have VaR adjusted for skew and kurtosis (Cornish-Fisher-Expansion) | False | True | +| student_t | bool | If one should use the student-t distribution | False | True | +| percentile | float | var percentile (%) | 99.9 | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | DataFrame with portfolio VaR | +--- + +## Examples + +```python +from openbb_terminal.sdk import openbb +p = openbb.portfolio.load("openbb_terminal/miscellaneous/portfolio_examples/holdings/example.csv") +output = openbb.portfolio.var(p) +``` + +--- diff --git a/website/content/sdk/reference/portfolio/yret.md b/website/content/sdk/reference/portfolio/yret.md new file mode 100644 index 000000000000..0340febea571 --- /dev/null +++ b/website/content/sdk/reference/portfolio/yret.md @@ -0,0 +1,98 @@ +--- +title: yret +description: Website page provides in-depth guide on using yret, a module that delivers + yearly returns in quantitative finance. It includes complete procedures from loading + portfolio to displaying returns in graph. +keywords: +- Yearly Returns +- Portfolio Management +- Quantitative Finance +- Data Visualization +- Open source +- Finance Library +- Benchmarking +- Portfolio Load +- yret Chart +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + +Get yearly returns + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/portfolio/portfolio_model.py#L203)] + +```python +openbb.portfolio.yret(portfolio_engine: portfolio_engine.PortfolioEngine, window: str = "all") +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| portfolio_engine | PortfolioEngine | PortfolioEngine class instance, this will hold transactions and perform calculations.
Use `portfolio.load` to create a PortfolioEngine. | None | False | +| window | str | interval to compare cumulative returns and benchmark | all | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | DataFrame with yearly returns | +--- + +## Examples + +```python +from openbb_terminal.sdk import openbb +p = openbb.portfolio.load("openbb_terminal/miscellaneous/portfolio_examples/holdings/example.csv") +output = openbb.portfolio.yret(p) +``` + +--- + + + + +Display yearly returns + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/portfolio/portfolio_view.py#L376)] + +```python +openbb.portfolio.yret_chart(portfolio_engine: portfolio_engine.PortfolioEngine, window: str = "all", raw: bool = False, export: str = "", external_axes: Optional[matplotlib.axes._axes.Axes] = None) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| portfolio_engine | PortfolioEngine | PortfolioEngine class instance, this will hold transactions and perform calculations.
Use `portfolio.load` to create a PortfolioEngine. | None | False | +| window | str | interval to compare cumulative returns and benchmark | all | True | +| raw | False | Display raw data from cumulative return | False | True | +| export | str | Export certain type of data | | True | +| external_axes | plt.Axes | Optional axes to display plot on | None | True | + + +--- + +## Returns + +This function does not return anything + +--- + + + diff --git a/website/content/sdk/reference/qa/acf.md b/website/content/sdk/reference/qa/acf.md new file mode 100644 index 000000000000..31c38190f2f0 --- /dev/null +++ b/website/content/sdk/reference/qa/acf.md @@ -0,0 +1,62 @@ +--- +title: acf +description: This page provides a detailed description and source code of acf - an + OpenBB function used to plot Auto and Partial Auto Correlation of returns and change + in returns. One can understand how to use the function, its parameters, and view + examples of its use. +keywords: +- auto correlation +- quantitive analysis +- quantitative_analysis.qa_view.py +- plots +- openbb.qa.acf +- codes +- parameters +- returns +- examples +- stocks.load +- GitHub source code +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Plots Auto and Partial Auto Correlation of returns and change in returns + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/common/quantitative_analysis/qa_view.py#L372)] + +```python +openbb.qa.acf(data: pd.DataFrame, target: str, symbol: str = "", lags: int = 15, external_axes: Optional[List[matplotlib.axes._axes.Axes]] = None) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| data | pd.DataFrame | Dataframe to look at | None | False | +| target | str | Data column to look at | None | False | +| symbol | str | Name of dataset | | True | +| lags | int | Max number of lags to look at | 15 | True | +| external_axes | Optional[List[plt.Axes]] | External axes (4 axes are expected in the list), by default None | None | True | + + +--- + +## Returns + +This function does not return anything + +--- + +## Examples + +```python +from openbb_terminal.sdk import openbb +df = openbb.stocks.load("AAPL") +openbb.qa.acf(data=df, target="Adj Close") +``` + +--- diff --git a/website/content/sdk/reference/qa/bw.md b/website/content/sdk/reference/qa/bw.md new file mode 100644 index 000000000000..2259aa7eee0a --- /dev/null +++ b/website/content/sdk/reference/qa/bw.md @@ -0,0 +1,57 @@ +--- +title: bw +description: The documentation page depicts the usage and configuration options for + the 'bw' function in OpenBB Terminal. The function plots box and whisker graphs + for quantitative data analysis based on provided DataFrame and target. An example + using stock data for 'AAPL' is provided for a clearer understanding. +keywords: +- Box and Whisker Plots +- Quantitative Analysis +- Yearly Accumulation +- External Axes +- AAPL +- Adjusted Close +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Plots box and whisker plots + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/common/quantitative_analysis/qa_view.py#L270)] + +```python +openbb.qa.bw(data: pd.DataFrame, target: str, symbol: str = "", yearly: bool = True, external_axes: Optional[List[matplotlib.axes._axes.Axes]] = None) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| symbol | str | Name of dataset | | True | +| data | pd.DataFrame | Dataframe to look at | None | False | +| target | str | Data column to look at | None | False | +| yearly | bool | Flag to indicate yearly accumulation | True | True | +| external_axes | Optional[List[plt.Axes]] | External axes (1 axis is expected in the list), by default None | None | True | + + +--- + +## Returns + +This function does not return anything + +--- + +## Examples + +```python +from openbb_terminal.sdk import openbb +df = openbb.stocks.load("AAPL") +openbb.qa.bw(data=df, target="Adj Close") +``` + +--- diff --git a/website/content/sdk/reference/qa/calculate_adjusted_var.md b/website/content/sdk/reference/qa/calculate_adjusted_var.md new file mode 100644 index 000000000000..e4cd03224a2e --- /dev/null +++ b/website/content/sdk/reference/qa/calculate_adjusted_var.md @@ -0,0 +1,52 @@ +--- +title: calculate_adjusted_var +description: This docusaurus page explains the calculation of adjusted VaR, which + takes into account skew and kurtosis. It includes the explanation of the source + code, parameters used, and what the function returns. +keywords: +- Docusaurus page +- adjusted VaR calculation +- Cornish-Fischer-Expansion +- quantitative analysis +- Python code +- source code explanation +- kurtosis +- skew +- standard deviation +- mean +- normal distribution +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Calculates VaR, which is adjusted for skew and kurtosis (Cornish-Fischer-Expansion) + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/common/quantitative_analysis/qa_model.py#L182)] + +```python +openbb.qa.calculate_adjusted_var(kurtosis: float, skew: float, ndp: float, std: float, mean: float) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| kurtosis | float | kurtosis of data | None | False | +| skew | float | skew of data | None | False | +| ndp | float | normal distribution percentage number (99% -> -2.326) | None | False | +| std | float | standard deviation of data | None | False | +| mean | float | mean of data | None | False | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| float | Real adjusted VaR | +--- diff --git a/website/content/sdk/reference/qa/cdf.md b/website/content/sdk/reference/qa/cdf.md new file mode 100644 index 000000000000..2c60cf8f5836 --- /dev/null +++ b/website/content/sdk/reference/qa/cdf.md @@ -0,0 +1,54 @@ +--- +title: cdf +description: The page provides details about the 'cdf' function in the OpenBB SDK, + which plots the Cumulative Distribution Function. It lists the function parameters, + return values, and provides a working example. +keywords: +- Cumulative Distribution Function +- Quantitative Analysis +- OpenBB SDK +- clf function +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Plots Cumulative Distribution Function + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/common/quantitative_analysis/qa_view.py#L159)] + +```python +openbb.qa.cdf(data: pd.DataFrame, target: str, symbol: str = "", export: str = "", external_axes: Optional[List[matplotlib.axes._axes.Axes]] = None) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| data | pd.DataFrame | Dataframe to look at | None | False | +| target | str | Data column | None | False | +| symbol | str | Name of dataset | | True | +| export | str | Format to export data | | True | +| external_axes | Optional[List[plt.Axes]] | External axes (1 axis is expected in the list), by default None | None | True | + + +--- + +## Returns + +This function does not return anything + +--- + +## Examples + +```python +from openbb_terminal.sdk import openbb +df = openbb.stocks.load("AAPL") +openbb.qa.cdf(data=df, target="Adj Close") +``` + +--- diff --git a/website/content/sdk/reference/qa/cusum.md b/website/content/sdk/reference/qa/cusum.md new file mode 100644 index 000000000000..11301e73661c --- /dev/null +++ b/website/content/sdk/reference/qa/cusum.md @@ -0,0 +1,56 @@ +--- +title: cusum +description: Documentation page for the Cumulative Sum Algorithm (CUSUM) used in the + OpenBB Terminal for quantitative analysis. Contains a snippet of the source code, + parameters descriptions, and an example of usage. +keywords: +- OpenBB Terminal documentation +- Cumulative Sum Algorithm +- CUSUM +- quantitative analysis +- parameters description +- OpenBB SDK +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Plots Cumulative sum algorithm (CUSUM) to detect abrupt changes in data + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/common/quantitative_analysis/qa_view.py#L523)] + +```python +openbb.qa.cusum(data: pd.DataFrame, target: str, threshold: float = 5, drift: float = 2.1, external_axes: Optional[List[matplotlib.axes._axes.Axes]] = None) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| data | pd.DataFrame | Dataframe | None | False | +| target | str | Column of data to look at | None | False | +| threshold | float | Threshold value | 5 | True | +| drift | float | Drift parameter | 2.1 | True | +| external_axes | Optional[List[plt.Axes]] | External axes (2 axes are expected in the list), by default None | None | True | + + +--- + +## Returns + +This function does not return anything + +--- + +## Examples + +```python +from openbb_terminal.sdk import openbb +df = openbb.stocks.load("AAPL") +openbb.qa.cusum(data=df, target="Adj Close") +``` + +--- diff --git a/website/content/sdk/reference/qa/decompose.md b/website/content/sdk/reference/qa/decompose.md new file mode 100644 index 000000000000..c09ba64289ee --- /dev/null +++ b/website/content/sdk/reference/qa/decompose.md @@ -0,0 +1,53 @@ +--- +title: decompose +description: This documentation page provides details on the 'decompose' function + in OpenBB's quantitative analysis module. The function executes seasonal decomposition + on a specified DataFrame, returning decomposed results and filtered dataframes for + cycle and trend. +keywords: +- decompose +- seasonal decomposition +- quantitative analysis +- multiplicative +- dataframe +- DecomposeResult +- statsmodels +- observed +- seasonal +- trend +- residual +- weights +- cycle DataFrame +- trend DataFrame +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Perform seasonal decomposition + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/common/quantitative_analysis/qa_model.py#L46)] + +```python +openbb.qa.decompose(data: pd.DataFrame, multiplicative: bool = False) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| data | pd.DataFrame | Dataframe of targeted data | None | False | +| multiplicative | bool | Boolean to indicate multiplication instead of addition | False | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| Tuple[DecomposeResult, pd.DataFrame, pd.DataFrame] | DecomposeResult class from statsmodels (observed, seasonal, trend, residual, and weights),
Filtered cycle DataFrame,
Filtered trend DataFrame | +--- diff --git a/website/content/sdk/reference/qa/es.md b/website/content/sdk/reference/qa/es.md new file mode 100644 index 000000000000..0dddc0697bf9 --- /dev/null +++ b/website/content/sdk/reference/qa/es.md @@ -0,0 +1,92 @@ +--- +title: es +description: This is a comprehensive guide on how to use OpenBB's quantitative analysis + for Expected Shortfall (ES). The document explains how to get the Expected Shortfall + for a specific stock dataframe and how to print a table showing expected shortfall + using the ES chart. Both the Model and Chart have been clearly explained in the + context of their parameters and return types. +keywords: +- Quantitative Analysis +- Expected Shortfall +- Percentile +- ES Chart +- Portfolio +- use_mean +- Distribution +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + +Gets Expected Shortfall for specified stock dataframe. + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/common/quantitative_analysis/qa_model.py#L355)] + +```python +openbb.qa.es(data: pd.DataFrame, use_mean: bool = False, distribution: str = "normal", percentile: Union[float, int] = 99.9, portfolio: bool = False) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| data | pd.DataFrame | Data dataframe | None | False | +| use_mean | bool | If one should use the data mean for calculation | False | True | +| distribution | str | Type of distribution, options: laplace, student_t, normal | normal | True | +| percentile | Union[float,int] | VaR percentile | 99.9 | True | +| portfolio | bool | If the data is a portfolio | False | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | DataFrame with Expected Shortfall per percentile | +--- + + + + +Prints table showing expected shortfall. + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/common/quantitative_analysis/qa_view.py#L1108)] + +```python +openbb.qa.es_chart(data: pd.DataFrame, symbol: str = "", use_mean: bool = False, distribution: str = "normal", percentile: float = 99.9, portfolio: bool = False) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| data | pd.DataFrame | Data dataframe | None | False | +| use_mean | | if one should use the data mean return | False | True | +| symbol | str | name of the data | | True | +| distribution | str | choose distribution to use: logistic, laplace, normal | normal | True | +| percentile | int | es percentile | 99.9 | True | +| portfolio | bool | If the data is a portfolio | False | True | + + +--- + +## Returns + +This function does not return anything + +--- + + + diff --git a/website/content/sdk/reference/qa/hist.md b/website/content/sdk/reference/qa/hist.md new file mode 100644 index 000000000000..c51fcf0619ae --- /dev/null +++ b/website/content/sdk/reference/qa/hist.md @@ -0,0 +1,56 @@ +--- +title: hist +description: This page provides a detailed guide on the usage of the 'openbb.qa.hist' + function from OpenBB. This function is utilized for plotting histograms of data, + particularly from a Pandas DataFrame. It also includes parameters, returns, and + examples for a better understanding. +keywords: +- Histogram +- Quantitative Analysis +- Data Visualization +- Pandas DataFrame +- openbb.qa.hist function +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Plots histogram of data + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/common/quantitative_analysis/qa_view.py#L82)] + +```python +openbb.qa.hist(data: pd.DataFrame, target: str, symbol: str = "", bins: int = 15, external_axes: Optional[List[matplotlib.axes._axes.Axes]] = None) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| data | pd.DataFrame | Dataframe to look at | None | False | +| target | str | Data column to get histogram of the dataframe | None | False | +| symbol | str | Name of dataset | | True | +| bins | int | Number of bins in histogram | 15 | True | +| external_axes | Optional[List[plt.Axes]] | External axes (1 axis is expected in the list), by default None | None | True | + + +--- + +## Returns + +This function does not return anything + +--- + +## Examples + +```python +from openbb_terminal.sdk import openbb +df = openbb.stocks.load("AAPL") +openbb.qa.hist(data=df, target="Adj Close") +``` + +--- diff --git a/website/content/sdk/reference/qa/kurtosis.md b/website/content/sdk/reference/qa/kurtosis.md new file mode 100644 index 000000000000..c76dc9de62a3 --- /dev/null +++ b/website/content/sdk/reference/qa/kurtosis.md @@ -0,0 +1,85 @@ +--- +title: kurtosis +description: This documentation page provides detailed information about Kurtosis + Indicator and how to plot rolling kurtosis with OpenBB-finance's tool. It includes + source code links and parameters needed for these python functions. +keywords: +- OpenBB-finance +- Kurtosis Indicator +- Plotting Kurtosis +- Quantitative Analysis +- Python Functions +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + +Kurtosis Indicator + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/common/quantitative_analysis/rolling_model.py#L123)] + +```python +openbb.qa.kurtosis(data: pd.DataFrame, window: int = 14) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| data | pd.DataFrame | Dataframe of targeted data | None | False | +| window | int | Length of window | 14 | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | Dataframe of rolling kurtosis | +--- + + + + +Plots rolling kurtosis + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/common/quantitative_analysis/rolling_view.py#L424)] + +```python +openbb.qa.kurtosis_chart(symbol: str, data: pd.DataFrame, target: str, window: int = 14, export: str = "", external_axes: Optional[List[matplotlib.axes._axes.Axes]] = None) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| symbol | str | Ticker | None | False | +| data | pd.DataFrame | Dataframe of stock prices | None | False | +| target | str | Column in data to look at | None | False | +| window | int | Length of window | 14 | True | +| export | str | Format to export data | | True | +| external_axes | Optional[List[plt.Axes]] | External axes (2 axes are expected in the list), by default None | None | True | + + +--- + +## Returns + +This function does not return anything + +--- + + + diff --git a/website/content/sdk/reference/qa/line.md b/website/content/sdk/reference/qa/line.md new file mode 100644 index 000000000000..23054fe3dd87 --- /dev/null +++ b/website/content/sdk/reference/qa/line.md @@ -0,0 +1,59 @@ +--- +title: line +description: The page describes the 'line' function of the OpenBB library, used for + displaying line plots of data. It provides the source code link and details the + parameters, usage, and examples of the function within the domain of quantitative + analysis and data visualization using Python. +keywords: +- line plot +- quantitative analysis +- data visualization +- pd.Series +- matplotlib +- datetime +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Display line plot of data + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/common/quantitative_analysis/qa_view.py#L938)] + +```python +openbb.qa.line(data: pd.Series, title: str = "", log_y: bool = True, markers_lines: Optional[List[datetime.datetime]] = None, markers_scatter: Optional[List[datetime.datetime]] = None, export: str = "", external_axes: Optional[List[matplotlib.axes._axes.Axes]] = None) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| data | pd.Series | Data to plot | None | False | +| title | str | Title for plot | | True | +| log_y | bool | Flag for showing y on log scale | True | True | +| markers_lines | Optional[List[datetime]] | List of dates to highlight using vertical lines | None | True | +| markers_scatter | Optional[List[datetime]] | List of dates to highlight using scatter | None | True | +| export | str | Format to export data | | True | +| external_axes | Optional[List[plt.Axes]] | External axes (1 axis is expected in the list), by default None | None | True | + + +--- + +## Returns + +This function does not return anything + +--- + +## Examples + +```python +from openbb_terminal.sdk import openbb +df = openbb.stocks.load("AAPL") +openbb.qa.line(data=df["Adj Close"]) +``` + +--- diff --git a/website/content/sdk/reference/qa/normality.md b/website/content/sdk/reference/qa/normality.md new file mode 100644 index 000000000000..5dad16318ed6 --- /dev/null +++ b/website/content/sdk/reference/qa/normality.md @@ -0,0 +1,85 @@ +--- +title: normality +description: This page provides detailed information on OpenBB's qa.normality and + qa.normality_chart functions used for quantitative analysis. These functions are + used to generate statistics on the relation to the normal curve, targeting specific + data in a dataframe. +keywords: +- openbb.qa.normality +- quantitative analysis +- distribution returns +- normal curve +- openbb.qa.normality_chart +- dataframe +- statistics normality +- targeted data +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + +Look at the distribution of returns and generate statistics on the relation to the normal curve. + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/common/quantitative_analysis/qa_model.py#L81)] + +```python +openbb.qa.normality(data: pd.DataFrame) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| data | pd.DataFrame | Dataframe of targeted data | None | False | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | Dataframe containing statistics of normality | +--- + + + + +Prints table showing normality statistics + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/common/quantitative_analysis/qa_view.py#L805)] + +```python +openbb.qa.normality_chart(data: pd.DataFrame, target: str, export: str = "") +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| data | pd.DataFrame | DataFrame | None | False | +| target | str | Column in data to look at | None | False | +| export | str | Format to export data | | True | + + +--- + +## Returns + +This function does not return anything + +--- + + + diff --git a/website/versioned_docs/version-v3/sdk/reference/qa/omega.md b/website/content/sdk/reference/qa/omega.md similarity index 76% rename from website/versioned_docs/version-v3/sdk/reference/qa/omega.md rename to website/content/sdk/reference/qa/omega.md index 37004d0aa9d0..0de699e64062 100644 --- a/website/versioned_docs/version-v3/sdk/reference/qa/omega.md +++ b/website/content/sdk/reference/qa/omega.md @@ -1,13 +1,29 @@ --- title: omega -description: OpenBB SDK Function +description: Learn about the omega series and ratio in the OpenBB quantitative analysis + toolkit. The documentation provides information on how to generate the omega series + and plot the omega ratio from stock dataframes. +keywords: +- omega series +- quantitative analysis +- numpy +- pandas +- dataframe +- stock data +- threshold range +- annualized target return +- omega ratio +- plotting +- chart --- +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; -# omega - @@ -39,8 +55,6 @@ openbb.qa.omega(data: pd.DataFrame, threshold_start: float = 0, threshold_end: f | pd.DataFrame | omega series | --- - - @@ -71,7 +85,5 @@ This function does not return anything --- - - - \ No newline at end of file + diff --git a/website/content/sdk/reference/qa/qqplot.md b/website/content/sdk/reference/qa/qqplot.md new file mode 100644 index 000000000000..b4a84460573d --- /dev/null +++ b/website/content/sdk/reference/qa/qqplot.md @@ -0,0 +1,57 @@ +--- +title: qqplot +description: The 'qqplot' page provides information on how to use the 'qqplot' function + in the OpenBB library for quantitative data analysis. It explains the procedure, + the parameters required, and provides a practical example using the stock ticker + from Apple. +keywords: +- qqplot +- quantitative analysis +- data analysis +- matplotlib +- Pandas Dataframe +- stock ticker +- AAPL +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Plots QQ plot for data against normal quantiles + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/common/quantitative_analysis/qa_view.py#L462)] + +```python +openbb.qa.qqplot(data: pd.DataFrame, target: str, symbol: str = "", external_axes: Optional[List[matplotlib.axes._axes.Axes]] = None) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| data | pd.DataFrame | Dataframe | None | False | +| target | str | Column in data to look at | None | False | +| symbol | str | Stock ticker | | True | +| external_axes | Optional[List[plt.Axes]] | External axes (1 axis is expected in the list), by default None | None | True | + + +--- + +## Returns + +This function does not return anything + +--- + +## Examples + +```python +from openbb_terminal.sdk import openbb +df = openbb.stocks.load("AAPL") +openbb.qa.qqplot(data=df, target="Adj Close") +``` + +--- diff --git a/website/content/sdk/reference/qa/quantile.md b/website/content/sdk/reference/qa/quantile.md new file mode 100644 index 000000000000..8d3da3ab12c1 --- /dev/null +++ b/website/content/sdk/reference/qa/quantile.md @@ -0,0 +1,89 @@ +--- +title: quantile +description: This page provides documentation and source code for OpenBB's Quantile + function. It includes info about parameters, return types, and how to generate and + plot rolling quantile data using Python. +keywords: +- Docusaurus +- Quantile +- Source Code +- Quantitative Analysis +- Plotting Data +- Rolling Quantile +- Python DataFrame +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + +Overlay Median & Quantile + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/common/quantitative_analysis/rolling_model.py#L72)] + +```python +openbb.qa.quantile(data: pd.DataFrame, window: int = 14, quantile_pct: float = 0.5) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| data | pd.DataFrame | Dataframe of targeted data | None | False | +| window | int | Length of window | 14 | True | +| quantile_pct | float | Quantile to display | 0.5 | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| Tuple[pd.DataFrame, pd.DataFrame] | Dataframe of rolling median prices over window,
Dataframe of rolling quantile prices over window | +--- + + + + +Plots rolling quantile + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/common/quantitative_analysis/rolling_view.py#L245)] + +```python +openbb.qa.quantile_chart(data: pd.DataFrame, target: str, symbol: str = "", window: int = 14, quantile: float = 0.5, export: str = "", external_axes: Optional[List[matplotlib.axes._axes.Axes]] = None) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| data | pd.DataFrame | Dataframe | None | False | +| target | str | Column in data to look at | None | False | +| symbol | str | Stock ticker | | True | +| window | int | Length of window | 14 | True | +| quantile | float | Quantile to get | 0.5 | True | +| export | str | Format to export data | | True | +| external_axes | Optional[List[plt.Axes]] | External axes (1 axis is expected in the list), by default None | None | True | + + +--- + +## Returns + +This function does not return anything + +--- + + + diff --git a/website/content/sdk/reference/qa/rolling.md b/website/content/sdk/reference/qa/rolling.md new file mode 100644 index 000000000000..5d408603762b --- /dev/null +++ b/website/content/sdk/reference/qa/rolling.md @@ -0,0 +1,88 @@ +--- +title: rolling +description: A documentation page explaining the functionality of the OpenBB rolling + model and rolling chart. These tools deal with computing and plotting rolling means + and standard deviations in financial data, mapped by stock symbols or tickers. The + methods are implemented in Python and operate on dataframes. +keywords: +- rolling +- quantitative analysis +- dataframe +- standard deviation +- mean +- Stock ticker +- window +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + +Return rolling mean and standard deviation + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/common/quantitative_analysis/rolling_model.py#L16)] + +```python +openbb.qa.rolling(data: pd.DataFrame, window: int = 14) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| data | pd.DataFrame | Dataframe of target data | None | False | +| window | int | Length of rolling window | 14 | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| Tuple[pd.DataFrame, pd.DataFrame] | Dataframe of rolling mean,
Dataframe of rolling standard deviation | +--- + + + + +Plots mean std deviation + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/common/quantitative_analysis/rolling_view.py#L26)] + +```python +openbb.qa.rolling_chart(data: pd.DataFrame, target: str, symbol: str = "", window: int = 14, export: str = "", external_axes: Optional[List[matplotlib.axes._axes.Axes]] = None) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| data | pd.DataFrame | Dataframe | None | False | +| target | str | Column in data to look at | None | False | +| symbol | str | Stock ticker | | True | +| window | int | Length of window | 14 | True | +| export | str | Format to export data | | True | +| external_axes | Optional[List[plt.Axes]] | External axes (2 axes are expected in the list), by default None | None | True | + + +--- + +## Returns + +This function does not return anything + +--- + + + diff --git a/website/content/sdk/reference/qa/sharpe.md b/website/content/sdk/reference/qa/sharpe.md new file mode 100644 index 000000000000..2f32c23f4c5e --- /dev/null +++ b/website/content/sdk/reference/qa/sharpe.md @@ -0,0 +1,86 @@ +--- +title: sharpe +description: Documentation page on the Sharpe Ratio - a financial measure calculated + in the OpenBB framework. Includes parameters, source code, and instructions for + plotting the Sharpe ratio in a chart. Relevant for quantitative finance, data analysis, + and Python programming. +keywords: +- Sharpe Ratio +- Quantitative Analysis +- Risk-Free Rate +- Data Visualization +- Finance +- Financial Models +- Programming +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + +Calculates the sharpe ratio + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/common/quantitative_analysis/qa_model.py#L537)] + +```python +openbb.qa.sharpe(data: pd.DataFrame, rfr: float = 0, window: float = 252) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| data | pd.DataFrame | selected dataframe column | None | False | +| rfr | float | risk free rate | 0 | True | +| window | float | length of the rolling window | 252 | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | sharpe ratio | +--- + + + + +Plots Calculated the sharpe ratio + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/common/quantitative_analysis/qa_view.py#L1156)] + +```python +openbb.qa.sharpe_chart(data: pd.DataFrame, rfr: float = 0, window: float = 252) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| data | pd.DataFrame | selected dataframe column | None | False | +| rfr | float | risk free rate | 0 | True | +| window | float | length of the rolling window | 252 | True | + + +--- + +## Returns + +This function does not return anything + +--- + + + diff --git a/website/content/sdk/reference/qa/skew.md b/website/content/sdk/reference/qa/skew.md new file mode 100644 index 000000000000..233ee8f59163 --- /dev/null +++ b/website/content/sdk/reference/qa/skew.md @@ -0,0 +1,92 @@ +--- +title: skew +description: This documentation page provides details on the function openbb.qa.skew, + used for rolling skewness indicator calculations and plotting. It includes parameters + description and links to the source code. +keywords: +- Quantitative Analysis +- Skewness Indicator +- Python Coding +- Source Code +- Financial Data Analysis +- Rolling Skew +- Skew Chart +- Parameters +- Window Length +- Stock Ticker +- Data Export +- External Axes +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + +Skewness Indicator + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/common/quantitative_analysis/rolling_model.py#L103)] + +```python +openbb.qa.skew(data: pd.DataFrame, window: int = 14) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| data | pd.DataFrame | Dataframe of targeted data | None | False | +| window | int | Length of window | 14 | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | Dataframe of rolling skew | +--- + + + + +Plots rolling skew + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/common/quantitative_analysis/rolling_view.py#L341)] + +```python +openbb.qa.skew_chart(symbol: str, data: pd.DataFrame, target: str, window: int = 14, export: str = "", external_axes: Optional[List[matplotlib.axes._axes.Axes]] = None) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| symbol | str | Stock ticker | None | False | +| data | pd.DataFrame | Dataframe | None | False | +| target | str | Column in data to look at | None | False | +| window | int | Length of window | 14 | True | +| export | str | Format to export data | | True | +| external_axes | Optional[List[plt.Axes]] | External axes (2 axes are expected in the list), by default None | None | True | + + +--- + +## Returns + +This function does not return anything + +--- + + + diff --git a/website/content/sdk/reference/qa/sortino.md b/website/content/sdk/reference/qa/sortino.md new file mode 100644 index 000000000000..7a026c190f67 --- /dev/null +++ b/website/content/sdk/reference/qa/sortino.md @@ -0,0 +1,87 @@ +--- +title: sortino +description: Documentation on the use of the Sortino Ratio function within the OpenBB + Quantitative Analysis Code. It includes the Python source code along with details + of parameters for calculating and plotting the Sortino ratio. +keywords: +- Sortino Ratio +- Source Code +- Quantitative Analysis +- Charts +- Python Dataframes +- Financial Metrics +- Risk-Adjusted Performance +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + +Calculates the sortino ratio + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/common/quantitative_analysis/qa_model.py#L562)] + +```python +openbb.qa.sortino(data: pd.DataFrame, target_return: float = 0, window: float = 252, adjusted: bool = False) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| data | pd.DataFrame | selected dataframe | None | False | +| target_return | float | target return of the asset | 0 | True | +| window | float | length of the rolling window | 252 | True | +| adjusted | bool | adjust the sortino ratio | False | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | sortino ratio | +--- + + + + +Plots the sortino ratio + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/common/quantitative_analysis/qa_view.py#L1181)] + +```python +openbb.qa.sortino_chart(data: pd.DataFrame, target_return: float, window: float, adjusted: bool) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| data | pd.DataFrame | selected dataframe | None | False | +| target_return | float | target return of the asset | None | False | +| window | float | length of the rolling window | None | False | +| adjusted | bool | adjust the sortino ratio | None | False | + + +--- + +## Returns + +This function does not return anything + +--- + + + diff --git a/website/content/sdk/reference/qa/spread.md b/website/content/sdk/reference/qa/spread.md new file mode 100644 index 000000000000..c20e0ced7277 --- /dev/null +++ b/website/content/sdk/reference/qa/spread.md @@ -0,0 +1,88 @@ +--- +title: spread +description: 'The page provides information about two central functions of the OpenBBTerminal: + ''spread'' and ''spread_chart''. These Python functions are part of the quantitative + analysis, analyzing standard deviation, variance and create spread charts. The descriptions + include source code, parameters, and return values.' +keywords: +- Standard Deviation +- Variance +- Quantitative Analysis +- Rolling model +- Spread +- Spread chart +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + +Standard Deviation and Variance + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/common/quantitative_analysis/rolling_model.py#L41)] + +```python +openbb.qa.spread(data: pd.DataFrame, window: int = 14) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| data | pd.DataFrame | DataFrame of targeted data | None | False | +| window | int | Length of window | 14 | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| Tuple[pd.DataFrame, pd.DataFrame] | Dataframe of rolling standard deviation,
Dataframe of rolling variance | +--- + + + + +Plots rolling spread + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/common/quantitative_analysis/rolling_view.py#L135)] + +```python +openbb.qa.spread_chart(data: pd.DataFrame, target: str, symbol: str = "", window: int = 14, export: str = "", external_axes: Optional[List[matplotlib.axes._axes.Axes]] = None) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| data | pd.DataFrame | Dataframe | None | False | +| target | str | Column in data to look at | None | False | +| target | str | Column in data to look at | None | False | +| symbol | str | Stock ticker | | True | +| window | int | Length of window | 14 | True | +| export | str | Format to export data | | True | +| external_axes | Optional[List[plt.Axes]] | External axes (3 axes are expected in the list), by default None | None | True | + + +--- + +## Returns + +This function does not return anything + +--- + + + diff --git a/website/content/sdk/reference/qa/summary.md b/website/content/sdk/reference/qa/summary.md new file mode 100644 index 000000000000..d157cf726e30 --- /dev/null +++ b/website/content/sdk/reference/qa/summary.md @@ -0,0 +1,82 @@ +--- +title: summary +description: This page contains documentation for methods of calculating and displaying + summary statistics in the OpenBB Terminal. Tab sections divide the page into different + functionalities, including a model overview and a chart view of summary statistics. + Details for parameters, return values, and links to the original source code are + provided for each method. +keywords: +- summary statistics +- quantitative analysis +- OpenBB.qa +- summary_chart +- export data +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + +Print summary statistics + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/common/quantitative_analysis/qa_model.py#L25)] + +```python +openbb.qa.summary(data: pd.DataFrame) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| data | pd.DataFrame | Dataframe to get summary statistics for | None | False | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | Summary statistics | +--- + + + + +Prints table showing summary statistics + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/common/quantitative_analysis/qa_view.py#L53)] + +```python +openbb.qa.summary_chart(data: pd.DataFrame, export: str = "") +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| data | pd.DataFrame | DataFrame to get statistics of | None | False | +| export | str | Format to export data | | True | + + +--- + +## Returns + +This function does not return anything + +--- + + + diff --git a/website/content/sdk/reference/qa/unitroot.md b/website/content/sdk/reference/qa/unitroot.md new file mode 100644 index 000000000000..57446dd21590 --- /dev/null +++ b/website/content/sdk/reference/qa/unitroot.md @@ -0,0 +1,85 @@ +--- +title: unitroot +description: This documentation provides in-depth information on how to calculate + unit root test statistics, using the OpenBB software. This includes source code, + parameter details, and return values for both model and chart functions. +keywords: +- quantitative analysis +- unit root test +- ADF test +- KPSS test +- regression +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + +Calculate test statistics for unit roots + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/common/quantitative_analysis/qa_model.py#L135)] + +```python +openbb.qa.unitroot(data: pd.DataFrame, fuller_reg: str = "c", kpss_reg: str = "c") +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| data | pd.DataFrame | DataFrame of target variable | None | False | +| fuller_reg | str | Type of regression of ADF test. Can be ‘c’,’ct’,’ctt’,’nc’ 'c' - Constant and t - trend order | c | True | +| kpss_reg | str | Type of regression for KPSS test. Can be ‘c’,’ct' | c | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | Dataframe with results of ADF test and KPSS test | +--- + + + + +Prints table showing unit root test calculations + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/common/quantitative_analysis/qa_view.py#L839)] + +```python +openbb.qa.unitroot_chart(data: pd.DataFrame, target: str, fuller_reg: str = "c", kpss_reg: str = "c", export: str = "") +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| data | pd.DataFrame | DataFrame | None | False | +| target | str | Column of data to look at | None | False | +| fuller_reg | str | Type of regression of ADF test. Can be ‘c’,’ct’,’ctt’,’nc’ 'c' - Constant and t - trend order | c | True | +| kpss_reg | str | Type of regression for KPSS test. Can be ‘c’,’ct' | c | True | +| export | str | Format for exporting data | | True | + + +--- + +## Returns + +This function does not return anything + +--- + + + diff --git a/website/content/sdk/reference/qa/var.md b/website/content/sdk/reference/qa/var.md new file mode 100644 index 000000000000..c7a97b81694b --- /dev/null +++ b/website/content/sdk/reference/qa/var.md @@ -0,0 +1,96 @@ +--- +title: var +description: This Docusaurus page contains Python source code for 'var/model' and + 'var chart' functions. Each section provides detailed explanations of parameters + and returns, and links to the respective source code. The functions are a part of + quantitative analysis of a specified stock dataframe. +keywords: +- Docusaurus page +- tab items +- Python code +- quantitative analysis +- dataframe +- var/model +- var chart +- parameters +- returns +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + +Gets value at risk for specified stock dataframe. + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/common/quantitative_analysis/qa_model.py#L224)] + +```python +openbb.qa.var(data: pd.DataFrame, use_mean: bool = False, adjusted_var: bool = False, student_t: bool = False, percentile: Union[int, float] = 99.9, portfolio: bool = False) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| data | pd.DataFrame | Data dataframe | None | False | +| use_mean | bool | If one should use the data mean for calculation | False | True | +| adjusted_var | bool | If one should return VaR adjusted for skew and kurtosis | False | True | +| student_t | bool | If one should use the student-t distribution | False | True | +| percentile | Union[int,float] | VaR percentile | 99.9 | True | +| portfolio | bool | If the data is a portfolio | False | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | DataFrame with Value at Risk per percentile | +--- + + + + +Prints table showing VaR of dataframe. + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/common/quantitative_analysis/qa_view.py#L1048)] + +```python +openbb.qa.var_chart(data: pd.DataFrame, symbol: str = "", use_mean: bool = False, adjusted_var: bool = False, student_t: bool = False, percentile: float = 99.9, data_range: int = 0, portfolio: bool = False) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| data | pd.Dataframe | Data dataframe | None | False | +| use_mean | bool | if one should use the data mean return | False | True | +| symbol | str | name of the data | | True | +| adjusted_var | bool | if one should have VaR adjusted for skew and kurtosis (Cornish-Fisher-Expansion) | False | True | +| student_t | bool | If one should use the student-t distribution | False | True | +| percentile | int | var percentile | 99.9 | True | +| data_range | int | Number of rows you want to use VaR over | 0 | True | +| portfolio | bool | If the data is a portfolio | False | True | + + +--- + +## Returns + +This function does not return anything + +--- + + + diff --git a/website/content/sdk/reference/stocks/ba/bullbear.md b/website/content/sdk/reference/stocks/ba/bullbear.md new file mode 100644 index 000000000000..53acf590b524 --- /dev/null +++ b/website/content/sdk/reference/stocks/ba/bullbear.md @@ -0,0 +1,40 @@ +--- +title: bullbear +description: This page provides information on how to use OpenBB's bullbear function + that fetches sentiment for a ticker from stocktwits. Detailed info about parameters + and returns are included. +keywords: +- bullbear function +- stocktwits +- sentiment analysis +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Gets bullbear sentiment for ticker [Source: stocktwits]. + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/common/behavioural_analysis/stocktwits_model.py#L16)] + +```python +openbb.stocks.ba.bullbear(symbol: str) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| symbol | str | Ticker symbol to look at | None | False | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| Tuple[int, int, int, int] | Watchlist count,
Number of cases found for ticker,
Number of bullish statements,
Number of bearish statements, | +--- diff --git a/website/content/sdk/reference/stocks/ba/cnews.md b/website/content/sdk/reference/stocks/ba/cnews.md new file mode 100644 index 000000000000..8c55f8c34799 --- /dev/null +++ b/website/content/sdk/reference/stocks/ba/cnews.md @@ -0,0 +1,45 @@ +--- +title: cnews +description: This page provides details about the 'cnews' function of the OpenBB Terminal, + capable of fetching company news. The function uses the company ticker and optional + dates of search as parameters. +keywords: +- cnews function +- company news +- Finnhub +- company ticker +- news articles +- search dates +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Get news from a company. [Source: Finnhub] + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/stocks/behavioural_analysis/finnhub_model.py#L20)] + +```python +openbb.stocks.ba.cnews(symbol: str, start_date: Optional[str] = None, end_date: Optional[str] = None) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| symbol | str | company ticker to look for news articles | None | False | +| start_date | Optional[str] | date to start searching articles, with format YYYY-MM-DD | None | True | +| end_date | Optional[str] | date to end searching articles, with format YYYY-MM-DD | None | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| List | term to search on the news articles | +--- diff --git a/website/content/sdk/reference/stocks/ba/getdd.md b/website/content/sdk/reference/stocks/ba/getdd.md new file mode 100644 index 000000000000..afb40621969e --- /dev/null +++ b/website/content/sdk/reference/stocks/ba/getdd.md @@ -0,0 +1,48 @@ +--- +title: getdd +description: This page explains the 'getdd' function. This function fetches due diligence + posts from a list of subreddits. The source code link, parameters including the + stock ticker, number of posts to fetch, and number of days back to fetch the posts, + along with the return type are described. +keywords: +- getdd function +- stock ticker +- subreddits +- dataframe +- due diligence posts +- number of posts +- number of days +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Gets due diligence posts from list of subreddits [Source: reddit]. + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/common/behavioural_analysis/reddit_model.py#L711)] + +```python +openbb.stocks.ba.getdd(symbol: str, limit: int = 5, n_days: int = 3, show_all_flairs: bool = False) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| symbol | str | Stock ticker | None | False | +| limit | int | Number of posts to get | 5 | True | +| n_days | int | Number of days back to get posts | 3 | True | +| show_all_flairs | bool | Search through all flairs (apart from Yolo and Meme) | False | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | Dataframe of submissions | +--- diff --git a/website/content/sdk/reference/stocks/ba/headlines.md b/website/content/sdk/reference/stocks/ba/headlines.md new file mode 100644 index 000000000000..5d7ebe01b624 --- /dev/null +++ b/website/content/sdk/reference/stocks/ba/headlines.md @@ -0,0 +1,86 @@ +--- +title: headlines +description: The website page provides detailed documentation on how to use sentiment + analysis with FinBrain's API on a company's stock. It offers instructions on extracting + sentiment from headlines and visualizing sentiment trends through charts. +keywords: +- sentiment analysis +- FinBrain's API +- stock analysis +- data visualization +- OpenBBTerminal documentation +- behavioural analysis +- stock sentiment +- Stock market data +- Open-source software +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + +Gets Sentiment analysis provided by FinBrain's API [Source: finbrain]. + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/common/behavioural_analysis/finbrain_model.py#L15)] + +```python +openbb.stocks.ba.headlines(symbol: str) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| symbol | str | Ticker symbol to get the sentiment analysis from | None | False | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | Empty if there was an issue with data retrieval | +--- + + + + +Plots Sentiment analysis from FinBrain. Prints table if raw is True. [Source: FinBrain] + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/common/behavioural_analysis/finbrain_view.py#L36)] + +```python +openbb.stocks.ba.headlines_chart(symbol: str, raw: bool = False, export: str = "", external_axes: Optional[List[matplotlib.axes._axes.Axes]] = None) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| symbol | str | Ticker symbol to get the sentiment analysis from | None | False | +| raw | False | Display raw table data | False | True | +| export | str | Format to export data | | True | +| external_axes | Optional[List[plt.Axes]] | External axes (1 axis is expected in the list), by default None | None | True | + + +--- + +## Returns + +This function does not return anything + +--- + + + diff --git a/website/content/sdk/reference/stocks/ba/hist.md b/website/content/sdk/reference/stocks/ba/hist.md new file mode 100644 index 000000000000..d66e3bbbcf13 --- /dev/null +++ b/website/content/sdk/reference/stocks/ba/hist.md @@ -0,0 +1,90 @@ +--- +title: hist +description: This page provides coding tutorials on how to get hour-level sentiment + data for a chosen stock symbol and display the historical sentiment data of a ticker + using OpenBB tools. It also includes source codes, parameters, and return information. +keywords: +- hour-level sentiment data +- stock symbol +- historical sentiment data +- coding tutorial +- parameters +- returns +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + +Get hour-level sentiment data for the chosen symbol. + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/common/behavioural_analysis/sentimentinvestor_model.py#L19)] + +```python +openbb.stocks.ba.hist(symbol: str, start_date: Optional[str] = None, end_date: Optional[str] = None, number: int = 100) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| symbol | str | Ticker to view sentiment data | None | False | +| start_date | Optional[str] | Initial date like string or unix timestamp (e.g. 12-21-2021) | None | True | +| end_date | Optional[str] | End date like string or unix timestamp (e.g. 12-21-2021) | None | True | +| number | int | Number of results returned by API call
Maximum 250 per api call | 100 | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | Dataframe of historical sentiment | +--- + + + + +Display historical sentiment data of a ticker, + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/common/behavioural_analysis/sentimentinvestor_view.py#L30)] + +```python +openbb.stocks.ba.hist_chart(symbol: str, start_date: Optional[str] = None, end_date: Optional[str] = None, number: int = 100, raw: bool = False, limit: int = 10, export: str = "", external_axes: Optional[List[matplotlib.axes._axes.Axes]] = None) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| symbol | str | Ticker symbol to view sentiment data | None | False | +| start_date | Optional[str] | Initial date like string or unix timestamp (e.g. 2021-12-21) | None | True | +| end_date | Optional[str] | End date like string or unix timestamp (e.g. 2022-01-15) | None | True | +| number | int | Number of results returned by API call
Maximum 250 per api call | 100 | True | +| raw | boolean | Whether to display raw data, by default False | False | True | +| limit | int | Number of results display on the terminal
Default: 10 | 10 | True | +| export | str | Format to export data | | True | +| external_axes | Optional[List[plt.Axes]] | External axes (2 axes are expected in the list), by default None | None | True | + + +--- + +## Returns + +This function does not return anything + +--- + + + diff --git a/website/content/sdk/reference/stocks/ba/infer.md b/website/content/sdk/reference/stocks/ba/infer.md new file mode 100644 index 000000000000..b50614c47cff --- /dev/null +++ b/website/content/sdk/reference/stocks/ba/infer.md @@ -0,0 +1,86 @@ +--- +title: infer +description: This page is a detailed guide for using OpenBB's terminal to access and + analyze Twitter data, providing tips for inferring market sentiment from tweets + and visualizing data. +keywords: +- terminal guidance +- Twitter data analysis +- market sentiment +- social media analytics +- VADER sentiment analysis +- data visualization +- programming code +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + +Load tweets from twitter API and analyzes using VADER. + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/common/behavioural_analysis/twitter_model.py#L23)] + +```python +openbb.stocks.ba.infer(symbol: str, limit: int = 100, start_date: Optional[str] = "", end_date: Optional[str] = "") +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| symbol | str | Ticker symbol to search twitter for | None | False | +| limit | int | Number of tweets to analyze | 100 | True | +| start_date | Optional[str] | If given, the start time to get tweets from | | True | +| end_date | Optional[str] | If given, the end time to get tweets from | | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | Dataframe of tweets and sentiment | +--- + + + + +Prints Inference sentiment from past n tweets. + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/common/behavioural_analysis/twitter_view.py#L29)] + +```python +openbb.stocks.ba.infer_chart(symbol: str, limit: int = 100, export: str = "") +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| symbol | str | Stock ticker symbol | None | False | +| limit | int | Number of tweets to analyze | 100 | True | +| export | str | Format to export tweet dataframe | | True | + + +--- + +## Returns + +This function does not return anything + +--- + + + diff --git a/website/content/sdk/reference/stocks/ba/mentions.md b/website/content/sdk/reference/stocks/ba/mentions.md new file mode 100644 index 000000000000..5d42cb48b15d --- /dev/null +++ b/website/content/sdk/reference/stocks/ba/mentions.md @@ -0,0 +1,82 @@ +--- +title: mentions +description: Documentation page for OpenBB Terminal's modules 'mentions' and 'mentions_chart.' + These modules analyze and visualize the interest over time for a particular stock's + symbol using Google's API. +keywords: +- Stock market analysis +- Google API +- Stock interest +- Data visualization +- Finance +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + +Get interest over time from google api [Source: google]. + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/common/behavioural_analysis/google_model.py#L16)] + +```python +openbb.stocks.ba.mentions(symbol: str) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| symbol | str | Stock ticker symbol | None | False | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | Dataframe of interest over time | +--- + + + + +Plots weekly bars of stock's interest over time. other users watchlist. [Source: Google]. + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/common/behavioural_analysis/google_view.py#L26)] + +```python +openbb.stocks.ba.mentions_chart(symbol: str, start_date: str = "", export: str = "", external_axes: Optional[List[matplotlib.axes._axes.Axes]] = None) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| symbol | str | Ticker symbol | None | False | +| start_date | str | Start date as YYYY-MM-DD string | | True | +| export | str | Format to export data | | True | +| external_axes | Optional[List[plt.Axes]] | External axes (1 axis is expected in the list), by default None | None | True | + + +--- + +## Returns + +This function does not return anything + +--- + + + diff --git a/website/content/sdk/reference/stocks/ba/messages.md b/website/content/sdk/reference/stocks/ba/messages.md new file mode 100644 index 000000000000..7d2bb75512ba --- /dev/null +++ b/website/content/sdk/reference/stocks/ba/messages.md @@ -0,0 +1,43 @@ +--- +title: messages +description: This page provides information regarding the 'get last messages for a + given ticker' function in the OpenBB Terminal. It explains the usage and parameters + of the function. +keywords: +- stock messages +- stock ticker +- Stocktwits messages +- data analysis +- behavioural analysis on stocks +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Get last messages for a given ticker [Source: stocktwits]. + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/common/behavioural_analysis/stocktwits_model.py#L52)] + +```python +openbb.stocks.ba.messages(symbol: str, limit: int = 30) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| symbol | str | Stock ticker symbol | None | False | +| limit | int | Number of messages to get | 30 | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | Dataframe of messages | +--- diff --git a/website/content/sdk/reference/stocks/ba/popular.md b/website/content/sdk/reference/stocks/ba/popular.md new file mode 100644 index 000000000000..f74bc2c83a62 --- /dev/null +++ b/website/content/sdk/reference/stocks/ba/popular.md @@ -0,0 +1,47 @@ +--- +title: popular +description: This page contains a python function to get popular tickers from a list + of subreddits. The function leverages the OpenBB.Finance Terminal to analyze the + behavioral analysis of posts from Reddit. +keywords: +- OpenBB.Finance Terminal +- Reddit ticker analysis +- Python function +- Behavioral analysis +- Popular tickers +- Subreddits +- Post analysis +- DataFrames +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Get popular tickers from list of subreddits [Source: reddit]. + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/common/behavioural_analysis/reddit_model.py#L145)] + +```python +openbb.stocks.ba.popular(limit: int = 10, post_limit: int = 50, subreddits: str = "") +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| limit | int | Number of top tickers to get | 10 | True | +| post_limit | int | How many posts to analyze in each subreddit | 50 | True | +| subreddits | str | String of comma separated subreddits. | | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | DataFrame of top tickers from supplied subreddits | +--- diff --git a/website/content/sdk/reference/stocks/ba/queries.md b/website/content/sdk/reference/stocks/ba/queries.md new file mode 100644 index 000000000000..b7e06f7e9924 --- /dev/null +++ b/website/content/sdk/reference/stocks/ba/queries.md @@ -0,0 +1,44 @@ +--- +title: queries +description: Learn how to get related queries from Google API using the `openbb.stocks.ba.queries` + function in the OpenBB Terminal. This page includes parameters, return types, and + source code. +keywords: +- Google API +- Queries +- Behavioral analysis +- Stock ticker symbol +- Source code +- Marketing SEO +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Get related queries from google api [Source: google]. + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/common/behavioural_analysis/google_model.py#L73)] + +```python +openbb.stocks.ba.queries(symbol: str, limit: int = 10) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| symbol | str | Stock ticker symbol to compare | None | False | +| limit | int | Number of queries to show | 10 | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | Dataframe of related queries | +--- diff --git a/website/content/sdk/reference/stocks/ba/redditsent.md b/website/content/sdk/reference/stocks/ba/redditsent.md new file mode 100644 index 000000000000..e896ff0ec627 --- /dev/null +++ b/website/content/sdk/reference/stocks/ba/redditsent.md @@ -0,0 +1,54 @@ +--- +title: redditsent +description: A documentation on redditsent function. It is used to find posts related + to a specific search term from Reddit. The function provides comprehensive search + and categorization of results based on user-preferences. +keywords: +- redditsent +- Search function +- Reddit posts +- Behavioral analysis +- Python function +- Ticker symbol +- post categorization +- Comprehensive search +- subreddits +- dataframe +- polarity scores +- average polarity score +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Finds posts related to a specific search term in Reddit. + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/common/behavioural_analysis/reddit_model.py#L864)] + +```python +openbb.stocks.ba.redditsent(symbol: str, limit: int = 100, sortby: str = "relevance", time_frame: str = "week", full_search: bool = True, subreddits: str = "all") +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| symbol | str | Ticker symbol to search for | None | False | +| limit | int | Number of posts to get per subreddit | 100 | True | +| sortby | str | Search type (Possibilities: "relevance", "hot", "top", "new", or "comments") | relevance | True | +| time_frame | str | Relative time of post (Possibilities: "hour", "day", "week", "month", "year", "all") | week | True | +| full_search | bool | Enable comprehensive search for ticker | True | True | +| subreddits | str | Comma-separated list of subreddits | all | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| | Dataframe of submissions related to the search term,
List of polarity scores,
Average polarity score. | +--- diff --git a/website/content/sdk/reference/stocks/ba/regions.md b/website/content/sdk/reference/stocks/ba/regions.md new file mode 100644 index 000000000000..1f45b3ea7393 --- /dev/null +++ b/website/content/sdk/reference/stocks/ba/regions.md @@ -0,0 +1,87 @@ +--- +title: regions +description: This page provides detailed instructions on how to utilize the regions + functions from OpenBB finance terminal to retrieve and visualize stock interests + by region using Google API. The documentation covers the parameters, return types, + and source code for the functionalities. +keywords: +- Docusaurus +- SEO metadata +- regions +- google api +- stock's interest +- openbb.stocks.ba.regions +- openbb.stocks.ba.regions_chart +- ticker symbol +- dataframe +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + +Get interest by region from google api [Source: google]. + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/common/behavioural_analysis/google_model.py#L44)] + +```python +openbb.stocks.ba.regions(symbol: str) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| symbol | str | Ticker symbol to look at | None | False | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | Dataframe of interest by region | +--- + + + + +Plots bars of regions based on stock's interest. [Source: Google]. + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/common/behavioural_analysis/google_view.py#L156)] + +```python +openbb.stocks.ba.regions_chart(symbol: str, limit: int = 5, export: str = "", external_axes: Optional[List[matplotlib.axes._axes.Axes]] = None) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| symbol | str | Ticker symbol | None | False | +| limit | int | Number of regions to show | 5 | True | +| export | str | Format to export data | | True | +| external_axes | Optional[List[plt.Axes]] | External axes (1 axis is expected in the list), by default None | None | True | + + +--- + +## Returns + +This function does not return anything + +--- + + + diff --git a/website/content/sdk/reference/stocks/ba/rise.md b/website/content/sdk/reference/stocks/ba/rise.md new file mode 100644 index 000000000000..1ddf8e7736ad --- /dev/null +++ b/website/content/sdk/reference/stocks/ba/rise.md @@ -0,0 +1,43 @@ +--- +title: rise +description: Discover top rising related queries for a stock's symbol with the OpenBB + rise tool. Analyze market behavior and spot trends. +keywords: +- stock analysis +- market trends +- rising queries +- stock symbol use +- OpenBB rise tool +- behavioral analysis +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Get top rising related queries with this stock's query [Source: google]. + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/common/behavioural_analysis/google_model.py#L106)] + +```python +openbb.stocks.ba.rise(symbol: str, limit: int = 10) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| symbol | str | Stock ticker symbol | None | False | +| limit | int | Number of queries to show | 10 | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | Dataframe containing rising related queries | +--- diff --git a/website/content/sdk/reference/stocks/ba/sentiment.md b/website/content/sdk/reference/stocks/ba/sentiment.md new file mode 100644 index 000000000000..15bc15f6145b --- /dev/null +++ b/website/content/sdk/reference/stocks/ba/sentiment.md @@ -0,0 +1,92 @@ +--- +title: sentiment +description: This page provides documentation on extracting sentiment from a stock + ticker symbol, which includes the parameters for the number of tweets per hour, + number of days to extract tweets for, an optional comparison to the corresponding + change in stock price, and an optional export format. Plots sentiments can also + be visualized using the provided python codes. +keywords: +- sentiment analysis +- stock ticker symbol +- tweets per hour +- extract tweets +- stock price +- dataframe +- python code +- plot sentiments +- export format +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + +Get sentiments from symbol. + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/common/behavioural_analysis/twitter_model.py#L125)] + +```python +openbb.stocks.ba.sentiment(symbol: str, n_tweets: int = 15, n_days_past: int = 2) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| symbol | str | Stock ticker symbol to get sentiment for | None | False | +| n_tweets | int | Number of tweets to get per hour | 15 | True | +| n_days_past | int | Number of days to extract tweets for | 2 | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | Dataframe of sentiment | +--- + + + + +Plots sentiments from symbol + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/common/behavioural_analysis/twitter_view.py#L79)] + +```python +openbb.stocks.ba.sentiment_chart(symbol: str, n_tweets: int = 15, n_days_past: int = 2, compare: bool = False, export: str = "", external_axes: Optional[List[matplotlib.axes._axes.Axes]] = None) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| symbol | str | Stock ticker symbol to get sentiment for | None | False | +| n_tweets | int | Number of tweets to get per hour | 15 | True | +| n_days_past | int | Number of days to extract tweets for | 2 | True | +| compare | bool | Show corresponding change in stock price | False | True | +| export | str | Format to export tweet dataframe | | True | +| external_axes | Optional[List[plt.Axes]] | External axes (1 axis is expected in the list), by default None | None | True | + + +--- + +## Returns + +This function does not return anything + +--- + + + diff --git a/website/content/sdk/reference/stocks/ba/snews.md b/website/content/sdk/reference/stocks/ba/snews.md new file mode 100644 index 000000000000..b6d5b0a7b8ab --- /dev/null +++ b/website/content/sdk/reference/stocks/ba/snews.md @@ -0,0 +1,88 @@ +--- +title: snews +description: snews is an impactful tool from OpenBB's finance package employing VADER + sentiment model to analyze stock headline sentiments over time, leveraged from Finnhub + data. It also provides features to visualize these sentiments against the stock + price using Python's matplotlib library. +keywords: +- snews +- VADER model +- Finnhub +- stock sentiment analysis +- OpenBB finance +- trading strategies +- data visualization +- matplotlib +- sentiment over time +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + +Get headlines sentiment using VADER model over time. [Source: Finnhub] + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/stocks/behavioural_analysis/finnhub_model.py#L97)] + +```python +openbb.stocks.ba.snews(symbol: str) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| symbol | str | Ticker of company | None | False | +| Returns | None | | None | True | +| ---------- | None | | None | True | +| pd.DataFrame | None | The news article information | None | True | + + +--- + +## Returns + +This function does not return anything + +--- + + + + +Display stock price and headlines sentiment using VADER model over time. [Source: Finnhub] + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/stocks/behavioural_analysis/finnhub_view.py#L27)] + +```python +openbb.stocks.ba.snews_chart(symbol: str, export: str = "", external_axes: Optional[List[matplotlib.axes._axes.Axes]] = None) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| symbol | str | Ticker of company | None | False | +| export | str | Format to export data | | True | +| external_axes | Optional[List[plt.Axes]] | External axes (2 axes are expected in the list), by default None | None | True | + + +--- + +## Returns + +This function does not return anything + +--- + + + diff --git a/website/content/sdk/reference/stocks/ba/spac.md b/website/content/sdk/reference/stocks/ba/spac.md new file mode 100644 index 000000000000..00dba7398dde --- /dev/null +++ b/website/content/sdk/reference/stocks/ba/spac.md @@ -0,0 +1,43 @@ +--- +title: spac +description: A detailed documentation page on the SPAC function from OpenBB's financial + analysis tool suite. Learn how to extract SPAC-related posts from top subreddits + with OpenBB. +keywords: +- SPAC +- Reddit Analysis +- subreddits +- Financial Analysis +- Data Extraction +- SPAC posts Extraction +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Get posts containing SPAC from top subreddits [Source: reddit]. + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/common/behavioural_analysis/reddit_model.py#L456)] + +```python +openbb.stocks.ba.spac(limit: int = 5) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| limit | int | Number of posts to get for each subreddit, by default 5 | 5 | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| Tuple[pd.DataFrame, dict, int] | Dataframe of reddit submission,
Dictionary of tickers and counts,
Number of posts found. | +--- diff --git a/website/content/sdk/reference/stocks/ba/spacc.md b/website/content/sdk/reference/stocks/ba/spacc.md new file mode 100644 index 000000000000..7b34968a9042 --- /dev/null +++ b/website/content/sdk/reference/stocks/ba/spacc.md @@ -0,0 +1,46 @@ +--- +title: spacc +description: Detailed documentation of the function openbb.stocks.ba.spacc, providing + insights into top trending SPACs on Reddit. The page includes the source code, parameters, + and returns for implementing the function. +keywords: +- SPACs +- Reddit +- Source Code +- openbb.stocks.ba.spacc +- Parameters +- Returns +- dictionary +- Number of mentions +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Get top tickers from r/SPACs [Source: reddit]. + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/common/behavioural_analysis/reddit_model.py#L317)] + +```python +openbb.stocks.ba.spacc(limit: int = 10, popular: bool = False) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| limit | int | Number of posts to look at | 10 | True | +| popular | bool | Search by hot instead of new | False | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| Tuple[pd.DataFrame, dict] | Dataframe of reddit submission,
Dictionary of tickers and number of mentions. | +--- diff --git a/website/content/sdk/reference/stocks/ba/stalker.md b/website/content/sdk/reference/stocks/ba/stalker.md new file mode 100644 index 000000000000..33b16462a36a --- /dev/null +++ b/website/content/sdk/reference/stocks/ba/stalker.md @@ -0,0 +1,45 @@ +--- +title: stalker +description: This documentation page provides information on how to use the 'stalker' + function from the OpenBB platform, which gathers messages from a specified user + on Stocktwits. The source code is also available for referencing. +keywords: +- Stalker +- Messages +- User +- Posts +- Stocktwits +- Source code +- Post limit +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Gets messages from given user [Source: stocktwits]. + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/common/behavioural_analysis/stocktwits_model.py#L103)] + +```python +openbb.stocks.ba.stalker(user: str, limit: int = 30) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| user | str | User to get posts for | None | False | +| limit | int | Number of posts to get, by default 30 | 30 | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| List[Dict[str, Any]] | List of posts | +--- diff --git a/website/content/sdk/reference/stocks/ba/text_sent.md b/website/content/sdk/reference/stocks/ba/text_sent.md new file mode 100644 index 000000000000..f5c23b00532e --- /dev/null +++ b/website/content/sdk/reference/stocks/ba/text_sent.md @@ -0,0 +1,43 @@ +--- +title: text_sent +description: Learn how to use the Text Sentiment Analysis function of OpenBB's Reddit + Model. Understand the sentiment of a post and related comments, providing valuable + insights into stock market trends. +keywords: +- Text sentiment analysis +- Stock market sentiment +- Behavioural analysis +- Comment analysis +- Post analysis +- Reddit model +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Find the sentiment of a post and related comments. + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/common/behavioural_analysis/reddit_model.py#L1049)] + +```python +openbb.stocks.ba.text_sent(post_data: List[str]) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| post_data | list[str] | A post and its comments in string form | None | False | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| float | A number in the range [-1, 1] representing sentiment | +--- diff --git a/website/versioned_docs/version-v3/sdk/reference/stocks/ba/trend.md b/website/content/sdk/reference/stocks/ba/trend.md similarity index 77% rename from website/versioned_docs/version-v3/sdk/reference/stocks/ba/trend.md rename to website/content/sdk/reference/stocks/ba/trend.md index 33e0c64c797b..3f0ea2c1b806 100644 --- a/website/versioned_docs/version-v3/sdk/reference/stocks/ba/trend.md +++ b/website/content/sdk/reference/stocks/ba/trend.md @@ -1,13 +1,30 @@ --- title: trend -description: OpenBB SDK Function +description: The page details functions related to behavioural analysis with OpenBB + Terminal, specifically focusing on trend analysis. The page explains how to generate + sentiment data on the most talked about stock tickers. Explained in detail with + source code and parameters. +keywords: +- sentiment data +- tickers +- trend +- behavioural analysis +- trend chart +- API call +- dataframe +- hour +- number +- limit +- export data --- +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; -# trend - @@ -39,8 +56,6 @@ openbb.stocks.ba.trend(start_date: Optional[str] = None, hour: int = 0, number: | pd.DataFrame | Dataframe of trending data | --- - - @@ -73,7 +88,5 @@ This function does not return anything --- - - - \ No newline at end of file + diff --git a/website/content/sdk/reference/stocks/ba/trending.md b/website/content/sdk/reference/stocks/ba/trending.md new file mode 100644 index 000000000000..a71af7c55ba6 --- /dev/null +++ b/website/content/sdk/reference/stocks/ba/trending.md @@ -0,0 +1,39 @@ +--- +title: trending +description: Learn how to obtain trending tickers from Stocktwits using the OpenBB + Terminal. The page provides clear python code and explanation of the returned dataframe. + OpenBB Terminal is a powerful tool for financial data analysis. +keywords: +- trending tickers +- stocktwits +- python code +- watchlist count +- financial data analysis +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Get trending tickers from stocktwits [Source: stocktwits]. + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/common/behavioural_analysis/stocktwits_model.py#L79)] + +```python +openbb.stocks.ba.trending() +``` + +--- + +## Parameters + +This function does not take any parameters. + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | Dataframe of trending tickers and watchlist count | +--- diff --git a/website/content/sdk/reference/stocks/ba/watchlist.md b/website/content/sdk/reference/stocks/ba/watchlist.md new file mode 100644 index 000000000000..401cbe6b6f62 --- /dev/null +++ b/website/content/sdk/reference/stocks/ba/watchlist.md @@ -0,0 +1,45 @@ +--- +title: watchlist +description: This page provides the syntax and details of the 'watchlist' function + which fetches reddit users watchlists. It includes source code details, usage, parameters + and return values. +keywords: +- Watchlist +- Reddit +- Python function +- Behavioral Analysis +- Source Code +- Returns +- Parameters +- Usage +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Get reddit users watchlists [Source: reddit]. + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/common/behavioural_analysis/reddit_model.py#L40)] + +```python +openbb.stocks.ba.watchlist(limit: int = 5) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| limit | int | Number of posts to look through | 5 | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| Tuple[List[praw.models.reddit.submission.Submission], dict, int] | List of reddit submissions,
Dictionary of tickers and their count,
Count of how many posts were analyzed. | +--- diff --git a/website/content/sdk/reference/stocks/ba/wsb.md b/website/content/sdk/reference/stocks/ba/wsb.md new file mode 100644 index 000000000000..e1626491d242 --- /dev/null +++ b/website/content/sdk/reference/stocks/ba/wsb.md @@ -0,0 +1,47 @@ +--- +title: wsb +description: This page provides documentation for the OpenBB 'wsb' function, which + retrieves reddit posts from wsb. The page includes details about parameters and + returned data in the form of a pandas Dataframe. +keywords: +- wsb +- OpenBB-finance +- reddit_model.py +- openbb.stocks.ba.wsb +- reddit submissions +- Parameters +- Limit +- New +- Returns +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Get wsb posts [Source: reddit]. + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/common/behavioural_analysis/reddit_model.py#L602)] + +```python +openbb.stocks.ba.wsb(limit: int = 10, new: bool = False) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| limit | int | Number of posts to get, by default 10 | 10 | True | +| new | bool | Flag to sort by new instead of hot, by default False | False | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | Dataframe of reddit submissions | +--- diff --git a/website/content/sdk/reference/stocks/ca/balance.md b/website/content/sdk/reference/stocks/ca/balance.md new file mode 100644 index 000000000000..6914fd10f67f --- /dev/null +++ b/website/content/sdk/reference/stocks/ca/balance.md @@ -0,0 +1,47 @@ +--- +title: balance +description: "This page provides a detailed view on the balance data obtained through\ + \ OpenBB Terminal\u2019s stocks comparison analysis. Python source code, parameters\ + \ for the function and return type are conventionally presented." +keywords: +- balance data +- stocks comparison analysis +- marketwatch model +- tickers comparison +- quarterly statements +- data export +- dataframe +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Get balance data. [Source: Marketwatch]. + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/stocks/comparison_analysis/marketwatch_model.py#L107)] + +```python +openbb.stocks.ca.balance(similar: List[str], timeframe: str = "2021", quarter: bool = False) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| similar | List[str] | List of tickers to compare.
Comparable companies can be accessed through
finnhub_peers(), finviz_peers(), polygon_peers(). | None | False | +| timeframe | str | Column header to compare | 2021 | True | +| quarter | bool | Whether to use quarterly statements, by default False | False | True | +| export | str | Format to export data | None | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | Dataframe of balance comparisons | +--- diff --git a/website/content/sdk/reference/stocks/ca/cashflow.md b/website/content/sdk/reference/stocks/ca/cashflow.md new file mode 100644 index 000000000000..3bbdfab5f9d4 --- /dev/null +++ b/website/content/sdk/reference/stocks/ca/cashflow.md @@ -0,0 +1,48 @@ +--- +title: cashflow +description: This page discusses the cashflow data from Marketwatch. It explains how + to use the openbb.stocks.ca.cashflow function, its parameters, and outputs, emphasizing + on a dataframe of cashflow comparisons. +keywords: +- cashflow data +- marketwatch source code +- openbb.stocks.ca.cashflow function +- parameters +- dataframe of cashflow comparisons +- timeframe +- quarter +- export +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Get cashflow data. [Source: Marketwatch] + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/stocks/comparison_analysis/marketwatch_model.py#L140)] + +```python +openbb.stocks.ca.cashflow(similar: List[str], timeframe: str = "2021", quarter: bool = False) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| similar | List[str] | List of tickers to compare.
Comparable companies can be accessed through
finnhub_peers(), finviz_peers(), polygon_peers(). | None | False | +| timeframe | str | Column header to compare | 2021 | True | +| quarter | bool | Whether to use quarterly statements, by default False | False | True | +| export | str | Format to export data | None | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | Dataframe of cashflow comparisons | +--- diff --git a/website/content/sdk/reference/stocks/ca/hcorr.md b/website/content/sdk/reference/stocks/ca/hcorr.md new file mode 100644 index 000000000000..b35adb1cd67e --- /dev/null +++ b/website/content/sdk/reference/stocks/ca/hcorr.md @@ -0,0 +1,87 @@ +--- +title: hcorr +description: The page gives detailed guidelines on how to use the hcorr function in + OpenBB Terminal to gather historical price correlation data. It further explains + the process to create correlation heatmaps based on historical price comparison. +keywords: +- historical price correlation +- chart +- finance tools +- correlation matrix +- finance source code +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + +Get historical price correlation. [Source: Yahoo Finance] + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/stocks/comparison_analysis/yahoo_finance_model.py#L98)] + +```python +openbb.stocks.ca.hcorr(similar: List[str], start_date: Optional[str] = None, candle_type: str = "a") +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| similar | List[str] | List of similar tickers.
Comparable companies can be accessed through
finnhub_peers(), finviz_peers(), polygon_peers(). | None | False | +| start_date | Optional[str] | Initial date (e.g., 2021-10-01). Defaults to 1 year back | None | True | +| candle_type | str | OHLCA column to use for candles or R for returns, by default "a" for Adjusted Close | a | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| Tuple[pd.DataFrame, pd.DataFrame] | Dataframe with correlation matrix, Dataframe with historical prices for all comparison stocks | +--- + + + + +Correlation heatmap based on historical price comparison + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/stocks/comparison_analysis/yahoo_finance_view.py#L159)] + +```python +openbb.stocks.ca.hcorr_chart(similar: List[str], start_date: Optional[str] = None, candle_type: str = "a", display_full_matrix: bool = False, raw: bool = False, external_axes: Optional[List[matplotlib.axes._axes.Axes]] = None, export: str = "") +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| similar | List[str] | List of similar tickers.
Comparable companies can be accessed through
finnhub_peers(), finviz_peers(), polygon_peers(). | None | False | +| start_date | Optional[str] | Initial date (e.g., 2021-10-01). Defaults to 1 year back | None | True | +| candle_type | str | OHLCA column to use for candles or R for returns, by default "a" for Adjusted Close | a | True | +| display_full_matrix | bool | Optionally display all values in the matrix, rather than masking off half, by default False | False | True | +| raw | bool | Whether to display raw data | False | True | +| external_axes | Optional[List[plt.Axes]] | External axes (1 axis is expected in the list), by default None | None | True | +| export | str | Format to export correlation prices, by default "" | | True | + + +--- + +## Returns + +This function does not return anything + +--- + + + diff --git a/website/content/sdk/reference/stocks/ca/hist.md b/website/content/sdk/reference/stocks/ca/hist.md new file mode 100644 index 000000000000..86679cce193c --- /dev/null +++ b/website/content/sdk/reference/stocks/ca/hist.md @@ -0,0 +1,95 @@ +--- +title: hist +description: Python code examples using OpenBB Terminal to retrieve, visualize and + manipulate historical stock prices from Yahoo Finance for a list of comparison stocks. + The code covers data acquisition, charting of historical prices, and export functionalities. +keywords: +- stock comparison +- historical stock prices +- data visualization +- Python code +- Yahoo Finance +- stock market analysis +- stock price chart +- stock data export +- data manipulation +- stock data normalization +- Comparable companies +- Finnhub peers +- Finnviz peers +- Polygon peers +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + +Get historical prices for all comparison stocks + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/stocks/comparison_analysis/yahoo_finance_model.py#L31)] + +```python +openbb.stocks.ca.hist(similar: List[str], start_date: Optional[str] = None, candle_type: str = "a") +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| similar | List[str] | List of similar tickers.
Comparable companies can be accessed through
finnhub_peers(), finviz_peers(), polygon_peers(). | None | False | +| start_date | Optional[str] | Initial date (e.g., 2021-10-01). Defaults to 1 year back | None | True | +| candle_type | str | Candle variable to compare, by default "a" for Adjusted Close. Possible values are: o, h, l, c, a, v, r | a | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | Dataframe containing candle type variable for each ticker | +--- + + + + +Display historical stock prices. [Source: Yahoo Finance] + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/stocks/comparison_analysis/yahoo_finance_view.py#L43)] + +```python +openbb.stocks.ca.hist_chart(similar: List[str], start_date: Optional[str] = None, candle_type: str = "a", normalize: bool = True, export: str = "", external_axes: Optional[List[matplotlib.axes._axes.Axes]] = None) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| similar | List[str] | List of similar tickers.
Comparable companies can be accessed through
finnhub_peers(), finviz_peers(), polygon_peers(). | None | False | +| start_date | Optional[str] | Initial date (e.g., 2021-10-01). Defaults to 1 year back | None | True | +| candle_type | str | OHLCA column to use or R to use daily returns calculated from Adjusted Close, by default "a" for Adjusted Close | a | True | +| normalize | bool | Boolean to normalize all stock prices using MinMax defaults True | True | True | +| export | str | Format to export historical prices, by default "" | | True | +| external_axes | Optional[List[plt.Axes]] | External axes (1 axis is expected in the list), by default None | None | True | + + +--- + +## Returns + +This function does not return anything + +--- + + + diff --git a/website/content/sdk/reference/stocks/ca/income.md b/website/content/sdk/reference/stocks/ca/income.md new file mode 100644 index 000000000000..c10d06138d97 --- /dev/null +++ b/website/content/sdk/reference/stocks/ca/income.md @@ -0,0 +1,92 @@ +--- +title: income +description: This page provides detailed information on how to get income data from + different peer companies using OpenBB's financial functions. This includes the source + code and the parameters needed for these operations. +keywords: +- income data +- financial functions +- parameters +- Marketwatch +- income statements +- quarterly statements +- dataframe +- income chart +- data export +- financial comparison +- ticker comparison +- financial data analysis +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + +Get income data. [Source: Marketwatch]. + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/stocks/comparison_analysis/marketwatch_model.py#L74)] + +```python +openbb.stocks.ca.income(similar: List[str], timeframe: str = "2021", quarter: bool = False) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| similar | List[str] | List of tickers to compare.
Comparable companies can be accessed through
finnhub_peers(), finviz_peers(), polygon_peers(). | None | False | +| timeframe | str | Column header to compare | 2021 | True | +| quarter | bool | Whether to use quarterly statements, by default False | False | True | +| export | str | Format to export data | None | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | Dataframe of income statements | +--- + + + + +Display income data. [Source: Marketwatch]. + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/stocks/comparison_analysis/marketwatch_view.py#L23)] + +```python +openbb.stocks.ca.income_chart(symbols: List[str], timeframe: str = "2021", quarter: bool = False, export: str = "") +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| symbols | List[str] | List of tickers to compare. Enter tickers you want to see as shown below:
["TSLA", "AAPL", "NFLX", "BBY"]
You can also get a list of comparable peers with
finnhub_peers(), finviz_peers(), polygon_peers(). | None | False | +| timeframe | str | What year to look at | 2021 | True | +| quarter | bool | Whether to use quarterly statements, by default False | False | True | +| export | str | Format to export data | | True | + + +--- + +## Returns + +This function does not return anything + +--- + + + diff --git a/website/content/sdk/reference/stocks/ca/scorr.md b/website/content/sdk/reference/stocks/ca/scorr.md new file mode 100644 index 000000000000..d74cdef1cd0c --- /dev/null +++ b/website/content/sdk/reference/stocks/ca/scorr.md @@ -0,0 +1,90 @@ +--- +title: scorr +description: This page provides information on the 'scorr' function, a tool used to + get correlation sentiments across similar companies. It also displays information + on how to utilize the 'scorr_chart' function, designed to plot correlation sentiments + heatmap for a set of similar companies. +keywords: +- scorr function +- scorr_chart function +- correlation sentiments +- similar companies +- FinBrain +- FinViz +- Finnhub +- Polygon +- heatmap plot +- sentiment analysis +- stock comparison +- matplotlib axes +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + +Get correlation sentiments across similar companies. [Source: FinBrain]. + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/stocks/comparison_analysis/finbrain_model.py#L125)] + +```python +openbb.stocks.ca.scorr(similar: List[str]) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| similar | List[str] | Similar companies to compare income with.
Comparable companies can be accessed through
finnhub_peers(), finviz_peers(), polygon_peers(). | None | False | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| Tuple[pd.DataFrame,pd.DataFrame] | Contains sentiment analysis from several tickers | +--- + + + + +Plot correlation sentiments heatmap across similar companies. [Source: FinBrain]. + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/stocks/comparison_analysis/finbrain_view.py#L121)] + +```python +openbb.stocks.ca.scorr_chart(similar: List[str], raw: bool = False, export: str = "", external_axes: Optional[List[matplotlib.axes._axes.Axes]] = None) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| similar | List[str] | Similar companies to compare income with.
Comparable companies can be accessed through
finviz_peers(), finnhub_peers() or polygon_peers(). | None | False | +| raw | bool | Output raw values, by default False | False | True | +| export | str | Format to export data | | True | +| external_axes | Optional[List[plt.Axes]] | External axes (1 axis is expected in the list), by default None | None | True | + + +--- + +## Returns + +This function does not return anything + +--- + + + diff --git a/website/content/sdk/reference/stocks/ca/screener.md b/website/content/sdk/reference/stocks/ca/screener.md new file mode 100644 index 000000000000..3e1bf580d04c --- /dev/null +++ b/website/content/sdk/reference/stocks/ca/screener.md @@ -0,0 +1,45 @@ +--- +title: screener +description: This documentation page provides an overview of the Screener feature + in the OpenBB Terminal, demonstrating how to use it to compare similar companies. +keywords: +- Stock Screener +- Comparison Analysis +- Similar Companies +- Finviz +- Finnhub +- Polygon +- Technical Analysis +- Financial Analysis +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Screener Overview. + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/stocks/comparison_analysis/finviz_compare_model.py#L53)] + +```python +openbb.stocks.ca.screener(similar: List[str], data_type: str = "overview") +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| similar | | List of similar companies.
Comparable companies can be accessed through
finnhub_peers(), finviz_peers(), polygon_peers(). | None | False | +| data_type | str | Data type between: overview, valuation, financial, ownership, performance, technical | overview | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | Dataframe with overview, valuation, financial, ownership, performance or technical | +--- diff --git a/website/content/sdk/reference/stocks/ca/sentiment.md b/website/content/sdk/reference/stocks/ca/sentiment.md new file mode 100644 index 000000000000..98bbe9d2ec7e --- /dev/null +++ b/website/content/sdk/reference/stocks/ca/sentiment.md @@ -0,0 +1,92 @@ +--- +title: sentiment +description: The page provides detailed information about Sentiment Analysis functions + provided by the OpenBB Finance Terminal. It guides users on how to retrieve sentiment + analysis for several symbols using FinBrain's API and how to display the sentiment + for all ticker. +keywords: +- API +- Sentiment Analysis +- Finance +- Terminal +- FinBrain +- Ticker +- Symbols +- Finviz_peers +- Finnhub_peers +- Polygon_peers +- Data visualization +- matplotlib +- Data Export +- Sentiment chart +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + +Gets Sentiment analysis from several symbols provided by FinBrain's API. + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/stocks/comparison_analysis/finbrain_model.py#L47)] + +```python +openbb.stocks.ca.sentiment(symbols: List[str]) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| symbols | List[str] | List of tickers to get sentiment.
Comparable companies can be accessed through
finnhub_peers(), finviz_peers(), polygon_peers(). | None | False | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | Contains sentiment analysis from several tickers | +--- + + + + +Display sentiment for all ticker. [Source: FinBrain]. + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/stocks/comparison_analysis/finbrain_view.py#L32)] + +```python +openbb.stocks.ca.sentiment_chart(similar: List[str], raw: bool = False, export: str = "", external_axes: Optional[List[matplotlib.axes._axes.Axes]] = None) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| similar | List[str] | Similar companies to compare income with.
Comparable companies can be accessed through
finviz_peers(), finnhub_peers() or polygon_peers(). | None | False | +| raw | bool | Output raw values, by default False | False | True | +| export | str | Format to export data | | True | +| external_axes | Optional[List[plt.Axes]] | External axes (1 axis is expected in the list), by default None | None | True | + + +--- + +## Returns + +This function does not return anything + +--- + + + diff --git a/website/content/sdk/reference/stocks/ca/similar.md b/website/content/sdk/reference/stocks/ca/similar.md new file mode 100644 index 000000000000..94cb0e9d1352 --- /dev/null +++ b/website/content/sdk/reference/stocks/ca/similar.md @@ -0,0 +1,66 @@ +--- +title: similar +description: Documentation for the 'similar' functionality in the OpenBB-finance package. + Includes details about the function, parameters and returns, and examples. +keywords: +- OpenBB-finance +- similar tickers +- stock comparison +- stock analysis +- python package +- Finviz +- Polygon +- Finnhub +- TSNE +- stock symbols +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Find similar tickers to a given symbol. + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/stocks/comparison_analysis/sdk_helpers.py#L15)] + +```python +openbb.stocks.ca.similar(symbol: str, source: Any = "Finviz") +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| symbol | str | Symbol to find similar tickers to. | None | False | +| source | str | Source to get data for, by default "Finviz". Can be "Finviz", "Polygon", "Finnhub", or "TSNE" | Finviz | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| List[str] | List of similar tickers. | +--- + +## Examples + + +To get similar tickers to AAPL from Finviz: + +```python +from openbb_terminal.sdk import openbb +similar_tickers = openbb.stocks.ca.similar("AAPL) +``` + + +To use our custom TSNE model for similar tickers in the SP500: + +```python +similar_tickers = openbb.stocks.ca.similar("AAPL", source="TSNE") +``` + +--- diff --git a/website/content/sdk/reference/stocks/ca/volume.md b/website/content/sdk/reference/stocks/ca/volume.md new file mode 100644 index 000000000000..d48ea4fd1513 --- /dev/null +++ b/website/content/sdk/reference/stocks/ca/volume.md @@ -0,0 +1,89 @@ +--- +title: volume +description: This documentation page details how to get and display stock volume using + openbb.stocks.ca volume function. Includes Python codes and parameter descriptions + for user guidance. +keywords: +- openbb.stocks.ca +- stock volume +- Yahoo Finance +- docusaurus +- parameter description +- volume_chart +- volume function +- stock analysis +- finnhub_peers +- finviz_peers +- polygon_peers +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + +Get stock volume. [Source: Yahoo Finance] + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/stocks/comparison_analysis/yahoo_finance_model.py#L134)] + +```python +openbb.stocks.ca.volume(similar: List[str], start_date: Optional[str] = None) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| similar | List[str] | List of similar tickers.
Comparable companies can be accessed through
finnhub_peers(), finviz_peers(), polygon_peers(). | None | False | +| start_date | Optional[str] | Initial date (e.g., 2021-10-01). Defaults to 1 year back | None | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | Dataframe with volume for stock | +--- + + + + +Display stock volume. [Source: Yahoo Finance] + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/stocks/comparison_analysis/yahoo_finance_view.py#L107)] + +```python +openbb.stocks.ca.volume_chart(similar: List[str], start_date: Optional[str] = None, export: str = "", external_axes: Optional[List[matplotlib.axes._axes.Axes]] = None) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| similar | List[str] | List of similar tickers.
Comparable companies can be accessed through
finnhub_peers(), finviz_peers(), polygon_peers(). | None | False | +| start_date | Optional[str] | Initial date (e.g., 2021-10-01). Defaults to 1 year back | None | True | +| export | str | Format to export historical prices, by default "" | | True | +| external_axes | Optional[List[plt.Axes]] | External axes (1 axis is expected in the list), by default None | None | True | + + +--- + +## Returns + +This function does not return anything + +--- + + + diff --git a/website/content/sdk/reference/stocks/candle.md b/website/content/sdk/reference/stocks/candle.md new file mode 100644 index 000000000000..4ceb0cbeb063 --- /dev/null +++ b/website/content/sdk/reference/stocks/candle.md @@ -0,0 +1,75 @@ +--- +title: candle +description: This documentation page contains information about the 'candle' function + of OpenBB's SDK which plots the candlestick chart for a specific stock ticker. It + offers various parameters for data customization providing an interactive way to + visualize stock market data. +keywords: +- Candle function +- Stocks visualization +- OpenBB terminal +- Candlestick chart +- Python stock market data +- Matplotlib +- Plotly +- Stock ticker data +- Intraday data +- Financial data +- SEO for technical documentation +- SEO for programming documentation +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Show candle plot of loaded ticker. + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/stocks/stocks_helper.py#L443)] + +```python +openbb.stocks.candle(symbol: str, data: pd.DataFrame = None, use_matplotlib: bool = True, intraday: bool = False, add_trend: bool = False, ma: Optional[Iterable[int]] = None, asset_type: str = "", start_date: Union[datetime.datetime, str, NoneType] = None, interval: int = 1440, end_date: Union[datetime.datetime, str, NoneType] = None, prepost: bool = False, source: str = "YahooFinance", weekly: bool = False, monthly: bool = False, external_axes: Optional[List[matplotlib.axes._axes.Axes]] = None, raw: bool = False, yscale: str = "linear") +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| symbol | str | Ticker name | None | False | +| data | pd.DataFrame | Stock dataframe | None | True | +| use_matplotlib | bool | Flag to use matplotlib instead of interactive plotly chart | True | True | +| intraday | bool | Flag for intraday data for plotly range breaks | False | True | +| add_trend | bool | Flag to add high and low trends to chart | False | True | +| ma | Tuple[int] | Moving averages to add to the candle | None | True | +| asset_type_ | str | String to include in title | None | True | +| external_axes | Optional[List[plt.Axes]] | External axes (2 axes are expected in the list), by default None | None | True | +| asset_type_ | str | String to include in title | None | True | +| start_date | str or datetime | Start date to get data from with. - datetime or string format (YYYY-MM-DD) | None | True | +| interval | int | Interval (in minutes) to get data 1, 5, 15, 30, 60 or 1440 | 1440 | True | +| end_date | str or datetime | End date to get data from with. - datetime or string format (YYYY-MM-DD) | None | True | +| prepost | bool | Pre and After hours data | False | True | +| source | str | Source of data extracted | YahooFinance | True | +| weekly | bool | Flag to get weekly data | False | True | +| monthly | bool | Flag to get monthly data | False | True | +| raw | bool | Flag to display raw data, by default False | False | True | +| yscale | str | Linear or log for yscale | linear | True | + + +--- + +## Returns + +This function does not return anything + +--- + +## Examples + +```python +from openbb_terminal.sdk import openbb +openbb.stocks.candle("AAPL") +``` + +--- diff --git a/website/content/sdk/reference/stocks/dd/analyst.md b/website/content/sdk/reference/stocks/dd/analyst.md new file mode 100644 index 000000000000..a11f4e7c4613 --- /dev/null +++ b/website/content/sdk/reference/stocks/dd/analyst.md @@ -0,0 +1,44 @@ +--- +title: analyst +description: This documentation page provides details on retrieving analyst data from + the OpenBB terminal. Get valuable information regarding stock ticker symbols and + analyst price targets for your due diligence. +keywords: +- Analyst +- Finviz +- Analyst Data +- Stocks +- Price Targets +- Stock Ticker Symbol +- Due Diligence +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Get analyst data. [Source: Finviz] + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/stocks/due_diligence/finviz_model.py#L33)] + +```python +openbb.stocks.dd.analyst(symbol: str) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| symbol | str | Stock ticker symbol | None | False | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| DataFrame | Analyst price targets | +--- diff --git a/website/content/sdk/reference/stocks/dd/arktrades.md b/website/content/sdk/reference/stocks/dd/arktrades.md new file mode 100644 index 000000000000..855076a72837 --- /dev/null +++ b/website/content/sdk/reference/stocks/dd/arktrades.md @@ -0,0 +1,46 @@ +--- +title: arktrades +description: Arktrades is a feature provided by OpenBB Stocks, a function in Python + facilitating due diligence for stock trading. This page contains the guide to access + ARK trades for a particular stock ticker, returning a dataframe of trades. Source + code included, hosted on GitHub. +keywords: +- arktrades +- OpenBB Stocks +- Stocks Due Diligence +- trade dataframe +- ARK trades +- Stock Ticker +- Stock Trades +- GitHub Source Code +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Gets a dataframe of ARK trades for ticker + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/stocks/due_diligence/ark_model.py#L19)] + +```python +openbb.stocks.dd.arktrades(symbol: str) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| symbol | str | Ticker to get trades for | None | False | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | DataFrame of trades | +--- diff --git a/website/content/sdk/reference/stocks/dd/customer.md b/website/content/sdk/reference/stocks/dd/customer.md new file mode 100644 index 000000000000..9fb4a1179d51 --- /dev/null +++ b/website/content/sdk/reference/stocks/dd/customer.md @@ -0,0 +1,45 @@ +--- +title: customer +description: Documentation for the 'customer' function in the OpenBB Terminal. This + function allows you to print customers from a ticker, helping in stock analysis + and due diligence. Here, you'll find details about parameters, return values, and + the source code. +keywords: +- customer +- stocks +- due diligence +- dataframe +- symbol +- limit +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Print customers from ticker provided + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/stocks/due_diligence/csimarket_model.py#L66)] + +```python +openbb.stocks.dd.customer(symbol: str, limit: int = 50) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| symbol | str | Ticker to select customers from | None | False | +| limit | int | The maximum number of rows to show | 50 | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | A dataframe of suppliers | +--- diff --git a/website/content/sdk/reference/stocks/dd/est.md b/website/content/sdk/reference/stocks/dd/est.md new file mode 100644 index 000000000000..22ca326baa72 --- /dev/null +++ b/website/content/sdk/reference/stocks/dd/est.md @@ -0,0 +1,41 @@ +--- +title: est +description: Access analysts' estimates for given ticker symbols utilizing OpenBB. + Understand the method in Python with accompanying source code and expected return + data types. +keywords: +- analysts' estimates +- business insider +- stocks +- due diligence +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Get analysts' estimates for a given ticker. [Source: Business Insider] + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/stocks/due_diligence/business_insider_model.py#L76)] + +```python +openbb.stocks.dd.est(symbol: str) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| symbol | str | Ticker to get analysts' estimates | None | False | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | Year estimates | +--- diff --git a/website/content/sdk/reference/stocks/dd/news.md b/website/content/sdk/reference/stocks/dd/news.md new file mode 100644 index 000000000000..ecede9fbe403 --- /dev/null +++ b/website/content/sdk/reference/stocks/dd/news.md @@ -0,0 +1,43 @@ +--- +title: news +description: This page provides details on how to use the Finviz News function integrated + into OpenBB. This function can be used to pull the latest news for a specific stock + ticker symbol. +keywords: +- Finviz News +- OpenBB Finviz integration +- Python Finviz news function +- stock ticker symbol +- financial news +- website news API +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Get news from Finviz + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/stocks/due_diligence/finviz_model.py#L16)] + +```python +openbb.stocks.dd.news(symbol: str) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| symbol | str | Stock ticker symbol | None | False | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| List[Any] | News | +--- diff --git a/website/content/sdk/reference/stocks/dd/pt.md b/website/content/sdk/reference/stocks/dd/pt.md new file mode 100644 index 000000000000..604c6a9e4c8d --- /dev/null +++ b/website/content/sdk/reference/stocks/dd/pt.md @@ -0,0 +1,103 @@ +--- +title: pt +description: This documentation pertains to OpenBB's APIs for retrieving and visualizing + analysts' price targets for stocks. Two key functions are discussed, one to retrieve + the data and the other to generate charts. +keywords: +- API documentation +- stock price targets +- data retrieval +- data visualization +- analysts' price targets +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + +Get analysts' price targets for a given stock. [Source: Business Insider] + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/stocks/due_diligence/business_insider_model.py#L20)] + +```python +openbb.stocks.dd.pt(symbol: str) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| symbol | str | Ticker symbol | None | False | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | Analysts data | +--- + +## Examples + +```python +from openbb_terminal.sdk import openbb +df = openbb.stocks.dd.pt(symbol="AAPL") +``` + +--- + + + + +Display analysts' price targets for a given stock. [Source: Business Insider] + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/stocks/due_diligence/business_insider_view.py#L32)] + +```python +openbb.stocks.dd.pt_chart(symbol: str, data: Optional[pd.DataFrame] = None, start_date: Optional[str] = None, limit: int = 10, raw: bool = False, export: str = "", external_axes: Optional[List[matplotlib.axes._axes.Axes]] = None) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| symbol | str | Due diligence ticker symbol | None | False | +| data | Optional[DataFrame] | Price target DataFrame | None | True | +| start_date | Optional[str] | Start date of the stock data, format YYYY-MM-DD | None | True | +| limit | int | Number of latest price targets from analysts to print | 10 | True | +| raw | bool | Display raw data only | False | True | +| export | str | Export dataframe data to csv,json,xlsx file | | True | +| external_axes | Optional[List[plt.Axes]] | External axes (1 axis is expected in the list), by default None | None | True | + + +--- + +## Returns + +This function does not return anything + +--- + +## Examples + +```python +from openbb_terminal.sdk import openbb +openbb.stocks.dd.pt_chart(symbol="AAPL") +``` + +--- + + + diff --git a/website/content/sdk/reference/stocks/dd/rating.md b/website/content/sdk/reference/stocks/dd/rating.md new file mode 100644 index 000000000000..e7898bd2bb43 --- /dev/null +++ b/website/content/sdk/reference/stocks/dd/rating.md @@ -0,0 +1,43 @@ +--- +title: rating +description: The page provides detailed information about the OpenBBTerminal's functionality + to fetch ratings for a given stock ticker using the Financial Modeling Prep source. + The code is written in Python and returns data in pd.DataFrame format. +keywords: +- Stock Ticker +- Ratings +- Financial Modeling Prep +- Source Code +- Stock Market +- Financial Data +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Get ratings for a given ticker. [Source: Financial Modeling Prep] + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/stocks/due_diligence/fmp_model.py#L17)] + +```python +openbb.stocks.dd.rating(symbol: str) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| symbol | str | Stock ticker symbol | None | False | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | Rating data | +--- diff --git a/website/content/sdk/reference/stocks/dd/rot.md b/website/content/sdk/reference/stocks/dd/rot.md new file mode 100644 index 000000000000..beab253006c2 --- /dev/null +++ b/website/content/sdk/reference/stocks/dd/rot.md @@ -0,0 +1,86 @@ +--- +title: rot +description: This webpage contains detailed methods and code snippets to retrieve + and visualize rating over time data for any stock ticker. It includes functioning + code in Python, and links to the source code in GitHub. +keywords: +- stock ratings +- Finnhub api +- data visualization +- open source +- stock market +- financial markets +- investment research +- due diligence +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + +Get rating over time data. [Source: Finnhub] + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/stocks/due_diligence/finnhub_model.py#L17)] + +```python +openbb.stocks.dd.rot(symbol: str) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| symbol | str | Ticker symbol to get ratings from | None | False | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | Get dataframe with ratings | +--- + + + + +Rating over time (monthly). [Source: Finnhub] + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/stocks/due_diligence/finnhub_view.py#L75)] + +```python +openbb.stocks.dd.rot_chart(symbol: str, limit: int = 10, raw: bool = False, export: str = "", external_axes: Optional[List[matplotlib.axes._axes.Axes]] = None) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| ticker | str | Ticker to get ratings from | None | True | +| limit | int | Number of last months ratings to show | 10 | True | +| raw | bool | Display raw data only | False | True | +| export | str | Export dataframe data to csv,json,xlsx file | | True | +| external_axes | Optional[List[plt.Axes]] | External axes (1 axis is expected in the list), by default None | None | True | + + +--- + +## Returns + +This function does not return anything + +--- + + + diff --git a/website/content/sdk/reference/stocks/dd/sec.md b/website/content/sdk/reference/stocks/dd/sec.md new file mode 100644 index 000000000000..d4647228ce70 --- /dev/null +++ b/website/content/sdk/reference/stocks/dd/sec.md @@ -0,0 +1,45 @@ +--- +title: sec +description: This page provides the source code and related information for using + OpenBB's SEC filings feature. Retrieve stock ticker information from platforms like + Market Watch. Written in Python, the feature returns SEC filings data in a pd.DataFrame + format. +keywords: +- SEC filings +- stock ticker +- Market Watch +- stocks +- due diligence +- marketwatch model +- symbol +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Get SEC filings for a given stock ticker. [Source: Market Watch] + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/stocks/due_diligence/marketwatch_model.py#L20)] + +```python +openbb.stocks.dd.sec(symbol: str) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| symbol | str | Stock ticker symbol | None | False | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | SEC filings data | +--- diff --git a/website/content/sdk/reference/stocks/dd/supplier.md b/website/content/sdk/reference/stocks/dd/supplier.md new file mode 100644 index 000000000000..382600e00275 --- /dev/null +++ b/website/content/sdk/reference/stocks/dd/supplier.md @@ -0,0 +1,49 @@ +--- +title: supplier +description: Detailed documentation on the supplier function of OpenBBTerminal. It + describes how to use the function to get suppliers using a certain ticker from CSIMarket, + the source code path, and the parameters involved. +keywords: +- supplier +- CSIMarket +- Source Code +- stocks +- due diligence +- csimarket model.py +- stocks.dd.supplier function +- symbol parameter +- limit parameter +- dataframe +- suppliers data +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Get suppliers from ticker provided. [Source: CSIMarket] + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/stocks/due_diligence/csimarket_model.py#L42)] + +```python +openbb.stocks.dd.supplier(symbol: str, limit: int = 50) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| symbol | str | Ticker to select suppliers from | None | False | +| limit | int | The maximum number of rows to show | 50 | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | A dataframe of suppliers | +--- diff --git a/website/content/sdk/reference/stocks/disc/active.md b/website/content/sdk/reference/stocks/disc/active.md new file mode 100644 index 000000000000..65a4eb744b59 --- /dev/null +++ b/website/content/sdk/reference/stocks/disc/active.md @@ -0,0 +1,44 @@ +--- +title: active +description: This page provides documentation for the 'active' function of the OpenBB + Finance API. The function returns the most active stocks in descending order based + on intraday trade volume. +keywords: +- OpenBB Finance API +- active function +- Stock trading +- Trading volume +- Most active stocks +- Finance +- API documentation +- Data Frame +- Yahoo Finance +- Intraday trading +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Get stocks ordered in descending order by intraday trade volume. [Source: Yahoo Finance] + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/stocks/discovery/yahoofinance_model.py#L97)] + +```python +openbb.stocks.disc.active() +``` + +--- + +## Parameters + +This function does not take any parameters. + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | Most active stocks | +--- diff --git a/website/content/sdk/reference/stocks/disc/arkord.md b/website/content/sdk/reference/stocks/disc/arkord.md new file mode 100644 index 000000000000..e3db4dbccb39 --- /dev/null +++ b/website/content/sdk/reference/stocks/disc/arkord.md @@ -0,0 +1,50 @@ +--- +title: arkord +description: This page contains details about the arkord function, which returns ARK + orders in a DataFrame. The function provides options to filter based on buys only, + sells only, or by a specific fund. This page also lists the various columns in the + returned DataFrame, which includes ticker, date, shares, weight, fund, and direction. +keywords: +- ARK +- Orders +- filter +- buys only +- sells only +- fund +- ARK orders data frame +- shares +- weight +- direction +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Returns ARK orders in a Dataframe + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/stocks/discovery/ark_model.py#L23)] + +```python +openbb.stocks.disc.arkord(buys_only: bool = False, sells_only: bool = False, fund: str = "") +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| buys_only | bool | Flag to filter on buys only | False | True | +| sells_only | bool | Flag to sort on sells only | False | True | +| fund | str | Optional filter by fund | | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| DataFrame | ARK orders data frame with the following columns -
(ticker, date, shares, weight, fund, direction) | +--- diff --git a/website/content/sdk/reference/stocks/disc/asc.md b/website/content/sdk/reference/stocks/disc/asc.md new file mode 100644 index 000000000000..1514db15d937 --- /dev/null +++ b/website/content/sdk/reference/stocks/disc/asc.md @@ -0,0 +1,39 @@ +--- +title: asc +description: Documentation for OpenBB's function to get the most aggressive small + cap stocks from Yahoo Finance with high earnings growth rates. Includes python code + and parameters description. +keywords: +- Yahoo Finance +- small cap stocks +- earnings growth rates +- stocks +- aggressive small cap stocks +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Get Yahoo Finance small cap stocks with earnings growth rates better than 25%. + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/stocks/discovery/yahoofinance_model.py#L138)] + +```python +openbb.stocks.disc.asc() +``` + +--- + +## Parameters + +This function does not take any parameters. + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | Most aggressive small cap stocks | +--- diff --git a/website/content/sdk/reference/stocks/disc/dividends.md b/website/content/sdk/reference/stocks/disc/dividends.md new file mode 100644 index 000000000000..c5e0e32fc1f1 --- /dev/null +++ b/website/content/sdk/reference/stocks/disc/dividends.md @@ -0,0 +1,41 @@ +--- +title: dividends +description: This page provides documentation on how to access the dividend calendar + for a given date using our OpenBB Terminal. The date represents the Ex-Dividend + Date. Users are guided on how to use it and understand the returned DataFrame. +keywords: +- dividends +- Ex-Dividend Date +- dividend calendar +- stock market +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Gets dividend calendar for given date. Date represents Ex-Dividend Date + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/stocks/discovery/nasdaq_model.py#L52)] + +```python +openbb.stocks.disc.dividends(date: str = None) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| date | datetime | Date to get for in format YYYY-MM-DD | None | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | Dataframe of dividend calendar | +--- diff --git a/website/content/sdk/reference/stocks/disc/fipo.md b/website/content/sdk/reference/stocks/disc/fipo.md new file mode 100644 index 000000000000..dc9b365a2b6d --- /dev/null +++ b/website/content/sdk/reference/stocks/disc/fipo.md @@ -0,0 +1,44 @@ +--- +title: fipo +description: The 'fipo' page provides information on the future IPOs dates using the + Finnhub source. It includes an OpenBB python method to retrieve upcoming IPO dates + within a specified number of days. The result is displayed as a DataFrame. +keywords: +- Future IPOs +- IPO dates +- Finnhub source +- Financial data +- Stocks discovery +- Fipo +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Future IPOs dates. [Source: Finnhub] + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/stocks/discovery/finnhub_model.py#L115)] + +```python +openbb.stocks.disc.fipo(num_days_ahead: int = 5, end_date: Optional[str] = None) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| num_days_ahead | int | Number of days to look ahead for IPOs dates | 5 | True | +| end_date | datetime | The end date (format YYYY-MM-DD) to look for IPOs from today onwards | None | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | Get dataframe with future IPOs | +--- diff --git a/website/content/sdk/reference/stocks/disc/gainers.md b/website/content/sdk/reference/stocks/disc/gainers.md new file mode 100644 index 000000000000..70bb86782382 --- /dev/null +++ b/website/content/sdk/reference/stocks/disc/gainers.md @@ -0,0 +1,39 @@ +--- +title: gainers +description: This page provides information on how to use OpenBB Terminal Python source + code to get the top stock gainers from Yahoo Finance. It returns the data in a Pandas + DataFrame. +keywords: +- Top gainers +- Stocks +- Yahoo Finance +- Source Code +- Stock Market +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Get top gainers. [Source: Yahoo Finance] + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/stocks/discovery/yahoofinance_model.py#L16)] + +```python +openbb.stocks.disc.gainers() +``` + +--- + +## Parameters + +This function does not take any parameters. + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | Stock Gainers | +--- diff --git a/website/content/sdk/reference/stocks/disc/gtech.md b/website/content/sdk/reference/stocks/disc/gtech.md new file mode 100644 index 000000000000..a4ff33edd1cb --- /dev/null +++ b/website/content/sdk/reference/stocks/disc/gtech.md @@ -0,0 +1,41 @@ +--- +title: gtech +description: Gtech is a function used to get technology stocks with revenue and earnings + growth exceeding 25%. The page provides source code and details about parameters + and returns. +keywords: +- gtech +- technology stocks +- revenue growth +- earnings growth +- Yahoo Finance +- stocks discovery +- python code +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Get technology stocks with revenue and earnings growth in excess of 25%. [Source: Yahoo Finance] + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/stocks/discovery/yahoofinance_model.py#L76)] + +```python +openbb.stocks.disc.gtech() +``` + +--- + +## Parameters + +This function does not take any parameters. + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | Growth technology stocks | +--- diff --git a/website/content/sdk/reference/stocks/disc/hotpenny.md b/website/content/sdk/reference/stocks/disc/hotpenny.md new file mode 100644 index 000000000000..639bfcc301b8 --- /dev/null +++ b/website/content/sdk/reference/stocks/disc/hotpenny.md @@ -0,0 +1,38 @@ +--- +title: hotpenny +description: 'The page provides documentation on how to use the hotpenny function + provided by OpenBB, which returns a DataFrame of today''s hot penny stocks with + different columns such as Ticker, Price, Change, $ Volume, Volume, # Trades.' +keywords: +- hot penny stocks +- stocks DataFrame +- stock trading +- financial data +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Returns today hot penny stocks + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/stocks/discovery/shortinterest_model.py#L38)] + +```python +openbb.stocks.disc.hotpenny() +``` + +--- + +## Parameters + +This function does not take any parameters. + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| DataFrame | Today hot penny stocks DataFrame with the following columns:
Ticker, Price, Change, $ Volume, Volume, # Trades | +--- diff --git a/website/content/sdk/reference/stocks/disc/ipo.md b/website/content/sdk/reference/stocks/disc/ipo.md new file mode 100644 index 000000000000..cc17492285ce --- /dev/null +++ b/website/content/sdk/reference/stocks/disc/ipo.md @@ -0,0 +1,41 @@ +--- +title: ipo +description: Navigate through the IPO calendar using OpenBB's Python toolkit. The + page provides source code and parameters for IPO through start and end dates, returning + all events in a convenient pd.DataFrame format. +keywords: +- IPO +- IPO calendar +- Source code +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Get IPO calendar + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/stocks/discovery/finnhub_model.py#L16)] + +```python +openbb.stocks.disc.ipo(start_date: Optional[str] = None, end_date: Optional[str] = None) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| start_date | Optional[str] | Initial date, format YYYY-MM-DD | None | True | +| end_date | Optional[str] | Final date, format YYYY-MM-DD | None | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | Get dataframe with IPO calendar events | +--- diff --git a/website/content/sdk/reference/stocks/disc/losers.md b/website/content/sdk/reference/stocks/disc/losers.md new file mode 100644 index 000000000000..a6dd11091b28 --- /dev/null +++ b/website/content/sdk/reference/stocks/disc/losers.md @@ -0,0 +1,43 @@ +--- +title: losers +description: This page provides information on how to get the top stock market losers + using the 'losers' function with OpenBB and Yahoo Finance. This function does not + require parameters and returns a pandas dataframe of stock losers. +keywords: +- losers +- top losers +- Yahoo Finance +- Source Code +- stocks +- discovery +- stock market +- yahoofinance_model.py +- Stock Losers +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Get top losers. [Source: Yahoo Finance] + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/stocks/discovery/yahoofinance_model.py#L35)] + +```python +openbb.stocks.disc.losers() +``` + +--- + +## Parameters + +This function does not take any parameters. + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | Stock Losers | +--- diff --git a/website/content/sdk/reference/stocks/disc/lowfloat.md b/website/content/sdk/reference/stocks/disc/lowfloat.md new file mode 100644 index 000000000000..52a31154f089 --- /dev/null +++ b/website/content/sdk/reference/stocks/disc/lowfloat.md @@ -0,0 +1,42 @@ +--- +title: lowfloat +description: This page explains the lowfloat function from the openbb.stocks.disc + Python library that returns a low float DataFrame. It provides details of the input + parameters and return types. +keywords: +- lowfloat +- openbb.stocks.disc +- ShortInt +- Float +- Outstd +- Industry +- Stocks +- Exchange +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Returns low float DataFrame + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/stocks/discovery/shortinterest_model.py#L15)] + +```python +openbb.stocks.disc.lowfloat() +``` + +--- + +## Parameters + +This function does not take any parameters. + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| DataFrame | Low float DataFrame with the following columns:
Ticker, Company, Exchange, ShortInt, Float, Outstd, Industry | +--- diff --git a/website/content/sdk/reference/stocks/disc/news.md b/website/content/sdk/reference/stocks/disc/news.md new file mode 100644 index 000000000000..bbac8852f7aa --- /dev/null +++ b/website/content/sdk/reference/stocks/disc/news.md @@ -0,0 +1,44 @@ +--- +title: news +description: This page provides information on the documentation for the 'news' functionality + in OpenBBTerminal. It enables users to customize their news type and limit the number + of news to be displayed. +keywords: +- OpenBBTerminal documentation +- Customize News +- News types +- Limit News Display +- Stock News +- Python code for news customization +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Gets news. [Source: SeekingAlpha] + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/stocks/discovery/seeking_alpha_model.py#L199)] + +```python +openbb.stocks.disc.news(news_type: str = "Top-News", limit: int = 5) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| news_type | str | From: Top-News, On-The-Move, Market-Pulse, Notable-Calls, Buybacks, Commodities, Crypto, Issuance, Global,
Guidance, IPOs, SPACs, Politics, M-A, Consumer, Energy, Financials, Healthcare, MLPs, REITs, Technology | Top-News | True | +| limit | int | Number of news to display | 5 | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| List[dict] | List of dict news | +--- diff --git a/website/content/sdk/reference/stocks/disc/pipo.md b/website/content/sdk/reference/stocks/disc/pipo.md new file mode 100644 index 000000000000..1a870b082a5f --- /dev/null +++ b/website/content/sdk/reference/stocks/disc/pipo.md @@ -0,0 +1,45 @@ +--- +title: pipo +description: This page provides information about the 'pipo' open source code which + is used to find Past IPO dates. It includes details about the parameters used and + the output provided by the code. +keywords: +- pipo +- past IPO dates +- open source code +- Finnhub +- dataframe +- num_days_behind +- start_date +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Past IPOs dates. [Source: Finnhub] + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/stocks/discovery/finnhub_model.py#L74)] + +```python +openbb.stocks.disc.pipo(num_days_behind: int = 5, start_date: Optional[str] = None) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| num_days_behind | int | Number of days to look behind for IPOs dates | 5 | True | +| start_date | str | The starting date (format YYYY-MM-DD) to look for IPOs | None | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | Get dataframe with past IPOs | +--- diff --git a/website/content/sdk/reference/stocks/disc/rtat.md b/website/content/sdk/reference/stocks/disc/rtat.md new file mode 100644 index 000000000000..6fdc0d261c08 --- /dev/null +++ b/website/content/sdk/reference/stocks/disc/rtat.md @@ -0,0 +1,40 @@ +--- +title: rtat +description: The rtat function provides the top 10 retail stocks per day functionality. + It does not take any parameters and returns a DataFrame with tickers. +keywords: +- Retail Stocks +- rtat function +- top 10 stocks +- Stock Tickers +- Dataframe of tickers +- Stock Discovery +- No parameters function +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Gets the top 10 retail stocks per day + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/stocks/discovery/nasdaq_model.py#L20)] + +```python +openbb.stocks.disc.rtat() +``` + +--- + +## Parameters + +This function does not take any parameters. + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | Dataframe of tickers | +--- diff --git a/website/content/sdk/reference/stocks/disc/trending.md b/website/content/sdk/reference/stocks/disc/trending.md new file mode 100644 index 000000000000..b4716b94d33e --- /dev/null +++ b/website/content/sdk/reference/stocks/disc/trending.md @@ -0,0 +1,41 @@ +--- +title: trending +description: The Trending page provides a list of trending articles from OpenBB, it + allows customization of the quantity of articles displayed with a default value + set at 5. +keywords: +- Trending articles +- Source code +- Stocks discovery +- Article limit customization +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Returns a list of trending articles + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/stocks/discovery/seeking_alpha_model.py#L100)] + +```python +openbb.stocks.disc.trending(limit: int = 5) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| limit | int | Number of articles | 5 | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| list | Trending articles list | +--- diff --git a/website/content/sdk/reference/stocks/disc/ugs.md b/website/content/sdk/reference/stocks/disc/ugs.md new file mode 100644 index 000000000000..fdb6ae7e2ef0 --- /dev/null +++ b/website/content/sdk/reference/stocks/disc/ugs.md @@ -0,0 +1,41 @@ +--- +title: ugs +description: This page details the UGS function, which identifies stocks with excellent + earnings growth rates and relatively low PE and PEG ratios, thus helping to discover + undervalued stocks. Source code is also provided. +keywords: +- ugs function +- stock discovery +- earnings growth rate +- PE ratio +- PEG ratio +- undervalued stocks +- yahoofinance model +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Get stocks with earnings growth rates better than 25% and relatively low PE and PEG ratios. + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/stocks/discovery/yahoofinance_model.py#L54)] + +```python +openbb.stocks.disc.ugs() +``` + +--- + +## Parameters + +This function does not take any parameters. + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | Undervalued stocks | +--- diff --git a/website/content/sdk/reference/stocks/disc/ulc.md b/website/content/sdk/reference/stocks/disc/ulc.md new file mode 100644 index 000000000000..b444df136370 --- /dev/null +++ b/website/content/sdk/reference/stocks/disc/ulc.md @@ -0,0 +1,39 @@ +--- +title: ulc +description: This page provides information on the 'ulc' function which is used to + retrieve potentially undervalued large cap stocks from Yahoo Finance through the + OpenBB platform. No parameters are needed for this function. It returns the most + undervalued large cap stocks in a pd.DataFrame format. +keywords: +- ulc +- Yahoo Finance +- undervalued large cap stocks +- stocks +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Get Yahoo Finance potentially undervalued large cap stocks. + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/stocks/discovery/yahoofinance_model.py#L116)] + +```python +openbb.stocks.disc.ulc() +``` + +--- + +## Parameters + +This function does not take any parameters. + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | Most undervalued large cap stocks | +--- diff --git a/website/content/sdk/reference/stocks/disc/upcoming.md b/website/content/sdk/reference/stocks/disc/upcoming.md new file mode 100644 index 000000000000..6bd425dd0231 --- /dev/null +++ b/website/content/sdk/reference/stocks/disc/upcoming.md @@ -0,0 +1,41 @@ +--- +title: upcoming +description: This documentation page is related to the upcoming() function in OpenBB's + stocks discovery module which returns a DataFrame containing upcoming earnings. + The page includes source code, function parameters, and return types. +keywords: +- OpenBB.stocks.disc.upcoming +- Upcoming earnings +- Source Code +- Number of pages +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Returns a DataFrame with upcoming earnings + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/stocks/discovery/seeking_alpha_model.py#L41)] + +```python +openbb.stocks.disc.upcoming(limit: int = 10) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| limit | int | Number of pages | 10 | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| DataFrame | Upcoming earnings DataFrame | +--- diff --git a/website/content/sdk/reference/stocks/dps/ctb.md b/website/content/sdk/reference/stocks/dps/ctb.md new file mode 100644 index 000000000000..96b0c555a723 --- /dev/null +++ b/website/content/sdk/reference/stocks/dps/ctb.md @@ -0,0 +1,42 @@ +--- +title: ctb +description: The page provides information about the function that returns the cost + to borrow of stocks using Interactive Broker. The source code of the function is + available. No parameters are needed for the function. +keywords: +- stocks +- cost to borrow +- Interactive Broker +- Source Code +- openbb.stocks.dps.ctb() +- Parameters +- Return type +- OpenBB-finance +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Get stocks with highest cost to borrow [Source: Interactive Broker] + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/stocks/dark_pool_shorts/ibkr_model.py#L16)] + +```python +openbb.stocks.dps.ctb() +``` + +--- + +## Parameters + +This function does not take any parameters. + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | Cost to borrow | +--- diff --git a/website/content/sdk/reference/stocks/dps/dpotc.md b/website/content/sdk/reference/stocks/dps/dpotc.md new file mode 100644 index 000000000000..34c81079dda8 --- /dev/null +++ b/website/content/sdk/reference/stocks/dps/dpotc.md @@ -0,0 +1,84 @@ +--- +title: dpotc +description: Documentation for dpotc and dpotc_chart, functions in the OpenBB Finance + library for retrieving and visualizing Dark Pools (ATS) and OTC (Non-ATS) data from + FINRA. Includes parameters and source code. +keywords: +- dpotc +- FINRA data +- Dark Pools (ATS) Data +- OTC (Non-ATS) Data +- dpotc_chart +- barchart +- matplotlib +- Export dataframe data +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + +Get all FINRA data associated with a ticker + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/stocks/dark_pool_shorts/finra_model.py#L293)] + +```python +openbb.stocks.dps.dpotc(symbol: str) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| symbol | str | Stock ticker to get data from | None | False | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| Tuple[pd.DataFrame, pd.DataFrame] | Dark Pools (ATS) Data, OTC (Non-ATS) Data | +--- + + + + +Display barchart of dark pool (ATS) and OTC (Non ATS) data. [Source: FINRA] + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/stocks/dark_pool_shorts/finra_view.py#L27)] + +```python +openbb.stocks.dps.dpotc_chart(symbol: str, export: str = "", external_axes: Optional[List[matplotlib.axes._axes.Axes]] = None) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| symbol | str | Stock ticker | None | False | +| export | str | Export dataframe data to csv,json,xlsx file | | True | +| external_axes | Optional[List[plt.Axes]] | External axes (2 axes are expected in the list), by default None | None | True | + + +--- + +## Returns + +This function does not return anything + +--- + + + diff --git a/website/content/sdk/reference/stocks/dps/ftd.md b/website/content/sdk/reference/stocks/dps/ftd.md new file mode 100644 index 000000000000..8904a671fa73 --- /dev/null +++ b/website/content/sdk/reference/stocks/dps/ftd.md @@ -0,0 +1,88 @@ +--- +title: ftd +description: Documentation related to 'ftd'- a feature that provides fails-to-deliver + data for a given ticker. Offers a model and chart view +keywords: +- ftd +- fails-to-deliver +- stock data +- chart view +- model view +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + +Display fails-to-deliver data for a given ticker. [Source: SEC] + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/stocks/dark_pool_shorts/sec_model.py#L60)] + +```python +openbb.stocks.dps.ftd(symbol: str, start_date: Optional[str] = None, end_date: Optional[str] = None, limit: int = 0) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| symbol | str | Stock ticker | None | False | +| start_date | Optional[str] | Start of data, in YYYY-MM-DD format | None | True | +| end_date | Optional[str] | End of data, in YYYY-MM-DD format | None | True | +| limit | int | Number of latest fails-to-deliver being printed | 0 | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | Fail to deliver data | +--- + + + + +Display fails-to-deliver data for a given ticker. [Source: SEC] + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/stocks/dark_pool_shorts/sec_view.py#L28)] + +```python +openbb.stocks.dps.ftd_chart(symbol: str, data: pd.DataFrame = None, start_date: Optional[str] = None, end_date: Optional[str] = None, limit: int = 0, raw: bool = False, export: str = "", external_axes: Optional[List[matplotlib.axes._axes.Axes]] = None) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| symbol | str | Stock ticker | None | False | +| data | pd.DataFrame | Stock data | None | True | +| start_date | Optional[str] | Start of data, in YYYY-MM-DD format | None | True | +| end_date | Optional[str] | End of data, in YYYY-MM-DD format | None | True | +| limit | int | Number of latest fails-to-deliver being printed | 0 | True | +| raw | bool | Print raw data | False | True | +| export | str | Export dataframe data to csv,json,xlsx file | | True | +| external_axes | Optional[List[plt.Axes]] | External axes (2 axes are expected in the list), by default None | None | True | + + +--- + +## Returns + +This function does not return anything + +--- + + + diff --git a/website/content/sdk/reference/stocks/dps/hsi.md b/website/content/sdk/reference/stocks/dps/hsi.md new file mode 100644 index 000000000000..f0c343cebd02 --- /dev/null +++ b/website/content/sdk/reference/stocks/dps/hsi.md @@ -0,0 +1,47 @@ +--- +title: hsi +description: 'The hsi function returns a high short interest DataFrame. This OpenBB + finance function doesn''t require any parameters and provides key financial data + including: Ticker, Company, Exchange, ShortInt, Float, Outstd, and Industry. Ideal + for those interested in dark pool shorts and stock market data.' +keywords: +- hsi +- high short interest DataFrame +- OpenBB finance +- short interest +- dataframe +- dark pool shorts +- stock market +- financial data +- exchange +- company +- outstd +- industry +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Returns a high short interest DataFrame + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/stocks/dark_pool_shorts/shortinterest_model.py#L18)] + +```python +openbb.stocks.dps.hsi() +``` + +--- + +## Parameters + +This function does not take any parameters. + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| DataFrame | High short interest Dataframe with the following columns:
Ticker, Company, Exchange, ShortInt, Float, Outstd, Industry | +--- diff --git a/website/content/sdk/reference/stocks/dps/pos.md b/website/content/sdk/reference/stocks/dps/pos.md new file mode 100644 index 000000000000..2ba9e33b9d22 --- /dev/null +++ b/website/content/sdk/reference/stocks/dps/pos.md @@ -0,0 +1,46 @@ +--- +title: pos +description: This documentation page is about getting dark pool short positions using + the 'pos' function in the openbb.stocks.dps python package. Details about parameters + such as 'sortby' and 'ascend', and the data returned, i.e., pd.DataFrame, are provided. +keywords: +- pos +- dark pool short positions +- Stockgrid +- coding +- openbb.stocks.dps.pos +- parameters +- returns +- Data in ascending order +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Get dark pool short positions. [Source: Stockgrid] + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/stocks/dark_pool_shorts/stockgrid_model.py#L18)] + +```python +openbb.stocks.dps.pos(sortby: str = "dpp_dollar", ascend: bool = False) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| sortby | str | Field for which to sort by, where 'sv': Short Vol. [1M],
'sv_pct': Short Vol. %%, 'nsv': Net Short Vol. [1M],
'nsv_dollar': Net Short Vol. ($100M), 'dpp': DP Position [1M],
'dpp_dollar': DP Position ($1B) | dpp_dollar | True | +| ascend | bool | Data in ascending order | False | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | Dark pool short position data | +--- diff --git a/website/content/sdk/reference/stocks/dps/prom.md b/website/content/sdk/reference/stocks/dps/prom.md new file mode 100644 index 000000000000..2218e49901e0 --- /dev/null +++ b/website/content/sdk/reference/stocks/dps/prom.md @@ -0,0 +1,88 @@ +--- +title: prom +description: 'This page provides a detailed explanation of two important functions + in FINRA ATS data analysis offered by our tool: ''prom'' and ''Chart''. ''prom'' + fetches and processes the most promising stocks based on linear regression while + ''Chart'' aids in visualizing the dark pool data for improving trading decisions.' +keywords: +- FINRA ATS data +- Trading tool +- Linear regression +- Dark pool data +- Dark pool trades activity +- Stocks analysis +- Data visualization +- Promising stocks +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + +Get all FINRA ATS data, and parse most promising tickers based on linear regression + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/stocks/dark_pool_shorts/finra_model.py#L214)] + +```python +openbb.stocks.dps.prom(limit: int = 1000, tier_ats: str = "T1") +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| limit | int | Number of tickers to filter from entire ATS data based on the sum of the total weekly shares quantity | 1000 | True | +| tier_ats | int | Tier to process data from: T1, T2 or OTCE | T1 | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| Tuple[pd.DataFrame, Dict] | Dark Pools (ATS) Data, Tickers from Dark Pools with better regression slope | +--- + + + + +Display dark pool (ATS) data of tickers with growing trades activity. [Source: FINRA] + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/stocks/dark_pool_shorts/finra_view.py#L188)] + +```python +openbb.stocks.dps.prom_chart(input_limit: int = 1000, limit: int = 10, tier: str = "T1", export: str = "", external_axes: Optional[List[matplotlib.axes._axes.Axes]] = None) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| input_limit | int | Number of tickers to filter from entire ATS data based on
the sum of the total weekly shares quantity | 1000 | True | +| limit | int | Number of tickers to display from most promising with
better linear regression slope | 10 | True | +| tier | str | Tier to process data from: T1, T2 or OTCE | T1 | True | +| export | str | Export dataframe data to csv,json,xlsx file | | True | +| external_axes | Optional[List[plt.Axes]] | External axes (1 axis is expected in the list), by default None | None | True | + + +--- + +## Returns + +This function does not return anything + +--- + + + diff --git a/website/versioned_docs/version-v3/sdk/reference/stocks/dps/psi_q.md b/website/content/sdk/reference/stocks/dps/psi_q.md similarity index 80% rename from website/versioned_docs/version-v3/sdk/reference/stocks/dps/psi_q.md rename to website/content/sdk/reference/stocks/dps/psi_q.md index 81dcce09c527..460fcd9cb715 100644 --- a/website/versioned_docs/version-v3/sdk/reference/stocks/dps/psi_q.md +++ b/website/content/sdk/reference/stocks/dps/psi_q.md @@ -1,13 +1,28 @@ --- title: psi_q -description: OpenBB SDK Function +description: The psi_q documentation page explains the usage of the psi_q function, + which plots the short interest of a stock. It contains the source code, code snippets, + parameters, and return types of the function. +keywords: +- psi_q +- short interest +- stock +- plot +- code +- function +- parameters +- returns +- NYSE +- NASDAQ --- +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; -# psi_q - @@ -38,8 +53,6 @@ openbb.stocks.dps.psi_q(symbol: str, nyse: bool = False) | pd.DataFrame | short interest volume data | --- - - @@ -73,7 +86,5 @@ This function does not return anything --- - - - \ No newline at end of file + diff --git a/website/versioned_docs/version-v3/sdk/reference/stocks/dps/psi_sg.md b/website/content/sdk/reference/stocks/dps/psi_sg.md similarity index 75% rename from website/versioned_docs/version-v3/sdk/reference/stocks/dps/psi_sg.md rename to website/content/sdk/reference/stocks/dps/psi_sg.md index 31810c1fe83c..98d3165478e8 100644 --- a/website/versioned_docs/version-v3/sdk/reference/stocks/dps/psi_sg.md +++ b/website/content/sdk/reference/stocks/dps/psi_sg.md @@ -1,13 +1,28 @@ --- title: psi_sg -description: OpenBB SDK Function +description: The psi_sg page provides Python code snippets for retrieving short interest + volume data and stock prices. Also available is the functionality to plot this data + or export it in various file formats. The data is sourced from Stockgrid. +keywords: +- psi_sg +- Docusaurus +- Short interest volume +- Stock data +- Stockgrid +- Python code +- Data visualization +- Data export +- Market days +- Raw data --- +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; -# psi_sg - @@ -37,8 +52,6 @@ openbb.stocks.dps.psi_sg(symbol: str) | Tuple[pd.DataFrame, List] | Short interest volume data, Price data | --- - - @@ -71,7 +84,5 @@ This function does not return anything --- - - - \ No newline at end of file + diff --git a/website/content/sdk/reference/stocks/dps/shorted.md b/website/content/sdk/reference/stocks/dps/shorted.md new file mode 100644 index 000000000000..723867af2493 --- /dev/null +++ b/website/content/sdk/reference/stocks/dps/shorted.md @@ -0,0 +1,41 @@ +--- +title: shorted +description: The page provides details about the 'shorted' function of OpenBBTerminal + which shows the most shorted stocks according to Yahoo Finance. Details include + the source code and parameters, if any. +keywords: +- shorted +- stock screener +- Yahoo Finance +- OpenBB finance +- stocks +- dark pool shorts +- yahoofinance model +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Get most shorted stock screener [Source: Yahoo Finance] + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/stocks/dark_pool_shorts/yahoofinance_model.py#L16)] + +```python +openbb.stocks.dps.shorted() +``` + +--- + +## Parameters + +This function does not take any parameters. + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | Most Shorted Stocks | +--- diff --git a/website/content/sdk/reference/stocks/dps/sidtc.md b/website/content/sdk/reference/stocks/dps/sidtc.md new file mode 100644 index 000000000000..58dc5374f1e6 --- /dev/null +++ b/website/content/sdk/reference/stocks/dps/sidtc.md @@ -0,0 +1,43 @@ +--- +title: sidtc +description: Documentation for sidtc, a tool command that retrieves and sorts short + interest and days-to-cover data. +keywords: +- sidtc +- short interest +- days-to-cover +- stockgrid +- OpenBB-finance +- stock data +- floating short +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Get short interest and days to cover. [Source: Stockgrid] + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/stocks/dark_pool_shorts/stockgrid_model.py#L76)] + +```python +openbb.stocks.dps.sidtc(sortby: str = "float") +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| sortby | str | Field for which to sort by, where 'float': Float Short %%,
'dtc': Days to Cover, 'si': Short Interest | float | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | Short interest and days to cover data | +--- diff --git a/website/content/sdk/reference/stocks/dps/spos.md b/website/content/sdk/reference/stocks/dps/spos.md new file mode 100644 index 000000000000..b90fec67615d --- /dev/null +++ b/website/content/sdk/reference/stocks/dps/spos.md @@ -0,0 +1,88 @@ +--- +title: spos +description: This documentation page provides a detailed guide on spos function under + the OpenBB package. Learn how to get net short position and plot net short position + with source codes and parameters clearly listed. +keywords: +- spos +- net short position +- plotting +- Source Code +- parameters +- chart +- Stockgrid +- Stock data +- Data Visualization +- Data Export +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + +Get net short position. [Source: Stockgrid] + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/stocks/dark_pool_shorts/stockgrid_model.py#L165)] + +```python +openbb.stocks.dps.spos(symbol: str) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| symbol | str | Stock to get data from | None | False | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | Net short position | +--- + + + + +Plot net short position. [Source: Stockgrid] + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/stocks/dark_pool_shorts/stockgrid_view.py#L247)] + +```python +openbb.stocks.dps.spos_chart(symbol: str, limit: int = 84, raw: bool = False, export: str = "", external_axes: Optional[List[matplotlib.axes._axes.Axes]] = None) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| symbol | str | Stock to plot for | None | False | +| limit | int | Number of last open market days to show | 84 | True | +| raw | bool | Flag to print raw data instead | False | True | +| export | str | Export dataframe data to csv,json,xlsx file | | True | +| external_axes | Optional[List[plt.Axes]] | External axes (2 axes are expected in the list), by default None | None | True | + + +--- + +## Returns + +This function does not return anything + +--- + + + diff --git a/website/content/sdk/reference/stocks/fa/analysis.md b/website/content/sdk/reference/stocks/fa/analysis.md new file mode 100644 index 000000000000..6da568ecfe01 --- /dev/null +++ b/website/content/sdk/reference/stocks/fa/analysis.md @@ -0,0 +1,44 @@ +--- +title: analysis +description: Documentation on OpenBB Terminal's feature for SEC filings analysis using + machine learning. The page contains information on how to perform the analysis, + parameters required, and default values. +keywords: +- SEC filings analysis +- Machine learning +- Stocks +- Fundamental analysis +- Ticker symbol +- Eclect.us +- Source code +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Save time reading SEC filings with the help of machine learning. [Source: https://eclect.us] + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/stocks/fundamental_analysis/eclect_us_model.py#L18)] + +```python +openbb.stocks.fa.analysis(symbol: str) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| symbol | str | Ticker symbol to see analysis of filings | None | False | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| str | Analysis of filings text | +--- diff --git a/website/content/sdk/reference/stocks/fa/balance.md b/website/content/sdk/reference/stocks/fa/balance.md new file mode 100644 index 000000000000..1a1355defdae --- /dev/null +++ b/website/content/sdk/reference/stocks/fa/balance.md @@ -0,0 +1,64 @@ +--- +title: balance +description: This page provides detailed information for retrieving balance sheet + data via the OpenBBTerminal's Python function. This includes the parameters and + return type of the function, as well as examples of its use for different data sources + specifically for the stock symbol 'AAPL'. +keywords: +- balance sheet +- financial data +- YahooFinance +- AlphaVantage +- stock symbol +- AAPL +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Get balance sheet. + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/stocks/fundamental_analysis/sdk_helpers.py#L77)] + +```python +openbb.stocks.fa.balance(symbol: str, quarterly: bool = False, ratios: bool = False, source: str = "YahooFinance", limit: int = 10) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| symbol | str | Symbol to get balance sheet for | None | False | +| source | str | Data source for balance sheet, by default "YahooFinance" | YahooFinance | True | +| quarterly | bool | Flag to get quarterly data | False | True | +| ratios | bool | Flag to return data as a percent change. | False | True | +| limit | int | Number of statements to return (free tiers may be limited to 5 years) | 10 | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | Dataframe of balance sheet | +--- + +## Examples + +```python +from openbb_terminal.sdk import openbb +balance_sheet = openbb.stocks.fa.balance("AAPL", source="YahooFinance) +``` + +``` +If you have a premium AlphaVantage key, you can use the quarterly flag to get quarterly statements +``` +```python +quarterly_income_statement = openbb.stocks.fa.balance("AAPL", source="AlphaVantage", quarterly=True) +``` + +--- diff --git a/website/content/sdk/reference/stocks/fa/cal.md b/website/content/sdk/reference/stocks/fa/cal.md new file mode 100644 index 000000000000..0a8e9bd81b02 --- /dev/null +++ b/website/content/sdk/reference/stocks/fa/cal.md @@ -0,0 +1,42 @@ +--- +title: cal +description: This page provides a python function for fetching calendar earnings of + a specific stock ticker symbol using the OpenBB Terminal library. The function returns + a pandas dataframe with the earnings data. +keywords: +- calendar earnings +- ticker symbol +- openbb.stocks.fa.cal() +- stock fundamental analysis +- Python finance library +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Get calendar earnings for ticker symbol + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/stocks/fundamental_analysis/yahoo_finance_model.py#L179)] + +```python +openbb.stocks.fa.cal(symbol: str) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| symbol | str | Stock ticker symbol | None | False | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | Dataframe of calendar earnings | +--- diff --git a/website/content/sdk/reference/stocks/fa/cash.md b/website/content/sdk/reference/stocks/fa/cash.md new file mode 100644 index 000000000000..722136ed6b18 --- /dev/null +++ b/website/content/sdk/reference/stocks/fa/cash.md @@ -0,0 +1,64 @@ +--- +title: cash +description: Improve financial analysis with OpenBB's Cash Flow feature. Retrieve + historical cash flow data for any stock symbol using various sources like YahooFinance + with options to get quarterly data and data as a percentage change. +keywords: +- Cash Flow +- Financial Analysis +- Stock Symbol +- YahooFinance +- AlphaVantage +- ' quarterly data' +- percentage change +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Get Cash Flow. + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/stocks/fundamental_analysis/sdk_helpers.py#L140)] + +```python +openbb.stocks.fa.cash(symbol: str, quarterly: bool = False, ratios: bool = False, source: str = "YahooFinance", limit: int = 10) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| symbol | str | Symbol to get cash flow for | None | False | +| source | str | Data source for cash flow, by default "YahooFinance" | YahooFinance | True | +| quarterly | bool | Flag to get quarterly data | False | True | +| ratios | bool | Flag to return data as a percent change. | False | True | +| limit | int | Number of statements to return (free tiers may be limited to 5 years) | 10 | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | Dataframe of cash flow | +--- + +## Examples + +```python +from openbb_terminal.sdk import openbb +cash_flow = openbb.stocks.fa.cash("AAPL", source="YahooFinance) +``` + +``` +If you have a premium AlphaVantage key, you can use the quarterly flag to get quarterly statements +``` +```python +quarterly_income_statement = openbb.stocks.fa.cash("AAPL", source="AlphaVantage", quarterly=True) +``` + +--- diff --git a/website/content/sdk/reference/stocks/fa/data.md b/website/content/sdk/reference/stocks/fa/data.md new file mode 100644 index 000000000000..2543bdcdf7fa --- /dev/null +++ b/website/content/sdk/reference/stocks/fa/data.md @@ -0,0 +1,53 @@ +--- +title: data +description: Detailed instruction on how to get fundamental data from finviz using + 'openbb' Python package. It explains the usage of 'stocks.fa.data' function, its + parameters and return type along with an example. +keywords: +- fundamental data +- finviz +- stock ticker symbol +- dataframe +- openbb_terminal +- sdk +- IWV +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Get fundamental data from finviz + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/stocks/fundamental_analysis/finviz_model.py#L15)] + +```python +openbb.stocks.fa.data(symbol: str) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| symbol | str | Stock ticker symbol | None | False | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | DataFrame of fundamental data | +--- + +## Examples + +```python +from openbb_terminal.sdk import openbb +openbb.stocks.fa.data("IWV") +``` + +--- diff --git a/website/content/sdk/reference/stocks/fa/dcf.md b/website/content/sdk/reference/stocks/fa/dcf.md new file mode 100644 index 000000000000..d9d9b2bbe656 --- /dev/null +++ b/website/content/sdk/reference/stocks/fa/dcf.md @@ -0,0 +1,51 @@ +--- +title: dcf +description: This page covers how to use the 'dcf' function from FMP for stocks analysis + with the OpenBB tool. It indicates the parameters required and returns a dataframe + of dcf data. +keywords: +- dcf +- stocks +- FMP +- fundamental analysis +- fmp model +- parameters +- returns +- stock ticker symbol +- limit +- quarterly +- dataframe +- dcf data +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Get stocks dcf from FMP + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/stocks/fundamental_analysis/fmp_model.py#L173)] + +```python +openbb.stocks.fa.dcf(symbol: str, limit: int = 5, quarterly: bool = False) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| symbol | str | Stock ticker symbol | None | False | +| limit | int | Number to get | 5 | True | +| quarterly | bool | Flag to get quarterly data, by default False | False | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | Dataframe of dcf data | +--- diff --git a/website/content/sdk/reference/stocks/fa/divs.md b/website/content/sdk/reference/stocks/fa/divs.md new file mode 100644 index 000000000000..ed6ecc78fe9b --- /dev/null +++ b/website/content/sdk/reference/stocks/fa/divs.md @@ -0,0 +1,109 @@ +--- +title: divs +description: Improve your knowledge of OpenBB's fundamental analysis tools for stocks + with this comprehensive guide on retrieving and charting historical dividend data. + This page contains examples and source code in python focused on the use of the + 'divs' and 'divs_chart' functions for tickers like 'AAPL'. +keywords: +- docusaurus +- metadata +- dividends chart +- fundamental analysis +- historical data +- ticker symbol +- dividend history +- stocks +- AAPL +- matplotlib +- pandas DataFrame +- openbb_terminal.sdk +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + +Get historical dividend for ticker + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/stocks/fundamental_analysis/yahoo_finance_model.py#L256)] + +```python +openbb.stocks.fa.divs(symbol: str) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| symbol | str | Ticker symbol to get dividend for | None | False | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | Dataframe of dividends and dates | +--- + +## Examples + +```python +from openbb_terminal.sdk import openbb +openbb.fa.divs("AAPL") +``` + +--- + + + + +Display historical dividends + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/stocks/fundamental_analysis/yahoo_finance_view.py#L185)] + +```python +openbb.stocks.fa.divs_chart(symbol: str, limit: int = 12, plot: bool = True, export: str = "", external_axes: Optional[List[matplotlib.axes._axes.Axes]] = None) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| symbol | str | Stock ticker symbol | None | False | +| limit | int | Number to show | 12 | True | +| plot | bool | Plots historical data | True | True | +| export | str | Format to export data | | True | +| external_axes | Optional[List[plt.Axes]] | External axes (1 axis is expected in the list), by default None | None | True | + + +--- + +## Returns + +This function does not return anything + +--- + +## Examples + +```python +from openbb_terminal.sdk import openbb +openbb.fa.divs_chart("AAPL") +``` + +--- + + + diff --git a/website/content/sdk/reference/stocks/fa/dupont.md b/website/content/sdk/reference/stocks/fa/dupont.md new file mode 100644 index 000000000000..13f633d9cd37 --- /dev/null +++ b/website/content/sdk/reference/stocks/fa/dupont.md @@ -0,0 +1,40 @@ +--- +title: dupont +description: This page provides source code for the function openbb.stocks.fa.dupont + that returns the dupont ratio breakdown for a given stock ticker symbol. +keywords: +- dupont ratios +- Stock ticker symbol +- openbb.stocks.fa.dupont +- dupont ratio breakdown +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Get dupont ratios + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/stocks/fundamental_analysis/av_model.py#L715)] + +```python +openbb.stocks.fa.dupont(symbol: str) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| symbol | str | Stock ticker symbol | None | False | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | The dupont ratio breakdown | +--- diff --git a/website/content/sdk/reference/stocks/fa/earnings.md b/website/content/sdk/reference/stocks/fa/earnings.md new file mode 100644 index 000000000000..06de2eea2da9 --- /dev/null +++ b/website/content/sdk/reference/stocks/fa/earnings.md @@ -0,0 +1,60 @@ +--- +title: earnings +description: This site provides an extensive guide to retrieving earnings data of + any stock ticker using the OpenBB Terminal. The page includes detailed parameters + descriptions and practical examples. +keywords: +- earnings data +- stock ticker +- AlphaVantage +- YahooFinance +- quarterly data +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Get earnings data. + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/stocks/fundamental_analysis/sdk_helpers.py#L203)] + +```python +openbb.stocks.fa.earnings(symbol: str, source: str = "YahooFinance", quarterly: bool = False) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| symbol | str | Stock ticker | None | False | +| source | str | Source to use, by default "AlphaVantage" | YahooFinance | True | +| quarterly | bool | Flag to get quarterly data (AlphaVantage only), by default False. | False | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | Dataframe of earnings | +--- + +## Examples + +```python +from openbb_terminal.sdk import openbb +aapl_earnings = openbb.stocks.fa.earnings("AAPL", source ="YahooFinance) +``` + +``` +To obtain quarterly earnings, use the quarterly flag with AlphaVantage +``` +```python +aapl_earnings = openbb.stocks.fa.metrics("earnings", source ="AlphaVantage, quarterly=True) +``` + +--- diff --git a/website/content/sdk/reference/stocks/fa/enterprise.md b/website/content/sdk/reference/stocks/fa/enterprise.md new file mode 100644 index 000000000000..6cb366b662a0 --- /dev/null +++ b/website/content/sdk/reference/stocks/fa/enterprise.md @@ -0,0 +1,43 @@ +--- +title: enterprise +description: This page provides detailed information about the financial modeling + prep ticker enterprise, including python code, parameter descriptions, and returns. +keywords: +- Financial Modeling Prep Ticker Enterprise +- Enterprise Parameters +- Enterprise Returns +- Python code for Financial Modeling +- Fundamental Analysis Ticker Symbol +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Financial Modeling Prep ticker enterprise + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/stocks/fundamental_analysis/fmp_model.py#L131)] + +```python +openbb.stocks.fa.enterprise(symbol: str, limit: int = 5, quarterly: bool = False) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| symbol | str | Fundamental analysis ticker symbol | None | False | +| limit | int | Number to get | 5 | True | +| quarterly | bool | Flag to get quarterly data | False | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | Dataframe of enterprise information | +--- diff --git a/website/content/sdk/reference/stocks/fa/fama_coe.md b/website/content/sdk/reference/stocks/fa/fama_coe.md new file mode 100644 index 000000000000..183de8c47add --- /dev/null +++ b/website/content/sdk/reference/stocks/fa/fama_coe.md @@ -0,0 +1,45 @@ +--- +title: fama_coe +description: Learn how to use Fama and French to determine the cost of equity for + a company with our Fama_Coe tool. Find the Python source code and understand its + parameters and returns. +keywords: +- Fama and French +- cost of equity +- company financial analysis +- Python source code +- Fama_Coe tool +- OpenBB stocks +- ticker symbol analysis +- stock's Fama French coefficient +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Use Fama and French to get the cost of equity for a company + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/stocks/fundamental_analysis/dcf_model.py#L300)] + +```python +openbb.stocks.fa.fama_coe(symbol: str) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| symbol | str | The ticker symbol to be analyzed | None | False | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| float | The stock's Fama French coefficient | +--- diff --git a/website/content/sdk/reference/stocks/fa/fama_raw.md b/website/content/sdk/reference/stocks/fa/fama_raw.md new file mode 100644 index 000000000000..7e9add67723d --- /dev/null +++ b/website/content/sdk/reference/stocks/fa/fama_raw.md @@ -0,0 +1,42 @@ +--- +title: fama_raw +description: The page provides detailed information on retrieving Fama French data + through the openbb.stocks.fa.fama_raw() method in the OpenBB terminal. It serves + as a resource for financial analysis and coding in Python involving DCF models. +keywords: +- Fama French data +- openbb stocks +- fa fama raw +- Data Frame +- coding in Python +- fundamental analysis +- DCF model +- OpenBB-finance +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Get Fama French data + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/stocks/fundamental_analysis/dcf_model.py#L240)] + +```python +openbb.stocks.fa.fama_raw() +``` + +--- + +## Parameters + +This function does not take any parameters. + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | Fama French data | +--- diff --git a/website/content/sdk/reference/stocks/fa/fraud.md b/website/content/sdk/reference/stocks/fa/fraud.md new file mode 100644 index 000000000000..2d70710e6d78 --- /dev/null +++ b/website/content/sdk/reference/stocks/fa/fraud.md @@ -0,0 +1,43 @@ +--- +title: fraud +description: This is an informational page about Fetching fraud ratios based on fundamentals + using OpenBB's stocks.fa.fraud function in Python. This function accepts a stock + ticker symbol and returns fraud ratios in a pandas DataFrame format. +keywords: +- fraud ratios +- fundamental analysis +- stock ticker symbol +- pandas DataFrame +- OpenBB.finance +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Get fraud ratios based on fundamentals + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/stocks/fundamental_analysis/av_model.py#L594)] + +```python +openbb.stocks.fa.fraud(symbol: str, detail: bool = False) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| symbol | str | Stock ticker symbol | None | False | +| detail | bool | Whether to provide extra m-score details | False | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | The fraud ratios | +--- diff --git a/website/content/sdk/reference/stocks/fa/growth.md b/website/content/sdk/reference/stocks/fa/growth.md new file mode 100644 index 000000000000..0633c0c3f9db --- /dev/null +++ b/website/content/sdk/reference/stocks/fa/growth.md @@ -0,0 +1,45 @@ +--- +title: growth +description: This page provides information on how to get financial statement growth + using OpenBB's financial analysis function. Included are parameters required, return + types and the link to the source code. +keywords: +- Financial Statement Growth +- OpenBB Finance +- OpenBBTerminal source code +- Get financial statement growth +- Stock ticker symbol +- Fundamental Analysis +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Get financial statement growth + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/stocks/fundamental_analysis/fmp_model.py#L505)] + +```python +openbb.stocks.fa.growth(symbol: str, limit: int = 5, quarterly: bool = False) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| symbol | str | Stock ticker symbol | None | False | +| limit | int | Number to get | 5 | True | +| quarterly | bool | Flag to get quarterly data, by default False | False | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | Dataframe of financial statement growth | +--- diff --git a/website/content/sdk/reference/stocks/fa/historical_5.md b/website/content/sdk/reference/stocks/fa/historical_5.md new file mode 100644 index 000000000000..33f57d2f1a38 --- /dev/null +++ b/website/content/sdk/reference/stocks/fa/historical_5.md @@ -0,0 +1,45 @@ +--- +title: historical_5 +description: Find how to get a 5 year monthly historical performance for a given ticker + with dividends filtered using OpenBB's Python library. By analyzing ticker symbols + with this method, get a detailed data analysis. +keywords: +- Historical performance +- 5 year monthly history +- Dividends +- Ticker symbol +- Data analysis +- Source code +- Fundamental analysis +- Pandas DataFrame +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Get 5 year monthly historical performance for a ticker with dividends filtered + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/stocks/fundamental_analysis/dcf_model.py#L278)] + +```python +openbb.stocks.fa.historical_5(symbol: str) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| symbol | str | The ticker symbol to be analyzed | None | False | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | Historical data | +--- diff --git a/website/content/sdk/reference/stocks/fa/hq.md b/website/content/sdk/reference/stocks/fa/hq.md new file mode 100644 index 000000000000..62f1b44e595a --- /dev/null +++ b/website/content/sdk/reference/stocks/fa/hq.md @@ -0,0 +1,46 @@ +--- +title: hq +description: This documentation page provides source code for retrieving the Google + Map URL of a company's headquarters based on its stock ticker symbol, using the + OpenBB's function openbb.stocks.fa.hq. It includes the parameter details and return + type description. +keywords: +- hq +- google map url +- headquarter +- stock +- ticker symbol +- openbb.stocks.fa.hq +- fundamental analysis +- yahoo finance model +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Gets google map url for headquarter + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/stocks/fundamental_analysis/yahoo_finance_model.py#L228)] + +```python +openbb.stocks.fa.hq(symbol: str) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| symbol | str | Stock ticker symbol | None | False | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| str | Headquarter google maps url | +--- diff --git a/website/content/sdk/reference/stocks/fa/income.md b/website/content/sdk/reference/stocks/fa/income.md new file mode 100644 index 000000000000..1adfb28284e7 --- /dev/null +++ b/website/content/sdk/reference/stocks/fa/income.md @@ -0,0 +1,66 @@ +--- +title: income +description: This page is a detailed guide on how to use the 'income' function provided + by OpenBBTerminal. This function fetches income statements for a given stock symbol + from selected data sources like YahooFinance or AlphaVantage. +keywords: +- income statement +- stock +- symbol +- source +- YahooFinance +- AlphaVantage +- OpenBBTerminal income +- Financial Analysis +- fundamental analysis +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Get income statement. + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/stocks/fundamental_analysis/sdk_helpers.py#L14)] + +```python +openbb.stocks.fa.income(symbol: str, quarterly: bool = False, ratios: bool = False, source: str = "YahooFinance", limit: int = 10) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| symbol | str | Symbol to get income statement for | None | False | +| source | str | Data source for income statement, by default "YahooFinance" | YahooFinance | True | +| quarterly | bool | Flag to get quarterly data | False | True | +| ratios | bool | Flag to return data as a percent change. | False | True | +| limit | int | Number of statements to return (free tiers may be limited to 5 years) | 10 | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | Dataframe of income statement | +--- + +## Examples + +```python +from openbb_terminal.sdk import openbb +income_statement = openbb.stocks.fa.income("AAPL", source="YahooFinance) +``` + +``` +If you have a premium AlphaVantage key, you can use the quarterly flag to get quarterly statements +``` +```python +quarterly_income_statement = openbb.stocks.fa.income("AAPL", source="AlphaVantage", quarterly=True) +``` + +--- diff --git a/website/content/sdk/reference/stocks/fa/info.md b/website/content/sdk/reference/stocks/fa/info.md new file mode 100644 index 000000000000..76b2727f0d8f --- /dev/null +++ b/website/content/sdk/reference/stocks/fa/info.md @@ -0,0 +1,40 @@ +--- +title: info +description: This page provides information on retrieving ticker symbol information + using OpenBB.fa.info method, leveraging yfinance data. +keywords: +- fa.info method +- yfinance data +- stock ticker symbol +- Pandas DataFrame +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Gets ticker symbol info + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/stocks/fundamental_analysis/yahoo_finance_model.py#L31)] + +```python +openbb.stocks.fa.info(symbol: str) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| symbol | str | Stock ticker symbol | None | False | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | DataFrame of yfinance information | +--- diff --git a/website/content/sdk/reference/stocks/fa/key.md b/website/content/sdk/reference/stocks/fa/key.md new file mode 100644 index 000000000000..6154c6e31b73 --- /dev/null +++ b/website/content/sdk/reference/stocks/fa/key.md @@ -0,0 +1,43 @@ +--- +title: key +description: This page provides the source code and explanation on how to get key + metrics from OpenBB's stocks fundamental analysis. Detailed parameters and return + value are provided. +keywords: +- key metrics +- stocks +- fundamental analysis +- dataframe +- symbol +- stock ticker +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Get key metrics from overview + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/stocks/fundamental_analysis/av_model.py#L101)] + +```python +openbb.stocks.fa.key(symbol: str) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| symbol | str | Stock ticker symbol | None | False | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | Dataframe of key metrics | +--- diff --git a/website/content/sdk/reference/stocks/fa/metrics.md b/website/content/sdk/reference/stocks/fa/metrics.md new file mode 100644 index 000000000000..b2431eeea063 --- /dev/null +++ b/website/content/sdk/reference/stocks/fa/metrics.md @@ -0,0 +1,49 @@ +--- +title: metrics +description: This page details the process of getting key metrics in stock market + by using the metrics function with parameters symbol, limit, and quarterly. It includes + the Python code for this function. +keywords: +- OpenBBTerminal Metrics +- Metrics Function +- Stock Market Metrics +- Python Stock Market Code +- Fundamental Analysis +- FMP model +- Stock ticker symbol +- Quarterly data +- Market Analysis +- Dataframe of Key Metrics +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Get key metrics + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/stocks/fundamental_analysis/fmp_model.py#L421)] + +```python +openbb.stocks.fa.metrics(symbol: str, limit: int = 5, quarterly: bool = False) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| symbol | str | Stock ticker symbol | None | False | +| limit | int | Number to get | 5 | True | +| quarterly | bool | Flag to get quarterly data, by default False | False | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | Dataframe of key metrics | +--- diff --git a/website/content/sdk/reference/stocks/fa/mgmt.md b/website/content/sdk/reference/stocks/fa/mgmt.md new file mode 100644 index 000000000000..4eaf541bdb57 --- /dev/null +++ b/website/content/sdk/reference/stocks/fa/mgmt.md @@ -0,0 +1,42 @@ +--- +title: mgmt +description: This page provides a guide on getting company managers' details from + Business Insider using the OpenBB library. Code snippet in Python is provided. +keywords: +- company managers +- Business Insider +- OpenBB library +- Python code +- Stock ticker symbol +- Dataframe of managers +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Get company managers from Business Insider + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/stocks/fundamental_analysis/business_insider_model.py#L19)] + +```python +openbb.stocks.fa.mgmt(symbol: str) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| symbol | str | Stock ticker symbol | None | False | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | Dataframe of managers | +--- diff --git a/website/content/sdk/reference/stocks/fa/mktcap.md b/website/content/sdk/reference/stocks/fa/mktcap.md new file mode 100644 index 000000000000..69589558b9cc --- /dev/null +++ b/website/content/sdk/reference/stocks/fa/mktcap.md @@ -0,0 +1,88 @@ +--- +title: mktcap +description: "This page provides documentation about the mktcap function of OpenBB-finance\u2019\ + s Yahoo Finance Module. It explains the operation and usage of the functions for\ + \ market cap modeling and charting over a certain period." +keywords: +- OpenBB-finance +- Yahoo Finance +- mktcap function +- market cap model +- market cap chart +- Stock ticker symbol +- Financial analysis +- Fundamental analysis +- Stock market data +- Source code +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + +Get market cap over time for ticker. [Source: Yahoo Finance] + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/stocks/fundamental_analysis/yahoo_finance_model.py#L287)] + +```python +openbb.stocks.fa.mktcap(symbol: str, start_date: Optional[str] = None) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| symbol | str | Ticker to get market cap over time | None | False | +| start_date | Optional[str] | Initial date (e.g., 2021-10-01). Defaults to 3 years back | None | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | Dataframe of estimated market cap over time | +--- + + + + +Display market cap over time. [Source: Yahoo Finance] + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/stocks/fundamental_analysis/yahoo_finance_view.py#L338)] + +```python +openbb.stocks.fa.mktcap_chart(symbol: str, start_date: Optional[str] = None, export: str = "", external_axes: Optional[List[matplotlib.axes._axes.Axes]] = None) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| symbol | str | Stock ticker symbol | None | False | +| start_date | Optional[str] | Initial date (e.g., 2021-10-01). Defaults to 3 years back | None | True | +| export | str | Format to export data | | True | +| external_axes | Optional[List[plt.Axes]] | External axes (1 axis is expected in the list), by default None | None | True | + + +--- + +## Returns + +This function does not return anything + +--- + + + diff --git a/website/content/sdk/reference/stocks/fa/overview.md b/website/content/sdk/reference/stocks/fa/overview.md new file mode 100644 index 000000000000..900dd4c5d48a --- /dev/null +++ b/website/content/sdk/reference/stocks/fa/overview.md @@ -0,0 +1,45 @@ +--- +title: overview +description: This page provides an API for getting an Alpha Vantage's company overview + with OpenBB Terminal. It is implemented with Python for stock fundamental analysis. + A stock's ticker symbol is used as the parameter, and it returns the fundamentals + in a pd.DataFrame. +keywords: +- Alpha vantage company overview +- OpenBB finance +- OpenBB terminal +- Stocks fundamental analysis +- AV model +- Stock ticker symbol +- Dataframe of fundamentals +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Get alpha vantage company overview + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/stocks/fundamental_analysis/av_model.py#L36)] + +```python +openbb.stocks.fa.overview(symbol: str) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| symbol | str | Stock ticker symbol | None | False | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | Dataframe of fundamentals | +--- diff --git a/website/content/sdk/reference/stocks/fa/profile.md b/website/content/sdk/reference/stocks/fa/profile.md new file mode 100644 index 000000000000..64e846b35b97 --- /dev/null +++ b/website/content/sdk/reference/stocks/fa/profile.md @@ -0,0 +1,42 @@ +--- +title: profile +description: This page provides information on retrieving the ticker profile from + FMP using the 'openbb.stocks.fa.profile' function in OpenBBTerminal. Python's pd.DataFrame + is utilized to organize the stock ticker data. +keywords: +- FMP +- ticker profile +- stock ticker symbol +- openbb.stocks.fa.profile +- fundamental analysis +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Get ticker profile from FMP + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/stocks/fundamental_analysis/fmp_model.py#L56)] + +```python +openbb.stocks.fa.profile(symbol: str) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| symbol | str | Stock ticker symbol | None | False | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | Dataframe of ticker profile | +--- diff --git a/website/content/sdk/reference/stocks/fa/quote.md b/website/content/sdk/reference/stocks/fa/quote.md new file mode 100644 index 000000000000..1f56ac806936 --- /dev/null +++ b/website/content/sdk/reference/stocks/fa/quote.md @@ -0,0 +1,42 @@ +--- +title: quote +description: The documentation page provides a brief explanation on how to use the + OpenBBTerminal to fetch stock ticker quotes from FMP. It also includes the source + code and instructions on its parameters and return type. +keywords: +- FMP +- stocks +- fundamental analysis +- ticker quote +- symbol +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Gets ticker quote from FMP + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/stocks/fundamental_analysis/fmp_model.py#L84)] + +```python +openbb.stocks.fa.quote(symbol: str) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| symbol | str | Stock ticker symbol | None | False | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | Dataframe of ticker quote | +--- diff --git a/website/content/sdk/reference/stocks/fa/ratios.md b/website/content/sdk/reference/stocks/fa/ratios.md new file mode 100644 index 000000000000..e1b15d8debda --- /dev/null +++ b/website/content/sdk/reference/stocks/fa/ratios.md @@ -0,0 +1,45 @@ +--- +title: ratios +description: This page provides important details about the 'ratios' function in 'OpenBB + Stocks' module which is used for fundamental analysis. Users can extract key ratios + by providing a stock's ticker symbol and specifying other optional parameters. The + function returns a DataFrame of key ratios. +keywords: +- OpenBB Stocks +- Fundamental Analysis +- Key Ratios +- Stock Ticker Symbol +- Quarterly Data +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Get key ratios + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/stocks/fundamental_analysis/fmp_model.py#L463)] + +```python +openbb.stocks.fa.ratios(symbol: str, limit: int = 5, quarterly: bool = False) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| symbol | str | Stock ticker symbol | None | False | +| limit | int | Number to get | 5 | True | +| quarterly | bool | Flag to get quarterly data, by default False | False | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | Dataframe of key ratios | +--- diff --git a/website/content/sdk/reference/stocks/fa/score.md b/website/content/sdk/reference/stocks/fa/score.md new file mode 100644 index 000000000000..781e19dc9730 --- /dev/null +++ b/website/content/sdk/reference/stocks/fa/score.md @@ -0,0 +1,44 @@ +--- +title: score +description: Documentation of 'score' function in fmp, part of the fundamental analysis + of stocks, which retrieves the value score for a specified ticker symbol. Returns + a np.number type value score. +keywords: +- score +- fmp +- stocks +- fundamental analysis +- value score +- ticker symbol +- np.number +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Gets value score from fmp + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/stocks/fundamental_analysis/fmp_model.py#L25)] + +```python +openbb.stocks.fa.score(symbol: str) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| symbol | str | Stock ticker symbol | None | False | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| np.number | Value score | +--- diff --git a/website/content/sdk/reference/stocks/fa/shrs.md b/website/content/sdk/reference/stocks/fa/shrs.md new file mode 100644 index 000000000000..009e17a42c6f --- /dev/null +++ b/website/content/sdk/reference/stocks/fa/shrs.md @@ -0,0 +1,48 @@ +--- +title: shrs +description: This page provides information about a utility that fetches shareholder + data from Yahoo for a given stock. It includes a source code link and explains parameters + of the utility module. Uses Python language for coding. +keywords: +- Shareholders +- Yahoo +- Stocks +- Source Code +- Parameters +- Python Coding +- Stock Ticker Symbol +- Institutional Holder +- Data frame +- Major Holders +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Get shareholders from yahoo + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/stocks/fundamental_analysis/yahoo_finance_model.py#L75)] + +```python +openbb.stocks.fa.shrs(symbol: str, holder: str = "institutional") +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| symbol | str | Stock ticker symbol | None | False | +| holder | str | Which holder to get table for | institutional | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | Major holders | +--- diff --git a/website/content/sdk/reference/stocks/fa/similar_dfs.md b/website/content/sdk/reference/stocks/fa/similar_dfs.md new file mode 100644 index 000000000000..3f09363dc395 --- /dev/null +++ b/website/content/sdk/reference/stocks/fa/similar_dfs.md @@ -0,0 +1,51 @@ +--- +title: similar_dfs +description: The similar_dfs function in OpenBB is documented on this page. This function + is used for generating dataframes for similar companies by taking inputs such as + a ticker symbol, the output from the yfinance.info function and the number of similar + companies to produce. The option of filtering based on market cap is also provided. + Going through this documentation provides valuable information to understand the + use and functioning of the similar_dfs function. +keywords: +- similar_dfs +- dataframes +- similar companies +- stocks +- fundamental analysis +- yfinance.info function +- ticker symbol +- market cap +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Get dataframes for similar companies + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/stocks/fundamental_analysis/dcf_model.py#L468)] + +```python +openbb.stocks.fa.similar_dfs(symbol: str, info: Dict[str, Any], n: int, no_filter: bool = False) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| symbol | str | The ticker symbol to create a dataframe for | None | False | +| into | Dict[str,Any] | The dictionary produced from the yfinance.info function | None | True | +| n | int | The number of similar companies to produce | None | False | +| no_filter | bool | True means that we do not filter based on market cap | False | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| List[str, pd.DataFrame] | A list of similar companies | +--- diff --git a/website/content/sdk/reference/stocks/fa/splits.md b/website/content/sdk/reference/stocks/fa/splits.md new file mode 100644 index 000000000000..a8b36f538e7b --- /dev/null +++ b/website/content/sdk/reference/stocks/fa/splits.md @@ -0,0 +1,82 @@ +--- +title: splits +description: This page pertains to the splits and reverse splits events details of + stocks, showcasing how to fetch them using the openbb.stocks.fa.splits() function + and display them with openbb.stocks.fa.splits_chart() function. +keywords: +- Stock splits +- Reverse stock splits +- openbb.stocks.fa.splits +- openbb.stocks.fa.splits_chart +- Fundamental analysis +- Yahoo Finance +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + +Get splits and reverse splits events. [Source: Yahoo Finance] + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/stocks/fundamental_analysis/yahoo_finance_model.py#L326)] + +```python +openbb.stocks.fa.splits(symbol: str) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| symbol | str | Ticker to get forward and reverse splits | None | False | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | Dataframe of forward and reverse splits | +--- + + + + +Display splits and reverse splits events. [Source: Yahoo Finance] + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/stocks/fundamental_analysis/yahoo_finance_view.py#L261)] + +```python +openbb.stocks.fa.splits_chart(symbol: str, export: str = "", external_axes: Optional[List[matplotlib.axes._axes.Axes]] = None) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| symbol | str | Stock ticker symbol | None | False | +| export | str | Format to export data | | True | +| external_axes | Optional[List[plt.Axes]] | External axes (1 axis is expected in the list), by default None | None | True | + + +--- + +## Returns + +This function does not return anything + +--- + + + diff --git a/website/content/sdk/reference/stocks/fa/sust.md b/website/content/sdk/reference/stocks/fa/sust.md new file mode 100644 index 000000000000..33e5dd2b43e5 --- /dev/null +++ b/website/content/sdk/reference/stocks/fa/sust.md @@ -0,0 +1,43 @@ +--- +title: sust +description: This page provides information on how to get sustainability metrics for + a stock, using the OpenBB platform which relies on Yahoo Finance. It includes necessary + parameters and return values. +keywords: +- sustainability metrics +- Yahoo Finance +- stock +- ticker symbol +- dataframe +- fundamental analysis +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Get sustainability metrics from yahoo + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/stocks/fundamental_analysis/yahoo_finance_model.py#L138)] + +```python +openbb.stocks.fa.sust(symbol: str) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| symbol | str | Stock ticker symbol | None | False | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | Dataframe of sustainability metrics | +--- diff --git a/website/content/sdk/reference/stocks/fa/website.md b/website/content/sdk/reference/stocks/fa/website.md new file mode 100644 index 000000000000..6435dc95609a --- /dev/null +++ b/website/content/sdk/reference/stocks/fa/website.md @@ -0,0 +1,39 @@ +--- +title: website +description: This page provides documentation on how to fetch a company's website + from yfinance using a stock ticker symbol. +keywords: +- yfinance +- website +- stock ticker symbol +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Gets website of company from yfinance + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/stocks/fundamental_analysis/yahoo_finance_model.py#L210)] + +```python +openbb.stocks.fa.website(symbol: str) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| symbol | str | Stock ticker symbol | None | False | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| str | Company website | +--- diff --git a/website/content/sdk/reference/stocks/gov/contracts.md b/website/content/sdk/reference/stocks/gov/contracts.md new file mode 100644 index 000000000000..eb269cf9595c --- /dev/null +++ b/website/content/sdk/reference/stocks/gov/contracts.md @@ -0,0 +1,86 @@ +--- +title: contracts +description: This documentation contains the details of two functions, 'contracts' + and 'contracts_chart', that are used to retrieve trading data of U.S. government + contracts for specific ticker from 'quiverquant.com'. It explains the parameters + and return type of the functions, and provides links to the source code. +keywords: +- contracts +- contracts_chart +- quiverquant.com +- government contracts +- trading data +- parameters +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + +Get government contracts for ticker [Source: quiverquant.com] + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/stocks/government/quiverquant_model.py#L103)] + +```python +openbb.stocks.gov.contracts(symbol: str, past_transaction_days: int = 10) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| symbol | str | Ticker to get congress trading data from | None | False | +| past_transaction_days | int | Number of days to get transactions for | 10 | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | Most recent transactions by members of U.S. Congress | +--- + + + + +Show government contracts for ticker [Source: quiverquant.com] + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/stocks/government/quiverquant_view.py#L380)] + +```python +openbb.stocks.gov.contracts_chart(symbol: str, past_transaction_days: int = 10, raw: bool = False, export: str = "", external_axes: Optional[List[matplotlib.axes._axes.Axes]] = None) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| symbol | str | Ticker to get congress trading data from | None | False | +| past_transaction_days | int | Number of days to get transactions for | 10 | True | +| raw | bool | Flag to display raw data | False | True | +| export | str | Format to export data | | True | +| external_axes | Optional[List[plt.Axes]] | External axes (1 axis is expected in the list), by default None | None | True | + + +--- + +## Returns + +This function does not return anything + +--- + + + diff --git a/website/content/sdk/reference/stocks/gov/government_trading.md b/website/content/sdk/reference/stocks/gov/government_trading.md new file mode 100644 index 000000000000..a606adcb9553 --- /dev/null +++ b/website/content/sdk/reference/stocks/gov/government_trading.md @@ -0,0 +1,49 @@ +--- +title: government_trading +description: This page documents the government_trading function, which returns the + most recent transactions by members of government like congress, senate, house, + and others. The source code and parameters are provided for reference. +keywords: +- government trading +- recent transactions +- congress trading +- senate trading +- house trades +- financial contracts +- quarter contracts +- corporate lobbying +- ticker symbol +- trade data +- Data Frame +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Returns the most recent transactions by members of government + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/stocks/government/quiverquant_model.py#L25)] + +```python +openbb.stocks.gov.government_trading(gov_type: str = "congress", symbol: str = "") +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| gov_type | str | Type of government data between:
'congress', 'senate', 'house', 'contracts', 'quarter-contracts' and 'corporate-lobbying' | congress | True | +| symbol | str | Ticker symbol to get congress trading data from | | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | Most recent transactions by members of U.S. Congress | +--- diff --git a/website/content/sdk/reference/stocks/gov/gtrades.md b/website/content/sdk/reference/stocks/gov/gtrades.md new file mode 100644 index 000000000000..8364f1b90e33 --- /dev/null +++ b/website/content/sdk/reference/stocks/gov/gtrades.md @@ -0,0 +1,92 @@ +--- +title: gtrades +description: This page provides the documentation for the 'gtrades' function in OpenBB's + terminal for stock traders. It contains two tabs - the 'model' tab explains how + to get the government trading data for a specific ticker, while the 'view' tab provides + instructions for displaying this data as a chart. +keywords: +- stock trading +- government trading data +- quiverquant.com +- gtrades function +- model +- view +- congress +- senate +- house +- trades chart +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + +Government trading for specific ticker [Source: quiverquant.com] + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/stocks/government/quiverquant_model.py#L416)] + +```python +openbb.stocks.gov.gtrades(symbol: str, gov_type: str = "congress", past_transactions_months: int = 6) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| symbol | str | Ticker symbol to get congress trading data from | None | False | +| gov_type | str | Type of government data between: congress, senate and house | congress | True | +| past_transactions_months | int | Number of months to get transactions for | 6 | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | DataFrame of tickers government trading | +--- + + + + +Government trading for specific ticker [Source: quiverquant.com] + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/stocks/government/quiverquant_view.py#L331)] + +```python +openbb.stocks.gov.gtrades_chart(symbol: str, gov_type: str = "congress", past_transactions_months: int = 6, raw: bool = False, export: str = "", external_axes: Optional[List[matplotlib.axes._axes.Axes]] = None) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| symbol | str | Ticker symbol to get congress trading data from | None | False | +| gov_type | str | Type of government data between: congress, senate and house | congress | True | +| past_transactions_months | int | Number of months to get transactions for | 6 | True | +| raw | bool | Show raw output of trades | False | True | +| export | str | Format to export data | | True | +| external_axes | Optional[List[plt.Axes]] | External axes (1 axis is expected in the list), by default None | None | True | + + +--- + +## Returns + +This function does not return anything + +--- + + + diff --git a/website/content/sdk/reference/stocks/gov/histcont.md b/website/content/sdk/reference/stocks/gov/histcont.md new file mode 100644 index 000000000000..315edbdf9117 --- /dev/null +++ b/website/content/sdk/reference/stocks/gov/histcont.md @@ -0,0 +1,84 @@ +--- +title: histcont +description: This page provides documentation on OpenBBTerminal's histcont function. + The function allows users to get and visualize historical quarterly government contracts. +keywords: +- histcont function +- historical quarterly government contracts +- quiverquant.com +- stock data +- financial data +- data visualization +- ticker symbol +- congress trading data +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + +Get historical quarterly government contracts [Source: quiverquant.com] + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/stocks/government/quiverquant_model.py#L139)] + +```python +openbb.stocks.gov.histcont(symbol: str) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| symbol | str | Ticker symbol to get congress trading data from | None | False | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | Historical quarterly government contracts | +--- + + + + +Show historical quarterly government contracts [Source: quiverquant.com] + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/stocks/government/quiverquant_view.py#L547)] + +```python +openbb.stocks.gov.histcont_chart(symbol: str, raw: bool = False, export: str = "", external_axes: Optional[List[matplotlib.axes._axes.Axes]] = None) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| symbol | str | Ticker symbol to get congress trading data from | None | False | +| raw | bool | Flag to display raw data | False | True | +| export | str | Format to export data | | True | +| external_axes | Optional[List[plt.Axes]] | External axes (1 axis is expected in the list), by default None | None | True | + + +--- + +## Returns + +This function does not return anything + +--- + + + diff --git a/website/content/sdk/reference/stocks/gov/lastcontracts.md b/website/content/sdk/reference/stocks/gov/lastcontracts.md new file mode 100644 index 000000000000..5e024b8c8457 --- /dev/null +++ b/website/content/sdk/reference/stocks/gov/lastcontracts.md @@ -0,0 +1,86 @@ +--- +title: lastcontracts +description: This documentation page provides information on using OpenBBTerminal's + Python code to obtain government contract data from QuiverQuant. It guides how to + use the lastcontracts model and view functions for data analysis and export. +keywords: +- Government contracts +- QuiverQuant +- Data analysis +- Finance +- Source code +- Data export +- GitHub +- matplotlib +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + +Get last government contracts [Source: quiverquant.com] + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/stocks/government/quiverquant_model.py#L377)] + +```python +openbb.stocks.gov.lastcontracts(past_transaction_days: int = 2) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| past_transaction_days | int | Number of days to look back | 2 | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | DataFrame of government contracts | +--- + + + + +Last government contracts [Source: quiverquant.com] + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/stocks/government/quiverquant_view.py#L225)] + +```python +openbb.stocks.gov.lastcontracts_chart(past_transaction_days: int = 2, limit: int = 20, sum_contracts: bool = False, export: str = "", external_axes: Optional[List[matplotlib.axes._axes.Axes]] = None) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| past_transaction_days | int | Number of days to look back | 2 | True | +| limit | int | Number of contracts to show | 20 | True | +| sum_contracts | bool | Flag to show total amount of contracts given out. | False | True | +| export | str | Format to export data | | True | +| external_axes | Optional[List[plt.Axes]] | External axes (1 axis is expected in the list), by default None | None | True | + + +--- + +## Returns + +This function does not return anything + +--- + + + diff --git a/website/content/sdk/reference/stocks/gov/lasttrades.md b/website/content/sdk/reference/stocks/gov/lasttrades.md new file mode 100644 index 000000000000..ad8c67355232 --- /dev/null +++ b/website/content/sdk/reference/stocks/gov/lasttrades.md @@ -0,0 +1,47 @@ +--- +title: lasttrades +description: This page provides documentation for the 'lasttrades' function which + fetches last government trading data. It includes parameters such as 'gov_type', + 'limit', and 'representative', and returns a pandas DataFrame. +keywords: +- lasttrades +- government trading +- quiverquant.com source +- openbb.stocks.gov.lasttrades +- congress +- senate +- house +- representative +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Get last government trading [Source: quiverquant.com] + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/stocks/government/quiverquant_model.py#L164)] + +```python +openbb.stocks.gov.lasttrades(gov_type: str = "congress", limit: int = -1, representative: str = "") +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| gov_type | str | Type of government data between: congress, senate and house | congress | True | +| limit | int | Number of days to look back | -1 | True | +| representative | str | Specific representative to look at | | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | Last government trading | +--- diff --git a/website/content/sdk/reference/stocks/gov/lobbying.md b/website/content/sdk/reference/stocks/gov/lobbying.md new file mode 100644 index 000000000000..0b5e0a17c772 --- /dev/null +++ b/website/content/sdk/reference/stocks/gov/lobbying.md @@ -0,0 +1,47 @@ +--- +title: lobbying +description: This page provides details on corporate lobbying, including parameters + for symbol and limit, and returns a dataframe with corporate lobbying data. It includes + a link to the source code on GitHub. +keywords: +- Corporate lobbying details +- Source code +- openbb.stocks.gov.lobbying +- Parameters +- symbol +- Ticker symbol +- limit +- Returns +- corporate lobbying data +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Corporate lobbying details + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/stocks/government/quiverquant_model.py#L531)] + +```python +openbb.stocks.gov.lobbying(symbol: str, limit: int = 10) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| symbol | str | Ticker symbol to get corporate lobbying data from | None | False | +| limit | int | Number of events to show | 10 | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | Dataframe with corporate lobbying data | +--- diff --git a/website/content/sdk/reference/stocks/gov/qtrcontracts.md b/website/content/sdk/reference/stocks/gov/qtrcontracts.md new file mode 100644 index 000000000000..44f3150ce353 --- /dev/null +++ b/website/content/sdk/reference/stocks/gov/qtrcontracts.md @@ -0,0 +1,89 @@ +--- +title: qtrcontracts +description: Documentation on the use of qtrcontracts function in Python for analyzing + quarterly contracts by ticker. Posts include parameter details for the model and + chart functions. +keywords: +- qtrcontracts function +- quarterly contracts analytics +- OpenBB finance +- Model function +- Chart function +- Parameter settings +- Source code +- matplotlib.axes._axes.Axes +- Total analysis +- Momentum analysis +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + +Analyzes quarterly contracts by ticker + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/stocks/government/quiverquant_model.py#L482)] + +```python +openbb.stocks.gov.qtrcontracts(analysis: str = "total", limit: int = 5) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| analysis | str | How to analyze. Either gives total amount or sorts by high/low momentum. | total | True | +| limit | int | Number to return, by default 5 | 5 | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | Dataframe with tickers and total amount if total selected. | +--- + + + + +Quarterly contracts [Source: quiverquant.com] + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/stocks/government/quiverquant_view.py#L446)] + +```python +openbb.stocks.gov.qtrcontracts_chart(analysis: str = "total", limit: int = 5, raw: bool = False, export: str = "", external_axes: Optional[List[matplotlib.axes._axes.Axes]] = None) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| analysis | str | Analysis to perform. Either 'total', 'upmom' 'downmom' | total | True | +| limit | int | Number to show | 5 | True | +| raw | bool | Flag to display raw data | False | True | +| export | str | Format to export data | | True | +| external_axes | Optional[List[plt.Axes]] | External axes (1 axis is expected in the list), by default None | None | True | + + +--- + +## Returns + +This function does not return anything + +--- + + + diff --git a/website/content/sdk/reference/stocks/gov/topbuys.md b/website/content/sdk/reference/stocks/gov/topbuys.md new file mode 100644 index 000000000000..8975f169ee97 --- /dev/null +++ b/website/content/sdk/reference/stocks/gov/topbuys.md @@ -0,0 +1,91 @@ +--- +title: topbuys +description: This documentation page covers the top buy government trading on OpenBB + Terminal, providing detailed information on relevant python functions and parameters. + It features source code and explanations for different data types and optional parameters. +keywords: +- top buy government trading +- python functions +- parameters +- data types +- quiverquant.com +- congress +- senate +- house +- pandas DataFrame +- matplotlib +- trading data +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + +Get top buy government trading [Source: quiverquant.com] + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/stocks/government/quiverquant_model.py#L227)] + +```python +openbb.stocks.gov.topbuys(gov_type: str = "congress", past_transactions_months: int = 6) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| gov_type | str | Type of government data between: congress, senate and house | congress | True | +| past_transactions_months | int | Number of months to get trading for | 6 | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | DataFrame of top government buy trading | +--- + + + + +Top buy government trading [Source: quiverquant.com] + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/stocks/government/quiverquant_view.py#L79)] + +```python +openbb.stocks.gov.topbuys_chart(gov_type: str = "congress", past_transactions_months: int = 6, limit: int = 10, raw: bool = False, export: str = "", external_axes: Optional[List[matplotlib.axes._axes.Axes]] = None) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| gov_type | str | Type of government data between: congress, senate and house | congress | True | +| past_transactions_months | int | Number of months to get trading for | 6 | True | +| limit | int | Number of tickers to show | 10 | True | +| raw | bool | Display raw data | False | True | +| export | str | Format to export data | | True | +| external_axes | Optional[List[plt.Axes]] | External axes (1 axis is expected in the list), by default None | None | True | + + +--- + +## Returns + +This function does not return anything + +--- + + + diff --git a/website/content/sdk/reference/stocks/gov/toplobbying.md b/website/content/sdk/reference/stocks/gov/toplobbying.md new file mode 100644 index 000000000000..bd920aea80af --- /dev/null +++ b/website/content/sdk/reference/stocks/gov/toplobbying.md @@ -0,0 +1,87 @@ +--- +title: toplobbying +description: This page provides details on the 'toplobbying' functionality of the + OpenBBTerminal software, including the Quiverquant model and view. The page offers + a guide on how to present top lobbying tickers based on total money spent and guides + on retrieving corporate lobbying details using Python. +keywords: +- Corporate Lobbying +- Top Lobbying +- Lobbying Tickers +- Government +- Quiverquant model +- Quiverquant view +- Source Code +- Data frame +- Chart +- Raw data +- Export data +- External axes +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + +Corporate lobbying details + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/stocks/government/quiverquant_model.py#L358)] + +```python +openbb.stocks.gov.toplobbying() +``` + +--- + +## Parameters + +This function does not take any parameters. + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | DataFrame of top corporate lobbying | +--- + + + + +Top lobbying tickers based on total spent + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/stocks/government/quiverquant_view.py#L622)] + +```python +openbb.stocks.gov.toplobbying_chart(limit: int = 10, raw: bool = False, export: str = "", external_axes: Optional[List[matplotlib.axes._axes.Axes]] = None) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| limit | int | Number of tickers to show | 10 | True | +| raw | bool | Show raw data | False | True | +| export | | Format to export data | | True | +| external_axes | Optional[List[plt.Axes]] | External axes (1 axis is expected in the list), by default None | None | True | + + +--- + +## Returns + +This function does not return anything + +--- + + + diff --git a/website/content/sdk/reference/stocks/gov/topsells.md b/website/content/sdk/reference/stocks/gov/topsells.md new file mode 100644 index 000000000000..7e6962855e24 --- /dev/null +++ b/website/content/sdk/reference/stocks/gov/topsells.md @@ -0,0 +1,93 @@ +--- +title: topsells +description: Explore the topsells documentation page for detailed instructions on + how to use the openbb.stocks.gov.topsells function. This function is used to get + top sell government trading data from quiverquant.com. It covers different types + of government data including congress, senate, and house. The function allows for + customization such as defining the number of past transaction months. Samples of + source codes are also provided with relevant links for reference. +keywords: +- topsells +- trading +- government data +- quiverquant.com +- openbb.stocks.gov +- congress +- senate +- house +- past transactions months +- matplotlib +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + +Get top sell government trading [Source: quiverquant.com] + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/stocks/government/quiverquant_model.py#L287)] + +```python +openbb.stocks.gov.topsells(gov_type: str = "congress", past_transactions_months: int = 6) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| gov_type | str | Type of government data between: congress, senate and house | congress | True | +| past_transactions_months | int | Number of months to get trading for | 6 | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | DataFrame of top government sell trading | +--- + + + + +Top sell government trading [Source: quiverquant.com] + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/stocks/government/quiverquant_view.py#L151)] + +```python +openbb.stocks.gov.topsells_chart(gov_type: str = "congress", past_transactions_months: int = 6, limit: int = 10, raw: bool = False, export: str = "", external_axes: Optional[List[matplotlib.axes._axes.Axes]] = None) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| gov_type | str | Type of government data between: congress, senate and house | congress | True | +| past_transactions_months | int | Number of months to get trading for | 6 | True | +| limit | int | Number of tickers to show | 10 | True | +| raw | bool | Display raw data | False | True | +| export | str | Format to export data | | True | +| external_axes | Optional[List[plt.Axes]] | External axes (1 axis is expected in the list), by default None | None | True | + + +--- + +## Returns + +This function does not return anything + +--- + + + diff --git a/website/content/sdk/reference/stocks/ins/act.md b/website/content/sdk/reference/stocks/ins/act.md new file mode 100644 index 000000000000..751cdb562aba --- /dev/null +++ b/website/content/sdk/reference/stocks/ins/act.md @@ -0,0 +1,87 @@ +--- +title: act +description: OpenBBTerminal offers user-friendly, Python-based tools to gauge insider + activity data for a given stock ticker from Business Insider. The available functions + not only assemble the raw data but also provide you with an elaborate chart outlining + past insider activities. +keywords: +- OpenBB Finance +- Stock Insider Activity +- Business Insider +- Financial Data +- Stock Market +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + +Get insider activity. [Source: Business Insider] + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/stocks/insider/businessinsider_model.py#L17)] + +```python +openbb.stocks.ins.act(symbol: str) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| symbol | str | Ticker symbol to get insider activity data from | None | False | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | Insider activity data | +--- + + + + +Display insider activity. [Source: Business Insider] + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/stocks/insider/businessinsider_view.py#L32)] + +```python +openbb.stocks.ins.act_chart(data: pd.DataFrame, symbol: str, start_date: Optional[str] = None, interval: str = "1440min", limit: int = 10, raw: bool = False, export: str = "", external_axes: Optional[List[matplotlib.axes._axes.Axes]] = None) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| data | pd.DataFrame | Stock dataframe | None | False | +| symbol | str | Due diligence ticker symbol | None | False | +| start_date | Optional[str] | Initial date (e.g., 2021-10-01). Defaults to 3 years back | None | True | +| interval | str | Stock data interval | 1440min | True | +| limit | int | Number of latest days of inside activity | 10 | True | +| raw | bool | Print to console | False | True | +| export | str | Export dataframe data to csv,json,xlsx file | | True | +| external_axes | Optional[List[plt.Axes]] | External axes (1 axis is expected in the list), by default None | None | True | + + +--- + +## Returns + +This function does not return anything + +--- + + + diff --git a/website/content/sdk/reference/stocks/ins/lins.md b/website/content/sdk/reference/stocks/ins/lins.md new file mode 100644 index 000000000000..4e40e411be7b --- /dev/null +++ b/website/content/sdk/reference/stocks/ins/lins.md @@ -0,0 +1,82 @@ +--- +title: lins +description: 'The webpage is a technical documentation section related to the usage + of the functions ''lins'' and ''lins_chart''. It involves extracting and displaying + last insider activity for a particular stock ticker from source: Finviz.' +keywords: +- technical documentation +- stock ticker +- insider activity +- Finviz +- OpenBB.finance +- functions +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + +Get last insider activity for a given stock ticker. [Source: Finviz] + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/stocks/insider/finviz_model.py#L16)] + +```python +openbb.stocks.ins.lins(symbol: str) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| symbol | str | Stock ticker symbol | None | False | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | Latest insider trading activity | +--- + + + + +Display insider activity for a given stock ticker. [Source: Finviz] + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/stocks/insider/finviz_view.py#L15)] + +```python +openbb.stocks.ins.lins_chart(symbol: str, limit: int = 10, export: str = "") +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| symbol | str | Stock ticker symbol | None | False | +| limit | int | Number of latest insider activity to display | 10 | True | +| export | str | Export dataframe data to csv,json,xlsx file | | True | + + +--- + +## Returns + +This function does not return anything + +--- + + + diff --git a/website/content/sdk/reference/stocks/ins/print_insider_data.md b/website/content/sdk/reference/stocks/ins/print_insider_data.md new file mode 100644 index 000000000000..c4d1e25b5ca4 --- /dev/null +++ b/website/content/sdk/reference/stocks/ins/print_insider_data.md @@ -0,0 +1,87 @@ +--- +title: print_insider_data +description: Documentation page for OpenBB-finance's Print Insider Data feature. It + includes details about the parameters involved, such as the type of insider data + and the limit of data rows to display, as well as the option to export data in a + specific format. The page provides source code links for further information. +keywords: +- Print insider data +- Open insider filtered data +- Type_insider +- Limit +- Export data format +- Docusaurus page metadata +- Source code +- OpenBB-finance +- Metadata SEO +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + +Print insider data + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/stocks/insider/openinsider_model.py#L1437)] + +```python +openbb.stocks.ins.print_insider_data(type_insider: str = "lcb", limit: int = 10) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| type_insider | str | Insider type of data. Available types can be accessed through get_insider_types(). | lcb | True | +| limit | int | Limit of data rows to display | 10 | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | Open insider filtered data | +--- + + + + +Print insider data + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/stocks/insider/openinsider_view.py#L108)] + +```python +openbb.stocks.ins.print_insider_data_chart(type_insider: str = "lcb", limit: int = 10, export: str = "") +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| type_insider | str | Insider type of data. Available types can be accessed through get_insider_types(). | lcb | True | +| limit | int | Limit of data rows to display | 10 | True | +| export | str | Export data format | | True | + + +--- + +## Returns + +This function does not return anything + +--- + + + diff --git a/website/content/sdk/reference/stocks/load.md b/website/content/sdk/reference/stocks/load.md new file mode 100644 index 000000000000..49be6b644ca3 --- /dev/null +++ b/website/content/sdk/reference/stocks/load.md @@ -0,0 +1,59 @@ +--- +title: load +description: Learn how to use the load function within OpenBBTerminal's stocks module + to retrieve and analyze data. Provide a symbol (ticker), define start and end dates, + interval, choose whether to include pre/post-hours data and the data source. Options + to retrieve weekly and monthly data are available. The gathered data is returned + as a pandas DataFrame. +keywords: +- symbol analysis +- start_date +- interval +- end_date +- prepost +- source +- YahooFinance +- weekly data +- monthly data +- verbose +- data extraction +- dataframe +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Load a symbol to perform analysis using the string above as a template. + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/stocks/stocks_helper.py#L223)] + +```python +openbb.stocks.load(symbol: str, start_date: Union[datetime.datetime, str, NoneType] = None, interval: int = 1440, end_date: Union[datetime.datetime, str, NoneType] = None, prepost: bool = False, source: str = "YahooFinance", weekly: bool = False, monthly: bool = False, verbose: bool = True) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| symbol | str | Ticker to get data | None | False | +| start_date | str or datetime | Start date to get data from with. - datetime or string format (YYYY-MM-DD) | None | True | +| interval | int | Interval (in minutes) to get data 1, 5, 15, 30, 60 or 1440 | 1440 | True | +| end_date | str or datetime | End date to get data from with. - datetime or string format (YYYY-MM-DD) | None | True | +| prepost | bool | Pre and After hours data | False | True | +| source | str | Source of data extracted | YahooFinance | True | +| weekly | bool | Flag to get weekly data | False | True | +| monthly | bool | Flag to get monthly data | False | True | +| verbose | bool | Display verbose information on what was the symbol that was loaded | True | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | Dataframe of data | +--- diff --git a/website/content/sdk/reference/stocks/options/chains.md b/website/content/sdk/reference/stocks/options/chains.md new file mode 100644 index 000000000000..20ebeb78e3e9 --- /dev/null +++ b/website/content/sdk/reference/stocks/options/chains.md @@ -0,0 +1,61 @@ +--- +title: chains +description: This page provides comprehensive instructions on how to get option chain + for a stock using openbb.stocks.options API. It provides examples including how + to retrieve data from 'Nasdaq' and fetch specific expiration dates. +keywords: +- stock options +- option chain +- openbb.stocks.options.api +- Nasdaq +- expiration dates +- stock market API +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Get Option Chain For A Stock. No greek data is returned + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/stocks/options/options_sdk_helper.py#L20)] + +```python +openbb.stocks.options.chains(symbol: str, source: str = "Nasdaq", expiration: Optional[str] = None) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| symbol | str | Symbol to get chain for | None | False | +| source | str | Source to get data from, by default "Nasdaq" | Nasdaq | True | +| expiration | Union[str, None] | Date to get chain for. By default returns all dates | None | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | Dataframe of full option chain. | +--- + +## Examples + +```python +from openbb_terminal.sdk import openbb +aapl_option_chain = openbb.stocks.options.chains("AAPL", source = "Nasdaq") +``` + +``` +To get a specific expiration date, use the expiration parameter +``` +```python +aapl_chain_date = openbb.stocks.options.chains("AAPL", expiration="2023-07-21", source="Nasdaq") +``` + +--- diff --git a/website/content/sdk/reference/stocks/options/dte.md b/website/content/sdk/reference/stocks/options/dte.md new file mode 100644 index 000000000000..515264a9f1c7 --- /dev/null +++ b/website/content/sdk/reference/stocks/options/dte.md @@ -0,0 +1,40 @@ +--- +title: dte +description: This documentation page provides detailed information on the 'dte' function. + Learn about the computation of days to expiration from yfinance option date using + the 'openbb.stocks.options' methods in Python. +keywords: +- dte function +- yfinance option date +- openbb.stocks.options +- python coding +- finance model +- stock options +- days to expiration +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Gets days to expiration from yfinance option date + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/stocks/options/yfinance_model.py#L365)] + +```python +openbb.stocks.options.dte(date_value: str) +``` + +--- + +## Parameters + +This function does not take any parameters. + +--- + +## Returns + +This function does not return anything + +--- diff --git a/website/content/sdk/reference/stocks/options/expirations.md b/website/content/sdk/reference/stocks/options/expirations.md new file mode 100644 index 000000000000..b9ed0ac64df8 --- /dev/null +++ b/website/content/sdk/reference/stocks/options/expirations.md @@ -0,0 +1,55 @@ +--- +title: expirations +description: Find option chain expirations using the OpenBBTerminal. It allows to + fetch data from different sources like Nasdaq and Tradier. The result is a comprehensive + dataframe. +keywords: +- option chain +- Nasdaq +- option expiration +- symbol +- data source +- Tradier +- dataframe +- SPX +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Get Option Chain Expirations + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/stocks/options/options_sdk_helper.py#L69)] + +```python +openbb.stocks.options.expirations(symbol: str, source: str = "Nasdaq") +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| symbol | str | Symbol to get chain for | None | False | +| source | str | Source to get data from, by default "Nasdaq" | Nasdaq | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | Dataframe of full option chain. | +--- + +## Examples + +```python +from openbb_terminal.sdk import openbb +SPX_expirations = openbb.stocks.options.expirations("SPX", source = "Tradier") +``` + +--- diff --git a/website/content/sdk/reference/stocks/options/generate_data.md b/website/content/sdk/reference/stocks/options/generate_data.md new file mode 100644 index 000000000000..9a09c2a192e5 --- /dev/null +++ b/website/content/sdk/reference/stocks/options/generate_data.md @@ -0,0 +1,40 @@ +--- +title: generate_data +description: The generate_data function in openbb.stocks.options gets x values, and + y values before and after premiums. It doesn't take any parameters or return anything. +keywords: +- generate_data +- x values +- y values +- premiums +- current_price +- options +- underlying +- openbb.stocks.options +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Gets x values, and y values before and after premiums + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/stocks/options/yfinance_model.py#L287)] + +```python +openbb.stocks.options.generate_data(current_price: float, options: List[Dict[str, int]], underlying: int) +``` + +--- + +## Parameters + +This function does not take any parameters. + +--- + +## Returns + +This function does not return anything + +--- diff --git a/website/content/sdk/reference/stocks/options/grhist.md b/website/content/sdk/reference/stocks/options/grhist.md new file mode 100644 index 000000000000..14b2f323ad0e --- /dev/null +++ b/website/content/sdk/reference/stocks/options/grhist.md @@ -0,0 +1,99 @@ +--- +title: grhist +description: Learn about using the functions grhist, syncretism model, and syncretism + view in OpenBBTerminal to get historical greeks for options on stocks. These Python + functions are clearly explained and the source code is provided for in-depth understanding. + The page also delineates parameters and return values. +keywords: +- stocks +- options +- grhist +- syncretism model +- historical greeks +- strike price +- put option +- OCC option symbol +- grhist chart +- Greek variable +- export data +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + +Get histoical option greeks + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/stocks/options/screen/syncretism_model.py#L37)] + +```python +openbb.stocks.options.grhist(symbol: str, expiry: str, strike: Union[str, float], chain_id: str = "", put: bool = False) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| symbol | str | Stock ticker symbol | None | False | +| expiry | str | Option expiration date | None | False | +| strike | Union[str, float] | Strike price to look for | None | False | +| chain_id | str | OCC option symbol. Overwrites other inputs | | True | +| put | bool | Is this a put option? | False | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | Dataframe containing historical greeks | +--- + + + + +Plots historical greeks for a given option. [Source: Syncretism] + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/stocks/options/screen/syncretism_view.py#L107)] + +```python +openbb.stocks.options.grhist_chart(symbol: str, expiry: str, strike: Union[float, str], greek: str = "Delta", chain_id: str = "", put: bool = False, raw: bool = False, limit: Union[int, str] = 20, export: str = "", external_axes: Optional[List[matplotlib.axes._axes.Axes]] = None) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| symbol | str | Stock ticker | None | False | +| expiry | str | Expiration date | None | False | +| strike | Union[str, float] | Strike price to consider | None | False | +| greek | str | Greek variable to plot | Delta | True | +| chain_id | str | OCC option chain. Overwrites other variables | | True | +| put | bool | Is this a put option? | False | True | +| raw | bool | Print to console | False | True | +| limit | int | Number of rows to show in raw | 20 | True | +| export | str | Format to export data | | True | +| external_axes | Optional[List[plt.Axes]] | External axes (1 axis is expected in the list), by default None | None | True | + + +--- + +## Returns + +This function does not return anything + +--- + + + diff --git a/website/content/sdk/reference/stocks/options/hist.md b/website/content/sdk/reference/stocks/options/hist.md new file mode 100644 index 000000000000..b227fbe936ef --- /dev/null +++ b/website/content/sdk/reference/stocks/options/hist.md @@ -0,0 +1,62 @@ +--- +title: hist +description: The page explains how to get historical option pricing using the OpenBB + SDK in Python. It provides a detailed guide for parameters and return types along + with examples. You may choose data source from ChartExchange or Tradier. +keywords: +- Option Pricing +- Historical data +- ChartExchange +- Tradier +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Get historical option pricing. + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/stocks/options/options_sdk_helper.py#L101)] + +```python +openbb.stocks.options.hist(symbol: str, exp: str, strike: Union[int, float, str], call: bool = True, source: Any = "ChartExchange") +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| symbol | str | Symbol to get data for | None | False | +| exp | str | Expiration date | None | False | +| strike | Union[int ,Union[float,str]] | Strike price | None | False | +| call | bool | Flag to indicate a call, by default True | True | True | +| source | str | Source to get data from. Can be ChartExchange or Tradier, by default "ChartExchange" | ChartExchange | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | DataFrame of historical option pricing | +--- + +## Examples + +```python +from openbb_terminal.sdk import openbb +aapl_150_call = openbb.stocks.options.hist("AAPL", "2022-11-18", 150, call=True, source="ChartExchange") +``` + +``` +Because this generates a dataframe, we can easily plot the close price for a SPY put: +(Note that Tradier requires an API key) +``` +```python +openbb.stocks.options.hist("SPY", "2022-11-18", 400, call=False, source="Tradier").plot(y="close) +``` + +--- diff --git a/website/versioned_docs/version-v3/sdk/reference/stocks/options/hist_ce.md b/website/content/sdk/reference/stocks/options/hist_ce.md similarity index 77% rename from website/versioned_docs/version-v3/sdk/reference/stocks/options/hist_ce.md rename to website/content/sdk/reference/stocks/options/hist_ce.md index ffc2311ceb46..19444bec385e 100644 --- a/website/versioned_docs/version-v3/sdk/reference/stocks/options/hist_ce.md +++ b/website/content/sdk/reference/stocks/options/hist_ce.md @@ -1,13 +1,27 @@ --- title: hist_ce -description: OpenBB SDK Function +description: 'This page describes two main functionalities of the OpenBBFinance documentation: + ''hist_ce'' function for getting historical prices for a specific stock option and + ''hist_ce_chart'' function for displaying the same historical stock data in charts. + Both functions come with detailed explanations of their parameters and expected + returns.' +keywords: +- OpenBBFinance documentation +- stock options +- historical prices +- chart visualization +- hist_ce function +- hist_ce_chart function +- stock data --- +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; -# hist_ce - @@ -40,8 +54,6 @@ openbb.stocks.options.hist_ce(symbol: str = "GME", date: str = "2021-02-05", cal | pd.Dataframe | Historic information for an option | --- - - @@ -76,7 +88,5 @@ This function does not return anything --- - - - \ No newline at end of file + diff --git a/website/content/sdk/reference/stocks/options/info.md b/website/content/sdk/reference/stocks/options/info.md new file mode 100644 index 000000000000..730709ffbdae --- /dev/null +++ b/website/content/sdk/reference/stocks/options/info.md @@ -0,0 +1,80 @@ +--- +title: info +description: This documentation page provides information about the info and chart + models for options in OpenBB Terminal, explaining how to get ticker info and scrape + Barchart.com for options info. +keywords: +- OpenBB Terminal documentation +- Stock options +- Ticker info +- Barchart.com scraping +- Python utilities +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + +Get info for a given ticker + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/stocks/options/yfinance_model.py#L329)] + +```python +openbb.stocks.options.info(symbol: str) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| symbol | str | The ticker symbol to get the price for | None | False | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| float | The info for a given ticker | +--- + + + + +Scrapes Barchart.com for the options information + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/stocks/options/barchart_view.py#L15)] + +```python +openbb.stocks.options.info_chart(symbol: str, export: str = "") +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| symbol | str | Ticker symbol to get options info for | None | False | +| export | str | Format of export file | | True | + + +--- + +## Returns + +This function does not return anything + +--- + + + diff --git a/website/content/sdk/reference/stocks/options/last_price.md b/website/content/sdk/reference/stocks/options/last_price.md new file mode 100644 index 000000000000..c9d19f124853 --- /dev/null +++ b/website/content/sdk/reference/stocks/options/last_price.md @@ -0,0 +1,44 @@ +--- +title: last_price +description: The page provides documentation for the 'last_price' API call in the + OpenBBTerminal project of OpenBB.finance. It details how to request for the last + price of a specific stock option using the ticker symbol. +keywords: +- last_price +- api request +- OpenBB.finance +- stocks +- options +- tradier_model.py +- ticker symbol +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Makes api request for last price + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/stocks/options/tradier_model.py#L275)] + +```python +openbb.stocks.options.last_price(symbol: str) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| symbol | str | Ticker symbol | None | False | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| | Last price | +--- diff --git a/website/content/sdk/reference/stocks/options/pcr.md b/website/content/sdk/reference/stocks/options/pcr.md new file mode 100644 index 000000000000..7122840d682c --- /dev/null +++ b/website/content/sdk/reference/stocks/options/pcr.md @@ -0,0 +1,97 @@ +--- +title: pcr +description: Documentation for the 'pcr' function from the OpenBB Terminal platform. + Contains model and chart views to get and display the put call ratio of certain + stock options. +keywords: +- pcr function +- put call ratio +- stock options +- AlphaQuery.com +- Python code +- function parameters +- function return +- docusaurus tabs +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + +Gets put call ratio over last time window [Source: AlphaQuery.com] + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/stocks/options/alphaquery_model.py#L17)] + +```python +openbb.stocks.options.pcr(symbol: str, window: int = 30, start_date: Optional[str] = None) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| symbol | str | Ticker symbol to look for | None | False | +| window | int | Window to consider, by default 30 | 30 | True | +| start_date | Optional[str] | Start date to plot (e.g., 2021-10-01), by default last 366 days | None | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | Put call ratio | +--- + +## Examples + +```python +from openbb_terminal.sdk import openbb +pcr_df = openbb.stocks.options.pcr("B") +``` + +--- + + + + +Display put call ratio [Source: AlphaQuery.com] + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/stocks/options/alphaquery_view.py#L26)] + +```python +openbb.stocks.options.pcr_chart(symbol: str, window: int = 30, start_date: str = "2021-11-24", export: str = "", external_axes: Optional[List[matplotlib.axes._axes.Axes]] = None) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| symbol | str | Stock ticker symbol | None | False | +| window | int | Window length to look at, by default 30 | 30 | True | +| start_date | str | Starting date for data, by default (datetime.now() - timedelta(days=366)).strftime("%Y-%m-%d") | 2021-11-24 | True | +| export | str | Format to export data, by default "" | | True | +| external_axes | Optional[List[plt.Axes]] | External axes (1 axis is expected in the list), by default None | None | True | + + +--- + +## Returns + +This function does not return anything + +--- + + + diff --git a/website/content/sdk/reference/stocks/options/process_chains.md b/website/content/sdk/reference/stocks/options/process_chains.md new file mode 100644 index 000000000000..a83eaa8b7d46 --- /dev/null +++ b/website/content/sdk/reference/stocks/options/process_chains.md @@ -0,0 +1,43 @@ +--- +title: process_chains +description: A details documentation page about how to use process_chains function + of openbb.stocks.options in Python. This function takes API response from Tradier + and returns a DataFrame with available options. +keywords: +- stocks +- options +- process chains +- API +- Tradier +- options trading +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Function to take in the request and return a DataFrame + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/stocks/options/tradier_model.py#L238)] + +```python +openbb.stocks.options.process_chains(response: requests.models.Response) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| response | requests.models.Response | This is the response from tradier api. | None | False | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | Dataframe with all available options | +--- diff --git a/website/content/sdk/reference/stocks/options/screen/check_presets.md b/website/content/sdk/reference/stocks/options/screen/check_presets.md new file mode 100644 index 000000000000..bf20b2061619 --- /dev/null +++ b/website/content/sdk/reference/stocks/options/screen/check_presets.md @@ -0,0 +1,43 @@ +--- +title: check_presets +description: This page explains the check_presets function used in option screener + to check the preset values. The function takes a dictionary with presets from configparser + as argument and returns a string of accumulated errors. +keywords: +- check_presets +- Option Screener +- Preset values +- openbb.stocks.options.screen +- configparser +- Error accumulation +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Checks option screener preset values + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/stocks/options/screen/syncretism_model.py#L251)] + +```python +openbb.stocks.options.screen.check_presets(preset_dict: dict) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| preset_dict | dict | Defined presets from configparser | None | False | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| str | String of all errors accumulated | +--- diff --git a/website/content/sdk/reference/stocks/options/screen/screener_output.md b/website/content/sdk/reference/stocks/options/screen/screener_output.md new file mode 100644 index 000000000000..47f748471ef6 --- /dev/null +++ b/website/content/sdk/reference/stocks/options/screen/screener_output.md @@ -0,0 +1,82 @@ +--- +title: screener_output +description: This documentation page cover the usage of screener output for OpenBB + Terminal. It includes explanations for using preset filters, printing the output, + and parameters for sorting and export formatting. There are also links to the source + code and Python command line instructions. +keywords: +- screener output +- preset filters +- export formatting +- command line instructions +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + +Screen options based on preset filters + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/stocks/options/screen/syncretism_model.py#L159)] + +```python +openbb.stocks.options.screen.screener_output(preset: str) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| preset | str | Chosen preset | None | False | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| Tuple[pd.DataFrame, str] | DataFrame with screener data or empty if errors, String containing error message if supplied | +--- + + + + +Print the output of screener + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/stocks/options/screen/syncretism_view.py#L60)] + +```python +openbb.stocks.options.screen.screener_output_chart(preset: str, limit: int = 20, export: str = "") +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| preset | str | Chosen preset | None | False | +| limit | int | Number of randomly sorted rows to display | 20 | True | +| export | str | Format for export file | | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| List | List of tickers screened | +--- + + + diff --git a/website/content/sdk/reference/stocks/options/unu.md b/website/content/sdk/reference/stocks/options/unu.md new file mode 100644 index 000000000000..543c405526e5 --- /dev/null +++ b/website/content/sdk/reference/stocks/options/unu.md @@ -0,0 +1,99 @@ +--- +title: unu +description: The documentation page provides details about the 'unu' command from + openbb.stocks.options. It includes information on how to get unusual option activity + data from fdscanner.com and display the unusual options table. It lists parameters, + returns, and gives examples of usage. +keywords: +- stocks +- options +- unu +- fdscanner.com +- unusual option activity +- dataframe +- python code +- parameters +- returns +- examples +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + +Get unusual option activity from fdscanner.com + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/stocks/options/fdscanner_model.py#L19)] + +```python +openbb.stocks.options.unu(limit: int = 100) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| limit | int | Number to show | 100 | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| Tuple[pd.DataFrame, pd.Timestamp] | Dataframe containing options information, Timestamp indicated when data was updated from website | +--- + +## Examples + +```python +from openbb_terminal.sdk import openbb +unu_df = openbb.stocks.options.unu() +``` + +--- + + + + +Displays the unusual options table + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/stocks/options/fdscanner_view.py#L15)] + +```python +openbb.stocks.options.unu_chart(limit: int = 20, sortby: str = "Vol/OI", ascend: bool = False, calls_only: bool = False, puts_only: bool = False, export: str = "") +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| limit | int | Number of rows to show | 20 | True | +| sortby | str | Data column to sort on | Vol/OI | True | +| ascend | bool | Whether to sort in ascend order | False | True | +| calls_only | bool | Flag to only show calls | False | True | +| puts_only | bool | Flag to show puts only | False | True | +| export | str | File type to export | | True | + + +--- + +## Returns + +This function does not return anything + +--- + + + diff --git a/website/content/sdk/reference/stocks/options/vsurf.md b/website/content/sdk/reference/stocks/options/vsurf.md new file mode 100644 index 000000000000..9fb84424776f --- /dev/null +++ b/website/content/sdk/reference/stocks/options/vsurf.md @@ -0,0 +1,84 @@ +--- +title: vsurf +description: A documentation page that guides how to use vsurf method which gets the + IV surface for calls and puts for stock ticker symbol and how to utilize vsurf_chart + to display the vol surface. Includes source code, data types and defaults. +keywords: +- Docusaurus +- vSurf +- vSurf_Chart +- IV Surface +- vol surface +- options +- ticker symbol +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + +Gets IV surface for calls and puts for ticker + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/stocks/options/yfinance_model.py#L371)] + +```python +openbb.stocks.options.vsurf(symbol: str) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| symbol | str | Stock ticker symbol to get | None | False | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | Dataframe of DTE, Strike and IV | +--- + + + + +Display vol surface + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/stocks/options/yfinance_view.py#L1128)] + +```python +openbb.stocks.options.vsurf_chart(symbol: str, export: str = "", z: str = "IV", external_axes: Optional[List[matplotlib.axes._axes.Axes]] = None) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| symbol | str | Ticker symbol to get surface for | None | False | +| export | str | Format to export data | | True | +| z | str | The variable for the Z axis | IV | True | +| external_axes | Optional[List[plt.Axes]] | External axes (1 axis is expected in the list), by default None | None | True | + + +--- + +## Returns + +This function does not return anything + +--- + + + diff --git a/website/content/sdk/reference/stocks/process_candle.md b/website/content/sdk/reference/stocks/process_candle.md new file mode 100644 index 000000000000..a37318618857 --- /dev/null +++ b/website/content/sdk/reference/stocks/process_candle.md @@ -0,0 +1,42 @@ +--- +title: process_candle +description: Learn how to use OpenBB's process_candle function to manipulate stock + data into a candle style plot. Particularly useful tool for financial analysis. +keywords: +- OpenBB stocks +- process_candle +- Stock DataFrame +- Panda's DataFrame +- Stock market +- Finance +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Process DataFrame into candle style plot. + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/stocks/stocks_helper.py#L825)] + +```python +openbb.stocks.process_candle(data: pd.DataFrame) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| data | DataFrame | Stock dataframe. | None | False | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| DataFrame | A Panda's data frame with columns Open, High, Low, Close, Adj Close, Volume,
date_id, OC-High, OC-Low. | +--- diff --git a/website/content/sdk/reference/stocks/qa/beta.md b/website/content/sdk/reference/stocks/qa/beta.md new file mode 100644 index 000000000000..f1909648785f --- /dev/null +++ b/website/content/sdk/reference/stocks/qa/beta.md @@ -0,0 +1,93 @@ +--- +title: beta +description: Learn how to calculate beta for a ticker and a reference ticker, and + display it with a scatterplot and linear regression, using OpenBB - an open source + finance tool. The page includes source code and parameters to correctly perform + and visualize these actions. +keywords: +- Docusaurus page optimization +- Beta calculation +- Ticker symbol +- Reference ticker symbol +- Stock market analysis +- Quantitative analysis +- Data visualization +- Scatterplot +- Linear regression +- Open source finance +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + +Calculate beta for a ticker and a reference ticker. + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/stocks/quantitative_analysis/beta_model.py#L11)] + +```python +openbb.stocks.qa.beta(symbol: str, ref_symbol: str, data: pd.DataFrame = None, ref_data: pd.DataFrame = None, interval: int = 1440) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| symbol | str | A ticker to calculate beta for | None | False | +| ref_symbol | str | A reference ticker symbol for the beta calculation (default in terminal is SPY) | None | False | +| data | pd.DataFrame | The selected ticker symbols price data | None | True | +| ref_data | pd.DataFrame | The reference ticker symbols price data | None | True | +| interval | int | The interval of the ref_data. This will ONLY be used if ref_data is None | 1440 | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| Tuple[pd.Series, pd.Series, float, float] | Stock ticker symbols close-to-close returns, Reference ticker symbols close-to-close returns, beta, alpha | +--- + + + + +Display the beta scatterplot + linear regression. + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/stocks/quantitative_analysis/beta_view.py#L18)] + +```python +openbb.stocks.qa.beta_chart(symbol: str, ref_symbol: str, data: pd.DataFrame = None, ref_data: pd.DataFrame = None, interval: int = 1440, export: str = "") +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| symbol | str | A ticker to calculate beta for | None | False | +| ref_symbol | str | A reference ticker symbol for the beta calculation (default in terminal is SPY) | None | False | +| data | pd.DataFrame | The selected ticker symbols price data | None | True | +| ref_data | pd.DataFrame | The reference ticker symbols price data | None | True | +| interval | int | The interval of the ref_data. This will ONLY be used if ref_data is None | 1440 | True | + + +--- + +## Returns + +This function does not return anything + +--- + + + diff --git a/website/content/sdk/reference/stocks/qa/capm.md b/website/content/sdk/reference/stocks/qa/capm.md new file mode 100644 index 000000000000..f81f50567e6a --- /dev/null +++ b/website/content/sdk/reference/stocks/qa/capm.md @@ -0,0 +1,42 @@ +--- +title: capm +description: This page offers an in-depth look at the CAPM model, providing information + about its parameters, returns, and the concept of systematic risk. +keywords: +- CAPM model +- Stocks +- Quantitative analysis +- Symbol +- Beta for a stock +- Systematic risk for a stock +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Provides information that relates to the CAPM model + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/stocks/quantitative_analysis/factors_model.py#L80)] + +```python +openbb.stocks.qa.capm(symbol: str) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| symbol | str | A ticker symbol in string form | None | False | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| Tuple[float, float] | The beta for a stock, The systematic risk for a stock | +--- diff --git a/website/content/sdk/reference/stocks/qa/fama_raw.md b/website/content/sdk/reference/stocks/qa/fama_raw.md new file mode 100644 index 000000000000..059f7016c74d --- /dev/null +++ b/website/content/sdk/reference/stocks/qa/fama_raw.md @@ -0,0 +1,42 @@ +--- +title: fama_raw +description: The doc page provides details on the fama_raw function for getting Fama + French data to calculate risk. It explains its usage in the OpenBB finance's quantitative + analysis and factors model. +keywords: +- fama_raw +- Fama French data +- risk calculation +- OpenBB finance +- quantitative analysis +- factors model +- stocks +- Fama French Model +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Gets base Fama French data to calculate risk + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/stocks/quantitative_analysis/factors_model.py#L20)] + +```python +openbb.stocks.qa.fama_raw() +``` + +--- + +## Parameters + +This function does not take any parameters. + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | A data with fama french model information | +--- diff --git a/website/content/sdk/reference/stocks/qa/historical_5.md b/website/content/sdk/reference/stocks/qa/historical_5.md new file mode 100644 index 000000000000..b68e7ae58aa3 --- /dev/null +++ b/website/content/sdk/reference/stocks/qa/historical_5.md @@ -0,0 +1,42 @@ +--- +title: historical_5 +description: Historical_5 function from OpenBB provides 5 year monthly historical + performance for a given stock ticker symbol with dividends filtered. This page gives + a comprehensive view of the function's parameters and returns. +keywords: +- stocks +- quantitative analysis +- historical_5 +- performance +- dividends +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Get 5 year monthly historical performance for a ticker with dividends filtered + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/stocks/quantitative_analysis/factors_model.py#L58)] + +```python +openbb.stocks.qa.historical_5(symbol: str) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| symbol | str | A ticker symbol in string form | None | False | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | A dataframe with historical information | +--- diff --git a/website/content/sdk/reference/stocks/quote.md b/website/content/sdk/reference/stocks/quote.md new file mode 100644 index 000000000000..c2541a7f99d1 --- /dev/null +++ b/website/content/sdk/reference/stocks/quote.md @@ -0,0 +1,40 @@ +--- +title: quote +description: Documentation for 'Ticker quote', a function of OpenBB's Stock Model. + It retrieves information about a specific ticker from YahooFinance. This tool doesn't + return any values, it solely utilizes inputted symbols. +keywords: +- Ticker quote +- YahooFinance +- Stock model +- symbol +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Ticker quote. [Source: YahooFinance] + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/stocks/stocks_model.py#L233)] + +```python +openbb.stocks.quote(symbol: str) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| symbol | str | Ticker | None | False | + + +--- + +## Returns + +This function does not return anything + +--- diff --git a/website/content/sdk/reference/stocks/screener/historical.md b/website/content/sdk/reference/stocks/screener/historical.md new file mode 100644 index 000000000000..f23885a76e6e --- /dev/null +++ b/website/content/sdk/reference/stocks/screener/historical.md @@ -0,0 +1,94 @@ +--- +title: historical +description: 'This webpage provides comprehensive documentation about the ''historical'' + feature of OpenBB''s application: OpenBBTerminal. Users can view and access python + codes, parameters, returning values for two main functionalities: viewing historical + price of stocks and creating a chart for those stocks.' +keywords: +- historical stock price +- stock chart +- python codes +- parameters +- dataframe +- preset loaded +- type candle +- MinMax normalization +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + +View historical price of stocks that meet preset + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/stocks/screener/yahoofinance_model.py#L53)] + +```python +openbb.stocks.screener.historical(preset_loaded: str = "top_gainers", limit: int = 10, start_date: str = "2022-05-29", type_candle: str = "a", normalize: bool = True) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| preset_loaded | str | Preset loaded to filter for tickers | top_gainers | True | +| limit | int | Number of stocks to display | 10 | True | +| start_date | str | Start date to display historical data, in YYYY-MM-DD format | 2022-05-29 | True | +| type_candle | str | Type of candle to display | a | True | +| normalize | bool | Boolean to normalize all stock prices using MinMax | True | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | Dataframe of the screener | +--- + + + + +View historical price of stocks that meet preset + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/stocks/screener/yahoofinance_view.py#L28)] + +```python +openbb.stocks.screener.historical_chart(preset_loaded: str = "top_gainers", limit: int = 10, start_date: str = "2022-05-29", type_candle: str = "a", normalize: bool = True, export: str = "", external_axes: Optional[List[matplotlib.axes._axes.Axes]] = None) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| preset_loaded | str | Preset loaded to filter for tickers | top_gainers | True | +| limit | int | Number of stocks to display | 10 | True | +| start_date | str | Start date to display historical data, in YYYY-MM-DD format | 2022-05-29 | True | +| type_candle | str | Type of candle to display | a | True | +| normalize | bool | Boolean to normalize all stock prices using MinMax | True | True | +| export | str | Export dataframe data to csv,json,xlsx file | | True | +| external_axes | Optional[List[plt.Axes]] | External axes (1 axis is expected in the list), by default None | None | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| list[str] | List of stocks | +--- + + + diff --git a/website/versioned_docs/version-v3/sdk/reference/stocks/screener/screener_data.md b/website/content/sdk/reference/stocks/screener/screener_data.md similarity index 79% rename from website/versioned_docs/version-v3/sdk/reference/stocks/screener/screener_data.md rename to website/content/sdk/reference/stocks/screener/screener_data.md index b38067850f45..a28094c050a1 100644 --- a/website/versioned_docs/version-v3/sdk/reference/stocks/screener/screener_data.md +++ b/website/content/sdk/reference/stocks/screener/screener_data.md @@ -1,13 +1,28 @@ --- title: screener_data -description: OpenBB SDK Function +description: This documentation outlines the functionality of the screener_data and + screener_data_chart modules in the OpenBB Terminal, a Python library for loading + and handling preset stock filters. It provides parameter descriptions and return + values, with links to the source code. +keywords: +- Screener data +- Python library +- Source code +- Stocks +- Preset filters +- Data types +- Screener data chart +- Order of stocks +- Data export --- +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; -# screener_data - @@ -40,8 +55,6 @@ openbb.stocks.screener.screener_data(preset_loaded: str = "top_gainers", data_ty | pd.DataFrame | Dataframe with loaded filtered stocks | --- - - @@ -76,7 +89,5 @@ openbb.stocks.screener.screener_data_chart(loaded_preset: str = "top_gainers", d | List[str] | List of stocks that meet preset criteria | --- - - - \ No newline at end of file + diff --git a/website/content/sdk/reference/stocks/search.md b/website/content/sdk/reference/stocks/search.md new file mode 100644 index 000000000000..17aaa35e1d04 --- /dev/null +++ b/website/content/sdk/reference/stocks/search.md @@ -0,0 +1,62 @@ +--- +title: search +description: The documentation page details the 'search' function of the OpenBB python + library used for querying stocks information. The function allows queries based + on parameters like country, sector, industry and exchange country. The search results + are returned as a pandas DataFrame. +keywords: +- search +- query +- tickers +- stocks +- country +- sector +- industry +- exchange_country +- limit +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Search selected query for tickers. + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/stocks/stocks_helper.py#L98)] + +```python +openbb.stocks.search(query: str = "", country: str = "", sector: str = "", industry: str = "", exchange_country: str = "", limit: int = 0) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +|------------------|------|---------------------------------------------------------|---------|----------| +| query | str | The search term used to find company tickers | | True | +| country | str | Search by country to find stocks matching the criteria | | True | +| sector | str | Search by sector to find stocks matching the criteria | | True | +| industry | str | Search by industry to find stocks matching the criteria | | True | +| exchange_country | str | Search by exchange country to find stock matching | | True | +| limit | int | The limit of companies shown. | 0 | True | + +--- + +## Returns + +| Type | Description | +|--------------|----------------| +| pd.DataFrame | Search results | + + +--- + +## Examples + +```python +from openbb_terminal.sdk import openbb +openbb.stocks.search(country="united states", exchange_country="Germany") +``` + +--- diff --git a/website/content/sdk/reference/stocks/sia/countries.md b/website/content/sdk/reference/stocks/sia/countries.md new file mode 100644 index 000000000000..8e8bcf93d4e1 --- /dev/null +++ b/website/content/sdk/reference/stocks/sia/countries.md @@ -0,0 +1,45 @@ +--- +title: countries +description: This documentation page discusses how to retrieve all countries in Yahoo + Finance data based on sector or industry. It provides an analysis method using the + OpenBB stocks sia function with Python. +keywords: +- Yahoo Finance data +- sector industry analysis +- finance database +- OpenBB stocks +- filter by industry +- filter by sector +- countries data +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Get all countries in Yahoo Finance data based on sector or industry. [Source: Finance Database] + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/stocks/sector_industry_analysis/financedatabase_model.py#L19)] + +```python +openbb.stocks.sia.countries(industry: str = "", sector: str = "") +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| industry | str | Filter retrieved countries by industry | | True | +| sector | str | Filter retrieved countries by sector | | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| list | List of possible countries | +--- diff --git a/website/content/sdk/reference/stocks/sia/cpci.md b/website/content/sdk/reference/stocks/sia/cpci.md new file mode 100644 index 000000000000..e9c665b1c472 --- /dev/null +++ b/website/content/sdk/reference/stocks/sia/cpci.md @@ -0,0 +1,92 @@ +--- +title: cpci +description: This docusaurus page provides comprehensive information on the 'cpci' + function of the OpenBB Terminal. It explains how to use the function to get the + number of companies per country in a specific industry based on market cap and whether + to exclude international exchanges. Detailed parameters and return values are provided, + along with source code links for those who require in-depth understanding. +keywords: +- cpci function +- number of companies per country +- industry-based company distribution +- market cap +- finance database +- industry selection +- python code +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + +Get number of companies per country in a specific industry (and specific market cap). + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/stocks/sector_industry_analysis/financedatabase_model.py#L411)] + +```python +openbb.stocks.sia.cpci(industry: str = "Internet Content & Information", mktcap: str = "Large", exclude_exchanges: bool = True) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| industry | str | Select industry to get number of companies by each country | Internet Content & Information | True | +| mktcap | str | Select market cap of companies to consider from Small, Mid and Large | Large | True | +| exclude_exchanges | bool | Exclude international exchanges | True | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| dict | Dictionary of countries and number of companies in a specific sector | +--- + + + + +Display number of companies per country in a specific industry. [Source: Finance Database] + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/stocks/sector_industry_analysis/financedatabase_view.py#L818)] + +```python +openbb.stocks.sia.cpci_chart(industry: str = "Internet Content & Information", mktcap: str = "Large", exclude_exchanges: bool = True, export: str = "", raw: bool = False, max_countries_to_display: int = 15, min_pct_to_display_country: float = 0.015, external_axes: Optional[List[matplotlib.axes._axes.Axes]] = None) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| industry | str | Select industry to get number of companies by each country | Internet Content & Information | True | +| mktcap | str | Select market cap of companies to consider from Small, Mid and Large | Large | True | +| exclude_exchanges | bool | Exclude international exchanges | True | True | +| export | str | Format to export data as | | True | +| raw | bool | Output all raw data | False | True | +| max_countries_to_display | int | Maximum number of countries to display | 15 | True | +| min_pct_to_display_country | float | Minimum percentage to display country | 0.015 | True | +| external_axes | Optional[List[plt.Axes]] | External axes (1 axis is expected in the list), by default None | None | True | + + +--- + +## Returns + +This function does not return anything + +--- + + + diff --git a/website/content/sdk/reference/stocks/sia/cpcs.md b/website/content/sdk/reference/stocks/sia/cpcs.md new file mode 100644 index 000000000000..411b3ad65167 --- /dev/null +++ b/website/content/sdk/reference/stocks/sia/cpcs.md @@ -0,0 +1,91 @@ +--- +title: cpcs +description: This documentation page provides information on how to use cpcs, a feature + of OpenBB's finance software, to get and display the number of companies per country + in a specific sector. Multiple parameters are available to allow customised queries. + Source code links are also provided. +keywords: +- CPCS feature +- number of companies per country +- specific sector +- market cap +- finance software +- customize queries +- parameters +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + +Get number of companies per country in a specific sector (and specific market cap). + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/stocks/sector_industry_analysis/financedatabase_model.py#L360)] + +```python +openbb.stocks.sia.cpcs(sector: str = "Technology", mktcap: str = "Large", exclude_exchanges: bool = True) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| sector | str | Select sector to get number of companies by each country | Technology | True | +| mktcap | str | Select market cap of companies to consider from Small, Mid and Large | Large | True | +| exclude_exchanges | bool | Exclude international exchanges | True | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| dict | Dictionary of countries and number of companies in a specific sector | +--- + + + + +Display number of companies per country in a specific sector. [Source: Finance Database] + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/stocks/sector_industry_analysis/financedatabase_view.py#L675)] + +```python +openbb.stocks.sia.cpcs_chart(sector: str = "Technology", mktcap: str = "Large", exclude_exchanges: bool = True, export: str = "", raw: bool = False, max_countries_to_display: int = 15, min_pct_to_display_country: float = 0.015, external_axes: Optional[List[matplotlib.axes._axes.Axes]] = None) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| sector | str | Select sector to get number of companies by each country | Technology | True | +| mktcap | str | Select market cap of companies to consider from Small, Mid and Large | Large | True | +| exclude_exchanges | bool | Exclude international exchanges | True | True | +| export | str | Format to export data as | | True | +| raw | bool | Output all raw data | False | True | +| max_countries_to_display | int | Maximum number of countries to display | 15 | True | +| min_pct_to_display_country | float | Minimum percentage to display country | 0.015 | True | +| external_axes | Optional[List[plt.Axes]] | External axes (1 axis is expected in the list), by default None | None | True | + + +--- + +## Returns + +This function does not return anything + +--- + + + diff --git a/website/content/sdk/reference/stocks/sia/cpic.md b/website/content/sdk/reference/stocks/sia/cpic.md new file mode 100644 index 000000000000..d52c994bad72 --- /dev/null +++ b/website/content/sdk/reference/stocks/sia/cpic.md @@ -0,0 +1,95 @@ +--- +title: cpic +description: The documentation page on cpic used in openbb_terminal provides detailed + information on how to use the 'cpic' and 'cpic_chart' to analyze and visualize the + number of companies per industry in a specific country, considering optional parameters + like market cap, excluding international exchanges, maximum industries to display + and more. +keywords: +- cpic +- openbb_terminal documentation +- sector industry analysis +- Number of companies per industry +- Finance Database +- Market Cap +- Excluding international exchanges +- Data visualization +- Parameter description +- Returns +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + +Get number of companies per industry in a specific country (and specific market cap). + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/stocks/sector_industry_analysis/financedatabase_model.py#L255)] + +```python +openbb.stocks.sia.cpic(country: str = "United States", mktcap: str = "Large", exclude_exchanges: bool = True) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| country | str | Select country to get number of companies by each industry | United States | True | +| mktcap | str | Select market cap of companies to consider from Small, Mid and Large | Large | True | +| exclude_exchanges | bool | Exclude international exchanges | True | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| dict | Dictionary of industries and number of companies in a specific country | +--- + + + + +Display number of companies per industry in a specific country. [Source: Finance Database] + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/stocks/sector_industry_analysis/financedatabase_view.py#L376)] + +```python +openbb.stocks.sia.cpic_chart(country: str = "United States", mktcap: str = "Large", exclude_exchanges: bool = True, export: str = "", raw: bool = False, max_industries_to_display: int = 15, min_pct_to_display_industry: float = 0.015, external_axes: Optional[List[matplotlib.axes._axes.Axes]] = None) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| country | str | Select country to get number of companies by each industry | United States | True | +| mktcap | str | Select market cap of companies to consider from Small, Mid and Large | Large | True | +| exclude_exchanges | bool | Exclude international exchanges | True | True | +| export | str | Format to export data as | | True | +| raw | bool | Output all raw data | False | True | +| max_industries_to_display | int | Maximum number of industries to display | 15 | True | +| min_pct_to_display_industry | float | Minimum percentage to display industry | 0.015 | True | +| external_axes | Optional[List[plt.Axes]] | External axes (1 axis is expected in the list), by default None | None | True | + + +--- + +## Returns + +This function does not return anything + +--- + + + diff --git a/website/content/sdk/reference/stocks/sia/cpis.md b/website/content/sdk/reference/stocks/sia/cpis.md new file mode 100644 index 000000000000..066380b72fd1 --- /dev/null +++ b/website/content/sdk/reference/stocks/sia/cpis.md @@ -0,0 +1,92 @@ +--- +title: cpis +description: cpis and cpis_chart functions are powerful tools in the OpenBBTerminal + that inform about the number of companies per industry in a specific sector and + market cap, and visualise the data respectively. +keywords: +- cpis +- cpis_chart +- sector analysis +- industry analysis +- company information +- data visualization +- market capitalization +- stock analysis +- technology industry +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + +Get number of companies per industry in a specific sector (and specific market cap). + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/stocks/sector_industry_analysis/financedatabase_model.py#L309)] + +```python +openbb.stocks.sia.cpis(sector: str = "Technology", mktcap: str = "Large", exclude_exchanges: bool = True) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| sector | str | Select sector to get number of companies by each industry | Technology | True | +| mktcap | str | Select market cap of companies to consider from Small, Mid and Large | Large | True | +| exclude_exchanges | bool | Exclude international exchanges | True | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| dict | Dictionary of industries and number of companies in a specific sector | +--- + + + + +Display number of companies per industry in a specific sector. [Source: Finance Database] + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/stocks/sector_industry_analysis/financedatabase_view.py#L525)] + +```python +openbb.stocks.sia.cpis_chart(sector: str = "Technology", mktcap: str = "Large", exclude_exchanges: bool = True, export: str = "", raw: bool = False, max_industries_to_display: int = 15, min_pct_to_display_industry: float = 0.015, external_axes: Optional[List[matplotlib.axes._axes.Axes]] = None) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| sector | str | Select sector to get number of companies by each industry | Technology | True | +| mktcap | str | Select market cap of companies to consider from Small, Mid and Large | Large | True | +| exclude_exchanges | bool | Exclude international exchanges | True | True | +| export | str | Format to export data as | | True | +| raw | bool | Output all raw data | False | True | +| max_industries_to_display | int | Maximum number of industries to display | 15 | True | +| min_pct_to_display_industry | float | Minimum percentage to display industry | 0.015 | True | +| external_axes | Optional[List[plt.Axes]] | External axes (1 axis is expected in the list), by default None | None | True | + + +--- + +## Returns + +This function does not return anything + +--- + + + diff --git a/website/content/sdk/reference/stocks/sia/cps.md b/website/content/sdk/reference/stocks/sia/cps.md new file mode 100644 index 000000000000..9e541cf7af1f --- /dev/null +++ b/website/content/sdk/reference/stocks/sia/cps.md @@ -0,0 +1,93 @@ +--- +title: cps +description: A docusaurus documentation page detailing the usage of the 'cps' and + 'cps_chart' functions within the OpenBB marketing terminal. The functions pertain + to the analysis of companies per sector in a specific country and market cap +keywords: +- docusaurus +- cps +- cps_chart +- OpenBB terminal +- sector industry analysis +- finance database +- stock market +- metadata +- market cap analysis +- company analysis +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + +Get number of companies per sector in a specific country (and specific market cap). [Source: Finance Database] + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/stocks/sector_industry_analysis/financedatabase_model.py#L205)] + +```python +openbb.stocks.sia.cps(country: str = "United States", mktcap: str = "Large", exclude_exchanges: bool = True) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| country | str | Select country to get number of companies by each sector | United States | True | +| mktcap | str | Select market cap of companies to consider from Small, Mid and Large | Large | True | +| exclude_exchanges | bool | Exclude international exchanges | True | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| dict | Dictionary of sectors and number of companies in a specific country | +--- + + + + +Display number of companies per sector in a specific country (and market cap). [Source: Finance Database] + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/stocks/sector_industry_analysis/financedatabase_view.py#L238)] + +```python +openbb.stocks.sia.cps_chart(country: str = "United States", mktcap: str = "Large", exclude_exchanges: bool = True, export: str = "", raw: bool = False, max_sectors_to_display: int = 15, min_pct_to_display_sector: float = 0.015, external_axes: Optional[List[matplotlib.axes._axes.Axes]] = None) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| country | str | Select country to get number of companies by each sector | United States | True | +| mktcap | str | Select market cap of companies to consider from Small, Mid and Large | Large | True | +| exclude_exchanges | bool | Exclude international exchanges | True | True | +| export | str | Format to export data as | | True | +| raw | bool | Output all raw data | False | True | +| max_sectors_to_display | int | Maximum number of sectors to display | 15 | True | +| min_pct_to_display_sector | float | Minimum percentage to display sector | 0.015 | True | +| external_axes | Optional[List[plt.Axes]] | External axes (1 axis is expected in the list), by default None | None | True | + + +--- + +## Returns + +This function does not return anything + +--- + + + diff --git a/website/content/sdk/reference/stocks/sia/filter_stocks.md b/website/content/sdk/reference/stocks/sia/filter_stocks.md new file mode 100644 index 000000000000..704c136f7018 --- /dev/null +++ b/website/content/sdk/reference/stocks/sia/filter_stocks.md @@ -0,0 +1,51 @@ +--- +title: filter_stocks +description: This page provides an in-depth look into the function 'filter_stocks' + used for filtering stocks based on various parameters like country, sector, industry, + and market cap, and excluding specific exchanges. Understand the usage and benefits + of this functionality in stock filtering. +keywords: +- filter stocks +- stock filters +- stock filtering +- finance database +- sector stocks +- industry stocks +- market cap +- stock exchange +- filter by country +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Filter stocks based on country, sector, industry, market cap and exclude exchanges. + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/stocks/sector_industry_analysis/financedatabase_model.py#L109)] + +```python +openbb.stocks.sia.filter_stocks(country: str = None, sector: str = None, industry: str = None, marketcap: str = "", exclude_exchanges: bool = True) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| country | str | Search by country to find stocks matching the criteria. | None | True | +| sector | str | Search by sector to find stocks matching the criteria. | None | True | +| industry | str | Search by industry to find stocks matching the criteria. | None | True | +| marketcap | str | Select stocks based on the market cap. | | True | +| exclude_exchanges | bool | When you wish to include different exchanges use this boolean. | True | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| list | List of filtered stocks | +--- diff --git a/website/content/sdk/reference/stocks/sia/industries.md b/website/content/sdk/reference/stocks/sia/industries.md new file mode 100644 index 000000000000..98cf2bff2081 --- /dev/null +++ b/website/content/sdk/reference/stocks/sia/industries.md @@ -0,0 +1,45 @@ +--- +title: industries +description: The documentation page provides information and source code on how to + get all industries in Yahoo Finance data based on country or sector. This is part + of the OpenBBTerminal project. +keywords: +- Finance Database +- Yahoo Finance data +- openbb.stocks.sia.industries +- industries +- country filter +- sector filter +- sector analysis +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Get all industries in Yahoo Finance data based on country or sector. [Source: Finance Database] + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/stocks/sector_industry_analysis/financedatabase_model.py#L69)] + +```python +openbb.stocks.sia.industries(country: str = "", sector: str = "") +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| country | str | Filter retrieved industries by country | | True | +| sector | str | Filter retrieved industries by sector | | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| list | List of possible industries | +--- diff --git a/website/content/sdk/reference/stocks/sia/maketcap.md b/website/content/sdk/reference/stocks/sia/maketcap.md new file mode 100644 index 000000000000..9c51fe8a8720 --- /dev/null +++ b/website/content/sdk/reference/stocks/sia/maketcap.md @@ -0,0 +1,42 @@ +--- +title: maketcap +description: Detailed documentation on the 'maketcap' function in the OpenBB finance + database model. The page provides information on the function, including its source + code, parameters (if any), and the values it returns. +keywords: +- market cap +- Yahoo Finance +- Finance Database +- stocks +- finance data analysis +- function +- parameters +- returns +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Get all market cap division in Yahoo Finance data. [Source: Finance Database] + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/stocks/sector_industry_analysis/financedatabase_model.py#L97)] + +```python +openbb.stocks.sia.maketcap() +``` + +--- + +## Parameters + +This function does not take any parameters. + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| list | List of possible market caps | +--- diff --git a/website/content/sdk/reference/stocks/sia/sectors.md b/website/content/sdk/reference/stocks/sia/sectors.md new file mode 100644 index 000000000000..3d4ec074d0d0 --- /dev/null +++ b/website/content/sdk/reference/stocks/sia/sectors.md @@ -0,0 +1,44 @@ +--- +title: sectors +description: This documentation page offers details on how to retrieve all sectors + in Yahoo Finance data based on criteria such as country or industry. The source + code and the parameters for the function are provided. +keywords: +- Yahoo Finance data +- Finance Database +- Sector analysis +- Industry filter +- Country filter +- Stocks +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Get all sectors in Yahoo Finance data based on country or industry. [Source: Finance Database] + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/stocks/sector_industry_analysis/financedatabase_model.py#L44)] + +```python +openbb.stocks.sia.sectors(industry: str = "", country: str = "") +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| industry | str | Filter retrieved sectors by industry | | True | +| country | str | Filter retrieved sectors by country | | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| list | List of possible sectors | +--- diff --git a/website/versioned_docs/version-v3/sdk/reference/stocks/sia/stocks_data.md b/website/content/sdk/reference/stocks/sia/stocks_data.md similarity index 75% rename from website/versioned_docs/version-v3/sdk/reference/stocks/sia/stocks_data.md rename to website/content/sdk/reference/stocks/sia/stocks_data.md index 22f32ed9251e..a72576bee646 100644 --- a/website/versioned_docs/version-v3/sdk/reference/stocks/sia/stocks_data.md +++ b/website/content/sdk/reference/stocks/sia/stocks_data.md @@ -1,9 +1,20 @@ --- title: stocks_data -description: OpenBB SDK Function +description: This page offers in-depth documentation on how to use the 'stocks_data' + function in the OpenBBTerminal's stock analysis tool, detailing parameters, returns + and source code. +keywords: +- stock data +- finance key +- financial statement +- stock analysis +- programming +- code documentation --- -# stocks_data +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + Get stocks data based on a list of stocks and the finance key. The function searches for the @@ -34,4 +45,3 @@ openbb.stocks.sia.stocks_data(symbols: List[str] = None, finance_key: str = "ncf | ---- | ----------- | | dict | Dictionary of filtered stocks data separated by financial statement | --- - diff --git a/website/content/sdk/reference/stocks/ta/recom.md b/website/content/sdk/reference/stocks/ta/recom.md new file mode 100644 index 000000000000..15afb11b64d1 --- /dev/null +++ b/website/content/sdk/reference/stocks/ta/recom.md @@ -0,0 +1,90 @@ +--- +title: recom +description: This page offers details on tradingview recommendations based on technical + indicators with an emphasis on Model and Chart tabs. This includes information on + parameters, returns, and source code. +keywords: +- Tradingview recommendation +- Technical indicators +- Model +- Chart +- Parameters +- Returns +- Source code +- Stocks +- Tradingview TA +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + +Get tradingview recommendation based on technical indicators + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/stocks/technical_analysis/tradingview_model.py#L56)] + +```python +openbb.stocks.ta.recom(symbol: str, screener: str = "america", exchange: str = "", interval: str = "") +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| symbol | str | Ticker symbol to get the recommendation from tradingview based on technical indicators | None | False | +| screener | str | Screener based on tradingview docs https://python-tradingview-ta.readthedocs.io/en/latest/usage.html | america | True | +| exchange | str | Exchange based on tradingview docs https://python-tradingview-ta.readthedocs.io/en/latest/usage.html | | True | +| interval | str | Interval time to check technical indicators and correspondent recommendation | | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | Dataframe of tradingview recommendations based on technical indicators | +--- + + + + +Print tradingview recommendation based on technical indicators + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/stocks/technical_analysis/tradingview_view.py#L17)] + +```python +openbb.stocks.ta.recom_chart(symbol: str, screener: str = "america", exchange: str = "", interval: str = "", export: str = "") +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| symbol | str | Ticker symbol to get tradingview recommendation based on technical indicators | None | False | +| screener | str | Screener based on tradingview docs https://python-tradingview-ta.readthedocs.io/en/latest/usage.html | america | True | +| exchange | str | Exchange based on tradingview docs https://python-tradingview-ta.readthedocs.io/en/latest/usage.html | | True | +| interval | str | Interval time to check technical indicators and correspondent recommendation | | True | +| export | str | Format of export file | | True | + + +--- + +## Returns + +This function does not return anything + +--- + + + diff --git a/website/content/sdk/reference/stocks/ta/summary.md b/website/content/sdk/reference/stocks/ta/summary.md new file mode 100644 index 000000000000..63c621b21b0a --- /dev/null +++ b/website/content/sdk/reference/stocks/ta/summary.md @@ -0,0 +1,82 @@ +--- +title: summary +description: The page contains two essential open-source tools, FinBrain's model for + technical summary reports and a viewer for those reports. Learn how to populate + a technical summary and how to view a summary chart. +keywords: +- Open-source tools +- FinBrain model +- Technical summary reports +- Summary chart +- OpenBB's API +- Stocks +- Ticker symbol +- Technical Analysis +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + +Get technical summary report provided by FinBrain's API + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/stocks/technical_analysis/finbrain_model.py#L15)] + +```python +openbb.stocks.ta.summary(symbol: str) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| symbol | str | Ticker symbol to get the technical summary | None | False | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| str | technical summary report | +--- + + + + +Print technical summary report provided by FinBrain's API + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/stocks/technical_analysis/finbrain_view.py#L14)] + +```python +openbb.stocks.ta.summary_chart(symbol: str) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| symbol | str | Ticker symbol to get the technical summary | None | False | + + +--- + +## Returns + +This function does not return anything + +--- + + + diff --git a/website/content/sdk/reference/stocks/ta/view.md b/website/content/sdk/reference/stocks/ta/view.md new file mode 100644 index 000000000000..50b649fe825d --- /dev/null +++ b/website/content/sdk/reference/stocks/ta/view.md @@ -0,0 +1,79 @@ +--- +title: view +description: Technical analysis with OpenBB - Learn how to use finviz model and view + chart using stock ticker. Detailed examples, parameters, and source code included. +keywords: +- technical analysis +- finviz model +- view chart +- stock ticker +- matplotlib +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + +Get finviz image for given ticker + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/stocks/technical_analysis/finviz_model.py#L16)] + +```python +openbb.stocks.ta.view(symbol: str) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| symbol | str | Ticker symbol | None | False | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| bytes | Image in byte format | +--- + + + + +View finviz image for ticker + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/stocks/technical_analysis/finviz_view.py#L22)] + +```python +openbb.stocks.ta.view_chart(symbol: str, external_axes: Optional[List[matplotlib.axes._axes.Axes]] = None) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| symbol | str | Stock ticker symbol | None | False | +| external_axes | Optional[List[plt.Axes]] | External axes (1 axis is expected in the list), by default None | None | True | + + +--- + +## Returns + +This function does not return anything + +--- + + + diff --git a/website/content/sdk/reference/stocks/th/all.md b/website/content/sdk/reference/stocks/th/all.md new file mode 100644 index 000000000000..c06586cbe168 --- /dev/null +++ b/website/content/sdk/reference/stocks/th/all.md @@ -0,0 +1,77 @@ +--- +title: all +description: Documentation detail of OpenBB's all exchanges and chart display functions. + OpenBB provides functionalities to fetch all available exchanges and display them + in a chart format. +keywords: +- OpenBB Documentation +- OpenBB Exchanges API +- OpenBB Chart Display +- Python scripts +- API Documentation +- Open source financial tools +- OpenBB Source Code +- Stock Exchange Data +- Extracting Exchange Data +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + +Get all exchanges. + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/stocks/tradinghours/bursa_model.py#L98)] + +```python +openbb.stocks.th.all() +``` + +--- + +## Parameters + +This function does not take any parameters. + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | All available exchanges | +--- + + + + +Display all exchanges. + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/stocks/tradinghours/bursa_view.py#L84)] + +```python +openbb.stocks.th.all_chart() +``` + +--- + +## Parameters + +This function does not take any parameters. + +--- + +## Returns + +This function does not return anything + +--- + + + diff --git a/website/content/sdk/reference/stocks/th/check_if_open.md b/website/content/sdk/reference/stocks/th/check_if_open.md new file mode 100644 index 000000000000..c474fe556194 --- /dev/null +++ b/website/content/sdk/reference/stocks/th/check_if_open.md @@ -0,0 +1,41 @@ +--- +title: check_if_open +description: SEO metadata for a Python function 'check_if_open' within OpenBB-finance's + OpenBBTerminal. This function checks if a particular market (Bursa) is open for + trading. +keywords: +- OpenBB-finance +- Stocks +- Trading hours +- Bursa +- Check market open +- Source code +- pandas +- Exchange +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Check if market open helper function + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/stocks/tradinghours/bursa_model.py#L156)] + +```python +openbb.stocks.th.check_if_open(bursa: pd.DataFrame, exchange: str) +``` + +--- + +## Parameters + +This function does not take any parameters. + +--- + +## Returns + +This function does not return anything + +--- diff --git a/website/content/sdk/reference/stocks/th/closed.md b/website/content/sdk/reference/stocks/th/closed.md new file mode 100644 index 000000000000..643aa021af0d --- /dev/null +++ b/website/content/sdk/reference/stocks/th/closed.md @@ -0,0 +1,74 @@ +--- +title: closed +description: The page provides information on the two functions `openbb.stocks.th.closed()` + and `openbb.stocks.th.closed_chart()`. The first function is for getting currently + closed exchanges which returns a pd.DataFrame. The second function is for displaying + closed exchanges but does not return anything. +keywords: +- closed exchanges +- Stocks +- Trading hours +- openbb.stocks.th.closed() +- openbb.stocks.th.closed_chart() +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + +Get closed exchanges. + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/stocks/tradinghours/bursa_model.py#L76)] + +```python +openbb.stocks.th.closed() +``` + +--- + +## Parameters + +This function does not take any parameters. + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | Currently closed exchanges | +--- + + + + +Display closed exchanges. + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/stocks/tradinghours/bursa_view.py#L64)] + +```python +openbb.stocks.th.closed_chart() +``` + +--- + +## Parameters + +This function does not take any parameters. + +--- + +## Returns + +This function does not return anything + +--- + + + diff --git a/website/content/sdk/reference/stocks/th/exchange.md b/website/content/sdk/reference/stocks/th/exchange.md new file mode 100644 index 000000000000..2ad86e803d32 --- /dev/null +++ b/website/content/sdk/reference/stocks/th/exchange.md @@ -0,0 +1,83 @@ +--- +title: exchange +description: This documentation page provides details on the 'exchange' function of + the OpenBB platform. This includes the model function for acquiring current exchange + open hours, and the view function for displaying these hours. The page provides + information on source codes, parameters and return values. +keywords: +- exchange +- trading hours +- model +- view +- chart +- parameters +- returns +- dataframe +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + +Get current exchange open hours. + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/stocks/tradinghours/bursa_model.py#L20)] + +```python +openbb.stocks.th.exchange(symbol: str) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| symbol | str | Exchange symbol | None | False | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | Exchange info | +--- + + + + +Display current exchange trading hours. + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/stocks/tradinghours/bursa_view.py#L15)] + +```python +openbb.stocks.th.exchange_chart(symbol: str) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| symbol | str | Exchange symbol | None | False | + + +--- + +## Returns + +This function does not return anything + +--- + + + diff --git a/website/content/sdk/reference/stocks/th/open.md b/website/content/sdk/reference/stocks/th/open.md new file mode 100644 index 000000000000..2ff53dde39f3 --- /dev/null +++ b/website/content/sdk/reference/stocks/th/open.md @@ -0,0 +1,74 @@ +--- +title: open +description: Documentation page offering extensive details on how 'open' feature functions + in OpenBB finance and their source code. This feature showcases open exchanges and + how to display them. +keywords: +- Finance Software +- Open +- Exchanges +- Trading hours +- Documentation +- Source code +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + +Get open exchanges. + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/stocks/tradinghours/bursa_model.py#L54)] + +```python +openbb.stocks.th.open() +``` + +--- + +## Parameters + +This function does not take any parameters. + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | Currently open exchanges | +--- + + + + +Display open exchanges. + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/stocks/tradinghours/bursa_view.py#L44)] + +```python +openbb.stocks.th.open_chart() +``` + +--- + +## Parameters + +This function does not take any parameters. + +--- + +## Returns + +This function does not return anything + +--- + + + diff --git a/website/content/sdk/reference/stocks/tob.md b/website/content/sdk/reference/stocks/tob.md new file mode 100644 index 000000000000..9128389ace28 --- /dev/null +++ b/website/content/sdk/reference/stocks/tob.md @@ -0,0 +1,48 @@ +--- +title: tob +description: Get top of book bid and ask for any ticker on the CBOE exchange using + the OpenBB Terminal. Default exchange is BZX, but can be changed to EDGX, BYX, or + EDGA. Returns a Dataframe of Bids. +keywords: +- Top of Book bid +- Ask for ticker +- CBOE +- BZX +- EDGX +- BYX +- EDGA +- OpenBB Stocks +- Dataframe of Bids +- OpenBB finance +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Get top of book bid and ask for ticker on exchange [CBOE.com] + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/stocks/cboe_model.py#L12)] + +```python +openbb.stocks.tob(symbol: str, exchange: str = "BZX") +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| symbol | str | Ticker to get | None | False | +| exchange | str | Exchange to look at. Can be `BZX`,`EDGX`, `BYX`, `EDGA` | BZX | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DatatFrame | Dataframe of Bids | +--- diff --git a/website/content/sdk/reference/ta/ad.md b/website/content/sdk/reference/ta/ad.md new file mode 100644 index 000000000000..13d38a3c90ab --- /dev/null +++ b/website/content/sdk/reference/ta/ad.md @@ -0,0 +1,85 @@ +--- +title: ad +description: This page provides information about how to implement and plot the AD + (Accumulation/Distribution Line) technical indicator using OpenBB's Python module. + It includes the source code, required parameters, and the outputs from these functions. +keywords: +- Docusaurus +- Metadata +- Technical Indicator +- AD indicator +- Pandas DataFrame +- Chart +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + +Calculate AD technical indicator + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/common/technical_analysis/volume_model.py#L17)] + +```python +openbb.ta.ad(data: pd.DataFrame, use_open: bool = False) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| data | pd.DataFrame | Dataframe of prices with OHLC and Volume | None | False | +| use_open | bool | Whether to use open prices | False | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | Dataframe with technical indicator | +--- + + + + +Plots AD technical indicator + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/common/technical_analysis/volume_view.py#L28)] + +```python +openbb.ta.ad_chart(data: pd.DataFrame, use_open: bool = False, symbol: str = "", export: str = "", external_axes: Optional[List[matplotlib.axes._axes.Axes]] = None) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| data | pd.DataFrame | Dataframe of ohlc prices | None | False | +| use_open | bool | Whether to use open prices in calculation | False | True | +| symbol | str | Ticker symbol | | True | +| export | str | Format to export data as | | True | +| external_axes | Optional[List[plt.Axes]] | External axes (3 axes are expected in the list), by default None | None | True | + + +--- + +## Returns + +This function does not return anything + +--- + + + diff --git a/website/content/sdk/reference/ta/adosc.md b/website/content/sdk/reference/ta/adosc.md new file mode 100644 index 000000000000..c7b991a1c308 --- /dev/null +++ b/website/content/sdk/reference/ta/adosc.md @@ -0,0 +1,93 @@ +--- +title: adosc +description: Technical page discussing the calculation and plotting of the AD Oscillator + technical indicator. The page also includes links to source code and parameter descriptions. +keywords: +- AD Oscillator +- technical indicator +- parameter description +- calculate +- plot +- technical analysis +- fast value +- slow value +- volume model +- TabItem +- docusaurus +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + +Calculate AD oscillator technical indicator + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/common/technical_analysis/volume_model.py#L46)] + +```python +openbb.ta.adosc(data: pd.DataFrame, use_open: bool = False, fast: int = 3, slow: int = 10) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| data | pd.DataFrame | Dataframe of OHLC prices | None | False | +| use_open | bool | Whether to use open prices | False | True | +| fast | int | Fast value | 3 | True | +| slow | int | Slow value | 10 | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | Dataframe with technical indicator | +--- + + + + +Plots AD Osc Indicator + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/common/technical_analysis/volume_view.py#L141)] + +```python +openbb.ta.adosc_chart(data: pd.DataFrame, fast: int = 3, slow: int = 10, use_open: bool = False, symbol: str = "", export: str = "", external_axes: Optional[List[matplotlib.axes._axes.Axes]] = None) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| data | pd.DataFrame | Dataframe of ohlc prices | None | False | +| use_open | bool | Whether to use open prices in calculation | False | True | +| fast | int | Length of fast window | 3 | True | +| slow | int | Length of slow window | 10 | True | +| symbol | str | Stock ticker | | True | +| export | str | Format to export data | | True | +| external_axes | Optional[List[plt.Axes]] | External axes (3 axes are expected in the list), by default None | None | True | + + +--- + +## Returns + +This function does not return anything + +--- + + + diff --git a/website/content/sdk/reference/ta/adx.md b/website/content/sdk/reference/ta/adx.md new file mode 100644 index 000000000000..2a8d23dd414b --- /dev/null +++ b/website/content/sdk/reference/ta/adx.md @@ -0,0 +1,88 @@ +--- +title: adx +description: This page provides extensive information about the ADX technical indicator, + including parameters, returns, and usage. It shares Python source codes for implementing + and visualising the ADX technical indicator on OHLC price data using OpenBBTerminal. +keywords: +- ADX technical indicator +- Dataframe with OHLC price data +- Technical Analysis +- ADX chart +- Plot ADX Indicator +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + +ADX technical indicator + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/common/technical_analysis/trend_indicators_model.py#L16)] + +```python +openbb.ta.adx(data: pd.DataFrame, window: int = 14, scalar: int = 100, drift: int = 1) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| data | pd.DataFrame | Dataframe with OHLC price data | None | False | +| window | int | Length of window | 14 | True | +| scalar | int | Scalar variable | 100 | True | +| drift | int | Drift variable | 1 | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | DataFrame with adx indicator | +--- + + + + +Plots ADX indicator + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/common/technical_analysis/trend_indicators_view.py#L30)] + +```python +openbb.ta.adx_chart(data: pd.DataFrame, window: int = 14, scalar: int = 100, drift: int = 1, symbol: str = "", export: str = "", external_axes: Optional[List[matplotlib.axes._axes.Axes]] = None) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| data | pd.DataFrame | Dataframe with OHLC price data | None | False | +| window | int | Length of window | 14 | True | +| scalar | int | Scalar variable | 100 | True | +| drift | int | Drift variable | 1 | True | +| symbol | str | Ticker | | True | +| export | str | Format to export data | | True | +| external_axes | Optional[List[plt.Axes]] | External axes (2 axes are expected in the list), by default None | None | True | + + +--- + +## Returns + +This function does not return anything + +--- + + + diff --git a/website/content/sdk/reference/ta/aroon.md b/website/content/sdk/reference/ta/aroon.md new file mode 100644 index 000000000000..b827d4905c78 --- /dev/null +++ b/website/content/sdk/reference/ta/aroon.md @@ -0,0 +1,96 @@ +--- +title: aroon +description: This documentation page provides an in-depth overview of the Aroon technical + indicator within the OpenBBTerminal. It covers the model and chart view of the Aroon + indicator, with detailed parameters and source code. It also provides the functionality + to plot the Aroon indicator and export data. +keywords: +- aroon +- technical indicator +- openbb.ta +- openbb.ta.aroon +- openbb.ta.aroon_chart +- trend indicators +- OHLC price data +- plotting +- matplotlib +- axes +- scalar +- window +- symbol +- export +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + +Aroon technical indicator + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/common/technical_analysis/trend_indicators_model.py#L56)] + +```python +openbb.ta.aroon(data: pd.DataFrame, window: int = 25, scalar: int = 100) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| data | pd.DataFrame | Dataframe with OHLC price data | None | False | +| window | int | Length of window | 25 | True | +| scalar | int | Scalar variable | 100 | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | DataFrame with aroon indicator | +--- + + + + +Plots Aroon indicator + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/common/technical_analysis/trend_indicators_view.py#L121)] + +```python +openbb.ta.aroon_chart(data: pd.DataFrame, window: int = 25, scalar: int = 100, symbol: str = "", export: str = "", external_axes: Optional[List[matplotlib.axes._axes.Axes]] = None) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| data | pd.DataFrame | Dataframe with OHLC price data | None | False | +| window | int | Length of window | 25 | True | +| symbol | str | Ticker | | True | +| scalar | int | Scalar variable | 100 | True | +| export | str | Format to export data | | True | +| external_axes | Optional[List[plt.Axes]] | External axes (3 axes are expected in the list), by default None | None | True | + + +--- + +## Returns + +This function does not return anything + +--- + + + diff --git a/website/content/sdk/reference/ta/atr.md b/website/content/sdk/reference/ta/atr.md new file mode 100644 index 000000000000..e6a3d0e0c927 --- /dev/null +++ b/website/content/sdk/reference/ta/atr.md @@ -0,0 +1,89 @@ +--- +title: atr +description: This page provides detailed documentation on the Average True Range (ATR) + feature in the OpenBB terminal. It includes descriptions and code examples for both + the volatility model and view, with an emphasis on working with OHLC price dataframes. + The page also hosts links to the source code on GitHub. +keywords: +- ATR +- Average True Range +- Technical Analysis +- Volatility Model +- Volatility View +- OHLC Prices +- Documentation +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + +Average True Range + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/common/technical_analysis/volatility_model.py#L132)] + +```python +openbb.ta.atr(data: pd.DataFrame, window: int = 14, mamode: str = "ema", offset: int = 0) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| data | pd.DataFrame | Dataframe of ohlc prices | None | False | +| window | int | Length of window | 14 | True | +| mamode | str | Type of filter | ema | True | +| offset | int | Offset value | 0 | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | Dataframe of atr | +--- + + + + +Plots ATR + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/common/technical_analysis/volatility_view.py#L289)] + +```python +openbb.ta.atr_chart(data: pd.DataFrame, symbol: str = "", window: int = 14, mamode: str = "sma", offset: int = 0, export: str = "", external_axes: Optional[List[matplotlib.axes._axes.Axes]] = None) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| data | pd.DataFrame | Dataframe of ohlc prices | None | False | +| symbol | str | Ticker symbol | | True | +| window | int | Length of window to calculate upper channel | 14 | True | +| export | str | Format of export file | | True | +| external_axes | Optional[List[plt.Axes]] | External axes (1 axis is expected in the list), by default None | None | True | + + +--- + +## Returns + +This function does not return anything + +--- + + + diff --git a/website/content/sdk/reference/ta/bbands.md b/website/content/sdk/reference/ta/bbands.md new file mode 100644 index 000000000000..75ea241efe00 --- /dev/null +++ b/website/content/sdk/reference/ta/bbands.md @@ -0,0 +1,90 @@ +--- +title: bbands +description: This documentation is about the 'bbands' function in the OpenBB finance + library. It allows users to calculate and plot Bollinger Bands for financial data, + providing multiple parameters for customization. +keywords: +- OpenBB finance library +- Bollinger Bands +- Financial data analysis +- Python financial tools +- Technical analysis +- Volatility models +- Financial chart plotting +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + +Calculate Bollinger Bands + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/common/technical_analysis/volatility_model.py#L18)] + +```python +openbb.ta.bbands(data: pd.DataFrame, window: int = 15, n_std: float = 2, mamode: str = "ema") +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| data | pd.DataFrame | Dataframe of ohlc prices | None | False | +| window | int | Length of window to calculate BB | 15 | True | +| n_std | float | Number of standard deviations to show | 2 | True | +| mamode | str | Method of calculating average | ema | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | Dataframe of bollinger band data | +--- + + + + +Plots bollinger bands + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/common/technical_analysis/volatility_view.py#L27)] + +```python +openbb.ta.bbands_chart(data: pd.DataFrame, symbol: str = "", window: int = 15, n_std: float = 2, mamode: str = "sma", export: str = "", external_axes: Optional[List[matplotlib.axes._axes.Axes]] = None) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| data | pd.DataFrame | Dataframe of ohlc prices | None | False | +| symbol | str | Ticker symbol | | True | +| window | int | Length of window to calculate BB | 15 | True | +| n_std | float | Number of standard deviations to show | 2 | True | +| mamode | str | Method of calculating average | sma | True | +| export | str | Format of export file | | True | +| external_axes | Optional[List[plt.Axes]] | External axes (1 axis is expected in the list), by default None | None | True | + + +--- + +## Returns + +This function does not return anything + +--- + + + diff --git a/website/content/sdk/reference/ta/cci.md b/website/content/sdk/reference/ta/cci.md new file mode 100644 index 000000000000..6bae19624399 --- /dev/null +++ b/website/content/sdk/reference/ta/cci.md @@ -0,0 +1,91 @@ +--- +title: cci +description: This page provides information on the Commodity Channel Index (CCI) utility + as part of the OpenBB platform. It comprises details about the technical model, + related parameters, expected returns, and source code linked to Github. Also includes + instructions for plotting CCI Indicator. +keywords: +- CCI +- Commodity channel index +- technical indicator +- dataframe +- Source code +- Parameters +- Returns +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + +Commodity channel index + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/common/technical_analysis/momentum_model.py#L20)] + +```python +openbb.ta.cci(data: pd.DataFrame, window: int = 14, scalar: float = 0.0015) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| high_vals | pd.Series | High values | None | True | +| low_values | pd.Series | Low values | None | True | +| close-values | pd.Series | Close values | None | True | +| window | int | Length of window | 14 | True | +| scalar | float | Scalar variable | 0.0015 | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | Dataframe of technical indicator | +--- + + + + +Plots CCI Indicator + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/common/technical_analysis/momentum_view.py#L34)] + +```python +openbb.ta.cci_chart(data: pd.DataFrame, window: int = 14, scalar: float = 0.0015, symbol: str = "", export: str = "", external_axes: Optional[List[matplotlib.axes._axes.Axes]] = None) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| data | pd.DataFrame | Dataframe of OHLC | None | False | +| window | int | Length of window | 14 | True | +| scalar | float | Scalar variable | 0.0015 | True | +| symbol | str | Stock ticker | | True | +| export | str | Format to export data | | True | +| external_axes | Optional[List[plt.Axes]] | External axes (2 axes are expected in the list), by default None | None | True | + + +--- + +## Returns + +This function does not return anything + +--- + + + diff --git a/website/content/sdk/reference/ta/cg.md b/website/content/sdk/reference/ta/cg.md new file mode 100644 index 000000000000..9557b124a6c5 --- /dev/null +++ b/website/content/sdk/reference/ta/cg.md @@ -0,0 +1,87 @@ +--- +title: cg +description: Documentation for Center of Gravity Indicator function 'cg' and its graphical + representation 'cg_chart' in the OpenBB Terminal. Explanation of their source code, + parameters, and returns are covered. +keywords: +- Center of Gravity Indicator +- Technical Analysis +- Source Code +- Parameters +- Returns +- Charts +- pd.Series +- matplotlib +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + +Center of gravity + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/common/technical_analysis/momentum_model.py#L189)] + +```python +openbb.ta.cg(values: pd.Series, window: int) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| values | pd.DataFrame | Data to use with close being titled values | None | False | +| window | int | Length for indicator window | None | False | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | Dataframe of technical indicator | +--- + + + + +Plots center of gravity Indicator + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/common/technical_analysis/momentum_view.py#L499)] + +```python +openbb.ta.cg_chart(data: pd.Series, window: int = 14, symbol: str = "", export: str = "", external_axes: Optional[List[matplotlib.axes._axes.Axes]] = None) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| data | pd.Series | Series of values | None | False | +| window | int | Length of window | 14 | True | +| symbol | str | Stock ticker | | True | +| export | str | Format to export data | | True | +| external_axes | Optional[List[plt.Axes]] | External axes (2 axes are expected in the list), by default None | None | True | + + +--- + +## Returns + +This function does not return anything + +--- + + + diff --git a/website/content/sdk/reference/ta/clenow.md b/website/content/sdk/reference/ta/clenow.md new file mode 100644 index 000000000000..b563a5cdb05d --- /dev/null +++ b/website/content/sdk/reference/ta/clenow.md @@ -0,0 +1,107 @@ +--- +title: clenow +description: This page offers thorough knowledge of Clenow Volatility Adjusted Momentum + model in OpenBB. It describes the function, parameters, returns and provides examples + of the feature in python code for aspiring users. +keywords: +- Clenow Volatility Adjusted Momentum +- Technical analysis +- Function description +- Parameters +- Python code example +- Data series +- Regression +- Momentum chart +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + +Gets the Clenow Volatility Adjusted Momentum. this is defined as the regression coefficient on log prices + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/common/technical_analysis/momentum_model.py#L207)] + +```python +openbb.ta.clenow(values: pd.Series, window: int = 90) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| values | pd.Series | Values to perform regression for | None | False | +| window | int | Length of lookback period | 90 | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| | R2 of fit to log data | +--- + +## Examples + +```python +from openbb_terminal.sdk import openbb +df = openbb.stocks.load("AAPL") +openbb.ta.clenow(df["Close"]) +``` + +--- + + + + +Prints table and plots clenow momentum + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/common/technical_analysis/momentum_view.py#L570)] + +```python +openbb.ta.clenow_chart(data: pd.Series, symbol: str = "", window: int = 90, export: str = "", external_axes: Optional[List[matplotlib.axes._axes.Axes]] = None) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| data | pd.Series | Series of values | None | False | +| symbol | str | Symbol that the data corresponds to | | True | +| window | int | Length of window | 90 | True | +| export | str | Format to export data | | True | +| external_axes | Optional[List[plt.Axes]] | External axes (2 axes are expected in the list), by default None | None | True | + + +--- + +## Returns + +This function does not return anything + +--- + +## Examples + +```python +from openbb_terminal.sdk import openbb +df = openbb.stocks.load("AAPL") +openbb.ta.clenow_chart(df["Close"]) +``` + +--- + + + diff --git a/website/content/sdk/reference/ta/demark.md b/website/content/sdk/reference/ta/demark.md new file mode 100644 index 000000000000..64e4edb1508a --- /dev/null +++ b/website/content/sdk/reference/ta/demark.md @@ -0,0 +1,107 @@ +--- +title: demark +description: This page provides comprehensive documentation on the demark sequential + indicator feature offered. It includes detailed source codes, parameters, returns, + and examples for users to understand how to get integer values for demark sequential + indicators, and also how to plot these indicators. +keywords: +- demark sequential indicator +- technical analysis +- plot indicators +- OpenBB terminal +- OpenBB finance +- GitHub link +- OpenBB stocks +- matplotlib.axes +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + +Get the integer value for demark sequential indicator + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/common/technical_analysis/momentum_model.py#L257)] + +```python +openbb.ta.demark(values: pd.Series) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| values | pd.Series | Series of close values | None | False | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | Dataframe of UP and DOWN sequential indicators | +--- + +## Examples + +```python +from openbb_terminal.sdk import openbb +df = openbb.stocks.load("AAPL") +openbb.ta.demark(df["Close"]) +``` + +--- + + + + +Plot demark sequential indicator + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/common/technical_analysis/momentum_view.py#L644)] + +```python +openbb.ta.demark_chart(data: pd.DataFrame, symbol: str = "", min_to_show: int = 5, export: str = "", external_axes: Optional[List[matplotlib.axes._axes.Axes]] = None) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| data | pd.DataFrame | DataFrame of values | None | False | +| symbol | str | Symbol that the data corresponds to | | True | +| min_to_show | int | Minimum value to show | 5 | True | +| export | str | Format to export data | | True | +| external_axes | Optional[List[plt.Axes]] | External axes (1 axes are expected in the list), by default None | None | True | + + +--- + +## Returns + +This function does not return anything + +--- + +## Examples + +```python +from openbb_terminal.sdk import openbb +df = openbb.stocks.load("AAPL") +openbb.ta.demark_chart(df) +``` + +--- + + + diff --git a/website/content/sdk/reference/ta/donchian.md b/website/content/sdk/reference/ta/donchian.md new file mode 100644 index 000000000000..cf84c62016f3 --- /dev/null +++ b/website/content/sdk/reference/ta/donchian.md @@ -0,0 +1,89 @@ +--- +title: donchian +description: This page provides comprehensive documentation on how to calculate and + plot Donchian Channels using OpenBB's technical analysis tools. Learn about the + parameters and return types to leverage this method in your financial modelling + work. +keywords: +- Donchian Channels +- Technical Analysis +- Financial Modelling +- FinTech +- Volatility Models +- Dataframes +- Data Visualization +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + +Calculate Donchian Channels + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/common/technical_analysis/volatility_model.py#L53)] + +```python +openbb.ta.donchian(data: pd.DataFrame, upper_length: int = 20, lower_length: int = 20) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| data | pd.DataFrame | Dataframe of ohlc prices | None | False | +| upper_length | int | Length of window to calculate upper channel | 20 | True | +| lower_length | int | Length of window to calculate lower channel | 20 | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | Dataframe of upper and lower channels | +--- + + + + +Plots donchian channels + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/common/technical_analysis/volatility_view.py#L112)] + +```python +openbb.ta.donchian_chart(data: pd.DataFrame, symbol: str = "", upper_length: int = 20, lower_length: int = 20, export: str = "", external_axes: Optional[List[matplotlib.axes._axes.Axes]] = None) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| data | pd.DataFrame | Dataframe of ohlc prices | None | False | +| symbol | str | Ticker symbol | | True | +| upper_length | int | Length of window to calculate upper channel | 20 | True | +| lower_length | int | Length of window to calculate lower channel | 20 | True | +| export | str | Format of export file | | True | +| external_axes | Optional[List[plt.Axes]] | External axes (1 axis is expected in the list), by default None | None | True | + + +--- + +## Returns + +This function does not return anything + +--- + + + diff --git a/website/content/sdk/reference/ta/ema.md b/website/content/sdk/reference/ta/ema.md new file mode 100644 index 000000000000..fe583a148ec2 --- /dev/null +++ b/website/content/sdk/reference/ta/ema.md @@ -0,0 +1,46 @@ +--- +title: ema +description: This page provides information on OpenBB's EMA (Exponential Moving Average) + functionality, a method often used in technical analysis of stocks. The mathematical + model's source code, parameters, and returns are clearly outlined. +keywords: +- ema +- exponential moving average +- technical analysis +- stock +- overlap model +- dataframe +- pd.Series +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Gets exponential moving average (EMA) for stock + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/common/technical_analysis/overlap_model.py#L19)] + +```python +openbb.ta.ema(data: pd.Series, length: int = 50, offset: int = 0) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| data | pd.Series | Dataframe of dates and prices | None | False | +| length | int | Length of EMA window | 50 | True | +| offset | int | Length of offset | 0 | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | Dataframe containing prices and EMA | +--- diff --git a/website/content/sdk/reference/ta/fib.md b/website/content/sdk/reference/ta/fib.md new file mode 100644 index 000000000000..325e9a1bf1b7 --- /dev/null +++ b/website/content/sdk/reference/ta/fib.md @@ -0,0 +1,91 @@ +--- +title: fib +description: This page serves as documentation for the Fibonacci levels calculation + model and its plotting function. Learn how to set parameters, define retracement + periods, and generate charts. +keywords: +- Fibonacci levels +- retracement periods +- Fibonacci documentation +- plotting function +- financial market analytics +- technical analysis +- data visualization +- Fibonacci levels chart +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + +Calculate Fibonacci levels + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/common/technical_analysis/custom_indicators_model.py#L17)] + +```python +openbb.ta.fib(data: pd.DataFrame, limit: int = 120, start_date: Any = None, end_date: Any = None) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| data | pd.DataFrame | Dataframe of prices | None | False | +| limit | int | Days to look back for retracement | 120 | True | +| start_date | Any | Custom start date for retracement | None | True | +| end_date | Any | Custom end date for retracement | None | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | Dataframe of fib levels | +--- + + + + +Plots Calculated fibonacci retracement levels + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/common/technical_analysis/custom_indicators_view.py#L29)] + +```python +openbb.ta.fib_chart(data: pd.DataFrame, limit: int = 120, start_date: Optional[str] = None, end_date: Optional[str] = None, symbol: str = "", export: str = "", external_axes: Optional[List[matplotlib.axes._axes.Axes]] = None) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| data | pd.DataFrame | OHLC data | None | False | +| limit | int | Days to lookback | 120 | True | +| start_date | Optional[str, None] | User picked date for starting retracement | None | True | +| end_date | Optional[str, None] | User picked date for ending retracement | None | True | +| symbol | str | Ticker symbol | | True | +| export | str | Format to export data | | True | +| external_axes | Optional[List[plt.Axes]] | External axes (2 axes are expected in the list), by default None | None | True | + + +--- + +## Returns + +This function does not return anything + +--- + + + diff --git a/website/content/sdk/reference/ta/fisher.md b/website/content/sdk/reference/ta/fisher.md new file mode 100644 index 000000000000..a0f72442eaa1 --- /dev/null +++ b/website/content/sdk/reference/ta/fisher.md @@ -0,0 +1,85 @@ +--- +title: fisher +description: Documentation page about Fisher Transform, a technical analysis indicator + used in finance. Detailed explanation on how to implement and use the Fisher Transform + indicator using the OpenBB library, with guides on parameters and returns for function + calls. +keywords: +- Fisher Transform +- technical analysis +- OpenBB library +- OHLC prices +- indicator window +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + +Fisher Transform + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/common/technical_analysis/momentum_model.py#L165)] + +```python +openbb.ta.fisher(data: pd.DataFrame, window: int = 14) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| data | pd.DataFrame | Dataframe of OHLC prices | None | False | +| window | int | Length for indicator window | 14 | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | Dataframe of technical indicator | +--- + + + + +Plots Fisher Indicator + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/common/technical_analysis/momentum_view.py#L406)] + +```python +openbb.ta.fisher_chart(data: pd.DataFrame, window: int = 14, symbol: str = "", export: str = "", external_axes: Optional[List[matplotlib.axes._axes.Axes]] = None) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| data | pd.DataFrame | Dataframe of OHLC prices | None | False | +| window | int | Length of window | 14 | True | +| symbol | str | Ticker string | | True | +| export | str | Format to export data | | True | +| external_axes | Optional[List[plt.Axes]] | External axes (3 axes are expected in the list), by default None | None | True | + + +--- + +## Returns + +This function does not return anything + +--- + + + diff --git a/website/content/sdk/reference/ta/hma.md b/website/content/sdk/reference/ta/hma.md new file mode 100644 index 000000000000..5a20db5d44b4 --- /dev/null +++ b/website/content/sdk/reference/ta/hma.md @@ -0,0 +1,44 @@ +--- +title: hma +description: This page provides documentation on the hma function from OpenBB. This + function calculates the hull moving average (HMA) of stock prices, using a pandas + dataframe as input and returning a dataframe with the prices and the HMA. +keywords: +- hma +- hull moving average +- stock technical analysis +- pandas +- SMA window +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Gets hull moving average (HMA) for stock + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/common/technical_analysis/overlap_model.py#L91)] + +```python +openbb.ta.hma(data: pd.Series, length: int = 50, offset: int = 0) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| data | pd.Series | Dataframe of dates and prices | None | False | +| length | int | Length of SMA window | 50 | True | +| offset | int | Length of offset | 0 | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | Dataframe containing prices and HMA | +--- diff --git a/website/content/sdk/reference/ta/kc.md b/website/content/sdk/reference/ta/kc.md new file mode 100644 index 000000000000..0463e42da621 --- /dev/null +++ b/website/content/sdk/reference/ta/kc.md @@ -0,0 +1,92 @@ +--- +title: kc +description: This documentation page provides details on the Keltner Channels functionality + implemented in the OpenBB Terminal. It includes a guide for using the Keltner Channels + analytical model and the chart plotting function. +keywords: +- Keltner Channels +- technical analysis +- volatility model +- chart plotting +- financial data analysis +- Data visualization +- ema filter +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + +Keltner Channels + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/common/technical_analysis/volatility_model.py#L88)] + +```python +openbb.ta.kc(data: pd.DataFrame, window: int = 20, scalar: float = 2, mamode: str = "ema", offset: int = 0) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| data | pd.DataFrame | Dataframe of ohlc prices | None | False | +| window | int | Length of window | 20 | True | +| scalar | float | Scalar value | 2 | True | +| mamode | str | Type of filter | ema | True | +| offset | int | Offset value | 0 | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | Dataframe of rolling kc | +--- + + + + +Plots Keltner Channels Indicator + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/common/technical_analysis/volatility_view.py#L194)] + +```python +openbb.ta.kc_chart(data: pd.DataFrame, window: int = 20, scalar: float = 2, mamode: str = "ema", offset: int = 0, symbol: str = "", export: str = "", external_axes: Optional[List[matplotlib.axes._axes.Axes]] = None) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| data | pd.DataFrame | Dataframe of ohlc prices | None | False | +| window | int | Length of window | 20 | True | +| scalar | float | Scalar value | 2 | True | +| mamode | str | Type of filter | ema | True | +| offset | int | Offset value | 0 | True | +| symbol | str | Ticker symbol | | True | +| export | str | Format to export data | | True | +| external_axes | Optional[List[plt.Axes]] | External axes (2 axes are expected in the list), by default None | None | True | + + +--- + +## Returns + +This function does not return anything + +--- + + + diff --git a/website/versioned_docs/version-v3/sdk/reference/ta/ma.md b/website/content/sdk/reference/ta/ma.md similarity index 84% rename from website/versioned_docs/version-v3/sdk/reference/ta/ma.md rename to website/content/sdk/reference/ta/ma.md index a6429824a7ed..0456ec28abf2 100644 --- a/website/versioned_docs/version-v3/sdk/reference/ta/ma.md +++ b/website/content/sdk/reference/ta/ma.md @@ -1,13 +1,29 @@ --- title: ma -description: OpenBB SDK Function +description: Comprehensive guide to the ma and ma_chart functions as part of the OpenBB + technical analysis python package. These functions focus on plotting the moving + average (MA) technical indicator of various types like EMA, ZLMA and SMA for a given + time-series data. +keywords: +- Technical Analysis +- Moving Average +- EMA +- SMA +- ZLMA +- Pandas +- Financial Data +- Data Visualization +- FAANG stocks +- MA Chart --- +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; -# ma - @@ -58,8 +74,6 @@ openbb.ta.ma_chart(data = spuk_index["^SPUK"], symbol = "S&P UK Index", ma_type --- - - @@ -110,7 +124,5 @@ openbb.ta.ma_chart(data = spuk_index["^SPUK"], symbol = "S&P UK Index", ma_type --- - - - \ No newline at end of file + diff --git a/website/content/sdk/reference/ta/macd.md b/website/content/sdk/reference/ta/macd.md new file mode 100644 index 000000000000..9650a4dcf821 --- /dev/null +++ b/website/content/sdk/reference/ta/macd.md @@ -0,0 +1,92 @@ +--- +title: macd +description: This page provides a comprehensive guide to MACD (Moving Average Convergence + Divergence) implementation in OpenBB terminal. It explains how to model and visualize + the MACD signal using Python as well as the parameters involved. +keywords: +- macd +- OpenBB_terminal +- technical analysis +- moving average convergence divergence +- plotting macd +- macd signal +- data visualization +- momentum model +- momentum view +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + +Moving average convergence divergence + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/common/technical_analysis/momentum_model.py#L61)] + +```python +openbb.ta.macd(data: pd.Series, n_fast: int = 12, n_slow: int = 26, n_signal: int = 9) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| data | pd.Series | Values for calculation | None | False | +| n_fast | int | Fast period | 12 | True | +| n_slow | int | Slow period | 26 | True | +| n_signal | int | Signal period | 9 | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | Dataframe of technical indicator | +--- + + + + +Plots MACD signal + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/common/technical_analysis/momentum_view.py#L126)] + +```python +openbb.ta.macd_chart(data: pd.Series, n_fast: int = 12, n_slow: int = 26, n_signal: int = 9, symbol: str = "", export: str = "", external_axes: Optional[List[matplotlib.axes._axes.Axes]] = None) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| data | pd.Series | Values to input | None | False | +| n_fast | int | Fast period | 12 | True | +| n_slow | int | Slow period | 26 | True | +| n_signal | int | Signal period | 9 | True | +| symbol | str | Stock ticker | | True | +| export | str | Format to export data | | True | +| external_axes | Optional[List[plt.Axes]] | External axes (2 axes are expected in the list), by default None | None | True | + + +--- + +## Returns + +This function does not return anything + +--- + + + diff --git a/website/content/sdk/reference/ta/obv.md b/website/content/sdk/reference/ta/obv.md new file mode 100644 index 000000000000..5b7cee087dec --- /dev/null +++ b/website/content/sdk/reference/ta/obv.md @@ -0,0 +1,84 @@ +--- +title: obv +description: This page provides information on how to use the On Balance Volume (OBV) + technical indicator source code. It covers how to plot the OBV chart and list the + parameters and returns. This information is useful for stock market analysis. +keywords: +- OBV +- On Balance Volume +- technical indicator source code +- plot OBV chart +- parameters +- returns +- stock market analysis +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + +On Balance Volume + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/common/technical_analysis/volume_model.py#L90)] + +```python +openbb.ta.obv(data: pd.DataFrame) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| data | pd.DataFrame | Dataframe of OHLC prices | None | False | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | Dataframe with technical indicator | +--- + + + + +Plots OBV technical indicator + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/common/technical_analysis/volume_view.py#L249)] + +```python +openbb.ta.obv_chart(data: pd.DataFrame, symbol: str = "", export: str = "", external_axes: Optional[List[matplotlib.axes._axes.Axes]] = None) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| data | pd.DataFrame | Dataframe of ohlc prices | None | False | +| symbol | str | Ticker | | True | +| export | str | Format to export data as | | True | +| external_axes | Optional[List[plt.Axes]] | External axes (1 axis is expected in the list), by default None | None | True | + + +--- + +## Returns + +This function does not return anything + +--- + + + diff --git a/website/content/sdk/reference/ta/rsi.md b/website/content/sdk/reference/ta/rsi.md new file mode 100644 index 000000000000..81188fbe4f26 --- /dev/null +++ b/website/content/sdk/reference/ta/rsi.md @@ -0,0 +1,83 @@ +--- +title: rsi +description: Implements relative strength index +keywords: +- relative strength index +- technical analysis +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + +Relative strength index + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/common/technical_analysis/momentum_model.py#L93)] + +```python +openbb.ta.rsi(data: pd.Series, window: int = 14, scalar: float = 100, drift: int = 1) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| data | pd.Series | Dataframe of prices | None | False | +| window | int | Length of window | 14 | True | +| scalar | float | Scalar variable | 100 | True | +| drift | int | Drift variable | 1 | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | Dataframe of technical indicator | +--- + + + + +Plots RSI Indicator + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/common/technical_analysis/momentum_view.py#L219)] + +```python +openbb.ta.rsi_chart(data: pd.Series, window: int = 14, scalar: float = 100.0, drift: int = 1, symbol: str = "", export: str = "", external_axes: Optional[List[matplotlib.axes._axes.Axes]] = None) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| data | pd.Series | Values to input | None | False | +| window | int | Length of window | 14 | True | +| scalar | float | Scalar variable | 100.0 | True | +| drift | int | Drift variable | 1 | True | +| symbol | str | Stock ticker | | True | +| export | str | Format to export data | | True | +| external_axes | Optional[List[plt.Axes]] | External axes (2 axes are expected in the list), by default None | None | True | + + +--- + +## Returns + +This function does not return anything + +--- + + + diff --git a/website/content/sdk/reference/ta/sma.md b/website/content/sdk/reference/ta/sma.md new file mode 100644 index 000000000000..647a9104e0a3 --- /dev/null +++ b/website/content/sdk/reference/ta/sma.md @@ -0,0 +1,47 @@ +--- +title: sma +description: This page provides a comprehensive guide on how to use the sma function + in OpenBB to get the Simple Moving Average (SMA) for stock. It also includes source + code, parameters, and returns descriptions. +keywords: +- sma +- moving average +- stock +- financial technical analysis +- openbb.ta.sma function +- dataframe +- pricing +- programming +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Gets simple moving average (SMA) for stock + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/common/technical_analysis/overlap_model.py#L43)] + +```python +openbb.ta.sma(data: pd.Series, length: int = 50, offset: int = 0) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| data | pd.Series | Dataframe of dates and prices | None | False | +| length | int | Length of SMA window | 50 | True | +| offset | int | Length of offset | 0 | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | Dataframe containing prices and SMA | +--- diff --git a/website/content/sdk/reference/ta/stoch.md b/website/content/sdk/reference/ta/stoch.md new file mode 100644 index 000000000000..910f7b4a4bed --- /dev/null +++ b/website/content/sdk/reference/ta/stoch.md @@ -0,0 +1,92 @@ +--- +title: stoch +description: This page provides information on the Stochastic oscillator method used + in the OpenBB Terminal. Here, you can find details about the parameters and function + implementation for both the model and chart view. It presents a tutorial on how + to plot the Stochastic oscillator signal with various parameters. +keywords: +- Stochastic oscillator +- Technical Analysis +- Python code +- Online documentation +- Model view +- Chart view +- OHLC prices +- Stock ticker symbol +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + +Stochastic oscillator + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/common/technical_analysis/momentum_model.py#L126)] + +```python +openbb.ta.stoch(data: pd.DataFrame, fastkperiod: int = 14, slowdperiod: int = 3, slowkperiod: int = 3) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| data | pd.DataFrame | Dataframe of OHLC prices | None | False | +| fastkperiod | int | Fast k period | 14 | True | +| slowdperiod | int | Slow d period | 3 | True | +| slowkperiod | int | Slow k period | 3 | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | Dataframe of technical indicator | +--- + + + + +Plots stochastic oscillator signal + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/common/technical_analysis/momentum_view.py#L307)] + +```python +openbb.ta.stoch_chart(data: pd.DataFrame, fastkperiod: int = 14, slowdperiod: int = 3, slowkperiod: int = 3, symbol: str = "", export: str = "", external_axes: Optional[List[matplotlib.axes._axes.Axes]] = None) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| data | pd.DataFrame | Dataframe of OHLC prices | None | False | +| fastkperiod | int | Fast k period | 14 | True | +| slowdperiod | int | Slow d period | 3 | True | +| slowkperiod | int | Slow k period | 3 | True | +| symbol | str | Stock ticker symbol | | True | +| export | str | Format to export data | | True | +| external_axes | Optional[List[plt.Axes]] | External axes (3 axes are expected in the list), by default None | None | True | + + +--- + +## Returns + +This function does not return anything + +--- + + + diff --git a/website/content/sdk/reference/ta/vwap.md b/website/content/sdk/reference/ta/vwap.md new file mode 100644 index 000000000000..16214a28e87c --- /dev/null +++ b/website/content/sdk/reference/ta/vwap.md @@ -0,0 +1,92 @@ +--- +title: vwap +description: This documentation page provides detailed information about the volume + weighted average price, or VWAP, a popular technical analysis indicator. It includes + Python code examples for calculating VWAP on a pandas DataFrame of stocks prices, + and creating a visual chart of VWAP data using matplotlib. +keywords: +- vwap +- technical analysis +- volume weighted average price +- data visualization +- pandas dataframe +- stock prices +- trading indicators +- OHLC prices +- matplotlib +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + + + + +Gets volume weighted average price (VWAP) + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/common/technical_analysis/overlap_model.py#L139)] + +```python +openbb.ta.vwap(data: pd.DataFrame, offset: int = 0) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| data | pd.DataFrame | Dataframe of dates and prices | None | False | +| offset | int | Length of offset | 0 | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | Dataframe with VWAP data | +--- + + + + +Plots VWMA technical indicator + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/common/technical_analysis/overlap_view.py#L133)] + +```python +openbb.ta.vwap_chart(data: pd.DataFrame, symbol: str = "", start_date: Optional[str] = None, end_date: Optional[str] = None, offset: int = 0, interval: str = "", export: str = "", external_axes: Optional[List[matplotlib.axes._axes.Axes]] = None) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| data | pd.DataFrame | Dataframe of OHLC prices | None | False | +| symbol | str | Ticker | | True | +| offset | int | Offset variable | 0 | True | +| start_date | Optional[str] | Initial date, format YYYY-MM-DD | None | True | +| end_date | Optional[str] | Final date, format YYYY-MM-DD | None | True | +| interval | str | Interval of data | | True | +| export | str | Format to export data | | True | +| external_axes | Optional[List[plt.Axes]] | External axes (3 axes are expected in the list), by default None | None | True | + + +--- + +## Returns + +This function does not return anything + +--- + + + diff --git a/website/content/sdk/reference/ta/wma.md b/website/content/sdk/reference/ta/wma.md new file mode 100644 index 000000000000..f6040071c3f3 --- /dev/null +++ b/website/content/sdk/reference/ta/wma.md @@ -0,0 +1,44 @@ +--- +title: wma +description: This page provides a comprehensive guide on how to get the Weighted Moving + Average (WMA) for stock using OpenBB's wma function. This includes relevant parameters + and return values. +keywords: +- Weighted Moving Average +- WMA +- Stock Analysis +- Python Function +- Technical Analysis +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Gets weighted moving average (WMA) for stock + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/common/technical_analysis/overlap_model.py#L67)] + +```python +openbb.ta.wma(data: pd.Series, length: int = 50, offset: int = 0) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| data | pd.Series | Dataframe of dates and prices | None | False | +| length | int | Length of SMA window | 50 | True | +| offset | int | Length of offset | 0 | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | Dataframe containing prices and WMA | +--- diff --git a/website/content/sdk/reference/ta/zlma.md b/website/content/sdk/reference/ta/zlma.md new file mode 100644 index 000000000000..9d4aabcdc754 --- /dev/null +++ b/website/content/sdk/reference/ta/zlma.md @@ -0,0 +1,48 @@ +--- +title: zlma +description: This page provides an in-depth view of the zlma function, which is used + to calculate zero-lagged exponential moving average (ZLEMA) for stocks. The page + includes the source code and details of parameters and returns. +keywords: +- ZLEMA +- stock analysis +- technical analysis +- openbb.ta.zlma function +- exponential moving average +- OpenBB finance +- overlap_model.py +- dataframe +- EMA +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Gets zero-lagged exponential moving average (ZLEMA) for stock + +Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/common/technical_analysis/overlap_model.py#L115)] + +```python +openbb.ta.zlma(data: pd.Series, length: int = 50, offset: int = 0) +``` + +--- + +## Parameters + +| Name | Type | Description | Default | Optional | +| ---- | ---- | ----------- | ------- | -------- | +| data | pd.Series | Dataframe of dates and prices | None | False | +| length | int | Length of EMA window | 50 | True | +| offset | int | Length of offset | 0 | True | + + +--- + +## Returns + +| Type | Description | +| ---- | ----------- | +| pd.DataFrame | Dataframe containing prices and EMA | +--- diff --git a/website/content/sdk/showcase.md b/website/content/sdk/showcase.md new file mode 100644 index 000000000000..74d16455b515 --- /dev/null +++ b/website/content/sdk/showcase.md @@ -0,0 +1,47 @@ +--- +title: Showcase +sidebar_position: 6 +description: A showcase of projects built using OpenBB SDK, providing you with examples + and real use cases of how our SDK has been used in different projects. Get in touch + with us to list your project. +keywords: +- OpenBB SDK +- project showcase +- software development kit +- open source +- Streamlit Dashboard +- Kulbinderdio project +- Economy +- ETF +- Stocks +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import ShowcaseItem from "@site/src/components/General/ShowcaseItem" + +This page contains a list of projects that use the OpenBB SDK. + +If you have a project that uses the OpenBB SDK, please contact us via [Discord](https://discord.com/invite/Up2QGbMKHY) or [hello@openbb.co](mailto:hello@openbb.co). + +--- + + + + + + +--- + +:::tip + +Find more open source projects on GitHub [here](https://github.com/search?q=topic:openbb&type=Repositories&l=&l=) diff --git a/website/versioned_docs/version-v3/sdk/usage/_category_.json b/website/content/sdk/usage/_category_.json similarity index 100% rename from website/versioned_docs/version-v3/sdk/usage/_category_.json rename to website/content/sdk/usage/_category_.json diff --git a/website/content/sdk/usage/api-keys.md b/website/content/sdk/usage/api-keys.md new file mode 100644 index 000000000000..740c7d893e00 --- /dev/null +++ b/website/content/sdk/usage/api-keys.md @@ -0,0 +1,866 @@ +--- +title: Setting API Keys +sidebar_position: 2 +description: This documentation page describes how you can set your own API keys from each data vendor on OpenBB to leverage their datasets. +keywords: +- API keys +- datasets +- data vendors +- subscription +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + + +## The Keys Module + +API (Application Programming Interface) keys are access credentials for obtaining data from a particular source. They are a string of random characters assigned, by the data provider, to an individual account. Most vendors offer a free tier requiring only a valid email address, some will require an account with proper KYC (Know Your Customer). Each source is entered into the SDK with the `openbb.keys` module, using the syntax described in the sections below. Wrapping the command with `help()` will print the docstrings to the screen. For example: + +```console +help(openbb.keys.reddit) +``` + +Which prints: + +```console + Set Reddit key + + Parameters + ---------- + client_id: str + Client ID + client_secret: str + Client secret + password: str + User password + username: str + User username + useragent: str + User useragent + persist: bool, optional + If False, api key change will be contained to where it was changed. For example, a Jupyter notebook session. + If True, api key change will be global, i.e. it will affect terminal environment variables. + By default, False. + show_output: bool, optional + + Returns + ------- + str + Status of key set + + Examples + -------- + >>> from openbb_terminal.sdk import openbb + >>> openbb.keys.reddit( + client_id="example_id", + client_secret="example_secret", + password="example_password", + username="example_username", + useragent="example_useragent" + ) +``` + +A message similar to the one below will be printed when a function requesting data from an API is called but the key has not yet been entered. + +```console +openbb.stocks.quote("AAPL") +API_KEY_FINANCIALMODELINGPREP not defined. Set API Keys in ~/.openbb_terminal/.env or under keys menu. +``` + +The menu also provides a method for testing the validity of a key upon entry. It can be easy to copy & paste the string with a missing character; so, if the test fails, check that the values were correctly recorded with the command: + +```console +openbb.keys.mykeys(show = True) +``` + +**We recommend gradually obtaining keys, when the use of a specific function requires it.** + +## Instructions by Source + +This section covers all API keys listed above and include detailed instructions how to obtain each API key. By clicking on each name, the section will expand and instructions are provided. Include, `persist = True` in the syntax to permanently store the key on the machine. + +### AlphaVantage + +> Alpha Vantage provides enterprise-grade financial market data through a set of powerful and developer-friendly data APIs and spreadsheets. From traditional asset classes (e.g., stocks, ETFs, mutual funds) to economic indicators, from foreign exchange rates to commodities, from fundamental data to technical indicators, Alpha Vantage is your one-stop-shop for real-time and historical global market data delivered through cloud-based APIs, Excel, and Google Sheets. + +
+Instructions + +Go to: https://www.alphavantage.co/support/#api-key + +[AlphaVantage](https://www.alphavantage.co/support/#api-key) + +![AlphaVantage](https://user-images.githubusercontent.com/46355364/207820936-46c2ba00-81ff-4cd3-98a4-4fa44412996f.png) + +Fill out the form, pass Captcha, and click on, "GET FREE API KEY". The issued key can be entered into the OpenBB SDK with: + +```console +openbb.keys.av(key = 'REPLACE_WITH_KEY', persist = True) +``` + +
+ +### Binance + +> Binance cryptocurrency exchange - We operate the worlds biggest bitcoin exchange and altcoin crypto exchange in the world by volume + +
+Instructions + +Go to: https://www.binance.com/en/support/faq/how-to-create-api-360002502072 + +![Binance](https://user-images.githubusercontent.com/46355364/207839805-f71cf12a-62d2-41cb-ba19-0c35917abc40.png) + +These instructions should provide clear guidance for obtaining an API Key. Enter the issued credentials into the OpenBB SDK with: + +```console +openbb.keys.binance( + key = 'REPLACE_WITH_KEY', + secret = 'REPLACE_WITH_SECRET', + persist = True +) +``` + +
+ +### Bitquery + +> Bitquery is an API-first product company dedicated to power and solve blockchain data problems using the ground truth of on-chain data. + +
+Instructions + +Go to: https://bitquery.io/< + +![Bitquery](https://user-images.githubusercontent.com/46355364/207840322-5532a3f9-739f-4e28-9839-a58db932882e.png) + +Click "Try GraphQL API", which opens the following screen: + +![Try GraphQL API](https://user-images.githubusercontent.com/46355364/207840576-2c51a538-dd9b-484d-b11d-40e3e424df62.png) + +After creating an account and verifying the email address, get the value for the key by clicking on the "API Key" tab. + +![Get Bitquery API Key](https://user-images.githubusercontent.com/46355364/207840833-35c1b12c-9b4b-43fe-a33e-f7b92c43a011.png) + +Enter this API key into the OpenBB SDK with: + +```console +openbb.keys.bitquery(key = 'REPLACE_WITH_KEY', persist = True) +``` + +
+ +### BizToc + +> BizToc is the one-stop business and finance news hub, encapsulating the top 200 US news providers in real time. + +
+Instructions + +The BizToc API is hosted on RapidAPI. To set up, go to: https://rapidapi.com/thma/api/biztoc. + +![biztoc0](https://github.com/marban/OpenBBTerminal/assets/18151143/04cdd423-f65e-4ad8-ad5a-4a59b0f5ddda) + +In the top right, select "Sign Up". After answering some questions, you will be prompted to select one of their plans. + +![biztoc1](https://github.com/marban/OpenBBTerminal/assets/18151143/9f3b72ea-ded7-48c5-aa33-bec5c0de8422) + +After signing up, navigate back to https://rapidapi.com/thma/api/biztoc. If you are logged in, you will see a header called X-RapidAPI-Key. + +![biztoc2](https://github.com/marban/OpenBBTerminal/assets/18151143/0f3b6c91-07e0-447a-90cd-a9e23522929f) + +Copy the key to the clipboard, and enter this key into the OpenBB Terminal with: + +```console +openbb.keys.biztoc(key = "REPLACE_WITH_KEY", persist=True) +``` + +
+ +### CoinMarketCap + +> CoinMarketCap is the world's most-referenced price-tracking website for cryptoassets in the rapidly growing cryptocurrency space. Its mission is to make crypto discoverable and efficient globally by empowering retail users with unbiased, high quality and accurate information for drawing their own informed conclusions. + +
+Instructions + +Go to: https://coinmarketcap.com/api + +![CoinMarketCap](https://user-images.githubusercontent.com/46355364/207831111-3f09ed75-740e-4121-a67e-6e1f36e8ab9a.png) + +Click on, "Get Your Free API Key Now", which opens to the page: + +![CoinMarketCap](https://user-images.githubusercontent.com/46355364/207831345-06a48efe-63b2-4804-bcf9-52fa4a73f7db.png) + +Once the account has been created, copy the API key displayed within the dashboard. + +![CoinMarketCap](https://user-images.githubusercontent.com/46355364/207831705-e9f95018-bba7-49a9-b057-3443bc839861.png) + +Enter the API key into the OpenBB SDK with: + +```console +openbb.keys.cmc(key = 'REPLACE_WITH_KEY', persist = True) +``` + +
+ +### Coinbase + +> Coinbase is a secure online platform for buying, selling, transferring, and storing cryptocurrency. + +
+Instructions + +Go to: https://help.coinbase.com/en/exchange/managing-my-account/how-to-create-an-api-key + +![Coinbase](https://user-images.githubusercontent.com/46355364/207841901-647f0aef-0c74-454d-b99e-367d784259f0.png) + +Follow the instructions to obtain the credentials for the specific account. Enter the three values into the OpenBB SDK with: + +```console +openbb.keys.coinbase( + key = 'REPLACE_WITH_KEY', + secret = 'REPLACE_WITH_SECRET', + passphrase = 'REPLACE_WITH_PASSPHRASE', + persist = True +) +``` + +
+ +### Coinglass + +> Coinglass is a cryptocurrency futures trading & information platform,where you can find the Bitcoin Liquidations ,Bitcoin open interest, Grayscale Bitcoin Trust，Bitcoin longs vs shorts ratio and actively compare funding rates for crypto futures.Above all the quantities are shown as per their respective contract value. + +
+Instructions + +Go to: https://www.coinglass.com/ + +![Coinglass](https://user-images.githubusercontent.com/46355364/207844601-8510687a-e54f-49b9-961f-5ef6718f58ab.png) + +Click, "Log in", and then sign up for an account. This opens the page: + +![Coinglass](https://user-images.githubusercontent.com/46355364/207844637-a9321889-c4d8-4d44-95fe-a6288a17ad19.png) + +With the account created, find the assigned API key within the account profile page. Enter this value into the OpenBB SDK with: + +```console +openbb.keys.coinglass(key = 'REPLACE_WITH_KEY', persist = True) +``` + +
+ +### Companies House + +> The Companies House API lets you retrieve information about limited companies (and other companies that fall within the Companies Act 2006). The data returned is live and real-time, and is simple to use and understand. + +
+Instructions + +Setup an account by following the instructions [here](https://developer-specs.company-information.service.gov.uk/guides/gettingStarted#set-up-a-companies-house-account). + +![Companies House](https://user-images.githubusercontent.com/85772166/234980988-352e36f7-334b-4e4c-846f-2cea128f9464.png) + +After creating the account and logging in, click on, [Create an Application](https://developer.company-information.service.gov.uk/manage-applications/add). Fill out the form and then click the `Create` button at the bottom of the page. + +![Create an Application](https://user-images.githubusercontent.com/85772166/234981083-e78cf4f7-3be0-404e-b7cc-b452679bbb06.png) + +Once the application is created, an API key can be generated by clicking on `View all Applications`, and then the `Create new key` button at the bottom. Copy the API key value to the clipboard and then enter it into the OpenBB SDK with: + +```console +openbb.keys.companieshouse('REPLACE_WITH_KEY', persist = True) +``` + +
+ +### Crypto Panic + +> CryptoPanic is a news aggregator platform indicating impact on price and market for traders and cryptocurrency enthusiasts. + +
+Instructions + +Go to: https://cryptopanic.com/developers/api/ + +![Crypto Panic](https://user-images.githubusercontent.com/46355364/207848733-27e5a804-7ae7-4ca2-88b2-848b32929b6f.png) + +Click on, ["Sign up"](https://cryptopanic.com/accounts/signup/?next=/developers/api/), and after creating, the API Key will be displayed on the documentation page, "Your free API auth token". + +![Crypto Panic](https://user-images.githubusercontent.com/46355364/207848971-3e4771b7-1faa-45fe-955f-81bd736b16b7.png) + +Enter that value in the OpenBB SDK with: + +```console +openbb.keys.cpanic(key = 'REPLACE_WITH_KEY', persist = True) +``` + +
+ +### Databento + +> Databento eliminates tens of thousands of dollars in upfront expenses per dataset without sacrificing data integrity. We give you the flexibility to pick up real-time full exchange feeds and terabytes of historical data, whenever you need it. + +
+Instructions + +Go to: https://docs.databento.com/getting-started + +![Databento](https://user-images.githubusercontent.com/85772166/221944000-394e7123-5bb3-4218-b949-f0958b6353da.png) + +Click on, [Sign up](https://databento.com/signup), and after creating an account, the API key is found in the [account portal](https://databento.com/portal/keys). + +![Databento](https://user-images.githubusercontent.com/85772166/221944057-c2314909-7b7d-4f65-8e9e-287a957f54f8.png) + +Enter this into the terminal with: + +```console +openbb.keys.databento(key = 'REPLACE_WITH_KEY') +``` + +
+ +### Degiro + +> DEGIRO is Europe's fastest growing online stock broker. DEGIRO distinguishes itself from its competitors by offering extremely low trading commissions. + +
+Instructions + +Go to: https://www.degiro.com/ + +![Degiro](https://user-images.githubusercontent.com/46355364/207838353-001d350c-872c-4770-a586-fb21318122eb.png) + +Click on, "Open an account", and then go through the registration process. After setting up the account, the login credentials can be entered in the OpenBB SDK with: + +```console +openbb.keys.degiro( + username = 'USERNAME', + password = 'PASSWORD', + persist = True +) +``` + +Instructions for setting up 2FA authorization are [here](https://github.com/Chavithra/degiro-connector#35-how-to-use-2fa-). + +
+ +### EODHD + +> Historical End of Day, Intraday, and Live prices API, with Fundamental Financial data API for more than 120000 stocks, ETFs and funds all over the world. + +
+Instructions + +Go to: https://eodhistoricaldata.com/r/?ref=869U7F4J + +![EODHD](https://user-images.githubusercontent.com/46355364/207849214-23763c95-7314-42ae-b97d-cb5810686498.png) + +Clicking on, "Registration", opens the page: + +![EODHD](https://user-images.githubusercontent.com/46355364/207849324-00d4a916-8260-45c0-9714-289e0a0574c0.png) + +Once registered, the API Key will be next to "API TOKEN". + +![EODHD](https://user-images.githubusercontent.com/46355364/207849462-37471270-929a-45c5-a164-a84249b19231.png) + +Enter this string into the OpenBB SDK with: + +```console +openbb.keys.eodhd(key = 'REPLACE_WITH_KEY', persist = True) +``` + +
+ +### Finnhub + +> With the sole mission of democratizing financial data, we are proud to offer a FREE realtime API for stocks, forex and cryptocurrency. + +
+Instructions + +Go to: https://finnhub.io/ + +![Finnhub](https://user-images.githubusercontent.com/46355364/207832028-283c3321-8c05-4ee8-b4d2-41cdc940f408.png) + +Click on, "Get free api key", to open the page: + +![Finnhub](https://user-images.githubusercontent.com/46355364/207832185-f4c8406a-3b75-4acc-b3e8-3c4b3272d4da.png) + +Once the account has been created, find the API key in the account dashboard. + +![Finnhub](https://user-images.githubusercontent.com/46355364/207832601-62007d95-410c-4d03-a5a3-b177d1894a4c.png) + +Add this key to the OpenBB SDK with: + +```console +openbb.keys.finnhub(key = 'REPLACE_WITH_KEY', persist = True) +``` + +
+ +### Financial Modeling Prep + +> Enhance your application with our data that goes up to 30 years back in history. Earnings calendar, financial statements, multiple exchanges and more! + +
+Instructions + +Go to: https://site.financialmodelingprep.com/developer/docs + +[FinancialModelingPrep](https://site.financialmodelingprep.com/developer/docs) + +![FinancialModelingPrep](https://user-images.githubusercontent.com/46355364/207821920-64553d05-d461-4984-b0fe-be0368c71186.png) + +Click on, "Get my API KEY here", and sign up for a free account. + +![FinancialModelingPrep](https://user-images.githubusercontent.com/46355364/207822184-a723092e-ef42-4f87-8c55-db150f09741b.png) + +With an account created, sign in and navigate to the Dashboard, which shows the assigned token. by pressing the "Dashboard" button which will show the API key. + +![FinancialModelingPrep](https://user-images.githubusercontent.com/46355364/207823170-dd8191db-e125-44e5-b4f3-2df0e115c91d.png) + +Enter the key into the OpenBB SDK with: + +```console +openbb.keys.fmp(key = 'REPLACE_WITH_KEY', persist = True) +``` + +
+ +### FRED + +> FRED is the trusted source for economic data since 1991. Download, graph, and track 819,000 US and international time series from 110 sources. + +
+Instructions + +Go to: https://fred.stlouisfed.org + +![FRED](https://user-images.githubusercontent.com/46355364/207827137-d143ba4c-72cb-467d-a7f4-5cc27c597aec.png) + +Click on, "My Account", create a new account or sign in with Google: + +![FRED](https://user-images.githubusercontent.com/46355364/207827011-65cdd501-27e3-436f-bd9d-b0d8381d46a7.png) + +After completing the sign-up, go to "My Account", and select "API Keys". Then, click on, "Request API Key". + +![FRED](https://user-images.githubusercontent.com/46355364/207827577-c869f989-4ef4-4949-ab57-6f3931f2ae9d.png) + +Fill in the box for information about the use-case for FRED, and by clicking, "Request API key", at the bottom of the page, the API key will be issued. + +![FRED](https://user-images.githubusercontent.com/46355364/207828032-0a32d3b8-1378-4db2-9064-aa1eb2111632.png) + +Enter the API key into the OpenBB SDK with: + +```console +openbb.keys.fred(key = 'REPLACE_WITH_KEY', persist = True) +``` + +
+ +### GitHub + +> GitHub is where over 100 million developers shape the future of software. + +
+Instructions + +![GitHub](https://user-images.githubusercontent.com/46355364/207846953-7feae777-3c3b-4f21-9dcf-84817c732618.png) + +Sign up for, or sign in to, GitHub. Once logged in, navigate to the [apps](https://github.com/settings/apps) page, under account settings. + +![GitHub](https://user-images.githubusercontent.com/46355364/207847215-3c04003f-26ea-4e62-9c13-ea35176bb5e3.png) + +Select, "New GitHub App": + +![GitHub](https://user-images.githubusercontent.com/46355364/207847383-d24416c6-18be-43f2-ae7c-455e8372a6ed.png) + +After creating the app, the key will be issued. Enter this token into the OpenBB SDK with: + +```console +openbb.keys.github(key = 'REPLACE_WITH_KEY', persist = True) +``` + +
+ +### Glassnode + +> Glassnode makes blockchain data accessible for everyone. We source and carefully dissect on-chain data, to deliver contextualized and actionable insights. + +
+Instructions + +Go to: https://studio.glassnode.com + +![Glassnode](https://user-images.githubusercontent.com/46355364/207843761-799078ff-fa64-4d39-a6eb-ba01d250be69.png) + +Click on, "Sign up", and create an account: + +![Glassnode](https://user-images.githubusercontent.com/46355364/207843795-dd2cdbdb-45eb-4c7d-b967-ae9857d4ea5d.png) + +After creating an account, navigate to the [account settings](https://studio.glassnode.com/settings/api) and generate an API Key. + +![Glassnode](https://user-images.githubusercontent.com/46355364/207843950-5f33f37d-0203-4302-a67f-198808f18e06.png) + +Enter this key in the OpenBB SDK with: + +```console +openbb.keys.glassnode(key = 'REPLACE_WITH_KEY', persist = True) +``` + +
+ +### Intrinio + +> Intrinio is more than a financial data API provider – we're a real time data partner. That means we're your guide to every step of the financial data. + +
+Instructions + +Go to: https://intrinio.com/starter-plan + +![Intrinio](https://user-images.githubusercontent.com/85772166/219207307-d6605460-ae2c-46d3-8b4e-f82057cfce59.png) + +An API key will be issued with a subscription. Find the token value within the account dashboard, and enter it into the OpenBB SDK with: + +```console +openbb.keys.intrinio(key = 'REPLACE_WITH_KEY', persist = True) +``` + +
+ +### Messari + +> Gain an edge over the crypto market with professional grade data, tools, and research. + +
+Instructions + +Go to: https://messari.io + +![Messari](https://user-images.githubusercontent.com/46355364/207848122-ec6a41e4-76b7-4620-adc3-1f1c19f4bca6.png) + +Click on, "Sign up", and create an account. + +![Messari](https://user-images.githubusercontent.com/46355364/207848160-6a962e3c-3007-40a3-9431-cd5ddfe5bb8e.png) + +After creating the account, navigate to the [account page](https://messari.io/account/api), and click on the tab for, API Access. + +![Messari](https://user-images.githubusercontent.com/46355364/207848324-ade5bede-8e6b-4b87-bdec-eade3217c0d8.png) + +Copy the API key and add it to the OpenBB SDK with: + +```console +openbb.keys.messari(key = 'REPLACE_WITH_KEY', persist = True) +``` + +
+ +### News API + +> News API is a simple, easy-to-use REST API that returns JSON search results for current and historic news articles published by over 80,000 worldwide sources. + +
+Instructions + +Go to: https://newsapi.org + +![News API](https://user-images.githubusercontent.com/46355364/207828250-0c5bc38c-90b4-427d-a611-b43c98c8e7ab.png) + +Click on, "Get API Key", and fill out the form. + +![News API](https://user-images.githubusercontent.com/46355364/207828421-76922bc2-cde0-493f-9eed-7f90eb831779.png) + +Register for an account and the next screen will provide the API Key. + +![News API](https://user-images.githubusercontent.com/46355364/207828736-f0fce53b-f302-4456-adf9-8d50ac41fbe2.png) + +Add this API key into the OpenBB SDK with: + +```console +openbb.keys.news(key = 'REPLACE_WITH_KEY', persist = True) +``` + +
+ +### Oanda + +> OANDA's Currency Converter allows you to check the latest foreign exchange average bid/ask rates and convert all major world currencies. + +
+Instructions + +Go to: https://developer.oanda.com + +![Oanda](https://user-images.githubusercontent.com/46355364/207839324-d30aa2b6-be83-41ff-9b1b-146cac566789.png) + +After creating an account, follow the steps below. + +![Oanda](https://user-images.githubusercontent.com/46355364/207839246-eb40f093-b583-4edd-b178-99fe399bfb66.png) + +Upon completion of the account setup, enter the credentials into the OpenBB SDK with: + +```console +openbb.keys.oanda( + account = 'REPLACE_WITH_ACCOUNT', + access_token = 'REPLACE_WITH_TOKEN', + account_type = 'REPLACE_WITH_LIVE_OR_PRACTICE', + persist = True +) +``` + +
+ +### Polygon + +> Live & historical data for US stocks for all 19 exchanges. Instant access to real-time and historical stock market data. + +
+Instructions + +Go to: https://polygon.io + +![Polygon](https://user-images.githubusercontent.com/46355364/207825623-fcd7f0a3-131a-4294-808c-754c13e38e2a.png) + +Click on, "Get your Free API Key". + +![Polygon](https://user-images.githubusercontent.com/46355364/207825952-ca5540ec-6ed2-4cef-a0ed-bb50b813932c.png) + +After signing up, the API Key is found at the bottom of the account dashboard page. + +![Polygon](https://user-images.githubusercontent.com/46355364/207826258-b1f318fa-fd9c-41d9-bf5c-fe16722e6601.png) + +Enter the key into the OpenBB SDK with: + +```console +openbb.keys.polygon(key = 'REPLACE_WITH_KEY', persist = True) +``` + +
+ +### Quandl + +> The premier source for financial, economic, and alternative datasets, serving investment professionals. Quandl’s platform is used by over 400,000 people, including analysts from the world’s top hedge funds, asset managers and investment banks. + +
+Instructions + +![Quandl](https://user-images.githubusercontent.com/46355364/207823899-208a3952-f557-4b73-aee6-64ac00faedb7.png) + +Click on, "Sign Up", and register a new account. + +![Quandl](https://user-images.githubusercontent.com/46355364/207824214-4b6b2b74-e709-4ed4-adf2-14803e6f3568.png) + +Follow the sign-up instructions, and upon completion the API key will be assigned. + +![Quandl](https://user-images.githubusercontent.com/46355364/207824664-3c82befb-9c69-42df-8a82-510d85c19a97.png) + +Enter the key into the OpenBB SDK with: + +```console +openbb.keys.quandl(key = 'REPLACE_WITH_KEY', persist = True) +``` + +
+ +### Reddit + +> Reddit is a network of communities where people can dive into their interests, hobbies and passions. + +
+Instructions + +Sign in to Reddit, and then go to: https://old.reddit.com/prefs/apps/ + +![Reddit](https://preview.redd.it/540vrn3k0cn91.png?width=986&format=png&auto=webp&v=enabled&s=88228cd0cf4415b3487b8d35e1097f0caa804e15) + +Scroll down and click on "create application", selecting "script". + +![Reddit](https://preview.redd.it/7je4ehqa1cn91.png?width=916&format=png&auto=webp&v=enabled&s=dbdf65ccc0820cfe28eff8e81cba056f4fd8263e) + +Once the application is created, you must register it [here](https://old.reddit.com/wiki/api) + +![Reddit](https://user-images.githubusercontent.com/46355364/207834105-665180be-c2b6-43c8-b1c9-477729905010.png) + +Click on, "Read the full API terms and sign up for usage", and fill out the form. + +![Reddit](https://user-images.githubusercontent.com/46355364/207834850-32a0d4c8-9990-4919-94e3-abad1487a3bd.png) + +After submitting the form, check for a confirmation email. The credentials will be displayed [here](https://old.reddit.com/prefs/apps/), add them to the OpenBB SDK with: + +```console +openbb.keys.reddit( + client_id = 'REPLACE_WITH_CLIENT_ID', + client_secret = 'REPLACE_WITH_CLIENT_SECRET', + username = 'REPLACE_WITH_REDDIT_USERNAME', + password = 'REPLACE_WITH_REDDIT_PASSWORD', + useragent = 'REPLACE_WITH_USER_AGENT', + persist = True +) +``` + +
+ +### Robinhood + +> Robinhood has commission-free investing, and tools to help shape your financial future. + +
+Instructions + +Go to: https://robinhood.com/us/en + +![Robinhood](https://user-images.githubusercontent.com/46355364/207838058-a2311632-6459-4cfd-bc0a-639ee3931574.png) + +After registering for an account, it can be added to the OpenBB SDK with: + +```console +openbb.keys.rb( + username = 'REPLACE_WITH_USERNAME', + password = 'REPLACE_WITH_PASSWORD', + persist = True +``` + +The first login will request 2FA authorization from the device connected to the account. + +
+ +### Santiment + +> We provide tools to help you analyze crypto markets and find data-driven opportunities to optimize your investing. + +
+Instructions + +Go to: https://app.santiment.net + +![Santiment](https://user-images.githubusercontent.com/46355364/207849709-a5f10b03-138c-4e09-89f6-8a18cfbaf008.png) + +Click on, "Sign up", and register for an account. + +![Santiment](https://user-images.githubusercontent.com/46355364/207849732-4bae61de-2f62-4919-b85d-f418f1bbd0c4.png) + +Navigate to the [account dashboard](https://app.santiment.net/account#api-keys) and generate a key. + +![Santiment](https://user-images.githubusercontent.com/46355364/207849839-31d1d0a7-6936-4ebd-a7f8-1292f6317b07.png) + +Add it to the OpenBB SDK with: + +```console +openbb.keys.santiment(key = 'REPLACE_WITH_KEY', persist = True) +``` + +
+ +### Stocksera + +> Empowering investors to take advantage of alternative data. We track trending tickers on social media and provide alternative data for easy due-diligence & analysis. + +
+Instructions + +Go to: https://stocksera.pythonanywhere.com + +![Stocksera](https://user-images.githubusercontent.com/46355364/207853896-ee233569-26bb-4244-b115-43ac8885757a.png) + +Click on, "Log in", and create an account. + +![Stocksera](https://user-images.githubusercontent.com/46355364/207853985-46a7a17f-b6b2-442b-886d-f68b3ba2ad5a.png) + +Once logged in, navigate to the "Developers" tab and copy the API key. + +![Stocksera](https://user-images.githubusercontent.com/46355364/207854224-e5ddace0-15d1-491c-b616-263cca0bef02.png) + +Add the key to the OpenBB SDK with: + +```console +openbb.keys.stocksera(key = 'REPLACE_WITH_KEY', persist = True) +``` + +
+ +### Token Terminal + +> Token Terminal is a platform that aggregates financial data on the leading blockchains and decentralized applications. + +
+Instructions + +Go to: https://tokenterminal.com + +![Token Terminal](https://user-images.githubusercontent.com/46355364/207850735-69368b4f-6a3e-46b8-ba69-3b79d9231f15.png) + +Click on, "Log in" and sign up for an account. + +![Token Terminal](https://user-images.githubusercontent.com/46355364/207850774-2071df78-3289-4c8e-9d64-156b9ec8ad81.png) + +Verify the email address, and then navigate go to the "API" tab and copy the API key to the clipboard. + +![Token Terminal](https://user-images.githubusercontent.com/46355364/207851035-71ea3eff-a11f-4835-8592-c07b3aa3f800.png) + +Add the key to the OpenBB SDK with: + +```console +openbb.keys.tokenterminal(key = 'REPLACE_WITH_KEY', persist = True) +``` + +
+ +### Tradier + +> Tradier, the home of active traders. Our open collaboration platform allows investors to truly customize their trading experience like never before. + +
+Instructions + +Go to: https://documentation.tradier.com + +![Tradier](https://user-images.githubusercontent.com/46355364/207829178-a8bba770-f2ea-4480-b28e-efd81cf30980.png) + +Click on, "Open Account", to start the sign-up process. After the account has been setup, navigate to [Tradier Broker Dash](https://dash.tradier.com/login?redirect=settings.api) and create the application. Request a sandbox access token, and enter this key into the OpenBB SDK with: + +```console +openbb.keys.tradier(key = 'REPLACE_WITH_KEY', persist = True) +``` + +
+ +### Twitter + +> From breaking news and entertainment to sports and politics, get the full story with all the live commentary. + +
+Upcoming changes to the Twitter API will deprecate the current functionality, it is uncertain if the features will continue to work. + +![Twitter API](https://pbs.twimg.com/media/FooIJF3agAIU8SN?format=png&name=medium) + +
+ +### Whale Alert + +> Whale Alert continuously collects and analyzes billions of blockchain transactions and related-off chain data from hundreds of reliable sources and converts it into an easy to use standardized format. Our world-class analytics and custom high speed database solutions process transactions the moment they are made, resulting in the largest and most up-to-date blockchain dataset in the world. + +
+Instructions + +Go to: https://docs.whale-alert.io +![Whale Alert](https://user-images.githubusercontent.com/46355364/207842892-3f71ee7a-6cd3-48a2-82e4-fa5ec5b13807.png) + +Click on, "sign up here". + +![Whale Alert](https://user-images.githubusercontent.com/46355364/207842992-427f1d2c-b34e-41c9-85fd-18511805fd16.png) + +After creating the account, click on, "Create", to issue the API Key. + +![Whale Alert](https://user-images.githubusercontent.com/46355364/207843214-20232465-9a52-4b66-b01a-0b8cecbdd612.png) + +Enter the key into the OpenBB SDK with: + +```console +openbb.keys.walert(key = 'REPLACE_WITH_KEY', persist = True) +``` + +
diff --git a/website/content/sdk/usage/basics.md b/website/content/sdk/usage/basics.md new file mode 100644 index 000000000000..16207dbf6627 --- /dev/null +++ b/website/content/sdk/usage/basics.md @@ -0,0 +1,412 @@ +--- +title: Basics +sidebar_position: 1 +description: This page provides a detailed overview of using the OpenBB SDK - a tool + that brings programmatic access to nearly all Terminal commands. Topics covered + include installation, essential terminal command usage, working with Python environments, + using Jupyter and various code editors, managing API keys, functionality, and navigation + of the SDK. There are also specifics on using function inputs and responses, as + well as dealing with plot themes and changing data sources. Support is offered via + the support page, GitHub, and Discord. +keywords: +- OpenBB SDK +- Terminal commands +- Installation +- Python environment +- Jupyter +- Code Editors +- API Keys +- Programming +- Conda +- Pandas DataFrame +- Python packages +- Stocks +- Screener preset +- OpenBB Hub +- VS Code +--- + + +## Overview + +The OpenBB SDK provides programmatic access to nearly all Terminal commands, allowing custom scripts and functions to power creations built on top of the core platform. It is easy to use and as flexible as one's imagination. The sections below will outline how to get started using it. If it isn't already installed, follow the instructions to install via [PyPi (pip)](/terminal/installation/pypi) or from the [source code](/terminal/installation/source). + +## Importing the OpenBB SDK + +No additional software is required to use the OpenBB SDK, it can be consumed directly from the command line Terminal within the virtual environment created during the installation process. + +### Terminal Command Line + +The `obb` virtual environment has both `python` and `ipython` as methods for starting a new session from scratch. + +- Step 1: Activate the `obb` virtual environment. + - `conda activate obb` + +:::note + +If this doesn't work, there may be an obvious reason why. + +- The installation was not completed. +- The terminal being used is different from the one which was used for installation. For example, Miniconda was installed using `CMD.exe` or `Anaconda Prompt`, but the current terminal is PowerShell. + +Open the same terminal used for installation and activate the `obb` environment, then enter: + +```console +conda init --all --system +``` + +`Exit` and re-open. Conda should now be callable from all terminal shell profiles. +::: + +- Step 2: Start a new Python or iPython session. + - `python` + - `ipython` + +This will display a similar message to the one below. + +```console +(obb) Steves-MacBook-Pro:OpenBBTerminal steve$ python +Python 3.10.8 | packaged by conda-forge | (main, Nov 22 2022, 08:25:13) [Clang 14.0.6 ] on darwin +Type "help", "copyright", "credits" or "license" for more information. +>>> from openbb_terminal.sdk import openbb +``` + +`ipython` will look slightly different. + +```console +(obb) Steves-MacBook-Pro:OpenBBTerminal steve$ ipython +Python 3.10.8 | packaged by conda-forge | (main, Nov 22 2022, 08:25:13) [Clang 14.0.6 ] +Type 'copyright', 'credits' or 'license' for more information +IPython 8.11.0 -- An enhanced Interactive Python. Type '?' for help. + +In [1]: from openbb_terminal.sdk import openbb +``` + +`ipython` is a good choice for exploring and working on scripts without saving them as a new file, while the plain command line version, `python`, is what a scripted `.py` file would use to run. + +### Jupyter + +Jupyter is a code editor and IDE that runs in a web browser, served over localhost. No additional installation steps are required to use it, in two flavours, `notebook` and `lab`. Both are launched from the terminal command line, after activating the `obb` virtual Python environment. + +```console +conda activate obb +jupyter lab +``` + +Or + +```console +conda activate obb +jupyter notebook +``` + +This will launch the Jupyter server and open a browser window with the application. + +![Jupyter Lab](https://github.com/OpenBB-finance/OpenBBTerminal/assets/85772166/4a289ef0-11af-4909-af7a-66fe97e9ffea) + +There will be only one choice for the kernel, `Python3 (ipykernel)`. Click on, `Select`. + +In the console window (or a new Notebook file) the OpenBB SDK is imported by entering: + +```console +from openbb_terminal.sdk import openbb +``` + +Docstrings can be viewed in a pop-up with the key command, `shift+tab`. The contents of each module (similar to the menus in the OpenBB Terminal) can be browsed by hitting the `tab` key. + +![Jupyter Lab Import](https://github.com/OpenBB-finance/OpenBBTerminal/assets/85772166/7cc04e49-57fe-4bbf-bb5e-4cfbdab62eaf) + +The `Contextual Help` window displays more details, and also previews DataFrames after they are assigned. These tools are an excellent way to understand the structure of the SDK along with the syntax for each command and argument. + +### Code Editors and IDEs + +Regardless of the code editor of choice, the program must know that the `obb` virtual Python environment exists. The steps for setting it up will vary by platform, consult the manual for the specific editor. VS Code is a recommended choice because it is free, flexible, and has integrations with GitHub and Jupyter, and has a plugin marketplace that can enhance a workspace with tools like GitHub Co-Pilot. Some code editing and IDE suites will charge a subscription for Jupyter integrations, which make them less ideal. + +:::note +Spyder is not recommended for installing or operating the OpenBB SDK. +::: + +#### Helpful VS Code Extensions + +Installing a few extensions in VS Code will improve the user experience and provide enhanced functionality. + +- Python Extension Pack (Don Jayamanne) +- Jupyter PowerToys (Microsoft) +- Jupyter Notebook Renderers +- Codeium + +Icons on the sidebar for Jupyter and Python provide quick access to the virtual environments, and a new notebook or interactive window are created with a mouse click. + +![VS Code](https://github.com/OpenBB-finance/OpenBBTerminal/assets/85772166/bf04c707-a591-47c8-a5e9-c4c0e60e302a) + +When opening a Notebook file, or a new interactive window, ensure that the correct environment is being used. If the selected environment is not the one created during installation, the OpenBB SDK will not import. + +Click on the item in the top-right of the window to select or change the environment. + +![VS Code environment](https://github.com/OpenBB-finance/OpenBBTerminal/assets/85772166/0e4904cf-4ff7-4130-b965-30b3de140392) + +The OpenBB SDK is imported with: + +```python +from openbb_terminal.sdk import openbb +``` + +## Navigation + +The layout of the OpenBB SDK is similar to the menus in the OpenBB Terminal, with each one represented as a module. Instead of a `/` in the path, it is `.`. For example, `openbb.stocks.gov` is the Government submodule of `stocks`. + +![Navigation](https://github.com/OpenBB-finance/OpenBBTerminal/assets/85772166/ad3617fe-b84c-4bbd-9139-2563702849ba) + +The attributes for each module - and docstrings for a function - can also be printed directly to the screen, insert a question mark at the end of the string. + +```jupyterpython +openbb.stocks.gov.contracts? +``` + +**Note**: For a regular `python` session, the syntax is: `help(openbb.stocks.gov.contracts)` + +``` +Signature: openbb.stocks.gov.contracts(symbol: str, past_transaction_days: int = 10) -> pandas.core.frame.DataFrame +Call signature: openbb.stocks.gov.contracts(*args: Any, **kwargs: Any) -> Any +Type: get_contracts +String form: +File: ~/GitHub/OpenBBTerminal/openbb_terminal/stocks/government/quiverquant_model.py +Docstring: +Get government contracts for ticker [Source: quiverquant.com] + +Parameters +---------- +symbol: str + Ticker to get congress trading data from +past_transaction_days: int + Number of days to get transactions for + +Returns +------- +pd.DataFrame + Most recent transactions by members of U.S. Congress +``` + +## Docstrings + +Docstrings are the SDK equivalent to the Terminal's `--help` argument. They contain information on the functions, its input parameters, and the type of data being returned. The Contextual Help window, in Jupyter, is a very convenient way to keep this information on hand. Referencing the docstrings will greatly reduce the need to consult the online documentation pages. + +![Docstrings](https://github.com/OpenBB-finance/OpenBBTerminal/assets/85772166/ffbfcdec-c16e-41e7-8828-b099325910a5) + +## API Keys + +The `keys` module provides methods for managing access credentials to data sources. If the API keys have already been set in a locally installed OpenBB Terminal application, no further action is required. A new installation can be authorized using the OpenBB Hub, or they can be entered manually in the SDK. For instructions on obtaining and authorizing each individual source, see the guide [here](/sdk/usage//api-keys). A key can be stored permanently, or only for the active session. Use the `persist` boolean argument to remember or forget it. + +```python +openbb.keys.fred(key= "REPLACE_WITH_YOUR_KEY", persist=True) +``` + +### Authorize With the OpenBB Hub + +API keys can be imported to the session by logging in to an [OpenBB Hub account](https://my.openbb.co/app/sdk/api-keys). The session can persist, if desired, otherwise they will be valid only for the current session. We recommend connecting to Hub by generating a Personal Access Token. Follow the [link](https://my.openbb.co/app/sdk/api-keys), scroll to the bottom of the page, and click the "Generate" button. + +![OpenBB Personal Access Token](https://github.com/OpenBB-finance/OpenBBTerminal/assets/85772166/8c3988b4-cba9-4008-b8f3-04eef72878be) + +Copy the generated token and enter as the value for the `token` parameter, ignoring the email and password fields. By default, the credentials will be forgotten when the SDK session is terminated. + +```jupyterpython +openbb.login? +``` + +``` +Signature: +openbb.login( + email: str = '', + password: str = '', + token: str = '', + keep_session: bool = False, + silent: bool = False, +) +Docstring: +Login and load user info. +If there is a saved session it will be used (this can be achieved by `keep_session=True`). +If there's not a local session, +the user can use either email and password or the OpenBB Personal Access Token. + +Parameters +---------- +email : str + The email. +password : str + The password. +token : str + The OpenBB Personal Access Token. +keep_session : bool + Keep the session, i.e., next time the user logs in, + there is no need to enter the email and password or the token. +silent : bool + If True, the console print will be silent. + +Examples +-------- +>>> from openbb_terminal.sdk import openbb +>>> openbb.login(email="", password="") +File: ~/GitHub/OpenBBTerminal/openbb_terminal/core/session/sdk_session.py +Type: function +``` + +Login with an access token with the syntax: + +```python +openbb.login(token = "REPLACE_WITH_THE_PERSONAL_ACCESS_TOKEN") +``` + +The token can be revoked from the OpenBB Hub API Keys page, by clicking on the `Regenerate` button, which will invalidate the current one. + +## How to Use the SDK + +The syntax examples provided assume that the SDK has already been imported. + +```python +from openbb_terminal.sdk import openbb +``` + +### Function Inputs + +The majority of parameters accept a string as the input. The docstrings will describe the expected inputs, but most will follow these general guidelines, unless otherwise stated: + +- String values are surrounded by quotation marks, or a single apostrophe. + - `"the string"`, or `'the string to enter'` +- Some commands expect a list for the main input, and are contained within square brackets, with each item separated by a comma. + - `["the first string", "the second string"]` + - `openbb.stocks.quote(["SPY", "QQQ", "IWM", "AAPL", "MSFT", "TSLA", "GOOG", "META", "AMZN"])` +- Dates are entered as a string, and follow the format: "YYYY-MM-DD". + - `openbb.stocks.load("SPY", start_date="1994-01-01")` +- When the expected input of a parameter is an integer or float value, they are entered without quotes. + - `limit = 10` +- Boolean arguments are always capitalized. + - True + - False + +### Function Responses + +Most data objects returned by functions are Pandas DataFrames, and the results will be printed without first assigning it to a variable. + +```python +openbb.stocks.quote("SPY") +``` + +![Data Response](https://github.com/OpenBB-finance/OpenBBTerminal/assets/85772166/cb932ee1-3a87-4744-81a5-840c452eac51) + +The presentation of the responses will vary by platform, the sample above is from Jupyter Lab. When the same function in the Terminal outputs a chart, the response is separated into the model and view components. The SDK map will show two functions for the same command where the second has `_chart` added on. Using this second command will display the chart while the former returns the raw Pandas DataFrame. + +![Model and View](https://github.com/OpenBB-finance/OpenBBTerminal/assets/85772166/08bccaae-13f3-4fcd-857c-13cd30250492) + +```python +data = openbb.stocks.load("SPY", weekly = True) +openbb.ta.atr_chart(data, symbol = "SPY") +``` + +If the SDK session is from the command line (`python` or `ipython`), a window will open to display the chart. Within an IDE, or Jupyter Notebook, they will be displayed inline and will not have the same toolbars. + +![openbb.ta.atr_chart](https://github.com/OpenBB-finance/OpenBBTerminal/assets/85772166/b668556b-27a5-49cc-989b-8d7de1e420e2) + +### Passing Data Through + +Using the output of one function to feed another input will be a common workflow. Basic operations do not require importing any Python packages. The example below adds a new column, with the 20-day simple moving average, to the existing DataFrame. + +```python +data = openbb.stocks.load('VOO', start_date = "2022-05-15") +data["SMA"] = openbb.ta.sma(data = data["Close"], length = 20) +``` + +The code block below takes the top ten results from the `unusual_volume` [screener preset](/sdk/data-available/stocks/stocks-screener), gets a single DataFrame with the daily returns for each ticker YTD, then identifies the date of the best performing day. These operations will require importing the Pandas library to the session. + +```python +import pandas as pd + +results = openbb.stocks.screener.screener_data('unusual_volume') +tickers = results.sort_values(by = "Volume", ascending = False).head(10)["Ticker"].to_list() +openbb.stocks.quote(tickers) +ytd_returns = openbb.stocks.ca.hist(tickers, start_date = '2023-01-01', candle_type = 'r') +date = ytd_returns.idxmax() +returns = ytd_returns.max() +max_returns = pd.concat([date,returns], axis = 1) +max_returns.columns = ["Date", "Returns"] + +max_returns +``` + +| | Date | Returns | +|:-----|:--------------------|----------:| +| GSIT | 2023-05-12 00:00:00 | 2.10366 | +| WISA | 2023-03-27 00:00:00 | 0.894737 | +| LMFA | 2023-05-15 00:00:00 | 0.399731 | +| OKE | 2023-05-05 00:00:00 | 0.0300176 | +| GETR | 2023-05-12 00:00:00 | 0.450151 | +| MMP | 2023-05-15 00:00:00 | 0.12994 | +| ORMP | 2023-05-15 00:00:00 | 0.106007 | +| MGOL | 2023-03-28 00:00:00 | 0.322957 | +| TIVC | 2023-01-12 00:00:00 | 0.19 | +| REAL | 2023-05-08 00:00:00 | 0.191304 | + +### OpenBB Figure Objects + +Functions returning a chart will have a boolean argument labeled, `external_axes`. When this is set as `True`, and the function's output is assigned to a variable, a Plotly figure object is returned, which can be manipulated accordingly. Copy the block below to see all the parameters that can be set. + +```jupyterpython +data = openbb.stocks.candle("SPY", external_axes = True) +data? +``` + +![OpenBB Figure](https://github.com/OpenBB-finance/OpenBBTerminal/assets/85772166/71f272f4-49eb-42c7-bd93-bd06f364ce32) + +Charts called from a command line session, will open a new window and appear the same as they are in the OpenBB Terminal application. + +![OpenBB Terminal Charts](https://user-images.githubusercontent.com/85772166/233247951-e011fe2c-23a6-4518-bd17-3f43a9c2011a.png) + +See the page [here](/terminal/usage/basics#charts) for a detailed explanation of the toolbar. + +To create an empty figure object, import the `OpenBBFigure` class directly. + +```python +from openbb_terminal.core.plots import OpenBBFigure +fig = OpenBBFigure() +``` + +### Chart Themes + +Themes used by the charting and tables libraries are accessible in the SDK through a separate import statement. + +```python +from openbb_terminal import theme +``` + +Print the path to the location of the style files with: + +```python +theme.plt_styles_available +``` + +Set the charts theme as light or dark: + +```python +theme.apply_style('light') +``` + +Refer to the [Plotly documentation](https://plotly.com/python/templates/) for details on customizing style sheets. + +### Chart Cheat Sheet + +![OpenBB Chart Cheat Sheet](https://user-images.githubusercontent.com/85772166/234313541-3d725e1c-ce48-4413-9267-b03571e0eccd.png) + +### Changing Data Sources + +The source of the data can be specified - where more than one is available - by including the `source` argument in the syntax. + +```python +polygon = openbb.stocks.load("SPY", source = "Polygon") +eodhd = openbb.stocks.load("SPY", source = "EODHD") +av = openbb.stocks.load("SPY", source = "AlphaVantage") +intrinio = openbb.stocks.load("SPY", source = "Intrinio") +databento = openbb.stocks.load("SPY", source = "DataBento") +``` + +## Support, Bug Reports & Feedback + +Issues can be raised through the [support page](https://my.openbb.co/app/sdk/support) or on [GitHub](https://github.com/OpenBB-finance/OpenBBTerminal/issues/new/choose). You can also chat with the community on [Discord](https://openbb.co/discord) to find help or inspiration. Feedback is always welcome. diff --git a/website/content/terminal/_category_.json b/website/content/terminal/_category_.json new file mode 100644 index 000000000000..cd167daf5312 --- /dev/null +++ b/website/content/terminal/_category_.json @@ -0,0 +1,4 @@ +{ + "label": "OpenBB Terminal", + "position": 2 +} diff --git a/website/versioned_docs/version-v3/bot/changelog/_category_.json b/website/content/terminal/changelog/_category_.json similarity index 100% rename from website/versioned_docs/version-v3/bot/changelog/_category_.json rename to website/content/terminal/changelog/_category_.json diff --git a/website/versioned_docs/version-v3/terminal/changelog/version2_0_0.mdx b/website/content/terminal/changelog/version2_0_0.mdx similarity index 100% rename from website/versioned_docs/version-v3/terminal/changelog/version2_0_0.mdx rename to website/content/terminal/changelog/version2_0_0.mdx diff --git a/website/versioned_docs/version-v3/terminal/changelog/version2_1_0.mdx b/website/content/terminal/changelog/version2_1_0.mdx similarity index 100% rename from website/versioned_docs/version-v3/terminal/changelog/version2_1_0.mdx rename to website/content/terminal/changelog/version2_1_0.mdx diff --git a/website/versioned_docs/version-v3/terminal/changelog/version2_2_0.mdx b/website/content/terminal/changelog/version2_2_0.mdx similarity index 100% rename from website/versioned_docs/version-v3/terminal/changelog/version2_2_0.mdx rename to website/content/terminal/changelog/version2_2_0.mdx diff --git a/website/versioned_docs/version-v3/terminal/changelog/version2_3_0.mdx b/website/content/terminal/changelog/version2_3_0.mdx similarity index 100% rename from website/versioned_docs/version-v3/terminal/changelog/version2_3_0.mdx rename to website/content/terminal/changelog/version2_3_0.mdx diff --git a/website/versioned_docs/version-v3/terminal/changelog/version2_3_1.mdx b/website/content/terminal/changelog/version2_3_1.mdx similarity index 100% rename from website/versioned_docs/version-v3/terminal/changelog/version2_3_1.mdx rename to website/content/terminal/changelog/version2_3_1.mdx diff --git a/website/versioned_docs/version-v3/terminal/changelog/version2_4_0.mdx b/website/content/terminal/changelog/version2_4_0.mdx similarity index 100% rename from website/versioned_docs/version-v3/terminal/changelog/version2_4_0.mdx rename to website/content/terminal/changelog/version2_4_0.mdx diff --git a/website/versioned_docs/version-v3/terminal/changelog/version2_4_1.mdx b/website/content/terminal/changelog/version2_4_1.mdx similarity index 100% rename from website/versioned_docs/version-v3/terminal/changelog/version2_4_1.mdx rename to website/content/terminal/changelog/version2_4_1.mdx diff --git a/website/versioned_docs/version-v3/terminal/changelog/version2_5_0.mdx b/website/content/terminal/changelog/version2_5_0.mdx similarity index 100% rename from website/versioned_docs/version-v3/terminal/changelog/version2_5_0.mdx rename to website/content/terminal/changelog/version2_5_0.mdx diff --git a/website/versioned_docs/version-v3/terminal/changelog/version2_5_1.mdx b/website/content/terminal/changelog/version2_5_1.mdx similarity index 90% rename from website/versioned_docs/version-v3/terminal/changelog/version2_5_1.mdx rename to website/content/terminal/changelog/version2_5_1.mdx index 2a52912bda0e..50a63e6c7b5b 100644 --- a/website/versioned_docs/version-v3/terminal/changelog/version2_5_1.mdx +++ b/website/content/terminal/changelog/version2_5_1.mdx @@ -1,5 +1,5 @@ --- -title: 2.5.1 +title: v2.5.1 version: "2.5.1" date: 2023-03-01 description: Current - v2.5.1 diff --git a/website/versioned_docs/version-v3/terminal/changelog/version3_0_0.mdx b/website/content/terminal/changelog/version3_0_0.mdx similarity index 100% rename from website/versioned_docs/version-v3/terminal/changelog/version3_0_0.mdx rename to website/content/terminal/changelog/version3_0_0.mdx diff --git a/website/versioned_docs/version-v3/terminal/changelog/version3_0_1.mdx b/website/content/terminal/changelog/version3_0_1.mdx similarity index 100% rename from website/versioned_docs/version-v3/terminal/changelog/version3_0_1.mdx rename to website/content/terminal/changelog/version3_0_1.mdx diff --git a/website/versioned_docs/version-v3/terminal/changelog/version3_1_0.mdx b/website/content/terminal/changelog/version3_1_0.mdx similarity index 100% rename from website/versioned_docs/version-v3/terminal/changelog/version3_1_0.mdx rename to website/content/terminal/changelog/version3_1_0.mdx diff --git a/website/versioned_docs/version-v3/terminal/changelog/version3_2_0.mdx b/website/content/terminal/changelog/version3_2_0.mdx similarity index 100% rename from website/versioned_docs/version-v3/terminal/changelog/version3_2_0.mdx rename to website/content/terminal/changelog/version3_2_0.mdx diff --git a/website/versioned_docs/version-v3/terminal/changelog/version3_2_1.mdx b/website/content/terminal/changelog/version3_2_1.mdx similarity index 100% rename from website/versioned_docs/version-v3/terminal/changelog/version3_2_1.mdx rename to website/content/terminal/changelog/version3_2_1.mdx diff --git a/website/versioned_docs/version-v3/bot/faqs/_category_.json b/website/content/terminal/faqs/_category_.json similarity index 100% rename from website/versioned_docs/version-v3/bot/faqs/_category_.json rename to website/content/terminal/faqs/_category_.json diff --git a/website/content/terminal/faqs/bugs_support_feedback.md b/website/content/terminal/faqs/bugs_support_feedback.md new file mode 100644 index 000000000000..856cb1c589b6 --- /dev/null +++ b/website/content/terminal/faqs/bugs_support_feedback.md @@ -0,0 +1,59 @@ +--- +title: Bugs, Support, and Feedback +sidebar_position: 5 +description: Familiarize yourself with common issues and bug reports within our OpenBB + Terminal, explore our patch release process and learn how to report issues or get + support for OpenBB Terminal. You'll also learn how to provide feedback and request + specific features within the platform. +keywords: +- GitHub +- bugs +- patches +- issue reporting +- support +- Discord +- feature requests +- machine learning +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +When an error is encountered, it is always a good idea to check the open issues on [GitHub](https://github.com/OpenBB-finance/OpenBBTerminal/issues). There may be a workaround solution for the specific problem until a patch is released. + +
How often are patches for bugs released? + +The installer versions are packaged approximately every two-weeks. Those working with a cloned GitHub version can checkout the Develop branch to get the latest fixes and releases before they are pushed to the main branch. + +```console +git checkout develop +``` + +
+ +
How do I report a bug? + +First, search the open issues for another report. If one already exists, attach any relevant information and screenshots as a comment. If one does not exist, start one with this [link](https://github.com/OpenBB-finance/OpenBBTerminal/issues/new?assignees=&labels=type%3Abug&template=bug_report.md&title=%5BBug%5D) + +
+ +
How can I get help with OpenBB Terminal? + +You can get help with OpenBB Terminal by joining our [Discord server](https://openbb.co/discord) or contact us in our support form [here](https://openbb.co/support). + +
+ +
How can I give feedback about the OpenBB Terminal, or request specific functionality? + +Being an open source platform that wishes to tailor to the needs of any type of investor, we highly encourage anyone to share with us their experience and/or how we can further improve the OpenBB Terminal. This can be anything from a very small bug, a new feature, or the implementation of a highly advanced Machine Learning model. + +You are able to directly send us information about a bug or a question/suggestion from inside the terminal by using the `support` command which is available everywhere in the terminal. Here you can select which command you want to report a bug on, ask a question or make a suggestion. After entering `support`, when you press `ENTER` (⏎), you are taken to the Support form which is automatically filled with your input. You are only required to include the type (e.g. bug, suggestion or question) and message in the form, although this can also be set directly from inside the terminal (see `support -h`). + +Alternatively, you can contact us via the following routes: + +- If you notice that a feature is missing inside the terminal, please fill in the [Request a Feature](https://openbb.co/request-a-feature) form. +- If you wish to report a bug, have a question/suggestion or anything else, please fill in the [Support](https://openbb.co/support) form. +- If you wish to speak to us directly, please contact us on [Discord](https://openbb.co/discord). + +
diff --git a/website/content/terminal/faqs/data_sources.md b/website/content/terminal/faqs/data_sources.md new file mode 100644 index 000000000000..6d2aedabff1f --- /dev/null +++ b/website/content/terminal/faqs/data_sources.md @@ -0,0 +1,77 @@ +--- +title: Data and Sources +sidebar_position: 4 +description: The page discusses the data sources and functionalities of OpenBB, an + aggregator of data from various sources. It guides on troubleshooting, locating + data, and requesting features. +keywords: +- data aggregator +- troubleshooting guide +- data sources +- ticker symbols +- load function +- feature request +- data providers +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +## Data and Sources + +Please note that OpenBB does not provide any data, it is an aggregator which provides users access to data from a variety of sources. OpenBB does not maintain or have any control over the raw data supplied. If there is a specific problem with the output from a data provider, please consider contacting them first. + +
Is there a list of all data providers? + +The complete list is found [here](/terminal/usage/data/api-keys) + +
+ +
How do I find and load a ticker symbol from India, or any other country? + +Use the [`/stocks/search`](/terminal/data-available/stocks#search) command. + +```console +search --country canada --industrygroup banks +``` + +Ticker symbols listed on exchanges outside of the US will have a suffix attached, for example, Rico Auto Industries Limited: + +```console +load ricoauto.ns +``` + +The precise naming convention will differ by source, reference each source's own documentation for specific details. + +
+ +
Data from today is missing. + +By default, the load function requests end-of-day daily data and is not included until the EOD summary has been published. The current day's data is considered intraday and is loaded when the `interval` argument is present. + +```console +load SPY -i 60 +``` + +
+ +
Can I stream live prices and news feeds? + +The OpenBB Terminal is not currently capable of streaming live feeds through websocket connections. + +
+ +
"Pair BTC/USDT not found in binance" + +US-based users are currently unable to access the Binance API. Please try loading the pair from a different source, for example: + +`load btc --source CCXT --exchange kraken` + +
+ +
How can I request functionality for a specific data source? + +Please [request a feature](https://openbb.co/request-a-feature) by submitting a new request. + +
diff --git a/website/content/terminal/faqs/developer_issues.md b/website/content/terminal/faqs/developer_issues.md new file mode 100644 index 000000000000..d3a9d8cf79c5 --- /dev/null +++ b/website/content/terminal/faqs/developer_issues.md @@ -0,0 +1,169 @@ +--- +title: Developer Issues +sidebar_position: 6 +description: This page helps with frequently asked questions regarding debugging, + GitHub pull requests, and common error resolutions. The guide includes steps on + how to launch in debug mode, switching branches, handling missing dependencies like + wheel, dealing with .whl files, understanding JSONDecodeError, correcting line break + errors, and using VS Code terminal. +keywords: +- debug mode +- GitHub pull requests +- error resolutions +- missing dependencies +- wheel +- .whl file errors +- JSONDecodeError +- line break errors +- VS Code terminal +- poetry +- conda +- pip +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +
How do I launch in debug mode? + +When installed from source, the OpenBB Terminal can be launched in debug mode. Launch the Terminal using the syntax below. + +```python +python terminal.py --debug +``` + +Operate the Terminal normally, and errors will trigger an interrupt which prints the traceback with the error. Charts and tables will also include a developer tools button, located at the top-left of the window, for identifying issues specific to the PyWry interactive window. + +
+ +
What branch on GitHub should pull requests be submitted to? + +Pull requests submitted to the Main branch will not be merged, please create branches from the `develop` branch. + +To switch to the develop branch: + +```console +git checkout develop +``` + +Branches must also follow the naming convention: + +- /feature/name_your_branch + - For developing functionality. +- /hotfix/name_your_patch + - For bug patches. + +
+ +
Error: "git pull" fails because of a hot fix: cannot lock ref + +If the error message looks something like: + +```console +cannot lock ref: 'refs/remotes/origin/hotfix' exists; cannot create +``` + +Try: + +```console +git remote prune origin +git pull +``` + +
+ +
What does it mean if it says wheel is missing? + +If you receive any notifications regarding `wheel` missing, this could be due to this dependency missing. + +`conda install -c conda-forge wheel` or `pip install wheel` + +
+ +
Why do these .whl files not exist? + +If you get errors about .whl files not existing (usually on Windows) you have to reinitialize the following folder. +Just removing the 'artifacts' folder could also be enough: + +| Platform | Location | +| -------- | ------------------------------- | +| Linux | "~/.cache/pypoetry" | +| Mac | "~/Library/Caches/pypoetry" | +| Windows | "%localappdata%/pypoetry/cache" | + +When you try to add a package to Poetry it is possible that it causes a similar issue. Here you can remove the +'artifacts' folder again to reinitialize Poetry. + +If you run into trouble with Poetry, and the advice above did not help, your best bet is to try + +- `poetry update --lock` +- `conda deactivate` -> `conda activate obb`, then try again +- Track down the offensive package and purge it from your anaconda `` folder, then try again + +| Platform | Location | +| --------- | ------------------------------------------- | +| Linux/Mac | ~/anaconda3/envs, or , ~/opt/anaconda3/envs | +| Windows | %userprofile%/anaconda3/envs | + +- Completely nuke your conda environment folder and make a new environment from scratch + + - `conda deactivate` + - `conda env remove -n obb` + - `conda clean -a` + - Make a new environment and install dependencies again. +- Reboot your computer and try again +- Submit a ticket on GitHub + +
+ +
What does the JSONDecodeError mean during poetry install? + +Sometimes poetry can throw a `JSONDecodeError` on random packages while running `poetry install`. This can be observed on macOS 10.14+ running python 3.8+. This is because of the use of an experimental installer that can be switched off to avoid the mentioned error. Run the code below as advised [here](https://github.com/python-poetry/poetry/issues/4210) and it should fix the installation process. + +```bash +poetry config experimental.new-installer false +``` + +_Commands that may help you in case of an error:_ + +- `python -m pip install --upgrade pip` +- `poetry update --lock` +- `poetry install` + +
+ +
How do I deal with errors regarding CRLF? + +When trying to commit code changes, pylint will prevent you from doing so if your line break settings are set to +CRLF (default for Windows). +This is because the entire package uses LF (default for Linux/Mac), and it is therefore +important that you change this setting to LF _before_ you make any changes to the code. + +It is possible that CRLF automatically turns back on, you can correct this with: + +```bash +git config --global core.autocrlf false +``` + +In case you already made coding adjustments, you have to reset your cache, and the changes you made to the code with +the following: + +```bash +git rm --cached -r . +git reset --hard +``` + +
+ +
Why can't I run OpenBB via the VS Code integrated terminal? + +This occurs when VS Code terminal python version/path is different from the terminal version. + +To fix it add this to vscode JSON settings ([ref](https://stackoverflow.com/questions/54582361/vscode-terminal-shows-incorrect-python-version-and-path-launching-terminal-from)): + +```bash + "terminal.integrated.inheritEnv": false, +``` + +
diff --git a/website/content/terminal/faqs/general_operation.md b/website/content/terminal/faqs/general_operation.md new file mode 100644 index 000000000000..870375f4d26d --- /dev/null +++ b/website/content/terminal/faqs/general_operation.md @@ -0,0 +1,129 @@ +--- +title: General Operation +sidebar_position: 3 +description: Learn how to overcome system-related issues by enabling the 'developer + mode' on Windows and MacOS. Get answers for queries and potential issues. Here, + you'll also get to know how to run applications that do not meet the system's security + policy, allow apps through firewall and get tips on portfolio management. +keywords: +- developer mode +- overcome system-related issues +- Windows +- MacOS +- run applications +- system's security policy +- allow apps through firewall +- Portfolio management +- Settings +- FAQ +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Both Windows and MacOS provide a "developer mode", and enabling it may help to overcome system-related issues. + +**MacOS**: Go to the System Settings, and under the "Privacy and Security" tab, scroll to the bottom and select the option to "Allow applications downloaded from App Store and identified developers". Then, scroll up to click on, "Developer Tools", and add `Terminal.app` and `Visual Studio Code` (or the preferred code editor) to the list of applications allowed to run software locally that does not meet the system's security policy. + +**Windows**: Go to the Control Panel, and under the "Privacy & Security" tab, click on, "For developers". Under this menu, turn "Developer Mode" on. + +From the Windows Security menu, click on the Firewall & Network Protection tab, then click on "Allow an app through firewall". If the applications below are not allowed to communicate through Windows Defender Firewall, change the settings to allow. + +- BranchCache +- Hyper-V +- VcXsrv +- Windows Terminal + +
Why does a specific menu or command not exist? + +It could be that you are running an outdated version in which the menu or command is not yet available. Please check the [installation guide](/terminal/installation) to download the most recent release. + +Do note that it is also possible that the menu or command has been deprecated. If this is oversight, please reach out to us [here](https://openbb.co/support). + +
+ +
Charts do not display on Linux/WSL or Docker installation. + +Check that X-11, or similar, is installed, open, and configured. Follow the instructions pertaining to the system here: [/terminal/installation/docker](/terminal/installation/docker) + +
+ +
How do I retrieve more results than is returned by default? + +Most functions will have either, `--start` and `--end` flags, or a `--limit` argument. Print the help dialogue for any command by attaching, `--help` or `-h`. + +
+ +
Does the portfolio menu allow for dividends, interest, or other distributions? + +Currently, this is only possible by manually updating the portfolio file. + +
+ +
Why does my Portfolio file fail to load? + +This can be the result of a formatting error, check the file in a simple text editor to observe any abnormalities in the formatting; or, it could be a bug - check the [GitHub issues page](https://github.com/OpenBB-finance/OpenBBTerminal/issues) for similar errors. + +- Check that all the necessary column titles are present. +- Inspect the file to see if cells left blank have been filled unintentionally with 0 or NaN values. +- A particular asset may not be able to load data. Check for valid historical data from the Stocks menu. +- Format ticker symbols according to yFinance naming convention. +- All dates must be entered as YYYY-MM-DD. +- Transactions dated for today will fail to load historical data. +- MacOS users should attempt to avoid using the Numbers application as it has a habit of changing the formatting while saving. + +Files can be formatted as either `.csv` or `.xlsx` files, and the required column headers are: + +`[Date,Type,Ticker,Side,Price,Quantity,Fees,Investment,Currency,Sector,Industry,Country,Region]` + +See the guide [here](/sdk/data-available/portfolio/introduction) for more information. + +
+ +
How do I change the chart styles? + +See the guide [here](/terminal/usage/overview/customizing-the-terminal). The theme can be toggled between light and dark mode, directly on the individual chart. See the [Terminal Basics page](/terminal/usage/basics#charts) for more information on working with the charts. + +
+ +
Can I change the colors of the text in the Terminal? + +Yes, use the `colors` command under the `/settings` menu: [/terminal/usage/overview/customizing-the-terminal](/terminal/usage/overview/customizing-the-terminal) + +
+ +
After setting the preset in the stocks screener, nothing happens. + +Print the current screen again with by entering, `?`. Does the name of the selected preset display? With a preset loaded, run the screener by entering one of the commands below: + +- Financial +- Ownership +- Overview +- Performance +- Technical +- Valuation + +
+ +
Forecast functions say to enter a valid data set + +Because an unlimited number of data sets can be loaded into the Forecast menu, each function requires defining the specific data set to be used. Add the `-d` or `--dataset` argument to the command, along with the name of the desired data set. + +```console +rnn -d SPY +``` + +
+ +
How do I find stocks from India, or another country? + +Use the `search` command from the `/stocks` menu. Refer to the menu's introduction guide [here](/terminal/data-available/stocks#search). + +As an example, try this: + +```console +search --country india --exchange-country india --limit 1000 +``` + +
diff --git a/website/content/terminal/faqs/installation_updates.md b/website/content/terminal/faqs/installation_updates.md new file mode 100644 index 000000000000..b063447cf159 --- /dev/null +++ b/website/content/terminal/faqs/installation_updates.md @@ -0,0 +1,117 @@ +--- +title: Installation and Updates +sidebar_position: 1 +description: This page provides comprehensive insights about installing and updating + the OpenBB Terminal. It discusses system requirements, installation process, common + errors and their solutions. Information about updating the OpenBB Terminal through + different methods is also covered. +keywords: +- OpenBB Terminal installation +- Updating OpenBB Terminal +- System requirements for OpenBB Terminal +- Installation errors with OpenBB Terminal +- Python pip installation +- Microsoft Visual C++ +- Homebrew installation +- libomp +- Conda installation issue +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +## Installation and Updates + +
How much hard drive space is required? + +An installation will use approximately 4-5 GB of space, with additional storage required for optional machine learning models. + +
+ +
What is the minimum version of Windows or MacOS required to install the OpenBB Terminal? + +The OpenBB Terminal installation packages are compatible with: + +- Windows 10 or later. +- MacOS Monterey or later. + +**Note:** Machines which are not compatible with the installer packages may be able to install from the source code. + +
+ +
How do I update my installation to the latest version? + +The terminal is constantly being updated with new features and bug fixes. The process for updating will vary by the installation type: + +- As of version 2.4.1, the Windows installer has an option for uninstalling the existing prior to updating. +- For other installer versions, uninstall the previous version (uninstall.exe for Windows, delete the Application folder on MacOS); then, download the latest version and reinstall. User settings and data will remain. +- For a `pip` installation, when a new version is published: `pip install -U openbb[all]` +- Upgrade a cloned version of the GitHub repo with: + +```console +git fetch +git pull +poetry install -E all +``` + +**Notes:** If the cloned repository is a fork, pull from: `git pull origin main` or `git pull origin develop`. If there are changes locally to the files that conflict with the incoming changes from GitHub, stash them before pulling from main with `git stash`. + +
+ +### PyPi Nightly + +The nightly build can be installed with: + +```console +pip install openbb-terminal-nightly[all] +``` + +**Note**: This version may not be stable and should not be used in a production setting. + +
"Microsoft Visual C++ 14.0 or greater is required" + +Download and install [C++ Build Tools](https://visualstudio.microsoft.com/visual-cpp-build-tools/), restart the machine, then try again. + +![image](https://github.com/OpenBB-finance/OpenBBTerminal/assets/85772166/ceb57be0-6dae-42f2-aca6-bf62ce7d6135) + +![image](https://github.com/OpenBB-finance/OpenBBTerminal/assets/85772166/f8aef8fc-a080-4164-bd36-460714ec44f3) + +
+ +
Error: failed building wheel for bt + +There may be an additional message that is printed from this error, stating: "Microsoft Visual C++ 14.0 or greater is required. Get it with "Microsoft C++ Build Tools". + +Download and install it. [https://visualstudio.microsoft.com/visual-cpp-build-tools/](https://visualstudio.microsoft.com/visual-cpp-build-tools/) + +Mac and Linux users may also encounter a similar error because a C++ compiler is not installed. Install Homebrew: + +```console +/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)" +``` + +Then run: + +```console +brew install gcc +brew install cmake +``` + +
+ +
Miniconda3 will not install on ARM/Linux Raspberry Pi machines. + +Refer to this issue on the Conda [GitHub](https://github.com/conda/conda/issues/10723) page. + +
+ +
Error: Library not loaded: '/usr/local/opt/libomp/lib/libomp.dylib' + +This error is resolved by installing libomp from Homebrew: + +```console +brew install libomp +``` + +
diff --git a/website/versioned_docs/version-v3/terminal/faqs/launching.md b/website/content/terminal/faqs/launching.md similarity index 84% rename from website/versioned_docs/version-v3/terminal/faqs/launching.md rename to website/content/terminal/faqs/launching.md index dfebd39eec95..82970d5d8f2d 100644 --- a/website/versioned_docs/version-v3/terminal/faqs/launching.md +++ b/website/content/terminal/faqs/launching.md @@ -1,36 +1,25 @@ --- title: Launching sidebar_position: 2 -description: Help and troubleshooting when experiencing errors when launching the OpenBB Termainl. +description: Comprehensive troubleshooting guide for various software and system compatibility + issues encountered while using the OpenBB Terminal. Covers topics such as Mac M1/M2 + Rosetta installation, Terminal, and SDK launch issues, ModuleNotFoundError solutions, + SSL certificates authorization failures, proxy connection issues, and Linux Ubuntu + specific problems. keywords: - [ - installation, - installer, - install, - guide, - mac, - windows, - linux, - python, - github, - macos, - how to, - explanation, - openbb terminal, - ssl, - certificate, - launch, - invalid cpu, - fail to launch, - fontconfig, - linux, - ubuntu - ] +- Mac M1/M2 Rosetta installation +- Incompatible library version issue +- Terminal app launch failure +- ModuleNotFoundError OpenBB troubleshooting +- Fontconfig warning solution +- SSL certificates authorization failure +- Proxy connection issues +- Linux Ubuntu OpenBB launch issue --- import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - +
Mac: Invalid CPU Type - Terminal fails to launch. diff --git a/website/content/terminal/index.md b/website/content/terminal/index.md new file mode 100644 index 000000000000..e44fb815821d --- /dev/null +++ b/website/content/terminal/index.md @@ -0,0 +1,66 @@ +--- +title: Introduction +sidebar_position: 0 +description: OpenBB is an open source investment research software aimed at analyzing + financial market data. It makes use of data science and machine learning to convert + raw data into meaningful investment understanding. +keywords: +- investment research software +- financial market data analysis +- open source +- machine learning +- data science +- data providers +- premium API keys +- investment research platform +- contributing guidelines +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +The OpenBB Terminal is the first and only open source investment research platform. The terminal connects to dozens of different data providers and allows users to access investment research from a single platform. More than that, due to its open source nature, users can add custom data sources or build their own analysis on top. + +terminal + +--- + +- **WHY OPEN SOURCE?** + +Unlike closed source products, open source products allow for higher quality, more transparency, the best ideas, the best developers, and foster a sense of community. To sum it up, it drives innovation. This allows you to adapt all code within this product to your need or even build proprietary features on top of our infrastructure. Standardized but customizable. + +- **WHY FREE?** + +We believe investment research should be affordable to everyone. This platform leverages an extensive collection of free datasets from data sources; giving you access to a vast range of financial data without any cost. This results in free access to 30+ years of fundamental and market data, large economic databases that include key economic indicators and much more. When our free solution is still too limited, through a paid subscription with the data source or our tools all premium features can be accessed that give the detail that you need. + +- **WHY PYTHON?** + +Python is one of the most used programming languages due to its simplified syntax and shallow learning curve. On top of this, it is highly used in the financial industry throughout the entirety of the firm from analysts to portfolio managers but also including credit risk modellers and data scientists. This is also the very first time in history that users, regardless of their background, can add features to an investment research platform with relative ease. + +- **WHY REMOTE ACCESS?** + +Since COVID-19, the way the world works has changed. And we believe that investment research should be accessible from any location, entirely for free. Wherever you're based and wherever you decide to work, we want to support you in always having access to the OpenBB Terminal. Therefore, our platform and tools are available from any location, whether you’re a student looking to collect financial data, a professional needing to do market research or a retail investor looking to keep up to date with movements in the market. We want to accelerate a future where each individual can have their own investment research platform at their fingertips. + +--- + +terminal + +--- + +- **WHY FREE?** + +We believe that everyone should be able to have the same tooling to do investment research. By leveraging free API tiers, we can allow users to have access to a vast range of information for free. On the other hand, we want users that are willing to subscribe to premium API keys from certain data providers to be able to take advantage of that on OpenBB Terminal - this is where we see a monetization opportunity, a revenue share with data providers for connecting our users to their resources. + +- **WHY OPEN SOURCE?** + +An open source product allows for higher quality, lower costs, more transparency, and faster go-to-market due to the strong community created. There is no point in re-inventing the wheel for financial theory that has been around for decades, thus users can adapt the platform to their needs or even build proprietary features on top of our infrastructure. + + +- **WHY PYTHON?** + +Python is one of the most used programming languages due to its simplified syntax and shallow learning curve. On top of this, it is highly used in data science and academia world (particularly on finance, economics or business related degrees). This is very important, as it is the first time in history that users - regardless of their background - can so easily add features to an investment research platform. + +--- + +Want to contribute? Check out our [CONTRIBUTING GUIDELINES](https://github.com/OpenBB-finance/OpenBBTerminal/blob/main/CONTRIBUTING.md). diff --git a/website/content/terminal/installation/_category_.json b/website/content/terminal/installation/_category_.json new file mode 100644 index 000000000000..615aaadd978a --- /dev/null +++ b/website/content/terminal/installation/_category_.json @@ -0,0 +1,4 @@ +{ + "label": "Installation", + "position": 1 +} diff --git a/website/versioned_docs/version-v3/terminal/installation/docker.md b/website/content/terminal/installation/docker.md similarity index 90% rename from website/versioned_docs/version-v3/terminal/installation/docker.md rename to website/content/terminal/installation/docker.md index 31a1913bf4c4..84c9caeaa0ee 100644 --- a/website/versioned_docs/version-v3/terminal/installation/docker.md +++ b/website/content/terminal/installation/docker.md @@ -1,30 +1,27 @@ --- title: Docker sidebar_position: 5 -description: Installing the OpenBB Terminal via Docker supports both Windows and Unix systems (Linux + MacOS). Installation differs a bit between operating system (Windows, macOS and Linux). Please select the section matching to your OS. +description: Instructions for installing OpenBB Terminal via Docker on different operating + systems (Windows, MacOS, Linux). The page includes specific guidelines for Docker + Desktop installation, displaying charts in Docker, and how to pull and run OpenBB + Terminal Docker image. keywords: - [ - installation, - installer, - install, - guide, - mac, - windows, - linux, - python, - github, - macos, - how to, - explanation, - openbb terminal, - docker, - download - ] +- Docker +- Installation +- Windows +- MacOS +- Linux +- VcXsrv +- XQuartz +- docker-compose.yaml +- docker-compose.x11.yaml +- Docker Desktop +- Run OpenBB Terminal Docker image --- import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - + import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; diff --git a/website/versioned_docs/version-v3/terminal/installation/macos.md b/website/content/terminal/installation/macos.md similarity index 86% rename from website/versioned_docs/version-v3/terminal/installation/macos.md rename to website/content/terminal/installation/macos.md index 041822feb742..7a53370a4729 100644 --- a/website/versioned_docs/version-v3/terminal/installation/macos.md +++ b/website/content/terminal/installation/macos.md @@ -1,34 +1,27 @@ --- title: MacOS sidebar_position: 2 -description: Install the OpenBB Terminal on MacOS (Big Sur or later). There are two versions of the installers available for MacOS, Intel-based and Apple Silicon (M1). +description: Step-by-step instructions for installing the OpenBB Terminal on MacOS. + This guide covers installation for both Intel-based computers and Apple Silicon + (M1) devices, and includes instructions for preliminaries like installing Rosetta + for M1 users. keywords: - [ - installation, - installer, - install, - guide, - mac, - windows, - linux, - python, - github, - macos, - how to, - explanation, - openbb terminal, - big sur, - intel, - intel-based, - apple silicon, - m1, - dmg file - ] +- OpenBB Terminal Installation +- MacOS installation guide +- OpenBB on Mac Intel +- OpenBB on Mac M1 +- Rosetta installation +- PKG installer +- OpenBB Terminal application +- MacOS Big Sur installation +- MacOS Monterey installation +- Apple Silicon installation +- Unverified developer warning --- import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - + import InstallerButton from "@site/src/components/General/InstallerButton"; diff --git a/website/versioned_docs/version-v3/terminal/installation/pypi.md b/website/content/terminal/installation/pypi.md similarity index 91% rename from website/versioned_docs/version-v3/terminal/installation/pypi.md rename to website/content/terminal/installation/pypi.md index 72efbee6dcbe..7aa013668758 100644 --- a/website/versioned_docs/version-v3/terminal/installation/pypi.md +++ b/website/content/terminal/installation/pypi.md @@ -1,38 +1,30 @@ --- title: PyPI sidebar_position: 4 -description: This section provides steps to install the OpenBB Terminal from PyPI. This installation type supports Windows, macOS and Linux systems. +description: This page provides a comprehensive guide on how to install OpenBB Terminal + and SDK from PyPI across multiple operating system platforms. It lists all required + software and provides how-to steps to prepare the virtual environment, install the + main package and its toolkits, verify the installation, and upgrade to the latest + or nightly build versions. keywords: - [ - installation, - installer, - install, - guide, - mac, - windows, - linux, - python, - github, - macos, - how to, - explanation, - openbb terminal, - pypi, - miniconda, - git, - c++, - rosetta2, - libomp, - vcxsrv, - gtk - ] +- OpenBB Terminal installation +- OpenBB SDK installation +- PyPI installation guide +- how to install OpenBB Terminal +- how to install OpenBB SDK +- software requirements for OpenBB installation +- preparing virtual environment for OpenBB +- installing OpenBB toolkits +- verifying OpenBB installation +- updating OpenBB SDK +- OpenBB nightly builds --- -import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + - +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - + This section provides steps to install the OpenBB Terminal and SDK from PyPI. This installation type supports Windows, macOS and Linux systems. **Before starting the installation process, make sure the following pieces of software are installed.** diff --git a/website/versioned_docs/version-v3/terminal/installation/source.md b/website/content/terminal/installation/source.md similarity index 92% rename from website/versioned_docs/version-v3/terminal/installation/source.md rename to website/content/terminal/installation/source.md index 5f06c3b639ff..5ac31466c957 100644 --- a/website/versioned_docs/version-v3/terminal/installation/source.md +++ b/website/content/terminal/installation/source.md @@ -1,36 +1,35 @@ --- title: Source sidebar_position: 3 -description: This section provides steps to install the OpenBB Terminal from source. This installation type supports Windows, macOS and Linux systems. +description: Comprehensive guide to install the OpenBB Terminal and SDK from source. + The guide covers the installation process for Windows, macOS, and Linux systems + and covers various software installations including Miniconda, Git, Microsoft C++ + Build Tools, Rosetta2, LibOMP, VcXsrv, and GTK toolchains. Instructions for environment + setup and package management through Conda and Poetry are also included, along with + troubleshooting tips and community support. keywords: - [ - installation, - installer, - install, - guide, - mac, - windows, - linux, - python, - github, - macos, - how to, - explanation, - openbb terminal, - pypi, - miniconda, - git, - c++, - rosetta2, - libomp, - vcxsrv, - gtk - ] +- Installation +- Miniconda +- Git +- Microsoft C++ Build Tools +- Rosetta2 +- LibOMP +- VcXsrv +- GTK toolchains +- Conda +- Poetry +- Environment setup +- Python package management +- Troubleshooting +- Community support +- Linux +- MacOS +- Windows --- import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - + diff --git a/website/versioned_docs/version-v3/terminal/installation/windows.md b/website/content/terminal/installation/windows.md similarity index 80% rename from website/versioned_docs/version-v3/terminal/installation/windows.md rename to website/content/terminal/installation/windows.md index 77c9bd41a555..8c0f5ba9fe14 100644 --- a/website/versioned_docs/version-v3/terminal/installation/windows.md +++ b/website/content/terminal/installation/windows.md @@ -1,30 +1,20 @@ --- title: Windows sidebar_position: 1 -description: This section provides you with the installation file as well as the guide to install the OpenBB Terminal via Windows (10 or greater). +description: Learn how to install the OpenBB Terminal on Windows, understand its minimum + requirements, and follow the step-by-step instructions to ensure successful installation. keywords: - [ - installation, - installer, - install, - guide, - mac, - windows, - linux, - python, - github, - macos, - how to, - explanation, - openbb terminal, - requirements, - windows 10 - ] +- OpenBB Terminal installation +- Windows installation guide +- Windows OpenBB Terminal +- Download OpenBB Terminal +- Install OpenBB Terminal +- OpenBB Terminal requirements --- import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - + import InstallerButton from "@site/src/components/General/InstallerButton"; diff --git a/website/content/terminal/menus/_category_.json b/website/content/terminal/menus/_category_.json new file mode 100644 index 000000000000..b9628cc63daf --- /dev/null +++ b/website/content/terminal/menus/_category_.json @@ -0,0 +1,4 @@ +{ + "label": "Menus", + "position": 3 +} diff --git a/website/content/terminal/menus/alternative.md b/website/content/terminal/menus/alternative.md new file mode 100644 index 000000000000..fb271166fc49 --- /dev/null +++ b/website/content/terminal/menus/alternative.md @@ -0,0 +1,25 @@ +--- +title: Alternative +description: This page discusses how investors use alternative data for in-depth company + analysis and how this method can lead to better decision-making. It also covers + trends in data production and introduces related businesses. +keywords: +- alternative data +- company analysis +- investment data +- data sources +- corporate performance metrics +- data production trends +- data interpretation +- investment decision-making +- data cleaning +- data collection +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Investors utilize alternative data to analyze a company or investment that is not available through typical data sources (financial statements, SEC filings, management presentations, press releases, etc.). Traditional data sources do not provide investors with as accurate, timely, or granular insights and measurements into corporate performance as alternative data does. Increases in computing power and personal device usage have resulted in tremendous data production during the previous ten years. As a result, a slew of new businesses have sprung up to collect, clean, analyze, and interpret data in order to sell it as a product that might help investors make better decisions. + +Find more about the functionalities we offer in this menu [here](/terminal/reference). diff --git a/website/content/terminal/menus/common/_category_.json b/website/content/terminal/menus/common/_category_.json new file mode 100644 index 000000000000..c47bdcba8d10 --- /dev/null +++ b/website/content/terminal/menus/common/_category_.json @@ -0,0 +1,3 @@ +{ + "label": "Common" +} diff --git a/website/content/terminal/menus/common/common.md b/website/content/terminal/menus/common/common.md new file mode 100644 index 000000000000..41e0ff297d9d --- /dev/null +++ b/website/content/terminal/menus/common/common.md @@ -0,0 +1,23 @@ +--- +title: Introduction +sidebar_position: 1 +description: The page explains various features available on sub-menus that can be + utilized across different asset classes. These features are grouped and can be found + under the directory trees in the 'common/'. +keywords: +- sub-menus +- features +- asset classes +- directory trees +- common/ +- quant +- quantitative +- technical +- analysis +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Sub-menus containing features that can be applied across different asset classes are grouped here. These are grouped in the directory trees under `common/`. diff --git a/website/content/terminal/menus/common/qa.md b/website/content/terminal/menus/common/qa.md new file mode 100644 index 000000000000..fcd1ac10f9df --- /dev/null +++ b/website/content/terminal/menus/common/qa.md @@ -0,0 +1,147 @@ +--- +title: Quantitative Analysis +description: The page provides an overview of Quantitative Analysis in finance and + its application in different asset classes like Crypto, Forex, and Stocks. It also + highlights its usage in making profitable investment decisions, the use of terminal + commands for analyzing data, and the export of data for further analysis. +keywords: +- Quantitative analysis +- Asset classes +- Finance +- Crypto +- Forex +- Stocks +- Terminal +- Financial quantitative analysis +- Investment decisions +- Statistics +- Metrics +- Risk +- Investors +- Quantifiable statistics +- Command summary +- Line chart +- Target column +- Observation window +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Quantitative analysis (QA) in finance is an approach that emphasizes mathematical and statistical analysis to help determine the value of a financial asset, such as a stock or option. The ultimate goal of financial quantitative analysis is to use quantifiable statistics and metrics to assist investors in making profitable investment decisions. Quantitative analysis is different from qualitative analysis, which looks at factors such as how companies are structured, the makeup of their management teams, and what their strengths and weaknesses are. + +The Quantitative Analysis menu is a common menu to three asset classes: + +- Crypto +- Forex +- Stocks + + +![Screenshot 2023-10-30 at 11 15 59 AM](https://github.com/OpenBB-finance/OpenBBTerminal/assets/85772166/e191455f-e626-486b-ae22-4da8e9fd6811) + +## Usage + +Enter the menu, through one of the asset classes listed above, by entering `qa` in the Terminal. The ticker that is loaded before entering the menu will determine the timeframe for the analysis. To alter it, use the `load` function and pick a new `--start` and `--end` for the observation window. The QA functions target a specified column of the data. By default, this is returns. Use the `pick` command to chose a new target column. + +The menu is divided into five categories of functions: + +- Statistics +- Rolling Metrics +- Risk +- Other + +### Summary + +A summary of exportable statistics is displayed with the command, `summary`. The example here shows AAPL. + +```console +stocks +load aapl +qa +summary +``` + +![summary](https://github.com/OpenBB-finance/OpenBBTerminal/assets/85772166/16fc2132-765e-4b1b-9461-8e365551b278) + +### Line + +A simple line chart for the target column as a time-series is called with the `line` command, for example the `returns` column. + +To use the same data and target column, enter: + +```console +line +``` + +![line](https://github.com/OpenBB-finance/OpenBBTerminal/assets/85772166/f0407a98-f88b-4880-a2f4-53c2b0b62418) + +### Beta + +The `beta` command shows the beta of the loaded asset with respect to another. Use the `-r` parameter to select the asset to compare against. + +```console +beta -r xlk +``` + +![Screenshot 2023-10-30 at 11 48 31 AM](https://github.com/OpenBB-finance/OpenBBTerminal/assets/85772166/4df72127-c766-4099-ba89-1eed0e274f4c) + +### Pick + +To select a different target, like log returns, use the `pick` command. + +```console +pick -t logret +``` + +![Screenshot 2023-10-30 at 11 38 58 AM](https://github.com/OpenBB-finance/OpenBBTerminal/assets/85772166/93faab58-659b-45a0-aeaf-bed95cb511e3) + +The choice will be reflected on-screen after the menu is refreshed, `?`, `h`, `help` - with no command attached. + +### Rolling + +The `rolling` command plots the rolling mean and standard deviation of the target column over a selectable window of time. + +```console +pick -t close +rolling --windows 30 +``` + +![Screenshot 2023-10-30 at 12 04 15 PM](https://github.com/OpenBB-finance/OpenBBTerminal/assets/85772166/b0de1f0c-7e1d-4fad-9546-075b2024a8b3) + +### CDF + +The Cumulative Distribution Function (`cdf`) displays the probabilities with quantiles. + +```console +load aapl --start 2004-10-30 --monthly +pick -t returns +cdf +``` + +![Screenshot 2023-10-30 at 12 14 20 PM](https://github.com/OpenBB-finance/OpenBBTerminal/assets/85772166/54e84236-e730-4083-9e27-c3a44e84e3ee) + +### Skew + +The `skew` command shows the asymmetric distribution over a specified window. Adjust this window to suit the interval of data loaded. With monthly data, a window of 12 represents one-year. + +```console +skew +``` + +![Screenshot 2023-10-30 at 12 23 19 PM](https://github.com/OpenBB-finance/OpenBBTerminal/assets/85772166/f1e7e0e5-79fe-4ac7-8a4f-dbbb32793c50) + + +### CAPM + +The `capm` command uses the Fama French Factors to determine market risk against the loaded asset. The output of this function is printed directly to the screen. + +```console +capm +``` + +```console +Beta: 1.24 +Systematic Risk: 63.63% +Unsystematic Risk: 36.37% +``` diff --git a/website/content/terminal/menus/common/ta.md b/website/content/terminal/menus/common/ta.md new file mode 100644 index 000000000000..cd9f1ecec260 --- /dev/null +++ b/website/content/terminal/menus/common/ta.md @@ -0,0 +1,275 @@ +--- +title: Technical Analysis +description: Learn how to use our comprehensive technical analysis tools to understand + the trend patterns and market sentiment of various assets. Get insights on moving + averages, oscillating signals, directional strength, price band volatility, volume + analysis and even use custom indicators. Make better trading decisions with our + analysis dashboard! +keywords: +- technical analysis +- moving averages +- oscillating signals +- directional strength +- volatility +- volume analysis +- custom indicators +- trading +- asset analysis +- market trends +- financial trading tools +- crypto analysis +- stock analysis +- forex analysis +- ETF analysis +- financial dashboard +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +The Technical Analysis menu offers the user a suite of tools for analyzing the technical components of an asset's trading history. The menu can be found in most wings of the Terminal: + +- [Crypto](/terminal/data-available/crypto) +- [Stocks](/terminal/data-available/stocks) +- [ETF](/terminal/data-available/etf) +- [Forex](/terminal/data-available/forex) + +The commands are divided by categories that define their purpose for general-use: + +- Overlap - Moving averages +- Momentum - Oscillating signals +- Trend - Directional strength +- Volatility - Width of the price bands +- Volume - Singling out volume +- Custom - Multiple indicators and Fibonacci retracements + +All commands in this menu will rely on the interval and window chosen when loading an asset for analysis. Refer to the directory tree on the left side of the page, [here](/terminal/reference), for information on individual commands. To get a better understanding of what these features are, and the formulas behind them, a number of sources should be consulted; but, a good starting point is [Investopedia](https://www.investopedia.com/terms/t/technicalanalysis.asp). The menu employs the [Pandas-TA Library](https://github.com/twopirllc/pandas-ta). Submit a [feature request](https://openbb.co/request-a-feature) to let us know which indicators we should add next! + +### How to Use + +To begin, enter the menu from one of the menus listed above by entering `ta`. For demonstration purposes, we will use `QQQ` as the ticker. Let's grab some data! + +```console +/stocks/load QQQ/ta +``` + +The block above loads daily QQQ historical prices and volume, then enters the Technical Analysis menu. The table below lists all the available analysis functions. + +| Function Key | Type | Description | +| :----------- | :--------- | ------------------------------------------: | +| load | - | Load a new ticker for analysis. | +| ema | Overlap | Exponential Moving Average. | +| hma | Overlap | Hull Moving Average. | +| sma | Overlap | Simple Moving Average. | +| wma | Overlap | Weighted Moving Average. | +| vwap | Overlap | Volume Weighted Average Price. | +| zlma | Overlap | Zero-Lag Moving Average. | +| cci | Momentum | Commodity Channel Index. | +| cg | Momentum | Center of Gravity. | +| clenow | Momentum | Clenow Volatility Adjusted Momentum. | +| demark | Momentum | Tom Demark's Sequential Indicator. | +| macd | Momentum | Moving Average Convergence/Divergence. | +| fisher | Momentum | Fisher Transform. | +| rsi | Momentum | Relative Strength Index. | +| stoch | Momentum | Stochastic Oscillator. | +| adx | Trend | Average Directional Movement Index. | +| aroon | Trend | Aroon Indicator. | +| atr | Volatility | Average True Range. | +| bbands | Volatility | Bollinger Bands. | +| cones | Volatility | Realized Volatility Cones. | +| donchian | Volatility | Donchian Channels. | +| kc | Volatility | Keltner Channels. | +| ad | Volume | Accumulation/Distribution Line. | +| adosc | Volume | Chaikin Oscillator. | +| obv | Volume | On-Balance Volume. | +| fib | Custom | Fibonacci Retracement. | +| multi | Custom | Plot multiple indicators on the same chart. | + +:::note + +Some functions will not be compatible with intraday data and some may be designed specifically for a daily window. Interval labels on charts may still be described as "days" when the time series interval is intraday. Consult the help dialogue, by attaching `-h` to a command, for a reminder of the adjustable parameters. +::: + +With some daily data now loaded, let's look at some charts! + +## Examples + +### Moving Averages + +There are five types of moving averages available, they are grouped into the `Overlay` category. It is possible to overlay multiple windows of time for each one, and it is also possible to overlay multiple versions of moving average. + +#### Single MA Type + +The help dialogue will explain the differences. For example, Zero-Lag Moving Average. + +```console +zlma -h +``` + +```console +usage: zlma [-l N_LENGTH] [-o N_OFFSET] [-h] [--export EXPORT] [--sheet-name SHEET_NAME [SHEET_NAME ...]] + +The zero lag exponential moving average (ZLEMA) indicator was created by John Ehlers and Ric Way. The idea is do a regular exponential moving average (EMA) calculation but +on a de-lagged data instead of doing it on the regular data. Data is de-lagged by removing the data from "lag" days ago thus removing (or attempting to) the cumulative +effect of the moving average. + +options: + -l N_LENGTH, --length N_LENGTH + Window lengths. Multiple values indicated as comma separated values. (default: [20]) + -o N_OFFSET, --offset N_OFFSET + offset (default: 0) + -h, --help show this help message (default: False) + --export EXPORT Export raw data into csv, json, xlsx and figure into png, jpg, pdf, svg (default: ) + --sheet-name SHEET_NAME [SHEET_NAME ...] + Name of excel sheet to save data to. Only valid for .xlsx files. (default: None) + +For more information and examples, use 'about zlma' to access the related guide. +``` + +For moving averages, there are two parameters: the window length and offset. Let's examine the ZLMA at 50 and 200 days. + +```console +zlma -l 50,200 +``` + +![ZLMA 50,200](https://user-images.githubusercontent.com/85772166/233763992-157eb965-e5ca-48d6-b621-1e6596d4f784.png) + +Drawing a chart with the Simple Moving Average shows the overlaps occur at different points in time. + +```console +sma -l 50,200 +``` + +![SMA 50,200](https://user-images.githubusercontent.com/85772166/233764006-45f6e6db-aa8c-4404-8997-68f96fbbe29e.png) + +#### Multiple MA Types + +Let's overlay the 200-day ZLMA with the 200-day SMA to see where they intersect. This is accomplished using the `multi` function. + +```console +multi -i sma[200],zlma[200] +``` + +:::note +Make note of the difference in parameters syntax. With the `multi` function, parameters for each indicator must be surrounded with square brackets [ ]. +::: + +![SMA/ZLMA Overlay](https://user-images.githubusercontent.com/85772166/233764023-26991e03-6a82-47b6-9a6b-b2013dbdfffc.png) + +Now let's see both 200 and 50-day moving averages. + +```console +multi -i sma[50,200],zlma[50,200] +``` + +![SMA/ZLMA Overlay](https://user-images.githubusercontent.com/85772166/233764031-fd0375e9-f13f-43dd-b304-795168a0424b.png) + +The last crossover point provides some confirmation of the current trend. Intraday data might reveal more. Let's see the one-hour MAs! + +```console +load qqq -i 60/multi -i sma[50,200],zlma[50,200] +``` + +![SMA/ZLMA Hourly Overlay](https://user-images.githubusercontent.com/85772166/233764046-879252f8-3449-4f61-9098-6c538e130e47.png) + +The ZLMA 50 has crossed over the SMA50, potentially signalling that the trend is near its exhaustion point. Let's consult some other indicators using the hourly data now loaded. + +### multi + +Load multiple indicators on the same chart with the `multi` command. + +```console +load qqq -i 60 -s 2023-01-01/multi rsi,vwap,atr +``` + +![multi rsi,vwap,atr](https://user-images.githubusercontent.com/85772166/233764057-46b82e00-0e93-4f69-a253-c74f102a5827.png) + +The help dialogue for this function provides some guidance for setting the optional arguments for each indicator. + +```console +multi -h +``` + +```console +usage: multi [-i INDICATORS] [-h] [--export EXPORT] [--sheet-name SHEET_NAME [SHEET_NAME ...]] + +Plot multiple indicators on the same chart separated by a comma. + +options: + -i INDICATORS, --indicators INDICATORS + Indicators with optional arguments in the form of "macd[12,26,9],rsi,sma[20]" (default: None) + -h, --help show this help message (default: False) + --export EXPORT Export raw data into csv, json, xlsx and figure into png, jpg, pdf, svg (default: ) + --sheet-name SHEET_NAME [SHEET_NAME ...] + Name of excel sheet to save data to. Only valid for .xlsx files. (default: None) + +For more information and examples, use 'about multi' to access the related guide. +``` + +Making adjustments with this function requires knowing the parameters for each individual indicator. They will have sensible default values but, where there are multiple parameters, it may not be obvious which order the numbers need to be entered. Sometimes they are not even numbers, like MACD. + +### macd + +```console +macd --help + +(🦋) /stocks/ta/ $ macd --help + +usage: macd [--fast N_FAST] [--slow N_SLOW] [--signal N_SIGNAL] [-h] [--export EXPORT] [--sheet-name SHEET_NAME [SHEET_NAME ...]] + +The Moving Average Convergence Divergence (MACD) is the difference between two Exponential Moving Averages. The Signal line is an Exponential Moving +Average of the MACD. The MACD signals trend changes and indicates the start of new trend direction. High values indicate overbought conditions, low +values indicate oversold conditions. Divergence with the price indicates an end to the current trend, especially if the MACD is at extreme high or low +values. When the MACD line crosses above the signal line a buy signal is generated. When the MACD crosses below the signal line a sell signal is +generated. To confirm the signal, the MACD should be above zero for a buy, and below zero for a sell. + +options: + --fast N_FAST The short period. (default: 12) + --slow N_SLOW The long period. (default: 26) + --signal N_SIGNAL The signal period. (default: 9) + -h, --help show this help message (default: False) + --export EXPORT Export raw data into csv, json, xlsx and figure into png, jpg, pdf, svg (default: ) + --sheet-name SHEET_NAME [SHEET_NAME ...] + Name of excel sheet to save data to. Only valid for .xlsx files. (default: None) + +For more information and examples, use 'about macd' to access the related guide. +``` + +The one-hour MACD generated a downward signal trend two days ago. + +```console +load qqq -i 60 -s 2023-01-01/macd +``` + +![MACD Hourly](https://user-images.githubusercontent.com/85772166/233764068-521b6218-2e4f-49d2-94b3-b4806b739a56.png) + +:::note +Clicking and dragging the mouse near the corners at each axis allows the zooming to be locked to the X or Y axis only. +::: + +### obv + +Looking at the one-minute on-balance volume of QQQ today (April 21, 2023) reveals that massive volume spike occurred at 11:04. The ceiling is now the floor. + +```console +load qqq -i 1 -s 2023-04-21/macd +``` + +![On-Balance Volume](https://user-images.githubusercontent.com/85772166/233764081-ade1d33f-7524-41d0-9885-911a6270a11c.png) + +The Accumulation/Distribution Line at the same one-minute interval signals in advance of the upward drift reversal, beginning to sell into the Friday close just before 14:00. + +![Accumulation Distribution](https://user-images.githubusercontent.com/85772166/233764089-531dad18-d3c1-4bbb-aa6c-3c2c182f8fd3.png) + +## Indicators Dashboard + +This menu is also available as an experimental Dashboard Streamlit App. + +```console +/dashboards/indicators +``` + +![Dashboards Menu](https://user-images.githubusercontent.com/85772166/233764105-85b944eb-6ff7-42c8-b2c7-f9cbdff51388.png) + +![Indicators Dashboard](https://user-images.githubusercontent.com/85772166/233764115-7bfbbf8c-793e-4dbc-a8de-9f16007d68a9.png) diff --git a/website/content/terminal/menus/crypto/_category_.json b/website/content/terminal/menus/crypto/_category_.json new file mode 100644 index 000000000000..ff7142a628e7 --- /dev/null +++ b/website/content/terminal/menus/crypto/_category_.json @@ -0,0 +1,3 @@ +{ + "label": "Crypto" +} diff --git a/website/content/terminal/menus/crypto/dd.md b/website/content/terminal/menus/crypto/dd.md new file mode 100644 index 000000000000..7bb97c51c511 --- /dev/null +++ b/website/content/terminal/menus/crypto/dd.md @@ -0,0 +1,142 @@ +--- +title: Due Diligence +description: Guide to the Cryptocurrency Due Diligence menu command in the crypto + terminal. It offers information about the loaded coin, project details, the token + balance, fundraising details and social media activity. Examples of usage, price + movements and sentiment scores are provided. The guide provides detailed step-by-step + instructions on how to use all the features of the Cryptocurrency Due Diligence + command. +keywords: +- Cryptocurrency Due Diligence +- crypto +- load +- Coin +- coin metrics +- trades +- coin information +- project information +- Muir Glacier +- Istanbul +- sentiment analysis +- scores +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +The Due Diligence sub-menu provides a layer of tools for researching a digital asset, from a bottom-up perspective, with functions for tokenomics, community engagement, governance, roadmaps, whitepapers, and more. The commands are grouped into sections: + +- Overview +- Market +- Metrics +- Contributors and Investors +- Tokenomics +- Roadmap and News +- Activity and Community + +:::note + +Functions in this menu do not rely on the selected `--source` from the `load` command. The source of data for each command is located on the far-right of the menu item, in square brackets. + +::: + +## Usage + +Switch the current asset with the `load` command. A coin does not have to be loaded before entering the menu. + +```console +load xrp +``` + +### PI + +The `pi` command obtains key project information from Messari. + +```console +/crypto/dd/load xrp/pi +``` + +In this instance, there are no data points for audits or vulnerabilities. + +```console +Audits not found + +Vulnerabilities not found +``` + +A description of the project and technology is returned in a table: + +![project information](https://github.com/OpenBB-finance/OpenBBTerminal/assets/85772166/5ccc696d-4af6-41f8-9386-b621334f23a6) + +### PS + +Similar to `pi`, `ps` are key statitistics of the asset from Messari. + +```console +/crypto/dd/load xrp/ps +``` + +| name | XRP | +|:---------------------------|:--------------------| +| id | xrp-xrp | +| symbol | XRP | +| rank | 5 | +| circulating_supply | 53560508378 | +| total_supply | 99988331658 | +| max_supply | 100000000000 | +| beta_value | 1.018 | +| first_data_at | 2013-08-04 00:00:00 | +| last_updated | 2023-10-31 02:56:18 | +| usd_price | 0.5766098562100087 | +| usd_volume_24h | 1270078728.0050828 | +| usd_volume_24h_change_24h | 130.86 | +| usd_market_cap | 30883517034 | +| usd_market_cap_change_24h | 3.76 | +| usd_percent_change_15m | -0.23 | +| usd_percent_change_30m | -0.45 | +| usd_percent_change_1h | -0.63 | +| usd_percent_change_6h | -0.66 | +| usd_percent_change_12h | -0.83 | +| usd_percent_change_24h | 3.76 | +| usd_percent_change_7d | 5.21 | +| usd_percent_change_30d | 10.77 | +| usd_percent_change_1y | 26.09 | +| usd_ath_price | 3.84194 | +| usd_ath_date | 2018-01-04 07:14:00 | +| usd_percent_from_price_ath | -84.99 | + + +### Trades + +The `trades` command requests data via CCXT, pick the venue to see the latest trades. + +![Screenshot 2023-10-30 at 8 11 05 PM](https://github.com/OpenBB-finance/OpenBBTerminal/assets/85772166/2ae64595-d78d-48c4-b12f-75e929d0b6d2) + +```console +/crypto/dd/load xrp/trades kraken +``` + +![Screenshot 2023-10-30 at 8 09 34 PM](https://github.com/OpenBB-finance/OpenBBTerminal/assets/85772166/1e66e39b-3208-4be3-8e11-89d233de3770) + + +### OB + +The order book, `ob`, from the same venue: + +```console +/crypto/dd/load xrp/ob kraken +``` + +![Screenshot 2023-10-30 at 8 14 02 PM](https://github.com/OpenBB-finance/OpenBBTerminal/assets/85772166/28846e0b-e3fa-4828-bc12-493a632c5917) + + +### Inv + +The investors function, `inv`, shows who is backing the project. + +```console +/crypto/dd/load xrp/inv +``` + +![Screenshot 2023-10-30 at 8 20 03 PM](https://github.com/OpenBB-finance/OpenBBTerminal/assets/85772166/f0eabb1c-334c-44a4-9ef1-72f2c6799be1) diff --git a/website/content/terminal/menus/crypto/defi.md b/website/content/terminal/menus/crypto/defi.md new file mode 100644 index 000000000000..1ab6cca556a9 --- /dev/null +++ b/website/content/terminal/menus/crypto/defi.md @@ -0,0 +1,53 @@ +--- +title: Decentralized Finance (DeFi) +description: This doc provides information on the DeFi sub-menu, within the Crypto menu of the the OpenBB Terminal. +keywords: +- Cryptocurrency +- Decentralized Finance +- DeFi +- tvl +- pancakeswap +- sushiswap +- dApps information +- tokens +- stats +- pairs +- gdapps +- stvl +- crypto menu +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +The DeFi sub-menu sports a small collection of functions, with data largely coming from DeFi Llama. + +## Usage + +Enter the menu with: + +```console +/crypto/defi +``` + +### ldapps + +The `ldapps` command will return a list of DeFi apps. Use the `--limit` argument to increase the number of results returned. + +```console +/crypto/defi/ldapps --limit 1000 +``` + +![Screenshot 2023-10-31 at 9 12 46 AM](https://github.com/OpenBB-finance/OpenBBTerminal/assets/85772166/20e20089-080d-4172-a305-2d9ce364e1e9) + + +### stvl + +`stvl` is a time series representing the total value locked across the DeFi space. Use the `--limit` argument here for the number of days to look back. + +```console +/crypto/defi/stvl --limit 1000 +``` + +![Screenshot 2023-10-31 at 9 49 36 AM](https://github.com/OpenBB-finance/OpenBBTerminal/assets/85772166/41e67090-1db5-4ea9-946d-71887672b85a) diff --git a/website/content/terminal/menus/crypto/disc.md b/website/content/terminal/menus/crypto/disc.md new file mode 100644 index 000000000000..fd3614f18f27 --- /dev/null +++ b/website/content/terminal/menus/crypto/disc.md @@ -0,0 +1,62 @@ +--- +title: Discovery +description: This doc provides an introduction to the discovery sub-menu within the Crypto menu of the OpenBB Terminal. +keywords: +- Cryptocurrency Discovery +- crypto +- NFTs +- decentralized apps +- Bored Ape Yacht Club +- CryptoPunks +- Moonbirds +- Mutant Ape Yacht Club +- Doodles V4 +- CLONE X - X TAKASHI MURAKAMI +- Azuki +- Bored Ape Kennel Club +- Space Doodles +- VeeFriends +- Meebits +- Otherdeed for Otherside +- Fluf World +- Cyber Kongz +- SandVegasCasinoClub Official +- Splinterlands +- PancakeSwap +- Alien Worlds +- Farmers World +- AtomicAssets +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +The Discovery sub-menu is for finding trends across the Crypto universe. + +## Usage + +Enter the menu by typing `disc`, while inside the `crypto` menu. Or, by the absolute path: + +```console +/crypto/disc +``` + +![Screenshot 2023-10-31 at 10 00 49 AM](https://github.com/OpenBB-finance/OpenBBTerminal/assets/85772166/d5dc6656-92fd-4781-936a-00900f60d23e) + +Enter either, `..` or `q`, to return to the main Crypto menu. + +### Top + +The `top` command provides parameters for filtering categories. Browse them with the up/down arrow keys. + + +![Screenshot 2023-10-31 at 10 04 40 AM](https://github.com/OpenBB-finance/OpenBBTerminal/assets/85772166/6c0e42fa-42d8-4244-a244-d8289e06adda) + + +```console +top -c asset-backed-tokens +``` + +![Screenshot 2023-10-31 at 10 08 33 AM](https://github.com/OpenBB-finance/OpenBBTerminal/assets/85772166/7f50bae5-7b2f-48fa-9d92-3bdb0751790e) + diff --git a/website/content/terminal/menus/crypto/introduction.md b/website/content/terminal/menus/crypto/introduction.md new file mode 100644 index 000000000000..8a4a4efd7006 --- /dev/null +++ b/website/content/terminal/menus/crypto/introduction.md @@ -0,0 +1,99 @@ +--- +title: Introduction +sidebar_position: 1 +description: Documentation page detailing how to use the Cryptocurrency menu providing + trending cryptocurrency insights, researching specific coins, as well as providing access to onchain information. + Includes sub-menus for in-depth discovery, overview, onchain analysis, Defi, NFTs + and due diligence. Examples provided for navigating through features. +keywords: +- Cryptocurrency +- NFT +- Defi +- technical analysis +- quantitative analysis +- onchain information +- cryptocurrency analysis +- coin research +- crypto market +- forecasts +- Decentralized Finance +- Non Fungible Tokens +- crypto due diligence +- Ethereum +- Bitcoin +- blockchain transactions +- OpenSea NFT +- crypto news sentiment +- crypto project roadmap +- crypto market overview +- Altcoin season +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +The Crypto menu has functions and sub-menus for the discovery and analysis of digtal assets. Enter, from the main menu, by typing `crypto` into the Terminal. + +![crypto](https://github.com/OpenBB-finance/OpenBBTerminal/assets/85772166/63ebe2a5-27c2-4ca5-bdfe-2c1d51dde69d) + +## Usage + +At the base of the menu, there are six functions. They are are displayed above, in light blue text. Sub-menus are distinguished by a `>`, on the left side of the item. + +- load +- find +- price +- headlines +- candle +- prt + +### Load + +The `load` command is similar to the `/stocks/load` command, with some key differences: + +- `--vs` parameter is for relative pricing in a specific fiat or stable coin. +- When the `--source` is "CCXT", an `--exchange` parameter is required to select the specific data source. + - Data availability and granularity varies. + +![Screenshot 2023-10-30 at 3 40 43 PM](https://github.com/OpenBB-finance/OpenBBTerminal/assets/85772166/f3bf898a-366a-4344-8b37-5621f411774f) + +```console +/crypto/load --vs usd -c btc --source CCXT --exchange bitfinex +``` + +vs. + +```console +/crypto/load --vs usd -c btc --source CCXT --exchange binance +``` + +![Screenshot 2023-10-30 at 3 19 00 PM](https://github.com/OpenBB-finance/OpenBBTerminal/assets/85772166/c87e14ff-08b1-4c54-81ec-a310ce7a5590) + +### Price + +The `price` command displays realtime prices from Pyth. This command will stay active until `ctrl-c` is entered, which breaks the connection. A second instance of the Terminal could be started to keep a connection alive. + +```console +/crpyto/price SOL-USD +``` + +![Screenshot 2023-10-30 at 3 36 22 PM](https://github.com/OpenBB-finance/OpenBBTerminal/assets/85772166/fd3315f8-4500-4534-8fcc-24a330cc2ccf) + + +## Sub-Menus + +The Cryptocurrency menu has an extensive list of available sub-menus ranging from due diligence to NFT to onchain analysis. To find more information about each menu, you can click on one of the following: + +- [Discovery](disc.md): Top trending, top gainers or losers coins, as well as top NFTs, dApps and exchanges based on prices. +- [Overview](ov.md): General overviews of the cryptocurrency market, including global Defi market, stablecoins, exchanges as well as latest news. +- [Onchain](onchain.md): Onchain data for the Ethereum-based assets. Look up addresses with past transactions and balance history. +- [DeFi](defi.md): DeFi networks and data. +- [NFTs](nft.md): Discover latest NFT drops and OpenSea's NFT Collection statistics. +- [Due Diligence](dd.md): Perform due diligence on a chosen coin or project with information such as, tokenomics, roadmaps, news, and community. + +There are also entry points to Terminal toolkits: + +- [Forecast](/terminal/menus/forecast.md): Forecast menu. +- [Quantitative Analysis](/terminal/menus/common/qa.md): Quantitative Analysis menu. +- [Technical Analysis](/terminal/menus/common/ta.md): Technical Analysis menu. diff --git a/website/content/terminal/menus/crypto/nft.md b/website/content/terminal/menus/crypto/nft.md new file mode 100644 index 000000000000..d7f21d9736db --- /dev/null +++ b/website/content/terminal/menus/crypto/nft.md @@ -0,0 +1,53 @@ +--- +title: Non Fungible Token (NFT) +description: This page provides an introduction to the Non Fungible Token (NFT) sub-menu within the Crypto menu of the OpenBB Terminal. +keywords: +- Non Fungible Token +- NFT +- /crypto/nft +- stats +- metrics +- collections +- crypto menu +- nft menu +- mutant-ape-yacht-club +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +The Non Fungible Token (NFT) menu is a place to lookup stats and find collections of NFT projects. + +## Usage + +Enter the menu by typing, `nft`, into the Terminal from the Crypto menu, or with the absolute path. + +```console +/crypto/nft +``` + +![Screenshot 2023-10-31 at 11 01 12 AM](https://github.com/OpenBB-finance/OpenBBTerminal/assets/85772166/af546da0-933f-4c5d-9436-a599e2e51743) + +### Collections + +`collections` shows a list of projects containing basic stats. + +```console +/crypto/nft/collections +``` + +![Screenshot 2023-10-31 at 11 10 06 AM](https://github.com/OpenBB-finance/OpenBBTerminal/assets/85772166/1f566704-08d9-4d66-9089-fca29bda045a) + +### FP + +The `fp` command is a time series chart displaying sales and the floor price of a specific collection. + +![Screenshot 2023-10-31 at 11 11 23 AM](https://github.com/OpenBB-finance/OpenBBTerminal/assets/85772166/b91803e2-14af-45be-84a4-ea5ae94557dd) + +```console +/crypto/nft/fp -s adidas-golden-ticket +``` + +![Screenshot 2023-10-31 at 11 14 25 AM](https://github.com/OpenBB-finance/OpenBBTerminal/assets/85772166/31056539-e0ac-4c1d-ad19-d6076d380f65) + diff --git a/website/content/terminal/menus/crypto/onchain.md b/website/content/terminal/menus/crypto/onchain.md new file mode 100644 index 000000000000..44c8ead512c6 --- /dev/null +++ b/website/content/terminal/menus/crypto/onchain.md @@ -0,0 +1,68 @@ +--- +title: Onchain +description: This page provides insight into the Cryptocurrency Onchain menu. It discusses + how to use the menu for leveraging blockchain ledger data and scrutinizing transaction + data and crypto wallet balances. These features are crucial in deciding whether + to invest in a specific cryptocurrency. The page also provides examples of how to + view top traded crypto pairs and find information about specific Ethereum addresses. +keywords: +- Cryptocurrency +- Onchain +- Blockchain +- Investing +- Market Sentiment +- Blockchain Ledger Data +- Transaction Data +- Crypto Wallet Balances +- Top Traded Crypto Pairs +- Ethereum Address +- Historical Transactions +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +The Onchain sub-menu provides insights to the activities recorded on the blockchain. Enter the menu by typing, `onchain`, into the Terminal from Crypto menu, or with the absolute path: + +```console +/crypto/onchain +``` + +![Screenshot 2023-10-31 at 11 17 42 AM](https://github.com/OpenBB-finance/OpenBBTerminal/assets/85772166/1d9f7deb-a725-46ca-adc3-033613b63fb9) + +## Usage + +The menu is divided into two sections, with the bottom half dedicated to individual Ethereum addresses. + +### Whales + +The `whales` command shows where large blocks are being traded. + +```console +/crypto/onchain/whales +``` + +![Screenshot 2023-10-31 at 11 30 17 AM](https://github.com/OpenBB-finance/OpenBBTerminal/assets/85772166/b9c888d8-3bc9-4f0f-ad2a-96adf4e456df) + +### Address + +Load an Ethereum wallet address with the `address` command. + +```console +address --address 0x40B38765696e3d5d8d9d834D8AaD4bB6e418E489 +``` + +Add `-t` to the command if the address is an ERC20 token address. + +Add `-tx` to the command if the address is a transaction hash. + +### Balance + +After an address is loaded, use `balance` to check out what it's holding. + +```console +balance +``` + +![Screenshot 2023-10-31 at 12 33 48 PM](https://github.com/OpenBB-finance/OpenBBTerminal/assets/85772166/c8ef0b1f-d681-42d5-9082-3a358e6bc624) diff --git a/website/content/terminal/menus/crypto/ov.md b/website/content/terminal/menus/crypto/ov.md new file mode 100644 index 000000000000..a8a775adba88 --- /dev/null +++ b/website/content/terminal/menus/crypto/ov.md @@ -0,0 +1,104 @@ +--- +title: Overview +description: This page provides an introduction to the Overview sub-menu, within the Crypto menu, of the OpenBB Terminal. The menu provides general insights and current statistics for the digital asset universe. +keywords: +- crypto +- coingecko +- coinpaprika +- cryptopanic +- bitcoin rainbow +- tokenterminal +- blockchaincenter +- rekt +- withdrawalfees +- bitcoin +- overview +- market +- indexes +- indices +- derivatives +- stablecoins +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +The Overview sub-menu provides general insights and current statistics for the digital asset universe. + +## Usage + +Enter the Overview menu from the Crypto menu by typing, `ov`, into the Terminal. Or, with the absolute path: + +```console +/crypto/ov +``` + +![Screenshot 2023-10-31 at 12 51 06 PM](https://github.com/OpenBB-finance/OpenBBTerminal/assets/85772166/c756cef5-4dfc-4098-a1a8-2fdf231c5f29) + +### Global + +This command will display a pie chart of the market cap distribution across categories. + +```console +/crypto/ov/global --pie +``` + +![Screenshot 2023-10-31 at 1 00 12 PM](https://github.com/OpenBB-finance/OpenBBTerminal/assets/85772166/f5b174f9-dd4a-45db-b033-f892187a292d) + +Without the `--pie` argument, a table of statistics will be returned. + +```console +/crypto/ov/global --source CoinPaprika +``` + +| Metric | Value | +|:-----------------------------|:--------------------| +| market_cap_usd | 1311005992664 | +| volume_24h_usd | 80507355044 | +| bitcoin_dominance_percentage | 51.45 | +| cryptocurrencies_number | 8647 | +| market_cap_ath_value | 3629384273801 | +| market_cap_ath_date | 2021-10-27 07:40:00 | +| volume_24h_ath_value | 16460384024873 | +| volume_24h_ath_date | 2022-12-03 07:55:00 | +| volume_24h_percent_from_ath | -99.51 | +| volume_24h_percent_to_ath | 9999.99 | +| market_cap_change_24h | 0.22 | +| volume_24h_change_24h | -0.03 | +| last_updated | 2023-10-31 13:08:03 | + +```console +/crypto/ov/global --source CoinGecko +``` + +| Metric | Value | +|:-------------------------------------|-------------:| +| Active Cryptocurrencies | 10669 | +| Upcoming Icos | 0 | +| Ongoing Icos | 49 | +| Ended Icos | 3376 | +| Markets | 915 | +| Market Cap Change Percentage 24H Usd | 0.388704 | +| Btc Market Cap In Pct | 50.9577 | +| Eth Market Cap In Pct | 16.4667 | +| Altcoin Market Cap In Pct | 32.5756 | + + +### Info + +`info` populates a table comparing key statistics. + +```console +/crypto/ov/info --limit 5 +``` + +| rank | name | symbol | price | volume_24h | circulating_supply | total_supply | max_supply | market_cap | beta_value | ath_price | +|-------:|:-------------|:---------|-------------:|-------------:|---------------------:|---------------:|-------------:|-------------:|-------------:|------------:| +| 1 | Bitcoin | BTC | 34549.1 | 4358348411.915434 | 19529500 | 19529494 | 21000000 | 674727548248 | 1.08882 | 68692.1 | +| 2 | Ethereum | ETH | 1810.87 | 5255905608.761287 | 120269517 | 120269517 | 0 | 217792941980 | 1.14074 | 4864.11 | +| 3 | Tether | USDT | 1.00039 | 30909958617.638874 | 84663138137 | 87870794561 | 0 | 84696158663 | -0.00166159 | 1.21549 | +| 4 | Binance Coin | BNB | 225.853 | 364485823.712885 | 151703660 | 151070177 | 200000000 | 34262746244 | 0.858213 | 690.568 | +| 5 | XRP | XRP | 0.598955 | 1706798672.187495 | 53560508378 | 99988331658 | 100000000000 | 32080335199 | 1.01748 | 3.84194 | + + diff --git a/website/content/terminal/menus/econometrics.md b/website/content/terminal/menus/econometrics.md new file mode 100644 index 000000000000..bc9efa148e82 --- /dev/null +++ b/website/content/terminal/menus/econometrics.md @@ -0,0 +1,289 @@ +--- +title: Econometrics +description: This documentation page introduces the Econometrics menu, in the OpenBB Terminal. The menu has features for performing statistical analysis on custom datasets. +keywords: +- econometrics +- statistics +- statistical research +- custom datasets +- panel regression +- autocorrelation tests +- heteroscedasticity +- OpenBBUserData +- panel +- normality +- co-integration +- unitroot +- garch +- linear regression +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +The Econometrics functions are for performing statistical analysis on custom datasets. Multiple data sets can be loaded from local storage and modified with basic DataFrame operations. Statistical tests - (e.g. Breusch-Godfrey autocorrelation tests) or OLS and Panel regressions (e.g. Random Effects and Fixed Effects) - are performed on any of the loaded files. + +## Usage + +Enter the Econometrics menu from the main menu by typing, `econometrics`, into the Terminal. The absolute path for the menu is: + +```console +/econometrics +``` + +![Screenshot 2023-11-02 at 9 03 24 AM](https://github.com/OpenBB-finance/OpenBBTerminal/assets/85772166/b1720a35-d5d0-44c8-9826-b0cfffe29ee0) + + +### Sample Datasets + +![Screenshot 2023-11-02 at 12 12 07 PM](https://github.com/OpenBB-finance/OpenBBTerminal/assets/85772166/44cf93ce-96f9-4c6b-bed1-611f27738de9) + +There are sample datasets included in the Scipy library, those are listed by adding `--examples` to the `load` command. For example, `longley`: + +```console +load longley +``` + +:::note +Due to the small size of the dataset, many of these tests are not statistically significant. +::: + + +### Load + +The first step in using the Econometrics menu is to load in some data. Place files in the paths displayed at the top of the menu, under "Looking for data in:". + +![Screenshot 2023-11-02 at 9 15 17 AM](https://github.com/OpenBB-finance/OpenBBTerminal/assets/85772166/aabd6f32-2495-45f4-84b7-3d6686875e66) + +This file contains historical monthly levels of the S&P 500 price and P/E ratio. It was populated from: [Nasdaq Data Link](https://data.nasdaq.com/data/MULTPL-sp-500-ratios). + +After loading a file, refreshing the screen (`?` or `h` with no command) updates the information printed under "Loaded files and data columns:". + +```console +Loaded files and data columns: + sp500_pe : date, pe, price +``` + +### Show + +Use the `show` command to inspect a a loaded file. If more than one file has been loaded, specify the target's name. + +```console +show sp500_pe +``` + +| date | pe | price | +|:-----------|------:|--------:| +| 1871-01-31 | 11.1 | 4.44 | +| 1871-02-28 | 11.25 | 4.5 | +| ... | ... | ... | +| 2023-10-31 | 23.94 | 4193.8 | + + +### Index + +Set the index by using a similar syntax to: + +```console +index sp500_pe -i date +``` + +A confirmation message will print: + +```console +Successfully updated 'sp500_pe' index to be 'date' +``` + +### Type + +Format any column as one of: + +- int +- float +- str +- bool +- cataegory +- date + +To see what a column is defined as already: + +```console +type sp500_pe.pe +``` + +```console +The type of 'sp500_pe.pe' is 'float64' +``` + +Change it by adding the `--format` argument and one of the choices listed above. + +If this column of numbers was defined as a string, it could be changed with: + +```console +type -n sp500_pe.pe --format float +``` + +```console +Update 'sp500_pe.pe' with type 'float' +``` + +### RET + +Add a column to the time series for returns. + +```console +ret -v sp500_pe.price +``` + +### Clean + +If NaN values exist, use the `clean` command to handle them. The example below removes rows where they exist. The new `returns` column will contain a NaN in the first row. + +```console +clean sp500_pe -d rdrop +``` + +```console +Successfully cleaned 'sp500_pe' dataset +``` + +### Plot + +Plot columns from a loaded dataset using the `plot` command. + +```console +plot sp500_pe.pe +``` + +![Screenshot 2023-11-02 at 9 40 47 AM](https://github.com/OpenBB-finance/OpenBBTerminal/assets/85772166/316104d9-17a7-4c96-9516-57a4074fd221) + +### OLS + +Fit an OLS regression model to a loaded data set by defining the dependent and independent variables as column names. + +```console +ols sp500_pe.pe -i sp500_pe.price,sp500_pe.price_returns +``` + +![Screenshot 2023-11-02 at 11 15 11 AM](https://github.com/OpenBB-finance/OpenBBTerminal/assets/85772166/6ba43577-aa95-4c17-b1d4-77561629972f) + +**`bgod` and `bpag` commands require running `OLS` first.** + + +### Norm + +The `norm` is used to determine whether the data is normally distributed. + +```console +norm sp500_pe.price_returns +``` + +| | Kurtosis | Skewness | Jarque-Bera | Shapiro-Wilk | Kolmogorov-Smirnov | +|:----------|-----------:|-----------:|--------------:|---------------:|---------------------:| +| Statistic | 20.5784 | 7.20623 | 20258.4 | 0.903374 | 0.454473 | + + +A histogram of the distribution is displayed by adding a, `-p`, flag to the command. + +```console +norm sp500_pe.price_returns -p +``` + +![Screenshot 2023-11-02 at 12 25 22 PM](https://github.com/OpenBB-finance/OpenBBTerminal/assets/85772166/4aa0ff4a-b3c5-4a88-acd5-25c754724b9f) + + +### Working With Panel Data + +Within the examples of `load --examples` there is one panel dataset available named `wage_panel`. This is a dataset from the paper by Vella and M. Verbeek (1998), “Whose Wages Do Unions Raise? A Dynamic Model of Unionism and Wage Rate Determination for Young Men,” Journal of Applied Econometrics 13, 163-183. This is a well-known dataset also used within Chapter 14 of Introduction to Econometrics by Jeffrey Wooldridge. + +In the example below, the dataset is loaded and given an alias by adding the, `-a`, argument. + +```console +/econometrics/load --file wage_panel -a wp +``` + +To run panel regressions, it is important to define both _entity_ (e.g. company) and _time_ (e.g. year). Trying to run the `panel` command would right now result in the following: + +```console +panel -d wp.lwage -i wp.black,wp.hisp,wp.exper,wp.expersq,wp.married,wp.educ,wp.union,wp.year +``` + +```console +The column 'lwage' from the dataset 'wp' is not a MultiIndex. + +Make sure you set the index correctly with the index (e.g. index wp -i lwage,nr) command where the first level is the entity (e.g. Tesla Inc.) and the second level the date (e.g. 2021-03-31) +``` + +Within this dataset the `nr` and `year` columns define the _entity_ and _time_. To allow panel regression estimations, they will need to be defined using the `index` command. + +```console +index wp -i nr,year +``` + +```console +Successfully updated 'wp' index to be 'nr, year' +``` + +The columns `nr` and `year` still exists within the dataset and could have been dropped with the `-d` argument if desired. However, in this case the `year` column is relevant for generating time effects in Pooled OLS, Fixed Effects and Random Effects estimations. To be able to do this, the type of the year column needs to be changed. + +For the panel regressions, it can be beneficial to see time effects from `year`. Therefore, the type of the `year` column should be altered to `category`. This can be done with the following command: + +```console +type wp.year --format category +``` + +```console +Update 'wp.year' with type 'category' +``` + +The dataset is now properly configured to allow for proper panel regressions. The type of regression used is a choice of: + +- `-r pols` (Pooled OLS) +- `-r re` (Random Effects) +- `-r bols` (Between OLS) +- `-r fe` (Fixed Effects) +- `-r fdols` (First Difference OLS). + +For example, a **Random Effects** regression is performed. + +``` +panel -d wp.lwage -i wp.black,wp.hisp,wp.exper,wp.expersq,wp.married,wp.educ,wp.union,wp.year -r re +``` + +![Screenshot 2023-11-02 at 1 03 57 PM](https://github.com/OpenBB-finance/OpenBBTerminal/assets/85772166/1b576690-53b6-4ca2-9aa7-bc19cb3ac4f1) + + +### Scripts & Routines + +Doing research, both as a student or professor for a university or as a professional, often requires the findings to be easily replicated. As many steps could be required, the ability to make small adjustments without needing to re-do every single step again. This is where [OpenBB Routines](/terminal/usage/routines/introduction-to-routines.md) play an important role. + +Use the contents below as a demo file, copying and pasting into a file saved to the `~/OpenBBUserData/routines` folder. + +```txt +# Go into the econometrics context +econometrics + +# Load the wage_panel dataset and include an alias +load wage_panel -a wp + +# Set the MultiIndex, allowing for Panel regressions to be performed +index wp -i nr,year + +# Change the type of the year column so it can be included as time effects within the regressions +type wp.year --format category + +# Perform a Pooled OLS, Random Effects and Fixed Effects estimation +panel -d wp.lwage -i wp.black,wp.hisp,wp.exper,wp.expersq,wp.married,wp.educ,wp.union,wp.year +panel -d wp.lwage -i wp.black,wp.hisp,wp.exper,wp.expersq,wp.married,wp.educ,wp.union,wp.year -r re +panel -d wp.lwage -i wp.expersq,wp.union,wp.married,wp.year -r fe + +# Compare the results obtained from these regressions +compare +``` + +Run the routine from the Main menu: + +```console +/exe -f name_of_file.openbb +``` diff --git a/website/content/terminal/menus/economy.md b/website/content/terminal/menus/economy.md new file mode 100644 index 000000000000..de4fc42524e9 --- /dev/null +++ b/website/content/terminal/menus/economy.md @@ -0,0 +1,212 @@ +--- +title: Economy +description: This documentation page provides detailed information about OpenBB Terminal's + Economy Menu. This includes overviews of broad market and country-specific data, + querying from databases such as FRED and OECD, and insightful comparisons using + stored datasets. A must-read for those to get the most out of macroeconomic data + querying. +keywords: +- Macroeconomic data +- Federal Reserve of St. Louis +- FRED +- OECD +- EconDB +- API key +- Economy menu +- Broad market +- Country performance +- Databases +- Stored datasets +- Market data +- Economic calendar +- Time series data +- US Treasury rates +- Gross Domestic Product (GDP) +- Government debt-to-GDP ratios +- Harmonized CPI +- Confidence in government surveys +- USD Liquidity Index +- US Dollar Liquidity Index +- Global indices +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + + +The `/economy` menu provides methods for querying macroeconomic data sets from sources like FRED, OECD, and EconDB. To get the most out of this menu, sign up for a free API key from the [Federal Reserve of St. Louis](https://fred.stlouisfed.org/), and enter it into the OpenBB Terminal from the [`/keys` menu](/terminal/usage/data/api-keys). + +## The Economy Menu + +The menu is divided into four general sections: + +- **Broad market**: General headline statistics from the markets today. +- **Country performance**: Country-specific data published by the OECD. +- **Databases**: Query time series. +- **Stored datasets**: Compare and chart multiple time series together. + +Each command is listed below, with a short description. + +### Broad Market + +|Function Key |Description | +|:-----|-----:| +|overview |Market overview of either indices, bonds or currencies. | +|futures |Futures and commodities overview. | +|map |S&P 500 heat map. | +|bigmac |The Economist's Big Mac Index. | +|events |The economic calendar. | +|edebt |External debt statitistics for various countries. | +|valuation |Valuation of sectors, industries, and countries for US-listed stocks. | +|performance |Performance of sectors, industry, and countries for US-listed stocks. | +|usdli |USD Liquidity Index | + +### Country Performance + +|Function Key |Description | +|:-----|-----:| +|gdp |Nominal Gross Domestic Product (GDP). | +|rgdp |Real Gross Domestic Product (GDP). | +|fgdp |Forecasts of nominal and real Gross Domestic Product (GDP). | +|debt |Government debt-to-GDP ratios. | +|cpi |Harmonized CPI. | +|ccpi |CPI Components. | +|balance |Government tax revenues. | +|spending |Government spending. | +|trust |Confidence in government surveys. | + +### Databases + +|Function Key |Description | +|:-----|-----:| +|macro |Time series data by country and indicator. | +|treasury |Historical US Treasury rates. | +|fred |Query the FRED. | +|index |Historical daily time series for most major global indices. | + +### Stored Datasets + +|Function Key |Description | +|:-----|-----:| +|eval |A method for performing basic `eval` operations on a time series. +|plot |Plot multiple time series together. | + +## Examples + +This section will demonstrate some basic operations within the menu. + +### events + +A morning ritual might begin with checking the economic calendar for the day's - or week's - events. The `events` command can browse the calendar by country and date. By default, the current day for all countries will display in a table. + +```console +/economy/events +``` + +![Economic Calendar](https://user-images.githubusercontent.com/85772166/236106887-07732390-bee3-44e0-a69f-a71c8ee90a8e.png) + +To select a specific country, attach `--countries` to the command, then press the space bar. Use the up or down arrow keys to browse the choices. + +![Economic Calendar Countries](https://user-images.githubusercontent.com/85772166/236106932-473c0f02-af80-49a6-bdb3-548ac1e689fa.png) + +### overview + +The `overview` fetches the headline levels and rates from the Wall Street Journal. Choose from of the categories by attaching the `-t` argument to the command. + +```console +/economy/overview -t usbonds +``` + +![Overview](https://user-images.githubusercontent.com/85772166/236106975-961d7163-2ac8-4e05-b8df-34f2cf4908e7.png) + +| | Rate (%) | Yld (%) | Yld Chg (%) | +|:-------------|-----------:|----------:|--------------:| +| 30-Year Bond | 3.625 | 3.686 | -0.028 | +| 10-Year Note | 3.5 | 3.343 | -0.085 | +| 7-Year Note | 3.5 | 3.323 | -0.122 | +| 5-Year Note | 3.5 | 3.305 | -0.162 | +| 3-Year Note | 3.75 | 3.513 | -0.18 | +| 2-Year Note | 3.875 | 3.838 | -0.144 | +| 1-Year Bill | 0 | 4.665 | -0.09 | +| 6-Month Bill | 0 | 4.98 | 0.005 | +| 3-Month Bill | 0 | 5.212 | 0.064 | +| 1-Month Bill | 0 | 4.452 | 0.114 | + +### debt + +Compare debt-to-GDP ratios between groups of countries by entering them as a comma-separated list. + +```console +/economy/debt -c australia,norway,united_states,italy,japan +``` + +![Debt-to-GDP](https://user-images.githubusercontent.com/85772166/236107021-231e7472-10a0-4208-a92e-fe56c81076c0.png) + +### usdli + +Compare the US Dollar Liquidity Index against a selection of indices published to FRED. + +```console +/economy/usdli -o WILLSMLCAP +``` + +![USD Liquidity Index](https://github.com/OpenBB-finance/OpenBBTerminal/assets/85772166/1a2abf90-aa81-4d02-a77a-c913bfef14d7) + +The indices available to overlay are displayed in a table by adding, `--show`, to the command. + +```console +/economy/usdli --show +``` + +### valuation + +Get valuations of industries and sectors for the US equity universe. Select the focus by using the, `-g` (`--group`), parameter. + +![Valuation By Industry](https://github.com/OpenBB-finance/OpenBBTerminal/assets/85772166/0793bd01-95b9-46f3-90b5-5c4af851283f) + +```console +valuation --group consumer_cyclical +``` + +![Consumer Cyclical Valuations](https://github.com/OpenBB-finance/OpenBBTerminal/assets/85772166/53e670fc-34cd-444f-9aa9-79fe5714e786) + +### index + +Major global indices are curated under the `index` command. Adding `--show` to the command will display a table with the list. + +```console +index --show +``` + +![Curated Index List](https://user-images.githubusercontent.com/85772166/236107143-a3e260e0-9530-4448-a552-12b46ae0aa72.png) + +The cumulative returns of an index is displayed instead of the levels by attaching `-r` to the command. Multiple indices can be queried simultaneously. + +```console +index sp500,sp400,sp600 --start 2023-01-01 -r +``` + +![Indices](https://user-images.githubusercontent.com/85772166/236107229-410673db-e1ce-4e93-9e96-7821328e04dd.png) + +### fred + +To lookup FRED series by keywords attach, `-q`, to the `fred` command. + +```console +fred -q PCE +``` + +![Fred Series](https://user-images.githubusercontent.com/85772166/236107269-8f126f17-3da7-4bb3-8acb-35f3ad783f84.png) + +### plot + +After requesting a time series, it gets populated under `Stored datasets`. Plot them together, on a shared or separate y-axis, by using the `plot` command. + +![Multi-Axis Plots](https://user-images.githubusercontent.com/85772166/236107312-95ed4b92-e418-444c-b436-f45a1fc0a75d.png) + +```console +plot --y1 PCE --y2 sp500 +``` + +![Plot Multiple Time Series](https://user-images.githubusercontent.com/85772166/236107339-46037f4b-bc4f-458c-9f17-55a4cc6a61bc.png) diff --git a/website/content/terminal/menus/etf.md b/website/content/terminal/menus/etf.md new file mode 100644 index 000000000000..6a30db2b4e86 --- /dev/null +++ b/website/content/terminal/menus/etf.md @@ -0,0 +1,198 @@ +--- +title: ETF +description: This guide introduces the ETF menu, in the OpenBB Terminal. The features provide methods for searching and comparing funds across the ETF universe. +keywords: +- ETF +- overview +- holdings +- weights +- news +- compare companies +- discovery +- technical indicators +- forecasting +- export to Excel +- exchange traded funds +- stock market +- financial tool +- portfolio +- stock chart +- Vanguard Total Stock Market Index Fund +- VTI +- load ETF +- ETF chart +- trendlines +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +The ETF menu features provide methods for searching and comparing funds across the ETF universe. + +## Usage + +Enter by typing `etf` from the main menu of the Terminal, or with the absolute path: + +```console +/etf +``` + +![Screenshot 2023-11-02 at 5 43 12 PM](https://github.com/OpenBB-finance/OpenBBTerminal/assets/85772166/f50269a8-8ebc-4ef9-bd37-4c9e15774005) + +### Search + +Find ETFs by fuzzy query using the `search` command. + +```console +/etf search --name SPDR S&P +``` + +![Screenshot 2023-11-02 at 5 50 19 PM](https://github.com/OpenBB-finance/OpenBBTerminal/assets/85772166/984e0cbb-bced-4610-8a55-3262fdf8ea2a) + +### Load + +Use the `load` command to place a symbol into memory. + +```console +/etf/load xhb +``` + +### Overview + +`overview` shows a table of general statistics. + +```console +/etf/load xhb/overview +``` + +| | XHB | +|:-----------------|:-------------| +| Assets | $1.21B | +| Expense Ratio | 0.35% | +| PE Ratio | 11.24 | +| Shares Out | n/a | +| Dividend (ttm) | $0.74 | +| Dividend Yield | 0.99% | +| Ex-Dividend Date | Sep 18, 2023 | +| Volume | 8,880,265 | +| Open | 75.04 | +| Previous Close | 73.82 | +| 52-Week Low | 54.10 | +| 52-Week High | 85.13 | +| Beta | n/a | +| Holdings | 37 | + +### Holdings + +The `holdings` command provides a current view of the loaded ETF. + +```console +/etf/load xhb/holdings +``` + +| Symbol | Name | % Of Etf | Shares | +|:---------|:-----------------------------------|:-----------|----------:| +| WSM | Williams-Sonoma, Inc. | 4.50% | 321673 | +| CSL | Carlisle Companies Incorporated | 4.35% | 183841 | +| LII | Lennox International Inc. | 4.12% | 119330 | +| MAS | Masco Corporation | 3.99% | 821783 | +| TT | Trane Technologies plc | 3.98% | 224389 | +| PHM | PulteGroup, Inc. | 3.92% | 572445 | +| ALLE | Allegion plc | 3.92% | 427461 | # cspell: disable-line +| LEN | Lennar Corporation | 3.87% | 389388 | +| DHI | D.R. Horton, Inc. | 3.83% | 393696 | +| FND | Floor & Decor Holdings, Inc. | 3.78% | 493049 | +| TOL | Toll Brothers, Inc. | 3.76% | 571043 | +| HD | The Home Depot, Inc. | 3.72% | 140504 | +| NVR | NVR, Inc. | 3.70% | 7339 | +| JCI | Johnson Controls International plc | 3.68% | 805731 | +| LOW | Lowe's Companies, Inc. | 3.55% | 199799 | +| TPX | Tempur Sealy International, Inc. | 3.51% | 942711 | +| WMS | Advanced Drainage Systems, Inc. | 3.50% | 351760 | +| CARR | Carrier Global Corporation | 3.50% | 787745 | +| OC | Owens Corning | 3.41% | 323306 | +| BLDR | Builders FirstSource, Inc. | 3.34% | 330150 | +| AOS | A. O. Smith Corporation | 3.33% | 511883 | +| FBIN | Fortune Brands Innovations, Inc. | 3.17% | 609787 | +| TREX | Trex Company, Inc. | 2.79% | 532594 | +| BLD | TopBuild Corp. | 2.64% | 123797 | +| TMHC | Taylor Morrison Home Corporation | 2.07% | 580878 | +| TPH | Tri Pointe Homes, Inc. | 1.39% | 596693 | +| MHO | M/I Homes, Inc. | 1.39% | 181673 | +| MDC | M.D.C. Holdings, Inc. | 1.26% | 356746 | +| IBP | Installed Building Products, Inc. | 1.21% | 116492 | +| GRBK | Green Brick Partners, Inc. | 1.03% | 285076 | +| LGIH | LGI Homes, Inc. | 1.02% | 116166 | +| SKY | Skyline Champion Corporation | 1.01% | 185257 | +| CVCO | Cavco Industries, Inc. | 0.76% | 32610 | +| CCS | Century Communities, Inc. | 0.67% | 117325 | +| DFH | Dream Finders Homes, Inc. | 0.27% | 146550 | +| - | STATE STREET INSTITUTIONAL LIQ | 0.09% | 922512 | +| - | US DOLLAR | -2.36% | -25351025 | + +### Compare + +The `compare` command accepts a comma-separated list of symbols for comparing overview metrics. + +```console +compare -e xhb,pkb,rez,homz +``` + +| | XHB | PKB | REZ | HOMZ | +|:-----------------|:-------------|:-------------|:-------------|:-------------| +| Assets | $1.21B | $208.81M | $590.71M | $33.85M | +| Expense Ratio | 0.35% | 0.60% | 0.48% | 0.30% | +| PE Ratio | 11.24 | 9.23 | 21.51 | 10.42 | +| Shares Out | n/a | n/a | n/a | n/a | +| Dividend (ttm) | $0.74 | $0.23 | $2.20 | $0.80 | +| Dividend Yield | 0.99% | 0.45% | 3.43% | 2.30% | +| Ex-Dividend Date | Sep 18, 2023 | Sep 18, 2023 | Sep 26, 2023 | Oct 17, 2023 | +| Volume | 8,880,265 | 13,224 | 48,825 | 3,926 | +| Open | 75.04 | 50.59 | 63.05 | 33.90 | +| Previous Close | 73.82 | 49.83 | 62.31 | 33.47 | +| 52-Week Low | 54.10 | 37.54 | 60.64 | 29.89 | +| 52-Week High | 85.13 | 57.25 | 78.33 | 40.68 | +| Beta | n/a | n/a | n/a | n/a | +| Holdings | 37 | 32 | 43 | 102 | + + +### Disc + +The `disc` sub-menu has the movers of the day. + +- gainers +- decliners +- active + +```console +/etf/disc/gainers +``` + +| | Price | Chg | %Chg | Vol | +|:------------------------------------------------------|--------:|-------:|-------:|:-------| +| Direxion Daily Regional Banks Bull 3X Shares | 53.11 | 7.74 | 17.06 | 2.4M | +| AXS 2X Innovation ETF | 51.02 | 7.38 | 16.91 | 165.0K | +| T-Rex 2X Long Tesla Daily Target ETF | 19.8 | 2.29 | 13.08 | 177.6K | +| GraniteShares 1.5x Long Coinbase Daily ETF | 11.94 | 1.38 | 13.07 | 244.7K | +| MicroSectors U.S. Big Banks Index 3X Leveraged ETN | 13 | 1.44 | 12.46 | 1.4M | +| AdvisorShares MSOS 2x Daily ETF | 2.72 | 0.3 | 12.4 | 371.6K | +| Direxion Daily Homebuilders & Supplies Bull 3X Shares | 53.53 | 5.02 | 10.35 | 716.9K | +| GraniteShares 1.75x Long TSLA Daily ETF | 21.3 | 1.99 | 10.31 | 78.2K | +| Direxion Daily South Korea Bull 3X Shares | 6.45 | 0.57 | 9.69 | 447.4K | +| Direxion Daily TSLA Bull 1.5X Shares | 12.41 | 1.06 | 9.34 | 14.7M | +| Valkyrie Bitcoin Miners ETF | 10.59 | 0.9 | 9.29 | 232.1K | +| Direxion Daily S&P 500 High Beta Bull 3X Shares | 22.96 | 1.91 | 9.07 | 332.5K | +| MicroSectors Oil & Gas Exp. & Prod. 3x Leveraged ETN | 41.87 | 3.405 | 8.85 | 209.5K | +| Direxion Daily Real Estate Bull 3x Shares | 6.78 | 0.55 | 8.83 | 1.9M | +| Direxion Daily Retail Bull 3x Shares | 5.53 | 0.44 | 8.64 | 607.1K | +| ARK Innovation ETF | 38.28 | 2.97 | 8.41 | 28.6M | +| Direxion Daily Small Cap Bull 3x Shares | 24.94 | 1.86 | 8.06 | 22.6M | +| GraniteShares 1.25x Long Tesla Daily ETF | 15.06 | 1.1015 | 7.89 | 66.9K | +| ProShares UltraPro Russell2000 | 29.24 | 2.1 | 7.74 | 2.0M | +| Direxion Daily Consumer Discretionary Bull 3X Shares | 24.23 | 1.73 | 7.69 | 58.6K | +| VanEck Digital Transformation ETF | 6.13 | 0.43 | 7.54 | 263.3K | +| ARK Next Generation Internet ETF | 55.72 | 3.77 | 7.26 | 410.6K | +| Direxion Daily Financial Bull 3x Shares | 58.32 | 3.86 | 7.09 | 1.0M | +| Direxion Daily Semiconductor Bull 3X Shares | 17.08 | 1.13 | 7.08 | 90.0M | +| Ark Fintech Innovation ETF | 19.43 | 1.25 | 6.88 | 561.6K | diff --git a/website/content/terminal/menus/fixedincome.md b/website/content/terminal/menus/fixedincome.md new file mode 100644 index 000000000000..b30d2de64f98 --- /dev/null +++ b/website/content/terminal/menus/fixedincome.md @@ -0,0 +1,129 @@ +--- +title: Fixed Income +description: This guide introduces the Fixed Income menu, in the OpenBB Terminal, and provides examples for use. Features in this menu cover reference rates and government bonds, as well as corporate bond indices. +keywords: +- Fixed Income +- Financial Terminal +- Rates and Indices +- Plotting Data +- Central Bank Rates +- Government Bonds +- Corporate Bonds +- Spreads +- API Key +- User Guide +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +The Fixed Income menu functions for reference rates (ESTER, SOFR, SONIA and Ameribor), central bank rates (FRED, FOMC projections and ECB key interest rates), government bonds (treasury rates for any country, us-specific rates, yield curves), corporate bonds (ICE BofA Corporate Indices, Moody's AAA and BAA Corporate Indices, Commercial Paper, Spot Rates and HQM Corporate Yield Curve) and spreads (ICE BofA spreads, constant maturity spreads, and federal funds rate). + +:::note + +The menu relies on FRED for data requests, please refer to the [API keys guide](/terminal/usage/data/api-keys.md) for information on how to obtain and set a key for FRED. + +::: + +## Usage + +Enter the Fixed Income menu by typing `fixedincome` into the Terminal from the Main menu, or use the absolute path: + +```console +/fixedincome +``` + +![Screenshot 2023-11-03 at 10 00 27 AM](https://github.com/OpenBB-finance/OpenBBTerminal/assets/85772166/f1f00a5e-e55b-48b5-9298-01886ecc3c3f) + +The menu has groups of commands related to the type of data: + +- Reference Rates +- Central Bank Rates +- Government Bonds +- Corporate Bonds +- Spreads + +Most commands are a time series, and they will have `--start` and `--end` arguments. The specific series can be selected in functions where a `--parameter` argument is supplied. + +![Screenshot 2023-11-03 at 10 45 28 AM](https://github.com/OpenBB-finance/OpenBBTerminal/assets/85772166/69a146fd-4849-499b-8c59-5f55b31ddae0) + +### SOFR + +Enter, `sofr`, to get the Secured Overnight Financing Rate as a chart. + +```console +/fixedincome/sofr +``` + +![Screenshot 2023-11-03 at 10 48 07 AM](https://github.com/OpenBB-finance/OpenBBTerminal/assets/85772166/5c769dd2-226e-44d5-bebf-baca2cb1b5bf) + +### USRates + +The `usrates` command is parameterized for: + +- TIPS (tips) +- Bills (tbill) +- Constant Maturity (cmn) + +The lengths of duration will differ between the three. To see the available combinations, use the `--options` flag. + +```console +/fixedincome/usrates --options +``` + +| | tbill | cmn | tips | +|:--------|:--------|:-------|:-------| +| 4_week | DTB4WK | - | - | +| 1_month | - | DGS1MO | - | +| 3_month | TB3MS | DGS3MO | - | +| 6_month | DTB6 | DGS6MO | - | +| 1_year | DTB1YR | DGS1 | - | +| 2_year | - | DGS2 | - | +| 3_year | - | DGS3 | - | +| 5_year | - | DGS5 | DFII5 | +| 7_year | - | DGS7 | DFII7 | +| 10_year | - | DGS10 | DFII10 | +| 20_year | - | DGS20 | DFII20 | +| 30_year | - | DGS30 | DFII30 | + +Make the selection with a syntax like: + +``` +/fixedincome/usrates -p tbill -m 1_year --start 2009-01-01 +``` + +![Screenshot 2023-11-03 at 11 03 11 AM](https://github.com/OpenBB-finance/OpenBBTerminal/assets/85772166/b84d4713-c7da-4fe2-a8a6-3ae15834d8fc) + +### ICESpread + +The `icespread` command are the Option-Adjusted Spreads from the ICE BofA Corporate Bond Index series. + +Adding, `--category duration`, will place all of the US indices on the same chart. + +```console +icespread --category duration +``` + +![Screenshot 2023-11-03 at 11 11 04 AM](https://github.com/OpenBB-finance/OpenBBTerminal/assets/85772166/18c77008-4bf1-44e7-a3e6-0fbb37a5e3bd) + + +### Treasury + +The `treasury` command allows the comparison between multiple countries at the short or long ends of rates. + +```console +treasury --forecast --short united_kingdom,united_states,germany --start 2014-01-01 +``` + +![Screenshot 2023-11-03 at 11 21 14 AM](https://github.com/OpenBB-finance/OpenBBTerminal/assets/85772166/9122ae5b-4a58-4aaa-87c1-adedb5ddf4c0) + +### YCRV + +The `ycrv` command displays the yield curve on a specific date. The default state is the most recent. To view a historical date, add the `--date` argument. + +```console +ycrv --date 2008-11-03 +``` + +![Screenshot 2023-11-03 at 11 25 18 AM](https://github.com/OpenBB-finance/OpenBBTerminal/assets/85772166/14f9ff75-d2ed-4e29-af94-2598c7fae95e) diff --git a/website/content/terminal/menus/forecast.md b/website/content/terminal/menus/forecast.md new file mode 100644 index 000000000000..b508638ffc44 --- /dev/null +++ b/website/content/terminal/menus/forecast.md @@ -0,0 +1,666 @@ +--- +title: Forecast +description: A comprehensive guide exploring the Forecast menu, a machine learning + toolkit providing high-level, state-of-the-art, components. + Features include Data Loading, Data Exploration, Feature Engineering, Time Series + Forecasting, Anomaly Detection, and Miscellaneous AI Tools. This page presents real-world + examples and workflows for beginners and advanced users. +keywords: +- Docusaurus +- Metadata +- Search Engine Optimization +- Marketing +- Web page +- Content +- Forecast menu +- Machine learning toolkit +- Time Series Forecasting +- Anomaly Detection +- Feature Engineering +- Data Exploration +- Data Loading +- Dataset +- AI Tools +- Whisper +- YouTube +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +The Forecast menu is a machine learning toolkit that provides practitioners with high-level, state-of-the-art, components. Classical or deep learning models can be combined with low-level components and fine tuned to build new approaches and custom tuned models. Bring in multiple datasets and train machine learning models with unlimited external factors to see how underlying data may change future forecasting predictions and accuracy. + +## Usage + +The Forecast menu is entered from the Main menu, `forecast`, or with the absolute path: + +```console + /forecast +``` + +![The Forecast Menu](https://user-images.githubusercontent.com/85772166/233540050-071524c6-f374-4241-aa31-cf33b7685e22.png) + +There are also methods for entering the menu with a loaded ticker symbol from either of the [`/crypto` menu](/terminal/data-available/crypto) and [`/stocks` menu](/terminal/data-available/stocks) + +The menu is divided into sections for: + +- Loading Data +- Data Exploration +- Feature Engineering +- Time Series Forecasting +- Anomaly Detection +- Miscellaneous AI Tools + +and the functions within these groups are described in the following sections. + +### Loading Data + +#### With the Load Command + +If the Forecast menu has not been entered directly through the [`/crypto`](/terminal/data-available/crypto) or [`/stocks`](/terminal/data-available/stocks) menus, a dataset must be loaded before commencing any work. Use the `load` command to open one from a CSV file placed in the OpenBBUserData folder. The paths where the auto completion engine is looking for files is printed on the screen directly above the `load` command, `Looking for data in:` + +![Loading Data](https://user-images.githubusercontent.com/85772166/233540104-2aad880e-c077-448a-9aff-9d2f18baf19e.png) + +Use the following syntax to load a file and name a dataset, substituting `vix_daily` with the name of the file. + +```console + +load --file vix_daily.csv --alias vix +``` + +To refresh the screen, enter: `?` + +The dataset will be listed under the `load` command and display the column names within it. + +![Loading From a File](https://user-images.githubusercontent.com/85772166/233540197-0222d0a6-6f08-42e3-9072-a248eeec6f53.png) + +Repeat the process until all desired datasets have been loaded. + +#### Via the Stocks/Crypto Menus + +Use the `load` command, according to the nuances of each menu. For example's sake, and to match the starting date of the previously loaded file, it will look like: + +```console +/stocks/load SPY --start 1997-01-01/forecast +``` + +Combine these two methods an unlimited number of times for building a more complex model and forecast. + +![Load From Stocks Menu](https://user-images.githubusercontent.com/85772166/233540295-a7711fd8-992a-4561-b202-1b02a9a4aded.png) + +With some data loaded, the first series of tools are for inspecting, managing, and exporting the sets. + +### Exploration + +The exploration functions are listed in the table below, along with a short description. + +|Function |Description | +|:--------|-----------:| +|clean |Clean a dataset by filling or dropping NaNs. | +|combine |Combine columns from different datasets. | +|corr |Plot the correlation coefficients for dataset features. | +|delete |Delete columns from dataset. | +|desc |Show descriptive statistics of a dataset. | +|export |Export a processed dataset. | +|plot |Plot a specific columns of a loaded dataset. | +|rename |Rename columns from dataset. | +|season |Plot the seasonality for a dataset column. | +|setndays |Set the default number of days to forecast. | +|show |Show a portion of a loaded dataset. | + +#### Combine + +When running a model, all targeted columns must be within the same dataset. Use the `combine` command to accomplish this by merging one column with another dataset. + +```console +combine --dataset SPY -c vix.high +combine --dataset SPY -c vix.low +``` + +The SPY time series now has two additional columns from the VIX dataframe, high and low. + +#### Delete + +It may be desirable to remove entire columns from the target dataset. The syntax below removes the three columns from the SPY data loaded through the stocks menu. + +```console +delete --delete SPY.adj_close +delete --delete SPY.stock_splits +delete --delete SPY.dividends +``` + +#### Show + +After performing operations, examine the results using the `show` command. + +![Show](https://user-images.githubusercontent.com/85772166/233540348-e34d9342-f48e-48c1-ac0b-bef3261d8300.png) + +```console +show --name SPY +``` + +![Show Data](https://user-images.githubusercontent.com/85772166/233540386-eca474d6-596b-431e-9bf0-b7154257c877.png) + +#### Export + +To save all of the combined changes within a dataset, export it to a new file. + +```console +export -d SPY --type csv +``` + +This creates a new file in the [OpenBBUserData folder](/terminal/usage/data/custom-data). + +### Feature Engineering + +The Feature Engineering section provides methods for making fast calculations with a dataset. Each one is listed below with a short description. + +|Function |Description | +|:--------|-----------:| +|atr |Add Average True Range | +|delta |Add % Change | +|ema |Add Exponentially Weighted Moving Average | +|mom |Add Momentum | +|roc |Add Rate of Change | +|rsi |Add Relative Strength Index | +|sto |Add Stochastic Oscillator %K and %D | +|signal |Add Price Signal (short vs. long term) | + +Each function will have slight variations to the command syntax, but will generally operate similarly. Print the help dialogue as a reminder. + +```console +usage: rsi [-d {vix,SPY}] [-c TARGET_COLUMN] [--period PERIOD] [-h] + +Add rsi to dataset based on specific column. + +options: + -d {vix,SPY}, --dataset {vix,SPY} + The name of the dataset you want to select (default: None) + -c TARGET_COLUMN, --target-column TARGET_COLUMN + The name of the specific column you want to use (default: close) + --period PERIOD The period to use (default: 10) + -h, --help show this help message (default: False) + + +For more information and examples, use 'about rsi' to access the related guide. +``` + +```console + +usage: atr [--close-col CLOSE_COL] [--high-col HIGH_COL] [--low-col LOW_COL] [-d {vix,SPY}] + [-c TARGET_COLUMN] [-h] + +Add Average True Range to dataset of specific stock ticker. + +options: + --close-col CLOSE_COL + Close column name to use for Average True Range. (default: close) + --high-col HIGH_COL High column name to use for Average True Range. (default: high) + --low-col LOW_COL Low column name to use for Average True Range. (default: low) + -d {vix,SPY}, --dataset {vix,SPY} + The name of the dataset you want to select (default: None) + -c TARGET_COLUMN, --target-column TARGET_COLUMN + The name of the specific column you want to use (default: close) + -h, --help show this help message (default: False) + +For more information and examples, use 'about atr' to access the related guide. +``` + +To use these commands with the default settings, apply the syntax below. + +```console +atr -d SPY +rsi -d SPY +``` + +There are now two new columns in the SPY dataset, `true_range, RSI_10_close`. To keep the dataset organized, it may be worth renaming these columns. + +```console +rename -d SPY --oldcol RSI_10_close --newcol spy_rsi10 +rename -d SPY --oldcol true_range --newcol spy_atr +``` + +### Time Series Forecasting + +This group of features applies models to a target dataset and its columns. There are a wide selection to choose from. Please note that this guide is meant explain how to use the functions and does not attempt to explain the models themselves. This menu is an implementation of the [Unit8 Darts Time Series for Python](https://unit8.com/resources/darts-time-series-made-easy-in-python/) library. + +|Function |Description |Accepts Past Covariates? | +|:--------|:------------|:-----------------------| +|autoselect |Select best statistical model from AutoARIMA, AutoETS, AutoCES, MSTL, etc. |No | +|autoarima |Automatic ARIMA Model |No | +|autoces |Automatic Complex Exponential Smoothing Model |No | +|autoets |Automatic ETS (Error, Trend, Seasonality) Model |No | +|mstl |Multiple Seasonalities and Trend using Loess (MSTL) Model |No | +|rwd |Random Walk with Drift Model |No | +|seasonalnaive |Seasonal Naive Model |No | +|expo |Probabilistic Exponential Smoothing |No | +|theta |Theta Method |No | +|linregr |Probabilistic Linear Regression |Yes | +|regr |Regression |Yes | +|brnn |Block Recurrent Neural Network (RNN, LSTM, GRU) |Yes | +|nbeats |Neural Bayesian Estimation |Yes | +|nhits |Neural Hierarchical Interpolation |Yes | +|tcn |Temporal Convolutional Neural Network |Yes | +|trans |Transformer Network |Yes | +|tft |Temporal Fusion Transformer Network |Yes | + +Within this list of models, there are two distinct categories: + +- Without past covariates. +- With past covariates. + +The models featuring past covariates will accept an unlimited number of columns, or all columns can be chosen. The latter being more appropriate for when a dataset contains only columns which are deemed fit for the purpose. To use any model in its default state, all that is required is the command name and the target dataset's name. The default target column will always be `close` so, a column must be defined to run a model if the target dataset does not contain a column with this name. With the target column as `close`, the basic default syntax will look like: + +```console +rwd -d SPY +``` + +![Random Walk Drift](https://user-images.githubusercontent.com/85772166/233540491-34ba7cf0-dade-42d8-a165-5709ccf1e9fa.png) + +Each model should be reviewed carefully to understand what the adjustable parameters are, and how they should be defined. + +### Quantile Anomaly Detection + +`anom` performs a Quantile Anomaly detection on a given dataset. Read more about this calculation [here](https://unit8co.github.io/darts/generated_api/darts.ad.detectors.quantile_detector.html). + +```console +anom -d SPY +``` + +![Quantile Anomaly Detection](https://user-images.githubusercontent.com/85772166/233540548-1899cb39-35ef-4ea4-ac3c-1d1757f93ea8.png) + +### Miscellaneous AI Tools + +#### Whisper + +The `whisper` feature allows users to transcribe, translate, and summarize videos on YouTube. These abilities empowers users to perform deeper research than ever before, and opens the door to a more complete view of the macroeconomic landscape. The models are not installed until the first time it is used, and they can be quite significant in size. Performance will vary, and there is currently not a method for offloading processing to dedicated GPUs. + +```console +whisper https://www.youtube.com/watch?v=G0Q0BtGQzrA + +[DISCLAIMER]: This is a beta feature that uses standard NLP models. More recent models such as GPT will be added in future releases. + +Downloading and Loading NLP Pipelines from cache... + +All NLP Pipelines loaded. + +Transcribing and summarizing... +Downloaded video "China stuck in 8 trillion dollar debt crisis | GyanJaraHatke with Sourabh Maheshwari". Generating subtitles... +Detected language: Hindi +100%|████████████████████████████████████████████████████████| 83567/83567 [04:25<00:00, 314.21frames/s] +100%|███████████████████████████████████████████████████████████████████| 11/11 [02:44<00:00, 14.99s/it] + +------------------------- +Summary: Reduction: 81.38% +Sentiment: NEGATIVE: 73.2596 +------------------------- +China is the largest economy in the world. Usually China's economy is seen in the global level of the economy of America... +``` + +A file with the transcript is saved to the OpenBBUserData folder. + +## Sample Workflow #1 (Beginner) + +Let's begin by using one of the datasets we loaded in previously : `SPY` + +We will be forecasting `5 Business days` ahead for the remaider of these workflows unless specified. + +**Note:** All models automatically perform Historical backtesting on the test split before providing a prediction. + +We use [MAPE](https://en.wikipedia.org/wiki/Mean_absolute_percentage_error) for the default as it is quite convenient and scale independent since it calculates error as a percentage instead of an absolute value. There are many more metrics to compare time series. The metrics will compare only common slices of series when the two series are not aligned, and parallelize computation over a large number of pairs of series. Additional metrics to choose from are RMSE, MSE, and SMAPE. + +### plot + +```console +plot SPY.close +``` + +![Plot](https://user-images.githubusercontent.com/85772166/233540628-cc0b58e6-6259-4893-9dfe-4fb73217a181.png) + +### desc + +```console +desc SPY +``` + +![Describe](https://user-images.githubusercontent.com/85772166/233540670-3d4df645-8fff-41a6-a4f7-0a1005dbdb11.png) + +### expo + +Let's use a simple **Probabilistic Exponential Smoothing Model** to predict the close price. Keep in mind all models are performing automatic historical backtesting before providing future forecasts. Note that all models forecast `close` by default. + +```console +expo SPY +``` + +![Probalistic Exponential Smoothing Model](https://user-images.githubusercontent.com/85772166/233540707-1d87add0-b398-4083-9185-978e8e0bfe8c.png) + +### rnn + +We can also play with some models that are bit more advanced. As we go down the list, models begin to become larger in parameter size and complexity. This will play a key role later on when we want to train models with `past_covariates` (aka. external factors). + +This time lets test with a **Recurrent Neural Network** which by default uses an `LSTM` backbone. We can also choose to test out a `GRU` backbone to experiment. Let's do both and see if we can improve our accuracy and reduce the overall MAPE. + +```console +rnn SPY --forecast-only + +Epoch 50: 100%|█████████████████████████████████████| 214/214 [00:02<00:00, 77.77it/s, loss=-4.31, v_num=logs, train_loss=-4.46, val_loss=-.985] + +RNN model obtains MAPE: 3.13% +``` + +![RNN](https://user-images.githubusercontent.com/85772166/233540770-28abd8d5-c301-4d26-bd88-77287a6d71d7.png) + +This result expresses a different view from the Probabilistic Exponential Smoothing Model. + +For the second task, we would like to change the model type from `LSTM` --> `GRU`. Let's find out of this improves the MAPE score. Use the `-h` flag to understand the particular parameters one can change for RNN. (Please note that the parameters are different for each model). + +```console +rnn -h + +usage: rnn [--hidden-dim HIDDEN_DIM] [--training_length TRAINING_LENGTH] [--naive] [-d {vix,SPY}] [-c TARGET_COLUMN] [-n N_DAYS] + [-t TRAIN_SPLIT] [-i INPUT_CHUNK_LENGTH] [--force-reset FORCE_RESET] [--save-checkpoints SAVE_CHECKPOINTS] + [--model-save-name MODEL_SAVE_NAME] [--n-epochs N_EPOCHS] [--model-type MODEL_TYPE] [--dropout DROPOUT] [--batch-size BATCH_SIZE] + [--end S_END_DATE] [--start S_START_DATE] [--learning-rate LEARNING_RATE] [--residuals] [--forecast-only] [--export-pred-raw] + [--metric {rmse,mse,mape,smape}] [-h] [--export EXPORT] + +Perform RNN forecast (Vanilla RNN, LSTM, GRU): https://unit8co.github.io/darts/generated_api/darts.models.forecasting.rnn_model.html + +options: + --hidden-dim HIDDEN_DIM + Size for feature maps for each hidden RNN layer (h_n) (default: 20) + --training_length TRAINING_LENGTH + The length of both input (target and covariates) and output (target) time series used during training. Generally + speaking, training_length should have a higher value than input_chunk_length because otherwise during training the RNN + is never run for as many iterations as it will during training. (default: 20) + --naive Show the naive baseline for a model. (default: False) + -d {vix,SPY}, --dataset {vix,SPY} + The name of the dataset you want to select (default: None) + -c TARGET_COLUMN, --target-column TARGET_COLUMN + The name of the specific column you want to use (default: close) + -n N_DAYS, --n-days N_DAYS + prediction days. (default: 5) + -t TRAIN_SPLIT, --train-split TRAIN_SPLIT + Start point for rolling training and forecast window. 0.0-1.0 (default: 0.85) + -i INPUT_CHUNK_LENGTH, --input-chunk-length INPUT_CHUNK_LENGTH + Number of past time steps for forecasting module at prediction time. (default: 14) + --force-reset FORCE_RESET + If set to True, any previously-existing model with the same name will be reset (all checkpoints will be discarded). + (default: True) + --save-checkpoints SAVE_CHECKPOINTS + Whether to automatically save the untrained model and checkpoints. (default: True) + --model-save-name MODEL_SAVE_NAME + Name of the model to save. (default: rnn_model) + --n-epochs N_EPOCHS Number of epochs over which to train the model. (default: 300) + --model-type MODEL_TYPE + Enter a string specifying the RNN module type ("RNN", "LSTM" or "GRU") (default: LSTM) + --dropout DROPOUT Fraction of neurons affected by Dropout, from 0 to 1. (default: 0) + --batch-size BATCH_SIZE + Number of time series (input and output) used in each training pass (default: 32) + --end S_END_DATE The end date (format YYYY-MM-DD) to select for testing (default: None) + --start S_START_DATE The start date (format YYYY-MM-DD) to select for testing (default: None) + --learning-rate LEARNING_RATE + Learning rate during training. (default: 0.001) + --residuals Show the residuals for the model. (default: False) + --forecast-only Do not plot the historical data without forecasts. (default: False) + --export-pred-raw Export predictions to a csv file. (default: False) + --metric {rmse,mse,mape,smape} + Calculate precision based on a specific metric (rmse, mse, mape) (default: mape) + -h, --help show this help message (default: False) + --export EXPORT Export figure into png, jpg, pdf, svg (default: ) + +For more information and examples, use 'about rnn' to access the related guide. +``` + +Lets change the `--model-type` parameter to `GRU` and rerun. + +```console +rnn SPY --model-type GRU --forecast-only + +Epoch 85: 100%|█████████████████████████████████████| 214/214 [00:02<00:00, 75.10it/s, loss=-4.45, v_num=logs, train_loss=-4.35, val_loss=-2.35] + +RNN model obtains MAPE: 2.77% +``` + +![RNN with GRU](https://user-images.githubusercontent.com/85772166/233540843-2167a3ad-0088-4d84-a298-7b8b3b3655ff.png) + +We improved the accuracy score, great work! + +:::note +The take away for this is that all models should work out of the box when forecasting for a particular time series. One can switch the target by specifying a `-c` for `TARGET_COLUMN` and test out performance with multiple different models with a single command. +::: + +## Sample Workflow #2 (Advanced) + +To build successful models and improve accuracy over time, it is important to capture external data related to the time series you are training on. This can be seen in everyday applications: + +- Observed rainfalls and known weather forecasts can help to predict hydro and solar electricity production +- Recently-observed activity on an e-commerce website can help predict future sales. +- Making the model aware of up-coming holidays can help sales forecasting. + +In fact, more often than not, strictly relying on the history of a time series +to predict its future is missing a lot of valuable information. + +**Past covariates** are time series whose past values are known at prediction +time. Those series often contain values that have to be observed to be known. + +![image](https://user-images.githubusercontent.com/105685594/190244764-ce8cf01f-c959-4827-a326-62b0e172332d.png) + +To explore this topic more, please read the [blog post](https://medium.com/unit8-machine-learning-publication/time-series-forecasting-using-past-and-future-external-data-with-darts-1f0539585993) written by the authors of Darts. + +Note that only the following models can handle `past_covariates`: `BlockRNNModel`, `NBEATSModel`, `TCNModel`, `TransformerModel`, `RegressionModel` (incl. `LinearRegressionModel`), `Temporal Fusion Transformer` + +Earlier on in the guide we managed to accomplish the following: + +- Load multiple datasets. +- Combine datasets. +- Rename columns. +- Delete columns. + +We will continue this workflow by: + +- Adding some correlation analysis. +- Train models with `past_covariates`. + +For practice, let's start fresh and rebuild the same dataset. The [OpenBB Routine Scripts](/terminal/usage/routines/introduction-to-routines) can make quick work out of this chore. Copy the block below and create a new `.openbb` file, in `~/OpenBBUserData/routines/`, to follow along. + +```console +/stocks +load SPY --start 1997-01-01 +forecast +.. +load ^VIX --start 1997-01-01 +forecast +combine --dataset SPY -c ^VIX.high +combine --dataset SPY -c ^VIX.low +delete --delete SPY.adj_close +delete --delete SPY.stock_splits +delete --delete SPY.dividends +atr -d SPY +rsi -d SPY +rename -d SPY --oldcol RSI_10_close --newcol SPY_rsi10 +rename -d SPY --oldcol true_range --newcol SPY_atr +show SPY +``` + +Restart the Terminal to ensure that the routine file is found by the `/exe` command, and then run it. + +```console +exe --file forecast_demo.openbb +``` + +![Forecast Routine Demo](https://user-images.githubusercontent.com/85772166/233540963-b62b6f6b-a595-4cee-8ce9-8876024b3da8.png) + +### brnn + +Now take the new dataset and train a simple `Block RNN` model on SPY's `close` price, and again using `past_covariates` on a single column. + +Without past covariates: + +```console +brnn SPY --forecast-only +``` + +```console +Epoch 196: 100%|███████████████████████████████████| 214/214 [00:01<00:00, 107.42it/s, loss=-4.09, v_num=logs, train_loss=-4.07, val_loss=-1.53] + +Block RNN model obtains MAPE: 3.25% +``` + +![BRNN Without Covariates](https://user-images.githubusercontent.com/85772166/233541019-7bc0545e-f2f1-4a6d-84a2-7e7ac1de9043.png) + +With covariates: + +To use any covariates, there are two options: + +- specify specific columns with `--past-covariates` +- specify all columns as past covariates except the one you are forecasting + `--all-past-covariates` + +```console +brnn SPY --forecast-only --past-covariates volume +``` + +```console +Covariate #0: volume +Epoch 86: 100%|████████████████████████████████████████| 214/214 [00:02<00:00, 74.77it/s, loss=-4, v_num=logs, train_loss=-4.19, val_loss=-1.53] +Block RNN model obtains MAPE: 4.69% +``` + +![BRNN With Past Covariates](https://user-images.githubusercontent.com/85772166/233541054-552243aa-0509-47fd-8ac8-42c0b433095a.png) + +It is evident here that adding in the external variable of `volume` negatively affected the accuracy. + +Let's try adding a new column for the 200-day moving average. + +```console +ema -d SPY --period 200/brnn -d SPY --past-covariates EMA_200 +``` + +```console +Successfully added 'EMA_200' to 'SPY' dataset +Covariate #0: EMA_200 +Epoch 79: 100%|█████████████████████████████████████| 214/214 [00:02<00:00, 87.78it/s, loss=-3.81, v_num=logs, train_loss=-3.78, val_loss=-.435 +Block RNN model obtains MAPE: 4.60% +``` + +![BRNN With EMA200](https://user-images.githubusercontent.com/85772166/233541105-0f8dc802-e569-4ce2-b16a-0610e1cb99b7.png) + +This isn't an improvement. It's possible that there is too much noise in the data, so let's try shortening the length of time being used to train. + +```console + +brnn -d SPY --past-covariates EMA_200 -t 0.95 + +Covariate #0: EMA_200 +Epoch 87: 100%|█████████████████████████████████████| 215/215 [00:02<00:00, 82.81it/s, loss=-3.87, v_num=logs, train_loss=-4.29, val_loss=-1.59] +Block RNN model obtains MAPE: 3.38% +``` + +![Parameter Adjustments](https://user-images.githubusercontent.com/85772166/233541148-707d2167-46ee-47b1-b6dc-ed56b239f32f.png) + +Removing the 2020 volatility from the window of observation made a massive improvement to the forecast. Now let's see add all the columns in the dataset as past covariates. + +```console +brnn -d SPY --all-past-covariates -t 0.95 + +Covariate #0: open +Covariate #1: high +Covariate #2: low +Covariate #3: volume +Covariate #4: ^VIX_high +Covariate #5: ^VIX_low +Covariate #6: SPY_atr +Covariate #7: SPY_rsi10 +Covariate #8: EMA_200 +Epoch 39: 100%|█████████████████████████████████████| 215/215 [00:02<00:00, 83.50it/s, loss=-3.92, v_num=logs, train_loss=-4.03, val_loss=-2.14] +Block RNN model obtains MAPE: 3.57% +``` + +![BRNN with All Past Covariates](https://user-images.githubusercontent.com/85772166/233541177-7ddd64be-ec79-4aaf-b30f-41607a7b7f68.png) + +Adding all of the columns that were created doesn't improve the MAPE score, but it does narrow the range of forecasted prices. Playing around like this shows how small changes can have a large impact on a forecast. It is important to test many variables and parameters without getting too caught up overfitting any particular model. Validate a thesis before dedicating a large amount of time into it. + +### regr + +Using the `regr` function with `all-past-covariates` on the same dataset gives dramatically different forecast. + +```console +regr SPY --all-past-covariates + +Covariate #0: open +Covariate #1: high +Covariate #2: low +Covariate #3: volume +Covariate #4: ^VIX_high +Covariate #5: ^VIX_low +Covariate #6: SPY_atr +Covariate #7: SPY_rsi10 +Predicting Regression for 5 days +100%|███████████████████████████████████████████████████████████████████████████████████████████████████████| 1026/1026 [00:48<00:00, 21.35it/s] +Regression model obtains MAPE: 2.68% +``` + +![regr](https://user-images.githubusercontent.com/85772166/233541224-c2cbbaba-0b33-4d79-930a-dd2629d6ed94.png) + +Now that we know how to use covariates, and are starting to understand their effects, let's examine the impact of MSFT and AAPL closing prices on the regression forecast for SPY. We will discard the previous work and start fresh. + +The cache can be purged by resetting the Terminal. Use this command to clear it: + +```console +/r +``` + +Now we will fetch the data and combine the columns: + +```console +/stocks/load spy +forecast +.. +load aapl +forecast +.. +load msft +forecast +delete --delete SPY.stock_splits +delete --delete SPY.adj_close +delete --delete SPY.dividends +combine SPY -c AAPL.close +combine SPY -c MSFT.close +regr SPY --forecast-only --past-covariates AAPL_close,MSFT_close +``` + +**Remember: You can use unlimited number of `past_covariates` but they must all be combined into a single dataframe with the target forecast time series before training.** + +```console +Covariate #0: AAPL_close +Covariate #1: MSFT_close +Predicting Regression for 5 days +100%|█████████████████████████████████████████████████████████████████████████████████████████████████████████| 115/115 [00:01<00:00, 96.07it/s] +Regression model obtains MAPE: 1.77% +``` + +![Regression with Past Covariates](https://user-images.githubusercontent.com/85772166/233541267-42a541e2-ff5f-429e-a9fd-b9d2c76060ce.png) + +Adding the rest of the columns as past covariates improves the MAPE score slightly and starts to take a more directional view. + +```console +regr --all-past-covariates -d SPY + +Covariate #0: open +Covariate #1: high +Covariate #2: low +Covariate #3: volume +Covariate #4: AAPL_close +Covariate #5: MSFT_close +Predicting Regression for 5 days +100%|████████████████████████████████████████████████████████████████████████████████████████████████████████| 115/115 [00:00<00:00, 117.16it/s] +Regression model obtains MAPE: 1.66% +``` + +![Regression with All Past Covariates](https://user-images.githubusercontent.com/85772166/233541328-931117ff-9a84-437d-b8e8-b653d56335bc.png) + +:::note +The examples here are over-simplified as a means for demonstrating a framework to create and conduct experiments. It is important to keep in mind that these are tools, they are not oracles, and that results may vary. If you have any questions, requests for new feature engineering and model additions, or just want to be part of the conversation, please join us on [Discord](openbb.co/discord). Happy hacking! +::: diff --git a/website/content/terminal/menus/forex.md b/website/content/terminal/menus/forex.md new file mode 100644 index 000000000000..6d9a87243782 --- /dev/null +++ b/website/content/terminal/menus/forex.md @@ -0,0 +1,123 @@ +--- +title: Forex +description: This guide introduces the Forex (FX) menu, in the OpenBB Terminal, and provides examples for use. Features in this menu include historical prices and forward rates. It also provides entry points to the QA, TA, and Forecast menus. +keywords: +- Forex +- currency trading +- currency pairs +- USD/EUR +- JPY/GBP +- quote +- candle +- forward rates +- fwd +- technical analysis +- forecasting +- Oanda +- historical data +- real-time currency exchange +- terminal +- quantitative analysis +- seasonality +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +The Forex menu includes features for historical prices, forward rates, and real-time exchange rates. It also provides entry points to the [`/ta/`](/terminal/menus/common/ta.md), [`/qa`](/terminal/menus/common/qa.md), and [`/forecast`](/terminal/menus/forecast.md) menus. + + +## Usage + +The Forex menu is entered by typing `forex`, from the Main menu, or with the absolute path: + +```console +/forex +``` + +![Screenshot 2023-11-03 at 12 26 41 PM](https://github.com/OpenBB-finance/OpenBBTerminal/assets/85772166/83356fc6-9966-4da3-9bed-64ae7e42ecd0) + +### Load + +The first step will be to load a pair of currencies. The pairs are entered as a six-letter symbol, with the former of the pair being "from". + +```console +load JPYUSD +``` + +Inversely: + +```console +load USDJPY +``` + +### Quote + +A `quote` from YahooFinance displays the last price and a timestamp when it was refreshed. + +```console +/forex/load JPYUSD/quote +``` + +```console +Quote for JPY/USD + +Last refreshed : 2023-11-03 19:30:00 +Last value : 0.006694381590932608 +``` + +From AlphaVantage, a table is returned that includes a bid and ask. + +```console +quote --source AlphaVantage +``` + +| | Realtime Currency Exchange Rate | +|:-------------------|:----------------------------------| +| From_Currency Code | JPY | +| From_Currency Name | Japanese Yen | +| To_Currency Code | USD | +| To_Currency Name | United States Dollar | +| Exchange Rate | 0.00669000 | +| Last Refreshed | 2023-11-03 19:34:01 | +| Time Zone | UTC | +| Bid Price | 0.00668900 | +| Ask Price | 0.00669000 | + + +### FWD + +The `fwd` command gets a table with the term structure of a currency pair. + +```console +/forex/load USDJPY/fwd +``` + +| Expiration | Ask | Bid | Mid | Points | +|:--------------|--------:|--------:|--------:|-----------:| +| Overnight | 149.397 | 149.368 | 149.383 | 0 | +| Tomorrow Next | 149.397 | 149.368 | 149.382 | -2.33 | +| Spot Next | 149.397 | 149.368 | 149.382 | -2.325 | +| One Week | 149.395 | 149.366 | 149.381 | -16.315 | +| Two Weeks | 149.394 | 149.365 | 149.379 | -32.59 | +| Three Weeks | 149.392 | 149.363 | 149.378 | -48.89 | +| One Month | 149.39 | 149.361 | 149.375 | -70.1505 | +| Two Months | 149.381 | 149.352 | 149.367 | -155.31 | +| Three Months | 149.375 | 149.346 | 149.36 | -222.871 | +| Four Months | 149.368 | 149.339 | 149.353 | -290.68 | +| Five Months | 149.36 | 149.331 | 149.346 | -365.94 | +| Six Months | 149.354 | 149.325 | 149.339 | -431.97 | +| Seven Months | 149.347 | 149.318 | 149.332 | -500.22 | +| Eight Months | 149.34 | 149.311 | 149.326 | -567.58 | +| Nine Months | 149.334 | 149.305 | 149.319 | -630.18 | +| Ten Months | 149.327 | 149.298 | 149.313 | -697.4 | +| Eleven Months | 149.322 | 149.293 | 149.307 | -753.2 | +| One Year | 149.316 | 149.287 | 149.301 | -812.9 | +| Two Years | 149.256 | 149.227 | 149.242 | -1408.19 | +| Three Years | 149.204 | 149.173 | 149.188 | -1943.13 | +| Four Years | 149.158 | 149.127 | 149.142 | -2401.05 | +| Five Years | 149.108 | 149.077 | 149.092 | -2904.72 | +| Six Years | 149.08 | 149.048 | 149.064 | -3185.9 | +| Seven Years | 149.047 | 149.014 | 149.03 | -3522.5 | +| Ten Years | 148.948 | 148.912 | 148.93 | -4527.5 | diff --git a/website/content/terminal/menus/futures.md b/website/content/terminal/menus/futures.md new file mode 100644 index 000000000000..b51330c91695 --- /dev/null +++ b/website/content/terminal/menus/futures.md @@ -0,0 +1,85 @@ +--- +title: Futures +description: This documentation helps users understand how to use the Futures menu, + including capabilities like accessing historical prices, understanding the current + term structure of an asset, and using the search, curve and historical functions. + It also explains how to view categories, use ticker symbols, and export data. +keywords: +- Futures +- Historical Prices +- Asset +- Term Structure +- Search +- Curve +- Historical +- Futures Search Function +- Category Flag +- Ticker Symbol +- Eurodollar Futures +- Raw Data +- Export +- Historical Command +- Continuous Chart +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +The Futures menu provides historical prices and the current term structure for an asset. This menu is accessible from the Main menu by typing `futures` and pressing the `enter` key. + +image + +## How to Use + +There are three basic functions within this menu Search, Historical and Curve. + +`Search` allows the user to find which instruments are supported, and can be searched by the description. For example, searching for silver will return these results: + +``` +search -d silver +``` + +Search Futures + +To view an entire category, attach the `--category` flag to the function and select using the arrow keys. + +Futures Categories + +``` +search --category currency +``` + +Currency Futures + +Both `curve` and `historical` use the ticker symbol shown by the search function, for example, to see a chart of the current Eurodollar Futures term structure, simply enter: + +``` +`curve GE` +``` + +Eurodollar Futures Curve + +The raw data can be printed as a table or exported to a file, by attaching the optional arguments: `--raw`, or, `--export {filetype}`. For example, Global Emissions Offset Futures: + +``` +curve GEO --raw +``` + +Futures Raw Data + +The continuous chart is displayed with the `historical` command + the symbol. To see the optional arguments available for the command, deploy the `-h` flag. For example, the Eurodollar Futures contract for December 2024 expiry is displayed with: + +``` +historical GE -s 2015-01-01 -e 2024-12 +``` + +Historical Price of GEZ24.CME + +Multiple continuous charts can be plotted on the same chart by using a comma-separated list: + +``` +historical GE,ZQ -s 2007-01-01 +``` + +Historical Price of GE=F & ZQ=F diff --git a/website/versioned_docs/version-v3/terminal/usage/intros/mutualfunds.md b/website/content/terminal/menus/mutualfunds.md similarity index 89% rename from website/versioned_docs/version-v3/terminal/usage/intros/mutualfunds.md rename to website/content/terminal/menus/mutualfunds.md index 635d2a8c63c8..a129829df587 100644 --- a/website/versioned_docs/version-v3/terminal/usage/intros/mutualfunds.md +++ b/website/content/terminal/menus/mutualfunds.md @@ -1,17 +1,30 @@ --- title: Mutual Funds -keywords: [mutual funds, funds, morningstar, morning star, blackrock, vanguard, countries, global, search, holdings] -description: An introduction to the Mutual Funds menu - search and analyze the global mutual funds universe by country. +description: The documentation presents various commands and functions available within + the Mutual Funds menu, enabling users to analyze and get detailed insights about + different mutual funds. It covers features like searching funds, loading fund data, + analyzing sector weightings, and viewing current fund holdings, among others. +keywords: +- Mutual funds +- Fund analysis +- Investment +- Fund listings +- /funds commands +- Fund data +- Mutual fund information +- Fund sector weightings +- Mutual fund holdings +- Mutual fund carbon metrics --- + import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - + -## Overview The Mutual Funds menu provides a global view of the mutual funds universe. Enter the menu by typing, `/funds`. -## The Mutual Funds Menu +## Menu Commands in the Mutual Funds menu are grouped according to the workflow. diff --git a/website/content/terminal/menus/portfolio/_category_.json b/website/content/terminal/menus/portfolio/_category_.json new file mode 100644 index 000000000000..a905efd7a799 --- /dev/null +++ b/website/content/terminal/menus/portfolio/_category_.json @@ -0,0 +1,3 @@ +{ + "label": "Portfolio" +} diff --git a/website/content/terminal/menus/portfolio/introduction.md b/website/content/terminal/menus/portfolio/introduction.md new file mode 100644 index 000000000000..da384e385f85 --- /dev/null +++ b/website/content/terminal/menus/portfolio/introduction.md @@ -0,0 +1,278 @@ +--- +title: Introduction +sidebar_position: 1 +description: This docusaurus page is a thorough guide on how to optimize and track + your portfolio using innovative features. It covers how to load your transactions, + compare your portfolio to a benchmark, avail various statistical measures and apply + portfolio optimization techniques. +keywords: +- portfolio optimization +- benchmark comparison +- portfolio metrics +- transaction loading +- SEO improvement +- portfolio performance +- docusaurus guide +--- + +The Portfolio menu, and its sub-menus, are dedicated to properly explaining and optimizing your own portfolio. With features to load your own orderbook (transactions) it is possible to compare your results to that of a benchmark. For example, you are able to load both your portfolio and a benchmark (load and bench), then have the option to look into the performance compared to the benchmark asking the question "_What if I invested all my money in the benchmark instead?_" (perf) as well as see a wide variety of statistics and metrics (rsharpe, distr, var +and metric). Next to that, with these findings you can apply optimization techniques to your portfolio through the Portfolio Optimization menu. + +## How to use + +The Portfolio menu is called upon by typing `portfolio` which opens the following menu: + +image + +The first step in using this menu is loading a portfolio with load. Within this guide, we provide an example file when running `load --example` which will be used to explain the functionality through the guide. + +:::note If you wish to load in your own Excel holdings file, please follow the following steps: +1. Download the Excel file that can be used as a template [here](https://www.dropbox.com/s/03wjjf1lfkqjmtn/holdings_example.xlsx?dl=0). +2. Move the file inside the `portfolio/holdings` folder within the [OpenBBUserData](/terminal/usage/data/custom-data) folder and, optionally, adjust the name to your liking. +3. Open the Excel file and remove, edit or add to the values as you desire (e.g. your own orders). This is the default template that is also loaded in with `load --example`. +4. Open up the OpenBB Terminal, go to `portfolio` and type `load --file`. Your Excel file should then be one of the options. +::: + +Note that the Excel sheet requires the following columns: + +- **Date** - The date the trade occurred +- **Name** - The name of the security +- **Type** - The type of the security. Use Stock/Crypto/ETF as appropriate +- **Price** - The price the security was added or removed at, on a per-unit + basis +- **Quantity** - How much of the security in question was added or removed +- **Side** - Whether you bought or sold. Use Buy/Deposit/1 to add to the + portfolio or Sell/Withdrawal/0 to remove from the portfolio a search criteria, + country, sector or industry. + +The template Excel file also has additional columns but these are _optional_. The OpenBB Terminal can figure out by itself what industry, sector, country and region belongs to the loaded in Equity. So the field can be left blank if your holdings do not include this information. + +Continuing with the example, this results in the following: + +``` +(🦋) /portfolio/ $ load --example + +Loading an example, please type `about` to learn how to create your own Portfolio Excel sheet. + +Preprocessing transactions: 100%|██████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████| 14/14 [00:02<00:00, 4.88it/s] + Loading price data: 100%|████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████| 1/1 [00:00<00:00, 1.83it/s] + Calculating returns: 100%|████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████| 1/1 [00:00<00:00, 2.46it/s] + Loading benchmark: 100%|████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████| 4/4 [00:01<00:00, 2.35it/s] + +Portfolio: OpenBB Example Portfolio +Risk Free Rate: 0.00% +Benchmark: SPDR S&P 500 ETF Trust (SPY) +``` + +With the show command we can show how the data has been loaded in: + +``` +2022 Jul 19, 10:03 (🦋) /portfolio/ $ show + +┏━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━┳━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━┳━━━━━━━━┳━━━━━━━━━━┳━━━━━━┳━━━━━━━━━┳━━━━━━━━━━━━┳━━━━━━┳━━━━━━━━━━┓ +┃ Date ┃ Ticker ┃ Type ┃ Sector ┃ Industry ┃ Country ┃ Region ┃ Price ┃ Quantity ┃ Fees ┃ Premium ┃ Investment ┃ Side ┃ Currency ┃ +┡━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━╇━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━╇━━━━━━━━╇━━━━━━━━━━╇━━━━━━╇━━━━━━━━━╇━━━━━━━━━━━━╇━━━━━━╇━━━━━━━━━━┩ +│ 2010-05-03 00:00:00 │ GOOGL │ STOCK │ Communication Services │ Internet Content & Information │ United States │ North America │ 13.27 │ 2 │ 5 │ 6 │ 21.54 │ 1 │ USD │ +├─────────────────────┼────────┼───────┼────────────────────────┼─────────────────────────────────────┼───────────────┼───────────────┼────────┼──────────┼──────┼─────────┼────────────┼──────┼──────────┤ +│ 2010-07-06 00:00:00 │ AMZN │ STOCK │ Technology │ Internet Retail │ United States │ North America │ 5.50 │ 5 │ 3 │ 3 │ 24.50 │ 1 │ USD │ +├─────────────────────┼────────┼───────┼────────────────────────┼─────────────────────────────────────┼───────────────┼───────────────┼────────┼──────────┼──────┼─────────┼────────────┼──────┼──────────┤ +│ 2011-08-06 00:00:00 │ AAPL │ STOCK │ Technology │ Consumer Electronics │ United States │ North America │ 12.61 │ 3 │ 1 │ 0 │ 36.83 │ 1 │ USD │ +├─────────────────────┼────────┼───────┼────────────────────────┼─────────────────────────────────────┼───────────────┼───────────────┼────────┼──────────┼──────┼─────────┼────────────┼──────┼──────────┤ +│ 2011-12-12 00:00:00 │ APTV │ STOCK │ Consumer Cyclical │ Auto Parts │ United States │ North America │ 18.02 │ 5 │ 0 │ 2 │ 90.10 │ 1 │ USD │ +├─────────────────────┼────────┼───────┼────────────────────────┼─────────────────────────────────────┼───────────────┼───────────────┼────────┼──────────┼──────┼─────────┼────────────┼──────┼──────────┤ +│ 2012-02-03 00:00:00 │ ASML │ STOCK │ Technology │ Semiconductor Equipment & Materials │ Netherlands │ Europe │ 59.17 │ 7 │ 0 │ 4 │ 414.19 │ 1 │ USD │ +├─────────────────────┼────────┼───────┼────────────────────────┼─────────────────────────────────────┼───────────────┼───────────────┼────────┼──────────┼──────┼─────────┼────────────┼──────┼──────────┤ +│ 2012-05-04 00:00:00 │ NKE │ STOCK │ Consumer Cyclical │ Footwear & Accessories │ Germany │ Europe │ 27.95 │ 3 │ 0 │ 0 │ 83.85 │ 1 │ USD │ +├─────────────────────┼────────┼───────┼────────────────────────┼─────────────────────────────────────┼───────────────┼───────────────┼────────┼──────────┼──────┼─────────┼────────────┼──────┼──────────┤ +│ 2012-08-04 00:00:00 │ TSM │ STOCK │ Technology │ Semiconductors │ Taiwan │ Asia │ 14.24 │ 50 │ 0 │ 0 │ 712.00 │ 1 │ USD │ +├─────────────────────┼────────┼───────┼────────────────────────┼─────────────────────────────────────┼───────────────┼───────────────┼────────┼──────────┼──────┼─────────┼────────────┼──────┼──────────┤ +│ 2012-10-12 00:00:00 │ DGX │ STOCK │ Healthcare │ Diagnostics & Research │ United States │ North America │ 63.39 │ 6 │ 10 │ 0 │ 370.34 │ 1 │ USD │ +├─────────────────────┼────────┼───────┼────────────────────────┼─────────────────────────────────────┼───────────────┼───────────────┼────────┼──────────┼──────┼─────────┼────────────┼──────┼──────────┤ + +``` + +After loading in the portfolio, it is time to select a benchmark. By default, this is set to SPDR S&P 500 ETF Trust (SPY). It is important to choose a benchmark that closely matches your portfolio so that you can understand if the trades you have made actually were beneficial. For example, let's load in the with the bench command as follows: + +``` +(🦋) /portfolio/ $ bench --benchmark VTI + + Loading benchmark: 100%|████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████| 4/4 [00:01<00:00, 2.91it/s] + +(🦋) /portfolio/ $ ? + +╭─────────────────────────────────────────────────────────────────────────────────────── Portfolio ───────────────────────────────────────────────────────────────────────────────────────╮ +│ │ +│ │ +│ > bro brokers holdings, supports: robinhood, ally, degiro, coinbase │ +│ > po portfolio optimization, optimize your portfolio weights efficiently │ +│ │ +│ load load data into the portfolio │ +│ show show existing transactions │ +│ bench define the benchmark │ +│ │ +│ Loaded transactions file: OpenBB Example Portfolio │ +│ Risk Free Rate: 0.00% │ +│ Benchmark: Vanguard Total Stock Market ETF (VTI) + +``` + +Note that the `bench` command has a large selection of products you can choose from. Instead of taking the index directly, an ETF product is used to represent something that you could have actually invested in. By using the `DOWN` (⌄) arrow and pressing `ENTER` (⏎) you can select a different benchmark. + +With `perf`, we can see how the portfolio performed compared to if you invested the same amount of money into the benchmark instead. This reflects the capabilities of you, as an investor, to outperform a passive strategy. + +``` +(🦋) /portfolio/ $ perf + + Portfolio vs. Benchmark - Totals in period: all +┏━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━┳━━━━━━━━━━━┳━━━━━━━━━━━━┓ +┃ ┃ Portfolio ┃ Benchmark ┃ Difference ┃ +┡━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━╇━━━━━━━━━━━╇━━━━━━━━━━━━┩ +│ Total Investment │ 47665.95 │ 47665.95 │ - │ +├──────────────────┼───────────┼───────────┼────────────┤ +│ Total Value │ 59961.16 │ 60038.37 │ -77.21 │ +├──────────────────┼───────────┼───────────┼────────────┤ +│ Total % Return │ 25.79% │ 25.96% │ -0.16% │ +├──────────────────┼───────────┼───────────┼────────────┤ +│ Total Abs Return │ 12295.21 │ 12372.42 │ -77.21 │ +└──────────────────┴───────────┴───────────┴────────────┘ +``` + +Compliment this by showing the volatility of the portfolio for different time periods with `metric` as follows: + +``` +(🦋) /portfolio/ $ metric volatility + +Volatility for Portfolio and Benchmark +┏━━━━━┳━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━┓ +┃ ┃ Portfolio [%] ┃ Benchmark [%] ┃ +┡━━━━━╇━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━┩ +│ mtd │ 8.185 │ 4.210 │ +├─────┼───────────────┼───────────────┤ +│ qtd │ 8.185 │ 4.210 │ +├─────┼───────────────┼───────────────┤ +│ ytd │ 31.497 │ 18.220 │ +├─────┼───────────────┼───────────────┤ +│ 3m │ 22.340 │ 14.436 │ +├─────┼───────────────┼───────────────┤ +│ 6m │ 30.879 │ 17.912 │ +├─────┼───────────────┼───────────────┤ +│ 1y │ 35.816 │ 20.128 │ +├─────┼───────────────┼───────────────┤ +│ 3y │ 54.981 │ 41.174 │ +├─────┼───────────────┼───────────────┤ +│ 5y │ 64.408 │ 45.647 │ +├─────┼───────────────┼───────────────┤ +│ 10y │ 78.014 │ 53.200 │ +├─────┼───────────────┼───────────────┤ +│ all │ 93.956 │ 60.885 │ +└─────┴───────────────┴───────────────┘ +``` + +## Examples + +Starting off by loading in the OpenBB Example Portfolio again and changing the benchmark, the Vanguard Total Stock Market ETF (VTI). + +``` +(🦋) /portfolio/ $ load --example + +Loading an example, please type `about` to learn how to create your own Portfolio Excel sheet. + +Preprocessing transactions: 100%|██████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████| 14/14 [00:02<00:00, 4.88it/s] + Loading price data: 100%|████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████| 1/1 [00:00<00:00, 1.83it/s] + Calculating returns: 100%|████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████| 1/1 [00:00<00:00, 2.46it/s] + Loading benchmark: 100%|████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████| 4/4 [00:01<00:00, 2.35it/s] + +Portfolio: OpenBB Example Portfolio +Risk Free Rate: 0.00% +Benchmark: SPDR S&P 500 ETF Trust (SPY) + +(🦋) /portfolio/ $ bench VTI + + Loading benchmark: 100%|████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████| 4/4 [00:01<00:00, 3.32it/s] +``` + +Then, we can show our performance compared to that of the benchmark with `perf` as well as show the rolling beta with `rbeta`. + +``` +(🦋) /portfolio/ $ perf + + Portfolio vs. Benchmark - Totals in period: all +┏━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━┳━━━━━━━━━━━┳━━━━━━━━━━━━┓ +┃ ┃ Portfolio ┃ Benchmark ┃ Difference ┃ +┡━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━╇━━━━━━━━━━━╇━━━━━━━━━━━━┩ +│ Total Investment │ 47665.95 │ 47665.95 │ - │ +├──────────────────┼───────────┼───────────┼────────────┤ +│ Total Value │ 60815.22 │ 58901.42 │ 1913.79 │ +├──────────────────┼───────────┼───────────┼────────────┤ +│ Total % Return │ 27.59% │ 23.57% │ 4.02% │ +├──────────────────┼───────────┼───────────┼────────────┤ +│ Total Abs Return │ 13149.27 │ 11235.47 │ 1913.79 │ +└──────────────────┴───────────┴───────────┴────────────┘ + +(🦋) /portfolio/ $ rbeta +``` + +![Rolling Beta of the Portfolio](https://user-images.githubusercontent.com/46355364/180178392-96efb6e1-60a1-4f76-92d8-434fb3637c21.png) + +This helps in understanding that, even though you achieved a superior return, this also came at a greater risk compared to that of the benchmark. With the available functionalities you can further look into these results, e.g. by looking at the `summary` statistics: + +``` +🦋) /portfolio/ $ summary + +Summary of Portfolio vs Benchmark for all period +┏━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━┳━━━━━━━━━━━┓ +┃ ┃ Portfolio ┃ Benchmark ┃ +┡━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━╇━━━━━━━━━━━┩ +│ Volatility │ 0.02 │ 0.01 │ +├───────────────────┼───────────┼───────────┤ +│ Skew │ -1.65 │ -0.58 │ +├───────────────────┼───────────┼───────────┤ +│ Kurtosis │ 32.89 │ 12.12 │ +├───────────────────┼───────────┼───────────┤ +│ Maximum Drawdowwn │ -0.42 │ -0.35 │ +├───────────────────┼───────────┼───────────┤ +│ Sharpe ratio │ 0.04 │ 0.05 │ +├───────────────────┼───────────┼───────────┤ +│ Sortino ratio │ 0.05 │ 0.06 │ +├───────────────────┼───────────┼───────────┤ +│ R2 Score │ 0.50 │ 0.50 │ +└───────────────────┴───────────┴───────────┘ +``` + +As well as look into how the allocations differ per sector and country with `alloc`. This shows that there is a clear difference in how the benchmark and the portfolio are constructed implying the Total Market ETF might not be the best benchmark for your portfolio. + +``` +(🦋) /portfolio/ $ alloc sectors + + + Portfolio vs. Benchmark - Top 4 Sectors Allocation +┏━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━┳━━━━━━━━━━━┳━━━━━━━━━━━━┓ +┃ Sectors ┃ Portfolio ┃ Benchmark ┃ Difference ┃ +┡━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━╇━━━━━━━━━━━╇━━━━━━━━━━━━┩ +│ Technology │ 58.26% │ 23.37% │ 34.89% │ +├────────────────────────┼───────────┼───────────┼────────────┤ +│ Consumer Cyclical │ 30.26% │ 10.30% │ 19.96% │ +├────────────────────────┼───────────┼───────────┼────────────┤ +│ Healthcare │ 9.98% │ 14.85% │ -4.87% │ +├────────────────────────┼───────────┼───────────┼────────────┤ +│ Communication Services │ 1.50% │ 7.98% │ -6.48% │ +└────────────────────────┴───────────┴───────────┴────────────┘ + +(🦋) /portfolio/ $ alloc countries + + + Portfolio vs. Benchmark - Top 5 Countries Allocation +┏━━━━━━━━━━━━━━━┳━━━━━━━━━━━┳━━━━━━━━━━━┳━━━━━━━━━━━━┓ +┃ Countries ┃ Portfolio ┃ Benchmark ┃ Difference ┃ +┡━━━━━━━━━━━━━━━╇━━━━━━━━━━━╇━━━━━━━━━━━╇━━━━━━━━━━━━┩ +│ Netherlands │ 38.06% │ - │ 38.06% │ +├───────────────┼───────────┼───────────┼────────────┤ +│ United States │ 29.69% │ 99.10% │ -69.41% │ +├───────────────┼───────────┼───────────┼────────────┤ +│ Taiwan │ 14.66% │ 0.01% │ 14.65% │ +├───────────────┼───────────┼───────────┼────────────┤ +│ China │ 11.11% │ - │ 11.11% │ +├───────────────┼───────────┼───────────┼────────────┤ +│ Ireland │ 6.47% │ - │ 6.47% │ +└───────────────┴───────────┴───────────┴────────────┘ +``` diff --git a/website/content/terminal/menus/portfolio/po.md b/website/content/terminal/menus/portfolio/po.md new file mode 100644 index 000000000000..766fbb792a45 --- /dev/null +++ b/website/content/terminal/menus/portfolio/po.md @@ -0,0 +1,468 @@ +--- +title: Portfolio Optimization +description: This documentation pages describes the portfolio optimization menu which allows the user to apply advanced optimization techniques to a portfolio of any type and of any size. +keywords: +- portfolio +- portfolio optimization +- returns +- drawdown +- optimization +- sharpe ratio +- risk +- diversification +- correlation +- risk parity +- hierarchical +- weighted +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +The Portfolio Optimization menu allows the user to apply advanced optimization techniques to a portfolio of any type and of any size. It does so by introducing a multitude of optimization techniques ranging from mean-variance optimization to risk parity models and hierarchical clustering models. By providing Excel templates, the user can make sense of the vast array of parameters that each command has. E.g. think of the historic period you wish to use or which of the more than 10 risk measures and covariance methods should be used? These are questions the templates make easier to answer. + +### How to use + +The portfolio optimization menu can be reached by visiting the `portfolio` menu and typing `po` (or alternatively, typing `/portfolio/po` from any location). This opens the following menu: + +image + +The first step in using this menu is loading a portfolio with load. Within this guide, we provide an example file when running `load --example` which will be used to explain the functionality through the guide. + +:::note If you wish to load in your own Excel allocation file, please follow the following steps: +1. Download the Excel file that can be used as a template [here](https://www.dropbox.com/s/wp1lcq86exyngjy/allocation_example.xlsx?dl=0). +2. Move the file inside the `portfolio/allocation` folder within the [OpenBBUserData](/terminal/usage/data/custom-data) folder and, optionally, adjust the name to your liking. +3. Open the Excel file and remove, edit or add to the values as you desire (e.g. your own allocation). This is the default template that is also loaded in with `load --example`. +4. Open up the OpenBB Terminal, go to `portfolio/po` and type `load --file`. Your Excel file should then be one of the options. +::: + +Furthermore, given the amount of options you can choose from in each command and giving the complexity of the topic, we also provide a parameter file (both .xlsx and .ini to adjust parameters in a user-friendly way). + +:::note If you wish to load in your own Excel or ini parameter file, please follow the following steps: +1. Download the file that can be used as a template: [xlsx](https://www.dropbox.com/s/qfhd7ntj7mlwsuc/parameters_template.xlsx?dl=0) (recommended) or [ini](https://www.dropbox.com/s/3ehwg3hiwm89hgo/parameters_template.ini?dl=0) (advanced). +2. Move the file inside the `portfolio/optimization` folder within the [OpenBBUserData](/terminal/usage/data/custom-data) folder and, optionally, adjust the name to your liking. +3. Open the file and set parameters as you wish. +4. Open up the OpenBB Terminal, go to `portfolio/po` and type `file --file`. The file should then be one of the options. +::: + +Find more information about these two templates below. + +#### OpenBB Portfolio Template + +This template hands the user a format to work with it to define the portfolio. Here, categorization is applied based on asset class, sector, industry, country and currency. By using the dropdown menus within this Excel, you are able to apply the proper categorization. This is based on the same methodology as found in other areas of the terminal. + + + +You can load in the portfolio template by using the load command or use `load --example` to obtain an example allocation: + +``` +(🦋) /portfolio/po/ $ load --file allocation_example.xlsx +(🦋) /portfolio/po/ $ show + +Current Portfolios: None + +Current Categories: ASSET_CLASS, SECTOR, INDUSTRY, COUNTRY, CURRENT_INVESTED_AMOUNT, CURRENCY +``` + +#### OpenBB Parameters Template + +This template provides the user with the ability to set define values for each parameter based on the optimization technique that is deployed. E.g. if you select `riskparity` for the `technique` parameter, you will notice that some parameters turn grey. This means that the parameter is irrelevant for the selected method. + +The OpenBB Terminal does, however, allow the user to run any model despite the `technique` you selected. Therefore, if you are interested in running multiple models, consider removing the value for `technique`. Do note that this makes it more difficult to understand which values are used for which model. + + + +Once you have defined the parameters, save the template and load it inside the terminal by using the file command. If done correctly, the parameters file should show automatically after typing `file` and pressing SPACE. Then, by using the DOWN KEY (⌄) you can select the file by pressing ENTER (⏎) which will then be loaded into the terminal: + +``` +(🦋) /portfolio/po/ $ file parameters_template.xlsx +Parameters: + historic_period : 3y + log_returns : 0 + return_frequency : d + max_nan : 0.05 + threshold_value : 0.3 + nan_fill_method : time + risk_free : 0.003 + significance_level : 0.05 + risk_measure : MV + target_return : -1 + target_risk : -1 + expected_return : hist + covariance : hist + smoothing_factor_ewma : 0.94 + long_allocation : 1 + short_allocation : 0 +``` + +#### Performing optimization + +Based on the parameters and allocation the user has set, the optimization process begins. What optimization technique is ideal depends entirely on the user's risk profile and objectives. As an illustration, Risk Parity is presented below via the riskparity command. + +First of all, we load in the example portfolio as follows: + +``` +(🦋) /portfolio/po/ $ load --example + +Loading an example, please type `about` to learn how to create your own Portfolio Optimization Excel sheet. + + +(🦋) /portfolio/po/ $ ? + +╭────────────────────────────────────────────────────────────────────────── Portfolio - Portfolio Optimization ───────────────────────────────────────────────────────────────────────────╮ +│ │ +│ load load tickers and categories from .xlsx or .csv file │ +│ │ +│ Portfolio loaded: OpenBB Example Portfolio │ +│ │ +│ Tickers: AAPL, AMZN, APTV, ASML, BABA, GOOGL, HYG, IYR, NKE, PEX, PSP, REZ, TIP, TLT, TSM │ +│ Categories: ASSET_CLASS, SECTOR, INDUSTRY, COUNTRY, CURRENCY | + +``` + +``` +(🦋) /portfolio/po/ $ riskparity + +Optimization can take time. Please be patient... + +[3 Years] Risk parity portfolio based on risk budgeting approach +using volatility as risk measure + + Weights +┏━━━━━━━┳━━━━━━━━━━┓ +┃ ┃ Value ┃ +┡━━━━━━━╇━━━━━━━━━━┩ +│ AAPL │ 3.68 % │ +├───────┼──────────┤ +│ AMZN │ 3.75 % │ +├───────┼──────────┤ +│ APTV │ 2.46 % │ +├───────┼──────────┤ +│ ASML │ 2.67 % │ +├───────┼──────────┤ +│ BABA │ 3.62 % │ +├───────┼──────────┤ +│ GOOGL │ 3.82 % │ +├───────┼──────────┤ +│ HYG │ 9.53 % │ +├───────┼──────────┤ +│ IYR │ 4.38 % │ +├───────┼──────────┤ +│ NKE │ 3.72 % │ +├───────┼──────────┤ +│ PEX │ 4.27 % │ +├───────┼──────────┤ +│ PSP │ 3.68 % │ +├───────┼──────────┤ +│ REZ │ 4.60 % │ +├───────┼──────────┤ +│ TIP │ 25.52 % │ +├───────┼──────────┤ +│ TLT │ 20.60 % │ +├───────┼──────────┤ +│ TSM │ 3.72 % │ +└───────┴──────────┘ + +Annual (by 252) expected return: 4.35% +Annual (by √252) volatility: 14.59% +Sharpe ratio: 0.0317 +``` + +To understand how this portfolio differs from the original portfolio, the show command can be used. This also shows the allocations to each asset class, sector, industry and currency. Using the optimized portfolio, this generates the following results: + +``` +(🦋) /portfolio/po/ $ show RP_0 + +Portfolio - RP_0 + + Category - Asset_Class +┏━━━━━┳━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━┳━━━━━━━━━━┓ +┃ ┃ Asset_Class ┃ Current_Invested_Amount ┃ Current_Weights ┃ Value ┃ +┡━━━━━╇━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━╇━━━━━━━━━━┩ +│ USD │ FIXED INCOME │ 2,550,000 $ │ 30.03 % │ 55.65 % │ +├─────┼────────────────┼─────────────────────────┼─────────────────┼──────────┤ +│ USD │ PRIVATE EQUITY │ 850,000 $ │ 10.01 % │ 7.95 % │ +├─────┼────────────────┼─────────────────────────┼─────────────────┼──────────┤ +│ USD │ PUBLIC EQUITY │ 4,242,000 $ │ 49.95 % │ 27.42 % │ +├─────┼────────────────┼─────────────────────────┼─────────────────┼──────────┤ +│ USD │ REAL ESTATE │ 850,000 $ │ 10.01 % │ 8.98 % │ +├─────┼────────────────┼─────────────────────────┼─────────────────┼──────────┤ +│ USD │ TOTAL USD │ 8,492,000 $ │ 100.00 % │ 100.00 % │ +└─────┴────────────────┴─────────────────────────┴─────────────────┴──────────┘ + + Category - Sector +┏━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━┳━━━━━━━━━━┓ +┃ ┃ Sector ┃ Current_Invested_Amount ┃ Current_Weights ┃ Value ┃ +┡━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━╇━━━━━━━━━━┩ +│ USD │ COMMUNICATION SERVICES │ 636,000 $ │ 7.49 % │ 3.82 % │ +├─────┼────────────────────────┼─────────────────────────┼─────────────────┼──────────┤ +│ USD │ CONSUMER CYCLICAL │ 751,000 $ │ 8.84 % │ 7.34 % │ +├─────┼────────────────────────┼─────────────────────────┼─────────────────┼──────────┤ +│ USD │ CONSUMER DISCRETIONARY │ 1,175,000 $ │ 13.84 % │ 6.21 % │ +├─────┼────────────────────────┼─────────────────────────┼─────────────────┼──────────┤ +│ USD │ CORPORATE BOND │ 810,000 $ │ 9.54 % │ 9.53 % │ +├─────┼────────────────────────┼─────────────────────────┼─────────────────┼──────────┤ +│ USD │ FINANCIALS │ 850,000 $ │ 10.01 % │ 7.95 % │ +├─────┼────────────────────────┼─────────────────────────┼─────────────────┼──────────┤ +│ USD │ GOVERNMENT BOND │ 1,740,000 $ │ 20.49 % │ 46.12 % │ +├─────┼────────────────────────┼─────────────────────────┼─────────────────┼──────────┤ +│ USD │ INFORMATION TECHNOLOGY │ 1,680,000 $ │ 19.78 % │ 10.06 % │ +├─────┼────────────────────────┼─────────────────────────┼─────────────────┼──────────┤ +│ USD │ REAL ESTATE │ 850,000 $ │ 10.01 % │ 8.98 % │ +├─────┼────────────────────────┼─────────────────────────┼─────────────────┼──────────┤ +│ USD │ TOTAL USD │ 8,492,000 $ │ 100.00 % │ 100.00 % │ +└─────┴────────────────────────┴─────────────────────────┴─────────────────┴──────────┘ + + Category - Industry +┏━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━┳━━━━━━━━━━┓ +┃ ┃ Industry ┃ Current_Invested_Amount ┃ Current_Weights ┃ Value ┃ +┡━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━╇━━━━━━━━━━┩ +│ USD │ AUTO PARTS & EQUIPMENT │ 429,000 $ │ 5.05 % │ 2.46 % │ +├─────┼────────────────────────────────────────────┼─────────────────────────┼─────────────────┼──────────┤ +│ USD │ FINANCIAL SERVICES │ 850,000 $ │ 10.01 % │ 7.95 % │ +├─────┼────────────────────────────────────────────┼─────────────────────────┼─────────────────┼──────────┤ +│ USD │ FOOTWEAR & ACCESSORIES │ 505,000 $ │ 5.95 % │ 3.72 % │ +├─────┼────────────────────────────────────────────┼─────────────────────────┼─────────────────┼──────────┤ +│ USD │ HIGH YIELD BOND │ 810,000 $ │ 9.54 % │ 9.53 % │ +├─────┼────────────────────────────────────────────┼─────────────────────────┼─────────────────┼──────────┤ +│ USD │ INFLATION-PROTECTED BOND │ 890,000 $ │ 10.48 % │ 25.52 % │ +├─────┼────────────────────────────────────────────┼─────────────────────────┼─────────────────┼──────────┤ +│ USD │ INTERACTIVE MEDIA & SERVICES │ 636,000 $ │ 7.49 % │ 3.82 % │ +├─────┼────────────────────────────────────────────┼─────────────────────────┼─────────────────┼──────────┤ +│ USD │ INTERNET & DIRECT MARKETING RETAIL │ 992,000 $ │ 11.68 % │ 7.37 % │ +├─────┼────────────────────────────────────────────┼─────────────────────────┼─────────────────┼──────────┤ +│ USD │ LONG GOVERNMENT │ 850,000 $ │ 10.01 % │ 20.60 % │ +├─────┼────────────────────────────────────────────┼─────────────────────────┼─────────────────┼──────────┤ +│ USD │ RESIDENTIAL │ 280,000 $ │ 3.30 % │ 4.60 % │ +├─────┼────────────────────────────────────────────┼─────────────────────────┼─────────────────┼──────────┤ +│ USD │ SEMICONDUCTORS │ 1,300,000 $ │ 15.31 % │ 6.39 % │ +├─────┼────────────────────────────────────────────┼─────────────────────────┼─────────────────┼──────────┤ +│ USD │ TECHNOLOGY HARDWARE, STORAGE & PERIPHERALS │ 380,000 $ │ 4.47 % │ 3.68 % │ +├─────┼────────────────────────────────────────────┼─────────────────────────┼─────────────────┼──────────┤ +│ USD │ TOTAL MARKET │ 570,000 $ │ 6.71 % │ 4.38 % │ +├─────┼────────────────────────────────────────────┼─────────────────────────┼─────────────────┼──────────┤ +│ USD │ TOTAL USD │ 8,492,000 $ │ 100.00 % │ 100.00 % │ +└─────┴────────────────────────────────────────────┴─────────────────────────┴─────────────────┴──────────┘ + + Category - Country +┏━━━━━┳━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━┳━━━━━━━━━━┓ +┃ ┃ Country ┃ Current_Invested_Amount ┃ Current_Weights ┃ Value ┃ +┡━━━━━╇━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━╇━━━━━━━━━━┩ +│ USD │ ASIA │ 626,000 $ │ 7.37 % │ 7.34 % │ +├─────┼───────────────┼─────────────────────────┼─────────────────┼──────────┤ +│ USD │ EUROPE │ 1,425,000 $ │ 16.78 % │ 6.39 % │ +├─────┼───────────────┼─────────────────────────┼─────────────────┼──────────┤ +│ USD │ UNITED STATES │ 6,441,000 $ │ 75.85 % │ 86.28 % │ +├─────┼───────────────┼─────────────────────────┼─────────────────┼──────────┤ +│ USD │ TOTAL USD │ 8,492,000 $ │ 100.00 % │ 100.00 % │ +└─────┴───────────────┴─────────────────────────┴─────────────────┴──────────┘ +``` + +It is possible to use the commands without loading in the parameters template or by using the parameters template but changing some arguments directly into the terminal. For example, using the same method as described above, the risk measure is changed to Conditional Value at Risk (CVaR) and the used historic period is increased to 5 years (keeping all other parameters unchanged): + +``` +(🦋) /portfolio/po/ $ riskparity -rm CVaR -p 5y + +Optimization can take time. Please be patient... + +[5 Years] Risk parity portfolio based on risk budgeting approach +using conditional value at risk (CVaR) as risk measure + + Weights +┏━━━━━━━┳━━━━━━━━━━┓ +┃ ┃ Value ┃ +┡━━━━━━━╇━━━━━━━━━━┩ +│ AAPL │ 3.73 % │ +├───────┼──────────┤ +│ AMZN │ 3.27 % │ +├───────┼──────────┤ +│ APTV │ 2.68 % │ +├───────┼──────────┤ +│ ASML │ 2.75 % │ +├───────┼──────────┤ +│ BABA │ 4.10 % │ +├───────┼──────────┤ +│ GOOGL │ 3.59 % │ +├───────┼──────────┤ +│ HYG │ 9.43 % │ +├───────┼──────────┤ +│ IYR │ 4.36 % │ +├───────┼──────────┤ +│ NKE │ 3.42 % │ +├───────┼──────────┤ +│ PEX │ 4.16 % │ +├───────┼──────────┤ +│ PSP │ 3.60 % │ +├───────┼──────────┤ +│ REZ │ 4.58 % │ +├───────┼──────────┤ +│ TIP │ 26.33 % │ +├───────┼──────────┤ +│ TLT │ 20.29 % │ +├───────┼──────────┤ +│ TSM │ 3.70 % │ +└───────┴──────────┘ + +Annual (by 252) expected return: 6.99% +Annual (by √252) volatility: 12.21% +Sharpe ratio: 0.2538 +Annual (by √252) conditional value at risk (CVaR) : 28.63% +Return / conditional value at risk (CVaR) ratio: 0.1083 +``` + +## Examples + +The example portfolio is again loaded in: + +``` +(🦋) /portfolio/po/ $ load --example + +Loading an example, please type `about` to learn how to create your own Portfolio Optimization Excel sheet. + + +(🦋) /portfolio/po/ $ ? + +╭────────────────────────────────────────────────────────────────────────── Portfolio - Portfolio Optimization ───────────────────────────────────────────────────────────────────────────╮ +│ │ +│ load load tickers and categories from .xlsx or .csv file │ +│ │ +│ Portfolio loaded: OpenBB Example Portfolio │ +│ │ +│ Tickers: AAPL, AMZN, APTV, ASML, BABA, GOOGL, HYG, IYR, NKE, PEX, PSP, REZ, TIP, TLT, TSM │ +│ Categories: ASSET_CLASS, SECTOR, INDUSTRY, COUNTRY, CURRENCY | + +``` + +It is possible to load the parameters template here but this is not necessary as each parameter has a default value set regardless. However, because the Excel file provides a more structured way of presenting the choices, the template is loaded in: + +``` +(🦋) /portfolio/po/ $ file --file parameters_template.xlsx +Parameters: + historic_period : 3y + log_returns : 0 + return_frequency : d + max_nan : 0.05 + threshold_value : 0.3 + nan_fill_method : time + risk_free : 0.003 + significance_level : 0.05 + risk_measure : MV + target_return : -1 + target_risk : -1 + expected_return : hist + covariance : hist + smoothing_factor_ewma : 0.94 + long_allocation : 1 + short_allocation : 0 +``` + +Then, the Hierarchical Risk Parity technique is applied by running the hrp command. This results in the following: + +``` +(🦋) /portfolio/po/ $ hrp + +Optimization can take time. Please be patient... + +[3 Years] Hierarchical risk parity portfolio using pearson codependence, +single linkage and volatility as risk measure + + Weights +┏━━━━━━━┳━━━━━━━━━━┓ +┃ ┃ Value ┃ +┡━━━━━━━╇━━━━━━━━━━┩ +│ AAPL │ 1.47 % │ +├───────┼──────────┤ +│ AMZN │ 2.54 % │ +├───────┼──────────┤ +│ APTV │ 0.44 % │ +├───────┼──────────┤ +│ ASML │ 0.93 % │ +├───────┼──────────┤ +│ BABA │ 0.64 % │ +├───────┼──────────┤ +│ GOOGL │ 1.68 % │ +├───────┼──────────┤ +│ HYG │ 10.46 % │ +├───────┼──────────┤ +│ IYR │ 1.28 % │ +├───────┼──────────┤ +│ NKE │ 1.33 % │ +├───────┼──────────┤ +│ PEX │ 1.31 % │ +├───────┼──────────┤ +│ PSP │ 1.75 % │ +├───────┼──────────┤ +│ REZ │ 1.39 % │ +├───────┼──────────┤ +│ TIP │ 62.12 % │ +├───────┼──────────┤ +│ TLT │ 11.40 % │ +├───────┼──────────┤ +│ TSM │ 1.26 % │ +└───────┴──────────┘ + +Annual (by 252) expected return: 2.48% +Annual (by √252) volatility: 9.13% +Sharpe ratio: -0.1546 +``` + +This optimization process is then compared with the current holdings. To keep things manageable, only the sector allocations are compared between the unoptimized and optimized portfolio which is done with the show command: + +``` +(🦋) /portfolio/po/ $ show _HRP0 -ct SECTOR + +Current Portfolios: _HRP0 + +Current Categories: INDUSTRY, CURRENT_INVESTED_AMOUNT, ASSET_CLASS, COUNTRY, CURRENCY, SECTOR + +Portfolio: _HRP0 + + Category - Sector +┏━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━┳━━━━━━━━━━┓ +┃ ┃ Sector ┃ Current_Invested_Amount ┃ Current_Weights ┃ Value ┃ +┡━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━╇━━━━━━━━━━┩ +│ USD │ COMMUNICATION SERVICES │ 636,000 $ │ 7.49 % │ 1.68 % │ +├─────┼────────────────────────┼─────────────────────────┼─────────────────┼──────────┤ +│ USD │ CONSUMER CYCLICAL │ 751,000 $ │ 8.84 % │ 1.97 % │ +├─────┼────────────────────────┼─────────────────────────┼─────────────────┼──────────┤ +│ USD │ CONSUMER DISCRETIONARY │ 1,175,000 $ │ 13.84 % │ 2.98 % │ +├─────┼────────────────────────┼─────────────────────────┼─────────────────┼──────────┤ +│ USD │ CORPORATE BOND │ 810,000 $ │ 9.54 % │ 10.46 % │ +├─────┼────────────────────────┼─────────────────────────┼─────────────────┼──────────┤ +│ USD │ FINANCIALS │ 850,000 $ │ 10.01 % │ 3.06 % │ +├─────┼────────────────────────┼─────────────────────────┼─────────────────┼──────────┤ +│ USD │ GOVERNMENT BOND │ 1,740,000 $ │ 20.49 % │ 73.52 % │ +├─────┼────────────────────────┼─────────────────────────┼─────────────────┼──────────┤ +│ USD │ INFORMATION TECHNOLOGY │ 1,680,000 $ │ 19.78 % │ 3.66 % │ +├─────┼────────────────────────┼─────────────────────────┼─────────────────┼──────────┤ +│ USD │ REAL ESTATE │ 850,000 $ │ 10.01 % │ 2.67 % │ +├─────┼────────────────────────┼─────────────────────────┼─────────────────┼──────────┤ +│ USD │ TOTAL USD │ 8,492,000 $ │ 100.00 % │ 100.00 % │ +└─────┴────────────────────────┴─────────────────────────┴─────────────────┴──────────┘ +``` + +This table shows how the portfolio changed and how much is allocated to each sector. It is possible to delve further into these findings with the plot command. This gives the ability to visually depict allocations, e.g. below the sector allocation is visually depicted. + +``` +(🦋) /portfolio/po/ $ plot --portfolios _HRP0 -ct SECTOR -pi +``` + +![Sectors Pie Chart](https://user-images.githubusercontent.com/46355364/213746043-58cd5d69-6e62-4ebd-b12c-724be62458ac.png) + +Further analysis can be done by looking at the portfolio's returns histogram which also includes a variety of risk measures as well as the portfolio's drawdowns. + +```` +(🦋) /portfolio/po/ $ plot --portfolios _HRP0 -ct SECTOR -hi -dd +```` + +![Portfolio Returns Histogram](https://user-images.githubusercontent.com/46355364/213745938-f6f97e06-287c-4c0d-a4f1-bc23828b346e.png) +![Portfolio Drawdowns](https://user-images.githubusercontent.com/46355364/213746000-5f7f6bc0-9f5c-4be3-a217-12551c79bcee.png) + +Next to that, to delve deeper in the underlying conclusions the HRP method has drawn. Here, a closer look can be given to the assets cluster map, which links certain categories to each other. The linkage process is done per asset basis but here it is grouped per sector. Based on these results, the user can identify whether the optimization techniques also logically makes sense. + +```` +(🦋) /portfolio/po/ $ plot --portfolios _HRP0 -ct SECTOR -rc -he +```` +![Heatmap with Linkage Method](https://user-images.githubusercontent.com/46355364/213745877-8d0ab932-7775-4c9b-be60-da614c338b8d.png) +![Risk Contributions](https://user-images.githubusercontent.com/46355364/213745808-d4dede01-a16c-4b3f-83a7-f8b2096896e3.png) diff --git a/website/content/terminal/menus/stocks/_category_.json b/website/content/terminal/menus/stocks/_category_.json new file mode 100644 index 000000000000..79c165ed2dfb --- /dev/null +++ b/website/content/terminal/menus/stocks/_category_.json @@ -0,0 +1,3 @@ +{ + "label": "Stocks" +} diff --git a/website/content/terminal/menus/stocks/ba.md b/website/content/terminal/menus/stocks/ba.md new file mode 100644 index 000000000000..aca944d5d89e --- /dev/null +++ b/website/content/terminal/menus/stocks/ba.md @@ -0,0 +1,148 @@ +--- +title: Behavioural Analysis +description: The page introduces the Behavioural Analysis sub-menu, within the Stocks menu, of the OpenBB Terminal. +keywords: +- Behavioural Analysis +- public sentiment +- momentum trading strategies +- stocks +- companies +- reddit +- twitter +- stocktwits +- x +- google +- API key +- /r/wallstreetbets +- social sentiment +- deep learning algorithms +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +The Behavioural Analysis menu offers the user tools for gauging the overall public sentiment of a company online. The complexity of the tools range from message board scrapers to deep learning algorithms for financial analysis and prediction. Sentiment is particularly useful for momentum trading strategies, discovery, and general fundamental research. + +## Usage + +Navigate into the menu from the Stocks menu by entering, `ba`. Or, by using the absolute path from anywhere in the Terminal: + +```console +/stocks/ba +``` + +![Screenshot 2023-10-31 at 1 50 04 PM](https://github.com/OpenBB-finance/OpenBBTerminal/assets/85772166/5946bc28-95a8-4402-a546-68be140aa025) + +### Trending + +The `trending` command gets the list of trending tickers, according to Stocktwits. + +```console +/stocks/ba/trending +``` + +| Ticker | Watchlist Count | Name | +|:---------|------------------:|:------------------------------------------------| +| AMD | 468973 | Advanced Micro Devices Inc. | +| NVDA | 447556 | NVIDIA Corp | +| XRP.X | 158654 | Ripple | +| CHK | 61074 | Chesapeake Energy Corp. - Ordinary Shares - New | +| PINS | 44549 | PINTEREST INC | +| CRSP | 34881 | CRISPR Therapeutics AG | +| CAT | 29787 | Caterpillar Inc. | +| FSLR | 28779 | First Solar Inc | +| CVS | 26361 | CVS Health Corp | +| SAVE | 24589 | Spirit Airlines Inc | +| SRPT | 18634 | Sarepta Therapeutics Inc | +| Z | 18152 | Zillow Group Inc | +| BUD | 13161 | Anheuser-Busch InBev | +| MTCH | 12638 | Match Group Inc. | +| UEC | 12473 | Uranium Energy Corp | +| CZR | 10943 | Caesars Entertainment Inc | +| CCJ | 10108 | Cameco Corp. | +| ANET | 9235 | Arista Networks Inc | +| CELH | 9012 | Celsius Holdings Inc | +| LTHM | 8206 | Livent Corp | +| MPC | 7307 | Marathon Petroleum Corp | +| PAYC | 5425 | Paycom Software Inc | +| ZI | 5061 | ZoomInfo Technologies Inc. | +| SPRC | 3789 | SCISPARC LTD | +| ELF | 3658 | e.l.f. Beauty Inc | +| XDC.X | 3073 | XinFin Network | +| KRL.X | 2385 | Kryll | +| FRSH | 1935 | Freshworks Inc | +| MTZ | 1544 | Mastec Inc. | +| VERV | 1054 | Verve Therapeutics Inc | + +### Bullbear + +`bullbear` gives a fast sentiment synopsis from the most recent Stocktwits posts. + +```console +/stocks/ba/load crsp/bullbear +``` + +```console +Watchlist count: 34881 + +Last 15 sentiment messages: +Bullish: 80.0% +Bearish: 20.0% +``` + +```console +/stocks/ba/load amd/bullbear +``` + +```console +Watchlist count: 468973 + +Last 12 sentiment messages: +Bullish: 50.0% +Bearish: 50.0% +``` + +### Redditsent + +`redditsent` will crawl through posts related to the ticker and give it a score based on how polarizing the message is. + +![Screenshot 2023-10-31 at 2 28 52 PM](https://github.com/OpenBB-finance/OpenBBTerminal/assets/85772166/71e6a3c9-ece8-45a4-afca-150211ae7c43) + +### Queries + +The `queries` command shows the terms people are including when searching for the company on Google. + +```console +/stocks/ba/load amd/queries +``` + +| query | value | +|:------------|:--------| +| amd ryzen | 100% | +| amd radeon | 67% | +| radeon | 62% | +| amd stock | 52% | +| amd ryzen 5 | 47% | +| intel | 46% | +| amd ryzen 7 | 25% | +| nvidia | 23% | +| amd driver | 22% | +| amd cpu | 21% | + +```console +/stocks/ba/load intc/queries +``` + +| query | value | +|:-----------------|:--------| +| stock intc | 100% | +| intc price | 36% | +| stock price intc | 32% | +| amd | 15% | +| amd stock | 12% | +| aapl | 9% | +| msft | 8% | +| intc share | 7% | +| nvda | 7% | +| tsla | 7% | diff --git a/website/content/terminal/menus/stocks/comparison.md b/website/content/terminal/menus/stocks/comparison.md new file mode 100644 index 000000000000..8581f491c28f --- /dev/null +++ b/website/content/terminal/menus/stocks/comparison.md @@ -0,0 +1,116 @@ +--- +title: Comparison Analysis +description: This page provides an introduction to the Comparison Analysis (CA) sub-menu, within the Stocks menu, of the OpenBB Terminal. +keywords: +- comparison +- analysis +- peers +- similar stocks +- compare +- correlation +- historical +- screen +- pairs +- performance +- valuation +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +The Comparison Analysis menu features different methods for comparing price, volume, and fundamentals across multiple stocks. + +## Usage + +Enter the menu from the `/stocks` menu. If a ticker is not already loaded, enter one now by using the `ticker` command. + +```console +/stocks/ca/ticker AMD +``` + +![Screenshot 2023-10-31 at 9 32 13 PM](https://github.com/OpenBB-finance/OpenBBTerminal/assets/85772166/75ae98f4-e928-4319-8675-a09d4fe0ca87) + +### Get + +The `get` command will attempt to find the company peers of the base ticker. + +```console +get --source Polygon +``` + +```console +[Polygon] Similar Companies: AMD, INTC, MCHP, NVDA, TXN, HPQ, XLK +``` + +Refreshing the screen, `?` or `h` with no command, will update the list of similar companies. + +![Screenshot 2023-10-31 at 9 38 17 PM](https://github.com/OpenBB-finance/OpenBBTerminal/assets/85772166/418ca6fc-63d6-4ec6-99d5-ac1f1375b358) + +### RMV + +Use the syntax below to remove a ticker from the list: + +```console +rmv xlk +``` + +```console +[Polygon] Similar Companies: AMD, INTC, MCHP, NVDA, TXN, HPQ +``` + +### Add + +Similarly, add another one by using the `add` command. + +```console +add mu +``` + +```console +[Custom] Similar Companies: HPQ, MCHP, TXN, INTC, MU, AMD, NVDA +``` + +### Technical + +With a list of similar companies populated, the `techincal` command will compare recent price performance metrics. + +```console +technical +``` + +![Screenshot 2023-11-01 at 8 16 39 AM](https://github.com/OpenBB-finance/OpenBBTerminal/assets/85772166/9eb4ea36-97a2-44ec-ad8a-8d7ec6145097) + + +### Cashflow + +The `cashflow` command will compare recent annual and quarterly statements for a given period. + +```console +cashflow --quarter +``` + +```console +Other available quarterly timeframes are: 31-Jul-2022, 31-Oct-2022, 31-Jan-2023, 30-Apr-2023, 31-Jul-2023 +``` + +| Item | HPQ (31-Jul-2023) | MCHP (30-Jun-2023) | TXN (30-Jun-2023) | INTC (30-Jun-2023) | MU (31-Aug-2023) | AMD (30-Jun-2023) | NVDA (31-Jul-2023) | +|:---------------------------------------|:--------------------|:---------------------|:--------------------|:---------------------|:-------------------|:--------------------|:---------------------| +| Net Income before Extraordinaries | 736M | 666.4M | 1.72B | 1.47B | (1.43B) | 27M | 6.19B | +| Net Income Growth | -30.96% | 10.33% | 0.82% | 153.22% | 24.58% | 119.42% | 202.94% | +| Depreciation, Depletion & Amortization | 217M | 222.9M | 300M | 2.28B | 1.94B | 873M | 365M | +| Depreciation and Depletion | 126M | 50.5M | 285M | 1.83B | 1.92B | 180M | 219M | +| Amortization of Intangible Assets | 91M | 172.4M | 15M | 444M | 20M | 693M | 146M | +| Deferred Taxes & Investment Tax Credit | 43M | 23.9M | (52M) | | | (274M) | (746M) | +| Deferred Taxes | 43M | 23.9M | (52M) | | | (274M) | (746M) | +| Investment Tax Credit | | | | | | | | +| Other Funds | 69M | 57.9M | 110M | 1.14B | 260M | 335M | 714M | +| Funds from Operations | 1.07B | 971.1M | 2.08B | 4.89B | 767M | 961M | 6.52B | +| Extraordinaries | | | | | | | | +| Changes in Working Capital | (89M) | 22.1M | (681M) | (2.08B) | (518M) | (582M) | (174M) | +| Receivables | (246M) | (159.7M) | (79M) | 851M | 35M | (272M) | (2.99B) | +| Accounts Payable | 781M | 34.9M | 74M | (331M) | (340M) | 236M | 778M | +| Other Assets/Liabilities | (659M) | 50.5M | (157M) | (303M) | (64M) | (87M) | (246M) | +| Net Operating Cash Flow | 976M | 993.2M | 1.4B | 2.81B | 249M | 379M | 6.35B | +| Net Operating Cash Flow Growth | 53.46% | 39.99% | 20.60% | 257.31% | 937.50% | -22.02% | 118.07% | +| Net Operating Cash Flow / Sales | 7.38% | 43.40% | 30.88% | 21.69% | 6.21% | 7.07% | 47.00% | diff --git a/website/content/terminal/menus/stocks/dark-pool-shorts.md b/website/content/terminal/menus/stocks/dark-pool-shorts.md new file mode 100644 index 000000000000..b892de041ff0 --- /dev/null +++ b/website/content/terminal/menus/stocks/dark-pool-shorts.md @@ -0,0 +1,127 @@ +--- +title: Dark Pools & Short Data +description: This documentation page introduces the dark pool and short data menu, which provides the user with tools for gauging the level of short interest, FTD rate, and off-exchange volume in NMS securities. +keywords: +- dark pool +- short data +- ftd +- off-exchange volume +- short interest +- nms +- short +- sidtc +- cover +- fail +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +The purpose of this menu is to provide the user with tools for gauging the level of short interest, FTD rate, and off-exchange volume in a NMS security. There are also commands for looking at market as a whole. + +## Usage + +Enter the `dps` menu from the `/stocks` menu, or through the absolute path: + +```console +/stocks/dps +``` + +![Screenshot 2023-11-01 at 8 33 58 AM](https://github.com/OpenBB-finance/OpenBBTerminal/assets/85772166/64775307-b79e-4ff6-95dd-ec676e1ab677) + +The commands which are not ticker-specific are grouped at the top of the menu, and they provide screener-like utility. + +### Shorted + +A list of the most-shorted stocks, according to Yahoo Finance, is displayed with the `shorted` command. It should be noted that this menu is only able to provide data for SEC-regulated equities. + +```console +/stocks/dps/shorted +``` + +![Screenshot 2023-11-01 at 8 38 12 AM](https://github.com/OpenBB-finance/OpenBBTerminal/assets/85772166/d1361b8f-0795-439f-b9f6-ace9cbde068a) + +### HSI + +The `hsi` command includes the percent of short interest relative to the float size. + +```console +/stocks/dps/hsi +``` + +![Screenshot 2023-11-01 at 8 40 39 AM](https://github.com/OpenBB-finance/OpenBBTerminal/assets/85772166/1287e58b-dbed-44a0-821a-769daebb3f29) + +### PROM + +`prom` performs a linear regression to scan for tickers with growing trade activity on ATS tapes, reported to FINRA. + +```console +/stocks/dps/prom -n 50 -l 5 -t T1 +``` + +```console +Processing Tier T1 ... +Processing regression on 50 promising tickers ... +``` + +![Screenshot 2023-11-01 at 8 45 21 AM](https://github.com/OpenBB-finance/OpenBBTerminal/assets/85772166/13b67056-9d94-45f0-b483-41c1da773f0e) + + +Tier 2 NMS Tickers: + +```console +/stocks/dps/prom -n 50 -l 5 -t T2 +``` + +```console +Processing Tier T2 ... +Processing regression on 50 promising tickers ... +``` + +![Screenshot 2023-11-01 at 8 48 32 AM](https://github.com/OpenBB-finance/OpenBBTerminal/assets/85772166/fab9bb45-fec9-4d51-8b77-0bb9697d8888) + + + +`pos` provides a summary for the last reported trading day (information is updated in the early evening). Position represents a rolling twenty-day total and directional trends can be identified by watching the changes over time. Adding the `-a` flag will sort the list from the bottom up - the most negative - and creates a fuller picture when watching in tandom with the positive side of the ledger. Monitor the rate of change in position sizes, or a reversal in directional flow. This white paper, written by SqueezeMetrics, sheds some light on the trading activity reported here. + +```console +/stocks/dps pos +``` + +![Screenshot 2023-11-01 at 8 55 25 AM](https://github.com/OpenBB-finance/OpenBBTerminal/assets/85772166/8075ab29-cbac-448c-bfc4-a2ca250f6288) + +The other end of the spectrum: + +```console +/stocks/dps/pos -a +``` + +![Screenshot 2023-11-01 at 8 58 27 AM](https://github.com/OpenBB-finance/OpenBBTerminal/assets/85772166/9bd6d148-ae36-4b7b-9faa-79db4dcb93ad) + + +### CTB + +The cost-to-borrow is used as a proxy-measurement for an equity's specialness. `ctb` shows the most expensive equities to short, and the number shares available to short, on Interactive Brokers. + +```console +/stocks/dps/ctb -n 5 +``` + +| Symbol | Fees | Available | +|:---------|:-----------|------------:| +| ALPSQ | 1187.0287% | 500000 | +| LEO | 1034.2946% | 300000 | +| NIM | 872.2794% | 2000 | +| SVRE | 801.5519% | 15000 | +| APLM | 753.8133% | 65000 | + +### FTD + +The `ftd` command will lookup the SEC-reported fails-to-deliver data for a single company. Use `load` to set the symbol. + +```console +/stocks/dps/load cvna/ftd --start 2022-01-01 +``` + +![Screenshot 2023-11-01 at 9 28 34 AM](https://github.com/OpenBB-finance/OpenBBTerminal/assets/85772166/43409271-e306-4f13-9153-8cc322dde851) diff --git a/website/content/terminal/menus/stocks/disc.md b/website/content/terminal/menus/stocks/disc.md new file mode 100644 index 000000000000..7f1295fafad4 --- /dev/null +++ b/website/content/terminal/menus/stocks/disc.md @@ -0,0 +1,103 @@ +--- +title: Discovery +description: This documentation page is an introduction to the Discovery sub-menu, within Stocks, of the OpenBB Terminal. Functions in this menu include stock lists, calendars, trending moves and an S&P 500 heatmap. +keywords: +- Stocks Discovery +- following trends +- current events +- gainers +- losers +- most active +- calendar +- dividend +- earnings +- Seeking Alpha news +- S&P 500 +- heatmap +- ark +- penny stocks +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +The Discovery menu has functions for upcoming corporate calendar events and stock lists. Commands in this menu are not ticker-specific and do not require a symbol to be loaded. + +## Usage + +Enter the Discovery menu from the `/stocks` menu by typing `disc` into the Terminal, or through the absolute path: + +```console +/stocks/disc +``` + +![Screenshot 2023-11-01 at 9 34 25 AM](https://github.com/OpenBB-finance/OpenBBTerminal/assets/85772166/94d61da1-a04e-4d03-87bc-1d95443dc851) + + +### DIVCAL + +The dividend calendar will display single dates, and does not provide historical data. The `date` will be with respect to the ex-dividend date. + +```console +/stocks/disc/divcal +``` + +![Screenshot 2023-11-01 at 9 43 46 AM](https://github.com/OpenBB-finance/OpenBBTerminal/assets/85772166/d99e5973-6a49-441d-bb4d-5a60139f7334) + +### Upcoming + + +Check the upcoming earnings schedule using, `upcoming`. The `limit` parameter represents the number of days to look ahead. + +```console +/stocks/disc/upcoming --start 2023-11-02 --limit 5 +``` + +![Screenshot 2023-11-01 at 9 47 27 AM](https://github.com/OpenBB-finance/OpenBBTerminal/assets/85772166/99fc4bec-7ffe-4b98-bf98-e791c81aab3a) + + +### Filings + +The `filings` command is the RSS feed of latest filings to the SEC. The results are printed directly to the screen, or they can be exported with the `--export` command. To see all the entries from today, add `--today` to the command. By default, the five most-recent documents will be displayed. + +```console +/stocks/disc/filings +``` + +```console +Timestamp: 2023-11-01 12:44:49 US/Eastern +Ticker: NVO +CIK: 353278 +Form Type: 6-K +6-K - NOVO NORDISK A S (0000353278) (Filer) +https://www.sec.gov/Archives/edgar/data/353278/000117184323006584/0001171843-23-006584-index.htm + +Timestamp: 2023-11-01 12:44:49 US/Eastern +Ticker: NONOF +CIK: 353278 +Form Type: 6-K +6-K - NOVO NORDISK A S (0000353278) (Filer) +https://www.sec.gov/Archives/edgar/data/353278/000117184323006584/0001171843-23-006584-index.htm + +Timestamp: 2023-11-01 12:38:55 US/Eastern +Ticker: None +CIK: 1715593 +Form Type: 13F-HR +13F-HR - Csenge Advisory Group (0001715593) (Filer) +https://www.sec.gov/Archives/edgar/data/1715593/000171559323000007/0001715593-23-000007-index.htm + +Timestamp: 2023-11-01 12:36:58 US/Eastern +Ticker: HMY +CIK: 1023514 +Form Type: 6-K +6-K - HARMONY GOLD MINING CO LTD (0001023514) (Filer) +https://www.sec.gov/Archives/edgar/data/1023514/000162828023035854/0001628280-23-035854-index.htm + +Timestamp: 2023-11-01 12:36:58 US/Eastern +Ticker: HGMCF +CIK: 1023514 +Form Type: 6-K +6-K - HARMONY GOLD MINING CO LTD (0001023514) (Filer) +https://www.sec.gov/Archives/edgar/data/1023514/000162828023035854/0001628280-23-035854-index.htm +``` diff --git a/website/content/terminal/menus/stocks/fa.md b/website/content/terminal/menus/stocks/fa.md new file mode 100644 index 000000000000..a9c30b2a8bb2 --- /dev/null +++ b/website/content/terminal/menus/stocks/fa.md @@ -0,0 +1,220 @@ +--- +title: Fundamental Analysis +description: The Fundamental Analysis menu is a set of tools for analyzing the overall health of a company and estimating its intrinsic value. Functions within this menu provide company profiles, financial statements, historical distributions, financial ratios, and analyst estimates. +keywords: +- fundamental analysis +- financials +- consensus +- estimates +- price target +- SEC filings +- shareholder +- ratios +- fundamentals +- management +- ratings +- eps +- dcf +- customers +- suppliers +- distributions +- analyst +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +The Fundamental Analysis menu is a set of tools for analyzing the overall health of a company and estimating its intrinsic value. Functions within this menu provide company profiles, financial statements, historical distributions, financial ratios, and analyst estimates. Revenue of companies with a long public history are easier to forecast, and the consensus of many analysts will indicate the level of confidence in future expectations. In addition to these features, there are tools in the [`stocks/ca`](/terminal/menus/stocks/comparison.md) menu for comparing fundamentals across groups of companies. + +## Usage + +Enter the submenu from the `/stocks/` menu with `fa`, or from the absolute path: + +```console +/stocks/fa +``` + +![Screenshot 2023-11-01 at 10 03 40 AM](https://github.com/OpenBB-finance/OpenBBTerminal/assets/85772166/21a947f2-b173-493f-a1e4-b889deef32c4) + +:::note + +- All functions in this menu can add a ticker argument with the `-t` flag. This overrides the loaded symbol. + +- Data returned from each source will be different for the same command. Use the `--source` argument to change the data provider for a command with more than one available. + +::: + +### Overview + +The `overview` command provides general metadata and key metrics. + +```console +/stocks/fa/overview -t aapl --source YahooFinance +``` + +| | Value | +|:------------------------------|:-------------------| +| Currency | USD | +| Day high | 172.36000061035156 | +| Day low | 170.1300048828125 | +| Exchange | NMS | +| Fifty day average | 176.71860076904298 | +| Last price | 172.35000610351562 | +| Last volume | 23223500 | +| Market cap | 2694554388210.7812 | +| Open | 171.0 | +| Previous close | 170.38 | +| Quote type | EQUITY | +| Regular market previous close | 170.77000427246094 | +| Shares | 15634199552 | +| Ten day average volume | 56025390 | +| Three month average volume | 58964427 | +| Timezone | America/New_York | +| Two hundred day average | 170.8950003814697 | +| Year change | 0.177480560641351 | +| Year high | 198.22999572753906 | +| Year low | 124.16999816894531 | + + +An example of the difference between sources: + +```console +/stocks/fa/overview -t aapl --source AlphaVantage +``` + +| | | +|:---------------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Symbol | AAPL | +| AssetType | Common Stock | +| Name | Apple Inc | +| Description | Apple Inc. is an American multinational technology company that specializes in consumer electronics, computer software, and online services. Apple is the world's largest technology company by revenue (totalling $274.5 billion in 2020) and, since January 2021, the world's most valuable company. As of 2021, Apple is the world's fourth-largest PC vendor by unit sales, and fourth-largest smartphone manufacturer. It is one of the Big Five American information technology companies, along with Amazon, Google, Microsoft, and Facebook. | +| CIK | 320193 | +| Exchange | NASDAQ | +| Currency | USD | +| Country | USA | +| Sector | TECHNOLOGY | +| Industry | ELECTRONIC COMPUTERS | +| Address | ONE INFINITE LOOP, CUPERTINO, CA, US | +| FiscalYearEnd | September | +| LatestQuarter | 2023-06-30 | +| MarketCapitalization | 2669852230000 | +| EBITDA | 123957002000 | +| PERatio | 28.65 | +| PEGRatio | 2.75 | +| BookValue | 3.852 | +| DividendPerShare | 0.93 | +| DividendYield | 0.0056 | +| EPS | 5.96 | +| RevenuePerShareTTM | 24.22 | +| ProfitMargin | 0.247 | +| OperatingMarginTTM | 0.281 | +| ReturnOnAssetsTTM | 0.209 | +| ReturnOnEquityTTM | 1.601 | +| RevenueTTM | 383932989000 | +| GrossProfitTTM | 170782000000 | +| DilutedEPSTTM | 5.96 | +| QuarterlyEarningsGrowthYOY | 0.05 | +| QuarterlyRevenueGrowthYOY | -0.014 | +| AnalystTargetPrice | 187.73 | +| TrailingPE | 28.65 | +| ForwardPE | 28.66 | +| PriceToSalesRatioTTM | 5.51 | +| PriceToBookRatio | 44.63 | +| EVToRevenue | 5.92 | +| EVToEBITDA | 23.52 | +| Beta | 1.308 | +| 52WeekHigh | 197.96 | +| 52WeekLow | 123.64 | +| 50DayMovingAverage | 176.72 | +| 200DayMovingAverage | 170.9 | +| SharesOutstanding | 15634200000 | +| DividendDate | 2023-08-17 | +| ExDividendDate | 2023-08-11 | + + +### Analysis + +The `analysis` command reads SEC filings with NLP and extracts the most important statements. Source: [https://eclect.us/](https://eclect.us/) + +![Screenshot 2023-11-01 at 10 20 44 AM](https://github.com/OpenBB-finance/OpenBBTerminal/assets/85772166/771f1f60-7879-4243-bbb5-2d2298ea4ecf) + +### MKTCAP + +The `mktcap` command will display the historical market cap of the company. When the `--source` is `FinancialModelingPrep`, the enterprise value can be chosen as the target metric. + +```console +/stocks/fa/mktcap -t aapl --source FinancialModelingPrep ---method enterprise_value --quarter +``` + +![Screenshot 2023-11-01 at 10 29 30 AM](https://github.com/OpenBB-finance/OpenBBTerminal/assets/85772166/41fb942b-dffc-4ab9-b6b8-62884b9faf8d) + +### Earnings + +The `earnings` command compares reported EPS to estimated for each period. + +```console +/stocks/fa/earnings -t aapl --quarter +``` + +![Screenshot 2023-11-01 at 10 59 35 AM](https://github.com/OpenBB-finance/OpenBBTerminal/assets/85772166/fa03681a-11ff-4a33-8832-fa47246ed44c) + +### EPSFC + +`epsfc` is the forward consensus of EPS estimates. + +```console +/stocks/fa/epsfc -t aapl +``` + +| fiscalyear | consensus_mean | change % | analysts | actual | consensus_low | consensus_high | +|-------------:|-----------------:|-----------:|-----------:|---------:|----------------:|-----------------:| +| 2022 | 6.10809 | 8.87861 | 41 | 6.11 | 5.96 | 6.4 | +| 2023 | 6.07227 | -0.617512 | 43 | 0 | 5.82 | 6.53 | +| 2024 | 6.53322 | 7.59107 | 43 | 0 | 5.6 | 7.1 | +| 2025 | 7.11054 | 8.83668 | 19 | 0 | 6.09 | 7.98 | +| 2026 | 8.12 | 14.1967 | 2 | 0 | 7.18 | 9.06 | +| 2027 | 9.08 | 11.8227 | 2 | 0 | 8.03 | 10.13 | +| 2028 | 8.96 | -1.32159 | 1 | 0 | 8.96 | 8.96 | +| 2029 | 9.96 | 11.1607 | 1 | 0 | 9.96 | 9.96 | +| 2030 | 10.99 | 10.3414 | 1 | 0 | 10.99 | 10.99 | +| 2031 | 12.14 | 10.4641 | 1 | 0 | 12.14 | 12.14 | +| 2032 | 13.44 | 10.7084 | 1 | 0 | 13.44 | 13.44 | + +### Ratios + +The `ratios` command returns calculated financial ratios, by year or quarter. To get quarterly data, apply the `--quarter` flag. Use the `--limit` argument to return more results. + +```console +/stocks/fa/ratios -t aapl +``` + +![Screenshot 2023-11-01 at 10 54 48 AM](https://github.com/OpenBB-finance/OpenBBTerminal/assets/85772166/2eb8dd17-1dd3-4d85-9f70-318037015285) + + +### DCF + +The `dcf` function will attempt to generate a discounted cash flow statement as an Excel file. See the optional arguments that can be applied to the command by adding `-h` to the syntax. + +```console +/stocks/fa/dcf -h +``` + +The available parameters are: + +```console + -t TICKER, --ticker TICKER + Ticker to analyze (default: None) + -a, --audit Generates a tie-out for financial statement information pulled from online. (default: False) + --no-ratios Removes ratios from DCF. (default: True) + --no-filter Allow similar companies of any market cap to be shown. (default: False) + -p PREDICTION, --prediction PREDICTION + Number of years to predict before using terminal value. (default: 10) + -s SIMILAR, --similar SIMILAR + Number of similar companies to generate ratios for. (default: 0) + -b BETA, --beta BETA The beta you'd like to use for the calculation. (default: 1) + -g, --growth Whether to replace a linear regression estimate with a growth estimate. (default: False) + -h, --help show this help message (default: False) +``` + +![Screenshot 2023-11-01 at 11 15 06 AM](https://github.com/OpenBB-finance/OpenBBTerminal/assets/85772166/6bc9861a-9dc1-4425-8f09-5f29d5619f9d) diff --git a/website/content/terminal/menus/stocks/gov.md b/website/content/terminal/menus/stocks/gov.md new file mode 100644 index 000000000000..3ca8c46b4849 --- /dev/null +++ b/website/content/terminal/menus/stocks/gov.md @@ -0,0 +1,82 @@ +--- +title: Government +description: This documentation pages describes the government trading menu hwere users can access the reported trades of elected officials, lobbyist activity, awarded contracts, and general spending of the United States Treasury Department. +keywords: +- government +- government trading +- lobbyist activity +- awarded contracts +- treasury +- representatives +- senate +- the house +- congress +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +The features in this menu are intended to show the reported trades of elected officials, lobbyist activity, awarded contracts, and general spending of the United States Treasury Department. This menu only covers the USA, or companies that trade on US exchanges. The information in this menu is compiled by QuiverQuant. + +## Usage + +Enter the menu from `/stocks` with `gov`, or via the absolute path: + +```console +/stocks/gov +``` + +The menu is divided into two sections. Features under the `Explore` do not depend on individual tickers, while the commands listed under `Ticker` do. + +![Screenshot 2023-11-01 at 11 18 40 AM](https://github.com/OpenBB-finance/OpenBBTerminal/assets/85772166/51be579a-7fa0-4ef8-b04c-f2f06c9ef099) + +A symbol can be set by using `load`. + +### Lasttrades + +The `lasttrades` command displays the most recent purchase and sale disclosures by representatives. + +![Screenshot 2023-11-01 at 11 23 48 AM](https://github.com/OpenBB-finance/OpenBBTerminal/assets/85772166/7fe9823e-bdc0-4cb6-8a74-8634f407c145) + + +### Toplobbying + +`toplobbying` shows which public companies are spending the most on lobbying efforts. + +```console +/stocks/gov/toplobbying --limit 1 +``` + +![Screenshot 2023-11-01 at 11 29 33 AM](https://github.com/OpenBB-finance/OpenBBTerminal/assets/85772166/9b2564b2-f503-454a-adc4-f397d1b940f2) + +### Lobbying + +For descriptions of each lobbying event from a company, load a ticker and then use the `lobbying` command. + +```console +/stocks/gov/load lmt/lobbying --limit 1 +``` + +```console +2023-10-05: LOCKHEED MARTIN CORPORATION $50000 + +Tax matters impacting Lockheed Martin Corporation. + +Defense issues impacting Lockheed Martin Corporation. + +H.R.2670/S.2226 - National Defense Authorization Act for Fiscal Year 2024. + +Defense Appropriations. +``` + +### Lastcontracts + +`lastcontracts` is a list of the most recently awarded government contracts. + +```console +/stocks/gov/lastcontracts --limit +``` + +![Screenshot 2023-11-01 at 12 27 34 PM](https://github.com/OpenBB-finance/OpenBBTerminal/assets/85772166/b290c8db-a1b5-4f6c-bea2-65cf16eae3e7) + diff --git a/website/content/terminal/menus/stocks/ins.md b/website/content/terminal/menus/stocks/ins.md new file mode 100644 index 000000000000..b1208d528068 --- /dev/null +++ b/website/content/terminal/menus/stocks/ins.md @@ -0,0 +1,96 @@ +--- +title: Insider Trading +description: This documentation page features the insider trading menu which gives stock screener for SEC Form 4 filings and researching individual companies for executive and director transactions +keywords: +- SEC form 4 filings +- insider +- insider trading +- insider activity +- stock screener +- reporting +- transactions +- trade type +- trade date +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +The Insider Trading menu provides screener-like functions for SEC Form 4 filings, or for researching individual companies with executive and director transactions. The features in this menu function only for companies registered with the SEC, that also trade in public markets. + +## Usage + +Navigate to the Insider Trading submenu from the `stocks` menu by typing `ins` and pressing `enter`. + +![Screenshot 2023-11-01 at 12 46 13 PM](https://github.com/OpenBB-finance/OpenBBTerminal/assets/85772166/6e79a43c-f401-4519-a777-415c64581ddd) + +The menu can be entered with its absolute path: + +```console +/stocks/ins +``` + +The Insider Trading menu contains three groups of functions: +- Screening: use presets to filter companies. +- Scanning: scan the latest transactions in the market. +- Researching: lookup individual companies. + + +### Screening + +Screening in this sub-menu uses a similar process to the [Stocks Screener](/terminal/menus/stocks/screener.md). This [template](https://github.com/OpenBB-finance/OpenBBTerminal/blob/develop/openbb_terminal/miscellaneous/stocks/insider/template.ini) file is a starting point, and describes how to configurea preset for use. Follow the formatting instructions in the comments of the template file, then place this file in the OpenBBUserData folder: `~/OpenBBUserData/presets/stocks/insider`. Files placed in this folder will be recognized by the auto complete choices on next launch. Changes to the settings (without altering the filename) will be reflected when the preset is run, restarting the Terminal is not required. + +#### Set + +Set the preset to use by typing, `set -p`, and then the spacebar will activated the choices from auto complete. + +![Screenshot 2023-11-01 at 1 17 55 PM](https://github.com/OpenBB-finance/OpenBBTerminal/assets/85772166/6eaea63a-bfff-47c3-be79-4a7df490f5c8) + +#### Filter + +The `filter` command runs the screen. Use the `--limit` parameter to increase the number of results returned. + +```console +set -p Insurance-Agents +filter +``` + +```console +A: Amended filing +D: Derivative transaction in filing (usually option exercise) +M: Multiple transactions in filing; earliest reported transaction date & weighted average transaction price +P - Purchase: Purchase of securities on an exchange or from another person +S - Sale: Sale of securities on an exchange or to another person +S - Sale+OE: Sale of securities on an exchange or to another person (after option exercise) +``` + +![Screenshot 2023-11-01 at 1 23 29 PM](https://github.com/OpenBB-finance/OpenBBTerminal/assets/85772166/4793ef66-0e4e-46bd-886f-f6615058b4f6) + +### Scanning + +The commands grouped by both "Last Insiders" and "Top Insiders" filter market-wide by the description printed on the menu. + +#### toppw + +`toppw` returns the top officer purchases during the past week. + +```console +/stocks/ins/toppw +``` + +![Screenshot 2023-11-01 at 1 28 32 PM](https://github.com/OpenBB-finance/OpenBBTerminal/assets/85772166/2caf277e-75e3-4f6a-90a5-0f92b449062c) + +### Researching + +The three functions grouped at the bottom are activated when the Insider Trading menu is entered with a ticker symbol loaded from the `/stocks` menu. + +#### stats + +The `stats` command shows the insider activity for a ticker. + +```console +/stocks/load rivn/ins/stats +``` + +![Screenshot 2023-11-01 at 1 41 29 PM](https://github.com/OpenBB-finance/OpenBBTerminal/assets/85772166/6028b97e-bea4-4d4e-85e1-3512c8004675) diff --git a/website/content/terminal/menus/stocks/introduction.md b/website/content/terminal/menus/stocks/introduction.md new file mode 100644 index 000000000000..c891056bc1cb --- /dev/null +++ b/website/content/terminal/menus/stocks/introduction.md @@ -0,0 +1,335 @@ +--- +title: Introduction +sidebar_position: 1 +description: This is a documentation page for the Stocks menu used in public equity. + It contains functions for searching and loading company market data, displaying + candle charts, and providing quotes and company specifics. The menu also offers + a wide range of sub-menus that segment functions based on the type of data they + return. +keywords: +- public equity +- company market data +- candle charts +- stock quotes +- company specifics +- stock search +- data groups +- metadata +- technical analysis +- trading hours +- equity options +- quantitative analysis +- research websites +- stocks screener +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + + +The Stocks menu is the high-level menu for the Public Equity asset class. It contains functions for searching and loading company market data, showing candle charts, quotes and company specifics via a large selection of sub-menus. The sub-menus break the functions down into groups based on the type of data they return. The items in the stocks menu are listed below with a short description. Refer to each sub-menu's introductory guide for a more detailed explanation of the functions within. + +## Menu Contents + +| Command | Type | Name | Description | +| :------- | -------- | -----------------------: | ---------------------------------------------------------------------------: | +| ba | Sub-Menu | Behavioural Analysis | Social Media, Sentiment, Trends | +| bt | Sub-Menu | Strategy Backtester | Simple EMA, EMA Crossover & RSI Strategies | +| ca | Sub-Menu | Comparison Analysis | Compare Historical Prices, Correlations, Financials | +| candle | Function | Candle | Candlestick Chart of the Loaded Data | +| codes | Function | Codes | Cross-Reference FIGI, CIK, and SIC Numbers | +| disc | Sub-Menu | Discovery | Upcoming Earnings and Dividends Calendar, Heatmaps, Trending News | +| dps | Sub-Menu | Dark Pool and Short Data | Short Interest, Borrow Rates, Off-Exchange Short Volume | +| fa | Sub-Menu | Fundamental Analysis | Financial Statements, Company Overviews, Analyst Coverage, Price Targets | +| forecast | Sub-Menu | Forecasting and ML | Enter the Forecast Menu With the Loaded Ticker | +| gov | Sub-Menu | Government | House and Senate Trading Disclosures, Lobbying Efforts, US Treasury Spending | +| ins | Sub-Menu | Insider Trading | SEC Form 4 Disclosures & Screener | +| load | Function | Load | Load a Ticker Symbol | +| news | Function | News | Ticker-Specific News Headlines | +| options | Sub-Menu | Equity Options | Options Analysis, Quotes, Historical Prices, Greeks & Screener | +| qa | Sub-Menu | Quantitative Analysis | Mathematical Analysis | +| quote | Function | Quote | Current Price and Performance Data for the Ticker | +| res | Sub-Menu | Research Websites | Shortcuts to Online Resources for the Loaded Ticker | +| scr | Sub-Menu | Stocks Screener | Custom Stocks Screener | +| search | Function | Stocks Search | Find a company and ticker | +| ta | Sub-Menu | Technical Analysis | Technical Indicators and Charts | +| th | Sub-Menu | Trading Hours | Lists of World Markets and Current Status | +| tob | Function | Top of Book | Top of Book Bid/Ask from CBOE (US-only when markets are open) | + +## How to Use + +Navigate to the menu by entering, `stocks`, from the Main Menu. From another menu, `/stocks`, will jump directly there. + +The current screen can always be re-printed with any of: `?`, `h`, `help`. The help dialogue, containing all parameters for each function, is printed when `-h` is attached to any command. The help dialogue will also provide the list of sources available to each command, the `news` function is shown below. + +```console +news -h +``` + +Which prints the reference information on the screen: + +```console +usage: news [-t TICKER] [-d N_START_DATE] [-o] [-s SOURCES] [-h] [--export EXPORT] [--sheet-name SHEET_NAME [SHEET_NAME ...]] [-l LIMIT] [--source {Feedparser,NewsApi,Ultima}] + +latest news of the company + +options: + -t TICKER, --ticker TICKER + Ticker to get data for + -d N_START_DATE, --date N_START_DATE + The starting date (format YYYY-MM-DD) to search articles from + -o, --oldest Show oldest articles first + -s SOURCES, --sources SOURCES + Show news only from the sources specified (e.g bloomberg,reuters) + -h, --help show this help message + --export EXPORT Export raw data into csv, json, xlsx + --sheet-name SHEET_NAME [SHEET_NAME ...] + Name of excel sheet to save data to. Only valid for .xlsx files. + -l LIMIT, --limit LIMIT + Number of entries to show in data. + --source {Feedparser,NewsApi,Ultima} + Data source to select from + +For more information and examples, use 'about news' to access the related guide. +``` + +Attaching the source argument to a command selects a source other than the default, which can also be set permanently from the [`/sources` menu](/terminal/usage/data/data-sources). To select the `source` as `Ultima`, use the syntax below. + +```console +news -t WMT --source Ultima + +------------------------ +> 2023-04-10 15:44:56 - The Federal Trade Commission and Justice Department should stop the acquisition of Albertsons by Kroger. The usual false claims are being made such as... + +Relevancy score: 4.87/5 Stars + +Competition Risk (Walmart Inc. faces competition risk due to the presence of other large retailers in the market, as well as physical, eCommerce and omni-channel retailers, social commerce platforms, wholesale club operators and retail intermediaries. +These competitors have the ability to leverage their economies of scale to offer lower prices than Walmart, which can put pressure on Walmart’s margins. +Additionally, these competitors have the ability to quickly respond to changes in the market, which can put Walmart at a disadvantage. +Furthermore, Walmart is subject to laws and regulations related to competition and antitrust matters, which could require extensive system and operational changes, increase operating costs, and require significant capital expenditures.) + +Read more: https://www.cincinnati.com/story/opinion/letters/2023/04/10/letters-kroger-acquiring-albertsons-will-reduce-competition-not-prices/70080423007/ +``` + +The first step in many workflows will be to load a stock symbol with historical data. The amount, granularity, and market coverage will vary by source. Users can elect to subscribe to any of the data sources accordingly. While no API keys are required to get started using the Terminal, acquiring these credentials at the free level significantly enhances the user experience with additional functionality and available data. Refer to the [API keys guide](/terminal/usage/data/api-keys) for links to obtain each. + +## Examples + +### Load + +The `load` function is a starting point for most functions, and parameters can be adjusted for intraday and resolution. It has many optional arguments which can be displayed for reference by attaching, `-h`, or, `--help`, to any function. Entering: + +```console +load -h +``` + +Reveals the choices: + +```console +usage: load [-t TICKER] [-s START] [-e END] [-i {1,5,15,30,60}] [-p] [-f FILEPATH] [-m] [-w] [--exchange] [--performance] [-h] [--export EXPORT] + [--sheet-name SHEET_NAME [SHEET_NAME ...]] [--source {YahooFinance,AlphaVantage,Polygon,EODHD,Intrinio}] + +optional arguments: + -t TICKER, --ticker TICKER + Stock ticker (default: None) + -s START, --start START + The starting date (format YYYY-MM-DD) of the stock (default: 2020-02-11) + -e END, --end END The ending date (format YYYY-MM-DD) of the stock (default: 2023-02-15) + -i {1,5,15,30,60}, --interval {1,5,15,30,60} + Intraday stock minutes (default: 1440) + -p, --prepost Pre/After market hours. Only reflected in intraday data. (default: False) + -f FILEPATH, --file FILEPATH + Path to load custom file. (default: None) + -m, --monthly Load monthly data (default: False) + -w, --weekly Load weekly data (default: False) + --exchange Show exchange information. (default: False) + --performance Show performance information. (default: False) + -h, --help show this help message (default: False) + --export EXPORT Export raw data into csv, json, xlsx (default: ) + --sheet-name SHEET_NAME [SHEET_NAME ...] + Name of excel sheet to save data to. Only valid for .xlsx files. (default: None) + --source {YahooFinance,AlphaVantage,Polygon,EODHD,Intrinio,DataBento} + Data source to select from (default: YahooFinance) + + +``` + +By default, a daily period of OHLC+V data over three years, from YahooFinance, is loaded to memory. Use the default settings like this: + +```console +load MSFT +``` + +A message will print indicating the starting date from which the data begins. + +```console +Loading Daily data for MSFT with starting period 2019-11-27. +``` + +A simple way to get the entire history available from a source is to use an arbitrary starting date from a long time ago, like `1900-01-01`. + +```console +load MSFT -s 1990-01-01 +``` + +The console print indicates the first date of history, provided by this source, is January 29, 1993. + +```console +Loading Daily data for MSFT with starting period 1993-01-29. +``` + +A range-bound window can also be loaded; for example, the dot-com era: + +```console +load MSFT -s 1997-01-01 -e 2003-01-01 +``` + +The interval of the data can also be set as weekly or monthly; `-w` for weekly, and `-m` for monthly candles. The data will now start on a Monday or at the beginning of a month. + +```console +load MSFT -s 1997-01-01 -e 2003-01-01 -w +``` + +Intraday data is also requested this way, only using the `-i` or `--interval` argument. One-minute data can be loaded like this: + +```console +load MSFT -i 1 +``` + +From YahooFinance, five days of one-minute data is available. The amount of historical price data will vary by source. + +```console +Loading Intraday 1min data for MSFT with starting period 2022-11-25. +``` + +This can be augmented further by adding pre/post market price candles. + +```console +load MSFT -i 1 -p +``` + +Data can also be exported, as a CSV, JSON, or XLSX file, directly from the `load` function. The file is created in the OpenBBUserData folder. + +```console +load MSFT -s 1990-01-01 -m --export msft_monthly.csv +``` + +```console +Loading Daily data for MSFT with starting period 1993-02-01. + +Saved file: /Users/{username}/OpenBBUserData/exports/msft_monthly.csv +``` + +Exported files can also be loaded by declaring the `--file` argument. Place the file to import in the folder: `OpenBBUserData/custom_imports/stocks` + +### Candle + +The `candle` command displays a chart of the loaded symbol. It needs no arguments to display, but modifiers can enhance the content of the chart. Commands can also be sequenced together with a `/` separating each individual command. + +```console +(🦋) /stocks/ $ load MSFT + +Loading Daily data for MSFT with starting period 2020-04-08. + +(🦋) /stocks/ $ candle +``` + +![stocks/candle](https://user-images.githubusercontent.com/85772166/231903835-a0157626-1329-4d5a-80a1-8d21b71adcb1.png) + +The help dialogue for the `candle` command shows how this chart can be supplemented with additional data; specifically, `-t` for trend, `--ma` for moving averages, `--log` for a log scale, and `--ha` to convert the candles to a Heikin Ashi pattern. + +```console +candle -h +``` + +Which prints to screen: + +```console +usage: candle [-t TICKER] [-p] [--sort {open,high,low,close,adjclose,volume,dividends,stock_splits}] [-r] [--raw] [--trend] [--ma MOV_AVG] [--ha] [--log] [-h] [--export EXPORT] + [--sheet-name SHEET_NAME [SHEET_NAME ...]] [-l LIMIT] + +Shows historic price and volume for the asset. + +options: + -t TICKER, --ticker TICKER + Ticker to analyze. (default: None) + -p, --prepost Pre/After market hours. Only works for intraday data. (default: False) + --sort {open,high,low,close,adjclose,volume,dividends,stock_splits} + Choose a column to sort by. Only works when raw data is displayed. (default: ) + -r, --reverse Data is sorted in descending order by default. Reverse flag will sort it in an ascending way. Only works when raw data is displayed. (default: False) + --raw Shows raw data instead of a chart. (default: False) + --trend Flag to add high and low trends to candle. (default: False) + --ma MOV_AVG Add moving average in number of days to plot and separate by a comma. Value for ma (moving average) keyword needs to be greater than 1. (default: None) + --ha Flag to show Heikin Ashi candles. (default: False) + --log Plot with y axis on log scale (default: False) + -h, --help show this help message (default: False) + --export EXPORT Export raw data into csv, json, xlsx and figure into png, jpg, pdf, svg (default: ) + --sheet-name SHEET_NAME [SHEET_NAME ...] + Name of excel sheet to save data to. Only valid for .xlsx files. (default: None) + -l LIMIT, --limit LIMIT + Number of entries to show in data. (default: 20) + +For more information and examples, use 'about candle' to access the related guide. +``` + +Be sure to adjust the values for moving averages to correspond with the interval of the data loaded. Below adds movings averages for three and twelve month periods (because data loaded is monthly), and changes the y-axis to a log-scale. + +```console +load msft --start 1980-01-01 --monthly +candle --ma 3,12 --log +``` + +![candle moving average log](https://user-images.githubusercontent.com/85772166/231904022-7da40eae-2389-4dfa-a619-f950fa8f2929.png) + +### News + +Get ticker-related news headlines by entering `news` after loading a ticker. + +```console +news --source NewsApi +``` + +![stocks/news](https://user-images.githubusercontent.com/85772166/231904057-235b93e2-12e6-45db-a4eb-f6c7c93e02ff.png) + +### TOB + +The `tob` function is the "Top of Book", and it returns data during market hours. + +```console +tob +``` + +![stocks/tob](https://user-images.githubusercontent.com/85772166/231904101-0df25e0e-631c-4a58-a449-e851df6fd4d8.png) + +### Quote + +Get the current market price and general performance metrics of the loaded ticker. + +```console +quote +``` + +![stocks/quote](https://user-images.githubusercontent.com/85772166/231904179-1908801d-ac8d-4bc2-aa08-e93507df1630.png) + +### Codes + +`codes` prints the CIK, Composite FIGI, Share Class FIGI, and SIC codes - when available - for a US-listed stock. This function requires a free API key from Polygon. + +```console +codes +``` + +![stocks/codes](https://user-images.githubusercontent.com/85772166/231904217-b477d719-389c-4678-ac04-266641ec7652.png) + +### Search + +The `search` function provides a way to find stocks by name, region, sector, industry and exchange location. The results can be exported as a CSV, JSON, or XLSX file from the command line or within the table. + +Return all Canadian banks with US listings with: + +```console +search --country canada --industrygroup banks +``` + +![stocks/search](https://user-images.githubusercontent.com/85772166/231904274-cc3ba608-280a-47f7-834a-98ba2f3de6c3.png) diff --git a/website/content/terminal/menus/stocks/options.md b/website/content/terminal/menus/stocks/options.md new file mode 100644 index 000000000000..4b50ebdec263 --- /dev/null +++ b/website/content/terminal/menus/stocks/options.md @@ -0,0 +1,171 @@ +--- +title: Options +description: This is an informative page providing a detailed overview of how to navigate + and use the Options Menu to analyze equity options. It discusses the functions, + and gives clear examples of how to fetch and analyze options data such as chains, + Greeks, expiration dates, and put/call ratios using different financial data sources. +keywords: +- equity options +- options menu +- financial instruments +- derivatives +- due diligence +- YahooFinance +- Nasdaq +- Tradier +- Intrinio +- options data +- options chains +- options functions +- ticker symbol +- unusual options +- fdscanner.com +- option chain +- put/call ratio +- expiration date +- volatility smile +- second order Greeks +- greeks command +- puts +- calls +- surface +- spx +- ndx +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +The Options menu provides the user with tools for analyzing equity options. Wikipedia is a great resource for definitions and for learning about the mechanics of derivatives, read it [here](https://en.wikipedia.org/wiki/Option_(finance)). These are complex, leveraged, financial instruments requiring specialized knowledge and a different frame-of-mind than the approach taken by an equities long-only investor. Always conduct thorough due diligence. + +## Usage + +Navigate to the menu by typing `options`, from the `/stocks` menu, and then pressing enter. The menu can also be entered by the absolute path: + +```console +/stocks/options +``` + +The source for the options data can be defined using the `load` command, and a default preference is be defined in the `/sources` menu - or on the [OpenBB Hub](https://my.openbb.co). The chains data returned will vary by source. The following sources are currently available to use: + +- YahooFinance +- Nasdaq +- Tradier (requires API key) +- Intrinio (requires API key) + +The menu can be entered without a ticker symbol loaded. If one is already loaded from the stocks menu, it will automatically fetch the chains data from the default source. The commands displayed above the currently active Ticker and Expiry do not require any data to be loaded, while the functions below do. + +| Function Key | Description | +| :----------- | ----------: | +|calc |A basic payoff diagram for a single call or put. | +|chains |Display options chains and Greeks. | +|eodchain |Gets the option chain for a ticker, on a specific date. | +|exp |Select a target expiration date. | +|greeks |Shows or recalculates the Greeks for an expiration date. | +|grhist |Plot the historical Greeks of an individual contract. | +|hedge |A calculator for weighting a position to neutralize delta. | +|hist |Historical prices of an individual contract. | +|info |Basic stats for the options chain. | +|load |Load a new ticker. | +|oi |Plot the open interest. | +|plot |Plot x vs. y as defined by the user. | +|pcr |Display historical rolling put/call ratios for a ticker over a selectable window. | +|screen |An options screener. | +|unu |Unusual options activity for S&P 500 stocks. | +|voi |Plot the volume and open interest together. | +|vol |Plot the volume. | +|vsurf |3-D volatility surface chart. | + +The examples here will start by entering the Options menu without a ticker symbol loaded. + +```console +/stocks/options +``` + +### UNU + +Unusual options are described as those having a very high volume/open interest ratio. This function is built using the data provided by [fdscanner.com](https://fdscanner.com). By default, the top 20 options with the highest vol/OI ratio are returned as a table. + +```console +unu +``` + +With the new interactive tables, it may be better to remove the limit and utilize the table's built-in filtering. + +```console +unu -l 500 +``` + +This returned over 500 results which can then be filtered, for example, by June/23 expirations. There were thirty-four results. + +![Unusual Options](https://user-images.githubusercontent.com/85772166/234757578-da79b032-416b-4e0a-b759-a05f651f28a2.png) + +### Load + +Let's take a look at one of these tickers, GM. The default source will be `YahooFinance`. Select a different source by attaching `--source` to the command. + +```console +load gm +``` + +:::note +**This obtains the data for all the expirations, very long chains - like SPY - may take a few moments to load.** +::: + +```console +Getting Option Chain ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 100% 0:00:00 +Loaded option chain from YahooFinance +``` + +### PCR + +The `pcr` command plots a rolling put/call ratio (ten years max) over a selectable window of time (default is 30 days). + +```console +pcr -l 90 -s 2010-04-01 +``` + +![GM 90-Day P/C Ratio](https://user-images.githubusercontent.com/85772166/234757627-8250700b-1586-4535-948e-33d6ff18c4a2.png) + +Adding in an overlay from an exported CSV file adds more context to the story. + +```console +/stocks/load GM --start 2013-04-01 --monthly --export gm_monthly.csv +``` + +![GM 90-Day P/C Ratio Against Share Price](https://user-images.githubusercontent.com/85772166/234757705-0bc63a89-0cb8-4d32-a403-2a8aa7b0337a.png) + +### EXP + +After loading, select an expiration date for the chain using the `exp` command. To display the list of available expirations, use the function with no arguments. The date can be selected by entering a number - with `0` being the nearest expiry - or by entering the date, formatted as `YYYY-MM-DD`. + +```console +exp 2023-06-02 +``` + +```console +Expiration set to 2023-06-02 +``` + +### Plot + +Use the `plot` function to draw the volatility smile for the selected expiration date. + +```console +plot -c smile +``` + +![Volatility Smile](https://user-images.githubusercontent.com/85772166/234757758-537ada39-cf47-49e3-a861-b97c4b7a9919.png) + +### Greeks + +Calculate the second order Greeks - Rho, Phi, Charm, Vanna, Vomma - with the `greeks` command. + +```console +greeks --risk-free 4.8 --all +``` + +![Greeks Command](https://user-images.githubusercontent.com/85772166/234757813-c6a7b04f-3a20-4c7b-841b-1cd3fec7c088.png) + +![Second Order Greeks](https://user-images.githubusercontent.com/85772166/234757864-749ff78e-00c3-465a-b1b1-f4d0d2991c84.png) diff --git a/website/content/terminal/menus/stocks/screener.md b/website/content/terminal/menus/stocks/screener.md new file mode 100644 index 000000000000..0e39b9e4cd4d --- /dev/null +++ b/website/content/terminal/menus/stocks/screener.md @@ -0,0 +1,263 @@ +--- +title: Stock Screener +description: This comprehensive guide provides step-by-step instructions for using + the Stock Screener tool, an efficient way to discover stocks and narrow down investment + options. It includes details on various categories of stocks, detailed examples, + and preset parameters for customization. This guide also includes information on + how to view, set, and customize presets as per user preferences. +keywords: +- stock screener +- stock research +- stock statistics +- stock investing +- financial analytics +- preset parameters +- investment tool +- custom presets +- trading trends +- technical analysis +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +The Stock Screener is a diverse tool for discovering comapanies. It is a great jumping point for narrowing the universe of stocks at the beginning of a research workflow. Get to the screener from the `Stocks` menu by typing `scr`, and then pressing `enter`. There are six categories of statistics to sort the defined criteria by. + +- Overview +- Valuation +- Financial +- Ownership +- Performance +- Technical + +Running a screen is as easy as entering one of the choices above. + +### Presets + +The default preset upon entering the sub-menu is, `top_gainers`. This preset, like some of the others, contain no parameters other than a signal - the name of the preset - and has no corresponding file which can be edited. All signals are listed in the table below. Use the commands `view` and `set` to select a new one. + +| Preset and Signal Name | Description | +| :--------------------- | --------------------------------------------------------------------------: | +| top_gainers | stocks with the highest % price gain today | +| top_losers | stocks with the highest % price loss today | +| new_high | stocks making 52-week high today | +| new_low | stocks making 52-week low today | +| most_volatile | stocks with the highest widest high/low trading range today | +| most_active | stocks with the highest trading volume today | +| unusual_volume | stocks with unusually high volume today - the highest relative volume ratio | +| overbought | stock is becoming overvalued and may experience a pullback. | +| oversold | oversold stocks may represent a buying opportunity for investors | +| downgrades | stocks downgraded by analysts today | +| upgrades | stocks upgraded by analysts today | +| earnings_before | companies reporting earnings today, before market open | +| earnings_after | companies reporting earnings today, after market close | +| recent_insider_buying | stocks with recent insider buying activity | +| recent_insider_selling | stocks with recent insider selling activity | +| major_news | stocks with the highest news coverage today | +| horizontal_sr | horizontal channel of price range between support and resistance trendlines | +| tl_resistance | once a rising trendline is broken | +| tl_support | once a falling trendline is broken | +| wedge_up | upward trendline support and upward trendline resistance (reversal) | +| wedge_down | downward trendline support and downward trendline resistance (reversal) | +| wedge | upward trendline support, downward trendline resistance (contiunation) | +| triangle_ascending | upward trendline support and horizontal trendline resistance | +| triangle_descending | horizontal trendline support and downward trendline resistance | +| channel_up | both support and resistance trendlines slope upward | +| channel_down | both support and resistance trendlines slope downward | +| channel | both support and resistance trendlines are horizontal | +| double_top | stock with 'M' shape that indicates a bearish reversal in trend | +| double_bottom | stock with 'W' shape that indicates a bullish reversal in trend | +| multiple_top | same as double_top hitting more highs | +| multiple_bottom | same as double_bottom hitting more lows | +| head_shoulders | chart formation that predicts a bullish-to-bearish trend reversal | +| head_shoulders_inverse | chart formation that predicts a bearish-to-bullish trend reversal | + +These signals offer a good starting point, and results can be narrowed by creating a custom preset with defined parameters. Place new presets (which are text files saved as an `.ini` type) in the OpenBBUserData folder: `~/OpenBBUserData/presets/stocks/screener`. Files saved here will populate as a choice the next time the Terminal is launched. Changes to an existing file (same filename) are reflected the next time that screener preset is run, a restart is not required once the preset has been recognized. + +:::note Refer to the template file [here](https://github.com/OpenBB-finance/OpenBBTerminal/files/11153280/all_parameters.txt) for all of the available parameters and accepted values. + +::: + +Preset parameters are grouped into major categories: + +- [General] +- [Descriptive] +- [Fundamental] +- [Technical] + +The `General` category, for example, has two parameters: Order and Signal. The accepted values for both are listed below. + +```console +[General] +# Ticker, Company, Sector, Industry, Country, Market Cap., Price/Earnings, Forward Price/Earnings, +# PEG (Price/Earnings/Growth), Price/Sales, Price/Book, Price/Cash, Price/Free Cash Flow, Dividend Yield, Payout Ratio, +# EPS (ttm), EPS growth this year, EPS growth next year, EPS growth past 5 years, EPS growth next 5 years, +# Sales growth past 5 years, EPS growth qtr over qtr, Sales growth qtr over qtr, Shares Outstanding, Shares Float, +# Insider Ownership, Insider Transactions, Institutional Ownership, Institutional Transactions, Short Interest Share, +# Short Interest Ratio, Earnings Date, Return on Assets, Return on Equity, Return on Investment, Current Ratio, +# Quick Ratio, LT Debt/Equity, Total Debt/Equity, Gross Margin, Operating Margin, Net Profit Margin, +# Analyst Recommendation, Performance (Week), Performance (Month), Performance (Quarter), Performance (Half Year), +# Performance (Year), Performance (Year To Date), Beta, Average True Range, Volatility (Week), Volatility (Month), +# 20-Day SMA (Relative), 50-Day SMA (Relative), 200-Day SMA (Relative), 50-Day High (Relative), 50-Day Low (Relative), +# 52-Week High (Relative), 52-Week Low (Relative), Relative Strength Index (14), Average Volume (3 Month), +# Relative Volume, Change, Change from Open, Gap, Volume, Price, Target Price, IPO Date + +Order = Ticker + +# None (all stocks), Top Gainers, Top Losers, New High, New Low, Most Volatile, Most Active, Unusual Volume, Overbought, +# Oversold, Downgrades, Upgrades, Earnings Before, Earnings After, Recent Insider Buying, Recent Insider Selling, Major News, +# Horizontal S/R, TL Resistance, TL Support, Wedge Up, Wedge Down, Triangle Ascending, Triangle Descending, Wedge, Channel Up, +# Channel Down, Channel, Double Top, Double Bottom, Multiple Top, Multiple Bottom, Head & Shoulders, Head & Shoulders Inverse + +Signal = Top Gainers + +``` + +A new preset file should contain all four categories, even if no parameters are added. The example below is a minimalist example of how it should be structured. This preset is called, `djia_components`. + +```console +# Author of preset: OpenBB +# Description: Filter for the Dow Jones Industrial Average components. + +[General] + +[Descriptive] + +Index = DJIA + +[Fundamental] + +[Technical] +``` + +### Set + +To set the preset to be the example above, use the `set` command and press the spacebar. Use the up/down arrow keys to scroll through the presets. + +```console +set djia_components +``` + +With a preset selected, select the type of data to return by entering one of the six commands listed at the top of this guide. Each command returns a different set of columns which can be sorted by adding the optional `-s` argument, and selecting a choice populated by autocomplete. The results will display as a table. + +![Stocks Screener](https://user-images.githubusercontent.com/85772166/229921157-8297665a-1b88-4f4e-aeb1-91c1bb9aba7c.png) + +The next examples will demonstrate the expected outputs, and provide some context for getting started. + +### View + +See the specified parameters for a custom preset with the `view` function. + +```console +view -p bull_runs_over_10pct +``` + +```console + + - General - +Order : Ticker +Signal: Top Gainers + + + - Descriptive - + + + - Fundamental - + + + - Technical - +Performance: Today +10% +``` + +```console +view -p buffett_like +``` + +```console + - General - + + + - Descriptive - +Market Cap. : +Mid (over $2bln) +Dividend Yield: Positive (>0%) + + + - Fundamental - +EPS growthnext 5 years : Positive (>0%) +Debt/Equity : Under 0.5 +Price/Free Cash Flow : Under 50 +Sales growthpast 5 years: Positive (>0%) +Return on Investment : Over +15% +P/B : Under 3 + + + - Technical - + +``` + +Some presets contain only a signal, therefore there are no parameters to view. Any stock crossing the threshold for the signal will be returned. + +```console +view -p channel_up +``` + +```console +This preset contains no parameters other than the signal. +``` + +### S&P 500 Sector Components + +A series of presets are included that filter the S&P 500 constituents by sector. There are no parameters, so these presets simply return the components for comparison. + +![S&P 500](https://user-images.githubusercontent.com/85772166/229921343-605d0fbe-645f-4c69-83a9-a0034bc5c00e.png) + +```console +/stocks/scr/set -p sp500_financial_sector/performance +``` + +Columns can also be sorted, filtered, or rearranged from within the tables. + +![Screener Output](https://user-images.githubusercontent.com/85772166/229921470-ac5d9d9e-8489-45aa-9cc2-f0d8a156b172.png) + +Changes made to an existing preset will be reflected immediately, restarting is only necessary when adding a new file. The preset Financial Sector preset can be modified to filter only those companies with a Price-to-Book ratio of under 1. + +```console + +# Author of preset: OpenBB +# Description: Filter for the S&P 500 Financial Sector components. + +[General] + +[Descriptive] + +Index = S&P 500 +Sector = Financial + +[Fundamental] + +P/B = Under 1 + +[Technical] + +``` + +Open presets in any simple text editor, add the desired parameters, save the file, then run the command again. At the time of publication, twelve results were narrowed down from sixty-eight. All available parameters and settings are listed in the text file [here](https://github.com/OpenBB-finance/OpenBBTerminal/files/11153280/all_parameters.txt). + +![Financial Sector P/B Under 1](https://user-images.githubusercontent.com/85772166/229921644-ca14f08a-95f2-4ac3-8da3-49bbe4af3be4.png) + +### CA + +The tickers from the results of the last screen are stored in memory and can be taken into the [Comparison Analysis menu](/terminal/data-available/stocks/comparison) to undergo further scrutiny. + +![Screener Results](https://user-images.githubusercontent.com/85772166/229921889-3ce97436-a768-4a74-b312-e6070459e2a9.png) + +```console +set -p buffett_like +performance +? +ca +hcorr +``` + +![Correlation Matrix of Results](https://user-images.githubusercontent.com/85772166/229921977-fd31ff4c-d782-46fb-ba56-922cde5df8f0.png) diff --git a/website/content/terminal/menus/stocks/tradinghours.md b/website/content/terminal/menus/stocks/tradinghours.md new file mode 100644 index 000000000000..372e627c7ebf --- /dev/null +++ b/website/content/terminal/menus/stocks/tradinghours.md @@ -0,0 +1,55 @@ +--- +title: Trading Hours +description: This introduces the Trading Hours sub-menu, within the Stocks menu of the OpenBB Terminal. Use these commands to check the operating status of markets globally. +keywords: +- trading hours +- trading +- market hours +- open +- close +- bursa +- pandasmarketcalendars +- status +- holidays +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This set of features is for checking the operating status of markets globally. + +## Usage + +Enter, `th`, from the [`/stocks/`](/terminal/menus/stocks/introduction.md) menu. Or, with the absolute path: + +```console +/stocks/th +``` + +![Screenshot 2023-11-01 at 2 21 56 PM](https://github.com/OpenBB-finance/OpenBBTerminal/assets/85772166/66fe02c2-22d1-4ce3-a410-7df6f7f4defa) + +### Exchange + +Get the regular market hours and status of a particular exchange. + +```console +/stocks/th/exchange -n ASX +``` + +| | ASX | +|:----------------------|:--------------------------------------------------------------------------------------------------| +| name | Australian Securities Exchange | +| short_name | AX | +| website | https://www2.asx.com.au/markets/market-resources/trading-hours-calendar/cash-market-trading-hours | +| market_open | 10:00:00 | +| market_close | 16:00:00 | +| lunchbreak_start | | +| lunchbreak_end | | +| opening_auction_start | 07:00:00 | +| opening_auction_end | 10:00:00 | +| closing_auction_start | 16:10:00 | +| closing_auction_end | 16:12:00 | +| timezone | Australia/Sydney | +| flag | 🇦🇺 | +| open | False | diff --git a/website/versioned_docs/version-v3/terminal/reference/_category_.json b/website/content/terminal/reference/_category_.json similarity index 100% rename from website/versioned_docs/version-v3/terminal/reference/_category_.json rename to website/content/terminal/reference/_category_.json diff --git a/website/versioned_docs/version-v3/terminal/reference/alt/_category_.json b/website/content/terminal/reference/alt/_category_.json similarity index 100% rename from website/versioned_docs/version-v3/terminal/reference/alt/_category_.json rename to website/content/terminal/reference/alt/_category_.json diff --git a/website/versioned_docs/version-v3/terminal/reference/alt/covid/_category_.json b/website/content/terminal/reference/alt/covid/_category_.json similarity index 100% rename from website/versioned_docs/version-v3/terminal/reference/alt/covid/_category_.json rename to website/content/terminal/reference/alt/covid/_category_.json diff --git a/website/content/terminal/reference/alt/covid/cases.md b/website/content/terminal/reference/alt/covid/cases.md new file mode 100644 index 000000000000..0a6368244004 --- /dev/null +++ b/website/content/terminal/reference/alt/covid/cases.md @@ -0,0 +1,35 @@ +--- +title: cases +description: A detailed guide on how to use the 'cases' command to show historical + cases for any country. This command is simple to use as it doesn't need any parameters, + offering a straightforward solution for data visualization. +keywords: +- historical cases +- country cases +- cases command +- no parameters +- data visualization +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Show historical cases for country. + +### Usage + +```python +cases +``` + +--- + +## Parameters + +This command has no parameters + + +![cases](https://user-images.githubusercontent.com/46355364/153897646-99e4f73f-be61-4ed7-a31d-58e8695e7c50.png) + +--- diff --git a/website/content/terminal/reference/alt/covid/country.md b/website/content/terminal/reference/alt/covid/country.md new file mode 100644 index 000000000000..690b7e4b5fec --- /dev/null +++ b/website/content/terminal/reference/alt/covid/country.md @@ -0,0 +1,32 @@ +--- +title: country +description: This page provides information on how to select a country to look at + its data. It displays detailed analysis and parameters for each country. +keywords: +- Country Data +- Parameters +- Country Selection +- Data Selection +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Select a country to look at data for. + +### Usage + +```python +country [-c country_name] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| country | Country to get data for. | None | True | suriname, qatar, romania, cabo_verde, malawi, micronesia, belarus, denmark, fiji, cambodia, madagascar, saint_vincent_and_the_grenadines, paraguay, eritrea, barbados, ethiopia, laos, zimbabwe, lithuania, comoros, namibia, spain, papua_new_guinea, central_african_republic, honduras, equatorial_guinea, botswana, canada, italy, jordan, chad, czechia, uzbekistan, azerbaijan, poland, us, el_salvador, ghana, kiribati, kuwait, senegal, holy_see, mauritius, oman, sierra_leone, zambia, nigeria, kosovo, brunei, china, gabon, seychelles, guatemala, somalia, peru, sao_tome_and_principe, sweden, pakistan, moldova, togo, niger, ukraine, sudan, trinidad_and_tobago, netherlands, philippines, australia, burkina_faso, tajikistan, united_arab_emirates, kyrgyzstan, costa_rica, portugal, mozambique, mauritania, timor-leste, vietnam, montenegro, guyana, mongolia, bahrain, cameroon, palau, jamaica, new_zealand, iraq, mali, saint_kitts_and_nevis, brazil, belgium, maldives, egypt, panama, rwanda, israel, russia, nicaragua, switzerland, kazakhstan, guinea-bissau, albania, thailand, cuba, uruguay, liechtenstein, bosnia_and_herzegovina, haiti, andorra, taiwan*, dominica, congo_(kinshasa), ecuador, malta, vanuatu, dominican_republic, lesotho, morocco, west_bank_and_gaza, lebanon, south_sudan, armenia, afghanistan, grenada, indonesia, sri_lanka, iran, bolivia, luxembourg, north_macedonia, cyprus, iceland, serbia, greece, united_kingdom, georgia, saint_lucia, venezuela, austria, tonga, saudi_arabia, argentina, summer_olympics_2020, angola, algeria, latvia, yemen, singapore, turkey, belize, burundi, ireland, south_africa, bulgaria, india, diamond_princess, cote_d'ivoire, libya, slovenia, benin, djibouti, congo_(brazzaville), tunisia, nepal, bahamas, bhutan, colombia, hungary, malaysia, germany, tanzania, samoa, san_marino, syria, liberia, korea,_south, uganda, gambia, marshall_islands, kenya, finland, bangladesh, eswatini, slovakia, burma, ms_zaandam, japan, guinea, monaco, mexico, solomon_islands, estonia, chile, croatia, antigua_and_barbuda, norway, france, all | + +--- diff --git a/website/content/terminal/reference/alt/covid/deaths.md b/website/content/terminal/reference/alt/covid/deaths.md new file mode 100644 index 000000000000..40cd95537c70 --- /dev/null +++ b/website/content/terminal/reference/alt/covid/deaths.md @@ -0,0 +1,35 @@ +--- +title: deaths +description: This page provides access to historical deaths data per country. It explains + the usage of the 'deaths' command, which requires no parameters and presents the + data in a visual format. +keywords: +- Death statistics +- Historical deaths +- Country wise death rate +- Death data visualization +- Countries death data +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Show historical deaths by country. + +### Usage + +```python +deaths +``` + +--- + +## Parameters + +This command has no parameters + + +![deaths](https://user-images.githubusercontent.com/46355364/153897766-73a8e2ee-c4e6-40d3-a65d-8b116efdacfa.png) + +--- diff --git a/website/content/terminal/reference/alt/covid/ov.md b/website/content/terminal/reference/alt/covid/ov.md new file mode 100644 index 000000000000..f1cb1841665c --- /dev/null +++ b/website/content/terminal/reference/alt/covid/ov.md @@ -0,0 +1,34 @@ +--- +title: ov +description: This ov page includes historical cases and deaths by country, along with + usage instructions and on-page parameters. +keywords: +- ov +- historical cases +- deaths by country +- usage +- parameters +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Show historical cases and deaths by country. + +### Usage + +```python +ov +``` + +--- + +## Parameters + +This command has no parameters + + +![ov](https://user-images.githubusercontent.com/46355364/153897893-52f7649a-90ba-4dca-bfe7-75839ce7ec2e.png) + +--- diff --git a/website/content/terminal/reference/alt/covid/rates.md b/website/content/terminal/reference/alt/covid/rates.md new file mode 100644 index 000000000000..a1f0470e983f --- /dev/null +++ b/website/content/terminal/reference/alt/covid/rates.md @@ -0,0 +1,34 @@ +--- +title: rates +description: The 'rates' page in our documentation provides insights on how to access + historical death and case rates for a given country using our data visualization + tool. No parameters are required. +keywords: +- Rates documentation +- Historical death rates +- Country cases rates +- Data visualization +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Show historical death/cases rates for a country. + +### Usage + +```python +rates +``` + +--- + +## Parameters + +This command has no parameters + + +![rates](https://user-images.githubusercontent.com/46355364/153898007-a051dc1c-4b03-4c3c-ae72-c61da8f732ff.png) + +--- diff --git a/website/content/terminal/reference/alt/covid/slopes.md b/website/content/terminal/reference/alt/covid/slopes.md new file mode 100644 index 000000000000..df75a5337bd7 --- /dev/null +++ b/website/content/terminal/reference/alt/covid/slopes.md @@ -0,0 +1,40 @@ +--- +title: slopes +description: This page offers information on the 'slopes' Python function, which displays + the countries with the highest slope values. You can customize the data displayed + with parameters such as 'days back', 'reverse' for sorting options, and 'threshold' + for total cases. +keywords: +- slope +- data sorting +- data analysis +- cases threshold +- ascending +- descending +- reverse +- days back +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Show countries with highest slopes. + +### Usage + +```python +slopes [-d DAYS] [-r] [-t THRESHOLD] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| days | Number of days back to look | 30 | True | None | +| reverse | Data is sorted in descending order by default. Reverse flag will sort it in an ascending way. Only works when raw data is displayed. | False | True | None | +| threshold | Threshold for total cases over period | 10000 | True | None | + +--- diff --git a/website/versioned_docs/version-v3/terminal/reference/alt/oss/_category_.json b/website/content/terminal/reference/alt/oss/_category_.json similarity index 100% rename from website/versioned_docs/version-v3/terminal/reference/alt/oss/_category_.json rename to website/content/terminal/reference/alt/oss/_category_.json diff --git a/website/content/terminal/reference/alt/oss/rossidx.md b/website/content/terminal/reference/alt/oss/rossidx.md new file mode 100644 index 000000000000..1847c8e61395 --- /dev/null +++ b/website/content/terminal/reference/alt/oss/rossidx.md @@ -0,0 +1,47 @@ +--- +title: rossidx +description: This page provides detailed instructions on how to use the rossidx command + in Python to sort and display information about startups from the Ross Index. Users + can sort by various criteria (e.g. GitHub Stars, Company, Country), display charts, + and set the chart type to 'stars' or 'forks'. +keywords: +- rossidx +- startups +- chart +- stars +- forks +- sorting +- growth chart +- GitHub +- company +- country +- city +- founded +- raised money +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Display list of startups from ross index [Source: https://runacap.com/] Use --chart to display chart and -t {stars,forks} to set chart type + +### Usage + +```python +rossidx [-s SORTBY [SORTBY ...]] [-r] [-c] [-g] [-t {stars,forks}] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| sortby | Sort startups by column | Stars AGR [%] | True | GitHub, Company, Country, City, Founded, Raised [$M], Stars, Forks, Stars AGR [%], Forks AGR [%] | +| reverse | Data is sorted in descending order by default. Reverse flag will sort it in an ascending way. Only works when raw data is displayed. | False | True | None | +| show_chart | Flag to show chart | False | True | None | +| show_growth | Flag to show growth chart | False | True | None | +| chart_type | Chart type: {stars, forks} | stars | True | stars, forks | + +--- diff --git a/website/content/terminal/reference/alt/oss/rs.md b/website/content/terminal/reference/alt/oss/rs.md new file mode 100644 index 000000000000..b4bdd9d6b405 --- /dev/null +++ b/website/content/terminal/reference/alt/oss/rs.md @@ -0,0 +1,34 @@ +--- +title: rs +description: Learn how to display a repository summary by using the rs command. A + simple guide to understanding the rs usage and its parameters. Source code is available + on Github. +keywords: +- repo summary +- repository +- rs command +- Github +- openbb-finance/openbbterminal +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Display a repo summary [Source: https://api.github.com] + +### Usage + +```python +rs -r REPO +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| repo | Repository to search for repo summary. Format: org/repo, e.g., openbb-finance/openbbterminal | None | False | None | + +--- diff --git a/website/content/terminal/reference/alt/oss/sh.md b/website/content/terminal/reference/alt/oss/sh.md new file mode 100644 index 000000000000..0b5d303076c3 --- /dev/null +++ b/website/content/terminal/reference/alt/oss/sh.md @@ -0,0 +1,33 @@ +--- +title: sh +description: The page provides instructions on using the 'sh' command to view a repository's + star history on GitHub. The usage and parameters are clearly detailed. +keywords: +- repo star history +- sh command usage +- GitHub +- repository search +- openbb-finance/openbbterminal +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Display a repo star history [Source: https://api.github.com] + +### Usage + +```python +sh -r REPO +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| repo | Repository to search for star history. Format: org/repo, e.g., openbb-finance/openbbterminal | None | False | None | + +--- diff --git a/website/content/terminal/reference/alt/oss/tr.md b/website/content/terminal/reference/alt/oss/tr.md new file mode 100644 index 000000000000..e1e454fcb633 --- /dev/null +++ b/website/content/terminal/reference/alt/oss/tr.md @@ -0,0 +1,41 @@ +--- +title: tr +description: Documentation on how to display top repositories using the GitHub API. + Instructions include usage, parameters details, and examples. The user can sort + the repos by stars or forks, and can filter by repo categories. +keywords: +- top repositories +- github api +- parameters +- stars +- forks +- repo categories +- filter +- sort +- usage +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Display top repositories [Source: https://api.github.com] + +### Usage + +```python +tr [-s {stars,forks}] [-c CATEGORIES] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| sortby | Sort repos by {stars, forks}. Default: stars | stars | True | stars, forks | +| categories | Filter by repo categories. If more than one separate with a comma: e.g., finance,investment | | True | None | + +![cases](https://user-images.githubusercontent.com/46355364/153897646-99e4f73f-be61-4ed7-a31d-58e8695e7c50.png) + +--- diff --git a/website/versioned_docs/version-v3/terminal/reference/crypto/_category_.json b/website/content/terminal/reference/crypto/_category_.json similarity index 100% rename from website/versioned_docs/version-v3/terminal/reference/crypto/_category_.json rename to website/content/terminal/reference/crypto/_category_.json diff --git a/website/content/terminal/reference/crypto/candle.md b/website/content/terminal/reference/crypto/candle.md new file mode 100644 index 000000000000..60204900563d --- /dev/null +++ b/website/content/terminal/reference/crypto/candle.md @@ -0,0 +1,36 @@ +--- +title: candle +description: This page provides documentation on using the 'candle' feature for displaying + charts for loaded coins in the chosen currency and date range. It includes usage + instructions and details about parameters. +keywords: +- candle feature +- coin chart +- currency chart +- date range chart +- logy parameter +- log scale chart +- docusaurus page SEO +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Display chart for loaded coin. You can specify currency vs which you want to show chart and also number of days to get data for. + +### Usage + +```python +candle [--log] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| logy | Plot with y axis on log scale | False | True | None | + +--- diff --git a/website/versioned_docs/version-v3/terminal/reference/crypto/dd/_category_.json b/website/content/terminal/reference/crypto/dd/_category_.json similarity index 100% rename from website/versioned_docs/version-v3/terminal/reference/crypto/dd/_category_.json rename to website/content/terminal/reference/crypto/dd/_category_.json diff --git a/website/content/terminal/reference/crypto/dd/active.md b/website/content/terminal/reference/crypto/dd/active.md new file mode 100644 index 000000000000..aeb9a02c8acd --- /dev/null +++ b/website/content/terminal/reference/crypto/dd/active.md @@ -0,0 +1,40 @@ +--- +title: active +description: This page provides information on how to display active blockchain addresses + over time including usage, parameters and visualization. The data source is Glassnode. +keywords: +- Blockchain +- Addresses +- Active +- Glassnode +- Data visualization +- Frequency Interval +- Initial Date +- Final Date +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Display active blockchain addresses over time [Source: https://glassnode.org] + +### Usage + +```python +active [-i {24h,1w,1month}] [-s SINCE] [-u UNTIL] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| interval | Frequency interval. Default: 24h | 24h | True | 24h, 1w, 1month | +| since | Initial date. Default: 1 year ago | 2021-11-25 | True | None | +| until | Final date. Default: Today | 2022-11-25 | True | None | + +![active](https://user-images.githubusercontent.com/46355364/154058739-e30fed47-c86f-4aef-a699-1bc69180c607.png) + +--- diff --git a/website/versioned_docs/version-v3/terminal/reference/crypto/dd/ath.md b/website/content/terminal/reference/crypto/dd/ath.md similarity index 81% rename from website/versioned_docs/version-v3/terminal/reference/crypto/dd/ath.md rename to website/content/terminal/reference/crypto/dd/ath.md index 13e55d12ba35..06befb8ad271 100644 --- a/website/versioned_docs/version-v3/terminal/reference/crypto/dd/ath.md +++ b/website/content/terminal/reference/crypto/dd/ath.md @@ -1,9 +1,20 @@ --- title: ath -description: OpenBB Terminal Function +description: This documentation is about the All Time High (ATH) function for a crypto + coin or token. A user can load coin data and see the highest price (in USD or BTC) + that coin has ever reached. +keywords: +- all time high +- crypto coin +- load coin data +- highest price +- price in USD +- price in BTC --- -# ath +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + All time high data for loaded coin diff --git a/website/versioned_docs/version-v3/terminal/reference/crypto/dd/atl.md b/website/content/terminal/reference/crypto/dd/atl.md similarity index 78% rename from website/versioned_docs/version-v3/terminal/reference/crypto/dd/atl.md rename to website/content/terminal/reference/crypto/dd/atl.md index 0e4b33ae9947..5150cba7fdc1 100644 --- a/website/versioned_docs/version-v3/terminal/reference/crypto/dd/atl.md +++ b/website/content/terminal/reference/crypto/dd/atl.md @@ -1,9 +1,25 @@ --- title: atl -description: OpenBB Terminal Function +description: The 'atl' command page provides information on how to retrieve all time + low data for a specific cryptocurrency coin. The page includes instructions, parameters, + and examples of usage. +keywords: +- Cryptocurrency +- Coin data +- All time low +- ATL command +- cryptocurrency data retrieval +- crypto lows +- data commands +- crypto commands +- bitcoin +- ethereum +- crypto market data --- -# atl +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + All time low data for loaded coin diff --git a/website/content/terminal/reference/crypto/dd/balance.md b/website/content/terminal/reference/crypto/dd/balance.md new file mode 100644 index 000000000000..6c30c1e8d9f3 --- /dev/null +++ b/website/content/terminal/reference/crypto/dd/balance.md @@ -0,0 +1,35 @@ +--- +title: balance +description: This page provides a detailed guide on how to display balance using a + Python script. It features usage instructions, parameter descriptions, and particularities + with the 'vs' parameter representing the quote currency. +keywords: +- balance +- coin +- currency +- USDT +- python script +- quote currency +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Display balance + +### Usage + +```python +balance [--vs VS] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| vs | Quote currency (what to view coin vs) | USDT | True | None | + +--- diff --git a/website/content/terminal/reference/crypto/dd/basic.md b/website/content/terminal/reference/crypto/dd/basic.md new file mode 100644 index 000000000000..f6b2fc55e67c --- /dev/null +++ b/website/content/terminal/reference/crypto/dd/basic.md @@ -0,0 +1,74 @@ +--- +title: basic +description: The page provides extensive information on how to use the 'basic' function + in the cryptocurrency realm to extract key details of a coin such as its name, symbol, + rank, type, description, platform, proof_type, tags, contract and parent. Contains + usage instructions and examples. +keywords: +- crypto +- coin information +- python crypto commands +- cryptocurrency +- bitcoin +- function usage +- crypto function +- basic +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Get basic information for coin. Like: name, symbol, rank, type, description, platform, proof_type, contract, tags, parent + +### Usage + +```python +basic +``` + +--- + +## Parameters + +This command has no parameters + + + +--- + +## Examples + +```python +2022 Feb 15, 07:10 (🦋) /crypto/dd/ $ basic + Basic Coin Information +┌─────────────┬───────────────────────────────────────────────────────────────────────────────┐ +│ Metric │ Value │ +├─────────────┼───────────────────────────────────────────────────────────────────────────────┤ +│ id │ btc-bitcoin │ +├─────────────┼───────────────────────────────────────────────────────────────────────────────┤ +│ name │ Bitcoin │ +├─────────────┼───────────────────────────────────────────────────────────────────────────────┤ +│ symbol │ BTC │ +├─────────────┼───────────────────────────────────────────────────────────────────────────────┤ +│ rank │ 1 │ +├─────────────┼───────────────────────────────────────────────────────────────────────────────┤ +│ type │ coin │ +├─────────────┼───────────────────────────────────────────────────────────────────────────────┤ +│ description │ Bitcoin is a cryptocurrency and worldwide payment system. It is the first │ +│ │ decentralized digital currency, as the system works without a central bank or │ +│ │ single administrator. │ +├─────────────┼───────────────────────────────────────────────────────────────────────────────┤ +│ platform │ bnb-binance-coin │ +├─────────────┼───────────────────────────────────────────────────────────────────────────────┤ +│ proof_type │ Proof of Work │ +├─────────────┼───────────────────────────────────────────────────────────────────────────────┤ +│ contract │ 0x719bd7b3d60f0b194fdbe4570aeda1b3712b4986 │ +├─────────────┼───────────────────────────────────────────────────────────────────────────────┤ +│ tags │ Segwit, Cryptocurrency, Proof Of Work, Payments, Sha256, Mining, Lightning │ +│ │ Network │ +├─────────────┼───────────────────────────────────────────────────────────────────────────────┤ +│ parent │ bnb-binance-coin │ +└─────────────┴───────────────────────────────────────────────────────────────────────────────┘ +``` +--- diff --git a/website/content/terminal/reference/crypto/dd/bc.md b/website/content/terminal/reference/crypto/dd/bc.md new file mode 100644 index 000000000000..474f898f5f26 --- /dev/null +++ b/website/content/terminal/reference/crypto/dd/bc.md @@ -0,0 +1,56 @@ +--- +title: bc +description: Documentation for the 'bc' command in a blockchain context - provides + URLs for loaded coins on various blockchain explorer sites like etherscan.io or + polkascan.io for analysing blockchain data. +keywords: +- blockchain +- blockchain explorers +- blockchain URLs +- etherescan.io +- polkascan.io +- blockchain data +- crypto +- btc.com +- tokenview.com +- blockchair.com +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Blockchain explorers URLs for loaded coin. Those are sites like etherescan.io or polkascan.io in which you can see all blockchain data e.g. all txs, all tokens, all contracts... + +### Usage + +```python +bc +``` + +--- + +## Parameters + +This command has no parameters + + + +--- + +## Examples + +```python +2022 Feb 15, 07:10 (🦋) /crypto/dd/ $ bc + Blockchain URLs +┌────────┬─────────────────────────────────┐ +│ Metric │ Value │ +├────────┼─────────────────────────────────┤ +│ 0 │ https://blockchair.com/bitcoin/ │ +├────────┼─────────────────────────────────┤ +│ 1 │ https://btc.com/ │ +├────────┼─────────────────────────────────┤ +│ 2 │ https://btc.tokenview.com/ │ +└────────┴─────────────────────────────────┘ +``` +--- diff --git a/website/content/terminal/reference/crypto/dd/change.md b/website/content/terminal/reference/crypto/dd/change.md new file mode 100644 index 000000000000..b8b713500657 --- /dev/null +++ b/website/content/terminal/reference/crypto/dd/change.md @@ -0,0 +1,54 @@ +--- +title: change +description: A detailed guide on how to use the 'change' command for tracking active + blockchain addresses over time in various exchanges. It also provides instructions + on setting input parameters and explains their usage for more precise data. +keywords: +- blockchain +- active blockchain addresses +- tracking blockchain +- change command +- exchange platform +- blockchain data tracking +- data fetching +- data commands +- coinex +- bittrex +- binance +- poloniex +- blockchain analytics +- glassnode source +- command parameters +- bitfinex +- kraken +- okex +- bithumb +- coinbase +- luno +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Display active blockchain addresses over time [Source: https://glassnode.org] Note that free api keys only allow fetching data with a 1y lag + +### Usage + +```python +change [-e {aggregated,binance,bittrex,coinex,gate.io,gemini,huobi,kucoin,poloniex,bibox,bigone,bitfinex,hitbtc,kraken,okex,bithumb,zb.com,cobinhood,bitmex,bitstamp,coinbase,coincheck,luno}] [-s SINCE] [-u UNTIL] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| exchange | Exchange to check change. Default: aggregated | aggregated | True | aggregated, binance, bittrex, coinex, gate.io, gemini, huobi, kucoin, poloniex, bibox, bigone, bitfinex, hitbtc, kraken, okex, bithumb, zb.com, cobinhood, bitmex, bitstamp, coinbase, coincheck, luno | +| since | Initial date. Default: 2 years ago | 2020-11-25 | True | None | +| until | Final date. Default: 1 year ago | 2021-11-23 | True | None | + +![change](https://user-images.githubusercontent.com/46355364/154060004-c5367c72-d25b-48da-a316-35d8d6e5208e.png) + +--- diff --git a/website/content/terminal/reference/crypto/dd/desc.md b/website/content/terminal/reference/crypto/dd/desc.md new file mode 100644 index 000000000000..b5e676754710 --- /dev/null +++ b/website/content/terminal/reference/crypto/dd/desc.md @@ -0,0 +1,63 @@ +--- +title: desc +description: Informative project description utility for numerous blockchain projects + with parameters such as 'project of interest'. The page informs about the metadata + and application of the tool across different use cases. +keywords: +- docusaurus +- project description +- blockchain +- crypto projects +- metadata +- usage +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Display project description [Source: Token Terminal] + +### Usage + +```python +desc -p {0x,1inch,88mph,aave,abracadabra-money,alchemist,alchemix-finance,algorand,alpha-finance,arweave,autofarm,avalanche,axie-infinity,balancer,bancor,barnbridge,basket-dao,benqi,binance-smart-chain,bitcoin,cap,cardano,centrifuge,clipper,compound,convex-finance,cosmos,cryptex,curve,decentral-games,decred,dforce,dhedge,dodo,dogecoin,dydx,ellipsis-finance,elrond,enzyme-finance,erasure-protocol,ethereum,ethereum-name-service,euler,fantom,fei-protocol,filecoin,futureswap,gmx,goldfinch,harvest-finance,helium,hurricaneswap,idle-finance,index-cooperative,instadapp,integral-protocol,karura,keeperdao,keep-network,kusama,kyber,lido-finance,liquity,litecoin,livepeer,looksrare,loopring,maiar,makerdao,maple-finance,mcdex,metamask,mstable,near-protocol,nexus-mutual,nftx,notional-finance,opensea,optimism,osmosis,pancakeswap,pangolin,perpetual-protocol,piedao,pocket-network,polkadot,polygon,polymarket,pooltogether,powerpool,quickswap,rarible,rari-capital,reflexer,ren,ribbon-finance,rocket-pool,saddle-finance,set-protocol,solana,solend,spookyswap,stake-dao,stellar,sushiswap,synthetix,terra,tezos,the-graph,thorchain,tokemak,tokenlon,tornado-cash,trader-joe,uma,uniswap,unit-protocol,venus,vesper-finance,volmex,wakaswap,yearn-finance,yield-guild-games,yield-yak,zcash,zora} +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| project | Choose project of interest | None | False | 0x, 1inch, 88mph, aave, abracadabra-money, alchemist, alchemix-finance, algorand, alpha-finance, arweave, autofarm, avalanche, axie-infinity, balancer, bancor, barnbridge, basket-dao, benqi, binance-smart-chain, bitcoin, cap, cardano, centrifuge, clipper, compound, convex-finance, cosmos, cryptex, curve, decentral-games, decred, dforce, dhedge, dodo, dogecoin, dydx, ellipsis-finance, elrond, enzyme-finance, erasure-protocol, ethereum, ethereum-name-service, euler, fantom, fei-protocol, filecoin, futureswap, gmx, goldfinch, harvest-finance, helium, hurricaneswap, idle-finance, index-cooperative, instadapp, integral-protocol, karura, keeperdao, keep-network, kusama, kyber, lido-finance, liquity, litecoin, livepeer, looksrare, loopring, maiar, makerdao, maple-finance, mcdex, metamask, mstable, near-protocol, nexus-mutual, nftx, notional-finance, opensea, optimism, osmosis, pancakeswap, pangolin, perpetual-protocol, piedao, pocket-network, polkadot, polygon, polymarket, pooltogether, powerpool, quickswap, rarible, rari-capital, reflexer, ren, ribbon-finance, rocket-pool, saddle-finance, set-protocol, solana, solend, spookyswap, stake-dao, stellar, sushiswap, synthetix, terra, tezos, the-graph, thorchain, tokemak, tokenlon, tornado-cash, trader-joe, uma, uniswap, unit-protocol, venus, vesper-finance, volmex, wakaswap, yearn-finance, yield-guild-games, yield-yak, zcash, zora | + + +--- + +## Examples + +```python +2022 Aug 28, 19:09 (🦋) /crypto/dd/ $ desc cardano +HOW + Validators process transactions and receive fees from users (supply-side revenue). + +WHO + ADA holders own and govern the protocol. They currently do not take a cut of the total transaction fees paid by users (protocol revenue). + +WHAT + Cardano is a smart contract platform for decentralized applications (a blockchain). Cardano was founded by Charles Hoskinson & Jeremy Wood and launched in 2017. + +FUNDING + Cardano has raised approx. $62.2M. + +COMPETITION + Smart contract platforms such as Cosmos, Ethereum, Tezos, etc. + +BUSINESS MODEL + Cardano is a smart contract platform for dApps. + +GITHUB CONTRIBUTORS + 533 +``` +--- diff --git a/website/versioned_docs/version-v3/terminal/reference/crypto/dd/dev.md b/website/content/terminal/reference/crypto/dd/dev.md similarity index 75% rename from website/versioned_docs/version-v3/terminal/reference/crypto/dd/dev.md rename to website/content/terminal/reference/crypto/dd/dev.md index 4290c7756c4d..fe82c0e06c18 100644 --- a/website/versioned_docs/version-v3/terminal/reference/crypto/dd/dev.md +++ b/website/content/terminal/reference/crypto/dd/dev.md @@ -1,9 +1,29 @@ --- title: dev -description: OpenBB Terminal Function +description: This page provides a comprehensive guide to our dev command, which gives + insights into the development data of a specific loaded coin. The command includes + useful statistics like the number of forks, stars, subscribers, pull requests, merges, + etc. on Github. +keywords: +- developers data +- loaded coin +- github statistics +- crypto command +- crypto tool +- software development +- code development +- pull request +- commits +- forks +- merges +- contributors +- subscribers +- stars --- -# dev +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + Developers data for loaded coin. If the development data is available you can see how the code development of given coin is going on. There are some statistics that shows number of stars, forks, subscribers, pull requests, commits, merges, contributors on github. diff --git a/website/content/terminal/reference/crypto/dd/eb.md b/website/content/terminal/reference/crypto/dd/eb.md new file mode 100644 index 000000000000..32412ac810f6 --- /dev/null +++ b/website/content/terminal/reference/crypto/dd/eb.md @@ -0,0 +1,39 @@ +--- +title: eb +description: The eb page provides information on how to display active blockchain + addresses over time using different exchanges. It also includes details on parameters + such as the initial and final dates for fetching data. +keywords: +- blockchain addresses +- data fetching +- api keys +- exchanges +- parameters +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Display active blockchain addresses over time [Source: https://glassnode.org] Note that free api keys only allow fetching data with a 1y lag + +### Usage + +```python +eb [-p] [-e {aggregated,binance,bittrex,coinex,gate.io,gemini,huobi,kucoin,poloniex,bibox,bigone,bitfinex,hitbtc,kraken,okex,bithumb,zb.com,cobinhood,bitmex,bitstamp,coinbase,coincheck,luno}] [-s SINCE] [-u UNTIL] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| percentage | Show percentage instead of stacked value. Default: False | False | True | None | +| exchange | Exchange to check change. Default: aggregated | aggregated | True | aggregated, binance, bittrex, coinex, gate.io, gemini, huobi, kucoin, poloniex, bibox, bigone, bitfinex, hitbtc, kraken, okex, bithumb, zb.com, cobinhood, bitmex, bitstamp, coinbase, coincheck, luno | +| since | Initial date. Default: 2 years ago | 2020-11-25 | True | None | +| until | Final date. Default: 1 year ago | 2021-11-23 | True | None | + +![eb](https://user-images.githubusercontent.com/46355364/154060160-3102de99-bed7-4e3b-bc98-81c684eefcb0.png) + +--- diff --git a/website/content/terminal/reference/crypto/dd/events.md b/website/content/terminal/reference/crypto/dd/events.md new file mode 100644 index 000000000000..f64eb127c281 --- /dev/null +++ b/website/content/terminal/reference/crypto/dd/events.md @@ -0,0 +1,79 @@ +--- +title: events +description: This is a docusaurus page dedicated to the events tool which displays + the most important events of cryptocurrency coins. It presents multiple functionalities + such as sorting and limiting the amount of events displayed, with additional features + like displaying urls for each event. +keywords: +- cryptocurrency +- events +- coins +- limit +- sort +- ascending order +- descending order +- urls +- docusaurus +- crypto tool +- crypto events +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Show information about most important coins events. Most of coins doesn't have any events. You can display only top N number of events with --limit parameter. You can sort data by id, date , date_to, name, description, is_conference --sort parameter and also with --reverse flag to sort ascending. You can use additional flag --urls to see urls for each event Displays: date , date_to, name, description, is_conference, link, proof_image_link + +### Usage + +```python +events [-l LIMIT] [-s {date,date_to,name,description,is_conference}] [-r] [-u] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| limit | Limit of records | 10 | True | None | +| sortby | Sort by given column. Default: date | date | True | date, date_to, name, description, is_conference | +| reverse | Data is sorted in descending order by default. Reverse flag will sort it in an ascending way. Only works when raw data is displayed. | False | True | None | +| urls | Flag to show urls. If you will use that flag you will see only date, name, link columns | False | True | None | + + +--- + +## Examples + +```python +2022 Feb 15, 07:14 (🦋) /crypto/dd/ $ events + All Events +┌────────────┬────────────┬────────────────────────────────────────────────────────────────────────────────────────────────────────┬─────────────────────────────────────────┬───────────────┐ +│ date │ date_to │ name │ description │ is_conference │ +├────────────┼────────────┼────────────────────────────────────────────────────────────────────────────────────────────────────────┼─────────────────────────────────────────┼───────────────┤ +│ 2021-06-11 │ None │ Ask El Salvador for advice: Cuba suspends dollar cash deposits in banks due to US sanctions │ │ False │ +│ 00:00:00 │ │ │ │ │ +├────────────┼────────────┼────────────────────────────────────────────────────────────────────────────────────────────────────────┼─────────────────────────────────────────┼───────────────┤ +│ 2021-06-11 │ None │ One of the Richest Bitcoin Whales in History Bought $138,000,000 in BTC Amid Market Turmoil – AronBoss │ │ False │ +│ 00:00:00 │ │ │ │ │ +├────────────┼────────────┼────────────────────────────────────────────────────────────────────────────────────────────────────────┼─────────────────────────────────────────┼───────────────┤ +│ 2021-05-10 │ None │ Bitcoin’s upcoming Taproot upgrade and why it matters for the network │ │ False │ +│ 00:00:00 │ │ │ │ │ +├────────────┼────────────┼────────────────────────────────────────────────────────────────────────────────────────────────────────┼─────────────────────────────────────────┼───────────────┤ +│ 2021-03-24 │ 2021-03-26 │ THE CRYPTO GATHERING │ │ False │ +│ 08:00:00 │ 23:00:00 │ │ │ │ +├────────────┼────────────┼────────────────────────────────────────────────────────────────────────────────────────────────────────┼─────────────────────────────────────────┼───────────────┤ +│ 2018-10-09 │ 2018-10-09 │ Blockchain & Bitcoin Conference Switzerland │ The second conference organized by │ True │ +│ 09:00:00 │ 18:00:00 │ │ Smile-Expo company in Geneva, the │ │ +│ │ │ │ European fintech hub. The conference │ │ +│ │ │ │ will also feature the demozone. │ │ +├────────────┼────────────┼────────────────────────────────────────────────────────────────────────────────────────────────────────┼─────────────────────────────────────────┼───────────────┤ +│ 2018-09-28 │ 2018-09-30 │ Super Conference │ KWIC, Kitchener - Waterloo, ON, Canada. │ True │ +│ 20:00:00 │ 16:00:00 │ │ 29 September, 2018 │ │ +├────────────┼────────────┼────────────────────────────────────────────────────────────────────────────────────────────────────────┼─────────────────────────────────────────┼───────────────┤ +│ 2018-07-10 │ None │ SEC- ETF VanEck decision │ │ False │ +│ 12:00:00 │ │ │ │ │ +└────────────┴────────────┴────────────────────────────────────────────────────────────────────────────────────────────────────────┴─────────────────────────────────────────┴───────────────┘ +``` +--- diff --git a/website/content/terminal/reference/crypto/dd/ex.md b/website/content/terminal/reference/crypto/dd/ex.md new file mode 100644 index 000000000000..5dfe74c5983c --- /dev/null +++ b/website/content/terminal/reference/crypto/dd/ex.md @@ -0,0 +1,44 @@ +--- +title: ex +description: An in-depth guide to using the 'ex' command to retrieve and manipulate + data from various crypto exchanges. Learn how to limit query results, sort data + by important parameters such as id and volume, and switch between ascending and + descending order. +keywords: +- exchanges +- coin +- crypto +- parameters +- sorted data +- ascend +- descend +- limit +- fiats +- id +- name +- adjusted_volume_24h_share +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Get all exchanges found for given coin. You can display only top N number of exchanges with --top parameter. You can sort data by id, name, adjusted_volume_24h_share, fiats --sort parameter and also with --reverse flag to sort ascending. Displays: id, name, adjusted_volume_24h_share, fiats + +### Usage + +```python +ex [-l LIMIT] [-s {id,name,adjusted_volume_24h_share,fiats}] [-r] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| limit | Limit of records | 10 | True | None | +| sortby | Sort by given column. Default: date | adjusted_volume_24h_share | True | id, name, adjusted_volume_24h_share, fiats | +| reverse | Data is sorted in descending order by default. Reverse flag will sort it in an ascending way. Only works when raw data is displayed. | False | True | None | + +--- diff --git a/website/content/terminal/reference/crypto/dd/fr.md b/website/content/terminal/reference/crypto/dd/fr.md new file mode 100644 index 000000000000..1238125e32b6 --- /dev/null +++ b/website/content/terminal/reference/crypto/dd/fr.md @@ -0,0 +1,32 @@ +--- +title: fr +description: This documentation page explains how to use the 'fr' command to display + an asset's fundraising details on Messari.io. The command requires no parameters. +keywords: +- fundraising +- details +- asset +- Messari.io +- parameters +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Display asset's fundraising details [Source: https://messari.io] + +### Usage + +```python +fr +``` + +--- + +## Parameters + +This command has no parameters + + +--- diff --git a/website/content/terminal/reference/crypto/dd/fundrate.md b/website/content/terminal/reference/crypto/dd/fundrate.md new file mode 100644 index 000000000000..92ad29c5a4d6 --- /dev/null +++ b/website/content/terminal/reference/crypto/dd/fundrate.md @@ -0,0 +1,35 @@ +--- +title: fundrate +description: The fundrate page discusses how to display the funding rate by exchange + for a certain asset using the fundrate command. It presents a detailed explanation + of the command usage, source, and implies that no parameters are needed. This is + ideal for those seeking in-depth information about coinglass's API reference. +keywords: +- fundrate +- funding rate +- exchange +- asset +- API-Reference +- Coinglass +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Displays funding rate by exchange for a certain asset [Source: https://coinglass.github.io/API-Reference/] + +### Usage + +```python +fundrate +``` + +--- + +## Parameters + +This command has no parameters + + +--- diff --git a/website/versioned_docs/version-v3/terminal/reference/crypto/dd/funot.md b/website/content/terminal/reference/crypto/dd/funot.md similarity index 84% rename from website/versioned_docs/version-v3/terminal/reference/crypto/dd/funot.md rename to website/content/terminal/reference/crypto/dd/funot.md index 900e50388033..a791212ec6ff 100644 --- a/website/versioned_docs/version-v3/terminal/reference/crypto/dd/funot.md +++ b/website/content/terminal/reference/crypto/dd/funot.md @@ -1,9 +1,27 @@ --- title: funot -description: OpenBB Terminal Function +description: This page covers the 'funot' function, which displays fundamental metrics + such as market cap, revenue, and TVL (Total Value Locked) for a wide array of digital + asset projects, as sourced from Token Terminal. +keywords: +- funot +- Token Terminal +- digital asset metrics +- cryptocurrency analysis +- cryptocurrency projects +- market cap +- revenue +- TVL +- python function +- Total Value Locked +- cryptocurrency metrics +- fundamental metrics +- SEO for docusaurus --- -# funot +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + Display fundamental metric over time [Source: Token Terminal] diff --git a/website/content/terminal/reference/crypto/dd/gh.md b/website/content/terminal/reference/crypto/dd/gh.md new file mode 100644 index 000000000000..37f3a21e515b --- /dev/null +++ b/website/content/terminal/reference/crypto/dd/gh.md @@ -0,0 +1,42 @@ +--- +title: gh +description: "Learn how to utilize the GH command line tool to track GitHub activity\ + \ for a given crypto coin. Discover how to filter by development activity, set frequency\ + \ intervals, and define start and end dates\u2014all with this powerful Python-based\ + \ tool." +keywords: +- Github activity +- Pull Request +- Issue +- command line tool +- development activity +- frequency intervals +- start and end dates +- Santiment +- tracking tool +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Display github activity over time for a given coin. Github activity includes the following actions: creating a Pull Request, an Issue, commenting on an issue / PR, and many more. See detailed definition at https://academy.santiment.net/metrics/development-activity/ [Source: https://santiment.net/] + +### Usage + +```python +gh [-i INTERVAL] [-d DEV] [-s START] [-end END] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| interval | Frequency interval. Default: 1d | 1d | True | None | +| dev | Filter only for development activity. Default: False | False | True | None | +| start | Initial date. Default: A year ago | 2021-11-25 | True | None | +| end | End date. Default: Today | 2022-11-25 | True | None | + +--- diff --git a/website/content/terminal/reference/crypto/dd/gov.md b/website/content/terminal/reference/crypto/dd/gov.md new file mode 100644 index 000000000000..62e857d00245 --- /dev/null +++ b/website/content/terminal/reference/crypto/dd/gov.md @@ -0,0 +1,32 @@ +--- +title: gov +description: This page provides information on the 'gov' command, enabling the display + of an asset's governance. The command is easy to use and requires no parameters. +keywords: +- gov +- asset governance +- no parameters +- usage +- messari.io source +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Display asset's governance [Source: https://messari.io] + +### Usage + +```python +gov +``` + +--- + +## Parameters + +This command has no parameters + + +--- diff --git a/website/content/terminal/reference/crypto/dd/info.md b/website/content/terminal/reference/crypto/dd/info.md new file mode 100644 index 000000000000..57503512c76d --- /dev/null +++ b/website/content/terminal/reference/crypto/dd/info.md @@ -0,0 +1,103 @@ +--- +title: info +description: This page provides commands to retrieve basic information about any loaded + cryptocurrency like Bitcoin. It shows data like Name, Symbol, Description, Market + Cap, Public Interest, Supply, and Price related metrics. This feature can be very + useful for those tracking specific cryptocurrencies and their performance. +keywords: +- crypto +- bitcoin +- cryptocurrency information +- bitcoin stats +- market cap +- public interest score +- supply +- price metrics +- crypto commands +- btc +- digital currency +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Shows basic information about loaded coin like: Name, Symbol, Description, Market Cap, Public Interest, Supply, and Price related metrics + +### Usage + +```python +info +``` + +--- + +## Parameters + +This command has no parameters + + + +--- + +## Examples + +```python +2022 Feb 15, 07:34 (🦋) /crypto/dd/ $ info + Basic Coin Information +┌─────────────────────────────┬──────────────────────────────────────────────────────────────────────────────────┐ +│ Metric │ Value │ +├─────────────────────────────┼──────────────────────────────────────────────────────────────────────────────────┤ +│ Id │ bitcoin │ +├─────────────────────────────┼──────────────────────────────────────────────────────────────────────────────────┤ +│ Name │ Bitcoin │ +├─────────────────────────────┼──────────────────────────────────────────────────────────────────────────────────┤ +│ Symbol │ btc │ +├─────────────────────────────┼──────────────────────────────────────────────────────────────────────────────────┤ +│ Description │ Bitcoin is the first successful internet money based on peer-to-peer technology; │ +│ │ whereby no central bank or authority is involved in the transaction and │ +│ │ production of the Bitcoin currency. It was created by an anonymous │ +│ │ individual/group under the name, Satoshi Nakamoto. The source code is available │ +│ │ publicly as an open source project, anybody can look at it and be part of the │ +│ │ developmental process. Bitcoin is changing the way we see money as we speak. The │ +│ │ idea was to produce a means of exchange, independent of any central authority, │ +│ │ that could be transferred electronically in a secure, verifiable and immutable │ +│ │ way. It is a decentralized peer-to-peer internet currency making mobile payment │ +│ │ easy, very low transaction fees, protects your identity, and it works anywhere │ +│ │ all the time with no central authority and banks. Bitcoin is designed to have │ +│ │ only 21 million BTC ever created, thus making it a deflationary currency. │ +│ │ Bitcoin uses the SHA-256 hashing algorithm with an average transaction │ +│ │ confirmation time of 10 minutes. Miners today are mining Bitcoin using ASIC chip │ +│ │ dedicated to only mining Bitcoin, and the hash rate has shot up to peta hashes. │ +│ │ Being the first successful online cryptography currency, Bitcoin has inspired │ +│ │ other alternative currencies such as Litecoin, Peercoin, Primecoin, and so on. │ +│ │ The cryptocurrency then took off with the innovation of the turing-complete │ +│ │ smart contract by Ethereum which led to the development of other amazing │ +│ │ projects such as EOS, Tron, and even crypto-collectibles such as CryptoKitties. │ +├─────────────────────────────┼──────────────────────────────────────────────────────────────────────────────────┤ +│ Contract Address │ {} │ +├─────────────────────────────┼──────────────────────────────────────────────────────────────────────────────────┤ +│ Market Cap Rank │ 1 │ +├─────────────────────────────┼──────────────────────────────────────────────────────────────────────────────────┤ +│ Public Interest Score │ 0.34 │ +├─────────────────────────────┼──────────────────────────────────────────────────────────────────────────────────┤ +│ Total Supply │ 21000000.00 │ +├─────────────────────────────┼──────────────────────────────────────────────────────────────────────────────────┤ +│ Max Supply │ 21000000.00 │ +├─────────────────────────────┼──────────────────────────────────────────────────────────────────────────────────┤ +│ Circulating Supply │ 18958987.00 │ +├─────────────────────────────┼──────────────────────────────────────────────────────────────────────────────────┤ +│ Price Change Percentage 24H │ 4.47 │ +├─────────────────────────────┼──────────────────────────────────────────────────────────────────────────────────┤ +│ Price Change Percentage 7D │ 0.82 │ +├─────────────────────────────┼──────────────────────────────────────────────────────────────────────────────────┤ +│ Price Change Percentage 30D │ 2.41 │ +├─────────────────────────────┼──────────────────────────────────────────────────────────────────────────────────┤ +│ Current Price Btc │ 1.00 │ +├─────────────────────────────┼──────────────────────────────────────────────────────────────────────────────────┤ +│ Current Price Eth │ 14.27 │ +├─────────────────────────────┼──────────────────────────────────────────────────────────────────────────────────┤ +│ Current Price Usd │ 44269 │ +└─────────────────────────────┴──────────────────────────────────────────────────────────────────────────────────┘ +``` +--- diff --git a/website/content/terminal/reference/crypto/dd/inv.md b/website/content/terminal/reference/crypto/dd/inv.md new file mode 100644 index 000000000000..548e8f40b5aa --- /dev/null +++ b/website/content/terminal/reference/crypto/dd/inv.md @@ -0,0 +1,34 @@ +--- +title: inv +description: Documentation page for the 'inv' command - displaying asset's investors. + This command runs without parameters and is a part of financial data analysis tools. +keywords: +- asset investors +- financial data +- data analysis +- Python commands +- parameters +- docusaurus page +- messari.io +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Display asset's investors [Source: https://messari.io] + +### Usage + +```python +inv +``` + +--- + +## Parameters + +This command has no parameters + + +--- diff --git a/website/content/terminal/reference/crypto/dd/links.md b/website/content/terminal/reference/crypto/dd/links.md new file mode 100644 index 000000000000..3065204d0792 --- /dev/null +++ b/website/content/terminal/reference/crypto/dd/links.md @@ -0,0 +1,31 @@ +--- +title: links +description: The 'links' command is utilized to display an asset's links. This command + doesn't require any parameters and is beneficial for those handling asset information. +keywords: +- links +- asset's links +- parameters +- asset information +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Display asset's links [Source: https://messari.io] + +### Usage + +```python +links +``` + +--- + +## Parameters + +This command has no parameters + + +--- diff --git a/website/content/terminal/reference/crypto/dd/liquidations.md b/website/content/terminal/reference/crypto/dd/liquidations.md new file mode 100644 index 000000000000..cdc57f7ce908 --- /dev/null +++ b/website/content/terminal/reference/crypto/dd/liquidations.md @@ -0,0 +1,35 @@ +--- +title: liquidations +description: The Liquidations page provides detailed data about crypto asset liquidations. + It's an easy-to-use feature of the Coinglass API with no parameters required. Enhance + your understanding of cryptocurrency liquidations. +keywords: +- liquidations +- crypto asset data +- coinglass API +- cryptocurrency +- blockchain technology +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Displays liquidations data for the loaded crypto asset [Source: https://coinglass.github.io/API-Reference/#liquidation-chart] + +### Usage + +```python +liquidations +``` + +--- + +## Parameters + +This command has no parameters + + +![oi](https://user-images.githubusercontent.com/1673206/186211230-e095fe05-6d86-4d6a-aa2d-dd84dee4ad52.png) + +--- diff --git a/website/content/terminal/reference/crypto/dd/load.md b/website/content/terminal/reference/crypto/dd/load.md new file mode 100644 index 000000000000..afb9cfa77d1a --- /dev/null +++ b/website/content/terminal/reference/crypto/dd/load.md @@ -0,0 +1,43 @@ +--- +title: load +description: Experienced in loading crypto currency data for analysis from Yahoo Finance + by default or other sources such as 'ccxt' or 'cg'. Ability to select specific interval, + start and end dates, and exchange currencies +keywords: +- Load crypto currency +- Yahoo Finance +- ccxt +- cg +- specific interval +- crypto analysis +- exchange selection +- coin symbol +- quote currency +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Load crypto currency to perform analysis on. Yahoo Finance is used as default source. Other sources can be used such as 'ccxt' or 'cg' with --source. If you select 'ccxt', you can then select any exchange with --exchange. You can also select a specific interval with --interval. + +### Usage + +```python +load -c COIN [-s START] [--exchange {aax,ascendex,bequant,bibox,bigone,binance,binancecoinm,binanceus,binanceusdm,bit2c,bitbank,bitbay,bitcoincom,bitfinex,bitfinex2,bitflyer,bitforex,bitget,bithumb,bitmart,bitmex,bitopro,bitpanda,bitrue,bitso,bitstamp,bitstamp1,bittrex,bitvavo,bkex,bl3p,btcalpha,btcbox,btcex,btcmarkets,btctradeua,btcturk,buda,bw,bybit,bytetrade,cex,coinbaseprime,coinbasepro,coincheck,coinex,coinfalcon,coinmate,coinone,coinspot,crex24,cryptocom,currencycom,delta,deribit,digifinex,eqonex,exmo,flowbtc,fmfwio,ftx,ftxus,gate,gateio,gemini,hitbtc,hitbtc3,hollaex,huobi,huobijp,huobipro,idex,independentreserve,indodax,itbit,kraken,kucoin,kucoinfutures,kuna,latoken,lbank,lbank2,liquid,luno,lykke,mercado,mexc,mexc3,ndax,novadax,oceanex,okcoin,okex,okex5,okx,paymium,phemex,poloniex,probit,qtrade,ripio,stex,therock,tidebit,tidex,timex,tokocrypto,upbit,wavesexchange,whitebit,woo,yobit,zaif,zb,zipmex,zonda}] [-e END] [-i {1,5,15,30,60,240,1440,10080,43200}] [--vs VS] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| coin | Coin to get. Must be coin symbol (e.g., btc, eth) | None | False | None | +| start | The starting date (format YYYY-MM-DD) of the crypto | 2019-11-21 | True | None | +| exchange | Exchange to search | binance | True | aax, ascendex, bequant, bibox, bigone, binance, binancecoinm, binanceus, binanceusdm, bit2c, bitbank, bitbay, bitcoincom, bitfinex, bitfinex2, bitflyer, bitforex, bitget, bithumb, bitmart, bitmex, bitopro, bitpanda, bitrue, bitso, bitstamp, bitstamp1, bittrex, bitvavo, bkex, bl3p, btcalpha, btcbox, btcex, btcmarkets, btctradeua, btcturk, buda, bw, bybit, bytetrade, cex, coinbaseprime, coinbasepro, coincheck, coinex, coinfalcon, coinmate, coinone, coinspot, crex24, cryptocom, currencycom, delta, deribit, digifinex, eqonex, exmo, flowbtc, fmfwio, ftx, ftxus, gate, gateio, gemini, hitbtc, hitbtc3, hollaex, huobi, huobijp, huobipro, idex, independentreserve, indodax, itbit, kraken, kucoin, kucoinfutures, kuna, latoken, lbank, lbank2, liquid, luno, lykke, mercado, mexc, mexc3, ndax, novadax, oceanex, okcoin, okex, okex5, okx, paymium, phemex, poloniex, probit, qtrade, ripio, stex, therock, tidebit, tidex, timex, tokocrypto, upbit, wavesexchange, whitebit, woo, yobit, zaif, zb, zipmex, zonda | +| end | The ending date (format YYYY-MM-DD) of the crypto | 2022-11-25 | True | None | +| interval | The interval of the crypto | 1440 | True | 1, 5, 15, 30, 60, 240, 1440, 10080, 43200 | +| vs | Quote currency (what to view coin vs). e.g., usdc, usdt, ... if source is ccxt, usd, eur, ... otherwise | usdt | True | None | + +--- diff --git a/website/versioned_docs/version-v3/terminal/reference/crypto/dd/market.md b/website/content/terminal/reference/crypto/dd/market.md similarity index 92% rename from website/versioned_docs/version-v3/terminal/reference/crypto/dd/market.md rename to website/content/terminal/reference/crypto/dd/market.md index e2ef300b8f71..3af1b5f653d5 100644 --- a/website/versioned_docs/version-v3/terminal/reference/crypto/dd/market.md +++ b/website/content/terminal/reference/crypto/dd/market.md @@ -1,9 +1,25 @@ --- title: market -description: OpenBB Terminal Function +description: This page provides a command to fetch market data for a loaded coin, + offering detailed metrics like Market Cap, Supply, Circulating Supply, Price, Volume, + Price Change Percentage and more. Examples are provided for a better understanding. +keywords: +- Market Data +- Coin Metrics +- Market Cap +- Supply +- Circulating Supply +- Price +- Volume +- Price Change Percentage +- Fully Diluted Valuation +- Total Volume +- High/Low 24h --- -# market +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + Market data for loaded coin. There you find metrics like: Market Cap, Supply, Circulating Supply, Price, Volume and many others. diff --git a/website/content/terminal/reference/crypto/dd/mcapdom.md b/website/content/terminal/reference/crypto/dd/mcapdom.md new file mode 100644 index 000000000000..2466b6eb24a4 --- /dev/null +++ b/website/content/terminal/reference/crypto/dd/mcapdom.md @@ -0,0 +1,37 @@ +--- +title: mcapdom +description: The mcapdom documentation page presents an outline of how to display + an asset's percentage share of the total crypto circulating market cap. It includes + usage and parameters specifically for frequency interval, initial date, and end + date. +keywords: +- mcapdom +- crypto circulating market cap +- asset's percentage share +- frequency interval +- initial date +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Display asset's percentage share of total crypto circulating market cap [Source: https://messari.io] + +### Usage + +```python +mcapdom [-i {5m,15m,30m,1h,1d,1w}] [-s START] [-end END] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| interval | Frequency interval. Default: 1d | 1d | True | 5m, 15m, 30m, 1h, 1d, 1w | +| start | Initial date. Default: A year ago | 2021-11-25 | True | None | +| end | End date. Default: Today | 2022-11-25 | True | None | + +--- diff --git a/website/content/terminal/reference/crypto/dd/mkt.md b/website/content/terminal/reference/crypto/dd/mkt.md new file mode 100644 index 000000000000..0434ab73766f --- /dev/null +++ b/website/content/terminal/reference/crypto/dd/mkt.md @@ -0,0 +1,95 @@ +--- +title: mkt +description: The 'mkt' page allows for viewing of market data for a given coin based + on different parameters such as trust_score, volume, and price. The page accepts + different parameters to further sort, limit, and display the data effectively. +keywords: +- mkt +- coin +- market data +- trust_score +- volume +- price data +- cryptocurrency +- data sort +- url display +- data limit +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Get all markets found for given coin. You can display only N number of markets with --limt parameter. You can sort data by pct_volume_share, exchange, pair, trust_score, volume, price --sort parameter and also with --reverse flag to sort ascending. You can use additional flag --urls to see urls for each market Displays: exchange, pair, trust_score, volume, price, pct_volume_share, + +### Usage + +```python +mkt [--vs {BTC,ETH,USD,EUR,PLN,KRW,GBP,CAD,JPY,RUB,TRY,NZD,AUD,CHF,UAH,HKD,SGD,NGN,PHP,MXN,BRL,THB,CLP,CNY,CZK,DKK,HUF,IDR,ILS,INR,MYR,NOK,PKR,SEK,TWD,ZAR,VND,BOB,COP,PEN,ARS,ISK}] [-l LIMIT] [-s {pct_volume_share,exchange,pair,trust_score,volume,price}] [-r] [-u] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| vs | Quoted currency. Default USD | USD | True | BTC, ETH, USD, EUR, PLN, KRW, GBP, CAD, JPY, RUB, TRY, NZD, AUD, CHF, UAH, HKD, SGD, NGN, PHP, MXN, BRL, THB, CLP, CNY, CZK, DKK, HUF, IDR, ILS, INR, MYR, NOK, PKR, SEK, TWD, ZAR, VND, BOB, COP, PEN, ARS, ISK | +| limit | Limit of records | 20 | True | None | +| sortby | Sort by given column. Default: pct_volume_share | pct_volume_share | True | pct_volume_share, exchange, pair, trust_score, volume, price | +| reverse | Data is sorted in descending order by default. Reverse flag will sort it in an ascending way. Only works when raw data is displayed. | False | True | None | +| urls | Flag to show urls. If you will use that flag you will see only: exchange, pair, trust_score, market_url columns | False | True | None | + + +--- + +## Examples + +```python +2022 Feb 15, 07:41 (🦋) /crypto/dd/ $ mkt + All Markets +┌─────────────────────┬──────────┬─────────────┬──────────────────┬───────────┬────────────────┐ +│ exchange │ pair │ trust_score │ pct_volume_share │ usd_price │ usd_volume │ +├─────────────────────┼──────────┼─────────────┼──────────────────┼───────────┼────────────────┤ +│ QB │ BTC/USDT │ low │ 76.66 │ 44335.56 │ 83125013156.79 │ +├─────────────────────┼──────────┼─────────────┼──────────────────┼───────────┼────────────────┤ +│ Bitenium │ BTC/USDT │ no_data │ 1.70 │ 44337.16 │ 1840286891.89 │ +├─────────────────────┼──────────┼─────────────┼──────────────────┼───────────┼────────────────┤ +│ Binance │ BTC/USDT │ high │ 1.69 │ 44340.62 │ 1829582324.62 │ +├─────────────────────┼──────────┼─────────────┼──────────────────┼───────────┼────────────────┤ +│ Crypto.com Exchange │ BTC/USDT │ low │ 1.41 │ 44329.00 │ 1524907447.06 │ +├─────────────────────┼──────────┼─────────────┼──────────────────┼───────────┼────────────────┤ +│ Indoex │ BTC/USD │ no_data │ 0.71 │ 44257.37 │ 767372786.82 │ +├─────────────────────┼──────────┼─────────────┼──────────────────┼───────────┼────────────────┤ +│ Coinbase │ BTC/USD │ high │ 0.65 │ 44305.95 │ 700692544.59 │ +├─────────────────────┼──────────┼─────────────┼──────────────────┼───────────┼────────────────┤ +│ Gleec BTC Exchange │ BTC/USDT │ no_data │ 0.63 │ 44353.43 │ 681039760.57 │ +├─────────────────────┼──────────┼─────────────┼──────────────────┼───────────┼────────────────┤ +│ HitBTC │ BTC/USDT │ high │ 0.63 │ 44351.01 │ 681002641.50 │ +├─────────────────────┼──────────┼─────────────┼──────────────────┼───────────┼────────────────┤ +│ Bequant │ BTC/USDT │ low │ 0.63 │ 44331.91 │ 679750799.42 │ +├─────────────────────┼──────────┼─────────────┼──────────────────┼───────────┼────────────────┤ +│ FMFW.io │ BTC/USD │ low │ 0.63 │ 44205.77 │ 678518719.32 │ +├─────────────────────┼──────────┼─────────────┼──────────────────┼───────────┼────────────────┤ +│ Binance │ BTC/BUSD │ high │ 0.53 │ 44309.66 │ 572365752.88 │ +├─────────────────────┼──────────┼─────────────┼──────────────────┼───────────┼────────────────┤ +│ FTX (Spot) │ BTC/USD │ medium │ 0.45 │ 44209.00 │ 492815904.21 │ +├─────────────────────┼──────────┼─────────────┼──────────────────┼───────────┼────────────────┤ +│ Huobi │ BTC/USDT │ low │ 0.44 │ 44340.66 │ 479152896.05 │ +├─────────────────────┼──────────┼─────────────┼──────────────────┼───────────┼────────────────┤ +│ Indoex │ BTC/EUR │ no_data │ 0.42 │ 44250.15 │ 453236652.77 │ +├─────────────────────┼──────────┼─────────────┼──────────────────┼───────────┼────────────────┤ +│ Kucoin │ BTC/USDT │ low │ 0.40 │ 44341.16 │ 436318305.41 │ +├─────────────────────┼──────────┼─────────────┼──────────────────┼───────────┼────────────────┤ +│ Bitrue │ BTC/USDT │ low │ 0.37 │ 44337.33 │ 403067095.03 │ +├─────────────────────┼──────────┼─────────────┼──────────────────┼───────────┼────────────────┤ +│ Lbank │ BTC/USDT │ low │ 0.36 │ 44343.55 │ 385493474.14 │ +├─────────────────────┼──────────┼─────────────┼──────────────────┼───────────┼────────────────┤ +│ BigONE │ BTC/USDT │ low │ 0.35 │ 44334.78 │ 377459785.89 │ +├─────────────────────┼──────────┼─────────────┼──────────────────┼───────────┼────────────────┤ +│ Simex │ BTC/USD │ low │ 0.33 │ 44237.02 │ 355967120.52 │ +├─────────────────────┼──────────┼─────────────┼──────────────────┼───────────┼────────────────┤ +│ DigiFinex │ BTC/USDT │ high │ 0.31 │ 44394.03 │ 339944185.15 │ +└─────────────────────┴──────────┴─────────────┴──────────────────┴───────────┴────────────────┘ +``` +--- diff --git a/website/content/terminal/reference/crypto/dd/mt.md b/website/content/terminal/reference/crypto/dd/mt.md new file mode 100644 index 000000000000..4b5232463ee4 --- /dev/null +++ b/website/content/terminal/reference/crypto/dd/mt.md @@ -0,0 +1,42 @@ +--- +title: mt +description: This page provides detailed information about how to display Messari + timeseries data, explaining the use of key parameters, available data frequency + intervals, and how to query the timeseries. It is a resource for understanding and + extracting meaningful insights from Messari data. +keywords: +- messari timeseries +- timeseries parameters +- data frequency intervals +- messari data sources +- timeseries query +- messari usage +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Display messari timeseries [Source: https://messari.io] + +### Usage + +```python +mt [--list] [-t TIMESERIES] [-i {5m,15m,30m,1h,1d,1w}] [-s START] [-end END] [--include-paid] [-q QUERY [QUERY ...]] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| list | Flag to show available timeseries | False | True | None | +| timeseries | Messari timeseries id | | True | mcap.realized, fees, iss.rate, reddit.active.users, nvt.adj.90d.ma, txn.tfr.val.med.ntv, daily.vol, exch.flow.in.ntv, mcap.dom, blk.cnt, txn.vol, sply.total.iss, txn.tfr.avg.ntv, txn.tsfr.val.adj, exch.flow.out.usd, nvt.adj, txn.tsfr.val.avg, txn.fee.med.ntv, fees.ntv, blk.size.byte, txn.tfr.val.ntv, txn.tfr.val.med, mcap.circ, sply.liquid, exch.flow.in.usd, sply.out, exch.flow.out.ntv.incl, exch.flow.in.ntv.incl, exch.sply.usd, exch.flow.out.usd.incl, txn.cnt, exch.flow.in.usd.incl, daily.shp, txn.tfr.val.adj.ntv, price, hashrate, exch.flow.out.ntv, real.vol, exch.sply.ntv, txn.fee.avg, txn.tfr.erc721.cnt, twitter.followers, telegram.users, reddit.subscribers, cg.sply.circ, blk.size.bytes.avg, txn.fee.avg.ntv, txn.fee.med, txn.tsfr.cnt, sply.circ, mcap.out, diff.avg, act.addr.cnt, min.rev.ntv, new.iss.ntv, min.rev.usd, new.iss.usd, sply.total.iss.ntv, txn.tfr.erc20.cnt | +| interval | Frequency interval | 1d | True | 5m, 15m, 30m, 1h, 1d, 1w | +| start | Initial date. Default: A year ago | 2021-11-25 | True | None | +| end | End date. Default: Today | 2022-11-25 | True | None | +| include_paid | Flag to show both paid and free sources | False | True | None | +| query | Query to search across all messari timeseries | | True | None | + +--- diff --git a/website/content/terminal/reference/crypto/dd/news.md b/website/content/terminal/reference/crypto/dd/news.md new file mode 100644 index 000000000000..fca32573a6be --- /dev/null +++ b/website/content/terminal/reference/crypto/dd/news.md @@ -0,0 +1,63 @@ +--- +title: news +description: The News Page aggregates the latest crypto news from the CryptoPanic + platform, allowing extensive filter and sort options to customize your feed. The + page is interactive and easy-to-use for those who want to stay updated with the + cryptocurrency market news. +keywords: +- news +- cryptopanic +- cryptocurrency +- aggregator platform +- coin +- filter options +- crypto news +- crypto media +- parameters +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Display most recent news on the given coin from CryptoPanic aggregator platform. [Source: https://cryptopanic.com/] + +### Usage + +```python +news [-l LIMIT] [-k {news,media}] [--filter {rising,hot,bullish,bearish,important,saved,lol}] [-r {en,de,es,fr,nl,it,pt,ru}] [-s {published_at,domain,title,negative_votes,positive_votes}] [--reverse] [-u] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| limit | display N number records | 10 | True | None | +| kind | Filter by category of news. Available values: news or media. | news | True | news, media | +| filter | Filter by kind of news. From: rising|hot|bullish|bearish|important|saved|lol | None | True | rising, hot, bullish, bearish, important, saved, lol | +| region | Filter news by regions. Available regions are: en (English), de (Deutsch), nl (Dutch), es (Español), fr (Français), it (Italiano), pt (Português), ru (Русский) | en | True | en, de, es, fr, nl, it, pt, ru | +| sortby | Sort by given column. Default: published_at | published_at | True | published_at, domain, title, negative_votes, positive_votes | +| reverse | Data is sorted in descending order by default. Reverse flag will sort it in an ascending way. Only works when raw data is displayed. | False | True | None | +| urls | Flag to disable urls. Hides column with URL. | True | True | None | + + +--- + +## Examples + +```python +2022 Apr 25, 09:49 (🦋) /crypto/dd/ $ news + Most Recent News +┏━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ +┃ published_at ┃ title ┃ link ┃ +┡━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┩ +│ 2022-04-24 │ Major German Bank Applies For Crypto │ https://cryptopanic.com/news/15005355/Maj… │ +│ │ Custody License │ │ +├──────────────┼─────────────────────────────────────────────┼────────────────────────────────────────────┤ +│ 2022-04-24 │ These Two Companies Will Let You Buy a │ https://cryptopanic.com/news/15005488/The… │ +│ │ House with Crypto │ │ +├──────────────┼─────────────────────────────────────────────┼──────────────────────────────────────────── +``` +--- diff --git a/website/content/terminal/reference/crypto/dd/nonzero.md b/website/content/terminal/reference/crypto/dd/nonzero.md new file mode 100644 index 000000000000..c5f0d32cdc30 --- /dev/null +++ b/website/content/terminal/reference/crypto/dd/nonzero.md @@ -0,0 +1,40 @@ +--- +title: nonzero +description: The 'nonzero' page provides documentation on how to display addresses + with nonzero assets in a specific blockchain using the Glassnode API. The page details + the usage of the command and parameters, along with providing a visual representation. +keywords: +- nonzero +- blockchain +- glassnode +- addresses +- assets +- data fetching +- api +- parameters +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Display addresses with nonzero assets in a certain blockchain [Source: https://glassnode.org] Note that free api keys only allow fetching data with a 1y lag + +### Usage + +```python +nonzero [-s SINCE] [-u UNTIL] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| since | Initial date. Default: 2 years ago | 2020-11-25 | True | None | +| until | Final date. Default: 1 year ago | 2021-11-23 | True | None | + +![nonzero](https://user-images.githubusercontent.com/46355364/154064344-5b7825c8-9243-47ba-9930-0f5f7e3282a4.png) + +--- diff --git a/website/content/terminal/reference/crypto/dd/ob.md b/website/content/terminal/reference/crypto/dd/ob.md new file mode 100644 index 000000000000..4037284c9a83 --- /dev/null +++ b/website/content/terminal/reference/crypto/dd/ob.md @@ -0,0 +1,41 @@ +--- +title: ob +description: This page explains how to retrieve the order book for any selected cryptocurrency + coin across numerous exchanges. It specifically instructs the use of the 'ob' command + in python. +keywords: +- order book +- cryptocurrency +- exchange +- quote currency +- cryptocurrency pairs +- binance +- bitfinex +- coinbase +- poloniex +- crypto trading +- trading parameters +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Get the order book for selected coin + +### Usage + +```python +ob [-e {aax,alpaca,ascendex,bequant,bibox,bigone,binance,binancecoinm,binanceus,binanceusdm,bit2c,bitbank,bitbay,bitbns,bitcoincom,bitfinex,bitfinex2,bitflyer,bitforex,bitget,bithumb,bitmart,bitmex,bitopro,bitpanda,bitrue,bitso,bitstamp,bitstamp1,bittrex,bitvavo,bkex,bl3p,blockchaincom,btcalpha,btcbox,btcex,btcmarkets,btctradeua,btcturk,buda,bw,bybit,bytetrade,cex,coinbase,coinbaseprime,coinbasepro,coincheck,coinex,coinfalcon,coinmate,coinone,coinspot,crex24,cryptocom,currencycom,delta,deribit,digifinex,eqonex,exmo,flowbtc,fmfwio,ftx,ftxus,gate,gateio,gemini,hitbtc,hitbtc3,hollaex,huobi,huobijp,huobipro,idex,independentreserve,indodax,itbit,kraken,kucoin,kucoinfutures,kuna,latoken,lbank,lbank2,liquid,luno,lykke,mercado,mexc,mexc3,ndax,novadax,oceanex,okcoin,okex,okex5,okx,paymium,phemex,poloniex,probit,qtrade,ripio,stex,therock,tidebit,tidex,timex,tokocrypto,upbit,wavesexchange,wazirx,whitebit,woo,yobit,zaif,zb,zipmex,zonda}] [--vs VS] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| exchange | Exchange to search for order book | binance | True | aax, alpaca, ascendex, bequant, bibox, bigone, binance, binancecoinm, binanceus, binanceusdm, bit2c, bitbank, bitbay, bitbns, bitcoincom, bitfinex, bitfinex2, bitflyer, bitforex, bitget, bithumb, bitmart, bitmex, bitopro, bitpanda, bitrue, bitso, bitstamp, bitstamp1, bittrex, bitvavo, bkex, bl3p, blockchaincom, btcalpha, btcbox, btcex, btcmarkets, btctradeua, btcturk, buda, bw, bybit, bytetrade, cex, coinbase, coinbaseprime, coinbasepro, coincheck, coinex, coinfalcon, coinmate, coinone, coinspot, crex24, cryptocom, currencycom, delta, deribit, digifinex, eqonex, exmo, flowbtc, fmfwio, ftx, ftxus, gate, gateio, gemini, hitbtc, hitbtc3, hollaex, huobi, huobijp, huobipro, idex, independentreserve, indodax, itbit, kraken, kucoin, kucoinfutures, kuna, latoken, lbank, lbank2, liquid, luno, lykke, mercado, mexc, mexc3, ndax, novadax, oceanex, okcoin, okex, okex5, okx, paymium, phemex, poloniex, probit, qtrade, ripio, stex, therock, tidebit, tidex, timex, tokocrypto, upbit, wavesexchange, wazirx, whitebit, woo, yobit, zaif, zb, zipmex, zonda | +| vs | Quote currency (what to view coin vs) | usdt | True | AUD, BIDR, BKRW, BNB, BRL, BTC, BUSD, BVND, DAI, DOGE, DOT, ETH, EUR, GBP, IDRT, NGN, PAX, PLN, RUB, TRX, TRY, TUSD, UAH, USDC, USDP, USDS, USDT, UST, VAI, XRP, ZAR | + +--- diff --git a/website/content/terminal/reference/crypto/dd/oi.md b/website/content/terminal/reference/crypto/dd/oi.md new file mode 100644 index 000000000000..b3a49cd6463c --- /dev/null +++ b/website/content/terminal/reference/crypto/dd/oi.md @@ -0,0 +1,39 @@ +--- +title: oi +description: The documentation page 'oi' provides information about open interest + by exchange for certain assets. It includes parameters, usage and an illustrative + image. +keywords: +- oi +- API-Reference +- open interest +- exchange +- assets +- parameters +- usage +- illustrative image +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Displays open interest by exchange for a certain asset [Source: https://coinglass.github.io/API-Reference/] + +### Usage + +```python +oi [-i {0,1,2,4}] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| interval | Frequency interval. Default: 0 | 0 | True | 0, 1, 2, 4 | + +![oi](https://user-images.githubusercontent.com/46355364/154086745-17c2b33a-e1bf-40b1-8ac8-3422fe081e96.png) + +--- diff --git a/website/content/terminal/reference/crypto/dd/pi.md b/website/content/terminal/reference/crypto/dd/pi.md new file mode 100644 index 000000000000..49422e6939fc --- /dev/null +++ b/website/content/terminal/reference/crypto/dd/pi.md @@ -0,0 +1,100 @@ +--- +title: pi +description: This page provides a command that displays detailed project information + of crypto assets. The command showcases project details, technology details, public + repositories and disclosed vulnerabilities with examples in Python. +keywords: +- crypto assets +- project information +- technology details +- public repositories +- disclosed vulnerabilities +- Bitcoin +- BTC +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Display asset's project info [Source: https://messari.io] + +### Usage + +```python +pi +``` + +--- + +## Parameters + +This command has no parameters + + + +--- + +## Examples + +```python +2022 Jul 13, 07:51 (🦋) /crypto/dd/ $ pi + + BTC General Info +┏━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Metric ┃ Value ┃ +┡━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┩ +│ Project Details │ Bitcoin is the first distributed consensus-based censorship-resistant, permissionless, peer-to-peer payment settlement network with a provably scarce, programmable, native currency. │ +│ │ Bitcoin (BTC), the native asset of the Bitcoin blockchain, is the world's first digital currency without a central bank or administrator. The Bitcoin network is an emergent decentralized monetary institution that exists through the interplay │ +│ │ between full nodes, miners, and developers. It is set by a social contract that is created and opted into by the users of the network and hardened │ +│ │ through game theory and cryptography. Bitcoin is the first, oldest, and largest cryptocurrency in the world. │ +├────────────────────┼─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ +│ Technology Details │ "Bitcoin" is a label used for a protocol and a currency. │ +│ │ │ +│ │ Bitcoin, the currency, is bits of data usable outside the limitations of the protocol using second-layer solutions like a href="https://messari.io/resource/lightning-network"Lightning Network/a payment channels. │ +│ │ │ +│ │ Bitcoin, the protocol, is a distributed, time-stamped ledger of a href="https://messari.io/resource/utxo"unspent transaction output/a (UTXO) transfers stored in an append-only chain of 1MB data blocks. A network of mining and economic a │ +│ │ href="https://messari.io/resource/node"nodes/a maintains this ledger by validating, propagating, and fighting to include a href="https://messari.io/resource/mempool"mempool/a transactions in new blocks. Economic nodes (aka "full nodes") │ +│ │ receive transactions from other network participants, validate them against network consensus rules and double-spend vectors, and propagate the transactions to other full nodes that also validate and propagate. Valid transactions are sent to the │ +│ │ network's mempool waiting for mining nodes to confirm them via inclusion in the next block. │ +│ │ │ +│ │ Mining nodes work to empty the mempool usually in a highest-to-lowest fee order by picking transactions to include in the next block and racing against each other to generate a hash less than the target number set by Bitcoin's difficulty │ +│ │ adjustment algorithm. Bitcoin uses a Proof-of-Work (PoW) consensus mechanism to establish the chain of blocks with the most accumulated “work” (a.k.a., energy spent on solved hashes) as the valid chain. Other network peers can cheaply verify the │ +│ │ chain’s work. │ +│ │ │ +│ │ Mining difficulty regularly adjusts to maintain Bitcoin's average ten-minute block schedule. Mining nodes add new blocks to whatever chain has the largest accumulated proof of work maintained by a network of economic nodes with downloaded copies │ +│ │ of the same chain. │ +│ │ │ +│ │ Learn More: │ +│ │ Bitcoin Developer's Guide │ +│ │ Mastering Bitcoin │ +└────────────────────┴─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┘ + + BTC Public Repositories +┏━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━┓ +┃ Name ┃ Link ┃ License_type ┃ +┡━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━┩ +│ Bitcoin Core Repository │ https://github.com/bitcoin/bitcoin │ MIT License │ +└─────────────────────────┴────────────────────────────────────┴──────────────┘ + + BTC Vulnerabilities +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Title ┃ Date ┃ Type ┃ Details ┃ +┡━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┩ +│ Value Overflow Incident │ 2010-08-06 04:00:00+00:00 │ Inflation │ On 6 August 2010, a major vulnerability in the bitcoin protocol was spotted. Transactions weren't properly verified before they were included in the transaction log or blockchain, which let │ +│ │ │ │ users bypass bitcoin's economic restrictions and create an indefinite number of bitcoins. On 15 August, the vulnerability was exploited; over 184 billion bitcoins were generated in a transaction │ +│ │ │ │ and sent to two addresses on the network. Within hours, the transaction was spotted and erased from the transaction log after the bug was fixed and the network forked to an updated version of │ +│ │ │ │ the bitcoin protocol. This was the only major security flaw found and exploited in bitcoin's history. │ +├─────────────────────────────────┼───────────────────────────┼───────────┼────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ +│ Denial of Service Vulnerability │ 2018-09-20 04:00:00+00:00 │ Inflation │ On September 17, Bitcoin Core developers discovered that older versions of Bitcoin Core will crash if they try to process a block containing a transaction that attempts to spend the same input │ +│ │ │ │ twice. Such blocks are invalid, so they can only be created by a miner willing to sacrifice their allowed income for creating a block of at least 12.5 BTC (about $80,000 USD as of this writing). │ +│ │ │ │ │ +│ │ │ │ Soon after discovering the DDoS attack vulnerability, Bitcoin Core developers also discovered an inflation bug which they quickly determined had the same root cause and fix. They decided to │ +│ │ │ │ disclose the DDoS vulnerability immediately while keeping the inflation bug quiet. This provided developers time to reach out to miners, businesses, and other affected systems about upgrading │ +│ │ │ │ their software, while also providing additional time to fix the exploit. │ +│ │ │ │ │ +│ │ │ │ https://bitcoincore.org/en/2018/09/18/release-0.16.3/ │ +│ │ │ │ https://bitcoincore.org/en/2018/09/20/notice/ │ +└─────────────────────────────────┴───────────────────────────┴───────────┴────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┘ +``` +--- diff --git a/website/content/terminal/reference/crypto/dd/ps.md b/website/content/terminal/reference/crypto/dd/ps.md new file mode 100644 index 000000000000..65ced679c55f --- /dev/null +++ b/website/content/terminal/reference/crypto/dd/ps.md @@ -0,0 +1,101 @@ +--- +title: ps +description: Detailed documentation on ps metric, a tool used to fetch price and supply + related metrics for a given coin. Includes usage, parameters, examples, and more + for crypto analysis and data aggregation. +keywords: +- ps metric +- coin pricing +- coin supply metrics +- crypto analytics +- crypto metrics +- coin info +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Get price and supply related metrics for given coin. + +### Usage + +```python +ps [--vs {BTC,ETH,USD,EUR,PLN,KRW,GBP,CAD,JPY,RUB,TRY,NZD,AUD,CHF,UAH,HKD,SGD,NGN,PHP,MXN,BRL,THB,CLP,CNY,CZK,DKK,HUF,IDR,ILS,INR,MYR,NOK,PKR,SEK,TWD,ZAR,VND,BOB,COP,PEN,ARS,ISK}] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| vs | Quoted currency. Default USD | USD | True | BTC, ETH, USD, EUR, PLN, KRW, GBP, CAD, JPY, RUB, TRY, NZD, AUD, CHF, UAH, HKD, SGD, NGN, PHP, MXN, BRL, THB, CLP, CNY, CZK, DKK, HUF, IDR, ILS, INR, MYR, NOK, PKR, SEK, TWD, ZAR, VND, BOB, COP, PEN, ARS, ISK | + + +--- + +## Examples + +```python +2022 Feb 15, 07:46 (🦋) /crypto/dd/ $ ps + Coin Information +┌────────────────────────────┬─────────────────────┐ +│ Metric │ Value │ +├────────────────────────────┼─────────────────────┤ +│ id │ btc-bitcoin │ +├────────────────────────────┼─────────────────────┤ +│ name │ Bitcoin │ +├────────────────────────────┼─────────────────────┤ +│ symbol │ BTC │ +├────────────────────────────┼─────────────────────┤ +│ rank │ 1 │ +├────────────────────────────┼─────────────────────┤ +│ circulating_supply │ 18.959 M │ +├────────────────────────────┼─────────────────────┤ +│ total_supply │ 18.959 M │ +├────────────────────────────┼─────────────────────┤ +│ max_supply │ 21 M │ +├────────────────────────────┼─────────────────────┤ +│ beta_value │ 0.896 │ +├────────────────────────────┼─────────────────────┤ +│ first_data_at │ 2010-07-17 00:00:00 │ +├────────────────────────────┼─────────────────────┤ +│ last_updated │ 2022-02-15 12:43:09 │ +├────────────────────────────┼─────────────────────┤ +│ usd_price │ 44.331 K │ +├────────────────────────────┼─────────────────────┤ +│ usd_volume_24h │ 108.460 B │ +├────────────────────────────┼─────────────────────┤ +│ usd_volume_24h_change_24h │ 122.920 │ +├────────────────────────────┼─────────────────────┤ +│ usd_market_cap │ 840.463 B │ +├────────────────────────────┼─────────────────────┤ +│ usd_market_cap_change_24h │ 4.540 │ +├────────────────────────────┼─────────────────────┤ +│ usd_percent_change_15m │ 0.020 │ +├────────────────────────────┼─────────────────────┤ +│ usd_percent_change_30m │ -0.200 │ +├────────────────────────────┼─────────────────────┤ +│ usd_percent_change_1h │ -0.100 │ +├────────────────────────────┼─────────────────────┤ +│ usd_percent_change_6h │ 1.450 │ +├────────────────────────────┼─────────────────────┤ +│ usd_percent_change_12h │ 3.980 │ +├────────────────────────────┼─────────────────────┤ +│ usd_percent_change_24h │ 4.530 │ +├────────────────────────────┼─────────────────────┤ +│ usd_percent_change_7d │ 2.010 │ +├────────────────────────────┼─────────────────────┤ +│ usd_percent_change_30d │ 2.860 │ +├────────────────────────────┼─────────────────────┤ +│ usd_percent_change_1y │ -6.670 │ +├────────────────────────────┼─────────────────────┤ +│ usd_ath_price │ 68.692 K │ +├────────────────────────────┼─────────────────────┤ +│ usd_ath_date │ 2021-11-10 16:51:15 │ +├────────────────────────────┼─────────────────────┤ +│ usd_percent_from_price_ath │ -35.370 │ +└────────────────────────────┴─────────────────────┘ +``` +--- diff --git a/website/content/terminal/reference/crypto/dd/rm.md b/website/content/terminal/reference/crypto/dd/rm.md new file mode 100644 index 000000000000..6b2b17ed1650 --- /dev/null +++ b/website/content/terminal/reference/crypto/dd/rm.md @@ -0,0 +1,39 @@ +--- +title: rm +description: A documentation page for the 'rm' command showcasing how to display an + asset's roadmap sourced from Messari. It contains sections on how to use this command, + and parameters to modify data presentation. +keywords: +- rm +- asset's roadmap +- messari +- usage +- parameters +- reverse +- sorting data +- raw data +- ascending order +- descending order +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Display asset's roadmap [Source: https://messari.io] + +### Usage + +```python +rm [-r] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| reverse | Data is sorted in descending order by default. Reverse flag will sort it in an ascending way. Only works when raw data is displayed. | False | True | None | + +--- diff --git a/website/content/terminal/reference/crypto/dd/score.md b/website/content/terminal/reference/crypto/dd/score.md new file mode 100644 index 000000000000..9ad993022ee3 --- /dev/null +++ b/website/content/terminal/reference/crypto/dd/score.md @@ -0,0 +1,85 @@ +--- +title: score +description: This page provides access to cryptocurrency scores including CoinGecko, + Developer, Community and Sentiment scores. Learn how to access these scores for + any loaded coin. +keywords: +- cryptocurrency scores +- CoinGecko scores +- Developer scores +- Community scores +- Sentiment scores +- Reddit scores +- crypto metrics +- crypto ranking +- crypto sentiment +- crypto statistics +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +In this view you can find different kind of scores for loaded coin. Those scores represents different rankings, sentiment metrics, some user stats and others. You will see CoinGecko scores, Developer Scores, Community Scores, Sentiment, Reddit scores and many others. + +### Usage + +```python +score +``` + +--- + +## Parameters + +This command has no parameters + + + +--- + +## Examples + +```python +2022 Feb 15, 07:47 (🦋) /crypto/dd/ $ score + + Different Scores for Loaded Coin +┌─────────────────────────────────┬────────────┐ +│ Metric │ Value │ +├─────────────────────────────────┼────────────┤ +│ Coingecko Rank │ 1.00 │ +├─────────────────────────────────┼────────────┤ +│ Coingecko Score │ 80.77 │ +├─────────────────────────────────┼────────────┤ +│ Developer Score │ 98.91 │ +├─────────────────────────────────┼────────────┤ +│ Community Score │ 72.62 │ +├─────────────────────────────────┼────────────┤ +│ Liquidity Score │ 100.25 │ +├─────────────────────────────────┼────────────┤ +│ Sentiment Votes Up Percentage │ 83.17 │ +├─────────────────────────────────┼────────────┤ +│ Sentiment Votes Down Percentage │ 16.83 │ +├─────────────────────────────────┼────────────┤ +│ Public Interest Score │ 0.34 │ +├─────────────────────────────────┼────────────┤ +│ Facebook Likes │ │ +├─────────────────────────────────┼────────────┤ +│ Twitter Followers │ 4669906.00 │ +├─────────────────────────────────┼────────────┤ +│ Reddit Average Posts 48H │ 7.46 │ +├─────────────────────────────────┼────────────┤ +│ Reddit Average Comments 48H │ 1298.00 │ +├─────────────────────────────────┼────────────┤ +│ Reddit Subscribers │ 3908131.00 │ +├─────────────────────────────────┼────────────┤ +│ Reddit Accounts Active 48H │ 5154.00 │ +├─────────────────────────────────┼────────────┤ +│ Telegram Channel User Count │ │ +├─────────────────────────────────┼────────────┤ +│ Alexa Rank │ 9440.00 │ +├─────────────────────────────────┼────────────┤ +│ Bing Matches │ │ +└─────────────────────────────────┴────────────┘ +``` +--- diff --git a/website/content/terminal/reference/crypto/dd/social.md b/website/content/terminal/reference/crypto/dd/social.md new file mode 100644 index 000000000000..d550cca5176c --- /dev/null +++ b/website/content/terminal/reference/crypto/dd/social.md @@ -0,0 +1,55 @@ +--- +title: social +description: This Docusaurus page provides guidelines on using the 'social' command + to fetch relevant social media information for any loaded cryptocurrency. +keywords: +- social media for cryptocurrencies +- information about crypto coins +- Telegram channels for cryptos +- Reddit groups for cryptos +- Twitter for cryptos +- Bitcointalk for cryptos +- Facebook for cryptos +- Discord for cryptos +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Shows social media corresponding to loaded coin. You can find there name of telegram channel, urls to twitter, reddit, bitcointalk, facebook and discord. + +### Usage + +```python +social +``` + +--- + +## Parameters + +This command has no parameters + + + +--- + +## Examples + +```python +2022 Feb 15, 07:47 (🦋) /crypto/dd/ $ social + Social Media for Loaded Coin +┌───────────┬───────────────────────────────────┐ +│ Metric │ Value │ +├───────────┼───────────────────────────────────┤ +│ Telegram │ │ +├───────────┼───────────────────────────────────┤ +│ Twitter │ https://twitter.com/bitcoin │ +├───────────┼───────────────────────────────────┤ +│ Subreddit │ https://www.reddit.com/r/Bitcoin/ │ +├───────────┼───────────────────────────────────┤ +│ Facebook │ bitcoins │ +└───────────┴───────────────────────────────────┘ +``` +--- diff --git a/website/content/terminal/reference/crypto/dd/stats.md b/website/content/terminal/reference/crypto/dd/stats.md new file mode 100644 index 000000000000..8dcc22a912ac --- /dev/null +++ b/website/content/terminal/reference/crypto/dd/stats.md @@ -0,0 +1,69 @@ +--- +title: stats +description: The 'stats' page provides 24 hour statistical data on cryptocurrencies + with options to view data in various quote currencies. It displays metrics such + as open value, high, low, volume, and last known value. +keywords: +- coin stats +- crypto stats +- quote currency +- 24 hr Product Stats +- USD +- USDC +- USDT +- EUR +- GBP +- volume +- open +- high +- low +- last +- volume_30day +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Display coin stats + +### Usage + +```python +stats [--vs {USD,USDC,USDT,EUR,USD,GBP}] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| vs | Quote currency (what to view coin vs) | USDT | True | USD, USDC, USDT, EUR, USD, GBP | + + +--- + +## Examples + +```python +2022 Feb 15, 07:47 (🦋) /crypto/dd/ $ stats + + 24 hr Product Stats +┌──────────────┬────────────────┐ +│ Metric │ Value │ +├──────────────┼────────────────┤ +│ open │ 42551.99 │ +├──────────────┼────────────────┤ +│ high │ 44428.47 │ +├──────────────┼────────────────┤ +│ low │ 41800 │ +├──────────────┼────────────────┤ +│ volume │ 743.03129474 │ +├──────────────┼────────────────┤ +│ last │ 44183.84 │ +├──────────────┼────────────────┤ +│ volume_30day │ 22665.06104665 │ +└──────────────┴────────────────┘ +``` +--- diff --git a/website/content/terminal/reference/crypto/dd/team.md b/website/content/terminal/reference/crypto/dd/team.md new file mode 100644 index 000000000000..658ca698a235 --- /dev/null +++ b/website/content/terminal/reference/crypto/dd/team.md @@ -0,0 +1,32 @@ +--- +title: team +description: 'Information about functions related to displaying an asset''s team, + with usage instructions and noting that there are no parameters required. Source: + Messari.io' +keywords: +- team +- display asset's team +- messari.io +- no parameters +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Display asset's team [Source: https://messari.io] + +### Usage + +```python +team +``` + +--- + +## Parameters + +This command has no parameters + + +--- diff --git a/website/content/terminal/reference/crypto/dd/tk.md b/website/content/terminal/reference/crypto/dd/tk.md new file mode 100644 index 000000000000..250b5fd093b2 --- /dev/null +++ b/website/content/terminal/reference/crypto/dd/tk.md @@ -0,0 +1,31 @@ +--- +title: tk +description: Learn about usage and parameters of the tk command which displays asset's + tokenomics. Access source and detailed guidance here. +keywords: +- tk +- asset's tokenomics +- no parameters +- messari.io source +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Display asset's tokenomics [Source: https://messari.io] + +### Usage + +```python +tk +``` + +--- + +## Parameters + +This command has no parameters + + +--- diff --git a/website/content/terminal/reference/crypto/dd/trades.md b/website/content/terminal/reference/crypto/dd/trades.md new file mode 100644 index 000000000000..7787a181a1eb --- /dev/null +++ b/website/content/terminal/reference/crypto/dd/trades.md @@ -0,0 +1,39 @@ +--- +title: trades +description: This page provides a comprehensive guide on how to get the latest trades + for a selected coin, demonstrating usage in Python. It explains the parameters required + and supports a variety of exchanges, including Binance and Bitfinex. +keywords: +- trades +- cryptocurrency +- coin +- exchange +- parameters +- quote currency +- bitfinex +- binance +- usage +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Get the latest trades for selected coin + +### Usage + +```python +trades [-e {aax,alpaca,ascendex,bequant,bibox,bigone,binance,binancecoinm,binanceus,binanceusdm,bit2c,bitbank,bitbay,bitbns,bitcoincom,bitfinex,bitfinex2,bitflyer,bitforex,bitget,bithumb,bitmart,bitmex,bitopro,bitpanda,bitrue,bitso,bitstamp,bitstamp1,bittrex,bitvavo,bkex,bl3p,blockchaincom,btcalpha,btcbox,btcex,btcmarkets,btctradeua,btcturk,buda,bw,bybit,bytetrade,cex,coinbase,coinbaseprime,coinbasepro,coincheck,coinex,coinfalcon,coinmate,coinone,coinspot,crex24,cryptocom,currencycom,delta,deribit,digifinex,eqonex,exmo,flowbtc,fmfwio,ftx,ftxus,gate,gateio,gemini,hitbtc,hitbtc3,hollaex,huobi,huobijp,huobipro,idex,independentreserve,indodax,itbit,kraken,kucoin,kucoinfutures,kuna,latoken,lbank,lbank2,liquid,luno,lykke,mercado,mexc,mexc3,ndax,novadax,oceanex,okcoin,okex,okex5,okx,paymium,phemex,poloniex,probit,qtrade,ripio,stex,therock,tidebit,tidex,timex,tokocrypto,upbit,wavesexchange,wazirx,whitebit,woo,yobit,zaif,zb,zipmex,zonda}] [--vs VS] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| exchange | Exchange to search for order book | binance | True | aax, alpaca, ascendex, bequant, bibox, bigone, binance, binancecoinm, binanceus, binanceusdm, bit2c, bitbank, bitbay, bitbns, bitcoincom, bitfinex, bitfinex2, bitflyer, bitforex, bitget, bithumb, bitmart, bitmex, bitopro, bitpanda, bitrue, bitso, bitstamp, bitstamp1, bittrex, bitvavo, bkex, bl3p, blockchaincom, btcalpha, btcbox, btcex, btcmarkets, btctradeua, btcturk, buda, bw, bybit, bytetrade, cex, coinbase, coinbaseprime, coinbasepro, coincheck, coinex, coinfalcon, coinmate, coinone, coinspot, crex24, cryptocom, currencycom, delta, deribit, digifinex, eqonex, exmo, flowbtc, fmfwio, ftx, ftxus, gate, gateio, gemini, hitbtc, hitbtc3, hollaex, huobi, huobijp, huobipro, idex, independentreserve, indodax, itbit, kraken, kucoin, kucoinfutures, kuna, latoken, lbank, lbank2, liquid, luno, lykke, mercado, mexc, mexc3, ndax, novadax, oceanex, okcoin, okex, okex5, okx, paymium, phemex, poloniex, probit, qtrade, ripio, stex, therock, tidebit, tidex, timex, tokocrypto, upbit, wavesexchange, wazirx, whitebit, woo, yobit, zaif, zb, zipmex, zonda | +| vs | Quote currency (what to view coin vs) | usdt | True | AUD, BIDR, BKRW, BNB, BRL, BTC, BUSD, BVND, DAI, DOGE, DOT, ETH, EUR, GBP, IDRT, NGN, PAX, PLN, RUB, TRX, TRY, TUSD, UAH, USDC, USDP, USDS, USDT, UST, VAI, XRP, ZAR | + +--- diff --git a/website/content/terminal/reference/crypto/dd/twitter.md b/website/content/terminal/reference/crypto/dd/twitter.md new file mode 100644 index 000000000000..c7b1041b04b3 --- /dev/null +++ b/website/content/terminal/reference/crypto/dd/twitter.md @@ -0,0 +1,91 @@ +--- +title: twitter +description: This page provides information on how to use the twitter function to + display the last 10 tweets for a given coin. The function includes parameters such + as limit and sortby which can be used to customize the output. The tweets are displayed + with their date, user_name, status, retweet_count, and like_count. +keywords: +- twitter +- tweets +- sorting +- limit parameter +- ascending sort +- descending sort +- date +- user_name +- status +- retweet_count +- like_count +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Show last 10 tweets for given coin. You can display only N number of tweets with --limit parameter. You can sort data by date, user_name, status, retweet_count, like_count --sort parameter and also with --reverse flag to sort ascending. Displays: date, user_name, status, retweet_count, like_count + +### Usage + +```python +twitter [-l LIMIT] [-s {date,user_name,status,retweet_count,like_count}] [-r] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| limit | Limit of records | 10 | True | None | +| sortby | Sort by given column. Default: date | date | True | date, user_name, status, retweet_count, like_count | +| reverse | Data is sorted in descending order by default. Reverse flag will sort it in an ascending way. Only works when raw data is displayed. | False | True | None | + + +--- + +## Examples + +```python +2022 Feb 15, 07:49 (🦋) /crypto/dd/ $ twitter + Twitter Timeline +┌────────────┬────────────────┬──────────────────────────────────────────────────────────────────────────────────┬───────────────┬────────────┐ +│ date │ user_name │ status │ retweet_count │ like_count │ +├────────────┼────────────────┼──────────────────────────────────────────────────────────────────────────────────┼───────────────┼────────────┤ +│ 2021-10-27 │ bitcoincoreorg │ Bitcoin Core 0.20.2 (backports) was released It is available from │ 67 │ 153 │ +│ 10:55:48 │ │ https://t.co/ea0sMBjrp2 Release mail: https://t.co/KahVJFcZ9d │ │ │ +├────────────┼────────────────┼──────────────────────────────────────────────────────────────────────────────────┼───────────────┼────────────┤ +│ 2021-09-13 │ bitcoincoreorg │ Bitcoin Core 22.0 was released! It is available from https://t.co/WpMuMaejz1 │ 366 │ 1065 │ +│ 22:01:09 │ │ Release mail: https://t.co/ZvZKXZ0iLD │ │ │ +├────────────┼────────────────┼──────────────────────────────────────────────────────────────────────────────────┼───────────────┼────────────┤ +│ 2021-07-20 │ LukeDashjr │ PSA: @BitcoinCoreOrg (#Bitcoin Core) is NOT soliciting or performing closed │ 88 │ 0 │ +│ 21:51:31 │ │ testing of any beta or other software.If you get an email inviting you, be │ │ │ +│ │ │ aware it is spam and their "testing version" is almost certainly malware.Note: │ │ │ +│ │ │ the "From" on emails is NOT secure and faked. │ │ │ +├────────────┼────────────────┼──────────────────────────────────────────────────────────────────────────────────┼───────────────┼────────────┤ +│ 2021-07-03 │ bitcoincoreorg │ A reminder that Bitcoin Core is available for download worldwide through │ 192 │ 577 │ +│ 08:25:13 │ │ https://t.co/WpMuMaejz1 . It is also available through BitTorrent. │ │ │ +├────────────┼────────────────┼──────────────────────────────────────────────────────────────────────────────────┼───────────────┼────────────┤ +│ 2021-06-03 │ pwuille │ In version 0.21 @bitcoincoreorg added support for Tor V3: │ 73 │ 0 │ +│ 17:16:25 │ │ https://t.co/yIUqYjqQnGFor the next major release we're dropping V2 support. │ │ │ +│ │ │ Their usability will rapidly diminish the next few months, as they're deprecated │ │ │ +│ │ │ and @torproject will soon remove support. https://t.co/XEUbSnVmCe │ │ │ +├────────────┼────────────────┼──────────────────────────────────────────────────────────────────────────────────┼───────────────┼────────────┤ +│ 2021-05-02 │ bitcoincoreorg │ Bitcoin Core 0.21.1 was released! It is available from https://t.co/WpMuMaejz1 │ 159 │ 583 │ +│ 07:21:00 │ │ Release mail: https://t.co/TuFxSkQABE │ │ │ +├────────────┼────────────────┼──────────────────────────────────────────────────────────────────────────────────┼───────────────┼────────────┤ +│ 2021-04-19 │ bitcoincoreorg │ Bitcoin Core 0.21.1 release candidate 1 available https://t.co/BSQjJiRuHw │ 59 │ 222 │ +│ 04:59:28 │ │ https://t.co/KQMiZFHnZy │ │ │ +├────────────┼────────────────┼──────────────────────────────────────────────────────────────────────────────────┼───────────────┼────────────┤ +│ 2021-01-19 │ achow101 │ I'm launching a Bitcoin Core usage survey: https://t.co/O3mbn4vnCPThe survey │ 106 │ 0 │ +│ 20:59:02 │ │ will help us learn about who, how, and why people use Bitcoin Core so that we │ │ │ +│ │ │ can improve it in the future. If you have any feedback about the software you │ │ │ +│ │ │ want to leave, this is the place to do it. │ │ │ +├────────────┼────────────────┼──────────────────────────────────────────────────────────────────────────────────┼───────────────┼────────────┤ +│ 2021-01-14 │ bitcoincoreorg │ Bitcoin Core 0.21.0 was released It is available from https://t.co/jnWN8LRX75 │ 283 │ 907 │ +│ 14:09:31 │ │ Release mail: https://t.co/6dFNUj3K4d │ │ │ +├────────────┼────────────────┼──────────────────────────────────────────────────────────────────────────────────┼───────────────┼────────────┤ +│ 2020-08-01 │ bitcoincoreorg │ Bitcoin Core 0.20.1 was released It is available from https://t.co/Uy9NJ11mih │ 216 │ 544 │ +│ 13:15:33 │ │ (main website update pending) Release mail: https://t.co/95MXgRvN7Z │ │ │ +└────────────┴────────────────┴──────────────────────────────────────────────────────────────────────────────────┴───────────────┴────────────┘ +``` +--- diff --git a/website/content/terminal/reference/crypto/dd/web.md b/website/content/terminal/reference/crypto/dd/web.md new file mode 100644 index 000000000000..2b5c0ec22da1 --- /dev/null +++ b/website/content/terminal/reference/crypto/dd/web.md @@ -0,0 +1,53 @@ +--- +title: web +description: This page offers information on how to find websites for a given Coin, + including homepages, forums, and announcement sites. It also provides a guide on + how to use the web command with no parameters. +keywords: +- crypto +- coin +- websites +- homepages +- forums +- announcement sites +- web command +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Websites found for given Coin. You can find there urls to homepage, forum, announcement site and others. + +### Usage + +```python +web +``` + +--- + +## Parameters + +This command has no parameters + + + +--- + +## Examples + +```python +2022 Feb 15, 07:49 (🦋) /crypto/dd/ $ web + Websites for Loaded Coin +┌────────────────────┬──────────────────────────┐ +│ Metric │ Value │ +├────────────────────┼──────────────────────────┤ +│ Homepage │ http://www.bitcoin.org │ +├────────────────────┼──────────────────────────┤ +│ Official Forum Url │ https://bitcointalk.org/ │ +├────────────────────┼──────────────────────────┤ +│ Announcement Url │ │ +└────────────────────┴──────────────────────────┘ +``` +--- diff --git a/website/versioned_docs/version-v3/terminal/reference/crypto/defi/_category_.json b/website/content/terminal/reference/crypto/defi/_category_.json similarity index 100% rename from website/versioned_docs/version-v3/terminal/reference/crypto/defi/_category_.json rename to website/content/terminal/reference/crypto/defi/_category_.json diff --git a/website/content/terminal/reference/crypto/defi/anchor.md b/website/content/terminal/reference/crypto/defi/anchor.md new file mode 100644 index 000000000000..8defd37ea71d --- /dev/null +++ b/website/content/terminal/reference/crypto/defi/anchor.md @@ -0,0 +1,47 @@ +--- +title: anchor +description: This documentation covers the usage of anchor which displays earnings + data of a specific terra address. It also provides the option to view the history + of past transactions. The page provides code examples for better understanding. +keywords: +- anchor +- terra +- cryptocurrency +- crypto +- Blockchain +- earnings data +- transactions history +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Displays anchor protocol earnings data of a certain terra address --transactions flag can be passed to show history of previous transactions [Source: https://cryptosaurio.com/] + +### Usage + +```python +anchor --address ADDRESS [--transactions] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| address | Terra address. Valid terra addresses start with 'terra' | None | False | None | +| transactions | Flag to show transactions history in anchor earn | False | True | None | + + +--- + +## Examples + +```python +2022 Mar 18, 14:29 (🦋) /crypto/defi/ $ anchor terra13kc0x8kr3sq8226myf4nmanmn2mrk9s5s9wsnz --transactions +``` +![anchor](https://user-images.githubusercontent.com/43375532/159065235-e8fb189d-f670-4391-a7fc-064640b9607d.png) + +--- diff --git a/website/content/terminal/reference/crypto/defi/dtvl.md b/website/content/terminal/reference/crypto/defi/dtvl.md new file mode 100644 index 000000000000..efa0b8b11c11 --- /dev/null +++ b/website/content/terminal/reference/crypto/defi/dtvl.md @@ -0,0 +1,1116 @@ +--- +title: dtvl +description: dtvl is a tool designed for tracking the historical Total Value Locked + (TVL) of different decentralized applications (dApps). It offers users commands + to search and display historical TVL data for specific crypto dApps, providing valuable + insights for crypto investors and enthusiasts. +keywords: +- docusaurus SEO +- website marketing +- dApps TVL +- historical TVL +- TVL tracking +- crypto Dapps +- crypto TVL +- TVL analytics +- TVL data +- crypto data +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Displays historical TVL of different dApps. [Source: https://docs.llama.fi/api] + +### Usage + +```python +dtvl -d DAPPS +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| dapps | dApps to search historical TVL. Should be split by , e.g.: anchor,sushiswap,pancakeswap | None | False | None | + + +--- + +## Examples + +```python +0.exchange +1bch +1inch-network +1swap +88mph +8ightdao +aave +aavegotchi +abracadabra +acoconut +across +acryptos +acumen +adamant-finance +adena-finance +afraswap +agarthadao +agave +aladdin-dao +alchemist +alchemix +aldrin +algofi +aliensfarm +alita-finance +alium-swap +alkemi +allbridge +allinx +almond +alpaca-city +alpaca-finance +alpha-finance +amogus-dao +amun-tokens +amy-finance +anchor +anchorswap +angle +ankr +annex +ante-finance +aperocket +apeswap +apollodao +apricot-finance +apwine +apy-finance +aquarius +ara-finance +arbicheems +arbinyan +arbirise-finance +arbis-finance +arcx +arenaswap +arkadiko +armor +arrow +artemis-protocol +asgard-dao +asgard-finance +asol +astroport +atlantis-loans +atlas-usv +atmossoft +atrix +auctus +augmented-finance +augur +augury-finance +auroraswap +autofarm +autoshark +avalaunch +avalps +avaviking +avaware +axedao +axial +aztec +b.protocol +babylon-finance +babypig-finance +babyswap +back-finance +bacondao +badger-dao +bagels-finance +baguette +baker-guild +bakeryswap +balanced +balancer +bamboodefi +bananafarm +banano +bancor +banksy-farm +bao-finance +barnbridge +base-protocol +basis-cash +basketdao +beanstalk +bear-finance +bearn +becoswap +beefy-finance +beethoven-x +beglobal-finance +behodler +bella-protocol +belt-finance +benqi +benswap +bepswap +beta-finance +bifi +big-data-protocol +billion-happiness +bishares +biswap +bitant +bitpif +blackbird-finance +blackpool +blizzard +blizz-finance +bnbminer-finance +bogged-finance +bondappetit +boofinance +borgswap +boringdao +bossswap +bouje-finance +bourbon-dao +brahma +bridge-mutual +brinc +bring.finance +brokoli-network +bscstation +bscswap +bt.finance +btc-proxy +btcst +buffaloswap +bumper-finance +bunny +bunnypark +bxh +cafeswap +cakedao +canary +cap +capital-dao +carbon-finance +carbonswap +cardstarter +caribou-finance +cashcow-finance +cashcow-protocol +cashio +cbridge +cerberusdao +chad-finance +chainge-finance +chainport +channels-finance +chargedefi +charm-finance +cheesedao +cherryswap +chest-finance +chfry-finance +chickenswap +chikn-farm +chronicle +chronoswap +clipper +cobraswap +coffin-finance +cofix +coinswap-space +coinwind +colony +cometh +complifi +complus-network +component +composable-finance +compound +connext +convergence +convex-finance +cook-finance +corgiswap +cougarswap +coup-farm +cover-protocol +cozy-finance +cream-finance +creamswap +crodex +cronaswap +crow-finance +crunchy-network +cryptex +cryptoyieldfocus +crystl-finance +cub-finance +curve +cvault-finance +cvi-finance +cyber-dog +cyberfantasyfembots +cybertime +cycle-finance +cyclone +cyclos +dao-maker +daoventures +dapp-account-dao +dark-matter +ddex +decubate +deepseadao +deerfi +defibox +defichain-dex +defichain-loans +defidollar-dao +defi-halal +defi-kingdoms +defily +definer +definix +defiplaza +defirex +defisaver +defis-network +defi-swap +defi-yield-protocol +defrost +defyswap +dehive +demeter +depth +deri-protocol +derivadex +deversifi +dev-protocol +dforce +dfx-finance +dfyn-network +dhedge +dino.exchange +dinosaur-eggs +dinoswap +dios-finance +dodo +doki-doki-finance +domani-protocol +donkey +dopex +dopple-finance +draco-force +dracula +drift +drops +duckydefi +dungeonswap +dydx +ecurve +eggtartswap +element-finance +elephantdex +eleven-finance +elk +ellipsis-finance +embr-finance +emerald-swap +emiswap +empiredex +energiswap +enterdao +entropyfi +enzyme-finance +eosauthority-rex +erasure +ergodex +ester-finance +ethernity-chain +euler +euphoria +everestdao +everipedia +everrise +evolutionland +exinswap +exodia +fabric +fantohm +fantompup +farmersonly +farm-hero +feeder-finance +fegex +fei-protocol +ferrum +fiat-dao +filda +finnexus +firebird +firedao +flame-defi +flamincome +flamingo-finance +flare-loans +flarex +flashstake +flexa +float-capital +float-protocol +fluity +flux-protocol +fodl-finance +forcedao +fortress +fortube +fortune-dao +fractional-art +francium +frax +freeliquid +freeriver +friktion +frost-finance +ftm-frens +fuji-dao +furucombo +fusefi +futureswap +fuzz-finance +gains-network +gaj-finance +galatea-cash +galaxygoogle-dao +gamma +gearbox +geist-finance +genesis-finance +genesys +genshiro +geyser +gibxswap +giza-dao +glide-finance +globiance +gmx +gnosis +goldfinch +golff-protocol +gondola-finance +goose-finance +goswap +governor-dao +grassland-finance +gravity-finance +grim-finance +gro +growth-defi +guard(helmet) +g-uni +gyro +hades-swap +hakka-finance +halodao +handle-fi +harvest-finance +hbtc +hector-dao +hegic +helios-prime +hermes-defi +hex +hfione +honeyfarm +honeyswap +hop-protocol +hotpot-finance +hpdex +hswap +huckleberry +hundred-finance +hunny-finance +hurricaneswap +hyper-finance +hyperswap +ice-colony +ice-dao +ichi-farm +ideamarket +idex +idle-finance +ifpool +ifswap +illuvium +impermax-finance +impossible-finance +imtoken +index-coop +indexed-finance +injective-protocol +ink-protocol +instadapp +instrumental-finance +insurace +integral +inverse-finance +invictusdao +iron-finance +itrust-finance +jade-protocol +jaguarswap +jarvis-network +jet +jetfuel-finance +jetswap +jpool +jswap +justcryptos +justlend +juststables +kaco-finance +kafe-finance +kaidex +kalata +karma-dao +karura-dollar-(kusd) +karura-liquid-staking +karura-swap +katana +katana-dex +kava +kava-lend +kava-swap +kawaiiswap +kebab-finance +keep3r-network +keeperdao +keep-network +kimochi +kine-finance +kingdefi +kitty-finance +klayswap +klend +klima-dao +klondike-finance +knightswap-finance +knit-finance +koala-defi +kogefarm +kokomoswap +kokoswap +kolibri +kronos-dao +kryptodex +kswap-finance +kuswap +kuu-finance +kwikswap +kyber +larix +latteswap +layer2-finance +leaguedao +lemonswap +lendhub +leonicornswap +levinswap +lido +lien +life-dao +lightning-network +linear-finance +liqee +liquid-driver +liquidrium +liquidswap +liquity +lixir-finance +lobis +longdrink +loop-finance +loopring +lootswap +loterra +louverture +luaswap +lumenswap +luxor-money +lydia +lyra +macaronswap +magic-land +magnet-dao +maiar-exchange +makerdao +makiswap +mama-dao +mango-markets +manifest +mantra-dao +maple +marginswap +marinade-finance +market +mars-ecosystem +marshmallowdefi +mars-poolin +matrix-farm +maximizer +mcdex +mdex +mean-finance +mensa-protocol +mento +meowswap +mercurial-finance +mercurity +merit-circle +merlin +meso-finance +metacrono +meta-pool +metareserve +metaversepro +metronome +mfinance +midasdao +mimas-finance +mimo-defi +miningtycoon +miniswap +minmax-finance +mint-club +mintswap +mirai +mirror +mistswap +mm-finance +mm-optimizer +mobius-finance +mobius-money +mobox +mochifi +mochiswap +mojitoswap +moneyonchain +monox +moola-market +moondao +moonfarm +mooniswap +moonpot +moonswap +morpheus-swap +mstable +muesliswap +multichain +multi-chain-miner +multiplier +mushrooms-finance +n3rd-finance +nacho-finance +naos-finance +nasdex +nearpad +necc +neku +nemesis-dao +nerve +nerve-network +nest-protocol +netswap +neutrino +newdex +newland +nexus-mutual +nexus-protocol +nft20 +nftb +nftx +nidhi-dao +niifi +nileriver +niob-finance +notional +nowswap +nsure +nuls +numbers-protocol +o2-dao +o3-swap +oakfarm +obswap +ocean-protocol +ocp-finance +oddz +oh-finance +ola-finance +olive-cash +olympus-dao +omicron +omm +ondo-finance +one-cash +onedao-finance +oneswap +only1 +onx-finance +ooki +oolongswap +opendao +openleverage +openocean +openswap +opium +optidoge +optinyan +opyn +oraichain +orca +orcadao +origin-dollar +orion-money +orion-protocol +osmosis +otterclam +ouchi-finance +overnight +ovr +oxygen +pacoca +padswap +paint-swap +pala +paladin-finance +pancakeswap +pandaswap +pando +pangolin +pantherswap +papa-dao +paraswap +parrot-defi +parrot-protocol +partyswap +peakdefi +pendle +penguin-finance +percent-finance +perlin +perpetual-protocol +phoenix-finance +photonswap-finance +pickle +pidao-finance +piedao +piggy +piggybank-dao +piggy-finance +pika-protocol +pilot-protocol +pinkswap +pinyottas +pippi +piratedao +pizza +planet-finance +platypus-finance +plenty-defi +pnetwork +pods-finance +pole-aggregator +polkaex +polkamarkets +polkastarter +polkaswap +polly-finance +polycat +polydex +polydex-cryption-network +polygon-bridge-&-staking +polygonfarm-finance +polymarket +polyquity +polyroll +polyshield +polywhale-finance +polyyeld-finance +poof-cash +pooltogether +popsicle-finance +pop-town +port-finance +position-exchange +potluck-protocol +powerbomb-finance +powerpool +predictcoin +premia +primitive +pstake +psyoptions +pumpkin-dao +purefi +pureswap +pylon-protocol +qian +qidao +qilin +quarry +qubit +quickswap +quipuswap +rabbit-finance +radao +ragnarokdao +ramp +ram-protocol +rari-capital +rarify +raven +raydium +realt +reaper-farm +redacted-cartel +ref-finance +reflexer +renvm +reserve +retreeb +retrodefi +revault +reverse +revest-finance +ribbon-finance +risq-protocol +rivrkitty +robiniaswap +robo-advisor-for-yield +robo-vault +rocket-pool +rocketswap +romedao +rose +rskswap +rubicon +r-u-generous +ruler +saber +sablier-finance +saddle-finance +safedollar +safeohm +safeswap +saffron-finance +sakeperp +salem-finance +samodao +sapphire-defi +sashimiswap +scarab-finance +scarecrow-finance +scientix +scream +seadex +secret-bridge +secret-network +secretswap +securedao +seeder-finance +sencha +senpaiswap +sentre +serum +serum-swap +set-protocol +s-finance +shadecash +shapeshift +sharedstake +sheepdex +sheesha-finance +shell-protocol +sherlock +shiba-fantom +shibance +shibaswap +shield +shinobi +sifchain +singular-farm +siren +skeleton-finance +smartcoin +smartdex +smolswap +smoothy +snowball +snowbank +snowcatdao +snowdog +snowswap +socean +socialswap +soda-protocol +solana-farm +solarbeam +solend +solo-top +solyard +sonicswap +soulswap +sovryn +soy-finance +spartacus +spectrum-protocol +sperax-usd +spicy-dao +spicyswap +spiritdao +spiritswap +spookyswap +squiddao +squid-defi +squid-stake +stabilize +stacker-ventures +stacks-staking +stader +stafi +stakedao +stakehound +stakesteak +stakewise +standard-protocol +stand-cash +stargate-finance +starterra +steakbank-finance +stellarx +stonedefi +stormswap +strike +strudel-finance +summit-defi +sumswap +sun.io +sunflower-finance +sunflowerswap +sunny +sunrise-gaming +sunswap +superfarm +superfluid +sushiswap +suterusu +swamp-finance +swap-cat +swapmatic +swapp +swapperchan +swapr +swarm-markets +swerve +swift-finance +swing-dao +swipe +swop +symmetric +synapse +sync-network +synlev +synthetify +synthetix +taichi +talent-protocol +tangoswap +tarot +tectonic +teddy-cash +telcoin +telos-swap +templar-dao +temple-dao +tempodao +tempus-finance +tendieswap +tenet +ten-finance +terraswap +tesseract +tethys-finance +tetu +tezos-liquidity-baking +thales +the-dragons-lair +the-grand-banks +the-sandbox +the-seed-farm +thetanuts +thorchain +thoreum-finance +thorstarter +thorusfi +tidal-finance +timewarp +tinlake +tinyman +tokemak +tokenlon +tomb-finance +tomofinance +ton-swap +topshelf +tornadao +tornado-cash +totemfi +tracer +trader-joe +tranche-finance +tranchess +tranquil-finance +trava-finance +treedefi +trick-or-treat-farm +trisolaris +tropical-finance +truefi +ttswap +tulip-protocol +twindex +typhoon-cash +ubeswap +ubiquity-dao +umami-finance +uma-protocol +umbrella-network +umbria-network +unagii +undead-finance +unfederalreserve +unicly +unifarm +unifi +unilend +union-finance +unipower +unirex-finance +uniswap +unite-finance +unit-protocol +unitrade +universe-finance +universe-xyz +unore +unslashed +unusdao +upfi-network +valhalladao +valkyrie +valuedefi +value-liquid +vampireswap +vanilla +vaporwave +varen +vaulty-finance +vee-finance +venus +vesper +vexchange +vigor +vikingsfinance +viperswap +vires-finance +volmex +vortex-dao +voyager +vultureswap +vvs-finance +wagmidao +wagyuswap +waka-finance +wannaswap +wanswap-dex +wardenswap +warp-protocol +wasabix +waterloan +wault +waves-exchange +wbtc +wepiggy +westarter +whale-loans +wheat-protocol +whiteheart +wild-credit +wing-finance +wingswap +wisteria-swap +witswap +wonderland +wraithswap +wrapped +wrapped-bnb +wrap-protocol +xdai-stake-bridge +xdefi +xdollar +xenophon +xensa +xeus +xmas-past +xsigma +xtoken +xusd-money +yam-finance +yapeswap +yaxis +yearn-finance +yel-finance +yetiswap +yfdai +yfii +yieldly +yield-protocol +yield-yak +yogi-finance +yokaiswap +yoshi-exchange +youswap +youves +ysl.io +zabu-finance +zai-finance +zencha-finance +zenlink +zeus-finance +zigzag +zilswap +zkswap +zlot +zodiacdao +zoocoin +zookeeper +zoomswap +zunami +zyxswap +``` +![dtvl](https://user-images.githubusercontent.com/46355364/154051510-e048f525-e9d3-4eae-a0c9-dbea62843310.png) + +--- diff --git a/website/content/terminal/reference/crypto/defi/gacc.md b/website/content/terminal/reference/crypto/defi/gacc.md new file mode 100644 index 000000000000..e888ea3d3892 --- /dev/null +++ b/website/content/terminal/reference/crypto/defi/gacc.md @@ -0,0 +1,37 @@ +--- +title: gacc +description: This page provides information on how to display the terra blockchain + account growth history using the 'gacc' function. It includes usage instructions, + parameters description, and an explanatory diagram. +keywords: +- terra blockchain +- account growth history +- gacc function +- parameters description +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Displays terra blockchain account growth history. [Source: https://fcd.terra.dev/swagger] + +### Usage + +```python +gacc [-l LIMIT] [--cumulative] [-k {active,total}] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| limit | Number of days to show | 90 | True | None | +| cumulative | Show cumulative or discrete values. For active accounts only discrete value are available | True | True | None | +| kind | Total account count or active account count. Default: total | total | True | active, total | + +![gacc](https://user-images.githubusercontent.com/46355364/154051829-8225869b-6ea8-434e-afd6-51b9c81e0ade.png) + +--- diff --git a/website/content/terminal/reference/crypto/defi/gdapps.md b/website/content/terminal/reference/crypto/defi/gdapps.md new file mode 100644 index 000000000000..d1aa50d96696 --- /dev/null +++ b/website/content/terminal/reference/crypto/defi/gdapps.md @@ -0,0 +1,38 @@ +--- +title: gdapps +description: This is a detailed guide on using the gdapps function. It helps to display + top dApps based on TVL grouped by chain, including usage and parameters information. +keywords: +- gdapps +- dApps +- TVL +- chain +- display +- parameters +- limit +- usage +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Display top dApps (in terms of TVL) grouped by chain. [Source: https://docs.llama.fi/api] + +### Usage + +```python +gdapps [-l LIMIT] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| limit | Number of top dApps to display | 40 | True | None | + +![gdapps](https://user-images.githubusercontent.com/46355364/154051959-ca11b04f-8f53-4299-8c20-13ea75869082.png) + +--- diff --git a/website/content/terminal/reference/crypto/defi/lcsc.md b/website/content/terminal/reference/crypto/defi/lcsc.md new file mode 100644 index 000000000000..8037d12c6048 --- /dev/null +++ b/website/content/terminal/reference/crypto/defi/lcsc.md @@ -0,0 +1,42 @@ +--- +title: lcsc +description: This is a documentation page for the 'lcsc' function which displays Luna + circulating supply changes. The function sources its data from Smartstake.io. Instructions + are provided on obtaining the required key token from Smartstake.io alongside usage + and parameters information. +keywords: +- lcsc +- Luna circulating supply +- Smartstake.io +- key token +- Inspect tool +- Fetch/XHR tab +- listData +- history +- dayCount +- URL extraction +- parameters +- range +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Display Luna circulating supply changes stats. [Source: Smartstake.io] Follow these steps to get the key token: 1. Head to https://terra.smartstake.io/ 2. Right click on your browser and choose Inspect 3. Select Network tab (by clicking on the expand button next to Source tab) 4. Go to Fetch/XHR tab, and refresh the page 5. Get the option looks similar to the following: `listData?type=history&dayCount=30` 6. Extract the key and token out of the URL + +### Usage + +```python +lcsc [-d DAYS] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| days | Number of days to display. Default: 30 days | 30 | True | range(1, 1000) | + +--- diff --git a/website/content/terminal/reference/crypto/defi/ldapps.md b/website/content/terminal/reference/crypto/defi/ldapps.md new file mode 100644 index 000000000000..f2f70abce464 --- /dev/null +++ b/website/content/terminal/reference/crypto/defi/ldapps.md @@ -0,0 +1,78 @@ +--- +title: ldapps +description: This documentation page provides detailed information on how to display + and interpret data on Decentralized Applications (dApps) listed on DeFi Llama including + parameters, usage and examples. +keywords: +- DeFi Llama +- dApps +- Decentralized Applications +- ldapps command +- Usage +- Parameters +- Examples +- Crypto +- Crypto Sorting +- Crypto Commands +- Blockchain +- Decentralized Finance +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Display information about listed dApps on DeFi Llama. [Source: https://docs.llama.fi/api] + +### Usage + +```python +ldapps [-l LIMIT] [-s {tvl,symbol,category,chains,change_1h,change_1d,change_7d,name}] [-r] [--desc] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| limit | Number of records to display | 10 | True | None | +| sortby | Sort by given column. Default: tvl | tvl | True | tvl, symbol, category, chains, change_1h, change_1d, change_7d, name | +| reverse | Data is sorted in descending order by default. Reverse flag will sort it in an ascending way. Only works when raw data is displayed. | False | True | None | +| description | Flag to display description of protocol | False | True | None | + + +--- + +## Examples + +```python +2022 Feb 15, 06:24 (🦋) /crypto/defi/ $ ldapps +┌──────────────────────────┬────────┬──────────┬──────────────────────────────────────────────────┬───────────────┬───────────────┬───────────────┬──────────┐ +│ Name │ Symbol │ Category │ Chains │ Change 1H (%) │ Change 1D (%) │ Change 7D (%) │ TVL ($) │ +├──────────────────────────┼────────┼──────────┼──────────────────────────────────────────────────┼───────────────┼───────────────┼───────────────┼──────────┤ +│ Curve │ CRV │ Dexes │ Ethereum, Avalanche, Fantom, Polygon, Arbitrum, │ 0.00 │ 1.26 │ 1.24 │ 19.752 B │ +│ │ │ │ xDai, Harmony, Optimism │ │ │ │ │ +├──────────────────────────┼────────┼──────────┼──────────────────────────────────────────────────┼───────────────┼───────────────┼───────────────┼──────────┤ +│ MakerDAO │ MKR │ CDP │ Ethereum │ 0.00 │ 4.68 │ -0.35 │ 17.551 B │ +├──────────────────────────┼────────┼──────────┼──────────────────────────────────────────────────┼───────────────┼───────────────┼───────────────┼──────────┤ +│ Convex Finance │ CVX │ Yield │ Ethereum │ -0.00 │ 1.98 │ 0.40 │ 13.657 B │ +├──────────────────────────┼────────┼──────────┼──────────────────────────────────────────────────┼───────────────┼───────────────┼───────────────┼──────────┤ +│ AAVE │ AAVE │ Lending │ Ethereum, Avalanche, Polygon │ 0.00 │ 3.06 │ -0.02 │ 13.597 B │ +├──────────────────────────┼────────┼──────────┼──────────────────────────────────────────────────┼───────────────┼───────────────┼───────────────┼──────────┤ +│ WBTC │ WBTC │ Bridge │ Ethereum │ 0.13 │ 5.03 │ 1.06 │ 11.633 B │ +├──────────────────────────┼────────┼──────────┼──────────────────────────────────────────────────┼───────────────┼───────────────┼───────────────┼──────────┤ +│ Polygon Bridge & Staking │ MATIC │ Chain │ Polygon │ 0.00 │ -1.84 │ 1.42 │ 10.344 B │ +├──────────────────────────┼────────┼──────────┼──────────────────────────────────────────────────┼───────────────┼───────────────┼───────────────┼──────────┤ +│ Lido │ LDO │ Staking │ Ethereum, Terra, Solana │ 0.00 │ 8.70 │ 0.42 │ 9.626 B │ +├──────────────────────────┼────────┼──────────┼──────────────────────────────────────────────────┼───────────────┼───────────────┼───────────────┼──────────┤ +│ Anchor │ ANC │ Lending │ Terra │ -0.00 │ 5.25 │ 5.51 │ 8.401 B │ +├──────────────────────────┼────────┼──────────┼──────────────────────────────────────────────────┼───────────────┼───────────────┼───────────────┼──────────┤ +│ Uniswap │ UNI │ Dexes │ Ethereum, Polygon, Arbitrum, Optimism │ 0.78 │ 5.38 │ 0.13 │ 7.652 B │ +├──────────────────────────┼────────┼──────────┼──────────────────────────────────────────────────┼───────────────┼───────────────┼───────────────┼──────────┤ +│ Multichain │ MULTI │ Bridge │ Fantom, Avalanche, Ethereum, Binance, Moonriver, │ 0.00 │ 3.05 │ -5.37 │ 7.305 B │ +│ │ │ │ Arbitrum, Harmony, OKExChain, Polygon, Telos, │ │ │ │ │ +│ │ │ │ Heco, xDai, Kucoin, Syscoin │ │ │ │ │ +└──────────────────────────┴────────┴──────────┴──────────────────────────────────────────────────┴───────────────┴───────────────┴───────────────┴──────────┘ +``` +--- diff --git a/website/versioned_docs/version-v3/terminal/reference/crypto/defi/newsletter.md b/website/content/terminal/reference/crypto/defi/newsletter.md similarity index 91% rename from website/versioned_docs/version-v3/terminal/reference/crypto/defi/newsletter.md rename to website/content/terminal/reference/crypto/defi/newsletter.md index 38e9e9d89fb8..77e6875e4cf2 100644 --- a/website/versioned_docs/version-v3/terminal/reference/crypto/defi/newsletter.md +++ b/website/content/terminal/reference/crypto/defi/newsletter.md @@ -1,9 +1,21 @@ --- title: newsletter -description: OpenBB Terminal Function +description: This page outlines the usage, parameters, choices, and examples of the + newsletter command, which displays DeFi related substack newsletters. It is part + of a larger toolkit aimed at simplifying tasks within the crypto and DeFi space. +keywords: +- decentralized finance +- DeFi +- newsletter +- substack newsletters +- crypto +- python script +- parameters --- -# newsletter +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + Display DeFi related substack newsletters. [Source: substack.com] diff --git a/website/content/terminal/reference/crypto/defi/pairs.md b/website/content/terminal/reference/crypto/defi/pairs.md new file mode 100644 index 000000000000..6babd57ab1c4 --- /dev/null +++ b/website/content/terminal/reference/crypto/defi/pairs.md @@ -0,0 +1,77 @@ +--- +title: pairs +description: This page provides a detailed guide on how to use recently added pairs + on Uniswap DEX using a command line tool. It includes instructions on usage, parameters, + and examples, providing a comprehensive understanding of sorting and filtering commands + related to trading volume and transaction counts. +keywords: +- Uniswap DEX +- pairs +- trading volume +- transactions +- sort +- reverse +- command line tool +- parameters +- examples +- crypto currencies +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Displays Lastly added pairs on Uniswap DEX. [Source: https://thegraph.com/en/] + +### Usage + +```python +pairs [-l LIMIT] [-v VOL] [-tx TX] [--days DAY] [-s {created,pair,token0,token1,volumeUSD,txCount,totalSupply}] [-r] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| limit | Number of records to display | 10 | True | None | +| vol | Minimum trading volume | 100 | True | range(1, 1000) | +| tx | Minimum number of transactions | 100 | True | range(1, 1000) | +| days | Number of days the pair has been active, | 10 | True | range(1, 1000) | +| sortby | Sort by given column. Default: created | created | True | created, pair, token0, token1, volumeUSD, txCount, totalSupply | +| reverse | Data is sorted in descending order by default. Reverse flag will sort it in an ascending way. Only works when raw data is displayed. | False | True | None | + + +--- + +## Examples + +```python +2022 Feb 15, 06:27 (🦋) /crypto/defi/ $ pairs + Latest Added Pairs on Uniswap DEX +┌─────────────────────┬────────────────┬──────────────────────────────────────┬────────────────────┬───────────┬─────────┬─────────────┐ +│ created │ pair │ token0 │ token1 │ volumeUSD │ txCount │ totalSupply │ +├─────────────────────┼────────────────┼──────────────────────────────────────┼────────────────────┼───────────┼─────────┼─────────────┤ +│ 2022-02-15 07:28:54 │ LIKI/WETH │ Lion King │ Wrapped Ether │ 1.3M │ 327 │ 0 │ +├─────────────────────┼────────────────┼──────────────────────────────────────┼────────────────────┼───────────┼─────────┼─────────────┤ +│ 2022-02-15 05:26:25 │ X2Y2/WETH │ X2Y2Token │ Wrapped Ether │ 51.1M │ 2550 │ 124K │ +├─────────────────────┼────────────────┼──────────────────────────────────────┼────────────────────┼───────────┼─────────┼─────────────┤ +│ 2022-02-14 20:09:09 │ SIN/WETH │ Sins │ Wrapped Ether │ 2.5M │ 1334 │ 0 │ +├─────────────────────┼────────────────┼──────────────────────────────────────┼────────────────────┼───────────┼─────────┼─────────────┤ +│ 2022-02-14 19:41:24 │ YouTube/WETH │ YouTube Metaverse │ Wrapped Ether │ 637.5K │ 105 │ 1.2M │ +├─────────────────────┼────────────────┼──────────────────────────────────────┼────────────────────┼───────────┼─────────┼─────────────┤ +│ 2022-02-14 18:13:14 │ ALI/USDC │ Artificial Liquid Intelligence Token │ USD//C │ 4.3M │ 490 │ 3 │ +├─────────────────────┼────────────────┼──────────────────────────────────────┼────────────────────┼───────────┼─────────┼─────────────┤ +│ 2022-02-14 16:49:02 │ SuperBowl/WETH │ SuperBowl Metaverse │ Wrapped Ether │ 3.1M │ 161 │ 1.3M │ +├─────────────────────┼────────────────┼──────────────────────────────────────┼────────────────────┼───────────┼─────────┼─────────────┤ +│ 2022-02-14 13:31:57 │ LUSHI/WETH │ LuckyShinu │ Wrapped Ether │ 485.3K │ 770 │ 1.3K │ +├─────────────────────┼────────────────┼──────────────────────────────────────┼────────────────────┼───────────┼─────────┼─────────────┤ +│ 2022-02-14 13:22:44 │ Google/WETH │ Google Metaverse │ Wrapped Ether │ 3.4M │ 189 │ 745.7K │ +├─────────────────────┼────────────────┼──────────────────────────────────────┼────────────────────┼───────────┼─────────┼─────────────┤ +│ 2022-02-13 18:04:58 │ WETH/SKYWALKER │ Wrapped Ether │ Skywalker Protocol │ 888.2K │ 104 │ 54 │ +├─────────────────────┼────────────────┼──────────────────────────────────────┼────────────────────┼───────────┼─────────┼─────────────┤ +│ 2022-02-13 17:56:36 │ McDonalds/WETH │ McDonalds Metaverse │ Wrapped Ether │ 2.6M │ 208 │ 1.9M │ +└─────────────────────┴────────────────┴──────────────────────────────────────┴────────────────────┴───────────┴─────────┴─────────────┘ +``` +--- diff --git a/website/versioned_docs/version-v3/terminal/reference/crypto/defi/pools.md b/website/content/terminal/reference/crypto/defi/pools.md similarity index 91% rename from website/versioned_docs/version-v3/terminal/reference/crypto/defi/pools.md rename to website/content/terminal/reference/crypto/defi/pools.md index 0cc9896c7c8b..95b60e80d54d 100644 --- a/website/versioned_docs/version-v3/terminal/reference/crypto/defi/pools.md +++ b/website/content/terminal/reference/crypto/defi/pools.md @@ -1,9 +1,25 @@ --- title: pools -description: OpenBB Terminal Function +description: This page is a Python script documentation to display and sort Uniswap + Pools by volume, token name symbol, and transaction count using dataset from thegraph.com. + It provides clear instructions and examples on usage and parameters. +keywords: +- Uniswap Pools +- Volume +- Token Name +- Token Symbol +- Volume USD +- Transaction Count +- Sorting +- Python Script +- Cryptocurrency +- TheGraph Source +- Data Display --- -# pools +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + Display uniswap pools by volume. [Source: https://thegraph.com/en/] diff --git a/website/content/terminal/reference/crypto/defi/sinfo.md b/website/content/terminal/reference/crypto/defi/sinfo.md new file mode 100644 index 000000000000..708d5ff60bd7 --- /dev/null +++ b/website/content/terminal/reference/crypto/defi/sinfo.md @@ -0,0 +1,34 @@ +--- +title: sinfo +description: Learn how to use sinfo tool to display staking info of a Terra address. + Provides usage information and parameter details. +keywords: +- sinfo tool +- Terra address +- staking info +- parameters +- usage +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Displays staking info of a certain terra address. [Source: https://fcd.terra.dev/swagger] + +### Usage + +```python +sinfo -a ADDRESS [-l LIMIT] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| address | Terra address. Valid terra addresses start with 'terra' | None | False | None | +| limit | Number of delegations | 10 | True | None | + +--- diff --git a/website/content/terminal/reference/crypto/defi/sratio.md b/website/content/terminal/reference/crypto/defi/sratio.md new file mode 100644 index 000000000000..e189290d4101 --- /dev/null +++ b/website/content/terminal/reference/crypto/defi/sratio.md @@ -0,0 +1,36 @@ +--- +title: sratio +description: This page provides a guide on how to use sratio tool for displaying terra + blockchain staking ratio history. It includes parameters, usage and source link. +keywords: +- sratio +- terra blockchain +- staking ratio history +- fcd.terra.dev +- parameters +- limit +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Displays terra blockchain staking ratio history. [Source: https://fcd.terra.dev/swagger] + +### Usage + +```python +sratio [-l LIMIT] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| limit | Number of days to show | 90 | True | None | + +![sratio](https://user-images.githubusercontent.com/46355364/154053989-81ffd06a-db35-402b-ac27-4a5ae17158bf.png) + +--- diff --git a/website/content/terminal/reference/crypto/defi/sreturn.md b/website/content/terminal/reference/crypto/defi/sreturn.md new file mode 100644 index 000000000000..f42910a7e033 --- /dev/null +++ b/website/content/terminal/reference/crypto/defi/sreturn.md @@ -0,0 +1,37 @@ +--- +title: sreturn +description: The sreturn page provides information about the terra blockchain staking + returns history. It contains usage details, parameters, and illustrative diagrams. +keywords: +- sreturn +- terra blockchain +- staking returns history +- usage details +- parameters +- diagrams +- blockchain technology +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Displays terra blockchain staking returns history. [Source: https://fcd.terra.dev/swagger] + +### Usage + +```python +sreturn [-l LIMIT] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| limit | Number of days to show | 90 | True | None | + +![sreturn](https://user-images.githubusercontent.com/46355364/154054156-d57ad946-88dd-4766-a4f9-ec5a9bfebab7.png) + +--- diff --git a/website/content/terminal/reference/crypto/defi/stats.md b/website/content/terminal/reference/crypto/defi/stats.md new file mode 100644 index 000000000000..7f2f564f240f --- /dev/null +++ b/website/content/terminal/reference/crypto/defi/stats.md @@ -0,0 +1,63 @@ +--- +title: stats +description: Documentation for 'stats' query, providing base statistics about Uniswap, + a decentralized exchange (DEX). The page includes usage instructions and examples + of results including metrics like totalVolumeUSD, totalLiquidityUSD, pairCount, + txCount, and totalLiquidityETH. +keywords: +- Uniswap DEX +- DEX statistics +- crypto defi stats +- volumeUSD +- liquidityUSD +- pairCount +- txCount +- liquidityETH +- base statistics +- theGraph.com +- usage query +- Uniswap metrics +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Display base statistics about Uniswap DEX. [Source: https://thegraph.com/en/] + +### Usage + +```python +stats +``` + +--- + +## Parameters + +This command has no parameters + + + +--- + +## Examples + +```python +2022 Feb 15, 06:33 (🦋) /crypto/defi/ $ stats + Uniswap DEX Base Statistics +┌───────────────────┬────────┐ +│ Metric │ Value │ +├───────────────────┼────────┤ +│ totalVolumeUSD │ 393.2B │ +├───────────────────┼────────┤ +│ totalLiquidityUSD │ 3.3B │ +├───────────────────┼────────┤ +│ pairCount │ 63.3K │ +├───────────────────┼────────┤ +│ txCount │ 73.6M │ +├───────────────────┼────────┤ +│ totalLiquidityETH │ 1.1M │ +└───────────────────┴────────┘ +``` +--- diff --git a/website/content/terminal/reference/crypto/defi/stvl.md b/website/content/terminal/reference/crypto/defi/stvl.md new file mode 100644 index 000000000000..f3ecb0eeae8e --- /dev/null +++ b/website/content/terminal/reference/crypto/defi/stvl.md @@ -0,0 +1,38 @@ +--- +title: stvl +description: The page provides detailed information about the stvl function. This + includes its usage, parameters like 'limit' and how to display TVLs for listed dApps + using llama.fi API. +keywords: +- stvl +- TVLs +- dApps +- llama.fi +- API +- parameters +- limit +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Displays historical values of the total sum of TVLs from all listed dApps. [Source: https://docs.llama.fi/api] + +### Usage + +```python +stvl [-l LIMIT] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| limit | Number of records to display | 10 | True | None | + +![stvl](https://user-images.githubusercontent.com/46355364/154054369-2c9dd45c-26b6-4255-81f6-7e839169c786.png) + +--- diff --git a/website/versioned_docs/version-v3/terminal/reference/crypto/defi/swaps.md b/website/content/terminal/reference/crypto/defi/swaps.md similarity index 88% rename from website/versioned_docs/version-v3/terminal/reference/crypto/defi/swaps.md rename to website/content/terminal/reference/crypto/defi/swaps.md index 9d2b99722272..20a43552fc08 100644 --- a/website/versioned_docs/version-v3/terminal/reference/crypto/defi/swaps.md +++ b/website/content/terminal/reference/crypto/defi/swaps.md @@ -1,9 +1,25 @@ --- title: swaps -description: OpenBB Terminal Function +description: This webpage displays the latest swaps done on Uniswap DEX. It allows + users to sort crypto transactions in different ways as per their needs. It's useful + for observing and analyzing recent cryptocurrency transactions. +keywords: +- Uniswap DEX +- crypto swaps +- cryptocurrency transactions +- defi data +- last crypto swaps +- uniswap transactions +- sort uniswap dex +- track uniswap swaps +- token exchange +- decoding uniswap +- uniswap analysis --- -# swaps +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + Display last swaps done on Uniswap DEX. [Source: https://thegraph.com/en/] diff --git a/website/versioned_docs/version-v3/terminal/reference/crypto/defi/tokens.md b/website/content/terminal/reference/crypto/defi/tokens.md similarity index 95% rename from website/versioned_docs/version-v3/terminal/reference/crypto/defi/tokens.md rename to website/content/terminal/reference/crypto/defi/tokens.md index efc491c1185a..9727026acf65 100644 --- a/website/versioned_docs/version-v3/terminal/reference/crypto/defi/tokens.md +++ b/website/content/terminal/reference/crypto/defi/tokens.md @@ -1,9 +1,24 @@ --- title: tokens -description: OpenBB Terminal Function +description: Detailed guidance on displaying trade-able tokens on Uniswap DEX including + parameters, usage, and examples. Useful for those interested in DeFi and cryptocurrency + trading. +keywords: +- Uniswap DEX +- tokens +- cryptocurrency +- trading +- blockchain +- DeFi +- crypto trading +- tradeVolumeUSD +- totalLiquidity +- txCount --- -# tokens +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + Display tokens trade-able on Uniswap DEX [Source: https://thegraph.com/en/] diff --git a/website/content/terminal/reference/crypto/defi/validators.md b/website/content/terminal/reference/crypto/defi/validators.md new file mode 100644 index 000000000000..17f9a11fa939 --- /dev/null +++ b/website/content/terminal/reference/crypto/defi/validators.md @@ -0,0 +1,73 @@ +--- +title: validators +description: The 'validators' documentation page provides detailed insights into Terra + validators, including how to sort and display data related to each validator. The + information includes Validator Name, Tokens Amount, Voting Power, Commission Rate, + Status, and Uptime. +keywords: +- validators +- Terra validators +- crypto +- tokens amount +- voting power +- commission rate +- validator status +- uptime +- Terra +- Defi +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Displays information about terra validators. [Source: https://fcd.terra.dev/swagger] + +### Usage + +```python +validators [-l LIMIT] [-s {validatorName,tokensAmount,votingPower,commissionRate,status,uptime}] [-r] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| limit | Number of validators to show | 10 | True | None | +| sortby | Sort by given column. Default: votingPower | votingPower | True | validatorName, tokensAmount, votingPower, commissionRate, status, uptime | +| reverse | Data is sorted in descending order by default. Reverse flag will sort it in an ascending way. Only works when raw data is displayed. | False | True | None | + + +--- + +## Examples + +```python +2022 Feb 15, 06:36 (🦋) /crypto/defi/ $ validators +┌──────────────────────────────────────────────┬─────────────────────┬───────────────┬────────────────┬───────────────────┬────────┬──────────┐ +│ Account address │ Validator name │ Tokens amount │ Voting power % │ Commission rate % │ Status │ Uptime % │ +├──────────────────────────────────────────────┼─────────────────────┼───────────────┼────────────────┼───────────────────┼────────┼──────────┤ +│ terra1259cmu5zyklsdkmgstxhwqpe0utfe5hhyygjdc │ Orion.Money │ 21.9M │ 7.20 │ 5.00 │ active │ 100.00 │ +├──────────────────────────────────────────────┼─────────────────────┼───────────────┼────────────────┼───────────────────┼────────┼──────────┤ +│ terra15zcjduavxc5mkp8qcqs9eyhwlqwdlrzy6anwpg │ B-Harvest │ 17.9M │ 5.88 │ 5.00 │ active │ 100.00 │ +├──────────────────────────────────────────────┼─────────────────────┼───────────────┼────────────────┼───────────────────┼────────┼──────────┤ +│ terra123gn6j23lmexu0qx5qhmgxgunmjcqsx8g5ueq2 │ Staking Fund │ 15.7M │ 5.17 │ 10.00 │ active │ 100.00 │ +├──────────────────────────────────────────────┼─────────────────────┼───────────────┼────────────────┼───────────────────┼────────┼──────────┤ +│ terra1v5hrqlv8dqgzvy0pwzqzg0gxy899rm4kdn0jp4 │ DokiaCapital │ 10.3M │ 3.38 │ 5.00 │ active │ 100.00 │ +├──────────────────────────────────────────────┼─────────────────────┼───────────────┼────────────────┼───────────────────┼────────┼──────────┤ +│ terra1kprce6kc08a6l03gzzh99hfpazfjeczfpd6td0 │ Certus One │ 9M │ 2.96 │ 10.00 │ active │ 100.00 │ +├──────────────────────────────────────────────┼─────────────────────┼───────────────┼────────────────┼───────────────────┼────────┼──────────┤ +│ terra1p54hc4yy2ajg67j645dn73w3378j6k05v52cnk │ hashed │ 7.7M │ 2.53 │ 10.00 │ active │ 100.00 │ +├──────────────────────────────────────────────┼─────────────────────┼───────────────┼────────────────┼───────────────────┼────────┼──────────┤ +│ terra1va2ew92dtkhffduswr83elf3nfvl4xg48rguwl │ NOD Games │ 7.4M │ 2.44 │ 0.00 │ active │ 99.99 │ +├──────────────────────────────────────────────┼─────────────────────┼───────────────┼────────────────┼───────────────────┼────────┼──────────┤ +│ terra175hhkyxmkp8hf2zrzka7cnn7lk6mudtv4nsp2x │ DSRV - CHAISCAN.com │ 6.7M │ 2.22 │ 10.00 │ active │ 100.00 │ +├──────────────────────────────────────────────┼─────────────────────┼───────────────┼────────────────┼───────────────────┼────────┼──────────┤ +│ terra162892yn0tf8dxl8ghgneqykyr8ufrwmcs6vft5 │ Luna Maximalists │ 6.5M │ 2.14 │ 20.00 │ active │ 99.98 │ +├──────────────────────────────────────────────┼─────────────────────┼───────────────┼────────────────┼───────────────────┼────────┼──────────┤ +│ terra1h6rf7y2ar5vz64q8rchz5443s3tqnswrpxe69f │ Staked │ 6.3M │ 2.08 │ 10.00 │ active │ 100.00 │ +└──────────────────────────────────────────────┴─────────────────────┴───────────────┴────────────────┴───────────────────┴────────┴──────────┘ +``` +--- diff --git a/website/content/terminal/reference/crypto/defi/vaults.md b/website/content/terminal/reference/crypto/defi/vaults.md new file mode 100644 index 000000000000..2f563b238f03 --- /dev/null +++ b/website/content/terminal/reference/crypto/defi/vaults.md @@ -0,0 +1,81 @@ +--- +title: vaults +description: This page provides a detailed description on how to use and interact + with DeFi Vaults using various blockchains and DeFi protocols. It provides useful + commands, parameters, and examples. +keywords: +- defi +- blockchain +- protocol +- vaults +- cryptocurrency +- ethereum +- terra +- beefy +- apy +- tvl +- parameters +- examples +- osmosis +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Display Top DeFi Vaults. [Source: https://coindix.com/] + +### Usage + +```python +vaults [-c {ethereum,polygon,avalanche,bsc,terra,fantom,moonriver,celo,heco,okex,cronos,arbitrum,eth,harmony,fuse,defichain,solana,optimism,kusama,metis,osmosis}] [-p {aave,acryptos,alpaca,anchor,autofarm,balancer,bancor,beefy,belt,compound,convex,cream,curve,defichain,geist,lido,liquity,mirror,pancakeswap,raydium,sushi,tarot,traderjoe,tulip,ubeswap,uniswap,venus,yearn,osmosis,tulip}] [-k {lp,single,noimploss,stable}] [-t TOP] [-s {name,chain,protocol,apy,tvl,link}] [-r] [-l] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| chain | Blockchain name e.g. ethereum, terra | None | True | ethereum, polygon, avalanche, bsc, terra, fantom, moonriver, celo, heco, okex, cronos, arbitrum, eth, harmony, fuse, defichain, solana, optimism, kusama, metis, osmosis | +| protocol | DeFi protocol name e.g. aave, uniswap | None | True | aave, acryptos, alpaca, anchor, autofarm, balancer, bancor, beefy, belt, compound, convex, cream, curve, defichain, geist, lido, liquity, mirror, pancakeswap, raydium, sushi, tarot, traderjoe, tulip, ubeswap, uniswap, venus, yearn, osmosis, tulip | +| kind | Kind/type of vault e.g. lp, single, noimploss, stable | None | True | lp, single, noimploss, stable | +| limit | Number of records to display | 10 | True | range(1, 1000) | +| sortby | Sort by given column. Default: timestamp | apy | True | name, chain, protocol, apy, tvl, link | +| reverse | Data is sorted in descending order by default. Reverse flag will sort it in an ascending way. Only works when raw data is displayed. | False | True | None | +| link | Flag to show vault link | True | True | None | + + +--- + +## Examples + +```python +2022 May 26, 07:19 (�) /crypto/defi/ $ vaults + + Top DeFi Vaults +┌──────────────────────┬───────────┬──────────┬───────────┬──────────┐ +│ Name │ Chain │ Protocol │ APY (%) │ TVL ($) │ +├──────────────────────┼───────────┼──────────┼───────────┼──────────┤ +│ ESHARE-BNB │ BNB Chain │ Beefy │ 3034.87 % │ 1.587 M │ +├──────────────────────┼───────────┼──────────┼───────────┼──────────┤ +│ BSHARE-FTM │ Fantom │ Beefy │ 1545.3 % │ 1.637 M │ +├──────────────────────┼───────────┼──────────┼───────────┼──────────┤ +│ ust-wormholeUST-3Crv │ Ethereum │ Convex │ 1471.74 % │ 2.600 M │ +├──────────────────────┼───────────┼──────────┼───────────┼──────────┤ +│ GRAPE-MIM │ Avalanche │ Beefy │ 1404.84 % │ 1.110 M │ +├──────────────────────┼───────────┼──────────┼───────────┼──────────┤ +│ BASED-TOMB │ Fantom │ Beefy │ 527.77 % │ 1.139 M │ +├──────────────────────┼───────────┼──────────┼───────────┼──────────┤ +│ EMP-ETH │ BNB Chain │ Beefy │ 362.55 % │ 1.257 M │ +├──────────────────────┼───────────┼──────────┼───────────┼──────────┤ +│ BADGER-WBTC │ Ethereum │ Balancer │ 340.54 % │ 15.150 M │ +├──────────────────────┼───────────┼──────────┼───────────┼──────────┤ +│ BSW-BNB │ BNB Chain │ Alpaca │ 280.7 % │ 1.863 M │ +├──────────────────────┼───────────┼──────────┼───────────┼──────────┤ +│ WBTC-OSMO │ Osmosis │ Osmosis │ 231.2 % │ 4.730 M │ +├──────────────────────┼───────────┼──────────┼───────────┼──────────┤ +│ ROWAN-OSMO │ Osmosis │ Osmosis │ 228.72 % │ 1.834 M │ +└──────────────────────┴───────────┴──────────┴───────────┴──────────┘ +``` +--- diff --git a/website/versioned_docs/version-v3/terminal/reference/crypto/disc/_category_.json b/website/content/terminal/reference/crypto/disc/_category_.json similarity index 100% rename from website/versioned_docs/version-v3/terminal/reference/crypto/disc/_category_.json rename to website/content/terminal/reference/crypto/disc/_category_.json diff --git a/website/versioned_docs/version-v3/terminal/reference/crypto/disc/dapps.md b/website/content/terminal/reference/crypto/disc/dapps.md similarity index 90% rename from website/versioned_docs/version-v3/terminal/reference/crypto/disc/dapps.md rename to website/content/terminal/reference/crypto/disc/dapps.md index 1f8bd9813064..f70a2af5ea67 100644 --- a/website/versioned_docs/version-v3/terminal/reference/crypto/disc/dapps.md +++ b/website/content/terminal/reference/crypto/disc/dapps.md @@ -1,9 +1,28 @@ --- title: dapps -description: OpenBB Terminal Function +description: A comprehensive guide to understanding and using 'dapps' command for + listing and sorting the top Decentralized Applications (DApps) from various categories + and protocols as per users' choice. +keywords: +- DApp +- Decentralized Applications +- Crypto +- Blockchain +- PancakeSwap +- Splinterlands +- Alien Worlds +- Farmers World +- AtomicAssets +- Axie Infinity +- Upland +- OpenSea +- Katana +- Magic Eden --- -# dapps +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + Shows top decentralized applications [Source: https://dappradar.com/] Accepts --sort {Name,Category,Protocols,Daily Users,Daily Volume [$]} to sort by column diff --git a/website/versioned_docs/version-v3/terminal/reference/crypto/disc/dex.md b/website/content/terminal/reference/crypto/disc/dex.md similarity index 87% rename from website/versioned_docs/version-v3/terminal/reference/crypto/disc/dex.md rename to website/content/terminal/reference/crypto/disc/dex.md index 9a20639a7b21..d642823ab69c 100644 --- a/website/versioned_docs/version-v3/terminal/reference/crypto/disc/dex.md +++ b/website/content/terminal/reference/crypto/disc/dex.md @@ -1,9 +1,21 @@ --- title: dex -description: OpenBB Terminal Function +description: The dex page displays information about top decentralized exchanges. + It provides usage, parameters, and examples of how to fetch and sort the data. +keywords: +- Decentralized Exchanges +- Dex command +- Crypto Data Sorting +- Crypto Trading Volume +- Dex Parameters +- Dex Examples +- DappRadar +- Cryptocurrency --- -# dex +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + Shows top decentralized exchanges [Source: https://dappradar.com/] Accepts --sort {Name,Daily Users,Daily Volume [$]} to sort by column diff --git a/website/content/terminal/reference/crypto/disc/gainers.md b/website/content/terminal/reference/crypto/disc/gainers.md new file mode 100644 index 000000000000..a9c41990b740 --- /dev/null +++ b/website/content/terminal/reference/crypto/disc/gainers.md @@ -0,0 +1,80 @@ +--- +title: gainers +description: This page provides details on the 'gainers' functionality, including + descriptions, parameters, usage, and examples. The gainers functionality displays + the coins that have gained the most in a selected time period. +keywords: +- gainers +- crypto +- coins +- market cap +- volume +- time intervals +- parameters +- defaults +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Shows Largest Gainers - coins which gain the most in given period. You can use parameter --interval to set which timeframe are you interested in: {14d,1h,1y,200d,24h,30d,7d} You can look on only N number of records with --limit, You can sort by {Symbol,Name,Price [$],Market Cap,Market Cap Rank,Volume [$]} with --sort. + +### Usage + +```python +gainers [-i {14d,1h,1y,200d,24h,30d,7d}] [-l LIMIT] [-s SORTBY [SORTBY ...]] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| interval | time period, one from {14d,1h,1y,200d,24h,30d,7d} | 1h | True | 14d, 1h, 1y, 200d, 24h, 30d, 7d | +| limit | Number of records to display | 15 | True | None | +| sortby | Sort by given column. Default: Market Cap Rank | market_cap | True | Symbol, Name, Price [$], Market Cap, Market Cap Rank, Volume [$] | + + +--- + +## Examples + +```python +2022 Feb 15, 06:38 (🦋) /crypto/disc/ $ gainers +┌────────┬─────────────────┬───────────┬────────────────┬─────────────────┬────────────┬───────────────┐ +│ Symbol │ Name │ Price [$] │ Market Cap [$] │ Market Cap Rank │ Volume [$] │ Change 1h [%] │ +├────────┼─────────────────┼───────────┼────────────────┼─────────────────┼────────────┼───────────────┤ +│ xrp │ XRP │ 0.84 │ 39.9B │ 6 │ 3.2B │ 0.29 │ +├────────┼─────────────────┼───────────┼────────────────┼─────────────────┼────────────┼───────────────┤ +│ luna │ Terra │ 56.50 │ 22.4B │ 9 │ 1B │ 0.14 │ +├────────┼─────────────────┼───────────┼────────────────┼─────────────────┼────────────┼───────────────┤ +│ usdc │ USD Coin │ 1.00 │ 52.6B │ 5 │ 3B │ 0.12 │ +├────────┼─────────────────┼───────────┼────────────────┼─────────────────┼────────────┼───────────────┤ +│ bnb │ Binance Coin │ 429.85 │ 72.2B │ 4 │ 709.6M │ 0.12 │ +├────────┼─────────────────┼───────────┼────────────────┼─────────────────┼────────────┼───────────────┤ +│ btc │ Bitcoin │ 44275.00 │ 838.8B │ 1 │ 20.6B │ 0.11 │ +├────────┼─────────────────┼───────────┼────────────────┼─────────────────┼────────────┼───────────────┤ +│ usdt │ Tether │ 1.00 │ 78.5B │ 3 │ 43.3B │ 0.08 │ +├────────┼─────────────────┼───────────┼────────────────┼─────────────────┼────────────┼───────────────┤ +│ busd │ Binance USD │ 1.00 │ 17.6B │ 13 │ 3B │ -0.04 │ +├────────┼─────────────────┼───────────┼────────────────┼─────────────────┼────────────┼───────────────┤ +│ dot │ Polkadot │ 19.79 │ 21.4B │ 11 │ 672.9M │ -0.12 │ +├────────┼─────────────────┼───────────┼────────────────┼─────────────────┼────────────┼───────────────┤ +│ eth │ Ethereum │ 3100.92 │ 370.6B │ 2 │ 14.4B │ -0.24 │ +├────────┼─────────────────┼───────────┼────────────────┼─────────────────┼────────────┼───────────────┤ +│ shib │ Shiba Inu │ 0.00 │ 17.2B │ 14 │ 1.1B │ -0.34 │ +├────────┼─────────────────┼───────────┼────────────────┼─────────────────┼────────────┼───────────────┤ +│ ada │ Cardano │ 1.09 │ 34.9B │ 7 │ 1B │ -0.41 │ +├────────┼─────────────────┼───────────┼────────────────┼─────────────────┼────────────┼───────────────┤ +│ doge │ Dogecoin │ 0.15 │ 19.9B │ 12 │ 604.3M │ -0.50 │ +├────────┼─────────────────┼───────────┼────────────────┼─────────────────┼────────────┼───────────────┤ +│ AVAX │ Avalanche │ 88.42 │ 21.7B │ 10 │ 894.8M │ -0.65 │ +├────────┼─────────────────┼───────────┼────────────────┼─────────────────┼────────────┼───────────────┤ +│ sol │ Solana │ 102.75 │ 32.7B │ 8 │ 1.8B │ -0.76 │ +├────────┼─────────────────┼───────────┼────────────────┼─────────────────┼────────────┼───────────────┤ +│ cro │ Crypto.com Coin │ 0.50 │ 12.5B │ 15 │ 200.8M │ -1.21 │ +└────────┴─────────────────┴───────────┴────────────────┴─────────────────┴────────────┴───────────────┘ +``` +--- diff --git a/website/versioned_docs/version-v3/terminal/reference/crypto/disc/games.md b/website/content/terminal/reference/crypto/disc/games.md similarity index 85% rename from website/versioned_docs/version-v3/terminal/reference/crypto/disc/games.md rename to website/content/terminal/reference/crypto/disc/games.md index 3300638d1616..6ba3cfff9d03 100644 --- a/website/versioned_docs/version-v3/terminal/reference/crypto/disc/games.md +++ b/website/content/terminal/reference/crypto/disc/games.md @@ -1,9 +1,26 @@ --- title: games -description: OpenBB Terminal Function +description: This page provides a list of top blockchain games with sorting options + by Name, Daily Users, and Daily Volume. Use this command to discover the most popular + and lucrative blockchain games. +keywords: +- blockchain +- blockchain games +- crypto games +- daily volume +- daily users +- sorting +- top games +- Splinterlands +- PancakeSwap +- Alien Worlds +- Axie Infinity +- OpenSea --- -# games +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + Shows top blockchain games [Source: https://dappradar.com/] Accepts --sort {Name,Daily Users,Daily Volume [$]} to sort by column diff --git a/website/content/terminal/reference/crypto/disc/losers.md b/website/content/terminal/reference/crypto/disc/losers.md new file mode 100644 index 000000000000..914b850b1229 --- /dev/null +++ b/website/content/terminal/reference/crypto/disc/losers.md @@ -0,0 +1,85 @@ +--- +title: losers +description: The 'losers' documentation page provides a Python based solution for + identifying cryptocurrencies with the largest drop in value over a given time period. + Control the analysis with options for the time interval, record limits, and sorting. + This tool is essential for in-depth market analysis and monitoring market trends. +keywords: +- Market Analysis +- Cryptocurrency +- Crypto Losers +- Market Trends +- Price Drop +- Time Interval +- Record Limit +- Sort Options +- Python Script +- Crypto Coin Symbol +- Market Cap Rank +- Volume +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Shows Largest Losers - coins which price dropped the most in given period You can use parameter --interval to set which timeframe are you interested in: {14d,1h,1y,200d,24h,30d,7d} You can look on only N number of records with --limit, You can sort by {Symbol,Name,Price [$],Market Cap,Market Cap Rank,Volume [$]} with --sort. + +### Usage + +```python +losers [-i {14d,1h,1y,200d,24h,30d,7d}] [-l LIMIT] [-s SORTBY [SORTBY ...]] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| interval | time period, one from {14d,1h,1y,200d,24h,30d,7d} | 1h | True | 14d, 1h, 1y, 200d, 24h, 30d, 7d | +| limit | Number of records to display | 15 | True | None | +| sortby | Sort by given column. Default: Market Cap Rank | Market Cap | True | Symbol, Name, Price [$], Market Cap, Market Cap Rank, Volume [$] | + + +--- + +## Examples + +```python +2022 Feb 15, 06:43 (🦋) /crypto/disc/ $ losers +┌────────┬─────────────────┬───────────┬────────────────┬─────────────────┬────────────┬───────────────┐ +│ Symbol │ Name │ Price [$] │ Market Cap [$] │ Market Cap Rank │ Volume [$] │ Change 1h [%] │ +├────────┼─────────────────┼───────────┼────────────────┼─────────────────┼────────────┼───────────────┤ +│ cro │ Crypto.com Coin │ 0.50 │ 12.5B │ 15 │ 200.8M │ -1.21 │ +├────────┼─────────────────┼───────────┼────────────────┼─────────────────┼────────────┼───────────────┤ +│ sol │ Solana │ 102.75 │ 32.7B │ 8 │ 1.8B │ -0.76 │ +├────────┼─────────────────┼───────────┼────────────────┼─────────────────┼────────────┼───────────────┤ +│ doge │ Dogecoin │ 0.15 │ 19.9B │ 12 │ 604.3M │ -0.50 │ +├────────┼─────────────────┼───────────┼────────────────┼─────────────────┼────────────┼───────────────┤ +│ AVAX │ Avalanche │ 88.66 │ 21.7B │ 10 │ 899.9M │ -0.38 │ +├────────┼─────────────────┼───────────┼────────────────┼─────────────────┼────────────┼───────────────┤ +│ ada │ Cardano │ 1.09 │ 34.9B │ 7 │ 1B │ -0.31 │ +├────────┼─────────────────┼───────────┼────────────────┼─────────────────┼────────────┼───────────────┤ +│ shib │ Shiba Inu │ 0.00 │ 17.2B │ 14 │ 1.1B │ -0.26 │ +├────────┼─────────────────┼───────────┼────────────────┼─────────────────┼────────────┼───────────────┤ +│ eth │ Ethereum │ 3100.92 │ 370.6B │ 2 │ 14.4B │ -0.24 │ +├────────┼─────────────────┼───────────┼────────────────┼─────────────────┼────────────┼───────────────┤ +│ dot │ Polkadot │ 19.79 │ 21.4B │ 11 │ 672.9M │ -0.12 │ +├────────┼─────────────────┼───────────┼────────────────┼─────────────────┼────────────┼───────────────┤ +│ busd │ Binance USD │ 1.00 │ 17.6B │ 13 │ 3B │ -0.06 │ +├────────┼─────────────────┼───────────┼────────────────┼─────────────────┼────────────┼───────────────┤ +│ bnb │ Binance Coin │ 429.57 │ 72.2B │ 4 │ 1.8B │ 0.05 │ +├────────┼─────────────────┼───────────┼────────────────┼─────────────────┼────────────┼───────────────┤ +│ usdt │ Tether │ 1.00 │ 78.5B │ 3 │ 43.3B │ 0.08 │ +├────────┼─────────────────┼───────────┼────────────────┼─────────────────┼────────────┼───────────────┤ +│ luna │ Terra │ 56.47 │ 22.4B │ 9 │ 1B │ 0.08 │ +├────────┼─────────────────┼───────────┼────────────────┼─────────────────┼────────────┼───────────────┤ +│ btc │ Bitcoin │ 44275.00 │ 838.8B │ 1 │ 20.6B │ 0.11 │ +├────────┼─────────────────┼───────────┼────────────────┼─────────────────┼────────────┼───────────────┤ +│ usdc │ USD Coin │ 1.00 │ 52.6B │ 5 │ 3B │ 0.12 │ +├────────┼─────────────────┼───────────┼────────────────┼─────────────────┼────────────┼───────────────┤ +│ xrp │ XRP │ 0.84 │ 39.9B │ 6 │ 3.2B │ 0.29 │ +└────────┴─────────────────┴───────────┴────────────────┴─────────────────┴────────────┴───────────────┘ +``` +--- diff --git a/website/content/terminal/reference/crypto/disc/nft.md b/website/content/terminal/reference/crypto/disc/nft.md new file mode 100644 index 000000000000..cdc019196a49 --- /dev/null +++ b/website/content/terminal/reference/crypto/disc/nft.md @@ -0,0 +1,37 @@ +--- +title: nft +description: Page covers usage and parameters of an NFT command for Dappradar. Allows + sorting NFTs by name, protocols, floor price, average price, market cap, and volume. +keywords: +- NFT +- Dappradar +- Sort +- Market Cap +- Volume +- Floor Price +- Avg Price +- Protocols +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Shows top NFT collections [Source: https://dappradar.com/] Accepts --sort {Name,Protocols,Floor Price [$],Avg Price [$],Market Cap,Volume [$]} to sort by column + +### Usage + +```python +nft [-l LIMIT] [-s SORTBY [SORTBY ...]] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| limit | Number of records to display | 15 | True | None | +| sortby | Sort by given column. Default: Market Cap | Market Cap | True | Name, Protocols, Floor Price [$], Avg Price [$], Market Cap [$], Volume [$] | + +--- diff --git a/website/content/terminal/reference/crypto/disc/search.md b/website/content/terminal/reference/crypto/disc/search.md new file mode 100644 index 000000000000..1906f9c90b06 --- /dev/null +++ b/website/content/terminal/reference/crypto/disc/search.md @@ -0,0 +1,73 @@ +--- +title: search +description: This docusaurus page provides detail on how to use the Search function + within the CoinPaprika API, including specific parameters such as limit, sort, and + category. +keywords: +- CoinPaprika +- API +- Search function +- Data sorting +- Data categories +- metadata +- docusaurus +- bitcoin +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Search over CoinPaprika API You can display only N number of results with --limit parameter. You can sort data by id, name , category --sort parameter and also with --reverse flag to sort descending. To choose category in which you are searching for use --cat/-c parameter. Available categories: currencies|exchanges|icos|people|tags|all Displays: id, name, category + +### Usage + +```python +search -q QUERY [QUERY ...] [-c {currencies,exchanges,icos,people,tags,all}] [-l LIMIT] [-s {category,id,name}] [-r] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| query | phrase for search | None | False | None | +| category | Categories to search: currencies|exchanges|icos|people|tags|all. Default: all | all | True | currencies, exchanges, icos, people, tags, all | +| limit | Limit of records | 10 | True | None | +| sortby | Sort by given column. Default: id | id | True | category, id, name | +| reverse | Data is sorted in descending order by default. Reverse flag will sort it in an ascending way. Only works when raw data is displayed. | False | True | None | + + +--- + +## Examples + +```python +2022 Feb 15, 06:51 (🦋) /crypto/disc/ $ search -q bitcoin + CoinPaprika Results +┌─────────────────────────┬──────────────────────┬────────────┐ +│ id │ name │ category │ +├─────────────────────────┼──────────────────────┼────────────┤ +│ bbtc-baby-bitcoin │ Baby Bitcoin │ currencies │ +├─────────────────────────┼──────────────────────┼────────────┤ +│ bc-bitcoin-confidential │ Bitcoin Confidential │ currencies │ +├─────────────────────────┼──────────────────────┼────────────┤ +│ bca-bitcoin-atom │ Bitcoin Atom │ currencies │ +├─────────────────────────┼──────────────────────┼────────────┤ +│ bcd-bitcoin-diamond │ Bitcoin Diamond │ currencies │ +├─────────────────────────┼──────────────────────┼────────────┤ +│ bcf-bitcoin-fast │ Bitcoin Fast │ currencies │ +├─────────────────────────┼──────────────────────┼────────────┤ +│ bch-bitcoin-cash │ Bitcoin Cash │ currencies │ +├─────────────────────────┼──────────────────────┼────────────┤ +│ bch-bitcoin-cash-token │ Bitcoin Cash Token │ currencies │ +├─────────────────────────┼──────────────────────┼────────────┤ +│ bci-bitcoin-interest │ Bitcoin Interest │ currencies │ +├─────────────────────────┼──────────────────────┼────────────┤ +│ bcr-bitcoinrock │ BITCOINROCK │ currencies │ +├─────────────────────────┼──────────────────────┼────────────┤ +│ bct-bitcointrust │ BitcoinTrust │ currencies │ +└─────────────────────────┴──────────────────────┴────────────┘ +``` +--- diff --git a/website/content/terminal/reference/crypto/disc/top.md b/website/content/terminal/reference/crypto/disc/top.md new file mode 100644 index 000000000000..b9519f542c8c --- /dev/null +++ b/website/content/terminal/reference/crypto/disc/top.md @@ -0,0 +1,71 @@ +--- +title: top +description: The page provides detailed usage patterns and instructions for the 'top' + function that displays N coins from data sources like CoinGecko, allowing users + to sort and filter the displayed data. The page includes details about various parameters, + their description, usage, and examples. +keywords: +- crypto +- CoinGecko +- data filtering +- data sorting +- parameters +- usage +- examples +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Display N coins from the data source, if the data source is CoinGecko it can receive a category as argument (-c decentralized-finance-defi or -c stablecoins) and will show only the top coins in that category. can also receive sort arguments (these depend on the source), e.g., --sort Volume [$] You can sort by {Symbol,Name,Price [$],Market Cap,Market Cap Rank,Volume [$]} with CoinGecko Number of coins to show: -l 10 + +### Usage + +```python +top [-c CATEGORY] [-l LIMIT] [-s SORTBY [SORTBY ...]] [-r] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| category | Category (e.g., stablecoins). Empty for no category. Only works for 'CoinGecko' source. | | True | aave-tokens, analytics, arbitrum-ecosystem, artificial-intelligence, asset-backed-tokens, asset-manager, augmented-reality, automated-market-maker-amm, avalanche-ecosystem, axie-infinity, big-data, binance-launchpool, binance-smart-chain, business-platform, business-services, cardano-ecosystem, celo-ecosystem, centralized-exchange-token-cex, charity, cny-stablecoin, collectibles, communication, compound-tokens, cosmos-ecosystem, cryptocurrency, daomaker-ecosystem, decentralized-exchange, decentralized-finance-defi, defi-index, decentralized-derivatives, education, energy, entertainment, etf, eth-2-0-staking, eur-stablecoin, exchange-based-tokens, fan-token, fantom-ecosystem, finance-banking, fractionalized-nft, gambling, gaming, gbp-stablecoin, gig-economy, xdai-ecosystem, governance, guild-scholarship, harmony-ecosystem, healthcare, heco-chain-ecosystem, impossible-launchpad, index-coin, infrastructure, insurance, internet-of-things-iot, investment, iotex-ecosystem, kardiachain-ecosystem, krw-stablecoin, launchpad, layer-1, legal, lending-borrowing, leveraged-token, lp-tokens, manufacturing, marketing, masternodes, media, meme-token, metaverse, mev-protection, mirrored-assets, moonriver-ecosystem, music, near-protocol-ecosystem, nft-index, niftex-shards, non-fungible-tokens-nft, number, oec-ecosystem, ohm-fork, olympus-pro, decentralized-options, oracle, decentralized-perpetuals, play-to-earn, dot-ecosystem, polygon-ecosystem, prediction-markets, privacy-coins, protocol, real-estate, realt-tokens, rebase-tokens, reddit-points, remittance, retail, seigniorage, smart-contract-platform, social-money, software, solana-ecosystem, sports, stablecoins, storage, structured-products, synthetic-assets, synths, technology-science, terra-ecosystem, tokenized-btc, tokenized-gold, tokenized-products, tokenized-stock, tokensets, tourism, usd-stablecoin, us-election-2020, utokens, virtual-reality, wallets, wrapped-tokens, yearn-yfi-partnerships-mergers, yield-aggregator, yield-farming, zilliqa-ecosystem | +| limit | Limit of records | 10 | True | None | +| sortby | Sort by given column. Default: Market Cap Rank | Market Cap Rank | True | Symbol, Name, Volume [$], Market Cap, Market Cap Rank, 7D Change [%], 24H Change [%] | +| reverse | Data is sorted in descending order by default. Reverse flag will sort it in an ascending way. Only works when raw data is displayed. | False | True | None | + + +--- + +## Examples + +```python +2022 Feb 15, 06:44 (🦋) /crypto/disc/ $ top +┌────────┬──────────────┬────────────┬────────────────┬─────────────────┬───────────────┬────────────────┐ +│ Symbol │ Name │ Volume [$] │ Market Cap [$] │ Market Cap Rank │ 7D Change [%] │ 24H Change [%] │ +├────────┼──────────────┼────────────┼────────────────┼─────────────────┼───────────────┼────────────────┤ +│ btc │ Bitcoin │ 20.6B │ 838.8B │ 1 │ 0.93 │ 4.77 │ +├────────┼──────────────┼────────────┼────────────────┼─────────────────┼───────────────┼────────────────┤ +│ eth │ Ethereum │ 14.4B │ 370.6B │ 2 │ -1.53 │ 7.77 │ +├────────┼──────────────┼────────────┼────────────────┼─────────────────┼───────────────┼────────────────┤ +│ usdt │ Tether │ 43.3B │ 78.5B │ 3 │ -0.01 │ -0.05 │ +├────────┼──────────────┼────────────┼────────────────┼─────────────────┼───────────────┼────────────────┤ +│ bnb │ Binance Coin │ 1.8B │ 72.2B │ 4 │ -1.01 │ 8.18 │ +├────────┼──────────────┼────────────┼────────────────┼─────────────────┼───────────────┼────────────────┤ +│ usdc │ USD Coin │ 3B │ 52.6B │ 5 │ 0.25 │ 0.17 │ +├────────┼──────────────┼────────────┼────────────────┼─────────────────┼───────────────┼────────────────┤ +│ xrp │ XRP │ 3.2B │ 39.9B │ 6 │ 0.71 │ 5.51 │ +├────────┼──────────────┼────────────┼────────────────┼─────────────────┼───────────────┼────────────────┤ +│ ada │ Cardano │ 1B │ 34.9B │ 7 │ -9.04 │ 5.52 │ +├────────┼──────────────┼────────────┼────────────────┼─────────────────┼───────────────┼────────────────┤ +│ sol │ Solana │ 1.8B │ 32.7B │ 8 │ -12.54 │ 10.07 │ +├────────┼──────────────┼────────────┼────────────────┼─────────────────┼───────────────┼────────────────┤ +│ luna │ Terra │ 1B │ 22.4B │ 9 │ -5.26 │ 8.67 │ +├────────┼──────────────┼────────────┼────────────────┼─────────────────┼───────────────┼────────────────┤ +│ AVAX │ Avalanche │ 899.9M │ 21.7B │ 10 │ 6.28 │ 12.72 │ +└────────┴──────────────┴────────────┴────────────────┴─────────────────┴───────────────┴────────────────┘ +``` +--- diff --git a/website/content/terminal/reference/crypto/disc/trending.md b/website/content/terminal/reference/crypto/disc/trending.md new file mode 100644 index 000000000000..953f4b2676ea --- /dev/null +++ b/website/content/terminal/reference/crypto/disc/trending.md @@ -0,0 +1,58 @@ +--- +title: trending +description: Discover top trending coins on CoinGecko in the last 24 hours. Our expert + tool provides market rankings based on the latest data for efficient crypto tracking. +keywords: +- trending coins +- CoinGecko +- market ranking +- crypto tracking +- cryptocurrency +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Discover trending coins (Top-7) on CoinGecko in the last 24 hours + +### Usage + +```python +trending +``` + +--- + +## Parameters + +This command has no parameters + + + +--- + +## Examples + +```python +2022 Feb 15, 06:45 (🦋) /crypto/disc/ $ trending + Trending coins on CoinGecko +┌────────────────────┬────────────────────┬─────────────────┐ +│ Symbol │ Name │ Market Cap Rank │ +├────────────────────┼────────────────────┼─────────────────┤ +│ cellframe │ Cellframe │ 751 │ +├────────────────────┼────────────────────┼─────────────────┤ +│ dehub │ DeHub │ 858 │ +├────────────────────┼────────────────────┼─────────────────┤ +│ richquack │ Rich Quack │ 476 │ +├────────────────────┼────────────────────┼─────────────────┤ +│ smooth-love-potion │ Smooth Love Potion │ 101 │ +├────────────────────┼────────────────────┼─────────────────┤ +│ gala │ Gala │ 56 │ +├────────────────────┼────────────────────┼─────────────────┤ +│ looksrare │ LooksRare │ 157 │ +├────────────────────┼────────────────────┼─────────────────┤ +│ doge-dash │ Doge Dash │ 950 │ +└────────────────────┴────────────────────┴─────────────────┘ +``` +--- diff --git a/website/content/terminal/reference/crypto/find.md b/website/content/terminal/reference/crypto/find.md new file mode 100644 index 000000000000..fcdfaf894ad6 --- /dev/null +++ b/website/content/terminal/reference/crypto/find.md @@ -0,0 +1,114 @@ +--- +title: find +description: 'Use our coin search tool to find similar coins by name, symbol, or id + across different platforms like CoinGecko, Binance, Coinbase and CoinPaprika. If + you don''t remember the exact name or id of a crypto coin, you can use this tool + for your search. Provide your search query and choose the searching key: symbol, + id or name of coin. You can limit the number of records displayed and move over + coins using pagination.' +keywords: +- coin search +- cryptocurrency +- crypto search tool +- find coin by symbol +- find coin by id +- Bitcoin +- CoinGecko +- Binance +- CoinPaprika +- Coinbase +- search query +- pagination mechanism +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Find similar coin by name, symbol, or id. If you don't remember exact name or id of the Coin at CoinGecko, Binance, Coinbase or CoinPaprika you can use this command to display coins with similar name, symbol or id to your search query. Example of usage: coin name is something like "polka". So I can try: find -c polka -k name -t 25 It will search for coin that has similar name to polka and display top 25 matches. -c, --coin stands for coin - you provide here your search query -k, --key it's a searching key. You can search by symbol, id or name of coin -l, --limit it displays top N number of records. coins: Shows list of coins available on CoinGecko, CoinPaprika and Binance.If you provide name of coin then in result you will see ids of coins with best match for all mentioned services. If you provide "ALL" in your coin search query, then all coins will be displayed. To move over coins you can use pagination mechanism with skip, top params. E.g. coins ALL --skip 100 --limit 30 then all coins from 100 to 130 will be displayed. By default skip = 0, limit = 10. If you won't provide source of the data everything will be displayed (CoinGecko, CoinPaprika, Binance). If you want to search only in given source then use --source flag. E.g. if you want to find coin with name uniswap on CoinPaprika then use: coins uniswap --source cp --limit 10 + +### Usage + +```python +find -c COIN [-k {id,symbol,name}] [-l LIMIT] [-s SKIP] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| coin | Symbol Name or Id of Coin | None | False | None | +| key | Specify by which column you would like to search: symbol, name, id | symbol | True | id, symbol, name | +| limit | Number of records to display | 10 | True | None | +| skip | Skip n of records | 0 | True | range(1, 300) | + + +--- + +## Examples + +```python +2022 Feb 15, 07:52 (🦋) /crypto/ $ find -c btc + Similar Coins +┌───────┬────────┬──────────────────────────────┬──────────────────────────────┐ +│ index │ symbol │ id │ name │ +├───────┼────────┼──────────────────────────────┼──────────────────────────────┤ +│ 0 │ btc │ bitcoin │ Bitcoin │ +├───────┼────────┼──────────────────────────────┼──────────────────────────────┤ +│ 1 │ zbtc │ zetta-bitcoin-hashrate-token │ Zetta Bitcoin Hashrate Token │ +├───────┼────────┼──────────────────────────────┼──────────────────────────────┤ +│ 2 │ xbtc │ dforce-btc │ dForce BTC │ +├───────┼────────┼──────────────────────────────┼──────────────────────────────┤ +│ 2 │ xbtc │ synthetic-btc │ Synthetic BTC │ +├───────┼────────┼──────────────────────────────┼──────────────────────────────┤ +│ 2 │ xbtc │ wrapped-bitcoin-stacks │ Wrapped Bitcoin-Stacks │ +├───────┼────────┼──────────────────────────────┼──────────────────────────────┤ +│ 3 │ xbtc │ dforce-btc │ dForce BTC │ +├───────┼────────┼──────────────────────────────┼──────────────────────────────┤ +│ 3 │ xbtc │ synthetic-btc │ Synthetic BTC │ +├───────┼────────┼──────────────────────────────┼──────────────────────────────┤ +│ 3 │ xbtc │ wrapped-bitcoin-stacks │ Wrapped Bitcoin-Stacks │ +├───────┼────────┼──────────────────────────────┼──────────────────────────────┤ +│ 4 │ xbtc │ dforce-btc │ dForce BTC │ +├───────┼────────┼──────────────────────────────┼──────────────────────────────┤ +│ 4 │ xbtc │ synthetic-btc │ Synthetic BTC │ +├───────┼────────┼──────────────────────────────┼──────────────────────────────┤ +│ 4 │ xbtc │ wrapped-bitcoin-stacks │ Wrapped Bitcoin-Stacks │ +├───────┼────────┼──────────────────────────────┼──────────────────────────────┤ +│ 5 │ wbtc │ wrapped-bitcoin │ Wrapped Bitcoin │ +├───────┼────────┼──────────────────────────────┼──────────────────────────────┤ +│ 5 │ wbtc │ wrapped-btc-wormhole │ Wrapped BTC (Wormhole) │ +├───────┼────────┼──────────────────────────────┼──────────────────────────────┤ +│ 6 │ wbtc │ wrapped-bitcoin │ Wrapped Bitcoin │ +├───────┼────────┼──────────────────────────────┼──────────────────────────────┤ +│ 6 │ wbtc │ wrapped-btc-wormhole │ Wrapped BTC (Wormhole) │ +├───────┼────────┼──────────────────────────────┼──────────────────────────────┤ +│ 7 │ vbtc │ venus-btc │ Venus BTC │ +├───────┼────────┼──────────────────────────────┼──────────────────────────────┤ +│ 8 │ ubtc │ united-bitcoin │ United Bitcoin │ +├───────┼────────┼──────────────────────────────┼──────────────────────────────┤ +│ 9 │ tbtc │ t-bitcoin │ τBitcoin │ +├───────┼────────┼──────────────────────────────┼──────────────────────────────┤ +│ 9 │ tbtc │ tbtc │ tBTC │ +└───────┴────────┴──────────────────────────────┴──────────────────────────────┘ + + Similar Coins +┌───────┬───────┬───────┐ +│ index │ id │ name │ +├───────┼───────┼───────┤ +│ 0 │ tbtc │ tBTC │ +├───────┼───────┼───────┤ +│ 1 │ sbtc │ sBTC │ +├───────┼───────┼───────┤ +│ 2 │ wwbtc │ wWBTC │ +├───────┼───────┼───────┤ +│ 3 │ tzbtc │ tzBTC │ +├───────┼───────┼───────┤ +│ 4 │ nhbtc │ nHBTC │ +├───────┼───────┼───────┤ +│ 5 │ bxbtc │ bxBTC │ +└───────┴───────┴───────┘ +``` +--- diff --git a/website/content/terminal/reference/crypto/headlines.md b/website/content/terminal/reference/crypto/headlines.md new file mode 100644 index 000000000000..d4b46b254abe --- /dev/null +++ b/website/content/terminal/reference/crypto/headlines.md @@ -0,0 +1,59 @@ +--- +title: headlines +description: This page provides comprehensive details on how to use 'headlines' to + display sentiment analysis from FinBrain for specific cryptocurrencies. It includes + the usage commands, parameters, and several examples for better understanding. +keywords: +- headlines +- sentiment analysis +- FinBrain +- cryptocurrencies +- command usage +- parameters +- examples +- cryptocurrency symbols +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Display sentiment analysis from FinBrain for chosen Cryptocurrencies + +### Usage + +```python +headlines [-c {AAVE,ADA,ADX,AE,ANT,ARDR,ARK,ATOM,BAT,BCCOIN,BCH,BCN,BLOCK,BNB,BNT,BTC,BTCD,BTG,BTM,BTS,CVC,DASH,DCN,DCR,DGB,DGD,DNT,DOGE,DOT,EDG,EOS,ETH,ETP,FAIR,FCT,FUN,GAME,GAS,GBYTE,GNO,GNT,HSR,ICX,IOC,KIN,KMD,KNC,LINK,LKK,LRC,LSK,LTC,MAID,MCAP,MCO,MGO,MKR,MLN,MONA,MTL,NAV,NEBL,NEO,NLC2,NXS,NXT,OMG,PAY,PIVX,PPT,QASH,QRL,QTUM,REP,RLC,SALT,SC,SMART,SNGLS,STEEM,STORJ,SUB,SYS,TAAS,TRX,UBQ,UNI,USDT,VEN,VERI,VTC,WAVES,WINGS,WTC,XCP,XLM,XMR,XRP,XTZ,XVG,YFI,ZEC,ZEN,ZRX}] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| coin | Symbol of coin to load data for, ~100 symbols are available | BTC | True | AAVE, ADA, ADX, AE, ANT, ARDR, ARK, ATOM, BAT, BCCOIN, BCH, BCN, BLOCK, BNB, BNT, BTC, BTCD, BTG, BTM, BTS, CVC, DASH, DCN, DCR, DGB, DGD, DNT, DOGE, DOT, EDG, EOS, ETH, ETP, FAIR, FCT, FUN, GAME, GAS, GBYTE, GNO, GNT, HSR, ICX, IOC, KIN, KMD, KNC, LINK, LKK, LRC, LSK, LTC, MAID, MCAP, MCO, MGO, MKR, MLN, MONA, MTL, NAV, NEBL, NEO, NLC2, NXS, NXT, OMG, PAY, PIVX, PPT, QASH, QRL, QTUM, REP, RLC, SALT, SC, SMART, SNGLS, STEEM, STORJ, SUB, SYS, TAAS, TRX, UBQ, UNI, USDT, VEN, VERI, VTC, WAVES, WINGS, WTC, XCP, XLM, XMR, XRP, XTZ, XVG, YFI, ZEC, ZEN, ZRX | + + +--- + +## Examples + +```python +2022 Feb 15, 07:52 (🦋) /crypto/ $ headlines + +date +2022-02-06 0.137 +2022-02-07 0.137 +2022-02-08 0.237 +2022-02-09 0.123 +2022-02-10 0.131 +2022-02-11 0.014 +2022-02-12 -0.057 +2022-02-13 0.02 +2022-02-14 0.103 +2022-02-15 0.158 +``` +![headlines](https://user-images.githubusercontent.com/46355364/154066006-d281a8c8-bd25-4355-9cd5-3affd4477bd6.png) + +--- diff --git a/website/content/terminal/reference/crypto/load.md b/website/content/terminal/reference/crypto/load.md new file mode 100644 index 000000000000..6c98eee3d25f --- /dev/null +++ b/website/content/terminal/reference/crypto/load.md @@ -0,0 +1,47 @@ +--- +title: load +description: This page provides instructions on how to load and analyze cryptocurrency + data from various sources with custom intervals using Python. Ideal for Bitcoin, + Ethereum, and other cryptocurrency investors and analysts. +keywords: +- cryptocurrency analysis +- crypto trading +- Yahoo Finance +- ccxt +- cg +- crypto exchange +- Python cryptocurrency +- coin symbol +- Bitcoin +- Ethereum +- Binance +- crypto intervals +- USD trading +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Load crypto currency to perform analysis on. Yahoo Finance is used as default source. Other sources can be used such as 'ccxt' or 'cg' with --source. If you select 'ccxt', you can then select any exchange with --exchange. You can also select a specific interval with --interval. + +### Usage + +```python +load -c COIN [-s START] [--exchange {aax,ascendex,bequant,bibox,bigone,binance,binancecoinm,binanceus,binanceusdm,bit2c,bitbank,bitbay,bitcoincom,bitfinex,bitfinex2,bitflyer,bitforex,bitget,bithumb,bitmart,bitmex,bitopro,bitpanda,bitrue,bitso,bitstamp,bitstamp1,bittrex,bitvavo,bkex,bl3p,btcalpha,btcbox,btcex,btcmarkets,btctradeua,btcturk,buda,bw,bybit,bytetrade,cex,coinbaseprime,coinbasepro,coincheck,coinex,coinfalcon,coinmate,coinone,coinspot,crex24,cryptocom,currencycom,delta,deribit,digifinex,eqonex,exmo,flowbtc,fmfwio,ftx,ftxus,gate,gateio,gemini,hitbtc,hitbtc3,hollaex,huobi,huobijp,huobipro,idex,independentreserve,indodax,itbit,kraken,kucoin,kucoinfutures,kuna,latoken,lbank,lbank2,liquid,luno,lykke,mercado,mexc,mexc3,ndax,novadax,oceanex,okcoin,okex,okex5,okx,paymium,phemex,poloniex,probit,qtrade,ripio,stex,therock,tidebit,tidex,timex,tokocrypto,upbit,wavesexchange,whitebit,woo,yobit,zaif,zb,zipmex,zonda}] [-e END] [-i {1,5,15,30,60,240,1440,10080,43200}] [--vs VS] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| coin | Coin to get. Must be coin symbol (e.g., btc, eth) | None | False | None | +| start | The starting date (format YYYY-MM-DD) of the crypto | 2019-11-21 | True | None | +| exchange | Exchange to search | binance | True | aax, ascendex, bequant, bibox, bigone, binance, binancecoinm, binanceus, binanceusdm, bit2c, bitbank, bitbay, bitcoincom, bitfinex, bitfinex2, bitflyer, bitforex, bitget, bithumb, bitmart, bitmex, bitopro, bitpanda, bitrue, bitso, bitstamp, bitstamp1, bittrex, bitvavo, bkex, bl3p, btcalpha, btcbox, btcex, btcmarkets, btctradeua, btcturk, buda, bw, bybit, bytetrade, cex, coinbaseprime, coinbasepro, coincheck, coinex, coinfalcon, coinmate, coinone, coinspot, crex24, cryptocom, currencycom, delta, deribit, digifinex, eqonex, exmo, flowbtc, fmfwio, ftx, ftxus, gate, gateio, gemini, hitbtc, hitbtc3, hollaex, huobi, huobijp, huobipro, idex, independentreserve, indodax, itbit, kraken, kucoin, kucoinfutures, kuna, latoken, lbank, lbank2, liquid, luno, lykke, mercado, mexc, mexc3, ndax, novadax, oceanex, okcoin, okex, okex5, okx, paymium, phemex, poloniex, probit, qtrade, ripio, stex, therock, tidebit, tidex, timex, tokocrypto, upbit, wavesexchange, whitebit, woo, yobit, zaif, zb, zipmex, zonda | +| end | The ending date (format YYYY-MM-DD) of the crypto | 2022-11-25 | True | None | +| interval | The interval of the crypto | 1440 | True | 1, 5, 15, 30, 60, 240, 1440, 10080, 43200 | +| vs | Quote currency (what to view coin vs). e.g., usdc, usdt, ... if source is ccxt, usd, eur, ... otherwise | usdt | True | None | + +--- diff --git a/website/versioned_docs/version-v3/terminal/reference/crypto/nft/_category_.json b/website/content/terminal/reference/crypto/nft/_category_.json similarity index 100% rename from website/versioned_docs/version-v3/terminal/reference/crypto/nft/_category_.json rename to website/content/terminal/reference/crypto/nft/_category_.json diff --git a/website/content/terminal/reference/crypto/nft/collections.md b/website/content/terminal/reference/crypto/nft/collections.md new file mode 100644 index 000000000000..efa8d0c49a84 --- /dev/null +++ b/website/content/terminal/reference/crypto/nft/collections.md @@ -0,0 +1,64 @@ +--- +title: collections +description: Understand how to use Python code for tracking NFT collections. The guide + includes scripts and examples showcasing how to display the floor price and sales + over time for top collections including CryptoPunks, Bored Ape Yacht Club, and others. +keywords: +- NFT Collections +- floor price +- sales over time +- top collections +- CryptoPunks +- Bored Ape Yacht Club +- Mutant Ape Yacht Club +- Otherdeed for Otherside +- Moonbirds +- ethereum +- python code for NFTs +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +NFT Collections [Source: https://nftpricefloor.com/] + +### Usage + +```python +collections [--fp] [--sales] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| fp | Flag to display floor price over time for top collections | False | True | None | +| sales | Flag to display sales over time for top collections | False | True | None | + + +--- + +## Examples + +```python +NFT Collections +┏━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━┳━━━━━━━━━━━━━┳━━━━━━━━━━━━┓ +┃ slug ┃ name ┃ floorPriceETH ┃ totalSupply ┃ countOnSale ┃ blockchain ┃ +┡━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━╇━━━━━━━━━━━━━╇━━━━━━━━━━━━┩ +│ cryptopunks │ CryptoPunks │ 67.95 │ 10000 │ 1145 │ ethereum │ +├───────────────────────┼─────────────────────────┼───────────────┼─────────────┼─────────────┼────────────┤ +│ bored-ape-yacht-club │ Bored Ape Yacht Club │ 65.68 │ 10000 │ 775 │ ethereum │ +├───────────────────────┼─────────────────────────┼───────────────┼─────────────┼─────────────┼────────────┤ +│ mutant-ape-yacht-club │ Mutant Ape Yacht Club │ 11.99 │ 19423 │ 1075 │ ethereum │ +├───────────────────────┼─────────────────────────┼───────────────┼─────────────┼─────────────┼────────────┤ +│ otherdeed │ Otherdeed for Otherside │ 1.57 │ 100000 │ 3932 │ ethereum │ +├───────────────────────┼─────────────────────────┼───────────────┼─────────────┼─────────────┼────────────┤ +│ proof-moonbirds │ Moonbirds │ 13.25 │ 10000 │ 145 │ ethereum │ +└───────────────────────┴─────────────────────────┴───────────────┴─────────────┴─────────────┴────────────┘ +``` +![collections fp command](https://user-images.githubusercontent.com/40023817/186201697-ff15dd9c-3b09-4c3a-b498-e98a876f1338.png) + +--- diff --git a/website/content/terminal/reference/crypto/nft/fp.md b/website/content/terminal/reference/crypto/nft/fp.md new file mode 100644 index 000000000000..9cd52e15b405 --- /dev/null +++ b/website/content/terminal/reference/crypto/nft/fp.md @@ -0,0 +1,47 @@ +--- +title: fp +description: This content provides a comprehensive guide on utilizing the 'fp' command + in retrieving the floor price of a specific NFT collection. Examples of collections + include Bored Ape Yacht Club, CryptoPunks, and Cool Cats. +keywords: +- NFT +- floor price +- collection +- SLUG +- fp +- bored-ape-yacht-club +- cryptopunks +- meebits +- veefriends +- cool-cats +- bored-ape-kennel-club +- mekaverse +- cryptoblots-art-blocks-curated +- loot +- uninterested-unicorns +- doodles +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Display floor price of a certain NFT collection. [Source: https://nftpricefloor.com/] + +### Usage + +```python +fp -s SLUG +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| slug | NFT floor price collection slug (e.g., bored-ape-yacht-club) | None | False | avastars, wicked-craniums, hyperhash-art-blocks-curated, official-moar-by-joan-cornella, ecumenopolis-art-blocks-playground, supducks, neo-tokyo-identities, ether-orcs, mooncats, cryptopunks, foustlings, mfers, meebits, tom-sachs-rockets, akuma-origins, plasma-bears, rtfkt-mnlth, akutars, eightbitme, shinsei-galverse, gh0stly-gh0sts, ragnarok-meta, mcgoblinwtf, foxfam, the-potatoz, autoglyphs, milady, the-blocks-of-art-art-blocks-curated, scribbled-boundaries-art-blocks-curated, dooplicator, 27-bit-digital-art-blocks-curated, 720-minutes-art-blocks-curated, aerial-view-art-blocks-curated, grifters-by-xcopy, algobots-art-blocks-curated, apparitions-art-blocks-curated, bubble-blobby-art-blocks-curated, geometry-runners-art-blocks-curated, squiggly, singularity-art-blocks-curated, unigrids-art-blocks-curated, metahero-universe-generative, archetype-art-blocks-curated, trossets-art-blocks-curated, collectvox, veefriends, forgotten-runes-wizards-cult, cool-cats, the-vogu-collective, joyworld-joys, algorhythms-art-blocks-curated, renga, metasaurs, bored-ape-kennel-club, the-cryptodads, gener8tive-k-compositions, the-shiboshis, gen-art-membership, deadfellaz, gevols, neo-tokyo-part-3-item-caches, blitmap, bears-deluxe, jungle-freaks-by-trosley, 888-inner-circle, wolf-game, voxies, neo-tokyo-part-4-land-deeds, nimbuds-art-blocks-curated, subscapes-art-blocks-curated, chill-frogs, creepz-genesis, poap, sappy-seals, pulsquares, chimera-art-blocks-curated, Decentraland, pudgy-penguins, genesis-braindrops, asm-aifa-genesis, jrny-nft-club, party-ape-billionaire-club, incognito, cyberbrokers, chain-runners, dotdotdots, wicked-ape-bone-club, etheria, proof-collective, bapetaverse-official, dynamic-slices-art-blocks-curated, shinsekaicorp, murakami-flowers, the-yakuza-cats-society, space-punks-club, veefriends-series-2, v1-cryptopunks-wrapped, supernormalbyzipcy, frammenti-art-blocks-curated, lostsamurise, peaceful-groupies, adidas-virtual-gear-genesis, gambling-apes, 0xMons, desperate-ape-wives, adidas-for-prada, framergence, the-littles-nft, kleee02, renga-black-box, purrnelopes-country-club, haki-nft, tiny-dinos, quantum-key, arcade-land, impostors-genesis-aliens, los-muertos-world, everai-heroes-duo, factura-by-mathias-isaksen, dreams-art-blocks-curated, construction-token-art-blocks-curated, byopills, crypto-bull-society, cupcats-official, galaxy-eggs, gutter-dogs, spooky-boys-country-club, the-art-of-seasons, beeple-everydays, elevated-deconstructions-art-blocks-curated, sorare, we-are-all-going-to-die, loot, uninterested-unicorns, mekaverse, premint-collector-pass, cryptoblots-art-blocks-curated, the-association-nft, chimpers-nft, cosmic-reef-art-blocks-curated, meridian-art-blocks-playground, phototaxis-art-blocks-playground, paper-armada-art-blocks-playground, treeverse, time-pieces-build-a-better-future, doodles, genesis-art-blocks-curated, beeple-genesis-collection, jadu-jetpack, galacticapes, digidaigaku, winter-bears, cryptoskulls, decentraland_names, raidparty-fighters, ens-domains, adidas-originals-capsule-collection, 10ktf, asm-brains, galaxy-fight-club, curio-cards, fluf-world, dodgers-mlb-crypto, vaynersports-pass-vsp, elementals-art-blocks-curated, screens-art-blocks-curated, memories-of-qilin-art-blocks-curated, colorspace-art-blocks-curated, flux-art-blocks-curated, anticyclone-art-blocks-curated, the-humanoids, ignition-art-blocks-curated, inspirals-art-blocks-curated, lonely-alien-space-club, spectron-art-blocks-curated, synapses-art-blocks-curated, watercolor-dreams-art-blocks-curated, glitch-crystal-monsters-art-blocks-curated, pigments-art-blocks-curated, endless-nameless-art-blocks-curated, sneaky-vampire-syndicate, bastard-gan-punks-v2, damien-hirst-the-currency, coolmans-universe, creepz-reptile-armoury, rhythm-art-blocks-playground, smilesssvrs, the-alien-secret-society, space-doodles, wavelength, furballs, killergf, nina-s-super-cool-world, monaco-planet-yacht, crypto-cannabis-club, thorguards, punks-comic, invisible-friends, karafuru, cryptocoven, wizards-dragons-game, the-doge-pound, creature-world, phase-art-blocks-curated, cryptoadz, monkey-bet-dao, divine-anarchy, fang-gang, moonbirds-oddities, onchainmonkey, superlative-secret-society, alien-insects-art-blocks-playground, cryptoon-goonz, isekai-meta, rektguy, io-imaginary-ones, animetas, ape-gang, habbo-avatars, al-cabones, fidenza-art-blocks-curated, cryptodickbutts, playboy-rabbitars-official, first-first-nfts, ether-cards-founder, goop-troop, fvck-crystal, headdao, 8liens, gutter-rats, stoner-cats, bubblegum-kids, the-official-surreals, fusion-by-hideki-tsukamoto, where-my-vans-go, kiwami-genesis, the-alien-boy, tubby-cats, lives-of-asuna, 1111-by-kevin-abosch, cryptobatz-by-ozzy-osbourne, dourdarcels, defy-genesis-masks, polygonpunks, peculiar-gang, the-n-project, otherdeed, fluf-world-thingies, gutter-pigeons, world-of-women, realms-for-adventurers, generativemasks, crypto-pills-by-micha-klein, heaven-computer, cryptomories, the-wanderers, the-blitnauts, capsule-house, timeless-characters, apostles-genesis, waifusion, swampverse, bored-mummy-waking-up, fragments-of-an-infinite-field-art-blocks-curated, aww-friends, ancient-courses-of-fictional-rivers-art-blocks-curated, shitbeast, mutant-garden-seeder, cyberkongz-genesis, collectvoxmirandus, azuki, salt-v4, satoshibles, uwucrew, neo-tokyo-outer-identities, 3landers, goblintownwtf, mutant-ape-yacht-club, lightspeed-lads, genuine-ardvark, dino-pals-art-blocks-factory, 0n1-force, cyberkongz-vx, adidas-originals-into-the-metaverse-phase-1-and-2, portal-art-blocks-playground, the-saudis-nft, goatz, podgans-braindrops, animonkeys, anonymice-breeding, song-a-day, corruption-s, boki-nft, solos, deafbeef, anonymice, gazers, sipherian-surge, phantabear, prime-ape-planet-pap, creepz-shapeshifterz, muri-haus, cryptocubes, fast-food-punks, ack-unique-editions, fomoverse, hapeprime, alienfrensnft, derace-horses, mr-crypto-by-racksmafia, the-senses, rojom, color-study-art-blocks-playground, drip-squad, avatar-rock-out, the-minds-eye, proof-moonbirds, ape-kids-club, world-of-women-galaxy, og-crystals, nouns, angry-ape-army, cryptotrunks, solvency, bored-ape-yacht-club, lazy-lions, rumble-kong-league, wonderpals, apes-in-space, yolo-holiday, the_sandbox, adidas-wagmi-united, crypto-unicorns, spooky-season-poieeeyee, mlb-champions, the-sevens, eulerbeats-genesis-original, wearing-your-emotion, natsukashii, treasure-of-ophiel, imaginatation-station, cute-snacks, conall-in-space, bald-tuesdays, alien-clock-art-blocks-playground, party-degenerates, rug-radio-genesis-nft, loomlocknft, skulptuur-art-blocks-curated, letswalk, entretiempos-art-blocks-curated, obits, koin-games-dev-squad, metahero-universe-core-identities, para-bellum-art-blocks-curated, ainightbirds, decentraland_wearables, revenants-by-alethea-ai, dapper-dinos-nft, chumbi-valley, tfoust10, celestial-assembly, 5-boro-bodega, gettin-groovy, meme-team, creatures-of-the-nighties, enlightenment, earth-to-planet, edifice, mutant-cats, vortex, bored_ape_chemistry_club, bulls-on-the-block, ghostsproject, avidlines, rareapepeyachtclub, royal-society-of-players, smallbros, adam-bomb-squad, fomo-dog-club, ikb-cachet-de-garantie, zombieclub-token, koala-intelligence-agency, cute-cool-and-creepy, the-singularity, hausphases, robotos, deadheads, gutter-cat-gang, ringers-art-blocks-curated, beeple-spring-summer-collection, nftrees, merge, slotie-nft, crypto-stamp, deez-nuts, stepn-shoeboxes, beanz-official, i-quit-my-job-to-be-an-artist, doodle-collection, autology, the-fatty-bagz, bent, rituals, old-school-cool, magic-of-the-woods, stutter-void, tandizojere, bodegacatceo, the-eternal-pump, boss-beauties, impact-theory-founders-key, nifty-league-degens, clonex, pegz, fewocious-x-rtfkt, meta-legends, lil-heroes-by-edgar-plans, worldwide-webb-land, the-butterfly-garden, sys32template, aylia, neo-tokyo-part-2-vault-cards, chromie-squiggle-art-blocks-curated, nft-worlds, chainfaces, lobsterdao, cryptoarte, backed-goods-&-evils, growl-gang, creatures-without-pants, exosama-expect-chaos, parallel-alpha, qql-mint-pass, cryptovoxels, oana193, substantial-law-910, baby-doge-army, genuine-undead-nft, protectors-of-the-forest, drag-queens-of-big-gay-baby, hoppy-doodle, alicia-freeman-designs, boonji-project, automatism-art-blocks-factory, dystopunks, laura-dumitriu, puzzled-panther, looki, century-art-blocks-curated, mind-the-gap-by-mountvitruvius, hedz-by-matt-furie, beeple-5000-days-collection, max-pain-and-frens-by-xcopy, worst-twitch-ever, canetoonist, joy-girls-club, plasticity-by-p4stoboy, sidus-nft-heroes, avire-nft, tirli, bites-of-brazil, rtfkt-x-rimowa, fewoworld-paint-nft, raunchy-rancor, fmarxy, doge-pound-puppies, inft-personality-pod-by-alethea-ai, dubbl3bee, mask-world-nft, eando9745, catharsis-by-dario-lanza, rinascita, art-gobblers, koripo-by-rich-poole, nike-rtfkt-cryptokicks-dunk-genesis, colorglyphs, nike-monolith, metroverse-genesis, ledger-market-pass-genesis-edition, psychedelics-anonymous-genesis, nike-ar-hoodie-rtfkt, cool-pets-nft, kaiju-kingz, crypto-chicks, valhalla, jiometory-no-compute-art-blocks-curated, broadside, fancy-bears, mimic-shhans, cool-cats-football-club, metabillionaire, akumu-dragonz, sail-o-bots-art-blocks-factory, hashmasks, blvckgenesis, 3d-invisible-friends, asemica, kpr | + +![fp command](https://user-images.githubusercontent.com/43375532/186253073-e50643be-391f-4aa4-949b-946b2d000f38.png) + +--- diff --git a/website/content/terminal/reference/crypto/nft/stats.md b/website/content/terminal/reference/crypto/nft/stats.md new file mode 100644 index 000000000000..dc8e27e73a55 --- /dev/null +++ b/website/content/terminal/reference/crypto/nft/stats.md @@ -0,0 +1,88 @@ +--- +title: stats +description: A guide to displaying statistics of an OpenSea NFT collection such as + market cap, floor price, volume, and sales using a slug parameter. This includes + an example using the Mutant Ape Yacht Club collection. +keywords: +- OpenSea +- NFT +- Collection +- Stats +- Market Cap +- Floor Price +- Average Price +- Volume +- Sales +- Slug +- Crypto +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Display stats about an opensea nft collection. e.g. alien-frens [Source: https://opensea.io] + +### Usage + +```python +info -s SLUG +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| slug | Opensea collection slug (e.g., mutant-ape-yacht-club) | None | False | None | + + +--- + +## Examples + +```python +2022 Feb 15, 07:56 (🦋) /crypto/nft/ $ stats mutant-ape-yacht-club + Collection Stats +┌────────────────────────────────┬───────────────────────┐ +│ Metric │ Value │ +├────────────────────────────────┼───────────────────────┤ +│ Name │ Mutant Ape Yacht Club │ +├────────────────────────────────┼───────────────────────┤ +│ Floor Price (ETH) │ 20.00 │ +├────────────────────────────────┼───────────────────────┤ +│ Number of Owners │ 11739.00 │ +├────────────────────────────────┼───────────────────────┤ +│ Market Cap (ETH) │ 394162.01 │ +├────────────────────────────────┼───────────────────────┤ +│ Average Price ETH │ 9.41 │ +├────────────────────────────────┼───────────────────────┤ +│ One day volume (ETH) │ 529.62 │ +├────────────────────────────────┼───────────────────────┤ +│ One day change (%) │ 3.65 │ +├────────────────────────────────┼───────────────────────┤ +│ One day sales (ETH) │ 24.00 │ +├────────────────────────────────┼───────────────────────┤ +│ One day average price (ETH) │ 22.07 │ +├────────────────────────────────┼───────────────────────┤ +│ Thirty day volume (ETH) │ 50336.61 │ +├────────────────────────────────┼───────────────────────┤ +│ Thirty day change (%) │ -19.89 │ +├────────────────────────────────┼───────────────────────┤ +│ Thirty day sales (ETH) │ 2269.00 │ +├────────────────────────────────┼───────────────────────┤ +│ Thirty day average price (ETH) │ 22.18 │ +├────────────────────────────────┼───────────────────────┤ +│ Total Supply (ETH) │ 17958.00 │ +├────────────────────────────────┼───────────────────────┤ +│ Total Sales (ETH) │ 25728.00 │ +├────────────────────────────────┼───────────────────────┤ +│ Total Volume (ETH) │ 242008.36 │ +├────────────────────────────────┼───────────────────────┤ +│ Creation Date │ Aug 29, 2021 │ +├────────────────────────────────┼───────────────────────┤ +│ URL │ - │ +└────────────────────────────────┴───────────────────────┘ +``` +--- diff --git a/website/versioned_docs/version-v3/terminal/reference/crypto/onchain/_category_.json b/website/content/terminal/reference/crypto/onchain/_category_.json similarity index 100% rename from website/versioned_docs/version-v3/terminal/reference/crypto/onchain/_category_.json rename to website/content/terminal/reference/crypto/onchain/_category_.json diff --git a/website/content/terminal/reference/crypto/onchain/address.md b/website/content/terminal/reference/crypto/onchain/address.md new file mode 100644 index 000000000000..010723e86ed9 --- /dev/null +++ b/website/content/terminal/reference/crypto/onchain/address.md @@ -0,0 +1,40 @@ +--- +title: address +description: This page provides a guide to loading and analyzing account addresses, + token addresses and transaction hashes on Ethplorer with Python. Learn how to use + parameters for efficient analysis. +keywords: +- ethplorer +- address +- account address +- token address +- transaction hash +- erc20 +- ethereum +- analysis +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Load address for further analysis. You can analyze account address, token address or transaction hash. [Source: Ethplorer] + +### Usage + +```python +address [-a] [-t] [-tx] --address ADDRESS +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| account | Account address | False | True | None | +| token | ERC20 token address | False | True | None | +| transaction | Transaction hash | False | True | None | +| address | Ethereum address | False | False | None | + +--- diff --git a/website/content/terminal/reference/crypto/onchain/baas.md b/website/content/terminal/reference/crypto/onchain/baas.md new file mode 100644 index 000000000000..9f94b046ab79 --- /dev/null +++ b/website/content/terminal/reference/crypto/onchain/baas.md @@ -0,0 +1,45 @@ +--- +title: baas +description: This documentation is related to the 'baas' function which displays the + average bid, ask prices, and spread for a chosen crypto pair over a specified time + period. The function can work with various cryptocurrencies and ERC 20 tokens. +keywords: +- baas +- crypto pair +- average bid +- average ask prices +- spread +- time period +- ERC20 token +- crypto currency +- ETH +- USD +- BTC +- USDT +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Display average bid, ask prices, spread for given crypto pair for chosen time period [Source: https://graphql.bitquery.io/] + +### Usage + +```python +baas [-c COIN] [-vs {ETH,USD,BTC,USDT}] [-l LIMIT] [-s {date,baseCurrency,quoteCurrency,dailySpread,averageBidPrice,averageAskPrice}] [-r] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| coin | ERC20 token symbol or address. | None | True | WETH, USDC, USDT, DAI, WBTC, FEI, sUSD, SHIB, SUSHI, ETH, OHM, UNI, LINK, AAVE, renBTC, TUSD, -, sETH, YFI, imBTC, ALCX, TRIBE, HEX, BNT, SPELL, sBTC, BUSD, UST, CVX, KOKO, FRAX, ETH2x-FLI, LUSD, ELON, LEASH, RAI, MC, EDEN, DYDX, 1INCH, EURS, RBN, MKR, ENS, BIT, ILV, CRV, DELTA, SNX, TOKE, MATIC, SQUID, SYN, SAITAMA, COMP, AGLD, FODL, EURT, BONE, DOG, SAND, AMPL, FNK, PAX, BAC, BDP, DPI, MIC, FTM, TRU, BADGER, BAL, HBTC, AXS, FXS, LRC, MOCHI, WISE, UFO, eRSDL, ESD, sLINK, RGT, STARL, DYP, LOBI, DOE, PERP, TKING, PEOPLE, AKITA, BOND, WDOGE, VSP, MM, ICE, LDO, RARE, CENNZ, xSUSHI, BDI, GM, CARDS, DSD, FARM, MIR, KISHU, AMP, RPL, FLOKI, DIGG, MIS, NCR, YGG, cvxCRV, KINE, CEL, ENJ, LON, MANA, GNO, NU, DRC, BGLD, SHKOOBY, NFD, ALPHA, BAS, PICKLE, RLY, ibEUR, NFTX, FEG, GALA, WOO, welp, SCAMMY, generalize fix for rebass tokens, RAD, Ian Laphan fan token, KP3R, SUPER, ROOK, FLX, REN, MIM, PSP, POLS, agEUR, BANK, NEXO, CORE, sETH2, FLOOR, RUNE, VISR, MCB, UNQT, IMX, BMI, LYXe, STRONG, REB, HGT, UMA, KUMA, BOTTO, WTON, BAND, DAO, AUDIO, XOR, SOUL, bALPHA, TORN, GRO, LEND, ERN, XXi, GYEN, DEXTF, INST, CREAM, VEMP, GRPFT, aKLIMA, ZCX, ibBTC, wNXM, USE, FTX Token, VADER, PLUG, PILOT, stETH, WOOL, KEEP, eXRD, ANY, TUBE2, VERSE, 10SET, DODO, STMX, STAKE, FOX, WAXE, GRT, EVN, RACA, COLLAR, KBTC, XSGD, yveCRV-DAO, aEth, LUNA, PUNK, DFX, LQTY, DERC, SHEESHA, SNGJ, ORB, LCX, BRAIN, RC_WETH_750_DAI_2021_3_31, OUSD, CHAIN, FX, SRM, SAK3, LIMIT, QNT, eMax, mIAU, CRO, USDN, HOPR, XMT, wCRES, 3Crv, EPAY, MASK, UFODOGE, $BASED, TTX, YAXIS, HOKK, PPAY, CAPY, DEA, RC_WBTC_25000_DAI_2021_3_31, OCEAN, DEUS, MILF, STA, pBTC, ibGBP, LPOOL, UBOMB, VRA, UNIX, MXS, LMT, LGB, COR, wPE, GERO, DFL, ZKS, DPX, KIMCHI, vBNT, DORA, Metis, PAID, yvBOOST, wstETH, KYL, BFC, NII, COC, BLACKHOLE, HANU, COTI, BEAN, DEV, LESS, sILV, sOHM, PEBBLE, KIRO, XES, Auction, ORN, GUSD, gm, SWAP, REQ, AUSCM, MPL, PAR, XTK, xSNXa, UMX, RBC, WGMI, OPUL, DEXT, uJENNY, HXB, PENDLE, COVER, ArtDeco, mFloki, TEL, KCAL, FREN, MetaCat, vETH, NAUSICAA, GTC, FREE, AXN, BANANA, SALE, AST1, PKF, BLOCKS, AST, BCS, 3DOG, SI, XFOC, BSOCIAL, MTA, BAT, YAM, UOS, $DG, COMBO, DEFI5, WHALE, APY, BOOST, WOOFY, SDT, YUAN, XEND, OGN, RAMP, yyDAI+yUSDC+yUSDT+yTUSD, LEAFA, SHAMAN, NTVRK, LONDON, buidl, SANSHU, SLP, CERTI, PAXG, LYM, eCum, SMINU, MIMO, UNISTAKE, ALBT, mLOOT, SHB5, GPYX, NOS, RKYU, CTX, K9, CZ, C3, 3TH, CHARLOTTE, COIN, PNT, JEJUDOGE, GMGN, ROOM, FEWGO, SKL, MCO2, BONDLY, GDT, XCAD, BNS, FGLD, XFIT, IDTT, EFI, DOGEGF, HUMAN, XP, Eevee Inu , MEME, PLUG-B, LIX, VXV, OCC, DVF, UBT, YAMv2, pBTC35A, GMT, CUBE, MCC, HEZ, DRF, PUSH, TEMP, RAIL, yDAI+yUSDC+yUSDT+yTUSD, AION, PREMIA, Lelouch, DBUY, XAUt, QRDO, wANATHA, TCAP, BEZOGE, SYLO, STAK, RUSD, oneUNI, PSHIB, xAAVEb, SBC DAO, ID, FOMO, SCREAMINU, SqINU, XYO, XTM, WAGMI, STARB, ViCA, DAM, ANGLE, AIOZ, USF, FST, MFG, SOCRAT, BTRST, PAPER, CONV, POLK, SAFE, 69, RVST, WING, CHINU, MSHIBA, GIZMO, COPE, OOP, MTO, METAGOKU, BLACKSTALLION, AKITACASH, Interstellar, RFOX, NBNG, DIADOGE, APED, BTC2x-FLI, HZM, TECH, MOON, pLTC, MPY, WOGE, FLOAT, SHFL, CAKEINU, LEBRON, RSR, RARI, WXT, RULER, ODA, VLT, PKINU, ERC20, MFS, WWT, VOL, HINU, YLD, PICIPO, GNBU, SWAG, TFI-LP, METACEX, ASTRO, OPM, LEECH, Yf-DAI, SHINU, HOUND, LBY, AFT, ANIME, rDPX, RAICHU, DGCL, SPANK, CHININU, MGC, ICHI, ZENDOGE, KOMBAT, KISHIMOTO, LEEEEECH, SAPINU, SPIDEYINU , ELAND, SCOOP, DONI, SDOG, ZINU, GIVE, SUPER HEAVY , LGBTSHIBA, SHIB2, CIAO, BARK, TOKYOGHOUL, AVINOC, BIN, BID, TMTG, MLINK, NFY, VAMINU, GG, ORION, WASABI, GP, ROLL?, vETH2, CELL, TINYSAITAMA, 1Punch, RAC, MACROHARD, SGT, ODI, SCOOBY, Mononoke-Inu, CLAKE, SAT, TRND, NEWINU, KST, Rainbows, EWTB, SMT, DNXC, PMON, HMF, UBI, SER, MASHIMA, STIMMY, NFTD, GMI, xHDX, SAITO, MINT, YOP, UMB, LID, SPI, wsOHM, wCFG, GN, B20, XDEFI, MATTER, FDT, LBXC, ONX, SDL, FUN, DDOS, CC10, CoShi, LGCY, PXT, MTHD, ENCORE, TCR, mUSD, K21, ibETH, FNX, REVV, BULK, TOWN, SFI, LAYER, DOGE, ITS, TVK, TGX, Hi, WILD, CFi | +| vs | Quote currency | USDT | True | ETH, USD, BTC, USDT | +| limit | Number of days to display data for. | 10 | True | None | +| sortby | Sort by given column. | date | True | date, baseCurrency, quoteCurrency, dailySpread, averageBidPrice, averageAskPrice | +| reverse | Data is sorted in descending order by default. Reverse flag will sort it in an ascending way. Only works when raw data is displayed. | False | True | None | + +--- diff --git a/website/content/terminal/reference/crypto/onchain/balance.md b/website/content/terminal/reference/crypto/onchain/balance.md new file mode 100644 index 000000000000..0d663ab73ad8 --- /dev/null +++ b/website/content/terminal/reference/crypto/onchain/balance.md @@ -0,0 +1,40 @@ +--- +title: balance +description: Metadata for the page discussing about the 'balance' function to display + information about tokens on given Ethereum blockchain balance. The page outlines + how to use this function, its parameters, and their possible values. +keywords: +- ethplorer +- ethereum +- balance +- tokens +- python script +- blockchain balance +- sortby function +- ascending order +- descending order +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Display info about tokens on given ethereum blockchain balance. [Source: Ethplorer] + +### Usage + +```python +balance [-l LIMIT] [-s {index,balance,tokenName,tokenSymbol}] [-r] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| limit | display N number records | 10 | True | None | +| sortby | Sort by given column. Default: index | index | True | index, balance, tokenName, tokenSymbol | +| reverse | Data is sorted in descending order by default. Reverse flag will sort it in an ascending way. Only works when raw data is displayed. | False | True | None | + +--- diff --git a/website/content/terminal/reference/crypto/onchain/btccp.md b/website/content/terminal/reference/crypto/onchain/btccp.md new file mode 100644 index 000000000000..694762802d29 --- /dev/null +++ b/website/content/terminal/reference/crypto/onchain/btccp.md @@ -0,0 +1,40 @@ +--- +title: btccp +description: btccp displays the Bitcoin (BTC) circulating supply with ranging parameters. + It uses data sourced from blockchain's API while offering a customizable date range. +keywords: +- Bitcoin +- BTC +- circulating supply +- blockchain API +- cryptocurrency +- data visualization +- btccp +- data extraction +- date parameters +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Display BTC circulating supply [Source: https://api.blockchain.info/] + +### Usage + +```python +btccp [-s SINCE] [-u UNTIL] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| since | Initial date. Default: 2010-01-01 | 2010-01-01 | True | None | +| until | Final date. Default: 2021-01-01 | 2022-11-25 | True | None | + +![btccp](https://user-images.githubusercontent.com/46355364/154067527-0916ab9d-4690-4077-9037-a2665f9fc593.png) + +--- diff --git a/website/content/terminal/reference/crypto/onchain/btcct.md b/website/content/terminal/reference/crypto/onchain/btcct.md new file mode 100644 index 000000000000..b35743791a00 --- /dev/null +++ b/website/content/terminal/reference/crypto/onchain/btcct.md @@ -0,0 +1,38 @@ +--- +title: btcct +description: The btcct page provides details on how to monitor Bitcoin confirmed transactions + using the Blockchain API with adjustable date parameters. +keywords: +- btcct +- Bitcoin transactions +- Blockchain API +- Confirmed transactions +- BTC +- Cryptocurrency +- Crypto transactions monitoring +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Display BTC confirmed transactions [Source: https://api.blockchain.info/] + +### Usage + +```python +btcct [-s SINCE] [-u UNTIL] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| since | Initial date. Default: 2010-01-01 | 2010-01-01 | True | None | +| until | Final date. Default: 2022-11-25 | 2022-11-25 | True | None | + +![btcct](https://user-images.githubusercontent.com/46355364/154067586-d80059e8-cf7b-475a-990b-cf2aec7bc646.png) + +--- diff --git a/website/content/terminal/reference/crypto/onchain/ds.md b/website/content/terminal/reference/crypto/onchain/ds.md new file mode 100644 index 000000000000..0d4fb5f904b2 --- /dev/null +++ b/website/content/terminal/reference/crypto/onchain/ds.md @@ -0,0 +1,39 @@ +--- +title: ds +description: DS provides daily transactions of certain symbols in Ethereum blockchain, + it supports platforms such as uniswap-v3, uniswap-v2, sushiswap, and curve. It primarily + helps in checking fees and the number of users over time. +keywords: +- ds +- daily transactions +- ethereum blockchain +- platforms +- uniswap-v3 +- uniswap-v2 +- sushiswap +- curve +- fees +- number of users over time +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Get daily transactions for certain symbols in ethereum blockchain [Source: https://sdk.flipsidecrypto.xyz/shroomdk] + +### Usage + +```python +ds [-p {uniswap-v3,uniswap-v2,sushiswap,curve}] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| platform | Ethereum platform to check fees/number of users over time | curve | True | uniswap-v3, uniswap-v2, sushiswap, curve | + +--- diff --git a/website/content/terminal/reference/crypto/onchain/dt.md b/website/content/terminal/reference/crypto/onchain/dt.md new file mode 100644 index 000000000000..4042c7bb2f01 --- /dev/null +++ b/website/content/terminal/reference/crypto/onchain/dt.md @@ -0,0 +1,34 @@ +--- +title: dt +description: This page provides info on how to get daily transactions for certain + symbols in ethereum blockchain using the 'dt' command. +keywords: +- dt +- transactions +- symbols +- ethereum +- blockchain +- flipsidecrypto +- crypto +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Get daily transactions for certain symbols in ethereum blockchain [Source: https://sdk.flipsidecrypto.xyz/shroomdk] + +### Usage + +```python +dt +``` + +--- + +## Parameters + +This command has no parameters + + +--- diff --git a/website/content/terminal/reference/crypto/onchain/dvcp.md b/website/content/terminal/reference/crypto/onchain/dvcp.md new file mode 100644 index 000000000000..57041e83c3cc --- /dev/null +++ b/website/content/terminal/reference/crypto/onchain/dvcp.md @@ -0,0 +1,43 @@ +--- +title: dvcp +description: dvcp helps you to analyze the daily trading volume for any given cryptocurrency + pair. It includes features for sorting and displaying the data based on different + parameters including coin type, quote currency, and range of days. +keywords: +- crypto +- dvcp +- crypto pair volume +- ERC20 token +- Sort data +- Bitcoin +- Ethereum +- USDT +- crypto trading +- trade volume +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Display daily volume for given crypto pair [Source: https://graphql.bitquery.io/] + +### Usage + +```python +dvcp -c COIN [-vs {ETH,USD,BTC,USDT}] [-d DAYS] [-s {date,exchange,base,quote,open,high,low,close,tradeAmount,trades}] [-r] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| coin | ERC20 token symbol or address. | None | False | None | +| vs | Quote currency | USDT | True | ETH, USD, BTC, USDT | +| days | Number of days to display data for. | 10 | True | range(1, 100) | +| sortby | Sort by given column. | date | True | date, exchange, base, quote, open, high, low, close, tradeAmount, trades | +| reverse | Data is sorted in descending order by default. Reverse flag will sort it in an ascending way. Only works when raw data is displayed. | False | True | None | + +--- diff --git a/website/content/terminal/reference/crypto/onchain/gwei.md b/website/content/terminal/reference/crypto/onchain/gwei.md new file mode 100644 index 000000000000..3fddc8e3c284 --- /dev/null +++ b/website/content/terminal/reference/crypto/onchain/gwei.md @@ -0,0 +1,34 @@ +--- +title: gwei +description: This page provides in-depth information on gwei, ETH gas fees, and their + usage with the onchain command. It's a valuable resource for those involved in the + crypto transaction process on the Ethereum platform. +keywords: +- gwei +- ETH gas fees +- onchain +- ethereum +- ethgasstation.info +- crypto transaction +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Display ETH gas fees [Source: https://ethgasstation.info] + +### Usage + +```python +onchain +``` + +--- + +## Parameters + +This command has no parameters + + +--- diff --git a/website/content/terminal/reference/crypto/onchain/hist.md b/website/content/terminal/reference/crypto/onchain/hist.md new file mode 100644 index 000000000000..b39f7cd352b1 --- /dev/null +++ b/website/content/terminal/reference/crypto/onchain/hist.md @@ -0,0 +1,38 @@ +--- +title: hist +description: Learn how to us the 'hist' function to display history for any given + Ethereum Blockchain balance using Ethplorer. Understand the usage, parameters and + their defaults, for an optimized user experience. +keywords: +- crypto +- ethereum +- hist +- blockchain +- ethereum blockchain +- transaction history +- ethplorer +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Display history for given ethereum blockchain balance. e.g. 0x3cD751E6b0078Be393132286c442345e5DC49699 [Source: Ethplorer] + +### Usage + +```python +hist [-l LIMIT] [-s {timestamp,transactionHash,token,value}] [-r] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| limit | display N number records | 10 | True | None | +| sortby | Sort by given column. Default: timestamp | timestamp | True | timestamp, transactionHash, token, value | +| reverse | Data is sorted in descending order by default. Reverse flag will sort it in an ascending way. Only works when raw data is displayed. | False | True | None | + +--- diff --git a/website/content/terminal/reference/crypto/onchain/holders.md b/website/content/terminal/reference/crypto/onchain/holders.md new file mode 100644 index 000000000000..2564a979e65d --- /dev/null +++ b/website/content/terminal/reference/crypto/onchain/holders.md @@ -0,0 +1,37 @@ +--- +title: holders +description: Detailed guide on how to display top ERC20 token holders using python, + with the option of sorting the data in various ways. +keywords: +- ERC20 token holders +- Ethplorer +- parameters +- sortby +- limit +- reverse +- data sorting +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Display top ERC20 token holders: e.g. 0x1f9840a85d5aF5bf1D1762F925BDADdC4201F984 [Source: Ethplorer] + +### Usage + +```python +holders [-l LIMIT] [-s {balance,share}] [-r] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| limit | display N number records | 10 | True | None | +| sortby | Sort by given column. Default: share | share | True | balance, share | +| reverse | Data is sorted in descending order by default. Reverse flag will sort it in an ascending way. Only works when raw data is displayed. | False | True | None | + +--- diff --git a/website/content/terminal/reference/crypto/onchain/hr.md b/website/content/terminal/reference/crypto/onchain/hr.md new file mode 100644 index 000000000000..79e746401997 --- /dev/null +++ b/website/content/terminal/reference/crypto/onchain/hr.md @@ -0,0 +1,42 @@ +--- +title: hr +description: Documentation on the 'hr' function to view the mean hashrate of BTC or + ETH over a specific frequency interval. Contains information on command usage and + the parameters involved. +keywords: +- blockchain +- hashrate +- BTC +- ETH +- coin +- cryptocurrency +- frequency interval +- Glassnode +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Display mean hashrate for a certain blockchain (ETH or BTC) [Source: https://glassnode.org] + +### Usage + +```python +hr [-c {BTC,ETH}] [-i {24h,1w,1month}] [-s SINCE] [-u UNTIL] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| coin | Coin to check hashrate (BTC or ETH) | BTC | True | BTC, ETH | +| interval | Frequency interval. Default: 24h | 24h | True | 24h, 1w, 1month | +| since | Initial date. Default: 2021-11-25 | 2021-11-25 | True | None | +| until | Final date. Default: 2022-11-25 | 2022-11-25 | True | None | + +![hr](https://user-images.githubusercontent.com/46355364/154067420-9fdd9324-c4f2-4bb4-91c1-4c675e4b45d1.png) + +--- diff --git a/website/content/terminal/reference/crypto/onchain/info.md b/website/content/terminal/reference/crypto/onchain/info.md new file mode 100644 index 000000000000..74614661eeb6 --- /dev/null +++ b/website/content/terminal/reference/crypto/onchain/info.md @@ -0,0 +1,34 @@ +--- +title: info +description: This page provides information about ERC20 tokens using Ethplorer as + a source. Learn how to use our tool to display info about ERC20 tokens, including + how to show social media links. +keywords: +- ERC20 token +- Ethplorer +- Token info +- Social media links +- Python usage +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Display info about ERC20 token. e.g. 0x1f9840a85d5aF5bf1D1762F925BDADdC4201F984 [Source: Ethplorer] + +### Usage + +```python +info [--social] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| social | Flag to show social media links | False | True | None | + +--- diff --git a/website/content/terminal/reference/crypto/onchain/lt.md b/website/content/terminal/reference/crypto/onchain/lt.md new file mode 100644 index 000000000000..840f4a86297c --- /dev/null +++ b/website/content/terminal/reference/crypto/onchain/lt.md @@ -0,0 +1,45 @@ +--- +title: lt +description: Description and usage guide for the lt command, that displays trades + on decentralized exchanges including the ability to aggregate trades by DEX or time, + display trade amount in different currencies, and sort data. The command uses Python + language. +keywords: +- Display Trades +- Decentralized Exchanges +- Aggregated +- DEX +- Trade Amount +- Currency +- USD +- ETH +- BTC +- USDT +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Display Trades on Decentralized Exchanges aggregated by DEX or Month [Source: https://graphql.bitquery.io/] + +### Usage + +```python +lt [-k {dex,time}] [-vs {ETH,USD,BTC,USDT}] [-l LIMIT] [-d DAYS] [-s {exchange,trades,tradeAmount}] [-r] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| kind | Aggregate trades by dex or time Default: dex | dex | True | dex, time | +| vs | Currency of displayed trade amount. | USD | True | ETH, USD, BTC, USDT | +| limit | display N number records | 10 | True | None | +| days | Number of days to display data for. | 90 | True | range(1, 360) | +| sortby | Sort by given column. Default: tradeAmount. For monthly trades date. | tradeAmount | True | exchange, trades, tradeAmount | +| reverse | Data is sorted in descending order by default. Reverse flag will sort it in an ascending way. Only works when raw data is displayed. | False | True | None | + +--- diff --git a/website/content/terminal/reference/crypto/onchain/prices.md b/website/content/terminal/reference/crypto/onchain/prices.md new file mode 100644 index 000000000000..a10b8130a46e --- /dev/null +++ b/website/content/terminal/reference/crypto/onchain/prices.md @@ -0,0 +1,44 @@ +--- +title: prices +description: This page provides information about displaying historical token prices. + It includes parameters to sort data by date, cap, volumeConverted, open, high, close, + and low values. The source of data is Ethplorer. +keywords: +- token prices +- historical prices +- Ethplorer +- date +- cap +- volumeConverted +- open +- high +- close +- low +- data sort +- ascending order +- descending order +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +"Display token historical prices. e.g. 0x1f9840a85d5aF5bf1D1762F925BDADdC4201F984 [Source: Ethplorer] + +### Usage + +```python +prices [-l LIMIT] [-s {date,cap,volumeConverted,open,high,close,low}] [-r] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| limit | display N number records | 10 | True | None | +| sortby | Sort by given column. Default: date | date | True | date, cap, volumeConverted, open, high, close, low | +| reverse | Data is sorted in descending order by default. Reverse flag will sort it in an ascending way. Only works when raw data is displayed. | False | True | None | + +--- diff --git a/website/content/terminal/reference/crypto/onchain/th.md b/website/content/terminal/reference/crypto/onchain/th.md new file mode 100644 index 000000000000..85ac44cf49c1 --- /dev/null +++ b/website/content/terminal/reference/crypto/onchain/th.md @@ -0,0 +1,40 @@ +--- +title: th +description: This page provides comprehensive documentation for the 'th' function + which displays information about token history. It explains the usage of the function, + along with descriptions of parameters like limit, sortby, reverse and hash. Useful + for anyone needing to navigate token history using Ethplorer. +keywords: +- token history +- Ethplorer +- command parameters +- sortby +- reverse +- hash +- transaction hash +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Displays info about token history. e.g. 0x1f9840a85d5aF5bf1D1762F925BDADdC4201F984 [Source: Ethplorer] + +### Usage + +```python +th [-l LIMIT] [-s {value}] [-r] [--hash] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| limit | display N number records | 10 | True | None | +| sortby | Sort by given column. Default: value | value | True | value | +| reverse | Data is sorted in descending order by default. Reverse flag will sort it in an ascending way. Only works when raw data is displayed. | False | True | None | +| hash | Flag to show transaction hash | True | True | None | + +--- diff --git a/website/content/terminal/reference/crypto/onchain/top.md b/website/content/terminal/reference/crypto/onchain/top.md new file mode 100644 index 000000000000..3024d2de7d15 --- /dev/null +++ b/website/content/terminal/reference/crypto/onchain/top.md @@ -0,0 +1,71 @@ +--- +title: top +description: This documentation page provides information on how to display the top + ERC20 tokens. It explains command usage, command parameters and provides examples. +keywords: +- ERC20 tokens +- Ethplorer +- Command usage +- Command parameters +- Crypto +- Token price +- Token holders +- Token transfers +- Token transactions +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Display top ERC20 tokens. [Source: Ethplorer] + +### Usage + +```python +top [-l LIMIT] [-s {rank,name,symbol,price,txsCount,transfersCount,holdersCount}] [-r] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| limit | display N number records | 10 | True | None | +| sortby | Sort by given column. Default: rank | rank | True | rank, name, symbol, price, txsCount, transfersCount, holdersCount | +| reverse | Data is sorted in descending order by default. Reverse flag will sort it in an ascending way. Only works when raw data is displayed. | False | True | None | + + +--- + +## Examples + +```python +2022 Feb 15, 08:04 (🦋) /crypto/onchain/ $ top + Top ERC20 Tokens +┌──────┬───────────────┬────────┬─────────┬──────────┬────────────────┬──────────────┬────────────────┬───────────────┐ +│ rank │ name │ symbol │ price │ txsCount │ transfersCount │ holdersCount │ twitter │ coingecko │ +├──────┼───────────────┼────────┼─────────┼──────────┼────────────────┼──────────────┼────────────────┼───────────────┤ +│ 1 │ WETH │ WETH │ 3099.54 │ 6M │ 90M │ 440.2K │ │ weth │ +├──────┼───────────────┼────────┼─────────┼──────────┼────────────────┼──────────────┼────────────────┼───────────────┤ +│ 2 │ Tether USD │ USDT │ 1.00 │ 125.5M │ 138.8M │ 4.4M │ Tether_to │ tether │ +├──────┼───────────────┼────────┼─────────┼──────────┼────────────────┼──────────────┼────────────────┼───────────────┤ +│ 3 │ USD Coin │ USDC │ 1.00 │ 19M │ 34.8M │ 1.4M │ │ usd-coin │ +├──────┼───────────────┼────────┼─────────┼──────────┼────────────────┼──────────────┼────────────────┼───────────────┤ +│ 4 │ Strong │ STRONG │ 393.38 │ 464.9K │ 4.7M │ 31.5K │ Strongblock_io │ strong │ +├──────┼───────────────┼────────┼─────────┼──────────┼────────────────┼──────────────┼────────────────┼───────────────┤ +│ 5 │ LooksRare │ LOOKS │ 2.14 │ 263.9K │ 1.2M │ 19.6K │ LooksRareNFT │ looksrare │ +├──────┼───────────────┼────────┼─────────┼──────────┼────────────────┼──────────────┼────────────────┼───────────────┤ +│ 6 │ Dai │ DAI │ 1.00 │ 4.1M │ 13.1M │ 453.7K │ MakerDAO │ dai │ +├──────┼───────────────┼────────┼─────────┼──────────┼────────────────┼──────────────┼────────────────┼───────────────┤ +│ 7 │ Shiba Inu │ SHIB │ 0.00 │ 4.6M │ 6.8M │ 1.2M │ Shibtoken │ shiba-inu │ +├──────┼───────────────┼────────┼─────────┼──────────┼────────────────┼──────────────┼────────────────┼───────────────┤ +│ 8 │ Matic Network │ MATIC │ 1.79 │ 2.8M │ 3.5M │ 367.6K │ maticnetwork │ matic-network │ +├──────┼───────────────┼────────┼─────────┼──────────┼────────────────┼──────────────┼────────────────┼───────────────┤ +│ 9 │ Chainlink │ LINK │ 16.81 │ 5.5M │ 10.9M │ 651.2K │ chainlink │ chainlink │ +├──────┼───────────────┼────────┼─────────┼──────────┼────────────────┼──────────────┼────────────────┼───────────────┤ +│ 10 │ Gala │ GALA │ 0.34 │ 678.5K │ 869.8K │ 105.5K │ GoGalaGames │ gala │ +└──────┴───────────────┴────────┴─────────┴──────────┴────────────────┴──────────────┴────────────────┴───────────────┘ +``` +--- diff --git a/website/content/terminal/reference/crypto/onchain/ttcp.md b/website/content/terminal/reference/crypto/onchain/ttcp.md new file mode 100644 index 000000000000..9150a5126c42 --- /dev/null +++ b/website/content/terminal/reference/crypto/onchain/ttcp.md @@ -0,0 +1,43 @@ +--- +title: ttcp +description: This documentation page provides details on the usage of the ttcp tool + used for displaying the most traded crypto pairs on a chosen decentralized exchange + over a selected time period. It includes the description and options for each parameter. +keywords: +- ttcp +- traded crypto pairs +- decentralized exchange +- crypto trading +- trading +- blockchain +- 1inch +- Uniswap +- trade parameters +- tradeAmount +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Display most traded crypto pairs on given decentralized exchange in chosen time period. [Source: https://graphql.bitquery.io/] + +### Usage + +```python +ttcp [-l LIMIT] [-e {1inch,AfroDex,AirSwap,Amplbitcratic,Balancer,BestSwap,Bitox,CellSwap,Cellswap,Cofix,Coinchangex,Curve,DDEX,DUBIex,DecentrEx,DeversiFi,Dodo,ETHERCExchange,EtherBlockchain,EtherDelta,Ethernext,Ethfinex,FEGex,FFFSwap,Fordex,GUDecks,GUDeks,HiSwap,IDEX,LedgerDex,Matcha,Miniswap,Mooniswap,Oasis,OpenRelay,S.Finance,SakeSwap,SeedDex,SingularX,StarBitEx,SushiSwap,SwapX,SwitchDex,TacoSwap,TokenJar,TokenStore,TokenTrove,Tokenlon,TradexOne,Uniswap,ZeusSwap,dYdX,dex.blue}] [-d DAYS] [-s {base,quoted,trades,tradeAmount}] [-r] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| limit | display N number records | 10 | True | None | +| exchange | Decentralized exchange name. | None | True | 1inch, AfroDex, AirSwap, Amplbitcratic, Balancer, BestSwap, Bitox, CellSwap, Cellswap, Cofix, Coinchangex, Curve, DDEX, DUBIex, DecentrEx, DeversiFi, Dodo, ETHERCExchange, EtherBlockchain, EtherDelta, Ethernext, Ethfinex, FEGex, FFFSwap, Fordex, GUDecks, GUDeks, HiSwap, IDEX, LedgerDex, Matcha, Miniswap, Mooniswap, Oasis, OpenRelay, S.Finance, SakeSwap, SeedDex, SingularX, StarBitEx, SushiSwap, SwapX, SwitchDex, TacoSwap, TokenJar, TokenStore, TokenTrove, Tokenlon, TradexOne, Uniswap, ZeusSwap, dYdX, dex.blue | +| days | Number of days to display data for. | 30 | True | range(1, 100) | +| sortby | Sort by given column. | tradeAmount | True | base, quoted, trades, tradeAmount | +| reverse | Data is sorted in descending order by default. Reverse flag will sort it in an ascending way. Only works when raw data is displayed. | False | True | None | + +--- diff --git a/website/content/terminal/reference/crypto/onchain/tv.md b/website/content/terminal/reference/crypto/onchain/tv.md new file mode 100644 index 000000000000..ca087f9d3468 --- /dev/null +++ b/website/content/terminal/reference/crypto/onchain/tv.md @@ -0,0 +1,39 @@ +--- +title: tv +description: This section of the page is a guide on using the function to display + token volume on different Decentralized Exchanges. It includes parameters such as + the currency of the displayed trade amount and options to sort data. +keywords: +- decentralized exchanges +- token volume +- ERC20 token +- trade amount +- sort by column +- data sorting +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Display token volume on different Decentralized Exchanges. [Source: https://graphql.bitquery.io/] + +### Usage + +```python +tv -c COIN [-vs {ETH,USD,BTC,USDT}] [-l LIMIT] [-s {exchange,trades,tradeAmount}] [-r] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| coin | ERC20 token symbol or address. | None | False | None | +| vs | Currency of displayed trade amount. | USD | True | ETH, USD, BTC, USDT | +| limit | display N number records | 10 | True | None | +| sortby | Sort by given column. | trades | True | exchange, trades, tradeAmount | +| reverse | Data is sorted in descending order by default. Reverse flag will sort it in an ascending way. Only works when raw data is displayed. | False | True | None | + +--- diff --git a/website/content/terminal/reference/crypto/onchain/tvl.md b/website/content/terminal/reference/crypto/onchain/tvl.md new file mode 100644 index 000000000000..27f8603b6da7 --- /dev/null +++ b/website/content/terminal/reference/crypto/onchain/tvl.md @@ -0,0 +1,41 @@ +--- +title: tvl +description: This page discusses the Total Value Locked (TVL) metric, a key concept + in cryptocurrency. Learn how to utilize this metric through different parameters + and understand its significance in evaluating Ethereum ERC20 contract balances. +keywords: +- Total Value Locked +- TVL +- Cryptocurrency +- Ethereum ERC20 +- Contract balance +- User address +- Address name +- Contract symbol +- Interval +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Total value locked (TVL) metric - Ethereum ERC20 [Source:https://docs.flipsidecrypto.com/] useraddress OR addressname must be provided + +### Usage + +```python +tvl [-u USERADDRESS] [-a ADDRESSNAME] [-s SYMBOL] [-i INTERVAL] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| useraddress | User address we'd like to take a balance reading of against the contract | None | True | None | +| addressname | Address name corresponding to the user address | None | True | None | +| symbol | Contract symbol | USDC | True | None | +| interval | Interval in months | 12 | True | None | + +--- diff --git a/website/content/terminal/reference/crypto/onchain/tx.md b/website/content/terminal/reference/crypto/onchain/tx.md new file mode 100644 index 000000000000..f78ab9b0442d --- /dev/null +++ b/website/content/terminal/reference/crypto/onchain/tx.md @@ -0,0 +1,36 @@ +--- +title: tx +description: The page provides a detailed guide on displaying information about ERC20 + token transactions on the Ethereum blockchain using tx command. +keywords: +- ERC20 token +- Ethereum blockchain +- tx command +- Ethplorer +- blockchain transactions +- cryptocurrency +- blockchain technology +- command usage +- token transaction +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Display info ERC20 token transaction on ethereum blockchain. e.g. 0x9dc7b43ad4288c624fdd236b2ecb9f2b81c93e706b2ffd1d19b112c1df7849e6 [Source: Ethplorer] + +### Usage + +```python +tx +``` + +--- + +## Parameters + +This command has no parameters + + +--- diff --git a/website/content/terminal/reference/crypto/onchain/ueat.md b/website/content/terminal/reference/crypto/onchain/ueat.md new file mode 100644 index 000000000000..b5b3e19279bf --- /dev/null +++ b/website/content/terminal/reference/crypto/onchain/ueat.md @@ -0,0 +1,46 @@ +--- +title: ueat +description: The ueat page provides a means to display the number of unique ethereum + addresses which made a transaction in a given time interval. It provides options + to limit or sort data and to set time intervals. Statistics such as average, medium, + and maximum gas prices are available and data can be displayed in reverse or sorted + order. +keywords: +- ueat +- ethereum +- transaction +- time interval +- unique addresses +- bitquery +- sort +- average gas price +- medium gas price +- maximum gas price +- raw data +- reverse flag +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Display number of unique ethereum addresses which made a transaction in given time interval, [Source: https://graphql.bitquery.io/] + +### Usage + +```python +ueat [-l LIMIT] [-s {date,uniqueSenders,transactions,averageGasPrice,mediumGasPrice,maximumGasPrice}] [-i {day,month,week}] [-r] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| limit | display N number records. (Maximum available time period is 90 days.Depending on chosen time period, display N records will be recalculated. E.g.For interval: month, and number: 10, period of calculation equals to 300, but because of max days limit: 90, it will only return last 3 months (3 records). | 10 | True | range(1, 90) | +| sortby | Sort by given column. | date | True | date, uniqueSenders, transactions, averageGasPrice, mediumGasPrice, maximumGasPrice | +| interval | Time interval in which ethereum address made transaction. month, week or day. Maximum time period is 90 days (3 months, 14 weeks) | day | True | day, month, week | +| reverse | Data is sorted in descending order by default. Reverse flag will sort it in an ascending way. Only works when raw data is displayed. | False | True | None | + +--- diff --git a/website/content/terminal/reference/crypto/onchain/whales.md b/website/content/terminal/reference/crypto/onchain/whales.md new file mode 100644 index 000000000000..16e373322eb4 --- /dev/null +++ b/website/content/terminal/reference/crypto/onchain/whales.md @@ -0,0 +1,43 @@ +--- +title: whales +description: A page that provides information on the use of the 'whales' feature to + display significant cryptocurrency transactions. It explains parameters for customization + like minimum value, record limit, sort order, etc. +keywords: +- Crypto whales transactions +- Cryptocurrency +- Docusaurus +- Crypto transaction tracking +- Crypto address details +- Sort crypto transactions +- Crypto trade parameters +- Display major crypto transactions +- Sort by date, amount, blockchain +- Limit number of crypto records +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Display crypto whales transactions. [Source: https://docs.whale-alert.io/] + +### Usage + +```python +whales [-m MIN] [-l LIMIT] [-s {date,symbol,blockchain,amount,amount_usd,from,to}] [-r] [-a] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| min | Minimum value of transactions. | 1000000 | True | None | +| limit | display N number records | 10 | True | None | +| sortby | Sort by given column. Default: date | date | True | date, symbol, blockchain, amount, amount_usd, from, to | +| reverse | Data is sorted in descending order by default. Reverse flag will sort it in an ascending way. Only works when raw data is displayed. | False | True | None | +| address | Flag to show addresses of transaction | False | True | None | + +--- diff --git a/website/versioned_docs/version-v3/terminal/reference/crypto/ov/_category_.json b/website/content/terminal/reference/crypto/ov/_category_.json similarity index 100% rename from website/versioned_docs/version-v3/terminal/reference/crypto/ov/_category_.json rename to website/content/terminal/reference/crypto/ov/_category_.json diff --git a/website/content/terminal/reference/crypto/ov/altindex.md b/website/content/terminal/reference/crypto/ov/altindex.md new file mode 100644 index 000000000000..7aa95f498a6e --- /dev/null +++ b/website/content/terminal/reference/crypto/ov/altindex.md @@ -0,0 +1,43 @@ +--- +title: altindex +description: The altindex documentation page provides information on how to display + altcoin index over time, compare altcoins performance to Bitcoin, and interpret + if it's an Altcoin Season. +keywords: +- altindex +- altcoin index +- Bitcoin +- Altcoin Season +- stablecoins +- asset backed tokens +- cryptocurrency +- blockchain +- crypto tools +- crypto comparison +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Display altcoin index overtime. If 75% of the Top 50 coins performed better than Bitcoin over periods of time (30, 90 or 365 days) it is Altcoin Season. Excluded from the Top 50 are Stablecoins (Tether, DAI…) and asset backed tokens (WBTC, stETH, cLINK,…) [Source: https://blockchaincenter.net] + +### Usage + +```python +altindex [-p {30,90,365}] [-s SINCE] [-u UNTIL] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| period | Period of time to check if how altcoins have performed against btc (30, 90, 365) | 365 | True | 30, 90, 365 | +| since | Start date (default: 1 year before, e.g., 2021-01-01) | 2021-11-25 | True | None | +| until | Final date. Default is current date | 2022-11-25 | True | None | + +![altindex](https://user-images.githubusercontent.com/46355364/154068454-43dbc146-31df-4b25-bf14-0b12284afc6d.png) + +--- diff --git a/website/content/terminal/reference/crypto/ov/btcrb.md b/website/content/terminal/reference/crypto/ov/btcrb.md new file mode 100644 index 000000000000..0dbb9e714733 --- /dev/null +++ b/website/content/terminal/reference/crypto/ov/btcrb.md @@ -0,0 +1,41 @@ +--- +title: btcrb +description: btcrb is a Python-based tool offering visualization of Bitcoin Rainbow + chart over time which includes halvings. Its primary data source is Glassnode and + it's inspired by Blockchaincenter.net. +keywords: +- btcrb +- bitcoin +- rainbow chart +- glassnode +- blockchaincenter.net +- BTC +- cryptocurrency +- halvings +- price data +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Display bitcoin rainbow chart overtime including halvings. [Price data from source: https://glassnode.com] [Inspired by: https://blockchaincenter.net] + +### Usage + +```python +btcrb [-s SINCE] [-u UNTIL] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| since | Initial date. Default is initial BTC date: 2010-01-01 | 2010-01-01 | True | None | +| until | Final date. Default is current date | 2022-11-25 | True | None | + +![btcrb](https://user-images.githubusercontent.com/46355364/154068553-f40e8a63-dd69-4508-a0f1-d91cfd5e6e9b.png) + +--- diff --git a/website/content/terminal/reference/crypto/ov/categories.md b/website/content/terminal/reference/crypto/ov/categories.md new file mode 100644 index 000000000000..3468fec217da --- /dev/null +++ b/website/content/terminal/reference/crypto/ov/categories.md @@ -0,0 +1,98 @@ +--- +title: categories +description: Docusaurus page that provides details on top cryptocurrency categories + by market capitalization. It includes categories such as stablecoins, defi, solana + ecosystem, and polkadot ecosystem, among others. This page also provides ways to + sort and display data. +keywords: +- cryptocurrency categories +- market capitalization +- stablecoins +- defi +- solana ecosystem +- polkadot ecosystem +- sort parameter +- pie chart +- smart contract platform +- binance smart chain +- polygon ecosystem +- avalanche ecosystem +- moonriver ecosystem +- fantom ecosystem +- stablecoins +- arbitrum ecosystem +- near protocol ecosystem +- exchange-based tokens +- decentralized finance +- centralized exchange token +- gnosis chain ecosystem +- cosmos ecosystem +- market cap change 24h +- top 3 coins +- volume 24h +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Shows top cryptocurrency categories by market capitalization. It includes categories like: stablecoins, defi, solana ecosystem, polkadot ecosystem and many others. You can sort by {}, using --sortby parameter + +### Usage + +```python +categories [-l LIMIT] [-s {Name,Market_Cap,Market_Cap_Change_24H,Top_3_Coins,Volume_24H}] [--pie] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| limit | display N number of records | 15 | True | None | +| sortby | Sort by given column. Default: market_cap_desc | Market_Cap | True | Name, Market_Cap, Market_Cap_Change_24H, Top_3_Coins, Volume_24H | +| pie | Flag to show pie chart | False | True | None | + + +--- + +## Examples + +```python +2022 Feb 15, 08:10 (🦋) /crypto/ov/ $ categories +┌──────────────────────────────────┬────────────┬───────────────────────┬───────────────────────────────────────────────────────┬────────────┐ +│ Name │ Market Cap │ Market Cap Change 24H │ Top 3 Coins │ Volume 24H │ +├──────────────────────────────────┼────────────┼───────────────────────┼───────────────────────────────────────────────────────┼────────────┤ +│ Smart Contract Platform │ 678.047 B │ 8.095 │ ethereum,binance-coin-logo,cardano │ 27.408 B │ +├──────────────────────────────────┼────────────┼───────────────────────┼───────────────────────────────────────────────────────┼────────────┤ +│ Binance Smart Chain Ecosystem │ 339.679 B │ 3.876 │ Tether-logo,binance-coin-logo,USD_Coin_icon │ 58.906 B │ +├──────────────────────────────────┼────────────┼───────────────────────┼───────────────────────────────────────────────────────┼────────────┤ +│ Polygon Ecosystem │ 311.497 B │ 3.644 │ Tether-logo,binance-coin-logo,USD_Coin_icon │ 58.872 B │ +├──────────────────────────────────┼────────────┼───────────────────────┼───────────────────────────────────────────────────────┼────────────┤ +│ Avalanche Ecosystem │ 299.726 B │ 3.620 │ Tether-logo,binance-coin-logo,USD_Coin_icon │ 53.420 B │ +├──────────────────────────────────┼────────────┼───────────────────────┼───────────────────────────────────────────────────────┼────────────┤ +│ Moonriver Ecosystem │ 288.048 B │ 3.709 │ Tether-logo,binance-coin-logo,USD_Coin_icon │ 55.035 B │ +├──────────────────────────────────┼────────────┼───────────────────────┼───────────────────────────────────────────────────────┼────────────┤ +│ Fantom Ecosystem │ 215.497 B │ 1.760 │ Tether-logo,USD_Coin_icon,luna1557227471663 │ 53.904 B │ +├──────────────────────────────────┼────────────┼───────────────────────┼───────────────────────────────────────────────────────┼────────────┤ +│ Stablecoins │ 182.561 B │ -0.108 │ Tether-logo,USD_Coin_icon,BUSD │ 50.694 B │ +├──────────────────────────────────┼────────────┼───────────────────────┼───────────────────────────────────────────────────────┼────────────┤ +│ Arbitrum Ecosystem │ 180.827 B │ 1.536 │ Tether-logo,USD_Coin_icon,wrapped_bitcoin_wbtc │ 49.169 B │ +├──────────────────────────────────┼────────────┼───────────────────────┼───────────────────────────────────────────────────────┼────────────┤ +│ Near Protocol Ecosystem │ 173.873 B │ 1.585 │ Tether-logo,USD_Coin_icon,4943 │ 49.034 B │ +├──────────────────────────────────┼────────────┼───────────────────────┼───────────────────────────────────────────────────────┼────────────┤ +│ Exchange-based Tokens │ 129.556 B │ 7.082 │ binance-coin-logo,cypto,F │ 6.532 B │ +├──────────────────────────────────┼────────────┼───────────────────────┼───────────────────────────────────────────────────────┼────────────┤ +│ Decentralized Finance (DeFi) │ 115.516 B │ 6.310 │ luna1557227471663,4943,chainlink-new-logo │ 5.141 B │ +├──────────────────────────────────┼────────────┼───────────────────────┼───────────────────────────────────────────────────────┼────────────┤ +│ Centralized Exchange Token (CEX) │ 109.267 B │ 6.734 │ binance-coin-logo,cypto,F │ 2.138 B │ +├──────────────────────────────────┼────────────┼───────────────────────┼───────────────────────────────────────────────────────┼────────────┤ +│ Gnosis Chain Ecosystem │ 86.569 B │ 3.015 │ USD_Coin_icon,wrapped_bitcoin_wbtc,chainlink-new-logo │ 5.255 B │ +├──────────────────────────────────┼────────────┼───────────────────────┼───────────────────────────────────────────────────────┼────────────┤ +│ Cosmos Ecosystem │ 56.514 B │ 7.509 │ luna1557227471663,cypto,cosmos_hub │ 2.653 B │ +├──────────────────────────────────┼────────────┼───────────────────────┼───────────────────────────────────────────────────────┼────────────┤ +│ Solana Ecosystem │ 51.051 B │ 8.194 │ solana,chainlink-new-logo,Graph_Token │ 2.925 B │ +└──────────────────────────────────┴────────────┴───────────────────────┴───────────────────────────────────────────────────────┴────────────┘ +``` +--- diff --git a/website/versioned_docs/version-v3/terminal/reference/crypto/ov/ch.md b/website/content/terminal/reference/crypto/ov/ch.md similarity index 95% rename from website/versioned_docs/version-v3/terminal/reference/crypto/ov/ch.md rename to website/content/terminal/reference/crypto/ov/ch.md index 75f5305ab7fe..5c6b17fa26b4 100644 --- a/website/versioned_docs/version-v3/terminal/reference/crypto/ov/ch.md +++ b/website/content/terminal/reference/crypto/ov/ch.md @@ -1,9 +1,26 @@ --- title: ch -description: OpenBB Terminal Function +description: This documentation outlines the usage of the 'ch' command to display + a list of major crypto-related hacks. It details the different parameters available + to sort and display the data. Included are specific examples, and the expected output. +keywords: +- crypto-related hacks +- crypto hack +- hack display +- sort by parameters +- crypto platform +- hack amount +- hack date +- hack audit +- hack slug +- hack URL +- reverse display order +- individual crypto hack --- -# ch +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + Display list of major crypto-related hacks [Source: https://rekt.news] Can be sorted by {Platform,Date,Amount [$],Audit,Slug,URL} with --sortby and reverse the display order with --reverse Show only N elements with --limit Accepts --slug or -s to check individual crypto hack (e.g., -s polynetwork-rekt) diff --git a/website/content/terminal/reference/crypto/ov/contracts.md b/website/content/terminal/reference/crypto/ov/contracts.md new file mode 100644 index 000000000000..9e1963208bfc --- /dev/null +++ b/website/content/terminal/reference/crypto/ov/contracts.md @@ -0,0 +1,84 @@ +--- +title: contracts +description: This page details how to effectively fetch all contract addresses for + a specific blockchain platform with customizable parameters for limitations and + sorting. Various platforms such as Ethereum and Bitcoin are discussed, along with + illustration on detailed sets of commands. +keywords: +- contracts +- blockchain platform +- smart contracts +- ethereum +- bitcoin +- parameters +- sort data +- display +- crypto +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Gets all contract addresses for given platform. Provide platform id with -p/--platform parameter You can display only N number of smart contracts with --limit parameter. You can sort data by id, type, active, balance --sortby parameter and also with --reverse flag to sort descending. Displays: id, type, active, balance + +### Usage + +```python +contracts [-p {btc-bitcoin,eos-eos,eth-ethereum,xrp-xrp,bch-bitcoin-cash,xem-nem,neo-neo,xlm-stellar,etc-ethereum-classic,qtum-qtum,zec-zcash,vet-vechain,bts-bitshares,waves-waves,nxt-nxt,act-achain,ubq-ubiq,xcp-counterparty,ppc-peercoin,etp-metaverse-etp,signa-signa,omni-omni,trx-tron,bnb-binance-coin,ardr-ardor,ht-huobi-token,wan-wanchain,ftm-fantom,matic-polygon,afcash-africunia-bank,avax-avalanche,sol-solana,blvr-believer,cake-pancakeswap,bcna-bitcanna831,fsxu-flashx-ultra,chik-chickenkebab-finance,jgn-juggernaut7492,crx-cryptex,whirl-whirl-finance,etl-etherlite,eubi-eubi-token,swam-swapmatic-token,shells-shells,levelg-levelg,lyr-lyra,ants-fireants,berry-berry,drc-deracoin,sxcc-southxchange-coin,vega-vega-coin,xgk-goldkash,ptd-peseta-digital,mmt-moments-market,gems-algogems,kilt-kilt-protocol,harl-harmonylauncher,alph-alephium,ride-holoride,fcon-spacefalcon,love-diamond-love,kint-kintsugi,astr-astar,chum-chum-coin,polyx-polymesh,kfl-kaafila,evmos-evmos,wtip-worktips9618,xeta-xana,arn-arenum,fayre-fayre,mart-artmeta,azit-azit,fcd-freshcut-diamond,pbt-property-blockchain-trade,fww-farmers-world-wood,cand-canary-dollar,srs-sirius-finance,xden-xiden,arz-arize,hash-provenance-blockchain,joy-drawshop-kingdom-reverse-joystick,orbc-orbis,b3x-bnext-b3x,xmp-maptcoin,gomt-gomeat,pro-proton-coin,slrr-solarr,xgbl-xungible,utg-ultronglow,oxp-onxrp,algx-algodex,bridge-octus-bridge,cvshot-cvshots,xspectar-xspectar,blkz-blocksworkz,sva-solvia,bdlt-bdlt,ogy-origyn-foundation,digau-dignity-gold,trx3l-trx3l,eth3s-eth3s,intr-interlay,crom-crome,tutl-tutela,cc-cloudcoin,ztg-zeitgeist,film-filmcredits,znt-zenith-finance,bnd-bened,mddn-modden234234234,wei-wei,dcrn-decred-next,omc-omchain,turn-big-turn,cmp-caduceus,pmg-pmg-coin,xx-xx-network,neer-metaversenetwork-pioneer,tao-fusotao,cic-crazy-internet-coin,bsx-basilisk,cuc-cuprum-coin,ulx-ultron,fury-fanfury,vxxl-vxxl,spex-stepex,log-logos,metal-metal-blockchain,nai-natiol,ling-lingose}] [-l LIMIT] [-s {id,type,active}] [-r] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| platform | Blockchain platform like eth-ethereum | eth-ethereum | True | btc-bitcoin, eos-eos, eth-ethereum, xrp-xrp, bch-bitcoin-cash, xem-nem, neo-neo, xlm-stellar, etc-ethereum-classic, qtum-qtum, zec-zcash, vet-vechain, bts-bitshares, waves-waves, nxt-nxt, act-achain, ubq-ubiq, xcp-counterparty, ppc-peercoin, etp-metaverse-etp, signa-signa, omni-omni, trx-tron, bnb-binance-coin, ardr-ardor, ht-huobi-token, wan-wanchain, ftm-fantom, matic-polygon, afcash-africunia-bank, avax-avalanche, sol-solana, blvr-believer, cake-pancakeswap, bcna-bitcanna831, fsxu-flashx-ultra, chik-chickenkebab-finance, jgn-juggernaut7492, crx-cryptex, whirl-whirl-finance, etl-etherlite, eubi-eubi-token, swam-swapmatic-token, shells-shells, levelg-levelg, lyr-lyra, ants-fireants, berry-berry, drc-deracoin, sxcc-southxchange-coin, vega-vega-coin, xgk-goldkash, ptd-peseta-digital, mmt-moments-market, gems-algogems, kilt-kilt-protocol, harl-harmonylauncher, alph-alephium, ride-holoride, fcon-spacefalcon, love-diamond-love, kint-kintsugi, astr-astar, chum-chum-coin, polyx-polymesh, kfl-kaafila, evmos-evmos, wtip-worktips9618, xeta-xana, arn-arenum, fayre-fayre, mart-artmeta, azit-azit, fcd-freshcut-diamond, pbt-property-blockchain-trade, fww-farmers-world-wood, cand-canary-dollar, srs-sirius-finance, xden-xiden, arz-arize, hash-provenance-blockchain, joy-drawshop-kingdom-reverse-joystick, orbc-orbis, b3x-bnext-b3x, xmp-maptcoin, gomt-gomeat, pro-proton-coin, slrr-solarr, xgbl-xungible, utg-ultronglow, oxp-onxrp, algx-algodex, bridge-octus-bridge, cvshot-cvshots, xspectar-xspectar, blkz-blocksworkz, sva-solvia, bdlt-bdlt, ogy-origyn-foundation, digau-dignity-gold, trx3l-trx3l, eth3s-eth3s, intr-interlay, crom-crome, tutl-tutela, cc-cloudcoin, ztg-zeitgeist, film-filmcredits, znt-zenith-finance, bnd-bened, mddn-modden234234234, wei-wei, dcrn-decred-next, omc-omchain, turn-big-turn, cmp-caduceus, pmg-pmg-coin, xx-xx-network, neer-metaversenetwork-pioneer, tao-fusotao, cic-crazy-internet-coin, bsx-basilisk, cuc-cuprum-coin, ulx-ultron, fury-fanfury, vxxl-vxxl, spex-stepex, log-logos, metal-metal-blockchain, nai-natiol, ling-lingose | +| limit | display N number records | 15 | True | None | +| sortby | Sort by given column | id | True | id, type, active | +| reverse | Data is sorted in ascending order by default. Reverse flag will sort it in an descending way. Only works when raw data is displayed. | False | True | None | + + +--- + +## Examples + +```python +2022 Feb 15, 08:16 (🦋) /crypto/ov/ $ contracts + Contract Addresses +┌────────────────────────────────────────────────────┬───────┬────────┐ +│ id │ type │ active │ +├────────────────────────────────────────────────────┼───────┼────────┤ +│ - │ ERC20 │ True │ +├────────────────────────────────────────────────────┼───────┼────────┤ +│ -dogeinu │ ERC20 │ True │ +├────────────────────────────────────────────────────┼───────┼────────┤ +│ -exotix │ ERC20 │ True │ +├────────────────────────────────────────────────────┼───────┼────────┤ +│ -onlychads │ ERC20 │ True │ +├────────────────────────────────────────────────────┼───────┼────────┤ +│ -pcore │ ERC20 │ True │ +├────────────────────────────────────────────────────┼───────┼────────┤ +│ -the-ether-collection │ ERC20 │ True │ +├────────────────────────────────────────────────────┼───────┼────────┤ +│ 0175-geely-automobile │ ERC20 │ True │ +├────────────────────────────────────────────────────┼───────┼────────┤ +│ 0241-alibaba-health-information-technology-limited │ ERC20 │ True │ +├────────────────────────────────────────────────────┼───────┼────────┤ +│ 0347-angang-steel │ ERC20 │ True │ +├────────────────────────────────────────────────────┼───────┼────────┤ +│ 0358-jiangxi-copper │ ERC20 │ True │ +├────────────────────────────────────────────────────┼───────┼────────┤ +│ 0522-asm-pacific-technology-limited │ ERC20 │ True │ +├────────────────────────────────────────────────────┼───────┼────────┤ +│ 0728-china-telecom │ ERC20 │ True │ +├────────────────────────────────────────────────────┼───────┼────────┤ +│ 0753-air-china │ ERC20 │ True │ +├────────────────────────────────────────────────────┼───────┼────────┤ +│ 0857-petrochina │ ERC20 │ True │ +├────────────────────────────────────────────────────┼───────┼────────┤ +│ 0916-china-longyuan-power │ ERC20 │ True │ +└────────────────────────────────────────────────────┴───────┴────────┘ +``` +--- diff --git a/website/content/terminal/reference/crypto/ov/cr.md b/website/content/terminal/reference/crypto/ov/cr.md new file mode 100644 index 000000000000..f4c6e6576a92 --- /dev/null +++ b/website/content/terminal/reference/crypto/ov/cr.md @@ -0,0 +1,40 @@ +--- +title: cr +description: A content focused on the 'cr' command line tool usage and its parameters, + which provides crypto interest rates from numerous platforms, for various cryptocurrencies. + Core parameters include selection of interest rate type, specific cryptocurrencies, + and platforms. +keywords: +- cryptocurrency +- crypto interest rates +- cryptocurrency platforms +- borrow interest rate +- supply interest rate +- crypto supply and borrow rates +- cr command line +- cryptocurrency parameters +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Displays crypto {borrow,supply} interest rates for cryptocurrencies across several platforms. You can select rate type with --type {borrow,supply} You can display only N number of platforms with --limit parameter. + +### Usage + +```python +cr [-t {borrow,supply}] [-c CRYPTOS] [-p PLATFORMS] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| type | Select interest rate type | supply | True | borrow, supply | +| cryptos | Cryptocurrencies to search interest rates for separated by comma. Default: BTC,ETH,USDT,USDC. Options: ZRX,BAT,REP,ETH,SAI,BTC,XRP,LTC,EOS,BCH,XMR,DOGE,USDC,USDT,BSV,NEO,ETC,OMG,ZEC,BTG,SAN,DAI,UNI,WBTC,COMP,LUNA,UST,BUSD,KNC,LEND,LINK,MANA,MKR,SNX,SUSD,TUSD,eCRV-DAO,HEGIC,YFI,1INCH,CRV-IB,CRV-HBTC,BOOST,CRV-sBTC,CRV-renBTC,CRV-sAave,CRV-oBTC,CRV-pBTC,CRV-LUSD,CRV-BBTC,CRV-tBTC,CRV-FRAX,CRV-yBUSD,CRV-COMP,CRV-GUSD,yUSD,CRV-3pool,CRV-TUSD,CRV-BUSD,CRV-DUSD,CRV-UST,CRV-mUSD,sUSD,CRV-sUSD,CRV-LINK,CRV-USDN,CRV-USDP,CRV-alUSD,CRV-Aave,CRV-HUSD,CRV-EURS,RAI,CRV-triCrypto,CRV-Pax,CRV-USDT,CRV-USDK,CRV-RSV,CRV-3Crypto,GUSD,PAX,USD,ILK,BNB,PAXG,ADA,FTT,SOL,SRM,RAY,XLM,SUSHI,CRV,BAL,AAVE,MATIC,GRT,ENJ,USDP,IOST,AMP,PERP,SHIB,ALICE,ALPHA,ANKR,ATA,AVA,AXS,BAKE,BAND,BNT,BTCST,CELR,CFX,CHR,COS,COTI,CTSI,DUSK,EGLD,ELF,FET,FLOW,FTM,INJ,IOTX,MDX,NEAR,OCEAN,ONT,POLS,REEF,WRX,XEC,XTZ,XVS,ZIL,DOT,FIL,TRX,CAKE,ADX,FIRO,SXP,ATOM,IOTA,AKRO,AUDIO,BADGER,CVC,DENT,DYDX,FORTH,GNO,HOT,LPT,LRC,NKN,NMR,NU,OGN,OXT,POLY,QNT,RLC,RSR,SAND,SKL,STMX,STORJ,TRB,UMA,DPI,VSP,CHSB,EURT,GHST,3CRV,CRVRENWBTC,MIR-UST UNI LP,ALCX,ALUSD,USDP3CRV,RENBTC,YVECRV,CVX,USDTTRC20,AUD,HKD,GBP,EUR,HUSD,HT,DASH,EURS,AVAX,BTT,GALA,ILV,APE | BTC,ETH,USDT,USDC | True | ZRX, BAT, REP, ETH, SAI, BTC, XRP, LTC, EOS, BCH, XMR, DOGE, USDC, USDT, BSV, NEO, ETC, OMG, ZEC, BTG, SAN, DAI, UNI, WBTC, COMP, LUNA, UST, BUSD, KNC, LEND, LINK, MANA, MKR, SNX, SUSD, TUSD, eCRV-DAO, HEGIC, YFI, 1INCH, CRV-IB, CRV-HBTC, BOOST, CRV-sBTC, CRV-renBTC, CRV-sAave, CRV-oBTC, CRV-pBTC, CRV-LUSD, CRV-BBTC, CRV-tBTC, CRV-FRAX, CRV-yBUSD, CRV-COMP, CRV-GUSD, yUSD, CRV-3pool, CRV-TUSD, CRV-BUSD, CRV-DUSD, CRV-UST, CRV-mUSD, sUSD, CRV-sUSD, CRV-LINK, CRV-USDN, CRV-USDP, CRV-alUSD, CRV-Aave, CRV-HUSD, CRV-EURS, RAI, CRV-triCrypto, CRV-Pax, CRV-USDT, CRV-USDK, CRV-RSV, CRV-3Crypto, GUSD, PAX, USD, ILK, BNB, PAXG, ADA, FTT, SOL, SRM, RAY, XLM, SUSHI, CRV, BAL, AAVE, MATIC, GRT, ENJ, USDP, IOST, AMP, PERP, SHIB, ALICE, ALPHA, ANKR, ATA, AVA, AXS, BAKE, BAND, BNT, BTCST, CELR, CFX, CHR, COS, COTI, CTSI, DUSK, EGLD, ELF, FET, FLOW, FTM, INJ, IOTX, MDX, NEAR, OCEAN, ONT, POLS, REEF, WRX, XEC, XTZ, XVS, ZIL, DOT, FIL, TRX, CAKE, ADX, FIRO, SXP, ATOM, IOTA, AKRO, AUDIO, BADGER, CVC, DENT, DYDX, FORTH, GNO, HOT, LPT, LRC, NKN, NMR, NU, OGN, OXT, POLY, QNT, RLC, RSR, SAND, SKL, STMX, STORJ, TRB, UMA, DPI, VSP, CHSB, EURT, GHST, 3CRV, CRVRENWBTC, MIR-UST UNI LP, ALCX, ALUSD, USDP3CRV, RENBTC, YVECRV, CVX, USDTTRC20, AUD, HKD, GBP, EUR, HUSD, HT, DASH, EURS, AVAX, BTT, GALA, ILV, APE | +| platforms | Platforms to search interest rates in separated by comma. Default: BlockFi,Ledn,SwissBorg,Youhodler. Options: MakerDao,Compound,Poloniex,Bitfinex,dYdX,CompoundV2,Linen,Hodlonaut,InstaDapp,Zerion,Argent,DeFiSaver,MakerDaoV2,Ddex,AaveStable,AaveVariable,YearnFinance,BlockFi,Nexo,CryptoCom,Soda,Coinbase,SaltLending,Ledn,Bincentive,Inlock,Bitwala,Zipmex,Vauld,Delio,Yield,Vesper,Reflexer,SwissBorg,MushroomsFinance,ElementFi,Maple,CoinRabbit,WirexXAccounts,Youhodler,YieldApp,NotionalFinance,IconFi | BlockFi,Ledn,SwissBorg,Youhodler | True | MakerDao, Compound, Poloniex, Bitfinex, dYdX, CompoundV2, Linen, Hodlonaut, InstaDapp, Zerion, Argent, DeFiSaver, MakerDaoV2, Ddex, AaveStable, AaveVariable, YearnFinance, BlockFi, Nexo, CryptoCom, Soda, Coinbase, SaltLending, Ledn, Bincentive, Inlock, Bitwala, Zipmex, Vauld, Delio, Yield, Vesper, Reflexer, SwissBorg, MushroomsFinance, ElementFi, Maple, CoinRabbit, WirexXAccounts, Youhodler, YieldApp, NotionalFinance, IconFi | + +--- diff --git a/website/content/terminal/reference/crypto/ov/defi.md b/website/content/terminal/reference/crypto/ov/defi.md new file mode 100644 index 000000000000..be266406fec7 --- /dev/null +++ b/website/content/terminal/reference/crypto/ov/defi.md @@ -0,0 +1,63 @@ +--- +title: defi +description: The 'defi' page provides global decentralized finance (DeFi) statistics + such as market cap, trading volume, DeFi dominance, and top coins. It plainly outlines + how to use the function, its lack of parameters and showcases an example of the + function being used. +keywords: +- DeFi +- Decentralized Finance +- distributed networks +- financial services +- Market Cap +- Trading Volume +- Defi Dominance +- Top Coins +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Shows global DeFi statistics DeFi or Decentralized Finance refers to financial services that are built on top of distributed networks with no central intermediaries. Displays metrics like: Market Cap, Trading Volume, Defi Dominance, Top Coins... + +### Usage + +```python +defi +``` + +--- + +## Parameters + +This command has no parameters + + + +--- + +## Examples + +```python +2022 Feb 15, 08:11 (🦋) /crypto/ov/ $ defi + Global DEFI Statistics +┌─────────────────────────┬─────────────────┐ +│ Metric │ Value │ +├─────────────────────────┼─────────────────┤ +│ Defi Market Cap │ 110361000917.64 │ +├─────────────────────────┼─────────────────┤ +│ Eth Market Cap │ 372708922218.61 │ +├─────────────────────────┼─────────────────┤ +│ Defi To Eth Ratio │ 29.61 │ +├─────────────────────────┼─────────────────┤ +│ Trading Volume 24H │ 4839623761.93 │ +├─────────────────────────┼─────────────────┤ +│ Defi Dominance │ 5.32 │ +├─────────────────────────┼─────────────────┤ +│ Top Coin Name │ Terra │ +├─────────────────────────┼─────────────────┤ +│ Top Coin Defi Dominance │ 20.40 │ +└─────────────────────────┴─────────────────┘ +``` +--- diff --git a/website/content/terminal/reference/crypto/ov/derivatives.md b/website/content/terminal/reference/crypto/ov/derivatives.md new file mode 100644 index 000000000000..4ce8642d27ec --- /dev/null +++ b/website/content/terminal/reference/crypto/ov/derivatives.md @@ -0,0 +1,90 @@ +--- +title: derivatives +description: This page provides a comprehensive list and details on crypto derivatives. + Understand and sort crypto financial tools such as futures, options, and perpetual + contracts based on different parameters including Rank, Market, Symbol, Price, and + more. +keywords: +- crypto derivatives +- cryptocurrency +- Bitcoin +- crypto futures +- crypto options +- perpetual contracts +- sort by Rank +- sort by Market +- sort by Symbol +- sort by Price +- sort by Pct_Change_24h +- sort by Contract_Type +- sort by Basis +- sort by Spread +- sort by Funding_Rate +- sort by Volume_24h +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Shows list of crypto derivatives from CoinGecko Crypto derivatives are secondary contracts or financial tools that derive their value from a primary underlying asset. In this case, the primary asset would be a cryptocurrency such as Bitcoin. The most popular crypto derivatives are crypto futures, crypto options, and perpetual contracts. You can look on only N number of records with --limit, You can sort by Rank, Market, Symbol, Price, Pct_Change_24h, Contract_Type, Basis, Spread, Funding_Rate, Volume_24h with by and also with --reverse flag to set it to sort descending. Displays: Rank, Market, Symbol, Price, Pct_Change_24h, Contract_Type, Basis, Spread, Funding_Rate, Volume_24h + +### Usage + +```python +derivatives [-l LIMIT] [-s {Rank,Market,Symbol,Price,Pct_Change_24h,Contract_Type,Basis,Spread,Funding_Rate,Volume_24h}] [-r] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| limit | display N number records | 15 | True | None | +| sortby | Sort by given column. Default: Rank | Rank | True | Rank, Market, Symbol, Price, Pct_Change_24h, Contract_Type, Basis, Spread, Funding_Rate, Volume_24h | +| reverse | Data is sorted in ascending order by default. Reverse flag will sort it in an descending way. Only works when raw data is displayed. | False | True | None | + + +--- + +## Examples + +```python +2022 Feb 15, 08:11 (🦋) /crypto/ov/ $ derivatives + Crypto Derivatives +┌──────┬───────────────────────────────┬───────────────┬──────────┬────────────────┬───────────────┬───────┬────────┬──────────────┬────────────────┐ +│ Rank │ Market │ Symbol │ Price │ Pct_Change_24h │ Contract_Type │ Basis │ Spread │ Funding_Rate │ Volume_24h │ +├──────┼───────────────────────────────┼───────────────┼──────────┼────────────────┼───────────────┼───────┼────────┼──────────────┼────────────────┤ +│ 1 │ Binance (Futures) │ BTCUSDT │ 44268.84 │ 4.20 │ perpetual │ 0.02 │ 0.01 │ -0.01 │ 14058514627.71 │ +├──────┼───────────────────────────────┼───────────────┼──────────┼────────────────┼───────────────┼───────┼────────┼──────────────┼────────────────┤ +│ 2 │ FTX (Derivatives) │ BTC-PERP │ 44320.00 │ 4.26 │ perpetual │ -0.07 │ 0.01 │ 0.05 │ 3855173273.68 │ +├──────┼───────────────────────────────┼───────────────┼──────────┼────────────────┼───────────────┼───────┼────────┼──────────────┼────────────────┤ +│ 3 │ MEXC Global (Futures) │ ETH_USDT │ 3113.88 │ 6.05 │ perpetual │ 0.06 │ 0.01 │ -0.02 │ 742832083.24 │ +├──────┼───────────────────────────────┼───────────────┼──────────┼────────────────┼───────────────┼───────┼────────┼──────────────┼────────────────┤ +│ 4 │ Gate.io (Futures) │ BTC_USDT │ 44255.93 │ 4.07 │ perpetual │ 0.07 │ 0.01 │ -0.01 │ 1323562150.90 │ +├──────┼───────────────────────────────┼───────────────┼──────────┼────────────────┼───────────────┼───────┼────────┼──────────────┼────────────────┤ +│ 5 │ Binance (Futures) │ ETHUSDT │ 3116.95 │ 6.44 │ perpetual │ 0.04 │ 0.01 │ -0.02 │ 6311502301.53 │ +├──────┼───────────────────────────────┼───────────────┼──────────┼────────────────┼───────────────┼───────┼────────┼──────────────┼────────────────┤ +│ 6 │ Prime XBT │ BTC/USD │ 44250.70 │ 4.25 │ perpetual │ 0.00 │ 0.02 │ 0.00 │ 237445592.24 │ +├──────┼───────────────────────────────┼───────────────┼──────────┼────────────────┼───────────────┼───────┼────────┼──────────────┼────────────────┤ +│ 7 │ Bitget Futures │ BTCUSDT_UMCBL │ 44240.81 │ 3.93 │ perpetual │ -0.01 │ 0.01 │ -0.01 │ 4770121162.81 │ +├──────┼───────────────────────────────┼───────────────┼──────────┼────────────────┼───────────────┼───────┼────────┼──────────────┼────────────────┤ +│ 8 │ FTX (Derivatives) │ ETH-PERP │ 3115.00 │ 6.25 │ perpetual │ 0.03 │ 0.01 │ 0.00 │ 2193700085.40 │ +├──────┼───────────────────────────────┼───────────────┼──────────┼────────────────┼───────────────┼───────┼────────┼──────────────┼────────────────┤ +│ 9 │ Bitfinex (Futures) │ ETHF0:USTF0 │ 3116.90 │ 6.59 │ perpetual │ 0.05 │ 0.01 │ 0.00 │ 35390334.64 │ +├──────┼───────────────────────────────┼───────────────┼──────────┼────────────────┼───────────────┼───────┼────────┼──────────────┼────────────────┤ +│ 10 │ Bybit │ BTCUSDT │ 44213.89 │ 3.90 │ perpetual │ 0.06 │ 0.01 │ -0.01 │ 2873696641.99 │ +├──────┼───────────────────────────────┼───────────────┼──────────┼────────────────┼───────────────┼───────┼────────┼──────────────┼────────────────┤ +│ 11 │ C-Trade │ BTCUSD │ 44172.50 │ 3.65 │ perpetual │ 0.16 │ 0.01 │ 0.01 │ 25634007.98 │ +├──────┼───────────────────────────────┼───────────────┼──────────┼────────────────┼───────────────┼───────┼────────┼──────────────┼────────────────┤ +│ 12 │ Crypto.com Exchange (Futures) │ BTCUSD-PERP │ 44295.00 │ 4.21 │ perpetual │ -0.00 │ 0.02 │ 0.00 │ 882778425.04 │ +├──────┼───────────────────────────────┼───────────────┼──────────┼────────────────┼───────────────┼───────┼────────┼──────────────┼────────────────┤ +│ 13 │ Binance (Futures) │ BTCUSD_PERP │ 44273.80 │ 4.16 │ perpetual │ 0.05 │ 0.01 │ -0.01 │ 5207414861.13 │ +├──────┼───────────────────────────────┼───────────────┼──────────┼────────────────┼───────────────┼───────┼────────┼──────────────┼────────────────┤ +│ 14 │ Bybit │ BTCUSD │ 44200.50 │ 3.89 │ perpetual │ 0.10 │ 0.01 │ -0.01 │ 1365988606.18 │ +├──────┼───────────────────────────────┼───────────────┼──────────┼────────────────┼───────────────┼───────┼────────┼──────────────┼────────────────┤ +│ 15 │ BTSE (Futures) │ BTCPFC │ 44220.00 │ 4.10 │ perpetual │ 0.03 │ 0.01 │ 0.00 │ 1022965434.27 │ +└──────┴───────────────────────────────┴───────────────┴──────────┴────────────────┴───────────────┴───────┴────────┴──────────────┴────────────────┘ +``` +--- diff --git a/website/content/terminal/reference/crypto/ov/ewf.md b/website/content/terminal/reference/crypto/ov/ewf.md new file mode 100644 index 000000000000..61bf71395a05 --- /dev/null +++ b/website/content/terminal/reference/crypto/ov/ewf.md @@ -0,0 +1,163 @@ +--- +title: ewf +description: Detailed documentation on the usage of 'ewf', a command that displays + exchange withdrawal fees for various cryptocurrencies. The list includes a wide + range of exchanges from Binance to OKEx, providing an important resource for those + dealing with crypto trading. +keywords: +- ewf +- exchange withdrawal fees +- cryptocurrency +- crypto trading +- crypto exchanges +- withdrawal fees +- FixedFloat +- CREX24 +- GetBTC +- Deribit +- CoinFalcon +- Bitfinex +- Bleutrade +- Kraken +- Coindeal +- OKCoin +- CoinTiger +- Kucoin +- AscendEX +- Coincheck +- Coinone +- CoinEx +- Bitrue +- Crypto.com Exchange +- DSX +- Poloniex +- Binance +- Bitkub +- BitMart +- TOKOK +- Flyp.me +- HitBTC +- Liquid +- Gate.io +- Bittrex +- BitForex +- BTSE +- Tidex +- Huobi Global +- BW +- SouthXchange +- WhiteBit +- OKEx +- Coinsbit +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Display exchange withdrawal fees [Source: https://withdrawalfees.com/] + +### Usage + +```python +ewf +``` + +--- + +## Parameters + +This command has no parameters + + + +--- + +## Examples + +```python +2022 Feb 15, 08:20 (🦋) /crypto/ov/ $ ewf + +Withdrawal fees per exchange: + Withdrawal Fees +┌─────────────────────┬───────┬────────────────┬──────────────────┬────────┬─────────────────────┐ +│ Exchange │ Coins │ Lowest │ Average │ Median │ Highest │ +├─────────────────────┼───────┼────────────────┼──────────────────┼────────┼─────────────────────┤ +│ FixedFloat │ 19 │ FREE │ FREE │ FREE │ FREE │ +├─────────────────────┼───────┼────────────────┼──────────────────┼────────┼─────────────────────┤ +│ CREX24 │ 218 │ $0.000000001 │ $0.97 │ $0.003 │ $35.42 │ +├─────────────────────┼───────┼────────────────┼──────────────────┼────────┼─────────────────────┤ +│ GetBTC │ 20 │ FREE │ $1.54 │ $0.03 │ $22.13 │ +├─────────────────────┼───────┼────────────────┼──────────────────┼────────┼─────────────────────┤ +│ Deribit │ 2 │ $0.89 │ $2.30 │ $2.30 │ $3.72 │ +├─────────────────────┼───────┼────────────────┼──────────────────┼────────┼─────────────────────┤ +│ CoinFalcon │ 9 │ $0.00000000008 │ $3.41 │ $0.15 │ $24.83 │ +├─────────────────────┼───────┼────────────────┼──────────────────┼────────┼─────────────────────┤ +│ Bitfinex │ 139 │ FREE │ $3.59 │ $4.92 │ $51.83 │ +├─────────────────────┼───────┼────────────────┼──────────────────┼────────┼─────────────────────┤ +│ Bleutrade │ 14 │ FREE │ $4.76 │ FREE │ $44.27 │ +├─────────────────────┼───────┼────────────────┼──────────────────┼────────┼─────────────────────┤ +│ Kraken │ 101 │ $0.0002 │ $7.23 │ $6.62 │ $33.92 │ +├─────────────────────┼───────┼────────────────┼──────────────────┼────────┼─────────────────────┤ +│ Coindeal │ 17 │ $0.01 │ $7.52 │ $1.08 │ $46.55 │ +├─────────────────────┼───────┼────────────────┼──────────────────┼────────┼─────────────────────┤ +│ OKCoin │ 75 │ $0.0002 │ $8.27 │ $2.40 │ $45.93 │ +├─────────────────────┼───────┼────────────────┼──────────────────┼────────┼─────────────────────┤ +│ CoinTiger │ 40 │ $0.00006 │ $10.40 │ $0.44 │ $217.00 │ +├─────────────────────┼───────┼────────────────┼──────────────────┼────────┼─────────────────────┤ +│ Kucoin │ 598 │ FREE │ $11.12 │ $10.22 │ $60.89 │ +├─────────────────────┼───────┼────────────────┼──────────────────┼────────┼─────────────────────┤ +│ AscendEX │ 278 │ FREE │ $11.29 │ $12.22 │ $418.86 │ +├─────────────────────┼───────┼────────────────┼──────────────────┼────────┼─────────────────────┤ +│ Coincheck │ 17 │ $0.002 │ $11.45 │ $0.33 │ $56.70 │ +├─────────────────────┼───────┼────────────────┼──────────────────┼────────┼─────────────────────┤ +│ Coinone │ 213 │ FREE │ $11.79 │ $12.41 │ $403.08 │ +├─────────────────────┼───────┼────────────────┼──────────────────┼────────┼─────────────────────┤ +│ CoinEx │ 376 │ FREE │ $12.11 │ $15.15 │ $64.73 │ +├─────────────────────┼───────┼────────────────┼──────────────────┼────────┼─────────────────────┤ +│ Bitrue │ 73 │ FREE │ $12.67 │ $2.42 │ $137.85 │ +├─────────────────────┼───────┼────────────────┼──────────────────┼────────┼─────────────────────┤ +│ Crypto.com Exchange │ 179 │ FREE │ $13.59 │ $8.02 │ $229.75 │ +├─────────────────────┼───────┼────────────────┼──────────────────┼────────┼─────────────────────┤ +│ DSX │ 14 │ $0.0004 │ $14.40 │ $1.23 │ $146.63 │ +├─────────────────────┼───────┼────────────────┼──────────────────┼────────┼─────────────────────┤ +│ Poloniex │ 301 │ FREE │ $15.83 │ $16.22 │ $100.00 │ +├─────────────────────┼───────┼────────────────┼──────────────────┼────────┼─────────────────────┤ +│ Binance │ 417 │ FREE │ $16.80 │ $25.00 │ $83.27 │ +├─────────────────────┼───────┼────────────────┼──────────────────┼────────┼─────────────────────┤ +│ Bitkub │ 55 │ $0.002 │ $18.17 │ $20.10 │ $83.27 │ +├─────────────────────┼───────┼────────────────┼──────────────────┼────────┼─────────────────────┤ +│ BitMart │ 135 │ FREE │ $18.78 │ $0.34 │ $706.20 │ +├─────────────────────┼───────┼────────────────┼──────────────────┼────────┼─────────────────────┤ +│ TOKOK │ 125 │ FREE │ $18.99 │ $3.59 │ $598.00 │ +├─────────────────────┼───────┼────────────────┼──────────────────┼────────┼─────────────────────┤ +│ Flyp.me │ 46 │ $0.0002 │ $19.23 │ $31.78 │ $36.72 │ +├─────────────────────┼───────┼────────────────┼──────────────────┼────────┼─────────────────────┤ +│ HitBTC │ 520 │ FREE │ $31.11 │ $30.17 │ $744.58 │ +├─────────────────────┼───────┼────────────────┼──────────────────┼────────┼─────────────────────┤ +│ Liquid │ 207 │ FREE │ $31.42 │ $0.44 │ $5074.75 │ +├─────────────────────┼───────┼────────────────┼──────────────────┼────────┼─────────────────────┤ +│ Gate.io │ 1184 │ FREE │ $35.04 │ $44.53 │ $3049.92 │ +├─────────────────────┼───────┼────────────────┼──────────────────┼────────┼─────────────────────┤ +│ Bittrex │ 475 │ FREE │ $43.35 │ $38.05 │ $6421.06 │ +├─────────────────────┼───────┼────────────────┼──────────────────┼────────┼─────────────────────┤ +│ BitForex │ 84 │ FREE │ $47.57 │ $0.16 │ $2797.80 │ +├─────────────────────┼───────┼────────────────┼──────────────────┼────────┼─────────────────────┤ +│ BTSE │ 89 │ $0.002 │ $48.92 │ $14.31 │ $2954.31 │ +├─────────────────────┼───────┼────────────────┼──────────────────┼────────┼─────────────────────┤ +│ Tidex │ 78 │ $0.00000002 │ $93.25 │ $3.99 │ $6511.71 │ +├─────────────────────┼───────┼────────────────┼──────────────────┼────────┼─────────────────────┤ +│ Huobi Global │ 425 │ FREE │ $137.17 │ $13.88 │ $52838.35 │ +├─────────────────────┼───────┼────────────────┼──────────────────┼────────┼─────────────────────┤ +│ BW │ 86 │ $0.00000002 │ $185.48 │ $3.22 │ $13857.00 │ +├─────────────────────┼───────┼────────────────┼──────────────────┼────────┼─────────────────────┤ +│ SouthXchange │ 156 │ FREE │ $989.69 │ $0.001 │ $151890.50 │ +├─────────────────────┼───────┼────────────────┼──────────────────┼────────┼─────────────────────┤ +│ WhiteBit │ 200 │ FREE │ $2530.07 │ $4.59 │ $441294.24 │ +├─────────────────────┼───────┼────────────────┼──────────────────┼────────┼─────────────────────┤ +│ OKEx │ 353 │ FREE │ $44033.70 │ $14.30 │ $15539000.00 │ +├─────────────────────┼───────┼────────────────┼──────────────────┼────────┼─────────────────────┤ +│ Coinsbit │ 580 │ FREE │ $302866468285.59 │ $3.94 │ $175505321255000.00 │ +└─────────────────────┴───────┴────────────────┴──────────────────┴────────┴─────────────────────┘ +``` +--- diff --git a/website/content/terminal/reference/crypto/ov/exchanges.md b/website/content/terminal/reference/crypto/ov/exchanges.md new file mode 100644 index 000000000000..52cada0673ea --- /dev/null +++ b/website/content/terminal/reference/crypto/ov/exchanges.md @@ -0,0 +1,86 @@ +--- +title: exchanges +description: A documentation page that details the usage of currency exchange parameters + in crypto trading. Provides details on how to sort and limit data based on various + criteria, specifically for CoinPaprika and CoinGecko exchanges. +keywords: +- crypto exchanges +- display limit +- sort data +- Trust_Score +- Id +- Name +- Country +- Year_Established +- Trade_Volume_24h_BTC +- CoinPaprika +- CoinGecko +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Shows Top Crypto Exchanges You can display only N number exchanges with --limit parameter. You can sort data by Trust_Score, Id, Name, Country, Year_Established, Trade_Volume_24h_BTC with --sortby Or you can sort data by 'name', 'currencies', 'markets', 'fiats', 'confidence', 'volume_24h', 'volume_7d', 'volume_30d', 'sessions_per_month' if you are using the alternative source CoinPaprika and also with --reverse flag to sort ascending. Flag --urls will display urls. Displays: Trust_Score, Id, Name, Country, Year_Established, Trade_Volume_24h_BTC + +### Usage + +```python +exchanges [-l LIMIT] [-s {Rank,Trust_Score,Id,Name,Country,Year Established,Trade_Volume_24h_BTC,rank,name,currencies,markets,fiats,confidence,volume_24h,volume_7d,volume_30d,sessions_per_month}] [-r] [-u] [--vs {BTC,ETH,USD,EUR,PLN,KRW,GBP,CAD,JPY,RUB,TRY,NZD,AUD,CHF,UAH,HKD,SGD,NGN,PHP,MXN,BRL,THB,CLP,CNY,CZK,DKK,HUF,IDR,ILS,INR,MYR,NOK,PKR,SEK,TWD,ZAR,VND,BOB,COP,PEN,ARS,ISK}] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| limit | display N number records | 15 | True | None | +| sortby | Sort by given column. Default: Rank | Rank | True | Rank, Trust_Score, Id, Name, Country, Year Established, Trade_Volume_24h_BTC, rank, name, currencies, markets, fiats, confidence, volume_24h, volume_7d, volume_30d, sessions_per_month | +| reverse | Data is sorted in descending order by default. Reverse flag will sort it in an ascending way. Only works when raw data is displayed. | False | True | None | +| urls | Flag to add a url column. Works only with CoinGecko source | False | True | None | +| vs | Quoted currency. Default: USD. Works only with CoinPaprika source | USD | True | BTC, ETH, USD, EUR, PLN, KRW, GBP, CAD, JPY, RUB, TRY, NZD, AUD, CHF, UAH, HKD, SGD, NGN, PHP, MXN, BRL, THB, CLP, CNY, CZK, DKK, HUF, IDR, ILS, INR, MYR, NOK, PKR, SEK, TWD, ZAR, VND, BOB, COP, PEN, ARS, ISK | + + +--- + +## Examples + +```python +2022 Feb 15, 08:12 (🦋) /crypto/ov/ $ exchanges + Top CoinGecko Exchanges +┌──────┬─────────────┬────────────┬─────────────────────┬────────────────────────┬──────────────────┬──────────────────────┐ +│ Rank │ Trust_Score │ Id │ Name │ Country │ Year_Established │ Trade_Volume_24h_BTC │ +├──────┼─────────────┼────────────┼─────────────────────┼────────────────────────┼──────────────────┼──────────────────────┤ +│ 1 │ 10.00 │ binance │ Binance │ Cayman Islands │ 2017.00 │ 307450.76 │ +├──────┼─────────────┼────────────┼─────────────────────┼────────────────────────┼──────────────────┼──────────────────────┤ +│ 2 │ 10.00 │ okex │ OKX │ Belize │ 2013.00 │ 80452.05 │ +├──────┼─────────────┼────────────┼─────────────────────┼────────────────────────┼──────────────────┼──────────────────────┤ +│ 3 │ 10.00 │ gdax │ Coinbase Exchange │ United States │ 2012.00 │ 68358.93 │ +├──────┼─────────────┼────────────┼─────────────────────┼────────────────────────┼──────────────────┼──────────────────────┤ +│ 4 │ 10.00 │ crypto_com │ Crypto.com Exchange │ Cayman Islands │ 2019.00 │ 60342.43 │ +├──────┼─────────────┼────────────┼─────────────────────┼────────────────────────┼──────────────────┼──────────────────────┤ +│ 5 │ 10.00 │ kucoin │ KuCoin │ Seychelles │ 2014.00 │ 53539.44 │ +├──────┼─────────────┼────────────┼─────────────────────┼────────────────────────┼──────────────────┼──────────────────────┤ +│ 6 │ 10.00 │ ftx_spot │ FTX │ Antigua and Barbuda │ 2019.00 │ 40360.67 │ +├──────┼─────────────┼────────────┼─────────────────────┼────────────────────────┼──────────────────┼──────────────────────┤ +│ 7 │ 10.00 │ huobi │ Huobi Global │ Seychelles │ 2013.00 │ 34851.50 │ +├──────┼─────────────┼────────────┼─────────────────────┼────────────────────────┼──────────────────┼──────────────────────┤ +│ 8 │ 10.00 │ gate │ Gate.io │ Hong Kong │ None │ 30159.12 │ +├──────┼─────────────┼────────────┼─────────────────────┼────────────────────────┼──────────────────┼──────────────────────┤ +│ 9 │ 10.00 │ bitmart │ BitMart │ Cayman Islands │ 2017.00 │ 21782.37 │ +├──────┼─────────────┼────────────┼─────────────────────┼────────────────────────┼──────────────────┼──────────────────────┤ +│ 10 │ 10.00 │ kraken │ Kraken │ United States │ 2011.00 │ 19819.63 │ +├──────┼─────────────┼────────────┼─────────────────────┼────────────────────────┼──────────────────┼──────────────────────┤ +│ 11 │ 10.00 │ bitfinex │ Bitfinex │ British Virgin Islands │ 2014.00 │ 13254.81 │ +├──────┼─────────────┼────────────┼─────────────────────┼────────────────────────┼──────────────────┼──────────────────────┤ +│ 12 │ 10.00 │ bybit_spot │ Bybit (spot) │ None │ 2018.00 │ 7823.03 │ +├──────┼─────────────┼────────────┼─────────────────────┼────────────────────────┼──────────────────┼──────────────────────┤ +│ 13 │ 10.00 │ binance_us │ Binance US │ United States │ 2019.00 │ 7384.36 │ +├──────┼─────────────┼────────────┼─────────────────────┼────────────────────────┼──────────────────┼──────────────────────┤ +│ 14 │ 10.00 │ gemini │ Gemini │ United States │ 2014.00 │ 2876.09 │ +├──────┼─────────────┼────────────┼─────────────────────┼────────────────────────┼──────────────────┼──────────────────────┤ +│ 15 │ 10.00 │ bitkub │ Bitkub │ Thailand │ 2018.00 │ 2163.91 │ +└──────┴─────────────┴────────────┴─────────────────────┴────────────────────────┴──────────────────┴──────────────────────┘ +``` +--- diff --git a/website/content/terminal/reference/crypto/ov/exmarkets.md b/website/content/terminal/reference/crypto/ov/exmarkets.md new file mode 100644 index 000000000000..d588c5f9884f --- /dev/null +++ b/website/content/terminal/reference/crypto/ov/exmarkets.md @@ -0,0 +1,79 @@ +--- +title: exmarkets +description: The page explains the usage of exmarkets command that generates a table + with exchange markets data with various parameters. It provides information on how + to limit, sort, and view this data in a user-friendly format. +keywords: +- exmarkets +- exchange markets +- cryptocurrency +- sort data +- limit data +- command usage +- parameter usage +- exchange_id +- trust score +- base_currency_name +- quote_currency_name +- market_url +- reported_volume_24h_share +- category +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Get all exchange markets found for given exchange You can display only N number of records with --limit parameter. You can sort data by pair, base_currency_name, quote_currency_name, market_url, category, reported_volume_24h_share, trust_score --sortby parameter and also with --reverse flag to sort ascending. You can use additional flag --urls to see urls for each market Displays: exchange_id, pair, base_currency_name, quote_currency_name, market_url, category, reported_volume_24h_share, trust_score, + +### Usage + +```python +exmarkets [-e EXCHANGE] [-l LIMIT] [-s {pair,base_currency_name,quote_currency_name,category,reported_volume_24h_share,trust_score,market_url}] [-r] [-u] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| exchange | Identifier of exchange e.g for Binance Exchange - binance | binance | True | None | +| limit | display N number records | 10 | True | None | +| sortby | Sort by given column. Default: reported_volume_24h_share | reported_volume_24h_share | True | pair, base_currency_name, quote_currency_name, category, reported_volume_24h_share, trust_score, market_url | +| reverse | Data is sorted in descending order by default. Reverse flag will sort it in an ascending way. Only works when raw data is displayed. | False | True | None | +| urls | Flag to show urls. If you will use that flag you will see only: exchange, pair, trust_score, market_url columns | False | True | None | + + +--- + +## Examples + +```python +2022 Feb 15, 08:18 (🦋) /crypto/ov/ $ exmarkets + Exchange Markets +┌─────────────┬───────────┬────────────────────┬─────────────────────┬──────────┬───────────────────────────┬─────────────┐ +│ exchange_id │ pair │ base_currency_name │ quote_currency_name │ category │ reported_volume_24h_share │ trust_score │ +├─────────────┼───────────┼────────────────────┼─────────────────────┼──────────┼───────────────────────────┼─────────────┤ +│ binance │ BTC/USDT │ Bitcoin │ Tether │ Spot │ 14.25 │ high │ +├─────────────┼───────────┼────────────────────┼─────────────────────┼──────────┼───────────────────────────┼─────────────┤ +│ binance │ ETH/USDT │ Ethereum │ Tether │ Spot │ 11.87 │ high │ +├─────────────┼───────────┼────────────────────┼─────────────────────┼──────────┼───────────────────────────┼─────────────┤ +│ binance │ BTC/BUSD │ Bitcoin │ Binance USD │ Spot │ 4.44 │ high │ +├─────────────┼───────────┼────────────────────┼─────────────────────┼──────────┼───────────────────────────┼─────────────┤ +│ binance │ BNB/USDT │ Binance Coin │ Tether │ Spot │ 3.58 │ medium │ +├─────────────┼───────────┼────────────────────┼─────────────────────┼──────────┼───────────────────────────┼─────────────┤ +│ binance │ BUSD/USDT │ Binance USD │ Tether │ Spot │ 3.54 │ high │ +├─────────────┼───────────┼────────────────────┼─────────────────────┼──────────┼───────────────────────────┼─────────────┤ +│ binance │ ETH/BUSD │ Ethereum │ Binance USD │ Spot │ 2.97 │ high │ +├─────────────┼───────────┼────────────────────┼─────────────────────┼──────────┼───────────────────────────┼─────────────┤ +│ binance │ SLP/USDT │ Smooth Love Potion │ Tether │ Spot │ 2.86 │ medium │ +├─────────────┼───────────┼────────────────────┼─────────────────────┼──────────┼───────────────────────────┼─────────────┤ +│ binance │ SHIB/USDT │ Shiba Inu │ Tether │ Spot │ 2.41 │ high │ +├─────────────┼───────────┼────────────────────┼─────────────────────┼──────────┼───────────────────────────┼─────────────┤ +│ binance │ XRP/USDT │ XRP │ Tether │ Spot │ 2.01 │ high │ +├─────────────┼───────────┼────────────────────┼─────────────────────┼──────────┼───────────────────────────┼─────────────┤ +│ binance │ SOL/USDT │ Solana │ Tether │ Spot │ 1.95 │ high │ +└─────────────┴───────────┴────────────────────┴─────────────────────┴──────────┴───────────────────────────┴─────────────┘ +``` +--- diff --git a/website/content/terminal/reference/crypto/ov/exrates.md b/website/content/terminal/reference/crypto/ov/exrates.md new file mode 100644 index 000000000000..5450eddd223c --- /dev/null +++ b/website/content/terminal/reference/crypto/ov/exrates.md @@ -0,0 +1,82 @@ +--- +title: exrates +description: The 'exrates' page allows users to view crypto, fiats, and commodity + exchange rates from CoinGecko in Python. The page also explains how to limit, sort, + or reverse data. Methods show examples and list of parameters as well. +keywords: +- exrates +- crypto exchange rates +- CoinGecko +- sort +- limit +- reverse +- parameters +- fiats +- commodity +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Shows list of crypto, fiats, commodity exchange rates from CoinGecko You can look on only N number of records with --limit, You can sort by Index, Name, Unit, Value, Type, and also use --reverse flag to sort descending. + +### Usage + +```python +exrates [-l LIMIT] [-s {Index,Name,Unit,Value,Type}] [-r] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| limit | display N number records | 15 | True | None | +| sortby | Sort by given column. Default: Index | Index | True | Index, Name, Unit, Value, Type | +| reverse | Data is sorted in ascending order by default. Reverse flag will sort it in an descending way. Only works when raw data is displayed. | False | True | None | + + +--- + +## Examples + +```python +2022 Feb 15, 08:12 (🦋) /crypto/ov/ $ exrates + Exchange Rates +┌───────┬─────────────────────────────┬──────┬────────────┬────────┐ +│ Index │ Name │ Unit │ Value │ Type │ +├───────┼─────────────────────────────┼──────┼────────────┼────────┤ +│ 1 │ Bitcoin │ BTC │ 1.00 │ crypto │ +├───────┼─────────────────────────────┼──────┼────────────┼────────┤ +│ 2 │ Ether │ ETH │ 14.20 │ crypto │ +├───────┼─────────────────────────────┼──────┼────────────┼────────┤ +│ 3 │ Litecoin │ LTC │ 337.43 │ crypto │ +├───────┼─────────────────────────────┼──────┼────────────┼────────┤ +│ 4 │ Bitcoin Cash │ BCH │ 130.59 │ crypto │ +├───────┼─────────────────────────────┼──────┼────────────┼────────┤ +│ 5 │ Binance Coin │ BNB │ 103.36 │ crypto │ +├───────┼─────────────────────────────┼──────┼────────────┼────────┤ +│ 6 │ EOS │ EOS │ 17907.80 │ crypto │ +├───────┼─────────────────────────────┼──────┼────────────┼────────┤ +│ 7 │ XRP │ XRP │ 53041.60 │ crypto │ +├───────┼─────────────────────────────┼──────┼────────────┼────────┤ +│ 8 │ Lumens │ XLM │ 201835.99 │ crypto │ +├───────┼─────────────────────────────┼──────┼────────────┼────────┤ +│ 9 │ Chainlink │ LINK │ 2619.11 │ crypto │ +├───────┼─────────────────────────────┼──────┼────────────┼────────┤ +│ 10 │ Polkadot │ DOT │ 2235.39 │ crypto │ +├───────┼─────────────────────────────┼──────┼────────────┼────────┤ +│ 11 │ Yearn.finance │ YFI │ 1.85 │ crypto │ +├───────┼─────────────────────────────┼──────┼────────────┼────────┤ +│ 12 │ US Dollar │ $ │ 44258.09 │ fiat │ +├───────┼─────────────────────────────┼──────┼────────────┼────────┤ +│ 13 │ United Arab Emirates Dirham │ DH │ 162560.27 │ fiat │ +├───────┼─────────────────────────────┼──────┼────────────┼────────┤ +│ 14 │ Argentine Peso │ $ │ 4711797.18 │ fiat │ +├───────┼─────────────────────────────┼──────┼────────────┼────────┤ +│ 15 │ Australian Dollar │ A$ │ 61998.28 │ fiat │ +└───────┴─────────────────────────────┴──────┴────────────┴────────┘ +``` +--- diff --git a/website/content/terminal/reference/crypto/ov/fun.md b/website/content/terminal/reference/crypto/ov/fun.md new file mode 100644 index 000000000000..110c8859d194 --- /dev/null +++ b/website/content/terminal/reference/crypto/ov/fun.md @@ -0,0 +1,55 @@ +--- +title: fun +description: This page provides a comprehensive guide on how to use the python script + 'fun' to display various fundamental metrics from the Token Terminal. The metrics + include market cap, timeline, category, etc. It also comes with specific command-line + examples and parameter descriptions for better understanding. +keywords: +- fundamental metrics +- Token Terminal +- usage +- parameters +- python script +- examples +- market_cap +- Blockchain +- category +- metric +- timeline +- reverse +- limit +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Display fundamental metrics overview [Source: Token Terminal] + +### Usage + +```python +fun -m {twitter_followers,gmv_annualized,market_cap,take_rate,revenue,revenue_protocol,tvl,pe,pe_circulating,ps,ps_circulating} [-c {Asset Management,Blockchain,DeFi,Exchange,Gaming,Insurance,Interoperability,Lending,NFT,Other,Prediction Market,Stablecoin}] [-t {24h,7d,30d,90d,180d,365d}] [-r] [-l LIMIT] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| metric | Choose metric of interest | None | False | twitter_followers, gmv_annualized, market_cap, take_rate, revenue, revenue_protocol, tvl, pe, pe_circulating, ps, ps_circulating | +| category | Choose category of interest | | True | Asset Management, Blockchain, DeFi, Exchange, Gaming, Insurance, Interoperability, Lending, NFT, Other, Prediction Market, Stablecoin | +| timeline | Choose timeline of interest | 24h | True | 24h, 7d, 30d, 90d, 180d, 365d | +| reverse | Data is sorted in descending order by default. Reverse flag will sort it in an ascending way. Only works when raw data is displayed. | False | True | None | +| limit | Display N items | 10 | True | None | + + +--- + +## Examples + +```python +2022 Aug 28, 20:02 (🦋) /crypto/ov/ $ fun -m market_cap -c Blockchain +``` +--- diff --git a/website/versioned_docs/version-v3/terminal/reference/crypto/ov/global.md b/website/content/terminal/reference/crypto/ov/global.md similarity index 83% rename from website/versioned_docs/version-v3/terminal/reference/crypto/ov/global.md rename to website/content/terminal/reference/crypto/ov/global.md index ce4c22216424..b51d85bfdae5 100644 --- a/website/versioned_docs/version-v3/terminal/reference/crypto/ov/global.md +++ b/website/content/terminal/reference/crypto/ov/global.md @@ -1,9 +1,21 @@ --- title: global -description: OpenBB Terminal Function +description: An overview of global statistics on the Crypto Market, providing essential + information such as active cryptocurrencies, ICOs data, and market cap changes. + Features a pie chart option for visualizing market cap distribution. Powered by + CoinGecko. +keywords: +- Global Cryptocurrency +- Crypto Market Statistics +- Cryptocurrency Analysis +- ICOs Data +- Pie Chart Market Cap +- CoinGecko --- -# global +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + Shows global statistics about Crypto Market diff --git a/website/content/terminal/reference/crypto/ov/hm.md b/website/content/terminal/reference/crypto/ov/hm.md new file mode 100644 index 000000000000..8c72a0a012ab --- /dev/null +++ b/website/content/terminal/reference/crypto/ov/hm.md @@ -0,0 +1,71 @@ +--- +title: hm +description: This page provides a guide to use 'hm' tool in displaying cryptocurrencies + heatmap with a daily percentage change. Utilize parameter options like 'limit' and + 'category' to customize the display. +keywords: +- cryptocurrency +- heatmap +- daily percentage change +- parameters +- limit +- category +- crypto categories +- display options +- cryptocurrency tool +- '''hm'' tool' +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Display cryptocurrencies heatmap with daily percentage change [Source: https://coingecko.com] Accepts --category or -c to display only coins of a certain category (default no category to display all coins ranked by market cap). You can look on only top N number of records with --limit. + +### Usage + +```python +hm [-l LIMIT] [-c CATEGORY] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| limit | Display N items | 10 | True | None | +| category | Category (e.g., stablecoins). Empty for no category | | True | aave-tokens, analytics, arbitrum-ecosystem, artificial-intelligence, asset-backed-tokens, asset-manager, augmented-reality, automated-market-maker-amm, avalanche-ecosystem, axie-infinity, big-data, binance-launchpool, binance-smart-chain, business-platform, business-services, cardano-ecosystem, celo-ecosystem, centralized-exchange-token-cex, charity, cny-stablecoin, collectibles, communication, compound-tokens, cosmos-ecosystem, cryptocurrency, daomaker-ecosystem, decentralized-exchange, decentralized-finance-defi, defi-index, decentralized-derivatives, education, energy, entertainment, etf, eth-2-0-staking, eur-stablecoin, exchange-based-tokens, fan-token, fantom-ecosystem, finance-banking, fractionalized-nft, gambling, gaming, gbp-stablecoin, gig-economy, xdai-ecosystem, governance, guild-scholarship, harmony-ecosystem, healthcare, heco-chain-ecosystem, impossible-launchpad, index-coin, infrastructure, insurance, internet-of-things-iot, investment, iotex-ecosystem, kardiachain-ecosystem, krw-stablecoin, launchpad, layer-1, legal, lending-borrowing, leveraged-token, lp-tokens, manufacturing, marketing, masternodes, media, meme-token, metaverse, mev-protection, mirrored-assets, moonriver-ecosystem, music, near-protocol-ecosystem, nft-index, niftex-shards, non-fungible-tokens-nft, number, oec-ecosystem, ohm-fork, olympus-pro, decentralized-options, oracle, decentralized-perpetuals, play-to-earn, dot-ecosystem, polygon-ecosystem, prediction-markets, privacy-coins, protocol, real-estate, realt-tokens, rebase-tokens, reddit-points, remittance, retail, seigniorage, smart-contract-platform, social-money, software, solana-ecosystem, sports, stablecoins, storage, structured-products, synthetic-assets, synths, technology-science, terra-ecosystem, tokenized-btc, tokenized-gold, tokenized-products, tokenized-stock, tokensets, tourism, usd-stablecoin, us-election-2020, utokens, virtual-reality, wallets, wrapped-tokens, yearn-yfi-partnerships-mergers, yield-aggregator, yield-farming, zilliqa-ecosystem | + + +--- + +## Examples + +```python +2022 Feb 15, 06:44 (🦋) /crypto/disc/ $ cgtop +┌────────┬──────────────┬────────────┬────────────────┬─────────────────┬───────────────┬────────────────┐ +│ Symbol │ Name │ Volume [$] │ Market Cap [$] │ Market Cap Rank │ 7D Change [%] │ 24H Change [%] │ +├────────┼──────────────┼────────────┼────────────────┼─────────────────┼───────────────┼────────────────┤ +│ btc │ Bitcoin │ 20.6B │ 838.8B │ 1 │ 0.93 │ 4.77 │ +├────────┼──────────────┼────────────┼────────────────┼─────────────────┼───────────────┼────────────────┤ +│ eth │ Ethereum │ 14.4B │ 370.6B │ 2 │ -1.53 │ 7.77 │ +├────────┼──────────────┼────────────┼────────────────┼─────────────────┼───────────────┼────────────────┤ +│ usdt │ Tether │ 43.3B │ 78.5B │ 3 │ -0.01 │ -0.05 │ +├────────┼──────────────┼────────────┼────────────────┼─────────────────┼───────────────┼────────────────┤ +│ bnb │ Binance Coin │ 1.8B │ 72.2B │ 4 │ -1.01 │ 8.18 │ +├────────┼──────────────┼────────────┼────────────────┼─────────────────┼───────────────┼────────────────┤ +│ usdc │ USD Coin │ 3B │ 52.6B │ 5 │ 0.25 │ 0.17 │ +├────────┼──────────────┼────────────┼────────────────┼─────────────────┼───────────────┼────────────────┤ +│ xrp │ XRP │ 3.2B │ 39.9B │ 6 │ 0.71 │ 5.51 │ +├────────┼──────────────┼────────────┼────────────────┼─────────────────┼───────────────┼────────────────┤ +│ ada │ Cardano │ 1B │ 34.9B │ 7 │ -9.04 │ 5.52 │ +├────────┼──────────────┼────────────┼────────────────┼─────────────────┼───────────────┼────────────────┤ +│ sol │ Solana │ 1.8B │ 32.7B │ 8 │ -12.54 │ 10.07 │ +├────────┼──────────────┼────────────┼────────────────┼─────────────────┼───────────────┼────────────────┤ +│ luna │ Terra │ 1B │ 22.4B │ 9 │ -5.26 │ 8.67 │ +├────────┼──────────────┼────────────┼────────────────┼─────────────────┼───────────────┼────────────────┤ +│ AVAX │ Avalanche │ 899.9M │ 21.7B │ 10 │ 6.28 │ 12.72 │ +└────────┴──────────────┴────────────┴────────────────┴─────────────────┴───────────────┴────────────────┘ +``` +--- diff --git a/website/content/terminal/reference/crypto/ov/hold.md b/website/content/terminal/reference/crypto/ov/hold.md new file mode 100644 index 000000000000..d42efb679ecb --- /dev/null +++ b/website/content/terminal/reference/crypto/ov/hold.md @@ -0,0 +1,39 @@ +--- +title: hold +description: An overview of public companies holding Bitcoin or Ethereum, presenting + key metrics like total holdings and value. +keywords: +- Bitcoin +- Ethereum +- public companies +- crypto holdings +- cryptocurrency +- digital assets +- bar chart +- Bitcoin dominance +- crypto metrics +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Shows overview of public companies that holds ethereum or bitcoin. You can find there most important metrics like: Total Bitcoin Holdings, Total Value (USD), Public Companies Bitcoin Dominance, Companies + +### Usage + +```python +hold [-c {ethereum,bitcoin}] [-l LIMIT] [--bar] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| coin | companies with ethereum or bitcoin | bitcoin | True | ethereum, bitcoin | +| limit | display N number of records | 5 | True | None | +| bar | Flag to show bar chart | False | True | None | + +--- diff --git a/website/content/terminal/reference/crypto/ov/indexes.md b/website/content/terminal/reference/crypto/ov/indexes.md new file mode 100644 index 000000000000..ff1e24212c34 --- /dev/null +++ b/website/content/terminal/reference/crypto/ov/indexes.md @@ -0,0 +1,82 @@ +--- +title: indexes +description: Our 'indexes' page offers data on crypto indexes coming from CoinGecko. + It allows users to see details of each crypto index and offers several parameters + for sorting and limiting the data displayed. Utilize cryptocurrency market data + to make informed decisions regarding your crypto investments. +keywords: +- cryptocurrency +- CoinGecko +- crypto index +- market cap +- cryptocurrency market data +- crypto investment +- data sorting parameters +- limit parameter +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Shows list of crypto indexes from CoinGecko. Each crypto index is made up of a selection of cryptocurrencies, grouped together and weighted by market cap. You can display only N number of indexes with --limit parameter. You can sort data by Rank, Name, Id, Market, Last, MultiAsset with --sortby and also with --reverse flag to sort descending. Displays: Rank, Name, Id, Market, Last, MultiAsset + +### Usage + +```python +indexes [-l LIMIT] [-s {Rank,Name,Id,Market,Last,MultiAsset}] [-r] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| limit | display N number records | 15 | True | None | +| sortby | Sort by given column. Default: Rank | Rank | True | Rank, Name, Id, Market, Last, MultiAsset | +| reverse | Data is sorted in ascending order by default. Reverse flag will sort it in an descending way. Only works when raw data is displayed. | False | True | None | + + +--- + +## Examples + +```python +2022 Feb 15, 08:13 (🦋) /crypto/ov/ $ indexes + Crypto Indexes +┌──────┬─────────────────────────────┬────────┬───────────────────────┬───────┬────────────┐ +│ Rank │ Name │ Id │ Market │ Last │ MultiAsset │ +├──────┼─────────────────────────────┼────────┼───────────────────────┼───────┼────────────┤ +│ 1 │ CoinFLEX (Futures) DFN │ DFN │ CoinFLEX (Futures) │ nan │ None │ +├──────┼─────────────────────────────┼────────┼───────────────────────┼───────┼────────────┤ +│ 2 │ Perpetual Protocol ZIL │ ZIL │ Perpetual Protocol │ 0.11 │ None │ +├──────┼─────────────────────────────┼────────┼───────────────────────┼───────┼────────────┤ +│ 3 │ Bibox (Futures) LINK │ LINK │ Bibox (Futures) │ 0.11 │ None │ +├──────┼─────────────────────────────┼────────┼───────────────────────┼───────┼────────────┤ +│ 4 │ CME Bitcoin Futures BTC │ BTC │ CME Group │ 0.11 │ False │ +├──────┼─────────────────────────────┼────────┼───────────────────────┼───────┼────────────┤ +│ 5 │ Bibox (Futures) XRP │ XRP │ Bibox (Futures) │ 0.11 │ None │ +├──────┼─────────────────────────────┼────────┼───────────────────────┼───────┼────────────┤ +│ 6 │ Bibox (Futures) AXS │ AXS │ Bibox (Futures) │ 0.11 │ None │ +├──────┼─────────────────────────────┼────────┼───────────────────────┼───────┼────────────┤ +│ 7 │ ZBG Futures BSV │ BSV │ ZBG Futures │ 0.11 │ None │ +├──────┼─────────────────────────────┼────────┼───────────────────────┼───────┼────────────┤ +│ 8 │ MEXC Global (Futures) ATLAS │ ATLAS │ MEXC Global (Futures) │ 4.54 │ None │ +├──────┼─────────────────────────────┼────────┼───────────────────────┼───────┼────────────┤ +│ 9 │ CoinFLEX (Futures) BCHABC │ BCHABC │ CoinFLEX (Futures) │ 0.00 │ None │ +├──────┼─────────────────────────────┼────────┼───────────────────────┼───────┼────────────┤ +│ 10 │ Prime XBT USDC │ USDC │ Prime XBT │ 0.00 │ None │ +├──────┼─────────────────────────────┼────────┼───────────────────────┼───────┼────────────┤ +│ 11 │ Poloniex Futures AXS │ AXS │ Poloniex Futures │ 60.56 │ None │ +├──────┼─────────────────────────────┼────────┼───────────────────────┼───────┼────────────┤ +│ 12 │ Bibox (Futures) ETC │ ETC │ Bibox (Futures) │ 60.56 │ None │ +├──────┼─────────────────────────────┼────────┼───────────────────────┼───────┼────────────┤ +│ 13 │ MyCoinStory SUN │ SUN │ MCS │ 13.41 │ None │ +├──────┼─────────────────────────────┼────────┼───────────────────────┼───────┼────────────┤ +│ 14 │ dYdX │ DYDX │ FTX (Derivatives) │ 7.57 │ None │ +├──────┼─────────────────────────────┼────────┼───────────────────────┼───────┼────────────┤ +│ 15 │ Ronin │ RON │ FTX (Derivatives) │ 2.83 │ False │ +└──────┴─────────────────────────────┴────────┴───────────────────────┴───────┴────────────┘ +``` +--- diff --git a/website/content/terminal/reference/crypto/ov/info.md b/website/content/terminal/reference/crypto/ov/info.md new file mode 100644 index 000000000000..11255bc4f73f --- /dev/null +++ b/website/content/terminal/reference/crypto/ov/info.md @@ -0,0 +1,107 @@ +--- +title: info +description: This page documents the usage of the CoinPaprika API, showing basic coin + information, stating its parameters, and demonstrating how to sort and display information. + It is a comprehensive guide for those seeking knowledge about crypto and financial + data. +keywords: +- docusaurus +- metadata +- coin information +- CoinPaprika API +- sort data +- rank +- name +- symbol +- price +- volume_24h +- circulating_supply +- total_supply +- max_supply +- market_cap +- beta_value +- ath_price +- parameters +- quoted currency +- crypto +- financial data +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Show basic coin information for all coins from CoinPaprika API You can display only N number of coins with --limit parameter. You can sort data by rank, name, symbol, price, volume_24h, circulating_supply, total_supply, max_supply, market_cap, beta_value, ath_price --sortby parameter and also with --reverse flag to sort descending. Displays: rank, name, symbol, price, volume_24h, circulating_supply, total_supply, max_supply, market_cap, beta_value, ath_price + +### Usage + +```python +info [--vs {BTC,ETH,USD,EUR,PLN,KRW,GBP,CAD,JPY,RUB,TRY,NZD,AUD,CHF,UAH,HKD,SGD,NGN,PHP,MXN,BRL,THB,CLP,CNY,CZK,DKK,HUF,IDR,ILS,INR,MYR,NOK,PKR,SEK,TWD,ZAR,VND,BOB,COP,PEN,ARS,ISK}] [-l LIMIT] [-s {rank,name,symbol,price,volume_24h,circulating_supply,total_supply,max_supply,ath_price,market_cap,beta_value}] [-r] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| vs | Quoted currency. Default USD | USD | True | BTC, ETH, USD, EUR, PLN, KRW, GBP, CAD, JPY, RUB, TRY, NZD, AUD, CHF, UAH, HKD, SGD, NGN, PHP, MXN, BRL, THB, CLP, CNY, CZK, DKK, HUF, IDR, ILS, INR, MYR, NOK, PKR, SEK, TWD, ZAR, VND, BOB, COP, PEN, ARS, ISK | +| limit | display N number records | 20 | True | None | +| sortby | Sort by given column. Default: rank | rank | True | rank, name, symbol, price, volume_24h, circulating_supply, total_supply, max_supply, ath_price, market_cap, beta_value | +| reverse | Data is sorted in ascending order by default. Reverse flag will sort it in an descending way. Only works when raw data is displayed. | False | True | None | + + +--- + +## Examples + +```python +2022 Feb 15, 08:18 (🦋) /crypto/ov/ $ info + +Displaying data vs USD + Basic Coin Information +┌──────┬───────────────────────────┬────────────┬────────┬────────────┬────────────────────┬──────────────┬────────────┬────────────┬────────────┬───────────┐ +│ rank │ name │ symbol │ price │ volume_24h │ circulating_supply │ total_supply │ max_supply │ market_cap │ beta_value │ ath_price │ +├──────┼───────────────────────────┼────────────┼────────┼────────────┼────────────────────┼──────────────┼────────────┼────────────┼────────────┼───────────┤ +│ 0 │ ZcCoin │ ZCC │ 0.004 │ 1.249 K │ 0 │ 0 │ 0 │ 0 │ 0.222 │ 0.014 │ +├──────┼───────────────────────────┼────────────┼────────┼────────────┼────────────────────┼──────────────┼────────────┼────────────┼────────────┼───────────┤ +│ 0 │ Icolcoin │ ICOL │ 0.011 │ 0.000 │ 0 │ 20.234 M │ 0 │ 0 │ -0.090 │ 1.099 │ +├──────┼───────────────────────────┼────────────┼────────┼────────────┼────────────────────┼──────────────┼────────────┼────────────┼────────────┼───────────┤ +│ 0 │ Poodle Dog Coin │ POODLE DOG │ 0.000 │ 635.137 │ 0 │ 0 │ 0 │ 0 │ 0 │ nan │ +├──────┼───────────────────────────┼────────────┼────────┼────────────┼────────────────────┼──────────────┼────────────┼────────────┼────────────┼───────────┤ +│ 0 │ REDANCOIN │ REDAN │ 0.006 │ 396.232 │ 0 │ 0 │ 0 │ 0 │ 0.967 │ 0.017 │ +├──────┼───────────────────────────┼────────────┼────────┼────────────┼────────────────────┼──────────────┼────────────┼────────────┼────────────┼───────────┤ +│ 0 │ Fado Go │ FADO │ 0.010 │ 10.257 M │ 0 │ 1 B │ 0 │ 0 │ 9.635 │ 0.021 │ +├──────┼───────────────────────────┼────────────┼────────┼────────────┼────────────────────┼──────────────┼────────────┼────────────┼────────────┼───────────┤ +│ 0 │ OK Fly │ OKFLY │ 0.000 │ 178.900 │ 0 │ 0 │ 0 │ 0 │ 1.004 │ 0.000 │ +├──────┼───────────────────────────┼────────────┼────────┼────────────┼────────────────────┼──────────────┼────────────┼────────────┼────────────┼───────────┤ +│ 0 │ Leonardo SPA │ LDO │ 7.623 │ 53.360 │ 0 │ 0 │ 426.388 K │ 650.063 K │ 0.040 │ 8.860 │ +├──────┼───────────────────────────┼────────────┼────────┼────────────┼────────────────────┼──────────────┼────────────┼────────────┼────────────┼───────────┤ +│ 0 │ HappyDoge │ HAPPYDOGE │ 0.000 │ 56.544 │ 0 │ 0 │ 0 │ 0 │ 2.840 │ 0.000 │ +├──────┼───────────────────────────┼────────────┼────────┼────────────┼────────────────────┼──────────────┼────────────┼────────────┼────────────┼───────────┤ +│ 0 │ Hyper DAO │ HDAO │ 0.030 │ 4.797 │ 0 │ 0 │ 0 │ 0 │ 0.021 │ 0.031 │ +├──────┼───────────────────────────┼────────────┼────────┼────────────┼────────────────────┼──────────────┼────────────┼────────────┼────────────┼───────────┤ +│ 0 │ SweetGirl │ SWTG │ 0.001 │ 16.067 │ 0 │ 0 │ 0 │ 0 │ 1.435 │ 0.001 │ +├──────┼───────────────────────────┼────────────┼────────┼────────────┼────────────────────┼──────────────┼────────────┼────────────┼────────────┼───────────┤ +│ 0 │ Gaj Finance │ GAJ │ 0.047 │ 598.888 │ 1.941 M │ 1.941 M │ 0 │ 90.617 K │ 1.357 │ 0.568 │ +├──────┼───────────────────────────┼────────────┼────────┼────────────┼────────────────────┼──────────────┼────────────┼────────────┼────────────┼───────────┤ +│ 0 │ Noachis Terra │ NTT │ 0.000 │ 1.263 │ 0 │ 0 │ 0 │ 0 │ -2.052 │ 0.000 │ +├──────┼───────────────────────────┼────────────┼────────┼────────────┼────────────────────┼──────────────┼────────────┼────────────┼────────────┼───────────┤ +│ 0 │ Connect Coin │ XCON │ 0.000 │ 25.370 │ 38.997 M │ 70 M │ 0 │ 10.359 K │ 0.863 │ 0.696 │ +├──────┼───────────────────────────┼────────────┼────────┼────────────┼────────────────────┼──────────────┼────────────┼────────────┼────────────┼───────────┤ +│ 0 │ ECOSCU │ ECU │ 0.003 │ 21.205 │ 0 │ 0 │ 0 │ 0 │ 1.376 │ 0.004 │ +├──────┼───────────────────────────┼────────────┼────────┼────────────┼────────────────────┼──────────────┼────────────┼────────────┼────────────┼───────────┤ +│ 0 │ Under Armour Cl A │ UAA │ 17.190 │ 429.750 │ 0 │ 236.518 K │ 236.518 K │ 0 │ 0.181 │ 27.140 │ +├──────┼───────────────────────────┼────────────┼────────┼────────────┼────────────────────┼──────────────┼────────────┼────────────┼────────────┼───────────┤ +│ 0 │ Multiplier │ MXX │ 0.007 │ 902.638 │ 137.665 M │ 186.586 M │ 0 │ 946.127 K │ 0.793 │ 0.014 │ +├──────┼───────────────────────────┼────────────┼────────┼────────────┼────────────────────┼──────────────┼────────────┼────────────┼────────────┼───────────┤ +│ 0 │ SmartPad │ PAD │ 0.017 │ 4.454 K │ 0 │ 1 B │ 0 │ 0 │ 1.159 │ 0.043 │ +├──────┼───────────────────────────┼────────────┼────────┼────────────┼────────────────────┼──────────────┼────────────┼────────────┼────────────┼───────────┤ +│ 0 │ Home Coin │ HOME │ 0.000 │ 23.056 │ 0 │ 0 │ 0 │ 0 │ 0.853 │ 0.000 │ +├──────┼───────────────────────────┼────────────┼────────┼────────────┼────────────────────┼──────────────┼────────────┼────────────┼────────────┼───────────┤ +│ 0 │ Teva Pharma Ind Adr Rep 1 │ TEVA │ 8.455 │ 8.455 │ 0 │ 317.460 K │ 317.460 K │ 0 │ 0.101 │ 13.210 │ +├──────┼───────────────────────────┼────────────┼────────┼────────────┼────────────────────┼──────────────┼────────────┼────────────┼────────────┼───────────┤ +│ 0 │ Virtual Quest Room Coin │ VQR │ 0.010 │ 0.965 │ 0 │ 567.838 K │ 52.560 M │ 0 │ 1.417 │ 0.055 │ +└──────┴───────────────────────────┴────────────┴────────┴────────────┴────────────────────┴──────────────┴────────────┴────────────┴────────────┴───────────┘ +``` +--- diff --git a/website/content/terminal/reference/crypto/ov/markets.md b/website/content/terminal/reference/crypto/ov/markets.md new file mode 100644 index 000000000000..3b63a75ce58c --- /dev/null +++ b/website/content/terminal/reference/crypto/ov/markets.md @@ -0,0 +1,92 @@ +--- +title: markets +description: Explore market-related coin information such as price, supply, and volume + for all digital currencies on CoinPaprika. Customize the number of coins to be displayed + and sort data by various parameters such as rank, price, and volume. Ideal for cryptocurrency + analysis and comparison. +keywords: +- market data +- coin data +- coin information +- coin statistics +- php market +- cryptocurrency +- cryptocurrency market +- price data +- supply data +- volume data +- crypto analysis +- market comparison +- crypto ranking +- coin ranking +- crypto price +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Show market related (price, supply, volume) coin information for all coins on CoinPaprika. You can display only N number of coins with --limit parameter. You can sort data by rank, name, symbol, price, volume_24h, mcap_change_24h, pct_change_1h, pct_change_24h, ath_price, pct_from_ath, --sortby parameter and also with --reverse flag to sort ascending. Displays: rank, name, symbol, price, volume_24h, mcap_change_24h, pct_change_1h, pct_change_24h, ath_price, pct_from_ath, + +### Usage + +```python +markets [--vs {BTC,ETH,USD,EUR,PLN,KRW,GBP,CAD,JPY,RUB,TRY,NZD,AUD,CHF,UAH,HKD,SGD,NGN,PHP,MXN,BRL,THB,CLP,CNY,CZK,DKK,HUF,IDR,ILS,INR,MYR,NOK,PKR,SEK,TWD,ZAR,VND,BOB,COP,PEN,ARS,ISK}] [-l LIMIT] [-s {rank,name,symbol,price,volume_24h,mcap_change_24h,pct_change_1h,pct_change_24h,ath_price,pct_from_ath}] [-r] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| vs | Quoted currency. Default USD | USD | True | BTC, ETH, USD, EUR, PLN, KRW, GBP, CAD, JPY, RUB, TRY, NZD, AUD, CHF, UAH, HKD, SGD, NGN, PHP, MXN, BRL, THB, CLP, CNY, CZK, DKK, HUF, IDR, ILS, INR, MYR, NOK, PKR, SEK, TWD, ZAR, VND, BOB, COP, PEN, ARS, ISK | +| limit | display N number records | 15 | True | None | +| sortby | Sort by given column. Default: rank | rank | True | rank, name, symbol, price, volume_24h, mcap_change_24h, pct_change_1h, pct_change_24h, ath_price, pct_from_ath | +| reverse | Data is sorted in descending order by default. Reverse flag will sort it in an ascending way. Only works when raw data is displayed. | False | True | None | + + +--- + +## Examples + +```python +2022 Feb 15, 08:19 (🦋) /crypto/ov/ $ markets + +Displaying data vs USD + Basic Market Information +┌──────┬───────────────────┬────────────┬────────┬────────────┬─────────────────┬───────────────┬────────────────┬───────────┬──────────────┐ +│ rank │ name │ symbol │ price │ volume_24h │ mcap_change_24h │ pct_change_1h │ pct_change_24h │ ath_price │ pct_from_ath │ +├──────┼───────────────────┼────────────┼────────┼────────────┼─────────────────┼───────────────┼────────────────┼───────────┼──────────────┤ +│ 0 │ ZcCoin │ ZCC │ 0.004 │ 1.249 K │ 0 │ -0.230 │ -1.290 │ 0.014 │ -72.510 │ +├──────┼───────────────────┼────────────┼────────┼────────────┼─────────────────┼───────────────┼────────────────┼───────────┼──────────────┤ +│ 0 │ Icolcoin │ ICOL │ 0.011 │ 0.000 │ 0 │ -0.040 │ 3.100 │ 1.099 │ -98.990 │ +├──────┼───────────────────┼────────────┼────────┼────────────┼─────────────────┼───────────────┼────────────────┼───────────┼──────────────┤ +│ 0 │ Poodle Dog Coin │ POODLE DOG │ 0.000 │ 635.137 │ 0 │ 0 │ 0 │ nan │ nan │ +├──────┼───────────────────┼────────────┼────────┼────────────┼─────────────────┼───────────────┼────────────────┼───────────┼──────────────┤ +│ 0 │ REDANCOIN │ REDAN │ 0.006 │ 396.232 │ 0 │ -0.040 │ 4.110 │ 0.017 │ -66.030 │ +├──────┼───────────────────┼────────────┼────────┼────────────┼─────────────────┼───────────────┼────────────────┼───────────┼──────────────┤ +│ 0 │ Fado Go │ FADO │ 0.010 │ 10.257 M │ 0 │ 1.250 │ -25.140 │ 0.021 │ -49.900 │ +├──────┼───────────────────┼────────────┼────────┼────────────┼─────────────────┼───────────────┼────────────────┼───────────┼──────────────┤ +│ 0 │ OK Fly │ OKFLY │ 0.000 │ 178.900 │ 0 │ -0.340 │ 0.540 │ 0.000 │ -6.600 │ +├──────┼───────────────────┼────────────┼────────┼────────────┼─────────────────┼───────────────┼────────────────┼───────────┼──────────────┤ +│ 0 │ Leonardo SPA │ LDO │ 7.623 │ 53.360 │ 0 │ -0.260 │ -0.180 │ 8.860 │ -13.930 │ +├──────┼───────────────────┼────────────┼────────┼────────────┼─────────────────┼───────────────┼────────────────┼───────────┼──────────────┤ +│ 0 │ HappyDoge │ HAPPYDOGE │ 0.000 │ 56.544 │ 0 │ -0.210 │ -5 │ 0.000 │ -23.840 │ +├──────┼───────────────────┼────────────┼────────┼────────────┼─────────────────┼───────────────┼────────────────┼───────────┼──────────────┤ +│ 0 │ Hyper DAO │ HDAO │ 0.030 │ 4.797 │ 0 │ -0.230 │ -0.130 │ 0.031 │ -2.500 │ +├──────┼───────────────────┼────────────┼────────┼────────────┼─────────────────┼───────────────┼────────────────┼───────────┼──────────────┤ +│ 0 │ SweetGirl │ SWTG │ 0.001 │ 16.067 │ 0 │ -0.210 │ 6.340 │ 0.001 │ -1 │ +├──────┼───────────────────┼────────────┼────────┼────────────┼─────────────────┼───────────────┼────────────────┼───────────┼──────────────┤ +│ 0 │ Gaj Finance │ GAJ │ 0.047 │ 598.888 │ 5.090 │ 0.280 │ 5.090 │ 0.568 │ -91.780 │ +├──────┼───────────────────┼────────────┼────────┼────────────┼─────────────────┼───────────────┼────────────────┼───────────┼──────────────┤ +│ 0 │ Noachis Terra │ NTT │ 0.000 │ 1.263 │ 0 │ -0.210 │ 6.250 │ 0.000 │ -85.260 │ +├──────┼───────────────────┼────────────┼────────┼────────────┼─────────────────┼───────────────┼────────────────┼───────────┼──────────────┤ +│ 0 │ Connect Coin │ XCON │ 0.000 │ 25.370 │ -2.620 │ -0.040 │ -2.620 │ 0.696 │ -99.960 │ +├──────┼───────────────────┼────────────┼────────┼────────────┼─────────────────┼───────────────┼────────────────┼───────────┼──────────────┤ +│ 0 │ ECOSCU │ ECU │ 0.003 │ 21.205 │ 0 │ -0.210 │ 1.680 │ 0.004 │ -23.090 │ +├──────┼───────────────────┼────────────┼────────┼────────────┼─────────────────┼───────────────┼────────────────┼───────────┼──────────────┤ +│ 0 │ Under Armour Cl A │ UAA │ 17.190 │ 429.750 │ 0 │ 0 │ -1.770 │ 27.140 │ -36.660 │ +└──────┴───────────────────┴────────────┴────────┴────────────┴─────────────────┴───────────────┴────────────────┴───────────┴──────────────┘ +``` +--- diff --git a/website/content/terminal/reference/crypto/ov/news.md b/website/content/terminal/reference/crypto/ov/news.md new file mode 100644 index 000000000000..e77fb4bc2a39 --- /dev/null +++ b/website/content/terminal/reference/crypto/ov/news.md @@ -0,0 +1,45 @@ +--- +title: news +description: This page provides usage details for a news aggregation code from CryptoPanic, + involving handy functions such as data filtering, sorting, region based displaying + and more. Learn how to get the crypto news you need quickly and efficiently. +keywords: +- cryptopanic +- crypto news +- news aggregation +- data filtering +- region based +- sorted data +- bullish news +- bearish news +- crypto media +- cryptocurrency +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Display recent news from CryptoPanic aggregator platform. [Source: https://cryptopanic.com/] + +### Usage + +```python +news [-l LIMIT] [-k {news,media}] [--filter {rising,hot,bullish,bearish,important,saved,lol}] [-r {en,de,es,fr,nl,it,pt,ru}] [-s {published_at,domain,title,negative_votes,positive_votes}] [--reverse] [-u] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| limit | display N number records | 20 | True | None | +| kind | Filter by category of news. Available values: news or media. | news | True | news, media | +| filter | Filter by kind of news. One from list: rising|hot|bullish|bearish|important|saved|lol | None | True | rising, hot, bullish, bearish, important, saved, lol | +| region | Filter news by regions. Available regions are: en (English), de (Deutsch), nl (Dutch), es (Español), fr (Français), it (Italiano), pt (Português), ru (Русский) | en | True | en, de, es, fr, nl, it, pt, ru | +| sortby | Sort by given column. Default: published_at | published_at | True | published_at, domain, title, negative_votes, positive_votes | +| reverse | Data is sorted in descending order by default. Reverse flag will sort it in an ascending way. Only works when raw data is displayed. | False | True | None | +| urls | Flag to show urls column. | False | True | None | + +--- diff --git a/website/content/terminal/reference/crypto/ov/pairs.md b/website/content/terminal/reference/crypto/ov/pairs.md new file mode 100644 index 000000000000..575b496cc826 --- /dev/null +++ b/website/content/terminal/reference/crypto/ov/pairs.md @@ -0,0 +1,81 @@ +--- +title: pairs +description: The page gives a detailed overview on how to use the 'pairs' function + for showing available trading pairs on Coinbase. It includes usage code, parameters + description, and some examples. +keywords: +- pairs function +- Coinbase +- trading pairs +- function usage +- parameters description +- crypto trading +- base_currency +- quote_currency +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Shows available trading pairs on Coinbase + +### Usage + +```python +pairs [-l LIMIT] [-s {id,display_name,base_currency,quote_currency,base_min_size,base_max_size,min_market_funds,max_market_funds}] [-r] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| limit | display N number of pairs =10 | 15 | True | None | +| sortby | Sort by given column. Default: id | id | True | id, display_name, base_currency, quote_currency, base_min_size, base_max_size, min_market_funds, max_market_funds | +| reverse | Data is sorted in ascending order by default. Reverse flag will sort it in an descending way. Only works when raw data is displayed. | False | True | None | + + +--- + +## Examples + +```python +2022 Feb 15, 08:09 (🦋) /crypto/ov/ $ pairs + Available Pairs for Trading +┌───────────┬──────────────┬───────────────┬────────────────┬───────────────┬───────────────┬──────────────────┬──────────────────┐ +│ id │ display_name │ base_currency │ quote_currency │ base_min_size │ base_max_size │ min_market_funds │ max_market_funds │ +├───────────┼──────────────┼───────────────┼────────────────┼───────────────┼───────────────┼──────────────────┼──────────────────┤ +│ 1INCH-BTC │ 1INCH/BTC │ 1INCH │ BTC │ 0.23 │ 91 K │ 0.000016 │ 10 │ +├───────────┼──────────────┼───────────────┼────────────────┼───────────────┼───────────────┼──────────────────┼──────────────────┤ +│ 1INCH-EUR │ 1INCH/EUR │ 1INCH │ EUR │ 0.22 │ 88 K │ 0.84 │ 170 K │ +├───────────┼──────────────┼───────────────┼────────────────┼───────────────┼───────────────┼──────────────────┼──────────────────┤ +│ 1INCH-GBP │ 1INCH/GBP │ 1INCH │ GBP │ 0.23 │ 90 K │ 0.72 │ 150 K │ +├───────────┼──────────────┼───────────────┼────────────────┼───────────────┼───────────────┼──────────────────┼──────────────────┤ +│ 1INCH-USD │ 1INCH/USD │ 1INCH │ USD │ 0.23 │ 320 K │ 1 │ 710 K │ +├───────────┼──────────────┼───────────────┼────────────────┼───────────────┼───────────────┼──────────────────┼──────────────────┤ +│ AAVE-BTC │ AAVE/BTC │ AAVE │ BTC │ 0.003 │ 2.500 K │ 0.000016 │ 13 │ +├───────────┼──────────────┼───────────────┼────────────────┼───────────────┼───────────────┼──────────────────┼──────────────────┤ +│ AAVE-EUR │ AAVE/EUR │ AAVE │ EUR │ 0.003 │ 2.400 K │ 0.84 │ 470 K │ +├───────────┼──────────────┼───────────────┼────────────────┼───────────────┼───────────────┼──────────────────┼──────────────────┤ +│ AAVE-GBP │ AAVE/GBP │ AAVE │ GBP │ 0.003 │ 1.500 K │ 0.72 │ 240 K │ +├───────────┼──────────────┼───────────────┼────────────────┼───────────────┼───────────────┼──────────────────┼──────────────────┤ +│ AAVE-USD │ AAVE/USD │ AAVE │ USD │ 0.003 │ 8.900 K │ 1 │ 2 M │ +├───────────┼──────────────┼───────────────┼────────────────┼───────────────┼───────────────┼──────────────────┼──────────────────┤ +│ ACH-USD │ ACH/USD │ ACH │ USD │ 11 │ 20 M │ 1 │ 1.100 M │ +├───────────┼──────────────┼───────────────┼────────────────┼───────────────┼───────────────┼──────────────────┼──────────────────┤ +│ ADA-BTC │ ADA/BTC │ ADA │ BTC │ 0.5 │ 820 K │ 0.000016 │ 27 │ +├───────────┼──────────────┼───────────────┼────────────────┼───────────────┼───────────────┼──────────────────┼──────────────────┤ +│ ADA-ETH │ ADA/ETH │ ADA │ ETH │ 0.5 │ 660 K │ 0.00022 │ 290 │ +├───────────┼──────────────┼───────────────┼────────────────┼───────────────┼───────────────┼──────────────────┼──────────────────┤ +│ ADA-EUR │ ADA/EUR │ ADA │ EUR │ 0.48 │ 880 K │ 0.84 │ 1.100 M │ +├───────────┼──────────────┼───────────────┼────────────────┼───────────────┼───────────────┼──────────────────┼──────────────────┤ +│ ADA-GBP │ ADA/GBP │ ADA │ GBP │ 0.49 │ 640 K │ 0.72 │ 650 K │ +├───────────┼──────────────┼───────────────┼────────────────┼───────────────┼───────────────┼──────────────────┼──────────────────┤ +│ ADA-USD │ ADA/USD │ ADA │ USD │ 0.5 │ 3.600 M │ 1 │ 5 M │ +├───────────┼──────────────┼───────────────┼────────────────┼───────────────┼───────────────┼──────────────────┼──────────────────┤ +│ ADA-USDC │ ADA/USDC │ ADA │ USDC │ 0.5 │ 580 K │ 1 │ 800 K │ +└───────────┴──────────────┴───────────────┴────────────────┴───────────────┴───────────────┴──────────────────┴──────────────────┘ +``` +--- diff --git a/website/content/terminal/reference/crypto/ov/platforms.md b/website/content/terminal/reference/crypto/ov/platforms.md new file mode 100644 index 000000000000..ac9cb331c84b --- /dev/null +++ b/website/content/terminal/reference/crypto/ov/platforms.md @@ -0,0 +1,135 @@ +--- +title: platforms +description: This page lists out the platforms for smart contract including Ethereum, + Solana, Cosmos, Polkadot, Kusama. It helps users understand the command-line interfaces + to engage with these diverse smart contract platforms. +keywords: +- smart contract platforms +- ethereum +- solana +- cosmos +- polkadot +- kusama +- crypto platforms +- blockchain technology +- docusaurus SEO +- keywords generation +- content-related keywords +- blockchain platforms +- cryptocurrency SEO +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +List all smart contract platforms like ethereum, solana, cosmos, polkadot, kusama + +### Usage + +```python +platforms +``` + +--- + +## Parameters + +This command has no parameters + + + +--- + +## Examples + +```python +2022 Feb 15, 08:19 (🦋) /crypto/ov/ $ platforms + Smart Contract Platforms +┌───────┬───────────────────────────┐ +│ index │ platform_id │ +├───────┼───────────────────────────┤ +│ 1 │ btc-bitcoin │ +├───────┼───────────────────────────┤ +│ 2 │ eos-eos │ +├───────┼───────────────────────────┤ +│ 3 │ eth-ethereum │ +├───────┼───────────────────────────┤ +│ 4 │ xrp-xrp │ +├───────┼───────────────────────────┤ +│ 5 │ bch-bitcoin-cash │ +├───────┼───────────────────────────┤ +│ 6 │ xem-nem │ +├───────┼───────────────────────────┤ +│ 7 │ neo-neo │ +├───────┼───────────────────────────┤ +│ 8 │ xlm-stellar │ +├───────┼───────────────────────────┤ +│ 9 │ etc-ethereum-classic │ +├───────┼───────────────────────────┤ +│ 10 │ qtum-qtum │ +├───────┼───────────────────────────┤ +│ 11 │ zec-zcash │ +├───────┼───────────────────────────┤ +│ 12 │ vet-vechain │ +├───────┼───────────────────────────┤ +│ 13 │ bts-bitshares │ +├───────┼───────────────────────────┤ +│ 14 │ waves-waves │ +├───────┼───────────────────────────┤ +│ 15 │ nxt-nxt │ +├───────┼───────────────────────────┤ +│ 16 │ act-achain │ +├───────┼───────────────────────────┤ +│ 17 │ ubq-ubiq │ +├───────┼───────────────────────────┤ +│ 18 │ xcp-counterparty │ +├───────┼───────────────────────────┤ +│ 19 │ html-htmlcoin │ +├───────┼───────────────────────────┤ +│ 20 │ etp-metaverse-etp │ +├───────┼───────────────────────────┤ +│ 21 │ signa-signa │ +├───────┼───────────────────────────┤ +│ 22 │ omni-omni │ +├───────┼───────────────────────────┤ +│ 23 │ trx-tron │ +├───────┼───────────────────────────┤ +│ 24 │ bnb-binance-coin │ +├───────┼───────────────────────────┤ +│ 25 │ ardr-ardor │ +├───────┼───────────────────────────┤ +│ 26 │ ht-huobi-token │ +├───────┼───────────────────────────┤ +│ 27 │ ftm-fantom │ +├───────┼───────────────────────────┤ +│ 28 │ matic-polygon │ +├───────┼───────────────────────────┤ +│ 29 │ avax-avalanche │ +├───────┼───────────────────────────┤ +│ 30 │ sol-solana │ +├───────┼───────────────────────────┤ +│ 31 │ blvr-believer │ +├───────┼───────────────────────────┤ +│ 32 │ cake-pancakeswap │ +├───────┼───────────────────────────┤ +│ 33 │ fsxu-flashx-ultra │ +├───────┼───────────────────────────┤ +│ 34 │ chik-chickenkebab-finance │ +├───────┼───────────────────────────┤ +│ 35 │ jgn-juggernaut7492 │ +├───────┼───────────────────────────┤ +│ 36 │ crx-cryptex │ +├───────┼───────────────────────────┤ +│ 37 │ whirl-whirl-finance │ +├───────┼───────────────────────────┤ +│ 38 │ eubi-eubi-token │ +├───────┼───────────────────────────┤ +│ 39 │ swam-swapmatic-token │ +├───────┼───────────────────────────┤ +│ 40 │ shells-shells │ +├───────┼───────────────────────────┤ +│ 41 │ slx-solex-finance │ +└───────┴───────────────────────────┘ +``` +--- diff --git a/website/content/terminal/reference/crypto/ov/stables.md b/website/content/terminal/reference/crypto/ov/stables.md new file mode 100644 index 000000000000..1fc2f33920dc --- /dev/null +++ b/website/content/terminal/reference/crypto/ov/stables.md @@ -0,0 +1,85 @@ +--- +title: stables +description: This page offers detailed information about stablecoins ranked by market + capitalization. It explains the usage and parameters of the 'stables' command to + sort and display relevant data about different stablecoins. +keywords: +- Stablecoins +- Market Capitalization +- Cryptocurrency +- US Dollar +- Gold +- Parameters +- Data Display +- Sorting Data +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Shows stablecoins by market capitalization. Stablecoins are cryptocurrencies that attempt to peg their market value to some external reference like the U.S. dollar or to a commodity's price such as gold. You can display only N number of coins with --limit parameter. You can sort data by {} with --sortby + +### Usage + +```python +stables [-l LIMIT] [-s {Symbol,Name,Price_[$],Market_Cap_[$],Market_Cap_Rank,Change_7d_[%],Change_24h_[%],Volume_[$]}] [-r] [--pie] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| limit | display N number records | 15 | True | None | +| sortby | Sort by given column. Default: market_cap | Market_Cap_[$] | True | Symbol, Name, Price_[$], Market_Cap_[$], Market_Cap_Rank, Change_7d_[%], Change_24h_[%], Volume_[$] | +| reverse | Data is sorted in descending order by default. Reverse flag will sort it in an ascending way. Only works when raw data is displayed. | False | True | None | +| pie | Flag to show pie chart | False | True | None | + + +--- + +## Examples + +```python +2022 Feb 15, 08:16 (🦋) /crypto/ov/ $ stables + +First 15 stablecoins have a total 182.582 B dollars of market cap. + + Stablecoin Data +┌─────────┬──────────────────────┬───────────┬────────────────┬─────────────────┬────────────────┬───────────────┬────────────┬──────────────────────────┐ +│ Symbol │ Name │ Price [$] │ Market Cap [$] │ Market Cap Rank │ Change 24h [%] │ Change 7d [%] │ Volume [$] │ Percentage [%] of top 15 │ +├─────────┼──────────────────────┼───────────┼────────────────┼─────────────────┼────────────────┼───────────────┼────────────┼──────────────────────────┤ +│ usdt │ Tether │ 1.001 │ 78.556 B │ 3 │ -0.014 │ -0.063 │ 43.035 B │ 43.025 │ +├─────────┼──────────────────────┼───────────┼────────────────┼─────────────────┼────────────────┼───────────────┼────────────┼──────────────────────────┤ +│ usdc │ USD Coin │ 1 │ 52.519 B │ 5 │ 0.120 │ -0.052 │ 2.976 B │ 28.765 │ +├─────────┼──────────────────────┼───────────┼────────────────┼─────────────────┼────────────────┼───────────────┼────────────┼──────────────────────────┤ +│ busd │ Binance USD │ 1.001 │ 17.557 B │ 13 │ 0.041 │ -0.105 │ 3.124 B │ 9.616 │ +├─────────┼──────────────────────┼───────────┼────────────────┼─────────────────┼────────────────┼───────────────┼────────────┼──────────────────────────┤ +│ ust │ TerraUSD │ 1.001 │ 11.616 B │ 17 │ 0.132 │ -0.053 │ 318.818 M │ 6.362 │ +├─────────┼──────────────────────┼───────────┼────────────────┼─────────────────┼────────────────┼───────────────┼────────────┼──────────────────────────┤ +│ dai │ Dai │ 1.001 │ 9.820 B │ 19 │ 0.069 │ 0.059 │ 237.136 M │ 5.378 │ +├─────────┼──────────────────────┼───────────┼────────────────┼─────────────────┼────────────────┼───────────────┼────────────┼──────────────────────────┤ +│ mim │ Magic Internet Money │ 1.001 │ 2.788 B │ 51 │ 0.419 │ 0.107 │ 42.304 M │ 1.527 │ +├─────────┼──────────────────────┼───────────┼────────────────┼─────────────────┼────────────────┼───────────────┼────────────┼──────────────────────────┤ +│ frax │ Frax │ 1.001 │ 2.660 B │ 53 │ 0.553 │ -0.490 │ 25.748 M │ 1.457 │ +├─────────┼──────────────────────┼───────────┼────────────────┼─────────────────┼────────────────┼───────────────┼────────────┼──────────────────────────┤ +│ tusd │ TrueUSD │ 1.001 │ 1.487 B │ 80 │ 0.014 │ 0.017 │ 92.185 M │ 0.814 │ +├─────────┼──────────────────────┼───────────┼────────────────┼─────────────────┼────────────────┼───────────────┼────────────┼──────────────────────────┤ +│ usdp │ Pax Dollar │ 1.001 │ 1.034 B │ 100 │ -0.164 │ -0.003 │ 13.857 M │ 0.566 │ +├─────────┼──────────────────────┼───────────┼────────────────┼─────────────────┼────────────────┼───────────────┼────────────┼──────────────────────────┤ +│ fei │ Fei USD │ 1.002 │ 556.435 M │ 147 │ 0.248 │ -0.048 │ 14.805 M │ 0.305 │ +├─────────┼──────────────────────┼───────────┼────────────────┼─────────────────┼────────────────┼───────────────┼────────────┼──────────────────────────┤ +│ lusd │ Liquity USD │ 1.010 │ 498.292 M │ 159 │ 0.210 │ 0.038 │ 6.557 M │ 0.273 │ +├─────────┼──────────────────────┼───────────┼────────────────┼─────────────────┼────────────────┼───────────────┼────────────┼──────────────────────────┤ +│ usdn │ Neutrino USD │ 0.999 │ 443.663 M │ 169 │ 1.023 │ 0.073 │ 11.068 M │ 0.243 │ +├─────────┼──────────────────────┼───────────┼────────────────┼─────────────────┼────────────────┼───────────────┼────────────┼──────────────────────────┤ +│ xaut │ Tether Gold │ 1.851 K │ 418.617 M │ 173 │ 2.029 │ -0.250 │ 4.853 M │ 0.229 │ +├─────────┼──────────────────────┼───────────┼────────────────┼─────────────────┼────────────────┼───────────────┼────────────┼──────────────────────────┤ +│ mimatic │ MAI │ 0.999 │ 264.095 M │ 235 │ 0.043 │ 0.085 │ 3.754 M │ 0.145 │ +├─────────┼──────────────────────┼───────────┼────────────────┼─────────────────┼────────────────┼───────────────┼────────────┼──────────────────────────┤ +│ husd │ HUSD │ 1.005 │ 263.061 M │ 236 │ 0.686 │ 0.524 │ 35.886 M │ 0.144 │ +└─────────┴──────────────────────┴───────────┴────────────────┴─────────────────┴────────────────┴───────────────┴────────────┴──────────────────────────┘ +``` +--- diff --git a/website/content/terminal/reference/crypto/ov/wf.md b/website/content/terminal/reference/crypto/ov/wf.md new file mode 100644 index 000000000000..5b3d99c4bba8 --- /dev/null +++ b/website/content/terminal/reference/crypto/ov/wf.md @@ -0,0 +1,78 @@ +--- +title: wf +description: The documentation page contains information regarding the withdrawal + fees for top coins in cryptocurrency. It provides a detailed insight into the average, + median and highest withdrawal fees for coins such as Bitcoin, Ethereum and Tether + among others. The tool also allows to limit the number of coins while displaying + the withdrawal fees. +keywords: +- withdrawal fees +- top coins +- cryptocurrency +- Bitcoin +- Ethereum +- Tether +- Binance Coin +- USD Coin +- XRP +- Cardano +- Solana +- Terra +- Avalanche +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Display top coins withdrawal fees [Source: https://withdrawalfees.com/] + +### Usage + +```python +wf [-l LIMIT] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| limit | Limit number of coins to display withdrawal fees. Default 10 | 10 | True | None | + + +--- + +## Examples + +```python +2022 Feb 15, 08:21 (🦋) /crypto/ov/ $ wf + +Withdrawal fees on exchanges: + Top Withdrawal Fees +┌──────────────┬──────────────┬─────────┬────────┬──────────────────────┬────────────────────┐ +│ Coin │ Lowest │ Average │ Median │ Highest │ Exchanges Compared │ +├──────────────┼──────────────┼─────────┼────────┼──────────────────────┼────────────────────┤ +│ Bitcoin │ FREE │ $20.01 │ $22.13 │ $66.40 (0.0015 BTC) │ 38 │ +├──────────────┼──────────────┼─────────┼────────┼──────────────────────┼────────────────────┤ +│ Ethereum │ FREE │ $22.54 │ $19.39 │ $74.48 (0.024 ETH) │ 37 │ +├──────────────┼──────────────┼─────────┼────────┼──────────────────────┼────────────────────┤ +│ Tether │ FREE │ $19.24 │ $15.55 │ $100.00 (100 USDT) │ 30 │ +├──────────────┼──────────────┼─────────┼────────┼──────────────────────┼────────────────────┤ +│ Binance Coin │ FREE │ $4.06 │ $0.64 │ $21.38 (0.05 BNB) │ 16 │ +├──────────────┼──────────────┼─────────┼────────┼──────────────────────┼────────────────────┤ +│ USD Coin │ FREE │ $21.39 │ $19.98 │ $50.96 (51 USDC) │ 27 │ +├──────────────┼──────────────┼─────────┼────────┼──────────────────────┼────────────────────┤ +│ XRP │ FREE │ $1.79 │ $0.21 │ $30.02 (36 XRP) │ 29 │ +├──────────────┼──────────────┼─────────┼────────┼──────────────────────┼────────────────────┤ +│ Cardano │ $0.330.3 ADA │ $6.94 │ $1.08 │ $146.63 (135.14 ADA) │ 26 │ +├──────────────┼──────────────┼─────────┼────────┼──────────────────────┼────────────────────┤ +│ Solana │ FREE │ $1.17 │ $1.02 │ $5.00 (0.049 SOL) │ 18 │ +├──────────────┼──────────────┼─────────┼────────┼──────────────────────┼────────────────────┤ +│ Terra │ FREE │ $4.11 │ $1.13 │ $30.53 (0.54 LUNA) │ 15 │ +├──────────────┼──────────────┼─────────┼────────┼──────────────────────┼────────────────────┤ +│ Avalanche │ FREE │ $1.77 │ $0.88 │ $8.83 (0.1 AVAX) │ 15 │ +└──────────────┴──────────────┴─────────┴────────┴──────────────────────┴────────────────────┘ +``` +--- diff --git a/website/content/terminal/reference/crypto/ov/wfpe.md b/website/content/terminal/reference/crypto/ov/wfpe.md new file mode 100644 index 000000000000..02a3a84045be --- /dev/null +++ b/website/content/terminal/reference/crypto/ov/wfpe.md @@ -0,0 +1,132 @@ +--- +title: wfpe +description: This wfpe documentation page covers the usage of wfpe command to check + cryptocurrency withdrawal fees per exchange. It includes example outputs and parameters. +keywords: +- wfpe +- cryptocurrency withdrawal fee +- coin withdrawal +- crypto withdrawal +- exchange withdrawal fee +- Bitcoin withdrawal +- Ethereum withdrawal +- crypto trading +- crypto exchange guides +- crypto commands +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Coin withdrawal fees per exchange [Source: https://withdrawalfees.com/] + +### Usage + +```python +wfpe [-c COIN] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| coin | Coin to check withdrawal fees in long format (e.g., bitcoin, ethereum) | bitcoin | True | None | + + +--- + +## Examples + +```python +2022 Feb 15, 08:21 (🦋) /crypto/ov/ $ wfpe + + +Withdrawal fees for bitcoin: + +bitcoin is available on 38 exchanges with alowest fee of FREE(0 BTC), average of $20.01(0.0004519 BTC) and median of $22.13(0.0005 BTC) + + Withdrawal Fees per Exchange +┌─────────────────────┬───────────────────────┬───────────────────────────┐ +│ Exchange │ Withdrawal Fee │ Minimum Withdrawal Amount │ +├─────────────────────┼───────────────────────┼───────────────────────────┤ +│ FixedFloat │ FREE │ │ +├─────────────────────┼───────────────────────┼───────────────────────────┤ +│ Deribit │ $0.89 (0.00002 BTC) │ │ +├─────────────────────┼───────────────────────┼───────────────────────────┤ +│ Kraken │ $0.89 (0.00002 BTC) │ $22.13 (0.0005 BTC) │ +├─────────────────────┼───────────────────────┼───────────────────────────┤ +│ OKCoin │ $0.89 (0.00002 BTC) │ │ +├─────────────────────┼───────────────────────┼───────────────────────────┤ +│ CoinEx │ $4.43 (0.0001 BTC) │ $44.27 (0.001 BTC) │ +├─────────────────────┼───────────────────────┼───────────────────────────┤ +│ CoinFalcon │ $4.43 (0.0001 BTC) │ │ +├─────────────────────┼───────────────────────┼───────────────────────────┤ +│ Crypto.com Exchange │ $4.43 (0.0001 BTC) │ $8.85 (0.0002 BTC) │ +├─────────────────────┼───────────────────────┼───────────────────────────┤ +│ Flyp.me │ $4.43 (0.0001 BTC) │ │ +├─────────────────────┼───────────────────────┼───────────────────────────┤ +│ SouthXchange │ $6.64 (0.00015 BTC) │ $8.85 (0.0002 BTC) │ +├─────────────────────┼───────────────────────┼───────────────────────────┤ +│ OKEx │ $8.85 (0.0002 BTC) │ $44.27 (0.001 BTC) │ +├─────────────────────┼───────────────────────┼───────────────────────────┤ +│ Bittrex │ $13.28 (0.0003 BTC) │ │ +├─────────────────────┼───────────────────────┼───────────────────────────┤ +│ Coindeal │ $16.60 (0.000375 BTC) │ │ +├─────────────────────┼───────────────────────┼───────────────────────────┤ +│ Tidex │ $17.71 (0.0004 BTC) │ $22.13 (0.0005 BTC) │ +├─────────────────────┼───────────────────────┼───────────────────────────┤ +│ Bitfinex │ $17.71 (0.0004 BTC) │ │ +├─────────────────────┼───────────────────────┼───────────────────────────┤ +│ DSX │ $17.71 (0.0004 BTC) │ │ +├─────────────────────┼───────────────────────┼───────────────────────────┤ +│ Huobi Global │ $17.71 (0.0004 BTC) │ │ +├─────────────────────┼───────────────────────┼───────────────────────────┤ +│ WhiteBit │ $17.71 (0.0004 BTC) │ $44.27 (0.001 BTC) │ +├─────────────────────┼───────────────────────┼───────────────────────────┤ +│ Liquid │ $22.13 (0.0005 BTC) │ │ +├─────────────────────┼───────────────────────┼───────────────────────────┤ +│ BitForex │ $22.13 (0.0005 BTC) │ $44.27 (0.001 BTC) │ +├─────────────────────┼───────────────────────┼───────────────────────────┤ +│ BitMart │ $22.13 (0.0005 BTC) │ $221.34 (0.005 BTC) │ +├─────────────────────┼───────────────────────┼───────────────────────────┤ +│ Coinsbit │ $22.13 (0.0005 BTC) │ │ +├─────────────────────┼───────────────────────┼───────────────────────────┤ +│ Kucoin │ $22.13 (0.0005 BTC) │ │ +├─────────────────────┼───────────────────────┼───────────────────────────┤ +│ Poloniex │ $22.13 (0.0005 BTC) │ │ +├─────────────────────┼───────────────────────┼───────────────────────────┤ +│ AscendEX │ $22.13 (0.0005 BTC) │ $442.69 (0.01 BTC) │ +├─────────────────────┼───────────────────────┼───────────────────────────┤ +│ Bitkub │ $22.13 (0.0005 BTC) │ │ +├─────────────────────┼───────────────────────┼───────────────────────────┤ +│ Bitrue │ $22.13 (0.0005 BTC) │ │ +├─────────────────────┼───────────────────────┼───────────────────────────┤ +│ BTSE │ $22.13 (0.0005 BTC) │ $44.27 (0.001 BTC) │ +├─────────────────────┼───────────────────────┼───────────────────────────┤ +│ BW │ $22.13 (0.0005 BTC) │ $110.67 (0.0025 BTC) │ +├─────────────────────┼───────────────────────┼───────────────────────────┤ +│ Coincheck │ $22.13 (0.0005 BTC) │ │ +├─────────────────────┼───────────────────────┼───────────────────────────┤ +│ CoinTiger │ $22.13 (0.0005 BTC) │ $442.69 (0.01 BTC) │ +├─────────────────────┼───────────────────────┼───────────────────────────┤ +│ GetBTC │ $22.13 (0.0005 BTC) │ │ +├─────────────────────┼───────────────────────┼───────────────────────────┤ +│ Binance │ $30.55 (0.00069 BTC) │ $61.98 (0.0014 BTC) │ +├─────────────────────┼───────────────────────┼───────────────────────────┤ +│ CREX24 │ $35.42 (0.0008 BTC) │ │ +├─────────────────────┼───────────────────────┼───────────────────────────┤ +│ TOKOK │ $35.42 (0.0008 BTC) │ $44.27 (0.001 BTC) │ +├─────────────────────┼───────────────────────┼───────────────────────────┤ +│ HitBTC │ $39.84 (0.0009 BTC) │ │ +├─────────────────────┼───────────────────────┼───────────────────────────┤ +│ Bleutrade │ $44.27 (0.001 BTC) │ │ +├─────────────────────┼───────────────────────┼───────────────────────────┤ +│ Gate.io │ $44.27 (0.001 BTC) │ $486.96 (0.011 BTC) │ +├─────────────────────┼───────────────────────┼───────────────────────────┤ +│ Coinone │ $66.40 (0.0015 BTC) │ $4.43 (0.0001 BTC) │ +└─────────────────────┴───────────────────────┴───────────────────────────┘ +``` +--- diff --git a/website/content/terminal/reference/crypto/price.md b/website/content/terminal/reference/crypto/price.md new file mode 100644 index 000000000000..fcdb35fcc960 --- /dev/null +++ b/website/content/terminal/reference/crypto/price.md @@ -0,0 +1,38 @@ +--- +title: price +description: This documentation page contains information on how to display the price + and confidence interval of various crypto coins in real-time using Pyth. It features + a table of ~100 available symbols for different coins. Use the provided command + options to load data. +keywords: +- Price display +- Real-time data +- Confidence interval +- Pyth +- Usage +- Parameters +- Symbols +- Crypto coins +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Display price and interval of confidence in real-time. [Source: Pyth] + +### Usage + +```python +price -s SYMBOL +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| symbol | Symbol of coin to load data for, ~100 symbols are available | None | False | AAVE-USD, ADA-USD, ALGO-USD, ANC-USD, APE-USD, ATLAS-USD, ATOM-USD, AVAX-USD, BCH-USD, BETH-USD, BNB-USD, BRZ-USD, BTC-USD, BUSD-USD, C98-USD, COPE-USD, CUSD-USD, DOGE-USD, DOT-USD, ETH-USD, FIDA-USD, FTM-USD, FTT-USD, GMT-USD, GOFX-USD, HXRO-USD, INJ-USD, JET-USD, LTC-USD, LUNA-USD, LUNC-USD, MATIC-USD, MER-USD, MIR-USD, MNGO-USD, MSOL-USD, NEAR-USD, ONE-USD, ORCA-USD, PAI-USD, PORT-USD, RAY-USD, SBR-USD, SCNSOL-USD, SLND-USD, SNY-USD, SOL-USD, SRM-USD, STEP-USD, STSOL-USD, TUSD-USD, USDC-USD, USDT-USD, USTC-USD, VAI-USD, XVS-USD, ZBC-USD | + +--- diff --git a/website/content/terminal/reference/crypto/prt.md b/website/content/terminal/reference/crypto/prt.md new file mode 100644 index 000000000000..9cac73fda785 --- /dev/null +++ b/website/content/terminal/reference/crypto/prt.md @@ -0,0 +1,39 @@ +--- +title: prt +description: The Potential Returns Tool page provides detailed usage and parameter + information for the tool which helps users estimate returns from various cryptocurrencies + if they reach a certain price or market cap. The tool utilizes data from CoinGecko. +keywords: +- Potential Returns Tool +- cryptocurrency +- market cap +- coin data +- CoinGecko +- compare crypto +- crypto price +- top N coins +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Potential Returns ToolTool to check returns if loaded coin reaches provided price or other crypto market capUses CoinGecko to grab coin data (price and market cap). + +### Usage + +```python +prt [--vs VS] [-p PRICE] [-t TOP] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| vs | Coin to compare with | None | True | None | +| price | Desired price | None | True | None | +| top | Compare with top N coins | None | True | None | + +--- diff --git a/website/versioned_docs/version-v3/terminal/reference/crypto/qa/_category_.json b/website/content/terminal/reference/crypto/qa/_category_.json similarity index 100% rename from website/versioned_docs/version-v3/terminal/reference/crypto/qa/_category_.json rename to website/content/terminal/reference/crypto/qa/_category_.json diff --git a/website/content/terminal/reference/crypto/qa/acf.md b/website/content/terminal/reference/crypto/qa/acf.md new file mode 100644 index 000000000000..b054ee72176a --- /dev/null +++ b/website/content/terminal/reference/crypto/qa/acf.md @@ -0,0 +1,39 @@ +--- +title: acf +description: The page provides explanation and usage for acf- the Auto-Correlation + and Partial Auto-Correlation Functions for diff and diff diff crypto data. It includes + parameters details and illustrative plot. +keywords: +- acf +- Auto-Correlation +- Partial Auto-Correlation +- diff +- diff diff +- crypto data +- lags +- plots +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Auto-Correlation and Partial Auto-Correlation Functions for diff and diff diff crypto data + +### Usage + +```python +acf [-l LAGS] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| lags | maximum lags to display in plots | 15 | True | range(5, 100) | + +![acf](https://user-images.githubusercontent.com/46355364/154305242-176c3ba1-ebfc-43e7-a027-46251fb02463.png) + +--- diff --git a/website/content/terminal/reference/crypto/qa/bw.md b/website/content/terminal/reference/crypto/qa/bw.md new file mode 100644 index 000000000000..3c1e44504c2e --- /dev/null +++ b/website/content/terminal/reference/crypto/qa/bw.md @@ -0,0 +1,37 @@ +--- +title: bw +description: This page details the usage of the Box and Whisker (bw) plot with its + parameters. It also includes a guide on how to display a yearly bw plot. +keywords: +- Box and Whisker plot +- bw plot +- parameters +- yearly bw plot +- data visualization +- optional choices +- plot description +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Box and Whisker plot + +### Usage + +```python +bw [-y] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| year | Flag to show yearly bw plot | False | True | None | + +![bw](https://user-images.githubusercontent.com/46355364/154305545-0f99fe4b-07e1-4714-8762-da3569023578.png) + +--- diff --git a/website/content/terminal/reference/crypto/qa/cdf.md b/website/content/terminal/reference/crypto/qa/cdf.md new file mode 100644 index 000000000000..2f72a09e9b65 --- /dev/null +++ b/website/content/terminal/reference/crypto/qa/cdf.md @@ -0,0 +1,50 @@ +--- +title: cdf +description: This page provides detailed information about the 'cdf' function, a cumulative + distribution function. It includes usage, parameters, and examples. +keywords: +- cdf +- cumulative distribution function +- usage +- parameters +- examples +- export +- csv +- json +- xlsx +- dataframe +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Cumulative distribution function + +### Usage + +```python +cdf +``` + +--- + +## Parameters + +This command has no parameters + + + +--- + +## Examples + +```python +optional arguments: + --export {csv,json,xlsx} + Export dataframe data to csv,json,xlsx file (default: ) + -h, --help show this help message (default: False) +``` +![cdf](https://user-images.githubusercontent.com/46355364/154306055-cb3bb1ef-0e61-40c9-bf51-d095bed8dc1b.png) + +--- diff --git a/website/content/terminal/reference/crypto/qa/cusum.md b/website/content/terminal/reference/crypto/qa/cusum.md new file mode 100644 index 000000000000..c30a636f3e1f --- /dev/null +++ b/website/content/terminal/reference/crypto/qa/cusum.md @@ -0,0 +1,38 @@ +--- +title: cusum +description: Learn about the Cumulative Sum Algorithm (CUSUM) used to detect abrupt + changes in data. Understand its usage, parameters, and visualize how it works. +keywords: +- cusum +- cumulative sum algorithm +- data change detection +- usage of cusum +- parameters of cusum +- threshold +- drift +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Cumulative sum algorithm (CUSUM) to detect abrupt changes in data + +### Usage + +```python +cusum [-t THRESHOLD] [-d DRIFT] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| threshold | threshold | 0.0 | True | None | +| drift | drift | 0.0 | True | None | + +![cusum](https://user-images.githubusercontent.com/46355364/154306207-d68f53f4-2f9a-4c1a-8e0e-b83d49938759.png) + +--- diff --git a/website/content/terminal/reference/crypto/qa/decompose.md b/website/content/terminal/reference/crypto/qa/decompose.md new file mode 100644 index 000000000000..574df1737a44 --- /dev/null +++ b/website/content/terminal/reference/crypto/qa/decompose.md @@ -0,0 +1,53 @@ +--- +title: decompose +description: Learn how to decompose time series using Additive and Multiplicative + models on a marketing website. Includes usage instructions and parameters. +keywords: +- Decompose time series +- Additive Time Series +- Multiplicative Time Series +- Level +- CyclicTrend +- Residual +- Seasonality +- Parameters +- Usage +- Marketing +- Stocks +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Decompose time series as: - Additive Time Series = Level + CyclicTrend + Residual + Seasonality - Multiplicative Time Series = Level * CyclicTrend * Residual * Seasonality + +### Usage + +```python +decompose [-m] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| multiplicative | decompose using multiplicative model instead of additive | False | True | None | + + +--- + +## Examples + +```python +2022 Feb 16, 11:06 (🦋) /stocks/qa/ $ decompose + +Time-Series Level is 2660.84 +Strength of Trend: 0.0000 +Strength of Seasonality: 0.0032 +``` +![decompose](https://user-images.githubusercontent.com/46355364/154306626-1c5ad11e-a2e9-4107-9aec-5cf18da5358e.png) + +--- diff --git a/website/content/terminal/reference/crypto/qa/hist.md b/website/content/terminal/reference/crypto/qa/hist.md new file mode 100644 index 000000000000..190c1d5faa51 --- /dev/null +++ b/website/content/terminal/reference/crypto/qa/hist.md @@ -0,0 +1,39 @@ +--- +title: hist +description: The page provides usage instructions for 'hist' command in Python that + creates histograms with density and rug. It also includes details about parameters + and the default value. +keywords: +- hist +- histogram +- density +- rug +- parameters +- n_bins +- Usage +- coding +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Histogram with density and rug + +### Usage + +```python +hist [-b N_BINS] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| n_bins | | 15 | True | range(10, 100) | + +![hist](https://user-images.githubusercontent.com/46355364/154306947-aaba936a-ac07-40e2-a5a6-bf1fab460cd0.png) + +--- diff --git a/website/content/terminal/reference/crypto/qa/kurtosis.md b/website/content/terminal/reference/crypto/qa/kurtosis.md new file mode 100644 index 000000000000..cf4d2ccf3299 --- /dev/null +++ b/website/content/terminal/reference/crypto/qa/kurtosis.md @@ -0,0 +1,38 @@ +--- +title: kurtosis +description: This is a documentation page about Kurtosis, a measure of the 'tailedness' + of a probability distribution of a real-valued random variable. +keywords: +- Kurtosis +- Probability Distribution +- Real-valued random variable +- Skewness +- Theoretical Distribution +- Sample +- Population +- n_window +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Kurtosis is a measure of the "tailedness" of the probability distribution of a real-valued random variable. Like skewness, kurtosis describes the shape of a probability distribution and there are different ways of quantifying it for a theoretical distribution and corresponding ways of estimating it from a sample from a population. Different measures of kurtosis may have different interpretations. + +### Usage + +```python +kurtosis [-w N_WINDOW] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| n_window | window length | 14 | True | range(5, 100) | + +![kurtosis](https://user-images.githubusercontent.com/46355364/154307174-68671146-9551-4c2f-a179-db1d4b20b992.png) + +--- diff --git a/website/content/terminal/reference/crypto/qa/line.md b/website/content/terminal/reference/crypto/qa/line.md new file mode 100644 index 000000000000..3fe210bff711 --- /dev/null +++ b/website/content/terminal/reference/crypto/qa/line.md @@ -0,0 +1,39 @@ +--- +title: line +description: This page is a comprehensive guide on how to create line plots of selected + data, and how to highlight specific datetimes. It provides information about different + parameters like log scale plotting, vertical line markers, and scatter markers. +keywords: +- line plot +- data visualization +- datetime highlighting +- log scale plotting +- vertical line markers +- scatter markers +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Show line plot of selected data or highlight specific datetimes. + +### Usage + +```python +line [--log] [--ml ML] [--ms MS] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| log | Plot with y on log scale | False | True | None | +| ml | Draw vertical line markers to highlight certain events (comma separated dates, e.g. 2020-01-01,2020-02-01) | | True | None | +| ms | Draw scatter markers to highlight certain events (comma separated dates, e.g. 2021-01-01,2021-02-01) | | True | None | + +![line](https://user-images.githubusercontent.com/46355364/154307397-9c2e9325-bce6-494d-994f-a6d7db798798.png) + +--- diff --git a/website/content/terminal/reference/crypto/qa/load.md b/website/content/terminal/reference/crypto/qa/load.md new file mode 100644 index 000000000000..89a8ad29eff0 --- /dev/null +++ b/website/content/terminal/reference/crypto/qa/load.md @@ -0,0 +1,48 @@ +--- +title: load +description: Learn how to load and analyze crypto currency data using our command-line + utility. This page provides full usage details, including parameters, exchange choice, + interval selection and more. The tool supports Yahoo finance, ccxt among other data + sources. +keywords: +- crypto currency analysis +- Yahoo Finance +- ccxt +- crypto exchange +- coin data +- crypto intervals +- command line utility +- binance +- bitbank +- coinbasepro +- cryptocom +- kucoin +- retrieving crypto data +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Load crypto currency to perform analysis on. Yahoo Finance is used as default source. Other sources can be used such as 'ccxt' or 'cg' with --source. If you select 'ccxt', you can then select any exchange with --exchange. You can also select a specific interval with --interval. + +### Usage + +```python +load -c COIN [-s START] [--exchange {aax,ascendex,bequant,bibox,bigone,binance,binancecoinm,binanceus,binanceusdm,bit2c,bitbank,bitbay,bitcoincom,bitfinex,bitfinex2,bitflyer,bitforex,bitget,bithumb,bitmart,bitmex,bitopro,bitpanda,bitrue,bitso,bitstamp,bitstamp1,bittrex,bitvavo,bkex,bl3p,btcalpha,btcbox,btcex,btcmarkets,btctradeua,btcturk,buda,bw,bybit,bytetrade,cex,coinbaseprime,coinbasepro,coincheck,coinex,coinfalcon,coinmate,coinone,coinspot,crex24,cryptocom,currencycom,delta,deribit,digifinex,eqonex,exmo,flowbtc,fmfwio,ftx,ftxus,gate,gateio,gemini,hitbtc,hitbtc3,hollaex,huobi,huobijp,huobipro,idex,independentreserve,indodax,itbit,kraken,kucoin,kucoinfutures,kuna,latoken,lbank,lbank2,liquid,luno,lykke,mercado,mexc,mexc3,ndax,novadax,oceanex,okcoin,okex,okex5,okx,paymium,phemex,poloniex,probit,qtrade,ripio,stex,therock,tidebit,tidex,timex,tokocrypto,upbit,wavesexchange,whitebit,woo,yobit,zaif,zb,zipmex,zonda}] [-e END] [-i {1,5,15,30,60,240,1440,10080,43200}] [--vs VS] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| coin | Coin to get. Must be coin symbol (e.g., btc, eth) | None | False | None | +| start | The starting date (format YYYY-MM-DD) of the crypto | 2019-11-21 | True | None | +| exchange | Exchange to search | binance | True | aax, ascendex, bequant, bibox, bigone, binance, binancecoinm, binanceus, binanceusdm, bit2c, bitbank, bitbay, bitcoincom, bitfinex, bitfinex2, bitflyer, bitforex, bitget, bithumb, bitmart, bitmex, bitopro, bitpanda, bitrue, bitso, bitstamp, bitstamp1, bittrex, bitvavo, bkex, bl3p, btcalpha, btcbox, btcex, btcmarkets, btctradeua, btcturk, buda, bw, bybit, bytetrade, cex, coinbaseprime, coinbasepro, coincheck, coinex, coinfalcon, coinmate, coinone, coinspot, crex24, cryptocom, currencycom, delta, deribit, digifinex, eqonex, exmo, flowbtc, fmfwio, ftx, ftxus, gate, gateio, gemini, hitbtc, hitbtc3, hollaex, huobi, huobijp, huobipro, idex, independentreserve, indodax, itbit, kraken, kucoin, kucoinfutures, kuna, latoken, lbank, lbank2, liquid, luno, lykke, mercado, mexc, mexc3, ndax, novadax, oceanex, okcoin, okex, okex5, okx, paymium, phemex, poloniex, probit, qtrade, ripio, stex, therock, tidebit, tidex, timex, tokocrypto, upbit, wavesexchange, whitebit, woo, yobit, zaif, zb, zipmex, zonda | +| end | The ending date (format YYYY-MM-DD) of the crypto | 2022-11-25 | True | None | +| interval | The interval of the crypto | 1440 | True | 1, 5, 15, 30, 60, 240, 1440, 10080, 43200 | +| vs | Quote currency (what to view coin vs). e.g., usdc, usdt, ... if source is ccxt, usd, eur, ... otherwise | usdt | True | None | + +--- diff --git a/website/content/terminal/reference/crypto/qa/normality.md b/website/content/terminal/reference/crypto/qa/normality.md new file mode 100644 index 000000000000..931162188836 --- /dev/null +++ b/website/content/terminal/reference/crypto/qa/normality.md @@ -0,0 +1,61 @@ +--- +title: normality +description: The page provides comprehensive instructions on how to use the 'normality' + function in stock market data analysis. It offers examples of how the function can + be used to calculate different statistics, including Kurtosis, Skewness, Jarque-Bera, + Shapiro-Wilk, and Kolmogorov-Smirnov, thereby assisting in deciding whether the + data has a Gaussian distribution. +keywords: +- normality tests +- stock market +- statistics +- Kurtosis +- Skewness +- Jarque-Bera +- Shapiro-Wilk +- Kolmogorov-Smirnov +- data analysis +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Normality tests + +### Usage + +```python +normality +``` + +--- + +## Parameters + +This command has no parameters + + + +--- + +## Examples + +```python +2022 Feb 16, 11:11 (🦋) /stocks/qa/ $ normality + Normality Statistics +┏━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━┳━━━━━━━━━┓ +┃ ┃ Statistic ┃ p-value ┃ +┡━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━╇━━━━━━━━━┩ +│ Kurtosis │ 10.2422 │ 0.0000 │ +├────────────────────┼───────────┼─────────┤ +│ Skewness │ -0.2238 │ 0.8229 │ +├────────────────────┼───────────┼─────────┤ +│ Jarque-Bera │ 1155.1958 │ 0.0000 │ +├────────────────────┼───────────┼─────────┤ +│ Shapiro-Wilk │ 0.9265 │ 0.0000 │ +├────────────────────┼───────────┼─────────┤ +│ Kolmogorov-Smirnov │ 0.4680 │ 0.0000 │ +└────────────────────┴───────────┴─────────┘ +``` +--- diff --git a/website/content/terminal/reference/crypto/qa/pick.md b/website/content/terminal/reference/crypto/qa/pick.md new file mode 100644 index 000000000000..019b3af51e5a --- /dev/null +++ b/website/content/terminal/reference/crypto/qa/pick.md @@ -0,0 +1,66 @@ +--- +title: pick +description: The page provides detailed information about the 'pick' command which + is used to change target variables for stock market analysis, using Python. It lists + the usage, parameters, and examples for easier understanding. +keywords: +- pick +- target variable +- parameters +- stock analysis +- stock market +- examples +- usage +- Open +- High +- Low +- Close +- Adj Close +- Volume +- date_id +- OC_High +- OC_Low +- Returns +- LogRet +- TSLA +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Change target variable + +### Usage + +```python +pick [-t {Open,High,Low,Close,Adj Close,Volume,date_id,OC_High,OC_Low,Returns,LogRet}] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| target | Select variable to analyze | None | True | Open, High, Low, Close, Adj Close, Volume, date_id, OC_High, OC_Low, Returns, LogRet | + + +--- + +## Examples + +```python +2022 Feb 16, 11:12 (🦋) /stocks/qa/ $ load tsla + +Loading Daily TSLA stock with starting period 2019-02-11 for analysis. + +Datetime: 2022 Feb 16 11:12 +Timezone: America/New_York +Currency: USD +Market: CLOSED + + +2022 Feb 16, 11:12 (🦋) /stocks/qa/ $ pick adjclose +``` +--- diff --git a/website/content/terminal/reference/crypto/qa/qqplot.md b/website/content/terminal/reference/crypto/qa/qqplot.md new file mode 100644 index 000000000000..b82f51ead348 --- /dev/null +++ b/website/content/terminal/reference/crypto/qa/qqplot.md @@ -0,0 +1,33 @@ +--- +title: qqplot +description: A docusaurus page dedicated to explaining how to utilize the 'qqplot' + Python function to display data in a QQ plot versus normal quantiles. Provides a + succinct guide on usage and parameters available. +keywords: +- qqplot +- normal quantiles +- data visualization +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Display QQ plot vs normal quantiles + +### Usage + +```python +qqplot +``` + +--- + +## Parameters + +This command has no parameters + + +![qqplot](https://user-images.githubusercontent.com/46355364/154307858-acd1a7d0-bb40-4639-a69c-c316749a90ab.png) + +--- diff --git a/website/content/terminal/reference/crypto/qa/quantile.md b/website/content/terminal/reference/crypto/qa/quantile.md new file mode 100644 index 000000000000..a067981420fd --- /dev/null +++ b/website/content/terminal/reference/crypto/qa/quantile.md @@ -0,0 +1,40 @@ +--- +title: quantile +description: Understand how to use the 'quantile' function, a key statistical tool + used to divide distributions. Learn about parameters including 'n_window' for window + length and 'f_quantile' for specifying quantile values. +keywords: +- quantile function +- distribution +- statistics +- median +- n_window +- f_quantile +- parameters +- data analysis +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +The quantiles are values which divide the distribution such that there is a given proportion of observations below the quantile. For example, the median is a quantile. The median is the central value of the distribution, such that half the points are less than or equal to it and half are greater than or equal to it. By default, q is set at 0.5, which effectively is median. Change q to get the desired quantile (0q1). + +### Usage + +```python +quantile [-w N_WINDOW] [-q F_QUANTILE] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| n_window | window length | 14 | True | range(5, 100) | +| f_quantile | quantile | 0.5 | True | 0.0, 0.01, 0.02, 0.03, 0.04, 0.05, 0.06, 0.07, 0.08, 0.09, 0.1, 0.11, 0.12, 0.13, 0.14, 0.15, 0.16, 0.17, 0.18, 0.19, 0.2, 0.21, 0.22, 0.23, 0.24, 0.25, 0.26, 0.27, 0.28, 0.29, 0.3, 0.31, 0.32, 0.33, 0.34, 0.35000000000000003, 0.36, 0.37, 0.38, 0.39, 0.4, 0.41000000000000003, 0.42, 0.43, 0.44, 0.45, 0.46, 0.47000000000000003, 0.48, 0.49, 0.5, 0.51, 0.52, 0.53, 0.54, 0.55, 0.56, 0.5700000000000001, 0.58, 0.59, 0.6, 0.61, 0.62, 0.63, 0.64, 0.65, 0.66, 0.67, 0.68, 0.6900000000000001, 0.7000000000000001, 0.71, 0.72, 0.73, 0.74, 0.75, 0.76, 0.77, 0.78, 0.79, 0.8, 0.81, 0.8200000000000001, 0.8300000000000001, 0.84, 0.85, 0.86, 0.87, 0.88, 0.89, 0.9, 0.91, 0.92, 0.93, 0.9400000000000001, 0.9500000000000001, 0.96, 0.97, 0.98, 0.99 | + +![quantile](https://user-images.githubusercontent.com/46355364/154307976-868e98e1-5a30-43c7-92fc-f221d09c5bd2.png) + +--- diff --git a/website/content/terminal/reference/crypto/qa/raw.md b/website/content/terminal/reference/crypto/qa/raw.md new file mode 100644 index 000000000000..a0cf9b26e389 --- /dev/null +++ b/website/content/terminal/reference/crypto/qa/raw.md @@ -0,0 +1,92 @@ +--- +title: raw +description: This Docusaurus page provides instructions on how to print raw data to + the console using Python. It includes details on parameters such as limit, reverse, + and sortby. Examples of usage and output are provided. +keywords: +- Raw data +- sort +- Limit +- reverse +- sortby +- ascending +- descending +- stocks +- display +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Print raw data to console + +### Usage + +```python +raw [-l LIMIT] [-r] [-s {open,high,low,close,adjclose,volume,date_id,oc_high,oc_low,returns,logret}] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| limit | Number to show | 20 | True | None | +| reverse | Data is sorted in descending order by default. Reverse flag will sort it in an ascending way. Only works when raw data is displayed. | False | True | None | +| sortby | The column to sort by | None | True | open, high, low, close, adjclose, volume, date_id, oc_high, oc_low, returns, logret | + + +--- + +## Examples + +```python +2022 Feb 16, 11:05 (🦋) /stocks/qa/ $ raw + Raw Data +┏━━━━━━━━━━━━┳━━━━━━━━━━┓ +┃ ┃ Adjclose ┃ +┡━━━━━━━━━━━━╇━━━━━━━━━━┩ +│ 2022-01-19 │ 995.650 │ +├────────────┼──────────┤ +│ 2022-01-20 │ 996.270 │ +├────────────┼──────────┤ +│ 2022-01-21 │ 943.900 │ +├────────────┼──────────┤ +│ 2022-01-24 │ 930.000 │ +├────────────┼──────────┤ +│ 2022-01-25 │ 918.400 │ +├────────────┼──────────┤ +│ 2022-01-26 │ 937.410 │ +├────────────┼──────────┤ +│ 2022-01-27 │ 829.100 │ +├────────────┼──────────┤ +│ 2022-01-28 │ 846.350 │ +├────────────┼──────────┤ +│ 2022-01-31 │ 936.720 │ +├────────────┼──────────┤ +│ 2022-02-01 │ 931.250 │ +├────────────┼──────────┤ +│ 2022-02-02 │ 905.660 │ +├────────────┼──────────┤ +│ 2022-02-03 │ 891.140 │ +├────────────┼──────────┤ +│ 2022-02-04 │ 923.320 │ +├────────────┼──────────┤ +│ 2022-02-07 │ 907.340 │ +├────────────┼──────────┤ +│ 2022-02-08 │ 922.000 │ +├────────────┼──────────┤ +│ 2022-02-09 │ 932.000 │ +├────────────┼──────────┤ +│ 2022-02-10 │ 904.550 │ +├────────────┼──────────┤ +│ 2022-02-11 │ 860.000 │ +├────────────┼──────────┤ +│ 2022-02-14 │ 875.760 │ +├────────────┼──────────┤ +│ 2022-02-15 │ 922.430 │ +└────────────┴──────────┘ +``` +--- diff --git a/website/content/terminal/reference/crypto/qa/rolling.md b/website/content/terminal/reference/crypto/qa/rolling.md new file mode 100644 index 000000000000..4dd19ff29a74 --- /dev/null +++ b/website/content/terminal/reference/crypto/qa/rolling.md @@ -0,0 +1,37 @@ +--- +title: rolling +description: Learn the usage, parameters and practical details of the rolling function, + a vital Python tool for calculating the rolling mean and standard deviation. +keywords: +- Rolling function +- Mean calculation +- Standard deviation +- Programming tools +- Window length parameter +- Usage example +- Data visualization +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Rolling mean and std deviation + +### Usage + +```python +rolling [-w N_WINDOW] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| n_window | Window length | 14 | True | range(5, 100) | + +![rolling](https://user-images.githubusercontent.com/46355364/154308175-bb244d55-a6e0-4d6e-80f4-b3937dcd8ed4.png) + +--- diff --git a/website/content/terminal/reference/crypto/qa/skew.md b/website/content/terminal/reference/crypto/qa/skew.md new file mode 100644 index 000000000000..dba4fb9cb5aa --- /dev/null +++ b/website/content/terminal/reference/crypto/qa/skew.md @@ -0,0 +1,43 @@ +--- +title: skew +description: The 'skew' documentation page explains how this concept can be utilized + to measure asymmetry or distortion of a symmetric distribution, also describing + usage and parameters in Python. It provides insights into how skewness measures + deviation from a normal distribution, depicting either a right or left shift. Comprehensive + visual aids are also given for clarification of the skewness concept. +keywords: +- skew +- asymmetry measurement +- distortion +- symmetric distribution +- normal distribution +- skewness +- random variable distribution +- distribution deviation +- right-skewed +- left-skew +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Skewness is a measure of asymmetry or distortion of symmetric distribution. It measures the deviation of the given distribution of a random variable from a symmetric distribution, such as normal distribution. A normal distribution is without any skewness, as it is symmetrical on both sides. Hence, a curve is regarded as skewed if it is shifted towards the right or the left. + +### Usage + +```python +skew [-w N_WINDOW] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| n_window | window length | 14 | True | range(5, 100) | + +![skew](https://user-images.githubusercontent.com/46355364/154308298-7528be2a-05f5-44b8-a479-d4716b2a6c6e.png) + +--- diff --git a/website/content/terminal/reference/crypto/qa/spread.md b/website/content/terminal/reference/crypto/qa/spread.md new file mode 100644 index 000000000000..9f2c71a5230b --- /dev/null +++ b/website/content/terminal/reference/crypto/qa/spread.md @@ -0,0 +1,36 @@ +--- +title: spread +description: This page illustrates the rolling spread measurement, its usage, and + the parameters involved in it. It comprehensively explains how to use 'spread' and + the function of 'n_window' in it. +keywords: +- spread measurement +- usage of spread +- spread parameters +- n_window in spread +- rolling spread +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Shows rolling spread measurement + +### Usage + +```python +spread [-w N_WINDOW] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| n_window | Window length | 14 | True | range(5, 100) | + +![spread](https://user-images.githubusercontent.com/46355364/154308406-f20812a4-fa04-4937-b8de-dc27042f7462.png) + +--- diff --git a/website/content/terminal/reference/crypto/qa/summary.md b/website/content/terminal/reference/crypto/qa/summary.md new file mode 100644 index 000000000000..aa24281dd87c --- /dev/null +++ b/website/content/terminal/reference/crypto/qa/summary.md @@ -0,0 +1,73 @@ +--- +title: summary +description: This page provides a guide on how to use the 'summary' command for getting + summary statistics in Python. The command requires no parameters and provides a + detailed statistical insights on data points such as open, high, low, close, volume + and more. +keywords: +- Summary Statistics +- Command +- No parameters +- Stocks +- Open +- High +- Low +- Close +- Volume +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Summary statistics + +### Usage + +```python +summary +``` + +--- + +## Parameters + +This command has no parameters + + + +--- + +## Examples + +```python +2022 Feb 16, 11:16 (🦋) /stocks/qa/ $ summary + + Summary Statistics +┏━━━━━━━┳━━━━━━━━━━┳━━━━━━━━━━┳━━━━━━━━━━┳━━━━━━━━━━┳━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━┳━━━━━━━━━┳━━━━━━━━━━┓ +┃ ┃ open ┃ high ┃ low ┃ close ┃ adjclose ┃ volume ┃ returns ┃ logret ┃ logprice ┃ +┡━━━━━━━╇━━━━━━━━━━╇━━━━━━━━━━╇━━━━━━━━━━╇━━━━━━━━━━╇━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━╇━━━━━━━━━╇━━━━━━━━━━┩ +│ count │ 760.000 │ 760.000 │ 760.000 │ 760.000 │ 760.000 │ 760.000 │ 760.000 │ 760.000 │ 760.000 │ +├───────┼──────────┼──────────┼──────────┼──────────┼──────────┼─────────────────────┼─────────┼─────────┼──────────┤ +│ mean │ 203.131 │ 205.470 │ 200.350 │ 202.963 │ 202.963 │ 18581311.316 │ -0.000 │ -0.000 │ 5.288 │ +├───────┼──────────┼──────────┼──────────┼──────────┼──────────┼─────────────────────┼─────────┼─────────┼──────────┤ +│ std │ 44.546 │ 44.825 │ 44.020 │ 44.497 │ 44.497 │ 10992756.504 │ 0.025 │ 0.025 │ 0.224 │ +├───────┼──────────┼──────────┼──────────┼──────────┼──────────┼─────────────────────┼─────────┼─────────┼──────────┤ +│ min │ 112.630 │ 114.200 │ 108.700 │ 111.790 │ 111.790 │ 5523000.000 │ -0.133 │ -0.143 │ 4.717 │ +├───────┼──────────┼──────────┼──────────┼──────────┼──────────┼─────────────────────┼─────────┼─────────┼──────────┤ +│ 10% │ 152.144 │ 153.973 │ 150.186 │ 151.635 │ 151.635 │ 9561170.000 │ -0.030 │ -0.030 │ 5.021 │ +├───────┼──────────┼──────────┼──────────┼──────────┼──────────┼─────────────────────┼─────────┼─────────┼──────────┤ +│ 25% │ 171.659 │ 174.392 │ 169.912 │ 171.858 │ 171.858 │ 12144500.000 │ -0.012 │ -0.013 │ 5.147 │ +├───────┼──────────┼──────────┼──────────┼──────────┼──────────┼─────────────────────┼─────────┼─────────┼──────────┤ +│ 50% │ 199.905 │ 202.325 │ 197.335 │ 200.000 │ 200.000 │ 15985100.000 │ 0.000 │ 0.000 │ 5.298 │ +├───────┼──────────┼──────────┼──────────┼──────────┼──────────┼─────────────────────┼─────────┼─────────┼──────────┤ +│ 75% │ 229.373 │ 231.640 │ 226.552 │ 229.478 │ 229.478 │ 21443775.000 │ 0.014 │ 0.014 │ 5.436 │ +├───────┼──────────┼──────────┼──────────┼──────────┼──────────┼─────────────────────┼─────────┼─────────┼──────────┤ +│ 90% │ 265.203 │ 268.028 │ 262.522 │ 265.506 │ 265.506 │ 28987730.000 │ 0.029 │ 0.029 │ 5.582 │ +├───────┼──────────┼──────────┼──────────┼──────────┼──────────┼─────────────────────┼─────────┼─────────┼──────────┤ +│ max │ 313.500 │ 319.320 │ 308.910 │ 317.140 │ 317.140 │ 141830000.000 │ 0.104 │ 0.099 │ 5.759 │ +├───────┼──────────┼──────────┼──────────┼──────────┼──────────┼─────────────────────┼─────────┼─────────┼──────────┤ +│ var │ 1984.325 │ 2009.289 │ 1937.717 │ 1979.969 │ 1979.969 │ 120840695549911.328 │ 0.001 │ 0.001 │ 0.050 │ +└───────┴──────────┴──────────┴──────────┴──────────┴──────────┴─────────────────────┴─────────┴─────────┴──────────┘ +``` +--- diff --git a/website/content/terminal/reference/crypto/qa/unitroot.md b/website/content/terminal/reference/crypto/qa/unitroot.md new file mode 100644 index 000000000000..9eb51bce95a3 --- /dev/null +++ b/website/content/terminal/reference/crypto/qa/unitroot.md @@ -0,0 +1,59 @@ +--- +title: unitroot +description: This page provides comprehensive instructions and usage examples for + the unitroot tool. Unitroot, used for unit root test and stationarity, offers multiple + regression methods including c, ct, ctt, and nc. +keywords: +- unitroot +- unit root test +- stationarity +- ADF +- KPSS +- regression +- programming +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Unit root test / stationarity (ADF, KPSS) + +### Usage + +```python +unitroot [-r {c,ct,ctt,nc}] [-k {c,ct}] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| fuller_reg | Type of regression. Can be ‘c’,’ct’,’ctt’,’nc’ 'c' - Constant and t - trend order | c | True | c, ct, ctt, nc | +| kpss_reg | Type of regression. Can be ‘c’,’ct' | c | True | c, ct | + + +--- + +## Examples + +```python +2022 Feb 16, 11:16 (🦋) /stocks/qa/ $ unitroot + Unit Root Calculation +┏━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━┳━━━━━━━━┓ +┃ ┃ ADF ┃ KPSS ┃ +┡━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━╇━━━━━━━━┩ +│ Test Statistic │ -28.9536 │ 0.2928 │ +├────────────────┼────────────┼────────┤ +│ P-Value │ 0.0000 │ 0.1000 │ +├────────────────┼────────────┼────────┤ +│ NLags │ 0.0000 │ 3 │ +├────────────────┼────────────┼────────┤ +│ Nobs │ 759.0000 │ │ +├────────────────┼────────────┼────────┤ +│ ICBest │ -3339.2013 │ │ +└────────────────┴────────────┴────────┘ +``` +--- diff --git a/website/versioned_docs/version-v3/terminal/reference/crypto/ta/_category_.json b/website/content/terminal/reference/crypto/ta/_category_.json similarity index 100% rename from website/versioned_docs/version-v3/terminal/reference/crypto/ta/_category_.json rename to website/content/terminal/reference/crypto/ta/_category_.json diff --git a/website/content/terminal/reference/crypto/ta/ad.md b/website/content/terminal/reference/crypto/ta/ad.md new file mode 100644 index 000000000000..1db29e5ee3da --- /dev/null +++ b/website/content/terminal/reference/crypto/ta/ad.md @@ -0,0 +1,39 @@ +--- +title: ad +description: This documentation explains how to use the Accumulation/Distribution + Line, an indicator similar to the On Balance Volume to project trends in the price + direction of a stock, and how to use specific parameters with the ad function to + get the open value of a stock. +keywords: +- Accumulation/Distribution Line +- On Balance Volume +- Marketing +- Stock Value +- Close Location Value +- Price Trend +- Price Flattening +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +The Accumulation/Distribution Line is similar to the On Balance Volume (OBV), which sums the volume times +1/-1 based on whether the close is higher than the previous close. The Accumulation/Distribution indicator, however multiplies the volume by the close location value (CLV). The CLV is based on the movement of the issue within a single bar and can be +1, -1 or zero. The Accumulation/Distribution Line is interpreted by looking for a divergence in the direction of the indicator relative to price. If the Accumulation/Distribution Line is trending upward it indicates that the price may follow. Also, if the Accumulation/Distribution Line becomes flat while the price is still rising (or falling) then it signals an impending flattening of the price. + +### Usage + +```python +ad [--open] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| b_use_open | uses open value of stock | False | True | None | + +![ad](https://user-images.githubusercontent.com/46355364/154309283-9512c6c0-dda3-4348-9350-105238676479.png) + +--- diff --git a/website/content/terminal/reference/crypto/ta/adosc.md b/website/content/terminal/reference/crypto/ta/adosc.md new file mode 100644 index 000000000000..581a94a8a338 --- /dev/null +++ b/website/content/terminal/reference/crypto/ta/adosc.md @@ -0,0 +1,42 @@ +--- +title: adosc +description: This page explains the Accumulation/Distribution Oscillator (adosc), + a momentum indicator in trading examining both the strength of price moves and underlying + buying/selling pressure. It details usage, parameters, and potential market implications. +keywords: +- Accumulation/Distribution Oscillator +- adosc +- momentum indicator +- price moves +- buying pressure +- selling pressure +- market turning points +- trading +- stock market +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Accumulation/Distribution Oscillator, also known as the Chaikin Oscillator is essentially a momentum indicator, but of the Accumulation-Distribution line rather than merely price. It looks at both the strength of price moves and the underlying buying and selling pressure during a given time period. The oscillator reading above zero indicates net buying pressure, while one below zero registers net selling pressure. Divergence between the indicator and pure price moves are the most common signals from the indicator, and often flag market turning points. + +### Usage + +```python +adosc [--open] [--fast N_LENGTH_FAST] [--slow N_LENGTH_SLOW] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| b_use_open | uses open value of stock | False | True | None | +| n_length_fast | fast length | 3 | True | range(1, 100) | +| n_length_slow | slow length | 10 | True | None | + +![adosc](https://user-images.githubusercontent.com/46355364/154309482-31c027ab-e80f-4145-9c63-392a74cf69c7.png) + +--- diff --git a/website/content/terminal/reference/crypto/ta/adx.md b/website/content/terminal/reference/crypto/ta/adx.md new file mode 100644 index 000000000000..699aa50bdf01 --- /dev/null +++ b/website/content/terminal/reference/crypto/ta/adx.md @@ -0,0 +1,42 @@ +--- +title: adx +description: This page provides detailed instructions on using the ADX, a Welles Wilder + style moving average of the Directional Movement Index. It includes usage examples + and parameter specifications. +keywords: +- ADX +- Welles Wilder +- Directional Movement Index +- DX +- trend strength +- parameters +- n_length +- n_scalar +- n_drift +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +The ADX is a Welles Wilder style moving average of the Directional Movement Index (DX). The values range from 0 to 100, but rarely get above 60. To interpret the ADX, consider a high number to be a strong trend, and a low number, a weak trend. + +### Usage + +```python +adx [-l N_LENGTH] [-s N_SCALAR] [-d N_DRIFT] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| n_length | length | 14 | True | range(1, 100) | +| n_scalar | scalar | 100 | True | None | +| n_drift | drift | 1 | True | range(1, 100) | + +![adx](https://user-images.githubusercontent.com/46355364/154309667-c67f6078-822f-452d-9853-ffffa9172670.png) + +--- diff --git a/website/content/terminal/reference/crypto/ta/aroon.md b/website/content/terminal/reference/crypto/ta/aroon.md new file mode 100644 index 000000000000..477613aa104c --- /dev/null +++ b/website/content/terminal/reference/crypto/ta/aroon.md @@ -0,0 +1,44 @@ +--- +title: aroon +description: The page introduces the aroon indicator which signifies the emergence + of new trends. It explains how the indicator works, including its Up and Down indicators, + its relationship with the highest high and lowest low within a certain period, and + its role in identifying strong or weak trends. +keywords: +- aroon +- trend indicator +- aroon Up +- aroon Down +- upward trend +- downward trend +- n period range +- dawn's early light +- crossovers +- weak trend +- strong trend +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +The word aroon is Sanskrit for "dawn's early light." The Aroon indicator attempts to show when a new trend is dawning. The indicator consists of two lines (Up and Down) that measure how long it has been since the highest high/lowest low has occurred within an n period range. When the Aroon Up is staying between 70 and 100 then it indicates an upward trend. When the Aroon Down is staying between 70 and 100 then it indicates an downward trend. A strong upward trend is indicated when the Aroon Up is above 70 while the Aroon Down is below 30. Likewise, a strong downward trend is indicated when the Aroon Down is above 70 while the Aroon Up is below 30. Also look for crossovers. When the Aroon Down crosses above the Aroon Up, it indicates a weakening of the upward trend (and vice versa). + +### Usage + +```python +aroon [-l N_LENGTH] [-s N_SCALAR] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| n_length | length | 25 | True | range(1, 100) | +| n_scalar | scalar | 100 | True | None | + +![aroon](https://user-images.githubusercontent.com/46355364/154309825-f8ccc98b-31ac-43fc-a251-66f6f41545a5.png) + +--- diff --git a/website/content/terminal/reference/crypto/ta/bbands.md b/website/content/terminal/reference/crypto/ta/bbands.md new file mode 100644 index 000000000000..1a1ce5fb3269 --- /dev/null +++ b/website/content/terminal/reference/crypto/ta/bbands.md @@ -0,0 +1,44 @@ +--- +title: bbands +description: This page provides detailed information about the Bollinger Bands (bbands), + a volatility indicator in technical analysis, including usage, parameters, visual + representation, data interpretation, and their importance in buy or sell signals + generation. +keywords: +- Bollinger Bands +- bbands +- technical analysis +- volatility indicators +- overbought conditions +- oversold conditions +- price targets +- price reversal +- support level +- resistance level +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Bollinger Bands consist of three lines. The middle band is a simple moving average (generally 20 periods) of the typical price (TP). The upper and lower bands are F standard deviations (generally 2) above and below the middle band. The bands widen and narrow when the volatility of the price is higher or lower, respectively. Bollinger Bands do not, in themselves, generate buy or sell signals; they are an indicator of overbought or oversold conditions. When the price is near the upper or lower band it indicates that a reversal may be imminent. The middle band becomes a support or resistance level. The upper and lower bands can also be interpreted as price targets. When the price bounces off of the lower band and crosses the middle band, then the upper band becomes the price target. + +### Usage + +```python +bbands [-l N_LENGTH] [-s N_STD] [-m {ema,sma,wma,hma,zlma}] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| n_length | length | 15 | True | range(1, 100) | +| n_std | std | 2 | True | 0.0, 0.25, 0.5, 0.75, 1.0, 1.25, 1.5, 1.75, 2.0, 2.25, 2.5, 2.75, 3.0, 3.25, 3.5, 3.75, 4.0, 4.25, 4.5, 4.75, 5.0, 5.25, 5.5, 5.75, 6.0, 6.25, 6.5, 6.75, 7.0, 7.25, 7.5, 7.75, 8.0, 8.25, 8.5, 8.75, 9.0, 9.25, 9.5, 9.75 | +| s_mamode | mamode | sma | True | ema, sma, wma, hma, zlma | + +![bbands](https://user-images.githubusercontent.com/46355364/154309951-116f3c31-342d-4ceb-b489-8b0ba78eb3a0.png) + +--- diff --git a/website/content/terminal/reference/crypto/ta/cci.md b/website/content/terminal/reference/crypto/ta/cci.md new file mode 100644 index 000000000000..ef77422316cf --- /dev/null +++ b/website/content/terminal/reference/crypto/ta/cci.md @@ -0,0 +1,41 @@ +--- +title: cci +description: This page provides an in-depth analysis of the CCI - a tool designed + to spot initiating and concluding market trends. It clearly explains how to utilize + this tool, covering everything from normal trading range to identifying oversold + conditions and anticipating price correction. +keywords: +- CCI +- market trends +- overbought +- oversold +- price divergence +- price correction +- n_length +- n_scalar +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +The CCI is designed to detect beginning and ending market trends. The range of 100 to -100 is the normal trading range. CCI values outside of this range indicate overbought or oversold conditions. You can also look for price divergence in the CCI. If the price is making new highs, and the CCI is not, then a price correction is likely. + +### Usage + +```python +cci [-l N_LENGTH] [-s N_SCALAR] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| n_length | length | 14 | True | range(1, 100) | +| n_scalar | scalar | 0.015 | True | None | + +![cci](https://user-images.githubusercontent.com/46355364/154310079-808803ca-26dd-4d45-8a02-17e51230bf2d.png) + +--- diff --git a/website/content/terminal/reference/crypto/ta/cg.md b/website/content/terminal/reference/crypto/ta/cg.md new file mode 100644 index 000000000000..211479d76a55 --- /dev/null +++ b/website/content/terminal/reference/crypto/ta/cg.md @@ -0,0 +1,41 @@ +--- +title: cg +description: This page explains the use of the Center of Gravity (COG) indicator to + anticipate future price movements and trade on price reversals. It also includes + parameters and usage guide for COG indicator. +keywords: +- Center of Gravity indicator +- COG indicator +- future price movements +- trade on price reversals +- oscillators +- range-bound markets +- speculate upcoming price change +- CG parameters +- CG usage guide +- N_LENGTH +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +The Center of Gravity indicator, in short, is used to anticipate future price movements and to trade on price reversals as soon as they happen. However, just like other oscillators, the COG indicator returns the best results in range-bound markets and should be avoided when the price is trending. Traders who use it will be able to closely speculate the upcoming price change of the asset. + +### Usage + +```python +cg [-l N_LENGTH] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| n_length | length | 14 | True | range(1, 100) | + +![cg](https://user-images.githubusercontent.com/46355364/154310202-cd0d703e-21ba-41a2-b58a-5b8547efa887.png) + +--- diff --git a/website/content/terminal/reference/crypto/ta/donchian.md b/website/content/terminal/reference/crypto/ta/donchian.md new file mode 100644 index 000000000000..271fb1f9a018 --- /dev/null +++ b/website/content/terminal/reference/crypto/ta/donchian.md @@ -0,0 +1,41 @@ +--- +title: donchian +description: This page provides information on Donchian Channels, an indicator comprising + upper and lower bands around a midrange or median band. It includes details of the + parameters for its usage. +keywords: +- Donchian Channels +- moving average calculations +- upper and lower bands +- highest and lowest price +- N periods +- security +- Donchian Channel +- N_LENGTH_UPPER +- N_LENGTH_LOWER +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Donchian Channels are three lines generated by moving average calculations that comprise an indicator formed by upper and lower bands around a midrange or median band. The upper band marks the highest price of a security over N periods while the lower band marks the lowest price of a security over N periods. The area between the upper and lower bands represents the Donchian Channel. + +### Usage + +```python +donchian [-u N_LENGTH_UPPER] [-l N_LENGTH_LOWER] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| n_length_upper | length | 20 | True | range(1, 100) | +| n_length_lower | length | 20 | True | range(1, 100) | + +![donchian](https://user-images.githubusercontent.com/46355364/154310472-6cd5805f-b87f-4668-85a1-3e5dd7267848.png) + +--- diff --git a/website/content/terminal/reference/crypto/ta/ema.md b/website/content/terminal/reference/crypto/ta/ema.md new file mode 100644 index 000000000000..13281ccc2954 --- /dev/null +++ b/website/content/terminal/reference/crypto/ta/ema.md @@ -0,0 +1,40 @@ +--- +title: ema +description: Page providing details about the Exponential Moving Average (EMA), a + crucial tool in technical analysis. Explains the comparison between EMA and Simple + Moving Average, along with usage and parameters. +keywords: +- Exponential Moving Average +- technical analysis +- Simple Moving Average +- cumulative calculation +- responsive to changes +- parameters +- Window lengths +- offset +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +The Exponential Moving Average is a staple of technical analysis and is used in countless technical indicators. In a Simple Moving Average, each value in the time period carries equal weight, and values outside of the time period are not included in the average. However, the Exponential Moving Average is a cumulative calculation, including all data. Past values have a diminishing contribution to the average, while more recent values have a greater contribution. This method allows the moving average to be more responsive to changes in the data. + +### Usage + +```python +ema [-l N_LENGTH] [-o N_OFFSET] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| n_length | Window lengths. Multiple values indicated as comma separated values. | 20, 50 | True | None | +| n_offset | offset | 0 | True | range(0, 100) | + +![ema](https://user-images.githubusercontent.com/46355364/154310578-6f4a51a8-3667-497c-9c50-7ff16e256fb6.png) + +--- diff --git a/website/content/terminal/reference/crypto/ta/fib.md b/website/content/terminal/reference/crypto/ta/fib.md new file mode 100644 index 000000000000..132caf6f0163 --- /dev/null +++ b/website/content/terminal/reference/crypto/ta/fib.md @@ -0,0 +1,40 @@ +--- +title: fib +description: This page contains details on how to calculate the Fibonacci retracement + levels using specified parameters. Learn about proper usage, accepted parameters, + and view a visual representation. +keywords: +- Fibonacci retracement levels +- fib function +- parameters +- Fibonacci trading +- trading strategies +- stock analysis +- trading charts +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Calculates the fibonacci retracement levels + +### Usage + +```python +fib [-p PERIOD] [--start START] [--end END] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| period | Days to look back for retracement | 120 | True | range(1, 960) | +| start | Starting date to select | None | True | None | +| end | Ending date to select | None | True | None | + +![fib](https://user-images.githubusercontent.com/46355364/154310727-81a1eab3-5565-42c7-8b47-4f80288dd700.png) + +--- diff --git a/website/content/terminal/reference/crypto/ta/fisher.md b/website/content/terminal/reference/crypto/ta/fisher.md new file mode 100644 index 000000000000..841818fd3113 --- /dev/null +++ b/website/content/terminal/reference/crypto/ta/fisher.md @@ -0,0 +1,39 @@ +--- +title: fisher +description: This page provides information about the Fisher Transform, a technical + indicator that converts prices into a Gaussian normal distribution. The tool helps + with identifying potential turning points in the price of an asset, and enables + users to visualize trends and price waves. +keywords: +- Fisher Transform +- technical indicator +- John F. Ehlers +- Gaussian normal distribution +- price turning points +- price trends +- price waves +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +The Fisher Transform is a technical indicator created by John F. Ehlers that converts prices into a Gaussian normal distribution.1 The indicator highlights when prices have moved to an extreme, based on recent prices. This may help in spotting turning points in the price of an asset. It also helps show the trend and isolate the price waves within a trend. + +### Usage + +```python +fisher [-l N_LENGTH] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| n_length | length | 14 | True | range(1, 100) | + +![fisher](https://user-images.githubusercontent.com/46355364/154310853-0abf6cea-71ca-4f07-b009-282c58ab9cfc.png) + +--- diff --git a/website/content/terminal/reference/crypto/ta/hma.md b/website/content/terminal/reference/crypto/ta/hma.md new file mode 100644 index 000000000000..22fa7f133b97 --- /dev/null +++ b/website/content/terminal/reference/crypto/ta/hma.md @@ -0,0 +1,40 @@ +--- +title: hma +description: The page covers the Hull Moving Average (HMA) - a moving average that + is more responsive to current price activity while maintaining smoothness. It explains + the usage, parameters (such as n_length and n_offset) and gives a visual representation. +keywords: +- Hull Moving Average +- HMA +- Moving Average +- price activity +- curve smoothness +- n_length +- n_offset +- algorithm parameters +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +The Hull Moving Average solves the age old dilemma of making a moving average more responsive to current price activity whilst maintaining curve smoothness. In fact the HMA almost eliminates lag altogether and manages to improve smoothing at the same time. + +### Usage + +```python +hma [-l N_LENGTH] [-o N_OFFSET] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| n_length | Window lengths. Multiple values indicated as comma separated values. | 10, 20 | True | None | +| n_offset | offset | 0 | True | range(0, 100) | + +![hma](https://user-images.githubusercontent.com/46355364/154310988-2e97c166-a3b9-49ae-abcd-2c1b37309072.png) + +--- diff --git a/website/content/terminal/reference/crypto/ta/kc.md b/website/content/terminal/reference/crypto/ta/kc.md new file mode 100644 index 000000000000..28cb6e885e5e --- /dev/null +++ b/website/content/terminal/reference/crypto/ta/kc.md @@ -0,0 +1,50 @@ +--- +title: kc +description: The documentation provides insights on Keltner Channels (kc), a volatility-based + band indicating a trend direction. The page explains its usage in Python, various + parameters like N_LENGTH, N_SCALAR, mamode types (ema, sma, wma, hma, zlma) and + the N_OFFSET. +keywords: +- kc +- Keltner Channels +- volatility-based bands +- average true range +- ATR +- trend direction +- N_LENGTH +- N_SCALAR +- mamode +- ema +- sma +- wma +- hma +- zlma +- N_OFFSET +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Keltner Channels are volatility-based bands that are placed on either side of an asset's price and can aid in determining the direction of a trend.The Keltner channel uses the average true range (ATR) or volatility, with breaks above or below the top and bottom barriers signaling a continuation. + +### Usage + +```python +kc [-l N_LENGTH] [-s N_SCALAR] [-m {ema,sma,wma,hma,zlma}] [-o N_OFFSET] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| n_length | Window length | 20 | True | range(1, 100) | +| n_scalar | scalar | 2 | True | None | +| s_mamode | mamode | ema | True | ema, sma, wma, hma, zlma | +| n_offset | offset | 0 | True | range(0, 100) | + +![kc](https://user-images.githubusercontent.com/46355364/154311120-a769ee53-901b-401f-907f-cacac43ee9b9.png) + +--- diff --git a/website/content/terminal/reference/crypto/ta/load.md b/website/content/terminal/reference/crypto/ta/load.md new file mode 100644 index 000000000000..3cad23bddb94 --- /dev/null +++ b/website/content/terminal/reference/crypto/ta/load.md @@ -0,0 +1,44 @@ +--- +title: load +description: Documentation on how to load and analyze crypto currency data using Python. + The page explains how to use different data sources such as Yahoo Finance, ccxt, + or cg, select exchanges and intervals, and query data by cryptocurrency symbols, + start and end dates. +keywords: +- crypto currency analysis +- yahoo finance +- ccxt +- cg +- exchange selection +- data interval +- load function +- cryptocurrency symbol +- quote currency +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Load crypto currency to perform analysis on. Yahoo Finance is used as default source. Other sources can be used such as 'ccxt' or 'cg' with --source. If you select 'ccxt', you can then select any exchange with --exchange. You can also select a specific interval with --interval. + +### Usage + +```python +load -c COIN [-s START] [--exchange {aax,ascendex,bequant,bibox,bigone,binance,binancecoinm,binanceus,binanceusdm,bit2c,bitbank,bitbay,bitcoincom,bitfinex,bitfinex2,bitflyer,bitforex,bitget,bithumb,bitmart,bitmex,bitopro,bitpanda,bitrue,bitso,bitstamp,bitstamp1,bittrex,bitvavo,bkex,bl3p,btcalpha,btcbox,btcex,btcmarkets,btctradeua,btcturk,buda,bw,bybit,bytetrade,cex,coinbaseprime,coinbasepro,coincheck,coinex,coinfalcon,coinmate,coinone,coinspot,crex24,cryptocom,currencycom,delta,deribit,digifinex,eqonex,exmo,flowbtc,fmfwio,ftx,ftxus,gate,gateio,gemini,hitbtc,hitbtc3,hollaex,huobi,huobijp,huobipro,idex,independentreserve,indodax,itbit,kraken,kucoin,kucoinfutures,kuna,latoken,lbank,lbank2,liquid,luno,lykke,mercado,mexc,mexc3,ndax,novadax,oceanex,okcoin,okex,okex5,okx,paymium,phemex,poloniex,probit,qtrade,ripio,stex,therock,tidebit,tidex,timex,tokocrypto,upbit,wavesexchange,whitebit,woo,yobit,zaif,zb,zipmex,zonda}] [-e END] [-i {1,5,15,30,60,240,1440,10080,43200}] [--vs VS] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| coin | Coin to get. Must be coin symbol (e.g., btc, eth) | None | False | None | +| start | The starting date (format YYYY-MM-DD) of the crypto | 2019-11-21 | True | None | +| exchange | Exchange to search | binance | True | aax, ascendex, bequant, bibox, bigone, binance, binancecoinm, binanceus, binanceusdm, bit2c, bitbank, bitbay, bitcoincom, bitfinex, bitfinex2, bitflyer, bitforex, bitget, bithumb, bitmart, bitmex, bitopro, bitpanda, bitrue, bitso, bitstamp, bitstamp1, bittrex, bitvavo, bkex, bl3p, btcalpha, btcbox, btcex, btcmarkets, btctradeua, btcturk, buda, bw, bybit, bytetrade, cex, coinbaseprime, coinbasepro, coincheck, coinex, coinfalcon, coinmate, coinone, coinspot, crex24, cryptocom, currencycom, delta, deribit, digifinex, eqonex, exmo, flowbtc, fmfwio, ftx, ftxus, gate, gateio, gemini, hitbtc, hitbtc3, hollaex, huobi, huobijp, huobipro, idex, independentreserve, indodax, itbit, kraken, kucoin, kucoinfutures, kuna, latoken, lbank, lbank2, liquid, luno, lykke, mercado, mexc, mexc3, ndax, novadax, oceanex, okcoin, okex, okex5, okx, paymium, phemex, poloniex, probit, qtrade, ripio, stex, therock, tidebit, tidex, timex, tokocrypto, upbit, wavesexchange, whitebit, woo, yobit, zaif, zb, zipmex, zonda | +| end | The ending date (format YYYY-MM-DD) of the crypto | 2022-11-25 | True | None | +| interval | The interval of the crypto | 1440 | True | 1, 5, 15, 30, 60, 240, 1440, 10080, 43200 | +| vs | Quote currency (what to view coin vs). e.g., usdc, usdt, ... if source is ccxt, usd, eur, ... otherwise | usdt | True | None | + +--- diff --git a/website/content/terminal/reference/crypto/ta/macd.md b/website/content/terminal/reference/crypto/ta/macd.md new file mode 100644 index 000000000000..d091eda3a6f5 --- /dev/null +++ b/website/content/terminal/reference/crypto/ta/macd.md @@ -0,0 +1,42 @@ +--- +title: macd +description: Explore the MACD page to understand the use and parameters of the Moving + Average Convergence Divergence (MACD). Learn about the significance of high and + low MACD values, buy and sell signals, and more. +keywords: +- MACD +- Moving Average Convergence Divergence +- Exponential Moving Averages +- Signal line +- Trend changes +- Overbought conditions +- Oversold conditions +- Buy signal +- Sell signal +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +The Moving Average Convergence Divergence (MACD) is the difference between two Exponential Moving Averages. The Signal line is an Exponential Moving Average of the MACD. The MACD signals trend changes and indicates the start of new trend direction. High values indicate overbought conditions, low values indicate oversold conditions. Divergence with the price indicates an end to the current trend, especially if the MACD is at extreme high or low values. When the MACD line crosses above the signal line a buy signal is generated. When the MACD crosses below the signal line a sell signal is generated. To confirm the signal, the MACD should be above zero for a buy, and below zero for a sell. + +### Usage + +```python +macd [--fast N_FAST] [--slow N_SLOW] [--signal N_SIGNAL] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| n_fast | The short period. | 12 | True | range(1, 100) | +| n_slow | The long period. | 26 | True | None | +| n_signal | The signal period. | 9 | True | None | + +![macd](https://user-images.githubusercontent.com/46355364/154311220-d18eb93e-76b3-4abb-b9c6-86484f462c55.png) + +--- diff --git a/website/content/terminal/reference/crypto/ta/obv.md b/website/content/terminal/reference/crypto/ta/obv.md new file mode 100644 index 000000000000..c4351497a16c --- /dev/null +++ b/website/content/terminal/reference/crypto/ta/obv.md @@ -0,0 +1,35 @@ +--- +title: obv +description: Learn about the On Balance Volume (OBV), a trading indicator that represents + the cumulative total of up and down volumes. Find out how to use, interpret the + OBV, understand market trends and use it in your trading analysis. +keywords: +- On Balance Volume +- OBV +- Volume analysis +- Trading indicators +- Market trends +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +The On Balance Volume (OBV) is a cumulative total of the up and down volume. When the close is higher than the previous close, the volume is added to the running total, and when the close is lower than the previous close, the volume is subtracted from the running total. To interpret the OBV, look for the OBV to move with the price or precede price moves. If the price moves before the OBV, then it is a non-confirmed move. A series of rising peaks, or falling troughs, in the OBV indicates a strong trend. If the OBV is flat, then the market is not trending. + +### Usage + +```python +obv +``` + +--- + +## Parameters + +This command has no parameters + + +![obv](https://user-images.githubusercontent.com/46355364/154311359-edb78587-744f-4e2c-b247-8b9fbf09b01f.png) + +--- diff --git a/website/content/terminal/reference/crypto/ta/rsi.md b/website/content/terminal/reference/crypto/ta/rsi.md new file mode 100644 index 000000000000..93ad6e6928c1 --- /dev/null +++ b/website/content/terminal/reference/crypto/ta/rsi.md @@ -0,0 +1,41 @@ +--- +title: rsi +description: Learn how to interpret and use the Relative Strength Index (RSI), an + overbought/oversold indicator that calculates a ratio of recent upward price movements + to the absolute price movement and helps indicate potential price reversals. +keywords: +- Relative Strength Index +- RSI +- RSI interpretation +- overbought/oversold indicator +- RSI divergence +- price reversal +- RSI parameters +- RSI usage +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +The Relative Strength Index (RSI) calculates a ratio of the recent upward price movements to the absolute price movement. The RSI ranges from 0 to 100. The RSI is interpreted as an overbought/oversold indicator when the value is over 70/below 30. You can also look for divergence with price. If the price is making new highs/lows, and the RSI is not, it indicates a reversal. + +### Usage + +```python +rsi [-l N_LENGTH] [-s N_SCALAR] [-d N_DRIFT] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| n_length | length | 14 | True | range(1, 100) | +| n_scalar | scalar | 100 | True | None | +| n_drift | drift | 1 | True | range(1, 100) | + +![rsi](https://user-images.githubusercontent.com/46355364/154311651-99e67e12-1677-43a9-92d9-5998d99fd0db.png) + +--- diff --git a/website/content/terminal/reference/crypto/ta/sma.md b/website/content/terminal/reference/crypto/ta/sma.md new file mode 100644 index 000000000000..3a6d5027a886 --- /dev/null +++ b/website/content/terminal/reference/crypto/ta/sma.md @@ -0,0 +1,38 @@ +--- +title: sma +description: A documentation page elaborating on Simple Moving Averages (sma), their + application in data smoothing and trend identification. It outlines usage, parameters + and provides visualized data. +keywords: +- Moving averages +- Data smoothing +- Trend identification +- Simple Moving Average +- Filtering data changes +- sma parameters +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Moving Averages are used to smooth the data in an array to help eliminate noise and identify trends. The Simple Moving Average is literally the simplest form of a moving average. Each output value is the average of the previous n values. In a Simple Moving Average, each value in the time period carries equal weight, and values outside of the time period are not included in the average. This makes it less responsive to recent changes in the data, which can be useful for filtering out those changes. + +### Usage + +```python +sma [-l N_LENGTH] [-o N_OFFSET] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| n_length | Window lengths. Multiple values indicated as comma separated values. | 20, 50 | True | None | +| n_offset | offset | 0 | True | range(0, 100) | + +![sma](https://user-images.githubusercontent.com/46355364/154311791-5b130d08-55bd-406b-a68e-914a733c5191.png) + +--- diff --git a/website/content/terminal/reference/crypto/ta/stoch.md b/website/content/terminal/reference/crypto/ta/stoch.md new file mode 100644 index 000000000000..e2ef8be57652 --- /dev/null +++ b/website/content/terminal/reference/crypto/ta/stoch.md @@ -0,0 +1,46 @@ +--- +title: stoch +description: Learn about the Stochastic Oscillator, a measurement tool in trading + ranges. Discover the meaning of overbought and oversold conditions and how to interpret + the signals from Fast %D and Slow %D. Understand how to use parameters like n_fastkperiod, + n_slowdperiod, and n_slowkperiod for moving averages. +keywords: +- Stochastic Oscillator +- overbought condition +- oversold condition +- Fast %D +- Slow %D +- buy signal +- sell signal +- Raw %K +- moving average +- n_fastkperiod +- n_slowdperiod +- n_slowkperiod +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +The Stochastic Oscillator measures where the close is in relation to the recent trading range. The values range from zero to 100. %D values over 75 indicate an overbought condition; values under 25 indicate an oversold condition. When the Fast %D crosses above the Slow %D, it is a buy signal; when it crosses below, it is a sell signal. The Raw %K is generally considered too erratic to use for crossover signals. + +### Usage + +```python +stoch [-k N_FASTKPERIOD] [-d N_SLOWDPERIOD] [--slowkperiod N_SLOWKPERIOD] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| n_fastkperiod | The time period of the fastk moving average | 14 | True | range(1, 100) | +| n_slowdperiod | The time period of the slowd moving average | 3 | True | range(1, 100) | +| n_slowkperiod | The time period of the slowk moving average | 3 | True | range(1, 100) | + +![stoch](https://user-images.githubusercontent.com/46355364/154311913-d58e58bb-d116-44dd-ae4b-44e59c25f22a.png) + +--- diff --git a/website/content/terminal/reference/crypto/ta/tv.md b/website/content/terminal/reference/crypto/ta/tv.md new file mode 100644 index 000000000000..36faf901e5a0 --- /dev/null +++ b/website/content/terminal/reference/crypto/ta/tv.md @@ -0,0 +1,32 @@ +--- +title: tv +description: Page provides details on 'tv' command for leveraging TradingView for + technical analysis. It includes usage and information that the command has no parameters. +keywords: +- TradingView +- technical analysis +- tv command +- usage +- no parameters +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +View TradingView for technical analysis. [Source: TradingView] + +### Usage + +```python +tv +``` + +--- + +## Parameters + +This command has no parameters + + +--- diff --git a/website/content/terminal/reference/crypto/ta/vwap.md b/website/content/terminal/reference/crypto/ta/vwap.md new file mode 100644 index 000000000000..11d1d5c928e5 --- /dev/null +++ b/website/content/terminal/reference/crypto/ta/vwap.md @@ -0,0 +1,55 @@ +--- +title: vwap +description: The page describes Volume Weighted Average Price (VWAP) used to measure + the average typical price by volume with intraday charts. It details its usage, + parameters, and provides examples. +keywords: +- vwap +- Volume Weighted Average Price +- intraday charts +- average typical price +- stock analysis +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +The Volume Weighted Average Price that measures the average typical price by volume. It is typically used with intraday charts to identify general direction. + +### Usage + +```python +vwap [-o N_OFFSET] [--start START] [--end END] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| n_offset | offset | 0 | True | range(0, 100) | +| start | Starting date to select | None | True | None | +| end | Ending date to select | None | True | None | + + +--- + +## Examples + +```python +2022 Feb 16, 11:36 (🦋) /stocks/ta/ $ load GOOGL -i 1 + +Loading Intraday 1min GOOGL stock with starting period 2022-02-10 for analysis. + +Datetime: 2022 Feb 16 11:36 +Timezone: America/New_York +Currency: USD +Market: CLOSED + +2022 Feb 16, 11:36 (🦋) /stocks/ta/ $ vwap +``` +![vwap](https://user-images.githubusercontent.com/46355364/154312502-9377c57c-6e34-42a6-b021-674e7d4561dd.png) + +--- diff --git a/website/content/terminal/reference/crypto/ta/wma.md b/website/content/terminal/reference/crypto/ta/wma.md new file mode 100644 index 000000000000..6407bf4072eb --- /dev/null +++ b/website/content/terminal/reference/crypto/ta/wma.md @@ -0,0 +1,41 @@ +--- +title: wma +description: A comprehensive guide about Weighted Moving Average (WMA), its special + features, usage, inclusion of parameters like window lengths and offset. Also, providing + an illustrative diagram about WMA. +keywords: +- Weighted Moving Average +- WMA +- n_length +- n_offset +- WMA parameters +- WMA usage +- WMA diagram +- window lengths +- offset +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +A Weighted Moving Average puts more weight on recent data and less on past data. This is done by multiplying each bar’s price by a weighting factor. Because of its unique calculation, WMA will follow prices more closely than a corresponding Simple Moving Average. + +### Usage + +```python +wma [-l N_LENGTH] [-o N_OFFSET] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| n_length | Window lengths. Multiple values indicated as comma separated values. | 20, 50 | True | None | +| n_offset | offset | 0 | True | range(0, 100) | + +![wma](https://user-images.githubusercontent.com/46355364/154312618-43430406-97c1-4740-87be-2414de9a1c06.png) + +--- diff --git a/website/content/terminal/reference/crypto/ta/zlma.md b/website/content/terminal/reference/crypto/ta/zlma.md new file mode 100644 index 000000000000..cb11ba091cd2 --- /dev/null +++ b/website/content/terminal/reference/crypto/ta/zlma.md @@ -0,0 +1,44 @@ +--- +title: zlma +description: The ZLEMA (Zero Lag Exponential Moving Average) is a technical indicator + developed by John Ehlers and Ric Way. This documentation page explains how to use + it, focusing on implementation with Python and specifying its parameters including + window lengths (N_LENGTH) and offset (N_OFFSET). +keywords: +- ZLEMA +- exponential moving average +- de-lagged data +- EMA +- zero lag exponential moving average +- John Ehlers +- Ric Way +- zlma +- N_LENGTH +- N_OFFSET +- parameters +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +The zero lag exponential moving average (ZLEMA) indicator was created by John Ehlers and Ric Way. The idea is do a regular exponential moving average (EMA) calculation but on a de-lagged data instead of doing it on the regular data. Data is de-lagged by removing the data from "lag" days ago thus removing (or attempting to) the cumulative effect of the moving average. + +### Usage + +```python +zlma [-l N_LENGTH] [-o N_OFFSET] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| n_length | Window lengths. Multiple values indicated as comma separated values. | 20 | True | None | +| n_offset | offset | 0 | True | range(0, 100) | + +![zlma](https://user-images.githubusercontent.com/46355364/154312786-bc60268b-9da9-4fd9-bed6-fc95f5560075.png) + +--- diff --git a/website/versioned_docs/version-v3/terminal/reference/crypto/tools/_category_.json b/website/content/terminal/reference/crypto/tools/_category_.json similarity index 100% rename from website/versioned_docs/version-v3/terminal/reference/crypto/tools/_category_.json rename to website/content/terminal/reference/crypto/tools/_category_.json diff --git a/website/content/terminal/reference/crypto/tools/aprtoapy.md b/website/content/terminal/reference/crypto/tools/aprtoapy.md new file mode 100644 index 000000000000..a10243a2e6d9 --- /dev/null +++ b/website/content/terminal/reference/crypto/tools/aprtoapy.md @@ -0,0 +1,35 @@ +--- +title: aprtoapy +description: APR to APY conversion tool. Use aprtoapy tool to compute APY value from + APR, defining the number of compounding periods per year. +keywords: +- aprtoapy +- APR +- APY +- compounding +- finance tools +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Tool to calculate APY from APR value. Compouding periods, i.e., the number of times compounded per year can be defined with -c argument. + +### Usage + +```python +aprtoapy [--apr APR] [-c COMPOUNDING] [-n] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| apr | APR value in percentage to convert | 100 | True | range(1, 101) | +| compounding | Number of compounded periods in a year. 12 means compounding monthly | 12 | True | range(1, 101) | +| narrative | Flag to show narrative instead of dataframe | False | True | None | + +--- diff --git a/website/content/terminal/reference/crypto/tools/il.md b/website/content/terminal/reference/crypto/tools/il.md new file mode 100644 index 000000000000..695cdb7a27ef --- /dev/null +++ b/website/content/terminal/reference/crypto/tools/il.md @@ -0,0 +1,40 @@ +--- +title: il +description: The Document page provides details on the 'il' tool designed to calculate + Impermanent Loss in custom liquidity pools. Including its usage, and parameters + such as token price change and pool proportion, the tool allows users to estimate + potential impermanent losses. +keywords: +- Impermanent Loss +- Liquidity Pool +- Token Price Change +- Pool Proportion +- Dollar Value +- il Tool +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Tool to calculate Impermanent Loss in a custom liquidity pool. Users can provide percentages increases for two tokens (and their weight in the liquidity pool) and verify the impermanent loss that can occur. + +### Usage + +```python +il [-a PRICECHANGEA] [-b PRICECHANGEB] [-p PROPORTION] [-v VALUE] [-n] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| priceChangeA | Token A price change in percentage | 0 | True | range(1, 101) | +| priceChangeB | Token B price change in percentage | 100 | True | range(1, 101) | +| proportion | Pool proportion. E.g., 50 means that pool contains 50%% of token A and 50%% of token B, 30 means that pool contains 30%% of token A and 70%% of token B | 50 | True | range(1, 101) | +| value | Initial amount of dollars that user provides to liquidity pool | 1000 | True | None | +| narrative | Flag to show narrative instead of dataframe | False | True | None | + +--- diff --git a/website/versioned_docs/version-v3/terminal/reference/econometrics/_category_.json b/website/content/terminal/reference/econometrics/_category_.json similarity index 100% rename from website/versioned_docs/version-v3/terminal/reference/econometrics/_category_.json rename to website/content/terminal/reference/econometrics/_category_.json diff --git a/website/content/terminal/reference/econometrics/add.md b/website/content/terminal/reference/econometrics/add.md new file mode 100644 index 000000000000..b27aee69c93d --- /dev/null +++ b/website/content/terminal/reference/econometrics/add.md @@ -0,0 +1,102 @@ +--- +title: add +description: This page provides documentation for the 'add' function in an Econometrics + software. This function allows you to add a new column to your dataset using various + computations on existing columns. +keywords: +- Econometrics +- Data manipulation +- Add function +- Computations +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Add columns to your dataframe with the option to use formulas. E.g. newdatasetcol = basedatasetcol sign criteriaordatasetcol thesis.high_revenue = thesis.revenue 1000 dataset.debt_ratio = dataset.debt div dataset2.assets + +### Usage + +```python +add -n NEWDATASETCOL -b BASEDATASETCOL -s {div,mul,add,sub,mod,pow,,,=,=,==} -c CRITERIAORDATASETCOL +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| newdatasetcol | New dataset column to be added with format: dataset.column | None | False | None | +| basedatasetcol | Base dataset column to be used as base with format: dataset.column | None | False | None | +| sign | Sign to be applied to the base dataset column | None | False | div, mul, add, sub, mod, pow, , , =, =, == | +| criteriaordatasetcol | Either dataset column to be applied on top of base dataset or criteria | None | False | None | + + +--- + +## Examples + +```python +2022 May 31, 04:50 (🦋) /econometrics/ $ load wage_panel -a wp + +2022 May 31, 04:49 (🦋) /econometrics/ $ add -n wp.after_1990 -b wp.year -s -c 1990 + +2022 May 31, 04:49 (🦋) /econometrics/ $ show wp + + Dataset wp | Showing 10 of 4360 rows +┏━━━┳━━━━┳━━━━━━┳━━━━━━━┳━━━━━━━┳━━━━━━┳━━━━━━━┳━━━━━━━━━┳━━━━━━┳━━━━━━━┳━━━━━━━┳━━━━━━━━━┳━━━━━━━━━━━━┳━━━━━━━━━━━━┓ +┃ ┃ nr ┃ year ┃ black ┃ exper ┃ hisp ┃ hours ┃ married ┃ educ ┃ union ┃ lwage ┃ expersq ┃ occupation ┃ after_1990 ┃ +┡━━━╇━━━━╇━━━━━━╇━━━━━━━╇━━━━━━━╇━━━━━━╇━━━━━━━╇━━━━━━━━━╇━━━━━━╇━━━━━━━╇━━━━━━━╇━━━━━━━━━╇━━━━━━━━━━━━╇━━━━━━━━━━━━┩ +│ 0 │ 13 │ 1980 │ 0 │ 1 │ 0 │ 2672 │ 0 │ 14 │ 0 │ 1.20 │ 1 │ 9 │ False │ +├───┼────┼──────┼───────┼───────┼──────┼───────┼─────────┼──────┼───────┼───────┼─────────┼────────────┼────────────┤ +│ 1 │ 13 │ 1981 │ 0 │ 2 │ 0 │ 2320 │ 0 │ 14 │ 1 │ 1.85 │ 4 │ 9 │ False │ +├───┼────┼──────┼───────┼───────┼──────┼───────┼─────────┼──────┼───────┼───────┼─────────┼────────────┼────────────┤ +│ 2 │ 13 │ 1982 │ 0 │ 3 │ 0 │ 2940 │ 0 │ 14 │ 0 │ 1.34 │ 9 │ 9 │ False │ +├───┼────┼──────┼───────┼───────┼──────┼───────┼─────────┼──────┼───────┼───────┼─────────┼────────────┼────────────┤ +│ 3 │ 13 │ 1983 │ 0 │ 4 │ 0 │ 2960 │ 0 │ 14 │ 0 │ 1.43 │ 16 │ 9 │ False │ +├───┼────┼──────┼───────┼───────┼──────┼───────┼─────────┼──────┼───────┼───────┼─────────┼────────────┼────────────┤ +│ 4 │ 13 │ 1984 │ 0 │ 5 │ 0 │ 3071 │ 0 │ 14 │ 0 │ 1.57 │ 25 │ 5 │ False │ +├───┼────┼──────┼───────┼───────┼──────┼───────┼─────────┼──────┼───────┼───────┼─────────┼────────────┼────────────┤ +│ 5 │ 13 │ 1985 │ 0 │ 6 │ 0 │ 2864 │ 0 │ 14 │ 0 │ 1.70 │ 36 │ 2 │ False │ +├───┼────┼──────┼───────┼───────┼──────┼───────┼─────────┼──────┼───────┼───────┼─────────┼────────────┼────────────┤ +│ 6 │ 13 │ 1986 │ 0 │ 7 │ 0 │ 2994 │ 0 │ 14 │ 0 │ -0.72 │ 49 │ 2 │ False │ +├───┼────┼──────┼───────┼───────┼──────┼───────┼─────────┼──────┼───────┼───────┼─────────┼────────────┼────────────┤ +│ 7 │ 13 │ 1987 │ 0 │ 8 │ 0 │ 2640 │ 0 │ 14 │ 0 │ 1.67 │ 64 │ 2 │ False │ +├───┼────┼──────┼───────┼───────┼──────┼───────┼─────────┼──────┼───────┼───────┼─────────┼────────────┼────────────┤ +│ 8 │ 17 │ 1980 │ 0 │ 4 │ 0 │ 2484 │ 0 │ 13 │ 0 │ 1.68 │ 16 │ 2 │ False │ +├───┼────┼──────┼───────┼───────┼──────┼───────┼─────────┼──────┼───────┼───────┼─────────┼────────────┼────────────┤ +│ 9 │ 17 │ 1981 │ 0 │ 5 │ 0 │ 2804 │ 0 │ 13 │ 0 │ 1.52 │ 25 │ 2 │ False │ +└───┴────┴──────┴───────┴───────┴──────┴───────┴─────────┴──────┴───────┴───────┴─────────┴────────────┴────────────┘ + +2022 May 31, 04:49 (🦋) /econometrics/ $ add -n wp.after_1985 -b wp.year -s -c 1985 + +2022 May 31, 04:50 (🦋) /econometrics/ $ show wp + + Dataset wp | Showing 10 of 4360 rows +┏━━━┳━━━━┳━━━━━━┳━━━━━━━┳━━━━━━━┳━━━━━━┳━━━━━━━┳━━━━━━━━━┳━━━━━━┳━━━━━━━┳━━━━━━━┳━━━━━━━━━┳━━━━━━━━━━━━┳━━━━━━━━━━━━┳━━━━━━━━━━━━┓ +┃ ┃ nr ┃ year ┃ black ┃ exper ┃ hisp ┃ hours ┃ married ┃ educ ┃ union ┃ lwage ┃ expersq ┃ occupation ┃ after_1990 ┃ after_1985 ┃ +┡━━━╇━━━━╇━━━━━━╇━━━━━━━╇━━━━━━━╇━━━━━━╇━━━━━━━╇━━━━━━━━━╇━━━━━━╇━━━━━━━╇━━━━━━━╇━━━━━━━━━╇━━━━━━━━━━━━╇━━━━━━━━━━━━╇━━━━━━━━━━━━┩ +│ 0 │ 13 │ 1980 │ 0 │ 1 │ 0 │ 2672 │ 0 │ 14 │ 0 │ 1.20 │ 1 │ 9 │ False │ False │ +├───┼────┼──────┼───────┼───────┼──────┼───────┼─────────┼──────┼───────┼───────┼─────────┼────────────┼────────────┼────────────┤ +│ 1 │ 13 │ 1981 │ 0 │ 2 │ 0 │ 2320 │ 0 │ 14 │ 1 │ 1.85 │ 4 │ 9 │ False │ False │ +├───┼────┼──────┼───────┼───────┼──────┼───────┼─────────┼──────┼───────┼───────┼─────────┼────────────┼────────────┼────────────┤ +│ 2 │ 13 │ 1982 │ 0 │ 3 │ 0 │ 2940 │ 0 │ 14 │ 0 │ 1.34 │ 9 │ 9 │ False │ False │ +├───┼────┼──────┼───────┼───────┼──────┼───────┼─────────┼──────┼───────┼───────┼─────────┼────────────┼────────────┼────────────┤ +│ 3 │ 13 │ 1983 │ 0 │ 4 │ 0 │ 2960 │ 0 │ 14 │ 0 │ 1.43 │ 16 │ 9 │ False │ False │ +├───┼────┼──────┼───────┼───────┼──────┼───────┼─────────┼──────┼───────┼───────┼─────────┼────────────┼────────────┼────────────┤ +│ 4 │ 13 │ 1984 │ 0 │ 5 │ 0 │ 3071 │ 0 │ 14 │ 0 │ 1.57 │ 25 │ 5 │ False │ False │ +├───┼────┼──────┼───────┼───────┼──────┼───────┼─────────┼──────┼───────┼───────┼─────────┼────────────┼────────────┼────────────┤ +│ 5 │ 13 │ 1985 │ 0 │ 6 │ 0 │ 2864 │ 0 │ 14 │ 0 │ 1.70 │ 36 │ 2 │ False │ False │ +├───┼────┼──────┼───────┼───────┼──────┼───────┼─────────┼──────┼───────┼───────┼─────────┼────────────┼────────────┼────────────┤ +│ 6 │ 13 │ 1986 │ 0 │ 7 │ 0 │ 2994 │ 0 │ 14 │ 0 │ -0.72 │ 49 │ 2 │ False │ True │ +├───┼────┼──────┼───────┼───────┼──────┼───────┼─────────┼──────┼───────┼───────┼─────────┼────────────┼────────────┼────────────┤ +│ 7 │ 13 │ 1987 │ 0 │ 8 │ 0 │ 2640 │ 0 │ 14 │ 0 │ 1.67 │ 64 │ 2 │ False │ True │ +├───┼────┼──────┼───────┼───────┼──────┼───────┼─────────┼──────┼───────┼───────┼─────────┼────────────┼────────────┼────────────┤ +│ 8 │ 17 │ 1980 │ 0 │ 4 │ 0 │ 2484 │ 0 │ 13 │ 0 │ 1.68 │ 16 │ 2 │ False │ False │ +├───┼────┼──────┼───────┼───────┼──────┼───────┼─────────┼──────┼───────┼───────┼─────────┼────────────┼────────────┼────────────┤ +│ 9 │ 17 │ 1981 │ 0 │ 5 │ 0 │ 2804 │ 0 │ 13 │ 0 │ 1.52 │ 25 │ 2 │ False │ False │ +└───┴────┴──────┴───────┴───────┴──────┴───────┴─────────┴──────┴───────┴───────┴─────────┴────────────┴────────────┴────────────┘ +``` +--- diff --git a/website/content/terminal/reference/econometrics/bgod.md b/website/content/terminal/reference/econometrics/bgod.md new file mode 100644 index 000000000000..da409065f5bc --- /dev/null +++ b/website/content/terminal/reference/econometrics/bgod.md @@ -0,0 +1,100 @@ +--- +title: bgod +description: This page provides the usage, parameters, and examples of the Breusch-Godfrey + autocorrelation test in Python. It's useful for individuals working with OLS Regression + Results and other econometrics. The BGOD page increases understanding of this functionality + within Python. +keywords: +- Breusch-Godfrey +- Autocorrelation Test +- OLS Regression Results +- Econometrics +- BGOD +- Metadata +- Least Squares Method +- Durbin-Watson +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Show Breusch-Godfrey autocorrelation test results.Needs OLS to be run in advance with independent and dependent variables + +### Usage + +```python +bgod [-l LAGS] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| lags | The lags for the Breusch-Godfrey test | 3 | True | None | + + +--- + +## Examples + +```python +2022 Jun 01, 06:29 (🦋) /econometrics/ $ load longley -a ll + +2022 Jun 01, 06:29 (🦋) /econometrics/ $ ols -d ll.totemp -i ll.gnpdefl,ll.gnp,ll.unemp,ll.armed,ll.pop,ll.year + OLS Regression Results +======================================================================================= +Dep. Variable: ll.totemp R-squared (uncentered): 1.000 +Model: OLS Adj. R-squared (uncentered): 1.000 +Method: Least Squares F-statistic: 5.052e+04 +Date: Wed, 01 Jun 2022 Prob (F-statistic): 8.20e-22 +Time: 12:29:44 Log-Likelihood: -117.56 +No. Observations: 16 AIC: 247.1 +Df Residuals: 10 BIC: 251.8 +Df Model: 6 +Covariance Type: nonrobust +============================================================================== + coef std err t P|t| [0.025 0.975] +------------------------------------------------------------------------------ +ll.gnpdefl -52.9936 129.545 -0.409 0.691 -341.638 235.650 +ll.gnp 0.0711 0.030 2.356 0.040 0.004 0.138 +ll.unemp -0.4235 0.418 -1.014 0.335 -1.354 0.507 +ll.armed -0.5726 0.279 -2.052 0.067 -1.194 0.049 +ll.pop -0.4142 0.321 -1.289 0.226 -1.130 0.302 +ll.year 48.4179 17.689 2.737 0.021 9.003 87.832 +============================================================================== +Omnibus: 1.443 Durbin-Watson: 1.277 +Prob(Omnibus): 0.486 Jarque-Bera (JB): 0.605 +Skew: 0.476 Prob(JB): 0.739 +Kurtosis: 3.031 Cond. No. 4.56e+05 +============================================================================== + +Notes: +[1] R² is computed without centering (uncentered) since the model does not contain a constant. +[2] Standard Errors assume that the covariance matrix of the errors is correctly specified. +[3] The condition number is large, 4.56e+05. This might indicate that there are +strong multicollinearity or other numerical problems. + +Warnings: +kurtosistest only valid for n=20 ... continuing anyway, n=16 + +2022 Jun 01, 06:29 (🦋) /econometrics/ $ bgod + +Breusch-Godfrey autocorrelation test [Lags: 3] +┏━━━━━━━━━━┳━━━━━━━━━━━━━━━━━┓ +┃ ┃ Breusch-Godfrey ┃ +┡━━━━━━━━━━╇━━━━━━━━━━━━━━━━━┩ +│ LM-stat │ 10.35 │ +├──────────┼─────────────────┤ +│ p-value │ 0.02 │ +├──────────┼─────────────────┤ +│ f-stat │ 0.10 │ +├──────────┼─────────────────┤ +│ fp-value │ 0.96 │ +└──────────┴─────────────────┘ + +The result 0.02 indicates no existence of autocorrelation. +``` +--- diff --git a/website/content/terminal/reference/econometrics/bpag.md b/website/content/terminal/reference/econometrics/bpag.md new file mode 100644 index 000000000000..01d075d41f25 --- /dev/null +++ b/website/content/terminal/reference/econometrics/bpag.md @@ -0,0 +1,97 @@ +--- +title: bpag +description: The page provides information on how to use the 'bpag' command to conduct + the Breusch-Pagan heteroscedasticity test in econometrics. It requires running OLS + with dependent and independent variables and shows whether there is heteroscedasticity + in the data. +keywords: +- Breusch-Pagan test +- heteroscedasticity test +- OLS +- econometrics +- bpag command +- data analysis +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Show Breusch-Pagan heteroscedasticity test results. Needs OLS to be run in advance with independent and dependent variables + +### Usage + +```python +bpag +``` + +--- + +## Parameters + +This command has no parameters + + + +--- + +## Examples + +```python +2022 Jun 01, 06:29 (🦋) /econometrics/ $ load longley -a ll + +2022 Jun 01, 06:29 (🦋) /econometrics/ $ ols -d ll.totemp -i ll.gnpdefl,ll.gnp,ll.unemp,ll.armed,ll.pop,ll.year + OLS Regression Results +======================================================================================= +Dep. Variable: ll.totemp R-squared (uncentered): 1.000 +Model: OLS Adj. R-squared (uncentered): 1.000 +Method: Least Squares F-statistic: 5.052e+04 +Date: Wed, 01 Jun 2022 Prob (F-statistic): 8.20e-22 +Time: 12:29:44 Log-Likelihood: -117.56 +No. Observations: 16 AIC: 247.1 +Df Residuals: 10 BIC: 251.8 +Df Model: 6 +Covariance Type: nonrobust +============================================================================== + coef std err t P|t| [0.025 0.975] +------------------------------------------------------------------------------ +ll.gnpdefl -52.9936 129.545 -0.409 0.691 -341.638 235.650 +ll.gnp 0.0711 0.030 2.356 0.040 0.004 0.138 +ll.unemp -0.4235 0.418 -1.014 0.335 -1.354 0.507 +ll.armed -0.5726 0.279 -2.052 0.067 -1.194 0.049 +ll.pop -0.4142 0.321 -1.289 0.226 -1.130 0.302 +ll.year 48.4179 17.689 2.737 0.021 9.003 87.832 +============================================================================== +Omnibus: 1.443 Durbin-Watson: 1.277 +Prob(Omnibus): 0.486 Jarque-Bera (JB): 0.605 +Skew: 0.476 Prob(JB): 0.739 +Kurtosis: 3.031 Cond. No. 4.56e+05 +============================================================================== + +Notes: +[1] R² is computed without centering (uncentered) since the model does not contain a constant. +[2] Standard Errors assume that the covariance matrix of the errors is correctly specified. +[3] The condition number is large, 4.56e+05. This might indicate that there are +strong multicollinearity or other numerical problems. + +Warnings: +kurtosistest only valid for n=20 ... continuing anyway, n=16 + +2022 Jun 01, 06:30 (🦋) /econometrics/ $ bpag + +Breusch-Pagan heteroscedasticity test +┏━━━━━━━━━━┳━━━━━━━━━━━━━━━┓ +┃ ┃ Breusch-Pagan ┃ +┡━━━━━━━━━━╇━━━━━━━━━━━━━━━┩ +│ lm-stat │ 7.90 │ +├──────────┼───────────────┤ +│ p-value │ 0.16 │ +├──────────┼───────────────┤ +│ f-stat │ 1.63 │ +├──────────┼───────────────┤ +│ fp-value │ 0.24 │ +└──────────┴───────────────┘ + +The result 0.16 indicates the existence of heteroscedasticity. Consider taking the log or a rate for the dependent variable. +``` +--- diff --git a/website/content/terminal/reference/econometrics/clean.md b/website/content/terminal/reference/econometrics/clean.md new file mode 100644 index 000000000000..d7d20974570b --- /dev/null +++ b/website/content/terminal/reference/econometrics/clean.md @@ -0,0 +1,72 @@ +--- +title: clean +description: This documentation page provides in-depth instructions on how to clean + a dataset by filling and dropping NaN values using different methods. It covers + the use of the function, parameters, choices, and detailed examples. +keywords: +- dataset cleaning +- NaN values +- data processing +- Python functions +- data analysis +- SEO optimization +- filling methods +- dropping methods +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Clean a dataset by filling and dropping NaN values. + +### Usage + +```python +clean [-n {}] [--fill {rfill,cfill,rbfill,cbfill,rffill,bffill}] [-d {rdrop,cdrop}] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| name | The name of the dataset you want to clean up | None | True | None | +| fill | The method of filling NaNs. This has options to fill rows (rfill, rbfill, rffill) or fill columns (cfill, cbfill, cffill). Furthermore, it has the option to forward fill and backward fill (up to --limit) which refer to how many rows/columns can be set equal to the last non-NaN value | | True | rfill, cfill, rbfill, cbfill, rffill, bffill | +| drop | The method of dropping NaNs. This either has the option rdrop (drop rows that contain NaNs) or cdrop (drop columns that contain NaNs) | | True | rdrop, cdrop | + + +--- + +## Examples + +```python +txt +2022 Feb 24, 04:58 (🦋) /econometrics/ $ show thesis + thesis +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━┳━━━━━━━━━┳━━━━━━━━┳━━━━━━━━━━━┳━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━┳━━━━━━━━┳━━━━━━━━━━━━━━━━━━┓ +┃ ┃ current_assets ┃ assets ┃ debt ┃ depr_amor ┃ income ┃ current_liabilities ┃ revenue ┃ equity ┃ interest_expense ┃ +┡━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━╇━━━━━━━━━╇━━━━━━━━╇━━━━━━━━━━━╇━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━╇━━━━━━━━╇━━━━━━━━━━━━━━━━━━┩ +│ ('AAR Corp', Timestamp('2016-01-01 00:00:00')) │ 970.70 │ 1522.00 │ 160.00 │ 18.50 │ 9.90 │ 359.70 │ 412.10 │ 858.30 │ 1.70 │ +├────────────────────────────────────────────────┼────────────────┼─────────┼────────┼───────────┼────────┼─────────────────────┼─────────┼────────┼──────────────────┤ +│ ('AAR Corp', Timestamp('2016-04-01 00:00:00')) │ 873.10 │ 1442.10 │ 136.10 │ 17.80 │ 11.80 │ 329.00 │ 468.60 │ 865.80 │ 1.20 │ +├────────────────────────────────────────────────┼────────────────┼─────────┼────────┼───────────┼────────┼─────────────────────┼─────────┼────────┼──────────────────┤ +│ ('AAR Corp', Timestamp('2016-07-01 00:00:00')) │ 849.40 │ 1427.00 │ 142.80 │ nan │ 9.90 │ 314.40 │ 404.80 │ 858.50 │ 1.30 │ +├────────────────────────────────────────────────┼────────────────┼─────────┼────────┼───────────┼────────┼─────────────────────┼─────────┼────────┼──────────────────┤ +│ ('AAR Corp', Timestamp('2016-10-01 00:00:00')) │ 901.80 │ 1486.60 │ 154.10 │ nan │ 11.40 │ 350.90 │ 328.30 │ 872.40 │ 1.10 │ +├────────────────────────────────────────────────┼────────────────┼─────────┼────────┼───────────┼────────┼─────────────────────┼─────────┼────────┼──────────────────┤ +│ ('AAR Corp', Timestamp('2017-01-01 00:00:00')) │ 893.10 │ 1502.10 │ 168.70 │ nan │ 14.40 │ 342.80 │ 407.20 │ 885.70 │ 1.40 │ +├────────────────────────────────────────────────┼────────────────┼─────────┼────────┼───────────┼────────┼─────────────────────┼─────────┼────────┼──────────────────┤ +│ ('AAR Corp', Timestamp('2017-04-01 00:00:00')) │ 888.50 │ 1504.10 │ 155.30 │ nan │ 16.30 │ 335.10 │ 450.50 │ 914.20 │ 1.50 │ +├────────────────────────────────────────────────┼────────────────┼─────────┼────────┼───────────┼────────┼─────────────────────┼─────────┼────────┼──────────────────┤ +│ ('AAR Corp', Timestamp('2017-07-01 00:00:00')) │ 904.70 │ 1531.70 │ 189.00 │ 10.20 │ 11.00 │ 312.10 │ 397.90 │ 924.70 │ 1.70 │ +├────────────────────────────────────────────────┼────────────────┼─────────┼────────┼───────────┼────────┼─────────────────────┼─────────┼────────┼──────────────────┤ +│ ('AAR Corp', Timestamp('2017-10-01 00:00:00')) │ 892.20 │ 1544.30 │ 215.80 │ 10.60 │ 13.30 │ 336.50 │ 420.60 │ 906.50 │ 1.90 │ +├────────────────────────────────────────────────┼────────────────┼─────────┼────────┼───────────┼────────┼─────────────────────┼─────────┼────────┼──────────────────┤ +│ ('AAR Corp', Timestamp('2018-01-01 00:00:00')) │ 933.60 │ 1512.20 │ 194.30 │ 10.60 │ 31.30 │ 326.60 │ 456.30 │ 915.20 │ 2.20 │ +├────────────────────────────────────────────────┼────────────────┼─────────┼────────┼───────────┼────────┼─────────────────────┼─────────┼────────┼──────────────────┤ +│ ('AAR Corp', Timestamp('2018-04-01 00:00:00')) │ 942.70 │ 1524.70 │ 177.20 │ 9.10 │ 18.10 │ 333.30 │ 473.50 │ 936.30 │ 2.20 │ +└────────────────────────────────────────────────┴────────────────┴─────────┴────────┴───────────┴────────┴─────────────────────┴─────────┴────────┴──────────────────┘ +``` +--- diff --git a/website/content/terminal/reference/econometrics/coint.md b/website/content/terminal/reference/econometrics/coint.md new file mode 100644 index 000000000000..e20094e28910 --- /dev/null +++ b/website/content/terminal/reference/econometrics/coint.md @@ -0,0 +1,64 @@ +--- +title: coint +description: The Coint page provides users with an explanation and guideline on how + to show co-integration between two timeseries. It includes parameter descriptions, + usage, and examples. +keywords: +- coint +- co-integration +- timeseries +- plot +- significant +- parameters +- examples +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Show co-integration between two timeseries + +### Usage + +```python +coint -t TS [-p] [-s SIGNIFICANT] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| ts | The time series you wish to test co-integration on. E.g. historical.open,historical2.close. | None | False | None | +| plot | Plot Z-Values | False | True | None | +| significant | Show only companies that have p-values lower than this percentage | 0 | True | None | + + +--- + +## Examples + +```python +2022 Feb 24, 06:03 (🦋) /econometrics/ $ coint msft.adj_close,aapl.adj_close,tsla.adj_close,googl.adj_close -p + Cointegration Tests +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━┳━━━━━━━┳━━━━━━━┳━━━━━━━━━━━━━━━┳━━━━━━━━━┓ +┃ Pairs ┃ Constant ┃ Gamma ┃ Alpha ┃ Dickey-Fuller ┃ P Value ┃ +┡━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━╇━━━━━━━╇━━━━━━━╇━━━━━━━━━━━━━━━╇━━━━━━━━━┩ +│ adj_close-msft/adj_close-aapl │ 46.62 │ 1.58 │ 0.00 │ -1.86 │ 0.35 │ +├────────────────────────────────┼──────────┼───────┼───────┼───────────────┼─────────┤ +│ adj_close-msft/adj_close-tsla │ 130.28 │ 0.18 │ -0.01 │ -2.82 │ 0.06 │ +├────────────────────────────────┼──────────┼───────┼───────┼───────────────┼─────────┤ +│ adj_close-msft/adj_close-googl │ 21.38 │ 0.10 │ -0.01 │ -2.51 │ 0.11 │ +├────────────────────────────────┼──────────┼───────┼───────┼───────────────┼─────────┤ +│ adj_close-aapl/adj_close-tsla │ 53.92 │ 0.11 │ -0.01 │ -2.94 │ 0.04 │ +├────────────────────────────────┼──────────┼───────┼───────┼───────────────┼─────────┤ +│ adj_close-aapl/adj_close-googl │ -7.83 │ 0.06 │ -0.00 │ -1.62 │ 0.47 │ +├────────────────────────────────┼──────────┼───────┼───────┼───────────────┼─────────┤ +│ adj_close-tsla/adj_close-googl │ -505.14 │ 0.51 │ -0.01 │ -2.28 │ 0.18 │ +└────────────────────────────────┴──────────┴───────┴───────┴───────────────┴─────────┘ +``` +![error_terms_cointegrations](https://user-images.githubusercontent.com/46355364/155514964-dd75cf17-91ae-4326-96e8-45d9a2c7b24a.png) + +--- diff --git a/website/content/terminal/reference/econometrics/combine.md b/website/content/terminal/reference/econometrics/combine.md new file mode 100644 index 000000000000..ddc956fd68c8 --- /dev/null +++ b/website/content/terminal/reference/econometrics/combine.md @@ -0,0 +1,75 @@ +--- +title: combine +description: This page provides comprehensive documentation on the 'combine' function, + including its usage with Python, parameters, and clear, practical examples. Combine + is essential when dealing with datasets, particularly when you need to add specific + columns. +keywords: +- combine +- datasets +- columns +- parameters +- add columns +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +The columns you want to add to a dataset. The first argument is the dataset to add columns inand the remaining could be: datasetX.column2,datasetY.column3 + +### Usage + +```python +combine [-d {}] [-c COLUMNS] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| dataset | Dataset to add columns to | None | True | None | +| columns | The columns we want to add dataset.column,dataset.column2 | None | True | None | + + +--- + +## Examples + +```python +2022 May 31, 04:54 (🦋) /econometrics/ $ load nile + +2022 May 31, 04:54 (🦋) /econometrics/ $ load nile -a nile_2 + +2022 May 31, 04:54 (🦋) /econometrics/ $ combine nile -c nile_2.volume + +2022 May 31, 04:55 (🦋) /econometrics/ $ show nile + + Dataset nile | Showing 10 of 100 rows +┏━━━┳━━━━━━━━━┳━━━━━━━━━┳━━━━━━━━━━━━━━━┓ +┃ ┃ year ┃ volume ┃ nile_2_volume ┃ +┡━━━╇━━━━━━━━━╇━━━━━━━━━╇━━━━━━━━━━━━━━━┩ +│ 0 │ 1871.00 │ 1120.00 │ 1120.00 │ +├───┼─────────┼─────────┼───────────────┤ +│ 1 │ 1872.00 │ 1160.00 │ 1160.00 │ +├───┼─────────┼─────────┼───────────────┤ +│ 2 │ 1873.00 │ 963.00 │ 963.00 │ +├───┼─────────┼─────────┼───────────────┤ +│ 3 │ 1874.00 │ 1210.00 │ 1210.00 │ +├───┼─────────┼─────────┼───────────────┤ +│ 4 │ 1875.00 │ 1160.00 │ 1160.00 │ +├───┼─────────┼─────────┼───────────────┤ +│ 5 │ 1876.00 │ 1160.00 │ 1160.00 │ +├───┼─────────┼─────────┼───────────────┤ +│ 6 │ 1877.00 │ 813.00 │ 813.00 │ +├───┼─────────┼─────────┼───────────────┤ +│ 7 │ 1878.00 │ 1230.00 │ 1230.00 │ +├───┼─────────┼─────────┼───────────────┤ +│ 8 │ 1879.00 │ 1370.00 │ 1370.00 │ +├───┼─────────┼─────────┼───────────────┤ +│ 9 │ 1880.00 │ 1140.00 │ 1140.00 │ +└───┴─────────┴─────────┴───────────────┘ +``` +--- diff --git a/website/content/terminal/reference/econometrics/compare.md b/website/content/terminal/reference/econometrics/compare.md new file mode 100644 index 000000000000..18ba53b7b50b --- /dev/null +++ b/website/content/terminal/reference/econometrics/compare.md @@ -0,0 +1,33 @@ +--- +title: compare +description: Detailed documentation on the 'compare' function, a python command for + comparing results between all activated Panel regression models. This function doesn't + require any parameters. +keywords: +- compare +- Panel regression models +- activated +- models +- results +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Compare results between all activated Panel regression models + +### Usage + +```python +compare +``` + +--- + +## Parameters + +This command has no parameters + + +--- diff --git a/website/content/terminal/reference/econometrics/delete.md b/website/content/terminal/reference/econometrics/delete.md new file mode 100644 index 000000000000..9a4867eacd96 --- /dev/null +++ b/website/content/terminal/reference/econometrics/delete.md @@ -0,0 +1,100 @@ +--- +title: delete +description: This documentation page provides a detailed overview of how to use the + 'delete' command to remove specified columns from a dataset. It includes usage examples + and explanations of command parameters to help users leverage this tool more effectively + in their data manipulation tasks. +keywords: +- delete command +- dataset manipulation +- data column removal +- docusaurus +- command usage +- data management +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +The column you want to delete from a dataset. + +### Usage + +```python +delete [-d DELETE] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| delete | The columns you want to delete from a dataset. Use format: dataset.column or multiple with dataset.column,dataset.column2 | None | True | None | + + +--- + +## Examples + +```python +2022 May 31, 04:53 (🦋) /econometrics/ $ load wage_panel -a wp + +2022 May 31, 04:53 (🦋) /econometrics/ $ show wp + + Dataset wp | Showing 10 of 4360 rows +┏━━━┳━━━━━━━┳━━━━━━━━━┳━━━━━━━┳━━━━━━━┳━━━━━━┳━━━━━━━━━┳━━━━━━━━━┳━━━━━━━┳━━━━━━━┳━━━━━━━┳━━━━━━━━━┳━━━━━━━━━━━━┓ +┃ ┃ nr ┃ year ┃ black ┃ exper ┃ hisp ┃ hours ┃ married ┃ educ ┃ union ┃ lwage ┃ expersq ┃ occupation ┃ +┡━━━╇━━━━━━━╇━━━━━━━━━╇━━━━━━━╇━━━━━━━╇━━━━━━╇━━━━━━━━━╇━━━━━━━━━╇━━━━━━━╇━━━━━━━╇━━━━━━━╇━━━━━━━━━╇━━━━━━━━━━━━┩ +│ 0 │ 13.00 │ 1980.00 │ 0.00 │ 1.00 │ 0.00 │ 2672.00 │ 0.00 │ 14.00 │ 0.00 │ 1.20 │ 1.00 │ 9.00 │ +├───┼───────┼─────────┼───────┼───────┼──────┼─────────┼─────────┼───────┼───────┼───────┼─────────┼────────────┤ +│ 1 │ 13.00 │ 1981.00 │ 0.00 │ 2.00 │ 0.00 │ 2320.00 │ 0.00 │ 14.00 │ 1.00 │ 1.85 │ 4.00 │ 9.00 │ +├───┼───────┼─────────┼───────┼───────┼──────┼─────────┼─────────┼───────┼───────┼───────┼─────────┼────────────┤ +│ 2 │ 13.00 │ 1982.00 │ 0.00 │ 3.00 │ 0.00 │ 2940.00 │ 0.00 │ 14.00 │ 0.00 │ 1.34 │ 9.00 │ 9.00 │ +├───┼───────┼─────────┼───────┼───────┼──────┼─────────┼─────────┼───────┼───────┼───────┼─────────┼────────────┤ +│ 3 │ 13.00 │ 1983.00 │ 0.00 │ 4.00 │ 0.00 │ 2960.00 │ 0.00 │ 14.00 │ 0.00 │ 1.43 │ 16.00 │ 9.00 │ +├───┼───────┼─────────┼───────┼───────┼──────┼─────────┼─────────┼───────┼───────┼───────┼─────────┼────────────┤ +│ 4 │ 13.00 │ 1984.00 │ 0.00 │ 5.00 │ 0.00 │ 3071.00 │ 0.00 │ 14.00 │ 0.00 │ 1.57 │ 25.00 │ 5.00 │ +├───┼───────┼─────────┼───────┼───────┼──────┼─────────┼─────────┼───────┼───────┼───────┼─────────┼────────────┤ +│ 5 │ 13.00 │ 1985.00 │ 0.00 │ 6.00 │ 0.00 │ 2864.00 │ 0.00 │ 14.00 │ 0.00 │ 1.70 │ 36.00 │ 2.00 │ +├───┼───────┼─────────┼───────┼───────┼──────┼─────────┼─────────┼───────┼───────┼───────┼─────────┼────────────┤ +│ 6 │ 13.00 │ 1986.00 │ 0.00 │ 7.00 │ 0.00 │ 2994.00 │ 0.00 │ 14.00 │ 0.00 │ -0.72 │ 49.00 │ 2.00 │ +├───┼───────┼─────────┼───────┼───────┼──────┼─────────┼─────────┼───────┼───────┼───────┼─────────┼────────────┤ +│ 7 │ 13.00 │ 1987.00 │ 0.00 │ 8.00 │ 0.00 │ 2640.00 │ 0.00 │ 14.00 │ 0.00 │ 1.67 │ 64.00 │ 2.00 │ +├───┼───────┼─────────┼───────┼───────┼──────┼─────────┼─────────┼───────┼───────┼───────┼─────────┼────────────┤ +│ 8 │ 17.00 │ 1980.00 │ 0.00 │ 4.00 │ 0.00 │ 2484.00 │ 0.00 │ 13.00 │ 0.00 │ 1.68 │ 16.00 │ 2.00 │ +├───┼───────┼─────────┼───────┼───────┼──────┼─────────┼─────────┼───────┼───────┼───────┼─────────┼────────────┤ +│ 9 │ 17.00 │ 1981.00 │ 0.00 │ 5.00 │ 0.00 │ 2804.00 │ 0.00 │ 13.00 │ 0.00 │ 1.52 │ 25.00 │ 2.00 │ +└───┴───────┴─────────┴───────┴───────┴──────┴─────────┴─────────┴───────┴───────┴───────┴─────────┴────────────┘ + +2022 May 31, 04:53 (🦋) /econometrics/ $ delete wp.year,wp.black,wp.exper + +2022 May 31, 04:53 (🦋) /econometrics/ $ show wp + + Dataset wp | Showing 10 of 4360 rows +┏━━━┳━━━━━━━┳━━━━━━┳━━━━━━━━━┳━━━━━━━━━┳━━━━━━━┳━━━━━━━┳━━━━━━━┳━━━━━━━━━┳━━━━━━━━━━━━┓ +┃ ┃ nr ┃ hisp ┃ hours ┃ married ┃ educ ┃ union ┃ lwage ┃ expersq ┃ occupation ┃ +┡━━━╇━━━━━━━╇━━━━━━╇━━━━━━━━━╇━━━━━━━━━╇━━━━━━━╇━━━━━━━╇━━━━━━━╇━━━━━━━━━╇━━━━━━━━━━━━┩ +│ 0 │ 13.00 │ 0.00 │ 2672.00 │ 0.00 │ 14.00 │ 0.00 │ 1.20 │ 1.00 │ 9.00 │ +├───┼───────┼──────┼─────────┼─────────┼───────┼───────┼───────┼─────────┼────────────┤ +│ 1 │ 13.00 │ 0.00 │ 2320.00 │ 0.00 │ 14.00 │ 1.00 │ 1.85 │ 4.00 │ 9.00 │ +├───┼───────┼──────┼─────────┼─────────┼───────┼───────┼───────┼─────────┼────────────┤ +│ 2 │ 13.00 │ 0.00 │ 2940.00 │ 0.00 │ 14.00 │ 0.00 │ 1.34 │ 9.00 │ 9.00 │ +├───┼───────┼──────┼─────────┼─────────┼───────┼───────┼───────┼─────────┼────────────┤ +│ 3 │ 13.00 │ 0.00 │ 2960.00 │ 0.00 │ 14.00 │ 0.00 │ 1.43 │ 16.00 │ 9.00 │ +├───┼───────┼──────┼─────────┼─────────┼───────┼───────┼───────┼─────────┼────────────┤ +│ 4 │ 13.00 │ 0.00 │ 3071.00 │ 0.00 │ 14.00 │ 0.00 │ 1.57 │ 25.00 │ 5.00 │ +├───┼───────┼──────┼─────────┼─────────┼───────┼───────┼───────┼─────────┼────────────┤ +│ 5 │ 13.00 │ 0.00 │ 2864.00 │ 0.00 │ 14.00 │ 0.00 │ 1.70 │ 36.00 │ 2.00 │ +├───┼───────┼──────┼─────────┼─────────┼───────┼───────┼───────┼─────────┼────────────┤ +│ 6 │ 13.00 │ 0.00 │ 2994.00 │ 0.00 │ 14.00 │ 0.00 │ -0.72 │ 49.00 │ 2.00 │ +├───┼───────┼──────┼─────────┼─────────┼───────┼───────┼───────┼─────────┼────────────┤ +│ 7 │ 13.00 │ 0.00 │ 2640.00 │ 0.00 │ 14.00 │ 0.00 │ 1.67 │ 64.00 │ 2.00 │ +├───┼───────┼──────┼─────────┼─────────┼───────┼───────┼───────┼─────────┼────────────┤ +│ 8 │ 17.00 │ 0.00 │ 2484.00 │ 0.00 │ 13.00 │ 0.00 │ 1.68 │ 16.00 │ 2.00 │ +├───┼───────┼──────┼─────────┼─────────┼───────┼───────┼───────┼─────────┼────────────┤ +│ 9 │ 17.00 │ 0.00 │ 2804.00 │ 0.00 │ 13.00 │ 0.00 │ 1.52 │ 25.00 │ 2.00 │ +└───┴───────┴──────┴─────────┴─────────┴───────┴───────┴───────┴─────────┴────────────┘ +``` +--- diff --git a/website/content/terminal/reference/econometrics/desc.md b/website/content/terminal/reference/econometrics/desc.md new file mode 100644 index 000000000000..bdea882fb410 --- /dev/null +++ b/website/content/terminal/reference/econometrics/desc.md @@ -0,0 +1,90 @@ +--- +title: desc +description: Easily analyze data with the desc command in Python. Generate comprehensive + descriptive statistics for each column in your dataset; such as count, mean, standard + deviation, min, max, etc. Ideal for econometric analysis and other forms of statistical + insights. +keywords: +- data analysis +- descriptive statistics +- dataset +- econometrics +- statistics for dataset +- anes96 dataset +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Show the descriptive statistics of the dataset + +### Usage + +```python +desc -n {} +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| name | The name of the dataset.column you want to show the descriptive statistics | None | False | None | + + +--- + +## Examples + +```python +2022 Jun 01, 06:50 (🦋) /econometrics/ $ load anes96 + +2022 Jun 01, 06:51 (🦋) /econometrics/ $ desc anes96 + + Statistics for dataset: 'anes96' +┏━━━━━━━┳━━━━━━━━━┳━━━━━━━━┳━━━━━━━━┳━━━━━━━━┳━━━━━━━━┳━━━━━━━━┳━━━━━━━━┳━━━━━━━━┳━━━━━━━━┳━━━━━━━━┳━━━━━━━━━━┓ +┃ ┃ popul ┃ tvnews ┃ selflr ┃ clinlr ┃ dolelr ┃ pid ┃ age ┃ educ ┃ income ┃ vote ┃ logpopul ┃ +┡━━━━━━━╇━━━━━━━━━╇━━━━━━━━╇━━━━━━━━╇━━━━━━━━╇━━━━━━━━╇━━━━━━━━╇━━━━━━━━╇━━━━━━━━╇━━━━━━━━╇━━━━━━━━╇━━━━━━━━━━┩ +│ count │ 944.00 │ 944.00 │ 944.00 │ 944.00 │ 944.00 │ 944.00 │ 944.00 │ 944.00 │ 944.00 │ 944.00 │ 944.00 │ +├───────┼─────────┼────────┼────────┼────────┼────────┼────────┼────────┼────────┼────────┼────────┼──────────┤ +│ mean │ 306.38 │ 3.73 │ 4.33 │ 2.94 │ 5.39 │ 2.84 │ 47.04 │ 4.57 │ 16.33 │ 0.42 │ 2.47 │ +├───────┼─────────┼────────┼────────┼────────┼────────┼────────┼────────┼────────┼────────┼────────┼──────────┤ +│ std │ 1082.61 │ 2.68 │ 1.44 │ 1.38 │ 1.27 │ 2.27 │ 16.42 │ 1.60 │ 5.97 │ 0.49 │ 3.19 │ +├───────┼─────────┼────────┼────────┼────────┼────────┼────────┼────────┼────────┼────────┼────────┼──────────┤ +│ min │ 0.00 │ 0.00 │ 1.00 │ 1.00 │ 1.00 │ 0.00 │ 19.00 │ 1.00 │ 1.00 │ 0.00 │ -2.30 │ +├───────┼─────────┼────────┼────────┼────────┼────────┼────────┼────────┼────────┼────────┼────────┼──────────┤ +│ 25% │ 1.00 │ 1.00 │ 3.00 │ 2.00 │ 5.00 │ 1.00 │ 34.00 │ 3.00 │ 14.00 │ 0.00 │ 0.10 │ +├───────┼─────────┼────────┼────────┼────────┼────────┼────────┼────────┼────────┼────────┼────────┼──────────┤ +│ 50% │ 22.00 │ 3.00 │ 4.00 │ 3.00 │ 6.00 │ 2.00 │ 44.00 │ 4.00 │ 17.00 │ 0.00 │ 3.10 │ +├───────┼─────────┼────────┼────────┼────────┼────────┼────────┼────────┼────────┼────────┼────────┼──────────┤ +│ 75% │ 110.00 │ 7.00 │ 6.00 │ 4.00 │ 6.00 │ 5.00 │ 58.00 │ 6.00 │ 21.00 │ 1.00 │ 4.70 │ +├───────┼─────────┼────────┼────────┼────────┼────────┼────────┼────────┼────────┼────────┼────────┼──────────┤ +│ max │ 7300.00 │ 7.00 │ 7.00 │ 7.00 │ 7.00 │ 6.00 │ 91.00 │ 7.00 │ 24.00 │ 1.00 │ 8.90 │ +└───────┴─────────┴────────┴────────┴────────┴────────┴────────┴────────┴────────┴────────┴────────┴──────────┘ + +2022 Jun 01, 06:51 (🦋) /econometrics/ $ desc anes96.educ + +Statistics for dataset: 'anes96' +┏━━━━━━━┳━━━━━━━━┓ +┃ ┃ educ ┃ +┡━━━━━━━╇━━━━━━━━┩ +│ count │ 944.00 │ +├───────┼────────┤ +│ mean │ 4.57 │ +├───────┼────────┤ +│ std │ 1.60 │ +├───────┼────────┤ +│ min │ 1.00 │ +├───────┼────────┤ +│ 25% │ 3.00 │ +├───────┼────────┤ +│ 50% │ 4.00 │ +├───────┼────────┤ +│ 75% │ 6.00 │ +├───────┼────────┤ +│ max │ 7.00 │ +└───────┴────────┘ +``` +--- diff --git a/website/content/terminal/reference/econometrics/dwat.md b/website/content/terminal/reference/econometrics/dwat.md new file mode 100644 index 000000000000..22b02f1e91e9 --- /dev/null +++ b/website/content/terminal/reference/econometrics/dwat.md @@ -0,0 +1,89 @@ +--- +title: dwat +description: The 'dwat' documentation page provides comprehensive information about + Durbin-Watson autocorrelation test, its usage with Ordinary Least Squares (OLS) + regression, and potential issues and solutions with multi-collinearity and numerical + problems. The page features examples with a Python command, its parameters, and + regression results to provide a practical understanding of the concepts. +keywords: +- dwat +- autocorrelation tests +- Durbin-Watson +- OLS +- independent variables +- dependent variables +- regression results +- plot +- residuals +- multicollinearity +- numerical problems +- analytics +- statistics +- econometrics +- statistical analysis +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Show autocorrelation tests from Durbin-Watson. Needs OLS to be run in advance with independent and dependent variables + +### Usage + +```python +dwat [-p] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| plot | Plot the residuals | False | True | None | + + +--- + +## Examples + +```python +2022 Feb 24, 05:59 (🦋) /econometrics/ $ ols -d adj_close-msft -i adj_close-aapl -i adj_close-googl -i adj_close-tsla + OLS Regression Results +============================================================================== +Dep. Variable: adj_close_msft R-squared: 0.977 +Model: OLS Adj. R-squared: 0.977 +Method: Least Squares F-statistic: 1.068e+04 +Date: Thu, 24 Feb 2022 Prob (F-statistic): 0.00 +Time: 12:00:01 Log-Likelihood: -2830.6 +No. Observations: 759 AIC: 5669. +Df Residuals: 755 BIC: 5688. +Df Model: 3 +Covariance Type: nonrobust +=================================================================================== + coef std err t P|t| [0.025 0.975] +----------------------------------------------------------------------------------- +Intercept 27.7984 2.166 12.832 0.000 23.546 32.051 +adj_close_aapl 0.8662 0.034 25.503 0.000 0.800 0.933 +adj_close_googl 0.0508 0.002 30.374 0.000 0.048 0.054 +adj_close_tsla -0.0007 0.004 -0.181 0.856 -0.009 0.007 +============================================================================== +Omnibus: 41.445 Durbin-Watson: 0.044 +Prob(Omnibus): 0.000 Jarque-Bera (JB): 47.398 +Skew: 0.612 Prob(JB): 5.10e-11 +Kurtosis: 2.995 Cond. No. 1.16e+04 +============================================================================== + +Notes: +[1] Standard Errors assume that the covariance matrix of the errors is correctly specified. +[2] The condition number is large, 1.16e+04. This might indicate that there are +strong multicollinearity or other numerical problems. + +2022 Feb 24, 06:00 (🦋) /statistics/ $ dwat -p +The result 0.04 is outside the range 1.5 and 2.5 and therefore autocorrelation can be problematic. +Please consider lags of the dependent or independent variable. +``` +![durbin_watson example](https://user-images.githubusercontent.com/46355364/155514788-caaa65a2-1f5f-41d0-8db2-06e682d5a53e.png) + +--- diff --git a/website/content/terminal/reference/econometrics/export.md b/website/content/terminal/reference/econometrics/export.md new file mode 100644 index 000000000000..ccead5507075 --- /dev/null +++ b/website/content/terminal/reference/econometrics/export.md @@ -0,0 +1,48 @@ +--- +title: export +description: This documentation page guides you on how to use the 'export' command + in Python for exporting a dataset to Excel or CSV. It provides detailed usage, parameters, + and examples. +keywords: +- export +- dataset +- Excel +- CSV +- econometrics +- data export +- export command +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Export dataset to Excel + +### Usage + +```python +export [-n NAME] [-t {xlsx,csv}] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| name | The name of the dataset you wish to export | None | True | None | +| type | The file type you wish to export to | xlsx | True | xlsx, csv | + + +--- + +## Examples + +```python +2022 Feb 24, 04:35 (🦋) /econometrics/ $ load ThesisData.xlsx thesis + +2022 Feb 24, 04:36 (🦋) /econometrics/ $ export thesis -t csv +Saved file: /Users/jeroenbouma/My Drive/Programming/Python/OpenBBTerminal/exports/statistics/thesis_20220224_103614.csv +``` +--- diff --git a/website/content/terminal/reference/econometrics/granger.md b/website/content/terminal/reference/econometrics/granger.md new file mode 100644 index 000000000000..8e8358627035 --- /dev/null +++ b/website/content/terminal/reference/econometrics/granger.md @@ -0,0 +1,61 @@ +--- +title: granger +description: This is a documentation page for Granger causality command in econometrics. + The command is used for analyzing the cause between two-time series. The page also + provides usage examples and parameters detail. +keywords: +- Granger causality +- time series analysis +- Econometrics +- Command documentation +- Statistical command +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Show Granger causality between two timeseries + +### Usage + +```python +granger [-t Available time series] [-l LAGS] [-c CONFIDENCE] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| ts | Requires two time series, the first time series is assumed to be Granger-caused by the second time series. | None | True | None | +| lags | How many lags should be included | 3 | True | None | +| confidence | Set the confidence level | 0.05 | True | None | + + +--- + +## Examples + +```python +2022 Jun 01, 06:35 (🦋) /econometrics/ $ load strikes + +2022 Jun 01, 06:36 (🦋) /econometrics/ $ granger strikes.duration,strikes.iprod + +Granger Causality Test [Y: strikes.duration | X: strikes.iprod | Lags: 3] +┏━━━━━━━━━━━━━━┳━━━━━━━━┳━━━━━━━━━┳━━━━━━━┳━━━━━━┓ +┃ ┃ F-test ┃ P-value ┃ Count ┃ Lags ┃ +┡━━━━━━━━━━━━━━╇━━━━━━━━╇━━━━━━━━━╇━━━━━━━╇━━━━━━┩ +│ ssr_ftest │ 0.81 │ 0.49 │ 52.00 │ 3.00 │ +├──────────────┼────────┼─────────┼───────┼──────┤ +│ ssr_chi2test │ 2.75 │ 0.43 │ - │ 3 │ +├──────────────┼────────┼─────────┼───────┼──────┤ +│ lrtest │ 2.69 │ 0.44 │ - │ 3 │ +├──────────────┼────────┼─────────┼───────┼──────┤ +│ params_ftest │ 0.81 │ 0.49 │ 52.00 │ 3.00 │ +└──────────────┴────────┴─────────┴───────┴──────┘ + +As the p-value of the F-test is 0.495, we can not reject the null hypothesis at the 0.05 confidence level. +``` +--- diff --git a/website/content/terminal/reference/econometrics/index_cmd.md b/website/content/terminal/reference/econometrics/index_cmd.md new file mode 100644 index 000000000000..6f6afdc06109 --- /dev/null +++ b/website/content/terminal/reference/econometrics/index_cmd.md @@ -0,0 +1,106 @@ +--- +title: index +description: This page of the documentation describes how to set a (multi)index for + a dataset. It includes parameters for selecting the dataset, the default index, + data adjustments for regressions, and dropping the column that the index is set + for. Examples using Python are provided. +keywords: +- indexing +- dataset +- default index +- dataset adjustment +- timeseries regression +- panel data regression +- drop column +- data management +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Set a (multi) index for the dataset + +### Usage + +```python +index -n {} [-i INDEX] [-a] [-d] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| name | Name of dataset to select index from | None | False | None | +| index | Columns from the dataset the user wishes to set as default | | True | None | +| adjustment | Whether to allow for making adjustments to the dataset to align it with the use case for Timeseries and Panel Data regressions | False | True | None | +| drop | Whether to drop the column(s) the index is set for. | False | True | None | + + +--- + +## Examples + +```python +2022 Jun 01, 06:39 (🦋) /econometrics/ $ load wage_panel -a wp + +2022 Jun 01, 06:39 (🦋) /econometrics/ $ show wp + + Dataset wp | Showing 10 of 4360 rows +┏━━━┳━━━━━━━┳━━━━━━━━━┳━━━━━━━┳━━━━━━━┳━━━━━━┳━━━━━━━━━┳━━━━━━━━━┳━━━━━━━┳━━━━━━━┳━━━━━━━┳━━━━━━━━━┳━━━━━━━━━━━━┓ +┃ ┃ nr ┃ year ┃ black ┃ exper ┃ hisp ┃ hours ┃ married ┃ educ ┃ union ┃ lwage ┃ expersq ┃ occupation ┃ +┡━━━╇━━━━━━━╇━━━━━━━━━╇━━━━━━━╇━━━━━━━╇━━━━━━╇━━━━━━━━━╇━━━━━━━━━╇━━━━━━━╇━━━━━━━╇━━━━━━━╇━━━━━━━━━╇━━━━━━━━━━━━┩ +│ 0 │ 13.00 │ 1980.00 │ 0.00 │ 1.00 │ 0.00 │ 2672.00 │ 0.00 │ 14.00 │ 0.00 │ 1.20 │ 1.00 │ 9.00 │ +├───┼───────┼─────────┼───────┼───────┼──────┼─────────┼─────────┼───────┼───────┼───────┼─────────┼────────────┤ +│ 1 │ 13.00 │ 1981.00 │ 0.00 │ 2.00 │ 0.00 │ 2320.00 │ 0.00 │ 14.00 │ 1.00 │ 1.85 │ 4.00 │ 9.00 │ +├───┼───────┼─────────┼───────┼───────┼──────┼─────────┼─────────┼───────┼───────┼───────┼─────────┼────────────┤ +│ 2 │ 13.00 │ 1982.00 │ 0.00 │ 3.00 │ 0.00 │ 2940.00 │ 0.00 │ 14.00 │ 0.00 │ 1.34 │ 9.00 │ 9.00 │ +├───┼───────┼─────────┼───────┼───────┼──────┼─────────┼─────────┼───────┼───────┼───────┼─────────┼────────────┤ +│ 3 │ 13.00 │ 1983.00 │ 0.00 │ 4.00 │ 0.00 │ 2960.00 │ 0.00 │ 14.00 │ 0.00 │ 1.43 │ 16.00 │ 9.00 │ +├───┼───────┼─────────┼───────┼───────┼──────┼─────────┼─────────┼───────┼───────┼───────┼─────────┼────────────┤ +│ 4 │ 13.00 │ 1984.00 │ 0.00 │ 5.00 │ 0.00 │ 3071.00 │ 0.00 │ 14.00 │ 0.00 │ 1.57 │ 25.00 │ 5.00 │ +├───┼───────┼─────────┼───────┼───────┼──────┼─────────┼─────────┼───────┼───────┼───────┼─────────┼────────────┤ +│ 5 │ 13.00 │ 1985.00 │ 0.00 │ 6.00 │ 0.00 │ 2864.00 │ 0.00 │ 14.00 │ 0.00 │ 1.70 │ 36.00 │ 2.00 │ +├───┼───────┼─────────┼───────┼───────┼──────┼─────────┼─────────┼───────┼───────┼───────┼─────────┼────────────┤ +│ 6 │ 13.00 │ 1986.00 │ 0.00 │ 7.00 │ 0.00 │ 2994.00 │ 0.00 │ 14.00 │ 0.00 │ -0.72 │ 49.00 │ 2.00 │ +├───┼───────┼─────────┼───────┼───────┼──────┼─────────┼─────────┼───────┼───────┼───────┼─────────┼────────────┤ +│ 7 │ 13.00 │ 1987.00 │ 0.00 │ 8.00 │ 0.00 │ 2640.00 │ 0.00 │ 14.00 │ 0.00 │ 1.67 │ 64.00 │ 2.00 │ +├───┼───────┼─────────┼───────┼───────┼──────┼─────────┼─────────┼───────┼───────┼───────┼─────────┼────────────┤ +│ 8 │ 17.00 │ 1980.00 │ 0.00 │ 4.00 │ 0.00 │ 2484.00 │ 0.00 │ 13.00 │ 0.00 │ 1.68 │ 16.00 │ 2.00 │ +├───┼───────┼─────────┼───────┼───────┼──────┼─────────┼─────────┼───────┼───────┼───────┼─────────┼────────────┤ +│ 9 │ 17.00 │ 1981.00 │ 0.00 │ 5.00 │ 0.00 │ 2804.00 │ 0.00 │ 13.00 │ 0.00 │ 1.52 │ 25.00 │ 2.00 │ +└───┴───────┴─────────┴───────┴───────┴──────┴─────────┴─────────┴───────┴───────┴───────┴─────────┴────────────┘ + +2022 Jun 01, 06:39 (🦋) /econometrics/ $ index wp -i nr,year +Successfully updated 'wp' index to be 'nr, year' + +2022 Jun 01, 06:39 (🦋) /econometrics/ $ show wp + + Dataset wp | Showing 10 of 4360 rows +┏━━━━━━━━━━━━┳━━━━━━━┳━━━━━━━━━┳━━━━━━━┳━━━━━━━┳━━━━━━┳━━━━━━━━━┳━━━━━━━━━┳━━━━━━━┳━━━━━━━┳━━━━━━━┳━━━━━━━━━┳━━━━━━━━━━━━┓ +┃ ┃ nr ┃ year ┃ black ┃ exper ┃ hisp ┃ hours ┃ married ┃ educ ┃ union ┃ lwage ┃ expersq ┃ occupation ┃ +┡━━━━━━━━━━━━╇━━━━━━━╇━━━━━━━━━╇━━━━━━━╇━━━━━━━╇━━━━━━╇━━━━━━━━━╇━━━━━━━━━╇━━━━━━━╇━━━━━━━╇━━━━━━━╇━━━━━━━━━╇━━━━━━━━━━━━┩ +│ (13, 1980) │ 13.00 │ 1980.00 │ 0.00 │ 1.00 │ 0.00 │ 2672.00 │ 0.00 │ 14.00 │ 0.00 │ 1.20 │ 1.00 │ 9.00 │ +├────────────┼───────┼─────────┼───────┼───────┼──────┼─────────┼─────────┼───────┼───────┼───────┼─────────┼────────────┤ +│ (13, 1981) │ 13.00 │ 1981.00 │ 0.00 │ 2.00 │ 0.00 │ 2320.00 │ 0.00 │ 14.00 │ 1.00 │ 1.85 │ 4.00 │ 9.00 │ +├────────────┼───────┼─────────┼───────┼───────┼──────┼─────────┼─────────┼───────┼───────┼───────┼─────────┼────────────┤ +│ (13, 1982) │ 13.00 │ 1982.00 │ 0.00 │ 3.00 │ 0.00 │ 2940.00 │ 0.00 │ 14.00 │ 0.00 │ 1.34 │ 9.00 │ 9.00 │ +├────────────┼───────┼─────────┼───────┼───────┼──────┼─────────┼─────────┼───────┼───────┼───────┼─────────┼────────────┤ +│ (13, 1983) │ 13.00 │ 1983.00 │ 0.00 │ 4.00 │ 0.00 │ 2960.00 │ 0.00 │ 14.00 │ 0.00 │ 1.43 │ 16.00 │ 9.00 │ +├────────────┼───────┼─────────┼───────┼───────┼──────┼─────────┼─────────┼───────┼───────┼───────┼─────────┼────────────┤ +│ (13, 1984) │ 13.00 │ 1984.00 │ 0.00 │ 5.00 │ 0.00 │ 3071.00 │ 0.00 │ 14.00 │ 0.00 │ 1.57 │ 25.00 │ 5.00 │ +├────────────┼───────┼─────────┼───────┼───────┼──────┼─────────┼─────────┼───────┼───────┼───────┼─────────┼────────────┤ +│ (13, 1985) │ 13.00 │ 1985.00 │ 0.00 │ 6.00 │ 0.00 │ 2864.00 │ 0.00 │ 14.00 │ 0.00 │ 1.70 │ 36.00 │ 2.00 │ +├────────────┼───────┼─────────┼───────┼───────┼──────┼─────────┼─────────┼───────┼───────┼───────┼─────────┼────────────┤ +│ (13, 1986) │ 13.00 │ 1986.00 │ 0.00 │ 7.00 │ 0.00 │ 2994.00 │ 0.00 │ 14.00 │ 0.00 │ -0.72 │ 49.00 │ 2.00 │ +├────────────┼───────┼─────────┼───────┼───────┼──────┼─────────┼─────────┼───────┼───────┼───────┼─────────┼────────────┤ +│ (13, 1987) │ 13.00 │ 1987.00 │ 0.00 │ 8.00 │ 0.00 │ 2640.00 │ 0.00 │ 14.00 │ 0.00 │ 1.67 │ 64.00 │ 2.00 │ +├────────────┼───────┼─────────┼───────┼───────┼──────┼─────────┼─────────┼───────┼───────┼───────┼─────────┼────────────┤ +│ (17, 1980) │ 17.00 │ 1980.00 │ 0.00 │ 4.00 │ 0.00 │ 2484.00 │ 0.00 │ 13.00 │ 0.00 │ 1.68 │ 16.00 │ 2.00 │ +├────────────┼───────┼─────────┼───────┼───────┼──────┼─────────┼─────────┼───────┼───────┼───────┼─────────┼────────────┤ +│ (17, 1981) │ 17.00 │ 1981.00 │ 0.00 │ 5.00 │ 0.00 │ 2804.00 │ 0.00 │ 13.00 │ 0.00 │ 1.52 │ 25.00 │ 2.00 │ +└────────────┴───────┴─────────┴───────┴───────┴──────┴─────────┴─────────┴───────┴───────┴───────┴─────────┴────────────┘ +``` +--- diff --git a/website/content/terminal/reference/econometrics/load.md b/website/content/terminal/reference/econometrics/load.md new file mode 100644 index 000000000000..2ed5c9e957a5 --- /dev/null +++ b/website/content/terminal/reference/econometrics/load.md @@ -0,0 +1,73 @@ +--- +title: load +description: This documentation page covers the function 'load', which is utilized + to load datasets from various sources. It provides in-depth details of its usage, + parameters and examples to guide users. +keywords: +- Load Function +- Dataset +- StatsModels +- Data Loading +- Documentation +- Function Parameters +- Econometrics +- Examples +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Load dataset (from previous export, custom imports or StatsModels). + +### Usage + +```python +load [-f FILE] [-a ALIAS] [-e] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| file | File to load data in (can be custom import, may have been exported before or can be from Statsmodels) | None | True | None | +| alias | Alias name to give to the dataset | None | True | None | +| examples | Use this argument to show examples of Statsmodels to load in. See: https://www.statsmodels.org/devel/datasets/index.html | False | True | None | + + +--- + +## Examples + +```python +2022 Feb 28, 04:19 (🦋) /econometrics/ $ load MSFT_20220221_140503.xlsx -a msft + +2022 Feb 28, 04:20 (🦋) /econometrics/ $ show msft + msft +┏━━━┳━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━┳━━━━━━━━┳━━━━━━━━┳━━━━━━━━┳━━━━━━━━━━━┳━━━━━━━━━━┓ +┃ ┃ date ┃ open ┃ high ┃ low ┃ close ┃ adj_close ┃ volume ┃ +┡━━━╇━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━╇━━━━━━━━╇━━━━━━━━╇━━━━━━━━╇━━━━━━━━━━━╇━━━━━━━━━━┩ +│ 0 │ 2019-02-19 00:00:00 │ 107.79 │ 108.66 │ 107.78 │ 108.17 │ 104.38 │ 18038500 │ +├───┼─────────────────────┼────────┼────────┼────────┼────────┼───────────┼──────────┤ +│ 1 │ 2019-02-20 00:00:00 │ 107.86 │ 107.94 │ 106.29 │ 107.15 │ 103.84 │ 21607700 │ +├───┼─────────────────────┼────────┼────────┼────────┼────────┼───────────┼──────────┤ +│ 2 │ 2019-02-21 00:00:00 │ 106.90 │ 109.48 │ 106.87 │ 109.41 │ 106.03 │ 29063200 │ +├───┼─────────────────────┼────────┼────────┼────────┼────────┼───────────┼──────────┤ +│ 3 │ 2019-02-22 00:00:00 │ 110.05 │ 111.20 │ 109.82 │ 110.97 │ 107.54 │ 27763200 │ +├───┼─────────────────────┼────────┼────────┼────────┼────────┼───────────┼──────────┤ +│ 4 │ 2019-02-25 00:00:00 │ 111.76 │ 112.18 │ 111.26 │ 111.59 │ 108.14 │ 23750600 │ +├───┼─────────────────────┼────────┼────────┼────────┼────────┼───────────┼──────────┤ +│ 5 │ 2019-02-26 00:00:00 │ 111.26 │ 113.24 │ 111.17 │ 112.36 │ 108.89 │ 21536700 │ +├───┼─────────────────────┼────────┼────────┼────────┼────────┼───────────┼──────────┤ +│ 6 │ 2019-02-27 00:00:00 │ 111.69 │ 112.36 │ 110.88 │ 112.17 │ 108.71 │ 21487100 │ +├───┼─────────────────────┼────────┼────────┼────────┼────────┼───────────┼──────────┤ +│ 7 │ 2019-02-28 00:00:00 │ 112.04 │ 112.88 │ 111.73 │ 112.03 │ 108.57 │ 29083900 │ +├───┼─────────────────────┼────────┼────────┼────────┼────────┼───────────┼──────────┤ +│ 8 │ 2019-03-01 00:00:00 │ 112.89 │ 113.02 │ 111.67 │ 112.53 │ 109.06 │ 23501200 │ +├───┼─────────────────────┼────────┼────────┼────────┼────────┼───────────┼──────────┤ +│ 9 │ 2019-03-04 00:00:00 │ 113.02 │ 113.25 │ 110.80 │ 112.26 │ 108.79 │ 26608000 │ +└───┴─────────────────────┴────────┴────────┴────────┴────────┴───────────┴──────────┘ +``` +--- diff --git a/website/content/terminal/reference/econometrics/norm.md b/website/content/terminal/reference/econometrics/norm.md new file mode 100644 index 000000000000..f122cba30e39 --- /dev/null +++ b/website/content/terminal/reference/econometrics/norm.md @@ -0,0 +1,40 @@ +--- +title: norm +description: This page provides guidelines on using the 'norm' function to test whether + particular data is normally distributed. It covers functionality and parameter description, + and also includes histogram examples for a clear understanding. +keywords: +- data normalization +- data distribution +- histogram +- plot +- dataset +- data testing +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Test whether the used data is normally distributed. + +### Usage + +```python +norm -v {} [-p] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| column | The dataset.column you want to test normality for | None | False | None | +| plot | Whether you wish to plot a histogram to visually depict normality | False | True | None | + +![histogram_adj_close_tsla](https://user-images.githubusercontent.com/46355364/155514663-90cb210a-002a-49fe-b7d3-29d9f2aeb5ac.png) + +![histogram_returns_msft](https://user-images.githubusercontent.com/46355364/155514702-f46da473-b340-4d68-b31e-f96606c4ed00.png) + +--- diff --git a/website/content/terminal/reference/econometrics/ols.md b/website/content/terminal/reference/econometrics/ols.md new file mode 100644 index 000000000000..311cd712f8ba --- /dev/null +++ b/website/content/terminal/reference/econometrics/ols.md @@ -0,0 +1,38 @@ +--- +title: ols +description: This page explains how to perform an OLS regression on timeseries data + using specific commands and parameters. It's useful for those working in data analytics + or statistical modeling. +keywords: +- OLS regression +- timeseries data +- data analytics +- statistical modeling +- dependent variable +- independent variable +- no_output parameter +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Performs an OLS regression on timeseries data. + +### Usage + +```python +ols -d DEPENDENT -i INDEPENDENT [--no-output] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| dependent | The dependent variable on the regression you would like to perform | None | False | None | +| independent | The independent variables on the regression you would like to perform. E.g. historical.high,historical.low | None | False | None | +| no_output | Hide the output of the regression | False | True | None | + +--- diff --git a/website/content/terminal/reference/econometrics/panel.md b/website/content/terminal/reference/econometrics/panel.md new file mode 100644 index 000000000000..699f4efad1a6 --- /dev/null +++ b/website/content/terminal/reference/econometrics/panel.md @@ -0,0 +1,44 @@ +--- +title: panel +description: The documentation page provides a comprehensive guide to performing regression + analysis on Panel Data using the 'panel' command in Python. It includes information + about the usage, command parameters and the type of regression analysis you can + perform. +keywords: +- panel data regression +- data analysis +- regression analysis +- Pooled OLS +- Random Effects +- Between OLS +- Fixed Effects +- First Difference OLS +- entity effects +- time effects +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Performs regression analysis on Panel Data. There are a multitude of options to select from to fit the needs of restrictions of the dataset. + +### Usage + +```python +panel -d DEPENDENT -i INDEPENDENT [-r {pols,re,bols,fe,fdols,POLS,RE,BOLS,FE,FDOLS}] [-e] [-t] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| dependent | The dependent variable on the regression you would like to perform | None | False | None | +| independent | The independent variables on the regression you would like to perform. E.g. wage_panel.married,wage_panel.union | None | False | None | +| type | The type of regression you wish to perform. This can be either pols (Pooled OLS), re (Random Effects), bols (Between OLS), fe (Fixed Effects) or fdols (First Difference OLS) | pols | True | pols, re, bols, fe, fdols, POLS, RE, BOLS, FE, FDOLS | +| entity_effects | Using this command creates entity effects, which is equivalent to including dummies for each entity. This is only used within Fixed Effects estimations (when type is set to 'fe') | False | True | None | +| time_effects | Using this command creates time effects, which is equivalent to including dummies for each time. This is only used within Fixed Effects estimations (when type is set to 'fe') | False | True | None | + +--- diff --git a/website/content/terminal/reference/econometrics/plot.md b/website/content/terminal/reference/econometrics/plot.md new file mode 100644 index 000000000000..2ebebbe96553 --- /dev/null +++ b/website/content/terminal/reference/econometrics/plot.md @@ -0,0 +1,78 @@ +--- +title: plot +description: This page provides documentation for the 'plot' command used in Python + scripting. The command is intended for plotting data based on a specified column + from a dataset with usage examples and parameter explanations. +keywords: +- Python scripting +- data plotting +- command usage +- dataset +- econometrics +- tutorial +- SEO optimization +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Plot data based on the index + +### Usage + +```python +plot [-v VALUES] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| values | Dataset.column values to be displayed in a plot | None | True | None | + + +--- + +## Examples + +```python +2022 Jun 01, 06:45 (🦋) /econometrics/ $ load macrodata -a us_macro + +2022 Jun 01, 06:45 (🦋) /econometrics/ $ index us_macro -i year -d +Successfully updated 'us_macro' index to be 'year' + +2022 Jun 01, 06:46 (🦋) /econometrics/ $ show us_macro + + Dataset us_macro | Showing 10 of 203 rows +┏━━━━━━━━┳━━━━━━━━━┳━━━━━━━━━┳━━━━━━━━━━┳━━━━━━━━━┳━━━━━━━━━━┳━━━━━━━━━┳━━━━━━━┳━━━━━━━━┳━━━━━━━━━━┳━━━━━━━┳━━━━━━━━┳━━━━━━━┳━━━━━━━━━┓ +┃ ┃ quarter ┃ realgdp ┃ realcons ┃ realinv ┃ realgovt ┃ realdpi ┃ cpi ┃ m1 ┃ tbilrate ┃ unemp ┃ pop ┃ infl ┃ realint ┃ +┡━━━━━━━━╇━━━━━━━━━╇━━━━━━━━━╇━━━━━━━━━━╇━━━━━━━━━╇━━━━━━━━━━╇━━━━━━━━━╇━━━━━━━╇━━━━━━━━╇━━━━━━━━━━╇━━━━━━━╇━━━━━━━━╇━━━━━━━╇━━━━━━━━━┩ +│ 1959.0 │ 1.00 │ 2710.35 │ 1707.40 │ 286.90 │ 470.05 │ 1886.90 │ 28.98 │ 139.70 │ 2.82 │ 5.80 │ 177.15 │ 0.00 │ 0.00 │ +├────────┼─────────┼─────────┼──────────┼─────────┼──────────┼─────────┼───────┼────────┼──────────┼───────┼────────┼───────┼─────────┤ +│ 1959.0 │ 2.00 │ 2778.80 │ 1733.70 │ 310.86 │ 481.30 │ 1919.70 │ 29.15 │ 141.70 │ 3.08 │ 5.10 │ 177.83 │ 2.34 │ 0.74 │ +├────────┼─────────┼─────────┼──────────┼─────────┼──────────┼─────────┼───────┼────────┼──────────┼───────┼────────┼───────┼─────────┤ +│ 1959.0 │ 3.00 │ 2775.49 │ 1751.80 │ 289.23 │ 491.26 │ 1916.40 │ 29.35 │ 140.50 │ 3.82 │ 5.30 │ 178.66 │ 2.74 │ 1.09 │ +├────────┼─────────┼─────────┼──────────┼─────────┼──────────┼─────────┼───────┼────────┼──────────┼───────┼────────┼───────┼─────────┤ +│ 1959.0 │ 4.00 │ 2785.20 │ 1753.70 │ 299.36 │ 484.05 │ 1931.30 │ 29.37 │ 140.00 │ 4.33 │ 5.60 │ 179.39 │ 0.27 │ 4.06 │ +├────────┼─────────┼─────────┼──────────┼─────────┼──────────┼─────────┼───────┼────────┼──────────┼───────┼────────┼───────┼─────────┤ +│ 1960.0 │ 1.00 │ 2847.70 │ 1770.50 │ 331.72 │ 462.20 │ 1955.50 │ 29.54 │ 139.60 │ 3.50 │ 5.20 │ 180.01 │ 2.31 │ 1.19 │ +├────────┼─────────┼─────────┼──────────┼─────────┼──────────┼─────────┼───────┼────────┼──────────┼───────┼────────┼───────┼─────────┤ +│ 1960.0 │ 2.00 │ 2834.39 │ 1792.90 │ 298.15 │ 460.40 │ 1966.10 │ 29.55 │ 140.20 │ 2.68 │ 5.20 │ 180.67 │ 0.14 │ 2.55 │ +├────────┼─────────┼─────────┼──────────┼─────────┼──────────┼─────────┼───────┼────────┼──────────┼───────┼────────┼───────┼─────────┤ +│ 1960.0 │ 3.00 │ 2839.02 │ 1785.80 │ 296.38 │ 474.68 │ 1967.80 │ 29.75 │ 140.90 │ 2.36 │ 5.60 │ 181.53 │ 2.70 │ -0.34 │ +├────────┼─────────┼─────────┼──────────┼─────────┼──────────┼─────────┼───────┼────────┼──────────┼───────┼────────┼───────┼─────────┤ +│ 1960.0 │ 4.00 │ 2802.62 │ 1788.20 │ 259.76 │ 476.43 │ 1966.60 │ 29.84 │ 141.10 │ 2.29 │ 6.30 │ 182.29 │ 1.21 │ 1.08 │ +├────────┼─────────┼─────────┼──────────┼─────────┼──────────┼─────────┼───────┼────────┼──────────┼───────┼────────┼───────┼─────────┤ +│ 1961.0 │ 1.00 │ 2819.26 │ 1787.70 │ 266.40 │ 475.85 │ 1984.50 │ 29.81 │ 142.10 │ 2.37 │ 6.80 │ 182.99 │ -0.40 │ 2.77 │ +├────────┼─────────┼─────────┼──────────┼─────────┼──────────┼─────────┼───────┼────────┼──────────┼───────┼────────┼───────┼─────────┤ +│ 1961.0 │ 2.00 │ 2872.01 │ 1814.30 │ 286.25 │ 480.33 │ 2014.40 │ 29.92 │ 142.90 │ 2.29 │ 7.00 │ 183.69 │ 1.47 │ 0.81 │ +└────────┴─────────┴─────────┴──────────┴─────────┴──────────┴─────────┴───────┴────────┴──────────┴───────┴────────┴───────┴─────────┘ + +2022 Jun 01, 06:44 (🦋) /econometrics/ $ plot us_macro.unemp +``` +![unemp_data_us](https://user-images.githubusercontent.com/46355364/156058283-3888c6a8-a9a7-41c6-a091-b94b7946679b.png) + +--- diff --git a/website/content/terminal/reference/econometrics/remove.md b/website/content/terminal/reference/econometrics/remove.md new file mode 100644 index 000000000000..68e6e054b4bf --- /dev/null +++ b/website/content/terminal/reference/econometrics/remove.md @@ -0,0 +1,41 @@ +--- +title: remove +description: Learn how to remove a dataset from a loaded list efficiently using our + step-by-step guide, which includes usage, parameters setup, and examples. +keywords: +- remove dataset +- dataset management +- data management commands +- data cleaning +- database management +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Remove a dataset from the loaded dataset list + +### Usage + +```python +remove [-n {}] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| name | The name of the dataset you want to remove | None | True | None | + + +--- + +## Examples + +```python +2022 Feb 24, 04:37 (🦋) /econometrics/ $ remove thesis +``` +--- diff --git a/website/content/terminal/reference/econometrics/rename.md b/website/content/terminal/reference/econometrics/rename.md new file mode 100644 index 000000000000..cebd927b4ce3 --- /dev/null +++ b/website/content/terminal/reference/econometrics/rename.md @@ -0,0 +1,76 @@ +--- +title: rename +description: The 'rename' page in our documentation explains how to change the name + of columns in a dataset using a specific command. This includes detailed parameter + explanations and usage examples. +keywords: +- rename +- dataset +- parameters +- examples +- column renaming +- usage +- data manipulation +- python commands +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +The column you want to rename from a dataset. + +### Usage + +```python +rename [-d {}] -o OLDCOL -n NEWCOL +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| dataset | Dataset that will get a column renamed | None | True | None | +| oldcol | Old column from dataset to be renamed | None | False | None | +| newcol | New column from dataset to be renamed | None | False | None | + + +--- + +## Examples + +```python +2022 May 31, 04:57 (🦋) /econometrics/ $ load wage_panel -a wp + +2022 May 31, 04:58 (🦋) /econometrics/ $ rename wp -o year -n date + +2022 May 31, 04:58 (🦋) /econometrics/ $ show wp + + Dataset wp | Showing 10 of 4360 rows +┏━━━┳━━━━━━━┳━━━━━━━━━┳━━━━━━━┳━━━━━━━┳━━━━━━┳━━━━━━━━━┳━━━━━━━━━┳━━━━━━━┳━━━━━━━┳━━━━━━━┳━━━━━━━━━┳━━━━━━━━━━━━┓ +┃ ┃ nr ┃ date ┃ black ┃ exper ┃ hisp ┃ hours ┃ married ┃ educ ┃ union ┃ lwage ┃ expersq ┃ occupation ┃ +┡━━━╇━━━━━━━╇━━━━━━━━━╇━━━━━━━╇━━━━━━━╇━━━━━━╇━━━━━━━━━╇━━━━━━━━━╇━━━━━━━╇━━━━━━━╇━━━━━━━╇━━━━━━━━━╇━━━━━━━━━━━━┩ +│ 0 │ 13.00 │ 1980.00 │ 0.00 │ 1.00 │ 0.00 │ 2672.00 │ 0.00 │ 14.00 │ 0.00 │ 1.20 │ 1.00 │ 9.00 │ +├───┼───────┼─────────┼───────┼───────┼──────┼─────────┼─────────┼───────┼───────┼───────┼─────────┼────────────┤ +│ 1 │ 13.00 │ 1981.00 │ 0.00 │ 2.00 │ 0.00 │ 2320.00 │ 0.00 │ 14.00 │ 1.00 │ 1.85 │ 4.00 │ 9.00 │ +├───┼───────┼─────────┼───────┼───────┼──────┼─────────┼─────────┼───────┼───────┼───────┼─────────┼────────────┤ +│ 2 │ 13.00 │ 1982.00 │ 0.00 │ 3.00 │ 0.00 │ 2940.00 │ 0.00 │ 14.00 │ 0.00 │ 1.34 │ 9.00 │ 9.00 │ +├───┼───────┼─────────┼───────┼───────┼──────┼─────────┼─────────┼───────┼───────┼───────┼─────────┼────────────┤ +│ 3 │ 13.00 │ 1983.00 │ 0.00 │ 4.00 │ 0.00 │ 2960.00 │ 0.00 │ 14.00 │ 0.00 │ 1.43 │ 16.00 │ 9.00 │ +├───┼───────┼─────────┼───────┼───────┼──────┼─────────┼─────────┼───────┼───────┼───────┼─────────┼────────────┤ +│ 4 │ 13.00 │ 1984.00 │ 0.00 │ 5.00 │ 0.00 │ 3071.00 │ 0.00 │ 14.00 │ 0.00 │ 1.57 │ 25.00 │ 5.00 │ +├───┼───────┼─────────┼───────┼───────┼──────┼─────────┼─────────┼───────┼───────┼───────┼─────────┼────────────┤ +│ 5 │ 13.00 │ 1985.00 │ 0.00 │ 6.00 │ 0.00 │ 2864.00 │ 0.00 │ 14.00 │ 0.00 │ 1.70 │ 36.00 │ 2.00 │ +├───┼───────┼─────────┼───────┼───────┼──────┼─────────┼─────────┼───────┼───────┼───────┼─────────┼────────────┤ +│ 6 │ 13.00 │ 1986.00 │ 0.00 │ 7.00 │ 0.00 │ 2994.00 │ 0.00 │ 14.00 │ 0.00 │ -0.72 │ 49.00 │ 2.00 │ +├───┼───────┼─────────┼───────┼───────┼──────┼─────────┼─────────┼───────┼───────┼───────┼─────────┼────────────┤ +│ 7 │ 13.00 │ 1987.00 │ 0.00 │ 8.00 │ 0.00 │ 2640.00 │ 0.00 │ 14.00 │ 0.00 │ 1.67 │ 64.00 │ 2.00 │ +├───┼───────┼─────────┼───────┼───────┼──────┼─────────┼─────────┼───────┼───────┼───────┼─────────┼────────────┤ +│ 8 │ 17.00 │ 1980.00 │ 0.00 │ 4.00 │ 0.00 │ 2484.00 │ 0.00 │ 13.00 │ 0.00 │ 1.68 │ 16.00 │ 2.00 │ +├───┼───────┼─────────┼───────┼───────┼──────┼─────────┼─────────┼───────┼───────┼───────┼─────────┼────────────┤ +│ 9 │ 17.00 │ 1981.00 │ 0.00 │ 5.00 │ 0.00 │ 2804.00 │ 0.00 │ 13.00 │ 0.00 │ 1.52 │ 25.00 │ 2.00 │ +└───┴───────┴─────────┴───────┴───────┴──────┴─────────┴─────────┴───────┴───────┴───────┴─────────┴────────────┘ +``` +--- diff --git a/website/content/terminal/reference/econometrics/root.md b/website/content/terminal/reference/econometrics/root.md new file mode 100644 index 000000000000..5e72001bb13d --- /dev/null +++ b/website/content/terminal/reference/econometrics/root.md @@ -0,0 +1,62 @@ +--- +title: root +description: This page provides detailed info on running unit root tests on a column + of a dataset using various types of regression. The page includes usage, parameters, + and examples. +keywords: +- unit root tests +- dataset +- econometrics +- ADF +- KPSS +- regression +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Show unit root tests of a column of a dataset + +### Usage + +```python +root -v {} [-r {c,ct,ctt,n}] [-k {c,ct}] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| column | The column and name of the database you want test unit root for | None | False | None | +| fuller_reg | Type of regression. Can be 'c','ct','ctt','nc'. c - Constant and t - trend order | c | True | c, ct, ctt, n | +| kpss_reg | Type of regression. Can be 'c', 'ct'. c - Constant and t - trend order | c | True | c, ct | + + +--- + +## Examples + +```python +2022 Jun 01, 06:47 (🦋) /econometrics/ $ load fair + +2022 Jun 01, 06:47 (🦋) /econometrics/ $ root fair.yrs_married + +Unitroot from dataset 'fair of 'yrs_married' +┏━━━━━━━━━━━━━━━━┳━━━━━━━━━━┳━━━━━━━┓ +┃ ┃ ADF ┃ KPSS ┃ +┡━━━━━━━━━━━━━━━━╇━━━━━━━━━━╇━━━━━━━┩ +│ Test Statistic │ -8.08 │ 7.01 │ +├────────────────┼──────────┼───────┤ +│ P-Value │ 0.00 │ 0.01 │ +├────────────────┼──────────┼───────┤ +│ NLags │ 34.00 │ 26.00 │ +├────────────────┼──────────┼───────┤ +│ Nobs │ 6331.00 │ 0.00 │ +├────────────────┼──────────┼───────┤ +│ ICBest │ 42958.72 │ 0.00 │ +└────────────────┴──────────┴───────┘ +``` +--- diff --git a/website/content/terminal/reference/econometrics/show.md b/website/content/terminal/reference/econometrics/show.md new file mode 100644 index 000000000000..aa12be21ab9f --- /dev/null +++ b/website/content/terminal/reference/econometrics/show.md @@ -0,0 +1,128 @@ +--- +title: show +description: This documentation page provides a detailed overview of the 'show' function + in Python, used for data representation and manipulation in DataFrames. It presents + the usage, parameters, and examples demonstrating how the function can be employed + for different econometrics datasets by sorting and displaying datasets in an organized + manner. +keywords: +- Database +- Data sorting +- Data visualization +- Show function +- Econometrics +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Show a portion of the DataFrame + +### Usage + +```python +show [-n {}] [-s SORTBY] [-r] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| name | The name of the database you want to show data for | None | True | None | +| sortby | Sort based on a column in the DataFrame | | True | None | +| reverse | Data is sorted in descending order by default. Reverse flag will sort it in an ascending way. Only works when raw data is displayed. | False | True | None | + + +--- + +## Examples + +```python +2022 Mar 04, 05:57 (🦋) /econometrics/ $ load longley -a ll + +2022 Mar 04, 05:57 (🦋) /econometrics/ $ index ll -i year -d + +2022 Mar 04, 05:57 (🦋) /econometrics/ $ show ll -s unemp + + Dataset ll | Showing 10 of 16 rows +┏━━━━━━━━┳━━━━━━━━━━┳━━━━━━━━━┳━━━━━━━━━━━┳━━━━━━━━━┳━━━━━━━━━┳━━━━━━━━━━━┓ +┃ ┃ totemp ┃ gnpdefl ┃ gnp ┃ unemp ┃ armed ┃ pop ┃ +┡━━━━━━━━╇━━━━━━━━━━╇━━━━━━━━━╇━━━━━━━━━━━╇━━━━━━━━━╇━━━━━━━━━╇━━━━━━━━━━━┩ +│ 1961.0 │ 69331.00 │ 115.70 │ 518173.00 │ 4806.00 │ 2572.00 │ 127852.00 │ +├────────┼──────────┼─────────┼───────────┼─────────┼─────────┼───────────┤ +│ 1958.0 │ 66513.00 │ 110.80 │ 444546.00 │ 4681.00 │ 2637.00 │ 121950.00 │ +├────────┼──────────┼─────────┼───────────┼─────────┼─────────┼───────────┤ +│ 1962.0 │ 70551.00 │ 116.90 │ 554894.00 │ 4007.00 │ 2827.00 │ 130081.00 │ +├────────┼──────────┼─────────┼───────────┼─────────┼─────────┼───────────┤ +│ 1960.0 │ 69564.00 │ 114.20 │ 502601.00 │ 3931.00 │ 2514.00 │ 125368.00 │ +├────────┼──────────┼─────────┼───────────┼─────────┼─────────┼───────────┤ +│ 1959.0 │ 68655.00 │ 112.60 │ 482704.00 │ 3813.00 │ 2552.00 │ 123366.00 │ +├────────┼──────────┼─────────┼───────────┼─────────┼─────────┼───────────┤ +│ 1949.0 │ 60171.00 │ 88.20 │ 258054.00 │ 3682.00 │ 1616.00 │ 109773.00 │ +├────────┼──────────┼─────────┼───────────┼─────────┼─────────┼───────────┤ +│ 1954.0 │ 63761.00 │ 100.00 │ 363112.00 │ 3578.00 │ 3350.00 │ 116219.00 │ +├────────┼──────────┼─────────┼───────────┼─────────┼─────────┼───────────┤ +│ 1950.0 │ 61187.00 │ 89.50 │ 284599.00 │ 3351.00 │ 1650.00 │ 110929.00 │ +├────────┼──────────┼─────────┼───────────┼─────────┼─────────┼───────────┤ +│ 1957.0 │ 68169.00 │ 108.40 │ 442769.00 │ 2936.00 │ 2798.00 │ 120445.00 │ +├────────┼──────────┼─────────┼───────────┼─────────┼─────────┼───────────┤ +│ 1955.0 │ 66019.00 │ 101.20 │ 397469.00 │ 2904.00 │ 3048.00 │ 117388.00 │ +└────────┴──────────┴─────────┴───────────┴─────────┴─────────┴───────────┘ + +2022 Mar 04, 05:57 (🦋) /econometrics/ $ load wage_panel -a wp + +2022 Mar 04, 05:58 (🦋) /econometrics/ $ show + Dataset ll | Showing 10 of 16 rows +┏━━━━━━━━┳━━━━━━━━━━┳━━━━━━━━━┳━━━━━━━━━━━┳━━━━━━━━━┳━━━━━━━━━┳━━━━━━━━━━━┓ +┃ ┃ totemp ┃ gnpdefl ┃ gnp ┃ unemp ┃ armed ┃ pop ┃ +┡━━━━━━━━╇━━━━━━━━━━╇━━━━━━━━━╇━━━━━━━━━━━╇━━━━━━━━━╇━━━━━━━━━╇━━━━━━━━━━━┩ +│ 1947.0 │ 60323.00 │ 83.00 │ 234289.00 │ 2356.00 │ 1590.00 │ 107608.00 │ +├────────┼──────────┼─────────┼───────────┼─────────┼─────────┼───────────┤ +│ 1948.0 │ 61122.00 │ 88.50 │ 259426.00 │ 2325.00 │ 1456.00 │ 108632.00 │ +├────────┼──────────┼─────────┼───────────┼─────────┼─────────┼───────────┤ +│ 1949.0 │ 60171.00 │ 88.20 │ 258054.00 │ 3682.00 │ 1616.00 │ 109773.00 │ +├────────┼──────────┼─────────┼───────────┼─────────┼─────────┼───────────┤ +│ 1950.0 │ 61187.00 │ 89.50 │ 284599.00 │ 3351.00 │ 1650.00 │ 110929.00 │ +├────────┼──────────┼─────────┼───────────┼─────────┼─────────┼───────────┤ +│ 1951.0 │ 63221.00 │ 96.20 │ 328975.00 │ 2099.00 │ 3099.00 │ 112075.00 │ +├────────┼──────────┼─────────┼───────────┼─────────┼─────────┼───────────┤ +│ 1952.0 │ 63639.00 │ 98.10 │ 346999.00 │ 1932.00 │ 3594.00 │ 113270.00 │ +├────────┼──────────┼─────────┼───────────┼─────────┼─────────┼───────────┤ +│ 1953.0 │ 64989.00 │ 99.00 │ 365385.00 │ 1870.00 │ 3547.00 │ 115094.00 │ +├────────┼──────────┼─────────┼───────────┼─────────┼─────────┼───────────┤ +│ 1954.0 │ 63761.00 │ 100.00 │ 363112.00 │ 3578.00 │ 3350.00 │ 116219.00 │ +├────────┼──────────┼─────────┼───────────┼─────────┼─────────┼───────────┤ +│ 1955.0 │ 66019.00 │ 101.20 │ 397469.00 │ 2904.00 │ 3048.00 │ 117388.00 │ +├────────┼──────────┼─────────┼───────────┼─────────┼─────────┼───────────┤ +│ 1956.0 │ 67857.00 │ 104.60 │ 419180.00 │ 2822.00 │ 2857.00 │ 118734.00 │ +└────────┴──────────┴─────────┴───────────┴─────────┴─────────┴───────────┘ + + Dataset wp | Showing 10 of 4360 rows +┏━━━┳━━━━━━━┳━━━━━━━━━┳━━━━━━━┳━━━━━━━┳━━━━━━┳━━━━━━━━━┳━━━━━━━━━┳━━━━━━━┳━━━━━━━┳━━━━━━━┳━━━━━━━━━┳━━━━━━━━━━━━┓ +┃ ┃ nr ┃ year ┃ black ┃ exper ┃ hisp ┃ hours ┃ married ┃ educ ┃ union ┃ lwage ┃ expersq ┃ occupation ┃ +┡━━━╇━━━━━━━╇━━━━━━━━━╇━━━━━━━╇━━━━━━━╇━━━━━━╇━━━━━━━━━╇━━━━━━━━━╇━━━━━━━╇━━━━━━━╇━━━━━━━╇━━━━━━━━━╇━━━━━━━━━━━━┩ +│ 0 │ 13.00 │ 1980.00 │ 0.00 │ 1.00 │ 0.00 │ 2672.00 │ 0.00 │ 14.00 │ 0.00 │ 1.20 │ 1.00 │ 9.00 │ +├───┼───────┼─────────┼───────┼───────┼──────┼─────────┼─────────┼───────┼───────┼───────┼─────────┼────────────┤ +│ 1 │ 13.00 │ 1981.00 │ 0.00 │ 2.00 │ 0.00 │ 2320.00 │ 0.00 │ 14.00 │ 1.00 │ 1.85 │ 4.00 │ 9.00 │ +├───┼───────┼─────────┼───────┼───────┼──────┼─────────┼─────────┼───────┼───────┼───────┼─────────┼────────────┤ +│ 2 │ 13.00 │ 1982.00 │ 0.00 │ 3.00 │ 0.00 │ 2940.00 │ 0.00 │ 14.00 │ 0.00 │ 1.34 │ 9.00 │ 9.00 │ +├───┼───────┼─────────┼───────┼───────┼──────┼─────────┼─────────┼───────┼───────┼───────┼─────────┼────────────┤ +│ 3 │ 13.00 │ 1983.00 │ 0.00 │ 4.00 │ 0.00 │ 2960.00 │ 0.00 │ 14.00 │ 0.00 │ 1.43 │ 16.00 │ 9.00 │ +├───┼───────┼─────────┼───────┼───────┼──────┼─────────┼─────────┼───────┼───────┼───────┼─────────┼────────────┤ +│ 4 │ 13.00 │ 1984.00 │ 0.00 │ 5.00 │ 0.00 │ 3071.00 │ 0.00 │ 14.00 │ 0.00 │ 1.57 │ 25.00 │ 5.00 │ +├───┼───────┼─────────┼───────┼───────┼──────┼─────────┼─────────┼───────┼───────┼───────┼─────────┼────────────┤ +│ 5 │ 13.00 │ 1985.00 │ 0.00 │ 6.00 │ 0.00 │ 2864.00 │ 0.00 │ 14.00 │ 0.00 │ 1.70 │ 36.00 │ 2.00 │ +├───┼───────┼─────────┼───────┼───────┼──────┼─────────┼─────────┼───────┼───────┼───────┼─────────┼────────────┤ +│ 6 │ 13.00 │ 1986.00 │ 0.00 │ 7.00 │ 0.00 │ 2994.00 │ 0.00 │ 14.00 │ 0.00 │ -0.72 │ 49.00 │ 2.00 │ +├───┼───────┼─────────┼───────┼───────┼──────┼─────────┼─────────┼───────┼───────┼───────┼─────────┼────────────┤ +│ 7 │ 13.00 │ 1987.00 │ 0.00 │ 8.00 │ 0.00 │ 2640.00 │ 0.00 │ 14.00 │ 0.00 │ 1.67 │ 64.00 │ 2.00 │ +├───┼───────┼─────────┼───────┼───────┼──────┼─────────┼─────────┼───────┼───────┼───────┼─────────┼────────────┤ +│ 8 │ 17.00 │ 1980.00 │ 0.00 │ 4.00 │ 0.00 │ 2484.00 │ 0.00 │ 13.00 │ 0.00 │ 1.68 │ 16.00 │ 2.00 │ +├───┼───────┼─────────┼───────┼───────┼──────┼─────────┼─────────┼───────┼───────┼───────┼─────────┼────────────┤ +│ 9 │ 17.00 │ 1981.00 │ 0.00 │ 5.00 │ 0.00 │ 2804.00 │ 0.00 │ 13.00 │ 0.00 │ 1.52 │ 25.00 │ 2.00 │ +└───┴───────┴─────────┴───────┴───────┴──────┴─────────┴─────────┴───────┴───────┴───────┴─────────┴────────────┘ +``` +--- diff --git a/website/versioned_docs/version-v3/terminal/reference/econometrics/type.md b/website/content/terminal/reference/econometrics/type.md similarity index 82% rename from website/versioned_docs/version-v3/terminal/reference/econometrics/type.md rename to website/content/terminal/reference/econometrics/type.md index a31e0ff32e84..a5f6fa71ef98 100644 --- a/website/versioned_docs/version-v3/terminal/reference/econometrics/type.md +++ b/website/content/terminal/reference/econometrics/type.md @@ -1,9 +1,20 @@ --- title: type -description: OpenBB Terminal Function +description: Learn how to show the type of the columns of your dataset or change the + type of a specific column using Docusaurus. This guide also provides usage, parameters + and examples. +keywords: +- Docusaurus +- Dataset Column Types +- Change Column Type +- Code Examples +- Type Function Parameters +- Type Function Usage --- -# type +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + Show the type of the columns of the dataset and/or change the type of the column diff --git a/website/versioned_docs/version-v3/terminal/reference/economy/_category_.json b/website/content/terminal/reference/economy/_category_.json similarity index 100% rename from website/versioned_docs/version-v3/terminal/reference/economy/_category_.json rename to website/content/terminal/reference/economy/_category_.json diff --git a/website/content/terminal/reference/economy/bigmac.md b/website/content/terminal/reference/economy/bigmac.md new file mode 100644 index 000000000000..6aec7dc77036 --- /dev/null +++ b/website/content/terminal/reference/economy/bigmac.md @@ -0,0 +1,38 @@ +--- +title: bigmac +description: This page provides information on how to get historical Big Mac Index + data using specific commands and parameters. It also gives details about usage and + provided country codes. +keywords: +- Big Mac Index +- historical data +- Nasdaq Data Link +- country codes +- data retrieval +- commands and parameters +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Get historical Big Mac Index [Nasdaq Data Link] + +### Usage + +```python +bigmac [--codes] [-c COUNTRIES] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| codes | Flag to show all country codes | False | True | None | +| countries | Country codes to get data for. | USA | True | None | + +![bigmac](https://user-images.githubusercontent.com/46355364/158362967-8353fa50-2eb1-43b0-9cbb-bc3c3aec2e2a.png) + +--- diff --git a/website/content/terminal/reference/economy/edebt.md b/website/content/terminal/reference/economy/edebt.md new file mode 100644 index 000000000000..f38862c5e4d7 --- /dev/null +++ b/website/content/terminal/reference/economy/edebt.md @@ -0,0 +1,32 @@ +--- +title: edebt +description: The page provides the information about edebt, a tool that gives access + to national debt statistics for various countries. The data is sourced from Wikipedia. +keywords: +- edebt +- national debt statistics +- debt data +- economic data +- global debt statistics +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +National debt statistics for various countries. [Source: Wikipedia] + +### Usage + +```python +edebt +``` + +--- + +## Parameters + +This command has no parameters + + +--- diff --git a/website/content/terminal/reference/economy/eval.md b/website/content/terminal/reference/economy/eval.md new file mode 100644 index 000000000000..277ce16299b2 --- /dev/null +++ b/website/content/terminal/reference/economy/eval.md @@ -0,0 +1,38 @@ +--- +title: eval +description: This page provides information about the 'eval' function for creating + custom data columns using mathematical expressions supported by pandas.eval(). It + exemplifies case sensitivity and the use of queries on loaded datasets. +keywords: +- eval function +- custom data column +- pandas.eval +- mathematical expressions +- datasets +- case sensitive +- query +- DGS2 +- DGS5 +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Create custom data column from loaded datasets. Can be mathematical expressions supported by pandas.eval() function. Example. If I have loaded `fred DGS2,DGS5` and I want to create a new column that is the difference between these two, I can create a new column by doing `eval spread = DGS2 - DGS5`. Notice that the command is case sensitive, i.e., `DGS2` is not the same as `dgs2`. + +### Usage + +```python +eval [-q QUERY [QUERY ...]] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| query | Query to evaluate on loaded datasets | None | False | None | + +--- diff --git a/website/content/terminal/reference/economy/events.md b/website/content/terminal/reference/economy/events.md new file mode 100644 index 000000000000..6e82d048d59e --- /dev/null +++ b/website/content/terminal/reference/economy/events.md @@ -0,0 +1,89 @@ +--- +title: events +description: This page of the documentation provides comprehensive instructions on + how to use the 'events' feature of our API. It allows users to fetch economic events + from various countries within a specified date range. Important options include + setting the importance and category of events. +keywords: +- economy +- economic calendar +- global financial events +- events tracking +- country wise economic events +- importance +- event category +- API usage +- financial market +- data analysis +- finance data +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Economic calendar. If no start or end dates, default is the current day high importance events. + +### Usage + +```python +events [-c {argentina,australia,austria,bahrain,bangladesh,belgium,bosnia,botswana,brazil,bulgaria,canada,cayman_islands,chile,china,colombia,costa_rica,croatia,cyprus,czech_republic,denmark,dubai,ecuador,egypt,estonia,euro_zone,finland,france,germany,greece,hong_kong,hungary,iceland,india,indonesia,iraq,ireland,israel,italy,ivory_coast,jamaica,japan,jordan,kazakhstan,kenya,kuwait,latvia,lebanon,lithuania,luxembourg,malawi,malaysia,malta,mauritius,mexico,mongolia,montenegro,morocco,namibia,netherlands,new_zealand,nigeria,norway,oman,pakistan,palestine,peru,philippines,poland,portugal,qatar,romania,russia,rwanda,saudi_arabia,serbia,singapore,slovakia,slovenia,south_africa,south_korea,spain,sri_lanka,sweden,switzerland,taiwan,tanzania,thailand,tunisia,turkey,uganda,ukraine,united_kingdom,united_states,venezuela,vietnam,zambia,zimbabwe,all}] [-s START_DATE] [-e END_DATE] [-d SPEC_DATE] [-i {high,medium,low,all}] [--categories {employment,credit,balance,economic_activity,central_banks,bonds,inflation,confidence_index}] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| country | Display calendar for specific country. | | True | argentina, australia, austria, bahrain, bangladesh, belgium, bosnia, botswana, brazil, bulgaria, canada, cayman_islands, chile, china, colombia, costa_rica, croatia, cyprus, czech_republic, denmark, dubai, ecuador, egypt, estonia, euro_zone, finland, france, germany, greece, hong_kong, hungary, iceland, india, indonesia, iraq, ireland, israel, italy, ivory_coast, jamaica, japan, jordan, kazakhstan, kenya, kuwait, latvia, lebanon, lithuania, luxembourg, malawi, malaysia, malta, mauritius, mexico, mongolia, montenegro, morocco, namibia, netherlands, new_zealand, nigeria, norway, oman, pakistan, palestine, peru, philippines, poland, portugal, qatar, romania, russia, rwanda, saudi_arabia, serbia, singapore, slovakia, slovenia, south_africa, south_korea, spain, sri_lanka, sweden, switzerland, taiwan, tanzania, thailand, tunisia, turkey, uganda, ukraine, united_kingdom, united_states, venezuela, vietnam, zambia, zimbabwe, all | +| start_date | The start date of the data (format: YEAR-MONTH-DAY, i.e. 2010-12-31) | 2022-11-25 | True | None | +| end_date | The start date of the data (format: YEAR-MONTH-DAY, i.e. 2010-12-31) | 2022-11-25 | True | None | +| spec_date | Get a specific date for events. Overrides start and end dates. | None | True | None | +| importance | Event importance classified as high, medium, low or all. | None | True | high, medium, low, all | +| category | [INVESTING source only] Event category. | None | True | employment, credit, balance, economic_activity, central_banks, bonds, inflation, confidence_index | + + +--- + +## Examples + +```python +2022 Oct 20, 15:19 (🦋) /economy/ $ events -c united_kingdom,spain -s 2022-10-20 -e 2022-11-05 -l 15 + + Economic Calendar +┏━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━┳━━━━━━━━━━━┳━━━━━━━━━━┳━━━━━━━━━━━━┓ +┃ Time (GMT) ┃ Country ┃ Event ┃ actual ┃ consensus ┃ previous ┃ Date ┃ +┡━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━╇━━━━━━━━━━━╇━━━━━━━━━━╇━━━━━━━━━━━━┩ +│ 04:40 │ Spain │ Spanish 3-Year Bonos Auction │ 2.663% │ - │ 1.416% │ 2022-10-20 │ +├────────────┼────────────────┼────────────────────────────────────┼────────┼───────────┼──────────┼────────────┤ +│ 04:40 │ Spain │ Spanish 7-Year Obligacion Auction │ 3.247% │ - │ 1.550% │ 2022-10-20 │ +├────────────┼────────────────┼────────────────────────────────────┼────────┼───────────┼──────────┼────────────┤ +│ 19:01 │ United Kingdom │ GfK Consumer Confidence │ - │ -52 │ -49 │ 2022-10-20 │ +├────────────┼────────────────┼────────────────────────────────────┼────────┼───────────┼──────────┼────────────┤ +│ 02:00 │ United Kingdom │ Core Retail Sales │ - │ -0.3% │ -1.6% │ 2022-10-21 │ +├────────────┼────────────────┼────────────────────────────────────┼────────┼───────────┼──────────┼────────────┤ +│ 02:00 │ United Kingdom │ Core Retail Sales │ - │ -4.1% │ -5.0% │ 2022-10-21 │ +├────────────┼────────────────┼────────────────────────────────────┼────────┼───────────┼──────────┼────────────┤ +│ 02:00 │ United Kingdom │ Public Sector Net Borrowing │ - │ 12.30B │ 11.06B │ 2022-10-21 │ +├────────────┼────────────────┼────────────────────────────────────┼────────┼───────────┼──────────┼────────────┤ +│ 02:00 │ United Kingdom │ Public Sector Net Cash Requirement │ - │ - │ 5.321B │ 2022-10-21 │ +├────────────┼────────────────┼────────────────────────────────────┼────────┼───────────┼──────────┼────────────┤ +│ 02:00 │ United Kingdom │ Retail Sales │ - │ -5.0% │ -5.4% │ 2022-10-21 │ +├────────────┼────────────────┼────────────────────────────────────┼────────┼───────────┼──────────┼────────────┤ +│ 02:00 │ United Kingdom │ Retail Sales │ - │ -0.5% │ -1.6% │ 2022-10-21 │ +├────────────┼────────────────┼────────────────────────────────────┼────────┼───────────┼──────────┼────────────┤ +│ 04:30 │ United Kingdom │ BoE Consumer Credit │ - │ - │ 1.077B │ 2022-10-21 │ +├────────────┼────────────────┼────────────────────────────────────┼────────┼───────────┼──────────┼────────────┤ +│ 04:30 │ United Kingdom │ M4 Money Supply │ - │ - │ -0.2% │ 2022-10-21 │ +├────────────┼────────────────┼────────────────────────────────────┼────────┼───────────┼──────────┼────────────┤ +│ 04:30 │ United Kingdom │ Mortgage Approvals │ - │ 62.00K │ 74.34K │ 2022-10-21 │ +├────────────┼────────────────┼────────────────────────────────────┼────────┼───────────┼──────────┼────────────┤ +│ 04:30 │ United Kingdom │ Mortgage Lending │ - │ 4.90B │ 6.14B │ 2022-10-21 │ +├────────────┼────────────────┼────────────────────────────────────┼────────┼───────────┼──────────┼────────────┤ +│ 15:30 │ United Kingdom │ CFTC GBP speculative net positions │ - │ - │ -39.2K │ 2022-10-21 │ +├────────────┼────────────────┼────────────────────────────────────┼────────┼───────────┼──────────┼────────────┤ +│ 14:00 │ United Kingdom │ BoE MPC Member Mann │ - │ - │ - │ 2022-10-22 │ +└────────────┴────────────────┴────────────────────────────────────┴────────┴───────────┴──────────┴────────────┘ +``` +--- diff --git a/website/content/terminal/reference/economy/fred.md b/website/content/terminal/reference/economy/fred.md new file mode 100644 index 000000000000..ada8f2161ccd --- /dev/null +++ b/website/content/terminal/reference/economy/fred.md @@ -0,0 +1,80 @@ +--- +title: fred +description: This documentation page provides information on using the fred command + to query the FRED database, plot data, and handle Macro Economic data. It includes + details on parameters, usage, and examples including Python code snippets. +keywords: +- FRED database +- Query +- Series ID +- Fred command +- Macro Economic +- Data plotting +- Start date +- End date +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Query the FRED database and plot data based on the Series ID. [Source: FRED] + +### Usage + +```python +fred [-p PARAMETER] [-s START_DATE] [-e END_DATE] [-q QUERY] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| parameter | Series ID of the Macro Economic data from FRED | | True | None | +| start_date | Starting date (YYYY-MM-DD) of data | None | True | None | +| end_date | Ending date (YYYY-MM-DD) of data | None | True | None | +| query | Query the FRED database to obtain Series IDs given the query search term. | None | True | None | + + +--- + +## Examples + +```python +2022 Mar 15, 07:08 (🦋) /economy/ $ fred -q treasuries + Search results for treasuries +┏━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Series ID ┃ Title ┃ Description ┃ +┡━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┩ +│ T10Y2Y │ 10-Year Treasury Constant Maturity Minus 2-Year │ Starting with the update on June 21, 2019, the Treasury bond data used in calculating interest rate │ +│ │ Treasury Constant Maturity │ spreads is obtained directly from the U.S. Treasury Department (https://www.treasury.gov/resource- │ +│ │ │ center/data-chart-center/interest-rates/Pages/TextView.aspx?data=yield). Series is calculated as │ +│ │ │ the spread between 10-Year Treasury Constant Maturity (BC_10YEAR) and 2-Year Treasury Constant │ +│ │ │ Maturity (BC_2YEAR). Both underlying series are published at the U.S. Treasury Department │ +│ │ │ (https://www.treasury.gov/resource-center/data-chart-center/interest- │ +│ │ │ rates/Pages/TextView.aspx?data=yield). │ +├───────────┼─────────────────────────────────────────────────┼─────────────────────────────────────────────────────────────────────────────────────────────────────┤ +│ T10Y2YM │ 10-Year Treasury Constant Maturity Minus 2-Year │ Series is calculated as the spread between 10-Year Treasury Constant Maturity (BC_10YEARM) and │ +│ │ Treasury Constant Maturity │ 2-Year Treasury Constant Maturity (BC_2YEARM). Starting with the update on June 21, 2019, the │ +│ │ │ Treasury bond data used in calculating interest rate spreads is obtained directly from the U.S. │ +│ │ │ Treasury Department (https://www.treasury.gov/resource-center/data-chart-center/interest- │ +│ │ │ rates/Pages/TextView.aspx?data=yield). │ +├───────────┼─────────────────────────────────────────────────┼─────────────────────────────────────────────────────────────────────────────────────────────────────┤ +│ DFII10 │ Market Yield on U.S. Treasury Securities at │ For further information regarding treasury constant maturity data, please refer to the Board of │ +│ │ 10-Year Constant Maturity, Inflation-Indexed │ Governors ( http://www.federalreserve.gov/releases/h15/current/h15.pdf) and the Treasury │ +│ │ │ (http://www.treasury.gov/resource-center/data-chart-center/interest-rates/Pages/yieldmethod.aspx). │ +├───────────┼─────────────────────────────────────────────────┼─────────────────────────────────────────────────────────────────────────────────────────────────────┤ +│ FII10 │ Market Yield on U.S. Treasury Securities at │ For further information regarding treasury constant maturity data, please refer to │ +│ │ 10-Year Constant Maturity, Inflation-Indexed │ http://www.federalreserve.gov/releases/h15/current/h15.pdf and http://www.treasury.gov/resource- │ +│ │ │ center/data-chart-center/interest-rates/Pages/yieldmethod.aspx. │ +├───────────┼─────────────────────────────────────────────────┼─────────────────────────────────────────────────────────────────────────────────────────────────────┤ +│ WFII10 │ Market Yield on U.S. Treasury Securities at │ For further information regarding treasury constant maturity data, please refer to │ +│ │ 10-Year Constant Maturity, Inflation-Indexed │ http://www.federalreserve.gov/releases/h15/current/h15.pdf and http://www.treasury.gov/resource- │ +│ │ │ center/data-chart-center/interest-rates/Pages/yieldmethod.aspx. │ +└───────────┴─────────────────────────────────────────────────┴─────────────────────────────────────────────────────────────────────────────────────────────────────┘ +``` +![fred](https://user-images.githubusercontent.com/46355364/158575129-1d4b26de-8bd8-49b3-b1b9-e349afaf8a50.png) + +--- diff --git a/website/content/terminal/reference/economy/futures.md b/website/content/terminal/reference/economy/futures.md new file mode 100644 index 000000000000..95fc60f2e922 --- /dev/null +++ b/website/content/terminal/reference/economy/futures.md @@ -0,0 +1,161 @@ +--- +title: futures +description: This page provides information on futures/commodities from sources such + as Wall St. Journal and FinViz. Users can retrieve a range of commodity futures + (like energy, metals, meats, grains, softs) and sort the data in several ways. +keywords: +- futures +- commodities +- Wall St. Journal +- FinViz +- energy +- metals +- meats +- grains +- softs +- sortby +- reverse +- commodity futures +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Futures/Commodities from Wall St. Journal and FinViz. + +### Usage + +```python +futures [-c {energy,metals,meats,grains,softs}] [-s {ticker,last,change,prevClose}] [-r] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| commodity | Obtain commodity futures from FinViz | | True | energy, metals, meats, grains, softs | +| sortby | | ticker | True | ticker, last, change, prevClose | +| reverse | Data is sorted in descending order by default. Reverse flag will sort it in an ascending way. Only works when raw data is displayed. | False | True | None | + + +--- + +## Examples + +```python +2022 Mar 15, 07:02 (🦋) /economy/ $ futures + Futures/Commodities [Source: Wall St. Journal] +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━┳━━━━━━━━━┳━━━━━━━┓ +┃ ┃ Price ┃ Chg ┃ %Chg ┃ +┡━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━╇━━━━━━━━━╇━━━━━━━┩ +│ Crude Oil Futures │ 97.11 │ -5.90 │ -5.73 │ +├───────────────────────────┼─────────┼─────────┼───────┤ +│ Brent Crude Futures │ 101.01 │ -5.89 │ -5.51 │ +├───────────────────────────┼─────────┼─────────┼───────┤ +│ Gold Futures │ 1930.50 │ -30.30 │ -1.55 │ +├───────────────────────────┼─────────┼─────────┼───────┤ +│ Silver Futures │ 24.875 │ -0.423 │ -1.67 │ +├───────────────────────────┼─────────┼─────────┼───────┤ +│ Natural Gas Futures │ 4.601 │ -0.101 │ -2.15 │ +├───────────────────────────┼─────────┼─────────┼───────┤ +│ Unleaded Gasoline Futures │ 3.0197 │ -0.1492 │ -4.71 │ +├───────────────────────────┼─────────┼─────────┼───────┤ +│ Copper Futures │ 4.5005 │ -0.0225 │ -0.50 │ +├───────────────────────────┼─────────┼─────────┼───────┤ +│ Corn Futures │ 739.00 │ -9.25 │ -1.24 │ +├───────────────────────────┼─────────┼─────────┼───────┤ +│ Wheat Futures │ 1126.50 │ 30.25 │ 2.76 │ +├───────────────────────────┼─────────┼─────────┼───────┤ +│ Bloomberg Commodity Index │ 121.16 │ -2.64 │ -2.13 │ +└───────────────────────────┴─────────┴─────────┴───────┘ + +2022 Mar 15, 07:03 (🦋) /economy/ $ futures energy + Future Table [Source: FinViz] +┏━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━┳━━━━━━━━┳━━━━━━━━━━━━┓ +┃ ┃ prevClose ┃ last ┃ change (%) ┃ +┡━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━╇━━━━━━━━╇━━━━━━━━━━━━┩ +│ Ethanol │ 2.16 │ 2.22 │ 2.78 │ +├─────────────────┼───────────┼────────┼────────────┤ +│ Gasoline RBOB │ 3.17 │ 3.02 │ -4.82 │ +├─────────────────┼───────────┼────────┼────────────┤ +│ Crude Oil Brent │ 106.90 │ 101.01 │ -5.51 │ +├─────────────────┼───────────┼────────┼────────────┤ +│ Natural Gas │ 4.66 │ 4.56 │ -2.10 │ +├─────────────────┼───────────┼────────┼────────────┤ +│ Heating Oil │ 3.28 │ 3.07 │ -6.44 │ +├─────────────────┼───────────┼────────┼────────────┤ +│ Crude Oil WTI │ 103.01 │ 97.14 │ -5.70 │ +└─────────────────┴───────────┴────────┴────────────┘ + +2022 Mar 15, 07:04 (🦋) /economy/ $ futures metals + Future Table [Source: FinViz] +┏━━━━━━━━━━━┳━━━━━━━━━━━┳━━━━━━━━━┳━━━━━━━━━━━━┓ +┃ ┃ prevClose ┃ last ┃ change (%) ┃ +┡━━━━━━━━━━━╇━━━━━━━━━━━╇━━━━━━━━━╇━━━━━━━━━━━━┩ +│ Silver │ 25.30 │ 24.88 │ -1.65 │ +├───────────┼───────────┼─────────┼────────────┤ +│ Platinum │ 1052.30 │ 1021.50 │ -2.93 │ +├───────────┼───────────┼─────────┼────────────┤ +│ Palladium │ 2417.60 │ 2450.50 │ 1.36 │ +├───────────┼───────────┼─────────┼────────────┤ +│ Copper │ 4.52 │ 4.49 │ -0.64 │ +├───────────┼───────────┼─────────┼────────────┤ +│ Gold │ 1960.80 │ 1930.30 │ -1.56 │ +└───────────┴───────────┴─────────┴────────────┘ + +2022 Mar 15, 07:04 (🦋) /economy/ $ futures meats + Future Table [Source: FinViz] +┏━━━━━━━━━━━━━━━┳━━━━━━━━━━━┳━━━━━━━━┳━━━━━━━━━━━━┓ +┃ ┃ prevClose ┃ last ┃ change (%) ┃ +┡━━━━━━━━━━━━━━━╇━━━━━━━━━━━╇━━━━━━━━╇━━━━━━━━━━━━┩ +│ Lean Hogs │ 102.72 │ 102.17 │ -0.54 │ +├───────────────┼───────────┼────────┼────────────┤ +│ Live Cattle │ 137.30 │ 140.35 │ 2.22 │ +├───────────────┼───────────┼────────┼────────────┤ +│ Feeder Cattle │ 157.97 │ 162.43 │ 2.82 │ +└───────────────┴───────────┴────────┴────────────┘ + +2022 Mar 15, 07:04 (🦋) /economy/ $ futures grains + Future Table [Source: FinViz] +┏━━━━━━━━━━━━━━┳━━━━━━━━━━━┳━━━━━━━━━┳━━━━━━━━━━━━┓ +┃ ┃ prevClose ┃ last ┃ change (%) ┃ +┡━━━━━━━━━━━━━━╇━━━━━━━━━━━╇━━━━━━━━━╇━━━━━━━━━━━━┩ +│ Wheat │ 1096.25 │ 1127.50 │ 2.85 │ +├──────────────┼───────────┼─────────┼────────────┤ +│ Soybeans │ 1670.50 │ 1646.00 │ -1.47 │ +├──────────────┼───────────┼─────────┼────────────┤ +│ Rough Rice │ 16.10 │ 16.14 │ 0.25 │ +├──────────────┼───────────┼─────────┼────────────┤ +│ Oats │ 662.00 │ 653.75 │ -1.25 │ +├──────────────┼───────────┼─────────┼────────────┤ +│ Soybean Meal │ 484.30 │ 476.40 │ -1.63 │ +├──────────────┼───────────┼─────────┼────────────┤ +│ Soybean oil │ 73.95 │ 72.90 │ -1.42 │ +├──────────────┼───────────┼─────────┼────────────┤ +│ Corn │ 748.25 │ 739.75 │ -1.14 │ +├──────────────┼───────────┼─────────┼────────────┤ +│ Canola │ 1139.10 │ 1113.40 │ -2.26 │ +└──────────────┴───────────┴─────────┴────────────┘ + +2022 Mar 15, 07:04 (🦋) /economy/ $ futures softs + Future Table [Source: FinViz] +┏━━━━━━━━━━━━━━┳━━━━━━━━━━━┳━━━━━━━━━┳━━━━━━━━━━━━┓ +┃ ┃ prevClose ┃ last ┃ change (%) ┃ +┡━━━━━━━━━━━━━━╇━━━━━━━━━━━╇━━━━━━━━━╇━━━━━━━━━━━━┩ +│ Sugar │ 19.13 │ 18.74 │ -2.04 │ +├──────────────┼───────────┼─────────┼────────────┤ +│ Lumber │ 1159.20 │ 1104.00 │ -4.76 │ +├──────────────┼───────────┼─────────┼────────────┤ +│ Coffee │ 218.80 │ 215.05 │ -1.71 │ +├──────────────┼───────────┼─────────┼────────────┤ +│ Orange Juice │ 138.70 │ 142.00 │ 2.38 │ +├──────────────┼───────────┼─────────┼────────────┤ +│ Cotton │ 118.77 │ 118.06 │ -0.60 │ +├──────────────┼───────────┼─────────┼────────────┤ +│ Cocoa │ 2611.00 │ 2556.00 │ -2.11 │ +└──────────────┴───────────┴─────────┴────────────┘ +``` +--- diff --git a/website/content/terminal/reference/economy/index_cmd.md b/website/content/terminal/reference/economy/index_cmd.md new file mode 100644 index 000000000000..457c6f0f42f0 --- /dev/null +++ b/website/content/terminal/reference/economy/index_cmd.md @@ -0,0 +1,59 @@ +--- +title: index +description: This page provides detailed information on how to obtain indices data + and visualize it. The useful parameters and their respective descriptions are provided + to ensure efficient data manipulation. Actual examples that illustrate the usage + of the commands are included for better understanding. +keywords: +- Indices data +- Data plot +- Yahoo Finance +- FinanceDatabase +- Data intervals +- Start date +- End date +- Data column +- Data query +- Compounded returns +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Obtain any set of indices and plot them together. With the -si argument the major indices are shown. By using the arguments (for example 'nasdaq' and 'sp500') you can collect data and plot the graphs together. [Source: Yahoo finance / FinanceDatabase] + +### Usage + +```python +index [-i INDICES] [--show] [--interval {1m,2m,5m,15m,30m,60m,90m,1h,1d,5d,1wk,1mo,3mo}] [-s START_DATE] [-e END_DATE] [-c COLUMN] [-q QUERY] [-r] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| indices | One or multiple indices | None | True | None | +| show_indices | Show the major indices, their arguments and ticker | False | True | None | +| interval | The preferred interval data is shown at. This can be 1m, 2m, 5m, 15m, 30m, 60m, 90m, 1h, 1d, 5d, 1wk, 1mo or 3mo | 1d | True | 1m, 2m, 5m, 15m, 30m, 60m, 90m, 1h, 1d, 5d, 1wk, 1mo, 3mo | +| start_date | The start date of the data (format: YEAR-MONTH-DAY, i.e. 2010-12-31) | 2000-01-01 | True | None | +| end_date | The end date of the data (format: YEAR-MONTH-DAY, i.e. 2021-06-20) | None | True | None | +| column | The column you wish to load in, by default this is the Adjusted Close column | Adj Close | True | None | +| query | Search for indices with given keyword | None | True | None | +| returns | Flag to show compounded returns over interval. | False | True | None | + + +--- + +## Examples + +```python +2022 Mar 15, 07:29 (🦋) /economy/ $ index nasdaq,dowjones +``` +![index nasdaq dowjones](https://user-images.githubusercontent.com/46355364/158573612-f2e4b04c-b833-4899-9817-62e40b9fe1d2.png) + +![index vix](https://user-images.githubusercontent.com/46355364/158573676-9871c58e-3ffd-44d5-888a-c1d76ec98251.png) + +--- diff --git a/website/content/terminal/reference/economy/macro.md b/website/content/terminal/reference/economy/macro.md new file mode 100644 index 000000000000..b743fe1819a6 --- /dev/null +++ b/website/content/terminal/reference/economy/macro.md @@ -0,0 +1,60 @@ +--- +title: macro +description: Learn how to retrieve and manipulate a variety of macro data from numerous + countries using various parameters and transformations. The page provides examples + and details of the functionalities. +keywords: +- macro data +- Gross Domestic Product +- Treasury Yields +- Employment figures +- Government components +- Consumer and Producer Indices +- EconDB +- macro parameters +- data transformation +- macro programming +- currency conversion +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Get a broad selection of macro data from one or multiple countries. This includes Gross Domestic Product (RGDP & GDP) and the underlying components, Treasury Yields (Y10YD & M3YD), Employment figures (URATE, EMP, AC0I0 and EMRATIO), Government components (e.g. GBAL & GREV), Consumer and Producer Indices (CPI & PPI) and a variety of other indicators. [Source: EconDB] + +### Usage + +```python +macro [-p PARAMETERS] [-c COUNTRIES] [-t {,TPOP,TOYA,TUSD,TPGP,TNOR}] [--show {parameters,countries,transform}] [-s START_DATE] [-e END_DATE] [--convert {Albania,Argentina,Australia,Austria,Azerbaijan,Bangladesh,Belarus,Belgium,Bhutan,Bosnia_and_Herzegovina,Botswana,Brazil,Bulgaria,Cambodia,Cameroon,Canada,Chile,China,Colombia,Croatia,Cyprus,Czechia,Denmark,Dominican_Republic,Egypt,Estonia,European_Union,Finland,France,Germany,Greece,Honduras,Hong Kong,Hungary,India,Indonesia,Iran,Ireland,Israel,Italy,Japan,Kazakhstan,Laos,Latvia,Lebanon,Lithuania,Luxembourg,Macedonia,Malaysia,Malta,Mexico,Mongolia,Netherlands,New_Zealand,Nigeria,Norway,Oman,Pakistan,Panama,Paraguay,Peru,Philippines,Poland,Portugal,Qatar,Romania,Russia,Saudi_Arabia,Serbia,Singapore,Slovakia,Slovenia,South_Africa,South_Korea,Spain,Sweden,Switzerland,Taiwan,Thailand,Tunisia,Turkey,Ukraine,United_Arab_Emirates,United_Kingdom,United_States,Uzbekistan,Venezuela,Vietnam}] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| parameters | Abbreviation(s) of the Macro Economic data | CPI | True | None | +| countries | The country or countries you wish to show data for | united_states | True | None | +| transform | The transformation to apply to the data | | True | , TPOP, TOYA, TUSD, TPGP, TNOR | +| show | Show parameters and what they represent using 'parameters' or countries and their currencies using 'countries' | None | True | parameters, countries, transform | +| start_date | The start date of the data (format: YEAR-MONTH-DAY, i.e. 2010-12-31) | None | True | None | +| end_date | The end date of the data (format: YEAR-MONTH-DAY, i.e. 2021-06-20) | None | True | None | +| currency | Convert the currency of the chosen country to a specified currency. To find the currency symbols use '--show countries' | False | True | Albania, Argentina, Australia, Austria, Azerbaijan, Bangladesh, Belarus, Belgium, Bhutan, Bosnia_and_Herzegovina, Botswana, Brazil, Bulgaria, Cambodia, Cameroon, Canada, Chile, China, Colombia, Croatia, Cyprus, Czechia, Denmark, Dominican_Republic, Egypt, Estonia, European_Union, Finland, France, Germany, Greece, Honduras, Hong Kong, Hungary, India, Indonesia, Iran, Ireland, Israel, Italy, Japan, Kazakhstan, Laos, Latvia, Lebanon, Lithuania, Luxembourg, Macedonia, Malaysia, Malta, Mexico, Mongolia, Netherlands, New_Zealand, Nigeria, Norway, Oman, Pakistan, Panama, Paraguay, Peru, Philippines, Poland, Portugal, Qatar, Romania, Russia, Saudi_Arabia, Serbia, Singapore, Slovakia, Slovenia, South_Africa, South_Korea, Spain, Sweden, Switzerland, Taiwan, Thailand, Tunisia, Turkey, Ukraine, United_Arab_Emirates, United_Kingdom, United_States, Uzbekistan, Venezuela, Vietnam | + + +--- + +## Examples + +```python +2022 Mar 15, 07:20 (🦋) /economy/ $ macro -p CONF -c netherlands,germany,france -s 2005-01-01 -e 2022-01-01 +``` +![macro conf netherlands germany france](https://user-images.githubusercontent.com/46355364/159249787-a030cd2c-0b29-4522-a1a9-db0245d55d9f.png) + +![oil production macro](https://user-images.githubusercontent.com/46355364/159251277-9381cc0a-7efe-41ce-af93-41d832103a1e.png) + +![argentina gross domestic product in dollars](https://user-images.githubusercontent.com/46355364/159253210-c7135b12-b04a-49e4-8896-d03e4c25f520.png) + +--- diff --git a/website/content/terminal/reference/economy/map.md b/website/content/terminal/reference/economy/map.md new file mode 100644 index 000000000000..a0d6d8fd6470 --- /dev/null +++ b/website/content/terminal/reference/economy/map.md @@ -0,0 +1,44 @@ +--- +title: map +description: The documentation outlines the usage and parameters of a performance + index stocks map placed according to sectors and industries. The Web-Based map tool, + sourced by Finviz, adjusts based on selected performance periods and map filter + types, such as SP500, world, full or ETF. +keywords: +- Performance index +- stocks map +- sectors and industries +- market cap +- Finviz +- map filter type +- Performance period +- sp500 +- world +- full +- etf +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Performance index stocks map categorized by sectors and industries. Size represents market cap. Opens web-browser. [Source: Finviz] + +### Usage + +```python +map [-p {1d,1w,1m,3m,6m,1y}] [-t {sp500,world,full,etf}] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| s_period | Performance period. | 1d | True | 1d, 1w, 1m, 3m, 6m, 1y | +| s_type | Map filter type. | sp500 | True | sp500, world, full, etf | + +![map](https://user-images.githubusercontent.com/46355364/154042399-ede7eb15-de7f-4de7-8541-3700ad2a97a0.png) + +--- diff --git a/website/content/terminal/reference/economy/overview.md b/website/content/terminal/reference/economy/overview.md new file mode 100644 index 000000000000..faa6034925ba --- /dev/null +++ b/website/content/terminal/reference/economy/overview.md @@ -0,0 +1,173 @@ +--- +title: overview +description: 'A comprehensive guide to monitor different financial markets that includes + usage of command-line codes for the assessment of indices, US bonds, global bonds + and currencies. US indices include examples of DJIA, S&P 500, Nasdaq Composite, + and several others. The bond overview provides details about US 10 Year Treasury + Note, Germany 10 Year Government Bond, and more. Currencies'' commands exemplify + data about Euro, Japanese Yen, U.K. Pound and others. ' +keywords: +- Market Overview +- Indices +- US Bonds +- Global Bonds +- Currencies +- Command-line codes +- Financial Markets +- DJIA +- S&P 500 +- Nasdaq Composite +- US 10 Year Treasury Note +- Germany 10 Year Government Bond +- Euro +- Japanese Yen +- U.K. Pound +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Provide a market overview of a variety of options. This can be a general overview, indices, bonds and currencies. [Source: Wall St. Journal] + +### Usage + +```python +overview [-t {indices,usbonds,glbonds,currencies}] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| type | Obtain either US indices, US Bonds, Global Bonds or Currencies | | True | indices, usbonds, glbonds, currencies | + + +--- + +## Examples + +```python +2022 Mar 15, 06:59 (🦋) /economy/ $ overview + Market Overview +┏━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━┳━━━━━━━━━┳━━━━━━━┓ +┃ ┃ Price ┃ Chg ┃ %Chg ┃ +┡━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━╇━━━━━━━━━╇━━━━━━━┩ +│ DJIA │ 32945.24 │ 1.05 │ 0.00 │ +├───────────────────┼──────────┼─────────┼───────┤ +│ S&P 500 │ 4173.11 │ -31.20 │ -0.74 │ +├───────────────────┼──────────┼─────────┼───────┤ +│ Nasdaq Composite │ 12581.22 │ -262.59 │ -2.04 │ +├───────────────────┼──────────┼─────────┼───────┤ +│ Japan: Nikkei 225 │ 25346.48 │ 38.63 │ 0.15 │ +├───────────────────┼──────────┼─────────┼───────┤ +│ UK: FTSE 100 │ 7117.67 │ -75.80 │ -1.05 │ +├───────────────────┼──────────┼─────────┼───────┤ +│ Crude Oil Futures │ 97.12 │ -5.89 │ -5.72 │ +├───────────────────┼──────────┼─────────┼───────┤ +│ Gold Futures │ 1932.30 │ -28.50 │ -1.45 │ +├───────────────────┼──────────┼─────────┼───────┤ +│ Yen │ 118.01 │ -0.18 │ -0.15 │ +├───────────────────┼──────────┼─────────┼───────┤ +│ Euro │ 1.0996 │ 0.0055 │ 0.50 │ +└───────────────────┴──────────┴─────────┴───────┘ + +2022 Mar 15, 07:00 (🦋) /economy/ $ overview indices + US Indices +┏━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━┳━━━━━━━━━┳━━━━━━━┓ +┃ ┃ Price ┃ Chg ┃ %Chg ┃ +┡━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━╇━━━━━━━━━╇━━━━━━━┩ +│ DJIA │ 32945.24 │ 1.05 │ 0.00 │ +├───────────────────────┼──────────┼─────────┼───────┤ +│ Nasdaq Composite │ 12581.22 │ -262.59 │ -2.04 │ +├───────────────────────┼──────────┼─────────┼───────┤ +│ S&P 500 │ 4173.11 │ -31.20 │ -0.74 │ +├───────────────────────┼──────────┼─────────┼───────┤ +│ DJ Total Stock Market │ 42169.18 │ -412.17 │ -0.97 │ +├───────────────────────┼──────────┼─────────┼───────┤ +│ Russell 2000 │ 1941.72 │ -37.95 │ -1.92 │ +├───────────────────────┼──────────┼─────────┼───────┤ +│ NYSE Composite │ 15694.35 │ -59.35 │ -0.38 │ +├───────────────────────┼──────────┼─────────┼───────┤ +│ Barron's 400 │ 968.62 │ -6.27 │ -0.64 │ +├───────────────────────┼──────────┼─────────┼───────┤ +│ CBOE Volatility │ 32.57 │ 0.80 │ 2.52 │ +├───────────────────────┼──────────┼─────────┼───────┤ +│ DJIA Futures │ 32786 │ -52 │ -0.16 │ +├───────────────────────┼──────────┼─────────┼───────┤ +│ S&P 500 Futures │ 4160.25 │ -3.25 │ -0.08 │ +└───────────────────────┴──────────┴─────────┴───────┘ + +2022 Mar 15, 07:00 (🦋) /economy/ $ overview usbonds +ov US Bonds +┏━━━━━━━━━━━━━━┳━━━━━━━━━━┳━━━━━━━━━┳━━━━━━━━━━━━━┓ +┃ ┃ Rate (%) ┃ Yld (%) ┃ Yld Chg (%) ┃ +┡━━━━━━━━━━━━━━╇━━━━━━━━━━╇━━━━━━━━━╇━━━━━━━━━━━━━┩ +│ 30-Year Bond │ 2.25 │ 2.462 │ -0.016 │ +├──────────────┼──────────┼─────────┼─────────────┤ +│ 10-Year Note │ 1.88 │ 2.119 │ -0.025 │ +├──────────────┼──────────┼─────────┼─────────────┤ +│ 7-Year Note │ 1.88 │ 2.131 │ -0.023 │ +├──────────────┼──────────┼─────────┼─────────────┤ +│ 5-Year Note │ 1.88 │ 2.070 │ -0.023 │ +├──────────────┼──────────┼─────────┼─────────────┤ +│ 3-Year Note │ 1.75 │ 2.020 │ -0.035 │ +├──────────────┼──────────┼─────────┼─────────────┤ +│ 2-Year Note │ 1.50 │ 1.835 │ -0.032 │ +├──────────────┼──────────┼─────────┼─────────────┤ +│ 1-Year Bill │ 0.00 │ 1.202 │ -0.003 │ +├──────────────┼──────────┼─────────┼─────────────┤ +│ 6-Month Bill │ 0.00 │ 0.830 │ 0.087 │ +├──────────────┼──────────┼─────────┼─────────────┤ +│ 3-Month Bill │ 0.00 │ 0.442 │ -0.019 │ +├──────────────┼──────────┼─────────┼─────────────┤ +│ 1-Month Bill │ 0.00 │ 0.200 │ -0.007 │ +└──────────────┴──────────┴─────────┴─────────────┘ + +2022 Mar 15, 07:00 (🦋) /economy/ $ overview glbonds + Global Bonds +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━┳━━━━━━━━━┳━━━━━━━━━━━━━┓ +┃ ┃ Rate (%) ┃ Yld (%) ┃ Yld Chg (%) ┃ +┡━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━╇━━━━━━━━━╇━━━━━━━━━━━━━┩ +│ U.S. 10 Year Treasury Note │ 1.875 │ 2.118 │ -0.026 │ +├───────────────────────────────────┼──────────┼─────────┼─────────────┤ +│ Germany 10 Year Government Bond │ 0.000 │ 0.359 │ -0.009 │ +├───────────────────────────────────┼──────────┼─────────┼─────────────┤ +│ U.K. 10 Year Gilt │ 4.250 │ 1.591 │ -0.006 │ +├───────────────────────────────────┼──────────┼─────────┼─────────────┤ +│ Japan 10 Year Government Bond │ 0.100 │ 0.210 │ 0.015 │ +├───────────────────────────────────┼──────────┼─────────┼─────────────┤ +│ Australia 10 Year Government Bond │ 1.000 │ 2.505 │ 0.061 │ +├───────────────────────────────────┼──────────┼─────────┼─────────────┤ +│ China 10 Year Government Bond │ 2.890 │ 2.846 │ 0.055 │ +└───────────────────────────────────┴──────────┴─────────┴─────────────┘ + +2022 Mar 15, 07:00 (🦋) /economy/ $ overview currencies + Currencies +┏━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━┳━━━━━━━━━┳━━━━━━━┓ +┃ ┃ Last ┃ Chng ┃ %Chng ┃ +┡━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━╇━━━━━━━━━╇━━━━━━━┩ +│ Euro (EUR/USD) │ 1.0996 │ 0.0055 │ 0.50 │ +├────────────────────────┼─────────┼─────────┼───────┤ +│ Japanese Yen (USD/JPY) │ 118.03 │ -0.16 │ -0.14 │ +├────────────────────────┼─────────┼─────────┼───────┤ +│ U.K. Pound (GBP/USD) │ 1.3036 │ 0.0035 │ 0.27 │ +├────────────────────────┼─────────┼─────────┼───────┤ +│ Swiss Franc (USD/CHF) │ 0.9388 │ 0.0002 │ 0.02 │ +├────────────────────────┼─────────┼─────────┼───────┤ +│ Chinese Yuan (USD/CNY) │ 6.3740 │ 0.0086 │ 0.14 │ +├────────────────────────┼─────────┼─────────┼───────┤ +│ Canadian $ (USD/CAD) │ 1.2846 │ 0.0020 │ 0.16 │ +├────────────────────────┼─────────┼─────────┼───────┤ +│ Mexican Peso (USD/MXN) │ 20.8658 │ -0.0495 │ -0.24 │ +├────────────────────────┼─────────┼─────────┼───────┤ +│ Bitcoin (BTC/USD) │ 38691 │ -46 │ -0.12 │ +├────────────────────────┼─────────┼─────────┼───────┤ +│ WSJ Dollar Index │ 91.76 │ -0.21 │ -0.23 │ +├────────────────────────┼─────────┼─────────┼───────┤ +│ U.S. Dollar Index │ 98.78 │ -0.22 │ -0.22 │ +└────────────────────────┴─────────┴─────────┴───────┘ +``` +--- diff --git a/website/content/terminal/reference/economy/performance.md b/website/content/terminal/reference/economy/performance.md new file mode 100644 index 000000000000..c62105afdf04 --- /dev/null +++ b/website/content/terminal/reference/economy/performance.md @@ -0,0 +1,76 @@ +--- +title: performance +description: Documentation for the Performance function that helps to view group data, + including sectors, industries, and countries. It details usage, parameters, and + provides examples of Performance function use. +keywords: +- Performance function +- group data view +- sectors +- industries +- countries +- function usage +- parameters +- financial data +- finviz data +- data presentation +- data sorting +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +View group (sectors, industry or country) performance data. [Source: Finviz] + +### Usage + +```python +performance [-g {sector,industry,basic_materials,communication_services,consumer_cyclical,consumer_defensive,energy,financial,healthcare,industrials,real_Estate,technology,utilities,country,capitalization}] [-s {Name,Week,Month,3Month,6Month,1Year,YTD,Recom,AvgVolume,RelVolume,Change,Volume}] [-r] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| group | Data group (sector, industry or country) | sector | True | sector, industry, basic_materials, communication_services, consumer_cyclical, consumer_defensive, energy, financial, healthcare, industrials, real_Estate, technology, utilities, country, capitalization | +| sortby | Column to sort by | Name | True | Name, Week, Month, 3Month, 6Month, 1Year, YTD, Recom, AvgVolume, RelVolume, Change, Volume | +| reverse | Data is sorted in descending order by default. Reverse flag will sort it in an ascending way. Only works when raw data is displayed. | False | True | None | + + +--- + +## Examples + +```python +2022 Feb 15, 05:25 (🦋) /economy/ $ performance + Group Performance Data +┌────────────────────────┬───────┬───────┬────────┬────────┬───────┬───────┬───────┬────────────────┬───────────┬────────┬─────────────┐ +│ Name │ Week │ Month │ 3Month │ 6Month │ 1Year │ YTD │ Recom │ AvgVolume [1M] │ RelVolume │ Change │ Volume [1M] │ +├────────────────────────┼───────┼───────┼────────┼────────┼───────┼───────┼───────┼────────────────┼───────────┼────────┼─────────────┤ +│ Utilities │ -0.02 │ -0.04 │ -0.01 │ -0.03 │ 0.04 │ -0.07 │ 2.33 │ 148.49 │ 1.10 │ -0.01 │ 163.32 │ +├────────────────────────┼───────┼───────┼────────┼────────┼───────┼───────┼───────┼────────────────┼───────────┼────────┼─────────────┤ +│ Technology │ -0.02 │ -0.07 │ -0.13 │ -0.05 │ 0.01 │ -0.13 │ 1.98 │ 1590.00 │ 0.91 │ -0.00 │ 1440.00 │ +├────────────────────────┼───────┼───────┼────────┼────────┼───────┼───────┼───────┼────────────────┼───────────┼────────┼─────────────┤ +│ Real Estate │ -0.02 │ -0.08 │ -0.08 │ -0.04 │ 0.07 │ -0.12 │ 2.22 │ 331.13 │ 1.13 │ -0.01 │ 373.51 │ +├────────────────────────┼───────┼───────┼────────┼────────┼───────┼───────┼───────┼────────────────┼───────────┼────────┼─────────────┤ +│ Industrials │ -0.01 │ -0.07 │ -0.09 │ -0.06 │ 0.06 │ -0.08 │ 2.26 │ 627.31 │ 0.97 │ -0.00 │ 611.51 │ +├────────────────────────┼───────┼───────┼────────┼────────┼───────┼───────┼───────┼────────────────┼───────────┼────────┼─────────────┤ +│ Healthcare │ -0.02 │ -0.04 │ -0.10 │ -0.11 │ -0.05 │ -0.10 │ 2.05 │ 1600.00 │ 0.79 │ -0.01 │ 1260.00 │ +├────────────────────────┼───────┼───────┼────────┼────────┼───────┼───────┼───────┼────────────────┼───────────┼────────┼─────────────┤ +│ Financial │ -0.01 │ -0.03 │ -0.02 │ 0.01 │ 0.14 │ 0.01 │ 2.20 │ 969.06 │ 1.05 │ -0.01 │ 1020.00 │ +├────────────────────────┼───────┼───────┼────────┼────────┼───────┼───────┼───────┼────────────────┼───────────┼────────┼─────────────┤ +│ Energy │ -0.01 │ 0.07 │ 0.16 │ 0.34 │ 0.43 │ 0.20 │ 2.24 │ 675.13 │ 1.09 │ -0.02 │ 738.17 │ +├────────────────────────┼───────┼───────┼────────┼────────┼───────┼───────┼───────┼────────────────┼───────────┼────────┼─────────────┤ +│ Consumer Defensive │ -0.01 │ -0.03 │ -0.00 │ -0.01 │ 0.04 │ -0.03 │ 2.23 │ 443.50 │ 0.97 │ -0.00 │ 432.15 │ +├────────────────────────┼───────┼───────┼────────┼────────┼───────┼───────┼───────┼────────────────┼───────────┼────────┼─────────────┤ +│ Consumer Cyclical │ -0.00 │ -0.08 │ -0.15 │ -0.07 │ -0.12 │ -0.10 │ 2.05 │ 1250.00 │ 0.83 │ 0.00 │ 1040.00 │ +├────────────────────────┼───────┼───────┼────────┼────────┼───────┼───────┼───────┼────────────────┼───────────┼────────┼─────────────┤ +│ Communication Services │ -0.01 │ -0.07 │ -0.16 │ -0.14 │ -0.05 │ -0.10 │ 1.88 │ 731.80 │ 0.94 │ 0.00 │ 690.29 │ +├────────────────────────┼───────┼───────┼────────┼────────┼───────┼───────┼───────┼────────────────┼───────────┼────────┼─────────────┤ +│ Basic Materials │ 0.02 │ -0.03 │ -0.01 │ -0.03 │ 0.06 │ -0.02 │ 2.21 │ 461.26 │ 1.11 │ -0.01 │ 514.01 │ +└────────────────────────┴───────┴───────┴────────┴────────┴───────┴───────┴───────┴────────────────┴───────────┴────────┴─────────────┘ +``` +--- diff --git a/website/content/terminal/reference/economy/plot.md b/website/content/terminal/reference/economy/plot.md new file mode 100644 index 000000000000..02426af3e6b8 --- /dev/null +++ b/website/content/terminal/reference/economy/plot.md @@ -0,0 +1,44 @@ +--- +title: plot +description: Learn how to plot data on two y-axes using the plot command in our tools. + The command allows you to plot different time series in one graph with data from + the macro, fred, index, and treasury commands. Our guide also provides examples + of usage and parameters to customize your plots. +keywords: +- plot data +- two y-axes +- macro +- fred +- index +- treasury commands +- time series +- graph +- variables +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command can plot any data on two y-axes obtained from the macro, fred, index and treasury commands. To be able to use this data, just load the available series from the previous commands. For example 'macro -p GDP -c Germany Netherlands' will store the data for usage in this command. Therefore, it allows you to plot different time series in one graph. The example above could be plotted the following way: 'plot --y1 Germany_GDP --y2 Netherlands_GDP' or 'plot --y1 Germany_GDP Netherlands_GDP' + +### Usage + +```python +plot [--y1 YAXIS1] [--y2 YAXIS2] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| yaxis1 | Select the data you wish to plot on the first y-axis. You can select multiple variables here. | | True | None | +| yaxis2 | Select the data you wish to plot on the second y-axis. You can select multiple variables here. | | True | None | + +![Figure_1](https://user-images.githubusercontent.com/46355364/158633367-783d54eb-79ab-443f-af99-8a9ecadf5949.png) + +![Figure_2](https://user-images.githubusercontent.com/46355364/158633394-d948d909-d39b-4b05-9c5b-2e30b202cc32.png) + +--- diff --git a/website/versioned_docs/version-v3/terminal/reference/economy/qa/_category_.json b/website/content/terminal/reference/economy/qa/_category_.json similarity index 100% rename from website/versioned_docs/version-v3/terminal/reference/economy/qa/_category_.json rename to website/content/terminal/reference/economy/qa/_category_.json diff --git a/website/content/terminal/reference/economy/qa/acf.md b/website/content/terminal/reference/economy/qa/acf.md new file mode 100644 index 000000000000..15a244c43344 --- /dev/null +++ b/website/content/terminal/reference/economy/qa/acf.md @@ -0,0 +1,39 @@ +--- +title: acf +description: Documentation page about the ACF python function, an auto-correlation + and partial auto-correlation function for diff and diff diff stock data. It includes + code usage, parameters and a visual example. +keywords: +- auto-correlation +- partial auto-correlation +- acf +- stock data +- lags +- acf function +- diff +- diff diff +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Auto-Correlation and Partial Auto-Correlation Functions for diff and diff diff stock data + +### Usage + +```python +acf [-l LAGS] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| lags | maximum lags to display in plots | 15 | True | None | + +![acf](https://user-images.githubusercontent.com/46355364/154305242-176c3ba1-ebfc-43e7-a027-46251fb02463.png) + +--- diff --git a/website/content/terminal/reference/economy/qa/bw.md b/website/content/terminal/reference/economy/qa/bw.md new file mode 100644 index 000000000000..70ce81d87a9a --- /dev/null +++ b/website/content/terminal/reference/economy/qa/bw.md @@ -0,0 +1,37 @@ +--- +title: bw +description: Box and Whisker Plot (bw) page instructs users on the usage of bw in + Python, explains the parameters, and offers a view of a bw plot. Promotes understanding + of data visualization. +keywords: +- Box and Whisker plot +- bw +- plot +- data visualization +- parameters +- yearly plot +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Box and Whisker plot + +### Usage + +```python +bw [-y] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| year | Flag to show yearly bw plot | False | True | None | + +![bw](https://user-images.githubusercontent.com/46355364/154305545-0f99fe4b-07e1-4714-8762-da3569023578.png) + +--- diff --git a/website/content/terminal/reference/economy/qa/cdf.md b/website/content/terminal/reference/economy/qa/cdf.md new file mode 100644 index 000000000000..f34fbdcce583 --- /dev/null +++ b/website/content/terminal/reference/economy/qa/cdf.md @@ -0,0 +1,49 @@ +--- +title: cdf +description: This page provides documentation about the 'cdf' command in Python, which + is a cumulative distribution function without any parameters. Examples of usage + and export of dataframe data to csv, json, or xlsx file are given. +keywords: +- cdf +- cumulative distribution function +- parameterless command +- export dataframe +- csv +- json +- xlsx +- help +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Cumulative distribution function + +### Usage + +```python +cdf +``` + +--- + +## Parameters + +This command has no parameters + + + +--- + +## Examples + +```python +optional arguments: + --export {csv,json,xlsx} + Export dataframe data to csv,json,xlsx file (default: ) + -h, --help show this help message (default: False) +``` +![cdf](https://user-images.githubusercontent.com/46355364/154306055-cb3bb1ef-0e61-40c9-bf51-d095bed8dc1b.png) + +--- diff --git a/website/content/terminal/reference/economy/qa/cusum.md b/website/content/terminal/reference/economy/qa/cusum.md new file mode 100644 index 000000000000..90368693ee68 --- /dev/null +++ b/website/content/terminal/reference/economy/qa/cusum.md @@ -0,0 +1,37 @@ +--- +title: cusum +description: This page provides a detailed explanation on the usage, parameters and + functionality of the Cumulative Sum Algorithm (CUSUM) used for detecting abrupt + changes in data. +keywords: +- cusum +- cumulative sum algorithm +- data change detection +- threshold +- drift +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Cumulative sum algorithm (CUSUM) to detect abrupt changes in data + +### Usage + +```python +cusum [-t THRESHOLD] [-d DRIFT] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| threshold | threshold | 0.007999992370605469 | True | None | +| drift | drift | 0.0039999961853027345 | True | None | + +![cusum](https://user-images.githubusercontent.com/46355364/154306207-d68f53f4-2f9a-4c1a-8e0e-b83d49938759.png) + +--- diff --git a/website/content/terminal/reference/economy/qa/decompose.md b/website/content/terminal/reference/economy/qa/decompose.md new file mode 100644 index 000000000000..2cb7f3330a46 --- /dev/null +++ b/website/content/terminal/reference/economy/qa/decompose.md @@ -0,0 +1,50 @@ +--- +title: decompose +description: This product documentation page discusses the decompose function in time + series analysis. It explains additive and multiplicative time series and provides + specific usage examples and parameter details. +keywords: +- Decompose function +- Additive time series +- Multiplicative time series +- Time series analysis +- Stocks +- Parameter details +- Usage examples +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Decompose time series as: - Additive Time Series = Level + CyclicTrend + Residual + Seasonality - Multiplicative Time Series = Level * CyclicTrend * Residual * Seasonality + +### Usage + +```python +decompose [-m] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| multiplicative | decompose using multiplicative model instead of additive | False | True | None | + + +--- + +## Examples + +```python +2022 Feb 16, 11:06 (🦋) /stocks/qa/ $ decompose + +Time-Series Level is 2660.84 +Strength of Trend: 0.0000 +Strength of Seasonality: 0.0032 +``` +![decompose](https://user-images.githubusercontent.com/46355364/154306626-1c5ad11e-a2e9-4107-9aec-5cf18da5358e.png) + +--- diff --git a/website/content/terminal/reference/economy/qa/hist.md b/website/content/terminal/reference/economy/qa/hist.md new file mode 100644 index 000000000000..60a5aecf104f --- /dev/null +++ b/website/content/terminal/reference/economy/qa/hist.md @@ -0,0 +1,36 @@ +--- +title: hist +description: A detailed guide on using 'hist', a histogram with density and rug. This + page includes usage examples, parameters, and a demonstrative image. +keywords: +- Histogram +- Density +- Rug +- Hist guide +- n_bins parameter +- Usage examples +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Histogram with density and rug + +### Usage + +```python +hist [-b N_BINS] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| n_bins | | 15 | True | None | + +![hist](https://user-images.githubusercontent.com/46355364/154306947-aaba936a-ac07-40e2-a5a6-bf1fab460cd0.png) + +--- diff --git a/website/content/terminal/reference/economy/qa/kurtosis.md b/website/content/terminal/reference/economy/qa/kurtosis.md new file mode 100644 index 000000000000..4e4d3eb72901 --- /dev/null +++ b/website/content/terminal/reference/economy/qa/kurtosis.md @@ -0,0 +1,40 @@ +--- +title: kurtosis +description: This page offers comprehensive information on kurtosis - a measure of + the 'tailedness' of a probability distribution of a real-valued random variable. + Learn about its different measures and how to estimate it from a sample. Try it + out with our Python usage guide. +keywords: +- kurtosis +- probability distribution +- real-valued random variable +- shape of distribution +- theoretical distribution +- sample estimation +- python usage guide +- n_window parameter +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Kurtosis is a measure of the "tailedness" of the probability distribution of a real-valued random variable. Like skewness, kurtosis describes the shape of a probability distribution and there are different ways of quantifying it for a theoretical distribution and corresponding ways of estimating it from a sample from a population. Different measures of kurtosis may have different interpretations. + +### Usage + +```python +kurtosis [-w N_WINDOW] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| n_window | window length | 14 | True | None | + +![kurtosis](https://user-images.githubusercontent.com/46355364/154307174-68671146-9551-4c2f-a179-db1d4b20b992.png) + +--- diff --git a/website/content/terminal/reference/economy/qa/line.md b/website/content/terminal/reference/economy/qa/line.md new file mode 100644 index 000000000000..3b2590933576 --- /dev/null +++ b/website/content/terminal/reference/economy/qa/line.md @@ -0,0 +1,39 @@ +--- +title: line +description: The page provides a detailed overview on how to use the 'line' function + in Python to visualize data on a line plot. It provides parameters for customizing + the plot such as scale, markers and highlighting specific events. +keywords: +- line plot +- data visualization +- log scale +- line markers +- scatter markers +- highlight events +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Show line plot of selected data or highlight specific datetimes. + +### Usage + +```python +line [--log] [--ml ML] [--ms MS] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| log | Plot with y on log scale | False | True | None | +| ml | Draw vertical line markers to highlight certain events | | True | None | +| ms | Draw scatter markers to highlight certain events | | True | None | + +![line](https://user-images.githubusercontent.com/46355364/154307397-9c2e9325-bce6-494d-994f-a6d7db798798.png) + +--- diff --git a/website/content/terminal/reference/economy/qa/load.md b/website/content/terminal/reference/economy/qa/load.md new file mode 100644 index 000000000000..2ce6f5804135 --- /dev/null +++ b/website/content/terminal/reference/economy/qa/load.md @@ -0,0 +1,50 @@ +--- +title: load +description: This page provides a guide on how to load a stock ticker for analysis. + It explains the parameters for loading data, including options for Indian tickers, + intraday stock minutes, and custom file paths. Additionally, users can find information + on how to load monthly and weekly data. +keywords: +- load +- stock ticker +- analysis +- syf +- Indian ticker +- exchanges data providers +- Yahoo finance +- starting date +- ending date +- intraday stock minutes +- pre/after market hours +- custom file path +- monthly data +- weekly data +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Load stock ticker to perform analysis on. When the data source is syf', an Indian ticker can be loaded by using '.NS' at the end, e.g. 'SBIN.NS'. See available market in https://help.yahoo.com/kb/exchanges-data-providers-yahoo-finance-sln2310.html. + +### Usage + +```python +load -t TICKER [-s START] [-e END] [-i {1,5,15,30,60}] [-p] [-f FILEPATH] [-m] [-w] [-r {ytd,1y,2y,5y,6m}] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| ticker | Stock ticker | None | False | None | +| start | The starting date (format YYYY-MM-DD) of the stock | 2019-11-21 | True | None | +| end | The ending date (format YYYY-MM-DD) of the stock | 2022-11-25 | True | None | +| interval | Intraday stock minutes | 1440 | True | 1, 5, 15, 30, 60 | +| prepost | Pre/After market hours. Only works for 'yf' source, and intraday data | False | True | None | +| filepath | Path to load custom file. | None | True | None | +| monthly | Load monthly data | False | True | None | +| weekly | Load weekly data | False | True | None | +--- diff --git a/website/content/terminal/reference/economy/qa/normality.md b/website/content/terminal/reference/economy/qa/normality.md new file mode 100644 index 000000000000..ee952d3c6a53 --- /dev/null +++ b/website/content/terminal/reference/economy/qa/normality.md @@ -0,0 +1,59 @@ +--- +title: normality +description: This page on the marketing website provides details on the 'normality' + function including its usage, parameters, and examples. It is particularly centered + around running normality tests in Python. +keywords: +- Normality command +- Normality Statistics +- Kurtosis +- Skewness +- Jarque-Bera +- Shapiro-Wilk +- Kolmogorov-Smirnov +- parameters +- examples +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Normality tests + +### Usage + +```python +normality +``` + +--- + +## Parameters + +This command has no parameters + + + +--- + +## Examples + +```python +2022 Feb 16, 11:11 (🦋) /stocks/qa/ $ normality + Normality Statistics +┏━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━┳━━━━━━━━━┓ +┃ ┃ Statistic ┃ p-value ┃ +┡━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━╇━━━━━━━━━┩ +│ Kurtosis │ 10.2422 │ 0.0000 │ +├────────────────────┼───────────┼─────────┤ +│ Skewness │ -0.2238 │ 0.8229 │ +├────────────────────┼───────────┼─────────┤ +│ Jarque-Bera │ 1155.1958 │ 0.0000 │ +├────────────────────┼───────────┼─────────┤ +│ Shapiro-Wilk │ 0.9265 │ 0.0000 │ +├────────────────────┼───────────┼─────────┤ +│ Kolmogorov-Smirnov │ 0.4680 │ 0.0000 │ +└────────────────────┴───────────┴─────────┘ +``` +--- diff --git a/website/content/terminal/reference/economy/qa/pick.md b/website/content/terminal/reference/economy/qa/pick.md new file mode 100644 index 000000000000..ac8e1358d3c6 --- /dev/null +++ b/website/content/terminal/reference/economy/qa/pick.md @@ -0,0 +1,58 @@ +--- +title: pick +description: This page explains the usage of the load command for loading a FRED series + to the current selection. This is useful for analyzing stock market data with various + parameters such as Open, High, Low, Close, Adj Close, Volume, etc. +keywords: +- FRED series +- load command +- Stocks analysis +- TSLA +- Python commands +- Stock market +- Market data +- Open, High, Low, Close +- Adj Close, Volume +- date_id, OC_High, OC_Low +- Returns, LogRet +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Load a FRED series to current selection + +### Usage + +```python +load [-c {Open,High,Low,Close,Adj Close,Volume,date_id,OC_High,OC_Low,Returns,LogRet}] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| column | Which loaded source to get data from | None | True | Open, High, Low, Close, Adj Close, Volume, date_id, OC_High, OC_Low, Returns, LogRet | + + +--- + +## Examples + +```python +2022 Feb 16, 11:12 (🦋) /stocks/qa/ $ load tsla + +Loading Daily TSLA stock with starting period 2019-02-11 for analysis. + +Datetime: 2022 Feb 16 11:12 +Timezone: America/New_York +Currency: USD +Market: CLOSED + + +2022 Feb 16, 11:12 (🦋) /stocks/qa/ $ pick adjclose +``` +--- diff --git a/website/content/terminal/reference/economy/qa/qqplot.md b/website/content/terminal/reference/economy/qa/qqplot.md new file mode 100644 index 000000000000..f1c0710a1065 --- /dev/null +++ b/website/content/terminal/reference/economy/qa/qqplot.md @@ -0,0 +1,34 @@ +--- +title: qqplot +description: The qqplot page focuses on providing information on how to display a + QQ plot vs normal quantiles using Python. The command has no parameters and includes + a practical example. +keywords: +- qqplot +- normal quantiles +- data visualization +- no parameters +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Display QQ plot vs normal quantiles + +### Usage + +```python +qqplot +``` + +--- + +## Parameters + +This command has no parameters + + +![qqplot](https://user-images.githubusercontent.com/46355364/154307858-acd1a7d0-bb40-4639-a69c-c316749a90ab.png) + +--- diff --git a/website/content/terminal/reference/economy/qa/quantile.md b/website/content/terminal/reference/economy/qa/quantile.md new file mode 100644 index 000000000000..0d2686034ed6 --- /dev/null +++ b/website/content/terminal/reference/economy/qa/quantile.md @@ -0,0 +1,39 @@ +--- +title: quantile +description: This documentation page provides detailed information on the concept + of quantile, a statistical term which refers to the values that divide a set of + observations into specified proportions. The page also includes parameters for customizing + the quantile function. +keywords: +- Quantile +- Distribution +- Median +- n_window +- f_quantile +- Parameters +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +The quantiles are values which divide the distribution such that there is a given proportion of observations below the quantile. For example, the median is a quantile. The median is the central value of the distribution, such that half the points are less than or equal to it and half are greater than or equal to it. By default, q is set at 0.5, which effectively is median. Change q to get the desired quantile (0q1). + +### Usage + +```python +quantile [-w N_WINDOW] [-q F_QUANTILE] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| n_window | window length | 14 | True | None | +| f_quantile | quantile | 0.5 | True | None | + +![quantile](https://user-images.githubusercontent.com/46355364/154307976-868e98e1-5a30-43c7-92fc-f221d09c5bd2.png) + +--- diff --git a/website/content/terminal/reference/economy/qa/raw.md b/website/content/terminal/reference/economy/qa/raw.md new file mode 100644 index 000000000000..53d20b983931 --- /dev/null +++ b/website/content/terminal/reference/economy/qa/raw.md @@ -0,0 +1,93 @@ +--- +title: raw +description: This documentation page explains the usage of the 'raw' command in Python + which prints raw data to console. It outlines parameters and usage, and provides + an example of output sorted by a specific column in either ascending or descending + order. +keywords: +- raw data +- console +- parameters +- usage +- limit +- reverse +- sortby +- ascending +- descending +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Print raw data to console + +### Usage + +```python +raw [-l LIMIT] [-r] [-s SORTBY] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| limit | Number to show | 20 | True | None | +| reverse | Data is sorted in descending order by default. Reverse flag will sort it in an ascending way. Only works when raw data is displayed. | False | True | None | +| sortby | The column to sort by | None | True | None | + + +--- + +## Examples + +```python +2022 Feb 16, 11:05 (🦋) /stocks/qa/ $ raw + Raw Data +┏━━━━━━━━━━━━┳━━━━━━━━━━┓ +┃ ┃ Adjclose ┃ +┡━━━━━━━━━━━━╇━━━━━━━━━━┩ +│ 2022-01-19 │ 995.650 │ +├────────────┼──────────┤ +│ 2022-01-20 │ 996.270 │ +├────────────┼──────────┤ +│ 2022-01-21 │ 943.900 │ +├────────────┼──────────┤ +│ 2022-01-24 │ 930.000 │ +├────────────┼──────────┤ +│ 2022-01-25 │ 918.400 │ +├────────────┼──────────┤ +│ 2022-01-26 │ 937.410 │ +├────────────┼──────────┤ +│ 2022-01-27 │ 829.100 │ +├────────────┼──────────┤ +│ 2022-01-28 │ 846.350 │ +├────────────┼──────────┤ +│ 2022-01-31 │ 936.720 │ +├────────────┼──────────┤ +│ 2022-02-01 │ 931.250 │ +├────────────┼──────────┤ +│ 2022-02-02 │ 905.660 │ +├────────────┼──────────┤ +│ 2022-02-03 │ 891.140 │ +├────────────┼──────────┤ +│ 2022-02-04 │ 923.320 │ +├────────────┼──────────┤ +│ 2022-02-07 │ 907.340 │ +├────────────┼──────────┤ +│ 2022-02-08 │ 922.000 │ +├────────────┼──────────┤ +│ 2022-02-09 │ 932.000 │ +├────────────┼──────────┤ +│ 2022-02-10 │ 904.550 │ +├────────────┼──────────┤ +│ 2022-02-11 │ 860.000 │ +├────────────┼──────────┤ +│ 2022-02-14 │ 875.760 │ +├────────────┼──────────┤ +│ 2022-02-15 │ 922.430 │ +└────────────┴──────────┘ +``` +--- diff --git a/website/content/terminal/reference/economy/qa/rolling.md b/website/content/terminal/reference/economy/qa/rolling.md new file mode 100644 index 000000000000..c4cf4156b69f --- /dev/null +++ b/website/content/terminal/reference/economy/qa/rolling.md @@ -0,0 +1,39 @@ +--- +title: rolling +description: The page provides details on the 'rolling' function, focusing on usage + with Python, its parameters, especially 'n_window' for window length, and its role + in calculating rolling mean and standard deviation. +keywords: +- rolling +- mean +- std deviation +- usage +- parameters +- n_window +- window length +- coding +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Rolling mean and std deviation + +### Usage + +```python +rolling [-w N_WINDOW] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| n_window | Window length | 14 | True | None | + +![rolling](https://user-images.githubusercontent.com/46355364/154308175-bb244d55-a6e0-4d6e-80f4-b3937dcd8ed4.png) + +--- diff --git a/website/content/terminal/reference/economy/qa/skew.md b/website/content/terminal/reference/economy/qa/skew.md new file mode 100644 index 000000000000..2d4170e38e44 --- /dev/null +++ b/website/content/terminal/reference/economy/qa/skew.md @@ -0,0 +1,39 @@ +--- +title: skew +description: The documentation page of the 'skew' attribute, which is a measure of + the asymmetry or distortion of a symmetric distribution. It provides explanation + of the concept, its usage in Python and parameters details. +keywords: +- skew +- asymmetry +- symmetric distribution +- normal distribution +- distortion +- deviation +- random variable +- parameters +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Skewness is a measure of asymmetry or distortion of symmetric distribution. It measures the deviation of the given distribution of a random variable from a symmetric distribution, such as normal distribution. A normal distribution is without any skewness, as it is symmetrical on both sides. Hence, a curve is regarded as skewed if it is shifted towards the right or the left. + +### Usage + +```python +skew [-w N_WINDOW] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| n_window | window length | 14 | True | None | + +![skew](https://user-images.githubusercontent.com/46355364/154308298-7528be2a-05f5-44b8-a479-d4716b2a6c6e.png) + +--- diff --git a/website/content/terminal/reference/economy/qa/spread.md b/website/content/terminal/reference/economy/qa/spread.md new file mode 100644 index 000000000000..4177618dff23 --- /dev/null +++ b/website/content/terminal/reference/economy/qa/spread.md @@ -0,0 +1,38 @@ +--- +title: spread +description: This page provides a detailed guide on the use of the 'spread' function + in Python, which shows rolling spread measurement. Furthermore, it also presents + the parameters involved, their descriptions, and potential default values. +keywords: +- spread +- rolling spread measurement +- parameters +- usage +- window length +- n_window +- optional +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Shows rolling spread measurement + +### Usage + +```python +spread [-w N_WINDOW] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| n_window | Window length | 14 | True | None | + +![spread](https://user-images.githubusercontent.com/46355364/154308406-f20812a4-fa04-4937-b8de-dc27042f7462.png) + +--- diff --git a/website/content/terminal/reference/economy/qa/summary.md b/website/content/terminal/reference/economy/qa/summary.md new file mode 100644 index 000000000000..2f0e96f4cac1 --- /dev/null +++ b/website/content/terminal/reference/economy/qa/summary.md @@ -0,0 +1,69 @@ +--- +title: summary +description: This page pertains to the summary statistics command used in Python for + data analysis. The command provides a comprehensive summary of various statistical + parameters for a given dataset, offering insight into data distribution and patterns. +keywords: +- summary statistics +- data analysis +- statistics +- data summary +- data distribution +- data interpretation +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Summary statistics + +### Usage + +```python +summary +``` + +--- + +## Parameters + +This command has no parameters + + + +--- + +## Examples + +```python +2022 Feb 16, 11:16 (🦋) /stocks/qa/ $ summary + + Summary Statistics +┏━━━━━━━┳━━━━━━━━━━┳━━━━━━━━━━┳━━━━━━━━━━┳━━━━━━━━━━┳━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━┳━━━━━━━━━┳━━━━━━━━━━┓ +┃ ┃ open ┃ high ┃ low ┃ close ┃ adjclose ┃ volume ┃ returns ┃ logret ┃ logprice ┃ +┡━━━━━━━╇━━━━━━━━━━╇━━━━━━━━━━╇━━━━━━━━━━╇━━━━━━━━━━╇━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━╇━━━━━━━━━╇━━━━━━━━━━┩ +│ count │ 760.000 │ 760.000 │ 760.000 │ 760.000 │ 760.000 │ 760.000 │ 760.000 │ 760.000 │ 760.000 │ +├───────┼──────────┼──────────┼──────────┼──────────┼──────────┼─────────────────────┼─────────┼─────────┼──────────┤ +│ mean │ 203.131 │ 205.470 │ 200.350 │ 202.963 │ 202.963 │ 18581311.316 │ -0.000 │ -0.000 │ 5.288 │ +├───────┼──────────┼──────────┼──────────┼──────────┼──────────┼─────────────────────┼─────────┼─────────┼──────────┤ +│ std │ 44.546 │ 44.825 │ 44.020 │ 44.497 │ 44.497 │ 10992756.504 │ 0.025 │ 0.025 │ 0.224 │ +├───────┼──────────┼──────────┼──────────┼──────────┼──────────┼─────────────────────┼─────────┼─────────┼──────────┤ +│ min │ 112.630 │ 114.200 │ 108.700 │ 111.790 │ 111.790 │ 5523000.000 │ -0.133 │ -0.143 │ 4.717 │ +├───────┼──────────┼──────────┼──────────┼──────────┼──────────┼─────────────────────┼─────────┼─────────┼──────────┤ +│ 10% │ 152.144 │ 153.973 │ 150.186 │ 151.635 │ 151.635 │ 9561170.000 │ -0.030 │ -0.030 │ 5.021 │ +├───────┼──────────┼──────────┼──────────┼──────────┼──────────┼─────────────────────┼─────────┼─────────┼──────────┤ +│ 25% │ 171.659 │ 174.392 │ 169.912 │ 171.858 │ 171.858 │ 12144500.000 │ -0.012 │ -0.013 │ 5.147 │ +├───────┼──────────┼──────────┼──────────┼──────────┼──────────┼─────────────────────┼─────────┼─────────┼──────────┤ +│ 50% │ 199.905 │ 202.325 │ 197.335 │ 200.000 │ 200.000 │ 15985100.000 │ 0.000 │ 0.000 │ 5.298 │ +├───────┼──────────┼──────────┼──────────┼──────────┼──────────┼─────────────────────┼─────────┼─────────┼──────────┤ +│ 75% │ 229.373 │ 231.640 │ 226.552 │ 229.478 │ 229.478 │ 21443775.000 │ 0.014 │ 0.014 │ 5.436 │ +├───────┼──────────┼──────────┼──────────┼──────────┼──────────┼─────────────────────┼─────────┼─────────┼──────────┤ +│ 90% │ 265.203 │ 268.028 │ 262.522 │ 265.506 │ 265.506 │ 28987730.000 │ 0.029 │ 0.029 │ 5.582 │ +├───────┼──────────┼──────────┼──────────┼──────────┼──────────┼─────────────────────┼─────────┼─────────┼──────────┤ +│ max │ 313.500 │ 319.320 │ 308.910 │ 317.140 │ 317.140 │ 141830000.000 │ 0.104 │ 0.099 │ 5.759 │ +├───────┼──────────┼──────────┼──────────┼──────────┼──────────┼─────────────────────┼─────────┼─────────┼──────────┤ +│ var │ 1984.325 │ 2009.289 │ 1937.717 │ 1979.969 │ 1979.969 │ 120840695549911.328 │ 0.001 │ 0.001 │ 0.050 │ +└───────┴──────────┴──────────┴──────────┴──────────┴──────────┴─────────────────────┴─────────┴─────────┴──────────┘ +``` +--- diff --git a/website/content/terminal/reference/economy/qa/unitroot.md b/website/content/terminal/reference/economy/qa/unitroot.md new file mode 100644 index 000000000000..11edfeabdca3 --- /dev/null +++ b/website/content/terminal/reference/economy/qa/unitroot.md @@ -0,0 +1,65 @@ +--- +title: unitroot +description: Understand the usage, implementation parameters and examples of the unitroot + function which is used to perform unit root test, stationarity tests like ADF and + KPSS. Learn about regression types and the calculation of values like Test Statistic, + P-Value, NLags, Nobs and ICBest. +keywords: +- unitroot +- stationarity tests +- ADF tests +- KPSS tests +- regression types +- unitroot parameters +- unitroot examples +- p-value +- n-lags +- n-obs +- icbest +- python commands +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Unit root test / stationarity (ADF, KPSS) + +### Usage + +```python +unitroot [-r {c,ct,ctt,nc}] [-k {c,ct}] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| fuller_reg | Type of regression. Can be ‘c’,’ct’,’ctt’,’nc’ 'c' - Constant and t - trend order | c | True | c, ct, ctt, nc | +| kpss_reg | Type of regression. Can be ‘c’,’ct' | c | True | c, ct | + + +--- + +## Examples + +```python +2022 Feb 16, 11:16 (🦋) /stocks/qa/ $ unitroot + Unit Root Calculation +┏━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━┳━━━━━━━━┓ +┃ ┃ ADF ┃ KPSS ┃ +┡━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━╇━━━━━━━━┩ +│ Test Statistic │ -28.9536 │ 0.2928 │ +├────────────────┼────────────┼────────┤ +│ P-Value │ 0.0000 │ 0.1000 │ +├────────────────┼────────────┼────────┤ +│ NLags │ 0.0000 │ 3 │ +├────────────────┼────────────┼────────┤ +│ Nobs │ 759.0000 │ │ +├────────────────┼────────────┼────────┤ +│ ICBest │ -3339.2013 │ │ +└────────────────┴────────────┴────────┘ +``` +--- diff --git a/website/content/terminal/reference/economy/spectrum.md b/website/content/terminal/reference/economy/spectrum.md new file mode 100644 index 000000000000..0e2a591d14fd --- /dev/null +++ b/website/content/terminal/reference/economy/spectrum.md @@ -0,0 +1,48 @@ +--- +title: spectrum +description: Learn how to view group spectrum data in various sectors, industries + or countries. Understand usage and parameters involved. +keywords: +- Spectrum data +- Sectors +- Industries +- Countries +- Data analysis +- Financial analysis +- Consumer cyclical +- Consumer defensive +- Energy sector +- Healthcare sector +- Industrials sector +- Real Estate sector +- Technology sector +- Utilities sector +- Data groups +- Capitalization +- Finviz +- Basic materials sector +- Communication services sector +- Programming +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +View group (sectors, industry or country) spectrum data. [Source: Finviz] + +### Usage + +```python +spectrum [-g {sector,industry,basic_materials,communication_services,consumer_cyclical,consumer_defensive,energy,financial,healthcare,industrials,real_Estate,technology,utilities,country,capitalization}] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| group | Data group (sector, industry or country) | sector | True | sector, industry, basic_materials, communication_services, consumer_cyclical, consumer_defensive, energy, financial, healthcare, industrials, real_Estate, technology, utilities, country, capitalization | + +--- diff --git a/website/content/terminal/reference/economy/spread.md b/website/content/terminal/reference/economy/spread.md new file mode 100644 index 000000000000..f076419b351e --- /dev/null +++ b/website/content/terminal/reference/economy/spread.md @@ -0,0 +1,43 @@ +--- +title: spread +description: 'Documentation page for ''spread'' software: a tool designed to generate + bond spread matrix. This tool is parametrizable, allowing users to customize its + outputs.' +keywords: +- spread software +- bond spread matrix +- financial tools +- bond spread matrix generator +- bond spread +- financial software +- customizable finance tool +- bond rates +- finance heatmap +- financial data visualization +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Generate bond spread matrix. + +### Usage + +```python +spread [-g {G7,PIIGS,EZ,AMERICAS,EUROPE,ME,APAC,AFRICA}] [-c COUNTRIES] [-m MATURITY] [--change CHANGE] [--color {rgb,binary,openbb}] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| group | Show bond spread matrix for group of countries. | G7 | True | G7, PIIGS, EZ, AMERICAS, EUROPE, ME, APAC, AFRICA | +| countries | Show bond spread matrix for explicit list of countries. | None | True | None | +| maturity | Specify maturity to compare rates. | 10Y | True | None | +| change | Get matrix of 1 day change in rates or spreads. | False | True | None | +| color | Set color palette on heatmap. | openbb | True | rgb, binary, openbb | + +--- diff --git a/website/content/terminal/reference/economy/treasury.md b/website/content/terminal/reference/economy/treasury.md new file mode 100644 index 000000000000..51e5003a5e9b --- /dev/null +++ b/website/content/terminal/reference/economy/treasury.md @@ -0,0 +1,69 @@ +--- +title: treasury +description: This page provides detailed information and instructions on how to obtain + and plot any set of U.S. treasuries through different parameters including maturity, + frequency and type. It provides flexibility with regards to date ranges. +keywords: +- U.S. treasuries +- maturity +- frequency +- plot +- date range +- parameters +- instructions +- EconDB +- FED +- inflation-adjusted +- secondary markets +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Obtain any set of U.S. treasuries and plot them together. These can be a range of maturities for nominal, inflation-adjusted (on long term average of inflation adjusted) and secondary markets over a lengthy period. Note: 3-month and 10-year treasury yields for other countries are available via the command 'macro' and parameter 'M3YD' and 'Y10YD'. [Source: EconDB / FED] + +### Usage + +```python +treasury [-m MATURITY] [--show] [--freq {annually,monthly,weekly,daily}] [-t TYPE] [-s START_DATE] [-e END_DATE] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| maturity | The preferred maturity which is dependent on the type of the treasury | 10y | True | None | +| show_maturities | Show the maturities available for every instrument. | False | True | None | +| frequency | The frequency, this can be annually, monthly, weekly or daily | monthly | True | annually, monthly, weekly, daily | +| type | Choose from: nominal, inflation, average, secondary | nominal | True | None | +| start_date | The start date of the data (format: YEAR-MONTH-DAY, i.e. 2010-12-31) | 1934-01-31 | True | None | +| end_date | The end date of the data (format: YEAR-DAY-MONTH, i.e. 2021-06-02) | 2022-11-25 | True | None | + + +--- + +## Examples + +```python +2022 Mar 15, 07:33 (🦋) /economy/ $ treasury -sm + Maturity options per instrument +┏━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Instrument ┃ Maturities ┃ +┡━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┩ +│ nominal │ 1m, 3m, 6m, 1y, 2y, 3y, 5y, 7y, 10y, 20y, 30y │ +├────────────┼───────────────────────────────────────────────┤ +│ inflation │ 5y, 7y, 10y, 20y, 30y │ +├────────────┼───────────────────────────────────────────────┤ +│ average │ Defined by function │ +├────────────┼───────────────────────────────────────────────┤ +│ secondary │ 4w, 3m, 6m, 1y │ +└────────────┴───────────────────────────────────────────────┘ +``` +![3y 5y 10y 30y nominal](https://user-images.githubusercontent.com/46355364/158575884-8ec4e1dc-fb5b-4440-be4b-5e1dcd6d2a5e.png) + +![5y nominal inflation average](https://user-images.githubusercontent.com/46355364/158575921-ff7c387c-8eb6-4716-80c4-f4c5121633f2.png) + +--- diff --git a/website/content/terminal/reference/economy/valuation.md b/website/content/terminal/reference/economy/valuation.md new file mode 100644 index 000000000000..de8da707f088 --- /dev/null +++ b/website/content/terminal/reference/economy/valuation.md @@ -0,0 +1,85 @@ +--- +title: valuation +description: Learn how to view and understand group valuation data for different sectors, + industries, or countries using various parameters. Find the exact metrics you need + regarding Market Cap, P/E, P/S, P/B and more. +keywords: +- valuation +- sectors +- industry +- country +- data group +- sortby +- reverse +- MarketCap +- P/E +- FwdP/E +- PEG +- P/S +- P/B +- P/C +- P/FCF +- EPSpast5Y +- EPSnext5Y +- Salespast5Y +- Change +- Volume +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +View group (sectors, industry or country) valuation data. [Source: Finviz] + +### Usage + +```python +valuation [-g {sector,industry,basic_materials,communication_services,consumer_cyclical,consumer_defensive,energy,financial,healthcare,industrials,real_Estate,technology,utilities,country,capitalization}] [-s {Name,MarketCap,P/E,FwdP/E,PEG,P/S,P/B,P/C,P/FCF,EPSpast5Y,EPSnext5Y,Salespast5Y,Change,Volume}] [-r] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| group | Data group (sectors, industry or country) | sector | True | sector, industry, basic_materials, communication_services, consumer_cyclical, consumer_defensive, energy, financial, healthcare, industrials, real_Estate, technology, utilities, country, capitalization | +| sortby | Column to sort by | Name | True | Name, MarketCap, P/E, FwdP/E, PEG, P/S, P/B, P/C, P/FCF, EPSpast5Y, EPSnext5Y, Salespast5Y, Change, Volume | +| reverse | Data is sorted in descending order by default. Reverse flag will sort it in an ascending way. Only works when raw data is displayed. | False | True | None | + + +--- + +## Examples + +```python +2022 Feb 15, 05:44 (🦋) /economy/ $ valuation + Group Valuation Data +┌────────────────────────┬───────────┬───────┬────────┬──────┬──────┬──────┬───────┬───────┬───────────┬───────────┬─────────────┬────────┬─────────────┐ +│ Name │ MarketCap │ P/E │ FwdP/E │ PEG │ P/S │ P/B │ P/C │ P/FCF │ EPSpast5Y │ EPSnext5Y │ Salespast5Y │ Change │ Volume [1M] │ +├────────────────────────┼───────────┼───────┼────────┼──────┼──────┼──────┼───────┼───────┼───────────┼───────────┼─────────────┼────────┼─────────────┤ +│ Utilities │ 1358.78 │ 23.92 │ 3.08 │ 3.42 │ 1.89 │ 1.34 │ 27.21 │ 58.67 │ -0.01 │ 0.07 │ 0.02 │ -0.01 │ 163.32 │ +├────────────────────────┼───────────┼───────┼────────┼──────┼──────┼──────┼───────┼───────┼───────────┼───────────┼─────────────┼────────┼─────────────┤ +│ Technology │ 14633.47 │ 30.64 │ 23.23 │ 1.70 │ 5.35 │ 4.49 │ 16.77 │ 37.99 │ 0.23 │ 0.18 │ 0.14 │ -0.00 │ 1440.00 │ +├────────────────────────┼───────────┼───────┼────────┼──────┼──────┼──────┼───────┼───────┼───────────┼───────────┼─────────────┼────────┼─────────────┤ +│ Real Estate │ 1750.54 │ 28.61 │ 32.15 │ 2.85 │ 5.67 │ 1.84 │ 21.76 │ 60.06 │ 0.07 │ 0.10 │ 0.09 │ -0.01 │ 373.51 │ +├────────────────────────┼───────────┼───────┼────────┼──────┼──────┼──────┼───────┼───────┼───────────┼───────────┼─────────────┼────────┼─────────────┤ +│ Industrials │ 4912.21 │ 23.16 │ 16.15 │ 1.62 │ 2.00 │ 4.09 │ 12.84 │ 32.04 │ 0.06 │ 0.14 │ 0.04 │ -0.00 │ 611.51 │ +├────────────────────────┼───────────┼───────┼────────┼──────┼──────┼──────┼───────┼───────┼───────────┼───────────┼─────────────┼────────┼─────────────┤ +│ Healthcare │ 7545.19 │ 23.89 │ 15.09 │ 2.04 │ 2.17 │ 3.58 │ 12.48 │ 32.62 │ 0.12 │ 0.12 │ 0.12 │ -0.01 │ 1260.00 │ +├────────────────────────┼───────────┼───────┼────────┼──────┼──────┼──────┼───────┼───────┼───────────┼───────────┼─────────────┼────────┼─────────────┤ +│ Financial │ 10421.24 │ 13.02 │ 13.90 │ 1.01 │ 2.95 │ 0.01 │ 0.59 │ 16.51 │ 0.08 │ 0.13 │ 0.07 │ -0.01 │ 1020.00 │ +├────────────────────────┼───────────┼───────┼────────┼──────┼──────┼──────┼───────┼───────┼───────────┼───────────┼─────────────┼────────┼─────────────┤ +│ Energy │ 3287.09 │ 13.48 │ 9.81 │ 1.18 │ 0.89 │ 1.26 │ 9.53 │ 18.20 │ -0.08 │ 0.11 │ 0.00 │ -0.02 │ 738.17 │ +├────────────────────────┼───────────┼───────┼────────┼──────┼──────┼──────┼───────┼───────┼───────────┼───────────┼─────────────┼────────┼─────────────┤ +│ Consumer Defensive │ 3764.29 │ 25.71 │ 22.11 │ 2.72 │ 1.41 │ 4.15 │ 19.93 │ 48.20 │ 0.07 │ 0.09 │ 0.04 │ -0.00 │ 432.15 │ +├────────────────────────┼───────────┼───────┼────────┼──────┼──────┼──────┼───────┼───────┼───────────┼───────────┼─────────────┼────────┼─────────────┤ +│ Consumer Cyclical │ 7765.73 │ 25.61 │ 15.36 │ 1.14 │ 1.16 │ 3.68 │ 10.47 │ 43.62 │ 0.25 │ 0.22 │ 0.19 │ 0.00 │ 1040.00 │ +├────────────────────────┼───────────┼───────┼────────┼──────┼──────┼──────┼───────┼───────┼───────────┼───────────┼─────────────┼────────┼─────────────┤ +│ Communication Services │ 7657.15 │ 21.10 │ 14.48 │ 1.01 │ 3.55 │ 3.49 │ 14.31 │ 32.95 │ 0.18 │ 0.21 │ 0.19 │ 0.00 │ 690.29 │ +├────────────────────────┼───────────┼───────┼────────┼──────┼──────┼──────┼───────┼───────┼───────────┼───────────┼─────────────┼────────┼─────────────┤ +│ Basic Materials │ 2168.52 │ 11.80 │ 11.73 │ 0.81 │ 1.63 │ 2.23 │ 12.24 │ 16.83 │ 0.26 │ 0.15 │ 0.08 │ -0.01 │ 514.01 │ +└────────────────────────┴───────────┴───────┴────────┴──────┴──────┴──────┴───────┴───────┴───────────┴───────────┴─────────────┴────────┴─────────────┘ +``` +--- diff --git a/website/content/terminal/reference/economy/ycrv.md b/website/content/terminal/reference/economy/ycrv.md new file mode 100644 index 000000000000..8d92fc7960ed --- /dev/null +++ b/website/content/terminal/reference/economy/ycrv.md @@ -0,0 +1,30 @@ +--- +title: ycrv +description: This documentation page explains how the user is able to use ycrv command to generate country yield curve, which shows the bond rates at different maturities. +keywords: +- bond rates +- yield curve +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Generate country yield curve. The yield curve shows the bond rates at different maturities. + +### Usage + +```python +ycrv [-c {argentina,australia,austria,bahrain,bangladesh,belgium,botswana,brazil,bulgaria,canada,chile,china,colombia,croatia,cyprus,czech republic,denmark,egypt,finland,france,germany,greece,hong kong,hungary,iceland,india,indonesia,ireland,israel,italy,japan,jordan,kenya,latvia,lithuania,luxembourg,malaysia,malta,mauritius,mexico,morocco,namibia,netherlands,new zealand,nigeria,norway,pakistan,peru,philippines,poland,portugal,qatar,romania,russia,saudi arabia,serbia,singapore,slovakia,slovenia,south africa,south korea,spain,sri lanka,sweden,switzerland,taiwan,thailand,turkey,uganda,ukraine,united kingdom,united states,venezuela,vietnam}] [-d DATE] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| country | Yield curve for a country. Ex: united_states | united_states | True | argentina, australia, austria, bahrain, bangladesh, belgium, botswana, brazil, bulgaria, canada, chile, china, colombia, croatia, cyprus, czech republic, denmark, egypt, finland, france, germany, greece, hong kong, hungary, iceland, india, indonesia, ireland, israel, italy, japan, jordan, kenya, latvia, lithuania, luxembourg, malaysia, malta, mauritius, mexico, morocco, namibia, netherlands, new zealand, nigeria, norway, pakistan, peru, philippines, poland, portugal, qatar, romania, russia, saudi arabia, serbia, singapore, slovakia, slovenia, south africa, south korea, spain, sri lanka, sweden, switzerland, taiwan, thailand, turkey, uganda, ukraine, united kingdom, united states, venezuela, vietnam | +| date | Date to get data from FRED. If not supplied, the most recent entry will be used. | None | True | None | + +--- diff --git a/website/versioned_docs/version-v3/terminal/reference/etf/_category_.json b/website/content/terminal/reference/etf/_category_.json similarity index 100% rename from website/versioned_docs/version-v3/terminal/reference/etf/_category_.json rename to website/content/terminal/reference/etf/_category_.json diff --git a/website/content/terminal/reference/etf/candle.md b/website/content/terminal/reference/etf/candle.md new file mode 100644 index 000000000000..3af60b3e0fe2 --- /dev/null +++ b/website/content/terminal/reference/etf/candle.md @@ -0,0 +1,45 @@ +--- +title: candle +description: This documentation is for the 'candle' function that shows historical + data for an ETF. It explains how to use the function with key parameters to sort + data, display raw information, setup moving average in days, etc. +keywords: +- candle function +- ETF historical data +- interactive plotly chart +- sort data +- display raw data +- moving average +- market trends +- high and low trends +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Shows historic data for an ETF + +### Usage + +```python +candle [-p] [--sort {adjclose,open,close,high,low,volume,returns,logret}] [-r] [--raw] [-n NUM] [-t] [--ma MOV_AVG] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| plotly | Flag to show interactive plotly chart. | True | True | None | +| sort | Choose a column to sort by | | True | adjclose, open, close, high, low, volume, returns, logret | +| reverse | Data is sorted in descending order by default. Reverse flag will sort it in an ascending way. Only works when raw data is displayed. | False | True | None | +| raw | Shows raw data instead of chart | False | True | None | +| num | Number to show if raw selected | 20 | True | None | +| trendlines | Flag to add high and low trends to candle. | False | True | None | +| mov_avg | Add moving average in number of days to plot and separate by a comma. Value for ma (moving average) keyword needs to be greater than 1. | | True | None | + +![candle](https://user-images.githubusercontent.com/46355364/154031063-090a4419-c3b1-4707-8f8e-b41c872a783a.png) + +--- diff --git a/website/content/terminal/reference/etf/compare.md b/website/content/terminal/reference/etf/compare.md new file mode 100644 index 000000000000..66aaf2a61c1d --- /dev/null +++ b/website/content/terminal/reference/etf/compare.md @@ -0,0 +1,74 @@ +--- +title: compare +description: A documentation page for the 'compare' function used in StockAnalysis. + The function allows users to compare selected ETF symbols to obtain various financial + and trading data. Parameters, usage, and examples are provided. +keywords: +- StockAnalysis +- ETF comparison +- Financial data +- Trading information +- Financial analysis tools +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Compare selected ETFs [Source: StockAnalysis] + +### Usage + +```python +compare -e NAMES +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| names | Symbols to compare | None | False | None | + + +--- + +## Examples + +```python +2022 Feb 15, 04:24 (🦋) /etf/ $ compare VOO,SPY + ETF Comparisons +┌────────────────┬────────────┬─────────────┐ +│ │ VOO │ SPY │ +├────────────────┼────────────┼─────────────┤ +│ Assets │ $283.52B │ $407.71B │ +├────────────────┼────────────┼─────────────┤ +│ NAV │ $413.03 │ $449.25 │ +├────────────────┼────────────┼─────────────┤ +│ Expense Ratio │ 0.03% │ 0.09% │ +├────────────────┼────────────┼─────────────┤ +│ PE Ratio │ 24.90 │ 22.23 │ +├────────────────┼────────────┼─────────────┤ +│ Shares Out │ 686.44M │ 907.53M │ +├────────────────┼────────────┼─────────────┤ +│ Dividend (ttm) │ $5.44 │ $5.72 │ +├────────────────┼────────────┼─────────────┤ +│ Dividend Yield │ 1.35% │ 1.30% │ +├────────────────┼────────────┼─────────────┤ +│ Volume │ 10,167,584 │ 123,006,262 │ +├────────────────┼────────────┼─────────────┤ +│ Open │ 404.43 │ 439.92 │ +├────────────────┼────────────┼─────────────┤ +│ Previous Close │ 404.94 │ 440.46 │ +├────────────────┼────────────┼─────────────┤ +│ 52-Week Low │ 341.92 │ 371.88 │ +├────────────────┼────────────┼─────────────┤ +│ 52-Week High │ 341.92 │ 371.88 │ +├────────────────┼────────────┼─────────────┤ +│ Beta │ 0.99 │ 0.99 │ +├────────────────┼────────────┼─────────────┤ +│ Holdings │ 510 │ 507 │ +└────────────────┴────────────┴─────────────┘ +``` +--- diff --git a/website/versioned_docs/version-v3/terminal/reference/etf/disc/_category_.json b/website/content/terminal/reference/etf/disc/_category_.json similarity index 100% rename from website/versioned_docs/version-v3/terminal/reference/etf/disc/_category_.json rename to website/content/terminal/reference/etf/disc/_category_.json diff --git a/website/content/terminal/reference/etf/disc/active.md b/website/content/terminal/reference/etf/disc/active.md new file mode 100644 index 000000000000..99f71de1a0c2 --- /dev/null +++ b/website/content/terminal/reference/etf/disc/active.md @@ -0,0 +1,69 @@ +--- +title: active +description: The active function provides an overview of most active ETFs/mutual funds + according to WSJ market data. The function details include price, volume, change, + and percent change. +keywords: +- etf +- active +- mutual funds +- market data +- wsj.com +- price +- volume +- change +- percent change +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Displays most active ETF/Mutual funds from wsj.com/market-data + +### Usage + +```python +active +``` + +--- + +## Parameters + +This command has no parameters + + + +--- + +## Examples + +```python +2022 Feb 15, 04:26 (🦋) /etf/disc/ $ active + ETF Movers +┌───────────────────────────────────────────────────┬────────┬───────┬───────┬────────┐ +│ │ Price │ Chg │ %Chg │ Vol │ +├───────────────────────────────────────────────────┼────────┼───────┼───────┼────────┤ +│ ProShares Ultra VIX Short-Term Futures ETF │ 16.93 │ 0.27 │ 1.62 │ 149.8M │ +├───────────────────────────────────────────────────┼────────┼───────┼───────┼────────┤ +│ SPDR S&P 500 ETF Trust │ 439.02 │ -1.44 │ -0.33 │ 123.0M │ +├───────────────────────────────────────────────────┼────────┼───────┼───────┼────────┤ +│ ProShares UltraPro Short QQQ │ 41.52 │ -0.10 │ -0.24 │ 110.2M │ +├───────────────────────────────────────────────────┼────────┼───────┼───────┼────────┤ +│ iPath Series B S&P 500 VIX Short-Term Futures ETN │ 23.31 │ 0.07 │ 0.30 │ 103.6M │ +├───────────────────────────────────────────────────┼────────┼───────┼───────┼────────┤ +│ ProShares UltraPro QQQ │ 53.43 │ 0.15 │ 0.28 │ 95.1M │ +├───────────────────────────────────────────────────┼────────┼───────┼───────┼────────┤ +│ Invesco QQQ Trust Series I │ 347.49 │ 0.43 │ 0.12 │ 80.3M │ +├───────────────────────────────────────────────────┼────────┼───────┼───────┼────────┤ +│ Financial Select Sector SPDR ETF │ 39.66 │ -0.45 │ -1.12 │ 71.5M │ +├───────────────────────────────────────────────────┼────────┼───────┼───────┼────────┤ +│ Direxion Daily Semiconductor Bear 3X Shares │ 4.73 │ 0.00 │ 0.00 │ 64.3M │ +├───────────────────────────────────────────────────┼────────┼───────┼───────┼────────┤ +│ iShares MSCI Emerging Markets ETF │ 48.38 │ -0.34 │ -0.70 │ 59.4M │ +├───────────────────────────────────────────────────┼────────┼───────┼───────┼────────┤ +│ ProShares UltraPro Short S&P 500 │ 15.27 │ 0.15 │ 0.99 │ 58.8M │ +└───────────────────────────────────────────────────┴────────┴───────┴───────┴────────┘ +``` +--- diff --git a/website/versioned_docs/version-v3/terminal/reference/etf/disc/decliners.md b/website/content/terminal/reference/etf/disc/decliners.md similarity index 91% rename from website/versioned_docs/version-v3/terminal/reference/etf/disc/decliners.md rename to website/content/terminal/reference/etf/disc/decliners.md index f30948774840..d3063c0c8812 100644 --- a/website/versioned_docs/version-v3/terminal/reference/etf/disc/decliners.md +++ b/website/content/terminal/reference/etf/disc/decliners.md @@ -1,9 +1,20 @@ --- title: decliners -description: OpenBB Terminal Function +description: The decliners documentation page provides information on how to use the + 'decliners' command to display the top ETF/Mutual fund decliners from wsj.com/market-data. + The command doesn't require any parameters and includes examples of usage. +keywords: +- ETF +- Mutual fund +- decliners +- wsj.com/market-data +- parameters +- examples --- -# decliners +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + Displays top ETF/Mutual fund decliners from wsj.com/market-data diff --git a/website/content/terminal/reference/etf/disc/gainers.md b/website/content/terminal/reference/etf/disc/gainers.md new file mode 100644 index 000000000000..b32cda6f4066 --- /dev/null +++ b/website/content/terminal/reference/etf/disc/gainers.md @@ -0,0 +1,70 @@ +--- +title: gainers +description: This documentation page is about the 'gainers' command, which displays + the top ETF/Mutual fund gainers from wsj.com/market-data. It includes no parameters + and examples of its use. +keywords: +- gainers command +- ETF gainers +- Mutual fund gainers +- wsj.com market data +- command usage +- ETF Movers +- Top gainers +- Price change +- Volume +- investment tool +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Displays top ETF/Mutual fund gainers from wsj.com/market-data + +### Usage + +```python +gainers +``` + +--- + +## Parameters + +This command has no parameters + + + +--- + +## Examples + +```python +2022 Feb 15, 04:25 (🦋) /etf/disc/ $ gainers + ETF Movers +┌─────────────────────────────────────────────────────────────┬───────┬──────┬──────┬────────┐ +│ │ Price │ Chg │ %Chg │ Vol │ +├─────────────────────────────────────────────────────────────┼───────┼──────┼──────┼────────┤ +│ MicroSectors U.S. Big Banks Index -3X Inverse Leveraged ETN │ 8.69 │ 0.69 │ 8.69 │ 97.8K │ +├─────────────────────────────────────────────────────────────┼───────┼──────┼──────┼────────┤ +│ ProShares Ultra Bloomberg Natural Gas │ 31.92 │ 2.54 │ 8.65 │ 4.1M │ +├─────────────────────────────────────────────────────────────┼───────┼──────┼──────┼────────┤ +│ MicroSectors U.S. Big Oil Index -3X Inverse Leveraged ETN │ 3.37 │ 0.23 │ 7.32 │ 6.1M │ +├─────────────────────────────────────────────────────────────┼───────┼──────┼──────┼────────┤ +│ MicroSectors Gold Miners 3X Leveraged ETN │ 11.51 │ 0.71 │ 6.57 │ 811.8K │ +├─────────────────────────────────────────────────────────────┼───────┼──────┼──────┼────────┤ +│ Direxion Daily S&P Oil & Gas Exp. & Prod. Bear 2X Shares │ 3.76 │ 0.19 │ 5.32 │ 13.9M │ +├─────────────────────────────────────────────────────────────┼───────┼──────┼──────┼────────┤ +│ Direxion Daily S&P Biotech Bear 3X Shares │ 39.64 │ 1.89 │ 5.01 │ 5.5M │ +├─────────────────────────────────────────────────────────────┼───────┼──────┼──────┼────────┤ +│ Direxion Daily Russia Bull 2X Shares │ 20.84 │ 0.95 │ 4.78 │ 277.8K │ +├─────────────────────────────────────────────────────────────┼───────┼──────┼──────┼────────┤ +│ Direxion Daily Energy Bear 2X Shares │ 6.98 │ 0.31 │ 4.65 │ 3.4M │ +├─────────────────────────────────────────────────────────────┼───────┼──────┼──────┼────────┤ +│ United States Natural Gas Fund L.P. │ 14.55 │ 0.60 │ 4.30 │ 7.8M │ +├─────────────────────────────────────────────────────────────┼───────┼──────┼──────┼────────┤ +│ ProShares UltraShort Oil & Gas │ 29.74 │ 1.17 │ 4.10 │ 122.5K │ +└─────────────────────────────────────────────────────────────┴───────┴──────┴──────┴────────┘ +``` +--- diff --git a/website/content/terminal/reference/etf/load.md b/website/content/terminal/reference/etf/load.md new file mode 100644 index 000000000000..e012922f1f85 --- /dev/null +++ b/website/content/terminal/reference/etf/load.md @@ -0,0 +1,80 @@ +--- +title: load +description: This page provides a guide on how to load an Exchange Traded Fund (ETF) + ticker to perform analysis. It includes the usage, parameters such as ticker, start + date, end date and limit of holdings. The page also includes examples of how to + use the load feature. +keywords: +- load +- ETF +- analysis +- parameters +- date +- holdings +- Yahoo Finance +- StockAnalysis +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Load ETF ticker to perform analysis on. + +### Usage + +```python +load -t TICKER [-s START] [-e END] [-l LIMIT] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| ticker | ETF ticker | None | False | None | +| start | The starting date (format YYYY-MM-DD) of the ETF | 2021-11-24 | True | None | +| end | The ending date (format YYYY-MM-DD) of the ETF | 2022-11-25 | True | None | +| limit | Limit of holdings to display | 5 | True | None | + + +--- + +## Examples + +```python +2022 Jun 21, 09:18 (🦋) /etf/ $ load voo +Top company holdings found: AAPL, MSFT, AMZN, GOOGL, TSLA + + +2022 Jun 21, 09:18 (🦋) /etf/ $ ? +╭─────────────────────────────────────────────────────────────────────────────────────────────────────── ETF ────────────────────────────────────────────────────────────────────────────────────────────────────────╮ +│ │ +│ ln lookup by name [FinanceDatabase / StockAnalysis] │ +│ ld lookup by description [FinanceDatabase] │ +│ load load ETF data [Yahoo Finance] │ +│ │ +│ Symbol: VOO │ +│ Major holdings: AAPL, MSFT, AMZN, GOOGL, TSLA │ +│ │ +│ ca comparison analysis, get similar, historical, correlation, financials │ +│ disc discover ETFs, gainers/decliners/active │ +│ scr screener ETFs, overview/performance, using preset filters │ +│ │ +│ overview get overview [StockAnalysis] │ +│ holdings top company holdings [StockAnalysis] │ +│ weights sector weights allocation [Yahoo Finance] │ +│ summary summary description of the ETF [Yahoo Finance] │ +│ news latest news of the company [News API] │ +│ candle view a candle chart for ETF │ +│ │ +│ pir create (multiple) passive investor excel report(s) [PassiveInvestor] │ +│ compare compare multiple different ETFs [StockAnalysis] │ +│ │ +│ ta technical analysis, ema, macd, rsi, adx, bbands, obv │ +│ pred prediction techniques, regression, arima, rnn, lstm │ +│ │ +╰─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────── OpenBB Terminal v1.3.0 (https://openbb.co) ─╯ +``` +--- diff --git a/website/content/terminal/reference/etf/news.md b/website/content/terminal/reference/etf/news.md new file mode 100644 index 000000000000..18cd1694d11e --- /dev/null +++ b/website/content/terminal/reference/etf/news.md @@ -0,0 +1,39 @@ +--- +title: news +description: The page provides information on how to print the latest news about ETF + using parameters such as limit, starting date, order of articles, and news sources. + This information is sourced from the News API. +keywords: +- ETF +- News API +- latest news +- articles +- bbc +- yahoo.com +- docusaurus +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Prints latest news about ETF, including date, title and web link. [Source: News API] + +### Usage + +```python +news [-l LIMIT] [-d N_START_DATE] [-o] [-s SOURCES] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| limit | Limit of latest news being printed. | 5 | True | None | +| n_start_date | The starting date (format YYYY-MM-DD) to search articles from | datetime.now() - timedelta(days=365) | True | None | +| n_oldest | Show oldest articles first | True | True | None | +| sources | Show news only from the sources specified (e.g bbc yahoo.com) | | True | None | + +--- diff --git a/website/content/terminal/reference/etf/overview.md b/website/content/terminal/reference/etf/overview.md new file mode 100644 index 000000000000..9846acc95d48 --- /dev/null +++ b/website/content/terminal/reference/etf/overview.md @@ -0,0 +1,85 @@ +--- +title: overview +description: The page provides a detailed overview of selected ETFs including information + on assets, NAV, expense ratio, PE ratio, outstanding shares, dividends, yield, trading + volume, opening and closing prices, 52-week highs and lows, beta coefficient and + the number of holdings. +keywords: +- ETF +- overview +- assets +- NAV +- Expense Ratio +- PE Ratio +- Shares Out +- dividend +- Dividend Yield +- Volume +- Open +- Previous Close +- 52-Week Low +- 52-Week High +- Beta +- Holdings +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Get overview data for selected etf + +### Usage + +```python +overview +``` + +--- + +## Parameters + +This command has no parameters + + + +--- + +## Examples + +```python +2022 Feb 15, 04:14 (🦋) /etf/ $ overview + ETF Overview Information +┌────────────────┬────────────┐ +│ │ VOO │ +├────────────────┼────────────┤ +│ Assets │ $283.52B │ +├────────────────┼────────────┤ +│ NAV │ $413.03 │ +├────────────────┼────────────┤ +│ Expense Ratio │ 0.03% │ +├────────────────┼────────────┤ +│ PE Ratio │ 24.90 │ +├────────────────┼────────────┤ +│ Shares Out │ 686.44M │ +├────────────────┼────────────┤ +│ Dividend (ttm) │ $5.44 │ +├────────────────┼────────────┤ +│ Dividend Yield │ 1.35% │ +├────────────────┼────────────┤ +│ Volume │ 10,167,584 │ +├────────────────┼────────────┤ +│ Open │ 404.43 │ +├────────────────┼────────────┤ +│ Previous Close │ 404.94 │ +├────────────────┼────────────┤ +│ 52-Week Low │ 341.92 │ +├────────────────┼────────────┤ +│ 52-Week High │ 341.92 │ +├────────────────┼────────────┤ +│ Beta │ 0.99 │ +├────────────────┼────────────┤ +│ Holdings │ 510 │ +└────────────────┴────────────┘ +``` +--- diff --git a/website/content/terminal/reference/etf/pir.md b/website/content/terminal/reference/etf/pir.md new file mode 100644 index 000000000000..0f0290f1e77e --- /dev/null +++ b/website/content/terminal/reference/etf/pir.md @@ -0,0 +1,40 @@ +--- +title: pir +description: Create comprehensive ETF excel reports using the passive investor ETF + tool 'pir'. This tool generates a detailed report containing significant metrics + about any ETFs obtained from Yahoo Finance. Modifiable parameters include the ETF + symbols, report filename, and save location. +keywords: +- passive investor ETF +- ETF excel report +- Yahoo Finance ETF metrics +- ETF report generation +- OpenBBUserData +- Python programming +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Create passive investor ETF excel report which contains most of the important metrics about an ETF obtained from Yahoo Finnace. You are able to input any ETF ticker you like within the command to create am extensive report + +### Usage + +```python +pir [-e NAMES] [--filename FILENAME] [--folder FOLDER] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| names | Symbols to create a report for (e.g. pir ARKW ARKQ QQQ VOO) | | True | None | +| filename | Filename of the excel ETF report | ETF_report_20221125_164801 | True | None | +| folder | Folder where the excel ETF report will be saved | /home/runner/OpenBBUserData/exports | True | None | + +![pir](https://raw.githubusercontent.com/JerBouma/ThePassiveInvestor/master/Images/outputExample.gif) + +--- diff --git a/website/versioned_docs/version-v3/terminal/reference/etf/screener/_category_.json b/website/content/terminal/reference/etf/screener/_category_.json similarity index 100% rename from website/versioned_docs/version-v3/terminal/reference/etf/screener/_category_.json rename to website/content/terminal/reference/etf/screener/_category_.json diff --git a/website/content/terminal/reference/etf/screener/sbc.md b/website/content/terminal/reference/etf/screener/sbc.md new file mode 100644 index 000000000000..c238d8eaf6bf --- /dev/null +++ b/website/content/terminal/reference/etf/screener/sbc.md @@ -0,0 +1,39 @@ +--- +title: sbc +description: This documentation page describes how to use the sbc or 'search by category' + feature on FinanceDatabase/StockAnalysis.com. It provides detailed information about + parameters for category and limit. It specifically caters to ETFs data lookup. +keywords: +- sbc +- search by category +- FinanceDatabase +- StockAnalysis.com +- usage +- parameters +- category +- limit +- ETFs +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Search by category [Source: FinanceDatabase/StockAnalysis.com] + +### Usage + +```python +sbc -c CATEGORY [CATEGORY ...] [-l LIMIT] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| category | Category to look for | None | False | None | +| limit | Limit of ETFs to display | 5 | True | None | + +--- diff --git a/website/content/terminal/reference/etf/screener/screen.md b/website/content/terminal/reference/etf/screener/screen.md new file mode 100644 index 000000000000..45dcf5bed187 --- /dev/null +++ b/website/content/terminal/reference/etf/screener/screen.md @@ -0,0 +1,41 @@ +--- +title: screen +description: Documentation for the ETF screen tool, a command-line Python application + that scrapes and sorts data from stockanalysis.com. The tool offers various sorting + options, including by assets, expense, and volume, among others. +keywords: +- ETF Screen +- Stock Analysis +- Data Scraping +- Github Repository +- CLI +- Parameters +- Sort +- Limit +- Reverse +- Financial Data +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Screens ETFS from a personal scraping github repository. Data scraped from stockanalysis.com + +### Usage + +```python +screen [-l LIMIT] [-s {Assets,NAV,Expense,PE,SharesOut,Div,DivYield,Volume,Open,PrevClose,YrLow,YrHigh,Beta,N_Hold}] [-r] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| limit | Limit of etfs to display | 10 | True | None | +| sortby | Sort by given column. Default: Assets | Assets | True | Assets, NAV, Expense, PE, SharesOut, Div, DivYield, Volume, Open, PrevClose, YrLow, YrHigh, Beta, N_Hold | +| reverse | Data is sorted in descending order by default. Reverse flag will sort it in an ascending way. Only works when raw data is displayed. | False | True | None | + +--- diff --git a/website/content/terminal/reference/etf/screener/set.md b/website/content/terminal/reference/etf/screener/set.md new file mode 100644 index 000000000000..934d0845f473 --- /dev/null +++ b/website/content/terminal/reference/etf/screener/set.md @@ -0,0 +1,34 @@ +--- +title: set +description: This page provides detailed information about the 'set' command used + in Python, its usage, parameters, and the role of 'etf_config.ini' as a preset filter. +keywords: +- set command +- preset +- etf_config.ini +- set usage +- set parameters +- filter presets +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Set preset. + +### Usage + +```python +set [-p {etf_config.ini}] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| preset | Filter presets | template | True | etf_config.ini | + +--- diff --git a/website/content/terminal/reference/etf/screener/view.md b/website/content/terminal/reference/etf/screener/view.md new file mode 100644 index 000000000000..a8b492e9c8ec --- /dev/null +++ b/website/content/terminal/reference/etf/screener/view.md @@ -0,0 +1,34 @@ +--- +title: view +description: The page provides information on viewing available presets, using the + view command and viewing specific custom presets. The specific custom preset example + is etf_config.ini. +keywords: +- View presets +- Usage of view +- View parameters +- Custom presets +- etf_config.ini +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +View available presets under presets folder. + +### Usage + +```python +view [-p {etf_config.ini}] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| preset | View specific custom preset | | True | etf_config.ini | + +--- diff --git a/website/content/terminal/reference/etf/search.md b/website/content/terminal/reference/etf/search.md new file mode 100644 index 000000000000..ff4cb99fc6ed --- /dev/null +++ b/website/content/terminal/reference/etf/search.md @@ -0,0 +1,37 @@ +--- +title: search +description: Learn how to search for ETFs by name using the FinanceDatabase or StockAnalysis.com. + Understand the usage, parameters, and how to incorporate them in Python. +keywords: +- ETF +- search +- FinanceDatabase +- StockAnalysis +- name +- description +- parameters +- usage +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Search ETF by name [Source: FinanceDatabase/StockAnalysis.com] + +### Usage + +```python +search -n NAME [NAME ...] [-d DESCRIPTION [DESCRIPTION ...]] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| name | Name to look for ETFs | | False | None | +| description | Name to look for ETFs | | True | None | + +--- diff --git a/website/content/terminal/reference/etf/summary.md b/website/content/terminal/reference/etf/summary.md new file mode 100644 index 000000000000..eff2b09e877e --- /dev/null +++ b/website/content/terminal/reference/etf/summary.md @@ -0,0 +1,34 @@ +--- +title: summary +description: This documentation page provides a summary of how to print an ETF description + with no additional parameters required. Ideal for quick referencing. +keywords: +- Documentation +- ETF Description +- Print ETF +- No Parameters +- Summary +- Quick Reference +- Python Code +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Print ETF description summary + +### Usage + +```python +summary +``` + +--- + +## Parameters + +This command has no parameters + + +--- diff --git a/website/versioned_docs/version-v3/terminal/reference/etf/ta/_category_.json b/website/content/terminal/reference/etf/ta/_category_.json similarity index 100% rename from website/versioned_docs/version-v3/terminal/reference/etf/ta/_category_.json rename to website/content/terminal/reference/etf/ta/_category_.json diff --git a/website/content/terminal/reference/etf/ta/ad.md b/website/content/terminal/reference/etf/ta/ad.md new file mode 100644 index 000000000000..d098a769c9b9 --- /dev/null +++ b/website/content/terminal/reference/etf/ta/ad.md @@ -0,0 +1,39 @@ +--- +title: ad +description: The Accumulation/Distribution Line page provides information about how + this technical analysis tool operates, based on the close location value, to predict + trends in stock price. It also covers how to interpret divergence in the indicator, + usage of the tool, and parameters for customization. +keywords: +- Accumulation/Distribution Line +- On Balance Volume +- close location value +- stock market indicator +- price movement +- technical analysis +- price trends +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +The Accumulation/Distribution Line is similar to the On Balance Volume (OBV), which sums the volume times +1/-1 based on whether the close is higher than the previous close. The Accumulation/Distribution indicator, however multiplies the volume by the close location value (CLV). The CLV is based on the movement of the issue within a single bar and can be +1, -1 or zero. The Accumulation/Distribution Line is interpreted by looking for a divergence in the direction of the indicator relative to price. If the Accumulation/Distribution Line is trending upward it indicates that the price may follow. Also, if the Accumulation/Distribution Line becomes flat while the price is still rising (or falling) then it signals an impending flattening of the price. + +### Usage + +```python +ad [--open] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| b_use_open | uses open value of stock | False | True | None | + +![ad](https://user-images.githubusercontent.com/46355364/154309283-9512c6c0-dda3-4348-9350-105238676479.png) + +--- diff --git a/website/content/terminal/reference/etf/ta/adosc.md b/website/content/terminal/reference/etf/ta/adosc.md new file mode 100644 index 000000000000..3bf8df3f91dc --- /dev/null +++ b/website/content/terminal/reference/etf/ta/adosc.md @@ -0,0 +1,46 @@ +--- +title: adosc +description: Explore the Accumulation/Distribution Oscillator page, also known as + the Chaikin Oscillator. This powerful momentum indicator analyzes the strength of + price moves and the underlying buying and selling pressure in a given period. Learn + how to use the indicator and understand its parameters like fast length and slow + length. +keywords: +- Accumulation/Distribution Oscillator +- Chaikin Oscillator +- momentum indicator +- price moves +- buying pressure +- selling pressure +- market turning points +- adosc +- stock value +- fast length +- slow length +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Accumulation/Distribution Oscillator, also known as the Chaikin Oscillator is essentially a momentum indicator, but of the Accumulation-Distribution line rather than merely price. It looks at both the strength of price moves and the underlying buying and selling pressure during a given time period. The oscillator reading above zero indicates net buying pressure, while one below zero registers net selling pressure. Divergence between the indicator and pure price moves are the most common signals from the indicator, and often flag market turning points. + +### Usage + +```python +adosc [--open] [--fast N_LENGTH_FAST] [--slow N_LENGTH_SLOW] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| b_use_open | uses open value of stock | False | True | None | +| n_length_fast | fast length | 3 | True | None | +| n_length_slow | slow length | 10 | True | None | + +![adosc](https://user-images.githubusercontent.com/46355364/154309482-31c027ab-e80f-4145-9c63-392a74cf69c7.png) + +--- diff --git a/website/content/terminal/reference/etf/ta/adx.md b/website/content/terminal/reference/etf/ta/adx.md new file mode 100644 index 000000000000..2d8f9b0ffacd --- /dev/null +++ b/website/content/terminal/reference/etf/ta/adx.md @@ -0,0 +1,46 @@ +--- +title: adx +description: The page provides detailed information about the ADX or Average Directional + Movement Index, a Welles Wilder style moving average of the Directional Movement + Index (DX). It features guidelines on its usage, elaboration of its parameters, + and aids readers in interpreting it for identifying strong and weak trends. +keywords: +- ADX +- Welles Wilder +- Directional Movement Index +- DX +- trend +- parameters +- n_length +- n_scalar +- n_drift +- n_length +- n_scalar +- n_drift +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +The ADX is a Welles Wilder style moving average of the Directional Movement Index (DX). The values range from 0 to 100, but rarely get above 60. To interpret the ADX, consider a high number to be a strong trend, and a low number, a weak trend. + +### Usage + +```python +adx [-l N_LENGTH] [-s N_SCALAR] [-d N_DRIFT] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| n_length | length | 14 | True | None | +| n_scalar | scalar | 100 | True | None | +| n_drift | drift | 1 | True | None | + +![adx](https://user-images.githubusercontent.com/46355364/154309667-c67f6078-822f-452d-9853-ffffa9172670.png) + +--- diff --git a/website/content/terminal/reference/etf/ta/aroon.md b/website/content/terminal/reference/etf/ta/aroon.md new file mode 100644 index 000000000000..67cc61ba8373 --- /dev/null +++ b/website/content/terminal/reference/etf/ta/aroon.md @@ -0,0 +1,39 @@ +--- +title: aroon +description: This page provides a comprehensive detail on 'Aroon' - an indicator that + shows when a new trend is dawning in the market. It explains how to interpret upward + and downward trends as well as crossovers. +keywords: +- aroon +- marketing +- trend +- indicator +- upward trend +- downward trend +- crossovers +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +The word aroon is Sanskrit for "dawn's early light." The Aroon indicator attempts to show when a new trend is dawning. The indicator consists of two lines (Up and Down) that measure how long it has been since the highest high/lowest low has occurred within an n period range. When the Aroon Up is staying between 70 and 100 then it indicates an upward trend. When the Aroon Down is staying between 70 and 100 then it indicates an downward trend. A strong upward trend is indicated when the Aroon Up is above 70 while the Aroon Down is below 30. Likewise, a strong downward trend is indicated when the Aroon Down is above 70 while the Aroon Up is below 30. Also look for crossovers. When the Aroon Down crosses above the Aroon Up, it indicates a weakening of the upward trend (and vice versa). + +### Usage + +```python +aroon [-l N_LENGTH] [-s N_SCALAR] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| n_length | length | 25 | True | None | +| n_scalar | scalar | 100 | True | None | + +![aroon](https://user-images.githubusercontent.com/46355364/154309825-f8ccc98b-31ac-43fc-a251-66f6f41545a5.png) + +--- diff --git a/website/content/terminal/reference/etf/ta/atr.md b/website/content/terminal/reference/etf/ta/atr.md new file mode 100644 index 000000000000..976d4c87b08b --- /dev/null +++ b/website/content/terminal/reference/etf/ta/atr.md @@ -0,0 +1,43 @@ +--- +title: atr +description: This page provides comprehensive information about the Average True Range + (ATR) including its usage, implementation, and parameters. It serves as a key resource + for understanding ATR, a widely used tool for measuring volatility in market prices. +keywords: +- average true range +- volatility measure +- ATR usage +- ATR parameters +- ema +- sma +- wma +- hma +- zlma +- n_length +- s_mamode +- n_offset +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Averge True Range is used to measure volatility, especially volatility caused by gaps or limit moves. + +### Usage + +```python +atr [-l N_LENGTH] [-m {ema,sma,wma,hma,zlma}] [-o N_OFFSET] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| n_length | Window length | 14 | True | None | +| s_mamode | mamode | ema | True | ema, sma, wma, hma, zlma | +| n_offset | offset | 0 | True | None | + +--- diff --git a/website/content/terminal/reference/etf/ta/bbands.md b/website/content/terminal/reference/etf/ta/bbands.md new file mode 100644 index 000000000000..50fc6a7407a6 --- /dev/null +++ b/website/content/terminal/reference/etf/ta/bbands.md @@ -0,0 +1,46 @@ +--- +title: bbands +description: Documentation for Bollinger Bands (bbands), an indicator of overbought + or oversold conditions in market prices. Includes details on how to use and interpret + bbands, as well as information on bbands' parameters (such as n_length, n_std, and + s_mamode). +keywords: +- Bollinger Bands +- overbought conditions +- oversold conditions +- volatility +- price target +- support level +- resistance level +- bbands +- n_length +- n_std +- s_mamode +- sma +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Bollinger Bands consist of three lines. The middle band is a simple moving average (generally 20 periods) of the typical price (TP). The upper and lower bands are F standard deviations (generally 2) above and below the middle band. The bands widen and narrow when the volatility of the price is higher or lower, respectively. Bollinger Bands do not, in themselves, generate buy or sell signals; they are an indicator of overbought or oversold conditions. When the price is near the upper or lower band it indicates that a reversal may be imminent. The middle band becomes a support or resistance level. The upper and lower bands can also be interpreted as price targets. When the price bounces off of the lower band and crosses the middle band, then the upper band becomes the price target. + +### Usage + +```python +bbands [-l N_LENGTH] [-s N_STD] [-m S_MAMODE] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| n_length | length | 15 | True | None | +| n_std | std | 2 | True | None | +| s_mamode | mamode | sma | True | None | + +![bbands](https://user-images.githubusercontent.com/46355364/154309951-116f3c31-342d-4ceb-b489-8b0ba78eb3a0.png) + +--- diff --git a/website/content/terminal/reference/etf/ta/cci.md b/website/content/terminal/reference/etf/ta/cci.md new file mode 100644 index 000000000000..7f5c0028bc91 --- /dev/null +++ b/website/content/terminal/reference/etf/ta/cci.md @@ -0,0 +1,41 @@ +--- +title: cci +description: The page describes the usage and parameters of CCI (Commodity Channel + Index), a tool designed to detect beginning and ending market trends. It suggests + how CCI values can indicate overbought or oversold conditions and potential price + corrections. +keywords: +- Commodity Channel Index +- CCI +- market trends +- overbought conditions +- oversold conditions +- price correction +- CCI Parameters +- CCI usage +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +The CCI is designed to detect beginning and ending market trends. The range of 100 to -100 is the normal trading range. CCI values outside of this range indicate overbought or oversold conditions. You can also look for price divergence in the CCI. If the price is making new highs, and the CCI is not, then a price correction is likely. + +### Usage + +```python +cci [-l N_LENGTH] [-s N_SCALAR] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| n_length | length | 14 | True | None | +| n_scalar | scalar | 0.015 | True | None | + +![cci](https://user-images.githubusercontent.com/46355364/154310079-808803ca-26dd-4d45-8a02-17e51230bf2d.png) + +--- diff --git a/website/content/terminal/reference/etf/ta/cg.md b/website/content/terminal/reference/etf/ta/cg.md new file mode 100644 index 000000000000..a9803b7f50a9 --- /dev/null +++ b/website/content/terminal/reference/etf/ta/cg.md @@ -0,0 +1,37 @@ +--- +title: cg +description: This page provides detailed information on the Center of Gravity indicator + (COG) used to anticipate future price movements and trade on price reversals, and + its best usage in range-bound markets. +keywords: +- Center of Gravity indicator +- future price movements +- trade on price reversals +- oscillators +- range-bound markets +- asset price change +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +The Center of Gravity indicator, in short, is used to anticipate future price movements and to trade on price reversals as soon as they happen. However, just like other oscillators, the COG indicator returns the best results in range-bound markets and should be avoided when the price is trending. Traders who use it will be able to closely speculate the upcoming price change of the asset. + +### Usage + +```python +cg [-l N_LENGTH] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| n_length | length | 14 | True | None | + +![cg](https://user-images.githubusercontent.com/46355364/154310202-cd0d703e-21ba-41a2-b58a-5b8547efa887.png) + +--- diff --git a/website/content/terminal/reference/etf/ta/clenow.md b/website/content/terminal/reference/etf/ta/clenow.md new file mode 100644 index 000000000000..849c2973e2d3 --- /dev/null +++ b/website/content/terminal/reference/etf/ta/clenow.md @@ -0,0 +1,33 @@ +--- +title: clenow +description: Discover how to calculate the Clenow Volatility Adjusted Momentum using + the lookback period for regression in Python. Learn about the parameters and usage + of the command for optimized results. +keywords: +- Clenow +- Volatility Adjusted Momentum +- Lookback period +- Regression +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Calculates the Clenow Volatility Adjusted Momentum. + +### Usage + +```python +clenow [-p PERIOD] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| period | Lookback period for regression | 90 | True | None | + +--- diff --git a/website/content/terminal/reference/etf/ta/demark.md b/website/content/terminal/reference/etf/ta/demark.md new file mode 100644 index 000000000000..6db3321b91e1 --- /dev/null +++ b/website/content/terminal/reference/etf/ta/demark.md @@ -0,0 +1,32 @@ +--- +title: demark +description: Documentation for Demark Sequential Indicator, a technical indicator + in Python. Detailed usage and parameter information is available. +keywords: +- Demark Sequential Indicator +- Technical Indicator +- Parameters +- Usage +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Calculates the Demark sequential indicator. + +### Usage + +```python +demark [-m MIN_TO_SHOW] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| min_to_show | Minimum value of indicator to show (declutters plot). | 5 | True | None | + +--- diff --git a/website/content/terminal/reference/etf/ta/donchian.md b/website/content/terminal/reference/etf/ta/donchian.md new file mode 100644 index 000000000000..9221e25add29 --- /dev/null +++ b/website/content/terminal/reference/etf/ta/donchian.md @@ -0,0 +1,40 @@ +--- +title: donchian +description: This page covers the complete information about Donchian Channels, an + indicator generated by moving average calculations to mark the highest and lowest + prices of a security over N periods. It also includes how to use the 'donchian' + command. +keywords: +- Donchian Channels +- security price +- moving average calculations +- upper and lower bands +- Donchian Channel +- n_length_upper +- n_length_lower +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Donchian Channels are three lines generated by moving average calculations that comprise an indicator formed by upper and lower bands around a midrange or median band. The upper band marks the highest price of a security over N periods while the lower band marks the lowest price of a security over N periods. The area between the upper and lower bands represents the Donchian Channel. + +### Usage + +```python +donchian [-u N_LENGTH_UPPER] [-l N_LENGTH_LOWER] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| n_length_upper | length | 20 | True | None | +| n_length_lower | length | 20 | True | None | + +![donchian](https://user-images.githubusercontent.com/46355364/154310472-6cd5805f-b87f-4668-85a1-3e5dd7267848.png) + +--- diff --git a/website/content/terminal/reference/etf/ta/ema.md b/website/content/terminal/reference/etf/ta/ema.md new file mode 100644 index 000000000000..d43d7a1eae82 --- /dev/null +++ b/website/content/terminal/reference/etf/ta/ema.md @@ -0,0 +1,41 @@ +--- +title: ema +description: The page provides details on 'Exponential Moving Average' (EMA) under + technical analysis. It explains how EMA outperforms the Simple Moving Average by + giving more weight to recent data for increased responsiveness. The page includes + a guide for using the 'ema' function and its parameters - 'n_length' and 'n_offset'. +keywords: +- Exponential Moving Average +- technical analysis +- Simple Moving Average +- ema +- Moving Average calculation +- n_length +- n_offset +- data responsiveness +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +The Exponential Moving Average is a staple of technical analysis and is used in countless technical indicators. In a Simple Moving Average, each value in the time period carries equal weight, and values outside of the time period are not included in the average. However, the Exponential Moving Average is a cumulative calculation, including all data. Past values have a diminishing contribution to the average, while more recent values have a greater contribution. This method allows the moving average to be more responsive to changes in the data. + +### Usage + +```python +ema [-l N_LENGTH] [-o N_OFFSET] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| n_length | Window lengths. Multiple values indicated as comma separated values. | 20, 50 | True | None | +| n_offset | offset | 0 | True | None | + +![ema](https://user-images.githubusercontent.com/46355364/154310578-6f4a51a8-3667-497c-9c50-7ff16e256fb6.png) + +--- diff --git a/website/content/terminal/reference/etf/ta/fib.md b/website/content/terminal/reference/etf/ta/fib.md new file mode 100644 index 000000000000..75e1d9ccdb91 --- /dev/null +++ b/website/content/terminal/reference/etf/ta/fib.md @@ -0,0 +1,40 @@ +--- +title: fib +description: This page offers a comprehensive guide on how to calculate Fibonacci + retracement levels, detailing its usage and the parameters required. +keywords: +- Fibonacci retracement levels +- Financial market analysis +- Trading tools +- Technical analysis +- period parameter +- start parameter +- end parameter +- calculation guide +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Calculates the fibonacci retracement levels + +### Usage + +```python +fib [-p PERIOD] [--start START] [--end END] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| period | Days to look back for retracement | 120 | True | None | +| start | Starting date to select | None | True | None | +| end | Ending date to select | None | True | None | + +![fib](https://user-images.githubusercontent.com/46355364/154310727-81a1eab3-5565-42c7-8b47-4f80288dd700.png) + +--- diff --git a/website/content/terminal/reference/etf/ta/fisher.md b/website/content/terminal/reference/etf/ta/fisher.md new file mode 100644 index 000000000000..44f1da74650b --- /dev/null +++ b/website/content/terminal/reference/etf/ta/fisher.md @@ -0,0 +1,39 @@ +--- +title: fisher +description: A technical documentation page highlighting the Fisher Transform, a technical + indicator, its usage, parameters, and purpose in identifying price turning points + and trends. +keywords: +- Fisher Transform +- Technical Indicator +- John F. Ehlers +- Price Turning Points +- Price Trends +- Gaussian Normal Distribution +- Isolate Price Waves +- Parameter Configuration +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +The Fisher Transform is a technical indicator created by John F. Ehlers that converts prices into a Gaussian normal distribution.1 The indicator highlights when prices have moved to an extreme, based on recent prices. This may help in spotting turning points in the price of an asset. It also helps show the trend and isolate the price waves within a trend. + +### Usage + +```python +fisher [-l N_LENGTH] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| n_length | length | 14 | True | None | + +![fisher](https://user-images.githubusercontent.com/46355364/154310853-0abf6cea-71ca-4f07-b009-282c58ab9cfc.png) + +--- diff --git a/website/content/terminal/reference/etf/ta/hma.md b/website/content/terminal/reference/etf/ta/hma.md new file mode 100644 index 000000000000..42d0a8c51ab2 --- /dev/null +++ b/website/content/terminal/reference/etf/ta/hma.md @@ -0,0 +1,41 @@ +--- +title: hma +description: Learn how to use the Hull Moving Average (HMA), a method that improves + responsiveness to price activity and maintains curve smoothness. Understand how + to use parameters like n_length and n_offset with the HMA. +keywords: +- Hull Moving Average +- moving average +- price activity +- curve smoothness +- lag elimination +- improved smoothing +- HMA usage +- n_length +- n_offset +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +The Hull Moving Average solves the age old dilemma of making a moving average more responsive to current price activity whilst maintaining curve smoothness. In fact the HMA almost eliminates lag altogether and manages to improve smoothing at the same time. + +### Usage + +```python +hma [-l N_LENGTH] [-o N_OFFSET] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| n_length | Window lengths. Multiple values indicated as comma separated values. | 10, 20 | True | None | +| n_offset | offset | 0 | True | None | + +![hma](https://user-images.githubusercontent.com/46355364/154310988-2e97c166-a3b9-49ae-abcd-2c1b37309072.png) + +--- diff --git a/website/content/terminal/reference/etf/ta/kc.md b/website/content/terminal/reference/etf/ta/kc.md new file mode 100644 index 000000000000..a53a7d2894f0 --- /dev/null +++ b/website/content/terminal/reference/etf/ta/kc.md @@ -0,0 +1,47 @@ +--- +title: kc +description: This documentation page provides detailed information about Keltner Channels, + a volatility-based band applied onto an asset's price. These channels aid in trend + determination by employing average true range (ATR) or volatility. The page also + provides comprehensive instructions about how to use and parameterize the 'kc' tool. +keywords: +- Keltner Channels +- volatility-based bands +- average true range +- ATR +- trend determination +- kc +- kc parameters +- n_length +- n_scalar +- s_mamode +- n_offset +- kc usage +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Keltner Channels are volatility-based bands that are placed on either side of an asset's price and can aid in determining the direction of a trend.The Keltner channel uses the average true range (ATR) or volatility, with breaks above or below the top and bottom barriers signaling a continuation. + +### Usage + +```python +kc [-l N_LENGTH] [-s N_SCALAR] [-m {ema,sma,wma,hma,zlma}] [-o N_OFFSET] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| n_length | Window length | 20 | True | None | +| n_scalar | scalar | 2 | True | None | +| s_mamode | mamode | ema | True | ema, sma, wma, hma, zlma | +| n_offset | offset | 0 | True | None | + +![kc](https://user-images.githubusercontent.com/46355364/154311120-a769ee53-901b-401f-907f-cacac43ee9b9.png) + +--- diff --git a/website/content/terminal/reference/etf/ta/macd.md b/website/content/terminal/reference/etf/ta/macd.md new file mode 100644 index 000000000000..e2903d527da7 --- /dev/null +++ b/website/content/terminal/reference/etf/ta/macd.md @@ -0,0 +1,43 @@ +--- +title: macd +description: Describes the Moving Average Convergence Divergence (MACD), a metric + used to indicate trend changes and potential buy/sell signals in markets. The page + includes usage, parameters, and a visual example. +keywords: +- MACD +- Moving Average Convergence Divergence +- Exponential Moving Averages +- Signal line +- trend changes +- overbought conditions +- oversold conditions +- Divergence +- buy signal +- sell signal +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +The Moving Average Convergence Divergence (MACD) is the difference between two Exponential Moving Averages. The Signal line is an Exponential Moving Average of the MACD. The MACD signals trend changes and indicates the start of new trend direction. High values indicate overbought conditions, low values indicate oversold conditions. Divergence with the price indicates an end to the current trend, especially if the MACD is at extreme high or low values. When the MACD line crosses above the signal line a buy signal is generated. When the MACD crosses below the signal line a sell signal is generated. To confirm the signal, the MACD should be above zero for a buy, and below zero for a sell. + +### Usage + +```python +macd [--fast N_FAST] [--slow N_SLOW] [--signal N_SIGNAL] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| n_fast | The short period. | 12 | True | None | +| n_slow | The long period. | 26 | True | None | +| n_signal | The signal period. | 9 | True | None | + +![macd](https://user-images.githubusercontent.com/46355364/154311220-d18eb93e-76b3-4abb-b9c6-86484f462c55.png) + +--- diff --git a/website/content/terminal/reference/etf/ta/obv.md b/website/content/terminal/reference/etf/ta/obv.md new file mode 100644 index 000000000000..f919c8366eca --- /dev/null +++ b/website/content/terminal/reference/etf/ta/obv.md @@ -0,0 +1,37 @@ +--- +title: obv +description: On Balance Volume (OBV) is a crucial aspect in volume analysis and technical + trading. This page gives an in-depth explanation on OBV describing its impact, its + interpretation, and usage in predicting price moves and market trends. +keywords: +- On Balance Volume +- OBV +- Volume Analysis +- Technical Analysis +- Market Trend +- Price Move +- Financial Trading +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +The On Balance Volume (OBV) is a cumulative total of the up and down volume. When the close is higher than the previous close, the volume is added to the running total, and when the close is lower than the previous close, the volume is subtracted from the running total. To interpret the OBV, look for the OBV to move with the price or precede price moves. If the price moves before the OBV, then it is a non-confirmed move. A series of rising peaks, or falling troughs, in the OBV indicates a strong trend. If the OBV is flat, then the market is not trending. + +### Usage + +```python +obv +``` + +--- + +## Parameters + +This command has no parameters + + +![obv](https://user-images.githubusercontent.com/46355364/154311359-edb78587-744f-4e2c-b247-8b9fbf09b01f.png) + +--- diff --git a/website/content/terminal/reference/etf/ta/rsi.md b/website/content/terminal/reference/etf/ta/rsi.md new file mode 100644 index 000000000000..54afe4701a86 --- /dev/null +++ b/website/content/terminal/reference/etf/ta/rsi.md @@ -0,0 +1,45 @@ +--- +title: rsi +description: This page provides detailed information about the Relative Strength Index + (RSI), including its calculations, interpretation and usage. It also explains the + various parameters involved and how to modify them. +keywords: +- RSI +- Relative Strength Index +- overbought +- oversold +- indicator +- price movement +- divergence +- reversal +- parameters +- n_length +- n_scalar +- n_drift +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +The Relative Strength Index (RSI) calculates a ratio of the recent upward price movements to the absolute price movement. The RSI ranges from 0 to 100. The RSI is interpreted as an overbought/oversold indicator when the value is over 70/below 30. You can also look for divergence with price. If the price is making new highs/lows, and the RSI is not, it indicates a reversal. + +### Usage + +```python +rsi [-l N_LENGTH] [-s N_SCALAR] [-d N_DRIFT] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| n_length | length | 14 | True | None | +| n_scalar | scalar | 100 | True | None | +| n_drift | drift | 1 | True | None | + +![rsi](https://user-images.githubusercontent.com/46355364/154311651-99e67e12-1677-43a9-92d9-5998d99fd0db.png) + +--- diff --git a/website/content/terminal/reference/etf/ta/sma.md b/website/content/terminal/reference/etf/ta/sma.md new file mode 100644 index 000000000000..f68dcd90e2a3 --- /dev/null +++ b/website/content/terminal/reference/etf/ta/sma.md @@ -0,0 +1,39 @@ +--- +title: sma +description: This page provides information on Simple Moving Average (SMA), a tool + for trend identification and data filtering. It details SMA's usage and parameters + like n_length and n_offset. +keywords: +- Simple Moving Average +- sma +- Moving Average +- trend identification +- data filtering +- n_length +- n_offset +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Moving Averages are used to smooth the data in an array to help eliminate noise and identify trends. The Simple Moving Average is literally the simplest form of a moving average. Each output value is the average of the previous n values. In a Simple Moving Average, each value in the time period carries equal weight, and values outside of the time period are not included in the average. This makes it less responsive to recent changes in the data, which can be useful for filtering out those changes. + +### Usage + +```python +sma [-l N_LENGTH] [-o N_OFFSET] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| n_length | Window lengths. Multiple values indicated as comma separated values. | 20, 50 | True | None | +| n_offset | offset | 0 | True | None | + +![sma](https://user-images.githubusercontent.com/46355364/154311791-5b130d08-55bd-406b-a68e-914a733c5191.png) + +--- diff --git a/website/content/terminal/reference/etf/ta/stoch.md b/website/content/terminal/reference/etf/ta/stoch.md new file mode 100644 index 000000000000..915631eb079e --- /dev/null +++ b/website/content/terminal/reference/etf/ta/stoch.md @@ -0,0 +1,44 @@ +--- +title: stoch +description: Learn how to use the Stochastic Oscillator, a tool for measuring where + the close is in relation to the recent trading range. Input values range from zero + to 100, and interpret the output for buy and sell signals +keywords: +- Stochastic Oscillator +- overbought condition +- oversold condition +- buy signal +- sell signal +- Fast %D and Slow %D +- Raw %K +- moving average +- trading range +- stoch usage +- stoch parameters +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +The Stochastic Oscillator measures where the close is in relation to the recent trading range. The values range from zero to 100. %D values over 75 indicate an overbought condition; values under 25 indicate an oversold condition. When the Fast %D crosses above the Slow %D, it is a buy signal; when it crosses below, it is a sell signal. The Raw %K is generally considered too erratic to use for crossover signals. + +### Usage + +```python +stoch [-k N_FASTKPERIOD] [-d N_SLOWDPERIOD] [--slowkperiod N_SLOWKPERIOD] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| n_fastkperiod | The time period of the fastk moving average | 14 | True | None | +| n_slowdperiod | The time period of the slowd moving average | 3 | True | None | +| n_slowkperiod | The time period of the slowk moving average | 3 | True | None | + +![stoch](https://user-images.githubusercontent.com/46355364/154311913-d58e58bb-d116-44dd-ae4b-44e59c25f22a.png) + +--- diff --git a/website/content/terminal/reference/etf/ta/vwap.md b/website/content/terminal/reference/etf/ta/vwap.md new file mode 100644 index 000000000000..a391525c0dbe --- /dev/null +++ b/website/content/terminal/reference/etf/ta/vwap.md @@ -0,0 +1,60 @@ +--- +title: vwap +description: Learn how to use the Volume Weighted Average Price, a tool that measures + the average typical price by volume. It is used with intraday charts to identify + the general direction of the market. +keywords: +- VWAP +- intraday charts +- average price +- volume +- market direction +- stock analysis +- GOOGL +- USD +- financial data +- trading +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +The Volume Weighted Average Price that measures the average typical price by volume. It is typically used with intraday charts to identify general direction. + +### Usage + +```python +vwap [-o N_OFFSET] [--start START] [--end END] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| n_offset | offset | 0 | True | None | +| start | Starting date to select | None | True | None | +| end | Ending date to select | None | True | None | + + +--- + +## Examples + +```python +2022 Feb 16, 11:36 (🦋) /stocks/ta/ $ load GOOGL -i 1 + +Loading Intraday 1min GOOGL stock with starting period 2022-02-10 for analysis. + +Datetime: 2022 Feb 16 11:36 +Timezone: America/New_York +Currency: USD +Market: CLOSED + +2022 Feb 16, 11:36 (🦋) /stocks/ta/ $ vwap +``` +![vwap](https://user-images.githubusercontent.com/46355364/154312502-9377c57c-6e34-42a6-b021-674e7d4561dd.png) + +--- diff --git a/website/content/terminal/reference/etf/ta/wma.md b/website/content/terminal/reference/etf/ta/wma.md new file mode 100644 index 000000000000..f9775b398cd2 --- /dev/null +++ b/website/content/terminal/reference/etf/ta/wma.md @@ -0,0 +1,38 @@ +--- +title: wma +description: Learn how to use Weighted Moving Average (WMA) for better data analysis. + This page provides a guide on how to implement WMA, with more weight on recent data + and less on past data. It details the usage, parameters, defaults and offers a visual + representation for clearer understanding. +keywords: +- Weighted Moving Average +- WMA +- Simple Moving Average +- n_length +- n_offset +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +A Weighted Moving Average puts more weight on recent data and less on past data. This is done by multiplying each bar’s price by a weighting factor. Because of its unique calculation, WMA will follow prices more closely than a corresponding Simple Moving Average. + +### Usage + +```python +wma [-l N_LENGTH] [-o N_OFFSET] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| n_length | Window lengths. Multiple values indicated as comma separated values. | 20, 50 | True | None | +| n_offset | offset | 0 | True | None | + +![wma](https://user-images.githubusercontent.com/46355364/154312618-43430406-97c1-4740-87be-2414de9a1c06.png) + +--- diff --git a/website/content/terminal/reference/etf/ta/zlma.md b/website/content/terminal/reference/etf/ta/zlma.md new file mode 100644 index 000000000000..7a5ed6fb98c7 --- /dev/null +++ b/website/content/terminal/reference/etf/ta/zlma.md @@ -0,0 +1,40 @@ +--- +title: zlma +description: Zero lag exponential moving average (ZLEMA) indicator documentation. + Learn how to use and implement the ZLEMA in your data studies with its parameters + and usage. Devised by John Ehlers and Ric Way, ZLEMA aids in providing a de-lagged + calculation of data. +keywords: +- zlma +- zero lag exponential moving average +- John Ehlers +- Ric Way +- EMA +- de-lagged data +- moving average +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +The zero lag exponential moving average (ZLEMA) indicator was created by John Ehlers and Ric Way. The idea is do a regular exponential moving average (EMA) calculation but on a de-lagged data instead of doing it on the regular data. Data is de-lagged by removing the data from "lag" days ago thus removing (or attempting to) the cumulative effect of the moving average. + +### Usage + +```python +zlma [-l N_LENGTH] [-o N_OFFSET] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| n_length | Window lengths. Multiple values indicated as comma separated values. | 20 | True | None | +| n_offset | offset | 0 | True | None | + +![zlma](https://user-images.githubusercontent.com/46355364/154312786-bc60268b-9da9-4fd9-bed6-fc95f5560075.png) + +--- diff --git a/website/content/terminal/reference/etf/weights.md b/website/content/terminal/reference/etf/weights.md new file mode 100644 index 000000000000..9363f98678c3 --- /dev/null +++ b/website/content/terminal/reference/etf/weights.md @@ -0,0 +1,36 @@ +--- +title: weights +description: The page details the usage of the 'weights' parameter in viewing ETF + sector holdings. It also provides information about the parameters such as the minimum + positive float to display the sector and an option for raw data output. +keywords: +- ETF sector holdings +- weights parameter +- minimum positive float +- raw data output +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Look at ETF sector holdings + +### Usage + +```python +weights [-m MIN] [--raw] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| min | Minimum positive float to display sector | 5 | True | None | +| raw | Only output raw data | False | True | None | + +![weights](https://user-images.githubusercontent.com/46355364/154034921-2195b3c0-d251-4ec2-8fc0-87605115bee0.png) + +--- diff --git a/website/versioned_docs/version-v3/terminal/reference/forecast/_category_.json b/website/content/terminal/reference/forecast/_category_.json similarity index 100% rename from website/versioned_docs/version-v3/terminal/reference/forecast/_category_.json rename to website/content/terminal/reference/forecast/_category_.json diff --git a/website/content/terminal/reference/forecast/atr.md b/website/content/terminal/reference/forecast/atr.md new file mode 100644 index 000000000000..c521baf9eaa8 --- /dev/null +++ b/website/content/terminal/reference/forecast/atr.md @@ -0,0 +1,82 @@ +--- +title: atr +description: This page details how to add Average True Range to a stock ticker dataset + using the `atr` command. It's a fantastic resource for individuals interested in + forecasting and stock market analysis. +keywords: +- Average True Range +- dataset +- stock ticker +- close column +- high column +- low column +- target dataset +- target column +- forecasting +- stock market analysis +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Add Average True Range to dataset of specific stock ticker. + +### Usage + +```python +atr [--close-col CLOSE_COL] [--high-col HIGH_COL] [--low-col LOW_COL] [-d {}] [-c TARGET_COLUMN] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| close_col | Close column name to use for Average True Range. | close | True | None | +| high_col | High column name to use for Average True Range. | high | True | None | +| low_col | Low column name to use for Average True Range. | low | True | None | +| target_dataset | The name of the dataset you want to select | None | True | None | +| target_column | The name of the specific column you want to use | close | True | None | + + +--- + +## Examples + +```python +(🦋) /forecast/ $ load aapl_20220628_113243.csv + +(🦋) /forecast/ $ atr aapl_20220628_113243 +Successfully added 'Average True Range' to 'aapl_20220628_113243' dataset + +(🦋) /forecast/ $ show aapl_20220628_113243 +aapl_20220628_113243 dataset has shape (row, column): (759, 9) + + Dataset aapl_20220628_113243 | Showing 10 of 759 rows +┏━━━┳━━━━━━━━━━━━┳━━━━━━━━━━━━┳━━━━━━━┳━━━━━━━┳━━━━━━━┳━━━━━━━┳━━━━━━━━━━━┳━━━━━━━━━━━┳━━━━━━━━━━━━┓ +┃ ┃ unnamed:_0 ┃ date ┃ open ┃ high ┃ low ┃ close ┃ adj_close ┃ volume ┃ true_range ┃ +┡━━━╇━━━━━━━━━━━━╇━━━━━━━━━━━━╇━━━━━━━╇━━━━━━━╇━━━━━━━╇━━━━━━━╇━━━━━━━━━━━╇━━━━━━━━━━━╇━━━━━━━━━━━━┩ +│ 0 │ 0 │ 2019-06-10 │ 47.95 │ 48.84 │ 47.90 │ 48.15 │ 46.99 │ 104883600 │ 0.94 │ +├───┼────────────┼────────────┼───────┼───────┼───────┼───────┼───────────┼───────────┼────────────┤ +│ 1 │ 1 │ 2019-06-11 │ 48.72 │ 49.00 │ 48.40 │ 48.70 │ 47.53 │ 107731600 │ 0.85 │ +├───┼────────────┼────────────┼───────┼───────┼───────┼───────┼───────────┼───────────┼────────────┤ +│ 2 │ 2 │ 2019-06-12 │ 48.49 │ 48.99 │ 48.35 │ 48.55 │ 47.38 │ 73012800 │ 0.65 │ +├───┼────────────┼────────────┼───────┼───────┼───────┼───────┼───────────┼───────────┼────────────┤ +│ 3 │ 3 │ 2019-06-13 │ 48.67 │ 49.20 │ 48.40 │ 48.54 │ 47.37 │ 86698400 │ 0.80 │ +├───┼────────────┼────────────┼───────┼───────┼───────┼───────┼───────────┼───────────┼────────────┤ +│ 4 │ 4 │ 2019-06-14 │ 47.89 │ 48.40 │ 47.58 │ 48.19 │ 47.03 │ 75046000 │ 0.96 │ +├───┼────────────┼────────────┼───────┼───────┼───────┼───────┼───────────┼───────────┼────────────┤ +│ 5 │ 5 │ 2019-06-17 │ 48.22 │ 48.74 │ 48.04 │ 48.47 │ 47.31 │ 58676400 │ 0.70 │ +├───┼────────────┼────────────┼───────┼───────┼───────┼───────┼───────────┼───────────┼────────────┤ +│ 6 │ 6 │ 2019-06-18 │ 49.01 │ 50.07 │ 48.80 │ 49.61 │ 48.42 │ 106204000 │ 1.60 │ +├───┼────────────┼────────────┼───────┼───────┼───────┼───────┼───────────┼───────────┼────────────┤ +│ 7 │ 7 │ 2019-06-19 │ 49.92 │ 49.97 │ 49.33 │ 49.47 │ 48.28 │ 84496800 │ 0.64 │ +├───┼────────────┼────────────┼───────┼───────┼───────┼───────┼───────────┼───────────┼────────────┤ +│ 8 │ 8 │ 2019-06-20 │ 50.09 │ 50.15 │ 49.51 │ 49.87 │ 48.67 │ 86056000 │ 0.69 │ +├───┼────────────┼────────────┼───────┼───────┼───────┼───────┼───────────┼───────────┼────────────┤ +│ 9 │ 9 │ 2019-06-21 │ 49.70 │ 50.21 │ 49.54 │ 49.69 │ 48.50 │ 191202400 │ 0.68 │ +└───┴────────────┴────────────┴───────┴───────┴───────┴───────┴───────────┴───────────┴────────────┘ +``` +--- diff --git a/website/content/terminal/reference/forecast/autoarima.md b/website/content/terminal/reference/forecast/autoarima.md new file mode 100644 index 000000000000..758111bf0fd6 --- /dev/null +++ b/website/content/terminal/reference/forecast/autoarima.md @@ -0,0 +1,81 @@ +--- +title: autoarima +description: The AutoARIMA documentation page provides an extensive guide on how the + Automatic ARIMA forecast works. Details include command usage, various parameters, + and examples demonstrating how the forecast performs. This page is ideal for those + seeking to understand predictive modeling, time-series analysis, and the application + of ARIMA models. +keywords: +- AutoARIMA +- Forecasting +- Predictive modeling +- ARIMA models +- Time Series Analysis +- Machine Learning +- Algorithm +- Data Modeling +- Statistical Analysis +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Perform Automatic ARIMA forecast: https://nixtla.github.io/statsforecast/examples/getting_started_with_auto_arima_and_ets.html + +### Usage + +```python +autoarima [--naive] [-d {}] [-c TARGET_COLUMN] [-n N_DAYS] [-s {N,A,M}] [-p SEASONAL_PERIODS] [-w START_WINDOW] [--end S_END_DATE] [--start S_START_DATE] [--residuals] [--forecast-only] [--export-pred-raw] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| naive | Show the naive baseline for a model. | False | True | None | +| target_dataset | The name of the dataset you want to select | None | True | None | +| target_column | The name of the specific column you want to use | close | True | None | +| n_days | prediction days. | 5 | True | None | +| seasonal | Seasonality: N: None, A: Additive, M: Multiplicative. | A | True | N, A, M | +| seasonal_periods | Seasonal periods: 4: Quarterly, 7: Daily | 7 | True | None | +| start_window | Start point for rolling training and forecast window. 0.0-1.0 | 0.85 | True | None | +| s_end_date | The end date (format YYYY-MM-DD) to select for testing | None | True | None | +| s_start_date | The start date (format YYYY-MM-DD) to select for testing | None | True | None | +| residuals | Show the residuals for the model. | False | True | None | +| forecast_only | Do not plot the historical data without forecasts. | False | True | None | +| export_pred_raw | Export predictions to a csv file. | False | True | None | + + +--- + +## Examples + +```python +2022 Nov 07, 16:17 (🦋) /stocks/ $ forecast + +2022 Nov 07, 16:17 (🦋) /forecast/ $ autoarima AAPL + +Cross Validation Time Series 1: 100%|█████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████| 115/115 [00:2100:00, 5.31it/s] +Forecast: 100%|███████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████| 1/1 [00:0000:00, 1.68it/s] +AutoARIMA obtains MAPE: 2.86% + + + Actual price: 138.38 +┏━━━━━━━━━━━━┳━━━━━━━━━━━━┓ +┃ Datetime ┃ Prediction ┃ +┡━━━━━━━━━━━━╇━━━━━━━━━━━━┩ +│ 2022-11-07 │ 138.43 │ +├────────────┼────────────┤ +│ 2022-11-08 │ 138.43 │ +├────────────┼────────────┤ +│ 2022-11-09 │ 138.43 │ +├────────────┼────────────┤ +│ 2022-11-10 │ 138.43 │ +├────────────┼────────────┤ +│ 2022-11-11 │ 138.43 │ +└────────────┴────────────┘ +``` +--- diff --git a/website/content/terminal/reference/forecast/autoces.md b/website/content/terminal/reference/forecast/autoces.md new file mode 100644 index 000000000000..2b9e6818afbd --- /dev/null +++ b/website/content/terminal/reference/forecast/autoces.md @@ -0,0 +1,79 @@ +--- +title: autoces +description: This site explores Autoces, a tool for Automatic Complex Exponential + Smoothing forecast, its usage, parameters, and examples. +keywords: +- Autoces +- Automatic Complex Exponential Smoothing forecast +- forecasting tool +- parameters +- usage +- examples +- seasonality +- data analysis +- prediction days +- plotting historical data +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Perform Automatic Complex Exponential Smoothing forecast: https://nixtla.github.io/statsforecast/models.html#autoces + +### Usage + +```python +autoces [--naive] [-d {}] [-c TARGET_COLUMN] [-n N_DAYS] [-s {N,A,M}] [-p SEASONAL_PERIODS] [-w START_WINDOW] [--end S_END_DATE] [--start S_START_DATE] [--residuals] [--forecast-only] [--export-pred-raw] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| naive | Show the naive baseline for a model. | False | True | None | +| target_dataset | The name of the dataset you want to select | None | True | None | +| target_column | The name of the specific column you want to use | close | True | None | +| n_days | prediction days. | 5 | True | None | +| seasonal | Seasonality: N: None, A: Additive, M: Multiplicative. | A | True | N, A, M | +| seasonal_periods | Seasonal periods: 4: Quarterly, 7: Daily | 7 | True | None | +| start_window | Start point for rolling training and forecast window. 0.0-1.0 | 0.85 | True | None | +| s_end_date | The end date (format YYYY-MM-DD) to select for testing | None | True | None | +| s_start_date | The start date (format YYYY-MM-DD) to select for testing | None | True | None | +| residuals | Show the residuals for the model. | False | True | None | +| forecast_only | Do not plot the historical data without forecasts. | False | True | None | +| export_pred_raw | Export predictions to a csv file. | False | True | None | + + +--- + +## Examples + +```python +2022 Nov 07, 16:42 (🦋) /stocks/ $ forecast + +2022 Nov 07, 16:42 (🦋) /forecast/ $ autoces AAPL + +Cross Validation Time Series 1: 100%|█████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████| 115/115 [00:1300:00, 8.70it/s] +Forecast: 100%|███████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████| 1/1 [00:0000:00, 3.23it/s] +AutoCES obtains MAPE: 3.09% + + + Actual price: 138.38 +┏━━━━━━━━━━━━┳━━━━━━━━━━━━┓ +┃ Datetime ┃ Prediction ┃ +┡━━━━━━━━━━━━╇━━━━━━━━━━━━┩ +│ 2022-11-07 │ 138.70 │ +├────────────┼────────────┤ +│ 2022-11-08 │ 138.53 │ +├────────────┼────────────┤ +│ 2022-11-09 │ 139.16 │ +├────────────┼────────────┤ +│ 2022-11-10 │ 138.91 │ +├────────────┼────────────┤ +│ 2022-11-11 │ 139.01 │ +└────────────┴────────────┘ +``` +--- diff --git a/website/content/terminal/reference/forecast/autoets.md b/website/content/terminal/reference/forecast/autoets.md new file mode 100644 index 000000000000..1eaf04742559 --- /dev/null +++ b/website/content/terminal/reference/forecast/autoets.md @@ -0,0 +1,77 @@ +--- +title: autoets +description: The page provides information on how to use the autoets function for + automatic Error, Trend, Seasonality (ETS) forecasting. It includes details on the + usage of this function, its parameters, and an example to illustrate its application. +keywords: +- autoets +- ETS forecasting +- automatic ETS +- Error Trend Seasonality +- forecast +- parameters +- prediction +- seasonality +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Perform Automatic ETS (Error, Trend, Seasonality) forecast: https://nixtla.github.io/statsforecast/examples/getting_started_with_auto_arima_and_ets.html + +### Usage + +```python +autoets [--naive] [-d {}] [-c TARGET_COLUMN] [-n N_DAYS] [-s {N,A,M}] [-p SEASONAL_PERIODS] [-w START_WINDOW] [--end S_END_DATE] [--start S_START_DATE] [--residuals] [--forecast-only] [--export-pred-raw] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| naive | Show the naive baseline for a model. | False | True | None | +| target_dataset | The name of the dataset you want to select | None | True | None | +| target_column | The name of the specific column you want to use | close | True | None | +| n_days | prediction days. | 5 | True | None | +| seasonal | Seasonality: N: None, A: Additive, M: Multiplicative. | A | True | N, A, M | +| seasonal_periods | Seasonal periods: 4: Quarterly, 7: Daily | 7 | True | None | +| start_window | Start point for rolling training and forecast window. 0.0-1.0 | 0.85 | True | None | +| s_end_date | The end date (format YYYY-MM-DD) to select for testing | None | True | None | +| s_start_date | The start date (format YYYY-MM-DD) to select for testing | None | True | None | +| residuals | Show the residuals for the model. | False | True | None | +| forecast_only | Do not plot the historical data without forecasts. | False | True | None | +| export_pred_raw | Export predictions to a csv file. | False | True | None | + + +--- + +## Examples + +```python +2022 Oct 21, 18:20 (🦋) /forecast/ $ load AAPL + +2022 Oct 21, 18:21 (🦋) /forecast/ $ autoets AAPL + + + + Actual price: 143.39 +┏━━━━━━━━━━━━┳━━━━━━━━━━━━┓ +┃ Datetime ┃ Prediction ┃ +┡━━━━━━━━━━━━╇━━━━━━━━━━━━┩ +│ 2022-10-21 │ 143.42 │ +├────────────┼────────────┤ +│ 2022-10-24 │ 143.42 │ +├────────────┼────────────┤ +│ 2022-10-25 │ 143.42 │ +├────────────┼────────────┤ +│ 2022-10-26 │ 143.42 │ +├────────────┼────────────┤ +│ 2022-10-27 │ 143.42 │ +└────────────┴────────────┘ +``` +![autoets](https://user-images.githubusercontent.com/10517170/197297075-d141d735-0b35-43cc-bf4f-e746b6b1001e.png) + +--- diff --git a/website/content/terminal/reference/forecast/autoselect.md b/website/content/terminal/reference/forecast/autoselect.md new file mode 100644 index 000000000000..70ba7e194d67 --- /dev/null +++ b/website/content/terminal/reference/forecast/autoselect.md @@ -0,0 +1,98 @@ +--- +title: autoselect +description: The autoselect page provides information on how to utilize specific parameters + for advanced statistical forecasting using models such as AutoARIMA, AutoETS, AutoCES, + MSTL, and more. It also includes examples of how to use this forecasting tool. +keywords: +- autoselect +- statistical forecast +- AutoARIMA +- AutoETS +- AutoCES +- MSTL +- seasonality +- forecasting +- performance per model +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Perform Automatic Statistical Forecast (select best statistical model from AutoARIMA, AutoETS, AutoCES, MSTL, ...) + +### Usage + +```python +autoselect [--naive] [-d {}] [-c TARGET_COLUMN] [-n N_DAYS] [-s {N,A,M}] [-p SEASONAL_PERIODS] [-w START_WINDOW] [--end S_END_DATE] [--start S_START_DATE] [--residuals] [--forecast-only] [--export-pred-raw] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| naive | Show the naive baseline for a model. | False | True | None | +| target_dataset | The name of the dataset you want to select | None | True | None | +| target_column | The name of the specific column you want to use | close | True | None | +| n_days | prediction days. | 5 | True | None | +| seasonal | Seasonality: N: None, A: Additive, M: Multiplicative. | A | True | N, A, M | +| seasonal_periods | Seasonal periods: 4: Quarterly, 7: Daily | 7 | True | None | +| start_window | Start point for rolling training and forecast window. 0.0-1.0 | 0.85 | True | None | +| s_end_date | The end date (format YYYY-MM-DD) to select for testing | None | True | None | +| s_start_date | The start date (format YYYY-MM-DD) to select for testing | None | True | None | +| residuals | Show the residuals for the model. | False | True | None | +| forecast_only | Do not plot the historical data without forecasts. | False | True | None | +| export_pred_raw | Export predictions to a csv file. | False | True | None | + + +--- + +## Examples + +```python +2022 Nov 09, 15:23 (🦋) /forecast/ $ load AAPL + +2022 Nov 09, 15:24 (🦋) /forecast/ $ autoselect AAPL + +Cross Validation Time Series 1: 100%|█████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████| 115/115 [00:4700:00, 2.40it/s] +Forecast: 100%|███████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████| 1/1 [00:0100:00, 1.80s/it] + + + Performance per model. + Best model: AutoETS +┏━━━━━━━━━━━━━━━┳━━━━━━━━┓ +┃ Model ┃ MAPE ┃ +┡━━━━━━━━━━━━━━━╇━━━━━━━━┩ +│ AutoETS │ 2.91% │ +├───────────────┼────────┤ +│ AutoARIMA │ 2.93% │ +├───────────────┼────────┤ +│ RWD │ 3.04% │ +├───────────────┼────────┤ +│ AutoCES │ 3.15% │ +├───────────────┼────────┤ +│ MSTL │ 3.40% │ +├───────────────┼────────┤ +│ SeasonalNaive │ 4.32% │ +├───────────────┼────────┤ +│ SeasWA │ 8.06% │ +└───────────────┴────────┘ + + Actual price: 139.50 +┏━━━━━━━━━━━━┳━━━━━━━━━━━━┓ +┃ Datetime ┃ Prediction ┃ +┡━━━━━━━━━━━━╇━━━━━━━━━━━━┩ +│ 2022-11-09 │ 139.47 │ +├────────────┼────────────┤ +│ 2022-11-10 │ 139.47 │ +├────────────┼────────────┤ +│ 2022-11-11 │ 139.47 │ +├────────────┼────────────┤ +│ 2022-11-14 │ 139.47 │ +├────────────┼────────────┤ +│ 2022-11-15 │ 139.47 │ +└────────────┴────────────┘ +``` +--- diff --git a/website/content/terminal/reference/forecast/brnn.md b/website/content/terminal/reference/forecast/brnn.md new file mode 100644 index 000000000000..1ac7d1b14e0f --- /dev/null +++ b/website/content/terminal/reference/forecast/brnn.md @@ -0,0 +1,102 @@ +--- +title: brnn +description: This documentation page provides in-depth details on how to effectively + perform BRNN forecasting using machine learning techniques such as LSTM and GRU + with Datusaurus models. It contains all the necessary parameters with their description, + default values, and optionality. The page also offers a clear working example demonstrating + the usage of BRNN for forecasting financial time series data. +keywords: +- BRNN forecast +- Vanilla RNN +- LSTM +- GRU +- machine learning +- data analysis +- datusaurus models +- forecasts +- parameters +- covariates +- train split +- epoch +- training +- RNN module type +- dropout +- batch size +- learning rate +- residuals +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Perform BRNN forecast (Vanilla RNN, LSTM, GRU): https://unit8co.github.io/darts/generated_api/darts.models.forecasting.block_rnn_model.html + +### Usage + +```python +brnn [--n-rnn-layers N_RNN_LAYERS] [--past-covariates PAST_COVARIATES] [--all-past-covariates] [--naive] [-d {}] [-c TARGET_COLUMN] [-n N_DAYS] [-t TRAIN_SPLIT] [-i INPUT_CHUNK_LENGTH] [-o OUTPUT_CHUNK_LENGTH] [--force-reset FORCE_RESET] [--save-checkpoints SAVE_CHECKPOINTS] [--model-save-name MODEL_SAVE_NAME] [--n-epochs N_EPOCHS] [--model-type MODEL_TYPE] [--dropout DROPOUT] [--batch-size BATCH_SIZE] [--end S_END_DATE] [--start S_START_DATE] [--learning-rate LEARNING_RATE] [--residuals] [--forecast-only] [--export-pred-raw] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| n_rnn_layers | Number of layers in the RNN module. | 1 | True | None | +| past_covariates | Past covariates(columns/features) in same dataset. Comma separated. | None | True | None | +| all_past_covariates | Adds all rows as past covariates except for date and the target column. | False | True | None | +| naive | Show the naive baseline for a model. | False | True | None | +| target_dataset | The name of the dataset you want to select | None | True | None | +| target_column | The name of the specific column you want to use | close | True | None | +| n_days | prediction days. | 5 | True | None | +| train_split | Start point for rolling training and forecast window. 0.0-1.0 | 0.85 | True | None | +| input_chunk_length | Number of past time steps for forecasting module at prediction time. | 14 | True | None | +| output_chunk_length | The length of the forecast of the model. | 5 | True | None | +| force_reset | If set to True, any previously-existing model with the same name will be reset (all checkpoints will be discarded). | True | True | None | +| save_checkpoints | Whether to automatically save the untrained model and checkpoints. | True | True | None | +| model_save_name | Name of the model to save. | brnn_model | True | None | +| n_epochs | Number of epochs over which to train the model. | 300 | True | None | +| model_type | Either a string specifying the RNN module type ("RNN", "LSTM" or "GRU") | LSTM | True | None | +| dropout | Fraction of neurons affected by Dropout, from 0 to 1. | 0 | True | None | +| batch_size | Number of time series (input and output) used in each training pass | 32 | True | None | +| s_end_date | The end date (format YYYY-MM-DD) to select for testing | None | True | None | +| s_start_date | The start date (format YYYY-MM-DD) to select for testing | None | True | None | +| learning_rate | Learning rate during training. | 0.001 | True | None | +| residuals | Show the residuals for the model. | False | True | None | +| forecast_only | Do not plot the historical data without forecasts. | False | True | None | +| export_pred_raw | Export predictions to a csv file. | False | True | None | + + +--- + +## Examples + +```python +2022 Jul 23, 10:36 (🦋) /forecast/ $ load GME_20220719_123734.csv -a GME + +2022 Jul 23, 11:03 (🦋) /forecast/ $ brnn GME +100%|███████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████| 115/115 [00:0700:00, 15.10it/s] +Block RNN model obtains MAPE: 17.09% + + + + Actual price: $ 146.64 +┏━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━┓ +┃ Datetime ┃ Prediction ┃ +┡━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━┩ +│ 2022-07-19 00:00:00 │ $ 147.89 │ +├─────────────────────┼────────────┤ +│ 2022-07-20 00:00:00 │ $ 149.11 │ +├─────────────────────┼────────────┤ +│ 2022-07-21 00:00:00 │ $ 149.59 │ +├─────────────────────┼────────────┤ +│ 2022-07-22 00:00:00 │ $ 141.46 │ +├─────────────────────┼────────────┤ +│ 2022-07-25 00:00:00 │ $ 144.99 │ +└─────────────────────┴────────────┘ +``` +![brnn](https://user-images.githubusercontent.com/72827203/180615365-1644ce7a-050e-4ee1-92c2-4518db14f53d.png) + +--- diff --git a/website/content/terminal/reference/forecast/clean.md b/website/content/terminal/reference/forecast/clean.md new file mode 100644 index 000000000000..9ae36e669b43 --- /dev/null +++ b/website/content/terminal/reference/forecast/clean.md @@ -0,0 +1,73 @@ +--- +title: clean +description: This documentation page provides information about how to clean a dataset + by filling and dropping NaN values. It also offers examples and descriptions of + different parameters. +keywords: +- data cleaning +- filling NaN values +- dropping NaN values +- data cleaning parameters +- dataset cleaning +- data processing +- usage examples +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Clean a dataset by filling and dropping NaN values. + +### Usage + +```python +clean [-f {rfill,cfill,rbfill,cbfill,rffill,bffill}] [--drop {rdrop,cdrop}] [-d {}] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| fill | The method of filling NaNs. This has options to fill rows (rfill, rbfill, rffill) or fill columns (cfill, cbfill, cffill). Furthermore, it has the option to forward fill and backward fill (up to --limit) which refer to how many rows/columns can be set equal to the last non-NaN value | | True | rfill, cfill, rbfill, cbfill, rffill, bffill | +| drop | The method of dropping NaNs. This either has the option rdrop (drop rows that contain NaNs) or cdrop (drop columns that contain NaNs) | | True | rdrop, cdrop | +| target_dataset | The name of the dataset you want to select | None | True | None | + + +--- + +## Examples + +```python +(🦋) /forecast/ $ show TSLA + +TSLA dataset has shape (row, column): (611, 7) + + Dataset TSLA | Showing 10 of 611 rows +┏━━━┳━━━━━━━━━━━━┳━━━━━━━━┳━━━━━━━━┳━━━━━━━━┳━━━━━━━━┳━━━━━━━━━━━┳━━━━━━━━━━━┓ +┃ ┃ date ┃ open ┃ high ┃ low ┃ close ┃ adj_close ┃ volume ┃ +┡━━━╇━━━━━━━━━━━━╇━━━━━━━━╇━━━━━━━━╇━━━━━━━━╇━━━━━━━━╇━━━━━━━━━━━╇━━━━━━━━━━━┩ +│ 0 │ 2020-01-02 │ 84.90 │ 86.14 │ 84.34 │ 86.05 │ 86.05 │ 47660500 │ +├───┼────────────┼────────┼────────┼────────┼────────┼───────────┼───────────┤ +│ 1 │ 2020-01-03 │ 88.10 │ 90.80 │ 87.38 │ 88.60 │ 88.60 │ 88892500 │ +├───┼────────────┼────────┼────────┼────────┼────────┼───────────┼───────────┤ +│ 2 │ 2020-01-06 │ 88.09 │ 90.31 │ 88.00 │ 90.31 │ 90.31 │ 50665000 │ +├───┼────────────┼────────┼────────┼────────┼────────┼───────────┼───────────┤ +│ 3 │ 2020-01-07 │ 92.28 │ 94.33 │ 90.67 │ 93.81 │ 93.81 │ 89410500 │ +├───┼────────────┼────────┼────────┼────────┼────────┼───────────┼───────────┤ +│ 4 │ 2020-01-08 │ 94.74 │ 99.70 │ 93.65 │ 98.43 │ 98.43 │ 155721500 │ +├───┼────────────┼────────┼────────┼────────┼────────┼───────────┼───────────┤ +│ 5 │ 2020-01-09 │ 99.42 │ 99.76 │ 94.57 │ 96.27 │ 96.27 │ 142202000 │ +├───┼────────────┼────────┼────────┼────────┼────────┼───────────┼───────────┤ +│ 6 │ 2020-01-10 │ 96.36 │ 96.99 │ 94.74 │ 95.63 │ 95.63 │ 64797500 │ +├───┼────────────┼────────┼────────┼────────┼────────┼───────────┼───────────┤ +│ 7 │ 2020-01-13 │ 98.70 │ 105.13 │ 98.40 │ 104.97 │ 104.97 │ 132588000 │ +├───┼────────────┼────────┼────────┼────────┼────────┼───────────┼───────────┤ +│ 8 │ 2020-01-14 │ 108.85 │ 109.48 │ 104.98 │ 107.58 │ 107.58 │ 144981000 │ +├───┼────────────┼────────┼────────┼────────┼────────┼───────────┼───────────┤ +│ 9 │ 2020-01-15 │ 105.95 │ 107.57 │ 103.36 │ 103.70 │ 103.70 │ 86844000 │ +└───┴────────────┴────────┴────────┴────────┴────────┴───────────┴───────────┘ +``` +--- diff --git a/website/content/terminal/reference/forecast/combine.md b/website/content/terminal/reference/forecast/combine.md new file mode 100644 index 000000000000..9dcd1cf50ce6 --- /dev/null +++ b/website/content/terminal/reference/forecast/combine.md @@ -0,0 +1,80 @@ +--- +title: combine +description: The page provides detailed instruction on how to use the 'combine' function + which is used to combine datasets or add specific columns to a dataset. This function + is used to streamline data analysis. +keywords: +- combine function +- data analysis +- combine datasets +- add columns +- dataset usage +- TSLA.csv +- MSFT.csv +- parameter usage +- docusaurus page +- dataset combination instructions +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Combine two entire datasets, or add specific columns. Add specificcolumns with the syntax: datasetX.column2,datasetY.column3 + +### Usage + +```python +combine [--dataset {--dataset,--columns,-c,--help,-h}] [-c COLUMNS] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| dataset | Dataset to add columns to | None | True | --dataset, --columns, -c, --help, -h | +| columns | The columns we want to add dataset.column,datasetb.column2 | None | True | None | + + +--- + +## Examples + +```python +(🦋) /forecast/ $ load TSLA.csv + +(🦋) /forecast/ $ load MSFT.csv + +(🦋) /forecast/ $ combine --dataset TSLA --columns MSFT.volume + +(🦋) /forecast/ $ show TSLA +TSLA dataset has shape (row, column): (611, 8) + + Dataset TSLA | Showing 10 of 611 rows +┏━━━┳━━━━━━━━━━━━┳━━━━━━━━┳━━━━━━━━┳━━━━━━━━┳━━━━━━━━┳━━━━━━━━━━━┳━━━━━━━━━━━┳━━━━━━━━━━━━━━━┓ +┃ ┃ date ┃ open ┃ high ┃ low ┃ close ┃ adj_close ┃ volume ┃ MSFT_volume ┃ +┡━━━╇━━━━━━━━━━━━╇━━━━━━━━╇━━━━━━━━╇━━━━━━━━╇━━━━━━━━╇━━━━━━━━━━━╇━━━━━━━━━━━╇━━━━━━━━━━━━━━━┩ +│ 0 │ 2020-01-02 │ 84.90 │ 86.14 │ 84.34 │ 86.05 │ 86.05 │ 47660500 │ 1359650900.00 │ +├───┼────────────┼────────┼────────┼────────┼────────┼───────────┼───────────┼───────────────┤ +│ 1 │ 2020-01-03 │ 88.10 │ 90.80 │ 87.38 │ 88.60 │ 88.60 │ 88892500 │ 1074643300.00 │ +├───┼────────────┼────────┼────────┼────────┼────────┼───────────┼───────────┼───────────────┤ +│ 2 │ 2020-01-06 │ 88.09 │ 90.31 │ 88.00 │ 90.31 │ 90.31 │ 50665000 │ 1110237200.00 │ +├───┼────────────┼────────┼────────┼────────┼────────┼───────────┼───────────┼───────────────┤ +│ 3 │ 2020-01-07 │ 92.28 │ 94.33 │ 90.67 │ 93.81 │ 93.81 │ 89410500 │ 1319029500.00 │ +├───┼────────────┼────────┼────────┼────────┼────────┼───────────┼───────────┼───────────────┤ +│ 4 │ 2020-01-08 │ 94.74 │ 99.70 │ 93.65 │ 98.43 │ 98.43 │ 155721500 │ 1720130200.00 │ +├───┼────────────┼────────┼────────┼────────┼────────┼───────────┼───────────┼───────────────┤ +│ 5 │ 2020-01-09 │ 99.42 │ 99.76 │ 94.57 │ 96.27 │ 96.27 │ 142202000 │ 1671811600.00 │ +├───┼────────────┼────────┼────────┼────────┼────────┼───────────┼───────────┼───────────────┤ +│ 6 │ 2020-01-10 │ 96.36 │ 96.99 │ 94.74 │ 95.63 │ 95.63 │ 64797500 │ 1408590600.00 │ +├───┼────────────┼────────┼────────┼────────┼────────┼───────────┼───────────┼───────────────┤ +│ 7 │ 2020-01-13 │ 98.70 │ 105.13 │ 98.40 │ 104.97 │ 104.97 │ 132588000 │ 1279372100.00 │ +├───┼────────────┼────────┼────────┼────────┼────────┼───────────┼───────────┼───────────────┤ +│ 8 │ 2020-01-14 │ 108.85 │ 109.48 │ 104.98 │ 107.58 │ 107.58 │ 144981000 │ 1273139500.00 │ +├───┼────────────┼────────┼────────┼────────┼────────┼───────────┼───────────┼───────────────┤ +│ 9 │ 2020-01-15 │ 105.95 │ 107.57 │ 103.36 │ 103.70 │ 103.70 │ 86844000 │ 1281432800.00 │ +└───┴────────────┴────────┴────────┴────────┴────────┴───────────┴───────────┴───────────────┘ +``` +--- diff --git a/website/content/terminal/reference/forecast/corr.md b/website/content/terminal/reference/forecast/corr.md new file mode 100644 index 000000000000..8c98ce4da6b1 --- /dev/null +++ b/website/content/terminal/reference/forecast/corr.md @@ -0,0 +1,48 @@ +--- +title: corr +description: The page provides information about the 'corr' function used to plot + correlation coefficients of a given dataset. It describes parameters, usage examples + and visual representation for a TSLA dataset. +keywords: +- corr +- plot correlation coefficients +- parameters +- dataset +- forecasting +- examples +- TSLA +- usage +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Plot correlation coefficients. + +### Usage + +```python +corr [-d {}] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| target_dataset | The name of the dataset you want to select | None | True | None | + + +--- + +## Examples + +```python +(🦋) /forecast/ $ load TSLA.csv + +(🦋) /forecast/ $ corr TSLA +TODO: screen shot +``` +--- diff --git a/website/content/terminal/reference/forecast/delete.md b/website/content/terminal/reference/forecast/delete.md new file mode 100644 index 000000000000..4dbf23779015 --- /dev/null +++ b/website/content/terminal/reference/forecast/delete.md @@ -0,0 +1,103 @@ +--- +title: delete +description: Learn how to delete a column from your dataset with straightforward commands, + enhancing your data management and analysis in Python. +keywords: +- delete column +- data management +- dataset +- data analysis +- command usage +- parameters +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +The column you want to delete from a dataset. + +### Usage + +```python +delete [--delete {}] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| delete | The columns you want to delete from a dataset. Use format: dataset.column or multiple with dataset.column,datasetb.column2 | None | True | None | + + +--- + +## Examples + +```python +(🦋) /forecast/ $ load TSLA.csv + +(🦋) /forecast/ $ roc TSLA +Successfully added 'ROC_10' to 'TSLA' dataset + +(🦋) /forecast/ $ show +TSLA dataset has shape (row, column): (611, 8) + + Dataset TSLA | Showing 10 of 611 rows +┏━━━┳━━━━━━━━━━━━┳━━━━━━━━┳━━━━━━━━┳━━━━━━━━┳━━━━━━━━┳━━━━━━━━━━━┳━━━━━━━━━━━┳━━━━━━━━┓ +┃ ┃ date ┃ open ┃ high ┃ low ┃ close ┃ adj_close ┃ volume ┃ ROC_10 ┃ +┡━━━╇━━━━━━━━━━━━╇━━━━━━━━╇━━━━━━━━╇━━━━━━━━╇━━━━━━━━╇━━━━━━━━━━━╇━━━━━━━━━━━╇━━━━━━━━┩ +│ 0 │ 2020-01-02 │ 84.90 │ 86.14 │ 84.34 │ 86.05 │ 86.05 │ 47660500 │ nan │ +├───┼────────────┼────────┼────────┼────────┼────────┼───────────┼───────────┼────────┤ +│ 1 │ 2020-01-03 │ 88.10 │ 90.80 │ 87.38 │ 88.60 │ 88.60 │ 88892500 │ nan │ +├───┼────────────┼────────┼────────┼────────┼────────┼───────────┼───────────┼────────┤ +│ 2 │ 2020-01-06 │ 88.09 │ 90.31 │ 88.00 │ 90.31 │ 90.31 │ 50665000 │ nan │ +├───┼────────────┼────────┼────────┼────────┼────────┼───────────┼───────────┼────────┤ +│ 3 │ 2020-01-07 │ 92.28 │ 94.33 │ 90.67 │ 93.81 │ 93.81 │ 89410500 │ nan │ +├───┼────────────┼────────┼────────┼────────┼────────┼───────────┼───────────┼────────┤ +│ 4 │ 2020-01-08 │ 94.74 │ 99.70 │ 93.65 │ 98.43 │ 98.43 │ 155721500 │ nan │ +├───┼────────────┼────────┼────────┼────────┼────────┼───────────┼───────────┼────────┤ +│ 5 │ 2020-01-09 │ 99.42 │ 99.76 │ 94.57 │ 96.27 │ 96.27 │ 142202000 │ nan │ +├───┼────────────┼────────┼────────┼────────┼────────┼───────────┼───────────┼────────┤ +│ 6 │ 2020-01-10 │ 96.36 │ 96.99 │ 94.74 │ 95.63 │ 95.63 │ 64797500 │ nan │ +├───┼────────────┼────────┼────────┼────────┼────────┼───────────┼───────────┼────────┤ +│ 7 │ 2020-01-13 │ 98.70 │ 105.13 │ 98.40 │ 104.97 │ 104.97 │ 132588000 │ nan │ +├───┼────────────┼────────┼────────┼────────┼────────┼───────────┼───────────┼────────┤ +│ 8 │ 2020-01-14 │ 108.85 │ 109.48 │ 104.98 │ 107.58 │ 107.58 │ 144981000 │ nan │ +├───┼────────────┼────────┼────────┼────────┼────────┼───────────┼───────────┼────────┤ +│ 9 │ 2020-01-15 │ 105.95 │ 107.57 │ 103.36 │ 103.70 │ 103.70 │ 86844000 │ 20.51 │ +└───┴────────────┴────────┴────────┴────────┴────────┴───────────┴───────────┴────────┘ + +(🦋) /forecast/ $ delete TSLA.ROC_10 + +(🦋) /forecast/ $ show TSLA +TSLA dataset has shape (row, column): (611, 7) + + Dataset TSLA | Showing 10 of 611 rows +┏━━━┳━━━━━━━━━━━━┳━━━━━━━━┳━━━━━━━━┳━━━━━━━━┳━━━━━━━━┳━━━━━━━━━━━┳━━━━━━━━━━━┓ +┃ ┃ date ┃ open ┃ high ┃ low ┃ close ┃ adj_close ┃ volume ┃ +┡━━━╇━━━━━━━━━━━━╇━━━━━━━━╇━━━━━━━━╇━━━━━━━━╇━━━━━━━━╇━━━━━━━━━━━╇━━━━━━━━━━━┩ +│ 0 │ 2020-01-02 │ 84.90 │ 86.14 │ 84.34 │ 86.05 │ 86.05 │ 47660500 │ +├───┼────────────┼────────┼────────┼────────┼────────┼───────────┼───────────┤ +│ 1 │ 2020-01-03 │ 88.10 │ 90.80 │ 87.38 │ 88.60 │ 88.60 │ 88892500 │ +├───┼────────────┼────────┼────────┼────────┼────────┼───────────┼───────────┤ +│ 2 │ 2020-01-06 │ 88.09 │ 90.31 │ 88.00 │ 90.31 │ 90.31 │ 50665000 │ +├───┼────────────┼────────┼────────┼────────┼────────┼───────────┼───────────┤ +│ 3 │ 2020-01-07 │ 92.28 │ 94.33 │ 90.67 │ 93.81 │ 93.81 │ 89410500 │ +├───┼────────────┼────────┼────────┼────────┼────────┼───────────┼───────────┤ +│ 4 │ 2020-01-08 │ 94.74 │ 99.70 │ 93.65 │ 98.43 │ 98.43 │ 155721500 │ +├───┼────────────┼────────┼────────┼────────┼────────┼───────────┼───────────┤ +│ 5 │ 2020-01-09 │ 99.42 │ 99.76 │ 94.57 │ 96.27 │ 96.27 │ 142202000 │ +├───┼────────────┼────────┼────────┼────────┼────────┼───────────┼───────────┤ +│ 6 │ 2020-01-10 │ 96.36 │ 96.99 │ 94.74 │ 95.63 │ 95.63 │ 64797500 │ +├───┼────────────┼────────┼────────┼────────┼────────┼───────────┼───────────┤ +│ 7 │ 2020-01-13 │ 98.70 │ 105.13 │ 98.40 │ 104.97 │ 104.97 │ 132588000 │ +├───┼────────────┼────────┼────────┼────────┼────────┼───────────┼───────────┤ +│ 8 │ 2020-01-14 │ 108.85 │ 109.48 │ 104.98 │ 107.58 │ 107.58 │ 144981000 │ +├───┼────────────┼────────┼────────┼────────┼────────┼───────────┼───────────┤ +│ 9 │ 2020-01-15 │ 105.95 │ 107.57 │ 103.36 │ 103.70 │ 103.70 │ 86844000 │ +└───┴────────────┴────────┴────────┴────────┴────────┴───────────┴───────────┘ +``` +--- diff --git a/website/content/terminal/reference/forecast/delta.md b/website/content/terminal/reference/forecast/delta.md new file mode 100644 index 000000000000..057165afa729 --- /dev/null +++ b/website/content/terminal/reference/forecast/delta.md @@ -0,0 +1,78 @@ +--- +title: delta +description: Documentation related to Delta, a function that adds percentage change + to a selected dataset column. The page gives an overview of the function usage, + parameters and examples +keywords: +- Delta function +- Dataset +- Column specific change +- Data analysis +- Forecasting +- Command line parameters +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Add %Change (Delta) to dataset based on specific column. + +### Usage + +```python +delta [-d {}] [-c TARGET_COLUMN] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| target_dataset | The name of the dataset you want to select | None | True | None | +| target_column | The name of the specific column you want to use | close | True | None | + + +--- + +## Examples + +```python +(🦋) /forecast/ $ load aapl_20220628_113243.csv + +(🦋) /forecast/ $ delta aapl_20220628_113243 +Successfully added 'Delta_close' to 'aapl_20220628_113243' dataset + +(🦋) /forecast/ $ delta aapl_20220628_113243 -c volume +Successfully added 'Delta_volume' to 'aapl_20220628_113243' dataset + +(🦋) /forecast/ $ show aapl_20220628_113243 +aapl_20220628_113243 dataset has shape (row, column): (759, 10) + + Dataset aapl_20220628_113243 | Showing 10 of 759 rows +┏━━━┳━━━━━━━━━━━━┳━━━━━━━━━━━━┳━━━━━━━┳━━━━━━━┳━━━━━━━┳━━━━━━━┳━━━━━━━━━━━┳━━━━━━━━━━━┳━━━━━━━━━━━━━┳━━━━━━━━━━━━━━┓ +┃ ┃ unnamed:_0 ┃ date ┃ open ┃ high ┃ low ┃ close ┃ adj_close ┃ volume ┃ delta_close ┃ delta_volume ┃ +┡━━━╇━━━━━━━━━━━━╇━━━━━━━━━━━━╇━━━━━━━╇━━━━━━━╇━━━━━━━╇━━━━━━━╇━━━━━━━━━━━╇━━━━━━━━━━━╇━━━━━━━━━━━━━╇━━━━━━━━━━━━━━┩ +│ 0 │ 0 │ 2019-06-10 │ 47.95 │ 48.84 │ 47.90 │ 48.15 │ 46.99 │ 104883600 │ 0.00 │ 0.00 │ +├───┼────────────┼────────────┼───────┼───────┼───────┼───────┼───────────┼───────────┼─────────────┼──────────────┤ +│ 1 │ 1 │ 2019-06-11 │ 48.72 │ 49.00 │ 48.40 │ 48.70 │ 47.53 │ 107731600 │ 0.01 │ 0.03 │ +├───┼────────────┼────────────┼───────┼───────┼───────┼───────┼───────────┼───────────┼─────────────┼──────────────┤ +│ 2 │ 2 │ 2019-06-12 │ 48.49 │ 48.99 │ 48.35 │ 48.55 │ 47.38 │ 73012800 │ -0.00 │ -0.32 │ +├───┼────────────┼────────────┼───────┼───────┼───────┼───────┼───────────┼───────────┼─────────────┼──────────────┤ +│ 3 │ 3 │ 2019-06-13 │ 48.67 │ 49.20 │ 48.40 │ 48.54 │ 47.37 │ 86698400 │ -0.00 │ 0.19 │ +├───┼────────────┼────────────┼───────┼───────┼───────┼───────┼───────────┼───────────┼─────────────┼──────────────┤ +│ 4 │ 4 │ 2019-06-14 │ 47.89 │ 48.40 │ 47.58 │ 48.19 │ 47.03 │ 75046000 │ -0.01 │ -0.13 │ +├───┼────────────┼────────────┼───────┼───────┼───────┼───────┼───────────┼───────────┼─────────────┼──────────────┤ +│ 5 │ 5 │ 2019-06-17 │ 48.22 │ 48.74 │ 48.04 │ 48.47 │ 47.31 │ 58676400 │ 0.01 │ -0.22 │ +├───┼────────────┼────────────┼───────┼───────┼───────┼───────┼───────────┼───────────┼─────────────┼──────────────┤ +│ 6 │ 6 │ 2019-06-18 │ 49.01 │ 50.07 │ 48.80 │ 49.61 │ 48.42 │ 106204000 │ 0.02 │ 0.81 │ +├───┼────────────┼────────────┼───────┼───────┼───────┼───────┼───────────┼───────────┼─────────────┼──────────────┤ +│ 7 │ 7 │ 2019-06-19 │ 49.92 │ 49.97 │ 49.33 │ 49.47 │ 48.28 │ 84496800 │ -0.00 │ -0.20 │ +├───┼────────────┼────────────┼───────┼───────┼───────┼───────┼───────────┼───────────┼─────────────┼──────────────┤ +│ 8 │ 8 │ 2019-06-20 │ 50.09 │ 50.15 │ 49.51 │ 49.87 │ 48.67 │ 86056000 │ 0.01 │ 0.02 │ +├───┼────────────┼────────────┼───────┼───────┼───────┼───────┼───────────┼───────────┼─────────────┼──────────────┤ +│ 9 │ 9 │ 2019-06-21 │ 49.70 │ 50.21 │ 49.54 │ 49.69 │ 48.50 │ 191202400 │ -0.00 │ 1.22 │ +└───┴────────────┴────────────┴───────┴───────┴───────┴───────┴───────────┴───────────┴─────────────┴──────────────┘ +``` +--- diff --git a/website/content/terminal/reference/forecast/desc.md b/website/content/terminal/reference/forecast/desc.md new file mode 100644 index 000000000000..62ba046d3385 --- /dev/null +++ b/website/content/terminal/reference/forecast/desc.md @@ -0,0 +1,67 @@ +--- +title: desc +description: A page detailing how to use the 'desc' function to show descriptive statistics + of a dataset, including parameters and usage examples. +keywords: +- dataset +- descriptive statistics +- data analysis +- query commands +- data visualization +- data loading +- TSLA +- usage examples +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Show descriptive statistics of a dataset + +### Usage + +```python +desc [-d {}] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| target_dataset | The name of the dataset you want to select | None | True | None | + + +--- + +## Examples + +```python +(🦋) /forecast/ $ load TSLA.csv + +(🦋) /forecast/ $ desc TSLA + + Showing Descriptive Statistics for Dataset TSLA +┏━━━━━━━┳━━━━━━━━━┳━━━━━━━━━┳━━━━━━━━━┳━━━━━━━━━┳━━━━━━━━━━━┳━━━━━━━━━━━━━━┓ +┃ ┃ open ┃ high ┃ low ┃ close ┃ adj_close ┃ volume ┃ +┡━━━━━━━╇━━━━━━━━━╇━━━━━━━━━╇━━━━━━━━━╇━━━━━━━━━╇━━━━━━━━━━━╇━━━━━━━━━━━━━━┩ +│ count │ 611.00 │ 611.00 │ 611.00 │ 611.00 │ 611.00 │ 611.00 │ +├───────┼─────────┼─────────┼─────────┼─────────┼───────────┼──────────────┤ +│ mean │ 599.50 │ 613.65 │ 583.85 │ 599.19 │ 599.19 │ 47275047.14 │ +├───────┼─────────┼─────────┼─────────┼─────────┼───────────┼──────────────┤ +│ std │ 308.73 │ 315.33 │ 300.77 │ 307.95 │ 307.95 │ 35945322.23 │ +├───────┼─────────┼─────────┼─────────┼─────────┼───────────┼──────────────┤ +│ min │ 74.94 │ 80.97 │ 70.10 │ 72.24 │ 72.24 │ 9800600.00 │ +├───────┼─────────┼─────────┼─────────┼─────────┼───────────┼──────────────┤ +│ 25% │ 325.09 │ 332.00 │ 304.80 │ 316.07 │ 316.07 │ 23386000.00 │ +├───────┼─────────┼─────────┼─────────┼─────────┼───────────┼──────────────┤ +│ 50% │ 661.42 │ 672.00 │ 644.60 │ 659.58 │ 659.58 │ 33337300.00 │ +├───────┼─────────┼─────────┼─────────┼─────────┼───────────┼──────────────┤ +│ 75% │ 830.71 │ 846.82 │ 801.99 │ 822.97 │ 822.97 │ 62445150.00 │ +├───────┼─────────┼─────────┼─────────┼─────────┼───────────┼──────────────┤ +│ max │ 1234.41 │ 1243.49 │ 1217.00 │ 1229.91 │ 1229.91 │ 304694000.00 │ +└───────┴─────────┴─────────┴─────────┴─────────┴───────────┴──────────────┘ +``` +--- diff --git a/website/content/terminal/reference/forecast/ema.md b/website/content/terminal/reference/forecast/ema.md new file mode 100644 index 000000000000..b42562c76441 --- /dev/null +++ b/website/content/terminal/reference/forecast/ema.md @@ -0,0 +1,107 @@ +--- +title: ema +description: Documentation for the 'ema' tool that allows the addition of an exponential + moving average to a dataset based on a specific column. Explains usage, parameters, + and gives practical examples. +keywords: +- ema +- exponential moving average +- dataset +- column +- target_column +- period +- usage +- parameters +- examples +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Add exponential moving average to dataset based on specific column. + +### Usage + +```python +ema [-d {}] [-c TARGET_COLUMN] [--period PERIOD] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| target_dataset | The name of the dataset you want to select | None | True | None | +| target_column | The name of the specific column you want to use | close | True | None | +| period | The period to use | 10 | True | None | + + +--- + +## Examples + +```python +(🦋) /forecast/ $ load TSLA.csv + +(🦋) /forecast/ $ show TSLA +TSLA dataset has shape (row, column): (611, 7) + + Dataset TSLA | Showing 10 of 611 rows +┏━━━┳━━━━━━━━━━━━┳━━━━━━━━┳━━━━━━━━┳━━━━━━━━┳━━━━━━━━┳━━━━━━━━━━━┳━━━━━━━━━━━┓ +┃ ┃ date ┃ open ┃ high ┃ low ┃ close ┃ adj_close ┃ volume ┃ +┡━━━╇━━━━━━━━━━━━╇━━━━━━━━╇━━━━━━━━╇━━━━━━━━╇━━━━━━━━╇━━━━━━━━━━━╇━━━━━━━━━━━┩ +│ 0 │ 2020-01-02 │ 84.90 │ 86.14 │ 84.34 │ 86.05 │ 86.05 │ 47660500 │ +├───┼────────────┼────────┼────────┼────────┼────────┼───────────┼───────────┤ +│ 1 │ 2020-01-03 │ 88.10 │ 90.80 │ 87.38 │ 88.60 │ 88.60 │ 88892500 │ +├───┼────────────┼────────┼────────┼────────┼────────┼───────────┼───────────┤ +│ 2 │ 2020-01-06 │ 88.09 │ 90.31 │ 88.00 │ 90.31 │ 90.31 │ 50665000 │ +├───┼────────────┼────────┼────────┼────────┼────────┼───────────┼───────────┤ +│ 3 │ 2020-01-07 │ 92.28 │ 94.33 │ 90.67 │ 93.81 │ 93.81 │ 89410500 │ +├───┼────────────┼────────┼────────┼────────┼────────┼───────────┼───────────┤ +│ 4 │ 2020-01-08 │ 94.74 │ 99.70 │ 93.65 │ 98.43 │ 98.43 │ 155721500 │ +├───┼────────────┼────────┼────────┼────────┼────────┼───────────┼───────────┤ +│ 5 │ 2020-01-09 │ 99.42 │ 99.76 │ 94.57 │ 96.27 │ 96.27 │ 142202000 │ +├───┼────────────┼────────┼────────┼────────┼────────┼───────────┼───────────┤ +│ 6 │ 2020-01-10 │ 96.36 │ 96.99 │ 94.74 │ 95.63 │ 95.63 │ 64797500 │ +├───┼────────────┼────────┼────────┼────────┼────────┼───────────┼───────────┤ +│ 7 │ 2020-01-13 │ 98.70 │ 105.13 │ 98.40 │ 104.97 │ 104.97 │ 132588000 │ +├───┼────────────┼────────┼────────┼────────┼────────┼───────────┼───────────┤ +│ 8 │ 2020-01-14 │ 108.85 │ 109.48 │ 104.98 │ 107.58 │ 107.58 │ 144981000 │ +├───┼────────────┼────────┼────────┼────────┼────────┼───────────┼───────────┤ +│ 9 │ 2020-01-15 │ 105.95 │ 107.57 │ 103.36 │ 103.70 │ 103.70 │ 86844000 │ +└───┴────────────┴────────┴────────┴────────┴────────┴───────────┴───────────┘ + +(🦋) /forecast/ $ ema TSLA +Successfully added 'EMA_10' to 'TSLA' dataset + +(🦋) /forecast/ $ show TSLA +TSLA dataset has shape (row, column): (611, 8) + + Dataset TSLA | Showing 10 of 611 rows +┏━━━┳━━━━━━━━━━━━┳━━━━━━━━┳━━━━━━━━┳━━━━━━━━┳━━━━━━━━┳━━━━━━━━━━━┳━━━━━━━━━━━┳━━━━━━━━┓ +┃ ┃ date ┃ open ┃ high ┃ low ┃ close ┃ adj_close ┃ volume ┃ EMA_10 ┃ +┡━━━╇━━━━━━━━━━━━╇━━━━━━━━╇━━━━━━━━╇━━━━━━━━╇━━━━━━━━╇━━━━━━━━━━━╇━━━━━━━━━━━╇━━━━━━━━┩ +│ 0 │ 2020-01-02 │ 84.90 │ 86.14 │ 84.34 │ 86.05 │ 86.05 │ 47660500 │ 86.05 │ +├───┼────────────┼────────┼────────┼────────┼────────┼───────────┼───────────┼────────┤ +│ 1 │ 2020-01-03 │ 88.10 │ 90.80 │ 87.38 │ 88.60 │ 88.60 │ 88892500 │ 86.52 │ +├───┼────────────┼────────┼────────┼────────┼────────┼───────────┼───────────┼────────┤ +│ 2 │ 2020-01-06 │ 88.09 │ 90.31 │ 88.00 │ 90.31 │ 90.31 │ 50665000 │ 87.21 │ +├───┼────────────┼────────┼────────┼────────┼────────┼───────────┼───────────┼────────┤ +│ 3 │ 2020-01-07 │ 92.28 │ 94.33 │ 90.67 │ 93.81 │ 93.81 │ 89410500 │ 88.41 │ +├───┼────────────┼────────┼────────┼────────┼────────┼───────────┼───────────┼────────┤ +│ 4 │ 2020-01-08 │ 94.74 │ 99.70 │ 93.65 │ 98.43 │ 98.43 │ 155721500 │ 90.23 │ +├───┼────────────┼────────┼────────┼────────┼────────┼───────────┼───────────┼────────┤ +│ 5 │ 2020-01-09 │ 99.42 │ 99.76 │ 94.57 │ 96.27 │ 96.27 │ 142202000 │ 91.33 │ +├───┼────────────┼────────┼────────┼────────┼────────┼───────────┼───────────┼────────┤ +│ 6 │ 2020-01-10 │ 96.36 │ 96.99 │ 94.74 │ 95.63 │ 95.63 │ 64797500 │ 92.11 │ +├───┼────────────┼────────┼────────┼────────┼────────┼───────────┼───────────┼────────┤ +│ 7 │ 2020-01-13 │ 98.70 │ 105.13 │ 98.40 │ 104.97 │ 104.97 │ 132588000 │ 94.45 │ +├───┼────────────┼────────┼────────┼────────┼────────┼───────────┼───────────┼────────┤ +│ 8 │ 2020-01-14 │ 108.85 │ 109.48 │ 104.98 │ 107.58 │ 107.58 │ 144981000 │ 96.84 │ +├───┼────────────┼────────┼────────┼────────┼────────┼───────────┼───────────┼────────┤ +│ 9 │ 2020-01-15 │ 105.95 │ 107.57 │ 103.36 │ 103.70 │ 103.70 │ 86844000 │ 98.08 │ +└───┴────────────┴────────┴────────┴────────┴────────┴───────────┴───────────┴────────┘ +``` +--- diff --git a/website/content/terminal/reference/forecast/expo.md b/website/content/terminal/reference/forecast/expo.md new file mode 100644 index 000000000000..c14b9e566584 --- /dev/null +++ b/website/content/terminal/reference/forecast/expo.md @@ -0,0 +1,90 @@ +--- +title: expo +description: This page provides a comprehensive guide to the expo usage for executing + a Probabilistic Exponential Smoothing forecast. Parameters and their usage are laid + out, along with examples for reference. +keywords: +- Probabilistic Exponential Smoothing +- forecast +- expo +- trend +- dampen +- naive +- target_column +- n_days +- seasonal_periods +- start_window +- s_end_date +- s_start_date +- residuals +- forecast_only +- export_pred_raw +- parameters +- usage examples +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Perform Probabilistic Exponential Smoothing forecast: https://unit8co.github.io/darts/generated_api/darts.models.forecasting.exponential_smoothing.html + +### Usage + +```python +expo [--trend {N,A,M}] [--dampen DAMPEN] [--naive] [-d {}] [-c TARGET_COLUMN] [-n N_DAYS] [-s {N,A,M}] [-p SEASONAL_PERIODS] [-w START_WINDOW] [--end S_END_DATE] [--start S_START_DATE] [--residuals] [--forecast-only] [--export-pred-raw] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| trend | Trend: N: None, A: Additive, M: Multiplicative. | A | True | N, A, M | +| dampen | Dampening | F | True | None | +| naive | Show the naive baseline for a model. | False | True | None | +| target_dataset | The name of the dataset you want to select | None | True | None | +| target_column | The name of the specific column you want to use | close | True | None | +| n_days | prediction days. | 5 | True | None | +| seasonal | Seasonality: N: None, A: Additive, M: Multiplicative. | A | True | N, A, M | +| seasonal_periods | Seasonal periods: 4: Quarterly, 7: Daily | 7 | True | None | +| start_window | Start point for rolling training and forecast window. 0.0-1.0 | 0.85 | True | None | +| s_end_date | The end date (format YYYY-MM-DD) to select for testing | None | True | None | +| s_start_date | The start date (format YYYY-MM-DD) to select for testing | None | True | None | +| residuals | Show the residuals for the model. | False | True | None | +| forecast_only | Do not plot the historical data without forecasts. | False | True | None | +| export_pred_raw | Export predictions to a csv file. | False | True | None | + + +--- + +## Examples + +```python +2022 Jul 23, 10:36 (🦋) /forecast/ $ load GME_20220719_123734.csv -a GME + +2022 Jul 23, 10:52 (🦋) /forecast/ $ expo GME +100%|███████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████| 115/115 [00:1600:00, 6.80it/s] +Exponential smoothing obtains MAPE: 12.88% + + + + Actual price: $ 146.64 +┏━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━┓ +┃ Datetime ┃ Prediction ┃ +┡━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━┩ +│ 2022-07-19 00:00:00 │ $ 146.35 │ +├─────────────────────┼────────────┤ +│ 2022-07-20 00:00:00 │ $ 148.63 │ +├─────────────────────┼────────────┤ +│ 2022-07-21 00:00:00 │ $ 148.86 │ +├─────────────────────┼────────────┤ +│ 2022-07-22 00:00:00 │ $ 151.76 │ +├─────────────────────┼────────────┤ +│ 2022-07-25 00:00:00 │ $ 149.74 │ +└─────────────────────┴────────────┘ +``` +![expo](https://user-images.githubusercontent.com/72827203/180615313-e45d6cb3-06a8-45aa-ae4e-505df07e7210.png) + +--- diff --git a/website/content/terminal/reference/forecast/export.md b/website/content/terminal/reference/forecast/export.md new file mode 100644 index 000000000000..2cb0a346af18 --- /dev/null +++ b/website/content/terminal/reference/forecast/export.md @@ -0,0 +1,52 @@ +--- +title: export +description: Page providing a guide on how to use the 'export' feature of a data-focused + application, which allows exporting datasets to Excel or CSV formats. +keywords: +- export data guide +- export dataset +- export to Excel +- export to CSV +- data-focused application +- data exporting +- dataset handling +- dataset operation +- automation +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Export dataset to Excel + +### Usage + +```python +export [-t {xlsx,csv}] [-d {}] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| type | The file type you wish to export to | xlsx | True | xlsx, csv | +| target_dataset | The name of the dataset you want to select | None | True | None | + + +--- + +## Examples + +```python +(🦋) /forecast/ $ load aapl + +(🦋) /forecast/ $ ema aapl +Successfully added 'EMA_10' to 'aapl' dataset + +(🦋) /forecast/ $ export aapl +Saved file: .../OpenBBTerminal/exports/forecast/aapl_20220711_151219.xlsx +``` +--- diff --git a/website/content/terminal/reference/forecast/linregr.md b/website/content/terminal/reference/forecast/linregr.md new file mode 100644 index 000000000000..46c57e634538 --- /dev/null +++ b/website/content/terminal/reference/forecast/linregr.md @@ -0,0 +1,84 @@ +--- +title: linregr +description: This documentation page details how to use and implement the 'linregr' + function for performing linear regression forecasts. It includes descriptive parameters, + usage examples, and result interpretations. +keywords: +- docusaurus +- linear regression +- forecasting +- linregr +- parameters +- usage +- examples +- metadata +- data science +- machine learning +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Perform a linear regression forecast: https://unit8co.github.io/darts/generated_api/darts.models.forecasting.linear_regression_model.html + +### Usage + +```python +linregr [--past-covariates PAST_COVARIATES] [--all-past-covariates] [--naive] [-d {}] [-c TARGET_COLUMN] [-n N_DAYS] [-t TRAIN_SPLIT] [-o OUTPUT_CHUNK_LENGTH] [--end S_END_DATE] [--start S_START_DATE] [--lags LAGS] [--residuals] [--forecast-only] [--explainability-raw] [--export-pred-raw] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| past_covariates | Past covariates(columns/features) in same dataset. Comma separated. | None | True | None | +| all_past_covariates | Adds all rows as past covariates except for date and the target column. | False | True | None | +| naive | Show the naive baseline for a model. | False | True | None | +| target_dataset | The name of the dataset you want to select | None | True | None | +| target_column | The name of the specific column you want to use | close | True | None | +| n_days | prediction days. | 5 | True | None | +| train_split | Start point for rolling training and forecast window. 0.0-1.0 | 0.85 | True | None | +| output_chunk_length | The length of the forecast of the model. | 5 | True | None | +| s_end_date | The end date (format YYYY-MM-DD) to select for testing | None | True | None | +| s_start_date | The start date (format YYYY-MM-DD) to select for testing | None | True | None | +| lags | Lagged target values used to predict the next time step. | 14 | True | None | +| residuals | Show the residuals for the model. | False | True | None | +| forecast_only | Do not plot the historical data without forecasts. | False | True | None | +| explainability_raw | Prints out a raw dataframe showing explainability results. | False | True | None | +| export_pred_raw | Export predictions to a csv file. | False | True | None | + + +--- + +## Examples + +```python +2022 Jul 23, 10:36 (🦋) /forecast/ $ load GME_20220719_123734.csv -a GME + +2022 Jul 23, 11:03 (🦋) /forecast/ $ linregr GME +100%|███████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████| 115/115 [00:0700:00, 15.10it/s] +Logistic Regression model obtains MAPE: 10.85% + + + + Actual price: $ 146.64 +┏━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━┓ +┃ Datetime ┃ Prediction ┃ +┡━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━┩ +│ 2022-07-19 00:00:00 │ $ 144.41 │ +├─────────────────────┼────────────┤ +│ 2022-07-20 00:00:00 │ $ 142.69 │ +├─────────────────────┼────────────┤ +│ 2022-07-21 00:00:00 │ $ 140.94 │ +├─────────────────────┼────────────┤ +│ 2022-07-22 00:00:00 │ $ 139.89 │ +├─────────────────────┼────────────┤ +│ 2022-07-25 00:00:00 │ $ 136.04 │ +└─────────────────────┴────────────┘ +``` +![linregr](https://user-images.githubusercontent.com/72827203/180615335-26395da8-3848-40f4-a68b-d2c14475db95.png) + +--- diff --git a/website/content/terminal/reference/forecast/load.md b/website/content/terminal/reference/forecast/load.md new file mode 100644 index 000000000000..d8aa33fbb7fe --- /dev/null +++ b/website/content/terminal/reference/forecast/load.md @@ -0,0 +1,73 @@ +--- +title: load +description: This page details how to use the 'load' command to bring custom datasets + into your forecasting tool. It gives usage instructions, parameter descriptions, + and examples. +keywords: +- load command +- custom dataset +- data import +- data forecasting tool +- command usage +- command parameters +- command examples +- data forecasting examples +- custom import +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Load custom dataset (from previous export, custom imports). + +### Usage + +```python +load [-f {}] [-a ALIAS] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| file | File to load data in (can be custom import, may have been exported before.) | None | True | None | +| alias | Alias name to give to the dataset | None | True | None | + + +--- + +## Examples + +```python +(🦋) /forecast/ $ load aapl.csv + +(🦋) /forecast/ $ show aapl + Dataset aapl | Showing 10 of 759 rows +┏━━━┳━━━━━━━━━━━━┳━━━━━━━┳━━━━━━━┳━━━━━━━┳━━━━━━━┳━━━━━━━━━━━┳━━━━━━━━━━━┓ +┃ ┃ date ┃ open ┃ high ┃ low ┃ close ┃ adj_close ┃ volume ┃ +┡━━━╇━━━━━━━━━━━━╇━━━━━━━╇━━━━━━━╇━━━━━━━╇━━━━━━━╇━━━━━━━━━━━╇━━━━━━━━━━━┩ +│ 0 │ 2019-06-10 │ 47.95 │ 48.84 │ 47.90 │ 48.15 │ 46.99 │ 104883600 │ +├───┼────────────┼───────┼───────┼───────┼───────┼───────────┼───────────┤ +│ 1 │ 2019-06-11 │ 48.72 │ 49.00 │ 48.40 │ 48.70 │ 47.53 │ 107731600 │ +├───┼────────────┼───────┼───────┼───────┼───────┼───────────┼───────────┤ +│ 2 │ 2019-06-12 │ 48.49 │ 48.99 │ 48.35 │ 48.55 │ 47.38 │ 73012800 │ +├───┼────────────┼───────┼───────┼───────┼───────┼───────────┼───────────┤ +│ 3 │ 2019-06-13 │ 48.67 │ 49.20 │ 48.40 │ 48.54 │ 47.37 │ 86698400 │ +├───┼────────────┼───────┼───────┼───────┼───────┼───────────┼───────────┤ +│ 4 │ 2019-06-14 │ 47.89 │ 48.40 │ 47.58 │ 48.19 │ 47.03 │ 75046000 │ +├───┼────────────┼───────┼───────┼───────┼───────┼───────────┼───────────┤ +│ 5 │ 2019-06-17 │ 48.22 │ 48.74 │ 48.04 │ 48.47 │ 47.31 │ 58676400 │ +├───┼────────────┼───────┼───────┼───────┼───────┼───────────┼───────────┤ +│ 6 │ 2019-06-18 │ 49.01 │ 50.07 │ 48.80 │ 49.61 │ 48.42 │ 106204000 │ +├───┼────────────┼───────┼───────┼───────┼───────┼───────────┼───────────┤ +│ 7 │ 2019-06-19 │ 49.92 │ 49.97 │ 49.33 │ 49.47 │ 48.28 │ 84496800 │ +├───┼────────────┼───────┼───────┼───────┼───────┼───────────┼───────────┤ +│ 8 │ 2019-06-20 │ 50.09 │ 50.15 │ 49.51 │ 49.87 │ 48.67 │ 86056000 │ +├───┼────────────┼───────┼───────┼───────┼───────┼───────────┼───────────┤ +│ 9 │ 2019-06-21 │ 49.70 │ 50.21 │ 49.54 │ 49.69 │ 48.50 │ 191202400 │ +└───┴────────────┴───────┴───────┴───────┴───────┴───────────┴───────────┘ +``` +--- diff --git a/website/content/terminal/reference/forecast/mom.md b/website/content/terminal/reference/forecast/mom.md new file mode 100644 index 000000000000..9dfc998ca1d8 --- /dev/null +++ b/website/content/terminal/reference/forecast/mom.md @@ -0,0 +1,136 @@ +--- +title: mom +description: For the 'mom' function in a forecasting tool, this page discusses its + usage in Python, along with parameters and their values. Various examples of its + application on a TSLA dataset are illustrated to demonstrate the addition and cleaning + of a 'Momentum_10' column. +keywords: +- forecasting tool +- add momentum +- Python function usage +- dataset handling +- TSLA dataset +- usage examples +- parameters +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Add momentum to dataset based on specific column. + +### Usage + +```python +mom [-d {}] [-c TARGET_COLUMN] [--period PERIOD] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| target_dataset | The name of the dataset you want to select | None | True | None | +| target_column | The name of the specific column you want to use | close | True | None | +| period | The period to use | 10 | True | None | + + +--- + +## Examples + +```python +(🦋) /forecast/ $ show TSLA +TSLA dataset has shape (row, column): (611, 7) + + Dataset TSLA | Showing 10 of 611 rows +┏━━━┳━━━━━━━━━━━━┳━━━━━━━━┳━━━━━━━━┳━━━━━━━━┳━━━━━━━━┳━━━━━━━━━━━┳━━━━━━━━━━━┓ +┃ ┃ date ┃ open ┃ high ┃ low ┃ close ┃ adj_close ┃ volume ┃ +┡━━━╇━━━━━━━━━━━━╇━━━━━━━━╇━━━━━━━━╇━━━━━━━━╇━━━━━━━━╇━━━━━━━━━━━╇━━━━━━━━━━━┩ +│ 0 │ 2020-01-02 │ 84.90 │ 86.14 │ 84.34 │ 86.05 │ 86.05 │ 47660500 │ +├───┼────────────┼────────┼────────┼────────┼────────┼───────────┼───────────┤ +│ 1 │ 2020-01-03 │ 88.10 │ 90.80 │ 87.38 │ 88.60 │ 88.60 │ 88892500 │ +├───┼────────────┼────────┼────────┼────────┼────────┼───────────┼───────────┤ +│ 2 │ 2020-01-06 │ 88.09 │ 90.31 │ 88.00 │ 90.31 │ 90.31 │ 50665000 │ +├───┼────────────┼────────┼────────┼────────┼────────┼───────────┼───────────┤ +│ 3 │ 2020-01-07 │ 92.28 │ 94.33 │ 90.67 │ 93.81 │ 93.81 │ 89410500 │ +├───┼────────────┼────────┼────────┼────────┼────────┼───────────┼───────────┤ +│ 4 │ 2020-01-08 │ 94.74 │ 99.70 │ 93.65 │ 98.43 │ 98.43 │ 155721500 │ +├───┼────────────┼────────┼────────┼────────┼────────┼───────────┼───────────┤ +│ 5 │ 2020-01-09 │ 99.42 │ 99.76 │ 94.57 │ 96.27 │ 96.27 │ 142202000 │ +├───┼────────────┼────────┼────────┼────────┼────────┼───────────┼───────────┤ +│ 6 │ 2020-01-10 │ 96.36 │ 96.99 │ 94.74 │ 95.63 │ 95.63 │ 64797500 │ +├───┼────────────┼────────┼────────┼────────┼────────┼───────────┼───────────┤ +│ 7 │ 2020-01-13 │ 98.70 │ 105.13 │ 98.40 │ 104.97 │ 104.97 │ 132588000 │ +├───┼────────────┼────────┼────────┼────────┼────────┼───────────┼───────────┤ +│ 8 │ 2020-01-14 │ 108.85 │ 109.48 │ 104.98 │ 107.58 │ 107.58 │ 144981000 │ +├───┼────────────┼────────┼────────┼────────┼────────┼───────────┼───────────┤ +│ 9 │ 2020-01-15 │ 105.95 │ 107.57 │ 103.36 │ 103.70 │ 103.70 │ 86844000 │ +└───┴────────────┴────────┴────────┴────────┴────────┴───────────┴───────────┘ + +(🦋) /forecast/ $ mom TSLA +Successfully added 'Momentum_10' to 'TSLA' dataset + +(🦋) /forecast/ $ show TSLA +TSLA dataset has shape (row, column): (611, 8) + + Dataset TSLA | Showing 10 of 611 rows +┏━━━┳━━━━━━━━━━━━┳━━━━━━━━┳━━━━━━━━┳━━━━━━━━┳━━━━━━━━┳━━━━━━━━━━━┳━━━━━━━━━━━┳━━━━━━━━━━━━━┓ +┃ ┃ date ┃ open ┃ high ┃ low ┃ close ┃ adj_close ┃ volume ┃ Momentum_10 ┃ +┡━━━╇━━━━━━━━━━━━╇━━━━━━━━╇━━━━━━━━╇━━━━━━━━╇━━━━━━━━╇━━━━━━━━━━━╇━━━━━━━━━━━╇━━━━━━━━━━━━━┩ +│ 0 │ 2020-01-02 │ 84.90 │ 86.14 │ 84.34 │ 86.05 │ 86.05 │ 47660500 │ nan │ +├───┼────────────┼────────┼────────┼────────┼────────┼───────────┼───────────┼─────────────┤ +│ 1 │ 2020-01-03 │ 88.10 │ 90.80 │ 87.38 │ 88.60 │ 88.60 │ 88892500 │ nan │ +├───┼────────────┼────────┼────────┼────────┼────────┼───────────┼───────────┼─────────────┤ +│ 2 │ 2020-01-06 │ 88.09 │ 90.31 │ 88.00 │ 90.31 │ 90.31 │ 50665000 │ nan │ +├───┼────────────┼────────┼────────┼────────┼────────┼───────────┼───────────┼─────────────┤ +│ 3 │ 2020-01-07 │ 92.28 │ 94.33 │ 90.67 │ 93.81 │ 93.81 │ 89410500 │ nan │ +├───┼────────────┼────────┼────────┼────────┼────────┼───────────┼───────────┼─────────────┤ +│ 4 │ 2020-01-08 │ 94.74 │ 99.70 │ 93.65 │ 98.43 │ 98.43 │ 155721500 │ nan │ +├───┼────────────┼────────┼────────┼────────┼────────┼───────────┼───────────┼─────────────┤ +│ 5 │ 2020-01-09 │ 99.42 │ 99.76 │ 94.57 │ 96.27 │ 96.27 │ 142202000 │ nan │ +├───┼────────────┼────────┼────────┼────────┼────────┼───────────┼───────────┼─────────────┤ +│ 6 │ 2020-01-10 │ 96.36 │ 96.99 │ 94.74 │ 95.63 │ 95.63 │ 64797500 │ nan │ +├───┼────────────┼────────┼────────┼────────┼────────┼───────────┼───────────┼─────────────┤ +│ 7 │ 2020-01-13 │ 98.70 │ 105.13 │ 98.40 │ 104.97 │ 104.97 │ 132588000 │ nan │ +├───┼────────────┼────────┼────────┼────────┼────────┼───────────┼───────────┼─────────────┤ +│ 8 │ 2020-01-14 │ 108.85 │ 109.48 │ 104.98 │ 107.58 │ 107.58 │ 144981000 │ nan │ +├───┼────────────┼────────┼────────┼────────┼────────┼───────────┼───────────┼─────────────┤ +│ 9 │ 2020-01-15 │ 105.95 │ 107.57 │ 103.36 │ 103.70 │ 103.70 │ 86844000 │ nan │ +└───┴────────────┴────────┴────────┴────────┴────────┴───────────┴───────────┴─────────────┘ + +(🦋) /forecast/ $ clean TSLA +Namespace(drop='', fill='', help=False, limit=5, target_dataset='TSLA') +Successfully cleaned 'TSLA' dataset + +(🦋) /forecast/ $ show TSLA +TSLA dataset has shape (row, column): (601, 8) + + Dataset TSLA | Showing 10 of 601 rows +┏━━━┳━━━━━━━━━━━━┳━━━━━━━━┳━━━━━━━━┳━━━━━━━━┳━━━━━━━━┳━━━━━━━━━━━┳━━━━━━━━━━━┳━━━━━━━━━━━━━┓ +┃ ┃ date ┃ open ┃ high ┃ low ┃ close ┃ adj_close ┃ volume ┃ Momentum_10 ┃ +┡━━━╇━━━━━━━━━━━━╇━━━━━━━━╇━━━━━━━━╇━━━━━━━━╇━━━━━━━━╇━━━━━━━━━━━╇━━━━━━━━━━━╇━━━━━━━━━━━━━┩ +│ 0 │ 2020-01-16 │ 98.75 │ 102.89 │ 98.43 │ 102.70 │ 102.70 │ 108683500 │ 16.65 │ +├───┼────────────┼────────┼────────┼────────┼────────┼───────────┼───────────┼─────────────┤ +│ 1 │ 2020-01-17 │ 101.52 │ 103.13 │ 100.63 │ 102.10 │ 102.10 │ 68145500 │ 13.50 │ +├───┼────────────┼────────┼────────┼────────┼────────┼───────────┼───────────┼─────────────┤ +│ 2 │ 2020-01-21 │ 106.05 │ 109.72 │ 105.68 │ 109.44 │ 109.44 │ 89017500 │ 19.13 │ +├───┼────────────┼────────┼────────┼────────┼────────┼───────────┼───────────┼─────────────┤ +│ 3 │ 2020-01-22 │ 114.38 │ 118.90 │ 111.82 │ 113.91 │ 113.91 │ 156845000 │ 20.10 │ +├───┼────────────┼────────┼────────┼────────┼────────┼───────────┼───────────┼─────────────┤ +│ 4 │ 2020-01-23 │ 112.85 │ 116.40 │ 111.12 │ 114.44 │ 114.44 │ 98255000 │ 16.01 │ +├───┼────────────┼────────┼────────┼────────┼────────┼───────────┼───────────┼─────────────┤ +│ 5 │ 2020-01-24 │ 114.13 │ 114.77 │ 110.85 │ 112.96 │ 112.96 │ 71768000 │ 16.70 │ +├───┼────────────┼────────┼────────┼────────┼────────┼───────────┼───────────┼─────────────┤ +│ 6 │ 2020-01-27 │ 108.40 │ 112.89 │ 107.86 │ 111.60 │ 111.60 │ 68040500 │ 15.97 │ +├───┼────────────┼────────┼────────┼────────┼────────┼───────────┼───────────┼─────────────┤ +│ 7 │ 2020-01-28 │ 113.70 │ 115.36 │ 111.62 │ 113.38 │ 113.38 │ 58942500 │ 8.41 │ +├───┼────────────┼────────┼────────┼────────┼────────┼───────────┼───────────┼─────────────┤ +│ 8 │ 2020-01-29 │ 115.14 │ 117.96 │ 113.49 │ 116.20 │ 116.20 │ 89007500 │ 8.61 │ +├───┼────────────┼────────┼────────┼────────┼────────┼───────────┼───────────┼─────────────┤ +│ 9 │ 2020-01-30 │ 126.48 │ 130.18 │ 123.60 │ 128.16 │ 128.16 │ 145028500 │ 24.46 │ +└───┴────────────┴────────┴────────┴────────┴────────┴───────────┴───────────┴─────────────┘ +``` +--- diff --git a/website/content/terminal/reference/forecast/mstl.md b/website/content/terminal/reference/forecast/mstl.md new file mode 100644 index 000000000000..f56356142587 --- /dev/null +++ b/website/content/terminal/reference/forecast/mstl.md @@ -0,0 +1,76 @@ +--- +title: mstl +description: A comprehensive guide for MSTL - Multiple Seasonalities and Trend using + Loess forecast analysis in Python. This page includes technical details to understand + the parameters for a more accurate prediction, including details on seasonalities + and trends. A practical example is provided for clarity. +keywords: +- MSTL forecast +- Multiple Seasonalities and Trend +- Predictive Modeling +- Time Series Forecasting +- Loess Forecast +- Seasonality +- Predictive Analytics Tools +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Perform Multiple Seasonalities and Trend using Loess (MSTL) forecast: https://nixtla.github.io/statsforecast/examples/multipleseasonalities.html + +### Usage + +```python +mstl [--naive] [-d {}] [-c TARGET_COLUMN] [-n N_DAYS] [-s {N,A,M}] [-p SEASONAL_PERIODS] [-w START_WINDOW] [--end S_END_DATE] [--start S_START_DATE] [--residuals] [--forecast-only] [--export-pred-raw] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| naive | Show the naive baseline for a model. | False | True | None | +| target_dataset | The name of the dataset you want to select | None | True | None | +| target_column | The name of the specific column you want to use | close | True | None | +| n_days | prediction days. | 5 | True | None | +| seasonal | Seasonality: N: None, A: Additive, M: Multiplicative. | A | True | N, A, M | +| seasonal_periods | Seasonal periods: 4: Quarterly, 7: Daily | 7 | True | None | +| start_window | Start point for rolling training and forecast window. 0.0-1.0 | 0.85 | True | None | +| s_end_date | The end date (format YYYY-MM-DD) to select for testing | None | True | None | +| s_start_date | The start date (format YYYY-MM-DD) to select for testing | None | True | None | +| residuals | Show the residuals for the model. | False | True | None | +| forecast_only | Do not plot the historical data without forecasts. | False | True | None | +| export_pred_raw | Export predictions to a csv file. | False | True | None | + + +--- + +## Examples + +```python +2022 Nov 07, 18:16 (🦋) /forecast/ $ mstl AAPL + +Cross Validation Time Series 1: 100%|████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████| 115/115 [00:0100:00, 103.78it/s] +Forecast: 100%|███████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████| 1/1 [00:0000:00, 19.19it/s] +MSTL obtains MAPE: 3.37% + + + Actual price: 138.38 +┏━━━━━━━━━━━━┳━━━━━━━━━━━━┓ +┃ Datetime ┃ Prediction ┃ +┡━━━━━━━━━━━━╇━━━━━━━━━━━━┩ +│ 2022-11-07 │ 137.45 │ +├────────────┼────────────┤ +│ 2022-11-08 │ 142.27 │ +├────────────┼────────────┤ +│ 2022-11-09 │ 140.00 │ +├────────────┼────────────┤ +│ 2022-11-10 │ 141.32 │ +├────────────┼────────────┤ +│ 2022-11-11 │ 141.36 │ +└────────────┴────────────┘ +``` +--- diff --git a/website/content/terminal/reference/forecast/nbeats.md b/website/content/terminal/reference/forecast/nbeats.md new file mode 100644 index 000000000000..0dd27ec175f2 --- /dev/null +++ b/website/content/terminal/reference/forecast/nbeats.md @@ -0,0 +1,92 @@ +--- +title: nbeats +description: Explore how to use NBEATS, Neural Bayesian Estimation of Time Series, + a powerful tool for forecasting. It includes details of parameters, usage, and examples. +keywords: +- nbeats +- Neural Bayesian Estimation +- Time Series +- forecasting +- darts.models.forecasting +- python library +- data science +- machine learning +- API +- examples +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Perform NBEATS forecast (Neural Bayesian Estimation of Time Series): https://unit8co.github.io/darts/generated_api/darts.models.forecasting.nbeats.html + +### Usage + +```python +nbeats [--num_stacks NUM_STACKS] [--num_blocks NUM_BLOCKS] [--num_layers NUM_LAYERS] [--layer_widths LAYER_WIDTHS] [--past-covariates PAST_COVARIATES] [--all-past-covariates] [--naive] [-d {}] [-c TARGET_COLUMN] [-n N_DAYS] [-t TRAIN_SPLIT] [-i INPUT_CHUNK_LENGTH] [-o OUTPUT_CHUNK_LENGTH] [--force-reset FORCE_RESET] [--save-checkpoints SAVE_CHECKPOINTS] [--model-save-name MODEL_SAVE_NAME] [--n-epochs N_EPOCHS] [--batch-size BATCH_SIZE] [--end S_END_DATE] [--start S_START_DATE] [--learning-rate LEARNING_RATE] [--residuals] [--forecast-only] [--export-pred-raw] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| num_stacks | The number of stacks that make up the whole model. | 10 | True | None | +| num_blocks | The number of blocks making up every stack. | 3 | True | None | +| num_layers | The number of fully connected layers preceding the final forking layers in each block of every stack. | 4 | True | None | +| layer_widths | Determines the number of neurons that make up each fully connected layer in each block of every stack | 512 | True | None | +| past_covariates | Past covariates(columns/features) in same dataset. Comma separated. | None | True | None | +| all_past_covariates | Adds all rows as past covariates except for date and the target column. | False | True | None | +| naive | Show the naive baseline for a model. | False | True | None | +| target_dataset | The name of the dataset you want to select | None | True | None | +| target_column | The name of the specific column you want to use | close | True | None | +| n_days | prediction days. | 5 | True | None | +| train_split | Start point for rolling training and forecast window. 0.0-1.0 | 0.85 | True | None | +| input_chunk_length | Number of past time steps for forecasting module at prediction time. | 14 | True | None | +| output_chunk_length | The length of the forecast of the model. | 5 | True | None | +| force_reset | If set to True, any previously-existing model with the same name will be reset (all checkpoints will be discarded). | True | True | None | +| save_checkpoints | Whether to automatically save the untrained model and checkpoints. | True | True | None | +| model_save_name | Name of the model to save. | nbeats_model | True | None | +| n_epochs | Number of epochs over which to train the model. | 300 | True | None | +| batch_size | Number of time series (input and output) used in each training pass | 800 | True | None | +| s_end_date | The end date (format YYYY-MM-DD) to select for testing | None | True | None | +| s_start_date | The start date (format YYYY-MM-DD) to select for testing | None | True | None | +| learning_rate | Learning rate during training. | 0.001 | True | None | +| residuals | Show the residuals for the model. | False | True | None | +| forecast_only | Do not plot the historical data without forecasts. | False | True | None | +| export_pred_raw | Export predictions to a csv file. | False | True | None | + + +--- + +## Examples + +```python +2022 Jul 23, 10:36 (🦋) /forecast/ $ load GME_20220719_123734.csv -a GME + +2022 Jul 23, 11:03 (🦋) /forecast/ $ nbeats GME +100%|███████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████| 115/115 [00:0700:00, 15.10it/s] +NBEATS model obtains MAPE: 23.53% + + + + Actual price: $ 146.64 +┏━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━┓ +┃ Datetime ┃ Prediction ┃ +┡━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━┩ +│ 2022-07-19 00:00:00 │ $ 158.52 │ +├─────────────────────┼────────────┤ +│ 2022-07-20 00:00:00 │ $ 172.21 │ +├─────────────────────┼────────────┤ +│ 2022-07-21 00:00:00 │ $ 67.46 │ +├─────────────────────┼────────────┤ +│ 2022-07-22 00:00:00 │ $ 97.63 │ +├─────────────────────┼────────────┤ +│ 2022-07-25 00:00:00 │ $ 154.24 │ +└─────────────────────┴────────────┘ +``` +![nbeats](https://user-images.githubusercontent.com/72827203/180615396-d29126ae-ad75-4f84-9f67-2121dc4e695a.png) + +--- diff --git a/website/content/terminal/reference/forecast/nhits.md b/website/content/terminal/reference/forecast/nhits.md new file mode 100644 index 000000000000..302c11ea28a6 --- /dev/null +++ b/website/content/terminal/reference/forecast/nhits.md @@ -0,0 +1,100 @@ +--- +title: nhits +description: 'The nhits page provide detailed parameters for forecasting using the + Temporal Fusion Transformer model for predicting time-series. A step by step guide + to use nhits in a command-line along with additional key performance indicators + are provided. This is an effective resource for financial market predictions and + similar time-series forecasting tasks with tutorial and potential usage for nn models. ' +keywords: +- nhits +- darts forecasting +- tft model +- time-series forecasting +- forecast parameters +- nn models +- tensorflow models +- neural network models +- stock market predict +- financial forecast +- nhits command +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Perform nhits forecast: https://unit8co.github.io/darts/generated_api/darts.models.forecasting.tft_model.html + +### Usage + +```python +nhits [--num-stacks NUM_STACKS] [--num-blocks NUM_BLOCKS] [--num-layers NUM_LAYERS] [--layer_widths LAYER_WIDTHS] [--activation {ReLU,RReLU,PReLU,Softplus,Tanh,SELU,LeakyReLU,Sigmoid}] [--max_pool_1d] [--past-covariates PAST_COVARIATES] [--all-past-covariates] [--naive] [-d {}] [-c TARGET_COLUMN] [-n N_DAYS] [-t TRAIN_SPLIT] [-i INPUT_CHUNK_LENGTH] [-o OUTPUT_CHUNK_LENGTH] [--force-reset FORCE_RESET] [--save-checkpoints SAVE_CHECKPOINTS] [--model-save-name MODEL_SAVE_NAME] [--n-epochs N_EPOCHS] [--dropout DROPOUT] [--batch-size BATCH_SIZE] [--end S_END_DATE] [--start S_START_DATE] [--residuals] [--forecast-only] [--export-pred-raw] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| num_stacks | The number of stacks that make up the model | 3 | True | None | +| num_blocks | The number of blocks making up every stack | 1 | True | None | +| num_layers | The number of fully connected layers | 2 | True | None | +| layer_widths | The number of neurons in each layer | 512 | True | None | +| activation | The desired activation | ReLU | True | ReLU, RReLU, PReLU, Softplus, Tanh, SELU, LeakyReLU, Sigmoid | +| maxpool1d | Whether to use max_pool_1d or AvgPool1d | True | True | None | +| past_covariates | Past covariates(columns/features) in same dataset. Comma separated. | None | True | None | +| all_past_covariates | Adds all rows as past covariates except for date and the target column. | False | True | None | +| naive | Show the naive baseline for a model. | False | True | None | +| target_dataset | The name of the dataset you want to select | None | True | None | +| target_column | The name of the specific column you want to use | close | True | None | +| n_days | prediction days. | 5 | True | None | +| train_split | Start point for rolling training and forecast window. 0.0-1.0 | 0.85 | True | None | +| input_chunk_length | Number of past time steps for forecasting module at prediction time. | 14 | True | None | +| output_chunk_length | The length of the forecast of the model. | 5 | True | None | +| force_reset | If set to True, any previously-existing model with the same name will be reset (all checkpoints will be discarded). | True | True | None | +| save_checkpoints | Whether to automatically save the untrained model and checkpoints. | True | True | None | +| model_save_name | Name of the model to save. | nhits_model | True | None | +| n_epochs | Number of epochs over which to train the model. | 300 | True | None | +| dropout | Fraction of neurons affected by Dropout, from 0 to 1. | 0.1 | True | None | +| batch_size | Number of time series (input and output) used in each training pass | 32 | True | None | +| s_end_date | The end date (format YYYY-MM-DD) to select for testing | None | True | None | +| s_start_date | The start date (format YYYY-MM-DD) to select for testing | None | True | None | +| residuals | Show the residuals for the model. | False | True | None | +| forecast_only | Do not plot the historical data without forecasts. | False | True | None | +| export_pred_raw | Export predictions to a csv file. | False | True | None | + + +--- + +## Examples + +```python +2022 Oct 11, 06:38 D /forecast/ $ load AAPL_20220719_201127.csv + +2022 Oct 11, 06:38 D /forecast/ $ nhits AAPL_20220719_201127 +Epoch 153: 100%|███████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████| 25/25 [00:0000:00, 183.87it/s, loss=-1.56, train_loss=-1.60, val_loss=-.954] +Predicting NHITS for 5 days +100%|███████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████| 115/115 [00:0100:00, 92.46it/s] +NHITS model obtains MAPE: 7.45% + + + + Actual price: 147.07 +┏━━━━━━━━━━━━┳━━━━━━━━━━━━┓ +┃ Datetime ┃ Prediction ┃ +┡━━━━━━━━━━━━╇━━━━━━━━━━━━┩ +│ 2022-07-19 │ 134.84 │ +├────────────┼────────────┤ +│ 2022-07-20 │ 141.80 │ +├────────────┼────────────┤ +│ 2022-07-21 │ 131.06 │ +├────────────┼────────────┤ +│ 2022-07-22 │ 102.95 │ +├────────────┼────────────┤ +│ 2022-07-25 │ 123.72 │ +└────────────┴────────────┘ +``` +![nbeats](https://user-images.githubusercontent.com/72827203/195015203-3644fe8c-e1f7-49ab-9595-a19b474948cc.png) + +--- diff --git a/website/content/terminal/reference/forecast/plot.md b/website/content/terminal/reference/forecast/plot.md new file mode 100644 index 000000000000..101beb74eef5 --- /dev/null +++ b/website/content/terminal/reference/forecast/plot.md @@ -0,0 +1,46 @@ +--- +title: plot +description: This page provides an elaborative guide to users on how to plot data + based on their index with interactive examples. +keywords: +- Data Plotting +- Plot usage +- Dataset.column values +- Plot parameters +- Python plot guide +- Data visualization +- index-based plotting +- Programming +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Plot data based on the index + +### Usage + +```python +plot [-v {}] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| values | Dataset.column values to be displayed in a plot. Use comma to separate multiple | None | True | None | + + +--- + +## Examples + +```python +(🦋) /forecast/ $ load aapl.csv + +(🦋) /forecast/ $ plot appl.close +``` +--- diff --git a/website/content/terminal/reference/forecast/regr.md b/website/content/terminal/reference/forecast/regr.md new file mode 100644 index 000000000000..47e7dee34e47 --- /dev/null +++ b/website/content/terminal/reference/forecast/regr.md @@ -0,0 +1,85 @@ +--- +title: regr +description: This page provides a comprehensive guide on how to carry out a regression + forecast using regr function in darts.models. Parameters such as past covariates, + prediction days, train split, target dataset, and output chunk length are explained + in great detail. Examples and usage documentation are also provided to aid in understanding. +keywords: +- regression forecast +- darts.models +- forecasting model +- regr function +- regr parameters +- past covariates +- prediction days +- train split +- forecast chunk length +- forecasting tool +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Perform a regression forecast: https://unit8co.github.io/darts/generated_api/darts.models.forecasting.regression_model.html + +### Usage + +```python +regr [--past-covariates PAST_COVARIATES] [--all-past-covariates] [--naive] [-d {}] [-c TARGET_COLUMN] [-n N_DAYS] [-t TRAIN_SPLIT] [-o OUTPUT_CHUNK_LENGTH] [--end S_END_DATE] [--start S_START_DATE] [--lags LAGS] [--residuals] [--forecast-only] [--explainability-raw] [--export-pred-raw] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| past_covariates | Past covariates(columns/features) in same dataset. Comma separated. | None | True | None | +| all_past_covariates | Adds all rows as past covariates except for date and the target column. | False | True | None | +| naive | Show the naive baseline for a model. | False | True | None | +| target_dataset | The name of the dataset you want to select | None | True | None | +| target_column | The name of the specific column you want to use | close | True | None | +| n_days | prediction days. | 5 | True | None | +| train_split | Start point for rolling training and forecast window. 0.0-1.0 | 0.85 | True | None | +| output_chunk_length | The length of the forecast of the model. | 5 | True | None | +| s_end_date | The end date (format YYYY-MM-DD) to select for testing | None | True | None | +| s_start_date | The start date (format YYYY-MM-DD) to select for testing | None | True | None | +| lags | Lagged target values used to predict the next time step. | 14 | True | None | +| residuals | Show the residuals for the model. | False | True | None | +| forecast_only | Do not plot the historical data without forecasts. | False | True | None | +| explainability_raw | Prints out a raw dataframe showing explainability results. | False | True | None | +| export_pred_raw | Export predictions to a csv file. | False | True | None | + + +--- + +## Examples + +```python +2022 Jul 23, 10:36 (🦋) /forecast/ $ load GME_20220719_123734.csv -a GME + +2022 Jul 23, 11:08 (🦋) /forecast/ $ regr GME +100%|██████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████| 115/115 [00:0100:00, 111.85it/s] +Regression model obtains MAPE: 12.34% + + + + Actual price: $ 146.64 +┏━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━┓ +┃ Datetime ┃ Prediction ┃ +┡━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━┩ +│ 2022-07-19 00:00:00 │ $ 143.74 │ +├─────────────────────┼────────────┤ +│ 2022-07-20 00:00:00 │ $ 144.90 │ +├─────────────────────┼────────────┤ +│ 2022-07-21 00:00:00 │ $ 142.41 │ +├─────────────────────┼────────────┤ +│ 2022-07-22 00:00:00 │ $ 133.50 │ +├─────────────────────┼────────────┤ +│ 2022-07-25 00:00:00 │ $ 134.24 │ +└─────────────────────┴────────────┘ +``` +![regr](https://user-images.githubusercontent.com/72827203/180615346-82fae367-d0cc-4d78-be30-b947a83df909.png) + +--- diff --git a/website/content/terminal/reference/forecast/rename.md b/website/content/terminal/reference/forecast/rename.md new file mode 100644 index 000000000000..a06fbaa75b30 --- /dev/null +++ b/website/content/terminal/reference/forecast/rename.md @@ -0,0 +1,101 @@ +--- +title: rename +description: The page provides detailed information on the 'rename' function from + a Python-based toolset, used for renaming columns in a dataset. It includes how + to use the function, its parameters, and relevant examples. +keywords: +- rename tool +- dataset +- parameter +- column rename +- dataset modification +- data management +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +The column you want to rename from a dataset. + +### Usage + +```python +rename [-d {}] -o OLDCOL -n NEWCOL +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| dataset | Dataset that will get a column renamed | None | True | None | +| oldcol | Old column from dataset to be renamed | None | False | None | +| newcol | New column from dataset to be renamed | None | False | None | + + +--- + +## Examples + +```python +2022 Jul 23, 10:16 (🦋) /forecast/ $ show AAPL +AAPL dataset has shape (row, column): (759, 7) + + Dataset AAPL | Showing 10 of 759 rows +┏━━━┳━━━━━━━━━━━━┳━━━━━━━┳━━━━━━━┳━━━━━━━┳━━━━━━━┳━━━━━━━━━━━┳━━━━━━━━━━┓ +┃ ┃ date ┃ open ┃ high ┃ low ┃ close ┃ adj_close ┃ volume ┃ +┡━━━╇━━━━━━━━━━━━╇━━━━━━━╇━━━━━━━╇━━━━━━━╇━━━━━━━╇━━━━━━━━━━━╇━━━━━━━━━━┩ +│ 0 │ 2019-07-15 │ 51.02 │ 51.47 │ 51.00 │ 51.30 │ 50.07 │ 67789600 │ +├───┼────────────┼───────┼───────┼───────┼───────┼───────────┼──────────┤ +│ 1 │ 2019-07-16 │ 51.15 │ 51.53 │ 50.88 │ 51.12 │ 49.90 │ 67467200 │ +├───┼────────────┼───────┼───────┼───────┼───────┼───────────┼──────────┤ +│ 2 │ 2019-07-17 │ 51.01 │ 51.27 │ 50.82 │ 50.84 │ 49.62 │ 56430000 │ +├───┼────────────┼───────┼───────┼───────┼───────┼───────────┼──────────┤ +│ 3 │ 2019-07-18 │ 51.00 │ 51.47 │ 50.92 │ 51.42 │ 50.18 │ 74162400 │ +├───┼────────────┼───────┼───────┼───────┼───────┼───────────┼──────────┤ +│ 4 │ 2019-07-19 │ 51.45 │ 51.62 │ 50.59 │ 50.65 │ 49.43 │ 83717200 │ +├───┼────────────┼───────┼───────┼───────┼───────┼───────────┼──────────┤ +│ 5 │ 2019-07-22 │ 50.91 │ 51.81 │ 50.90 │ 51.81 │ 50.56 │ 89111600 │ +├───┼────────────┼───────┼───────┼───────┼───────┼───────────┼──────────┤ +│ 6 │ 2019-07-23 │ 52.12 │ 52.23 │ 51.82 │ 52.21 │ 50.96 │ 73420800 │ +├───┼────────────┼───────┼───────┼───────┼───────┼───────────┼──────────┤ +│ 7 │ 2019-07-24 │ 51.92 │ 52.29 │ 51.79 │ 52.17 │ 50.92 │ 59966400 │ +├───┼────────────┼───────┼───────┼───────┼───────┼───────────┼──────────┤ +│ 8 │ 2019-07-25 │ 52.22 │ 52.31 │ 51.68 │ 51.76 │ 50.51 │ 55638400 │ +├───┼────────────┼───────┼───────┼───────┼───────┼───────────┼──────────┤ +│ 9 │ 2019-07-26 │ 51.87 │ 52.43 │ 51.78 │ 51.94 │ 50.69 │ 70475600 │ +└───┴────────────┴───────┴───────┴───────┴───────┴───────────┴──────────┘ + +2022 Jul 23, 10:16 (🦋) /forecast/ $ rename AAPL -o close -n new_name + +2022 Jul 23, 10:16 (🦋) /forecast/ $ show AAPL +AAPL dataset has shape (row, column): (759, 7) + + Dataset AAPL | Showing 10 of 759 rows +┏━━━┳━━━━━━━━━━━━┳━━━━━━━┳━━━━━━━┳━━━━━━━┳━━━━━━━━━━┳━━━━━━━━━━━┳━━━━━━━━━━┓ +┃ ┃ date ┃ open ┃ high ┃ low ┃ new_name ┃ adj_close ┃ volume ┃ +┡━━━╇━━━━━━━━━━━━╇━━━━━━━╇━━━━━━━╇━━━━━━━╇━━━━━━━━━━╇━━━━━━━━━━━╇━━━━━━━━━━┩ +│ 0 │ 2019-07-15 │ 51.02 │ 51.47 │ 51.00 │ 51.30 │ 50.07 │ 67789600 │ +├───┼────────────┼───────┼───────┼───────┼──────────┼───────────┼──────────┤ +│ 1 │ 2019-07-16 │ 51.15 │ 51.53 │ 50.88 │ 51.12 │ 49.90 │ 67467200 │ +├───┼────────────┼───────┼───────┼───────┼──────────┼───────────┼──────────┤ +│ 2 │ 2019-07-17 │ 51.01 │ 51.27 │ 50.82 │ 50.84 │ 49.62 │ 56430000 │ +├───┼────────────┼───────┼───────┼───────┼──────────┼───────────┼──────────┤ +│ 3 │ 2019-07-18 │ 51.00 │ 51.47 │ 50.92 │ 51.42 │ 50.18 │ 74162400 │ +├───┼────────────┼───────┼───────┼───────┼──────────┼───────────┼──────────┤ +│ 4 │ 2019-07-19 │ 51.45 │ 51.62 │ 50.59 │ 50.65 │ 49.43 │ 83717200 │ +├───┼────────────┼───────┼───────┼───────┼──────────┼───────────┼──────────┤ +│ 5 │ 2019-07-22 │ 50.91 │ 51.81 │ 50.90 │ 51.81 │ 50.56 │ 89111600 │ +├───┼────────────┼───────┼───────┼───────┼──────────┼───────────┼──────────┤ +│ 6 │ 2019-07-23 │ 52.12 │ 52.23 │ 51.82 │ 52.21 │ 50.96 │ 73420800 │ +├───┼────────────┼───────┼───────┼───────┼──────────┼───────────┼──────────┤ +│ 7 │ 2019-07-24 │ 51.92 │ 52.29 │ 51.79 │ 52.17 │ 50.92 │ 59966400 │ +├───┼────────────┼───────┼───────┼───────┼──────────┼───────────┼──────────┤ +│ 8 │ 2019-07-25 │ 52.22 │ 52.31 │ 51.68 │ 51.76 │ 50.51 │ 55638400 │ +├───┼────────────┼───────┼───────┼───────┼──────────┼───────────┼──────────┤ +│ 9 │ 2019-07-26 │ 51.87 │ 52.43 │ 51.78 │ 51.94 │ 50.69 │ 70475600 │ +└───┴────────────┴───────┴───────┴───────┴──────────┴───────────┴──────────┘ +``` +--- diff --git a/website/content/terminal/reference/forecast/rnn.md b/website/content/terminal/reference/forecast/rnn.md new file mode 100644 index 000000000000..c516f2280a5c --- /dev/null +++ b/website/content/terminal/reference/forecast/rnn.md @@ -0,0 +1,92 @@ +--- +title: rnn +description: Explore the use of Recurrent Neural Networks (RNNs) for time series forecasting. + It explains how to perform RNN forecasts using different architectures like Vanilla + RNN, LSTM, and GRU, using the Darts models forecasting library. The document covers + usage examples, parameters description and features of the model. +keywords: +- RNN forecast +- Vanilla RNN +- LSTM +- GRU +- darts.models.forecasting.rnn_model +- parameters +- examples +- machine learning +- model training +- model prediction +- time series analysis +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Perform RNN forecast (Vanilla RNN, LSTM, GRU): https://unit8co.github.io/darts/generated_api/darts.models.forecasting.rnn_model.html + +### Usage + +```python +rnn [--hidden-dim HIDDEN_DIM] [--training_length TRAINING_LENGTH] [--naive] [-d {}] [-c TARGET_COLUMN] [-n N_DAYS] [-t TRAIN_SPLIT] [-i INPUT_CHUNK_LENGTH] [--force-reset FORCE_RESET] [--save-checkpoints SAVE_CHECKPOINTS] [--model-save-name MODEL_SAVE_NAME] [--n-epochs N_EPOCHS] [--model-type MODEL_TYPE] [--dropout DROPOUT] [--batch-size BATCH_SIZE] [--end S_END_DATE] [--start S_START_DATE] [--learning-rate LEARNING_RATE] [--residuals] [--forecast-only] [--export-pred-raw] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| hidden_dim | Size for feature maps for each hidden RNN layer (h_n) | 20 | True | None | +| training_length | The length of both input (target and covariates) and output (target) time series used during training. Generally speaking, training_length should have a higher value than input_chunk_length because otherwise during training the RNN is never run for as many iterations as it will during training. | 20 | True | None | +| naive | Show the naive baseline for a model. | False | True | None | +| target_dataset | The name of the dataset you want to select | None | True | None | +| target_column | The name of the specific column you want to use | close | True | None | +| n_days | prediction days. | 5 | True | None | +| train_split | Start point for rolling training and forecast window. 0.0-1.0 | 0.85 | True | None | +| input_chunk_length | Number of past time steps for forecasting module at prediction time. | 14 | True | None | +| force_reset | If set to True, any previously-existing model with the same name will be reset (all checkpoints will be discarded). | True | True | None | +| save_checkpoints | Whether to automatically save the untrained model and checkpoints. | True | True | None | +| model_save_name | Name of the model to save. | rnn_model | True | None | +| n_epochs | Number of epochs over which to train the model. | 300 | True | None | +| model_type | Either a string specifying the RNN module type ("RNN", "LSTM" or "GRU") | LSTM | True | None | +| dropout | Fraction of neurons affected by Dropout, from 0 to 1. | 0 | True | None | +| batch_size | Number of time series (input and output) used in each training pass | 32 | True | None | +| s_end_date | The end date (format YYYY-MM-DD) to select for testing | None | True | None | +| s_start_date | The start date (format YYYY-MM-DD) to select for testing | None | True | None | +| learning_rate | Learning rate during training. | 0.001 | True | None | +| residuals | Show the residuals for the model. | False | True | None | +| forecast_only | Do not plot the historical data without forecasts. | False | True | None | +| export_pred_raw | Export predictions to a csv file. | False | True | None | + + +--- + +## Examples + +```python +2022 Jul 23, 10:36 (🦋) /forecast/ $ load GME_20220719_123734.csv -a GME + +2022 Jul 23, 11:03 (🦋) /forecast/ $ rnn GME +100%|███████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████| 115/115 [00:0700:00, 15.10it/s] +RNN model obtains MAPE: 14.67% + + + + Actual price: $ 146.64 +┏━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━┓ +┃ Datetime ┃ Prediction ┃ +┡━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━┩ +│ 2022-07-19 00:00:00 │ $ 146.89 │ +├─────────────────────┼────────────┤ +│ 2022-07-20 00:00:00 │ $ 148.58 │ +├─────────────────────┼────────────┤ +│ 2022-07-21 00:00:00 │ $ 150.00 │ +├─────────────────────┼────────────┤ +│ 2022-07-22 00:00:00 │ $ 151.23 │ +├─────────────────────┼────────────┤ +│ 2022-07-25 00:00:00 │ $ 152.29 │ +└─────────────────────┴────────────┘ +``` +![rnn](https://user-images.githubusercontent.com/72827203/180615355-5c30635a-be63-4b9a-836d-9feb3d3ac263.png) + +--- diff --git a/website/content/terminal/reference/forecast/roc.md b/website/content/terminal/reference/forecast/roc.md new file mode 100644 index 000000000000..d262f6265fcb --- /dev/null +++ b/website/content/terminal/reference/forecast/roc.md @@ -0,0 +1,103 @@ +--- +title: roc +description: The documentation shows how to use the ROC function which is used to + add a Rate of Change to a selected dataset based on a specific column. It includes + usage examples and details on setting parameters like 'target_dataset', 'target_column', + and 'period'. +keywords: +- Documentation +- ROC function +- Dataset +- Rate of Change +- Parameters +- Usage examples +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Add rate of change to dataset based on specific column. + +### Usage + +```python +roc [-d {}] [-c TARGET_COLUMN] [--period PERIOD] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| target_dataset | The name of the dataset you want to select | None | True | None | +| target_column | The name of the specific column you want to use | close | True | None | +| period | The period to use | 10 | True | None | + + +--- + +## Examples + +```python +(🦋) /forecast/ $ show TSLA +TSLA dataset has shape (row, column): (611, 7) + + Dataset TSLA | Showing 10 of 611 rows +┏━━━┳━━━━━━━━━━━━┳━━━━━━━━┳━━━━━━━━┳━━━━━━━━┳━━━━━━━━┳━━━━━━━━━━━┳━━━━━━━━━━━┓ +┃ ┃ date ┃ open ┃ high ┃ low ┃ close ┃ adj_close ┃ volume ┃ +┡━━━╇━━━━━━━━━━━━╇━━━━━━━━╇━━━━━━━━╇━━━━━━━━╇━━━━━━━━╇━━━━━━━━━━━╇━━━━━━━━━━━┩ +│ 0 │ 2020-01-02 │ 84.90 │ 86.14 │ 84.34 │ 86.05 │ 86.05 │ 47660500 │ +├───┼────────────┼────────┼────────┼────────┼────────┼───────────┼───────────┤ +│ 1 │ 2020-01-03 │ 88.10 │ 90.80 │ 87.38 │ 88.60 │ 88.60 │ 88892500 │ +├───┼────────────┼────────┼────────┼────────┼────────┼───────────┼───────────┤ +│ 2 │ 2020-01-06 │ 88.09 │ 90.31 │ 88.00 │ 90.31 │ 90.31 │ 50665000 │ +├───┼────────────┼────────┼────────┼────────┼────────┼───────────┼───────────┤ +│ 3 │ 2020-01-07 │ 92.28 │ 94.33 │ 90.67 │ 93.81 │ 93.81 │ 89410500 │ +├───┼────────────┼────────┼────────┼────────┼────────┼───────────┼───────────┤ +│ 4 │ 2020-01-08 │ 94.74 │ 99.70 │ 93.65 │ 98.43 │ 98.43 │ 155721500 │ +├───┼────────────┼────────┼────────┼────────┼────────┼───────────┼───────────┤ +│ 5 │ 2020-01-09 │ 99.42 │ 99.76 │ 94.57 │ 96.27 │ 96.27 │ 142202000 │ +├───┼────────────┼────────┼────────┼────────┼────────┼───────────┼───────────┤ +│ 6 │ 2020-01-10 │ 96.36 │ 96.99 │ 94.74 │ 95.63 │ 95.63 │ 64797500 │ +├───┼────────────┼────────┼────────┼────────┼────────┼───────────┼───────────┤ +│ 7 │ 2020-01-13 │ 98.70 │ 105.13 │ 98.40 │ 104.97 │ 104.97 │ 132588000 │ +├───┼────────────┼────────┼────────┼────────┼────────┼───────────┼───────────┤ +│ 8 │ 2020-01-14 │ 108.85 │ 109.48 │ 104.98 │ 107.58 │ 107.58 │ 144981000 │ +├───┼────────────┼────────┼────────┼────────┼────────┼───────────┼───────────┤ +│ 9 │ 2020-01-15 │ 105.95 │ 107.57 │ 103.36 │ 103.70 │ 103.70 │ 86844000 │ +└───┴────────────┴────────┴────────┴────────┴────────┴───────────┴───────────┘ + +(🦋) /forecast/ $ roc TSLA +Successfully added 'ROC_10' to 'TSLA' dataset + +(🦋) /forecast/ $ show TSLA +TSLA dataset has shape (row, column): (611, 8) + + Dataset TSLA | Showing 10 of 611 rows +┏━━━┳━━━━━━━━━━━━┳━━━━━━━━┳━━━━━━━━┳━━━━━━━━┳━━━━━━━━┳━━━━━━━━━━━┳━━━━━━━━━━━┳━━━━━━━━┓ +┃ ┃ date ┃ open ┃ high ┃ low ┃ close ┃ adj_close ┃ volume ┃ ROC_10 ┃ +┡━━━╇━━━━━━━━━━━━╇━━━━━━━━╇━━━━━━━━╇━━━━━━━━╇━━━━━━━━╇━━━━━━━━━━━╇━━━━━━━━━━━╇━━━━━━━━┩ +│ 0 │ 2020-01-02 │ 84.90 │ 86.14 │ 84.34 │ 86.05 │ 86.05 │ 47660500 │ nan │ +├───┼────────────┼────────┼────────┼────────┼────────┼───────────┼───────────┼────────┤ +│ 1 │ 2020-01-03 │ 88.10 │ 90.80 │ 87.38 │ 88.60 │ 88.60 │ 88892500 │ nan │ +├───┼────────────┼────────┼────────┼────────┼────────┼───────────┼───────────┼────────┤ +│ 2 │ 2020-01-06 │ 88.09 │ 90.31 │ 88.00 │ 90.31 │ 90.31 │ 50665000 │ nan │ +├───┼────────────┼────────┼────────┼────────┼────────┼───────────┼───────────┼────────┤ +│ 3 │ 2020-01-07 │ 92.28 │ 94.33 │ 90.67 │ 93.81 │ 93.81 │ 89410500 │ nan │ +├───┼────────────┼────────┼────────┼────────┼────────┼───────────┼───────────┼────────┤ +│ 4 │ 2020-01-08 │ 94.74 │ 99.70 │ 93.65 │ 98.43 │ 98.43 │ 155721500 │ nan │ +├───┼────────────┼────────┼────────┼────────┼────────┼───────────┼───────────┼────────┤ +│ 5 │ 2020-01-09 │ 99.42 │ 99.76 │ 94.57 │ 96.27 │ 96.27 │ 142202000 │ nan │ +├───┼────────────┼────────┼────────┼────────┼────────┼───────────┼───────────┼────────┤ +│ 6 │ 2020-01-10 │ 96.36 │ 96.99 │ 94.74 │ 95.63 │ 95.63 │ 64797500 │ nan │ +├───┼────────────┼────────┼────────┼────────┼────────┼───────────┼───────────┼────────┤ +│ 7 │ 2020-01-13 │ 98.70 │ 105.13 │ 98.40 │ 104.97 │ 104.97 │ 132588000 │ nan │ +├───┼────────────┼────────┼────────┼────────┼────────┼───────────┼───────────┼────────┤ +│ 8 │ 2020-01-14 │ 108.85 │ 109.48 │ 104.98 │ 107.58 │ 107.58 │ 144981000 │ nan │ +├───┼────────────┼────────┼────────┼────────┼────────┼───────────┼───────────┼────────┤ +│ 9 │ 2020-01-15 │ 105.95 │ 107.57 │ 103.36 │ 103.70 │ 103.70 │ 86844000 │ 20.51 │ +└───┴────────────┴────────┴────────┴────────┴────────┴───────────┴───────────┴────────┘ +``` +--- diff --git a/website/content/terminal/reference/forecast/rsi.md b/website/content/terminal/reference/forecast/rsi.md new file mode 100644 index 000000000000..64175fe41c00 --- /dev/null +++ b/website/content/terminal/reference/forecast/rsi.md @@ -0,0 +1,137 @@ +--- +title: rsi +description: This page provides a thorough explanation of how to add an RSI (Relative + Strength Index) to a specific dataset based on a chosen column. It provides useful + examples of seamless operation using Python. RSI is typically used by forecasters + and analysts to help identify market trends and overbought or oversold conditions. +keywords: +- Relative Strength Index +- RSI +- dataset +- forecast +- analysis +- market trends +- overbought conditions +- oversold conditions +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Add rsi to dataset based on specific column. + +### Usage + +```python +rsi [-d {}] [-c TARGET_COLUMN] [--period PERIOD] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| target_dataset | The name of the dataset you want to select | None | True | None | +| target_column | The name of the specific column you want to use | close | True | None | +| period | The period to use | 10 | True | None | + + +--- + +## Examples + +```python +(🦋) /forecast/ $ show TSLA +TSLA dataset has shape (row, column): (611, 7) + + Dataset TSLA | Showing 10 of 611 rows +┏━━━┳━━━━━━━━━━━━┳━━━━━━━━┳━━━━━━━━┳━━━━━━━━┳━━━━━━━━┳━━━━━━━━━━━┳━━━━━━━━━━━┓ +┃ ┃ date ┃ open ┃ high ┃ low ┃ close ┃ adj_close ┃ volume ┃ +┡━━━╇━━━━━━━━━━━━╇━━━━━━━━╇━━━━━━━━╇━━━━━━━━╇━━━━━━━━╇━━━━━━━━━━━╇━━━━━━━━━━━┩ +│ 0 │ 2020-01-02 │ 84.90 │ 86.14 │ 84.34 │ 86.05 │ 86.05 │ 47660500 │ +├───┼────────────┼────────┼────────┼────────┼────────┼───────────┼───────────┤ +│ 1 │ 2020-01-03 │ 88.10 │ 90.80 │ 87.38 │ 88.60 │ 88.60 │ 88892500 │ +├───┼────────────┼────────┼────────┼────────┼────────┼───────────┼───────────┤ +│ 2 │ 2020-01-06 │ 88.09 │ 90.31 │ 88.00 │ 90.31 │ 90.31 │ 50665000 │ +├───┼────────────┼────────┼────────┼────────┼────────┼───────────┼───────────┤ +│ 3 │ 2020-01-07 │ 92.28 │ 94.33 │ 90.67 │ 93.81 │ 93.81 │ 89410500 │ +├───┼────────────┼────────┼────────┼────────┼────────┼───────────┼───────────┤ +│ 4 │ 2020-01-08 │ 94.74 │ 99.70 │ 93.65 │ 98.43 │ 98.43 │ 155721500 │ +├───┼────────────┼────────┼────────┼────────┼────────┼───────────┼───────────┤ +│ 5 │ 2020-01-09 │ 99.42 │ 99.76 │ 94.57 │ 96.27 │ 96.27 │ 142202000 │ +├───┼────────────┼────────┼────────┼────────┼────────┼───────────┼───────────┤ +│ 6 │ 2020-01-10 │ 96.36 │ 96.99 │ 94.74 │ 95.63 │ 95.63 │ 64797500 │ +├───┼────────────┼────────┼────────┼────────┼────────┼───────────┼───────────┤ +│ 7 │ 2020-01-13 │ 98.70 │ 105.13 │ 98.40 │ 104.97 │ 104.97 │ 132588000 │ +├───┼────────────┼────────┼────────┼────────┼────────┼───────────┼───────────┤ +│ 8 │ 2020-01-14 │ 108.85 │ 109.48 │ 104.98 │ 107.58 │ 107.58 │ 144981000 │ +├───┼────────────┼────────┼────────┼────────┼────────┼───────────┼───────────┤ +│ 9 │ 2020-01-15 │ 105.95 │ 107.57 │ 103.36 │ 103.70 │ 103.70 │ 86844000 │ +└───┴────────────┴────────┴────────┴────────┴────────┴───────────┴───────────┘ + +(🦋) /forecast/ $ rsi TSLA +Successfully added 'RSI_10' to 'TSLA' dataset + +(🦋) /forecast/ $ show TSLA +TSLA dataset has shape (row, column): (611, 8) + + Dataset TSLA | Showing 10 of 611 rows +┏━━━┳━━━━━━━━━━━━┳━━━━━━━━┳━━━━━━━━┳━━━━━━━━┳━━━━━━━━┳━━━━━━━━━━━┳━━━━━━━━━━━┳━━━━━━━━┓ +┃ ┃ date ┃ open ┃ high ┃ low ┃ close ┃ adj_close ┃ volume ┃ RSI_10 ┃ +┡━━━╇━━━━━━━━━━━━╇━━━━━━━━╇━━━━━━━━╇━━━━━━━━╇━━━━━━━━╇━━━━━━━━━━━╇━━━━━━━━━━━╇━━━━━━━━┩ +│ 0 │ 2020-01-02 │ 84.90 │ 86.14 │ 84.34 │ 86.05 │ 86.05 │ 47660500 │ nan │ +├───┼────────────┼────────┼────────┼────────┼────────┼───────────┼───────────┼────────┤ +│ 1 │ 2020-01-03 │ 88.10 │ 90.80 │ 87.38 │ 88.60 │ 88.60 │ 88892500 │ nan │ +├───┼────────────┼────────┼────────┼────────┼────────┼───────────┼───────────┼────────┤ +│ 2 │ 2020-01-06 │ 88.09 │ 90.31 │ 88.00 │ 90.31 │ 90.31 │ 50665000 │ nan │ +├───┼────────────┼────────┼────────┼────────┼────────┼───────────┼───────────┼────────┤ +│ 3 │ 2020-01-07 │ 92.28 │ 94.33 │ 90.67 │ 93.81 │ 93.81 │ 89410500 │ nan │ +├───┼────────────┼────────┼────────┼────────┼────────┼───────────┼───────────┼────────┤ +│ 4 │ 2020-01-08 │ 94.74 │ 99.70 │ 93.65 │ 98.43 │ 98.43 │ 155721500 │ nan │ +├───┼────────────┼────────┼────────┼────────┼────────┼───────────┼───────────┼────────┤ +│ 5 │ 2020-01-09 │ 99.42 │ 99.76 │ 94.57 │ 96.27 │ 96.27 │ 142202000 │ nan │ +├───┼────────────┼────────┼────────┼────────┼────────┼───────────┼───────────┼────────┤ +│ 6 │ 2020-01-10 │ 96.36 │ 96.99 │ 94.74 │ 95.63 │ 95.63 │ 64797500 │ nan │ +├───┼────────────┼────────┼────────┼────────┼────────┼───────────┼───────────┼────────┤ +│ 7 │ 2020-01-13 │ 98.70 │ 105.13 │ 98.40 │ 104.97 │ 104.97 │ 132588000 │ nan │ +├───┼────────────┼────────┼────────┼────────┼────────┼───────────┼───────────┼────────┤ +│ 8 │ 2020-01-14 │ 108.85 │ 109.48 │ 104.98 │ 107.58 │ 107.58 │ 144981000 │ nan │ +├───┼────────────┼────────┼────────┼────────┼────────┼───────────┼───────────┼────────┤ +│ 9 │ 2020-01-15 │ 105.95 │ 107.57 │ 103.36 │ 103.70 │ 103.70 │ 86844000 │ nan │ +└───┴────────────┴────────┴────────┴────────┴────────┴───────────┴───────────┴────────┘ + +(🦋) /forecast/ $ clean TSLA +Namespace(drop='', fill='', help=False, limit=5, target_dataset='TSLA') +Successfully cleaned 'TSLA' dataset + +(🦋) /forecast/ $ show TSLA +TSLA dataset has shape (row, column): (601, 8) + + Dataset TSLA | Showing 10 of 601 rows +┏━━━┳━━━━━━━━━━━━┳━━━━━━━━┳━━━━━━━━┳━━━━━━━━┳━━━━━━━━┳━━━━━━━━━━━┳━━━━━━━━━━━┳━━━━━━━━┓ +┃ ┃ date ┃ open ┃ high ┃ low ┃ close ┃ adj_close ┃ volume ┃ RSI_10 ┃ +┡━━━╇━━━━━━━━━━━━╇━━━━━━━━╇━━━━━━━━╇━━━━━━━━╇━━━━━━━━╇━━━━━━━━━━━╇━━━━━━━━━━━╇━━━━━━━━┩ +│ 0 │ 2020-01-16 │ 98.75 │ 102.89 │ 98.43 │ 102.70 │ 102.70 │ 108683500 │ 76.00 │ +├───┼────────────┼────────┼────────┼────────┼────────┼───────────┼───────────┼────────┤ +│ 1 │ 2020-01-17 │ 101.52 │ 103.13 │ 100.63 │ 102.10 │ 102.10 │ 68145500 │ 74.45 │ +├───┼────────────┼────────┼────────┼────────┼────────┼───────────┼───────────┼────────┤ +│ 2 │ 2020-01-21 │ 106.05 │ 109.72 │ 105.68 │ 109.44 │ 109.44 │ 89017500 │ 80.00 │ +├───┼────────────┼────────┼────────┼────────┼────────┼───────────┼───────────┼────────┤ +│ 3 │ 2020-01-22 │ 114.38 │ 118.90 │ 111.82 │ 113.91 │ 113.91 │ 156845000 │ 82.56 │ +├───┼────────────┼────────┼────────┼────────┼────────┼───────────┼───────────┼────────┤ +│ 4 │ 2020-01-23 │ 112.85 │ 116.40 │ 111.12 │ 114.44 │ 114.44 │ 98255000 │ 82.85 │ +├───┼────────────┼────────┼────────┼────────┼────────┼───────────┼───────────┼────────┤ +│ 5 │ 2020-01-24 │ 114.13 │ 114.77 │ 110.85 │ 112.96 │ 112.96 │ 71768000 │ 78.80 │ +├───┼────────────┼────────┼────────┼────────┼────────┼───────────┼───────────┼────────┤ +│ 6 │ 2020-01-27 │ 108.40 │ 112.89 │ 107.86 │ 111.60 │ 111.60 │ 68040500 │ 75.05 │ +├───┼────────────┼────────┼────────┼────────┼────────┼───────────┼───────────┼────────┤ +│ 7 │ 2020-01-28 │ 113.70 │ 115.36 │ 111.62 │ 113.38 │ 113.38 │ 58942500 │ 76.66 │ +├───┼────────────┼────────┼────────┼────────┼────────┼───────────┼───────────┼────────┤ +│ 8 │ 2020-01-29 │ 115.14 │ 117.96 │ 113.49 │ 116.20 │ 116.20 │ 89007500 │ 79.05 │ +├───┼────────────┼────────┼────────┼────────┼────────┼───────────┼───────────┼────────┤ +│ 9 │ 2020-01-30 │ 126.48 │ 130.18 │ 123.60 │ 128.16 │ 128.16 │ 145028500 │ 85.87 │ +└───┴────────────┴────────┴────────┴────────┴────────┴───────────┴───────────┴────────┘ +``` +--- diff --git a/website/content/terminal/reference/forecast/rwd.md b/website/content/terminal/reference/forecast/rwd.md new file mode 100644 index 000000000000..4d140d090e58 --- /dev/null +++ b/website/content/terminal/reference/forecast/rwd.md @@ -0,0 +1,80 @@ +--- +title: rwd +description: This page details the procedure for performing a Random Walk with Drift + (RWD) forecast using the statsforecast tool in Python. Complete with parameter listings, + usage instructions, and examples, the guidance facilitates accurate and efficient + data analysis. +keywords: +- Random Walk with Drift +- RWD +- Forecast +- Statsforecast +- Dataset +- Seasonality +- Residuals +- Predictions +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Perform Random Walk with Drift forecast: https://nixtla.github.io/statsforecast/models.html#randomwalkwithdrift + +### Usage + +```python +rwd [--naive] [-d {}] [-c TARGET_COLUMN] [-n N_DAYS] [-s {N,A,M}] [-w START_WINDOW] [--end S_END_DATE] [--start S_START_DATE] [--residuals] [--forecast-only] [--export-pred-raw] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| naive | Show the naive baseline for a model. | False | True | None | +| target_dataset | The name of the dataset you want to select | None | True | None | +| target_column | The name of the specific column you want to use | close | True | None | +| n_days | prediction days. | 5 | True | None | +| seasonal | Seasonality: N: None, A: Additive, M: Multiplicative. | A | True | N, A, M | +| start_window | Start point for rolling training and forecast window. 0.0-1.0 | 0.85 | True | None | +| s_end_date | The end date (format YYYY-MM-DD) to select for testing | None | True | None | +| s_start_date | The start date (format YYYY-MM-DD) to select for testing | None | True | None | +| residuals | Show the residuals for the model. | False | True | None | +| forecast_only | Do not plot the historical data without forecasts. | False | True | None | +| export_pred_raw | Export predictions to a csv file. | False | True | None | + + +--- + +## Examples + +```python +2022 Nov 07, 18:43 (🦋) /stocks/ $ load AAPL + +2022 Nov 07, 18:43 (🦋) /stocks/ $ forecast + +2022 Nov 07, 18:43 (🦋) /forecast/ $ rwd AAPL + +Cross Validation Time Series 1: 100%|█████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████| 115/115 [00:0200:00, 49.97it/s] +Forecast: 100%|████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████| 1/1 [00:0000:00, 15887.52it/s] +RWD obtains MAPE: 2.98% + + + Actual price: 138.38 +┏━━━━━━━━━━━━┳━━━━━━━━━━━━┓ +┃ Datetime ┃ Prediction ┃ +┡━━━━━━━━━━━━╇━━━━━━━━━━━━┩ +│ 2022-11-07 │ 138.47 │ +├────────────┼────────────┤ +│ 2022-11-08 │ 138.57 │ +├────────────┼────────────┤ +│ 2022-11-09 │ 138.66 │ +├────────────┼────────────┤ +│ 2022-11-10 │ 138.76 │ +├────────────┼────────────┤ +│ 2022-11-11 │ 138.85 │ +└────────────┴────────────┘ +``` +--- diff --git a/website/content/terminal/reference/forecast/season.md b/website/content/terminal/reference/forecast/season.md new file mode 100644 index 000000000000..2d4dad9153c6 --- /dev/null +++ b/website/content/terminal/reference/forecast/season.md @@ -0,0 +1,52 @@ +--- +title: season +description: Meta description for the 'season' function in Docusaurus. This function + helps to display and understand the seasonality for a given column in a dataset, + providing options for customization such as time lag, maximal lag order, and confidence + interval. +keywords: +- docusaurus +- season +- dataset +- seasonality +- time lag +- maximal lag order +- confidence interval +- data visualization +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +The seasonality for a given column + +### Usage + +```python +season [-v {}] [-m M] [--max_lag MAX_LAG] [-a ALPHA] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| values | Dataset.column values to be displayed in a plot | None | True | None | +| m | A time lag to highlight on the plot | None | True | None | +| max_lag | The maximal lag order to consider | 24 | True | None | +| alpha | The confidence interval to display | 0.05 | True | None | + + +--- + +## Examples + +```python +(🦋) /forecast/ $ load TSLA.csv + +(🦋) /forecast/ $ season TSLA.volume +TODO: screen shot +``` +--- diff --git a/website/content/terminal/reference/forecast/seasonalnaive.md b/website/content/terminal/reference/forecast/seasonalnaive.md new file mode 100644 index 000000000000..e8e9db140f7c --- /dev/null +++ b/website/content/terminal/reference/forecast/seasonalnaive.md @@ -0,0 +1,80 @@ +--- +title: seasonalnaive +description: This page provides detailed usage of the SeasonalNaive forecasting model + including parameters definitions, examples, and results interpretation. It is meant + as a guide for using SeasonalNaive to make economic predictions. +keywords: +- SeasonalNaive +- Forecasting +- Economic Predictions +- Additive Seasonality +- Multiplicative Seasonality +- Models +- Forecast Parameters +- Time Series Analysis +- Cross Validation Time Series +- Statsforecast +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Perform SeasonalNaive forecasting: https://nixtla.github.io/statsforecast/models.html#seasonalnaive + +### Usage + +```python +seasonalnaive [--naive] [-d {}] [-c TARGET_COLUMN] [-n N_DAYS] [-s {N,A,M}] [-p SEASONAL_PERIODS] [-w START_WINDOW] [--end S_END_DATE] [--start S_START_DATE] [--residuals] [--forecast-only] [--export-pred-raw] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| naive | Show the naive baseline for a model. | False | True | None | +| target_dataset | The name of the dataset you want to select | None | True | None | +| target_column | The name of the specific column you want to use | close | True | None | +| n_days | prediction days. | 5 | True | None | +| seasonal | Seasonality: N: None, A: Additive, M: Multiplicative. | A | True | N, A, M | +| seasonal_periods | Seasonal periods: 4: Quarterly, 7: Daily | 7 | True | None | +| start_window | Start point for rolling training and forecast window. 0.0-1.0 | 0.85 | True | None | +| s_end_date | The end date (format YYYY-MM-DD) to select for testing | None | True | None | +| s_start_date | The start date (format YYYY-MM-DD) to select for testing | None | True | None | +| residuals | Show the residuals for the model. | False | True | None | +| forecast_only | Do not plot the historical data without forecasts. | False | True | None | +| export_pred_raw | Export predictions to a csv file. | False | True | None | + + +--- + +## Examples + +```python +2022 Nov 07, 19:24 (🦋) /stocks/ $ forecast + +2022 Nov 07, 19:24 (🦋) /forecast/ $ seasonalnaive AAPL + +Cross Validation Time Series 1: 100%|█████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████| 115/115 [00:0200:00, 47.75it/s] +Forecast: 100%|████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████| 1/1 [00:0000:00, 14873.42it/s] +SeasonalNaive obtains MAPE: 4.26% + + + Actual price: 138.38 +┏━━━━━━━━━━━━┳━━━━━━━━━━━━┓ +┃ Datetime ┃ Prediction ┃ +┡━━━━━━━━━━━━╇━━━━━━━━━━━━┩ +│ 2022-11-07 │ 138.38 │ +├────────────┼────────────┤ +│ 2022-11-08 │ 144.80 │ +├────────────┼────────────┤ +│ 2022-11-09 │ 155.74 │ +├────────────┼────────────┤ +│ 2022-11-10 │ 153.34 │ +├────────────┼────────────┤ +│ 2022-11-11 │ 150.65 │ +└────────────┴────────────┘ +``` +--- diff --git a/website/content/terminal/reference/forecast/show.md b/website/content/terminal/reference/forecast/show.md new file mode 100644 index 000000000000..154944d71919 --- /dev/null +++ b/website/content/terminal/reference/forecast/show.md @@ -0,0 +1,75 @@ +--- +title: show +description: This page provides detailed information and examples about how to show + a portion of a DataFrame using predefined parameters. Gain an improved understanding + on DataFrame display, database sorting, data ordering and setting column limits. +keywords: +- Data Display +- Data Sorting +- Database +- Data Ordering +- Column Limits +- Usage Examples +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Show a portion of the DataFrame + +### Usage + +```python +show [-n {}] [-s SORTBY [SORTBY ...]] [-r] [--limit-col LIMIT_COL] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| name | The name of the database you want to show data for | None | True | None | +| sortby | Sort based on a column in the DataFrame | | True | None | +| reverse | Data is sorted in descending order by default. Reverse flag will sort it in an ascending way. Only works when raw data is displayed. | False | True | None | +| limit_col | Set the number of columns to display when showing the dataset | 10 | True | None | + + +--- + +## Examples + +```python +(🦋) /forecast/ $ load aapl.csv + +(🦋) /forecast/ $ show aapl + +aapl dataset has shape (row, column): (759, 7) + + Dataset aapl | Showing 10 of 759 rows +┏━━━┳━━━━━━━━━━━━┳━━━━━━━┳━━━━━━━┳━━━━━━━┳━━━━━━━┳━━━━━━━━━━━┳━━━━━━━━━━━┓ +┃ ┃ date ┃ open ┃ high ┃ low ┃ close ┃ adj_close ┃ volume ┃ +┡━━━╇━━━━━━━━━━━━╇━━━━━━━╇━━━━━━━╇━━━━━━━╇━━━━━━━╇━━━━━━━━━━━╇━━━━━━━━━━━┩ +│ 0 │ 2019-06-10 │ 47.95 │ 48.84 │ 47.90 │ 48.15 │ 46.99 │ 104883600 │ +├───┼────────────┼───────┼───────┼───────┼───────┼───────────┼───────────┤ +│ 1 │ 2019-06-11 │ 48.72 │ 49.00 │ 48.40 │ 48.70 │ 47.53 │ 107731600 │ +├───┼────────────┼───────┼───────┼───────┼───────┼───────────┼───────────┤ +│ 2 │ 2019-06-12 │ 48.49 │ 48.99 │ 48.35 │ 48.55 │ 47.38 │ 73012800 │ +├───┼────────────┼───────┼───────┼───────┼───────┼───────────┼───────────┤ +│ 3 │ 2019-06-13 │ 48.67 │ 49.20 │ 48.40 │ 48.54 │ 47.37 │ 86698400 │ +├───┼────────────┼───────┼───────┼───────┼───────┼───────────┼───────────┤ +│ 4 │ 2019-06-14 │ 47.89 │ 48.40 │ 47.58 │ 48.19 │ 47.03 │ 75046000 │ +├───┼────────────┼───────┼───────┼───────┼───────┼───────────┼───────────┤ +│ 5 │ 2019-06-17 │ 48.22 │ 48.74 │ 48.04 │ 48.47 │ 47.31 │ 58676400 │ +├───┼────────────┼───────┼───────┼───────┼───────┼───────────┼───────────┤ +│ 6 │ 2019-06-18 │ 49.01 │ 50.07 │ 48.80 │ 49.61 │ 48.42 │ 106204000 │ +├───┼────────────┼───────┼───────┼───────┼───────┼───────────┼───────────┤ +│ 7 │ 2019-06-19 │ 49.92 │ 49.97 │ 49.33 │ 49.47 │ 48.28 │ 84496800 │ +├───┼────────────┼───────┼───────┼───────┼───────┼───────────┼───────────┤ +│ 8 │ 2019-06-20 │ 50.09 │ 50.15 │ 49.51 │ 49.87 │ 48.67 │ 86056000 │ +├───┼────────────┼───────┼───────┼───────┼───────┼───────────┼───────────┤ +│ 9 │ 2019-06-21 │ 49.70 │ 50.21 │ 49.54 │ 49.69 │ 48.50 │ 191202400 │ +└───┴────────────┴───────┴───────┴───────┴───────┴───────────┴───────────┘ +``` +--- diff --git a/website/content/terminal/reference/forecast/signal.md b/website/content/terminal/reference/forecast/signal.md new file mode 100644 index 000000000000..92185efb2301 --- /dev/null +++ b/website/content/terminal/reference/forecast/signal.md @@ -0,0 +1,140 @@ +--- +title: signal +description: The documentation provides information about the 'Signal' function, which + is used to add a price signal to a dataset based on closing price. The signal predicts + if a short-term price will go up or down as compared to the long-term. +keywords: +- Signal function +- Dataset +- Closing price +- Short-term price prediction +- Long-term price comparison +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Add price signal to dataset based on closing price. 1 if the signal is that short term price will go up as compared to the long term. 0 if the signal is that short term price will go down as compared to the long term. + +### Usage + +```python +signal [-d {}] [-c TARGET_COLUMN] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| target_dataset | The name of the dataset you want to select | None | True | None | +| target_column | The name of the specific column you want to use | close | True | None | + + +--- + +## Examples + +```python +(🦋) /forecast/ $ show TSLA +TSLA dataset has shape (row, column): (611, 7) + + Dataset TSLA | Showing 10 of 611 rows +┏━━━┳━━━━━━━━━━━━┳━━━━━━━━┳━━━━━━━━┳━━━━━━━━┳━━━━━━━━┳━━━━━━━━━━━┳━━━━━━━━━━━┓ +┃ ┃ date ┃ open ┃ high ┃ low ┃ close ┃ adj_close ┃ volume ┃ +┡━━━╇━━━━━━━━━━━━╇━━━━━━━━╇━━━━━━━━╇━━━━━━━━╇━━━━━━━━╇━━━━━━━━━━━╇━━━━━━━━━━━┩ +│ 0 │ 2020-01-02 │ 84.90 │ 86.14 │ 84.34 │ 86.05 │ 86.05 │ 47660500 │ +├───┼────────────┼────────┼────────┼────────┼────────┼───────────┼───────────┤ +│ 1 │ 2020-01-03 │ 88.10 │ 90.80 │ 87.38 │ 88.60 │ 88.60 │ 88892500 │ +├───┼────────────┼────────┼────────┼────────┼────────┼───────────┼───────────┤ +│ 2 │ 2020-01-06 │ 88.09 │ 90.31 │ 88.00 │ 90.31 │ 90.31 │ 50665000 │ +├───┼────────────┼────────┼────────┼────────┼────────┼───────────┼───────────┤ +│ 3 │ 2020-01-07 │ 92.28 │ 94.33 │ 90.67 │ 93.81 │ 93.81 │ 89410500 │ +├───┼────────────┼────────┼────────┼────────┼────────┼───────────┼───────────┤ +│ 4 │ 2020-01-08 │ 94.74 │ 99.70 │ 93.65 │ 98.43 │ 98.43 │ 155721500 │ +├───┼────────────┼────────┼────────┼────────┼────────┼───────────┼───────────┤ +│ 5 │ 2020-01-09 │ 99.42 │ 99.76 │ 94.57 │ 96.27 │ 96.27 │ 142202000 │ +├───┼────────────┼────────┼────────┼────────┼────────┼───────────┼───────────┤ +│ 6 │ 2020-01-10 │ 96.36 │ 96.99 │ 94.74 │ 95.63 │ 95.63 │ 64797500 │ +├───┼────────────┼────────┼────────┼────────┼────────┼───────────┼───────────┤ +│ 7 │ 2020-01-13 │ 98.70 │ 105.13 │ 98.40 │ 104.97 │ 104.97 │ 132588000 │ +├───┼────────────┼────────┼────────┼────────┼────────┼───────────┼───────────┤ +│ 8 │ 2020-01-14 │ 108.85 │ 109.48 │ 104.98 │ 107.58 │ 107.58 │ 144981000 │ +├───┼────────────┼────────┼────────┼────────┼────────┼───────────┼───────────┤ +│ 9 │ 2020-01-15 │ 105.95 │ 107.57 │ 103.36 │ 103.70 │ 103.70 │ 86844000 │ +└───┴────────────┴────────┴────────┴────────┴────────┴───────────┴───────────┘ + +(🦋) /forecast/ $ signal TSLA +Successfully added 'Price Signal' to 'TSLA' dataset + +(🦋) /forecast/ $ show TSLA -l 30 +TSLA dataset has shape (row, column): (611, 8) + + Dataset TSLA | Showing 30 of 611 rows +┏━━━━┳━━━━━━━━━━━━┳━━━━━━━━┳━━━━━━━━┳━━━━━━━━┳━━━━━━━━┳━━━━━━━━━━━┳━━━━━━━━━━━┳━━━━━━━━┓ +┃ ┃ date ┃ open ┃ high ┃ low ┃ close ┃ adj_close ┃ volume ┃ signal ┃ +┡━━━━╇━━━━━━━━━━━━╇━━━━━━━━╇━━━━━━━━╇━━━━━━━━╇━━━━━━━━╇━━━━━━━━━━━╇━━━━━━━━━━━╇━━━━━━━━┩ +│ 0 │ 2020-01-02 │ 84.90 │ 86.14 │ 84.34 │ 86.05 │ 86.05 │ 47660500 │ 0.00 │ +├────┼────────────┼────────┼────────┼────────┼────────┼───────────┼───────────┼────────┤ +│ 1 │ 2020-01-03 │ 88.10 │ 90.80 │ 87.38 │ 88.60 │ 88.60 │ 88892500 │ 0.00 │ +├────┼────────────┼────────┼────────┼────────┼────────┼───────────┼───────────┼────────┤ +│ 2 │ 2020-01-06 │ 88.09 │ 90.31 │ 88.00 │ 90.31 │ 90.31 │ 50665000 │ 0.00 │ +├────┼────────────┼────────┼────────┼────────┼────────┼───────────┼───────────┼────────┤ +│ 3 │ 2020-01-07 │ 92.28 │ 94.33 │ 90.67 │ 93.81 │ 93.81 │ 89410500 │ 0.00 │ +├────┼────────────┼────────┼────────┼────────┼────────┼───────────┼───────────┼────────┤ +│ 4 │ 2020-01-08 │ 94.74 │ 99.70 │ 93.65 │ 98.43 │ 98.43 │ 155721500 │ 0.00 │ +├────┼────────────┼────────┼────────┼────────┼────────┼───────────┼───────────┼────────┤ +│ 5 │ 2020-01-09 │ 99.42 │ 99.76 │ 94.57 │ 96.27 │ 96.27 │ 142202000 │ 0.00 │ +├────┼────────────┼────────┼────────┼────────┼────────┼───────────┼───────────┼────────┤ +│ 6 │ 2020-01-10 │ 96.36 │ 96.99 │ 94.74 │ 95.63 │ 95.63 │ 64797500 │ 0.00 │ +├────┼────────────┼────────┼────────┼────────┼────────┼───────────┼───────────┼────────┤ +│ 7 │ 2020-01-13 │ 98.70 │ 105.13 │ 98.40 │ 104.97 │ 104.97 │ 132588000 │ 0.00 │ +├────┼────────────┼────────┼────────┼────────┼────────┼───────────┼───────────┼────────┤ +│ 8 │ 2020-01-14 │ 108.85 │ 109.48 │ 104.98 │ 107.58 │ 107.58 │ 144981000 │ 0.00 │ +├────┼────────────┼────────┼────────┼────────┼────────┼───────────┼───────────┼────────┤ +│ 9 │ 2020-01-15 │ 105.95 │ 107.57 │ 103.36 │ 103.70 │ 103.70 │ 86844000 │ 0.00 │ +├────┼────────────┼────────┼────────┼────────┼────────┼───────────┼───────────┼────────┤ +│ 10 │ 2020-01-16 │ 98.75 │ 102.89 │ 98.43 │ 102.70 │ 102.70 │ 108683500 │ 1.00 │ +├────┼────────────┼────────┼────────┼────────┼────────┼───────────┼───────────┼────────┤ +│ 11 │ 2020-01-17 │ 101.52 │ 103.13 │ 100.63 │ 102.10 │ 102.10 │ 68145500 │ 1.00 │ +├────┼────────────┼────────┼────────┼────────┼────────┼───────────┼───────────┼────────┤ +│ 12 │ 2020-01-21 │ 106.05 │ 109.72 │ 105.68 │ 109.44 │ 109.44 │ 89017500 │ 1.00 │ +├────┼────────────┼────────┼────────┼────────┼────────┼───────────┼───────────┼────────┤ +│ 13 │ 2020-01-22 │ 114.38 │ 118.90 │ 111.82 │ 113.91 │ 113.91 │ 156845000 │ 1.00 │ +├────┼────────────┼────────┼────────┼────────┼────────┼───────────┼───────────┼────────┤ +│ 14 │ 2020-01-23 │ 112.85 │ 116.40 │ 111.12 │ 114.44 │ 114.44 │ 98255000 │ 1.00 │ +├────┼────────────┼────────┼────────┼────────┼────────┼───────────┼───────────┼────────┤ +│ 15 │ 2020-01-24 │ 114.13 │ 114.77 │ 110.85 │ 112.96 │ 112.96 │ 71768000 │ 1.00 │ +├────┼────────────┼────────┼────────┼────────┼────────┼───────────┼───────────┼────────┤ +│ 16 │ 2020-01-27 │ 108.40 │ 112.89 │ 107.86 │ 111.60 │ 111.60 │ 68040500 │ 1.00 │ +├────┼────────────┼────────┼────────┼────────┼────────┼───────────┼───────────┼────────┤ +│ 17 │ 2020-01-28 │ 113.70 │ 115.36 │ 111.62 │ 113.38 │ 113.38 │ 58942500 │ 1.00 │ +├────┼────────────┼────────┼────────┼────────┼────────┼───────────┼───────────┼────────┤ +│ 18 │ 2020-01-29 │ 115.14 │ 117.96 │ 113.49 │ 116.20 │ 116.20 │ 89007500 │ 1.00 │ +├────┼────────────┼────────┼────────┼────────┼────────┼───────────┼───────────┼────────┤ +│ 19 │ 2020-01-30 │ 126.48 │ 130.18 │ 123.60 │ 128.16 │ 128.16 │ 145028500 │ 1.00 │ +├────┼────────────┼────────┼────────┼────────┼────────┼───────────┼───────────┼────────┤ +│ 20 │ 2020-01-31 │ 128.00 │ 130.60 │ 126.50 │ 130.11 │ 130.11 │ 78596500 │ 1.00 │ +├────┼────────────┼────────┼────────┼────────┼────────┼───────────┼───────────┼────────┤ +│ 21 │ 2020-02-03 │ 134.74 │ 157.23 │ 134.70 │ 156.00 │ 156.00 │ 235325000 │ 1.00 │ +├────┼────────────┼────────┼────────┼────────┼────────┼───────────┼───────────┼────────┤ +│ 22 │ 2020-02-04 │ 176.59 │ 193.80 │ 166.78 │ 177.41 │ 177.41 │ 304694000 │ 1.00 │ +├────┼────────────┼────────┼────────┼────────┼────────┼───────────┼───────────┼────────┤ +│ 23 │ 2020-02-05 │ 164.65 │ 169.20 │ 140.82 │ 146.94 │ 146.94 │ 242119000 │ 1.00 │ +├────┼────────────┼────────┼────────┼────────┼────────┼───────────┼───────────┼────────┤ +│ 24 │ 2020-02-06 │ 139.98 │ 159.17 │ 137.40 │ 149.79 │ 149.79 │ 199404000 │ 1.00 │ +├────┼────────────┼────────┼────────┼────────┼────────┼───────────┼───────────┼────────┤ +│ 25 │ 2020-02-07 │ 146.11 │ 153.95 │ 146.00 │ 149.61 │ 149.61 │ 85317500 │ 1.00 │ +├────┼────────────┼────────┼────────┼────────┼────────┼───────────┼───────────┼────────┤ +│ 26 │ 2020-02-10 │ 160.00 │ 164.00 │ 150.48 │ 154.26 │ 154.26 │ 123446000 │ 1.00 │ +├────┼────────────┼────────┼────────┼────────┼────────┼───────────┼───────────┼────────┤ +│ 27 │ 2020-02-11 │ 153.76 │ 156.70 │ 151.60 │ 154.88 │ 154.88 │ 58487500 │ 1.00 │ +├────┼────────────┼────────┼────────┼────────┼────────┼───────────┼───────────┼────────┤ +│ 28 │ 2020-02-12 │ 155.57 │ 157.95 │ 152.67 │ 153.46 │ 153.46 │ 60112500 │ 1.00 │ +├────┼────────────┼────────┼────────┼────────┼────────┼───────────┼───────────┼────────┤ +│ 29 │ 2020-02-13 │ 148.37 │ 163.60 │ 147.00 │ 160.80 │ 160.80 │ 131446500 │ 1.00 │ +└────┴────────────┴────────┴────────┴────────┴────────┴───────────┴───────────┴────────┘ +``` +--- diff --git a/website/content/terminal/reference/forecast/sto.md b/website/content/terminal/reference/forecast/sto.md new file mode 100644 index 000000000000..1bd18b35ac3a --- /dev/null +++ b/website/content/terminal/reference/forecast/sto.md @@ -0,0 +1,108 @@ +--- +title: sto +description: Details on the usage, parameters, and examples of the 'sto' command in + adding the Stochastic Oscillator %K and %D. 'sto' can help users understand and + interpret the predictive model through stochastic oscillation analysis. +keywords: +- Stochastic Oscillator +- sto command +- Predictive Model Analysis +- Technical Indicator +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Add in Stochastic Oscillator %K and %D + +### Usage + +```python +sto [--close-col CLOSE_COL] [--high-col HIGH_COL] [--low-col LOW_COL] [-d {}] [--period PERIOD] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| close_col | Close column name to use for Stochastic Oscillator | close | True | None | +| high_col | High column name to use for Stochastic Oscillator | high | True | None | +| low_col | Low column name to use for Stochastic Oscillator | low | True | None | +| target_dataset | The name of the dataset you want to select | None | True | None | +| period | The period to use | 10 | True | None | + + +--- + +## Examples + +```python +(🦋) /forecast/ $ load TSLA.csv + +(🦋) /forecast/ $ show TSLA +TSLA dataset has shape (row, column): (611, 7) + + Dataset TSLA | Showing 10 of 611 rows +┏━━━┳━━━━━━━━━━━━┳━━━━━━━━┳━━━━━━━━┳━━━━━━━━┳━━━━━━━━┳━━━━━━━━━━━┳━━━━━━━━━━━┓ +┃ ┃ date ┃ open ┃ high ┃ low ┃ close ┃ adj_close ┃ volume ┃ +┡━━━╇━━━━━━━━━━━━╇━━━━━━━━╇━━━━━━━━╇━━━━━━━━╇━━━━━━━━╇━━━━━━━━━━━╇━━━━━━━━━━━┩ +│ 0 │ 2020-01-02 │ 84.90 │ 86.14 │ 84.34 │ 86.05 │ 86.05 │ 47660500 │ +├───┼────────────┼────────┼────────┼────────┼────────┼───────────┼───────────┤ +│ 1 │ 2020-01-03 │ 88.10 │ 90.80 │ 87.38 │ 88.60 │ 88.60 │ 88892500 │ +├───┼────────────┼────────┼────────┼────────┼────────┼───────────┼───────────┤ +│ 2 │ 2020-01-06 │ 88.09 │ 90.31 │ 88.00 │ 90.31 │ 90.31 │ 50665000 │ +├───┼────────────┼────────┼────────┼────────┼────────┼───────────┼───────────┤ +│ 3 │ 2020-01-07 │ 92.28 │ 94.33 │ 90.67 │ 93.81 │ 93.81 │ 89410500 │ +├───┼────────────┼────────┼────────┼────────┼────────┼───────────┼───────────┤ +│ 4 │ 2020-01-08 │ 94.74 │ 99.70 │ 93.65 │ 98.43 │ 98.43 │ 155721500 │ +├───┼────────────┼────────┼────────┼────────┼────────┼───────────┼───────────┤ +│ 5 │ 2020-01-09 │ 99.42 │ 99.76 │ 94.57 │ 96.27 │ 96.27 │ 142202000 │ +├───┼────────────┼────────┼────────┼────────┼────────┼───────────┼───────────┤ +│ 6 │ 2020-01-10 │ 96.36 │ 96.99 │ 94.74 │ 95.63 │ 95.63 │ 64797500 │ +├───┼────────────┼────────┼────────┼────────┼────────┼───────────┼───────────┤ +│ 7 │ 2020-01-13 │ 98.70 │ 105.13 │ 98.40 │ 104.97 │ 104.97 │ 132588000 │ +├───┼────────────┼────────┼────────┼────────┼────────┼───────────┼───────────┤ +│ 8 │ 2020-01-14 │ 108.85 │ 109.48 │ 104.98 │ 107.58 │ 107.58 │ 144981000 │ +├───┼────────────┼────────┼────────┼────────┼────────┼───────────┼───────────┤ +│ 9 │ 2020-01-15 │ 105.95 │ 107.57 │ 103.36 │ 103.70 │ 103.70 │ 86844000 │ +└───┴────────────┴────────┴────────┴────────┴────────┴───────────┴───────────┘ + +(🦋) /forecast/ $ sto TSLA +Successfully added 'STOK&D_10' to 'TSLA' dataset + +(🦋) /forecast/ $ show TSLA +TSLA dataset has shape (row, column): (611, 9) + + Dataset TSLA | Showing 10 of 611 rows +┏━━━┳━━━━━━━━━━━━┳━━━━━━━━┳━━━━━━━━┳━━━━━━━━┳━━━━━━━━┳━━━━━━━━━━━┳━━━━━━━━━━━┳━━━━━━━━━┳━━━━━━━━━┓ +┃ ┃ date ┃ open ┃ high ┃ low ┃ close ┃ adj_close ┃ volume ┃ SO%K_10 ┃ SO%D_10 ┃ +┡━━━╇━━━━━━━━━━━━╇━━━━━━━━╇━━━━━━━━╇━━━━━━━━╇━━━━━━━━╇━━━━━━━━━━━╇━━━━━━━━━━━╇━━━━━━━━━╇━━━━━━━━━┩ +│ 0 │ 2020-01-02 │ 84.90 │ 86.14 │ 84.34 │ 86.05 │ 86.05 │ 47660500 │ nan │ nan │ +├───┼────────────┼────────┼────────┼────────┼────────┼───────────┼───────────┼─────────┼─────────┤ +│ 1 │ 2020-01-03 │ 88.10 │ 90.80 │ 87.38 │ 88.60 │ 88.60 │ 88892500 │ nan │ nan │ +├───┼────────────┼────────┼────────┼────────┼────────┼───────────┼───────────┼─────────┼─────────┤ +│ 2 │ 2020-01-06 │ 88.09 │ 90.31 │ 88.00 │ 90.31 │ 90.31 │ 50665000 │ nan │ nan │ +├───┼────────────┼────────┼────────┼────────┼────────┼───────────┼───────────┼─────────┼─────────┤ +│ 3 │ 2020-01-07 │ 92.28 │ 94.33 │ 90.67 │ 93.81 │ 93.81 │ 89410500 │ nan │ nan │ +├───┼────────────┼────────┼────────┼────────┼────────┼───────────┼───────────┼─────────┼─────────┤ +│ 4 │ 2020-01-08 │ 94.74 │ 99.70 │ 93.65 │ 98.43 │ 98.43 │ 155721500 │ nan │ nan │ +├───┼────────────┼────────┼────────┼────────┼────────┼───────────┼───────────┼─────────┼─────────┤ +│ 5 │ 2020-01-09 │ 99.42 │ 99.76 │ 94.57 │ 96.27 │ 96.27 │ 142202000 │ nan │ nan │ +├───┼────────────┼────────┼────────┼────────┼────────┼───────────┼───────────┼─────────┼─────────┤ +│ 6 │ 2020-01-10 │ 96.36 │ 96.99 │ 94.74 │ 95.63 │ 95.63 │ 64797500 │ nan │ nan │ +├───┼────────────┼────────┼────────┼────────┼────────┼───────────┼───────────┼─────────┼─────────┤ +│ 7 │ 2020-01-13 │ 98.70 │ 105.13 │ 98.40 │ 104.97 │ 104.97 │ 132588000 │ nan │ nan │ +├───┼────────────┼────────┼────────┼────────┼────────┼───────────┼───────────┼─────────┼─────────┤ +│ 8 │ 2020-01-14 │ 108.85 │ 109.48 │ 104.98 │ 107.58 │ 107.58 │ 144981000 │ nan │ nan │ +├───┼────────────┼────────┼────────┼────────┼────────┼───────────┼───────────┼─────────┼─────────┤ +│ 9 │ 2020-01-15 │ 105.95 │ 107.57 │ 103.36 │ 103.70 │ 103.70 │ 86844000 │ 77.00 │ nan │ +└───┴────────────┴────────┴────────┴────────┴────────┴───────────┴───────────┴─────────┴─────────┘ + +(🦋) /forecast/ $ clean TSLA +Namespace(drop='', fill='', help=False, limit=5, target_dataset='TSLA') +Successfully cleaned 'TSLA' dataset +``` +--- diff --git a/website/content/terminal/reference/forecast/tcn.md b/website/content/terminal/reference/forecast/tcn.md new file mode 100644 index 000000000000..78575088bba0 --- /dev/null +++ b/website/content/terminal/reference/forecast/tcn.md @@ -0,0 +1,95 @@ +--- +title: tcn +description: This page explains the usage, parameters, and examples of the TCN forecast + function used for time series forecasting. The function includes various adjustable + parameters for fine-tuning the model's performance and supports the option to save + the output data. +keywords: +- TCN +- forecast +- time series forecasting +- data modeling +- parameters +- examples +- docusaurus +- metadata +- marketing website page +- code examples +- machine learning model +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Perform TCN forecast: https://unit8co.github.io/darts/generated_api/darts.models.forecasting.tcn_model.html + +### Usage + +```python +tcn [--num-filters NUM_FILTERS] [--weight-norm WEIGHT_NORM] [--dilation-base DILATION_BASE] [--past-covariates PAST_COVARIATES] [--all-past-covariates] [--naive] [-d {}] [-c TARGET_COLUMN] [-n N_DAYS] [-t TRAIN_SPLIT] [-i INPUT_CHUNK_LENGTH] [-o OUTPUT_CHUNK_LENGTH] [--force-reset FORCE_RESET] [--save-checkpoints SAVE_CHECKPOINTS] [--model-save-name MODEL_SAVE_NAME] [--n-epochs N_EPOCHS] [--dropout DROPOUT] [--batch-size BATCH_SIZE] [--end S_END_DATE] [--start S_START_DATE] [--learning-rate LEARNING_RATE] [--residuals] [--forecast-only] [--export-pred-raw] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| num_filters | The number of filters in a convolutional layer of the TCN | 3 | True | None | +| weight_norm | Boolean value indicating whether to use weight normalization. | True | True | None | +| dilation_base | The base of the exponent that will determine the dilation on every level. | 2 | True | None | +| past_covariates | Past covariates(columns/features) in same dataset. Comma separated. | None | True | None | +| all_past_covariates | Adds all rows as past covariates except for date and the target column. | False | True | None | +| naive | Show the naive baseline for a model. | False | True | None | +| target_dataset | The name of the dataset you want to select | None | True | None | +| target_column | The name of the specific column you want to use | close | True | None | +| n_days | prediction days. | 5 | True | None | +| train_split | Start point for rolling training and forecast window. 0.0-1.0 | 0.85 | True | None | +| input_chunk_length | Number of past time steps for forecasting module at prediction time. | 14 | True | None | +| output_chunk_length | The length of the forecast of the model. | 5 | True | None | +| force_reset | If set to True, any previously-existing model with the same name will be reset (all checkpoints will be discarded). | True | True | None | +| save_checkpoints | Whether to automatically save the untrained model and checkpoints. | True | True | None | +| model_save_name | Name of the model to save. | tcn_model | True | None | +| n_epochs | Number of epochs over which to train the model. | 300 | True | None | +| dropout | Fraction of neurons affected by Dropout, from 0 to 1. | 0.1 | True | None | +| batch_size | Number of time series (input and output) used in each training pass | 32 | True | None | +| s_end_date | The end date (format YYYY-MM-DD) to select for testing | None | True | None | +| s_start_date | The start date (format YYYY-MM-DD) to select for testing | None | True | None | +| learning_rate | Learning rate during training. | 0.001 | True | None | +| residuals | Show the residuals for the model. | False | True | None | +| forecast_only | Do not plot the historical data without forecasts. | False | True | None | +| export_pred_raw | Export predictions to a csv file. | False | True | None | + + +--- + +## Examples + +```python +2022 Jul 23, 10:36 (🦋) /forecast/ $ load GME_20220719_123734.csv -a GME + +2022 Jul 23, 11:08 (🦋) /forecast/ $ tcn GME +100%|██████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████| 115/115 [00:0100:00, 111.85it/s] +TCN model obtains MAPE: 19.12% + + + + Actual price: $ 146.64 +┏━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━┓ +┃ Datetime ┃ Prediction ┃ +┡━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━┩ +│ 2022-07-19 00:00:00 │ $ 135.73 │ +├─────────────────────┼────────────┤ +│ 2022-07-20 00:00:00 │ $ 142.42 │ +├─────────────────────┼────────────┤ +│ 2022-07-21 00:00:00 │ $ 140.68 │ +├─────────────────────┼────────────┤ +│ 2022-07-22 00:00:00 │ $ 152.98 │ +├─────────────────────┼────────────┤ +│ 2022-07-25 00:00:00 │ $ 154.55 │ +└─────────────────────┴────────────┘ +``` +![tcn](https://user-images.githubusercontent.com/72827203/180615408-ac6f9289-c3e9-486f-b262-701ef1906373.png) + +--- diff --git a/website/content/terminal/reference/forecast/tft.md b/website/content/terminal/reference/forecast/tft.md new file mode 100644 index 000000000000..2f50bf699597 --- /dev/null +++ b/website/content/terminal/reference/forecast/tft.md @@ -0,0 +1,97 @@ +--- +title: tft +description: This page provides detailed instructions on how to perform temporal forecasting + using the Temporal Fusion Transformer (TFT). It includes usage examples, parameter + explanations, and result predictions. It's an exceptional resource if you're looking + to understand or implement the TFT for data analysis and machine learning purposes. +keywords: +- Temporal Fusion Transformer +- Temporal forecasting +- Data analysis +- TFT parameters +- Model prediction +- Darts.TFT +- Darts.models.forecasting +- Model training +- Data Science +- Machine Learning +- Forecasting Techniques +- Time Series Forecasting +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Perform TFT forecast (Temporal Fusion Transformer): https://unit8co.github.io/darts/generated_api/darts.models.forecasting.tft_model.html + +### Usage + +```python +tft [--lstm-layers LSTM_LAYERS] [--num-attention-heads NUM_ATTENTION_HEADS] [--full-attention] [--hidden-continuous-size HIDDEN_CONTINUOUS_SIZE] [--hidden-size HIDDEN_SIZE] [--past-covariates PAST_COVARIATES] [--all-past-covariates] [--naive] [-d {}] [-c TARGET_COLUMN] [-n N_DAYS] [-t TRAIN_SPLIT] [-i INPUT_CHUNK_LENGTH] [-o OUTPUT_CHUNK_LENGTH] [--force-reset FORCE_RESET] [--save-checkpoints SAVE_CHECKPOINTS] [--model-save-name MODEL_SAVE_NAME] [--n-epochs N_EPOCHS] [--dropout DROPOUT] [--batch-size BATCH_SIZE] [--end S_END_DATE] [--start S_START_DATE] [--residuals] [--forecast-only] [--export-pred-raw] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| lstm_layers | Number of LSTM layers. | 1 | True | None | +| num_attention_heads | Number of attention heads. | 4 | True | None | +| full_attention | Whether to apply a multi-head attention query. | False | True | None | +| hidden_continuous_size | Default hidden size for processing continuous variables. | 8 | True | None | +| hidden_size | Size for feature maps for each hidden RNN layer (h_n) | 16 | True | None | +| past_covariates | Past covariates(columns/features) in same dataset. Comma separated. | None | True | None | +| all_past_covariates | Adds all rows as past covariates except for date and the target column. | False | True | None | +| naive | Show the naive baseline for a model. | False | True | None | +| target_dataset | The name of the dataset you want to select | None | True | None | +| target_column | The name of the specific column you want to use | close | True | None | +| n_days | prediction days. | 5 | True | None | +| train_split | Start point for rolling training and forecast window. 0.0-1.0 | 0.85 | True | None | +| input_chunk_length | Number of past time steps for forecasting module at prediction time. | 14 | True | None | +| output_chunk_length | The length of the forecast of the model. | 5 | True | None | +| force_reset | If set to True, any previously-existing model with the same name will be reset (all checkpoints will be discarded). | True | True | None | +| save_checkpoints | Whether to automatically save the untrained model and checkpoints. | True | True | None | +| model_save_name | Name of the model to save. | tft_model | True | None | +| n_epochs | Number of epochs over which to train the model. | 300 | True | None | +| dropout | Fraction of neurons affected by Dropout, from 0 to 1. | 0.1 | True | None | +| batch_size | Number of time series (input and output) used in each training pass | 32 | True | None | +| s_end_date | The end date (format YYYY-MM-DD) to select for testing | None | True | None | +| s_start_date | The start date (format YYYY-MM-DD) to select for testing | None | True | None | +| residuals | Show the residuals for the model. | False | True | None | +| forecast_only | Do not plot the historical data without forecasts. | False | True | None | +| export_pred_raw | Export predictions to a csv file. | False | True | None | + + +--- + +## Examples + +```python +2022 Jul 23, 10:36 (🦋) /forecast/ $ load GME_20220719_123734.csv -a GME + +2022 Jul 23, 11:03 (🦋) /forecast/ $ tft GME +100%|███████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████| 115/115 [00:0700:00, 15.10it/s] +TFT model obtains MAPE: 44.60% + + + + Actual price: $ 146.64 +┏━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━┓ +┃ Datetime ┃ Prediction ┃ +┡━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━┩ +│ 2022-07-19 00:00:00 │ $ 169.69 │ +├─────────────────────┼────────────┤ +│ 2022-07-20 00:00:00 │ $ 168.53 │ +├─────────────────────┼────────────┤ +│ 2022-07-21 00:00:00 │ $ 167.33 │ +├─────────────────────┼────────────┤ +│ 2022-07-22 00:00:00 │ $ 167.23 │ +├─────────────────────┼────────────┤ +│ 2022-07-25 00:00:00 │ $ 165.82 │ +└─────────────────────┴────────────┘ +``` +![tft](https://user-images.githubusercontent.com/72827203/180615444-47bcdd54-0693-4415-9617-ed3a571b26c6.png) + +--- diff --git a/website/content/terminal/reference/forecast/theta.md b/website/content/terminal/reference/forecast/theta.md new file mode 100644 index 000000000000..3d2e7ceb3373 --- /dev/null +++ b/website/content/terminal/reference/forecast/theta.md @@ -0,0 +1,78 @@ +--- +title: theta +description: This page provides a detailed guide on how to perform a Theta forecast + using Python. Parameters with their descriptions and the process of exporting predictions + to a CSV file are covered as well. +keywords: +- Theta forecast +- Predictive Modelling +- Historical Data +- Seasonality +- Forecasting +- Model Parameters +- Profit Forecast +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Perform Theta forecast: https://unit8co.github.io/darts/generated_api/darts.models.forecasting.theta.html + +### Usage + +```python +theta [--naive] [-d {}] [-c TARGET_COLUMN] [-n N_DAYS] [-s {N,A,M}] [-p SEASONAL_PERIODS] [-w START_WINDOW] [--end S_END_DATE] [--start S_START_DATE] [--residuals] [--forecast-only] [--export-pred-raw] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| naive | Show the naive baseline for a model. | False | True | None | +| target_dataset | The name of the dataset you want to select | None | True | None | +| target_column | The name of the specific column you want to use | close | True | None | +| n_days | prediction days. | 5 | True | None | +| seasonal | Seasonality: N: None, A: Additive, M: Multiplicative. | M | True | N, A, M | +| seasonal_periods | Seasonal periods: 4: Quarterly, 7: Daily | 7 | True | None | +| start_window | Start point for rolling training and forecast window. 0.0-1.0 | 0.85 | True | None | +| s_end_date | The end date (format YYYY-MM-DD) to select for testing | None | True | None | +| s_start_date | The start date (format YYYY-MM-DD) to select for testing | None | True | None | +| residuals | Show the residuals for the model. | False | True | None | +| forecast_only | Do not plot the historical data without forecasts. | False | True | None | +| export_pred_raw | Export predictions to a csv file. | False | True | None | + + +--- + +## Examples + +```python +2022 Jul 23, 10:36 (🦋) /forecast/ $ load GME_20220719_123734.csv -a GME + +2022 Jul 23, 11:01 (🦋) /forecast/ $ theta GME +100%|███████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████| 115/115 [00:2300:00, 4.88it/s] +Theta Model obtains MAPE: 12.71% + + + + Actual price: $ 146.64 +┏━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━┓ +┃ Datetime ┃ Prediction ┃ +┡━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━┩ +│ 2022-07-19 00:00:00 │ $ 145.41 │ +├─────────────────────┼────────────┤ +│ 2022-07-20 00:00:00 │ $ 147.28 │ +├─────────────────────┼────────────┤ +│ 2022-07-21 00:00:00 │ $ 147.28 │ +├─────────────────────┼────────────┤ +│ 2022-07-22 00:00:00 │ $ 148.66 │ +├─────────────────────┼────────────┤ +│ 2022-07-25 00:00:00 │ $ 147.18 │ +└─────────────────────┴────────────┘ +``` +![theta](https://user-images.githubusercontent.com/72827203/180615324-5b50445c-cc95-4efa-84a6-85e85ddc2d28.png) + +--- diff --git a/website/content/terminal/reference/forecast/trans.md b/website/content/terminal/reference/forecast/trans.md new file mode 100644 index 000000000000..670156aac270 --- /dev/null +++ b/website/content/terminal/reference/forecast/trans.md @@ -0,0 +1,91 @@ +--- +title: trans +description: This documentation page provides an in-depth guide on how to perform + Transformer Forecast using the trans function. It details usage, parameters with + their descriptions, defaults, whether they are optional, and their choices. It also + includes examples of application. +keywords: +- trans function +- Transformer Forecast +- parameter guidance +- programming +- examples +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Perform Transformer Forecast: https://unit8co.github.io/darts/generated_api/darts.models.forecasting.transformer_model.html + +### Usage + +```python +trans [--d-model D_MODEL] [--nhead NHEAD] [--num_encoder_layers NUM_ENCODER_LAYERS] [--num_decoder_layers NUM_DECODER_LAYERS] [--dim_feedforward DIM_FEEDFORWARD] [--activation {relu,gelu}] [--past-covariates PAST_COVARIATES] [--all-past-covariates] [--naive] [-d {}] [-c TARGET_COLUMN] [-n N_DAYS] [-t TRAIN_SPLIT] [-i INPUT_CHUNK_LENGTH] [-o OUTPUT_CHUNK_LENGTH] [--force-reset FORCE_RESET] [--save-checkpoints SAVE_CHECKPOINTS] [--model-save-name MODEL_SAVE_NAME] [--n-epochs N_EPOCHS] [--dropout DROPOUT] [--batch-size BATCH_SIZE] [--end S_END_DATE] [--start S_START_DATE] [--residuals] [--forecast-only] [--export-pred-raw] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| d_model | Number of expected features in inputs. | 64 | True | None | +| nhead | Number of head in the attention mechanism. | 4 | True | None | +| num_encoder_layers | The number of encoder layers in the encoder. | 3 | True | None | +| num_decoder_layers | The number of decoder layers in the encoder. | 3 | True | None | +| dim_feedforward | The dimension of the feedforward model. | 512 | True | None | +| activation | Number of LSTM layers. | relu | True | relu, gelu | +| past_covariates | Past covariates(columns/features) in same dataset. Comma separated. | None | True | None | +| all_past_covariates | Adds all rows as past covariates except for date and the target column. | False | True | None | +| naive | Show the naive baseline for a model. | False | True | None | +| target_dataset | The name of the dataset you want to select | None | True | None | +| target_column | The name of the specific column you want to use | close | True | None | +| n_days | prediction days. | 5 | True | None | +| train_split | Start point for rolling training and forecast window. 0.0-1.0 | 0.85 | True | None | +| input_chunk_length | Number of past time steps for forecasting module at prediction time. | 14 | True | None | +| output_chunk_length | The length of the forecast of the model. | 5 | True | None | +| force_reset | If set to True, any previously-existing model with the same name will be reset (all checkpoints will be discarded). | True | True | None | +| save_checkpoints | Whether to automatically save the untrained model and checkpoints. | True | True | None | +| model_save_name | Name of the model to save. | trans_model | True | None | +| n_epochs | Number of epochs over which to train the model. | 300 | True | None | +| dropout | Fraction of neurons affected by Dropout, from 0 to 1. | 0 | True | None | +| batch_size | Number of time series (input and output) used in each training pass | 32 | True | None | +| s_end_date | The end date (format YYYY-MM-DD) to select for testing | None | True | None | +| s_start_date | The start date (format YYYY-MM-DD) to select for testing | None | True | None | +| residuals | Show the residuals for the model. | False | True | None | +| forecast_only | Do not plot the historical data without forecasts. | False | True | None | +| export_pred_raw | Export predictions to a csv file. | False | True | None | + + +--- + +## Examples + +```python +2022 Jul 23, 10:36 (🦋) /forecast/ $ load GME_20220719_123734.csv -a GME + +2022 Jul 23, 11:01 (🦋) /forecast/ $ trans GME +100%|███████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████████| 115/115 [00:2300:00, 4.88it/s] +Transformer model obtains MAPE: 13.11% + + + + Actual price: $ 146.64 +┏━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━┓ +┃ Datetime ┃ Prediction ┃ +┡━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━┩ +│ 2022-07-19 00:00:00 │ $ 145.63 │ +├─────────────────────┼────────────┤ +│ 2022-07-20 00:00:00 │ $ 142.28 │ +├─────────────────────┼────────────┤ +│ 2022-07-21 00:00:00 │ $ 137.67 │ +├─────────────────────┼────────────┤ +│ 2022-07-22 00:00:00 │ $ 137.33 │ +├─────────────────────┼────────────┤ +│ 2022-07-25 00:00:00 │ $ 130.62 │ +└─────────────────────┴────────────┘ +``` +![trans](https://user-images.githubusercontent.com/72827203/180615423-948cc67c-cead-4e13-9cab-c348bc4c86ab.png) + +--- diff --git a/website/content/terminal/reference/forecast/which.md b/website/content/terminal/reference/forecast/which.md new file mode 100644 index 000000000000..7a56c36c3315 --- /dev/null +++ b/website/content/terminal/reference/forecast/which.md @@ -0,0 +1,52 @@ +--- +title: which +description: This page provides instructions on how to show library versions of required + packages using the function 'which'. +keywords: +- docusaurus +- which function +- library versions +- required packages +- Torch version +- Darts version +- Commands +- CPU +- RAM +- Dataset size +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Show library versions of required packages. + +### Usage + +```python +which +``` + +--- + +## Parameters + +This command has no parameters + + + +--- + +## Examples + +```python +2022 Sep 15, 00:04 (🦋) /forecast/ $ which +which + +Current Compute Device (CPU or GPU): CPU +Current RAM: 16.0G +Recommended Max dataset size based on current RAM: 5.0G +Torch version: 1.11.0 +Darts version: 0.21.0 +``` +--- diff --git a/website/versioned_docs/version-v3/terminal/reference/forex/_category_.json b/website/content/terminal/reference/forex/_category_.json similarity index 100% rename from website/versioned_docs/version-v3/terminal/reference/forex/_category_.json rename to website/content/terminal/reference/forex/_category_.json diff --git a/website/content/terminal/reference/forex/candle.md b/website/content/terminal/reference/forex/candle.md new file mode 100644 index 000000000000..5b1d871958f2 --- /dev/null +++ b/website/content/terminal/reference/forex/candle.md @@ -0,0 +1,48 @@ +--- +title: candle +description: This documentation is for the 'candle' function used to show loaded fx + data. It provides usage details, parameters explanations and choices, including + plotly, sort, reverse, raw, trendlines, moving averages, and more, along with a + graphical presentation. +keywords: +- candle function +- loaded fx data +- interactive plotly chart +- sort data +- reverse flag +- raw data +- trendlines +- moving average +- log scale +- fx data visualization +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Show candle for loaded fx data + +### Usage + +```python +candle [-p] [--sort {adjclose,open,close,high,low,volume,logret}] [-r] [--raw] [-t] [--ma MOV_AVG] [--log] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| plotly | Flag to show interactive plotly chart | True | True | None | +| sort | Choose a column to sort by. Only works when raw data is displayed. | | True | adjclose, open, close, high, low, volume, logret | +| reverse | Data is sorted in descending order by default. Reverse flag will sort it in an ascending way. Only works when raw data is displayed. | False | True | None | +| raw | Shows raw data instead of chart. | False | True | None | +| trendlines | Flag to add high and low trends to candle | False | True | None | +| mov_avg | Add moving average in number of days to plot and separate by a comma. Value for ma (moving average) keyword needs to be greater than 1. | None | True | None | +| logy | Plot with y axis on log scale | False | True | None | + +![candle](https://user-images.githubusercontent.com/46355364/154029283-2e5e472b-4c2b-4e88-8fbe-f6a0925898b8.png) + +--- diff --git a/website/content/terminal/reference/forex/fwd.md b/website/content/terminal/reference/forex/fwd.md new file mode 100644 index 000000000000..d5fd9a465f3b --- /dev/null +++ b/website/content/terminal/reference/forex/fwd.md @@ -0,0 +1,32 @@ +--- +title: fwd +description: A documentation page for the 'fwd' command which provides forward rates + for a loaded pair. Its usage and parameters are explained. +keywords: +- fwd command +- forward rates +- loaded pair +- command usage +- parameters +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Get forward rates for loaded pair. + +### Usage + +```python +fwd +``` + +--- + +## Parameters + +This command has no parameters + + +--- diff --git a/website/content/terminal/reference/forex/load.md b/website/content/terminal/reference/forex/load.md new file mode 100644 index 000000000000..557867b2415b --- /dev/null +++ b/website/content/terminal/reference/forex/load.md @@ -0,0 +1,40 @@ +--- +title: load +description: This page documents how to load historical exchange rate data from Alpha + Advantage and YahooFinance. It provides code usage standards in Python and explains + the parameters for the source, the resolution, the interval, and the start date + of data. +keywords: +- load historical exchange rate data +- Alpha Advantage +- YahooFinance +- resolution of data +- intervals of intraday data +- start date of data +- currency pairs +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Load historical exchange rate data.Available data sources are Alpha Advantage and YahooFinanceBy default main source used for analysis is YahooFinance (yf). To change it use --source av + +### Usage + +```python +load [-t TICKER] [-r {i,d,w,m}] [-i {1min,5min,15min,30min,60min,90min,1hour,1day,5day,1week,1month,3month}] [-s START_DATE] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| ticker | Currency pair to load. | None | True | AUDCHF, ZARPLN, DKKNZD, XAGUSD, USDRWF, MYREUR, ZAREUR, MWKGBP, USDBSD, ALLGBP, MXNZAR, HUFUSD, BRLARS, OMRAED, ZARUGX, GBPCZK, XAUCNY, MURGBP, EURLSL, EURBWP, AEDPKR, XAGBRL, XAUGBP, IDRKRW, BRICHF, VNDJPY, MADAUD, GBPBMD, USDTMT, HRKUSD, HUFPLN, HUFDKK, SGDGBP, KZTGBP, AUNUSD, EURCNY, HUFCAD, GBPSEK, ZARIDR, JPYTHB, MDLGBP, IDRCHF, KWDAED, SARJPY, GBPRON, ARSPEN, TWDCHF, INREUR, DKKCAD, USDCZK, AUDIDR, SARUSD, THBINR, XAUCAD, GHSGBP, EURKHR, ZMWZAR, ILSSEK, SGDTHB, EURKYD, USDMGA, ZARNOK, SGDCAD, SEKINR, DKKRUB, THBUSD, USDMYR, USDUZS, ZARSZL, JPYCLP, UAHUSD, JPYMXN, JPYNOK, AUDCNY, EURGYD, GBPBDT, PENUSD, ZARPHP, MXNARS, PLNCZK, GBPAUD, AEDAUD, RUBPLN, USDSDG, EURSCR, HKDMXN, RUBCHF, TRYJPY, OSOUSD, GBPMAD, EURTJS, PKREUR, EURCDF, AUDCAD, USDRSD, JPYCZK, BRLCLP, MWKUSD, ISKCHF, GBPBTN, BAMGBP, ILSZAR, SEKZAR, HUFZAR, QARAED, SARKWD, MYRHKD, RONZAR, JPYSAR, BHDPKR, DOPUSD, AUDGBP, INRHKD, XAUAUD, IDRAUD, XAUHKD, KRWSGD, AUDNZD, JPYGBP, KESUSD, KRWRUB, TNDGBP, USDEUR, BWPGBP, DKKMYR, GBPNGN, QARPKR, TWDCAD, BMDGBP, HUFJPY, GBPSCR, EURMVR, KHRGBP, LKRZAR, ZARBWP, EURIDR, GBPUAH, GBPGYD, ZARTND, KRWUSD, AUDMAD, ZARPKR, NZDGBP, AEDSAR, MYRIDR, XPTEUR, GHSZAR, SGDSEK, PENCAD, HKDZAR, SGDJPY, TRYUSD, GBPAMD, EURCOP, NZDZAR, DKKSGD, IDRTHB, AEDSEK, BDTGBP, AUDTHB, XAUKRW, GBPRUB, GBPYER, USDMVR, BRLMXN, TTDGBP, GBPBBD, EURPLN, SGDUSD, AUDILS, EURAED, NSOUSD, VRLCHF, SCRUSD, RWFUSD, ZARHKD, EURNZD, IDRZAR, TWDINR, KRWZAR, ZARNAD, HRKPLN, BAMUSD, EUREGP, NPRUSD, KRWTWD, XAUJPY, USDBHD, BNDGBP, EURBMD, EURNOK, MXNUSD, USDEGP, XPTGBP, ARSCOP, NZDCHF, NZDJPY, KRWCAD, EURBRL, DKKSEK, MALCHF, SOSUSD, GBPCUP, AUDCLP, EURUYU, EURUZS, UYUUSD, EURUSD, BWPZAR, NZDPLN, GBPLRD, IDRMYR, PABUSD, USDPKR, ARSCHF, MYRNZD, JODUSD, ARSHKD, EURMKD, EURLYD, XAGARS, ISKUSD, HKDSEK, USDTRY, RSDUSD, DKKAED, ZARMYR, KMFUSD, NGNZAR, IDRJPY, SARPKR, GBPMYR, ILSAUD, IDREUR, JPYAUD, QARUSD, GBPSLL, GBPEUR, PHPUSD, THBEUR, RUBEUR, USDMMK, XAGGBP, ZARARS, USDKMF, BZDUSD, SEKPLN, PLNJPY, GBPLBP, EURHNL, AUDPKR, KYDCAD, XAUZAR, MGAGBP, LRDUSD, NZDTRY, AUDHUF, USDLKR, EURNGN, BNDUSD, SGDIDR, MYRCAD, HKDPLN, EUROMR, EURSAR, GBPJPY, IDRHKD, MXNPEN, USDXPF, IQDGBP, USDPGK, INRCHF, NZDHKD, AUDHKD, BBDGBP, USDGTQ, NGNJPY, ARSSGD, GBPMOP, TWDMYR, BMDCAD, XPDUSD, USDDZD, EURBSD, SGDZAR, AUNCHF, ARSMXN, AUDFJD, UGXZAR, AUDARS, IQDUSD, MXNEUR, HKDAUD, XAGEUR, RONGBP, USDZMW, TRYSGD, INRSGD, GBPLAK, GBPMWK, EURKES, USDCUP, USDUYU, AUDJPY, XAGCAD, DKKCNY, USDJMD, MADGBP, ILSNOK, MUREUR, THBHKD, INRTHB, SAREUR, MYRGBP, AMDGBP, HKDARS, GBPARS, SGDAUD, INRTWD, BHDUSD, LRDGBP, GBPPAB, RONUSD, IDRNZD, MYRKRW, KMFGBP, ZARGHS, PLNMXN, USDHUF, ARECHF, BMDEUR, KYDGBP, AUDNOK, AUDCNH, TWDNZD, KWDEUR, EURZMW, KZTUSD, GBPBOB, GBPJMD, DKKCHF, EURCNH, SEKILS, AUDKRW, AWGGBP, HNLGBP, XAUEUR, NSOCHF, GBPLSL, USDBZD, ZARKES, SLLUSD, THBCHF, NOKUSD, EURCZK, HKDGBP, GBPTTD, MMKGBP, PGKGBP, BRLAUD, AEDDKK, EURBHD, JMDUSD, USDNGN, NOKRUB, SVCUSD, GBPQAR, LTLAUD, JPYTWD, USDRON, KRUCHF, SGDBRL, EGPPKR, EURJMD, MXNDKK, NZDMYR, USDLBP, MWKZAR, HRKAUD, MYRJPY, USDKWD, AUDBRL, EURYER, PLNGBP, IDRTWD, EGPEUR, EURPYG, ILSAED, EURKZT, DKKZAR, FJDUSD, NBLUSD, AEDEUR, PLNNOK, XPTUSD, MXNBRL, USDNAD, ZARUSD, NOKINR, ARSZAR, BOBGBP, RWFZAR, GBPLYD, USDUGX, GBPCHF, DKKAUD, PLNCHF, USDBIF, AUDSGD, MXNCZK, PENGBP, NOKAED, USDMKD, MKDGBP, PKRUSD, EURPGK, THBPKR, HTGUSD, SGDPKR, LKRGBP, EURPKR, ZARMXN, USDMXN, USDHRK, INRJPY, FRNCHF, MXNCLP, GBPNOK, SGDPLN, USDARS, OMRUSD, DKKBGN, INRSEK, USDCAD, XPDGBP, KESZAR, JPYPKR, BDTJPY, NPRGBP, EURZAR, MYRPKR, PGKAUD, KYDEUR, DKKISK, SGDEUR, MYRZAR, PLNDKK, BRLPEN, ZMWUSD, TNDUSD, GHSEUR, PGKUSD, KYDBMD, SZLGBP, DKKMXN, BGNCAD, BRLCHF, INRMYR, GBPISK, SGDNOK, HKDTHB, TWDPKR, GBPPYG, NOKDKK, GBPTHB, EURJOD, EURUAH, RUBZAR, PENMXN, SGDNZD, HKDPKR, USDDOP, NZDHUF, KYDUSD, GBPBZD, EGPZAR, NZDUSD, KWDGBP, USDBAM, EURTTD, ZARCAD, AEDINR, EURTND, USDCDF, ZARCOP, KRWEUR, ILSEUR, SVCGBP, GBPBAM, IDRINR, DOECHF, ZARNGN, DOEUSD, THBCNY, GBPTND, MGAUSD, THBZAR, TWDJPY, SZLEUR, EURLAK, EURUGX, KRWCNY, DZDEUR, EURCHF, ZARGBP, MYRCHF, HKDINR, EURHRK, USDKRW, SEKEUR, MDLEUR, AEDBHD, RUBKRW, USDBND, NIOGBP, DKKUSD, NIOUSD, BDTUSD, USDILS, GBPSZL, NOKZAR, BRLRSD, HTGGBP, RUBSEK, EURLKR, SEKGBP, DKKCZK, THBCAD, EURVND, USDGNF, GBPPHP, MXNSGD, AUDMYR, EURGNF, USDKES, ETBGBP, EURBZD, GBPUGX, USDPAB, HNLUSD, ARSAUD, SGDARS, JODILS, GBPKHR, USDFJD, DKKNOK, GBPPEN, DKKINR, JPYKRW, ZARAUD, VNDCAD, TWDEUR, JPYSEK, ZARDKK, INRCAD, EURLBP, XCDGBP, HUFCHF, XAUMXN, XAUINR, GBPMKD, THBMYR, KWDPKR, USDJPY, DKKTHB, TWDHKD, NZDIDR, AEDNOK, PKRGBP, MXNRUB, ZARCZK, INRKRW, MYRTHB, NZDPKR, EURBBD, MYRSGD, JPYDKK, USDMWK, USDTND, NOKCHF, TWDAUD, NGNUSD, AUDZAR, SGDMXN, KRWHKD, MVRUSD, THBTWD, EURFJD, GBPUSD, GBPILS, GBPXCD, INRNZD, EURNIO, USDSLL, USDAUD, USDNZD, KRWINR, JPYMYR, ZARRUB, EURSEK, JPYARS, AEDCAD, MXNCOP, AUDMXN, XPDEUR, EURMDL, TWDKRW, XAGTRY, BRLSGD, USDSEK, AUDHRK, DKKPLN, DKKGBP, ZARKRW, BGNUSD, AEDGBP, EURILS, USDLRD, AUDSEK, ZARRON, VNDEUR, SCRGBP, AUDAED, GNFUSD, INRZAR, DKKEUR, ARSBRL, MXNCHF, GBPDOP, LYDUSD, EURSOS, EURMAD, USDPLN, USDCHF, DKKHUF, DJFGBP, EURAFN, TRYCHF, GBPGNF, PHPJPY, EURCAD, USDPYG, EURDOP, PENARS, EGPJPY, GBPVND, USDBWP, DKKTWD, PENCLP, GBPBHD, SEKCHF, PLNEUR, XAGRUB, MYRINR, THBGBP, EURPAB, USDMDL, EURTRY, USDHKD, EURRUB, ZARAED, AUDPLN, SGDCHF, ILSJPY, KRWAUD, OSOCHF, GBPMMK, SZLCHF, GBPKMF, KRWNZD, ARSCAD, JMDGBP, THBAUD, USDCOP, ZARRWF, SEKNOK, HKDCHF, ZARTHB, ALLUSD, SOSGBP, EURINR, EURMMK, USDBDT, AUDPGK, USDKHR, USDBOB, EURAUD, TWDDKK, XAGMXN, SGDKRW, USDSCR, XPFGBP, XAGHKD, GBPKWD, USDAED, MMKUSD, PENBRL, GBPAED, HKDTWD, TWDSGD, NOKILS, EURPHP, USDRUB, SLLGBP, RUBMXN, GBPMXN, EURDKK, GBPPLN, IDRSGD, DZDUSD, MXNHKD, AUDPHP, SEKJPY, USDPEN, SGDCNY, ZARJPY, NZDINR, SGDINR, HKDKRW, GBPMUR, ZAREGP, OMRGBP, USDVND, GBPRWF, ETBUSD, TWDZAR, GBPGTQ, XAURUB, MKDUSD, EURCUP, GBPNPR, SEKUSD, ZARCNY, EURMYR, USDZAR, NZDEUR, EURDZD, GBPKZT, GBPPGK, ZARCYP, RONCHF, AEDCHF, MXNGBP, MXNJPY, GBPBWP, EURALL, JPYILS, INRGBP, GBPFJD, GBPHRK, JODAED, KWDUSD, USDLSL, HKDJPY, AUDUSD, ARSCLP, KRWSEK, NZDCZK, USDMUR, SHPUSD, GBPKES, AUDTWD, HKDBRL, GTQUSD, GBPETB, USDCVE, GHSUSD, ZARSEK, BGNCNY, ILSPLN, GBPAFN, GBPCNH, BRIUSD, ZARBRL, GBPBND, GBPKYD, JPYHKD, EURMZN, DKKCOP, BOBUSD, ZARHUF, EURHUF, ZARINR, MURUSD, USDSAR, EURTHB, EURDJF, EURMGA, ZARSGD, NZDAUD, XAGKRW, EURNPR, BWPCHF, YERUSD, ALLEUR, TRYPLN, MYRCNY, AEDNZD, AWGUSD, JPYCAD, EURRON, EURBOB, USDHNL, GBPCAD, THBSGD, SGDTRY, USDIDR, BBDUSD, EURNAD, EURGTQ, GBPALL, NOKEUR, NZDTWD, BRLZAR, USDBBD, BRLEUR, LKRUSD, EURBTN, JPYRUB, USDQAR, LYDGBP, BBDEUR, GBPUYU, USDTHB, GBPINR, BRLUSD, VNDUSD, UZSUSD, ILSUSD, MXNAUD, GBPTRY, JPYINR, KRUUSD, XAUUSD, EURMXN, USDPHP, GBPJOD, AFNGBP, SGDTWD, EURHKD, AEDZAR, GBPNIO, USDNOK, SGDDKK, ZARTWD, BIFUSD, GYDGBP, PKRZAR, JPYPLN, XAUBRL, USDETB, BMDKYD, ZARTRY, GBPRSD, USDAWG, PENCOP, USDTTD, RSDGBP, GBPMGA, GBPNZD, DKKPKR, ZARNZD, QARZAR, DKKJPY, GBPKRW, TZSUSD, GBPGHS, AUDDKK, NBLCHF, BMDBBD, THBIDR, NZDAED, MYRUSD, EURMOP, TWDSEK, AUDBGN, BHDEUR, GBPBGN, EURBIF, USDCLP, GTQGBP, JPYIDR, XAGAUD, EURCLP, UYUGBP, DKKPHP, USDCNH, USDKZT, EURETB, EURPEN, BGNAUD, INRUSD, IDRCAD, EURMUR, INRCNY, OMRZAR, HKDCAD, GBPHKD, HKDUSD, TJSUSD, DKKHKD, AUDCZK, GBPEGP, EURSLL, GBPCNY, EURGBP, ZARILS, GBPTWD, XAUARS, USDBRL, BWPUSD, BSDUSD, EURGHS, NZDTHB, NZDKRW, JPYEUR, USDOMR, EURBDT, HKDMYR, PYGUSD, GYDUSD, SEKDKK, EURRSD, EURBGN, GBPLKR, DKKUAH, XAGINR, ILSJOD, RUBAUD, LSLGBP, SEKCZK, ARSGBP, GBPIQD, GBPMVR, USDSZL, GBPHNL, ARSUSD, GBPIDR, USDDJF, EURQAR, JPYZAR, KRWIDR, RUBUSD, UAHDKK, JPYNZD, TWDIDR, USDALL, PLNUSD, PHPGBP, USDGBP, SGDHKD, GBPOMR, KRWTHB, ARSEUR, USDJOD, GBPSOS, SZLZAR, USDHTG, NOKPLN, GBPXPF, EURKWD, SZLUSD, MADZAR, SEKAUD, NOKGBP, ILSCHF, GBPSAR, GBPBIF, DKKTRY, EGPUSD, USDYER, MADUSD, TRYZAR, XAUTHB, XAUSAR, AEDJPY, USDISK, USDDKK, AUDTRY, USDBGN, PLNSEK, NZDCNY, THBJPY, JPYBRL, RUBJPY, AEDUSD, USDGHS, TTDUSD, USDKYD, EURRWF, GBPSGD, FJDGBP, HRKEUR, BSDGBP, INRAUD, USDINR, USDCNY, GBPCLP, XAGZAR, KRWBRL, DOPGBP, USDNIO, USDIQD, HKDEUR, AUDINR, BTNGBP, JPYCHF, USDLYD, EURSDG, USDSGD, GBPDKK, JPYRSD, EURBND, HKDNZD, TRYDKK, XAGJPY, GNFGBP, RWFGBP, GBPDZD, EURSGD, HKDSGD, IDRUSD, IDRCNY, SEKCAD, USDMAD, NOKJPY, ARSJPY, SGDAED, NZDCAD, RUBNOK, EURTZS, HKDDKK, XAUTRY, USDLAK, PLNHUF, THBKRW, THBNZD, EURSZL, MYRAUD, EURARS, SGDMYR, TWDCNY, MDLUSD, GBPDJF, HRKCAD, GBPHTG, EURTWD, ILSCAD, NGNGBP, KRWMYR, EURHTG, LBPUSD, BRLJPY, GBPCOP, NOKSEK, NZDDKK, PLNILS, EURMWK, USDUAH, KRWJPY, PHPDKK, USDTJS, EURIQD, HUFEUR, MXNPLN, GBPBRL, USDTZS, PENEUR, EURAMD, ZARMWK, TZSZAR, USDTWD, HKDCNY, LSLUSD, ZARMAD, EURKRW, TWDTHB, BRLCAD, BRLCOP, XAGCNY, JPYCNY, JPYAED, YERGBP, EURLRD, JPYUSD, BRLSEK, USDNPR, NZDNOK, MOPUSD, MYRDKK, GBPBSD, EURISK, USDGYD, AUDLTL, NZDMXN, TWDUSD, MYRTWD, GBPCDF, NZDSEK, IDRGBP, AUDEUR, USDMOP, RUBGBP, VRNCHF, BWPEUR, EURJPY, GBPHUF, KRWCHF, MALUSD, BGNDKK, BRLKRW, AUDRUB, NZDSGD, ZARCHF, HKDIDR, MXNCAD, GBPZAR, XAGSAR, BRLHKD, UYUEUR | +| resolution | [Alphavantage only] Resolution of data. Can be intraday, daily, weekly or monthly | d | True | i, d, w, m | +| interval | Interval of intraday data. Options: [YahooFinance] 1min, 2min, 5min, 15min, 30min, 60min, 90min, 1hour, 1day, 5day, 1week, 1month, 3month. [AlphaVantage] 1min, 5min, 15min, 30min, 60min | 1day | True | 1min, 5min, 15min, 30min, 60min, 90min, 1hour, 1day, 5day, 1week, 1month, 3month | +| start_date | Start date of data. | datetime.now() - timedelta(days=365) | True | None | + +--- diff --git a/website/versioned_docs/version-v3/terminal/reference/forex/oanda/_category_.json b/website/content/terminal/reference/forex/oanda/_category_.json similarity index 100% rename from website/versioned_docs/version-v3/terminal/reference/forex/oanda/_category_.json rename to website/content/terminal/reference/forex/oanda/_category_.json diff --git a/website/content/terminal/reference/forex/oanda/calendar.md b/website/content/terminal/reference/forex/oanda/calendar.md new file mode 100644 index 000000000000..984f1a7651d9 --- /dev/null +++ b/website/content/terminal/reference/forex/oanda/calendar.md @@ -0,0 +1,36 @@ +--- +title: calendar +description: This is a documentation page for the calendar function. It details the + parameters and the usage of this function to manipulate and view calendar data. +keywords: +- Calendar Data +- Usage +- Parameters +- Days +- Search +- Forward +- Backward +- Negative Numbers +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Show Calendar Data + +### Usage + +```python +calendar [-d DAYS] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| days | The number of days to search for, up to 30 forward or backward use negative numbers to search back. | 7 | True | None | + +--- diff --git a/website/content/terminal/reference/forex/oanda/cancel.md b/website/content/terminal/reference/forex/oanda/cancel.md new file mode 100644 index 000000000000..f03f497f84e1 --- /dev/null +++ b/website/content/terminal/reference/forex/oanda/cancel.md @@ -0,0 +1,33 @@ +--- +title: cancel +description: Webpage detailing how to cancel a pending order with usage, parameters + and special considerations. +keywords: +- Cancel Pending Order +- Order Management +- Webpage Documentation +- Cancel Order Operation +- API Usage +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Cancel a Pending Order. + +### Usage + +```python +cancel -i ORDERID +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| orderID | The pending order ID to cancel. | None | False | None | + +--- diff --git a/website/content/terminal/reference/forex/oanda/candles.md b/website/content/terminal/reference/forex/oanda/candles.md new file mode 100644 index 000000000000..2d8ef8a3e034 --- /dev/null +++ b/website/content/terminal/reference/forex/oanda/candles.md @@ -0,0 +1,50 @@ +--- +title: candles +description: This page is a comprehensive guide on how to display candle data for + different technical analysis indicators like Bollinger Bands, Accumulation/Distribution + Indicator, Commodity Channel Index, Exponential Moving Average, On Balance Volume, + Relative Strength Index, Simple Moving Average, and Volume Weighted Average Price. +keywords: +- candle data +- technical analysis +- data visualization +- Bollinger Bands +- Accumulation/Distribution Indicator +- Commodity Channel Index +- Exponential Moving Average +- On Balance Volume +- Relative Strength Index +- Simple Moving Average +- Volume Weighted Average Price +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Display Candle Data + +### Usage + +```python +candles [-g GRANULARITY] [-l CANDLECOUNT] [-a] [-b] [-c] [-e] [-o] [-r] [-s] [-v] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| granularity | The timeframe to get for the candle chart (Seconds: S5, S10, S15, S30 Minutes: M1, M2, M4, M5, M10, M15, M30 Hours: H1, H2, H3, H4, H6, H8, H12 Day (default): D, Week: W Month: M | D | True | None | +| candlecount | The number of candles to retrieve. Default:180 | 180 | True | None | +| ad | Adds ad (Accumulation/Distribution Indicator) to the chart | False | True | None | +| bbands | Adds Bollinger Bands to the chart | False | True | None | +| cci | Adds cci (Commodity Channel Index) to the chart | False | True | None | +| ema | Adds ema (Exponential Moving Average) to the chart | False | True | None | +| obv | Adds obv (On Balance Volume) to the chart | False | True | None | +| rsi | Adds rsi (Relative Strength Index) to the chart | False | True | None | +| sma | Adds sma (Simple Moving Average) to the chart | False | True | None | +| vwap | Adds vwap (Volume Weighted Average Price) to the chart | False | True | None | + +--- diff --git a/website/content/terminal/reference/forex/oanda/closetrade.md b/website/content/terminal/reference/forex/oanda/closetrade.md new file mode 100644 index 000000000000..78889779a606 --- /dev/null +++ b/website/content/terminal/reference/forex/oanda/closetrade.md @@ -0,0 +1,37 @@ +--- +title: closetrade +description: Documentation for the command 'closetrade', which allows for closing + trades by ID. It enables specification of the number of units to close, with relevant + parameters detailed. +keywords: +- closetrade +- trade +- orderID +- units +- close trade +- parameters +- trade ID +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Close a trade by id. + +### Usage + +```python +closetrade [-i ORDERID] [-u UNITS] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| orderID | The Trade ID to close. | None | True | None | +| units | The number of units on the trade to close. If not set it defaults to all units. | None | True | None | + +--- diff --git a/website/content/terminal/reference/forex/oanda/from.md b/website/content/terminal/reference/forex/oanda/from.md new file mode 100644 index 000000000000..cffad20a4fb5 --- /dev/null +++ b/website/content/terminal/reference/forex/oanda/from.md @@ -0,0 +1,36 @@ +--- +title: from +description: This page provides instructions on how to select the 'from' currency + symbol in a forex pair, including usage information and a comprehensive list of + available currencies. +keywords: +- forex +- currency symbol +- forex pair +- from symbol +- trading +- currency exchange +- forex trading +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Select the "from" currency symbol in a forex pair + +### Usage + +```python +from -n FROM_SYMBOL +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| from_symbol | From currency | None | False | AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AUX, AWG, AZN, BAM, BBD, BDT, BGN, BHD, BIF, BMD, BND, BOB, BRL, BSD, BTN, BWP, BYN, BZD, CAD, CDF, CHF, CLF, CLP, CNH, CNY, COP, CRC, CUC, CUP, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ERN, ETB, EUR, EUX, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, IQD, IRR, ISK, JMD, JOD, JPY, KES, KGS, KHR, KMF, KRW, KWD, KYD, KZT, LAK, LBP, LKR, LRD, LSL, LYD, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRU, MUR, MVR, MWK, MXN, MXV, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, OMR, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SDG, SEK, SGD, SHP, SLL, SOS, SRD, SSP, STN, SVC, SYP, SZL, THB, TJS, TMT, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, USY, UYU, UZS, VES, VND, VUV, WST, XAF, XCD, XCU, XDR, XOF, XPF, YER, ZAR, ZMW | + +--- diff --git a/website/content/terminal/reference/forex/oanda/list.md b/website/content/terminal/reference/forex/oanda/list.md new file mode 100644 index 000000000000..be1050bd250c --- /dev/null +++ b/website/content/terminal/reference/forex/oanda/list.md @@ -0,0 +1,35 @@ +--- +title: list +description: This page contains information on how to list the order history using + specific parameters such as order state and limit retrieval. It provides guidance + on the usage and parameters to maximize functionality. +keywords: +- list order history +- Usage +- parameters +- state order +- limit order retrieval +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +List order history + +### Usage + +```python +list [-s STATE] [-l LIMIT] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| state | List orders that have a specific state. | ALL | True | None | +| limit | Limit the number of orders to retrieve. | 20 | True | None | + +--- diff --git a/website/content/terminal/reference/forex/oanda/order.md b/website/content/terminal/reference/forex/oanda/order.md new file mode 100644 index 000000000000..9729d98c4a63 --- /dev/null +++ b/website/content/terminal/reference/forex/oanda/order.md @@ -0,0 +1,37 @@ +--- +title: order +description: How to create an order, set unit and price, and understanding of long + and short position in order request. Also, guides on setting the price for a limit + order. +keywords: +- order +- units +- price +- long position +- short position +- limit order +- order request +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Create order + +### Usage + +```python +order -u UNITS -p PRICE +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| units | The number of units to place in the order request. Positive for a long position and negative for a short position. | None | False | None | +| price | The price to set for the limit order. | None | False | None | + +--- diff --git a/website/content/terminal/reference/forex/oanda/orderbook.md b/website/content/terminal/reference/forex/oanda/orderbook.md new file mode 100644 index 000000000000..b1fa383b6b9c --- /dev/null +++ b/website/content/terminal/reference/forex/oanda/orderbook.md @@ -0,0 +1,34 @@ +--- +title: orderbook +description: This is a marketing website page on how to plot an orderbook for an instrument + using the provided Oanda command. The page contains details on usage of 'orderbook' + command. +keywords: +- Orderbook +- Oanda Command +- Instrument +- Usage +- Parameters +- Marketing website +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Plot an orderbook for an instrument if Oanda provides one. + +### Usage + +```python +orderbook +``` + +--- + +## Parameters + +This command has no parameters + + +--- diff --git a/website/content/terminal/reference/forex/oanda/pending.md b/website/content/terminal/reference/forex/oanda/pending.md new file mode 100644 index 000000000000..32d99ea3cc0c --- /dev/null +++ b/website/content/terminal/reference/forex/oanda/pending.md @@ -0,0 +1,29 @@ +--- +title: pending +description: Learn how to retrieve information about pending orders using the 'pending' + command in Python. Note that this command does not require any parameters. +keywords: +- pending orders +- no parameters +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Get information about pending orders. + +### Usage + +```python +pending +``` + +--- + +## Parameters + +This command has no parameters + + +--- diff --git a/website/content/terminal/reference/forex/oanda/positionbook.md b/website/content/terminal/reference/forex/oanda/positionbook.md new file mode 100644 index 000000000000..13f83ee972d6 --- /dev/null +++ b/website/content/terminal/reference/forex/oanda/positionbook.md @@ -0,0 +1,33 @@ +--- +title: positionbook +description: This page provides information on how to plot a position book for an + instrument using Oanda. It is particularly helpful in implementing commands in python + and understanding its parameters. +keywords: +- Positionbook +- Oanda +- Instrument +- Command +- Parameters +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Plot a position book for an instrument if Oanda provides one. + +### Usage + +```python +positionbook +``` + +--- + +## Parameters + +This command has no parameters + + +--- diff --git a/website/content/terminal/reference/forex/oanda/positions.md b/website/content/terminal/reference/forex/oanda/positions.md new file mode 100644 index 000000000000..6c85ac2b5ceb --- /dev/null +++ b/website/content/terminal/reference/forex/oanda/positions.md @@ -0,0 +1,31 @@ +--- +title: positions +description: This documentation page provides information about the available positions, + along with usage instructions. The 'positions' command has no parameters. +keywords: +- Positions +- Open Positions Information +- Usage +- No Parameters +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Get information about open positions. + +### Usage + +```python +positions +``` + +--- + +## Parameters + +This command has no parameters + + +--- diff --git a/website/content/terminal/reference/forex/oanda/price.md b/website/content/terminal/reference/forex/oanda/price.md new file mode 100644 index 000000000000..88559b714c9d --- /dev/null +++ b/website/content/terminal/reference/forex/oanda/price.md @@ -0,0 +1,31 @@ +--- +title: price +description: Learn how to get the price for a selected instrument using the 'price' + command. Know more about its usage and parameters. +keywords: +- price +- instrument +- parameters +- usage +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Get price for selected instrument. + +### Usage + +```python +price +``` + +--- + +## Parameters + +This command has no parameters + + +--- diff --git a/website/content/terminal/reference/forex/oanda/summary.md b/website/content/terminal/reference/forex/oanda/summary.md new file mode 100644 index 000000000000..57e548475af5 --- /dev/null +++ b/website/content/terminal/reference/forex/oanda/summary.md @@ -0,0 +1,33 @@ +--- +title: summary +description: Documentation for the 'summary' command to print account information, + its usage, and parameters. Ideal for users seeking to understand how to retrieve + account details. +keywords: +- account information +- usage +- parameters +- print account details +- summary command +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Print some information about your account. + +### Usage + +```python +summary +``` + +--- + +## Parameters + +This command has no parameters + + +--- diff --git a/website/content/terminal/reference/forex/oanda/to.md b/website/content/terminal/reference/forex/oanda/to.md new file mode 100644 index 000000000000..231fb4f33ab3 --- /dev/null +++ b/website/content/terminal/reference/forex/oanda/to.md @@ -0,0 +1,37 @@ +--- +title: to +description: The page provides details on how to select the 'to' currency symbol in + a forex pair. It covers usage, parameters including a comprehensive list of currency + codes. +keywords: +- Forex +- Currency Exchange +- To Currency Symbol +- Forex Pair +- Currency Codes +- Finance +- Trading +- Foreign Exchange +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Select the "to" currency symbol in a forex pair + +### Usage + +```python +to -n TO_SYMBOL +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| to_symbol | To currency | None | False | AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AUX, AWG, AZN, BAM, BBD, BDT, BGN, BHD, BIF, BMD, BND, BOB, BRL, BSD, BTN, BWP, BYN, BZD, CAD, CDF, CHF, CLF, CLP, CNH, CNY, COP, CRC, CUC, CUP, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ERN, ETB, EUR, EUX, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, INR, IQD, IRR, ISK, JMD, JOD, JPY, KES, KGS, KHR, KMF, KRW, KWD, KYD, KZT, LAK, LBP, LKR, LRD, LSL, LYD, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRU, MUR, MVR, MWK, MXN, MXV, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, OMR, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SDG, SEK, SGD, SHP, SLL, SOS, SRD, SSP, STN, SVC, SYP, SZL, THB, TJS, TMT, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, USY, UYU, UZS, VES, VND, VUV, WST, XAF, XCD, XCU, XDR, XOF, XPF, YER, ZAR, ZMW | + +--- diff --git a/website/content/terminal/reference/forex/oanda/trades.md b/website/content/terminal/reference/forex/oanda/trades.md new file mode 100644 index 000000000000..52b500be5c49 --- /dev/null +++ b/website/content/terminal/reference/forex/oanda/trades.md @@ -0,0 +1,33 @@ +--- +title: trades +description: This page provides information on how to retrieve open trades using a + simple command, along with usage details and explains that the command has no parameters. +keywords: +- trades +- open trades +- no parameters +- usage details +- python command +- trading commands +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Get information about open trades. + +### Usage + +```python +trades +``` + +--- + +## Parameters + +This command has no parameters + + +--- diff --git a/website/versioned_docs/version-v3/terminal/reference/forex/qa/_category_.json b/website/content/terminal/reference/forex/qa/_category_.json similarity index 100% rename from website/versioned_docs/version-v3/terminal/reference/forex/qa/_category_.json rename to website/content/terminal/reference/forex/qa/_category_.json diff --git a/website/content/terminal/reference/forex/qa/acf.md b/website/content/terminal/reference/forex/qa/acf.md new file mode 100644 index 000000000000..a5bedffcd5c3 --- /dev/null +++ b/website/content/terminal/reference/forex/qa/acf.md @@ -0,0 +1,37 @@ +--- +title: acf +description: This page provides information about Auto-Correlation and Partial Auto-Correlation + Functions for diff and diff diff forex data, including its usage and parameters. +keywords: +- Auto-Correlation Function +- Partial Auto-Correlation Function +- Forex data +- Data analysis +- Python acf +- Forex data analysis +- Data visualization +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Auto-Correlation and Partial Auto-Correlation Functions for diff and diff diff forex data + +### Usage + +```python +acf [-l LAGS] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| lags | maximum lags to display in plots | 15 | True | range(5, 100) | + +![acf](https://user-images.githubusercontent.com/46355364/154305242-176c3ba1-ebfc-43e7-a027-46251fb02463.png) + +--- diff --git a/website/content/terminal/reference/forex/qa/bw.md b/website/content/terminal/reference/forex/qa/bw.md new file mode 100644 index 000000000000..4b5faeef2b60 --- /dev/null +++ b/website/content/terminal/reference/forex/qa/bw.md @@ -0,0 +1,36 @@ +--- +title: bw +description: The page provides comprehensive information about the usage of Box and + Whisker plot, also known as 'bw'. It covers how to generate bw plots, including + a yearly bw plot, using Python. It includes a parameter table and several supporting + visuals to guide users. +keywords: +- Box and Whisker plot +- bw +- data visualization +- yearly bw plot +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Box and Whisker plot + +### Usage + +```python +bw [-y] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| year | Flag to show yearly bw plot | False | True | None | + +![bw](https://user-images.githubusercontent.com/46355364/154305545-0f99fe4b-07e1-4714-8762-da3569023578.png) + +--- diff --git a/website/content/terminal/reference/forex/qa/cdf.md b/website/content/terminal/reference/forex/qa/cdf.md new file mode 100644 index 000000000000..ad05a3c26eb9 --- /dev/null +++ b/website/content/terminal/reference/forex/qa/cdf.md @@ -0,0 +1,50 @@ +--- +title: cdf +description: This page provides exhaustive details about the 'cdf' (Cumulative Distribution + Function) command in Python including its usage, parameters, example arguments, + and the export options. An illustrative grok of the cdf function is also included. +keywords: +- cdf +- cumulative distribution function +- parameters +- arguments +- export +- csv +- json +- xlsx +- dataframe +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Cumulative distribution function + +### Usage + +```python +cdf +``` + +--- + +## Parameters + +This command has no parameters + + + +--- + +## Examples + +```python +optional arguments: + --export {csv,json,xlsx} + Export dataframe data to csv,json,xlsx file (default: ) + -h, --help show this help message (default: False) +``` +![cdf](https://user-images.githubusercontent.com/46355364/154306055-cb3bb1ef-0e61-40c9-bf51-d095bed8dc1b.png) + +--- diff --git a/website/content/terminal/reference/forex/qa/cusum.md b/website/content/terminal/reference/forex/qa/cusum.md new file mode 100644 index 000000000000..c25480b54a44 --- /dev/null +++ b/website/content/terminal/reference/forex/qa/cusum.md @@ -0,0 +1,38 @@ +--- +title: cusum +description: The page provides detailed information on using cusum (Cumulative sum + algorithm) tool. It covers areas such as algorithm usage with Python, parameters + like threshold and drift, and graphical data representation. +keywords: +- cusum +- cumulative sum algorithm +- data change detection +- algorithm usage +- threshold +- drift +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Cumulative sum algorithm (CUSUM) to detect abrupt changes in data + +### Usage + +```python +cusum [-t THRESHOLD] [-d DRIFT] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| threshold | threshold | 0.0 | True | None | +| drift | drift | 0.0 | True | None | + +![cusum](https://user-images.githubusercontent.com/46355364/154306207-d68f53f4-2f9a-4c1a-8e0e-b83d49938759.png) + +--- diff --git a/website/content/terminal/reference/forex/qa/decompose.md b/website/content/terminal/reference/forex/qa/decompose.md new file mode 100644 index 000000000000..5a09004ac4cf --- /dev/null +++ b/website/content/terminal/reference/forex/qa/decompose.md @@ -0,0 +1,51 @@ +--- +title: decompose +description: Learn how to decompose time series using the additive or multiplicative + model. Understand the usage, parameters, and get examples to simplify your analysis. +keywords: +- time series decomposition +- additive time series +- multiplicative time series +- cyclic trend +- residual +- seasonality +- decompose function +- data analysis +- stock analysis +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Decompose time series as: - Additive Time Series = Level + CyclicTrend + Residual + Seasonality - Multiplicative Time Series = Level * CyclicTrend * Residual * Seasonality + +### Usage + +```python +decompose [-m] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| multiplicative | decompose using multiplicative model instead of additive | False | True | None | + + +--- + +## Examples + +```python +2022 Feb 16, 11:06 (🦋) /stocks/qa/ $ decompose + +Time-Series Level is 2660.84 +Strength of Trend: 0.0000 +Strength of Seasonality: 0.0032 +``` +![decompose](https://user-images.githubusercontent.com/46355364/154306626-1c5ad11e-a2e9-4107-9aec-5cf18da5358e.png) + +--- diff --git a/website/content/terminal/reference/forex/qa/hist.md b/website/content/terminal/reference/forex/qa/hist.md new file mode 100644 index 000000000000..a27d0cc21300 --- /dev/null +++ b/website/content/terminal/reference/forex/qa/hist.md @@ -0,0 +1,37 @@ +--- +title: hist +description: This page is about the hist command, a tool that creates histograms with + density and rug. Here you will find usage, parameter information, and details on + how to use the n_bins parameter effectively. +keywords: +- hist +- histogram +- density +- rug +- bins +- parameters +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Histogram with density and rug + +### Usage + +```python +hist [-b BINS] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| n_bins | | 15 | True | range(10, 100) | + +![hist](https://user-images.githubusercontent.com/46355364/154306947-aaba936a-ac07-40e2-a5a6-bf1fab460cd0.png) + +--- diff --git a/website/content/terminal/reference/forex/qa/kurtosis.md b/website/content/terminal/reference/forex/qa/kurtosis.md new file mode 100644 index 000000000000..1ebf9891a108 --- /dev/null +++ b/website/content/terminal/reference/forex/qa/kurtosis.md @@ -0,0 +1,41 @@ +--- +title: kurtosis +description: This page discusses the concept of kurtosis. It provides detailed insights + on its functioning, importance, and usage with the help of Python code. +keywords: +- kurtosis +- probability distribution +- tailedness +- real-valued random variable +- shape +- theoretical distribution +- population sample +- Python code +- parameters +- n_window +- window length +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Kurtosis is a measure of the "tailedness" of the probability distribution of a real-valued random variable. Like skewness, kurtosis describes the shape of a probability distribution and there are different ways of quantifying it for a theoretical distribution and corresponding ways of estimating it from a sample from a population. Different measures of kurtosis may have different interpretations. + +### Usage + +```python +kurtosis [-w N_WINDOW] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| n_window | window length | 14 | True | range(5, 100) | + +![kurtosis](https://user-images.githubusercontent.com/46355364/154307174-68671146-9551-4c2f-a179-db1d4b20b992.png) + +--- diff --git a/website/content/terminal/reference/forex/qa/line.md b/website/content/terminal/reference/forex/qa/line.md new file mode 100644 index 000000000000..556ac9cedd1e --- /dev/null +++ b/website/content/terminal/reference/forex/qa/line.md @@ -0,0 +1,39 @@ +--- +title: line +description: The 'line' documentation page provides information on how to create a + line plot of selected data or highlight specific datetimes. It also details the + usage, parameters, and provides a visual representation. +keywords: +- line plot +- highlight specific datetimes +- log scale plotting +- vertical line markers +- scatter markers +- data visualization +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Show line plot of selected data or highlight specific datetimes. + +### Usage + +```python +line [--log] [--ml ML] [--ms MS] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| log | Plot with y on log scale | False | True | None | +| ml | Draw vertical line markers to highlight certain events | | True | None | +| ms | Draw scatter markers to highlight certain events | | True | None | + +![line](https://user-images.githubusercontent.com/46355364/154307397-9c2e9325-bce6-494d-994f-a6d7db798798.png) + +--- diff --git a/website/content/terminal/reference/forex/qa/load.md b/website/content/terminal/reference/forex/qa/load.md new file mode 100644 index 000000000000..77374b744f64 --- /dev/null +++ b/website/content/terminal/reference/forex/qa/load.md @@ -0,0 +1,48 @@ +--- +title: load +description: A detailed guide on how to load any cryptocurrency to perform various + analyses. This page includes the method to select an exchange and designate a particular + interval along with explaining several parameters including start and end dates. +keywords: +- load +- crypto currency +- analysis +- Yahoo Finance +- ccxt +- cg +- source +- exchange +- interval +- parameters +- coin +- start +- end +- vs +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Load crypto currency to perform analysis on. Yahoo Finance is used as default source. Other sources can be used such as 'ccxt' or 'cg' with --source. If you select 'ccxt', you can then select any exchange with --exchange. You can also select a specific interval with --interval. + +### Usage + +```python +load -c COIN [-s START] [--exchange {aax,ascendex,bequant,bibox,bigone,binance,binancecoinm,binanceus,binanceusdm,bit2c,bitbank,bitbay,bitcoincom,bitfinex,bitfinex2,bitflyer,bitforex,bitget,bithumb,bitmart,bitmex,bitopro,bitpanda,bitrue,bitso,bitstamp,bitstamp1,bittrex,bitvavo,bkex,bl3p,btcalpha,btcbox,btcex,btcmarkets,btctradeua,btcturk,buda,bw,bybit,bytetrade,cex,coinbaseprime,coinbasepro,coincheck,coinex,coinfalcon,coinmate,coinone,coinspot,crex24,cryptocom,currencycom,delta,deribit,digifinex,eqonex,exmo,flowbtc,fmfwio,ftx,ftxus,gate,gateio,gemini,hitbtc,hitbtc3,hollaex,huobi,huobijp,huobipro,idex,independentreserve,indodax,itbit,kraken,kucoin,kucoinfutures,kuna,latoken,lbank,lbank2,liquid,luno,lykke,mercado,mexc,mexc3,ndax,novadax,oceanex,okcoin,okex,okex5,okx,paymium,phemex,poloniex,probit,qtrade,ripio,stex,therock,tidebit,tidex,timex,tokocrypto,upbit,wavesexchange,whitebit,woo,yobit,zaif,zb,zipmex,zonda}] [-e END] [-i {1,5,15,30,60,240,1440,10080,43200}] [--vs VS] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| coin | Coin to get. Must be coin symbol (e.g., btc, eth) | None | False | None | +| start | The starting date (format YYYY-MM-DD) of the crypto | 2019-11-21 | True | None | +| exchange | Exchange to search | binance | True | aax, ascendex, bequant, bibox, bigone, binance, binancecoinm, binanceus, binanceusdm, bit2c, bitbank, bitbay, bitcoincom, bitfinex, bitfinex2, bitflyer, bitforex, bitget, bithumb, bitmart, bitmex, bitopro, bitpanda, bitrue, bitso, bitstamp, bitstamp1, bittrex, bitvavo, bkex, bl3p, btcalpha, btcbox, btcex, btcmarkets, btctradeua, btcturk, buda, bw, bybit, bytetrade, cex, coinbaseprime, coinbasepro, coincheck, coinex, coinfalcon, coinmate, coinone, coinspot, crex24, cryptocom, currencycom, delta, deribit, digifinex, eqonex, exmo, flowbtc, fmfwio, ftx, ftxus, gate, gateio, gemini, hitbtc, hitbtc3, hollaex, huobi, huobijp, huobipro, idex, independentreserve, indodax, itbit, kraken, kucoin, kucoinfutures, kuna, latoken, lbank, lbank2, liquid, luno, lykke, mercado, mexc, mexc3, ndax, novadax, oceanex, okcoin, okex, okex5, okx, paymium, phemex, poloniex, probit, qtrade, ripio, stex, therock, tidebit, tidex, timex, tokocrypto, upbit, wavesexchange, whitebit, woo, yobit, zaif, zb, zipmex, zonda | +| end | The ending date (format YYYY-MM-DD) of the crypto | 2022-11-25 | True | None | +| interval | The interval of the crypto | 1440 | True | 1, 5, 15, 30, 60, 240, 1440, 10080, 43200 | +| vs | Quote currency (what to view coin vs). e.g., usdc, usdt, ... if source is ccxt, usd, eur, ... otherwise | usdt | True | None | + +--- diff --git a/website/content/terminal/reference/forex/qa/normality.md b/website/content/terminal/reference/forex/qa/normality.md new file mode 100644 index 000000000000..1eb11dc6ae52 --- /dev/null +++ b/website/content/terminal/reference/forex/qa/normality.md @@ -0,0 +1,58 @@ +--- +title: normality +description: The page provides usage details for the command 'normality' which executes + normality tests in python, includes parameters and examples showcasing normality + statistics like Kurtosis, Skewness, Jarque-Bera, Shapiro-Wilk, and Kolmogorov-Smirnov. +keywords: +- normality tests +- kurtosis +- skewness +- Jarque-Bera +- Shapiro-Wilk +- Kolmogorov-Smirnov +- statistics +- p-value +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Normality tests + +### Usage + +```python +normality +``` + +--- + +## Parameters + +This command has no parameters + + + +--- + +## Examples + +```python +2022 Feb 16, 11:11 (🦋) /stocks/qa/ $ normality + Normality Statistics +┏━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━┳━━━━━━━━━┓ +┃ ┃ Statistic ┃ p-value ┃ +┡━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━╇━━━━━━━━━┩ +│ Kurtosis │ 10.2422 │ 0.0000 │ +├────────────────────┼───────────┼─────────┤ +│ Skewness │ -0.2238 │ 0.8229 │ +├────────────────────┼───────────┼─────────┤ +│ Jarque-Bera │ 1155.1958 │ 0.0000 │ +├────────────────────┼───────────┼─────────┤ +│ Shapiro-Wilk │ 0.9265 │ 0.0000 │ +├────────────────────┼───────────┼─────────┤ +│ Kolmogorov-Smirnov │ 0.4680 │ 0.0000 │ +└────────────────────┴───────────┴─────────┘ +``` +--- diff --git a/website/content/terminal/reference/forex/qa/pick.md b/website/content/terminal/reference/forex/qa/pick.md new file mode 100644 index 000000000000..7b639d57ff81 --- /dev/null +++ b/website/content/terminal/reference/forex/qa/pick.md @@ -0,0 +1,52 @@ +--- +title: pick +description: This page provides detailed information on how to use the 'pick' function + for changing the target variable for analysis. It includes usage instructions, the + various parameters used, and specific examples dealing primarily with stock analysis. +keywords: +- target variable change +- usage of pick +- parameters of pick +- examples of pick +- stock analysis +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Change target variable + +### Usage + +```python +pick [-t {Open,High,Low,Close,Adj Close,Volume,date_id,OC_High,OC_Low,Returns,LogRet}] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| target | Select variable to analyze | None | True | Open, High, Low, Close, Adj Close, Volume, date_id, OC_High, OC_Low, Returns, LogRet | + + +--- + +## Examples + +```python +2022 Feb 16, 11:12 (🦋) /stocks/qa/ $ load tsla + +Loading Daily TSLA stock with starting period 2019-02-11 for analysis. + +Datetime: 2022 Feb 16 11:12 +Timezone: America/New_York +Currency: USD +Market: CLOSED + + +2022 Feb 16, 11:12 (🦋) /stocks/qa/ $ pick adjclose +``` +--- diff --git a/website/content/terminal/reference/forex/qa/qqplot.md b/website/content/terminal/reference/forex/qa/qqplot.md new file mode 100644 index 000000000000..acf62e8b4465 --- /dev/null +++ b/website/content/terminal/reference/forex/qa/qqplot.md @@ -0,0 +1,33 @@ +--- +title: qqplot +description: The page provides detailed information on the usage of qqplot, which + displays a QQ plot vs normal quantiles in Python with no parameters required. +keywords: +- qqplot +- display +- normal quantiles +- parameters +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Display QQ plot vs normal quantiles + +### Usage + +```python +qqplot +``` + +--- + +## Parameters + +This command has no parameters + + +![qqplot](https://user-images.githubusercontent.com/46355364/154307858-acd1a7d0-bb40-4639-a69c-c316749a90ab.png) + +--- diff --git a/website/content/terminal/reference/forex/qa/quantile.md b/website/content/terminal/reference/forex/qa/quantile.md new file mode 100644 index 000000000000..d7b5d676918a --- /dev/null +++ b/website/content/terminal/reference/forex/qa/quantile.md @@ -0,0 +1,41 @@ +--- +title: quantile +description: The page explores the concept of 'quantile' in statistical analysis, + focusing especially on its calculations, usage, parameters, and relation to 'median' + and distribution. A valuable resource for those interested in understanding and + applying observational data for better decision making. +keywords: +- quantile +- distribution +- median +- observations +- window length +- descriptive statistics +- quantile calculation +- data analysis +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +The quantiles are values which divide the distribution such that there is a given proportion of observations below the quantile. For example, the median is a quantile. The median is the central value of the distribution, such that half the points are less than or equal to it and half are greater than or equal to it. By default, q is set at 0.5, which effectively is median. Change q to get the desired quantile (0q1). + +### Usage + +```python +quantile [-w N_WINDOW] [-q N_QUANTILE] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| n_window | window length | 14 | True | range(5, 100) | +| f_quantile | quantile | 0.5 | True | 0.0, 0.01, 0.02, 0.03, 0.04, 0.05, 0.06, 0.07, 0.08, 0.09, 0.1, 0.11, 0.12, 0.13, 0.14, 0.15, 0.16, 0.17, 0.18, 0.19, 0.2, 0.21, 0.22, 0.23, 0.24, 0.25, 0.26, 0.27, 0.28, 0.29, 0.3, 0.31, 0.32, 0.33, 0.34, 0.35000000000000003, 0.36, 0.37, 0.38, 0.39, 0.4, 0.41000000000000003, 0.42, 0.43, 0.44, 0.45, 0.46, 0.47000000000000003, 0.48, 0.49, 0.5, 0.51, 0.52, 0.53, 0.54, 0.55, 0.56, 0.5700000000000001, 0.58, 0.59, 0.6, 0.61, 0.62, 0.63, 0.64, 0.65, 0.66, 0.67, 0.68, 0.6900000000000001, 0.7000000000000001, 0.71, 0.72, 0.73, 0.74, 0.75, 0.76, 0.77, 0.78, 0.79, 0.8, 0.81, 0.8200000000000001, 0.8300000000000001, 0.84, 0.85, 0.86, 0.87, 0.88, 0.89, 0.9, 0.91, 0.92, 0.93, 0.9400000000000001, 0.9500000000000001, 0.96, 0.97, 0.98, 0.99 | + +![quantile](https://user-images.githubusercontent.com/46355364/154307976-868e98e1-5a30-43c7-92fc-f221d09c5bd2.png) + +--- diff --git a/website/content/terminal/reference/forex/qa/raw.md b/website/content/terminal/reference/forex/qa/raw.md new file mode 100644 index 000000000000..eaa1930f1bd2 --- /dev/null +++ b/website/content/terminal/reference/forex/qa/raw.md @@ -0,0 +1,90 @@ +--- +title: raw +description: Documentation page for raw function, which is used to output raw data + to the console. Explains its usage, parameters, along with examples. +keywords: +- Documentation +- raw function +- Console Output +- Data Sorting +- Programming Parameter Explanation +- Python Sorting +- Command examples +- Data Representation +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Print raw data to console + +### Usage + +```python +raw [-l LIMIT] [-r] [-s {open,high,low,close,adjclose,volume,date_id,oc_high,oc_low,returns,logret}] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| limit | Number to show | 20 | True | None | +| reverse | Data is sorted in descending order by default. Reverse flag will sort it in an ascending way. Only works when raw data is displayed. | False | True | None | +| sortby | The column to sort by | None | True | open, high, low, close, adjclose, volume, date_id, oc_high, oc_low, returns, logret | + + +--- + +## Examples + +```python +2022 Feb 16, 11:05 (🦋) /stocks/qa/ $ raw + Raw Data +┏━━━━━━━━━━━━┳━━━━━━━━━━┓ +┃ ┃ Adjclose ┃ +┡━━━━━━━━━━━━╇━━━━━━━━━━┩ +│ 2022-01-19 │ 995.650 │ +├────────────┼──────────┤ +│ 2022-01-20 │ 996.270 │ +├────────────┼──────────┤ +│ 2022-01-21 │ 943.900 │ +├────────────┼──────────┤ +│ 2022-01-24 │ 930.000 │ +├────────────┼──────────┤ +│ 2022-01-25 │ 918.400 │ +├────────────┼──────────┤ +│ 2022-01-26 │ 937.410 │ +├────────────┼──────────┤ +│ 2022-01-27 │ 829.100 │ +├────────────┼──────────┤ +│ 2022-01-28 │ 846.350 │ +├────────────┼──────────┤ +│ 2022-01-31 │ 936.720 │ +├────────────┼──────────┤ +│ 2022-02-01 │ 931.250 │ +├────────────┼──────────┤ +│ 2022-02-02 │ 905.660 │ +├────────────┼──────────┤ +│ 2022-02-03 │ 891.140 │ +├────────────┼──────────┤ +│ 2022-02-04 │ 923.320 │ +├────────────┼──────────┤ +│ 2022-02-07 │ 907.340 │ +├────────────┼──────────┤ +│ 2022-02-08 │ 922.000 │ +├────────────┼──────────┤ +│ 2022-02-09 │ 932.000 │ +├────────────┼──────────┤ +│ 2022-02-10 │ 904.550 │ +├────────────┼──────────┤ +│ 2022-02-11 │ 860.000 │ +├────────────┼──────────┤ +│ 2022-02-14 │ 875.760 │ +├────────────┼──────────┤ +│ 2022-02-15 │ 922.430 │ +└────────────┴──────────┘ +``` +--- diff --git a/website/content/terminal/reference/forex/qa/rolling.md b/website/content/terminal/reference/forex/qa/rolling.md new file mode 100644 index 000000000000..677d9e2e178e --- /dev/null +++ b/website/content/terminal/reference/forex/qa/rolling.md @@ -0,0 +1,40 @@ +--- +title: rolling +description: This page contains information about the 'Rolling Mean' and 'Standard + Deviation' in Python data analysis. It covers usage, parameters, and provides visual + representations. +keywords: +- rolling +- mean +- std deviation +- usage +- parameters +- n_window +- window length +- data analysis +- statistics +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Rolling mean and std deviation + +### Usage + +```python +rolling [-w N_WINDOW] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| n_window | Window length | 14 | True | range(5, 100) | + +![rolling](https://user-images.githubusercontent.com/46355364/154308175-bb244d55-a6e0-4d6e-80f4-b3937dcd8ed4.png) + +--- diff --git a/website/content/terminal/reference/forex/qa/skew.md b/website/content/terminal/reference/forex/qa/skew.md new file mode 100644 index 000000000000..bb293f58e92f --- /dev/null +++ b/website/content/terminal/reference/forex/qa/skew.md @@ -0,0 +1,38 @@ +--- +title: skew +description: Learn about the concept of skewness as a measure of asymmetry, its relevance + in symmetric distribution and normal distribution, and the 'skew' command along + with its parameters and usage. +keywords: +- skewness +- symmetric distribution +- asymmetry +- normal distribution +- distortion +- skew command +- command parameters +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Skewness is a measure of asymmetry or distortion of symmetric distribution. It measures the deviation of the given distribution of a random variable from a symmetric distribution, such as normal distribution. A normal distribution is without any skewness, as it is symmetrical on both sides. Hence, a curve is regarded as skewed if it is shifted towards the right or the left. + +### Usage + +```python +skew [-w N_WINDOW] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| n_window | window length | 14 | True | range(5, 100) | + +![skew](https://user-images.githubusercontent.com/46355364/154308298-7528be2a-05f5-44b8-a479-d4716b2a6c6e.png) + +--- diff --git a/website/content/terminal/reference/forex/qa/spread.md b/website/content/terminal/reference/forex/qa/spread.md new file mode 100644 index 000000000000..38e0b6573953 --- /dev/null +++ b/website/content/terminal/reference/forex/qa/spread.md @@ -0,0 +1,36 @@ +--- +title: spread +description: A documentation page detailing how to use the spread measurement tool. + The page includes parameters, usage, and visuals to guide the user. +keywords: +- spread measurement +- rolling spread +- usage +- parameters +- n_window +- window length +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Shows rolling spread measurement + +### Usage + +```python +spread [-w N_WINDOW] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| n_window | Window length | 14 | True | range(5, 100) | + +![spread](https://user-images.githubusercontent.com/46355364/154308406-f20812a4-fa04-4937-b8de-dc27042f7462.png) + +--- diff --git a/website/content/terminal/reference/forex/qa/summary.md b/website/content/terminal/reference/forex/qa/summary.md new file mode 100644 index 000000000000..ec0e78ae7f4f --- /dev/null +++ b/website/content/terminal/reference/forex/qa/summary.md @@ -0,0 +1,70 @@ +--- +title: summary +description: This page provides a detailed guide on how to use the 'summary' function. + This powerful command provides key summary statistics without requiring any additional + parameters. Users can leverage such data insights for data analysis and stock market + research. +keywords: +- data analysis +- summary function +- statistical data +- stock market research +- data insight +- parameter-less commands +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Summary statistics + +### Usage + +```python +summary +``` + +--- + +## Parameters + +This command has no parameters + + + +--- + +## Examples + +```python +2022 Feb 16, 11:16 (🦋) /stocks/qa/ $ summary + + Summary Statistics +┏━━━━━━━┳━━━━━━━━━━┳━━━━━━━━━━┳━━━━━━━━━━┳━━━━━━━━━━┳━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━┳━━━━━━━━━┳━━━━━━━━━━┓ +┃ ┃ open ┃ high ┃ low ┃ close ┃ adjclose ┃ volume ┃ returns ┃ logret ┃ logprice ┃ +┡━━━━━━━╇━━━━━━━━━━╇━━━━━━━━━━╇━━━━━━━━━━╇━━━━━━━━━━╇━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━╇━━━━━━━━━╇━━━━━━━━━━┩ +│ count │ 760.000 │ 760.000 │ 760.000 │ 760.000 │ 760.000 │ 760.000 │ 760.000 │ 760.000 │ 760.000 │ +├───────┼──────────┼──────────┼──────────┼──────────┼──────────┼─────────────────────┼─────────┼─────────┼──────────┤ +│ mean │ 203.131 │ 205.470 │ 200.350 │ 202.963 │ 202.963 │ 18581311.316 │ -0.000 │ -0.000 │ 5.288 │ +├───────┼──────────┼──────────┼──────────┼──────────┼──────────┼─────────────────────┼─────────┼─────────┼──────────┤ +│ std │ 44.546 │ 44.825 │ 44.020 │ 44.497 │ 44.497 │ 10992756.504 │ 0.025 │ 0.025 │ 0.224 │ +├───────┼──────────┼──────────┼──────────┼──────────┼──────────┼─────────────────────┼─────────┼─────────┼──────────┤ +│ min │ 112.630 │ 114.200 │ 108.700 │ 111.790 │ 111.790 │ 5523000.000 │ -0.133 │ -0.143 │ 4.717 │ +├───────┼──────────┼──────────┼──────────┼──────────┼──────────┼─────────────────────┼─────────┼─────────┼──────────┤ +│ 10% │ 152.144 │ 153.973 │ 150.186 │ 151.635 │ 151.635 │ 9561170.000 │ -0.030 │ -0.030 │ 5.021 │ +├───────┼──────────┼──────────┼──────────┼──────────┼──────────┼─────────────────────┼─────────┼─────────┼──────────┤ +│ 25% │ 171.659 │ 174.392 │ 169.912 │ 171.858 │ 171.858 │ 12144500.000 │ -0.012 │ -0.013 │ 5.147 │ +├───────┼──────────┼──────────┼──────────┼──────────┼──────────┼─────────────────────┼─────────┼─────────┼──────────┤ +│ 50% │ 199.905 │ 202.325 │ 197.335 │ 200.000 │ 200.000 │ 15985100.000 │ 0.000 │ 0.000 │ 5.298 │ +├───────┼──────────┼──────────┼──────────┼──────────┼──────────┼─────────────────────┼─────────┼─────────┼──────────┤ +│ 75% │ 229.373 │ 231.640 │ 226.552 │ 229.478 │ 229.478 │ 21443775.000 │ 0.014 │ 0.014 │ 5.436 │ +├───────┼──────────┼──────────┼──────────┼──────────┼──────────┼─────────────────────┼─────────┼─────────┼──────────┤ +│ 90% │ 265.203 │ 268.028 │ 262.522 │ 265.506 │ 265.506 │ 28987730.000 │ 0.029 │ 0.029 │ 5.582 │ +├───────┼──────────┼──────────┼──────────┼──────────┼──────────┼─────────────────────┼─────────┼─────────┼──────────┤ +│ max │ 313.500 │ 319.320 │ 308.910 │ 317.140 │ 317.140 │ 141830000.000 │ 0.104 │ 0.099 │ 5.759 │ +├───────┼──────────┼──────────┼──────────┼──────────┼──────────┼─────────────────────┼─────────┼─────────┼──────────┤ +│ var │ 1984.325 │ 2009.289 │ 1937.717 │ 1979.969 │ 1979.969 │ 120840695549911.328 │ 0.001 │ 0.001 │ 0.050 │ +└───────┴──────────┴──────────┴──────────┴──────────┴──────────┴─────────────────────┴─────────┴─────────┴──────────┘ +``` +--- diff --git a/website/content/terminal/reference/forex/qa/unitroot.md b/website/content/terminal/reference/forex/qa/unitroot.md new file mode 100644 index 000000000000..a1ac467ec635 --- /dev/null +++ b/website/content/terminal/reference/forex/qa/unitroot.md @@ -0,0 +1,57 @@ +--- +title: unitroot +description: This page offers a detailed guide on the use of the unit root function + in testing stationarity, parameters included, and usage examples. +keywords: +- unit root +- stationarity +- ADF +- KPSS +- regression type +- code examples +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Unit root test / stationarity (ADF, KPSS) + +### Usage + +```python +unitroot [-r {c,ct,ctt,nc}] [-k {c,ct}] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| fuller_reg | Type of regression. Can be ‘c’,’ct’,’ctt’,’nc’ 'c' - Constant and t - trend order | c | True | c, ct, ctt, nc | +| kpss_reg | Type of regression. Can be ‘c’,’ct' | c | True | c, ct | + + +--- + +## Examples + +```python +2022 Feb 16, 11:16 (🦋) /stocks/qa/ $ unitroot + Unit Root Calculation +┏━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━┳━━━━━━━━┓ +┃ ┃ ADF ┃ KPSS ┃ +┡━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━╇━━━━━━━━┩ +│ Test Statistic │ -28.9536 │ 0.2928 │ +├────────────────┼────────────┼────────┤ +│ P-Value │ 0.0000 │ 0.1000 │ +├────────────────┼────────────┼────────┤ +│ NLags │ 0.0000 │ 3 │ +├────────────────┼────────────┼────────┤ +│ Nobs │ 759.0000 │ │ +├────────────────┼────────────┼────────┤ +│ ICBest │ -3339.2013 │ │ +└────────────────┴────────────┴────────┘ +``` +--- diff --git a/website/content/terminal/reference/forex/quote.md b/website/content/terminal/reference/forex/quote.md new file mode 100644 index 000000000000..fd71862cb7f9 --- /dev/null +++ b/website/content/terminal/reference/forex/quote.md @@ -0,0 +1,33 @@ +--- +title: quote +description: This documentation page provides information regarding the usage and + parameters of the 'quote' function in python which fetches the current exchange + rate. +keywords: +- Documentation +- Exchange Rate +- Quote Function +- Current Rate +- Usage and Parameters +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Get current exchange rate quote + +### Usage + +```python +quote +``` + +--- + +## Parameters + +This command has no parameters + + +--- diff --git a/website/versioned_docs/version-v3/terminal/reference/forex/ta/_category_.json b/website/content/terminal/reference/forex/ta/_category_.json similarity index 100% rename from website/versioned_docs/version-v3/terminal/reference/forex/ta/_category_.json rename to website/content/terminal/reference/forex/ta/_category_.json diff --git a/website/content/terminal/reference/forex/ta/ad.md b/website/content/terminal/reference/forex/ta/ad.md new file mode 100644 index 000000000000..f95e19e3aed2 --- /dev/null +++ b/website/content/terminal/reference/forex/ta/ad.md @@ -0,0 +1,36 @@ +--- +title: ad +description: The page delves into the Accumulation/Distribution Line, a valuable tool + in trading analysis, explaining its comparison to other indicators and its usage + in predicting price movements. +keywords: +- Accumulation/Distribution Line +- On Balance Volume +- trading analysis +- price prediction +- close location value +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +The Accumulation/Distribution Line is similar to the On Balance Volume (OBV), which sums the volume times +1/-1 based on whether the close is higher than the previous close. The Accumulation/Distribution indicator, however multiplies the volume by the close location value (CLV). The CLV is based on the movement of the issue within a single bar and can be +1, -1 or zero. The Accumulation/Distribution Line is interpreted by looking for a divergence in the direction of the indicator relative to price. If the Accumulation/Distribution Line is trending upward it indicates that the price may follow. Also, if the Accumulation/Distribution Line becomes flat while the price is still rising (or falling) then it signals an impending flattening of the price. + +### Usage + +```python +ad [--open] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| b_use_open | uses open value of data | False | True | None | + +![ad](https://user-images.githubusercontent.com/46355364/154309283-9512c6c0-dda3-4348-9350-105238676479.png) + +--- diff --git a/website/content/terminal/reference/forex/ta/adx.md b/website/content/terminal/reference/forex/ta/adx.md new file mode 100644 index 000000000000..928e947bfd0f --- /dev/null +++ b/website/content/terminal/reference/forex/ta/adx.md @@ -0,0 +1,40 @@ +--- +title: adx +description: The page provides a detailed explanation of the ADX, a Welles Wilder + moving average of the Directional Movement Index (DX). It explains the ADX interpretation + and its usage along with some relevant parameters. +keywords: +- ADX +- Welles Wilder +- Directional Movement Index +- DX +- ADX interpretation +- ADX usage +- ADX parameters +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +The ADX is a Welles Wilder style moving average of the Directional Movement Index (DX). The values range from 0 to 100, but rarely get above 60. To interpret the ADX, consider a high number to be a strong trend, and a low number, a weak trend. + +### Usage + +```python +adx [-l N_LENGTH] [-s N_SCALAR] [-d N_DRIFT] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| n_length | length | 14 | True | None | +| n_scalar | scalar | 100 | True | None | +| n_drift | drift | 1 | True | None | + +![adx](https://user-images.githubusercontent.com/46355364/154309667-c67f6078-822f-452d-9853-ffffa9172670.png) + +--- diff --git a/website/content/terminal/reference/forex/ta/aroon.md b/website/content/terminal/reference/forex/ta/aroon.md new file mode 100644 index 000000000000..3d390caca163 --- /dev/null +++ b/website/content/terminal/reference/forex/ta/aroon.md @@ -0,0 +1,40 @@ +--- +title: aroon +description: Learn about the Aroon Indicator, a tool that shows when a new trend is + dawning in market analysis. Understand its parameters, usage and visual representation. +keywords: +- Aroon Indicator +- Market Analysis +- New Trend +- Upward Trend +- Downward Trend +- Aroon Up +- Aroon Down +- Crossovers +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +The word aroon is Sanskrit for "dawn's early light." The Aroon indicator attempts to show when a new trend is dawning. The indicator consists of two lines (Up and Down) that measure how long it has been since the highest high/lowest low has occurred within an n period range. When the Aroon Up is staying between 70 and 100 then it indicates an upward trend. When the Aroon Down is staying between 70 and 100 then it indicates an downward trend. A strong upward trend is indicated when the Aroon Up is above 70 while the Aroon Down is below 30. Likewise, a strong downward trend is indicated when the Aroon Down is above 70 while the Aroon Up is below 30. Also look for crossovers. When the Aroon Down crosses above the Aroon Up, it indicates a weakening of the upward trend (and vice versa). + +### Usage + +```python +aroon [-l N_LENGTH] [-s N_SCALAR] [-o N_OFFSET] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| n_length | length | 25 | True | None | +| n_scalar | scalar | 100 | True | None | +| n_offset | offset | 0 | True | None | + +![aroon](https://user-images.githubusercontent.com/46355364/154309825-f8ccc98b-31ac-43fc-a251-66f6f41545a5.png) + +--- diff --git a/website/content/terminal/reference/forex/ta/bbands.md b/website/content/terminal/reference/forex/ta/bbands.md new file mode 100644 index 000000000000..001a5921060e --- /dev/null +++ b/website/content/terminal/reference/forex/ta/bbands.md @@ -0,0 +1,45 @@ +--- +title: bbands +description: Understand Bollinger Bands - an indicator of overbought or oversold conditions + in trading with parameters such as n_length, n_std, and s_mamode. The document includes + information on usage, parameters, and graphical representation. +keywords: +- Bollinger Bands +- moving average +- volatility +- overbought +- oversold +- support +- resistance +- price target +- bbands +- n_length +- n_std +- s_mamode +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Bollinger Bands consist of three lines. The middle band is a simple moving average (generally 20 periods) of the typical price (TP). The upper and lower bands are F standard deviations (generally 2) above and below the middle band. The bands widen and narrow when the volatility of the price is higher or lower, respectively. Bollinger Bands do not, in themselves, generate buy or sell signals; they are an indicator of overbought or oversold conditions. When the price is near the upper or lower band it indicates that a reversal may be imminent. The middle band becomes a support or resistance level. The upper and lower bands can also be interpreted as price targets. When the price bounces off of the lower band and crosses the middle band, then the upper band becomes the price target. + +### Usage + +```python +bbands [-l N_LENGTH] [-s N_STD] [-m {ema,sma,wma,hma,zlma}] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| n_length | length | 5 | True | None | +| n_std | std | 2 | True | 0.0, 0.25, 0.5, 0.75, 1.0, 1.25, 1.5, 1.75, 2.0, 2.25, 2.5, 2.75, 3.0, 3.25, 3.5, 3.75, 4.0, 4.25, 4.5, 4.75, 5.0, 5.25, 5.5, 5.75, 6.0, 6.25, 6.5, 6.75, 7.0, 7.25, 7.5, 7.75, 8.0, 8.25, 8.5, 8.75, 9.0, 9.25, 9.5, 9.75 | +| s_mamode | mamode | sma | True | ema, sma, wma, hma, zlma | + +![bbands](https://user-images.githubusercontent.com/46355364/154309951-116f3c31-342d-4ceb-b489-8b0ba78eb3a0.png) + +--- diff --git a/website/content/terminal/reference/forex/ta/cci.md b/website/content/terminal/reference/forex/ta/cci.md new file mode 100644 index 000000000000..b06030fd84e3 --- /dev/null +++ b/website/content/terminal/reference/forex/ta/cci.md @@ -0,0 +1,39 @@ +--- +title: cci +description: A detailed guide on the CCI or Commodity Channel Index, its usage, parameters + and its role in detecting market trends and facilitating price correction. +keywords: +- CCI +- Commodity Channel Index +- CCI usage +- market trends +- price correction +- overbought conditions +- oversold conditions +- CCI parameters +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +The CCI is designed to detect beginning and ending market trends. The range of 100 to -100 is the normal trading range. CCI values outside of this range indicate overbought or oversold conditions. You can also look for price divergence in the CCI. If the price is making new highs, and the CCI is not, then a price correction is likely. + +### Usage + +```python +cci [-l N_LENGTH] [-s N_SCALAR] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| n_length | length | 14 | True | None | +| n_scalar | scalar | 0.015 | True | None | + +![cci](https://user-images.githubusercontent.com/46355364/154310079-808803ca-26dd-4d45-8a02-17e51230bf2d.png) + +--- diff --git a/website/content/terminal/reference/forex/ta/cg.md b/website/content/terminal/reference/forex/ta/cg.md new file mode 100644 index 000000000000..4dbfac206aff --- /dev/null +++ b/website/content/terminal/reference/forex/ta/cg.md @@ -0,0 +1,42 @@ +--- +title: cg +description: This page details the Center of Gravity (COG) indicator that aids in + predicting future price movements. Instructions regarding its usage and parameters + are also outlined, particularly suitable for range-bound markets. +keywords: +- Center of Gravity indicator +- COG +- oscillators +- price reversals +- range-bound markets +- price predictions +- asset price change +- trading +- parameters +- trending market +- speculate +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +The Center of Gravity indicator, in short, is used to anticipate future price movements and to trade on price reversals as soon as they happen. However, just like other oscillators, the COG indicator returns the best results in range-bound markets and should be avoided when the price is trending. Traders who use it will be able to closely speculate the upcoming price change of the asset. + +### Usage + +```python +cg [-l N_LENGTH] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| n_length | length | 14 | True | None | + +![cg](https://user-images.githubusercontent.com/46355364/154310202-cd0d703e-21ba-41a2-b58a-5b8547efa887.png) + +--- diff --git a/website/content/terminal/reference/forex/ta/donchian.md b/website/content/terminal/reference/forex/ta/donchian.md new file mode 100644 index 000000000000..703a05d22be0 --- /dev/null +++ b/website/content/terminal/reference/forex/ta/donchian.md @@ -0,0 +1,50 @@ +--- +title: donchian +description: Discover how Donchian Channels, generated by moving average calculations, + form an indicator through upper and lower bands around a midrange. Learn how to + use the donchian python code and understand the parameters involved. +keywords: +- Donchian Channels +- moving average calculations +- indicator +- upper band +- lower band +- midrange +- median band +- highest price +- lowest price +- security +- N periods +- Donchian Channel +- parameters +- n_length_upper +- n_length_lower +- length +- usage +- donchian +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Donchian Channels are three lines generated by moving average calculations that comprise an indicator formed by upper and lower bands around a midrange or median band. The upper band marks the highest price of a security over N periods while the lower band marks the lowest price of a security over N periods. The area between the upper and lower bands represents the Donchian Channel. + +### Usage + +```python +donchian [-u N_LENGTH_UPPER] [-l N_LENGTH_LOWER] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| n_length_upper | length | 20 | True | None | +| n_length_lower | length | 20 | True | None | + +![donchian](https://user-images.githubusercontent.com/46355364/154310472-6cd5805f-b87f-4668-85a1-3e5dd7267848.png) + +--- diff --git a/website/content/terminal/reference/forex/ta/ema.md b/website/content/terminal/reference/forex/ta/ema.md new file mode 100644 index 000000000000..0a751aa18406 --- /dev/null +++ b/website/content/terminal/reference/forex/ta/ema.md @@ -0,0 +1,39 @@ +--- +title: ema +description: A guide to understanding and using the Exponential Moving Average, a + fundamental tool in technical analysis with a focus on its application. +keywords: +- Exponential Moving Average +- technical analysis +- moving average +- EMA +- cumulative calculation +- data responsiveness +- EMA use +- EMA parameters +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +The Exponential Moving Average is a staple of technical analysis and is used in countless technical indicators. In a Simple Moving Average, each value in the time period carries equal weight, and values outside of the time period are not included in the average. However, the Exponential Moving Average is a cumulative calculation, including all data. Past values have a diminishing contribution to the average, while more recent values have a greater contribution. This method allows the moving average to be more responsive to changes in the data. + +### Usage + +```python +ema [-l N_LENGTH] [-o N_OFFSET] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| n_length | Window lengths. Multiple values indicated as comma separated values. | 20, 50 | True | None | +| n_offset | offset | 0 | True | None | + +![ema](https://user-images.githubusercontent.com/46355364/154310578-6f4a51a8-3667-497c-9c50-7ff16e256fb6.png) + +--- diff --git a/website/content/terminal/reference/forex/ta/fib.md b/website/content/terminal/reference/forex/ta/fib.md new file mode 100644 index 000000000000..c159b82b8445 --- /dev/null +++ b/website/content/terminal/reference/forex/ta/fib.md @@ -0,0 +1,37 @@ +--- +title: fib +description: Discover how to calculate fibonacci retracement levels with our flexible + parameters. Perfect for financial analysts and traders. +keywords: +- fib +- fibonacci retracement +- financial tool +- trading +- parameters +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Calculates the fibonacci retracement levels + +### Usage + +```python +fib [-p PERIOD] [--start START] [--end END] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| period | Days to look back for retracement | 120 | True | range(1, 960) | +| start | Starting date to select | None | True | None | +| end | Ending date to select | None | True | None | + +![fib](https://user-images.githubusercontent.com/46355364/154310727-81a1eab3-5565-42c7-8b47-4f80288dd700.png) + +--- diff --git a/website/content/terminal/reference/forex/ta/fisher.md b/website/content/terminal/reference/forex/ta/fisher.md new file mode 100644 index 000000000000..98eb544d9621 --- /dev/null +++ b/website/content/terminal/reference/forex/ta/fisher.md @@ -0,0 +1,39 @@ +--- +title: fisher +description: Documentation on the Fisher Transform, a technical indicator used to + highlight trends and potential turning points in asset prices. +keywords: +- Fisher Transform +- technical indicator +- John F. Ehlers +- Gaussian normal distribution +- extreme prices +- turning points +- price of an asset +- trend +- price waves +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +The Fisher Transform is a technical indicator created by John F. Ehlers that converts prices into a Gaussian normal distribution.1 The indicator highlights when prices have moved to an extreme, based on recent prices. This may help in spotting turning points in the price of an asset. It also helps show the trend and isolate the price waves within a trend. + +### Usage + +```python +fisher [-l N_LENGTH] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| n_length | length | 14 | True | None | + +![fisher](https://user-images.githubusercontent.com/46355364/154310853-0abf6cea-71ca-4f07-b009-282c58ab9cfc.png) + +--- diff --git a/website/content/terminal/reference/forex/ta/load.md b/website/content/terminal/reference/forex/ta/load.md new file mode 100644 index 000000000000..5d1ca257bb18 --- /dev/null +++ b/website/content/terminal/reference/forex/ta/load.md @@ -0,0 +1,46 @@ +--- +title: load +description: This documentation page supports users in stock analysis by guiding them + on how to load a stock ticker. It explains various parameters such as market source, + date ranges, pre/after market hours, and periodicity of data. It also includes guidance + for loading custom files and managing data at different frequencies. +keywords: +- Load stock ticker +- Stock analysis +- Data source +- Indian ticker +- Market analysis +- Intraday stock minutes +- Pre/After market hours +- Load custom file +- Monthly data +- Weekly data +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Load stock ticker to perform analysis on. When the data source is syf', an Indian ticker can be loaded by using '.NS' at the end, e.g. 'SBIN.NS'. See available market in https://help.yahoo.com/kb/exchanges-data-providers-yahoo-finance-sln2310.html. + +### Usage + +```python +load -t TICKER [-s START] [-e END] [-i {1,5,15,30,60}] [-p] [-f FILEPATH] [-m] [-w] [-r {ytd,1y,2y,5y,6m}] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| ticker | Stock ticker | None | False | None | +| start | The starting date (format YYYY-MM-DD) of the stock | 2019-11-21 | True | None | +| end | The ending date (format YYYY-MM-DD) of the stock | 2022-11-25 | True | None | +| interval | Intraday stock minutes | 1440 | True | 1, 5, 15, 30, 60 | +| prepost | Pre/After market hours. Only works for 'yf' source, and intraday data | False | True | None | +| filepath | Path to load custom file. | None | True | None | +| monthly | Load monthly data | False | True | None | +| weekly | Load weekly data | False | True | None | +--- diff --git a/website/content/terminal/reference/forex/ta/macd.md b/website/content/terminal/reference/forex/ta/macd.md new file mode 100644 index 000000000000..573bc4288ad1 --- /dev/null +++ b/website/content/terminal/reference/forex/ta/macd.md @@ -0,0 +1,43 @@ +--- +title: macd +description: This page describes the Moving Average Convergence Divergence (MACD) + tool used for trend changes in market conditions. It explains the concept, usage + and different parameters. Information about how these parameters influence and indicate + the onset of new trend direction, overbought or oversold conditions is also provided. +keywords: +- MACD +- Moving Average Convergence Divergence +- Exponential Moving Averages +- trend changes +- overbought conditions +- oversold conditions +- Divergence +- buy signal +- sell signal +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +The Moving Average Convergence Divergence (MACD) is the difference between two Exponential Moving Averages. The Signal line is an Exponential Moving Average of the MACD. The MACD signals trend changes and indicates the start of new trend direction. High values indicate overbought conditions, low values indicate oversold conditions. Divergence with the price indicates an end to the current trend, especially if the MACD is at extreme high or low values. When the MACD line crosses above the signal line a buy signal is generated. When the MACD crosses below the signal line a sell signal is generated. To confirm the signal, the MACD should be above zero for a buy, and below zero for a sell. + +### Usage + +```python +macd [--fast N_FAST] [--slow N_SLOW] [--signal N_SIGNAL] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| n_fast | The short period. | 12 | True | None | +| n_slow | The long period. | 26 | True | None | +| n_signal | The signal period. | 9 | True | None | + +![macd](https://user-images.githubusercontent.com/46355364/154311220-d18eb93e-76b3-4abb-b9c6-86484f462c55.png) + +--- diff --git a/website/content/terminal/reference/forex/ta/obv.md b/website/content/terminal/reference/forex/ta/obv.md new file mode 100644 index 000000000000..e21856c75291 --- /dev/null +++ b/website/content/terminal/reference/forex/ta/obv.md @@ -0,0 +1,37 @@ +--- +title: obv +description: On Balance Volume (OBV) is a technical analysis indicator that uses volume + flow to predict changes in stock price. The OBV measures buying and selling pressure + and is often used to confirm price trends or warn of potential price reversals. +keywords: +- On Balance Volume +- OBV +- technical analysis +- stock price prediction +- price trends +- price reversals +- stock market +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +The On Balance Volume (OBV) is a cumulative total of the up and down volume. When the close is higher than the previous close, the volume is added to the running total, and when the close is lower than the previous close, the volume is subtracted from the running total. To interpret the OBV, look for the OBV to move with the price or precede price moves. If the price moves before the OBV, then it is a non-confirmed move. A series of rising peaks, or falling troughs, in the OBV indicates a strong trend. If the OBV is flat, then the market is not trending. + +### Usage + +```python +obv +``` + +--- + +## Parameters + +This command has no parameters + + +![obv](https://user-images.githubusercontent.com/46355364/154311359-edb78587-744f-4e2c-b247-8b9fbf09b01f.png) + +--- diff --git a/website/content/terminal/reference/forex/ta/rsi.md b/website/content/terminal/reference/forex/ta/rsi.md new file mode 100644 index 000000000000..00287121a33c --- /dev/null +++ b/website/content/terminal/reference/forex/ta/rsi.md @@ -0,0 +1,43 @@ +--- +title: rsi +description: Detailed documentation on how to use the Relative Strength Index (RSI), + a key trading indicator. The page includes information on parameters such as n_length, + n_scalar, and n_drift, as well as how to interpret the RSI. +keywords: +- RSI +- Relative Strength Index +- price movements +- overbought/oversold indicator +- price divergence +- n_length +- n_scalar +- n_drift +- technical analysis +- trading indicator +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +The Relative Strength Index (RSI) calculates a ratio of the recent upward price movements to the absolute price movement. The RSI ranges from 0 to 100. The RSI is interpreted as an overbought/oversold indicator when the value is over 70/below 30. You can also look for divergence with price. If the price is making new highs/lows, and the RSI is not, it indicates a reversal. + +### Usage + +```python +rsi [-l N_LENGTH] [-s N_SCALAR] [-d N_DRIFT] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| n_length | length | 14 | True | None | +| n_scalar | scalar | 100 | True | None | +| n_drift | drift | 1 | True | None | + +![rsi](https://user-images.githubusercontent.com/46355364/154311651-99e67e12-1677-43a9-92d9-5998d99fd0db.png) + +--- diff --git a/website/content/terminal/reference/forex/ta/sma.md b/website/content/terminal/reference/forex/ta/sma.md new file mode 100644 index 000000000000..37e09286e3e2 --- /dev/null +++ b/website/content/terminal/reference/forex/ta/sma.md @@ -0,0 +1,40 @@ +--- +title: sma +description: This page explains the Simple Moving Average (sma), a method used to + filter noise and identify trends in data by averaging the previous set of values + within a given time period. It includes the usage and parameter details. +keywords: +- sma +- moving averages +- simple moving average +- filter noise +- identify trends +- time period +- n_length +- n_offset +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Moving Averages are used to smooth the data in an array to help eliminate noise and identify trends. The Simple Moving Average is literally the simplest form of a moving average. Each output value is the average of the previous n values. In a Simple Moving Average, each value in the time period carries equal weight, and values outside of the time period are not included in the average. This makes it less responsive to recent changes in the data, which can be useful for filtering out those changes. + +### Usage + +```python +sma [-l N_LENGTH] [-o N_OFFSET] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| n_length | Window lengths. Multiple values indicated as comma separated values. | 20, 50 | True | None | +| n_offset | offset | 0 | True | None | + +![sma](https://user-images.githubusercontent.com/46355364/154311791-5b130d08-55bd-406b-a68e-914a733c5191.png) + +--- diff --git a/website/content/terminal/reference/forex/ta/stoch.md b/website/content/terminal/reference/forex/ta/stoch.md new file mode 100644 index 000000000000..22f6daad3cf7 --- /dev/null +++ b/website/content/terminal/reference/forex/ta/stoch.md @@ -0,0 +1,50 @@ +--- +title: stoch +description: The page provides detailed information about the Stochastic Oscillator + trading tool. It describes the principles of operation, situations of overbought + and oversold conditions, and offers instructions for its usage. It also specifies + parameters and their functionality, including time periods of fastk, slowd, and + slowk moving averages. +keywords: +- Stochastic Oscillator +- Overbought condition +- Oversold condition +- Fast %D +- Slow %D +- Buy signal +- Sell signal +- Raw %K +- Trading range +- N_fastkperiod +- N_slowdperiod +- N_slowkperiod +- Fastk moving average +- Slowk moving average +- Slowd moving average +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +The Stochastic Oscillator measures where the close is in relation to the recent trading range. The values range from zero to 100. %D values over 75 indicate an overbought condition; values under 25 indicate an oversold condition. When the Fast %D crosses above the Slow %D, it is a buy signal; when it crosses below, it is a sell signal. The Raw %K is generally considered too erratic to use for crossover signals. + +### Usage + +```python +stoch [-k N_FASTKPERIOD] [-d N_SLOWDPERIOD] [--slowkperiod N_SLOWKPERIOD] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| n_fastkperiod | The time period of the fastk moving average | 14 | True | None | +| n_slowdperiod | The time period of the slowd moving average | 3 | True | None | +| n_slowkperiod | The time period of the slowk moving average | 3 | True | None | + +![stoch](https://user-images.githubusercontent.com/46355364/154311913-d58e58bb-d116-44dd-ae4b-44e59c25f22a.png) + +--- diff --git a/website/content/terminal/reference/forex/ta/zlma.md b/website/content/terminal/reference/forex/ta/zlma.md new file mode 100644 index 000000000000..3d15ed8ee77d --- /dev/null +++ b/website/content/terminal/reference/forex/ta/zlma.md @@ -0,0 +1,43 @@ +--- +title: zlma +description: The ZLMA (Zero Lag Exponential Moving Average) indicator page covers + the concept, usage, and parameters like n_length and n_offset. This indicator, developed + by John Ehlers and Ric Way, is used for moving average calculation on de-lagged + data. The page also provides a visual representation of the zlma method. +keywords: +- zlma +- zero lag exponential moving average +- EMA +- John Ehlers +- Ric Way +- moving average calculation +- lag +- de-lagged data +- n_length +- n_offset +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +The zero lag exponential moving average (ZLEMA) indicator was created by John Ehlers and Ric Way. The idea is do a regular exponential moving average (EMA) calculation but on a de-lagged data instead of doing it on the regular data. Data is de-lagged by removing the data from "lag" days ago thus removing (or attempting to) the cumulative effect of the moving average. + +### Usage + +```python +zlma [-l N_LENGTH] [-o N_OFFSET] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| n_length | Window lengths. Multiple values indicated as comma separated values. | 20 | True | None | +| n_offset | offset | 0 | True | None | + +![zlma](https://user-images.githubusercontent.com/46355364/154312786-bc60268b-9da9-4fd9-bed6-fc95f5560075.png) + +--- diff --git a/website/versioned_docs/version-v3/terminal/reference/funds/_category_.json b/website/content/terminal/reference/funds/_category_.json similarity index 100% rename from website/versioned_docs/version-v3/terminal/reference/funds/_category_.json rename to website/content/terminal/reference/funds/_category_.json diff --git a/website/content/terminal/reference/funds/alswe.md b/website/content/terminal/reference/funds/alswe.md new file mode 100644 index 000000000000..4704c154e734 --- /dev/null +++ b/website/content/terminal/reference/funds/alswe.md @@ -0,0 +1,37 @@ +--- +title: alswe +description: A documentation page for the 'alswe' tool providing allocation insights + for a Swedish fund. Includes parameters for focus on country, sector, or holding + levels. +keywords: +- allocation +- swedish fund +- alswe +- fund exposure +- fund allocation +- sector +- country +- holding +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Show allocation of a swedish fund. + +### Usage + +```python +alswe [--focus {all,country,sector,holding}] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| focus | The focus of the funds exposure/allocation | all | True | all, country, sector, holding | + +--- diff --git a/website/content/terminal/reference/funds/country.md b/website/content/terminal/reference/funds/country.md new file mode 100644 index 000000000000..4b0ccbc9817b --- /dev/null +++ b/website/content/terminal/reference/funds/country.md @@ -0,0 +1,35 @@ +--- +title: country +description: This page provides information on how to set a country for funds. It + explains the usage and parameters needed for this process, primarily focusing on + the country selection parameter. +keywords: +- country +- funds +- usage +- parameters +- name +- select +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Set a country for funds + +### Usage + +```python +country [-n NAME [NAME ...]] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| name | country to select | None | True | None | + +--- diff --git a/website/content/terminal/reference/funds/equity.md b/website/content/terminal/reference/funds/equity.md new file mode 100644 index 000000000000..03fb72bf359e --- /dev/null +++ b/website/content/terminal/reference/funds/equity.md @@ -0,0 +1,30 @@ +--- +title: equity +description: This is a documentation page for the 'equity' command, which displays + fund equity holdings. The page also explains how to use the command and mentions + that it has no parameters. +keywords: +- equity +- fund equity holdings +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Show fund equity holdings. + +### Usage + +```python +equity +``` + +--- + +## Parameters + +This command has no parameters + + +--- diff --git a/website/content/terminal/reference/funds/info.md b/website/content/terminal/reference/funds/info.md new file mode 100644 index 000000000000..1a5fe6bffef6 --- /dev/null +++ b/website/content/terminal/reference/funds/info.md @@ -0,0 +1,30 @@ +--- +title: info +description: The page provides a detailed guide on how to get fund information using + a specific Python command. It also discusses the usage of the command and its parameters. +keywords: +- Fund Information +- Usage +- Command Parameters +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Get fund information. + +### Usage + +```python +info +``` + +--- + +## Parameters + +This command has no parameters + + +--- diff --git a/website/content/terminal/reference/funds/infoswe.md b/website/content/terminal/reference/funds/infoswe.md new file mode 100644 index 000000000000..fb8748719776 --- /dev/null +++ b/website/content/terminal/reference/funds/infoswe.md @@ -0,0 +1,33 @@ +--- +title: infoswe +description: The infoswe documentation page provides details about how to show fund + info of a Swedish fund. It includes usage and parameters instruction for infoswe. +keywords: +- infoswe +- Swedish fund info +- fund information +- usage +- parameters +- instruction +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Show fund info of a swedish fund. + +### Usage + +```python +infoswe +``` + +--- + +## Parameters + +This command has no parameters + + +--- diff --git a/website/content/terminal/reference/funds/load.md b/website/content/terminal/reference/funds/load.md new file mode 100644 index 000000000000..314202c27e11 --- /dev/null +++ b/website/content/terminal/reference/funds/load.md @@ -0,0 +1,36 @@ +--- +title: load +description: This page provides information about the 'load' feature designed to retrieve + historical data. It details the usage and various parameters with their functions. +keywords: +- historical data +- load function +- fund search +- date range +- parameters +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Get historical data. + +### Usage + +```python +load --fund FUND [FUND ...] [-n] [-s START] [-e END] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| fund | Fund string to search for | None | False | None | +| name | Flag to indicate name provided instead of symbol. | False | True | None | +| start | The starting date (format YYYY-MM-DD) of the fund | 2021-11-24 | True | None | +| end | The ending date (format YYYY-MM-DD) of the fund | 2022-11-25 | True | None | + +--- diff --git a/website/content/terminal/reference/funds/overview.md b/website/content/terminal/reference/funds/overview.md new file mode 100644 index 000000000000..def0682aa0e8 --- /dev/null +++ b/website/content/terminal/reference/funds/overview.md @@ -0,0 +1,33 @@ +--- +title: overview +description: This page provides an overview of her selected country's funds. You'll + learn how to limit the number of search results shown. +keywords: +- funds +- country-specific +- overview +- search +- limit +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Show overview of funds from selected country. + +### Usage + +```python +overview [-l LIMIT] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| limit | Number of search results to show | 10 | True | None | + +--- diff --git a/website/content/terminal/reference/funds/plot.md b/website/content/terminal/reference/funds/plot.md new file mode 100644 index 000000000000..97448f1795d1 --- /dev/null +++ b/website/content/terminal/reference/funds/plot.md @@ -0,0 +1,35 @@ +--- +title: plot +description: This page provides guidance on how to plot historical data. It includes + information on the usage of the plot command and explains that there are no parameters + required. +keywords: +- plot +- historical data +- parameters +- usage +- data visualization +- graph +- data analysis +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Plot historical data. + +### Usage + +```python +plot +``` + +--- + +## Parameters + +This command has no parameters + + +--- diff --git a/website/content/terminal/reference/funds/search.md b/website/content/terminal/reference/funds/search.md new file mode 100644 index 000000000000..ea682ac1f8bd --- /dev/null +++ b/website/content/terminal/reference/funds/search.md @@ -0,0 +1,42 @@ +--- +title: search +description: This page provides search features for mutual funds in a selected country + based on various selectable fields. It incorporates features of result sorting and + limiting, displayed in either ascending or descending order. +keywords: +- Search +- Mutual Funds +- Country +- Fields +- Fund Info +- Data Sorting +- Results Limit +- Ascending Order +- Descending Order +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Search mutual funds in selected country based on selected field. + +### Usage + +```python +search [-b {name,issuer,isin,symbol}] --fund FUND [FUND ...] [-s {country,name,symbol,issuer,isin,asset_class,currency,underlying}] [-l LIMIT] [-r] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| by | Field to search by | name | True | name, issuer, isin, symbol | +| fund | Fund string to search for | None | False | None | +| sortby | Column to sort by | name | True | country, name, symbol, issuer, isin, asset_class, currency, underlying | +| limit | Number of search results to show | 10 | True | None | +| reverse | Data is sorted in descending order by default. Reverse flag will sort it in an ascending way. Only works when raw data is displayed. | False | True | None | + +--- diff --git a/website/content/terminal/reference/funds/sector.md b/website/content/terminal/reference/funds/sector.md new file mode 100644 index 000000000000..17a387813746 --- /dev/null +++ b/website/content/terminal/reference/funds/sector.md @@ -0,0 +1,32 @@ +--- +title: sector +description: This page explains how to show fund sector weighting using a command-line + tool, providing usage instructions and parameter details. +keywords: +- fund sector weighting +- command-line tool +- usage instructions +- parameter details +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Show fund sector weighting. + +### Usage + +```python +sector [-m MIN] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| min | Minimum positive float to display sector | 5 | True | None | + +--- diff --git a/website/versioned_docs/version-v3/terminal/reference/futures/_category_.json b/website/content/terminal/reference/futures/_category_.json similarity index 100% rename from website/versioned_docs/version-v3/terminal/reference/futures/_category_.json rename to website/content/terminal/reference/futures/_category_.json diff --git a/website/content/terminal/reference/futures/curve.md b/website/content/terminal/reference/futures/curve.md new file mode 100644 index 000000000000..d44902819b0b --- /dev/null +++ b/website/content/terminal/reference/futures/curve.md @@ -0,0 +1,37 @@ +--- +title: curve +description: Documentation page for the 'curve' command in Python, used to display + futures curve sourced from YahooFinance. Provides usage example and a comprehensive + list of financial ticker parameters. +keywords: +- curve documentation +- curve usage +- futures curve +- financial parameter +- financial trading +- YahooFinance +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Display futures curve. [Source: YahooFinance] + +### Usage + +```python +curve -t TICKER +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| ticker | Future curve to be selected | | False | YI, ALI, BLK, AW, BZ, BZT, CB, CSC, GEO, ZW, ZWT, DC, GDK, HG0, HGT, ZC, ZCT, CLT, DY, QC, QM, XAE, QO, GC, SGU, QG, QH, QU, QI, GF, GFT, GCT, KE, KET, HE, HET, LE, LET, HG, MHG, MGC, SIL, MCL, YG, XK, XC, XW, GNF, ZO, PRK, RBT, ZR, GD, SIT, ZS, ZM, ZMT, ZL, ZLT, SBT, ZN, N1U, TWE, ZT, F1U, RX, GE, GLB, ZF, 10Y, 2YY, 30Y, 5YY, SR1, ZFT, ZQ, Z3N, SR3, ZB, UB, BTM, BTC, ETH, MBT, MET, 6A, 6L, 6B, PJY, PSF, 6C, E7, J7, 6E, EAD, RP, ECD, RY, ENK, ESK, RF, SIR, 6J, KRW, 6M, M6A, MCD, MSF, M6E, M6B, MIR, M6C, M6J, 6N, NKD, NIY, NOK, 6R, 6Z, SEK, 6S, SJY, TPY, YMT, NQT, EST, XAF, RS1, RSG, RSV, RTY, M2K, ESG, EMT, EMD, MNQ, MES, ES, FNG, MMW, CHH, MFS, ASN, LFM, MML, MME, MIN, USS, MWL, MWS, VLQ, SDA, SED, PL, PA, BUS, AUP, GLI, DX, FT5, MMM, MMN, MLE, YM, XAI, XAB, XAK, XAP, XAR, XAU, XAV, XAY, XAZ, BIO, NQ, NQQ, UFV, CC, KC, CT, SF, SB, OJ, NG, RB, CL, TRM | + +![Figure_1dd](https://user-images.githubusercontent.com/25267873/196562734-b3fe1c41-c103-4527-a081-5cf7dae62cce.png) + +--- diff --git a/website/content/terminal/reference/futures/historical.md b/website/content/terminal/reference/futures/historical.md new file mode 100644 index 000000000000..0640c5951087 --- /dev/null +++ b/website/content/terminal/reference/futures/historical.md @@ -0,0 +1,41 @@ +--- +title: historical +description: This documentation page provides the user with instructions on how to + display futures historical data. Certain parameters like ticker data, start date, + and expiry date can be specified to customize the output according to individual + needs. +keywords: +- display futures historical +- futures timeseries +- Ticker data +- historical data +- future expiry date +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Display futures historical. [Source: YahooFinance] + +### Usage + +```python +historical -t TICKER [-s START] [-e EXPIRY] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| ticker | Future ticker to display timeseries separated by comma when multiple, e.g.: BLK,QI | | False | None | +| start | Initial date. Default: 3 years ago | datetime.now() - timedelta(days=365) | True | None | +| expiry | Select future expiry date with format YYYY-MM | | True | None | + +![blk](https://user-images.githubusercontent.com/25267873/196562549-1251b0fd-ca36-4e0f-bca6-b6bfe473effa.png) + +![Figure_31](https://user-images.githubusercontent.com/25267873/196562627-79f9ffa1-8582-457c-91e8-5c18d6d4304f.png) + +--- diff --git a/website/content/terminal/reference/futures/search.md b/website/content/terminal/reference/futures/search.md new file mode 100644 index 000000000000..07a557e31beb --- /dev/null +++ b/website/content/terminal/reference/futures/search.md @@ -0,0 +1,36 @@ +--- +title: search +description: A detailed guide on how to use the search feature in YahooFinance for + futures. Learn how to choose different parameters like exchange, category and description + for a more specific search. +keywords: +- YahooFinance Search +- Futures Search Tool +- YahooFinance Futures +- Search Exchange Futures +- Search Category Futures +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Search futures. [Source: YahooFinance] + +### Usage + +```python +search [-e {NYB,CMX,CME,CBT,NYM}] [-c {metals,agriculture,index,hydrocarbon,bonds,currency}] [-d DESCRIPTION [DESCRIPTION ...]] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| exchange | Select the exchange where the future exists | | True | NYB, CMX, CME, CBT, NYM | +| category | Select the category where the future exists | | True | metals, agriculture, index, hydrocarbon, bonds, currency | +| description | Select the description future you are interested in | | True | None | + +--- diff --git a/website/versioned_docs/version-v3/terminal/reference/portfolio/_category_.json b/website/content/terminal/reference/portfolio/_category_.json similarity index 100% rename from website/versioned_docs/version-v3/terminal/reference/portfolio/_category_.json rename to website/content/terminal/reference/portfolio/_category_.json diff --git a/website/versioned_docs/version-v3/terminal/reference/portfolio/alloc.md b/website/content/terminal/reference/portfolio/alloc.md similarity index 91% rename from website/versioned_docs/version-v3/terminal/reference/portfolio/alloc.md rename to website/content/terminal/reference/portfolio/alloc.md index 54c783c78d42..49c481e5c7b7 100644 --- a/website/versioned_docs/version-v3/terminal/reference/portfolio/alloc.md +++ b/website/content/terminal/reference/portfolio/alloc.md @@ -1,9 +1,20 @@ --- title: alloc -description: OpenBB Terminal Function +description: The page serves as a documentation for 'alloc' - a python function that + helps users understand their portfolio's allocation to different assets or sectors + compared to a benchmark. It includes detailed usage instructions, parameters, and + examples of how to use the function. +keywords: +- alloc +- asset allocation +- sector allocation +- benchmark comparison +- portfolio management --- -# alloc +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + Show your allocation to each asset or sector compared to the benchmark. @@ -56,7 +67,7 @@ Portfolio vs. Benchmark - Top 10 Assets Allocation 2022 May 12, 06:23 (🦋) /portfolio/ $ alloc sectors - Portfolio vs. Benchmark - Top 4 Sectors Allocation + Portfolio vs. Benchmark - Top 4 Sectors Allocation ┏━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━┳━━━━━━━━━━━┳━━━━━━━━━━━━┓ ┃ Sectors ┃ Portfolio ┃ Benchmark ┃ Difference ┃ ┡━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━╇━━━━━━━━━━━╇━━━━━━━━━━━━┩ @@ -71,7 +82,7 @@ Portfolio vs. Benchmark - Top 10 Assets Allocation 2022 May 12, 06:23 (🦋) /portfolio/ $ alloc countries - Portfolio vs. Benchmark - Top 5 Countries Allocation + Portfolio vs. Benchmark - Top 5 Countries Allocation ┏━━━━━━━━━━━━━━━┳━━━━━━━━━━━┳━━━━━━━━━━━┳━━━━━━━━━━━━┓ ┃ Countries ┃ Portfolio ┃ Benchmark ┃ Difference ┃ ┡━━━━━━━━━━━━━━━╇━━━━━━━━━━━╇━━━━━━━━━━━╇━━━━━━━━━━━━┩ @@ -88,7 +99,7 @@ Portfolio vs. Benchmark - Top 10 Assets Allocation 2022 May 12, 06:23 (🦋) /portfolio/ $ alloc regions - Portfolio vs. Benchmark - Top 3 Regions Allocation + Portfolio vs. Benchmark - Top 3 Regions Allocation ┏━━━━━━━━━━━━━━━┳━━━━━━━━━━━┳━━━━━━━━━━━┳━━━━━━━━━━━━┓ ┃ Regions ┃ Portfolio ┃ Benchmark ┃ Difference ┃ ┡━━━━━━━━━━━━━━━╇━━━━━━━━━━━╇━━━━━━━━━━━╇━━━━━━━━━━━━┩ diff --git a/website/content/terminal/reference/portfolio/attrib.md b/website/content/terminal/reference/portfolio/attrib.md new file mode 100644 index 000000000000..eb7175ddd0bc --- /dev/null +++ b/website/content/terminal/reference/portfolio/attrib.md @@ -0,0 +1,48 @@ +--- +title: attrib +description: The page provides detailed information on how to use the 'attrib' command + in order to display portfolio attribution compared to the S&P 500. It invites to + choose between relative or absolute attribution values and to view raw attribution + values in a table. The users can select the period for which they want to calculate + the attribution. +keywords: +- portfolio attribution +- S&P 500 comparison +- attribution calculation +- relative attribution values +- absolute attribution values +- attrib command +- raw attribution values +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Displays sector attribution of the portfolio compared to the S&P 500 + +### Usage + +```python +attrib [-p {mtd,qtd,ytd,3m,6m,1y,3y,5y,10y,all}] [-t {relative,absolute}] [--raw [RAW]] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| period | Period in which to calculate attribution | all | True | mtd, qtd, ytd, 3m, 6m, 1y, 3y, 5y, 10y, all | +| type | Select between relative or absolute attribution values | relative | True | relative, absolute | +| raw | View raw attribution values in a table | False | True | None | + + +--- + +## Examples + +```python +2022 Nov 03, 23:37 (🦋) /portfolio/ $ attrib -p 3m +``` +--- diff --git a/website/content/terminal/reference/portfolio/bench.md b/website/content/terminal/reference/portfolio/bench.md new file mode 100644 index 000000000000..78e987e916de --- /dev/null +++ b/website/content/terminal/reference/portfolio/bench.md @@ -0,0 +1,54 @@ +--- +title: bench +description: This page provides a detailed guideline on how to load in benchmarks + for a portfolio based on the ticker. It elaborates the usage of the 'bench' command + in python, its parameters, choices and gives practical examples of its application. +keywords: +- benchmark +- portfolio +- SPDR S&P 500 ETF Trust (SPY) +- iShares Core S&P 500 ETF (IVV) +- Vanguard Total Stock Market ETF (VTI) +- Vanguard S&P 500 ETF (VOO) +- Invesco QQQ Trust (QQQ) +- full_shares +- shares +- choices +- parameters +- Vanguard FTSE Developed Markets ETF (VEA) +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Load in a benchmark from a selected list or set your own based on the ticker. + +### Usage + +```python +bench -b BENCHMARK [BENCHMARK ...] [-s] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| benchmark | Set the benchmark for the portfolio. By default, this is SPDR S&P 500 ETF Trust (SPY). | SPY | False | SPDR S&P 500 ETF Trust (SPY), iShares Core S&P 500 ETF (IVV), Vanguard Total Stock Market ETF (VTI), Vanguard S&P 500 ETF (VOO), Invesco QQQ Trust (QQQ), Vanguard Value ETF (VTV), Vanguard FTSE Developed Markets ETF (VEA), iShares Core MSCI EAFE ETF (IEFA), iShares Core U.S. Aggregate Bond ETF (AGG), Vanguard Total Bond Market ETF (BND), Vanguard FTSE Emerging Markets ETF (VWO), Vanguard Growth ETF (VUG), iShares Core MSCI Emerging Markets ETF (IEMG), iShares Core S&P Small-Cap ETF (IJR), SPDR Gold Shares (GLD), iShares Russell 1000 Growth ETF (IWF), iShares Core S&P Mid-Cap ETF (IJH), Vanguard Dividend Appreciation ETF (VIG), iShares Russell 2000 ETF (IWM), iShares Russell 1000 Value ETF (IWD), Vanguard Mid-Cap ETF (VO), iShares MSCI EAFE ETF (EFA), Vanguard Total International Stock ETF (VXUS), Vanguard Information Technology ETF (VGT), Vanguard High Dividend Yield Index ETF (VYM), Vanguard Total International Bond ETF (BNDX), Vanguard Real Estate ETF (VNQ), Vanguard Small Cap ETF (VB), Technology Select Sector SPDR Fund (XLK), iShares Core S&P Total U.S. Stock Market ETF (ITOT), Vanguard Intermediate-Term Corporate Bond ETF (VCIT), Vanguard Short-Term Corporate Bond ETF (VCSH), Energy Select Sector SPDR Fund (XLE), Health Care Select Sector SPDR Fund (XLV), Vanguard Short-Term Bond ETF (BSV), Financial Select Sector SPDR Fund (XLF), Schwab US Dividend Equity ETF (SCHD), Invesco S&P 500® Equal Weight ETF (RSP), iShares iBoxx $ Investment Grade Corporate Bond ETF (LQD), iShares S&P 500 Growth ETF (IVW), Vanguard FTSE All-World ex-US Index Fund (VEU), iShares TIPS Bond ETF (TIP), iShares Gold Trust (IAU), Schwab U.S. Large-Cap ETF (SCHX), iShares Core MSCI Total International Stock ETF (IXUS), iShares Russell Midcap ETF (IWR), iShares Russell 1000 ETF (IWB), SPDR Dow Jones Industrial Average ETF Trust (DIA), iShares MSCI Emerging Markets ETF (EEM), iShares MSCI USA Min Vol Factor ETF (USMV), Schwab International Equity ETF (SCHF), iShares S&P 500 Value ETF (IVE), iShares National Muni Bond ETF (MUB), Vanguard Large Cap ETF (VV), Vanguard Small Cap Value ETF (VBR), iShares ESG Aware MSCI USA ETF (ESGU), Vanguard Total World Stock ETF (VT), iShares Core Dividend Growth ETF (DGRO), iShares 1-3 Year Treasury Bond ETF (SHY), iShares Select Dividend ETF (DVY), iShares MSCI USA Quality Factor ETF (QUAL), Schwab U.S. Broad Market ETF (SCHB), iShares MBS ETF (MBB), SPDR S&P Dividend ETF (SDY), iShares 1-5 Year Investment Grade Corporate Bond ETF (IGSB), Vanguard Short-Term Inflation-Protected Securities ETF (VTIP), JPMorgan Ultra-Short Income ETF (JPST), iShares 20+ Year Treasury Bond ETF (TLT), iShares MSCI ACWI ETF (ACWI), SPDR S&P Midcap 400 ETF Trust (MDY), iShares Core Total USD Bond Market ETF (IUSB), iShares Short Treasury Bond ETF (SHV), Vanguard FTSE Europe ETF (VGK), Consumer Discretionary Select Sector SPDR Fund (XLY), SPDR Bloomberg 1-3 Month T-Bill ETF (BIL), iShares U.S. Treasury Bond ETF (GOVT), Vanguard Health Care ETF (VHT), Vanguard Mid-Cap Value ETF (VOE), Consumer Staples Select Sector SPDR Fund (XLP), Schwab U.S. TIPS ETF (SCHP), iShares 7-10 Year Treasury Bond ETF (IEF), iShares Preferred & Income Securities ETF (PFF), Utilities Select Sector SPDR Fund (XLU), Vanguard Tax-Exempt Bond ETF (VTEB), iShares MSCI EAFE Value ETF (EFV), Schwab U.S. Large-Cap Growth ETF (SCHG), iShares J.P. Morgan USD Emerging Markets Bond ETF (EMB), Dimensional U.S. Core Equity 2 ETF (DFAC), Schwab U.S. Small-Cap ETF (SCHA), VanEck Gold Miners ETF (GDX), Vanguard Mortgage-Backed Securities ETF (VMBS), ProShares UltraPro QQQ (TQQQ), Vanguard Short-Term Treasury ETF (VGSH), iShares iBoxx $ High Yield Corporate Bond ETF (HYG), Industrial Select Sector SPDR Fund (XLI), iShares Russell Mid-Cap Value ETF (IWS), Vanguard Extended Market ETF (VXF), SPDR Portfolio S&P 500 ETF (SPLG), SPDR Portfolio S&P 500 Value ETF (SPYV), iShares Russell 2000 Value ETF (IWN) | +| full_shares | Whether to only make a trade with the benchmark when a full share can be bought (no partial shares). | False | True | None | + + +--- + +## Examples + +```python +2022 May 10, 09:53 (🦋) /portfolio/ $ bench Vanguard FTSE Developed Markets ETF (VEA) + +Benchmark: Vanguard Developed Markets Index Fund (VEA) + +2022 May 10, 09:53 (🦋) /portfolio/ $ +``` +--- diff --git a/website/versioned_docs/version-v3/terminal/reference/portfolio/brokers/_category_.json b/website/content/terminal/reference/portfolio/brokers/_category_.json similarity index 100% rename from website/versioned_docs/version-v3/terminal/reference/portfolio/brokers/_category_.json rename to website/content/terminal/reference/portfolio/brokers/_category_.json diff --git a/website/versioned_docs/version-v3/terminal/reference/portfolio/brokers/ally/_category_.json b/website/content/terminal/reference/portfolio/brokers/ally/_category_.json similarity index 100% rename from website/versioned_docs/version-v3/terminal/reference/portfolio/brokers/ally/_category_.json rename to website/content/terminal/reference/portfolio/brokers/ally/_category_.json diff --git a/website/content/terminal/reference/portfolio/brokers/ally/balances.md b/website/content/terminal/reference/portfolio/brokers/ally/balances.md new file mode 100644 index 000000000000..f3459e3d30df --- /dev/null +++ b/website/content/terminal/reference/portfolio/brokers/ally/balances.md @@ -0,0 +1,32 @@ +--- +title: balances +description: Learn about the balances command and its usage in marketing accounting. + No parameters are involved in this command's application. +keywords: +- balances +- marketing +- account balance +- usage +- parameters +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Account balance details + +### Usage + +```python +balances +``` + +--- + +## Parameters + +This command has no parameters + + +--- diff --git a/website/content/terminal/reference/portfolio/brokers/ally/history.md b/website/content/terminal/reference/portfolio/brokers/ally/history.md new file mode 100644 index 000000000000..cf219d6abc8c --- /dev/null +++ b/website/content/terminal/reference/portfolio/brokers/ally/history.md @@ -0,0 +1,33 @@ +--- +title: history +description: This page provides information on the account transaction history feature. + It shows users how to set a limit on the number of recent transactions to display. +keywords: +- Account transaction history +- Usage +- Parameters +- Limit +- Transactions +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Account transaction history + +### Usage + +```python +history [-l LIMIT] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| limit | Number of recent transactions to show | 15 | True | None | + +--- diff --git a/website/content/terminal/reference/portfolio/brokers/ally/holdings.md b/website/content/terminal/reference/portfolio/brokers/ally/holdings.md new file mode 100644 index 000000000000..d557c694a08a --- /dev/null +++ b/website/content/terminal/reference/portfolio/brokers/ally/holdings.md @@ -0,0 +1,31 @@ +--- +title: holdings +description: This documentation page provides information on how to view your trading + accounts on Ally using a command 'holdings'. +keywords: +- Trading Accounts +- Ally +- Holdings +- Ally Trading +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Display info about your trading accounts on Ally + +### Usage + +```python +holdings +``` + +--- + +## Parameters + +This command has no parameters + + +--- diff --git a/website/content/terminal/reference/portfolio/brokers/ally/movers.md b/website/content/terminal/reference/portfolio/brokers/ally/movers.md new file mode 100644 index 000000000000..46aba6af586d --- /dev/null +++ b/website/content/terminal/reference/portfolio/brokers/ally/movers.md @@ -0,0 +1,45 @@ +--- +title: movers +description: This documentation page provides information on how to get stock movers + using Python command line. Detailed explanations for different parameters such as + list_type, exchange, and limit are included. +keywords: +- stock movers +- Python command line +- list_type parameter +- exchange parameter +- limit parameter +- toplosers +- toppctlosers +- topvolume +- topactive +- topgainers +- toppctgainers +- American Stock Exchange +- New York Stock Exchange +- NASDAQ +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Get stock movers + +### Usage + +```python +movers [-t {toplosers,toppctlosers,topvolume,topactive,topgainers,toppctgainers}] [-e {A,N,Q,U,V}] [-l LIMIT] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| list_type | List to get movers of | topactive | True | toplosers, toppctlosers, topvolume, topactive, topgainers, toppctgainers | +| exchange | Exchange to look at. Can be A:American Stock Exchange. N:New York Stock Exchange. Q:NASDAQ U:NASDAQ Bulletin Board V:NASDAQ OTC Other | N | True | A, N, Q, U, V | +| limit | Number to show | 15 | True | None | + +--- diff --git a/website/content/terminal/reference/portfolio/brokers/ally/quote.md b/website/content/terminal/reference/portfolio/brokers/ally/quote.md new file mode 100644 index 000000000000..d9f342f33320 --- /dev/null +++ b/website/content/terminal/reference/portfolio/brokers/ally/quote.md @@ -0,0 +1,33 @@ +--- +title: quote +description: This page provides a guide on how to get stocks quotes using ticker symbols. + It details usage, parameters like ticker and describes how to select multiple stocks + to track at the same time. +keywords: +- stock quote +- stock ticker +- stock market +- quotes +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Get stock quote + +### Usage + +```python +quote [-t TICKER] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| ticker | Ticker to get quote for. Can be in form of 'tick1,tick2...' | None | True | None | + +--- diff --git a/website/versioned_docs/version-v3/terminal/reference/portfolio/brokers/coinbase/_category_.json b/website/content/terminal/reference/portfolio/brokers/coinbase/_category_.json similarity index 100% rename from website/versioned_docs/version-v3/terminal/reference/portfolio/brokers/coinbase/_category_.json rename to website/content/terminal/reference/portfolio/brokers/coinbase/_category_.json diff --git a/website/content/terminal/reference/portfolio/brokers/coinbase/account.md b/website/content/terminal/reference/portfolio/brokers/coinbase/account.md new file mode 100644 index 000000000000..4d32b69a330e --- /dev/null +++ b/website/content/terminal/reference/portfolio/brokers/coinbase/account.md @@ -0,0 +1,36 @@ +--- +title: account +description: Manage and display information about your trading accounts on Coinbase + with options to specify currency and access all account data. +keywords: +- Coinbase +- Trading accounts +- Account information +- Currency value +- USD +- Trading +- Crypto trading +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Display info about your trading accounts on Coinbase + +### Usage + +```python +account [--all] [-c CURRENCY] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| all | Flag to display all your account | False | True | None | +| currency | Currency to display value in. | USD | True | None | + +--- diff --git a/website/content/terminal/reference/portfolio/brokers/coinbase/deposits.md b/website/content/terminal/reference/portfolio/brokers/coinbase/deposits.md new file mode 100644 index 000000000000..8da0d4f7165f --- /dev/null +++ b/website/content/terminal/reference/portfolio/brokers/coinbase/deposits.md @@ -0,0 +1,39 @@ +--- +title: deposits +description: The deposits page is a comprehensive guide on displaying a list of deposits + for your account. It provides details on usage, parameters like deposit type, limit, + sortby, reverse, and their defaults. +keywords: +- deposits +- account +- internal_deposit +- deposit +- limit +- sortby +- reverse +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Display a list of deposits for your account. + +### Usage + +```python +deposits [-t {internal_deposit,deposit}] [-l LIMIT] [-s {created_at,amount}] [-r] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| type | Deposit type. Either: internal_deposits (transfer between portfolios) or deposit | deposit | True | internal_deposit, deposit | +| limit | Limit parameter. | 20 | True | None | +| sortby | Sort by given column. Default: created_at | created_at | True | created_at, amount | +| reverse | Data is sorted in descending order by default. Reverse flag will sort it in an ascending way. Only works when raw data is displayed. | False | True | None | + +--- diff --git a/website/content/terminal/reference/portfolio/brokers/coinbase/history.md b/website/content/terminal/reference/portfolio/brokers/coinbase/history.md new file mode 100644 index 000000000000..6ada610e93ee --- /dev/null +++ b/website/content/terminal/reference/portfolio/brokers/coinbase/history.md @@ -0,0 +1,38 @@ +--- +title: history +description: This page displays details on how to fetch account history using python + command. It includes a list of parameters like coin symbol, account ID, and limit + parameter with their optional values and defaults. +keywords: +- account history +- usage +- parameters +- python command +- coin symbol +- account id +- limit parameter +- BTC +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Display account history + +### Usage + +```python +history [-a ACCOUNT] [-l LIMIT] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| account | Symbol of coin of account or id | BTC | True | None | +| limit | Limit parameter. | 20 | True | None | + +--- diff --git a/website/content/terminal/reference/portfolio/brokers/coinbase/orders.md b/website/content/terminal/reference/portfolio/brokers/coinbase/orders.md new file mode 100644 index 000000000000..bc7662ef555a --- /dev/null +++ b/website/content/terminal/reference/portfolio/brokers/coinbase/orders.md @@ -0,0 +1,39 @@ +--- +title: orders +description: The page explains how open orders can be listed. It provides information + on usage and parameters such as limit, sortby, and reverse. +keywords: +- orders +- open orders +- parameters +- limit +- sortby +- reverse +- descending order +- ascending order +- raw data +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +List your current open orders + +### Usage + +```python +orders [-l LIMIT] [-s {product_id,side,price,size,type,created_at,status}] [-r] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| limit | Limit parameter. | 20 | True | None | +| sortby | Sort by given column. Default: created_at | created_at | True | product_id, side, price, size, type, created_at, status | +| reverse | Data is sorted in descending order by default. Reverse flag will sort it in an ascending way. Only works when raw data is displayed. | False | True | None | + +--- diff --git a/website/versioned_docs/version-v3/terminal/reference/portfolio/brokers/degiro/_category_.json b/website/content/terminal/reference/portfolio/brokers/degiro/_category_.json similarity index 100% rename from website/versioned_docs/version-v3/terminal/reference/portfolio/brokers/degiro/_category_.json rename to website/content/terminal/reference/portfolio/brokers/degiro/_category_.json diff --git a/website/content/terminal/reference/portfolio/brokers/degiro/cancel.md b/website/content/terminal/reference/portfolio/brokers/degiro/cancel.md new file mode 100644 index 000000000000..5e0b7ea75442 --- /dev/null +++ b/website/content/terminal/reference/portfolio/brokers/degiro/cancel.md @@ -0,0 +1,33 @@ +--- +title: cancel +description: This page provides detailed guidance on how to cancel an order using + id as the parameter. It explains the usage, parameters, and possible choices. +keywords: +- cancel +- order +- id +- usage +- parameters +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + + + +### Usage + +```python +cancel id +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| id | Order's id. | None | False | None | + +--- diff --git a/website/content/terminal/reference/portfolio/brokers/degiro/companynews.md b/website/content/terminal/reference/portfolio/brokers/degiro/companynews.md new file mode 100644 index 000000000000..dd4eb4cf8536 --- /dev/null +++ b/website/content/terminal/reference/portfolio/brokers/degiro/companynews.md @@ -0,0 +1,39 @@ +--- +title: companynews +description: This page contains a guide on how to use the 'companynews' tool and set + its parameters such as SYMBOL, which represents the company's ISIN code; LIMIT for + the number of news to display; OFFSET to adjust the displayed news; and LANGUAGES + to define the languages in which the news appears. +keywords: +- company news tool +- usage guide +- ISIN code +- news display +- display offset +- language settings +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + + + +### Usage + +```python +companynews -s SYMBOL [-l LIMIT] [-o OFFSET] [-lang LANGUAGES] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| symbol | ISIN code of the company. | None | False | None | +| limit | Number of news to display. | 10 | True | None | +| offset | Offset of news to display. | 0 | True | None | +| languages | Languages of news to display. | en,fr | True | None | + +--- diff --git a/website/content/terminal/reference/portfolio/brokers/degiro/create.md b/website/content/terminal/reference/portfolio/brokers/degiro/create.md new file mode 100644 index 000000000000..ae54c74c78fd --- /dev/null +++ b/website/content/terminal/reference/portfolio/brokers/degiro/create.md @@ -0,0 +1,57 @@ +--- +title: create +description: This is a technical page with detailed instructions on how to create + and use parameters including action, product, symbol, price, size, up_to, duration, + type, and their respective choices in programming. This covers various market operations + including buy, sell, GTD, GTC, limit, market, stop-limit, and stop-loss. +keywords: +- create +- usage +- parameters +- action +- product +- symbol +- price +- size +- up_to +- duration +- type +- order +- buy +- sell +- gtd +- gtc +- limit +- market +- stop-limit +- stop-loss +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + + + +### Usage + +```python +create [-a {buy,sell}] (-prod PRODUCT | -sym SYMBOL) -p PRICE (-s SIZE | -up UP_TO) [-d {gtd,gtc}] [-t {limit,market,stop-limit,stop-loss}] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| action | Action wanted. | buy | True | buy, sell | +| product | Id of the product wanted. | None | True | None | +| symbol | Symbol wanted. | None | True | None | +| price | Price wanted. | None | False | None | +| size | Price wanted. | None | True | None | +| up_to | Up to price. | None | True | None | +| duration | Duration of the Order. | gtd | True | gtd, gtc | +| type | Type of the Order. | limit | True | limit, market, stop-limit, stop-loss | + +--- diff --git a/website/content/terminal/reference/portfolio/brokers/degiro/hold.md b/website/content/terminal/reference/portfolio/brokers/degiro/hold.md new file mode 100644 index 000000000000..b4eefff5bc61 --- /dev/null +++ b/website/content/terminal/reference/portfolio/brokers/degiro/hold.md @@ -0,0 +1,30 @@ +--- +title: hold +description: The document page provides instructions on how to use the 'hold' command + in Python, which requires no parameters. +keywords: +- hold command +- usage +- no parameters +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + + + +### Usage + +```python +hold +``` + +--- + +## Parameters + +This command has no parameters + + +--- diff --git a/website/content/terminal/reference/portfolio/brokers/degiro/lastnews.md b/website/content/terminal/reference/portfolio/brokers/degiro/lastnews.md new file mode 100644 index 000000000000..4b3e04a40566 --- /dev/null +++ b/website/content/terminal/reference/portfolio/brokers/degiro/lastnews.md @@ -0,0 +1,31 @@ +--- +title: lastnews +description: Documentation on the 'lastnews' function in Python. Features include + the option to limit the number of displayed news. +keywords: +- lastnews +- news display +- limit parameter +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + + + +### Usage + +```python +lastnews [-l LIMIT] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| limit | Number of news to display. | 10 | True | None | + +--- diff --git a/website/content/terminal/reference/portfolio/brokers/degiro/login.md b/website/content/terminal/reference/portfolio/brokers/degiro/login.md new file mode 100644 index 000000000000..8e65928788e8 --- /dev/null +++ b/website/content/terminal/reference/portfolio/brokers/degiro/login.md @@ -0,0 +1,33 @@ +--- +title: login +description: This page provides instructions on how to login using one-time-password + for 2FA. It includes parameters' description and usage. +keywords: +- login +- Usage +- Parameters +- One time password +- 2FA +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + + + +### Usage + +```python +login [-otp ONE_TIME_PASSWORD] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| one_time_password | One-time-password for 2FA. | None | True | None | + +--- diff --git a/website/content/terminal/reference/portfolio/brokers/degiro/logout.md b/website/content/terminal/reference/portfolio/brokers/degiro/logout.md new file mode 100644 index 000000000000..74d26f76c98f --- /dev/null +++ b/website/content/terminal/reference/portfolio/brokers/degiro/logout.md @@ -0,0 +1,30 @@ +--- +title: logout +description: This page provides information about how to use the logout command in + python. It includes the usage of this command and the details about its parameters. +keywords: +- logout +- usage +- parameters +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + + + +### Usage + +```python +logout +``` + +--- + +## Parameters + +This command has no parameters + + +--- diff --git a/website/content/terminal/reference/portfolio/brokers/degiro/lookup.md b/website/content/terminal/reference/portfolio/brokers/degiro/lookup.md new file mode 100644 index 000000000000..c7a496975531 --- /dev/null +++ b/website/content/terminal/reference/portfolio/brokers/degiro/lookup.md @@ -0,0 +1,37 @@ +--- +title: lookup +description: A detailed guide on how to use the lookup command in python, showing + parameters such as search_text, limit, and offset and their usage. +keywords: +- lookup command +- search_text +- limit +- offset +- command parameters +- usage guide +- coding documentation +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + + + +### Usage + +```python +lookup [-l LIMIT] [-o OFFSET] search_text +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| search_text | Name of the company or a text. | None | False | None | +| limit | Number of result expected (0 for unlimited). | 10 | True | None | +| offset | To use an offset. | 0 | True | None | + +--- diff --git a/website/content/terminal/reference/portfolio/brokers/degiro/paexport.md b/website/content/terminal/reference/portfolio/brokers/degiro/paexport.md new file mode 100644 index 000000000000..0845dcbc35ac --- /dev/null +++ b/website/content/terminal/reference/portfolio/brokers/degiro/paexport.md @@ -0,0 +1,36 @@ +--- +title: paexport +description: Detailed usage guide and parameters of the 'paexport' Python command. + This includes instructions on setting the start and end date, along with the usage + of different currencies. +keywords: +- paexport +- usage +- parameters +- currency +- USD +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + + + +### Usage + +```python +paexport -s START [-e END] [-c CURRENCY] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| start | Start date. | None | False | None | +| end | End date. | datetime.now() | True | None | +| currency | Used currency. | USD | True | None | + +--- diff --git a/website/content/terminal/reference/portfolio/brokers/degiro/pending.md b/website/content/terminal/reference/portfolio/brokers/degiro/pending.md new file mode 100644 index 000000000000..83ef73bd2e17 --- /dev/null +++ b/website/content/terminal/reference/portfolio/brokers/degiro/pending.md @@ -0,0 +1,31 @@ +--- +title: pending +description: This page discusses the 'pending' concept, its usage in Python, and emphasizes + that the command does not require any parameters. It is a useful resource for those + interested in understanding and applying this 'pending' operation. +keywords: +- pending +- usage +- parameters +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + + + +### Usage + +```python +pending +``` + +--- + +## Parameters + +This command has no parameters + + +--- diff --git a/website/content/terminal/reference/portfolio/brokers/degiro/topnews.md b/website/content/terminal/reference/portfolio/brokers/degiro/topnews.md new file mode 100644 index 000000000000..06377bf0f099 --- /dev/null +++ b/website/content/terminal/reference/portfolio/brokers/degiro/topnews.md @@ -0,0 +1,34 @@ +--- +title: topnews +description: The topnews function provides users with the most current and breaking + news. It's simple to use and doesn't require any parameters, keeping you informed + about the world's events with minimal effort. +keywords: +- topnews +- news +- up to date +- current events +- news updates +- daily news +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + + + +### Usage + +```python +topnews +``` + +--- + +## Parameters + +This command has no parameters + + +--- diff --git a/website/content/terminal/reference/portfolio/brokers/degiro/update.md b/website/content/terminal/reference/portfolio/brokers/degiro/update.md new file mode 100644 index 000000000000..50d4946c1608 --- /dev/null +++ b/website/content/terminal/reference/portfolio/brokers/degiro/update.md @@ -0,0 +1,34 @@ +--- +title: update +description: The marketing website page 'update' is primarily focused on how to update + orders by their ID and price. Learn the usage and understand the parameters in detail. +keywords: +- Order update +- docusaurus SEO +- price updating +- Order's id +- docusaurus parameters +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + + + +### Usage + +```python +update -p PRICE id +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| id | Order's id. | None | False | None | +| price | Price wanted. | None | False | None | + +--- diff --git a/website/versioned_docs/version-v3/terminal/reference/portfolio/brokers/robinhood/_category_.json b/website/content/terminal/reference/portfolio/brokers/robinhood/_category_.json similarity index 100% rename from website/versioned_docs/version-v3/terminal/reference/portfolio/brokers/robinhood/_category_.json rename to website/content/terminal/reference/portfolio/brokers/robinhood/_category_.json diff --git a/website/content/terminal/reference/portfolio/brokers/robinhood/history.md b/website/content/terminal/reference/portfolio/brokers/robinhood/history.md new file mode 100644 index 000000000000..747c065f4bf8 --- /dev/null +++ b/website/content/terminal/reference/portfolio/brokers/robinhood/history.md @@ -0,0 +1,36 @@ +--- +title: history +description: Learn about the usage and parameters for accessing historical portfolio + information with spans ranging from a day to all accessible history and intervals + from 5 minutes to a week. +keywords: +- historical portfolio info +- portfolio history +- historical data +- interval data +- span of data +- usage +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Historical Portfolio Info + +### Usage + +```python +history [-s {day,week,month,3month,year,5year,all}] [-i {5minute,10minute,hour,day,week}] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| span | Span of historical data | 3month | True | day, week, month, 3month, year, 5year, all | +| interval | Interval to look at portfolio | day | True | 5minute, 10minute, hour, day, week | + +--- diff --git a/website/content/terminal/reference/portfolio/brokers/robinhood/holdings.md b/website/content/terminal/reference/portfolio/brokers/robinhood/holdings.md new file mode 100644 index 000000000000..d9120ea4a91e --- /dev/null +++ b/website/content/terminal/reference/portfolio/brokers/robinhood/holdings.md @@ -0,0 +1,33 @@ +--- +title: holdings +description: This Docusaurus page provides information on how to use the 'holdings' + function to display information about your trading accounts on Robinhood. It also + covers usage and details about parameters. +keywords: +- holdings +- trading accounts +- Robinhood +- account info +- trading +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Display info about your trading accounts on Robinhood + +### Usage + +```python +holdings +``` + +--- + +## Parameters + +This command has no parameters + + +--- diff --git a/website/content/terminal/reference/portfolio/distr.md b/website/content/terminal/reference/portfolio/distr.md new file mode 100644 index 000000000000..40f561ca1ff4 --- /dev/null +++ b/website/content/terminal/reference/portfolio/distr.md @@ -0,0 +1,40 @@ +--- +title: distr +description: This page provides information on how to compute the distribution of + daily returns with 'distr'. It includes details on its usage, parameters and choices + for the period. +keywords: +- distr +- daily returns +- compute distribution +- usage +- parameters +- period +- file +- loaded +- default +- optional +- choices +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Compute distribution of daily returns + +### Usage + +```python +distr [-p PERIOD] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| period | The file to be loaded | all | True | mtd, qtd, ytd, 3m, 6m, 1y, 3y, 5y, 10y, all | + +--- diff --git a/website/content/terminal/reference/portfolio/dret.md b/website/content/terminal/reference/portfolio/dret.md new file mode 100644 index 000000000000..72c122745f7f --- /dev/null +++ b/website/content/terminal/reference/portfolio/dret.md @@ -0,0 +1,38 @@ +--- +title: dret +description: The dret page is about getting daily returns for specific periods. Users + can modify periods as 3y, 5y, 10y, or select all for the entire duration. It also + clarifies the usage and parameters in detail. +keywords: +- dret +- daily returns +- period +- year returns +- 3y +- 5y +- 10y +- all +- usage +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Daily returns + +### Usage + +```python +dret [-p PERIOD] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| period | Period to select start end of the year returns | all | True | 3y, 5y, 10y, all | + +--- diff --git a/website/content/terminal/reference/portfolio/es.md b/website/content/terminal/reference/portfolio/es.md new file mode 100644 index 000000000000..e3c6ee2114ef --- /dev/null +++ b/website/content/terminal/reference/portfolio/es.md @@ -0,0 +1,59 @@ +--- +title: es +description: This documentation page provides guidance on how to use the Expected + Shortfall (ES) function of the selected portfolio. It includes its usage, parameters + including distribution and percentile, and examples. +keywords: +- Expected Shortfall +- ES function +- portfolio +- parameters +- distribution +- percentile +- portfolio return +- mean of portfolios +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Provides Expected Shortfall (short: ES) of the selected portfolio. + +### Usage + +```python +es [-m] [-d DIST] [-p PERCENTILE] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| use_mean | If one should use the mean of the portfolios return | True | True | None | +| distribution | Distribution used for the calculations | normal | True | laplace, student_t, logistic, normal | +| percentile | Percentile used for ES calculations, for example input 99.9 equals a 99.9 Percent Expected Shortfall | 99.9 | True | None | + + +--- + +## Examples + +```python +2022 Feb 25, 03:09 (🦋) /portfolio/ $ es + Portfolio Expected Shortfall +┏━━━━━━━┳━━━━━━━━━┳━━━━━━━━━━━━━━━━┓ +┃ ┃ ES: ┃ Historical ES: ┃ +┡━━━━━━━╇━━━━━━━━━╇━━━━━━━━━━━━━━━━┩ +│ 90.0% │ -0.0204 │ -0.0202 │ +├───────┼─────────┼────────────────┤ +│ 95.0% │ -0.0240 │ -0.0242 │ +├───────┼─────────┼────────────────┤ +│ 99.0% │ -0.0310 │ -0.0270 │ +├───────┼─────────┼────────────────┤ +│ 99.9% │ -0.0391 │ -0.0277 │ +└───────┴─────────┴────────────────┘ +``` +--- diff --git a/website/content/terminal/reference/portfolio/holdp.md b/website/content/terminal/reference/portfolio/holdp.md new file mode 100644 index 000000000000..0f85a9dbea98 --- /dev/null +++ b/website/content/terminal/reference/portfolio/holdp.md @@ -0,0 +1,33 @@ +--- +title: holdp +description: A guide on how to use the holdp function to display holdings of assets + in percentage. Includes usage, parameters and additional options. +keywords: +- display holdings +- assets percentage +- holdp function +- Holdings management +- Portfolio management +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Display holdings of assets (in percentage) + +### Usage + +```python +holdp [-u] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| unstack | Sum all assets percentage over time | False | True | None | + +--- diff --git a/website/content/terminal/reference/portfolio/holdv.md b/website/content/terminal/reference/portfolio/holdv.md new file mode 100644 index 000000000000..3994c0982858 --- /dev/null +++ b/website/content/terminal/reference/portfolio/holdv.md @@ -0,0 +1,37 @@ +--- +title: holdv +description: The page provides detailed information on the usage, the required and + optional parameters of 'holdv' - a function used to display the holdings of assets. + It specifically features the 'unstack' parameter for summing all assets value over + time. +keywords: +- holdv +- assets +- unstack +- value +- time +- usage +- parameters +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Display holdings of assets (absolute value) + +### Usage + +```python +holdv [-u] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| unstack | Sum all assets value over time | False | True | None | + +--- diff --git a/website/content/terminal/reference/portfolio/load.md b/website/content/terminal/reference/portfolio/load.md new file mode 100644 index 000000000000..1a7c1a8212c3 --- /dev/null +++ b/website/content/terminal/reference/portfolio/load.md @@ -0,0 +1,136 @@ +--- +title: load +description: The 'load' function allows users to load their portfolio transactions + from a given file, optionally assigning a name and setting a risk-free rate. The + loaded portfolio details will be presented in a detailed table showcasing each transaction. +keywords: +- load +- portfolio transactions +- parameters +- risk free rate +- file +- name +- examples +- portfolio +- stocks +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Load your portfolio transactions. + +### Usage + +```python +load -f FILE [-n NAME] [-r RISK_FREE_RATE] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| file | The file to be loaded | None | False | Public_Equity_Orderbook.xlsx, Public_Equity_Orderbook_No_Categorization.xlsx, bitcoin.csv, example.csv, market.csv | +| name | The name that you wish to give to your portfolio | None | True | None | +| risk_free_rate | Set the risk free rate. | 0 | True | None | + + +--- + +## Examples + +```python +2022 May 13, 05:00 (🦋) /portfolio/ $ load Public_Equity_Orderbook.xlsx + +Portfolio: Public_Equity_Orderbook.xlsx +Risk Free Rate: 0.00% + +2022 May 13, 05:00 (🦋) /portfolio/ $ show +┏━━━━━━━━━━━━┳━━━━━━━┳━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━┳━━━━━━━━━━┳━━━━━━━━━━┳━━━━━━┳━━━━━━━━━┳━━━━━━━━━━━━┳━━━━━━┳━━━━━━━━━━┓ +┃ Date ┃ Name ┃ Type ┃ Sector ┃ Industry ┃ Country ┃ Region ┃ Price ┃ Quantity ┃ Fees ┃ Premium ┃ Investment ┃ Side ┃ Currency ┃ +┡━━━━━━━━━━━━╇━━━━━━━╇━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━╇━━━━━━━━━━╇━━━━━━━━━━╇━━━━━━╇━━━━━━━━━╇━━━━━━━━━━━━╇━━━━━━╇━━━━━━━━━━┩ +│ 2010-05-03 │ CASH │ CASH │ CASH │ CASH │ CASH │ Unknown │ 60850.00 │ 1 │ 0 │ 0 │ 60850.00 │ 1 │ USD │ +├────────────┼───────┼───────┼────────────────────────┼─────────────────────────────────────┼───────────────┼───────────────┼──────────┼──────────┼──────┼─────────┼────────────┼──────┼──────────┤ +│ 2010-05-03 │ GOOGL │ STOCK │ Communication Services │ Internet Content & Information │ United States │ North America │ 265.30 │ 2 │ 5 │ 6 │ 530.60 │ 1 │ USD │ +├────────────┼───────┼───────┼────────────────────────┼─────────────────────────────────────┼───────────────┼───────────────┼──────────┼──────────┼──────┼─────────┼────────────┼──────┼──────────┤ +│ 2010-07-06 │ AMZN │ STOCK │ Technology │ Internet Retail │ United States │ North America │ 110.06 │ 5 │ 3 │ 3 │ 550.30 │ 1 │ USD │ +├────────────┼───────┼───────┼────────────────────────┼─────────────────────────────────────┼───────────────┼───────────────┼──────────┼──────────┼──────┼─────────┼────────────┼──────┼──────────┤ +│ 2011-08-06 │ AAPL │ STOCK │ Technology │ Consumer Electronics │ United States │ North America │ 12.61 │ 3 │ 1 │ 0 │ 37.83 │ 1 │ USD │ +├────────────┼───────┼───────┼────────────────────────┼─────────────────────────────────────┼───────────────┼───────────────┼──────────┼──────────┼──────┼─────────┼────────────┼──────┼──────────┤ +│ 2011-12-12 │ APTV │ STOCK │ Consumer Cyclical │ Auto Parts │ United States │ North America │ 18.02 │ 5 │ 0 │ 2 │ 90.10 │ 1 │ USD │ +├────────────┼───────┼───────┼────────────────────────┼─────────────────────────────────────┼───────────────┼───────────────┼──────────┼──────────┼──────┼─────────┼────────────┼──────┼──────────┤ +│ 2012-02-03 │ ASML │ STOCK │ Technology │ Semiconductor Equipment & Materials │ Netherlands │ Europe │ 59.17 │ 7 │ 0 │ 4 │ 414.19 │ 1 │ USD │ +├────────────┼───────┼───────┼────────────────────────┼─────────────────────────────────────┼───────────────┼───────────────┼──────────┼──────────┼──────┼─────────┼────────────┼──────┼──────────┤ +│ 2012-05-04 │ NKE │ STOCK │ Consumer Cyclical │ Footwear & Accessories │ Germany │ Europe │ 27.95 │ 3 │ 0 │ 0 │ 83.85 │ 1 │ USD │ +├────────────┼───────┼───────┼────────────────────────┼─────────────────────────────────────┼───────────────┼───────────────┼──────────┼──────────┼──────┼─────────┼────────────┼──────┼──────────┤ +│ 2012-08-04 │ TSM │ STOCK │ Technology │ Semiconductors │ Taiwan │ Asia │ 14.24 │ 50 │ 0 │ 0 │ 712.00 │ 1 │ USD │ +├────────────┼───────┼───────┼────────────────────────┼─────────────────────────────────────┼───────────────┼───────────────┼──────────┼──────────┼──────┼─────────┼────────────┼──────┼──────────┤ +│ 2012-10-12 │ DGX │ STOCK │ Healthcare │ Diagnostics & Research │ United States │ North America │ 63.39 │ 6 │ 10 │ 0 │ 380.34 │ 1 │ USD │ +├────────────┼───────┼───────┼────────────────────────┼─────────────────────────────────────┼───────────────┼───────────────┼──────────┼──────────┼──────┼─────────┼────────────┼──────┼──────────┤ +│ 2013-02-03 │ YUM │ STOCK │ Consumer Cyclical │ Restaurants │ United States │ North America │ 45.98 │ 4 │ 10 │ 0 │ 183.92 │ 1 │ USD │ +├────────────┼───────┼───────┼────────────────────────┼─────────────────────────────────────┼───────────────┼───────────────┼──────────┼──────────┼──────┼─────────┼────────────┼──────┼──────────┤ +│ 2013-03-04 │ GOOGL │ STOCK │ Communication Services │ Internet Content & Information │ United States │ North America │ 410.75 │ 1 │ 100 │ 2 │ 410.75 │ 1 │ USD │ +├────────────┼───────┼───────┼────────────────────────┼─────────────────────────────────────┼───────────────┼───────────────┼──────────┼──────────┼──────┼─────────┼────────────┼──────┼──────────┤ +│ 2013-08-08 │ AMZN │ STOCK │ Technology │ Internet Retail │ United States │ North America │ 295.74 │ 1 │ 2 │ 3 │ 295.74 │ 1 │ USD │ +├────────────┼───────┼───────┼────────────────────────┼─────────────────────────────────────┼───────────────┼───────────────┼──────────┼──────────┼──────┼─────────┼────────────┼──────┼──────────┤ +│ 2013-10-09 │ AAPL │ STOCK │ Technology │ Consumer Electronics │ United States │ North America │ 17.38 │ 5 │ 5 │ 5 │ 86.90 │ 1 │ USD │ +├────────────┼───────┼───────┼────────────────────────┼─────────────────────────────────────┼───────────────┼───────────────┼──────────┼──────────┼──────┼─────────┼────────────┼──────┼──────────┤ +│ 2014-02-03 │ APTV │ STOCK │ Consumer Cyclical │ Auto Parts │ United States │ North America │ 49.53 │ 5 │ 4 │ 0 │ 247.65 │ 1 │ USD │ +├────────────┼───────┼───────┼────────────────────────┼─────────────────────────────────────┼───────────────┼───────────────┼──────────┼──────────┼──────┼─────────┼────────────┼──────┼──────────┤ +│ 2014-02-05 │ ASML │ STOCK │ Technology │ Semiconductor Equipment & Materials │ Netherlands │ Europe │ 85.16 │ 3 │ 3 │ 0 │ 255.48 │ 1 │ USD │ +├────────────┼───────┼───────┼────────────────────────┼─────────────────────────────────────┼───────────────┼───────────────┼──────────┼──────────┼──────┼─────────┼────────────┼──────┼──────────┤ +│ 2014-12-08 │ NKE │ STOCK │ Consumer Cyclical │ Footwear & Accessories │ Germany │ Europe │ 48.86 │ 10 │ 2 │ 0 │ 488.60 │ 1 │ USD │ +├────────────┼───────┼───────┼────────────────────────┼─────────────────────────────────────┼───────────────┼───────────────┼──────────┼──────────┼──────┼─────────┼────────────┼──────┼──────────┤ +│ 2015-02-02 │ BABA │ STOCK │ Consumer Cyclical │ Internet Retail │ China │ Asia │ 90.13 │ 30 │ 1 │ 0 │ 2703.90 │ 1 │ USD │ +├────────────┼───────┼───────┼────────────────────────┼─────────────────────────────────────┼───────────────┼───────────────┼──────────┼──────────┼──────┼─────────┼────────────┼──────┼──────────┤ +│ 2015-03-08 │ TSM │ STOCK │ Technology │ Semiconductors │ Taiwan │ Asia │ 23.45 │ 20 │ 6 │ 0 │ 469.00 │ 1 │ USD │ +├────────────┼───────┼───────┼────────────────────────┼─────────────────────────────────────┼───────────────┼───────────────┼──────────┼──────────┼──────┼─────────┼────────────┼──────┼──────────┤ +│ 2015-12-05 │ DGX │ STOCK │ Healthcare │ Diagnostics & Research │ United States │ North America │ 68.83 │ 21 │ 2 │ 3 │ 1445.43 │ 1 │ USD │ +├────────────┼───────┼───────┼────────────────────────┼─────────────────────────────────────┼───────────────┼───────────────┼──────────┼──────────┼──────┼─────────┼────────────┼──────┼──────────┤ +│ 2016-02-06 │ YUM │ STOCK │ Consumer Cyclical │ Restaurants │ United States │ North America │ 48.49 │ 2 │ 4 │ 1 │ 96.98 │ 1 │ USD │ +├────────────┼───────┼───────┼────────────────────────┼─────────────────────────────────────┼───────────────┼───────────────┼──────────┼──────────┼──────┼─────────┼────────────┼──────┼──────────┤ +│ 2016-09-07 │ GOOGL │ STOCK │ Communication Services │ Internet Content & Information │ United States │ North America │ 807.99 │ 2 │ 0 │ 2 │ 1615.98 │ 1 │ USD │ +├────────────┼───────┼───────┼────────────────────────┼─────────────────────────────────────┼───────────────┼───────────────┼──────────┼──────────┼──────┼─────────┼────────────┼──────┼──────────┤ +│ 2017-01-10 │ AMZN │ STOCK │ Technology │ Internet Retail │ United States │ North America │ 795.90 │ 2 │ 0 │ 0 │ 1591.80 │ 1 │ USD │ +├────────────┼───────┼───────┼────────────────────────┼─────────────────────────────────────┼───────────────┼───────────────┼──────────┼──────────┼──────┼─────────┼────────────┼──────┼──────────┤ +│ 2017-05-10 │ AAPL │ STOCK │ Technology │ Consumer Electronics │ United States │ North America │ 38.32 │ 10 │ 0 │ 0 │ 383.20 │ 1 │ USD │ +├────────────┼───────┼───────┼────────────────────────┼─────────────────────────────────────┼───────────────┼───────────────┼──────────┼──────────┼──────┼─────────┼────────────┼──────┼──────────┤ +│ 2017-12-08 │ APTV │ STOCK │ Consumer Cyclical │ Auto Parts │ United States │ North America │ 85.22 │ 10 │ 4 │ 0 │ 852.20 │ 1 │ USD │ +├────────────┼───────┼───────┼────────────────────────┼─────────────────────────────────────┼───────────────┼───────────────┼──────────┼──────────┼──────┼─────────┼────────────┼──────┼──────────┤ +│ 2018-07-05 │ ASML │ STOCK │ Technology │ Semiconductor Equipment & Materials │ Netherlands │ Europe │ 195.99 │ 5 │ 2 │ 5 │ 979.95 │ 1 │ USD │ +├────────────┼───────┼───────┼────────────────────────┼─────────────────────────────────────┼───────────────┼───────────────┼──────────┼──────────┼──────┼─────────┼────────────┼──────┼──────────┤ +│ 2018-09-03 │ NKE │ STOCK │ Consumer Cyclical │ Footwear & Accessories │ Germany │ Europe │ 79.60 │ 3 │ 2 │ 4 │ 238.80 │ 1 │ USD │ +├────────────┼───────┼───────┼────────────────────────┼─────────────────────────────────────┼───────────────┼───────────────┼──────────┼──────────┼──────┼─────────┼────────────┼──────┼──────────┤ +│ 2019-05-04 │ BABA │ STOCK │ Consumer Cyclical │ Internet Retail │ China │ Asia │ 188.24 │ 5 │ 1 │ 2 │ 941.20 │ 1 │ USD │ +├────────────┼───────┼───────┼────────────────────────┼─────────────────────────────────────┼───────────────┼───────────────┼──────────┼──────────┼──────┼─────────┼────────────┼──────┼──────────┤ +│ 2019-09-09 │ TSM │ STOCK │ Technology │ Semiconductors │ Taiwan │ Asia │ 43.85 │ 3 │ 6 │ 7 │ 131.55 │ 1 │ USD │ +├────────────┼───────┼───────┼────────────────────────┼─────────────────────────────────────┼───────────────┼───────────────┼──────────┼──────────┼──────┼─────────┼────────────┼──────┼──────────┤ +│ 2019-12-10 │ DGX │ STOCK │ Healthcare │ Diagnostics & Research │ United States │ North America │ 104.94 │ 8 │ 1 │ 4 │ 839.52 │ 1 │ USD │ +├────────────┼───────┼───────┼────────────────────────┼─────────────────────────────────────┼───────────────┼───────────────┼──────────┼──────────┼──────┼─────────┼────────────┼──────┼──────────┤ +│ 2020-02-03 │ YUM │ STOCK │ Consumer Cyclical │ Restaurants │ United States │ North America │ 106.41 │ 10 │ 10 │ 2 │ 1064.10 │ 1 │ USD │ +├────────────┼───────┼───────┼────────────────────────┼─────────────────────────────────────┼───────────────┼───────────────┼──────────┼──────────┼──────┼─────────┼────────────┼──────┼──────────┤ +│ 2020-03-08 │ GOOGL │ STOCK │ Communication Services │ Internet Content & Information │ United States │ North America │ 1215.79 │ 3 │ 10 │ 2 │ 3647.37 │ 1 │ USD │ +├────────────┼───────┼───────┼────────────────────────┼─────────────────────────────────────┼───────────────┼───────────────┼──────────┼──────────┼──────┼─────────┼────────────┼──────┼──────────┤ +│ 2020-06-09 │ AMZN │ STOCK │ Technology │ Internet Retail │ United States │ North America │ 2600.86 │ 2 │ 200 │ 20 │ 5201.72 │ 1 │ USD │ +├────────────┼───────┼───────┼────────────────────────┼─────────────────────────────────────┼───────────────┼───────────────┼──────────┼──────────┼──────┼─────────┼────────────┼──────┼──────────┤ +│ 2020-12-12 │ AAPL │ STOCK │ Technology │ Consumer Electronics │ United States │ North America │ 121.78 │ 4 │ 10 │ 0 │ 487.12 │ 1 │ USD │ +├────────────┼───────┼───────┼────────────────────────┼─────────────────────────────────────┼───────────────┼───────────────┼──────────┼──────────┼──────┼─────────┼────────────┼──────┼──────────┤ +│ 2021-01-07 │ APTV │ STOCK │ Consumer Cyclical │ Auto Parts │ United States │ North America │ 144.80 │ 20 │ 10 │ 6 │ 2896.00 │ 1 │ USD │ +├────────────┼───────┼───────┼────────────────────────┼─────────────────────────────────────┼───────────────┼───────────────┼──────────┼──────────┼──────┼─────────┼────────────┼──────┼──────────┤ +│ 2021-05-06 │ ASML │ STOCK │ Technology │ Semiconductor Equipment & Materials │ Netherlands │ Europe │ 644.34 │ 30 │ 10 │ 3 │ 19330.20 │ 1 │ USD │ +├────────────┼───────┼───────┼────────────────────────┼─────────────────────────────────────┼───────────────┼───────────────┼──────────┼──────────┼──────┼─────────┼────────────┼──────┼──────────┤ +│ 2021-12-28 │ NKE │ STOCK │ Consumer Cyclical │ Footwear & Accessories │ Germany │ Europe │ 166.42 │ 13 │ 20 │ 3 │ 2163.46 │ 1 │ USD │ +├────────────┼───────┼───────┼────────────────────────┼─────────────────────────────────────┼───────────────┼───────────────┼──────────┼──────────┼──────┼─────────┼────────────┼──────┼──────────┤ +│ 2022-02-02 │ BABA │ STOCK │ Consumer Cyclical │ Internet Retail │ China │ Asia │ 122.88 │ 30 │ 0 │ 1 │ 3686.40 │ 1 │ USD │ +├────────────┼───────┼───────┼────────────────────────┼─────────────────────────────────────┼───────────────┼───────────────┼──────────┼──────────┼──────┼─────────┼────────────┼──────┼──────────┤ +│ 2022-03-04 │ TSM │ STOCK │ Technology │ Semiconductors │ Taiwan │ Asia │ 105.06 │ 30 │ 0 │ 2 │ 3151.80 │ 1 │ USD │ +├────────────┼───────┼───────┼────────────────────────┼─────────────────────────────────────┼───────────────┼───────────────┼──────────┼──────────┼──────┼─────────┼────────────┼──────┼──────────┤ +│ 2022-04-12 │ DGX │ STOCK │ Healthcare │ Diagnostics & Research │ United States │ North America │ 137.27 │ 10 │ 30 │ 1 │ 1372.70 │ 1 │ USD │ +├────────────┼───────┼───────┼────────────────────────┼─────────────────────────────────────┼───────────────┼───────────────┼──────────┼──────────┼──────┼─────────┼────────────┼──────┼──────────┤ +│ 2022-05-02 │ YUM │ STOCK │ Consumer Cyclical │ Restaurants │ United States │ North America │ 115.76 │ 11 │ 40 │ 0 │ 1273.36 │ 1 │ USD │ +└────────────┴───────┴───────┴────────────────────────┴─────────────────────────────────────┴───────────────┴───────────────┴──────────┴──────────┴──────┴─────────┴────────────┴──────┴──────────┘ +``` +--- diff --git a/website/content/terminal/reference/portfolio/maxdd.md b/website/content/terminal/reference/portfolio/maxdd.md new file mode 100644 index 000000000000..e0d3a447dd0e --- /dev/null +++ b/website/content/terminal/reference/portfolio/maxdd.md @@ -0,0 +1,33 @@ +--- +title: maxdd +description: This page provides a detailed guideline on how to use 'maxdd' command + in Python for managing portfolio. It allows users to show maximum portfolio drawdown + and it operates without parameters. +keywords: +- maxdd +- portfolio +- drawdown +- usage +- no parameters +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Show portfolio maximum drawdown + +### Usage + +```python +maxdd +``` + +--- + +## Parameters + +This command has no parameters + + +--- diff --git a/website/content/terminal/reference/portfolio/metric.md b/website/content/terminal/reference/portfolio/metric.md new file mode 100644 index 000000000000..86e98d46badb --- /dev/null +++ b/website/content/terminal/reference/portfolio/metric.md @@ -0,0 +1,49 @@ +--- +title: metric +description: This page provides detailed instructions on how to display a chosen metric + for different periods. It discusses parameters such as volatility, sharpe, sortino, + etc. and how to set the risk-free rate for calculations. +keywords: +- metric +- risk free rate +- volatility +- sharpe ratio +- sortino ratio +- max drawdown +- R square +- skew +- kurtosis +- gain to pain +- tracker +- information ratio +- tail ratio +- common sense ratio +- jensens alpha +- calmar ratio +- kelly criterion +- payoff ratio +- profit factor +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Display metric of choice for different periods + +### Usage + +```python +metric [-m METRIC] [-r RISK_FREE_RATE] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| metric | Set metric of choice | True | True | volatility, sharpe, sortino, maxdrawdown, rsquare, skew, kurtosis, gaintopain, trackerr, information, tail, commonsense, jensens, calmar, kelly, payoff, profitfactor | +| risk_free_rate | Set risk free rate for calculations. | 0 | True | None | + +--- diff --git a/website/content/terminal/reference/portfolio/mret.md b/website/content/terminal/reference/portfolio/mret.md new file mode 100644 index 000000000000..17d7a50988ef --- /dev/null +++ b/website/content/terminal/reference/portfolio/mret.md @@ -0,0 +1,36 @@ +--- +title: mret +description: This page is about the mret tool that helps to calculate monthly returns. + It contains information about its usage, parameters, and various options. +keywords: +- mret +- monthly returns +- heatmap +- parameters +- usage +- periods +- choices +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Monthly returns + +### Usage + +```python +mret [-p PERIOD] [-s] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| period | Period to select start end of the year returns | all | True | 3y, 5y, 10y, all | +| show_vals | Show monthly returns on heatmap | False | True | None | + +--- diff --git a/website/content/terminal/reference/portfolio/om.md b/website/content/terminal/reference/portfolio/om.md new file mode 100644 index 000000000000..0c6e30433262 --- /dev/null +++ b/website/content/terminal/reference/portfolio/om.md @@ -0,0 +1,37 @@ +--- +title: om +description: A documentation page providing information about the om function that + calculates the omega ratio of a selected portfolio with customizable start and end + parameters. +keywords: +- omega ratio +- portfolio +- start parameter +- end parameter +- om function +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Provides omega ratio of the selected portfolio. + +### Usage + +```python +om [-s START] [-e END] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| start | Start of the omega ratio threshold | 0 | True | None | +| end | End of the omega ratio threshold | 1.5 | True | None | + +![image](https://user-images.githubusercontent.com/75195383/163531048-c8efc8f7-d2a2-40ba-acca-811c8b92b264.png) + +--- diff --git a/website/content/terminal/reference/portfolio/perf.md b/website/content/terminal/reference/portfolio/perf.md new file mode 100644 index 000000000000..b1fbb1cadd61 --- /dev/null +++ b/website/content/terminal/reference/portfolio/perf.md @@ -0,0 +1,141 @@ +--- +title: perf +description: The 'perf' function displays the performance metrics of both individual + trades and the total portfolio against a given benchmark. This data is crucial for + investors and traders to understand how their portfolio is performing compared to + a standard benchmark. +keywords: +- perf +- benchmark +- trade performance +- portfolio performance +- performance metrics +- investment tracking +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Shows performance of each trade and total performance of the portfolio versus the benchmark. + +### Usage + +```python +performance [-t] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| show_trades | Whether to show performance on all trades in comparison to the benchmark. | False | True | None | + + +--- + +## Examples + +```python +2022 May 12, 06:22 (🦋) /portfolio/ $ perf -t + Portfolio vs. Benchmark - Totals +┏━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━┳━━━━━━━━━━━┳━━━━━━━━━━━━┓ +┃ ┃ Portfolio ┃ Benchmark ┃ Difference ┃ +┡━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━╇━━━━━━━━━━━╇━━━━━━━━━━━━┩ +│ Total Investment │ 61331.99 │ 61331.99 │ 0.00e+00 │ +├──────────────────┼───────────┼───────────┼────────────┤ +│ Total Value │ 95969.52 │ 81940.19 │ 14029.33 │ +├──────────────────┼───────────┼───────────┼────────────┤ +│ Total % Return │ 0.56 │ 0.34 │ 0.23 │ +├──────────────────┼───────────┼───────────┼────────────┤ +│ Total Abs Return │ 34637.53 │ 20608.20 │ 14029.33 │ +└──────────────────┴───────────┴───────────┴────────────┘ + + Portfolio vs. Benchmark - Individual Trades +┏━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━┳━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━┓ +┃ Date ┃ Name ┃ Portfolio Value ┃ Portfolio % Return ┃ Benchmark Value ┃ % Benchmark Return ┃ Alpha ┃ +┡━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━╇━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━┩ +│ 2010-05-03 00:00:00 │ CASH │ 0.00e+00 │ 0.00e+00 │ 0.00e+00 │ 0.00e+00 │ 0.00e+00 │ +├─────────────────────┼───────┼─────────────────┼────────────────────┼─────────────────┼────────────────────┼──────────┤ +│ 2010-05-03 00:00:00 │ GOOGL │ 4544.10 │ 756.41% │ 2102.34 │ 296.22% │ 460.19% │ +├─────────────────────┼───────┼─────────────────┼────────────────────┼─────────────────┼────────────────────┼──────────┤ +│ 2010-07-06 00:00:00 │ AMZN │ 10537.20 │ 1814.81% │ 2563.26 │ 365.79% │ 1449.02% │ +├─────────────────────┼───────┼─────────────────┼────────────────────┼─────────────────┼────────────────────┼──────────┤ +│ 2011-08-06 00:00:00 │ AAPL │ 439.50 │ 1061.78% │ 157.50 │ 316.33% │ 745.44% │ +├─────────────────────┼───────┼─────────────────┼────────────────────┼─────────────────┼────────────────────┼──────────┤ +│ 2011-12-12 00:00:00 │ APTV │ 453.70 │ 403.55% │ 336.57 │ 273.56% │ 129.99% │ +├─────────────────────┼───────┼─────────────────┼────────────────────┼─────────────────┼────────────────────┼──────────┤ +│ 2012-02-03 00:00:00 │ ASML │ 3649.10 │ 781.02% │ 1407.84 │ 239.90% │ 541.12% │ +├─────────────────────┼───────┼─────────────────┼────────────────────┼─────────────────┼────────────────────┼──────────┤ +│ 2012-05-04 00:00:00 │ NKE │ 323.76 │ 286.12% │ 280.56 │ 234.60% │ 51.52% │ +├─────────────────────┼───────┼─────────────────┼────────────────────┼─────────────────┼────────────────────┼──────────┤ +│ 2012-08-04 00:00:00 │ TSM │ 4391.50 │ 516.78% │ 2341.66 │ 228.88% │ 287.90% │ +├─────────────────────┼───────┼─────────────────┼────────────────────┼─────────────────┼────────────────────┼──────────┤ +│ 2012-10-12 00:00:00 │ DGX │ 797.16 │ 109.59% │ 1212.76 │ 218.86% │ -109.27% │ +├─────────────────────┼───────┼─────────────────┼────────────────────┼─────────────────┼────────────────────┼──────────┤ +│ 2013-02-03 00:00:00 │ YUM │ 435.60 │ 136.84% │ 550.77 │ 199.46% │ -62.62% │ +├─────────────────────┼───────┼─────────────────┼────────────────────┼─────────────────┼────────────────────┼──────────┤ +│ 2013-03-04 00:00:00 │ GOOGL │ 2272.05 │ 453.15% │ 1205.05 │ 193.38% │ 259.77% │ +├─────────────────────┼───────┼─────────────────┼────────────────────┼─────────────────┼────────────────────┼──────────┤ +│ 2013-08-08 00:00:00 │ AMZN │ 2107.44 │ 612.60% │ 769.49 │ 160.19% │ 452.41% │ +├─────────────────────┼───────┼─────────────────┼────────────────────┼─────────────────┼────────────────────┼──────────┤ +│ 2013-10-09 00:00:00 │ AAPL │ 732.50 │ 742.92% │ 229.90 │ 164.56% │ 578.36% │ +├─────────────────────┼───────┼─────────────────┼────────────────────┼─────────────────┼────────────────────┼──────────┤ +│ 2014-02-03 00:00:00 │ APTV │ 453.70 │ 83.20% │ 618.99 │ 149.94% │ -66.74% │ +├─────────────────────┼───────┼─────────────────┼────────────────────┼─────────────────┼────────────────────┼──────────┤ +│ 2014-02-05 00:00:00 │ ASML │ 1563.90 │ 512.14% │ 634.71 │ 148.44% │ 363.70% │ +├─────────────────────┼───────┼─────────────────┼────────────────────┼─────────────────┼────────────────────┼──────────┤ +│ 2014-12-08 00:00:00 │ NKE │ 1079.20 │ 120.88% │ 1029.58 │ 110.72% │ 10.16% │ +├─────────────────────┼───────┼─────────────────┼────────────────────┼─────────────────┼────────────────────┼──────────┤ +│ 2015-02-02 00:00:00 │ BABA │ 2451.90 │ -9.32% │ 5772.66 │ 113.49% │ -122.81% │ +├─────────────────────┼───────┼─────────────────┼────────────────────┼─────────────────┼────────────────────┼──────────┤ +│ 2015-03-08 00:00:00 │ TSM │ 1756.60 │ 274.54% │ 967.87 │ 106.37% │ 168.17% │ +├─────────────────────┼───────┼─────────────────┼────────────────────┼─────────────────┼────────────────────┼──────────┤ +│ 2015-12-05 00:00:00 │ DGX │ 2790.06 │ 93.03% │ 2977.51 │ 106.00% │ -12.97% │ +├─────────────────────┼───────┼─────────────────┼────────────────────┼─────────────────┼────────────────────┼──────────┤ +│ 2016-02-06 00:00:00 │ YUM │ 217.80 │ 124.58% │ 225.69 │ 132.72% │ -8.14% │ +├─────────────────────┼───────┼─────────────────┼────────────────────┼─────────────────┼────────────────────┼──────────┤ +│ 2016-09-07 00:00:00 │ GOOGL │ 4544.10 │ 181.20% │ 3099.70 │ 91.82% │ 89.38% │ +├─────────────────────┼───────┼─────────────────┼────────────────────┼─────────────────┼────────────────────┼──────────┤ +│ 2017-01-10 00:00:00 │ AMZN │ 4214.88 │ 164.79% │ 2913.21 │ 83.01% │ 81.77% │ +├─────────────────────┼───────┼─────────────────┼────────────────────┼─────────────────┼────────────────────┼──────────┤ +│ 2017-05-10 00:00:00 │ AAPL │ 1465.00 │ 282.31% │ 661.37 │ 72.59% │ 209.71% │ +├─────────────────────┼───────┼─────────────────┼────────────────────┼─────────────────┼────────────────────┼──────────┤ +│ 2017-12-08 00:00:00 │ APTV │ 907.40 │ 6.48% │ 1317.77 │ 54.63% │ -48.15% │ +├─────────────────────┼───────┼─────────────────┼────────────────────┼─────────────────┼────────────────────┼──────────┤ +│ 2018-07-05 00:00:00 │ ASML │ 2606.50 │ 165.98% │ 1441.40 │ 47.09% │ 118.89% │ +├─────────────────────┼───────┼─────────────────┼────────────────────┼─────────────────┼────────────────────┼──────────┤ +│ 2018-09-03 00:00:00 │ NKE │ 323.76 │ 35.58% │ 331.89 │ 38.98% │ -3.40% │ +├─────────────────────┼───────┼─────────────────┼────────────────────┼─────────────────┼────────────────────┼──────────┤ +│ 2019-05-04 00:00:00 │ BABA │ 408.65 │ -56.58% │ 1284.84 │ 36.51% │ -93.09% │ +├─────────────────────┼───────┼─────────────────┼────────────────────┼─────────────────┼────────────────────┼──────────┤ +│ 2019-09-09 00:00:00 │ TSM │ 263.49 │ 100.30% │ 177.00 │ 34.55% │ 65.74% │ +├─────────────────────┼───────┼─────────────────┼────────────────────┼─────────────────┼────────────────────┼──────────┤ +│ 2019-12-10 00:00:00 │ DGX │ 1062.88 │ 26.61% │ 1069.02 │ 27.34% │ -0.73% │ +├─────────────────────┼───────┼─────────────────┼────────────────────┼─────────────────┼────────────────────┼──────────┤ +│ 2020-02-03 00:00:00 │ YUM │ 1089.00 │ 2.34% │ 1304.22 │ 22.57% │ -20.23% │ +├─────────────────────┼───────┼─────────────────┼────────────────────┼─────────────────┼────────────────────┼──────────┤ +│ 2020-03-08 00:00:00 │ GOOGL │ 6816.15 │ 86.88% │ 5324.47 │ 45.98% │ 40.90% │ +├─────────────────────┼───────┼─────────────────┼────────────────────┼─────────────────┼────────────────────┼──────────┤ +│ 2020-06-09 00:00:00 │ AMZN │ 4214.88 │ -18.97% │ 6436.07 │ 23.73% │ -42.70% │ +├─────────────────────┼───────┼─────────────────┼────────────────────┼─────────────────┼────────────────────┼──────────┤ +│ 2020-12-12 00:00:00 │ AAPL │ 586.00 │ 20.30% │ 512.33 │ 5.18% │ 15.12% │ +├─────────────────────┼───────┼─────────────────┼────────────────────┼─────────────────┼────────────────────┼──────────┤ +│ 2021-01-07 00:00:00 │ APTV │ 1814.80 │ -37.33% │ 2901.22 │ 0.18% │ -37.51% │ +├─────────────────────┼───────┼─────────────────┼────────────────────┼─────────────────┼────────────────────┼──────────┤ +│ 2021-05-06 00:00:00 │ ASML │ 15639.00 │ -19.10% │ 17643.93 │ -8.72% │ -10.37% │ +├─────────────────────┼───────┼─────────────────┼────────────────────┼─────────────────┼────────────────────┼──────────┤ +│ 2021-12-28 00:00:00 │ NKE │ 1402.96 │ -35.15% │ 1749.43 │ -19.14% │ -16.01% │ +├─────────────────────┼───────┼─────────────────┼────────────────────┼─────────────────┼────────────────────┼──────────┤ +│ 2022-02-02 00:00:00 │ BABA │ 2451.90 │ -33.49% │ 3141.73 │ -14.78% │ -18.71% │ +├─────────────────────┼───────┼─────────────────┼────────────────────┼─────────────────┼────────────────────┼──────────┤ +│ 2022-03-04 00:00:00 │ TSM │ 2634.90 │ -16.40% │ 2835.11 │ -10.05% │ -6.35% │ +├─────────────────────┼───────┼─────────────────┼────────────────────┼─────────────────┼────────────────────┼──────────┤ +│ 2022-04-12 00:00:00 │ DGX │ 1328.60 │ -3.21% │ 1216.75 │ -11.36% │ 8.15% │ +├─────────────────────┼───────┼─────────────────┼────────────────────┼─────────────────┼────────────────────┼──────────┤ +│ 2022-05-02 00:00:00 │ YUM │ 1197.90 │ -5.93% │ 1194.00 │ -6.23% │ 0.31% │ +└─────────────────────┴───────┴─────────────────┴────────────────────┴─────────────────┴────────────────────┴──────────┘ +``` +--- diff --git a/website/versioned_docs/version-v3/terminal/reference/portfolio/po/_category_.json b/website/content/terminal/reference/portfolio/po/_category_.json similarity index 100% rename from website/versioned_docs/version-v3/terminal/reference/portfolio/po/_category_.json rename to website/content/terminal/reference/portfolio/po/_category_.json diff --git a/website/content/terminal/reference/portfolio/po/blacklitterman.md b/website/content/terminal/reference/portfolio/po/blacklitterman.md new file mode 100644 index 000000000000..98393037ad57 --- /dev/null +++ b/website/content/terminal/reference/portfolio/po/blacklitterman.md @@ -0,0 +1,89 @@ +--- +title: blacklitterman +description: This article provides an overview of how to optimize your portfolio using + Black Litterman estimates. It includes a detailed guide on parameter usage, command + line options, and examples to get you up to speed with the utility. +keywords: +- Black Litterman +- portfolio optimization +- portfolio analysis +- investment strategies +- benchmarking +- investment objectives +- risk aversion +- financial data analysis +- financial modelling +- portfolio risk management +- investment risk +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Optimize portfolio using Black Litterman estimates + +### Usage + +```python +blacklitterman [-bm BENCHMARK] [-o {MinRisk,Utility,Sharpe,MaxRet}] [-pv P_VIEWS] [-qv Q_VIEWS] [-ra RISK_AVERSION] [-d DELTA] [-eq] [-op] [-vs SHORT_ALLOCATION] [--file FILE] [--download DOWNLOAD] [-mt METHOD] [-ct CATEGORIES] [-p PERIOD] [-s START_PERIOD] [-e END_PERIOD] [-lr] [--freq {d,w,m}] [-mn MAX_NAN] [-th THRESHOLD_VALUE] [-r RISK_FREE] [-v LONG_ALLOCATION] [--name NAME] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| benchmark | portfolio name from current portfolio list | None | True | None | +| objective | Objective function used to optimize the portfolio | Sharpe | True | MinRisk, Utility, Sharpe, MaxRet | +| p_views | matrix P of analyst views | None | True | None | +| q_views | matrix Q of analyst views | None | True | None | +| risk_aversion | Risk aversion parameter | 1 | True | None | +| delta | Risk aversion factor of Black Litterman model | None | True | None | +| equilibrium | If True excess returns are based on equilibrium market portfolio, if False excess returns are calculated as historical returns minus risk free rate. | True | True | None | +| optimize | If True Black Litterman estimates are used as inputs of mean variance model, if False returns equilibrium weights from Black Litterman model | True | True | None | +| short_allocation | Amount to allocate to portfolio in short positions | 0.0 | True | None | +| file | Upload an Excel file with views for Black Litterman model | | True | None | +| download | Create a template to design Black Litterman model views | | True | None | +| nan_fill_method | Method used to fill nan values in time series, by default time. Possible values are: 'linear': linear interpolation 'time': linear interpolation based on time index 'nearest': use nearest value to replace nan values 'zero': spline of zeroth order 'slinear': spline of first order 'quadratic': spline of second order 'cubic': spline of third order 'barycentric': builds a polynomial that pass for all points | time | True | linear, time, nearest, zero, slinear, quadratic, cubic, barycentric | +| categories | Show selected categories | ASSET_CLASS, COUNTRY, SECTOR, INDUSTRY | True | None | +| historic_period | Period to get yfinance data from. Possible frequency strings are: 'd': means days, for example '252d' means 252 days 'w': means weeks, for example '52w' means 52 weeks 'mo': means months, for example '12mo' means 12 months 'y': means years, for example '1y' means 1 year 'ytd': downloads data from beginning of year to today 'max': downloads all data available for each asset | 3y | True | 1d, 5d, 1mo, 3mo, 6mo, 1y, 2y, 5y, 10y, ytd, max | +| start_period | Start date to get yfinance data from. Must be in 'YYYY-MM-DD' format | | True | None | +| end_period | End date to get yfinance data from. Must be in 'YYYY-MM-DD' format | | True | None | +| log_returns | If use logarithmic or arithmetic returns to calculate returns | False | True | None | +| return_frequency | Frequency used to calculate returns. Possible values are: 'd': for daily returns 'w': for weekly returns 'm': for monthly returns | d | True | d, w, m | +| max_nan | Max percentage of nan values accepted per asset to be considered in the optimization process | 0.05 | True | None | +| threshold_value | Value used to replace outliers that are higher to threshold in absolute value | 0.3 | True | None | +| risk_free | Risk-free rate of borrowing/lending. The period of the risk-free rate must be annual | 0.02924 | True | None | +| long_allocation | Amount to allocate to portfolio | 1 | True | None | +| name | Save portfolio with personalized or default name | BL_0 | True | None | + + +--- + +## Examples + +```python +2022 Apr 26, 01:25 (🦋) /portfolio/po/ $ add AAPL,MSFT,JP,BA +2022 Apr 26, 01:26 (🦋) /portfolio/po/ $ maxsharpe + + [3 Years] Maximal return/risk ratio portfolio using volatility as risk measure + + Weights +┏━━━━━━┳━━━━━━━━━━┓ +┃ ┃ Value ┃ +┡━━━━━━╇━━━━━━━━━━┩ +│ AAPL │ 100.00 % │ +├──────┼──────────┤ +│ BA │ 0.00 % │ +├──────┼──────────┤ +│ JP │ 0.00 % │ +├──────┼──────────┤ +│ MSFT │ 0.00 % │ +└──────┴──────────┘ +Annual (by 252) expected return: 45.46% +Annual (by √252) volatility: 34.16% +Sharpe ratio: 1.3209 +``` +--- diff --git a/website/content/terminal/reference/portfolio/po/dividend.md b/website/content/terminal/reference/portfolio/po/dividend.md new file mode 100644 index 000000000000..c8dc5743b952 --- /dev/null +++ b/website/content/terminal/reference/portfolio/po/dividend.md @@ -0,0 +1,87 @@ +--- +title: dividend +description: The 'dividend' page offers detailed explanations on how to utilize dividend-related + functionalities for portfolio optimization, showcasing parameters such as risk measure, + nan-fill-method, historic period, and others. Each parameter is explained in detail + and comes with default settings, optional values, and choices to customize as per + the user's choice. +keywords: +- docusaurus +- dividend +- portfolio optimization +- risk measure +- nan-fill-method +- historic period +- parameters +- portfolio weights +- expected return +- volatility +- Sharpe ratio +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Returns a portfolio that is weighted based dividend yield. + +### Usage + +```python +dividend [-rm {MV,MAD,MSV,FLPM,SLPM,CVaR,EVaR,WR,ADD,UCI,CDaR,EDaR,MDD}] [-mt METHOD] [-p PERIOD] [-s START_PERIOD] [-e END_PERIOD] [-lr] [--freq {d,w,m}] [-mn MAX_NAN] [-th THRESHOLD_VALUE] [-r RISK_FREE] [-a SIGNIFICANCE_LEVEL] [-v LONG_ALLOCATION] [--name NAME] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| risk_measure | Risk measure used to optimize the portfolio. Possible values are: 'MV' : Variance 'MAD' : Mean Absolute Deviation 'MSV' : Semi Variance (Variance of negative returns) 'FLPM' : First Lower Partial Moment 'SLPM' : Second Lower Partial Moment 'CVaR' : Conditional Value at Risk 'EVaR' : Entropic Value at Risk 'WR' : Worst Realization 'ADD' : Average Drawdown of uncompounded returns 'UCI' : Ulcer Index of uncompounded returns 'CDaR' : Conditional Drawdown at Risk of uncompounded returns 'EDaR' : Entropic Drawdown at Risk of uncompounded returns 'MDD' : Maximum Drawdown of uncompounded returns | MV | True | MV, MAD, MSV, FLPM, SLPM, CVaR, EVaR, WR, ADD, UCI, CDaR, EDaR, MDD | +| nan_fill_method | Method used to fill nan values in time series, by default time. Possible values are: 'linear': linear interpolation 'time': linear interpolation based on time index 'nearest': use nearest value to replace nan values 'zero': spline of zeroth order 'slinear': spline of first order 'quadratic': spline of second order 'cubic': spline of third order 'barycentric': builds a polynomial that pass for all points | time | True | linear, time, nearest, zero, slinear, quadratic, cubic, barycentric | +| historic_period | Period to get yfinance data from. Possible frequency strings are: 'd': means days, for example '252d' means 252 days 'w': means weeks, for example '52w' means 52 weeks 'mo': means months, for example '12mo' means 12 months 'y': means years, for example '1y' means 1 year 'ytd': downloads data from beginning of year to today 'max': downloads all data available for each asset | 3y | True | 1d, 5d, 1mo, 3mo, 6mo, 1y, 2y, 5y, 10y, ytd, max | +| start_period | Start date to get yfinance data from. Must be in 'YYYY-MM-DD' format | | True | None | +| end_period | End date to get yfinance data from. Must be in 'YYYY-MM-DD' format | | True | None | +| log_returns | If use logarithmic or arithmetic returns to calculate returns | False | True | None | +| return_frequency | Frequency used to calculate returns. Possible values are: 'd': for daily returns 'w': for weekly returns 'm': for monthly returns | d | True | d, w, m | +| max_nan | Max percentage of nan values accepted per asset to be considered in the optimization process | 0.05 | True | None | +| threshold_value | Value used to replace outliers that are higher to threshold in absolute value | 0.3 | True | None | +| risk_free | Risk-free rate of borrowing/lending. The period of the risk-free rate must be annual | 0.02924 | True | None | +| significance_level | Significance level of CVaR, EVaR, CDaR and EDaR | 0.05 | True | None | +| long_allocation | Amount to allocate to portfolio | 1 | True | None | +| name | Save portfolio with personalized or default name | DIVIDEND_0 | True | None | + + +--- + +## Examples + +```python +2022 Apr 05, 14:55 (🦋) /portfolio/po/ $ dividend + + [3 Years] Weighted Portfolio based on dividendYield + + Weights +┏━━━━━━┳━━━━━━━━━┓ +┃ ┃ Value ┃ +┡━━━━━━╇━━━━━━━━━┩ +│ AAPL │ 8.48 % │ +├──────┼─────────┤ +│ AMZN │ 0.0 % │ +├──────┼─────────┤ +│ BA │ 0.0 % │ +├──────┼─────────┤ +│ FB │ 0.0 % │ +├──────┼─────────┤ +│ MSFT │ 13.58 % │ +├──────┼─────────┤ +│ T │ 77.92 % │ +├──────┼─────────┤ +│ TSLA │ 0.0 % │ +└──────┴─────────┘ + +Annual (by 252) expected return: 10.30% +Annual (by √252) volatility: 24.10% +Sharpe ratio: 0.4198 +``` +--- diff --git a/website/content/terminal/reference/portfolio/po/ef.md b/website/content/terminal/reference/portfolio/po/ef.md new file mode 100644 index 000000000000..5bd1eb6930cb --- /dev/null +++ b/website/content/terminal/reference/portfolio/po/ef.md @@ -0,0 +1,75 @@ +--- +title: ef +description: Detailed instructions on using the 'ef' function in portfolio optimization. + This function plots random portfolios based on their risk and returns, providing + visualization of the efficient frontier. It includes parameters for risk measures, + nan filling methods, financial dataset periods, return calculations, and outlier + handling. +keywords: +- ef function +- portfolio risk and return +- efficient frontier +- portfolio optimization +- risk measures +- random portfolios +- CVaR +- EVaR +- Maximum Drawdown +- Mean Absolute Deviation +- nan_fill_method +- financial dataset +- yfinance data +- risk-free rate +- logarithmic returns +- return frequency +- outlier threshold +- simulation parameters +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This function plots random portfolios based on their risk and returns and shows the efficient frontier. + +### Usage + +```python +ef [-vs SHORT_ALLOCATION] [-n AMOUNT_PORTFOLIOS] [-se RANDOM_SEED] [-t] [--no_plot] [-rm {MV,MAD,MSV,FLPM,SLPM,CVaR,EVaR,WR,ADD,UCI,CDaR,EDaR,MDD}] [-mt METHOD] [-p PERIOD] [-s START_PERIOD] [-e END_PERIOD] [-lr] [--freq {d,w,m}] [-mn MAX_NAN] [-th THRESHOLD_VALUE] [-r RISK_FREE] [-a SIGNIFICANCE_LEVEL] [-v LONG_ALLOCATION] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| short_allocation | Amount to allocate to portfolio in short positions | 0.0 | True | None | +| amount_portfolios | Number of portfolios to simulate | 100 | True | None | +| random_seed | Seed used to generate random portfolios | 123 | True | None | +| tangency | Adds the optimal line with the risk-free asset | False | True | None | +| plot_tickers | Whether or not to plot the tickers for the assets provided | True | True | None | +| risk_measure | Risk measure used to optimize the portfolio. Possible values are: 'MV' : Variance 'MAD' : Mean Absolute Deviation 'MSV' : Semi Variance (Variance of negative returns) 'FLPM' : First Lower Partial Moment 'SLPM' : Second Lower Partial Moment 'CVaR' : Conditional Value at Risk 'EVaR' : Entropic Value at Risk 'WR' : Worst Realization 'ADD' : Average Drawdown of uncompounded returns 'UCI' : Ulcer Index of uncompounded returns 'CDaR' : Conditional Drawdown at Risk of uncompounded returns 'EDaR' : Entropic Drawdown at Risk of uncompounded returns 'MDD' : Maximum Drawdown of uncompounded returns | MV | True | MV, MAD, MSV, FLPM, SLPM, CVaR, EVaR, WR, ADD, UCI, CDaR, EDaR, MDD | +| nan_fill_method | Method used to fill nan values in time series, by default time. Possible values are: 'linear': linear interpolation 'time': linear interpolation based on time index 'nearest': use nearest value to replace nan values 'zero': spline of zeroth order 'slinear': spline of first order 'quadratic': spline of second order 'cubic': spline of third order 'barycentric': builds a polynomial that pass for all points | time | True | linear, time, nearest, zero, slinear, quadratic, cubic, barycentric | +| historic_period | Period to get yfinance data from. Possible frequency strings are: 'd': means days, for example '252d' means 252 days 'w': means weeks, for example '52w' means 52 weeks 'mo': means months, for example '12mo' means 12 months 'y': means years, for example '1y' means 1 year 'ytd': downloads data from beginning of year to today 'max': downloads all data available for each asset | 3y | True | 1d, 5d, 1mo, 3mo, 6mo, 1y, 2y, 5y, 10y, ytd, max | +| start_period | Start date to get yfinance data from. Must be in 'YYYY-MM-DD' format | | True | None | +| end_period | End date to get yfinance data from. Must be in 'YYYY-MM-DD' format | | True | None | +| log_returns | If use logarithmic or arithmetic returns to calculate returns | False | True | None | +| return_frequency | Frequency used to calculate returns. Possible values are: 'd': for daily returns 'w': for weekly returns 'm': for monthly returns | d | True | d, w, m | +| max_nan | Max percentage of nan values accepted per asset to be considered in the optimization process | 0.05 | True | None | +| threshold_value | Value used to replace outliers that are higher to threshold in absolute value | 0.3 | True | None | +| risk_free | Risk-free rate of borrowing/lending. The period of the risk-free rate must be annual | 0.02924 | True | None | +| significance_level | Significance level of CVaR, EVaR, CDaR and EDaR | 0.05 | True | None | +| long_allocation | Amount to allocate to portfolio | 1 | True | None | + + +--- + +## Examples + +```python +2022 Apr 05, 15:03 (🦋) /portfolio/po/ $ ef +``` +![Frontier](https://user-images.githubusercontent.com/61527316/161860003-e8b8ae93-ce8c-4e06-bad2-59c100f09325.png) + +--- diff --git a/website/content/terminal/reference/portfolio/po/equal.md b/website/content/terminal/reference/portfolio/po/equal.md new file mode 100644 index 000000000000..e3b37fb8d268 --- /dev/null +++ b/website/content/terminal/reference/portfolio/po/equal.md @@ -0,0 +1,88 @@ +--- +title: equal +description: The page provides information about an equally weighted portfolio optimization + command 'equal'. It lists and explains the parameters for usage like risk measure, + nan fill method, return frequency, and more. The page is useful for individuals + looking for information about portfolio optimization and the usage of specific financial + indicators. +keywords: +- docusaurus +- equally weighted portfolio +- portfolio optimization +- risk measure +- nan fill method +- historic period +- log returns +- return frequency +- risk-free rate +- significance level +- allocation +- financial data analysis +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Returns an equally weighted portfolio + +### Usage + +```python +equal [-rm {MV,MAD,MSV,FLPM,SLPM,CVaR,EVaR,WR,ADD,UCI,CDaR,EDaR,MDD}] [-mt METHOD] [-p PERIOD] [-s START_PERIOD] [-e END_PERIOD] [-lr] [--freq {d,w,m}] [-mn MAX_NAN] [-th THRESHOLD_VALUE] [-r RISK_FREE] [-a SIGNIFICANCE_LEVEL] [-v LONG_ALLOCATION] [--name NAME] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| risk_measure | Risk measure used to optimize the portfolio. Possible values are: 'MV' : Variance 'MAD' : Mean Absolute Deviation 'MSV' : Semi Variance (Variance of negative returns) 'FLPM' : First Lower Partial Moment 'SLPM' : Second Lower Partial Moment 'CVaR' : Conditional Value at Risk 'EVaR' : Entropic Value at Risk 'WR' : Worst Realization 'ADD' : Average Drawdown of uncompounded returns 'UCI' : Ulcer Index of uncompounded returns 'CDaR' : Conditional Drawdown at Risk of uncompounded returns 'EDaR' : Entropic Drawdown at Risk of uncompounded returns 'MDD' : Maximum Drawdown of uncompounded returns | MV | True | MV, MAD, MSV, FLPM, SLPM, CVaR, EVaR, WR, ADD, UCI, CDaR, EDaR, MDD | +| nan_fill_method | Method used to fill nan values in time series, by default time. Possible values are: 'linear': linear interpolation 'time': linear interpolation based on time index 'nearest': use nearest value to replace nan values 'zero': spline of zeroth order 'slinear': spline of first order 'quadratic': spline of second order 'cubic': spline of third order 'barycentric': builds a polynomial that pass for all points | time | True | linear, time, nearest, zero, slinear, quadratic, cubic, barycentric | +| historic_period | Period to get yfinance data from. Possible frequency strings are: 'd': means days, for example '252d' means 252 days 'w': means weeks, for example '52w' means 52 weeks 'mo': means months, for example '12mo' means 12 months 'y': means years, for example '1y' means 1 year 'ytd': downloads data from beginning of year to today 'max': downloads all data available for each asset | 3y | True | 1d, 5d, 1mo, 3mo, 6mo, 1y, 2y, 5y, 10y, ytd, max | +| start_period | Start date to get yfinance data from. Must be in 'YYYY-MM-DD' format | | True | None | +| end_period | End date to get yfinance data from. Must be in 'YYYY-MM-DD' format | | True | None | +| log_returns | If use logarithmic or arithmetic returns to calculate returns | False | True | None | +| return_frequency | Frequency used to calculate returns. Possible values are: 'd': for daily returns 'w': for weekly returns 'm': for monthly returns | d | True | d, w, m | +| max_nan | Max percentage of nan values accepted per asset to be considered in the optimization process | 0.05 | True | None | +| threshold_value | Value used to replace outliers that are higher to threshold in absolute value | 0.3 | True | None | +| risk_free | Risk-free rate of borrowing/lending. The period of the risk-free rate must be annual | 0.02924 | True | None | +| significance_level | Significance level of CVaR, EVaR, CDaR and EDaR | 0.05 | True | None | +| long_allocation | Amount to allocate to portfolio | 1 | True | None | +| name | Save portfolio with personalized or default name | NAME_0 | True | None | + + +--- + +## Examples + +```python +2022 Apr 05, 14:52 (🦋) /portfolio/po/ $ equal + + [3 Years] Equally Weighted Portfolio + + Weights +┏━━━━━━┳━━━━━━━━━┓ +┃ ┃ Value ┃ +┡━━━━━━╇━━━━━━━━━┩ +│ AAPL │ 14.28 % │ +├──────┼─────────┤ +│ AMZN │ 14.28 % │ +├──────┼─────────┤ +│ BA │ 14.28 % │ +├──────┼─────────┤ +│ FB │ 14.28 % │ +├──────┼─────────┤ +│ MSFT │ 14.28 % │ +├──────┼─────────┤ +│ T │ 14.28 % │ +├──────┼─────────┤ +│ TSLA │ 14.28 % │ +└──────┴─────────┘ + +Annual (by 252) expected return: 35.70% +Annual (by √252) volatility: 29.50% +Sharpe ratio: 1.2041 +``` +--- diff --git a/website/content/terminal/reference/portfolio/po/file.md b/website/content/terminal/reference/portfolio/po/file.md new file mode 100644 index 000000000000..b0a39628a6b3 --- /dev/null +++ b/website/content/terminal/reference/portfolio/po/file.md @@ -0,0 +1,34 @@ +--- +title: file +description: This documentation page provides details about the 'file' parameter usage + in Python code. The page also includes default files and optional choices. +keywords: +- file parameter +- python code usage +- default files +- optional file choices +- OpenBB_Parameters_Template +- parameters .ini files +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Select parameter file to use + +### Usage + +```python +file -f FILE [FILE ...] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| file | Parameter file to be used | None | False | OpenBB_Parameters_Template_v1.0.0.xlsx, defaults.ini, dany.ini, james.ini, example.ini, dd.ini | + +--- diff --git a/website/content/terminal/reference/portfolio/po/herc.md b/website/content/terminal/reference/portfolio/po/herc.md new file mode 100644 index 000000000000..0c4e0bc7ff95 --- /dev/null +++ b/website/content/terminal/reference/portfolio/po/herc.md @@ -0,0 +1,99 @@ +--- +title: herc +description: The page contains details about using HERC (Hierarchical Equal Risk Contribution) + for building a portfolio. It covers its usage, parameters, and a clear step-by-step + example. +keywords: +- Hierarchical Equal Risk Contribution +- Portfolio +- HERC +- Risk Measurement +- SEO improvement +- Financial trading +- Financial portfolio +- Risk management +- Codependence +- Covariance +- Risk measure optimization +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Builds a hierarchical equal risk contribution portfolio + +### Usage + +```python +herc [-cd {pearson,spearman,abs_pearson,abs_spearman,distance,mutual_info,tail}] [-cv {hist,ewma1,ewma2,ledoit,oas,shrunk,gl,jlogo,fixed,spectral,shrink}] [-rm RISK-MEASURE] [-as CVAR_SIMULATIONS_LOSSES] [-b CVAR_SIGNIFICANCE] [-bs CVAR_SIMULATIONS_GAINS] [-lk LINKAGE] [-k AMOUNT_CLUSTERS] [-mk MAX_CLUSTERS] [-bi {KN,FD,SC,HGR}] [-at ALPHA_TAIL] [-lo LEAF_ORDER] [-de SMOOTHING_FACTOR_EWMA] [-mt METHOD] [-ct CATEGORIES] [-p PERIOD] [-s START_PERIOD] [-e END_PERIOD] [-lr] [--freq {d,w,m}] [-mn MAX_NAN] [-th THRESHOLD_VALUE] [-r RISK_FREE] [-a SIGNIFICANCE_LEVEL] [-v LONG_ALLOCATION] [--name NAME] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| co_dependence | The codependence or similarity matrix used to build the distance metric and clusters. Possible values are: 'pearson': pearson correlation matrix 'spearman': spearman correlation matrix 'abs_pearson': absolute value of pearson correlation matrix 'abs_spearman': absolute value of spearman correlation matrix 'distance': distance correlation matrix 'mutual_info': mutual information codependence matrix 'tail': tail index codependence matrix | pearson | True | pearson, spearman, abs_pearson, abs_spearman, distance, mutual_info, tail | +| covariance | Method used to estimate covariance matrix. Possible values are 'hist': historical method 'ewma1': exponential weighted moving average with adjust=True 'ewma2': exponential weighted moving average with adjust=False 'ledoit': Ledoit and Wolf shrinkage method 'oas': oracle shrinkage method 'shrunk': scikit-learn shrunk method 'gl': graphical lasso method 'jlogo': j-logo covariance 'fixed': takes average of eigenvalues above max Marchenko Pastour limit 'spectral': makes zero eigenvalues above max Marchenko Pastour limit 'shrink': Lopez de Prado's book shrinkage method | hist | True | hist, ewma1, ewma2, ledoit, oas, shrunk, gl, jlogo, fixed, spectral, shrink | +| risk_measure | Risk measure used to optimize the portfolio. Possible values are: 'MV' : Variance 'MAD' : Mean Absolute Deviation 'GMD' : Gini Mean Difference 'MSV' : Semi Variance (Variance of negative returns) 'FLPM' : First Lower Partial Moment 'SLPM' : Second Lower Partial Moment 'VaR' : Value at Risk 'CVaR' : Conditional Value at Risk 'TG' : Tail Gini 'EVaR' : Entropic Value at Risk 'WR' : Worst Realization 'RG' : Range 'CVRG' : CVaR Range 'TGRG' : Tail Gini Range 'ADD' : Average Drawdown of uncompounded returns 'UCI' : Ulcer Index of uncompounded returns 'DaR' : Drawdown at Risk of uncompounded returns 'CDaR' : Conditional Drawdown at Risk of uncompounded returns 'EDaR' : Entropic Drawdown at Risk of uncompounded returns 'MDD' : Maximum Drawdown of uncompounded returns 'ADD_Rel' : Average Drawdown of compounded returns 'UCI_Rel' : Ulcer Index of compounded returns 'DaR_Rel' : Drawdown at Risk of compounded returns 'CDaR_Rel' : Conditional Drawdown at Risk of compounded returns 'EDaR_Rel' : Entropic Drawdown at Risk of compounded returns 'MDD_Rel' : Maximum Drawdown of compounded returns | MV | True | MV, MAD, GMD, MSV, VaR, CVaR, TG, EVaR, RG, CVRG, TGRG, WR, FLPM, SLPM, MDD, ADD, DaR, CDaR, EDaR, UCI, MDD_Rel, ADD_Rel, DaR_Rel, CDaR_Rel, EDaR_Rel, UCI_Rel | +| cvar_simulations_losses | Number of CVaRs used to approximate Tail Gini of losses. The default is 100 | 100 | True | None | +| cvar_significance | Significance level of CVaR and Tail Gini of gains. If empty it duplicates alpha | None | True | None | +| cvar_simulations_gains | Number of CVaRs used to approximate Tail Gini of gains. If empty it duplicates a_sim value | None | True | None | +| linkage | Linkage method of hierarchical clustering | single | True | single, complete, average, weighted, centroid, median, ward, dbht | +| amount_clusters | Number of clusters specified in advance | None | True | None | +| max_clusters | Max number of clusters used by the two difference gap statistic to find the optimal number of clusters. If k is empty this value is used | 10 | True | None | +| amount_bins | Number of bins used to calculate the variation of information | KN | True | KN, FD, SC, HGR | +| alpha_tail | Significance level for lower tail dependence index, only used when when codependence value is 'tail' | 0.05 | True | None | +| leaf_order | Indicates if the cluster are ordered so that the distance between successive leaves is minimal | True | True | None | +| smoothing_factor_ewma | Smoothing factor for ewma estimators | 0.94 | True | None | +| nan_fill_method | Method used to fill nan values in time series, by default time. Possible values are: 'linear': linear interpolation 'time': linear interpolation based on time index 'nearest': use nearest value to replace nan values 'zero': spline of zeroth order 'slinear': spline of first order 'quadratic': spline of second order 'cubic': spline of third order 'barycentric': builds a polynomial that pass for all points | time | True | linear, time, nearest, zero, slinear, quadratic, cubic, barycentric | +| categories | Show selected categories | ASSET_CLASS, COUNTRY, SECTOR, INDUSTRY | True | None | +| historic_period | Period to get yfinance data from. Possible frequency strings are: 'd': means days, for example '252d' means 252 days 'w': means weeks, for example '52w' means 52 weeks 'mo': means months, for example '12mo' means 12 months 'y': means years, for example '1y' means 1 year 'ytd': downloads data from beginning of year to today 'max': downloads all data available for each asset | 3y | True | 1d, 5d, 1mo, 3mo, 6mo, 1y, 2y, 5y, 10y, ytd, max | +| start_period | Start date to get yfinance data from. Must be in 'YYYY-MM-DD' format | | True | None | +| end_period | End date to get yfinance data from. Must be in 'YYYY-MM-DD' format | | True | None | +| log_returns | If use logarithmic or arithmetic returns to calculate returns | False | True | None | +| return_frequency | Frequency used to calculate returns. Possible values are: 'd': for daily returns 'w': for weekly returns 'm': for monthly returns | d | True | d, w, m | +| max_nan | Max percentage of nan values accepted per asset to be considered in the optimization process | 0.05 | True | None | +| threshold_value | Value used to replace outliers that are higher to threshold in absolute value | 0.3 | True | None | +| risk_free | Risk-free rate of borrowing/lending. The period of the risk-free rate must be annual | 0.02924 | True | None | +| significance_level | Significance level of CVaR, EVaR, CDaR and EDaR | 0.05 | True | None | +| long_allocation | Amount to allocate to portfolio | 1 | True | None | +| name | Save portfolio with personalized or default name | HERC_0 | True | None | + + +--- + +## Examples + +```python +2022 Apr 05, 14:40 (🦋) /portfolio/po/ $ herc + + [3 Years] Hierarchical equal risk contribution portfolio using pearson +codependence,single linkage and volatility as risk measure + + Weights +┏━━━━━━┳━━━━━━━━━┓ +┃ ┃ Value ┃ +┡━━━━━━╇━━━━━━━━━┩ +│ AAPL │ 10.78 % │ +├──────┼─────────┤ +│ AMZN │ 12.64 % │ +├──────┼─────────┤ +│ BA │ 9.12 % │ +├──────┼─────────┤ +│ FB │ 8.08 % │ +├──────┼─────────┤ +│ MSFT │ 12.86 % │ +├──────┼─────────┤ +│ T │ 43.83 % │ +├──────┼─────────┤ +│ TSLA │ 2.66 % │ +└──────┴─────────┘ + +Annual (by 252) expected return: 18.09% +Annual (by √252) volatility: 24.19% +Sharpe ratio: 0.7401 +``` +--- diff --git a/website/content/terminal/reference/portfolio/po/hrp.md b/website/content/terminal/reference/portfolio/po/hrp.md new file mode 100644 index 000000000000..ced788db4bd2 --- /dev/null +++ b/website/content/terminal/reference/portfolio/po/hrp.md @@ -0,0 +1,101 @@ +--- +title: hrp +description: This technical documentation page provides comprehensive instructions + for using 'hrp', a Python command for creating a hierarchical risk parity portfolio. + It includes detailed information on usage, parameters, and examples for building + custom portfolios optimized for specific risk parameters. Tools like codependence + matrix, covariance matrix, CVaR, Tail Gini and hierarchical clustering methodologies + are explored in depth. +keywords: +- hrp +- hierarchical risk parity portfolio +- portfolio optimization +- risk management +- codependence matrix +- covariance matrix +- risk measure +- CVaR +- Tail Gini +- hierarchical clustering +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Builds a hierarchical risk parity portfolio + +### Usage + +```python +hrp [-cd {pearson,spearman,abs_pearson,abs_spearman,distance,mutual_info,tail}] [-cv {hist,ewma1,ewma2,ledoit,oas,shrunk,gl,jlogo,fixed,spectral,shrink}] [-rm RISK-MEASURE] [-as CVAR_SIMULATIONS_LOSSES] [-b CVAR_SIGNIFICANCE] [-bs CVAR_SIMULATIONS_GAINS] [-lk LINKAGE] [-k AMOUNT_CLUSTERS] [-mk MAX_CLUSTERS] [-bi {KN,FD,SC,HGR}] [-at ALPHA_TAIL] [-lo LEAF_ORDER] [-de SMOOTHING_FACTOR_EWMA] [-mt METHOD] [-ct CATEGORIES] [-p PERIOD] [-s START_PERIOD] [-e END_PERIOD] [-lr] [--freq {d,w,m}] [-mn MAX_NAN] [-th THRESHOLD_VALUE] [-r RISK_FREE] [-a SIGNIFICANCE_LEVEL] [-v LONG_ALLOCATION] [--name NAME] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| co_dependence | The codependence or similarity matrix used to build the distance metric and clusters. Possible values are: 'pearson': pearson correlation matrix 'spearman': spearman correlation matrix 'abs_pearson': absolute value of pearson correlation matrix 'abs_spearman': absolute value of spearman correlation matrix 'distance': distance correlation matrix 'mutual_info': mutual information codependence matrix 'tail': tail index codependence matrix | pearson | True | pearson, spearman, abs_pearson, abs_spearman, distance, mutual_info, tail | +| covariance | Method used to estimate covariance matrix. Possible values are 'hist': historical method 'ewma1': exponential weighted moving average with adjust=True 'ewma2': exponential weighted moving average with adjust=False 'ledoit': Ledoit and Wolf shrinkage method 'oas': oracle shrinkage method 'shrunk': scikit-learn shrunk method 'gl': graphical lasso method 'jlogo': j-logo covariance 'fixed': takes average of eigenvalues above max Marchenko Pastour limit 'spectral': makes zero eigenvalues above max Marchenko Pastour limit 'shrink': Lopez de Prado's book shrinkage method | hist | True | hist, ewma1, ewma2, ledoit, oas, shrunk, gl, jlogo, fixed, spectral, shrink | +| risk_measure | Risk measure used to optimize the portfolio. Possible values are: 'MV' : Variance 'MAD' : Mean Absolute Deviation 'GMD' : Gini Mean Difference 'MSV' : Semi Variance (Variance of negative returns) 'FLPM' : First Lower Partial Moment 'SLPM' : Second Lower Partial Moment 'VaR' : Value at Risk 'CVaR' : Conditional Value at Risk 'TG' : Tail Gini 'EVaR' : Entropic Value at Risk 'WR' : Worst Realization 'RG' : Range 'CVRG' : CVaR Range 'TGRG' : Tail Gini Range 'ADD' : Average Drawdown of uncompounded returns 'UCI' : Ulcer Index of uncompounded returns 'DaR' : Drawdown at Risk of uncompounded returns 'CDaR' : Conditional Drawdown at Risk of uncompounded returns 'EDaR' : Entropic Drawdown at Risk of uncompounded returns 'MDD' : Maximum Drawdown of uncompounded returns 'ADD_Rel' : Average Drawdown of compounded returns 'UCI_Rel' : Ulcer Index of compounded returns 'DaR_Rel' : Drawdown at Risk of compounded returns 'CDaR_Rel' : Conditional Drawdown at Risk of compounded returns 'EDaR_Rel' : Entropic Drawdown at Risk of compounded returns 'MDD_Rel' : Maximum Drawdown of compounded returns | MV | True | MV, MAD, GMD, MSV, VaR, CVaR, TG, EVaR, RG, CVRG, TGRG, WR, FLPM, SLPM, MDD, ADD, DaR, CDaR, EDaR, UCI, MDD_Rel, ADD_Rel, DaR_Rel, CDaR_Rel, EDaR_Rel, UCI_Rel | +| cvar_simulations_losses | Number of CVaRs used to approximate Tail Gini of losses. The default is 100 | 100 | True | None | +| cvar_significance | Significance level of CVaR and Tail Gini of gains. If empty it duplicates alpha | None | True | None | +| cvar_simulations_gains | Number of CVaRs used to approximate Tail Gini of gains. If empty it duplicates a_sim value | None | True | None | +| linkage | Linkage method of hierarchical clustering | single | True | single, complete, average, weighted, centroid, median, ward, dbht | +| amount_clusters | Number of clusters specified in advance | None | True | None | +| max_clusters | Max number of clusters used by the two difference gap statistic to find the optimal number of clusters. If k is empty this value is used | 10 | True | None | +| amount_bins | Number of bins used to calculate the variation of information | KN | True | KN, FD, SC, HGR | +| alpha_tail | Significance level for lower tail dependence index, only used when when codependence value is 'tail' | 0.05 | True | None | +| leaf_order | Indicates if the cluster are ordered so that the distance between successive leaves is minimal | True | True | None | +| smoothing_factor_ewma | Smoothing factor for ewma estimators | 0.94 | True | None | +| nan_fill_method | Method used to fill nan values in time series, by default time. Possible values are: 'linear': linear interpolation 'time': linear interpolation based on time index 'nearest': use nearest value to replace nan values 'zero': spline of zeroth order 'slinear': spline of first order 'quadratic': spline of second order 'cubic': spline of third order 'barycentric': builds a polynomial that pass for all points | time | True | linear, time, nearest, zero, slinear, quadratic, cubic, barycentric | +| categories | Show selected categories | ASSET_CLASS, COUNTRY, SECTOR, INDUSTRY | True | None | +| historic_period | Period to get yfinance data from. Possible frequency strings are: 'd': means days, for example '252d' means 252 days 'w': means weeks, for example '52w' means 52 weeks 'mo': means months, for example '12mo' means 12 months 'y': means years, for example '1y' means 1 year 'ytd': downloads data from beginning of year to today 'max': downloads all data available for each asset | 3y | True | 1d, 5d, 1mo, 3mo, 6mo, 1y, 2y, 5y, 10y, ytd, max | +| start_period | Start date to get yfinance data from. Must be in 'YYYY-MM-DD' format | | True | None | +| end_period | End date to get yfinance data from. Must be in 'YYYY-MM-DD' format | | True | None | +| log_returns | If use logarithmic or arithmetic returns to calculate returns | False | True | None | +| return_frequency | Frequency used to calculate returns. Possible values are: 'd': for daily returns 'w': for weekly returns 'm': for monthly returns | d | True | d, w, m | +| max_nan | Max percentage of nan values accepted per asset to be considered in the optimization process | 0.05 | True | None | +| threshold_value | Value used to replace outliers that are higher to threshold in absolute value | 0.3 | True | None | +| risk_free | Risk-free rate of borrowing/lending. The period of the risk-free rate must be annual | 0.02924 | True | None | +| significance_level | Significance level of CVaR, EVaR, CDaR and EDaR | 0.05 | True | None | +| long_allocation | Amount to allocate to portfolio | 1 | True | None | +| name | Save portfolio with personalized or default name | _HRP0 | True | None | + + +--- + +## Examples + +```python +2022 Apr 05, 14:20 (🦋) /portfolio/po/ $ hrp + + [3 Years] Hierarchical risk parity portfolio using pearson codependence, +single linkage and volatility as risk measure + + Weights +┏━━━━━━┳━━━━━━━━━┓ +┃ ┃ Value ┃ +┡━━━━━━╇━━━━━━━━━┩ +│ AAPL │ 13.74 % │ +├──────┼─────────┤ +│ AMZN │ 17.97 % │ +├──────┼─────────┤ +│ BA │ 5.74 % │ +├──────┼─────────┤ +│ FB │ 10.29 % │ +├──────┼─────────┤ +│ MSFT │ 18.28 % │ +├──────┼─────────┤ +│ T │ 27.57 % │ +├──────┼─────────┤ +│ TSLA │ 6.37 % │ +└──────┴─────────┘ + +Annual (by 252) expected return: 28.03% +Annual (by √252) volatility: 25.35% +Sharpe ratio: 1.0982 +``` +--- diff --git a/website/content/terminal/reference/portfolio/po/load.md b/website/content/terminal/reference/portfolio/po/load.md new file mode 100644 index 000000000000..422481f31aea --- /dev/null +++ b/website/content/terminal/reference/portfolio/po/load.md @@ -0,0 +1,42 @@ +--- +title: load +description: This page provides documentation on how to load a file of stocks tickers + with optional categories using Python. It contains information on the parameters + and file options that are available. +keywords: +- Load +- Stocks +- Tickers +- File +- Categories +- Parameters +- Allocation +- OpenBB_Parameters_Template_v1.0.0.xlsx +- defaults.ini +- dany.ini +- james.ini +- example.ini +- dd.ini +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Load file of stocks tickers with optional categories + +### Usage + +```python +load -f FILE [FILE ...] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| file | Allocation file to be used | None | False | OpenBB_Parameters_Template_v1.0.0.xlsx, defaults.ini, dany.ini, james.ini, example.ini, dd.ini | + +--- diff --git a/website/content/terminal/reference/portfolio/po/maxdecorr.md b/website/content/terminal/reference/portfolio/po/maxdecorr.md new file mode 100644 index 000000000000..70f30d4ab622 --- /dev/null +++ b/website/content/terminal/reference/portfolio/po/maxdecorr.md @@ -0,0 +1,88 @@ +--- +title: maxdecorr +description: The maxdecorr function offers users the ability to maximize their portfolio's + decorrelation using several covariance methods. It gives various options for portfolio + allocation, short and long positions, and data interpolation methods. The function + leverages yfinance data to produce optimized results. This is a tool for anyone + working with financial markets, portfolio management, or financial method development. +keywords: +- maxdecorr +- portfolio optimization +- decorrelation +- covariance methods +- data analysis +- portfolio allocation +- financial markets +- data interpolation +- yfinance data +- financial method +- short positions +- long positions +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Maximizes the portfolio's decorrelation + +### Usage + +```python +maxdecorr [-cv {hist,ewma1,ewma2,ledoit,oas,shrunk,gl,jlogo,fixed,spectral,shrink}] [-de SMOOTHING_FACTOR_EWMA] [-vs SHORT_ALLOCATION] [-mt METHOD] [-ct CATEGORIES] [-p PERIOD] [-s START_PERIOD] [-e END_PERIOD] [-lr] [--freq {d,w,m}] [-mn MAX_NAN] [-th THRESHOLD_VALUE] [-v LONG_ALLOCATION] [--name NAME] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| covariance | Method used to estimate covariance matrix. Possible values are 'hist': historical method 'ewma1': exponential weighted moving average with adjust=True 'ewma2': exponential weighted moving average with adjust=False 'ledoit': Ledoit and Wolf shrinkage method 'oas': oracle shrinkage method 'shrunk': scikit-learn shrunk method 'gl': graphical lasso method 'jlogo': j-logo covariance 'fixed': takes average of eigenvalues above max Marchenko Pastour limit 'spectral': makes zero eigenvalues above max Marchenko Pastour limit 'shrink': Lopez de Prado's book shrinkage method | hist | True | hist, ewma1, ewma2, ledoit, oas, shrunk, gl, jlogo, fixed, spectral, shrink | +| smoothing_factor_ewma | Smoothing factor for ewma estimators | 0.94 | True | None | +| short_allocation | Amount to allocate to portfolio in short positions | 0.0 | True | None | +| nan_fill_method | Method used to fill nan values in time series, by default time. Possible values are: 'linear': linear interpolation 'time': linear interpolation based on time index 'nearest': use nearest value to replace nan values 'zero': spline of zeroth order 'slinear': spline of first order 'quadratic': spline of second order 'cubic': spline of third order 'barycentric': builds a polynomial that pass for all points | time | True | linear, time, nearest, zero, slinear, quadratic, cubic, barycentric | +| categories | Show selected categories | ASSET_CLASS, COUNTRY, SECTOR, INDUSTRY | True | None | +| historic_period | Period to get yfinance data from. Possible frequency strings are: 'd': means days, for example '252d' means 252 days 'w': means weeks, for example '52w' means 52 weeks 'mo': means months, for example '12mo' means 12 months 'y': means years, for example '1y' means 1 year 'ytd': downloads data from beginning of year to today 'max': downloads all data available for each asset | 3y | True | 1d, 5d, 1mo, 3mo, 6mo, 1y, 2y, 5y, 10y, ytd, max | +| start_period | Start date to get yfinance data from. Must be in 'YYYY-MM-DD' format | | True | None | +| end_period | End date to get yfinance data from. Must be in 'YYYY-MM-DD' format | | True | None | +| log_returns | If use logarithmic or arithmetic returns to calculate returns | False | True | None | +| return_frequency | Frequency used to calculate returns. Possible values are: 'd': for daily returns 'w': for weekly returns 'm': for monthly returns | d | True | d, w, m | +| max_nan | Max percentage of nan values accepted per asset to be considered in the optimization process | 0.05 | True | None | +| threshold_value | Value used to replace outliers that are higher to threshold in absolute value | 0.3 | True | None | +| long_allocation | Amount to allocate to portfolio | 1 | True | None | +| name | Save portfolio with personalized or default name | MAXDECORR_0 | True | None | + + +--- + +## Examples + +```python +2022 Apr 05, 14:15 (🦋) /portfolio/po/ $ maxdecorr + + [3 Years] Display a maximal decorrelation portfolio + Weights +┏━━━━━━┳━━━━━━━━━┓ +┃ ┃ Value ┃ +┡━━━━━━╇━━━━━━━━━┩ +│ AAPL │ 0.0 % │ +├──────┼─────────┤ +│ AMZN │ 18.49 % │ +├──────┼─────────┤ +│ BA │ 17.29 % │ +├──────┼─────────┤ +│ FB │ 12.33 % │ +├──────┼─────────┤ +│ MSFT │ 0.0 % │ +├──────┼─────────┤ +│ T │ 27.37 % │ +├──────┼─────────┤ +│ TSLA │ 24.50 % │ +└──────┴─────────┘ + +Annual (by 252) expected return: 36.58% +Annual (by √252) volatility: 31.17% +Sharpe ratio: 1.1735 +``` +--- diff --git a/website/content/terminal/reference/portfolio/po/maxdiv.md b/website/content/terminal/reference/portfolio/po/maxdiv.md new file mode 100644 index 000000000000..aa0d08dbc8b3 --- /dev/null +++ b/website/content/terminal/reference/portfolio/po/maxdiv.md @@ -0,0 +1,86 @@ +--- +title: maxdiv +description: The maxdiv page is a comprehensive guide for maximizing portfolio diversification + with parameters like covariance matrix estimation method, smoothing factor for ewma + estimators, allocations, return methods, tolerances for nan values, and more. It + also includes examples of use. +keywords: +- maxdiv +- portfolio diversification +- covariance matrix +- smoothing factor +- short allocation +- nan fill method +- historic period +- log returns +- return frequency +- long allocation +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Maximizes the portfolio's diversification ratio + +### Usage + +```python +maxdiv [-cv {hist,ewma1,ewma2,ledoit,oas,shrunk,gl,jlogo,fixed,spectral,shrink}] [-de SMOOTHING_FACTOR_EWMA] [-vs SHORT_ALLOCATION] [-mt METHOD] [-ct CATEGORIES] [-p PERIOD] [-s START_PERIOD] [-e END_PERIOD] [-lr] [--freq {d,w,m}] [-mn MAX_NAN] [-th THRESHOLD_VALUE] [-v LONG_ALLOCATION] [--name NAME] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| covariance | Method used to estimate covariance matrix. Possible values are 'hist': historical method 'ewma1': exponential weighted moving average with adjust=True 'ewma2': exponential weighted moving average with adjust=False 'ledoit': Ledoit and Wolf shrinkage method 'oas': oracle shrinkage method 'shrunk': scikit-learn shrunk method 'gl': graphical lasso method 'jlogo': j-logo covariance 'fixed': takes average of eigenvalues above max Marchenko Pastour limit 'spectral': makes zero eigenvalues above max Marchenko Pastour limit 'shrink': Lopez de Prado's book shrinkage method | hist | True | hist, ewma1, ewma2, ledoit, oas, shrunk, gl, jlogo, fixed, spectral, shrink | +| smoothing_factor_ewma | Smoothing factor for ewma estimators | 0.94 | True | None | +| short_allocation | Amount to allocate to portfolio in short positions | 0.0 | True | None | +| nan_fill_method | Method used to fill nan values in time series, by default time. Possible values are: 'linear': linear interpolation 'time': linear interpolation based on time index 'nearest': use nearest value to replace nan values 'zero': spline of zeroth order 'slinear': spline of first order 'quadratic': spline of second order 'cubic': spline of third order 'barycentric': builds a polynomial that pass for all points | time | True | linear, time, nearest, zero, slinear, quadratic, cubic, barycentric | +| categories | Show selected categories | ASSET_CLASS, COUNTRY, SECTOR, INDUSTRY | True | None | +| historic_period | Period to get yfinance data from. Possible frequency strings are: 'd': means days, for example '252d' means 252 days 'w': means weeks, for example '52w' means 52 weeks 'mo': means months, for example '12mo' means 12 months 'y': means years, for example '1y' means 1 year 'ytd': downloads data from beginning of year to today 'max': downloads all data available for each asset | 3y | True | 1d, 5d, 1mo, 3mo, 6mo, 1y, 2y, 5y, 10y, ytd, max | +| start_period | Start date to get yfinance data from. Must be in 'YYYY-MM-DD' format | | True | None | +| end_period | End date to get yfinance data from. Must be in 'YYYY-MM-DD' format | | True | None | +| log_returns | If use logarithmic or arithmetic returns to calculate returns | False | True | None | +| return_frequency | Frequency used to calculate returns. Possible values are: 'd': for daily returns 'w': for weekly returns 'm': for monthly returns | d | True | d, w, m | +| max_nan | Max percentage of nan values accepted per asset to be considered in the optimization process | 0.05 | True | None | +| threshold_value | Value used to replace outliers that are higher to threshold in absolute value | 0.3 | True | None | +| long_allocation | Amount to allocate to portfolio | 1 | True | None | +| name | Save portfolio with personalized or default name | MAXDIV_0 | True | None | + + +--- + +## Examples + +```python +2022 Apr 05, 14:18 (🦋) /portfolio/po/ $ maxdiv + + [3 Years] Display a maximal diversification portfolio + + Weights +┏━━━━━━┳━━━━━━━━━┓ +┃ ┃ Value ┃ +┡━━━━━━╇━━━━━━━━━┩ +│ AAPL │ 0.0 % │ +├──────┼─────────┤ +│ AMZN │ 22.62 % │ +├──────┼─────────┤ +│ BA │ 11.53 % │ +├──────┼─────────┤ +│ FB │ 12.06 % │ +├──────┼─────────┤ +│ MSFT │ 0.0 % │ +├──────┼─────────┤ +│ T │ 40.01 % │ +├──────┼─────────┤ +│ TSLA │ 13.75 % │ +└──────┴─────────┘ + +Annual (by 252) expected return: 24.68% +Annual (by √252) volatility: 26.16% +Sharpe ratio: 0.9435 +``` +--- diff --git a/website/content/terminal/reference/portfolio/po/maxret.md b/website/content/terminal/reference/portfolio/po/maxret.md new file mode 100644 index 000000000000..3370fe2b9268 --- /dev/null +++ b/website/content/terminal/reference/portfolio/po/maxret.md @@ -0,0 +1,96 @@ +--- +title: maxret +description: The 'maxret' function is designed to maximize the return of a portfolio. + It allows users to set multiple parameters and constraints like target return and + risk, portfolio allocation, risk measure, and more. It supports various calculation + methods and can handle various types of data. +keywords: +- portfolio optimization +- return maximization +- risk management +- financial data analysis +- historical data +- return calculation +- covariance estimation +- shrinkage method +- risk-free rate +- significance level +- CVaR +- EVaR +- CDaR +- MDD +- Sharp ratio +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Maximizes the portfolio's return + +### Usage + +```python +maxret [-tr TARGET_RETURN] [-tk TARGET_RISK] [-m {hist,ewma1,ewma2}] [-cv {hist,ewma1,ewma2,ledoit,oas,shrunk,gl,jlogo,fixed,spectral,shrink}] [-de SMOOTHING_FACTOR_EWMA] [-vs SHORT_ALLOCATION] [-rm {MV,MAD,MSV,FLPM,SLPM,CVaR,EVaR,WR,ADD,UCI,CDaR,EDaR,MDD}] [-mt METHOD] [-ct CATEGORIES] [-p PERIOD] [-s START_PERIOD] [-e END_PERIOD] [-lr] [--freq {d,w,m}] [-mn MAX_NAN] [-th THRESHOLD_VALUE] [-r RISK_FREE] [-a SIGNIFICANCE_LEVEL] [-v LONG_ALLOCATION] [--name NAME] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| target_return | Constraint on minimum level of portfolio's return | -1 | True | None | +| target_risk | Constraint on maximum level of portfolio's risk | -1 | True | None | +| expected_return | Method used to estimate the expected return vector | hist | True | hist, ewma1, ewma2 | +| covariance | Method used to estimate covariance matrix. Possible values are 'hist': historical method 'ewma1': exponential weighted moving average with adjust=True 'ewma2': exponential weighted moving average with adjust=False 'ledoit': Ledoit and Wolf shrinkage method 'oas': oracle shrinkage method 'shrunk': scikit-learn shrunk method 'gl': graphical lasso method 'jlogo': j-logo covariance 'fixed': takes average of eigenvalues above max Marchenko Pastour limit 'spectral': makes zero eigenvalues above max Marchenko Pastour limit 'shrink': Lopez de Prado's book shrinkage method | hist | True | hist, ewma1, ewma2, ledoit, oas, shrunk, gl, jlogo, fixed, spectral, shrink | +| smoothing_factor_ewma | Smoothing factor for ewma estimators | 0.94 | True | None | +| short_allocation | Amount to allocate to portfolio in short positions | 0.0 | True | None | +| risk_measure | Risk measure used to optimize the portfolio. Possible values are: 'MV' : Variance 'MAD' : Mean Absolute Deviation 'MSV' : Semi Variance (Variance of negative returns) 'FLPM' : First Lower Partial Moment 'SLPM' : Second Lower Partial Moment 'CVaR' : Conditional Value at Risk 'EVaR' : Entropic Value at Risk 'WR' : Worst Realization 'ADD' : Average Drawdown of uncompounded returns 'UCI' : Ulcer Index of uncompounded returns 'CDaR' : Conditional Drawdown at Risk of uncompounded returns 'EDaR' : Entropic Drawdown at Risk of uncompounded returns 'MDD' : Maximum Drawdown of uncompounded returns | MV | True | MV, MAD, MSV, FLPM, SLPM, CVaR, EVaR, WR, ADD, UCI, CDaR, EDaR, MDD | +| nan_fill_method | Method used to fill nan values in time series, by default time. Possible values are: 'linear': linear interpolation 'time': linear interpolation based on time index 'nearest': use nearest value to replace nan values 'zero': spline of zeroth order 'slinear': spline of first order 'quadratic': spline of second order 'cubic': spline of third order 'barycentric': builds a polynomial that pass for all points | time | True | linear, time, nearest, zero, slinear, quadratic, cubic, barycentric | +| categories | Show selected categories | ASSET_CLASS, COUNTRY, SECTOR, INDUSTRY | True | None | +| historic_period | Period to get yfinance data from. Possible frequency strings are: 'd': means days, for example '252d' means 252 days 'w': means weeks, for example '52w' means 52 weeks 'mo': means months, for example '12mo' means 12 months 'y': means years, for example '1y' means 1 year 'ytd': downloads data from beginning of year to today 'max': downloads all data available for each asset | 3y | True | 1d, 5d, 1mo, 3mo, 6mo, 1y, 2y, 5y, 10y, ytd, max | +| start_period | Start date to get yfinance data from. Must be in 'YYYY-MM-DD' format | | True | None | +| end_period | End date to get yfinance data from. Must be in 'YYYY-MM-DD' format | | True | None | +| log_returns | If use logarithmic or arithmetic returns to calculate returns | False | True | None | +| return_frequency | Frequency used to calculate returns. Possible values are: 'd': for daily returns 'w': for weekly returns 'm': for monthly returns | d | True | d, w, m | +| max_nan | Max percentage of nan values accepted per asset to be considered in the optimization process | 0.05 | True | None | +| threshold_value | Value used to replace outliers that are higher to threshold in absolute value | 0.3 | True | None | +| risk_free | Risk-free rate of borrowing/lending. The period of the risk-free rate must be annual | 0.02924 | True | None | +| significance_level | Significance level of CVaR, EVaR, CDaR and EDaR | 0.05 | True | None | +| long_allocation | Amount to allocate to portfolio | 1 | True | None | +| name | Save portfolio with personalized or default name | MAXRET_0 | True | None | + + +--- + +## Examples + +```python +[3 Years] Maximal return portfolio using +volatility as risk measure + + Weights +┏━━━━━━┳━━━━━━━━━┓ +┃ ┃ Value ┃ +┡━━━━━━╇━━━━━━━━━┩ +│ AAPL │ 0.0 % │ +├──────┼─────────┤ +│ AMZN │ 0.0 % │ +├──────┼─────────┤ +│ BA │ 0.0 % │ +├──────┼─────────┤ +│ FB │ 0.0 % │ +├──────┼─────────┤ +│ MSFT │ 0.0 % │ +├──────┼─────────┤ +│ T │ 0.0 % │ +├──────┼─────────┤ +│ TSLA │ 100.0 % │ +└──────┴─────────┘ + +Annual (by 252) expected return: 124.85% +Annual (by √252) volatility: 68.44% +Sharpe ratio: 1.8215 +``` +--- diff --git a/website/content/terminal/reference/portfolio/po/maxsharpe.md b/website/content/terminal/reference/portfolio/po/maxsharpe.md new file mode 100644 index 000000000000..bcc4fa3c0727 --- /dev/null +++ b/website/content/terminal/reference/portfolio/po/maxsharpe.md @@ -0,0 +1,93 @@ +--- +title: maxsharpe +description: The maxsharpe page provides extensive information on maximizing the portfolio's + return/risk ratio. It provides usage and examples of parameters used in calculations + such as target_return, target_risk, expected_return, covariance, smoothing_factor_ewma, + short_allocation, and risk_measure. +keywords: +- maxsharpe +- return risk ratio +- portfolio optimization +- target return +- target risk +- covariance +- risk measure +- short allocation +- expected return +- smoothing factor +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Maximizes the portfolio's return/risk ratio + +### Usage + +```python +maxsharpe [-tr TARGET_RETURN] [-tk TARGET_RISK] [-m {hist,ewma1,ewma2}] [-cv {hist,ewma1,ewma2,ledoit,oas,shrunk,gl,jlogo,fixed,spectral,shrink}] [-de SMOOTHING_FACTOR_EWMA] [-vs SHORT_ALLOCATION] [-rm {MV,MAD,MSV,FLPM,SLPM,CVaR,EVaR,WR,ADD,UCI,CDaR,EDaR,MDD}] [-mt METHOD] [-ct CATEGORIES] [-p PERIOD] [-s START_PERIOD] [-e END_PERIOD] [-lr] [--freq {d,w,m}] [-mn MAX_NAN] [-th THRESHOLD_VALUE] [-r RISK_FREE] [-a SIGNIFICANCE_LEVEL] [-v LONG_ALLOCATION] [--name NAME] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| target_return | Constraint on minimum level of portfolio's return | -1 | True | None | +| target_risk | Constraint on maximum level of portfolio's risk | -1 | True | None | +| expected_return | Method used to estimate the expected return vector | hist | True | hist, ewma1, ewma2 | +| covariance | Method used to estimate covariance matrix. Possible values are 'hist': historical method 'ewma1': exponential weighted moving average with adjust=True 'ewma2': exponential weighted moving average with adjust=False 'ledoit': Ledoit and Wolf shrinkage method 'oas': oracle shrinkage method 'shrunk': scikit-learn shrunk method 'gl': graphical lasso method 'jlogo': j-logo covariance 'fixed': takes average of eigenvalues above max Marchenko Pastour limit 'spectral': makes zero eigenvalues above max Marchenko Pastour limit 'shrink': Lopez de Prado's book shrinkage method | hist | True | hist, ewma1, ewma2, ledoit, oas, shrunk, gl, jlogo, fixed, spectral, shrink | +| smoothing_factor_ewma | Smoothing factor for ewma estimators | 0.94 | True | None | +| short_allocation | Amount to allocate to portfolio in short positions | 0.0 | True | None | +| risk_measure | Risk measure used to optimize the portfolio. Possible values are: 'MV' : Variance 'MAD' : Mean Absolute Deviation 'MSV' : Semi Variance (Variance of negative returns) 'FLPM' : First Lower Partial Moment 'SLPM' : Second Lower Partial Moment 'CVaR' : Conditional Value at Risk 'EVaR' : Entropic Value at Risk 'WR' : Worst Realization 'ADD' : Average Drawdown of uncompounded returns 'UCI' : Ulcer Index of uncompounded returns 'CDaR' : Conditional Drawdown at Risk of uncompounded returns 'EDaR' : Entropic Drawdown at Risk of uncompounded returns 'MDD' : Maximum Drawdown of uncompounded returns | MV | True | MV, MAD, MSV, FLPM, SLPM, CVaR, EVaR, WR, ADD, UCI, CDaR, EDaR, MDD | +| nan_fill_method | Method used to fill nan values in time series, by default time. Possible values are: 'linear': linear interpolation 'time': linear interpolation based on time index 'nearest': use nearest value to replace nan values 'zero': spline of zeroth order 'slinear': spline of first order 'quadratic': spline of second order 'cubic': spline of third order 'barycentric': builds a polynomial that pass for all points | time | True | linear, time, nearest, zero, slinear, quadratic, cubic, barycentric | +| categories | Show selected categories | ASSET_CLASS, COUNTRY, SECTOR, INDUSTRY | True | None | +| historic_period | Period to get yfinance data from. Possible frequency strings are: 'd': means days, for example '252d' means 252 days 'w': means weeks, for example '52w' means 52 weeks 'mo': means months, for example '12mo' means 12 months 'y': means years, for example '1y' means 1 year 'ytd': downloads data from beginning of year to today 'max': downloads all data available for each asset | 3y | True | 1d, 5d, 1mo, 3mo, 6mo, 1y, 2y, 5y, 10y, ytd, max | +| start_period | Start date to get yfinance data from. Must be in 'YYYY-MM-DD' format | | True | None | +| end_period | End date to get yfinance data from. Must be in 'YYYY-MM-DD' format | | True | None | +| log_returns | If use logarithmic or arithmetic returns to calculate returns | False | True | None | +| return_frequency | Frequency used to calculate returns. Possible values are: 'd': for daily returns 'w': for weekly returns 'm': for monthly returns | d | True | d, w, m | +| max_nan | Max percentage of nan values accepted per asset to be considered in the optimization process | 0.05 | True | None | +| threshold_value | Value used to replace outliers that are higher to threshold in absolute value | 0.3 | True | None | +| risk_free | Risk-free rate of borrowing/lending. The period of the risk-free rate must be annual | 0.02924 | True | None | +| significance_level | Significance level of CVaR, EVaR, CDaR and EDaR | 0.05 | True | None | +| long_allocation | Amount to allocate to portfolio | 1 | True | None | +| name | Save portfolio with personalized or default name | MAXSHARPE_0 | True | None | + + +--- + +## Examples + +```python +2022 Apr 05, 13:52 (🦋) /portfolio/po/ $ maxsharpe --pie + + [3 Years] Display a maximal return/risk ratio portfolio using +volatility as risk measure + + Weights +┏━━━━━━┳━━━━━━━━━┓ +┃ ┃ Value ┃ +┡━━━━━━╇━━━━━━━━━┩ +│ AAPL │ 51.47 % │ +├──────┼─────────┤ +│ AMZN │ 0.0 % │ +├──────┼─────────┤ +│ BA │ 0.0 % │ +├──────┼─────────┤ +│ FB │ 0.0 % │ +├──────┼─────────┤ +│ MSFT │ 0.0 % │ +├──────┼─────────┤ +│ T │ 0.0 % │ +├──────┼─────────┤ +│ TSLA │ 48.52 % │ +└──────┴─────────┘ + +Annual (by 252) expected return: 86.15% +Annual (by √252) volatility: 44.22% +Sharpe ratio: 1.9441 +``` +--- diff --git a/website/content/terminal/reference/portfolio/po/maxutil.md b/website/content/terminal/reference/portfolio/po/maxutil.md new file mode 100644 index 000000000000..7ed6cac2dc82 --- /dev/null +++ b/website/content/terminal/reference/portfolio/po/maxutil.md @@ -0,0 +1,99 @@ +--- +title: maxutil +description: Maxutil is a powerful Python tool used for portfolio optimization. The + page provides extensive information about the usage, parameters, and examples of + maximizing a risk-averse utility function. Navigate through the specifics, from + expected return methods to defining your risk measures and risk aversion parameters. +keywords: +- maxutil +- risk averse utility function +- portfolio optimization +- financial tool +- financial software +- usage +- parameters +- examples +- expected return +- covariance +- risk measure +- risk aversion +- target return +- target risk +- risk-free rate +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Maximizes a risk averse utility function + +### Usage + +```python +maxutil [-ra RISK_AVERSION] [-tr TARGET_RETURN] [-tk TARGET_RISK] [-m {hist,ewma1,ewma2}] [-cv {hist,ewma1,ewma2,ledoit,oas,shrunk,gl,jlogo,fixed,spectral,shrink}] [-de SMOOTHING_FACTOR_EWMA] [-vs SHORT_ALLOCATION] [-rm {MV,MAD,MSV,FLPM,SLPM,CVaR,EVaR,WR,ADD,UCI,CDaR,EDaR,MDD}] [-mt METHOD] [-ct CATEGORIES] [-p PERIOD] [-s START_PERIOD] [-e END_PERIOD] [-lr] [--freq {d,w,m}] [-mn MAX_NAN] [-th THRESHOLD_VALUE] [-r RISK_FREE] [-a SIGNIFICANCE_LEVEL] [-v LONG_ALLOCATION] [--name NAME] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| risk_aversion | Risk aversion parameter | 1 | True | None | +| target_return | Constraint on minimum level of portfolio's return | -1 | True | None | +| target_risk | Constraint on maximum level of portfolio's risk | -1 | True | None | +| expected_return | Method used to estimate the expected return vector | hist | True | hist, ewma1, ewma2 | +| covariance | Method used to estimate covariance matrix. Possible values are 'hist': historical method 'ewma1': exponential weighted moving average with adjust=True 'ewma2': exponential weighted moving average with adjust=False 'ledoit': Ledoit and Wolf shrinkage method 'oas': oracle shrinkage method 'shrunk': scikit-learn shrunk method 'gl': graphical lasso method 'jlogo': j-logo covariance 'fixed': takes average of eigenvalues above max Marchenko Pastour limit 'spectral': makes zero eigenvalues above max Marchenko Pastour limit 'shrink': Lopez de Prado's book shrinkage method | hist | True | hist, ewma1, ewma2, ledoit, oas, shrunk, gl, jlogo, fixed, spectral, shrink | +| smoothing_factor_ewma | Smoothing factor for ewma estimators | 0.94 | True | None | +| short_allocation | Amount to allocate to portfolio in short positions | 0.0 | True | None | +| risk_measure | Risk measure used to optimize the portfolio. Possible values are: 'MV' : Variance 'MAD' : Mean Absolute Deviation 'MSV' : Semi Variance (Variance of negative returns) 'FLPM' : First Lower Partial Moment 'SLPM' : Second Lower Partial Moment 'CVaR' : Conditional Value at Risk 'EVaR' : Entropic Value at Risk 'WR' : Worst Realization 'ADD' : Average Drawdown of uncompounded returns 'UCI' : Ulcer Index of uncompounded returns 'CDaR' : Conditional Drawdown at Risk of uncompounded returns 'EDaR' : Entropic Drawdown at Risk of uncompounded returns 'MDD' : Maximum Drawdown of uncompounded returns | MV | True | MV, MAD, MSV, FLPM, SLPM, CVaR, EVaR, WR, ADD, UCI, CDaR, EDaR, MDD | +| nan_fill_method | Method used to fill nan values in time series, by default time. Possible values are: 'linear': linear interpolation 'time': linear interpolation based on time index 'nearest': use nearest value to replace nan values 'zero': spline of zeroth order 'slinear': spline of first order 'quadratic': spline of second order 'cubic': spline of third order 'barycentric': builds a polynomial that pass for all points | time | True | linear, time, nearest, zero, slinear, quadratic, cubic, barycentric | +| categories | Show selected categories | ASSET_CLASS, COUNTRY, SECTOR, INDUSTRY | True | None | +| historic_period | Period to get yfinance data from. Possible frequency strings are: 'd': means days, for example '252d' means 252 days 'w': means weeks, for example '52w' means 52 weeks 'mo': means months, for example '12mo' means 12 months 'y': means years, for example '1y' means 1 year 'ytd': downloads data from beginning of year to today 'max': downloads all data available for each asset | 3y | True | 1d, 5d, 1mo, 3mo, 6mo, 1y, 2y, 5y, 10y, ytd, max | +| start_period | Start date to get yfinance data from. Must be in 'YYYY-MM-DD' format | | True | None | +| end_period | End date to get yfinance data from. Must be in 'YYYY-MM-DD' format | | True | None | +| log_returns | If use logarithmic or arithmetic returns to calculate returns | False | True | None | +| return_frequency | Frequency used to calculate returns. Possible values are: 'd': for daily returns 'w': for weekly returns 'm': for monthly returns | d | True | d, w, m | +| max_nan | Max percentage of nan values accepted per asset to be considered in the optimization process | 0.05 | True | None | +| threshold_value | Value used to replace outliers that are higher to threshold in absolute value | 0.3 | True | None | +| risk_free | Risk-free rate of borrowing/lending. The period of the risk-free rate must be annual | 0.02924 | True | None | +| significance_level | Significance level of CVaR, EVaR, CDaR and EDaR | 0.05 | True | None | +| long_allocation | Amount to allocate to portfolio | 1 | True | None | +| name | Save portfolio with personalized or default name | MAXUTIL_0 | True | None | + + +--- + +## Examples + +```python +2022 Apr 05, 13:21 (🦋) /portfolio/po/ $ maxutil + + [3 Years] Display a maximal risk averse utility function + portfolio using volatility as risk measure + + Weights +┏━━━━━━┳━━━━━━━━━┓ +┃ ┃ Value ┃ +┡━━━━━━╇━━━━━━━━━┩ +│ AAPL │ 0.0 % │ +├──────┼─────────┤ +│ AMZN │ 0.0 % │ +├──────┼─────────┤ +│ BA │ 0.0 % │ +├──────┼─────────┤ +│ FB │ 0.0 % │ +├──────┼─────────┤ +│ MSFT │ 0.0 % │ +├──────┼─────────┤ +│ T │ 0.0 % │ +├──────┼─────────┤ +│ TSLA │ 100.0 % │ +└──────┴─────────┘ + +Annual (by 252) expected return: 124.85% +Annual (by √252) volatility: 68.44% +Sharpe ratio: 1.8215 +``` +--- diff --git a/website/content/terminal/reference/portfolio/po/minrisk.md b/website/content/terminal/reference/portfolio/po/minrisk.md new file mode 100644 index 000000000000..ba3fb5a0c153 --- /dev/null +++ b/website/content/terminal/reference/portfolio/po/minrisk.md @@ -0,0 +1,90 @@ +--- +title: minrisk +description: The minrisk page offers detailed instructions and examples on minimizing + a financial portfolio's risk using various estimators, risk measures and allocation + strategies. It provides comprehensive guidelines for portfolio management and analytics. +keywords: +- portfolio risk minimization +- portfolio management +- risk measure +- financial portfolio optimization +- covariance estimation +- asset allocation +- portfolio analytics +- expected return estimation +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Minimizes portfolio's risk + +### Usage + +```python +minrisk [-tr TARGET_RETURN] [-tk TARGET_RISK] [-m {hist,ewma1,ewma2}] [-cv {hist,ewma1,ewma2,ledoit,oas,shrunk,gl,jlogo,fixed,spectral,shrink}] [-de SMOOTHING_FACTOR_EWMA] [-vs SHORT_ALLOCATION] [-rm {MV,MAD,MSV,FLPM,SLPM,CVaR,EVaR,WR,ADD,UCI,CDaR,EDaR,MDD}] [-mt METHOD] [-ct CATEGORIES] [-p PERIOD] [-s START_PERIOD] [-e END_PERIOD] [-lr] [--freq {d,w,m}] [-mn MAX_NAN] [-th THRESHOLD_VALUE] [-r RISK_FREE] [-a SIGNIFICANCE_LEVEL] [-v LONG_ALLOCATION] [--name NAME] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| target_return | Constraint on minimum level of portfolio's return | -1 | True | None | +| target_risk | Constraint on maximum level of portfolio's risk | -1 | True | None | +| expected_return | Method used to estimate expected returns vector | hist | True | hist, ewma1, ewma2 | +| covariance | Method used to estimate covariance matrix. Possible values are 'hist': historical method 'ewma1': exponential weighted moving average with adjust=True 'ewma2': exponential weighted moving average with adjust=False 'ledoit': Ledoit and Wolf shrinkage method 'oas': oracle shrinkage method 'shrunk': scikit-learn shrunk method 'gl': graphical lasso method 'jlogo': j-logo covariance 'fixed': takes average of eigenvalues above max Marchenko Pastour limit 'spectral': makes zero eigenvalues above max Marchenko Pastour limit 'shrink': Lopez de Prado's book shrinkage method | hist | True | hist, ewma1, ewma2, ledoit, oas, shrunk, gl, jlogo, fixed, spectral, shrink | +| smoothing_factor_ewma | Smoothing factor for ewma estimators | 0.94 | True | None | +| short_allocation | Amount to allocate to portfolio in short positions | 0.0 | True | None | +| risk_measure | Risk measure used to optimize the portfolio. Possible values are: 'MV' : Variance 'MAD' : Mean Absolute Deviation 'MSV' : Semi Variance (Variance of negative returns) 'FLPM' : First Lower Partial Moment 'SLPM' : Second Lower Partial Moment 'CVaR' : Conditional Value at Risk 'EVaR' : Entropic Value at Risk 'WR' : Worst Realization 'ADD' : Average Drawdown of uncompounded returns 'UCI' : Ulcer Index of uncompounded returns 'CDaR' : Conditional Drawdown at Risk of uncompounded returns 'EDaR' : Entropic Drawdown at Risk of uncompounded returns 'MDD' : Maximum Drawdown of uncompounded returns | MV | True | MV, MAD, MSV, FLPM, SLPM, CVaR, EVaR, WR, ADD, UCI, CDaR, EDaR, MDD | +| nan_fill_method | Method used to fill nan values in time series, by default time. Possible values are: 'linear': linear interpolation 'time': linear interpolation based on time index 'nearest': use nearest value to replace nan values 'zero': spline of zeroth order 'slinear': spline of first order 'quadratic': spline of second order 'cubic': spline of third order 'barycentric': builds a polynomial that pass for all points | time | True | linear, time, nearest, zero, slinear, quadratic, cubic, barycentric | +| categories | Show selected categories | ASSET_CLASS, COUNTRY, SECTOR, INDUSTRY | True | None | +| historic_period | Period to get yfinance data from. Possible frequency strings are: 'd': means days, for example '252d' means 252 days 'w': means weeks, for example '52w' means 52 weeks 'mo': means months, for example '12mo' means 12 months 'y': means years, for example '1y' means 1 year 'ytd': downloads data from beginning of year to today 'max': downloads all data available for each asset | 3y | True | 1d, 5d, 1mo, 3mo, 6mo, 1y, 2y, 5y, 10y, ytd, max | +| start_period | Start date to get yfinance data from. Must be in 'YYYY-MM-DD' format | | True | None | +| end_period | End date to get yfinance data from. Must be in 'YYYY-MM-DD' format | | True | None | +| log_returns | If use logarithmic or arithmetic returns to calculate returns | False | True | None | +| return_frequency | Frequency used to calculate returns. Possible values are: 'd': for daily returns 'w': for weekly returns 'm': for monthly returns | d | True | d, w, m | +| max_nan | Max percentage of nan values accepted per asset to be considered in the optimization process | 0.05 | True | None | +| threshold_value | Value used to replace outliers that are higher to threshold in absolute value | 0.3 | True | None | +| risk_free | Risk-free rate of borrowing/lending. The period of the risk-free rate must be annual | 0.02924 | True | None | +| significance_level | Significance level of CVaR, EVaR, CDaR and EDaR | 0.05 | True | None | +| long_allocation | Amount to allocate to portfolio | 1 | True | None | +| name | Save portfolio with personalized or default name | MINRISK_0 | True | None | + + +--- + +## Examples + +```python +2022 Apr 05, 13:45 (🦋) /portfolio/po/ $ minrisk + + [3 Years] Display a minimum risk portfolio using +volatility as risk measure + + Weights +┏━━━━━━┳━━━━━━━━━┓ +┃ ┃ Value ┃ +┡━━━━━━╇━━━━━━━━━┩ +│ AAPL │ 0.0 % │ +├──────┼─────────┤ +│ AMZN │ 35.21 % │ +├──────┼─────────┤ +│ BA │ 0.0 % │ +├──────┼─────────┤ +│ FB │ 0.0 % │ +├──────┼─────────┤ +│ MSFT │ 5.86 % │ +├──────┼─────────┤ +│ T │ 58.92 % │ +├──────┼─────────┤ +│ TSLA │ 0.0 % │ +└──────┴─────────┘ + +Annual (by 252) expected return: 11.77% +Annual (by √252) volatility: 22.03% +Sharpe ratio: 0.5256 +``` +--- diff --git a/website/content/terminal/reference/portfolio/po/mktcap.md b/website/content/terminal/reference/portfolio/po/mktcap.md new file mode 100644 index 000000000000..7428c9c20a91 --- /dev/null +++ b/website/content/terminal/reference/portfolio/po/mktcap.md @@ -0,0 +1,82 @@ +--- +title: mktcap +description: The mktcap page provides comprehensive usage, parameters and examples + for creating a market cap weighted portfolio. The page is very useful for investors + and financial analysts looking for systematic ways to allocate their investments + based on market cap measurements. +keywords: +- mktcap +- portfolio +- market cap +- weighted portfolio +- asset allocation +- risk measures +- investment strategy +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Returns a portfolio that is weighted based on Market Cap. + +### Usage + +```python +mktcap [-rm {MV,MAD,MSV,FLPM,SLPM,CVaR,EVaR,WR,ADD,UCI,CDaR,EDaR,MDD}] [-mt METHOD] [-p PERIOD] [-s START_PERIOD] [-e END_PERIOD] [-lr] [--freq {d,w,m}] [-mn MAX_NAN] [-th THRESHOLD_VALUE] [-r RISK_FREE] [-a SIGNIFICANCE_LEVEL] [-v LONG_ALLOCATION] [--name NAME] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| risk_measure | Risk measure used to optimize the portfolio. Possible values are: 'MV' : Variance 'MAD' : Mean Absolute Deviation 'MSV' : Semi Variance (Variance of negative returns) 'FLPM' : First Lower Partial Moment 'SLPM' : Second Lower Partial Moment 'CVaR' : Conditional Value at Risk 'EVaR' : Entropic Value at Risk 'WR' : Worst Realization 'ADD' : Average Drawdown of uncompounded returns 'UCI' : Ulcer Index of uncompounded returns 'CDaR' : Conditional Drawdown at Risk of uncompounded returns 'EDaR' : Entropic Drawdown at Risk of uncompounded returns 'MDD' : Maximum Drawdown of uncompounded returns | MV | True | MV, MAD, MSV, FLPM, SLPM, CVaR, EVaR, WR, ADD, UCI, CDaR, EDaR, MDD | +| nan_fill_method | Method used to fill nan values in time series, by default time. Possible values are: 'linear': linear interpolation 'time': linear interpolation based on time index 'nearest': use nearest value to replace nan values 'zero': spline of zeroth order 'slinear': spline of first order 'quadratic': spline of second order 'cubic': spline of third order 'barycentric': builds a polynomial that pass for all points | time | True | linear, time, nearest, zero, slinear, quadratic, cubic, barycentric | +| historic_period | Period to get yfinance data from. Possible frequency strings are: 'd': means days, for example '252d' means 252 days 'w': means weeks, for example '52w' means 52 weeks 'mo': means months, for example '12mo' means 12 months 'y': means years, for example '1y' means 1 year 'ytd': downloads data from beginning of year to today 'max': downloads all data available for each asset | 3y | True | 1d, 5d, 1mo, 3mo, 6mo, 1y, 2y, 5y, 10y, ytd, max | +| start_period | Start date to get yfinance data from. Must be in 'YYYY-MM-DD' format | | True | None | +| end_period | End date to get yfinance data from. Must be in 'YYYY-MM-DD' format | | True | None | +| log_returns | If use logarithmic or arithmetic returns to calculate returns | False | True | None | +| return_frequency | Frequency used to calculate returns. Possible values are: 'd': for daily returns 'w': for weekly returns 'm': for monthly returns | d | True | d, w, m | +| max_nan | Max percentage of nan values accepted per asset to be considered in the optimization process | 0.05 | True | None | +| threshold_value | Value used to replace outliers that are higher to threshold in absolute value | 0.3 | True | None | +| risk_free | Risk-free rate of borrowing/lending. The period of the risk-free rate must be annual | 0.02924 | True | None | +| significance_level | Significance level of CVaR, EVaR, CDaR and EDaR | 0.05 | True | None | +| long_allocation | Amount to allocate to portfolio | 1 | True | None | +| name | Save portfolio with personalized or default name | MKTCAP_0 | True | None | + + +--- + +## Examples + +```python +2022 Apr 05, 14:53 (🦋) /portfolio/po/ $ mktcap + + [3 Years] Weighted Portfolio based on marketCap + + Weights +┏━━━━━━┳━━━━━━━━━┓ +┃ ┃ Value ┃ +┡━━━━━━╇━━━━━━━━━┩ +│ AAPL │ 32.03 % │ +├──────┼─────────┤ +│ AMZN │ 18.73 % │ +├──────┼─────────┤ +│ BA │ 1.21 % │ +├──────┼─────────┤ +│ FB │ 7.10 % │ +├──────┼─────────┤ +│ MSFT │ 26.20 % │ +├──────┼─────────┤ +│ T │ 1.92 % │ +├──────┼─────────┤ +│ TSLA │ 12.79 % │ +└──────┴─────────┘ + +Annual (by 252) expected return: 47.78% +Annual (by √252) volatility: 30.44% +Sharpe ratio: 1.5636 +``` +--- diff --git a/website/content/terminal/reference/portfolio/po/nco.md b/website/content/terminal/reference/portfolio/po/nco.md new file mode 100644 index 000000000000..f2cedf92e30e --- /dev/null +++ b/website/content/terminal/reference/portfolio/po/nco.md @@ -0,0 +1,100 @@ +--- +title: nco +description: Supplement to the nested cluster optimization (NCO) portfolio building + tool documentation. Offers comprehensive information on usage, parameters, and examples + of how to use the nco tool to optimize your investment portfolio. The topics covered + include codependence, covariance, risk measures, and cluster settings. +keywords: +- nested clustered optimization +- nco +- portfolio building +- portfolio optimization +- codependence +- covariance +- risk measure +- correlation matrix +- portfolio parameters +- cluster +- asset allocation +- investment strategy +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Builds a nested clustered optimization portfolio + +### Usage + +```python +nco [-cd {pearson,spearman,abs_pearson,abs_spearman,distance,mutual_info,tail}] [-cv {hist,ewma1,ewma2,ledoit,oas,shrunk,gl,jlogo,fixed,spectral,shrink}] [-o {MinRisk,Utility,Sharpe,ERC}] [-ra RISK_AVERSION] [-lk LINKAGE] [-k AMOUNT_CLUSTERS] [-mk MAX_CLUSTERS] [-bi {KN,FD,SC,HGR}] [-at ALPHA_TAIL] [-lo] [-de SMOOTHING_FACTOR_EWMA] [-rm {MV,MAD,MSV,FLPM,SLPM,CVaR,EVaR,WR,ADD,UCI,CDaR,EDaR,MDD}] [-mt METHOD] [-ct CATEGORIES] [-p PERIOD] [-s START_PERIOD] [-e END_PERIOD] [-lr] [--freq {d,w,m}] [-mn MAX_NAN] [-th THRESHOLD_VALUE] [-r RISK_FREE] [-a SIGNIFICANCE_LEVEL] [-v LONG_ALLOCATION] [--name NAME] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| co_dependence | The codependence or similarity matrix used to build the distance metric and clusters. Possible values are: 'pearson': pearson correlation matrix 'spearman': spearman correlation matrix 'abs_pearson': absolute value of pearson correlation matrix 'abs_spearman': absolute value of spearman correlation matrix 'distance': distance correlation matrix 'mutual_info': mutual information codependence matrix 'tail': tail index codependence matrix | pearson | True | pearson, spearman, abs_pearson, abs_spearman, distance, mutual_info, tail | +| covariance | Method used to estimate covariance matrix. Possible values are 'hist': historical method 'ewma1': exponential weighted moving average with adjust=True 'ewma2': exponential weighted moving average with adjust=False 'ledoit': Ledoit and Wolf shrinkage method 'oas': oracle shrinkage method 'shrunk': scikit-learn shrunk method 'gl': graphical lasso method 'jlogo': j-logo covariance 'fixed': takes average of eigenvalues above max Marchenko Pastour limit 'spectral': makes zero eigenvalues above max Marchenko Pastour limit 'shrink': Lopez de Prado's book shrinkage method | hist | True | hist, ewma1, ewma2, ledoit, oas, shrunk, gl, jlogo, fixed, spectral, shrink | +| objective | Objective function used to optimize the portfolio | MinRisk | True | MinRisk, Utility, Sharpe, ERC | +| risk_aversion | Risk aversion parameter | 1 | True | None | +| linkage | Linkage method of hierarchical clustering | single | True | single, complete, average, weighted, centroid, median, ward, dbht | +| amount_clusters | Number of clusters specified in advance | None | True | None | +| max_clusters | Max number of clusters used by the two difference gap statistic to find the optimal number of clusters. If k is empty this value is used | 10 | True | None | +| amount_bins | Number of bins used to calculate the variation of information | KN | True | KN, FD, SC, HGR | +| alpha_tail | Significance level for lower tail dependence index, only used when when codependence value is 'tail' | 0.05 | True | None | +| leaf_order | indicates if the cluster are ordered so that the distance between successive leaves is minimal | True | True | None | +| smoothing_factor_ewma | Smoothing factor for ewma estimators | 0.94 | True | None | +| risk_measure | Risk measure used to optimize the portfolio. Possible values are: 'MV' : Variance 'MAD' : Mean Absolute Deviation 'MSV' : Semi Variance (Variance of negative returns) 'FLPM' : First Lower Partial Moment 'SLPM' : Second Lower Partial Moment 'CVaR' : Conditional Value at Risk 'EVaR' : Entropic Value at Risk 'WR' : Worst Realization 'ADD' : Average Drawdown of uncompounded returns 'UCI' : Ulcer Index of uncompounded returns 'CDaR' : Conditional Drawdown at Risk of uncompounded returns 'EDaR' : Entropic Drawdown at Risk of uncompounded returns 'MDD' : Maximum Drawdown of uncompounded returns | MV | True | MV, MAD, MSV, FLPM, SLPM, CVaR, EVaR, WR, ADD, UCI, CDaR, EDaR, MDD | +| nan_fill_method | Method used to fill nan values in time series, by default time. Possible values are: 'linear': linear interpolation 'time': linear interpolation based on time index 'nearest': use nearest value to replace nan values 'zero': spline of zeroth order 'slinear': spline of first order 'quadratic': spline of second order 'cubic': spline of third order 'barycentric': builds a polynomial that pass for all points | time | True | linear, time, nearest, zero, slinear, quadratic, cubic, barycentric | +| categories | Show selected categories | ASSET_CLASS, COUNTRY, SECTOR, INDUSTRY | True | None | +| historic_period | Period to get yfinance data from. Possible frequency strings are: 'd': means days, for example '252d' means 252 days 'w': means weeks, for example '52w' means 52 weeks 'mo': means months, for example '12mo' means 12 months 'y': means years, for example '1y' means 1 year 'ytd': downloads data from beginning of year to today 'max': downloads all data available for each asset | 3y | True | 1d, 5d, 1mo, 3mo, 6mo, 1y, 2y, 5y, 10y, ytd, max | +| start_period | Start date to get yfinance data from. Must be in 'YYYY-MM-DD' format | | True | None | +| end_period | End date to get yfinance data from. Must be in 'YYYY-MM-DD' format | | True | None | +| log_returns | If use logarithmic or arithmetic returns to calculate returns | False | True | None | +| return_frequency | Frequency used to calculate returns. Possible values are: 'd': for daily returns 'w': for weekly returns 'm': for monthly returns | d | True | d, w, m | +| max_nan | Max percentage of nan values accepted per asset to be considered in the optimization process | 0.05 | True | None | +| threshold_value | Value used to replace outliers that are higher to threshold in absolute value | 0.3 | True | None | +| risk_free | Risk-free rate of borrowing/lending. The period of the risk-free rate must be annual | 0.02924 | True | None | +| significance_level | Significance level of CVaR, EVaR, CDaR and EDaR | 0.05 | True | None | +| long_allocation | Amount to allocate to portfolio | 1 | True | None | +| name | Save portfolio with personalized or default name | NCO_0 | True | None | + + +--- + +## Examples + +```python +2022 Apr 05, 14:34 (🦋) /portfolio/po/ $ nco + + [3 Years] Nested clustered optimization using pearson codependence, +single linkage and volatility as risk measure + + Weights +┏━━━━━━┳━━━━━━━━━┓ +┃ ┃ Value ┃ +┡━━━━━━╇━━━━━━━━━┩ +│ AAPL │ 7.17 % │ +├──────┼─────────┤ +│ AMZN │ 19.33 % │ +├──────┼─────────┤ +│ BA │ 0.0 % │ +├──────┼─────────┤ +│ FB │ 0.53 % │ +├──────┼─────────┤ +│ MSFT │ 16.81 % │ +├──────┼─────────┤ +│ T │ 56.14 % │ +├──────┼─────────┤ +│ TSLA │ 0.0 % │ +└──────┴─────────┘ + +Annual (by 252) expected return: 15.58% +Annual (by √252) volatility: 22.42% +Sharpe ratio: 0.6868 +``` +--- diff --git a/website/versioned_docs/version-v3/terminal/reference/portfolio/po/parameters/_category_.json b/website/content/terminal/reference/portfolio/po/parameters/_category_.json similarity index 100% rename from website/versioned_docs/version-v3/terminal/reference/portfolio/po/parameters/_category_.json rename to website/content/terminal/reference/portfolio/po/parameters/_category_.json diff --git a/website/content/terminal/reference/portfolio/po/parameters/arg.md b/website/content/terminal/reference/portfolio/po/parameters/arg.md new file mode 100644 index 000000000000..4299b25eef59 --- /dev/null +++ b/website/content/terminal/reference/portfolio/po/parameters/arg.md @@ -0,0 +1,35 @@ +--- +title: arg +description: This page explains how to set different values for available arguments + using the 'arg' command in Python. It covers usage, parameters and available choices. +keywords: +- arg command +- Python arguments +- setting argument values +- command-line arguments +- parameters +- choices +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Set a different value for one of the available arguments. + +### Usage + +```python +arg [-a ARGUMENT ARGUMENT] [-s] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| argument | Set a value for an argument | None | True | None | +| show | Show the available arguments, the options and a description. | False | True | None | + +--- diff --git a/website/content/terminal/reference/portfolio/po/parameters/load.md b/website/content/terminal/reference/portfolio/po/parameters/load.md new file mode 100644 index 000000000000..ad18ca6014e1 --- /dev/null +++ b/website/content/terminal/reference/portfolio/po/parameters/load.md @@ -0,0 +1,33 @@ +--- +title: load +description: This page provides information on how to load portfolio risk parameters + using either ini or xlsx files. It demonstrates the command usage and details about + the 'file' parameter. +keywords: +- load portfolio risk parameters +- ini files +- xlsx files +- parameter file usage +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Load portfolio risk parameters (ini or xlsx) + +### Usage + +```python +file -f FILE [FILE ...] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| file | Parameter file to be used | None | False | None | + +--- diff --git a/website/content/terminal/reference/portfolio/po/parameters/save.md b/website/content/terminal/reference/portfolio/po/parameters/save.md new file mode 100644 index 000000000000..96e3c4ec719e --- /dev/null +++ b/website/content/terminal/reference/portfolio/po/parameters/save.md @@ -0,0 +1,33 @@ +--- +title: save +description: This documentation page provides information on the 'save' command in + reference to portfolio risk parameters. Learn about how to properly save your parameters + using python. +keywords: +- save +- portfolio +- risk parameters +- file +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Save portfolio risk parameters (ini or xlsx) + +### Usage + +```python +save -f FILE +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| file | Filename to be saved | None | False | None | + +--- diff --git a/website/content/terminal/reference/portfolio/po/parameters/set.md b/website/content/terminal/reference/portfolio/po/parameters/set.md new file mode 100644 index 000000000000..ef02e7df2736 --- /dev/null +++ b/website/content/terminal/reference/portfolio/po/parameters/set.md @@ -0,0 +1,43 @@ +--- +title: set +description: This documentation page provides an understanding of the different portfolio + optimization models available. It explains how to use the set command in Python + to select a model from a list, including maxsharpe, minrisk, maxutil, and others. +keywords: +- portfolio optimization models +- set command +- maxsharpe +- minrisk +- maxutil +- maxret +- maxdiv +- maxdecorr +- ef +- riskparity +- relriskparity +- hrp +- herc +- nco +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Select one of the portfolio optimization models + +### Usage + +```python +set -m {maxsharpe,minrisk,maxutil,maxret,maxdiv,maxdecorr,ef,riskparity,relriskparity,hrp,herc,nco} +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| model | Frequency used to calculate returns | None | False | maxsharpe, minrisk, maxutil, maxret, maxdiv, maxdecorr, ef, riskparity, relriskparity, hrp, herc, nco | + +--- diff --git a/website/content/terminal/reference/portfolio/po/plot.md b/website/content/terminal/reference/portfolio/po/plot.md new file mode 100644 index 000000000000..909bdcf89d13 --- /dev/null +++ b/website/content/terminal/reference/portfolio/po/plot.md @@ -0,0 +1,71 @@ +--- +title: plot +description: The plot page allows users to select and plot charts for various portfolios, + using a range of parameters and offering several optional features. It includes + different types of charts such as pie, histogram, drawdown, and risk contribution + charts. Different risk measures can be optimized, and users can control various + other factors such as the calculation frequency, the max percentage of accepted + NaN values, and the risk-free rate. +keywords: +- plot +- charts +- portfolios +- risk measures +- drawdown chart +- risk contribution chart +- correlation matrix +- heatmap +- CVaR +- EVaR +- Maximum Drawdown +- risk-free rate +- significance level +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Plot selected charts for portfolios + +### Usage + +```python +plot [-pf PORTFOLIOS] [-pi] [-hi] [-dd] [-rc] [-he] [-rm {MV,MAD,MSV,FLPM,SLPM,CVaR,EVaR,WR,ADD,UCI,CDaR,EDaR,MDD}] [-mt METHOD] [-ct CATEGORIES] [-p PERIOD] [-s START_PERIOD] [-e END_PERIOD] [-lr] [--freq {d,w,m}] [-mn MAX_NAN] [-th THRESHOLD_VALUE] [-r RISK_FREE] [-a SIGNIFICANCE_LEVEL] [-v LONG_ALLOCATION] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| portfolios | Selected portfolios that will be plotted | | True | None | +| pie | Display a pie chart for weights | False | True | None | +| hist | Display a histogram with risk measures | False | True | None | +| dd | Display a drawdown chart with risk measures | False | True | None | +| rc_chart | Display a risk contribution chart for assets | False | True | None | +| heat | Display a heatmap of correlation matrix with dendrogram | False | True | None | +| risk_measure | Risk measure used to optimize the portfolio. Possible values are: 'MV' : Variance 'MAD' : Mean Absolute Deviation 'MSV' : Semi Variance (Variance of negative returns) 'FLPM' : First Lower Partial Moment 'SLPM' : Second Lower Partial Moment 'CVaR' : Conditional Value at Risk 'EVaR' : Entropic Value at Risk 'WR' : Worst Realization 'ADD' : Average Drawdown of uncompounded returns 'UCI' : Ulcer Index of uncompounded returns 'CDaR' : Conditional Drawdown at Risk of uncompounded returns 'EDaR' : Entropic Drawdown at Risk of uncompounded returns 'MDD' : Maximum Drawdown of uncompounded returns | MV | True | MV, MAD, MSV, FLPM, SLPM, CVaR, EVaR, WR, ADD, UCI, CDaR, EDaR, MDD | +| nan_fill_method | Method used to fill nan values in time series, by default time. Possible values are: 'linear': linear interpolation 'time': linear interpolation based on time index 'nearest': use nearest value to replace nan values 'zero': spline of zeroth order 'slinear': spline of first order 'quadratic': spline of second order 'cubic': spline of third order 'barycentric': builds a polynomial that pass for all points | time | True | linear, time, nearest, zero, slinear, quadratic, cubic, barycentric | +| categories | Show selected categories | ASSET_CLASS, COUNTRY, SECTOR, INDUSTRY | True | None | +| historic_period | Period to get yfinance data from. Possible frequency strings are: 'd': means days, for example '252d' means 252 days 'w': means weeks, for example '52w' means 52 weeks 'mo': means months, for example '12mo' means 12 months 'y': means years, for example '1y' means 1 year 'ytd': downloads data from beginning of year to today 'max': downloads all data available for each asset | 3y | True | 1d, 5d, 1mo, 3mo, 6mo, 1y, 2y, 5y, 10y, ytd, max | +| start_period | Start date to get yfinance data from. Must be in 'YYYY-MM-DD' format | | True | None | +| end_period | End date to get yfinance data from. Must be in 'YYYY-MM-DD' format | | True | None | +| log_returns | If use logarithmic or arithmetic returns to calculate returns | False | True | None | +| return_frequency | Frequency used to calculate returns. Possible values are: 'd': for daily returns 'w': for weekly returns 'm': for monthly returns | d | True | d, w, m | +| max_nan | Max percentage of nan values accepted per asset to be considered in the optimization process | 0.05 | True | None | +| threshold_value | Value used to replace outliers that are higher to threshold in absolute value | 0.3 | True | None | +| risk_free | Risk-free rate of borrowing/lending. The period of the risk-free rate must be annual | 0.02924 | True | None | +| significance_level | Significance level of CVaR, EVaR, CDaR and EDaR | 0.05 | True | None | +| long_allocation | Amount to allocate to portfolio | 1 | True | None | + + +--- + +## Examples + +```python +2022 Apr 26, 02:19 (🦋) /portfolio/po/ $ plot -pf maxsharpe_0 -pi -hi -dd -rc -he +``` +--- diff --git a/website/content/terminal/reference/portfolio/po/property.md b/website/content/terminal/reference/portfolio/po/property.md new file mode 100644 index 000000000000..e5c60211de93 --- /dev/null +++ b/website/content/terminal/reference/portfolio/po/property.md @@ -0,0 +1,93 @@ +--- +title: property +description: This documentation defines the usage, parameters, and examples for the + 'property' function. This function helps in creating a portfolio that is weighted + based on a selected property. It includes risk measure options, nan fill methods, + risk-free rates, significance levels, and more to optimize the portfolio. The description + helps in understanding the function's implementation for portfolio management. +keywords: +- portfolio optimization +- property weighting +- risk measures +- yfinance data +- log returns +- return frequency +- risk-free rate +- outliers +- CVaR +- EVaR +- CDaR +- EDaR +- nan fill method +- historic period +- significance level +- long allocation +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Returns a portfolio that is weighted based on selected property. + +### Usage + +```python +property -pr PROPERTY [-rm {MV,MAD,MSV,FLPM,SLPM,CVaR,EVaR,WR,ADD,UCI,CDaR,EDaR,MDD}] [-mt METHOD] [-p PERIOD] [-s START_PERIOD] [-e END_PERIOD] [-lr] [--freq {d,w,m}] [-mn MAX_NAN] [-th THRESHOLD_VALUE] [-r RISK_FREE] [-a SIGNIFICANCE_LEVEL] [-v LONG_ALLOCATION] [--name NAME] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| s_property | Property info to weight. Use one of yfinance info options. | None | False | previousClose, regularMarketOpen, twoHundredDayAverage, trailingAnnualDividendYield, payoutRatio, volume24Hr, regularMarketDayHigh, navPrice, averageDailyVolume10Day, totalAssets, regularMarketPreviousClose, fiftyDayAverage, trailingAnnualDividendRate, open, toCurrency, averageVolume10days, expireDate, yield, algorithm, dividendRate, exDividendDate, beta, circulatingSupply, regularMarketDayLow, priceHint, currency, trailingPE, regularMarketVolume, lastMarket, maxSupply, openInterest, marketCap, volumeAllCurrencies, strikePrice, averageVolume, priceToSalesTrailing12Months, dayLow, ask, ytdReturn, askSize, volume, fiftyTwoWeekHigh, forwardPE, fromCurrency, fiveYearAvgDividendYield, fiftyTwoWeekLow, bid, dividendYield, bidSize, dayHigh, annualHoldingsTurnover, enterpriseToRevenue, beta3Year, profitMargins, enterpriseToEbitda, 52WeekChange, morningStarRiskRating, forwardEps, revenueQuarterlyGrowth, sharesOutstanding, fundInceptionDate, annualReportExpenseRatio, bookValue, sharesShort, sharesPercentSharesOut, heldPercentInstitutions, netIncomeToCommon, trailingEps, lastDividendValue, SandP52WeekChange, priceToBook, heldPercentInsiders, shortRatio, sharesShortPreviousMonthDate, floatShares, enterpriseValue, fundFamily, threeYearAverageReturn, lastSplitFactor, legalType, lastDividendDate, morningStarOverallRating, earningsQuarterlyGrowth, pegRatio, lastCapGain, shortPercentOfFloat, sharesShortPriorMonth, impliedSharesOutstanding, fiveYearAverageReturn, regularMarketPrice | +| risk_measure | Risk measure used to optimize the portfolio. Possible values are: 'MV' : Variance 'MAD' : Mean Absolute Deviation 'MSV' : Semi Variance (Variance of negative returns) 'FLPM' : First Lower Partial Moment 'SLPM' : Second Lower Partial Moment 'CVaR' : Conditional Value at Risk 'EVaR' : Entropic Value at Risk 'WR' : Worst Realization 'ADD' : Average Drawdown of uncompounded returns 'UCI' : Ulcer Index of uncompounded returns 'CDaR' : Conditional Drawdown at Risk of uncompounded returns 'EDaR' : Entropic Drawdown at Risk of uncompounded returns 'MDD' : Maximum Drawdown of uncompounded returns | MV | True | MV, MAD, MSV, FLPM, SLPM, CVaR, EVaR, WR, ADD, UCI, CDaR, EDaR, MDD | +| nan_fill_method | Method used to fill nan values in time series, by default time. Possible values are: 'linear': linear interpolation 'time': linear interpolation based on time index 'nearest': use nearest value to replace nan values 'zero': spline of zeroth order 'slinear': spline of first order 'quadratic': spline of second order 'cubic': spline of third order 'barycentric': builds a polynomial that pass for all points | time | True | linear, time, nearest, zero, slinear, quadratic, cubic, barycentric | +| historic_period | Period to get yfinance data from. Possible frequency strings are: 'd': means days, for example '252d' means 252 days 'w': means weeks, for example '52w' means 52 weeks 'mo': means months, for example '12mo' means 12 months 'y': means years, for example '1y' means 1 year 'ytd': downloads data from beginning of year to today 'max': downloads all data available for each asset | 3y | True | 1d, 5d, 1mo, 3mo, 6mo, 1y, 2y, 5y, 10y, ytd, max | +| start_period | Start date to get yfinance data from. Must be in 'YYYY-MM-DD' format | | True | None | +| end_period | End date to get yfinance data from. Must be in 'YYYY-MM-DD' format | | True | None | +| log_returns | If use logarithmic or arithmetic returns to calculate returns | False | True | None | +| return_frequency | Frequency used to calculate returns. Possible values are: 'd': for daily returns 'w': for weekly returns 'm': for monthly returns | d | True | d, w, m | +| max_nan | Max percentage of nan values accepted per asset to be considered in the optimization process | 0.05 | True | None | +| threshold_value | Value used to replace outliers that are higher to threshold in absolute value | 0.3 | True | None | +| risk_free | Risk-free rate of borrowing/lending. The period of the risk-free rate must be annual | 0.02924 | True | None | +| significance_level | Significance level of CVaR, EVaR, CDaR and EDaR | 0.05 | True | None | +| long_allocation | Amount to allocate to portfolio | 1 | True | None | +| name | Save portfolio with personalized or default name | PROPERTY_0 | True | None | + + +--- + +## Examples + +```python +2022 Apr 05, 15:02 (🦋) /portfolio/po/ $ property -pr trailingEps + + [3 Years] Weighted Portfolio based on trailingEps + + Weights +┏━━━━━━┳━━━━━━━━━┓ +┃ ┃ Value ┃ +┡━━━━━━╇━━━━━━━━━┩ +│ AAPL │ 6.36 % │ +├──────┼─────────┤ +│ AMZN │ 68.58 % │ +├──────┼─────────┤ +│ BA │ -7.56 % │ +├──────┼─────────┤ +│ FB │ 14.57 % │ +├──────┼─────────┤ +│ MSFT │ 9.93 % │ +├──────┼─────────┤ +│ T │ 2.92 % │ +├──────┼─────────┤ +│ TSLA │ 5.18 % │ +└──────┴─────────┘ + +Annual (by 252) expected return: 33.74% +Annual (by √252) volatility: 30.25% +Sharpe ratio: 1.1094 +``` +--- diff --git a/website/content/terminal/reference/portfolio/po/relriskparity.md b/website/content/terminal/reference/portfolio/po/relriskparity.md new file mode 100644 index 000000000000..8005c3fc41da --- /dev/null +++ b/website/content/terminal/reference/portfolio/po/relriskparity.md @@ -0,0 +1,85 @@ +--- +title: relriskparity +description: This page provides a detailed guide on how to build a relaxed risk parity + portfolio using the least squares approach. It includes usage instructions, parameters, + and examples. +keywords: +- risk parity portfolio +- least squares approach +- portfolio optimization +- risk management +- investment strategies +- asset allocation +- yfinance data +- time series +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Build a relaxed risk parity portfolio based on least squares approach + +### Usage + +```python +relriskparity [-ve VERSION] [-rc RISK_CONTRIBUTION] [-pf PENAL_FACTOR] [-tr TARGET_RETURN] [-de SMOOTHING_FACTOR_EWMA] [-mt METHOD] [-ct CATEGORIES] [-p PERIOD] [-s START_PERIOD] [-e END_PERIOD] [-lr] [--freq {d,w,m}] [-mn MAX_NAN] [-th THRESHOLD_VALUE] [-v LONG_ALLOCATION] [--name NAME] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| risk_parity_model | version of relaxed risk parity model: Possible values are: 'A': risk parity without regularization and penalization constraints 'B': with regularization constraint but without penalization constraint 'C': with regularization and penalization constraints | A | True | A, B, C | +| risk_contribution | Vector of risk contribution constraints | None | True | None | +| penal_factor | The penalization factor of penalization constraints. Only used with version 'C'. | 1 | True | None | +| target_return | Constraint on minimum level of portfolio's return | -1 | True | None | +| smoothing_factor_ewma | Smoothing factor for ewma estimators | 0.94 | True | None | +| nan_fill_method | Method used to fill nan values in time series, by default time. Possible values are: 'linear': linear interpolation 'time': linear interpolation based on time index 'nearest': use nearest value to replace nan values 'zero': spline of zeroth order 'slinear': spline of first order 'quadratic': spline of second order 'cubic': spline of third order 'barycentric': builds a polynomial that pass for all points | time | True | linear, time, nearest, zero, slinear, quadratic, cubic, barycentric | +| categories | Show selected categories | ASSET_CLASS, COUNTRY, SECTOR, INDUSTRY | True | None | +| historic_period | Period to get yfinance data from. Possible frequency strings are: 'd': means days, for example '252d' means 252 days 'w': means weeks, for example '52w' means 52 weeks 'mo': means months, for example '12mo' means 12 months 'y': means years, for example '1y' means 1 year 'ytd': downloads data from beginning of year to today 'max': downloads all data available for each asset | 3y | True | 1d, 5d, 1mo, 3mo, 6mo, 1y, 2y, 5y, 10y, ytd, max | +| start_period | Start date to get yfinance data from. Must be in 'YYYY-MM-DD' format | | True | None | +| end_period | End date to get yfinance data from. Must be in 'YYYY-MM-DD' format | | True | None | +| log_returns | If use logarithmic or arithmetic returns to calculate returns | False | True | None | +| return_frequency | Frequency used to calculate returns. Possible values are: 'd': for daily returns 'w': for weekly returns 'm': for monthly returns | d | True | d, w, m | +| max_nan | Max percentage of nan values accepted per asset to be considered in the optimization process | 0.05 | True | None | +| threshold_value | Value used to replace outliers that are higher to threshold in absolute value | 0.3 | True | None | +| long_allocation | Amount to allocate to portfolio | 1 | True | None | +| name | Save portfolio with personalized or default name | RRP_0 | True | None | + + +--- + +## Examples + +```python +2022 Apr 05, 14:08 (🦋) /portfolio/po/ $ relriskparity + + [3 Years] Relaxed risk parity portfolio based on least squares approach + + Weights +┏━━━━━━┳━━━━━━━━━┓ +┃ ┃ Value ┃ +┡━━━━━━╇━━━━━━━━━┩ +│ AAPL │ 13.42 % │ +├──────┼─────────┤ +│ AMZN │ 16.51 % │ +├──────┼─────────┤ +│ BA │ 10.18 % │ +├──────┼─────────┤ +│ FB │ 12.83 % │ +├──────┼─────────┤ +│ MSFT │ 14.36 % │ +├──────┼─────────┤ +│ T │ 24.0 % │ +├──────┼─────────┤ +│ TSLA │ 8.68 % │ +└──────┴─────────┘ + +Annual (by 252) expected return: 28.99% +Annual (by √252) volatility: 26.60% +Sharpe ratio: 1.0899 +``` +--- diff --git a/website/content/terminal/reference/portfolio/po/riskparity.md b/website/content/terminal/reference/portfolio/po/riskparity.md new file mode 100644 index 000000000000..da04e2efdc6d --- /dev/null +++ b/website/content/terminal/reference/portfolio/po/riskparity.md @@ -0,0 +1,88 @@ +--- +title: riskparity +description: This docusaurus page provides detailed information on how to build a + risk parity portfolio using the risk budgeting approach. The user can make use of + many available parameters and conditions to customize the portfolio and its conditions + as per their requirements. +keywords: +- risk parity portfolio +- risk budgeting approach +- portfolio optimization +- portfolio parameters +- risk measures +- docusaurus documentation +- financial data analysis +- yfinance data +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Build a risk parity portfolio based on risk budgeting approach + +### Usage + +```python +riskparity [-rm RISK-MEASURE] [-rc RISK_CONTRIBUTION] [-tr TARGET_RETURN] [-de SMOOTHING_FACTOR_EWMA] [-mt METHOD] [-ct CATEGORIES] [-p PERIOD] [-s START_PERIOD] [-e END_PERIOD] [-lr] [--freq {d,w,m}] [-mn MAX_NAN] [-th THRESHOLD_VALUE] [-r RISK_FREE] [-a SIGNIFICANCE_LEVEL] [-v LONG_ALLOCATION] [--name NAME] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| risk_measure | Risk measure used to optimize the portfolio. Possible values are: 'MV' : Variance 'MAD' : Mean Absolute Deviation 'MSV' : Semi Variance (Variance of negative returns) 'FLPM' : First Lower Partial Moment 'SLPM' : Second Lower Partial Moment 'CVaR' : Conditional Value at Risk 'EVaR' : Entropic Value at Risk 'UCI' : Ulcer Index of uncompounded returns 'CDaR' : Conditional Drawdown at Risk of uncompounded returns 'EDaR' : Entropic Drawdown at Risk of uncompounded returns | MV | True | MV, MAD, MSV, FLPM, SLPM, CVaR, EVaR, CDaR, EDaR, UCI | +| risk_contribution | vector of risk contribution constraint | None | True | None | +| target_return | Constraint on minimum level of portfolio's return | -1 | True | None | +| smoothing_factor_ewma | Smoothing factor for ewma estimators | 0.94 | True | None | +| nan_fill_method | Method used to fill nan values in time series, by default time. Possible values are: 'linear': linear interpolation 'time': linear interpolation based on time index 'nearest': use nearest value to replace nan values 'zero': spline of zeroth order 'slinear': spline of first order 'quadratic': spline of second order 'cubic': spline of third order 'barycentric': builds a polynomial that pass for all points | time | True | linear, time, nearest, zero, slinear, quadratic, cubic, barycentric | +| categories | Show selected categories | ASSET_CLASS, COUNTRY, SECTOR, INDUSTRY | True | None | +| historic_period | Period to get yfinance data from. Possible frequency strings are: 'd': means days, for example '252d' means 252 days 'w': means weeks, for example '52w' means 52 weeks 'mo': means months, for example '12mo' means 12 months 'y': means years, for example '1y' means 1 year 'ytd': downloads data from beginning of year to today 'max': downloads all data available for each asset | 3y | True | 1d, 5d, 1mo, 3mo, 6mo, 1y, 2y, 5y, 10y, ytd, max | +| start_period | Start date to get yfinance data from. Must be in 'YYYY-MM-DD' format | | True | None | +| end_period | End date to get yfinance data from. Must be in 'YYYY-MM-DD' format | | True | None | +| log_returns | If use logarithmic or arithmetic returns to calculate returns | False | True | None | +| return_frequency | Frequency used to calculate returns. Possible values are: 'd': for daily returns 'w': for weekly returns 'm': for monthly returns | d | True | d, w, m | +| max_nan | Max percentage of nan values accepted per asset to be considered in the optimization process | 0.05 | True | None | +| threshold_value | Value used to replace outliers that are higher to threshold in absolute value | 0.3 | True | None | +| risk_free | Risk-free rate of borrowing/lending. The period of the risk-free rate must be annual | 0.02924 | True | None | +| significance_level | Significance level of CVaR, EVaR, CDaR and EDaR | 0.05 | True | None | +| long_allocation | Amount to allocate to portfolio | 1 | True | None | +| name | Save portfolio with personalized or default name | RP_0 | True | None | + + +--- + +## Examples + +```python +2022 Apr 05, 14:45 (🦋) /portfolio/po/ $ riskparity + + [3 Years] Risk parity portfolio based on risk budgeting approach +using volatility as risk measure + + Weights +┏━━━━━━┳━━━━━━━━━┓ +┃ ┃ Value ┃ +┡━━━━━━╇━━━━━━━━━┩ +│ AAPL │ 13.42 % │ +├──────┼─────────┤ +│ AMZN │ 16.51 % │ +├──────┼─────────┤ +│ BA │ 10.18 % │ +├──────┼─────────┤ +│ FB │ 12.83 % │ +├──────┼─────────┤ +│ MSFT │ 14.36 % │ +├──────┼─────────┤ +│ T │ 24.00 % │ +├──────┼─────────┤ +│ TSLA │ 8.68 % │ +└──────┴─────────┘ + +Annual (by 252) expected return: 28.99% +Annual (by √252) volatility: 26.60% +Sharpe ratio: 1.0829 +``` +--- diff --git a/website/content/terminal/reference/portfolio/po/rpf.md b/website/content/terminal/reference/portfolio/po/rpf.md new file mode 100644 index 000000000000..bfc34ef7b667 --- /dev/null +++ b/website/content/terminal/reference/portfolio/po/rpf.md @@ -0,0 +1,33 @@ +--- +title: rpf +description: This page provides information on the usage and parameters of the 'rpf' + function, a tool used for removing portfolios. +keywords: +- rpf +- portfolio management +- command line function +- programming documentation +- remove portfolios +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Remove one of the portfolios + +### Usage + +```python +rpf [-pf PORTFOLIOS] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| portfolios | portfolios to be removed from the saved portfolios | | True | None | + +--- diff --git a/website/content/terminal/reference/portfolio/po/show.md b/website/content/terminal/reference/portfolio/po/show.md new file mode 100644 index 000000000000..a369fc1df947 --- /dev/null +++ b/website/content/terminal/reference/portfolio/po/show.md @@ -0,0 +1,43 @@ +--- +title: show +description: The page provides command usage and parameters for the 'show' feature + which helps to display selected saved portfolios and its associated categories like + asset class, country, sector, industry with an option to allocate amount for long + term investments. +keywords: +- show +- saved portfolios +- usage +- parameters +- portfolios +- categories +- long allocation +- asset class +- country +- sector +- industry +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Show selected saved portfolios + +### Usage + +```python +show [-pf PORTFOLIOS] [-ct CATEGORIES] [-v LONG_ALLOCATION] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| portfolios | Show selected saved portfolios | | True | None | +| categories | Show selected categories | ASSET_CLASS, COUNTRY, SECTOR, INDUSTRY | True | None | +| long_allocation | Amount to allocate to portfolio | 1 | True | None | + +--- diff --git a/website/versioned_docs/version-v3/terminal/reference/portfolio/portfolio_analysis/_category_.json b/website/content/terminal/reference/portfolio/portfolio_analysis/_category_.json similarity index 100% rename from website/versioned_docs/version-v3/terminal/reference/portfolio/portfolio_analysis/_category_.json rename to website/content/terminal/reference/portfolio/portfolio_analysis/_category_.json diff --git a/website/content/terminal/reference/portfolio/portfolio_analysis/group.md b/website/content/terminal/reference/portfolio/portfolio_analysis/group.md new file mode 100644 index 000000000000..5843fa1053c8 --- /dev/null +++ b/website/content/terminal/reference/portfolio/portfolio_analysis/group.md @@ -0,0 +1,37 @@ +--- +title: group +description: This page documents the 'group' function in python for displaying a portfolio + group by a given column. This includes an optional allocation column addition to + the dataframe, with usage and parameter details provided. +keywords: +- Group Function +- Portfolio Group +- Allocation Column +- Marketing Parameters +- Dataframe Modification +- Group By Ticker +- Python Command +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Displays portfolio grouped by a given column + +### Usage + +```python +group [-g {}] [-a] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| group | Column to group by | Ticker | True | Index([], dtype='object') | +| allocation | Add allocation column in % to dataframe | False | True | None | + +--- diff --git a/website/content/terminal/reference/portfolio/portfolio_analysis/load.md b/website/content/terminal/reference/portfolio/portfolio_analysis/load.md new file mode 100644 index 000000000000..04eb8d52bb8f --- /dev/null +++ b/website/content/terminal/reference/portfolio/portfolio_analysis/load.md @@ -0,0 +1,46 @@ +--- +title: load +description: This documentation page provides information on the 'load' function used + to get portfolio from predefined csv/json/xlsx files. It includes usage instructions + as well as details on parameters like 'sector', 'country', 'last_price', 'show_nan' + and 'path'. +keywords: +- load function +- predefined portfolio files +- csv portfolio +- json portfolio +- xlsx portfolio +- sector parameter +- country parameter +- last_price parameter +- show_nan parameter +- path parameter +- portfolio retrieval +- portfolio documentation +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Function to get portfolio from predefined csv/json/xlsx file inside portfolios folder + +### Usage + +```python +load [-s] [-c] [--no_last_price] [--nan] [-p {}] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| sector | Add sector to dataframe | False | True | None | +| country | Add country to dataframe | False | True | None | +| last_price | Don't add last price from yfinance | True | True | None | +| show_nan | Show nan entries | False | True | None | +| path | Path to portfolio file | my_portfolio.csv | True | None | + +--- diff --git a/website/content/terminal/reference/portfolio/portfolio_analysis/view.md b/website/content/terminal/reference/portfolio/portfolio_analysis/view.md new file mode 100644 index 000000000000..bb417b19a685 --- /dev/null +++ b/website/content/terminal/reference/portfolio/portfolio_analysis/view.md @@ -0,0 +1,35 @@ +--- +title: view +description: Understand how to view available portfolios in various formats using + the 'view' command. This page provides a comprehensive guide on the parameters used. +keywords: +- portfolio view +- load portfolios +- csv portfolio +- json portfolio +- xlsx portfolio +- format command +- parameters guide +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Show available portfolios to load. + +### Usage + +```python +view [-format {csv,json,xlsx,all}] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| file_format | Format of portfolios to view. 'csv' will show all csv files available, etc. | all | True | csv, json, xlsx, all | + +--- diff --git a/website/content/terminal/reference/portfolio/rbeta.md b/website/content/terminal/reference/portfolio/rbeta.md new file mode 100644 index 000000000000..389dd4f06d49 --- /dev/null +++ b/website/content/terminal/reference/portfolio/rbeta.md @@ -0,0 +1,34 @@ +--- +title: rbeta +description: This page provides a detailed guide on the use of the 'rbeta' function + to show rolling beta of a portfolio versus a benchmark over different time periods. + It covers the available periods and how to use them. +keywords: +- rbeta +- rolling beta +- portfolio vs benchmark +- portfolio period +- rolling window +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Show rolling beta portfolio vs benchmark + +### Usage + +```python +rbeta [-p PERIOD] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| period | Period to apply rolling window | 1y | True | mtd, qtd, ytd, 3m, 6m, 1y, 3y, 5y, 10y, all | + +--- diff --git a/website/content/terminal/reference/portfolio/rsharpe.md b/website/content/terminal/reference/portfolio/rsharpe.md new file mode 100644 index 000000000000..27c3e73aa916 --- /dev/null +++ b/website/content/terminal/reference/portfolio/rsharpe.md @@ -0,0 +1,37 @@ +--- +title: rsharpe +description: The page provides comprehensive instructions on how to use the 'rsharpe' + function, which is a tool for comparing a portfolio against a benchmark. The function + allows for customization based on the desired period and risk free rate. +keywords: +- rsharpe +- rolling sharpe portfolio +- benchmarking +- risk free rate +- portfolio period +- portfolio calculation +- financial tools +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Show rolling sharpe portfolio vs benchmark + +### Usage + +```python +rsharpe [-p PERIOD] [-r RISK_FREE_RATE] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| period | Period to apply rolling window | 1y | True | mtd, qtd, ytd, 3m, 6m, 1y, 3y, 5y, 10y, all | +| risk_free_rate | Set risk free rate for calculations. | 0 | True | None | + +--- diff --git a/website/content/terminal/reference/portfolio/rvol.md b/website/content/terminal/reference/portfolio/rvol.md new file mode 100644 index 000000000000..429039cf9425 --- /dev/null +++ b/website/content/terminal/reference/portfolio/rvol.md @@ -0,0 +1,35 @@ +--- +title: rvol +description: Rvol page shows the rolling volatility portfolio versus benchmark. It + is primarily used to analyse the market's volatility over different periods. +keywords: +- rvol +- rolling volatility +- portfolio +- benchmark +- market analysis +- volatility analysis +- time period +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Show rolling volatility portfolio vs benchmark + +### Usage + +```python +rvol [-p PERIOD] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| period | Period to apply rolling window | 1y | True | mtd, qtd, ytd, 3m, 6m, 1y, 3y, 5y, 10y, all | + +--- diff --git a/website/content/terminal/reference/portfolio/show.md b/website/content/terminal/reference/portfolio/show.md new file mode 100644 index 000000000000..c411cc69513a --- /dev/null +++ b/website/content/terminal/reference/portfolio/show.md @@ -0,0 +1,141 @@ +--- +title: show +description: This documentation page describes the 'show' command, which presents + a table of transactions with no parameters required. It includes usage, parameters, + and examples. +keywords: +- Show command +- Transactions table +- No parameters +- Portfolio +- Instructions +- Python codes +- Sector +- Industry +- Country +- Region +- Price +- Quantity +- Fees +- Premium +- Investment +- Side +- Currency +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Show transactions table + +### Usage + +```python +show +``` + +--- + +## Parameters + +This command has no parameters + + + +--- + +## Examples + +```python +2022 May 13, 05:00 (🦋) /portfolio/ $ load Public_Equity_Orderbook.xlsx + +Portfolio: Public_Equity_Orderbook.xlsx +Risk Free Rate: 0.00% + +2022 May 13, 05:00 (🦋) /portfolio/ $ show +┏━━━━━━━━━━━━┳━━━━━━━┳━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━┳━━━━━━━━━━┳━━━━━━━━━━┳━━━━━━┳━━━━━━━━━┳━━━━━━━━━━━━┳━━━━━━┳━━━━━━━━━━┓ +┃ Date ┃ Name ┃ Type ┃ Sector ┃ Industry ┃ Country ┃ Region ┃ Price ┃ Quantity ┃ Fees ┃ Premium ┃ Investment ┃ Side ┃ Currency ┃ +┡━━━━━━━━━━━━╇━━━━━━━╇━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━╇━━━━━━━━━━╇━━━━━━━━━━╇━━━━━━╇━━━━━━━━━╇━━━━━━━━━━━━╇━━━━━━╇━━━━━━━━━━┩ +│ 2010-05-03 │ CASH │ CASH │ CASH │ CASH │ CASH │ Unknown │ 60850.00 │ 1 │ 0 │ 0 │ 60850.00 │ 1 │ USD │ +├────────────┼───────┼───────┼────────────────────────┼─────────────────────────────────────┼───────────────┼───────────────┼──────────┼──────────┼──────┼─────────┼────────────┼──────┼──────────┤ +│ 2010-05-03 │ GOOGL │ STOCK │ Communication Services │ Internet Content & Information │ United States │ North America │ 265.30 │ 2 │ 5 │ 6 │ 530.60 │ 1 │ USD │ +├────────────┼───────┼───────┼────────────────────────┼─────────────────────────────────────┼───────────────┼───────────────┼──────────┼──────────┼──────┼─────────┼────────────┼──────┼──────────┤ +│ 2010-07-06 │ AMZN │ STOCK │ Technology │ Internet Retail │ United States │ North America │ 110.06 │ 5 │ 3 │ 3 │ 550.30 │ 1 │ USD │ +├────────────┼───────┼───────┼────────────────────────┼─────────────────────────────────────┼───────────────┼───────────────┼──────────┼──────────┼──────┼─────────┼────────────┼──────┼──────────┤ +│ 2011-08-06 │ AAPL │ STOCK │ Technology │ Consumer Electronics │ United States │ North America │ 12.61 │ 3 │ 1 │ 0 │ 37.83 │ 1 │ USD │ +├────────────┼───────┼───────┼────────────────────────┼─────────────────────────────────────┼───────────────┼───────────────┼──────────┼──────────┼──────┼─────────┼────────────┼──────┼──────────┤ +│ 2011-12-12 │ APTV │ STOCK │ Consumer Cyclical │ Auto Parts │ United States │ North America │ 18.02 │ 5 │ 0 │ 2 │ 90.10 │ 1 │ USD │ +├────────────┼───────┼───────┼────────────────────────┼─────────────────────────────────────┼───────────────┼───────────────┼──────────┼──────────┼──────┼─────────┼────────────┼──────┼──────────┤ +│ 2012-02-03 │ ASML │ STOCK │ Technology │ Semiconductor Equipment & Materials │ Netherlands │ Europe │ 59.17 │ 7 │ 0 │ 4 │ 414.19 │ 1 │ USD │ +├────────────┼───────┼───────┼────────────────────────┼─────────────────────────────────────┼───────────────┼───────────────┼──────────┼──────────┼──────┼─────────┼────────────┼──────┼──────────┤ +│ 2012-05-04 │ NKE │ STOCK │ Consumer Cyclical │ Footwear & Accessories │ Germany │ Europe │ 27.95 │ 3 │ 0 │ 0 │ 83.85 │ 1 │ USD │ +├────────────┼───────┼───────┼────────────────────────┼─────────────────────────────────────┼───────────────┼───────────────┼──────────┼──────────┼──────┼─────────┼────────────┼──────┼──────────┤ +│ 2012-08-04 │ TSM │ STOCK │ Technology │ Semiconductors │ Taiwan │ Asia │ 14.24 │ 50 │ 0 │ 0 │ 712.00 │ 1 │ USD │ +├────────────┼───────┼───────┼────────────────────────┼─────────────────────────────────────┼───────────────┼───────────────┼──────────┼──────────┼──────┼─────────┼────────────┼──────┼──────────┤ +│ 2012-10-12 │ DGX │ STOCK │ Healthcare │ Diagnostics & Research │ United States │ North America │ 63.39 │ 6 │ 10 │ 0 │ 380.34 │ 1 │ USD │ +├────────────┼───────┼───────┼────────────────────────┼─────────────────────────────────────┼───────────────┼───────────────┼──────────┼──────────┼──────┼─────────┼────────────┼──────┼──────────┤ +│ 2013-02-03 │ YUM │ STOCK │ Consumer Cyclical │ Restaurants │ United States │ North America │ 45.98 │ 4 │ 10 │ 0 │ 183.92 │ 1 │ USD │ +├────────────┼───────┼───────┼────────────────────────┼─────────────────────────────────────┼───────────────┼───────────────┼──────────┼──────────┼──────┼─────────┼────────────┼──────┼──────────┤ +│ 2013-03-04 │ GOOGL │ STOCK │ Communication Services │ Internet Content & Information │ United States │ North America │ 410.75 │ 1 │ 100 │ 2 │ 410.75 │ 1 │ USD │ +├────────────┼───────┼───────┼────────────────────────┼─────────────────────────────────────┼───────────────┼───────────────┼──────────┼──────────┼──────┼─────────┼────────────┼──────┼──────────┤ +│ 2013-08-08 │ AMZN │ STOCK │ Technology │ Internet Retail │ United States │ North America │ 295.74 │ 1 │ 2 │ 3 │ 295.74 │ 1 │ USD │ +├────────────┼───────┼───────┼────────────────────────┼─────────────────────────────────────┼───────────────┼───────────────┼──────────┼──────────┼──────┼─────────┼────────────┼──────┼──────────┤ +│ 2013-10-09 │ AAPL │ STOCK │ Technology │ Consumer Electronics │ United States │ North America │ 17.38 │ 5 │ 5 │ 5 │ 86.90 │ 1 │ USD │ +├────────────┼───────┼───────┼────────────────────────┼─────────────────────────────────────┼───────────────┼───────────────┼──────────┼──────────┼──────┼─────────┼────────────┼──────┼──────────┤ +│ 2014-02-03 │ APTV │ STOCK │ Consumer Cyclical │ Auto Parts │ United States │ North America │ 49.53 │ 5 │ 4 │ 0 │ 247.65 │ 1 │ USD │ +├────────────┼───────┼───────┼────────────────────────┼─────────────────────────────────────┼───────────────┼───────────────┼──────────┼──────────┼──────┼─────────┼────────────┼──────┼──────────┤ +│ 2014-02-05 │ ASML │ STOCK │ Technology │ Semiconductor Equipment & Materials │ Netherlands │ Europe │ 85.16 │ 3 │ 3 │ 0 │ 255.48 │ 1 │ USD │ +├────────────┼───────┼───────┼────────────────────────┼─────────────────────────────────────┼───────────────┼───────────────┼──────────┼──────────┼──────┼─────────┼────────────┼──────┼──────────┤ +│ 2014-12-08 │ NKE │ STOCK │ Consumer Cyclical │ Footwear & Accessories │ Germany │ Europe │ 48.86 │ 10 │ 2 │ 0 │ 488.60 │ 1 │ USD │ +├────────────┼───────┼───────┼────────────────────────┼─────────────────────────────────────┼───────────────┼───────────────┼──────────┼──────────┼──────┼─────────┼────────────┼──────┼──────────┤ +│ 2015-02-02 │ BABA │ STOCK │ Consumer Cyclical │ Internet Retail │ China │ Asia │ 90.13 │ 30 │ 1 │ 0 │ 2703.90 │ 1 │ USD │ +├────────────┼───────┼───────┼────────────────────────┼─────────────────────────────────────┼───────────────┼───────────────┼──────────┼──────────┼──────┼─────────┼────────────┼──────┼──────────┤ +│ 2015-03-08 │ TSM │ STOCK │ Technology │ Semiconductors │ Taiwan │ Asia │ 23.45 │ 20 │ 6 │ 0 │ 469.00 │ 1 │ USD │ +├────────────┼───────┼───────┼────────────────────────┼─────────────────────────────────────┼───────────────┼───────────────┼──────────┼──────────┼──────┼─────────┼────────────┼──────┼──────────┤ +│ 2015-12-05 │ DGX │ STOCK │ Healthcare │ Diagnostics & Research │ United States │ North America │ 68.83 │ 21 │ 2 │ 3 │ 1445.43 │ 1 │ USD │ +├────────────┼───────┼───────┼────────────────────────┼─────────────────────────────────────┼───────────────┼───────────────┼──────────┼──────────┼──────┼─────────┼────────────┼──────┼──────────┤ +│ 2016-02-06 │ YUM │ STOCK │ Consumer Cyclical │ Restaurants │ United States │ North America │ 48.49 │ 2 │ 4 │ 1 │ 96.98 │ 1 │ USD │ +├────────────┼───────┼───────┼────────────────────────┼─────────────────────────────────────┼───────────────┼───────────────┼──────────┼──────────┼──────┼─────────┼────────────┼──────┼──────────┤ +│ 2016-09-07 │ GOOGL │ STOCK │ Communication Services │ Internet Content & Information │ United States │ North America │ 807.99 │ 2 │ 0 │ 2 │ 1615.98 │ 1 │ USD │ +├────────────┼───────┼───────┼────────────────────────┼─────────────────────────────────────┼───────────────┼───────────────┼──────────┼──────────┼──────┼─────────┼────────────┼──────┼──────────┤ +│ 2017-01-10 │ AMZN │ STOCK │ Technology │ Internet Retail │ United States │ North America │ 795.90 │ 2 │ 0 │ 0 │ 1591.80 │ 1 │ USD │ +├────────────┼───────┼───────┼────────────────────────┼─────────────────────────────────────┼───────────────┼───────────────┼──────────┼──────────┼──────┼─────────┼────────────┼──────┼──────────┤ +│ 2017-05-10 │ AAPL │ STOCK │ Technology │ Consumer Electronics │ United States │ North America │ 38.32 │ 10 │ 0 │ 0 │ 383.20 │ 1 │ USD │ +├────────────┼───────┼───────┼────────────────────────┼─────────────────────────────────────┼───────────────┼───────────────┼──────────┼──────────┼──────┼─────────┼────────────┼──────┼──────────┤ +│ 2017-12-08 │ APTV │ STOCK │ Consumer Cyclical │ Auto Parts │ United States │ North America │ 85.22 │ 10 │ 4 │ 0 │ 852.20 │ 1 │ USD │ +├────────────┼───────┼───────┼────────────────────────┼─────────────────────────────────────┼───────────────┼───────────────┼──────────┼──────────┼──────┼─────────┼────────────┼──────┼──────────┤ +│ 2018-07-05 │ ASML │ STOCK │ Technology │ Semiconductor Equipment & Materials │ Netherlands │ Europe │ 195.99 │ 5 │ 2 │ 5 │ 979.95 │ 1 │ USD │ +├────────────┼───────┼───────┼────────────────────────┼─────────────────────────────────────┼───────────────┼───────────────┼──────────┼──────────┼──────┼─────────┼────────────┼──────┼──────────┤ +│ 2018-09-03 │ NKE │ STOCK │ Consumer Cyclical │ Footwear & Accessories │ Germany │ Europe │ 79.60 │ 3 │ 2 │ 4 │ 238.80 │ 1 │ USD │ +├────────────┼───────┼───────┼────────────────────────┼─────────────────────────────────────┼───────────────┼───────────────┼──────────┼──────────┼──────┼─────────┼────────────┼──────┼──────────┤ +│ 2019-05-04 │ BABA │ STOCK │ Consumer Cyclical │ Internet Retail │ China │ Asia │ 188.24 │ 5 │ 1 │ 2 │ 941.20 │ 1 │ USD │ +├────────────┼───────┼───────┼────────────────────────┼─────────────────────────────────────┼───────────────┼───────────────┼──────────┼──────────┼──────┼─────────┼────────────┼──────┼──────────┤ +│ 2019-09-09 │ TSM │ STOCK │ Technology │ Semiconductors │ Taiwan │ Asia │ 43.85 │ 3 │ 6 │ 7 │ 131.55 │ 1 │ USD │ +├────────────┼───────┼───────┼────────────────────────┼─────────────────────────────────────┼───────────────┼───────────────┼──────────┼──────────┼──────┼─────────┼────────────┼──────┼──────────┤ +│ 2019-12-10 │ DGX │ STOCK │ Healthcare │ Diagnostics & Research │ United States │ North America │ 104.94 │ 8 │ 1 │ 4 │ 839.52 │ 1 │ USD │ +├────────────┼───────┼───────┼────────────────────────┼─────────────────────────────────────┼───────────────┼───────────────┼──────────┼──────────┼──────┼─────────┼────────────┼──────┼──────────┤ +│ 2020-02-03 │ YUM │ STOCK │ Consumer Cyclical │ Restaurants │ United States │ North America │ 106.41 │ 10 │ 10 │ 2 │ 1064.10 │ 1 │ USD │ +├────────────┼───────┼───────┼────────────────────────┼─────────────────────────────────────┼───────────────┼───────────────┼──────────┼──────────┼──────┼─────────┼────────────┼──────┼──────────┤ +│ 2020-03-08 │ GOOGL │ STOCK │ Communication Services │ Internet Content & Information │ United States │ North America │ 1215.79 │ 3 │ 10 │ 2 │ 3647.37 │ 1 │ USD │ +├────────────┼───────┼───────┼────────────────────────┼─────────────────────────────────────┼───────────────┼───────────────┼──────────┼──────────┼──────┼─────────┼────────────┼──────┼──────────┤ +│ 2020-06-09 │ AMZN │ STOCK │ Technology │ Internet Retail │ United States │ North America │ 2600.86 │ 2 │ 200 │ 20 │ 5201.72 │ 1 │ USD │ +├────────────┼───────┼───────┼────────────────────────┼─────────────────────────────────────┼───────────────┼───────────────┼──────────┼──────────┼──────┼─────────┼────────────┼──────┼──────────┤ +│ 2020-12-12 │ AAPL │ STOCK │ Technology │ Consumer Electronics │ United States │ North America │ 121.78 │ 4 │ 10 │ 0 │ 487.12 │ 1 │ USD │ +├────────────┼───────┼───────┼────────────────────────┼─────────────────────────────────────┼───────────────┼───────────────┼──────────┼──────────┼──────┼─────────┼────────────┼──────┼──────────┤ +│ 2021-01-07 │ APTV │ STOCK │ Consumer Cyclical │ Auto Parts │ United States │ North America │ 144.80 │ 20 │ 10 │ 6 │ 2896.00 │ 1 │ USD │ +├────────────┼───────┼───────┼────────────────────────┼─────────────────────────────────────┼───────────────┼───────────────┼──────────┼──────────┼──────┼─────────┼────────────┼──────┼──────────┤ +│ 2021-05-06 │ ASML │ STOCK │ Technology │ Semiconductor Equipment & Materials │ Netherlands │ Europe │ 644.34 │ 30 │ 10 │ 3 │ 19330.20 │ 1 │ USD │ +├────────────┼───────┼───────┼────────────────────────┼─────────────────────────────────────┼───────────────┼───────────────┼──────────┼──────────┼──────┼─────────┼────────────┼──────┼──────────┤ +│ 2021-12-28 │ NKE │ STOCK │ Consumer Cyclical │ Footwear & Accessories │ Germany │ Europe │ 166.42 │ 13 │ 20 │ 3 │ 2163.46 │ 1 │ USD │ +├────────────┼───────┼───────┼────────────────────────┼─────────────────────────────────────┼───────────────┼───────────────┼──────────┼──────────┼──────┼─────────┼────────────┼──────┼──────────┤ +│ 2022-02-02 │ BABA │ STOCK │ Consumer Cyclical │ Internet Retail │ China │ Asia │ 122.88 │ 30 │ 0 │ 1 │ 3686.40 │ 1 │ USD │ +├────────────┼───────┼───────┼────────────────────────┼─────────────────────────────────────┼───────────────┼───────────────┼──────────┼──────────┼──────┼─────────┼────────────┼──────┼──────────┤ +│ 2022-03-04 │ TSM │ STOCK │ Technology │ Semiconductors │ Taiwan │ Asia │ 105.06 │ 30 │ 0 │ 2 │ 3151.80 │ 1 │ USD │ +├────────────┼───────┼───────┼────────────────────────┼─────────────────────────────────────┼───────────────┼───────────────┼──────────┼──────────┼──────┼─────────┼────────────┼──────┼──────────┤ +│ 2022-04-12 │ DGX │ STOCK │ Healthcare │ Diagnostics & Research │ United States │ North America │ 137.27 │ 10 │ 30 │ 1 │ 1372.70 │ 1 │ USD │ +├────────────┼───────┼───────┼────────────────────────┼─────────────────────────────────────┼───────────────┼───────────────┼──────────┼──────────┼──────┼─────────┼────────────┼──────┼──────────┤ +│ 2022-05-02 │ YUM │ STOCK │ Consumer Cyclical │ Restaurants │ United States │ North America │ 115.76 │ 11 │ 40 │ 0 │ 1273.36 │ 1 │ USD │ +└────────────┴───────┴───────┴────────────────────────┴─────────────────────────────────────┴───────────────┴───────────────┴──────────┴──────────┴──────┴─────────┴────────────┴──────┴──────────┘ +``` +--- diff --git a/website/content/terminal/reference/portfolio/summary.md b/website/content/terminal/reference/portfolio/summary.md new file mode 100644 index 000000000000..2f15901cee9f --- /dev/null +++ b/website/content/terminal/reference/portfolio/summary.md @@ -0,0 +1,37 @@ +--- +title: summary +description: The page provides a detailed guide on how to display a summary of portfolio + vs benchmark. It explains the usage, parameters, and choices available. +keywords: +- summary +- portfolio +- benchmark +- Usage +- parameters +- period +- risk_free_rate +- calculations +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Display summary of portfolio vs benchmark + +### Usage + +```python +summary [-p PERIOD] [-r RISK_FREE_RATE] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| period | The file to be loaded | all | True | mtd, qtd, ytd, 3m, 6m, 1y, 3y, 5y, 10y, all | +| risk_free_rate | Set risk free rate for calculations. | 0 | True | None | + +--- diff --git a/website/content/terminal/reference/portfolio/var.md b/website/content/terminal/reference/portfolio/var.md new file mode 100644 index 000000000000..d3ea0a58eaa7 --- /dev/null +++ b/website/content/terminal/reference/portfolio/var.md @@ -0,0 +1,61 @@ +--- +title: var +description: Learn how to calculate the Value at Risk (VaR) of your portfolio using + different parameters and statistical methods. This guide provides examples and an + explanation of all the options. +keywords: +- Value at Risk +- VaR +- portfolio +- portfolio return +- Cornish-Fisher-Expansion +- student-t distribution +- percentile +- VaR calculations +- Historical VaR +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Provides value at risk (short: VaR) of the selected portfolio. + +### Usage + +```python +var [-m] [-a] [-s] [-p PERCENTILE] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| use_mean | If one should use the mean of the portfolio return | True | True | None | +| adjusted | If the VaR should be adjusted for skew and kurtosis (Cornish-Fisher-Expansion) | False | True | None | +| student_t | If one should use the student-t distribution | False | True | None | +| percentile | Percentile used for VaR calculations, for example input 99.9 equals a 99.9 Percent VaR | 99.9 | True | None | + + +--- + +## Examples + +```python +2022 Feb 25, 03:09 (🦋) /portfolio/ $ var + Portfolio Value at Risk +┏━━━━━━━┳━━━━━━━━━┳━━━━━━━━━━━━━━━━━┓ +┃ ┃ VaR: ┃ Historical VaR: ┃ +┡━━━━━━━╇━━━━━━━━━╇━━━━━━━━━━━━━━━━━┩ +│ 90.0% │ -0.0148 │ -0.0135 │ +├───────┼─────────┼─────────────────┤ +│ 95.0% │ -0.0189 │ -0.0197 │ +├───────┼─────────┼─────────────────┤ +│ 99.0% │ -0.0267 │ -0.0258 │ +├───────┼─────────┼─────────────────┤ +│ 99.9% │ -0.0353 │ -0.0276 │ +└───────┴─────────┴─────────────────┘ +``` +--- diff --git a/website/content/terminal/reference/portfolio/yret.md b/website/content/terminal/reference/portfolio/yret.md new file mode 100644 index 000000000000..911f6217504b --- /dev/null +++ b/website/content/terminal/reference/portfolio/yret.md @@ -0,0 +1,34 @@ +--- +title: yret +description: This page provides a guide on how to use the command 'yret' for determining + the end of year returns. It offers details on the permissible period selections + and their usage. +keywords: +- yret +- usage +- parameters +- end of year returns +- period +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +End of the year returns + +### Usage + +```python +yret [-p PERIOD] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| period | Period to select start end of the year returns | all | True | 3y, 5y, 10y, all | + +--- diff --git a/website/versioned_docs/version-v3/terminal/reference/reports/_category_.json b/website/content/terminal/reference/reports/_category_.json similarity index 100% rename from website/versioned_docs/version-v3/terminal/reference/reports/_category_.json rename to website/content/terminal/reference/reports/_category_.json diff --git a/website/content/terminal/reference/reports/run.md b/website/content/terminal/reference/reports/run.md new file mode 100644 index 000000000000..d61cb744114b --- /dev/null +++ b/website/content/terminal/reference/reports/run.md @@ -0,0 +1,37 @@ +--- +title: run +description: Learn how to effectively run a notebook from a specific location using + various parameters. This page also provides details about certain parameters such + as report parameters and the file to be loaded. +keywords: +- run notebook +- usage +- parameters +- file loading +- report parameters +- OpenBBUserData +- custom reports +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Run a notebook from this folder: '/home/runner/OpenBBUserData/reports/custom reports'. + +### Usage + +```python +run -f {} [-p PARAMETERS [PARAMETERS ...]] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| file | The file to be loaded | None | False | None | +| parameters | Report parameters with format 'name:value'. | None | True | None | + +--- diff --git a/website/versioned_docs/version-v3/terminal/reference/stocks/_category_.json b/website/content/terminal/reference/stocks/_category_.json similarity index 100% rename from website/versioned_docs/version-v3/terminal/reference/stocks/_category_.json rename to website/content/terminal/reference/stocks/_category_.json diff --git a/website/versioned_docs/version-v3/terminal/reference/stocks/ba/_category_.json b/website/content/terminal/reference/stocks/ba/_category_.json similarity index 100% rename from website/versioned_docs/version-v3/terminal/reference/stocks/ba/_category_.json rename to website/content/terminal/reference/stocks/ba/_category_.json diff --git a/website/content/terminal/reference/stocks/ba/bullbear.md b/website/content/terminal/reference/stocks/ba/bullbear.md new file mode 100644 index 000000000000..f9bef1c9a83c --- /dev/null +++ b/website/content/terminal/reference/stocks/ba/bullbear.md @@ -0,0 +1,51 @@ +--- +title: bullbear +description: This page provides information on the bullbear command, which prints + the bullbear sentiment based on the last 30 Stocktwits messages, as well as the + watchlist count. No parameters needed. +keywords: +- bullbear +- stocktwits +- stock market sentiment +- stock trade +- stock watchlist count +- bullish +- bearish +- no parameters command +- stock messaging +- stock trade analysis +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Print bullbear sentiment based on last 30 messages on the board. Also prints the watchlist_count. [Source: Stocktwits] + +### Usage + +```python +bullbear +``` + +--- + +## Parameters + +This command has no parameters + + + +--- + +## Examples + +```python +2022 Feb 16, 10:07 (🦋) /stocks/ba/ $ bullbear +Watchlist count: 381324 + +Last 16 sentiment messages: +Bullish 87.5% +Bearish 12.5% +``` +--- diff --git a/website/content/terminal/reference/stocks/ba/getdd.md b/website/content/terminal/reference/stocks/ba/getdd.md new file mode 100644 index 000000000000..0dd100ac3eda --- /dev/null +++ b/website/content/terminal/reference/stocks/ba/getdd.md @@ -0,0 +1,66 @@ +--- +title: getdd +description: Getdd function retrieves top stocks' due diligence from Reddit with the + functionality of choosing a limit on the posts, number of prior days to search, + and the choice of searching through all flairs or focusing on specific flairs including + DD, technical analysis, Catalyst, News, Advice, and Chart. +keywords: +- stock's due diligence +- Reddit +- getdd +- limit of posts +- number of prior days +- search through flairs +- 'flairs: DD, technical analysis, Catalyst, News, Advice, Chart' +- ATVI free money +- 'PTON: The safest investment' +- bottom on $FB +- Congress Trading & Retail Traders +- large market cap stocks +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Print top stock's due diligence from other users. [Source: Reddit] + +### Usage + +```python +getdd [-l LIMIT] [-d DAYS] [-a] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| limit | limit of posts to retrieve. | 5 | True | None | +| days | number of prior days to look for. | 3 | True | None | +| all | search through all flairs (apart from Yolo and Meme), otherwise we focus on specific flairs: DD, technical analysis, Catalyst, News, Advice, Chart | False | True | None | + + +--- + +## Examples + +```python +2022 Feb 16, 10:18 (🦋) /stocks/ba/ $ getdd -d 50 +2022-02-15 17:51:11 - $ATVI free money even if MSFT deal falls through. +https://old.reddit.com/r/wallstreetbets/comments/st8s1i/atvi_free_money_even_if_msft_deal_falls_through/ + +2022-02-10 05:10:31 - PTON: The safest investment you can make +https://old.reddit.com/r/stocks/comments/soycgc/pton_the_safest_investment_you_can_make/ + +2022-02-09 01:47:49 - Why only retards are selling the (near) bottom on $FB and are about to get metacucked 🙊 +https://old.reddit.com/r/wallstreetbets/comments/so19al/why_only_retards_are_selling_the_near_bottom_on/) + +2022-02-08 02:53:43 - If You Cannot Beat Them, Join Them - Congress Trading & Retail Traders +https://old.reddit.com/r/wallstreetbets/comments/sn90qs/if_you_cannot_beat_them_join_them_congress/ + +2022-02-03 20:01:06 - Thoughts on only buying large market cap stocks (Top 100, 100 billion market cap+, and significant index weighting)? +https://old.reddit.com/r/stocks/comments/sjsqhu/thoughts_on_only_buying_large_market_cap_stocks/ +``` +--- diff --git a/website/content/terminal/reference/stocks/ba/headlines.md b/website/content/terminal/reference/stocks/ba/headlines.md new file mode 100644 index 000000000000..d67146adf87a --- /dev/null +++ b/website/content/terminal/reference/stocks/ba/headlines.md @@ -0,0 +1,72 @@ +--- +title: headlines +description: Provides information about how FinBrain Technologies collects financial + news headlines from numerous major sources to generate sentiment scores for over + 4500 US stocks. It explores how they use deep learning algorithms for financial + analysis and prediction. +keywords: +- FinBrain +- news headlines +- financial news sources +- sentiment scores +- US stocks +- deep learning algorithms +- prediction +- traders +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +FinBrain collects the news headlines from 15+ major financial news sources on a daily basis and analyzes them to generate sentiment scores for more than 4500 US stocks.FinBrain Technologies develops deep learning algorithms for financial analysis and prediction, which currently serves traders from more than 150 countries all around the world. [Source: https://finbrain.tech] + +### Usage + +```python +headlines +``` + +--- + +## Parameters + +This command has no parameters + + + +--- + +## Examples + +```python +2022 Feb 16, 10:20 (🦋) /stocks/ba/ $ headlines + +FinBrain Ticker Sentiment +┏━━━━━━━━━━━━┳━━━━━━━━━━━┓ +┃ ┃ Sentiment ┃ +┡━━━━━━━━━━━━╇━━━━━━━━━━━┩ +│ 2022-02-03 │ 0.107 │ +├────────────┼───────────┤ +│ 2022-02-04 │ 0.354 │ +├────────────┼───────────┤ +│ 2022-02-07 │ 0.129 │ +├────────────┼───────────┤ +│ 2022-02-08 │ 0.173 │ +├────────────┼───────────┤ +│ 2022-02-09 │ 0.187 │ +├────────────┼───────────┤ +│ 2022-02-10 │ 0.161 │ +├────────────┼───────────┤ +│ 2022-02-11 │ 0.311 │ +├────────────┼───────────┤ +│ 2022-02-14 │ 0.174 │ +├────────────┼───────────┤ +│ 2022-02-15 │ 0.275 │ +├────────────┼───────────┤ +│ 2022-02-16 │ 0.329 │ +└────────────┴───────────┘ +``` +![headlines](https://user-images.githubusercontent.com/46355364/154296211-b0380095-5f84-4bae-955e-9ef96c9704af.png) + +--- diff --git a/website/content/terminal/reference/stocks/ba/infer.md b/website/content/terminal/reference/stocks/ba/infer.md new file mode 100644 index 000000000000..0a498bf268c6 --- /dev/null +++ b/website/content/terminal/reference/stocks/ba/infer.md @@ -0,0 +1,52 @@ +--- +title: infer +description: The documentation guide on 'infer', a tool used for quick sentiment inference + from latest tweets that contain the ticker using vader sentiment analysis. It provides + parameters to set the tweet limit and also includes examples of usage +keywords: +- infer +- vader sentiment analysis +- Twitter +- tweets +- sentiment inference +- stock +- limit +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Print quick sentiment inference from last tweets that contain the ticker. This model splits the text into character-level tokens and uses vader sentiment analysis. [Source: Twitter] + +### Usage + +```python +infer [-l LIMIT] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| limit | limit of latest tweets to infer from. | 100 | True | None | + + +--- + +## Examples + +```python +2022 Feb 19, 13:05 (🦋) /stocks/ba/ $ infer +From: 2022-02-19 17:08:20 +To: 2022-02-19 18:04:18 +100 tweets were analyzed. +Frequency of approx 1 tweet every 34 seconds. +The summed compound sentiment of AAPL is: 13.2 +The average compound sentiment of AAPL is: 0.13 +Of the last 100 tweets, 45.00 % had a higher positive sentiment +Of the last 100 tweets, 18.00 % had a higher negative sentiment +``` +--- diff --git a/website/content/terminal/reference/stocks/ba/interest.md b/website/content/terminal/reference/stocks/ba/interest.md new file mode 100644 index 000000000000..2b42fd579225 --- /dev/null +++ b/website/content/terminal/reference/stocks/ba/interest.md @@ -0,0 +1,49 @@ +--- +title: interest +description: This page serves as a user guide for the 'interest' feature which plots + keywords or phrases over time versus stock price. It provides details on its usage, + parameters, and provides illustrative execution results. Notable keywords that you + could use to influence the plotted interest include topical phrases like 'COVID', + 'WW3', and 'NFT'. The source for this functionality is based on Google. +keywords: +- Interest +- Stock price +- Words +- Sentences +- Date +- Parameters +- Default +- Optional +- Start +- Words +- Choices +- Google +- COVID +- WW3 +- NFT +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Plot interest over time of words/sentences versus stock price. [Source: Google] + +### Usage + +```python +interest [-s START] [-w WORDS] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| start | starting date (format YYYY-MM-DD) of interest | 2020-11-23 | True | None | +| words | Select multiple sentences/words separated by commas. E.g. COVID,WW3,NFT | None | True | None | + +![interest](https://user-images.githubusercontent.com/25267873/157575723-23c55e4e-9e87-4647-b8fa-8ed9643f471f.png) + +--- diff --git a/website/content/terminal/reference/stocks/ba/jcdr.md b/website/content/terminal/reference/stocks/ba/jcdr.md new file mode 100644 index 000000000000..d95e48cbd7b1 --- /dev/null +++ b/website/content/terminal/reference/stocks/ba/jcdr.md @@ -0,0 +1,34 @@ +--- +title: jcdr +description: The 'jcdr' page provides information about daily Cramer recommendations + and the parameters for using them, including adjustments for inverse recommendations. +keywords: +- jcdr +- cramer recommendation +- daily cramer recommendation +- inverse recommendation +- usage +- parameters +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Show daily cramer recommendation + +### Usage + +```python +jcdr [-i] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| inverse | Show inverse recommendation | False | True | None | + +--- diff --git a/website/content/terminal/reference/stocks/ba/jctr.md b/website/content/terminal/reference/stocks/ba/jctr.md new file mode 100644 index 000000000000..dc1748a2a969 --- /dev/null +++ b/website/content/terminal/reference/stocks/ba/jctr.md @@ -0,0 +1,31 @@ +--- +title: jctr +description: The jctr command in Python shows the cramer recommendation for the loaded + ticker. This command requires no parameters. +keywords: +- jctr +- cramer recommendation +- loaded ticker +- no parameters command +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Show cramer recommendation for loaded ticker + +### Usage + +```python +jctr +``` + +--- + +## Parameters + +This command has no parameters + + +--- diff --git a/website/content/terminal/reference/stocks/ba/load.md b/website/content/terminal/reference/stocks/ba/load.md new file mode 100644 index 000000000000..1f81fec31715 --- /dev/null +++ b/website/content/terminal/reference/stocks/ba/load.md @@ -0,0 +1,46 @@ +--- +title: load +description: This documentation page provides useful information on how to load stock + tickers for market analysis, including specifications for intraday stocks, market + hours, and options for custom, weekly, and monthly data loading. +keywords: +- Stock market analysis +- Intraday stock +- Market hours +- Load stock ticker +- Stock data +- Pre/post market +- Stock ticker +- Custom data load +- Monthly data load +- Weekly data load +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Load stock ticker to perform analysis on. When the data source is syf', an Indian ticker can be loaded by using '.NS' at the end, e.g. 'SBIN.NS'. See available market in https://help.yahoo.com/kb/exchanges-data-providers-yahoo-finance-sln2310.html. + +### Usage + +```python +load -t TICKER [-s START] [-e END] [-i {1,5,15,30,60}] [-p] [-f FILEPATH] [-m] [-w] [-r {ytd,1y,2y,5y,6m}] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| ticker | Stock ticker | None | False | None | +| start | The starting date (format YYYY-MM-DD) of the stock | 2019-11-21 | True | None | +| end | The ending date (format YYYY-MM-DD) of the stock | 2022-11-25 | True | None | +| interval | Intraday stock minutes | 1440 | True | 1, 5, 15, 30, 60 | +| prepost | Pre/After market hours. Only works for 'yf' source, and intraday data | False | True | None | +| filepath | Path to load custom file. | None | True | None | +| monthly | Load monthly data | False | True | None | +| weekly | Load weekly data | False | True | None | + +--- diff --git a/website/content/terminal/reference/stocks/ba/mentions.md b/website/content/terminal/reference/stocks/ba/mentions.md new file mode 100644 index 000000000000..3b1ab16362e3 --- /dev/null +++ b/website/content/terminal/reference/stocks/ba/mentions.md @@ -0,0 +1,34 @@ +--- +title: mentions +description: The page provides details on how to plot weekly bars of stock's interest + over time with a python script. It includes usage and parameters like start date. +keywords: +- stock mentions +- Start Date Parameter +- Interest over time +- Google source +- Weekly bars +- Docusaurus SEO +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Plot weekly bars of stock's interest over time. other users watchlist. [Source: Google] + +### Usage + +```python +mentions [-s START] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| start | starting date (format YYYY-MM-DD) from when we are interested in stock's mentions. | 2022-01-01 | True | None | + +--- diff --git a/website/content/terminal/reference/stocks/ba/messages.md b/website/content/terminal/reference/stocks/ba/messages.md new file mode 100644 index 000000000000..917bdfe420c7 --- /dev/null +++ b/website/content/terminal/reference/stocks/ba/messages.md @@ -0,0 +1,34 @@ +--- +title: messages +description: This page provides an overview of how to use the 'messages' function + to print the last messages on the Stocktwits message board. It includes detailed + instructions on parameter usage too. +keywords: +- messages +- Stocktwits +- message board +- parameters +- limit +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Print up to 30 of the last messages on the board. [Source: Stocktwits] + +### Usage + +```python +messages [-l LIMIT] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| limit | limit messages shown. | 30 | True | None | + +--- diff --git a/website/content/terminal/reference/stocks/ba/popular.md b/website/content/terminal/reference/stocks/ba/popular.md new file mode 100644 index 000000000000..9d9eaec3f0d2 --- /dev/null +++ b/website/content/terminal/reference/stocks/ba/popular.md @@ -0,0 +1,88 @@ +--- +title: popular +description: This segment teaches you how to obtain a list of the latest popular stock + tickers from various subreddits using command line parameters. This tutorial contains + usage, a parameters guide, and an example command. +keywords: +- stock market +- popular tickers +- Reddit stock market +- Reddit tickers +- Python command line +- Finance +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Print latest popular tickers. [Source: Reddit] + +### Usage + +```python +popular [-l LIMIT] [-n NUM] [-s S_SUBREDDIT] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| limit | limit of top tickers to retrieve | 10 | True | None | +| num | number of posts retrieved per sub reddit. | 50 | True | None | +| s_subreddit | Subreddits to look for tickers, e.g. pennystocks,stocks. Default: pennystocks, RobinHoodPennyStocks, Daytrading, StockMarket, stocks, investing, wallstreetbets | None | True | None | + + +--- + +## Examples + +```python +2022 Feb 16, 10:31 (🦋) /stocks/ba/ $ popular +Search for latest tickers for 50 'Superstonk' posts + 217 potential tickers found. +Search for latest tickers for 50 'pennystocks' posts + 107 potential tickers found. +Search for latest tickers for 50 'RobinHoodPennyStocks' posts + 7 potential tickers found. +Search for latest tickers for 50 'Daytrading' posts + 56 potential tickers found. +Search for latest tickers for 50 'StockMarket' posts + 77 potential tickers found. +Search for latest tickers for 50 'stocks' posts + 97 potential tickers found. +Search for latest tickers for 50 'investing' posts + 37 potential tickers found. +Search for latest tickers for 50 'wallstreetbets' posts + 31 potential tickers found. + + The following TOP 10 tickers have been mentioned: +┏━━━━━━━━━━┳━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━┳━━━━━━━━━┳━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Mentions ┃ Ticker ┃ Company ┃ Sector ┃ Price ┃ Change ┃ Perf Month ┃ URL ┃ +┡━━━━━━━━━━╇━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━╇━━━━━━━━━╇━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┩ +│ 57 │ GME │ GameStop Corp. │ Consumer Cyclical │ 129.34 │ 2.52% │ 8.15% │ https://finviz.com/quote.ashx?t=GME │ +├──────────┼────────┼────────────────────────────────────────────────────────┼──────────────────────┼────────┼─────────┼────────────┼──────────────────────────────────────┤ +│ 40 │ POST │ Post Holdings, Inc. │ Consumer Defensive │ 109.14 │ -0.18% │ -7.18% │ https://finviz.com/quote.ashx?t=POST │ +├──────────┼────────┼────────────────────────────────────────────────────────┼──────────────────────┼────────┼─────────┼────────────┼──────────────────────────────────────┤ +│ 10 │ SPY │ Financial │ Exchange Traded Fund │ 442.48 │ -0.81% │ -4.01% │ https://finviz.com/quote.ashx?t=SPY │ +├──────────┼────────┼────────────────────────────────────────────────────────┼──────────────────────┼────────┼─────────┼────────────┼──────────────────────────────────────┤ +│ 8 │ QQQ │ Financial │ Exchange Traded Fund │ 351.15 │ -1.40% │ -6.28% │ https://finviz.com/quote.ashx?t=QQQ │ +├──────────┼────────┼────────────────────────────────────────────────────────┼──────────────────────┼────────┼─────────┼────────────┼──────────────────────────────────────┤ +│ 6 │ VTI │ Vanguard Index Funds - Vanguard Total Stock Market ETF │ Financial │ 224.13 │ -0.86% │ -3.81% │ https://finviz.com/quote.ashx?t=VTI │ +├──────────┼────────┼────────────────────────────────────────────────────────┼──────────────────────┼────────┼─────────┼────────────┼──────────────────────────────────────┤ +│ 5 │ AAPL │ Apple Inc. │ Technology │ 170.53 │ -1.31% │ -0.16% │ https://finviz.com/quote.ashx?t=AAPL │ +├──────────┼────────┼────────────────────────────────────────────────────────┼──────────────────────┼────────┼─────────┼────────────┼──────────────────────────────────────┤ +│ 5 │ ESG │ Financial │ Exchange Traded Fund │ 107.88 │ -0.65% │ -4.64% │ https://finviz.com/quote.ashx?t=ESG │ +├──────────┼────────┼────────────────────────────────────────────────────────┼──────────────────────┼────────┼─────────┼────────────┼──────────────────────────────────────┤ +│ 5 │ SHOP │ Shopify Inc. │ Technology │ 728.52 │ -18.10% │ -19.35% │ https://finviz.com/quote.ashx?t=SHOP │ +├──────────┼────────┼────────────────────────────────────────────────────────┼──────────────────────┼────────┼─────────┼────────────┼──────────────────────────────────────┤ +│ 4 │ AMD │ Advanced Micro Devices, Inc. │ Technology │ 117.21 │ -3.51% │ -11.26% │ https://finviz.com/quote.ashx?t=AMD │ +├──────────┼────────┼────────────────────────────────────────────────────────┼──────────────────────┼────────┼─────────┼────────────┼──────────────────────────────────────┤ +│ 4 │ NVDA │ NVIDIA Corporation │ Technology │ 258.61 │ -2.39% │ -1.66% │ https://finviz.com/quote.ashx?t=NVDA │ +├──────────┼────────┼────────────────────────────────────────────────────────┼──────────────────────┼────────┼─────────┼────────────┼──────────────────────────────────────┤ +│ 3 │ RESN │ Resonant Inc. │ Technology │ 4.35 │ -1.01% │ 185.06% │ https://finviz.com/quote.ashx?t=RESN │ +└──────────┴────────┴────────────────────────────────────────────────────────┴──────────────────────┴────────┴─────────┴────────────┴──────────────────────────────────────┘ +``` +--- diff --git a/website/content/terminal/reference/stocks/ba/queries.md b/website/content/terminal/reference/stocks/ba/queries.md new file mode 100644 index 000000000000..e09d6bf45142 --- /dev/null +++ b/website/content/terminal/reference/stocks/ba/queries.md @@ -0,0 +1,73 @@ +--- +title: queries +description: This page provides documentation on how to use the 'queries' function + to print the top related queries associated with a stock's query. Learn how to set + a limit on the number of queries and view examples of the output. +keywords: +- stock +- query +- stock query +- top related queries +- print +- stock's query +- function +- Google source +- limit +- parameters +- examples +- output +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Print top related queries with this stock's query. [Source: Google] + +### Usage + +```python +queries [-l LIMIT] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| limit | limit of top related queries to print. | 10 | True | None | + + +--- + +## Examples + +```python +2022 Feb 16, 10:38 (🦋) /stocks/ba/ $ queries + Top AMZN's related queries +┏━━━━━━━━━━━━━━━━━━┳━━━━━━━┓ +┃ query ┃ value ┃ +┡━━━━━━━━━━━━━━━━━━╇━━━━━━━┩ +│ amzn stock │ 100% │ +├──────────────────┼───────┤ +│ amzn price │ 31% │ +├──────────────────┼───────┤ +│ amzn stock price │ 26% │ +├──────────────────┼───────┤ +│ aapl │ 25% │ +├──────────────────┼───────┤ +│ tsla │ 18% │ +├──────────────────┼───────┤ +│ aapl stock │ 15% │ +├──────────────────┼───────┤ +│ fb stock │ 12% │ +├──────────────────┼───────┤ +│ msft │ 12% │ +├──────────────────┼───────┤ +│ tsla stock │ 12% │ +├──────────────────┼───────┤ +│ goog │ 9% │ +└──────────────────┴───────┘ +``` +--- diff --git a/website/content/terminal/reference/stocks/ba/redditsent.md b/website/content/terminal/reference/stocks/ba/redditsent.md new file mode 100644 index 000000000000..74414e703137 --- /dev/null +++ b/website/content/terminal/reference/stocks/ba/redditsent.md @@ -0,0 +1,62 @@ +--- +title: redditsent +description: Discover how to use the redditsent function to perform sentiment analysis + on Reddit about a specific ticker or company. Learn to adjust search parameters + like sorting type, subreddits, post limit, time period, and more for a comprehensive + Reddit search. +keywords: +- redditsent +- sentiment analysis +- Reddit +- search sorting +- company search +- subreddits +- posts limit +- time period +- full search +- graphic display +- table of sentiment values +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Determine general Reddit sentiment about a ticker. [Source: Reddit] + +### Usage + +```python +redditsent [-s {relevance,hot,top,new,comments}] [-c COMPANY] [--subreddits SUBREDDITS] [-l LIMIT] [-t {hour,day,week,month,year,all}] [--full] [-g] [-d] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| sort | search sorting type | relevance | True | relevance, hot, top, new, comments | +| company | explicit name of company to search for, will override ticker symbol | None | True | None | +| subreddits | comma-separated list of subreddits to search | all | True | None | +| limit | how many posts to gather from each subreddit | 10 | True | None | +| time | time period to get posts from -- all, year, month, week, or day; defaults to week | week | True | hour, day, week, month, year, all | +| full_search | enable comprehensive search | False | True | None | +| graphic | display graphic | True | True | None | +| display | Print table of sentiment values | False | True | None | + + +--- + +## Examples + +```python +txt +redditsent -c Google --subreddits tech,stocks --full +Searching through subreddits for posts. +100%|█████████████████████████████████████████████████████████████████████████| 2/2 [00:0100:00, 1.84it/s] +Analyzing each post... +100%|███████████████████████████████████████████████████████████████████████| 10/10 [00:0400:00, 2.07it/s] +Sentiment Analysis for Google is 0.7552 +``` +--- diff --git a/website/content/terminal/reference/stocks/ba/regions.md b/website/content/terminal/reference/stocks/ba/regions.md new file mode 100644 index 000000000000..9c712f4e128d --- /dev/null +++ b/website/content/terminal/reference/stocks/ba/regions.md @@ -0,0 +1,37 @@ +--- +title: regions +description: Learn how to plot bars representing regions based on a stock's interest + using Python. This tutorial includes Python usage explanations, parameters details, + and visualization examples. +keywords: +- regions +- stock's interest +- plot bars +- Google source +- Python usage +- limit parameter +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Plot bars of regions based on stock's interest. [Source: Google] + +### Usage + +```python +regions [-l LIMIT] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| limit | limit of regions to plot that show highest interest. | 10 | True | None | + +![regions](https://user-images.githubusercontent.com/46355364/154300386-f6b1924c-8f73-44c5-bbae-52ef33d88061.png) + +--- diff --git a/website/content/terminal/reference/stocks/ba/rise.md b/website/content/terminal/reference/stocks/ba/rise.md new file mode 100644 index 000000000000..83d104f33203 --- /dev/null +++ b/website/content/terminal/reference/stocks/ba/rise.md @@ -0,0 +1,68 @@ +--- +title: rise +description: The 'rise' is a command for printing top rising related queries of a + specific stock. It sources its data from Google and is customizable based on user + inputs, creating an efficient way of keeping track of specific stock metrics. +keywords: +- stocks +- stock metrics +- google sourced data +- top rising queries +- command line interface +- stock command +- query limit +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Print top rising related queries with this stock's query. [Source: Google] + +### Usage + +```python +rise [-l LIMIT] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| limit | limit of top rising related queries to print. | 10 | True | None | + + +--- + +## Examples + +```python +2022 Feb 16, 10:40 (🦋) /stocks/ba/ $ rise +Top rising AAPL's related queries +┏━━━━━━━━━━━━━━━━━┳━━━━━━━━┓ +┃ query ┃ value ┃ +┡━━━━━━━━━━━━━━━━━╇━━━━━━━━┩ +│ nio stock │ 227850 │ +├─────────────────┼────────┤ +│ nio │ 183950 │ +├─────────────────┼────────┤ +│ pltr │ 103100 │ +├─────────────────┼────────┤ +│ pltr stock │ 82800 │ +├─────────────────┼────────┤ +│ mrna stock │ 75050 │ +├─────────────────┼────────┤ +│ zm stock │ 67850 │ +├─────────────────┼────────┤ +│ nio stock price │ 64000 │ +├─────────────────┼────────┤ +│ zm │ 63500 │ +├─────────────────┼────────┤ +│ bynd │ 61450 │ +├─────────────────┼────────┤ +│ bynd stock │ 47450 │ +└─────────────────┴────────┘ +``` +--- diff --git a/website/content/terminal/reference/stocks/ba/sentiment.md b/website/content/terminal/reference/stocks/ba/sentiment.md new file mode 100644 index 000000000000..b35b7ff5770f --- /dev/null +++ b/website/content/terminal/reference/stocks/ba/sentiment.md @@ -0,0 +1,54 @@ +--- +title: sentiment +description: The page provides a sentiment analysis tool that predicts in-depth sentiment + from recent tweets containing pre-specified stock tickers. It offers customizable + parameters including the limit of tweets to extract per hour and the number of past + days to extract tweets. Additionally, users can choose to show a corresponding change + in the stock price, enhancing the analysis. +keywords: +- sentiment +- tweets analysis +- stock market sentiment +- Twitter data analysis +- predictive sentiment analysis +- stock market data +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Plot in-depth sentiment predicted from tweets from last days that contain pre-defined ticker. [Source: Twitter] + +### Usage + +```python +sentiment [-l LIMIT] [-d N_DAYS_PAST] [-c] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| limit | limit of tweets to extract per hour. | 15 | True | None | +| n_days_past | number of days in the past to extract tweets. | 6 | True | None | +| compare | show corresponding change in stock price | False | True | None | + + +--- + +## Examples + +```python +2022 Feb 19, 13:16 (🦋) /stocks/ba/ $ sentiment +From 2022-02-19 retrieving 360 tweets (15 tweets/hour) +From 2022-02-18 retrieving 360 tweets (15 tweets/hour) +From 2022-02-17 retrieving 360 tweets (15 tweets/hour) +From 2022-02-16 retrieving 360 tweets (15 tweets/hour) +From 2022-02-15 retrieving 360 tweets (15 tweets/hour) +From 2022-02-14 retrieving 360 tweets (15 tweets/hour) +From 2022-02-13 retrieving 360 tweets (15 tweets/hour) +``` +--- diff --git a/website/content/terminal/reference/stocks/ba/snews.md b/website/content/terminal/reference/stocks/ba/snews.md new file mode 100644 index 000000000000..207d24d9067c --- /dev/null +++ b/website/content/terminal/reference/stocks/ba/snews.md @@ -0,0 +1,34 @@ +--- +title: snews +description: 'snews - Display stock price and headlines sentiment using VADER model. + No parameters. Source: Finnhub.' +keywords: +- snews +- stock price +- headlines sentiment +- VADER model +- Finnhub +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Display stock price and headlines sentiment using VADER model over time. [Source: Finnhub] + +### Usage + +```python +snews +``` + +--- + +## Parameters + +This command has no parameters + + +![snews](https://user-images.githubusercontent.com/25267873/156584514-33c2cd52-4763-43cd-8a53-4118b8615450.png) + +--- diff --git a/website/content/terminal/reference/stocks/ba/spac.md b/website/content/terminal/reference/stocks/ba/spac.md new file mode 100644 index 000000000000..69e2471448c2 --- /dev/null +++ b/website/content/terminal/reference/stocks/ba/spac.md @@ -0,0 +1,63 @@ +--- +title: spac +description: This page provides a tool letting users pull SPAC announcements from + Reddit. It shows usage, parameters, examples, and notable references to companies + such as eToro and Citadel Advisors. +keywords: +- SPACs +- Reddit +- stocks +- eToro +- GME +- FTCV +- APEX Clearing +- Peak 6 +- Citadel Advisors +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Show other users SPACs announcement. [Source: Reddit] + +### Usage + +```python +spac [-l N_LIMIT] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| n_limit | limit of posts with SPACs retrieved. | 5 | True | None | + + +--- + +## Examples + +```python +2022 Feb 16, 10:42 (🦋) /stocks/ba/ $ spac +2022-02-15 22:31:56 - 2020 vs 2021 +https://old.reddit.com/r/wallstreetbets/comments/stfcdu/2020_vs_2021/ + +2022-02-15 20:05:35 - Calls on the “W” this week should print…Wynn and Walmart calls baby.. +https://old.reddit.com/r/wallstreetbets/comments/stbz5h/calls_on_the_w_this_week_should_printwynn_and/ + +2022-02-13 18:09:23 - APEX Clearing, Peak 6, a power couple, poker and a failed SPAC. +https://old.reddit.com/r/Superstonk/comments/srovzk/apex_clearing_peak_6_a_power_couple_poker_and_a/ + +2022-02-11 19:30:21 - SPAC founders DO get 20% of hundreds of millions in stock for their 25k investment. And the par value for shares is so low, some fuckery can be done! +https://old.reddit.com/r/Superstonk/comments/sq7hcz/spac_founders_do_get_20_of_hundreds_of_millions/ + +2022-02-11 15:16:40 - In Q4 Citadel Advisors LLC bought 6.39% of FTCV - the SPAC that eToro will merge with in order to go public. +https://old.reddit.com/r/Superstonk/comments/sq1qv8/in_q4_citadel_advisors_llc_bought_639_of_ftcv_the/ + +The following stock tickers have been mentioned more than once across the previous SPACs: +3 GME, 2 POST, 2 FTCV +``` +--- diff --git a/website/content/terminal/reference/stocks/ba/spacc.md b/website/content/terminal/reference/stocks/ba/spacc.md new file mode 100644 index 000000000000..955d2475e648 --- /dev/null +++ b/website/content/terminal/reference/stocks/ba/spacc.md @@ -0,0 +1,63 @@ +--- +title: spacc +description: Spacc- a tool that presents a list of other users' SPACs announcements + from the 'SPACs' subreddit. Options include setting the limit of posts retrieved + and the sorting model- popular posts or recent posts. +keywords: +- spacc +- SPACs +- subreddit +- tool +- posts +- limit +- b_popular +- score +- time +- Reddit +- stocks +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Print other users SPACs announcement under subreddit 'SPACs'. [Source: Reddit] + +### Usage + +```python +spacc [-l N_LIMIT] [-p] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| n_limit | limit of posts with SPACs retrieved | 10 | True | None | +| b_popular | popular flag, if true the posts retrieved are based on score rather than time | False | True | None | + + +--- + +## Examples + +```python +2022 Feb 16, 10:43 (🦋) /stocks/ba/ $ spacc +2022-02-16 11:35:01 - I scraped r/SPACs for the top ticker mentions in the last 24H. Here are the results (Wednesday February 16, 2022) +https://old.reddit.com/r/SPACs/comments/sttsnl/i_scraped_rspacs_for_the_top_ticker_mentions_in/ + +2022-02-16 09:26:19 - PPGH Gogoro confirms that it is expected to list overseas in the first quarter of this year +https://old.reddit.com/r/SPACs/comments/strs9m/ppgh_gogoro_confirms_that_it_is_expected_to_list/ + +2022-02-16 08:00:16 - Announcements x Daily Discussion for Wednesday, February 16, 2022 +https://old.reddit.com/r/SPACs/comments/stqhci/announcements_x_daily_discussion_for_wednesday/ + +2022-02-15 15:10:40 - Did IBKR resolve my SPAC redemptions wrongly? +https://old.reddit.com/r/SPACs/comments/st52xb/did_ibkr_resolve_my_spac_redemptions_wrongly/ + +The following stock tickers have been mentioned more than once across the previous SPACs: +8 CCAC, 6 IBKR, 3 CLBT, 3 SLDP, 2 VIAC, 2 CND +``` +--- diff --git a/website/content/terminal/reference/stocks/ba/stalker.md b/website/content/terminal/reference/stocks/ba/stalker.md new file mode 100644 index 000000000000..545b7ebbdedc --- /dev/null +++ b/website/content/terminal/reference/stocks/ba/stalker.md @@ -0,0 +1,216 @@ +--- +title: stalker +description: 'Stalker: A tool for tracking and printing the last messages of a Stocktwits + user. Allows specification of the username and limit of messages to be shown. Helps + users quickly retrieve and review the recent activity of a specific user.' +keywords: +- stalker +- user messages +- Stocktwits +- username +- message limit +- programming documentation +- message tracking +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Print up to the last 30 messages of a user. [Source: Stocktwits] + +### Usage + +```python +stalker [-u S_USER] [-l LIMIT] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| s_user | username. | Newsfilter | True | None | +| limit | limit messages shown. | 30 | True | None | + + +--- + +## Examples + +```python +2022 Feb 16, 10:44 (🦋) /stocks/ba/ $ stalker + +------------------------------------------------------------------------------ +2022-02-16 15:44:24 +$APSI Form 8-K: On February 14, 2022, Aqua Power Systems acquired a digital asset commonly referred to as “land” within the Sandbox metaverse. The Sandbox is a decentralized, community-driven gaming e.. + +https://newsfilter.io/a/077c80e3595e23f3a9adf089f24220d1 + +------------------------------------------------------------------------------ +2022-02-16 15:44:04 +$ACT $GNW Increase in Long-Term Care Costs in Wisconsin Mirror National Trends; Labor Market Shifts and Continued COVID-19 Pressure Affect Future Costs + +https://newsfilter.io/a/acd6951639a15b873ff29dfe333c495e + +------------------------------------------------------------------------------ +2022-02-16 15:43:44 +$SYBT 2,571 shares acquired by Croce Michael (Executive Vice President), reported in a new form 4 filed with the SEC + +https://newsfilter.io/a/a9b224c7a3427af2d28a7d5482c2501a + +------------------------------------------------------------------------------ +2022-02-16 15:43:30 +Thinking about trading options or stock in Roblox, Meta, Block, Trade Desk, or Devon Energy? $DVN $FB $RBLX $SQ $TTD + +https://newsfilter.io/a/b7000be8e8b35ededc2abe4c246cd19a + +------------------------------------------------------------------------------ +2022-02-16 15:43:08 +$GRRB $338,254.00 of shares acquired by Schwiers James B (President & COO), reported in a new form 4 filed with the SEC + +https://newsfilter.io/a/327d924ef4c507727b08b5f4989b1bd3 + +------------------------------------------------------------------------------ +2022-02-16 15:42:07 +$ARLP 794 shares acquired by Cantrell Brian L (Senior VP and CFO), reported in a new form 4 filed with the SEC + +https://newsfilter.io/a/0310350cc25f4d15959334893bd916dc + +------------------------------------------------------------------------------ +2022-02-16 15:42:01 +$ACT $GNW Increase in Long-Term Care Costs in Texas Mirror National Trends; Labor Market Shifts and Continued COVID-19 Pressure Affect Future Costs + +https://newsfilter.io/a/e86d458d9e48cacd03bb0fc4ed9031aa + +------------------------------------------------------------------------------ +2022-02-16 15:41:26 +$PDLB Form 3/A (initial statement of beneficial ownership of securities) filed with the SEC + +https://newsfilter.io/a/ec79f2f0558259465e6ed6be37208891 + +------------------------------------------------------------------------------ +2022-02-16 15:40:54 +$PDLB filed 2 new form 3/A (initial statement of beneficial ownership of securities) with the SEC in the last 2 minutes. + +1. filing: https://newsfilter.io/a/d1c358598d5b7d9917f135004753dd3c +2. filing: https://newsfilter.io/a/e12fd3d79f67fe97b0349ebcec497594 + +------------------------------------------------------------------------------ +2022-02-16 15:40:42 +$ZNTE Form DEFA14A (additional definitive proxy soliciting materials and rule 14(a)(12) material) filed with the SEC + +https://newsfilter.io/a/81a6d11a7d635b22d0b63d97724877ba + +------------------------------------------------------------------------------ +2022-02-16 15:40:08 +Thinking about buying stock in Team, ViacomCBS, Kaival Brands, Ericsson, or Barrick Gold? $ERIC $GOLD $KAVL $TISI $VIAC + +https://newsfilter.io/a/587588716a671414014bf779eab21059 + +------------------------------------------------------------------------------ +2022-02-16 15:40:07 +Thinking about buying stock in Vinco Ventures, SoFi Technologies, Ford, Vonage, or BP? $BBIG $BP $F $SOFI $VG + +https://newsfilter.io/a/385fbe647e5e9ef2c9328bf3a9fbc9b6 + +------------------------------------------------------------------------------ +2022-02-16 15:40:04 +$ACT $GNW Increase in Long-Term Care Costs in Tennessee Mirror National Trends; Labor Market Shifts and Continued COVID-19 Pressure Affect Future Costs + +https://newsfilter.io/a/f0544ef5b76170ad50bc8359bac658e2 + +------------------------------------------------------------------------------ +2022-02-16 15:39:54 +$FTRP Field Trip Health Posts 330% YoY Increase In Q3 Revenue + +https://newsfilter.io/a/e2118ae4f28181fa49047b865af0ef41 + +------------------------------------------------------------------------------ +2022-02-16 15:39:54 +$KHC Kraft Heinz Stock Gains On Q4 Earnings Beat + +https://newsfilter.io/a/4a57861cd3455555baa7cb88705225c5 + +------------------------------------------------------------------------------ +2022-02-16 15:39:54 +$VIAC $CMCSA ViacomCBS Rebrands As Paramount: What You Need To Know + +https://newsfilter.io/a/1dee0b7add2966c50b08a6f213e69a4d + +------------------------------------------------------------------------------ +2022-02-16 15:38:56 +$ABNB Truist Securities analyst Naved Khan maintains Airbnb with a Hold and raises the price target from $180 to $190. + +------------------------------------------------------------------------------ +2022-02-16 15:38:01 +$ACT $GNW Change in Long-Term Care Costs in South Dakota Mixed; Labor Market Shifts and Continued COVID-19 Pressure Affect Future Costs + +https://newsfilter.io/a/157e15e71e3872ce73d3401098f3f855 + +------------------------------------------------------------------------------ +2022-02-16 15:36:04 +$ACT $GNW Increase in Long-Term Care Costs in Oklahoma Mirror National Trends; Labor Market Shifts and Continued COVID-19 Pressure Affect Future Costs + +https://newsfilter.io/a/ad6f8e78a059110c0837d6eef45c8955 + +------------------------------------------------------------------------------ +2022-02-16 15:35:42 +$ZNTE Form 8-K: Regulation FD Disclosure. As previously announced, Zanite Acquisition Corp. entered into a Business Combination Agreement with Embraer S.A. Embraer Aircraft Holding and EVE UAM, dated .. + +https://newsfilter.io/a/915ff8502b8a5c00b4664293ab6806ab + +------------------------------------------------------------------------------ +2022-02-16 15:35:30 +$HON Honeywell International was awarded a new government contract "Repair of NIIN 014601334", total contract value: $4,959.84 + +https://newsfilter.io/a/36789929e1dafa14b062a20b211e6aca + +------------------------------------------------------------------------------ +2022-02-16 15:35:02 +$TCFC $V Webinar: Bringing Credit Issuing In-House in 2022 + +https://newsfilter.io/a/5dd17c223e94a8dc364e899a0eb95bb2 + +------------------------------------------------------------------------------ +2022-02-16 15:34:51 +$NRUC Form 424B3 (prospectus ) filed with the SEC + +https://newsfilter.io/a/fe2b5bf1ac582d745f6fadb886126695 + +------------------------------------------------------------------------------ +2022-02-16 15:34:27 +$ZNTE Form DEFA14A (additional definitive proxy soliciting materials and rule 14(a)(12) material) filed with the SEC https://newsfilter.io/a/c0d62bba8d60e10984b83bd681c3a455 + +------------------------------------------------------------------------------ +2022-02-16 15:34:06 +$NGG NIAGARA MOHAWK POWER DECLARES PREFERRED STOCK DIVIDENDS + +https://newsfilter.io/a/60b80cf78256233915c4a4ecacfb2626 + +------------------------------------------------------------------------------ +2022-02-16 15:34:05 +$PM Philip Morris International to Publish a Video Presentation at the 2022 Consumer Analyst Group of New York Virtual Conference + +https://newsfilter.io/a/adeaf7a6816bdc25b346f15c098f90cb + +------------------------------------------------------------------------------ +2022-02-16 15:34:01 +$ACT $GNW Change in Long-Term Care Costs in Nebraska Mixed; Labor Market Shifts and Continued COVID-19 Pressure Affect Future Costs + +https://newsfilter.io/a/f640abccc455086ae4b43f43ad4254fb + +------------------------------------------------------------------------------ +2022-02-16 15:33:07 +$PDLB Form 3/A (initial statement of beneficial ownership of securities) filed with the SEC + +https://newsfilter.io/a/bea839aee3a4f30dc384c7a90e21c701 + +------------------------------------------------------------------------------ +2022-02-16 15:33:06 +$ALKT Texans Credit Union Partners with Alkami to Amplify Its Digital Banking Experience + +https://newsfilter.io/a/198d92eb6e1c481b825b830659af8698 +``` +--- diff --git a/website/content/terminal/reference/stocks/ba/trending.md b/website/content/terminal/reference/stocks/ba/trending.md new file mode 100644 index 000000000000..a26c91236089 --- /dev/null +++ b/website/content/terminal/reference/stocks/ba/trending.md @@ -0,0 +1,107 @@ +--- +title: trending +description: This page provides information on trending stocks. It features a database + extracted from Stocktwits displaying the trending stocks along with their respective + tickers, watchlist counts, and a range of different company names. +keywords: +- Stock trending +- Stocktwits +- watchlist count +- company name +- stock market +- market data +- stockist +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Stocks trending. [Source: Stocktwits] + +### Usage + +```python +trending +``` + +--- + +## Parameters + +This command has no parameters + + + +--- + +## Examples + +```python +2022 Feb 16, 10:50 (🦋) /stocks/ba/ $ trending + Trending Stocks +┏━━━━━━━━┳━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Ticker ┃ Watchlist Count ┃ Name ┃ +┡━━━━━━━━╇━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┩ +│ RBLX │ 57121 │ Roblox │ +├────────┼─────────────────┼────────────────────────────────────────────────┤ +│ SHOP │ 98777 │ Shopify │ +├────────┼─────────────────┼────────────────────────────────────────────────┤ +│ VIAC │ 18321 │ Viacom CBS, Inc │ +├────────┼─────────────────┼────────────────────────────────────────────────┤ +│ UPST │ 27649 │ Upstart │ +├────────┼─────────────────┼────────────────────────────────────────────────┤ +│ NVDA │ 350895 │ NVIDIA Corporation │ +├────────┼─────────────────┼────────────────────────────────────────────────┤ +│ ORGN │ 12019 │ Origin Materials │ +├────────┼─────────────────┼────────────────────────────────────────────────┤ +│ BCRX │ 36996 │ BioCryst Pharmaceuticals, Inc. │ +├────────┼─────────────────┼────────────────────────────────────────────────┤ +│ APPS │ 23164 │ Digital Turbine, Inc. │ +├────────┼─────────────────┼────────────────────────────────────────────────┤ +│ ABNB │ 44018 │ Airbnb │ +├────────┼─────────────────┼────────────────────────────────────────────────┤ +│ ACT │ 848 │ ADVISORSHARES T/VICE ETF │ +├────────┼─────────────────┼────────────────────────────────────────────────┤ +│ TTD │ 30946 │ The Trade Desk Inc │ +├────────┼─────────────────┼────────────────────────────────────────────────┤ +│ IBRX │ 10309 │ ImmunityBio Inc │ +├────────┼─────────────────┼────────────────────────────────────────────────┤ +│ GOLD │ 22601 │ Barrick Gold Corporation │ +├────────┼─────────────────┼────────────────────────────────────────────────┤ +│ SPCE │ 136010 │ Virgin Galactic Holdings Inc │ +├────────┼─────────────────┼────────────────────────────────────────────────┤ +│ AERC │ 5689 │ AeroClean Technologies Inc │ +├────────┼─────────────────┼────────────────────────────────────────────────┤ +│ KSCP │ 4896 │ Knightscope │ +├────────┼─────────────────┼────────────────────────────────────────────────┤ +│ AUPH │ 42395 │ Aurinia Pharmaceuticals Inc. │ +├────────┼─────────────────┼────────────────────────────────────────────────┤ +│ CROX │ 5925 │ CROCS Inc. │ +├────────┼─────────────────┼────────────────────────────────────────────────┤ +│ AI │ 20938 │ C3.ai Inc │ +├────────┼─────────────────┼────────────────────────────────────────────────┤ +│ ERIC │ 8548 │ LM Ericsson Telephone Co. │ +├────────┼─────────────────┼────────────────────────────────────────────────┤ +│ IMTE │ 7701 │ Integrated Media Technology Ltd │ +├────────┼─────────────────┼────────────────────────────────────────────────┤ +│ AMC │ 369648 │ AMC Entertainment │ +├────────┼─────────────────┼────────────────────────────────────────────────┤ +│ TIGR │ 10273 │ UP Fintech │ +├────────┼─────────────────┼────────────────────────────────────────────────┤ +│ MASI │ 1424 │ Masimo Corporation │ +├────────┼─────────────────┼────────────────────────────────────────────────┤ +│ BKKT │ 24761 │ Bakkt Holdings Inc - Ordinary Shares - Class A │ +├────────┼─────────────────┼────────────────────────────────────────────────┤ +│ SGLY │ 178 │ Sino Global Shipping America Ltd │ +├────────┼─────────────────┼────────────────────────────────────────────────┤ +│ BXRX │ 10174 │ Baudax Bio, Inc. │ +├────────┼─────────────────┼────────────────────────────────────────────────┤ +│ ARLP │ 1507 │ Alliance Resource Partners LP │ +├────────┼─────────────────┼────────────────────────────────────────────────┤ +│ WIX │ 6479 │ Wix │ +├────────┼─────────────────┼────────────────────────────────────────────────┤ +│ GNRC │ 3090 │ Generac Holdings Inc. │ +└────────┴─────────────────┴────────────────────────────────────────────────┘ +``` +--- diff --git a/website/content/terminal/reference/stocks/ba/watchlist.md b/website/content/terminal/reference/stocks/ba/watchlist.md new file mode 100644 index 000000000000..63002e501ef1 --- /dev/null +++ b/website/content/terminal/reference/stocks/ba/watchlist.md @@ -0,0 +1,59 @@ +--- +title: watchlist +description: This page documents the 'watchlist' function which allows users to fetch + and print other user's watchlist of stock posts from Reddit. It demonstrates usage, + explains different parameters including limit for posts, and provides examples of + its execution. +keywords: +- watchlist +- stock posts +- post limit +- Reddit source +- usage +- parameters +- examples +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Print other users watchlist. [Source: Reddit] + +### Usage + +```python +watchlist [-l LIMIT] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| limit | limit of posts with watch lists retrieved. | 5 | True | None | + + +--- + +## Examples + +```python +2022 Feb 16, 10:52 (🦋) /stocks/ba/ $ watchlist +2022-02-16 14:16:31 - Morning Update for Wednesday, 2/16/22 +https://old.reddit.com/r/StockMarket/comments/stwy68/morning_update_for_wednesday_21622/ + +2022-02-15 08:18:07 - Don't let family, friends, etc. influence you that you cannot make it + some general stock advice. +https://old.reddit.com/r/Daytrading/comments/ssy2sw/dont_let_family_friends_etc_influence_you_that/ + +2022-02-14 11:49:01 - Let's investigate stocks in Europe, Euronext ($ENX.PA) write up. +https://old.reddit.com/r/stocks/comments/ss8sxb/lets_investigate_stocks_in_europe_euronext_enxpa/ + +2022-02-13 21:46:46 - Looking for a platform that displays (or screens by) basic financial data with a good UI. +https://old.reddit.com/r/stocks/comments/srtwxi/looking_for_a_platform_that_displays_or_screens/ + +2022-02-11 17:31:13 - Clear Blue Technologies $CBLU.V $CBUTF QUICK LOOK, watchlist + portfolio addition 👀👀 👨🏽‍💻👩🏾‍💻 +https://old.reddit.com/r/RobinHoodPennyStocks/comments/sq4t5o/clear_blue_technologies_cbluv_cbutf_quick_look/ +``` +--- diff --git a/website/content/terminal/reference/stocks/ba/wsb.md b/website/content/terminal/reference/stocks/ba/wsb.md new file mode 100644 index 000000000000..3c745214d4c0 --- /dev/null +++ b/website/content/terminal/reference/stocks/ba/wsb.md @@ -0,0 +1,72 @@ +--- +title: wsb +description: This page serves as a guide on how to use the 'wsb' function, a tool + which prints what the WSB gang are up to in Reddit's subreddit wallstreetbets. It + includes parameters and examples. +keywords: +- wsb function guide +- WallStreetBets subreddit +- Limit post print +- Parameter description +- Python examples +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Print what WSB gang are up to in subreddit wallstreetbets. [Source: Reddit] + +### Usage + +```python +wsb [-l N_LIMIT] [--new] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| n_limit | limit of posts to print. | 10 | True | None | +| b_new | new flag, if true the posts retrieved are based on being more recent rather than their score. | False | True | None | + + +--- + +## Examples + +```python +2022 Feb 16, 10:52 (🦋) /stocks/ba/ $ wsb +2022-02-16 11:00:14 - Daily Discussion Thread for February 16, 2022 +https://old.reddit.com/r/wallstreetbets/comments/stt7n0/daily_discussion_thread_for_february_16_2022/ + +2022-02-12 11:45:28 - Most Anticipated Earnings Releases for the week beginning February 14th, 2022 +https://old.reddit.com/r/wallstreetbets/comments/sqpscq/most_anticipated_earnings_releases_for_the_week/ + +2022-02-16 14:01:48 - Since losing money is cool here. +https://old.reddit.com/r/wallstreetbets/comments/stwml0/since_loosing_money_is_cool_here/ + +2022-02-16 11:42:50 - How to become a WSB mod 🌈🌈🌈 +https://old.reddit.com/r/wallstreetbets/comments/sttx9d/how_to_become_a_wsb_mod/ + +2022-02-15 23:19:28 - I don't get why this inflation thing is freaking people out +https://old.reddit.com/r/wallstreetbets/comments/stggd7/i_dont_get_why_this_inflation_thing_is_freaking/) + +2022-02-16 13:56:23 - Justice Department Is Pursuing Wide-Ranging Investigation of Short-Sellers +https://old.reddit.com/r/wallstreetbets/comments/stwht2/justice_department_is_pursuing_wideranging/ + +2022-02-15 21:24:58 - i was up 100% on upst puts +https://old.reddit.com/r/wallstreetbets/comments/stdsqj/i_was_up_100_on_upst_puts/ + +2022-02-15 19:33:03 - The over short thesis hasn't gone anywhere. +https://old.reddit.com/r/wallstreetbets/comments/stb7gb/the_over_short_thesis_hasnt_gone_anywhere/ + +2022-02-16 14:15:24 - Make GME, not war. +https://old.reddit.com/r/wallstreetbets/comments/stwxa9/make_gme_not_war/ + +2022-02-16 11:24:54 - Free Money Hack - Can’t Go Tits Up +https://old.reddit.com/r/wallstreetbets/comments/sttmmb/free_money_hack_cant_go_tits_up/ +``` +--- diff --git a/website/versioned_docs/version-v3/terminal/reference/stocks/backtesting/_category_.json b/website/content/terminal/reference/stocks/backtesting/_category_.json similarity index 100% rename from website/versioned_docs/version-v3/terminal/reference/stocks/backtesting/_category_.json rename to website/content/terminal/reference/stocks/backtesting/_category_.json diff --git a/website/content/terminal/reference/stocks/backtesting/ema.md b/website/content/terminal/reference/stocks/backtesting/ema.md new file mode 100644 index 000000000000..a75e4800774f --- /dev/null +++ b/website/content/terminal/reference/stocks/backtesting/ema.md @@ -0,0 +1,37 @@ +--- +title: ema +description: Learn how to use the EMA strategy, where stock is bought when the price + is equivalent to EMA(l). Parameters such as EMA period, spy hold comparison, and + buy and hold comparison are covered extensively. +keywords: +- EMA Strategy +- Price EMA +- Stock Buying +- EMA Period +- Spy Hold Comparison +- Buy and Hold Comparison +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Strategy where stock is bought when Price EMA(l) + +### Usage + +```python +ema [-l LENGTH] [--spy] [--no_bench] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| length | EMA period to consider | 20 | True | None | +| spy | Flag to add spy hold comparison | False | True | None | +| no_bench | Flag to not show buy and hold comparison | False | True | None | + +--- diff --git a/website/content/terminal/reference/stocks/backtesting/emacross.md b/website/content/terminal/reference/stocks/backtesting/emacross.md new file mode 100644 index 000000000000..ecfd8d6240b0 --- /dev/null +++ b/website/content/terminal/reference/stocks/backtesting/emacross.md @@ -0,0 +1,42 @@ +--- +title: emacross +description: The emacross page provides documentation for a python script that crosses + between a long and a short Exponential Moving Average (EMA). It also includes information + on the parameters of the script including lengths of the long and short EMA periods, + spy hold comparison, buy hold comparison, and short selling operations. +keywords: +- emacross +- Exponential Moving Average +- EMA period +- long EMA +- short EMA +- spy hold comparison +- buy hold comparison +- short sell +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Cross between a long and a short Exponential Moving Average. + +### Usage + +```python +emacross [-l LONG] [-s SHORT] [--spy] [--no_bench] [--no_short] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| long | Long EMA period | 50 | True | None | +| short | Short EMA period | 20 | True | None | +| spy | Flag to add spy hold comparison | False | True | None | +| no_bench | Flag to not show buy and hold comparison | False | True | None | +| shortable | Flag that disables the short sell | True | True | None | + +--- diff --git a/website/content/terminal/reference/stocks/backtesting/rsi.md b/website/content/terminal/reference/stocks/backtesting/rsi.md new file mode 100644 index 000000000000..50d144063730 --- /dev/null +++ b/website/content/terminal/reference/stocks/backtesting/rsi.md @@ -0,0 +1,43 @@ +--- +title: rsi +description: Understanding the rsi strategy, which buys stock when it's less than + a threshold and shorts when it exceeds a threshold. Learn the usage, parameters, + and options involved in this strategy. +keywords: +- rsi +- stock market strategy +- short sell +- rsi calculation +- buy and hold comparison +- spy hold comparison +- rsi level +- periods for calculation +- threshold for buying and shorting stock +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Strategy that buys when the stock is less than a threshold and shorts when it exceeds a threshold. + +### Usage + +```python +rsi [-p PERIODS] [-u HIGH] [-l LOW] [--spy] [--no_bench] [--no_short] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| periods | Number of periods for RSI calculation | 14 | True | None | +| high | High (upper) RSI Level | 70 | True | None | +| low | Low RSI Level | 30 | True | None | +| spy | Flag to add spy hold comparison | False | True | None | +| no_bench | Flag to not show buy and hold comparison | False | True | None | +| shortable | Flag that disables the short sell | True | True | None | + +--- diff --git a/website/content/terminal/reference/stocks/backtesting/whatif.md b/website/content/terminal/reference/stocks/backtesting/whatif.md new file mode 100644 index 000000000000..6edc4d10869d --- /dev/null +++ b/website/content/terminal/reference/stocks/backtesting/whatif.md @@ -0,0 +1,38 @@ +--- +title: whatif +description: Learn about the 'whatif' command line tool which provides a hypothetical + scenario of having bought a certain number of shares on a specific date. This tool + can be used for backward investment analysis and scenario planning. +keywords: +- whatif +- shares +- share trading +- investment scenario +- investment analysis +- command line tool +- DATE_SHARES_ACQUIRED +- NUM_SHARES_ACQUIRED +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Displays what if scenario of having bought X shares at date Y + +### Usage + +```python +whatif [-d DATE_SHARES_ACQUIRED] [-n NUM_SHARES_ACQUIRED] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| date_shares_acquired | Date at which the shares were acquired | None | True | None | +| num_shares_acquired | Number of shares acquired | 1.0 | True | None | + +--- diff --git a/website/versioned_docs/version-v3/terminal/reference/stocks/ca/_category_.json b/website/content/terminal/reference/stocks/ca/_category_.json similarity index 100% rename from website/versioned_docs/version-v3/terminal/reference/stocks/ca/_category_.json rename to website/content/terminal/reference/stocks/ca/_category_.json diff --git a/website/content/terminal/reference/stocks/ca/add.md b/website/content/terminal/reference/stocks/ca/add.md new file mode 100644 index 000000000000..2bacaca9911d --- /dev/null +++ b/website/content/terminal/reference/stocks/ca/add.md @@ -0,0 +1,32 @@ +--- +title: add +description: This page provides the details on how to add and compare similar tickers + as well as the usage of 'add' command and a comprehensive description of its parameters. +keywords: +- Add operation +- Ticker comparison +- Command usage +- Parameters description +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Add similar tickers to compare with. + +### Usage + +```python +add [-s L_SIMILAR] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| l_similar | Tickers to add to similar list | | True | None | + +--- diff --git a/website/content/terminal/reference/stocks/ca/balance.md b/website/content/terminal/reference/stocks/ca/balance.md new file mode 100644 index 000000000000..6fdcf16dfbec --- /dev/null +++ b/website/content/terminal/reference/stocks/ca/balance.md @@ -0,0 +1,124 @@ +--- +title: balance +description: Generates and prints either a yearly or quarterly balance statement of + a company, and compares its financial data with similar companies. The balance command + also provides a way to specify a preferred timeframe. +keywords: +- balance statement +- financial data +- yearly balance +- quarterly balance +- company comparison +- financial comparison +- financial metrics +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Prints either yearly or quarterly balance statement the company, and compares it against similar companies. + +### Usage + +```python +balance [-q] [-t S_TIMEFRAME] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| b_quarter | Quarter financial data flag. | False | True | None | +| s_timeframe | Specify yearly/quarterly timeframe. Default is last. | None | True | None | + + +--- + +## Examples + +```python +2022 Feb 15, 08:35 (🦋) /stocks/ca/ $ balance + +Other available yearly timeframes are: 2017, 2018, 2019, 2020, 2021 + + Company Comparison +┌──────────────────────────────────────┬─────────┬────────┬─────────┐ +│ │ AAPL │ TSLA │ MSFT │ +├──────────────────────────────────────┼─────────┼────────┼─────────┤ +│ Cash & Short Term Investments │ 62.64B │ 18.05B │ 130.33B │ +├──────────────────────────────────────┼─────────┼────────┼─────────┤ +│ Cash & Short Term Investments Growth │ -31.15% │ -8.00% │ -4.54% │ +├──────────────────────────────────────┼─────────┼────────┼─────────┤ +│ Cash Only │ 26.91B │ 17.92B │ 14.22B │ +├──────────────────────────────────────┼─────────┼────────┼─────────┤ +│ Short-Term Investments │ 35.73B │ 131M │ 116.11B │ +├──────────────────────────────────────┼─────────┼────────┼─────────┤ +│ Cash & ST Investments / Total Assets │ 17.85% │ 29.05% │ 39.05% │ +├──────────────────────────────────────┼─────────┼────────┼─────────┤ +│ Total Accounts Receivable │ 51.51B │ 1.91B │ 38.04B │ +├──────────────────────────────────────┼─────────┼────────┼─────────┤ +│ Total Accounts Receivable Growth │ 37.55% │ 1.43% │ 18.84% │ +├──────────────────────────────────────┼─────────┼────────┼─────────┤ +│ Accounts Receivables, Net │ 26.28B │ 1.91B │ 38.04B │ +├──────────────────────────────────────┼─────────┼────────┼─────────┤ +│ Accounts Receivables, Gross │ 26.28B │ 1.91B │ 38.79B │ +├──────────────────────────────────────┼─────────┼────────┼─────────┤ +│ Bad Debt/Doubtful Accounts │ - │ - │ (751M) │ +├──────────────────────────────────────┼─────────┼────────┼─────────┤ +│ Other Receivable │ 25.23B │ - │ - │ +├──────────────────────────────────────┼─────────┼────────┼─────────┤ +│ Accounts Receivable Turnover │ 7.10 │ 28.14 │ 4.42 │ +├──────────────────────────────────────┼─────────┼────────┼─────────┤ +│ Inventories │ 6.58B │ 5.76B │ 2.64B │ +├──────────────────────────────────────┼─────────┼────────┼─────────┤ +│ Finished Goods │ 6.58B │ 1.28B │ 1.37B │ +├──────────────────────────────────────┼─────────┼────────┼─────────┤ +│ Work in Progress │ - │ 1.09B │ 79M │ +├──────────────────────────────────────┼─────────┼────────┼─────────┤ +│ Raw Materials │ - │ 3.39B │ 1.19B │ +├──────────────────────────────────────┼─────────┼────────┼─────────┤ +│ Progress Payments & Other │ - │ - │ - │ +├──────────────────────────────────────┼─────────┼────────┼─────────┤ +│ Other Current Assets │ 14.11B │ 1.38B │ 13.39B │ +├──────────────────────────────────────┼─────────┼────────┼─────────┤ +│ Miscellaneous Current Assets │ 14.11B │ 1.38B │ 13.39B │ +├──────────────────────────────────────┼─────────┼────────┼─────────┤ +│ Total Current Assets │ 134.84B │ 27.1B │ 184.41B │ +├──────────────────────────────────────┼─────────┼────────┼─────────┤ +│ Net Property, Plant & Equipment │ 49.53B │ 31.18B │ 70.8B │ +├──────────────────────────────────────┼─────────┼────────┼─────────┤ +│ Property, Plant & Equipment - Gross │ 119.81B │ 39.87B │ 122.15B │ +├──────────────────────────────────────┼─────────┼────────┼─────────┤ +│ Buildings │ 20.04B │ 4.68B │ 43.93B │ +├──────────────────────────────────────┼─────────┼────────┼─────────┤ +│ Land & Improvements │ - │ - │ 3.66B │ +├──────────────────────────────────────┼─────────┼────────┼─────────┤ +│ Computer Software and Equipment │ - │ 1.41B │ 51.25B │ +├──────────────────────────────────────┼─────────┼────────┼─────────┤ +│ Other Property, Plant & Equipment │ 11.02B │ 18.73B │ 12.23B │ +├──────────────────────────────────────┼─────────┼────────┼─────────┤ +│ Accumulated Depreciation │ 70.28B │ 8.69B │ 51.35B │ +├──────────────────────────────────────┼─────────┼────────┼─────────┤ +│ Total Investments and Advances │ 127.88B │ 223M │ 6.03B │ +├──────────────────────────────────────┼─────────┼────────┼─────────┤ +│ Other Long-Term Investments │ 127.88B │ 223M │ 6.03B │ +├──────────────────────────────────────┼─────────┼────────┼─────────┤ +│ Long-Term Note Receivables │ - │ 299M │ 3.4B │ +├──────────────────────────────────────┼─────────┼────────┼─────────┤ +│ Intangible Assets │ - │ 1.72B │ 57.51B │ +├──────────────────────────────────────┼─────────┼────────┼─────────┤ +│ Net Goodwill │ - │ 200M │ 49.71B │ +├──────────────────────────────────────┼─────────┼────────┼─────────┤ +│ Net Other Intangibles │ - │ - │ 7.8B │ +├──────────────────────────────────────┼─────────┼────────┼─────────┤ +│ Other Assets │ 38.76B │ 1.62B │ 4.45B │ +├──────────────────────────────────────┼─────────┼────────┼─────────┤ +│ Total Assets │ 351B │ 62.13B │ 333.78B │ +├──────────────────────────────────────┼─────────┼────────┼─────────┤ +│ Total Assets Growth │ 8.37% │ 19.14% │ 10.78% │ +└──────────────────────────────────────┴─────────┴────────┴─────────┘ +``` +--- diff --git a/website/content/terminal/reference/stocks/ca/cashflow.md b/website/content/terminal/reference/stocks/ca/cashflow.md new file mode 100644 index 000000000000..d1391213f3be --- /dev/null +++ b/website/content/terminal/reference/stocks/ca/cashflow.md @@ -0,0 +1,86 @@ +--- +title: cashflow +description: The documentation explains usage of the cashflow tool, which provides + yearly or quarterly cashflow statements for companies and allows for comparison + against similar companies. +keywords: +- cashflow statement +- company financial data +- financial comparison +- quarterly financial data +- yearly financial data +- financial timeframe +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Prints either yearly or quarterly cashflow statement the company, and compares it against similar companies. + +### Usage + +```python +cashflow [-q] [-t S_TIMEFRAME] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| b_quarter | Quarter financial data flag. | False | True | None | +| s_timeframe | Specify year/quarter of the cashflow statement to be retrieved. The format for year is YYYY and for quarter is DD-MMM-YYY (for example, 30-Sep-2021). Default is last year/quarter. | None | True | None | + + +--- + +## Examples + +```python +2022 Feb 15, 08:35 (🦋) /stocks/ca/ $ cashflow +Other available yearly timeframes are: 2017, 2018, 2019, 2020, 2021 + + Cashflow Comparison +┌────────────────────────────────────────┬──────────┬─────────┬─────────┐ +│ │ AAPL │ TSLA │ MSFT │ +├────────────────────────────────────────┼──────────┼─────────┼─────────┤ +│ Net Income before Extraordinaries │ 94.68B │ 5.64B │ 61.27B │ +├────────────────────────────────────────┼──────────┼─────────┼─────────┤ +│ Net Income Growth │ 64.92% │ 554.76% │ 38.37% │ +├────────────────────────────────────────┼──────────┼─────────┼─────────┤ +│ Depreciation, Depletion & Amortization │ 11.28B │ 2.91B │ 10.9B │ +├────────────────────────────────────────┼──────────┼─────────┼─────────┤ +│ Depreciation and Depletion │ 11.28B │ 1.91B │ 9.3B │ +├────────────────────────────────────────┼──────────┼─────────┼─────────┤ +│ Amortization of Intangible Assets │ - │ 1B │ 1.6B │ +├────────────────────────────────────────┼──────────┼─────────┼─────────┤ +│ Deferred Taxes & Investment Tax Credit │ (4.77B) │ - │ (150M) │ +├────────────────────────────────────────┼──────────┼─────────┼─────────┤ +│ Deferred Taxes │ (4.77B) │ - │ (150M) │ +├────────────────────────────────────────┼──────────┼─────────┼─────────┤ +│ Investment Tax Credit │ - │ - │ - │ +├────────────────────────────────────────┼──────────┼─────────┼─────────┤ +│ Other Funds │ 7.76B │ 2.42B │ 5.66B │ +├────────────────────────────────────────┼──────────┼─────────┼─────────┤ +│ Funds from Operations │ 108.95B │ 10.98B │ 77.68B │ +├────────────────────────────────────────┼──────────┼─────────┼─────────┤ +│ Extraordinaries │ - │ - │ - │ +├────────────────────────────────────────┼──────────┼─────────┼─────────┤ +│ Changes in Working Capital │ (4.91B) │ 518M │ (936M) │ +├────────────────────────────────────────┼──────────┼─────────┼─────────┤ +│ Receivables │ (14.03B) │ (130M) │ (6.48B) │ +├────────────────────────────────────────┼──────────┼─────────┼─────────┤ +│ Accounts Payable │ 12.33B │ 4.58B │ 2.8B │ +├────────────────────────────────────────┼──────────┼─────────┼─────────┤ +│ Other Assets/Liabilities │ (567M) │ (2.22B) │ 5.79B │ +├────────────────────────────────────────┼──────────┼─────────┼─────────┤ +│ Net Operating Cash Flow │ 104.04B │ 11.5B │ 76.74B │ +├────────────────────────────────────────┼──────────┼─────────┼─────────┤ +│ Net Operating Cash Flow Growth │ 28.96% │ 93.45% │ 26.48% │ +├────────────────────────────────────────┼──────────┼─────────┼─────────┤ +│ Net Operating Cash Flow / Sales │ 28.44% │ 21.36% │ 45.65% │ +└────────────────────────────────────────┴──────────┴─────────┴─────────┘ +``` +--- diff --git a/website/content/terminal/reference/stocks/ca/financial.md b/website/content/terminal/reference/stocks/ca/financial.md new file mode 100644 index 000000000000..51494055bbaf --- /dev/null +++ b/website/content/terminal/reference/stocks/ca/financial.md @@ -0,0 +1,50 @@ +--- +title: financial +description: This page provides an explanation of the 'financial' command in Python, + including its usage, parameters, and examples. The 'financial' command prints screener + data of similar companies, aiding in financial analysis and investment decisions. +keywords: +- financial command +- stock screener +- investment decisions +- Finviz +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Prints screener data of similar companies. [Source: Finviz] + +### Usage + +```python +financial +``` + +--- + +## Parameters + +This command has no parameters + + + +--- + +## Examples + +```python +2022 Feb 15, 08:36 (🦋) /stocks/ca/ $ financial + Stock Screener +┌────────┬──────────────────┬──────────┬──────┬──────┬──────┬────────┬─────────┬───────────┬─────────┬─────────┬────────┬──────────┬──────────┬────────┬────────┬─────────────┐ +│ Ticker │ Market Cap │ Dividend │ ROA │ ROE │ ROI │ Curr R │ Quick R │ LTDebt/Eq │ Debt/Eq │ Gross M │ Oper M │ Profit M │ Earnings │ Price │ Change │ Volume │ +├────────┼──────────────────┼──────────┼──────┼──────┼──────┼────────┼─────────┼───────────┼─────────┼─────────┼────────┼──────────┼──────────┼────────┼────────┼─────────────┤ +│ AAPL │ 2812900000000.00 │ 0.01 │ 0.29 │ 1.50 │ 0.50 │ 1.00 │ 1.00 │ 1.48 │ 1.71 │ 0.43 │ 0.31 │ 0.27 │ Jan 27/a │ 168.88 │ 0.00 │ 86185528.00 │ +├────────┼──────────────────┼──────────┼──────┼──────┼──────┼────────┼─────────┼───────────┼─────────┼─────────┼────────┼──────────┼──────────┼────────┼────────┼─────────────┤ +│ MSFT │ 2266600000000.00 │ 0.01 │ 0.22 │ 0.48 │ 0.28 │ 2.20 │ 2.20 │ 0.38 │ 0.42 │ 0.69 │ 0.42 │ 0.39 │ Jan 25/a │ 295.00 │ -0.00 │ 36359488.00 │ +├────────┼──────────────────┼──────────┼──────┼──────┼──────┼────────┼─────────┼───────────┼─────────┼─────────┼────────┼──────────┼──────────┼────────┼────────┼─────────────┤ +│ TSLA │ 879490000000.00 │ None │ 0.10 │ 0.21 │ 0.16 │ 1.40 │ 1.10 │ 0.17 │ 0.23 │ 0.25 │ 0.12 │ 0.10 │ Jan 26/a │ 875.76 │ 0.02 │ 22585472.00 │ +└────────┴──────────────────┴──────────┴──────┴──────┴──────┴────────┴─────────┴───────────┴─────────┴─────────┴────────┴──────────┴──────────┴────────┴────────┴─────────────┘ +``` +--- diff --git a/website/content/terminal/reference/stocks/ca/get.md b/website/content/terminal/reference/stocks/ca/get.md new file mode 100644 index 000000000000..7b364c0c7278 --- /dev/null +++ b/website/content/terminal/reference/stocks/ca/get.md @@ -0,0 +1,43 @@ +--- +title: get +description: A document page explaining the usage of the 'get' command in python. + It allows users to fetch similar companies from a data source for comparison. Instructions + and parameters for limiting the stocks and filtering by U.S. stock exchanges, Industry + and Sector are also included. +keywords: +- get +- similar companies +- data source +- Finviz +- parameters +- Polygon +- stocks +- US stock exchanges +- Industry +- Sector +- limit +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Get similar companies from selected data source (default: Finviz) to compare with. + +### Usage + +```python +get [-u] [-n] [-l LIMIT] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| us_only | Show only stocks from the US stock exchanges. Works only with Polygon | False | True | None | +| b_no_country | Similar stocks from finviz using only Industry and Sector. | False | True | None | +| limit | Limit of stocks to retrieve. | 10 | True | None | + +--- diff --git a/website/content/terminal/reference/stocks/ca/hcorr.md b/website/content/terminal/reference/stocks/ca/hcorr.md new file mode 100644 index 000000000000..7d001cd27733 --- /dev/null +++ b/website/content/terminal/reference/stocks/ca/hcorr.md @@ -0,0 +1,42 @@ +--- +title: hcorr +description: The page presents a correlation heatmap 'hcorr' based on historical price + comparison between similar companies. This tool assists in understanding and visualizing + stock market trends. +keywords: +- hcorr +- correlation heatmap +- price comparison +- historical data +- stock market trends +- financial tools +- data visualization +- type_candle +- display_full_matrix +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Correlation heatmap based on historical price comparison between similar companies. + +### Usage + +```python +hcorr [-t {o,h,l,c,a}] [-s START] [--display-full-matrix] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| type_candle | Candle data to use: o-open, h-high, l-low, c-close, a-adjusted close, r-returns. | a | True | o, h, l, c, a | +| start | The starting date (format YYYY-MM-DD) of the stock | 2021-11-24 | True | None | +| display_full_matrix | Display all matrix values, rather than masking off half. | False | True | None | + +![hcorr](https://user-images.githubusercontent.com/46355364/154073186-45336f5f-85e1-4cb9-9307-9694295b1f80.png) + +--- diff --git a/website/content/terminal/reference/stocks/ca/historical.md b/website/content/terminal/reference/stocks/ca/historical.md new file mode 100644 index 000000000000..013a8230b13d --- /dev/null +++ b/website/content/terminal/reference/stocks/ca/historical.md @@ -0,0 +1,43 @@ +--- +title: historical +description: A guide for understanding and using the 'historical' feature for price + comparison between similar companies, includes usage, parameters details and graphical + representation. +keywords: +- Price comparison +- Historical prices +- Stock analysis +- Normalization +- Candle data +- Starting date +- High, low, close prices +- Company comparison +- Open-high-low-close +- Adjusted close +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Historical price comparison between similar companies. + +### Usage + +```python +historical [-t {o,h,l,c,a}] [-n] [-s START] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| type_candle | Candle data to use: o-open, h-high, l-low, c-close, a-adjusted close. | a | True | o, h, l, c, a | +| normalize | Flag to normalize all prices on same 0-1 scale | False | True | None | +| start | The starting date (format YYYY-MM-DD) of the stock | 2021-11-24 | True | None | + +![historical](https://user-images.githubusercontent.com/46355364/154073378-935eddd4-167e-48e8-9e3d-34029e5ba42f.png) + +--- diff --git a/website/content/terminal/reference/stocks/ca/income.md b/website/content/terminal/reference/stocks/ca/income.md new file mode 100644 index 000000000000..9f14db550f29 --- /dev/null +++ b/website/content/terminal/reference/stocks/ca/income.md @@ -0,0 +1,168 @@ +--- +title: income +description: This page provides a guide on how to use the 'income' function which + prints either yearly or quarterly income statements for a company, and compares + it against similar companies. The guide includes usage, parameters, and examples + with real company data. +keywords: +- income statement +- company financial data +- yearly report +- quarterly report +- income indices +- financial comparison +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Prints either yearly or quarterly income statement the company, and compares it against similar companies. + +### Usage + +```python +income [-q] [-t S_TIMEFRAME] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| b_quarter | Quarter financial data flag. | False | True | None | +| s_timeframe | Specify yearly/quarterly timeframe. Default is last. | None | True | None | + + +--- + +## Examples + +```python +2022 Feb 15, 08:39 (🦋) /stocks/ca/ $ historical + + +2022 Feb 15, 08:39 (🦋) /stocks/ca/ $ income +Other available yearly timeframes are: 2017, 2018, 2019, 2020, 2021 + + Income Data +┌───────────────────────────────────────────┬─────────┬─────────┬─────────┬─────────┐ +│ │ AAPL │ GOOGL │ TSLA │ MSFT │ +├───────────────────────────────────────────┼─────────┼─────────┼─────────┼─────────┤ +│ Sales/Revenue │ 365.82B │ 257.49B │ 53.82B │ 168.09B │ +├───────────────────────────────────────────┼─────────┼─────────┼─────────┼─────────┤ +│ Sales Growth │ 33.44% │ 41.21% │ 70.67% │ 17.53% │ +├───────────────────────────────────────────┼─────────┼─────────┼─────────┼─────────┤ +│ Cost of Goods Sold (COGS) incl. D&A │ 212.98B │ 110.94B │ 40.22B │ 52.23B │ +├───────────────────────────────────────────┼─────────┼─────────┼─────────┼─────────┤ +│ COGS Growth │ 25.18% │ 30.93% │ 61.48% │ 13.36% │ +├───────────────────────────────────────────┼─────────┼─────────┼─────────┼─────────┤ +│ COGS excluding D&A │ 201.7B │ 98.5B │ 37.31B │ 41.33B │ +├───────────────────────────────────────────┼─────────┼─────────┼─────────┼─────────┤ +│ Depreciation & Amortization Expense │ 11.28B │ 12.44B │ 2.91B │ 10.9B │ +├───────────────────────────────────────────┼─────────┼─────────┼─────────┼─────────┤ +│ Depreciation │ 11.28B │ 11.56B │ 1.91B │ 9.3B │ +├───────────────────────────────────────────┼─────────┼─────────┼─────────┼─────────┤ +│ Amortization of Intangibles │ - │ 886M │ 1B │ 1.6B │ +├───────────────────────────────────────────┼─────────┼─────────┼─────────┼─────────┤ +│ Gross Income │ 152.84B │ 146.55B │ 13.61B │ 115.86B │ +├───────────────────────────────────────────┼─────────┼─────────┼─────────┼─────────┤ +│ Gross Income Growth │ 46.95% │ 50.12% │ 105.22% │ 19.52% │ +├───────────────────────────────────────────┼─────────┼─────────┼─────────┼─────────┤ +│ Gross Profit Margin │ 41.78% │ 56.91% │ 25.28% │ 68.93% │ +├───────────────────────────────────────────┼─────────┼─────────┼─────────┼─────────┤ +│ SG&A Expense │ 43.89B │ 67.98B │ 7.11B │ 45.94B │ +├───────────────────────────────────────────┼─────────┼─────────┼─────────┼─────────┤ +│ SGA Growth │ 13.50% │ 20.17% │ 53.36% │ 4.46% │ +├───────────────────────────────────────────┼─────────┼─────────┼─────────┼─────────┤ +│ Research & Development │ 21.91B │ 31.56B │ 2.59B │ 20.72B │ +├───────────────────────────────────────────┼─────────┼─────────┼─────────┼─────────┤ +│ Other SG&A │ 21.97B │ - │ - │ 25.22B │ +├───────────────────────────────────────────┼─────────┼─────────┼─────────┼─────────┤ +│ Other Operating Expense │ - │ - │ - │ - │ +├───────────────────────────────────────────┼─────────┼─────────┼─────────┼─────────┤ +│ Unusual Expense │ - │ (10.4B) │ (40M) │ (1.04B) │ +├───────────────────────────────────────────┼─────────┼─────────┼─────────┼─────────┤ +│ EBIT after Unusual Expense │ - │ 88.96B │ 6.54B │ 70.96B │ +├───────────────────────────────────────────┼─────────┼─────────┼─────────┼─────────┤ +│ Non Operating Income/Expense │ 60M │ 284M │ 122M │ 357M │ +├───────────────────────────────────────────┼─────────┼─────────┼─────────┼─────────┤ +│ Non-Operating Interest Income │ 2.84B │ 1.5B │ 56M │ 2.13B │ +├───────────────────────────────────────────┼─────────┼─────────┼─────────┼─────────┤ +│ Equity in Affiliates (Pretax) │ - │ 334M │ - │ - │ +├───────────────────────────────────────────┼─────────┼─────────┼─────────┼─────────┤ +│ Interest Expense │ 2.65B │ 346M │ 371M │ 2.35B │ +├───────────────────────────────────────────┼─────────┼─────────┼─────────┼─────────┤ +│ Interest Expense Growth │ -7.94% │ 156.30% │ -50.40% │ -9.46% │ +├───────────────────────────────────────────┼─────────┼─────────┼─────────┼─────────┤ +│ Gross Interest Expense │ 2.65B │ 509M │ 424M │ 2.35B │ +├───────────────────────────────────────────┼─────────┼─────────┼─────────┼─────────┤ +│ Interest Capitalized │ - │ 163M │ 53M │ - │ +├───────────────────────────────────────────┼─────────┼─────────┼─────────┼─────────┤ +│ Pretax Income │ 109.21B │ 90.73B │ 6.34B │ 71.1B │ +├───────────────────────────────────────────┼─────────┼─────────┼─────────┼─────────┤ +│ Pretax Income Growth │ 62.77% │ 88.71% │ 449.65% │ 34.06% │ +├───────────────────────────────────────────┼─────────┼─────────┼─────────┼─────────┤ +│ Pretax Margin │ 29.85% │ 35.24% │ 11.78% │ 42.30% │ +├───────────────────────────────────────────┼─────────┼─────────┼─────────┼─────────┤ +│ Income Tax │ 14.53B │ 14.7B │ 699M │ 9.83B │ +├───────────────────────────────────────────┼─────────┼─────────┼─────────┼─────────┤ +│ Income Tax - Current Domestic │ 9.88B │ 10.13B │ 9M │ 4.51B │ +├───────────────────────────────────────────┼─────────┼─────────┼─────────┼─────────┤ +│ Income Tax - Current Foreign │ 9.42B │ 2.69B │ 839M │ 5.47B │ +├───────────────────────────────────────────┼─────────┼─────────┼─────────┼─────────┤ +│ Income Tax - Deferred Domestic │ (7.51B) │ 2.02B │ - │ (179M) │ +├───────────────────────────────────────────┼─────────┼─────────┼─────────┼─────────┤ +│ Income Tax - Deferred Foreign │ 2.74B │ (135M) │ (149M) │ 29M │ +├───────────────────────────────────────────┼─────────┼─────────┼─────────┼─────────┤ +│ Income Tax Credits │ - │ - │ - │ - │ +├───────────────────────────────────────────┼─────────┼─────────┼─────────┼─────────┤ +│ Equity in Affiliates │ - │ - │ - │ - │ +├───────────────────────────────────────────┼─────────┼─────────┼─────────┼─────────┤ +│ Other After Tax Income (Expense) │ - │ - │ 5M │ - │ +├───────────────────────────────────────────┼─────────┼─────────┼─────────┼─────────┤ +│ Consolidated Net Income │ 94.68B │ 76.03B │ 5.65B │ 61.27B │ +├───────────────────────────────────────────┼─────────┼─────────┼─────────┼─────────┤ +│ Minority Interest Expense │ - │ - │ 125M │ - │ +├───────────────────────────────────────────┼─────────┼─────────┼─────────┼─────────┤ +│ Net Income │ 94.68B │ 76.03B │ 5.52B │ 61.27B │ +├───────────────────────────────────────────┼─────────┼─────────┼─────────┼─────────┤ +│ Net Income Growth │ 64.92% │ 88.81% │ 700.58% │ 38.37% │ +├───────────────────────────────────────────┼─────────┼─────────┼─────────┼─────────┤ +│ Net Margin Growth │ 25.88% │ 29.53% │ 10.26% │ 36.45% │ +├───────────────────────────────────────────┼─────────┼─────────┼─────────┼─────────┤ +│ Extraordinaries & Discontinued Operations │ - │ - │ - │ - │ +├───────────────────────────────────────────┼─────────┼─────────┼─────────┼─────────┤ +│ Extra Items & Gain/Loss Sale Of Assets │ - │ - │ - │ - │ +├───────────────────────────────────────────┼─────────┼─────────┼─────────┼─────────┤ +│ Cumulative Effect - Accounting Chg │ - │ - │ - │ - │ +├───────────────────────────────────────────┼─────────┼─────────┼─────────┼─────────┤ +│ Discontinued Operations │ - │ - │ - │ - │ +├───────────────────────────────────────────┼─────────┼─────────┼─────────┼─────────┤ +│ Net Income After Extraordinaries │ 94.68B │ 76.03B │ 5.52B │ 61.27B │ +├───────────────────────────────────────────┼─────────┼─────────┼─────────┼─────────┤ +│ Preferred Dividends │ - │ - │ - │ - │ +├───────────────────────────────────────────┼─────────┼─────────┼─────────┼─────────┤ +│ Net Income Available to Common │ 94.68B │ 76.03B │ 5.52B │ 61.27B │ +├───────────────────────────────────────────┼─────────┼─────────┼─────────┼─────────┤ +│ EPS (Basic) │ 5.67 │ 113.88 │ 5.6 │ 8.12 │ +├───────────────────────────────────────────┼─────────┼─────────┼─────────┼─────────┤ +│ EPS (Basic) Growth │ 71.34% │ 79.48% │ 657.49% │ 39.52% │ +├───────────────────────────────────────────┼─────────┼─────────┼─────────┼─────────┤ +│ Basic Shares Outstanding │ 16.7B │ 667.65M │ 986M │ 7.55B │ +├───────────────────────────────────────────┼─────────┼─────────┼─────────┼─────────┤ +│ EPS (Diluted) │ 5.61 │ 112.2 │ 4.89 │ 8.05 │ +├───────────────────────────────────────────┼─────────┼─────────┼─────────┼─────────┤ +│ EPS (Diluted) Growth │ 71.40% │ 91.42% │ 667.98% │ 39.73% │ +├───────────────────────────────────────────┼─────────┼─────────┼─────────┼─────────┤ +│ Diluted Shares Outstanding │ 16.86B │ 677.67M │ 1.13B │ 7.61B │ +├───────────────────────────────────────────┼─────────┼─────────┼─────────┼─────────┤ +│ EBITDA │ 120.23B │ 91.01B │ 9.41B │ 80.82B │ +├───────────────────────────────────────────┼─────────┼─────────┼─────────┼─────────┤ +│ EBITDA Growth │ 57.38% │ 66.24% │ 117.96% │ 23.84% │ +├───────────────────────────────────────────┼─────────┼─────────┼─────────┼─────────┤ +│ EBITDA Margin │ 32.87% │ 35.34% │ 17.48% │ 48.08% │ +└───────────────────────────────────────────┴─────────┴─────────┴─────────┴─────────┘ +``` +--- diff --git a/website/content/terminal/reference/stocks/ca/overview.md b/website/content/terminal/reference/stocks/ca/overview.md new file mode 100644 index 000000000000..18cf8ae1befd --- /dev/null +++ b/website/content/terminal/reference/stocks/ca/overview.md @@ -0,0 +1,58 @@ +--- +title: overview +description: This overview provides a snapshot of similar companies using the 'overview' + command, including critical data such as stock price, market cap, P/E ratio, and + more. Data sourced from Finviz. +keywords: +- stock screener +- finviz +- company data +- stock market +- financial data +- stock information +- company overview +- market cap +- PE ratio +- stock price +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Prints screener data of similar companies. [Source: Finviz] + +### Usage + +```python +overview +``` + +--- + +## Parameters + +This command has no parameters + + + +--- + +## Examples + +```python +2022 Feb 15, 08:41 (🦋) /stocks/ca/ $ overview + Stock Screener +┌────────┬───────────────────────┬────────────────────────┬────────────────────────────────┬─────────┬──────────────────┬────────┬─────────┬────────┬─────────────┐ +│ Ticker │ Company │ Sector │ Industry │ Country │ Market Cap │ P/E │ Price │ Change │ Volume │ +├────────┼───────────────────────┼────────────────────────┼────────────────────────────────┼─────────┼──────────────────┼────────┼─────────┼────────┼─────────────┤ +│ AAPL │ Apple Inc. │ Technology │ Consumer Electronics │ USA │ 2812900000000.00 │ 28.04 │ 168.88 │ 0.00 │ 86185528.00 │ +├────────┼───────────────────────┼────────────────────────┼────────────────────────────────┼─────────┼──────────────────┼────────┼─────────┼────────┼─────────────┤ +│ GOOGL │ Alphabet Inc. │ Communication Services │ Internet Content & Information │ USA │ 1849330000000.00 │ 24.15 │ 2710.52 │ 0.01 │ 1715054.00 │ +├────────┼───────────────────────┼────────────────────────┼────────────────────────────────┼─────────┼──────────────────┼────────┼─────────┼────────┼─────────────┤ +│ MSFT │ Microsoft Corporation │ Technology │ Software - Infrastructure │ USA │ 2266600000000.00 │ 31.39 │ 295.00 │ -0.00 │ 36359488.00 │ +├────────┼───────────────────────┼────────────────────────┼────────────────────────────────┼─────────┼──────────────────┼────────┼─────────┼────────┼─────────────┤ +│ TSLA │ Tesla, Inc. │ Consumer Cyclical │ Auto Manufacturers │ USA │ 879490000000.00 │ 177.93 │ 875.76 │ 0.02 │ 22585472.00 │ +└────────┴───────────────────────┴────────────────────────┴────────────────────────────────┴─────────┴──────────────────┴────────┴─────────┴────────┴─────────────┘ +``` +--- diff --git a/website/content/terminal/reference/stocks/ca/ownership.md b/website/content/terminal/reference/stocks/ca/ownership.md new file mode 100644 index 000000000000..88b1ff7cacdd --- /dev/null +++ b/website/content/terminal/reference/stocks/ca/ownership.md @@ -0,0 +1,60 @@ +--- +title: ownership +description: The 'ownership' documentation provides a guide on how to print stock + screener data of similar companies. It explains the usage, parameters, and provides + examples. +keywords: +- Stocks +- Market data +- Ownership +- Finviz +- Programming +- Coding examples +- Financial data +- Insider trades +- Technical usage +- Command guide +- Financial screener +- Documentation +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Prints screener data of similar companies. [Source: Finviz] + +### Usage + +```python +ownership +``` + +--- + +## Parameters + +This command has no parameters + + + +--- + +## Examples + +```python +2022 Feb 15, 08:41 (🦋) /stocks/ca/ $ ownership + Stock Screener +┌────────┬──────────────────┬────────────────┬────────────────┬─────────────┬───────────────┬──────────┬────────────┬─────────────┬─────────────┬──────────────┬─────────┬────────┬─────────────┐ +│ Ticker │ Market Cap │ Outstanding │ Float │ Insider Own │ Insider Trans │ Inst Own │ Inst Trans │ Float Short │ Short Ratio │ Avg Volume │ Price │ Change │ Volume │ +├────────┼──────────────────┼────────────────┼────────────────┼─────────────┼───────────────┼──────────┼────────────┼─────────────┼─────────────┼──────────────┼─────────┼────────┼─────────────┤ +│ AAPL │ 2812900000000.00 │ 16390000000.00 │ 16310000000.00 │ 0.00 │ -0.15 │ 0.59 │ 0.00 │ 0.01 │ 0.89 │ 102890000.00 │ 168.88 │ 0.00 │ 86185528.00 │ +├────────┼──────────────────┼────────────────┼────────────────┼─────────────┼───────────────┼──────────┼────────────┼─────────────┼─────────────┼──────────────┼─────────┼────────┼─────────────┤ +│ GOOGL │ 1849330000000.00 │ 662660000.00 │ 615700000.00 │ 0.00 │ 0.00 │ 0.80 │ 0.00 │ 0.00 │ 1.22 │ 1810000.00 │ 2710.52 │ 0.01 │ 1715054.00 │ +├────────┼──────────────────┼────────────────┼────────────────┼─────────────┼───────────────┼──────────┼────────────┼─────────────┼─────────────┼──────────────┼─────────┼────────┼─────────────┤ +│ MSFT │ 2266600000000.00 │ 7500000000.00 │ 7480000000.00 │ 0.00 │ -0.19 │ 0.72 │ 0.00 │ 0.01 │ 1.14 │ 35290000.00 │ 295.00 │ -0.00 │ 36359488.00 │ +├────────┼──────────────────┼────────────────┼────────────────┼─────────────┼───────────────┼──────────┼────────────┼─────────────┼─────────────┼──────────────┼─────────┼────────┼─────────────┤ +│ TSLA │ 879490000000.00 │ 1000000000.00 │ 833120000.00 │ 0.00 │ -0.94 │ 0.41 │ -0.01 │ 0.03 │ 0.91 │ 26320000.00 │ 875.76 │ 0.02 │ 22585472.00 │ +└────────┴──────────────────┴────────────────┴────────────────┴─────────────┴───────────────┴──────────┴────────────┴─────────────┴─────────────┴──────────────┴─────────┴────────┴─────────────┘ +``` +--- diff --git a/website/content/terminal/reference/stocks/ca/performance.md b/website/content/terminal/reference/stocks/ca/performance.md new file mode 100644 index 000000000000..6dd37a9d562b --- /dev/null +++ b/website/content/terminal/reference/stocks/ca/performance.md @@ -0,0 +1,55 @@ +--- +title: performance +description: This page provides information on the 'performance' command in the Python + programming language. It displays screener data from Finviz for similar companies, + giving a comprehensive performance overview including parameters such as Perf Week, + Perf Month, Perf Quart, Perf Half, Perf Year, and more. The command is shown in + use along with sample output. +keywords: +- performance command +- Finviz +- stock screener +- screener data +- company performance +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Prints screener data of similar companies. [Source: Finviz] + +### Usage + +```python +performance +``` + +--- + +## Parameters + +This command has no parameters + + + +--- + +## Examples + +```python +2022 Feb 15, 08:42 (🦋) /stocks/ca/ $ performance + Stock Screener +┌────────┬───────────┬────────────┬────────────┬───────────┬───────────┬──────────┬──────────────┬──────────────┬───────┬──────────────┬────────────┬─────────┬────────┬─────────────┐ +│ Ticker │ Perf Week │ Perf Month │ Perf Quart │ Perf Half │ Perf Year │ Perf YTD │ Volatility W │ Volatility M │ Recom │ Avg Volume │ Rel Volume │ Price │ Change │ Volume │ +├────────┼───────────┼────────────┼────────────┼───────────┼───────────┼──────────┼──────────────┼──────────────┼───────┼──────────────┼────────────┼─────────┼────────┼─────────────┤ +│ AAPL │ -0.02 │ -0.02 │ 0.13 │ 0.12 │ 0.27 │ -0.05 │ 0.02 │ 0.03 │ 1.80 │ 102890000.00 │ 0.84 │ 168.88 │ 0.00 │ 86185528.00 │ +├────────┼───────────┼────────────┼────────────┼───────────┼───────────┼──────────┼──────────────┼──────────────┼───────┼──────────────┼────────────┼─────────┼────────┼─────────────┤ +│ GOOGL │ -0.03 │ -0.02 │ -0.09 │ -0.02 │ 0.28 │ -0.06 │ 0.03 │ 0.03 │ 1.70 │ 1810000.00 │ 0.95 │ 2710.52 │ 0.01 │ 1715054.00 │ +├────────┼───────────┼────────────┼────────────┼───────────┼───────────┼──────────┼──────────────┼──────────────┼───────┼──────────────┼────────────┼─────────┼────────┼─────────────┤ +│ MSFT │ -0.02 │ -0.03 │ -0.12 │ 0.00 │ 0.21 │ -0.12 │ 0.02 │ 0.03 │ 1.60 │ 35290000.00 │ 1.03 │ 295.00 │ -0.00 │ 36359488.00 │ +├────────┼───────────┼────────────┼────────────┼───────────┼───────────┼──────────┼──────────────┼──────────────┼───────┼──────────────┼────────────┼─────────┼────────┼─────────────┤ +│ TSLA │ -0.03 │ -0.15 │ -0.15 │ 0.28 │ 0.10 │ -0.17 │ 0.05 │ 0.06 │ 2.60 │ 26320000.00 │ 0.85 │ 875.76 │ 0.02 │ 22585472.00 │ +└────────┴───────────┴────────────┴────────────┴───────────┴───────────┴──────────┴──────────────┴──────────────┴───────┴──────────────┴────────────┴─────────┴────────┴─────────────┘ +``` +--- diff --git a/website/content/terminal/reference/stocks/ca/rmv.md b/website/content/terminal/reference/stocks/ca/rmv.md new file mode 100644 index 000000000000..1b51e9d7198e --- /dev/null +++ b/website/content/terminal/reference/stocks/ca/rmv.md @@ -0,0 +1,36 @@ +--- +title: rmv +description: The 'rmv' documentation page explains how to use the Python command line + tool for removing similar tickers. It provides a detailed description of parameters, + including optional choices and default values. +keywords: +- rmv +- remove similar tickers +- command line tool +- API +- parameters +- optional choices +- default value +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Remove similar tickers to compare with. + +### Usage + +```python +rmv [-s L_SIMILAR] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| l_similar | Tickers to remove from similar list | | True | None | + +--- diff --git a/website/content/terminal/reference/stocks/ca/scorr.md b/website/content/terminal/reference/stocks/ca/scorr.md new file mode 100644 index 000000000000..e1cb25dd51a1 --- /dev/null +++ b/website/content/terminal/reference/stocks/ca/scorr.md @@ -0,0 +1,36 @@ +--- +title: scorr +description: The page provides reference to FinBrain's sentiment correlation tool, + demonstrating usage, parameters, and a screenshot for better interpretation. It + aids with extracting and comparing sentiment data across similar tickers. +keywords: +- FinBrain +- sentiment correlation +- similar tickers +- sentiment_compare +- raw sentiment data +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +FinBrain's sentiment correlation across similar tickers. + +### Usage + +```python +sentiment_compare [-r] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| raw | Display raw sentiment data | False | True | None | + +![scorr](https://user-images.githubusercontent.com/46355364/154073958-a2d7afd1-2406-46a6-8dc2-fdfd8b8605a4.png) + +--- diff --git a/website/content/terminal/reference/stocks/ca/sentiment.md b/website/content/terminal/reference/stocks/ca/sentiment.md new file mode 100644 index 000000000000..e90bad36ab24 --- /dev/null +++ b/website/content/terminal/reference/stocks/ca/sentiment.md @@ -0,0 +1,36 @@ +--- +title: sentiment +description: This page details the sentiment comparison feature in FinBrain's system. + It offers an understanding of sentiment across similar tickers, with the possibility + to view raw sentiment data. +keywords: +- FinBrain +- sentiment comparison +- sentiment +- tickers +- raw sentiment data +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +FinBrain's sentiment comparison across similar tickers. + +### Usage + +```python +sentiment_compare [-r] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| raw | Display raw sentiment data | False | True | None | + +![sentiment](https://user-images.githubusercontent.com/46355364/154074202-54d9b40a-124a-4962-a3a6-62b7afe8cd62.png) + +--- diff --git a/website/content/terminal/reference/stocks/ca/set.md b/website/content/terminal/reference/stocks/ca/set.md new file mode 100644 index 000000000000..54236daada7d --- /dev/null +++ b/website/content/terminal/reference/stocks/ca/set.md @@ -0,0 +1,34 @@ +--- +title: set +description: This page provides instructions on how to use the 'set' command to select + similar companies for comparison, including usage and parameter details. +keywords: +- similar companies +- comparison +- set function +- usage +- parameters +- L_SIMILAR +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Select similar companies to compare with. + +### Usage + +```python +set [-s L_SIMILAR] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| l_similar | similar companies to compare with. | | True | None | + +--- diff --git a/website/content/terminal/reference/stocks/ca/technical.md b/website/content/terminal/reference/stocks/ca/technical.md new file mode 100644 index 000000000000..a44461e1435c --- /dev/null +++ b/website/content/terminal/reference/stocks/ca/technical.md @@ -0,0 +1,66 @@ +--- +title: technical +description: This page provides usage information, examples and parameters details + for the 'technical' function that prints screener data of similar companies. +keywords: +- technical function +- stock screener +- company data +- financial data +- similar companies +- Stock ticker +- Beta +- ATR +- SMA20 +- SMA50 +- SMA200 +- 52W High +- 52W Low +- RSI +- Price +- Change +- from Open +- Gap +- Volume +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Prints screener data of similar companies. [Source: Finviz] + +### Usage + +```python +technical +``` + +--- + +## Parameters + +This command has no parameters + + + +--- + +## Examples + +```python +2022 Feb 15, 08:44 (🦋) /stocks/ca/ $ technical + Stock Screener +┌────────┬──────┬───────┬───────┬───────┬────────┬──────────┬─────────┬───────┬─────────┬────────┬───────────┬───────┬─────────────┐ +│ Ticker │ Beta │ ATR │ SMA20 │ SMA50 │ SMA200 │ 52W High │ 52W Low │ RSI │ Price │ Change │ from Open │ Gap │ Volume │ +├────────┼──────┼───────┼───────┼───────┼────────┼──────────┼─────────┼───────┼─────────┼────────┼───────────┼───────┼─────────────┤ +│ AAPL │ 1.18 │ 4.29 │ -0.00 │ -0.02 │ 0.13 │ -0.08 │ 0.45 │ 46.89 │ 168.88 │ 0.00 │ 0.01 │ -0.01 │ 86185528.00 │ +├────────┼──────┼───────┼───────┼───────┼────────┼──────────┼─────────┼───────┼─────────┼────────┼───────────┼───────┼─────────────┤ +│ GOOGL │ 1.07 │ 93.36 │ -0.01 │ -0.04 │ 0.00 │ -0.11 │ 0.36 │ 45.82 │ 2710.52 │ 0.01 │ 0.02 │ -0.01 │ 1715054.00 │ +├────────┼──────┼───────┼───────┼───────┼────────┼──────────┼─────────┼───────┼─────────┼────────┼───────────┼───────┼─────────────┤ +│ MSFT │ 0.91 │ 9.40 │ -0.03 │ -0.07 │ -0.00 │ -0.16 │ 0.32 │ 40.63 │ 295.00 │ -0.00 │ 0.00 │ -0.00 │ 36359488.00 │ +├────────┼──────┼───────┼───────┼───────┼────────┼──────────┼─────────┼───────┼─────────┼────────┼───────────┼───────┼─────────────┤ +│ TSLA │ 2.04 │ 57.00 │ -0.06 │ -0.12 │ 0.06 │ -0.30 │ 0.62 │ 41.26 │ 875.76 │ 0.02 │ 0.02 │ 0.00 │ 22585472.00 │ +└────────┴──────┴───────┴───────┴───────┴────────┴──────────┴─────────┴───────┴─────────┴────────┴───────────┴───────┴─────────────┘ +``` +--- diff --git a/website/content/terminal/reference/stocks/ca/ticker.md b/website/content/terminal/reference/stocks/ca/ticker.md new file mode 100644 index 000000000000..996351336d61 --- /dev/null +++ b/website/content/terminal/reference/stocks/ca/ticker.md @@ -0,0 +1,47 @@ +--- +title: ticker +description: This page provides detailed instructions on how to set and use the ticker + function. It is invaluable for extracting similar tickers, helping users engage + more with stocks. +keywords: +- ticker function +- extract similar tickers +- docusaurus documentation +- stock market +- financial tool +- ticker usage +- technical analysis +- stock ticker +- usage examples +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Set ticker to extract similar from + +### Usage + +```python +ticker -t TICKER +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| ticker | Ticker get similar tickers from | None | False | None | + + +--- + +## Examples + +```python +text +2022 Feb 15, 08:33 (🦋) /stocks/ca/ $ ticker AAPL +``` +--- diff --git a/website/content/terminal/reference/stocks/ca/tsne.md b/website/content/terminal/reference/stocks/ca/tsne.md new file mode 100644 index 000000000000..0defd77a95be --- /dev/null +++ b/website/content/terminal/reference/stocks/ca/tsne.md @@ -0,0 +1,39 @@ +--- +title: tsne +description: Documentation page about TSNE method for comparing similar companies, + detailing usage, parameters, and examples. It describes how to implement TSNE method + using sklearn in Python. +keywords: +- TSNE +- sklearn +- comparison +- similar companies +- parameters +- usage +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Get similar companies to compare with using sklearn TSNE. + +### Usage + +```python +tsne [-r LR] [-l LIMIT] [-p] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| lr | TSNE Learning rate. Typical values are between 50 and 200 | 200 | True | None | +| limit | Limit of stocks to retrieve. The subsample will occur randomly. | 10 | True | None | +| no_plot | | False | True | None | + +![tsne](https://user-images.githubusercontent.com/46355364/154074416-af8c7d2a-fa2f-461f-8522-933cf6e3543b.png) + +--- diff --git a/website/content/terminal/reference/stocks/ca/valuation.md b/website/content/terminal/reference/stocks/ca/valuation.md new file mode 100644 index 000000000000..4486ca997fbb --- /dev/null +++ b/website/content/terminal/reference/stocks/ca/valuation.md @@ -0,0 +1,70 @@ +--- +title: valuation +description: This documentation page explains the usage of the 'valuation' command + which prints screener data of similar companies. It includes examples and details + about the parameters +keywords: +- valuation +- screener data +- similar companies +- parameters +- command usage +- enterprise SEO +- data printing +- examples +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Prints screener data of similar companies. [Source: Finviz] + +### Usage + +```python +valuation +``` + +--- + +## Parameters + +This command has no parameters + + + +--- + +## Examples + +```python +2022 Feb 15, 08:46 (🦋) /stocks/ca/ $ valuation + Stock Screener +┌────────┬──────────────────┬───────┬─────────┬──────┬───────┬───────┬───────┬───────┬────────────┬────────────┬─────────────┬─────────────┬───────────────┬─────────┬────────┬─────────────┐ +│ Ticker │ Market Cap │ P/E │ Fwd P/E │ PEG │ P/S │ P/B │ P/C │ P/FCF │ EPS this Y │ EPS next Y │ EPS past 5Y │ EPS next 5Y │ Sales past 5Y │ Price │ Change │ Volume │ +├────────┼──────────────────┼───────┼─────────┼──────┼───────┼───────┼───────┼───────┼────────────┼────────────┼─────────────┼─────────────┼───────────────┼─────────┼────────┼─────────────┤ +│ AAPL │ 2812900000000.00 │ 28.04 │ 25.72 │ 1.89 │ 7.44 │ 38.47 │ 44.01 │ 32.23 │ 0.71 │ 0.07 │ 0.22 │ 0.15 │ 0.11 │ 168.88 │ 0.00 │ 86185528.00 │ +├────────┼──────────────────┼───────┼─────────┼──────┼───────┼───────┼───────┼───────┼────────────┼────────────┼─────────────┼─────────────┼───────────────┼─────────┼────────┼─────────────┤ +│ AMZN │ 1637940000000.00 │ 47.95 │ 42.78 │ 1.38 │ 3.49 │ 11.43 │ 17.05 │ None │ 0.55 │ 0.51 │ 0.68 │ 0.35 │ 0.28 │ 3103.34 │ 0.01 │ 4161535.00 │ +├────────┼──────────────────┼───────┼─────────┼──────┼───────┼───────┼───────┼───────┼────────────┼────────────┼─────────────┼─────────────┼───────────────┼─────────┼────────┼─────────────┤ +│ ANSS │ 28880000000.00 │ 59.65 │ 40.01 │ 5.33 │ 15.41 │ 6.38 │ 26.71 │ 48.76 │ -0.05 │ 0.10 │ 0.12 │ 0.11 │ 0.12 │ 317.12 │ -0.01 │ 393261.00 │ +├────────┼──────────────────┼───────┼─────────┼──────┼───────┼───────┼───────┼───────┼────────────┼────────────┼─────────────┼─────────────┼───────────────┼─────────┼────────┼─────────────┤ +│ CDNS │ 41140000000.00 │ 57.27 │ 39.88 │ 3.15 │ 13.83 │ 14.75 │ 40.58 │ 43.78 │ -0.40 │ 0.13 │ 0.21 │ 0.18 │ 0.10 │ 142.08 │ -0.00 │ 1218681.00 │ +├────────┼──────────────────┼───────┼─────────┼──────┼───────┼───────┼───────┼───────┼────────────┼────────────┼─────────────┼─────────────┼───────────────┼─────────┼────────┼─────────────┤ +│ GOOG │ 1857570000000.00 │ 26.07 │ 24.10 │ 1.24 │ 7.77 │ 7.35 │ None │ None │ 0.85 │ 0.04 │ None │ 0.21 │ None │ 2706.00 │ 0.01 │ 1339640.00 │ +├────────┼──────────────────┼───────┼─────────┼──────┼───────┼───────┼───────┼───────┼────────────┼────────────┼─────────────┼─────────────┼───────────────┼─────────┼────────┼─────────────┤ +│ GOOGL │ 1849330000000.00 │ 24.15 │ 20.04 │ 1.15 │ 7.18 │ 7.14 │ 13.24 │ 27.60 │ 0.91 │ 0.17 │ 0.32 │ 0.21 │ 0.23 │ 2710.52 │ 0.01 │ 1715054.00 │ +├────────┼──────────────────┼───────┼─────────┼──────┼───────┼───────┼───────┼───────┼────────────┼────────────┼─────────────┼─────────────┼───────────────┼─────────┼────────┼─────────────┤ +│ INTU │ 155900000000.00 │ 69.95 │ 38.73 │ 4.02 │ 15.11 │ 14.84 │ 47.97 │ 59.62 │ 0.09 │ 0.17 │ 0.20 │ 0.17 │ 0.15 │ 529.05 │ -0.01 │ 1165436.00 │ +├────────┼──────────────────┼───────┼─────────┼──────┼───────┼───────┼───────┼───────┼────────────┼────────────┼─────────────┼─────────────┼───────────────┼─────────┼────────┼─────────────┤ +│ KEYS │ 31100000000.00 │ 34.69 │ 22.18 │ 2.89 │ 6.29 │ 8.11 │ 15.15 │ 27.09 │ 0.44 │ 0.08 │ 0.20 │ 0.12 │ 0.11 │ 165.93 │ 0.01 │ 1519015.00 │ +├────────┼──────────────────┼───────┼─────────┼──────┼───────┼───────┼───────┼───────┼────────────┼────────────┼─────────────┼─────────────┼───────────────┼─────────┼────────┼─────────────┤ +│ MSFT │ 2266600000000.00 │ 31.39 │ 27.37 │ 1.80 │ 12.26 │ 13.84 │ 18.08 │ 52.23 │ 0.40 │ 0.15 │ 0.26 │ 0.17 │ 0.13 │ 295.00 │ -0.00 │ 36359488.00 │ +├────────┼──────────────────┼───────┼─────────┼──────┼───────┼───────┼───────┼───────┼────────────┼────────────┼─────────────┼─────────────┼───────────────┼─────────┼────────┼─────────────┤ +│ SNPS │ 47690000000.00 │ 61.25 │ 32.70 │ 4.11 │ 11.34 │ 8.52 │ 30.17 │ 34.09 │ 0.13 │ 0.15 │ 0.23 │ 0.15 │ 0.12 │ 294.96 │ -0.00 │ 826559.00 │ +├────────┼──────────────────┼───────┼─────────┼──────┼───────┼───────┼───────┼───────┼────────────┼────────────┼─────────────┼─────────────┼───────────────┼─────────┼────────┼─────────────┤ +│ VRSN │ 23560000000.00 │ 30.45 │ 29.60 │ 3.81 │ 17.74 │ None │ 19.65 │ 37.40 │ -0.02 │ 0.15 │ 0.20 │ 0.08 │ 0.04 │ 213.56 │ -0.00 │ 640475.00 │ +└────────┴──────────────────┴───────┴─────────┴──────┴───────┴───────┴───────┴───────┴────────────┴────────────┴─────────────┴─────────────┴───────────────┴─────────┴────────┴─────────────┘ +``` +--- diff --git a/website/content/terminal/reference/stocks/ca/volume.md b/website/content/terminal/reference/stocks/ca/volume.md new file mode 100644 index 000000000000..3779d6c55c3f --- /dev/null +++ b/website/content/terminal/reference/stocks/ca/volume.md @@ -0,0 +1,40 @@ +--- +title: volume +description: Documentation page outlining the usage, parameters, and results from + the volume function, which provides historical volume comparison between similar + companies. +keywords: +- volume function +- historical volume comparison +- stock volume +- financial data +- stock market analysis +- company comparison +- parameters +- data visualization +- stock analysis +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Historical volume comparison between similar companies. + +### Usage + +```python +volume [-s START] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| start | The starting date (format YYYY-MM-DD) of the stock | 2021-11-24 | True | None | + +![volume](https://user-images.githubusercontent.com/46355364/154074657-72976b1a-fc27-4917-8d43-95f5b54da32e.png) + +--- diff --git a/website/content/terminal/reference/stocks/candle.md b/website/content/terminal/reference/stocks/candle.md new file mode 100644 index 000000000000..1126da17d578 --- /dev/null +++ b/website/content/terminal/reference/stocks/candle.md @@ -0,0 +1,45 @@ +--- +title: candle +description: This page provides a detailed guide on the usage of the 'candle' command + in Python, a tool for displaying historic stock data. It covers functionalities + such as plot display, data sorting and trendline addition. +keywords: +- candle command +- historic stock data +- data visualization +- data sorting +- trendlines +- interactive plotly chart +- moving average +- log scale +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Shows historic data for a stock + +### Usage + +```python +candle [-p] [--sort {adjclose,open,close,high,low,volume,returns,logret}] [-r] [--raw] [-t] [--ma MOV_AVG] [--log] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| plotly | Flag to show interactive plotly chart | True | True | None | +| sort | Choose a column to sort by. Only works when raw data is displayed. | | True | adjclose, open, close, high, low, volume, returns, logret | +| reverse | Data is sorted in descending order by default. Reverse flag will sort it in an ascending way. Only works when raw data is displayed. | False | True | None | +| raw | Shows raw data instead of chart. | False | True | None | +| trendlines | Flag to add high and low trends to candle | False | True | None | +| mov_avg | Add moving average in number of days to plot and separate by a comma. Value for ma (moving average) keyword needs to be greater than 1. | None | True | None | +| logy | Plot with y axis on log scale | False | True | None | + +![candle](https://user-images.githubusercontent.com/46355364/154072214-f4b49833-157f-44a7-be2d-d558ffc6f945.png) + +--- diff --git a/website/versioned_docs/version-v3/terminal/reference/stocks/dd/_category_.json b/website/content/terminal/reference/stocks/dd/_category_.json similarity index 100% rename from website/versioned_docs/version-v3/terminal/reference/stocks/dd/_category_.json rename to website/content/terminal/reference/stocks/dd/_category_.json diff --git a/website/content/terminal/reference/stocks/dd/analyst.md b/website/content/terminal/reference/stocks/dd/analyst.md new file mode 100644 index 000000000000..04b0f65c4339 --- /dev/null +++ b/website/content/terminal/reference/stocks/dd/analyst.md @@ -0,0 +1,59 @@ +--- +title: analyst +description: This page enables users to print analyst prices and ratings for a company + using a simple python command. Information such as 'date', 'analyst', 'category', + 'price', and 'rating' is revealed. +keywords: +- Analyst data +- Stock market data +- Stock analyst ratings +- Financial information +- Command-line interface +- Python commands +- Finance +- Stock prices +- Financial data +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Print analyst prices and ratings of the company. The following fields are expected: date, analyst, category, price from, price to, and rating. [Source: Finviz] + +### Usage + +```python +analyst +``` + +--- + +## Parameters + +This command has no parameters + + + +--- + +## Examples + +```python +2022 Feb 16, 04:20 (🦋) /stocks/dd/ $ analyst + Display Analyst Ratings +┏━━━━━━━━━━━━┳━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━┳━━━━━━━━━━━━━┳━━━━━━━━━━━┓ +┃ ┃ category ┃ analyst ┃ rating ┃ target ┃ target_from ┃ target_to ┃ +┡━━━━━━━━━━━━╇━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━╇━━━━━━━━━━━━━╇━━━━━━━━━━━┩ +│ 2022-01-31 │ Upgrade │ Credit Suisse │ Neutral - Outperform │ 1025.00 │ nan │ nan │ +├────────────┼────────────┼─────────────────┼───────────────────────┼─────────┼─────────────┼───────────┤ +│ 2022-01-27 │ Reiterated │ Wells Fargo │ Equal Weight │ nan │ 860.00 │ 910.00 │ +├────────────┼────────────┼─────────────────┼───────────────────────┼─────────┼─────────────┼───────────┤ +│ 2022-01-27 │ Reiterated │ Robert W. Baird │ Outperform │ nan │ 888.00 │ 1108.00 │ +├────────────┼────────────┼─────────────────┼───────────────────────┼─────────┼─────────────┼───────────┤ +│ 2022-01-27 │ Reiterated │ Oppenheimer │ Outperform │ nan │ 1080.00 │ 1103.00 │ +├────────────┼────────────┼─────────────────┼───────────────────────┼─────────┼─────────────┼───────────┤ +│ 2022-01-27 │ Reiterated │ JP Morgan │ Underweight │ nan │ 295.00 │ 325.00 │ +└────────────┴────────────┴─────────────────┴───────────────────────┴─────────┴─────────────┴───────────┘ +``` +--- diff --git a/website/content/terminal/reference/stocks/dd/arktrades.md b/website/content/terminal/reference/stocks/dd/arktrades.md new file mode 100644 index 000000000000..b127a15e27ba --- /dev/null +++ b/website/content/terminal/reference/stocks/dd/arktrades.md @@ -0,0 +1,73 @@ +--- +title: arktrades +description: The page documents the ArkTrades tool. This tool provides trade details + for any given ticker in ARK funds. It has optional parameters to limit rows shown + or include the ticker symbol in the table. +keywords: +- arktrades +- trades +- ARK funds +- limit rows +- show symbol +- table +- stocks +- trade data +- sell +- buy +- Apple Inc. +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Get trades for ticker across all ARK funds. + +### Usage + +```python +arktrades [-l LIMIT] [-s] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| limit | Limit of rows to show | 10 | True | None | +| show_symbol | Flag to show ticker in table | False | True | None | + + +--- + +## Examples + +```python +2022 Feb 16, 04:23 (🦋) /stocks/dd/ $ arktrades + ARK Trades +┏━━━━━━━━━━━━┳━━━━━━━━┳━━━━━━━━┳━━━━━━┳━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━┳━━━━━━━━━━━━━┓ +┃ ┃ shares ┃ weight ┃ fund ┃ direction ┃ everything.profile.companyName ┃ Close ($) ┃ Total ($1M) ┃ +┡━━━━━━━━━━━━╇━━━━━━━━╇━━━━━━━━╇━━━━━━╇━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━╇━━━━━━━━━━━━━┩ +│ 2020-08-24 │ 9891 │ 0.18 │ ARKQ │ Sell │ Apple Inc. │ 125.86 │ 1.24 │ +├────────────┼────────┼────────┼──────┼───────────┼────────────────────────────────┼───────────┼─────────────┤ +│ 2020-08-24 │ 14278 │ 0.25 │ ARKW │ Sell │ Apple Inc. │ 125.86 │ 1.80 │ +├────────────┼────────┼────────┼──────┼───────────┼────────────────────────────────┼───────────┼─────────────┤ +│ 2020-08-25 │ 27722 │ 0.50 │ ARKF │ Sell │ Apple Inc. │ 124.82 │ 3.46 │ +├────────────┼────────┼────────┼──────┼───────────┼────────────────────────────────┼───────────┼─────────────┤ +│ 2020-09-08 │ 14631 │ 0.20 │ ARKQ │ Sell │ Apple Inc. │ 112.82 │ 1.65 │ +├────────────┼────────┼────────┼──────┼───────────┼────────────────────────────────┼───────────┼─────────────┤ +│ 2020-09-08 │ 90983 │ 0.82 │ ARKW │ Sell │ Apple Inc. │ 112.82 │ 10.26 │ +├────────────┼────────┼────────┼──────┼───────────┼────────────────────────────────┼───────────┼─────────────┤ +│ 2020-09-09 │ 34120 │ 0.18 │ ARKW │ Sell │ Apple Inc. │ 117.32 │ 4.00 │ +├────────────┼────────┼────────┼──────┼───────────┼────────────────────────────────┼───────────┼─────────────┤ +│ 2020-09-09 │ 24678 │ 0.51 │ ARKF │ Sell │ Apple Inc. │ 117.32 │ 2.90 │ +├────────────┼────────┼────────┼──────┼───────────┼────────────────────────────────┼───────────┼─────────────┤ +│ 2020-09-28 │ 8397 │ 0.15 │ ARKQ │ Sell │ Apple Inc. │ 114.96 │ 0.97 │ +├────────────┼────────┼────────┼──────┼───────────┼────────────────────────────────┼───────────┼─────────────┤ +│ 2020-10-14 │ 125517 │ 0.52 │ ARKG │ Buy │ Apple Inc. │ 121.19 │ 15.21 │ +├────────────┼────────┼────────┼──────┼───────────┼────────────────────────────────┼───────────┼─────────────┤ +│ 2020-10-30 │ 128557 │ 0.50 │ ARKG │ Sell │ Apple Inc. │ 108.86 │ 13.99 │ +└────────────┴────────┴────────┴──────┴───────────┴────────────────────────────────┴───────────┴─────────────┘ +``` +--- diff --git a/website/content/terminal/reference/stocks/dd/customer.md b/website/content/terminal/reference/stocks/dd/customer.md new file mode 100644 index 000000000000..8a953445c7ea --- /dev/null +++ b/website/content/terminal/reference/stocks/dd/customer.md @@ -0,0 +1,31 @@ +--- +title: customer +description: The 'customer' page provides a list of customers from a ticker source, + CSIMarket. It also includes the usage of the command and its parameters. +keywords: +- customer +- CSIMarket +- command parameters +- usage +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +List of customers from ticker provided. [Source: CSIMarket] + +### Usage + +```python +customer +``` + +--- + +## Parameters + +This command has no parameters + + +--- diff --git a/website/content/terminal/reference/stocks/dd/est.md b/website/content/terminal/reference/stocks/dd/est.md new file mode 100644 index 000000000000..5db7600f73f5 --- /dev/null +++ b/website/content/terminal/reference/stocks/dd/est.md @@ -0,0 +1,103 @@ +--- +title: est +description: Detailed guide on how to get yearly estimates and quarter earnings/revenues + for stocks using the 'est' command. It includes parameters' usage, examples and + source of data. +keywords: +- annual earnings +- quarter earnings +- annual revenue +- estimates +- stock market +- business +- financial data +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Yearly estimates and quarter earnings/revenues. [Source: Business Insider] + +### Usage + +```python +est [-e {annualrevenue,annualearnings,quarterearnings}] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| estimate | Estimates to get | annualearnings | True | annualrevenue, annualearnings, quarterearnings | + + +--- + +## Examples + +```python +2022 Sep 16, 23:24 (🦋) /stocks/dd/ $ est -e annualearnings + + Annual Earnings Estimates +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━┳━━━━━━━━━┳━━━━━━━━━┳━━━━━━━━━━┳━━━━━━━━━━┓ +┃ ┃ 2022 ┃ 2023 ┃ 2024 ┃ 2025 ┃ 2026 ┃ +┡━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━╇━━━━━━━━━╇━━━━━━━━━╇━━━━━━━━━━╇━━━━━━━━━━┩ +│ Revenue │ 392,623 │ 410,909 │ 430,738 │ 454,433 │ 510,220 │ +├────────────────────────────────┼──────────┼─────────┼─────────┼──────────┼──────────┤ +│ Dividend │ 0.91 │ 0.98 │ 1.05 │ 0.99 │ 0.93 │ +├────────────────────────────────┼──────────┼─────────┼─────────┼──────────┼──────────┤ +│ Dividend Yield (in %) │ 0.60 % │ 0.64 % │ 0.69 % │ 0.65 % │ 0.61 % │ +├────────────────────────────────┼──────────┼─────────┼─────────┼──────────┼──────────┤ +│ EPS │ 6.09 │ 6.45 │ 6.86 │ 7.24 │ 7.58 │ +├────────────────────────────────┼──────────┼─────────┼─────────┼──────────┼──────────┤ +│ P/E Ratio │ 24.91 │ 23.52 │ 22.13 │ 20.97 │ 20.03 │ +├────────────────────────────────┼──────────┼─────────┼─────────┼──────────┼──────────┤ +│ EBIT │ 118,989 │ 121,191 │ 125,432 │ 128,497 │ 146,245 │ +├────────────────────────────────┼──────────┼─────────┼─────────┼──────────┼──────────┤ +│ EBITDA │ 130,785 │ 132,990 │ 138,897 │ 149,228 │ 158,983 │ +├────────────────────────────────┼──────────┼─────────┼─────────┼──────────┼──────────┤ +│ Net Profit │ 99,530 │ 101,720 │ 105,647 │ 108,662 │ 124,217 │ +├────────────────────────────────┼──────────┼─────────┼─────────┼──────────┼──────────┤ +│ Net Profit Adjusted │ 100,429 │ 103,715 │ 108,643 │ 117,760 │ 132,601 │ +├────────────────────────────────┼──────────┼─────────┼─────────┼──────────┼──────────┤ +│ Pre-Tax Profit │ 118,535 │ 121,213 │ 126,453 │ 131,656 │ 156,001 │ +├────────────────────────────────┼──────────┼─────────┼─────────┼──────────┼──────────┤ +│ Net Profit (Adjusted) │ 118,256 │ 121,673 │ 129,059 │ 133,883 │ 146,138 │ +├────────────────────────────────┼──────────┼─────────┼─────────┼──────────┼──────────┤ +│ EPS (Non-GAAP) ex. SOE │ 6.06 │ 6.46 │ 6.95 │ 7.36 │ 8.09 │ +├────────────────────────────────┼──────────┼─────────┼─────────┼──────────┼──────────┤ +│ EPS (GAAP) │ 6.09 │ 6.45 │ 6.86 │ 7.24 │ 7.58 │ +├────────────────────────────────┼──────────┼─────────┼─────────┼──────────┼──────────┤ +│ Gross Income │ 169,560 │ 176,873 │ 185,487 │ 200,666 │ 221,723 │ +├────────────────────────────────┼──────────┼─────────┼─────────┼──────────┼──────────┤ +│ Cash Flow from Investing │ -19,306 │ -8,376 │ -13,356 │ -10,998 │ -11,108 │ +├────────────────────────────────┼──────────┼─────────┼─────────┼──────────┼──────────┤ +│ Cash Flow from Operations │ 123,476 │ 123,734 │ 134,248 │ 143,306 │ 150,627 │ +├────────────────────────────────┼──────────┼─────────┼─────────┼──────────┼──────────┤ +│ Cash Flow from Financing │ -108,858 │ -90,388 │ -78,773 │ -14,759 │ -15,262 │ +├────────────────────────────────┼──────────┼─────────┼─────────┼──────────┼──────────┤ +│ Cash Flow per Share │ 7.16 │ 7.58 │ 8.58 │ 9.09 │ - │ +├────────────────────────────────┼──────────┼─────────┼─────────┼──────────┼──────────┤ +│ Free Cash Flow │ 111,277 │ 109,160 │ 114,479 │ 120,309 │ 139,519 │ +├────────────────────────────────┼──────────┼─────────┼─────────┼──────────┼──────────┤ +│ Free Cash Flow per Share │ 6.70 │ 6.85 │ 7.44 │ 7.87 │ 8.52 │ +├────────────────────────────────┼──────────┼─────────┼─────────┼──────────┼──────────┤ +│ Book Value per Share │ 3.55 │ 4.39 │ 5.52 │ 7.90 │ - │ +├────────────────────────────────┼──────────┼─────────┼─────────┼──────────┼──────────┤ +│ Net Debt │ -56,230 │ -81,452 │ -41,666 │ -174,398 │ -493,690 │ +├────────────────────────────────┼──────────┼─────────┼─────────┼──────────┼──────────┤ +│ Research & Development Exp. │ 26,214 │ 28,913 │ 31,890 │ 38,822 │ 40,837 │ +├────────────────────────────────┼──────────┼─────────┼─────────┼──────────┼──────────┤ +│ Capital Expenditure │ 10,282 │ 11,518 │ 12,409 │ 14,097 │ 11,108 │ +├────────────────────────────────┼──────────┼─────────┼─────────┼──────────┼──────────┤ +│ Selling, General & Admin. Exp. │ 24,911 │ 27,190 │ 28,831 │ 31,789 │ 34,641 │ +├────────────────────────────────┼──────────┼─────────┼─────────┼──────────┼──────────┤ +│ Shareholder’s Equity │ 58,270 │ 74,745 │ 100,755 │ 187,040 │ 472,170 │ +├────────────────────────────────┼──────────┼─────────┼─────────┼──────────┼──────────┤ +│ Total Assets │ 343,493 │ 369,736 │ 419,940 │ 529,449 │ 811,911 │ +└────────────────────────────────┴──────────┴─────────┴─────────┴──────────┴──────────┘ +``` +--- diff --git a/website/content/terminal/reference/stocks/dd/load.md b/website/content/terminal/reference/stocks/dd/load.md new file mode 100644 index 000000000000..aa563c8f8aee --- /dev/null +++ b/website/content/terminal/reference/stocks/dd/load.md @@ -0,0 +1,40 @@ +--- +title: load +description: This docusaurus page provides detailed information on how to load a stock + ticker to perform analysis, providing instructions on usage and descriptions of + various parameters. +keywords: +- stock ticker +- load +- stock analysis +- usage instructions +- parameters +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Load stock ticker to perform analysis on. When the data source is syf', an Indian ticker can be loaded by using '.NS' at the end, e.g. 'SBIN.NS'. See available market in https://help.yahoo.com/kb/exchanges-data-providers-yahoo-finance-sln2310.html. + +### Usage + +```python +load -t TICKER [-s START] [-e END] [-i {1,5,15,30,60}] [-p] [-f FILEPATH] [-m] [-w] [-r {ytd,1y,2y,5y,6m}] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| ticker | Stock ticker | None | False | None | +| start | The starting date (format YYYY-MM-DD) of the stock | 2019-11-21 | True | None | +| end | The ending date (format YYYY-MM-DD) of the stock | 2022-11-25 | True | None | +| interval | Intraday stock minutes | 1440 | True | 1, 5, 15, 30, 60 | +| prepost | Pre/After market hours. Only works for 'yf' source, and intraday data | False | True | None | +| filepath | Path to load custom file. | None | True | None | +| monthly | Load monthly data | False | True | None | +| weekly | Load weekly data | False | True | None | +--- diff --git a/website/content/terminal/reference/stocks/dd/pt.md b/website/content/terminal/reference/stocks/dd/pt.md new file mode 100644 index 000000000000..9b4adbb947c0 --- /dev/null +++ b/website/content/terminal/reference/stocks/dd/pt.md @@ -0,0 +1,40 @@ +--- +title: pt +description: The pt command can print the latest price targets from analysts as provided + by Business Insider. The command has parameters such as raw for displaying only + raw data, and limit for controlling the number of price targets shown. +keywords: +- Business Insider +- Price Target +- Analysts +- Parameters +- Raw data +- Limit +- Latest price targets +- Print +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Prints price target from analysts. [Source: Business Insider] + +### Usage + +```python +pt [--raw] [-l LIMIT] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| raw | Only output raw data | False | True | None | +| limit | Limit of latest price targets from analysts to print. | 10 | True | None | + +![pt](https://user-images.githubusercontent.com/46355364/154235470-58ed232e-116e-442a-bffe-8e855eba3bda.png) + +--- diff --git a/website/content/terminal/reference/stocks/dd/rating.md b/website/content/terminal/reference/stocks/dd/rating.md new file mode 100644 index 000000000000..3373a5dd77ec --- /dev/null +++ b/website/content/terminal/reference/stocks/dd/rating.md @@ -0,0 +1,42 @@ +--- +title: rating +description: A page detailing the rating system for evaluating companies based on + specific financial ratios. It prints information on whether a company is a buy, + neutral or sell. This page provides usage details and parameters for obtaining ratings. +keywords: +- Rating +- Company Evaluation +- Buy or Sell Recommendation +- Financial Ratios +- P/B +- ROA +- DCF +- P/E +- ROE +- D/E +- Financial Modeling Prep +- Limit +- Last Days Ratings +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Based on specific ratios, prints information whether the company is a (strong) buy, neutral or a (strong) sell. The following fields are expected: P/B, ROA, DCF, P/E, ROE, and D/E. [Source: Financial Modeling Prep] + +### Usage + +```python +rating [-l LIMIT] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| limit | limit of last days to display ratings | 10 | True | None | + +--- diff --git a/website/content/terminal/reference/stocks/dd/rot.md b/website/content/terminal/reference/stocks/dd/rot.md new file mode 100644 index 000000000000..00cac063822a --- /dev/null +++ b/website/content/terminal/reference/stocks/dd/rot.md @@ -0,0 +1,40 @@ +--- +title: rot +description: This page provides information about the 'rot' - Rating Over Time (monthly), + including its usage, parameters, and a visual example. The info is sourced from + Finnhub. +keywords: +- rot +- Rating Over Time +- monthly rating +- Finnhub +- rot parameters +- rot usage +- data visualization +- raw data +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Rating over time (monthly). [Source: Finnhub] + +### Usage + +```python +rot [-l LIMIT] [--raw] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| limit | Limit of last months | 10 | True | None | +| raw | Only output raw data | False | True | None | + +![rot](https://user-images.githubusercontent.com/46355364/154236600-5e3c68b6-5fda-4140-8ae2-360389399cd2.png) + +--- diff --git a/website/content/terminal/reference/stocks/dd/sec.md b/website/content/terminal/reference/stocks/dd/sec.md new file mode 100644 index 000000000000..151914b2c30f --- /dev/null +++ b/website/content/terminal/reference/stocks/dd/sec.md @@ -0,0 +1,68 @@ +--- +title: sec +description: This page provides information on how to print and analyze SEC filings + of a company using Market Watch. The SEC data includes Filing Date, Document Date, + Type, Category, whether the filing is Amended, and a Link to the filing. +keywords: +- SEC filings +- data print +- financial data +- Market Watch +- stock data +- SEC data +- stock SEC filings +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Prints SEC filings of the company. The following fields are expected: Filing Date, Document Date, Type, Category, Amended, and Link. [Source: Market Watch] + +### Usage + +```python +sec [-l LIMIT] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| limit | number of latest SEC filings. | 5 | True | None | + + +--- + +## Examples + +```python +2022 Feb 16, 04:37 (🦋) /stocks/dd/ $ sec -l 10 + SEC Filings +┏━━━━━━━━━━━━┳━━━━━━━━━━━━━━━┳━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ ┃ Document Date ┃ Type ┃ Category ┃ Amended ┃ Link ┃ +┡━━━━━━━━━━━━╇━━━━━━━━━━━━━━━╇━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┩ +│ 02/15/2022 │ N/A │ SC 13G/A │ Institutional Ownership │ * │ https://www.marketwatch.com/investing/stock/tsla/financials/secfilings?docid=15572277 │ +├────────────┼───────────────┼──────────┼─────────────────────────┼─────────┼───────────────────────────────────────────────────────────────────────────────────────┤ +│ 02/14/2022 │ N/A │ SC 13G/A │ Institutional Ownership │ * │ https://www.marketwatch.com/investing/stock/tsla/financials/secfilings?docid=15565323 │ +├────────────┼───────────────┼──────────┼─────────────────────────┼─────────┼───────────────────────────────────────────────────────────────────────────────────────┤ +│ 02/10/2022 │ N/A │ SC 13G/A │ Institutional Ownership │ * │ https://www.marketwatch.com/investing/stock/tsla/financials/secfilings?docid=15548625 │ +├────────────┼───────────────┼──────────┼─────────────────────────┼─────────┼───────────────────────────────────────────────────────────────────────────────────────┤ +│ 02/08/2022 │ N/A │ SC 13G │ Institutional Ownership │ │ https://www.marketwatch.com/investing/stock/tsla/financials/secfilings?docid=15541156 │ +├────────────┼───────────────┼──────────┼─────────────────────────┼─────────┼───────────────────────────────────────────────────────────────────────────────────────┤ +│ 02/07/2022 │ 12/31/2021 │ 10-K │ Annual Reports │ │ https://www.marketwatch.com/investing/stock/tsla/financials/secfilings?docid=15534769 │ +├────────────┼───────────────┼──────────┼─────────────────────────┼─────────┼───────────────────────────────────────────────────────────────────────────────────────┤ +│ 01/26/2022 │ 01/26/2022 │ 8-K │ Special Events │ │ https://www.marketwatch.com/investing/stock/tsla/financials/secfilings?docid=15502788 │ +├────────────┼───────────────┼──────────┼─────────────────────────┼─────────┼───────────────────────────────────────────────────────────────────────────────────────┤ +│ 01/03/2022 │ 01/02/2022 │ 8-K │ Special Events │ │ https://www.marketwatch.com/investing/stock/tsla/financials/secfilings?docid=15453642 │ +├────────────┼───────────────┼──────────┼─────────────────────────┼─────────┼───────────────────────────────────────────────────────────────────────────────────────┤ +│ 12/01/2021 │ 12/01/2021 │ 8-K │ Special Events │ │ https://www.marketwatch.com/investing/stock/tsla/financials/secfilings?docid=15394282 │ +├────────────┼───────────────┼──────────┼─────────────────────────┼─────────┼───────────────────────────────────────────────────────────────────────────────────────┤ +│ 10/25/2021 │ 09/30/2021 │ 10-Q │ Quarterly Reports │ │ https://www.marketwatch.com/investing/stock/tsla/financials/secfilings?docid=15297229 │ +├────────────┼───────────────┼──────────┼─────────────────────────┼─────────┼───────────────────────────────────────────────────────────────────────────────────────┤ +│ 10/20/2021 │ 10/20/2021 │ 8-K │ Special Events │ │ https://www.marketwatch.com/investing/stock/tsla/financials/secfilings?docid=15291361 │ +└────────────┴───────────────┴──────────┴─────────────────────────┴─────────┴───────────────────────────────────────────────────────────────────────────────────────┘ +``` +--- diff --git a/website/content/terminal/reference/stocks/dd/supplier.md b/website/content/terminal/reference/stocks/dd/supplier.md new file mode 100644 index 000000000000..7405b7878164 --- /dev/null +++ b/website/content/terminal/reference/stocks/dd/supplier.md @@ -0,0 +1,31 @@ +--- +title: supplier +description: This page provides a list of suppliers from a ticker provided, sourced + from CSIMarket. The 'supplier' command is highlighted in this page, including its + usage and parameters. +keywords: +- supplier +- CSIMarket +- Parameters +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +List of suppliers from ticker provided. [Source: CSIMarket] + +### Usage + +```python +supplier +``` + +--- + +## Parameters + +This command has no parameters + + +--- diff --git a/website/versioned_docs/version-v3/terminal/reference/stocks/disc/_category_.json b/website/content/terminal/reference/stocks/disc/_category_.json similarity index 100% rename from website/versioned_docs/version-v3/terminal/reference/stocks/disc/_category_.json rename to website/content/terminal/reference/stocks/disc/_category_.json diff --git a/website/content/terminal/reference/stocks/disc/active.md b/website/content/terminal/reference/stocks/disc/active.md new file mode 100644 index 000000000000..a11270b45c28 --- /dev/null +++ b/website/content/terminal/reference/stocks/disc/active.md @@ -0,0 +1,100 @@ +--- +title: active +description: This page provides an insight into the 'active' command used to display + up to 25 top actively traded intraday tickers in the stock market using Python. + The page explains the usage conditions, parameters and ends with a clear example + showcasing its functionality. +keywords: +- Active command +- Intraday tickers +- Most actively traded +- Stocks +- Yahoo Finance +- Market data +- Command-line tool +- Stock market +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Print up to 25 top most actively traded intraday tickers. [Source: Yahoo Finance] + +### Usage + +```python +active [-l LIMIT] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| limit | Limit of stocks to display. | 5 | True | None | + + +--- + +## Examples + +```python +2022 Feb 16, 03:46 (🦋) /stocks/disc/ $ active -l 25 + Most Active Stocks +┏━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━┳━━━━━━━━┳━━━━━━━━━━┳━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━┓ +┃ Symbol ┃ Name ┃ Price (Intraday) ┃ Change ┃ % Change ┃ Volume ┃ Avg Vol (3 month) ┃ Market Cap ┃ PE Ratio (TTM) ┃ +┡━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━╇━━━━━━━━╇━━━━━━━━━━╇━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━┩ +│ SPCE │ Virgin Galactic Holdings, Inc. │ 10.74 │ 2.60 │ +31.94% │ 178.62M │ 14.077M │ 2.771B │ │ +├────────┼──────────────────────────────────────┼──────────────────┼────────┼──────────┼──────────┼───────────────────┼────────────┼────────────────┤ +│ AMD │ Advanced Micro Devices, Inc. │ 121.47 │ 7.20 │ +6.30% │ 141.257M │ 73.478M │ 145.679B │ 47.26 │ +├────────┼──────────────────────────────────────┼──────────────────┼────────┼──────────┼──────────┼───────────────────┼────────────┼────────────────┤ +│ NVDA │ NVIDIA Corporation │ 264.95 │ 22.28 │ +9.18% │ 70.175M │ 51.247M │ 660.255B │ 81.70 │ +├────────┼──────────────────────────────────────┼──────────────────┼────────┼──────────┼──────────┼───────────────────┼────────────┼────────────────┤ +│ F │ Ford Motor Company │ 18.08 │ 0.62 │ +3.55% │ 64.555M │ 108.718M │ 72.397B │ 4.06 │ +├────────┼──────────────────────────────────────┼──────────────────┼────────┼──────────┼──────────┼───────────────────┼────────────┼────────────────┤ +│ AAPL │ Apple Inc. │ 172.79 │ 3.91 │ +2.32% │ 64.286M │ 104.284M │ 2.82T │ 28.73 │ +├────────┼──────────────────────────────────────┼──────────────────┼────────┼──────────┼──────────┼───────────────────┼────────────┼────────────────┤ +│ ZNGA │ Zynga Inc. │ 9.05 │ -0.01 │ -0.11% │ 55.461M │ 35.399M │ 10.231B │ │ +├────────┼──────────────────────────────────────┼──────────────────┼────────┼──────────┼──────────┼───────────────────┼────────────┼────────────────┤ +│ RBLX │ Roblox Corporation │ 73.30 │ 4.98 │ +7.29% │ 49.158M │ 22.259M │ 42.429B │ │ +├────────┼──────────────────────────────────────┼──────────────────┼────────┼──────────┼──────────┼───────────────────┼────────────┼────────────────┤ +│ SOFI │ SoFi Technologies, Inc. │ 12.58 │ 0.58 │ +4.83% │ 50.868M │ 50.382M │ 10.059B │ │ +├────────┼──────────────────────────────────────┼──────────────────┼────────┼──────────┼──────────┼───────────────────┼────────────┼────────────────┤ +│ PLTR │ Palantir Technologies Inc. │ 14.17 │ 0.91 │ +6.86% │ 48.047M │ 42.817M │ 28.408B │ │ +├────────┼──────────────────────────────────────┼──────────────────┼────────┼──────────┼──────────┼───────────────────┼────────────┼────────────────┤ +│ NIO │ NIO Inc. │ 25.79 │ 2.00 │ +8.41% │ 46.697M │ 53.892M │ 41.021B │ │ +├────────┼──────────────────────────────────────┼──────────────────┼────────┼──────────┼──────────┼───────────────────┼────────────┼────────────────┤ +│ AAL │ American Airlines Group Inc. │ 18.84 │ 1.41 │ +8.09% │ 46.529M │ 40.319M │ 12.203B │ │ +├────────┼──────────────────────────────────────┼──────────────────┼────────┼──────────┼──────────┼───────────────────┼────────────┼────────────────┤ +│ FB │ Meta Platforms, Inc. │ 221.00 │ 3.30 │ +1.52% │ 42.685M │ 29.422M │ 601.549B │ 16.05 │ +├────────┼──────────────────────────────────────┼──────────────────┼────────┼──────────┼──────────┼───────────────────┼────────────┼────────────────┤ +│ BAC │ Bank of America Corporation │ 47.79 │ 0.37 │ +0.78% │ 41.879M │ 52.171M │ 386.04B │ 13.39 │ +├────────┼──────────────────────────────────────┼──────────────────┼────────┼──────────┼──────────┼───────────────────┼────────────┼────────────────┤ +│ ITUB │ Itaú Unibanco Holding S.A. │ 5.14 │ 0.08 │ +1.58% │ 41.059M │ 45.848M │ 50.269B │ 9.92 │ +├────────┼──────────────────────────────────────┼──────────────────┼────────┼──────────┼──────────┼───────────────────┼────────────┼────────────────┤ +│ AMC │ AMC Entertainment Holdings, Inc. │ 19.48 │ 1.73 │ +9.75% │ 39.222M │ 49.237M │ 10B │ │ +├────────┼──────────────────────────────────────┼──────────────────┼────────┼──────────┼──────────┼───────────────────┼────────────┼────────────────┤ +│ ABEV │ Ambev S.A. │ 2.95 │ 0.05 │ +1.72% │ 38.479M │ 21.416M │ 46.429B │ 15.36 │ +├────────┼──────────────────────────────────────┼──────────────────┼────────┼──────────┼──────────┼───────────────────┼────────────┼────────────────┤ +│ INTC │ Intel Corporation │ 48.44 │ 0.86 │ +1.81% │ 35.858M │ 36.63M │ 197.248B │ 9.97 │ +├────────┼──────────────────────────────────────┼──────────────────┼────────┼──────────┼──────────┼───────────────────┼────────────┼────────────────┤ +│ VALE │ Vale S.A. │ 17.14 │ -0.35 │ -2.00% │ 33.93M │ 32.586M │ 80.669B │ 4.79 │ +├────────┼──────────────────────────────────────┼──────────────────┼────────┼──────────┼──────────┼───────────────────┼────────────┼────────────────┤ +│ UBER │ Uber Technologies, Inc. │ 37.09 │ 2.50 │ +7.23% │ 36.234M │ 32.245M │ 71.959B │ │ +├────────┼──────────────────────────────────────┼──────────────────┼────────┼──────────┼──────────┼───────────────────┼────────────┼────────────────┤ +│ FCEL │ FuelCell Energy, Inc. │ 5.49 │ 0.87 │ +18.83% │ 34.067M │ 23.922M │ 2.013B │ │ +├────────┼──────────────────────────────────────┼──────────────────┼────────┼──────────┼──────────┼───────────────────┼────────────┼────────────────┤ +│ T │ AT&T Inc. │ 24.34 │ 0.29 │ +1.21% │ 31.096M │ 62.336M │ 173.812B │ 8.82 │ +├────────┼──────────────────────────────────────┼──────────────────┼────────┼──────────┼──────────┼───────────────────┼────────────┼────────────────┤ +│ CCL │ Carnival Corporation & plc │ 22.78 │ 1.42 │ +6.65% │ 31.595M │ 43.634M │ 26.684B │ │ +├────────┼──────────────────────────────────────┼──────────────────┼────────┼──────────┼──────────┼───────────────────┼────────────┼────────────────┤ +│ NOK │ Nokia Corporation │ 5.60 │ 0.17 │ +3.13% │ 29.464M │ 24.911M │ 32.265B │ 17.07 │ +├────────┼──────────────────────────────────────┼──────────────────┼────────┼──────────┼──────────┼───────────────────┼────────────┼────────────────┤ +│ PBR │ Petróleo Brasileiro S.A. - Petrobras │ 13.77 │ -0.21 │ -1.50% │ 27.492M │ 31.187M │ 89.809B │ 3.49 │ +├────────┼──────────────────────────────────────┼──────────────────┼────────┼──────────┼──────────┼───────────────────┼────────────┼────────────────┤ +│ MSFT │ Microsoft Corporation │ 300.47 │ 5.47 │ +1.85% │ 27.379M │ 35.818M │ 2.253T │ 32.00 │ +└────────┴──────────────────────────────────────┴──────────────────┴────────┴──────────┴──────────┴───────────────────┴────────────┴────────────────┘ +``` +--- diff --git a/website/content/terminal/reference/stocks/disc/arkord.md b/website/content/terminal/reference/stocks/disc/arkord.md new file mode 100644 index 000000000000..673850bbcff9 --- /dev/null +++ b/website/content/terminal/reference/stocks/disc/arkord.md @@ -0,0 +1,110 @@ +--- +title: arkord +description: Arkord is a tool for displaying orders by ARK Investment Management LLC. + The software allows users to filter and sort stocks based on various parameters, + including volume, opening and closing values, highs and lows, and the weight of + shares. +keywords: +- arkord +- ARK Investment Management +- stocks +- buys +- sells +- fund +- orders +- shares +- volume +- open +- close +- high +- low +- weight +- sorting +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Orders by ARK Investment Management LLC - https://ark-funds.com/. [Source: https://cathiesark.com] + +### Usage + +```python +arkord [-l LIMIT] [-s {date,volume,open,high,close,low,total,weight,shares}] [-r] [-b] [-c] [--fund {ARKK,ARKF,ARKW,ARKQ,ARKG,ARKX,}] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| limit | Limit of stocks to display. | 10 | True | None | +| sort_col | Column to sort by | | True | date, volume, open, high, close, low, total, weight, shares | +| reverse | Data is sorted in descending order by default. Reverse flag will sort it in an ascending way. Only works when raw data is displayed. | False | True | None | +| buys_only | Flag to look at buys only | False | True | None | +| sells_only | Flag to look at sells only | False | True | None | +| fund | Filter by fund | | True | ARKK, ARKF, ARKW, ARKQ, ARKG, ARKX, | + + +--- + +## Examples + +```python +2022 Feb 16, 03:49 (🦋) /stocks/disc/ $ arkord + + Orders by ARK Investment Management LLC +┏━━━━━━━━━━━━┳━━━━━━━━┳━━━━━━━━━━━┳━━━━━━━━━┳━━━━━━━┳━━━━━━━┳━━━━━━━┳━━━━━━━┳━━━━━━━━━━━━┳━━━━━━┳━━━━━━━━┳━━━━━━━━┓ +┃ Date ┃ Ticker ┃ Direction ┃ Volume ┃ Open ┃ Close ┃ High ┃ Low ┃ Total ┃ Fund ┃ Weight ┃ Shares ┃ +┡━━━━━━━━━━━━╇━━━━━━━━╇━━━━━━━━━━━╇━━━━━━━━━╇━━━━━━━╇━━━━━━━╇━━━━━━━╇━━━━━━━╇━━━━━━━━━━━━╇━━━━━━╇━━━━━━━━╇━━━━━━━━┩ +│ 2022-02-15 │ TSP │ Buy │ 1960200 │ 17.52 │ 17.86 │ 17.95 │ 16.83 │ 623206.86 │ ARKK │ 0.0049 │ 34894 │ +├────────────┼────────┼───────────┼─────────┼───────┼───────┼───────┼───────┼────────────┼──────┼────────┼────────┤ +│ 2022-02-15 │ MKFG │ Buy │ 1057800 │ 4.55 │ 4.67 │ 4.73 │ 4.54 │ 94847.70 │ ARKQ │ 0.0058 │ 20310 │ +├────────────┼────────┼───────────┼─────────┼───────┼───────┼───────┼───────┼────────────┼──────┼────────┼────────┤ +│ 2022-02-15 │ TWOU │ Buy │ 6176700 │ 9.92 │ 9.77 │ 10.20 │ 9.70 │ 269749.71 │ ARKK │ 0.0023 │ 27610 │ +├────────────┼────────┼───────────┼─────────┼───────┼───────┼───────┼───────┼────────────┼──────┼────────┼────────┤ +│ 2022-02-15 │ CND │ Buy │ 926500 │ 10.29 │ 10.37 │ 10.59 │ 10.25 │ 2883415.93 │ ARKF │ 0.1825 │ 278000 │ +├────────────┼────────┼───────────┼─────────┼───────┼───────┼───────┼───────┼────────────┼──────┼────────┼────────┤ +│ 2022-02-15 │ TSP │ Buy │ 1960200 │ 17.52 │ 17.86 │ 17.95 │ 16.83 │ 675215.18 │ ARKQ │ 0.0403 │ 37806 │ +├────────────┼────────┼───────────┼─────────┼───────┼───────┼───────┼───────┼────────────┼──────┼────────┼────────┤ +│ 2022-02-15 │ AQB │ Sell │ 510200 │ 1.66 │ 1.65 │ 1.66 │ 1.62 │ 147107.40 │ ARKG │ 0.0038 │ 89156 │ +├────────────┼────────┼───────────┼─────────┼───────┼───────┼───────┼───────┼────────────┼──────┼────────┼────────┤ +│ 2022-02-15 │ CLLS │ Sell │ 182200 │ 5.69 │ 5.60 │ 5.74 │ 5.57 │ 82364.80 │ ARKG │ 0.0022 │ 14708 │ +├────────────┼────────┼───────────┼─────────┼───────┼───────┼───────┼───────┼────────────┼──────┼────────┼────────┤ +│ 2022-02-15 │ TWOU │ Buy │ 6176700 │ 9.92 │ 9.77 │ 10.20 │ 9.70 │ 57340.13 │ ARKW │ 0.0023 │ 5869 │ +├────────────┼────────┼───────────┼─────────┼───────┼───────┼───────┼───────┼────────────┼──────┼────────┼────────┤ +│ 2022-02-15 │ TWOU │ Buy │ 6176700 │ 9.92 │ 9.77 │ 10.20 │ 9.70 │ 34507.64 │ ARKQ │ 0.0022 │ 3532 │ +├────────────┼────────┼───────────┼─────────┼───────┼───────┼───────┼───────┼────────────┼──────┼────────┼────────┤ +│ 2022-02-15 │ MKFG │ Buy │ 1057800 │ 4.55 │ 4.67 │ 4.73 │ 4.54 │ 22131.13 │ ARKX │ 0.0057 │ 4739 │ +└────────────┴────────┴───────────┴─────────┴───────┴───────┴───────┴───────┴────────────┴──────┴────────┴────────┘ + +2022 Feb 16, 03:50 (🦋) /stocks/disc/ $ arkord -b --fund ARKK + + Orders by ARK Investment Management LLC +┏━━━━━━━━━━━━┳━━━━━━━━┳━━━━━━━━━━━┳━━━━━━━━━━┳━━━━━━━━┳━━━━━━━━┳━━━━━━━━┳━━━━━━━━┳━━━━━━━━━━━━━┳━━━━━━┳━━━━━━━━┳━━━━━━━━━┓ +┃ Date ┃ Ticker ┃ Direction ┃ Volume ┃ Open ┃ Close ┃ High ┃ Low ┃ Total ┃ Fund ┃ Weight ┃ Shares ┃ +┡━━━━━━━━━━━━╇━━━━━━━━╇━━━━━━━━━━━╇━━━━━━━━━━╇━━━━━━━━╇━━━━━━━━╇━━━━━━━━╇━━━━━━━━╇━━━━━━━━━━━━━╇━━━━━━╇━━━━━━━━╇━━━━━━━━━┩ +│ 2022-02-15 │ TSP │ Buy │ 1960200 │ 17.52 │ 17.86 │ 17.95 │ 16.83 │ 623206.86 │ ARKK │ 0.0049 │ 34894 │ +├────────────┼────────┼───────────┼──────────┼────────┼────────┼────────┼────────┼─────────────┼──────┼────────┼─────────┤ +│ 2022-02-15 │ TWOU │ Buy │ 6176700 │ 9.92 │ 9.77 │ 10.20 │ 9.70 │ 269749.71 │ ARKK │ 0.0023 │ 27610 │ +├────────────┼────────┼───────────┼──────────┼────────┼────────┼────────┼────────┼─────────────┼──────┼────────┼─────────┤ +│ 2022-02-14 │ HOOD │ Buy │ 21768500 │ 13.10 │ 13.35 │ 13.87 │ 12.97 │ 1423710.79 │ ARKK │ 0.0114 │ 106645 │ +├────────────┼────────┼───────────┼──────────┼────────┼────────┼────────┼────────┼─────────────┼──────┼────────┼─────────┤ +│ 2022-02-14 │ TSP │ Buy │ 3316800 │ 16.37 │ 17.23 │ 18.00 │ 16.35 │ 5257717.13 │ ARKK │ 0.0431 │ 305149 │ +├────────────┼────────┼───────────┼──────────┼────────┼────────┼────────┼────────┼─────────────┼──────┼────────┼─────────┤ +│ 2022-02-11 │ TSP │ Buy │ 3500000 │ 16.25 │ 16.47 │ 17.37 │ 16.18 │ 7952045.07 │ ARKK │ 0.0638 │ 482820 │ +├────────────┼────────┼───────────┼──────────┼────────┼────────┼────────┼────────┼─────────────┼──────┼────────┼─────────┤ +│ 2022-02-11 │ TWST │ Buy │ 3457400 │ 59.19 │ 55.99 │ 62.13 │ 55.77 │ 17381704.09 │ ARKK │ 0.1348 │ 310443 │ +├────────────┼────────┼───────────┼──────────┼────────┼────────┼────────┼────────┼─────────────┼──────┼────────┼─────────┤ +│ 2022-02-11 │ HOOD │ Buy │ 17567800 │ 13.61 │ 13.32 │ 14.19 │ 13.07 │ 2032285.63 │ ARKK │ 0.0159 │ 152574 │ +├────────────┼────────┼───────────┼──────────┼────────┼────────┼────────┼────────┼─────────────┼──────┼────────┼─────────┤ +│ 2022-02-10 │ TSP │ Buy │ 5914200 │ 15.71 │ 16.37 │ 17.96 │ 15.00 │ 4849383.57 │ ARKK │ 0.0391 │ 296236 │ +├────────────┼────────┼───────────┼──────────┼────────┼────────┼────────┼────────┼─────────────┼──────┼────────┼─────────┤ +│ 2022-02-10 │ SQ │ Buy │ 26289600 │ 109.25 │ 108.94 │ 119.00 │ 107.30 │ 13000464.13 │ ARKK │ 0.1095 │ 119336 │ +├────────────┼────────┼───────────┼──────────┼────────┼────────┼────────┼────────┼─────────────┼──────┼────────┼─────────┤ +│ 2022-02-10 │ DNA │ Buy │ 13850600 │ 5.64 │ 5.76 │ 6.30 │ 5.60 │ 12554836.34 │ ARKK │ 0.1017 │ 2179659 │ +└────────────┴────────┴───────────┴──────────┴────────┴────────┴────────┴────────┴─────────────┴──────┴────────┴─────────┘ +``` +--- diff --git a/website/content/terminal/reference/stocks/disc/asc.md b/website/content/terminal/reference/stocks/disc/asc.md new file mode 100644 index 000000000000..0c54105d764a --- /dev/null +++ b/website/content/terminal/reference/stocks/disc/asc.md @@ -0,0 +1,100 @@ +--- +title: asc +description: This documentation page provides information on 'asc', a command line + tool that fetches and displays small cap stocks with high earnings growth rates. + With customizable limit options, users can view top performing small cap stocks + with ease. Ideal for stock market enthusiasts and financial professionals looking + to filter out high-growth small cap stocks. +keywords: +- small cap stocks +- earnings growth +- stock market analysis +- financial data analysis +- stock market tools +- financial programming +- stock information display +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Print up to 25 small cap stocks with earnings growth rates better than 25%. [Source: Yahoo Finance] + +### Usage + +```python +asc [-l LIMIT] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| limit | Limit of stocks to display. | 5 | True | None | + + +--- + +## Examples + +```python +2022 Feb 16, 03:51 (🦋) /stocks/disc/ $ asc -l 25 + High Growth Small Caps +┏━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━┳━━━━━━━━┳━━━━━━━━━━┳━━━━━━━━┳━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━┓ +┃ Symbol ┃ Name ┃ Price (Intraday) ┃ Change ┃ % Change ┃ Volume ┃ Avg Vol (3 month) ┃ Market Cap ┃ PE Ratio (TTM) ┃ +┡━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━╇━━━━━━━━╇━━━━━━━━━━╇━━━━━━━━╇━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━┩ +│ RIDE │ Lordstown Motors Corp. │ 3.41 │ 0.34 │ +11.07% │ 6.245M │ 7.056M │ 655.508M │ │ +├────────┼───────────────────────────────────────────┼──────────────────┼────────┼──────────┼────────┼───────────────────┼────────────┼────────────────┤ +│ SKLZ │ Skillz Inc. │ 4.56 │ 0.59 │ +14.86% │ 13.14M │ 13.946M │ 1.861B │ │ +├────────┼───────────────────────────────────────────┼──────────────────┼────────┼──────────┼────────┼───────────────────┼────────────┼────────────────┤ +│ BGCP │ BGC Partners, Inc. │ 4.61 │ 0.33 │ +7.71% │ 5.293M │ 2.116M │ 1.7B │ 40.09 │ +├────────┼───────────────────────────────────────────┼──────────────────┼────────┼──────────┼────────┼───────────────────┼────────────┼────────────────┤ +│ TIGR │ UP Fintech Holding Limited │ 4.92 │ 0.52 │ +11.82% │ 2.734M │ 4.485M │ 798.885M │ 24.85 │ +├────────┼───────────────────────────────────────────┼──────────────────┼────────┼──────────┼────────┼───────────────────┼────────────┼────────────────┤ +│ EDIT │ Editas Medicine, Inc. │ 16.65 │ 0.86 │ +5.45% │ 1.386M │ 1.774M │ 1.139B │ │ +├────────┼───────────────────────────────────────────┼──────────────────┼────────┼──────────┼────────┼───────────────────┼────────────┼────────────────┤ +│ DM │ Desktop Metal, Inc. │ 4.36 │ 0.41 │ +10.38% │ 5.407M │ 5.977M │ 1.356B │ │ +├────────┼───────────────────────────────────────────┼──────────────────┼────────┼──────────┼────────┼───────────────────┼────────────┼────────────────┤ +│ APRN │ Blue Apron Holdings, Inc. │ 6.27 │ 0.35 │ +5.91% │ 1.29M │ 1.444M │ 198.724M │ │ +├────────┼───────────────────────────────────────────┼──────────────────┼────────┼──────────┼────────┼───────────────────┼────────────┼────────────────┤ +│ CRK │ Comstock Resources, Inc. │ 7.30 │ -0.14 │ -1.88% │ 4.106M │ 3.487M │ 1.7B │ │ +├────────┼───────────────────────────────────────────┼──────────────────┼────────┼──────────┼────────┼───────────────────┼────────────┼────────────────┤ +│ GOEV │ Canoo Inc. │ 6.22 │ 0.27 │ +4.54% │ 1.97M │ 5.864M │ 1.485B │ │ +├────────┼───────────────────────────────────────────┼──────────────────┼────────┼──────────┼────────┼───────────────────┼────────────┼────────────────┤ +│ BEST │ BEST Inc. │ 1.12 │ 0.09 │ +8.74% │ 1.633M │ 1.706M │ 435.344M │ │ +├────────┼───────────────────────────────────────────┼──────────────────┼────────┼──────────┼────────┼───────────────────┼────────────┼────────────────┤ +│ BLU │ BELLUS Health Inc. │ 7.06 │ 0.00 │ 0.00% │ 1.344M │ 3.323M │ 751.163M │ │ +├────────┼───────────────────────────────────────────┼──────────────────┼────────┼──────────┼────────┼───────────────────┼────────────┼────────────────┤ +│ HYLN │ Hyliion Holdings Corp. │ 4.22 │ 0.23 │ +5.76% │ 1.988M │ 2.863M │ 731.381M │ │ +├────────┼───────────────────────────────────────────┼──────────────────┼────────┼──────────┼────────┼───────────────────┼────────────┼────────────────┤ +│ VLDR │ Velodyne Lidar, Inc. │ 4.25 │ 0.31 │ +7.87% │ 5.567M │ 5.266M │ 841.793M │ │ +├────────┼───────────────────────────────────────────┼──────────────────┼────────┼──────────┼────────┼───────────────────┼────────────┼────────────────┤ +│ HUYA │ HUYA Inc. │ 6.09 │ 0.44 │ +7.79% │ 1.952M │ 2.844M │ 1.445B │ 8.13 │ +├────────┼───────────────────────────────────────────┼──────────────────┼────────┼──────────┼────────┼───────────────────┼────────────┼────────────────┤ +│ PEI │ Pennsylvania Real Estate Investment Trust │ 0.90 │ 0.03 │ +3.38% │ 329076 │ 752054 │ 74.214M │ │ +├────────┼───────────────────────────────────────────┼──────────────────┼────────┼──────────┼────────┼───────────────────┼────────────┼────────────────┤ +│ APPH │ AppHarvest, Inc. │ 3.12 │ 0.09 │ +2.97% │ 782043 │ 1.479M │ 314.945M │ │ +├────────┼───────────────────────────────────────────┼──────────────────┼────────┼──────────┼────────┼───────────────────┼────────────┼────────────────┤ +│ FSM │ Fortuna Silver Mines Inc. │ 3.66 │ 0.00 │ 0.00% │ 3.637M │ 4.569M │ 1.068B │ 12.93 │ +├────────┼───────────────────────────────────────────┼──────────────────┼────────┼──────────┼────────┼───────────────────┼────────────┼────────────────┤ +│ BGFV │ Big 5 Sporting Goods Corporation │ 18.26 │ 0.94 │ +5.43% │ 603600 │ 1.137M │ 407.395M │ 3.97 │ +├────────┼───────────────────────────────────────────┼──────────────────┼────────┼──────────┼────────┼───────────────────┼────────────┼────────────────┤ +│ ZEV │ Lightning eMotors, Inc. │ 5.49 │ 0.40 │ +7.86% │ 579157 │ 1.412M │ 411.507M │ │ +├────────┼───────────────────────────────────────────┼──────────────────┼────────┼──────────┼────────┼───────────────────┼────────────┼────────────────┤ +│ DNMR │ Danimer Scientific, Inc. │ 4.07 │ 0.41 │ +11.20% │ 4.452M │ 3.75M │ 408.4M │ │ +├────────┼───────────────────────────────────────────┼──────────────────┼────────┼──────────┼────────┼───────────────────┼────────────┼────────────────┤ +│ ORPH │ Orphazyme A/S │ 2.13 │ 0.13 │ +6.50% │ 553864 │ 989978 │ 74.448M │ │ +├────────┼───────────────────────────────────────────┼──────────────────┼────────┼──────────┼────────┼───────────────────┼────────────┼────────────────┤ +│ REAL │ The RealReal, Inc. │ 9.89 │ 0.70 │ +7.62% │ 2.514M │ 3.049M │ 913.715M │ │ +├────────┼───────────────────────────────────────────┼──────────────────┼────────┼──────────┼────────┼───────────────────┼────────────┼────────────────┤ +│ USA │ Liberty All-Star Equity Fund │ 7.52 │ 0.12 │ +1.62% │ 796155 │ 1.374M │ 1.683B │ 2.88 │ +├────────┼───────────────────────────────────────────┼──────────────────┼────────┼──────────┼────────┼───────────────────┼────────────┼────────────────┤ +│ DHY │ Credit Suisse High Yield Bond Fund, Inc. │ 2.23 │ -0.00 │ -0.20% │ 509800 │ 335704 │ 230.836M │ 6.39 │ +├────────┼───────────────────────────────────────────┼──────────────────┼────────┼──────────┼────────┼───────────────────┼────────────┼────────────────┤ +│ CENX │ Century Aluminum Company │ 20.35 │ 1.26 │ +6.60% │ 1.887M │ 1.268M │ 1.834B │ │ +└────────┴───────────────────────────────────────────┴──────────────────┴────────┴──────────┴────────┴───────────────────┴────────────┴────────────────┘ +``` +--- diff --git a/website/content/terminal/reference/stocks/disc/cnews.md b/website/content/terminal/reference/stocks/disc/cnews.md new file mode 100644 index 000000000000..3faf54c3ba56 --- /dev/null +++ b/website/content/terminal/reference/stocks/disc/cnews.md @@ -0,0 +1,93 @@ +--- +title: cnews +description: cnews page provides an interface to access customized news from various + sectors such as crypto, buybacks, politics, healthcare, and many more, sourced from + Seeking Alpha. Users can limit the number of news displayed and select specific + news type for display. +keywords: +- cnews +- customized news +- Seeking Alpha +- top-news +- crypto +- issuance +- buybacks +- commodities +- spacs +- politics +- consumer +- energy +- financials +- healthcare +- mlps +- reits +- technology +- stock repurchase program +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Customized news. [Source: Seeking Alpha] + +### Usage + +```python +cnews [-t {top-news,on-the-move,market-pulse,notable-calls,buybacks,commodities,crypto,issuance,global,guidance,ipos,spacs,politics,m-a,consumer,energy,financials,healthcare,mlps,reits,technology}] [-l LIMIT] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| s_type | number of news to display | Top-News | True | top-news, on-the-move, market-pulse, notable-calls, buybacks, commodities, crypto, issuance, global, guidance, ipos, spacs, politics, m-a, consumer, energy, financials, healthcare, mlps, reits, technology | +| limit | limit of news to display | 5 | True | None | + + +--- + +## Examples + +```python +2022 Feb 16, 03:52 (🦋) /stocks/disc/ $ cnews +2022-02-15 19:04:21 - 3800509 - ViacomCBS earnings call: A flood of content feeding transformation to Paramount +https://seekingalpha.com/news/3800509-viacomcbs-earnings-call-a-flood-of-content-feeding-transformation-to-paramount + +2022-02-15 16:26:46 - 3800415 - ViacomCBS rebranding company as Paramount Global +https://seekingalpha.com/news/3800415-viacomcbs-rebranding-company-as-paramount-global + +2022-02-15 16:25:33 - 3800411 - Airbnb stock soars after guidance comes in strong +https://seekingalpha.com/news/3800411-airbnb-stock-soars-after-guidance-comes-in-strong + +2022-02-15 16:25:05 - 3800410 - ViacomCBS rebranding company as Paramount Global +https://seekingalpha.com/news/3800410-viacomcbs-rebranding-company-as-paramount-global + +2022-02-15 16:14:45 - 3800380 - ViacomCBS dips as profits dip despite revenue beat, streaming gains +https://seekingalpha.com/news/3800380-viacomcbs-dips-as-profits-dip-despite-revenue-beat-streaming-gains + +2022-02-15 16:14:20 - 3800378 - Wynn Resorts trades lower after earnings, Encore Boston sale +https://seekingalpha.com/news/3800378-wynn-resorts-trades-lower-after-earnings-encore-boston-sale + +2022 Feb 16, 03:52 (🦋) /stocks/disc/ $ cnews -t buybacks +2022-02-15 16:24:36 - 3800409 - DHI launches new $15M in stock repurchase program +https://seekingalpha.com/news/3800409-dhi-launches-new-15m-in-stock-repurchase-program + +2022-02-15 16:20:21 - 3800395 - Upstart stock soars after Q4 earnings beat, strong guidance, stock buyback +https://seekingalpha.com/news/3800395-upstart-stock-soars-after-q4-earnings-beat-strong-guidance-stock-buyback + +2022-02-15 16:17:07 - 3800387 - Upstart announces $400M share repurchase program +https://seekingalpha.com/news/3800387-upstart-announces-400m-share-repurchase-program + +2022-02-15 08:04:55 - 3800026 - GCM Grosvenor reports Q4 results, increases stock repurchase plan by $20M +https://seekingalpha.com/news/3800026-gcm-grosvenor-reports-q4-results-increases-stock-repurchase-plan-by-20m + +2022-02-15 08:04:08 - 3800020 - Middlefield Banc declares $0.17 dividend; expands stock buyback plan +https://seekingalpha.com/news/3800020-middlefield-banc-corp-declares-0_17-dividend + +2022-02-15 07:26:40 - 3799989 - LGI Homes expands stock repurchase program by $200M +https://seekingalpha.com/news/3799989-lgi-homes-expands-stock-repurchase-program-by-200m +``` +--- diff --git a/website/versioned_docs/version-v3/terminal/reference/stocks/disc/divcal.md b/website/content/terminal/reference/stocks/disc/divcal.md similarity index 92% rename from website/versioned_docs/version-v3/terminal/reference/stocks/disc/divcal.md rename to website/content/terminal/reference/stocks/disc/divcal.md index ff5b87ae9271..9a3f5150f7b3 100644 --- a/website/versioned_docs/version-v3/terminal/reference/stocks/disc/divcal.md +++ b/website/content/terminal/reference/stocks/disc/divcal.md @@ -1,9 +1,23 @@ --- title: divcal -description: OpenBB Terminal Function +description: Guide to use divcal for acquiring dividend calendar for a selected date + in the stock market. The parameters include date, sort, and reverse. The data includes + Name, Symbol, Ex-Dividend date, Payment date, Record date, Dividend, and Annual + Dividend. +keywords: +- divcal +- dividend calendar +- stock market +- ex-dividend date +- payment date +- record date +- annual dividend +- announcement date --- -# divcal +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + Get dividend calendar for selected date diff --git a/website/content/terminal/reference/stocks/disc/fipo.md b/website/content/terminal/reference/stocks/disc/fipo.md new file mode 100644 index 000000000000..b78d1adb77cb --- /dev/null +++ b/website/content/terminal/reference/stocks/disc/fipo.md @@ -0,0 +1,56 @@ +--- +title: fipo +description: This documentation page provides information and examples on using the + 'fipo' function, a tool for retrieving future IPO date estimates from financial + data source Finnhub.io. This aids users in planning for upcoming IPOs by providing + essential details such as exchange name, company name, number of shares, expected + price, status, and total share value. +keywords: +- IPO +- Stock market +- future IPO dates +- SMART FOR LIFE, INC. +- NASDAQ Capital +- FinTech +- Finnhub.io +- Stock exchange +- Investment +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Future IPOs dates. [Source: https://finnhub.io] + +### Usage + +```python +fipo [-d DAYS] [-s END] [-l LIMIT] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| days | Number of days in the future to look for IPOs. | 5 | True | None | +| end | The end date (format YYYY-MM-DD) to look for IPOs, starting from today. When set, end date will override --days argument | None | True | None | +| limit | Limit number of IPOs to display. | 20 | True | None | + + +--- + +## Examples + +```python +2022 Feb 16, 03:59 (🦋) /stocks/disc/ $ fipo + Future IPO Dates +┏━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━┳━━━━━━━━━━┳━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━┓ +┃ Future ┃ Exchange ┃ Name ┃ Number of Shares ┃ Price ┃ Status ┃ symbol ┃ Total Shares Value ┃ +┡━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━╇━━━━━━━━━━╇━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━┩ +│ 2022-02-16 │ NASDAQ Capital │ SMART FOR LIFE, INC. │ 1800000 │ 9.00-11.00 │ expected │ SMFL │ 22770000 │ +└────────────┴────────────────┴──────────────────────┴──────────────────┴────────────┴──────────┴────────┴────────────────────┘ +``` +--- diff --git a/website/content/terminal/reference/stocks/disc/gainers.md b/website/content/terminal/reference/stocks/disc/gainers.md new file mode 100644 index 000000000000..868f8c877529 --- /dev/null +++ b/website/content/terminal/reference/stocks/disc/gainers.md @@ -0,0 +1,95 @@ +--- +title: gainers +description: This page provides a method to print the top 25 stock gainers using Python. + You can customize the limit of stocks you want to display. This information is sourced + from Yahoo Finance. +keywords: +- stock market +- top gainers +- Yahoo Finance +- stock limit display +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Print up to 25 top gainers. [Source: Yahoo Finance] + +### Usage + +```python +gainers [-l LIMIT] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| limit | Limit of stocks to display. | 5 | True | None | + + +--- + +## Examples + +```python +2022 Feb 16, 04:02 (🦋) /stocks/disc/ $ gainers -l 25 + Gainers +┏━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━┳━━━━━━━━┳━━━━━━━━━━┳━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━┓ +┃ Symbol ┃ Name ┃ Price (Intraday) ┃ Change ┃ % Change ┃ Volume ┃ Avg Vol (3 month) ┃ Market Cap ┃ PE Ratio (TTM) ┃ +┡━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━╇━━━━━━━━╇━━━━━━━━━━╇━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━┩ +│ TSEM │ Tower Semiconductor Ltd. │ 47.07 │ 13.94 │ +42.08% │ 19.666M │ 484573 │ 5.29B │ 39.59 │ +├────────┼──────────────────────────────────────────────────────┼──────────────────┼────────┼──────────┼─────────┼───────────────────┼────────────┼────────────────┤ +│ SPCE │ Virgin Galactic Holdings, Inc. │ 10.74 │ 2.60 │ +31.94% │ 178.62M │ 14.077M │ 2.771B │ │ +├────────┼──────────────────────────────────────────────────────┼──────────────────┼────────┼──────────┼─────────┼───────────────────┼────────────┼────────────────┤ +│ JOBY │ Joby Aviation, Inc. │ 6.04 │ 1.28 │ +26.89% │ 17.994M │ 4.128M │ 3.648B │ │ +├────────┼──────────────────────────────────────────────────────┼──────────────────┼────────┼──────────┼─────────┼───────────────────┼────────────┼────────────────┤ +│ BBAJF │ Banco del Bajío, S.A., Institución de Banca Múltiple │ 2.48 │ 0.46 │ +22.54% │ 40917 │ 2047 │ 3.564B │ 9.78 │ +├────────┼──────────────────────────────────────────────────────┼──────────────────┼────────┼──────────┼─────────┼───────────────────┼────────────┼────────────────┤ +│ IBRX │ ImmunityBio, Inc. │ 7.03 │ 1.28 │ +22.26% │ 5.772M │ 1.764M │ 2.797B │ │ +├────────┼──────────────────────────────────────────────────────┼──────────────────┼────────┼──────────┼─────────┼───────────────────┼────────────┼────────────────┤ +│ SABR │ Sabre Corporation │ 10.97 │ 1.97 │ +21.89% │ 19.887M │ 7.994M │ 3.548B │ │ +├────────┼──────────────────────────────────────────────────────┼──────────────────┼────────┼──────────┼─────────┼───────────────────┼────────────┼────────────────┤ +│ TAL │ TAL Education Group │ 3.78 │ 0.67 │ +21.54% │ 18.245M │ 12.731M │ 2.438B │ │ +├────────┼──────────────────────────────────────────────────────┼──────────────────┼────────┼──────────┼─────────┼───────────────────┼────────────┼────────────────┤ +│ BHG │ Bright Health Group, Inc. │ 3.56 │ 0.60 │ +20.27% │ 9.546M │ 4.293M │ 2.238B │ │ +├────────┼──────────────────────────────────────────────────────┼──────────────────┼────────┼──────────┼─────────┼───────────────────┼────────────┼────────────────┤ +│ FCEL │ FuelCell Energy, Inc. │ 5.49 │ 0.87 │ +18.83% │ 34.067M │ 23.922M │ 2.013B │ │ +├────────┼──────────────────────────────────────────────────────┼──────────────────┼────────┼──────────┼─────────┼───────────────────┼────────────┼────────────────┤ +│ DELHY │ Delivery Hero SE │ 5.65 │ 0.85 │ +17.71% │ 186351 │ 87198 │ 14.181B │ │ +├────────┼──────────────────────────────────────────────────────┼──────────────────┼────────┼──────────┼─────────┼───────────────────┼────────────┼────────────────┤ +│ YNDX │ Yandex N.V. │ 52.40 │ 7.22 │ +15.98% │ 8.061M │ 2.784M │ 18.797B │ │ +├────────┼──────────────────────────────────────────────────────┼──────────────────┼────────┼──────────┼─────────┼───────────────────┼────────────┼────────────────┤ +│ YMM │ Full Truck Alliance Co. Ltd. │ 9.86 │ 1.35 │ +15.86% │ 4.733M │ 5.647M │ 10.706B │ │ +├────────┼──────────────────────────────────────────────────────┼──────────────────┼────────┼──────────┼─────────┼───────────────────┼────────────┼────────────────┤ +│ SE │ Sea Limited │ 149.55 │ 20.38 │ +15.78% │ 15.176M │ 7.888M │ 83.41B │ │ +├────────┼──────────────────────────────────────────────────────┼──────────────────┼────────┼──────────┼─────────┼───────────────────┼────────────┼────────────────┤ +│ OZON │ Ozon Holdings PLC │ 22.23 │ 3.00 │ +15.60% │ 2.356M │ 1.501M │ 4.809B │ │ +├────────┼──────────────────────────────────────────────────────┼──────────────────┼────────┼──────────┼─────────┼───────────────────┼────────────┼────────────────┤ +│ AMKR │ Amkor Technology, Inc. │ 24.19 │ 3.04 │ +14.37% │ 3.905M │ 955511 │ 5.917B │ 10.66 │ +├────────┼──────────────────────────────────────────────────────┼──────────────────┼────────┼──────────┼─────────┼───────────────────┼────────────┼────────────────┤ +│ CHPT │ ChargePoint Holdings, Inc. │ 15.26 │ 1.88 │ +14.05% │ 11.435M │ 10.295M │ 5.051B │ │ +├────────┼──────────────────────────────────────────────────────┼──────────────────┼────────┼──────────┼─────────┼───────────────────┼────────────┼────────────────┤ +│ BE │ Bloom Energy Corporation │ 19.93 │ 2.42 │ +13.82% │ 8.296M │ 3.38M │ 3.517B │ │ +├────────┼──────────────────────────────────────────────────────┼──────────────────┼────────┼──────────┼─────────┼───────────────────┼────────────┼────────────────┤ +│ WXXWY │ WuXi Biologics (Cayman) Inc. │ 16.06 │ 1.88 │ +13.26% │ 286881 │ 265244 │ 33.487B │ 79.50 │ +├────────┼──────────────────────────────────────────────────────┼──────────────────┼────────┼──────────┼─────────┼───────────────────┼────────────┼────────────────┤ +│ ZG │ Zillow Group, Inc. │ 64.88 │ 7.53 │ +13.13% │ 2.798M │ 1.167M │ 16.413B │ │ +├────────┼──────────────────────────────────────────────────────┼──────────────────┼────────┼──────────┼─────────┼───────────────────┼────────────┼────────────────┤ +│ JKS │ JinkoSolar Holding Co., Ltd. │ 44.28 │ 5.05 │ +12.87% │ 1.045M │ 1.217M │ 2.112B │ │ +├────────┼──────────────────────────────────────────────────────┼──────────────────┼────────┼──────────┼─────────┼───────────────────┼────────────┼────────────────┤ +│ Z │ Zillow Group, Inc. │ 65.16 │ 7.09 │ +12.21% │ 19.876M │ 6.241M │ 16.279B │ │ +├────────┼──────────────────────────────────────────────────────┼──────────────────┼────────┼──────────┼─────────┼───────────────────┼────────────┼────────────────┤ +│ TUYA │ Tuya Inc. │ 6.50 │ 0.70 │ +12.07% │ 994793 │ 2.268M │ 3.638B │ │ +├────────┼──────────────────────────────────────────────────────┼──────────────────┼────────┼──────────┼─────────┼───────────────────┼────────────┼────────────────┤ +│ MARA │ Marathon Digital Holdings, Inc. │ 28.63 │ 3.08 │ +12.05% │ 15.776M │ 12.787M │ 2.938B │ │ +├────────┼──────────────────────────────────────────────────────┼──────────────────┼────────┼──────────┼─────────┼───────────────────┼────────────┼────────────────┤ +│ LFST │ LifeStance Health Group, Inc. │ 9.24 │ 0.98 │ +11.86% │ 572335 │ 1.075M │ 3.457B │ │ +├────────┼──────────────────────────────────────────────────────┼──────────────────┼────────┼──────────┼─────────┼───────────────────┼────────────┼────────────────┤ +│ IMAB │ I-Mab │ 27.82 │ 2.93 │ +11.77% │ 1.13M │ 655100 │ 2.224B │ │ +└────────┴──────────────────────────────────────────────────────┴──────────────────┴────────┴──────────┴─────────┴───────────────────┴────────────┴────────────────┘ +``` +--- diff --git a/website/content/terminal/reference/stocks/disc/gtech.md b/website/content/terminal/reference/stocks/disc/gtech.md new file mode 100644 index 000000000000..c7ca046a8f74 --- /dev/null +++ b/website/content/terminal/reference/stocks/disc/gtech.md @@ -0,0 +1,94 @@ +--- +title: gtech +description: Display top tech stocks with significant revenue and earnings growth. + Limit the number of displayed stocks as desired. Source data from Yahoo Finance. +keywords: +- stocks +- tech stocks +- revenue +- earnings growth +- stock display +- Yahoo Finance +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Print up to 25 top tech stocks with revenue and earnings growth in excess of 25%. [Source: Yahoo Finance] + +### Usage + +```python +gtech [-l LIMIT] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| limit | Limit of stocks to display. | 5 | True | None | + + +--- + +## Examples + +```python +2022 Feb 16, 04:03 (🦋) /stocks/disc/ $ gtech -l 25 + Growth Tech Stocks +┏━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━┳━━━━━━━━┳━━━━━━━━━━┳━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━┓ +┃ Symbol ┃ Name ┃ Price (Intraday) ┃ Change ┃ % Change ┃ Volume ┃ Avg Vol (3 month) ┃ Market Cap ┃ PE Ratio (TTM) ┃ +┡━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━╇━━━━━━━━╇━━━━━━━━━━╇━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━┩ +│ AFRM │ Affirm Holdings, Inc. │ 44.80 │ 1.10 │ +2.52% │ 27.207M │ 13.585M │ 12.744B │ │ +├────────┼─────────────────────────────────────┼──────────────────┼────────┼──────────┼─────────┼───────────────────┼────────────┼────────────────┤ +│ NVDA │ NVIDIA Corporation │ 264.95 │ 22.28 │ +9.18% │ 70.175M │ 51.247M │ 660.255B │ 81.70 │ +├────────┼─────────────────────────────────────┼──────────────────┼────────┼──────────┼─────────┼───────────────────┼────────────┼────────────────┤ +│ MU │ Micron Technology, Inc. │ 96.00 │ 6.14 │ +6.83% │ 27.084M │ 21.734M │ 107.499B │ 14.86 │ +├────────┼─────────────────────────────────────┼──────────────────┼────────┼──────────┼─────────┼───────────────────┼────────────┼────────────────┤ +│ UMC │ United Microelectronics Corporation │ 9.90 │ 0.41 │ +4.32% │ 14.052M │ 8.722M │ 24.52B │ 12.07 │ +├────────┼─────────────────────────────────────┼──────────────────┼────────┼──────────┼─────────┼───────────────────┼────────────┼────────────────┤ +│ ZM │ Zoom Video Communications, Inc. │ 146.90 │ 4.81 │ +3.39% │ 2.974M │ 4.748M │ 43.775B │ 39.04 │ +├────────┼─────────────────────────────────────┼──────────────────┼────────┼──────────┼─────────┼───────────────────┼────────────┼────────────────┤ +│ QCOM │ QUALCOMM Incorporated │ 173.00 │ 7.87 │ +4.77% │ 11.103M │ 11.057M │ 194.971B │ 19.83 │ +├────────┼─────────────────────────────────────┼──────────────────┼────────┼──────────┼─────────┼───────────────────┼────────────┼────────────────┤ +│ ON │ ON Semiconductor Corporation │ 62.24 │ 3.58 │ +6.10% │ 6.39M │ 7.297M │ 26.919B │ 27.42 │ +├────────┼─────────────────────────────────────┼──────────────────┼────────┼──────────┼─────────┼───────────────────┼────────────┼────────────────┤ +│ AMAT │ Applied Materials, Inc. │ 139.84 │ 7.98 │ +6.05% │ 9.069M │ 8.525M │ 124.177B │ 21.85 │ +├────────┼─────────────────────────────────────┼──────────────────┼────────┼──────────┼─────────┼───────────────────┼────────────┼────────────────┤ +│ SQ │ Block, Inc. │ 115.21 │ 3.57 │ +3.20% │ 16.322M │ 13.814M │ 66.207B │ 115.56 │ +├────────┼─────────────────────────────────────┼──────────────────┼────────┼──────────┼─────────┼───────────────────┼────────────┼────────────────┤ +│ DM │ Desktop Metal, Inc. │ 4.36 │ 0.41 │ +10.38% │ 5.407M │ 5.977M │ 1.356B │ │ +├────────┼─────────────────────────────────────┼──────────────────┼────────┼──────────┼─────────┼───────────────────┼────────────┼────────────────┤ +│ NET │ Cloudflare, Inc. │ 115.35 │ 9.79 │ +9.27% │ 5.154M │ 5.423M │ 37.329B │ │ +├────────┼─────────────────────────────────────┼──────────────────┼────────┼──────────┼─────────┼───────────────────┼────────────┼────────────────┤ +│ LSPD │ Lightspeed Commerce Inc. │ 31.73 │ 3.00 │ +10.44% │ 1.443M │ 1.506M │ 4.712B │ │ +├────────┼─────────────────────────────────────┼──────────────────┼────────┼──────────┼─────────┼───────────────────┼────────────┼────────────────┤ +│ CRWD │ CrowdStrike Holdings, Inc. │ 189.30 │ 8.70 │ +4.82% │ 2.471M │ 4.331M │ 43.414B │ │ +├────────┼─────────────────────────────────────┼──────────────────┼────────┼──────────┼─────────┼───────────────────┼────────────┼────────────────┤ +│ COIN │ Coinbase Global, Inc. │ 208.95 │ 13.70 │ +7.02% │ 3.714M │ 4.699M │ 54.724B │ 15.72 │ +├────────┼─────────────────────────────────────┼──────────────────┼────────┼──────────┼─────────┼───────────────────┼────────────┼────────────────┤ +│ BILL │ Bill.com Holdings, Inc. │ 253.72 │ 13.72 │ +5.72% │ 1.855M │ 2.43M │ 26.281B │ │ +├────────┼─────────────────────────────────────┼──────────────────┼────────┼──────────┼─────────┼───────────────────┼────────────┼────────────────┤ +│ RNG │ RingCentral, Inc. │ 173.12 │ 4.96 │ +2.95% │ 706714 │ 1.24M │ 16.177B │ │ +├────────┼─────────────────────────────────────┼──────────────────┼────────┼──────────┼─────────┼───────────────────┼────────────┼────────────────┤ +│ HIMX │ Himax Technologies, Inc. │ 12.10 │ 1.10 │ +10.00% │ 3.812M │ 4.038M │ 2.106B │ 6.42 │ +├────────┼─────────────────────────────────────┼──────────────────┼────────┼──────────┼─────────┼───────────────────┼────────────┼────────────────┤ +│ XLNX │ Xilinx, Inc. │ 194.92 │ 0.00 │ 0.00% │ 0 │ 4.072M │ 48.415B │ 52.38 │ +├────────┼─────────────────────────────────────┼──────────────────┼────────┼──────────┼─────────┼───────────────────┼────────────┼────────────────┤ +│ AI │ C3.ai, Inc. │ 25.71 │ 1.11 │ +4.51% │ 3.158M │ 4.016M │ 2.701B │ │ +├────────┼─────────────────────────────────────┼──────────────────┼────────┼──────────┼─────────┼───────────────────┼────────────┼────────────────┤ +│ ZS │ Zscaler, Inc. │ 285.82 │ 11.39 │ +4.15% │ 2.136M │ 2.648M │ 40.038B │ │ +├────────┼─────────────────────────────────────┼──────────────────┼────────┼──────────┼─────────┼───────────────────┼────────────┼────────────────┤ +│ DQ │ Daqo New Energy Corp. │ 41.34 │ 3.14 │ +8.22% │ 638902 │ 1.471M │ 3.039B │ 4.60 │ +├────────┼─────────────────────────────────────┼──────────────────┼────────┼──────────┼─────────┼───────────────────┼────────────┼────────────────┤ +│ STEM │ Stem, Inc. │ 11.39 │ 0.86 │ +8.17% │ 2.62M │ 3.865M │ 1.744B │ │ +├────────┼─────────────────────────────────────┼──────────────────┼────────┼──────────┼─────────┼───────────────────┼────────────┼────────────────┤ +│ CIEN │ Ciena Corporation │ 68.53 │ 4.71 │ +7.38% │ 4.286M │ 1.676M │ 10.614B │ 21.48 │ +├────────┼─────────────────────────────────────┼──────────────────┼────────┼──────────┼─────────┼───────────────────┼────────────┼────────────────┤ +│ YMM │ Full Truck Alliance Co. Ltd. │ 9.86 │ 1.35 │ +15.86% │ 4.733M │ 5.647M │ 10.706B │ │ +└────────┴─────────────────────────────────────┴──────────────────┴────────┴──────────┴─────────┴───────────────────┴────────────┴────────────────┘ +``` +--- diff --git a/website/content/terminal/reference/stocks/disc/heatmap.md b/website/content/terminal/reference/stocks/disc/heatmap.md new file mode 100644 index 000000000000..aa24bff179eb --- /dev/null +++ b/website/content/terminal/reference/stocks/disc/heatmap.md @@ -0,0 +1,37 @@ +--- +title: heatmap +description: This page describes how to use the heatmap tool which provides an interactive + treemap of the SP 500 from finviz. It includes usage examples and a detailed description + of parameters. +keywords: +- heatmap tool +- SP 500 heatmap +- interactive treemap +- finviz +- usage examples +- tool parameters +- timeframe parameter +- data visualization +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Get the SP 500 heatmap from finviz and display in interactive treemap + +### Usage + +```python +heatmap [-t {day,week,month,3month,6month,year,ytd}] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| timeframe | Timeframe to get heatmap data for | day | True | day, week, month, 3month, 6month, year, ytd | + +--- diff --git a/website/content/terminal/reference/stocks/disc/hotpenny.md b/website/content/terminal/reference/stocks/disc/hotpenny.md new file mode 100644 index 000000000000..f9bd2ed91636 --- /dev/null +++ b/website/content/terminal/reference/stocks/disc/hotpenny.md @@ -0,0 +1,55 @@ +--- +title: hotpenny +description: The hotpenny webpage provides a list of top penny stocks sourced from + various websites. It displays price, volume, trade changes, and allows users to + limit the number of stocks displayed. +keywords: +- hotpenny +- penny stocks +- stock market +- trade changes +- stock volume +- stock price +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Provides top penny stocks from various websites. [Source: Yfinance] + +### Usage + +```python +hotpenny [-l LIMIT] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| limit | limit of stocks to display | 5 | True | None | + + +--- + +## Examples + +```python +2022 Feb 16, 04:04 (🦋) /stocks/disc/ $ hotpenny + Top Penny Stocks +┏━━━━━━━┳━━━━━━━━┳━━━━━━━━┳━━━━━━━━━━━━━━┳━━━━━━━━━━━┳━━━━━━━━━━┓ +┃ ┃ Price ┃ Change ┃ $ Volume ┃ Volume ┃ # Trades ┃ +┡━━━━━━━╇━━━━━━━━╇━━━━━━━━╇━━━━━━━━━━━━━━╇━━━━━━━━━━━╇━━━━━━━━━━┩ +│ TCEHY │ $61.01 │ 1.55% │ $303,380,785 │ 4,994,963 │ 17,401 │ +├───────┼────────┼────────┼──────────────┼───────────┼──────────┤ +│ GBTC │ $31.28 │ 6.25% │ $110,596,120 │ 3,545,597 │ 14,364 │ +├───────┼────────┼────────┼──────────────┼───────────┼──────────┤ +│ BHPLF │ $33.74 │ -1.06% │ $65,818,744 │ 1,962,313 │ 23 │ +├───────┼────────┼────────┼──────────────┼───────────┼──────────┤ +│ RHHBY │ $46.92 │ 1.49% │ $56,390,274 │ 1,201,629 │ 2,463 │ +└───────┴────────┴────────┴──────────────┴───────────┴──────────┘ +``` +--- diff --git a/website/content/terminal/reference/stocks/disc/losers.md b/website/content/terminal/reference/stocks/disc/losers.md new file mode 100644 index 000000000000..ad68b2d503d3 --- /dev/null +++ b/website/content/terminal/reference/stocks/disc/losers.md @@ -0,0 +1,96 @@ +--- +title: losers +description: This page explains the usage of the 'losers' command in stocks software/tool. + It allows the user to display up to 25 top market losers data from Yahoo Finance + with specific parameters and examples. +keywords: +- stocks +- market losers +- stock market +- Yahoo Finance +- stock tracking +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Print up to 25 top losers. [Source: Yahoo Finance] + +### Usage + +```python +losers [-l LIMIT] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| limit | Limit of stocks to display. | 5 | True | None | + + +--- + +## Examples + +```python +2022 Feb 16, 04:07 (🦋) /stocks/disc/ $ losers -l 25 + Display Losers +┏━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━┳━━━━━━━━┳━━━━━━━━━━┳━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━┓ +┃ Symbol ┃ Name ┃ Price (Intraday) ┃ Change ┃ % Change ┃ Volume ┃ Avg Vol (3 month) ┃ Market Cap ┃ PE Ratio (TTM) ┃ +┡━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━╇━━━━━━━━╇━━━━━━━━━━╇━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━┩ +│ MEDP │ Medpace Holdings, Inc. │ 138.87 │ -35.36 │ -20.30% │ 2.262M │ 240165 │ 4.991B │ 28.75 │ +├────────┼──────────────────────────────────────────────────┼──────────────────┼────────┼──────────┼─────────┼───────────────────┼────────────┼────────────────┤ +│ CAR │ Avis Budget Group, Inc. │ 171.25 │ -23.46 │ -12.05% │ 3.66M │ 984295 │ 9.667B │ 14.50 │ +├────────┼──────────────────────────────────────────────────┼──────────────────┼────────┼──────────┼─────────┼───────────────────┼────────────┼────────────────┤ +│ PRI │ Primerica, Inc. │ 137.13 │ -14.35 │ -9.47% │ 537376 │ 151716 │ 5.415B │ 12.44 │ +├────────┼──────────────────────────────────────────────────┼──────────────────┼────────┼──────────┼─────────┼───────────────────┼────────────┼────────────────┤ +│ RCRUY │ Recruit Holdings Co., Ltd. │ 8.94 │ -0.84 │ -8.63% │ 848219 │ 409847 │ 74.455B │ 36.27 │ +├────────┼──────────────────────────────────────────────────┼──────────────────┼────────┼──────────┼─────────┼───────────────────┼────────────┼────────────────┤ +│ HMY │ Harmony Gold Mining Company Limited │ 3.61 │ -0.34 │ -8.61% │ 13.117M │ 5.722M │ 2.204B │ 6.67 │ +├────────┼──────────────────────────────────────────────────┼──────────────────┼────────┼──────────┼─────────┼───────────────────┼────────────┼────────────────┤ +│ FIS │ Fidelity National Information Services, Inc. │ 102.85 │ -8.65 │ -7.76% │ 9.579M │ 4.143M │ 62.629B │ 285.69 │ +├────────┼──────────────────────────────────────────────────┼──────────────────┼────────┼──────────┼─────────┼───────────────────┼────────────┼────────────────┤ +│ SYNH │ Syneos Health, Inc. │ 82.17 │ -6.80 │ -7.64% │ 1.031M │ 504631 │ 8.52B │ 34.51 │ +├────────┼──────────────────────────────────────────────────┼──────────────────┼────────┼──────────┼─────────┼───────────────────┼────────────┼────────────────┤ +│ CYTK │ Cytokinetics, Incorporated │ 37.58 │ -2.76 │ -6.84% │ 3.067M │ 1.064M │ 3.172B │ │ +├────────┼──────────────────────────────────────────────────┼──────────────────┼────────┼──────────┼─────────┼───────────────────┼────────────┼────────────────┤ +│ KUBTY │ Kubota Corporation │ 91.32 │ -6.37 │ -6.52% │ 42171 │ 20532 │ 21.922B │ 14.27 │ +├────────┼──────────────────────────────────────────────────┼──────────────────┼────────┼──────────┼─────────┼───────────────────┼────────────┼────────────────┤ +│ IPGP │ IPG Photonics Corporation │ 137.55 │ -9.13 │ -6.22% │ 1.086M │ 274590 │ 7.333B │ 28.25 │ +├────────┼──────────────────────────────────────────────────┼──────────────────┼────────┼──────────┼─────────┼───────────────────┼────────────┼────────────────┤ +│ DHR-PA │ Danaher Corporation │ 1828.87 │ 14.59 │ +0.80% │ 16720 │ 4094 │ 168.217B │ 212.24 │ +├────────┼──────────────────────────────────────────────────┼──────────────────┼────────┼──────────┼─────────┼───────────────────┼────────────┼────────────────┤ +│ STZ │ Constellation Brands, Inc. │ 219.55 │ -14.30 │ -6.12% │ 2.589M │ 1.063M │ 41.692B │ │ +├────────┼──────────────────────────────────────────────────┼──────────────────┼────────┼──────────┼─────────┼───────────────────┼────────────┼────────────────┤ +│ PTR │ PetroChina Company Limited │ 50.80 │ -3.28 │ -6.07% │ 437983 │ 176783 │ 149.884B │ 7.06 │ +├────────┼──────────────────────────────────────────────────┼──────────────────┼────────┼──────────┼─────────┼───────────────────┼────────────┼────────────────┤ +│ MSADY │ MS&AD Insurance Group Holdings, Inc. │ 17.22 │ -1.08 │ -5.90% │ 27461 │ 49672 │ 18.923B │ 12.92 │ +├────────┼──────────────────────────────────────────────────┼──────────────────┼────────┼──────────┼─────────┼───────────────────┼────────────┼────────────────┤ +│ OMCL │ Omnicell, Inc. │ 139.55 │ -8.05 │ -5.45% │ 3.242M │ 335131 │ 6.132B │ 80.57 │ +├────────┼──────────────────────────────────────────────────┼──────────────────┼────────┼──────────┼─────────┼───────────────────┼────────────┼────────────────┤ +│ CGSHY │ Country Garden Services Holdings Company Limited │ 6.25 │ -0.36 │ -5.45% │ 26709 │ 33427 │ 21.904B │ 33.60 │ +├────────┼──────────────────────────────────────────────────┼──────────────────┼────────┼──────────┼─────────┼───────────────────┼────────────┼────────────────┤ +│ CLR │ Continental Resources, Inc. │ 54.27 │ -3.09 │ -5.39% │ 9.754M │ 1.696M │ 19.84B │ 23.91 │ +├────────┼──────────────────────────────────────────────────┼──────────────────┼────────┼──────────┼─────────┼───────────────────┼────────────┼────────────────┤ +│ ICLR │ ICON Public Limited Company │ 242.36 │ -13.48 │ -5.27% │ 1.359M │ 508632 │ 19.728B │ 82.46 │ +├────────┼──────────────────────────────────────────────────┼──────────────────┼────────┼──────────┼─────────┼───────────────────┼────────────┼────────────────┤ +│ RYDAF │ Shell plc │ 26.01 │ -1.44 │ -5.25% │ 24010 │ 66619 │ 200.025B │ 10.12 │ +├────────┼──────────────────────────────────────────────────┼──────────────────┼────────┼──────────┼─────────┼───────────────────┼────────────┼────────────────┤ +│ SBSW │ Sibanye Stillwater Limited │ 15.57 │ -0.81 │ -4.95% │ 5.813M │ 3.127M │ 10.954B │ 3.83 │ +├────────┼──────────────────────────────────────────────────┼──────────────────┼────────┼──────────┼─────────┼───────────────────┼────────────┼────────────────┤ +│ PHJMF │ PT Hanjaya Mandala Sampoerna Tbk │ 0.07 │ -0.00 │ -4.83% │ 53513 │ 424706 │ 7.561B │ │ +├────────┼──────────────────────────────────────────────────┼──────────────────┼────────┼──────────┼─────────┼───────────────────┼────────────┼────────────────┤ +│ CMTG │ Claros Mortgage Trust, Inc. │ 16.98 │ -0.84 │ -4.71% │ 48428 │ 62252 │ 2.266B │ 11.55 │ +├────────┼──────────────────────────────────────────────────┼──────────────────┼────────┼──────────┼─────────┼───────────────────┼────────────┼────────────────┤ +│ IQV │ IQVIA Holdings Inc. │ 228.64 │ -11.26 │ -4.69% │ 3.086M │ 929314 │ 43.679B │ 58.19 │ +├────────┼──────────────────────────────────────────────────┼──────────────────┼────────┼──────────┼─────────┼───────────────────┼────────────┼────────────────┤ +│ CRL │ Charles River Laboratories International, Inc. │ 312.63 │ -14.81 │ -4.52% │ 1.245M │ 381670 │ 15.777B │ 40.49 │ +├────────┼──────────────────────────────────────────────────┼──────────────────┼────────┼──────────┼─────────┼───────────────────┼────────────┼────────────────┤ +│ BTU │ Peabody Energy Corporation │ 17.21 │ -0.81 │ -4.50% │ 7.956M │ 5.386M │ 2.294B │ 5.35 │ +└────────┴──────────────────────────────────────────────────┴──────────────────┴────────┴──────────┴─────────┴───────────────────┴────────────┴────────────────┘ +``` +--- diff --git a/website/content/terminal/reference/stocks/disc/lowfloat.md b/website/content/terminal/reference/stocks/disc/lowfloat.md new file mode 100644 index 000000000000..8954ed6b7442 --- /dev/null +++ b/website/content/terminal/reference/stocks/disc/lowfloat.md @@ -0,0 +1,74 @@ +--- +title: lowfloat +description: "The LowFloat webpage provides sophisticated tools for retrieving information\ + \ about top stocks with the lowest float. It offers a comprehensive database that\ + \ includes stocks from Nasdaq, the New York Stock Exchange, the American Stock Exchange,\ + \ and the Over the Counter Bulletin Board. The service not only provides a stock\u2019\ + s float, but also provides additional key data such as the number of outstanding\ + \ shares, short interest, and company industry." +keywords: +- lowfloat +- stocks +- stock market +- Nasdaq +- New York Stock Exchange +- American Stock Exchange +- Outstanding shares +- Short interest +- Company industry +- Stock trading +- Low float stocks +- Stock data +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Print top stocks with lowest float. LowFloat.com provides a convenient sorted database of stocks which have a float of under 10 million shares. Additional key data such as the number of outstanding shares, short interest, and company industry is displayed. Data is presented for the Nasdaq Stock Market, the New York Stock Exchange, the American Stock Exchange, and the Over the Counter Bulletin Board. [Source: www.lowfloat.com] + +### Usage + +```python +lowfloat [-l LIMIT] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| limit | limit of stocks to display | 5 | True | None | + + +--- + +## Examples + +```python +2022 Feb 16, 04:09 (🦋) /stocks/disc/ $ lowfloat -l 10 + Top Float Stocks +┏━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━┳━━━━━━━┳━━━━━━━━┳━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Ticker ┃ Company ┃ Exchange ┃ Float ┃ Outstd ┃ ShortInt ┃ Industry ┃ +┡━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━╇━━━━━━━╇━━━━━━━━╇━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┩ +│ DIT │ Amcon Distributing Co │ AMEX │ 160K │ 580K │ 1.09% │ Retail (Grocery) │ +├────────┼───────────────────────────────────────┼──────────┼───────┼────────┼──────────┼────────────────────────────────────────────┤ +│ SEB │ Seaboard Corp │ AMEX │ 240K │ 1.16M │ 0.78% │ Fish/Livestock │ +├────────┼───────────────────────────────────────┼──────────┼───────┼────────┼──────────┼────────────────────────────────────────────┤ +│ MAYS │ JW Mays Inc │ Nasdaq │ 390K │ 2.02M │ 0.85% │ Real Estate Operations │ +├────────┼───────────────────────────────────────┼──────────┼───────┼────────┼──────────┼────────────────────────────────────────────┤ +│ HMG │ HMG Courtland Properties │ AMEX │ 400K │ 1.02M │ 0.28% │ Real Estate Operations │ +├────────┼───────────────────────────────────────┼──────────┼───────┼────────┼──────────┼────────────────────────────────────────────┤ +│ VBFC │ Village Bank and Trust Financial Corp │ Nasdaq │ 530K │ 1.47M │ 0.10% │ Regional Banks │ +├────────┼───────────────────────────────────────┼──────────┼───────┼────────┼──────────┼────────────────────────────────────────────┤ +│ BDL │ Flanigan's Enterprises Inc │ AMEX │ 550K │ 1.86M │ 0.05% │ Restaurants │ +├────────┼───────────────────────────────────────┼──────────┼───────┼────────┼──────────┼────────────────────────────────────────────┤ +│ RAND │ Rand Capital Corp │ Nasdaq │ 620K │ 2.58M │ 0.01% │ Misc. Financial Services │ +├────────┼───────────────────────────────────────┼──────────┼───────┼────────┼──────────┼────────────────────────────────────────────┤ +│ NCSM │ NCS Multistage Holdings Inc │ Nasdaq │ 630K │ 2.38M │ 0.69% │ Oil & Gas - Related Services and Equipment │ +├────────┼───────────────────────────────────────┼──────────┼───────┼────────┼──────────┼────────────────────────────────────────────┤ +│ INTG │ Intergroup Corp │ Nasdaq │ 650K │ 2.20M │ 0.62% │ Real Estate Operations │ +└────────┴───────────────────────────────────────┴──────────┴───────┴────────┴──────────┴────────────────────────────────────────────┘ +``` +--- diff --git a/website/content/terminal/reference/stocks/disc/pipo.md b/website/content/terminal/reference/stocks/disc/pipo.md new file mode 100644 index 000000000000..57c788c2a3bc --- /dev/null +++ b/website/content/terminal/reference/stocks/disc/pipo.md @@ -0,0 +1,72 @@ +--- +title: pipo +description: This documentation page provides details on how to use the 'pipo' function + to retrieve past IPOs dates; instructions for its usage, parameters and clear examples + are provided. +keywords: +- pipo +- past IPOs dates +- function usage +- parameters instructions +- examples +- IPOs +- dates +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Past IPOs dates. [Source: https://finnhub.io] + +### Usage + +```python +pipo [-d DAYS] [-s START] [-l LIMIT] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| days | Number of past days to look for IPOs. | 5 | True | None | +| start | The starting date (format YYYY-MM-DD) to look for IPOs. When set, start date will override --days argument | None | True | None | +| limit | Limit number of IPOs to display. | 20 | True | None | + + +--- + +## Examples + +```python +2022 Feb 16, 04:10 (🦋) /stocks/disc/ $ pipo + IPO Dates +┏━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━┳━━━━━━━━━━┳━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━┓ +┃ Past ┃ Exchange ┃ Name ┃ Number of Shares ┃ Price ┃ Status ┃ symbol ┃ Total Shares Value ┃ +┡━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━╇━━━━━━━━━━╇━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━┩ +│ 2022-02-16 │ NASDAQ Capital │ SMART FOR LIFE, INC. │ 1800000 │ 9.00-11.00 │ expected │ SMFL │ 22770000 │ +├────────────┼────────────────┼───────────────────────────────┼──────────────────┼────────────┼──────────┼────────┼────────────────────┤ +│ 2022-02-15 │ NASDAQ Capital │ ASPAC I Acquisition Corp. │ 6000000 │ 10.00 │ expected │ ASCAU │ 69000000 │ +├────────────┼────────────────┼───────────────────────────────┼──────────────────┼────────────┼──────────┼────────┼────────────────────┤ +│ 2022-02-15 │ NASDAQ Global │ Genesis Unicorn Capital Corp. │ 7500000 │ 10.00 │ expected │ GENQU │ 75000000 │ +├────────────┼────────────────┼───────────────────────────────┼──────────────────┼────────────┼──────────┼────────┼────────────────────┤ +│ 2022-02-11 │ NASDAQ Global │ Relativity Acquisition Corp │ 12500000 │ 10.00 │ priced │ RACYU │ 125000000 │ +├────────────┼────────────────┼───────────────────────────────┼──────────────────┼────────────┼──────────┼────────┼────────────────────┤ +│ 2022-02-11 │ NASDAQ Global │ Signal Hill Acquisition Corp. │ 10000000 │ 10.00 │ priced │ SGHLU │ 100000000 │ +├────────────┼────────────────┼───────────────────────────────┼──────────────────┼────────────┼──────────┼────────┼────────────────────┤ +│ 2022-02-11 │ NYSE │ MODIV INC. │ 40000 │ 25.00 │ priced │ MDV │ 1000000 │ +├────────────┼────────────────┼───────────────────────────────┼──────────────────┼────────────┼──────────┼────────┼────────────────────┤ +│ 2022-02-11 │ NASDAQ Capital │ Direct Digital Holdings, Inc. │ 2800000 │ 5.50 │ priced │ DRCT │ 15400000 │ +├────────────┼────────────────┼───────────────────────────────┼──────────────────┼────────────┼──────────┼────────┼────────────────────┤ +│ 2022-02-11 │ NASDAQ Capital │ TC BioPharm (Holdings) plc │ 4117648 │ 4.25 │ priced │ TCBP │ 17500004 │ +├────────────┼────────────────┼───────────────────────────────┼──────────────────┼────────────┼──────────┼────────┼────────────────────┤ +│ 2022-02-11 │ NASDAQ Global │ Jaguar Global Growth Corp I │ 20000000 │ 10.00 │ priced │ JGGCU │ 200000000 │ +├────────────┼────────────────┼───────────────────────────────┼──────────────────┼────────────┼──────────┼────────┼────────────────────┤ +│ 2022-02-11 │ NYSE MKT │ HNR Acquisition Corp. │ 7500000 │ 10.00 │ priced │ HNRAU │ 75000000 │ +├────────────┼────────────────┼───────────────────────────────┼──────────────────┼────────────┼──────────┼────────┼────────────────────┤ +│ 2022-02-11 │ NASDAQ Capital │ JUPITER NEUROSCIENCES, INC. │ 2200000 │ 6.00-8.00 │ expected │ JUNS │ 20240000 │ +└────────────┴────────────────┴───────────────────────────────┴──────────────────┴────────────┴──────────┴────────┴────────────────────┘ +``` +--- diff --git a/website/content/terminal/reference/stocks/disc/rtat.md b/website/content/terminal/reference/stocks/disc/rtat.md new file mode 100644 index 000000000000..ce4f9db2f33f --- /dev/null +++ b/website/content/terminal/reference/stocks/disc/rtat.md @@ -0,0 +1,124 @@ +--- +title: rtat +description: The rtat tool provides daily insights into the retail trading activity + and sentiment for over 9,500 US traded stocks, ADRs, and ETPs. Learn how to use + it, understand its parameters, and see examples of results with our detailed documentation. +keywords: +- rtat +- trade tracking +- investment trades +- retail activity +- stocks +- ADRs +- ETPs +- retail sentiment +- daily view +- investment sentiment +- RTAT usage +- python example +- parameter limit +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Tracking over $30B USD/day of individual investors trades, RTAT gives a daily view into retail activity and sentiment for over 9,500 US traded stocks, ADRs, and ETPs + +### Usage + +```python +rtat [-l LIMIT] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| limit | limit of days to display | 3 | True | None | + + +--- + +## Examples + +```python +2022 Feb 16, 04:12 (🦋) /stocks/disc/ $ rtat + 2022-02-11 Top Retail: +┏━━━━━━━━┳━━━━━━━━━━┳━━━━━━━━━━━┓ +┃ Ticker ┃ Activity ┃ Sentiment ┃ +┡━━━━━━━━╇━━━━━━━━━━╇━━━━━━━━━━━┩ +│ TSLA │ 0.04 │ 1 │ +├────────┼──────────┼───────────┤ +│ TQQQ │ 0.02 │ 6 │ +├────────┼──────────┼───────────┤ +│ SQQQ │ 0.02 │ 6 │ +├────────┼──────────┼───────────┤ +│ SPY │ 0.03 │ 2 │ +├────────┼──────────┼───────────┤ +│ QQQ │ 0.03 │ 0 │ +├────────┼──────────┼───────────┤ +│ NVDA │ 0.04 │ 3 │ +├────────┼──────────┼───────────┤ +│ MSFT │ 0.02 │ 2 │ +├────────┼──────────┼───────────┤ +│ FB │ 0.02 │ 2 │ +├────────┼──────────┼───────────┤ +│ AMD │ 0.06 │ 1 │ +├────────┼──────────┼───────────┤ +│ AAPL │ 0.03 │ -1 │ +└────────┴──────────┴───────────┘ + + 2022-02-14 Top Retail: +┏━━━━━━━━┳━━━━━━━━━━┳━━━━━━━━━━━┓ +┃ Ticker ┃ Activity ┃ Sentiment ┃ +┡━━━━━━━━╇━━━━━━━━━━╇━━━━━━━━━━━┩ +│ TSLA │ 0.04 │ 0 │ +├────────┼──────────┼───────────┤ +│ TQQQ │ 0.02 │ 2 │ +├────────┼──────────┼───────────┤ +│ SQQQ │ 0.02 │ 9 │ +├────────┼──────────┼───────────┤ +│ SPY │ 0.03 │ 2 │ +├────────┼──────────┼───────────┤ +│ QQQ │ 0.03 │ -1 │ +├────────┼──────────┼───────────┤ +│ NVDA │ 0.03 │ 2 │ +├────────┼──────────┼───────────┤ +│ MSFT │ 0.02 │ 1 │ +├────────┼──────────┼───────────┤ +│ FB │ 0.02 │ 1 │ +├────────┼──────────┼───────────┤ +│ AMD │ 0.08 │ -1 │ +├────────┼──────────┼───────────┤ +│ AAPL │ 0.03 │ -3 │ +└────────┴──────────┴───────────┘ + + 2022-02-15 Top Retail: +┏━━━━━━━━┳━━━━━━━━━━┳━━━━━━━━━━━┓ +┃ Ticker ┃ Activity ┃ Sentiment ┃ +┡━━━━━━━━╇━━━━━━━━━━╇━━━━━━━━━━━┩ +│ TSLA │ 0.04 │ 0 │ +├────────┼──────────┼───────────┤ +│ TQQQ │ 0.01 │ 5 │ +├────────┼──────────┼───────────┤ +│ SPY │ 0.03 │ 2 │ +├────────┼──────────┼───────────┤ +│ SPCE │ 0.01 │ 8 │ +├────────┼──────────┼───────────┤ +│ QQQ │ 0.03 │ 1 │ +├────────┼──────────┼───────────┤ +│ NVDA │ 0.07 │ 2 │ +├────────┼──────────┼───────────┤ +│ MSFT │ 0.02 │ 1 │ +├────────┼──────────┼───────────┤ +│ FB │ 0.03 │ 1 │ +├────────┼──────────┼───────────┤ +│ AMD │ 0.08 │ -2 │ +├────────┼──────────┼───────────┤ +│ AAPL │ 0.03 │ -2 │ +└────────┴──────────┴───────────┘ +``` +--- diff --git a/website/content/terminal/reference/stocks/disc/trending.md b/website/content/terminal/reference/stocks/disc/trending.md new file mode 100644 index 000000000000..48bd29fe8a67 --- /dev/null +++ b/website/content/terminal/reference/stocks/disc/trending.md @@ -0,0 +1,79 @@ +--- +title: trending +description: The 'Trending' page provides the latest news articles sourced from Seeking + Alpha. Users can access articles by ID, limit the number of articles displayed, + and filter by start date. +keywords: +- Trending +- News Articles +- Seeking Alpha +- Article ID +- Article Limit +- Start Date +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Trending news articles. [Source: Seeking Alpha] + +### Usage + +```python +trending [-i N_ID] [-l LIMIT] [-d S_DATE] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| n_id | article ID | -1 | True | None | +| limit | limit of articles being printed | 5 | True | None | +| s_date | starting date of articles | 2022-11-25 | True | None | + + +--- + +## Examples + +```python +2022 Feb 16, 04:13 (🦋) /stocks/disc/ $ trending -i 10 +2010-03-21 08:33:21 Deutsche Bank's Marc Greenberg can't justify the BUD deal. But he says Bud Light Lime is the... +https://seekingalpha.com/news/10 + + Deutsche Bank's Marc Greenberg can't justify the BUD deal. But he says Bud Light Lime is the beer to beat. +2022 Feb 16, 04:13 (🦋) /stocks/disc/ $ trending -l 10 +2022-02-16 02:00:18 - 3800145 - Shopify Q4 Earnings Preview: What to Expect +https://seekingalpha.com/news/3800145-shopify-q4-earnings-preview-what-to-expect + +2022-02-15 16:20:21 - 3800395 - Upstart stock soars after Q4 earnings beat, strong guidance, stock buyback +https://seekingalpha.com/news/3800395-upstart-stock-soars-after-q4-earnings-beat-strong-guidance-stock-buyback + +2022-02-15 11:31:14 - 3800203 - Greenview Capital takes stakes in Alibaba, Amazon +https://seekingalpha.com/news/3800203-greenview-capital-takes-stakes-in-alibaba-amazon + +2022-02-15 16:38:11 - 3800438 - Roblox shares plunge as metaverse company misses Wall Street's expectations +https://seekingalpha.com/news/3800438-roblox-shares-plunge-as-metaverse-company-misses-wall-streets-expectations + +2022-02-15 12:39:57 - 3800257 - Sunshine Biopharma announces pricing of $8M public offering, uplisting +https://seekingalpha.com/news/3800257-sunshine-biopharma-announces-pricing-of-8m-public-offering-uplisting + +2022-02-15 14:06:05 - 3800296 - Cathie Wood’s ARKK a bubble? Let’s look at history +https://seekingalpha.com/news/3800296-is-cathie-woods-arkk-a-bubble-lets-look-at-history + +2022-02-16 01:38:34 - 3800525 - Flex LNG Non-GAAP EPS of $1.18, revenue of $114.6M beats by $4.38M +https://seekingalpha.com/news/3800525-flex-lng-non-gaap-eps-of-118-revenue-of-1146m-beats-by-438m + +2022-02-15 19:04:21 - 3800509 - ViacomCBS earnings call: A flood of content feeding transformation to Paramount +https://seekingalpha.com/news/3800509-viacomcbs-earnings-call-a-flood-of-content-feeding-transformation-to-paramount + +2022-02-16 02:09:27 - 3800529 - Golden Ocean raises dividend by ~6% to $0.90/share +https://seekingalpha.com/news/3800529-golden-ocean-raises-dividend-by-6-to-090share + +2022-02-15 17:35:20 - 3800169 - Matterport Q4 2021 Earnings Preview +https://seekingalpha.com/news/3800169-matterport-q4-2021-earnings-preview +``` +--- diff --git a/website/content/terminal/reference/stocks/disc/ugs.md b/website/content/terminal/reference/stocks/disc/ugs.md new file mode 100644 index 000000000000..bcc25e467d1a --- /dev/null +++ b/website/content/terminal/reference/stocks/disc/ugs.md @@ -0,0 +1,99 @@ +--- +title: ugs +description: The 'ugs' documentation page provides instructions on how to print up + to 25 undervalued stocks with revenue and earnings growth exceeding 25%. It includes + details on usage, parameters, and examples demonstrating expected outcomes. +keywords: +- undervalued stocks +- stocks +- revenue growth +- earnings growth +- stock market +- financial market +- ugs +- Yahoo Finance +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Print up to 25 undervalued stocks with revenue and earnings growth in excess of 25%. [Source: Yahoo Finance] + +### Usage + +```python +ugs [-l LIMIT] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| limit | Limit of stocks to display. | 5 | True | None | + + +--- + +## Examples + +```python +2022 Feb 16, 04:14 (🦋) /stocks/disc/ $ ugs -l 25 + Undervalued Growth Stocks +┏━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━┳━━━━━━━━┳━━━━━━━━━━┳━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━┓ +┃ Symbol ┃ Name ┃ Price (Intraday) ┃ Change ┃ % Change ┃ Volume ┃ Avg Vol (3 month) ┃ Market Cap ┃ PE Ratio (TTM) ┃ +┡━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━╇━━━━━━━━╇━━━━━━━━━━╇━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━┩ +│ BAC │ Bank of America Corporation │ 47.79 │ 0.37 │ +0.78% │ 41.879M │ 52.171M │ 386.04B │ 13.39 │ +├────────┼─────────────────────────────────────┼──────────────────┼────────┼──────────┼─────────┼───────────────────┼────────────┼────────────────┤ +│ PFE │ Pfizer Inc. │ 49.79 │ -0.01 │ -0.02% │ 28.167M │ 42.507M │ 279.465B │ 12.92 │ +├────────┼─────────────────────────────────────┼──────────────────┼────────┼──────────┼─────────┼───────────────────┼────────────┼────────────────┤ +│ ITUB │ Itaú Unibanco Holding S.A. │ 5.14 │ 0.08 │ +1.58% │ 41.059M │ 45.848M │ 50.269B │ 9.92 │ +├────────┼─────────────────────────────────────┼──────────────────┼────────┼──────────┼─────────┼───────────────────┼────────────┼────────────────┤ +│ FCX │ Freeport-McMoRan Inc. │ 43.67 │ 1.22 │ +2.87% │ 15.482M │ 18.44M │ 64.128B │ 15.06 │ +├────────┼─────────────────────────────────────┼──────────────────┼────────┼──────────┼─────────┼───────────────────┼────────────┼────────────────┤ +│ VALE │ Vale S.A. │ 17.14 │ -0.35 │ -2.00% │ 33.93M │ 32.586M │ 80.669B │ 4.79 │ +├────────┼─────────────────────────────────────┼──────────────────┼────────┼──────────┼─────────┼───────────────────┼────────────┼────────────────┤ +│ WFC │ Wells Fargo & Company │ 58.38 │ 0.53 │ +0.92% │ 17.227M │ 30.109M │ 226.853B │ 11.79 │ +├────────┼─────────────────────────────────────┼──────────────────┼────────┼──────────┼─────────┼───────────────────┼────────────┼────────────────┤ +│ GM │ General Motors Company │ 49.67 │ 1.27 │ +2.62% │ 14.813M │ 20.688M │ 72.172B │ 7.41 │ +├────────┼─────────────────────────────────────┼──────────────────┼────────┼──────────┼─────────┼───────────────────┼────────────┼────────────────┤ +│ FB │ Meta Platforms, Inc. │ 221.00 │ 3.30 │ +1.52% │ 42.685M │ 29.422M │ 601.549B │ 16.05 │ +├────────┼─────────────────────────────────────┼──────────────────┼────────┼──────────┼─────────┼───────────────────┼────────────┼────────────────┤ +│ ATUS │ Altice USA, Inc. │ 14.65 │ 0.71 │ +5.09% │ 4.904M │ 6.156M │ 6.661B │ 6.65 │ +├────────┼─────────────────────────────────────┼──────────────────┼────────┼──────────┼─────────┼───────────────────┼────────────┼────────────────┤ +│ MU │ Micron Technology, Inc. │ 96.00 │ 6.14 │ +6.83% │ 27.084M │ 21.734M │ 107.499B │ 14.86 │ +├────────┼─────────────────────────────────────┼──────────────────┼────────┼──────────┼─────────┼───────────────────┼────────────┼────────────────┤ +│ HBAN │ Huntington Bancshares Incorporated │ 16.21 │ 0.51 │ +3.25% │ 5.809M │ 12.004M │ 23.306B │ 18.01 │ +├────────┼─────────────────────────────────────┼──────────────────┼────────┼──────────┼─────────┼───────────────────┼────────────┼────────────────┤ +│ UMC │ United Microelectronics Corporation │ 9.90 │ 0.41 │ +4.32% │ 14.052M │ 8.722M │ 24.52B │ 12.07 │ +├────────┼─────────────────────────────────────┼──────────────────┼────────┼──────────┼─────────┼───────────────────┼────────────┼────────────────┤ +│ VIAC │ ViacomCBS Inc. │ 35.99 │ 0.96 │ +2.74% │ 13.027M │ 14.338M │ 23.436B │ 7.03 │ +├────────┼─────────────────────────────────────┼──────────────────┼────────┼──────────┼─────────┼───────────────────┼────────────┼────────────────┤ +│ CMCSA │ Comcast Corporation │ 48.05 │ 0.65 │ +1.37% │ 21.088M │ 23.444M │ 217.822B │ 15.81 │ +├────────┼─────────────────────────────────────┼──────────────────┼────────┼──────────┼─────────┼───────────────────┼────────────┼────────────────┤ +│ LYG │ Lloyds Banking Group plc │ 2.82 │ 0.06 │ +2.17% │ 10.023M │ 9.419M │ 53.069B │ 8493.98 │ +├────────┼─────────────────────────────────────┼──────────────────┼────────┼──────────┼─────────┼───────────────────┼────────────┼────────────────┤ +│ GFI │ Gold Fields Limited │ 11.79 │ -0.49 │ -3.99% │ 10.13M │ 7.067M │ 10.466B │ 11.19 │ +├────────┼─────────────────────────────────────┼──────────────────┼────────┼──────────┼─────────┼───────────────────┼────────────┼────────────────┤ +│ HPQ │ HP Inc. │ 37.37 │ 0.86 │ +2.36% │ 7.367M │ 10.599M │ 40.461B │ 7.01 │ +├────────┼─────────────────────────────────────┼──────────────────┼────────┼──────────┼─────────┼───────────────────┼────────────┼────────────────┤ +│ RF │ Regions Financial Corporation │ 25.29 │ 0.77 │ +3.14% │ 7.727M │ 9.327M │ 23.823B │ 10.16 │ +├────────┼─────────────────────────────────────┼──────────────────┼────────┼──────────┼─────────┼───────────────────┼────────────┼────────────────┤ +│ QCOM │ QUALCOMM Incorporated │ 173.00 │ 7.87 │ +4.77% │ 11.103M │ 11.057M │ 194.971B │ 19.83 │ +├────────┼─────────────────────────────────────┼──────────────────┼────────┼──────────┼─────────┼───────────────────┼────────────┼────────────────┤ +│ DOW │ Dow Inc. │ 61.86 │ 1.03 │ +1.69% │ 4.025M │ 5.732M │ 45.513B │ 7.38 │ +├────────┼─────────────────────────────────────┼──────────────────┼────────┼──────────┼─────────┼───────────────────┼────────────┼────────────────┤ +│ KEY │ KeyCorp │ 26.53 │ 0.62 │ +2.39% │ 6.08M │ 8.248M │ 24.642B │ 10.07 │ +├────────┼─────────────────────────────────────┼──────────────────┼────────┼──────────┼─────────┼───────────────────┼────────────┼────────────────┤ +│ FITB │ Fifth Third Bancorp │ 49.38 │ 1.15 │ +2.38% │ 3.765M │ 5.432M │ 33.716B │ 13.24 │ +├────────┼─────────────────────────────────────┼──────────────────┼────────┼──────────┼─────────┼───────────────────┼────────────┼────────────────┤ +│ RKT │ Rocket Companies, Inc. │ 12.67 │ 0.39 │ +3.18% │ 3.99M │ 4.741M │ 25.179B │ 4.18 │ +├────────┼─────────────────────────────────────┼──────────────────┼────────┼──────────┼─────────┼───────────────────┼────────────┼────────────────┤ +│ ING │ ING Groep N.V. │ 14.77 │ 0.30 │ +2.07% │ 4.587M │ 4.233M │ 55.768B │ 10.33 │ +├────────┼─────────────────────────────────────┼──────────────────┼────────┼──────────┼─────────┼───────────────────┼────────────┼────────────────┤ +│ SYF │ Synchrony Financial │ 44.79 │ 0.76 │ +1.73% │ 5.374M │ 5.908M │ 23.348B │ 6.10 │ +└────────┴─────────────────────────────────────┴──────────────────┴────────┴──────────┴─────────┴───────────────────┴────────────┴────────────────┘ +``` +--- diff --git a/website/content/terminal/reference/stocks/disc/ulc.md b/website/content/terminal/reference/stocks/disc/ulc.md new file mode 100644 index 000000000000..d30dd8bb1d6c --- /dev/null +++ b/website/content/terminal/reference/stocks/disc/ulc.md @@ -0,0 +1,100 @@ +--- +title: ulc +description: The 'ulc' page provides a useful tool for displaying potentially undervalued + large cap stocks. The utility allows you to specify the limit of stocks to display, + making it a versatile tool for investment research. Source data is retrieved from + Yahoo Finance. +keywords: +- stocks +- large cap stocks +- undervalued stocks +- investment research +- stock display tool +- Yahoo Finance +- stock market +- stock analysis +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Print up to 25 potentially undervalued large cap stocks. [Source: Yahoo Finance] + +### Usage + +```python +ulc [-l LIMIT] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| limit | Limit of stocks to display. | 5 | True | None | + + +--- + +## Examples + +```python +2022 Feb 16, 04:15 (🦋) /stocks/disc/ $ ulc -l 25 + Undervalued Large Cap Stocks +┏━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━┳━━━━━━━━┳━━━━━━━━━━┳━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━┓ +┃ Symbol ┃ Name ┃ Price (Intraday) ┃ Change ┃ % Change ┃ Volume ┃ Avg Vol (3 month) ┃ Market Cap ┃ PE Ratio (TTM) ┃ +┡━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━╇━━━━━━━━╇━━━━━━━━━━╇━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━┩ +│ F │ Ford Motor Company │ 18.08 │ 0.62 │ +3.55% │ 64.555M │ 108.718M │ 72.397B │ 4.06 │ +├────────┼──────────────────────────────────────┼──────────────────┼────────┼──────────┼─────────┼───────────────────┼────────────┼────────────────┤ +│ NOK │ Nokia Corporation │ 5.60 │ 0.17 │ +3.13% │ 29.464M │ 24.911M │ 32.265B │ 17.07 │ +├────────┼──────────────────────────────────────┼──────────────────┼────────┼──────────┼─────────┼───────────────────┼────────────┼────────────────┤ +│ ITUB │ Itaú Unibanco Holding S.A. │ 5.14 │ 0.08 │ +1.58% │ 41.059M │ 45.848M │ 50.269B │ 9.92 │ +├────────┼──────────────────────────────────────┼──────────────────┼────────┼──────────┼─────────┼───────────────────┼────────────┼────────────────┤ +│ FCX │ Freeport-McMoRan Inc. │ 43.67 │ 1.22 │ +2.87% │ 15.482M │ 18.44M │ 64.128B │ 15.06 │ +├────────┼──────────────────────────────────────┼──────────────────┼────────┼──────────┼─────────┼───────────────────┼────────────┼────────────────┤ +│ PBR │ Petróleo Brasileiro S.A. - Petrobras │ 13.77 │ -0.21 │ -1.50% │ 27.492M │ 31.187M │ 89.809B │ 3.49 │ +├────────┼──────────────────────────────────────┼──────────────────┼────────┼──────────┼─────────┼───────────────────┼────────────┼────────────────┤ +│ VALE │ Vale S.A. │ 17.14 │ -0.35 │ -2.00% │ 33.93M │ 32.586M │ 80.669B │ 4.79 │ +├────────┼──────────────────────────────────────┼──────────────────┼────────┼──────────┼─────────┼───────────────────┼────────────┼────────────────┤ +│ GOLD │ Barrick Gold Corporation │ 20.68 │ -0.41 │ -1.94% │ 21.46M │ 17.845M │ 36.812B │ 18.56 │ +├────────┼──────────────────────────────────────┼──────────────────┼────────┼──────────┼─────────┼───────────────────┼────────────┼────────────────┤ +│ NLY │ Annaly Capital Management, Inc. │ 7.26 │ 0.07 │ +0.97% │ 23.269M │ 22.798M │ 10.598B │ 4.54 │ +├────────┼──────────────────────────────────────┼──────────────────┼────────┼──────────┼─────────┼───────────────────┼────────────┼────────────────┤ +│ CLF │ Cleveland-Cliffs Inc. │ 19.77 │ 1.30 │ +7.04% │ 21.478M │ 20.134M │ 10.387B │ 3.69 │ +├────────┼──────────────────────────────────────┼──────────────────┼────────┼──────────┼─────────┼───────────────────┼────────────┼────────────────┤ +│ GM │ General Motors Company │ 49.67 │ 1.27 │ +2.62% │ 14.813M │ 20.688M │ 72.172B │ 7.41 │ +├────────┼──────────────────────────────────────┼──────────────────┼────────┼──────────┼─────────┼───────────────────┼────────────┼────────────────┤ +│ HBAN │ Huntington Bancshares Incorporated │ 16.21 │ 0.51 │ +3.25% │ 5.809M │ 12.004M │ 23.306B │ 18.01 │ +├────────┼──────────────────────────────────────┼──────────────────┼────────┼──────────┼─────────┼───────────────────┼────────────┼────────────────┤ +│ UMC │ United Microelectronics Corporation │ 9.90 │ 0.41 │ +4.32% │ 14.052M │ 8.722M │ 24.52B │ 12.07 │ +├────────┼──────────────────────────────────────┼──────────────────┼────────┼──────────┼─────────┼───────────────────┼────────────┼────────────────┤ +│ ET │ Energy Transfer LP │ 10.17 │ 0.07 │ +0.69% │ 13.167M │ 22.73M │ 32.354B │ 5.67 │ +├────────┼──────────────────────────────────────┼──────────────────┼────────┼──────────┼─────────┼───────────────────┼────────────┼────────────────┤ +│ VIAC │ ViacomCBS Inc. │ 35.99 │ 0.96 │ +2.74% │ 13.027M │ 14.338M │ 23.436B │ 7.03 │ +├────────┼──────────────────────────────────────┼──────────────────┼────────┼──────────┼─────────┼───────────────────┼────────────┼────────────────┤ +│ LUMN │ Lumen Technologies, Inc. │ 10.04 │ 0.13 │ +1.31% │ 22.151M │ 13.534M │ 10.28B │ 5.26 │ +├────────┼──────────────────────────────────────┼──────────────────┼────────┼──────────┼─────────┼───────────────────┼────────────┼────────────────┤ +│ HPE │ Hewlett Packard Enterprise Company │ 17.38 │ 0.51 │ +3.02% │ 7.326M │ 10.758M │ 22.48B │ 6.74 │ +├────────┼──────────────────────────────────────┼──────────────────┼────────┼──────────┼─────────┼───────────────────┼────────────┼────────────────┤ +│ MRNA │ Moderna, Inc. │ 151.12 │ 8.65 │ +6.07% │ 10.858M │ 10.898M │ 61.272B │ 9.05 │ +├────────┼──────────────────────────────────────┼──────────────────┼────────┼──────────┼─────────┼───────────────────┼────────────┼────────────────┤ +│ PBR-A │ Petróleo Brasileiro S.A. - Petrobras │ 12.54 │ -0.10 │ -0.79% │ 11.855M │ 12.201M │ 70.249B │ 3.18 │ +├────────┼──────────────────────────────────────┼──────────────────┼────────┼──────────┼─────────┼───────────────────┼────────────┼────────────────┤ +│ LYG │ Lloyds Banking Group plc │ 2.82 │ 0.06 │ +2.17% │ 10.023M │ 9.419M │ 53.069B │ 8493.98 │ +├────────┼──────────────────────────────────────┼──────────────────┼────────┼──────────┼─────────┼───────────────────┼────────────┼────────────────┤ +│ SUZ │ Suzano S.A. │ 11.11 │ -0.08 │ -0.71% │ 861227 │ 852793 │ 14.99B │ 9.14 │ +├────────┼──────────────────────────────────────┼──────────────────┼────────┼──────────┼─────────┼───────────────────┼────────────┼────────────────┤ +│ GFI │ Gold Fields Limited │ 11.79 │ -0.49 │ -3.99% │ 10.13M │ 7.067M │ 10.466B │ 11.19 │ +├────────┼──────────────────────────────────────┼──────────────────┼────────┼──────────┼─────────┼───────────────────┼────────────┼────────────────┤ +│ HPQ │ HP Inc. │ 37.37 │ 0.86 │ +2.36% │ 7.367M │ 10.599M │ 40.461B │ 7.01 │ +├────────┼──────────────────────────────────────┼──────────────────┼────────┼──────────┼─────────┼───────────────────┼────────────┼────────────────┤ +│ HAL │ Halliburton Company │ 32.52 │ 0.16 │ +0.49% │ 10.356M │ 11.058M │ 29.222B │ 19.95 │ +├────────┼──────────────────────────────────────┼──────────────────┼────────┼──────────┼─────────┼───────────────────┼────────────┼────────────────┤ +│ RF │ Regions Financial Corporation │ 25.29 │ 0.77 │ +3.14% │ 7.727M │ 9.327M │ 23.823B │ 10.16 │ +├────────┼──────────────────────────────────────┼──────────────────┼────────┼──────────┼─────────┼───────────────────┼────────────┼────────────────┤ +│ DOW │ Dow Inc. │ 61.86 │ 1.03 │ +1.69% │ 4.025M │ 5.732M │ 45.513B │ 7.38 │ +└────────┴──────────────────────────────────────┴──────────────────┴────────┴──────────┴─────────┴───────────────────┴────────────┴────────────────┘ +``` +--- diff --git a/website/content/terminal/reference/stocks/disc/upcoming.md b/website/content/terminal/reference/stocks/disc/upcoming.md new file mode 100644 index 000000000000..fd209cf93f1c --- /dev/null +++ b/website/content/terminal/reference/stocks/disc/upcoming.md @@ -0,0 +1,285 @@ +--- +title: upcoming +description: This documentation page provides information about the 'upcoming' command + which displays upcoming earnings release dates. It fetches data from Seeking Alpha + and presents it in an easy-to-read format, showcasing the upcoming earnings releases + of various companies. Ideal tool for investors seeking recent financial data. +keywords: +- upcoming earnings release dates +- Seeking Alpha +- stock market +- financial data +- finance documentation +- stock earnings +- stock investment data +- financial information +- investment tools +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Upcoming earnings release dates. [Source: Seeking Alpha] + +### Usage + +```python +upcoming [-l LIMIT] [-p N_PAGES] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| limit | Limit of upcoming earnings release dates to display. | 1 | True | None | +| n_pages | Number of pages to read upcoming earnings from in Seeking Alpha website. | 10 | True | None | + + +--- + +## Examples + +```python +2022 Feb 16, 04:17 (🦋) /stocks/disc/ $ upcoming + + Upcoming Earnings Releases +┏━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ ┃ Earnings on 2022-02-16 ┃ +┡━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┩ +│ GLDD │ Great Lakes Dredge & Dock Corporation │ +├───────┼─────────────────────────────────────────┤ +│ BCOR │ Blucora, Inc. │ +├───────┼─────────────────────────────────────────┤ +│ BGCP │ BGC Partners, Inc. │ +├───────┼─────────────────────────────────────────┤ +│ ADI │ Analog Devices, Inc. │ +├───────┼─────────────────────────────────────────┤ +│ KHC │ The Kraft Heinz Company │ +├───────┼─────────────────────────────────────────┤ +│ AMCX │ AMC Networks Inc. │ +├───────┼─────────────────────────────────────────┤ +│ AIMC │ Altra Industrial Motion Corp. │ +├───────┼─────────────────────────────────────────┤ +│ WIX │ Wix.com Ltd. │ +├───────┼─────────────────────────────────────────┤ +│ TTD │ The Trade Desk, Inc. │ +├───────┼─────────────────────────────────────────┤ +│ CCEP │ Coca-Cola Europacific Partners PLC │ +├───────┼─────────────────────────────────────────┤ +│ WING │ Wingstop Inc. │ +├───────┼─────────────────────────────────────────┤ +│ DRVN │ Driven Brands Holdings Inc. │ +├───────┼─────────────────────────────────────────┤ +│ CSCO │ Cisco Systems, Inc. │ +├───────┼─────────────────────────────────────────┤ +│ CPRT │ Copart, Inc. │ +├───────┼─────────────────────────────────────────┤ +│ HST │ Host Hotels & Resorts, Inc. │ +├───────┼─────────────────────────────────────────┤ +│ NVDA │ NVIDIA Corporation │ +├───────┼─────────────────────────────────────────┤ +│ RBBN │ Ribbon Communications Inc. │ +├───────┼─────────────────────────────────────────┤ +│ TRIP │ TripAdvisor, Inc. │ +├───────┼─────────────────────────────────────────┤ +│ RGLD │ Royal Gold, Inc. │ +├───────┼─────────────────────────────────────────┤ +│ CRMT │ America's Car-Mart, Inc. │ +├───────┼─────────────────────────────────────────┤ +│ CAKE │ The Cheesecake Factory Incorporated │ +├───────┼─────────────────────────────────────────┤ +│ VECO │ Veeco Instruments Inc. │ +├───────┼─────────────────────────────────────────┤ +│ SCKT │ Socket Mobile, Inc. │ +├───────┼─────────────────────────────────────────┤ +│ PEGA │ Pegasystems Inc. │ +├───────┼─────────────────────────────────────────┤ +│ FARO │ FARO Technologies, Inc. │ +├───────┼─────────────────────────────────────────┤ +│ RUSHA │ Rush Enterprises, Inc. │ +├───────┼─────────────────────────────────────────┤ +│ AXTI │ AXT, Inc. │ +├───────┼─────────────────────────────────────────┤ +│ INFN │ Infinera Corporation │ +├───────┼─────────────────────────────────────────┤ +│ MMLP │ Martin Midstream Partners L.P. │ +├───────┼─────────────────────────────────────────┤ +│ BCOV │ Brightcove Inc. │ +├───────┼─────────────────────────────────────────┤ +│ ROIC │ Retail Opportunity Investments Corp. │ +├───────┼─────────────────────────────────────────┤ +│ TRUP │ Trupanion, Inc. │ +├───────┼─────────────────────────────────────────┤ +│ LOPE │ Grand Canyon Education, Inc. │ +├───────┼─────────────────────────────────────────┤ +│ OPI │ Office Properties Income Trust │ +├───────┼─────────────────────────────────────────┤ +│ EVER │ EverQuote, Inc. │ +├───────┼─────────────────────────────────────────┤ +│ CONE │ CyrusOne Inc. │ +├───────┼─────────────────────────────────────────┤ +│ MTTR │ Matterport, Inc. │ +├───────┼─────────────────────────────────────────┤ +│ TXG │ 10x Genomics, Inc. │ +├───────┼─────────────────────────────────────────┤ +│ APP │ AppLovin Corporation │ +├───────┼─────────────────────────────────────────┤ +│ AMPL │ Amplitude, Inc. │ +├───────┼─────────────────────────────────────────┤ +│ CTRE │ CareTrust REIT, Inc. │ +├───────┼─────────────────────────────────────────┤ +│ KNBE │ KnowBe4, Inc. │ +├───────┼─────────────────────────────────────────┤ +│ SBLK │ Star Bulk Carriers Corp. │ +├───────┼─────────────────────────────────────────┤ +│ OCDX │ Ortho Clinical Diagnostics Holdings plc │ +├───────┼─────────────────────────────────────────┤ +│ OM │ Outset Medical, Inc. │ +├───────┼─────────────────────────────────────────┤ +│ ACVA │ ACV Auctions Inc. │ +├───────┼─────────────────────────────────────────┤ +│ CNDT │ Conduent Incorporated │ +├───────┼─────────────────────────────────────────┤ +│ AUR │ Aurora Innovation, Inc. │ +├───────┼─────────────────────────────────────────┤ +│ IBEX │ IBEX Limited │ +├───────┼─────────────────────────────────────────┤ +│ GRIN │ Grindrod Shipping Holdings Ltd. │ +├───────┼─────────────────────────────────────────┤ +│ PLMR │ Palomar Holdings, Inc. │ +├───────┼─────────────────────────────────────────┤ +│ GLBE │ Global-e Online Ltd. │ +├───────┼─────────────────────────────────────────┤ +│ WKME │ WalkMe Ltd. │ +├───────┼─────────────────────────────────────────┤ +│ ALKS │ Alkermes plc │ +├───────┼─────────────────────────────────────────┤ +│ QUIK │ QuickLogic Corporation │ +├───────┼─────────────────────────────────────────┤ +│ SPWR │ SunPower Corporation │ +├───────┼─────────────────────────────────────────┤ +│ BPMC │ Blueprint Medicines Corporation │ +├───────┼─────────────────────────────────────────┤ +│ GOGL │ Golden Ocean Group Limited │ +├───────┼─────────────────────────────────────────┤ +│ GLDD │ Great Lakes Dredge & Dock Corporation │ +├───────┼─────────────────────────────────────────┤ +│ BCOR │ Blucora, Inc. │ +├───────┼─────────────────────────────────────────┤ +│ BGCP │ BGC Partners, Inc. │ +├───────┼─────────────────────────────────────────┤ +│ ADI │ Analog Devices, Inc. │ +├───────┼─────────────────────────────────────────┤ +│ KHC │ The Kraft Heinz Company │ +├───────┼─────────────────────────────────────────┤ +│ AMCX │ AMC Networks Inc. │ +├───────┼─────────────────────────────────────────┤ +│ AIMC │ Altra Industrial Motion Corp. │ +├───────┼─────────────────────────────────────────┤ +│ WIX │ Wix.com Ltd. │ +├───────┼─────────────────────────────────────────┤ +│ TTD │ The Trade Desk, Inc. │ +├───────┼─────────────────────────────────────────┤ +│ CCEP │ Coca-Cola Europacific Partners PLC │ +├───────┼─────────────────────────────────────────┤ +│ WING │ Wingstop Inc. │ +├───────┼─────────────────────────────────────────┤ +│ DRVN │ Driven Brands Holdings Inc. │ +├───────┼─────────────────────────────────────────┤ +│ CSCO │ Cisco Systems, Inc. │ +├───────┼─────────────────────────────────────────┤ +│ CPRT │ Copart, Inc. │ +├───────┼─────────────────────────────────────────┤ +│ HST │ Host Hotels & Resorts, Inc. │ +├───────┼─────────────────────────────────────────┤ +│ NVDA │ NVIDIA Corporation │ +├───────┼─────────────────────────────────────────┤ +│ RBBN │ Ribbon Communications Inc. │ +├───────┼─────────────────────────────────────────┤ +│ TRIP │ TripAdvisor, Inc. │ +├───────┼─────────────────────────────────────────┤ +│ RGLD │ Royal Gold, Inc. │ +├───────┼─────────────────────────────────────────┤ +│ CRMT │ America's Car-Mart, Inc. │ +├───────┼─────────────────────────────────────────┤ +│ CAKE │ The Cheesecake Factory Incorporated │ +├───────┼─────────────────────────────────────────┤ +│ VECO │ Veeco Instruments Inc. │ +├───────┼─────────────────────────────────────────┤ +│ SCKT │ Socket Mobile, Inc. │ +├───────┼─────────────────────────────────────────┤ +│ PEGA │ Pegasystems Inc. │ +├───────┼─────────────────────────────────────────┤ +│ FARO │ FARO Technologies, Inc. │ +├───────┼─────────────────────────────────────────┤ +│ RUSHA │ Rush Enterprises, Inc. │ +├───────┼─────────────────────────────────────────┤ +│ AXTI │ AXT, Inc. │ +├───────┼─────────────────────────────────────────┤ +│ INFN │ Infinera Corporation │ +├───────┼─────────────────────────────────────────┤ +│ MMLP │ Martin Midstream Partners L.P. │ +├───────┼─────────────────────────────────────────┤ +│ BCOV │ Brightcove Inc. │ +├───────┼─────────────────────────────────────────┤ +│ ROIC │ Retail Opportunity Investments Corp. │ +├───────┼─────────────────────────────────────────┤ +│ TRUP │ Trupanion, Inc. │ +├───────┼─────────────────────────────────────────┤ +│ LOPE │ Grand Canyon Education, Inc. │ +├───────┼─────────────────────────────────────────┤ +│ OPI │ Office Properties Income Trust │ +├───────┼─────────────────────────────────────────┤ +│ EVER │ EverQuote, Inc. │ +├───────┼─────────────────────────────────────────┤ +│ CONE │ CyrusOne Inc. │ +├───────┼─────────────────────────────────────────┤ +│ MTTR │ Matterport, Inc. │ +├───────┼─────────────────────────────────────────┤ +│ TXG │ 10x Genomics, Inc. │ +├───────┼─────────────────────────────────────────┤ +│ APP │ AppLovin Corporation │ +├───────┼─────────────────────────────────────────┤ +│ AMPL │ Amplitude, Inc. │ +├───────┼─────────────────────────────────────────┤ +│ CTRE │ CareTrust REIT, Inc. │ +├───────┼─────────────────────────────────────────┤ +│ KNBE │ KnowBe4, Inc. │ +├───────┼─────────────────────────────────────────┤ +│ SBLK │ Star Bulk Carriers Corp. │ +├───────┼─────────────────────────────────────────┤ +│ OCDX │ Ortho Clinical Diagnostics Holdings plc │ +├───────┼─────────────────────────────────────────┤ +│ OM │ Outset Medical, Inc. │ +├───────┼─────────────────────────────────────────┤ +│ ACVA │ ACV Auctions Inc. │ +├───────┼─────────────────────────────────────────┤ +│ CNDT │ Conduent Incorporated │ +├───────┼─────────────────────────────────────────┤ +│ AUR │ Aurora Innovation, Inc. │ +├───────┼─────────────────────────────────────────┤ +│ IBEX │ IBEX Limited │ +├───────┼─────────────────────────────────────────┤ +│ GRIN │ Grindrod Shipping Holdings Ltd. │ +├───────┼─────────────────────────────────────────┤ +│ PLMR │ Palomar Holdings, Inc. │ +├───────┼─────────────────────────────────────────┤ +│ GLBE │ Global-e Online Ltd. │ +├───────┼─────────────────────────────────────────┤ +│ WKME │ WalkMe Ltd. │ +├───────┼─────────────────────────────────────────┤ +│ ALKS │ Alkermes plc │ +├───────┼─────────────────────────────────────────┤ +│ QUIK │ QuickLogic Corporation │ +├───────┼─────────────────────────────────────────┤ +│ SPWR │ SunPower Corporation │ +├───────┼─────────────────────────────────────────┤ +│ BPMC │ Blueprint Medicines Corporation │ +├───────┼─────────────────────────────────────────┤ +│ GOGL │ Golden Ocean Group Limited │ +└───────┴─────────────────────────────────────────┘ +``` +--- diff --git a/website/versioned_docs/version-v3/terminal/reference/stocks/dps/_category_.json b/website/content/terminal/reference/stocks/dps/_category_.json similarity index 100% rename from website/versioned_docs/version-v3/terminal/reference/stocks/dps/_category_.json rename to website/content/terminal/reference/stocks/dps/_category_.json diff --git a/website/content/terminal/reference/stocks/dps/ctb.md b/website/content/terminal/reference/stocks/dps/ctb.md new file mode 100644 index 000000000000..f72ef8bc2ade --- /dev/null +++ b/website/content/terminal/reference/stocks/dps/ctb.md @@ -0,0 +1,89 @@ +--- +title: ctb +description: This page provides a detailed overview on how to show the cost to borrow + of stocks using the ctb function. It includes usage, parameters, and examples, helping + users to effectively retrieve and manage data. +keywords: +- ctb function +- cost to borrow +- stock data +- Interactive Broker +- record retrieval +- data management +- Stocksera +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Show cost to borrow of stocks. [Source: Stocksera/Interactive Broker] + +### Usage + +```python +ctb [-n NUMBER] [--raw] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| number | Number of records to retrieve. | 20 | True | None | +| raw | Print raw data. | False | True | None | + + +--- + +## Examples + +```python +2022 Apr 07, 09:47 (�) /stocks/dps/ $ ctb + Highest Cost to Borrow +┌─────────┬───────────┬───────────┐ +│ Symbol │ Fees │ Available │ +├─────────┼───────────┼───────────┤ +│ PIK │ 457.4402% │ 7000 │ +├─────────┼───────────┼───────────┤ +│ EVTL │ 413.7294% │ 10000 │ +├─────────┼───────────┼───────────┤ +│ CELZ │ 330.9411% │ 100000 │ +├─────────┼───────────┼───────────┤ +│ DRCT │ 304.9628% │ 300000 │ +├─────────┼───────────┼───────────┤ +│ MYNZ │ 291.8163% │ 3000 │ +├─────────┼───────────┼───────────┤ +│ DCFC │ 279.0673% │ 10000 │ +├─────────┼───────────┼───────────┤ +│ FGFPP │ 278.422% │ 8000 │ +├─────────┼───────────┼───────────┤ +│ ZTEK │ 250.0307% │ 75000 │ +├─────────┼───────────┼───────────┤ +│ FRGE │ 245.1883% │ 700 │ +├─────────┼───────────┼───────────┤ +│ SATL │ 240.7341% │ 500 │ +├─────────┼───────────┼───────────┤ +│ ARMR │ 240.5414% │ 5000 │ +├─────────┼───────────┼───────────┤ +│ PILL │ 223.538% │ 55000 │ +├─────────┼───────────┼───────────┤ +│ ARQQ │ 217.3978% │ 3000 │ +├─────────┼───────────┼───────────┤ +│ NRSN │ 216.9888% │ 6000 │ +├─────────┼───────────┼───────────┤ +│ ZIONL │ 215.2871% │ 35000 │ +├─────────┼───────────┼───────────┤ +│ BLBX │ 213.441% │ 15000 │ +├─────────┼───────────┼───────────┤ +│ WINSF │ 212.907% │ 10000 │ +├─────────┼───────────┼───────────┤ +│ SKYH │ 206.7746% │ 25000 │ +├─────────┼───────────┼───────────┤ +│ SOHON │ 205.1096% │ 40000 │ +├─────────┼───────────┼───────────┤ +│ MH PRA │ 202.1235% │ 100000 │ +└─────────┴───────────┴───────────┘ +``` +--- diff --git a/website/content/terminal/reference/stocks/dps/dpotc.md b/website/content/terminal/reference/stocks/dps/dpotc.md new file mode 100644 index 000000000000..c01988e1a7a4 --- /dev/null +++ b/website/content/terminal/reference/stocks/dps/dpotc.md @@ -0,0 +1,37 @@ +--- +title: dpotc +description: dpotc is a command that displays a barchart of dark pool (ATS) and OTC + (Non ATS) data. With this command, you can visually interpret financial data efficiently. +keywords: +- dpotc +- dark pool data +- OTC data +- barchart display +- financial data visualization +- Non ATS +- ATS +- FINRA +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Display barchart of dark pool (ATS) and OTC (Non ATS) data. [Source: FINRA] + +### Usage + +```python +dpotc +``` + +--- + +## Parameters + +This command has no parameters + + +![Figure_2](https://user-images.githubusercontent.com/46355364/154075026-dad50459-0e0b-478f-94ad-c478bf66ce1a.png) + +--- diff --git a/website/content/terminal/reference/stocks/dps/ftd.md b/website/content/terminal/reference/stocks/dps/ftd.md new file mode 100644 index 000000000000..24226577811c --- /dev/null +++ b/website/content/terminal/reference/stocks/dps/ftd.md @@ -0,0 +1,41 @@ +--- +title: ftd +description: Documentation and usage guide for the 'ftd' function that prints the + latest fails-to-deliver data sourced from SEC. It allows users to specify date range, + volume of data and offers raw data print. +keywords: +- fails-to-deliver data +- SEC source +- ftd +- datetime parameter +- raw data +- data print +- data analysis +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Prints latest fails-to-deliver data. [Source: SEC] + +### Usage + +```python +ftd [-s START] [-e END] [-n N_NUM] [--raw] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| start | start of datetime to see FTD | 2022-09-26 | True | None | +| end | end of datetime to see FTD | 2022-11-25 | True | None | +| n_num | number of latest fails-to-deliver being printed | 0 | True | None | +| raw | Print raw data. | False | True | None | + +![ftd](https://user-images.githubusercontent.com/46355364/154075166-a5a84604-e8ec-46d5-a990-8ca3d928c662.png) + +--- diff --git a/website/content/terminal/reference/stocks/dps/hsi.md b/website/content/terminal/reference/stocks/dps/hsi.md new file mode 100644 index 000000000000..cf6413fcb8d8 --- /dev/null +++ b/website/content/terminal/reference/stocks/dps/hsi.md @@ -0,0 +1,71 @@ +--- +title: hsi +description: This page provides detailed instructions on how to use the 'hsi' tool, + which is designed to pull data on the top stocks that are being heavily shorted + according to HighShortInterest.com. It provides details on parameters, usage, and + examples on how to use the command line tool. +keywords: +- hsi tool +- stock market data +- short interest stocks +- high short interest +- stock command line tools +- stock market research +- stocks +- short selling +- stock market guide +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Print top stocks being more heavily shorted. HighShortInterest.com provides a convenient sorted database of stocks which have a short interest of over 20 percent. Additional key data such as the float, number of outstanding shares, and company industry is displayed. Data is presented for the Nasdaq Stock Market, the New York Stock Exchange, and the American Stock Exchange. [Source: www.highshortinterest.com] + +### Usage + +```python +hsi [-l LIMIT] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| limit | Limit of the top heavily shorted stocks to retrieve. | 10 | True | None | + + +--- + +## Examples + +```python +2022 Feb 15, 08:49 (🦋) /stocks/dps/ $ hsi + Top Interest Stocks +┌────────┬───────────────────────────────┬──────────┬──────────┬─────────┬─────────┬────────────────────────────────────────────┐ +│ Ticker │ Company │ Exchange │ ShortInt │ Float │ Outstd │ Industry │ +├────────┼───────────────────────────────┼──────────┼──────────┼─────────┼─────────┼────────────────────────────────────────────┤ +│ CRTX │ Cortexyme Inc │ Nasdaq │ 47.00% │ 15.56M │ 29.88M │ Biotechnology & Medical Research │ +├────────┼───────────────────────────────┼──────────┼──────────┼─────────┼─────────┼────────────────────────────────────────────┤ +│ BLNK │ Blink Charging Co │ Nasdaq │ 40.97% │ 36.46M │ 42.20M │ Utilities - Electric │ +├────────┼───────────────────────────────┼──────────┼──────────┼─────────┼─────────┼────────────────────────────────────────────┤ +│ GOGO │ Gogo Inc │ Nasdaq │ 39.10% │ 45.62M │ 109.95M │ Communications Services │ +├────────┼───────────────────────────────┼──────────┼──────────┼─────────┼─────────┼────────────────────────────────────────────┤ +│ FUV │ Arcimoto Inc │ Nasdaq │ 35.67% │ 28.76M │ 37.64M │ Auto & Truck Manufacturers │ +├────────┼───────────────────────────────┼──────────┼──────────┼─────────┼─────────┼────────────────────────────────────────────┤ +│ ICPT │ Intercept Pharmaceuticals Inc │ Nasdaq │ 35.61% │ 23.52M │ 29.55M │ Biotechnology & Medical Research │ +├────────┼───────────────────────────────┼──────────┼──────────┼─────────┼─────────┼────────────────────────────────────────────┤ +│ SFT │ Shift Technologies Inc │ Nasdaq │ 35.18% │ 54.48M │ 81.31M │ Retailers - Auto Vehicles, Parts & Service │ +├────────┼───────────────────────────────┼──────────┼──────────┼─────────┼─────────┼────────────────────────────────────────────┤ +│ BGFV │ Big 5 Sporting Goods Corp │ Nasdaq │ 34.45% │ 20.01M │ 22.31M │ Retailers - Miscellaneous Specialty │ +├────────┼───────────────────────────────┼──────────┼──────────┼─────────┼─────────┼────────────────────────────────────────────┤ +│ RMO │ Romeo Power Inc │ NYSE │ 34.28% │ 90.21M │ 134.46M │ Electrical Components & Equipment │ +├────────┼───────────────────────────────┼──────────┼──────────┼─────────┼─────────┼────────────────────────────────────────────┤ +│ BYND │ Beyond Meat Inc │ Nasdaq │ 33.99% │ 56.25M │ 63.33M │ Food Processing │ +├────────┼───────────────────────────────┼──────────┼──────────┼─────────┼─────────┼────────────────────────────────────────────┤ +│ SDC │ SmileDirectClub Inc │ Nasdaq │ 33.23% │ 110.88M │ 119.14M │ Medical Equipment, Supplies & Distribution │ +└────────┴───────────────────────────────┴──────────┴──────────┴─────────┴─────────┴────────────────────────────────────────────┘ +``` +--- diff --git a/website/content/terminal/reference/stocks/dps/load.md b/website/content/terminal/reference/stocks/dps/load.md new file mode 100644 index 000000000000..a9e9cb70ed68 --- /dev/null +++ b/website/content/terminal/reference/stocks/dps/load.md @@ -0,0 +1,51 @@ +--- +title: load +description: Understanding how to load a stock ticker for analysis. This page provides + description and usage of parameters such as stock ticker, start date, end date, + interval, filepath and more. Indian tickers and Yahoo Finance markets are also referenced. +keywords: +- load +- stock ticker +- analysis +- data source +- Indian ticker +- yahoo finance +- market +- parameters +- starting date +- ending date +- intraday stock +- prepost +- filepath +- monthly data +- weekly data +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Load stock ticker to perform analysis on. When the data source is syf', an Indian ticker can be loaded by using '.NS' at the end, e.g. 'SBIN.NS'. See available market in https://help.yahoo.com/kb/exchanges-data-providers-yahoo-finance-sln2310.html. + +### Usage + +```python +load -t TICKER [-s START] [-e END] [-i {1,5,15,30,60}] [-p] [-f FILEPATH] [-m] [-w] [-r {ytd,1y,2y,5y,6m}] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| ticker | Stock ticker | None | False | None | +| start | The starting date (format YYYY-MM-DD) of the stock | 2019-11-21 | True | None | +| end | The ending date (format YYYY-MM-DD) of the stock | 2022-11-25 | True | None | +| interval | Intraday stock minutes | 1440 | True | 1, 5, 15, 30, 60 | +| prepost | Pre/After market hours. Only works for 'yf' source, and intraday data | False | True | None | +| filepath | Path to load custom file. | None | True | None | +| monthly | Load monthly data | False | True | None | +| weekly | Load weekly data | False | True | None | + +--- diff --git a/website/content/terminal/reference/stocks/dps/pos.md b/website/content/terminal/reference/stocks/dps/pos.md new file mode 100644 index 000000000000..add354ef961f --- /dev/null +++ b/website/content/terminal/reference/stocks/dps/pos.md @@ -0,0 +1,76 @@ +--- +title: pos +description: The 'pos' page holds the explanation and tutorial for retrieving dark + pool short positions. The content includes usage, parameters with their detailed + description, and an example in form of a table. +keywords: +- Dark pool short positions +- Python script usage +- Data parameters +- Data sorting +- Descending order +- Ascending order +- Display limit +- Command line tool example +- Volatility data +- Net short volume +- DP position +- Stock market parameters +- Stockgrid source +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Get dark pool short positions. [Source: Stockgrid] + +### Usage + +```python +pos [-l LIMIT] [-s {sv,sv_pct,nsv,nsv_dollar,dpp,dpp_dollar}] [-r] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| limit | Limit of tickers to display. | 10 | True | None | +| sort_field | Field for which to sort by, where 'sv': Short Vol. [1M], 'sv_pct': Short Vol. %%, 'nsv': Net Short Vol. [1M], 'nsv_dollar': Net Short Vol. ($100M), 'dpp': DP Position [1M], 'dpp_dollar': DP Position ($1B) | dpp_dollar | True | sv, sv_pct, nsv, nsv_dollar, dpp, dpp_dollar | +| reverse | Data is sorted in descending order by default. Reverse flag will sort it in an ascending way. Only works when raw data is displayed. | False | True | None | + + +--- + +## Examples + +```python +2022 Feb 15, 08:51 (🦋) /stocks/dps/ $ pos + Data for: 2022-02-14 +┌────────┬─────────────────┬──────────────┬─────────────────────┬────────────────────────┬──────────────────┬───────────────────┐ +│ Ticker │ Short Vol. [1M] │ Short Vol. % │ Net Short Vol. [1M] │ Net Short Vol. ($100M) │ DP Position [1M] │ DP Position ($1B) │ +├────────┼─────────────────┼──────────────┼─────────────────────┼────────────────────────┼──────────────────┼───────────────────┤ +│ QQQ │ 12.80 │ 66.45 │ 6.34 │ 22.02 │ 117.89 │ 42.14 │ +├────────┼─────────────────┼──────────────┼─────────────────────┼────────────────────────┼──────────────────┼───────────────────┤ +│ AMD │ 45.65 │ 66.50 │ 22.65 │ 25.88 │ 171.23 │ 21.13 │ +├────────┼─────────────────┼──────────────┼─────────────────────┼────────────────────────┼──────────────────┼───────────────────┤ +│ SPY │ 12.74 │ 53.08 │ 1.48 │ 6.49 │ 42.46 │ 19.11 │ +├────────┼─────────────────┼──────────────┼─────────────────────┼────────────────────────┼──────────────────┼───────────────────┤ +│ NVDA │ 12.36 │ 55.73 │ 2.54 │ 6.17 │ 73.21 │ 18.07 │ +├────────┼─────────────────┼──────────────┼─────────────────────┼────────────────────────┼──────────────────┼───────────────────┤ +│ IWM │ 3.33 │ 72.64 │ 2.07 │ 4.16 │ 33.92 │ 6.74 │ +├────────┼─────────────────┼──────────────┼─────────────────────┼────────────────────────┼──────────────────┼───────────────────┤ +│ LQD │ 8.18 │ 83.55 │ 6.57 │ 8.13 │ 52.24 │ 6.62 │ +├────────┼─────────────────┼──────────────┼─────────────────────┼────────────────────────┼──────────────────┼───────────────────┤ +│ HYG │ 8.20 │ 70.11 │ 4.70 │ 3.88 │ 59.81 │ 5.04 │ +├────────┼─────────────────┼──────────────┼─────────────────────┼────────────────────────┼──────────────────┼───────────────────┤ +│ NFLX │ 1.28 │ 47.61 │ -0.13 │ -0.51 │ 11.19 │ 4.76 │ +├────────┼─────────────────┼──────────────┼─────────────────────┼────────────────────────┼──────────────────┼───────────────────┤ +│ SNAP │ 13.34 │ 61.82 │ 5.10 │ 2.02 │ 105.93 │ 4.34 │ +├────────┼─────────────────┼──────────────┼─────────────────────┼────────────────────────┼──────────────────┼───────────────────┤ +│ SMH │ 1.04 │ 62.44 │ 0.41 │ 1.10 │ 13.29 │ 3.67 │ +└────────┴─────────────────┴──────────────┴─────────────────────┴────────────────────────┴──────────────────┴───────────────────┘ +``` +--- diff --git a/website/content/terminal/reference/stocks/dps/prom.md b/website/content/terminal/reference/stocks/dps/prom.md new file mode 100644 index 000000000000..f35d33913112 --- /dev/null +++ b/website/content/terminal/reference/stocks/dps/prom.md @@ -0,0 +1,39 @@ +--- +title: prom +description: Display dark pool (ATS) data of tickers with growing trades activity + using linear regression. Filter and process data from different tiers. +keywords: +- prom +- dark pool +- ATS data +- trade activity +- linear regression +- data filtering +- tier processing +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Display dark pool (ATS) data of tickers with growing trades activity using linear regression. + +### Usage + +```python +prom [-n N_NUM] [-l LIMIT] [-t {T1,T2,OTCE}] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| n_num | Number of tickers to filter from entire ATS data based on the sum of the total weekly shares quantity. | 1000 | True | None | +| limit | Limit of most promising tickers to display. | 10 | True | None | +| tier | Tier to process data from. | | True | T1, T2, OTCE | + +![prom](https://user-images.githubusercontent.com/46355364/154076323-2d031477-a70d-4065-b649-c8493fecdcbc.png) + +--- diff --git a/website/content/terminal/reference/stocks/dps/psi.md b/website/content/terminal/reference/stocks/dps/psi.md new file mode 100644 index 000000000000..5cca25dd3068 --- /dev/null +++ b/website/content/terminal/reference/stocks/dps/psi.md @@ -0,0 +1,38 @@ +--- +title: psi +description: The page provides detailed information about psi command which shows + the price vs short interest volume data from either NYSE or NASDAQ taken from Quandl + or Stockgrid. It also includes usage and parameter details. +keywords: +- psi +- NYSE +- NASDAQ +- Quandl +- Stockgrid +- short-interest volume +- price +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Shows price vs short interest volume. [Source: Quandl/Stockgrid] + +### Usage + +```python +psi [--nyse] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| b_nyse | Data from NYSE flag. Otherwise comes from NASDAQ. Only works for Quandl. | False | True | None | + +![Figure_2](https://user-images.githubusercontent.com/46355364/154076731-e1f5ad9c-71c7-4c56-93b1-613985057951.png) + +--- diff --git a/website/content/terminal/reference/stocks/dps/shorted.md b/website/content/terminal/reference/stocks/dps/shorted.md new file mode 100644 index 000000000000..ac2c17874621 --- /dev/null +++ b/website/content/terminal/reference/stocks/dps/shorted.md @@ -0,0 +1,70 @@ +--- +title: shorted +description: This page provides information on the 'shorted' functionality which allows + users to retrieve up to 25 top ticker most shorted stocks from Yahoo Finance. The + page explains how the feature can be used, and lists the parameters available for + customization. +keywords: +- shorted +- top ticker +- most shorted stocks +- yahoo finance +- stock market +- stock analysis +- limit +- parameters +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Print up to 25 top ticker most shorted. [Source: Yahoo Finance] + +### Usage + +```python +shorted [-l LIMIT] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| limit | Limit of the most shorted stocks to retrieve. | 10 | True | None | + + +--- + +## Examples + +```python +2022 Feb 15, 11:06 (🦋) /stocks/dps/ $ shorted + Most Shorted Stocks +┌────────┬────────────────────────────────────────┬──────────────────┬────────┬──────────┬────────┬───────────────────┬────────────┬────────────────┐ +│ Symbol │ Name │ Price (Intraday) │ Change │ % Change │ Volume │ Avg Vol (3 month) │ Market Cap │ PE Ratio (TTM) │ +├────────┼────────────────────────────────────────┼──────────────────┼────────┼──────────┼────────┼───────────────────┼────────────┼────────────────┤ +│ ECAT │ BlackRock ESG Capital Allocation Trust │ 16.86 │ 0.13 │ +0.78% │ 40765 │ 347083 │ 84300 │ │ +├────────┼────────────────────────────────────────┼──────────────────┼────────┼──────────┼────────┼───────────────────┼────────────┼────────────────┤ +│ BLNK │ Blink Charging Co. │ 24.75 │ 0.97 │ +4.08% │ 354745 │ 2.357M │ 1.044B │ │ +├────────┼────────────────────────────────────────┼──────────────────┼────────┼──────────┼────────┼───────────────────┼────────────┼────────────────┤ +│ HRTX │ Heron Therapeutics, Inc. │ 8.74 │ 0.22 │ +2.58% │ 200853 │ 2.077M │ 890.912M │ │ +├────────┼────────────────────────────────────────┼──────────────────┼────────┼──────────┼────────┼───────────────────┼────────────┼────────────────┤ +│ SAVA │ Cassava Sciences, Inc. │ 48.83 │ 0.13 │ +0.28% │ 430440 │ 3.047M │ 1.954B │ │ +├────────┼────────────────────────────────────────┼──────────────────┼────────┼──────────┼────────┼───────────────────┼────────────┼────────────────┤ +│ ARCH │ Arch Resources, Inc. │ 116.90 │ 3.64 │ +3.21% │ 623213 │ 493427 │ 1.79B │ 59.80 │ +├────────┼────────────────────────────────────────┼──────────────────┼────────┼──────────┼────────┼───────────────────┼────────────┼────────────────┤ +│ EVGO │ EVgo, Inc. │ 10.01 │ 0.27 │ +2.77% │ 1.144M │ 4.419M │ 2.648B │ │ +├────────┼────────────────────────────────────────┼──────────────────┼────────┼──────────┼────────┼───────────────────┼────────────┼────────────────┤ +│ BEEM │ Beam Global │ 14.56 │ 1.07 │ +7.92% │ 59466 │ 357145 │ 130.285M │ │ +├────────┼────────────────────────────────────────┼──────────────────┼────────┼──────────┼────────┼───────────────────┼────────────┼────────────────┤ +│ SDC │ SmileDirectClub, Inc. │ 2.29 │ 0.07 │ +3.39% │ 1.018M │ 8.748M │ 886.831M │ │ +├────────┼────────────────────────────────────────┼──────────────────┼────────┼──────────┼────────┼───────────────────┼────────────┼────────────────┤ +│ BGFV │ Big 5 Sporting Goods Corporation │ 17.84 │ 0.52 │ +3.00% │ 139821 │ 1.183M │ 398.025M │ 3.88 │ +├────────┼────────────────────────────────────────┼──────────────────┼────────┼──────────┼────────┼───────────────────┼────────────┼────────────────┤ +│ BYND │ Beyond Meat, Inc. │ 59.97 │ 1.84 │ +3.17% │ 480665 │ 3.702M │ 3.798B │ │ +└────────┴────────────────────────────────────────┴──────────────────┴────────┴──────────┴────────┴───────────────────┴────────────┴────────────────┘ +``` +--- diff --git a/website/content/terminal/reference/stocks/dps/sidtc.md b/website/content/terminal/reference/stocks/dps/sidtc.md new file mode 100644 index 000000000000..d5177ff97952 --- /dev/null +++ b/website/content/terminal/reference/stocks/dps/sidtc.md @@ -0,0 +1,69 @@ +--- +title: sidtc +description: The sidtc page provides a command line interface to print short interest + and days to cover for stocks. Provides options to limit the number of tickers displayed + and sorting by specific fields. +keywords: +- sidtc +- short interest +- days to cover +- Stockgrid +- stock market +- financial data +- stock analysis +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Print short interest and days to cover. [Source: Stockgrid] + +### Usage + +```python +sidtc [-l LIMIT] [-s {float,dtc,si}] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| limit | Limit of tickers to display. | 10 | True | None | +| sort_field | Field for which to sort by, where 'float': Float Short %%, 'dtc': Days to Cover, 'si': Short Interest | float | True | float, dtc, si | + + +--- + +## Examples + +```python +2022 Feb 15, 11:07 (🦋) /stocks/dps/ $ sidtc + Data for: 2022-01-31 +┌────────┬───────────────┬───────────────┬─────────────────────┐ +│ Ticker │ Float Short % │ Days to Cover │ Short Interest [1M] │ +├────────┼───────────────┼───────────────┼─────────────────────┤ +│ VIEW │ 40.70 │ 14.92 │ 21.46 │ +├────────┼───────────────┼───────────────┼─────────────────────┤ +│ HRTX │ 34.06 │ 14.92 │ 34.64 │ +├────────┼───────────────┼───────────────┼─────────────────────┤ +│ IRBT │ 24.47 │ 13.85 │ 6.47 │ +├────────┼───────────────┼───────────────┼─────────────────────┤ +│ ZYXI │ 24.13 │ 14.43 │ 4.77 │ +├────────┼───────────────┼───────────────┼─────────────────────┤ +│ TDUP │ 22.94 │ 14.14 │ 11.93 │ +├────────┼───────────────┼───────────────┼─────────────────────┤ +│ GOGO │ 22.44 │ 25.02 │ 17.84 │ +├────────┼───────────────┼───────────────┼─────────────────────┤ +│ SATS │ 19.49 │ 23.27 │ 7.14 │ +├────────┼───────────────┼───────────────┼─────────────────────┤ +│ RLAY │ 19.32 │ 20.15 │ 14.88 │ +├────────┼───────────────┼───────────────┼─────────────────────┤ +│ OMER │ 18.89 │ 13.36 │ 11.32 │ +├────────┼───────────────┼───────────────┼─────────────────────┤ +│ AXDX │ 18.75 │ 19.71 │ 7.00 │ +└────────┴───────────────┴───────────────┴─────────────────────┘ +``` +--- diff --git a/website/content/terminal/reference/stocks/dps/spos.md b/website/content/terminal/reference/stocks/dps/spos.md new file mode 100644 index 000000000000..b6084bf250ae --- /dev/null +++ b/website/content/terminal/reference/stocks/dps/spos.md @@ -0,0 +1,37 @@ +--- +title: spos +description: An informative page that demonstrates the usage of the 'spos' command, + exhibiting Net Short Vol. vs Position. It includes instructions on how to use the + command, its parameters, and an illustrative image. +keywords: +- spos command +- Net Short Vol vs Position +- command usage +- parameters +- trading commands +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Shows Net Short Vol. vs Position. [Source: Stockgrid] + +### Usage + +```python +spos [-n NUM] [-r] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| num | Number of last open market days to show | 120 | True | None | +| raw | Flag to print raw data instead | False | True | None | + +![spos](https://user-images.githubusercontent.com/46355364/154101511-fd2d65e9-69a6-46f3-aa78-77c032c6900d.png) + +--- diff --git a/website/versioned_docs/version-v3/terminal/reference/stocks/fa/_category_.json b/website/content/terminal/reference/stocks/fa/_category_.json similarity index 100% rename from website/versioned_docs/version-v3/terminal/reference/stocks/fa/_category_.json rename to website/content/terminal/reference/stocks/fa/_category_.json diff --git a/website/content/terminal/reference/stocks/fa/analysis.md b/website/content/terminal/reference/stocks/fa/analysis.md new file mode 100644 index 000000000000..256ace883411 --- /dev/null +++ b/website/content/terminal/reference/stocks/fa/analysis.md @@ -0,0 +1,30 @@ +--- +title: analysis +description: This page provides guidance on how to perform an analysis of SEC filings + using a specific NLP model through a python command. This command has no parameters. +keywords: +- analysis +- SEC filings +- NLP model +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Display analysis of SEC filings based on NLP model. [Source: https://eclect.us] + +### Usage + +```python +analysis +``` + +--- + +## Parameters + +This command has no parameters + + +--- diff --git a/website/content/terminal/reference/stocks/fa/balance.md b/website/content/terminal/reference/stocks/fa/balance.md new file mode 100644 index 000000000000..2295b2f677ef --- /dev/null +++ b/website/content/terminal/reference/stocks/fa/balance.md @@ -0,0 +1,204 @@ +--- +title: balance +description: The 'balance' documentation page provides comprehensive instructions + for printing a balance sheet statement over time. The page explains expected fields, + usage, parameters, and provides examples. It is a helpful resource for anyone looking + to understand how to use the 'balance' function effectively. +keywords: +- balance sheet statement +- balance page +- financial data +- Alpha Vantage +- parameters +- time-series data +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Prints a complete balance sheet statement over time. This can be either quarterly or annually. The following fields are expected: Accepted date, Account payables, Accumulated other comprehensive income loss, Cash and cash equivalents, Cash and short term investments, Common stock, Deferred revenue, Deferred revenue non current, Deferred tax liabilities non current, Filling date, Final link, Goodwill, Goodwill and intangible assets, Intangible assets, Inventory, Link, Long term debt, Long term investments, Net debt, Net receivables, Other assets, Other current assets, Other current liabilities, Other liabilities, Other non current assets, Other non current liabilities, Othertotal stockholders equity, Period, Property plant equipment net, Retained earnings, Short term debt, Short term investments, Tax assets, Tax payables, Total assets, Total current assets, Total current liabilities, Total debt, Total investments, Total liabilities, Total liabilities and stockholders equity, Total non current assets, Total non current liabilities, and Total stockholders equity. [Source: Alpha Vantage] + +### Usage + +```python +balance [-q] [-r] [-p column] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| b_quarter | Quarter fundamental data flag. | False | True | None | +| ratios | Shows percentage change of values. | False | True | None | +| plot | Rows to plot, comma separated. (-1 represents invalid data) | None | True | cash_and_cash_equivalents, short_term_investments, total_cash, net_receivables, inventory, other_current_assets, total_current_assets, gross_property_plant_and_equipment, accumulated_depreciation, net_property_plant_and_equipment, equity_and_other_investments, other_long-term_assets, total_non-current_assets, total_assets, current_debt, accounts_payable, deferred_revenues, other_current_liabilities, total_current_liabilities, long-term_debt, deferred_tax_liabilities, deferred_revenues, other_long-term_liabilities, total_non-current_liabilities, total_liabilities, common_stock, retained_earnings, accumulated_other_comprehensive_income, total_stockholders'_equity, total_liabilities_and_stockholders'_equity | + + +--- + +## Examples + +```python +2022 Feb 16, 04:44 (🦋) /stocks/fa/ $ balance -l 4 + MU Balance Sheet +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━┳━━━━━━━━━━━━┳━━━━━━━━━━━━┳━━━━━━━━━━━━┓ +┃ ┃ 2018-08-30 ┃ 2019-08-29 ┃ 2020-09-03 ┃ 2021-09-02 ┃ +┡━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━╇━━━━━━━━━━━━╇━━━━━━━━━━━━╇━━━━━━━━━━━━┩ +│ reportedCurrency │ USD │ USD │ USD │ USD │ +├────────────────────────────────────────┼────────────┼────────────┼────────────┼────────────┤ +│ totalAssets │ 43.376 B │ 48.887 B │ 53.678 B │ 58.849 B │ +├────────────────────────────────────────┼────────────┼────────────┼────────────┼────────────┤ +│ totalCurrentAssets │ 16.039 B │ 16.503 B │ 17.965 B │ 19.907 B │ +├────────────────────────────────────────┼────────────┼────────────┼────────────┼────────────┤ +│ cashAndCashEquivalentsAtCarryingValue │ 6.506 B │ 7.152 B │ 7.624 B │ 7.763 B │ +├────────────────────────────────────────┼────────────┼────────────┼────────────┼────────────┤ +│ cashAndShortTermInvestments │ 6.506 B │ 7.955 B │ 8.142 B │ 8.633 B │ +├────────────────────────────────────────┼────────────┼────────────┼────────────┼────────────┤ +│ inventory │ 3.595 B │ 5.118 B │ 5.373 B │ 4.487 B │ +├────────────────────────────────────────┼────────────┼────────────┼────────────┼────────────┤ +│ currentNetReceivables │ None │ 3.195 B │ 3.912 B │ 5.311 B │ +├────────────────────────────────────────┼────────────┼────────────┼────────────┼────────────┤ +│ totalNonCurrentAssets │ 26.396 B │ 32.511 B │ 5.174 B │ 6.495 B │ +├────────────────────────────────────────┼────────────┼────────────┼────────────┼────────────┤ +│ propertyPlantEquipment │ 23.672 B │ 28.240 B │ 31.615 B │ 33.764 B │ +├────────────────────────────────────────┼────────────┼────────────┼────────────┼────────────┤ +│ accumulatedDepreciationAmortizationPPE │ 25.419 B │ 29.584 B │ None │ None │ +├────────────────────────────────────────┼────────────┼────────────┼────────────┼────────────┤ +│ intangibleAssets │ 1.559 B │ 1.568 B │ 1.562 B │ 1.577 B │ +├────────────────────────────────────────┼────────────┼────────────┼────────────┼────────────┤ +│ intangibleAssetsExcludingGoodwill │ 331 M │ 340 M │ 334 M │ 349 M │ +├────────────────────────────────────────┼────────────┼────────────┼────────────┼────────────┤ +│ goodwill │ 1.228 B │ 1.228 B │ 1.228 B │ 1.228 B │ +├────────────────────────────────────────┼────────────┼────────────┼────────────┼────────────┤ +│ investments │ 769 M │ 1.967 B │ 1.566 B │ 2.635 B │ +├────────────────────────────────────────┼────────────┼────────────┼────────────┼────────────┤ +│ longTermInvestments │ 473 M │ 1.164 B │ 1.048 B │ 1.765 B │ +├────────────────────────────────────────┼────────────┼────────────┼────────────┼────────────┤ +│ shortTermInvestments │ 296 M │ 803 M │ 518 M │ 870 M │ +├────────────────────────────────────────┼────────────┼────────────┼────────────┼────────────┤ +│ otherCurrentAssets │ 164 M │ 235 M │ 538 M │ 502 M │ +├────────────────────────────────────────┼────────────┼────────────┼────────────┼────────────┤ +│ otherNonCurrrentAssets │ 611 M │ 575 M │ 781 M │ 1.054 B │ +├────────────────────────────────────────┼────────────┼────────────┼────────────┼────────────┤ +│ totalLiabilities │ 10.112 B │ 12.019 B │ 14.682 B │ 14.916 B │ +├────────────────────────────────────────┼────────────┼────────────┼────────────┼────────────┤ +│ totalCurrentLiabilities │ 5.754 B │ 6.390 B │ 6.635 B │ 6.424 B │ +├────────────────────────────────────────┼────────────┼────────────┼────────────┼────────────┤ +│ currentAccountsPayable │ 1.923 B │ 1.840 B │ 2.357 B │ 2.090 B │ +├────────────────────────────────────────┼────────────┼────────────┼────────────┼────────────┤ +│ deferredRevenue │ None │ 130 M │ 65 M │ 74 M │ +├────────────────────────────────────────┼────────────┼────────────┼────────────┼────────────┤ +│ currentDebt │ 859 M │ 1.310 B │ 270 M │ 155 M │ +├────────────────────────────────────────┼────────────┼────────────┼────────────┼────────────┤ +│ shortTermDebt │ 859 M │ 1.087 B │ 194 M │ 155 M │ +├────────────────────────────────────────┼────────────┼────────────┼────────────┼────────────┤ +│ totalNonCurrentLiabilities │ 4.358 B │ 4.997 B │ 7.404 B │ 7.684 B │ +├────────────────────────────────────────┼────────────┼────────────┼────────────┼────────────┤ +│ capitalLeaseObligations │ 845 M │ 368 M │ 410 M │ 649 M │ +├────────────────────────────────────────┼────────────┼────────────┼────────────┼────────────┤ +│ longTermDebt │ 4.898 B │ 5.755 B │ 6.157 B │ 5.968 B │ +├────────────────────────────────────────┼────────────┼────────────┼────────────┼────────────┤ +│ currentLongTermDebt │ 549 M │ 1.087 B │ 194 M │ 155 M │ +├────────────────────────────────────────┼────────────┼────────────┼────────────┼────────────┤ +│ longTermDebtNoncurrent │ None │ None │ None │ None │ +├────────────────────────────────────────┼────────────┼────────────┼────────────┼────────────┤ +│ shortLongTermDebtTotal │ 4.898 B │ 5.755 B │ 6.351 B │ 7.280 B │ +├────────────────────────────────────────┼────────────┼────────────┼────────────┼────────────┤ +│ otherCurrentLiabilities │ 3.778 B │ 454 M │ 548 M │ 944 M │ +├────────────────────────────────────────┼────────────┼────────────┼────────────┼────────────┤ +│ otherNonCurrentLiabilities │ 581 M │ 452 M │ 498 M │ 559 M │ +├────────────────────────────────────────┼────────────┼────────────┼────────────┼────────────┤ +│ totalShareholderEquity │ 32.294 B │ 35.881 B │ 38.996 B │ 43.933 B │ +├────────────────────────────────────────┼────────────┼────────────┼────────────┼────────────┤ +│ treasuryStock │ 429 M │ 3.221 B │ 3.495 B │ 4.695 B │ +├────────────────────────────────────────┼────────────┼────────────┼────────────┼────────────┤ +│ retainedEarnings │ 24.395 B │ 30.761 B │ 33.384 B │ 39.051 B │ +├────────────────────────────────────────┼────────────┼────────────┼────────────┼────────────┤ +│ commonStock │ 117 M │ 118 M │ 119 M │ 122 M │ +├────────────────────────────────────────┼────────────┼────────────┼────────────┼────────────┤ +│ commonStockSharesOutstanding │ 1.161 B │ 1.106 B │ 1.113 B │ 1.119 B │ +└────────────────────────────────────────┴────────────┴────────────┴────────────┴────────────┘ + +2022 Feb 16, 04:44 (🦋) /stocks/fa/ $ balance -l 4 -q + MU Balance Sheet +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━┳━━━━━━━━━━━━┳━━━━━━━━━━━━┳━━━━━━━━━━━━┓ +┃ ┃ 2021-03-04 ┃ 2021-06-03 ┃ 2021-09-02 ┃ 2021-12-02 ┃ +┡━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━╇━━━━━━━━━━━━╇━━━━━━━━━━━━╇━━━━━━━━━━━━┩ +│ reportedCurrency │ USD │ USD │ USD │ USD │ +├────────────────────────────────────────┼────────────┼────────────┼────────────┼────────────┤ +│ totalAssets │ 54.135 B │ 55.943 B │ 58.849 B │ 61.246 B │ +├────────────────────────────────────────┼────────────┼────────────┼────────────┼────────────┤ +│ totalCurrentAssets │ 17.279 B │ 18.561 B │ 19.907 B │ 20.191 B │ +├────────────────────────────────────────┼────────────┼────────────┼────────────┼────────────┤ +│ cashAndCashEquivalentsAtCarryingValue │ 6.507 B │ 7.759 B │ 7.763 B │ 8.680 B │ +├────────────────────────────────────────┼────────────┼────────────┼────────────┼────────────┤ +│ cashAndShortTermInvestments │ 6.507 B │ 7.759 B │ 8.633 B │ 9.580 B │ +├────────────────────────────────────────┼────────────┼────────────┼────────────┼────────────┤ +│ inventory │ 4.743 B │ 4.537 B │ 4.487 B │ 4.827 B │ +├────────────────────────────────────────┼────────────┼────────────┼────────────┼────────────┤ +│ currentNetReceivables │ 3.353 B │ 4.231 B │ 5.311 B │ 5.250 B │ +├────────────────────────────────────────┼────────────┼────────────┼────────────┼────────────┤ +│ totalNonCurrentAssets │ 36.856 B │ 37.382 B │ 6.495 B │ 6.786 B │ +├────────────────────────────────────────┼────────────┼────────────┼────────────┼────────────┤ +│ propertyPlantEquipment │ 32.423 B │ 32.767 B │ 33.764 B │ 35.729 B │ +├────────────────────────────────────────┼────────────┼────────────┼────────────┼────────────┤ +│ accumulatedDepreciationAmortizationPPE │ None │ None │ None │ None │ +├────────────────────────────────────────┼────────────┼────────────┼────────────┼────────────┤ +│ intangibleAssets │ 1.570 B │ 1.578 B │ 1.577 B │ 1.575 B │ +├────────────────────────────────────────┼────────────┼────────────┼────────────┼────────────┤ +│ intangibleAssetsExcludingGoodwill │ 342 M │ 350 M │ 349 M │ 347 M │ +├────────────────────────────────────────┼────────────┼────────────┼────────────┼────────────┤ +│ goodwill │ 1.228 B │ 1.228 B │ 1.228 B │ 1.228 B │ +├────────────────────────────────────────┼────────────┼────────────┼────────────┼────────────┤ +│ investments │ None │ None │ 2.635 B │ 2.717 B │ +├────────────────────────────────────────┼────────────┼────────────┼────────────┼────────────┤ +│ longTermInvestments │ 1.316 B │ 1.399 B │ 1.765 B │ 1.817 B │ +├────────────────────────────────────────┼────────────┼────────────┼────────────┼────────────┤ +│ shortTermInvestments │ 677 M │ 590 M │ 870 M │ 900 M │ +├────────────────────────────────────────┼────────────┼────────────┼────────────┼────────────┤ +│ otherCurrentAssets │ 538 M │ 478 M │ 502 M │ 521 M │ +├────────────────────────────────────────┼────────────┼────────────┼────────────┼────────────┤ +│ otherNonCurrrentAssets │ 821 M │ 816 M │ 1.054 B │ 1.188 B │ +├────────────────────────────────────────┼────────────┼────────────┼────────────┼────────────┤ +│ totalLiabilities │ 13.472 B │ 13.684 B │ 14.916 B │ 15.338 B │ +├────────────────────────────────────────┼────────────┼────────────┼────────────┼────────────┤ +│ totalCurrentLiabilities │ 5.433 B │ 5.462 B │ 6.424 B │ 6.512 B │ +├────────────────────────────────────────┼────────────┼────────────┼────────────┼────────────┤ +│ currentAccountsPayable │ None │ None │ 2.090 B │ 2.217 B │ +├────────────────────────────────────────┼────────────┼────────────┼────────────┼────────────┤ +│ deferredRevenue │ None │ None │ 74 M │ 74 M │ +├────────────────────────────────────────┼────────────┼────────────┼────────────┼────────────┤ +│ currentDebt │ 323 M │ 297 M │ 155 M │ 118 M │ +├────────────────────────────────────────┼────────────┼────────────┼────────────┼────────────┤ +│ shortTermDebt │ 323 M │ 297 M │ 155 M │ 118 M │ +├────────────────────────────────────────┼────────────┼────────────┼────────────┼────────────┤ +│ totalNonCurrentLiabilities │ 8.039 B │ 8.222 B │ 7.684 B │ 8.059 B │ +├────────────────────────────────────────┼────────────┼────────────┼────────────┼────────────┤ +│ capitalLeaseObligations │ 395 M │ 454 M │ 649 M │ 808 M │ +├────────────────────────────────────────┼────────────┼────────────┼────────────┼────────────┤ +│ longTermDebt │ 6.298 B │ 6.418 B │ 5.968 B │ 6.096 B │ +├────────────────────────────────────────┼────────────┼────────────┼────────────┼────────────┤ +│ currentLongTermDebt │ 323 M │ 297 M │ 155 M │ 118 M │ +├────────────────────────────────────────┼────────────┼────────────┼────────────┼────────────┤ +│ longTermDebtNoncurrent │ None │ None │ None │ None │ +├────────────────────────────────────────┼────────────┼────────────┼────────────┼────────────┤ +│ shortLongTermDebtTotal │ 7.148 B │ 7.228 B │ 7.280 B │ 6.096 B │ +├────────────────────────────────────────┼────────────┼────────────┼────────────┼────────────┤ +│ otherCurrentLiabilities │ 560 M │ 738 M │ 944 M │ 924 M │ +├────────────────────────────────────────┼────────────┼────────────┼────────────┼────────────┤ +│ otherNonCurrentLiabilities │ 552 M │ 569 M │ 559 M │ 632 M │ +├────────────────────────────────────────┼────────────┼────────────┼────────────┼────────────┤ +│ totalShareholderEquity │ 40.663 B │ 42.259 B │ 43.933 B │ 45.908 B │ +├────────────────────────────────────────┼────────────┼────────────┼────────────┼────────────┤ +│ treasuryStock │ None │ None │ 4.695 B │ 4.954 B │ +├────────────────────────────────────────┼────────────┼────────────┼────────────┼────────────┤ +│ retainedEarnings │ 34.723 B │ 36.452 B │ 39.051 B │ 41.267 B │ +├────────────────────────────────────────┼────────────┼────────────┼────────────┼────────────┤ +│ commonStock │ 120 M │ 120 M │ 122 M │ 122 M │ +├────────────────────────────────────────┼────────────┼────────────┼────────────┼────────────┤ +│ commonStockSharesOutstanding │ 1.121 B │ 1.120 B │ 1.119 B │ 1.120 B │ +└────────────────────────────────────────┴────────────┴────────────┴────────────┴────────────┘ +``` +--- diff --git a/website/content/terminal/reference/stocks/fa/cal.md b/website/content/terminal/reference/stocks/fa/cal.md new file mode 100644 index 000000000000..45b170eff94d --- /dev/null +++ b/website/content/terminal/reference/stocks/fa/cal.md @@ -0,0 +1,31 @@ +--- +title: cal +description: This page provides a guide to using the 'cal' command for accessing company + earning calendars and revenue estimates using python. +keywords: +- Company Earnings +- Earnings Calendar +- Revenue Estimates +- Yahoo Finance +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Calendar earnings of the company. Including revenue and earnings estimates. [Source: Yahoo Finance] + +### Usage + +```python +cal +``` + +--- + +## Parameters + +This command has no parameters + + +--- diff --git a/website/content/terminal/reference/stocks/fa/cash.md b/website/content/terminal/reference/stocks/fa/cash.md new file mode 100644 index 000000000000..cc293cdd71bf --- /dev/null +++ b/website/content/terminal/reference/stocks/fa/cash.md @@ -0,0 +1,177 @@ +--- +title: cash +description: This documentation describes the 'cash' script which prints a complete + cash flow statement over time. It covers features including options for quarterly + or annual views, detailed financial factors such as accounts payable and net income, + and usage of the command-line interface. The data source is mentioned as Alpha Vantage. +keywords: +- cash flow statement +- quarterly cash flow +- annual cash flow +- accounts payable +- accounts receivable +- net income +- operating cash flow +- investing activities +- financing activities +- Alpha Vantage source +- Stock financial analysis +- Command-line interface usage +- Docusaurus page metadata +- Parameter choices for cash script +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Prints a complete cash flow statement over time. This can be either quarterly or annually. The following fields are expected: Accepted date, Accounts payables, Accounts receivables, Acquisitions net, Capital expenditure, Cash at beginning of period, Cash at end of period, Change in working capital, Common stock issued, Common stock repurchased, Debt repayment, Deferred income tax, Depreciation and amortization, Dividends paid, Effect of forex changes on cash, Filling date, Final link, Free cash flow, Inventory, Investments in property plant and equipment, Link, Net cash provided by operating activities, Net cash used for investing activities, Net cash used provided by financing activities, Net change in cash, Net income, Operating cash flow, Other financing activities, Other investing activities, Other non cash items, Other working capital, Period, Purchases of investments, Sales maturities of investments, Stock based compensation. [Source: Alpha Vantage] + +### Usage + +```python +cash [-l LIMIT] [-q] [-r] [-p column] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| limit | Number of latest years/quarters. | 5 | True | None | +| b_quarter | Quarter fundamental data flag. | False | True | None | +| ratios | Shows percentage change of values. | False | True | None | +| plot | Rows to plot. (-1 represents invalid data) | None | True | net_income, depreciation_&_amortisation, deferred_income_taxes, stock-based_compensation, change_in working_capital, accounts_receivable, inventory, accounts_payable, other_working_capital, other_non-cash_items, net_cash_provided_by_operating_activities, investments_in_property_plant_and_equipment, acquisitions_net, purchases_of_investments, sales/maturities_of_investments, other_investing_activities, net_cash_used_for_investing_activities, debt_repayment, common_stock_issued, common_stock_repurchased, dividends_paid, other_financing_activities, net_cash_used_provided_by_(used_for)_financing_activities, net_change_in_cash, cash_at_beginning_of_period, cash_at_end_of_period, operating_cash_flow, capital_expenditure, free_cash_flow | + + +--- + +## Examples + +```python +2022 Feb 16, 04:52 (🦋) /stocks/fa/ $ cash -l 4 + FB Balance Sheet +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━┳━━━━━━━━━━━━┳━━━━━━━━━━━━┳━━━━━━━━━━━━┓ +┃ ┃ 2018-12-31 ┃ 2019-12-31 ┃ 2020-12-31 ┃ 2021-12-31 ┃ +┡━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━╇━━━━━━━━━━━━╇━━━━━━━━━━━━╇━━━━━━━━━━━━┩ +│ reportedCurrency │ USD │ USD │ USD │ USD │ +├───────────────────────────────────────────────────────────┼────────────┼────────────┼────────────┼────────────┤ +│ operatingCashflow │ 29.274 B │ 36.314 B │ 38.747 B │ 57.683 B │ +├───────────────────────────────────────────────────────────┼────────────┼────────────┼────────────┼────────────┤ +│ paymentsForOperatingActivities │ 1 M │ 914 M │ 1.222 B │ 1.421 B │ +├───────────────────────────────────────────────────────────┼────────────┼────────────┼────────────┼────────────┤ +│ proceedsFromOperatingActivities │ None │ None │ None │ None │ +├───────────────────────────────────────────────────────────┼────────────┼────────────┼────────────┼────────────┤ +│ changeInOperatingLiabilities │ 1.057 B │ 9.123 B │ -1.312 B │ 5.909 B │ +├───────────────────────────────────────────────────────────┼────────────┼────────────┼────────────┼────────────┤ +│ changeInOperatingAssets │ 2.741 B │ 1.873 B │ 1.411 B │ 5.209 B │ +├───────────────────────────────────────────────────────────┼────────────┼────────────┼────────────┼────────────┤ +│ depreciationDepletionAndAmortization │ 4.315 B │ 5.741 B │ 6.862 B │ 7.967 B │ +├───────────────────────────────────────────────────────────┼────────────┼────────────┼────────────┼────────────┤ +│ capitalExpenditures │ 13.915 B │ 15.102 B │ 15.115 B │ 18.567 B │ +├───────────────────────────────────────────────────────────┼────────────┼────────────┼────────────┼────────────┤ +│ changeInReceivables │ 1.892 B │ 1.961 B │ 1.512 B │ 3.110 B │ +├───────────────────────────────────────────────────────────┼────────────┼────────────┼────────────┼────────────┤ +│ changeInInventory │ None │ None │ None │ None │ +├───────────────────────────────────────────────────────────┼────────────┼────────────┼────────────┼────────────┤ +│ profitLoss │ 22.112 B │ 18.485 B │ 29.146 B │ 39.370 B │ +├───────────────────────────────────────────────────────────┼────────────┼────────────┼────────────┼────────────┤ +│ cashflowFromInvestment │ -11.603 B │ -19.864 B │ -30.059 B │ -7.570 B │ +├───────────────────────────────────────────────────────────┼────────────┼────────────┼────────────┼────────────┤ +│ cashflowFromFinancing │ -15.572 B │ -7.299 B │ -10.292 B │ -50.728 B │ +├───────────────────────────────────────────────────────────┼────────────┼────────────┼────────────┼────────────┤ +│ proceedsFromRepaymentsOfShortTermDebt │ 500 M │ -223 M │ 24 M │ 14 M │ +├───────────────────────────────────────────────────────────┼────────────┼────────────┼────────────┼────────────┤ +│ paymentsForRepurchaseOfCommonStock │ 12.879 B │ 4.202 B │ 6.272 B │ 44.537 B │ +├───────────────────────────────────────────────────────────┼────────────┼────────────┼────────────┼────────────┤ +│ paymentsForRepurchaseOfEquity │ 12.879 B │ 4.202 B │ 6.272 B │ 44.537 B │ +├───────────────────────────────────────────────────────────┼────────────┼────────────┼────────────┼────────────┤ +│ paymentsForRepurchaseOfPreferredStock │ None │ None │ None │ None │ +├───────────────────────────────────────────────────────────┼────────────┼────────────┼────────────┼────────────┤ +│ dividendPayout │ None │ None │ None │ None │ +├───────────────────────────────────────────────────────────┼────────────┼────────────┼────────────┼────────────┤ +│ dividendPayoutCommonStock │ None │ None │ None │ None │ +├───────────────────────────────────────────────────────────┼────────────┼────────────┼────────────┼────────────┤ +│ dividendPayoutPreferredStock │ None │ None │ None │ None │ +├───────────────────────────────────────────────────────────┼────────────┼────────────┼────────────┼────────────┤ +│ proceedsFromIssuanceOfCommonStock │ None │ None │ None │ None │ +├───────────────────────────────────────────────────────────┼────────────┼────────────┼────────────┼────────────┤ +│ proceedsFromIssuanceOfLongTermDebtAndCapitalSecuritiesNet │ None │ None │ None │ None │ +├───────────────────────────────────────────────────────────┼────────────┼────────────┼────────────┼────────────┤ +│ proceedsFromIssuanceOfPreferredStock │ None │ None │ None │ None │ +├───────────────────────────────────────────────────────────┼────────────┼────────────┼────────────┼────────────┤ +│ proceedsFromRepurchaseOfEquity │ -12.879 B │ -4.202 B │ -6.272 B │ -44.537 B │ +├───────────────────────────────────────────────────────────┼────────────┼────────────┼────────────┼────────────┤ +│ proceedsFromSaleOfTreasuryStock │ None │ None │ None │ None │ +├───────────────────────────────────────────────────────────┼────────────┼────────────┼────────────┼────────────┤ +│ changeInCashAndCashEquivalents │ 2.099 B │ 9.151 B │ -1.604 B │ -615 M │ +├───────────────────────────────────────────────────────────┼────────────┼────────────┼────────────┼────────────┤ +│ changeInExchangeRate │ None │ None │ None │ None │ +├───────────────────────────────────────────────────────────┼────────────┼────────────┼────────────┼────────────┤ +│ netIncome │ 22.112 B │ 18.485 B │ 29.146 B │ 39.370 B │ +└───────────────────────────────────────────────────────────┴────────────┴────────────┴────────────┴────────────┘ + +2022 Feb 16, 04:52 (🦋) /stocks/fa/ $ cash -l 4 -q + FB Balance Sheet +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━┳━━━━━━━━━━━━┳━━━━━━━━━━━━┳━━━━━━━━━━━━┓ +┃ ┃ 2021-03-31 ┃ 2021-06-30 ┃ 2021-09-30 ┃ 2021-12-31 ┃ +┡━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━╇━━━━━━━━━━━━╇━━━━━━━━━━━━╇━━━━━━━━━━━━┩ +│ reportedCurrency │ USD │ USD │ USD │ USD │ +├───────────────────────────────────────────────────────────┼────────────┼────────────┼────────────┼────────────┤ +│ operatingCashflow │ 12.242 B │ 13.247 B │ 14.090 B │ 18.104 B │ +├───────────────────────────────────────────────────────────┼────────────┼────────────┼────────────┼────────────┤ +│ paymentsForOperatingActivities │ 333 M │ 6.650 B │ 1.987 B │ -7.549 B │ +├───────────────────────────────────────────────────────────┼────────────┼────────────┼────────────┼────────────┤ +│ proceedsFromOperatingActivities │ None │ None │ None │ None │ +├───────────────────────────────────────────────────────────┼────────────┼────────────┼────────────┼────────────┤ +│ changeInOperatingLiabilities │ -1.787 B │ 1.513 B │ 2.180 B │ 4.003 B │ +├───────────────────────────────────────────────────────────┼────────────┼────────────┼────────────┼────────────┤ +│ changeInOperatingAssets │ -378 M │ 3.403 B │ 797 M │ 1.387 B │ +├───────────────────────────────────────────────────────────┼────────────┼────────────┼────────────┼────────────┤ +│ depreciationDepletionAndAmortization │ 1.972 B │ 1.986 B │ 1.995 B │ 2.014 B │ +├───────────────────────────────────────────────────────────┼────────────┼────────────┼────────────┼────────────┤ +│ capitalExpenditures │ 4.272 B │ 4.612 B │ 4.314 B │ 5.369 B │ +├───────────────────────────────────────────────────────────┼────────────┼────────────┼────────────┼────────────┤ +│ changeInReceivables │ -849 M │ 1.366 B │ 555 M │ 2.038 B │ +├───────────────────────────────────────────────────────────┼────────────┼────────────┼────────────┼────────────┤ +│ changeInInventory │ None │ None │ None │ None │ +├───────────────────────────────────────────────────────────┼────────────┼────────────┼────────────┼────────────┤ +│ profitLoss │ 9.497 B │ 10.394 B │ 9.194 B │ 10.285 B │ +├───────────────────────────────────────────────────────────┼────────────┼────────────┼────────────┼────────────┤ +│ cashflowFromInvestment │ -4.874 B │ -8.195 B │ -330 M │ 5.829 B │ +├───────────────────────────────────────────────────────────┼────────────┼────────────┼────────────┼────────────┤ +│ cashflowFromFinancing │ -5.185 B │ -8.549 B │ -15.252 B │ -21.742 B │ +├───────────────────────────────────────────────────────────┼────────────┼────────────┼────────────┼────────────┤ +│ proceedsFromRepaymentsOfShortTermDebt │ -50 M │ 53 M │ 12 M │ -1 M │ +├───────────────────────────────────────────────────────────┼────────────┼────────────┼────────────┼────────────┤ +│ paymentsForRepurchaseOfCommonStock │ 3.939 B │ 7.079 B │ 13.458 B │ 20.061 B │ +├───────────────────────────────────────────────────────────┼────────────┼────────────┼────────────┼────────────┤ +│ paymentsForRepurchaseOfEquity │ 3.939 B │ 7.079 B │ 13.458 B │ 20.061 B │ +├───────────────────────────────────────────────────────────┼────────────┼────────────┼────────────┼────────────┤ +│ paymentsForRepurchaseOfPreferredStock │ None │ None │ None │ None │ +├───────────────────────────────────────────────────────────┼────────────┼────────────┼────────────┼────────────┤ +│ dividendPayout │ None │ None │ None │ None │ +├───────────────────────────────────────────────────────────┼────────────┼────────────┼────────────┼────────────┤ +│ dividendPayoutCommonStock │ None │ None │ None │ None │ +├───────────────────────────────────────────────────────────┼────────────┼────────────┼────────────┼────────────┤ +│ dividendPayoutPreferredStock │ None │ None │ None │ None │ +├───────────────────────────────────────────────────────────┼────────────┼────────────┼────────────┼────────────┤ +│ proceedsFromIssuanceOfCommonStock │ 0 │ 0 │ 0 │ None │ +├───────────────────────────────────────────────────────────┼────────────┼────────────┼────────────┼────────────┤ +│ proceedsFromIssuanceOfLongTermDebtAndCapitalSecuritiesNet │ None │ None │ None │ None │ +├───────────────────────────────────────────────────────────┼────────────┼────────────┼────────────┼────────────┤ +│ proceedsFromIssuanceOfPreferredStock │ None │ None │ None │ None │ +├───────────────────────────────────────────────────────────┼────────────┼────────────┼────────────┼────────────┤ +│ proceedsFromRepurchaseOfEquity │ -3.939 B │ -7.079 B │ -13.458 B │ -20.061 B │ +├───────────────────────────────────────────────────────────┼────────────┼────────────┼────────────┼────────────┤ +│ proceedsFromSaleOfTreasuryStock │ None │ None │ None │ None │ +├───────────────────────────────────────────────────────────┼────────────┼────────────┼────────────┼────────────┤ +│ changeInCashAndCashEquivalents │ 2.183 B │ 12.254 B │ 11.064 B │ 2.191 B │ +├───────────────────────────────────────────────────────────┼────────────┼────────────┼────────────┼────────────┤ +│ changeInExchangeRate │ None │ None │ None │ None │ +├───────────────────────────────────────────────────────────┼────────────┼────────────┼────────────┼────────────┤ +│ netIncome │ 9.497 B │ 10.394 B │ 9.194 B │ 10.285 B │ +└───────────────────────────────────────────────────────────┴────────────┴────────────┴────────────┴────────────┘ +``` +--- diff --git a/website/content/terminal/reference/stocks/fa/data.md b/website/content/terminal/reference/stocks/fa/data.md new file mode 100644 index 000000000000..79e3e94c4675 --- /dev/null +++ b/website/content/terminal/reference/stocks/fa/data.md @@ -0,0 +1,40 @@ +--- +title: data +description: This documentation page provides information on data metrics related + to the company. It includes various financial and non-financial fields such as Company, + Sector, Industry, Index, Sales, Profit Margin, and many more. +keywords: +- Company Metrics +- Data Metrics +- Financial Data +- Industry +- Sector +- Index +- Sales +- Profit Margin +- Performance Metrics +- EPS +- Market Cap +- P/E ratio +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Print several metrics about the company. The following fields are expected: Company, Sector, Industry, Country, Index, P/E, EPS (ttm), Insider Own, Shs Outstand, Perf Week, Market Cap, Forward P/E, EPS next Y, Insider Trans, Shs Float, Perf Month, Income, EPS next Q, Inst Own, Short Float, Perf Quarter, Sales, P/S, EPS this Y, Inst Trans, Short Ratio, Perf Half Y, Book/sh, P/B, ROA, Target Price, Perf Year, Cash/sh, P/C, ROE, 52W Range, Perf YTD, P/FCF, EPS past 5Y, ROI, 52W High, Beta, Quick Ratio, Sales past 5Y, Gross Margin, 52W Low, ATR, Employees, Current Ratio, Sales Q/Q, Operating Margin, RSI (14), Volatility, Optionable, Debt/Eq, EPS Q/Q, Profit Margin, Rel Volume, Prev Close, Shortable, LT Debt/Eq, Earnings, Payout, Avg Volume, Price, Recommendation, SMA20, SMA50, SMA200, Volume, Change. [Source: Finviz] + +### Usage + +```python +data +``` + +--- + +## Parameters + +This command has no parameters + + +--- diff --git a/website/content/terminal/reference/stocks/fa/dcf.md b/website/content/terminal/reference/stocks/fa/dcf.md new file mode 100644 index 000000000000..f712804d44f5 --- /dev/null +++ b/website/content/terminal/reference/stocks/fa/dcf.md @@ -0,0 +1,54 @@ +--- +title: dcf +description: Discover the dcf command, a powerful and flexible tool that allows users + to predict and analyze the value of a company based on future cash flows and the + present value. This tool allows for customizable parameters, includes linear regression + estimates, discount factors, and multiple prediction models. +keywords: +- dcf +- discounted cash flow +- financial statements prediction +- linear regression +- Fama French +- CAPM +- cash flow analysis +- present value +- company value +- stock analysis +- financial tool +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +A discounted cash flow statement looks to analyze the value of a company. To do this we need to predict the future cash flows and then determine how much those cash flows are worth to us today. We predict the future expected cash flows by predicting what the financial statements will look like in the future, and then using this to determine the cash the company will have in the future. This cash is paid to share holders. We use linear regression to predict the future financial statements. Once we have our predicted financial statements we need to determine how much the cash flows are worth today. This is done with a discount factor. Our DCF allows users to choose between Fama French and CAPM for the factor. This allows us to calculate the present value of the future cash flows. The present value of all of these cash payments is the companies' value. Dividing this value by the number of shares outstanding allows us to calculate the value of each share in a company. + +### Usage + +```python +dcf [-a] [--no-ratios] [--no-filter] [-p PREDICTION] [-s SIMILAR] [-g] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| audit | Generates a tie-out for financial statement information pulled from online. | False | True | None | +| ratios | Removes ratios from DCF. | True | True | None | +| ratios | Allow similar companies of any market cap to be shown. | False | True | None | +| prediction | Number of years to predict before using terminal value. | 10 | True | None | +| similar | Number of similar companies to generate ratios for. | 6 | True | None | +| growth | Whether to replace a linear regression estimate with a growth estimate. | False | True | None | + +![dcf financials](https://user-images.githubusercontent.com/46355364/154241001-42be82e5-f001-4fd1-bcf4-cd55c7cef358.png) + +![dcf free cash flows](https://user-images.githubusercontent.com/46355364/154241130-f52c580e-710d-4cac-a8f3-f9bfece7865a.png) + +![dcf explanations](https://user-images.githubusercontent.com/46355364/154241408-5476f0ea-4789-4691-a063-6b43c382fce6.png) + +![dcf ratios](https://user-images.githubusercontent.com/46355364/154241575-f931c05a-c765-4abd-9cc1-0a0795aeaec3.png) + +--- diff --git a/website/content/terminal/reference/stocks/fa/dcfc.md b/website/content/terminal/reference/stocks/fa/dcfc.md new file mode 100644 index 000000000000..7856c7fc7fc1 --- /dev/null +++ b/website/content/terminal/reference/stocks/fa/dcfc.md @@ -0,0 +1,38 @@ +--- +title: dcfc +description: This page provides instructions on how to use the 'dcfc' function to + extract a company's discounted cash flow (DCF), stock price, and date information. + It further provides details on usage and parameters. +keywords: +- dcfc +- discounted cash flow +- stock price +- financial data extraction +- financial modeling +- DCF +- quarters +- fundamental data +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Prints the discounted cash flow of a company over time including the DCF of today. The following fields are expected: DCF, Stock price, and Date. [Source: Financial Modeling Prep] + +### Usage + +```python +dcfc [-l LIMIT] [-q] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| limit | Limit of latest years/quarters. | 5 | True | None | +| b_quarter | Quarter fundamental data flag. | False | True | None | + +--- diff --git a/website/content/terminal/reference/stocks/fa/divs.md b/website/content/terminal/reference/stocks/fa/divs.md new file mode 100644 index 000000000000..a7269bf7e785 --- /dev/null +++ b/website/content/terminal/reference/stocks/fa/divs.md @@ -0,0 +1,34 @@ +--- +title: divs +description: This documentation page provides explanation about the usage, and parameters + of the 'divs' function in showing historical dividends of a company. +keywords: +- divs function +- historical dividends +- dividend plotting +- function parameters +- dividend history +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Historical dividends for a company + +### Usage + +```python +divs [-l LIMIT] [-p] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| limit | Number of previous dividends to show | 16 | True | None | +| plot | Plots changes in dividend over time | False | True | None | + +--- diff --git a/website/content/terminal/reference/stocks/fa/dupont.md b/website/content/terminal/reference/stocks/fa/dupont.md new file mode 100644 index 000000000000..af35ec1b9972 --- /dev/null +++ b/website/content/terminal/reference/stocks/fa/dupont.md @@ -0,0 +1,32 @@ +--- +title: dupont +description: This page provides information about the Dupont tool, which deconstructs + return on equity to help investors understand it better. This tool can toggle between + presenting raw data and processed data. +keywords: +- dupont +- return on equity +- raw data +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +The extended dupont deconstructs return on equity to allow investors to understand it better + +### Usage + +```python +dupont [--raw] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| raw | Print raw data. | False | True | None | + +--- diff --git a/website/content/terminal/reference/stocks/fa/earnings.md b/website/content/terminal/reference/stocks/fa/earnings.md new file mode 100644 index 000000000000..2521822afa05 --- /dev/null +++ b/website/content/terminal/reference/stocks/fa/earnings.md @@ -0,0 +1,103 @@ +--- +title: earnings +description: This page provides documentation for the 'earnings' function. This tool + prints earnings dates and reported EPS of a company, enabling users to efficiently + track this financial data in a clear format. +keywords: +- docusaurus +- metadata +- earnings +- financial data +- EPS +- parameter +- example +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Print earnings dates and reported EPS of the company. The following fields are expected: Fiscal Date Ending and Reported EPS. [Source: Alpha Vantage] + +### Usage + +```python +earnings [-q] [-l LIMIT] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| b_quarter | Quarter fundamental data flag. | False | True | None | +| limit | Number of latest info | 5 | True | None | + + +--- + +## Examples + +```python +2022 Feb 16, 05:14 (🦋) /stocks/fa/ $ earnings -l 12 + MSFT Earnings +┏━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━┓ +┃ Fiscal Date Ending ┃ Reported EPS ┃ +┡━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━┩ +│ 2021-12-31 │ 4.75 │ +├────────────────────┼──────────────┤ +│ 2021-06-30 │ 7.97 │ +├────────────────────┼──────────────┤ +│ 2020-06-30 │ 5.75 │ +├────────────────────┼──────────────┤ +│ 2019-06-30 │ 4.75 │ +├────────────────────┼──────────────┤ +│ 2018-06-30 │ 3.88 │ +├────────────────────┼──────────────┤ +│ 2017-06-30 │ 3.31 │ +├────────────────────┼──────────────┤ +│ 2016-06-30 │ 2.76 │ +├────────────────────┼──────────────┤ +│ 2015-06-30 │ 2.46 │ +├────────────────────┼──────────────┤ +│ 2014-06-30 │ 2.63 │ +├────────────────────┼──────────────┤ +│ 2013-06-30 │ 2.67 │ +├────────────────────┼──────────────┤ +│ 2012-06-30 │ 2.73 │ +├────────────────────┼──────────────┤ +│ 2011-06-30 │ 2.69 │ +└────────────────────┴──────────────┘ + +2022 Feb 16, 05:15 (🦋) /stocks/fa/ $ earnings -l 12 -q + MSFT Earnings +┏━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━┳━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━┓ +┃ Fiscal Date Ending ┃ Reported Date ┃ Reported EPS ┃ Estimated EPS ┃ Surprise ┃ Surprise Percentage ┃ +┡━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━╇━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━┩ +│ 2021-12-31 │ 2022-01-25 │ 2.48 │ 2.31 │ 0.17 │ 7.3593 │ +├────────────────────┼───────────────┼──────────────┼───────────────┼──────────┼─────────────────────┤ +│ 2021-09-30 │ 2021-10-26 │ 2.27 │ 2.081 │ 0.189 │ 9.0822 │ +├────────────────────┼───────────────┼──────────────┼───────────────┼──────────┼─────────────────────┤ +│ 2021-06-30 │ 2021-07-27 │ 2.17 │ 1.9252 │ 0.2448 │ 12.7156 │ +├────────────────────┼───────────────┼──────────────┼───────────────┼──────────┼─────────────────────┤ +│ 2021-03-31 │ 2021-04-27 │ 1.95 │ 1.7781 │ 0.1719 │ 9.6676 │ +├────────────────────┼───────────────┼──────────────┼───────────────┼──────────┼─────────────────────┤ +│ 2020-12-31 │ 2021-01-26 │ 2.03 │ 1.6373 │ 0.3927 │ 23.9846 │ +├────────────────────┼───────────────┼──────────────┼───────────────┼──────────┼─────────────────────┤ +│ 2020-09-30 │ 2020-10-27 │ 1.82 │ 1.546 │ 0.274 │ 17.7232 │ +├────────────────────┼───────────────┼──────────────┼───────────────┼──────────┼─────────────────────┤ +│ 2020-06-30 │ 2020-07-22 │ 1.46 │ 1.372 │ 0.088 │ 6.414 │ +├────────────────────┼───────────────┼──────────────┼───────────────┼──────────┼─────────────────────┤ +│ 2020-03-31 │ 2020-04-29 │ 1.4 │ 1.2688 │ 0.1312 │ 10.3405 │ +├────────────────────┼───────────────┼──────────────┼───────────────┼──────────┼─────────────────────┤ +│ 2019-12-31 │ 2020-01-29 │ 1.51 │ 1.325 │ 0.185 │ 13.9623 │ +├────────────────────┼───────────────┼──────────────┼───────────────┼──────────┼─────────────────────┤ +│ 2019-09-30 │ 2019-10-23 │ 1.38 │ 1.2435 │ 0.1365 │ 10.9771 │ +├────────────────────┼───────────────┼──────────────┼───────────────┼──────────┼─────────────────────┤ +│ 2019-06-30 │ 2019-07-18 │ 1.37 │ 1.2137 │ 0.1563 │ 12.878 │ +├────────────────────┼───────────────┼──────────────┼───────────────┼──────────┼─────────────────────┤ +│ 2019-03-31 │ 2019-04-24 │ 1.14 │ 0.9985 │ 0.1415 │ 14.1713 │ +└────────────────────┴───────────────┴──────────────┴───────────────┴──────────┴─────────────────────┘ +``` +--- diff --git a/website/content/terminal/reference/stocks/fa/enterprise.md b/website/content/terminal/reference/stocks/fa/enterprise.md new file mode 100644 index 000000000000..818daf46965f --- /dev/null +++ b/website/content/terminal/reference/stocks/fa/enterprise.md @@ -0,0 +1,66 @@ +--- +title: enterprise +description: The enterprise page provides insights into stock price, market capitalization, + enterprise value, total debt, and other financial indicators over time. This information + is crucial for investment decisions and financial modeling. +keywords: +- enterprise +- stock price +- market capitalization +- enterprise value +- total debt +- cash and cash equivalents +- number of shares +- symbol +- financial modeling +- stocks +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Prints stock price, number of shares, market capitalization and enterprise value over time. The following fields are expected: Add total debt, Enterprise value, Market capitalization, Minus cash and cash equivalents, Number of shares, Stock price, and Symbol. [Source: Financial Modeling Prep] + +### Usage + +```python +enterprise [-l LIMIT] [-q] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| limit | Limit of latest years/quarters. | 5 | True | None | +| b_quarter | Quarter fundamental data flag. | False | True | None | + + +--- + +## Examples + +```python +2022 Feb 16, 05:26 (🦋) /stocks/fa/ $ enterprise -l 10 + GOOGL Enterprise +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━┳━━━━━━━━━━━┳━━━━━━━━━━━┳━━━━━━━━━━━┳━━━━━━━━━━━┳━━━━━━━━━━━┳━━━━━━━━━━━┳━━━━━━━━━━━┳━━━━━━━━━━━┳━━━━━━━━━━━┓ +┃ ┃ 2012 ┃ 2013 ┃ 2014 ┃ 2015 ┃ 2016 ┃ 2017 ┃ 2018 ┃ 2019 ┃ 2020 ┃ 2021 ┃ +┡━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━╇━━━━━━━━━━━╇━━━━━━━━━━━╇━━━━━━━━━━━╇━━━━━━━━━━━╇━━━━━━━━━━━╇━━━━━━━━━━━╇━━━━━━━━━━━╇━━━━━━━━━━━╇━━━━━━━━━━━┩ +│ Symbol │ GOOGL │ GOOGL │ GOOGL │ GOOGL │ GOOGL │ GOOGL │ GOOGL │ GOOGL │ GOOGL │ GOOGL │ +├─────────────────────────────────┼───────────┼───────────┼───────────┼───────────┼───────────┼───────────┼───────────┼───────────┼───────────┼───────────┤ +│ Stock price │ 377.292 │ 568.263 │ 537.550 │ 761.350 │ 823.830 │ 1.177 K │ 1.098 K │ 1.454 K │ 1.827 K │ 2.667 K │ +├─────────────────────────────────┼───────────┼───────────┼───────────┼───────────┼───────────┼───────────┼───────────┼───────────┼───────────┼───────────┤ +│ Number of shares │ 665 M │ 737 M │ 687 M │ 692.930 M │ 698.706 M │ 703.584 M │ 703.285 M │ 698.556 M │ 665.758 M │ 667.650 M │ +├─────────────────────────────────┼───────────┼───────────┼───────────┼───────────┼───────────┼───────────┼───────────┼───────────┼───────────┼───────────┤ +│ Market capitalization │ 250.899 B │ 418.810 B │ 369.297 B │ 527.562 B │ 575.615 B │ 828.379 B │ 772.200 B │ 1.016 T │ 1.217 T │ 1.781 T │ +├─────────────────────────────────┼───────────┼───────────┼───────────┼───────────┼───────────┼───────────┼───────────┼───────────┼───────────┼───────────┤ +│ Minus cash and cash equivalents │ 14.778 B │ 18.898 B │ 18.347 B │ 16.549 B │ 12.918 B │ 10.715 B │ 16.701 B │ 18.498 B │ 26.465 B │ 20.945 B │ +├─────────────────────────────────┼───────────┼───────────┼───────────┼───────────┼───────────┼───────────┼───────────┼───────────┼───────────┼───────────┤ +│ Add total debt │ 5.537 B │ 5.245 B │ 5.237 B │ 5.220 B │ 3.935 B │ 3.969 B │ 4.012 B │ 5.753 B │ 26.772 B │ 28.395 B │ +├─────────────────────────────────┼───────────┼───────────┼───────────┼───────────┼───────────┼───────────┼───────────┼───────────┼───────────┼───────────┤ +│ Enterprise value │ 241.658 B │ 405.157 B │ 356.187 B │ 516.233 B │ 566.632 B │ 821.633 B │ 759.511 B │ 1.003 T │ 1.217 T │ 1.788 T │ +└─────────────────────────────────┴───────────┴───────────┴───────────┴───────────┴───────────┴───────────┴───────────┴───────────┴───────────┴───────────┘ +``` +--- diff --git a/website/content/terminal/reference/stocks/fa/fraud.md b/website/content/terminal/reference/stocks/fa/fraud.md new file mode 100644 index 000000000000..ebdd8040f9b5 --- /dev/null +++ b/website/content/terminal/reference/stocks/fa/fraud.md @@ -0,0 +1,44 @@ +--- +title: fraud +description: An in-depth look at various statistical models for detecting fraud in + a company's reported earnings. Includes discussions on the Beneish model, Zmijewski + Score, and McKee Score; and use of different indices like Days Sales in Receivables + Index, Gross Margin Index, Asset Quality Index, and more. +keywords: +- Beneish model +- Zmijewski Score +- McKee Score +- Days Sales in Receivables Index +- Gross Margin Index +- Asset Quality Index +- Sales Growth Index +- Depreciation Index +- Sales General and Administrative Expenses Index +- Leverage Index +- Total Accruals to Total Assets +- Fraud detection +- Earnings manipulation +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +M-score: ------------------------------------------------ The Beneish model is a statistical model that uses financial ratios calculated with accounting data of a specific company in order to check if it is likely (high probability) that the reported earnings of the company have been manipulated. A score of -5 to -2.22 indicated a low chance of fraud, a score of -2.22 to -1.78 indicates a moderate change of fraud, and a score above -1.78 indicated a high chance of fraud.[Source: Wikipedia] DSRI: Days Sales in Receivables Index gauges whether receivables and revenue are out of balance, a large number is expected to be associated with a higher likelihood that revenues and earnings are overstated. GMI: Gross Margin Index shows if gross margins are deteriorating. Research suggests that firms with worsening gross margin are more likely to engage in earnings management, therefore there should be a positive correlation between GMI and probability of earnings management. AQI: Asset Quality Index measures the proportion of assets where potential benefit is less certain. A positive relation between AQI and earnings manipulation is expected. SGI: Sales Growth Index shows the amount of growth companies are having. Higher growth companies are more likely to commit fraud so there should be a positive relation between SGI and earnings management. DEPI: Depreciation Index is the ratio for the rate of depreciation. A DEPI greater than 1 shows that the depreciation rate has slowed and is positively correlated with earnings management. SGAI: Sales General and Administrative Expenses Index measures the change in SG&A over sales. There should be a positive relationship between SGAI and earnings management. LVGI: Leverage Index represents change in leverage. A LVGI greater than one indicates a lower change of fraud. TATA: Total Accruals to Total Assets is a proxy for the extent that cash underlies earnings. A higher number is associated with a higher likelihood of manipulation. Z-score: ------------------------------------------------ The Zmijewski Score is a bankruptcy model used to predict a firm's bankruptcy in two years. The ratio uses in the Zmijewski score were determined by probit analysis (think of probit as probability unit). In this case, scores less than .5 represent a higher probability of default. One of the criticisms that Zmijewski made was that other bankruptcy scoring models oversampled distressed firms and favored situations with more complete data.[Source: YCharts] McKee-score: ------------------------------------------------ The McKee Score is a bankruptcy model used to predict a firm's bankruptcy in one yearIt looks at a company's size, profitability, and liquidity to determine the probability.This model is 80% accurate in predicting bankruptcy. + +### Usage + +```python +fraud [-e] [-d] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| exp | Shows an explanation for the metrics | False | True | None | +| detail | Shows the details for calculating the mscore | False | True | None | + +--- diff --git a/website/content/terminal/reference/stocks/fa/growth.md b/website/content/terminal/reference/stocks/fa/growth.md new file mode 100644 index 000000000000..568526ed0673 --- /dev/null +++ b/website/content/terminal/reference/stocks/fa/growth.md @@ -0,0 +1,49 @@ +--- +title: growth +description: This documentation page discusses the various parameters and functionalities + of a financial growth model. It covers the growth of statement items and financial + ratios, including revenue, operating cash flow, assets, debt, EBIT, EPS, gross profit, + inventory, net income, operating income, and more. It provides usage examples and + parameter descriptions using Financial Modeling Prep as the data source. +keywords: +- financial growth +- statement items growth +- financial ratios +- Revenue Growth +- inventory growth +- operating cash flow growth +- Asset growth +- Debt growth +- Ebit growth +- Eps growth +- Free cash flow growth +- Gross profit growth +- Inventory growth +- Net income growth +- Operating income growth +- Revenue growth +- Financial Modeling Prep +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Prints the growth of several financial statement items and ratios over time. This can be either annually and quarterly. These are, among other things, Revenue Growth (3, 5 and 10 years), inventory growth and operating cash flow growth (3, 5 and 10 years). The following fields are expected: Asset growth, Book valueper share growth, Debt growth, Dividendsper share growth, Ebit growth, Eps diluted growth, Eps growth, Five y dividendper share growth per share, Five y net income growth per share, Five y operating c f growth per share, Five y revenue growth per share, Five y shareholders equity growth per share, Free cash flow growth, Gross profit growth, Inventory growth, Net income growth, Operating cash flow growth, Operating income growth, Rd expense growth, Receivables growth, Revenue growth, Sga expenses growth, Ten y dividendper share growth per share, Ten y net income growth per share, Ten y operating c f growth per share, Ten y revenue growth per share, Ten y shareholders equity growth per share, Three y dividendper share growth per share, Three y net income growth per share, Three y operating c f growth per share, Three y revenue growth per share, Three y shareholders equity growth per share, Weighted average shares diluted growth, and Weighted average shares growth [Source: Financial Modeling Prep] + +### Usage + +```python +growth [-l LIMIT] [-q] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| limit | Limit of latest years/quarters. | 5 | True | None | +| b_quarter | Quarter fundamental data flag. | False | True | None | + +--- diff --git a/website/content/terminal/reference/stocks/fa/hq.md b/website/content/terminal/reference/stocks/fa/hq.md new file mode 100644 index 000000000000..c12c648eab1b --- /dev/null +++ b/website/content/terminal/reference/stocks/fa/hq.md @@ -0,0 +1,34 @@ +--- +title: hq +description: The hq tool opens the company's headquarters location in Google Maps. + Sourced from Yahoo Finance, this command requires no parameters for usage. +keywords: +- hq +- Google Maps +- Yahoo Finance +- company location +- no parameters +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Opens in Google Maps HQ location of the company. [Source: Yahoo Finance] + +### Usage + +```python +hq +``` + +--- + +## Parameters + +This command has no parameters + + +![hq](https://user-images.githubusercontent.com/46355364/154249368-191f7d75-4c2a-46e1-bb83-561cd75bbecb.png) + +--- diff --git a/website/content/terminal/reference/stocks/fa/income.md b/website/content/terminal/reference/stocks/fa/income.md new file mode 100644 index 000000000000..bcba31302c0a --- /dev/null +++ b/website/content/terminal/reference/stocks/fa/income.md @@ -0,0 +1,109 @@ +--- +title: income +description: This page provides in-depth information on how to generate a comprehensive + income statement over a specific period, either quarterly or annually. It covers + critical financial terms such as gross profit, operating expenses, income before + tax, net income, and EPS among others. These metrics can be derived using Alpha + Vantage data source for accurate financial analysis. +keywords: +- income statement +- financial data +- quarterly reports +- annual reports +- financial metrics +- Alpha Vantage +- financial software +- financial terms +- gross profit +- net income +- operating expenses +- income before tax +- ebitda +- eps +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Prints a complete income statement over time. This can be either quarterly or annually. The following fields are expected: Accepted date, Cost and expenses, Cost of revenue, Depreciation and amortization, Ebitda, Ebitda Ratio, Eps, EPS Diluted, Filling date, Final link, General and administrative expenses, Gross profit, Gross profit ratio, Income before tax, Income before tax ratio, Income tax expense, Interest expense, Link, Net income, Net income ratio, Operating expenses, Operating income, Operating income ratio, Other expenses, Period, Research and development expenses, Revenue, Selling and marketing expenses, Total other income expenses net, Weighted average shs out, Weighted average shs out dil [Source: Alpha Vantage] + +### Usage + +```python +income [-q] [-r] [-p column] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| b_quarter | Quarter fundamental data flag. | False | True | None | +| ratios | Shows percentage change of values. | False | True | None | +| plot | Rows to plot, comma separated. (-1 represents invalid data) | None | True | total_revenue, cost_of_revenue, gross_profit, research_development, selling_general_and_administrative, total_operating_expenses, operating_income_or_loss, interest_expense, total_other_income/expenses_net, income_before_tax, income_tax_expense, income_from_continuing_operations, net_income, net_income_available_to_common_shareholders, basic_eps, diluted_eps, basic_average_shares, diluted_average_shares, ebitda | + + +--- + +## Examples + +```python +2022 Feb 16, 06:23 (🦋) /stocks/fa/ $ income -l 5 + MSFT Income Statement +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━┳━━━━━━━━━━━━┳━━━━━━━━━━━━┳━━━━━━━━━━━━┳━━━━━━━━━━━━┓ +┃ ┃ 2017-06-30 ┃ 2018-06-30 ┃ 2019-06-30 ┃ 2020-06-30 ┃ 2021-06-30 ┃ +┡━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━╇━━━━━━━━━━━━╇━━━━━━━━━━━━╇━━━━━━━━━━━━╇━━━━━━━━━━━━┩ +│ reportedCurrency │ USD │ USD │ USD │ USD │ USD │ +├───────────────────────────────────┼────────────┼────────────┼────────────┼────────────┼────────────┤ +│ grossProfit │ 62.310 B │ 72.007 B │ 82.933 B │ 96.937 B │ 115.856 B │ +├───────────────────────────────────┼────────────┼────────────┼────────────┼────────────┼────────────┤ +│ totalRevenue │ 96.571 B │ 107.222 B │ 123.495 B │ 140.503 B │ 165.936 B │ +├───────────────────────────────────┼────────────┼────────────┼────────────┼────────────┼────────────┤ +│ costOfRevenue │ 34.261 B │ 62.776 B │ 67.908 B │ 73.159 B │ 79.977 B │ +├───────────────────────────────────┼────────────┼────────────┼────────────┼────────────┼────────────┤ +│ costofGoodsAndServicesSold │ 34.261 B │ 38.353 B │ 42.910 B │ 46.078 B │ 52.232 B │ +├───────────────────────────────────┼────────────┼────────────┼────────────┼────────────┼────────────┤ +│ operatingIncome │ 29.025 B │ 35.058 B │ 42.959 B │ 52.959 B │ 69.916 B │ +├───────────────────────────────────┼────────────┼────────────┼────────────┼────────────┼────────────┤ +│ sellingGeneralAndAdministrative │ 20.020 B │ 22.223 B │ 23.098 B │ 24.709 B │ 25.224 B │ +├───────────────────────────────────┼────────────┼────────────┼────────────┼────────────┼────────────┤ +│ researchAndDevelopment │ 13.037 B │ 14.726 B │ 16.876 B │ 19.269 B │ 20.716 B │ +├───────────────────────────────────┼────────────┼────────────┼────────────┼────────────┼────────────┤ +│ operatingExpenses │ 35.063 B │ 39.149 B │ 41.874 B │ 46.350 B │ 48.461 B │ +├───────────────────────────────────┼────────────┼────────────┼────────────┼────────────┼────────────┤ +│ investmentIncomeNet │ 1.387 B │ 2.214 B │ 2.762 B │ 2.680 B │ 2.131 B │ +├───────────────────────────────────┼────────────┼────────────┼────────────┼────────────┼────────────┤ +│ netInterestIncome │ -2.222 B │ -2.733 B │ -2.686 B │ -2.591 B │ -2.346 B │ +├───────────────────────────────────┼────────────┼────────────┼────────────┼────────────┼────────────┤ +│ interestIncome │ 1.182 B │ 1.522 B │ 812 M │ 2.680 B │ 2.131 B │ +├───────────────────────────────────┼────────────┼────────────┼────────────┼────────────┼────────────┤ +│ interestExpense │ 2.222 B │ 2.733 B │ 2.686 B │ 2.591 B │ 2.346 B │ +├───────────────────────────────────┼────────────┼────────────┼────────────┼────────────┼────────────┤ +│ nonInterestIncome │ -674 M │ 109.955 B │ 126.181 B │ 143.094 B │ 168.282 B │ +├───────────────────────────────────┼────────────┼────────────┼────────────┼────────────┼────────────┤ +│ otherNonOperatingIncome │ -251 M │ -59 M │ -57 M │ -40 M │ 98 M │ +├───────────────────────────────────┼────────────┼────────────┼────────────┼────────────┼────────────┤ +│ depreciation │ 6.100 B │ 7.700 B │ 9.700 B │ 10.700 B │ 9.300 B │ +├───────────────────────────────────┼────────────┼────────────┼────────────┼────────────┼────────────┤ +│ depreciationAndAmortization │ 1.700 B │ 2.200 B │ 1.900 B │ 2.211 B │ 2.521 B │ +├───────────────────────────────────┼────────────┼────────────┼────────────┼────────────┼────────────┤ +│ incomeBeforeTax │ 29.901 B │ 36.474 B │ 43.688 B │ 53.036 B │ 71.102 B │ +├───────────────────────────────────┼────────────┼────────────┼────────────┼────────────┼────────────┤ +│ incomeTaxExpense │ 4.412 B │ 19.903 B │ 4.448 B │ 8.755 B │ 9.831 B │ +├───────────────────────────────────┼────────────┼────────────┼────────────┼────────────┼────────────┤ +│ interestAndDebtExpense │ 2.222 B │ 2.733 B │ 2.686 B │ 2.591 B │ 2.346 B │ +├───────────────────────────────────┼────────────┼────────────┼────────────┼────────────┼────────────┤ +│ netIncomeFromContinuingOperations │ 21.204 B │ 16.571 B │ 39.240 B │ 44.281 B │ 61.271 B │ +├───────────────────────────────────┼────────────┼────────────┼────────────┼────────────┼────────────┤ +│ comprehensiveIncomeNetOfTax │ 24.322 B │ 13.715 B │ 41.154 B │ 47.807 B │ 59.897 B │ +├───────────────────────────────────┼────────────┼────────────┼────────────┼────────────┼────────────┤ +│ ebit │ 32.123 B │ 39.207 B │ 46.374 B │ 55.627 B │ 73.448 B │ +├───────────────────────────────────┼────────────┼────────────┼────────────┼────────────┼────────────┤ +│ ebitda │ 33.823 B │ 41.407 B │ 48.274 B │ 57.838 B │ 75.969 B │ +├───────────────────────────────────┼────────────┼────────────┼────────────┼────────────┼────────────┤ +│ netIncome │ 25.489 B │ 16.571 B │ 39.240 B │ 44.281 B │ 61.271 B │ +└───────────────────────────────────┴────────────┴────────────┴────────────┴────────────┴────────────┘ +``` +--- diff --git a/website/content/terminal/reference/stocks/fa/info.md b/website/content/terminal/reference/stocks/fa/info.md new file mode 100644 index 000000000000..a1011f62086d --- /dev/null +++ b/website/content/terminal/reference/stocks/fa/info.md @@ -0,0 +1,282 @@ +--- +title: info +description: A comprehensive resource of detailed information about companies, including + financial stats and profile data sourced from Yahoo Finance. Ideal for getting to + know more about a company's performance, size, location, financial stats, and more. +keywords: +- business info +- company data +- financial details +- stock market +- Yahoo Finance +- company profile +- company information +- marketing SEO +- docusaurus page +- Page SEO +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Print information about the company. The following fields are expected: Zip, Sector, Full time employees, Long business summary, City, Phone, State, Country, Website, Max age, Address, Industry, Previous close, Regular market open, Two hundred day average, Payout ratio, Regular market day high, Average daily volume 10 day, Regular market previous close, Fifty day average, Open, Average volume 10 days, Beta, Regular market day low, Price hint, Currency, Trailing PE, Regular market volume, Market cap, Average volume, Price to sales trailing 12 months, Day low, Ask, Ask size, Volume, Fifty two week high, Forward PE, Fifty two week low, Bid, Tradeable, Bid size, Day high, Exchange, Short name, Long name, Exchange timezone name, Exchange timezone short name, Is esg populated, Gmt off set milliseconds, Quote type, Symbol, Message board id, Market, Enterprise to revenue, Profit margins, Enterprise to ebitda, 52 week change, Forward EPS, Shares outstanding, Book value, Shares short, Shares percent shares out, Last fiscal year end, Held percent institutions, Net income to common, Trailing EPS, Sand p52 week change, Price to book, Held percent insiders, Next fiscal year end, Most recent quarter, Short ratio, Shares short previous month date, Float shares, Enterprise value, Last split date, Last split factor, Earnings quarterly growth, Date short interest, PEG ratio, Short percent of float, Shares short prior month, Regular market price, Logo_url. [Source: Yahoo Finance] + +### Usage + +```python +info +``` + +--- + +## Parameters + +This command has no parameters + + + +--- + +## Examples + +```python +2022 Feb 16, 08:58 (🦋) /stocks/fa/ $ info + Ticker Info +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ ┃ Value ┃ +┡━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┩ +│ Zip │ 78725 │ +├───────────────────────────────────┼─────────────────────────────────────┤ +│ Sector │ Consumer Cyclical │ +├───────────────────────────────────┼─────────────────────────────────────┤ +│ Full time employees │ 99.290 K │ +├───────────────────────────────────┼─────────────────────────────────────┤ +│ City │ Austin │ +├───────────────────────────────────┼─────────────────────────────────────┤ +│ Phone │ (512) 516-8177 │ +├───────────────────────────────────┼─────────────────────────────────────┤ +│ State │ TX │ +├───────────────────────────────────┼─────────────────────────────────────┤ +│ Country │ United States │ +├───────────────────────────────────┼─────────────────────────────────────┤ +│ Website │ https://www.tesla.com │ +├───────────────────────────────────┼─────────────────────────────────────┤ +│ Max age │ 1 │ +├───────────────────────────────────┼─────────────────────────────────────┤ +│ Address │ 13101 Tesla Road │ +├───────────────────────────────────┼─────────────────────────────────────┤ +│ Industry │ Auto Manufacturers │ +├───────────────────────────────────┼─────────────────────────────────────┤ +│ Ebitda margins │ 0.173 │ +├───────────────────────────────────┼─────────────────────────────────────┤ +│ Profit margins │ 0.103 │ +├───────────────────────────────────┼─────────────────────────────────────┤ +│ Gross margins │ 0.253 │ +├───────────────────────────────────┼─────────────────────────────────────┤ +│ Operating cashflow │ 11.497 B │ +├───────────────────────────────────┼─────────────────────────────────────┤ +│ Revenue growth │ 0.649 │ +├───────────────────────────────────┼─────────────────────────────────────┤ +│ Operating margins │ 0.121 │ +├───────────────────────────────────┼─────────────────────────────────────┤ +│ Ebitda │ 9.333 B │ +├───────────────────────────────────┼─────────────────────────────────────┤ +│ Target low price │ 250 │ +├───────────────────────────────────┼─────────────────────────────────────┤ +│ Recommendation key │ hold │ +├───────────────────────────────────┼─────────────────────────────────────┤ +│ Gross profits │ 13.606 B │ +├───────────────────────────────────┼─────────────────────────────────────┤ +│ Free cashflow │ 4.628 B │ +├───────────────────────────────────┼─────────────────────────────────────┤ +│ Target median price │ 1.035 K │ +├───────────────────────────────────┼─────────────────────────────────────┤ +│ Current price │ 922.430 │ +├───────────────────────────────────┼─────────────────────────────────────┤ +│ Earnings growth │ 7.538 │ +├───────────────────────────────────┼─────────────────────────────────────┤ +│ Current ratio │ 1.375 │ +├───────────────────────────────────┼─────────────────────────────────────┤ +│ Return on assets │ 0.071 │ +├───────────────────────────────────┼─────────────────────────────────────┤ +│ Number of analyst opinions │ 36 │ +├───────────────────────────────────┼─────────────────────────────────────┤ +│ Target mean price │ 965.990 │ +├───────────────────────────────────┼─────────────────────────────────────┤ +│ Debt to equity │ 28.192 │ +├───────────────────────────────────┼─────────────────────────────────────┤ +│ Return on equity │ 0.204 │ +├───────────────────────────────────┼─────────────────────────────────────┤ +│ Target high price │ 1.480 K │ +├───────────────────────────────────┼─────────────────────────────────────┤ +│ Total cash │ 17.707 B │ +├───────────────────────────────────┼─────────────────────────────────────┤ +│ Total debt │ 8.904 B │ +├───────────────────────────────────┼─────────────────────────────────────┤ +│ Total revenue │ 53.823 B │ +├───────────────────────────────────┼─────────────────────────────────────┤ +│ Total cash per share │ 17.133 │ +├───────────────────────────────────┼─────────────────────────────────────┤ +│ Financial currency │ USD │ +├───────────────────────────────────┼─────────────────────────────────────┤ +│ Revenue per share │ 54.587 │ +├───────────────────────────────────┼─────────────────────────────────────┤ +│ Quick ratio │ 0.999 │ +├───────────────────────────────────┼─────────────────────────────────────┤ +│ Recommendation mean │ 2.600 │ +├───────────────────────────────────┼─────────────────────────────────────┤ +│ Exchange │ NMS │ +├───────────────────────────────────┼─────────────────────────────────────┤ +│ Short name │ Tesla, Inc. │ +├───────────────────────────────────┼─────────────────────────────────────┤ +│ Long name │ Tesla, Inc. │ +├───────────────────────────────────┼─────────────────────────────────────┤ +│ Exchange timezone name │ America/New_York │ +├───────────────────────────────────┼─────────────────────────────────────┤ +│ Exchange timezone short name │ EST │ +├───────────────────────────────────┼─────────────────────────────────────┤ +│ Is esg populated │ False │ +├───────────────────────────────────┼─────────────────────────────────────┤ +│ Gmt off set milliseconds │ -18 M │ +├───────────────────────────────────┼─────────────────────────────────────┤ +│ Quote type │ EQUITY │ +├───────────────────────────────────┼─────────────────────────────────────┤ +│ Symbol │ TSLA │ +├───────────────────────────────────┼─────────────────────────────────────┤ +│ Message board id │ finmb_27444752 │ +├───────────────────────────────────┼─────────────────────────────────────┤ +│ Market │ us_market │ +├───────────────────────────────────┼─────────────────────────────────────┤ +│ Enterprise to revenue │ 16.679 │ +├───────────────────────────────────┼─────────────────────────────────────┤ +│ Enterprise to ebitda │ 96.185 │ +├───────────────────────────────────┼─────────────────────────────────────┤ +│ 52 week change │ 0.156 │ +├───────────────────────────────────┼─────────────────────────────────────┤ +│ Forward EPS │ 12.540 │ +├───────────────────────────────────┼─────────────────────────────────────┤ +│ Shares outstanding │ 1.034 B │ +├───────────────────────────────────┼─────────────────────────────────────┤ +│ Book value │ 29.225 │ +├───────────────────────────────────┼─────────────────────────────────────┤ +│ Shares short │ 24.057 M │ +├───────────────────────────────────┼─────────────────────────────────────┤ +│ Shares percent shares out │ 0.023 │ +├───────────────────────────────────┼─────────────────────────────────────┤ +│ Last fiscal year end │ 1.641 B │ +├───────────────────────────────────┼─────────────────────────────────────┤ +│ Held percent institutions │ 0.425 │ +├───────────────────────────────────┼─────────────────────────────────────┤ +│ Net income to common │ 5.524 B │ +├───────────────────────────────────┼─────────────────────────────────────┤ +│ Trailing EPS │ 4.901 │ +├───────────────────────────────────┼─────────────────────────────────────┤ +│ Sand p52 week change │ 0.137 │ +├───────────────────────────────────┼─────────────────────────────────────┤ +│ Price to book │ 31.563 │ +├───────────────────────────────────┼─────────────────────────────────────┤ +│ Held percent insiders │ 0.194 │ +├───────────────────────────────────┼─────────────────────────────────────┤ +│ Next fiscal year end │ 1.704 B │ +├───────────────────────────────────┼─────────────────────────────────────┤ +│ Most recent quarter │ 1.641 B │ +├───────────────────────────────────┼─────────────────────────────────────┤ +│ Short ratio │ 0.770 │ +├───────────────────────────────────┼─────────────────────────────────────┤ +│ Shares short previous month date │ 1.641 B │ +├───────────────────────────────────┼─────────────────────────────────────┤ +│ Float shares │ 838.195 M │ +├───────────────────────────────────┼─────────────────────────────────────┤ +│ Beta │ 2.006 │ +├───────────────────────────────────┼─────────────────────────────────────┤ +│ Enterprise value │ 897.696 B │ +├───────────────────────────────────┼─────────────────────────────────────┤ +│ Price hint │ 2 │ +├───────────────────────────────────┼─────────────────────────────────────┤ +│ Last split date │ 2020-08-31 │ +├───────────────────────────────────┼─────────────────────────────────────┤ +│ Last split factor │ 5:1 │ +├───────────────────────────────────┼─────────────────────────────────────┤ +│ Earnings quarterly growth │ 7.596 │ +├───────────────────────────────────┼─────────────────────────────────────┤ +│ Price to sales trailing 12 months │ 17.713 │ +├───────────────────────────────────┼─────────────────────────────────────┤ +│ Date short interest │ 1.644 B │ +├───────────────────────────────────┼─────────────────────────────────────┤ +│ PEG ratio │ 4.140 │ +├───────────────────────────────────┼─────────────────────────────────────┤ +│ Forward PE │ 73.559 │ +├───────────────────────────────────┼─────────────────────────────────────┤ +│ Short percent of float │ 0.028 │ +├───────────────────────────────────┼─────────────────────────────────────┤ +│ Shares short prior month │ 22.472 M │ +├───────────────────────────────────┼─────────────────────────────────────┤ +│ Implied shares outstanding │ 0 │ +├───────────────────────────────────┼─────────────────────────────────────┤ +│ Previous close │ 875.760 │ +├───────────────────────────────────┼─────────────────────────────────────┤ +│ Regular market open │ 900 │ +├───────────────────────────────────┼─────────────────────────────────────┤ +│ Two hundred day average │ 826.031 │ +├───────────────────────────────────┼─────────────────────────────────────┤ +│ Trailing annual dividend yield │ 0 │ +├───────────────────────────────────┼─────────────────────────────────────┤ +│ Payout ratio │ 0 │ +├───────────────────────────────────┼─────────────────────────────────────┤ +│ Regular market day high │ 923 │ +├───────────────────────────────────┼─────────────────────────────────────┤ +│ Average daily volume 10 day │ 21.790 M │ +├───────────────────────────────────┼─────────────────────────────────────┤ +│ Regular market previous close │ 875.760 │ +├───────────────────────────────────┼─────────────────────────────────────┤ +│ Fifty day average │ 987.997 │ +├───────────────────────────────────┼─────────────────────────────────────┤ +│ Trailing annual dividend rate │ 0 │ +├───────────────────────────────────┼─────────────────────────────────────┤ +│ Open │ 900 │ +├───────────────────────────────────┼─────────────────────────────────────┤ +│ Average volume 10 days │ 21.790 M │ +├───────────────────────────────────┼─────────────────────────────────────┤ +│ Regular market day low │ 893.377 │ +├───────────────────────────────────┼─────────────────────────────────────┤ +│ Currency │ USD │ +├───────────────────────────────────┼─────────────────────────────────────┤ +│ Trailing PE │ 188.213 │ +├───────────────────────────────────┼─────────────────────────────────────┤ +│ Regular market volume │ 19.217 M │ +├───────────────────────────────────┼─────────────────────────────────────┤ +│ Market cap │ 953.341 B │ +├───────────────────────────────────┼─────────────────────────────────────┤ +│ Average volume │ 26.044 M │ +├───────────────────────────────────┼─────────────────────────────────────┤ +│ Day low │ 893.377 │ +├───────────────────────────────────┼─────────────────────────────────────┤ +│ Ask │ 922.940 │ +├───────────────────────────────────┼─────────────────────────────────────┤ +│ Ask size │ 2.200 K │ +├───────────────────────────────────┼─────────────────────────────────────┤ +│ Volume │ 19.217 M │ +├───────────────────────────────────┼─────────────────────────────────────┤ +│ Fifty two week high │ 1.243 K │ +├───────────────────────────────────┼─────────────────────────────────────┤ +│ Fifty two week low │ 539.490 │ +├───────────────────────────────────┼─────────────────────────────────────┤ +│ Bid │ 925 │ +├───────────────────────────────────┼─────────────────────────────────────┤ +│ Tradeable │ False │ +├───────────────────────────────────┼─────────────────────────────────────┤ +│ Bid size │ 1 K │ +├───────────────────────────────────┼─────────────────────────────────────┤ +│ Day high │ 923 │ +├───────────────────────────────────┼─────────────────────────────────────┤ +│ Regular market price │ 922.430 │ +├───────────────────────────────────┼─────────────────────────────────────┤ +│ Pre market price │ 917 │ +├───────────────────────────────────┼─────────────────────────────────────┤ +│ Logo_url │ https://logo.clearbit.com/tesla.com │ +├───────────────────────────────────┼─────────────────────────────────────┤ +│ Trailing peg ratio │ 2.587 │ +└───────────────────────────────────┴─────────────────────────────────────┘ +``` +--- diff --git a/website/content/terminal/reference/stocks/fa/key.md b/website/content/terminal/reference/stocks/fa/key.md new file mode 100644 index 000000000000..d2a617382ecd --- /dev/null +++ b/website/content/terminal/reference/stocks/fa/key.md @@ -0,0 +1,78 @@ +--- +title: key +description: This documentation provides users with key metrics data about a company + using Alpha Vantage API. It presents data fields like Market capitalization, EBITDA, + EPS, PE ratio, and more. +keywords: +- Alpha Vantage API +- Market capitalization +- EBITDA +- EPS +- PE ratio +- PEG ratio +- Price to book ratio +- Return on equity TTM +- Payout ratio +- Price to sales ratio TTM +- Dividend yield +- 50 day moving average +- Analyst target price +- Beta +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Gives main key metrics about the company (it's a subset of the Overview data from Alpha Vantage API). The following fields are expected: Market capitalization, EBITDA, EPS, PE ratio, PEG ratio, Price to book ratio, Return on equity TTM, Payout ratio, Price to sales ratio TTM, Dividend yield, 50 day moving average, Analyst target price, Beta [Source: Alpha Vantage API] + +### Usage + +```python +key +``` + +--- + +## Parameters + +This command has no parameters + + + +--- + +## Examples + +```python +2022 Feb 16, 06:54 (🦋) /stocks/fa/ $ key + AAPL Key Metrics +┏━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━┓ +┃ ┃ ┃ +┡━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━┩ +│ Market capitalization │ 2.820 T │ +├──────────────────────────┼───────────┤ +│ EBITDA │ 128.218 B │ +├──────────────────────────┼───────────┤ +│ EPS │ 6.01 │ +├──────────────────────────┼───────────┤ +│ PE ratio │ 28.73 │ +├──────────────────────────┼───────────┤ +│ PEG ratio │ 3.28 │ +├──────────────────────────┼───────────┤ +│ Price to book ratio │ 38.31 │ +├──────────────────────────┼───────────┤ +│ Return on equity TTM │ 1.456 │ +├──────────────────────────┼───────────┤ +│ Price to sales ratio TTM │ 7.45 │ +├──────────────────────────┼───────────┤ +│ Dividend yield │ 0.0052 │ +├──────────────────────────┼───────────┤ +│ 50 day moving average │ 172.3 │ +├──────────────────────────┼───────────┤ +│ Analyst target price │ 192.52 │ +├──────────────────────────┼───────────┤ +│ Beta │ 1.188 │ +└──────────────────────────┴───────────┘ +``` +--- diff --git a/website/content/terminal/reference/stocks/fa/load.md b/website/content/terminal/reference/stocks/fa/load.md new file mode 100644 index 000000000000..d94f00938b44 --- /dev/null +++ b/website/content/terminal/reference/stocks/fa/load.md @@ -0,0 +1,49 @@ +--- +title: load +description: This page provides comprehensive instructions on how to load stock tickers + to perform analysis. It highlights how to load Indian market stocks with '.NS' and + provides a link to the Yahoo finance available markets. The page features various + parameters to tailor analysis including adjustments for start and end dates, interval + times, and loading custom files. +keywords: +- Load stock ticker +- Perform analysis +- India stock market +- .NS +- Yahoo finance +- Exchanges data providers +- Parameters +- Stock interval +- Intraday stock minutes +- Load monthly data +- Load weekly data +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Load stock ticker to perform analysis on. When the data source is syf', an Indian ticker can be loaded by using '.NS' at the end, e.g. 'SBIN.NS'. See available market in https://help.yahoo.com/kb/exchanges-data-providers-yahoo-finance-sln2310.html. + +### Usage + +```python +load -t TICKER [-s START] [-e END] [-i {1,5,15,30,60}] [-p] [-f FILEPATH] [-m] [-w] [-r {ytd,1y,2y,5y,6m}] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| ticker | Stock ticker | None | False | None | +| start | The starting date (format YYYY-MM-DD) of the stock | 2019-11-21 | True | None | +| end | The ending date (format YYYY-MM-DD) of the stock | 2022-11-25 | True | None | +| interval | Intraday stock minutes | 1440 | True | 1, 5, 15, 30, 60 | +| prepost | Pre/After market hours. Only works for 'yf' source, and intraday data | False | True | None | +| filepath | Path to load custom file. | None | True | None | +| monthly | Load monthly data | False | True | None | +| weekly | Load weekly data | False | True | None | + +--- diff --git a/website/content/terminal/reference/stocks/fa/metrics.md b/website/content/terminal/reference/stocks/fa/metrics.md new file mode 100644 index 000000000000..46aee387cecd --- /dev/null +++ b/website/content/terminal/reference/stocks/fa/metrics.md @@ -0,0 +1,39 @@ +--- +title: metrics +description: This documentation page provides information on how to pull key metrics + of a company over time using metrics command. Included data are Return on Equity + (ROE), Working Capital, Current Ratio and Debt to Assets, among others. +keywords: +- metrics +- company metrics +- Return on Equity +- Working Capital +- Current Ratio +- Debt to Assets +- quarterly metrics +- annual metrics +- financial modeling +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Prints a list of the key metrics of a company over time. This can be either quarterly or annually. This includes, among other things, Return on Equity (ROE), Working Capital, Current Ratio and Debt to Assets. The following fields are expected: Average inventory, Average payables, Average receivables, Book value per share, Capex per share, Capex to depreciation, Capex to operating cash flow, Capex to revenue, Cash per share, Current ratio, Days of inventory on hand, Days payables outstanding, Days sales outstanding, Debt to assets, Debt to equity, Dividend yield, Earnings yield, Enterprise value, Enterprise value over EBITDA, Ev to free cash flow, Ev to operating cash flow, Ev to sales, Free cash flow per share, Free cash flow yield, Graham net net, Graham number, Income quality, Intangibles to total assets, Interest debt per share, Inventory turnover, Market cap, Net current asset value, Net debt to EBITDA, Net income per share, Operating cash flow per share, Payables turnover, Payout ratio, Pb ratio, Pe ratio, Pfcf ratio, Pocf ratio, Price to sales ratio, Ptb ratio, Receivables turnover, Research and development to revenue, Return on tangible assets, Revenue per share, Roe, Roic, Sales general and administrative to revenue, Shareholders equity per share, Stock based compensation to revenue, Tangible book value per share, and Working capital. [Source: Financial Modeling Prep] + +### Usage + +```python +metrics [-l LIMIT] [-q] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| limit | Limit of latest years/quarters. | 5 | True | None | +| b_quarter | Quarter fundamental data flag. | False | True | None | + +--- diff --git a/website/content/terminal/reference/stocks/fa/mgmt.md b/website/content/terminal/reference/stocks/fa/mgmt.md new file mode 100644 index 000000000000..7eefc1f1913d --- /dev/null +++ b/website/content/terminal/reference/stocks/fa/mgmt.md @@ -0,0 +1,34 @@ +--- +title: mgmt +description: This page provides details on how to print management team details using + the 'mgmt' command. It also includes potential insider activity page sourced from + Business Insider. +keywords: +- management team +- insider activity +- Business Insider +- mgmt +- print management info +- usage of mgmt +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Print management team. Namely: Name, Title, Information from google and (potentially) Insider Activity page. [Source: Business Insider] + +### Usage + +```python +mgmt +``` + +--- + +## Parameters + +This command has no parameters + + +--- diff --git a/website/content/terminal/reference/stocks/fa/mktcap.md b/website/content/terminal/reference/stocks/fa/mktcap.md new file mode 100644 index 000000000000..ac833a2b2a9d --- /dev/null +++ b/website/content/terminal/reference/stocks/fa/mktcap.md @@ -0,0 +1,39 @@ +--- +title: mktcap +description: The mktcap page describes the usage and parameters of the market cap + estimate over time. The source for this data is Yahoo Finance. A Python line command + is used to fetch and display this information. +keywords: +- mktcap +- market cap estimate +- Yahoo Finance +- python commands +- financial data +- parameters +- starting date +- data visualisation +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Market Cap estimate over time. [Source: Yahoo Finance] + +### Usage + +```python +mktcap [-s START] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| start | The starting date (format YYYY-MM-DD) of the market cap display | 2019-11-23 | True | None | + +![gnus_mktcap](https://user-images.githubusercontent.com/25267873/156903038-46f46af1-68ca-435b-aed7-842da041864a.png) + +--- diff --git a/website/content/terminal/reference/stocks/fa/overview.md b/website/content/terminal/reference/stocks/fa/overview.md new file mode 100644 index 000000000000..293a1b0d3bcb --- /dev/null +++ b/website/content/terminal/reference/stocks/fa/overview.md @@ -0,0 +1,141 @@ +--- +title: overview +description: This page provides a command to generate an extensive overview of a company, + delivering important data from asset type and exchange to financial metrics by Alpha + Vantage. This can be particularly useful for financial analysis and understanding + the company's current standing in the market. +keywords: +- Company overview +- Stocks information +- Market data +- Financial statistics +- Alpha Vantage +- Trading data +- Asset info +- Company data +- Financial analysis +- Business fundamentals +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Prints an overview about the company. The following fields are expected: Symbol, Asset type, Name, Description, Exchange, Currency, Country, Sector, Industry, Address, Full time employees, Fiscal year end, Latest quarter, Market capitalization, EBITDA, PE ratio, PEG ratio, Book value, Dividend per share, Dividend yield, EPS, Revenue per share TTM, Profit margin, Operating margin TTM, Return on assets TTM, Return on equity TTM, Revenue TTM, Gross profit TTM, Diluted EPS TTM, Quarterly earnings growth YOY, Quarterly revenue growth YOY, Analyst target price, Trailing PE, Forward PE, Price to sales ratio TTM, Price to book ratio, EV to revenue, EV to EBITDA, Beta, 52 week high, 52 week low, 50 day moving average, 200 day moving average, Shares outstanding, Shares float, Shares short, Shares short prior month, Short ratio, Short percent outstanding, Short percent float, Percent insiders, Percent institutions, Forward annual dividend rate, Forward annual dividend yield, Payout ratio, Dividend date, Ex dividend date, Last split factor, and Last split date. Also, the C i k field corresponds to Central Index Key, which can be used to search a company on https://www.sec.gov/edgar/searchedgar/cik.htm [Source: Alpha Vantage] + +### Usage + +```python +overview +``` + +--- + +## Parameters + +This command has no parameters + + + +--- + +## Examples + +```python +2022 Feb 16, 07:03 (🦋) /stocks/fa/ $ overview + TSLA Overview +┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ ┃ ┃ +┡━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┩ +│ Symbol │ TSLA │ +├───────────────────────────────┼───────────────────────────────────────┤ +│ Asset type │ Common Stock │ +├───────────────────────────────┼───────────────────────────────────────┤ +│ Name │ Tesla Inc │ +├───────────────────────────────┼───────────────────────────────────────┤ +│ C i k │ 1318605 │ +├───────────────────────────────┼───────────────────────────────────────┤ +│ Exchange │ NASDAQ │ +├───────────────────────────────┼───────────────────────────────────────┤ +│ Currency │ USD │ +├───────────────────────────────┼───────────────────────────────────────┤ +│ Country │ USA │ +├───────────────────────────────┼───────────────────────────────────────┤ +│ Sector │ MANUFACTURING │ +├───────────────────────────────┼───────────────────────────────────────┤ +│ Industry │ MOTOR VEHICLES & PASSENGER CAR BODIES │ +├───────────────────────────────┼───────────────────────────────────────┤ +│ Address │ 3500 DEER CREEK RD, PALO ALTO, CA, US │ +├───────────────────────────────┼───────────────────────────────────────┤ +│ Fiscal year end │ December │ +├───────────────────────────────┼───────────────────────────────────────┤ +│ Latest quarter │ 2021-12-31 │ +├───────────────────────────────┼───────────────────────────────────────┤ +│ Market capitalization │ 953.341 B │ +├───────────────────────────────┼───────────────────────────────────────┤ +│ EBITDA │ 9.333 B │ +├───────────────────────────────┼───────────────────────────────────────┤ +│ PE ratio │ 188.21 │ +├───────────────────────────────┼───────────────────────────────────────┤ +│ PEG ratio │ 2.587 │ +├───────────────────────────────┼───────────────────────────────────────┤ +│ Book value │ 29.23 │ +├───────────────────────────────┼───────────────────────────────────────┤ +│ Dividend per share │ 0 │ +├───────────────────────────────┼───────────────────────────────────────┤ +│ Dividend yield │ 0 │ +├───────────────────────────────┼───────────────────────────────────────┤ +│ EPS │ 4.901 │ +├───────────────────────────────┼───────────────────────────────────────┤ +│ Revenue per share TTM │ 54.59 │ +├───────────────────────────────┼───────────────────────────────────────┤ +│ Profit margin │ 0.102 │ +├───────────────────────────────┼───────────────────────────────────────┤ +│ Operating margin TTM │ 0.121 │ +├───────────────────────────────┼───────────────────────────────────────┤ +│ Return on assets TTM │ 0.0714 │ +├───────────────────────────────┼───────────────────────────────────────┤ +│ Return on equity TTM │ 0.204 │ +├───────────────────────────────┼───────────────────────────────────────┤ +│ Revenue TTM │ 53.823 B │ +├───────────────────────────────┼───────────────────────────────────────┤ +│ Gross profit TTM │ 13.606 B │ +├───────────────────────────────┼───────────────────────────────────────┤ +│ Diluted EPS TTM │ 4.901 │ +├───────────────────────────────┼───────────────────────────────────────┤ +│ Quarterly earnings growth YOY │ 7.54 │ +├───────────────────────────────┼───────────────────────────────────────┤ +│ Quarterly revenue growth YOY │ 0.649 │ +├───────────────────────────────┼───────────────────────────────────────┤ +│ Analyst target price │ 965.99 │ +├───────────────────────────────┼───────────────────────────────────────┤ +│ Trailing PE │ 188.21 │ +├───────────────────────────────┼───────────────────────────────────────┤ +│ Forward PE │ 88.5 │ +├───────────────────────────────┼───────────────────────────────────────┤ +│ Price to sales ratio TTM │ 17.71 │ +├───────────────────────────────┼───────────────────────────────────────┤ +│ Price to book ratio │ 29.98 │ +├───────────────────────────────┼───────────────────────────────────────┤ +│ EV to revenue │ 16.65 │ +├───────────────────────────────┼───────────────────────────────────────┤ +│ EV to EBITDA │ 93.12 │ +├───────────────────────────────┼───────────────────────────────────────┤ +│ Beta │ 2.006 │ +├───────────────────────────────┼───────────────────────────────────────┤ +│ 52 week high │ 1243.49 │ +├───────────────────────────────┼───────────────────────────────────────┤ +│ 52 week low │ 539.49 │ +├───────────────────────────────┼───────────────────────────────────────┤ +│ 50 day moving average │ 989.85 │ +├───────────────────────────────┼───────────────────────────────────────┤ +│ 200 day moving average │ 824.84 │ +├───────────────────────────────┼───────────────────────────────────────┤ +│ Shares outstanding │ 1.034 B │ +├───────────────────────────────┼───────────────────────────────────────┤ +│ Dividend date │ None │ +├───────────────────────────────┼───────────────────────────────────────┤ +│ Ex dividend date │ None │ +└───────────────────────────────┴───────────────────────────────────────┘ +``` +--- diff --git a/website/content/terminal/reference/stocks/fa/profile.md b/website/content/terminal/reference/stocks/fa/profile.md new file mode 100644 index 000000000000..e6d07177c27b --- /dev/null +++ b/website/content/terminal/reference/stocks/fa/profile.md @@ -0,0 +1,34 @@ +--- +title: profile +description: This documentation page provides comprehensive information about financial + profile command in Python. The command prints various aspects such as company description, + industry, sector, exchange and more. +keywords: +- Financial Modeling Prep +- Python command +- financial profile +- sector exchange +- company description +- Company information +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Prints information about, among other things, the industry, sector exchange and company description. The following fields are expected: Address, Beta, Ceo, Changes, Cik, City Company name, Country, Currency, Cusip, Dcf, Dcf diff, Default image, Description, Exchange, Exchange short name, Full time employees, Image, Industry, Ipo date, Isin, Last div, Mkt cap, Phone, Price, Range, Sector, State, Symbol, Vol avg, Website, Zip. [Source: Financial Modeling Prep] + +### Usage + +```python +profile +``` + +--- + +## Parameters + +This command has no parameters + + +--- diff --git a/website/content/terminal/reference/stocks/fa/quote.md b/website/content/terminal/reference/stocks/fa/quote.md new file mode 100644 index 000000000000..534f291a733c --- /dev/null +++ b/website/content/terminal/reference/stocks/fa/quote.md @@ -0,0 +1,54 @@ +--- +title: quote +description: This page provides a detailed explanation on the 'quote' function, a + tool that delivers comprehensive financial data of a company including volume, price-to-equity + ratio, market cap, and more. Source of this information typically comes from Financial + Modeling Prep. +keywords: +- quote +- company information +- market cap +- open price +- close price +- price-to-equity ratio +- Financial Modeling Prep +- Shares outstanding +- Day high +- Day low +- Earnings announcement +- Eps +- Exchange +- Name +- Open +- Pe +- Previous close +- Price +- Price avg200 +- Price avg50 +- Symbol +- Timestamp +- Volume +- Year high +- Year low +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Prints actual information about the company which is, among other things, the day high, market cap, open and close price and price-to-equity ratio. The following fields are expected: Avg volume, Change, Changes percentage, Day high, Day low, Earnings announcement, Eps, Exchange, Market cap, Name, Open, Pe, Previous close, Price, Price avg200, Price avg50, Shares outstanding, Symbol, Timestamp, Volume, Year high, and Year low. [Source: Financial Modeling Prep] + +### Usage + +```python +quote +``` + +--- + +## Parameters + +This command has no parameters + + +--- diff --git a/website/content/terminal/reference/stocks/fa/ratios.md b/website/content/terminal/reference/stocks/fa/ratios.md new file mode 100644 index 000000000000..ae59caa85550 --- /dev/null +++ b/website/content/terminal/reference/stocks/fa/ratios.md @@ -0,0 +1,41 @@ +--- +title: ratios +description: A comprehensive guide on using the 'ratios' function. It offers an in-depth + analysis of a company's ratios over time, which includes financial metrics like + Payout Ratio, Price-to-Book Ratio, Debt equity ratio, Dividend payout ratio and + much more. +keywords: +- ratios +- financial ratios +- debt equity ratio +- dividend payout ratio +- price to book ratio +- financial modeling +- asset turnover +- cash flow +- return on equity +- operating cycle +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Prints in-depth ratios of a company over time. This can be either quarterly or annually. This contains, among other things, Price-to-Book Ratio, Payout Ratio and Operating Cycle. The following fields are expected: Asset turnover, Capital expenditure coverage ratio, Cash conversion cycle, Cash flow coverage ratios, Cash flow to debt ratio, Cash per share, Cash ratio, Company equity multiplier, Current ratio, Days of inventory outstanding, Days of payables outstanding, Days of sales outstanding, Debt equity ratio, Debt ratio, Dividend paid and capex coverage ratio, Dividend payout ratio, Dividend yield, Ebit per revenue, Ebt per ebit, Effective tax rate, Enterprise value multiple, Fixed asset turnover, Free cash flow operating cash flow ratio, Free cash flow per share, Gross profit margin, Inventory turnover, Long term debt to capitalization, Net income per EBT, Net profit margin, Operating cash flow per share, Operating cash flow sales ratio, Operating cycle, Operating profit margin, Payables turnover, Payout ratio, Pretax profit margin, Price book value ratio, Price cash flow ratio, Price earnings ratio, Price earnings to growth ratio, Price fair value, Price sales ratio, Price to book ratio, Price to free cash flows ratio, Price to operating cash flows ratio, Price to sales ratio, Quick ratio, Receivables turnover, Return on assets, Return on capital employed, Return on equity, Short term coverage ratios, and Total debt to capitalization. [Source: Financial Modeling Prep] + +### Usage + +```python +ratios [-l LIMIT] [-q] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| limit | Limit of latest years/quarters. | 5 | True | None | +| b_quarter | Quarter fundamental data flag. | False | True | None | + +--- diff --git a/website/content/terminal/reference/stocks/fa/score.md b/website/content/terminal/reference/stocks/fa/score.md new file mode 100644 index 000000000000..28d0e9b78a5e --- /dev/null +++ b/website/content/terminal/reference/stocks/fa/score.md @@ -0,0 +1,36 @@ +--- +title: score +description: This is a documentation for Score, a Python command for a value investing + tool based on insights by Warren Buffett, Joseph Piotroski, and Benjamin Graham. + This command does not require any parameters. +keywords: +- Score +- Value Investing +- Warren Buffett +- Joseph Piotroski +- Benjamin Graham +- Investment tool +- FMP +- Python command +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Value investing tool based on Warren Buffett, Joseph Piotroski and Benjamin Graham thoughts [Source: FMP] + +### Usage + +```python +score +``` + +--- + +## Parameters + +This command has no parameters + + +--- diff --git a/website/content/terminal/reference/stocks/fa/shrs.md b/website/content/terminal/reference/stocks/fa/shrs.md new file mode 100644 index 000000000000..7c158e3e4750 --- /dev/null +++ b/website/content/terminal/reference/stocks/fa/shrs.md @@ -0,0 +1,35 @@ +--- +title: shrs +description: This page provides information on how to print Major, institutional and + mutualfunds shareholders using the 'shrs' command in Python. The data source for + this information is Yahoo Finance. +keywords: +- shrs +- major shareholders +- institutional shareholders +- mutualfunds shareholders +- Yahoo Finance +- shareholder table +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Print Major, institutional and mutualfunds shareholders. [Source: Yahoo Finance] + +### Usage + +```python +shrs [--holder {major,institutional,mutualfund}] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| holder | Table of holders to get | institutional | True | major, institutional, mutualfund | + +--- diff --git a/website/content/terminal/reference/stocks/fa/splits.md b/website/content/terminal/reference/stocks/fa/splits.md new file mode 100644 index 000000000000..05224588be5d --- /dev/null +++ b/website/content/terminal/reference/stocks/fa/splits.md @@ -0,0 +1,39 @@ +--- +title: splits +description: This page provides relevant information on stock splits and reverse split + events since a company's IPO, referencing Yahoo Finance. Example parameters for + use in Python are illustrated. +keywords: +- stock splits +- reverse split +- IPO +- Yahoo Finance +- parameters +- gnus_splits +- aapl_splits +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Stock splits and reverse split events since IPO [Source: Yahoo Finance] + +### Usage + +```python +splits +``` + +--- + +## Parameters + +This command has no parameters + + +![gnus_splits](https://user-images.githubusercontent.com/25267873/156905484-61d3a27a-2428-4d80-ae01-b085c875be24.png) + +![aapl_splits](https://user-images.githubusercontent.com/25267873/156905485-0964fcbd-c47b-4288-a06c-41363a9fdc30.png) + +--- diff --git a/website/content/terminal/reference/stocks/fa/sust.md b/website/content/terminal/reference/stocks/fa/sust.md new file mode 100644 index 000000000000..d563de402857 --- /dev/null +++ b/website/content/terminal/reference/stocks/fa/sust.md @@ -0,0 +1,101 @@ +--- +title: sust +description: This documentation page covers the usage of 'sust' command in fetching + sustainability values of a company, useful for responsible investment decisions. + All values are sourced from Yahoo Finance. +keywords: +- sust command +- sustainability values +- responsible investments +- Yahoo Finance +- ESG scores +- corporate sustainability +- investment tool +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Print sustainability values of the company. The following fields are expected: Palmoil, Controversialweapons, Gambling, Socialscore, Nuclear, Furleather, Alcoholic, Gmo, Catholic, Socialpercentile, Peercount, Governancescore, Environmentpercentile, Animaltesting, Tobacco, Total ESG, Highestcontroversy, ESG Performance, Coal, Pesticides, Adult, Percentile, Peergroup, Smallarms, Environmentscore, Governancepercentile, Militarycontract. [Source: Yahoo Finance] + +### Usage + +```python +sust +``` + +--- + +## Parameters + +This command has no parameters + + + +--- + +## Examples + +```python +2022 Feb 16, 09:01 (🦋) /stocks/fa/ $ sust + Ticker Sustainability +┏━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━┓ +┃ ┃ Value ┃ +┡━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━┩ +│ Palm oil │ False │ +├────────────────────────┼─────────────┤ +│ Controversial weapons │ False │ +├────────────────────────┼─────────────┤ +│ Gambling │ False │ +├────────────────────────┼─────────────┤ +│ Social score │ 16.16 │ +├────────────────────────┼─────────────┤ +│ Nuclear │ False │ +├────────────────────────┼─────────────┤ +│ Fur leather │ False │ +├────────────────────────┼─────────────┤ +│ Alcoholic │ False │ +├────────────────────────┼─────────────┤ +│ Gmo │ False │ +├────────────────────────┼─────────────┤ +│ Catholic │ False │ +├────────────────────────┼─────────────┤ +│ Social percentile │ None │ +├────────────────────────┼─────────────┤ +│ Peer count │ 37 │ +├────────────────────────┼─────────────┤ +│ Governance score │ 9.61 │ +├────────────────────────┼─────────────┤ +│ Environment percentile │ None │ +├────────────────────────┼─────────────┤ +│ Animal testing │ False │ +├────────────────────────┼─────────────┤ +│ Tobacco │ False │ +├────────────────────────┼─────────────┤ +│ Total esg │ 28.54 │ +├────────────────────────┼─────────────┤ +│ Highest controversy │ 3 │ +├────────────────────────┼─────────────┤ +│ Esg performance │ AVG_PERF │ +├────────────────────────┼─────────────┤ +│ Coal │ False │ +├────────────────────────┼─────────────┤ +│ Pesticides │ False │ +├────────────────────────┼─────────────┤ +│ Adult │ False │ +├────────────────────────┼─────────────┤ +│ Percentile │ 55.73 │ +├────────────────────────┼─────────────┤ +│ Peer group │ Automobiles │ +├────────────────────────┼─────────────┤ +│ Small arms │ False │ +├────────────────────────┼─────────────┤ +│ Environment score │ 2.78 │ +├────────────────────────┼─────────────┤ +│ Governance percentile │ None │ +├────────────────────────┼─────────────┤ +│ Military contract │ False │ +└────────────────────────┴─────────────┘ +``` +--- diff --git a/website/versioned_docs/version-v3/terminal/reference/stocks/fa/warnings.md b/website/content/terminal/reference/stocks/fa/warnings.md similarity index 90% rename from website/versioned_docs/version-v3/terminal/reference/stocks/fa/warnings.md rename to website/content/terminal/reference/stocks/fa/warnings.md index 036e4a6c6ece..e604c0d8f8bd 100644 --- a/website/versioned_docs/version-v3/terminal/reference/stocks/fa/warnings.md +++ b/website/content/terminal/reference/stocks/fa/warnings.md @@ -1,9 +1,24 @@ --- title: warnings -description: OpenBB Terminal Function +description: This page provides warnings by Sean Seah regarding stock market values, + including consistent historical earnings per share, return on equity, return on + assets, and net income to long-term debt ratio. Insightful examples and customizable + parameters are available for financial analysis. +keywords: +- Sean Seah warnings +- stock market indicators +- financial analytics +- historical earnings per share +- return on equity +- return on assets +- net income to long-term debt ratio +- financial analysis examples +- customizable financial parameters --- -# warnings +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + Sean Seah warnings. Check: Consistent historical earnings per share; Consistently high return on equity; Consistently high return on assets; 5x Net Income Long-Term Debt; and Interest coverage ratio more than 3. See https://www.drwealth.com/gone-fishing-with-buffett-by-sean-seah/comment-page-1/ [Source: Market Watch] diff --git a/website/content/terminal/reference/stocks/fa/web.md b/website/content/terminal/reference/stocks/fa/web.md new file mode 100644 index 000000000000..53b56f56876c --- /dev/null +++ b/website/content/terminal/reference/stocks/fa/web.md @@ -0,0 +1,33 @@ +--- +title: web +description: 'This page provides detailed information on how to open the company''s + website using the ''web'' command. It includes usage instructions and specification + of the lack of parameters for the command. Source: Yahoo Finance.' +keywords: +- company website +- web command +- usage instructions +- no parameters +- Yahoo Finance +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Opens company's website. [Source: Yahoo Finance] + +### Usage + +```python +web +``` + +--- + +## Parameters + +This command has no parameters + + +--- diff --git a/website/versioned_docs/version-v3/terminal/reference/stocks/gov/_category_.json b/website/content/terminal/reference/stocks/gov/_category_.json similarity index 100% rename from website/versioned_docs/version-v3/terminal/reference/stocks/gov/_category_.json rename to website/content/terminal/reference/stocks/gov/_category_.json diff --git a/website/content/terminal/reference/stocks/gov/contracts.md b/website/content/terminal/reference/stocks/gov/contracts.md new file mode 100644 index 000000000000..af0926b5ca56 --- /dev/null +++ b/website/content/terminal/reference/stocks/gov/contracts.md @@ -0,0 +1,36 @@ +--- +title: contracts +description: This documentation page provides information about contracts associated + with a ticker as sourced from QuiverQuant. Details include usage, parameters like + past transaction days and raw data. Also added is a snapshot of the contracts interface. +keywords: +- contracts +- past transaction days +- raw data +- quiverquant +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Contracts associated with ticker. [Source: www.quiverquant.com] + +### Usage + +```python +contracts [-p PAST_TRANSACTION_DAYS] [--raw] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| past_transaction_days | Past transaction days | 10 | True | None | +| raw | Print raw data. | False | True | None | + +![contracts](https://user-images.githubusercontent.com/46355364/154263066-0ff61349-4fe5-4eac-9e60-23fa075a9e9f.png) + +--- diff --git a/website/content/terminal/reference/stocks/gov/gtrades.md b/website/content/terminal/reference/stocks/gov/gtrades.md new file mode 100644 index 000000000000..1e781cf1831f --- /dev/null +++ b/website/content/terminal/reference/stocks/gov/gtrades.md @@ -0,0 +1,37 @@ +--- +title: gtrades +description: This page provides documentation on how to use the gtrades governmental + trading tool, offering information on command usage, parameters, and possible settings. +keywords: +- gtrades +- governmental trading +- usage +- parameters +- settings +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Government trading. [Source: www.quiverquant.com] + +### Usage + +```python +gtrades [-p PAST_TRANSACTIONS_MONTHS] [-g {congress,senate,house}] [--raw] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| past_transactions_months | Past transaction months | 6 | True | None | +| gov | | congress | True | congress, senate, house | +| raw | Print raw data. | False | True | None | + +![gtrades](https://user-images.githubusercontent.com/46355364/154263341-9f51e041-e2c6-408c-bf80-5ef3c7f045f0.png) + +--- diff --git a/website/content/terminal/reference/stocks/gov/histcont.md b/website/content/terminal/reference/stocks/gov/histcont.md new file mode 100644 index 000000000000..60cca9bae37c --- /dev/null +++ b/website/content/terminal/reference/stocks/gov/histcont.md @@ -0,0 +1,36 @@ +--- +title: histcont +description: The histcont page is part of Quiver Quant's website and deals with quarterly-contracts + historical data. Here you'll find information about parameters, usages, and data + visualizations. +keywords: +- histcont +- Quiver Quant +- historical contracts +- raw data +- data visualization +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Quarterly-contracts historical [Source: www.quiverquant.com] + +### Usage + +```python +histcont [--raw] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| raw | Print raw data. | False | True | None | + +![histcont](https://user-images.githubusercontent.com/46355364/154263545-a210b65d-5dac-45df-b378-692563a5c950.png) + +--- diff --git a/website/content/terminal/reference/stocks/gov/lastcontracts.md b/website/content/terminal/reference/stocks/gov/lastcontracts.md new file mode 100644 index 000000000000..9dce7b9bfac1 --- /dev/null +++ b/website/content/terminal/reference/stocks/gov/lastcontracts.md @@ -0,0 +1,110 @@ +--- +title: lastcontracts +description: This is a page for 'lastcontracts', a tool that displays the most recent + government contracts. It can customize the display based on the user's preferences + for the limit of contracts to display, the past transaction days to cover, and to + show or not the total amount of contracts. +keywords: +- lastcontracts +- government contracts +- display contracts +- past transaction days +- limit of contracts +- total amount of contracts +- data display +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Last government contracts. [Source: www.quiverquant.com] + +### Usage + +```python +lastcontracts [-p PAST_TRANSACTION_DAYS] [-l LIMIT] [-s] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| past_transaction_days | Past transaction days | 2 | True | None | +| limit | Limit of contracts to display | 20 | True | None | +| sum | Flag to show total amount of contracts. | False | True | None | + + +--- + +## Examples + +```python +2022 Feb 16, 07:22 (🦋) /stocks/gov/ $ lastcontracts + Last Government Contracts +┏━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━┳━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Date ┃ Ticker ┃ Amount ┃ Description ┃ Agency ┃ +┡━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━╇━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┩ +│ 2022-02-12 00:00:00 │ EW │ 32500.00 │ HEART VALVE │ DEPARTMENT OF VETERANS AFFAIRS (VA) │ +├─────────────────────┼────────┼───────────┼────────────────────────────────────────────────────┼───────────────────────────────────────┤ +│ 2022-02-11 00:00:00 │ HNGR │ 0.00 │ PROSTHETIC LIMB │ DEPARTMENT OF VETERANS AFFAIRS (VA) │ +├─────────────────────┼────────┼───────────┼────────────────────────────────────────────────────┼───────────────────────────────────────┤ +│ 2022-02-11 00:00:00 │ WBA │ 11425.69 │ JYNARQUE │ DEPARTMENT OF VETERANS AFFAIRS (VA) │ +├─────────────────────┼────────┼───────────┼────────────────────────────────────────────────────┼───────────────────────────────────────┤ +│ 2022-02-11 00:00:00 │ VSTO │ 14563.20 │ AMMUNITION FOR TRAINING FOR SIU CLASSES │ DEPARTMENT OF JUSTICE (DOJ) │ +├─────────────────────┼────────┼───────────┼────────────────────────────────────────────────────┼───────────────────────────────────────┤ +│ 2022-02-11 00:00:00 │ VSTO │ 680239.08 │ 556M RH JACKETED FRANGIBLE AMMUNITION PN Z556AA40 │ DEPARTMENT OF HOMELAND SECURITY (DHS) │ +│ │ │ │ (DOD VERSION OF PN BC556X1) │ │ +├─────────────────────┼────────┼───────────┼────────────────────────────────────────────────────┼───────────────────────────────────────┤ +│ 2022-02-11 00:00:00 │ VSTO │ 1070.18 │ AMMUNITION ORDER - D45 W/MO │ DEPARTMENT OF JUSTICE (DOJ) │ +├─────────────────────┼────────┼───────────┼────────────────────────────────────────────────────┼───────────────────────────────────────┤ +│ 2022-02-11 00:00:00 │ VAR │ 712143.00 │ PREVENTATIVE MAINTENANCE AND REPAIRS OF VARIAN │ DEPARTMENT OF VETERANS AFFAIRS (VA) │ +│ │ │ │ LINEAR ACCELERATORS LOCATED AT THE LTC CHARLES S. │ │ +│ │ │ │ KETTLES VAMC │ │ +├─────────────────────┼────────┼───────────┼────────────────────────────────────────────────────┼───────────────────────────────────────┤ +│ 2022-02-11 00:00:00 │ VAR │ 298800.00 │ DATA HOSTING FOR VARIAN LINAC SOFTWARE │ DEPARTMENT OF VETERANS AFFAIRS (VA) │ +│ │ │ │ (ECLIPSE/ARIA) │ │ +├─────────────────────┼────────┼───────────┼────────────────────────────────────────────────────┼───────────────────────────────────────┤ +│ 2022-02-11 00:00:00 │ UPS │ 4500.00 │ EXPRESS MAIL AND COURIER SERVICES FOR THE COEUR │ DEPARTMENT OF AGRICULTURE (USDA) │ +│ │ │ │ D'ALENE NURSERY, ID │ │ +├─────────────────────┼────────┼───────────┼────────────────────────────────────────────────────┼───────────────────────────────────────┤ +│ 2022-02-11 00:00:00 │ TTEK │ 215214.00 │ SUPERFUND TECHNICAL ASSESSMENT & RESPONSE TEAM 5 │ ENVIRONMENTAL PROTECTION AGENCY (EPA) │ +│ │ │ │ (START V) CONTRACT FOR EPA REGION 7 - SITE/PROJECT │ │ +│ │ │ │ NAME: NEBRASKA SITE ASSESSMENTS. │ │ +├─────────────────────┼────────┼───────────┼────────────────────────────────────────────────────┼───────────────────────────────────────┤ +│ 2022-02-11 00:00:00 │ TTEK │ 65468.54 │ SUPERFUND TECHNICAL ASSESSMENT & RESPONSE TEAM 5 │ ENVIRONMENTAL PROTECTION AGENCY (EPA) │ +│ │ │ │ (START V) CONTRACT FOR EPA REGION 7 - SITE/PROJECT │ │ +│ │ │ │ NAME: FABALL ABANDONED CONTAINER. │ │ +├─────────────────────┼────────┼───────────┼────────────────────────────────────────────────────┼───────────────────────────────────────┤ +│ 2022-02-11 00:00:00 │ TTEK │ 60769.52 │ SUPERFUND TECHNICAL ASSESSMENT & RESPONSE TEAM 5 │ ENVIRONMENTAL PROTECTION AGENCY (EPA) │ +│ │ │ │ (START V) CONTRACT FOR EPA REGION 7 - SITE/PROJECT │ │ +│ │ │ │ NAME: 10TH STREET SITE ASSESSMENT IN COLUMBUS, NE. │ │ +├─────────────────────┼────────┼───────────┼────────────────────────────────────────────────────┼───────────────────────────────────────┤ +│ 2022-02-11 00:00:00 │ TTEK │ 231856.02 │ SUPERFUND TECHNICAL ASSESSMENT & RESPONSE TEAM 5 │ ENVIRONMENTAL PROTECTION AGENCY (EPA) │ +│ │ │ │ (START V) CONTRACT FOR EPA REGION 7 - SITE/PROJECT │ │ +│ │ │ │ NAME: IOWA SITE ASSESSMENTS. │ │ +├─────────────────────┼────────┼───────────┼────────────────────────────────────────────────────┼───────────────────────────────────────┤ +│ 2022-02-11 00:00:00 │ T │ 9817.28 │ TELECOMMUNICATION SERVICES (JANUARY) │ DEPARTMENT OF JUSTICE (DOJ) │ +├─────────────────────┼────────┼───────────┼────────────────────────────────────────────────────┼───────────────────────────────────────┤ +│ 2022-02-11 00:00:00 │ T │ 187.49 │ LOCAL LONG DISTANCE PHONE SERVICE - 2ND QUARTER FY │ DEPARTMENT OF JUSTICE (DOJ) │ +│ │ │ │ 2022 │ │ +├─────────────────────┼────────┼───────────┼────────────────────────────────────────────────────┼───────────────────────────────────────┤ +│ 2022-02-11 00:00:00 │ SYY │ 88158.78 │ BASE FOOD ORDER TO REPLENISH THE WAREHOUSE. │ DEPARTMENT OF JUSTICE (DOJ) │ +├─────────────────────┼────────┼───────────┼────────────────────────────────────────────────────┼───────────────────────────────────────┤ +│ 2022-02-11 00:00:00 │ SYK │ 12938.43 │ HIP REPLACEMENT │ DEPARTMENT OF VETERANS AFFAIRS (VA) │ +├─────────────────────┼────────┼───────────┼────────────────────────────────────────────────────┼───────────────────────────────────────┤ +│ 2022-02-11 00:00:00 │ SYK │ 43282.32 │ STRYKER NEPTUNE SERVICES │ DEPARTMENT OF VETERANS AFFAIRS (VA) │ +├─────────────────────┼────────┼───────────┼────────────────────────────────────────────────────┼───────────────────────────────────────┤ +│ 2022-02-11 00:00:00 │ SO │ 4697.51 │ TO PROVIDE NON-PERSONAL SERVICE TO REPAIR FDC AT │ GENERAL SERVICES ADMINISTRATION (GSA) │ +│ │ │ │ THE CUSTOM HOUSE (GSA BLDG. NO. TX0101ZZ), LOCATED │ │ +│ │ │ │ AT 701 SAN JACINTO STREET, HOUSTON, TX 77002-3673. │ │ +├─────────────────────┼────────┼───────────┼────────────────────────────────────────────────────┼───────────────────────────────────────┤ +│ 2022-02-11 00:00:00 │ NOC │ 416297.80 │ THE PURPOSE OF THIS CALL ORDER IS FOR THE │ SOCIAL SECURITY ADMINISTRATION (SSA) │ +│ │ │ │ CONTRACTOR TO PROVIDE DATA COLLECTION & ANALYTICS │ │ +│ │ │ │ (M-21-31 ENTERPRISE LOGGING ONBOARDING SUPPORT) │ │ +│ │ │ │ SERVICES. │ │ +└─────────────────────┴────────┴───────────┴────────────────────────────────────────────────────┴───────────────────────────────────────┘ +``` +--- diff --git a/website/content/terminal/reference/stocks/gov/lasttrades.md b/website/content/terminal/reference/stocks/gov/lasttrades.md new file mode 100644 index 000000000000..0deceb9ca4cc --- /dev/null +++ b/website/content/terminal/reference/stocks/gov/lasttrades.md @@ -0,0 +1,111 @@ +--- +title: lasttrades +description: This page presents 'lasttrades', a comprehensive tool providing details + on the last government trades. It provides usage, parameters, and examples on how + to retrieve and understand transaction data. +keywords: +- lasttrades +- government trades +- transaction data +- trade parameters +- usage examples +- congress transactions +- senate trades +- house trades +- Quiver Quant +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Last government trades. [Source: www.quiverquant.com] + +### Usage + +```python +lasttrades [-g {congress,senate,house}] [-p PAST_TRANSACTIONS_DAYS] [-r REPRESENTATIVE] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| gov | | congress | True | congress, senate, house | +| past_transactions_days | Past transaction days | 5 | True | None | +| representative | Representative | | True | None | + + +--- + +## Examples + +```python +2022 Feb 16, 07:24 (🦋) /stocks/gov/ $ lasttrades + +Last transactions for CONGRESS + + Representative Trading +┏━━━━━━━━━━━━━━━━━━┳━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━┓ +┃ Transaction Date ┃ Ticker ┃ Representative ┃ Transaction ┃ Range ┃ House ┃ Report Date ┃ +┡━━━━━━━━━━━━━━━━━━╇━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━┩ +│ 2022-02-09 │ AM │ Mark Dr Green │ Sale │ $1,000,001-$5,000,000 │ Representatives │ 2022-02-14 │ +├──────────────────┼────────┼───────────────────────────┼─────────────┼───────────────────────┼─────────────────┼─────────────┤ +│ 2022-02-09 │ QQQ │ Pete Sessions │ Purchase │ $1,001-$15,000 │ Representatives │ 2022-02-11 │ +├──────────────────┼────────┼───────────────────────────┼─────────────┼───────────────────────┼─────────────────┼─────────────┤ +│ 2022-02-09 │ ET │ Mark Dr Green │ Purchase │ $500,001 │ Representatives │ 2022-02-14 │ +├──────────────────┼────────┼───────────────────────────┼─────────────┼───────────────────────┼─────────────────┼─────────────┤ +│ 2022-02-09 │ ENLC │ Mark Dr Green │ Purchase │ $500,001 │ Representatives │ 2022-02-14 │ +├──────────────────┼────────┼───────────────────────────┼─────────────┼───────────────────────┼─────────────────┼─────────────┤ +│ 2022-02-07 │ ET │ Mark Dr Green │ Purchase │ $250,001-$1,000,000 │ Representatives │ 2022-02-14 │ +├──────────────────┼────────┼───────────────────────────┼─────────────┼───────────────────────┼─────────────────┼─────────────┤ +│ 2022-02-07 │ AM │ Mark Dr Green │ Purchase │ $100,001-250,000 │ Representatives │ 2022-02-14 │ +├──────────────────┼────────┼───────────────────────────┼─────────────┼───────────────────────┼─────────────────┼─────────────┤ +│ 2022-02-04 │ BNS │ Pete Sessions │ Purchase │ $1,001-$15,000 │ Representatives │ 2022-02-11 │ +├──────────────────┼────────┼───────────────────────────┼─────────────┼───────────────────────┼─────────────────┼─────────────┤ +│ 2022-02-02 │ GOOGL │ Bob Gibbs │ Purchase │ $15,001-$50,000 │ Representatives │ 2022-02-06 │ +├──────────────────┼────────┼───────────────────────────┼─────────────┼───────────────────────┼─────────────────┼─────────────┤ +│ 2022-01-31 │ FSP │ Virginia Foxx │ Sale │ $50,001-$100,000 │ Representatives │ 2022-02-04 │ +├──────────────────┼────────┼───────────────────────────┼─────────────┼───────────────────────┼─────────────────┼─────────────┤ +│ 2022-01-31 │ FIMKX │ Thomas R. Carper │ Sale │ $1,001 - $15,000 │ Senate │ 2022-02-03 │ +├──────────────────┼────────┼───────────────────────────┼─────────────┼───────────────────────┼─────────────────┼─────────────┤ +│ 2022-01-31 │ CEF │ Thomas R. Carper │ Sale │ $1,001 - $15,000 │ Senate │ 2022-02-03 │ +├──────────────────┼────────┼───────────────────────────┼─────────────┼───────────────────────┼─────────────────┼─────────────┤ +│ 2022-01-31 │ PTMC │ Thomas R. Carper │ Sale │ $1,001 - $15,000 │ Senate │ 2022-02-03 │ +├──────────────────┼────────┼───────────────────────────┼─────────────┼───────────────────────┼─────────────────┼─────────────┤ +│ 2022-01-31 │ MOO │ Thomas R. Carper │ Purchase │ $1,001 - $15,000 │ Senate │ 2022-02-03 │ +├──────────────────┼────────┼───────────────────────────┼─────────────┼───────────────────────┼─────────────────┼─────────────┤ +│ 2022-01-31 │ ITA │ Thomas R. Carper │ Purchase │ $1,001 - $15,000 │ Senate │ 2022-02-03 │ +├──────────────────┼────────┼───────────────────────────┼─────────────┼───────────────────────┼─────────────────┼─────────────┤ +│ 2022-01-31 │ JHMM │ Thomas R. Carper │ Purchase │ $1,001 - $15,000 │ Senate │ 2022-02-03 │ +├──────────────────┼────────┼───────────────────────────┼─────────────┼───────────────────────┼─────────────────┼─────────────┤ +│ 2022-01-31 │ GNR │ Thomas R. Carper │ Purchase │ $1,001 - $15,000 │ Senate │ 2022-02-03 │ +├──────────────────┼────────┼───────────────────────────┼─────────────┼───────────────────────┼─────────────────┼─────────────┤ +│ 2022-01-31 │ WIW │ Thomas R. Carper │ Purchase │ $1,001 - $15,000 │ Senate │ 2022-02-03 │ +├──────────────────┼────────┼───────────────────────────┼─────────────┼───────────────────────┼─────────────────┼─────────────┤ +│ 2022-01-31 │ XAR │ Thomas R. Carper │ Sale │ $1,001 - $15,000 │ Senate │ 2022-02-03 │ +├──────────────────┼────────┼───────────────────────────┼─────────────┼───────────────────────┼─────────────────┼─────────────┤ +│ 2022-01-31 │ SI │ Thomas R. Carper │ Purchase │ $1,001 - $15,000 │ Senate │ 2022-02-03 │ +├──────────────────┼────────┼───────────────────────────┼─────────────┼───────────────────────┼─────────────────┼─────────────┤ +│ 2022-01-31 │ LUBFX │ Thomas R. Carper │ Sale │ $1,001 - $15,000 │ Senate │ 2022-02-03 │ +├──────────────────┼────────┼───────────────────────────┼─────────────┼───────────────────────┼─────────────────┼─────────────┤ +│ 2022-01-31 │ GEMIX │ Thomas R. Carper │ Sale │ $1,001 - $15,000 │ Senate │ 2022-02-03 │ +├──────────────────┼────────┼───────────────────────────┼─────────────┼───────────────────────┼─────────────────┼─────────────┤ +│ 2022-01-31 │ D │ Pete Sessions │ Sale │ $1,001-$15,000 │ Representatives │ 2022-02-11 │ +├──────────────────┼────────┼───────────────────────────┼─────────────┼───────────────────────┼─────────────────┼─────────────┤ +│ 2022-01-31 │ CYRX │ Donald Sternoff Beyer Jr. │ Sale │ $1,001-$15,000 │ Representatives │ 2022-02-01 │ +├──────────────────┼────────┼───────────────────────────┼─────────────┼───────────────────────┼─────────────────┼─────────────┤ +│ 2022-01-31 │ TRNO │ Donald Sternoff Beyer Jr. │ Purchase │ $1,001-$15,000 │ Representatives │ 2022-02-01 │ +├──────────────────┼────────┼───────────────────────────┼─────────────┼───────────────────────┼─────────────────┼─────────────┤ +│ 2022-01-31 │ PEP │ Donald Sternoff Beyer Jr. │ Purchase │ $1,001-$15,000 │ Representatives │ 2022-02-01 │ +├──────────────────┼────────┼───────────────────────────┼─────────────┼───────────────────────┼─────────────────┼─────────────┤ +│ 2022-01-31 │ COST │ Donald Sternoff Beyer Jr. │ Purchase │ $1,001-$15,000 │ Representatives │ 2022-02-01 │ +├──────────────────┼────────┼───────────────────────────┼─────────────┼───────────────────────┼─────────────────┼─────────────┤ +│ 2022-01-31 │ JPM │ Kevin Hern │ Purchase │ $1,001-$15,000 │ Representatives │ 2022-02-02 │ +├──────────────────┼────────┼───────────────────────────┼─────────────┼───────────────────────┼─────────────────┼─────────────┤ +│ 2022-01-31 │ NVDA │ Thomas R. Carper │ Purchase │ $1,001 - $15,000 │ Senate │ 2022-02-03 │ +└──────────────────┴────────┴───────────────────────────┴─────────────┴───────────────────────┴─────────────────┴─────────────┘ +``` +--- diff --git a/website/content/terminal/reference/stocks/gov/load.md b/website/content/terminal/reference/stocks/gov/load.md new file mode 100644 index 000000000000..dfd0b9c89110 --- /dev/null +++ b/website/content/terminal/reference/stocks/gov/load.md @@ -0,0 +1,50 @@ +--- +title: load +description: This page provides comprehensive instructions and details on how to load + stock ticker for market analysis, using various parameters. Details on how to choose + the starting and ending date, intraday stock minutes, pre and post market hours + are provided. There are also instructions on how to load custom files and specific + frequency data such as monthly or weekly. +keywords: +- stock ticker +- market analysis +- intraday stock +- prepost market +- load stock data +- analysis parameters +- data frequency +- load custom file +- SBIN.NS +- Indian ticker +- monthly data +- weekly data +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Load stock ticker to perform analysis on. When the data source is syf', an Indian ticker can be loaded by using '.NS' at the end, e.g. 'SBIN.NS'. See available market in https://help.yahoo.com/kb/exchanges-data-providers-yahoo-finance-sln2310.html. + +### Usage + +```python +load -t TICKER [-s START] [-e END] [-i {1,5,15,30,60}] [-p] [-f FILEPATH] [-m] [-w] [-r {ytd,1y,2y,5y,6m}] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| ticker | Stock ticker | None | False | None | +| start | The starting date (format YYYY-MM-DD) of the stock | 2019-11-21 | True | None | +| end | The ending date (format YYYY-MM-DD) of the stock | 2022-11-25 | True | None | +| interval | Intraday stock minutes | 1440 | True | 1, 5, 15, 30, 60 | +| prepost | Pre/After market hours. Only works for 'yf' source, and intraday data | False | True | None | +| filepath | Path to load custom file. | None | True | None | +| monthly | Load monthly data | False | True | None | +| weekly | Load weekly data | False | True | None | + +--- diff --git a/website/content/terminal/reference/stocks/gov/lobbying.md b/website/content/terminal/reference/stocks/gov/lobbying.md new file mode 100644 index 000000000000..14167e54bea5 --- /dev/null +++ b/website/content/terminal/reference/stocks/gov/lobbying.md @@ -0,0 +1,73 @@ +--- +title: lobbying +description: This lobbying documentation page provides lobbying details for Tesla + Inc. The content includes content related to the Electric Vehicle Tax Credit, Driving + America Forward Act, Energy Storage Tax Incentive and Deployment Act, and more. + The data is provided by Quiver Quant and represented in Python syntax. +keywords: +- Lobbying +- Tesla Inc +- Electric Vehicle Tax Credit +- Driving America Forward Act +- Storage Tax Credit +- Energy Storage Tax Incentive and Deployment Act +- Quiver Quant +- Gov Stock Politics +- Python Usage +- Coronavirus Aid, Relief, and Economic Security Act +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Lobbying details [Source: www.quiverquant.com] + +### Usage + +```python +lobbying [-l LIMIT] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| limit | Limit of events to show | 10 | True | None | + + +--- + +## Examples + +```python +2022 Feb 16, 07:27 (🦋) /stocks/gov/ $ lobbying +2021-01-21: TESLA INC N/A + +2020-10-20: TESLA INC N/A + +2020-10-20: TESLA INC N/A + +2020-07-20: TESLA INC $70000 + Discussions regarding Sec. 30D electric vehicle tax credit (S.1094/H.R.2256, the Driving America Forward Act) Sec. 30C alternative fuel infrastructure tax credit(S.3735, Securing America's Clean Fuel Infrastructure Act) Sec. 48 and 25D solar investment tax credit Storage tax credit (S.1142/H.R.2096,Energy Storage Tax Incentive and Deployment Act) + +2020-07-19: TESLA INC N/A + +2020-04-20: TESLA INC $140000 + H.R.748/S.3548, Coronavirus Aid, Relief, and Economic Security Act + +2020-04-20: TESLA INC $30000 + Issues related to the 30D EV tax credit, including the Driving America Forward Act, S. 1094 and H.R. 2256. + +2020-01-21: TESLA INC $150000 + Discussions regarding Sec. 30D electric vehicle tax credit (S.1094/H.R.2256, the Driving America Forward Act) Sec. 30C alternative tax credit (H.R.3301, the Taxpayer Certainty and Disaster Tax Relief Act) Sec. 48 and 25D solar investment tax credits (H.R.3961/S.2289, Renewable Energy Extension Act) Storage tax credit (S.1142/H.R.2096,Energy Storage Tax Incentive and Deployment Act) H.R.1865, Further Consolidated Appropriations Act, 2020 + +2020-01-17: TESLA INC $30000 + Issues related to the 30D EV tax credit, including the Driving America Forward Act, S. 1094 and H.R. 2256. + +2019-10-21: TESLA INC $150000 + Discussions regarding electric vehicle manufacturing and sales policies,charging infrastructure and regulation (S.2302, America's Transportation and Infrastruction Act;H.R.2616/S.674, Clean Corridors Act) Issues impacting autonomous vehicles +``` +--- diff --git a/website/content/terminal/reference/stocks/gov/qtrcontracts.md b/website/content/terminal/reference/stocks/gov/qtrcontracts.md new file mode 100644 index 000000000000..ba60222db2bd --- /dev/null +++ b/website/content/terminal/reference/stocks/gov/qtrcontracts.md @@ -0,0 +1,93 @@ +--- +title: qtrcontracts +description: The qtrcontracts page provides a comprehensive guide on how to view and + analyze government contracts data using Quiver Quantitative. The guide includes + usage parameters, examples, and options for analysis such as total contracts, highest + sloped contracts, and highest decreasing slopes. +keywords: +- qtrcontracts +- government contracts +- Quiver Quantitative +- stock market analysis +- tickers +- total contracts +- highest sloped contracts +- highest decreasing slopes +- raw data +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Look at government contracts [Source: www.quiverquant.com] + +### Usage + +```python +qtrcontracts [-l LIMIT] [-a {total,upmom,downmom}] [--raw] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| limit | Limit of tickers to get | 5 | True | None | +| analysis | Analysis to look at contracts. 'Total' shows summed contracts. 'Upmom' shows highest sloped contacts while 'downmom' shows highest decreasing slopes. | total | True | total, upmom, downmom | +| raw | Print raw data. | False | True | None | + + +--- + +## Examples + +```python +2022 Feb 16, 07:33 (🦋) /stocks/gov/ $ qtrcontracts -l 20 + Quarterly Contracts +┏━━━━━━┳━━━━━━━━━━━━━━━━━┓ +┃ ┃ Total ┃ +┡━━━━━━╇━━━━━━━━━━━━━━━━━┩ +│ NYRT │ 189265686585.09 │ +├──────┼─────────────────┤ +│ LMT │ 70707036450.10 │ +├──────┼─────────────────┤ +│ BA │ 36291094000.97 │ +├──────┼─────────────────┤ +│ RTX │ 30810798491.64 │ +├──────┼─────────────────┤ +│ NOC │ 18155712025.66 │ +├──────┼─────────────────┤ +│ MCK │ 15593287674.59 │ +├──────┼─────────────────┤ +│ AAL │ 12873580340.33 │ +├──────┼─────────────────┤ +│ DAL │ 12053655150.25 │ +├──────┼─────────────────┤ +│ GD │ 11113338870.17 │ +├──────┼─────────────────┤ +│ UAL │ 10937247542.42 │ +├──────┼─────────────────┤ +│ HUM │ 10433454331.45 │ +├──────┼─────────────────┤ +│ FLR │ 7630289754.85 │ +├──────┼─────────────────┤ +│ SO │ 7451534354.06 │ +├──────┼─────────────────┤ +│ LUV │ 7218696161.20 │ +├──────┼─────────────────┤ +│ MRNA │ 6233021716.31 │ +├──────┼─────────────────┤ +│ PFE │ 5717928167.45 │ +├──────┼─────────────────┤ +│ SSB │ 5122966968.19 │ +├──────┼─────────────────┤ +│ GE │ 4973975130.38 │ +├──────┼─────────────────┤ +│ EXPR │ 4617652107.41 │ +├──────┼─────────────────┤ +│ PW │ 4466721029.89 │ +└──────┴─────────────────┘ +``` +--- diff --git a/website/content/terminal/reference/stocks/gov/topbuys.md b/website/content/terminal/reference/stocks/gov/topbuys.md new file mode 100644 index 000000000000..137561248ef3 --- /dev/null +++ b/website/content/terminal/reference/stocks/gov/topbuys.md @@ -0,0 +1,41 @@ +--- +title: topbuys +description: Explore top buys for government trading. Discover how to use the 'topbuys' + feature, including parameter selection for congress, senate and house, past transactions, + and more for optimized use. Enhance your trading strategies today with quiverquant. +keywords: +- government trading +- topbuys +- congress +- senate +- house +- past transactions +- quiverquant +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Top buys for government trading. [Source: www.quiverquant.com] + +### Usage + +```python +topbuys [-g {congress,senate,house}] [-p PAST_TRANSACTIONS_MONTHS] [-l LIMIT] [--raw] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| gov | | congress | True | congress, senate, house | +| past_transactions_months | Past transaction months | 6 | True | None | +| limit | Limit of top tickers to display | 10 | True | None | +| raw | Print raw data. | False | True | None | + +![topbuys](https://user-images.githubusercontent.com/46355364/154266344-944b0c5b-f7b0-4fdb-a020-a93565f6c13c.png) + +--- diff --git a/website/content/terminal/reference/stocks/gov/toplobbying.md b/website/content/terminal/reference/stocks/gov/toplobbying.md new file mode 100644 index 000000000000..a366b5434bd4 --- /dev/null +++ b/website/content/terminal/reference/stocks/gov/toplobbying.md @@ -0,0 +1,39 @@ +--- +title: toplobbying +description: Toplobbying is an efficient tool to monitor lobbying activities. It allows + users to specify a limit for the number of stocks to display and choose to print + raw data. +keywords: +- toplobbying +- lobbying tool +- stocks +- limit stocks +- raw data +- display stocks +- quiverquant +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Top lobbying. [Source: www.quiverquant.com] + +### Usage + +```python +toplobbying [-l LIMIT] [--raw] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| limit | Limit of stocks to display | 10 | True | None | +| raw | Print raw data. | False | True | None | + +![toplobbying](https://user-images.githubusercontent.com/46355364/154266510-5e46cafe-f4b6-4fa2-9b87-6ae5e1f1a726.png) + +--- diff --git a/website/content/terminal/reference/stocks/gov/topsells.md b/website/content/terminal/reference/stocks/gov/topsells.md new file mode 100644 index 000000000000..cdcdf7e70fe7 --- /dev/null +++ b/website/content/terminal/reference/stocks/gov/topsells.md @@ -0,0 +1,43 @@ +--- +title: topsells +description: The page provides information on the top sells in government trading. + Understand how to use different options like governing body, limit of top tickers, + past transaction months and others to filter the information. +keywords: +- government trading +- top sells +- congress +- senate +- house +- past transactions months +- limit of top tickers +- print raw data +- quiverquant +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Top sells for government trading. [Source: www.quiverquant.com] + +### Usage + +```python +topsells [-g {congress,senate,house}] [-p PAST_TRANSACTIONS_MONTHS] [-l LIMIT] [--raw] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| gov | | congress | True | congress, senate, house | +| past_transactions_months | Past transaction months | 6 | True | None | +| limit | Limit of top tickers to display | 10 | True | None | +| raw | Print raw data. | False | True | None | + +![topsells](https://user-images.githubusercontent.com/46355364/154266942-4ee9c83a-39be-4aab-8a06-01b6850f5bd9.png) + +--- diff --git a/website/versioned_docs/version-v3/terminal/reference/stocks/ins/_category_.json b/website/content/terminal/reference/stocks/ins/_category_.json similarity index 100% rename from website/versioned_docs/version-v3/terminal/reference/stocks/ins/_category_.json rename to website/content/terminal/reference/stocks/ins/_category_.json diff --git a/website/content/terminal/reference/stocks/ins/act.md b/website/content/terminal/reference/stocks/ins/act.md new file mode 100644 index 000000000000..bc7c6d2b29b4 --- /dev/null +++ b/website/content/terminal/reference/stocks/ins/act.md @@ -0,0 +1,35 @@ +--- +title: act +description: The page provides a guide on the usage of 'act', a tool that enables + users to print insider business activity over time. It also outlines the parameters + like 'raw' providing a flexibility to print raw data. +keywords: +- act +- Insider activity +- Business Insider +- raw data +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Prints insider activity over time [Source: Business Insider] + +### Usage + +```python +act [--raw] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| raw | Print raw data. | False | True | None | + +![act](https://user-images.githubusercontent.com/46355364/154267227-6116e314-9186-4566-a977-01f85a99646f.png) + +--- diff --git a/website/versioned_docs/version-v3/terminal/reference/stocks/ins/blcp.md b/website/content/terminal/reference/stocks/ins/blcp.md similarity index 95% rename from website/versioned_docs/version-v3/terminal/reference/stocks/ins/blcp.md rename to website/content/terminal/reference/stocks/ins/blcp.md index baa73994b67c..78ee89986ed3 100644 --- a/website/versioned_docs/version-v3/terminal/reference/stocks/ins/blcp.md +++ b/website/content/terminal/reference/stocks/ins/blcp.md @@ -1,9 +1,21 @@ --- title: blcp -description: OpenBB Terminal Function +description: This page provides comprehensive instructions for using the 'blcp' feature + which displays the latest CEO/CFO purchases. It includes details on the usage, parameters, + and real-time examples. +keywords: +- blcp usage +- CEO/CFO purchases +- limit parameters +- OpenInsider source +- Insider data +- Trade details +- Python usage examples --- -# blcp +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + Print latest CEO/CFO purchases 25k. [Source: OpenInsider] diff --git a/website/versioned_docs/version-v3/terminal/reference/stocks/ins/blcs.md b/website/content/terminal/reference/stocks/ins/blcs.md similarity index 96% rename from website/versioned_docs/version-v3/terminal/reference/stocks/ins/blcs.md rename to website/content/terminal/reference/stocks/ins/blcs.md index fedccafc8411..9cf73a1e79fb 100644 --- a/website/versioned_docs/version-v3/terminal/reference/stocks/ins/blcs.md +++ b/website/content/terminal/reference/stocks/ins/blcs.md @@ -1,9 +1,20 @@ --- title: blcs -description: OpenBB Terminal Function +description: This page is about 'blcs', a tool that is used to print the latest CEO/CFO + sales 100k using data from OpenInsider. It displays insider data in a tabular format, + with options to limit data rows. +keywords: +- OpenInsider +- blcs +- CEO/CFO sales +- Insider Data +- Python tool +- Stocks --- -# blcs +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + Print latest CEO/CFO sales 100k. [Source: OpenInsider] diff --git a/website/versioned_docs/version-v3/terminal/reference/stocks/ins/blip.md b/website/content/terminal/reference/stocks/ins/blip.md similarity index 94% rename from website/versioned_docs/version-v3/terminal/reference/stocks/ins/blip.md rename to website/content/terminal/reference/stocks/ins/blip.md index 4a36d7c99dd1..f4387ebe221b 100644 --- a/website/versioned_docs/version-v3/terminal/reference/stocks/ins/blip.md +++ b/website/content/terminal/reference/stocks/ins/blip.md @@ -1,9 +1,32 @@ --- title: blip -description: OpenBB Terminal Function +description: This page enables usage of the 'blip' command, a tool for printing the + latest insider purchases 25k, sourced from OpenInsider. The usage, parameters, and + examples are provided to give an understanding on how to use this command effectively + to access insider trade data such as company name, insider name, trade type, price, + quantity, owned, value, etc. +keywords: +- blip +- Insider Purchases +- OpenInsider +- stocks +- Trade Data +- Company Name +- Insider Name +- Trade Type +- Price +- Qty +- Value +- Title +- Owned +- Diff Own +- Data Display +- Limit Parameter --- -# blip +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + Print latest insider purchases 25k. [Source: OpenInsider] diff --git a/website/versioned_docs/version-v3/terminal/reference/stocks/ins/blis.md b/website/content/terminal/reference/stocks/ins/blis.md similarity index 95% rename from website/versioned_docs/version-v3/terminal/reference/stocks/ins/blis.md rename to website/content/terminal/reference/stocks/ins/blis.md index f9e2f60c54f5..7c1314a869e8 100644 --- a/website/versioned_docs/version-v3/terminal/reference/stocks/ins/blis.md +++ b/website/content/terminal/reference/stocks/ins/blis.md @@ -1,9 +1,22 @@ --- title: blis -description: OpenBB Terminal Function +description: This page describes how to use the blis command to print out the latest + insider sales 100k from the OpenInsider source. It includes instructions on how + to limit the number of results and gives examples of use cases. +keywords: +- blis command +- print latest insider sales +- OpenInsider source +- limit results +- use cases +- command usage +- data display +- data rows --- -# blis +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + Print latest insider sales 100k. [Source: OpenInsider] diff --git a/website/versioned_docs/version-v3/terminal/reference/stocks/ins/blop.md b/website/content/terminal/reference/stocks/ins/blop.md similarity index 94% rename from website/versioned_docs/version-v3/terminal/reference/stocks/ins/blop.md rename to website/content/terminal/reference/stocks/ins/blop.md index 46430bcd32de..c750c59ffc81 100644 --- a/website/versioned_docs/version-v3/terminal/reference/stocks/ins/blop.md +++ b/website/content/terminal/reference/stocks/ins/blop.md @@ -1,9 +1,27 @@ --- title: blop -description: OpenBB Terminal Function +description: 'Documentation for ''blop'': a tool for displaying the latest officer + purchases in the stock market. The documentation covers usage, parameters, and provides + examples of insider data results including company and insider name, trade type, + price, quantity, ownership changes, and value.' +keywords: +- blop +- officer purchases +- stock market +- insider data +- trade type +- purchase +- company name +- insider name +- price +- quantity +- ownership +- value --- -# blop +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + Print latest officer purchases 25k. [Source: OpenInsider] diff --git a/website/versioned_docs/version-v3/terminal/reference/stocks/ins/blos.md b/website/content/terminal/reference/stocks/ins/blos.md similarity index 94% rename from website/versioned_docs/version-v3/terminal/reference/stocks/ins/blos.md rename to website/content/terminal/reference/stocks/ins/blos.md index bc8e103f2831..ac0351f4a534 100644 --- a/website/versioned_docs/version-v3/terminal/reference/stocks/ins/blos.md +++ b/website/content/terminal/reference/stocks/ins/blos.md @@ -1,9 +1,34 @@ --- title: blos -description: OpenBB Terminal Function +description: This Blos command page provides information on how to display the latest + officer sales 100k. It gives a detailed explanation of parameters, default values + and choices. It also provides clear examples, describing the output format and each + field's meaning. +keywords: +- blos command +- officer sales +- OpenInsider +- datarows display +- command usage +- parameters +- derivative transaction +- multiple transactions +- filing date +- trade date +- company name +- insider name +- title +- trade type +- price +- quantity +- owned +- diff own +- value --- -# blos +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + Print latest officer sales 100k. [Source: OpenInsider] diff --git a/website/versioned_docs/version-v3/terminal/reference/stocks/ins/filter.md b/website/content/terminal/reference/stocks/ins/filter.md similarity index 92% rename from website/versioned_docs/version-v3/terminal/reference/stocks/ins/filter.md rename to website/content/terminal/reference/stocks/ins/filter.md index adae16d45d4a..e7f8ec9fcc64 100644 --- a/website/versioned_docs/version-v3/terminal/reference/stocks/ins/filter.md +++ b/website/content/terminal/reference/stocks/ins/filter.md @@ -1,9 +1,23 @@ --- title: filter -description: OpenBB Terminal Function +description: Optimize your open insider data using the filter function. This guide + provides details on its usage, parameters, and examples, instructing users on how + to limit data rows and configure hyperlinks to meet their needs. Learn how to navigate + through stock market transactions, including sales and derivative transactions efficiently. +keywords: +- OpenInsider +- filter +- insider filtered data +- derivative transaction +- securities +- stock market +- stock transactions +- data display --- -# filter +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + Print open insider filtered data using loaded preset. [Source: OpenInsider] diff --git a/website/versioned_docs/version-v3/terminal/reference/stocks/ins/lcb.md b/website/content/terminal/reference/stocks/ins/lcb.md similarity index 95% rename from website/versioned_docs/version-v3/terminal/reference/stocks/ins/lcb.md rename to website/content/terminal/reference/stocks/ins/lcb.md index 85ce69276969..35885a10b9fd 100644 --- a/website/versioned_docs/version-v3/terminal/reference/stocks/ins/lcb.md +++ b/website/content/terminal/reference/stocks/ins/lcb.md @@ -1,9 +1,26 @@ --- title: lcb -description: OpenBB Terminal Function +description: This page documents the usage of the lcb function, which is a Python + command to print the latest cluster buys in the stock market. It includes details + about the parameters used and provides examples of how to use it effectively. The + information is sourced from OpenInsider. +keywords: +- lcb +- cluster buys +- openinsider +- python code +- code usage +- parameters +- data rows +- limit +- stock market +- stock data +- insider data --- -# lcb +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + Print latest cluster buys. [Source: OpenInsider] diff --git a/website/content/terminal/reference/stocks/ins/lins.md b/website/content/terminal/reference/stocks/ins/lins.md new file mode 100644 index 000000000000..75a7d2b73f80 --- /dev/null +++ b/website/content/terminal/reference/stocks/ins/lins.md @@ -0,0 +1,71 @@ +--- +title: lins +description: 'The lins page provides detailed insight into insider trading activity. + It includes fields like Date, Relationship, Transaction, #Shares, Cost, Value ($), + #Shares Total, Insider Trading, SEC Form 4. This tool functions as a vital resource + for tracking insider trading data.' +keywords: +- lins +- inside traders +- insider trading +- SEC Form 4 +- Finviz +- stock market +- stock trading +- financial information +- trading data +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Prints information about inside traders. The following fields are expected: Date, Relationship, Transaction, #Shares, Cost, Value ($), #Shares Total, Insider Trading, SEC Form 4. [Source: Finviz] + +### Usage + +```python +lins [-l LIMIT] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| limit | Limit of latest inside traders. | 10 | True | None | + + +--- + +## Examples + +```python +2022 Feb 16, 07:54 (🦋) /stocks/ins/ $ lins + Insider Activity +┏━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━┳━━━━━━━━━━━┳━━━━━━━━┳━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━┓ +┃ ┃ Relationship ┃ Transaction ┃ #Shares ┃ Cost ┃ Value ($) ┃ #Shares Total ┃ Insider Trading ┃ SEC Form 4 ┃ +┡━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━╇━━━━━━━━━━━╇━━━━━━━━╇━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━┩ +│ Feb 03 │ SVP, GC and Secretary │ Sale │ 25,000 │ 174.78 │ 4,369,548 │ 419,715 │ Adams Katherine L. │ Feb 07 06:30 PM │ +├────────┼──────────────────────────────┼─────────────┼───────────┼────────┼─────────────┼───────────────┼────────────────────┼─────────────────┤ +│ Feb 01 │ Director │ Sale │ 1,986 │ 173.29 │ 344,154 │ 4,532,724 │ LEVINSON ARTHUR D │ Feb 03 06:35 PM │ +├────────┼──────────────────────────────┼─────────────┼───────────┼────────┼─────────────┼───────────────┼────────────────────┼─────────────────┤ +│ Nov 12 │ Principal Accounting Officer │ Sale │ 9,005 │ 150.00 │ 1,350,750 │ 37,197 │ KONDO CHRIS │ Nov 16 06:30 PM │ +├────────┼──────────────────────────────┼─────────────┼───────────┼────────┼─────────────┼───────────────┼────────────────────┼─────────────────┤ +│ Nov 01 │ SVP, GC and Secretary │ Sale │ 25,000 │ 148.68 │ 3,716,895 │ 447,993 │ Adams Katherine L. │ Nov 03 06:31 PM │ +├────────┼──────────────────────────────┼─────────────┼───────────┼────────┼─────────────┼───────────────┼────────────────────┼─────────────────┤ +│ Oct 19 │ Senior Vice President, CFO │ Sale │ 165,829 │ 148.62 │ 24,645,506 │ 110,501 │ Maestri Luca │ Oct 21 06:30 PM │ +├────────┼──────────────────────────────┼─────────────┼───────────┼────────┼─────────────┼───────────────┼────────────────────┼─────────────────┤ +│ Oct 18 │ Senior Vice President │ Sale │ 18,247 │ 146.35 │ 2,670,391 │ 136,118 │ O'BRIEN DEIRDRE │ Oct 19 06:31 PM │ +├────────┼──────────────────────────────┼─────────────┼───────────┼────────┼─────────────┼───────────────┼────────────────────┼─────────────────┤ +│ Oct 04 │ COO │ Sale │ 165,829 │ 138.83 │ 23,022,040 │ 489,490 │ WILLIAMS JEFFREY E │ Oct 05 06:44 PM │ +├────────┼──────────────────────────────┼─────────────┼───────────┼────────┼─────────────┼───────────────┼────────────────────┼─────────────────┤ +│ Oct 04 │ Senior Vice President │ Sale │ 89,437 │ 138.83 │ 12,416,539 │ 136,118 │ O'BRIEN DEIRDRE │ Oct 05 06:43 PM │ +├────────┼──────────────────────────────┼─────────────┼───────────┼────────┼─────────────┼───────────────┼────────────────────┼─────────────────┤ +│ Aug 25 │ Chief Executive Officer │ Sale │ 2,386,440 │ 148.58 │ 354,568,479 │ 3,279,726 │ COOK TIMOTHY D │ Aug 26 06:30 PM │ +├────────┼──────────────────────────────┼─────────────┼───────────┼────────┼─────────────┼───────────────┼────────────────────┼─────────────────┤ +│ Aug 06 │ Senior Vice President │ Sale │ 14,877 │ 145.99 │ 2,171,893 │ 136,118 │ O'BRIEN DEIRDRE │ Aug 09 06:30 PM │ +└────────┴──────────────────────────────┴─────────────┴───────────┴────────┴─────────────┴───────────────┴────────────────────┴─────────────────┘ +``` +--- diff --git a/website/versioned_docs/version-v3/terminal/reference/stocks/ins/lip.md b/website/content/terminal/reference/stocks/ins/lip.md similarity index 95% rename from website/versioned_docs/version-v3/terminal/reference/stocks/ins/lip.md rename to website/content/terminal/reference/stocks/ins/lip.md index 70c7b420fcb6..7560494a34cd 100644 --- a/website/versioned_docs/version-v3/terminal/reference/stocks/ins/lip.md +++ b/website/content/terminal/reference/stocks/ins/lip.md @@ -1,9 +1,21 @@ --- title: lip -description: OpenBB Terminal Function +description: Documentation for 'lip' command offers detailed instruction on its use + to track latest insider purchases in the stock market. It includes a demonstration + of its usage, parameter details, and real-life examples for user guidance. +keywords: +- latest insider purchases +- OpenInsider +- stock market +- trading +- stock transactions +- stock trading script +- data display --- -# lip +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + Print latest insider purchases. [Source: OpenInsider] diff --git a/website/versioned_docs/version-v3/terminal/reference/stocks/ins/lis.md b/website/content/terminal/reference/stocks/ins/lis.md similarity index 95% rename from website/versioned_docs/version-v3/terminal/reference/stocks/ins/lis.md rename to website/content/terminal/reference/stocks/ins/lis.md index 75baa7290934..1502f7ea194d 100644 --- a/website/versioned_docs/version-v3/terminal/reference/stocks/ins/lis.md +++ b/website/content/terminal/reference/stocks/ins/lis.md @@ -1,9 +1,22 @@ --- title: lis -description: OpenBB Terminal Function +description: Understand the usage of 'lis' function that prints latest insider sales + for stocks. You can limit the amount of datarows to be displayed. This comes from + OpenInsider source and can help understand Insider trading data. +keywords: +- Print latest insider sales +- OpenInsider +- Stocks +- Insider data +- Trading +- Stock markets +- Financial data +- Script --- -# lis +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + Print latest insider sales. [Source: OpenInsider] diff --git a/website/versioned_docs/version-v3/terminal/reference/stocks/ins/lit.md b/website/content/terminal/reference/stocks/ins/lit.md similarity index 94% rename from website/versioned_docs/version-v3/terminal/reference/stocks/ins/lit.md rename to website/content/terminal/reference/stocks/ins/lit.md index aa4e7b881d89..3f02f7b217c0 100644 --- a/website/versioned_docs/version-v3/terminal/reference/stocks/ins/lit.md +++ b/website/content/terminal/reference/stocks/ins/lit.md @@ -1,9 +1,29 @@ --- title: lit -description: OpenBB Terminal Function +description: This Docusaurus page provides access to the latest insider trading information. + With the lit function, users can limit the number of data rows to display and view + pertinent details like trade date, ticker, company name, insider name, title, trade + type, price, qty, owned, diff own and value. +keywords: +- Insider trading +- OpenInsider +- lit function +- data rows +- trade date +- company name +- insider name +- title +- trade type +- price +- qty +- owned +- diff own +- value --- -# lit +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + Print latest insider trading. [Source: OpenInsider] diff --git a/website/content/terminal/reference/stocks/ins/load.md b/website/content/terminal/reference/stocks/ins/load.md new file mode 100644 index 000000000000..238204ae0669 --- /dev/null +++ b/website/content/terminal/reference/stocks/ins/load.md @@ -0,0 +1,51 @@ +--- +title: load +description: This page provides clear instructions on how to load a stock ticker for + performing analysis, with special settings like loading an Indian ticker, defining + the timeframe, setting intraday minutes, including pre/after market hours, and more. + It also includes usage cases and available parameters. +keywords: +- stock ticker +- stock analysis +- DEAR systems +- stock data +- data analysis +- finance analysis +- Indian stock market +- trading parameters +- Yahoo Finance +- custom data file +- monthly data +- weekly data +- prepost market hours +- intraday stock +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Load stock ticker to perform analysis on. When the data source is syf', an Indian ticker can be loaded by using '.NS' at the end, e.g. 'SBIN.NS'. See available market in https://help.yahoo.com/kb/exchanges-data-providers-yahoo-finance-sln2310.html. + +### Usage + +```python +load -t TICKER [-s START] [-e END] [-i {1,5,15,30,60}] [-p] [-f FILEPATH] [-m] [-w] [-r {ytd,1y,2y,5y,6m}] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| ticker | Stock ticker | None | False | None | +| start | The starting date (format YYYY-MM-DD) of the stock | 2019-11-21 | True | None | +| end | The ending date (format YYYY-MM-DD) of the stock | 2022-11-25 | True | None | +| interval | Intraday stock minutes | 1440 | True | 1, 5, 15, 30, 60 | +| prepost | Pre/After market hours. Only works for 'yf' source, and intraday data | False | True | None | +| filepath | Path to load custom file. | None | True | None | +| monthly | Load monthly data | False | True | None | +| weekly | Load weekly data | False | True | None | + +--- diff --git a/website/versioned_docs/version-v3/terminal/reference/stocks/ins/lpsb.md b/website/content/terminal/reference/stocks/ins/lpsb.md similarity index 95% rename from website/versioned_docs/version-v3/terminal/reference/stocks/ins/lpsb.md rename to website/content/terminal/reference/stocks/ins/lpsb.md index 88dcdc8bfb40..4203becd591e 100644 --- a/website/versioned_docs/version-v3/terminal/reference/stocks/ins/lpsb.md +++ b/website/content/terminal/reference/stocks/ins/lpsb.md @@ -1,9 +1,23 @@ --- title: lpsb -description: OpenBB Terminal Function +description: The lpsb page provides a user guide on how to use the lpsb command to + print the latest penny stock buys. It shows parameters and usage examples, making + it easier for users to understand and use this function in their stock market analysis. +keywords: +- penny stocks +- stock buy +- lpsb command +- user guide +- stock analysis +- command usage +- data analysis +- stock market +- trade data --- -# lpsb +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + Print latest penny stock buys. [Source: OpenInsider] diff --git a/website/content/terminal/reference/stocks/ins/set.md b/website/content/terminal/reference/stocks/ins/set.md new file mode 100644 index 000000000000..06e7b6f2b10c --- /dev/null +++ b/website/content/terminal/reference/stocks/ins/set.md @@ -0,0 +1,33 @@ +--- +title: set +description: This page provides instructions on how to set presets from the presets + folder. Various industry filter presets are available to tailor your usage. +keywords: +- set preset +- presets folder +- filter presets +- python usage +- Industry presets +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Set preset from under presets folder. + +### Usage + +```python +set [-p Desired preset] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| preset | Filter presets | template | True | template, Retail-Trade, Pharmaceuticals, Investment-Offices, Railroads, Real-Estate, Tobacco, Ground-Freight, Personal-Credit, Business-Services, Insurance-Carriers, Restaurants, Grocery, Hotels, whales, Nondurable-Goods, Furniture, Retail-Stores, Air-Transportatio, Electronics, Guided-Missiles, Lumber, Insurance-Agents, Mining, Banks, Utility-Gas, Legal, Wholesale-Trade, Health, Closed-End-Funds, Mortgages, Building-Materials, Agriculture, Credit-Industry, Brokers, Constructio, Manufacturing, Agro-Chemicals, Apparel, Professional-Services, Utility-Communications, Durable-Goods, Gold-Silver | + +--- diff --git a/website/content/terminal/reference/stocks/ins/stats.md b/website/content/terminal/reference/stocks/ins/stats.md new file mode 100644 index 000000000000..3eb9a0b079e3 --- /dev/null +++ b/website/content/terminal/reference/stocks/ins/stats.md @@ -0,0 +1,42 @@ +--- +title: stats +description: A documentation page detailing the usage and parameters of the 'stats' + function within the OpenInside software - used for filtering data using a selected + ticker. +keywords: +- OpenInsider +- stats function +- ticker data +- filter data +- software documentation +- data visualization +- docusaurus +- parameters +- hyperlinks +- datarows +- limit +- Usage +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Open insider filtered data using selected ticker. [Source: OpenInsider] + +### Usage + +```python +stats [-l LIMIT] [-u] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| limit | Limit of datarows to display | 10 | True | None | +| urls | Flag to show hyperlinks | False | True | None | + +--- diff --git a/website/versioned_docs/version-v3/terminal/reference/stocks/ins/tippm.md b/website/content/terminal/reference/stocks/ins/tippm.md similarity index 95% rename from website/versioned_docs/version-v3/terminal/reference/stocks/ins/tippm.md rename to website/content/terminal/reference/stocks/ins/tippm.md index f5c27f82a256..05225d4d7e86 100644 --- a/website/versioned_docs/version-v3/terminal/reference/stocks/ins/tippm.md +++ b/website/content/terminal/reference/stocks/ins/tippm.md @@ -1,9 +1,21 @@ --- title: tippm -description: OpenBB Terminal Function +description: This page provides information on the 'tippm' Python function which prints + data on the top insider purchases of the month. It includes usage details, parameters, + and examples of data rows from various companies such as Asana, Inc. +keywords: +- tippm +- insider purchases +- stock information +- data display +- Asana, Inc. +- parameter +- examples --- -# tippm +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + Print top insider purchases of the month. [Source: OpenInsider] diff --git a/website/versioned_docs/version-v3/terminal/reference/stocks/ins/tippw.md b/website/content/terminal/reference/stocks/ins/tippw.md similarity index 95% rename from website/versioned_docs/version-v3/terminal/reference/stocks/ins/tippw.md rename to website/content/terminal/reference/stocks/ins/tippw.md index 36554b1bfcd4..22a46faafeb4 100644 --- a/website/versioned_docs/version-v3/terminal/reference/stocks/ins/tippw.md +++ b/website/content/terminal/reference/stocks/ins/tippw.md @@ -1,9 +1,24 @@ --- title: tippw -description: OpenBB Terminal Function +description: Learn how to use the tippw function to print the top insider purchases + of the week. Discover parameters and example usages that can be customized according + to your requirements. +keywords: +- tippw +- insider purchases +- stock market +- financial data +- OpenInsider +- parameter usage +- python commands +- real-time data +- stock trading +- stock analysis tools --- -# tippw +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + Print top insider purchases of the week. [Source: OpenInsider] diff --git a/website/versioned_docs/version-v3/terminal/reference/stocks/ins/tipt.md b/website/content/terminal/reference/stocks/ins/tipt.md similarity index 82% rename from website/versioned_docs/version-v3/terminal/reference/stocks/ins/tipt.md rename to website/content/terminal/reference/stocks/ins/tipt.md index d87d5d4971ef..7cc4377bb888 100644 --- a/website/versioned_docs/version-v3/terminal/reference/stocks/ins/tipt.md +++ b/website/content/terminal/reference/stocks/ins/tipt.md @@ -1,9 +1,25 @@ --- title: tipt -description: OpenBB Terminal Function +description: The page provides an overview and usage of the 'tipt' function, a tool + that prints the top insider purchases of the day from OpenInsider. With parameter + customization and examples, become more adept at monitoring insider stock purchases. +keywords: +- tipt function +- insider purchases +- OpenInsider +- stock +- stock monitoring +- stock analysis +- guide +- usage +- tutorial +- data display +- trade --- -# tipt +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + Print top insider purchases of the day. [Source: OpenInsider] diff --git a/website/versioned_docs/version-v3/terminal/reference/stocks/ins/tispm.md b/website/content/terminal/reference/stocks/ins/tispm.md similarity index 94% rename from website/versioned_docs/version-v3/terminal/reference/stocks/ins/tispm.md rename to website/content/terminal/reference/stocks/ins/tispm.md index bed57849bffd..444d7c108598 100644 --- a/website/versioned_docs/version-v3/terminal/reference/stocks/ins/tispm.md +++ b/website/content/terminal/reference/stocks/ins/tispm.md @@ -1,9 +1,30 @@ --- title: tispm -description: OpenBB Terminal Function +description: Metadata for the 'tispm' page on a stock marketing website. This page + provides information about the top insider sales of the month, including trade date, + ticker, company name, insider name, title, trade type, price, quantity, owned, diff + own, and value. The data can be customized and limited, sourced from OpenInsider. +keywords: +- tispm +- insider sales +- stock marketing +- trade date +- company name +- insider name +- title +- trade type +- price +- quantity +- owned +- diff own +- value +- data display +- OpenInsider --- -# tispm +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + Print top insider sales of the month. [Source: OpenInsider] diff --git a/website/versioned_docs/version-v3/terminal/reference/stocks/ins/tispw.md b/website/content/terminal/reference/stocks/ins/tispw.md similarity index 96% rename from website/versioned_docs/version-v3/terminal/reference/stocks/ins/tispw.md rename to website/content/terminal/reference/stocks/ins/tispw.md index 619c659bbcd4..cf40e9c3a10f 100644 --- a/website/versioned_docs/version-v3/terminal/reference/stocks/ins/tispw.md +++ b/website/content/terminal/reference/stocks/ins/tispw.md @@ -1,9 +1,22 @@ --- title: tispw -description: OpenBB Terminal Function +description: tispw - A command line tool to fetch and present top insider sales of + the week from OpenInsider. Parameters for usage include the limit of datarows to + display. An important utility for those interested in stock market trends. +keywords: +- tispw +- insider sales +- stock market +- OpenInsider +- data display +- parameters +- datarows +- command line tool --- -# tispw +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + Print top insider sales of the week. [Source: OpenInsider] diff --git a/website/content/terminal/reference/stocks/ins/tist.md b/website/content/terminal/reference/stocks/ins/tist.md new file mode 100644 index 000000000000..81866b28bc1f --- /dev/null +++ b/website/content/terminal/reference/stocks/ins/tist.md @@ -0,0 +1,35 @@ +--- +title: tist +description: This page contains detailed instructions on how to use 'tist', a tool + to print top insider sales data of the day. Information on usage, parameters, and + options are provided. +keywords: +- tist +- top insider sales +- OpenInsider +- usage instructions +- parameters +- options +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Print top insider sales of the day. [Source: OpenInsider] + +### Usage + +```python +tist [-l LIMIT] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| limit | Limit of datarows to display | 10 | True | None | + +--- diff --git a/website/versioned_docs/version-v3/terminal/reference/stocks/ins/toppm.md b/website/content/terminal/reference/stocks/ins/toppm.md similarity index 94% rename from website/versioned_docs/version-v3/terminal/reference/stocks/ins/toppm.md rename to website/content/terminal/reference/stocks/ins/toppm.md index 1fc7ff4ee3a9..caa810dc0a25 100644 --- a/website/versioned_docs/version-v3/terminal/reference/stocks/ins/toppm.md +++ b/website/content/terminal/reference/stocks/ins/toppm.md @@ -1,9 +1,28 @@ --- title: toppm -description: OpenBB Terminal Function +description: The toppm command returns a comprehensive list of top officer purchases + of the month. It includes insider details such as filing date, trade date, ticker, + company name, insider name and more. You are able to limit the number of rows displayed + through the -l LIMIT parameter. +keywords: +- toppm +- officer purchases +- insider data +- trade date +- company name +- insider name +- title +- trade type +- price +- quantity +- owned +- percentage difference +- value --- -# toppm +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + Print top officer purchases of the month. [Source: OpenInsider] diff --git a/website/versioned_docs/version-v3/terminal/reference/stocks/ins/toppw.md b/website/content/terminal/reference/stocks/ins/toppw.md similarity index 95% rename from website/versioned_docs/version-v3/terminal/reference/stocks/ins/toppw.md rename to website/content/terminal/reference/stocks/ins/toppw.md index 3f675a23326f..db9a60e9d6a0 100644 --- a/website/versioned_docs/version-v3/terminal/reference/stocks/ins/toppw.md +++ b/website/content/terminal/reference/stocks/ins/toppw.md @@ -1,9 +1,22 @@ --- title: toppw -description: OpenBB Terminal Function +description: The documentation page for 'toppw' which stands for 'top officer purchases + of the week', sourced from OpenInsider. Displays insider trading data including + filing date, trade date, ticker, company name, and related details. +keywords: +- toppw +- insider trading +- OpenInsider +- stock market +- officer purchases +- trade data +- data display +- stock ticker --- -# toppw +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + Print top officer purchases of the week. [Source: OpenInsider] diff --git a/website/content/terminal/reference/stocks/ins/topt.md b/website/content/terminal/reference/stocks/ins/topt.md new file mode 100644 index 000000000000..19562c796f2d --- /dev/null +++ b/website/content/terminal/reference/stocks/ins/topt.md @@ -0,0 +1,36 @@ +--- +title: topt +description: This page provides instructions on how to use the 'topt' function which + prints the top officer purchases of the day. It includes parameters for usage and + an understanding of the output. +keywords: +- Topt +- Officer Purchases +- OpenInsider +- Usage +- Parameters +- Limit +- Datarows +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Print top officer purchases of the day. [Source: OpenInsider] + +### Usage + +```python +topt [-l LIMIT] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| limit | Limit of datarows to display | 10 | True | None | + +--- diff --git a/website/content/terminal/reference/stocks/ins/view.md b/website/content/terminal/reference/stocks/ins/view.md new file mode 100644 index 000000000000..239b41ac90f9 --- /dev/null +++ b/website/content/terminal/reference/stocks/ins/view.md @@ -0,0 +1,35 @@ +--- +title: view +description: This page provides instructions on how to view the available presets + in the preset folder using the view function. It also provides details about parameters + such as preset names. +keywords: +- view function +- using presets +- parameter description +- programming +- software development +- coding instructions +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +View available presets under presets folder. + +### Usage + +```python +view [-p Desired preset] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| preset | View specific preset | | True | template, Retail-Trade, Pharmaceuticals, Investment-Offices, Railroads, Real-Estate, Tobacco, Ground-Freight, Personal-Credit, Business-Services, Insurance-Carriers, Restaurants, Grocery, Hotels, whales, Nondurable-Goods, Furniture, Retail-Stores, Air-Transportatio, Electronics, Guided-Missiles, Lumber, Insurance-Agents, Mining, Banks, Utility-Gas, Legal, Wholesale-Trade, Health, Closed-End-Funds, Mortgages, Building-Materials, Agriculture, Credit-Industry, Brokers, Constructio, Manufacturing, Agro-Chemicals, Apparel, Professional-Services, Utility-Communications, Durable-Goods, Gold-Silver | + +--- diff --git a/website/content/terminal/reference/stocks/load.md b/website/content/terminal/reference/stocks/load.md new file mode 100644 index 000000000000..b7c79522d733 --- /dev/null +++ b/website/content/terminal/reference/stocks/load.md @@ -0,0 +1,78 @@ +--- +title: load +description: This documentation page provides detailed information on how to load + stock tickers using various parameters for analysis. Users can customize their usage + through options like start and end dates, interval, pre/after market hours, load + monthly or weekly data, among others. +keywords: +- Stock Analysis +- Load Stock Tickers +- Investment Analysis +- Financial Data +- Stock Market +- Yahoo Finance +- Custom Stock Data +- Intraday Stock +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Load stock ticker to perform analysis on. When the data source is syf', an Indian ticker can be loaded by using '.NS' at the end, e.g. 'SBIN.NS'. See available market in https://help.yahoo.com/kb/exchanges-data-providers-yahoo-finance-sln2310.html. + +### Usage + +```python +load -t TICKER [-s START] [-e END] [-i {1,5,15,30,60}] [-p] [-f FILEPATH] [-m] [-w] [-r {ytd,1y,2y,5y,6m}] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| ticker | Stock ticker | None | False | None | +| start | The starting date (format YYYY-MM-DD) of the stock | 2019-11-21 | True | None | +| end | The ending date (format YYYY-MM-DD) of the stock | 2022-11-25 | True | None | +| interval | Intraday stock minutes | 1440 | True | 1, 5, 15, 30, 60 | +| prepost | Pre/After market hours. Only works for 'yf' source, and intraday data | False | True | None | +| filepath | Path to load custom file. | None | True | None | +| monthly | Load monthly data | False | True | None | +| weekly | Load weekly data | False | True | None | + +--- + +## Examples + +```python +txt +2022 Feb 16, 08:29 (🦋) /stocks/ $ load TSLA + +Loading Daily TSLA stock with starting period 2019-02-11 for analysis. + +Datetime: 2022 Feb 16 08:30 +Timezone: America/New_York +Currency: USD +Market: OPEN + +2022 Feb 16, 08:30 (🦋) /stocks/ $ load AAPL + +Loading Daily AAPL stock with starting period 2019-02-11 for analysis. + +Datetime: 2022 Feb 16 08:30 +Timezone: America/New_York +Currency: USD +Market: OPEN + +2022 Feb 16, 08:30 (🦋) /stocks/ $ load AMZN + +Loading Daily AMZN stock with starting period 2019-02-11 for analysis. + +Datetime: 2022 Feb 16 08:30 +Timezone: America/New_York +Currency: USD +Market: OPEN +``` +--- diff --git a/website/content/terminal/reference/stocks/news.md b/website/content/terminal/reference/stocks/news.md new file mode 100644 index 000000000000..31fde42cae75 --- /dev/null +++ b/website/content/terminal/reference/stocks/news.md @@ -0,0 +1,92 @@ +--- +title: news +description: The News page presents the latest news from the company. Users can customize + news updates using specific parameters such as starting date, order, and news sources. +keywords: +- company news +- news updates +- customize news +- news sources +- news order +- starting date +- latest news +- company updates +- article search +- news articles +- Python news script +- news parameters +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +latest news of the company + +### Usage + +```python +news [-d N_START_DATE] [-o] [-s SOURCES] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| n_start_date | The starting date (format YYYY-MM-DD) to search articles from | datetime.now() - timedelta(days=365) | True | None | +| n_oldest | Show oldest articles first | True | True | None | +| sources | Show news only from the sources specified (e.g bloomberg,reuters) | | True | None | + + +--- + +## Examples + +```python +2022 Jul 04, 16:54 (🦋) /stocks/ $ news +543 news articles for Apple+Inc. were found since 2022-06-27 + + + Three ways to patch your thinking about open-source software security +┌─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┐ +│ Content │ +├─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ +│ 2022-07-04 20:11:03 │ +├─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ +│ What comes to mind when you hear “open source?” Is it a community? Better-quality software? A technology advantage │ +│ that helps companies scale quickly? If so, congratulations. You understand the value developing with open-source │ +│ software can bring to a business… │ +├─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ +│ https://siliconangle.com/2022/07/04/three-ways-patch-thinking-open-source-software-security/ │ +└─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┘ + + + HUUUGE, INC.: Informacja o kwartalnych przychodach ze sprzedaży +┌─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┐ +│ Content │ +├─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ +│ 2022-07-04 18:55:11 │ +├─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ +│ Spis treści:1. RAPORT BIEŻĄCY2. MESSAGE (ENGLISH VERSION)3. INFORMACJE O PODMIOCIE4. PODPISY OSÓB REPREZENTUJĄCYCH │ +│ SPÓŁKĘ KOMISJA NADZORU FINANSOWEGO html head /head bodyfont face='Times New... │ +├─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ +│ https://www.bankier.pl/wiadomosc/HUUUGE-INC-Informacja-o-kwartalnych-przychodach-ze-sprzedazy-8369875.html │ +└─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┘ + + + 5 Carpooling Apps to Help You Save Money on Transportation +┌─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┐ +│ Content │ +├─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ +│ 2022-07-04 16:00:22 │ +├─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ +│ When we were kids, our parents told us not to get into cars with strangers, but that’s before we all had │ +│ smartphones in our pockets and the price of gas skyrocketed. Now, if you need to get around, carpooling is a way to │ +│ save at the gas pump — or the electric… │ +├─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤ +│ https://www.thepennyhoarder.com/save-money/carpool-apps/ │ +└─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┘ +``` +--- diff --git a/website/versioned_docs/version-v3/terminal/reference/stocks/options/_category_.json b/website/content/terminal/reference/stocks/options/_category_.json similarity index 100% rename from website/versioned_docs/version-v3/terminal/reference/stocks/options/_category_.json rename to website/content/terminal/reference/stocks/options/_category_.json diff --git a/website/content/terminal/reference/stocks/options/binom.md b/website/content/terminal/reference/stocks/options/binom.md new file mode 100644 index 000000000000..e4fde633532c --- /dev/null +++ b/website/content/terminal/reference/stocks/options/binom.md @@ -0,0 +1,60 @@ +--- +title: binom +description: This page is an in-depth guide to using the binom function for binomial + option valuation. It details the usage, parameters, and provides examples to assist + users. +keywords: +- binom +- option valuation +- binomial option +- Strike price +- put value +- European option +- American option +- export excel +- plot values +- volatility +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Gives the option value using binomial option valuation + +### Usage + +```python +binom [-s STRIKE] [-p] [-e] [-x] [--plot] [-v VOLATILITY] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| strike | Strike price for option shown | 0 | True | None | +| put | Value a put instead of a call | False | True | None | +| europe | Value a European option instead of an American one | False | True | None | +| export | Export an excel spreadsheet with binomial pricing data | False | True | None | +| plot | Plot expected ending values | False | True | None | +| volatility | Underlying asset annualized volatility. Historical volatility used if not supplied. | None | True | None | + + +--- + +## Examples + +```python +2022 Feb 16, 08:40 (🦋) /stocks/options/ $ binom -s 3100 -e --plot + +AMZN call at $3100.00 expiring on 2022-03-25 is worth $136.85 + +2022 Feb 16, 08:41 (🦋) /stocks/options/ $ binom -s 3500 -p --plot + +AMZN put at $3500.00 expiring on 2022-03-25 is worth $389.72 +``` +![binom](https://user-images.githubusercontent.com/46355364/154276789-b6786517-3bea-4aa7-9d2e-e6669dd82587.png) + +--- diff --git a/website/content/terminal/reference/stocks/options/calc.md b/website/content/terminal/reference/stocks/options/calc.md new file mode 100644 index 000000000000..f0c8a2257bf4 --- /dev/null +++ b/website/content/terminal/reference/stocks/options/calc.md @@ -0,0 +1,58 @@ +--- +title: calc +description: Learn about 'calc', a tool to calculate profit or loss for given option + settings for strikes, premium, and selling contracts with default and optional preferences. + Include examples and a profit chart for better understanding. +keywords: +- calc +- profit calculator +- option settings +- put option +- sell option +- strike price +- premium price +- profit chart +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Calculate profit or loss for given option settings. + +### Usage + +```python +calc [--put] [--sell] [-s STRIKE] [-p PREMIUM] [-m MIN] [-M MAX] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| put | Flag to calculate put option | False | True | None | +| sell | Flag to get profit chart of selling contract | False | True | None | +| strike | Option strike price | 10 | True | None | +| premium | Premium price | 1 | True | None | +| min | Min price to look at | -1 | True | None | +| max | Max price to look at | -1 | True | None | + + +--- + +## Examples + +```python +2022 Feb 16, 08:45 (🦋) /stocks/options/ $ calc -s 30 -p 6 -m 1 -M 50 + +Strike: $30.0 +Premium: $6.0 +Breakeven price: $36.0 +Max profit: Unlimited +Max loss: $-600.0 +``` +![calc](https://user-images.githubusercontent.com/46355364/154277755-a6640bee-8621-4a7d-9fc6-9c197daca0e1.png) + +--- diff --git a/website/content/terminal/reference/stocks/options/chains.md b/website/content/terminal/reference/stocks/options/chains.md new file mode 100644 index 000000000000..c781d75e37ac --- /dev/null +++ b/website/content/terminal/reference/stocks/options/chains.md @@ -0,0 +1,50 @@ +--- +title: chains +description: Detailed guide on how to display option chains with python usage. Documentation + includes parameters for call options, put options, strike price, ask size, bid size, + volume, open interest and others, along with their default values and options. +keywords: +- option chains +- parameters +- python usage +- call options +- put options +- strike price +- ask size +- bid size +- volume +- open interest +- delta +- gamma +- theta +- vega +- ask iv +- bid iv +- mid iv +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Display option chains + +### Usage + +```python +chains [-c] [-p] [-m MIN_SP] [-M MAX_SP] [-d TO_DISPLAY] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| calls | Flag to show calls only | False | True | None | +| puts | Flag to show puts only | False | True | None | +| min_sp | minimum strike price to consider. | -1 | True | None | +| max_sp | maximum strike price to consider. | -1 | True | None | +| to_display | (tradier only) Columns to look at. Columns can be: bid, ask, strike, bidsize, asksize, volume, open_interest, delta, gamma, theta, vega, ask_iv, bid_iv, mid_iv. E.g. 'bid,ask,strike' | mid_iv, vega, delta, gamma, theta, volume, open_interest, bid, ask | True | None | + +--- diff --git a/website/content/terminal/reference/stocks/options/exp.md b/website/content/terminal/reference/stocks/options/exp.md new file mode 100644 index 000000000000..e808200cf534 --- /dev/null +++ b/website/content/terminal/reference/stocks/options/exp.md @@ -0,0 +1,72 @@ +--- +title: exp +description: The 'exp' page provides comprehensive details on setting expiration dates + using the 'exp' command in Python. It includes information on usage, parameters, + and examples to assist users in understanding and effectively managing dates. +keywords: +- exp documentation +- expiration date setting +- expiry date tool +- expiry date parameters +- exp usage +- exp examples +- exp command +- exp date selection +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +See and set expiration date + +### Usage + +```python +exp [-i {0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17}] [-d {2022-11-25,2022-12-02,2022-12-09,2022-12-16,2022-12-23,2022-12-30,2023-01-20,2023-02-17,2023-03-17,2023-04-21,2023-05-19,2023-06-16,2023-07-21,2023-09-15,2024-01-19,2024-03-15,2024-06-21,2025-01-17,}] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| index | Select index for expiry date. | -1 | True | range(0, 18) | +| date | Select date (YYYY-MM-DD) | | True | 2022-11-25, 2022-12-02, 2022-12-09, 2022-12-16, 2022-12-23, 2022-12-30, 2023-01-20, 2023-02-17, 2023-03-17, 2023-04-21, 2023-05-19, 2023-06-16, 2023-07-21, 2023-09-15, 2024-01-19, 2024-03-15, 2024-06-21, 2025-01-17, | + + +--- + +## Examples + +```python +2022 Feb 16, 08:50 (🦋) /stocks/options/ $ exp + +Available expiry dates: + 0. 2022-02-18 + 1. 2022-02-25 + 2. 2022-03-04 + 3. 2022-03-11 + 4. 2022-03-18 + 5. 2022-03-25 + 6. 2022-04-01 + 7. 2022-04-14 + 8. 2022-05-20 + 9. 2022-06-17 + 10. 2022-07-15 + 11. 2022-08-19 + 12. 2022-09-16 + 13. 2022-10-21 + 14. 2022-11-18 + 15. 2022-12-16 + 16. 2023-01-20 + 17. 2023-03-17 + 18. 2023-06-16 + 19. 2023-09-15 + 20. 2024-01-19 + +2022 Feb 16, 08:50 (🦋) /stocks/options/ $ exp 7 +Expiration set to 2022-04-14 +``` +--- diff --git a/website/versioned_docs/version-v3/terminal/reference/stocks/options/greeks.md b/website/content/terminal/reference/stocks/options/greeks.md similarity index 99% rename from website/versioned_docs/version-v3/terminal/reference/stocks/options/greeks.md rename to website/content/terminal/reference/stocks/options/greeks.md index 773d30428b7a..6a0b5bdaf831 100644 --- a/website/versioned_docs/version-v3/terminal/reference/stocks/options/greeks.md +++ b/website/content/terminal/reference/stocks/options/greeks.md @@ -1,9 +1,17 @@ --- title: greeks -description: OpenBB Terminal Function +description: This documentation page describes the greeks command, which retrieves greeks for a given option. +keywords: +- greeks +- delta +- gamma +- theta +- vega --- -# greeks +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + The greeks for a given option. diff --git a/website/content/terminal/reference/stocks/options/grhist.md b/website/content/terminal/reference/stocks/options/grhist.md new file mode 100644 index 000000000000..81f7886f1ad7 --- /dev/null +++ b/website/content/terminal/reference/stocks/options/grhist.md @@ -0,0 +1,46 @@ +--- +title: grhist +description: The grhist page is dedicated to illustrating how to plot historical option + greeks using Python. It includes various parameters like strike price, put option, + greek column, OCC option symbol, raw data, among others. It also demonstrates the + use of a certain data visualization for better understanding. +keywords: +- grhist +- historical option greeks plot +- option greeks +- put option +- strike price +- greek column +- OCC option symbol +- raw data +- data visualization +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Plot historical option greeks. + +### Usage + +```python +grhist -s STRIKE [-p] [-g {iv,gamma,theta,vega,delta,rho,premium}] [-c CHAIN_ID] [-r] [-l LIMIT] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| strike | Strike price to look at | None | False | None | +| put | Flag for showing put option | False | True | None | +| greek | Greek column to select | delta | True | iv, gamma, theta, vega, delta, rho, premium | +| chain_id | OCC option symbol | | True | None | +| raw | Display raw data | False | True | None | +| limit | Limit of raw data rows to display | 20 | True | None | + +![grhist](https://user-images.githubusercontent.com/46355364/154278932-086a0005-be71-4493-843d-3f9100a60905.png) + +--- diff --git a/website/versioned_docs/version-v3/terminal/reference/stocks/options/hedge/_category_.json b/website/content/terminal/reference/stocks/options/hedge/_category_.json similarity index 100% rename from website/versioned_docs/version-v3/terminal/reference/stocks/options/hedge/_category_.json rename to website/content/terminal/reference/stocks/options/hedge/_category_.json diff --git a/website/content/terminal/reference/stocks/options/hedge/add.md b/website/content/terminal/reference/stocks/options/hedge/add.md new file mode 100644 index 000000000000..ce69f11ff2c3 --- /dev/null +++ b/website/content/terminal/reference/stocks/options/hedge/add.md @@ -0,0 +1,69 @@ +--- +title: add +description: This page guides on the usage of the 'add' command to add options to + the trading diagram. The command has parameters allowing the user to buy a put instead + of a call, short an option, and specify an option's identifier. +keywords: +- trade options +- options trading +- options diagram +- add command +- buy put +- short option +- option identifier +- options command +- options parameters +- command usage +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Add options to the diagram. + +### Usage + +```python +add [-p] [-s] -i {0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,32,33,34,35,36,37,38,39,40,41,42,43,44,45,46,47,48,49,50,51,52,53,54,55,56,57,58,59} +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| put | Buy a put instead of a call | False | True | None | +| short | Short the option instead of buying it | False | True | None | +| identifier | The identifier of the option as found in the list command | None | False | range(0, 60) | + + +--- + +## Examples + +```python +2022 May 10, 09:17 (🦋) /stocks/options/hedge/ $ add 25 +┏━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━┓ +┃ ┃ Positions ┃ +┡━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━┩ +│ Delta │ 1.00 │ +├────────────────────┼───────────┤ +│ Gamma │ 7253.89 │ +├────────────────────┼───────────┤ +│ Vega │ 0.14 │ +├────────────────────┼───────────┤ +│ Implied Volatility │ 1.00e-05 │ +├────────────────────┼───────────┤ +│ Strike Price │ 147.00 │ +└────────────────────┴───────────┘ + + Current Option Positions +┏━━━━━━┳━━━━━━┳━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━┓ +┃ Type ┃ Hold ┃ Strike ┃ Implied Volatility ┃ +┡━━━━━━╇━━━━━━╇━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━┩ +│ Call │ Long │ 147.00 │ 1.00e-05 │ +└──────┴──────┴────────┴────────────────────┘ +``` +--- diff --git a/website/content/terminal/reference/stocks/options/hedge/list.md b/website/content/terminal/reference/stocks/options/hedge/list.md new file mode 100644 index 000000000000..13d3c996fb33 --- /dev/null +++ b/website/content/terminal/reference/stocks/options/hedge/list.md @@ -0,0 +1,164 @@ +--- +title: list +description: The 'list' page details available calls and puts commands that have no + parameters. It presents a step-by-step guide on using the 'list' command along with + examples. +keywords: +- list command +- calls and puts +- stock options +- command parameters +- command usage +- command examples +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Lists available calls and puts. + +### Usage + +```python +list +``` + +--- + +## Parameters + +This command has no parameters + + + +--- + +## Examples + +```python +2022 May 10, 09:21 (🦋) /stocks/options/hedge/ $ list + Available Calls and Puts +┏━━━━━━━━━━━━┳━━━━━━━━┳━━━━━━━━┓ +┃ Identifier ┃ Calls ┃ Puts ┃ +┡━━━━━━━━━━━━╇━━━━━━━━╇━━━━━━━━┩ +│ 0 │ 100.00 │ 100.00 │ +├────────────┼────────┼────────┤ +│ 1 │ 110.00 │ 105.00 │ +├────────────┼────────┼────────┤ +│ 2 │ 115.00 │ 110.00 │ +├────────────┼────────┼────────┤ +│ 3 │ 120.00 │ 115.00 │ +├────────────┼────────┼────────┤ +│ 4 │ 124.00 │ 120.00 │ +├────────────┼────────┼────────┤ +│ 5 │ 125.00 │ 123.00 │ +├────────────┼────────┼────────┤ +│ 6 │ 126.00 │ 124.00 │ +├────────────┼────────┼────────┤ +│ 7 │ 127.00 │ 125.00 │ +├────────────┼────────┼────────┤ +│ 8 │ 129.00 │ 126.00 │ +├────────────┼────────┼────────┤ +│ 9 │ 130.00 │ 127.00 │ +├────────────┼────────┼────────┤ +│ 10 │ 131.00 │ 128.00 │ +├────────────┼────────┼────────┤ +│ 11 │ 132.00 │ 129.00 │ +├────────────┼────────┼────────┤ +│ 12 │ 133.00 │ 130.00 │ +├────────────┼────────┼────────┤ +│ 13 │ 134.00 │ 131.00 │ +├────────────┼────────┼────────┤ +│ 14 │ 135.00 │ 132.00 │ +├────────────┼────────┼────────┤ +│ 15 │ 137.00 │ 133.00 │ +├────────────┼────────┼────────┤ +│ 16 │ 138.00 │ 134.00 │ +├────────────┼────────┼────────┤ +│ 17 │ 139.00 │ 135.00 │ +├────────────┼────────┼────────┤ +│ 18 │ 140.00 │ 136.00 │ +├────────────┼────────┼────────┤ +│ 19 │ 141.00 │ 137.00 │ +├────────────┼────────┼────────┤ +│ 20 │ 142.00 │ 138.00 │ +├────────────┼────────┼────────┤ +│ 21 │ 143.00 │ 139.00 │ +├────────────┼────────┼────────┤ +│ 22 │ 144.00 │ 140.00 │ +├────────────┼────────┼────────┤ +│ 23 │ 145.00 │ 141.00 │ +├────────────┼────────┼────────┤ +│ 24 │ 146.00 │ 142.00 │ +├────────────┼────────┼────────┤ +│ 25 │ 147.00 │ 143.00 │ +├────────────┼────────┼────────┤ +│ 26 │ 148.00 │ 144.00 │ +├────────────┼────────┼────────┤ +│ 27 │ 149.00 │ 145.00 │ +├────────────┼────────┼────────┤ +│ 28 │ 150.00 │ 146.00 │ +├────────────┼────────┼────────┤ +│ 29 │ 152.50 │ 147.00 │ +├────────────┼────────┼────────┤ +│ 30 │ 155.00 │ 148.00 │ +├────────────┼────────┼────────┤ +│ 31 │ 157.50 │ 149.00 │ +├────────────┼────────┼────────┤ +│ 32 │ 160.00 │ 150.00 │ +├────────────┼────────┼────────┤ +│ 33 │ 162.50 │ 152.50 │ +├────────────┼────────┼────────┤ +│ 34 │ 165.00 │ 155.00 │ +├────────────┼────────┼────────┤ +│ 35 │ 167.50 │ 157.50 │ +├────────────┼────────┼────────┤ +│ 36 │ 170.00 │ 160.00 │ +├────────────┼────────┼────────┤ +│ 37 │ 172.50 │ 162.50 │ +├────────────┼────────┼────────┤ +│ 38 │ 175.00 │ 165.00 │ +├────────────┼────────┼────────┤ +│ 39 │ 177.50 │ 167.50 │ +├────────────┼────────┼────────┤ +│ 40 │ 180.00 │ 170.00 │ +├────────────┼────────┼────────┤ +│ 41 │ 182.50 │ 172.50 │ +├────────────┼────────┼────────┤ +│ 42 │ 185.00 │ 175.00 │ +├────────────┼────────┼────────┤ +│ 43 │ 187.50 │ 177.50 │ +├────────────┼────────┼────────┤ +│ 44 │ 190.00 │ 180.00 │ +├────────────┼────────┼────────┤ +│ 45 │ 195.00 │ 182.50 │ +├────────────┼────────┼────────┤ +│ 46 │ 200.00 │ 185.00 │ +├────────────┼────────┼────────┤ +│ 47 │ 205.00 │ 187.50 │ +├────────────┼────────┼────────┤ +│ 48 │ 210.00 │ 190.00 │ +├────────────┼────────┼────────┤ +│ 49 │ 215.00 │ 195.00 │ +├────────────┼────────┼────────┤ +│ 50 │ 220.00 │ 200.00 │ +├────────────┼────────┼────────┤ +│ 51 │ 225.00 │ 205.00 │ +├────────────┼────────┼────────┤ +│ 52 │ 235.00 │ 210.00 │ +├────────────┼────────┼────────┤ +│ 53 │ 240.00 │ 215.00 │ +├────────────┼────────┼────────┤ +│ 54 │ 245.00 │ 220.00 │ +├────────────┼────────┼────────┤ +│ 55 │ 250.00 │ 225.00 │ +├────────────┼────────┼────────┤ +│ 56 │ - │ 230.00 │ +├────────────┼────────┼────────┤ +│ 57 │ - │ 235.00 │ +├────────────┼────────┼────────┤ +│ 58 │ - │ 250.00 │ +└────────────┴────────┴────────┘ +``` +--- diff --git a/website/content/terminal/reference/stocks/options/hedge/pick.md b/website/content/terminal/reference/stocks/options/hedge/pick.md new file mode 100644 index 000000000000..297b26f884f2 --- /dev/null +++ b/website/content/terminal/reference/stocks/options/hedge/pick.md @@ -0,0 +1,36 @@ +--- +title: pick +description: Learn how to use the 'pick' function to plot option hedge diagrams. Discover + parameters like amount investment and what options to pick. +keywords: +- Option hedge diagrams +- Investment +- Long call +- Long put +- Short call +- Short put +- Seed investment +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This function plots option hedge diagrams + +### Usage + +```python +pick -p {70_long_call,70_long_put,70_short_call,70_short_put,75_long_call,75_long_put,75_short_call,75_short_put,80_long_call,80_long_put,80_short_call,80_short_put,85_long_call,85_long_put,85_short_call,85_short_put,90_long_call,90_long_put,90_short_call,90_short_put,95_long_call,95_long_put,95_short_call,95_short_put,100_long_call,100_long_put,100_short_call,100_short_put,105_long_call,105_long_put,105_short_call,105_short_put,110_long_call,110_long_put,110_short_call,110_short_put,115_long_call,115_long_put,115_short_call,115_short_put,120_long_call,120_long_put,120_short_call,120_short_put,125_long_call,125_long_put,125_short_call,125_short_put,130_long_call,130_long_put,130_short_call,130_short_put,135_long_call,135_long_put,135_short_call,135_short_put,140_long_call,140_long_put,140_short_call,140_short_put,145_long_call,145_long_put,145_short_call,145_short_put,150_long_call,150_long_put,150_short_call,150_short_put,155_long_call,155_long_put,155_short_call,155_short_put,160_long_call,160_long_put,160_short_call,160_short_put,165_long_call,165_long_put,165_short_call,165_short_put,170_long_call,170_long_put,170_short_call,170_short_put,175_long_call,175_long_put,175_short_call,175_short_put,180_long_call,180_long_put,180_short_call,180_short_put,185_long_call,185_long_put,185_short_call,185_short_put,190_long_call,190_long_put,190_short_call,190_short_put,195_long_call,195_long_put,195_short_call,195_short_put,200_long_call,200_long_put,200_short_call,200_short_put,205_long_call,205_long_put,205_short_call,205_short_put,210_long_call,210_long_put,210_short_call,210_short_put,215_long_call,215_long_put,215_short_call,215_short_put,220_long_call,220_long_put,220_short_call,220_short_put,225_long_call,225_long_put,225_short_call,225_short_put,230_long_call,230_long_put,230_short_call,230_short_put,235_long_call,235_long_put,235_short_call,235_short_put,240_long_call,240_long_put,240_short_call,240_short_put,245_long_call,245_long_put,245_short_call,245_short_put} [-a AMOUNT] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| pick | Choose what you would like to pick | None | False | 70_long_call, 70_long_put, 70_short_call, 70_short_put, 75_long_call, 75_long_put, 75_short_call, 75_short_put, 80_long_call, 80_long_put, 80_short_call, 80_short_put, 85_long_call, 85_long_put, 85_short_call, 85_short_put, 90_long_call, 90_long_put, 90_short_call, 90_short_put, 95_long_call, 95_long_put, 95_short_call, 95_short_put, 100_long_call, 100_long_put, 100_short_call, 100_short_put, 105_long_call, 105_long_put, 105_short_call, 105_short_put, 110_long_call, 110_long_put, 110_short_call, 110_short_put, 115_long_call, 115_long_put, 115_short_call, 115_short_put, 120_long_call, 120_long_put, 120_short_call, 120_short_put, 125_long_call, 125_long_put, 125_short_call, 125_short_put, 130_long_call, 130_long_put, 130_short_call, 130_short_put, 135_long_call, 135_long_put, 135_short_call, 135_short_put, 140_long_call, 140_long_put, 140_short_call, 140_short_put, 145_long_call, 145_long_put, 145_short_call, 145_short_put, 150_long_call, 150_long_put, 150_short_call, 150_short_put, 155_long_call, 155_long_put, 155_short_call, 155_short_put, 160_long_call, 160_long_put, 160_short_call, 160_short_put, 165_long_call, 165_long_put, 165_short_call, 165_short_put, 170_long_call, 170_long_put, 170_short_call, 170_short_put, 175_long_call, 175_long_put, 175_short_call, 175_short_put, 180_long_call, 180_long_put, 180_short_call, 180_short_put, 185_long_call, 185_long_put, 185_short_call, 185_short_put, 190_long_call, 190_long_put, 190_short_call, 190_short_put, 195_long_call, 195_long_put, 195_short_call, 195_short_put, 200_long_call, 200_long_put, 200_short_call, 200_short_put, 205_long_call, 205_long_put, 205_short_call, 205_short_put, 210_long_call, 210_long_put, 210_short_call, 210_short_put, 215_long_call, 215_long_put, 215_short_call, 215_short_put, 220_long_call, 220_long_put, 220_short_call, 220_short_put, 225_long_call, 225_long_put, 225_short_call, 225_short_put, 230_long_call, 230_long_put, 230_short_call, 230_short_put, 235_long_call, 235_long_put, 235_short_call, 235_short_put, 240_long_call, 240_long_put, 240_short_call, 240_short_put, 245_long_call, 245_long_put, 245_short_call, 245_short_put | +| amount | Choose the amount invested | 1000 | True | None | + +--- diff --git a/website/content/terminal/reference/stocks/options/hedge/plot.md b/website/content/terminal/reference/stocks/options/hedge/plot.md new file mode 100644 index 000000000000..52b172c99e93 --- /dev/null +++ b/website/content/terminal/reference/stocks/options/hedge/plot.md @@ -0,0 +1,31 @@ +--- +title: plot +description: The 'plot' function is central to mapping out option payoff diagrams + with no required parameters. Ideal for financial strategies visualization. +keywords: +- plot function +- option payoff diagrams +- no parameters +- financial strategies visualization +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This function plots option payoff diagrams + +### Usage + +```python +plot +``` + +--- + +## Parameters + +This command has no parameters + + +--- diff --git a/website/content/terminal/reference/stocks/options/hedge/rmv.md b/website/content/terminal/reference/stocks/options/hedge/rmv.md new file mode 100644 index 000000000000..dc73c43ff9b4 --- /dev/null +++ b/website/content/terminal/reference/stocks/options/hedge/rmv.md @@ -0,0 +1,52 @@ +--- +title: rmv +description: This documentation page outlines the usage, parameters and examples for + the rmv command in the hedge. With rmv, you can efficiently remove one of the options + shown in the hedge or all of them. +keywords: +- rmv command +- hedge options +- remove option +- stocks options +- programming command +- command usage +- command parameters +- command examples +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Remove one of the options to be shown in the hedge. + +### Usage + +```python +rmv [-o OPTION [OPTION ...]] [-a] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| option | index of the option to remove | None | True | None | +| all | remove all of the options | False | True | None | + + +--- + +## Examples + +```python +2022 May 10, 09:32 (🦋) /stocks/options/hedge/ $ rmv Option A + Current Option Positions +┏━━━━━━┳━━━━━━┳━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━┓ +┃ Type ┃ Hold ┃ Strike ┃ Implied Volatility ┃ +┡━━━━━━╇━━━━━━╇━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━┩ +│ Call │ Long │ 155.00 │ 0.06 │ +└──────┴──────┴────────┴────────────────────┘ +``` +--- diff --git a/website/content/terminal/reference/stocks/options/hedge/sop.md b/website/content/terminal/reference/stocks/options/hedge/sop.md new file mode 100644 index 000000000000..88679b78b4cc --- /dev/null +++ b/website/content/terminal/reference/stocks/options/hedge/sop.md @@ -0,0 +1,50 @@ +--- +title: sop +description: The sop command in this documentation demonstrates how to view selected + options in a stock hedge. It provides usage, parameter details, and practical examples. +keywords: +- sop +- parameters +- options +- stocks +- hedge +- add +- implied volatility +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Displays selected option + +### Usage + +```python +sop +``` + +--- + +## Parameters + +This command has no parameters + + + +--- + +## Examples + +```python +2022 May 10, 09:34 (🦋) /stocks/options/hedge/ $ add 20 + Current Option Positions +┏━━━━━━┳━━━━━━┳━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━┓ +┃ Type ┃ Hold ┃ Strike ┃ Implied Volatility ┃ +┡━━━━━━╇━━━━━━╇━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━┩ +│ Call │ Long │ 142.00 │ 0.05 │ +├──────┼──────┼────────┼────────────────────┤ +│ Call │ Long │ 155.00 │ 0.06 │ +└──────┴──────┴────────┴────────────────────┘ +``` +--- diff --git a/website/content/terminal/reference/stocks/options/hist.md b/website/content/terminal/reference/stocks/options/hist.md new file mode 100644 index 000000000000..048eab6e65b2 --- /dev/null +++ b/website/content/terminal/reference/stocks/options/hist.md @@ -0,0 +1,124 @@ +--- +title: hist +description: The page provides a method to get historical quotes for the provided + option chain using Python. It details the usage and parameters required, including + the strike price, put option flag, and OCC option symbol. Example code and output + are provided. +keywords: +- historical quotes +- option chain +- strike price +- put option +- OCC option symbol +- code example +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Gets historical quotes for given option chain + +### Usage + +```python +hist -s STRIKE [-p] [-c CHAIN_ID] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| strike | Strike price to look at | None | False | None | +| put | Flag for showing put option | False | True | None | +| chain_id | OCC option symbol | None | True | None | + + +--- + +## Examples + +```python +2022 Feb 16, 09:07 (🦋) /stocks/options/ $ hist -s 3300 -p + AMZN raw data +┏━━━━┳━━━━━━━━━━━━┳━━━━━━━━┳━━━━━━━━┳━━━━━━━━┳━━━━━━━━┳━━━━━━━━┳━━━━━━━━┳━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━┓ +┃ ┃ Date ┃ Open ┃ High ┃ Low ┃ Close ┃ Change ┃ Volume ┃ Open Interest ┃ Change Since ┃ +┡━━━━╇━━━━━━━━━━━━╇━━━━━━━━╇━━━━━━━━╇━━━━━━━━╇━━━━━━━━╇━━━━━━━━╇━━━━━━━━╇━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━┩ +│ 0 │ 2022-02-11 │ 327.53 │ 386.93 │ 327.53 │ 386.93 │ 0.26 │ 6.00 │ 98.00 │ 0.00 │ +├────┼────────────┼────────┼────────┼────────┼────────┼────────┼────────┼───────────────┼──────────────┤ +│ 1 │ 2022-02-10 │ 313.51 │ 313.51 │ 297.92 │ 307.95 │ 0.05 │ 6.00 │ 97.00 │ 0.26 │ +├────┼────────────┼────────┼────────┼────────┼────────┼────────┼────────┼───────────────┼──────────────┤ +│ 2 │ 2022-02-09 │ 272.93 │ 292.00 │ 272.00 │ 292.00 │ 0.02 │ 7.00 │ 96.00 │ 0.33 │ +├────┼────────────┼────────┼────────┼────────┼────────┼────────┼────────┼───────────────┼──────────────┤ +│ 3 │ 2022-02-08 │ 321.15 │ 321.15 │ 287.15 │ 287.15 │ -0.10 │ 17.00 │ 96.00 │ 0.35 │ +├────┼────────────┼────────┼────────┼────────┼────────┼────────┼────────┼───────────────┼──────────────┤ +│ 4 │ 2022-02-07 │ 292.28 │ 319.55 │ 292.28 │ 319.55 │ 0.02 │ 7.00 │ 106.00 │ 0.21 │ +├────┼────────────┼────────┼────────┼────────┼────────┼────────┼────────┼───────────────┼──────────────┤ +│ 5 │ 2022-02-04 │ 395.34 │ 395.34 │ 311.87 │ 311.90 │ -0.48 │ 14.00 │ 104.00 │ 0.24 │ +├────┼────────────┼────────┼────────┼────────┼────────┼────────┼────────┼───────────────┼──────────────┤ +│ 6 │ 2022-02-03 │ 601.59 │ 601.59 │ 599.94 │ 599.94 │ 0.15 │ 2.00 │ 104.00 │ -0.36 │ +├────┼────────────┼────────┼────────┼────────┼────────┼────────┼────────┼───────────────┼──────────────┤ +│ 7 │ 2022-01-27 │ 527.86 │ 527.93 │ 513.45 │ 520.77 │ -0.13 │ 62.00 │ 103.00 │ -0.26 │ +├────┼────────────┼────────┼────────┼────────┼────────┼────────┼────────┼───────────────┼──────────────┤ +│ 8 │ 2022-01-25 │ 574.01 │ 598.50 │ 574.01 │ 598.50 │ 0.01 │ 5.00 │ 103.00 │ -0.35 │ +├────┼────────────┼────────┼────────┼────────┼────────┼────────┼────────┼───────────────┼──────────────┤ +│ 9 │ 2022-01-24 │ 572.19 │ 617.00 │ 572.19 │ 593.00 │ 0.12 │ 8.00 │ 107.00 │ -0.35 │ +├────┼────────────┼────────┼────────┼────────┼────────┼────────┼────────┼───────────────┼──────────────┤ +│ 10 │ 2022-01-21 │ 446.38 │ 532.21 │ 446.38 │ 531.03 │ 0.36 │ 16.00 │ 106.00 │ -0.27 │ +├────┼────────────┼────────┼────────┼────────┼────────┼────────┼────────┼───────────────┼──────────────┤ +│ 11 │ 2022-01-20 │ 333.40 │ 389.75 │ 332.17 │ 389.75 │ 0.23 │ 13.00 │ 103.00 │ -0.01 │ +├────┼────────────┼────────┼────────┼────────┼────────┼────────┼────────┼───────────────┼──────────────┤ +│ 12 │ 2022-01-19 │ 325.00 │ 325.00 │ 316.58 │ 316.58 │ -0.03 │ 11.00 │ 97.00 │ 0.22 │ +├────┼────────────┼────────┼────────┼────────┼────────┼────────┼────────┼───────────────┼──────────────┤ +│ 13 │ 2022-01-18 │ 319.90 │ 325.00 │ 314.90 │ 325.00 │ 0.05 │ 5.00 │ 96.00 │ 0.19 │ +├────┼────────────┼────────┼────────┼────────┼────────┼────────┼────────┼───────────────┼──────────────┤ +│ 14 │ 2022-01-14 │ 295.10 │ 310.09 │ 295.10 │ 310.09 │ 0.07 │ 2.00 │ 95.00 │ 0.25 │ +├────┼────────────┼────────┼────────┼────────┼────────┼────────┼────────┼───────────────┼──────────────┤ +│ 15 │ 2022-01-13 │ 260.17 │ 290.68 │ 260.12 │ 290.68 │ 0.14 │ 38.00 │ 95.00 │ 0.33 │ +├────┼────────────┼────────┼────────┼────────┼────────┼────────┼────────┼───────────────┼──────────────┤ +│ 16 │ 2022-01-12 │ 255.55 │ 255.55 │ 254.00 │ 254.00 │ -0.02 │ 3.00 │ 113.00 │ 0.52 │ +├────┼────────────┼────────┼────────┼────────┼────────┼────────┼────────┼───────────────┼──────────────┤ +│ 17 │ 2022-01-11 │ 282.10 │ 282.10 │ 253.15 │ 258.89 │ -0.22 │ 28.00 │ 114.00 │ 0.49 │ +├────┼────────────┼────────┼────────┼────────┼────────┼────────┼────────┼───────────────┼──────────────┤ +│ 18 │ 2022-01-10 │ 357.10 │ 365.85 │ 333.90 │ 333.90 │ 0.15 │ 8.00 │ 97.00 │ 0.16 │ +├────┼────────────┼────────┼────────┼────────┼────────┼────────┼────────┼───────────────┼──────────────┤ +│ 19 │ 2022-01-07 │ 290.40 │ 290.40 │ 290.40 │ 290.40 │ 0.23 │ 41.00 │ 98.00 │ 0.33 │ +├────┼────────────┼────────┼────────┼────────┼────────┼────────┼────────┼───────────────┼──────────────┤ +│ 20 │ 2022-01-04 │ 237.00 │ 237.00 │ 237.00 │ 237.00 │ -0.01 │ 1.00 │ 77.00 │ 0.63 │ +├────┼────────────┼────────┼────────┼────────┼────────┼────────┼────────┼───────────────┼──────────────┤ +│ 21 │ 2021-12-28 │ 238.50 │ 238.50 │ 238.50 │ 238.50 │ 0.05 │ 1.00 │ 75.00 │ 0.62 │ +├────┼────────────┼────────┼────────┼────────┼────────┼────────┼────────┼───────────────┼──────────────┤ +│ 22 │ 2021-12-23 │ 228.00 │ 228.00 │ 228.00 │ 228.00 │ -0.09 │ 1.00 │ 82.00 │ 0.70 │ +├────┼────────────┼────────┼────────┼────────┼────────┼────────┼────────┼───────────────┼──────────────┤ +│ 23 │ 2021-12-21 │ 250.00 │ 250.00 │ 250.00 │ 250.00 │ -0.13 │ 1.00 │ 82.00 │ 0.55 │ +├────┼────────────┼────────┼────────┼────────┼────────┼────────┼────────┼───────────────┼──────────────┤ +│ 24 │ 2021-12-20 │ 290.00 │ 297.00 │ 283.50 │ 289.00 │ 0.11 │ 17.00 │ 82.00 │ 0.34 │ +├────┼────────────┼────────┼────────┼────────┼────────┼────────┼────────┼───────────────┼──────────────┤ +│ 25 │ 2021-12-17 │ 262.80 │ 262.80 │ 260.24 │ 260.51 │ 0.02 │ 7.00 │ 82.00 │ 0.49 │ +├────┼────────────┼────────┼────────┼────────┼────────┼────────┼────────┼───────────────┼──────────────┤ +│ 26 │ 2021-12-16 │ 250.04 │ 256.42 │ 250.04 │ 256.42 │ 0.12 │ 3.00 │ 80.00 │ 0.51 │ +├────┼────────────┼────────┼────────┼────────┼────────┼────────┼────────┼───────────────┼──────────────┤ +│ 27 │ 2021-12-15 │ 282.10 │ 288.62 │ 229.73 │ 229.73 │ -0.06 │ 16.00 │ 77.00 │ 0.68 │ +├────┼────────────┼────────┼────────┼────────┼────────┼────────┼────────┼───────────────┼──────────────┤ +│ 28 │ 2021-12-13 │ 245.50 │ 245.50 │ 245.50 │ 245.50 │ 0.01 │ 1.00 │ 63.00 │ 0.58 │ +├────┼────────────┼────────┼────────┼────────┼────────┼────────┼────────┼───────────────┼──────────────┤ +│ 29 │ 2021-12-10 │ 243.42 │ 243.42 │ 243.42 │ 243.42 │ 0.08 │ 2.00 │ 63.00 │ 0.59 │ +├────┼────────────┼────────┼────────┼────────┼────────┼────────┼────────┼───────────────┼──────────────┤ +│ 30 │ 2021-12-07 │ 234.85 │ 234.85 │ 224.38 │ 224.45 │ -0.15 │ 3.00 │ 61.00 │ 0.72 │ +├────┼────────────┼────────┼────────┼────────┼────────┼────────┼────────┼───────────────┼──────────────┤ +│ 31 │ 2021-12-06 │ 283.15 │ 285.20 │ 263.81 │ 263.81 │ -0.08 │ 14.00 │ 45.00 │ 0.47 │ +├────┼────────────┼────────┼────────┼────────┼────────┼────────┼────────┼───────────────┼──────────────┤ +│ 32 │ 2021-12-03 │ 290.59 │ 293.03 │ 286.41 │ 286.81 │ 0.16 │ 20.00 │ 45.00 │ 0.35 │ +├────┼────────────┼────────┼────────┼────────┼────────┼────────┼────────┼───────────────┼──────────────┤ +│ 33 │ 2021-11-30 │ 225.00 │ 246.50 │ 225.00 │ 246.50 │ 0.10 │ 3.00 │ 25.00 │ 0.57 │ +├────┼────────────┼────────┼────────┼────────┼────────┼────────┼────────┼───────────────┼──────────────┤ +│ 34 │ 2021-11-23 │ 224.00 │ 224.00 │ 224.00 │ 224.00 │ 0.12 │ 1.00 │ 24.00 │ 0.73 │ +├────┼────────────┼────────┼────────┼────────┼────────┼────────┼────────┼───────────────┼──────────────┤ +│ 35 │ 2021-11-22 │ 177.26 │ 200.50 │ 177.26 │ 200.50 │ 0.15 │ 2.00 │ 23.00 │ 0.93 │ +├────┼────────────┼────────┼────────┼────────┼────────┼────────┼────────┼───────────────┼──────────────┤ +│ 36 │ 2021-11-19 │ 169.00 │ 174.20 │ 169.00 │ 174.20 │ 0.00 │ 22.00 │ 22.00 │ 1.22 │ +└────┴────────────┴────────┴────────┴────────┴────────┴────────┴────────┴───────────────┴──────────────┘ +``` +--- diff --git a/website/content/terminal/reference/stocks/options/info.md b/website/content/terminal/reference/stocks/options/info.md new file mode 100644 index 000000000000..cdd978656ae2 --- /dev/null +++ b/website/content/terminal/reference/stocks/options/info.md @@ -0,0 +1,77 @@ +--- +title: info +description: This page provides information about a command 'info' that displays option + data. It includes details about usage, parameters, and examples of how to use the + command in a Python environment. The page is particularly useful for individuals + interested in stock options data. +keywords: +- Info command +- Option data +- Python environment +- Stock options data +- Command usage +- Command parameters +- Command examples +- Implied volatility +- Historical volatility +- Put/Call Vol ratio +- Today's volume +- Open interest +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Display option data [Source: Barchart.com] + +### Usage + +```python +info +``` + +--- + +## Parameters + +This command has no parameters + + + +--- + +## Examples + +```python +2022 Feb 16, 09:09 (🦋) /stocks/options/ $ info + Options Information +┏━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ ┃ ┃ +┡━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━┩ +│ Implied Volatility │ 31.27% ( -3.04%) │ +├───────────────────────┼─────────────────────────┤ +│ Historical Volatility │ 54.71% │ +├───────────────────────┼─────────────────────────┤ +│ IV Percentile │ 81% │ +├───────────────────────┼─────────────────────────┤ +│ IV Rank │ 37.04% │ +├───────────────────────┼─────────────────────────┤ +│ IV High │ 53.44% on 02/03/22 │ +├───────────────────────┼─────────────────────────┤ +│ IV Low │ 18.22% on 08/27/21 │ +├───────────────────────┼─────────────────────────┤ +│ Put/Call Vol Ratio │ 0.85 │ +├───────────────────────┼─────────────────────────┤ +│ Today's Volume │ 143,740 │ +├───────────────────────┼─────────────────────────┤ +│ Volume Avg (30-Day) │ 241,667 │ +├───────────────────────┼─────────────────────────┤ +│ Put/Call OI Ratio │ 0.98 │ +├───────────────────────┼─────────────────────────┤ +│ Today's Open Interest │ 582,975 │ +├───────────────────────┼─────────────────────────┤ +│ Open Int (30-Day) │ 721,047 │ +└───────────────────────┴─────────────────────────┘ +``` +--- diff --git a/website/content/terminal/reference/stocks/options/load.md b/website/content/terminal/reference/stocks/options/load.md new file mode 100644 index 000000000000..5cb6126ac402 --- /dev/null +++ b/website/content/terminal/reference/stocks/options/load.md @@ -0,0 +1,78 @@ +--- +title: load +description: This documentation page includes detailed instructions on how to load + a stock ticker into the option menu using a specific command. It outlines each step + and provides multiple examples for better understanding. +keywords: +- load command +- stock ticker +- options +- stock trading +- stock options +- command line interface +- trading tool +- trading instructions +- TSLA +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Load a ticker into option menu + +### Usage + +```python +load -t TICKER +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| ticker | Stock ticker | None | False | None | + + +--- + +## Examples + +```python +2022 Feb 16, 09:13 (🦋) /stocks/options/ $ load TSLA + +2022 Feb 16, 09:13 (🦋) /stocks/options/ $ ? +╭────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────── Stocks - Options ──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮ +│ │ +│ unu show unusual options activity [Fdscanner.com] │ +│ calc basic call/put PnL calculator │ +│ │ +│ load load new ticker │ +│ exp see and set expiration dates │ +│ │ +│ Ticker: TSLA │ +│ Expiry: None │ +│ │ +│ pcr display put call ratio for ticker [AlphaQuery.com] │ +│ info display option information (volatility, IV rank etc) [Barchart.com] │ +│ chains display option chains with greeks [Tradier] │ +│ oi plot open interest [Tradier/YFinance] │ +│ vol plot volume [Tradier/YFinance] │ +│ voi plot volume and open interest [Tradier/YFinance] │ +│ hist plot option history [Tradier] │ +│ vsurf show 3D volatility surface [Yfinance] │ +│ grhist plot option greek history [Syncretism.io] │ +│ plot plot variables provided by the user [Yfinance] │ +│ parity shows whether options are above or below expected price [Yfinance] │ +│ binom shows the value of an option using binomial options pricing [Yfinance] │ +│ greeks shows the greeks for a given option [Yfinance] │ +│ │ +│ screen screens tickers based on preset [Syncretism.io] │ +│ payoff shows payoff diagram for a selection of options [Yfinance] │ +│ pricing shows options pricing and risk neutral valuation [Yfinance] │ +│ │ +╰───────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────── OpenBB Terminal ─╯ +``` +--- diff --git a/website/content/terminal/reference/stocks/options/oi.md b/website/content/terminal/reference/stocks/options/oi.md new file mode 100644 index 000000000000..6c6a81d074c3 --- /dev/null +++ b/website/content/terminal/reference/stocks/options/oi.md @@ -0,0 +1,51 @@ +--- +title: oi +description: This page provides a detailed explanation on how to plot open interest + using various parameters such as min, max, calls, and puts. It also includes usage + examples. +keywords: +- Open interest +- Tutorial +- Parameters +- Option trading +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Plot open interest. Open interest represents the number of contracts that exist. + +### Usage + +```python +oi [-m MIN] [-M MAX] [-c] [-p] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| min | Min strike to plot | -1 | True | None | +| max | Max strike to plot | -1 | True | None | +| calls | Flag to plot call options only | False | True | None | +| puts | Flag to plot put options only | False | True | None | + + +--- + +## Examples + +```python +2022 Feb 16, 09:13 (🦋) /stocks/options/ $ load SPY + +2022 Feb 16, 09:14 (🦋) /stocks/options/ $ exp 10 +Expiration set to 2022-03-11 + +2022 Feb 16, 09:14 (🦋) /stocks/options/ $ oi +``` +![oi](https://user-images.githubusercontent.com/46355364/154282811-b8b7d36b-2e4e-44c0-8026-b244d97a8608.png) + +--- diff --git a/website/versioned_docs/version-v3/terminal/reference/stocks/options/parity.md b/website/content/terminal/reference/stocks/options/parity.md similarity index 84% rename from website/versioned_docs/version-v3/terminal/reference/stocks/options/parity.md rename to website/content/terminal/reference/stocks/options/parity.md index 89f968576254..12e7e7063322 100644 --- a/website/versioned_docs/version-v3/terminal/reference/stocks/options/parity.md +++ b/website/content/terminal/reference/stocks/options/parity.md @@ -1,9 +1,18 @@ --- title: parity -description: OpenBB Terminal Function +description: The parity page provides details about whether options are over or under + valued. It includes usage examples, parameters definition and their choices. +keywords: +- parity +- over or under valued options +- parameters +- options valuation +- example usage --- -# parity +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + Shows whether options are over or under valued diff --git a/website/content/terminal/reference/stocks/options/pcr.md b/website/content/terminal/reference/stocks/options/pcr.md new file mode 100644 index 000000000000..fb694100eeb4 --- /dev/null +++ b/website/content/terminal/reference/stocks/options/pcr.md @@ -0,0 +1,37 @@ +--- +title: pcr +description: This marketing webpage demonstrates the usage of the 'pcr' function that + displays put to call ratio for a particular ticker. It includes a detailed parameters' + list and a plot for visualization. +keywords: +- Put Call Ratio +- AlphaQuery +- pcr function +- visualization +- parameters description +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Display put to call ratio for ticker [AlphaQuery.com] + +### Usage + +```python +pcr [-l {10,20,30,60,90,120,150,180}] [-s START] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| length | Window length to get | 30 | True | 10, 20, 30, 60, 90, 120, 150, 180 | +| start | Start date for plot | datetime.now() - timedelta(days=365) | True | None | + +![pcr](https://user-images.githubusercontent.com/46355364/154286299-19ea423d-28e7-48d7-a5f3-621f0428fd4a.png) + +--- diff --git a/website/content/terminal/reference/stocks/options/plot.md b/website/content/terminal/reference/stocks/options/plot.md new file mode 100644 index 000000000000..d3cefbd7d91f --- /dev/null +++ b/website/content/terminal/reference/stocks/options/plot.md @@ -0,0 +1,60 @@ +--- +title: plot +description: Plot documentation page provides information on how to show a plot for + the given x and y variables, with variables being last trade date, strike, last + price, bid, ask, percentage change, volume, open interest, implied volatility and + more. It also shows usage examples and available customizations. +keywords: +- plot +- show plot +- trade date +- strike +- last price +- bid +- ask +- change +- percent change +- volume +- open interest +- implied volatility +- stocks +- options +- graph +- custom graphs +- smile +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Shows a plot for the given x and y variables + +### Usage + +```python +plot [-p] [-x {ltd,s,lp,b,a,c,pc,v,oi,iv}] [-y {ltd,s,lp,b,a,c,pc,v,oi,iv}] [-c {smile}] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| put | Shows puts instead of calls | False | True | None | +| x | ltd- last trade date, s- strike, lp- last price, b- bid, a- ask,c- change, pc- percent change, v- volume, oi- open interest, iv- implied volatility | s | True | ltd, s, lp, b, a, c, pc, v, oi, iv | +| y | ltd- last trade date, s- strike, lp- last price, b- bid, a- ask,c- change, pc- percent change, v- volume, oi- open interest, iv- implied volatility | iv | True | ltd, s, lp, b, a, c, pc, v, oi, iv | +| custom | Choose from already created graphs | None | True | smile | + + +--- + +## Examples + +```python +2022 Feb 16, 09:37 (🦋) /stocks/options/ $ plot -p -x s -y iv +``` +![plot](https://user-images.githubusercontent.com/46355364/154287325-97de8945-a44c-418d-9e88-5123ee70469f.png) + +--- diff --git a/website/versioned_docs/version-v3/terminal/reference/stocks/options/pricing/_category_.json b/website/content/terminal/reference/stocks/options/pricing/_category_.json similarity index 100% rename from website/versioned_docs/version-v3/terminal/reference/stocks/options/pricing/_category_.json rename to website/content/terminal/reference/stocks/options/pricing/_category_.json diff --git a/website/content/terminal/reference/stocks/options/pricing/add.md b/website/content/terminal/reference/stocks/options/pricing/add.md new file mode 100644 index 000000000000..3a3affe0f135 --- /dev/null +++ b/website/content/terminal/reference/stocks/options/pricing/add.md @@ -0,0 +1,56 @@ +--- +title: add +description: This page demonstrates how to use the 'add' function to input a projected + stock price and its chance of occurrence into a data set. The tutorial is detailed + and includes examples for easy comprehension. +keywords: +- Stock Market +- Stock Pricing +- Stock Options +- Pricing Projection +- Options Pricing +- Price Addition +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Adds a price to the list + +### Usage + +```python +add -p PRICE -c CHANCE +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| price | Projected price of the stock at the expiration date | None | False | None | +| chance | Chance that the stock is at a given projected price | None | False | None | + + +--- + +## Examples + +```python +2022 Feb 16, 09:42 (🦋) /stocks/options/pricing/ $ add -p 175 -c 0.5 + +2022 Feb 16, 09:43 (🦋) /stocks/options/pricing/ $ add -p 165 -c 0.5 + +2022 Feb 16, 09:43 (🦋) /stocks/options/pricing/ $ show +Estimated price(s) of AAPL at 2022-05-20 +┏━━━━━━━━┳━━━━━━━━┓ +┃ Price ┃ Chance ┃ +┡━━━━━━━━╇━━━━━━━━┩ +│ 165.00 │ 0.50 │ +├────────┼────────┤ +│ 175.00 │ 0.50 │ +└────────┴────────┘ +``` +--- diff --git a/website/content/terminal/reference/stocks/options/pricing/rmv.md b/website/content/terminal/reference/stocks/options/pricing/rmv.md new file mode 100644 index 000000000000..8b3b0dc3842e --- /dev/null +++ b/website/content/terminal/reference/stocks/options/pricing/rmv.md @@ -0,0 +1,52 @@ +--- +title: rmv +description: The rmv command allows users to remove a price from the list in the stock + options pricing tool. It is a vital feature in the command line interface market + tool, which provides flexibility in managing price lists. +keywords: +- rmv command +- remove price +- stock options price +- command line interface +- price list +- market tools +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Removes a price from the list + +### Usage + +```python +rmv -p PRICE [-a] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| price | Price you want to remove from the list | None | False | None | +| all | Remove all prices from the list | False | True | None | + + +--- + +## Examples + +```python +2022 Feb 16, 09:44 (🦋) /stocks/options/pricing/ $ rmv -p 165 + +2022 Feb 16, 09:44 (🦋) /stocks/options/pricing/ $ show +Estimated price(s) of AAPL at 2022-05-20 +┏━━━━━━━━┳━━━━━━━━┓ +┃ Price ┃ Chance ┃ +┡━━━━━━━━╇━━━━━━━━┩ +│ 175.00 │ 0.50 │ +└────────┴────────┘ +``` +--- diff --git a/website/versioned_docs/version-v3/terminal/reference/stocks/options/pricing/rnval.md b/website/content/terminal/reference/stocks/options/pricing/rnval.md similarity index 90% rename from website/versioned_docs/version-v3/terminal/reference/stocks/options/pricing/rnval.md rename to website/content/terminal/reference/stocks/options/pricing/rnval.md index 7a1f29e8ceaf..d004c42faa9b 100644 --- a/website/versioned_docs/version-v3/terminal/reference/stocks/options/pricing/rnval.md +++ b/website/content/terminal/reference/stocks/options/pricing/rnval.md @@ -1,9 +1,20 @@ --- title: rnval -description: OpenBB Terminal Function +description: The rnval page provides detailed information about calculating the risk + neutral value of options, with steps to use the 'rnval' function. It includes detailed + parameters like strike prices and risk-free rates along with examples to aid comprehension. +keywords: +- rnval +- risk neutral value +- options +- stock options +- strike price +- risk-free rate --- -# rnval +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + The risk neutral value of the options diff --git a/website/content/terminal/reference/stocks/options/pricing/show.md b/website/content/terminal/reference/stocks/options/pricing/show.md new file mode 100644 index 000000000000..0be029e6816d --- /dev/null +++ b/website/content/terminal/reference/stocks/options/pricing/show.md @@ -0,0 +1,52 @@ +--- +title: show +description: This page provides the 'show' command, used to display stock option price + and it's estimated chance. It comes without parameters. +keywords: +- show command +- stock options +- display prices +- no parameters +- stock price estimation +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Display prices + +### Usage + +```python +show +``` + +--- + +## Parameters + +This command has no parameters + + + +--- + +## Examples + +```python +2022 Feb 16, 09:45 (🦋) /stocks/options/pricing/ $ add -p 100 -c 0.5 + +2022 Feb 16, 09:46 (🦋) /stocks/options/pricing/ $ add -p 200 -c 0.5 + +2022 Feb 16, 09:46 (🦋) /stocks/options/pricing/ $ show +Estimated price(s) of AAPL at 2022-05-20 +┏━━━━━━━━┳━━━━━━━━┓ +┃ Price ┃ Chance ┃ +┡━━━━━━━━╇━━━━━━━━┩ +│ 100.00 │ 0.50 │ +├────────┼────────┤ +│ 200.00 │ 0.50 │ +└────────┴────────┘ +``` +--- diff --git a/website/versioned_docs/version-v3/terminal/reference/stocks/options/screen/_category_.json b/website/content/terminal/reference/stocks/options/screen/_category_.json similarity index 100% rename from website/versioned_docs/version-v3/terminal/reference/stocks/options/screen/_category_.json rename to website/content/terminal/reference/stocks/options/screen/_category_.json diff --git a/website/content/terminal/reference/stocks/options/screen/scr.md b/website/content/terminal/reference/stocks/options/screen/scr.md new file mode 100644 index 000000000000..5b5160de00a7 --- /dev/null +++ b/website/content/terminal/reference/stocks/options/screen/scr.md @@ -0,0 +1,40 @@ +--- +title: scr +description: The page describes the usage, parameters and functions of the scr command. + It includes details about various presets like high_IV, TSLA_Poots, SPY_ATM_Calls + among others and key concepts like Implied Volatility and Price-to-book. +keywords: +- Screener filter +- syncretism +- high IV +- TSLA Poots +- SPY ATM Calls +- Implied Volatility +- Open Interest +- Price-to-book +- scr command +- SPY ATM Poots +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Screener filter output from https://ops.syncretism.io/index.html. Where: CS: Contract Symbol; S: Symbol, T: Option Type; Str: Strike; Exp v: Expiration; IV: Implied Volatility; LP: Last Price; B: Bid; A: Ask; V: Volume; OI: Open Interest; Y: Yield; MY: Monthly Yield; SMP: Regular Market Price; SMDL: Regular Market Day Low; SMDH: Regular Market Day High; LU: Last Trade Date; LC: Last Crawl; ITM: In The Money; PC: Price Change; PB: Price-to-book. + +### Usage + +```python +scr [-p {template.ini,high_IV.ini,3DTE_Degenerate.ini,TSLA_Poots.ini,Long_FAANGM.ini,SPY_ATM_Calls.ini,SPY_ATM_Poots.ini,Highest_IV.ini,Highest_OI.ini,Highest_Volume.ini,TSLA_Calls_90Days.ini}] [-l LIMIT] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| preset | Filter presets | high_IV | True | template.ini, high_IV.ini, 3DTE_Degenerate.ini, TSLA_Poots.ini, Long_FAANGM.ini, SPY_ATM_Calls.ini, SPY_ATM_Poots.ini, Highest_IV.ini, Highest_OI.ini, Highest_Volume.ini, TSLA_Calls_90Days.ini | +| limit | Limit of random entries to display. Default shows all | 10 | True | None | + +--- diff --git a/website/content/terminal/reference/stocks/options/screen/set.md b/website/content/terminal/reference/stocks/options/screen/set.md new file mode 100644 index 000000000000..ecbaea249ca0 --- /dev/null +++ b/website/content/terminal/reference/stocks/options/screen/set.md @@ -0,0 +1,37 @@ +--- +title: set +description: This page provides documentation on how to set presets from both custom + and default ones for filters. Instructions for usage along with parameters are described + in detail. +keywords: +- set presets +- custom presets +- default presets +- filter presets +- set filter presets +- instructions +- parameters +- usage +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Set preset from custom and default ones. + +### Usage + +```python +set [-p {template.ini,high_IV.ini,3DTE_Degenerate.ini,TSLA_Poots.ini,Long_FAANGM.ini,SPY_ATM_Calls.ini,SPY_ATM_Poots.ini,Highest_IV.ini,Highest_OI.ini,Highest_Volume.ini,TSLA_Calls_90Days.ini}] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| preset | Filter presets | template | True | template.ini, high_IV.ini, 3DTE_Degenerate.ini, TSLA_Poots.ini, Long_FAANGM.ini, SPY_ATM_Calls.ini, SPY_ATM_Poots.ini, Highest_IV.ini, Highest_OI.ini, Highest_Volume.ini, TSLA_Calls_90Days.ini | + +--- diff --git a/website/content/terminal/reference/stocks/options/screen/view.md b/website/content/terminal/reference/stocks/options/screen/view.md new file mode 100644 index 000000000000..47ed1b5901a4 --- /dev/null +++ b/website/content/terminal/reference/stocks/options/screen/view.md @@ -0,0 +1,33 @@ +--- +title: view +description: This page provides guidance on using view feature that offers preset + options under the presets folder. The categories include template.ini, high_IV.ini, + among others. Learn how to effectively use the view command in Python. +keywords: +- presets +- usage +- parameters +- view +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +View available presets under presets folder. + +### Usage + +```python +view [-p {template.ini,high_IV.ini,3DTE_Degenerate.ini,TSLA_Poots.ini,Long_FAANGM.ini,SPY_ATM_Calls.ini,SPY_ATM_Poots.ini,Highest_IV.ini,Highest_OI.ini,Highest_Volume.ini,TSLA_Calls_90Days.ini}] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| preset | View specific custom preset | | True | template.ini, high_IV.ini, 3DTE_Degenerate.ini, TSLA_Poots.ini, Long_FAANGM.ini, SPY_ATM_Calls.ini, SPY_ATM_Poots.ini, Highest_IV.ini, Highest_OI.ini, Highest_Volume.ini, TSLA_Calls_90Days.ini | + +--- diff --git a/website/content/terminal/reference/stocks/options/unu.md b/website/content/terminal/reference/stocks/options/unu.md new file mode 100644 index 000000000000..5f7f349f0d3e --- /dev/null +++ b/website/content/terminal/reference/stocks/options/unu.md @@ -0,0 +1,100 @@ +--- +title: unu +description: The documentation covers the essential parameters and usage of unu command + in fdscanner.com. Unu command is a powerful tool for displaying, sorting, and filtering + unusual options in market data. The user can set the limit of options to show, sort + data by default and optional variables, reverse the data order, and flag to show + puts or calls only. +keywords: +- unu command +- fdscanner.com +- market data +- data display +- stock options +- Vol/OI +- Limit +- sortby +- reverse +- puts_only +- calls_only +- unusual options +- Python script +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +This command gets unusual options from fdscanner.com + +### Usage + +```python +unu [-l LIMIT] [-s {Strike,Vol/OI,Vol,OI,Bid,Ask,Exp,Ticker} [{Strike,Vol/OI,Vol,OI,Bid,Ask,Exp,Ticker} ...]] [-r] [-p] [-c] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| limit | Limit of options to show. Each scraped page gives 20 results. | 20 | True | None | +| sortby | Column to sort by. Vol/OI is the default and typical variable to be considered unusual. | Vol/OI | True | Strike, Vol/OI, Vol, OI, Bid, Ask, Exp, Ticker | +| reverse | Data is sorted in descending order by default. Reverse flag will sort it in an ascending way. Only works when raw data is displayed. | False | True | None | +| puts_only | Flag to show puts only | False | True | None | +| calls_only | Flag to show calls only | False | True | None | + + +--- + +## Examples + +```python +2022 Feb 16, 09:51 (🦋) /stocks/options/ $ unu + Last Updated: 2022-02-15 16:37:03 (EST) +┏━━━━━━━━┳━━━━━━━━━━━━┳━━━━━━━━┳━━━━━━┳━━━━━━━━┳━━━━━━━━━━┳━━━━━━━━┳━━━━━━━┳━━━━━━━┓ +┃ Ticker ┃ Exp ┃ Strike ┃ Type ┃ Vol/OI ┃ Vol ┃ OI ┃ Bid ┃ Ask ┃ +┡━━━━━━━━╇━━━━━━━━━━━━╇━━━━━━━━╇━━━━━━╇━━━━━━━━╇━━━━━━━━━━╇━━━━━━━━╇━━━━━━━╇━━━━━━━┩ +│ ABT │ 2022-05-20 │ 65.00 │ Put │ 59.40 │ 8374.00 │ 141.00 │ 0.05 │ 0.11 │ +├────────┼────────────┼────────┼──────┼────────┼──────────┼────────┼───────┼───────┤ +│ AAPL │ 2022-03-04 │ 177.50 │ Call │ 52.30 │ 15858.00 │ 303.00 │ 1.41 │ 1.43 │ +├────────┼────────────┼────────┼──────┼────────┼──────────┼────────┼───────┼───────┤ +│ WMT │ 2022-03-04 │ 150.00 │ Call │ 44.60 │ 9095.00 │ 204.00 │ 0.23 │ 0.24 │ +├────────┼────────────┼────────┼──────┼────────┼──────────┼────────┼───────┼───────┤ +│ TSLA │ 2022-02-25 │ 915.00 │ Put │ 28.60 │ 6659.00 │ 233.00 │ 27.45 │ 28.20 │ +├────────┼────────────┼────────┼──────┼────────┼──────────┼────────┼───────┼───────┤ +│ JNJ │ 2022-03-04 │ 160.00 │ Put │ 28.20 │ 4208.00 │ 149.00 │ 0.83 │ 0.93 │ +├────────┼────────────┼────────┼──────┼────────┼──────────┼────────┼───────┼───────┤ +│ AAPL │ 2022-03-04 │ 157.50 │ Put │ 23.20 │ 3136.00 │ 135.00 │ 0.69 │ 0.70 │ +├────────┼────────────┼────────┼──────┼────────┼──────────┼────────┼───────┼───────┤ +│ F │ 2022-03-04 │ 17.50 │ Put │ 21.70 │ 2716.00 │ 125.00 │ 0.46 │ 0.49 │ +├────────┼────────────┼────────┼──────┼────────┼──────────┼────────┼───────┼───────┤ +│ TWTR │ 2022-03-04 │ 37.00 │ Call │ 21.10 │ 5899.00 │ 280.00 │ 1.42 │ 1.54 │ +├────────┼────────────┼────────┼──────┼────────┼──────────┼────────┼───────┼───────┤ +│ WDC │ 2022-02-25 │ 56.00 │ Call │ 21.00 │ 4061.00 │ 193.00 │ 1.30 │ 1.40 │ +├────────┼────────────┼────────┼──────┼────────┼──────────┼────────┼───────┼───────┤ +│ UAA │ 2022-02-25 │ 17.00 │ Put │ 19.60 │ 5064.00 │ 258.00 │ 0.24 │ 0.27 │ +├────────┼────────────┼────────┼──────┼────────┼──────────┼────────┼───────┼───────┤ +│ TSLA │ 2022-02-18 │ 915.00 │ Put │ 19.60 │ 15775.00 │ 804.00 │ 14.90 │ 15.30 │ +├────────┼────────────┼────────┼──────┼────────┼──────────┼────────┼───────┼───────┤ +│ IBM │ 2022-02-18 │ 133.00 │ Call │ 19.40 │ 7248.00 │ 374.00 │ 0.22 │ 0.25 │ +├────────┼────────────┼────────┼──────┼────────┼──────────┼────────┼───────┼───────┤ +│ WDC │ 2022-02-18 │ 59.00 │ Call │ 18.10 │ 2099.00 │ 116.00 │ 0.11 │ 0.16 │ +├────────┼────────────┼────────┼──────┼────────┼──────────┼────────┼───────┼───────┤ +│ CVX │ 2022-09-16 │ 110.00 │ Put │ 16.60 │ 3026.00 │ 182.00 │ 3.45 │ 4.10 │ +├────────┼────────────┼────────┼──────┼────────┼──────────┼────────┼───────┼───────┤ +│ UAL │ 2022-05-20 │ 65.00 │ Call │ 16.50 │ 2765.00 │ 168.00 │ 1.04 │ 1.17 │ +├────────┼────────────┼────────┼──────┼────────┼──────────┼────────┼───────┼───────┤ +│ GPS │ 2022-03-04 │ 15.50 │ Put │ 16.30 │ 2947.00 │ 181.00 │ 1.05 │ 1.12 │ +├────────┼────────────┼────────┼──────┼────────┼──────────┼────────┼───────┼───────┤ +│ SO │ 2022-02-18 │ 67.00 │ Call │ 16.20 │ 2942.00 │ 182.00 │ 0.05 │ 0.10 │ +├────────┼────────────┼────────┼──────┼────────┼──────────┼────────┼───────┼───────┤ +│ TWTR │ 2022-03-04 │ 35.00 │ Put │ 14.60 │ 6467.00 │ 442.00 │ 0.68 │ 0.78 │ +├────────┼────────────┼────────┼──────┼────────┼──────────┼────────┼───────┼───────┤ +│ QCOM │ 2022-03-04 │ 145.00 │ Put │ 14.10 │ 2275.00 │ 161.00 │ 0.73 │ 0.82 │ +├────────┼────────────┼────────┼──────┼────────┼──────────┼────────┼───────┼───────┤ +│ GPS │ 2022-02-25 │ 15.50 │ Put │ 13.10 │ 2716.00 │ 208.00 │ 0.49 │ 0.53 │ +└────────┴────────────┴────────┴──────┴────────┴──────────┴────────┴───────┴───────┘ +``` +--- diff --git a/website/content/terminal/reference/stocks/options/voi.md b/website/content/terminal/reference/stocks/options/voi.md new file mode 100644 index 000000000000..525214b967a4 --- /dev/null +++ b/website/content/terminal/reference/stocks/options/voi.md @@ -0,0 +1,40 @@ +--- +title: voi +description: The voi page provides a guide on how to plot Volume + Open Interest of + calls vs puts with parameters like minimum volume, minimum strike price and maximum + strike price. It's an integral part of a python-based toolkit. +keywords: +- voi +- Volume +- Open Interest +- strike price +- plot +- minimum volume +- maximum strike price +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Plots Volume + Open Interest of calls vs puts. + +### Usage + +```python +voi [-v MIN_VOL] [-m MIN_SP] [-M MAX_SP] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| min_vol | minimum volume (considering open interest) threshold of the plot. | -1 | True | None | +| min_sp | minimum strike price to consider in the plot. | -1 | True | None | +| max_sp | maximum strike price to consider in the plot. | -1 | True | None | + +![voi](https://user-images.githubusercontent.com/46355364/154290408-ae5d50ff-74ea-4705-b8ea-e4eebc842bb6.png) + +--- diff --git a/website/content/terminal/reference/stocks/options/vol.md b/website/content/terminal/reference/stocks/options/vol.md new file mode 100644 index 000000000000..1df34ed0da3f --- /dev/null +++ b/website/content/terminal/reference/stocks/options/vol.md @@ -0,0 +1,44 @@ +--- +title: vol +description: The 'vol' page provides command-line instructions for plotting volumes. + It deals with parameters like minimal and maximal strikes, calls, and puts. The + page is mainly focused on contracts traded today and the plotting of call or put + options only. +keywords: +- vol +- volume +- contracts traded +- plot volume +- min strike +- max strike +- calls +- puts +- options +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Plot volume. Volume refers to the number of contracts traded today. + +### Usage + +```python +vol [-m MIN] [-M MAX] [-c] [-p] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| min | Min strike to plot | -1 | True | None | +| max | Max strike to plot | -1 | True | None | +| calls | Flag to plot call options only | False | True | None | +| puts | Flag to plot put options only | False | True | None | + +![vol](https://user-images.githubusercontent.com/46355364/154291303-c23edf53-4242-4d9b-a45e-22ce8a633aa8.png) + +--- diff --git a/website/content/terminal/reference/stocks/options/vsurf.md b/website/content/terminal/reference/stocks/options/vsurf.md new file mode 100644 index 000000000000..35584c2441e9 --- /dev/null +++ b/website/content/terminal/reference/stocks/options/vsurf.md @@ -0,0 +1,36 @@ +--- +title: vsurf +description: Learn the usage of vsurf, a Python tool for plotting a 3D volatility + surface. Understand the parameters and see a sample representation. +keywords: +- vsurf +- 3D volatility surface +- IV +- OI +- LP +- data visualization +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Plot 3D volatility surface. + +### Usage + +```python +vsurf [-z {IV,OI,LP}] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| z | The data for the Z axis | IV | True | IV, OI, LP | + +![vsurf](https://user-images.githubusercontent.com/46355364/154290744-1e427337-1a9a-4b84-a85a-9f07571882ba.png) + +--- diff --git a/website/versioned_docs/version-v3/terminal/reference/stocks/qa/_category_.json b/website/content/terminal/reference/stocks/qa/_category_.json similarity index 100% rename from website/versioned_docs/version-v3/terminal/reference/stocks/qa/_category_.json rename to website/content/terminal/reference/stocks/qa/_category_.json diff --git a/website/content/terminal/reference/stocks/qa/acf.md b/website/content/terminal/reference/stocks/qa/acf.md new file mode 100644 index 000000000000..1fb8b33a41fd --- /dev/null +++ b/website/content/terminal/reference/stocks/qa/acf.md @@ -0,0 +1,37 @@ +--- +title: acf +description: Explore Auto-Correlation and Partial Auto-Correlation Functions for diff + and diff diff stock data using the acf Python script command. Understand maximum + lags to display in plots. +keywords: +- Auto-Correlation +- Partial Auto-Correlation +- diff stock data +- acf +- lags +- maximum lags +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Auto-Correlation and Partial Auto-Correlation Functions for diff and diff diff stock data + +### Usage + +```python +acf [-l LAGS] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| lags | maximum lags to display in plots | 15 | True | None | + +![acf](https://user-images.githubusercontent.com/46355364/154305242-176c3ba1-ebfc-43e7-a027-46251fb02463.png) + +--- diff --git a/website/content/terminal/reference/stocks/qa/beta.md b/website/content/terminal/reference/stocks/qa/beta.md new file mode 100644 index 000000000000..8e4cddff513e --- /dev/null +++ b/website/content/terminal/reference/stocks/qa/beta.md @@ -0,0 +1,37 @@ +--- +title: beta +description: This page displays a scatter plot demonstrating the beta of two stocks + or ETFs, provides usage and parameters, including the reference ticker used for + beta calculation with a default of 'SPY'. +keywords: +- beta +- stocks +- ETFs +- scatter plot +- beta calculation +- SPY +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Displays a scatter plot demonstrating the beta of two stocks or ETFs. + +### Usage + +```python +beta [-r REF] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| ref | Reference ticker used for beta calculation. | SPY | True | None | + +![beta](https://user-images.githubusercontent.com/62662248/180587175-5e548915-0d3e-44cf-bbff-3655d51e1d64.png) + +--- diff --git a/website/content/terminal/reference/stocks/qa/bw.md b/website/content/terminal/reference/stocks/qa/bw.md new file mode 100644 index 000000000000..617e46015fd3 --- /dev/null +++ b/website/content/terminal/reference/stocks/qa/bw.md @@ -0,0 +1,34 @@ +--- +title: bw +description: The page provides details about the 'bw' command in Python for generating + Box and Whisker plots. It includes usage, parameters, and an example visual output. +keywords: +- Box and Whisker plot +- bw command +- Parameter usage +- Plot Visualization +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Box and Whisker plot + +### Usage + +```python +bw [-y] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| year | Flag to show yearly bw plot | False | True | None | + +![bw](https://user-images.githubusercontent.com/46355364/154305545-0f99fe4b-07e1-4714-8762-da3569023578.png) + +--- diff --git a/website/content/terminal/reference/stocks/qa/capm.md b/website/content/terminal/reference/stocks/qa/capm.md new file mode 100644 index 000000000000..01049b018cff --- /dev/null +++ b/website/content/terminal/reference/stocks/qa/capm.md @@ -0,0 +1,56 @@ +--- +title: capm +description: The capm page offers detailed information on analysing a stock's risk + in comparison to the market risk. Learn to use the 'capm' command and understand + Beta, Systematic Risk, and Unsystematic Risk in stock analysis. +keywords: +- capm +- stock risk +- market risk +- beta +- systematic risk +- unsystematic risk +- stock analysis +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Provides detailed information about a stock's risk compared to the market risk. + +### Usage + +```python +capm +``` + +--- + +## Parameters + +This command has no parameters + + + +--- + +## Examples + +```python +2022 Feb 16, 11:01 (🦋) /stocks/qa/ $ load tsla + +Loading Daily TSLA stock with starting period 2019-02-11 for analysis. + +Datetime: 2022 Feb 16 11:02 +Timezone: America/New_York +Currency: USD +Market: CLOSED + + +2022 Feb 16, 11:02 (🦋) /stocks/qa/ $ capm +Beta: 2.02 +Systematic Risk: 23.09% +Unsystematic Risk: 76.91% +``` +--- diff --git a/website/content/terminal/reference/stocks/qa/cdf.md b/website/content/terminal/reference/stocks/qa/cdf.md new file mode 100644 index 000000000000..637e6b3eb27e --- /dev/null +++ b/website/content/terminal/reference/stocks/qa/cdf.md @@ -0,0 +1,48 @@ +--- +title: cdf +description: The 'cdf' page outlines the usage and parameters of the cumulative distribution + function within python coding. It also includes examples and an illustrative visual + aid. +keywords: +- Cumulative distribution function +- cdf +- coding +- parameters +- examples +- usage +- export functions +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Cumulative distribution function + +### Usage + +```python +cdf +``` + +--- + +## Parameters + +This command has no parameters + + + +--- + +## Examples + +```python +optional arguments: + --export {csv,json,xlsx} + Export dataframe data to csv,json,xlsx file (default: ) + -h, --help show this help message (default: False) +``` +![cdf](https://user-images.githubusercontent.com/46355364/154306055-cb3bb1ef-0e61-40c9-bf51-d095bed8dc1b.png) + +--- diff --git a/website/content/terminal/reference/stocks/qa/cusum.md b/website/content/terminal/reference/stocks/qa/cusum.md new file mode 100644 index 000000000000..1f22b55303a4 --- /dev/null +++ b/website/content/terminal/reference/stocks/qa/cusum.md @@ -0,0 +1,38 @@ +--- +title: cusum +description: Learn to use the Cumulative Sum Algorithm (CUSUM) to effortlessly detect + abrupt changes in your data. Understand parameters like threshold and drift to improve + your data analysis. +keywords: +- cumulative sum algorithm +- CUSUM +- abrupt changes detection +- data analysis +- threshold +- drift +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Cumulative sum algorithm (CUSUM) to detect abrupt changes in data + +### Usage + +```python +cusum [-t THRESHOLD] [-d DRIFT] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| threshold | threshold | 0.0 | True | None | +| drift | drift | 0.0 | True | None | + +![cusum](https://user-images.githubusercontent.com/46355364/154306207-d68f53f4-2f9a-4c1a-8e0e-b83d49938759.png) + +--- diff --git a/website/content/terminal/reference/stocks/qa/decompose.md b/website/content/terminal/reference/stocks/qa/decompose.md new file mode 100644 index 000000000000..e9e82bebf7c9 --- /dev/null +++ b/website/content/terminal/reference/stocks/qa/decompose.md @@ -0,0 +1,53 @@ +--- +title: decompose +description: 'Decompose time series guide and examples: additive and multiplicative + models. Includes usage, parameters, and example output for time series decomposition.' +keywords: +- Decompose +- Time Series +- Additive Time Series +- Multiplicative Time Series +- Level +- CyclicTrend +- Residual +- Seasonality +- Usage +- Parameters +- Example +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Decompose time series as: - Additive Time Series = Level + CyclicTrend + Residual + Seasonality - Multiplicative Time Series = Level * CyclicTrend * Residual * Seasonality + +### Usage + +```python +decompose [-m] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| multiplicative | decompose using multiplicative model instead of additive | False | True | None | + + +--- + +## Examples + +```python +2022 Feb 16, 11:06 (🦋) /stocks/qa/ $ decompose + +Time-Series Level is 2660.84 +Strength of Trend: 0.0000 +Strength of Seasonality: 0.0032 +``` +![decompose](https://user-images.githubusercontent.com/46355364/154306626-1c5ad11e-a2e9-4107-9aec-5cf18da5358e.png) + +--- diff --git a/website/content/terminal/reference/stocks/qa/es.md b/website/content/terminal/reference/stocks/qa/es.md new file mode 100644 index 000000000000..94956a7a7cc1 --- /dev/null +++ b/website/content/terminal/reference/stocks/qa/es.md @@ -0,0 +1,56 @@ +--- +title: es +description: Documentation page for using the Expected Shortfall (ES) function in + Python. Provides detailed examples, parameter usage, and options for calculations. +keywords: +- Expected Shortfall +- stock +- distribution +- percentile +- ES +- calculations +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Provides Expected Shortfall (short: ES) of the selected stock. + +### Usage + +```python +es [-m] [-d {laplace,student_t,logistic,normal}] [-p PERCENTILE] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| use_mean | If one should use the mean of the stocks return | False | True | None | +| distributions | Distribution used for the calculations | normal | True | laplace, student_t, logistic, normal | +| percentile | Percentile for calculations, i.e. input 99.9 equals a 99.9 Percent Expected Shortfall | 99.9 | True | None | + + +--- + +## Examples + +```python +2022 Feb 25, 06:50 (🦋) /stocks/qa/ $ es + TSLA Expected Shortfall +┏━━━━━━━┳━━━━━━━━━┳━━━━━━━━━━━━━━━━┓ +┃ ┃ ES: ┃ Historical ES: ┃ +┡━━━━━━━╇━━━━━━━━━╇━━━━━━━━━━━━━━━━┩ +│ 90.0% │ -0.0752 │ -0.0705 │ +├───────┼─────────┼────────────────┤ +│ 95.0% │ -0.0885 │ -0.0932 │ +├───────┼─────────┼────────────────┤ +│ 99.0% │ -0.1144 │ -0.1561 │ +├───────┼─────────┼────────────────┤ +│ 99.9% │ -0.1444 │ -0.2106 │ +└───────┴─────────┴────────────────┘ +``` +--- diff --git a/website/content/terminal/reference/stocks/qa/hist.md b/website/content/terminal/reference/stocks/qa/hist.md new file mode 100644 index 000000000000..fbc3c6049c18 --- /dev/null +++ b/website/content/terminal/reference/stocks/qa/hist.md @@ -0,0 +1,37 @@ +--- +title: hist +description: This page provides a guide on how to use 'hist' function in Python which + plots a histogram with density and rug. It also includes parameters related information + and usage syntax. +keywords: +- Histogram +- Density +- Rug +- Usage +- Parameters +- n_bins +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Histogram with density and rug + +### Usage + +```python +hist [-b N_BINS] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| n_bins | | 15 | True | None | + +![hist](https://user-images.githubusercontent.com/46355364/154306947-aaba936a-ac07-40e2-a5a6-bf1fab460cd0.png) + +--- diff --git a/website/content/terminal/reference/stocks/qa/kurtosis.md b/website/content/terminal/reference/stocks/qa/kurtosis.md new file mode 100644 index 000000000000..22b50901b421 --- /dev/null +++ b/website/content/terminal/reference/stocks/qa/kurtosis.md @@ -0,0 +1,38 @@ +--- +title: kurtosis +description: A deeper look into Kurtosis, a measure of probability distribution of + a real-valued random variable. The page also demonstrates how to use it with python, + especially setting the window length (n_window). +keywords: +- Kurtosis +- probability distribution +- real-valued random variable +- skewness +- theoretical distribution +- n_window +- window length +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Kurtosis is a measure of the "tailedness" of the probability distribution of a real-valued random variable. Like skewness, kurtosis describes the shape of a probability distribution and there are different ways of quantifying it for a theoretical distribution and corresponding ways of estimating it from a sample from a population. Different measures of kurtosis may have different interpretations. + +### Usage + +```python +kurtosis [-w N_WINDOW] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| n_window | window length | 14 | True | None | + +![kurtosis](https://user-images.githubusercontent.com/46355364/154307174-68671146-9551-4c2f-a179-db1d4b20b992.png) + +--- diff --git a/website/content/terminal/reference/stocks/qa/line.md b/website/content/terminal/reference/stocks/qa/line.md new file mode 100644 index 000000000000..5189f16447e4 --- /dev/null +++ b/website/content/terminal/reference/stocks/qa/line.md @@ -0,0 +1,39 @@ +--- +title: line +description: Learn how to create a line plot of selected data with the option to highlight + specific datetimes using vertical line markers and scatter markers. You can also + plot with y on the log scale. +keywords: +- line plot +- data visualization +- plotting data +- scatter markers +- vertical line markers +- log scale +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Show line plot of selected data or highlight specific datetimes. + +### Usage + +```python +line [--log] [--ml ML] [--ms MS] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| log | Plot with y on log scale | False | True | None | +| ml | Draw vertical line markers to highlight certain events | | True | None | +| ms | Draw scatter markers to highlight certain events | | True | None | + +![line](https://user-images.githubusercontent.com/46355364/154307397-9c2e9325-bce6-494d-994f-a6d7db798798.png) + +--- diff --git a/website/content/terminal/reference/stocks/qa/load.md b/website/content/terminal/reference/stocks/qa/load.md new file mode 100644 index 000000000000..a4bf519ea101 --- /dev/null +++ b/website/content/terminal/reference/stocks/qa/load.md @@ -0,0 +1,47 @@ +--- +title: load +description: This page provides information on loading stock tickers for analysis + and includes usage examples and parameters details. It also explains how to handle + Indian tickers and find available markets. +keywords: +- stock analysis +- load stock ticker +- financial data +- stock market data +- Indian stock market +- financial analysis parameters +- market hours +- custom file loading +- intraday stock minutes +- monthly data +- weekly data +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Load stock ticker to perform analysis on. When the data source is syf', an Indian ticker can be loaded by using '.NS' at the end, e.g. 'SBIN.NS'. See available market in https://help.yahoo.com/kb/exchanges-data-providers-yahoo-finance-sln2310.html. + +### Usage + +```python +load -t TICKER [-s START] [-e END] [-i {1,5,15,30,60}] [-p] [-f FILEPATH] [-m] [-w] [-r {ytd,1y,2y,5y,6m}] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| ticker | Stock ticker | None | False | None | +| start | The starting date (format YYYY-MM-DD) of the stock | 2019-11-21 | True | None | +| end | The ending date (format YYYY-MM-DD) of the stock | 2022-11-25 | True | None | +| interval | Intraday stock minutes | 1440 | True | 1, 5, 15, 30, 60 | +| prepost | Pre/After market hours. Only works for 'yf' source, and intraday data | False | True | None | +| filepath | Path to load custom file. | None | True | None | +| monthly | Load monthly data | False | True | None | +| weekly | Load weekly data | False | True | None | + +--- diff --git a/website/content/terminal/reference/stocks/qa/normality.md b/website/content/terminal/reference/stocks/qa/normality.md new file mode 100644 index 000000000000..e32f5b1eb6f9 --- /dev/null +++ b/website/content/terminal/reference/stocks/qa/normality.md @@ -0,0 +1,59 @@ +--- +title: normality +description: This page provides information on normality tests, including usage, parameters, + and examples. It includes different statistical tests such as Kurtosis, Skewness, + Jarque-Bera, Shapiro-Wilk, and Kolmogorov-Smirnov. +keywords: +- Normality tests +- Normality Statistics +- Kurtosis +- Skewness +- Jarque-Bera +- Shapiro-Wilk +- Kolmogorov-Smirnov +- p-value +- Statistic +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Normality tests + +### Usage + +```python +normality +``` + +--- + +## Parameters + +This command has no parameters + + + +--- + +## Examples + +```python +2022 Feb 16, 11:11 (🦋) /stocks/qa/ $ normality + Normality Statistics +┏━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━┳━━━━━━━━━┓ +┃ ┃ Statistic ┃ p-value ┃ +┡━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━╇━━━━━━━━━┩ +│ Kurtosis │ 10.2422 │ 0.0000 │ +├────────────────────┼───────────┼─────────┤ +│ Skewness │ -0.2238 │ 0.8229 │ +├────────────────────┼───────────┼─────────┤ +│ Jarque-Bera │ 1155.1958 │ 0.0000 │ +├────────────────────┼───────────┼─────────┤ +│ Shapiro-Wilk │ 0.9265 │ 0.0000 │ +├────────────────────┼───────────┼─────────┤ +│ Kolmogorov-Smirnov │ 0.4680 │ 0.0000 │ +└────────────────────┴───────────┴─────────┘ +``` +--- diff --git a/website/content/terminal/reference/stocks/qa/om.md b/website/content/terminal/reference/stocks/qa/om.md new file mode 100644 index 000000000000..0afc87eb0c28 --- /dev/null +++ b/website/content/terminal/reference/stocks/qa/om.md @@ -0,0 +1,35 @@ +--- +title: om +description: This page provides detailed guidance on how to use the omega ratio function + (om) for stock analysis with Python, including usage instructions and parameters. +keywords: +- omega ratio +- stock analysis +- financial analytics +- stock market +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Provides omega ratio of the selected stock. + +### Usage + +```python +om [-s START] [-e END] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| start | Start of the omega ratio threshold | 0 | True | None | +| end | End of the omega ratio threshold | 1.5 | True | None | + +![image](https://user-images.githubusercontent.com/75195383/163530147-557ad48b-c6ec-43d3-8d33-6ad4f02a6cfb.png) + +--- diff --git a/website/content/terminal/reference/stocks/qa/pick.md b/website/content/terminal/reference/stocks/qa/pick.md new file mode 100644 index 000000000000..8b1b17c45b2c --- /dev/null +++ b/website/content/terminal/reference/stocks/qa/pick.md @@ -0,0 +1,59 @@ +--- +title: pick +description: This page provides information on how to select different parameters + (like high, low, close etc.) for daily stock analysis, especially for TSLA stocks. + It explains the usage of the 'pick' command within the Python environment for stock + parameter selection. +keywords: +- target variable +- stock analysis +- daily stock +- tsla stock +- pick +- stock parameter selection +- stock market +- stock data manipulation +- market data +- financial data analysis +- time series data +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Change target variable + +### Usage + +```python +pick [-t {open,high,low,close,adjclose,volume,date_id,oc_high,oc_low,returns,logret,logprice}] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| target | Select variable to analyze | None | True | open, high, low, close, adjclose, volume, date_id, oc_high, oc_low, returns, logret, logprice | + + +--- + +## Examples + +```python +2022 Feb 16, 11:12 (🦋) /stocks/qa/ $ load tsla + +Loading Daily TSLA stock with starting period 2019-02-11 for analysis. + +Datetime: 2022 Feb 16 11:12 +Timezone: America/New_York +Currency: USD +Market: CLOSED + + +2022 Feb 16, 11:12 (🦋) /stocks/qa/ $ pick adjclose +``` +--- diff --git a/website/content/terminal/reference/stocks/qa/qqplot.md b/website/content/terminal/reference/stocks/qa/qqplot.md new file mode 100644 index 000000000000..6df07466eb02 --- /dev/null +++ b/website/content/terminal/reference/stocks/qa/qqplot.md @@ -0,0 +1,33 @@ +--- +title: qqplot +description: Discover the usage of QQ plot in Python to help with data visualization + of normal quantiles. This page provides information with no parameters required + to use it. +keywords: +- qqplot +- normal quantiles +- data visualization +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Display QQ plot vs normal quantiles + +### Usage + +```python +qqplot +``` + +--- + +## Parameters + +This command has no parameters + + +![qqplot](https://user-images.githubusercontent.com/46355364/154307858-acd1a7d0-bb40-4639-a69c-c316749a90ab.png) + +--- diff --git a/website/content/terminal/reference/stocks/qa/quantile.md b/website/content/terminal/reference/stocks/qa/quantile.md new file mode 100644 index 000000000000..4be1ba4711d2 --- /dev/null +++ b/website/content/terminal/reference/stocks/qa/quantile.md @@ -0,0 +1,38 @@ +--- +title: quantile +description: This page provides insights into the concept of 'Quantile' and how it's + used for dividing a distribution. It includes parameter details such as n_window + and f_quantile and usage information with Python. +keywords: +- quantile +- distribution +- median +- n_window +- f_quantile +- observations +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +The quantiles are values which divide the distribution such that there is a given proportion of observations below the quantile. For example, the median is a quantile. The median is the central value of the distribution, such that half the points are less than or equal to it and half are greater than or equal to it. By default, q is set at 0.5, which effectively is median. Change q to get the desired quantile (0q1). + +### Usage + +```python +quantile [-w N_WINDOW] [-q F_QUANTILE] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| n_window | window length | 14 | True | None | +| f_quantile | quantile | 0.5 | True | None | + +![quantile](https://user-images.githubusercontent.com/46355364/154307976-868e98e1-5a30-43c7-92fc-f221d09c5bd2.png) + +--- diff --git a/website/content/terminal/reference/stocks/qa/raw.md b/website/content/terminal/reference/stocks/qa/raw.md new file mode 100644 index 000000000000..10be69c07f0f --- /dev/null +++ b/website/content/terminal/reference/stocks/qa/raw.md @@ -0,0 +1,90 @@ +--- +title: raw +description: This page explains the 'raw' function related to financial data manipulation, + including its usage, parameters and some examples on how to use it in Python. It + cover topics such as sorting raw data, displaying limit number of data points and + reverse sorting. +keywords: +- raw data +- financial data +- data manipulation +- sorting raw data +- reverse sorting +- display limit +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Print raw data to console + +### Usage + +```python +raw [-l LIMIT] [-r] [-s {open,high,low,close,adjclose,volume,date_id,oc_high,oc_low,returns,logret,logprice}] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| limit | Number to show | 20 | True | None | +| reverse | Data is sorted in descending order by default. Reverse flag will sort it in an ascending way. Only works when raw data is displayed. | False | True | None | +| sortby | The column to sort by | None | True | open, high, low, close, adjclose, volume, date_id, oc_high, oc_low, returns, logret, logprice | + + +--- + +## Examples + +```python +2022 Feb 16, 11:05 (🦋) /stocks/qa/ $ raw + Raw Data +┏━━━━━━━━━━━━┳━━━━━━━━━━┓ +┃ ┃ Adjclose ┃ +┡━━━━━━━━━━━━╇━━━━━━━━━━┩ +│ 2022-01-19 │ 995.650 │ +├────────────┼──────────┤ +│ 2022-01-20 │ 996.270 │ +├────────────┼──────────┤ +│ 2022-01-21 │ 943.900 │ +├────────────┼──────────┤ +│ 2022-01-24 │ 930.000 │ +├────────────┼──────────┤ +│ 2022-01-25 │ 918.400 │ +├────────────┼──────────┤ +│ 2022-01-26 │ 937.410 │ +├────────────┼──────────┤ +│ 2022-01-27 │ 829.100 │ +├────────────┼──────────┤ +│ 2022-01-28 │ 846.350 │ +├────────────┼──────────┤ +│ 2022-01-31 │ 936.720 │ +├────────────┼──────────┤ +│ 2022-02-01 │ 931.250 │ +├────────────┼──────────┤ +│ 2022-02-02 │ 905.660 │ +├────────────┼──────────┤ +│ 2022-02-03 │ 891.140 │ +├────────────┼──────────┤ +│ 2022-02-04 │ 923.320 │ +├────────────┼──────────┤ +│ 2022-02-07 │ 907.340 │ +├────────────┼──────────┤ +│ 2022-02-08 │ 922.000 │ +├────────────┼──────────┤ +│ 2022-02-09 │ 932.000 │ +├────────────┼──────────┤ +│ 2022-02-10 │ 904.550 │ +├────────────┼──────────┤ +│ 2022-02-11 │ 860.000 │ +├────────────┼──────────┤ +│ 2022-02-14 │ 875.760 │ +├────────────┼──────────┤ +│ 2022-02-15 │ 922.430 │ +└────────────┴──────────┘ +``` +--- diff --git a/website/content/terminal/reference/stocks/qa/rolling.md b/website/content/terminal/reference/stocks/qa/rolling.md new file mode 100644 index 000000000000..60b082fcfa9f --- /dev/null +++ b/website/content/terminal/reference/stocks/qa/rolling.md @@ -0,0 +1,37 @@ +--- +title: rolling +description: The document displays a brief overview about rolling mean and standard + deviation. It includes usage explanation, parameters description with special emphasis + on window length and an illustrative diagram. +keywords: +- Rolling mean +- Standard deviation +- Usage +- Parameters +- n_window +- Window length +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Rolling mean and std deviation + +### Usage + +```python +rolling [-w N_WINDOW] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| n_window | Window length | 14 | True | None | + +![rolling](https://user-images.githubusercontent.com/46355364/154308175-bb244d55-a6e0-4d6e-80f4-b3937dcd8ed4.png) + +--- diff --git a/website/content/terminal/reference/stocks/qa/sh.md b/website/content/terminal/reference/stocks/qa/sh.md new file mode 100644 index 000000000000..42f712441536 --- /dev/null +++ b/website/content/terminal/reference/stocks/qa/sh.md @@ -0,0 +1,38 @@ +--- +title: sh +description: A comprehensive documentation page provides information about the Sharpe + ratio of a selected stock. It includes parameters such as risk-free return and rolling + window length, along with their usage presented in Python code. +keywords: +- Sharpe Ratio +- Stock +- Risk Free Return +- Rolling Window Length +- Finance +- Investment +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Provides the sharpe ratio of the selected stock. + +### Usage + +```python +sh [-r RFR] [-w WINDOW] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| rfr | Risk free return | 0 | True | None | +| window | Rolling window length | 1 | True | None | + +![image](https://user-images.githubusercontent.com/75195383/163530426-77abe5ac-9c21-43e5-a975-5a37c7eb452f.png) + +--- diff --git a/website/content/terminal/reference/stocks/qa/skew.md b/website/content/terminal/reference/stocks/qa/skew.md new file mode 100644 index 000000000000..0c4924269fff --- /dev/null +++ b/website/content/terminal/reference/stocks/qa/skew.md @@ -0,0 +1,38 @@ +--- +title: skew +description: The skew page describes skewness as a measure of asymmetry or distortion + of a symmetric distribution, such as a normal distribution. Skewness measures the + deviation of a random variable from a symmetric distribution. The page also details + the usage and parameters of the 'skew' function. +keywords: +- skew +- asymmetry +- symmetric distribution +- normal distribution +- deviation +- n_window parameter +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Skewness is a measure of asymmetry or distortion of symmetric distribution. It measures the deviation of the given distribution of a random variable from a symmetric distribution, such as normal distribution. A normal distribution is without any skewness, as it is symmetrical on both sides. Hence, a curve is regarded as skewed if it is shifted towards the right or the left. + +### Usage + +```python +skew [-w N_WINDOW] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| n_window | window length | 14 | True | None | + +![skew](https://user-images.githubusercontent.com/46355364/154308298-7528be2a-05f5-44b8-a479-d4716b2a6c6e.png) + +--- diff --git a/website/content/terminal/reference/stocks/qa/so.md b/website/content/terminal/reference/stocks/qa/so.md new file mode 100644 index 000000000000..4a66d91d3476 --- /dev/null +++ b/website/content/terminal/reference/stocks/qa/so.md @@ -0,0 +1,40 @@ +--- +title: so +description: This page provides information on how to calculate the Sortino ratio + of a selected stock, including parameters for target return, adjusting the Sortino + ratio for comparison with the Sharpe ratio, and setting the rolling window length. +keywords: +- sortino ratio +- stock analysis +- target return +- adjusted sortino ratio +- rolling window length +- sharpe ratio +- investment strategy +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Provides the sortino ratio of the selected stock. + +### Usage + +```python +so [-t TARGET_RETURN] [-a] [-w WINDOW] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| target_return | Target return | 0 | True | None | +| adjusted | If one should adjust the sortino ratio inorder to make it comparable to the sharpe ratio | False | True | None | +| window | Rolling window length | 1 | True | None | + +![image](https://user-images.githubusercontent.com/75195383/163530572-e527bc75-7ecd-44e3-b971-83b9a0662d0d.png) + +--- diff --git a/website/content/terminal/reference/stocks/qa/spread.md b/website/content/terminal/reference/stocks/qa/spread.md new file mode 100644 index 000000000000..af0196bdc186 --- /dev/null +++ b/website/content/terminal/reference/stocks/qa/spread.md @@ -0,0 +1,35 @@ +--- +title: spread +description: The 'spread' page shows the rolling spread measurement. Users can learn + how to use the 'spread' command, including its parameters such as 'n_window' which + defines the window length. +keywords: +- spread +- rolling spread measurement +- n_window +- window length +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Shows rolling spread measurement + +### Usage + +```python +spread [-w N_WINDOW] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| n_window | Window length | 14 | True | None | + +![spread](https://user-images.githubusercontent.com/46355364/154308406-f20812a4-fa04-4937-b8de-dc27042f7462.png) + +--- diff --git a/website/content/terminal/reference/stocks/qa/summary.md b/website/content/terminal/reference/stocks/qa/summary.md new file mode 100644 index 000000000000..e367d367abe6 --- /dev/null +++ b/website/content/terminal/reference/stocks/qa/summary.md @@ -0,0 +1,76 @@ +--- +title: summary +description: Documentation for the 'summary' function on the marketing website. This + feature provides detailed summary statistics on stocks, including parameters like + open, high, low, close, adjclose, volume, returns, and more. +keywords: +- summary function +- stocks +- statistics +- stock data +- stock volume +- stock returns +- data analysis +- market analysis +- open price +- close price +- high price +- low price +- adjusted close price +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Summary statistics + +### Usage + +```python +summary +``` + +--- + +## Parameters + +This command has no parameters + + + +--- + +## Examples + +```python +2022 Feb 16, 11:16 (🦋) /stocks/qa/ $ summary + + Summary Statistics +┏━━━━━━━┳━━━━━━━━━━┳━━━━━━━━━━┳━━━━━━━━━━┳━━━━━━━━━━┳━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━┳━━━━━━━━━┳━━━━━━━━━━┓ +┃ ┃ open ┃ high ┃ low ┃ close ┃ adjclose ┃ volume ┃ returns ┃ logret ┃ logprice ┃ +┡━━━━━━━╇━━━━━━━━━━╇━━━━━━━━━━╇━━━━━━━━━━╇━━━━━━━━━━╇━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━╇━━━━━━━━━╇━━━━━━━━━━┩ +│ count │ 760.000 │ 760.000 │ 760.000 │ 760.000 │ 760.000 │ 760.000 │ 760.000 │ 760.000 │ 760.000 │ +├───────┼──────────┼──────────┼──────────┼──────────┼──────────┼─────────────────────┼─────────┼─────────┼──────────┤ +│ mean │ 203.131 │ 205.470 │ 200.350 │ 202.963 │ 202.963 │ 18581311.316 │ -0.000 │ -0.000 │ 5.288 │ +├───────┼──────────┼──────────┼──────────┼──────────┼──────────┼─────────────────────┼─────────┼─────────┼──────────┤ +│ std │ 44.546 │ 44.825 │ 44.020 │ 44.497 │ 44.497 │ 10992756.504 │ 0.025 │ 0.025 │ 0.224 │ +├───────┼──────────┼──────────┼──────────┼──────────┼──────────┼─────────────────────┼─────────┼─────────┼──────────┤ +│ min │ 112.630 │ 114.200 │ 108.700 │ 111.790 │ 111.790 │ 5523000.000 │ -0.133 │ -0.143 │ 4.717 │ +├───────┼──────────┼──────────┼──────────┼──────────┼──────────┼─────────────────────┼─────────┼─────────┼──────────┤ +│ 10% │ 152.144 │ 153.973 │ 150.186 │ 151.635 │ 151.635 │ 9561170.000 │ -0.030 │ -0.030 │ 5.021 │ +├───────┼──────────┼──────────┼──────────┼──────────┼──────────┼─────────────────────┼─────────┼─────────┼──────────┤ +│ 25% │ 171.659 │ 174.392 │ 169.912 │ 171.858 │ 171.858 │ 12144500.000 │ -0.012 │ -0.013 │ 5.147 │ +├───────┼──────────┼──────────┼──────────┼──────────┼──────────┼─────────────────────┼─────────┼─────────┼──────────┤ +│ 50% │ 199.905 │ 202.325 │ 197.335 │ 200.000 │ 200.000 │ 15985100.000 │ 0.000 │ 0.000 │ 5.298 │ +├───────┼──────────┼──────────┼──────────┼──────────┼──────────┼─────────────────────┼─────────┼─────────┼──────────┤ +│ 75% │ 229.373 │ 231.640 │ 226.552 │ 229.478 │ 229.478 │ 21443775.000 │ 0.014 │ 0.014 │ 5.436 │ +├───────┼──────────┼──────────┼──────────┼──────────┼──────────┼─────────────────────┼─────────┼─────────┼──────────┤ +│ 90% │ 265.203 │ 268.028 │ 262.522 │ 265.506 │ 265.506 │ 28987730.000 │ 0.029 │ 0.029 │ 5.582 │ +├───────┼──────────┼──────────┼──────────┼──────────┼──────────┼─────────────────────┼─────────┼─────────┼──────────┤ +│ max │ 313.500 │ 319.320 │ 308.910 │ 317.140 │ 317.140 │ 141830000.000 │ 0.104 │ 0.099 │ 5.759 │ +├───────┼──────────┼──────────┼──────────┼──────────┼──────────┼─────────────────────┼─────────┼─────────┼──────────┤ +│ var │ 1984.325 │ 2009.289 │ 1937.717 │ 1979.969 │ 1979.969 │ 120840695549911.328 │ 0.001 │ 0.001 │ 0.050 │ +└───────┴──────────┴──────────┴──────────┴──────────┴──────────┴─────────────────────┴─────────┴─────────┴──────────┘ +``` +--- diff --git a/website/content/terminal/reference/stocks/qa/unitroot.md b/website/content/terminal/reference/stocks/qa/unitroot.md new file mode 100644 index 000000000000..6e48913b574c --- /dev/null +++ b/website/content/terminal/reference/stocks/qa/unitroot.md @@ -0,0 +1,62 @@ +--- +title: unitroot +description: This documentation page provides a detailed guide on how to use 'unitroot', + a python function for executing unit root tests including ADF and KPSS. It includes + parameters details, their choices, and usage examples. +keywords: +- unitroot +- ADF +- KPSS +- stationarity +- root test +- fuller_reg +- kpss_reg +- regression +- stock +- statistics +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Unit root test / stationarity (ADF, KPSS) + +### Usage + +```python +unitroot [-r {c,ct,ctt,nc}] [-k {c,ct}] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| fuller_reg | Type of regression. Can be ‘c’,’ct’,’ctt’,’nc’ 'c' - Constant and t - trend order | c | True | c, ct, ctt, nc | +| kpss_reg | Type of regression. Can be ‘c’,’ct' | c | True | c, ct | + + +--- + +## Examples + +```python +2022 Feb 16, 11:16 (🦋) /stocks/qa/ $ unitroot + Unit Root Calculation +┏━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━┳━━━━━━━━┓ +┃ ┃ ADF ┃ KPSS ┃ +┡━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━╇━━━━━━━━┩ +│ Test Statistic │ -28.9536 │ 0.2928 │ +├────────────────┼────────────┼────────┤ +│ P-Value │ 0.0000 │ 0.1000 │ +├────────────────┼────────────┼────────┤ +│ NLags │ 0.0000 │ 3 │ +├────────────────┼────────────┼────────┤ +│ Nobs │ 759.0000 │ │ +├────────────────┼────────────┼────────┤ +│ ICBest │ -3339.2013 │ │ +└────────────────┴────────────┴────────┘ +``` +--- diff --git a/website/content/terminal/reference/stocks/qa/var.md b/website/content/terminal/reference/stocks/qa/var.md new file mode 100644 index 000000000000..32e9526d8e04 --- /dev/null +++ b/website/content/terminal/reference/stocks/qa/var.md @@ -0,0 +1,62 @@ +--- +title: var +description: The page provides a comprehensive guide on the usage of 'var' command + for calculating Value at Risk (VaR) of selected stocks. It includes details on parameters, + usage, and examples. +keywords: +- Value at Risk +- var +- stocks +- stock trading +- VaR calculation +- portfolio management +- risk management +- quantitative analysis +- financial tools +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Provides value at risk (short: VaR) of the selected stock. + +### Usage + +```python +var [-m] [-a] [-s] [-p PERCENTILE] [-d DATA_RANGE] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| use_mean | If one should use the mean of the stocks return | False | True | None | +| adjusted | If the VaR should be adjusted for skew and kurtosis (Cornish-Fisher-Expansion) | False | True | None | +| student_t | If one should use the student-t distribution | False | True | None | +| percentile | Percentile used for VaR calculations, for example input 99.9 equals a 99.9 Percent VaR | 99.9 | True | None | +| data_range | Number of rows you want to use VaR over, ex: if you are using days, 30 would show VaR for the last 30 TRADING days | 0 | True | None | + + +--- + +## Examples + +```python +2022 Feb 16, 11:18 (🦋) /stocks/qa/ $ var + FB Value at Risk +┏━━━━━━━┳━━━━━━━━━┳━━━━━━━━━━━━━━━━━┓ +┃ ┃ VaR: ┃ Historical VaR: ┃ +┡━━━━━━━╇━━━━━━━━━╇━━━━━━━━━━━━━━━━━┩ +│ 90.0% │ -0.0305 │ -0.0233 │ +├───────┼─────────┼─────────────────┤ +│ 95.0% │ -0.0389 │ -0.0364 │ +├───────┼─────────┼─────────────────┤ +│ 99.0% │ -0.0546 │ -0.0578 │ +├───────┼─────────┼─────────────────┤ +│ 99.9% │ -0.0719 │ -0.1719 │ +└───────┴─────────┴─────────────────┘ +``` +--- diff --git a/website/content/terminal/reference/stocks/quote.md b/website/content/terminal/reference/stocks/quote.md new file mode 100644 index 000000000000..2d80db021ae6 --- /dev/null +++ b/website/content/terminal/reference/stocks/quote.md @@ -0,0 +1,36 @@ +--- +title: quote +description: This page provides the information about the quote for a specific stock + ticker. It explains how to use the quote function in Python and provides the details + of the parameters that are used in this function. The primary parameter is the stock + ticker, also referred to as 's_ticker'. +keywords: +- Quote +- Stock Ticker +- Parameters +- s_ticker +- USAGE +- Stocks +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Current quote for stock ticker + +### Usage + +```python +quote -t S_TICKER +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| s_ticker | stocks/QUOTE_ticker | None | False | None | + +--- diff --git a/website/versioned_docs/version-v3/terminal/reference/stocks/screener/_category_.json b/website/content/terminal/reference/stocks/screener/_category_.json similarity index 100% rename from website/versioned_docs/version-v3/terminal/reference/stocks/screener/_category_.json rename to website/content/terminal/reference/stocks/screener/_category_.json diff --git a/website/content/terminal/reference/stocks/screener/financial.md b/website/content/terminal/reference/stocks/screener/financial.md new file mode 100644 index 000000000000..3db7beca83f1 --- /dev/null +++ b/website/content/terminal/reference/stocks/screener/financial.md @@ -0,0 +1,45 @@ +--- +title: financial +description: This page details the use of the financial function that displays filtered + financial data of relevant companies. It details the various parameters including + preset filters, data sorting instructions, stock limits and more. +keywords: +- financial data +- financial filtering +- preset filters +- data sort +- stock limits +- financial parameters +- data ascending +- data descending +- financial commands +- financial programming +- python financial commands +- stock market commands +- stock analysis +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Prints financial data of the companies that meet the pre-set filtering. + +### Usage + +```python +financial [-p Desired preset.] [-l LIMIT] [-r] [-s SORT] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| preset | Filter presets | top_gainers | True | template, oversold_under_5dol, potential_reversals, top_performers_all, death_cross, unusual_volume, news_scanner, cheap_bottom_dividend, cheap_dividend, top_performers_healthcare, bull_runs_over_10pct, value_stocks, golden_cross, growth_stocks, channel_up_and_low_debt_and_sma_50and200, buffett_like, continued_momentum_scan, analyst_strong_buy, under_15dol_stocks, 5pct_above_low, cheap_oversold, weak_support_and_top_performers, undervalue, oversold_under_3dol, top_performers_tech, rosenwald_gtfo, recent_growth_and_support, heavy_inst_ins, modified_neff, simplistic_momentum_scanner_under_7dol, golden_cross_penny, break_out_stocks, high_vol_and_low_debt, stocks_strong_support_levels, sexy_year, short_squeeze_scan, oversold, rosenwald, modified_dreman, top_gainers, top_losers, new_high, new_low, most_volatile, most_active, overbought, downgrades, upgrades, earnings_before, earnings_after, recent_insider_buying, recent_insider_selling, major_news, horizontal_sr, tl_resistance, tl_support, wedge_up, wedge_down, wedge, triangle_ascending, triangle_descending, channel_up, channel_down, channel, double_top, double_bottom, multiple_top, multiple_bottom, head_shoulders, head_shoulders_inverse | +| limit | Limit of stocks to print | 10 | True | None | +| reverse | Data is sorted in descending order by default. Reverse flag will sort it in an ascending way. Only works when raw data is displayed. | False | True | None | +| sort | Sort elements of the table. | Ticker | True | ticker, marketcap, dividend, roa, roe, roi, currr, quickr, ltdebt/eq, debt/eq, grossm, operm, profitm, earnings, price, change, volume | + +--- diff --git a/website/content/terminal/reference/stocks/screener/historical.md b/website/content/terminal/reference/stocks/screener/historical.md new file mode 100644 index 000000000000..dcc47a8f8891 --- /dev/null +++ b/website/content/terminal/reference/stocks/screener/historical.md @@ -0,0 +1,44 @@ +--- +title: historical +description: The page outlines the use of the historical function, allowing users + to compare stock prices of companies historically. It provides details on usage + and parameters such as limits, date formats, types of candles, and more. The data + comes from sources like Yahoo Finance. +keywords: +- historical +- price comparison +- similar companies +- Yahoo Finance +- parameters +- limit +- no_scale +- start +- type_candle +- date format +- shorted stocks +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Historical price comparison between similar companies [Source: Yahoo Finance] + +### Usage + +```python +historical [-l LIMIT] [-n] [-s START] [-t {o,h,l,c,a}] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| limit | Limit of the most shorted stocks to retrieve. | 10 | True | None | +| no_scale | Flag to not put all prices on same 0-1 scale | False | True | None | +| start | The starting date (format YYYY-MM-DD) of the historical price to plot | 2022-05-29 | True | None | +| type_candle | type of candles: o-open, h-high, l-low, c-close, a-adjusted close. | a | True | o, h, l, c, a | + +--- diff --git a/website/content/terminal/reference/stocks/screener/overview.md b/website/content/terminal/reference/stocks/screener/overview.md new file mode 100644 index 000000000000..fddb831a5751 --- /dev/null +++ b/website/content/terminal/reference/stocks/screener/overview.md @@ -0,0 +1,45 @@ +--- +title: overview +description: This documentation provides a comprehensive guide on the overview function + which displays a brief data of companies based on predefined filters. It can limit + the stocks to print, reverse the sorting order, and sort table elements. +keywords: +- overview +- filter presets +- limit +- reverse +- sort +- stocks +- stock print +- data sorting +- table elements +- stock analysis +- commands +- parameters +- pre-set filtering +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Prints overview data of the companies that meet the pre-set filtering. + +### Usage + +```python +overview [-p Desired preset.] [-l LIMIT] [-r] [-s SORT] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| preset | Filter presets | top_gainers | True | template, oversold_under_5dol, potential_reversals, top_performers_all, death_cross, unusual_volume, news_scanner, cheap_bottom_dividend, cheap_dividend, top_performers_healthcare, bull_runs_over_10pct, value_stocks, golden_cross, growth_stocks, channel_up_and_low_debt_and_sma_50and200, buffett_like, continued_momentum_scan, analyst_strong_buy, under_15dol_stocks, 5pct_above_low, cheap_oversold, weak_support_and_top_performers, undervalue, oversold_under_3dol, top_performers_tech, rosenwald_gtfo, recent_growth_and_support, heavy_inst_ins, modified_neff, simplistic_momentum_scanner_under_7dol, golden_cross_penny, break_out_stocks, high_vol_and_low_debt, stocks_strong_support_levels, sexy_year, short_squeeze_scan, oversold, rosenwald, modified_dreman, top_gainers, top_losers, new_high, new_low, most_volatile, most_active, overbought, downgrades, upgrades, earnings_before, earnings_after, recent_insider_buying, recent_insider_selling, major_news, horizontal_sr, tl_resistance, tl_support, wedge_up, wedge_down, wedge, triangle_ascending, triangle_descending, channel_up, channel_down, channel, double_top, double_bottom, multiple_top, multiple_bottom, head_shoulders, head_shoulders_inverse | +| limit | Limit of stocks to print | 10 | True | None | +| reverse | Data is sorted in descending order by default. Reverse flag will sort it in an ascending way. Only works when raw data is displayed. | False | True | None | +| sort | Sort elements of the table. | Ticker | True | ticker, company, sector, industry, country, marketcap, p/e, price, change, volume | + +--- diff --git a/website/content/terminal/reference/stocks/screener/ownership.md b/website/content/terminal/reference/stocks/screener/ownership.md new file mode 100644 index 000000000000..776ed7f3c2fd --- /dev/null +++ b/website/content/terminal/reference/stocks/screener/ownership.md @@ -0,0 +1,43 @@ +--- +title: ownership +description: This documentation page includes detailed information about the 'ownership' + feature. Users can learn about the usage, available parameters, and filtering presets + to extract specific ownership data of companies. +keywords: +- ownership +- ownership data +- companies data +- usage +- parameters +- preset +- filter presets +- limit +- reverse +- sort +- stocks +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Prints ownership data of the companies that meet the pre-set filtering. + +### Usage + +```python +ownership [-p Desired preset.] [-l LIMIT] [-r] [-s SORT] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| preset | Filter presets | top_gainers | True | template, oversold_under_5dol, potential_reversals, top_performers_all, death_cross, unusual_volume, news_scanner, cheap_bottom_dividend, cheap_dividend, top_performers_healthcare, bull_runs_over_10pct, value_stocks, golden_cross, growth_stocks, channel_up_and_low_debt_and_sma_50and200, buffett_like, continued_momentum_scan, analyst_strong_buy, under_15dol_stocks, 5pct_above_low, cheap_oversold, weak_support_and_top_performers, undervalue, oversold_under_3dol, top_performers_tech, rosenwald_gtfo, recent_growth_and_support, heavy_inst_ins, modified_neff, simplistic_momentum_scanner_under_7dol, golden_cross_penny, break_out_stocks, high_vol_and_low_debt, stocks_strong_support_levels, sexy_year, short_squeeze_scan, oversold, rosenwald, modified_dreman, top_gainers, top_losers, new_high, new_low, most_volatile, most_active, overbought, downgrades, upgrades, earnings_before, earnings_after, recent_insider_buying, recent_insider_selling, major_news, horizontal_sr, tl_resistance, tl_support, wedge_up, wedge_down, wedge, triangle_ascending, triangle_descending, channel_up, channel_down, channel, double_top, double_bottom, multiple_top, multiple_bottom, head_shoulders, head_shoulders_inverse | +| limit | Limit of stocks to print | 10 | True | None | +| reverse | Data is sorted in descending order by default. Reverse flag will sort it in an ascending way. Only works when raw data is displayed. | False | True | None | +| sort | Sort elements of the table. | Ticker | True | ticker, marketcap, outstanding, float, insiderown, insidertrans, instown, insttrans, floatshort, shortratio, avgvolume, price, change, volume | + +--- diff --git a/website/content/terminal/reference/stocks/screener/performance.md b/website/content/terminal/reference/stocks/screener/performance.md new file mode 100644 index 000000000000..e2f85853d644 --- /dev/null +++ b/website/content/terminal/reference/stocks/screener/performance.md @@ -0,0 +1,42 @@ +--- +title: performance +description: This page outlines the parameters and usage for retrieving performance + data of various stocks, using predefined filter presets. It provides different ways + of sorting and limiting the data output. +keywords: +- performance data +- filter presets +- stock analysis +- top performers +- overbought stocks +- oversold stocks +- stock sorting +- stock scanning +- stock volatility +- stock volume +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Prints performance data of the companies that meet the pre-set filtering. + +### Usage + +```python +performance [-p Desired preset.] [-l LIMIT] [-r] [-s SORTBY] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| preset | Filter presets | top_gainers | True | template, oversold_under_5dol, potential_reversals, top_performers_all, death_cross, unusual_volume, news_scanner, cheap_bottom_dividend, cheap_dividend, top_performers_healthcare, bull_runs_over_10pct, value_stocks, golden_cross, growth_stocks, channel_up_and_low_debt_and_sma_50and200, buffett_like, continued_momentum_scan, analyst_strong_buy, under_15dol_stocks, 5pct_above_low, cheap_oversold, weak_support_and_top_performers, undervalue, oversold_under_3dol, top_performers_tech, rosenwald_gtfo, recent_growth_and_support, heavy_inst_ins, modified_neff, simplistic_momentum_scanner_under_7dol, golden_cross_penny, break_out_stocks, high_vol_and_low_debt, stocks_strong_support_levels, sexy_year, short_squeeze_scan, oversold, rosenwald, modified_dreman, top_gainers, top_losers, new_high, new_low, most_volatile, most_active, overbought, downgrades, upgrades, earnings_before, earnings_after, recent_insider_buying, recent_insider_selling, major_news, horizontal_sr, tl_resistance, tl_support, wedge_up, wedge_down, wedge, triangle_ascending, triangle_descending, channel_up, channel_down, channel, double_top, double_bottom, multiple_top, multiple_bottom, head_shoulders, head_shoulders_inverse | +| limit | Limit of stocks to print | 10 | True | None | +| reverse | Data is sorted in descending order by default. Reverse flag will sort it in an ascending way. Only works when raw data is displayed. | False | True | None | +| sort | Sort elements of the table. | Ticker | True | ticker, perfweek, perfmonth, perfquart, perfhalf, perfyear, perfytd, volatilityw, volatilitym, recom, avgvolume, relvolume, price, change, volume | + +--- diff --git a/website/content/terminal/reference/stocks/screener/set.md b/website/content/terminal/reference/stocks/screener/set.md new file mode 100644 index 000000000000..2c169844dc1c --- /dev/null +++ b/website/content/terminal/reference/stocks/screener/set.md @@ -0,0 +1,102 @@ +--- +title: set +description: Page provides instructions and usage methods on how to set presets from + custom and default ones in Python. It includes a wide array of parameters for filtering + presets. +keywords: +- set +- preset +- parameters +- filter presets +- oversold_under_5dol +- potential_reversals +- top_performers_all +- death_cross +- unusual_volume +- news_scanner +- cheap_bottom_dividend +- cheap_dividend +- top_performers_healthcare +- bull_runs_over_10pct +- value_stocks +- golden_cross +- growth_stocks +- channel_up_and_low_debt_and_sma_50and200 +- buffett_like +- continued_momentum_scan +- analyst_strong_buy +- under_15dol_stocks +- 5pct_above_low +- cheap_oversold +- weak_support_and_top_performers +- undervalue +- oversold_under_3dol +- top_performers_tech +- rosenwald_gtfo +- recent_growth_and_support +- heavy_inst_ins +- modified_neff +- simplistic_momentum_scanner_under_7dol +- golden_cross_penny +- break_out_stocks +- high_vol_and_low_debt +- stocks_strong_support_levels +- sexy_year +- short_squeeze_scan +- oversold +- rosenwald +- modified_dreman +- top_gainers +- top_losers +- new_high +- new_low +- most_volatile +- most_active +- overbought +- downgrades +- upgrades +- earnings_before +- earnings_after +- recent_insider_buying +- recent_insider_selling +- major_news +- horizontal_sr +- tl_resistance +- tl_support +- wedge_up +- wedge_down +- wedge +- triangle_ascending +- triangle_descending +- channel_up +- channel_down +- channel +- double_top +- double_bottom +- multiple_top +- multiple_bottom +- head_shoulders +- head_shoulders_inverse +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Set preset from custom and default ones. + +### Usage + +```python +set [-p Desired preset.] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| preset | Filter presets | template | True | template, oversold_under_5dol, potential_reversals, top_performers_all, death_cross, unusual_volume, news_scanner, cheap_bottom_dividend, cheap_dividend, top_performers_healthcare, bull_runs_over_10pct, value_stocks, golden_cross, growth_stocks, channel_up_and_low_debt_and_sma_50and200, buffett_like, continued_momentum_scan, analyst_strong_buy, under_15dol_stocks, 5pct_above_low, cheap_oversold, weak_support_and_top_performers, undervalue, oversold_under_3dol, top_performers_tech, rosenwald_gtfo, recent_growth_and_support, heavy_inst_ins, modified_neff, simplistic_momentum_scanner_under_7dol, golden_cross_penny, break_out_stocks, high_vol_and_low_debt, stocks_strong_support_levels, sexy_year, short_squeeze_scan, oversold, rosenwald, modified_dreman, top_gainers, top_losers, new_high, new_low, most_volatile, most_active, overbought, downgrades, upgrades, earnings_before, earnings_after, recent_insider_buying, recent_insider_selling, major_news, horizontal_sr, tl_resistance, tl_support, wedge_up, wedge_down, wedge, triangle_ascending, triangle_descending, channel_up, channel_down, channel, double_top, double_bottom, multiple_top, multiple_bottom, head_shoulders, head_shoulders_inverse | + +--- diff --git a/website/content/terminal/reference/stocks/screener/technical.md b/website/content/terminal/reference/stocks/screener/technical.md new file mode 100644 index 000000000000..6d01c67e41e8 --- /dev/null +++ b/website/content/terminal/reference/stocks/screener/technical.md @@ -0,0 +1,40 @@ +--- +title: technical +description: This page provides a comprehensive guide to the 'technical' functionality + of our platform. It explains how to use presets to filter and print technical data + of companies, and describes the functions of different parameters. +keywords: +- technical data +- stock filtering +- stock analytics +- financial tools +- preset filters +- stock parameters +- data sorting +- financial data analysis +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Prints technical data of the companies that meet the pre-set filtering. + +### Usage + +```python +technical [-p Desired preset.] [-l LIMIT] [-r] [-s {ticker,beta,atr,sma20,sma50,sma200,52whigh,52wlow,rsi,price,change,fromopen,gap,volume}] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| preset | Filter presets | top_gainers | True | template, oversold_under_5dol, potential_reversals, top_performers_all, death_cross, unusual_volume, news_scanner, cheap_bottom_dividend, cheap_dividend, top_performers_healthcare, bull_runs_over_10pct, value_stocks, golden_cross, growth_stocks, channel_up_and_low_debt_and_sma_50and200, buffett_like, continued_momentum_scan, analyst_strong_buy, under_15dol_stocks, 5pct_above_low, cheap_oversold, weak_support_and_top_performers, undervalue, oversold_under_3dol, top_performers_tech, rosenwald_gtfo, recent_growth_and_support, heavy_inst_ins, modified_neff, simplistic_momentum_scanner_under_7dol, golden_cross_penny, break_out_stocks, high_vol_and_low_debt, stocks_strong_support_levels, sexy_year, short_squeeze_scan, oversold, rosenwald, modified_dreman, top_gainers, top_losers, new_high, new_low, most_volatile, most_active, overbought, downgrades, upgrades, earnings_before, earnings_after, recent_insider_buying, recent_insider_selling, major_news, horizontal_sr, tl_resistance, tl_support, wedge_up, wedge_down, wedge, triangle_ascending, triangle_descending, channel_up, channel_down, channel, double_top, double_bottom, multiple_top, multiple_bottom, head_shoulders, head_shoulders_inverse | +| limit | Limit of stocks to print | 10 | True | None | +| reverse | Data is sorted in descending order by default. Reverse flag will sort it in an ascending way. Only works when raw data is displayed. | False | True | None | +| sort | Sort elements of the table. | Ticker | True | ticker, beta, atr, sma20, sma50, sma200, 52whigh, 52wlow, rsi, price, change, fromopen, gap, volume | + +--- diff --git a/website/content/terminal/reference/stocks/screener/valuation.md b/website/content/terminal/reference/stocks/screener/valuation.md new file mode 100644 index 000000000000..650c46975b39 --- /dev/null +++ b/website/content/terminal/reference/stocks/screener/valuation.md @@ -0,0 +1,43 @@ +--- +title: valuation +description: Marketing website page providing a tool to print valuation data of various + stocks based on a set of pre-defined filters, further offering various parametric + controls to refine and customize the output. +keywords: +- valuation tool +- stock market +- market filters +- financial data +- stock parameters +- data sort +- parameter limit +- preset filters +- Python commands +- investment tool +- stock analysis +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Prints valuation data of the companies that meet the pre-set filtering. + +### Usage + +```python +valuation [-p Desired preset.] [-l LIMIT] [-r] [-s SORT] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| preset | Filter presets | top_gainers | True | template, oversold_under_5dol, potential_reversals, top_performers_all, death_cross, unusual_volume, news_scanner, cheap_bottom_dividend, cheap_dividend, top_performers_healthcare, bull_runs_over_10pct, value_stocks, golden_cross, growth_stocks, channel_up_and_low_debt_and_sma_50and200, buffett_like, continued_momentum_scan, analyst_strong_buy, under_15dol_stocks, 5pct_above_low, cheap_oversold, weak_support_and_top_performers, undervalue, oversold_under_3dol, top_performers_tech, rosenwald_gtfo, recent_growth_and_support, heavy_inst_ins, modified_neff, simplistic_momentum_scanner_under_7dol, golden_cross_penny, break_out_stocks, high_vol_and_low_debt, stocks_strong_support_levels, sexy_year, short_squeeze_scan, oversold, rosenwald, modified_dreman, top_gainers, top_losers, new_high, new_low, most_volatile, most_active, overbought, downgrades, upgrades, earnings_before, earnings_after, recent_insider_buying, recent_insider_selling, major_news, horizontal_sr, tl_resistance, tl_support, wedge_up, wedge_down, wedge, triangle_ascending, triangle_descending, channel_up, channel_down, channel, double_top, double_bottom, multiple_top, multiple_bottom, head_shoulders, head_shoulders_inverse | +| limit | Limit of stocks to print | 10 | True | None | +| reverse | Data is sorted in descending order by default. Reverse flag will sort it in an ascending way. Only works when raw data is displayed. | False | True | None | +| sort | Sort elements of the table. | Ticker | True | ticker, marketcap, p/e, fwdp/e, peg, p/s, p/b, p/c, p/fcf, epsthisy, epsnexty, epspast5y, epsnext5y, salespast5y, price, change, volume | + +--- diff --git a/website/content/terminal/reference/stocks/screener/view.md b/website/content/terminal/reference/stocks/screener/view.md new file mode 100644 index 000000000000..8350986f7347 --- /dev/null +++ b/website/content/terminal/reference/stocks/screener/view.md @@ -0,0 +1,36 @@ +--- +title: view +description: The page provides information on the 'view' function which allows one + to view available presets under the presets folder. It includes the usage in Python + and parameters that can be set, aiding in stock analysis. +keywords: +- view +- presets +- parameters +- preset options +- usage +- custom preset +- stock analysis +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +View available presets under presets folder. + +### Usage + +```python +view [-p Desired preset.] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| preset | View specific custom preset | | True | template, oversold_under_5dol, potential_reversals, top_performers_all, death_cross, unusual_volume, news_scanner, cheap_bottom_dividend, cheap_dividend, top_performers_healthcare, bull_runs_over_10pct, value_stocks, golden_cross, growth_stocks, channel_up_and_low_debt_and_sma_50and200, buffett_like, continued_momentum_scan, analyst_strong_buy, under_15dol_stocks, 5pct_above_low, cheap_oversold, weak_support_and_top_performers, undervalue, oversold_under_3dol, top_performers_tech, rosenwald_gtfo, recent_growth_and_support, heavy_inst_ins, modified_neff, simplistic_momentum_scanner_under_7dol, golden_cross_penny, break_out_stocks, high_vol_and_low_debt, stocks_strong_support_levels, sexy_year, short_squeeze_scan, oversold, rosenwald, modified_dreman, top_gainers, top_losers, new_high, new_low, most_volatile, most_active, overbought, downgrades, upgrades, earnings_before, earnings_after, recent_insider_buying, recent_insider_selling, major_news, horizontal_sr, tl_resistance, tl_support, wedge_up, wedge_down, wedge, triangle_ascending, triangle_descending, channel_up, channel_down, channel, double_top, double_bottom, multiple_top, multiple_bottom, head_shoulders, head_shoulders_inverse | + +--- diff --git a/website/content/terminal/reference/stocks/search.md b/website/content/terminal/reference/stocks/search.md new file mode 100644 index 000000000000..5df954c55453 --- /dev/null +++ b/website/content/terminal/reference/stocks/search.md @@ -0,0 +1,41 @@ +--- +title: search +description: The 'search' documentation provides a detailed guide to using various + search commands on our platform. This includes usage, parameters, and term definitions + for finding company tickers, filtering stocks based on country, sector, industry + or specific exchange country. +keywords: +- Search Documentation +- Company Tickers +- Stock Market Search +- Search By Country +- Search By Sector +- Search By Industry +- Search By Exchange Country +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Show companies matching the search query + +### Usage + +```python +search [-q QUERY [QUERY ...]] [-c country] [-s sector] [-i industry] [-e exchange] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| query | The search term used to find company tickers | | True | None | +| country | Search by country to find stocks matching the criteria | | True | afghanistan, anguilla, argentina, australia, austria, azerbaijan, bahamas, bangladesh, barbados, belgium, belize, bermuda, botswana, brazil, british_virgin_islands, cambodia, canada, cayman_islands, chile, china, colombia, costa_rica, cyprus, czech_republic, denmark, dominican_republic, egypt, estonia, falkland_islands, finland, france, french_guiana, gabon, georgia, germany, ghana, gibraltar, greece, greenland, guernsey, hong_kong, hungary, iceland, india, indonesia, ireland, isle_of_man, israel, italy, ivory_coast, japan, jersey, jordan, kazakhstan, kyrgyzstan, latvia, liechtenstein, lithuania, luxembourg, macau, macedonia, malaysia, malta, mauritius, mexico, monaco, mongolia, montenegro, morocco, mozambique, myanmar, namibia, netherlands, netherlands_antilles, new_zealand, nigeria, norway, panama, papua_new_guinea, peru, philippines, poland, portugal, qatar, reunion, romania, russia, saudi_arabia, senegal, singapore, slovakia, slovenia, south_africa, south_korea, spain, suriname, sweden, switzerland, taiwan, tanzania, thailand, turkey, ukraine, united_arab_emirates, united_kingdom, united_states, uruguay, vietnam, zambia | +| sector | Search by sector to find stocks matching the criteria | | True | , basic_materials, communication_services, conglomerates, consumer_cyclical, consumer_defensive, consumer_goods, energy, financial, financial_services, healthcare, industrial_goods, industrials, real_estate, services, technology, utilities | +| industry | Search by industry to find stocks matching the criteria | | True | , advertising_agencies, aerospace_&_defense, aerospace_defense_-_major_diversified, aerospace_defense_products_&_services, agricultural_chemicals, agricultural_inputs, air_delivery_&_freight_services, airlines, airports_&_air_services, aluminum, apparel_manufacturing, apparel_retail, apparel_stores, asset_management, auto_&_truck_dealerships, auto_dealerships, auto_manufacturers, auto_manufacturers_-_major, auto_parts, banks_-_diversified, banks_-_regional, beverages_-_brewers, beverages_-_non-alcoholic, beverages_-_soft_drinks, beverages_-_wineries_&_distilleries, beverages_-_wineries_&_distillers, biotechnology, broadcasting, broadcasting_-_tv, building_materials, building_products_&_equipment, business_equipment, business_equipment_&_supplies, business_services, business_software_&_services, capital_markets, chemicals, chemicals_-_major_diversified, cigarettes, closed-end_fund_-_equity, coking_coal, communication_equipment, computer_based_systems, computer_hardware, confectioners, conglomerates, consulting_services, consumer_electronics, copper, credit_services, department_stores, diagnostics_&_research, discount_stores, discount,_variety_stores, diversified_computer_systems, diversified_electronics, diversified_investments, diversified_machinery, diversified_utilities, drug_manufacturers_-_general, drug_manufacturers_-_major, drug_manufacturers_-_other, drug_manufacturers_-_specialty_&_generic, drugs_-_generic, education_&_training_services, electric_utilities, electrical_equipment_&_parts, electronic_components, electronic_equipment, electronic_gaming_&_multimedia, electronics_&_computer_distribution, electronics_wholesale, engineering_&_construction, entertainment, entertainment_-_diversified, farm_&_construction_machinery, farm_&_heavy_construction_machinery, farm_products, financial_conglomerates, financial_data_&_stock_exchanges, food_-_major_diversified, food_distribution, food_wholesale, footwear_&_accessories, furnishings,_fixtures_&_appliances, gambling, gaming_activities, general_building_materials, general_contractors, gold, grocery_stores, health_care_plans, health_information_services, healthcare_information_services, healthcare_plans, heavy_construction, home_furnishings_&_fixtures, home_improvement_retail, hospitals, household_&_personal_products, independent_oil_&_gas, industrial_distribution, industrial_equipment_wholesale, industrial_metals_&_minerals, information_technology_services, infrastructure_operations, insurance_-_diversified, insurance_-_life, insurance_-_property_&_casualty, insurance_-_reinsurance, insurance_-_specialty, insurance_brokers, integrated_freight_&_logistics, internet_content_&_information, internet_information_providers, internet_retail, internet_service_providers, internet_software_&_services, investment_brokerage_-_national, jewelry_stores, leisure, life_insurance, lodging, long_distance_carriers, lumber_&_wood_production, lumber,_wood_production, luxury_goods, machine_tools_&_accessories, major_airlines, major_integrated_oil_&_gas, marine_shipping, marketing_services, medical_appliances_&_equipment, medical_care_facilities, medical_devices, medical_distribution, medical_instruments_&_supplies, medical_laboratories_&_research, metal_fabrication, money_center_banks, mortgage_finance, mortgage_investment, multimedia_&_graphics_software, networking_&_communication_devices, nonmetallic_mineral_mining, oil_&_gas_drilling, oil_&_gas_drilling_&_exploration, oil_&_gas_e&p, oil_&_gas_equipment_&_services, oil_&_gas_integrated, oil_&_gas_midstream, oil_&_gas_pipelines, oil_&_gas_refining_&_marketing, other_industrial_metals_&_mining, other_precious_metals_&_mining, packaged_foods, packaging_&_containers, paper_&_paper_products, personal_products, personal_services, pharmaceutical_retailers, pollution_&_treatment_controls, printed_circuit_boards, processed_&_packaged_goods, property_&_casualty_insurance, property_management, publishing, publishing_-_newspapers, reit_-_diversified, reit_-_healthcare_facilities, reit_-_hotel_&_motel, reit_-_industrial, reit_-_mortgage, reit_-_office, reit_-_residential, reit_-_retail, reit_-_specialty, railroads, real_estate_-_development, real_estate_-_diversified, real_estate_development, real_estate_services, recreational_goods,_other, recreational_vehicles, regional_-_mid-atlantic_banks, rental_&_leasing_services, research_services, residential_construction, resorts_&_casinos, restaurants, rubber_&_plastics, scientific_&_technical_instruments, security_&_protection_services, security_software_&_services, semiconductor_-_broad_line, semiconductor_equipment_&_materials, semiconductor-_memory_chips, semiconductors, shell_companies, shipping, silver, software_-_application, software_-_infrastructure, solar, specialized_health_services, specialty_business_services, specialty_chemicals, specialty_industrial_machinery, specialty_retail, specialty_retail,_other, staffing_&_employment_services, staffing_&_outsourcing_services, steel, steel_&_iron, technical_&_system_software, telecom_services, textile_-_apparel_clothing, textile_-_apparel_footwear_&_accessories, textile_industrial, textile_manufacturing, thermal_coal, tobacco, tobacco_products,_other, tools_&_accessories, travel_services, trucking, trucks_&_other_vehicles, uranium, utilities_-_diversified, utilities_-_independent_power_producers, utilities_-_regulated_electric, utilities_-_regulated_gas, utilities_-_regulated_water, utilities_-_renewable, waste_management, water_utilities, wireless_communications | +| exchange_country | Search by a specific exchange country to find stocks matching the criteria | | True | united_states, argentina, austria, australia, belgium, brazil, canada, chile, china, czech_republic, denmark, egypt, estonia, europe, finland, france, germany, greece, hong_kong, hungary, iceland, india, indonesia, ireland, israel, italy, japan, latvia, lithuania, malaysia, mexico, netherlands, new_zealand, norway, portugal, qatar, russia, singapore, south_africa, south_korea, spain, saudi_arabia, sweden, switzerland, taiwan, thailand, turkey, united_kingdom, venezuela | + +--- diff --git a/website/versioned_docs/version-v3/terminal/reference/stocks/sia/_category_.json b/website/content/terminal/reference/stocks/sia/_category_.json similarity index 100% rename from website/versioned_docs/version-v3/terminal/reference/stocks/sia/_category_.json rename to website/content/terminal/reference/stocks/sia/_category_.json diff --git a/website/content/terminal/reference/stocks/sia/country.md b/website/content/terminal/reference/stocks/sia/country.md new file mode 100644 index 000000000000..6c29db7c6cd3 --- /dev/null +++ b/website/content/terminal/reference/stocks/sia/country.md @@ -0,0 +1,35 @@ +--- +title: country +description: This page provides documentation about using the 'country' command. Explore + country details or set a specific country using the proper command syntax. +keywords: +- country command +- Python country command +- command usage +- command parameters +- country selection +- country details +- optional parameters +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +See existing countries, or set country if arg specified + +### Usage + +```python +country [-n NAME [NAME ...]] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| name | country to select | None | True | None | + +--- diff --git a/website/content/terminal/reference/stocks/sia/cpci.md b/website/content/terminal/reference/stocks/sia/cpci.md new file mode 100644 index 000000000000..3e29cc1adf29 --- /dev/null +++ b/website/content/terminal/reference/stocks/sia/cpci.md @@ -0,0 +1,44 @@ +--- +title: cpci +description: This page provides information on the usage and parameters of 'cpci', + a tool for analyzing Companies per Country based on Industry and Market Cap. It + helps users understand how to input parameters and what effect each one has on the + output. +keywords: +- cpci +- companies per country +- industry +- market cap +- parameters +- usage +- data analysis +- raw data +- maximum number of countries to display +- minimum percentage to display country +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Companies per Country based on Industry and Market Cap + +### Usage + +```python +cpci [-M MAX_COUNTRIES_TO_DISPLAY] [-m MIN_PCT_TO_DISPLAY_COUNTRY] [-r] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| max_countries_to_display | Maximum number of countries to display | 15 | True | None | +| min_pct_to_display_country | Minimum percentage to display country | 0.015 | True | None | +| raw | Output all raw data | False | True | None | + +![CPCI](https://user-images.githubusercontent.com/46355364/153896041-d66b4002-554d-47af-91d8-9a79824a6ccd.png) + +--- diff --git a/website/content/terminal/reference/stocks/sia/cpcs.md b/website/content/terminal/reference/stocks/sia/cpcs.md new file mode 100644 index 000000000000..d6c207cadb57 --- /dev/null +++ b/website/content/terminal/reference/stocks/sia/cpcs.md @@ -0,0 +1,40 @@ +--- +title: cpcs +description: CPCS is a powerful tool that allows users to view company distribution + based on various parameters like sector, market cap and more. It offers customizable + options to control the data display. +keywords: +- CPCS +- Company distribution by Country, Sector and Market Cap +- Country distribution data +- Sector distribution data +- Market cap data +- Data visualization +- Data customization +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Companies per Country based on Sector and Market Cap + +### Usage + +```python +cpcs [-M MAX_COUNTRIES_TO_DISPLAY] [-m MIN_PCT_TO_DISPLAY_COUNTRY] [-r] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| max_countries_to_display | Maximum number of countries to display | 15 | True | None | +| min_pct_to_display_country | Minimum percentage to display country | 0.015 | True | None | +| raw | Output all raw data | False | True | None | + +![CPCS](https://user-images.githubusercontent.com/46355364/153896494-5c0c9c00-aa2a-45cb-8a93-cfaa908b35df.png) + +--- diff --git a/website/content/terminal/reference/stocks/sia/cpic.md b/website/content/terminal/reference/stocks/sia/cpic.md new file mode 100644 index 000000000000..f21730945b23 --- /dev/null +++ b/website/content/terminal/reference/stocks/sia/cpic.md @@ -0,0 +1,43 @@ +--- +title: cpic +description: This is a documentation page for CPIC, a tool that displays companies + per industry based on country and market cap. It allows users to adjust parameters + such as the maximum number of industries to display and the minimum percentage to + display an industry. +keywords: +- CPIC +- companies per industry +- country +- market cap +- maximum industries to display +- minimum percentage to display industry +- raw data +- business tool +- data visualization +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Companies per Industry based on Country and Market Cap + +### Usage + +```python +cpic [-M MAX_INDUSTRIES_TO_DISPLAY] [-m MIN_PCT_TO_DISPLAY_INDUSTRY] [-r] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| max_industries_to_display | Maximum number of industries to display | 15 | True | None | +| min_pct_to_display_industry | Minimum percentage to display industry | 0.015 | True | None | +| raw | Output all raw data | False | True | None | + +![CPIC](https://user-images.githubusercontent.com/46355364/153896804-87ae9eb1-b252-4c8f-a089-b653920372fc.png) + +--- diff --git a/website/content/terminal/reference/stocks/sia/cpis.md b/website/content/terminal/reference/stocks/sia/cpis.md new file mode 100644 index 000000000000..f46b1c45befb --- /dev/null +++ b/website/content/terminal/reference/stocks/sia/cpis.md @@ -0,0 +1,34 @@ +--- +title: cpis +description: This documentation pages describes the cpis command which allows users to visualize companies per industry based on sector and market cap +keywords: +- sector +- industry +- market cap +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Companies per Industry based on Sector and Market Cap + +### Usage + +```python +cpis [-M MAX_INDUSTRIES_TO_DISPLAY] [-m MIN_PCT_TO_DISPLAY_INDUSTRY] [-r] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| max_industries_to_display | Maximum number of industries to display | 15 | True | None | +| min_pct_to_display_industry | Minimum percentage to display industry | 0.015 | True | None | +| raw | Output all raw data | False | True | None | + +![CPIS](https://user-images.githubusercontent.com/46355364/153896896-9e102f13-28ee-4abf-9277-a7c2ecfd08ab.png) + +--- diff --git a/website/content/terminal/reference/stocks/sia/cps.md b/website/content/terminal/reference/stocks/sia/cps.md new file mode 100644 index 000000000000..0cc455507af0 --- /dev/null +++ b/website/content/terminal/reference/stocks/sia/cps.md @@ -0,0 +1,41 @@ +--- +title: cps +description: A comprehensive guide on how to use the CPS tool for displaying Companies + per Sectors based on Country and Market Cap. It provides detailed explanation about + the command-line parameters, their options and usage. +keywords: +- CPS tool +- Companies per Sectors +- Country and Market Cap +- command-line parameters +- max sectors to display +- min percentage to display sector +- output all raw data +- data visualization +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Companies per Sectors based on Country and Market Cap + +### Usage + +```python +cps [-M MAX_SECTORS_TO_DISPLAY] [-m MIN_PCT_TO_DISPLAY_SECTOR] [-r] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| max_sectors_to_display | Maximum number of sectors to display | 15 | True | None | +| min_pct_to_display_sector | Minimum percentage to display sector | 0.015 | True | None | +| raw | Output all raw data | False | True | None | + +![CPS](https://user-images.githubusercontent.com/46355364/153896194-512699a7-ce52-4cbd-869e-89397bc96dc4.png) + +--- diff --git a/website/content/terminal/reference/stocks/sia/exchange.md b/website/content/terminal/reference/stocks/sia/exchange.md new file mode 100644 index 000000000000..292e90ca0686 --- /dev/null +++ b/website/content/terminal/reference/stocks/sia/exchange.md @@ -0,0 +1,32 @@ +--- +title: exchange +description: This page provides comprehensive information and usage of the 'exchange' + command for swapping the international exchanges flag. Specifically, it outlines + the parameters for this operation. +keywords: +- exchange +- swap +- international exchanges +- parameters +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Swap exclude international exchanges flag + +### Usage + +```python +exchange +``` + +--- + +## Parameters + +This command has no parameters + + +--- diff --git a/website/content/terminal/reference/stocks/sia/industry.md b/website/content/terminal/reference/stocks/sia/industry.md new file mode 100644 index 000000000000..03270725694c --- /dev/null +++ b/website/content/terminal/reference/stocks/sia/industry.md @@ -0,0 +1,34 @@ +--- +title: industry +description: This page provides information on how to view existing industries or + setting an industry using parameters. It includes usage, choices, and optional settings + for the 'industry' function. +keywords: +- industry +- industry selection +- set industry +- industry parameters +- industry usage +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +See existing industries, or set industry if arg specified + +### Usage + +```python +industry [-n NAME [NAME ...]] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| name | industry to select | None | True | None | + +--- diff --git a/website/content/terminal/reference/stocks/sia/metric.md b/website/content/terminal/reference/stocks/sia/metric.md new file mode 100644 index 000000000000..8b48e816eb7a --- /dev/null +++ b/website/content/terminal/reference/stocks/sia/metric.md @@ -0,0 +1,70 @@ +--- +title: metric +description: An informational page detailing the usage and parameters of the 'metric' + function. This function allows you to visualize various business and economic metrics + such as return on assets (roa), return on equity (roe), current ratio (cr), and + more. Understanding these metrics can aid in making informed financial and business + decisions. +keywords: +- metric visualization +- roa +- roe +- cr +- qr +- de +- tc +- tcs +- tr +- rps +- rg +- eg +- pm +- gp +- gm +- ocf +- om +- fcf +- td +- ebitda +- ebitdam +- rec +- mc +- fte +- er +- bv +- ss +- pb +- beta +- fs +- peg +- ev +- fpe +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Visualize a particular metric with the filters selected Available Metrics: roa return on assets roe return on equity cr current ratio qr quick ratio de debt to equity tc total cash tcs total cash per share tr total revenue rps revenue per share rg revenue growth eg earnings growth pm profit margins gp gross profits gm gross margins ocf operating cash flow om operating margins fcf free cash flow td total debt ebitda earnings before interest, taxes, depreciation and amortization ebitdam ebitda margins rec recommendation mean mc market cap fte full time employees er enterprise to revenue bv book value ss shares short pb price to book beta beta fs float shares sr short ratio peg peg ratio ev enterprise value fpe forward P/E, + +### Usage + +```python +metric -m {roa,roe,cr,qr,de,tc,tcs,tr,rps,rg,eg,pm,gp,gm,ocf,om,fcf,td,ebitda,ebitdam,rec,mc,fte,er,bv,ss,pb,beta,fs,peg,ev,fpe} [-l LIMIT] [-r] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| metric | Metric to visualize | None | False | roa, roe, cr, qr, de, tc, tcs, tr, rps, rg, eg, pm, gp, gm, ocf, om, fcf, td, ebitda, ebitdam, rec, mc, fte, er, bv, ss, pb, beta, fs, peg, ev, fpe | +| limit | Limit number of companies to display | 10 | True | None | +| raw | Output all raw data | False | True | None | + +![metric roe](https://user-images.githubusercontent.com/46355364/159276031-ad84d153-9cb3-440e-9771-090aa6c467c4.png) + +![metric fte](https://user-images.githubusercontent.com/46355364/159276335-d0ecb16f-eac2-421f-b69e-3bbffe126bd1.png) + +--- diff --git a/website/content/terminal/reference/stocks/sia/mktcap.md b/website/content/terminal/reference/stocks/sia/mktcap.md new file mode 100644 index 000000000000..0fce163b6c88 --- /dev/null +++ b/website/content/terminal/reference/stocks/sia/mktcap.md @@ -0,0 +1,42 @@ +--- +title: mktcap +description: This is an documentation page for 'mktcap', a tool that sets market cap + size to anything from Nano to Mega. Find usage instructions, parameters, and more. +keywords: +- mktcap +- market cap +- Nano +- Micro +- Small +- Mid +- Large +- Mega +- nano +- micro +- small +- mid +- large +- mega +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Set mktcap to nano, micro, small, mid, large or mega + +### Usage + +```python +mktcap [-n {Nano,Micro,Small,Mid,Large,Mega,nano,micro,small,mid,large,mega}] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| name | market cap to select | None | True | Nano, Micro, Small, Mid, Large, Mega, nano, micro, small, mid, large, mega | + +--- diff --git a/website/content/terminal/reference/stocks/sia/period.md b/website/content/terminal/reference/stocks/sia/period.md new file mode 100644 index 000000000000..6234dc70cf0e --- /dev/null +++ b/website/content/terminal/reference/stocks/sia/period.md @@ -0,0 +1,35 @@ +--- +title: period +description: This page provides details on how to set the period parameter to define + the time frame as annual, quarterly, or trailing. Essential for marketing and SEO + strategies requiring data analysis within specific periods. +keywords: +- period +- annual +- quarterly +- trailing +- parameters +- marketing +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Set period between annual, quarterly and trailing + +### Usage + +```python +period [-n {Annual,Quarterly,Trailing,annual,quarterly,trailing}] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| name | period to select | None | True | Annual, Quarterly, Trailing, annual, quarterly, trailing | + +--- diff --git a/website/content/terminal/reference/stocks/sia/sector.md b/website/content/terminal/reference/stocks/sia/sector.md new file mode 100644 index 000000000000..b25d50fa531f --- /dev/null +++ b/website/content/terminal/reference/stocks/sia/sector.md @@ -0,0 +1,34 @@ +--- +title: sector +description: A documentation page outlining how-to instructions for setting sectors + in Python. It includes usage, parameters, and choices. +keywords: +- Python instructions +- Setting sectors +- Command-line arguments +- Command Usage +- Parameters +- Programming documentation +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +See existing sectors, or set sector if arg specified + +### Usage + +```python +sector [-n NAME [NAME ...]] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| name | sector to select | None | True | None | + +--- diff --git a/website/content/terminal/reference/stocks/sia/select.md b/website/content/terminal/reference/stocks/sia/select.md new file mode 100644 index 000000000000..0a29a2de800c --- /dev/null +++ b/website/content/terminal/reference/stocks/sia/select.md @@ -0,0 +1,35 @@ +--- +title: select +description: The page provides detailed information on how to select a stock ticker + and customize industry, sector, country and market cap aligned with it. This includes + the usage guide and parameters to ensure smooth operations. +keywords: +- Select Stock Ticker +- Ticker Parameters +- Industry Selection +- Sector Selection +- Country Selection +- Market Cap Selection +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Select stock ticker and alter the industry, sector, country and market cap accordingly for this ticker. + +### Usage + +```python +select -t TICKER +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| ticker | Stock ticker | None | False | None | + +--- diff --git a/website/versioned_docs/version-v3/terminal/reference/stocks/sia/vis.md b/website/content/terminal/reference/stocks/sia/vis.md similarity index 79% rename from website/versioned_docs/version-v3/terminal/reference/stocks/sia/vis.md rename to website/content/terminal/reference/stocks/sia/vis.md index 315e23d2d553..4150c7702d73 100644 --- a/website/versioned_docs/version-v3/terminal/reference/stocks/sia/vis.md +++ b/website/content/terminal/reference/stocks/sia/vis.md @@ -1,9 +1,23 @@ --- title: vis -description: OpenBB Terminal Function +description: Use our platform to visualize important financial metrics like Balance + Sheet, Income, and Cash Flow Statements. Our tool provides an efficient metric visualization + facility and supports currency conversion for easy-use. Ideal for financial reporting + and analysis. +keywords: +- metrics +- visualization +- balance sheet statement metrics +- income statement metrics +- cash flow statement metrics +- financial reporting +- accounting software +- currency conversion --- -# vis +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + Visualize a particular metric with the filters selected Balance Sheet Statement ce Cash & Equivalents sti Short-Term Investments cce Cash & Cash Equivalents rec Receivables inv Inventory oca Other Current Assets tca Total Current Assets ppe Property, Plant & Equipment lti Long-Term Investments gai Goodwill and Intangibles olta Other Long-Term Assets tlta Total Long-Term Assets ta Total Assets ap Accounts Payable dr Deferred Revenue cd Current Debt ocl Other Current Liabilities tcl Total Current Liabilities ltd Long-Term Debt oltl Other Long-Term Liabilities tltl Total Long-Term Liabilities tl Total Liabilities ret Retained Earnings ci Comprehensive Income se Shareholders' Equity tle Total Liabilities and Equity Income Statement re Revenue cr Cost of Revenue gp Gross Profit sga Selling, Genera & Admin rd Research & Development ooe Other Operating Expenses oi Operating Income ie Interest Expense / Income oe Other Expense / Income it Income Tax ni Net Income pd Preferred Dividends Cash Flow Statement ninc Net Income da Depreciation & Amortization sbc Share-Based Compensation ooa Other Operating Activities ocf Operating Cash Flow cex Capital Expenditures acq Acquisitions cii Change in Investments oia Other Investing Activities icf Investing Cash Flow dp Dividends Paid si Share Insurance / Repurchase di Debt Issued / Paid ofa Other Financing Activities fcf Financing Cash Flow ncf Net Cash Flow diff --git a/website/versioned_docs/version-v3/terminal/reference/stocks/ta/_category_.json b/website/content/terminal/reference/stocks/ta/_category_.json similarity index 100% rename from website/versioned_docs/version-v3/terminal/reference/stocks/ta/_category_.json rename to website/content/terminal/reference/stocks/ta/_category_.json diff --git a/website/content/terminal/reference/stocks/ta/ad.md b/website/content/terminal/reference/stocks/ta/ad.md new file mode 100644 index 000000000000..483b2a8448dc --- /dev/null +++ b/website/content/terminal/reference/stocks/ta/ad.md @@ -0,0 +1,40 @@ +--- +title: ad +description: An in-depth explanation of Accumulation/Distribution Line (AD), its interpretation, + and usage. The page also provides a Python script for the indicator and describes + its parameters. +keywords: +- Accumulation/Distribution Line (AD) +- AD Indicator +- Close Location Value +- CLV +- Stock Market Indicator +- Python Script +- b_use_open +- On Balance Volume (OBV) +- Volume Times +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +The Accumulation/Distribution Line is similar to the On Balance Volume (OBV), which sums the volume times +1/-1 based on whether the close is higher than the previous close. The Accumulation/Distribution indicator, however multiplies the volume by the close location value (CLV). The CLV is based on the movement of the issue within a single bar and can be +1, -1 or zero. The Accumulation/Distribution Line is interpreted by looking for a divergence in the direction of the indicator relative to price. If the Accumulation/Distribution Line is trending upward it indicates that the price may follow. Also, if the Accumulation/Distribution Line becomes flat while the price is still rising (or falling) then it signals an impending flattening of the price. + +### Usage + +```python +ad [--open] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| b_use_open | uses open value of stock | False | True | None | + +![ad](https://user-images.githubusercontent.com/46355364/154309283-9512c6c0-dda3-4348-9350-105238676479.png) + +--- diff --git a/website/content/terminal/reference/stocks/ta/adosc.md b/website/content/terminal/reference/stocks/ta/adosc.md new file mode 100644 index 000000000000..03d342cefe00 --- /dev/null +++ b/website/content/terminal/reference/stocks/ta/adosc.md @@ -0,0 +1,43 @@ +--- +title: adosc +description: The Accumulation/Distribution Oscillator, also known as adosc or the + Chaikin Oscillator, is a momentum indicator that considers both the strength of + price moves and the underlying buying and selling pressure during a certain period. + Readings above zero signify net buying pressure, while those below zero signal net + selling pressure. Divergences between the indicator and explicit price movements + are the most prevalent signals, often denoting market turning points. +keywords: +- adosc +- Accumulation/Distribution Oscillator +- Chaikin Oscillator +- momentum indicator +- buying and selling pressure +- market turning points +- price moves +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Accumulation/Distribution Oscillator, also known as the Chaikin Oscillator is essentially a momentum indicator, but of the Accumulation-Distribution line rather than merely price. It looks at both the strength of price moves and the underlying buying and selling pressure during a given time period. The oscillator reading above zero indicates net buying pressure, while one below zero registers net selling pressure. Divergence between the indicator and pure price moves are the most common signals from the indicator, and often flag market turning points. + +### Usage + +```python +adosc [--open] [--fast N_LENGTH_FAST] [--slow N_LENGTH_SLOW] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| b_use_open | uses open value of stock | False | True | None | +| n_length_fast | fast length | 3 | True | None | +| n_length_slow | slow length | 10 | True | None | + +![adosc](https://user-images.githubusercontent.com/46355364/154309482-31c027ab-e80f-4145-9c63-392a74cf69c7.png) + +--- diff --git a/website/content/terminal/reference/stocks/ta/adx.md b/website/content/terminal/reference/stocks/ta/adx.md new file mode 100644 index 000000000000..7106d84b0e00 --- /dev/null +++ b/website/content/terminal/reference/stocks/ta/adx.md @@ -0,0 +1,42 @@ +--- +title: adx +description: Discover the purpose and usage of the ADX (Average Directional Index), + a Welles Wilder style moving average of the Directional Movement Index. Learn to + interpret the ADX values to determine the strength of a trend. +keywords: +- ADX +- Welles Wilder +- Average Directional Index +- Directional Movement Index +- ADX interpretation +- ADX parameters +- ADX usage +- Trend strength +- Trend analysis +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +The ADX is a Welles Wilder style moving average of the Directional Movement Index (DX). The values range from 0 to 100, but rarely get above 60. To interpret the ADX, consider a high number to be a strong trend, and a low number, a weak trend. + +### Usage + +```python +adx [-l N_LENGTH] [-s N_SCALAR] [-d N_DRIFT] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| n_length | length | 14 | True | None | +| n_scalar | scalar | 100 | True | None | +| n_drift | drift | 1 | True | None | + +![adx](https://user-images.githubusercontent.com/46355364/154309667-c67f6078-822f-452d-9853-ffffa9172670.png) + +--- diff --git a/website/content/terminal/reference/stocks/ta/aroon.md b/website/content/terminal/reference/stocks/ta/aroon.md new file mode 100644 index 000000000000..bd9dd7848588 --- /dev/null +++ b/website/content/terminal/reference/stocks/ta/aroon.md @@ -0,0 +1,44 @@ +--- +title: aroon +description: The page provides comprehensive details about the 'aroon' indicator, + a tool used in analytics to identify new trends. The explanation covers the significance + of the terms 'Aroon Up' and 'Aroon Down', as well as their impact on indicating + the occurrence and strength of upward and downward trends. +keywords: +- aroon +- dawn's early light +- trend indicator +- upward trend +- downward trend +- crossovers +- Aroon Up +- Aroon Down +- n_length +- n_scalar +- trend strength +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +The word aroon is Sanskrit for "dawn's early light." The Aroon indicator attempts to show when a new trend is dawning. The indicator consists of two lines (Up and Down) that measure how long it has been since the highest high/lowest low has occurred within an n period range. When the Aroon Up is staying between 70 and 100 then it indicates an upward trend. When the Aroon Down is staying between 70 and 100 then it indicates an downward trend. A strong upward trend is indicated when the Aroon Up is above 70 while the Aroon Down is below 30. Likewise, a strong downward trend is indicated when the Aroon Down is above 70 while the Aroon Up is below 30. Also look for crossovers. When the Aroon Down crosses above the Aroon Up, it indicates a weakening of the upward trend (and vice versa). + +### Usage + +```python +aroon [-l N_LENGTH] [-s N_SCALAR] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| n_length | length | 25 | True | None | +| n_scalar | scalar | 100 | True | None | + +![aroon](https://user-images.githubusercontent.com/46355364/154309825-f8ccc98b-31ac-43fc-a251-66f6f41545a5.png) + +--- diff --git a/website/content/terminal/reference/stocks/ta/atr.md b/website/content/terminal/reference/stocks/ta/atr.md new file mode 100644 index 000000000000..b76ef6331cf2 --- /dev/null +++ b/website/content/terminal/reference/stocks/ta/atr.md @@ -0,0 +1,43 @@ +--- +title: atr +description: Technical documentation of the 'atr' function or Average True Range used + for measuring volatility in financial markets, particularly those arising due to + gaps or limit moves. The page highlights how to use the function using Python, its + parameters, and different modes. +keywords: +- Averge True Range +- atr +- volatility measurement +- trading algorithms +- financial markets +- technical analysis +- ema +- sma +- wma +- hma +- zlma +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Averge True Range is used to measure volatility, especially volatility caused by gaps or limit moves. + +### Usage + +```python +atr [-l N_LENGTH] [-m {ema,sma,wma,hma,zlma}] [-o N_OFFSET] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| n_length | Window length | 14 | True | None | +| s_mamode | mamode | ema | True | ema, sma, wma, hma, zlma | +| n_offset | offset | 0 | True | None | + +--- diff --git a/website/content/terminal/reference/stocks/ta/bbands.md b/website/content/terminal/reference/stocks/ta/bbands.md new file mode 100644 index 000000000000..9d4e3f736ab4 --- /dev/null +++ b/website/content/terminal/reference/stocks/ta/bbands.md @@ -0,0 +1,43 @@ +--- +title: bbands +description: A comprehensive guide to understanding and using Bollinger Bands for + optimizing trading strategies. Learn about overbought and oversold conditions, price + targets, and the intuitive 'bbands' command for Python. +keywords: +- Bollinger Bands +- overbought conditions +- oversold conditions +- support level +- resistance level +- price target +- bbands command +- technical analysis +- trading strategy +- Bollinger Bands parameters +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Bollinger Bands consist of three lines. The middle band is a simple moving average (generally 20 periods) of the typical price (TP). The upper and lower bands are F standard deviations (generally 2) above and below the middle band. The bands widen and narrow when the volatility of the price is higher or lower, respectively. Bollinger Bands do not, in themselves, generate buy or sell signals; they are an indicator of overbought or oversold conditions. When the price is near the upper or lower band it indicates that a reversal may be imminent. The middle band becomes a support or resistance level. The upper and lower bands can also be interpreted as price targets. When the price bounces off of the lower band and crosses the middle band, then the upper band becomes the price target. + +### Usage + +```python +bbands [-l N_LENGTH] [-s N_STD] [-m {ema,sma,wma,hma,zlma}] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| n_length | length | 15 | True | None | +| n_std | std | 2 | True | None | +| s_mamode | mamode | sma | True | ema, sma, wma, hma, zlma | + +![bbands](https://user-images.githubusercontent.com/46355364/154309951-116f3c31-342d-4ceb-b489-8b0ba78eb3a0.png) + +--- diff --git a/website/content/terminal/reference/stocks/ta/cci.md b/website/content/terminal/reference/stocks/ta/cci.md new file mode 100644 index 000000000000..f10e29bc3b1e --- /dev/null +++ b/website/content/terminal/reference/stocks/ta/cci.md @@ -0,0 +1,41 @@ +--- +title: cci +description: Learn about the Commodity Channel Index (CCI), a tool designed to detect + beginning and ending market trends. Find out how to use it and what its parameters + mean. +keywords: +- CCI +- Commodity Channel Index +- market trends +- overbought conditions +- oversold conditions +- price divergence +- price correction +- n_length +- n_scalar +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +The CCI is designed to detect beginning and ending market trends. The range of 100 to -100 is the normal trading range. CCI values outside of this range indicate overbought or oversold conditions. You can also look for price divergence in the CCI. If the price is making new highs, and the CCI is not, then a price correction is likely. + +### Usage + +```python +cci [-l N_LENGTH] [-s N_SCALAR] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| n_length | length | 14 | True | None | +| n_scalar | scalar | 0.015 | True | None | + +![cci](https://user-images.githubusercontent.com/46355364/154310079-808803ca-26dd-4d45-8a02-17e51230bf2d.png) + +--- diff --git a/website/content/terminal/reference/stocks/ta/cg.md b/website/content/terminal/reference/stocks/ta/cg.md new file mode 100644 index 000000000000..811624e4e1b7 --- /dev/null +++ b/website/content/terminal/reference/stocks/ta/cg.md @@ -0,0 +1,39 @@ +--- +title: cg +description: This document details the Center of Gravity indicator used to anticipate + future price movements and to speculate the next price change of an asset, providing + parameter descriptions, usage, and a demonstrative chart. +keywords: +- Center of Gravity +- COG +- price movements +- oscillator +- market trend +- price reversal +- asset price speculation +- technical analysis +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +The Center of Gravity indicator, in short, is used to anticipate future price movements and to trade on price reversals as soon as they happen. However, just like other oscillators, the COG indicator returns the best results in range-bound markets and should be avoided when the price is trending. Traders who use it will be able to closely speculate the upcoming price change of the asset. + +### Usage + +```python +cg [-l N_LENGTH] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| n_length | length | 14 | True | None | + +![cg](https://user-images.githubusercontent.com/46355364/154310202-cd0d703e-21ba-41a2-b58a-5b8547efa887.png) + +--- diff --git a/website/content/terminal/reference/stocks/ta/clenow.md b/website/content/terminal/reference/stocks/ta/clenow.md new file mode 100644 index 000000000000..3e9b7613cd6f --- /dev/null +++ b/website/content/terminal/reference/stocks/ta/clenow.md @@ -0,0 +1,33 @@ +--- +title: clenow +description: This page provides detailed information on the Clenow Volatility Adjusted + Momentum, including its usage, parameters, and Python code examples. Learn how to + adjust the lookback period for regression. +keywords: +- clenow +- volatility adjusted momentum +- marketing website page +- lookback period for regression +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Calculates the Clenow Volatility Adjusted Momentum. + +### Usage + +```python +clenow [-p PERIOD] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| period | Lookback period for regression | 90 | True | None | + +--- diff --git a/website/content/terminal/reference/stocks/ta/demark.md b/website/content/terminal/reference/stocks/ta/demark.md new file mode 100644 index 000000000000..cad0ad4ff04f --- /dev/null +++ b/website/content/terminal/reference/stocks/ta/demark.md @@ -0,0 +1,36 @@ +--- +title: demark +description: This page provides insights into the calculation of the Demark sequential + indicator, its usage, and parameters. Ideal for those interested in Python programming, + data visualization, financial analysis, and trading indicators. +keywords: +- Demark sequential indicator +- Demark calculation +- Indicator parameters +- Python programming +- Data visualization +- Financial analysis +- Trading indicators +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Calculates the Demark sequential indicator. + +### Usage + +```python +demark [-m MIN_TO_SHOW] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| min_to_show | Minimum value of indicator to show (declutters plot). | 5 | True | None | + +--- diff --git a/website/content/terminal/reference/stocks/ta/donchian.md b/website/content/terminal/reference/stocks/ta/donchian.md new file mode 100644 index 000000000000..4d5efb3991dd --- /dev/null +++ b/website/content/terminal/reference/stocks/ta/donchian.md @@ -0,0 +1,42 @@ +--- +title: donchian +description: This page provides in-depth details on Donchian Channels - an indicator + formed by upper and lower bands around a midrange or median band, and how to use + it with parameters in python. +keywords: +- Donchian Channels +- moving average calculations +- security price +- upper band +- lower band +- midrange +- median band +- parameters +- n_length_upper +- n_length_lower +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Donchian Channels are three lines generated by moving average calculations that comprise an indicator formed by upper and lower bands around a midrange or median band. The upper band marks the highest price of a security over N periods while the lower band marks the lowest price of a security over N periods. The area between the upper and lower bands represents the Donchian Channel. + +### Usage + +```python +donchian [-u N_LENGTH_UPPER] [-l N_LENGTH_LOWER] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| n_length_upper | length | 20 | True | None | +| n_length_lower | length | 20 | True | None | + +![donchian](https://user-images.githubusercontent.com/46355364/154310472-6cd5805f-b87f-4668-85a1-3e5dd7267848.png) + +--- diff --git a/website/content/terminal/reference/stocks/ta/ema.md b/website/content/terminal/reference/stocks/ta/ema.md new file mode 100644 index 000000000000..0e5d1c9be29b --- /dev/null +++ b/website/content/terminal/reference/stocks/ta/ema.md @@ -0,0 +1,39 @@ +--- +title: ema +description: This is an explanation and usage guideline for the Exponential Moving + Average (EMA), a core tool in technical analysis. Learn about its distinction from + the Simple Moving Average and understand how it places greater contribution on recent + values, making it more responsive to changes in data. +keywords: +- Exponential Moving Average +- technical analysis +- Simple Moving Average +- ema +- ema parameters +- ema usage +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +The Exponential Moving Average is a staple of technical analysis and is used in countless technical indicators. In a Simple Moving Average, each value in the time period carries equal weight, and values outside of the time period are not included in the average. However, the Exponential Moving Average is a cumulative calculation, including all data. Past values have a diminishing contribution to the average, while more recent values have a greater contribution. This method allows the moving average to be more responsive to changes in the data. + +### Usage + +```python +ema [-l N_LENGTH] [-o N_OFFSET] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| n_length | Window lengths. Multiple values indicated as comma separated values. | 20, 50 | True | None | +| n_offset | offset | 0 | True | None | + +![ema](https://user-images.githubusercontent.com/46355364/154310578-6f4a51a8-3667-497c-9c50-7ff16e256fb6.png) + +--- diff --git a/website/content/terminal/reference/stocks/ta/fib.md b/website/content/terminal/reference/stocks/ta/fib.md new file mode 100644 index 000000000000..a36620999109 --- /dev/null +++ b/website/content/terminal/reference/stocks/ta/fib.md @@ -0,0 +1,41 @@ +--- +title: fib +description: The page delivers documentation for the Python program 'fib', used to + calculate fibonacci retracement levels. It includes usage instructions, parameters + definition, and visual outputs. +keywords: +- fibonacci retracement levels +- fib program +- period parameter +- start parameter +- end parameter +- date selection +- data analytics +- technical analysis tool +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Calculates the fibonacci retracement levels + +### Usage + +```python +fib [-p PERIOD] [--start START] [--end END] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| period | Days to look back for retracement | 120 | True | None | +| start | Starting date to select | None | True | None | +| end | Ending date to select | None | True | None | + +![fib](https://user-images.githubusercontent.com/46355364/154310727-81a1eab3-5565-42c7-8b47-4f80288dd700.png) + +--- diff --git a/website/content/terminal/reference/stocks/ta/fisher.md b/website/content/terminal/reference/stocks/ta/fisher.md new file mode 100644 index 000000000000..24b8f9bb0b3e --- /dev/null +++ b/website/content/terminal/reference/stocks/ta/fisher.md @@ -0,0 +1,43 @@ +--- +title: fisher +description: The page provides a comprehensive guide to the Fisher Transform, a technical + indicator by John F. Ehlers. It helps in highlighting extreme prices based on recent + values, identifying turning points, showing the trend and isolating price waves. + The functions, usage and parameters of the Fisher Transform are elaborately discussed. +keywords: +- Fisher Transform +- technical indicator +- John F. Ehlers +- Gaussian normal distribution +- extreme prices +- turning points +- price of an asset +- trend indication +- price waves +- Fisher usage +- Fisher parameters +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +The Fisher Transform is a technical indicator created by John F. Ehlers that converts prices into a Gaussian normal distribution.1 The indicator highlights when prices have moved to an extreme, based on recent prices. This may help in spotting turning points in the price of an asset. It also helps show the trend and isolate the price waves within a trend. + +### Usage + +```python +fisher [-l N_LENGTH] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| n_length | length | 14 | True | None | + +![fisher](https://user-images.githubusercontent.com/46355364/154310853-0abf6cea-71ca-4f07-b009-282c58ab9cfc.png) + +--- diff --git a/website/content/terminal/reference/stocks/ta/hma.md b/website/content/terminal/reference/stocks/ta/hma.md new file mode 100644 index 000000000000..28d33c09cd9f --- /dev/null +++ b/website/content/terminal/reference/stocks/ta/hma.md @@ -0,0 +1,41 @@ +--- +title: hma +description: Hull Moving Average (HMA) is a moving average methodology that reduces + lag and increases curve smoothness. This page provides detailed usage information, + relevant parameters, and imagery references. +keywords: +- Hull Moving Average +- HMA +- moving average +- market analysis +- lag reduction +- curve smoothness +- usage instruction +- parameters +- imagery +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +The Hull Moving Average solves the age old dilemma of making a moving average more responsive to current price activity whilst maintaining curve smoothness. In fact the HMA almost eliminates lag altogether and manages to improve smoothing at the same time. + +### Usage + +```python +hma [-l N_LENGTH] [-o N_OFFSET] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| n_length | Window lengths. Multiple values indicated as comma separated values. | 10, 20 | True | None | +| n_offset | offset | 0 | True | None | + +![hma](https://user-images.githubusercontent.com/46355364/154310988-2e97c166-a3b9-49ae-abcd-2c1b37309072.png) + +--- diff --git a/website/content/terminal/reference/stocks/ta/kc.md b/website/content/terminal/reference/stocks/ta/kc.md new file mode 100644 index 000000000000..b6c7a939eff6 --- /dev/null +++ b/website/content/terminal/reference/stocks/ta/kc.md @@ -0,0 +1,46 @@ +--- +title: kc +description: In-depth explanation and usage of the KC function for Keltner Channels; + including parameters, and how to utilize it to determine trend direction through + volatility-based bands. +keywords: +- Keltner Channels +- volatility-based bands +- asset's price +- average true range +- ATR +- volatility +- trend direction +- kc +- n_length +- n_scalar +- s_mamode +- n_offset +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Keltner Channels are volatility-based bands that are placed on either side of an asset's price and can aid in determining the direction of a trend.The Keltner channel uses the average true range (ATR) or volatility, with breaks above or below the top and bottom barriers signaling a continuation. + +### Usage + +```python +kc [-l N_LENGTH] [-s N_SCALAR] [-m {ema,sma,wma,hma,zlma}] [-o N_OFFSET] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| n_length | Window length | 20 | True | None | +| n_scalar | scalar | 2 | True | None | +| s_mamode | mamode | ema | True | ema, sma, wma, hma, zlma | +| n_offset | offset | 0 | True | None | + +![kc](https://user-images.githubusercontent.com/46355364/154311120-a769ee53-901b-401f-907f-cacac43ee9b9.png) + +--- diff --git a/website/content/terminal/reference/stocks/ta/load.md b/website/content/terminal/reference/stocks/ta/load.md new file mode 100644 index 000000000000..13b51aa7facb --- /dev/null +++ b/website/content/terminal/reference/stocks/ta/load.md @@ -0,0 +1,47 @@ +--- +title: load +description: This page provides detailed instructions on how to load a stock ticker + to perform analysis, complete with usage examples and parameters. It also provides + information on loading Indian tickers and references to data sources. +keywords: +- load stock ticker +- perform stock analysis +- Indian stock ticker +- stock analysis parameters +- stock data usage +- data source +- intraday stock minutes +- pre/after market hours +- load custom file +- monthly data +- weekly data +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Load stock ticker to perform analysis on. When the data source is syf', an Indian ticker can be loaded by using '.NS' at the end, e.g. 'SBIN.NS'. See available market in https://help.yahoo.com/kb/exchanges-data-providers-yahoo-finance-sln2310.html. + +### Usage + +```python +load -t TICKER [-s START] [-e END] [-i {1,5,15,30,60}] [-p] [-f FILEPATH] [-m] [-w] [-r {ytd,1y,2y,5y,6m}] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| ticker | Stock ticker | None | False | None | +| start | The starting date (format YYYY-MM-DD) of the stock | 2019-11-21 | True | None | +| end | The ending date (format YYYY-MM-DD) of the stock | 2022-11-25 | True | None | +| interval | Intraday stock minutes | 1440 | True | 1, 5, 15, 30, 60 | +| prepost | Pre/After market hours. Only works for 'yf' source, and intraday data | False | True | None | +| filepath | Path to load custom file. | None | True | None | +| monthly | Load monthly data | False | True | None | +| weekly | Load weekly data | False | True | None | + +--- diff --git a/website/content/terminal/reference/stocks/ta/macd.md b/website/content/terminal/reference/stocks/ta/macd.md new file mode 100644 index 000000000000..620a47ac83d9 --- /dev/null +++ b/website/content/terminal/reference/stocks/ta/macd.md @@ -0,0 +1,42 @@ +--- +title: macd +description: This page explains the Moving Average Convergence Divergence (MACD), + a tool used in technical analysis to signal trend changes. By explaining the behaviour + of MACD under various conditions, understanding its usage, and highlighting its + parameters, it assists in generating buy and sell signals. +keywords: +- MACD +- Moving Average Convergence Divergence +- Exponential Moving Averages +- Trend changes +- Buy signal +- Sell signal +- Overbought conditions +- Oversold conditions +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +The Moving Average Convergence Divergence (MACD) is the difference between two Exponential Moving Averages. The Signal line is an Exponential Moving Average of the MACD. The MACD signals trend changes and indicates the start of new trend direction. High values indicate overbought conditions, low values indicate oversold conditions. Divergence with the price indicates an end to the current trend, especially if the MACD is at extreme high or low values. When the MACD line crosses above the signal line a buy signal is generated. When the MACD crosses below the signal line a sell signal is generated. To confirm the signal, the MACD should be above zero for a buy, and below zero for a sell. + +### Usage + +```python +macd [--fast N_FAST] [--slow N_SLOW] [--signal N_SIGNAL] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| n_fast | The short period. | 12 | True | None | +| n_slow | The long period. | 26 | True | None | +| n_signal | The signal period. | 9 | True | None | + +![macd](https://user-images.githubusercontent.com/46355364/154311220-d18eb93e-76b3-4abb-b9c6-86484f462c55.png) + +--- diff --git a/website/content/terminal/reference/stocks/ta/obv.md b/website/content/terminal/reference/stocks/ta/obv.md new file mode 100644 index 000000000000..1ec67f1db0d9 --- /dev/null +++ b/website/content/terminal/reference/stocks/ta/obv.md @@ -0,0 +1,38 @@ +--- +title: obv +description: Learn about On Balance Volume (OBV), a cumulative total of the up and + down volume. Understand how to interpret OBV and its applications in the market + trend analysis. No parameters required for this command. +keywords: +- On Balance Volume +- up and down volume +- market trend analysis +- OBV +- price moves +- non-confirmed move +- strong trend +- market is not trending +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +The On Balance Volume (OBV) is a cumulative total of the up and down volume. When the close is higher than the previous close, the volume is added to the running total, and when the close is lower than the previous close, the volume is subtracted from the running total. To interpret the OBV, look for the OBV to move with the price or precede price moves. If the price moves before the OBV, then it is a non-confirmed move. A series of rising peaks, or falling troughs, in the OBV indicates a strong trend. If the OBV is flat, then the market is not trending. + +### Usage + +```python +obv +``` + +--- + +## Parameters + +This command has no parameters + + +![obv](https://user-images.githubusercontent.com/46355364/154311359-edb78587-744f-4e2c-b247-8b9fbf09b01f.png) + +--- diff --git a/website/content/terminal/reference/stocks/ta/recom.md b/website/content/terminal/reference/stocks/ta/recom.md new file mode 100644 index 000000000000..af0df8fd8259 --- /dev/null +++ b/website/content/terminal/reference/stocks/ta/recom.md @@ -0,0 +1,69 @@ +--- +title: recom +description: This documentation page outlines the use of a Python command-line tool + that prints Tradingview recommendations for various stock exchanges based on selected + technical indicators. It also covers the usage, parameters, and provides examples + of applicable scripts with their outputs. +keywords: +- Tradingview recommendation +- Technical indicators +- Script +- Stock exchange +- Python command-line tool +- Forex +- Crypto +- Screener +- Stocks +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Print tradingview recommendation based on technical indicators. [Source: Tradingview] + +### Usage + +```python +recom [-s {australia,brazil,cfd,crypto,euronext,forex,france,germany,hongkong,india,indonesia,malaysia,philippines,russia,ksa,rsa,korea,spain,sweden,taiwan,thailand,turkey,uk,america,vietnam}] [-e EXCHANGE] [-i {1m,5m,15m,1h,4h,1d,1W,1M}] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| screener | Screener. See https://python-tradingview-ta.readthedocs.io/en/latest/usage.html | america | True | australia, brazil, cfd, crypto, euronext, forex, france, germany, hongkong, india, indonesia, malaysia, philippines, russia, ksa, rsa, korea, spain, sweden, taiwan, thailand, turkey, uk, america, vietnam | +| exchange | Set exchange. For Forex use: 'FX_IDC', and for crypto use 'TVC'. See https://python-tradingview-ta.readthedocs.io/en/latest/usage.html. By default Alpha Vantage tries to get this data from the ticker. | | True | None | +| interval | Interval, that corresponds to the recommendation given by tradingview based on technical indicators. See https://python-tradingview-ta.readthedocs.io/en/latest/usage.html | | True | 1m, 5m, 15m, 1h, 4h, 1d, 1W, 1M | + + +--- + +## Examples + +```python +2022 Feb 16, 11:31 (🦋) /stocks/ta/ $ recom + Ticker Recommendation +┏━━━━━━━━━┳━━━━━━━━━━━━━━━━┳━━━━━┳━━━━━━┳━━━━━━━━━┓ +┃ ┃ RECOMMENDATION ┃ BUY ┃ SELL ┃ NEUTRAL ┃ +┡━━━━━━━━━╇━━━━━━━━━━━━━━━━╇━━━━━╇━━━━━━╇━━━━━━━━━┩ +│ 1 month │ BUY │ 15 │ 2 │ 9 │ +├─────────┼────────────────┼─────┼──────┼─────────┤ +│ 1 week │ BUY │ 14 │ 2 │ 10 │ +├─────────┼────────────────┼─────┼──────┼─────────┤ +│ 1 day │ SELL │ 5 │ 13 │ 8 │ +├─────────┼────────────────┼─────┼──────┼─────────┤ +│ 4 hours │ SELL │ 4 │ 14 │ 8 │ +├─────────┼────────────────┼─────┼──────┼─────────┤ +│ 1 hour │ SELL │ 4 │ 13 │ 9 │ +├─────────┼────────────────┼─────┼──────┼─────────┤ +│ 15 min │ SELL │ 3 │ 13 │ 10 │ +├─────────┼────────────────┼─────┼──────┼─────────┤ +│ 5 min │ SELL │ 5 │ 12 │ 9 │ +├─────────┼────────────────┼─────┼──────┼─────────┤ +│ 1 min │ SELL │ 6 │ 11 │ 9 │ +└─────────┴────────────────┴─────┴──────┴─────────┘ +``` +--- diff --git a/website/content/terminal/reference/stocks/ta/rsi.md b/website/content/terminal/reference/stocks/ta/rsi.md new file mode 100644 index 000000000000..e1fe6b2c701b --- /dev/null +++ b/website/content/terminal/reference/stocks/ta/rsi.md @@ -0,0 +1,43 @@ +--- +title: rsi +description: This page provides comprehensive information about the Relative Strength + Index (RSI), a tool used to calculate the ratio of recent upward price movements. + It details how to interpret RSI as an overbought or oversold indicator, highlights + how to use it, and breaks down various parameters associated with it. +keywords: +- Relative Strength Index +- rsi +- overbought/oversold indicator +- price movements +- price reversal +- rsi parameters +- n_length +- n_scalar +- n_drift +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +The Relative Strength Index (RSI) calculates a ratio of the recent upward price movements to the absolute price movement. The RSI ranges from 0 to 100. The RSI is interpreted as an overbought/oversold indicator when the value is over 70/below 30. You can also look for divergence with price. If the price is making new highs/lows, and the RSI is not, it indicates a reversal. + +### Usage + +```python +rsi [-l N_LENGTH] [-s N_SCALAR] [-d N_DRIFT] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| n_length | length | 14 | True | None | +| n_scalar | scalar | 100 | True | None | +| n_drift | drift | 1 | True | None | + +![rsi](https://user-images.githubusercontent.com/46355364/154311651-99e67e12-1677-43a9-92d9-5998d99fd0db.png) + +--- diff --git a/website/content/terminal/reference/stocks/ta/sma.md b/website/content/terminal/reference/stocks/ta/sma.md new file mode 100644 index 000000000000..169735c9cd3b --- /dev/null +++ b/website/content/terminal/reference/stocks/ta/sma.md @@ -0,0 +1,41 @@ +--- +title: sma +description: The page explains the simple moving average (SMA) command, used for data + smoothing and trend identification. It includes SMA's usage, parameters, and a graphical + representation, making it easier to understand how to use SMA to filter data. +keywords: +- Moving Average +- trend identification +- data smoothing +- Simple Moving Average +- SMA +- data filtering +- sma command +- n_length +- n_offset +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Moving Averages are used to smooth the data in an array to help eliminate noise and identify trends. The Simple Moving Average is literally the simplest form of a moving average. Each output value is the average of the previous n values. In a Simple Moving Average, each value in the time period carries equal weight, and values outside of the time period are not included in the average. This makes it less responsive to recent changes in the data, which can be useful for filtering out those changes. + +### Usage + +```python +sma [-l N_LENGTH] [-o N_OFFSET] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| n_length | Window lengths. Multiple values indicated as comma separated values. | 20, 50 | True | None | +| n_offset | offset | 0 | True | None | + +![sma](https://user-images.githubusercontent.com/46355364/154311791-5b130d08-55bd-406b-a68e-914a733c5191.png) + +--- diff --git a/website/content/terminal/reference/stocks/ta/stoch.md b/website/content/terminal/reference/stocks/ta/stoch.md new file mode 100644 index 000000000000..403b63dc47cd --- /dev/null +++ b/website/content/terminal/reference/stocks/ta/stoch.md @@ -0,0 +1,49 @@ +--- +title: stoch +description: This page presents an understanding of the Stochastic Oscillator, a technical + analysis indicator, and its parameters. It illustrates the buy and sell signals, + moving averages, overbought and oversold conditions, and usage in Python. Particularly, + it explains the commands n_fastkperiod, n_slowdperiod, and n_slowkperiod. +keywords: +- Stochastic Oscillator +- overbought condition +- oversold condition +- Fast %D +- Slow %D +- buy signal +- sell signal +- Raw %K +- crossover signals +- stoch +- moving average +- trading range +- n_fastkperiod +- n_slowdperiod +- n_slowkperiod +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +The Stochastic Oscillator measures where the close is in relation to the recent trading range. The values range from zero to 100. %D values over 75 indicate an overbought condition; values under 25 indicate an oversold condition. When the Fast %D crosses above the Slow %D, it is a buy signal; when it crosses below, it is a sell signal. The Raw %K is generally considered too erratic to use for crossover signals. + +### Usage + +```python +stoch [-k N_FASTKPERIOD] [-d N_SLOWDPERIOD] [--slowkperiod N_SLOWKPERIOD] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| n_fastkperiod | The time period of the fastk moving average | 14 | True | None | +| n_slowdperiod | The time period of the slowd moving average | 3 | True | None | +| n_slowkperiod | The time period of the slowk moving average | 3 | True | None | + +![stoch](https://user-images.githubusercontent.com/46355364/154311913-d58e58bb-d116-44dd-ae4b-44e59c25f22a.png) + +--- diff --git a/website/content/terminal/reference/stocks/ta/summary.md b/website/content/terminal/reference/stocks/ta/summary.md new file mode 100644 index 000000000000..d074c96928a2 --- /dev/null +++ b/website/content/terminal/reference/stocks/ta/summary.md @@ -0,0 +1,52 @@ +--- +title: summary +description: Detailed guide on using the technical summary report provided by FinBrain's + API, a leading provider of deep learning algorithms for financial analysis and prediction. + Learn how to track market trends and indicators such as RSI, MACD, SMA, and Bollinger + Bands. +keywords: +- technical summary +- FinBrain API +- trading prediction +- deep learning algorithms +- stock trading +- stock trends +- RSI +- MACD +- SMA +- Bollinger Bands +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Technical summary report provided by FinBrain's API. FinBrain Technologies develops deep learning algorithms for financial analysis and prediction, which currently serves traders from more than 150 countries all around the world. [Source: Finbrain] + +### Usage + +```python +summary +``` + +--- + +## Parameters + +This command has no parameters + + + +--- + +## Examples + +```python +2022 Feb 16, 11:33 (🦋) /stocks/ta/ $ summary +GOOGL price has changed -1.45% in the last 3 days and 0.80% yesterday. +RSI is currently neutral but close to the overbought area and the indicator is pointing downwards. +MACD is in the Bullish area and the histogram is moving downwards. +GOOGL price is trading below the 200-day SMA line and the SMA is trending up. +The asset price is between the Upper and the Middle Bollinger Bands. +``` +--- diff --git a/website/content/terminal/reference/stocks/ta/tv.md b/website/content/terminal/reference/stocks/ta/tv.md new file mode 100644 index 000000000000..4c60ac0eb96f --- /dev/null +++ b/website/content/terminal/reference/stocks/ta/tv.md @@ -0,0 +1,32 @@ +--- +title: tv +description: The webpage describes the use of 'tv' command to display TradingView + for technical analysis. It provides information on how to use the command in python, + and elaborates that this command doesn't require any parameters. +keywords: +- TradingView +- technical analysis +- tv command +- no parameters +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +View TradingView for technical analysis. [Source: TradingView] + +### Usage + +```python +tv +``` + +--- + +## Parameters + +This command has no parameters + + +--- diff --git a/website/content/terminal/reference/stocks/ta/view.md b/website/content/terminal/reference/stocks/ta/view.md new file mode 100644 index 000000000000..a8d9e487cb1e --- /dev/null +++ b/website/content/terminal/reference/stocks/ta/view.md @@ -0,0 +1,33 @@ +--- +title: view +description: Learn how to view historical stocks price with trendlines using our platform. + No parameters, quick visualization and up-to-date information from Finviz. +keywords: +- view historical price +- price trendlines +- stock price visualization +- Finviz +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +View historical price with trendlines. [Source: Finviz] + +### Usage + +```python +view +``` + +--- + +## Parameters + +This command has no parameters + + +![aapl](https://user-images.githubusercontent.com/25267873/113757843-02107700-970b-11eb-99ab-eb9b1312547f.png) + +--- diff --git a/website/content/terminal/reference/stocks/ta/vwap.md b/website/content/terminal/reference/stocks/ta/vwap.md new file mode 100644 index 000000000000..3071d9ad8bc6 --- /dev/null +++ b/website/content/terminal/reference/stocks/ta/vwap.md @@ -0,0 +1,61 @@ +--- +title: vwap +description: This page provides documentation on Volume Weighted Average Price (vwap) + which measures the average typical price by volume. It shows usage, parameters, + and examples specific to the analysis of stock data, with an example featuring the + GOOGL stock. +keywords: +- vwap +- Volume Weighted Average Price +- intraday charts +- general direction +- parameters +- examples +- stocks +- analysis +- offset +- GOOGL stock +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +The Volume Weighted Average Price that measures the average typical price by volume. It is typically used with intraday charts to identify general direction. + +### Usage + +```python +vwap [-o N_OFFSET] [--start START] [--end END] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| n_offset | offset | 0 | True | None | +| start | Starting date to select | None | True | None | +| end | Ending date to select | None | True | None | + + +--- + +## Examples + +```python +2022 Feb 16, 11:36 (🦋) /stocks/ta/ $ load GOOGL -i 1 + +Loading Intraday 1min GOOGL stock with starting period 2022-02-10 for analysis. + +Datetime: 2022 Feb 16 11:36 +Timezone: America/New_York +Currency: USD +Market: CLOSED + +2022 Feb 16, 11:36 (🦋) /stocks/ta/ $ vwap +``` +![vwap](https://user-images.githubusercontent.com/46355364/154312502-9377c57c-6e34-42a6-b021-674e7d4561dd.png) + +--- diff --git a/website/content/terminal/reference/stocks/ta/wma.md b/website/content/terminal/reference/stocks/ta/wma.md new file mode 100644 index 000000000000..2d7c4dd4150f --- /dev/null +++ b/website/content/terminal/reference/stocks/ta/wma.md @@ -0,0 +1,38 @@ +--- +title: wma +description: Learn how to use the Weighted Moving Average (WMA) in data analysis with + this comprehensive guide. The WMA accentuates recent prices over past figures, thus + providing close follow-up of market trends. +keywords: +- Weighted Moving Average +- WMA +- data +- data analysis +- market trends +- price tracking +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +A Weighted Moving Average puts more weight on recent data and less on past data. This is done by multiplying each bar’s price by a weighting factor. Because of its unique calculation, WMA will follow prices more closely than a corresponding Simple Moving Average. + +### Usage + +```python +wma [-l N_LENGTH] [-o N_OFFSET] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| n_length | Window lengths. Multiple values indicated as comma separated values. | 20, 50 | True | None | +| n_offset | offset | 0 | True | None | + +![wma](https://user-images.githubusercontent.com/46355364/154312618-43430406-97c1-4740-87be-2414de9a1c06.png) + +--- diff --git a/website/content/terminal/reference/stocks/ta/zlma.md b/website/content/terminal/reference/stocks/ta/zlma.md new file mode 100644 index 000000000000..e685d7c15098 --- /dev/null +++ b/website/content/terminal/reference/stocks/ta/zlma.md @@ -0,0 +1,43 @@ +--- +title: zlma +description: The zlma page provides an in-depth understanding of the zero lag exponential + moving average (ZLEMA), with insight into its usage, parameters such as 'n_length' + and 'n_offset', and a usage example. This indicator was created by John Ehlers and + Ric Way and the page neatly explains the concept with visual aids. +keywords: +- zlma +- zero lag exponential moving average +- John Ehlers +- Ric Way +- exponential moving average +- EMA +- de-lagged data +- moving average +- n_length +- n_offset +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +The zero lag exponential moving average (ZLEMA) indicator was created by John Ehlers and Ric Way. The idea is do a regular exponential moving average (EMA) calculation but on a de-lagged data instead of doing it on the regular data. Data is de-lagged by removing the data from "lag" days ago thus removing (or attempting to) the cumulative effect of the moving average. + +### Usage + +```python +zlma [-l N_LENGTH] [-o N_OFFSET] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| n_length | Window lengths. Multiple values indicated as comma separated values. | 20 | True | None | +| n_offset | offset | 0 | True | None | + +![zlma](https://user-images.githubusercontent.com/46355364/154312786-bc60268b-9da9-4fd9-bed6-fc95f5560075.png) + +--- diff --git a/website/versioned_docs/version-v3/terminal/reference/stocks/th/_category_.json b/website/content/terminal/reference/stocks/th/_category_.json similarity index 100% rename from website/versioned_docs/version-v3/terminal/reference/stocks/th/_category_.json rename to website/content/terminal/reference/stocks/th/_category_.json diff --git a/website/content/terminal/reference/stocks/th/all.md b/website/content/terminal/reference/stocks/th/all.md new file mode 100644 index 000000000000..e30ff1f62da1 --- /dev/null +++ b/website/content/terminal/reference/stocks/th/all.md @@ -0,0 +1,32 @@ +--- +title: all +description: This page provides insights on the 'all' exchange command, including + its usage and parameters. This command displays all the exchanges available. +keywords: +- all exchange command +- show all exchanges +- exchanges usage +- command parameters +- exchanges command documentation +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Show all exchanges + +### Usage + +```python +exchange +``` + +--- + +## Parameters + +This command has no parameters + + +--- diff --git a/website/content/terminal/reference/stocks/th/closed.md b/website/content/terminal/reference/stocks/th/closed.md new file mode 100644 index 000000000000..d1a5df3bdb4b --- /dev/null +++ b/website/content/terminal/reference/stocks/th/closed.md @@ -0,0 +1,31 @@ +--- +title: closed +description: Closed exchanges documentation page provides instructions on how to use + the 'exchange' command that has no parameters to show currently closed exchanges. +keywords: +- closed exchanges +- exchange command +- usage +- no parameters +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Show currently closed exchanges + +### Usage + +```python +exchange +``` + +--- + +## Parameters + +This command has no parameters + + +--- diff --git a/website/content/terminal/reference/stocks/th/exchange.md b/website/content/terminal/reference/stocks/th/exchange.md new file mode 100644 index 000000000000..046046b78881 --- /dev/null +++ b/website/content/terminal/reference/stocks/th/exchange.md @@ -0,0 +1,33 @@ +--- +title: exchange +description: Documentation page for exchanging market information, including usage, + parameters and selectable choices. +keywords: +- Exchange +- Market Information +- Parameters +- Docusaurus page +- Documentation +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Select the exchange you want see open hours for + +### Usage + +```python +exchange [-n {AMEX,AMS,AQ,AQS,ARCA,AS,ASE,ASX,AT,ATH,AX,BA,BD,BK,BO,BR,BRU,BSE,BUD,BUE,CA,CAI,CCS,CM,CN,CNQ,CO,CPH,CR,CSE,DE,DOH,DU,DUS,EBS,ENX,F,F,FKA,FRA,GER,HA,HAM,HAN,HE,HEL,HKEX,HKG,HM,IC,ICE,IL,IOB,IR,IS,ISE,IST,JK,JKT,JNB,JO,JPX,KLS,KLSE,KOE,KRX,KRX,KSC,L,LIS,LIT,LS,LSE,MC,MCE,MCX,ME,MEX,MI,MIL,MU,MUN,MX,NAS,NAS,NASDQ,NASGM,NASGS,NCM,NE,NEO,NGM,NMS,NS,NSI,NX,NYQ,NYS,NYS,NYSE,NZ,NZE,OL,OSL,OTC,PA,PAR,PCX,PNK,PR,PRA,QA,RG,RIS,S,SA,SAO,SAP,SAT,SAU,SES,SET,SG,SGO,SHH,SHZ,SHZE,SI,SN,SR,SS,ST,ST,STO,STU,SW,T,TA,TAL,TI,TL,TLO,TLV,TO,TOR,TW,TWO,TWO,TWSE,V,VAN,VI,VIE,VS}] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| exchange | Exchange short name | None | True | AMEX, AMS, AQ, AQS, ARCA, AS, ASE, ASX, AT, ATH, AX, BA, BD, BK, BO, BR, BRU, BSE, BUD, BUE, CA, CAI, CCS, CM, CN, CNQ, CO, CPH, CR, CSE, DE, DOH, DU, DUS, EBS, ENX, F, F, FKA, FRA, GER, HA, HAM, HAN, HE, HEL, HKEX, HKG, HM, IC, ICE, IL, IOB, IR, IS, ISE, IST, JK, JKT, JNB, JO, JPX, KLS, KLSE, KOE, KRX, KRX, KSC, L, LIS, LIT, LS, LSE, MC, MCE, MCX, ME, MEX, MI, MIL, MU, MUN, MX, NAS, NAS, NASDQ, NASGM, NASGS, NCM, NE, NEO, NGM, NMS, NS, NSI, NX, NYQ, NYS, NYS, NYSE, NZ, NZE, OL, OSL, OTC, PA, PAR, PCX, PNK, PR, PRA, QA, RG, RIS, S, SA, SAO, SAP, SAT, SAU, SES, SET, SG, SGO, SHH, SHZ, SHZE, SI, SN, SR, SS, ST, ST, STO, STU, SW, T, TA, TAL, TI, TL, TLO, TLV, TO, TOR, TW, TWO, TWO, TWSE, V, VAN, VI, VIE, VS | + +--- diff --git a/website/content/terminal/reference/stocks/th/open.md b/website/content/terminal/reference/stocks/th/open.md new file mode 100644 index 000000000000..736a2096526e --- /dev/null +++ b/website/content/terminal/reference/stocks/th/open.md @@ -0,0 +1,32 @@ +--- +title: open +description: Learn about the command to show currently open exchanges with our detailed + documentation. Understand its usage with no parameters. +keywords: +- Command +- Open exchanges +- Usage +- Parameters +- Documentation +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Show currently open exchanges + +### Usage + +```python +exchange +``` + +--- + +## Parameters + +This command has no parameters + + +--- diff --git a/website/content/terminal/reference/stocks/th/symbol.md b/website/content/terminal/reference/stocks/th/symbol.md new file mode 100644 index 000000000000..fee0602ce2da --- /dev/null +++ b/website/content/terminal/reference/stocks/th/symbol.md @@ -0,0 +1,36 @@ +--- +title: symbol +description: The page offers insight into using the 'symbol' parameter in trading + commands. It serves as a guide to set the symbol for your trades using Python, detailing + its usage and parameters. +keywords: +- symbol trading +- trade symbols +- trading parameters +- symbol selection +- stock symbols +- python trading commands +- symbol choice +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Select the symbol you wish to trade + +### Usage + +```python +symbol [-n SYMBOL] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| symbol | Symbol | None | True | None | + +--- diff --git a/website/content/terminal/reference/stocks/tob.md b/website/content/terminal/reference/stocks/tob.md new file mode 100644 index 000000000000..7e25c43dc5c0 --- /dev/null +++ b/website/content/terminal/reference/stocks/tob.md @@ -0,0 +1,40 @@ +--- +title: tob +description: This page provides insights on how to use the 'tob' function to get the + top of a book for a loaded ticker from a selected exchange, explaining its parameters + and usage. +keywords: +- tob function +- top of book +- loaded ticker +- selected exchange +- function usage +- parameters +- BZX +- EDGX +- BYX +- EDGA +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +Get top of book for loaded ticker from selected exchange + +### Usage + +```python +quote -t S_TICKER [-e {BZX,EDGX,BYX,EDGA}] +``` + +--- + +## Parameters + +| Name | Description | Default | Optional | Choices | +| ---- | ----------- | ------- | -------- | ------- | +| s_ticker | Ticker to get data for | None | False | None | +| exchange | | BZX | True | BZX, EDGX, BYX, EDGA | + +--- diff --git a/website/versioned_docs/version-v3/terminal/usage/_category_.json b/website/content/terminal/usage/_category_.json similarity index 100% rename from website/versioned_docs/version-v3/terminal/usage/_category_.json rename to website/content/terminal/usage/_category_.json diff --git a/website/content/terminal/usage/askobb-feature.md b/website/content/terminal/usage/askobb-feature.md new file mode 100644 index 000000000000..73dd29603bdf --- /dev/null +++ b/website/content/terminal/usage/askobb-feature.md @@ -0,0 +1,78 @@ +--- +title: AskOBB Feature +sidebar_position: 5 +description: This documentation page presents the innovative use of language learning + machines (LLMs), in particular, the LlamaIndex in transforming natural language + queries into commands in OpenBB Terminal. +keywords: +- AskOBB +- natural language query +- LLMs +- LlamaIndex +- BloombergGPT +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import TutorialVideo from '@site/src/components/General/TutorialVideo.tsx'; + + + +AskOBB allows users to do a query using natural language and we convert it directly into a command. This makes it easier for newcomers to get started with the OpenBB Terminal. + +![image](https://github.com/OpenBB-finance/OpenBBTerminal/assets/25267873/1ba1e556-150f-470c-9745-2dd7b536e5ba) + + +## Background + +With the rise of LLMs, it was only a matter of time before LlamaIndex became prevalent in the finance space. While emergent technologies like [BloombergGPT](https://www.bloomberg.com/company/press/bloomberggpt-50-billion-parameter-llm-tuned-finance/) is trained on financial information and financial documents, OpenBB is taking a different approach. With over 900 different commands accessing data from almost 100 different sources, we wanted to map natural language to these to reduce the barrier of entry to newcomers. + +While this may not sound like a complex problem, as we just need to classify natural language queries into one of 900 possible options, there are quite a few intricacies. Among these is the tree-type structure of OpenBB terminal commands. For example, if you want to view a candle chart looking at the so-called “Golden Cross” (where a 50 and a 200-day EMA cross), you would use the command `stocks/ta/ema -l 50,200`. However, this requires that we have some previous context - i.e. the data should be previously selected. So the full command to use would actually be `stocks/load /ta/ema -l 50,200` with `` being the data of interest. + +Another intricacy is that there are many different asset classes covered, which have their individual `load` commands. Loading in a cryptocurrency, such as Bitcoin, is a different command than loading an equity like AAPL. This means that the language model needs to understand the difference in mapping `load bitcoin` to `crypto/load btc` and `load AAPL` to `stocks/load AAPL`. + + +## Solution: LlamaIndex + +This is where LlamaIndex comes into play. Each of our OpenBB Terminal commands has an associated usage string in the form of a typical CLI help argument. An example for the stocks load command: + +![image](https://github.com/OpenBB-finance/OpenBBTerminal/assets/25267873/fcdcdc22-1c80-4f49-9171-8033c607d0b7) + +You can find this on our docs here: OpenBB Docs. + +If this help string is provided to an LLM, we can ask it for a command based on the context. So what we did was copy all of these command helps into txt files. In order to help out the model, we provided a few examples of each command. In our [stocks load file](https://github.com/OpenBB-finance/OpenBBTerminal/blob/d3126b414aac77fe4086661214535975ac55ba95/openbb_terminal/miscellaneous/gpt_index/data/stocks_load.txt), we add the following examples: + +![image](https://github.com/OpenBB-finance/OpenBBTerminal/assets/25267873/10cae260-8fea-41d0-adb4-13a4b8f62ca8) + +This process is repeated for EVERY function in the OpenBB Terminal. Once we have these, we can pass them to a Vector Index in two lines of code: + +```bash +documents = SimpleDirectoryReader(GPT_INDEX_DIRECTORY / "data/").load_data() +index = VectorStoreIndex.from_documents(documents, service_context=service_context) +``` + +What this Vector Index does is load in each file and create an embedding using the OpenAI embeddings API. In essence, this means each file is associated with a vector (a series of numbers such as `[0.001, 0.002, .2, ..., 0.03]`), and these are all saved in memory through LlamaIndex. + +Now that we have the context of our documentation and examples saved, it is time to query the LLM. For AskOBB, we are using OpenAI’s gpt3.5-turbo model by default, but allow users to specify others (e.g. GPT-4). We provide a prompt string to the query, indicating to only return a command and to follow certain rules when querying. The prompt string we provide is: + +![image](https://github.com/OpenBB-finance/OpenBBTerminal/assets/25267873/c0df6589-e22f-46b0-a272-6fa7f6762ff3) + +To get the LLM response, it is just another 2 lines of code with LlamaIndex: + +```bash +query_engine = index.as_query_engine() response = query_engine.query(prompt_string) +``` + +And that is all we need! + +What this process does is take our previously defined Vector Index, which stores all the relevant embeddings, and it creates an embedding from our prompt, which includes the query. To determine which txt file to use, the Vector Index finds the index with the “closest” embedding and provides that as context to the LLM. + + diff --git a/website/content/terminal/usage/data/_category_.json b/website/content/terminal/usage/data/_category_.json new file mode 100644 index 000000000000..626046e55b7c --- /dev/null +++ b/website/content/terminal/usage/data/_category_.json @@ -0,0 +1,4 @@ +{ + "label": "Data", + "position": 2 +} diff --git a/website/content/terminal/usage/data/api-keys.md b/website/content/terminal/usage/data/api-keys.md new file mode 100644 index 000000000000..600744d9846c --- /dev/null +++ b/website/content/terminal/usage/data/api-keys.md @@ -0,0 +1,857 @@ +--- +title: API Keys +sidebar_position: 2 +description: This documentation page describes how you can set your own API keys from each data vendor on OpenBB to leverage their datasets. +keywords: +- API keys +- datasets +- data vendors +- subscription +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +API (Application Programming Interface) keys are access credentials for obtaining data from a particular data vendor. They are a string of random characters assigned, by the data provider, to an individual account. + +## Setting API keys through Terminal + +Most vendors offer a free tier requiring only a valid email address, some will require an account with proper KYC (Know Your Customer). Each source is entered into the Terminal from the `/keys` menu with the syntax as described in the sections below. Adding the `-h` argument to the command will also display the expected inputs. For example, + +```console +(🦋) /keys/ $ reddit -h + +usage: reddit [-i CLIENT_ID] [-s CLIENT_SECRET] [-u USERNAME] [-p PASSWORD] [-a USER_AGENT [USER_AGENT ...]] [-h] + +Set Reddit API key. + +options: + -i CLIENT_ID, --id CLIENT_ID + Client ID (default: None) + -s CLIENT_SECRET, --secret CLIENT_SECRET + Client Secret (default: None) + -u USERNAME, --username USERNAME + Username (default: None) + -p PASSWORD, --password PASSWORD + Password (default: None) + -a USER_AGENT [USER_AGENT ...], --agent USER_AGENT [USER_AGENT ...] + User agent (default: None) + -h, --help show this help message (default: False) +``` + +In order to set the API key in the terminal, after obtaining the correct information from reddit, one would enter into the terminal: + +```console +(🦋) /keys/ $ reddit -i -s -u -p -a +``` + +A message similar to the one below will be printed when a function requesting data from an API is called but the key has not yet been entered. + +```console +(🦋) /stocks/fa/ $ rot + +API_FINNHUB_KEY not defined. Set API Keys in ~/.openbb_terminal/.env or under keys menu. +``` + +The menu also provides a method for testing the validity of a key upon entry. It can be easy to copy & paste the string with a missing character; so, if the test fails, check that the values were correctly recorded with the command: + +```console +(🦋) /keys/ $ mykeys --show +``` + +:::note +OpenBB recommends users to gradually obtaining API keys from data vendors based on their needs. + +In addition by accessing our [data vendor affiliate program](https://my.openbb.co/app/hub/affiliate) you can get discounts upon sign-up. +::: + + +## Supported data vendors + +This section covers all API keys listed above and include detailed instructions how to obtain each API key. By clicking on each name, the section will expand and instructions are provided. + +### AlphaVantage + +> Alpha Vantage provides enterprise-grade financial market data through a set of powerful and developer-friendly data APIs and spreadsheets. From traditional asset classes (e.g., stocks, ETFs, mutual funds) to economic indicators, from foreign exchange rates to commodities, from fundamental data to technical indicators, Alpha Vantage is your one-stop-shop for real-time and historical global market data delivered through cloud-based APIs, Excel, and Google Sheets. + +
+Instructions + +Go to: https://www.alphavantage.co/support/#api-key + +![AlphaVantage](https://user-images.githubusercontent.com/46355364/207820936-46c2ba00-81ff-4cd3-98a4-4fa44412996f.png) + +Fill out the form, pass Captcha, and click on, "GET FREE API KEY". The issued key can be entered into the OpenBB Terminal with: + +```console +/keys/av REPLACE_WITH_KEY +``` + +
+ +### Binance + +> Binance cryptocurrency exchange - We operate the worlds biggest bitcoin exchange and altcoin crypto exchange in the world by volume + +
+Instructions + +Go to: https://www.binance.com/en/support/faq/how-to-create-api-360002502072 + +![Binance](https://user-images.githubusercontent.com/46355364/207839805-f71cf12a-62d2-41cb-ba19-0c35917abc40.png) + +These instructions should provide clear guidance for obtaining an API Key. Enter the issued credentials into the OpenBB Terminal with: + +```console +/keys/binance -k REPLACE_WITH_KEY -s REPLACE_WITH_SECRET +``` + +
+ +### Bitquery + +> Bitquery is an API-first product company dedicated to power and solve blockchain data problems using the ground truth of on-chain data. + +
+Instructions + +Go to: https://bitquery.io/< + +![Bitquery](https://user-images.githubusercontent.com/46355364/207840322-5532a3f9-739f-4e28-9839-a58db932882e.png) + +Click "Try GraphQL API", which opens the following screen: + +![Try GraphQL API](https://user-images.githubusercontent.com/46355364/207840576-2c51a538-dd9b-484d-b11d-40e3e424df62.png) + +After creating an account and verifying the email address, get the value for the key by clicking on the "API Key" tab. + +![Get Bitquery API Key](https://user-images.githubusercontent.com/46355364/207840833-35c1b12c-9b4b-43fe-a33e-f7b92c43a011.png) + +Enter this API key into the OpenBB Terminal by typing: + +```console +/keys/bitquery REPLACE_WITH_KEY +``` + +
+ +### BizToc + +> BizToc is the one-stop business and finance news hub, encapsulating the top 200 US news providers in real time. + +
+Instructions + +The BizToc API is hosted on RapidAPI. To set up, go to: https://rapidapi.com/thma/api/biztoc. + +![biztoc0](https://github.com/marban/OpenBBTerminal/assets/18151143/04cdd423-f65e-4ad8-ad5a-4a59b0f5ddda) + +In the top right, select "Sign Up". After answering some questions, you will be prompted to select one of their plans. + +![biztoc1](https://github.com/marban/OpenBBTerminal/assets/18151143/9f3b72ea-ded7-48c5-aa33-bec5c0de8422) + +After signing up, navigate back to https://rapidapi.com/thma/api/biztoc. If you are logged in, you will see a header called X-RapidAPI-Key. + +![biztoc2](https://github.com/marban/OpenBBTerminal/assets/18151143/0f3b6c91-07e0-447a-90cd-a9e23522929f) + +Copy the key to the clipboard, and enter this key into the OpenBB Terminal with: + +```console +/keys/biztoc REPLACE_WITH_KEY +``` + +
+ +### CoinMarketCap + +> CoinMarketCap is the world's most-referenced price-tracking website for cryptoassets in the rapidly growing cryptocurrency space. Its mission is to make crypto discoverable and efficient globally by empowering retail users with unbiased, high quality and accurate information for drawing their own informed conclusions. + +
+Instructions + +Go to: https://coinmarketcap.com/api + +![CoinMarketCap](https://user-images.githubusercontent.com/46355364/207831111-3f09ed75-740e-4121-a67e-6e1f36e8ab9a.png) + +Click on, "Get Your Free API Key Now", which opens to the page: + +![CoinMarketCap](https://user-images.githubusercontent.com/46355364/207831345-06a48efe-63b2-4804-bcf9-52fa4a73f7db.png) + +Once the account has been created, copy the API key displayed within the dashboard. + +![CoinMarketCap](https://user-images.githubusercontent.com/46355364/207831705-e9f95018-bba7-49a9-b057-3443bc839861.png) + +Enter the API key into the OpenBB Terminal by typing: + +```console +/keys/cmc REPLACE_WITH_KEY +``` + +
+ +### Coinbase + +> Coinbase is a secure online platform for buying, selling, transferring, and storing cryptocurrency. + +
+Instructions + +Go to: https://help.coinbase.com/en/exchange/managing-my-account/how-to-create-an-api-key + +![Coinbase](https://user-images.githubusercontent.com/46355364/207841901-647f0aef-0c74-454d-b99e-367d784259f0.png) + +Follow the instructions to obtain the credentials for the specific account. Enter the three values into the OpenBB Terminal by typing: + +```console +/keys/coinbase -k REPLACE_WITH_KEY -s REPLACE_WITH_SECRET -p REPLACE_WITH_PASSPHRASE +``` + +
+ +### Coinglass + +> Coinglass is a cryptocurrency futures trading & information platform,where you can find the Bitcoin Liquidations ,Bitcoin open interest, Grayscale Bitcoin Trust，Bitcoin longs vs shorts ratio and actively compare funding rates for crypto futures.Above all the quantities are shown as per their respective contract value. + +
+Instructions + +Go to: https://www.coinglass.com/ + +![Coinglass](https://user-images.githubusercontent.com/46355364/207844601-8510687a-e54f-49b9-961f-5ef6718f58ab.png) + +Click, "Log in", and then sign up for an account. This opens the page: + +![Coinglass](https://user-images.githubusercontent.com/46355364/207844637-a9321889-c4d8-4d44-95fe-a6288a17ad19.png) + +With the account created, find the assigned API key within the account profile page. Enter this value into the OpenBB Terminal by typing: + +```console +/keys/coinglass REPLACE_WITH_KEY +``` + +
+ +### Crypto Panic + +> CryptoPanic is a news aggregator platform indicating impact on price and market for traders and cryptocurrency enthusiasts. + +
+Instructions + +Go to: https://cryptopanic.com/developers/api/ + +![Crypto Panic](https://user-images.githubusercontent.com/46355364/207848733-27e5a804-7ae7-4ca2-88b2-848b32929b6f.png) + +Click on, [Sign up](https://cryptopanic.com/accounts/signup/?next=/developers/api/), and after creating, the API key will be displayed on the documentation page, "Your free API auth token". + +![Crypto Panic](https://user-images.githubusercontent.com/46355364/207848971-3e4771b7-1faa-45fe-955f-81bd736b16b7.png) + +Enter that value in the OpenBB Terminal by typing: + +```console +/keys/cpanic REPLACE_WITH_KEY +``` + +
+ +### Databento + +> Databento eliminates tens of thousands of dollars in upfront expenses per dataset without sacrificing data integrity. We give you the flexibility to pick up real-time full exchange feeds and terabytes of historical data, whenever you need it. + +
+Instructions + +Go to: https://docs.databento.com/getting-started + +![Databento](https://user-images.githubusercontent.com/85772166/221943074-7a5e55c1-6193-42d8-a04c-431603a69a05.png) + +Click on, [Sign up](https://databento.com/signup), and after creating an account, the API key is found in the [account portal](https://databento.com/portal/keys). + +![Databento](https://user-images.githubusercontent.com/85772166/221943270-e0ada7bf-c7fb-46f2-bd7a-49afb3bc7bd8.png) + +Enter this into the terminal with: + +```console +/keys/databento REPLACE_WITH_KEY +``` + +
+ +### DEGIRO + +> DEGIRO is Europe's fastest growing online stock broker. DEGIRO distinguishes itself from its competitors by offering extremely low trading commissions. + +
+Instructions + +Go to: https://www.degiro.com/ + +![Degiro](https://user-images.githubusercontent.com/46355364/207838353-001d350c-872c-4770-a586-fb21318122eb.png) + +Click on, "Open an account", and then go through the registration process. After setting up the account, the login credentials can be entered in the OpenBB Terminal with: + +```console +/keys/degiro -u USERNAME -p PASSWORD +``` + +Instructions for setting up 2FA authorization are [here](https://github.com/Chavithra/degiro-connector#35-how-to-use-2fa-). + +
+ +### EODHD + +> Historical End of Day, Intraday, and Live prices API, with Fundamental Financial data API for more than 120000 stocks, ETFs and funds all over the world. + +
+Instructions + +Go to: https://eodhistoricaldata.com/r/?ref=869U7F4J + +![EODHD](https://user-images.githubusercontent.com/46355364/207849214-23763c95-7314-42ae-b97d-cb5810686498.png) + +Clicking on, "Registration", opens the page: + +![EODHD](https://user-images.githubusercontent.com/46355364/207849324-00d4a916-8260-45c0-9714-289e0a0574c0.png) + +Once registered, the API Key will be next to "API TOKEN". + +![EODHD](https://user-images.githubusercontent.com/46355364/207849462-37471270-929a-45c5-a164-a84249b19231.png) + +Enter this string into the OpenBB Terminal by typing: + +```console +/keys/eodhd REPLACE_WITH_KEY +``` + +
+ +### Finnhub + +> With the sole mission of democratizing financial data, we are proud to offer a FREE realtime API for stocks, forex and cryptocurrency. + +
+Instructions + +Go to: https://finnhub.io/ + +![Finnhub](https://user-images.githubusercontent.com/46355364/207832028-283c3321-8c05-4ee8-b4d2-41cdc940f408.png) + +Click on, "Get free api key", to open the page: + +![Finnhub](https://user-images.githubusercontent.com/46355364/207832185-f4c8406a-3b75-4acc-b3e8-3c4b3272d4da.png) + +Once the account has been created, find the API key in the account dashboard. + +![Finnhub](https://user-images.githubusercontent.com/46355364/207832601-62007d95-410c-4d03-a5a3-b177d1894a4c.png) + +Add this key to the OpenBB Terminal by entering: + +```console +/keys/finnhub REPLACE_WITH_KEY +``` + +
+ +### Financial Modeling Prep + +> Enhance your application with our data that goes up to 30 years back in history. Earnings calendar, financial statements, multiple exchanges and more! + +
+Instructions + +Go to: https://site.financialmodelingprep.com/developer/docs + +![FinancialModelingPrep](https://user-images.githubusercontent.com/46355364/207821920-64553d05-d461-4984-b0fe-be0368c71186.png) + +Click on, "Get my API KEY here", and sign up for a free account. + +![FinancialModelingPrep](https://user-images.githubusercontent.com/46355364/207822184-a723092e-ef42-4f87-8c55-db150f09741b.png) + +With an account created, sign in and navigate to the Dashboard, which shows the assigned token. by pressing the "Dashboard" button which will show the API key. + +![FinancialModelingPrep](https://user-images.githubusercontent.com/46355364/207823170-dd8191db-e125-44e5-b4f3-2df0e115c91d.png) + +Enter the key into the OpenBB Terminal with: + +```console +/keys/fmp REPLACE_WITH_KEY +``` + +
+ +### FRED + +> FRED is the trusted source for economic data since 1991. Download, graph, and track 819,000 US and international time series from 110 sources. + +
+Instructions + +Go to: https://fred.stlouisfed.org + +![FRED](https://user-images.githubusercontent.com/46355364/207827137-d143ba4c-72cb-467d-a7f4-5cc27c597aec.png) + +Click on, "My Account", create a new account or sign in with Google: + +![FRED](https://user-images.githubusercontent.com/46355364/207827011-65cdd501-27e3-436f-bd9d-b0d8381d46a7.png) + +After completing the sign-up, go to "My Account", and select "API Keys". Then, click on, "Request API Key". + +![FRED](https://user-images.githubusercontent.com/46355364/207827577-c869f989-4ef4-4949-ab57-6f3931f2ae9d.png) + +Fill in the box for information about the use-case for FRED, and by clicking, "Request API key", at the bottom of the page, the API key will be issued. + +![FRED](https://user-images.githubusercontent.com/46355364/207828032-0a32d3b8-1378-4db2-9064-aa1eb2111632.png) + +Enter the API key into the OpenBB Terminal with: + +```console +/keys/fred REPLACE_WITH_KEY +``` + +
+ +### GitHub + +> GitHub is where over 100 million developers shape the future of software. + +
+Instructions + +Go to: https://github.com + +![GitHub](https://user-images.githubusercontent.com/46355364/207846953-7feae777-3c3b-4f21-9dcf-84817c732618.png) + +Sign up for, or sign in to, GitHub. Once logged in, navigate to the [apps](https://github.com/settings/apps) page, under account settings. + +![GitHub](https://user-images.githubusercontent.com/46355364/207847215-3c04003f-26ea-4e62-9c13-ea35176bb5e3.png) + +Select, "New GitHub App": + +![GitHub](https://user-images.githubusercontent.com/46355364/207847383-d24416c6-18be-43f2-ae7c-455e8372a6ed.png) + +After creating the app, the key will be issued. Enter this token into the OpenBB Terminal with: + +```console +/keys/github REPLACE_WITH_KEY +``` + +
+ +### Glassnode + +> Glassnode makes blockchain data accessible for everyone. We source and carefully dissect on-chain data, to deliver contextualized and actionable insights. + +
+Instructions + +Go to: https://studio.glassnode.com + +![Glassnode](https://user-images.githubusercontent.com/46355364/207843761-799078ff-fa64-4d39-a6eb-ba01d250be69.png) + +Click on, "Sign up", and create an account: + +![Glassnode](https://user-images.githubusercontent.com/46355364/207843795-dd2cdbdb-45eb-4c7d-b967-ae9857d4ea5d.png) + +After creating an account, navigate to the [account settings](https://studio.glassnode.com/settings/api) and generate an API Key. + +![Glassnode](https://user-images.githubusercontent.com/46355364/207843950-5f33f37d-0203-4302-a67f-198808f18e06.png) + +Enter this key in the OpenBB terminal with: + +```console +/keys/glassnode REPLACE_WITH_KEY +``` + +
+ +### Intrinio + +> Intrinio is more than a financial data API provider – we're a real time data partner. That means we're your guide to every step of the financial data. + +
+Instructions + +Go to: https://intrinio.com/starter-plan + +![Intrinio](https://user-images.githubusercontent.com/85772166/219207556-fcfee614-59f1-46ae-bff4-c63dd2f6991d.png) + +An API key will be issued with a subscription. Find the token value within the account dashboard, and enter it into the OpenBB Terminal with: + +```console +/keys/intrinio REPLACE_WITH_KEY +``` + +
+ +### Messari + +> Gain an edge over the crypto market with professional grade data, tools, and research. + +
+Instructions + +Go to: https://messari.io + +![Messari](https://user-images.githubusercontent.com/46355364/207848122-ec6a41e4-76b7-4620-adc3-1f1c19f4bca6.png) + +Click on, "Sign up", and create an account. + +![Messari](https://user-images.githubusercontent.com/46355364/207848160-6a962e3c-3007-40a3-9431-cd5ddfe5bb8e.png) + +After creating the account, navigate to the [account page](https://messari.io/account/api), and click on the tab for, API Access. + +![Messari](https://user-images.githubusercontent.com/46355364/207848324-ade5bede-8e6b-4b87-bdec-eade3217c0d8.png) + +Copy the API key and add it to the OpenBB Terminal by entering: + +```console +/keys/messari REPLACE_WITH_KEY +``` + +
+ +### News API + +> News API is a simple, easy-to-use REST API that returns JSON search results for current and historic news articles published by over 80,000 worldwide sources. + +
+Instructions + +Go to: https://newsapi.org + +![News API](https://user-images.githubusercontent.com/46355364/207828250-0c5bc38c-90b4-427d-a611-b43c98c8e7ab.png) + +Click on, "Get API Key", and fill out the form. + +![News API](https://user-images.githubusercontent.com/46355364/207828421-76922bc2-cde0-493f-9eed-7f90eb831779.png) + +Register for an account and the next screen will provide the API Key. + +![News API](https://user-images.githubusercontent.com/46355364/207828736-f0fce53b-f302-4456-adf9-8d50ac41fbe2.png) + +Add this API key into the OpenBB Terminal by entering: + +```console +/keys/news REPLACE_WITH_KEY +``` + +
+ +### Oanda + +> OANDA's Currency Converter allows you to check the latest foreign exchange average bid/ask rates and convert all major world currencies. + +
+Instructions + +Go to: https://developer.oanda.com + +![Oanda](https://user-images.githubusercontent.com/46355364/207839324-d30aa2b6-be83-41ff-9b1b-146cac566789.png) + +After creating an account, follow the steps below. + +![Oanda](https://user-images.githubusercontent.com/46355364/207839246-eb40f093-b583-4edd-b178-99fe399bfb66.png) + +Upon completion of the account setup, enter the credentials into the OpenBB Terminal using the syntax: + +```console +/keys/oanda -a REPLACE_WITH_ACCOUNT -t REPLACE_WITH_TOKEN --account_type REPLACE_WITH_LIVE_OR_PRACTICE +``` + +
+ + +### OpenAI + +> An API for accessing new AI models developed by OpenAI. + +
+Instructions + +Go to: https://openai.com/blog/openai-api + +![OpenAI](https://github.com/OpenBB-finance/OpenBBTerminal/assets/105685594/2b2b5f7c-745a-40d7-bd19-05ed3021f9da) + +Click sign up and create an account. Once done, you will be logged into the home page: +![OpenAI](https://github.com/OpenBB-finance/OpenBBTerminal/assets/105685594/34976dce-bdf0-48cd-a9db-9e41eacdbc04) + + +Click the top right "Personal" button to find the following drop down: +![OpenAI](https://github.com/OpenBB-finance/OpenBBTerminal/assets/105685594/95987173-3884-462e-a03b-dff040f0acb4) + + +Click `View API Keys`. This will take you to the api Keys menu. Then click `Create new secret key`: +![OpenAI](https://github.com/OpenBB-finance/OpenBBTerminal/assets/105685594/210fa55b-8a33-4647-bdd4-28a478b02ba8) + +Then enter the Secret key credentials into the OpenBB Terminal using the syntax: + +```console +/keys/openai -k +``` + +
+ + + + +### Polygon + +> Live & historical data for US stocks for all 19 exchanges. Instant access to real-time and historical stock market data. + +
+Instructions + +Go to: https://polygon.io + +![Polygon](https://user-images.githubusercontent.com/46355364/207825623-fcd7f0a3-131a-4294-808c-754c13e38e2a.png) + +Click on, "Get your Free API Key". + +![Polygon](https://user-images.githubusercontent.com/46355364/207825952-ca5540ec-6ed2-4cef-a0ed-bb50b813932c.png) + +After signing up, the API Key is found at the bottom of the account dashboard page. + +![Polygon](https://user-images.githubusercontent.com/46355364/207826258-b1f318fa-fd9c-41d9-bf5c-fe16722e6601.png) + +Enter the key into the OpenBB Terminal by typing: + +```console +/keys/polygon REPLACE_WITH_KEY +``` + +
+ +### Quandl + +> The premier source for financial, economic, and alternative datasets, serving investment professionals. Quandl’s platform is used by over 400,000 people, including analysts from the world’s top hedge funds, asset managers and investment banks. + +
+Instructions + +Go to: https://www.quandl.com + +![Quandl](https://user-images.githubusercontent.com/46355364/207823899-208a3952-f557-4b73-aee6-64ac00faedb7.png) + +Click on, "Sign Up", and register a new account. + +![Quandl](https://user-images.githubusercontent.com/46355364/207824214-4b6b2b74-e709-4ed4-adf2-14803e6f3568.png) + +Follow the sign-up instructions, and upon completion the API key will be assigned. + +![Quandl](https://user-images.githubusercontent.com/46355364/207824664-3c82befb-9c69-42df-8a82-510d85c19a97.png) + +Enter the key into the OpenBB Terminal with: + +```console +/keys/quandl REPLACE_WITH_KEY +``` + +
+ +### Reddit + +> Reddit is a network of communities where people can dive into their interests, hobbies and passions. + +
+Instructions + +Sign in to Reddit, and then go to: https://old.reddit.com/prefs/apps/ + +![Reddit](https://preview.redd.it/540vrn3k0cn91.png?width=986&format=png&auto=webp&v=enabled&s=88228cd0cf4415b3487b8d35e1097f0caa804e15) + +Scroll down and click on "create application", selecting "script". + +![Reddit](https://preview.redd.it/7je4ehqa1cn91.png?width=916&format=png&auto=webp&v=enabled&s=dbdf65ccc0820cfe28eff8e81cba056f4fd8263e) + +Once the application is created, you must register it [here](https://old.reddit.com/wiki/api) + +![Reddit](https://user-images.githubusercontent.com/46355364/207834105-665180be-c2b6-43c8-b1c9-477729905010.png) + +Click on, "Read the full API terms and sign up for usage", and fill out the form. + +![Reddit](https://user-images.githubusercontent.com/46355364/207834850-32a0d4c8-9990-4919-94e3-abad1487a3bd.png) + +After submitting the form, check for a confirmation email. The credentials will be displayed [here](https://old.reddit.com/prefs/apps/), enter them into the OpenBB Terminal in one line: + +```console +/keys/reddit -i REPLACE_WITH_CLIENT_ID -s REPLACE_WITH_CLIENT_SECRET -u REPLACE_WITH_REDDIT_USERNAME -p REPLACE_WITH_REDDIT_PASSWORD -a REPLACE_WITH_USER_AGENT +``` + +
+ +### Robinhood + +> Robinhood has commission-free investing, and tools to help shape your financial future. + +
+Instructions + +Go to: https://robinhood.com/us/en + +![Robinhood](https://user-images.githubusercontent.com/46355364/207838058-a2311632-6459-4cfd-bc0a-639ee3931574.png) + +After registering for an account, it can be added to the OpenBB Terminal with: + +```console +/keys/rb -u REPLACE_WITH_USERNAME -p REPLACE_WITH_PASSWORD +``` + +The first login will request 2FA authorization from the device connected to the account. + +
+ +### Santiment + +> We provide tools to help you analyze crypto markets and find data-driven opportunities to optimize your investing. + +
+Instructions + +Go to: https://app.santiment.net + +Click on, "Sign up", and register for an account. + +![Santiment](https://user-images.githubusercontent.com/46355364/207849732-4bae61de-2f62-4919-b85d-f418f1bbd0c4.png) + +Navigate to the [account dashboard](https://app.santiment.net/account#api-keys) and generate a key. + +![Santiment](https://user-images.githubusercontent.com/46355364/207849839-31d1d0a7-6936-4ebd-a7f8-1292f6317b07.png) + +Add it to the OpenBB Terminal by entering: + +```console +/keys/santiment REPLACE_WITH_KEY +``` + +
+ +### Stocksera + +> Empowering investors to take advantage of alternative data. We track trending tickers on social media and provide alternative data for easy due-diligence & analysis. + +
+Instructions + +Go to: https://stocksera.pythonanywhere.com + +![Stocksera](https://user-images.githubusercontent.com/46355364/207853896-ee233569-26bb-4244-b115-43ac8885757a.png) + +Click on, "Log in", and create an account. + +![Stocksera](https://user-images.githubusercontent.com/46355364/207853985-46a7a17f-b6b2-442b-886d-f68b3ba2ad5a.png) + +Once logged in, navigate to the "Developers" tab and copy the API key. + +![Stocksera](https://user-images.githubusercontent.com/46355364/207854224-e5ddace0-15d1-491c-b616-263cca0bef02.png) + +Add the key to the OpenBB Terminal by entering: + +```console +/keys/stocksera REPLACE_WITH_KEY +``` + +
+ +### Token Terminal + +> Token Terminal is a platform that aggregates financial data on the leading blockchains and decentralized applications. + +
+Instructions + +Go to: https://tokenterminal.com + +![Token Terminal](https://user-images.githubusercontent.com/46355364/207850735-69368b4f-6a3e-46b8-ba69-3b79d9231f15.png) + +Click on, "Log in" and sign up for an account. + +![Token Terminal](https://user-images.githubusercontent.com/46355364/207850774-2071df78-3289-4c8e-9d64-156b9ec8ad81.png) + +Verify the email address, and then navigate go to the "API" tab and copy the API key to the clipboard. + +![Token Terminal](https://user-images.githubusercontent.com/46355364/207851035-71ea3eff-a11f-4835-8592-c07b3aa3f800.png) + +Add the key to the OpenBB Terminal by typing: + +```console +/keys/tokenterminal REPLACE_WITH_KEY +``` + +
+ +### Tradier + +> Tradier, the home of active traders. Our open collaboration platform allows investors to truly customize their trading experience like never before. + +
+Instructions + +Go to: https://documentation.tradier.com + +![Tradier](https://user-images.githubusercontent.com/46355364/207829178-a8bba770-f2ea-4480-b28e-efd81cf30980.png) + +Click on, "Open Account", to start the sign-up process. After the account has been setup, navigate to [Tradier Broker Dash](https://dash.tradier.com/login?redirect=settings.api) and create the application. Request a sandbox access token, and enter this key into the OpenBB Terminal with: + +```console +/keys/tradier REPLACE_WITH_KEY +``` + +
+ +### Twitter + +> From breaking news and entertainment to sports and politics, get the full story with all the live commentary. + +
+Upcoming changes to the Twitter API will deprecate the current functionality, it is uncertain if the current features will continue to work. + +![Twitter API](https://pbs.twimg.com/media/FooIJF3agAIU8SN?format=png&name=medium) + +
+ +### Ultima Insights + +> Ultima Insights offers tools such as the SEC Filing Analyst, Company news monitoring, Industry event watch, and Earnings Call Roundup for comprehensive investment monitoring. It incorporates daily Wall Street-level Qualitative analysis into OpenBB to keep users updated. The News curation system, powered by GPT + LLMs technology, presents relevant news to investors, often before it appears on platforms like Bloomberg. Ultima aims to provide timely and significant information for its users. + +
+Instructions + +Go to: https://ultimainsights.ai/openbb + +![Ultima Insights](https://user-images.githubusercontent.com/1911913/229215125-e3419788-eef3-4389-a3bd-5c08f3333347.png) + +Click on the "Get started" button for Ultima Pro or "Just Want the API Key" to get an Ultima API key for yout OpenBB account. Once you sign-up and confirm you want to start a trial with Ultima, Copy the API key to your clipboard and enter this key into the OpenBB Terminal with: + +```console +/keys/ultima REPLACE_WITH_KEY +``` + +
+ +### Whale Alert + +> Whale Alert continuously collects and analyzes billions of blockchain transactions and related-off chain data from hundreds of reliable sources and converts it into an easy to use standardized format. Our world-class analytics and custom high speed database solutions process transactions the moment they are made, resulting in the largest and most up-to-date blockchain dataset in the world. + +
+Instructions + +Go to: https://docs.whale-alert.io + +![Whale Alert](https://user-images.githubusercontent.com/46355364/207842892-3f71ee7a-6cd3-48a2-82e4-fa5ec5b13807.png) + +Click on, "sign up here". + +![Whale Alert](https://user-images.githubusercontent.com/46355364/207842992-427f1d2c-b34e-41c9-85fd-18511805fd16.png) + +After creating the account, click on, "Create", to issue the API Key. + +![Whale Alert](https://user-images.githubusercontent.com/46355364/207843214-20232465-9a52-4b66-b01a-0b8cecbdd612.png) + +Enter the key into the OpenBB Terminal by typing: + +```console +/keys/walert REPLACE_WITH_KEY +``` + +
diff --git a/website/content/terminal/usage/data/custom-data.md b/website/content/terminal/usage/data/custom-data.md new file mode 100644 index 000000000000..c92d55bc8aaf --- /dev/null +++ b/website/content/terminal/usage/data/custom-data.md @@ -0,0 +1,68 @@ +--- +title: Custom Data +sidebar_position: 3 +description: Documentation detailing usage of the OpenBB Terminal for financial data + aggregation, standardization, and user data import. It explains the OpenBBUserData + folder functions, how to modify settings, and how to import or export user data. +keywords: +- financial data +- data aggregation +- data standardization +- OpenBBUserData folder +- import data +- export data +- Econometrics +- Portfolio +- Portfolio Optimization +- settings menu +- export folder location +- userdata command +- user-created files +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +The OpenBB Terminal not only allows access to a world of financial data through our data aggregation and standardization. We also allow users to bring their own data to the terminal and export data. + +## The OpenBBUserData Folder + +The `OpenBBUserData` folder's default location is the home of the system user account. By default this will be the following paths: +- macOS: `Macintosh HD/Users//OpenBBUserData` +- Windows: `C:/Users//OpenBBUserData` + +Within the folder you can find files that you have exported as well as files that you wish to import directly into the OpenBB Terminal. For example, this could be an orderbook which you can store in `OpenBBUserData/portfolio/holdings`. + +![OpenBBUserData Folder](https://user-images.githubusercontent.com/85772166/195742985-19f0e420-d8f7-4fea-a145-a0243b8f2ddc.png) + +This folder contains all things user-created. For example: + +- Screener presets +- Portfolio files +- Exported files +- Files to be imported by various functions +- Styles and themes +- Preferred data sources + +**Note:** With a WSL-enabled Windows installation, this folder will be under the Linux partition + +### Update export folder location + +The location of this folder can be set by the user from the `/settings` menu. There should be no need to update paths in this menu unless the folders have been moved manually. If the location of the OpenBBUserData folder must be changed, it is best to move the entire existing folder to the new path. The path is then changed under the settings menu with: + +```console +(🦋) /settings/ $ userdata --folder "/complete_path_to/OpenBBUserData" +``` + +## Import data + +Menus, such as [Econometrics](/terminal/data-available/econometrics) or [Portfolio](/terminal/data-available/portfolio), allow the user to import their own dataset. Files available to import will be included with the selections made available by auto-complete. In the Econometrics menu, this is activated after pressing the space bar with `load -f ` + +![Importing Data](https://user-images.githubusercontent.com/85772166/204921760-38742f6c-ec78-4009-9c23-54dcb0504524.png) + +- The Econometrics `/econometrics` menu looks into the `exports` and `custom_imports/econometrics` folder. +- The Portfolio `/portfolio` menu looks into the `portfolio/holdings` folder +- The Portfolio Optimization `/portfolio/po` menu looks into the `portfolio/allocation` folder for the `load` command; and into the `portfolio/optimization` folder for the `file` command. + +Please make sure to read the relevant guides to understand how this works. diff --git a/website/content/terminal/usage/data/data-sources.md b/website/content/terminal/usage/data/data-sources.md new file mode 100644 index 000000000000..b9c12284959c --- /dev/null +++ b/website/content/terminal/usage/data/data-sources.md @@ -0,0 +1,121 @@ +--- +title: Data sources +sidebar_position: 1 +description: This page provides useful information on dealing with different data + vendors when using OpenBB's Terminal. It outlines how to select a default data source, + acquire API keys, and switch the data vendor using specific commands, all in an + effort to streamline and improve the user's experience. +keywords: +- Terminal +- data vendors +- API keys +- data sources +- FinancialModelingPrep +- Polygon +- AlphaVantage +- EODHD +- YahooFinance +- source +- stocks/fa/income +- changing data source +- Default data source +- /sources +- get --cmd +- set --cmd +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import TutorialVideo from '@site/src/components/General/TutorialVideo.tsx'; + + + +## Relationship with data vendors + +Most commands will require obtaining API keys from various data providers. OpenBB provides methods for consuming these data feeds, but has no control over the quality or quantity of data provided to an end-user. **No API Keys are required to get started using the Terminal**. + +See the list of data providers [here](/terminal/usage/data/api-keys), along with instructions for entering the credentials into the OpenBB Terminal. You can also request a new data source through this [form](https://openbb.co/request-a-feature). + +:::note +OpenBB doesn't store any financial data in its servers. We aggregate access to multiple data sources through API calls and standardize that interaction to provide users a seamless experience when dealing with different data vendors +::: + +## Changing data source in command + +Many commands have multiple datasources attached to it. A great example is `/stocka/fa/income` that allows you to select FinancialModelingPrep, Polygon, AlphaVantage, EODHD or YahooFinance. In order to specify the data vendor you want to utilize for that specific command you can utilize the argument `--source`. + +This also becomes clear from the help menu. + +``` +(🦋) /stocks/fa/ $ income -h + +usage: income [-t TICKER] [-q] [-r] [-p column] [-h] [--export EXPORT] [--sheet-name SHEET_NAME [SHEET_NAME ...]] [-l LIMIT] [--source {FinancialModelingPrep,Polygon,AlphaVantage,EODHD,YahooFinance}] + +Prints a complete income statement over time. This can be either quarterly or annually. + +optional arguments: + -t TICKER, --ticker TICKER + Ticker to analyze (default: None) + -q, --quarter Quarter fundamental data flag. (default: False) + -r, --ratios Shows percentage change of values. (default: False) + -p column, --plot column + Rows to plot, comma separated. (-1 represents invalid data) (default: None) + -h, --help show this help message (default: False) + --export EXPORT Export raw data into csv, json, xlsx (default: ) + --sheet-name SHEET_NAME [SHEET_NAME ...] + Name of excel sheet to save data to. Only valid for .xlsx files. (default: None) + -l LIMIT, --limit LIMIT + Number of entries to show in data. (default: 5) + --source {FinancialModelingPrep,Polygon,AlphaVantage,EODHD,YahooFinance} + Data source to select from (default: FinancialModelingPrep) + +For more information and examples, use 'about income' to access the related guide. +``` + +Within the source arguments it shows the exact sources as previously mentioned. Therefore, with this information in hand it is possible to switch to a different source e.g. with `income --source Polygon`. Do keep in mind that you might need to have an API key to use this source, see [here](/terminal/usage/data/api-keys). + +![Selecting a new Data Source](https://user-images.githubusercontent.com/85772166/233730763-54fd6400-f3ad-44a0-9c73-254d91ac2085.png) + +The available sources for each command are displayed on the right of the command, and they can be distinguished by the square brackets and distinct font color group. By default, if the user doesn't specify `--source` the terminal will use the first data provider displayed. + + +### Setting default source through Hub (easy) + +The default data vendor can be selected with more ease through the OpenBB Hub. Instructions can be found here. + + +### Setting default source through Terminal + +The default data source for each command (where multiple sources are available) can be defined within the [`/sources`](/terminal/usage/data/data-sources) menu. + +For example, if you would like to change the default data provider for the `income` command from the `stocks/fa` menu you can first run the command `get --cmd stocks/fa/income`. This returns the following: + +```console +(🦋) /sources/ $ get --cmd stocks/fa/income + +Default : FinancialModelingPrep +Available : FinancialModelingPrep, Polygon, AlphaVantage, EODHD, YahooFinance +``` + +Then, with `set` command you can change the default data provider. For example, we can change the data provider to `Polygon` with +the following: + +```console +(🦋) /sources/ $ set --cmd stocks/fa/income --source Polygon + +Default data source for 'stocks/fa/income' set to 'Polygon'. +``` + +and we can use `get` once more to confirm this update: + +```console +(🦋) /sources/ $ get --cmd stocks/fa/income + +Default : Polygon +Available : Polygon, FinancialModelingPrep, AlphaVantage, EODHD, YahooFinance +``` diff --git a/website/versioned_docs/version-v3/terminal/usage/guides/hub.md b/website/content/terminal/usage/hub.md similarity index 95% rename from website/versioned_docs/version-v3/terminal/usage/guides/hub.md rename to website/content/terminal/usage/hub.md index 6b1fe26dc7ee..00ef15c102ab 100644 --- a/website/versioned_docs/version-v3/terminal/usage/guides/hub.md +++ b/website/content/terminal/usage/hub.md @@ -1,31 +1,25 @@ --- title: Hub Synchronization sidebar_position: 6 -description: Walk-through of integrating the OpenBB Terminal with the OpenBB Hub +description: This is a documentation page for OpenBB focusing on the integration of + OpenBB Terminal with OpenBB Hub. Topics covered include registration, login, managing + API keys, default data sources, theme styles, script routines, and personal access + tokens. keywords: - [ - api, - keys, - api keys, - data provider, - data, - free, - openbb_terminal, - openbbterminal, - openbb_hub, - hub, - routines, - synchronization, - sync, - hub sync, - hub synchronization, - hub sync, - ] +- OpenBB Terminal guide +- OpenBB Hub integration +- Registration process +- Login process +- API Keys management +- Default Data Sources +- Theme Styles +- Script Routines +- Personal Access Tokens --- import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; - + This guide will walk you through the process of integrating the OpenBB Terminal with the OpenBB Hub to achieve optimal performance. diff --git a/website/content/terminal/usage/keyboard-hotkey-macros.md b/website/content/terminal/usage/keyboard-hotkey-macros.md new file mode 100644 index 000000000000..0a42dd4bac45 --- /dev/null +++ b/website/content/terminal/usage/keyboard-hotkey-macros.md @@ -0,0 +1,72 @@ +--- +title: Keyboard Hotkey Macros +sidebar_position: 7 +description: Learn how to set hotkeys macros on a customizable keyboard for swift + and efficient investment research. Learn how to remap keys, assigning them custom + macro commands, shortcuts, or key combinations using the VIA configurator for an + enhanced experience, especially for OpenBB power users. +keywords: +- customizable keyboard +- hotkeys macros +- investment research +- VIA configurator +- Keychron +- OpenBB power users +- command pipeline +- remap keys +- macro commands +- shortcuts +- key combinations +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import TutorialVideo from '@site/src/components/General/TutorialVideo.tsx'; + + + +This document will explain how you can set hotkeys macros on your customizable keyboard which allow you to perform investment research in a few seconds. + +## Supported Configurators + +### VIA + +This document will explain how you can set hotkeys on your customizable keyboard using [VIA](https://www.caniusevia.com/). + +Here is a list of VIA's supported keyboards: [https://www.caniusevia.com/docs/supported_keyboards](https://www.caniusevia.com/docs/supported_keyboards) + +Note: We were in the market looking for a keyboard that could be highliy customizable for the needs of OpenBB power users. This is when we stumbled upon Keychron and the VIA configurator which allows users to intuitively remap any key on the keyboard, and create numerous macro commands, shortcuts, or key combinations. +Here's a post from Keychron on VIA: [Why VIA is one of the most essential features for a custom keyboard?](https://www.keychron.com/blogs/news/why-qmk-via-is-one-of-the-most-essential-features-for-a-custom-keyboard) + +For the purpose of this example, the command pipeline we are creating has the following sequence of commands: `dps/psi/../fa/pt/income/..` + +1. Try VIA [here](https://usevia.app/). The following screen should popup + +![VIA](https://user-images.githubusercontent.com/25267873/236660856-f92ac602-cde9-48e6-8029-c083fbb75ff9.png) + +2. Select the Layer you are interested in altering. As we're not looking forward to remap any of the existing main keys, we need to go to layer 2, 3 or 4. In my case, with a Keychron Q2, I know that Layer 4 can be accessed by pressing on "Fn2". Thus, I select that layer. + +![Layer](https://user-images.githubusercontent.com/25267873/236660841-09203874-8a8e-4393-8674-357aad67a22b.png) + +3. Most keys should have a triangle upside down which simbolizes that they don't have any functionality. You want to select one of those keys to contain your hotkey routine. After that selection you want to remap the key functionality, hence in the **KEYMAP settings** below you click on MACROS tab and select "MO". Now the screen should look like this: + +![Layer](https://user-images.githubusercontent.com/25267873/236660948-a148582e-f928-4f12-ae54-9bdd3adfd020.png) + +4. Now we want to change what "MO" does and for that we select the **MACROS settings** below. Then we can select "M0" and insert `dps/psi/../fa/pt/income/..{KC_ENT}`. The screen should look like this: + +![Macro](https://user-images.githubusercontent.com/25267873/236661126-eeb5dc7c-2c01-4a43-ab64-12c470e864ce.png) + +Note that the `{KC_ENT}` will ensure that the command is run on the terminal. + +5. Save. To ensure that everything is correct you can go into the **KEYMAP settings** and click on the hotkey that you just created to see if it contains the sequence of commands, the following sequence should appear: + +![Save](https://user-images.githubusercontent.com/25267873/236661232-4f9119de-af37-49a2-948d-cfd6d650ed92.png) + +6. Finally, we are ready to test it on the [OpenBB Terminal](https://my.openbb.co/app/terminal). After going into `stocks` and doing `load AAPL`, I pressed "Fn2+Z" which lead to: + +![Test](https://user-images.githubusercontent.com/25267873/236660272-290fe586-7663-4cd6-bfc0-80b7f8f2efd1.png) diff --git a/website/content/terminal/usage/outputs/_category_.json b/website/content/terminal/usage/outputs/_category_.json new file mode 100644 index 000000000000..8a6d966dbaa5 --- /dev/null +++ b/website/content/terminal/usage/outputs/_category_.json @@ -0,0 +1,4 @@ +{ + "label": "Output", + "position": 3 +} diff --git a/website/content/terminal/usage/outputs/export-data.md b/website/content/terminal/usage/outputs/export-data.md new file mode 100644 index 000000000000..bb625928f40a --- /dev/null +++ b/website/content/terminal/usage/outputs/export-data.md @@ -0,0 +1,75 @@ +--- +title: Export data +sidebar_position: 3 +description: Learn how to export financial data through the OpenBB Terminal in different + formats like XLSX, CSV, JSON, PNG, JPG, PDF, and SVG. Also learn to specify filename, + sheet name, and export directly into a chart. +keywords: +- financial data export +- XLSX +- CSV +- JSON +- PNG +- JPG +- PDF +- SVG +- filename specification +- sheet name specification +- export to chart +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +The OpenBB Terminal offers a variety of ways to export financial data. This can be through XLSX, CSV or JSON but also through PNG, JPG, PDF and SVG giving plenty of flexibility to export the data the way you desire. + +This can be demonstrated with the `--export` argument, e.g. if you wish to export to `xlsx` you would add `--export xlsx`. + +For example, if you wish to download market data you can do so from the stocks menu with the following: + +```console +(🦋) /stocks/ $ load AAPL -s 2010-01-01 --export xlsx +``` + +This results in the following: + +![Export Example](https://user-images.githubusercontent.com/46355364/214817681-fd5324c3-003c-45eb-adf4-96d5b41a3c02.png) + +## Specifying filename + +We also allow you to define a file name, for example for the same stock tickers, we can also add in the filename. This time, we export to `csv`. + +```console +(🦋) /stocks/ $ load AAPL -s 2010-01-01 --export apple.csv +``` + +Which results in the following: + +![Filename Example](https://user-images.githubusercontent.com/46355364/214818131-597b3bd0-9c66-43f1-bf0e-2c0a703e2645.png) + +## Specifying sheet name when XLSX + +When you select the `xlsx` option, you can also specify the sheet name with `--sheet-name` which allows multiple datasets to be grouped to the same Excel file. Using the same stock ticker, we can define the following. First, get market data from the `stocks` menu: + +```console +(🦋) /stocks/ $ load AAPL -s 2010-01-01 --export apple.xlsx --sheet-name Market Data +``` + +Then enter the `fa` (Fundamental Analysis) menu and copy and paste the code below. This requires an API key from FinancialModelingPrep which you can obtain for free. Please have a look [here](/terminal/usage/data/api-keys). + +```console +(🦋) /stocks/fa/ $ income --source FinancialModelingPrep -l 10 --export apple.xlsx --sheet-name Income Statement +(🦋) /stocks/fa/ $ balance --source FinancialModelingPrep -l 10 --export apple.xlsx --sheet-name Balance Sheet +(🦋) /stocks/fa/ $ cash --source FinancialModelingPrep -l 10 --export apple.xlsx --sheet-name Cash Flow Statement +``` + +This generates a file for Apple with market data from 2010-01-01 until now and income, balance and cash flow statements over the last 10 years as seen in the image below. + +![Sheet Name Example](https://user-images.githubusercontent.com/46355364/214824561-6eaf3a88-746a-4abc-91e1-420c9036c00d.png) + +## Export directly into chart + +We allow exporting to images, this can be PNG, JPG, PDF and SVG. For example, using our `portfolio` menu we can export the charts to any type of format which again can be found within the `OpenBBUserData` folder. + +![image](https://user-images.githubusercontent.com/46355364/214819518-cec40468-9019-440c-8bfe-7bcabc207578.png) diff --git a/website/content/terminal/usage/outputs/interactive-charts.md b/website/content/terminal/usage/outputs/interactive-charts.md new file mode 100644 index 000000000000..08253332b23d --- /dev/null +++ b/website/content/terminal/usage/outputs/interactive-charts.md @@ -0,0 +1,107 @@ +--- +title: Interactive Charts +sidebar_position: 2 +description: Explore how to effectively utilize OpenBB's interactive charts backed + by open source PyWry technology. Understand various capabilities including annotation, + color modification, drawing tools, data export, and supplementary data overlay. +keywords: +- interactive charts +- PyWry technology +- chart annotation +- drawing tools +- data export +- data overlay +- editing chart title +- Toolbar +- Text Tools +- Draw Tools +- Export Tools +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import TutorialVideo from '@site/src/components/General/TutorialVideo.tsx'; + + + +A common type of output in OpenBB are interactive charts which open in a separated window (due to our [open source PyWry](https://github.com/OpenBB-finance/pywry) technology). The OpenBB charting library provides interactive and highly customizable charts. + +
+Charting cheat sheet + +![Group 653](https://user-images.githubusercontent.com/85772166/234313541-3d725e1c-ce48-4413-9267-b03571e0eccd.png) + +
+ +## Toolbar + +![Chart Tools](https://user-images.githubusercontent.com/85772166/233247997-55c03cbd-9ca9-4f5e-b3fb-3e5a9c63b6eb.png) + +The toolbar is located at the bottom of the window, and provides methods for: +- Panning and zooming. +- Modifying the title and axis labels. +- Adjusting the hover read out. +- Toggling light/dark mode. +- Annotating and drawing. +- Exporting raw data. +- Saving the chart as an image. +- Adding supplementary external data as an overlay. + +The label for each tool is displayed by holding the mouse over it. + +The toolbar's visibility can be toggled utilizing the `ctrl + h` shortcut. + +## Text Tools + +Annotate a chart by clicking on the `Add Text` button, or with the keyboard, `ctrl + t`. + +![Annotate Charts](https://user-images.githubusercontent.com/85772166/233248056-d459d7a0-ba2d-4533-896a-79406ded859e.png) + +Enter some text, make any adjustments to the options, then `submit`. Place the crosshairs over the desired data point and click to place the text. + +![Place Text](https://user-images.githubusercontent.com/85772166/233728645-74734241-4da2-4cff-af17-b68a62e95113.png) + +After placement, the text can be updated or deleted by clicking on it again. + +![Delete Annotation](https://user-images.githubusercontent.com/85772166/233728428-55d2a8e5-a68a-4cd1-9dbf-4c1cd697187e.png) + +## Change title + +The title of the chart is edited by clicking the button, `Change Titles`, near the middle center of the toolbar, immediately to the right of the `Add Text` button. + +## Draw Tools + +![Edit Colors](https://user-images.githubusercontent.com/85772166/233729318-8af947fa-ce2a-43e2-85ab-657e583ac8b1.png) + +The fourth group of icons on the toolbar are for drawing lines and shapes. +- Edit the colors. +- Draw a straight line. +- Draw a freeform line. +- Draw a circle. +- Draw a rectangle. +- Erase a shape. + +To draw on the chart, select one of the four drawing buttons and drag the mouse over the desired area. Click on any existing shape to modify it by dragging with the mouse and editing the color, or remove it by clicking the toolbar button, `Erase Active Shape`. The edit colors button will pop up as a floating icon, and clicking on that will display the color palette. + +## Export Tools + +The two buttons at the far-right of the toolbar are for saving the raw data or, to save an image file of the chart at the current panned and zoomed view. + +![Export Tools](https://user-images.githubusercontent.com/85772166/233248436-08a2a463-403b-4b1b-b7d8-80cd5af7bee3.png) + +## Overlay + +The button, `Overlay chart from CSV`, provides an easy import method for supplementing a chart with additional data. Clicking on the button opens a pop-up dialogue to select the file, column, and whether the overlay should be a bar, candlestick, or line chart. As a candlestick, the CSV file must contain OHLC data. The import window can also be opened with the keyboard, `ctrl-o`. + +![Overlay CSV](https://user-images.githubusercontent.com/85772166/233248522-16b539f4-b0ae-4c30-8c72-dfa59d0c0cfb.png) + +After choosing the file to overlay, select what to show and then click on `Submit`. + +![Overlay Options](https://user-images.githubusercontent.com/85772166/233250634-44864da0-0936-4d3c-8de2-c8374d26c1d2.png) + +![Overlay Chart](https://user-images.githubusercontent.com/85772166/233248639-6d12b16d-471f-4550-a8ab-8d8c18eeabb3.png) diff --git a/website/content/terminal/usage/outputs/interactive-tables.md b/website/content/terminal/usage/outputs/interactive-tables.md new file mode 100644 index 000000000000..28b0c1bfbacd --- /dev/null +++ b/website/content/terminal/usage/outputs/interactive-tables.md @@ -0,0 +1,80 @@ +--- +title: Interactive Tables +sidebar_position: 1 +description: Learn how to navigate and utilize OpenBB's interactive tables using our + open source PyWry technology. Understand how to sort and filter columns, hide or + remove columns, select number of rows per page, freeze index and column headers, + and export the data. +keywords: +- interactive tables +- PyWry technology +- sorting columns +- filtering columns +- hiding columns +- rows per page +- freeze index +- freeze column headers +- exporting data +- data visualization +- customizing tables +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import TutorialVideo from '@site/src/components/General/TutorialVideo.tsx'; + + + +A common type of output in OpenBB are interactive tables which open in a separated window (due to our [open source PyWry](https://github.com/OpenBB-finance/pywry) technology). These provide methods for searching, sorting, filtering, exporting and even adapting settings directly on the table. + +
+Table cheat sheet + +![Chart Intro (5)](https://user-images.githubusercontent.com/85772166/234315026-de098953-111b-4b69-9124-31530c01407a.png) + +
+ +## Sorting + +Columns can be sorted ascending/descending/unsorted, by clicking the controls to the right of each header title. The status of the filtering is shown as a blue indicator. + +![Sort Columns](https://user-images.githubusercontent.com/85772166/233248754-20c18390-a7af-490c-9571-876447b1b0ae.png) + +## Filtering + +The settings button, at the lower-left corner, displays choices for customizing the table. By selecting the `Type` to be `Advanced`, columns become filterable. + +![Table Settings](https://user-images.githubusercontent.com/85772166/233248876-0d788ff4-974d-4d92-8186-56864469870a.png) + +The columns can be filtered with min/max values or by letters, depending on the content of each column. + +![Filtered Tables](https://user-images.githubusercontent.com/85772166/233248923-45873bf1-de6b-40f8-a4aa-05e7c3d21ab0.png) + +## Hiding columns + +The table will scroll to the right as far as there are columns. Columns can be removed from the table by clicking the icon to the right of the settings button and unchecking it from the list. + +![Select Columns](https://user-images.githubusercontent.com/85772166/233248976-849791a6-c126-437c-bb54-454ba6ea4fa2.png) + +## Select rows per page + +The number of rows per page is defined in the drop down selection near the center, at the bottom. + +![Rows per Page](https://user-images.githubusercontent.com/85772166/233249018-8269896d-72f7-4e72-a4d4-2715d1f11b96.png) + +## Freeze the Index and Column Headers + +Right-click on the index name to enable/disable freezing when scrolling to the right. Column headers are frozen by default. + +![Index Freeze](https://user-images.githubusercontent.com/85772166/234103702-0965dfbd-24ca-4a66-8c76-9fac28abcff8.png) + +## Exporting Data + +At the bottom-right corner of the table window, there is a button for exporting the data. To the left, the drop down selection for `Type` can be defined as a CSV, XLSX, or PNG file. Exporting the table as a PNG file will create a screenshot of the table at its current view, and data that is not visible will not be captured. + +![Export Data](https://user-images.githubusercontent.com/85772166/233249065-60728dd1-612e-4684-b196-892f3604c0f4.png) diff --git a/website/content/terminal/usage/overview/_category_.json b/website/content/terminal/usage/overview/_category_.json new file mode 100644 index 000000000000..d98d73979e26 --- /dev/null +++ b/website/content/terminal/usage/overview/_category_.json @@ -0,0 +1,4 @@ +{ + "label": "Overview", + "position": 1 +} diff --git a/website/content/terminal/usage/overview/commands-and-arguments.md b/website/content/terminal/usage/overview/commands-and-arguments.md new file mode 100644 index 000000000000..0a58498fb807 --- /dev/null +++ b/website/content/terminal/usage/overview/commands-and-arguments.md @@ -0,0 +1,162 @@ +--- +title: Commands and arguments +sidebar_position: 2 +description: This documentation page includes a tutorial video that provides a short + introduction on commands and arguments for the OpenBB Terminal. It further explains + the help dialogue for functions, the auto-completion feature, and global commands + such as help, about, support, cls, quit, exit, and reset. Also, tips for submitting + support requests are provided. +keywords: +- tutorial video +- help arguments +- auto-complete +- global commands +- support command +- reset command +- command line interface +- metadata +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import TutorialVideo from '@site/src/components/General/TutorialVideo.tsx'; + + + + +## Help arguments + +A help dialogue for any function at the current location is printed to the screen by typing `-h` or `--help` after the command. The information returned contains a short description of the function and all accepted arguments. For example the `news` command will return: + +```console +(🦋) / $ news -h + +usage: news [-t TERM [TERM ...]] [-s SOURCES] [-h] [--export EXPORT] [--sheet-name SHEET_NAME [SHEET_NAME ...]] [-l LIMIT] + +display news articles based on term and data sources + +options: + -t TERM [TERM ...], --term TERM [TERM ...] + search for a term on the news + -s SOURCES, --sources SOURCES + sources from where to get news from (separated by comma) + -h, --help show this help message + --export EXPORT Export raw data into csv, json, xlsx + --sheet-name SHEET_NAME [SHEET_NAME ...] + Name of excel sheet to save data to. Only valid for .xlsx files. + -l LIMIT, --limit LIMIT + Number of entries to show in data. + +For more information and examples, use 'about news' to access the related guide. +``` + +To search for news containing the term, "Federal Reserve", you can use this command: + +```console +(🦋) / $ news --term Federal Reserve +``` + + +## Auto-complete + +![Auto Complete](https://user-images.githubusercontent.com/85772166/233247702-f707531c-2c65-4380-a662-cd4bc2ae0199.png) + +The OpenBB Terminal is equipped with an auto completion engine that presents choices based on the current menu and command. Whenever you start typing, suggestion prompts will appear for existing commands and menus. When the command contains arguments, pressing the `space bar` after typing the command will present the list of available arguments. Note that a menu doesn't has arguments attached. + +This functionality dramatically reduces the number of key strokes required to perform tasks and, in many cases, eliminates the need to consult the help dialogue for reminders. Choices - where they are bound by a defined list - are searchable with the up and down arrow keys. + + +## Global commands + +These are commands that can be used throughout the terminal and will work regardless of the menu where they belong. + +### Help + +The `help` command shows the current menu you are in and all the commands and menus that exist, including a short description for each of these. + +This is arguably one of the most helpful commands that the terminal. If you are familiar to navigating in a command line interface, it's the equivalent to `ls -ll`. + +### About + +The `about` command opens the browser to the OpenBB documentation pages for the specific command or menu. Note that this will depend on where the user is located within the terminal. + +```console +(🦋) / $ about stocks +``` + +The command above will open a browser to [Introduction to the Stocks menu](/terminal/data-available/stocks). + + +### Support + +The `support` command allows to submit a new request for support, a general question, or a bug report. The command will pre-populate a form with key information, like the command or menu name specific to the issue. Use the up and down arrow keys to browse and select the appropriate item for the ticket. + +![Support](https://user-images.githubusercontent.com/85772166/233577183-fbeb7be2-1d00-4ca0-86b3-42f1b71081e8.png) + +Naturally, this command has a help dialogue. + +```console +(🦋) / $ support -h + +Submit your support request + +options: + -c {search,load,quote,tob,candle,news,resources,codes,ta,ba,qa,disc,dps,scr,sia,ins,gov,res,dd,fa,bt,ca,options,th,forecast}, --command {generic,search,load,quote,tob,candle,news,resources,codes,ta,ba,qa,disc,dps,scr,sia,ins,gov,res,dd,fa,bt,ca,options,th,forecast} + Command that needs support (default: None) + --msg MSG [MSG ...], -m MSG [MSG ...] + Message to send. Enclose it with double quotes (default: ) + --type {bug,suggestion,question,generic}, -t {bug,suggestion,question,generic} + Support ticket type (default: generic) + -h, --help show this help message (default: False) +``` + +An example of a valid support ticket could be: + +```console +/stocks/ $ support search --type question --msg "How do I find stocks from India with OpenBB?" +``` + +The command opens a browser window to a pre-populated form on the OpenBB website. If you are signed-in to the Hub, all that is left to do is click `Submit`. + +![Submit Form](https://user-images.githubusercontent.com/85772166/233577448-3e426a88-d0cf-4338-8f4c-21b9fd01d8b2.png) + +PS: The answer to this question is: + +```console +(🦋) /stocks/ $ search --country india --exchange-country india +``` + +:::note +Tips for submitting a support request: + +- Tell us what version number is installed. +- Tell us what operating system and version the machine has. +- What is the installation type? Installer, Source, PyPi, Docker, other? +- Tell us the command and parameter combination causing the error. +- Tell us what symbol (ticker) is, or was trying to be, loaded. +- Show us the complete error message. +- Let us know any contextual information that will help us replicate and accurately identify the problem. +::: + +### Cls + +The `cls` command clears the entire terminal screen. + +### Quit + +The `quit` command (can also use `q` or `..`) allows to leave the current menu to go one menu above. If the user is on the root, that will mean leaving the terminal. + +### Exit + +The `exit` command allows the user to exit the terminal. + +### Reset + +The `reset` command (or `r`) allows a developer that is using the terminal through source code to quickly test it's code changes by re-starting the terminal with the code changes. This allows to improve speed of development. + +For more information on contributing to the OpenBB Terminal read our [contribution guidelines](https://github.com/OpenBB-finance/OpenBBTerminal/blob/main/CONTRIBUTING.md). diff --git a/website/content/terminal/usage/overview/customizing-the-terminal.md b/website/content/terminal/usage/overview/customizing-the-terminal.md new file mode 100644 index 000000000000..a7a0b58d1a8b --- /dev/null +++ b/website/content/terminal/usage/overview/customizing-the-terminal.md @@ -0,0 +1,142 @@ +--- +title: Customization +sidebar_position: 4 +description: This documentation page details the functionality of the Settings Menu + and the Feature Flags Menu in the OpenBB Terminal. It instructs users how to customize + the Terminal, alter its behaviour, and manipulate various environment variables. +keywords: +- Settings Menu +- Feature Flags Menu +- customize Terminal +- alter Terminal behaviour +- environment variables +- Documentation +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + +The OpenBB Terminal contains two menus for altering the behaviour and presentation of the Terminal, Settings and Feature Flags, both of which are accessed from the main menu. + + + +## Settings Menu + +The `/settings` menu provides methods for customizing the look of the Terminal. + +| Setting | Description | +| :----------- | :--------------------------------------------------------------- | +| `chart` | Select the chart style. | +| `colors` | Sets the color scheme for Terminal fonts. | +| `dt` | Add or remove date and time from the Terminal command line. | +| `flair` | Sets the flair emoji to be used. | +| `height` | Set the default plot height. | +| `lang` | Select the language for the Terminal menus and commands. | +| `source` | Use an alternate data sources file. (Not recommended to change.) | +| `table` | Select the table style. | +| `tz` | Select a timezone. | +| `userdata` | Change the local path to the OpenBBUserData folder. | +| `width` | Set the default plot width. | + +### Style example + +Set charts and tables styles as light or dark mode. + +```console +(🦋) /settings/ $ table -s light +``` + +```console +(🦋) /settings/ $ chart -s dark +``` + +### Timezone example + +Set the local timezone for the Terminal + +```console +(🦋) /settings/ $ tz Africa/Johannesburg +``` + +## Feature Flags Menu + +The `/featflags` menu provides methods for altering the behaviour and responses with environment variables. These configurations are on/off, and the status is indicated by the red/green text of each. Each parameter is listed below. + +| Feature | Description | +| :----------- | :---------------------------------------------------------------------------------------------- | +| `cls` | Clear the screen after each command. Default state is off. | +| `exithelp` | Automatically print the screen after navigating back one menu. Default state is off. | +| `interactive` | Enable/disable interactive tables. Disabling prints the table directly on the Terminal screen. | +| `overwrite` | Automatically overwrite exported files with the same name. Default state is off. | +| `promptkit` | Enable auto complete and history. Default state is on. | +| `rcontext` | Remember loaded tickers while switching menus. Default state is on. | +| `retryload` | Retries misspelled commands with the load function first. Default state is off. | +| `reporthtml` | Generate reports as HTML files. Default state is on. | +| `richpanel` | Displays a border around menus. Default state is on. | +| `tbhint` | Display usage hints in the bottom toolbar. Default state is on. | +| `version` | Displays the currently installed version number in the bottom right corner. | + +### Interactive example + +When it is off, the Terminal displays all tables directly on the screen instead of opening a window. + +```console +(🦋) /stocks/ $ quote spy + + SPY Quote +┏━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━┓ +┃ Info ┃ Value ┃ +┡━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━┩ +│ Symbol │ SPY │ +├───────────────────────┼────────────────────────┤ +│ Name │ SPDR S&P 500 ETF Trust │ +├───────────────────────┼────────────────────────┤ +│ Price │ 412.43 │ +├───────────────────────┼────────────────────────┤ +│ Changes percentage │ 0.06 │ +├───────────────────────┼────────────────────────┤ +│ Change │ 0.23 │ +├───────────────────────┼────────────────────────┤ +│ Day low │ 410.60 │ +├───────────────────────┼────────────────────────┤ +│ Day high │ 413.06 │ +├───────────────────────┼────────────────────────┤ +│ Year high │ 431.73 │ +├───────────────────────┼────────────────────────┤ +│ Year low │ 348.11 │ +├───────────────────────┼────────────────────────┤ +│ Market cap │ 378.521 B │ +├───────────────────────┼────────────────────────┤ +│ Price avg50 │ 402.47 │ +├───────────────────────┼────────────────────────┤ +│ Price avg200 │ 394.88 │ +├───────────────────────┼────────────────────────┤ +│ Exchange │ AMEX │ +├───────────────────────┼────────────────────────┤ +│ Volume │ 44.621 M │ +├───────────────────────┼────────────────────────┤ +│ Avg volume │ 89774263 │ +├───────────────────────┼────────────────────────┤ +│ Open │ 411.99 │ +├───────────────────────┼────────────────────────┤ +│ Previous close │ 412.20 │ +├───────────────────────┼────────────────────────┤ +│ Eps │ 19.85 │ +├───────────────────────┼────────────────────────┤ +│ Pe │ 20.78 │ +├───────────────────────┼────────────────────────┤ +│ Earnings announcement │ 2017-11-29 17:00:00 │ +├───────────────────────┼────────────────────────┤ +│ Shares outstanding │ 917.782 M │ +├───────────────────────┼────────────────────────┤ +│ Timestamp │ 2023-04-24 12:34:22 │ +└───────────────────────┴────────────────────────┘ +``` + +### Overwrite example + +Enable this feature flag to remove the prompt when exporting a file with the same name. This will only overwrite an existing `XLSX` file if the `--sheet-name` is not defined. + +### Exit help example + +Enabling this prints the parent menu on the screen when going back from a sub-menu. diff --git a/website/content/terminal/usage/overview/structure-and-navigation.md b/website/content/terminal/usage/overview/structure-and-navigation.md new file mode 100644 index 000000000000..2ddf04d59af2 --- /dev/null +++ b/website/content/terminal/usage/overview/structure-and-navigation.md @@ -0,0 +1,50 @@ +--- +title: Structure and Navigation +sidebar_position: 1 +description: Learn about the OpenBB Terminal, an interactive Command Line Interface + application. Understand the structure and navigation of the terminal, functions + or commands input via a keyboard, and the presentation of results in the form of + interactive charts, tables, or text. Get introduced to terminal commands, terminal + menus, OpenBB Hub's theme style, and the concept of absolute paths. +keywords: +- CLI application +- terminal structure +- Terminal navigation +- Command Line Interface +- Interactive Charts and Tables +- Terminal commands +- terminal menus +- OpenBB Hub Theme Style +- Absolute paths +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +## Structure + +import TutorialVideo from '@site/src/components/General/TutorialVideo.tsx'; + + + +The OpenBB Terminal is a Command Line Interface (CLI) application. Functions (commands) are called through the keyboard with results returned as charts, tables, or text. Charts and tables (if enabled) are displayed in a new window, and are fully interactive, while text prints directly to the Terminal screen. + +![The Home Screen](https://user-images.githubusercontent.com/85772166/233247655-2f8d0dae-be68-48ca-9b35-123b5b985cb6.png) + +A menu is a collection of commands (and sub-menus). A menu can be distinguished from a command because the former has a `>` on the left. The color of a command and a menu also differ, but these can be changed in OpenBB Hub's theme style. + +## Navigation + +Navigating through the Terminal menus is similar to traversing folders from any operating system's command line prompt. The `/home` screen is the main directory where everything begins, and the menus are paths branched from the main. Instead of `C:\Users\OpenBB\Documents`, you'll have something like `/stocks/options`. Instead of `cd ..`, you can do `..` to return the menu right above. To go back to the root menu you can do `/`. + +Absolute paths are also valid to-and-from any point. From the [`/stocks/options`](/terminal/data-available/stocks/options) menu, you can go directly to [`crypto`](/terminal/data-available/crypto) menu with: `/crypto`. Note the forward slash at the start to denote the "absolute" path. + + + diff --git a/website/content/terminal/usage/routines/_category_.json b/website/content/terminal/usage/routines/_category_.json new file mode 100644 index 000000000000..549ac0695baf --- /dev/null +++ b/website/content/terminal/usage/routines/_category_.json @@ -0,0 +1,4 @@ +{ + "label": "Routines", + "position": 4 +} diff --git a/website/content/terminal/usage/routines/community-routines.md b/website/content/terminal/usage/routines/community-routines.md new file mode 100644 index 000000000000..b1ce0f07188b --- /dev/null +++ b/website/content/terminal/usage/routines/community-routines.md @@ -0,0 +1,79 @@ +--- +title: Community Routines +sidebar_position: 6 +description: Page provides a detailed overview on the usage of OpenBB's Community + Routines. It explains how users can share, access, upvote, and search for investment + research scripts. Additionally, it presents the feature of using the new TimeGPT-1 + model from Nixtla, and the options to save, download, and share scripts. +keywords: +- Community Routines +- Investment Research +- Investment Scripts +- TimeGPT-1 Model +- Tutorial Video +- Upvotes +- Share Scripts +- Advanced Search +- Nixtla +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import TutorialVideo from '@site/src/components/General/TutorialVideo.tsx'; + + + +Community routines will enable the community to share their investment research routines and streamline everyone's investment research workflow. + +This is where you can find them: [https://my.openbb.co/app/terminal/community-routines/new](https://my.openbb.co/app/terminal/community-routines/new?size=25&tags=&page=1) + +![image](https://github.com/OpenBB-finance/OpenBBTerminal/assets/25267873/5cbfb88d-7b7f-4ac6-bf0b-be245ce19317) + +There are 3 categories where you can find a collection of scripts: + +- **Hot**: High rate of recent upvotes + +- **Popular**: Most-voted scripts + +- **New**: Recently added scripts + +The icon on the left allows you to upvote your favorite scripts and see how many times they have been voted by the community. + +In addition, if you are looking for a specific script, you can use the advanced search field to filter by username, description, tags, and even date time. + +![image](https://github.com/OpenBB-finance/OpenBBTerminal/assets/25267873/ecbc73ce-35b0-48b1-8fa4-ff6bd94db96f) + +When clicking on one of these scripts, you’ll be able to access the information associated with it - the username, title, description, and the script itself. + +![image](https://github.com/OpenBB-finance/OpenBBTerminal/assets/25267873/15f162b6-360d-4f1b-b300-55298ed82b99) + +Plus you’ll have 2 possible actions: + +- Save that routine to your personal collection - so you can edit it directly on the Hub and save it for terminal usage. + +- Download the routine to your desktop - so you can share it with others or tweak it locally. + +When you click on the “Share” icon associated with a routine, you’ll be prompted with a link to share that routine with your colleagues. + +![image](https://github.com/OpenBB-finance/OpenBBTerminal/assets/25267873/c8d6ecc1-7704-47ef-9f74-b336480c9fa1) + +The goal is that more users can benefit from other users' investment research workflow. + +If you select the check box “Run on terminal”, an “exe” will be added at the start of the link so you can copy-paste it into the OpenBB Terminal to run that same script. + +Finally, users can set their scripts to public or keep them private. + +In the screenshot below, you have a private routine that implements the new TimeGPT-1 (Beta) model from our friends at Nixtla. + +![image](https://github.com/OpenBB-finance/OpenBBTerminal/assets/25267873/a6326901-106c-4514-a9bc-68f659b867a9) + +Also, don’t forget to set your socials on your account so other OpenBB users can reach out to you to ask you more questions about your routines. + +![image](https://github.com/OpenBB-finance/OpenBBTerminal/assets/25267873/ace4c886-e521-46e5-a53a-736408dd096e) + +We hope you take advantage of this exciting addition and learn how to use one of the best features the terminal has to offer. diff --git a/website/content/terminal/usage/routines/introduction-to-routines.md b/website/content/terminal/usage/routines/introduction-to-routines.md new file mode 100644 index 000000000000..b70a3ab5b30d --- /dev/null +++ b/website/content/terminal/usage/routines/introduction-to-routines.md @@ -0,0 +1,108 @@ +--- +title: Introduction to Routines +sidebar_position: 3 +description: The page provides a detailed introduction to OpenBB Routines, which allow + users to automate processes and repetitive tasks in financial analysis and data + collection. It explains basic scripts, routine execution, and guides users on getting + started with an example. +keywords: +- OpenBB Routines +- automated processes +- repetitive tasks +- data collection +- basic script +- routine execution +- tutorial video +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import TutorialVideo from '@site/src/components/General/TutorialVideo.tsx'; + + + +## Introduction + +OpenBB Routines allows users to write simple scripts for automating processes and repetitive tasks. In essence, these are text plain-text files that can be created or modified in any basic text editor with the only difference of having a `.openbb` extension. + +Other software like STATA, SPSS, and R-Studio share similar functionality in the area of Econometrics and the OpenBB routine scripts venture into the area of financial analysis and data collection to speed up the process. + +For example, not only is it possible to automate a set of functionality, but it is also possible to export a large amount of data to Excel through the usage of `--export` and `--sheet-name` making data collection efficient, reproducible and customizable. + +The reason for this is the pipeline of commands became increasingly lengthy. This posed a challenge when sharing the commands with colleagues, as it became difficult for them to understand the purpose of the pipeline and what each step aimed to achieve. + +## Routine execution + +Run a routine file from the main menu, with the `exe` command. A great start would be to use `exe --example` to get a sense of what this functionality does. Below, the `--help` dialogue is displayed. + +```console +(🦋) / $ exe -h + +usage: exe [--file PATH] [-i ROUTINE_ARGS] [-e] [-h] + +Execute the automated routine script. For example, please use `exe --example` and for documentation and to learn how to create your own script type `about exe`. + +options: + --file PATH The path or .openbb file to run. (default: None) + -i ROUTINE_ARGS, --input ROUTINE_ARGS + Select multiple inputs to be replaced in the routine and separated by commas. E.g. GME,AMC,BTC-USD (default: None) + -e, --example Run an example script to understand how routines can be used. (default: False) + -h, --help show this help message (default: False) +``` + +## Basic Script + +![image](https://github.com/OpenBB-finance/OpenBBTerminal/assets/25267873/eaeb3511-d544-4579-8d76-f7a4fd7bb1d3) + +The most basic script style contains 2 main elements: + + - **Comments**: any text after a hashtag (`#`) is referred to as a comment. This is used to explain what is happening within the line below and is ignored when the file is executed. + + - **Commands**: any text *without* a hashtag is being run inside the OpenBB Terminal as if the user had prompted that line in the terminal. Note that this means that you are able to create a pipeline of commands in a single line, i.e. `stocks/load AAPL/candle --ma 20` is a valid line for the script. + +For instance, the text below corresponds to the example file that OpenBB provides. + +``` +# Go into the stocks context +stocks + +# Load a company ticker, e.g. Apple +load AAPL + +# Show a candle chart with a 20 day Moving Average +candle --ma 20 + +# Switch over to the Fundamental Analysis menu +fa + +# Show Earnings per Share (EPS) estimates +epsfc + +# Show price targets charts +pt + +# Show future estimations +est + +# Return to home +home +``` + +## Getting started + +As a starting point, let's use the example above. + +1. Create a new text file with the name `routines_template.openbb` and copy and paste the routine above. For simplicity you can also download the template file **[here](https://www.dropbox.com/s/73g9qx9xgtbb2ec/routines_template.openbb?dl=1)**. + +2. Move the file inside the `routines` folder within the [OpenBBUserData](/terminal/usage/data/custom-data) folder and, optionally, adjust the name to your liking. + +3. Open up the OpenBB Terminal, and type `exe --file routines_template`. If you changed the name of the file, then replace `routines_template` with such. As long as the file remains in the `routines` folder, you will be able to find your file through OpenBB Terminal's auto-completer capability. + +Now you should expect the contents of the example above to be run. This means that a candle chart with a moving average of 20 days, expectations and price targets from analysts and estimated future performance should pop up before returning to the home window. + +![OpenBB Routine Script Execution](https://user-images.githubusercontent.com/46355364/223207167-dfab3a74-d34d-47d4-bf6e-44944e8fbfa2.png) diff --git a/website/content/terminal/usage/routines/overlay-financial-data.md b/website/content/terminal/usage/routines/overlay-financial-data.md new file mode 100644 index 000000000000..6fb34a8f1b4c --- /dev/null +++ b/website/content/terminal/usage/routines/overlay-financial-data.md @@ -0,0 +1,133 @@ +--- +title: Overlay financial data +sidebar_position: 2 +description: Guide to improve financial data comparison and visualization using the + 'hold on' command in OpenBBTerminal. Covers overlaying data on the same axes, customizing + chart legends and titles, analyzing FAANG companies and GDP/CPI data, and more. +keywords: +- hold on command +- overlay financial data +- same axis plotting +- customizing charts +- financial data comparison +- MatLab +- financial charts +- FAANG companies +- CPI +- GDP +- data visualization +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import TutorialVideo from '@site/src/components/General/TutorialVideo.tsx'; + + + +## Hold on command + +Often analysts want to be able to overlay financial data. This is possible through the introduction of the `hold on` command. + +The `hold` functionality is available to allow users to overlay multiple datasets onto the same chart axes. This is useful for comparing datasets, or for plotting multiple datasets that share the same x-axis. This guide will walk through the functionalities and the recommended workflow. + +Drawing inspiration from MatLab, the `hold` function is used to toggle the holding state of the current figure. Unlike MatLab, this function needs to be called before calling any function that charts. The hold state can be turned on, from any terminal menu, by running: + +```bash +hold on +``` + +By default, new plots will be placed on a new axis, meaning comparing the magnitude values can be tricky. If you wish to plot subsequent figures on the same axis, you can use the sameaxis argument: + +```bash +hold on --sameaxis +``` + +Once the hold state is turned on, any terminal command with a plot will not be shown until the hold is turned off. To turn off the hold state, and see the combined figure, run: + +```bash +hold off +``` + +An example workflow is as follows. What this will do is plot the CPI and the GDP of the United States on the same axis. + +``` +(🦋) /economy/ $ hold on +(🦋) /economy/ $ gdp -c united_states +(🦋) /economy/ $ cpi -c united_states +(🦋) /economy/ $ hold off +``` +Which results in the following figure: + +![hold on ex1](https://github.com/OpenBB-finance/OpenBBTerminal/assets/18151143/a3b1f09e-1a64-4af0-a5a2-070590d848e1) + +To show the impact of the `--sameaxis` argument, we can run the previous commands, but starting with `hold on --sameaxis`. Because GDP is on the order on 70,000 USD/capita and the CPI is on the order of 10 (percent), we will see the cpi being a flat line, and the trend will not be apparent: + +![hold on ex2](https://github.com/OpenBB-finance/OpenBBTerminal/assets/18151143/43219ca7-126b-4782-bd95-5fa8967e0c6c) + + +## Customizing Charts + +A chart is only as good as its labelling. On the previous example, we can see that the legends reflected the command paths that were used, but not the arguments. If we added gdp of a second country, we would not be able to tell which line is which country. In order to avoid this confusion, when the hold state is on, every function comes with a `--legend` argument. + +This will pass the users desired label into the chart legend. When the chart is displayed, the legends will display. If a command is run without the `--legend` argument, it will default to using the command location as previously shown. In rare cases, a legend may not appear due to it not being defined in the functions `view` file. In this case, please raise a [GitHub issue](https://github.com/OpenBB-finance/OpenBBTerminal/issues/new/choose) so the team can address it. + +An additional customization is the ability to add a custom title to the chart. This can be specified by adding the `--title` argument to the hold off functionality. To show off these capabilities, we can use an example of plotting income statement items for different companies. In this example, we can look at FAANG companies and plot their revenues on the same axis. This example will show the previous 40 quarters. + +``` +(🦋) /stocks/fa/ $ hold on --sameaxis +(🦋) /stocks/fa/ $ income -t AAPL -q -l 40 --plot revenue --legend AAPL Revenue +(🦋) /stocks/fa/ $ income -t META -q -l 40 --plot revenue --legend META +(🦋) /stocks/fa/ $ income -t AMZN -q -l 40 --plot revenue +(🦋) /stocks/fa/ $ income -t GOOG -q -l 40 --plot revenue --legend GOOG +(🦋) /stocks/fa/ $ income -t NFLX -q -l 40 --plot revenue --legend netflix +(🦋) /stocks/fa/ $ hold off --title FAANG Revenues 10 Year +``` + +Which results in the following figure: + +![hold on custom](https://github.com/OpenBB-finance/OpenBBTerminal/assets/18151143/793d8309-6e49-42ca-b9bd-ff0dad9da959) + +### Example as pipeline of commands + +The following pipeline of commands can be run to achieve the same as above. + +```console +(🦋) $ stocks/fa/hold on --sameaxis/income -t AAPL -q -l 40 --plot revenue --legend AAPL Revenue/income -t META -q -l 40 --plot revenue --legend META/income -t AMZN -q -l 40 --plot revenue/income -t GOOG -q -l 40 --plot revenue --legend GOOG/income -t NFLX -q -l 40 --plot revenue --legend netflix/hold off --title FAANG Revenues 10 Year +``` + +### Example as routine + +Or, a user can create a routine that can be run by utilizing `exe` command. + +```bash + $STOCKS=AAPL,AMZN,MSFT,TSLA,GOOG + + stocks + fa + hold on --sameaxis + + foreach $$tick in $STOCKS: + income -t $$tick -l 40 -q --plot revenue --legend $$tick revenue + end + + hold off--title FAANG Revenues 10 Year +``` + +### Known Issues + +Unfortunately, there are some known issues with the hold functionality. These are being worked on, and will be addressed in future releases. The following are known issues: + +- When plotting charts, if the x axes are not the same, there may be an undesired result. For example, if looking at the `fixedincome/ycrv` function, the x axes is a number in years, so trying to plot a date along x will not work. + +- Candle charts are not supported within the hold state. A work around to plot a close value would be to navigate to `qa/pick Close/line`, which will plot a line chart. + +- Figures that have subplots on their own are not supported. This functionality is meant to overlay data on the same axes, so if there are multiple subplots, it is not supported. An example would be a function like `ta/macd`. The TA functions already have a multiple indicator functionality, `ta/multi`. + +- Running a single plot in the hold state messes with the figure layout and does not give the desired margin. + +- Time series data of varying frequencies may not produce smooth visuals. diff --git a/website/content/terminal/usage/routines/pipeline-of-commands.md b/website/content/terminal/usage/routines/pipeline-of-commands.md new file mode 100644 index 000000000000..00e000300bd0 --- /dev/null +++ b/website/content/terminal/usage/routines/pipeline-of-commands.md @@ -0,0 +1,90 @@ +--- +title: Pipeline of commands +sidebar_position: 1 +description: This page provides a detailed understanding of how to use OpenBB Terminal. + The tutorial video and walkthrough guides to help users automate their investment + research process by using single commands and command sequences to manipulate and + study data, especially GME's dark pool data. Concepts like pipelines of commands, + loading stocks, and use of indicators like MACD and EMA are explained. +keywords: +- Single command +- Pipeline of commands +- Command sequence +- Automate investment research +- Tutorial video +- GME's dark pool data +- Technical Analysis +- Moving Average Convergence/Divergence indicator +- Stock price loaded +- Exponential moving average indicator +- Price vs Short interest +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import TutorialVideo from '@site/src/components/General/TutorialVideo.tsx'; + + + +## Single command + +If you understand well the terminal architecture, you understand that commands and menus are organized in the form of a tree. + +![image](https://github.com/OpenBB-finance/OpenBBTerminal/assets/25267873/a5f10833-9693-4b39-9491-b431919db828) + +This means that if your intention is to explore GME's dark pool data, you simply need to navigate to the `stocks` section within the OpenBB Terminal and then proceed to the `dps` subsection (which stands for "dark pool and short" data). Upon reaching this point, the terminal will present you with several available commands that you could execute to retrieve the desired data. + +While all the information is in one place, having to type one command at a type is far from optimal. + +![image](https://github.com/OpenBB-finance/OpenBBTerminal/assets/25267873/41737800-7c60-48ad-a43d-814016d81762) + +## Pipeline of commands + +One of the main objectives of the OpenBB Terminal was the capability to be able to automate user's investment research workflow. Thus we needed to go further than just allowing to run 1 command at a time. + +This is where the concept of a pipeline of commands comes in. So users can run a sequence of commands. For instance, the example above could be achieved by simply running + +```console +(🦋) / $ stocks/load GME/dps/psi +``` + +Achieving the following: + +![image](https://github.com/OpenBB-finance/OpenBBTerminal/assets/25267873/c21c5452-5a67-4384-851c-d2801b60f8cd) + +A different example could be: + +```console +(🦋) / $ stocks/load GME/dps/psi/../fa/pt/income/../ins/stats +``` + +![image](https://github.com/OpenBB-finance/OpenBBTerminal/assets/25267873/61db4010-bdc2-4851-9e47-79fb4425b816) + +### Step-by-step explanation + +```console +(🦋) / $ stocks/load amzn/ta/macd/ema -l 50,200/../dps/psi +``` + +This will do the following: + +1. `stocks` - Go into `stocks` menu + +2. `load amzn` - Load Amazon's stock inside stock menu + +3. `ta` - Go into Technical Analysis (`ta`) menu + +4. `macd` - Run the moving average convergence/divergence indicator (`macd`) on the stock price loaded (i.e. `amzn`) + +5. `ema -l 50,200` - Run the exponential moving average indicator with windows of length 50 and 200 (`ema -l 50,200`) on the stock price loaded (i.e. `amzn`) + +6. `..` - Go one menu up + +7. `dps` - Go into Dark pool and Short (`dps`) menu + +8. `psi` - Go into Price vs Short interest (`psi`) menu diff --git a/website/content/terminal/usage/routines/routine-macro-recorder.md b/website/content/terminal/usage/routines/routine-macro-recorder.md new file mode 100644 index 000000000000..f592d1129f00 --- /dev/null +++ b/website/content/terminal/usage/routines/routine-macro-recorder.md @@ -0,0 +1,47 @@ +--- +title: Routine Macro Recorder +sidebar_position: 4 +description: Learn how to use the macro recorder in OpenBB to start saving commands + and automate common tasks with scripts. This page guides you through the process + of recording, saving, and accessing your recorded routines. +keywords: +- macro recorder +- script routines +- global commands +- Excel's VBA methods +- command recording +- routine script +- terminal main menu +- exe --file +- OpenBBUserData +- routines folder +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import TutorialVideo from '@site/src/components/General/TutorialVideo.tsx'; + + + +OpenBB script routines can be captured with the macro recorder, controlled with global commands, `record` to start saving commands and `stop` to terminate the recording. This shares similarities with that of Excel's VBA methods. This means that any command you run will be automatically recorded for the routine script and once you type `stop` it automatically saves the file to the `~/OpenBBUserData/routines/` folder. + +For example, if you copy and paste the following prompt in the OpenBB Terminal and press enter, you will see an example. + +```console +$ /record/economy/cpi/treasury/index sp500/stop +``` + +The following shows the output from this pipeline of commands. + +![Routines](https://user-images.githubusercontent.com/46355364/223204998-70d9e5da-f84e-4c22-90c4-576dcf87c1df.png) + +Because there was a `record` and `stop` at the `start` and `end` respectively, a routine script was created. This file cane be found inside the `routines` folder within the `OpenBBUserData` folder (more on exporting and import data [here](/terminal/usage/data/custom-data)). + +Now, you should be able to access the routine file from the terminal main menu by doing `/exe --file` and using the auto-completer. Note that the naming of the file will differ for you based on the time you are executing the script. + +![Routines](https://user-images.githubusercontent.com/46355364/223205394-77e7a33d-e9fa-4686-b32f-e8d183b265e6.png) diff --git a/website/content/terminal/usage/routines/routines-for-power-users.md b/website/content/terminal/usage/routines/routines-for-power-users.md new file mode 100644 index 000000000000..d7a0370464de --- /dev/null +++ b/website/content/terminal/usage/routines/routines-for-power-users.md @@ -0,0 +1,206 @@ +--- +title: Routines for Power Users +sidebar_position: 5 +description: This documentation guides on running automated workflows in OpenBB by + introducing variables and arguments for routines. Explains about input variables, + relative time keyword variables, internal script variables and creating loops for + batch execution. +keywords: +- automated workflows +- routines +- arguments +- variables +- relative time keywords +- internal script variables +- loops +- batch execution +- OpenBBTutorial +- Technical Analysis +- Stock Tickers +- Running Scripts +- Executing Commands +--- + +import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; + + + +import TutorialVideo from '@site/src/components/General/TutorialVideo.tsx'; + + + +## Input Variables + +When utilizing basic routines capabilities, users had to create separate routines for each specific ticker, such as `my_due_diligence_AAPL.openbb` or `my_due_diligence_TSLA.openbb`. This approach was suboptimal, considering that we had control over reading these scripts and they were meant to be used within our ecosystem. + +To address this limitation, we introduced the concept of arguments, inspired by the Perl language. These arguments are variables referenced within the `.openbb` script as `$ARGV` or `$ARGV[0]`, `$ARGV[1]`, and so on. They are provided in the terminal when running `exe` by adding the `--input` flag, followed by the variables separated by commas. + +For instance, if a routine file called `script_with_input.openbb` had the following format: + +![image](https://github.com/OpenBB-finance/OpenBBTerminal/assets/25267873/5b0f558e-ace0-423d-a3db-b6369755cffb) + +And we run it in the terminal with `exe —file script_with_input.openbb —input MSFT`, what would be run would be `stocks/load MSFT --start 2015-01-01/ta/ema -l 20,50,100,200` and so you could use the same routine for multiple tickers - **making it a more powerful automated workflow**. + +For instance, the example below shows how you can run the same script for MSFT but also TSLA ticker. + +And we run it in the terminal with exe —file script_with_input.openbb —input MSFT, what would be run would be stocks/load MSFT --start 2015-01-01/ta/ema -l 20,50,100,200 and so you could use the same routine for multiple tickers - making it a more powerful automated workflow. + +For instance, the example below shows how you can run the same script for `MSFT` but also `TSLA` ticker. + +![image](https://github.com/OpenBB-finance/OpenBBTerminal/assets/25267873/8a744571-59b9-4293-bdd7-5dd6e2c8eef3) + +### Example + +Let's look into the following routine (the file can be downloaded [here](https://www.dropbox.com/s/usooz6y29r1xldb/routines_template_with_inputs.openbb?dl=1)): + +``` +# This script requires you to use arguments. This can be done with the following: +# exe --file routines_template_with_inputs.openbb -i TSLA,AAPL,MSFT + +# Go to the stocks menu +stocks + +# Load a ticker, given the argument used. E.g. -i TSLA +load $ARGV[0] + +# Enter the Technical Analysis (ta) menu +ta + +# Show the fibonacci retracement levels +fib + +# Enter the comparison analysis (ca) menu +../ca + +# Set two extra tickers based on the arguments used. E.g. -i TSLA,AAPL,MSFT +add $ARGV[1],$ARGV[2] + +# Plot the historical prices +historical + +# Return to home +home +``` + +This script includes `$ARGV[0]`, `$ARGV[1]` and `$ARGV[2]`. This means that the script requires you to submit three arguments. In this case, they refer to stock tickers. Therefore, like the script also says, you can include these arguments with `-i` or `--input` followed by three tickers (e.g. `/exe routines_template_with_inputs.openbb -i TSLA,AAPL,MSFT`). Resulting in the following, + +![OpenBB Script with Input](https://user-images.githubusercontent.com/46355364/223207706-42995834-577f-4747-8185-42a016f441d9.png) + +Note: Make sure you saved this script in the `~/OpenBBUserData/routines/` folder else you are not able to execute it. + + +## Set Variables + +In addition to enabling users to run scripts with external variables using the keyword `ARGV`, we also support the use of internal variables within the script. These variables are defined by starting with the `$` character. + +![image](https://github.com/OpenBB-finance/OpenBBTerminal/assets/25267873/c0cc6e1e-b87c-46f4-8c94-539408745433) + +Which has the following output: + +![image](https://github.com/OpenBB-finance/OpenBBTerminal/assets/25267873/77060dfc-216e-490f-af72-3d4af5642e0f) + +Note that the variable can have a single element or can be constituted by an array where elements are separated using a comma “,”. + +### Example + +Example of the script below: + +``` +# Set date variable +$DATE = 2022-01-01 + +# Set list of tickers to iterate +$TICKERS = AAPL,MSFT + +# dive into stocks +stocks + +# candle chart for first ticker +load $TICKERS[0] --start $DATE/candle + +# candle chart for second ticker +load $TICKERS[1] --start $DATE[0]/candle +``` + +Note that a variable can be declared as a single argument `$DATE = 2022-01-01` but it can also be declared as a list `$TICKERS = AAPL,MSFT`. + +When declared as a list, the user needs to use the indexing to access the element of interest, i.e. if interested in `MSFT` then `$TICKERS[1]` should be used. + +When a single element is defined, then the user can access it through the variable name or indexing the first position equally, i.e. `$DATE` = `$DATE[0]`. + +Note that slicing is also possible, and the same convention as python is utilized. If the user has defined inputs `AAPL,MSFT,TSLA,NVDA,GOOG` then by selecting `$ARGV[1:3]` the tickers `MSFT,TSLA` are selected. + + +## Relative Time Keyword Variables + +In addition to the powerful variables discussed earlier, OpenBB also supports the usage of relative keywords, particularly for working with dates. These relative keywords provide flexibility when specifying dates about the current day. There are four types of relative keywords: + +1. **AGO**: Denotes a time in the past relative to the present day. Valid examples include `$365DAYSAGO`, `$12MONTHSAGO`, `$1YEARSAGO`. + +2. **FROMNOW**: Denotes a time in the future relative to the present day. Valid examples include `$365DAYSFROMNOW`, `$12MONTHSFROMNOW`, `$1YEARSFROMNOW`. + +3. **LAST**: Refers to the last specific day of the week or month that has occurred. Valid examples include `$LASTMONDAY`, `$LASTJUNE`. + +4. **NEXT**: Refers to the next specific day of the week or month that will occur. Valid examples include `$NEXTFRIDAY`, `$NEXTNOVEMBER`. + +The result will be a date with the conventional date associated with OpenBB, i.e. `YYYY-MM-DD`. + +### Example + +By picking on the previous example, we can add to the load `--start` argument the keyword `$18MONTHSAGO`. + +![image](https://github.com/OpenBB-finance/OpenBBTerminal/assets/25267873/e0e9b4a2-3d8d-4f72-8029-55f009dc15ee) + +This will result in the following output: + +![image](https://github.com/OpenBB-finance/OpenBBTerminal/assets/25267873/78d6235e-15a1-47cb-a99c-19694b6af0d9) + + +## Foreach Loop + +Finally, what scripting language would this be if there were no loops? For this, we were inspired by MatLab. The loops in OpenBB utilize the foreach and end convention, allowing for iteration through a list of variables or arguments to execute a sequence of commands. + +To create a foreach loop, you need to follow these steps: + +1. Create the loop header using the syntax: `foreach $$VAR in X` where `X` represents either an argument or a list of variables. It's worth noting that you can choose alternative names for the `$$VAR` variable, as long as the `$$` convention is maintained. + +2. Insert the commands you wish to repeat on the subsequent lines. + +3. Conclude the loop with the keyword `end`. + +### Examples + +``` +# Iterates through ARGV elements from position 1 onwards +foreach $$VAR in $ARGV[1:] + load $$VAR --start $DATES[0] --end $DATES[1]/dps/psi/.. +end +``` + +``` +# Loops through all $ARGV variables +FOREACH $$SOMETHING in $ARGV + load $$SOMETHING --start $DATE[0]/ins/stats/.. + end +``` + +``` +# Iterates through ARGV elements in position 1,2 +foreach $$VAR in $ARGV[1:3] + load $$VAR --start 2022-01-01 + ba + regions + .. +END +``` + +``` +# Loops through PLTR and BB +foreach $$X in PLTR,BB + load $$X --start $LASTJANUARY + candle +END +``` diff --git a/website/docusaurus.config.js b/website/docusaurus.config.js index 683a98fb8b69..f45f2eea1115 100644 --- a/website/docusaurus.config.js +++ b/website/docusaurus.config.js @@ -35,8 +35,8 @@ const config = { { redirects: [ { - from: "/terminal/usage/intros/forecasting", - to: "/terminal/usage/intros/forecast", + from: "/terminal/data-available/forecasting", + to: "/terminal/data-available/forecast", }, ], }, @@ -81,22 +81,10 @@ const config = { /** @type {import('@docusaurus/preset-classic').Options} */ ({ docs: { - breadcrumbs: true, - lastVersion: "current", - versions: { - current: { - label: "v4", - path: "", - banner: "unreleased", - }, - v3: { - label: "v3", - path: "v3", - }, - }, - editUrl: ({ versionDocsDirPath, docPath }) => - `https://github.com/OpenBB-finance/OpenBBTerminal/edit/main/website/${versionDocsDirPath}/${docPath}`, sidebarPath: require.resolve("./sidebars.js"), + editUrl: "https://github.com/OpenBB-finance/OpenBBTerminal/edit/main/website/", + showLastUpdateTime: true, + showLastUpdateAuthor: true, routeBasePath: "/", path: "content", remarkPlugins: [math], @@ -117,18 +105,6 @@ const config = { theme: lightCodeTheme, darkTheme: darkCodeTheme, }, - docs: { - versionPersistence: "localStorage", - }, - navbar: { - items: [ - { - type: "docsVersionDropdown", - position: "left", - dropdownActiveClassDisabled: true, - }, - ], - }, // TODO - Jose can you make this so we get lighter color on main view - like bot docs colorMode: { defaultMode: "dark", @@ -137,12 +113,11 @@ const config = { }, algolia: { appId: "7D1HQ0IXAS", - apiKey: "a2e289977b4b663ed9cf3d4635a438fd", + apiKey: "a2e289977b4b663ed9cf3d4635a438fd", // pragma: allowlist secret indexName: "openbbterminal", contextualSearch: false, }, }), - stylesheets: [ { href: "/katex/katex.min.css", diff --git a/website/generate_sdk4_markdown.py b/website/generate_sdk4_markdown.py index 8665ae0ab8b1..e97e74aeeb66 100644 --- a/website/generate_sdk4_markdown.py +++ b/website/generate_sdk4_markdown.py @@ -198,8 +198,8 @@ def get_command_meta(path: str, route_map: Dict[str, Any]) -> Dict[str, Any]: if param.name == "provider": # pylint: disable=W0212 - param_type = param._annotation - default = param._annotation.__args__[0].__args__[0] + param_type = param._annotation # type: ignore + default = param._annotation.__args__[0].__args__[0] # type: ignore description = ( "The provider to use for the query, by default None. " f"If None, the provider specified in defaults is selected or '{default}' if there is no default." @@ -213,7 +213,7 @@ def get_command_meta(path: str, route_map: Dict[str, Any]) -> Dict[str, Any]: optional = "True" default = "False" else: - description = obb_query_fields[param.name].description + description = obb_query_fields[param.name].description # type: ignore param_type = param.annotation @@ -278,7 +278,7 @@ def get_command_meta(path: str, route_map: Dict[str, Any]) -> Dict[str, Any]: "doc": description, } - standard, provider_extras, provider_params = {}, {}, {} + standard, provider_extras, provider_params = {}, {}, {} # type: ignore for provider_name, model_details in providers.items(): data_fields: Dict[str, FieldInfo] = model_details["Data"]["fields"] @@ -376,7 +376,7 @@ def generate_params_markdown_section(meta: Dict[str, Any]): def generate_data_model_card_info(meta: Dict[str, Any]) -> Tuple[str, str]: description = meta["description"] - split_description = list(filter(None, description.split("."))) + split_description = list(filter(None, description.split("."))) # type: ignore title = split_description[0] description = ".".join(split_description[1:]) if len(split_description) > 1 else "" @@ -418,7 +418,7 @@ def generate_implementation_details_markdown_section(data_model: str) -> str: return markdown -def generate_sdk_markdown() -> bool: +def generate_sdk_markdown() -> None: """Generate markdown files for OpenBB FastAPI SDK Docusaurus website.""" route_map = PathHandler.build_route_map() path_list = sorted(PathHandler.build_path_list(route_map=route_map)) @@ -489,7 +489,7 @@ def generate_sdk_markdown() -> bool: ) ) data_filepath.parent.mkdir(parents=True, exist_ok=True) - with open(data_filepath, "w", **kwargs) as f: + with open(data_filepath, "w", **kwargs) as f: # type: ignore f.write(data_markdown) reference_cards.setdefault(filepath.parent, []).append( @@ -501,7 +501,7 @@ def generate_sdk_markdown() -> bool: ) filepath.parent.mkdir(parents=True, exist_ok=True) - with open(filepath, "w", **kwargs) as f: + with open(filepath, "w", **kwargs) as f: # type: ignore f.write(markdown) reference_cards = dict(sorted(reference_cards.items(), key=lambda item: item[0])) @@ -521,7 +521,7 @@ def generate_sdk_markdown() -> bool: ) with open(content_path / "_category_.json", "w", **kwargs) as f: # type: ignore - """Generate category json""" + # Generate category json f.write(json.dumps({"label": "Reference", "position": 5}, indent=2)) def gen_category_json(fname: str, path: Path): diff --git a/website/package-lock.json b/website/package-lock.json index 7b2f19e28227..82a9d4288a91 100644 --- a/website/package-lock.json +++ b/website/package-lock.json @@ -25,7 +25,8 @@ "react-dom": "^17.0.2", "rehype-katex": "^5.0.0", "remark-math": "^3.0.1", - "tailwindcss-radix": "^2.7.0" + "tailwindcss-radix": "^2.7.0", + "typescript-toggle": "^1.1.0" }, "devDependencies": { "@docusaurus/module-type-aliases": "^2.4.3", @@ -12292,6 +12293,17 @@ "node": ">=4.2.0" } }, + "node_modules/typescript-toggle": { + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/typescript-toggle/-/typescript-toggle-1.1.0.tgz", + "integrity": "sha512-fdqedJ1rokLOhP2HJYZwRwfkQ1tEQ2C2YVMWPGwsVyq/5aonB67F0CbIA1kIu3rou5ZlFP3pvyvp/QLV95WHEg==", + "engines": { + "node": ">=10" + }, + "peerDependencies": { + "react": ">=16" + } + }, "node_modules/ua-parser-js": { "version": "1.0.36", "resolved": "https://registry.npmjs.org/ua-parser-js/-/ua-parser-js-1.0.36.tgz", diff --git a/website/package.json b/website/package.json index d56c9d4e9b26..9fc9c9051439 100644 --- a/website/package.json +++ b/website/package.json @@ -33,7 +33,8 @@ "react-dom": "^17.0.2", "rehype-katex": "^5.0.0", "remark-math": "^3.0.1", - "tailwindcss-radix": "^2.7.0" + "tailwindcss-radix": "^2.7.0", + "typescript-toggle": "^1.1.0" }, "devDependencies": { "@docusaurus/module-type-aliases": "^2.4.3", diff --git a/website/pnpm-lock.yaml b/website/pnpm-lock.yaml new file mode 100644 index 000000000000..7baa20dacee3 --- /dev/null +++ b/website/pnpm-lock.yaml @@ -0,0 +1,9371 @@ +lockfileVersion: '6.0' + +settings: + autoInstallPeers: true + excludeLinksFromLockfile: false + +dependencies: + '@docusaurus/core': + specifier: ^2.3.1 + version: 2.4.3(@docusaurus/types@2.4.3)(react-dom@17.0.2)(react@17.0.2)(typescript@4.9.5) + '@docusaurus/plugin-client-redirects': + specifier: ^2.3.1 + version: 2.4.3(react-dom@17.0.2)(react@17.0.2)(typescript@4.9.5) + '@docusaurus/plugin-content-docs': + specifier: ^2.3.1 + version: 2.4.3(react-dom@17.0.2)(react@17.0.2)(typescript@4.9.5) + '@docusaurus/preset-classic': + specifier: ^2.3.1 + version: 2.4.3(@algolia/client-search@4.20.0)(react-dom@17.0.2)(react@17.0.2)(search-insights@2.9.0)(typescript@4.9.5) + '@mdx-js/react': + specifier: ^1.6.22 + version: 1.6.22(react@17.0.2) + '@radix-ui/react-dialog': + specifier: ^1.0.2 + version: 1.0.5(react-dom@17.0.2)(react@17.0.2) + '@radix-ui/react-popover': + specifier: ^1.0.3 + version: 1.0.7(react-dom@17.0.2)(react@17.0.2) + '@radix-ui/react-tooltip': + specifier: ^1.0.5 + version: 1.0.7(react-dom@17.0.2)(react@17.0.2) + clsx: + specifier: ^1.2.1 + version: 1.2.1 + fuse.js: + specifier: ^6.6.2 + version: 6.6.2 + hast-util-is-element: + specifier: ^1.1.0 + version: 1.1.0 + posthog-js: + specifier: ^1.53.4 + version: 1.87.2 + prism-react-renderer: + specifier: ^1.3.5 + version: 1.3.5(react@17.0.2) + react: + specifier: ^17.0.2 + version: 17.0.2 + react-dom: + specifier: ^17.0.2 + version: 17.0.2(react@17.0.2) + rehype-katex: + specifier: ^5.0.0 + version: 5.0.0 + remark-math: + specifier: ^3.0.1 + version: 3.0.1 + tailwindcss-radix: + specifier: ^2.7.0 + version: 2.8.0 + typescript-toggle: + specifier: ^1.1.0 + version: 1.1.0(react@17.0.2) + +devDependencies: + '@docusaurus/module-type-aliases': + specifier: ^2.3.1 + version: 2.4.3(react-dom@17.0.2)(react@17.0.2) + '@tailwindcss/typography': + specifier: ^0.5.8 + version: 0.5.10(tailwindcss@3.3.5) + '@tsconfig/docusaurus': + specifier: ^1.0.5 + version: 1.0.7 + autoprefixer: + specifier: ^10.4.13 + version: 10.4.16(postcss@8.4.31) + postcss: + specifier: ^8.4.18 + version: 8.4.31 + tailwindcss: + specifier: ^3.2.3 + version: 3.3.5 + typescript: + specifier: ^4.7.4 + version: 4.9.5 + +packages: + + /@algolia/autocomplete-core@1.9.3(@algolia/client-search@4.20.0)(algoliasearch@4.20.0)(search-insights@2.9.0): + resolution: {integrity: sha512-009HdfugtGCdC4JdXUbVJClA0q0zh24yyePn+KUGk3rP7j8FEe/m5Yo/z65gn6nP/cM39PxpzqKrL7A6fP6PPw==} + dependencies: + '@algolia/autocomplete-plugin-algolia-insights': 1.9.3(@algolia/client-search@4.20.0)(algoliasearch@4.20.0)(search-insights@2.9.0) + '@algolia/autocomplete-shared': 1.9.3(@algolia/client-search@4.20.0)(algoliasearch@4.20.0) + transitivePeerDependencies: + - '@algolia/client-search' + - algoliasearch + - search-insights + dev: false + + /@algolia/autocomplete-plugin-algolia-insights@1.9.3(@algolia/client-search@4.20.0)(algoliasearch@4.20.0)(search-insights@2.9.0): + resolution: {integrity: sha512-a/yTUkcO/Vyy+JffmAnTWbr4/90cLzw+CC3bRbhnULr/EM0fGNvM13oQQ14f2moLMcVDyAx/leczLlAOovhSZg==} + peerDependencies: + search-insights: '>= 1 < 3' + dependencies: + '@algolia/autocomplete-shared': 1.9.3(@algolia/client-search@4.20.0)(algoliasearch@4.20.0) + search-insights: 2.9.0 + transitivePeerDependencies: + - '@algolia/client-search' + - algoliasearch + dev: false + + /@algolia/autocomplete-preset-algolia@1.9.3(@algolia/client-search@4.20.0)(algoliasearch@4.20.0): + resolution: {integrity: sha512-d4qlt6YmrLMYy95n5TB52wtNDr6EgAIPH81dvvvW8UmuWRgxEtY0NJiPwl/h95JtG2vmRM804M0DSwMCNZlzRA==} + peerDependencies: + '@algolia/client-search': '>= 4.9.1 < 6' + algoliasearch: '>= 4.9.1 < 6' + dependencies: + '@algolia/autocomplete-shared': 1.9.3(@algolia/client-search@4.20.0)(algoliasearch@4.20.0) + '@algolia/client-search': 4.20.0 + algoliasearch: 4.20.0 + dev: false + + /@algolia/autocomplete-shared@1.9.3(@algolia/client-search@4.20.0)(algoliasearch@4.20.0): + resolution: {integrity: sha512-Wnm9E4Ye6Rl6sTTqjoymD+l8DjSTHsHboVRYrKgEt8Q7UHm9nYbqhN/i0fhUYA3OAEH7WA8x3jfpnmJm3rKvaQ==} + peerDependencies: + '@algolia/client-search': '>= 4.9.1 < 6' + algoliasearch: '>= 4.9.1 < 6' + dependencies: + '@algolia/client-search': 4.20.0 + algoliasearch: 4.20.0 + dev: false + + /@algolia/cache-browser-local-storage@4.20.0: + resolution: {integrity: sha512-uujahcBt4DxduBTvYdwO3sBfHuJvJokiC3BP1+O70fglmE1ShkH8lpXqZBac1rrU3FnNYSUs4pL9lBdTKeRPOQ==} + dependencies: + '@algolia/cache-common': 4.20.0 + dev: false + + /@algolia/cache-common@4.20.0: + resolution: {integrity: sha512-vCfxauaZutL3NImzB2G9LjLt36vKAckc6DhMp05An14kVo8F1Yofb6SIl6U3SaEz8pG2QOB9ptwM5c+zGevwIQ==} + dev: false + + /@algolia/cache-in-memory@4.20.0: + resolution: {integrity: sha512-Wm9ak/IaacAZXS4mB3+qF/KCoVSBV6aLgIGFEtQtJwjv64g4ePMapORGmCyulCFwfePaRAtcaTbMcJF+voc/bg==} + dependencies: + '@algolia/cache-common': 4.20.0 + dev: false + + /@algolia/client-account@4.20.0: + resolution: {integrity: sha512-GGToLQvrwo7am4zVkZTnKa72pheQeez/16sURDWm7Seyz+HUxKi3BM6fthVVPUEBhtJ0reyVtuK9ArmnaKl10Q==} + dependencies: + '@algolia/client-common': 4.20.0 + '@algolia/client-search': 4.20.0 + '@algolia/transporter': 4.20.0 + dev: false + + /@algolia/client-analytics@4.20.0: + resolution: {integrity: sha512-EIr+PdFMOallRdBTHHdKI3CstslgLORQG7844Mq84ib5oVFRVASuuPmG4bXBgiDbcsMLUeOC6zRVJhv1KWI0ug==} + dependencies: + '@algolia/client-common': 4.20.0 + '@algolia/client-search': 4.20.0 + '@algolia/requester-common': 4.20.0 + '@algolia/transporter': 4.20.0 + dev: false + + /@algolia/client-common@4.20.0: + resolution: {integrity: sha512-P3WgMdEss915p+knMMSd/fwiHRHKvDu4DYRrCRaBrsfFw7EQHon+EbRSm4QisS9NYdxbS04kcvNoavVGthyfqQ==} + dependencies: + '@algolia/requester-common': 4.20.0 + '@algolia/transporter': 4.20.0 + dev: false + + /@algolia/client-personalization@4.20.0: + resolution: {integrity: sha512-N9+zx0tWOQsLc3K4PVRDV8GUeOLAY0i445En79Pr3zWB+m67V+n/8w4Kw1C5LlbHDDJcyhMMIlqezh6BEk7xAQ==} + dependencies: + '@algolia/client-common': 4.20.0 + '@algolia/requester-common': 4.20.0 + '@algolia/transporter': 4.20.0 + dev: false + + /@algolia/client-search@4.20.0: + resolution: {integrity: sha512-zgwqnMvhWLdpzKTpd3sGmMlr4c+iS7eyyLGiaO51zDZWGMkpgoNVmltkzdBwxOVXz0RsFMznIxB9zuarUv4TZg==} + dependencies: + '@algolia/client-common': 4.20.0 + '@algolia/requester-common': 4.20.0 + '@algolia/transporter': 4.20.0 + dev: false + + /@algolia/events@4.0.1: + resolution: {integrity: sha512-FQzvOCgoFXAbf5Y6mYozw2aj5KCJoA3m4heImceldzPSMbdyS4atVjJzXKMsfX3wnZTFYwkkt8/z8UesLHlSBQ==} + dev: false + + /@algolia/logger-common@4.20.0: + resolution: {integrity: sha512-xouigCMB5WJYEwvoWW5XDv7Z9f0A8VoXJc3VKwlHJw/je+3p2RcDXfksLI4G4lIVncFUYMZx30tP/rsdlvvzHQ==} + dev: false + + /@algolia/logger-console@4.20.0: + resolution: {integrity: sha512-THlIGG1g/FS63z0StQqDhT6bprUczBI8wnLT3JWvfAQDZX5P6fCg7dG+pIrUBpDIHGszgkqYEqECaKKsdNKOUA==} + dependencies: + '@algolia/logger-common': 4.20.0 + dev: false + + /@algolia/requester-browser-xhr@4.20.0: + resolution: {integrity: sha512-HbzoSjcjuUmYOkcHECkVTwAelmvTlgs48N6Owt4FnTOQdwn0b8pdht9eMgishvk8+F8bal354nhx/xOoTfwiAw==} + dependencies: + '@algolia/requester-common': 4.20.0 + dev: false + + /@algolia/requester-common@4.20.0: + resolution: {integrity: sha512-9h6ye6RY/BkfmeJp7Z8gyyeMrmmWsMOCRBXQDs4mZKKsyVlfIVICpcSibbeYcuUdurLhIlrOUkH3rQEgZzonng==} + dev: false + + /@algolia/requester-node-http@4.20.0: + resolution: {integrity: sha512-ocJ66L60ABSSTRFnCHIEZpNHv6qTxsBwJEPfYaSBsLQodm0F9ptvalFkHMpvj5DfE22oZrcrLbOYM2bdPJRHng==} + dependencies: + '@algolia/requester-common': 4.20.0 + dev: false + + /@algolia/transporter@4.20.0: + resolution: {integrity: sha512-Lsii1pGWOAISbzeyuf+r/GPhvHMPHSPrTDWNcIzOE1SG1inlJHICaVe2ikuoRjcpgxZNU54Jl+if15SUCsaTUg==} + dependencies: + '@algolia/cache-common': 4.20.0 + '@algolia/logger-common': 4.20.0 + '@algolia/requester-common': 4.20.0 + dev: false + + /@alloc/quick-lru@5.2.0: + resolution: {integrity: sha512-UrcABB+4bUrFABwbluTIBErXwvbsU/V7TZWfmbgJfbkwiBuziS9gxdODUyuiecfdGQ85jglMW6juS3+z5TsKLw==} + engines: {node: '>=10'} + dev: true + + /@ampproject/remapping@2.2.1: + resolution: {integrity: sha512-lFMjJTrFL3j7L9yBxwYfCq2k6qqwHyzuUl/XBnif78PWTJYyL/dfowQHWE3sp6U6ZzqWiiIZnpTMO96zhkjwtg==} + engines: {node: '>=6.0.0'} + dependencies: + '@jridgewell/gen-mapping': 0.3.3 + '@jridgewell/trace-mapping': 0.3.20 + dev: false + + /@babel/code-frame@7.22.13: + resolution: {integrity: sha512-XktuhWlJ5g+3TJXc5upd9Ks1HutSArik6jf2eAjYFyIOf4ej3RN+184cZbzDvbPnuTJIUhPKKJE3cIsYTiAT3w==} + engines: {node: '>=6.9.0'} + dependencies: + '@babel/highlight': 7.22.20 + chalk: 2.4.2 + dev: false + + /@babel/compat-data@7.23.2: + resolution: {integrity: sha512-0S9TQMmDHlqAZ2ITT95irXKfxN9bncq8ZCoJhun3nHL/lLUxd2NKBJYoNGWH7S0hz6fRQwWlAWn/ILM0C70KZQ==} + engines: {node: '>=6.9.0'} + dev: false + + /@babel/core@7.12.9: + resolution: {integrity: sha512-gTXYh3M5wb7FRXQy+FErKFAv90BnlOuNn1QkCK2lREoPAjrQCO49+HVSrFoe5uakFAF5eenS75KbO2vQiLrTMQ==} + engines: {node: '>=6.9.0'} + dependencies: + '@babel/code-frame': 7.22.13 + '@babel/generator': 7.23.0 + '@babel/helper-module-transforms': 7.23.0(@babel/core@7.12.9) + '@babel/helpers': 7.23.2 + '@babel/parser': 7.23.0 + '@babel/template': 7.22.15 + '@babel/traverse': 7.23.2 + '@babel/types': 7.23.0 + convert-source-map: 1.9.0 + debug: 4.3.4 + gensync: 1.0.0-beta.2 + json5: 2.2.3 + lodash: 4.17.21 + resolve: 1.22.8 + semver: 5.7.2 + source-map: 0.5.7 + transitivePeerDependencies: + - supports-color + dev: false + + /@babel/core@7.23.2: + resolution: {integrity: sha512-n7s51eWdaWZ3vGT2tD4T7J6eJs3QoBXydv7vkUM06Bf1cbVD2Kc2UrkzhiQwobfV7NwOnQXYL7UBJ5VPU+RGoQ==} + engines: {node: '>=6.9.0'} + dependencies: + '@ampproject/remapping': 2.2.1 + '@babel/code-frame': 7.22.13 + '@babel/generator': 7.23.0 + '@babel/helper-compilation-targets': 7.22.15 + '@babel/helper-module-transforms': 7.23.0(@babel/core@7.23.2) + '@babel/helpers': 7.23.2 + '@babel/parser': 7.23.0 + '@babel/template': 7.22.15 + '@babel/traverse': 7.23.2 + '@babel/types': 7.23.0 + convert-source-map: 2.0.0 + debug: 4.3.4 + gensync: 1.0.0-beta.2 + json5: 2.2.3 + semver: 6.3.1 + transitivePeerDependencies: + - supports-color + dev: false + + /@babel/generator@7.23.0: + resolution: {integrity: sha512-lN85QRR+5IbYrMWM6Y4pE/noaQtg4pNiqeNGX60eqOfo6gtEj6uw/JagelB8vVztSd7R6M5n1+PQkDbHbBRU4g==} + engines: {node: '>=6.9.0'} + dependencies: + '@babel/types': 7.23.0 + '@jridgewell/gen-mapping': 0.3.3 + '@jridgewell/trace-mapping': 0.3.20 + jsesc: 2.5.2 + dev: false + + /@babel/helper-annotate-as-pure@7.22.5: + resolution: {integrity: sha512-LvBTxu8bQSQkcyKOU+a1btnNFQ1dMAd0R6PyW3arXes06F6QLWLIrd681bxRPIXlrMGR3XYnW9JyML7dP3qgxg==} + engines: {node: '>=6.9.0'} + dependencies: + '@babel/types': 7.23.0 + dev: false + + /@babel/helper-builder-binary-assignment-operator-visitor@7.22.15: + resolution: {integrity: sha512-QkBXwGgaoC2GtGZRoma6kv7Szfv06khvhFav67ZExau2RaXzy8MpHSMO2PNoP2XtmQphJQRHFfg77Bq731Yizw==} + engines: {node: '>=6.9.0'} + dependencies: + '@babel/types': 7.23.0 + dev: false + + /@babel/helper-compilation-targets@7.22.15: + resolution: {integrity: sha512-y6EEzULok0Qvz8yyLkCvVX+02ic+By2UdOhylwUOvOn9dvYc9mKICJuuU1n1XBI02YWsNsnrY1kc6DVbjcXbtw==} + engines: {node: '>=6.9.0'} + dependencies: + '@babel/compat-data': 7.23.2 + '@babel/helper-validator-option': 7.22.15 + browserslist: 4.22.1 + lru-cache: 5.1.1 + semver: 6.3.1 + dev: false + + /@babel/helper-create-class-features-plugin@7.22.15(@babel/core@7.23.2): + resolution: {integrity: sha512-jKkwA59IXcvSaiK2UN45kKwSC9o+KuoXsBDvHvU/7BecYIp8GQ2UwrVvFgJASUT+hBnwJx6MhvMCuMzwZZ7jlg==} + engines: {node: '>=6.9.0'} + peerDependencies: + '@babel/core': ^7.0.0 + dependencies: + '@babel/core': 7.23.2 + '@babel/helper-annotate-as-pure': 7.22.5 + '@babel/helper-environment-visitor': 7.22.20 + '@babel/helper-function-name': 7.23.0 + '@babel/helper-member-expression-to-functions': 7.23.0 + '@babel/helper-optimise-call-expression': 7.22.5 + '@babel/helper-replace-supers': 7.22.20(@babel/core@7.23.2) + '@babel/helper-skip-transparent-expression-wrappers': 7.22.5 + '@babel/helper-split-export-declaration': 7.22.6 + semver: 6.3.1 + dev: false + + /@babel/helper-create-regexp-features-plugin@7.22.15(@babel/core@7.23.2): + resolution: {integrity: sha512-29FkPLFjn4TPEa3RE7GpW+qbE8tlsu3jntNYNfcGsc49LphF1PQIiD+vMZ1z1xVOKt+93khA9tc2JBs3kBjA7w==} + engines: {node: '>=6.9.0'} + peerDependencies: + '@babel/core': ^7.0.0 + dependencies: + '@babel/core': 7.23.2 + '@babel/helper-annotate-as-pure': 7.22.5 + regexpu-core: 5.3.2 + semver: 6.3.1 + dev: false + + /@babel/helper-define-polyfill-provider@0.4.3(@babel/core@7.23.2): + resolution: {integrity: sha512-WBrLmuPP47n7PNwsZ57pqam6G/RGo1vw/87b0Blc53tZNGZ4x7YvZ6HgQe2vo1W/FR20OgjeZuGXzudPiXHFug==} + peerDependencies: + '@babel/core': ^7.4.0 || ^8.0.0-0 <8.0.0 + dependencies: + '@babel/core': 7.23.2 + '@babel/helper-compilation-targets': 7.22.15 + '@babel/helper-plugin-utils': 7.22.5 + debug: 4.3.4 + lodash.debounce: 4.0.8 + resolve: 1.22.8 + transitivePeerDependencies: + - supports-color + dev: false + + /@babel/helper-environment-visitor@7.22.20: + resolution: {integrity: sha512-zfedSIzFhat/gFhWfHtgWvlec0nqB9YEIVrpuwjruLlXfUSnA8cJB0miHKwqDnQ7d32aKo2xt88/xZptwxbfhA==} + engines: {node: '>=6.9.0'} + dev: false + + /@babel/helper-function-name@7.23.0: + resolution: {integrity: sha512-OErEqsrxjZTJciZ4Oo+eoZqeW9UIiOcuYKRJA4ZAgV9myA+pOXhhmpfNCKjEH/auVfEYVFJ6y1Tc4r0eIApqiw==} + engines: {node: '>=6.9.0'} + dependencies: + '@babel/template': 7.22.15 + '@babel/types': 7.23.0 + dev: false + + /@babel/helper-hoist-variables@7.22.5: + resolution: {integrity: sha512-wGjk9QZVzvknA6yKIUURb8zY3grXCcOZt+/7Wcy8O2uctxhplmUPkOdlgoNhmdVee2c92JXbf1xpMtVNbfoxRw==} + engines: {node: '>=6.9.0'} + dependencies: + '@babel/types': 7.23.0 + dev: false + + /@babel/helper-member-expression-to-functions@7.23.0: + resolution: {integrity: sha512-6gfrPwh7OuT6gZyJZvd6WbTfrqAo7vm4xCzAXOusKqq/vWdKXphTpj5klHKNmRUU6/QRGlBsyU9mAIPaWHlqJA==} + engines: {node: '>=6.9.0'} + dependencies: + '@babel/types': 7.23.0 + dev: false + + /@babel/helper-module-imports@7.22.15: + resolution: {integrity: sha512-0pYVBnDKZO2fnSPCrgM/6WMc7eS20Fbok+0r88fp+YtWVLZrp4CkafFGIp+W0VKw4a22sgebPT99y+FDNMdP4w==} + engines: {node: '>=6.9.0'} + dependencies: + '@babel/types': 7.23.0 + dev: false + + /@babel/helper-module-transforms@7.23.0(@babel/core@7.12.9): + resolution: {integrity: sha512-WhDWw1tdrlT0gMgUJSlX0IQvoO1eN279zrAUbVB+KpV2c3Tylz8+GnKOLllCS6Z/iZQEyVYxhZVUdPTqs2YYPw==} + engines: {node: '>=6.9.0'} + peerDependencies: + '@babel/core': ^7.0.0 + dependencies: + '@babel/core': 7.12.9 + '@babel/helper-environment-visitor': 7.22.20 + '@babel/helper-module-imports': 7.22.15 + '@babel/helper-simple-access': 7.22.5 + '@babel/helper-split-export-declaration': 7.22.6 + '@babel/helper-validator-identifier': 7.22.20 + dev: false + + /@babel/helper-module-transforms@7.23.0(@babel/core@7.23.2): + resolution: {integrity: sha512-WhDWw1tdrlT0gMgUJSlX0IQvoO1eN279zrAUbVB+KpV2c3Tylz8+GnKOLllCS6Z/iZQEyVYxhZVUdPTqs2YYPw==} + engines: {node: '>=6.9.0'} + peerDependencies: + '@babel/core': ^7.0.0 + dependencies: + '@babel/core': 7.23.2 + '@babel/helper-environment-visitor': 7.22.20 + '@babel/helper-module-imports': 7.22.15 + '@babel/helper-simple-access': 7.22.5 + '@babel/helper-split-export-declaration': 7.22.6 + '@babel/helper-validator-identifier': 7.22.20 + dev: false + + /@babel/helper-optimise-call-expression@7.22.5: + resolution: {integrity: sha512-HBwaojN0xFRx4yIvpwGqxiV2tUfl7401jlok564NgB9EHS1y6QT17FmKWm4ztqjeVdXLuC4fSvHc5ePpQjoTbw==} + engines: {node: '>=6.9.0'} + dependencies: + '@babel/types': 7.23.0 + dev: false + + /@babel/helper-plugin-utils@7.10.4: + resolution: {integrity: sha512-O4KCvQA6lLiMU9l2eawBPMf1xPP8xPfB3iEQw150hOVTqj/rfXz0ThTb4HEzqQfs2Bmo5Ay8BzxfzVtBrr9dVg==} + dev: false + + /@babel/helper-plugin-utils@7.22.5: + resolution: {integrity: sha512-uLls06UVKgFG9QD4OeFYLEGteMIAa5kpTPcFL28yuCIIzsf6ZyKZMllKVOCZFhiZ5ptnwX4mtKdWCBE/uT4amg==} + engines: {node: '>=6.9.0'} + dev: false + + /@babel/helper-remap-async-to-generator@7.22.20(@babel/core@7.23.2): + resolution: {integrity: sha512-pBGyV4uBqOns+0UvhsTO8qgl8hO89PmiDYv+/COyp1aeMcmfrfruz+/nCMFiYyFF/Knn0yfrC85ZzNFjembFTw==} + engines: {node: '>=6.9.0'} + peerDependencies: + '@babel/core': ^7.0.0 + dependencies: + '@babel/core': 7.23.2 + '@babel/helper-annotate-as-pure': 7.22.5 + '@babel/helper-environment-visitor': 7.22.20 + '@babel/helper-wrap-function': 7.22.20 + dev: false + + /@babel/helper-replace-supers@7.22.20(@babel/core@7.23.2): + resolution: {integrity: sha512-qsW0In3dbwQUbK8kejJ4R7IHVGwHJlV6lpG6UA7a9hSa2YEiAib+N1T2kr6PEeUT+Fl7najmSOS6SmAwCHK6Tw==} + engines: {node: '>=6.9.0'} + peerDependencies: + '@babel/core': ^7.0.0 + dependencies: + '@babel/core': 7.23.2 + '@babel/helper-environment-visitor': 7.22.20 + '@babel/helper-member-expression-to-functions': 7.23.0 + '@babel/helper-optimise-call-expression': 7.22.5 + dev: false + + /@babel/helper-simple-access@7.22.5: + resolution: {integrity: sha512-n0H99E/K+Bika3++WNL17POvo4rKWZ7lZEp1Q+fStVbUi8nxPQEBOlTmCOxW/0JsS56SKKQ+ojAe2pHKJHN35w==} + engines: {node: '>=6.9.0'} + dependencies: + '@babel/types': 7.23.0 + dev: false + + /@babel/helper-skip-transparent-expression-wrappers@7.22.5: + resolution: {integrity: sha512-tK14r66JZKiC43p8Ki33yLBVJKlQDFoA8GYN67lWCDCqoL6EMMSuM9b+Iff2jHaM/RRFYl7K+iiru7hbRqNx8Q==} + engines: {node: '>=6.9.0'} + dependencies: + '@babel/types': 7.23.0 + dev: false + + /@babel/helper-split-export-declaration@7.22.6: + resolution: {integrity: sha512-AsUnxuLhRYsisFiaJwvp1QF+I3KjD5FOxut14q/GzovUe6orHLesW2C7d754kRm53h5gqrz6sFl6sxc4BVtE/g==} + engines: {node: '>=6.9.0'} + dependencies: + '@babel/types': 7.23.0 + dev: false + + /@babel/helper-string-parser@7.22.5: + resolution: {integrity: sha512-mM4COjgZox8U+JcXQwPijIZLElkgEpO5rsERVDJTc2qfCDfERyob6k5WegS14SX18IIjv+XD+GrqNumY5JRCDw==} + engines: {node: '>=6.9.0'} + dev: false + + /@babel/helper-validator-identifier@7.22.20: + resolution: {integrity: sha512-Y4OZ+ytlatR8AI+8KZfKuL5urKp7qey08ha31L8b3BwewJAoJamTzyvxPR/5D+KkdJCGPq/+8TukHBlY10FX9A==} + engines: {node: '>=6.9.0'} + dev: false + + /@babel/helper-validator-option@7.22.15: + resolution: {integrity: sha512-bMn7RmyFjY/mdECUbgn9eoSY4vqvacUnS9i9vGAGttgFWesO6B4CYWA7XlpbWgBt71iv/hfbPlynohStqnu5hA==} + engines: {node: '>=6.9.0'} + dev: false + + /@babel/helper-wrap-function@7.22.20: + resolution: {integrity: sha512-pms/UwkOpnQe/PDAEdV/d7dVCoBbB+R4FvYoHGZz+4VPcg7RtYy2KP7S2lbuWM6FCSgob5wshfGESbC/hzNXZw==} + engines: {node: '>=6.9.0'} + dependencies: + '@babel/helper-function-name': 7.23.0 + '@babel/template': 7.22.15 + '@babel/types': 7.23.0 + dev: false + + /@babel/helpers@7.23.2: + resolution: {integrity: sha512-lzchcp8SjTSVe/fPmLwtWVBFC7+Tbn8LGHDVfDp9JGxpAY5opSaEFgt8UQvrnECWOTdji2mOWMz1rOhkHscmGQ==} + engines: {node: '>=6.9.0'} + dependencies: + '@babel/template': 7.22.15 + '@babel/traverse': 7.23.2 + '@babel/types': 7.23.0 + transitivePeerDependencies: + - supports-color + dev: false + + /@babel/highlight@7.22.20: + resolution: {integrity: sha512-dkdMCN3py0+ksCgYmGG8jKeGA/8Tk+gJwSYYlFGxG5lmhfKNoAy004YpLxpS1W2J8m/EK2Ew+yOs9pVRwO89mg==} + engines: {node: '>=6.9.0'} + dependencies: + '@babel/helper-validator-identifier': 7.22.20 + chalk: 2.4.2 + js-tokens: 4.0.0 + dev: false + + /@babel/parser@7.23.0: + resolution: {integrity: sha512-vvPKKdMemU85V9WE/l5wZEmImpCtLqbnTvqDS2U1fJ96KrxoW7KrXhNsNCblQlg8Ck4b85yxdTyelsMUgFUXiw==} + engines: {node: '>=6.0.0'} + hasBin: true + dependencies: + '@babel/types': 7.23.0 + dev: false + + /@babel/plugin-bugfix-safari-id-destructuring-collision-in-function-expression@7.22.15(@babel/core@7.23.2): + resolution: {integrity: sha512-FB9iYlz7rURmRJyXRKEnalYPPdn87H5no108cyuQQyMwlpJ2SJtpIUBI27kdTin956pz+LPypkPVPUTlxOmrsg==} + engines: {node: '>=6.9.0'} + peerDependencies: + '@babel/core': ^7.0.0 + dependencies: + '@babel/core': 7.23.2 + '@babel/helper-plugin-utils': 7.22.5 + dev: false + + /@babel/plugin-bugfix-v8-spread-parameters-in-optional-chaining@7.22.15(@babel/core@7.23.2): + resolution: {integrity: sha512-Hyph9LseGvAeeXzikV88bczhsrLrIZqDPxO+sSmAunMPaGrBGhfMWzCPYTtiW9t+HzSE2wtV8e5cc5P6r1xMDQ==} + engines: {node: '>=6.9.0'} + peerDependencies: + '@babel/core': ^7.13.0 + dependencies: + '@babel/core': 7.23.2 + '@babel/helper-plugin-utils': 7.22.5 + '@babel/helper-skip-transparent-expression-wrappers': 7.22.5 + '@babel/plugin-transform-optional-chaining': 7.23.0(@babel/core@7.23.2) + dev: false + + /@babel/plugin-proposal-object-rest-spread@7.12.1(@babel/core@7.12.9): + resolution: {integrity: sha512-s6SowJIjzlhx8o7lsFx5zmY4At6CTtDvgNQDdPzkBQucle58A6b/TTeEBYtyDgmcXjUTM+vE8YOGHZzzbc/ioA==} + deprecated: This proposal has been merged to the ECMAScript standard and thus this plugin is no longer maintained. Please use @babel/plugin-transform-object-rest-spread instead. + peerDependencies: + '@babel/core': ^7.0.0-0 + dependencies: + '@babel/core': 7.12.9 + '@babel/helper-plugin-utils': 7.10.4 + '@babel/plugin-syntax-object-rest-spread': 7.8.3(@babel/core@7.12.9) + '@babel/plugin-transform-parameters': 7.22.15(@babel/core@7.12.9) + dev: false + + /@babel/plugin-proposal-private-property-in-object@7.21.0-placeholder-for-preset-env.2(@babel/core@7.23.2): + resolution: {integrity: sha512-SOSkfJDddaM7mak6cPEpswyTRnuRltl429hMraQEglW+OkovnCzsiszTmsrlY//qLFjCpQDFRvjdm2wA5pPm9w==} + engines: {node: '>=6.9.0'} + peerDependencies: + '@babel/core': ^7.0.0-0 + dependencies: + '@babel/core': 7.23.2 + dev: false + + /@babel/plugin-syntax-async-generators@7.8.4(@babel/core@7.23.2): + resolution: {integrity: sha512-tycmZxkGfZaxhMRbXlPXuVFpdWlXpir2W4AMhSJgRKzk/eDlIXOhb2LHWoLpDF7TEHylV5zNhykX6KAgHJmTNw==} + peerDependencies: + '@babel/core': ^7.0.0-0 + dependencies: + '@babel/core': 7.23.2 + '@babel/helper-plugin-utils': 7.22.5 + dev: false + + /@babel/plugin-syntax-class-properties@7.12.13(@babel/core@7.23.2): + resolution: {integrity: sha512-fm4idjKla0YahUNgFNLCB0qySdsoPiZP3iQE3rky0mBUtMZ23yDJ9SJdg6dXTSDnulOVqiF3Hgr9nbXvXTQZYA==} + peerDependencies: + '@babel/core': ^7.0.0-0 + dependencies: + '@babel/core': 7.23.2 + '@babel/helper-plugin-utils': 7.22.5 + dev: false + + /@babel/plugin-syntax-class-static-block@7.14.5(@babel/core@7.23.2): + resolution: {integrity: sha512-b+YyPmr6ldyNnM6sqYeMWE+bgJcJpO6yS4QD7ymxgH34GBPNDM/THBh8iunyvKIZztiwLH4CJZ0RxTk9emgpjw==} + engines: {node: '>=6.9.0'} + peerDependencies: + '@babel/core': ^7.0.0-0 + dependencies: + '@babel/core': 7.23.2 + '@babel/helper-plugin-utils': 7.22.5 + dev: false + + /@babel/plugin-syntax-dynamic-import@7.8.3(@babel/core@7.23.2): + resolution: {integrity: sha512-5gdGbFon+PszYzqs83S3E5mpi7/y/8M9eC90MRTZfduQOYW76ig6SOSPNe41IG5LoP3FGBn2N0RjVDSQiS94kQ==} + peerDependencies: + '@babel/core': ^7.0.0-0 + dependencies: + '@babel/core': 7.23.2 + '@babel/helper-plugin-utils': 7.22.5 + dev: false + + /@babel/plugin-syntax-export-namespace-from@7.8.3(@babel/core@7.23.2): + resolution: {integrity: sha512-MXf5laXo6c1IbEbegDmzGPwGNTsHZmEy6QGznu5Sh2UCWvueywb2ee+CCE4zQiZstxU9BMoQO9i6zUFSY0Kj0Q==} + peerDependencies: + '@babel/core': ^7.0.0-0 + dependencies: + '@babel/core': 7.23.2 + '@babel/helper-plugin-utils': 7.22.5 + dev: false + + /@babel/plugin-syntax-import-assertions@7.22.5(@babel/core@7.23.2): + resolution: {integrity: sha512-rdV97N7KqsRzeNGoWUOK6yUsWarLjE5Su/Snk9IYPU9CwkWHs4t+rTGOvffTR8XGkJMTAdLfO0xVnXm8wugIJg==} + engines: {node: '>=6.9.0'} + peerDependencies: + '@babel/core': ^7.0.0-0 + dependencies: + '@babel/core': 7.23.2 + '@babel/helper-plugin-utils': 7.22.5 + dev: false + + /@babel/plugin-syntax-import-attributes@7.22.5(@babel/core@7.23.2): + resolution: {integrity: sha512-KwvoWDeNKPETmozyFE0P2rOLqh39EoQHNjqizrI5B8Vt0ZNS7M56s7dAiAqbYfiAYOuIzIh96z3iR2ktgu3tEg==} + engines: {node: '>=6.9.0'} + peerDependencies: + '@babel/core': ^7.0.0-0 + dependencies: + '@babel/core': 7.23.2 + '@babel/helper-plugin-utils': 7.22.5 + dev: false + + /@babel/plugin-syntax-import-meta@7.10.4(@babel/core@7.23.2): + resolution: {integrity: sha512-Yqfm+XDx0+Prh3VSeEQCPU81yC+JWZ2pDPFSS4ZdpfZhp4MkFMaDC1UqseovEKwSUpnIL7+vK+Clp7bfh0iD7g==} + peerDependencies: + '@babel/core': ^7.0.0-0 + dependencies: + '@babel/core': 7.23.2 + '@babel/helper-plugin-utils': 7.22.5 + dev: false + + /@babel/plugin-syntax-json-strings@7.8.3(@babel/core@7.23.2): + resolution: {integrity: sha512-lY6kdGpWHvjoe2vk4WrAapEuBR69EMxZl+RoGRhrFGNYVK8mOPAW8VfbT/ZgrFbXlDNiiaxQnAtgVCZ6jv30EA==} + peerDependencies: + '@babel/core': ^7.0.0-0 + dependencies: + '@babel/core': 7.23.2 + '@babel/helper-plugin-utils': 7.22.5 + dev: false + + /@babel/plugin-syntax-jsx@7.12.1(@babel/core@7.12.9): + resolution: {integrity: sha512-1yRi7yAtB0ETgxdY9ti/p2TivUxJkTdhu/ZbF9MshVGqOx1TdB3b7xCXs49Fupgg50N45KcAsRP/ZqWjs9SRjg==} + peerDependencies: + '@babel/core': ^7.0.0-0 + dependencies: + '@babel/core': 7.12.9 + '@babel/helper-plugin-utils': 7.22.5 + dev: false + + /@babel/plugin-syntax-jsx@7.22.5(@babel/core@7.23.2): + resolution: {integrity: sha512-gvyP4hZrgrs/wWMaocvxZ44Hw0b3W8Pe+cMxc8V1ULQ07oh8VNbIRaoD1LRZVTvD+0nieDKjfgKg89sD7rrKrg==} + engines: {node: '>=6.9.0'} + peerDependencies: + '@babel/core': ^7.0.0-0 + dependencies: + '@babel/core': 7.23.2 + '@babel/helper-plugin-utils': 7.22.5 + dev: false + + /@babel/plugin-syntax-logical-assignment-operators@7.10.4(@babel/core@7.23.2): + resolution: {integrity: sha512-d8waShlpFDinQ5MtvGU9xDAOzKH47+FFoney2baFIoMr952hKOLp1HR7VszoZvOsV/4+RRszNY7D17ba0te0ig==} + peerDependencies: + '@babel/core': ^7.0.0-0 + dependencies: + '@babel/core': 7.23.2 + '@babel/helper-plugin-utils': 7.22.5 + dev: false + + /@babel/plugin-syntax-nullish-coalescing-operator@7.8.3(@babel/core@7.23.2): + resolution: {integrity: sha512-aSff4zPII1u2QD7y+F8oDsz19ew4IGEJg9SVW+bqwpwtfFleiQDMdzA/R+UlWDzfnHFCxxleFT0PMIrR36XLNQ==} + peerDependencies: + '@babel/core': ^7.0.0-0 + dependencies: + '@babel/core': 7.23.2 + '@babel/helper-plugin-utils': 7.22.5 + dev: false + + /@babel/plugin-syntax-numeric-separator@7.10.4(@babel/core@7.23.2): + resolution: {integrity: sha512-9H6YdfkcK/uOnY/K7/aA2xpzaAgkQn37yzWUMRK7OaPOqOpGS1+n0H5hxT9AUw9EsSjPW8SVyMJwYRtWs3X3ug==} + peerDependencies: + '@babel/core': ^7.0.0-0 + dependencies: + '@babel/core': 7.23.2 + '@babel/helper-plugin-utils': 7.22.5 + dev: false + + /@babel/plugin-syntax-object-rest-spread@7.8.3(@babel/core@7.12.9): + resolution: {integrity: sha512-XoqMijGZb9y3y2XskN+P1wUGiVwWZ5JmoDRwx5+3GmEplNyVM2s2Dg8ILFQm8rWM48orGy5YpI5Bl8U1y7ydlA==} + peerDependencies: + '@babel/core': ^7.0.0-0 + dependencies: + '@babel/core': 7.12.9 + '@babel/helper-plugin-utils': 7.22.5 + dev: false + + /@babel/plugin-syntax-object-rest-spread@7.8.3(@babel/core@7.23.2): + resolution: {integrity: sha512-XoqMijGZb9y3y2XskN+P1wUGiVwWZ5JmoDRwx5+3GmEplNyVM2s2Dg8ILFQm8rWM48orGy5YpI5Bl8U1y7ydlA==} + peerDependencies: + '@babel/core': ^7.0.0-0 + dependencies: + '@babel/core': 7.23.2 + '@babel/helper-plugin-utils': 7.22.5 + dev: false + + /@babel/plugin-syntax-optional-catch-binding@7.8.3(@babel/core@7.23.2): + resolution: {integrity: sha512-6VPD0Pc1lpTqw0aKoeRTMiB+kWhAoT24PA+ksWSBrFtl5SIRVpZlwN3NNPQjehA2E/91FV3RjLWoVTglWcSV3Q==} + peerDependencies: + '@babel/core': ^7.0.0-0 + dependencies: + '@babel/core': 7.23.2 + '@babel/helper-plugin-utils': 7.22.5 + dev: false + + /@babel/plugin-syntax-optional-chaining@7.8.3(@babel/core@7.23.2): + resolution: {integrity: sha512-KoK9ErH1MBlCPxV0VANkXW2/dw4vlbGDrFgz8bmUsBGYkFRcbRwMh6cIJubdPrkxRwuGdtCk0v/wPTKbQgBjkg==} + peerDependencies: + '@babel/core': ^7.0.0-0 + dependencies: + '@babel/core': 7.23.2 + '@babel/helper-plugin-utils': 7.22.5 + dev: false + + /@babel/plugin-syntax-private-property-in-object@7.14.5(@babel/core@7.23.2): + resolution: {integrity: sha512-0wVnp9dxJ72ZUJDV27ZfbSj6iHLoytYZmh3rFcxNnvsJF3ktkzLDZPy/mA17HGsaQT3/DQsWYX1f1QGWkCoVUg==} + engines: {node: '>=6.9.0'} + peerDependencies: + '@babel/core': ^7.0.0-0 + dependencies: + '@babel/core': 7.23.2 + '@babel/helper-plugin-utils': 7.22.5 + dev: false + + /@babel/plugin-syntax-top-level-await@7.14.5(@babel/core@7.23.2): + resolution: {integrity: sha512-hx++upLv5U1rgYfwe1xBQUhRmU41NEvpUvrp8jkrSCdvGSnM5/qdRMtylJ6PG5OFkBaHkbTAKTnd3/YyESRHFw==} + engines: {node: '>=6.9.0'} + peerDependencies: + '@babel/core': ^7.0.0-0 + dependencies: + '@babel/core': 7.23.2 + '@babel/helper-plugin-utils': 7.22.5 + dev: false + + /@babel/plugin-syntax-typescript@7.22.5(@babel/core@7.23.2): + resolution: {integrity: sha512-1mS2o03i7t1c6VzH6fdQ3OA8tcEIxwG18zIPRp+UY1Ihv6W+XZzBCVxExF9upussPXJ0xE9XRHwMoNs1ep/nRQ==} + engines: {node: '>=6.9.0'} + peerDependencies: + '@babel/core': ^7.0.0-0 + dependencies: + '@babel/core': 7.23.2 + '@babel/helper-plugin-utils': 7.22.5 + dev: false + + /@babel/plugin-syntax-unicode-sets-regex@7.18.6(@babel/core@7.23.2): + resolution: {integrity: sha512-727YkEAPwSIQTv5im8QHz3upqp92JTWhidIC81Tdx4VJYIte/VndKf1qKrfnnhPLiPghStWfvC/iFaMCQu7Nqg==} + engines: {node: '>=6.9.0'} + peerDependencies: + '@babel/core': ^7.0.0 + dependencies: + '@babel/core': 7.23.2 + '@babel/helper-create-regexp-features-plugin': 7.22.15(@babel/core@7.23.2) + '@babel/helper-plugin-utils': 7.22.5 + dev: false + + /@babel/plugin-transform-arrow-functions@7.22.5(@babel/core@7.23.2): + resolution: {integrity: sha512-26lTNXoVRdAnsaDXPpvCNUq+OVWEVC6bx7Vvz9rC53F2bagUWW4u4ii2+h8Fejfh7RYqPxn+libeFBBck9muEw==} + engines: {node: '>=6.9.0'} + peerDependencies: + '@babel/core': ^7.0.0-0 + dependencies: + '@babel/core': 7.23.2 + '@babel/helper-plugin-utils': 7.22.5 + dev: false + + /@babel/plugin-transform-async-generator-functions@7.23.2(@babel/core@7.23.2): + resolution: {integrity: sha512-BBYVGxbDVHfoeXbOwcagAkOQAm9NxoTdMGfTqghu1GrvadSaw6iW3Je6IcL5PNOw8VwjxqBECXy50/iCQSY/lQ==} + engines: {node: '>=6.9.0'} + peerDependencies: + '@babel/core': ^7.0.0-0 + dependencies: + '@babel/core': 7.23.2 + '@babel/helper-environment-visitor': 7.22.20 + '@babel/helper-plugin-utils': 7.22.5 + '@babel/helper-remap-async-to-generator': 7.22.20(@babel/core@7.23.2) + '@babel/plugin-syntax-async-generators': 7.8.4(@babel/core@7.23.2) + dev: false + + /@babel/plugin-transform-async-to-generator@7.22.5(@babel/core@7.23.2): + resolution: {integrity: sha512-b1A8D8ZzE/VhNDoV1MSJTnpKkCG5bJo+19R4o4oy03zM7ws8yEMK755j61Dc3EyvdysbqH5BOOTquJ7ZX9C6vQ==} + engines: {node: '>=6.9.0'} + peerDependencies: + '@babel/core': ^7.0.0-0 + dependencies: + '@babel/core': 7.23.2 + '@babel/helper-module-imports': 7.22.15 + '@babel/helper-plugin-utils': 7.22.5 + '@babel/helper-remap-async-to-generator': 7.22.20(@babel/core@7.23.2) + dev: false + + /@babel/plugin-transform-block-scoped-functions@7.22.5(@babel/core@7.23.2): + resolution: {integrity: sha512-tdXZ2UdknEKQWKJP1KMNmuF5Lx3MymtMN/pvA+p/VEkhK8jVcQ1fzSy8KM9qRYhAf2/lV33hoMPKI/xaI9sADA==} + engines: {node: '>=6.9.0'} + peerDependencies: + '@babel/core': ^7.0.0-0 + dependencies: + '@babel/core': 7.23.2 + '@babel/helper-plugin-utils': 7.22.5 + dev: false + + /@babel/plugin-transform-block-scoping@7.23.0(@babel/core@7.23.2): + resolution: {integrity: sha512-cOsrbmIOXmf+5YbL99/S49Y3j46k/T16b9ml8bm9lP6N9US5iQ2yBK7gpui1pg0V/WMcXdkfKbTb7HXq9u+v4g==} + engines: {node: '>=6.9.0'} + peerDependencies: + '@babel/core': ^7.0.0-0 + dependencies: + '@babel/core': 7.23.2 + '@babel/helper-plugin-utils': 7.22.5 + dev: false + + /@babel/plugin-transform-class-properties@7.22.5(@babel/core@7.23.2): + resolution: {integrity: sha512-nDkQ0NfkOhPTq8YCLiWNxp1+f9fCobEjCb0n8WdbNUBc4IB5V7P1QnX9IjpSoquKrXF5SKojHleVNs2vGeHCHQ==} + engines: {node: '>=6.9.0'} + peerDependencies: + '@babel/core': ^7.0.0-0 + dependencies: + '@babel/core': 7.23.2 + '@babel/helper-create-class-features-plugin': 7.22.15(@babel/core@7.23.2) + '@babel/helper-plugin-utils': 7.22.5 + dev: false + + /@babel/plugin-transform-class-static-block@7.22.11(@babel/core@7.23.2): + resolution: {integrity: sha512-GMM8gGmqI7guS/llMFk1bJDkKfn3v3C4KHK9Yg1ey5qcHcOlKb0QvcMrgzvxo+T03/4szNh5lghY+fEC98Kq9g==} + engines: {node: '>=6.9.0'} + peerDependencies: + '@babel/core': ^7.12.0 + dependencies: + '@babel/core': 7.23.2 + '@babel/helper-create-class-features-plugin': 7.22.15(@babel/core@7.23.2) + '@babel/helper-plugin-utils': 7.22.5 + '@babel/plugin-syntax-class-static-block': 7.14.5(@babel/core@7.23.2) + dev: false + + /@babel/plugin-transform-classes@7.22.15(@babel/core@7.23.2): + resolution: {integrity: sha512-VbbC3PGjBdE0wAWDdHM9G8Gm977pnYI0XpqMd6LrKISj8/DJXEsWqgRuTYaNE9Bv0JGhTZUzHDlMk18IpOuoqw==} + engines: {node: '>=6.9.0'} + peerDependencies: + '@babel/core': ^7.0.0-0 + dependencies: + '@babel/core': 7.23.2 + '@babel/helper-annotate-as-pure': 7.22.5 + '@babel/helper-compilation-targets': 7.22.15 + '@babel/helper-environment-visitor': 7.22.20 + '@babel/helper-function-name': 7.23.0 + '@babel/helper-optimise-call-expression': 7.22.5 + '@babel/helper-plugin-utils': 7.22.5 + '@babel/helper-replace-supers': 7.22.20(@babel/core@7.23.2) + '@babel/helper-split-export-declaration': 7.22.6 + globals: 11.12.0 + dev: false + + /@babel/plugin-transform-computed-properties@7.22.5(@babel/core@7.23.2): + resolution: {integrity: sha512-4GHWBgRf0krxPX+AaPtgBAlTgTeZmqDynokHOX7aqqAB4tHs3U2Y02zH6ETFdLZGcg9UQSD1WCmkVrE9ErHeOg==} + engines: {node: '>=6.9.0'} + peerDependencies: + '@babel/core': ^7.0.0-0 + dependencies: + '@babel/core': 7.23.2 + '@babel/helper-plugin-utils': 7.22.5 + '@babel/template': 7.22.15 + dev: false + + /@babel/plugin-transform-destructuring@7.23.0(@babel/core@7.23.2): + resolution: {integrity: sha512-vaMdgNXFkYrB+8lbgniSYWHsgqK5gjaMNcc84bMIOMRLH0L9AqYq3hwMdvnyqj1OPqea8UtjPEuS/DCenah1wg==} + engines: {node: '>=6.9.0'} + peerDependencies: + '@babel/core': ^7.0.0-0 + dependencies: + '@babel/core': 7.23.2 + '@babel/helper-plugin-utils': 7.22.5 + dev: false + + /@babel/plugin-transform-dotall-regex@7.22.5(@babel/core@7.23.2): + resolution: {integrity: sha512-5/Yk9QxCQCl+sOIB1WelKnVRxTJDSAIxtJLL2/pqL14ZVlbH0fUQUZa/T5/UnQtBNgghR7mfB8ERBKyKPCi7Vw==} + engines: {node: '>=6.9.0'} + peerDependencies: + '@babel/core': ^7.0.0-0 + dependencies: + '@babel/core': 7.23.2 + '@babel/helper-create-regexp-features-plugin': 7.22.15(@babel/core@7.23.2) + '@babel/helper-plugin-utils': 7.22.5 + dev: false + + /@babel/plugin-transform-duplicate-keys@7.22.5(@babel/core@7.23.2): + resolution: {integrity: sha512-dEnYD+9BBgld5VBXHnF/DbYGp3fqGMsyxKbtD1mDyIA7AkTSpKXFhCVuj/oQVOoALfBs77DudA0BE4d5mcpmqw==} + engines: {node: '>=6.9.0'} + peerDependencies: + '@babel/core': ^7.0.0-0 + dependencies: + '@babel/core': 7.23.2 + '@babel/helper-plugin-utils': 7.22.5 + dev: false + + /@babel/plugin-transform-dynamic-import@7.22.11(@babel/core@7.23.2): + resolution: {integrity: sha512-g/21plo58sfteWjaO0ZNVb+uEOkJNjAaHhbejrnBmu011l/eNDScmkbjCC3l4FKb10ViaGU4aOkFznSu2zRHgA==} + engines: {node: '>=6.9.0'} + peerDependencies: + '@babel/core': ^7.0.0-0 + dependencies: + '@babel/core': 7.23.2 + '@babel/helper-plugin-utils': 7.22.5 + '@babel/plugin-syntax-dynamic-import': 7.8.3(@babel/core@7.23.2) + dev: false + + /@babel/plugin-transform-exponentiation-operator@7.22.5(@babel/core@7.23.2): + resolution: {integrity: sha512-vIpJFNM/FjZ4rh1myqIya9jXwrwwgFRHPjT3DkUA9ZLHuzox8jiXkOLvwm1H+PQIP3CqfC++WPKeuDi0Sjdj1g==} + engines: {node: '>=6.9.0'} + peerDependencies: + '@babel/core': ^7.0.0-0 + dependencies: + '@babel/core': 7.23.2 + '@babel/helper-builder-binary-assignment-operator-visitor': 7.22.15 + '@babel/helper-plugin-utils': 7.22.5 + dev: false + + /@babel/plugin-transform-export-namespace-from@7.22.11(@babel/core@7.23.2): + resolution: {integrity: sha512-xa7aad7q7OiT8oNZ1mU7NrISjlSkVdMbNxn9IuLZyL9AJEhs1Apba3I+u5riX1dIkdptP5EKDG5XDPByWxtehw==} + engines: {node: '>=6.9.0'} + peerDependencies: + '@babel/core': ^7.0.0-0 + dependencies: + '@babel/core': 7.23.2 + '@babel/helper-plugin-utils': 7.22.5 + '@babel/plugin-syntax-export-namespace-from': 7.8.3(@babel/core@7.23.2) + dev: false + + /@babel/plugin-transform-for-of@7.22.15(@babel/core@7.23.2): + resolution: {integrity: sha512-me6VGeHsx30+xh9fbDLLPi0J1HzmeIIyenoOQHuw2D4m2SAU3NrspX5XxJLBpqn5yrLzrlw2Iy3RA//Bx27iOA==} + engines: {node: '>=6.9.0'} + peerDependencies: + '@babel/core': ^7.0.0-0 + dependencies: + '@babel/core': 7.23.2 + '@babel/helper-plugin-utils': 7.22.5 + dev: false + + /@babel/plugin-transform-function-name@7.22.5(@babel/core@7.23.2): + resolution: {integrity: sha512-UIzQNMS0p0HHiQm3oelztj+ECwFnj+ZRV4KnguvlsD2of1whUeM6o7wGNj6oLwcDoAXQ8gEqfgC24D+VdIcevg==} + engines: {node: '>=6.9.0'} + peerDependencies: + '@babel/core': ^7.0.0-0 + dependencies: + '@babel/core': 7.23.2 + '@babel/helper-compilation-targets': 7.22.15 + '@babel/helper-function-name': 7.23.0 + '@babel/helper-plugin-utils': 7.22.5 + dev: false + + /@babel/plugin-transform-json-strings@7.22.11(@babel/core@7.23.2): + resolution: {integrity: sha512-CxT5tCqpA9/jXFlme9xIBCc5RPtdDq3JpkkhgHQqtDdiTnTI0jtZ0QzXhr5DILeYifDPp2wvY2ad+7+hLMW5Pw==} + engines: {node: '>=6.9.0'} + peerDependencies: + '@babel/core': ^7.0.0-0 + dependencies: + '@babel/core': 7.23.2 + '@babel/helper-plugin-utils': 7.22.5 + '@babel/plugin-syntax-json-strings': 7.8.3(@babel/core@7.23.2) + dev: false + + /@babel/plugin-transform-literals@7.22.5(@babel/core@7.23.2): + resolution: {integrity: sha512-fTLj4D79M+mepcw3dgFBTIDYpbcB9Sm0bpm4ppXPaO+U+PKFFyV9MGRvS0gvGw62sd10kT5lRMKXAADb9pWy8g==} + engines: {node: '>=6.9.0'} + peerDependencies: + '@babel/core': ^7.0.0-0 + dependencies: + '@babel/core': 7.23.2 + '@babel/helper-plugin-utils': 7.22.5 + dev: false + + /@babel/plugin-transform-logical-assignment-operators@7.22.11(@babel/core@7.23.2): + resolution: {integrity: sha512-qQwRTP4+6xFCDV5k7gZBF3C31K34ut0tbEcTKxlX/0KXxm9GLcO14p570aWxFvVzx6QAfPgq7gaeIHXJC8LswQ==} + engines: {node: '>=6.9.0'} + peerDependencies: + '@babel/core': ^7.0.0-0 + dependencies: + '@babel/core': 7.23.2 + '@babel/helper-plugin-utils': 7.22.5 + '@babel/plugin-syntax-logical-assignment-operators': 7.10.4(@babel/core@7.23.2) + dev: false + + /@babel/plugin-transform-member-expression-literals@7.22.5(@babel/core@7.23.2): + resolution: {integrity: sha512-RZEdkNtzzYCFl9SE9ATaUMTj2hqMb4StarOJLrZRbqqU4HSBE7UlBw9WBWQiDzrJZJdUWiMTVDI6Gv/8DPvfew==} + engines: {node: '>=6.9.0'} + peerDependencies: + '@babel/core': ^7.0.0-0 + dependencies: + '@babel/core': 7.23.2 + '@babel/helper-plugin-utils': 7.22.5 + dev: false + + /@babel/plugin-transform-modules-amd@7.23.0(@babel/core@7.23.2): + resolution: {integrity: sha512-xWT5gefv2HGSm4QHtgc1sYPbseOyf+FFDo2JbpE25GWl5BqTGO9IMwTYJRoIdjsF85GE+VegHxSCUt5EvoYTAw==} + engines: {node: '>=6.9.0'} + peerDependencies: + '@babel/core': ^7.0.0-0 + dependencies: + '@babel/core': 7.23.2 + '@babel/helper-module-transforms': 7.23.0(@babel/core@7.23.2) + '@babel/helper-plugin-utils': 7.22.5 + dev: false + + /@babel/plugin-transform-modules-commonjs@7.23.0(@babel/core@7.23.2): + resolution: {integrity: sha512-32Xzss14/UVc7k9g775yMIvkVK8xwKE0DPdP5JTapr3+Z9w4tzeOuLNY6BXDQR6BdnzIlXnCGAzsk/ICHBLVWQ==} + engines: {node: '>=6.9.0'} + peerDependencies: + '@babel/core': ^7.0.0-0 + dependencies: + '@babel/core': 7.23.2 + '@babel/helper-module-transforms': 7.23.0(@babel/core@7.23.2) + '@babel/helper-plugin-utils': 7.22.5 + '@babel/helper-simple-access': 7.22.5 + dev: false + + /@babel/plugin-transform-modules-systemjs@7.23.0(@babel/core@7.23.2): + resolution: {integrity: sha512-qBej6ctXZD2f+DhlOC9yO47yEYgUh5CZNz/aBoH4j/3NOlRfJXJbY7xDQCqQVf9KbrqGzIWER1f23doHGrIHFg==} + engines: {node: '>=6.9.0'} + peerDependencies: + '@babel/core': ^7.0.0-0 + dependencies: + '@babel/core': 7.23.2 + '@babel/helper-hoist-variables': 7.22.5 + '@babel/helper-module-transforms': 7.23.0(@babel/core@7.23.2) + '@babel/helper-plugin-utils': 7.22.5 + '@babel/helper-validator-identifier': 7.22.20 + dev: false + + /@babel/plugin-transform-modules-umd@7.22.5(@babel/core@7.23.2): + resolution: {integrity: sha512-+S6kzefN/E1vkSsKx8kmQuqeQsvCKCd1fraCM7zXm4SFoggI099Tr4G8U81+5gtMdUeMQ4ipdQffbKLX0/7dBQ==} + engines: {node: '>=6.9.0'} + peerDependencies: + '@babel/core': ^7.0.0-0 + dependencies: + '@babel/core': 7.23.2 + '@babel/helper-module-transforms': 7.23.0(@babel/core@7.23.2) + '@babel/helper-plugin-utils': 7.22.5 + dev: false + + /@babel/plugin-transform-named-capturing-groups-regex@7.22.5(@babel/core@7.23.2): + resolution: {integrity: sha512-YgLLKmS3aUBhHaxp5hi1WJTgOUb/NCuDHzGT9z9WTt3YG+CPRhJs6nprbStx6DnWM4dh6gt7SU3sZodbZ08adQ==} + engines: {node: '>=6.9.0'} + peerDependencies: + '@babel/core': ^7.0.0 + dependencies: + '@babel/core': 7.23.2 + '@babel/helper-create-regexp-features-plugin': 7.22.15(@babel/core@7.23.2) + '@babel/helper-plugin-utils': 7.22.5 + dev: false + + /@babel/plugin-transform-new-target@7.22.5(@babel/core@7.23.2): + resolution: {integrity: sha512-AsF7K0Fx/cNKVyk3a+DW0JLo+Ua598/NxMRvxDnkpCIGFh43+h/v2xyhRUYf6oD8gE4QtL83C7zZVghMjHd+iw==} + engines: {node: '>=6.9.0'} + peerDependencies: + '@babel/core': ^7.0.0-0 + dependencies: + '@babel/core': 7.23.2 + '@babel/helper-plugin-utils': 7.22.5 + dev: false + + /@babel/plugin-transform-nullish-coalescing-operator@7.22.11(@babel/core@7.23.2): + resolution: {integrity: sha512-YZWOw4HxXrotb5xsjMJUDlLgcDXSfO9eCmdl1bgW4+/lAGdkjaEvOnQ4p5WKKdUgSzO39dgPl0pTnfxm0OAXcg==} + engines: {node: '>=6.9.0'} + peerDependencies: + '@babel/core': ^7.0.0-0 + dependencies: + '@babel/core': 7.23.2 + '@babel/helper-plugin-utils': 7.22.5 + '@babel/plugin-syntax-nullish-coalescing-operator': 7.8.3(@babel/core@7.23.2) + dev: false + + /@babel/plugin-transform-numeric-separator@7.22.11(@babel/core@7.23.2): + resolution: {integrity: sha512-3dzU4QGPsILdJbASKhF/V2TVP+gJya1PsueQCxIPCEcerqF21oEcrob4mzjsp2Py/1nLfF5m+xYNMDpmA8vffg==} + engines: {node: '>=6.9.0'} + peerDependencies: + '@babel/core': ^7.0.0-0 + dependencies: + '@babel/core': 7.23.2 + '@babel/helper-plugin-utils': 7.22.5 + '@babel/plugin-syntax-numeric-separator': 7.10.4(@babel/core@7.23.2) + dev: false + + /@babel/plugin-transform-object-rest-spread@7.22.15(@babel/core@7.23.2): + resolution: {integrity: sha512-fEB+I1+gAmfAyxZcX1+ZUwLeAuuf8VIg67CTznZE0MqVFumWkh8xWtn58I4dxdVf080wn7gzWoF8vndOViJe9Q==} + engines: {node: '>=6.9.0'} + peerDependencies: + '@babel/core': ^7.0.0-0 + dependencies: + '@babel/compat-data': 7.23.2 + '@babel/core': 7.23.2 + '@babel/helper-compilation-targets': 7.22.15 + '@babel/helper-plugin-utils': 7.22.5 + '@babel/plugin-syntax-object-rest-spread': 7.8.3(@babel/core@7.23.2) + '@babel/plugin-transform-parameters': 7.22.15(@babel/core@7.23.2) + dev: false + + /@babel/plugin-transform-object-super@7.22.5(@babel/core@7.23.2): + resolution: {integrity: sha512-klXqyaT9trSjIUrcsYIfETAzmOEZL3cBYqOYLJxBHfMFFggmXOv+NYSX/Jbs9mzMVESw/WycLFPRx8ba/b2Ipw==} + engines: {node: '>=6.9.0'} + peerDependencies: + '@babel/core': ^7.0.0-0 + dependencies: + '@babel/core': 7.23.2 + '@babel/helper-plugin-utils': 7.22.5 + '@babel/helper-replace-supers': 7.22.20(@babel/core@7.23.2) + dev: false + + /@babel/plugin-transform-optional-catch-binding@7.22.11(@babel/core@7.23.2): + resolution: {integrity: sha512-rli0WxesXUeCJnMYhzAglEjLWVDF6ahb45HuprcmQuLidBJFWjNnOzssk2kuc6e33FlLaiZhG/kUIzUMWdBKaQ==} + engines: {node: '>=6.9.0'} + peerDependencies: + '@babel/core': ^7.0.0-0 + dependencies: + '@babel/core': 7.23.2 + '@babel/helper-plugin-utils': 7.22.5 + '@babel/plugin-syntax-optional-catch-binding': 7.8.3(@babel/core@7.23.2) + dev: false + + /@babel/plugin-transform-optional-chaining@7.23.0(@babel/core@7.23.2): + resolution: {integrity: sha512-sBBGXbLJjxTzLBF5rFWaikMnOGOk/BmK6vVByIdEggZ7Vn6CvWXZyRkkLFK6WE0IF8jSliyOkUN6SScFgzCM0g==} + engines: {node: '>=6.9.0'} + peerDependencies: + '@babel/core': ^7.0.0-0 + dependencies: + '@babel/core': 7.23.2 + '@babel/helper-plugin-utils': 7.22.5 + '@babel/helper-skip-transparent-expression-wrappers': 7.22.5 + '@babel/plugin-syntax-optional-chaining': 7.8.3(@babel/core@7.23.2) + dev: false + + /@babel/plugin-transform-parameters@7.22.15(@babel/core@7.12.9): + resolution: {integrity: sha512-hjk7qKIqhyzhhUvRT683TYQOFa/4cQKwQy7ALvTpODswN40MljzNDa0YldevS6tGbxwaEKVn502JmY0dP7qEtQ==} + engines: {node: '>=6.9.0'} + peerDependencies: + '@babel/core': ^7.0.0-0 + dependencies: + '@babel/core': 7.12.9 + '@babel/helper-plugin-utils': 7.22.5 + dev: false + + /@babel/plugin-transform-parameters@7.22.15(@babel/core@7.23.2): + resolution: {integrity: sha512-hjk7qKIqhyzhhUvRT683TYQOFa/4cQKwQy7ALvTpODswN40MljzNDa0YldevS6tGbxwaEKVn502JmY0dP7qEtQ==} + engines: {node: '>=6.9.0'} + peerDependencies: + '@babel/core': ^7.0.0-0 + dependencies: + '@babel/core': 7.23.2 + '@babel/helper-plugin-utils': 7.22.5 + dev: false + + /@babel/plugin-transform-private-methods@7.22.5(@babel/core@7.23.2): + resolution: {integrity: sha512-PPjh4gyrQnGe97JTalgRGMuU4icsZFnWkzicB/fUtzlKUqvsWBKEpPPfr5a2JiyirZkHxnAqkQMO5Z5B2kK3fA==} + engines: {node: '>=6.9.0'} + peerDependencies: + '@babel/core': ^7.0.0-0 + dependencies: + '@babel/core': 7.23.2 + '@babel/helper-create-class-features-plugin': 7.22.15(@babel/core@7.23.2) + '@babel/helper-plugin-utils': 7.22.5 + dev: false + + /@babel/plugin-transform-private-property-in-object@7.22.11(@babel/core@7.23.2): + resolution: {integrity: sha512-sSCbqZDBKHetvjSwpyWzhuHkmW5RummxJBVbYLkGkaiTOWGxml7SXt0iWa03bzxFIx7wOj3g/ILRd0RcJKBeSQ==} + engines: {node: '>=6.9.0'} + peerDependencies: + '@babel/core': ^7.0.0-0 + dependencies: + '@babel/core': 7.23.2 + '@babel/helper-annotate-as-pure': 7.22.5 + '@babel/helper-create-class-features-plugin': 7.22.15(@babel/core@7.23.2) + '@babel/helper-plugin-utils': 7.22.5 + '@babel/plugin-syntax-private-property-in-object': 7.14.5(@babel/core@7.23.2) + dev: false + + /@babel/plugin-transform-property-literals@7.22.5(@babel/core@7.23.2): + resolution: {integrity: sha512-TiOArgddK3mK/x1Qwf5hay2pxI6wCZnvQqrFSqbtg1GLl2JcNMitVH/YnqjP+M31pLUeTfzY1HAXFDnUBV30rQ==} + engines: {node: '>=6.9.0'} + peerDependencies: + '@babel/core': ^7.0.0-0 + dependencies: + '@babel/core': 7.23.2 + '@babel/helper-plugin-utils': 7.22.5 + dev: false + + /@babel/plugin-transform-react-constant-elements@7.22.5(@babel/core@7.23.2): + resolution: {integrity: sha512-BF5SXoO+nX3h5OhlN78XbbDrBOffv+AxPP2ENaJOVqjWCgBDeOY3WcaUcddutGSfoap+5NEQ/q/4I3WZIvgkXA==} + engines: {node: '>=6.9.0'} + peerDependencies: + '@babel/core': ^7.0.0-0 + dependencies: + '@babel/core': 7.23.2 + '@babel/helper-plugin-utils': 7.22.5 + dev: false + + /@babel/plugin-transform-react-display-name@7.22.5(@babel/core@7.23.2): + resolution: {integrity: sha512-PVk3WPYudRF5z4GKMEYUrLjPl38fJSKNaEOkFuoprioowGuWN6w2RKznuFNSlJx7pzzXXStPUnNSOEO0jL5EVw==} + engines: {node: '>=6.9.0'} + peerDependencies: + '@babel/core': ^7.0.0-0 + dependencies: + '@babel/core': 7.23.2 + '@babel/helper-plugin-utils': 7.22.5 + dev: false + + /@babel/plugin-transform-react-jsx-development@7.22.5(@babel/core@7.23.2): + resolution: {integrity: sha512-bDhuzwWMuInwCYeDeMzyi7TaBgRQei6DqxhbyniL7/VG4RSS7HtSL2QbY4eESy1KJqlWt8g3xeEBGPuo+XqC8A==} + engines: {node: '>=6.9.0'} + peerDependencies: + '@babel/core': ^7.0.0-0 + dependencies: + '@babel/core': 7.23.2 + '@babel/plugin-transform-react-jsx': 7.22.15(@babel/core@7.23.2) + dev: false + + /@babel/plugin-transform-react-jsx@7.22.15(@babel/core@7.23.2): + resolution: {integrity: sha512-oKckg2eZFa8771O/5vi7XeTvmM6+O9cxZu+kanTU7tD4sin5nO/G8jGJhq8Hvt2Z0kUoEDRayuZLaUlYl8QuGA==} + engines: {node: '>=6.9.0'} + peerDependencies: + '@babel/core': ^7.0.0-0 + dependencies: + '@babel/core': 7.23.2 + '@babel/helper-annotate-as-pure': 7.22.5 + '@babel/helper-module-imports': 7.22.15 + '@babel/helper-plugin-utils': 7.22.5 + '@babel/plugin-syntax-jsx': 7.22.5(@babel/core@7.23.2) + '@babel/types': 7.23.0 + dev: false + + /@babel/plugin-transform-react-pure-annotations@7.22.5(@babel/core@7.23.2): + resolution: {integrity: sha512-gP4k85wx09q+brArVinTXhWiyzLl9UpmGva0+mWyKxk6JZequ05x3eUcIUE+FyttPKJFRRVtAvQaJ6YF9h1ZpA==} + engines: {node: '>=6.9.0'} + peerDependencies: + '@babel/core': ^7.0.0-0 + dependencies: + '@babel/core': 7.23.2 + '@babel/helper-annotate-as-pure': 7.22.5 + '@babel/helper-plugin-utils': 7.22.5 + dev: false + + /@babel/plugin-transform-regenerator@7.22.10(@babel/core@7.23.2): + resolution: {integrity: sha512-F28b1mDt8KcT5bUyJc/U9nwzw6cV+UmTeRlXYIl2TNqMMJif0Jeey9/RQ3C4NOd2zp0/TRsDns9ttj2L523rsw==} + engines: {node: '>=6.9.0'} + peerDependencies: + '@babel/core': ^7.0.0-0 + dependencies: + '@babel/core': 7.23.2 + '@babel/helper-plugin-utils': 7.22.5 + regenerator-transform: 0.15.2 + dev: false + + /@babel/plugin-transform-reserved-words@7.22.5(@babel/core@7.23.2): + resolution: {integrity: sha512-DTtGKFRQUDm8svigJzZHzb/2xatPc6TzNvAIJ5GqOKDsGFYgAskjRulbR/vGsPKq3OPqtexnz327qYpP57RFyA==} + engines: {node: '>=6.9.0'} + peerDependencies: + '@babel/core': ^7.0.0-0 + dependencies: + '@babel/core': 7.23.2 + '@babel/helper-plugin-utils': 7.22.5 + dev: false + + /@babel/plugin-transform-runtime@7.23.2(@babel/core@7.23.2): + resolution: {integrity: sha512-XOntj6icgzMS58jPVtQpiuF6ZFWxQiJavISGx5KGjRj+3gqZr8+N6Kx+N9BApWzgS+DOjIZfXXj0ZesenOWDyA==} + engines: {node: '>=6.9.0'} + peerDependencies: + '@babel/core': ^7.0.0-0 + dependencies: + '@babel/core': 7.23.2 + '@babel/helper-module-imports': 7.22.15 + '@babel/helper-plugin-utils': 7.22.5 + babel-plugin-polyfill-corejs2: 0.4.6(@babel/core@7.23.2) + babel-plugin-polyfill-corejs3: 0.8.6(@babel/core@7.23.2) + babel-plugin-polyfill-regenerator: 0.5.3(@babel/core@7.23.2) + semver: 6.3.1 + transitivePeerDependencies: + - supports-color + dev: false + + /@babel/plugin-transform-shorthand-properties@7.22.5(@babel/core@7.23.2): + resolution: {integrity: sha512-vM4fq9IXHscXVKzDv5itkO1X52SmdFBFcMIBZ2FRn2nqVYqw6dBexUgMvAjHW+KXpPPViD/Yo3GrDEBaRC0QYA==} + engines: {node: '>=6.9.0'} + peerDependencies: + '@babel/core': ^7.0.0-0 + dependencies: + '@babel/core': 7.23.2 + '@babel/helper-plugin-utils': 7.22.5 + dev: false + + /@babel/plugin-transform-spread@7.22.5(@babel/core@7.23.2): + resolution: {integrity: sha512-5ZzDQIGyvN4w8+dMmpohL6MBo+l2G7tfC/O2Dg7/hjpgeWvUx8FzfeOKxGog9IimPa4YekaQ9PlDqTLOljkcxg==} + engines: {node: '>=6.9.0'} + peerDependencies: + '@babel/core': ^7.0.0-0 + dependencies: + '@babel/core': 7.23.2 + '@babel/helper-plugin-utils': 7.22.5 + '@babel/helper-skip-transparent-expression-wrappers': 7.22.5 + dev: false + + /@babel/plugin-transform-sticky-regex@7.22.5(@babel/core@7.23.2): + resolution: {integrity: sha512-zf7LuNpHG0iEeiyCNwX4j3gDg1jgt1k3ZdXBKbZSoA3BbGQGvMiSvfbZRR3Dr3aeJe3ooWFZxOOG3IRStYp2Bw==} + engines: {node: '>=6.9.0'} + peerDependencies: + '@babel/core': ^7.0.0-0 + dependencies: + '@babel/core': 7.23.2 + '@babel/helper-plugin-utils': 7.22.5 + dev: false + + /@babel/plugin-transform-template-literals@7.22.5(@babel/core@7.23.2): + resolution: {integrity: sha512-5ciOehRNf+EyUeewo8NkbQiUs4d6ZxiHo6BcBcnFlgiJfu16q0bQUw9Jvo0b0gBKFG1SMhDSjeKXSYuJLeFSMA==} + engines: {node: '>=6.9.0'} + peerDependencies: + '@babel/core': ^7.0.0-0 + dependencies: + '@babel/core': 7.23.2 + '@babel/helper-plugin-utils': 7.22.5 + dev: false + + /@babel/plugin-transform-typeof-symbol@7.22.5(@babel/core@7.23.2): + resolution: {integrity: sha512-bYkI5lMzL4kPii4HHEEChkD0rkc+nvnlR6+o/qdqR6zrm0Sv/nodmyLhlq2DO0YKLUNd2VePmPRjJXSBh9OIdA==} + engines: {node: '>=6.9.0'} + peerDependencies: + '@babel/core': ^7.0.0-0 + dependencies: + '@babel/core': 7.23.2 + '@babel/helper-plugin-utils': 7.22.5 + dev: false + + /@babel/plugin-transform-typescript@7.22.15(@babel/core@7.23.2): + resolution: {integrity: sha512-1uirS0TnijxvQLnlv5wQBwOX3E1wCFX7ITv+9pBV2wKEk4K+M5tqDaoNXnTH8tjEIYHLO98MwiTWO04Ggz4XuA==} + engines: {node: '>=6.9.0'} + peerDependencies: + '@babel/core': ^7.0.0-0 + dependencies: + '@babel/core': 7.23.2 + '@babel/helper-annotate-as-pure': 7.22.5 + '@babel/helper-create-class-features-plugin': 7.22.15(@babel/core@7.23.2) + '@babel/helper-plugin-utils': 7.22.5 + '@babel/plugin-syntax-typescript': 7.22.5(@babel/core@7.23.2) + dev: false + + /@babel/plugin-transform-unicode-escapes@7.22.10(@babel/core@7.23.2): + resolution: {integrity: sha512-lRfaRKGZCBqDlRU3UIFovdp9c9mEvlylmpod0/OatICsSfuQ9YFthRo1tpTkGsklEefZdqlEFdY4A2dwTb6ohg==} + engines: {node: '>=6.9.0'} + peerDependencies: + '@babel/core': ^7.0.0-0 + dependencies: + '@babel/core': 7.23.2 + '@babel/helper-plugin-utils': 7.22.5 + dev: false + + /@babel/plugin-transform-unicode-property-regex@7.22.5(@babel/core@7.23.2): + resolution: {integrity: sha512-HCCIb+CbJIAE6sXn5CjFQXMwkCClcOfPCzTlilJ8cUatfzwHlWQkbtV0zD338u9dZskwvuOYTuuaMaA8J5EI5A==} + engines: {node: '>=6.9.0'} + peerDependencies: + '@babel/core': ^7.0.0-0 + dependencies: + '@babel/core': 7.23.2 + '@babel/helper-create-regexp-features-plugin': 7.22.15(@babel/core@7.23.2) + '@babel/helper-plugin-utils': 7.22.5 + dev: false + + /@babel/plugin-transform-unicode-regex@7.22.5(@babel/core@7.23.2): + resolution: {integrity: sha512-028laaOKptN5vHJf9/Arr/HiJekMd41hOEZYvNsrsXqJ7YPYuX2bQxh31fkZzGmq3YqHRJzYFFAVYvKfMPKqyg==} + engines: {node: '>=6.9.0'} + peerDependencies: + '@babel/core': ^7.0.0-0 + dependencies: + '@babel/core': 7.23.2 + '@babel/helper-create-regexp-features-plugin': 7.22.15(@babel/core@7.23.2) + '@babel/helper-plugin-utils': 7.22.5 + dev: false + + /@babel/plugin-transform-unicode-sets-regex@7.22.5(@babel/core@7.23.2): + resolution: {integrity: sha512-lhMfi4FC15j13eKrh3DnYHjpGj6UKQHtNKTbtc1igvAhRy4+kLhV07OpLcsN0VgDEw/MjAvJO4BdMJsHwMhzCg==} + engines: {node: '>=6.9.0'} + peerDependencies: + '@babel/core': ^7.0.0 + dependencies: + '@babel/core': 7.23.2 + '@babel/helper-create-regexp-features-plugin': 7.22.15(@babel/core@7.23.2) + '@babel/helper-plugin-utils': 7.22.5 + dev: false + + /@babel/preset-env@7.23.2(@babel/core@7.23.2): + resolution: {integrity: sha512-BW3gsuDD+rvHL2VO2SjAUNTBe5YrjsTiDyqamPDWY723na3/yPQ65X5oQkFVJZ0o50/2d+svm1rkPoJeR1KxVQ==} + engines: {node: '>=6.9.0'} + peerDependencies: + '@babel/core': ^7.0.0-0 + dependencies: + '@babel/compat-data': 7.23.2 + '@babel/core': 7.23.2 + '@babel/helper-compilation-targets': 7.22.15 + '@babel/helper-plugin-utils': 7.22.5 + '@babel/helper-validator-option': 7.22.15 + '@babel/plugin-bugfix-safari-id-destructuring-collision-in-function-expression': 7.22.15(@babel/core@7.23.2) + '@babel/plugin-bugfix-v8-spread-parameters-in-optional-chaining': 7.22.15(@babel/core@7.23.2) + '@babel/plugin-proposal-private-property-in-object': 7.21.0-placeholder-for-preset-env.2(@babel/core@7.23.2) + '@babel/plugin-syntax-async-generators': 7.8.4(@babel/core@7.23.2) + '@babel/plugin-syntax-class-properties': 7.12.13(@babel/core@7.23.2) + '@babel/plugin-syntax-class-static-block': 7.14.5(@babel/core@7.23.2) + '@babel/plugin-syntax-dynamic-import': 7.8.3(@babel/core@7.23.2) + '@babel/plugin-syntax-export-namespace-from': 7.8.3(@babel/core@7.23.2) + '@babel/plugin-syntax-import-assertions': 7.22.5(@babel/core@7.23.2) + '@babel/plugin-syntax-import-attributes': 7.22.5(@babel/core@7.23.2) + '@babel/plugin-syntax-import-meta': 7.10.4(@babel/core@7.23.2) + '@babel/plugin-syntax-json-strings': 7.8.3(@babel/core@7.23.2) + '@babel/plugin-syntax-logical-assignment-operators': 7.10.4(@babel/core@7.23.2) + '@babel/plugin-syntax-nullish-coalescing-operator': 7.8.3(@babel/core@7.23.2) + '@babel/plugin-syntax-numeric-separator': 7.10.4(@babel/core@7.23.2) + '@babel/plugin-syntax-object-rest-spread': 7.8.3(@babel/core@7.23.2) + '@babel/plugin-syntax-optional-catch-binding': 7.8.3(@babel/core@7.23.2) + '@babel/plugin-syntax-optional-chaining': 7.8.3(@babel/core@7.23.2) + '@babel/plugin-syntax-private-property-in-object': 7.14.5(@babel/core@7.23.2) + '@babel/plugin-syntax-top-level-await': 7.14.5(@babel/core@7.23.2) + '@babel/plugin-syntax-unicode-sets-regex': 7.18.6(@babel/core@7.23.2) + '@babel/plugin-transform-arrow-functions': 7.22.5(@babel/core@7.23.2) + '@babel/plugin-transform-async-generator-functions': 7.23.2(@babel/core@7.23.2) + '@babel/plugin-transform-async-to-generator': 7.22.5(@babel/core@7.23.2) + '@babel/plugin-transform-block-scoped-functions': 7.22.5(@babel/core@7.23.2) + '@babel/plugin-transform-block-scoping': 7.23.0(@babel/core@7.23.2) + '@babel/plugin-transform-class-properties': 7.22.5(@babel/core@7.23.2) + '@babel/plugin-transform-class-static-block': 7.22.11(@babel/core@7.23.2) + '@babel/plugin-transform-classes': 7.22.15(@babel/core@7.23.2) + '@babel/plugin-transform-computed-properties': 7.22.5(@babel/core@7.23.2) + '@babel/plugin-transform-destructuring': 7.23.0(@babel/core@7.23.2) + '@babel/plugin-transform-dotall-regex': 7.22.5(@babel/core@7.23.2) + '@babel/plugin-transform-duplicate-keys': 7.22.5(@babel/core@7.23.2) + '@babel/plugin-transform-dynamic-import': 7.22.11(@babel/core@7.23.2) + '@babel/plugin-transform-exponentiation-operator': 7.22.5(@babel/core@7.23.2) + '@babel/plugin-transform-export-namespace-from': 7.22.11(@babel/core@7.23.2) + '@babel/plugin-transform-for-of': 7.22.15(@babel/core@7.23.2) + '@babel/plugin-transform-function-name': 7.22.5(@babel/core@7.23.2) + '@babel/plugin-transform-json-strings': 7.22.11(@babel/core@7.23.2) + '@babel/plugin-transform-literals': 7.22.5(@babel/core@7.23.2) + '@babel/plugin-transform-logical-assignment-operators': 7.22.11(@babel/core@7.23.2) + '@babel/plugin-transform-member-expression-literals': 7.22.5(@babel/core@7.23.2) + '@babel/plugin-transform-modules-amd': 7.23.0(@babel/core@7.23.2) + '@babel/plugin-transform-modules-commonjs': 7.23.0(@babel/core@7.23.2) + '@babel/plugin-transform-modules-systemjs': 7.23.0(@babel/core@7.23.2) + '@babel/plugin-transform-modules-umd': 7.22.5(@babel/core@7.23.2) + '@babel/plugin-transform-named-capturing-groups-regex': 7.22.5(@babel/core@7.23.2) + '@babel/plugin-transform-new-target': 7.22.5(@babel/core@7.23.2) + '@babel/plugin-transform-nullish-coalescing-operator': 7.22.11(@babel/core@7.23.2) + '@babel/plugin-transform-numeric-separator': 7.22.11(@babel/core@7.23.2) + '@babel/plugin-transform-object-rest-spread': 7.22.15(@babel/core@7.23.2) + '@babel/plugin-transform-object-super': 7.22.5(@babel/core@7.23.2) + '@babel/plugin-transform-optional-catch-binding': 7.22.11(@babel/core@7.23.2) + '@babel/plugin-transform-optional-chaining': 7.23.0(@babel/core@7.23.2) + '@babel/plugin-transform-parameters': 7.22.15(@babel/core@7.23.2) + '@babel/plugin-transform-private-methods': 7.22.5(@babel/core@7.23.2) + '@babel/plugin-transform-private-property-in-object': 7.22.11(@babel/core@7.23.2) + '@babel/plugin-transform-property-literals': 7.22.5(@babel/core@7.23.2) + '@babel/plugin-transform-regenerator': 7.22.10(@babel/core@7.23.2) + '@babel/plugin-transform-reserved-words': 7.22.5(@babel/core@7.23.2) + '@babel/plugin-transform-shorthand-properties': 7.22.5(@babel/core@7.23.2) + '@babel/plugin-transform-spread': 7.22.5(@babel/core@7.23.2) + '@babel/plugin-transform-sticky-regex': 7.22.5(@babel/core@7.23.2) + '@babel/plugin-transform-template-literals': 7.22.5(@babel/core@7.23.2) + '@babel/plugin-transform-typeof-symbol': 7.22.5(@babel/core@7.23.2) + '@babel/plugin-transform-unicode-escapes': 7.22.10(@babel/core@7.23.2) + '@babel/plugin-transform-unicode-property-regex': 7.22.5(@babel/core@7.23.2) + '@babel/plugin-transform-unicode-regex': 7.22.5(@babel/core@7.23.2) + '@babel/plugin-transform-unicode-sets-regex': 7.22.5(@babel/core@7.23.2) + '@babel/preset-modules': 0.1.6-no-external-plugins(@babel/core@7.23.2) + '@babel/types': 7.23.0 + babel-plugin-polyfill-corejs2: 0.4.6(@babel/core@7.23.2) + babel-plugin-polyfill-corejs3: 0.8.6(@babel/core@7.23.2) + babel-plugin-polyfill-regenerator: 0.5.3(@babel/core@7.23.2) + core-js-compat: 3.33.1 + semver: 6.3.1 + transitivePeerDependencies: + - supports-color + dev: false + + /@babel/preset-modules@0.1.6-no-external-plugins(@babel/core@7.23.2): + resolution: {integrity: sha512-HrcgcIESLm9aIR842yhJ5RWan/gebQUJ6E/E5+rf0y9o6oj7w0Br+sWuL6kEQ/o/AdfvR1Je9jG18/gnpwjEyA==} + peerDependencies: + '@babel/core': ^7.0.0-0 || ^8.0.0-0 <8.0.0 + dependencies: + '@babel/core': 7.23.2 + '@babel/helper-plugin-utils': 7.22.5 + '@babel/types': 7.23.0 + esutils: 2.0.3 + dev: false + + /@babel/preset-react@7.22.15(@babel/core@7.23.2): + resolution: {integrity: sha512-Csy1IJ2uEh/PecCBXXoZGAZBeCATTuePzCSB7dLYWS0vOEj6CNpjxIhW4duWwZodBNueH7QO14WbGn8YyeuN9w==} + engines: {node: '>=6.9.0'} + peerDependencies: + '@babel/core': ^7.0.0-0 + dependencies: + '@babel/core': 7.23.2 + '@babel/helper-plugin-utils': 7.22.5 + '@babel/helper-validator-option': 7.22.15 + '@babel/plugin-transform-react-display-name': 7.22.5(@babel/core@7.23.2) + '@babel/plugin-transform-react-jsx': 7.22.15(@babel/core@7.23.2) + '@babel/plugin-transform-react-jsx-development': 7.22.5(@babel/core@7.23.2) + '@babel/plugin-transform-react-pure-annotations': 7.22.5(@babel/core@7.23.2) + dev: false + + /@babel/preset-typescript@7.23.2(@babel/core@7.23.2): + resolution: {integrity: sha512-u4UJc1XsS1GhIGteM8rnGiIvf9rJpiVgMEeCnwlLA7WJPC+jcXWJAGxYmeqs5hOZD8BbAfnV5ezBOxQbb4OUxA==} + engines: {node: '>=6.9.0'} + peerDependencies: + '@babel/core': ^7.0.0-0 + dependencies: + '@babel/core': 7.23.2 + '@babel/helper-plugin-utils': 7.22.5 + '@babel/helper-validator-option': 7.22.15 + '@babel/plugin-syntax-jsx': 7.22.5(@babel/core@7.23.2) + '@babel/plugin-transform-modules-commonjs': 7.23.0(@babel/core@7.23.2) + '@babel/plugin-transform-typescript': 7.22.15(@babel/core@7.23.2) + dev: false + + /@babel/regjsgen@0.8.0: + resolution: {integrity: sha512-x/rqGMdzj+fWZvCOYForTghzbtqPDZ5gPwaoNGHdgDfF2QA/XZbCBp4Moo5scrkAMPhB7z26XM/AaHuIJdgauA==} + dev: false + + /@babel/runtime-corejs3@7.23.2: + resolution: {integrity: sha512-54cIh74Z1rp4oIjsHjqN+WM4fMyCBYe+LpZ9jWm51CZ1fbH3SkAzQD/3XLoNkjbJ7YEmjobLXyvQrFypRHOrXw==} + engines: {node: '>=6.9.0'} + dependencies: + core-js-pure: 3.33.1 + regenerator-runtime: 0.14.0 + dev: false + + /@babel/runtime@7.23.2: + resolution: {integrity: sha512-mM8eg4yl5D6i3lu2QKPuPH4FArvJ8KhTofbE7jwMUv9KX5mBvwPAqnV3MlyBNqdp9RyRKP6Yck8TrfYrPvX3bg==} + engines: {node: '>=6.9.0'} + dependencies: + regenerator-runtime: 0.14.0 + + /@babel/template@7.22.15: + resolution: {integrity: sha512-QPErUVm4uyJa60rkI73qneDacvdvzxshT3kksGqlGWYdOTIUOwJ7RDUL8sGqslY1uXWSL6xMFKEXDS3ox2uF0w==} + engines: {node: '>=6.9.0'} + dependencies: + '@babel/code-frame': 7.22.13 + '@babel/parser': 7.23.0 + '@babel/types': 7.23.0 + dev: false + + /@babel/traverse@7.23.2: + resolution: {integrity: sha512-azpe59SQ48qG6nu2CzcMLbxUudtN+dOM9kDbUqGq3HXUJRlo7i8fvPoxQUzYgLZ4cMVmuZgm8vvBpNeRhd6XSw==} + engines: {node: '>=6.9.0'} + dependencies: + '@babel/code-frame': 7.22.13 + '@babel/generator': 7.23.0 + '@babel/helper-environment-visitor': 7.22.20 + '@babel/helper-function-name': 7.23.0 + '@babel/helper-hoist-variables': 7.22.5 + '@babel/helper-split-export-declaration': 7.22.6 + '@babel/parser': 7.23.0 + '@babel/types': 7.23.0 + debug: 4.3.4 + globals: 11.12.0 + transitivePeerDependencies: + - supports-color + dev: false + + /@babel/types@7.23.0: + resolution: {integrity: sha512-0oIyUfKoI3mSqMvsxBdclDwxXKXAUA8v/apZbc+iSyARYou1o8ZGDxbUYyLFoW2arqS2jDGqJuZvv1d/io1axg==} + engines: {node: '>=6.9.0'} + dependencies: + '@babel/helper-string-parser': 7.22.5 + '@babel/helper-validator-identifier': 7.22.20 + to-fast-properties: 2.0.0 + dev: false + + /@colors/colors@1.5.0: + resolution: {integrity: sha512-ooWCrlZP11i8GImSjTHYHLkvFDP48nS4+204nGb1RiX/WXYHmJA2III9/e2DWVabCESdW7hBAEzHRqUn9OUVvQ==} + engines: {node: '>=0.1.90'} + requiresBuild: true + dev: false + optional: true + + /@discoveryjs/json-ext@0.5.7: + resolution: {integrity: sha512-dBVuXR082gk3jsFp7Rd/JI4kytwGHecnCoTtXFb7DB6CNHp4rg5k1bhg0nWdLGLnOV71lmDzGQaLMy8iPLY0pw==} + engines: {node: '>=10.0.0'} + dev: false + + /@docsearch/css@3.5.2: + resolution: {integrity: sha512-SPiDHaWKQZpwR2siD0KQUwlStvIAnEyK6tAE2h2Wuoq8ue9skzhlyVQ1ddzOxX6khULnAALDiR/isSF3bnuciA==} + dev: false + + /@docsearch/react@3.5.2(@algolia/client-search@4.20.0)(react-dom@17.0.2)(react@17.0.2)(search-insights@2.9.0): + resolution: {integrity: sha512-9Ahcrs5z2jq/DcAvYtvlqEBHImbm4YJI8M9y0x6Tqg598P40HTEkX7hsMcIuThI+hTFxRGZ9hll0Wygm2yEjng==} + peerDependencies: + '@types/react': '>= 16.8.0 < 19.0.0' + react: '>= 16.8.0 < 19.0.0' + react-dom: '>= 16.8.0 < 19.0.0' + search-insights: '>= 1 < 3' + peerDependenciesMeta: + '@types/react': + optional: true + react: + optional: true + react-dom: + optional: true + search-insights: + optional: true + dependencies: + '@algolia/autocomplete-core': 1.9.3(@algolia/client-search@4.20.0)(algoliasearch@4.20.0)(search-insights@2.9.0) + '@algolia/autocomplete-preset-algolia': 1.9.3(@algolia/client-search@4.20.0)(algoliasearch@4.20.0) + '@docsearch/css': 3.5.2 + algoliasearch: 4.20.0 + react: 17.0.2 + react-dom: 17.0.2(react@17.0.2) + search-insights: 2.9.0 + transitivePeerDependencies: + - '@algolia/client-search' + dev: false + + /@docusaurus/core@2.4.3(@docusaurus/types@2.4.3)(react-dom@17.0.2)(react@17.0.2)(typescript@4.9.5): + resolution: {integrity: sha512-dWH5P7cgeNSIg9ufReX6gaCl/TmrGKD38Orbwuz05WPhAQtFXHd5B8Qym1TiXfvUNvwoYKkAJOJuGe8ou0Z7PA==} + engines: {node: '>=16.14'} + hasBin: true + peerDependencies: + react: ^16.8.4 || ^17.0.0 + react-dom: ^16.8.4 || ^17.0.0 + dependencies: + '@babel/core': 7.23.2 + '@babel/generator': 7.23.0 + '@babel/plugin-syntax-dynamic-import': 7.8.3(@babel/core@7.23.2) + '@babel/plugin-transform-runtime': 7.23.2(@babel/core@7.23.2) + '@babel/preset-env': 7.23.2(@babel/core@7.23.2) + '@babel/preset-react': 7.22.15(@babel/core@7.23.2) + '@babel/preset-typescript': 7.23.2(@babel/core@7.23.2) + '@babel/runtime': 7.23.2 + '@babel/runtime-corejs3': 7.23.2 + '@babel/traverse': 7.23.2 + '@docusaurus/cssnano-preset': 2.4.3 + '@docusaurus/logger': 2.4.3 + '@docusaurus/mdx-loader': 2.4.3(@docusaurus/types@2.4.3)(react-dom@17.0.2)(react@17.0.2) + '@docusaurus/react-loadable': 5.5.2(react@17.0.2) + '@docusaurus/utils': 2.4.3(@docusaurus/types@2.4.3) + '@docusaurus/utils-common': 2.4.3(@docusaurus/types@2.4.3) + '@docusaurus/utils-validation': 2.4.3(@docusaurus/types@2.4.3) + '@slorber/static-site-generator-webpack-plugin': 4.0.7 + '@svgr/webpack': 6.5.1 + autoprefixer: 10.4.16(postcss@8.4.31) + babel-loader: 8.3.0(@babel/core@7.23.2)(webpack@5.89.0) + babel-plugin-dynamic-import-node: 2.3.3 + boxen: 6.2.1 + chalk: 4.1.2 + chokidar: 3.5.3 + clean-css: 5.3.2 + cli-table3: 0.6.3 + combine-promises: 1.2.0 + commander: 5.1.0 + copy-webpack-plugin: 11.0.0(webpack@5.89.0) + core-js: 3.33.1 + css-loader: 6.8.1(webpack@5.89.0) + css-minimizer-webpack-plugin: 4.2.2(clean-css@5.3.2)(webpack@5.89.0) + cssnano: 5.1.15(postcss@8.4.31) + del: 6.1.1 + detect-port: 1.5.1 + escape-html: 1.0.3 + eta: 2.2.0 + file-loader: 6.2.0(webpack@5.89.0) + fs-extra: 10.1.0 + html-minifier-terser: 6.1.0 + html-tags: 3.3.1 + html-webpack-plugin: 5.5.3(webpack@5.89.0) + import-fresh: 3.3.0 + leven: 3.1.0 + lodash: 4.17.21 + mini-css-extract-plugin: 2.7.6(webpack@5.89.0) + postcss: 8.4.31 + postcss-loader: 7.3.3(postcss@8.4.31)(typescript@4.9.5)(webpack@5.89.0) + prompts: 2.4.2 + react: 17.0.2 + react-dev-utils: 12.0.1(typescript@4.9.5)(webpack@5.89.0) + react-dom: 17.0.2(react@17.0.2) + react-helmet-async: 1.3.0(react-dom@17.0.2)(react@17.0.2) + react-loadable: /@docusaurus/react-loadable@5.5.2(react@17.0.2) + react-loadable-ssr-addon-v5-slorber: 1.0.1(@docusaurus/react-loadable@5.5.2)(webpack@5.89.0) + react-router: 5.3.4(react@17.0.2) + react-router-config: 5.1.1(react-router@5.3.4)(react@17.0.2) + react-router-dom: 5.3.4(react@17.0.2) + rtl-detect: 1.1.2 + semver: 7.5.4 + serve-handler: 6.1.5 + shelljs: 0.8.5 + terser-webpack-plugin: 5.3.9(webpack@5.89.0) + tslib: 2.6.2 + update-notifier: 5.1.0 + url-loader: 4.1.1(file-loader@6.2.0)(webpack@5.89.0) + wait-on: 6.0.1 + webpack: 5.89.0 + webpack-bundle-analyzer: 4.9.1 + webpack-dev-server: 4.15.1(webpack@5.89.0) + webpack-merge: 5.10.0 + webpackbar: 5.0.2(webpack@5.89.0) + transitivePeerDependencies: + - '@docusaurus/types' + - '@parcel/css' + - '@swc/core' + - '@swc/css' + - bufferutil + - csso + - debug + - esbuild + - eslint + - lightningcss + - supports-color + - typescript + - uglify-js + - utf-8-validate + - vue-template-compiler + - webpack-cli + dev: false + + /@docusaurus/cssnano-preset@2.4.3: + resolution: {integrity: sha512-ZvGSRCi7z9wLnZrXNPG6DmVPHdKGd8dIn9pYbEOFiYihfv4uDR3UtxogmKf+rT8ZlKFf5Lqne8E8nt08zNM8CA==} + engines: {node: '>=16.14'} + dependencies: + cssnano-preset-advanced: 5.3.10(postcss@8.4.31) + postcss: 8.4.31 + postcss-sort-media-queries: 4.4.1(postcss@8.4.31) + tslib: 2.6.2 + dev: false + + /@docusaurus/logger@2.4.3: + resolution: {integrity: sha512-Zxws7r3yLufk9xM1zq9ged0YHs65mlRmtsobnFkdZTxWXdTYlWWLWdKyNKAsVC+D7zg+pv2fGbyabdOnyZOM3w==} + engines: {node: '>=16.14'} + dependencies: + chalk: 4.1.2 + tslib: 2.6.2 + dev: false + + /@docusaurus/mdx-loader@2.4.3(@docusaurus/types@2.4.3)(react-dom@17.0.2)(react@17.0.2): + resolution: {integrity: sha512-b1+fDnWtl3GiqkL0BRjYtc94FZrcDDBV1j8446+4tptB9BAOlePwG2p/pK6vGvfL53lkOsszXMghr2g67M0vCw==} + engines: {node: '>=16.14'} + peerDependencies: + react: ^16.8.4 || ^17.0.0 + react-dom: ^16.8.4 || ^17.0.0 + dependencies: + '@babel/parser': 7.23.0 + '@babel/traverse': 7.23.2 + '@docusaurus/logger': 2.4.3 + '@docusaurus/utils': 2.4.3(@docusaurus/types@2.4.3) + '@mdx-js/mdx': 1.6.22 + escape-html: 1.0.3 + file-loader: 6.2.0(webpack@5.89.0) + fs-extra: 10.1.0 + image-size: 1.0.2 + mdast-util-to-string: 2.0.0 + react: 17.0.2 + react-dom: 17.0.2(react@17.0.2) + remark-emoji: 2.2.0 + stringify-object: 3.3.0 + tslib: 2.6.2 + unified: 9.2.2 + unist-util-visit: 2.0.3 + url-loader: 4.1.1(file-loader@6.2.0)(webpack@5.89.0) + webpack: 5.89.0 + transitivePeerDependencies: + - '@docusaurus/types' + - '@swc/core' + - esbuild + - supports-color + - uglify-js + - webpack-cli + dev: false + + /@docusaurus/module-type-aliases@2.4.3(react-dom@17.0.2)(react@17.0.2): + resolution: {integrity: sha512-cwkBkt1UCiduuvEAo7XZY01dJfRn7UR/75mBgOdb1hKknhrabJZ8YH+7savd/y9kLExPyrhe0QwdS9GuzsRRIA==} + peerDependencies: + react: '*' + react-dom: '*' + dependencies: + '@docusaurus/react-loadable': 5.5.2(react@17.0.2) + '@docusaurus/types': 2.4.3(react-dom@17.0.2)(react@17.0.2) + '@types/history': 4.7.11 + '@types/react': 18.2.33 + '@types/react-router-config': 5.0.9 + '@types/react-router-dom': 5.3.3 + react: 17.0.2 + react-dom: 17.0.2(react@17.0.2) + react-helmet-async: 1.3.0(react-dom@17.0.2)(react@17.0.2) + react-loadable: /@docusaurus/react-loadable@5.5.2(react@17.0.2) + transitivePeerDependencies: + - '@swc/core' + - esbuild + - uglify-js + - webpack-cli + + /@docusaurus/plugin-client-redirects@2.4.3(react-dom@17.0.2)(react@17.0.2)(typescript@4.9.5): + resolution: {integrity: sha512-iCwc/zH8X6eNtLYdyUJFY6+GbsbRgMgvAC/TmSmCYTmwnoN5Y1Bc5OwUkdtoch0XKizotJMRAmGIAhP8sAetdQ==} + engines: {node: '>=16.14'} + peerDependencies: + react: ^16.8.4 || ^17.0.0 + react-dom: ^16.8.4 || ^17.0.0 + dependencies: + '@docusaurus/core': 2.4.3(@docusaurus/types@2.4.3)(react-dom@17.0.2)(react@17.0.2)(typescript@4.9.5) + '@docusaurus/logger': 2.4.3 + '@docusaurus/utils': 2.4.3(@docusaurus/types@2.4.3) + '@docusaurus/utils-common': 2.4.3(@docusaurus/types@2.4.3) + '@docusaurus/utils-validation': 2.4.3(@docusaurus/types@2.4.3) + eta: 2.2.0 + fs-extra: 10.1.0 + lodash: 4.17.21 + react: 17.0.2 + react-dom: 17.0.2(react@17.0.2) + tslib: 2.6.2 + transitivePeerDependencies: + - '@docusaurus/types' + - '@parcel/css' + - '@swc/core' + - '@swc/css' + - bufferutil + - csso + - debug + - esbuild + - eslint + - lightningcss + - supports-color + - typescript + - uglify-js + - utf-8-validate + - vue-template-compiler + - webpack-cli + dev: false + + /@docusaurus/plugin-content-blog@2.4.3(react-dom@17.0.2)(react@17.0.2)(typescript@4.9.5): + resolution: {integrity: sha512-PVhypqaA0t98zVDpOeTqWUTvRqCEjJubtfFUQ7zJNYdbYTbS/E/ytq6zbLVsN/dImvemtO/5JQgjLxsh8XLo8Q==} + engines: {node: '>=16.14'} + peerDependencies: + react: ^16.8.4 || ^17.0.0 + react-dom: ^16.8.4 || ^17.0.0 + dependencies: + '@docusaurus/core': 2.4.3(@docusaurus/types@2.4.3)(react-dom@17.0.2)(react@17.0.2)(typescript@4.9.5) + '@docusaurus/logger': 2.4.3 + '@docusaurus/mdx-loader': 2.4.3(@docusaurus/types@2.4.3)(react-dom@17.0.2)(react@17.0.2) + '@docusaurus/types': 2.4.3(react-dom@17.0.2)(react@17.0.2) + '@docusaurus/utils': 2.4.3(@docusaurus/types@2.4.3) + '@docusaurus/utils-common': 2.4.3(@docusaurus/types@2.4.3) + '@docusaurus/utils-validation': 2.4.3(@docusaurus/types@2.4.3) + cheerio: 1.0.0-rc.12 + feed: 4.2.2 + fs-extra: 10.1.0 + lodash: 4.17.21 + react: 17.0.2 + react-dom: 17.0.2(react@17.0.2) + reading-time: 1.5.0 + tslib: 2.6.2 + unist-util-visit: 2.0.3 + utility-types: 3.10.0 + webpack: 5.89.0 + transitivePeerDependencies: + - '@parcel/css' + - '@swc/core' + - '@swc/css' + - bufferutil + - csso + - debug + - esbuild + - eslint + - lightningcss + - supports-color + - typescript + - uglify-js + - utf-8-validate + - vue-template-compiler + - webpack-cli + dev: false + + /@docusaurus/plugin-content-docs@2.4.3(react-dom@17.0.2)(react@17.0.2)(typescript@4.9.5): + resolution: {integrity: sha512-N7Po2LSH6UejQhzTCsvuX5NOzlC+HiXOVvofnEPj0WhMu1etpLEXE6a4aTxrtg95lQ5kf0xUIdjX9sh3d3G76A==} + engines: {node: '>=16.14'} + peerDependencies: + react: ^16.8.4 || ^17.0.0 + react-dom: ^16.8.4 || ^17.0.0 + dependencies: + '@docusaurus/core': 2.4.3(@docusaurus/types@2.4.3)(react-dom@17.0.2)(react@17.0.2)(typescript@4.9.5) + '@docusaurus/logger': 2.4.3 + '@docusaurus/mdx-loader': 2.4.3(@docusaurus/types@2.4.3)(react-dom@17.0.2)(react@17.0.2) + '@docusaurus/module-type-aliases': 2.4.3(react-dom@17.0.2)(react@17.0.2) + '@docusaurus/types': 2.4.3(react-dom@17.0.2)(react@17.0.2) + '@docusaurus/utils': 2.4.3(@docusaurus/types@2.4.3) + '@docusaurus/utils-validation': 2.4.3(@docusaurus/types@2.4.3) + '@types/react-router-config': 5.0.9 + combine-promises: 1.2.0 + fs-extra: 10.1.0 + import-fresh: 3.3.0 + js-yaml: 4.1.0 + lodash: 4.17.21 + react: 17.0.2 + react-dom: 17.0.2(react@17.0.2) + tslib: 2.6.2 + utility-types: 3.10.0 + webpack: 5.89.0 + transitivePeerDependencies: + - '@parcel/css' + - '@swc/core' + - '@swc/css' + - bufferutil + - csso + - debug + - esbuild + - eslint + - lightningcss + - supports-color + - typescript + - uglify-js + - utf-8-validate + - vue-template-compiler + - webpack-cli + dev: false + + /@docusaurus/plugin-content-pages@2.4.3(react-dom@17.0.2)(react@17.0.2)(typescript@4.9.5): + resolution: {integrity: sha512-txtDVz7y3zGk67q0HjG0gRttVPodkHqE0bpJ+7dOaTH40CQFLSh7+aBeGnPOTl+oCPG+hxkim4SndqPqXjQ8Bg==} + engines: {node: '>=16.14'} + peerDependencies: + react: ^16.8.4 || ^17.0.0 + react-dom: ^16.8.4 || ^17.0.0 + dependencies: + '@docusaurus/core': 2.4.3(@docusaurus/types@2.4.3)(react-dom@17.0.2)(react@17.0.2)(typescript@4.9.5) + '@docusaurus/mdx-loader': 2.4.3(@docusaurus/types@2.4.3)(react-dom@17.0.2)(react@17.0.2) + '@docusaurus/types': 2.4.3(react-dom@17.0.2)(react@17.0.2) + '@docusaurus/utils': 2.4.3(@docusaurus/types@2.4.3) + '@docusaurus/utils-validation': 2.4.3(@docusaurus/types@2.4.3) + fs-extra: 10.1.0 + react: 17.0.2 + react-dom: 17.0.2(react@17.0.2) + tslib: 2.6.2 + webpack: 5.89.0 + transitivePeerDependencies: + - '@parcel/css' + - '@swc/core' + - '@swc/css' + - bufferutil + - csso + - debug + - esbuild + - eslint + - lightningcss + - supports-color + - typescript + - uglify-js + - utf-8-validate + - vue-template-compiler + - webpack-cli + dev: false + + /@docusaurus/plugin-debug@2.4.3(react-dom@17.0.2)(react@17.0.2)(typescript@4.9.5): + resolution: {integrity: sha512-LkUbuq3zCmINlFb+gAd4ZvYr+bPAzMC0hwND4F7V9bZ852dCX8YoWyovVUBKq4er1XsOwSQaHmNGtObtn8Av8Q==} + engines: {node: '>=16.14'} + peerDependencies: + react: ^16.8.4 || ^17.0.0 + react-dom: ^16.8.4 || ^17.0.0 + dependencies: + '@docusaurus/core': 2.4.3(@docusaurus/types@2.4.3)(react-dom@17.0.2)(react@17.0.2)(typescript@4.9.5) + '@docusaurus/types': 2.4.3(react-dom@17.0.2)(react@17.0.2) + '@docusaurus/utils': 2.4.3(@docusaurus/types@2.4.3) + fs-extra: 10.1.0 + react: 17.0.2 + react-dom: 17.0.2(react@17.0.2) + react-json-view: 1.21.3(react-dom@17.0.2)(react@17.0.2) + tslib: 2.6.2 + transitivePeerDependencies: + - '@parcel/css' + - '@swc/core' + - '@swc/css' + - '@types/react' + - bufferutil + - csso + - debug + - encoding + - esbuild + - eslint + - lightningcss + - supports-color + - typescript + - uglify-js + - utf-8-validate + - vue-template-compiler + - webpack-cli + dev: false + + /@docusaurus/plugin-google-analytics@2.4.3(react-dom@17.0.2)(react@17.0.2)(typescript@4.9.5): + resolution: {integrity: sha512-KzBV3k8lDkWOhg/oYGxlK5o9bOwX7KpPc/FTWoB+SfKhlHfhq7qcQdMi1elAaVEIop8tgK6gD1E58Q+XC6otSQ==} + engines: {node: '>=16.14'} + peerDependencies: + react: ^16.8.4 || ^17.0.0 + react-dom: ^16.8.4 || ^17.0.0 + dependencies: + '@docusaurus/core': 2.4.3(@docusaurus/types@2.4.3)(react-dom@17.0.2)(react@17.0.2)(typescript@4.9.5) + '@docusaurus/types': 2.4.3(react-dom@17.0.2)(react@17.0.2) + '@docusaurus/utils-validation': 2.4.3(@docusaurus/types@2.4.3) + react: 17.0.2 + react-dom: 17.0.2(react@17.0.2) + tslib: 2.6.2 + transitivePeerDependencies: + - '@parcel/css' + - '@swc/core' + - '@swc/css' + - bufferutil + - csso + - debug + - esbuild + - eslint + - lightningcss + - supports-color + - typescript + - uglify-js + - utf-8-validate + - vue-template-compiler + - webpack-cli + dev: false + + /@docusaurus/plugin-google-gtag@2.4.3(react-dom@17.0.2)(react@17.0.2)(typescript@4.9.5): + resolution: {integrity: sha512-5FMg0rT7sDy4i9AGsvJC71MQrqQZwgLNdDetLEGDHLfSHLvJhQbTCUGbGXknUgWXQJckcV/AILYeJy+HhxeIFA==} + engines: {node: '>=16.14'} + peerDependencies: + react: ^16.8.4 || ^17.0.0 + react-dom: ^16.8.4 || ^17.0.0 + dependencies: + '@docusaurus/core': 2.4.3(@docusaurus/types@2.4.3)(react-dom@17.0.2)(react@17.0.2)(typescript@4.9.5) + '@docusaurus/types': 2.4.3(react-dom@17.0.2)(react@17.0.2) + '@docusaurus/utils-validation': 2.4.3(@docusaurus/types@2.4.3) + react: 17.0.2 + react-dom: 17.0.2(react@17.0.2) + tslib: 2.6.2 + transitivePeerDependencies: + - '@parcel/css' + - '@swc/core' + - '@swc/css' + - bufferutil + - csso + - debug + - esbuild + - eslint + - lightningcss + - supports-color + - typescript + - uglify-js + - utf-8-validate + - vue-template-compiler + - webpack-cli + dev: false + + /@docusaurus/plugin-google-tag-manager@2.4.3(react-dom@17.0.2)(react@17.0.2)(typescript@4.9.5): + resolution: {integrity: sha512-1jTzp71yDGuQiX9Bi0pVp3alArV0LSnHXempvQTxwCGAEzUWWaBg4d8pocAlTpbP9aULQQqhgzrs8hgTRPOM0A==} + engines: {node: '>=16.14'} + peerDependencies: + react: ^16.8.4 || ^17.0.0 + react-dom: ^16.8.4 || ^17.0.0 + dependencies: + '@docusaurus/core': 2.4.3(@docusaurus/types@2.4.3)(react-dom@17.0.2)(react@17.0.2)(typescript@4.9.5) + '@docusaurus/types': 2.4.3(react-dom@17.0.2)(react@17.0.2) + '@docusaurus/utils-validation': 2.4.3(@docusaurus/types@2.4.3) + react: 17.0.2 + react-dom: 17.0.2(react@17.0.2) + tslib: 2.6.2 + transitivePeerDependencies: + - '@parcel/css' + - '@swc/core' + - '@swc/css' + - bufferutil + - csso + - debug + - esbuild + - eslint + - lightningcss + - supports-color + - typescript + - uglify-js + - utf-8-validate + - vue-template-compiler + - webpack-cli + dev: false + + /@docusaurus/plugin-sitemap@2.4.3(react-dom@17.0.2)(react@17.0.2)(typescript@4.9.5): + resolution: {integrity: sha512-LRQYrK1oH1rNfr4YvWBmRzTL0LN9UAPxBbghgeFRBm5yloF6P+zv1tm2pe2hQTX/QP5bSKdnajCvfnScgKXMZQ==} + engines: {node: '>=16.14'} + peerDependencies: + react: ^16.8.4 || ^17.0.0 + react-dom: ^16.8.4 || ^17.0.0 + dependencies: + '@docusaurus/core': 2.4.3(@docusaurus/types@2.4.3)(react-dom@17.0.2)(react@17.0.2)(typescript@4.9.5) + '@docusaurus/logger': 2.4.3 + '@docusaurus/types': 2.4.3(react-dom@17.0.2)(react@17.0.2) + '@docusaurus/utils': 2.4.3(@docusaurus/types@2.4.3) + '@docusaurus/utils-common': 2.4.3(@docusaurus/types@2.4.3) + '@docusaurus/utils-validation': 2.4.3(@docusaurus/types@2.4.3) + fs-extra: 10.1.0 + react: 17.0.2 + react-dom: 17.0.2(react@17.0.2) + sitemap: 7.1.1 + tslib: 2.6.2 + transitivePeerDependencies: + - '@parcel/css' + - '@swc/core' + - '@swc/css' + - bufferutil + - csso + - debug + - esbuild + - eslint + - lightningcss + - supports-color + - typescript + - uglify-js + - utf-8-validate + - vue-template-compiler + - webpack-cli + dev: false + + /@docusaurus/preset-classic@2.4.3(@algolia/client-search@4.20.0)(react-dom@17.0.2)(react@17.0.2)(search-insights@2.9.0)(typescript@4.9.5): + resolution: {integrity: sha512-tRyMliepY11Ym6hB1rAFSNGwQDpmszvWYJvlK1E+md4SW8i6ylNHtpZjaYFff9Mdk3i/Pg8ItQq9P0daOJAvQw==} + engines: {node: '>=16.14'} + peerDependencies: + react: ^16.8.4 || ^17.0.0 + react-dom: ^16.8.4 || ^17.0.0 + dependencies: + '@docusaurus/core': 2.4.3(@docusaurus/types@2.4.3)(react-dom@17.0.2)(react@17.0.2)(typescript@4.9.5) + '@docusaurus/plugin-content-blog': 2.4.3(react-dom@17.0.2)(react@17.0.2)(typescript@4.9.5) + '@docusaurus/plugin-content-docs': 2.4.3(react-dom@17.0.2)(react@17.0.2)(typescript@4.9.5) + '@docusaurus/plugin-content-pages': 2.4.3(react-dom@17.0.2)(react@17.0.2)(typescript@4.9.5) + '@docusaurus/plugin-debug': 2.4.3(react-dom@17.0.2)(react@17.0.2)(typescript@4.9.5) + '@docusaurus/plugin-google-analytics': 2.4.3(react-dom@17.0.2)(react@17.0.2)(typescript@4.9.5) + '@docusaurus/plugin-google-gtag': 2.4.3(react-dom@17.0.2)(react@17.0.2)(typescript@4.9.5) + '@docusaurus/plugin-google-tag-manager': 2.4.3(react-dom@17.0.2)(react@17.0.2)(typescript@4.9.5) + '@docusaurus/plugin-sitemap': 2.4.3(react-dom@17.0.2)(react@17.0.2)(typescript@4.9.5) + '@docusaurus/theme-classic': 2.4.3(react-dom@17.0.2)(react@17.0.2)(typescript@4.9.5) + '@docusaurus/theme-common': 2.4.3(@docusaurus/types@2.4.3)(react-dom@17.0.2)(react@17.0.2)(typescript@4.9.5) + '@docusaurus/theme-search-algolia': 2.4.3(@algolia/client-search@4.20.0)(@docusaurus/types@2.4.3)(react-dom@17.0.2)(react@17.0.2)(search-insights@2.9.0)(typescript@4.9.5) + '@docusaurus/types': 2.4.3(react-dom@17.0.2)(react@17.0.2) + react: 17.0.2 + react-dom: 17.0.2(react@17.0.2) + transitivePeerDependencies: + - '@algolia/client-search' + - '@parcel/css' + - '@swc/core' + - '@swc/css' + - '@types/react' + - bufferutil + - csso + - debug + - encoding + - esbuild + - eslint + - lightningcss + - search-insights + - supports-color + - typescript + - uglify-js + - utf-8-validate + - vue-template-compiler + - webpack-cli + dev: false + + /@docusaurus/react-loadable@5.5.2(react@17.0.2): + resolution: {integrity: sha512-A3dYjdBGuy0IGT+wyLIGIKLRE+sAk1iNk0f1HjNDysO7u8lhL4N3VEm+FAubmJbAztn94F7MxBTPmnixbiyFdQ==} + peerDependencies: + react: '*' + dependencies: + '@types/react': 18.2.33 + prop-types: 15.8.1 + react: 17.0.2 + + /@docusaurus/theme-classic@2.4.3(react-dom@17.0.2)(react@17.0.2)(typescript@4.9.5): + resolution: {integrity: sha512-QKRAJPSGPfDY2yCiPMIVyr+MqwZCIV2lxNzqbyUW0YkrlmdzzP3WuQJPMGLCjWgQp/5c9kpWMvMxjhpZx1R32Q==} + engines: {node: '>=16.14'} + peerDependencies: + react: ^16.8.4 || ^17.0.0 + react-dom: ^16.8.4 || ^17.0.0 + dependencies: + '@docusaurus/core': 2.4.3(@docusaurus/types@2.4.3)(react-dom@17.0.2)(react@17.0.2)(typescript@4.9.5) + '@docusaurus/mdx-loader': 2.4.3(@docusaurus/types@2.4.3)(react-dom@17.0.2)(react@17.0.2) + '@docusaurus/module-type-aliases': 2.4.3(react-dom@17.0.2)(react@17.0.2) + '@docusaurus/plugin-content-blog': 2.4.3(react-dom@17.0.2)(react@17.0.2)(typescript@4.9.5) + '@docusaurus/plugin-content-docs': 2.4.3(react-dom@17.0.2)(react@17.0.2)(typescript@4.9.5) + '@docusaurus/plugin-content-pages': 2.4.3(react-dom@17.0.2)(react@17.0.2)(typescript@4.9.5) + '@docusaurus/theme-common': 2.4.3(@docusaurus/types@2.4.3)(react-dom@17.0.2)(react@17.0.2)(typescript@4.9.5) + '@docusaurus/theme-translations': 2.4.3 + '@docusaurus/types': 2.4.3(react-dom@17.0.2)(react@17.0.2) + '@docusaurus/utils': 2.4.3(@docusaurus/types@2.4.3) + '@docusaurus/utils-common': 2.4.3(@docusaurus/types@2.4.3) + '@docusaurus/utils-validation': 2.4.3(@docusaurus/types@2.4.3) + '@mdx-js/react': 1.6.22(react@17.0.2) + clsx: 1.2.1 + copy-text-to-clipboard: 3.2.0 + infima: 0.2.0-alpha.43 + lodash: 4.17.21 + nprogress: 0.2.0 + postcss: 8.4.31 + prism-react-renderer: 1.3.5(react@17.0.2) + prismjs: 1.29.0 + react: 17.0.2 + react-dom: 17.0.2(react@17.0.2) + react-router-dom: 5.3.4(react@17.0.2) + rtlcss: 3.5.0 + tslib: 2.6.2 + utility-types: 3.10.0 + transitivePeerDependencies: + - '@parcel/css' + - '@swc/core' + - '@swc/css' + - bufferutil + - csso + - debug + - esbuild + - eslint + - lightningcss + - supports-color + - typescript + - uglify-js + - utf-8-validate + - vue-template-compiler + - webpack-cli + dev: false + + /@docusaurus/theme-common@2.4.3(@docusaurus/types@2.4.3)(react-dom@17.0.2)(react@17.0.2)(typescript@4.9.5): + resolution: {integrity: sha512-7KaDJBXKBVGXw5WOVt84FtN8czGWhM0lbyWEZXGp8AFfL6sZQfRTluFp4QriR97qwzSyOfQb+nzcDZZU4tezUw==} + engines: {node: '>=16.14'} + peerDependencies: + react: ^16.8.4 || ^17.0.0 + react-dom: ^16.8.4 || ^17.0.0 + dependencies: + '@docusaurus/mdx-loader': 2.4.3(@docusaurus/types@2.4.3)(react-dom@17.0.2)(react@17.0.2) + '@docusaurus/module-type-aliases': 2.4.3(react-dom@17.0.2)(react@17.0.2) + '@docusaurus/plugin-content-blog': 2.4.3(react-dom@17.0.2)(react@17.0.2)(typescript@4.9.5) + '@docusaurus/plugin-content-docs': 2.4.3(react-dom@17.0.2)(react@17.0.2)(typescript@4.9.5) + '@docusaurus/plugin-content-pages': 2.4.3(react-dom@17.0.2)(react@17.0.2)(typescript@4.9.5) + '@docusaurus/utils': 2.4.3(@docusaurus/types@2.4.3) + '@docusaurus/utils-common': 2.4.3(@docusaurus/types@2.4.3) + '@types/history': 4.7.11 + '@types/react': 18.2.33 + '@types/react-router-config': 5.0.9 + clsx: 1.2.1 + parse-numeric-range: 1.3.0 + prism-react-renderer: 1.3.5(react@17.0.2) + react: 17.0.2 + react-dom: 17.0.2(react@17.0.2) + tslib: 2.6.2 + use-sync-external-store: 1.2.0(react@17.0.2) + utility-types: 3.10.0 + transitivePeerDependencies: + - '@docusaurus/types' + - '@parcel/css' + - '@swc/core' + - '@swc/css' + - bufferutil + - csso + - debug + - esbuild + - eslint + - lightningcss + - supports-color + - typescript + - uglify-js + - utf-8-validate + - vue-template-compiler + - webpack-cli + dev: false + + /@docusaurus/theme-search-algolia@2.4.3(@algolia/client-search@4.20.0)(@docusaurus/types@2.4.3)(react-dom@17.0.2)(react@17.0.2)(search-insights@2.9.0)(typescript@4.9.5): + resolution: {integrity: sha512-jziq4f6YVUB5hZOB85ELATwnxBz/RmSLD3ksGQOLDPKVzat4pmI8tddNWtriPpxR04BNT+ZfpPUMFkNFetSW1Q==} + engines: {node: '>=16.14'} + peerDependencies: + react: ^16.8.4 || ^17.0.0 + react-dom: ^16.8.4 || ^17.0.0 + dependencies: + '@docsearch/react': 3.5.2(@algolia/client-search@4.20.0)(react-dom@17.0.2)(react@17.0.2)(search-insights@2.9.0) + '@docusaurus/core': 2.4.3(@docusaurus/types@2.4.3)(react-dom@17.0.2)(react@17.0.2)(typescript@4.9.5) + '@docusaurus/logger': 2.4.3 + '@docusaurus/plugin-content-docs': 2.4.3(react-dom@17.0.2)(react@17.0.2)(typescript@4.9.5) + '@docusaurus/theme-common': 2.4.3(@docusaurus/types@2.4.3)(react-dom@17.0.2)(react@17.0.2)(typescript@4.9.5) + '@docusaurus/theme-translations': 2.4.3 + '@docusaurus/utils': 2.4.3(@docusaurus/types@2.4.3) + '@docusaurus/utils-validation': 2.4.3(@docusaurus/types@2.4.3) + algoliasearch: 4.20.0 + algoliasearch-helper: 3.15.0(algoliasearch@4.20.0) + clsx: 1.2.1 + eta: 2.2.0 + fs-extra: 10.1.0 + lodash: 4.17.21 + react: 17.0.2 + react-dom: 17.0.2(react@17.0.2) + tslib: 2.6.2 + utility-types: 3.10.0 + transitivePeerDependencies: + - '@algolia/client-search' + - '@docusaurus/types' + - '@parcel/css' + - '@swc/core' + - '@swc/css' + - '@types/react' + - bufferutil + - csso + - debug + - esbuild + - eslint + - lightningcss + - search-insights + - supports-color + - typescript + - uglify-js + - utf-8-validate + - vue-template-compiler + - webpack-cli + dev: false + + /@docusaurus/theme-translations@2.4.3: + resolution: {integrity: sha512-H4D+lbZbjbKNS/Zw1Lel64PioUAIT3cLYYJLUf3KkuO/oc9e0QCVhIYVtUI2SfBCF2NNdlyhBDQEEMygsCedIg==} + engines: {node: '>=16.14'} + dependencies: + fs-extra: 10.1.0 + tslib: 2.6.2 + dev: false + + /@docusaurus/types@2.4.3(react-dom@17.0.2)(react@17.0.2): + resolution: {integrity: sha512-W6zNLGQqfrp/EoPD0bhb9n7OobP+RHpmvVzpA+Z/IuU3Q63njJM24hmT0GYboovWcDtFmnIJC9wcyx4RVPQscw==} + peerDependencies: + react: ^16.8.4 || ^17.0.0 + react-dom: ^16.8.4 || ^17.0.0 + dependencies: + '@types/history': 4.7.11 + '@types/react': 18.2.33 + commander: 5.1.0 + joi: 17.11.0 + react: 17.0.2 + react-dom: 17.0.2(react@17.0.2) + react-helmet-async: 1.3.0(react-dom@17.0.2)(react@17.0.2) + utility-types: 3.10.0 + webpack: 5.89.0 + webpack-merge: 5.10.0 + transitivePeerDependencies: + - '@swc/core' + - esbuild + - uglify-js + - webpack-cli + + /@docusaurus/utils-common@2.4.3(@docusaurus/types@2.4.3): + resolution: {integrity: sha512-/jascp4GbLQCPVmcGkPzEQjNaAk3ADVfMtudk49Ggb+131B1WDD6HqlSmDf8MxGdy7Dja2gc+StHf01kiWoTDQ==} + engines: {node: '>=16.14'} + peerDependencies: + '@docusaurus/types': '*' + peerDependenciesMeta: + '@docusaurus/types': + optional: true + dependencies: + '@docusaurus/types': 2.4.3(react-dom@17.0.2)(react@17.0.2) + tslib: 2.6.2 + dev: false + + /@docusaurus/utils-validation@2.4.3(@docusaurus/types@2.4.3): + resolution: {integrity: sha512-G2+Vt3WR5E/9drAobP+hhZQMaswRwDlp6qOMi7o7ZypB+VO7N//DZWhZEwhcRGepMDJGQEwtPv7UxtYwPL9PBw==} + engines: {node: '>=16.14'} + dependencies: + '@docusaurus/logger': 2.4.3 + '@docusaurus/utils': 2.4.3(@docusaurus/types@2.4.3) + joi: 17.11.0 + js-yaml: 4.1.0 + tslib: 2.6.2 + transitivePeerDependencies: + - '@docusaurus/types' + - '@swc/core' + - esbuild + - supports-color + - uglify-js + - webpack-cli + dev: false + + /@docusaurus/utils@2.4.3(@docusaurus/types@2.4.3): + resolution: {integrity: sha512-fKcXsjrD86Smxv8Pt0TBFqYieZZCPh4cbf9oszUq/AMhZn3ujwpKaVYZACPX8mmjtYx0JOgNx52CREBfiGQB4A==} + engines: {node: '>=16.14'} + peerDependencies: + '@docusaurus/types': '*' + peerDependenciesMeta: + '@docusaurus/types': + optional: true + dependencies: + '@docusaurus/logger': 2.4.3 + '@docusaurus/types': 2.4.3(react-dom@17.0.2)(react@17.0.2) + '@svgr/webpack': 6.5.1 + escape-string-regexp: 4.0.0 + file-loader: 6.2.0(webpack@5.89.0) + fs-extra: 10.1.0 + github-slugger: 1.5.0 + globby: 11.1.0 + gray-matter: 4.0.3 + js-yaml: 4.1.0 + lodash: 4.17.21 + micromatch: 4.0.5 + resolve-pathname: 3.0.0 + shelljs: 0.8.5 + tslib: 2.6.2 + url-loader: 4.1.1(file-loader@6.2.0)(webpack@5.89.0) + webpack: 5.89.0 + transitivePeerDependencies: + - '@swc/core' + - esbuild + - supports-color + - uglify-js + - webpack-cli + dev: false + + /@floating-ui/core@1.5.0: + resolution: {integrity: sha512-kK1h4m36DQ0UHGj5Ah4db7R0rHemTqqO0QLvUqi1/mUUp3LuAWbWxdxSIf/XsnH9VS6rRVPLJCncjRzUvyCLXg==} + dependencies: + '@floating-ui/utils': 0.1.6 + dev: false + + /@floating-ui/dom@1.5.3: + resolution: {integrity: sha512-ClAbQnEqJAKCJOEbbLo5IUlZHkNszqhuxS4fHAVxRPXPya6Ysf2G8KypnYcOTpx6I8xcgF9bbHb6g/2KpbV8qA==} + dependencies: + '@floating-ui/core': 1.5.0 + '@floating-ui/utils': 0.1.6 + dev: false + + /@floating-ui/react-dom@2.0.2(react-dom@17.0.2)(react@17.0.2): + resolution: {integrity: sha512-5qhlDvjaLmAst/rKb3VdlCinwTF4EYMiVxuuc/HVUjs46W0zgtbMmAZ1UTsDrRTxRmUEzl92mOtWbeeXL26lSQ==} + peerDependencies: + react: '>=16.8.0' + react-dom: '>=16.8.0' + dependencies: + '@floating-ui/dom': 1.5.3 + react: 17.0.2 + react-dom: 17.0.2(react@17.0.2) + dev: false + + /@floating-ui/utils@0.1.6: + resolution: {integrity: sha512-OfX7E2oUDYxtBvsuS4e/jSn4Q9Qb6DzgeYtsAdkPZ47znpoNsMgZw0+tVijiv3uGNR6dgNlty6r9rzIzHjtd/A==} + dev: false + + /@hapi/hoek@9.3.0: + resolution: {integrity: sha512-/c6rf4UJlmHlC9b5BaNvzAcFv7HZ2QHaV0D4/HNlBdvFnvQq8RI4kYdhyPCl7Xj+oWvTWQ8ujhqS53LIgAe6KQ==} + + /@hapi/topo@5.1.0: + resolution: {integrity: sha512-foQZKJig7Ob0BMAYBfcJk8d77QtOe7Wo4ox7ff1lQYoNNAb6jwcY1ncdoy2e9wQZzvNy7ODZCYJkK8kzmcAnAg==} + dependencies: + '@hapi/hoek': 9.3.0 + + /@jest/schemas@29.6.3: + resolution: {integrity: sha512-mo5j5X+jIZmJQveBKeS/clAueipV7KgiX1vMgCxam1RNYiqE1w62n0/tJJnHtjW8ZHcQco5gY85jA3mi0L+nSA==} + engines: {node: ^14.15.0 || ^16.10.0 || >=18.0.0} + dependencies: + '@sinclair/typebox': 0.27.8 + dev: false + + /@jest/types@29.6.3: + resolution: {integrity: sha512-u3UPsIilWKOM3F9CXtrG8LEJmNxwoCQC/XVj4IKYXvvpx7QIi/Kg1LI5uDmDpKlac62NUtX7eLjRh+jVZcLOzw==} + engines: {node: ^14.15.0 || ^16.10.0 || >=18.0.0} + dependencies: + '@jest/schemas': 29.6.3 + '@types/istanbul-lib-coverage': 2.0.5 + '@types/istanbul-reports': 3.0.3 + '@types/node': 20.8.9 + '@types/yargs': 17.0.29 + chalk: 4.1.2 + dev: false + + /@jridgewell/gen-mapping@0.3.3: + resolution: {integrity: sha512-HLhSWOLRi875zjjMG/r+Nv0oCW8umGb0BgEhyX3dDX3egwZtB8PqLnjz3yedt8R5StBrzcg4aBpnh8UA9D1BoQ==} + engines: {node: '>=6.0.0'} + dependencies: + '@jridgewell/set-array': 1.1.2 + '@jridgewell/sourcemap-codec': 1.4.15 + '@jridgewell/trace-mapping': 0.3.20 + + /@jridgewell/resolve-uri@3.1.1: + resolution: {integrity: sha512-dSYZh7HhCDtCKm4QakX0xFpsRDqjjtZf/kjI/v3T3Nwt5r8/qz/M19F9ySyOqU94SXBmeG9ttTul+YnR4LOxFA==} + engines: {node: '>=6.0.0'} + + /@jridgewell/set-array@1.1.2: + resolution: {integrity: sha512-xnkseuNADM0gt2bs+BvhO0p78Mk762YnZdsuzFV018NoG1Sj1SCQvpSqa7XUaTam5vAGasABV9qXASMKnFMwMw==} + engines: {node: '>=6.0.0'} + + /@jridgewell/source-map@0.3.5: + resolution: {integrity: sha512-UTYAUj/wviwdsMfzoSJspJxbkH5o1snzwX0//0ENX1u/55kkZZkcTZP6u9bwKGkv+dkk9at4m1Cpt0uY80kcpQ==} + dependencies: + '@jridgewell/gen-mapping': 0.3.3 + '@jridgewell/trace-mapping': 0.3.20 + + /@jridgewell/sourcemap-codec@1.4.15: + resolution: {integrity: sha512-eF2rxCRulEKXHTRiDrDy6erMYWqNw4LPdQ8UQA4huuxaQsVeRPFl2oM8oDGxMFhJUWZf9McpLtJasDDZb/Bpeg==} + + /@jridgewell/trace-mapping@0.3.20: + resolution: {integrity: sha512-R8LcPeWZol2zR8mmH3JeKQ6QRCFb7XgUhV9ZlGhHLGyg4wpPiPZNQOOWhFZhxKw8u//yTbNGI42Bx/3paXEQ+Q==} + dependencies: + '@jridgewell/resolve-uri': 3.1.1 + '@jridgewell/sourcemap-codec': 1.4.15 + + /@leichtgewicht/ip-codec@2.0.4: + resolution: {integrity: sha512-Hcv+nVC0kZnQ3tD9GVu5xSMR4VVYOteQIr/hwFPVEvPdlXqgGEuRjiheChHgdM+JyqdgNcmzZOX/tnl0JOiI7A==} + dev: false + + /@mdx-js/mdx@1.6.22: + resolution: {integrity: sha512-AMxuLxPz2j5/6TpF/XSdKpQP1NlG0z11dFOlq+2IP/lSgl11GY8ji6S/rgsViN/L0BDvHvUMruRb7ub+24LUYA==} + dependencies: + '@babel/core': 7.12.9 + '@babel/plugin-syntax-jsx': 7.12.1(@babel/core@7.12.9) + '@babel/plugin-syntax-object-rest-spread': 7.8.3(@babel/core@7.12.9) + '@mdx-js/util': 1.6.22 + babel-plugin-apply-mdx-type-prop: 1.6.22(@babel/core@7.12.9) + babel-plugin-extract-import-names: 1.6.22 + camelcase-css: 2.0.1 + detab: 2.0.4 + hast-util-raw: 6.0.1 + lodash.uniq: 4.5.0 + mdast-util-to-hast: 10.0.1 + remark-footnotes: 2.0.0 + remark-mdx: 1.6.22 + remark-parse: 8.0.3 + remark-squeeze-paragraphs: 4.0.0 + style-to-object: 0.3.0 + unified: 9.2.0 + unist-builder: 2.0.3 + unist-util-visit: 2.0.3 + transitivePeerDependencies: + - supports-color + dev: false + + /@mdx-js/react@1.6.22(react@17.0.2): + resolution: {integrity: sha512-TDoPum4SHdfPiGSAaRBw7ECyI8VaHpK8GJugbJIJuqyh6kzw9ZLJZW3HGL3NNrJGxcAixUvqROm+YuQOo5eXtg==} + peerDependencies: + react: ^16.13.1 || ^17.0.0 + dependencies: + react: 17.0.2 + dev: false + + /@mdx-js/util@1.6.22: + resolution: {integrity: sha512-H1rQc1ZOHANWBvPcW+JpGwr+juXSxM8Q8YCkm3GhZd8REu1fHR3z99CErO1p9pkcfcxZnMdIZdIsXkOHY0NilA==} + dev: false + + /@nodelib/fs.scandir@2.1.5: + resolution: {integrity: sha512-vq24Bq3ym5HEQm2NKCr3yXDwjc7vTsEThRDnkp2DK9p1uqLR+DHurm/NOTo0KG7HYHU7eppKZj3MyqYuMBf62g==} + engines: {node: '>= 8'} + dependencies: + '@nodelib/fs.stat': 2.0.5 + run-parallel: 1.2.0 + + /@nodelib/fs.stat@2.0.5: + resolution: {integrity: sha512-RkhPPp2zrqDAQA/2jNhnztcPAlv64XdhIp7a7454A5ovI7Bukxgt7MX7udwAu3zg1DcpPU0rz3VV1SeaqvY4+A==} + engines: {node: '>= 8'} + + /@nodelib/fs.walk@1.2.8: + resolution: {integrity: sha512-oGB+UxlgWcgQkgwo8GcEGwemoTFt3FIO9ababBmaGwXIoBKZ+GTy0pP185beGg7Llih/NSHSV2XAs1lnznocSg==} + engines: {node: '>= 8'} + dependencies: + '@nodelib/fs.scandir': 2.1.5 + fastq: 1.15.0 + + /@polka/url@1.0.0-next.23: + resolution: {integrity: sha512-C16M+IYz0rgRhWZdCmK+h58JMv8vijAA61gmz2rspCSwKwzBebpdcsiUmwrtJRdphuY30i6BSLEOP8ppbNLyLg==} + dev: false + + /@radix-ui/primitive@1.0.1: + resolution: {integrity: sha512-yQ8oGX2GVsEYMWGxcovu1uGWPCxV5BFfeeYxqPmuAzUyLT9qmaMXSAhXpb0WrspIeqYzdJpkh2vHModJPgRIaw==} + dependencies: + '@babel/runtime': 7.23.2 + dev: false + + /@radix-ui/react-arrow@1.0.3(react-dom@17.0.2)(react@17.0.2): + resolution: {integrity: sha512-wSP+pHsB/jQRaL6voubsQ/ZlrGBHHrOjmBnr19hxYgtS0WvAFwZhK2WP/YY5yF9uKECCEEDGxuLxq1NBK51wFA==} + peerDependencies: + '@types/react': '*' + '@types/react-dom': '*' + react: ^16.8 || ^17.0 || ^18.0 + react-dom: ^16.8 || ^17.0 || ^18.0 + peerDependenciesMeta: + '@types/react': + optional: true + '@types/react-dom': + optional: true + dependencies: + '@babel/runtime': 7.23.2 + '@radix-ui/react-primitive': 1.0.3(react-dom@17.0.2)(react@17.0.2) + react: 17.0.2 + react-dom: 17.0.2(react@17.0.2) + dev: false + + /@radix-ui/react-compose-refs@1.0.1(react@17.0.2): + resolution: {integrity: sha512-fDSBgd44FKHa1FRMU59qBMPFcl2PZE+2nmqunj+BWFyYYjnhIDWL2ItDs3rrbJDQOtzt5nIebLCQc4QRfz6LJw==} + peerDependencies: + '@types/react': '*' + react: ^16.8 || ^17.0 || ^18.0 + peerDependenciesMeta: + '@types/react': + optional: true + dependencies: + '@babel/runtime': 7.23.2 + react: 17.0.2 + dev: false + + /@radix-ui/react-context@1.0.1(react@17.0.2): + resolution: {integrity: sha512-ebbrdFoYTcuZ0v4wG5tedGnp9tzcV8awzsxYph7gXUyvnNLuTIcCk1q17JEbnVhXAKG9oX3KtchwiMIAYp9NLg==} + peerDependencies: + '@types/react': '*' + react: ^16.8 || ^17.0 || ^18.0 + peerDependenciesMeta: + '@types/react': + optional: true + dependencies: + '@babel/runtime': 7.23.2 + react: 17.0.2 + dev: false + + /@radix-ui/react-dialog@1.0.5(react-dom@17.0.2)(react@17.0.2): + resolution: {integrity: sha512-GjWJX/AUpB703eEBanuBnIWdIXg6NvJFCXcNlSZk4xdszCdhrJgBoUd1cGk67vFO+WdA2pfI/plOpqz/5GUP6Q==} + peerDependencies: + '@types/react': '*' + '@types/react-dom': '*' + react: ^16.8 || ^17.0 || ^18.0 + react-dom: ^16.8 || ^17.0 || ^18.0 + peerDependenciesMeta: + '@types/react': + optional: true + '@types/react-dom': + optional: true + dependencies: + '@babel/runtime': 7.23.2 + '@radix-ui/primitive': 1.0.1 + '@radix-ui/react-compose-refs': 1.0.1(react@17.0.2) + '@radix-ui/react-context': 1.0.1(react@17.0.2) + '@radix-ui/react-dismissable-layer': 1.0.5(react-dom@17.0.2)(react@17.0.2) + '@radix-ui/react-focus-guards': 1.0.1(react@17.0.2) + '@radix-ui/react-focus-scope': 1.0.4(react-dom@17.0.2)(react@17.0.2) + '@radix-ui/react-id': 1.0.1(react@17.0.2) + '@radix-ui/react-portal': 1.0.4(react-dom@17.0.2)(react@17.0.2) + '@radix-ui/react-presence': 1.0.1(react-dom@17.0.2)(react@17.0.2) + '@radix-ui/react-primitive': 1.0.3(react-dom@17.0.2)(react@17.0.2) + '@radix-ui/react-slot': 1.0.2(react@17.0.2) + '@radix-ui/react-use-controllable-state': 1.0.1(react@17.0.2) + aria-hidden: 1.2.3 + react: 17.0.2 + react-dom: 17.0.2(react@17.0.2) + react-remove-scroll: 2.5.5(react@17.0.2) + dev: false + + /@radix-ui/react-dismissable-layer@1.0.5(react-dom@17.0.2)(react@17.0.2): + resolution: {integrity: sha512-aJeDjQhywg9LBu2t/At58hCvr7pEm0o2Ke1x33B+MhjNmmZ17sy4KImo0KPLgsnc/zN7GPdce8Cnn0SWvwZO7g==} + peerDependencies: + '@types/react': '*' + '@types/react-dom': '*' + react: ^16.8 || ^17.0 || ^18.0 + react-dom: ^16.8 || ^17.0 || ^18.0 + peerDependenciesMeta: + '@types/react': + optional: true + '@types/react-dom': + optional: true + dependencies: + '@babel/runtime': 7.23.2 + '@radix-ui/primitive': 1.0.1 + '@radix-ui/react-compose-refs': 1.0.1(react@17.0.2) + '@radix-ui/react-primitive': 1.0.3(react-dom@17.0.2)(react@17.0.2) + '@radix-ui/react-use-callback-ref': 1.0.1(react@17.0.2) + '@radix-ui/react-use-escape-keydown': 1.0.3(react@17.0.2) + react: 17.0.2 + react-dom: 17.0.2(react@17.0.2) + dev: false + + /@radix-ui/react-focus-guards@1.0.1(react@17.0.2): + resolution: {integrity: sha512-Rect2dWbQ8waGzhMavsIbmSVCgYxkXLxxR3ZvCX79JOglzdEy4JXMb98lq4hPxUbLr77nP0UOGf4rcMU+s1pUA==} + peerDependencies: + '@types/react': '*' + react: ^16.8 || ^17.0 || ^18.0 + peerDependenciesMeta: + '@types/react': + optional: true + dependencies: + '@babel/runtime': 7.23.2 + react: 17.0.2 + dev: false + + /@radix-ui/react-focus-scope@1.0.4(react-dom@17.0.2)(react@17.0.2): + resolution: {integrity: sha512-sL04Mgvf+FmyvZeYfNu1EPAaaxD+aw7cYeIB9L9Fvq8+urhltTRaEo5ysKOpHuKPclsZcSUMKlN05x4u+CINpA==} + peerDependencies: + '@types/react': '*' + '@types/react-dom': '*' + react: ^16.8 || ^17.0 || ^18.0 + react-dom: ^16.8 || ^17.0 || ^18.0 + peerDependenciesMeta: + '@types/react': + optional: true + '@types/react-dom': + optional: true + dependencies: + '@babel/runtime': 7.23.2 + '@radix-ui/react-compose-refs': 1.0.1(react@17.0.2) + '@radix-ui/react-primitive': 1.0.3(react-dom@17.0.2)(react@17.0.2) + '@radix-ui/react-use-callback-ref': 1.0.1(react@17.0.2) + react: 17.0.2 + react-dom: 17.0.2(react@17.0.2) + dev: false + + /@radix-ui/react-id@1.0.1(react@17.0.2): + resolution: {integrity: sha512-tI7sT/kqYp8p96yGWY1OAnLHrqDgzHefRBKQ2YAkBS5ja7QLcZ9Z/uY7bEjPUatf8RomoXM8/1sMj1IJaE5UzQ==} + peerDependencies: + '@types/react': '*' + react: ^16.8 || ^17.0 || ^18.0 + peerDependenciesMeta: + '@types/react': + optional: true + dependencies: + '@babel/runtime': 7.23.2 + '@radix-ui/react-use-layout-effect': 1.0.1(react@17.0.2) + react: 17.0.2 + dev: false + + /@radix-ui/react-popover@1.0.7(react-dom@17.0.2)(react@17.0.2): + resolution: {integrity: sha512-shtvVnlsxT6faMnK/a7n0wptwBD23xc1Z5mdrtKLwVEfsEMXodS0r5s0/g5P0hX//EKYZS2sxUjqfzlg52ZSnQ==} + peerDependencies: + '@types/react': '*' + '@types/react-dom': '*' + react: ^16.8 || ^17.0 || ^18.0 + react-dom: ^16.8 || ^17.0 || ^18.0 + peerDependenciesMeta: + '@types/react': + optional: true + '@types/react-dom': + optional: true + dependencies: + '@babel/runtime': 7.23.2 + '@radix-ui/primitive': 1.0.1 + '@radix-ui/react-compose-refs': 1.0.1(react@17.0.2) + '@radix-ui/react-context': 1.0.1(react@17.0.2) + '@radix-ui/react-dismissable-layer': 1.0.5(react-dom@17.0.2)(react@17.0.2) + '@radix-ui/react-focus-guards': 1.0.1(react@17.0.2) + '@radix-ui/react-focus-scope': 1.0.4(react-dom@17.0.2)(react@17.0.2) + '@radix-ui/react-id': 1.0.1(react@17.0.2) + '@radix-ui/react-popper': 1.1.3(react-dom@17.0.2)(react@17.0.2) + '@radix-ui/react-portal': 1.0.4(react-dom@17.0.2)(react@17.0.2) + '@radix-ui/react-presence': 1.0.1(react-dom@17.0.2)(react@17.0.2) + '@radix-ui/react-primitive': 1.0.3(react-dom@17.0.2)(react@17.0.2) + '@radix-ui/react-slot': 1.0.2(react@17.0.2) + '@radix-ui/react-use-controllable-state': 1.0.1(react@17.0.2) + aria-hidden: 1.2.3 + react: 17.0.2 + react-dom: 17.0.2(react@17.0.2) + react-remove-scroll: 2.5.5(react@17.0.2) + dev: false + + /@radix-ui/react-popper@1.1.3(react-dom@17.0.2)(react@17.0.2): + resolution: {integrity: sha512-cKpopj/5RHZWjrbF2846jBNacjQVwkP068DfmgrNJXpvVWrOvlAmE9xSiy5OqeE+Gi8D9fP+oDhUnPqNMY8/5w==} + peerDependencies: + '@types/react': '*' + '@types/react-dom': '*' + react: ^16.8 || ^17.0 || ^18.0 + react-dom: ^16.8 || ^17.0 || ^18.0 + peerDependenciesMeta: + '@types/react': + optional: true + '@types/react-dom': + optional: true + dependencies: + '@babel/runtime': 7.23.2 + '@floating-ui/react-dom': 2.0.2(react-dom@17.0.2)(react@17.0.2) + '@radix-ui/react-arrow': 1.0.3(react-dom@17.0.2)(react@17.0.2) + '@radix-ui/react-compose-refs': 1.0.1(react@17.0.2) + '@radix-ui/react-context': 1.0.1(react@17.0.2) + '@radix-ui/react-primitive': 1.0.3(react-dom@17.0.2)(react@17.0.2) + '@radix-ui/react-use-callback-ref': 1.0.1(react@17.0.2) + '@radix-ui/react-use-layout-effect': 1.0.1(react@17.0.2) + '@radix-ui/react-use-rect': 1.0.1(react@17.0.2) + '@radix-ui/react-use-size': 1.0.1(react@17.0.2) + '@radix-ui/rect': 1.0.1 + react: 17.0.2 + react-dom: 17.0.2(react@17.0.2) + dev: false + + /@radix-ui/react-portal@1.0.4(react-dom@17.0.2)(react@17.0.2): + resolution: {integrity: sha512-Qki+C/EuGUVCQTOTD5vzJzJuMUlewbzuKyUy+/iHM2uwGiru9gZeBJtHAPKAEkB5KWGi9mP/CHKcY0wt1aW45Q==} + peerDependencies: + '@types/react': '*' + '@types/react-dom': '*' + react: ^16.8 || ^17.0 || ^18.0 + react-dom: ^16.8 || ^17.0 || ^18.0 + peerDependenciesMeta: + '@types/react': + optional: true + '@types/react-dom': + optional: true + dependencies: + '@babel/runtime': 7.23.2 + '@radix-ui/react-primitive': 1.0.3(react-dom@17.0.2)(react@17.0.2) + react: 17.0.2 + react-dom: 17.0.2(react@17.0.2) + dev: false + + /@radix-ui/react-presence@1.0.1(react-dom@17.0.2)(react@17.0.2): + resolution: {integrity: sha512-UXLW4UAbIY5ZjcvzjfRFo5gxva8QirC9hF7wRE4U5gz+TP0DbRk+//qyuAQ1McDxBt1xNMBTaciFGvEmJvAZCg==} + peerDependencies: + '@types/react': '*' + '@types/react-dom': '*' + react: ^16.8 || ^17.0 || ^18.0 + react-dom: ^16.8 || ^17.0 || ^18.0 + peerDependenciesMeta: + '@types/react': + optional: true + '@types/react-dom': + optional: true + dependencies: + '@babel/runtime': 7.23.2 + '@radix-ui/react-compose-refs': 1.0.1(react@17.0.2) + '@radix-ui/react-use-layout-effect': 1.0.1(react@17.0.2) + react: 17.0.2 + react-dom: 17.0.2(react@17.0.2) + dev: false + + /@radix-ui/react-primitive@1.0.3(react-dom@17.0.2)(react@17.0.2): + resolution: {integrity: sha512-yi58uVyoAcK/Nq1inRY56ZSjKypBNKTa/1mcL8qdl6oJeEaDbOldlzrGn7P6Q3Id5d+SYNGc5AJgc4vGhjs5+g==} + peerDependencies: + '@types/react': '*' + '@types/react-dom': '*' + react: ^16.8 || ^17.0 || ^18.0 + react-dom: ^16.8 || ^17.0 || ^18.0 + peerDependenciesMeta: + '@types/react': + optional: true + '@types/react-dom': + optional: true + dependencies: + '@babel/runtime': 7.23.2 + '@radix-ui/react-slot': 1.0.2(react@17.0.2) + react: 17.0.2 + react-dom: 17.0.2(react@17.0.2) + dev: false + + /@radix-ui/react-slot@1.0.2(react@17.0.2): + resolution: {integrity: sha512-YeTpuq4deV+6DusvVUW4ivBgnkHwECUu0BiN43L5UCDFgdhsRUWAghhTF5MbvNTPzmiFOx90asDSUjWuCNapwg==} + peerDependencies: + '@types/react': '*' + react: ^16.8 || ^17.0 || ^18.0 + peerDependenciesMeta: + '@types/react': + optional: true + dependencies: + '@babel/runtime': 7.23.2 + '@radix-ui/react-compose-refs': 1.0.1(react@17.0.2) + react: 17.0.2 + dev: false + + /@radix-ui/react-tooltip@1.0.7(react-dom@17.0.2)(react@17.0.2): + resolution: {integrity: sha512-lPh5iKNFVQ/jav/j6ZrWq3blfDJ0OH9R6FlNUHPMqdLuQ9vwDgFsRxvl8b7Asuy5c8xmoojHUxKHQSOAvMHxyw==} + peerDependencies: + '@types/react': '*' + '@types/react-dom': '*' + react: ^16.8 || ^17.0 || ^18.0 + react-dom: ^16.8 || ^17.0 || ^18.0 + peerDependenciesMeta: + '@types/react': + optional: true + '@types/react-dom': + optional: true + dependencies: + '@babel/runtime': 7.23.2 + '@radix-ui/primitive': 1.0.1 + '@radix-ui/react-compose-refs': 1.0.1(react@17.0.2) + '@radix-ui/react-context': 1.0.1(react@17.0.2) + '@radix-ui/react-dismissable-layer': 1.0.5(react-dom@17.0.2)(react@17.0.2) + '@radix-ui/react-id': 1.0.1(react@17.0.2) + '@radix-ui/react-popper': 1.1.3(react-dom@17.0.2)(react@17.0.2) + '@radix-ui/react-portal': 1.0.4(react-dom@17.0.2)(react@17.0.2) + '@radix-ui/react-presence': 1.0.1(react-dom@17.0.2)(react@17.0.2) + '@radix-ui/react-primitive': 1.0.3(react-dom@17.0.2)(react@17.0.2) + '@radix-ui/react-slot': 1.0.2(react@17.0.2) + '@radix-ui/react-use-controllable-state': 1.0.1(react@17.0.2) + '@radix-ui/react-visually-hidden': 1.0.3(react-dom@17.0.2)(react@17.0.2) + react: 17.0.2 + react-dom: 17.0.2(react@17.0.2) + dev: false + + /@radix-ui/react-use-callback-ref@1.0.1(react@17.0.2): + resolution: {integrity: sha512-D94LjX4Sp0xJFVaoQOd3OO9k7tpBYNOXdVhkltUbGv2Qb9OXdrg/CpsjlZv7ia14Sylv398LswWBVVu5nqKzAQ==} + peerDependencies: + '@types/react': '*' + react: ^16.8 || ^17.0 || ^18.0 + peerDependenciesMeta: + '@types/react': + optional: true + dependencies: + '@babel/runtime': 7.23.2 + react: 17.0.2 + dev: false + + /@radix-ui/react-use-controllable-state@1.0.1(react@17.0.2): + resolution: {integrity: sha512-Svl5GY5FQeN758fWKrjM6Qb7asvXeiZltlT4U2gVfl8Gx5UAv2sMR0LWo8yhsIZh2oQ0eFdZ59aoOOMV7b47VA==} + peerDependencies: + '@types/react': '*' + react: ^16.8 || ^17.0 || ^18.0 + peerDependenciesMeta: + '@types/react': + optional: true + dependencies: + '@babel/runtime': 7.23.2 + '@radix-ui/react-use-callback-ref': 1.0.1(react@17.0.2) + react: 17.0.2 + dev: false + + /@radix-ui/react-use-escape-keydown@1.0.3(react@17.0.2): + resolution: {integrity: sha512-vyL82j40hcFicA+M4Ex7hVkB9vHgSse1ZWomAqV2Je3RleKGO5iM8KMOEtfoSB0PnIelMd2lATjTGMYqN5ylTg==} + peerDependencies: + '@types/react': '*' + react: ^16.8 || ^17.0 || ^18.0 + peerDependenciesMeta: + '@types/react': + optional: true + dependencies: + '@babel/runtime': 7.23.2 + '@radix-ui/react-use-callback-ref': 1.0.1(react@17.0.2) + react: 17.0.2 + dev: false + + /@radix-ui/react-use-layout-effect@1.0.1(react@17.0.2): + resolution: {integrity: sha512-v/5RegiJWYdoCvMnITBkNNx6bCj20fiaJnWtRkU18yITptraXjffz5Qbn05uOiQnOvi+dbkznkoaMltz1GnszQ==} + peerDependencies: + '@types/react': '*' + react: ^16.8 || ^17.0 || ^18.0 + peerDependenciesMeta: + '@types/react': + optional: true + dependencies: + '@babel/runtime': 7.23.2 + react: 17.0.2 + dev: false + + /@radix-ui/react-use-rect@1.0.1(react@17.0.2): + resolution: {integrity: sha512-Cq5DLuSiuYVKNU8orzJMbl15TXilTnJKUCltMVQg53BQOF1/C5toAaGrowkgksdBQ9H+SRL23g0HDmg9tvmxXw==} + peerDependencies: + '@types/react': '*' + react: ^16.8 || ^17.0 || ^18.0 + peerDependenciesMeta: + '@types/react': + optional: true + dependencies: + '@babel/runtime': 7.23.2 + '@radix-ui/rect': 1.0.1 + react: 17.0.2 + dev: false + + /@radix-ui/react-use-size@1.0.1(react@17.0.2): + resolution: {integrity: sha512-ibay+VqrgcaI6veAojjofPATwledXiSmX+C0KrBk/xgpX9rBzPV3OsfwlhQdUOFbh+LKQorLYT+xTXW9V8yd0g==} + peerDependencies: + '@types/react': '*' + react: ^16.8 || ^17.0 || ^18.0 + peerDependenciesMeta: + '@types/react': + optional: true + dependencies: + '@babel/runtime': 7.23.2 + '@radix-ui/react-use-layout-effect': 1.0.1(react@17.0.2) + react: 17.0.2 + dev: false + + /@radix-ui/react-visually-hidden@1.0.3(react-dom@17.0.2)(react@17.0.2): + resolution: {integrity: sha512-D4w41yN5YRKtu464TLnByKzMDG/JlMPHtfZgQAu9v6mNakUqGUI9vUrfQKz8NK41VMm/xbZbh76NUTVtIYqOMA==} + peerDependencies: + '@types/react': '*' + '@types/react-dom': '*' + react: ^16.8 || ^17.0 || ^18.0 + react-dom: ^16.8 || ^17.0 || ^18.0 + peerDependenciesMeta: + '@types/react': + optional: true + '@types/react-dom': + optional: true + dependencies: + '@babel/runtime': 7.23.2 + '@radix-ui/react-primitive': 1.0.3(react-dom@17.0.2)(react@17.0.2) + react: 17.0.2 + react-dom: 17.0.2(react@17.0.2) + dev: false + + /@radix-ui/rect@1.0.1: + resolution: {integrity: sha512-fyrgCaedtvMg9NK3en0pnOYJdtfwxUcNolezkNPUsoX57X8oQk+NkqcvzHXD2uKNij6GXmWU9NDru2IWjrO4BQ==} + dependencies: + '@babel/runtime': 7.23.2 + dev: false + + /@sideway/address@4.1.4: + resolution: {integrity: sha512-7vwq+rOHVWjyXxVlR76Agnvhy8I9rpzjosTESvmhNeXOXdZZB15Fl+TI9x1SiHZH5Jv2wTGduSxFDIaq0m3DUw==} + dependencies: + '@hapi/hoek': 9.3.0 + + /@sideway/formula@3.0.1: + resolution: {integrity: sha512-/poHZJJVjx3L+zVD6g9KgHfYnb443oi7wLu/XKojDviHy6HOEOA6z1Trk5aR1dGcmPenJEgb2sK2I80LeS3MIg==} + + /@sideway/pinpoint@2.0.0: + resolution: {integrity: sha512-RNiOoTPkptFtSVzQevY/yWtZwf/RxyVnPy/OcA9HBM3MlGDnBEYL5B41H0MTn0Uec8Hi+2qUtTfG2WWZBmMejQ==} + + /@sinclair/typebox@0.27.8: + resolution: {integrity: sha512-+Fj43pSMwJs4KRrH/938Uf+uAELIgVBmQzg/q1YG10djyfA3TnrU8N8XzqCh/okZdszqBQTZf96idMfE5lnwTA==} + dev: false + + /@sindresorhus/is@0.14.0: + resolution: {integrity: sha512-9NET910DNaIPngYnLLPeg+Ogzqsi9uM4mSboU5y6p8S5DzMTVEsJZrawi+BoDNUVBa2DhJqQYUFvMDfgU062LQ==} + engines: {node: '>=6'} + dev: false + + /@slorber/static-site-generator-webpack-plugin@4.0.7: + resolution: {integrity: sha512-Ug7x6z5lwrz0WqdnNFOMYrDQNTPAprvHLSh6+/fmml3qUiz6l5eq+2MzLKWtn/q5K5NpSiFsZTP/fck/3vjSxA==} + engines: {node: '>=14'} + dependencies: + eval: 0.1.8 + p-map: 4.0.0 + webpack-sources: 3.2.3 + dev: false + + /@svgr/babel-plugin-add-jsx-attribute@6.5.1(@babel/core@7.23.2): + resolution: {integrity: sha512-9PYGcXrAxitycIjRmZB+Q0JaN07GZIWaTBIGQzfaZv+qr1n8X1XUEJ5rZ/vx6OVD9RRYlrNnXWExQXcmZeD/BQ==} + engines: {node: '>=10'} + peerDependencies: + '@babel/core': ^7.0.0-0 + dependencies: + '@babel/core': 7.23.2 + dev: false + + /@svgr/babel-plugin-remove-jsx-attribute@8.0.0(@babel/core@7.23.2): + resolution: {integrity: sha512-BcCkm/STipKvbCl6b7QFrMh/vx00vIP63k2eM66MfHJzPr6O2U0jYEViXkHJWqXqQYjdeA9cuCl5KWmlwjDvbA==} + engines: {node: '>=14'} + peerDependencies: + '@babel/core': ^7.0.0-0 + dependencies: + '@babel/core': 7.23.2 + dev: false + + /@svgr/babel-plugin-remove-jsx-empty-expression@8.0.0(@babel/core@7.23.2): + resolution: {integrity: sha512-5BcGCBfBxB5+XSDSWnhTThfI9jcO5f0Ai2V24gZpG+wXF14BzwxxdDb4g6trdOux0rhibGs385BeFMSmxtS3uA==} + engines: {node: '>=14'} + peerDependencies: + '@babel/core': ^7.0.0-0 + dependencies: + '@babel/core': 7.23.2 + dev: false + + /@svgr/babel-plugin-replace-jsx-attribute-value@6.5.1(@babel/core@7.23.2): + resolution: {integrity: sha512-8DPaVVE3fd5JKuIC29dqyMB54sA6mfgki2H2+swh+zNJoynC8pMPzOkidqHOSc6Wj032fhl8Z0TVn1GiPpAiJg==} + engines: {node: '>=10'} + peerDependencies: + '@babel/core': ^7.0.0-0 + dependencies: + '@babel/core': 7.23.2 + dev: false + + /@svgr/babel-plugin-svg-dynamic-title@6.5.1(@babel/core@7.23.2): + resolution: {integrity: sha512-FwOEi0Il72iAzlkaHrlemVurgSQRDFbk0OC8dSvD5fSBPHltNh7JtLsxmZUhjYBZo2PpcU/RJvvi6Q0l7O7ogw==} + engines: {node: '>=10'} + peerDependencies: + '@babel/core': ^7.0.0-0 + dependencies: + '@babel/core': 7.23.2 + dev: false + + /@svgr/babel-plugin-svg-em-dimensions@6.5.1(@babel/core@7.23.2): + resolution: {integrity: sha512-gWGsiwjb4tw+ITOJ86ndY/DZZ6cuXMNE/SjcDRg+HLuCmwpcjOktwRF9WgAiycTqJD/QXqL2f8IzE2Rzh7aVXA==} + engines: {node: '>=10'} + peerDependencies: + '@babel/core': ^7.0.0-0 + dependencies: + '@babel/core': 7.23.2 + dev: false + + /@svgr/babel-plugin-transform-react-native-svg@6.5.1(@babel/core@7.23.2): + resolution: {integrity: sha512-2jT3nTayyYP7kI6aGutkyfJ7UMGtuguD72OjeGLwVNyfPRBD8zQthlvL+fAbAKk5n9ZNcvFkp/b1lZ7VsYqVJg==} + engines: {node: '>=10'} + peerDependencies: + '@babel/core': ^7.0.0-0 + dependencies: + '@babel/core': 7.23.2 + dev: false + + /@svgr/babel-plugin-transform-svg-component@6.5.1(@babel/core@7.23.2): + resolution: {integrity: sha512-a1p6LF5Jt33O3rZoVRBqdxL350oge54iZWHNI6LJB5tQ7EelvD/Mb1mfBiZNAan0dt4i3VArkFRjA4iObuNykQ==} + engines: {node: '>=12'} + peerDependencies: + '@babel/core': ^7.0.0-0 + dependencies: + '@babel/core': 7.23.2 + dev: false + + /@svgr/babel-preset@6.5.1(@babel/core@7.23.2): + resolution: {integrity: sha512-6127fvO/FF2oi5EzSQOAjo1LE3OtNVh11R+/8FXa+mHx1ptAaS4cknIjnUA7e6j6fwGGJ17NzaTJFUwOV2zwCw==} + engines: {node: '>=10'} + peerDependencies: + '@babel/core': ^7.0.0-0 + dependencies: + '@babel/core': 7.23.2 + '@svgr/babel-plugin-add-jsx-attribute': 6.5.1(@babel/core@7.23.2) + '@svgr/babel-plugin-remove-jsx-attribute': 8.0.0(@babel/core@7.23.2) + '@svgr/babel-plugin-remove-jsx-empty-expression': 8.0.0(@babel/core@7.23.2) + '@svgr/babel-plugin-replace-jsx-attribute-value': 6.5.1(@babel/core@7.23.2) + '@svgr/babel-plugin-svg-dynamic-title': 6.5.1(@babel/core@7.23.2) + '@svgr/babel-plugin-svg-em-dimensions': 6.5.1(@babel/core@7.23.2) + '@svgr/babel-plugin-transform-react-native-svg': 6.5.1(@babel/core@7.23.2) + '@svgr/babel-plugin-transform-svg-component': 6.5.1(@babel/core@7.23.2) + dev: false + + /@svgr/core@6.5.1: + resolution: {integrity: sha512-/xdLSWxK5QkqG524ONSjvg3V/FkNyCv538OIBdQqPNaAta3AsXj/Bd2FbvR87yMbXO2hFSWiAe/Q6IkVPDw+mw==} + engines: {node: '>=10'} + dependencies: + '@babel/core': 7.23.2 + '@svgr/babel-preset': 6.5.1(@babel/core@7.23.2) + '@svgr/plugin-jsx': 6.5.1(@svgr/core@6.5.1) + camelcase: 6.3.0 + cosmiconfig: 7.1.0 + transitivePeerDependencies: + - supports-color + dev: false + + /@svgr/hast-util-to-babel-ast@6.5.1: + resolution: {integrity: sha512-1hnUxxjd83EAxbL4a0JDJoD3Dao3hmjvyvyEV8PzWmLK3B9m9NPlW7GKjFyoWE8nM7HnXzPcmmSyOW8yOddSXw==} + engines: {node: '>=10'} + dependencies: + '@babel/types': 7.23.0 + entities: 4.5.0 + dev: false + + /@svgr/plugin-jsx@6.5.1(@svgr/core@6.5.1): + resolution: {integrity: sha512-+UdQxI3jgtSjCykNSlEMuy1jSRQlGC7pqBCPvkG/2dATdWo082zHTTK3uhnAju2/6XpE6B5mZ3z4Z8Ns01S8Gw==} + engines: {node: '>=10'} + peerDependencies: + '@svgr/core': ^6.0.0 + dependencies: + '@babel/core': 7.23.2 + '@svgr/babel-preset': 6.5.1(@babel/core@7.23.2) + '@svgr/core': 6.5.1 + '@svgr/hast-util-to-babel-ast': 6.5.1 + svg-parser: 2.0.4 + transitivePeerDependencies: + - supports-color + dev: false + + /@svgr/plugin-svgo@6.5.1(@svgr/core@6.5.1): + resolution: {integrity: sha512-omvZKf8ixP9z6GWgwbtmP9qQMPX4ODXi+wzbVZgomNFsUIlHA1sf4fThdwTWSsZGgvGAG6yE+b/F5gWUkcZ/iQ==} + engines: {node: '>=10'} + peerDependencies: + '@svgr/core': '*' + dependencies: + '@svgr/core': 6.5.1 + cosmiconfig: 7.1.0 + deepmerge: 4.3.1 + svgo: 2.8.0 + dev: false + + /@svgr/webpack@6.5.1: + resolution: {integrity: sha512-cQ/AsnBkXPkEK8cLbv4Dm7JGXq2XrumKnL1dRpJD9rIO2fTIlJI9a1uCciYG1F2aUsox/hJQyNGbt3soDxSRkA==} + engines: {node: '>=10'} + dependencies: + '@babel/core': 7.23.2 + '@babel/plugin-transform-react-constant-elements': 7.22.5(@babel/core@7.23.2) + '@babel/preset-env': 7.23.2(@babel/core@7.23.2) + '@babel/preset-react': 7.22.15(@babel/core@7.23.2) + '@babel/preset-typescript': 7.23.2(@babel/core@7.23.2) + '@svgr/core': 6.5.1 + '@svgr/plugin-jsx': 6.5.1(@svgr/core@6.5.1) + '@svgr/plugin-svgo': 6.5.1(@svgr/core@6.5.1) + transitivePeerDependencies: + - supports-color + dev: false + + /@szmarczak/http-timer@1.1.2: + resolution: {integrity: sha512-XIB2XbzHTN6ieIjfIMV9hlVcfPU26s2vafYWQcZHWXHOxiaRZYEDKEwdl129Zyg50+foYV2jCgtrqSA6qNuNSA==} + engines: {node: '>=6'} + dependencies: + defer-to-connect: 1.1.3 + dev: false + + /@tailwindcss/typography@0.5.10(tailwindcss@3.3.5): + resolution: {integrity: sha512-Pe8BuPJQJd3FfRnm6H0ulKIGoMEQS+Vq01R6M5aCrFB/ccR/shT+0kXLjouGC1gFLm9hopTFN+DMP0pfwRWzPw==} + peerDependencies: + tailwindcss: '>=3.0.0 || insiders' + dependencies: + lodash.castarray: 4.4.0 + lodash.isplainobject: 4.0.6 + lodash.merge: 4.6.2 + postcss-selector-parser: 6.0.10 + tailwindcss: 3.3.5 + dev: true + + /@trysound/sax@0.2.0: + resolution: {integrity: sha512-L7z9BgrNEcYyUYtF+HaEfiS5ebkh9jXqbszz7pC0hRBPaatV0XjSD3+eHrpqFemQfgwiFF0QPIarnIihIDn7OA==} + engines: {node: '>=10.13.0'} + dev: false + + /@tsconfig/docusaurus@1.0.7: + resolution: {integrity: sha512-ffTXxGIP/IRMCjuzHd6M4/HdIrw1bMfC7Bv8hMkTadnePkpe0lG0oDSdbRpSDZb2rQMAgpbWiR10BvxvNYwYrg==} + dev: true + + /@types/body-parser@1.19.4: + resolution: {integrity: sha512-N7UDG0/xiPQa2D/XrVJXjkWbpqHCd2sBaB32ggRF2l83RhPfamgKGF8gwwqyksS95qUS5ZYF9aF+lLPRlwI2UA==} + dependencies: + '@types/connect': 3.4.37 + '@types/node': 20.8.9 + dev: false + + /@types/bonjour@3.5.12: + resolution: {integrity: sha512-ky0kWSqXVxSqgqJvPIkgFkcn4C8MnRog308Ou8xBBIVo39OmUFy+jqNe0nPwLCDFxUpmT9EvT91YzOJgkDRcFg==} + dependencies: + '@types/node': 20.8.9 + dev: false + + /@types/connect-history-api-fallback@1.5.2: + resolution: {integrity: sha512-gX2j9x+NzSh4zOhnRPSdPPmTepS4DfxES0AvIFv3jGv5QyeAJf6u6dY5/BAoAJU9Qq1uTvwOku8SSC2GnCRl6Q==} + dependencies: + '@types/express-serve-static-core': 4.17.39 + '@types/node': 20.8.9 + dev: false + + /@types/connect@3.4.37: + resolution: {integrity: sha512-zBUSRqkfZ59OcwXon4HVxhx5oWCJmc0OtBTK05M+p0dYjgN6iTwIL2T/WbsQZrEsdnwaF9cWQ+azOnpPvIqY3Q==} + dependencies: + '@types/node': 20.8.9 + dev: false + + /@types/eslint-scope@3.7.6: + resolution: {integrity: sha512-zfM4ipmxVKWdxtDaJ3MP3pBurDXOCoyjvlpE3u6Qzrmw4BPbfm4/ambIeTk/r/J0iq/+2/xp0Fmt+gFvXJY2PQ==} + dependencies: + '@types/eslint': 8.44.6 + '@types/estree': 1.0.3 + + /@types/eslint@8.44.6: + resolution: {integrity: sha512-P6bY56TVmX8y9J87jHNgQh43h6VVU+6H7oN7hgvivV81K2XY8qJZ5vqPy/HdUoVIelii2kChYVzQanlswPWVFw==} + dependencies: + '@types/estree': 1.0.3 + '@types/json-schema': 7.0.14 + + /@types/estree@1.0.3: + resolution: {integrity: sha512-CS2rOaoQ/eAgAfcTfq6amKG7bsN+EMcgGY4FAFQdvSj2y1ixvOZTUA9mOtCai7E1SYu283XNw7urKK30nP3wkQ==} + + /@types/express-serve-static-core@4.17.39: + resolution: {integrity: sha512-BiEUfAiGCOllomsRAZOiMFP7LAnrifHpt56pc4Z7l9K6ACyN06Ns1JLMBxwkfLOjJRlSf06NwWsT7yzfpaVpyQ==} + dependencies: + '@types/node': 20.8.9 + '@types/qs': 6.9.9 + '@types/range-parser': 1.2.6 + '@types/send': 0.17.3 + dev: false + + /@types/express@4.17.20: + resolution: {integrity: sha512-rOaqlkgEvOW495xErXMsmyX3WKBInbhG5eqojXYi3cGUaLoRDlXa5d52fkfWZT963AZ3v2eZ4MbKE6WpDAGVsw==} + dependencies: + '@types/body-parser': 1.19.4 + '@types/express-serve-static-core': 4.17.39 + '@types/qs': 6.9.9 + '@types/serve-static': 1.15.4 + dev: false + + /@types/hast@2.3.7: + resolution: {integrity: sha512-EVLigw5zInURhzfXUM65eixfadfsHKomGKUakToXo84t8gGIJuTcD2xooM2See7GyQ7DRtYjhCHnSUQez8JaLw==} + dependencies: + '@types/unist': 2.0.9 + dev: false + + /@types/history@4.7.11: + resolution: {integrity: sha512-qjDJRrmvBMiTx+jyLxvLfJU7UznFuokDv4f3WRuriHKERccVpFU+8XMQUAbDzoiJCsmexxRExQeMwwCdamSKDA==} + + /@types/html-minifier-terser@6.1.0: + resolution: {integrity: sha512-oh/6byDPnL1zeNXFrDXFLyZjkr1MsBG667IM792caf1L2UPOOMf65NFzjUH/ltyfwjAGfs1rsX1eftK0jC/KIg==} + dev: false + + /@types/http-errors@2.0.3: + resolution: {integrity: sha512-pP0P/9BnCj1OVvQR2lF41EkDG/lWWnDyA203b/4Fmi2eTyORnBtcDoKDwjWQthELrBvWkMOrvSOnZ8OVlW6tXA==} + dev: false + + /@types/http-proxy@1.17.13: + resolution: {integrity: sha512-GkhdWcMNiR5QSQRYnJ+/oXzu0+7JJEPC8vkWXK351BkhjraZF+1W13CUYARUvX9+NqIU2n6YHA4iwywsc/M6Sw==} + dependencies: + '@types/node': 20.8.9 + dev: false + + /@types/istanbul-lib-coverage@2.0.5: + resolution: {integrity: sha512-zONci81DZYCZjiLe0r6equvZut0b+dBRPBN5kBDjsONnutYNtJMoWQ9uR2RkL1gLG9NMTzvf+29e5RFfPbeKhQ==} + dev: false + + /@types/istanbul-lib-report@3.0.2: + resolution: {integrity: sha512-8toY6FgdltSdONav1XtUHl4LN1yTmLza+EuDazb/fEmRNCwjyqNVIQWs2IfC74IqjHkREs/nQ2FWq5kZU9IC0w==} + dependencies: + '@types/istanbul-lib-coverage': 2.0.5 + dev: false + + /@types/istanbul-reports@3.0.3: + resolution: {integrity: sha512-1nESsePMBlf0RPRffLZi5ujYh7IH1BWL4y9pr+Bn3cJBdxz+RTP8bUFljLz9HvzhhOSWKdyBZ4DIivdL6rvgZg==} + dependencies: + '@types/istanbul-lib-report': 3.0.2 + dev: false + + /@types/json-schema@7.0.14: + resolution: {integrity: sha512-U3PUjAudAdJBeC2pgN8uTIKgxrb4nlDF3SF0++EldXQvQBGkpFZMSnwQiIoDU77tv45VgNkl/L4ouD+rEomujw==} + + /@types/katex@0.11.1: + resolution: {integrity: sha512-DUlIj2nk0YnJdlWgsFuVKcX27MLW0KbKmGVoUHmFr+74FYYNUDAaj9ZqTADvsbE8rfxuVmSFc7KczYn5Y09ozg==} + dev: false + + /@types/keyv@3.1.4: + resolution: {integrity: sha512-BQ5aZNSCpj7D6K2ksrRCTmKRLEpnPvWDiLPfoGyhZ++8YtiK9d/3DBKPJgry359X/P1PfruyYwvnvwFjuEiEIg==} + dependencies: + '@types/node': 20.8.9 + dev: false + + /@types/mdast@3.0.14: + resolution: {integrity: sha512-gVZ04PGgw1qLZKsnWnyFv4ORnaJ+DXLdHTVSFbU8yX6xZ34Bjg4Q32yPkmveUP1yItXReKfB0Aknlh/3zxTKAw==} + dependencies: + '@types/unist': 2.0.9 + dev: false + + /@types/mime@1.3.4: + resolution: {integrity: sha512-1Gjee59G25MrQGk8bsNvC6fxNiRgUlGn2wlhGf95a59DrprnnHk80FIMMFG9XHMdrfsuA119ht06QPDXA1Z7tw==} + dev: false + + /@types/mime@3.0.3: + resolution: {integrity: sha512-i8MBln35l856k5iOhKk2XJ4SeAWg75mLIpZB4v6imOagKL6twsukBZGDMNhdOVk7yRFTMPpfILocMos59Q1otQ==} + dev: false + + /@types/node-forge@1.3.8: + resolution: {integrity: sha512-vGXshY9vim9CJjrpcS5raqSjEfKlJcWy2HNdgUasR66fAnVEYarrf1ULV4nfvpC1nZq/moA9qyqBcu83x+Jlrg==} + dependencies: + '@types/node': 20.8.9 + dev: false + + /@types/node@17.0.45: + resolution: {integrity: sha512-w+tIMs3rq2afQdsPJlODhoUEKzFP1ayaoyl1CcnwtIlsVe7K7bA1NGm4s3PraqTLlXnbIN84zuBlxBWo1u9BLw==} + dev: false + + /@types/node@20.8.9: + resolution: {integrity: sha512-UzykFsT3FhHb1h7yD4CA4YhBHq545JC0YnEz41xkipN88eKQtL6rSgocL5tbAP6Ola9Izm/Aw4Ora8He4x0BHg==} + dependencies: + undici-types: 5.26.5 + + /@types/parse-json@4.0.1: + resolution: {integrity: sha512-3YmXzzPAdOTVljVMkTMBdBEvlOLg2cDQaDhnnhT3nT9uDbnJzjWhKlzb+desT12Y7tGqaN6d+AbozcKzyL36Ng==} + dev: false + + /@types/parse5@5.0.3: + resolution: {integrity: sha512-kUNnecmtkunAoQ3CnjmMkzNU/gtxG8guhi+Fk2U/kOpIKjIMKnXGp4IJCgQJrXSgMsWYimYG4TGjz/UzbGEBTw==} + dev: false + + /@types/prop-types@15.7.9: + resolution: {integrity: sha512-n1yyPsugYNSmHgxDFjicaI2+gCNjsBck8UX9kuofAKlc0h1bL+20oSF72KeNaW2DUlesbEVCFgyV2dPGTiY42g==} + + /@types/qs@6.9.9: + resolution: {integrity: sha512-wYLxw35euwqGvTDx6zfY1vokBFnsK0HNrzc6xNHchxfO2hpuRg74GbkEW7e3sSmPvj0TjCDT1VCa6OtHXnubsg==} + dev: false + + /@types/range-parser@1.2.6: + resolution: {integrity: sha512-+0autS93xyXizIYiyL02FCY8N+KkKPhILhcUSA276HxzreZ16kl+cmwvV2qAM/PuCCwPXzOXOWhiPcw20uSFcA==} + dev: false + + /@types/react-router-config@5.0.9: + resolution: {integrity: sha512-a7zOj9yVUtM3Ns5stoseQAAsmppNxZpXDv6tZiFV5qlRmV4W96u53on1vApBX1eRSc8mrFOiB54Hc0Pk1J8GFg==} + dependencies: + '@types/history': 4.7.11 + '@types/react': 18.2.33 + '@types/react-router': 5.1.20 + + /@types/react-router-dom@5.3.3: + resolution: {integrity: sha512-kpqnYK4wcdm5UaWI3fLcELopqLrHgLqNsdpHauzlQktfkHL3npOSwtj1Uz9oKBAzs7lFtVkV8j83voAz2D8fhw==} + dependencies: + '@types/history': 4.7.11 + '@types/react': 18.2.33 + '@types/react-router': 5.1.20 + + /@types/react-router@5.1.20: + resolution: {integrity: sha512-jGjmu/ZqS7FjSH6owMcD5qpq19+1RS9DeVRqfl1FeBMxTDQAGwlMWOcs52NDoXaNKyG3d1cYQFMs9rCrb88o9Q==} + dependencies: + '@types/history': 4.7.11 + '@types/react': 18.2.33 + + /@types/react@18.2.33: + resolution: {integrity: sha512-v+I7S+hu3PIBoVkKGpSYYpiBT1ijqEzWpzQD62/jm4K74hPpSP7FF9BnKG6+fg2+62weJYkkBWDJlZt5JO/9hg==} + dependencies: + '@types/prop-types': 15.7.9 + '@types/scheduler': 0.16.5 + csstype: 3.1.2 + + /@types/responselike@1.0.2: + resolution: {integrity: sha512-/4YQT5Kp6HxUDb4yhRkm0bJ7TbjvTddqX7PZ5hz6qV3pxSo72f/6YPRo+Mu2DU307tm9IioO69l7uAwn5XNcFA==} + dependencies: + '@types/node': 20.8.9 + dev: false + + /@types/retry@0.12.0: + resolution: {integrity: sha512-wWKOClTTiizcZhXnPY4wikVAwmdYHp8q6DmC+EJUzAMsycb7HB32Kh9RN4+0gExjmPmZSAQjgURXIGATPegAvA==} + dev: false + + /@types/sax@1.2.6: + resolution: {integrity: sha512-A1mpYCYu1aHFayy8XKN57ebXeAbh9oQIZ1wXcno6b1ESUAfMBDMx7mf/QGlYwcMRaFryh9YBuH03i/3FlPGDkQ==} + dependencies: + '@types/node': 17.0.45 + dev: false + + /@types/scheduler@0.16.5: + resolution: {integrity: sha512-s/FPdYRmZR8SjLWGMCuax7r3qCWQw9QKHzXVukAuuIJkXkDRwp+Pu5LMIVFi0Fxbav35WURicYr8u1QsoybnQw==} + + /@types/send@0.17.3: + resolution: {integrity: sha512-/7fKxvKUoETxjFUsuFlPB9YndePpxxRAOfGC/yJdc9kTjTeP5kRCTzfnE8kPUKCeyiyIZu0YQ76s50hCedI1ug==} + dependencies: + '@types/mime': 1.3.4 + '@types/node': 20.8.9 + dev: false + + /@types/serve-index@1.9.3: + resolution: {integrity: sha512-4KG+yMEuvDPRrYq5fyVm/I2uqAJSAwZK9VSa+Zf+zUq9/oxSSvy3kkIqyL+jjStv6UCVi8/Aho0NHtB1Fwosrg==} + dependencies: + '@types/express': 4.17.20 + dev: false + + /@types/serve-static@1.15.4: + resolution: {integrity: sha512-aqqNfs1XTF0HDrFdlY//+SGUxmdSUbjeRXb5iaZc3x0/vMbYmdw9qvOgHWOyyLFxSSRnUuP5+724zBgfw8/WAw==} + dependencies: + '@types/http-errors': 2.0.3 + '@types/mime': 3.0.3 + '@types/node': 20.8.9 + dev: false + + /@types/sockjs@0.3.35: + resolution: {integrity: sha512-tIF57KB+ZvOBpAQwSaACfEu7htponHXaFzP7RfKYgsOS0NoYnn+9+jzp7bbq4fWerizI3dTB4NfAZoyeQKWJLw==} + dependencies: + '@types/node': 20.8.9 + dev: false + + /@types/unist@2.0.9: + resolution: {integrity: sha512-zC0iXxAv1C1ERURduJueYzkzZ2zaGyc+P2c95hgkikHPr3z8EdUZOlgEQ5X0DRmwDZn+hekycQnoeiiRVrmilQ==} + dev: false + + /@types/ws@8.5.8: + resolution: {integrity: sha512-flUksGIQCnJd6sZ1l5dqCEG/ksaoAg/eUwiLAGTJQcfgvZJKF++Ta4bJA6A5aPSJmsr+xlseHn4KLgVlNnvPTg==} + dependencies: + '@types/node': 20.8.9 + dev: false + + /@types/yargs-parser@21.0.2: + resolution: {integrity: sha512-5qcvofLPbfjmBfKaLfj/+f+Sbd6pN4zl7w7VSVI5uz7m9QZTuB2aZAa2uo1wHFBNN2x6g/SoTkXmd8mQnQF2Cw==} + dev: false + + /@types/yargs@17.0.29: + resolution: {integrity: sha512-nacjqA3ee9zRF/++a3FUY1suHTFKZeHba2n8WeDw9cCVdmzmHpIxyzOJBcpHvvEmS8E9KqWlSnWHUkOrkhWcvA==} + dependencies: + '@types/yargs-parser': 21.0.2 + dev: false + + /@webassemblyjs/ast@1.11.6: + resolution: {integrity: sha512-IN1xI7PwOvLPgjcf180gC1bqn3q/QaOCwYUahIOhbYUu8KA/3tw2RT/T0Gidi1l7Hhj5D/INhJxiICObqpMu4Q==} + dependencies: + '@webassemblyjs/helper-numbers': 1.11.6 + '@webassemblyjs/helper-wasm-bytecode': 1.11.6 + + /@webassemblyjs/floating-point-hex-parser@1.11.6: + resolution: {integrity: sha512-ejAj9hfRJ2XMsNHk/v6Fu2dGS+i4UaXBXGemOfQ/JfQ6mdQg/WXtwleQRLLS4OvfDhv8rYnVwH27YJLMyYsxhw==} + + /@webassemblyjs/helper-api-error@1.11.6: + resolution: {integrity: sha512-o0YkoP4pVu4rN8aTJgAyj9hC2Sv5UlkzCHhxqWj8butaLvnpdc2jOwh4ewE6CX0txSfLn/UYaV/pheS2Txg//Q==} + + /@webassemblyjs/helper-buffer@1.11.6: + resolution: {integrity: sha512-z3nFzdcp1mb8nEOFFk8DrYLpHvhKC3grJD2ardfKOzmbmJvEf/tPIqCY+sNcwZIY8ZD7IkB2l7/pqhUhqm7hLA==} + + /@webassemblyjs/helper-numbers@1.11.6: + resolution: {integrity: sha512-vUIhZ8LZoIWHBohiEObxVm6hwP034jwmc9kuq5GdHZH0wiLVLIPcMCdpJzG4C11cHoQ25TFIQj9kaVADVX7N3g==} + dependencies: + '@webassemblyjs/floating-point-hex-parser': 1.11.6 + '@webassemblyjs/helper-api-error': 1.11.6 + '@xtuc/long': 4.2.2 + + /@webassemblyjs/helper-wasm-bytecode@1.11.6: + resolution: {integrity: sha512-sFFHKwcmBprO9e7Icf0+gddyWYDViL8bpPjJJl0WHxCdETktXdmtWLGVzoHbqUcY4Be1LkNfwTmXOJUFZYSJdA==} + + /@webassemblyjs/helper-wasm-section@1.11.6: + resolution: {integrity: sha512-LPpZbSOwTpEC2cgn4hTydySy1Ke+XEu+ETXuoyvuyezHO3Kjdu90KK95Sh9xTbmjrCsUwvWwCOQQNta37VrS9g==} + dependencies: + '@webassemblyjs/ast': 1.11.6 + '@webassemblyjs/helper-buffer': 1.11.6 + '@webassemblyjs/helper-wasm-bytecode': 1.11.6 + '@webassemblyjs/wasm-gen': 1.11.6 + + /@webassemblyjs/ieee754@1.11.6: + resolution: {integrity: sha512-LM4p2csPNvbij6U1f19v6WR56QZ8JcHg3QIJTlSwzFcmx6WSORicYj6I63f9yU1kEUtrpG+kjkiIAkevHpDXrg==} + dependencies: + '@xtuc/ieee754': 1.2.0 + + /@webassemblyjs/leb128@1.11.6: + resolution: {integrity: sha512-m7a0FhE67DQXgouf1tbN5XQcdWoNgaAuoULHIfGFIEVKA6tu/edls6XnIlkmS6FrXAquJRPni3ZZKjw6FSPjPQ==} + dependencies: + '@xtuc/long': 4.2.2 + + /@webassemblyjs/utf8@1.11.6: + resolution: {integrity: sha512-vtXf2wTQ3+up9Zsg8sa2yWiQpzSsMyXj0qViVP6xKGCUT8p8YJ6HqI7l5eCnWx1T/FYdsv07HQs2wTFbbof/RA==} + + /@webassemblyjs/wasm-edit@1.11.6: + resolution: {integrity: sha512-Ybn2I6fnfIGuCR+Faaz7YcvtBKxvoLV3Lebn1tM4o/IAJzmi9AWYIPWpyBfU8cC+JxAO57bk4+zdsTjJR+VTOw==} + dependencies: + '@webassemblyjs/ast': 1.11.6 + '@webassemblyjs/helper-buffer': 1.11.6 + '@webassemblyjs/helper-wasm-bytecode': 1.11.6 + '@webassemblyjs/helper-wasm-section': 1.11.6 + '@webassemblyjs/wasm-gen': 1.11.6 + '@webassemblyjs/wasm-opt': 1.11.6 + '@webassemblyjs/wasm-parser': 1.11.6 + '@webassemblyjs/wast-printer': 1.11.6 + + /@webassemblyjs/wasm-gen@1.11.6: + resolution: {integrity: sha512-3XOqkZP/y6B4F0PBAXvI1/bky7GryoogUtfwExeP/v7Nzwo1QLcq5oQmpKlftZLbT+ERUOAZVQjuNVak6UXjPA==} + dependencies: + '@webassemblyjs/ast': 1.11.6 + '@webassemblyjs/helper-wasm-bytecode': 1.11.6 + '@webassemblyjs/ieee754': 1.11.6 + '@webassemblyjs/leb128': 1.11.6 + '@webassemblyjs/utf8': 1.11.6 + + /@webassemblyjs/wasm-opt@1.11.6: + resolution: {integrity: sha512-cOrKuLRE7PCe6AsOVl7WasYf3wbSo4CeOk6PkrjS7g57MFfVUF9u6ysQBBODX0LdgSvQqRiGz3CXvIDKcPNy4g==} + dependencies: + '@webassemblyjs/ast': 1.11.6 + '@webassemblyjs/helper-buffer': 1.11.6 + '@webassemblyjs/wasm-gen': 1.11.6 + '@webassemblyjs/wasm-parser': 1.11.6 + + /@webassemblyjs/wasm-parser@1.11.6: + resolution: {integrity: sha512-6ZwPeGzMJM3Dqp3hCsLgESxBGtT/OeCvCZ4TA1JUPYgmhAx38tTPR9JaKy0S5H3evQpO/h2uWs2j6Yc/fjkpTQ==} + dependencies: + '@webassemblyjs/ast': 1.11.6 + '@webassemblyjs/helper-api-error': 1.11.6 + '@webassemblyjs/helper-wasm-bytecode': 1.11.6 + '@webassemblyjs/ieee754': 1.11.6 + '@webassemblyjs/leb128': 1.11.6 + '@webassemblyjs/utf8': 1.11.6 + + /@webassemblyjs/wast-printer@1.11.6: + resolution: {integrity: sha512-JM7AhRcE+yW2GWYaKeHL5vt4xqee5N2WcezptmgyhNS+ScggqcT1OtXykhAb13Sn5Yas0j2uv9tHgrjwvzAP4A==} + dependencies: + '@webassemblyjs/ast': 1.11.6 + '@xtuc/long': 4.2.2 + + /@xtuc/ieee754@1.2.0: + resolution: {integrity: sha512-DX8nKgqcGwsc0eJSqYt5lwP4DH5FlHnmuWWBRy7X0NcaGR0ZtuyeESgMwTYVEtxmsNGY+qit4QYT/MIYTOTPeA==} + + /@xtuc/long@4.2.2: + resolution: {integrity: sha512-NuHqBY1PB/D8xU6s/thBgOAiAP7HOYDQ32+BFZILJ8ivkUkAHQnWfn6WhL79Owj1qmUnoN/YPhktdIoucipkAQ==} + + /accepts@1.3.8: + resolution: {integrity: sha512-PYAthTa2m2VKxuvSD3DPC/Gy+U+sOA1LAuT8mkmRuvw+NACSaeXEQ+NHcVF7rONl6qcaxV3Uuemwawk+7+SJLw==} + engines: {node: '>= 0.6'} + dependencies: + mime-types: 2.1.35 + negotiator: 0.6.3 + dev: false + + /acorn-import-assertions@1.9.0(acorn@8.11.2): + resolution: {integrity: sha512-cmMwop9x+8KFhxvKrKfPYmN6/pKTYYHBqLa0DfvVZcKMJWNyWLnaqND7dx/qn66R7ewM1UX5XMaDVP5wlVTaVA==} + peerDependencies: + acorn: ^8 + dependencies: + acorn: 8.11.2 + + /acorn-walk@8.3.0: + resolution: {integrity: sha512-FS7hV565M5l1R08MXqo8odwMTB02C2UqzB17RVgu9EyuYFBqJZ3/ZY97sQD5FewVu1UyDFc1yztUDrAwT0EypA==} + engines: {node: '>=0.4.0'} + dev: false + + /acorn@8.11.2: + resolution: {integrity: sha512-nc0Axzp/0FILLEVsm4fNwLCwMttvhEI263QtVPQcbpfZZ3ts0hLsZGOpE6czNlid7CJ9MlyH8reXkpsf3YUY4w==} + engines: {node: '>=0.4.0'} + hasBin: true + + /address@1.2.2: + resolution: {integrity: sha512-4B/qKCfeE/ODUaAUpSwfzazo5x29WD4r3vXiWsB7I2mSDAihwEqKO+g8GELZUQSSAo5e1XTYh3ZVfLyxBc12nA==} + engines: {node: '>= 10.0.0'} + dev: false + + /aggregate-error@3.1.0: + resolution: {integrity: sha512-4I7Td01quW/RpocfNayFdFVk1qSuoh0E7JrbRJ16nH01HhKFQ88INq9Sd+nd72zqRySlr9BmDA8xlEJ6vJMrYA==} + engines: {node: '>=8'} + dependencies: + clean-stack: 2.2.0 + indent-string: 4.0.0 + dev: false + + /ajv-formats@2.1.1(ajv@8.12.0): + resolution: {integrity: sha512-Wx0Kx52hxE7C18hkMEggYlEifqWZtYaRgouJor+WMdPnQyEK13vgEWyVNup7SoeeoLMsr4kf5h6dOW11I15MUA==} + peerDependencies: + ajv: ^8.0.0 + peerDependenciesMeta: + ajv: + optional: true + dependencies: + ajv: 8.12.0 + dev: false + + /ajv-keywords@3.5.2(ajv@6.12.6): + resolution: {integrity: sha512-5p6WTN0DdTGVQk6VjcEju19IgaHudalcfabD7yhDGeA6bcQnmL+CpveLJq/3hvfwd1aof6L386Ougkx6RfyMIQ==} + peerDependencies: + ajv: ^6.9.1 + dependencies: + ajv: 6.12.6 + + /ajv-keywords@5.1.0(ajv@8.12.0): + resolution: {integrity: sha512-YCS/JNFAUyr5vAuhk1DWm1CBxRHW9LbJ2ozWeemrIqpbsqKjHVxYPyi5GC0rjZIT5JxJ3virVTS8wk4i/Z+krw==} + peerDependencies: + ajv: ^8.8.2 + dependencies: + ajv: 8.12.0 + fast-deep-equal: 3.1.3 + dev: false + + /ajv@6.12.6: + resolution: {integrity: sha512-j3fVLgvTo527anyYyJOGTYJbG+vnnQYvE0m5mmkc1TK+nxAppkCLMIL0aZ4dblVCNoGShhm+kzE4ZUykBoMg4g==} + dependencies: + fast-deep-equal: 3.1.3 + fast-json-stable-stringify: 2.1.0 + json-schema-traverse: 0.4.1 + uri-js: 4.4.1 + + /ajv@8.12.0: + resolution: {integrity: sha512-sRu1kpcO9yLtYxBKvqfTeh9KzZEwO3STyX1HT+4CaDzC6HpTGYhIhPIzj9XuKU7KYDwnaeh5hcOwjy1QuJzBPA==} + dependencies: + fast-deep-equal: 3.1.3 + json-schema-traverse: 1.0.0 + require-from-string: 2.0.2 + uri-js: 4.4.1 + dev: false + + /algoliasearch-helper@3.15.0(algoliasearch@4.20.0): + resolution: {integrity: sha512-DGUnK3TGtDQsaUE4ayF/LjSN0DGsuYThB8WBgnnDY0Wq04K6lNVruO3LfqJOgSfDiezp+Iyt8Tj4YKHi+/ivSA==} + peerDependencies: + algoliasearch: '>= 3.1 < 6' + dependencies: + '@algolia/events': 4.0.1 + algoliasearch: 4.20.0 + dev: false + + /algoliasearch@4.20.0: + resolution: {integrity: sha512-y+UHEjnOItoNy0bYO+WWmLWBlPwDjKHW6mNHrPi0NkuhpQOOEbrkwQH/wgKFDLh7qlKjzoKeiRtlpewDPDG23g==} + dependencies: + '@algolia/cache-browser-local-storage': 4.20.0 + '@algolia/cache-common': 4.20.0 + '@algolia/cache-in-memory': 4.20.0 + '@algolia/client-account': 4.20.0 + '@algolia/client-analytics': 4.20.0 + '@algolia/client-common': 4.20.0 + '@algolia/client-personalization': 4.20.0 + '@algolia/client-search': 4.20.0 + '@algolia/logger-common': 4.20.0 + '@algolia/logger-console': 4.20.0 + '@algolia/requester-browser-xhr': 4.20.0 + '@algolia/requester-common': 4.20.0 + '@algolia/requester-node-http': 4.20.0 + '@algolia/transporter': 4.20.0 + dev: false + + /ansi-align@3.0.1: + resolution: {integrity: sha512-IOfwwBF5iczOjp/WeY4YxyjqAFMQoZufdQWDd19SEExbVLNXqvpzSJ/M7Za4/sCPmQ0+GRquoA7bGcINcxew6w==} + dependencies: + string-width: 4.2.3 + dev: false + + /ansi-html-community@0.0.8: + resolution: {integrity: sha512-1APHAyr3+PCamwNw3bXCPp4HFLONZt/yIH0sZp0/469KWNTEy+qN5jQ3GVX6DMZ1UXAi34yVwtTeaG/HpBuuzw==} + engines: {'0': node >= 0.8.0} + hasBin: true + dev: false + + /ansi-regex@5.0.1: + resolution: {integrity: sha512-quJQXlTSUGL2LH9SUXo8VwsY4soanhgo6LNSm84E1LBcE8s3O0wpdiRzyR9z/ZZJMlMWv37qOOb9pdJlMUEKFQ==} + engines: {node: '>=8'} + dev: false + + /ansi-regex@6.0.1: + resolution: {integrity: sha512-n5M855fKb2SsfMIiFFoVrABHJC8QtHwVx+mHWP3QcEqBHYienj5dHSgjbxtC0WEZXYt4wcD6zrQElDPhFuZgfA==} + engines: {node: '>=12'} + dev: false + + /ansi-styles@3.2.1: + resolution: {integrity: sha512-VT0ZI6kZRdTh8YyJw3SMbYm/u+NqfsAxEpWO0Pf9sq8/e94WxxOpPKx9FR1FlyCtOVDNOQ+8ntlqFxiRc+r5qA==} + engines: {node: '>=4'} + dependencies: + color-convert: 1.9.3 + dev: false + + /ansi-styles@4.3.0: + resolution: {integrity: sha512-zbB9rCJAT1rbjiVDb2hqKFHNYLxgtk8NURxZ3IZwD3F6NtxbXZQCnnSi1Lkx+IDohdPlFp222wVALIheZJQSEg==} + engines: {node: '>=8'} + dependencies: + color-convert: 2.0.1 + dev: false + + /ansi-styles@6.2.1: + resolution: {integrity: sha512-bN798gFfQX+viw3R7yrGWRqnrN2oRkEkUjjl4JNn4E8GxxbjtG3FbrEIIY3l8/hrwUwIeCZvi4QuOTP4MErVug==} + engines: {node: '>=12'} + dev: false + + /any-promise@1.3.0: + resolution: {integrity: sha512-7UvmKalWRt1wgjL1RrGxoSJW/0QZFIegpeGvZG9kjp8vrRu55XTHbwnqq2GpXm9uLbcuhxm3IqX9OB4MZR1b2A==} + dev: true + + /anymatch@3.1.3: + resolution: {integrity: sha512-KMReFUr0B4t+D+OBkjR3KYqvocp2XaSzO55UcB6mgQMd3KbcE+mWTyvVV7D/zsdEbNnV6acZUutkiHQXvTr1Rw==} + engines: {node: '>= 8'} + dependencies: + normalize-path: 3.0.0 + picomatch: 2.3.1 + + /arg@5.0.2: + resolution: {integrity: sha512-PYjyFOLKQ9y57JvQ6QLo8dAgNqswh8M1RMJYdQduT6xbWSgK36P/Z/v+p888pM69jMMfS8Xd8F6I1kQ/I9HUGg==} + + /argparse@1.0.10: + resolution: {integrity: sha512-o5Roy6tNG4SL/FOkCAN6RzjiakZS25RLYFrcMttJqbdd8BWrnA+fGz57iN5Pb06pvBGvl5gQ0B48dJlslXvoTg==} + dependencies: + sprintf-js: 1.0.3 + dev: false + + /argparse@2.0.1: + resolution: {integrity: sha512-8+9WqebbFzpX9OR+Wa6O29asIogeRMzcGtAINdpMHHyAg10f05aSFVBbcEqGf/PXw1EjAZ+q2/bEBg3DvurK3Q==} + dev: false + + /aria-hidden@1.2.3: + resolution: {integrity: sha512-xcLxITLe2HYa1cnYnwCjkOO1PqUHQpozB8x9AR0OgWN2woOBi5kSDVxKfd0b7sb1hw5qFeJhXm9H1nu3xSfLeQ==} + engines: {node: '>=10'} + dependencies: + tslib: 2.6.2 + dev: false + + /array-flatten@1.1.1: + resolution: {integrity: sha512-PCVAQswWemu6UdxsDFFX/+gVeYqKAod3D3UVm91jHwynguOwAvYPhx8nNlM++NqRcK6CxxpUafjmhIdKiHibqg==} + dev: false + + /array-flatten@2.1.2: + resolution: {integrity: sha512-hNfzcOV8W4NdualtqBFPyVO+54DSJuZGY9qT4pRroB6S9e3iiido2ISIC5h9R2sPJ8H3FHCIiEnsv1lPXO3KtQ==} + dev: false + + /array-union@2.1.0: + resolution: {integrity: sha512-HGyxoOTYUyCM6stUe6EJgnd4EoewAI7zMdfqO+kGjnlZmBDz/cR5pf8r/cR4Wq60sL/p0IkcjUEEPwS3GFrIyw==} + engines: {node: '>=8'} + dev: false + + /asap@2.0.6: + resolution: {integrity: sha512-BSHWgDSAiKs50o2Re8ppvp3seVHXSRM44cdSsT9FfNEUUZLOGWVCsiWaRPWM1Znn+mqZ1OfVZ3z3DWEzSp7hRA==} + dev: false + + /at-least-node@1.0.0: + resolution: {integrity: sha512-+q/t7Ekv1EDY2l6Gda6LLiX14rU9TV20Wa3ofeQmwPFZbOMo9DXrLbOjFaaclkXKWidIaopwAObQDqwWtGUjqg==} + engines: {node: '>= 4.0.0'} + dev: false + + /autoprefixer@10.4.16(postcss@8.4.31): + resolution: {integrity: sha512-7vd3UC6xKp0HLfua5IjZlcXvGAGy7cBAXTg2lyQ/8WpNhd6SiZ8Be+xm3FyBSYJx5GKcpRCzBh7RH4/0dnY+uQ==} + engines: {node: ^10 || ^12 || >=14} + hasBin: true + peerDependencies: + postcss: ^8.1.0 + dependencies: + browserslist: 4.22.1 + caniuse-lite: 1.0.30001554 + fraction.js: 4.3.7 + normalize-range: 0.1.2 + picocolors: 1.0.0 + postcss: 8.4.31 + postcss-value-parser: 4.2.0 + + /axios@0.25.0: + resolution: {integrity: sha512-cD8FOb0tRH3uuEe6+evtAbgJtfxr7ly3fQjYcMcuPlgkwVS9xboaVIpcDV+cYQe+yGykgwZCs1pzjntcGa6l5g==} + dependencies: + follow-redirects: 1.15.3 + transitivePeerDependencies: + - debug + dev: false + + /babel-loader@8.3.0(@babel/core@7.23.2)(webpack@5.89.0): + resolution: {integrity: sha512-H8SvsMF+m9t15HNLMipppzkC+Y2Yq+v3SonZyU70RBL/h1gxPkH08Ot8pEE9Z4Kd+czyWJClmFS8qzIP9OZ04Q==} + engines: {node: '>= 8.9'} + peerDependencies: + '@babel/core': ^7.0.0 + webpack: '>=2' + dependencies: + '@babel/core': 7.23.2 + find-cache-dir: 3.3.2 + loader-utils: 2.0.4 + make-dir: 3.1.0 + schema-utils: 2.7.1 + webpack: 5.89.0 + dev: false + + /babel-plugin-apply-mdx-type-prop@1.6.22(@babel/core@7.12.9): + resolution: {integrity: sha512-VefL+8o+F/DfK24lPZMtJctrCVOfgbqLAGZSkxwhazQv4VxPg3Za/i40fu22KR2m8eEda+IfSOlPLUSIiLcnCQ==} + peerDependencies: + '@babel/core': ^7.11.6 + dependencies: + '@babel/core': 7.12.9 + '@babel/helper-plugin-utils': 7.10.4 + '@mdx-js/util': 1.6.22 + dev: false + + /babel-plugin-dynamic-import-node@2.3.3: + resolution: {integrity: sha512-jZVI+s9Zg3IqA/kdi0i6UDCybUI3aSBLnglhYbSSjKlV7yF1F/5LWv8MakQmvYpnbJDS6fcBL2KzHSxNCMtWSQ==} + dependencies: + object.assign: 4.1.4 + dev: false + + /babel-plugin-extract-import-names@1.6.22: + resolution: {integrity: sha512-yJ9BsJaISua7d8zNT7oRG1ZLBJCIdZ4PZqmH8qa9N5AK01ifk3fnkc98AXhtzE7UkfCsEumvoQWgoYLhOnJ7jQ==} + dependencies: + '@babel/helper-plugin-utils': 7.10.4 + dev: false + + /babel-plugin-polyfill-corejs2@0.4.6(@babel/core@7.23.2): + resolution: {integrity: sha512-jhHiWVZIlnPbEUKSSNb9YoWcQGdlTLq7z1GHL4AjFxaoOUMuuEVJ+Y4pAaQUGOGk93YsVCKPbqbfw3m0SM6H8Q==} + peerDependencies: + '@babel/core': ^7.4.0 || ^8.0.0-0 <8.0.0 + dependencies: + '@babel/compat-data': 7.23.2 + '@babel/core': 7.23.2 + '@babel/helper-define-polyfill-provider': 0.4.3(@babel/core@7.23.2) + semver: 6.3.1 + transitivePeerDependencies: + - supports-color + dev: false + + /babel-plugin-polyfill-corejs3@0.8.6(@babel/core@7.23.2): + resolution: {integrity: sha512-leDIc4l4tUgU7str5BWLS2h8q2N4Nf6lGZP6UrNDxdtfF2g69eJ5L0H7S8A5Ln/arfFAfHor5InAdZuIOwZdgQ==} + peerDependencies: + '@babel/core': ^7.4.0 || ^8.0.0-0 <8.0.0 + dependencies: + '@babel/core': 7.23.2 + '@babel/helper-define-polyfill-provider': 0.4.3(@babel/core@7.23.2) + core-js-compat: 3.33.1 + transitivePeerDependencies: + - supports-color + dev: false + + /babel-plugin-polyfill-regenerator@0.5.3(@babel/core@7.23.2): + resolution: {integrity: sha512-8sHeDOmXC8csczMrYEOf0UTNa4yE2SxV5JGeT/LP1n0OYVDUUFPxG9vdk2AlDlIit4t+Kf0xCtpgXPBwnn/9pw==} + peerDependencies: + '@babel/core': ^7.4.0 || ^8.0.0-0 <8.0.0 + dependencies: + '@babel/core': 7.23.2 + '@babel/helper-define-polyfill-provider': 0.4.3(@babel/core@7.23.2) + transitivePeerDependencies: + - supports-color + dev: false + + /bail@1.0.5: + resolution: {integrity: sha512-xFbRxM1tahm08yHBP16MMjVUAvDaBMD38zsM9EMAUN61omwLmKlOpB/Zku5QkjZ8TZ4vn53pj+t518cH0S03RQ==} + dev: false + + /balanced-match@1.0.2: + resolution: {integrity: sha512-3oSeUO0TMV67hN1AmbXsK4yaqU7tjiHlbxRDZOpH0KW9+CeX4bRAaX0Anxt0tx2MrpRpWwQaPwIlISEJhYU5Pw==} + + /base16@1.0.0: + resolution: {integrity: sha512-pNdYkNPiJUnEhnfXV56+sQy8+AaPcG3POZAUnwr4EeqCUZFz4u2PePbo3e5Gj4ziYPCWGUZT9RHisvJKnwFuBQ==} + dev: false + + /batch@0.6.1: + resolution: {integrity: sha512-x+VAiMRL6UPkx+kudNvxTl6hB2XNNCG2r+7wixVfIYwu/2HKRXimwQyaumLjMveWvT2Hkd/cAJw+QBMfJ/EKVw==} + dev: false + + /big.js@5.2.2: + resolution: {integrity: sha512-vyL2OymJxmarO8gxMr0mhChsO9QGwhynfuu4+MHTAW6czfq9humCB7rKpUjDd9YUiDPU4mzpyupFSvOClAwbmQ==} + dev: false + + /binary-extensions@2.2.0: + resolution: {integrity: sha512-jDctJ/IVQbZoJykoeHbhXpOlNBqGNcwXJKJog42E5HDPUwQTSdjCHdihjj0DlnheQ7blbT6dHOafNAiS8ooQKA==} + engines: {node: '>=8'} + + /body-parser@1.20.1: + resolution: {integrity: sha512-jWi7abTbYwajOytWCQc37VulmWiRae5RyTpaCyDcS5/lMdtwSz5lOpDE67srw/HYe35f1z3fDQw+3txg7gNtWw==} + engines: {node: '>= 0.8', npm: 1.2.8000 || >= 1.4.16} + dependencies: + bytes: 3.1.2 + content-type: 1.0.5 + debug: 2.6.9 + depd: 2.0.0 + destroy: 1.2.0 + http-errors: 2.0.0 + iconv-lite: 0.4.24 + on-finished: 2.4.1 + qs: 6.11.0 + raw-body: 2.5.1 + type-is: 1.6.18 + unpipe: 1.0.0 + transitivePeerDependencies: + - supports-color + dev: false + + /bonjour-service@1.1.1: + resolution: {integrity: sha512-Z/5lQRMOG9k7W+FkeGTNjh7htqn/2LMnfOvBZ8pynNZCM9MwkQkI3zeI4oz09uWdcgmgHugVvBqxGg4VQJ5PCg==} + dependencies: + array-flatten: 2.1.2 + dns-equal: 1.0.0 + fast-deep-equal: 3.1.3 + multicast-dns: 7.2.5 + dev: false + + /boolbase@1.0.0: + resolution: {integrity: sha512-JZOSA7Mo9sNGB8+UjSgzdLtokWAky1zbztM3WRLCbZ70/3cTANmQmOdR7y2g+J0e2WXywy1yS468tY+IruqEww==} + dev: false + + /boxen@5.1.2: + resolution: {integrity: sha512-9gYgQKXx+1nP8mP7CzFyaUARhg7D3n1dF/FnErWmu9l6JvGpNUN278h0aSb+QjoiKSWG+iZ3uHrcqk0qrY9RQQ==} + engines: {node: '>=10'} + dependencies: + ansi-align: 3.0.1 + camelcase: 6.3.0 + chalk: 4.1.2 + cli-boxes: 2.2.1 + string-width: 4.2.3 + type-fest: 0.20.2 + widest-line: 3.1.0 + wrap-ansi: 7.0.0 + dev: false + + /boxen@6.2.1: + resolution: {integrity: sha512-H4PEsJXfFI/Pt8sjDWbHlQPx4zL/bvSQjcilJmaulGt5mLDorHOHpmdXAJcBcmru7PhYSp/cDMWRko4ZUMFkSw==} + engines: {node: ^12.20.0 || ^14.13.1 || >=16.0.0} + dependencies: + ansi-align: 3.0.1 + camelcase: 6.3.0 + chalk: 4.1.2 + cli-boxes: 3.0.0 + string-width: 5.1.2 + type-fest: 2.19.0 + widest-line: 4.0.1 + wrap-ansi: 8.1.0 + dev: false + + /brace-expansion@1.1.11: + resolution: {integrity: sha512-iCuPHDFgrHX7H2vEI/5xpz07zSHB00TpugqhmYtVmMO6518mCuRMoOYFldEBl0g187ufozdaHgWKcYFb61qGiA==} + dependencies: + balanced-match: 1.0.2 + concat-map: 0.0.1 + + /braces@3.0.2: + resolution: {integrity: sha512-b8um+L1RzM3WDSzvhm6gIz1yfTbBt6YTlcEKAvsmqCZZFw46z626lVj9j1yEPW33H5H+lBQpZMP1k8l+78Ha0A==} + engines: {node: '>=8'} + dependencies: + fill-range: 7.0.1 + + /browserslist@4.22.1: + resolution: {integrity: sha512-FEVc202+2iuClEhZhrWy6ZiAcRLvNMyYcxZ8raemul1DYVOVdFsbqckWLdsixQZCpJlwe77Z3UTalE7jsjnKfQ==} + engines: {node: ^6 || ^7 || ^8 || ^9 || ^10 || ^11 || ^12 || >=13.7} + hasBin: true + dependencies: + caniuse-lite: 1.0.30001554 + electron-to-chromium: 1.4.568 + node-releases: 2.0.13 + update-browserslist-db: 1.0.13(browserslist@4.22.1) + + /buffer-from@1.1.2: + resolution: {integrity: sha512-E+XQCRwSbaaiChtv6k6Dwgc+bx+Bs6vuKJHHl5kox/BaKbhiXzqQOwK4cO22yElGp2OCmjwVhT3HmxgyPGnJfQ==} + + /bytes@3.0.0: + resolution: {integrity: sha512-pMhOfFDPiv9t5jjIXkHosWmkSyQbvsgEVNkz0ERHbuLh2T/7j4Mqqpz523Fe8MVY89KC6Sh/QfS2sM+SjgFDcw==} + engines: {node: '>= 0.8'} + dev: false + + /bytes@3.1.2: + resolution: {integrity: sha512-/Nf7TyzTx6S3yRJObOAV7956r8cr2+Oj8AC5dt8wSP3BQAoeX58NoHyCU8P8zGkNXStjTSi6fzO6F0pBdcYbEg==} + engines: {node: '>= 0.8'} + dev: false + + /cacheable-request@6.1.0: + resolution: {integrity: sha512-Oj3cAGPCqOZX7Rz64Uny2GYAZNliQSqfbePrgAQ1wKAihYmCUnraBtJtKcGR4xz7wF+LoJC+ssFZvv5BgF9Igg==} + engines: {node: '>=8'} + dependencies: + clone-response: 1.0.3 + get-stream: 5.2.0 + http-cache-semantics: 4.1.1 + keyv: 3.1.0 + lowercase-keys: 2.0.0 + normalize-url: 4.5.1 + responselike: 1.0.2 + dev: false + + /call-bind@1.0.5: + resolution: {integrity: sha512-C3nQxfFZxFRVoJoGKKI8y3MOEo129NQ+FgQ08iye+Mk4zNZZGdjfs06bVTr+DBSlA66Q2VEcMki/cUCP4SercQ==} + dependencies: + function-bind: 1.1.2 + get-intrinsic: 1.2.2 + set-function-length: 1.1.1 + dev: false + + /callsites@3.1.0: + resolution: {integrity: sha512-P8BjAsXvZS+VIDUI11hHCQEv74YT67YUi5JJFNWIqL235sBmjX4+qx9Muvls5ivyNENctx46xQLQ3aTuE7ssaQ==} + engines: {node: '>=6'} + dev: false + + /camel-case@4.1.2: + resolution: {integrity: sha512-gxGWBrTT1JuMx6R+o5PTXMmUnhnVzLQ9SNutD4YqKtI6ap897t3tKECYla6gCWEkplXnlNybEkZg9GEGxKFCgw==} + dependencies: + pascal-case: 3.1.2 + tslib: 2.6.2 + dev: false + + /camelcase-css@2.0.1: + resolution: {integrity: sha512-QOSvevhslijgYwRx6Rv7zKdMF8lbRmx+uQGx2+vDc+KI/eBnsy9kit5aj23AgGu3pa4t9AgwbnXWqS+iOY+2aA==} + engines: {node: '>= 6'} + + /camelcase@6.3.0: + resolution: {integrity: sha512-Gmy6FhYlCY7uOElZUSbxo2UCDH8owEk996gkbrpsgGtrJLM3J7jGxl9Ic7Qwwj4ivOE5AWZWRMecDdF7hqGjFA==} + engines: {node: '>=10'} + dev: false + + /caniuse-api@3.0.0: + resolution: {integrity: sha512-bsTwuIg/BZZK/vreVTYYbSWoe2F+71P7K5QGEX+pT250DZbfU1MQ5prOKpPR+LL6uWKK3KMwMCAS74QB3Um1uw==} + dependencies: + browserslist: 4.22.1 + caniuse-lite: 1.0.30001554 + lodash.memoize: 4.1.2 + lodash.uniq: 4.5.0 + dev: false + + /caniuse-lite@1.0.30001554: + resolution: {integrity: sha512-A2E3U//MBwbJVzebddm1YfNp7Nud5Ip+IPn4BozBmn4KqVX7AvluoIDFWjsv5OkGnKUXQVmMSoMKLa3ScCblcQ==} + + /ccount@1.1.0: + resolution: {integrity: sha512-vlNK021QdI7PNeiUh/lKkC/mNHHfV0m/Ad5JoI0TYtlBnJAslM/JIkm/tGC88bkLIwO6OQ5uV6ztS6kVAtCDlg==} + dev: false + + /chalk@2.4.2: + resolution: {integrity: sha512-Mti+f9lpJNcwF4tWV8/OrTTtF1gZi+f8FqlyAdouralcFWFQWF2+NgCHShjkCb+IFBLq9buZwE1xckQU4peSuQ==} + engines: {node: '>=4'} + dependencies: + ansi-styles: 3.2.1 + escape-string-regexp: 1.0.5 + supports-color: 5.5.0 + dev: false + + /chalk@4.1.2: + resolution: {integrity: sha512-oKnbhFyRIXpUuez8iBMmyEa4nbj4IOQyuhc/wy9kY7/WVPcwIO9VA668Pu8RkO7+0G76SLROeyw9CpQ061i4mA==} + engines: {node: '>=10'} + dependencies: + ansi-styles: 4.3.0 + supports-color: 7.2.0 + dev: false + + /character-entities-legacy@1.1.4: + resolution: {integrity: sha512-3Xnr+7ZFS1uxeiUDvV02wQ+QDbc55o97tIV5zHScSPJpcLm/r0DFPcoY3tYRp+VZukxuMeKgXYmsXQHO05zQeA==} + dev: false + + /character-entities@1.2.4: + resolution: {integrity: sha512-iBMyeEHxfVnIakwOuDXpVkc54HijNgCyQB2w0VfGQThle6NXn50zU6V/u+LDhxHcDUPojn6Kpga3PTAD8W1bQw==} + dev: false + + /character-reference-invalid@1.1.4: + resolution: {integrity: sha512-mKKUkUbhPpQlCOfIuZkvSEgktjPFIsZKRRbC6KWVEMvlzblj3i3asQv5ODsrwt0N3pHAEvjP8KTQPHkp0+6jOg==} + dev: false + + /cheerio-select@2.1.0: + resolution: {integrity: sha512-9v9kG0LvzrlcungtnJtpGNxY+fzECQKhK4EGJX2vByejiMX84MFNQw4UxPJl3bFbTMw+Dfs37XaIkCwTZfLh4g==} + dependencies: + boolbase: 1.0.0 + css-select: 5.1.0 + css-what: 6.1.0 + domelementtype: 2.3.0 + domhandler: 5.0.3 + domutils: 3.1.0 + dev: false + + /cheerio@1.0.0-rc.12: + resolution: {integrity: sha512-VqR8m68vM46BNnuZ5NtnGBKIE/DfN0cRIzg9n40EIq9NOv90ayxLBXA8fXC5gquFRGJSTRqBq25Jt2ECLR431Q==} + engines: {node: '>= 6'} + dependencies: + cheerio-select: 2.1.0 + dom-serializer: 2.0.0 + domhandler: 5.0.3 + domutils: 3.1.0 + htmlparser2: 8.0.2 + parse5: 7.1.2 + parse5-htmlparser2-tree-adapter: 7.0.0 + dev: false + + /chokidar@3.5.3: + resolution: {integrity: sha512-Dr3sfKRP6oTcjf2JmUmFJfeVMvXBdegxB0iVQ5eb2V10uFJUCAS8OByZdVAyVb8xXNz3GjjTgj9kLWsZTqE6kw==} + engines: {node: '>= 8.10.0'} + dependencies: + anymatch: 3.1.3 + braces: 3.0.2 + glob-parent: 5.1.2 + is-binary-path: 2.1.0 + is-glob: 4.0.3 + normalize-path: 3.0.0 + readdirp: 3.6.0 + optionalDependencies: + fsevents: 2.3.3 + + /chrome-trace-event@1.0.3: + resolution: {integrity: sha512-p3KULyQg4S7NIHixdwbGX+nFHkoBiA4YQmyWtjb8XngSKV124nJmRysgAeujbUVb15vh+RvFUfCPqU7rXk+hZg==} + engines: {node: '>=6.0'} + + /ci-info@2.0.0: + resolution: {integrity: sha512-5tK7EtrZ0N+OLFMthtqOj4fI2Jeb88C4CAZPu25LDVUgXJ0A3Js4PMGqrn0JU1W0Mh1/Z8wZzYPxqUrXeBboCQ==} + dev: false + + /ci-info@3.9.0: + resolution: {integrity: sha512-NIxF55hv4nSqQswkAeiOi1r83xy8JldOFDTWiug55KBu9Jnblncd2U6ViHmYgHf01TPZS77NJBhBMKdWj9HQMQ==} + engines: {node: '>=8'} + dev: false + + /clean-css@5.3.2: + resolution: {integrity: sha512-JVJbM+f3d3Q704rF4bqQ5UUyTtuJ0JRKNbTKVEeujCCBoMdkEi+V+e8oktO9qGQNSvHrFTM6JZRXrUvGR1czww==} + engines: {node: '>= 10.0'} + dependencies: + source-map: 0.6.1 + dev: false + + /clean-stack@2.2.0: + resolution: {integrity: sha512-4diC9HaTE+KRAMWhDhrGOECgWZxoevMc5TlkObMqNSsVU62PYzXZ/SMTjzyGAFF1YusgxGcSWTEXBhp0CPwQ1A==} + engines: {node: '>=6'} + dev: false + + /cli-boxes@2.2.1: + resolution: {integrity: sha512-y4coMcylgSCdVinjiDBuR8PCC2bLjyGTwEmPb9NHR/QaNU6EUOXcTY/s6VjGMD6ENSEaeQYHCY0GNGS5jfMwPw==} + engines: {node: '>=6'} + dev: false + + /cli-boxes@3.0.0: + resolution: {integrity: sha512-/lzGpEWL/8PfI0BmBOPRwp0c/wFNX1RdUML3jK/RcSBA9T8mZDdQpqYBKtCFTOfQbwPqWEOpjqW+Fnayc0969g==} + engines: {node: '>=10'} + dev: false + + /cli-table3@0.6.3: + resolution: {integrity: sha512-w5Jac5SykAeZJKntOxJCrm63Eg5/4dhMWIcuTbo9rpE+brgaSZo0RuNJZeOyMgsUdhDeojvgyQLmjI+K50ZGyg==} + engines: {node: 10.* || >= 12.*} + dependencies: + string-width: 4.2.3 + optionalDependencies: + '@colors/colors': 1.5.0 + dev: false + + /clone-deep@4.0.1: + resolution: {integrity: sha512-neHB9xuzh/wk0dIHweyAXv2aPGZIVk3pLMe+/RNzINf17fe0OG96QroktYAUm7SM1PBnzTabaLboqqxDyMU+SQ==} + engines: {node: '>=6'} + dependencies: + is-plain-object: 2.0.4 + kind-of: 6.0.3 + shallow-clone: 3.0.1 + + /clone-response@1.0.3: + resolution: {integrity: sha512-ROoL94jJH2dUVML2Y/5PEDNaSHgeOdSDicUyS7izcF63G6sTc/FTjLub4b8Il9S8S0beOfYt0TaA5qvFK+w0wA==} + dependencies: + mimic-response: 1.0.1 + dev: false + + /clsx@1.2.1: + resolution: {integrity: sha512-EcR6r5a8bj6pu3ycsa/E/cKVGuTgZJZdsyUYHOksG/UHIiKfjxzRxYJpyVBwYaQeOvghal9fcc4PidlgzugAQg==} + engines: {node: '>=6'} + dev: false + + /collapse-white-space@1.0.6: + resolution: {integrity: sha512-jEovNnrhMuqyCcjfEJA56v0Xq8SkIoPKDyaHahwo3POf4qcSXqMYuwNcOTzp74vTsR9Tn08z4MxWqAhcekogkQ==} + dev: false + + /color-convert@1.9.3: + resolution: {integrity: sha512-QfAUtd+vFdAtFQcC8CCyYt1fYWxSqAiK2cSD6zDB8N3cpsEBAvRxp9zOGg6G/SHHJYAT88/az/IuDGALsNVbGg==} + dependencies: + color-name: 1.1.3 + dev: false + + /color-convert@2.0.1: + resolution: {integrity: sha512-RRECPsj7iu/xb5oKYcsFHSppFNnsj/52OVTRKb4zP5onXwVF3zVmmToNcOfGC+CRDpfK/U584fMg38ZHCaElKQ==} + engines: {node: '>=7.0.0'} + dependencies: + color-name: 1.1.4 + dev: false + + /color-name@1.1.3: + resolution: {integrity: sha512-72fSenhMw2HZMTVHeCA9KCmpEIbzWiQsjN+BHcBbS9vr1mtt+vJjPdksIBNUmKAW8TFUDPJK5SUU3QhE9NEXDw==} + dev: false + + /color-name@1.1.4: + resolution: {integrity: sha512-dOy+3AuW3a2wNbZHIuMZpTcgjGuLU/uBL/ubcZF9OXbDo8ff4O8yVp5Bf0efS8uEoYo5q4Fx7dY9OgQGXgAsQA==} + dev: false + + /colord@2.9.3: + resolution: {integrity: sha512-jeC1axXpnb0/2nn/Y1LPuLdgXBLH7aDcHu4KEKfqw3CUhX7ZpfBSlPKyqXE6btIgEzfWtrX3/tyBCaCvXvMkOw==} + dev: false + + /colorette@2.0.20: + resolution: {integrity: sha512-IfEDxwoWIjkeXL1eXcDiow4UbKjhLdq6/EuSVR9GMN7KVH3r9gQ83e73hsz1Nd1T3ijd5xv1wcWRYO+D6kCI2w==} + dev: false + + /combine-promises@1.2.0: + resolution: {integrity: sha512-VcQB1ziGD0NXrhKxiwyNbCDmRzs/OShMs2GqW2DlU2A/Sd0nQxE1oWDAE5O0ygSx5mgQOn9eIFh7yKPgFRVkPQ==} + engines: {node: '>=10'} + dev: false + + /comma-separated-tokens@1.0.8: + resolution: {integrity: sha512-GHuDRO12Sypu2cV70d1dkA2EUmXHgntrzbpvOB+Qy+49ypNfGgFQIC2fhhXbnyrJRynDCAARsT7Ou0M6hirpfw==} + dev: false + + /commander@2.20.3: + resolution: {integrity: sha512-GpVkmM8vF2vQUkj2LvZmD35JxeJOLCwJ9cUkugyk2nuhbv3+mJvpLYYt+0+USMxE+oj+ey/lJEnhZw75x/OMcQ==} + + /commander@4.1.1: + resolution: {integrity: sha512-NOKm8xhkzAjzFx8B2v5OAHT+u5pRQc2UCa2Vq9jYL/31o2wi9mxBA7LIFs3sV5VSC49z6pEhfbMULvShKj26WA==} + engines: {node: '>= 6'} + dev: true + + /commander@5.1.0: + resolution: {integrity: sha512-P0CysNDQ7rtVw4QIQtm+MRxV66vKFSvlsQvGYXZWR3qFU0jlMKHZZZgw8e+8DSah4UDKMqnknRDQz+xuQXQ/Zg==} + engines: {node: '>= 6'} + + /commander@7.2.0: + resolution: {integrity: sha512-QrWXB+ZQSVPmIWIhtEO9H+gwHaMGYiF5ChvoJ+K9ZGHG/sVsa6yiesAD1GC/x46sET00Xlwo1u49RVVVzvcSkw==} + engines: {node: '>= 10'} + dev: false + + /commander@8.3.0: + resolution: {integrity: sha512-OkTL9umf+He2DZkUq8f8J9of7yL6RJKI24dVITBmNfZBmri9zYZQrKkuXiKhyfPSu8tUhnVBB1iKXevvnlR4Ww==} + engines: {node: '>= 12'} + dev: false + + /commondir@1.0.1: + resolution: {integrity: sha512-W9pAhw0ja1Edb5GVdIF1mjZw/ASI0AlShXM83UUGe2DVr5TdAPEA1OA8m/g8zWp9x6On7gqufY+FatDbC3MDQg==} + dev: false + + /compressible@2.0.18: + resolution: {integrity: sha512-AF3r7P5dWxL8MxyITRMlORQNaOA2IkAFaTr4k7BUumjPtRpGDTZpl0Pb1XCO6JeDCBdp126Cgs9sMxqSjgYyRg==} + engines: {node: '>= 0.6'} + dependencies: + mime-db: 1.52.0 + dev: false + + /compression@1.7.4: + resolution: {integrity: sha512-jaSIDzP9pZVS4ZfQ+TzvtiWhdpFhE2RDHz8QJkpX9SIpLq88VueF5jJw6t+6CUQcAoA6t+x89MLrWAqpfDE8iQ==} + engines: {node: '>= 0.8.0'} + dependencies: + accepts: 1.3.8 + bytes: 3.0.0 + compressible: 2.0.18 + debug: 2.6.9 + on-headers: 1.0.2 + safe-buffer: 5.1.2 + vary: 1.1.2 + transitivePeerDependencies: + - supports-color + dev: false + + /concat-map@0.0.1: + resolution: {integrity: sha512-/Srv4dswyQNBfohGpz9o6Yb3Gz3SrUDqBH5rTuhGR7ahtlbYKnVxw2bCFMRljaA7EXHaXZ8wsHdodFvbkhKmqg==} + + /configstore@5.0.1: + resolution: {integrity: sha512-aMKprgk5YhBNyH25hj8wGt2+D52Sw1DRRIzqBwLp2Ya9mFmY8KPvvtvmna8SxVR9JMZ4kzMD68N22vlaRpkeFA==} + engines: {node: '>=8'} + dependencies: + dot-prop: 5.3.0 + graceful-fs: 4.2.11 + make-dir: 3.1.0 + unique-string: 2.0.0 + write-file-atomic: 3.0.3 + xdg-basedir: 4.0.0 + dev: false + + /connect-history-api-fallback@2.0.0: + resolution: {integrity: sha512-U73+6lQFmfiNPrYbXqr6kZ1i1wiRqXnp2nhMsINseWXO8lDau0LGEffJ8kQi4EjLZympVgRdvqjAgiZ1tgzDDA==} + engines: {node: '>=0.8'} + dev: false + + /consola@2.15.3: + resolution: {integrity: sha512-9vAdYbHj6x2fLKC4+oPH0kFzY/orMZyG2Aj+kNylHxKGJ/Ed4dpNyAQYwJOdqO4zdM7XpVHmyejQDcQHrnuXbw==} + dev: false + + /content-disposition@0.5.2: + resolution: {integrity: sha512-kRGRZw3bLlFISDBgwTSA1TMBFN6J6GWDeubmDE3AF+3+yXL8hTWv8r5rkLbqYXY4RjPk/EzHnClI3zQf1cFmHA==} + engines: {node: '>= 0.6'} + dev: false + + /content-disposition@0.5.4: + resolution: {integrity: sha512-FveZTNuGw04cxlAiWbzi6zTAL/lhehaWbTtgluJh4/E95DqMwTmha3KZN1aAWA8cFIhHzMZUvLevkw5Rqk+tSQ==} + engines: {node: '>= 0.6'} + dependencies: + safe-buffer: 5.2.1 + dev: false + + /content-type@1.0.5: + resolution: {integrity: sha512-nTjqfcBFEipKdXCv4YDQWCfmcLZKm81ldF0pAopTvyrFGVbcR6P/VAAd5G7N+0tTr8QqiU0tFadD6FK4NtJwOA==} + engines: {node: '>= 0.6'} + dev: false + + /convert-source-map@1.9.0: + resolution: {integrity: sha512-ASFBup0Mz1uyiIjANan1jzLQami9z1PoYSZCiiYW2FczPbenXc45FZdBZLzOT+r6+iciuEModtmCti+hjaAk0A==} + dev: false + + /convert-source-map@2.0.0: + resolution: {integrity: sha512-Kvp459HrV2FEJ1CAsi1Ku+MY3kasH19TFykTz2xWmMeq6bk2NU3XXvfJ+Q61m0xktWwt+1HSYf3JZsTms3aRJg==} + dev: false + + /cookie-signature@1.0.6: + resolution: {integrity: sha512-QADzlaHc8icV8I7vbaJXJwod9HWYp8uCqf1xa4OfNu1T7JVxQIrUgOWtHdNDtPiywmFbiS12VjotIXLrKM3orQ==} + dev: false + + /cookie@0.5.0: + resolution: {integrity: sha512-YZ3GUyn/o8gfKJlnlX7g7xq4gyO6OSuhGPKaaGssGB2qgDUS0gPgtTvoyZLTt9Ab6dC4hfc9dV5arkvc/OCmrw==} + engines: {node: '>= 0.6'} + dev: false + + /copy-text-to-clipboard@3.2.0: + resolution: {integrity: sha512-RnJFp1XR/LOBDckxTib5Qjr/PMfkatD0MUCQgdpqS8MdKiNUzBjAQBEN6oUy+jW7LI93BBG3DtMB2KOOKpGs2Q==} + engines: {node: '>=12'} + dev: false + + /copy-webpack-plugin@11.0.0(webpack@5.89.0): + resolution: {integrity: sha512-fX2MWpamkW0hZxMEg0+mYnA40LTosOSa5TqZ9GYIBzyJa9C3QUaMPSE2xAi/buNr8u89SfD9wHSQVBzrRa/SOQ==} + engines: {node: '>= 14.15.0'} + peerDependencies: + webpack: ^5.1.0 + dependencies: + fast-glob: 3.3.1 + glob-parent: 6.0.2 + globby: 13.2.2 + normalize-path: 3.0.0 + schema-utils: 4.2.0 + serialize-javascript: 6.0.1 + webpack: 5.89.0 + dev: false + + /core-js-compat@3.33.1: + resolution: {integrity: sha512-6pYKNOgD/j/bkC5xS5IIg6bncid3rfrI42oBH1SQJbsmYPKF7rhzcFzYCcxYMmNQQ0rCEB8WqpW7QHndOggaeQ==} + dependencies: + browserslist: 4.22.1 + dev: false + + /core-js-pure@3.33.1: + resolution: {integrity: sha512-wCXGbLjnsP10PlK/thHSQlOLlLKNEkaWbTzVvHHZ79fZNeN1gUmw2gBlpItxPv/pvqldevEXFh/d5stdNvl6EQ==} + requiresBuild: true + dev: false + + /core-js@3.33.1: + resolution: {integrity: sha512-qVSq3s+d4+GsqN0teRCJtM6tdEEXyWxjzbhVrCHmBS5ZTM0FS2MOS0D13dUXAWDUN6a+lHI/N1hF9Ytz6iLl9Q==} + requiresBuild: true + dev: false + + /core-util-is@1.0.3: + resolution: {integrity: sha512-ZQBvi1DcpJ4GDqanjucZ2Hj3wEO5pZDS89BWbkcrvdxksJorwUDDZamX9ldFkp9aw2lmBDLgkObEA4DWNJ9FYQ==} + dev: false + + /cosmiconfig@6.0.0: + resolution: {integrity: sha512-xb3ZL6+L8b9JLLCx3ZdoZy4+2ECphCMo2PwqgP1tlfVq6M6YReyzBJtvWWtbDSpNr9hn96pkCiZqUcFEc+54Qg==} + engines: {node: '>=8'} + dependencies: + '@types/parse-json': 4.0.1 + import-fresh: 3.3.0 + parse-json: 5.2.0 + path-type: 4.0.0 + yaml: 1.10.2 + dev: false + + /cosmiconfig@7.1.0: + resolution: {integrity: sha512-AdmX6xUzdNASswsFtmwSt7Vj8po9IuqXm0UXz7QKPuEUmPB4XyjGfaAr2PSuELMwkRMVH1EpIkX5bTZGRB3eCA==} + engines: {node: '>=10'} + dependencies: + '@types/parse-json': 4.0.1 + import-fresh: 3.3.0 + parse-json: 5.2.0 + path-type: 4.0.0 + yaml: 1.10.2 + dev: false + + /cosmiconfig@8.3.6(typescript@4.9.5): + resolution: {integrity: sha512-kcZ6+W5QzcJ3P1Mt+83OUv/oHFqZHIx8DuxG6eZ5RGMERoLqp4BuGjhHLYGK+Kf5XVkQvqBSmAy/nGWN3qDgEA==} + engines: {node: '>=14'} + peerDependencies: + typescript: '>=4.9.5' + peerDependenciesMeta: + typescript: + optional: true + dependencies: + import-fresh: 3.3.0 + js-yaml: 4.1.0 + parse-json: 5.2.0 + path-type: 4.0.0 + typescript: 4.9.5 + dev: false + + /cross-fetch@3.1.8: + resolution: {integrity: sha512-cvA+JwZoU0Xq+h6WkMvAUqPEYy92Obet6UdKLfW60qn99ftItKjB5T+BkyWOFWe2pUyfQ+IJHmpOTznqk1M6Kg==} + dependencies: + node-fetch: 2.7.0 + transitivePeerDependencies: + - encoding + dev: false + + /cross-spawn@7.0.3: + resolution: {integrity: sha512-iRDPJKUPVEND7dHPO8rkbOnPpyDygcDFtWjpeWNCgy8WP2rXcxXL8TskReQl6OrB2G7+UJrags1q15Fudc7G6w==} + engines: {node: '>= 8'} + dependencies: + path-key: 3.1.1 + shebang-command: 2.0.0 + which: 2.0.2 + dev: false + + /crypto-random-string@2.0.0: + resolution: {integrity: sha512-v1plID3y9r/lPhviJ1wrXpLeyUIGAZ2SHNYTEapm7/8A9nLPoyvVp3RK/EPFqn5kEznyWgYZNsRtYYIWbuG8KA==} + engines: {node: '>=8'} + dev: false + + /css-declaration-sorter@6.4.1(postcss@8.4.31): + resolution: {integrity: sha512-rtdthzxKuyq6IzqX6jEcIzQF/YqccluefyCYheovBOLhFT/drQA9zj/UbRAa9J7C0o6EG6u3E6g+vKkay7/k3g==} + engines: {node: ^10 || ^12 || >=14} + peerDependencies: + postcss: ^8.0.9 + dependencies: + postcss: 8.4.31 + dev: false + + /css-loader@6.8.1(webpack@5.89.0): + resolution: {integrity: sha512-xDAXtEVGlD0gJ07iclwWVkLoZOpEvAWaSyf6W18S2pOC//K8+qUDIx8IIT3D+HjnmkJPQeesOPv5aiUaJsCM2g==} + engines: {node: '>= 12.13.0'} + peerDependencies: + webpack: ^5.0.0 + dependencies: + icss-utils: 5.1.0(postcss@8.4.31) + postcss: 8.4.31 + postcss-modules-extract-imports: 3.0.0(postcss@8.4.31) + postcss-modules-local-by-default: 4.0.3(postcss@8.4.31) + postcss-modules-scope: 3.0.0(postcss@8.4.31) + postcss-modules-values: 4.0.0(postcss@8.4.31) + postcss-value-parser: 4.2.0 + semver: 7.5.4 + webpack: 5.89.0 + dev: false + + /css-minimizer-webpack-plugin@4.2.2(clean-css@5.3.2)(webpack@5.89.0): + resolution: {integrity: sha512-s3Of/4jKfw1Hj9CxEO1E5oXhQAxlayuHO2y/ML+C6I9sQ7FdzfEV6QgMLN3vI+qFsjJGIAFLKtQK7t8BOXAIyA==} + engines: {node: '>= 14.15.0'} + peerDependencies: + '@parcel/css': '*' + '@swc/css': '*' + clean-css: '*' + csso: '*' + esbuild: '*' + lightningcss: '*' + webpack: ^5.0.0 + peerDependenciesMeta: + '@parcel/css': + optional: true + '@swc/css': + optional: true + clean-css: + optional: true + csso: + optional: true + esbuild: + optional: true + lightningcss: + optional: true + dependencies: + clean-css: 5.3.2 + cssnano: 5.1.15(postcss@8.4.31) + jest-worker: 29.7.0 + postcss: 8.4.31 + schema-utils: 4.2.0 + serialize-javascript: 6.0.1 + source-map: 0.6.1 + webpack: 5.89.0 + dev: false + + /css-select@4.3.0: + resolution: {integrity: sha512-wPpOYtnsVontu2mODhA19JrqWxNsfdatRKd64kmpRbQgh1KtItko5sTnEpPdpSaJszTOhEMlF/RPz28qj4HqhQ==} + dependencies: + boolbase: 1.0.0 + css-what: 6.1.0 + domhandler: 4.3.1 + domutils: 2.8.0 + nth-check: 2.1.1 + dev: false + + /css-select@5.1.0: + resolution: {integrity: sha512-nwoRF1rvRRnnCqqY7updORDsuqKzqYJ28+oSMaJMMgOauh3fvwHqMS7EZpIPqK8GL+g9mKxF1vP/ZjSeNjEVHg==} + dependencies: + boolbase: 1.0.0 + css-what: 6.1.0 + domhandler: 5.0.3 + domutils: 3.1.0 + nth-check: 2.1.1 + dev: false + + /css-tree@1.1.3: + resolution: {integrity: sha512-tRpdppF7TRazZrjJ6v3stzv93qxRcSsFmW6cX0Zm2NVKpxE1WV1HblnghVv9TreireHkqI/VDEsfolRF1p6y7Q==} + engines: {node: '>=8.0.0'} + dependencies: + mdn-data: 2.0.14 + source-map: 0.6.1 + dev: false + + /css-what@6.1.0: + resolution: {integrity: sha512-HTUrgRJ7r4dsZKU6GjmpfRK1O76h97Z8MfS1G0FozR+oF2kG6Vfe8JE6zwrkbxigziPHinCJ+gCPjA9EaBDtRw==} + engines: {node: '>= 6'} + dev: false + + /cssesc@3.0.0: + resolution: {integrity: sha512-/Tb/JcjK111nNScGob5MNtsntNM1aCNUDipB/TkwZFhyDrrE47SOx/18wF2bbjgc3ZzCSKW1T5nt5EbFoAz/Vg==} + engines: {node: '>=4'} + hasBin: true + + /cssnano-preset-advanced@5.3.10(postcss@8.4.31): + resolution: {integrity: sha512-fnYJyCS9jgMU+cmHO1rPSPf9axbQyD7iUhLO5Df6O4G+fKIOMps+ZbU0PdGFejFBBZ3Pftf18fn1eG7MAPUSWQ==} + engines: {node: ^10 || ^12 || >=14.0} + peerDependencies: + postcss: ^8.2.15 + dependencies: + autoprefixer: 10.4.16(postcss@8.4.31) + cssnano-preset-default: 5.2.14(postcss@8.4.31) + postcss: 8.4.31 + postcss-discard-unused: 5.1.0(postcss@8.4.31) + postcss-merge-idents: 5.1.1(postcss@8.4.31) + postcss-reduce-idents: 5.2.0(postcss@8.4.31) + postcss-zindex: 5.1.0(postcss@8.4.31) + dev: false + + /cssnano-preset-default@5.2.14(postcss@8.4.31): + resolution: {integrity: sha512-t0SFesj/ZV2OTylqQVOrFgEh5uanxbO6ZAdeCrNsUQ6fVuXwYTxJPNAGvGTxHbD68ldIJNec7PyYZDBrfDQ+6A==} + engines: {node: ^10 || ^12 || >=14.0} + peerDependencies: + postcss: ^8.2.15 + dependencies: + css-declaration-sorter: 6.4.1(postcss@8.4.31) + cssnano-utils: 3.1.0(postcss@8.4.31) + postcss: 8.4.31 + postcss-calc: 8.2.4(postcss@8.4.31) + postcss-colormin: 5.3.1(postcss@8.4.31) + postcss-convert-values: 5.1.3(postcss@8.4.31) + postcss-discard-comments: 5.1.2(postcss@8.4.31) + postcss-discard-duplicates: 5.1.0(postcss@8.4.31) + postcss-discard-empty: 5.1.1(postcss@8.4.31) + postcss-discard-overridden: 5.1.0(postcss@8.4.31) + postcss-merge-longhand: 5.1.7(postcss@8.4.31) + postcss-merge-rules: 5.1.4(postcss@8.4.31) + postcss-minify-font-values: 5.1.0(postcss@8.4.31) + postcss-minify-gradients: 5.1.1(postcss@8.4.31) + postcss-minify-params: 5.1.4(postcss@8.4.31) + postcss-minify-selectors: 5.2.1(postcss@8.4.31) + postcss-normalize-charset: 5.1.0(postcss@8.4.31) + postcss-normalize-display-values: 5.1.0(postcss@8.4.31) + postcss-normalize-positions: 5.1.1(postcss@8.4.31) + postcss-normalize-repeat-style: 5.1.1(postcss@8.4.31) + postcss-normalize-string: 5.1.0(postcss@8.4.31) + postcss-normalize-timing-functions: 5.1.0(postcss@8.4.31) + postcss-normalize-unicode: 5.1.1(postcss@8.4.31) + postcss-normalize-url: 5.1.0(postcss@8.4.31) + postcss-normalize-whitespace: 5.1.1(postcss@8.4.31) + postcss-ordered-values: 5.1.3(postcss@8.4.31) + postcss-reduce-initial: 5.1.2(postcss@8.4.31) + postcss-reduce-transforms: 5.1.0(postcss@8.4.31) + postcss-svgo: 5.1.0(postcss@8.4.31) + postcss-unique-selectors: 5.1.1(postcss@8.4.31) + dev: false + + /cssnano-utils@3.1.0(postcss@8.4.31): + resolution: {integrity: sha512-JQNR19/YZhz4psLX/rQ9M83e3z2Wf/HdJbryzte4a3NSuafyp9w/I4U+hx5C2S9g41qlstH7DEWnZaaj83OuEA==} + engines: {node: ^10 || ^12 || >=14.0} + peerDependencies: + postcss: ^8.2.15 + dependencies: + postcss: 8.4.31 + dev: false + + /cssnano@5.1.15(postcss@8.4.31): + resolution: {integrity: sha512-j+BKgDcLDQA+eDifLx0EO4XSA56b7uut3BQFH+wbSaSTuGLuiyTa/wbRYthUXX8LC9mLg+WWKe8h+qJuwTAbHw==} + engines: {node: ^10 || ^12 || >=14.0} + peerDependencies: + postcss: ^8.2.15 + dependencies: + cssnano-preset-default: 5.2.14(postcss@8.4.31) + lilconfig: 2.1.0 + postcss: 8.4.31 + yaml: 1.10.2 + dev: false + + /csso@4.2.0: + resolution: {integrity: sha512-wvlcdIbf6pwKEk7vHj8/Bkc0B4ylXZruLvOgs9doS5eOsOpuodOV2zJChSpkp+pRpYQLQMeF04nr3Z68Sta9jA==} + engines: {node: '>=8.0.0'} + dependencies: + css-tree: 1.1.3 + dev: false + + /csstype@3.1.2: + resolution: {integrity: sha512-I7K1Uu0MBPzaFKg4nI5Q7Vs2t+3gWWW648spaF+Rg7pI9ds18Ugn+lvg4SHczUdKlHI5LWBXyqfS8+DufyBsgQ==} + + /debug@2.6.9: + resolution: {integrity: sha512-bC7ElrdJaJnPbAP+1EotYvqZsb3ecl5wi6Bfi6BJTUcNowp6cvspg0jXznRTKDjm/E7AdgFBVeAPVMNcKGsHMA==} + peerDependencies: + supports-color: '*' + peerDependenciesMeta: + supports-color: + optional: true + dependencies: + ms: 2.0.0 + dev: false + + /debug@4.3.4: + resolution: {integrity: sha512-PRWFHuSU3eDtQJPvnNY7Jcket1j0t5OuOsFzPPzsekD52Zl8qUfFIPEiswXqIvHWGVHOgX+7G/vCNNhehwxfkQ==} + engines: {node: '>=6.0'} + peerDependencies: + supports-color: '*' + peerDependenciesMeta: + supports-color: + optional: true + dependencies: + ms: 2.1.2 + dev: false + + /decompress-response@3.3.0: + resolution: {integrity: sha512-BzRPQuY1ip+qDonAOz42gRm/pg9F768C+npV/4JOsxRC2sq+Rlk+Q4ZCAsOhnIaMrgarILY+RMUIvMmmX1qAEA==} + engines: {node: '>=4'} + dependencies: + mimic-response: 1.0.1 + dev: false + + /deep-extend@0.6.0: + resolution: {integrity: sha512-LOHxIOaPYdHlJRtCQfDIVZtfw/ufM8+rVj649RIHzcm/vGwQRXFt6OPqIFWsm2XEMrNIEtWR64sY1LEKD2vAOA==} + engines: {node: '>=4.0.0'} + dev: false + + /deepmerge@4.3.1: + resolution: {integrity: sha512-3sUqbMEc77XqpdNO7FRyRog+eW3ph+GYCbj+rK+uYyRMuwsVy0rMiVtPn+QJlKFvWP/1PYpapqYn0Me2knFn+A==} + engines: {node: '>=0.10.0'} + dev: false + + /default-gateway@6.0.3: + resolution: {integrity: sha512-fwSOJsbbNzZ/CUFpqFBqYfYNLj1NbMPm8MMCIzHjC83iSJRBEGmDUxU+WP661BaBQImeC2yHwXtz+P/O9o+XEg==} + engines: {node: '>= 10'} + dependencies: + execa: 5.1.1 + dev: false + + /defer-to-connect@1.1.3: + resolution: {integrity: sha512-0ISdNousHvZT2EiFlZeZAHBUvSxmKswVCEf8hW7KWgG4a8MVEu/3Vb6uWYozkjylyCxe0JBIiRB1jV45S70WVQ==} + dev: false + + /define-data-property@1.1.1: + resolution: {integrity: sha512-E7uGkTzkk1d0ByLeSc6ZsFS79Axg+m1P/VsgYsxHgiuc3tFSj+MjMIwe90FC4lOAZzNBdY7kkO2P2wKdsQ1vgQ==} + engines: {node: '>= 0.4'} + dependencies: + get-intrinsic: 1.2.2 + gopd: 1.0.1 + has-property-descriptors: 1.0.1 + dev: false + + /define-lazy-prop@2.0.0: + resolution: {integrity: sha512-Ds09qNh8yw3khSjiJjiUInaGX9xlqZDY7JVryGxdxV7NPeuqQfplOpQ66yJFZut3jLa5zOwkXw1g9EI2uKh4Og==} + engines: {node: '>=8'} + dev: false + + /define-properties@1.2.1: + resolution: {integrity: sha512-8QmQKqEASLd5nx0U1B1okLElbUuuttJ/AnYmRXbbbGDWh6uS208EjD4Xqq/I9wK7u0v6O08XhTWnt5XtEbR6Dg==} + engines: {node: '>= 0.4'} + dependencies: + define-data-property: 1.1.1 + has-property-descriptors: 1.0.1 + object-keys: 1.1.1 + dev: false + + /del@6.1.1: + resolution: {integrity: sha512-ua8BhapfP0JUJKC/zV9yHHDW/rDoDxP4Zhn3AkA6/xT6gY7jYXJiaeyBZznYVujhZZET+UgcbZiQ7sN3WqcImg==} + engines: {node: '>=10'} + dependencies: + globby: 11.1.0 + graceful-fs: 4.2.11 + is-glob: 4.0.3 + is-path-cwd: 2.2.0 + is-path-inside: 3.0.3 + p-map: 4.0.0 + rimraf: 3.0.2 + slash: 3.0.0 + dev: false + + /depd@1.1.2: + resolution: {integrity: sha512-7emPTl6Dpo6JRXOXjLRxck+FlLRX5847cLKEn00PLAgc3g2hTZZgr+e4c2v6QpSmLeFP3n5yUo7ft6avBK/5jQ==} + engines: {node: '>= 0.6'} + dev: false + + /depd@2.0.0: + resolution: {integrity: sha512-g7nH6P6dyDioJogAAGprGpCtVImJhpPk/roCzdb3fIh61/s/nPsfR6onyMwkCAR/OlC3yBC0lESvUoQEAssIrw==} + engines: {node: '>= 0.8'} + dev: false + + /destroy@1.2.0: + resolution: {integrity: sha512-2sJGJTaXIIaR1w4iJSNoN0hnMY7Gpc/n8D4qSCJw8QqFWXf7cuAgnEHxBpweaVcPevC2l3KpjYCx3NypQQgaJg==} + engines: {node: '>= 0.8', npm: 1.2.8000 || >= 1.4.16} + dev: false + + /detab@2.0.4: + resolution: {integrity: sha512-8zdsQA5bIkoRECvCrNKPla84lyoR7DSAyf7p0YgXzBO9PDJx8KntPUay7NS6yp+KdxdVtiE5SpHKtbp2ZQyA9g==} + dependencies: + repeat-string: 1.6.1 + dev: false + + /detect-node-es@1.1.0: + resolution: {integrity: sha512-ypdmJU/TbBby2Dxibuv7ZLW3Bs1QEmM7nHjEANfohJLvE0XVujisn1qPJcZxg+qDucsr+bP6fLD1rPS3AhJ7EQ==} + dev: false + + /detect-node@2.1.0: + resolution: {integrity: sha512-T0NIuQpnTvFDATNuHN5roPwSBG83rFsuO+MXXH9/3N1eFbn4wcPjttvjMLEPWJ0RGUYgQE7cGgS3tNxbqCGM7g==} + dev: false + + /detect-port-alt@1.1.6: + resolution: {integrity: sha512-5tQykt+LqfJFBEYaDITx7S7cR7mJ/zQmLXZ2qt5w04ainYZw6tBf9dBunMjVeVOdYVRUzUOE4HkY5J7+uttb5Q==} + engines: {node: '>= 4.2.1'} + hasBin: true + dependencies: + address: 1.2.2 + debug: 2.6.9 + transitivePeerDependencies: + - supports-color + dev: false + + /detect-port@1.5.1: + resolution: {integrity: sha512-aBzdj76lueB6uUst5iAs7+0H/oOjqI5D16XUWxlWMIMROhcM0rfsNVk93zTngq1dDNpoXRr++Sus7ETAExppAQ==} + hasBin: true + dependencies: + address: 1.2.2 + debug: 4.3.4 + transitivePeerDependencies: + - supports-color + dev: false + + /didyoumean@1.2.2: + resolution: {integrity: sha512-gxtyfqMg7GKyhQmb056K7M3xszy/myH8w+B4RT+QXBQsvAOdc3XymqDDPHx1BgPgsdAA5SIifona89YtRATDzw==} + dev: true + + /dir-glob@3.0.1: + resolution: {integrity: sha512-WkrWp9GR4KXfKGYzOLmTuGVi1UWFfws377n9cc55/tb6DuqyF6pcQ5AbiHEshaDpY9v6oaSr2XCDidGmMwdzIA==} + engines: {node: '>=8'} + dependencies: + path-type: 4.0.0 + dev: false + + /dlv@1.1.3: + resolution: {integrity: sha512-+HlytyjlPKnIG8XuRG8WvmBP8xs8P71y+SKKS6ZXWoEgLuePxtDoUEiH7WkdePWrQ5JBpE6aoVqfZfJUQkjXwA==} + dev: true + + /dns-equal@1.0.0: + resolution: {integrity: sha512-z+paD6YUQsk+AbGCEM4PrOXSss5gd66QfcVBFTKR/HpFL9jCqikS94HYwKww6fQyO7IxrIIyUu+g0Ka9tUS2Cg==} + dev: false + + /dns-packet@5.6.1: + resolution: {integrity: sha512-l4gcSouhcgIKRvyy99RNVOgxXiicE+2jZoNmaNmZ6JXiGajBOJAesk1OBlJuM5k2c+eudGdLxDqXuPCKIj6kpw==} + engines: {node: '>=6'} + dependencies: + '@leichtgewicht/ip-codec': 2.0.4 + dev: false + + /dom-converter@0.2.0: + resolution: {integrity: sha512-gd3ypIPfOMr9h5jIKq8E3sHOTCjeirnl0WK5ZdS1AW0Odt0b1PaWaHdJ4Qk4klv+YB9aJBS7mESXjFoDQPu6DA==} + dependencies: + utila: 0.4.0 + dev: false + + /dom-serializer@1.4.1: + resolution: {integrity: sha512-VHwB3KfrcOOkelEG2ZOfxqLZdfkil8PtJi4P8N2MMXucZq2yLp75ClViUlOVwyoHEDjYU433Aq+5zWP61+RGag==} + dependencies: + domelementtype: 2.3.0 + domhandler: 4.3.1 + entities: 2.2.0 + dev: false + + /dom-serializer@2.0.0: + resolution: {integrity: sha512-wIkAryiqt/nV5EQKqQpo3SToSOV9J0DnbJqwK7Wv/Trc92zIAYZ4FlMu+JPFW1DfGFt81ZTCGgDEabffXeLyJg==} + dependencies: + domelementtype: 2.3.0 + domhandler: 5.0.3 + entities: 4.5.0 + dev: false + + /domelementtype@2.3.0: + resolution: {integrity: sha512-OLETBj6w0OsagBwdXnPdN0cnMfF9opN69co+7ZrbfPGrdpPVNBUj02spi6B1N7wChLQiPn4CSH/zJvXw56gmHw==} + dev: false + + /domhandler@4.3.1: + resolution: {integrity: sha512-GrwoxYN+uWlzO8uhUXRl0P+kHE4GtVPfYzVLcUxPL7KNdHKj66vvlhiweIHqYYXWlw+T8iLMp42Lm67ghw4WMQ==} + engines: {node: '>= 4'} + dependencies: + domelementtype: 2.3.0 + dev: false + + /domhandler@5.0.3: + resolution: {integrity: sha512-cgwlv/1iFQiFnU96XXgROh8xTeetsnJiDsTc7TYCLFd9+/WNkIqPTxiM/8pSd8VIrhXGTf1Ny1q1hquVqDJB5w==} + engines: {node: '>= 4'} + dependencies: + domelementtype: 2.3.0 + dev: false + + /domutils@2.8.0: + resolution: {integrity: sha512-w96Cjofp72M5IIhpjgobBimYEfoPjx1Vx0BSX9P30WBdZW2WIKU0T1Bd0kz2eNZ9ikjKgHbEyKx8BB6H1L3h3A==} + dependencies: + dom-serializer: 1.4.1 + domelementtype: 2.3.0 + domhandler: 4.3.1 + dev: false + + /domutils@3.1.0: + resolution: {integrity: sha512-H78uMmQtI2AhgDJjWeQmHwJJ2bLPD3GMmO7Zja/ZZh84wkm+4ut+IUnUdRa8uCGX88DiVx1j6FRe1XfxEgjEZA==} + dependencies: + dom-serializer: 2.0.0 + domelementtype: 2.3.0 + domhandler: 5.0.3 + dev: false + + /dot-case@3.0.4: + resolution: {integrity: sha512-Kv5nKlh6yRrdrGvxeJ2e5y2eRUpkUosIW4A2AS38zwSz27zu7ufDwQPi5Jhs3XAlGNetl3bmnGhQsMtkKJnj3w==} + dependencies: + no-case: 3.0.4 + tslib: 2.6.2 + dev: false + + /dot-prop@5.3.0: + resolution: {integrity: sha512-QM8q3zDe58hqUqjraQOmzZ1LIH9SWQJTlEKCH4kJ2oQvLZk7RbQXvtDM2XEq3fwkV9CCvvH4LA0AV+ogFsBM2Q==} + engines: {node: '>=8'} + dependencies: + is-obj: 2.0.0 + dev: false + + /duplexer3@0.1.5: + resolution: {integrity: sha512-1A8za6ws41LQgv9HrE/66jyC5yuSjQ3L/KOpFtoBilsAK2iA2wuS5rTt1OCzIvtS2V7nVmedsUU+DGRcjBmOYA==} + dev: false + + /duplexer@0.1.2: + resolution: {integrity: sha512-jtD6YG370ZCIi/9GTaJKQxWTZD045+4R4hTk/x1UyoqadyJ9x9CgSi1RlVDQF8U2sxLLSnFkCaMihqljHIWgMg==} + dev: false + + /eastasianwidth@0.2.0: + resolution: {integrity: sha512-I88TYZWc9XiYHRQ4/3c5rjjfgkjhLyW2luGIheGERbNQ6OY7yTybanSpDXZa8y7VUP9YmDcYa+eyq4ca7iLqWA==} + dev: false + + /ee-first@1.1.1: + resolution: {integrity: sha512-WMwm9LhRUo+WUaRN+vRuETqG89IgZphVSNkdFgeb6sS/E4OrDIN7t48CAewSHXc6C8lefD8KKfr5vY61brQlow==} + dev: false + + /electron-to-chromium@1.4.568: + resolution: {integrity: sha512-3TCOv8+BY6Ltpt1/CmGBMups2IdKOyfEmz4J8yIS4xLSeMm0Rf+psSaxLuswG9qMKt+XbNbmADybtXGpTFlbDg==} + + /emoji-regex@8.0.0: + resolution: {integrity: sha512-MSjYzcWNOA0ewAHpz0MxpYFvwg6yjy1NG3xteoqz644VCo/RPgnr1/GGt+ic3iJTzQ8Eu3TdM14SawnVUmGE6A==} + dev: false + + /emoji-regex@9.2.2: + resolution: {integrity: sha512-L18DaJsXSUk2+42pv8mLs5jJT2hqFkFE4j21wOmgbUqsZ2hL72NsUU785g9RXgo3s0ZNgVl42TiHp3ZtOv/Vyg==} + dev: false + + /emojis-list@3.0.0: + resolution: {integrity: sha512-/kyM18EfinwXZbno9FyUGeFh87KC8HRQBQGildHZbEuRyWFOmv1U10o9BBp8XVZDVNNuQKyIGIu5ZYAAXJ0V2Q==} + engines: {node: '>= 4'} + dev: false + + /emoticon@3.2.0: + resolution: {integrity: sha512-SNujglcLTTg+lDAcApPNgEdudaqQFiAbJCqzjNxJkvN9vAwCGi0uu8IUVvx+f16h+V44KCY6Y2yboroc9pilHg==} + dev: false + + /encodeurl@1.0.2: + resolution: {integrity: sha512-TPJXq8JqFaVYm2CWmPvnP2Iyo4ZSM7/QKcSmuMLDObfpH5fi7RUGmd/rTDf+rut/saiDiQEeVTNgAmJEdAOx0w==} + engines: {node: '>= 0.8'} + dev: false + + /end-of-stream@1.4.4: + resolution: {integrity: sha512-+uw1inIHVPQoaVuHzRyXd21icM+cnt4CzD5rW+NC1wjOUSTOs+Te7FOv7AhN7vS9x/oIyhLP5PR1H+phQAHu5Q==} + dependencies: + once: 1.4.0 + dev: false + + /enhanced-resolve@5.15.0: + resolution: {integrity: sha512-LXYT42KJ7lpIKECr2mAXIaMldcNCh/7E0KBKOu4KSfkHmP+mZmSs+8V5gBAqisWBy0OO4W5Oyys0GO1Y8KtdKg==} + engines: {node: '>=10.13.0'} + dependencies: + graceful-fs: 4.2.11 + tapable: 2.2.1 + + /entities@2.2.0: + resolution: {integrity: sha512-p92if5Nz619I0w+akJrLZH0MX0Pb5DX39XOwQTtXSdQQOaYH03S1uIQp4mhOZtAXrxq4ViO67YTiLBo2638o9A==} + dev: false + + /entities@4.5.0: + resolution: {integrity: sha512-V0hjH4dGPh9Ao5p0MoRY6BVqtwCjhz6vI5LT8AJ55H+4g9/4vbHx1I54fS0XuclLhDHArPQCiMjDxjaL8fPxhw==} + engines: {node: '>=0.12'} + dev: false + + /error-ex@1.3.2: + resolution: {integrity: sha512-7dFHNmqeFSEt2ZBsCriorKnn3Z2pj+fd9kmI6QoWw4//DL+icEBfc0U7qJCisqrTsKTjw4fNFy2pW9OqStD84g==} + dependencies: + is-arrayish: 0.2.1 + dev: false + + /es-module-lexer@1.3.1: + resolution: {integrity: sha512-JUFAyicQV9mXc3YRxPnDlrfBKpqt6hUYzz9/boprUJHs4e4KVr3XwOF70doO6gwXUor6EWZJAyWAfKki84t20Q==} + + /escalade@3.1.1: + resolution: {integrity: sha512-k0er2gUkLf8O0zKJiAhmkTnJlTvINGv7ygDNPbeIsX/TJjGJZHuh9B2UxbsaEkmlEo9MfhrSzmhIlhRlI2GXnw==} + engines: {node: '>=6'} + + /escape-goat@2.1.1: + resolution: {integrity: sha512-8/uIhbG12Csjy2JEW7D9pHbreaVaS/OpN3ycnyvElTdwM5n6GY6W6e2IPemfvGZeUMqZ9A/3GqIZMgKnBhAw/Q==} + engines: {node: '>=8'} + dev: false + + /escape-html@1.0.3: + resolution: {integrity: sha512-NiSupZ4OeuGwr68lGIeym/ksIZMJodUGOSCZ/FSnTxcrekbvqrgdUxlJOMpijaKZVjAJrWrGs/6Jy8OMuyj9ow==} + dev: false + + /escape-string-regexp@1.0.5: + resolution: {integrity: sha512-vbRorB5FUQWvla16U8R/qgaFIya2qGzwDrNmCZuYKrbdSUMG6I1ZCGQRefkRVhuOkIGVne7BQ35DSfo1qvJqFg==} + engines: {node: '>=0.8.0'} + dev: false + + /escape-string-regexp@4.0.0: + resolution: {integrity: sha512-TtpcNJ3XAzx3Gq8sWRzJaVajRs0uVxA2YAkdb1jm2YkPz4G6egUFAyA3n5vtEIZefPk5Wa4UXbKuS5fKkJWdgA==} + engines: {node: '>=10'} + dev: false + + /eslint-scope@5.1.1: + resolution: {integrity: sha512-2NxwbF/hZ0KpepYN0cNbo+FN6XoK7GaHlQhgx/hIZl6Va0bF45RQOOwhLIy8lQDbuCiadSLCBnH2CFYquit5bw==} + engines: {node: '>=8.0.0'} + dependencies: + esrecurse: 4.3.0 + estraverse: 4.3.0 + + /esprima@4.0.1: + resolution: {integrity: sha512-eGuFFw7Upda+g4p+QHvnW0RyTX/SVeJBDM/gCtMARO0cLuT2HcEKnTPvhjV6aGeqrCB/sbNop0Kszm0jsaWU4A==} + engines: {node: '>=4'} + hasBin: true + dev: false + + /esrecurse@4.3.0: + resolution: {integrity: sha512-KmfKL3b6G+RXvP8N1vr3Tq1kL/oCFgn2NYXEtqP8/L3pKapUA4G8cFVaoF3SU323CD4XypR/ffioHmkti6/Tag==} + engines: {node: '>=4.0'} + dependencies: + estraverse: 5.3.0 + + /estraverse@4.3.0: + resolution: {integrity: sha512-39nnKffWz8xN1BU/2c79n9nB9HDzo0niYUqx6xyqUnyoAnQyyWpOTdZEeiCch8BBu515t4wp9ZmgVfVhn9EBpw==} + engines: {node: '>=4.0'} + + /estraverse@5.3.0: + resolution: {integrity: sha512-MMdARuVEQziNTeJD8DgMqmhwR11BRQ/cBP+pLtYdSTnf3MIO8fFeiINEbX36ZdNlfU/7A9f3gUw49B3oQsvwBA==} + engines: {node: '>=4.0'} + + /esutils@2.0.3: + resolution: {integrity: sha512-kVscqXk4OCp68SZ0dkgEKVi6/8ij300KBWTJq32P/dYeWTSwK41WyTxalN1eRmA5Z9UU/LX9D7FWSmV9SAYx6g==} + engines: {node: '>=0.10.0'} + dev: false + + /eta@2.2.0: + resolution: {integrity: sha512-UVQ72Rqjy/ZKQalzV5dCCJP80GrmPrMxh6NlNf+erV6ObL0ZFkhCstWRawS85z3smdr3d2wXPsZEY7rDPfGd2g==} + engines: {node: '>=6.0.0'} + dev: false + + /etag@1.8.1: + resolution: {integrity: sha512-aIL5Fx7mawVa300al2BnEE4iNvo1qETxLrPI/o05L7z6go7fCw1J6EQmbK4FmJ2AS7kgVF/KEZWufBfdClMcPg==} + engines: {node: '>= 0.6'} + dev: false + + /eval@0.1.8: + resolution: {integrity: sha512-EzV94NYKoO09GLXGjXj9JIlXijVck4ONSr5wiCWDvhsvj5jxSrzTmRU/9C1DyB6uToszLs8aifA6NQ7lEQdvFw==} + engines: {node: '>= 0.8'} + dependencies: + '@types/node': 20.8.9 + require-like: 0.1.2 + dev: false + + /eventemitter3@4.0.7: + resolution: {integrity: sha512-8guHBZCwKnFhYdHr2ysuRWErTwhoN2X8XELRlrRwpmfeY2jjuUN4taQMsULKUVo1K4DvZl+0pgfyoysHxvmvEw==} + dev: false + + /events@3.3.0: + resolution: {integrity: sha512-mQw+2fkQbALzQ7V0MY0IqdnXNOeTtP4r0lN9z7AAawCXgqea7bDii20AYrIBrFd/Hx0M2Ocz6S111CaFkUcb0Q==} + engines: {node: '>=0.8.x'} + + /execa@5.1.1: + resolution: {integrity: sha512-8uSpZZocAZRBAPIEINJj3Lo9HyGitllczc27Eh5YYojjMFMn8yHMDMaUHE2Jqfq05D/wucwI4JGURyXt1vchyg==} + engines: {node: '>=10'} + dependencies: + cross-spawn: 7.0.3 + get-stream: 6.0.1 + human-signals: 2.1.0 + is-stream: 2.0.1 + merge-stream: 2.0.0 + npm-run-path: 4.0.1 + onetime: 5.1.2 + signal-exit: 3.0.7 + strip-final-newline: 2.0.0 + dev: false + + /express@4.18.2: + resolution: {integrity: sha512-5/PsL6iGPdfQ/lKM1UuielYgv3BUoJfz1aUwU9vHZ+J7gyvwdQXFEBIEIaxeGf0GIcreATNyBExtalisDbuMqQ==} + engines: {node: '>= 0.10.0'} + dependencies: + accepts: 1.3.8 + array-flatten: 1.1.1 + body-parser: 1.20.1 + content-disposition: 0.5.4 + content-type: 1.0.5 + cookie: 0.5.0 + cookie-signature: 1.0.6 + debug: 2.6.9 + depd: 2.0.0 + encodeurl: 1.0.2 + escape-html: 1.0.3 + etag: 1.8.1 + finalhandler: 1.2.0 + fresh: 0.5.2 + http-errors: 2.0.0 + merge-descriptors: 1.0.1 + methods: 1.1.2 + on-finished: 2.4.1 + parseurl: 1.3.3 + path-to-regexp: 0.1.7 + proxy-addr: 2.0.7 + qs: 6.11.0 + range-parser: 1.2.1 + safe-buffer: 5.2.1 + send: 0.18.0 + serve-static: 1.15.0 + setprototypeof: 1.2.0 + statuses: 2.0.1 + type-is: 1.6.18 + utils-merge: 1.0.1 + vary: 1.1.2 + transitivePeerDependencies: + - supports-color + dev: false + + /extend-shallow@2.0.1: + resolution: {integrity: sha512-zCnTtlxNoAiDc3gqY2aYAWFx7XWWiasuF2K8Me5WbN8otHKTUKBwjPtNpRs/rbUZm7KxWAaNj7P1a/p52GbVug==} + engines: {node: '>=0.10.0'} + dependencies: + is-extendable: 0.1.1 + dev: false + + /extend@3.0.2: + resolution: {integrity: sha512-fjquC59cD7CyW6urNXK0FBufkZcoiGG80wTuPujX590cB5Ttln20E2UB4S/WARVqhXffZl2LNgS+gQdPIIim/g==} + dev: false + + /fast-deep-equal@3.1.3: + resolution: {integrity: sha512-f3qQ9oQy9j2AhBe/H9VC91wLmKBCCU/gDOnKNAYG5hswO7BLKj09Hc5HYNz9cGI++xlpDCIgDaitVs03ATR84Q==} + + /fast-glob@3.3.1: + resolution: {integrity: sha512-kNFPyjhh5cKjrUltxs+wFx+ZkbRaxxmZ+X0ZU31SOsxCEtP9VPgtq2teZw1DebupL5GmDaNQ6yKMMVcM41iqDg==} + engines: {node: '>=8.6.0'} + dependencies: + '@nodelib/fs.stat': 2.0.5 + '@nodelib/fs.walk': 1.2.8 + glob-parent: 5.1.2 + merge2: 1.4.1 + micromatch: 4.0.5 + + /fast-json-stable-stringify@2.1.0: + resolution: {integrity: sha512-lhd/wF+Lk98HZoTCtlVraHtfh5XYijIjalXck7saUtuanSDyLMxnHhSXEDJqHxD7msR8D0uCmqlkwjCV8xvwHw==} + + /fast-url-parser@1.1.3: + resolution: {integrity: sha512-5jOCVXADYNuRkKFzNJ0dCCewsZiYo0dz8QNYljkOpFC6r2U4OBmKtvm/Tsuh4w1YYdDqDb31a8TVhBJ2OJKdqQ==} + dependencies: + punycode: 1.4.1 + dev: false + + /fastq@1.15.0: + resolution: {integrity: sha512-wBrocU2LCXXa+lWBt8RoIRD89Fi8OdABODa/kEnyeyjS5aZO5/GNvI5sEINADqP/h8M29UHTHUb53sUu5Ihqdw==} + dependencies: + reusify: 1.0.4 + + /faye-websocket@0.11.4: + resolution: {integrity: sha512-CzbClwlXAuiRQAlUyfqPgvPoNKTckTPGfwZV4ZdAhVcP2lh9KUxJg2b5GkE7XbjKQ3YJnQ9z6D9ntLAlB+tP8g==} + engines: {node: '>=0.8.0'} + dependencies: + websocket-driver: 0.7.4 + dev: false + + /fbemitter@3.0.0: + resolution: {integrity: sha512-KWKaceCwKQU0+HPoop6gn4eOHk50bBv/VxjJtGMfwmJt3D29JpN4H4eisCtIPA+a8GVBam+ldMMpMjJUvpDyHw==} + dependencies: + fbjs: 3.0.5 + transitivePeerDependencies: + - encoding + dev: false + + /fbjs-css-vars@1.0.2: + resolution: {integrity: sha512-b2XGFAFdWZWg0phtAWLHCk836A1Xann+I+Dgd3Gk64MHKZO44FfoD1KxyvbSh0qZsIoXQGGlVztIY+oitJPpRQ==} + dev: false + + /fbjs@3.0.5: + resolution: {integrity: sha512-ztsSx77JBtkuMrEypfhgc3cI0+0h+svqeie7xHbh1k/IKdcydnvadp/mUaGgjAOXQmQSxsqgaRhS3q9fy+1kxg==} + dependencies: + cross-fetch: 3.1.8 + fbjs-css-vars: 1.0.2 + loose-envify: 1.4.0 + object-assign: 4.1.1 + promise: 7.3.1 + setimmediate: 1.0.5 + ua-parser-js: 1.0.37 + transitivePeerDependencies: + - encoding + dev: false + + /feed@4.2.2: + resolution: {integrity: sha512-u5/sxGfiMfZNtJ3OvQpXcvotFpYkL0n9u9mM2vkui2nGo8b4wvDkJ8gAkYqbA8QpGyFCv3RK0Z+Iv+9veCS9bQ==} + engines: {node: '>=0.4.0'} + dependencies: + xml-js: 1.6.11 + dev: false + + /fflate@0.4.8: + resolution: {integrity: sha512-FJqqoDBR00Mdj9ppamLa/Y7vxm+PRmNWA67N846RvsoYVMKB4q3y/de5PA7gUmRMYK/8CMz2GDZQmCRN1wBcWA==} + dev: false + + /file-loader@6.2.0(webpack@5.89.0): + resolution: {integrity: sha512-qo3glqyTa61Ytg4u73GultjHGjdRyig3tG6lPtyX/jOEJvHif9uB0/OCI2Kif6ctF3caQTW2G5gym21oAsI4pw==} + engines: {node: '>= 10.13.0'} + peerDependencies: + webpack: ^4.0.0 || ^5.0.0 + dependencies: + loader-utils: 2.0.4 + schema-utils: 3.3.0 + webpack: 5.89.0 + dev: false + + /filesize@8.0.7: + resolution: {integrity: sha512-pjmC+bkIF8XI7fWaH8KxHcZL3DPybs1roSKP4rKDvy20tAWwIObE4+JIseG2byfGKhud5ZnM4YSGKBz7Sh0ndQ==} + engines: {node: '>= 0.4.0'} + dev: false + + /fill-range@7.0.1: + resolution: {integrity: sha512-qOo9F+dMUmC2Lcb4BbVvnKJxTPjCm+RRpe4gDuGrzkL7mEVl/djYSu2OdQ2Pa302N4oqkSg9ir6jaLWJ2USVpQ==} + engines: {node: '>=8'} + dependencies: + to-regex-range: 5.0.1 + + /finalhandler@1.2.0: + resolution: {integrity: sha512-5uXcUVftlQMFnWC9qu/svkWv3GTd2PfUhK/3PLkYNAe7FbqJMt3515HaxE6eRL74GdsriiwujiawdaB1BpEISg==} + engines: {node: '>= 0.8'} + dependencies: + debug: 2.6.9 + encodeurl: 1.0.2 + escape-html: 1.0.3 + on-finished: 2.4.1 + parseurl: 1.3.3 + statuses: 2.0.1 + unpipe: 1.0.0 + transitivePeerDependencies: + - supports-color + dev: false + + /find-cache-dir@3.3.2: + resolution: {integrity: sha512-wXZV5emFEjrridIgED11OoUKLxiYjAcqot/NJdAkOhlJ+vGzwhOAfcG5OX1jP+S0PcjEn8bdMJv+g2jwQ3Onig==} + engines: {node: '>=8'} + dependencies: + commondir: 1.0.1 + make-dir: 3.1.0 + pkg-dir: 4.2.0 + dev: false + + /find-up@3.0.0: + resolution: {integrity: sha512-1yD6RmLI1XBfxugvORwlck6f75tYL+iR0jqwsOrOxMZyGYqUuDhJ0l4AXdO1iX/FTs9cBAMEk1gWSEx1kSbylg==} + engines: {node: '>=6'} + dependencies: + locate-path: 3.0.0 + dev: false + + /find-up@4.1.0: + resolution: {integrity: sha512-PpOwAdQ/YlXQ2vj8a3h8IipDuYRi3wceVQQGYWxNINccq40Anw7BlsEXCMbt1Zt+OLA6Fq9suIpIWD0OsnISlw==} + engines: {node: '>=8'} + dependencies: + locate-path: 5.0.0 + path-exists: 4.0.0 + dev: false + + /find-up@5.0.0: + resolution: {integrity: sha512-78/PXT1wlLLDgTzDs7sjq9hzz0vXD+zn+7wypEe4fXQxCmdmqfGsEPQxmiCSQI3ajFV91bVSsvNtrJRiW6nGng==} + engines: {node: '>=10'} + dependencies: + locate-path: 6.0.0 + path-exists: 4.0.0 + dev: false + + /flat@5.0.2: + resolution: {integrity: sha512-b6suED+5/3rTpUBdG1gupIl8MPFCAMA0QXwmljLhvCUKcUvdE4gWky9zpuGCcXHOsz4J9wPGNWq6OKpmIzz3hQ==} + hasBin: true + + /flux@4.0.4(react@17.0.2): + resolution: {integrity: sha512-NCj3XlayA2UsapRpM7va6wU1+9rE5FIL7qoMcmxWHRzbp0yujihMBm9BBHZ1MDIk5h5o2Bl6eGiCe8rYELAmYw==} + peerDependencies: + react: ^15.0.2 || ^16.0.0 || ^17.0.0 + dependencies: + fbemitter: 3.0.0 + fbjs: 3.0.5 + react: 17.0.2 + transitivePeerDependencies: + - encoding + dev: false + + /follow-redirects@1.15.3: + resolution: {integrity: sha512-1VzOtuEM8pC9SFU1E+8KfTjZyMztRsgEfwQl44z8A25uy13jSzTj6dyK2Df52iV0vgHCfBwLhDWevLn95w5v6Q==} + engines: {node: '>=4.0'} + peerDependencies: + debug: '*' + peerDependenciesMeta: + debug: + optional: true + dev: false + + /fork-ts-checker-webpack-plugin@6.5.3(typescript@4.9.5)(webpack@5.89.0): + resolution: {integrity: sha512-SbH/l9ikmMWycd5puHJKTkZJKddF4iRLyW3DeZ08HTI7NGyLS38MXd/KGgeWumQO7YNQbW2u/NtPT2YowbPaGQ==} + engines: {node: '>=10', yarn: '>=1.0.0'} + peerDependencies: + eslint: '>= 6' + typescript: '>= 2.7' + vue-template-compiler: '*' + webpack: '>= 4' + peerDependenciesMeta: + eslint: + optional: true + vue-template-compiler: + optional: true + dependencies: + '@babel/code-frame': 7.22.13 + '@types/json-schema': 7.0.14 + chalk: 4.1.2 + chokidar: 3.5.3 + cosmiconfig: 6.0.0 + deepmerge: 4.3.1 + fs-extra: 9.1.0 + glob: 7.2.3 + memfs: 3.5.3 + minimatch: 3.1.2 + schema-utils: 2.7.0 + semver: 7.5.4 + tapable: 1.1.3 + typescript: 4.9.5 + webpack: 5.89.0 + dev: false + + /forwarded@0.2.0: + resolution: {integrity: sha512-buRG0fpBtRHSTCOASe6hD258tEubFoRLb4ZNA6NxMVHNw2gOcwHo9wyablzMzOA5z9xA9L1KNjk/Nt6MT9aYow==} + engines: {node: '>= 0.6'} + dev: false + + /fraction.js@4.3.7: + resolution: {integrity: sha512-ZsDfxO51wGAXREY55a7la9LScWpwv9RxIrYABrlvOFBlH/ShPnrtsXeuUIfXKKOVicNxQ+o8JTbJvjS4M89yew==} + + /fresh@0.5.2: + resolution: {integrity: sha512-zJ2mQYM18rEFOudeV4GShTGIQ7RbzA7ozbU9I/XBpm7kqgMywgmylMwXHxZJmkVoYkna9d2pVXVXPdYTP9ej8Q==} + engines: {node: '>= 0.6'} + dev: false + + /fs-extra@10.1.0: + resolution: {integrity: sha512-oRXApq54ETRj4eMiFzGnHWGy+zo5raudjuxN0b8H7s/RU2oW0Wvsx9O0ACRN/kRq9E8Vu/ReskGB5o3ji+FzHQ==} + engines: {node: '>=12'} + dependencies: + graceful-fs: 4.2.11 + jsonfile: 6.1.0 + universalify: 2.0.0 + dev: false + + /fs-extra@9.1.0: + resolution: {integrity: sha512-hcg3ZmepS30/7BSFqRvoo3DOMQu7IjqxO5nCDt+zM9XWjb33Wg7ziNT+Qvqbuc3+gWpzO02JubVyk2G4Zvo1OQ==} + engines: {node: '>=10'} + dependencies: + at-least-node: 1.0.0 + graceful-fs: 4.2.11 + jsonfile: 6.1.0 + universalify: 2.0.0 + dev: false + + /fs-monkey@1.0.5: + resolution: {integrity: sha512-8uMbBjrhzW76TYgEV27Y5E//W2f/lTFmx78P2w19FZSxarhI/798APGQyuGCwmkNxgwGRhrLfvWyLBvNtuOmew==} + dev: false + + /fs.realpath@1.0.0: + resolution: {integrity: sha512-OO0pH2lK6a0hZnAdau5ItzHPI6pUlvI7jMVnxUQRtw4owF2wk8lOSabtGDCTP4Ggrg2MbGnWO9X8K1t4+fGMDw==} + + /fsevents@2.3.3: + resolution: {integrity: sha512-5xoDfX+fL7faATnagmWPpbFtwh/R77WmMMqqHGS65C3vvB0YHrgF+B1YmZ3441tMj5n63k0212XNoJwzlhffQw==} + engines: {node: ^8.16.0 || ^10.6.0 || >=11.0.0} + os: [darwin] + requiresBuild: true + optional: true + + /function-bind@1.1.2: + resolution: {integrity: sha512-7XHNxH7qX9xG5mIwxkhumTox/MIRNcOgDrxWsMt2pAr23WHp6MrRlN7FBSFpCpr+oVO0F744iUgR82nJMfG2SA==} + + /fuse.js@6.6.2: + resolution: {integrity: sha512-cJaJkxCCxC8qIIcPBF9yGxY0W/tVZS3uEISDxhYIdtk8OL93pe+6Zj7LjCqVV4dzbqcriOZ+kQ/NE4RXZHsIGA==} + engines: {node: '>=10'} + dev: false + + /gensync@1.0.0-beta.2: + resolution: {integrity: sha512-3hN7NaskYvMDLQY55gnW3NQ+mesEAepTqlg+VEbj7zzqEMBVNhzcGYYeqFo/TlYz6eQiFcp1HcsCZO+nGgS8zg==} + engines: {node: '>=6.9.0'} + dev: false + + /get-intrinsic@1.2.2: + resolution: {integrity: sha512-0gSo4ml/0j98Y3lngkFEot/zhiCeWsbYIlZ+uZOVgzLyLaUw7wxUL+nCTP0XJvJg1AXulJRI3UJi8GsbDuxdGA==} + dependencies: + function-bind: 1.1.2 + has-proto: 1.0.1 + has-symbols: 1.0.3 + hasown: 2.0.0 + dev: false + + /get-nonce@1.0.1: + resolution: {integrity: sha512-FJhYRoDaiatfEkUK8HKlicmu/3SGFD51q3itKDGoSTysQJBnfOcxU5GxnhE1E6soB76MbT0MBtnKJuXyAx+96Q==} + engines: {node: '>=6'} + dev: false + + /get-own-enumerable-property-symbols@3.0.2: + resolution: {integrity: sha512-I0UBV/XOz1XkIJHEUDMZAbzCThU/H8DxmSfmdGcKPnVhu2VfFqr34jr9777IyaTYvxjedWhqVIilEDsCdP5G6g==} + dev: false + + /get-stream@4.1.0: + resolution: {integrity: sha512-GMat4EJ5161kIy2HevLlr4luNjBgvmj413KaQA7jt4V8B4RDsfpHk7WQ9GVqfYyyx8OS/L66Kox+rJRNklLK7w==} + engines: {node: '>=6'} + dependencies: + pump: 3.0.0 + dev: false + + /get-stream@5.2.0: + resolution: {integrity: sha512-nBF+F1rAZVCu/p7rjzgA+Yb4lfYXrpl7a6VmJrU8wF9I1CKvP/QwPNZHnOlwbTkY6dvtFIzFMSyQXbLoTQPRpA==} + engines: {node: '>=8'} + dependencies: + pump: 3.0.0 + dev: false + + /get-stream@6.0.1: + resolution: {integrity: sha512-ts6Wi+2j3jQjqi70w5AlN8DFnkSwC+MqmxEzdEALB2qXZYV3X/b1CTfgPLGJNMeAWxdPfU8FO1ms3NUfaHCPYg==} + engines: {node: '>=10'} + dev: false + + /github-slugger@1.5.0: + resolution: {integrity: sha512-wIh+gKBI9Nshz2o46B0B3f5k/W+WI9ZAv6y5Dn5WJ5SK1t0TnDimB4WE5rmTD05ZAIn8HALCZVmCsvj0w0v0lw==} + dev: false + + /glob-parent@5.1.2: + resolution: {integrity: sha512-AOIgSQCepiJYwP3ARnGx+5VnTu2HBYdzbGP45eLw1vr3zB3vZLeyed1sC9hnbcOc9/SrMyM5RPQrkGz4aS9Zow==} + engines: {node: '>= 6'} + dependencies: + is-glob: 4.0.3 + + /glob-parent@6.0.2: + resolution: {integrity: sha512-XxwI8EOhVQgWp6iDL+3b0r86f4d6AX6zSU55HfB4ydCEuXLXc5FcYeOu+nnGftS4TEju/11rt4KJPTMgbfmv4A==} + engines: {node: '>=10.13.0'} + dependencies: + is-glob: 4.0.3 + + /glob-to-regexp@0.4.1: + resolution: {integrity: sha512-lkX1HJXwyMcprw/5YUZc2s7DrpAiHB21/V+E1rHUrVNokkvB6bqMzT0VfV6/86ZNabt1k14YOIaT7nDvOX3Iiw==} + + /glob@7.1.6: + resolution: {integrity: sha512-LwaxwyZ72Lk7vZINtNNrywX0ZuLyStrdDtabefZKAY5ZGJhVtgdznluResxNmPitE0SAO+O26sWTHeKSI2wMBA==} + dependencies: + fs.realpath: 1.0.0 + inflight: 1.0.6 + inherits: 2.0.4 + minimatch: 3.1.2 + once: 1.4.0 + path-is-absolute: 1.0.1 + dev: true + + /glob@7.2.3: + resolution: {integrity: sha512-nFR0zLpU2YCaRxwoCJvL6UvCH2JFyFVIvwTLsIf21AuHlMskA1hhTdk+LlYJtOlYt9v6dvszD2BGRqBL+iQK9Q==} + dependencies: + fs.realpath: 1.0.0 + inflight: 1.0.6 + inherits: 2.0.4 + minimatch: 3.1.2 + once: 1.4.0 + path-is-absolute: 1.0.1 + dev: false + + /global-dirs@3.0.1: + resolution: {integrity: sha512-NBcGGFbBA9s1VzD41QXDG+3++t9Mn5t1FpLdhESY6oKY4gYTFpX4wO3sqGUa0Srjtbfj3szX0RnemmrVRUdULA==} + engines: {node: '>=10'} + dependencies: + ini: 2.0.0 + dev: false + + /global-modules@2.0.0: + resolution: {integrity: sha512-NGbfmJBp9x8IxyJSd1P+otYK8vonoJactOogrVfFRIAEY1ukil8RSKDz2Yo7wh1oihl51l/r6W4epkeKJHqL8A==} + engines: {node: '>=6'} + dependencies: + global-prefix: 3.0.0 + dev: false + + /global-prefix@3.0.0: + resolution: {integrity: sha512-awConJSVCHVGND6x3tmMaKcQvwXLhjdkmomy2W+Goaui8YPgYgXJZewhg3fWC+DlfqqQuWg8AwqjGTD2nAPVWg==} + engines: {node: '>=6'} + dependencies: + ini: 1.3.8 + kind-of: 6.0.3 + which: 1.3.1 + dev: false + + /globals@11.12.0: + resolution: {integrity: sha512-WOBp/EEGUiIsJSp7wcv/y6MO+lV9UoncWqxuFfm8eBwzWNgyfBd6Gz+IeKQ9jCmyhoH99g15M3T+QaVHFjizVA==} + engines: {node: '>=4'} + dev: false + + /globby@11.1.0: + resolution: {integrity: sha512-jhIXaOzy1sb8IyocaruWSn1TjmnBVs8Ayhcy83rmxNJ8q2uWKCAj3CnJY+KpGSXCueAPc0i05kVvVKtP1t9S3g==} + engines: {node: '>=10'} + dependencies: + array-union: 2.1.0 + dir-glob: 3.0.1 + fast-glob: 3.3.1 + ignore: 5.2.4 + merge2: 1.4.1 + slash: 3.0.0 + dev: false + + /globby@13.2.2: + resolution: {integrity: sha512-Y1zNGV+pzQdh7H39l9zgB4PJqjRNqydvdYCDG4HFXM4XuvSaQQlEc91IU1yALL8gUTDomgBAfz3XJdmUS+oo0w==} + engines: {node: ^12.20.0 || ^14.13.1 || >=16.0.0} + dependencies: + dir-glob: 3.0.1 + fast-glob: 3.3.1 + ignore: 5.2.4 + merge2: 1.4.1 + slash: 4.0.0 + dev: false + + /gopd@1.0.1: + resolution: {integrity: sha512-d65bNlIadxvpb/A2abVdlqKqV563juRnZ1Wtk6s1sIR8uNsXR70xqIzVqxVf1eTqDunwT2MkczEeaezCKTZhwA==} + dependencies: + get-intrinsic: 1.2.2 + dev: false + + /got@9.6.0: + resolution: {integrity: sha512-R7eWptXuGYxwijs0eV+v3o6+XH1IqVK8dJOEecQfTmkncw9AV4dcw/Dhxi8MdlqPthxxpZyizMzyg8RTmEsG+Q==} + engines: {node: '>=8.6'} + dependencies: + '@sindresorhus/is': 0.14.0 + '@szmarczak/http-timer': 1.1.2 + '@types/keyv': 3.1.4 + '@types/responselike': 1.0.2 + cacheable-request: 6.1.0 + decompress-response: 3.3.0 + duplexer3: 0.1.5 + get-stream: 4.1.0 + lowercase-keys: 1.0.1 + mimic-response: 1.0.1 + p-cancelable: 1.1.0 + to-readable-stream: 1.0.0 + url-parse-lax: 3.0.0 + dev: false + + /graceful-fs@4.2.11: + resolution: {integrity: sha512-RbJ5/jmFcNNCcDV5o9eTnBLJ/HszWV0P73bc+Ff4nS/rJj+YaS6IGyiOL0VoBYX+l1Wrl3k63h/KrH+nhJ0XvQ==} + + /gray-matter@4.0.3: + resolution: {integrity: sha512-5v6yZd4JK3eMI3FqqCouswVqwugaA9r4dNZB1wwcmrD02QkV5H0y7XBQW8QwQqEaZY1pM9aqORSORhJRdNK44Q==} + engines: {node: '>=6.0'} + dependencies: + js-yaml: 3.14.1 + kind-of: 6.0.3 + section-matter: 1.0.0 + strip-bom-string: 1.0.0 + dev: false + + /gzip-size@6.0.0: + resolution: {integrity: sha512-ax7ZYomf6jqPTQ4+XCpUGyXKHk5WweS+e05MBO4/y3WJ5RkmPXNKvX+bx1behVILVwr6JSQvZAku021CHPXG3Q==} + engines: {node: '>=10'} + dependencies: + duplexer: 0.1.2 + dev: false + + /handle-thing@2.0.1: + resolution: {integrity: sha512-9Qn4yBxelxoh2Ow62nP+Ka/kMnOXRi8BXnRaUwezLNhqelnN49xKz4F/dPP8OYLxLxq6JDtZb2i9XznUQbNPTg==} + dev: false + + /has-flag@3.0.0: + resolution: {integrity: sha512-sKJf1+ceQBr4SMkvQnBDNDtf4TXpVhVGateu0t918bl30FnbE2m4vNLX+VWe/dpjlb+HugGYzW7uQXH98HPEYw==} + engines: {node: '>=4'} + dev: false + + /has-flag@4.0.0: + resolution: {integrity: sha512-EykJT/Q1KjTWctppgIAgfSO0tKVuZUjhgMr17kqTumMl6Afv3EISleU7qZUzoXDFTAHTDC4NOoG/ZxU3EvlMPQ==} + engines: {node: '>=8'} + + /has-property-descriptors@1.0.1: + resolution: {integrity: sha512-VsX8eaIewvas0xnvinAe9bw4WfIeODpGYikiWYLH+dma0Jw6KHYqWiWfhQlgOVK8D6PvjubK5Uc4P0iIhIcNVg==} + dependencies: + get-intrinsic: 1.2.2 + dev: false + + /has-proto@1.0.1: + resolution: {integrity: sha512-7qE+iP+O+bgF9clE5+UoBFzE65mlBiVj3tKCrlNQ0Ogwm0BjpT/gK4SlLYDMybDh5I3TCTKnPPa0oMG7JDYrhg==} + engines: {node: '>= 0.4'} + dev: false + + /has-symbols@1.0.3: + resolution: {integrity: sha512-l3LCuF6MgDNwTDKkdYGEihYjt5pRPbEg46rtlmnSPlUbgmB8LOIrKJbYYFBSbnPaJexMKtiPO8hmeRjRz2Td+A==} + engines: {node: '>= 0.4'} + dev: false + + /has-yarn@2.1.0: + resolution: {integrity: sha512-UqBRqi4ju7T+TqGNdqAO0PaSVGsDGJUBQvk9eUWNGRY1CFGDzYhLWoM7JQEemnlvVcv/YEmc2wNW8BC24EnUsw==} + engines: {node: '>=8'} + dev: false + + /hasown@2.0.0: + resolution: {integrity: sha512-vUptKVTpIJhcczKBbgnS+RtcuYMB8+oNzPK2/Hp3hanz8JmpATdmmgLgSaadVREkDm+e2giHwY3ZRkyjSIDDFA==} + engines: {node: '>= 0.4'} + dependencies: + function-bind: 1.1.2 + + /hast-to-hyperscript@9.0.1: + resolution: {integrity: sha512-zQgLKqF+O2F72S1aa4y2ivxzSlko3MAvxkwG8ehGmNiqd98BIN3JM1rAJPmplEyLmGLO2QZYJtIneOSZ2YbJuA==} + dependencies: + '@types/unist': 2.0.9 + comma-separated-tokens: 1.0.8 + property-information: 5.6.0 + space-separated-tokens: 1.1.5 + style-to-object: 0.3.0 + unist-util-is: 4.1.0 + web-namespaces: 1.1.4 + dev: false + + /hast-util-from-parse5@6.0.1: + resolution: {integrity: sha512-jeJUWiN5pSxW12Rh01smtVkZgZr33wBokLzKLwinYOUfSzm1Nl/c3GUGebDyOKjdsRgMvoVbV0VpAcpjF4NrJA==} + dependencies: + '@types/parse5': 5.0.3 + hastscript: 6.0.0 + property-information: 5.6.0 + vfile: 4.2.1 + vfile-location: 3.2.0 + web-namespaces: 1.1.4 + dev: false + + /hast-util-is-element@1.1.0: + resolution: {integrity: sha512-oUmNua0bFbdrD/ELDSSEadRVtWZOf3iF6Lbv81naqsIV99RnSCieTbWuWCY8BAeEfKJTKl0gRdokv+dELutHGQ==} + dev: false + + /hast-util-parse-selector@2.2.5: + resolution: {integrity: sha512-7j6mrk/qqkSehsM92wQjdIgWM2/BW61u/53G6xmC8i1OmEdKLHbk419QKQUjz6LglWsfqoiHmyMRkP1BGjecNQ==} + dev: false + + /hast-util-raw@6.0.1: + resolution: {integrity: sha512-ZMuiYA+UF7BXBtsTBNcLBF5HzXzkyE6MLzJnL605LKE8GJylNjGc4jjxazAHUtcwT5/CEt6afRKViYB4X66dig==} + dependencies: + '@types/hast': 2.3.7 + hast-util-from-parse5: 6.0.1 + hast-util-to-parse5: 6.0.0 + html-void-elements: 1.0.5 + parse5: 6.0.1 + unist-util-position: 3.1.0 + vfile: 4.2.1 + web-namespaces: 1.1.4 + xtend: 4.0.2 + zwitch: 1.0.5 + dev: false + + /hast-util-to-parse5@6.0.0: + resolution: {integrity: sha512-Lu5m6Lgm/fWuz8eWnrKezHtVY83JeRGaNQ2kn9aJgqaxvVkFCZQBEhgodZUDUvoodgyROHDb3r5IxAEdl6suJQ==} + dependencies: + hast-to-hyperscript: 9.0.1 + property-information: 5.6.0 + web-namespaces: 1.1.4 + xtend: 4.0.2 + zwitch: 1.0.5 + dev: false + + /hast-util-to-text@2.0.1: + resolution: {integrity: sha512-8nsgCARfs6VkwH2jJU9b8LNTuR4700na+0h3PqCaEk4MAnMDeu5P0tP8mjk9LLNGxIeQRLbiDbZVw6rku+pYsQ==} + dependencies: + hast-util-is-element: 1.1.0 + repeat-string: 1.6.1 + unist-util-find-after: 3.0.0 + dev: false + + /hastscript@6.0.0: + resolution: {integrity: sha512-nDM6bvd7lIqDUiYEiu5Sl/+6ReP0BMk/2f4U/Rooccxkj0P5nm+acM5PrGJ/t5I8qPGiqZSE6hVAwZEdZIvP4w==} + dependencies: + '@types/hast': 2.3.7 + comma-separated-tokens: 1.0.8 + hast-util-parse-selector: 2.2.5 + property-information: 5.6.0 + space-separated-tokens: 1.1.5 + dev: false + + /he@1.2.0: + resolution: {integrity: sha512-F/1DnUGPopORZi0ni+CvrCgHQ5FyEAHRLSApuYWMmrbSwoN2Mn/7k+Gl38gJnR7yyDZk6WLXwiGod1JOWNDKGw==} + hasBin: true + dev: false + + /history@4.10.1: + resolution: {integrity: sha512-36nwAD620w12kuzPAsyINPWJqlNbij+hpK1k9XRloDtym8mxzGYl2c17LnV6IAGB2Dmg4tEa7G7DlawS0+qjew==} + dependencies: + '@babel/runtime': 7.23.2 + loose-envify: 1.4.0 + resolve-pathname: 3.0.0 + tiny-invariant: 1.3.1 + tiny-warning: 1.0.3 + value-equal: 1.0.1 + dev: false + + /hoist-non-react-statics@3.3.2: + resolution: {integrity: sha512-/gGivxi8JPKWNm/W0jSmzcMPpfpPLc3dY/6GxhX2hQ9iGj3aDfklV4ET7NjKpSinLpJ5vafa9iiGIEZg10SfBw==} + dependencies: + react-is: 16.13.1 + dev: false + + /hpack.js@2.1.6: + resolution: {integrity: sha512-zJxVehUdMGIKsRaNt7apO2Gqp0BdqW5yaiGHXXmbpvxgBYVZnAql+BJb4RO5ad2MgpbZKn5G6nMnegrH1FcNYQ==} + dependencies: + inherits: 2.0.4 + obuf: 1.1.2 + readable-stream: 2.3.8 + wbuf: 1.7.3 + dev: false + + /html-entities@2.4.0: + resolution: {integrity: sha512-igBTJcNNNhvZFRtm8uA6xMY6xYleeDwn3PeBCkDz7tHttv4F2hsDI2aPgNERWzvRcNYHNT3ymRaQzllmXj4YsQ==} + dev: false + + /html-minifier-terser@6.1.0: + resolution: {integrity: sha512-YXxSlJBZTP7RS3tWnQw74ooKa6L9b9i9QYXY21eUEvhZ3u9XLfv6OnFsQq6RxkhHygsaUMvYsZRV5rU/OVNZxw==} + engines: {node: '>=12'} + hasBin: true + dependencies: + camel-case: 4.1.2 + clean-css: 5.3.2 + commander: 8.3.0 + he: 1.2.0 + param-case: 3.0.4 + relateurl: 0.2.7 + terser: 5.22.0 + dev: false + + /html-tags@3.3.1: + resolution: {integrity: sha512-ztqyC3kLto0e9WbNp0aeP+M3kTt+nbaIveGmUxAtZa+8iFgKLUOD4YKM5j+f3QD89bra7UeumolZHKuOXnTmeQ==} + engines: {node: '>=8'} + dev: false + + /html-void-elements@1.0.5: + resolution: {integrity: sha512-uE/TxKuyNIcx44cIWnjr/rfIATDH7ZaOMmstu0CwhFG1Dunhlp4OC6/NMbhiwoq5BpW0ubi303qnEk/PZj614w==} + dev: false + + /html-webpack-plugin@5.5.3(webpack@5.89.0): + resolution: {integrity: sha512-6YrDKTuqaP/TquFH7h4srYWsZx+x6k6+FbsTm0ziCwGHDP78Unr1r9F/H4+sGmMbX08GQcJ+K64x55b+7VM/jg==} + engines: {node: '>=10.13.0'} + peerDependencies: + webpack: ^5.20.0 + dependencies: + '@types/html-minifier-terser': 6.1.0 + html-minifier-terser: 6.1.0 + lodash: 4.17.21 + pretty-error: 4.0.0 + tapable: 2.2.1 + webpack: 5.89.0 + dev: false + + /htmlparser2@6.1.0: + resolution: {integrity: sha512-gyyPk6rgonLFEDGoeRgQNaEUvdJ4ktTmmUh/h2t7s+M8oPpIPxgNACWa+6ESR57kXstwqPiCut0V8NRpcwgU7A==} + dependencies: + domelementtype: 2.3.0 + domhandler: 4.3.1 + domutils: 2.8.0 + entities: 2.2.0 + dev: false + + /htmlparser2@8.0.2: + resolution: {integrity: sha512-GYdjWKDkbRLkZ5geuHs5NY1puJ+PXwP7+fHPRz06Eirsb9ugf6d8kkXav6ADhcODhFFPMIXyxkxSuMf3D6NCFA==} + dependencies: + domelementtype: 2.3.0 + domhandler: 5.0.3 + domutils: 3.1.0 + entities: 4.5.0 + dev: false + + /http-cache-semantics@4.1.1: + resolution: {integrity: sha512-er295DKPVsV82j5kw1Gjt+ADA/XYHsajl82cGNQG2eyoPkvgUhX+nDIyelzhIWbbsXP39EHcI6l5tYs2FYqYXQ==} + dev: false + + /http-deceiver@1.2.7: + resolution: {integrity: sha512-LmpOGxTfbpgtGVxJrj5k7asXHCgNZp5nLfp+hWc8QQRqtb7fUy6kRY3BO1h9ddF6yIPYUARgxGOwB42DnxIaNw==} + dev: false + + /http-errors@1.6.3: + resolution: {integrity: sha512-lks+lVC8dgGyh97jxvxeYTWQFvh4uw4yC12gVl63Cg30sjPX4wuGcdkICVXDAESr6OJGjqGA8Iz5mkeN6zlD7A==} + engines: {node: '>= 0.6'} + dependencies: + depd: 1.1.2 + inherits: 2.0.3 + setprototypeof: 1.1.0 + statuses: 1.5.0 + dev: false + + /http-errors@2.0.0: + resolution: {integrity: sha512-FtwrG/euBzaEjYeRqOgly7G0qviiXoJWnvEH2Z1plBdXgbyjv34pHTSb9zoeHMyDy33+DWy5Wt9Wo+TURtOYSQ==} + engines: {node: '>= 0.8'} + dependencies: + depd: 2.0.0 + inherits: 2.0.4 + setprototypeof: 1.2.0 + statuses: 2.0.1 + toidentifier: 1.0.1 + dev: false + + /http-parser-js@0.5.8: + resolution: {integrity: sha512-SGeBX54F94Wgu5RH3X5jsDtf4eHyRogWX1XGT3b4HuW3tQPM4AaBzoUji/4AAJNXCEOWZ5O0DgZmJw1947gD5Q==} + dev: false + + /http-proxy-middleware@2.0.6(@types/express@4.17.20): + resolution: {integrity: sha512-ya/UeJ6HVBYxrgYotAZo1KvPWlgB48kUJLDePFeneHsVujFaW5WNj2NgWCAE//B1Dl02BIfYlpNgBy8Kf8Rjmw==} + engines: {node: '>=12.0.0'} + peerDependencies: + '@types/express': ^4.17.13 + peerDependenciesMeta: + '@types/express': + optional: true + dependencies: + '@types/express': 4.17.20 + '@types/http-proxy': 1.17.13 + http-proxy: 1.18.1 + is-glob: 4.0.3 + is-plain-obj: 3.0.0 + micromatch: 4.0.5 + transitivePeerDependencies: + - debug + dev: false + + /http-proxy@1.18.1: + resolution: {integrity: sha512-7mz/721AbnJwIVbnaSv1Cz3Am0ZLT/UBwkC92VlxhXv/k/BBQfM2fXElQNC27BVGr0uwUpplYPQM9LnaBMR5NQ==} + engines: {node: '>=8.0.0'} + dependencies: + eventemitter3: 4.0.7 + follow-redirects: 1.15.3 + requires-port: 1.0.0 + transitivePeerDependencies: + - debug + dev: false + + /human-signals@2.1.0: + resolution: {integrity: sha512-B4FFZ6q/T2jhhksgkbEW3HBvWIfDW85snkQgawt07S7J5QXTk6BkNV+0yAeZrM5QpMAdYlocGoljn0sJ/WQkFw==} + engines: {node: '>=10.17.0'} + dev: false + + /iconv-lite@0.4.24: + resolution: {integrity: sha512-v3MXnZAcvnywkTUEZomIActle7RXXeedOR31wwl7VlyoXO4Qi9arvSenNQWne1TcRwhCL1HwLI21bEqdpj8/rA==} + engines: {node: '>=0.10.0'} + dependencies: + safer-buffer: 2.1.2 + dev: false + + /icss-utils@5.1.0(postcss@8.4.31): + resolution: {integrity: sha512-soFhflCVWLfRNOPU3iv5Z9VUdT44xFRbzjLsEzSr5AQmgqPMTHdU3PMT1Cf1ssx8fLNJDA1juftYl+PUcv3MqA==} + engines: {node: ^10 || ^12 || >= 14} + peerDependencies: + postcss: ^8.1.0 + dependencies: + postcss: 8.4.31 + dev: false + + /ignore@5.2.4: + resolution: {integrity: sha512-MAb38BcSbH0eHNBxn7ql2NH/kX33OkB3lZ1BNdh7ENeRChHTYsTvWrMubiIAMNS2llXEEgZ1MUOBtXChP3kaFQ==} + engines: {node: '>= 4'} + dev: false + + /image-size@1.0.2: + resolution: {integrity: sha512-xfOoWjceHntRb3qFCrh5ZFORYH8XCdYpASltMhZ/Q0KZiOwjdE/Yl2QCiWdwD+lygV5bMCvauzgu5PxBX/Yerg==} + engines: {node: '>=14.0.0'} + hasBin: true + dependencies: + queue: 6.0.2 + dev: false + + /immer@9.0.21: + resolution: {integrity: sha512-bc4NBHqOqSfRW7POMkHd51LvClaeMXpm8dx0e8oE2GORbq5aRK7Bxl4FyzVLdGtLmvLKL7BTDBG5ACQm4HWjTA==} + dev: false + + /import-fresh@3.3.0: + resolution: {integrity: sha512-veYYhQa+D1QBKznvhUHxb8faxlrwUnxseDAbAp457E0wLNio2bOSKnjYDhMj+YiAq61xrMGhQk9iXVk5FzgQMw==} + engines: {node: '>=6'} + dependencies: + parent-module: 1.0.1 + resolve-from: 4.0.0 + dev: false + + /import-lazy@2.1.0: + resolution: {integrity: sha512-m7ZEHgtw69qOGw+jwxXkHlrlIPdTGkyh66zXZ1ajZbxkDBNjSY/LGbmjc7h0s2ELsUDTAhFr55TrPSSqJGPG0A==} + engines: {node: '>=4'} + dev: false + + /imurmurhash@0.1.4: + resolution: {integrity: sha512-JmXMZ6wuvDmLiHEml9ykzqO6lwFbof0GG4IkcGaENdCRDDmMVnny7s5HsIgHCbaq0w2MyPhDqkhTUgS2LU2PHA==} + engines: {node: '>=0.8.19'} + dev: false + + /indent-string@4.0.0: + resolution: {integrity: sha512-EdDDZu4A2OyIK7Lr/2zG+w5jmbuk1DVBnEwREQvBzspBJkCEbRa8GxU1lghYcaGJCnRWibjDXlq779X1/y5xwg==} + engines: {node: '>=8'} + dev: false + + /infima@0.2.0-alpha.43: + resolution: {integrity: sha512-2uw57LvUqW0rK/SWYnd/2rRfxNA5DDNOh33jxF7fy46VWoNhGxiUQyVZHbBMjQ33mQem0cjdDVwgWVAmlRfgyQ==} + engines: {node: '>=12'} + dev: false + + /inflight@1.0.6: + resolution: {integrity: sha512-k92I/b08q4wvFscXCLvqfsHCrjrF7yiXsQuIVvVE7N82W3+aqpzuUdBbfhWcy/FZR3/4IgflMgKLOsvPDrGCJA==} + dependencies: + once: 1.4.0 + wrappy: 1.0.2 + + /inherits@2.0.3: + resolution: {integrity: sha512-x00IRNXNy63jwGkJmzPigoySHbaqpNuzKbBOmzK+g2OdZpQ9w+sxCN+VSB3ja7IAge2OP2qpfxTjeNcyjmW1uw==} + dev: false + + /inherits@2.0.4: + resolution: {integrity: sha512-k/vGaX4/Yla3WzyMCvTQOXYeIHvqOKtnqBduzTHpzpQZzAskKMhZ2K+EnBiSM9zGSoIFeMpXKxa4dYeZIQqewQ==} + + /ini@1.3.8: + resolution: {integrity: sha512-JV/yugV2uzW5iMRSiZAyDtQd+nxtUnjeLt0acNdw98kKLrvuRVyB80tsREOE7yvGVgalhZ6RNXCmEHkUKBKxew==} + dev: false + + /ini@2.0.0: + resolution: {integrity: sha512-7PnF4oN3CvZF23ADhA5wRaYEQpJ8qygSkbtTXWBeXWXmEVRXK+1ITciHWwHhsjv1TmW0MgacIv6hEi5pX5NQdA==} + engines: {node: '>=10'} + dev: false + + /inline-style-parser@0.1.1: + resolution: {integrity: sha512-7NXolsK4CAS5+xvdj5OMMbI962hU/wvwoxk+LWR9Ek9bVtyuuYScDN6eS0rUm6TxApFpw7CX1o4uJzcd4AyD3Q==} + dev: false + + /interpret@1.4.0: + resolution: {integrity: sha512-agE4QfB2Lkp9uICn7BAqoscw4SZP9kTE2hxiFI3jBPmXJfdqiahTbUuKGsMoN2GtqL9AxhYioAcVvgsb1HvRbA==} + engines: {node: '>= 0.10'} + dev: false + + /invariant@2.2.4: + resolution: {integrity: sha512-phJfQVBuaJM5raOpJjSfkiD6BpbCE4Ns//LaXl6wGYtUBY83nWS6Rf9tXm2e8VaK60JEjYldbPif/A2B1C2gNA==} + dependencies: + loose-envify: 1.4.0 + + /ipaddr.js@1.9.1: + resolution: {integrity: sha512-0KI/607xoxSToH7GjN1FfSbLoU0+btTicjsQSWQlh/hZykN8KpmMf7uYwPW3R+akZ6R/w18ZlXSHBYXiYUPO3g==} + engines: {node: '>= 0.10'} + dev: false + + /ipaddr.js@2.1.0: + resolution: {integrity: sha512-LlbxQ7xKzfBusov6UMi4MFpEg0m+mAm9xyNGEduwXMEDuf4WfzB/RZwMVYEd7IKGvh4IUkEXYxtAVu9T3OelJQ==} + engines: {node: '>= 10'} + dev: false + + /is-alphabetical@1.0.4: + resolution: {integrity: sha512-DwzsA04LQ10FHTZuL0/grVDk4rFoVH1pjAToYwBrHSxcrBIGQuXrQMtD5U1b0U2XVgKZCTLLP8u2Qxqhy3l2Vg==} + dev: false + + /is-alphanumerical@1.0.4: + resolution: {integrity: sha512-UzoZUr+XfVz3t3v4KyGEniVL9BDRoQtY7tOyrRybkVNjDFWyo1yhXNGrrBTQxp3ib9BLAWs7k2YKBQsFRkZG9A==} + dependencies: + is-alphabetical: 1.0.4 + is-decimal: 1.0.4 + dev: false + + /is-arrayish@0.2.1: + resolution: {integrity: sha512-zz06S8t0ozoDXMG+ube26zeCTNXcKIPJZJi8hBrF4idCLms4CG9QtK7qBl1boi5ODzFpjswb5JPmHCbMpjaYzg==} + dev: false + + /is-binary-path@2.1.0: + resolution: {integrity: sha512-ZMERYes6pDydyuGidse7OsHxtbI7WVeUEozgR/g7rd0xUimYNlvZRE/K2MgZTjWy725IfelLeVcEM97mmtRGXw==} + engines: {node: '>=8'} + dependencies: + binary-extensions: 2.2.0 + + /is-buffer@2.0.5: + resolution: {integrity: sha512-i2R6zNFDwgEHJyQUtJEk0XFi1i0dPFn/oqjK3/vPCcDeJvW5NQ83V8QbicfF1SupOaB0h8ntgBC2YiE7dfyctQ==} + engines: {node: '>=4'} + dev: false + + /is-ci@2.0.0: + resolution: {integrity: sha512-YfJT7rkpQB0updsdHLGWrvhBJfcfzNNawYDNIyQXJz0IViGf75O8EBPKSdvw2rF+LGCsX4FZ8tcr3b19LcZq4w==} + hasBin: true + dependencies: + ci-info: 2.0.0 + dev: false + + /is-core-module@2.13.1: + resolution: {integrity: sha512-hHrIjvZsftOsvKSn2TRYl63zvxsgE0K+0mYMoH6gD4omR5IWB2KynivBQczo3+wF1cCkjzvptnI9Q0sPU66ilw==} + dependencies: + hasown: 2.0.0 + + /is-decimal@1.0.4: + resolution: {integrity: sha512-RGdriMmQQvZ2aqaQq3awNA6dCGtKpiDFcOzrTWrDAT2MiWrKQVPmxLGHl7Y2nNu6led0kEyoX0enY0qXYsv9zw==} + dev: false + + /is-docker@2.2.1: + resolution: {integrity: sha512-F+i2BKsFrH66iaUFc0woD8sLy8getkwTwtOBjvs56Cx4CgJDeKQeqfz8wAYiSb8JOprWhHH5p77PbmYCvvUuXQ==} + engines: {node: '>=8'} + hasBin: true + dev: false + + /is-extendable@0.1.1: + resolution: {integrity: sha512-5BMULNob1vgFX6EjQw5izWDxrecWK9AM72rugNr0TFldMOi0fj6Jk+zeKIt0xGj4cEfQIJth4w3OKWOJ4f+AFw==} + engines: {node: '>=0.10.0'} + dev: false + + /is-extglob@2.1.1: + resolution: {integrity: sha512-SbKbANkN603Vi4jEZv49LeVJMn4yGwsbzZworEoyEiutsN3nJYdbO36zfhGJ6QEDpOZIFkDtnq5JRxmvl3jsoQ==} + engines: {node: '>=0.10.0'} + + /is-fullwidth-code-point@3.0.0: + resolution: {integrity: sha512-zymm5+u+sCsSWyD9qNaejV3DFvhCKclKdizYaJUuHA83RLjb7nSuGnddCHGv0hk+KY7BMAlsWeK4Ueg6EV6XQg==} + engines: {node: '>=8'} + dev: false + + /is-glob@4.0.3: + resolution: {integrity: sha512-xelSayHH36ZgE7ZWhli7pW34hNbNl8Ojv5KVmkJD4hBdD3th8Tfk9vYasLM+mXWOZhFkgZfxhLSnrwRr4elSSg==} + engines: {node: '>=0.10.0'} + dependencies: + is-extglob: 2.1.1 + + /is-hexadecimal@1.0.4: + resolution: {integrity: sha512-gyPJuv83bHMpocVYoqof5VDiZveEoGoFL8m3BXNb2VW8Xs+rz9kqO8LOQ5DH6EsuvilT1ApazU0pyl+ytbPtlw==} + dev: false + + /is-installed-globally@0.4.0: + resolution: {integrity: sha512-iwGqO3J21aaSkC7jWnHP/difazwS7SFeIqxv6wEtLU8Y5KlzFTjyqcSIT0d8s4+dDhKytsk9PJZ2BkS5eZwQRQ==} + engines: {node: '>=10'} + dependencies: + global-dirs: 3.0.1 + is-path-inside: 3.0.3 + dev: false + + /is-npm@5.0.0: + resolution: {integrity: sha512-WW/rQLOazUq+ST/bCAVBp/2oMERWLsR7OrKyt052dNDk4DHcDE0/7QSXITlmi+VBcV13DfIbysG3tZJm5RfdBA==} + engines: {node: '>=10'} + dev: false + + /is-number@7.0.0: + resolution: {integrity: sha512-41Cifkg6e8TylSpdtTpeLVMqvSBEVzTttHvERD741+pnZ8ANv0004MRL43QKPDlK9cGvNp6NZWZUBlbGXYxxng==} + engines: {node: '>=0.12.0'} + + /is-obj@1.0.1: + resolution: {integrity: sha512-l4RyHgRqGN4Y3+9JHVrNqO+tN0rV5My76uW5/nuO4K1b6vw5G8d/cmFjP9tRfEsdhZNt0IFdZuK/c2Vr4Nb+Qg==} + engines: {node: '>=0.10.0'} + dev: false + + /is-obj@2.0.0: + resolution: {integrity: sha512-drqDG3cbczxxEJRoOXcOjtdp1J/lyp1mNn0xaznRs8+muBhgQcrnbspox5X5fOw0HnMnbfDzvnEMEtqDEJEo8w==} + engines: {node: '>=8'} + dev: false + + /is-path-cwd@2.2.0: + resolution: {integrity: sha512-w942bTcih8fdJPJmQHFzkS76NEP8Kzzvmw92cXsazb8intwLqPibPPdXf4ANdKV3rYMuuQYGIWtvz9JilB3NFQ==} + engines: {node: '>=6'} + dev: false + + /is-path-inside@3.0.3: + resolution: {integrity: sha512-Fd4gABb+ycGAmKou8eMftCupSir5lRxqf4aD/vd0cD2qc4HL07OjCeuHMr8Ro4CoMaeCKDB0/ECBOVWjTwUvPQ==} + engines: {node: '>=8'} + dev: false + + /is-plain-obj@2.1.0: + resolution: {integrity: sha512-YWnfyRwxL/+SsrWYfOpUtz5b3YD+nyfkHvjbcanzk8zgyO4ASD67uVMRt8k5bM4lLMDnXfriRhOpemw+NfT1eA==} + engines: {node: '>=8'} + dev: false + + /is-plain-obj@3.0.0: + resolution: {integrity: sha512-gwsOE28k+23GP1B6vFl1oVh/WOzmawBrKwo5Ev6wMKzPkaXaCDIQKzLnvsA42DRlbVTWorkgTKIviAKCWkfUwA==} + engines: {node: '>=10'} + dev: false + + /is-plain-object@2.0.4: + resolution: {integrity: sha512-h5PpgXkWitc38BBMYawTYMWJHFZJVnBquFE57xFpjB8pJFiF6gZ+bU+WyI/yqXiFR5mdLsgYNaPe8uao6Uv9Og==} + engines: {node: '>=0.10.0'} + dependencies: + isobject: 3.0.1 + + /is-plain-object@5.0.0: + resolution: {integrity: sha512-VRSzKkbMm5jMDoKLbltAkFQ5Qr7VDiTFGXxYFXXowVj387GeGNOCsOH6Msy00SGZ3Fp84b1Naa1psqgcCIEP5Q==} + engines: {node: '>=0.10.0'} + dev: false + + /is-regexp@1.0.0: + resolution: {integrity: sha512-7zjFAPO4/gwyQAAgRRmqeEeyIICSdmCqa3tsVHMdBzaXXRiqopZL4Cyghg/XulGWrtABTpbnYYzzIRffLkP4oA==} + engines: {node: '>=0.10.0'} + dev: false + + /is-root@2.1.0: + resolution: {integrity: sha512-AGOriNp96vNBd3HtU+RzFEc75FfR5ymiYv8E553I71SCeXBiMsVDUtdio1OEFvrPyLIQ9tVR5RxXIFe5PUFjMg==} + engines: {node: '>=6'} + dev: false + + /is-stream@2.0.1: + resolution: {integrity: sha512-hFoiJiTl63nn+kstHGBtewWSKnQLpyb155KHheA1l39uvtO9nWIop1p3udqPcUd/xbF1VLMO4n7OI6p7RbngDg==} + engines: {node: '>=8'} + dev: false + + /is-typedarray@1.0.0: + resolution: {integrity: sha512-cyA56iCMHAh5CdzjJIa4aohJyeO1YbwLi3Jc35MmRU6poroFjIGZzUzupGiRPOjgHg9TLu43xbpwXk523fMxKA==} + dev: false + + /is-whitespace-character@1.0.4: + resolution: {integrity: sha512-SDweEzfIZM0SJV0EUga669UTKlmL0Pq8Lno0QDQsPnvECB3IM2aP0gdx5TrU0A01MAPfViaZiI2V1QMZLaKK5w==} + dev: false + + /is-word-character@1.0.4: + resolution: {integrity: sha512-5SMO8RVennx3nZrqtKwCGyyetPE9VDba5ugvKLaD4KopPG5kR4mQ7tNt/r7feL5yt5h3lpuBbIUmCOG2eSzXHA==} + dev: false + + /is-wsl@2.2.0: + resolution: {integrity: sha512-fKzAra0rGJUUBwGBgNkHZuToZcn+TtXHpeCgmkMJMMYx1sQDYaCSyjJBSCa2nH1DGm7s3n1oBnohoVTBaN7Lww==} + engines: {node: '>=8'} + dependencies: + is-docker: 2.2.1 + dev: false + + /is-yarn-global@0.3.0: + resolution: {integrity: sha512-VjSeb/lHmkoyd8ryPVIKvOCn4D1koMqY+vqyjjUfc3xyKtP4dYOxM44sZrnqQSzSds3xyOrUTLTC9LVCVgLngw==} + dev: false + + /isarray@0.0.1: + resolution: {integrity: sha512-D2S+3GLxWH+uhrNEcoh/fnmYeP8E8/zHl644d/jdA0g2uyXvy3sb0qxotE+ne0LtccHknQzWwZEzhak7oJ0COQ==} + dev: false + + /isarray@1.0.0: + resolution: {integrity: sha512-VLghIWNM6ELQzo7zwmcg0NmTVyWKYjvIeM83yjp0wRDTmUnrM678fQbcKBo6n2CJEF0szoG//ytg+TKla89ALQ==} + dev: false + + /isexe@2.0.0: + resolution: {integrity: sha512-RHxMLp9lnKHGHRng9QFhRCMbYAcVpn69smSGcq3f36xjgVVWThj4qqLbTLlq7Ssj8B+fIQ1EuCEGI2lKsyQeIw==} + dev: false + + /isobject@3.0.1: + resolution: {integrity: sha512-WhB9zCku7EGTj/HQQRz5aUQEUeoQZH2bWcltRErOpymJ4boYE6wL9Tbr23krRPSZ+C5zqNSrSw+Cc7sZZ4b7vg==} + engines: {node: '>=0.10.0'} + + /jest-util@29.7.0: + resolution: {integrity: sha512-z6EbKajIpqGKU56y5KBUgy1dt1ihhQJgWzUlZHArA/+X2ad7Cb5iF+AK1EWVL/Bo7Rz9uurpqw6SiBCefUbCGA==} + engines: {node: ^14.15.0 || ^16.10.0 || >=18.0.0} + dependencies: + '@jest/types': 29.6.3 + '@types/node': 20.8.9 + chalk: 4.1.2 + ci-info: 3.9.0 + graceful-fs: 4.2.11 + picomatch: 2.3.1 + dev: false + + /jest-worker@27.5.1: + resolution: {integrity: sha512-7vuh85V5cdDofPyxn58nrPjBktZo0u9x1g8WtjQol+jZDaE+fhN+cIvTj11GndBnMnyfrUOG1sZQxCdjKh+DKg==} + engines: {node: '>= 10.13.0'} + dependencies: + '@types/node': 20.8.9 + merge-stream: 2.0.0 + supports-color: 8.1.1 + + /jest-worker@29.7.0: + resolution: {integrity: sha512-eIz2msL/EzL9UFTFFx7jBTkeZfku0yUAyZZZmJ93H2TYEiroIx2PQjEXcwYtYl8zXCxb+PAmA2hLIt/6ZEkPHw==} + engines: {node: ^14.15.0 || ^16.10.0 || >=18.0.0} + dependencies: + '@types/node': 20.8.9 + jest-util: 29.7.0 + merge-stream: 2.0.0 + supports-color: 8.1.1 + dev: false + + /jiti@1.20.0: + resolution: {integrity: sha512-3TV69ZbrvV6U5DfQimop50jE9Dl6J8O1ja1dvBbMba/sZ3YBEQqJ2VZRoQPVnhlzjNtU1vaXRZVrVjU4qtm8yA==} + hasBin: true + + /joi@17.11.0: + resolution: {integrity: sha512-NgB+lZLNoqISVy1rZocE9PZI36bL/77ie924Ri43yEvi9GUUMPeyVIr8KdFTMUlby1p0PBYMk9spIxEUQYqrJQ==} + dependencies: + '@hapi/hoek': 9.3.0 + '@hapi/topo': 5.1.0 + '@sideway/address': 4.1.4 + '@sideway/formula': 3.0.1 + '@sideway/pinpoint': 2.0.0 + + /js-tokens@4.0.0: + resolution: {integrity: sha512-RdJUflcE3cUzKiMqQgsCu06FPu9UdIJO0beYbPhHN4k6apgJtifcoCtT9bcxOpYBtpD2kCM6Sbzg4CausW/PKQ==} + + /js-yaml@3.14.1: + resolution: {integrity: sha512-okMH7OXXJ7YrN9Ok3/SXrnu4iX9yOk+25nqX4imS2npuvTYDmo/QEZoqwZkYaIDk3jVvBOTOIEgEhaLOynBS9g==} + hasBin: true + dependencies: + argparse: 1.0.10 + esprima: 4.0.1 + dev: false + + /js-yaml@4.1.0: + resolution: {integrity: sha512-wpxZs9NoxZaJESJGIZTyDEaYpl0FKSA+FB9aJiyemKhMwkxQg63h4T1KJgUGHpTqPDNRcmmYLugrRjJlBtWvRA==} + hasBin: true + dependencies: + argparse: 2.0.1 + dev: false + + /jsesc@0.5.0: + resolution: {integrity: sha512-uZz5UnB7u4T9LvwmFqXii7pZSouaRPorGs5who1Ip7VO0wxanFvBL7GkM6dTHlgX+jhBApRetaWpnDabOeTcnA==} + hasBin: true + dev: false + + /jsesc@2.5.2: + resolution: {integrity: sha512-OYu7XEzjkCQ3C5Ps3QIZsQfNpqoJyZZA99wd9aWd05NCtC5pWOkShK2mkL6HXQR6/Cy2lbNdPlZBpuQHXE63gA==} + engines: {node: '>=4'} + hasBin: true + dev: false + + /json-buffer@3.0.0: + resolution: {integrity: sha512-CuUqjv0FUZIdXkHPI8MezCnFCdaTAacej1TZYulLoAg1h/PhwkdXFN4V/gzY4g+fMBCOV2xF+rp7t2XD2ns/NQ==} + dev: false + + /json-parse-even-better-errors@2.3.1: + resolution: {integrity: sha512-xyFwyhro/JEof6Ghe2iz2NcXoj2sloNsWr/XsERDK/oiPCfaNhl5ONfp+jQdAZRQQ0IJWNzH9zIZF7li91kh2w==} + + /json-schema-traverse@0.4.1: + resolution: {integrity: sha512-xbbCH5dCYU5T8LcEhhuh7HJ88HXuW3qsI3Y0zOZFKfZEHcpWiHU/Jxzk629Brsab/mMiHQti9wMP+845RPe3Vg==} + + /json-schema-traverse@1.0.0: + resolution: {integrity: sha512-NM8/P9n3XjXhIZn1lLhkFaACTOURQXjWhV4BA/RnOv8xvgqtqpAX9IO4mRQxSx1Rlo4tqzeqb0sOlruaOy3dug==} + dev: false + + /json5@2.2.3: + resolution: {integrity: sha512-XmOWe7eyHYH14cLdVPoyg+GOH3rYX++KpzrylJwSW98t3Nk+U8XOl8FWKOgwtzdb8lXGf6zYwDUzeHMWfxasyg==} + engines: {node: '>=6'} + hasBin: true + dev: false + + /jsonfile@6.1.0: + resolution: {integrity: sha512-5dgndWOriYSm5cnYaJNhalLNDKOqFwyDB/rr1E9ZsGciGvKPs8R2xYGCacuf3z6K1YKDz182fd+fY3cn3pMqXQ==} + dependencies: + universalify: 2.0.0 + optionalDependencies: + graceful-fs: 4.2.11 + dev: false + + /katex@0.13.24: + resolution: {integrity: sha512-jZxYuKCma3VS5UuxOx/rFV1QyGSl3Uy/i0kTJF3HgQ5xMinCQVF8Zd4bMY/9aI9b9A2pjIBOsjSSm68ykTAr8w==} + hasBin: true + dependencies: + commander: 8.3.0 + dev: false + + /keyv@3.1.0: + resolution: {integrity: sha512-9ykJ/46SN/9KPM/sichzQ7OvXyGDYKGTaDlKMGCAlg2UK8KRy4jb0d8sFc+0Tt0YYnThq8X2RZgCg74RPxgcVA==} + dependencies: + json-buffer: 3.0.0 + dev: false + + /kind-of@6.0.3: + resolution: {integrity: sha512-dcS1ul+9tmeD95T+x28/ehLgd9mENa3LsvDTtzm3vyBEO7RPptvAD+t44WVXaUjTBRcrpFeFlC8WCruUR456hw==} + engines: {node: '>=0.10.0'} + + /kleur@3.0.3: + resolution: {integrity: sha512-eTIzlVOSUR+JxdDFepEYcBMtZ9Qqdef+rnzWdRZuMbOywu5tO2w2N7rqjoANZ5k9vywhL6Br1VRjUIgTQx4E8w==} + engines: {node: '>=6'} + dev: false + + /latest-version@5.1.0: + resolution: {integrity: sha512-weT+r0kTkRQdCdYCNtkMwWXQTMEswKrFBkm4ckQOMVhhqhIMI1UT2hMj+1iigIhgSZm5gTmrRXBNoGUgaTY1xA==} + engines: {node: '>=8'} + dependencies: + package-json: 6.5.0 + dev: false + + /launch-editor@2.6.1: + resolution: {integrity: sha512-eB/uXmFVpY4zezmGp5XtU21kwo7GBbKB+EQ+UZeWtGb9yAM5xt/Evk+lYH3eRNAtId+ej4u7TYPFZ07w4s7rRw==} + dependencies: + picocolors: 1.0.0 + shell-quote: 1.8.1 + dev: false + + /leven@3.1.0: + resolution: {integrity: sha512-qsda+H8jTaUaN/x5vzW2rzc+8Rw4TAQ/4KjB46IwK5VH+IlVeeeje/EoZRpiXvIqjFgK84QffqPztGI3VBLG1A==} + engines: {node: '>=6'} + dev: false + + /lilconfig@2.1.0: + resolution: {integrity: sha512-utWOt/GHzuUxnLKxB6dk81RoOeoNeHgbrXiuGk4yyF5qlRz+iIVWu56E2fqGHFrXz0QNUhLB/8nKqvRH66JKGQ==} + engines: {node: '>=10'} + + /lines-and-columns@1.2.4: + resolution: {integrity: sha512-7ylylesZQ/PV29jhEDl3Ufjo6ZX7gCqJr5F7PKrqc93v7fzSymt1BpwEU8nAUXs8qzzvqhbjhK5QZg6Mt/HkBg==} + + /loader-runner@4.3.0: + resolution: {integrity: sha512-3R/1M+yS3j5ou80Me59j7F9IMs4PXs3VqRrm0TU3AbKPxlmpoY1TNscJV/oGJXo8qCatFGTfDbY6W6ipGOYXfg==} + engines: {node: '>=6.11.5'} + + /loader-utils@2.0.4: + resolution: {integrity: sha512-xXqpXoINfFhgua9xiqD8fPFHgkoq1mmmpE92WlDbm9rNRd/EbRb+Gqf908T2DMfuHjjJlksiK2RbHVOdD/MqSw==} + engines: {node: '>=8.9.0'} + dependencies: + big.js: 5.2.2 + emojis-list: 3.0.0 + json5: 2.2.3 + dev: false + + /loader-utils@3.2.1: + resolution: {integrity: sha512-ZvFw1KWS3GVyYBYb7qkmRM/WwL2TQQBxgCK62rlvm4WpVQ23Nb4tYjApUlfjrEGvOs7KHEsmyUn75OHZrJMWPw==} + engines: {node: '>= 12.13.0'} + dev: false + + /locate-path@3.0.0: + resolution: {integrity: sha512-7AO748wWnIhNqAuaty2ZWHkQHRSNfPVIsPIfwEOWO22AmaoVrWavlOcMR5nzTLNYvp36X220/maaRsrec1G65A==} + engines: {node: '>=6'} + dependencies: + p-locate: 3.0.0 + path-exists: 3.0.0 + dev: false + + /locate-path@5.0.0: + resolution: {integrity: sha512-t7hw9pI+WvuwNJXwk5zVHpyhIqzg2qTlklJOf0mVxGSbe3Fp2VieZcduNYjaLDoy6p9uGpQEGWG87WpMKlNq8g==} + engines: {node: '>=8'} + dependencies: + p-locate: 4.1.0 + dev: false + + /locate-path@6.0.0: + resolution: {integrity: sha512-iPZK6eYjbxRu3uB4/WZ3EsEIMJFMqAoopl3R+zuq0UjcAm/MO6KCweDgPfP3elTztoKP3KtnVHxTn2NHBSDVUw==} + engines: {node: '>=10'} + dependencies: + p-locate: 5.0.0 + dev: false + + /lodash.castarray@4.4.0: + resolution: {integrity: sha512-aVx8ztPv7/2ULbArGJ2Y42bG1mEQ5mGjpdvrbJcJFU3TbYybe+QlLS4pst9zV52ymy2in1KpFPiZnAOATxD4+Q==} + dev: true + + /lodash.curry@4.1.1: + resolution: {integrity: sha512-/u14pXGviLaweY5JI0IUzgzF2J6Ne8INyzAZjImcryjgkZ+ebruBxy2/JaOOkTqScddcYtakjhSaeemV8lR0tA==} + dev: false + + /lodash.debounce@4.0.8: + resolution: {integrity: sha512-FT1yDzDYEoYWhnSGnpE/4Kj1fLZkDFyqRb7fNt6FdYOSxlUWAtp42Eh6Wb0rGIv/m9Bgo7x4GhQbm5Ys4SG5ow==} + dev: false + + /lodash.escape@4.0.1: + resolution: {integrity: sha512-nXEOnb/jK9g0DYMr1/Xvq6l5xMD7GDG55+GSYIYmS0G4tBk/hURD4JR9WCavs04t33WmJx9kCyp9vJ+mr4BOUw==} + dev: false + + /lodash.flatten@4.4.0: + resolution: {integrity: sha512-C5N2Z3DgnnKr0LOpv/hKCgKdb7ZZwafIrsesve6lmzvZIRZRGaZ/l6Q8+2W7NaT+ZwO3fFlSCzCzrDCFdJfZ4g==} + dev: false + + /lodash.flow@3.5.0: + resolution: {integrity: sha512-ff3BX/tSioo+XojX4MOsOMhJw0nZoUEF011LX8g8d3gvjVbxd89cCio4BCXronjxcTUIJUoqKEUA+n4CqvvRPw==} + dev: false + + /lodash.invokemap@4.6.0: + resolution: {integrity: sha512-CfkycNtMqgUlfjfdh2BhKO/ZXrP8ePOX5lEU/g0R3ItJcnuxWDwokMGKx1hWcfOikmyOVx6X9IwWnDGlgKl61w==} + dev: false + + /lodash.isplainobject@4.0.6: + resolution: {integrity: sha512-oSXzaWypCMHkPC3NvBEaPHf0KsA5mvPrOPgQWDsbg8n7orZ290M0BmC/jgRZ4vcJ6DTAhjrsSYgdsW/F+MFOBA==} + dev: true + + /lodash.memoize@4.1.2: + resolution: {integrity: sha512-t7j+NzmgnQzTAYXcsHYLgimltOV1MXHtlOWf6GjL9Kj8GK5FInw5JotxvbOs+IvV1/Dzo04/fCGfLVs7aXb4Ag==} + dev: false + + /lodash.merge@4.6.2: + resolution: {integrity: sha512-0KpjqXRVvrYyCsX1swR/XTK0va6VQkQM6MNo7PqW77ByjAhoARA8EfrP1N4+KlKj8YS0ZUCtRT/YUuhyYDujIQ==} + dev: true + + /lodash.pullall@4.2.0: + resolution: {integrity: sha512-VhqxBKH0ZxPpLhiu68YD1KnHmbhQJQctcipvmFnqIBDYzcIHzf3Zpu0tpeOKtR4x76p9yohc506eGdOjTmyIBg==} + dev: false + + /lodash.uniq@4.5.0: + resolution: {integrity: sha512-xfBaXQd9ryd9dlSDvnvI0lvxfLJlYAZzXomUYzLKtUeOQvOP5piqAWuGtrhWeqaXK9hhoM/iyJc5AV+XfsX3HQ==} + dev: false + + /lodash.uniqby@4.7.0: + resolution: {integrity: sha512-e/zcLx6CSbmaEgFHCA7BnoQKyCtKMxnuWrJygbwPs/AIn+IMKl66L8/s+wBUn5LRw2pZx3bUHibiV1b6aTWIww==} + dev: false + + /lodash@4.17.21: + resolution: {integrity: sha512-v2kDEe57lecTulaDIuNTPy3Ry4gLGJ6Z1O3vE1krgXZNrsQ+LFTGHVxVjcXPs17LhbZVGedAJv8XZ1tvj5FvSg==} + dev: false + + /loose-envify@1.4.0: + resolution: {integrity: sha512-lyuxPGr/Wfhrlem2CL/UcnUc1zcqKAImBDzukY7Y5F/yQiNdko6+fRLevlw1HgMySw7f611UIY408EtxRSoK3Q==} + hasBin: true + dependencies: + js-tokens: 4.0.0 + + /lower-case@2.0.2: + resolution: {integrity: sha512-7fm3l3NAF9WfN6W3JOmf5drwpVqX78JtoGJ3A6W0a6ZnldM41w2fV5D490psKFTpMds8TJse/eHLFFsNHHjHgg==} + dependencies: + tslib: 2.6.2 + dev: false + + /lowercase-keys@1.0.1: + resolution: {integrity: sha512-G2Lj61tXDnVFFOi8VZds+SoQjtQC3dgokKdDG2mTm1tx4m50NUHBOZSBwQQHyy0V12A0JTG4icfZQH+xPyh8VA==} + engines: {node: '>=0.10.0'} + dev: false + + /lowercase-keys@2.0.0: + resolution: {integrity: sha512-tqNXrS78oMOE73NMxK4EMLQsQowWf8jKooH9g7xPavRT706R6bkQJ6DY2Te7QukaZsulxa30wQ7bk0pm4XiHmA==} + engines: {node: '>=8'} + dev: false + + /lru-cache@5.1.1: + resolution: {integrity: sha512-KpNARQA3Iwv+jTA0utUVVbrh+Jlrr1Fv0e56GGzAFOXN7dk/FviaDW8LHmK52DlcH4WP2n6gI8vN1aesBFgo9w==} + dependencies: + yallist: 3.1.1 + dev: false + + /lru-cache@6.0.0: + resolution: {integrity: sha512-Jo6dJ04CmSjuznwJSS3pUeWmd/H0ffTlkXXgwZi+eq1UCmqQwCh+eLsYOYCwY991i2Fah4h1BEMCx4qThGbsiA==} + engines: {node: '>=10'} + dependencies: + yallist: 4.0.0 + dev: false + + /make-dir@3.1.0: + resolution: {integrity: sha512-g3FeP20LNwhALb/6Cz6Dd4F2ngze0jz7tbzrD2wAV+o9FeNHe4rL+yK2md0J/fiSf1sa1ADhXqi5+oVwOM/eGw==} + engines: {node: '>=8'} + dependencies: + semver: 6.3.1 + dev: false + + /markdown-escapes@1.0.4: + resolution: {integrity: sha512-8z4efJYk43E0upd0NbVXwgSTQs6cT3T06etieCMEg7dRbzCbxUCK/GHlX8mhHRDcp+OLlHkPKsvqQTCvsRl2cg==} + dev: false + + /mdast-squeeze-paragraphs@4.0.0: + resolution: {integrity: sha512-zxdPn69hkQ1rm4J+2Cs2j6wDEv7O17TfXTJ33tl/+JPIoEmtV9t2ZzBM5LPHE8QlHsmVD8t3vPKCyY3oH+H8MQ==} + dependencies: + unist-util-remove: 2.1.0 + dev: false + + /mdast-util-definitions@4.0.0: + resolution: {integrity: sha512-k8AJ6aNnUkB7IE+5azR9h81O5EQ/cTDXtWdMq9Kk5KcEW/8ritU5CeLg/9HhOC++nALHBlaogJ5jz0Ybk3kPMQ==} + dependencies: + unist-util-visit: 2.0.3 + dev: false + + /mdast-util-to-hast@10.0.1: + resolution: {integrity: sha512-BW3LM9SEMnjf4HXXVApZMt8gLQWVNXc3jryK0nJu/rOXPOnlkUjmdkDlmxMirpbU9ILncGFIwLH/ubnWBbcdgA==} + dependencies: + '@types/mdast': 3.0.14 + '@types/unist': 2.0.9 + mdast-util-definitions: 4.0.0 + mdurl: 1.0.1 + unist-builder: 2.0.3 + unist-util-generated: 1.1.6 + unist-util-position: 3.1.0 + unist-util-visit: 2.0.3 + dev: false + + /mdast-util-to-string@2.0.0: + resolution: {integrity: sha512-AW4DRS3QbBayY/jJmD8437V1Gombjf8RSOUCMFBuo5iHi58AGEgVCKQ+ezHkZZDpAQS75hcBMpLqjpJTjtUL7w==} + dev: false + + /mdn-data@2.0.14: + resolution: {integrity: sha512-dn6wd0uw5GsdswPFfsgMp5NSB0/aDe6fK94YJV/AJDYXL6HVLWBsxeq7js7Ad+mU2K9LAlwpk6kN2D5mwCPVow==} + dev: false + + /mdurl@1.0.1: + resolution: {integrity: sha512-/sKlQJCBYVY9Ers9hqzKou4H6V5UWc/M59TH2dvkt+84itfnq7uFOMLpOiOS4ujvHP4etln18fmIxA5R5fll0g==} + dev: false + + /media-typer@0.3.0: + resolution: {integrity: sha512-dq+qelQ9akHpcOl/gUVRTxVIOkAJ1wR3QAvb4RsVjS8oVoFjDGTc679wJYmUmknUF5HwMLOgb5O+a3KxfWapPQ==} + engines: {node: '>= 0.6'} + dev: false + + /memfs@3.5.3: + resolution: {integrity: sha512-UERzLsxzllchadvbPs5aolHh65ISpKpM+ccLbOJ8/vvpBKmAWf+la7dXFy7Mr0ySHbdHrFv5kGFCUHHe6GFEmw==} + engines: {node: '>= 4.0.0'} + dependencies: + fs-monkey: 1.0.5 + dev: false + + /merge-descriptors@1.0.1: + resolution: {integrity: sha512-cCi6g3/Zr1iqQi6ySbseM1Xvooa98N0w31jzUYrXPX2xqObmFGHJ0tQ5u74H3mVh7wLouTseZyYIq39g8cNp1w==} + dev: false + + /merge-stream@2.0.0: + resolution: {integrity: sha512-abv/qOcuPfk3URPfDzmZU1LKmuw8kT+0nIHvKrKgFrwifol/doWcdA4ZqsWQ8ENrFKkd67Mfpo/LovbIUsbt3w==} + + /merge2@1.4.1: + resolution: {integrity: sha512-8q7VEgMJW4J8tcfVPy8g09NcQwZdbwFEqhe/WZkoIzjn/3TGDwtOCYtXGxA3O8tPzpczCCDgv+P2P5y00ZJOOg==} + engines: {node: '>= 8'} + + /methods@1.1.2: + resolution: {integrity: sha512-iclAHeNqNm68zFtnZ0e+1L2yUIdvzNoauKU4WBA3VvH/vPFieF7qfRlwUZU+DA9P9bPXIS90ulxoUoCH23sV2w==} + engines: {node: '>= 0.6'} + dev: false + + /micromatch@4.0.5: + resolution: {integrity: sha512-DMy+ERcEW2q8Z2Po+WNXuw3c5YaUSFjAO5GsJqfEl7UjvtIuFKO6ZrKvcItdy98dwFI2N1tg3zNIdKaQT+aNdA==} + engines: {node: '>=8.6'} + dependencies: + braces: 3.0.2 + picomatch: 2.3.1 + + /mime-db@1.33.0: + resolution: {integrity: sha512-BHJ/EKruNIqJf/QahvxwQZXKygOQ256myeN/Ew+THcAa5q+PjyTTMMeNQC4DZw5AwfvelsUrA6B67NKMqXDbzQ==} + engines: {node: '>= 0.6'} + dev: false + + /mime-db@1.52.0: + resolution: {integrity: sha512-sPU4uV7dYlvtWJxwwxHD0PuihVNiE7TyAbQ5SWxDCB9mUYvOgroQOwYQQOKPJ8CIbE+1ETVlOoK1UC2nU3gYvg==} + engines: {node: '>= 0.6'} + + /mime-types@2.1.18: + resolution: {integrity: sha512-lc/aahn+t4/SWV/qcmumYjymLsWfN3ELhpmVuUFjgsORruuZPVSwAQryq+HHGvO/SI2KVX26bx+En+zhM8g8hQ==} + engines: {node: '>= 0.6'} + dependencies: + mime-db: 1.33.0 + dev: false + + /mime-types@2.1.35: + resolution: {integrity: sha512-ZDY+bPm5zTTF+YpCrAU9nK0UgICYPT0QtT1NZWFv4s++TNkcgVaT0g6+4R2uI4MjQjzysHB1zxuWL50hzaeXiw==} + engines: {node: '>= 0.6'} + dependencies: + mime-db: 1.52.0 + + /mime@1.6.0: + resolution: {integrity: sha512-x0Vn8spI+wuJ1O6S7gnbaQg8Pxh4NNHb7KSINmEWKiPE4RKOplvijn+NkmYmmRgP68mc70j2EbeTFRsrswaQeg==} + engines: {node: '>=4'} + hasBin: true + dev: false + + /mimic-fn@2.1.0: + resolution: {integrity: sha512-OqbOk5oEQeAZ8WXWydlu9HJjz9WVdEIvamMCcXmuqUYjTknH/sqsWvhQ3vgwKFRR1HpjvNBKQ37nbJgYzGqGcg==} + engines: {node: '>=6'} + dev: false + + /mimic-response@1.0.1: + resolution: {integrity: sha512-j5EctnkH7amfV/q5Hgmoal1g2QHFJRraOtmx0JpIqkxhBhI/lJSl1nMpQ45hVarwNETOoWEimndZ4QK0RHxuxQ==} + engines: {node: '>=4'} + dev: false + + /mini-css-extract-plugin@2.7.6(webpack@5.89.0): + resolution: {integrity: sha512-Qk7HcgaPkGG6eD77mLvZS1nmxlao3j+9PkrT9Uc7HAE1id3F41+DdBRYRYkbyfNRGzm8/YWtzhw7nVPmwhqTQw==} + engines: {node: '>= 12.13.0'} + peerDependencies: + webpack: ^5.0.0 + dependencies: + schema-utils: 4.2.0 + webpack: 5.89.0 + dev: false + + /minimalistic-assert@1.0.1: + resolution: {integrity: sha512-UtJcAD4yEaGtjPezWuO9wC4nwUnVH/8/Im3yEHQP4b67cXlD/Qr9hdITCU1xDbSEXg2XKNaP8jsReV7vQd00/A==} + dev: false + + /minimatch@3.1.2: + resolution: {integrity: sha512-J7p63hRiAjw1NDEww1W7i37+ByIrOWO5XQQAzZ3VOcL0PNybwpfmV/N05zFAzwQ9USyEcX6t3UO+K5aqBQOIHw==} + dependencies: + brace-expansion: 1.1.11 + + /minimist@1.2.8: + resolution: {integrity: sha512-2yyAR8qBkN3YuheJanUpWC5U3bb5osDywNB8RzDVlDwDHbocAJveqqj1u8+SVD7jkWT4yvsHCpWqqWqAxb0zCA==} + dev: false + + /mrmime@1.0.1: + resolution: {integrity: sha512-hzzEagAgDyoU1Q6yg5uI+AorQgdvMCur3FcKf7NhMKWsaYg+RnbTyHRa/9IlLF9rf455MOCtcqqrQQ83pPP7Uw==} + engines: {node: '>=10'} + dev: false + + /ms@2.0.0: + resolution: {integrity: sha512-Tpp60P6IUJDTuOq/5Z8cdskzJujfwqfOTkrwIwj7IRISpnkJnT6SyJ4PCPnGMoFjC9ddhal5KVIYtAt97ix05A==} + dev: false + + /ms@2.1.2: + resolution: {integrity: sha512-sGkPx+VjMtmA6MX27oA4FBFELFCZZ4S4XqeGOXCv68tT+jb3vk/RyaKWP0PTKyWtmLSM0b+adUTEvbs1PEaH2w==} + dev: false + + /ms@2.1.3: + resolution: {integrity: sha512-6FlzubTLZG3J2a/NVCAleEhjzq5oxgHyaCU9yYXvcLsvoVaHJq/s5xXI6/XXP6tz7R9xAOtHnSO/tXtF3WRTlA==} + dev: false + + /multicast-dns@7.2.5: + resolution: {integrity: sha512-2eznPJP8z2BFLX50tf0LuODrpINqP1RVIm/CObbTcBRITQgmC/TjcREF1NeTBzIcR5XO/ukWo+YHOjBbFwIupg==} + hasBin: true + dependencies: + dns-packet: 5.6.1 + thunky: 1.1.0 + dev: false + + /mz@2.7.0: + resolution: {integrity: sha512-z81GNO7nnYMEhrGh9LeymoE4+Yr0Wn5McHIZMK5cfQCl+NDX08sCZgUc9/6MHni9IWuFLm1Z3HTCXu2z9fN62Q==} + dependencies: + any-promise: 1.3.0 + object-assign: 4.1.1 + thenify-all: 1.6.0 + dev: true + + /nanoid@3.3.6: + resolution: {integrity: sha512-BGcqMMJuToF7i1rt+2PWSNVnWIkGCU78jBG3RxO/bZlnZPK2Cmi2QaffxGO/2RvWi9sL+FAiRiXMgsyxQ1DIDA==} + engines: {node: ^10 || ^12 || ^13.7 || ^14 || >=15.0.1} + hasBin: true + + /negotiator@0.6.3: + resolution: {integrity: sha512-+EUsqGPLsM+j/zdChZjsnX51g4XrHFOIXwfnCVPGlQk/k5giakcKsuxCObBRu6DSm9opw/O6slWbJdghQM4bBg==} + engines: {node: '>= 0.6'} + dev: false + + /neo-async@2.6.2: + resolution: {integrity: sha512-Yd3UES5mWCSqR+qNT93S3UoYUkqAZ9lLg8a7g9rimsWmYGK8cVToA4/sF3RrshdyV3sAGMXVUmpMYOw+dLpOuw==} + + /no-case@3.0.4: + resolution: {integrity: sha512-fgAN3jGAh+RoxUGZHTSOLJIqUc2wmoBwGR4tbpNAKmmovFoWq0OdRkb0VkldReO2a2iBT/OEulG9XSUc10r3zg==} + dependencies: + lower-case: 2.0.2 + tslib: 2.6.2 + dev: false + + /node-emoji@1.11.0: + resolution: {integrity: sha512-wo2DpQkQp7Sjm2A0cq+sN7EHKO6Sl0ctXeBdFZrL9T9+UywORbufTcTZxom8YqpLQt/FqNMUkOpkZrJVYSKD3A==} + dependencies: + lodash: 4.17.21 + dev: false + + /node-fetch@2.7.0: + resolution: {integrity: sha512-c4FRfUm/dbcWZ7U+1Wq0AwCyFL+3nt2bEw05wfxSz+DWpWsitgmSgYmy2dQdWyKC1694ELPqMs/YzUSNozLt8A==} + engines: {node: 4.x || >=6.0.0} + peerDependencies: + encoding: ^0.1.0 + peerDependenciesMeta: + encoding: + optional: true + dependencies: + whatwg-url: 5.0.0 + dev: false + + /node-forge@1.3.1: + resolution: {integrity: sha512-dPEtOeMvF9VMcYV/1Wb8CPoVAXtp6MKMlcbAt4ddqmGqUJ6fQZFXkNZNkNlfevtNkGtaSoXf/vNNNSvgrdXwtA==} + engines: {node: '>= 6.13.0'} + dev: false + + /node-releases@2.0.13: + resolution: {integrity: sha512-uYr7J37ae/ORWdZeQ1xxMJe3NtdmqMC/JZK+geofDrkLUApKRHPd18/TxtBOJ4A0/+uUIliorNrfYV6s1b02eQ==} + + /normalize-path@3.0.0: + resolution: {integrity: sha512-6eZs5Ls3WtCisHWp9S2GUy8dqkpGi4BVSz3GaqiE6ezub0512ESztXUwUB6C6IKbQkY2Pnb/mD4WYojCRwcwLA==} + engines: {node: '>=0.10.0'} + + /normalize-range@0.1.2: + resolution: {integrity: sha512-bdok/XvKII3nUpklnV6P2hxtMNrCboOjAcyBuQnWEhO665FwrSNRxU+AqpsyvO6LgGYPspN+lu5CLtw4jPRKNA==} + engines: {node: '>=0.10.0'} + + /normalize-url@4.5.1: + resolution: {integrity: sha512-9UZCFRHQdNrfTpGg8+1INIg93B6zE0aXMVFkw1WFwvO4SlZywU6aLg5Of0Ap/PgcbSw4LNxvMWXMeugwMCX0AA==} + engines: {node: '>=8'} + dev: false + + /normalize-url@6.1.0: + resolution: {integrity: sha512-DlL+XwOy3NxAQ8xuC0okPgK46iuVNAK01YN7RueYBqqFeGsBjV9XmCAzAdgt+667bCl5kPh9EqKKDwnaPG1I7A==} + engines: {node: '>=10'} + dev: false + + /npm-run-path@4.0.1: + resolution: {integrity: sha512-S48WzZW777zhNIrn7gxOlISNAqi9ZC/uQFnRdbeIHhZhCA6UqpkOT8T1G7BvfdgP4Er8gF4sUbaS0i7QvIfCWw==} + engines: {node: '>=8'} + dependencies: + path-key: 3.1.1 + dev: false + + /nprogress@0.2.0: + resolution: {integrity: sha512-I19aIingLgR1fmhftnbWWO3dXc0hSxqHQHQb3H8m+K3TnEn/iSeTZZOyvKXWqQESMwuUVnatlCnZdLBZZt2VSA==} + dev: false + + /nth-check@2.1.1: + resolution: {integrity: sha512-lqjrjmaOoAnWfMmBPL+XNnynZh2+swxiX3WUE0s4yEHI6m+AwrK2UZOimIRl3X/4QctVqS8AiZjFqyOGrMXb/w==} + dependencies: + boolbase: 1.0.0 + dev: false + + /object-assign@4.1.1: + resolution: {integrity: sha512-rJgTQnkUnH1sFw8yT6VSU3zD3sWmu6sZhIseY8VX+GRu3P6F7Fu+JNDoXfklElbLJSnc3FUQHVe4cU5hj+BcUg==} + engines: {node: '>=0.10.0'} + + /object-hash@3.0.0: + resolution: {integrity: sha512-RSn9F68PjH9HqtltsSnqYC1XXoWe9Bju5+213R98cNGttag9q9yAOTzdbsqvIa7aNm5WffBZFpWYr2aWrklWAw==} + engines: {node: '>= 6'} + dev: true + + /object-inspect@1.13.1: + resolution: {integrity: sha512-5qoj1RUiKOMsCCNLV1CBiPYE10sziTsnmNxkAI/rZhiD63CF7IqdFGC/XzjWjpSgLf0LxXX3bDFIh0E18f6UhQ==} + dev: false + + /object-keys@1.1.1: + resolution: {integrity: sha512-NuAESUOUMrlIXOfHKzD6bpPu3tYt3xvjNdRIQ+FeT0lNb4K8WR70CaDxhuNguS2XG+GjkyMwOzsN5ZktImfhLA==} + engines: {node: '>= 0.4'} + dev: false + + /object.assign@4.1.4: + resolution: {integrity: sha512-1mxKf0e58bvyjSCtKYY4sRe9itRk3PJpquJOjeIkz885CczcI4IvJJDLPS72oowuSh+pBxUFROpX+TU++hxhZQ==} + engines: {node: '>= 0.4'} + dependencies: + call-bind: 1.0.5 + define-properties: 1.2.1 + has-symbols: 1.0.3 + object-keys: 1.1.1 + dev: false + + /obuf@1.1.2: + resolution: {integrity: sha512-PX1wu0AmAdPqOL1mWhqmlOd8kOIZQwGZw6rh7uby9fTc5lhaOWFLX3I6R1hrF9k3zUY40e6igsLGkDXK92LJNg==} + dev: false + + /on-finished@2.4.1: + resolution: {integrity: sha512-oVlzkg3ENAhCk2zdv7IJwd/QUD4z2RxRwpkcGY8psCVcCYZNq4wYnVWALHM+brtuJjePWiYF/ClmuDr8Ch5+kg==} + engines: {node: '>= 0.8'} + dependencies: + ee-first: 1.1.1 + dev: false + + /on-headers@1.0.2: + resolution: {integrity: sha512-pZAE+FJLoyITytdqK0U5s+FIpjN0JP3OzFi/u8Rx+EV5/W+JTWGXG8xFzevE7AjBfDqHv/8vL8qQsIhHnqRkrA==} + engines: {node: '>= 0.8'} + dev: false + + /once@1.4.0: + resolution: {integrity: sha512-lNaJgI+2Q5URQBkccEKHTQOPaXdUxnZZElQTZY0MFUAuaEqe1E+Nyvgdz/aIyNi6Z9MzO5dv1H8n58/GELp3+w==} + dependencies: + wrappy: 1.0.2 + + /onetime@5.1.2: + resolution: {integrity: sha512-kbpaSSGJTWdAY5KPVeMOKXSrPtr8C8C7wodJbcsd51jRnmD+GZu8Y0VoU6Dm5Z4vWr0Ig/1NKuWRKf7j5aaYSg==} + engines: {node: '>=6'} + dependencies: + mimic-fn: 2.1.0 + dev: false + + /open@8.4.2: + resolution: {integrity: sha512-7x81NCL719oNbsq/3mh+hVrAWmFuEYUqrq/Iw3kUzH8ReypT9QQ0BLoJS7/G9k6N81XjW4qHWtjWwe/9eLy1EQ==} + engines: {node: '>=12'} + dependencies: + define-lazy-prop: 2.0.0 + is-docker: 2.2.1 + is-wsl: 2.2.0 + dev: false + + /opener@1.5.2: + resolution: {integrity: sha512-ur5UIdyw5Y7yEj9wLzhqXiy6GZ3Mwx0yGI+5sMn2r0N0v3cKJvUmFH5yPP+WXh9e0xfyzyJX95D8l088DNFj7A==} + hasBin: true + dev: false + + /p-cancelable@1.1.0: + resolution: {integrity: sha512-s73XxOZ4zpt1edZYZzvhqFa6uvQc1vwUa0K0BdtIZgQMAJj9IbebH+JkgKZc9h+B05PKHLOTl4ajG1BmNrVZlw==} + engines: {node: '>=6'} + dev: false + + /p-limit@2.3.0: + resolution: {integrity: sha512-//88mFWSJx8lxCzwdAABTJL2MyWB12+eIY7MDL2SqLmAkeKU9qxRvWuSyTjm3FUmpBEMuFfckAIqEaVGUDxb6w==} + engines: {node: '>=6'} + dependencies: + p-try: 2.2.0 + dev: false + + /p-limit@3.1.0: + resolution: {integrity: sha512-TYOanM3wGwNGsZN2cVTYPArw454xnXj5qmWF1bEoAc4+cU/ol7GVh7odevjp1FNHduHc3KZMcFduxU5Xc6uJRQ==} + engines: {node: '>=10'} + dependencies: + yocto-queue: 0.1.0 + dev: false + + /p-locate@3.0.0: + resolution: {integrity: sha512-x+12w/To+4GFfgJhBEpiDcLozRJGegY+Ei7/z0tSLkMmxGZNybVMSfWj9aJn8Z5Fc7dBUNJOOVgPv2H7IwulSQ==} + engines: {node: '>=6'} + dependencies: + p-limit: 2.3.0 + dev: false + + /p-locate@4.1.0: + resolution: {integrity: sha512-R79ZZ/0wAxKGu3oYMlz8jy/kbhsNrS7SKZ7PxEHBgJ5+F2mtFW2fK2cOtBh1cHYkQsbzFV7I+EoRKe6Yt0oK7A==} + engines: {node: '>=8'} + dependencies: + p-limit: 2.3.0 + dev: false + + /p-locate@5.0.0: + resolution: {integrity: sha512-LaNjtRWUBY++zB5nE/NwcaoMylSPk+S+ZHNB1TzdbMJMny6dynpAGt7X/tl/QYq3TIeE6nxHppbo2LGymrG5Pw==} + engines: {node: '>=10'} + dependencies: + p-limit: 3.1.0 + dev: false + + /p-map@4.0.0: + resolution: {integrity: sha512-/bjOqmgETBYB5BoEeGVea8dmvHb2m9GLy1E9W43yeyfP6QQCZGFNa+XRceJEuDB6zqr+gKpIAmlLebMpykw/MQ==} + engines: {node: '>=10'} + dependencies: + aggregate-error: 3.1.0 + dev: false + + /p-retry@4.6.2: + resolution: {integrity: sha512-312Id396EbJdvRONlngUx0NydfrIQ5lsYu0znKVUzVvArzEIt08V1qhtyESbGVd1FGX7UKtiFp5uwKZdM8wIuQ==} + engines: {node: '>=8'} + dependencies: + '@types/retry': 0.12.0 + retry: 0.13.1 + dev: false + + /p-try@2.2.0: + resolution: {integrity: sha512-R4nPAVTAU0B9D35/Gk3uJf/7XYbQcyohSKdvAxIRSNghFl4e71hVoGnBNQz9cWaXxO2I10KTC+3jMdvvoKw6dQ==} + engines: {node: '>=6'} + dev: false + + /package-json@6.5.0: + resolution: {integrity: sha512-k3bdm2n25tkyxcjSKzB5x8kfVxlMdgsbPr0GkZcwHsLpba6cBjqCt1KlcChKEvxHIcTB1FVMuwoijZ26xex5MQ==} + engines: {node: '>=8'} + dependencies: + got: 9.6.0 + registry-auth-token: 4.2.2 + registry-url: 5.1.0 + semver: 6.3.1 + dev: false + + /param-case@3.0.4: + resolution: {integrity: sha512-RXlj7zCYokReqWpOPH9oYivUzLYZ5vAPIfEmCTNViosC78F8F0H9y7T7gG2M39ymgutxF5gcFEsyZQSph9Bp3A==} + dependencies: + dot-case: 3.0.4 + tslib: 2.6.2 + dev: false + + /parent-module@1.0.1: + resolution: {integrity: sha512-GQ2EWRpQV8/o+Aw8YqtfZZPfNRWZYkbidE9k5rpl/hC3vtHHBfGm2Ifi6qWV+coDGkrUKZAxE3Lot5kcsRlh+g==} + engines: {node: '>=6'} + dependencies: + callsites: 3.1.0 + dev: false + + /parse-entities@2.0.0: + resolution: {integrity: sha512-kkywGpCcRYhqQIchaWqZ875wzpS/bMKhz5HnN3p7wveJTkTtyAB/AlnS0f8DFSqYW1T82t6yEAkEcB+A1I3MbQ==} + dependencies: + character-entities: 1.2.4 + character-entities-legacy: 1.1.4 + character-reference-invalid: 1.1.4 + is-alphanumerical: 1.0.4 + is-decimal: 1.0.4 + is-hexadecimal: 1.0.4 + dev: false + + /parse-json@5.2.0: + resolution: {integrity: sha512-ayCKvm/phCGxOkYRSCM82iDwct8/EonSEgCSxWxD7ve6jHggsFl4fZVQBPRNgQoKiuV/odhFrGzQXZwbifC8Rg==} + engines: {node: '>=8'} + dependencies: + '@babel/code-frame': 7.22.13 + error-ex: 1.3.2 + json-parse-even-better-errors: 2.3.1 + lines-and-columns: 1.2.4 + dev: false + + /parse-numeric-range@1.3.0: + resolution: {integrity: sha512-twN+njEipszzlMJd4ONUYgSfZPDxgHhT9Ahed5uTigpQn90FggW4SA/AIPq/6a149fTbE9qBEcSwE3FAEp6wQQ==} + dev: false + + /parse5-htmlparser2-tree-adapter@7.0.0: + resolution: {integrity: sha512-B77tOZrqqfUfnVcOrUvfdLbz4pu4RopLD/4vmu3HUPswwTA8OH0EMW9BlWR2B0RCoiZRAHEUu7IxeP1Pd1UU+g==} + dependencies: + domhandler: 5.0.3 + parse5: 7.1.2 + dev: false + + /parse5@6.0.1: + resolution: {integrity: sha512-Ofn/CTFzRGTTxwpNEs9PP93gXShHcTq255nzRYSKe8AkVpZY7e1fpmTfOyoIvjP5HG7Z2ZM7VS9PPhQGW2pOpw==} + dev: false + + /parse5@7.1.2: + resolution: {integrity: sha512-Czj1WaSVpaoj0wbhMzLmWD69anp2WH7FXMB9n1Sy8/ZFF9jolSQVMu1Ij5WIyGmcBmhk7EOndpO4mIpihVqAXw==} + dependencies: + entities: 4.5.0 + dev: false + + /parseurl@1.3.3: + resolution: {integrity: sha512-CiyeOxFT/JZyN5m0z9PfXw4SCBJ6Sygz1Dpl0wqjlhDEGGBP1GnsUVEL0p63hoG1fcj3fHynXi9NYO4nWOL+qQ==} + engines: {node: '>= 0.8'} + dev: false + + /pascal-case@3.1.2: + resolution: {integrity: sha512-uWlGT3YSnK9x3BQJaOdcZwrnV6hPpd8jFH1/ucpiLRPh/2zCVJKS19E4GvYHvaCcACn3foXZ0cLB9Wrx1KGe5g==} + dependencies: + no-case: 3.0.4 + tslib: 2.6.2 + dev: false + + /path-exists@3.0.0: + resolution: {integrity: sha512-bpC7GYwiDYQ4wYLe+FA8lhRjhQCMcQGuSgGGqDkg/QerRWw9CmGRT0iSOVRSZJ29NMLZgIzqaljJ63oaL4NIJQ==} + engines: {node: '>=4'} + dev: false + + /path-exists@4.0.0: + resolution: {integrity: sha512-ak9Qy5Q7jYb2Wwcey5Fpvg2KoAc/ZIhLSLOSBmRmygPsGwkVVt0fZa0qrtMz+m6tJTAHfZQ8FnmB4MG4LWy7/w==} + engines: {node: '>=8'} + dev: false + + /path-is-absolute@1.0.1: + resolution: {integrity: sha512-AVbw3UJ2e9bq64vSaS9Am0fje1Pa8pbGqTTsmXfaIiMpnr5DlDhfJOuLj9Sf95ZPVDAUerDfEk88MPmPe7UCQg==} + engines: {node: '>=0.10.0'} + + /path-is-inside@1.0.2: + resolution: {integrity: sha512-DUWJr3+ULp4zXmol/SZkFf3JGsS9/SIv+Y3Rt93/UjPpDpklB5f1er4O3POIbUuUJ3FXgqte2Q7SrU6zAqwk8w==} + dev: false + + /path-key@3.1.1: + resolution: {integrity: sha512-ojmeN0qd+y0jszEtoY48r0Peq5dwMEkIlCOu6Q5f41lfkswXuKtYrhgoTpLnyIcHm24Uhqx+5Tqm2InSwLhE6Q==} + engines: {node: '>=8'} + dev: false + + /path-parse@1.0.7: + resolution: {integrity: sha512-LDJzPVEEEPR+y48z93A0Ed0yXb8pAByGWo/k5YYdYgpY2/2EsOsksJrq7lOHxryrVOn1ejG6oAp8ahvOIQD8sw==} + + /path-to-regexp@0.1.7: + resolution: {integrity: sha512-5DFkuoqlv1uYQKxy8omFBeJPQcdoE07Kv2sferDCrAq1ohOU+MSDswDIbnx3YAM60qIOnYa53wBhXW0EbMonrQ==} + dev: false + + /path-to-regexp@1.8.0: + resolution: {integrity: sha512-n43JRhlUKUAlibEJhPeir1ncUID16QnEjNpwzNdO3Lm4ywrBpBZ5oLD0I6br9evr1Y9JTqwRtAh7JLoOzAQdVA==} + dependencies: + isarray: 0.0.1 + dev: false + + /path-to-regexp@2.2.1: + resolution: {integrity: sha512-gu9bD6Ta5bwGrrU8muHzVOBFFREpp2iRkVfhBJahwJ6p6Xw20SjT0MxLnwkjOibQmGSYhiUnf2FLe7k+jcFmGQ==} + dev: false + + /path-type@4.0.0: + resolution: {integrity: sha512-gDKb8aZMDeD/tZWs9P6+q0J9Mwkdl6xMV8TjnGP3qJVJ06bdMgkbBlLU8IdfOsIsFz2BW1rNVT3XuNEl8zPAvw==} + engines: {node: '>=8'} + dev: false + + /picocolors@1.0.0: + resolution: {integrity: sha512-1fygroTLlHu66zi26VoTDv8yRgm0Fccecssto+MhsZ0D/DGW2sm8E8AjW7NU5VVTRt5GxbeZ5qBuJr+HyLYkjQ==} + + /picomatch@2.3.1: + resolution: {integrity: sha512-JU3teHTNjmE2VCGFzuY8EXzCDVwEqB2a8fsIvwaStHhAWJEeVd1o1QD80CU6+ZdEXXSLbSsuLwJjkCBWqRQUVA==} + engines: {node: '>=8.6'} + + /pify@2.3.0: + resolution: {integrity: sha512-udgsAY+fTnvv7kI7aaxbqwWNb0AHiB0qBO89PZKPkoTmGOgdbrHDKD+0B2X4uTfJ/FT1R09r9gTsjUjNJotuog==} + engines: {node: '>=0.10.0'} + dev: true + + /pirates@4.0.6: + resolution: {integrity: sha512-saLsH7WeYYPiD25LDuLRRY/i+6HaPYr6G1OUlN39otzkSTxKnubR9RTxS3/Kk50s1g2JTgFwWQDQyplC5/SHZg==} + engines: {node: '>= 6'} + dev: true + + /pkg-dir@4.2.0: + resolution: {integrity: sha512-HRDzbaKjC+AOWVXxAU/x54COGeIv9eb+6CkDSQoNTt4XyWoIJvuPsXizxu/Fr23EiekbtZwmh1IcIG/l/a10GQ==} + engines: {node: '>=8'} + dependencies: + find-up: 4.1.0 + dev: false + + /pkg-up@3.1.0: + resolution: {integrity: sha512-nDywThFk1i4BQK4twPQ6TA4RT8bDY96yeuCVBWL3ePARCiEKDRSrNGbFIgUJpLp+XeIR65v8ra7WuJOFUBtkMA==} + engines: {node: '>=8'} + dependencies: + find-up: 3.0.0 + dev: false + + /postcss-calc@8.2.4(postcss@8.4.31): + resolution: {integrity: sha512-SmWMSJmB8MRnnULldx0lQIyhSNvuDl9HfrZkaqqE/WHAhToYsAvDq+yAsA/kIyINDszOp3Rh0GFoNuH5Ypsm3Q==} + peerDependencies: + postcss: ^8.2.2 + dependencies: + postcss: 8.4.31 + postcss-selector-parser: 6.0.13 + postcss-value-parser: 4.2.0 + dev: false + + /postcss-colormin@5.3.1(postcss@8.4.31): + resolution: {integrity: sha512-UsWQG0AqTFQmpBegeLLc1+c3jIqBNB0zlDGRWR+dQ3pRKJL1oeMzyqmH3o2PIfn9MBdNrVPWhDbT769LxCTLJQ==} + engines: {node: ^10 || ^12 || >=14.0} + peerDependencies: + postcss: ^8.2.15 + dependencies: + browserslist: 4.22.1 + caniuse-api: 3.0.0 + colord: 2.9.3 + postcss: 8.4.31 + postcss-value-parser: 4.2.0 + dev: false + + /postcss-convert-values@5.1.3(postcss@8.4.31): + resolution: {integrity: sha512-82pC1xkJZtcJEfiLw6UXnXVXScgtBrjlO5CBmuDQc+dlb88ZYheFsjTn40+zBVi3DkfF7iezO0nJUPLcJK3pvA==} + engines: {node: ^10 || ^12 || >=14.0} + peerDependencies: + postcss: ^8.2.15 + dependencies: + browserslist: 4.22.1 + postcss: 8.4.31 + postcss-value-parser: 4.2.0 + dev: false + + /postcss-discard-comments@5.1.2(postcss@8.4.31): + resolution: {integrity: sha512-+L8208OVbHVF2UQf1iDmRcbdjJkuBF6IS29yBDSiWUIzpYaAhtNl6JYnYm12FnkeCwQqF5LeklOu6rAqgfBZqQ==} + engines: {node: ^10 || ^12 || >=14.0} + peerDependencies: + postcss: ^8.2.15 + dependencies: + postcss: 8.4.31 + dev: false + + /postcss-discard-duplicates@5.1.0(postcss@8.4.31): + resolution: {integrity: sha512-zmX3IoSI2aoenxHV6C7plngHWWhUOV3sP1T8y2ifzxzbtnuhk1EdPwm0S1bIUNaJ2eNbWeGLEwzw8huPD67aQw==} + engines: {node: ^10 || ^12 || >=14.0} + peerDependencies: + postcss: ^8.2.15 + dependencies: + postcss: 8.4.31 + dev: false + + /postcss-discard-empty@5.1.1(postcss@8.4.31): + resolution: {integrity: sha512-zPz4WljiSuLWsI0ir4Mcnr4qQQ5e1Ukc3i7UfE2XcrwKK2LIPIqE5jxMRxO6GbI3cv//ztXDsXwEWT3BHOGh3A==} + engines: {node: ^10 || ^12 || >=14.0} + peerDependencies: + postcss: ^8.2.15 + dependencies: + postcss: 8.4.31 + dev: false + + /postcss-discard-overridden@5.1.0(postcss@8.4.31): + resolution: {integrity: sha512-21nOL7RqWR1kasIVdKs8HNqQJhFxLsyRfAnUDm4Fe4t4mCWL9OJiHvlHPjcd8zc5Myu89b/7wZDnOSjFgeWRtw==} + engines: {node: ^10 || ^12 || >=14.0} + peerDependencies: + postcss: ^8.2.15 + dependencies: + postcss: 8.4.31 + dev: false + + /postcss-discard-unused@5.1.0(postcss@8.4.31): + resolution: {integrity: sha512-KwLWymI9hbwXmJa0dkrzpRbSJEh0vVUd7r8t0yOGPcfKzyJJxFM8kLyC5Ev9avji6nY95pOp1W6HqIrfT+0VGw==} + engines: {node: ^10 || ^12 || >=14.0} + peerDependencies: + postcss: ^8.2.15 + dependencies: + postcss: 8.4.31 + postcss-selector-parser: 6.0.13 + dev: false + + /postcss-import@15.1.0(postcss@8.4.31): + resolution: {integrity: sha512-hpr+J05B2FVYUAXHeK1YyI267J/dDDhMU6B6civm8hSY1jYJnBXxzKDKDswzJmtLHryrjhnDjqqp/49t8FALew==} + engines: {node: '>=14.0.0'} + peerDependencies: + postcss: ^8.0.0 + dependencies: + postcss: 8.4.31 + postcss-value-parser: 4.2.0 + read-cache: 1.0.0 + resolve: 1.22.8 + dev: true + + /postcss-js@4.0.1(postcss@8.4.31): + resolution: {integrity: sha512-dDLF8pEO191hJMtlHFPRa8xsizHaM82MLfNkUHdUtVEV3tgTp5oj+8qbEqYM57SLfc74KSbw//4SeJma2LRVIw==} + engines: {node: ^12 || ^14 || >= 16} + peerDependencies: + postcss: ^8.4.21 + dependencies: + camelcase-css: 2.0.1 + postcss: 8.4.31 + dev: true + + /postcss-load-config@4.0.1(postcss@8.4.31): + resolution: {integrity: sha512-vEJIc8RdiBRu3oRAI0ymerOn+7rPuMvRXslTvZUKZonDHFIczxztIyJ1urxM1x9JXEikvpWWTUUqal5j/8QgvA==} + engines: {node: '>= 14'} + peerDependencies: + postcss: '>=8.0.9' + ts-node: '>=9.0.0' + peerDependenciesMeta: + postcss: + optional: true + ts-node: + optional: true + dependencies: + lilconfig: 2.1.0 + postcss: 8.4.31 + yaml: 2.3.3 + dev: true + + /postcss-loader@7.3.3(postcss@8.4.31)(typescript@4.9.5)(webpack@5.89.0): + resolution: {integrity: sha512-YgO/yhtevGO/vJePCQmTxiaEwER94LABZN0ZMT4A0vsak9TpO+RvKRs7EmJ8peIlB9xfXCsS7M8LjqncsUZ5HA==} + engines: {node: '>= 14.15.0'} + peerDependencies: + postcss: ^7.0.0 || ^8.0.1 + webpack: ^5.0.0 + dependencies: + cosmiconfig: 8.3.6(typescript@4.9.5) + jiti: 1.20.0 + postcss: 8.4.31 + semver: 7.5.4 + webpack: 5.89.0 + transitivePeerDependencies: + - typescript + dev: false + + /postcss-merge-idents@5.1.1(postcss@8.4.31): + resolution: {integrity: sha512-pCijL1TREiCoog5nQp7wUe+TUonA2tC2sQ54UGeMmryK3UFGIYKqDyjnqd6RcuI4znFn9hWSLNN8xKE/vWcUQw==} + engines: {node: ^10 || ^12 || >=14.0} + peerDependencies: + postcss: ^8.2.15 + dependencies: + cssnano-utils: 3.1.0(postcss@8.4.31) + postcss: 8.4.31 + postcss-value-parser: 4.2.0 + dev: false + + /postcss-merge-longhand@5.1.7(postcss@8.4.31): + resolution: {integrity: sha512-YCI9gZB+PLNskrK0BB3/2OzPnGhPkBEwmwhfYk1ilBHYVAZB7/tkTHFBAnCrvBBOmeYyMYw3DMjT55SyxMBzjQ==} + engines: {node: ^10 || ^12 || >=14.0} + peerDependencies: + postcss: ^8.2.15 + dependencies: + postcss: 8.4.31 + postcss-value-parser: 4.2.0 + stylehacks: 5.1.1(postcss@8.4.31) + dev: false + + /postcss-merge-rules@5.1.4(postcss@8.4.31): + resolution: {integrity: sha512-0R2IuYpgU93y9lhVbO/OylTtKMVcHb67zjWIfCiKR9rWL3GUk1677LAqD/BcHizukdZEjT8Ru3oHRoAYoJy44g==} + engines: {node: ^10 || ^12 || >=14.0} + peerDependencies: + postcss: ^8.2.15 + dependencies: + browserslist: 4.22.1 + caniuse-api: 3.0.0 + cssnano-utils: 3.1.0(postcss@8.4.31) + postcss: 8.4.31 + postcss-selector-parser: 6.0.13 + dev: false + + /postcss-minify-font-values@5.1.0(postcss@8.4.31): + resolution: {integrity: sha512-el3mYTgx13ZAPPirSVsHqFzl+BBBDrXvbySvPGFnQcTI4iNslrPaFq4muTkLZmKlGk4gyFAYUBMH30+HurREyA==} + engines: {node: ^10 || ^12 || >=14.0} + peerDependencies: + postcss: ^8.2.15 + dependencies: + postcss: 8.4.31 + postcss-value-parser: 4.2.0 + dev: false + + /postcss-minify-gradients@5.1.1(postcss@8.4.31): + resolution: {integrity: sha512-VGvXMTpCEo4qHTNSa9A0a3D+dxGFZCYwR6Jokk+/3oB6flu2/PnPXAh2x7x52EkY5xlIHLm+Le8tJxe/7TNhzw==} + engines: {node: ^10 || ^12 || >=14.0} + peerDependencies: + postcss: ^8.2.15 + dependencies: + colord: 2.9.3 + cssnano-utils: 3.1.0(postcss@8.4.31) + postcss: 8.4.31 + postcss-value-parser: 4.2.0 + dev: false + + /postcss-minify-params@5.1.4(postcss@8.4.31): + resolution: {integrity: sha512-+mePA3MgdmVmv6g+30rn57USjOGSAyuxUmkfiWpzalZ8aiBkdPYjXWtHuwJGm1v5Ojy0Z0LaSYhHaLJQB0P8Jw==} + engines: {node: ^10 || ^12 || >=14.0} + peerDependencies: + postcss: ^8.2.15 + dependencies: + browserslist: 4.22.1 + cssnano-utils: 3.1.0(postcss@8.4.31) + postcss: 8.4.31 + postcss-value-parser: 4.2.0 + dev: false + + /postcss-minify-selectors@5.2.1(postcss@8.4.31): + resolution: {integrity: sha512-nPJu7OjZJTsVUmPdm2TcaiohIwxP+v8ha9NehQ2ye9szv4orirRU3SDdtUmKH+10nzn0bAyOXZ0UEr7OpvLehg==} + engines: {node: ^10 || ^12 || >=14.0} + peerDependencies: + postcss: ^8.2.15 + dependencies: + postcss: 8.4.31 + postcss-selector-parser: 6.0.13 + dev: false + + /postcss-modules-extract-imports@3.0.0(postcss@8.4.31): + resolution: {integrity: sha512-bdHleFnP3kZ4NYDhuGlVK+CMrQ/pqUm8bx/oGL93K6gVwiclvX5x0n76fYMKuIGKzlABOy13zsvqjb0f92TEXw==} + engines: {node: ^10 || ^12 || >= 14} + peerDependencies: + postcss: ^8.1.0 + dependencies: + postcss: 8.4.31 + dev: false + + /postcss-modules-local-by-default@4.0.3(postcss@8.4.31): + resolution: {integrity: sha512-2/u2zraspoACtrbFRnTijMiQtb4GW4BvatjaG/bCjYQo8kLTdevCUlwuBHx2sCnSyrI3x3qj4ZK1j5LQBgzmwA==} + engines: {node: ^10 || ^12 || >= 14} + peerDependencies: + postcss: ^8.1.0 + dependencies: + icss-utils: 5.1.0(postcss@8.4.31) + postcss: 8.4.31 + postcss-selector-parser: 6.0.13 + postcss-value-parser: 4.2.0 + dev: false + + /postcss-modules-scope@3.0.0(postcss@8.4.31): + resolution: {integrity: sha512-hncihwFA2yPath8oZ15PZqvWGkWf+XUfQgUGamS4LqoP1anQLOsOJw0vr7J7IwLpoY9fatA2qiGUGmuZL0Iqlg==} + engines: {node: ^10 || ^12 || >= 14} + peerDependencies: + postcss: ^8.1.0 + dependencies: + postcss: 8.4.31 + postcss-selector-parser: 6.0.13 + dev: false + + /postcss-modules-values@4.0.0(postcss@8.4.31): + resolution: {integrity: sha512-RDxHkAiEGI78gS2ofyvCsu7iycRv7oqw5xMWn9iMoR0N/7mf9D50ecQqUo5BZ9Zh2vH4bCUR/ktCqbB9m8vJjQ==} + engines: {node: ^10 || ^12 || >= 14} + peerDependencies: + postcss: ^8.1.0 + dependencies: + icss-utils: 5.1.0(postcss@8.4.31) + postcss: 8.4.31 + dev: false + + /postcss-nested@6.0.1(postcss@8.4.31): + resolution: {integrity: sha512-mEp4xPMi5bSWiMbsgoPfcP74lsWLHkQbZc3sY+jWYd65CUwXrUaTp0fmNpa01ZcETKlIgUdFN/MpS2xZtqL9dQ==} + engines: {node: '>=12.0'} + peerDependencies: + postcss: ^8.2.14 + dependencies: + postcss: 8.4.31 + postcss-selector-parser: 6.0.13 + dev: true + + /postcss-normalize-charset@5.1.0(postcss@8.4.31): + resolution: {integrity: sha512-mSgUJ+pd/ldRGVx26p2wz9dNZ7ji6Pn8VWBajMXFf8jk7vUoSrZ2lt/wZR7DtlZYKesmZI680qjr2CeFF2fbUg==} + engines: {node: ^10 || ^12 || >=14.0} + peerDependencies: + postcss: ^8.2.15 + dependencies: + postcss: 8.4.31 + dev: false + + /postcss-normalize-display-values@5.1.0(postcss@8.4.31): + resolution: {integrity: sha512-WP4KIM4o2dazQXWmFaqMmcvsKmhdINFblgSeRgn8BJ6vxaMyaJkwAzpPpuvSIoG/rmX3M+IrRZEz2H0glrQNEA==} + engines: {node: ^10 || ^12 || >=14.0} + peerDependencies: + postcss: ^8.2.15 + dependencies: + postcss: 8.4.31 + postcss-value-parser: 4.2.0 + dev: false + + /postcss-normalize-positions@5.1.1(postcss@8.4.31): + resolution: {integrity: sha512-6UpCb0G4eofTCQLFVuI3EVNZzBNPiIKcA1AKVka+31fTVySphr3VUgAIULBhxZkKgwLImhzMR2Bw1ORK+37INg==} + engines: {node: ^10 || ^12 || >=14.0} + peerDependencies: + postcss: ^8.2.15 + dependencies: + postcss: 8.4.31 + postcss-value-parser: 4.2.0 + dev: false + + /postcss-normalize-repeat-style@5.1.1(postcss@8.4.31): + resolution: {integrity: sha512-mFpLspGWkQtBcWIRFLmewo8aC3ImN2i/J3v8YCFUwDnPu3Xz4rLohDO26lGjwNsQxB3YF0KKRwspGzE2JEuS0g==} + engines: {node: ^10 || ^12 || >=14.0} + peerDependencies: + postcss: ^8.2.15 + dependencies: + postcss: 8.4.31 + postcss-value-parser: 4.2.0 + dev: false + + /postcss-normalize-string@5.1.0(postcss@8.4.31): + resolution: {integrity: sha512-oYiIJOf4T9T1N4i+abeIc7Vgm/xPCGih4bZz5Nm0/ARVJ7K6xrDlLwvwqOydvyL3RHNf8qZk6vo3aatiw/go3w==} + engines: {node: ^10 || ^12 || >=14.0} + peerDependencies: + postcss: ^8.2.15 + dependencies: + postcss: 8.4.31 + postcss-value-parser: 4.2.0 + dev: false + + /postcss-normalize-timing-functions@5.1.0(postcss@8.4.31): + resolution: {integrity: sha512-DOEkzJ4SAXv5xkHl0Wa9cZLF3WCBhF3o1SKVxKQAa+0pYKlueTpCgvkFAHfk+Y64ezX9+nITGrDZeVGgITJXjg==} + engines: {node: ^10 || ^12 || >=14.0} + peerDependencies: + postcss: ^8.2.15 + dependencies: + postcss: 8.4.31 + postcss-value-parser: 4.2.0 + dev: false + + /postcss-normalize-unicode@5.1.1(postcss@8.4.31): + resolution: {integrity: sha512-qnCL5jzkNUmKVhZoENp1mJiGNPcsJCs1aaRmURmeJGES23Z/ajaln+EPTD+rBeNkSryI+2WTdW+lwcVdOikrpA==} + engines: {node: ^10 || ^12 || >=14.0} + peerDependencies: + postcss: ^8.2.15 + dependencies: + browserslist: 4.22.1 + postcss: 8.4.31 + postcss-value-parser: 4.2.0 + dev: false + + /postcss-normalize-url@5.1.0(postcss@8.4.31): + resolution: {integrity: sha512-5upGeDO+PVthOxSmds43ZeMeZfKH+/DKgGRD7TElkkyS46JXAUhMzIKiCa7BabPeIy3AQcTkXwVVN7DbqsiCew==} + engines: {node: ^10 || ^12 || >=14.0} + peerDependencies: + postcss: ^8.2.15 + dependencies: + normalize-url: 6.1.0 + postcss: 8.4.31 + postcss-value-parser: 4.2.0 + dev: false + + /postcss-normalize-whitespace@5.1.1(postcss@8.4.31): + resolution: {integrity: sha512-83ZJ4t3NUDETIHTa3uEg6asWjSBYL5EdkVB0sDncx9ERzOKBVJIUeDO9RyA9Zwtig8El1d79HBp0JEi8wvGQnA==} + engines: {node: ^10 || ^12 || >=14.0} + peerDependencies: + postcss: ^8.2.15 + dependencies: + postcss: 8.4.31 + postcss-value-parser: 4.2.0 + dev: false + + /postcss-ordered-values@5.1.3(postcss@8.4.31): + resolution: {integrity: sha512-9UO79VUhPwEkzbb3RNpqqghc6lcYej1aveQteWY+4POIwlqkYE21HKWaLDF6lWNuqCobEAyTovVhtI32Rbv2RQ==} + engines: {node: ^10 || ^12 || >=14.0} + peerDependencies: + postcss: ^8.2.15 + dependencies: + cssnano-utils: 3.1.0(postcss@8.4.31) + postcss: 8.4.31 + postcss-value-parser: 4.2.0 + dev: false + + /postcss-reduce-idents@5.2.0(postcss@8.4.31): + resolution: {integrity: sha512-BTrLjICoSB6gxbc58D5mdBK8OhXRDqud/zodYfdSi52qvDHdMwk+9kB9xsM8yJThH/sZU5A6QVSmMmaN001gIg==} + engines: {node: ^10 || ^12 || >=14.0} + peerDependencies: + postcss: ^8.2.15 + dependencies: + postcss: 8.4.31 + postcss-value-parser: 4.2.0 + dev: false + + /postcss-reduce-initial@5.1.2(postcss@8.4.31): + resolution: {integrity: sha512-dE/y2XRaqAi6OvjzD22pjTUQ8eOfc6m/natGHgKFBK9DxFmIm69YmaRVQrGgFlEfc1HePIurY0TmDeROK05rIg==} + engines: {node: ^10 || ^12 || >=14.0} + peerDependencies: + postcss: ^8.2.15 + dependencies: + browserslist: 4.22.1 + caniuse-api: 3.0.0 + postcss: 8.4.31 + dev: false + + /postcss-reduce-transforms@5.1.0(postcss@8.4.31): + resolution: {integrity: sha512-2fbdbmgir5AvpW9RLtdONx1QoYG2/EtqpNQbFASDlixBbAYuTcJ0dECwlqNqH7VbaUnEnh8SrxOe2sRIn24XyQ==} + engines: {node: ^10 || ^12 || >=14.0} + peerDependencies: + postcss: ^8.2.15 + dependencies: + postcss: 8.4.31 + postcss-value-parser: 4.2.0 + dev: false + + /postcss-selector-parser@6.0.10: + resolution: {integrity: sha512-IQ7TZdoaqbT+LCpShg46jnZVlhWD2w6iQYAcYXfHARZ7X1t/UGhhceQDs5X0cGqKvYlHNOuv7Oa1xmb0oQuA3w==} + engines: {node: '>=4'} + dependencies: + cssesc: 3.0.0 + util-deprecate: 1.0.2 + dev: true + + /postcss-selector-parser@6.0.13: + resolution: {integrity: sha512-EaV1Gl4mUEV4ddhDnv/xtj7sxwrwxdetHdWUGnT4VJQf+4d05v6lHYZr8N573k5Z0BViss7BDhfWtKS3+sfAqQ==} + engines: {node: '>=4'} + dependencies: + cssesc: 3.0.0 + util-deprecate: 1.0.2 + + /postcss-sort-media-queries@4.4.1(postcss@8.4.31): + resolution: {integrity: sha512-QDESFzDDGKgpiIh4GYXsSy6sek2yAwQx1JASl5AxBtU1Lq2JfKBljIPNdil989NcSKRQX1ToiaKphImtBuhXWw==} + engines: {node: '>=10.0.0'} + peerDependencies: + postcss: ^8.4.16 + dependencies: + postcss: 8.4.31 + sort-css-media-queries: 2.1.0 + dev: false + + /postcss-svgo@5.1.0(postcss@8.4.31): + resolution: {integrity: sha512-D75KsH1zm5ZrHyxPakAxJWtkyXew5qwS70v56exwvw542d9CRtTo78K0WeFxZB4G7JXKKMbEZtZayTGdIky/eA==} + engines: {node: ^10 || ^12 || >=14.0} + peerDependencies: + postcss: ^8.2.15 + dependencies: + postcss: 8.4.31 + postcss-value-parser: 4.2.0 + svgo: 2.8.0 + dev: false + + /postcss-unique-selectors@5.1.1(postcss@8.4.31): + resolution: {integrity: sha512-5JiODlELrz8L2HwxfPnhOWZYWDxVHWL83ufOv84NrcgipI7TaeRsatAhK4Tr2/ZiYldpK/wBvw5BD3qfaK96GA==} + engines: {node: ^10 || ^12 || >=14.0} + peerDependencies: + postcss: ^8.2.15 + dependencies: + postcss: 8.4.31 + postcss-selector-parser: 6.0.13 + dev: false + + /postcss-value-parser@4.2.0: + resolution: {integrity: sha512-1NNCs6uurfkVbeXG4S8JFT9t19m45ICnif8zWLd5oPSZ50QnwMfK+H3jv408d4jw/7Bttv5axS5IiHoLaVNHeQ==} + + /postcss-zindex@5.1.0(postcss@8.4.31): + resolution: {integrity: sha512-fgFMf0OtVSBR1va1JNHYgMxYk73yhn/qb4uQDq1DLGYolz8gHCyr/sesEuGUaYs58E3ZJRcpoGuPVoB7Meiq9A==} + engines: {node: ^10 || ^12 || >=14.0} + peerDependencies: + postcss: ^8.2.15 + dependencies: + postcss: 8.4.31 + dev: false + + /postcss@8.4.31: + resolution: {integrity: sha512-PS08Iboia9mts/2ygV3eLpY5ghnUcfLV/EXTOW1E2qYxJKGGBUtNjN76FYHnMs36RmARn41bC0AZmn+rR0OVpQ==} + engines: {node: ^10 || ^12 || >=14} + dependencies: + nanoid: 3.3.6 + picocolors: 1.0.0 + source-map-js: 1.0.2 + + /posthog-js@1.87.2: + resolution: {integrity: sha512-pdxEylfxwEDwwz7g5dunPucvAN51RAOWWQmkcqHsLNHlV5o5bTaTwcAXaWB1IUn3xKPuKYE2lqbdB3vC4H4rFQ==} + dependencies: + fflate: 0.4.8 + dev: false + + /prepend-http@2.0.0: + resolution: {integrity: sha512-ravE6m9Atw9Z/jjttRUZ+clIXogdghyZAuWJ3qEzjT+jI/dL1ifAqhZeC5VHzQp1MSt1+jxKkFNemj/iO7tVUA==} + engines: {node: '>=4'} + dev: false + + /pretty-error@4.0.0: + resolution: {integrity: sha512-AoJ5YMAcXKYxKhuJGdcvse+Voc6v1RgnsR3nWcYU7q4t6z0Q6T86sv5Zq8VIRbOWWFpvdGE83LtdSMNd+6Y0xw==} + dependencies: + lodash: 4.17.21 + renderkid: 3.0.0 + dev: false + + /pretty-time@1.1.0: + resolution: {integrity: sha512-28iF6xPQrP8Oa6uxE6a1biz+lWeTOAPKggvjB8HAs6nVMKZwf5bG++632Dx614hIWgUPkgivRfG+a8uAXGTIbA==} + engines: {node: '>=4'} + dev: false + + /prism-react-renderer@1.3.5(react@17.0.2): + resolution: {integrity: sha512-IJ+MSwBWKG+SM3b2SUfdrhC+gu01QkV2KmRQgREThBfSQRoufqRfxfHUxpG1WcaFjP+kojcFyO9Qqtpgt3qLCg==} + peerDependencies: + react: '>=0.14.9' + dependencies: + react: 17.0.2 + dev: false + + /prismjs@1.29.0: + resolution: {integrity: sha512-Kx/1w86q/epKcmte75LNrEoT+lX8pBpavuAbvJWRXar7Hz8jrtF+e3vY751p0R8H9HdArwaCTNDDzHg/ScJK1Q==} + engines: {node: '>=6'} + dev: false + + /process-nextick-args@2.0.1: + resolution: {integrity: sha512-3ouUOpQhtgrbOa17J7+uxOTpITYWaGP7/AhoR3+A+/1e9skrzelGi/dXzEYyvbxubEF6Wn2ypscTKiKJFFn1ag==} + dev: false + + /promise@7.3.1: + resolution: {integrity: sha512-nolQXZ/4L+bP/UGlkfaIujX9BKxGwmQ9OT4mOt5yvy8iK1h3wqTEJCijzGANTCCl9nWjY41juyAn2K3Q1hLLTg==} + dependencies: + asap: 2.0.6 + dev: false + + /prompts@2.4.2: + resolution: {integrity: sha512-NxNv/kLguCA7p3jE8oL2aEBsrJWgAakBpgmgK6lpPWV+WuOmY6r2/zbAVnP+T8bQlA0nzHXSJSJW0Hq7ylaD2Q==} + engines: {node: '>= 6'} + dependencies: + kleur: 3.0.3 + sisteransi: 1.0.5 + dev: false + + /prop-types@15.8.1: + resolution: {integrity: sha512-oj87CgZICdulUohogVAR7AjlC0327U4el4L6eAvOqCeudMDVU0NThNaV+b9Df4dXgSP1gXMTnPdhfe/2qDH5cg==} + dependencies: + loose-envify: 1.4.0 + object-assign: 4.1.1 + react-is: 16.13.1 + + /property-information@5.6.0: + resolution: {integrity: sha512-YUHSPk+A30YPv+0Qf8i9Mbfe/C0hdPXk1s1jPVToV8pk8BQtpw10ct89Eo7OWkutrwqvT0eicAxlOg3dOAu8JA==} + dependencies: + xtend: 4.0.2 + dev: false + + /proxy-addr@2.0.7: + resolution: {integrity: sha512-llQsMLSUDUPT44jdrU/O37qlnifitDP+ZwrmmZcoSKyLKvtZxpyV0n2/bD/N4tBAAZ/gJEdZU7KMraoK1+XYAg==} + engines: {node: '>= 0.10'} + dependencies: + forwarded: 0.2.0 + ipaddr.js: 1.9.1 + dev: false + + /pump@3.0.0: + resolution: {integrity: sha512-LwZy+p3SFs1Pytd/jYct4wpv49HiYCqd9Rlc5ZVdk0V+8Yzv6jR5Blk3TRmPL1ft69TxP0IMZGJ+WPFU2BFhww==} + dependencies: + end-of-stream: 1.4.4 + once: 1.4.0 + dev: false + + /punycode@1.4.1: + resolution: {integrity: sha512-jmYNElW7yvO7TV33CjSmvSiE2yco3bV2czu/OzDKdMNVZQWfxCblURLhf+47syQRBntjfLdd/H0egrzIG+oaFQ==} + dev: false + + /punycode@2.3.0: + resolution: {integrity: sha512-rRV+zQD8tVFys26lAGR9WUuS4iUAngJScM+ZRSKtvl5tKeZ2t5bvdNFdNHBW9FWR4guGHlgmsZ1G7BSm2wTbuA==} + engines: {node: '>=6'} + + /pupa@2.1.1: + resolution: {integrity: sha512-l1jNAspIBSFqbT+y+5FosojNpVpF94nlI+wDUpqP9enwOTfHx9f0gh5nB96vl+6yTpsJsypeNrwfzPrKuHB41A==} + engines: {node: '>=8'} + dependencies: + escape-goat: 2.1.1 + dev: false + + /pure-color@1.3.0: + resolution: {integrity: sha512-QFADYnsVoBMw1srW7OVKEYjG+MbIa49s54w1MA1EDY6r2r/sTcKKYqRX1f4GYvnXP7eN/Pe9HFcX+hwzmrXRHA==} + dev: false + + /qs@6.11.0: + resolution: {integrity: sha512-MvjoMCJwEarSbUYk5O+nmoSzSutSsTwF85zcHPQ9OrlFoZOYIjaqBAJIqIXjptyD5vThxGq52Xu/MaJzRkIk4Q==} + engines: {node: '>=0.6'} + dependencies: + side-channel: 1.0.4 + dev: false + + /queue-microtask@1.2.3: + resolution: {integrity: sha512-NuaNSa6flKT5JaSYQzJok04JzTL1CA6aGhv5rfLW3PgqA+M2ChpZQnAC8h8i4ZFkBS8X5RqkDBHA7r4hej3K9A==} + + /queue@6.0.2: + resolution: {integrity: sha512-iHZWu+q3IdFZFX36ro/lKBkSvfkztY5Y7HMiPlOUjhupPcG2JMfst2KKEpu5XndviX/3UhFbRngUPNKtgvtZiA==} + dependencies: + inherits: 2.0.4 + dev: false + + /randombytes@2.1.0: + resolution: {integrity: sha512-vYl3iOX+4CKUWuxGi9Ukhie6fsqXqS9FE2Zaic4tNFD2N2QQaXOMFbuKK4QmDHC0JO6B1Zp41J0LpT0oR68amQ==} + dependencies: + safe-buffer: 5.2.1 + + /range-parser@1.2.0: + resolution: {integrity: sha512-kA5WQoNVo4t9lNx2kQNFCxKeBl5IbbSNBl1M/tLkw9WCn+hxNBAW5Qh8gdhs63CJnhjJ2zQWFoqPJP2sK1AV5A==} + engines: {node: '>= 0.6'} + dev: false + + /range-parser@1.2.1: + resolution: {integrity: sha512-Hrgsx+orqoygnmhFbKaHE6c296J+HTAQXoxEF6gNupROmmGJRoyzfG3ccAveqCBrwr/2yxQ5BVd/GTl5agOwSg==} + engines: {node: '>= 0.6'} + dev: false + + /raw-body@2.5.1: + resolution: {integrity: sha512-qqJBtEyVgS0ZmPGdCFPWJ3FreoqvG4MVQln/kCgF7Olq95IbOp0/BWyMwbdtn4VTvkM8Y7khCQ2Xgk/tcrCXig==} + engines: {node: '>= 0.8'} + dependencies: + bytes: 3.1.2 + http-errors: 2.0.0 + iconv-lite: 0.4.24 + unpipe: 1.0.0 + dev: false + + /rc@1.2.8: + resolution: {integrity: sha512-y3bGgqKj3QBdxLbLkomlohkvsA8gdAiUQlSBJnBhfn+BPxg4bc62d8TcBW15wavDfgexCgccckhcZvywyQYPOw==} + hasBin: true + dependencies: + deep-extend: 0.6.0 + ini: 1.3.8 + minimist: 1.2.8 + strip-json-comments: 2.0.1 + dev: false + + /react-base16-styling@0.6.0: + resolution: {integrity: sha512-yvh/7CArceR/jNATXOKDlvTnPKPmGZz7zsenQ3jUwLzHkNUR0CvY3yGYJbWJ/nnxsL8Sgmt5cO3/SILVuPO6TQ==} + dependencies: + base16: 1.0.0 + lodash.curry: 4.1.1 + lodash.flow: 3.5.0 + pure-color: 1.3.0 + dev: false + + /react-dev-utils@12.0.1(typescript@4.9.5)(webpack@5.89.0): + resolution: {integrity: sha512-84Ivxmr17KjUupyqzFode6xKhjwuEJDROWKJy/BthkL7Wn6NJ8h4WE6k/exAv6ImS+0oZLRRW5j/aINMHyeGeQ==} + engines: {node: '>=14'} + peerDependencies: + typescript: '>=2.7' + webpack: '>=4' + peerDependenciesMeta: + typescript: + optional: true + dependencies: + '@babel/code-frame': 7.22.13 + address: 1.2.2 + browserslist: 4.22.1 + chalk: 4.1.2 + cross-spawn: 7.0.3 + detect-port-alt: 1.1.6 + escape-string-regexp: 4.0.0 + filesize: 8.0.7 + find-up: 5.0.0 + fork-ts-checker-webpack-plugin: 6.5.3(typescript@4.9.5)(webpack@5.89.0) + global-modules: 2.0.0 + globby: 11.1.0 + gzip-size: 6.0.0 + immer: 9.0.21 + is-root: 2.1.0 + loader-utils: 3.2.1 + open: 8.4.2 + pkg-up: 3.1.0 + prompts: 2.4.2 + react-error-overlay: 6.0.11 + recursive-readdir: 2.2.3 + shell-quote: 1.8.1 + strip-ansi: 6.0.1 + text-table: 0.2.0 + typescript: 4.9.5 + webpack: 5.89.0 + transitivePeerDependencies: + - eslint + - supports-color + - vue-template-compiler + dev: false + + /react-dom@17.0.2(react@17.0.2): + resolution: {integrity: sha512-s4h96KtLDUQlsENhMn1ar8t2bEa+q/YAtj8pPPdIjPDGBDIVNsrD9aXNWqspUe6AzKCIG0C1HZZLqLV7qpOBGA==} + peerDependencies: + react: 17.0.2 + dependencies: + loose-envify: 1.4.0 + object-assign: 4.1.1 + react: 17.0.2 + scheduler: 0.20.2 + + /react-error-overlay@6.0.11: + resolution: {integrity: sha512-/6UZ2qgEyH2aqzYZgQPxEnz33NJ2gNsnHA2o5+o4wW9bLM/JYQitNP9xPhsXwC08hMMovfGe/8retsdDsczPRg==} + dev: false + + /react-fast-compare@3.2.2: + resolution: {integrity: sha512-nsO+KSNgo1SbJqJEYRE9ERzo7YtYbou/OqjSQKxV7jcKox7+usiUVZOAC+XnDOABXggQTno0Y1CpVnuWEc1boQ==} + + /react-helmet-async@1.3.0(react-dom@17.0.2)(react@17.0.2): + resolution: {integrity: sha512-9jZ57/dAn9t3q6hneQS0wukqC2ENOBgMNVEhb/ZG9ZSxUetzVIw4iAmEU38IaVg3QGYauQPhSeUTuIUtFglWpg==} + peerDependencies: + react: ^16.6.0 || ^17.0.0 || ^18.0.0 + react-dom: ^16.6.0 || ^17.0.0 || ^18.0.0 + dependencies: + '@babel/runtime': 7.23.2 + invariant: 2.2.4 + prop-types: 15.8.1 + react: 17.0.2 + react-dom: 17.0.2(react@17.0.2) + react-fast-compare: 3.2.2 + shallowequal: 1.1.0 + + /react-is@16.13.1: + resolution: {integrity: sha512-24e6ynE2H+OKt4kqsOvNd8kBpV65zoxbA4BVsEOB3ARVWQki/DHzaUoC5KuON/BiccDaCCTZBuOcfZs70kR8bQ==} + + /react-json-view@1.21.3(react-dom@17.0.2)(react@17.0.2): + resolution: {integrity: sha512-13p8IREj9/x/Ye4WI/JpjhoIwuzEgUAtgJZNBJckfzJt1qyh24BdTm6UQNGnyTq9dapQdrqvquZTo3dz1X6Cjw==} + peerDependencies: + react: ^17.0.0 || ^16.3.0 || ^15.5.4 + react-dom: ^17.0.0 || ^16.3.0 || ^15.5.4 + dependencies: + flux: 4.0.4(react@17.0.2) + react: 17.0.2 + react-base16-styling: 0.6.0 + react-dom: 17.0.2(react@17.0.2) + react-lifecycles-compat: 3.0.4 + react-textarea-autosize: 8.5.3(react@17.0.2) + transitivePeerDependencies: + - '@types/react' + - encoding + dev: false + + /react-lifecycles-compat@3.0.4: + resolution: {integrity: sha512-fBASbA6LnOU9dOU2eW7aQ8xmYBSXUIWr+UmF9b1efZBazGNO+rcXT/icdKnYm2pTwcRylVUYwW7H1PHfLekVzA==} + dev: false + + /react-loadable-ssr-addon-v5-slorber@1.0.1(@docusaurus/react-loadable@5.5.2)(webpack@5.89.0): + resolution: {integrity: sha512-lq3Lyw1lGku8zUEJPDxsNm1AfYHBrO9Y1+olAYwpUJ2IGFBskM0DMKok97A6LWUpHm+o7IvQBOWu9MLenp9Z+A==} + engines: {node: '>=10.13.0'} + peerDependencies: + react-loadable: '*' + webpack: '>=4.41.1 || 5.x' + dependencies: + '@babel/runtime': 7.23.2 + react-loadable: /@docusaurus/react-loadable@5.5.2(react@17.0.2) + webpack: 5.89.0 + dev: false + + /react-remove-scroll-bar@2.3.4(react@17.0.2): + resolution: {integrity: sha512-63C4YQBUt0m6ALadE9XV56hV8BgJWDmmTPY758iIJjfQKt2nYwoUrPk0LXRXcB/yIj82T1/Ixfdpdk68LwIB0A==} + engines: {node: '>=10'} + peerDependencies: + '@types/react': ^16.8.0 || ^17.0.0 || ^18.0.0 + react: ^16.8.0 || ^17.0.0 || ^18.0.0 + peerDependenciesMeta: + '@types/react': + optional: true + dependencies: + react: 17.0.2 + react-style-singleton: 2.2.1(react@17.0.2) + tslib: 2.6.2 + dev: false + + /react-remove-scroll@2.5.5(react@17.0.2): + resolution: {integrity: sha512-ImKhrzJJsyXJfBZ4bzu8Bwpka14c/fQt0k+cyFp/PBhTfyDnU5hjOtM4AG/0AMyy8oKzOTR0lDgJIM7pYXI0kw==} + engines: {node: '>=10'} + peerDependencies: + '@types/react': ^16.8.0 || ^17.0.0 || ^18.0.0 + react: ^16.8.0 || ^17.0.0 || ^18.0.0 + peerDependenciesMeta: + '@types/react': + optional: true + dependencies: + react: 17.0.2 + react-remove-scroll-bar: 2.3.4(react@17.0.2) + react-style-singleton: 2.2.1(react@17.0.2) + tslib: 2.6.2 + use-callback-ref: 1.3.0(react@17.0.2) + use-sidecar: 1.1.2(react@17.0.2) + dev: false + + /react-router-config@5.1.1(react-router@5.3.4)(react@17.0.2): + resolution: {integrity: sha512-DuanZjaD8mQp1ppHjgnnUnyOlqYXZVjnov/JzFhjLEwd3Z4dYjMSnqrEzzGThH47vpCOqPPwJM2FtthLeJ8Pbg==} + peerDependencies: + react: '>=15' + react-router: '>=5' + dependencies: + '@babel/runtime': 7.23.2 + react: 17.0.2 + react-router: 5.3.4(react@17.0.2) + dev: false + + /react-router-dom@5.3.4(react@17.0.2): + resolution: {integrity: sha512-m4EqFMHv/Ih4kpcBCONHbkT68KoAeHN4p3lAGoNryfHi0dMy0kCzEZakiKRsvg5wHZ/JLrLW8o8KomWiz/qbYQ==} + peerDependencies: + react: '>=15' + dependencies: + '@babel/runtime': 7.23.2 + history: 4.10.1 + loose-envify: 1.4.0 + prop-types: 15.8.1 + react: 17.0.2 + react-router: 5.3.4(react@17.0.2) + tiny-invariant: 1.3.1 + tiny-warning: 1.0.3 + dev: false + + /react-router@5.3.4(react@17.0.2): + resolution: {integrity: sha512-Ys9K+ppnJah3QuaRiLxk+jDWOR1MekYQrlytiXxC1RyfbdsZkS5pvKAzCCr031xHixZwpnsYNT5xysdFHQaYsA==} + peerDependencies: + react: '>=15' + dependencies: + '@babel/runtime': 7.23.2 + history: 4.10.1 + hoist-non-react-statics: 3.3.2 + loose-envify: 1.4.0 + path-to-regexp: 1.8.0 + prop-types: 15.8.1 + react: 17.0.2 + react-is: 16.13.1 + tiny-invariant: 1.3.1 + tiny-warning: 1.0.3 + dev: false + + /react-style-singleton@2.2.1(react@17.0.2): + resolution: {integrity: sha512-ZWj0fHEMyWkHzKYUr2Bs/4zU6XLmq9HsgBURm7g5pAVfyn49DgUiNgY2d4lXRlYSiCif9YBGpQleewkcqddc7g==} + engines: {node: '>=10'} + peerDependencies: + '@types/react': ^16.8.0 || ^17.0.0 || ^18.0.0 + react: ^16.8.0 || ^17.0.0 || ^18.0.0 + peerDependenciesMeta: + '@types/react': + optional: true + dependencies: + get-nonce: 1.0.1 + invariant: 2.2.4 + react: 17.0.2 + tslib: 2.6.2 + dev: false + + /react-textarea-autosize@8.5.3(react@17.0.2): + resolution: {integrity: sha512-XT1024o2pqCuZSuBt9FwHlaDeNtVrtCXu0Rnz88t1jUGheCLa3PhjE1GH8Ctm2axEtvdCl5SUHYschyQ0L5QHQ==} + engines: {node: '>=10'} + peerDependencies: + react: ^16.8.0 || ^17.0.0 || ^18.0.0 + dependencies: + '@babel/runtime': 7.23.2 + react: 17.0.2 + use-composed-ref: 1.3.0(react@17.0.2) + use-latest: 1.2.1(react@17.0.2) + transitivePeerDependencies: + - '@types/react' + dev: false + + /react@17.0.2: + resolution: {integrity: sha512-gnhPt75i/dq/z3/6q/0asP78D0u592D5L1pd7M8P+dck6Fu/jJeL6iVVK23fptSUZj8Vjf++7wXA8UNclGQcbA==} + engines: {node: '>=0.10.0'} + dependencies: + loose-envify: 1.4.0 + object-assign: 4.1.1 + + /read-cache@1.0.0: + resolution: {integrity: sha512-Owdv/Ft7IjOgm/i0xvNDZ1LrRANRfew4b2prF3OWMQLxLfu3bS8FVhCsrSCMK4lR56Y9ya+AThoTpDCTxCmpRA==} + dependencies: + pify: 2.3.0 + dev: true + + /readable-stream@2.3.8: + resolution: {integrity: sha512-8p0AUk4XODgIewSi0l8Epjs+EVnWiK7NoDIEGU0HhE7+ZyY8D1IMY7odu5lRrFXGg71L15KG8QrPmum45RTtdA==} + dependencies: + core-util-is: 1.0.3 + inherits: 2.0.4 + isarray: 1.0.0 + process-nextick-args: 2.0.1 + safe-buffer: 5.1.2 + string_decoder: 1.1.1 + util-deprecate: 1.0.2 + dev: false + + /readable-stream@3.6.2: + resolution: {integrity: sha512-9u/sniCrY3D5WdsERHzHE4G2YCXqoG5FTHUiCC4SIbr6XcLZBY05ya9EKjYek9O5xOAwjGq+1JdGBAS7Q9ScoA==} + engines: {node: '>= 6'} + dependencies: + inherits: 2.0.4 + string_decoder: 1.3.0 + util-deprecate: 1.0.2 + dev: false + + /readdirp@3.6.0: + resolution: {integrity: sha512-hOS089on8RduqdbhvQ5Z37A0ESjsqz6qnRcffsMU3495FuTdqSm+7bhJ29JvIOsBDEEnan5DPu9t3To9VRlMzA==} + engines: {node: '>=8.10.0'} + dependencies: + picomatch: 2.3.1 + + /reading-time@1.5.0: + resolution: {integrity: sha512-onYyVhBNr4CmAxFsKS7bz+uTLRakypIe4R+5A824vBSkQy/hB3fZepoVEf8OVAxzLvK+H/jm9TzpI3ETSm64Kg==} + dev: false + + /rechoir@0.6.2: + resolution: {integrity: sha512-HFM8rkZ+i3zrV+4LQjwQ0W+ez98pApMGM3HUrN04j3CqzPOzl9nmP15Y8YXNm8QHGv/eacOVEjqhmWpkRV0NAw==} + engines: {node: '>= 0.10'} + dependencies: + resolve: 1.22.8 + dev: false + + /recursive-readdir@2.2.3: + resolution: {integrity: sha512-8HrF5ZsXk5FAH9dgsx3BlUer73nIhuj+9OrQwEbLTPOBzGkL1lsFCR01am+v+0m2Cmbs1nP12hLDl5FA7EszKA==} + engines: {node: '>=6.0.0'} + dependencies: + minimatch: 3.1.2 + dev: false + + /regenerate-unicode-properties@10.1.1: + resolution: {integrity: sha512-X007RyZLsCJVVrjgEFVpLUTZwyOZk3oiL75ZcuYjlIWd6rNJtOjkBwQc5AsRrpbKVkxN6sklw/k/9m2jJYOf8Q==} + engines: {node: '>=4'} + dependencies: + regenerate: 1.4.2 + dev: false + + /regenerate@1.4.2: + resolution: {integrity: sha512-zrceR/XhGYU/d/opr2EKO7aRHUeiBI8qjtfHqADTwZd6Szfy16la6kqD0MIUs5z5hx6AaKa+PixpPrR289+I0A==} + dev: false + + /regenerator-runtime@0.14.0: + resolution: {integrity: sha512-srw17NI0TUWHuGa5CFGGmhfNIeja30WMBfbslPNhf6JrqQlLN5gcrvig1oqPxiVaXb0oW0XRKtH6Nngs5lKCIA==} + + /regenerator-transform@0.15.2: + resolution: {integrity: sha512-hfMp2BoF0qOk3uc5V20ALGDS2ddjQaLrdl7xrGXvAIow7qeWRM2VA2HuCHkUKk9slq3VwEwLNK3DFBqDfPGYtg==} + dependencies: + '@babel/runtime': 7.23.2 + dev: false + + /regexpu-core@5.3.2: + resolution: {integrity: sha512-RAM5FlZz+Lhmo7db9L298p2vHP5ZywrVXmVXpmAD9GuL5MPH6t9ROw1iA/wfHkQ76Qe7AaPF0nGuim96/IrQMQ==} + engines: {node: '>=4'} + dependencies: + '@babel/regjsgen': 0.8.0 + regenerate: 1.4.2 + regenerate-unicode-properties: 10.1.1 + regjsparser: 0.9.1 + unicode-match-property-ecmascript: 2.0.0 + unicode-match-property-value-ecmascript: 2.1.0 + dev: false + + /registry-auth-token@4.2.2: + resolution: {integrity: sha512-PC5ZysNb42zpFME6D/XlIgtNGdTl8bBOCw90xQLVMpzuuubJKYDWFAEuUNc+Cn8Z8724tg2SDhDRrkVEsqfDMg==} + engines: {node: '>=6.0.0'} + dependencies: + rc: 1.2.8 + dev: false + + /registry-url@5.1.0: + resolution: {integrity: sha512-8acYXXTI0AkQv6RAOjE3vOaIXZkT9wo4LOFbBKYQEEnnMNBpKqdUrI6S4NT0KPIo/WVvJ5tE/X5LF/TQUf0ekw==} + engines: {node: '>=8'} + dependencies: + rc: 1.2.8 + dev: false + + /regjsparser@0.9.1: + resolution: {integrity: sha512-dQUtn90WanSNl+7mQKcXAgZxvUe7Z0SqXlgzv0za4LwiUhyzBC58yQO3liFoUgu8GiJVInAhJjkj1N0EtQ5nkQ==} + hasBin: true + dependencies: + jsesc: 0.5.0 + dev: false + + /rehype-katex@5.0.0: + resolution: {integrity: sha512-ksSuEKCql/IiIadOHiKRMjypva9BLhuwQNascMqaoGLDVd0k2NlE2wMvgZ3rpItzRKCd6vs8s7MFbb8pcR0AEg==} + dependencies: + '@types/katex': 0.11.1 + hast-util-to-text: 2.0.1 + katex: 0.13.24 + rehype-parse: 7.0.1 + unified: 9.2.2 + unist-util-visit: 2.0.3 + dev: false + + /rehype-parse@7.0.1: + resolution: {integrity: sha512-fOiR9a9xH+Le19i4fGzIEowAbwG7idy2Jzs4mOrFWBSJ0sNUgy0ev871dwWnbOo371SjgjG4pwzrbgSVrKxecw==} + dependencies: + hast-util-from-parse5: 6.0.1 + parse5: 6.0.1 + dev: false + + /relateurl@0.2.7: + resolution: {integrity: sha512-G08Dxvm4iDN3MLM0EsP62EDV9IuhXPR6blNz6Utcp7zyV3tr4HVNINt6MpaRWbxoOHT3Q7YN2P+jaHX8vUbgog==} + engines: {node: '>= 0.10'} + dev: false + + /remark-emoji@2.2.0: + resolution: {integrity: sha512-P3cj9s5ggsUvWw5fS2uzCHJMGuXYRb0NnZqYlNecewXt8QBU9n5vW3DUUKOhepS8F9CwdMx9B8a3i7pqFWAI5w==} + dependencies: + emoticon: 3.2.0 + node-emoji: 1.11.0 + unist-util-visit: 2.0.3 + dev: false + + /remark-footnotes@2.0.0: + resolution: {integrity: sha512-3Clt8ZMH75Ayjp9q4CorNeyjwIxHFcTkaektplKGl2A1jNGEUey8cKL0ZC5vJwfcD5GFGsNLImLG/NGzWIzoMQ==} + dev: false + + /remark-math@3.0.1: + resolution: {integrity: sha512-epT77R/HK0x7NqrWHdSV75uNLwn8g9qTyMqCRCDujL0vj/6T6+yhdrR7mjELWtkse+Fw02kijAaBuVcHBor1+Q==} + dev: false + + /remark-mdx@1.6.22: + resolution: {integrity: sha512-phMHBJgeV76uyFkH4rvzCftLfKCr2RZuF+/gmVcaKrpsihyzmhXjA0BEMDaPTXG5y8qZOKPVo83NAOX01LPnOQ==} + dependencies: + '@babel/core': 7.12.9 + '@babel/helper-plugin-utils': 7.10.4 + '@babel/plugin-proposal-object-rest-spread': 7.12.1(@babel/core@7.12.9) + '@babel/plugin-syntax-jsx': 7.12.1(@babel/core@7.12.9) + '@mdx-js/util': 1.6.22 + is-alphabetical: 1.0.4 + remark-parse: 8.0.3 + unified: 9.2.0 + transitivePeerDependencies: + - supports-color + dev: false + + /remark-parse@8.0.3: + resolution: {integrity: sha512-E1K9+QLGgggHxCQtLt++uXltxEprmWzNfg+MxpfHsZlrddKzZ/hZyWHDbK3/Ap8HJQqYJRXP+jHczdL6q6i85Q==} + dependencies: + ccount: 1.1.0 + collapse-white-space: 1.0.6 + is-alphabetical: 1.0.4 + is-decimal: 1.0.4 + is-whitespace-character: 1.0.4 + is-word-character: 1.0.4 + markdown-escapes: 1.0.4 + parse-entities: 2.0.0 + repeat-string: 1.6.1 + state-toggle: 1.0.3 + trim: 0.0.1 + trim-trailing-lines: 1.1.4 + unherit: 1.1.3 + unist-util-remove-position: 2.0.1 + vfile-location: 3.2.0 + xtend: 4.0.2 + dev: false + + /remark-squeeze-paragraphs@4.0.0: + resolution: {integrity: sha512-8qRqmL9F4nuLPIgl92XUuxI3pFxize+F1H0e/W3llTk0UsjJaj01+RrirkMw7P21RKe4X6goQhYRSvNWX+70Rw==} + dependencies: + mdast-squeeze-paragraphs: 4.0.0 + dev: false + + /renderkid@3.0.0: + resolution: {integrity: sha512-q/7VIQA8lmM1hF+jn+sFSPWGlMkSAeNYcPLmDQx2zzuiDfaLrOmumR8iaUKlenFgh0XRPIUeSPlH3A+AW3Z5pg==} + dependencies: + css-select: 4.3.0 + dom-converter: 0.2.0 + htmlparser2: 6.1.0 + lodash: 4.17.21 + strip-ansi: 6.0.1 + dev: false + + /repeat-string@1.6.1: + resolution: {integrity: sha512-PV0dzCYDNfRi1jCDbJzpW7jNNDRuCOG/jI5ctQcGKt/clZD+YcPS3yIlWuTJMmESC8aevCFmWJy5wjAFgNqN6w==} + engines: {node: '>=0.10'} + dev: false + + /require-from-string@2.0.2: + resolution: {integrity: sha512-Xf0nWe6RseziFMu+Ap9biiUbmplq6S9/p+7w7YXP/JBHhrUDDUhwa+vANyubuqfZWTveU//DYVGsDG7RKL/vEw==} + engines: {node: '>=0.10.0'} + dev: false + + /require-like@0.1.2: + resolution: {integrity: sha512-oyrU88skkMtDdauHDuKVrgR+zuItqr6/c//FXzvmxRGMexSDc6hNvJInGW3LL46n+8b50RykrvwSUIIQH2LQ5A==} + dev: false + + /requires-port@1.0.0: + resolution: {integrity: sha512-KigOCHcocU3XODJxsu8i/j8T9tzT4adHiecwORRQ0ZZFcp7ahwXuRU1m+yuO90C5ZUyGeGfocHDI14M3L3yDAQ==} + dev: false + + /resolve-from@4.0.0: + resolution: {integrity: sha512-pb/MYmXstAkysRFx8piNI1tGFNQIFA3vkE3Gq4EuA1dF6gHp/+vgZqsCGJapvy8N3Q+4o7FwvquPJcnZ7RYy4g==} + engines: {node: '>=4'} + dev: false + + /resolve-pathname@3.0.0: + resolution: {integrity: sha512-C7rARubxI8bXFNB/hqcp/4iUeIXJhJZvFPFPiSPRnhU5UPxzMFIl+2E6yY6c4k9giDJAhtV+enfA+G89N6Csng==} + dev: false + + /resolve@1.22.8: + resolution: {integrity: sha512-oKWePCxqpd6FlLvGV1VU0x7bkPmmCNolxzjMf4NczoDnQcIWrAF+cPtZn5i6n+RfD2d9i0tzpKnG6Yk168yIyw==} + hasBin: true + dependencies: + is-core-module: 2.13.1 + path-parse: 1.0.7 + supports-preserve-symlinks-flag: 1.0.0 + + /responselike@1.0.2: + resolution: {integrity: sha512-/Fpe5guzJk1gPqdJLJR5u7eG/gNY4nImjbRDaVWVMRhne55TCmj2i9Q+54PBRfatRC8v/rIiv9BN0pMd9OV5EQ==} + dependencies: + lowercase-keys: 1.0.1 + dev: false + + /retry@0.13.1: + resolution: {integrity: sha512-XQBQ3I8W1Cge0Seh+6gjj03LbmRFWuoszgK9ooCpwYIrhhoO80pfq4cUkU5DkknwfOfFteRwlZ56PYOGYyFWdg==} + engines: {node: '>= 4'} + dev: false + + /reusify@1.0.4: + resolution: {integrity: sha512-U9nH88a3fc/ekCF1l0/UP1IosiuIjyTh7hBvXVMHYgVcfGvt897Xguj2UOLDeI5BG2m7/uwyaLVT6fbtCwTyzw==} + engines: {iojs: '>=1.0.0', node: '>=0.10.0'} + + /rimraf@3.0.2: + resolution: {integrity: sha512-JZkJMZkAGFFPP2YqXZXPbMlMBgsxzE8ILs4lMIX/2o0L9UBw9O/Y3o6wFw/i9YLapcUJWwqbi3kdxIPdC62TIA==} + hasBin: true + dependencies: + glob: 7.2.3 + dev: false + + /rtl-detect@1.1.2: + resolution: {integrity: sha512-PGMBq03+TTG/p/cRB7HCLKJ1MgDIi07+QU1faSjiYRfmY5UsAttV9Hs08jDAHVwcOwmVLcSJkpwyfXszVjWfIQ==} + dev: false + + /rtlcss@3.5.0: + resolution: {integrity: sha512-wzgMaMFHQTnyi9YOwsx9LjOxYXJPzS8sYnFaKm6R5ysvTkwzHiB0vxnbHwchHQT65PTdBjDG21/kQBWI7q9O7A==} + hasBin: true + dependencies: + find-up: 5.0.0 + picocolors: 1.0.0 + postcss: 8.4.31 + strip-json-comments: 3.1.1 + dev: false + + /run-parallel@1.2.0: + resolution: {integrity: sha512-5l4VyZR86LZ/lDxZTR6jqL8AFE2S0IFLMP26AbjsLVADxHdhB/c0GUsH+y39UfCi3dzz8OlQuPmnaJOMoDHQBA==} + dependencies: + queue-microtask: 1.2.3 + + /rxjs@7.8.1: + resolution: {integrity: sha512-AA3TVj+0A2iuIoQkWEK/tqFjBq2j+6PO6Y0zJcvzLAFhEFIO3HL0vls9hWLncZbAAbK0mar7oZ4V079I/qPMxg==} + dependencies: + tslib: 2.6.2 + dev: false + + /safe-buffer@5.1.2: + resolution: {integrity: sha512-Gd2UZBJDkXlY7GbJxfsE8/nvKkUEU1G38c1siN6QP6a9PT9MmHB8GnpscSmMJSoF8LOIrt8ud/wPtojys4G6+g==} + dev: false + + /safe-buffer@5.2.1: + resolution: {integrity: sha512-rp3So07KcdmmKbGvgaNxQSJr7bGVSVk5S9Eq1F+ppbRo70+YeaDxkw5Dd8NPN+GD6bjnYm2VuPuCXmpuYvmCXQ==} + + /safer-buffer@2.1.2: + resolution: {integrity: sha512-YZo3K82SD7Riyi0E1EQPojLz7kpepnSQI9IyPbHHg1XXXevb5dJI7tpyN2ADxGcQbHG7vcyRHk0cbwqcQriUtg==} + dev: false + + /sax@1.3.0: + resolution: {integrity: sha512-0s+oAmw9zLl1V1cS9BtZN7JAd0cW5e0QH4W3LWEK6a4LaLEA2OTpGYWDY+6XasBLtz6wkm3u1xRw95mRuJ59WA==} + dev: false + + /scheduler@0.20.2: + resolution: {integrity: sha512-2eWfGgAqqWFGqtdMmcL5zCMK1U8KlXv8SQFGglL3CEtd0aDVDWgeF/YoCmvln55m5zSk3J/20hTaSBeSObsQDQ==} + dependencies: + loose-envify: 1.4.0 + object-assign: 4.1.1 + + /schema-utils@2.7.0: + resolution: {integrity: sha512-0ilKFI6QQF5nxDZLFn2dMjvc4hjg/Wkg7rHd3jK6/A4a1Hl9VFdQWvgB1UMGoU94pad1P/8N7fMcEnLnSiju8A==} + engines: {node: '>= 8.9.0'} + dependencies: + '@types/json-schema': 7.0.14 + ajv: 6.12.6 + ajv-keywords: 3.5.2(ajv@6.12.6) + dev: false + + /schema-utils@2.7.1: + resolution: {integrity: sha512-SHiNtMOUGWBQJwzISiVYKu82GiV4QYGePp3odlY1tuKO7gPtphAT5R/py0fA6xtbgLL/RvtJZnU9b8s0F1q0Xg==} + engines: {node: '>= 8.9.0'} + dependencies: + '@types/json-schema': 7.0.14 + ajv: 6.12.6 + ajv-keywords: 3.5.2(ajv@6.12.6) + dev: false + + /schema-utils@3.3.0: + resolution: {integrity: sha512-pN/yOAvcC+5rQ5nERGuwrjLlYvLTbCibnZ1I7B1LaiAz9BRBlE9GMgE/eqV30P7aJQUf7Ddimy/RsbYO/GrVGg==} + engines: {node: '>= 10.13.0'} + dependencies: + '@types/json-schema': 7.0.14 + ajv: 6.12.6 + ajv-keywords: 3.5.2(ajv@6.12.6) + + /schema-utils@4.2.0: + resolution: {integrity: sha512-L0jRsrPpjdckP3oPug3/VxNKt2trR8TcabrM6FOAAlvC/9Phcmm+cuAgTlxBqdBR1WJx7Naj9WHw+aOmheSVbw==} + engines: {node: '>= 12.13.0'} + dependencies: + '@types/json-schema': 7.0.14 + ajv: 8.12.0 + ajv-formats: 2.1.1(ajv@8.12.0) + ajv-keywords: 5.1.0(ajv@8.12.0) + dev: false + + /search-insights@2.9.0: + resolution: {integrity: sha512-bkWW9nIHOFkLwjQ1xqVaMbjjO5vhP26ERsH9Y3pKr8imthofEFIxlnOabkmGcw6ksRj9jWidcI65vvjJH/nTGg==} + dev: false + + /section-matter@1.0.0: + resolution: {integrity: sha512-vfD3pmTzGpufjScBh50YHKzEu2lxBWhVEHsNGoEXmCmn2hKGfeNLYMzCJpe8cD7gqX7TJluOVpBkAequ6dgMmA==} + engines: {node: '>=4'} + dependencies: + extend-shallow: 2.0.1 + kind-of: 6.0.3 + dev: false + + /select-hose@2.0.0: + resolution: {integrity: sha512-mEugaLK+YfkijB4fx0e6kImuJdCIt2LxCRcbEYPqRGCs4F2ogyfZU5IAZRdjCP8JPq2AtdNoC/Dux63d9Kiryg==} + dev: false + + /selfsigned@2.4.1: + resolution: {integrity: sha512-th5B4L2U+eGLq1TVh7zNRGBapioSORUeymIydxgFpwww9d2qyKvtuPU2jJuHvYAwwqi2Y596QBL3eEqcPEYL8Q==} + engines: {node: '>=10'} + dependencies: + '@types/node-forge': 1.3.8 + node-forge: 1.3.1 + dev: false + + /semver-diff@3.1.1: + resolution: {integrity: sha512-GX0Ix/CJcHyB8c4ykpHGIAvLyOwOobtM/8d+TQkAd81/bEjgPHrfba41Vpesr7jX/t8Uh+R3EX9eAS5be+jQYg==} + engines: {node: '>=8'} + dependencies: + semver: 6.3.1 + dev: false + + /semver@5.7.2: + resolution: {integrity: sha512-cBznnQ9KjJqU67B52RMC65CMarK2600WFnbkcaiwWq3xy/5haFJlshgnpjovMVJ+Hff49d8GEn0b87C5pDQ10g==} + hasBin: true + dev: false + + /semver@6.3.1: + resolution: {integrity: sha512-BR7VvDCVHO+q2xBEWskxS6DJE1qRnb7DxzUrogb71CWoSficBxYsiAGd+Kl0mmq/MprG9yArRkyrQxTO6XjMzA==} + hasBin: true + dev: false + + /semver@7.5.4: + resolution: {integrity: sha512-1bCSESV6Pv+i21Hvpxp3Dx+pSD8lIPt8uVjRrxAUt/nbswYc+tK6Y2btiULjd4+fnq15PX+nqQDC7Oft7WkwcA==} + engines: {node: '>=10'} + hasBin: true + dependencies: + lru-cache: 6.0.0 + dev: false + + /send@0.18.0: + resolution: {integrity: sha512-qqWzuOjSFOuqPjFe4NOsMLafToQQwBSOEpS+FwEt3A2V3vKubTquT3vmLTQpFgMXp8AlFWFuP1qKaJZOtPpVXg==} + engines: {node: '>= 0.8.0'} + dependencies: + debug: 2.6.9 + depd: 2.0.0 + destroy: 1.2.0 + encodeurl: 1.0.2 + escape-html: 1.0.3 + etag: 1.8.1 + fresh: 0.5.2 + http-errors: 2.0.0 + mime: 1.6.0 + ms: 2.1.3 + on-finished: 2.4.1 + range-parser: 1.2.1 + statuses: 2.0.1 + transitivePeerDependencies: + - supports-color + dev: false + + /serialize-javascript@6.0.1: + resolution: {integrity: sha512-owoXEFjWRllis8/M1Q+Cw5k8ZH40e3zhp/ovX+Xr/vi1qj6QesbyXXViFbpNvWvPNAD62SutwEXavefrLJWj7w==} + dependencies: + randombytes: 2.1.0 + + /serve-handler@6.1.5: + resolution: {integrity: sha512-ijPFle6Hwe8zfmBxJdE+5fta53fdIY0lHISJvuikXB3VYFafRjMRpOffSPvCYsbKyBA7pvy9oYr/BT1O3EArlg==} + dependencies: + bytes: 3.0.0 + content-disposition: 0.5.2 + fast-url-parser: 1.1.3 + mime-types: 2.1.18 + minimatch: 3.1.2 + path-is-inside: 1.0.2 + path-to-regexp: 2.2.1 + range-parser: 1.2.0 + dev: false + + /serve-index@1.9.1: + resolution: {integrity: sha512-pXHfKNP4qujrtteMrSBb0rc8HJ9Ms/GrXwcUtUtD5s4ewDJI8bT3Cz2zTVRMKtri49pLx2e0Ya8ziP5Ya2pZZw==} + engines: {node: '>= 0.8.0'} + dependencies: + accepts: 1.3.8 + batch: 0.6.1 + debug: 2.6.9 + escape-html: 1.0.3 + http-errors: 1.6.3 + mime-types: 2.1.35 + parseurl: 1.3.3 + transitivePeerDependencies: + - supports-color + dev: false + + /serve-static@1.15.0: + resolution: {integrity: sha512-XGuRDNjXUijsUL0vl6nSD7cwURuzEgglbOaFuZM9g3kwDXOWVTck0jLzjPzGD+TazWbboZYu52/9/XPdUgne9g==} + engines: {node: '>= 0.8.0'} + dependencies: + encodeurl: 1.0.2 + escape-html: 1.0.3 + parseurl: 1.3.3 + send: 0.18.0 + transitivePeerDependencies: + - supports-color + dev: false + + /set-function-length@1.1.1: + resolution: {integrity: sha512-VoaqjbBJKiWtg4yRcKBQ7g7wnGnLV3M8oLvVWwOk2PdYY6PEFegR1vezXR0tw6fZGF9csVakIRjrJiy2veSBFQ==} + engines: {node: '>= 0.4'} + dependencies: + define-data-property: 1.1.1 + get-intrinsic: 1.2.2 + gopd: 1.0.1 + has-property-descriptors: 1.0.1 + dev: false + + /setimmediate@1.0.5: + resolution: {integrity: sha512-MATJdZp8sLqDl/68LfQmbP8zKPLQNV6BIZoIgrscFDQ+RsvK/BxeDQOgyxKKoh0y/8h3BqVFnCqQ/gd+reiIXA==} + dev: false + + /setprototypeof@1.1.0: + resolution: {integrity: sha512-BvE/TwpZX4FXExxOxZyRGQQv651MSwmWKZGqvmPcRIjDqWub67kTKuIMx43cZZrS/cBBzwBcNDWoFxt2XEFIpQ==} + dev: false + + /setprototypeof@1.2.0: + resolution: {integrity: sha512-E5LDX7Wrp85Kil5bhZv46j8jOeboKq5JMmYM3gVGdGH8xFpPWXUMsNrlODCrkoxMEeNi/XZIwuRvY4XNwYMJpw==} + dev: false + + /shallow-clone@3.0.1: + resolution: {integrity: sha512-/6KqX+GVUdqPuPPd2LxDDxzX6CAbjJehAAOKlNpqqUpAqPM6HeL8f+o3a+JsyGjn2lv0WY8UsTgUJjU9Ok55NA==} + engines: {node: '>=8'} + dependencies: + kind-of: 6.0.3 + + /shallowequal@1.1.0: + resolution: {integrity: sha512-y0m1JoUZSlPAjXVtPPW70aZWfIL/dSP7AFkRnniLCrK/8MDKog3TySTBmckD+RObVxH0v4Tox67+F14PdED2oQ==} + + /shebang-command@2.0.0: + resolution: {integrity: sha512-kHxr2zZpYtdmrN1qDjrrX/Z1rR1kG8Dx+gkpK1G4eXmvXswmcE1hTWBWYUzlraYw1/yZp6YuDY77YtvbN0dmDA==} + engines: {node: '>=8'} + dependencies: + shebang-regex: 3.0.0 + dev: false + + /shebang-regex@3.0.0: + resolution: {integrity: sha512-7++dFhtcx3353uBaq8DDR4NuxBetBzC7ZQOhmTQInHEd6bSrXdiEyzCvG07Z44UYdLShWUyXt5M/yhz8ekcb1A==} + engines: {node: '>=8'} + dev: false + + /shell-quote@1.8.1: + resolution: {integrity: sha512-6j1W9l1iAs/4xYBI1SYOVZyFcCis9b4KCLQ8fgAGG07QvzaRLVVRQvAy85yNmmZSjYjg4MWh4gNvlPujU/5LpA==} + dev: false + + /shelljs@0.8.5: + resolution: {integrity: sha512-TiwcRcrkhHvbrZbnRcFYMLl30Dfov3HKqzp5tO5b4pt6G/SezKcYhmDg15zXVBswHmctSAQKznqNW2LO5tTDow==} + engines: {node: '>=4'} + hasBin: true + dependencies: + glob: 7.2.3 + interpret: 1.4.0 + rechoir: 0.6.2 + dev: false + + /side-channel@1.0.4: + resolution: {integrity: sha512-q5XPytqFEIKHkGdiMIrY10mvLRvnQh42/+GoBlFW3b2LXLE2xxJpZFdm94we0BaoV3RwJyGqg5wS7epxTv0Zvw==} + dependencies: + call-bind: 1.0.5 + get-intrinsic: 1.2.2 + object-inspect: 1.13.1 + dev: false + + /signal-exit@3.0.7: + resolution: {integrity: sha512-wnD2ZE+l+SPC/uoS0vXeE9L1+0wuaMqKlfz9AMUo38JsyLSBWSFcHR1Rri62LZc12vLr1gb3jl7iwQhgwpAbGQ==} + dev: false + + /sirv@2.0.3: + resolution: {integrity: sha512-O9jm9BsID1P+0HOi81VpXPoDxYP374pkOLzACAoyUQ/3OUVndNpsz6wMnY2z+yOxzbllCKZrM+9QrWsv4THnyA==} + engines: {node: '>= 10'} + dependencies: + '@polka/url': 1.0.0-next.23 + mrmime: 1.0.1 + totalist: 3.0.1 + dev: false + + /sisteransi@1.0.5: + resolution: {integrity: sha512-bLGGlR1QxBcynn2d5YmDX4MGjlZvy2MRBDRNHLJ8VI6l6+9FUiyTFNJ0IveOSP0bcXgVDPRcfGqA0pjaqUpfVg==} + dev: false + + /sitemap@7.1.1: + resolution: {integrity: sha512-mK3aFtjz4VdJN0igpIJrinf3EO8U8mxOPsTBzSsy06UtjZQJ3YY3o3Xa7zSc5nMqcMrRwlChHZ18Kxg0caiPBg==} + engines: {node: '>=12.0.0', npm: '>=5.6.0'} + hasBin: true + dependencies: + '@types/node': 17.0.45 + '@types/sax': 1.2.6 + arg: 5.0.2 + sax: 1.3.0 + dev: false + + /slash@3.0.0: + resolution: {integrity: sha512-g9Q1haeby36OSStwb4ntCGGGaKsaVSjQ68fBxoQcutl5fS1vuY18H3wSt3jFyFtrkx+Kz0V1G85A4MyAdDMi2Q==} + engines: {node: '>=8'} + dev: false + + /slash@4.0.0: + resolution: {integrity: sha512-3dOsAHXXUkQTpOYcoAxLIorMTp4gIQr5IW3iVb7A7lFIp0VHhnynm9izx6TssdrIcVIESAlVjtnO2K8bg+Coew==} + engines: {node: '>=12'} + dev: false + + /sockjs@0.3.24: + resolution: {integrity: sha512-GJgLTZ7vYb/JtPSSZ10hsOYIvEYsjbNU+zPdIHcUaWVNUEPivzxku31865sSSud0Da0W4lEeOPlmw93zLQchuQ==} + dependencies: + faye-websocket: 0.11.4 + uuid: 8.3.2 + websocket-driver: 0.7.4 + dev: false + + /sort-css-media-queries@2.1.0: + resolution: {integrity: sha512-IeWvo8NkNiY2vVYdPa27MCQiR0MN0M80johAYFVxWWXQ44KU84WNxjslwBHmc/7ZL2ccwkM7/e6S5aiKZXm7jA==} + engines: {node: '>= 6.3.0'} + dev: false + + /source-map-js@1.0.2: + resolution: {integrity: sha512-R0XvVJ9WusLiqTCEiGCmICCMplcCkIwwR11mOSD9CR5u+IXYdiseeEuXCVAjS54zqwkLcPNnmU4OeJ6tUrWhDw==} + engines: {node: '>=0.10.0'} + + /source-map-support@0.5.21: + resolution: {integrity: sha512-uBHU3L3czsIyYXKX88fdrGovxdSCoTGDRZ6SYXtSRxLZUzHg5P/66Ht6uoUlHu9EZod+inXhKo3qQgwXUT/y1w==} + dependencies: + buffer-from: 1.1.2 + source-map: 0.6.1 + + /source-map@0.5.7: + resolution: {integrity: sha512-LbrmJOMUSdEVxIKvdcJzQC+nQhe8FUZQTXQy6+I75skNgn3OoQ0DZA8YnFa7gp8tqtL3KPf1kmo0R5DoApeSGQ==} + engines: {node: '>=0.10.0'} + dev: false + + /source-map@0.6.1: + resolution: {integrity: sha512-UjgapumWlbMhkBgzT7Ykc5YXUT46F0iKu8SGXq0bcwP5dz/h0Plj6enJqjz1Zbq2l5WaqYnrVbwWOWMyF3F47g==} + engines: {node: '>=0.10.0'} + + /space-separated-tokens@1.1.5: + resolution: {integrity: sha512-q/JSVd1Lptzhf5bkYm4ob4iWPjx0KiRe3sRFBNrVqbJkFaBm5vbbowy1mymoPNLRa52+oadOhJ+K49wsSeSjTA==} + dev: false + + /spdy-transport@3.0.0: + resolution: {integrity: sha512-hsLVFE5SjA6TCisWeJXFKniGGOpBgMLmerfO2aCyCU5s7nJ/rpAepqmFifv/GCbSbueEeAJJnmSQ2rKC/g8Fcw==} + dependencies: + debug: 4.3.4 + detect-node: 2.1.0 + hpack.js: 2.1.6 + obuf: 1.1.2 + readable-stream: 3.6.2 + wbuf: 1.7.3 + transitivePeerDependencies: + - supports-color + dev: false + + /spdy@4.0.2: + resolution: {integrity: sha512-r46gZQZQV+Kl9oItvl1JZZqJKGr+oEkB08A6BzkiR7593/7IbtuncXHd2YoYeTsG4157ZssMu9KYvUHLcjcDoA==} + engines: {node: '>=6.0.0'} + dependencies: + debug: 4.3.4 + handle-thing: 2.0.1 + http-deceiver: 1.2.7 + select-hose: 2.0.0 + spdy-transport: 3.0.0 + transitivePeerDependencies: + - supports-color + dev: false + + /sprintf-js@1.0.3: + resolution: {integrity: sha512-D9cPgkvLlV3t3IzL0D0YLvGA9Ahk4PcvVwUbN0dSGr1aP0Nrt4AEnTUbuGvquEC0mA64Gqt1fzirlRs5ibXx8g==} + dev: false + + /stable@0.1.8: + resolution: {integrity: sha512-ji9qxRnOVfcuLDySj9qzhGSEFVobyt1kIOSkj1qZzYLzq7Tos/oUUWvotUPQLlrsidqsK6tBH89Bc9kL5zHA6w==} + deprecated: 'Modern JS already guarantees Array#sort() is a stable sort, so this library is deprecated. See the compatibility table on MDN: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/sort#browser_compatibility' + dev: false + + /state-toggle@1.0.3: + resolution: {integrity: sha512-d/5Z4/2iiCnHw6Xzghyhb+GcmF89bxwgXG60wjIiZaxnymbyOmI8Hk4VqHXiVVp6u2ysaskFfXg3ekCj4WNftQ==} + dev: false + + /statuses@1.5.0: + resolution: {integrity: sha512-OpZ3zP+jT1PI7I8nemJX4AKmAX070ZkYPVWV/AaKTJl+tXCTGyVdC1a4SL8RUQYEwk/f34ZX8UTykN68FwrqAA==} + engines: {node: '>= 0.6'} + dev: false + + /statuses@2.0.1: + resolution: {integrity: sha512-RwNA9Z/7PrK06rYLIzFMlaF+l73iwpzsqRIFgbMLbTcLD6cOao82TaWefPXQvB2fOC4AjuYSEndS7N/mTCbkdQ==} + engines: {node: '>= 0.8'} + dev: false + + /std-env@3.4.3: + resolution: {integrity: sha512-f9aPhy8fYBuMN+sNfakZV18U39PbalgjXG3lLB9WkaYTxijru61wb57V9wxxNthXM5Sd88ETBWi29qLAsHO52Q==} + dev: false + + /string-width@4.2.3: + resolution: {integrity: sha512-wKyQRQpjJ0sIp62ErSZdGsjMJWsap5oRNihHhu6G7JVO/9jIB6UyevL+tXuOqrng8j/cxKTWyWUwvSTriiZz/g==} + engines: {node: '>=8'} + dependencies: + emoji-regex: 8.0.0 + is-fullwidth-code-point: 3.0.0 + strip-ansi: 6.0.1 + dev: false + + /string-width@5.1.2: + resolution: {integrity: sha512-HnLOCR3vjcY8beoNLtcjZ5/nxn2afmME6lhrDrebokqMap+XbeW8n9TXpPDOqdGK5qcI3oT0GKTW6wC7EMiVqA==} + engines: {node: '>=12'} + dependencies: + eastasianwidth: 0.2.0 + emoji-regex: 9.2.2 + strip-ansi: 7.1.0 + dev: false + + /string_decoder@1.1.1: + resolution: {integrity: sha512-n/ShnvDi6FHbbVfviro+WojiFzv+s8MPMHBczVePfUpDJLwoLT0ht1l4YwBCbi8pJAveEEdnkHyPyTP/mzRfwg==} + dependencies: + safe-buffer: 5.1.2 + dev: false + + /string_decoder@1.3.0: + resolution: {integrity: sha512-hkRX8U1WjJFd8LsDJ2yQ/wWWxaopEsABU1XfkM8A+j0+85JAGppt16cr1Whg6KIbb4okU6Mql6BOj+uup/wKeA==} + dependencies: + safe-buffer: 5.2.1 + dev: false + + /stringify-object@3.3.0: + resolution: {integrity: sha512-rHqiFh1elqCQ9WPLIC8I0Q/g/wj5J1eMkyoiD6eoQApWHP0FtlK7rqnhmabL5VUY9JQCcqwwvlOaSuutekgyrw==} + engines: {node: '>=4'} + dependencies: + get-own-enumerable-property-symbols: 3.0.2 + is-obj: 1.0.1 + is-regexp: 1.0.0 + dev: false + + /strip-ansi@6.0.1: + resolution: {integrity: sha512-Y38VPSHcqkFrCpFnQ9vuSXmquuv5oXOKpGeT6aGrr3o3Gc9AlVa6JBfUSOCnbxGGZF+/0ooI7KrPuUSztUdU5A==} + engines: {node: '>=8'} + dependencies: + ansi-regex: 5.0.1 + dev: false + + /strip-ansi@7.1.0: + resolution: {integrity: sha512-iq6eVVI64nQQTRYq2KtEg2d2uU7LElhTJwsH4YzIHZshxlgZms/wIc4VoDQTlG/IvVIrBKG06CrZnp0qv7hkcQ==} + engines: {node: '>=12'} + dependencies: + ansi-regex: 6.0.1 + dev: false + + /strip-bom-string@1.0.0: + resolution: {integrity: sha512-uCC2VHvQRYu+lMh4My/sFNmF2klFymLX1wHJeXnbEJERpV/ZsVuonzerjfrGpIGF7LBVa1O7i9kjiWvJiFck8g==} + engines: {node: '>=0.10.0'} + dev: false + + /strip-final-newline@2.0.0: + resolution: {integrity: sha512-BrpvfNAE3dcvq7ll3xVumzjKjZQ5tI1sEUIKr3Uoks0XUl45St3FlatVqef9prk4jRDzhW6WZg+3bk93y6pLjA==} + engines: {node: '>=6'} + dev: false + + /strip-json-comments@2.0.1: + resolution: {integrity: sha512-4gB8na07fecVVkOI6Rs4e7T6NOTki5EmL7TUduTs6bu3EdnSycntVJ4re8kgZA+wx9IueI2Y11bfbgwtzuE0KQ==} + engines: {node: '>=0.10.0'} + dev: false + + /strip-json-comments@3.1.1: + resolution: {integrity: sha512-6fPc+R4ihwqP6N/aIv2f1gMH8lOVtWQHoqC4yK6oSDVVocumAsfCqjkXnqiYMhmMwS/mEHLp7Vehlt3ql6lEig==} + engines: {node: '>=8'} + dev: false + + /style-to-object@0.3.0: + resolution: {integrity: sha512-CzFnRRXhzWIdItT3OmF8SQfWyahHhjq3HwcMNCNLn+N7klOOqPjMeG/4JSu77D7ypZdGvSzvkrbyeTMizz2VrA==} + dependencies: + inline-style-parser: 0.1.1 + dev: false + + /stylehacks@5.1.1(postcss@8.4.31): + resolution: {integrity: sha512-sBpcd5Hx7G6seo7b1LkpttvTz7ikD0LlH5RmdcBNb6fFR0Fl7LQwHDFr300q4cwUqi+IYrFGmsIHieMBfnN/Bw==} + engines: {node: ^10 || ^12 || >=14.0} + peerDependencies: + postcss: ^8.2.15 + dependencies: + browserslist: 4.22.1 + postcss: 8.4.31 + postcss-selector-parser: 6.0.13 + dev: false + + /sucrase@3.34.0: + resolution: {integrity: sha512-70/LQEZ07TEcxiU2dz51FKaE6hCTWC6vr7FOk3Gr0U60C3shtAN+H+BFr9XlYe5xqf3RA8nrc+VIwzCfnxuXJw==} + engines: {node: '>=8'} + hasBin: true + dependencies: + '@jridgewell/gen-mapping': 0.3.3 + commander: 4.1.1 + glob: 7.1.6 + lines-and-columns: 1.2.4 + mz: 2.7.0 + pirates: 4.0.6 + ts-interface-checker: 0.1.13 + dev: true + + /supports-color@5.5.0: + resolution: {integrity: sha512-QjVjwdXIt408MIiAqCX4oUKsgU2EqAGzs2Ppkm4aQYbjm+ZEWEcW4SfFNTr4uMNZma0ey4f5lgLrkB0aX0QMow==} + engines: {node: '>=4'} + dependencies: + has-flag: 3.0.0 + dev: false + + /supports-color@7.2.0: + resolution: {integrity: sha512-qpCAvRl9stuOHveKsn7HncJRvv501qIacKzQlO/+Lwxc9+0q2wLyv4Dfvt80/DPn2pqOBsJdDiogXGR9+OvwRw==} + engines: {node: '>=8'} + dependencies: + has-flag: 4.0.0 + dev: false + + /supports-color@8.1.1: + resolution: {integrity: sha512-MpUEN2OodtUzxvKQl72cUF7RQ5EiHsGvSsVG0ia9c5RbWGL2CI4C7EpPS8UTBIplnlzZiNuV56w+FuNxy3ty2Q==} + engines: {node: '>=10'} + dependencies: + has-flag: 4.0.0 + + /supports-preserve-symlinks-flag@1.0.0: + resolution: {integrity: sha512-ot0WnXS9fgdkgIcePe6RHNk1WA8+muPa6cSjeR3V8K27q9BB1rTE3R1p7Hv0z1ZyAc8s6Vvv8DIyWf681MAt0w==} + engines: {node: '>= 0.4'} + + /svg-parser@2.0.4: + resolution: {integrity: sha512-e4hG1hRwoOdRb37cIMSgzNsxyzKfayW6VOflrwvR+/bzrkyxY/31WkbgnQpgtrNp1SdpJvpUAGTa/ZoiPNDuRQ==} + dev: false + + /svgo@2.8.0: + resolution: {integrity: sha512-+N/Q9kV1+F+UeWYoSiULYo4xYSDQlTgb+ayMobAXPwMnLvop7oxKMo9OzIrX5x3eS4L4f2UHhc9axXwY8DpChg==} + engines: {node: '>=10.13.0'} + hasBin: true + dependencies: + '@trysound/sax': 0.2.0 + commander: 7.2.0 + css-select: 4.3.0 + css-tree: 1.1.3 + csso: 4.2.0 + picocolors: 1.0.0 + stable: 0.1.8 + dev: false + + /tailwindcss-radix@2.8.0: + resolution: {integrity: sha512-1k1UfoIYgVyBl13FKwwoKavjnJ5VEaUClCTAsgz3VLquN4ay/lyaMPzkbqD71sACDs2fRGImytAUlMb4TzOt1A==} + dev: false + + /tailwindcss@3.3.5: + resolution: {integrity: sha512-5SEZU4J7pxZgSkv7FP1zY8i2TIAOooNZ1e/OGtxIEv6GltpoiXUqWvLy89+a10qYTB1N5Ifkuw9lqQkN9sscvA==} + engines: {node: '>=14.0.0'} + hasBin: true + dependencies: + '@alloc/quick-lru': 5.2.0 + arg: 5.0.2 + chokidar: 3.5.3 + didyoumean: 1.2.2 + dlv: 1.1.3 + fast-glob: 3.3.1 + glob-parent: 6.0.2 + is-glob: 4.0.3 + jiti: 1.20.0 + lilconfig: 2.1.0 + micromatch: 4.0.5 + normalize-path: 3.0.0 + object-hash: 3.0.0 + picocolors: 1.0.0 + postcss: 8.4.31 + postcss-import: 15.1.0(postcss@8.4.31) + postcss-js: 4.0.1(postcss@8.4.31) + postcss-load-config: 4.0.1(postcss@8.4.31) + postcss-nested: 6.0.1(postcss@8.4.31) + postcss-selector-parser: 6.0.13 + resolve: 1.22.8 + sucrase: 3.34.0 + transitivePeerDependencies: + - ts-node + dev: true + + /tapable@1.1.3: + resolution: {integrity: sha512-4WK/bYZmj8xLr+HUCODHGF1ZFzsYffasLUgEiMBY4fgtltdO6B4WJtlSbPaDTLpYTcGVwM2qLnFTICEcNxs3kA==} + engines: {node: '>=6'} + dev: false + + /tapable@2.2.1: + resolution: {integrity: sha512-GNzQvQTOIP6RyTfE2Qxb8ZVlNmw0n88vp1szwWRimP02mnTsx3Wtn5qRdqY9w2XduFNUgvOwhNnQsjwCp+kqaQ==} + engines: {node: '>=6'} + + /terser-webpack-plugin@5.3.9(webpack@5.89.0): + resolution: {integrity: sha512-ZuXsqE07EcggTWQjXUj+Aot/OMcD0bMKGgF63f7UxYcu5/AJF53aIpK1YoP5xR9l6s/Hy2b+t1AM0bLNPRuhwA==} + engines: {node: '>= 10.13.0'} + peerDependencies: + '@swc/core': '*' + esbuild: '*' + uglify-js: '*' + webpack: ^5.1.0 + peerDependenciesMeta: + '@swc/core': + optional: true + esbuild: + optional: true + uglify-js: + optional: true + dependencies: + '@jridgewell/trace-mapping': 0.3.20 + jest-worker: 27.5.1 + schema-utils: 3.3.0 + serialize-javascript: 6.0.1 + terser: 5.22.0 + webpack: 5.89.0 + + /terser@5.22.0: + resolution: {integrity: sha512-hHZVLgRA2z4NWcN6aS5rQDc+7Dcy58HOf2zbYwmFcQ+ua3h6eEFf5lIDKTzbWwlazPyOZsFQO8V80/IjVNExEw==} + engines: {node: '>=10'} + hasBin: true + dependencies: + '@jridgewell/source-map': 0.3.5 + acorn: 8.11.2 + commander: 2.20.3 + source-map-support: 0.5.21 + + /text-table@0.2.0: + resolution: {integrity: sha512-N+8UisAXDGk8PFXP4HAzVR9nbfmVJ3zYLAWiTIoqC5v5isinhr+r5uaO8+7r3BMfuNIufIsA7RdpVgacC2cSpw==} + dev: false + + /thenify-all@1.6.0: + resolution: {integrity: sha512-RNxQH/qI8/t3thXJDwcstUO4zeqo64+Uy/+sNVRBx4Xn2OX+OZ9oP+iJnNFqplFra2ZUVeKCSa2oVWi3T4uVmA==} + engines: {node: '>=0.8'} + dependencies: + thenify: 3.3.1 + dev: true + + /thenify@3.3.1: + resolution: {integrity: sha512-RVZSIV5IG10Hk3enotrhvz0T9em6cyHBLkH/YAZuKqd8hRkKhSfCGIcP2KUY0EPxndzANBmNllzWPwak+bheSw==} + dependencies: + any-promise: 1.3.0 + dev: true + + /thunky@1.1.0: + resolution: {integrity: sha512-eHY7nBftgThBqOyHGVN+l8gF0BucP09fMo0oO/Lb0w1OF80dJv+lDVpXG60WMQvkcxAkNybKsrEIE3ZtKGmPrA==} + dev: false + + /tiny-invariant@1.3.1: + resolution: {integrity: sha512-AD5ih2NlSssTCwsMznbvwMZpJ1cbhkGd2uueNxzv2jDlEeZdU04JQfRnggJQ8DrcVBGjAsCKwFBbDlVNtEMlzw==} + dev: false + + /tiny-warning@1.0.3: + resolution: {integrity: sha512-lBN9zLN/oAf68o3zNXYrdCt1kP8WsiGW8Oo2ka41b2IM5JL/S1CTyX1rW0mb/zSuJun0ZUrDxx4sqvYS2FWzPA==} + dev: false + + /to-fast-properties@2.0.0: + resolution: {integrity: sha512-/OaKK0xYrs3DmxRYqL/yDc+FxFUVYhDlXMhRmv3z915w2HF1tnN1omB354j8VUGO/hbRzyD6Y3sA7v7GS/ceog==} + engines: {node: '>=4'} + dev: false + + /to-readable-stream@1.0.0: + resolution: {integrity: sha512-Iq25XBt6zD5npPhlLVXGFN3/gyR2/qODcKNNyTMd4vbm39HUaOiAM4PMq0eMVC/Tkxz+Zjdsc55g9yyz+Yq00Q==} + engines: {node: '>=6'} + dev: false + + /to-regex-range@5.0.1: + resolution: {integrity: sha512-65P7iz6X5yEr1cwcgvQxbbIw7Uk3gOy5dIdtZ4rDveLqhrdJP+Li/Hx6tyK0NEb+2GCyneCMJiGqrADCSNk8sQ==} + engines: {node: '>=8.0'} + dependencies: + is-number: 7.0.0 + + /toidentifier@1.0.1: + resolution: {integrity: sha512-o5sSPKEkg/DIQNmH43V0/uerLrpzVedkUh8tGNvaeXpfpuwjKenlSox/2O/BTlZUtEe+JG7s5YhEz608PlAHRA==} + engines: {node: '>=0.6'} + dev: false + + /totalist@3.0.1: + resolution: {integrity: sha512-sf4i37nQ2LBx4m3wB74y+ubopq6W/dIzXg0FDGjsYnZHVa1Da8FH853wlL2gtUhg+xJXjfk3kUZS3BRoQeoQBQ==} + engines: {node: '>=6'} + dev: false + + /tr46@0.0.3: + resolution: {integrity: sha512-N3WMsuqV66lT30CrXNbEjx4GEwlow3v6rr4mCcv6prnfwhS01rkgyFdjPNBYd9br7LpXV1+Emh01fHnq2Gdgrw==} + dev: false + + /trim-trailing-lines@1.1.4: + resolution: {integrity: sha512-rjUWSqnfTNrjbB9NQWfPMH/xRK1deHeGsHoVfpxJ++XeYXE0d6B1En37AHfw3jtfTU7dzMzZL2jjpe8Qb5gLIQ==} + dev: false + + /trim@0.0.1: + resolution: {integrity: sha512-YzQV+TZg4AxpKxaTHK3c3D+kRDCGVEE7LemdlQZoQXn0iennk10RsIoY6ikzAqJTc9Xjl9C1/waHom/J86ziAQ==} + deprecated: Use String.prototype.trim() instead + dev: false + + /trough@1.0.5: + resolution: {integrity: sha512-rvuRbTarPXmMb79SmzEp8aqXNKcK+y0XaB298IXueQ8I2PsrATcPBCSPyK/dDNa2iWOhKlfNnOjdAOTBU/nkFA==} + dev: false + + /ts-interface-checker@0.1.13: + resolution: {integrity: sha512-Y/arvbn+rrz3JCKl9C4kVNfTfSm2/mEp5FSz5EsZSANGPSlQrpRI5M4PKF+mJnE52jOO90PnPSc3Ur3bTQw0gA==} + dev: true + + /tslib@2.6.2: + resolution: {integrity: sha512-AEYxH93jGFPn/a2iVAwW87VuUIkR1FVUKB77NwMF7nBTDkDrrT/Hpt/IrCJ0QXhW27jTBDcf5ZY7w6RiqTMw2Q==} + dev: false + + /type-fest@0.20.2: + resolution: {integrity: sha512-Ne+eE4r0/iWnpAxD852z3A+N0Bt5RN//NjJwRd2VFHEmrywxf5vsZlh4R6lixl6B+wz/8d+maTSAkN1FIkI3LQ==} + engines: {node: '>=10'} + dev: false + + /type-fest@2.19.0: + resolution: {integrity: sha512-RAH822pAdBgcNMAfWnCBU3CFZcfZ/i1eZjwFU/dsLKumyuuP3niueg2UAukXYF0E2AAoc82ZSSf9J0WQBinzHA==} + engines: {node: '>=12.20'} + dev: false + + /type-is@1.6.18: + resolution: {integrity: sha512-TkRKr9sUTxEH8MdfuCSP7VizJyzRNMjj2J2do2Jr3Kym598JVdEksuzPQCnlFPW4ky9Q+iA+ma9BGm06XQBy8g==} + engines: {node: '>= 0.6'} + dependencies: + media-typer: 0.3.0 + mime-types: 2.1.35 + dev: false + + /typedarray-to-buffer@3.1.5: + resolution: {integrity: sha512-zdu8XMNEDepKKR+XYOXAVPtWui0ly0NtohUscw+UmaHiAWT8hrV1rr//H6V+0DvJ3OQ19S979M0laLfX8rm82Q==} + dependencies: + is-typedarray: 1.0.0 + dev: false + + /typescript-toggle@1.1.0(react@17.0.2): + resolution: {integrity: sha512-fdqedJ1rokLOhP2HJYZwRwfkQ1tEQ2C2YVMWPGwsVyq/5aonB67F0CbIA1kIu3rou5ZlFP3pvyvp/QLV95WHEg==} + engines: {node: '>=10'} + peerDependencies: + react: '>=16' + dependencies: + react: 17.0.2 + dev: false + + /typescript@4.9.5: + resolution: {integrity: sha512-1FXk9E2Hm+QzZQ7z+McJiHL4NW1F2EzMu9Nq9i3zAaGqibafqYwCVU6WyWAuyQRRzOlxou8xZSyXLEN8oKj24g==} + engines: {node: '>=4.2.0'} + hasBin: true + + /ua-parser-js@1.0.37: + resolution: {integrity: sha512-bhTyI94tZofjo+Dn8SN6Zv8nBDvyXTymAdM3LDI/0IboIUwTu1rEhW7v2TfiVsoYWgkQ4kOVqnI8APUFbIQIFQ==} + dev: false + + /undici-types@5.26.5: + resolution: {integrity: sha512-JlCMO+ehdEIKqlFxk6IfVoAUVmgz7cU7zD/h9XZ0qzeosSHmUJVOzSQvvYSYWXkFXC+IfLKSIffhv0sVZup6pA==} + + /unherit@1.1.3: + resolution: {integrity: sha512-Ft16BJcnapDKp0+J/rqFC3Rrk6Y/Ng4nzsC028k2jdDII/rdZ7Wd3pPT/6+vIIxRagwRc9K0IUX0Ra4fKvw+WQ==} + dependencies: + inherits: 2.0.4 + xtend: 4.0.2 + dev: false + + /unicode-canonical-property-names-ecmascript@2.0.0: + resolution: {integrity: sha512-yY5PpDlfVIU5+y/BSCxAJRBIS1Zc2dDG3Ujq+sR0U+JjUevW2JhocOF+soROYDSaAezOzOKuyyixhD6mBknSmQ==} + engines: {node: '>=4'} + dev: false + + /unicode-match-property-ecmascript@2.0.0: + resolution: {integrity: sha512-5kaZCrbp5mmbz5ulBkDkbY0SsPOjKqVS35VpL9ulMPfSl0J0Xsm+9Evphv9CoIZFwre7aJoa94AY6seMKGVN5Q==} + engines: {node: '>=4'} + dependencies: + unicode-canonical-property-names-ecmascript: 2.0.0 + unicode-property-aliases-ecmascript: 2.1.0 + dev: false + + /unicode-match-property-value-ecmascript@2.1.0: + resolution: {integrity: sha512-qxkjQt6qjg/mYscYMC0XKRn3Rh0wFPlfxB0xkt9CfyTvpX1Ra0+rAmdX2QyAobptSEvuy4RtpPRui6XkV+8wjA==} + engines: {node: '>=4'} + dev: false + + /unicode-property-aliases-ecmascript@2.1.0: + resolution: {integrity: sha512-6t3foTQI9qne+OZoVQB/8x8rk2k1eVy1gRXhV3oFQ5T6R1dqQ1xtin3XqSlx3+ATBkliTaR/hHyJBm+LVPNM8w==} + engines: {node: '>=4'} + dev: false + + /unified@9.2.0: + resolution: {integrity: sha512-vx2Z0vY+a3YoTj8+pttM3tiJHCwY5UFbYdiWrwBEbHmK8pvsPj2rtAX2BFfgXen8T39CJWblWRDT4L5WGXtDdg==} + dependencies: + '@types/unist': 2.0.9 + bail: 1.0.5 + extend: 3.0.2 + is-buffer: 2.0.5 + is-plain-obj: 2.1.0 + trough: 1.0.5 + vfile: 4.2.1 + dev: false + + /unified@9.2.2: + resolution: {integrity: sha512-Sg7j110mtefBD+qunSLO1lqOEKdrwBFBrR6Qd8f4uwkhWNlbkaqwHse6e7QvD3AP/MNoJdEDLaf8OxYyoWgorQ==} + dependencies: + '@types/unist': 2.0.9 + bail: 1.0.5 + extend: 3.0.2 + is-buffer: 2.0.5 + is-plain-obj: 2.1.0 + trough: 1.0.5 + vfile: 4.2.1 + dev: false + + /unique-string@2.0.0: + resolution: {integrity: sha512-uNaeirEPvpZWSgzwsPGtU2zVSTrn/8L5q/IexZmH0eH6SA73CmAA5U4GwORTxQAZs95TAXLNqeLoPPNO5gZfWg==} + engines: {node: '>=8'} + dependencies: + crypto-random-string: 2.0.0 + dev: false + + /unist-builder@2.0.3: + resolution: {integrity: sha512-f98yt5pnlMWlzP539tPc4grGMsFaQQlP/vM396b00jngsiINumNmsY8rkXjfoi1c6QaM8nQ3vaGDuoKWbe/1Uw==} + dev: false + + /unist-util-find-after@3.0.0: + resolution: {integrity: sha512-ojlBqfsBftYXExNu3+hHLfJQ/X1jYY/9vdm4yZWjIbf0VuWF6CRufci1ZyoD/wV2TYMKxXUoNuoqwy+CkgzAiQ==} + dependencies: + unist-util-is: 4.1.0 + dev: false + + /unist-util-generated@1.1.6: + resolution: {integrity: sha512-cln2Mm1/CZzN5ttGK7vkoGw+RZ8VcUH6BtGbq98DDtRGquAAOXig1mrBQYelOwMXYS8rK+vZDyyojSjp7JX+Lg==} + dev: false + + /unist-util-is@4.1.0: + resolution: {integrity: sha512-ZOQSsnce92GrxSqlnEEseX0gi7GH9zTJZ0p9dtu87WRb/37mMPO2Ilx1s/t9vBHrFhbgweUwb+t7cIn5dxPhZg==} + dev: false + + /unist-util-position@3.1.0: + resolution: {integrity: sha512-w+PkwCbYSFw8vpgWD0v7zRCl1FpY3fjDSQ3/N/wNd9Ffa4gPi8+4keqt99N3XW6F99t/mUzp2xAhNmfKWp95QA==} + dev: false + + /unist-util-remove-position@2.0.1: + resolution: {integrity: sha512-fDZsLYIe2uT+oGFnuZmy73K6ZxOPG/Qcm+w7jbEjaFcJgbQ6cqjs/eSPzXhsmGpAsWPkqZM9pYjww5QTn3LHMA==} + dependencies: + unist-util-visit: 2.0.3 + dev: false + + /unist-util-remove@2.1.0: + resolution: {integrity: sha512-J8NYPyBm4baYLdCbjmf1bhPu45Cr1MWTm77qd9istEkzWpnN6O9tMsEbB2JhNnBCqGENRqEWomQ+He6au0B27Q==} + dependencies: + unist-util-is: 4.1.0 + dev: false + + /unist-util-stringify-position@2.0.3: + resolution: {integrity: sha512-3faScn5I+hy9VleOq/qNbAd6pAx7iH5jYBMS9I1HgQVijz/4mv5Bvw5iw1sC/90CODiKo81G/ps8AJrISn687g==} + dependencies: + '@types/unist': 2.0.9 + dev: false + + /unist-util-visit-parents@3.1.1: + resolution: {integrity: sha512-1KROIZWo6bcMrZEwiH2UrXDyalAa0uqzWCxCJj6lPOvTve2WkfgCytoDTPaMnodXh1WrXOq0haVYHj99ynJlsg==} + dependencies: + '@types/unist': 2.0.9 + unist-util-is: 4.1.0 + dev: false + + /unist-util-visit@2.0.3: + resolution: {integrity: sha512-iJ4/RczbJMkD0712mGktuGpm/U4By4FfDonL7N/9tATGIF4imikjOuagyMY53tnZq3NP6BcmlrHhEKAfGWjh7Q==} + dependencies: + '@types/unist': 2.0.9 + unist-util-is: 4.1.0 + unist-util-visit-parents: 3.1.1 + dev: false + + /universalify@2.0.0: + resolution: {integrity: sha512-hAZsKq7Yy11Zu1DE0OzWjw7nnLZmJZYTDZZyEFHZdUhV8FkH5MCfoU1XMaxXovpyW5nq5scPqq0ZDP9Zyl04oQ==} + engines: {node: '>= 10.0.0'} + dev: false + + /unpipe@1.0.0: + resolution: {integrity: sha512-pjy2bYhSsufwWlKwPc+l3cN7+wuJlK6uz0YdJEOlQDbl6jo/YlPi4mb8agUkVC8BF7V8NuzeyPNqRksA3hztKQ==} + engines: {node: '>= 0.8'} + dev: false + + /update-browserslist-db@1.0.13(browserslist@4.22.1): + resolution: {integrity: sha512-xebP81SNcPuNpPP3uzeW1NYXxI3rxyJzF3pD6sH4jE7o/IX+WtSpwnVU+qIsDPyk0d3hmFQ7mjqc6AtV604hbg==} + hasBin: true + peerDependencies: + browserslist: '>= 4.21.0' + dependencies: + browserslist: 4.22.1 + escalade: 3.1.1 + picocolors: 1.0.0 + + /update-notifier@5.1.0: + resolution: {integrity: sha512-ItnICHbeMh9GqUy31hFPrD1kcuZ3rpxDZbf4KUDavXwS0bW5m7SLbDQpGX3UYr072cbrF5hFUs3r5tUsPwjfHw==} + engines: {node: '>=10'} + dependencies: + boxen: 5.1.2 + chalk: 4.1.2 + configstore: 5.0.1 + has-yarn: 2.1.0 + import-lazy: 2.1.0 + is-ci: 2.0.0 + is-installed-globally: 0.4.0 + is-npm: 5.0.0 + is-yarn-global: 0.3.0 + latest-version: 5.1.0 + pupa: 2.1.1 + semver: 7.5.4 + semver-diff: 3.1.1 + xdg-basedir: 4.0.0 + dev: false + + /uri-js@4.4.1: + resolution: {integrity: sha512-7rKUyy33Q1yc98pQ1DAmLtwX109F7TIfWlW1Ydo8Wl1ii1SeHieeh0HHfPeL2fMXK6z0s8ecKs9frCuLJvndBg==} + dependencies: + punycode: 2.3.0 + + /url-loader@4.1.1(file-loader@6.2.0)(webpack@5.89.0): + resolution: {integrity: sha512-3BTV812+AVHHOJQO8O5MkWgZ5aosP7GnROJwvzLS9hWDj00lZ6Z0wNak423Lp9PBZN05N+Jk/N5Si8jRAlGyWA==} + engines: {node: '>= 10.13.0'} + peerDependencies: + file-loader: '*' + webpack: ^4.0.0 || ^5.0.0 + peerDependenciesMeta: + file-loader: + optional: true + dependencies: + file-loader: 6.2.0(webpack@5.89.0) + loader-utils: 2.0.4 + mime-types: 2.1.35 + schema-utils: 3.3.0 + webpack: 5.89.0 + dev: false + + /url-parse-lax@3.0.0: + resolution: {integrity: sha512-NjFKA0DidqPa5ciFcSrXnAltTtzz84ogy+NebPvfEgAck0+TNg4UJ4IN+fB7zRZfbgUf0syOo9MDxFkDSMuFaQ==} + engines: {node: '>=4'} + dependencies: + prepend-http: 2.0.0 + dev: false + + /use-callback-ref@1.3.0(react@17.0.2): + resolution: {integrity: sha512-3FT9PRuRdbB9HfXhEq35u4oZkvpJ5kuYbpqhCfmiZyReuRgpnhDlbr2ZEnnuS0RrJAPn6l23xjFg9kpDM+Ms7w==} + engines: {node: '>=10'} + peerDependencies: + '@types/react': ^16.8.0 || ^17.0.0 || ^18.0.0 + react: ^16.8.0 || ^17.0.0 || ^18.0.0 + peerDependenciesMeta: + '@types/react': + optional: true + dependencies: + react: 17.0.2 + tslib: 2.6.2 + dev: false + + /use-composed-ref@1.3.0(react@17.0.2): + resolution: {integrity: sha512-GLMG0Jc/jiKov/3Ulid1wbv3r54K9HlMW29IWcDFPEqFkSO2nS0MuefWgMJpeHQ9YJeXDL3ZUF+P3jdXlZX/cQ==} + peerDependencies: + react: ^16.8.0 || ^17.0.0 || ^18.0.0 + dependencies: + react: 17.0.2 + dev: false + + /use-isomorphic-layout-effect@1.1.2(react@17.0.2): + resolution: {integrity: sha512-49L8yCO3iGT/ZF9QttjwLF/ZD9Iwto5LnH5LmEdk/6cFmXddqi2ulF0edxTwjj+7mqvpVVGQWvbXZdn32wRSHA==} + peerDependencies: + '@types/react': '*' + react: ^16.8.0 || ^17.0.0 || ^18.0.0 + peerDependenciesMeta: + '@types/react': + optional: true + dependencies: + react: 17.0.2 + dev: false + + /use-latest@1.2.1(react@17.0.2): + resolution: {integrity: sha512-xA+AVm/Wlg3e2P/JiItTziwS7FK92LWrDB0p+hgXloIMuVCeJJ8v6f0eeHyPZaJrM+usM1FkFfbNCrJGs8A/zw==} + peerDependencies: + '@types/react': '*' + react: ^16.8.0 || ^17.0.0 || ^18.0.0 + peerDependenciesMeta: + '@types/react': + optional: true + dependencies: + react: 17.0.2 + use-isomorphic-layout-effect: 1.1.2(react@17.0.2) + dev: false + + /use-sidecar@1.1.2(react@17.0.2): + resolution: {integrity: sha512-epTbsLuzZ7lPClpz2TyryBfztm7m+28DlEv2ZCQ3MDr5ssiwyOwGH/e5F9CkfWjJ1t4clvI58yF822/GUkjjhw==} + engines: {node: '>=10'} + peerDependencies: + '@types/react': ^16.9.0 || ^17.0.0 || ^18.0.0 + react: ^16.8.0 || ^17.0.0 || ^18.0.0 + peerDependenciesMeta: + '@types/react': + optional: true + dependencies: + detect-node-es: 1.1.0 + react: 17.0.2 + tslib: 2.6.2 + dev: false + + /use-sync-external-store@1.2.0(react@17.0.2): + resolution: {integrity: sha512-eEgnFxGQ1Ife9bzYs6VLi8/4X6CObHMw9Qr9tPY43iKwsPw8xE8+EFsf/2cFZ5S3esXgpWgtSCtLNS41F+sKPA==} + peerDependencies: + react: ^16.8.0 || ^17.0.0 || ^18.0.0 + dependencies: + react: 17.0.2 + dev: false + + /util-deprecate@1.0.2: + resolution: {integrity: sha512-EPD5q1uXyFxJpCrLnCc1nHnq3gOa6DZBocAIiI2TaSCA7VCJ1UJDMagCzIkXNsUYfD1daK//LTEQ8xiIbrHtcw==} + + /utila@0.4.0: + resolution: {integrity: sha512-Z0DbgELS9/L/75wZbro8xAnT50pBVFQZ+hUEueGDU5FN51YSCYM+jdxsfCiHjwNP/4LCDD0i/graKpeBnOXKRA==} + dev: false + + /utility-types@3.10.0: + resolution: {integrity: sha512-O11mqxmi7wMKCo6HKFt5AhO4BwY3VV68YU07tgxfz8zJTIxr4BpsezN49Ffwy9j3ZpwwJp4fkRwjRzq3uWE6Rg==} + engines: {node: '>= 4'} + + /utils-merge@1.0.1: + resolution: {integrity: sha512-pMZTvIkT1d+TFGvDOqodOclx0QWkkgi6Tdoa8gC8ffGAAqz9pzPTZWAybbsHHoED/ztMtkv/VoYTYyShUn81hA==} + engines: {node: '>= 0.4.0'} + dev: false + + /uuid@8.3.2: + resolution: {integrity: sha512-+NYs2QeMWy+GWFOEm9xnn6HCDp0l7QBD7ml8zLUmJ+93Q5NF0NocErnwkTkXVFNiX3/fpC6afS8Dhb/gz7R7eg==} + hasBin: true + dev: false + + /value-equal@1.0.1: + resolution: {integrity: sha512-NOJ6JZCAWr0zlxZt+xqCHNTEKOsrks2HQd4MqhP1qy4z1SkbEP467eNx6TgDKXMvUOb+OENfJCZwM+16n7fRfw==} + dev: false + + /vary@1.1.2: + resolution: {integrity: sha512-BNGbWLfd0eUPabhkXUVm0j8uuvREyTh5ovRa/dyow/BqAbZJyC+5fU+IzQOzmAKzYqYRAISoRhdQr3eIZ/PXqg==} + engines: {node: '>= 0.8'} + dev: false + + /vfile-location@3.2.0: + resolution: {integrity: sha512-aLEIZKv/oxuCDZ8lkJGhuhztf/BW4M+iHdCwglA/eWc+vtuRFJj8EtgceYFX4LRjOhCAAiNHsKGssC6onJ+jbA==} + dev: false + + /vfile-message@2.0.4: + resolution: {integrity: sha512-DjssxRGkMvifUOJre00juHoP9DPWuzjxKuMDrhNbk2TdaYYBNMStsNhEOt3idrtI12VQYM/1+iM0KOzXi4pxwQ==} + dependencies: + '@types/unist': 2.0.9 + unist-util-stringify-position: 2.0.3 + dev: false + + /vfile@4.2.1: + resolution: {integrity: sha512-O6AE4OskCG5S1emQ/4gl8zK586RqA3srz3nfK/Viy0UPToBc5Trp9BVFb1u0CjsKrAWwnpr4ifM/KBXPWwJbCA==} + dependencies: + '@types/unist': 2.0.9 + is-buffer: 2.0.5 + unist-util-stringify-position: 2.0.3 + vfile-message: 2.0.4 + dev: false + + /wait-on@6.0.1: + resolution: {integrity: sha512-zht+KASY3usTY5u2LgaNqn/Cd8MukxLGjdcZxT2ns5QzDmTFc4XoWBgC+C/na+sMRZTuVygQoMYwdcVjHnYIVw==} + engines: {node: '>=10.0.0'} + hasBin: true + dependencies: + axios: 0.25.0 + joi: 17.11.0 + lodash: 4.17.21 + minimist: 1.2.8 + rxjs: 7.8.1 + transitivePeerDependencies: + - debug + dev: false + + /watchpack@2.4.0: + resolution: {integrity: sha512-Lcvm7MGST/4fup+ifyKi2hjyIAwcdI4HRgtvTpIUxBRhB+RFtUh8XtDOxUfctVCnhVi+QQj49i91OyvzkJl6cg==} + engines: {node: '>=10.13.0'} + dependencies: + glob-to-regexp: 0.4.1 + graceful-fs: 4.2.11 + + /wbuf@1.7.3: + resolution: {integrity: sha512-O84QOnr0icsbFGLS0O3bI5FswxzRr8/gHwWkDlQFskhSPryQXvrTMxjxGP4+iWYoauLoBvfDpkrOauZ+0iZpDA==} + dependencies: + minimalistic-assert: 1.0.1 + dev: false + + /web-namespaces@1.1.4: + resolution: {integrity: sha512-wYxSGajtmoP4WxfejAPIr4l0fVh+jeMXZb08wNc0tMg6xsfZXj3cECqIK0G7ZAqUq0PP8WlMDtaOGVBTAWztNw==} + dev: false + + /webidl-conversions@3.0.1: + resolution: {integrity: sha512-2JAn3z8AR6rjK8Sm8orRC0h/bcl/DqL7tRPdGZ4I1CjdF+EaMLmYxBHyXuKL849eucPFhvBoxMsflfOb8kxaeQ==} + dev: false + + /webpack-bundle-analyzer@4.9.1: + resolution: {integrity: sha512-jnd6EoYrf9yMxCyYDPj8eutJvtjQNp8PHmni/e/ulydHBWhT5J3menXt3HEkScsu9YqMAcG4CfFjs3rj5pVU1w==} + engines: {node: '>= 10.13.0'} + hasBin: true + dependencies: + '@discoveryjs/json-ext': 0.5.7 + acorn: 8.11.2 + acorn-walk: 8.3.0 + commander: 7.2.0 + escape-string-regexp: 4.0.0 + gzip-size: 6.0.0 + is-plain-object: 5.0.0 + lodash.debounce: 4.0.8 + lodash.escape: 4.0.1 + lodash.flatten: 4.4.0 + lodash.invokemap: 4.6.0 + lodash.pullall: 4.2.0 + lodash.uniqby: 4.7.0 + opener: 1.5.2 + picocolors: 1.0.0 + sirv: 2.0.3 + ws: 7.5.9 + transitivePeerDependencies: + - bufferutil + - utf-8-validate + dev: false + + /webpack-dev-middleware@5.3.3(webpack@5.89.0): + resolution: {integrity: sha512-hj5CYrY0bZLB+eTO+x/j67Pkrquiy7kWepMHmUMoPsmcUaeEnQJqFzHJOyxgWlq746/wUuA64p9ta34Kyb01pA==} + engines: {node: '>= 12.13.0'} + peerDependencies: + webpack: ^4.0.0 || ^5.0.0 + dependencies: + colorette: 2.0.20 + memfs: 3.5.3 + mime-types: 2.1.35 + range-parser: 1.2.1 + schema-utils: 4.2.0 + webpack: 5.89.0 + dev: false + + /webpack-dev-server@4.15.1(webpack@5.89.0): + resolution: {integrity: sha512-5hbAst3h3C3L8w6W4P96L5vaV0PxSmJhxZvWKYIdgxOQm8pNZ5dEOmmSLBVpP85ReeyRt6AS1QJNyo/oFFPeVA==} + engines: {node: '>= 12.13.0'} + hasBin: true + peerDependencies: + webpack: ^4.37.0 || ^5.0.0 + webpack-cli: '*' + peerDependenciesMeta: + webpack: + optional: true + webpack-cli: + optional: true + dependencies: + '@types/bonjour': 3.5.12 + '@types/connect-history-api-fallback': 1.5.2 + '@types/express': 4.17.20 + '@types/serve-index': 1.9.3 + '@types/serve-static': 1.15.4 + '@types/sockjs': 0.3.35 + '@types/ws': 8.5.8 + ansi-html-community: 0.0.8 + bonjour-service: 1.1.1 + chokidar: 3.5.3 + colorette: 2.0.20 + compression: 1.7.4 + connect-history-api-fallback: 2.0.0 + default-gateway: 6.0.3 + express: 4.18.2 + graceful-fs: 4.2.11 + html-entities: 2.4.0 + http-proxy-middleware: 2.0.6(@types/express@4.17.20) + ipaddr.js: 2.1.0 + launch-editor: 2.6.1 + open: 8.4.2 + p-retry: 4.6.2 + rimraf: 3.0.2 + schema-utils: 4.2.0 + selfsigned: 2.4.1 + serve-index: 1.9.1 + sockjs: 0.3.24 + spdy: 4.0.2 + webpack: 5.89.0 + webpack-dev-middleware: 5.3.3(webpack@5.89.0) + ws: 8.14.2 + transitivePeerDependencies: + - bufferutil + - debug + - supports-color + - utf-8-validate + dev: false + + /webpack-merge@5.10.0: + resolution: {integrity: sha512-+4zXKdx7UnO+1jaN4l2lHVD+mFvnlZQP/6ljaJVb4SZiwIKeUnrT5l0gkT8z+n4hKpC+jpOv6O9R+gLtag7pSA==} + engines: {node: '>=10.0.0'} + dependencies: + clone-deep: 4.0.1 + flat: 5.0.2 + wildcard: 2.0.1 + + /webpack-sources@3.2.3: + resolution: {integrity: sha512-/DyMEOrDgLKKIG0fmvtz+4dUX/3Ghozwgm6iPp8KRhvn+eQf9+Q7GWxVNMk3+uCPWfdXYC4ExGBckIXdFEfH1w==} + engines: {node: '>=10.13.0'} + + /webpack@5.89.0: + resolution: {integrity: sha512-qyfIC10pOr70V+jkmud8tMfajraGCZMBWJtrmuBymQKCrLTRejBI8STDp1MCyZu/QTdZSeacCQYpYNQVOzX5kw==} + engines: {node: '>=10.13.0'} + hasBin: true + peerDependencies: + webpack-cli: '*' + peerDependenciesMeta: + webpack-cli: + optional: true + dependencies: + '@types/eslint-scope': 3.7.6 + '@types/estree': 1.0.3 + '@webassemblyjs/ast': 1.11.6 + '@webassemblyjs/wasm-edit': 1.11.6 + '@webassemblyjs/wasm-parser': 1.11.6 + acorn: 8.11.2 + acorn-import-assertions: 1.9.0(acorn@8.11.2) + browserslist: 4.22.1 + chrome-trace-event: 1.0.3 + enhanced-resolve: 5.15.0 + es-module-lexer: 1.3.1 + eslint-scope: 5.1.1 + events: 3.3.0 + glob-to-regexp: 0.4.1 + graceful-fs: 4.2.11 + json-parse-even-better-errors: 2.3.1 + loader-runner: 4.3.0 + mime-types: 2.1.35 + neo-async: 2.6.2 + schema-utils: 3.3.0 + tapable: 2.2.1 + terser-webpack-plugin: 5.3.9(webpack@5.89.0) + watchpack: 2.4.0 + webpack-sources: 3.2.3 + transitivePeerDependencies: + - '@swc/core' + - esbuild + - uglify-js + + /webpackbar@5.0.2(webpack@5.89.0): + resolution: {integrity: sha512-BmFJo7veBDgQzfWXl/wwYXr/VFus0614qZ8i9znqcl9fnEdiVkdbi0TedLQ6xAK92HZHDJ0QmyQ0fmuZPAgCYQ==} + engines: {node: '>=12'} + peerDependencies: + webpack: 3 || 4 || 5 + dependencies: + chalk: 4.1.2 + consola: 2.15.3 + pretty-time: 1.1.0 + std-env: 3.4.3 + webpack: 5.89.0 + dev: false + + /websocket-driver@0.7.4: + resolution: {integrity: sha512-b17KeDIQVjvb0ssuSDF2cYXSg2iztliJ4B9WdsuB6J952qCPKmnVq4DyW5motImXHDC1cBT/1UezrJVsKw5zjg==} + engines: {node: '>=0.8.0'} + dependencies: + http-parser-js: 0.5.8 + safe-buffer: 5.2.1 + websocket-extensions: 0.1.4 + dev: false + + /websocket-extensions@0.1.4: + resolution: {integrity: sha512-OqedPIGOfsDlo31UNwYbCFMSaO9m9G/0faIHj5/dZFDMFqPTcx6UwqyOy3COEaEOg/9VsGIpdqn62W5KhoKSpg==} + engines: {node: '>=0.8.0'} + dev: false + + /whatwg-url@5.0.0: + resolution: {integrity: sha512-saE57nupxk6v3HY35+jzBwYa0rKSy0XR8JSxZPwgLr7ys0IBzhGviA1/TUGJLmSVqs8pb9AnvICXEuOHLprYTw==} + dependencies: + tr46: 0.0.3 + webidl-conversions: 3.0.1 + dev: false + + /which@1.3.1: + resolution: {integrity: sha512-HxJdYWq1MTIQbJ3nw0cqssHoTNU267KlrDuGZ1WYlxDStUtKUhOaJmh112/TZmHxxUfuJqPXSOm7tDyas0OSIQ==} + hasBin: true + dependencies: + isexe: 2.0.0 + dev: false + + /which@2.0.2: + resolution: {integrity: sha512-BLI3Tl1TW3Pvl70l3yq3Y64i+awpwXqsGBYWkkqMtnbXgrMD+yj7rhW0kuEDxzJaYXGjEW5ogapKNMEKNMjibA==} + engines: {node: '>= 8'} + hasBin: true + dependencies: + isexe: 2.0.0 + dev: false + + /widest-line@3.1.0: + resolution: {integrity: sha512-NsmoXalsWVDMGupxZ5R08ka9flZjjiLvHVAWYOKtiKM8ujtZWr9cRffak+uSE48+Ob8ObalXpwyeUiyDD6QFgg==} + engines: {node: '>=8'} + dependencies: + string-width: 4.2.3 + dev: false + + /widest-line@4.0.1: + resolution: {integrity: sha512-o0cyEG0e8GPzT4iGHphIOh0cJOV8fivsXxddQasHPHfoZf1ZexrfeA21w2NaEN1RHE+fXlfISmOE8R9N3u3Qig==} + engines: {node: '>=12'} + dependencies: + string-width: 5.1.2 + dev: false + + /wildcard@2.0.1: + resolution: {integrity: sha512-CC1bOL87PIWSBhDcTrdeLo6eGT7mCFtrg0uIJtqJUFyK+eJnzl8A1niH56uu7KMa5XFrtiV+AQuHO3n7DsHnLQ==} + + /wrap-ansi@7.0.0: + resolution: {integrity: sha512-YVGIj2kamLSTxw6NsZjoBxfSwsn0ycdesmc4p+Q21c5zPuZ1pl+NfxVdxPtdHvmNVOQ6XSYG4AUtyt/Fi7D16Q==} + engines: {node: '>=10'} + dependencies: + ansi-styles: 4.3.0 + string-width: 4.2.3 + strip-ansi: 6.0.1 + dev: false + + /wrap-ansi@8.1.0: + resolution: {integrity: sha512-si7QWI6zUMq56bESFvagtmzMdGOtoxfR+Sez11Mobfc7tm+VkUckk9bW2UeffTGVUbOksxmSw0AA2gs8g71NCQ==} + engines: {node: '>=12'} + dependencies: + ansi-styles: 6.2.1 + string-width: 5.1.2 + strip-ansi: 7.1.0 + dev: false + + /wrappy@1.0.2: + resolution: {integrity: sha512-l4Sp/DRseor9wL6EvV2+TuQn63dMkPjZ/sp9XkghTEbV9KlPS1xUsZ3u7/IQO4wxtcFB4bgpQPRcR3QCvezPcQ==} + + /write-file-atomic@3.0.3: + resolution: {integrity: sha512-AvHcyZ5JnSfq3ioSyjrBkH9yW4m7Ayk8/9My/DD9onKeu/94fwrMocemO2QAJFAlnnDN+ZDS+ZjAR5ua1/PV/Q==} + dependencies: + imurmurhash: 0.1.4 + is-typedarray: 1.0.0 + signal-exit: 3.0.7 + typedarray-to-buffer: 3.1.5 + dev: false + + /ws@7.5.9: + resolution: {integrity: sha512-F+P9Jil7UiSKSkppIiD94dN07AwvFixvLIj1Og1Rl9GGMuNipJnV9JzjD6XuqmAeiswGvUmNLjr5cFuXwNS77Q==} + engines: {node: '>=8.3.0'} + peerDependencies: + bufferutil: ^4.0.1 + utf-8-validate: ^5.0.2 + peerDependenciesMeta: + bufferutil: + optional: true + utf-8-validate: + optional: true + dev: false + + /ws@8.14.2: + resolution: {integrity: sha512-wEBG1ftX4jcglPxgFCMJmZ2PLtSbJ2Peg6TmpJFTbe9GZYOQCDPdMYu/Tm0/bGZkw8paZnJY45J4K2PZrLYq8g==} + engines: {node: '>=10.0.0'} + peerDependencies: + bufferutil: ^4.0.1 + utf-8-validate: '>=5.0.2' + peerDependenciesMeta: + bufferutil: + optional: true + utf-8-validate: + optional: true + dev: false + + /xdg-basedir@4.0.0: + resolution: {integrity: sha512-PSNhEJDejZYV7h50BohL09Er9VaIefr2LMAf3OEmpCkjOi34eYyQYAXUTjEQtZJTKcF0E2UKTh+osDLsgNim9Q==} + engines: {node: '>=8'} + dev: false + + /xml-js@1.6.11: + resolution: {integrity: sha512-7rVi2KMfwfWFl+GpPg6m80IVMWXLRjO+PxTq7V2CDhoGak0wzYzFgUY2m4XJ47OGdXd8eLE8EmwfAmdjw7lC1g==} + hasBin: true + dependencies: + sax: 1.3.0 + dev: false + + /xtend@4.0.2: + resolution: {integrity: sha512-LKYU1iAXJXUgAXn9URjiu+MWhyUXHsvfp7mcuYm9dSUKK0/CjtrUwFAxD82/mCWbtLsGjFIad0wIsod4zrTAEQ==} + engines: {node: '>=0.4'} + dev: false + + /yallist@3.1.1: + resolution: {integrity: sha512-a4UGQaWPH59mOXUYnAG2ewncQS4i4F43Tv3JoAM+s2VDAmS9NsK8GpDMLrCHPksFT7h3K6TOoUNn2pb7RoXx4g==} + dev: false + + /yallist@4.0.0: + resolution: {integrity: sha512-3wdGidZyq5PB084XLES5TpOSRA3wjXAlIWMhum2kRcv/41Sn2emQ0dycQW4uZXLejwKvg6EsvbdlVL+FYEct7A==} + dev: false + + /yaml@1.10.2: + resolution: {integrity: sha512-r3vXyErRCYJ7wg28yvBY5VSoAF8ZvlcW9/BwUzEtUsjvX/DKs24dIkuwjtuprwJJHsbyUbLApepYTR1BN4uHrg==} + engines: {node: '>= 6'} + dev: false + + /yaml@2.3.3: + resolution: {integrity: sha512-zw0VAJxgeZ6+++/su5AFoqBbZbrEakwu+X0M5HmcwUiBL7AzcuPKjj5we4xfQLp78LkEMpD0cOnUhmgOVy3KdQ==} + engines: {node: '>= 14'} + dev: true + + /yocto-queue@0.1.0: + resolution: {integrity: sha512-rVksvsnNCdJ/ohGc6xgPwyN8eheCxsiLM8mxuE/t/mOVqJewPuO1miLpTHQiRgTKCLexL4MeAFVagts7HmNZ2Q==} + engines: {node: '>=10'} + dev: false + + /zwitch@1.0.5: + resolution: {integrity: sha512-V50KMwwzqJV0NpZIZFwfOD5/lyny3WlSzRiXgA0G7VUnRlqttta1L6UQIHzd6EuBY/cHGfwTIck7w1yH6Q5zUw==} + dev: false diff --git a/website/sidebars.js b/website/sidebars.js index 9ab54c2459c4..5464be4d3232 100644 --- a/website/sidebars.js +++ b/website/sidebars.js @@ -14,7 +14,57 @@ /** @type {import('@docusaurus/plugin-content-docs').SidebarsConfig} */ const sidebars = { // By default, Docusaurus generates a sidebar from the docs folder structure - tutorialSidebar: [{type: 'autogenerated', dirName: '.'}], + tutorialSidebar: [ + { + type: "category", + label: "OpenBB Terminal Pro", + items: [{ type: "autogenerated", dirName: "pro" }], + customProps: { + hiddenByDefault: true, + }, + }, + { + type: "category", + label: "OpenBB Platform", + items: [ + { type: "autogenerated", dirName: "platform" }], + }, + { + type: "category", + label: "OpenBB Terminal", + items: [{ type: "autogenerated", dirName: "terminal" }], + }, + { + type: "category", + label: "OpenBB Bot", + items: [{ type: "autogenerated", dirName: "bot" }], + }, + { + type: "html", + value: '', + }, + { + type: "html", + className: "sidebar-title", + value: "LEGACY", + defaultStyle: true, + }, + { + type: "category", + label: "OpenBB SDK", + items: [{ type: "autogenerated", dirName: "sdk" }], + }, + // Can do stuff like this too + // { + // type: "html", + // defaultStyle: true, + // className: "powered-by-banner", + // value: ` + // Powered by + // Docusaurus Logo + // `, + // }, + ], // But you can create a sidebar manually /* diff --git a/website/src/components/General/TutorialVideo.tsx b/website/src/components/General/TutorialVideo.tsx new file mode 100644 index 000000000000..8a9153cdbfed --- /dev/null +++ b/website/src/components/General/TutorialVideo.tsx @@ -0,0 +1,41 @@ +import React, { useState } from "react"; +import { Toggle } from "typescript-toggle"; + +export default function TutorialVideo( + { + youtubeLink, + videoLegend="Tutorial video" + } : { + youtubeLink: string, + videoLegend?: string + }) { + + const [isOn, setIsOn] = useState(true); + + return ( +
+
+

{videoLegend}

+
+ setIsOn(!isOn)} + /> +
+
+ {isOn && ( +
+ +
+ )} +
+ ); +} diff --git a/website/src/components/Icons/LetteringDocsLogo.tsx b/website/src/components/Icons/LetteringDocsLogo.tsx new file mode 100644 index 000000000000..76566cbfd562 --- /dev/null +++ b/website/src/components/Icons/LetteringDocsLogo.tsx @@ -0,0 +1,29 @@ +import React, { SVGProps } from "react"; +interface SVGRProps { + title?: string; + titleId?: string; +} + +const LetteringDocsLogo = ({ + title, + titleId, + ...props +}: SVGProps & SVGRProps) => ( + + {title ? {title} : null} + + +); + +export default LetteringDocsLogo; diff --git a/website/src/components/Icons/OnlyBotLettering.tsx b/website/src/components/Icons/OnlyBotLettering.tsx new file mode 100644 index 000000000000..163bbf40dba7 --- /dev/null +++ b/website/src/components/Icons/OnlyBotLettering.tsx @@ -0,0 +1,36 @@ +import React, { SVGProps } from "react"; +interface SVGRProps { + title?: string; + titleId?: string; +} + +const OnlyBotLetteringLogo: React.FC & SVGRProps> = ({ + title, + titleId, + ...props +}) => ( + + + + + +); + +export default OnlyBotLetteringLogo; diff --git a/website/src/components/Icons/OnlyPlatformLettering.tsx b/website/src/components/Icons/OnlyPlatformLettering.tsx new file mode 100644 index 000000000000..5cc90a150227 --- /dev/null +++ b/website/src/components/Icons/OnlyPlatformLettering.tsx @@ -0,0 +1,40 @@ +import React, { SVGProps } from "react"; +interface SVGRProps { + title?: string; + titleId?: string; +} + +const OnlyPlatformLetteringLogo = ({ + title, + titleId, + ...props +}: SVGProps & SVGRProps) => ( + + + + + + +); + +export default OnlyPlatformLetteringLogo; diff --git a/website/src/components/Icons/OnlyProLettering.tsx b/website/src/components/Icons/OnlyProLettering.tsx new file mode 100644 index 000000000000..85a17f06b898 --- /dev/null +++ b/website/src/components/Icons/OnlyProLettering.tsx @@ -0,0 +1,79 @@ +import React, { SVGProps } from "react"; +interface SVGRProps { + title?: string; + titleId?: string; +} + +const OnlyProLetteringLogo = ({ + title, + titleId, + ...props +}: SVGProps & SVGRProps) => ( + + + + + + + + + + + + + + + +); + +export default OnlyProLetteringLogo; diff --git a/website/src/components/Icons/OnlySDKLettering.tsx b/website/src/components/Icons/OnlySDKLettering.tsx new file mode 100644 index 000000000000..9e50b0a6eb59 --- /dev/null +++ b/website/src/components/Icons/OnlySDKLettering.tsx @@ -0,0 +1,36 @@ +import React, { SVGProps } from "react"; +interface SVGRProps { + title?: string; + titleId?: string; +} + +const OnlySDKLetteringLogo = ({ + title, + titleId, + ...props +}: SVGProps & SVGRProps) => ( + + + + + +); + +export default OnlySDKLetteringLogo; diff --git a/website/src/components/Icons/OnlyTerminalLettering.tsx b/website/src/components/Icons/OnlyTerminalLettering.tsx new file mode 100644 index 000000000000..e1d64a49bf12 --- /dev/null +++ b/website/src/components/Icons/OnlyTerminalLettering.tsx @@ -0,0 +1,57 @@ +import React, { SVGProps } from "react"; +interface SVGRProps { + title?: string; + titleId?: string; +} + +const OnlyTerminalLetteringLogo = ({ + title, + titleId, + ...props +}: SVGProps & SVGRProps) => ( + + + + + + + + + + + +); + +export default OnlyTerminalLetteringLogo; diff --git a/website/src/components/Icons/Twitter.tsx b/website/src/components/Icons/Twitter.tsx index 8148214ce0b6..b8a8b722f81e 100644 --- a/website/src/components/Icons/Twitter.tsx +++ b/website/src/components/Icons/Twitter.tsx @@ -9,21 +9,23 @@ const TwitterIcon = ({ titleId, ...props }: SVGProps & SVGRProps) => ( - - {title ? {title} : null} - - + + {title ? {title} : null} + + + + + ) export default TwitterIcon diff --git a/website/src/css/custom.css b/website/src/css/custom.css index 7062db73b7c1..e601c5095c21 100644 --- a/website/src/css/custom.css +++ b/website/src/css/custom.css @@ -116,6 +116,7 @@ 0 1px 2px -1px var(--tw-shadow-color); box-shadow: var(--tw-ring-offset-shadow, 0 0 #0000), var(--tw-ring-shadow, 0 0 #0000), var(--tw-shadow); + white-space: nowrap; } [data-theme="dark"] .pagination-nav__link { @@ -354,6 +355,12 @@ filter: progid:DXImageTransform.Microsoft.gradient(startColorstr="#062d48", endColorstr="#060709", GradientType=1); } +/* convert to css tag */ +.header_docs_pro { + background: rgb(2,0,36);background: rgb(2,0,36); + background: linear-gradient(90deg, rgba(2,0,36,1) 0%, rgba(36,108,155,1) 13%, rgba(66,154,205,1) 22%, rgba(43,85,107,1) 42%, rgba(12,36,53,1) 61%, rgba(6,6,6,1) 100%); +} + table { border-collapse: collapse; border: none; @@ -455,3 +462,39 @@ details summary { .theme-doc-version-badge { margin-bottom: 20px !important; } + + +.sidebar-divider { + border-top: 1px solid var(--ifm-color-gray-200); + display: block; + margin: 0.5rem 0 0.25rem 1rem; +} + +html[data-theme='dark'] .sidebar-divider { + border-top: 1px solid var(--ifm-color-gray-800); +} + +.sidebar-title { + font-size: 0.8rem; + letter-spacing: 0.05rem; + text-transform: uppercase; + font-weight: 600; + color: var(--ifm-color-gray-600); +} + +html[data-theme='dark'] .sidebar-divider { + color: var(--ifm-color-gray-200); +} + +@media only screen and (max-width: 998px) { + .sidebar-title, + .powered-by-banner { + margin-left: 1rem; + } +} + +.theme-edit-this-page { + display: flex; + justify-content: left; + align-items: center; +} diff --git a/website/src/pages/index.tsx b/website/src/pages/index.tsx index 5b8a76a124df..e9cf0c8f5e81 100644 --- a/website/src/pages/index.tsx +++ b/website/src/pages/index.tsx @@ -18,50 +18,50 @@ export default function Home(): JSX.Element { OpenBB Documentation

- This website contains documentation for OpenBB Terminal, OpenBB - SDK, and OpenBB Bot. All the tooling you need for your investment - research. + All the documentation for the tools you need for your investment research.

-
+
-

- OpenBB Terminal +

+ OpenBB Platform

- Free and open source investment research platform. + The OpenBB Platform provides a convenient way to access raw financial data from multiple data providers.

See more

+
+
-

- OpenBB Platform +

+ OpenBB Terminal

- Python library that allows access to investment research data. + The OpenBB Terminal is an open source investment research platform accessible to everyone, everywhere.

See more @@ -75,16 +75,15 @@ export default function Home(): JSX.Element { to="/bot" className="bg-[url(/img/bot_bg_light.png)] dark:bg-[url('/img/bot_bg.png')] bg-no-repeat shadow-sm group !no-underline text-grey-900 dark:text-white hover:text-grey-900 dark:hover:border-white hover:border-grey-600/80 dark:hover:!text-white relative w-full h-[238px] max-w-full p-8 rounded flex flex-col items-start justify-start border border-grey-300 bg-white dark:bg-grey-900" > -

+

OpenBB Bot

- Discord/Telegram bot to retrieve investment research data from - anywhere. + The OpenBB Bot bring market data directly to your financial groups, such as on Discord, Telegram and more.

See more @@ -93,7 +92,7 @@ export default function Home(): JSX.Element {

- Looking for the marketing website?{" "} + Looking for our website?{" "}

- Looking for the marketing website?{" "} + Looking for our website?{" "} { - if (item.href) { - return item.href; + if (href) { + return href } // In these cases, it's not necessary to render a fallback // We skip the "findFirstCategoryLink" computation @@ -78,14 +79,21 @@ export default function DocSidebarItemCategory({ ...props }) { const { items, label, collapsible, className, href } = item; + const labelToHrefMap = { + "OpenBB Terminal": "/terminal", + "OpenBB Platform": "/platform", + "OpenBB Bot": "/bot", + "OpenBB Terminal Pro": "/pro" + }; + const newHref = labelToHrefMap[label] || href; const { docs: { sidebar: { autoCollapseCategories }, }, } = useThemeConfig(); - const hrefWithSSRFallback = useCategoryHrefWithSSRFallback(item); + const hrefWithSSRFallback = useCategoryHrefWithSSRFallback(item, newHref); const isActive = isActiveSidebarItem(item, activePath); - const isCurrentPage = isSamePath(href, activePath); + const isCurrentPage = isSamePath(newHref, activePath); const { collapsed, setCollapsed } = useCollapsible({ // Active categories are always initialized as expanded. The default // (`item.collapsed`) is only used for non-active categories. @@ -117,6 +125,14 @@ export default function DocSidebarItemCategory({ const dontShowLink = isIFrame && ["OpenBB Terminal", "OpenBB SDK", "OpenBB Bot"].includes(label); + const location = useLocation(); + const isProPage = location.pathname.startsWith("/pro"); + + // Hide the OpenBB Terminal Pro section if we're not on a /pro page + if (item.customProps?.hiddenByDefault && !isProPage) { + return null; + } + return (

  • { - if (dontShowLink) { - e.preventDefault(); - } - onItemClick?.(item); - if (href) { - updateCollapsed(false); - } else { - e.preventDefault(); - updateCollapsed(); - } + if (dontShowLink) { + e.preventDefault(); + } + onItemClick?.(item); + if (newHref) { + updateCollapsed(false); + } else { + e.preventDefault(); + updateCollapsed(); } + } : () => { - if (dontShowLink) { - e.preventDefault(); - } - onItemClick?.(item); + if (dontShowLink) { + e.preventDefault(); } + onItemClick?.(item); + } } aria-current={isCurrentPage ? "page" : undefined} aria-expanded={collapsible ? !collapsed : undefined} @@ -168,7 +184,7 @@ export default function DocSidebarItemCategory({ > {label} - {href && collapsible && ( + {newHref && collapsible && ( { diff --git a/website/src/theme/DocSidebarItem/index.js b/website/src/theme/DocSidebarItem/index.js index aff5bfa3ccaf..fafe8349fb0c 100644 --- a/website/src/theme/DocSidebarItem/index.js +++ b/website/src/theme/DocSidebarItem/index.js @@ -1,12 +1,12 @@ -import React, { useState } from "react"; +import { useLocation } from "@docusaurus/router"; import DocSidebarItemCategory from "@theme/DocSidebarItem/Category"; -import DocSidebarItemLink from "@theme/DocSidebarItem/Link"; import DocSidebarItemHtml from "@theme/DocSidebarItem/Html"; +import DocSidebarItemLink from "@theme/DocSidebarItem/Link"; +import React from "react"; import { useIFrameContext } from "../Root"; -import { useLocation } from "@docusaurus/router"; -import clsx from "clsx"; function shouldHideItem(item, productPath) { + if (item.items) { return item.items.every((childItem) => shouldHideItem(childItem, productPath) @@ -30,6 +30,12 @@ function shouldHideItem(item, productPath) { export default function DocSidebarItem({ item, ...props }) { const { isIFrame } = useIFrameContext(); const { pathname } = useLocation(); + const isPro = pathname.startsWith("/pro"); + + // Check if the item is the OpenBB Terminal Pro section + if (item.customProps?.hiddenByDefault && !isPro) { + return null; + } if (isIFrame) { const firstTwoPathSegments = pathname.split("/").slice(0, 3).join("/"); @@ -39,6 +45,12 @@ export default function DocSidebarItem({ item, ...props }) { } } + if (isPro && !checkIfAnyChildIsPro(item)) { + return null; + } else if (!isPro && item.href?.startsWith("/pro")) { + return null; + } + switch (item.type) { case "category": return ; @@ -49,3 +61,19 @@ export default function DocSidebarItem({ item, ...props }) { return ; } } + +function checkIfAnyChildIsPro(item) { + if (item.items) { + return item.items.some((childItem) => checkIfAnyChildIsPro(childItem)); + } + + if (item.type === "link") { + return item.href?.startsWith("/pro"); + } + + if (item.type === "category") { + return item.items.some((childItem) => checkIfAnyChildIsPro(childItem)); + } + + return false; +} diff --git a/website/src/theme/EditThisPage/index.js b/website/src/theme/EditThisPage/index.js index d13756100c32..d3547a569553 100644 --- a/website/src/theme/EditThisPage/index.js +++ b/website/src/theme/EditThisPage/index.js @@ -7,6 +7,7 @@ export default function EditThisPageWrapper(props) { if ( pathname.startsWith("/terminal/reference") || pathname.startsWith("/sdk/reference") || + pathname.startsWith("/platform/reference") || pathname.startsWith("/bot/reference") ) return null; diff --git a/website/src/theme/Footer/index.js b/website/src/theme/Footer/index.js index e86fb2803c01..1474108bdc0b 100644 --- a/website/src/theme/Footer/index.js +++ b/website/src/theme/Footer/index.js @@ -47,8 +47,8 @@ function Footer() { return (