Files
OpenBB/website/versioned_docs/version-v3/sdk/reference/crypto/dd/mcapdom.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.3 KiB
Vendored

title, description
title description
mcapdom OpenBB SDK Function

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

mcapdom

Returns market dominance of a coin over time

Source Code: [link]

openbb.crypto.dd.mcapdom(symbol: str, interval: str = "1d", start_date: Optional[str] = None, end_date: Optional[str] = None)

Parameters

Name Type Description Default Optional
symbol str Crypto symbol to check market cap dominance None False
interval str Interval frequency (possible values are: 5m, 15m, 30m, 1h, 1d, 1w) 1d True
start_date Optional[str] Initial date like string (e.g., 2021-10-01) None True
end_date Optional[str] End date like string (e.g., 2021-10-01) None True

Returns

Type Description
pd.DataFrame market dominance percentage over time

Plots market dominance of a coin over time

Source Code: [link]

openbb.crypto.dd.mcapdom_chart(symbol: str, start_date: Optional[str] = None, end_date: Optional[str] = None, interval: str = "1d", export: str = "", external_axes: Optional[List[matplotlib.axes._axes.Axes]] = None)

Parameters

Name Type Description Default Optional
symbol str Crypto symbol to check market cap dominance None False
start_date Optional[str] Initial date like string (e.g., 2021-10-01) None True
end_date Optional[str] End date like string (e.g., 2021-10-01) None True
interval str Interval frequency (possible values are: 5m, 15m, 30m, 1h, 1d, 1w) 1d 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