mirror of
https://github.com/OpenBB-finance/OpenBB.git
synced 2026-11-10 11:21:12 +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>
78 lines
2.2 KiB
Markdown
Vendored
78 lines
2.2 KiB
Markdown
Vendored
---
|
|
title: prom
|
|
description: OpenBB SDK Function
|
|
---
|
|
|
|
import Tabs from '@theme/Tabs';
|
|
import TabItem from '@theme/TabItem';
|
|
|
|
# prom
|
|
|
|
<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> |