mirror of
https://github.com/OpenBB-finance/OpenBB.git
synced 2026-11-07 01:41:17 +00:00
2e7eb4c9b6
* 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>
34 lines
720 B
Markdown
Vendored
34 lines
720 B
Markdown
Vendored
---
|
|
title: sidtc
|
|
description: OpenBB SDK Function
|
|
---
|
|
|
|
# sidtc
|
|
|
|
Get short interest and days to cover. [Source: Stockgrid]
|
|
|
|
Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/stocks/dark_pool_shorts/stockgrid_model.py#L76)]
|
|
|
|
```python
|
|
openbb.stocks.dps.sidtc(sortby: str = "float")
|
|
```
|
|
|
|
---
|
|
|
|
## Parameters
|
|
|
|
| Name | Type | Description | Default | Optional |
|
|
| ---- | ---- | ----------- | ------- | -------- |
|
|
| sortby | str | Field for which to sort by, where 'float': Float Short %%,<br/>'dtc': Days to Cover, 'si': Short Interest | float | True |
|
|
|
|
|
|
---
|
|
|
|
## Returns
|
|
|
|
| Type | Description |
|
|
| ---- | ----------- |
|
|
| pd.DataFrame | Short interest and days to cover data |
|
|
---
|
|
|