mirror of
https://github.com/OpenBB-finance/OpenBB.git
synced 2026-11-11 20:01:16 +00:00
79046608b6
* Update generate_terminal_markdown.py * updates * update workflows * Automated Change * tests * tests * Automated Change * Update test_generate_docs.py * Automated Change * updates * Automated Change * Update gen-docs.yml * Update test.yml * Automated Change * Update test.yml * Automated Change * Update generate_sdk_markdown.py * Automated Change * test * Automated Change * testtt23 * Automated Change * Update generate_sdk_markdown.py * Automated Change * Automated Change * added empting reference folders before autogen docs * updates * Automated Change * update tests gitactions * Automated Change * up * Automated Change * Automated Change * update pytest * Automated Change * tests * Automated Change * examples update * Automated Change * Update generate_sdk_markdown.py * Automated Change * Update test.yml * Update generate_sdk_markdown.py * strip * Automated Change * Workflow : check test update * Automated Change * Automated Change * Automated Change * Update test.yml * Automated Change * Update test.yml * Automated Change * Automated Change * up * Automated Change * Update generate_sdk_markdown.py * Automated Change * update workflows * fix guides * testing * Update gh-pages.yml * Update gh-pages.yml Co-authored-by: tehcoderer <tehcoderer@users.noreply.github.com> Co-authored-by: Jeroen Bouma <jer.bouma@gmail.com> Co-authored-by: Chavithra PARANA <chavithra@gmail.com> Co-authored-by: Chavithra <Chavithra@users.noreply.github.com> Co-authored-by: jose-donato <43375532+jose-donato@users.noreply.github.com> Co-authored-by: jose-donato <jose-donato@users.noreply.github.com>
64 lines
5.3 KiB
Markdown
Vendored
64 lines
5.3 KiB
Markdown
Vendored
---
|
||
title: vaults
|
||
description: OpenBB Terminal Function
|
||
---
|
||
|
||
# vaults
|
||
|
||
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 │
|
||
└──────────────────────┴───────────┴──────────┴───────────┴──────────┘
|
||
```
|
||
---
|