Files
OpenBB/website/content/sdk/reference/economy/futures.md
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

1.6 KiB
Vendored

title, description, keywords
title description keywords
futures This page provides information on how to retrieve and manipulate futures data using the OpenBB economy function. It includes examples and descriptions for parameters such as data source and future type.
economy
futures data
Finviz
WSJ
Indices
Energy
Metals
Meats
Grains
Softs
Bonds
Currencies

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

Get futures data.

Source Code: [link]

openbb.economy.futures(source: Any = "WSJ", future_type: str = "Indices")

Parameters

Name Type Description Default Optional
source str Data source for futures data. From the following: WSJ, Finviz WSJ True
future_type str (Finviz only) Future type to get. Can be: Indices, Energy, Metals, Meats, Grains, Softs, Bonds, Currencies. Indices True

Returns

Type Description
pd.DataFrame Dataframe of futures data.

Examples

from openbb_terminal.sdk import openbb
wsj_futures = openbb.economy.futures()
To sort by the largest percent change:
futures_sorted = openbb.economy.futures().sort_values(by="%Chg", ascending=False)
FinViz provides different options for future types.  We can get Meats with the following command:
meat_futures = openbb.economy.futures(source="Finviz", future_type="Meats")