mirror of
https://github.com/OpenBB-finance/OpenBB.git
synced 2026-11-04 00:12:29 +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>
89 lines
2.7 KiB
Markdown
Vendored
89 lines
2.7 KiB
Markdown
Vendored
---
|
|
title: prom
|
|
description: 'This page provides a detailed explanation of two important functions
|
|
in FINRA ATS data analysis offered by our tool: ''prom'' and ''Chart''. ''prom''
|
|
fetches and processes the most promising stocks based on linear regression while
|
|
''Chart'' aids in visualizing the dark pool data for improving trading decisions.'
|
|
keywords:
|
|
- FINRA ATS data
|
|
- Trading tool
|
|
- Linear regression
|
|
- Dark pool data
|
|
- Dark pool trades activity
|
|
- Stocks analysis
|
|
- Data visualization
|
|
- Promising stocks
|
|
---
|
|
|
|
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
|
|
|
|
<HeadTitle title="stocks.dps.prom - Reference | OpenBB SDK Docs" />
|
|
|
|
import Tabs from '@theme/Tabs';
|
|
import TabItem from '@theme/TabItem';
|
|
|
|
<Tabs>
|
|
<TabItem value="model" label="Model" default>
|
|
|
|
Get all FINRA ATS data, and parse most promising tickers based on linear regression
|
|
|
|
Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/stocks/dark_pool_shorts/finra_model.py#L214)]
|
|
|
|
```python
|
|
openbb.stocks.dps.prom(limit: int = 1000, tier_ats: str = "T1")
|
|
```
|
|
|
|
---
|
|
|
|
## Parameters
|
|
|
|
| Name | Type | Description | Default | Optional |
|
|
| ---- | ---- | ----------- | ------- | -------- |
|
|
| limit | int | Number of tickers to filter from entire ATS data based on the sum of the total weekly shares quantity | 1000 | True |
|
|
| tier_ats | int | Tier to process data from: T1, T2 or OTCE | T1 | True |
|
|
|
|
|
|
---
|
|
|
|
## Returns
|
|
|
|
| Type | Description |
|
|
| ---- | ----------- |
|
|
| Tuple[pd.DataFrame, Dict] | Dark Pools (ATS) Data, Tickers from Dark Pools with better regression slope |
|
|
---
|
|
|
|
</TabItem>
|
|
<TabItem value="view" label="Chart">
|
|
|
|
Display dark pool (ATS) data of tickers with growing trades activity. [Source: FINRA]
|
|
|
|
Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/stocks/dark_pool_shorts/finra_view.py#L188)]
|
|
|
|
```python
|
|
openbb.stocks.dps.prom_chart(input_limit: int = 1000, limit: int = 10, tier: str = "T1", export: str = "", external_axes: Optional[List[matplotlib.axes._axes.Axes]] = None)
|
|
```
|
|
|
|
---
|
|
|
|
## Parameters
|
|
|
|
| Name | Type | Description | Default | Optional |
|
|
| ---- | ---- | ----------- | ------- | -------- |
|
|
| input_limit | int | Number of tickers to filter from entire ATS data based on<br/>the sum of the total weekly shares quantity | 1000 | True |
|
|
| limit | int | Number of tickers to display from most promising with<br/>better linear regression slope | 10 | True |
|
|
| tier | str | Tier to process data from: T1, T2 or OTCE | T1 | True |
|
|
| export | str | Export dataframe data to csv,json,xlsx file | | True |
|
|
| external_axes | Optional[List[plt.Axes]] | External axes (1 axis is expected in the list), by default None | None | True |
|
|
|
|
|
|
---
|
|
|
|
## Returns
|
|
|
|
This function does not return anything
|
|
|
|
---
|
|
|
|
</TabItem>
|
|
</Tabs>
|