jerry/OpenBB
1
0
Fork 0
mirror of https://github.com/OpenBB-finance/OpenBB.git synced 2026-11-03 16:02:04 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
cd08218c35aed534ad59309ff2ca99d08e94de6a
OpenBB/website/content/sdk/reference/crypto/dd/mcapdom.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

3.0 KiB
Vendored
Raw Blame History

title, description, keywords
title description keywords
mcapdom Documentation for mcapdom function in OpenBBTerminal Python package, providing the tools to retrieve and visualize market dominance data for any given cryptocurrency over time. The page describes parameters, return values and provides direct links to the source code.
mcapdom
market dominance
crypto dominance
crypto symbol
market cap dominance chart
OpenBB Python functions
cryptocurrency due diligence
cryptocurrency market data
cryptocurrency trading analysis
financial data visualization
python finance
cryptocurrency interval data

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

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

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