mirror of
https://github.com/OpenBB-finance/OpenBB.git
synced 2026-11-02 07:23:25 +00:00
* 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>
1.9 KiB
Vendored
1.9 KiB
Vendored
title, description
| title | description |
|---|---|
| psi_q | OpenBB SDK Function |
import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem';
psi_q
Plots the short interest of a stock. This corresponds to the
Source Code: [link]
openbb.stocks.dps.psi_q(symbol: str, nyse: bool = False)
Parameters
| Name | Type | Description | Default | Optional |
|---|---|---|---|---|
| symbol | str | ticker to get short interest from | None | False |
| nyse | bool | data from NYSE if true, otherwise NASDAQ | False | True |
Returns
| Type | Description |
|---|---|
| pd.DataFrame | short interest volume data |
Plot the short interest of a stock. This corresponds to the
Source Code: [link]
openbb.stocks.dps.psi_q_chart(symbol: str, nyse: bool = False, limit: int = 10, raw: bool = False, export: str = "", external_axes: Optional[List[matplotlib.axes._axes.Axes]] = None)
Parameters
| Name | Type | Description | Default | Optional |
|---|---|---|---|---|
| symbol | str | ticker to get short interest from | None | False |
| nyse | bool | data from NYSE if true, otherwise NASDAQ | False | True |
| limit | int | Number of past days to show short interest | 10 | 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 (2 axes are expected in the list), by default None | None | True |
Returns
This function does not return anything