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

2.1 KiB
Vendored

title, description, keywords
title description keywords
curve The documentation page provides detailed instructions on how to retrieve and display curve futures using the OpenBB Python library, with source code provided. The API functions interact with data from Yahoo Finance and include customization options for data representation and export format.
curve futures
Yahoo Finance
futures data
data visualization
matplotlib
API documentation

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

import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem';

Get curve futures [Source: Yahoo Finance]

Source Code: [link]

openbb.futures.curve(symbol: str = "")

Parameters

Name Type Description Default Optional
symbol str symbol to get forward curve True

Returns

Type Description
pd.DataFrame Dictionary with sector weightings allocation

Display curve futures [Source: Yahoo Finance]

Source Code: [link]

openbb.futures.curve_chart(symbol: str, raw: bool = False, export: str = "", external_axes: Optional[List[matplotlib.axes._axes.Axes]] = None)

Parameters

Name Type Description Default Optional
symbol str Curve future symbol to display None False
raw bool Display futures timeseries in raw format False True
export str Type of format to export data True
external_axes Optional[List[plt.Axes]] External axes (1 axis is expected in the list), by default None None True

Returns

This function does not return anything