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>
132 lines
4.2 KiB
Markdown
Vendored
132 lines
4.2 KiB
Markdown
Vendored
---
|
|
title: vaults
|
|
description: This page provides detailed information on DeFi Vaults including functions
|
|
to get data and tools to visualize this data. The provided functions allow querying
|
|
various blockchains and DeFi protocols, and sorting by key metrics such as APY.
|
|
keywords:
|
|
- DeFi Vaults Information
|
|
- openbb.crypto.defi.vaults
|
|
- openbb.crypto.defi.vaults_chart
|
|
- Blockchain
|
|
- DeFi protocol
|
|
- Kind of vault
|
|
- APY
|
|
- ethereum
|
|
- polygon
|
|
- avalanche
|
|
- bsc
|
|
- terra
|
|
- fantom
|
|
- moonriver
|
|
- celo
|
|
- heco
|
|
- okex
|
|
- cronos
|
|
- arbitrum
|
|
- eth
|
|
- harmony
|
|
- fuse
|
|
- defichain
|
|
- solana
|
|
- optimism
|
|
- aave
|
|
- acryptos
|
|
- alpaca
|
|
- anchor
|
|
- autofarm
|
|
- balancer
|
|
- bancor
|
|
- beefy
|
|
- belt
|
|
- compound
|
|
- convex
|
|
- cream
|
|
- curve
|
|
- defichain
|
|
- geist
|
|
- lido
|
|
- liquity
|
|
- mirror
|
|
- pancakeswap
|
|
- raydium
|
|
- sushi
|
|
- tarot
|
|
- traderjoe
|
|
---
|
|
|
|
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
|
|
|
|
<HeadTitle title="crypto.defi.vaults - Reference | OpenBB SDK Docs" />
|
|
|
|
import Tabs from '@theme/Tabs';
|
|
import TabItem from '@theme/TabItem';
|
|
|
|
<Tabs>
|
|
<TabItem value="model" label="Model" default>
|
|
|
|
Get DeFi Vaults Information. DeFi Vaults are pools of funds with an assigned strategy which main goal is to
|
|
|
|
Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/cryptocurrency/defi/coindix_model.py#L107)]
|
|
|
|
```python
|
|
openbb.crypto.defi.vaults(chain: Optional[str] = None, protocol: Optional[str] = None, kind: Optional[str] = None, ascend: bool = True, sortby: str = "apy")
|
|
```
|
|
|
|
---
|
|
|
|
## Parameters
|
|
|
|
| Name | Type | Description | Default | Optional |
|
|
| ---- | ---- | ----------- | ------- | -------- |
|
|
| chain | str | Blockchain - one from list [<br/>'ethereum', 'polygon', 'avalanche', 'bsc', 'terra', 'fantom',<br/>'moonriver', 'celo', 'heco', 'okex', 'cronos', 'arbitrum', 'eth',<br/>'harmony', 'fuse', 'defichain', 'solana', 'optimism'<br/>] | None | True |
|
|
| protocol | str | DeFi protocol - one from list: [<br/>'aave', 'acryptos', 'alpaca', 'anchor', 'autofarm', 'balancer', 'bancor',<br/>'beefy', 'belt', 'compound', 'convex', 'cream', 'curve', 'defichain', 'geist',<br/>'lido', 'liquity', 'mirror', 'pancakeswap', 'raydium', 'sushi', 'tarot', 'traderjoe',<br/>'tulip', 'ubeswap', 'uniswap', 'venus', 'yearn'<br/>] | None | True |
|
|
| kind | str | Kind/type of vault - one from list: ['lp','single','noimploss','stable'] | None | True |
|
|
|
|
|
|
---
|
|
|
|
## Returns
|
|
|
|
| Type | Description |
|
|
| ---- | ----------- |
|
|
| pd.DataFrame | Top 100 DeFi Vaults for given chain/protocol sorted by APY. |
|
|
---
|
|
|
|
</TabItem>
|
|
<TabItem value="view" label="Chart">
|
|
|
|
Prints table showing Top DeFi Vaults - pools of funds with an assigned strategy which main goal is to
|
|
|
|
Source Code: [[link](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/openbb_terminal/cryptocurrency/defi/coindix_view.py#L19)]
|
|
|
|
```python
|
|
openbb.crypto.defi.vaults_chart(chain: Optional[str] = None, protocol: Optional[str] = None, kind: Optional[str] = None, limit: int = 10, sortby: str = "apy", ascend: bool = True, link: bool = False, export: str = "")
|
|
```
|
|
|
|
---
|
|
|
|
## Parameters
|
|
|
|
| Name | Type | Description | Default | Optional |
|
|
| ---- | ---- | ----------- | ------- | -------- |
|
|
| chain | str | Blockchain - one from list [<br/>'ethereum', 'polygon', 'avalanche', 'bsc', 'terra', 'fantom',<br/>'moonriver', 'celo', 'heco', 'okex', 'cronos', 'arbitrum', 'eth',<br/>'harmony', 'fuse', 'defichain', 'solana', 'optimism'<br/>] | None | True |
|
|
| protocol | str | DeFi protocol - one from list: [<br/>'aave', 'acryptos', 'alpaca', 'anchor', 'autofarm', 'balancer', 'bancor',<br/>'beefy', 'belt', 'compound', 'convex', 'cream', 'curve', 'defichain', 'geist',<br/>'lido', 'liquity', 'mirror', 'pancakeswap', 'raydium', 'sushi', 'tarot', 'traderjoe',<br/>'tulip', 'ubeswap', 'uniswap', 'venus', 'yearn'<br/>] | None | True |
|
|
| kind | str | Kind/type of vault - one from list: ['lp','single','noimploss','stable'] | None | True |
|
|
| limit | int | Number of records to display | 10 | True |
|
|
| sortby | str | Key by which to sort data | apy | True |
|
|
| ascend | bool | Flag to sort data descending | True | True |
|
|
| link | bool | Flag to show links | False | True |
|
|
| export | str | Export dataframe data to csv,json,xlsx file | | True |
|
|
|
|
|
|
---
|
|
|
|
## Returns
|
|
|
|
This function does not return anything
|
|
|
|
---
|
|
|
|
</TabItem>
|
|
</Tabs>
|