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/dpotc.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

2.0 KiB
Vendored
Raw Blame History

title, description, keywords
title description keywords
dpotc Documentation for dpotc and dpotc_chart, functions in the OpenBB Finance library for retrieving and visualizing Dark Pools (ATS) and OTC (Non-ATS) data from FINRA. Includes parameters and source code.
dpotc
FINRA data
Dark Pools (ATS) Data
OTC (Non-ATS) Data
dpotc_chart
barchart
matplotlib
Export dataframe data

import HeadTitle from '@site/src/components/General/HeadTitle.tsx';

import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem';

Get all FINRA data associated with a ticker

Source Code: [link]

openbb.stocks.dps.dpotc(symbol: str)

Parameters

Name Type Description Default Optional
symbol str Stock ticker to get data from None False

Returns

Type Description
Tuple[pd.DataFrame, pd.DataFrame] Dark Pools (ATS) Data, OTC (Non-ATS) Data

Display barchart of dark pool (ATS) and OTC (Non ATS) data. [Source: FINRA]

Source Code: [link]

openbb.stocks.dps.dpotc_chart(symbol: str, export: str = "", external_axes: Optional[List[matplotlib.axes._axes.Axes]] = None)

Parameters

Name Type Description Default Optional
symbol str Stock ticker None False
export str Export dataframe data to csv,json,xlsx file True
external_axes Optional[List[plt.Axes]] External axes (2 axes are expected in the list), by default None None True

Returns

This function does not return anything