mirror of
https://github.com/OpenBB-finance/OpenBB.git
synced 2026-10-30 05:52:23 +00:00
79046608b6
* Update generate_terminal_markdown.py * updates * update workflows * Automated Change * tests * tests * Automated Change * Update test_generate_docs.py * Automated Change * updates * Automated Change * Update gen-docs.yml * Update test.yml * Automated Change * Update test.yml * Automated Change * Update generate_sdk_markdown.py * Automated Change * test * Automated Change * testtt23 * Automated Change * Update generate_sdk_markdown.py * Automated Change * Automated Change * added empting reference folders before autogen docs * updates * Automated Change * update tests gitactions * Automated Change * up * Automated Change * Automated Change * update pytest * Automated Change * tests * Automated Change * examples update * Automated Change * Update generate_sdk_markdown.py * Automated Change * Update test.yml * Update generate_sdk_markdown.py * strip * Automated Change * Workflow : check test update * Automated Change * Automated Change * Automated Change * Update test.yml * Automated Change * Update test.yml * Automated Change * Automated Change * up * Automated Change * Update generate_sdk_markdown.py * Automated Change * update workflows * fix guides * testing * Update gh-pages.yml * Update gh-pages.yml Co-authored-by: tehcoderer <tehcoderer@users.noreply.github.com> Co-authored-by: Jeroen Bouma <jer.bouma@gmail.com> Co-authored-by: Chavithra PARANA <chavithra@gmail.com> Co-authored-by: Chavithra <Chavithra@users.noreply.github.com> Co-authored-by: jose-donato <43375532+jose-donato@users.noreply.github.com> Co-authored-by: jose-donato <jose-donato@users.noreply.github.com>
100 lines
3.2 KiB
Markdown
Vendored
100 lines
3.2 KiB
Markdown
Vendored
---
|
|
title: eb
|
|
description: OpenBB SDK Function
|
|
---
|
|
|
|
import Tabs from '@theme/Tabs';
|
|
import TabItem from '@theme/TabItem';
|
|
|
|
# eb
|
|
|
|
<Tabs>
|
|
<TabItem value="model" label="Model" default>
|
|
|
|
Returns the total amount of coins held on exchange addresses in units and percentage.
|
|
|
|
Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/cryptocurrency/due_diligence/glassnode_model.py#L453)]
|
|
|
|
```python
|
|
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,<br/>coinex, gate.io, gemini, huobi, kucoin, poloniex, bibox, bigone, bitfinex, hitbtc, kraken,<br/>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
|
|
|
|
```python
|
|
from openbb_terminal.sdk import openbb
|
|
df = openbb.crypto.dd.eb(symbol="BTC")
|
|
```
|
|
|
|
---
|
|
|
|
|
|
|
|
</TabItem>
|
|
<TabItem value="view" label="Chart">
|
|
|
|
Plots total amount of coins held on exchange addresses in units and percentage.
|
|
|
|
Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/cryptocurrency/due_diligence/glassnode_view.py#L238)]
|
|
|
|
```python
|
|
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,<br/>coinex, gate.io, gemini, huobi, kucoin, poloniex, bibox, bigone, bitfinex, hitbtc, kraken,<br/>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
|
|
|
|
```python
|
|
from openbb_terminal.sdk import openbb
|
|
openbb.crypto.dd.eb_chart(symbol="BTC")
|
|
```
|
|
|
|
---
|
|
|
|
|
|
|
|
</TabItem>
|
|
</Tabs> |