Files
OpenBB/website/content/terminal/reference/stocks/dps/prom.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

40 lines
1.1 KiB
Markdown
Vendored

---
title: prom
description: Display dark pool (ATS) data of tickers with growing trades activity
using linear regression. Filter and process data from different tiers.
keywords:
- prom
- dark pool
- ATS data
- trade activity
- linear regression
- data filtering
- tier processing
---
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
<HeadTitle title="stocks/dps/prom - Reference | OpenBB Terminal Docs" />
Display dark pool (ATS) data of tickers with growing trades activity using linear regression.
### Usage
```python
prom [-n N_NUM] [-l LIMIT] [-t {T1,T2,OTCE}]
```
---
## Parameters
| Name | Description | Default | Optional | Choices |
| ---- | ----------- | ------- | -------- | ------- |
| n_num | Number of tickers to filter from entire ATS data based on the sum of the total weekly shares quantity. | 1000 | True | None |
| limit | Limit of most promising tickers to display. | 10 | True | None |
| tier | Tier to process data from. | | True | T1, T2, OTCE |
![prom](https://user-images.githubusercontent.com/46355364/154076323-2d031477-a70d-4065-b649-c8493fecdcbc.png)
---