diff options
Diffstat (limited to 'website/content/sdk/reference/crypto/defi/anchor_data.md')
| -rw-r--r-- | website/content/sdk/reference/crypto/defi/anchor_data.md | 54 |
1 files changed, 27 insertions, 27 deletions
diff --git a/website/content/sdk/reference/crypto/defi/anchor_data.md b/website/content/sdk/reference/crypto/defi/anchor_data.md index 696658718cd..46a7543bcd2 100644 --- a/website/content/sdk/reference/crypto/defi/anchor_data.md +++ b/website/content/sdk/reference/crypto/defi/anchor_data.md @@ -1,21 +1,22 @@ --- title: anchor_data -description: Improve your understanding of the Anchor protocol with the help of our +description: + 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. keywords: -- docusaurus -- anchor protocol -- earnings data -- terra address -- parameters -- returns -- model -- view chart -- plot -- transactions history -- export + - docusaurus + - anchor protocol + - earnings data + - terra address + - parameters + - returns + - model + - view chart + - plot + - transactions history + - export --- import HeadTitle from '@site/src/components/General/HeadTitle.tsx'; @@ -40,18 +41,18 @@ openbb.crypto.defi.anchor_data(address: str = "") ## Parameters -| Name | Type | Description | Default | Optional | -| ---- | ---- | ----------- | ------- | -------- | -| address | str | Terra address. Valid terra addresses start with 'terra' | | True | - +| 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<br/>- pd.DataFrame: History of transactions<br/>- str: Overall statistics | +| Type | Description | +| -------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | +| Tuple[pd.DataFrame, pd.DataFrame, str] | - pd.DataFrame: Earnings over time in UST<br/>- pd.DataFrame: History of transactions<br/>- str: Overall statistics | + --- </TabItem> @@ -69,14 +70,13 @@ openbb.crypto.defi.anchor_data_chart(address: str = "", export: str = "", show_t ## 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 | - +| 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 | --- |