Vaults | Nest

Retrieve vaults

get

Fetch a list of vaults based on query parameters.

Query parameters

excludeGeoRestrictedbooleanOptional

Exclude geo-restricted vaults.

vaultStatusstring · enumOptional

Filter vaults by status (Live or ComingSoon).

Possible values:

includeHiddenbooleanOptional

Include hidden vaults in the response.

Responses

200

A list of vaults.

application/json

400

Invalid query parameters.

500

Server error.

get

GET /api/vaults HTTP/1.1
Host: app.nest.credit
Accept: */*

[
  {
    "vaultStatus": "ComingSoon",
    "slug": "text",
    "image": "text",
    "name": "text",
    "description": "text",
    "tvl": 1,
    "formattedTvl": "text",
    "apy": 1,
    "price": 1,
    "isEstimatedApy": true,
    "hasBoostedRewards": true,
    "formattedApy": "text",
    "formattedCooldownDays": "text",
    "estimatedApy": 1,
    "showLiveApy": true,
    "featuredAssets": [
      {
        "title": "text",
        "description": "text",
        "image": "text",
        "darkImage": "text",
        "comingSoon": true,
        "badgeSize": "sm"
      }
    ],
    "ethereum": {
      "contractAddress": "text"
    },
    "plume": {
      "contractAddress": "text"
    }
  }
]

Retrieve token details by slug

get

Fetch detailed information about a token using its slug.

Path parameters

slugstringRequired

Unique slug identifier for the token.

Responses

200

Token details.

application/json

Responseall of

404

Token not found.

500

Server error.

get

GET /api/{slug} HTTP/1.1
Host: app.nest.credit
Accept: */*

{
  "vaultStatus": "ComingSoon",
  "slug": "text",
  "image": "text",
  "name": "text",
  "description": "text",
  "tvl": 1,
  "formattedTvl": "text",
  "apy": 1,
  "price": 1,
  "isEstimatedApy": true,
  "hasBoostedRewards": true,
  "formattedApy": "text",
  "formattedCooldownDays": "text",
  "estimatedApy": 1,
  "showLiveApy": true,
  "featuredAssets": [
    {
      "title": "text",
      "description": "text",
      "image": "text",
      "darkImage": "text",
      "comingSoon": true,
      "badgeSize": "sm"
    }
  ],
  "ethereum": {
    "contractAddress": "text"
  },
  "plume": {
    "contractAddress": "text"
  },
  "formattedPrice": "text"
}

Retrieve compliance details by slug

get

Fetch compliance information for a token using its slug.

Path parameters

slugstringRequired

Unique slug identifier for the token.

Query parameters

userstringRequired

User address (Ethereum format).

Pattern: ^0x[a-fA-F0-9]{40}$

chainIdintegerRequired

Chain ID for the compliance check.

isDepositAndBridgebooleanOptional

Indicates if the compliance check is for deposit and bridge.

Responses

200

Compliance details.

application/json

400

Invalid query parameters.

404

Token not found.

500

Server error.

get

GET /api/{slug}/compliance HTTP/1.1
Host: app.nest.credit
Accept: */*

{
  "isCompliant": true,
  "predicateMessage": {
    "taskId": "text",
    "expireByBlockNumber": 1,
    "signerAddresses": [
      "text"
    ],
    "signatures": [
      "text"
    ]
  }
}