Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add keywords and descriptions to basics, intros and advanced guides #4052

Merged
merged 7 commits into from
Jan 30, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions website/content/sdk/guides/advanced/api-keys.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
---
title: Set API Keys
sidebar_position: 1
description: With the OpenBB SDK you can define your, often free, API key from various platforms like Alpha Vantage, FRED, IEX, Twitter, DeGiro, Binance and Coinglass. An API key is a set of random characters provided to you by a third party vendor that allows you to access data via their API endpoints. API keys can be managed directly from the SDK environment.
keywords: [api, keys, api keys, data provider, data, free, alpha vantage, fred, iex, twitter, degiro, binance, coinglass, polygon, intrinio, openbb sdk]
JerBouma marked this conversation as resolved.
Show resolved Hide resolved
---

## Accessing API Keys
Expand Down
2 changes: 2 additions & 0 deletions website/content/sdk/guides/advanced/changing-sources.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
---
title: Changing Sources
sidebar_position: 2
description: Many commands have multiple datasources attached to it. A great example is /stocka/fa/income that allows you to select YahooFinance, Polygon, AlphaVantage, FinancialModelingPrep or EODHD. Many have a default source but you can change the default sources of each command via the sources menu.
keywords: [source, sources, default source, datasources, api keys, api, keys, openbb sdk]
---

Some functions have the built-in capability of requesting data from multiple sources. `obb.stocks.load` is one example of this type feature:
Expand Down
1 change: 1 addition & 0 deletions website/content/sdk/guides/advanced/chart-styling.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Adjusting Chart Style
sidebar_position: 4
keywords: [export, import, data, excel, xlsx, csv, json, png, pdf, jpg, openbbuserdata, where is data exported, market data, financial data, free, openbb sdk, chart, styling]
---

Within the OpenBB SDK, you can customize your chart style. You can switch between `dark` and `light` easily using this block of code:
Expand Down
2 changes: 2 additions & 0 deletions website/content/sdk/guides/advanced/data.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
---
title: Importing and Exporting Data
sidebar_position: 3
description: The OpenBBUserData folder's default location is the home of the system user account. By default this will be the following paths. 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.
keywords: [export, import, data, excel, xlsx, csv, json, png, pdf, jpg, openbbuserdata, where is data exported, market data, financial data, free, openbb sdk]
---

The OpenBB SDK shares the `OpenBBUserData` folder with the Terminal, even with multiple versions installed on the same machine. Portfolio files, screener presets, and Matplotlib style sheets are all shared resources. This folder will be created after the first installation and it is read by subsequent installations. The default location for it is in the root of the operating system user account folder.
Expand Down
2 changes: 2 additions & 0 deletions website/content/sdk/guides/basics/index.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
---
title: Basics
sidebar_position: 1
description: The OpenBB SDK 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 terminal, explanation, basic usage, usage, how to, openbb sdk]
---
### Importing the SDK

Expand Down
5 changes: 2 additions & 3 deletions website/content/sdk/guides/intros/alternative.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,7 @@
---
title: Alternative
keywords: ['alts']
excerpt: "Alternative Menus in the OpenBB Terminal"

keywords: [alternative data, alternative, data, alt, openbb terminal]
description: 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 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`
Expand Down
2 changes: 2 additions & 0 deletions website/content/sdk/guides/intros/crypto/discovery.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
---
title: Discovery
keywords: [cryptocurrency, discovery, nft, app, decentralized, coins]
description: An Introduction to Cryptocurrency Discovery, within the Cryptocurrency Menu, with a brief overview of the features.
---

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.
Expand Down
2 changes: 2 additions & 0 deletions website/content/sdk/guides/intros/crypto/index.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
---
title: Crypto
keywords: [crypto, web3, nft, blockchain, cryptocurrency]
description: The Introduction to Cryptocurrency explains how to use the Cryptocurrency and provides a brief description of its sub-menus
---

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.
Expand Down
14 changes: 2 additions & 12 deletions website/content/sdk/guides/intros/econometrics.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,7 @@
---
title: Econometrics
keywords:
[
"econometrics",
"statistics",
"regression",
"panel data",
"time series",
"research",
"thesis",
"university",
]
excerpt: "The Introduction to Econometrics explains how to use the menu"
keywords: [econometrics, statistics, regression, panel data, time series, research, thesis, university]
description: 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 (for example) adding columns or setting indices, apply statistical tests (Breusch-Godfrey autocorrelation tests) as well as OLS regressions and Panel regressions (Random Effects and Fixed Effects)
---

The capabilities of the [Econometrics menu](/terminal/guides/intros/econometrics) from the OpenBB Terminal are wrapped into a powerful SDK, enabling users to work with the data in a flexible environment that can be fully customized to meet the needs of any user. The Econometrics menu's purpose is to provide the user the ability to perform statistical research on custom datasets. The menu allows the user to load in his/her own dataset(s), modify the data by adding columns or setting indices, apply statistical tests (e.g. <a href="https://en.wikipedia.org/wiki/Breusch%E2%80%93Godfrey_test" target="_blank" rel="noreferrer noopener">Breusch-Godfrey autocorrelation tests</a>) as well as OLS regressions and Panel regressions (e.g. <a href="https://en.wikipedia.org/wiki/Random_effects_model" target="_blank" rel="noreferrer noopener">Random Effects</a> and <a href="https://en.wikipedia.org/wiki/Fixed_effects_model" target="_blank" rel="noreferrer noopener">Fixed Effects</a>)
Expand Down
2 changes: 2 additions & 0 deletions website/content/sdk/guides/intros/economy.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
---
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]
description: The Economy menu enables you to obtain market overviews, see yield curves of any country and discover sector, industry and country performance. Next to that, the databases of EconDB, FRED and Yahoo Finance can be accessed. All of this can also be further analysed within the Forecasting menu and with Quantitative Techniques.
---

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:
Expand Down
7 changes: 2 additions & 5 deletions website/content/sdk/guides/intros/etf.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,7 @@
---
title: ETF
keywords:
[
"stocks, stock, options, option, call, put, earnings, calendar, how-to, guide, scripts, fundamental, analysis, technical, behavioural, analyst, equity, research, api, sdk, application, python, notebook, jupyter",
]
excerpt: "This guide introduces the ETF SDK in the context of the OpenBB SDK."
keywords: [etfs, exchange traded funds, fund, basket, retail, stocks, openbb terminal]
description: The ETF menu enables you to lookup any ETF and obtain an overview about the chosen ETF. Furthermore, sub-menus reside in this menu that can be used to compare companies within the ETF, discover gainers and losers within discovery and apply advanced technical indicators. Lastly, it also has the option to export multiple ETFs to Excel.
---

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`
Expand Down
2 changes: 2 additions & 0 deletions website/content/sdk/guides/intros/forecast.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
---
title: Forecast
keywords: [machine learning, statistics, artificial intelligence, deep learning, neural networks, time series, research, feature engineering, hyperparameters, ai, ml, openbb sdk]
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 that can be mixed, matched 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.
---

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.
Expand Down
2 changes: 2 additions & 0 deletions website/content/sdk/guides/intros/forex.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
---
title: Forex
keywords: [forex, currency, money, hedge, dollar, euro, pound, currencies, market, openbb sdk]
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. Furthermore, the menu has the ability to also apply Technical Analysis and Forecasting techniques.
---
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.

Expand Down
2 changes: 2 additions & 0 deletions website/content/sdk/guides/intros/futures.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
---
title: Futures
keywords: [forex, currency, money, hedge, dollar, euro, futures, future, interest, rates, forwards, commodities, bonds, treasuries, bond, gold, oil, openbb terminal]
description: The Futures menu provides historical prices and the current term structure for an asset.
---

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.
Expand Down
2 changes: 2 additions & 0 deletions website/content/sdk/guides/intros/portfolio/index.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
---
title: Portfolio
keywords: [portfolio, attribution, optimization, pnl, benchmark, return, volatility, metrics, broker, integration, report, optimization, risk, benchmark, brokers]
description: 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.
---

The [Portfolio menu](/terminal/guides/intros/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.
Expand Down
6 changes: 2 additions & 4 deletions website/content/sdk/guides/intros/portfolio/po.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,7 @@
---
title: Portfolio Optimization
keywords: ["portfolio", "optimization", "mean variance", "risk parity", "black litterman", "mean risk",
"hierarchical clustering models"]
excerpt: "The Introduction to Portfolio Optimization within the Portfolio menu explains how to use various portfolio
optimization techniques and provides a brief description of its sub-menus"
keywords: [portfolio, attribution, optimization, pnl, benchmark, return, volatility, metrics, broker, integration, report]
description: 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 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 <a href="https://www.investopedia.com/terms/m/meanvariance-analysis.asp" target="_blank" rel="noreferrer noopener">mean-variance optimization</a> to <a href="https://www.investopedia.com/terms/r/risk-parity.asp" target="_blank" rel="noreferrer noopener">risk parity models</a> and <a href="https://www.investopedia.com/terms/c/cluster_analysis.asp" target="_blank" rel="noreferrer noopener">hierarchical clustering models</a>. 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.

Expand Down
2 changes: 2 additions & 0 deletions website/content/sdk/guides/intros/quantitative-analysis.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
---
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]
description: This guide introduces the Quantitative Analysis menu, which is common across many sections of the OpenBB Terminal, briefly describes the features, and provides examples in context.
---

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`.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,10 +1,7 @@
---
title: Behavioral Analysis
keywords:
[
"stocks", "stock", "options", "option", "call", "put"
]
excerpt: "This guide introduces the BA menu in the context of the OpenBB SDK."
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]
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. Sentiment is particularly useful for momentum trading strategies, discovery, and general fundamental research.
---

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`
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
---
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]
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.
---

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`
Expand Down
2 changes: 2 additions & 0 deletions website/content/sdk/guides/intros/stocks/dark-pool-shorts.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
---
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]
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.
---

The `DPS` sub-module contains the commands from the [Dark Pools and Short Data menu](https://docs.openbb.co/terminal/guides/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.
Expand Down
7 changes: 2 additions & 5 deletions website/content/sdk/guides/intros/stocks/discovery.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,7 @@
---
title: Discovery
keywords:
[
"stocks", "stock", "options", "option", "comparison", "analysis", "tickers", "stocks", "insight"
]
excerpt: "This guide introduces the Disc SDK in the context of the OpenBB SDK."
keywords: [stocks, discovery, disc, menu, submenu, pipo, fipo, gainers, losers, ugs, gtech, active, ulc, asc, ford, arkord, upcoming, trending, cnews, lowfloat, hotpenny, rtat, divcal, dividends, short, trending, news]
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.
---

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`
Expand Down
2 changes: 2 additions & 0 deletions website/content/sdk/guides/intros/stocks/due-diligence.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
---
title: Due Diligence
keywords: [dd, due, diligence, research, company, ticker, analyst, rating, rot, pt, est, sec, supplier, customer, arktrades, ratings, analysts, filings, form, forms, customers, suppliers]
description: This guide introduces the Due Diligence menu within the Stocks menu, explains the features briefly, then provides examples.
---

## How to Use
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
---
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]
description: This guide introduces the Fundamental Analysis menu within the Stocks menu, briefly explains the features, and provides examples in context.
---

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:
Expand Down
Loading