jerry/OpenBB
1
0
Fork 0
mirror of https://github.com/OpenBB-finance/OpenBB.git synced 2026-11-01 23:12:21 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
f68929fa1efaa5e9abb7911029e287c975b37fd3
OpenBB/website/content/sdk/reference/stocks/dps/psi_sg.md
jose-donato 2e7eb4c9b6 New documentation website (#3526) 
* fix(docs): added margin between sections

* feat: removed unused files; updated ga

* fix: juan stuff doesnt work

* fix: random fix

* moon at noon

* fix: update docusaurus config

* Update controller_doc_classes.py

* fix: temp fix

* fix: temp fix

* Update controller_doc_classes.py

* fix: remove old content

* fix: taggfix

* init

* fix: styling and moved file

* Update generate_terminal_markdown.py

* fix: removed unused images

* fix: port new files

* Update generate_sdk_markdown.py

* Update controller_doc_classes.py

Co-authored-by: teh_coderer <me@tehcoderer.com>
2022-11-22 16:47:03 +00:00

1.8 KiB
Vendored
Raw Blame History

title, description
title description
psi_sg OpenBB SDK Function

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

psi_sg

Get price vs short interest volume. [Source: Stockgrid]

Source Code: [link]

openbb.stocks.dps.psi_sg(symbol: str)

Parameters

Name Type Description Default Optional
symbol str Stock to get data from None False

Returns

Type Description
Tuple[pd.DataFrame, List] Short interest volume data, Price data

Plot price vs short interest volume. [Source: Stockgrid]

Source Code: [link]

openbb.stocks.dps.psi_sg_chart(symbol: str, limit: int = 84, raw: bool = False, export: str = "", external_axes: Optional[List[matplotlib.axes._axes.Axes]] = None)

Parameters

Name Type Description Default Optional
symbol str Stock to plot for None False
limit int Number of last open market days to show 84 True
raw bool Flag to print raw data instead False True
export str Export dataframe data to csv,json,xlsx file True
external_axes Optional[List[plt.Axes]] External axes (3 axes are expected in the list), by default None None True

Returns

This function does not return anything