mirror of
https://github.com/OpenBB-finance/OpenBB.git
synced 2026-11-03 07:51:49 +00:00
4ad995fdd0
* 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>
52 lines
1.3 KiB
Markdown
Vendored
52 lines
1.3 KiB
Markdown
Vendored
---
|
|
title: future
|
|
description: This page provides detailed documentation on how to use OpenBB's 'future'
|
|
function in Python script. It explains parameters and returns related to different
|
|
financial instruments.
|
|
keywords:
|
|
- OpenBB future function
|
|
- Python script
|
|
- financial instruments
|
|
- Indices
|
|
- Energy
|
|
- Metals
|
|
- Meats
|
|
- Grains
|
|
- Softs
|
|
- Bonds
|
|
- Currencies
|
|
- Finviz
|
|
---
|
|
|
|
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
|
|
|
|
<HeadTitle title="economy.future - Reference | OpenBB SDK Docs" />
|
|
|
|
Get futures data. [Source: Finviz]
|
|
|
|
Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/economy/finviz_model.py#L187)]
|
|
|
|
```python
|
|
openbb.economy.future(future_type: str = "Indices", sortby: str = "ticker", ascend: bool = False)
|
|
```
|
|
|
|
---
|
|
|
|
## Parameters
|
|
|
|
| Name | Type | Description | Default | Optional |
|
|
| ---- | ---- | ----------- | ------- | -------- |
|
|
| future_type | str | From the following: Indices, Energy, Metals, Meats, Grains, Softs, Bonds, Currencies | Indices | True |
|
|
| sortby | str | Column to sort by | ticker | True |
|
|
| ascend | bool | Flag to sort in ascending order | False | True |
|
|
|
|
|
|
---
|
|
|
|
## Returns
|
|
|
|
| Type | Description |
|
|
| ---- | ----------- |
|
|
| pd.Dataframe | Indices, Energy, Metals, Meats, Grains, Softs, Bonds, Currencies |
|
|
---
|