API Specification

Describes the API specification for Nest vaults.

Overview

The Vault API allows users to retrieve details about specific vaults in the Nest Credit ecosystem. Each vault has a unique identifier (vaultSlug) used to fetch its current status, yield, total value locked (TVL), and other relevant financial data.

This API is useful for:

• Fetching real-time vault data for dashboards or analytics.

• Checking the status and availability of vaults.

---

GET /api/{vaultSlug}

Base URL:

https://app.nest.credit/api/

Description:

Retrieves details of a specific Nest Credit vault.

Path Parameters:

Parameter	Type	Required	Description
vaultSlug	string	✅	The unique identifier for the vault (e.g., nest-elixir-vault).

Supported Vault Slugs:

Vault Name	Vault Slug	API URL
Nest RWA Vault	nest-rwa-vault	https://app.nest.credit/api/nest-rwa-vault
Nest Institutional Core	nest-elixir-vault	https://app.nest.credit/api/nest-elixir-vault
Nest Institutional Core (LP)	nest-elixir-lp-vault	https://app.nest.credit/api/nest-elixir-lp-vault
Nest Treasuries Vault	nest-treasury-vault	https://app.nest.credit/api/nest-treasury-vault

Response:

Success (200 OK)

Returns a JSON object with vault details.

{
  "name": "Nest Institutional Core",
  "symbol": "nELIXIR",
  "description": "Institutional-grade DeFi deUSD",
  "vaultStatus": "Live",
  "isGeoRestricted": false,
  "apy": 0.0598803572043092,
  "price": 1.011932,
  "tvl": 22048169
}

Response Fields:

Field	Type	Description
name	string	The name of the vault.
symbol	string	The ticker symbol of the vault token.
description	string	A brief description of the vault.
vaultStatus	string	The operational status of the vault (Live, PreDeposit, ComingSoon).
isGeoRestricted	boolean	Indicates if the vault is restricted based on geographic location.
apy	number	The annual percentage yield (APY) of the vault.
price	number	The current price per vault token.
tvl	number	The total value locked (TVL) in the vault (in USD).

Error Responses:

404 Not Found

Occurs when the provided vaultSlug does not match any existing vault.

{
  "error": "Not found"
}