jerry/OpenBB
1
0
Fork 0
mirror of https://github.com/OpenBB-finance/OpenBB.git synced 2026-11-03 16:02:04 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
cd08218c35aed534ad59309ff2ca99d08e94de6a
OpenBB/website/content/sdk/reference/stocks/options/pcr.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.5 KiB
Vendored
Raw Blame History

title, description, keywords
title description keywords
pcr Documentation for the 'pcr' function from the OpenBB Terminal platform. Contains model and chart views to get and display the put call ratio of certain stock options.
pcr function
put call ratio
stock options
AlphaQuery.com
Python code
function parameters
function return
docusaurus tabs

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

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

Gets put call ratio over last time window [Source: AlphaQuery.com]

Source Code: [link]

openbb.stocks.options.pcr(symbol: str, window: int = 30, start_date: Optional[str] = None)

Parameters

Name Type Description Default Optional
symbol str Ticker symbol to look for None False
window int Window to consider, by default 30 30 True
start_date Optional[str] Start date to plot (e.g., 2021-10-01), by default last 366 days None True

Returns

Type Description
pd.DataFrame Put call ratio

Examples

from openbb_terminal.sdk import openbb
pcr_df = openbb.stocks.options.pcr("B")

Display put call ratio [Source: AlphaQuery.com]

Source Code: [link]

openbb.stocks.options.pcr_chart(symbol: str, window: int = 30, start_date: str = "2021-11-24", export: str = "", external_axes: Optional[List[matplotlib.axes._axes.Axes]] = None)

Parameters

Name Type Description Default Optional
symbol str Stock ticker symbol None False
window int Window length to look at, by default 30 30 True
start_date str Starting date for data, by default (datetime.now() - timedelta(days=366)).strftime("%Y-%m-%d") 2021-11-24 True
export str Format to export data, by default "" 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