Skip to main content
GET
/
v2
/
farming
/
vaults
Get investment vaults
curl --request GET \
  --url https://api.getnimbus.io/v2/farming/vaults
{
  "data": [
    {
      "id": "<string>",
      "name": "<string>",
      "chain": "<string>",
      "protocol": {
        "id": "<string>",
        "name": "<string>"
      },
      "type": "LP",
      "apr": 123,
      "apy": 123,
      "apr_rewards": 123,
      "totalApr": 123,
      "totalApy": 123,
      "tvl": 123,
      "coins": [
        "<string>"
      ],
      "rewards": {
        "tokens": [
          {
            "token_address": "<string>",
            "token_name": "<string>",
            "token_symbol": "<string>",
            "logo": "<string>"
          }
        ]
      },
      "farmLink": "<string>",
      "label": [
        "<string>"
      ],
      "logos": [
        "<string>"
      ]
    }
  ],
  "pagination": {
    "total": 123,
    "limit": 123,
    "offset": 123
  }
}

Query Parameters

​
address
string

Query pools/vaults involve with token address (optional, default is "")

​
chain
enum<string>
default:SUI
required

Query chain

Available options:
SUI,
TON,
SOL,
ECLIPSE
​
tvl
enum<string>

filter total value locked (optional, default is "")

Available options:
< 100K,
100K - 500K,
500K - 1M,
> 1M
​
apr
enum<string>

filter apy (optional, default is "")

Available options:
< 5%,
5% - 25%,
25% - 50%,
> 50%
​
protocol
string

filter protocol (optional, default is "")

​
type
enum<string>

filter type (optional, default is "")

Available options:
LP,
VAULT,
STAKING,
LENDING,
BORROW
​
tags
enum<string>[]

filter tags (optional, default is empty)

​
order
string
default:tvl

The order by (optional, default is "tvl")

​
sort
string
default:desc

The sort (optional, default is "desc")

​
limit
number
default:100

The limit (optional, default is 100)

​
offset
number
default:0

The offset (optional, default is 0)

Response

List of investment vaults

​
data
object[]
​
pagination
object