mirror of
https://github.com/OpenBB-finance/OpenBB.git
synced 2026-06-07 23:35:49 +08:00
4ad995fdd0
* 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>
3.8 KiB
Vendored
3.8 KiB
Vendored
title, description, keywords
| title | description | keywords | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| eb | This page provides documentation on how to use the OpenBBTerminal's 'eb' function in cryptocurrency due diligence. Users can return and plot the total amount of coins held on exchange addresses in Python - an essential tool for data analysis in the crypto market. |
|
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem';
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")