OpenBB/index_cmd.md at cd08218c35aed534ad59309ff2ca99d08e94de6a

mirror of https://github.com/OpenBB-finance/OpenBB.git synced 2026-11-02 23:41:27 +00:00

Files

DidierRLopes 4ad995fdd0 Docs/terminalpro and improvement (#5622 )

* add first iteration of content for Terminal Pro

* Update index.md

* Update dashboards.md

* Update folders.md

* Update grouping.md

* Update report.md

* Update templates.md

* Update quick-start.md

* Update index.md

* Update index.md

* Update home.md

* Update news.md

* Update index.md

* Update index.md

* Update index.md

* Update data-provider.md

* Update chat-with-widget.md

* Update data-manipulation.md

* Update forecasting.md

* fix: images self closing tags

* fix: only pro visitors can see pro

* inter font

* improve SEO content and restructuring

* add new package for toggle on tutorials

* move folder around

* improve main page of each prod

* small updates and improvements

* fix logo above

* small improvement in headtitle for portfolio funcs

* fix typos from OpenAI's GPT-4

* fix _category_ json

* remove generic SEO words

* add script that generates SEO for documentation

* add missing file

* remove sdk warning message

* fix links for andrew

---------

Co-authored-by: jose-donato <zmcdonato@gmail.com>
Co-authored-by: jose-donato <43375532+jose-donato@users.noreply.github.com>
Co-authored-by: andrewkenreich <andrew.kenreich@gmail.com>

2023-10-30 21:01:29 +00:00

2.3 KiB

Vendored

Raw Blame History

title, description, keywords

title

description

keywords

index

This page provides detailed information on how to obtain indices data and visualize it. The useful parameters and their respective descriptions are provided to ensure efficient data manipulation. Actual examples that illustrate the usage of the commands are included for better understanding.

Indices data

Data plot

Yahoo Finance

FinanceDatabase

Data intervals

Start date

End date

Data column

Data query

Compounded returns

import HeadTitle from '@site/src/components/General/HeadTitle.tsx';

Obtain any set of indices and plot them together. With the -si argument the major indices are shown. By using the arguments (for example 'nasdaq' and 'sp500') you can collect data and plot the graphs together. [Source: Yahoo finance / FinanceDatabase]

Usage

index [-i INDICES] [--show] [--interval {1m,2m,5m,15m,30m,60m,90m,1h,1d,5d,1wk,1mo,3mo}] [-s START_DATE] [-e END_DATE] [-c COLUMN] [-q QUERY] [-r]

Parameters

Name	Description	Default	Optional	Choices
indices	One or multiple indices	None	True	None
show_indices	Show the major indices, their arguments and ticker	False	True	None
interval	The preferred interval data is shown at. This can be 1m, 2m, 5m, 15m, 30m, 60m, 90m, 1h, 1d, 5d, 1wk, 1mo or 3mo	1d	True	1m, 2m, 5m, 15m, 30m, 60m, 90m, 1h, 1d, 5d, 1wk, 1mo, 3mo
start_date	The start date of the data (format: YEAR-MONTH-DAY, i.e. 2010-12-31)	2000-01-01	True	None
end_date	The end date of the data (format: YEAR-MONTH-DAY, i.e. 2021-06-20)	None	True	None
column	The column you wish to load in, by default this is the Adjusted Close column	Adj Close	True	None
query	Search for indices with given keyword	None	True	None
returns	Flag to show compounded returns over interval.	False	True	None

Examples

2022 Mar 15, 07:29 (🦋) /economy/ $ index nasdaq,dowjones

2.3 KiB Vendored Raw Blame History

Usage

Parameters

Examples

2.3 KiB

Vendored

Raw Blame History