Files
OpenBB/website/content/terminal/reference/crypto/defi/vaults.md
DidierRLopes 4ad995fdd0 Docs/terminalpro and improvement (#5622)
* 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>
2023-10-30 21:01:29 +00:00

82 lines
5.7 KiB
Markdown
Vendored
Raw Blame History

---
title: vaults
description: This page provides a detailed description on how to use and interact
with DeFi Vaults using various blockchains and DeFi protocols. It provides useful
commands, parameters, and examples.
keywords:
- defi
- blockchain
- protocol
- vaults
- cryptocurrency
- ethereum
- terra
- beefy
- apy
- tvl
- parameters
- examples
- osmosis
---
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
<HeadTitle title="crypto/defi/vaults - Reference | OpenBB Terminal Docs" />
Display Top DeFi Vaults. [Source: https://coindix.com/]
### Usage
```python
vaults [-c {ethereum,polygon,avalanche,bsc,terra,fantom,moonriver,celo,heco,okex,cronos,arbitrum,eth,harmony,fuse,defichain,solana,optimism,kusama,metis,osmosis}] [-p {aave,acryptos,alpaca,anchor,autofarm,balancer,bancor,beefy,belt,compound,convex,cream,curve,defichain,geist,lido,liquity,mirror,pancakeswap,raydium,sushi,tarot,traderjoe,tulip,ubeswap,uniswap,venus,yearn,osmosis,tulip}] [-k {lp,single,noimploss,stable}] [-t TOP] [-s {name,chain,protocol,apy,tvl,link}] [-r] [-l]
```
---
## Parameters
| Name | Description | Default | Optional | Choices |
| ---- | ----------- | ------- | -------- | ------- |
| chain | Blockchain name e.g. ethereum, terra | None | True | ethereum, polygon, avalanche, bsc, terra, fantom, moonriver, celo, heco, okex, cronos, arbitrum, eth, harmony, fuse, defichain, solana, optimism, kusama, metis, osmosis |
| protocol | DeFi protocol name e.g. aave, uniswap | None | True | aave, acryptos, alpaca, anchor, autofarm, balancer, bancor, beefy, belt, compound, convex, cream, curve, defichain, geist, lido, liquity, mirror, pancakeswap, raydium, sushi, tarot, traderjoe, tulip, ubeswap, uniswap, venus, yearn, osmosis, tulip |
| kind | Kind/type of vault e.g. lp, single, noimploss, stable | None | True | lp, single, noimploss, stable |
| limit | Number of records to display | 10 | True | range(1, 1000) |
| sortby | Sort by given column. Default: timestamp | apy | True | name, chain, protocol, apy, tvl, link |
| reverse | Data is sorted in descending order by default. Reverse flag will sort it in an ascending way. Only works when raw data is displayed. | False | True | None |
| link | Flag to show vault link | True | True | None |
---
## Examples
```python
2022 May 26, 07:19 (<EFBFBD>) /crypto/defi/ $ vaults
Top DeFi Vaults
┌──────────────────────┬───────────┬──────────┬───────────┬──────────┐
│ Name │ Chain │ Protocol │ APY (%) │ TVL ($) │
├──────────────────────┼───────────┼──────────┼───────────┼──────────┤
│ ESHARE-BNB │ BNB Chain │ Beefy │ 3034.87 % │ 1.587 M │
├──────────────────────┼───────────┼──────────┼───────────┼──────────┤
│ BSHARE-FTM │ Fantom │ Beefy │ 1545.3 % │ 1.637 M │
├──────────────────────┼───────────┼──────────┼───────────┼──────────┤
│ ust-wormholeUST-3Crv │ Ethereum │ Convex │ 1471.74 % │ 2.600 M │
├──────────────────────┼───────────┼──────────┼───────────┼──────────┤
│ GRAPE-MIM │ Avalanche │ Beefy │ 1404.84 % │ 1.110 M │
├──────────────────────┼───────────┼──────────┼───────────┼──────────┤
│ BASED-TOMB │ Fantom │ Beefy │ 527.77 % │ 1.139 M │
├──────────────────────┼───────────┼──────────┼───────────┼──────────┤
│ EMP-ETH │ BNB Chain │ Beefy │ 362.55 % │ 1.257 M │
├──────────────────────┼───────────┼──────────┼───────────┼──────────┤
│ BADGER-WBTC │ Ethereum │ Balancer │ 340.54 % │ 15.150 M │
├──────────────────────┼───────────┼──────────┼───────────┼──────────┤
│ BSW-BNB │ BNB Chain │ Alpaca │ 280.7 % │ 1.863 M │
├──────────────────────┼───────────┼──────────┼───────────┼──────────┤
│ WBTC-OSMO │ Osmosis │ Osmosis │ 231.2 % │ 4.730 M │
├──────────────────────┼───────────┼──────────┼───────────┼──────────┤
│ ROWAN-OSMO │ Osmosis │ Osmosis │ 228.72 % │ 1.834 M │
└──────────────────────┴───────────┴──────────┴───────────┴──────────┘
```
---