mirror of
https://github.com/OpenBB-finance/OpenBB.git
synced 2026-11-07 09:52:13 +00:00
79046608b6
* Update generate_terminal_markdown.py * updates * update workflows * Automated Change * tests * tests * Automated Change * Update test_generate_docs.py * Automated Change * updates * Automated Change * Update gen-docs.yml * Update test.yml * Automated Change * Update test.yml * Automated Change * Update generate_sdk_markdown.py * Automated Change * test * Automated Change * testtt23 * Automated Change * Update generate_sdk_markdown.py * Automated Change * Automated Change * added empting reference folders before autogen docs * updates * Automated Change * update tests gitactions * Automated Change * up * Automated Change * Automated Change * update pytest * Automated Change * tests * Automated Change * examples update * Automated Change * Update generate_sdk_markdown.py * Automated Change * Update test.yml * Update generate_sdk_markdown.py * strip * Automated Change * Workflow : check test update * Automated Change * Automated Change * Automated Change * Update test.yml * Automated Change * Update test.yml * Automated Change * Automated Change * up * Automated Change * Update generate_sdk_markdown.py * Automated Change * update workflows * fix guides * testing * Update gh-pages.yml * Update gh-pages.yml Co-authored-by: tehcoderer <tehcoderer@users.noreply.github.com> Co-authored-by: Jeroen Bouma <jer.bouma@gmail.com> Co-authored-by: Chavithra PARANA <chavithra@gmail.com> Co-authored-by: Chavithra <Chavithra@users.noreply.github.com> Co-authored-by: jose-donato <43375532+jose-donato@users.noreply.github.com> Co-authored-by: jose-donato <jose-donato@users.noreply.github.com>
1.2 KiB
Vendored
1.2 KiB
Vendored
title, description
| title | description |
|---|---|
| futures | OpenBB SDK Function |
futures
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")