jerry/OpenBB
1
0
Fork 0
mirror of https://github.com/OpenBB-finance/OpenBB.git synced 2026-11-01 06:51:38 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
041ff008de6fe892e8d9ac1e251eaa892cbdf97b
OpenBB/website/versioned_docs/version-v3/sdk/reference/crypto/dd/eb.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

3.2 KiB
Vendored
Raw Blame History

title, description
title description
eb OpenBB SDK Function

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

eb

Returns the total amount of coins held on exchange addresses in units and percentage.

Source Code: [link]

openbb.crypto.dd.eb(symbol: str, exchange: str = "aggregated", start_date: Optional[str] = None, end_date: Optional[str] = None)

Parameters

Name Type Description Default Optional
symbol str Asset to search active addresses (e.g., BTC) None False
exchange str Exchange to check net position change (possible values are: aggregated, binance, bittrex,
coinex, gate.io, gemini, huobi, kucoin, poloniex, bibox, bigone, bitfinex, hitbtc, kraken,
okex, bithumb, zb.com, cobinhood, bitmex, bitstamp, coinbase, coincheck, luno), by default "aggregated"		 aggregated True
start_date Optional[str] Initial date (format YYYY-MM-DD) by default 2 years ago None True
end_date Optional[str] Final date (format YYYY-MM-DD) by default 1 year ago None True

Returns

Type Description
pd.DataFrame total amount of coins in units/percentage and symbol price over time

Examples

from openbb_terminal.sdk import openbb
df = openbb.crypto.dd.eb(symbol="BTC")

Plots total amount of coins held on exchange addresses in units and percentage.

Source Code: [link]

openbb.crypto.dd.eb_chart(symbol: str, exchange: str = "aggregated", start_date: Optional[str] = None, end_date: Optional[str] = None, percentage: bool = False, export: str = "", external_axes: Optional[List[matplotlib.axes._axes.Axes]] = None)

Parameters

Name Type Description Default Optional
symbol str Asset to search active addresses (e.g., BTC) None False
exchange str Exchange to check net position change (possible values are: aggregated, binance, bittrex,
coinex, gate.io, gemini, huobi, kucoin, poloniex, bibox, bigone, bitfinex, hitbtc, kraken,
okex, bithumb, zb.com, cobinhood, bitmex, bitstamp, coinbase, coincheck, luno), by default "aggregated"		 aggregated True
start_date Optional[str] Initial date (format YYYY-MM-DD) by default 2 years ago None True
end_date Optional[str] Final date (format YYYY-MM-DD) by default 1 year ago None True
percentage bool Show percentage instead of stacked value. False True
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

Examples

from openbb_terminal.sdk import openbb
openbb.crypto.dd.eb_chart(symbol="BTC")