Improve Pro documentation further (#5641)

* small improvement

* Fix TutorialVideo for mobile view

* main page terminal pro docs

* jose whelp

* placeholder index file that needs to be removed

* fix: fixes sidebar, removes unused index.md

* update link to api keys

* update api keys link

* fix hyperlinks in terminal helper

* fix a few more links

* fix some more links

* linter

* black linter

* improve main docs page for each product

* small refactor

* header to take to main page of product

* run OpenAI script to generate SEO for pro content

---------

Co-authored-by: jose-donato <43375532+jose-donato@users.noreply.github.com>
This commit is contained in:
DidierRLopes
2023-11-03 09:46:20 -07:00
committed by GitHub
parent 1386cbb277
commit 504a4f442c
68 changed files with 6293 additions and 5828 deletions

2
CONTRIBUTING.md vendored
View File

@@ -222,7 +222,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

View File

@@ -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 @@
]
}
]
}
}

View File

@@ -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
1 file command
127 website/content/sdk/usage/basics/index.md holdings
128 website/content/sdk/usage/basics/index.md dd
129 website/content/sdk/usage/basics/index.md all
130 website/content/sdk/usage/guides/api-keys.md website/content/sdk/usage/api-keys.md from
131 website/content/sdk/usage/guides/api-keys.md website/content/sdk/usage/api-keys.md global
132 website/content/sdk/usage/guides/api-keys.md website/content/sdk/usage/api-keys.md account
133 website/content/sdk/usage/guides/api-keys.md website/content/sdk/usage/api-keys.md fred
134 website/content/sdk/usage/guides/api-keys.md website/content/sdk/usage/api-keys.md degiro
135 website/content/sdk/usage/guides/api-keys.md website/content/sdk/usage/api-keys.md oanda
136 website/content/sdk/usage/guides/api-keys.md website/content/sdk/usage/api-keys.md change
137 website/content/sdk/usage/guides/api-keys.md website/content/sdk/usage/api-keys.md fmp
138 website/content/sdk/usage/guides/api-keys.md website/content/sdk/usage/api-keys.md mykeys
139 website/content/sdk/usage/guides/api-keys.md website/content/sdk/usage/api-keys.md to
140 website/content/sdk/usage/guides/api-keys.md website/content/sdk/usage/api-keys.md set
141 website/content/sdk/usage/guides/api-keys.md website/content/sdk/usage/api-keys.md news
142 website/content/sdk/usage/guides/api-keys.md website/content/sdk/usage/api-keys.md not defined
143 website/content/sdk/usage/guides/api-keys.md website/content/sdk/usage/api-keys.md keys
144 website/content/sdk/usage/guides/api-keys.md website/content/sdk/usage/api-keys.md stocks
145 website/content/sdk/usage/guides/api-keys.md website/content/sdk/usage/api-keys.md quote
146 website/content/sdk/usage/guides/api-keys.md website/content/sdk/usage/api-keys.md show
147 website/content/sdk/usage/guides/changing-sources.md stocks
148 website/content/sdk/usage/guides/changing-sources.md source
149 website/content/sdk/usage/guides/changing-sources.md load
300 website/content/terminal/usage/basics/index.md file
301 website/content/terminal/usage/basics/index.md load
302 website/content/terminal/usage/basics/index.md raw
303 website/content/terminal/usage/guides/api-keys.md website/content/terminal/usage/data/api-keys.md options
304 website/content/terminal/usage/guides/api-keys.md website/content/terminal/usage/data/api-keys.md fa
305 website/content/terminal/usage/guides/api-keys.md website/content/terminal/usage/data/api-keys.md keys
306 website/content/terminal/usage/guides/api-keys.md website/content/terminal/usage/data/api-keys.md stocks
307 website/content/terminal/usage/guides/api-keys.md website/content/terminal/usage/data/api-keys.md not defined
308 website/content/terminal/usage/guides/api-keys.md website/content/terminal/usage/data/api-keys.md show
309 website/content/terminal/usage/guides/api-keys.md website/content/terminal/usage/data/api-keys.md fred
310 website/content/terminal/usage/guides/api-keys.md website/content/terminal/usage/data/api-keys.md oanda
311 website/content/terminal/usage/guides/api-keys.md website/content/terminal/usage/data/api-keys.md news
312 website/content/terminal/usage/guides/api-keys.md website/content/terminal/usage/data/api-keys.md degiro
313 website/content/terminal/usage/guides/api-keys.md website/content/terminal/usage/data/api-keys.md fmp
314 website/content/terminal/usage/guides/api-keys.md website/content/terminal/usage/data/api-keys.md mykeys
315 website/content/terminal/usage/guides/changing-sources.md save
316 website/content/terminal/usage/guides/changing-sources.md raw
317 website/content/terminal/usage/guides/changing-sources.md ticker

View File

@@ -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"
]
}
}

View File

@@ -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
1 file command
25 website/content/sdk/usage/basics/index.md ta.donchian
26 website/content/sdk/usage/basics/index.md stocks.load
27 website/content/sdk/usage/basics/index.md etf.holdings
28 website/content/sdk/usage/guides/api-keys.md website/content/sdk/usage/api-keys.md keys.github
29 website/content/sdk/usage/guides/api-keys.md website/content/sdk/usage/api-keys.md keys.glassnode
30 website/content/sdk/usage/guides/api-keys.md website/content/sdk/usage/api-keys.md keys.fred
31 website/content/sdk/usage/guides/api-keys.md website/content/sdk/usage/api-keys.md keys.finnhub
32 website/content/sdk/usage/guides/api-keys.md website/content/sdk/usage/api-keys.md keys.eodhd
33 website/content/sdk/usage/guides/api-keys.md website/content/sdk/usage/api-keys.md keys.degiro
34 website/content/sdk/usage/guides/api-keys.md website/content/sdk/usage/api-keys.md keys.databento
35 website/content/sdk/usage/guides/api-keys.md website/content/sdk/usage/api-keys.md keys.quandl
36 website/content/sdk/usage/guides/api-keys.md website/content/sdk/usage/api-keys.md keys.oanda
37 website/content/sdk/usage/guides/api-keys.md website/content/sdk/usage/api-keys.md keys.polygon
38 website/content/sdk/usage/guides/api-keys.md website/content/sdk/usage/api-keys.md keys.cpanic
39 website/content/sdk/usage/guides/api-keys.md website/content/sdk/usage/api-keys.md keys.santiment
40 website/content/sdk/usage/guides/api-keys.md website/content/sdk/usage/api-keys.md keys.stocksera
41 website/content/sdk/usage/guides/api-keys.md website/content/sdk/usage/api-keys.md keys.tokenterminal
42 website/content/sdk/usage/guides/api-keys.md website/content/sdk/usage/api-keys.md keys.tradier
43 website/content/sdk/usage/guides/api-keys.md website/content/sdk/usage/api-keys.md keys.walert
44 website/content/sdk/usage/guides/api-keys.md website/content/sdk/usage/api-keys.md stocks.quote
45 website/content/sdk/usage/guides/api-keys.md website/content/sdk/usage/api-keys.md keys.news
46 website/content/sdk/usage/guides/api-keys.md website/content/sdk/usage/api-keys.md keys.coinglass
47 website/content/sdk/usage/guides/api-keys.md website/content/sdk/usage/api-keys.md keys.messari
48 website/content/sdk/usage/guides/api-keys.md website/content/sdk/usage/api-keys.md keys.cmc
49 website/content/sdk/usage/guides/api-keys.md website/content/sdk/usage/api-keys.md keys.fmp
50 website/content/sdk/usage/guides/api-keys.md website/content/sdk/usage/api-keys.md keys.mykeys
51 website/content/sdk/usage/guides/api-keys.md website/content/sdk/usage/api-keys.md keys.reddit
52 website/content/sdk/usage/guides/api-keys.md website/content/sdk/usage/api-keys.md keys.coinbase
53 website/content/sdk/usage/guides/api-keys.md website/content/sdk/usage/api-keys.md news
54 website/content/sdk/usage/guides/api-keys.md website/content/sdk/usage/api-keys.md keys.av
55 website/content/sdk/usage/guides/api-keys.md website/content/sdk/usage/api-keys.md keys.binance
56 website/content/sdk/usage/guides/api-keys.md website/content/sdk/usage/api-keys.md keys.bitquery
57 website/content/sdk/usage/guides/changing-sources.md stocks.load
58 website/content/sdk/usage/intros/alternative.md alt.covid.slopes
59 website/content/sdk/usage/intros/alternative.md alt.covid.global_deaths
110 website/content/sdk/usage/intros/ta.md ta.rsi
111 website/content/sdk/usage/intros/ta.md stocks.load
112 website/content/sdk/usage/intros/ta.md ta.donchian
113 website/content/terminal/usage/guides/api-keys.md website/content/terminal/usage/data/api-keys.md news

View File

@@ -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"
]
}
}

View File

@@ -22,12 +22,12 @@ EN_FILE = I18N_DICT_LOCATION / "en.yml"
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"

View File

@@ -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

View File

@@ -28,10 +28,24 @@ import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
<HeadTitle title="OpenBB Bot Docs" />
OpenBB Bot is a chatting bot for Discord and Telegram which provides access to high quality financial data for both individual investors and online communities.
With OpenBB Bot, we offer free access to hundreds of commands ranging from stock data, options, screeners, darkpool info, crypto, nft, short data, and more!
OpenBB Bot was created to give individual users access to high quality financial data. We know our users love to invest and they also want to be part of a community and share ideas with their friends quickly and easily. Our Bot allows quick access to actionable market data to make you and your community better informed investors.
Looking for investment research data and sharing it with your community has never been easier than with the OpenBB Bot. Our bot delivers high-quality data directly to your fingertips, promoting engagement and learning among your peers. Share your investment ideas and strategies with your friends and colleagues seamlessly by accessing the data you need through a simple text message. The OpenBB Bot is the perfect tool for collaborative investment research that helps you make informed decisions and achieve success.
<img width="819" alt="bot" src="https://github.com/OpenBB-finance/OpenBBTerminal/assets/25267873/f65788ea-cab6-40a2-a1d9-282051a27083" />
---
- **Investment discussions at 10x speed**
Say goodbye to the hassle of switching tabs or opening browsers just to share screenshots of market data with your friends. With the OpenBB Bot, you can access real-time market data instantly by using a simple bot command. Our bot allows you to visualize data easily within your preferred chatting platform, so you can keep up with the latest market trends without ever having to leave the chat window.
- **Chatting through multiple platforms**
Discover the power of the OpenBB Bot on Discord and Telegram, and stay tuned for new platform releases. We are always working to expand our reach, and are committed to bringing the OpenBB Bot to a wider audience. Our goal is to provide convenient access to investment research data for all users, and we are excited to announce that more platforms will be added in the near future. Keep an eye out for updates on new platform availability, and join us as we continue to revolutionize the way you access investment data.
- **Available on desktop, mobile or tablet**
By utilizing the chatting platform as the user interface, OpenBB Bot enables users access to investment research data on any device that is supported by the platform. This means that whether you are on your desktop, laptop, tablet, or smartphone, you can conveniently access the bot's research data without any additional software or hardware requirements. Enjoy seamless access to valuable investment insights across all your devices, anytime and anywhere.
- **Customizable for your community**
The OpenBB Bot provides users and server owners with the ability to personalize the bot according to their preferences. With a wide range of customization options, you can alter the color scheme, set up a watchlist, configure technical analysis indicators on your charts, and even schedule automatic market data posts. From market opening to closing, the OpenBB Bot has you covered with its flexible features and robust functionality.

4
website/content/pro/_category_.json vendored Normal file
View File

@@ -0,0 +1,4 @@
{
"label": "OpenBB Terminal Pro",
"position": 0
}

View File

@@ -1,8 +1,25 @@
---
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
---
# Advanced Search
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
<HeadTitle title="Advanced Search | OpenBB Terminal Pro Docs" />
<img width="1455" alt="275681118-b5ed496a-5822-49c9-bc56-958dab886f59" src="https://github.com/OpenBB-finance/OpenBBTerminal/assets/25267873/b10a013f-ad07-4ea6-ac55-17236b249bb2"/>
@@ -21,4 +38,3 @@ The search is divided into six main categories:
* **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.

View File

@@ -1,8 +1,23 @@
---
sidebar_position: 2
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
---
# Copilot
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
<HeadTitle title="Copilot | OpenBB Terminal Pro Docs" />
OpenBB copilot is your companion to interact with the OpenBB Terminal Pro.

View File

@@ -1,4 +0,0 @@
{
"label": "Copilot",
"position": 7
}

View File

@@ -1,8 +1,21 @@
---
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: Docs
- Folder creation
- Dashboard creation
- Investment research
- Dashboard organization
- Dashboard settings
- Move dashboard to folder
---
# Folders
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
<HeadTitle title="Folders | OpenBB Terminal Pro Docs" />
On the sidebar, users have a plus icon where they are able to create a new dashboard or folder.

View File

@@ -1,8 +1,22 @@
---
sidebar_position: 2
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
---
# Grouping Mechanism
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
<HeadTitle title="Grouping | OpenBB Terminal Pro Docs" />
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.

View File

@@ -1,8 +1,22 @@
---
sidebar_position: 3
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: Documentation
- Dashboard Usage
- Data Visualization
- Add Widgets
- Manage Dashboards
- Dashboard export
- Dashboard settings
- Create new dashboard
---
# Dashboards
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
<HeadTitle title="Dashboards | OpenBB Terminal Pro Docs" />
<img width="1443" alt="275685305-db3b650a-5e33-4709-acc7-0f86f9522c06" src="https://github.com/OpenBB-finance/OpenBBTerminal/assets/25267873/e5f957db-3cf8-4873-9629-1fed0f08f2c7"/>
@@ -41,4 +55,3 @@ This allows to:
<img width="223" alt="275686811-6d7daa4d-6b09-4eb9-8972-626950fc7f6d" src="https://github.com/OpenBB-finance/OpenBBTerminal/assets/25267873/2bf5b35f-3522-4512-aac7-bc9bec178b00"/>
Which allows the creation of a new dashboard, or a new folder.

View File

@@ -1,8 +1,20 @@
---
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
---
# Report
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
<HeadTitle title="Report | OpenBB Terminal Pro Docs" />
<img width="1443" alt="275687043-c79f8643-3c34-43fd-bc77-a53384471e7b" src="https://github.com/OpenBB-finance/OpenBBTerminal/assets/25267873/9360faa9-1a46-43f9-8568-490ef5c1c5a1"/>

View File

@@ -1,8 +1,21 @@
---
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
---
# Templates
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
<HeadTitle title="Templates | OpenBB Terminal Pro Docs" />
<img width="1448" alt="275687647-683f47e3-0ad6-45bc-a026-01884cfabd3f" src="https://github.com/OpenBB-finance/OpenBBTerminal/assets/25267873/54e82c79-92d0-4e71-8f89-9e04c3e983d3"/>

View File

@@ -1,4 +1,4 @@
{
"label": "Getting started",
"position": 1
}
}

View File

@@ -1,8 +1,22 @@
---
sidebar_position: 2
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
---
# Getting Started with OpenBB Terminal Pro Free Trial
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
<HeadTitle title="Free Trial | OpenBB Terminal Pro Docs" />
To unlock the powerful features of **OpenBB Terminal Pro**, follow these steps:
@@ -10,19 +24,18 @@ To unlock the powerful features of **OpenBB Terminal Pro**, follow these steps:
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
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, please contact us.
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.

View File

@@ -1,4 +0,0 @@
{
"label": "Free trial",
"position": 1
}

View File

@@ -1,13 +0,0 @@
---
sidebar_position: 2
---
# Getting Started
Search and navigation
Navigation Sidebar
Main menu
Settings

View File

@@ -1,8 +1,25 @@
---
sidebar_position: 2
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
---
# Quick Start Guide
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
<HeadTitle title="Getting Started | OpenBB Terminal Pro Docs" />
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.

View File

@@ -1,4 +0,0 @@
{
"label": "Quick Start",
"position": 2
}

View File

@@ -1,5 +1,79 @@
---
sidebar_position: 1
title: OpenBB Terminal Pro
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
---
# OpenBB Pro
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
<HeadTitle title="OpenBB Terminal Pro Docs" />
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.
<div style={{position: 'relative', paddingBottom: '56.25%', height: '0', overflow: 'hidden', maxWidth: '100%'}}>
<iframe
style={{position: 'absolute', top: '0', left: '0', width: '100%', height: '100%', display: 'block', margin: '0 auto'}}
src="https://www.youtube.com/embed/9EEI4uce5Bs?si=us54nvFmBtfqe4Tz"
title="YouTube video player"
frameBorder="0"
allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share"
allowFullScreen>
</iframe>
</div>
---
- **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.

View File

@@ -1,8 +1,30 @@
---
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
---
# Charting
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
<HeadTitle title="Charting | OpenBB Terminal Pro Docs" />
<img width="1791" alt="273497041-34665daf-a145-44c5-ab1e-285c34d29bda" src="https://github.com/OpenBB-finance/OpenBBTerminal/assets/25267873/0044f3c9-c6ce-4880-8022-84be12fec05f" />

View File

@@ -1,4 +0,0 @@
{
"label": "Charting",
"position": 3
}

View File

@@ -1,9 +1,25 @@
---
title: Introduction
sidebar_position: 1
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
---
# Data Connectors
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
<HeadTitle title="Data Connectors | OpenBB Terminal Pro Docs" />
<img width="1785" alt="273497891-d9436d87-422c-4d73-a81c-bdc746695a28" src="https://github.com/OpenBB-finance/OpenBBTerminal/assets/25267873/f06f340b-0150-4475-baae-69a28a8d4493"/>

View File

@@ -1,8 +1,27 @@
---
sidebar_position: 4
title: Integrate your own backend
sidebar_position: 2
description: Learn how to integrate your own backend with OpenBB Terminal Pro using
the cookie-cutter or language-agnostic API approaches, with illustrative guides
and principles for handling widget.json files, APIs, interfaces, Python, FastAPI
and more.
keywords: Docs
- OpenBB cookie-cutter
- widgets.json
- OpenBB API
- Endpoint integration
- widget configuration
- Language-Agnostic API
- API implementation
- Python
- FastAPI
- Terminal Pro widgets
- Widget definitions
---
# Integrate your own backend
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
<HeadTitle title="Integrate your own backend | OpenBB Terminal Pro Docs" />
## Using OpenBB Cookie-Cutter

View File

@@ -1,8 +1,22 @@
---
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
---
# Integrating Third-party Data Providers
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
<HeadTitle title="Native Integrations | OpenBB Terminal Pro Docs" />
OpenBB Terminal Pro allows seamless integration with two types of third-party data providers.

View File

@@ -1,8 +1,25 @@
---
sidebar_position: 2
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
---
# Single Widget
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
<HeadTitle title="Single Widget | OpenBB Terminal Pro Docs" />
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.

View File

@@ -1,4 +0,0 @@
{
"label": "Home",
"position": 1
}

View File

@@ -1,12 +1,28 @@
---
sidebar_position: 2
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
---
# Home
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
<HeadTitle title="Homepage | OpenBB Terminal Pro Docs" />
<img width="1792" alt="273495206-3e6e9b81-41fd-499a-b026-defe7baab5d7" src="https://github.com/OpenBB-finance/OpenBBTerminal/assets/25267873/9be1e003-5aec-41b8-a400-b897646fd907"/>
Welcome to the home of OpenBB Terminal Pro, your one-stop hub for all things related to the terminal. Here's what you can find:
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.

View File

@@ -1,16 +1,39 @@
---
sidebar_position: 3
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
---
# Main Menu
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
<HeadTitle title="Main Menu | OpenBB Terminal Pro Docs" />
<img width="1467" alt="275680163-74bdd6f4-f54d-4ff2-8db0-75c075854e3f" src="https://github.com/OpenBB-finance/OpenBBTerminal/assets/25267873/03b201eb-6abb-4a50-a6b2-df1f37c3c8a1"/>
The main menu is your gateway to the powerful features of the OpenBB Terminal Pro. It comprises four key sections:
* **Home**: This is your dashboard, where you'll find the latest updates and insights from the OpenBB team.
* **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.
* **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.

View File

@@ -1,12 +1,25 @@
---
sidebar_position: 5
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
---
# News
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
<HeadTitle title="News | OpenBB Terminal Pro Docs" />
<img width="1792" alt="273495463-5d5ed1cf-f108-469d-9c36-94aa982e6944" src="https://github.com/OpenBB-finance/OpenBBTerminal/assets/25267873/d1785ad7-7a5d-4c70-949f-795ce7f875e8"/>
Welcome to the News section of OpenBB Terminal Pro. This is your hub for staying updated with the latest financial news and market trends.
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.

View File

@@ -1,4 +0,0 @@
{
"label": "News",
"position": 2
}

View File

@@ -1,4 +0,0 @@
{
"label": "Search",
"position": 6
}

13
website/content/pro/settings.md vendored Normal file
View File

@@ -0,0 +1,13 @@
---
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';
<HeadTitle title="Settings | OpenBB Terminal Pro Docs" />

View File

@@ -1,4 +0,0 @@
{
"label": "Settings",
"position": 2
}

View File

@@ -1,6 +0,0 @@
---
sidebar_position: 2
---
# Settings

View File

@@ -1,5 +1,15 @@
---
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

View File

@@ -1,4 +1,4 @@
{
"label": "Widgets",
"position": 4
}
}

View File

@@ -1,8 +1,22 @@
---
sidebar_position: 3
title: Chat with widgets
sidebar_position: 0
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
---
# Engage with the Chat Widget
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
<HeadTitle title="Chat with widgets | OpenBB Terminal Pro Docs" />
<img width="614" alt="275683124-b19067d7-abf1-4efb-9abb-93bb7bc3b03d" src="https://github.com/OpenBB-finance/OpenBBTerminal/assets/25267873/6f180d91-207a-4a37-86a8-ba78969f6e0a"/>

View File

@@ -1,8 +1,24 @@
---
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
---
# Data Providers
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
<HeadTitle title="Data Provider | OpenBB Terminal Pro Docs" />
<img width="1455" alt="275681258-09d976c7-7c3f-417f-9c86-14bd5659bfab" src="https://github.com/OpenBB-finance/OpenBBTerminal/assets/25267873/071d79ae-1410-4918-ac40-294b54b6068a"/>

View File

@@ -1,9 +1,34 @@
---
sidebar_position: 1
title: Introduction
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: Docs
- 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
---
# Widgets
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
<HeadTitle title="Widgets | OpenBB Terminal Pro Docs" />
<img width="616" alt="275681758-87fda536-c62c-4b3b-a6c0-42b4b2a3a3cc" src="https://github.com/OpenBB-finance/OpenBBTerminal/assets/25267873/42b9321b-2912-4853-af1e-abb256573fec"/>

View File

@@ -1,8 +1,20 @@
---
sidebar_position: 2
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
---
# Visualizing Data with Charts
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
<HeadTitle title="Chart from raw data | OpenBB Terminal Pro Docs" />
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.

View File

@@ -1,8 +1,24 @@
---
sidebar_position: 3
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
---
# Forecasting
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
<HeadTitle title="Forecasting | OpenBB Terminal Pro Docs" />
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.

View File

@@ -1,8 +1,25 @@
---
sidebar_position: 1
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
---
# Data Manipulation
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
<HeadTitle title="Tabular Data | OpenBB Terminal Pro Docs" />
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.

View File

@@ -27,7 +27,7 @@ Please note that OpenBB does not provide any data, it is an aggregator which pro
<details><summary>Is there a list of all data providers?</summary>
The complete list is found [here](/terminal/usage/guides/api-keys)
The complete list is found [here](/terminal/usage/data/api-keys)
</details>

View File

@@ -19,12 +19,24 @@ import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
<HeadTitle title="OpenBB SDK Docs" />
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 library of extensions, you can focus on designing and building your financial reports and applications.
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.
<img width="769" alt="sdk" src="https://github.com/OpenBB-finance/OpenBBTerminal/assets/25267873/3ae6ad4d-d90b-4555-8712-c94a048285d5" />
---
Want to contribute? Check out our CONTRIBUTING GUIDELINES.
- **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).

View File

@@ -26,7 +26,7 @@ The Behavioural Analysis menu offers the user tools for gauging the overall publ
### How to use
Some data sources will require a valid API key, which can be obtained for free and then set using the [Keys menu](/terminal/usage/guides/api-keys). As with every command, using the `-h` argument displays the help dialogue. Running the <a href="/terminal/reference/stocks/ba/headlines/" target="_blank" rel="noreferrer noopener">headlines</a> command returns the following:
Some data sources will require a valid API key, which can be obtained for free and then set using the [Keys menu](/terminal/usage/data/api-keys). As with every command, using the `-h` argument displays the help dialogue. Running the <a href="/terminal/reference/stocks/ba/headlines/" target="_blank" rel="noreferrer noopener">headlines</a> command returns the following:
```
(🦋) /stocks/ba/ $ headlines

View File

@@ -585,7 +585,7 @@ wp.year.1987 0.1348 0.0817 1.6504 0.0989 -0.0253 0.2950
Doing research both as a student or professor for a university or as a professional often requires the findings to be easily replicated. Furthermore, as many steps could be required it can be very beneficial to have the ability to make small adjustments without needing to re-do every single step again. This is where `.openbb` files play an important role.
By going to the main menu as depicted below, the `exe` command can be used. With this command you can run `.openbb` scripts that automatically run a set of commands similarly to that of the Stata do-files and SPSS syntax files. These scripts are located where the application is located inside the `routines` folder. Please find a more elaborate explanation in the [Scripts & Routines Guide](/terminal/usage/guides/scripts-and-routines).
By going to the main menu as depicted below, the `exe` command can be used. With this command you can run `.openbb` scripts that automatically run a set of commands similarly to that of the Stata do-files and SPSS syntax files. These scripts are located where the application is located inside the `routines` folder. Please find a more elaborate explanation in the [Scripts & Routines Guide](/terminal/usage/routines/introduction-to-routines).
This demo file has the following contents:

View File

@@ -35,7 +35,7 @@ import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
<HeadTitle title="Economy - Data Available | OpenBB Terminal Docs" />
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/guides/api-keys).
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

View File

@@ -25,7 +25,7 @@ The Fixed Income menu is the high-level menu for the Fixed Income asset class. I
## How to Use
The Fixed Income menu can be accessed directly from the `home` screen by typing `fixedincome`. This opens the menu as shown below. The menu heavily relies on FRED to obtain the data as seen below, please refer to the [API keys guide](/terminal/usage/guides/api-keys) for information on how to obtain and set a key for FRED.
The Fixed Income menu can be accessed directly from the `home` screen by typing `fixedincome`. This opens the menu as shown below. The menu heavily relies on FRED to obtain the data as seen below, please refer to the [API keys guide](/terminal/usage/data/api-keys) for information on how to obtain and set a key for FRED.
![Fixed Income Menu](https://user-images.githubusercontent.com/46355364/220970904-d32a63b5-aa14-47b4-bfe6-b5efc1cf2cd4.png)

View File

@@ -463,7 +463,7 @@ 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/guides/scripts-and-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.
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

View File

@@ -17,7 +17,7 @@ The purpose of this menu is to provide the user with tools for gauging the level
<img width="800" alt="image" src="https://user-images.githubusercontent.com/46355364/218979380-df541217-ecc3-4a4c-b23b-4fcfe891f69f.png"></img>
To use every feature in the Dark Pools menu, an API key for <a href="https://www.quandl.com/" target="_blank" rel="noreferrer noopener">Quandl</a> must be obtained (for free) and authorized on the local installation. See the <a href="/terminal/usage/guides/api-keys" target="_blank" rel="noreferrer noopener">Setting API Keys Guide</a> for help setting up the API keys in the OpenBB Terminal. The four commands at the bottom of the menu rely on a loaded ticker while the six above do not.
To use every feature in the Dark Pools menu, an API key for <a href="https://www.quandl.com/" target="_blank" rel="noreferrer noopener">Quandl</a> must be obtained (for free) and authorized on the local installation. See the <a href="/terminal/usage/data/api-keys" target="_blank" rel="noreferrer noopener">Setting API Keys Guide</a> for help setting up the API keys in the OpenBB Terminal. The four commands at the bottom of the menu rely on a loaded ticker while the six above do not.
### How to use

View File

@@ -88,7 +88,7 @@ options:
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/guides/changing-sources). To select the `source` as `Ultima`, use the syntax below.
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
@@ -106,7 +106,7 @@ Furthermore, Walmart is subject to laws and regulations related to competition a
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/guides/api-keys) for links to obtain each.
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

View File

@@ -24,7 +24,7 @@ Please note that OpenBB does not provide any data, it is an aggregator which pro
<details><summary>Is there a list of all data providers?</summary>
The complete list is found [here](/terminal/usage/guides/api-keys)
The complete list is found [here](/terminal/usage/data/api-keys)
</details>

View File

@@ -83,13 +83,13 @@ See the guide [here](/sdk/data-available/portfolio/introduction) for more inform
<details><summary>How do I change the chart styles?</summary>
See the guide [here](/terminal/usage/guides/customizing-the-terminal#styles). 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.
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.
</details>
<details><summary>Can I change the colors of the text in the Terminal?</summary>
Yes, use the `colors` command under the `/settings` menu: [/terminal/usage/guides/customizing-the-terminal](/terminal/usage/guides/customizing-the-terminal)
Yes, use the `colors` command under the `/settings` menu: [/terminal/usage/overview/customizing-the-terminal](/terminal/usage/overview/customizing-the-terminal)
</details>

View File

@@ -20,24 +20,27 @@ import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
<HeadTitle title="OpenBB Terminal Docs" />
OpenBB is a leading open source investment research software platform for accessing and analyzing financial market data. We represent millions of investors who want to leverage state-of-the-art data science and machine learning technologies to make sense of raw unrefined data. Our mission is to make investment research effective, powerful and accessible to everyone.
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.
<img width="806" alt="terminal" src="https://github.com/OpenBB-finance/OpenBBTerminal/assets/25267873/0140f6e6-4a16-4b9a-80af-8b6378a5f9e0" />
---
- **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.
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 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.
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.
---

View File

@@ -39,7 +39,7 @@ import TutorialVideo from '@site/src/components/General/TutorialVideo.tsx';
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/guides/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).
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
@@ -77,7 +77,7 @@ optional arguments:
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/basics/advanced/api-keys).
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)
@@ -91,7 +91,7 @@ The default data vendor can be selected with more ease through the OpenBB Hub. I
### 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/guides/changing-sources) menu.
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:

View File

@@ -56,7 +56,7 @@ When you select the `xlsx` option, you can also specify the sheet name with `--s
(🦋) /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/guides/api-keys).
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

12
website/pnpm-lock.yaml generated vendored
View File

@@ -59,6 +59,9 @@ dependencies:
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':
@@ -8697,6 +8700,15 @@ packages:
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'}

View File

@@ -14,35 +14,28 @@ export default function TutorialVideo(
return (
<div style={{textAlign: 'center'}}>
<div className="flex flex-row items-center justify-center">
<p className="mr-2">{videoLegend}</p>
<div className="flex flex-col sm:flex-row items-center justify-center">
<p>{videoLegend}</p>
<div style={{transform: 'scale(0.7)'}}>
<Toggle
isOn={isOn}
handleChange={() => {
const x = document.getElementById(youtubeLink);
if (x.style.display === 'none') {
x.style.display = 'block';
setIsOn(true);
} else {
x.style.display = 'none';
setIsOn(false);
}
}}
handleChange={() => setIsOn(!isOn)}
/>
</div>
</div>
<iframe
id={youtubeLink} // this makes it so that the ID is unique and I can have to vids per page
width="560"
height="315"
style={{display: 'block', margin: '0 auto'}}
src={youtubeLink}
title="YouTube video player"
frameBorder="0"
allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share"
allowFullScreen>
</iframe>
{isOn && (
<div style={{position: 'relative', paddingBottom: '56.25%', height: '0', overflow: 'hidden', maxWidth: '100%'}}>
<iframe
id={youtubeLink} // this makes it so that the ID is unique and I can have to vids per page
style={{position: 'absolute', top: '0', left: '0', width: '100%', height: '100%', display: 'block', margin: '0 auto'}}
src={youtubeLink}
title="YouTube video player"
frameBorder="0"
allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share"
allowFullScreen>
</iframe>
</div>
)}
</div>
);
}

View File

@@ -29,7 +29,7 @@ function shouldHideItem(item, productPath) {
export default function DocSidebarItem({ item, ...props }) {
const { isIFrame } = useIFrameContext();
const { pathname } = useLocation();
const isPro = pathname.startsWith("/pro")
const isPro = pathname.startsWith("/pro");
if (isIFrame) {
const firstTwoPathSegments = pathname.split("/").slice(0, 3).join("/");
@@ -39,14 +39,10 @@ export default function DocSidebarItem({ item, ...props }) {
}
}
if(isPro) {
if(!item.href?.startsWith("/pro")) {
return null;
}
} else {
if(item.href?.startsWith("/pro")) {
return null;
}
if (isPro && !checkIfAnyChildIsPro(item)) {
return null;
} else if (!isPro && item.href?.startsWith("/pro")) {
return null;
}
switch (item.type) {
@@ -59,3 +55,19 @@ export default function DocSidebarItem({ item, ...props }) {
return <DocSidebarItemLink item={item} {...props} />;
}
}
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;
}

View File

@@ -10,9 +10,10 @@ function getLogo(type) {
export default function NavbarLogo() {
const { pathname } = useLocation();
const type = pathname.length > 1 ? pathname.split("/")[1] : "home";
return (
<div className="flex items-center gap-x-[56px]">
<Link to="/" className="mb-1 md:mb-0 md:ml-0">
<Link to={`/${type}`} className="mb-1 md:mb-0 md:ml-0">
{getLogo(type)}
</Link>
</div>

View File

@@ -17,7 +17,7 @@
"import fileinput\n",
"import re\n",
"\n",
"openai.api_key = \"<API KEY HERE>\""
"openai.api_key = \"<YOUR_API_KEY>\""
]
},
{
@@ -78,7 +78,7 @@
"\n",
"instructor.patch()\n",
"\n",
"for product in [\"terminal\", \"platform\", \"bot\", \"SDK\"]:\n",
"for product in [\"../content/pro\"]:\n",
" for root, dirs, files in os.walk(product):\n",
" for file in files:\n",
" if file.endswith(\".md\"):\n",
@@ -156,12 +156,14 @@
" f.write('---\\n')\n",
"\n",
" # Write the HeadTitle component if it is not the index.md file\n",
" '''\n",
" if \"index.md\" not in filename.split('/'):\n",
" f.write(f\"\"\"\n",
"import HeadTitle from '@site/src/components/General/HeadTitle.tsx';\n",
"\n",
"<HeadTitle title=\"{metadata['title']} - {' - '.join([word.title().replace('-', ' ') for word in filename.split('/')[::-1][1:]])} | OpenBB Docs\" />\n",
"\"\"\")\n",
" '''\n",
" # Write the content after the front matter\n",
" f.write(content)"
]

11018
website/yarn.lock vendored

File diff suppressed because it is too large Load Diff