mirror of
https://github.com/OpenBB-finance/OpenBB.git
synced 2026-11-04 08:22:26 +00: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>
90 lines
2.4 KiB
Markdown
Vendored
90 lines
2.4 KiB
Markdown
Vendored
---
|
|
title: balance
|
|
description: This page provides information on how to use OpenBB's onchain tools for
|
|
interacting with the Ethereum blockchain. It includes instructions on how to get
|
|
information about token balances and displaying this information in a chart format.
|
|
Relevant Python code is also provided.
|
|
keywords:
|
|
- Docusaurus
|
|
- Onchain
|
|
- ethplorer
|
|
- Ethereum blockchain
|
|
- Blockchain balance
|
|
- Tokens
|
|
- ETH balance
|
|
- Source code
|
|
---
|
|
|
|
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
|
|
|
|
<HeadTitle title="crypto.onchain.balance - Reference | OpenBB SDK Docs" />
|
|
|
|
import Tabs from '@theme/Tabs';
|
|
import TabItem from '@theme/TabItem';
|
|
|
|
<Tabs>
|
|
<TabItem value="model" label="Model" default>
|
|
|
|
Get info about tokens on you ethereum blockchain balance. Eth balance, balance of all tokens which
|
|
|
|
Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/cryptocurrency/onchain/ethplorer_model.py#L196)]
|
|
|
|
```python
|
|
openbb.crypto.onchain.balance(address: str, sortby: str = "index", ascend: bool = False)
|
|
```
|
|
|
|
---
|
|
|
|
## Parameters
|
|
|
|
| Name | Type | Description | Default | Optional |
|
|
| ---- | ---- | ----------- | ------- | -------- |
|
|
| address | str | Blockchain balance e.g. 0x3cD751E6b0078Be393132286c442345e5DC49699 | None | False |
|
|
| sortby | str | Key to sort by. | index | True |
|
|
| ascend | str | Sort in descending order. | False | True |
|
|
|
|
|
|
---
|
|
|
|
## Returns
|
|
|
|
| Type | Description |
|
|
| ---- | ----------- |
|
|
| pd.DataFrame | DataFrame with list of tokens and their balances. |
|
|
---
|
|
|
|
</TabItem>
|
|
<TabItem value="view" label="Chart">
|
|
|
|
Display info about tokens for given ethereum blockchain balance e.g. ETH balance,
|
|
|
|
Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/cryptocurrency/onchain/ethplorer_view.py#L21)]
|
|
|
|
```python
|
|
openbb.crypto.onchain.balance_chart(address: str, limit: int = 15, sortby: str = "index", ascend: bool = False, export: str = "")
|
|
```
|
|
|
|
---
|
|
|
|
## Parameters
|
|
|
|
| Name | Type | Description | Default | Optional |
|
|
| ---- | ---- | ----------- | ------- | -------- |
|
|
| address | str | Ethereum balance. | None | False |
|
|
| limit | int | Limit of transactions. Maximum 100 | 15 | True |
|
|
| sortby | str | Key to sort by. | index | True |
|
|
| ascend | str | Sort in descending order. | False | True |
|
|
| export | str | Export dataframe data to csv,json,xlsx file | | True |
|
|
|
|
|
|
---
|
|
|
|
## Returns
|
|
|
|
This function does not return anything
|
|
|
|
---
|
|
|
|
</TabItem>
|
|
</Tabs>
|