jerry/OpenBB
1
0
Fork 0
mirror of https://github.com/OpenBB-finance/OpenBB.git synced 2026-11-13 12:51:49 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
e7abffee64aec08ab29107534b4e2fe49d2fe552
OpenBB/website/versioned_docs/version-v3/sdk/reference/stocks/ca/volume.md
Theodore Aptekarev f72bc8ccec Add Versioned Documentation (#5470) 
* Adding versioning to docs

---------

Co-authored-by: andrewkenreich <andrew.kenreich@gmail.com>
Co-authored-by: tehcoderer <me@tehcoderer.com>
2023-09-29 11:49:05 +02:00

2.1 KiB
Vendored
Raw Blame History

title, description
title description
volume OpenBB SDK Function

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

volume

Get stock volume. [Source: Yahoo Finance]

Source Code: [link]

openbb.stocks.ca.volume(similar: List[str], start_date: Optional[str] = None)

Parameters

Name Type Description Default Optional
similar List[str] List of similar tickers.
Comparable companies can be accessed through
finnhub_peers(), finviz_peers(), polygon_peers().		 None False
start_date Optional[str] Initial date (e.g., 2021-10-01). Defaults to 1 year back None True

Returns

Type Description
pd.DataFrame Dataframe with volume for stock

Display stock volume. [Source: Yahoo Finance]

Source Code: [link]

openbb.stocks.ca.volume_chart(similar: List[str], start_date: Optional[str] = None, export: str = "", external_axes: Optional[List[matplotlib.axes._axes.Axes]] = None)

Parameters

Name Type Description Default Optional
similar List[str] List of similar tickers.
Comparable companies can be accessed through
finnhub_peers(), finviz_peers(), polygon_peers().		 None False
start_date Optional[str] Initial date (e.g., 2021-10-01). Defaults to 1 year back None True
export str Format to export historical prices, by default "" 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