mirror of
https://github.com/OpenBB-finance/OpenBB.git
synced 2026-11-03 16:02:04 +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>
2.5 KiB
Vendored
2.5 KiB
Vendored
title, description, keywords
| title | description | keywords | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| anchor_data | Improve your understanding of the Anchor protocol with the help of our documentation providing detailed instructions on how to retrieve and plot earnings data for a specific Terra address. Skim through the parameters, the types, the given descriptions, and the functionality. |
|
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem';
Returns anchor protocol earnings data of a certain terra address
Source Code: [link]
openbb.crypto.defi.anchor_data(address: str = "")
Parameters
| Name | Type | Description | Default | Optional |
|---|---|---|---|---|
| address | str | Terra address. Valid terra addresses start with 'terra' | True |
Returns
| Type | Description |
|---|---|
| Tuple[pd.DataFrame, pd.DataFrame, str] | - pd.DataFrame: Earnings over time in UST - pd.DataFrame: History of transactions - str: Overall statistics |
Plots anchor protocol earnings data of a certain terra address
Source Code: [link]
openbb.crypto.defi.anchor_data_chart(address: str = "", export: str = "", show_transactions: bool = False, external_axes: Optional[List[matplotlib.axes._axes.Axes]] = None)
Parameters
| Name | Type | Description | Default | Optional |
|---|---|---|---|---|
| asset | str | Terra asset {ust,luna,sdt} | None | True |
| address | str | Terra address. Valid terra addresses start with 'terra' | True | |
| show_transactions | bool | Flag to show history of transactions in Anchor protocol for address. Default False | False | 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