jerry/OpenBB
1
0
Fork 0
mirror of https://github.com/OpenBB-finance/OpenBB.git synced 2026-11-03 07:51:49 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
cd08218c35aed534ad59309ff2ca99d08e94de6a
OpenBB/website/content/sdk/reference/stocks/dps/pos.md
DidierRLopes 4ad995fdd0 Docs/terminalpro and improvement (#5622) 
* 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>
2023-10-30 21:01:29 +00:00

1.4 KiB
Vendored
Raw Blame History

title, description, keywords
title description keywords
pos 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.
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';

Get dark pool short positions. [Source: Stockgrid]

Source Code: [link]

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],
'sv_pct': Short Vol. %%, 'nsv': Net Short Vol. [1M],
'nsv_dollar': Net Short Vol. ($100M), 'dpp': DP Position [1M],
'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