mirror of
https://github.com/OpenBB-finance/OpenBB.git
synced 2026-11-03 16:02:04 +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>
47 lines
1.4 KiB
Markdown
Vendored
47 lines
1.4 KiB
Markdown
Vendored
---
|
|
title: pos
|
|
description: This documentation page is about getting dark pool short positions using
|
|
the 'pos' function in the openbb.stocks.dps python package. Details about parameters
|
|
such as 'sortby' and 'ascend', and the data returned, i.e., pd.DataFrame, are provided.
|
|
keywords:
|
|
- pos
|
|
- dark pool short positions
|
|
- Stockgrid
|
|
- coding
|
|
- openbb.stocks.dps.pos
|
|
- parameters
|
|
- returns
|
|
- Data in ascending order
|
|
---
|
|
|
|
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
|
|
|
|
<HeadTitle title="stocks.dps.pos - Reference | OpenBB SDK Docs" />
|
|
|
|
Get dark pool short positions. [Source: Stockgrid]
|
|
|
|
Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/stocks/dark_pool_shorts/stockgrid_model.py#L18)]
|
|
|
|
```python
|
|
openbb.stocks.dps.pos(sortby: str = "dpp_dollar", ascend: bool = False)
|
|
```
|
|
|
|
---
|
|
|
|
## Parameters
|
|
|
|
| Name | Type | Description | Default | Optional |
|
|
| ---- | ---- | ----------- | ------- | -------- |
|
|
| sortby | str | Field for which to sort by, where 'sv': Short Vol. [1M],<br/>'sv_pct': Short Vol. %%, 'nsv': Net Short Vol. [1M],<br/>'nsv_dollar': Net Short Vol. ($100M), 'dpp': DP Position [1M],<br/>'dpp_dollar': DP Position ($1B) | dpp_dollar | True |
|
|
| ascend | bool | Data in ascending order | False | True |
|
|
|
|
|
|
---
|
|
|
|
## Returns
|
|
|
|
| Type | Description |
|
|
| ---- | ----------- |
|
|
| pd.DataFrame | Dark pool short position data |
|
|
---
|