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>
48 lines
1.1 KiB
Markdown
Vendored
48 lines
1.1 KiB
Markdown
Vendored
---
|
|
title: hsi
|
|
description: 'The hsi function returns a high short interest DataFrame. This OpenBB
|
|
finance function doesn''t require any parameters and provides key financial data
|
|
including: Ticker, Company, Exchange, ShortInt, Float, Outstd, and Industry. Ideal
|
|
for those interested in dark pool shorts and stock market data.'
|
|
keywords:
|
|
- hsi
|
|
- high short interest DataFrame
|
|
- OpenBB finance
|
|
- short interest
|
|
- dataframe
|
|
- dark pool shorts
|
|
- stock market
|
|
- financial data
|
|
- exchange
|
|
- company
|
|
- outstd
|
|
- industry
|
|
---
|
|
|
|
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
|
|
|
|
<HeadTitle title="stocks.dps.hsi - Reference | OpenBB SDK Docs" />
|
|
|
|
Returns a high short interest DataFrame
|
|
|
|
Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/stocks/dark_pool_shorts/shortinterest_model.py#L18)]
|
|
|
|
```python
|
|
openbb.stocks.dps.hsi()
|
|
```
|
|
|
|
---
|
|
|
|
## Parameters
|
|
|
|
This function does not take any parameters.
|
|
|
|
---
|
|
|
|
## Returns
|
|
|
|
| Type | Description |
|
|
| ---- | ----------- |
|
|
| DataFrame | High short interest Dataframe with the following columns:<br/>Ticker, Company, Exchange, ShortInt, Float, Outstd, Industry |
|
|
---
|