Vaults

get

Get all vaults info

Query parameters

livestringOptional

Filter vaults by status: true for active only, false for inactive only

Example: true

Responses

200

Get all vaults info

application/json

500

Server error

application/json

get

/vaults

HTTPcURLJavaScriptPython

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

{
  "data": [
    {
      "vaultAddress": "text",
      "accountantAddress": "text",
      "authorityAddress": "text",
      "tellerContractAddress": "text",
      "decimals": 1,
      "decimalsOverride": [
        {
          "56": 18
        }
      ],
      "chain": {
        "mainnet": {
          "startBlock": 1
        },
        "plume": {
          "startBlock": 1
        },
        "plasma": {
          "startBlock": 1
        },
        "arbitrum": {
          "startBlock": 1
        },
        "bsc": {
          "startBlock": 1
        }
      },
      "solana": {
        "mintAddress": "text",
        "composerAddress": "text",
        "decimals": 1,
        "startBlock": 1
      },
      "liquidAssets": [
        {
          "contractAddress": "text",
          "symbol": "text",
          "decimals": 1,
          "price": 1,
          "chainId": 1
        }
      ],
      "slug": "text",
      "name": "text",
      "symbol": "text",
      "icon": "text",
      "targetComposition": [
        {
          "slug": "text",
          "name": "text",
          "description": "text"
        }
      ],
      "sec30d": 1,
      "tvl": 1,
      "numHolders": 1,
      "volume24h": 1
    }
  ]
}

get

Get VaultDetails for all vaults

Query parameters

livestringOptional

Filter vaults by status: true for active only, false for inactive only

Example: true

liveLiquiditystringOptionalDefault: false

Responses

200

VaultDetails for all vaults

application/json

500

Server error

application/json

get

/vaults/details

HTTPcURLJavaScriptPython

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

{
  "data": [
    {
      "vaultAddress": "text",
      "accountantAddress": "text",
      "authorityAddress": "text",
      "tellerContractAddress": "text",
      "decimals": 1,
      "decimalsOverride": [
        {
          "56": 18
        }
      ],
      "chain": {
        "mainnet": {
          "startBlock": 1
        },
        "plume": {
          "startBlock": 1
        },
        "plasma": {
          "startBlock": 1
        },
        "arbitrum": {
          "startBlock": 1
        },
        "bsc": {
          "startBlock": 1
        }
      },
      "solana": {
        "mintAddress": "text",
        "composerAddress": "text",
        "decimals": 1,
        "startBlock": 1
      },
      "liquidAssets": [
        {
          "contractAddress": "text",
          "symbol": "text",
          "decimals": 1,
          "price": 1,
          "chainId": 1
        }
      ],
      "slug": "text",
      "name": "text",
      "symbol": "text",
      "icon": "text",
      "targetComposition": [
        {
          "slug": "text",
          "name": "text",
          "description": "text"
        }
      ],
      "tvl": 1,
      "tvl30DayChange": 1,
      "volume24h": 1,
      "apy": {
        "rolling7d": 1,
        "rolling30d": 1,
        "sec30d": 1
      },
      "tokenPrice": 1,
      "tokenPriceUpdatedAtEpoch": 1,
      "liquidFunds": 1,
      "liquidFundsRange": 1,
      "holders": 1,
      "tokenPriceUpdatedAt": "2026-01-18",
      "pendingRedemptions": 1,
      "shortfall": 1
    }
  ]
}

get

Get VaultDetailsLite for all vaults

Query parameters

liveLiquiditystringOptionalDefault: false

Responses

200

VaultDetailsLite for all vaults

application/json

500

Server error

application/json

get

/vaults/details-lite

HTTPcURLJavaScriptPython

GET /v1/vaults/details-lite HTTP/1.1
Host: api.nest.credit
Accept: */*

{
  "data": [
    {
      "vaultAddress": "text",
      "accountantAddress": "text",
      "authorityAddress": "text",
      "tellerContractAddress": "text",
      "decimals": 1,
      "decimalsOverride": [
        {
          "56": 18
        }
      ],
      "chain": {
        "mainnet": {
          "startBlock": 1
        },
        "plume": {
          "startBlock": 1
        },
        "plasma": {
          "startBlock": 1
        },
        "arbitrum": {
          "startBlock": 1
        },
        "bsc": {
          "startBlock": 1
        }
      },
      "solana": {
        "mintAddress": "text",
        "composerAddress": "text",
        "decimals": 1,
        "startBlock": 1
      },
      "liquidAssets": [
        {
          "contractAddress": "text",
          "symbol": "text",
          "decimals": 1,
          "price": 1,
          "chainId": 1
        }
      ],
      "slug": "text",
      "name": "text",
      "symbol": "text",
      "icon": "text",
      "targetComposition": [
        {
          "slug": "text",
          "name": "text",
          "description": "text"
        }
      ],
      "tvl": 1,
      "tvl30DayChange": 1,
      "volume24h": 1,
      "apy": {
        "rolling7d": 1,
        "rolling30d": 1,
        "sec30d": 1
      },
      "tokenPrice": 1,
      "tokenPriceUpdatedAtEpoch": 1,
      "liquidFunds": 1,
      "liquidFundsRange": 1,
      "holders": 1
    }
  ]
}

get

Get 7d, 30d and SEC 30d APYs for all vaults. apy is the composition-weighted yield APY based on underlying yield-bearing assets (liquid assets are excluded from the APY denominator). navApy is the price-delta (NAV-based) APY computed from vault token price changes.

Query parameters

includeBreakdownstringOptionalDefault: false

Responses

200

VaultApy for all vaults

application/json

get

/vaults/apy

HTTPcURLJavaScriptPython

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

200

VaultApy for all vaults

{
  "data": [
    {
      "vaultAddress": "text",
      "apy": {
        "rolling7d": 1,
        "rolling30d": 1,
        "sec30d": 1
      },
      "navApy": {
        "rolling7d": 1,
        "rolling30d": 1,
        "sec30d": 1
      },
      "breakdown": {
        "totalValue": 1,
        "liquidAssets": {
          "totalValue": 1,
          "weight": 1
        },
        "yieldAssets": [
          {
            "slug": "text",
            "value": 1,
            "weight": 1,
            "apy": {
              "rolling7d": 1,
              "rolling30d": 1,
              "sec30d": 1
            }
          }
        ]
      },
      "errors": [
        {
          "source": "superstate",
          "operation": "getPendingTransactions",
          "message": "superstate getPendingTransactions timed out after 10000ms",
          "code": "TIMEOUT",
          "timestamp": 1704067200
        }
      ]
    }
  ]
}

get

Get VaultTVL for all vaults

Responses

200

VaultTVL for all vaults

application/json

get

/vaults/tvl

HTTPcURLJavaScriptPython

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

200

VaultTVL for all vaults

{
  "data": [
    {
      "vaultAddress": "text",
      "tvl": 1
    }
  ]
}

get

Get last 24h volume for all vaults

Responses

200

Latest 24h volume for all vaults

application/json

500

Server error

application/json

get

/vaults/volume

HTTPcURLJavaScriptPython

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

{
  "data": [
    {
      "vaultAddress": "text",
      "volume24h": 1
    }
  ]
}

get

Get number of holders for all vaults and top holders for each vault

Query parameters

chainIdnumber | nullableOptional

Optional chain ID

Responses

200

VaultHolders for all vaults

application/json

500

Server error

application/json

get

/vaults/holders

HTTPcURLJavaScriptPython

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

{
  "data": [
    {
      "vaultAddress": "text",
      "totalHolders": 1,
      "holders": [
        {
          "chainId": 1,
          "user": "text",
          "balance": 1,
          "holderSince": 1
        }
      ]
    }
  ]
}

get

Get recent transactions for all vaults

Query parameters

chainIdnumber | nullableOptional

Optional chain ID

limitnumber · min: 1 · max: 100Optional

Maximum number of transactions per vault to return

Default: 10Example: 10

Responses

200

Recent transactions for all vaults

application/json

500

Server error

application/json

get

/vaults/recent-transactions

HTTPcURLJavaScriptPython

GET /v1/vaults/recent-transactions HTTP/1.1
Host: api.nest.credit
Accept: */*

{
  "data": [
    {
      "vaultAddress": "text",
      "recentTransactions": [
        {
          "transactionHash": "0x1234567890123456789012345678901234567890",
          "transactionType": "DEPOSIT",
          "vaultAddress": "0x1234567890123456789012345678901234567890",
          "user": "0x1234567890123456789012345678901234567890",
          "createdAt": 1717334400,
          "shares": 100,
          "sharesTokenAddress": "0x1234567890123456789012345678901234567890",
          "assets": 100,
          "assetsTokenAddress": "0x1234567890123456789012345678901234567890",
          "chainId": 1
        }
      ]
    }
  ]
}

get

Get VaultDetails by slug

Path parameters

slugstring · min: 1Required

Unique slug identifier for the vault.

Example: nest-alpha-vault

Query parameters

liveLiquiditystringOptionalDefault: false

Responses

200

Vault details by slug

application/json

404

Not found

application/json

500

Server error

application/json

get

/vaults/{slug}/details

HTTPcURLJavaScriptPython

GET /v1/vaults/{slug}/details HTTP/1.1
Host: api.nest.credit
Accept: */*

{
  "data": {
    "vaultAddress": "text",
    "accountantAddress": "text",
    "authorityAddress": "text",
    "tellerContractAddress": "text",
    "decimals": 1,
    "decimalsOverride": [
      {
        "56": 18
      }
    ],
    "chain": {
      "mainnet": {
        "startBlock": 1
      },
      "plume": {
        "startBlock": 1
      },
      "plasma": {
        "startBlock": 1
      },
      "arbitrum": {
        "startBlock": 1
      },
      "bsc": {
        "startBlock": 1
      }
    },
    "solana": {
      "mintAddress": "text",
      "composerAddress": "text",
      "decimals": 1,
      "startBlock": 1
    },
    "liquidAssets": [
      {
        "contractAddress": "text",
        "symbol": "text",
        "decimals": 1,
        "price": 1,
        "chainId": 1
      }
    ],
    "slug": "text",
    "name": "text",
    "symbol": "text",
    "icon": "text",
    "targetComposition": [
      {
        "slug": "text",
        "name": "text",
        "description": "text"
      }
    ],
    "tvl": 1,
    "tvl30DayChange": 1,
    "volume24h": 1,
    "apy": {
      "rolling7d": 1,
      "rolling30d": 1,
      "sec30d": 1
    },
    "tokenPrice": 1,
    "tokenPriceUpdatedAtEpoch": 1,
    "liquidFunds": 1,
    "liquidFundsRange": 1,
    "holders": 1,
    "tokenPriceUpdatedAt": "2026-01-18",
    "pendingRedemptions": 1,
    "shortfall": 1
  }
}

get

Get VaultDetailsLite by slug

Path parameters

slugstring · min: 1Required

Unique slug identifier for the vault.

Example: nest-alpha-vault

Query parameters

liveLiquiditystringOptionalDefault: false

Responses

200

Vault details by slug

application/json

404

Not found

application/json

500

Server error

application/json

get

/vaults/{slug}/details-lite

HTTPcURLJavaScriptPython

GET /v1/vaults/{slug}/details-lite HTTP/1.1
Host: api.nest.credit
Accept: */*

{
  "data": {
    "vaultAddress": "text",
    "accountantAddress": "text",
    "authorityAddress": "text",
    "tellerContractAddress": "text",
    "decimals": 1,
    "decimalsOverride": [
      {
        "56": 18
      }
    ],
    "chain": {
      "mainnet": {
        "startBlock": 1
      },
      "plume": {
        "startBlock": 1
      },
      "plasma": {
        "startBlock": 1
      },
      "arbitrum": {
        "startBlock": 1
      },
      "bsc": {
        "startBlock": 1
      }
    },
    "solana": {
      "mintAddress": "text",
      "composerAddress": "text",
      "decimals": 1,
      "startBlock": 1
    },
    "liquidAssets": [
      {
        "contractAddress": "text",
        "symbol": "text",
        "decimals": 1,
        "price": 1,
        "chainId": 1
      }
    ],
    "slug": "text",
    "name": "text",
    "symbol": "text",
    "icon": "text",
    "targetComposition": [
      {
        "slug": "text",
        "name": "text",
        "description": "text"
      }
    ],
    "tvl": 1,
    "tvl30DayChange": 1,
    "volume24h": 1,
    "apy": {
      "rolling7d": 1,
      "rolling30d": 1,
      "sec30d": 1
    },
    "tokenPrice": 1,
    "tokenPriceUpdatedAtEpoch": 1,
    "liquidFunds": 1,
    "liquidFundsRange": 1,
    "holders": 1
  }
}

get

Get Vault APY by slug. apy is the composition-weighted yield APY based on underlying yield-bearing assets (liquid assets are excluded from the APY denominator). navApy is the price-delta (NAV-based) APY computed from vault token price changes.

Path parameters

slugstring · min: 1Required

Unique slug identifier for the vault.

Example: nest-alpha-vault

Query parameters

includeBreakdownstringOptionalDefault: false

Responses

200

Vault APY

application/json

404

Not found

application/json

500

Server error

application/json

get

/vaults/{slug}/apy

HTTPcURLJavaScriptPython

GET /v1/vaults/{slug}/apy HTTP/1.1
Host: api.nest.credit
Accept: */*

{
  "data": {
    "vaultAddress": "text",
    "apy": {
      "rolling7d": 1,
      "rolling30d": 1,
      "sec30d": 1
    },
    "navApy": {
      "rolling7d": 1,
      "rolling30d": 1,
      "sec30d": 1
    },
    "breakdown": {
      "totalValue": 1,
      "liquidAssets": {
        "totalValue": 1,
        "weight": 1
      },
      "yieldAssets": [
        {
          "slug": "text",
          "value": 1,
          "weight": 1,
          "apy": {
            "rolling7d": 1,
            "rolling30d": 1,
            "sec30d": 1
          }
        }
      ]
    },
    "errors": [
      {
        "source": "superstate",
        "operation": "getPendingTransactions",
        "message": "superstate getPendingTransactions timed out after 10000ms",
        "code": "TIMEOUT",
        "timestamp": 1704067200
      }
    ]
  }
}

get

Get Vault TVL by slug

Path parameters

slugstring · min: 1Required

Unique slug identifier for the vault.

Example: nest-alpha-vault

Responses

200

Vault TVL

application/json

404

Not found

application/json

500

Server error

application/json

get

/vaults/{slug}/tvl

HTTPcURLJavaScriptPython

GET /v1/vaults/{slug}/tvl HTTP/1.1
Host: api.nest.credit
Accept: */*

{
  "data": {
    "vaultAddress": "text",
    "tvl": 1
  }
}

get

Get VaultInfo by slug

Path parameters

slugstring · min: 1Required

Unique slug identifier for the vault.

Example: nest-alpha-vault

Responses

200

VaultInfo

application/json

400

Invalid slug

application/json

404

Not found

application/json

500

Server error

application/json

get

/vaults/{slug}

HTTPcURLJavaScriptPython

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

{
  "data": {
    "vaultAddress": "text",
    "accountantAddress": "text",
    "authorityAddress": "text",
    "tellerContractAddress": "text",
    "decimals": 1,
    "decimalsOverride": [
      {
        "56": 18
      }
    ],
    "chain": {
      "mainnet": {
        "startBlock": 1
      },
      "plume": {
        "startBlock": 1
      },
      "plasma": {
        "startBlock": 1
      },
      "arbitrum": {
        "startBlock": 1
      },
      "bsc": {
        "startBlock": 1
      }
    },
    "solana": {
      "mintAddress": "text",
      "composerAddress": "text",
      "decimals": 1,
      "startBlock": 1
    },
    "liquidAssets": [
      {
        "contractAddress": "text",
        "symbol": "text",
        "decimals": 1,
        "price": 1,
        "chainId": 1
      }
    ],
    "slug": "text",
    "name": "text",
    "symbol": "text",
    "icon": "text",
    "targetComposition": [
      {
        "slug": "text",
        "name": "text",
        "description": "text"
      }
    ],
    "sec30d": 1,
    "tvl": 1,
    "numHolders": 1,
    "volume24h": 1
  }
}

get

Get total number of holders and top holders for a vault by slug

Path parameters

slugstring · min: 1Required

Unique slug identifier for the vault.

Example: nest-alpha-vault

Query parameters

chainIdnumber | nullableOptional

Optional chain ID

Responses

200

Vault holders

application/json

404

Not found

application/json

500

Server error

application/json

get

/vaults/{slug}/holders

HTTPcURLJavaScriptPython

GET /v1/vaults/{slug}/holders HTTP/1.1
Host: api.nest.credit
Accept: */*

{
  "data": {
    "vaultAddress": "text",
    "totalHolders": 1,
    "holders": [
      {
        "chainId": 1,
        "user": "text",
        "balance": 1,
        "holderSince": 1
      }
    ]
  }
}

get

Get latest 24h volume for a vault by slug

Path parameters

slugstring · min: 1Required

Unique slug identifier for the vault.

Example: nest-alpha-vault

Responses

200

Vault volume

application/json

404

Not found

application/json

500

Server error

application/json

get

/vaults/{slug}/volume

HTTPcURLJavaScriptPython

GET /v1/vaults/{slug}/volume HTTP/1.1
Host: api.nest.credit
Accept: */*

{
  "data": {
    "vaultAddress": "text",
    "volume24h": 1
  }
}

get

Get Vault pending redemptions by slug

Path parameters

slugstring · min: 1Required

Unique slug identifier for the vault.

Example: nest-alpha-vault

Query parameters

startDatenumber | nullableOptional

Optional expiration start date filter. Defaults to 30 days ago if not provided.

endDatenumber | nullableOptional

Optional expiration end date

userstringOptional

Optional user address

chainIdnumber | nullableOptional

Optional chain ID

onlyValidstringOptional

Optional boolean filter for only valid redemptions. Defaults to true

Default: true

Responses

200

Vault's PendingRedemption(s) for the given user

application/json

404

Not found

application/json

500

Server error

application/json

get

/vaults/{slug}/pending-redemptions

HTTPcURLJavaScriptPython

GET /v1/vaults/{slug}/pending-redemptions HTTP/1.1
Host: api.nest.credit
Accept: */*

{
  "data": {
    "vaultAddress": "text",
    "pendingRedemptions": [
      {
        "requestTransactionHash": "text",
        "user": "text",
        "chainId": 1,
        "amount": 1,
        "requestedAt": 1,
        "expiresAt": 1,
        "wantTokenContractAddress": "text",
        "minPrice": 1,
        "isValid": true
      }
    ]
  }
}

get

Get Vault failed redemptions by slug

Path parameters

slugstring · min: 1Required

Unique slug identifier for the vault.

Example: nest-alpha-vault

Query parameters

startDatenumber | nullableOptional

Optional expiration start date filter. Defaults to 30 days ago if not provided.

endDatenumber | nullableOptional

Optional expiration end date

userstringOptional

Optional user address

chainIdnumber | nullableOptional

Optional chain ID

Responses

200

Vault's FailedRedemption(s) for the given user

application/json

404

Not found

application/json

500

Server error

application/json

get

/vaults/{slug}/failed-redemptions

HTTPcURLJavaScriptPython

GET /v1/vaults/{slug}/failed-redemptions HTTP/1.1
Host: api.nest.credit
Accept: */*

{
  "data": {
    "vaultAddress": "text",
    "failedRedemptions": [
      {
        "requestTransactionHash": "text",
        "user": "text",
        "chainId": 1,
        "amount": 1,
        "requestedAt": 1,
        "expiresAt": 1,
        "wantTokenContractAddress": "text",
        "minPrice": 1,
        "isValid": true
      }
    ]
  }
}

get

Get Vault fulfilled redemptions by slug

Path parameters

slugstring · min: 1Required

Unique slug identifier for the vault.

Example: nest-alpha-vault

Query parameters

startDatenumber | nullableOptional

Optional expiration start date filter. Defaults to 30 days ago if not provided.

endDatenumber | nullableOptional

Optional expiration end date

userstringOptional

Optional user address

chainIdnumber | nullableOptional

Optional chain ID

Responses

200

Vault's FulfilledRedemption(s) for the given user

application/json

404

Not found

application/json

500

Server error

application/json

get

/vaults/{slug}/fulfilled-redemptions

HTTPcURLJavaScriptPython

GET /v1/vaults/{slug}/fulfilled-redemptions HTTP/1.1
Host: api.nest.credit
Accept: */*

{
  "data": {
    "vaultAddress": "text",
    "fulfilledRedemptions": [
      {
        "transactionHash": "text",
        "user": "text",
        "offerAmountSpent": 1,
        "wantAmountReceived": 1,
        "chainId": 1,
        "fulfilledAt": 1
      }
    ]
  }
}

get

Get the last price update for a vault by slug

Path parameters

slugstring · min: 1Required

Unique slug identifier for the vault.

Example: nest-alpha-vault

Query parameters

chainIdnumber | nullableOptional

Optional chain ID

Responses

200

Vault last price update

application/json

404

Not found

application/json

500

Server error

application/json

get

/vaults/{slug}/last-price-update

HTTPcURLJavaScriptPython

GET /v1/vaults/{slug}/last-price-update HTTP/1.1
Host: api.nest.credit
Accept: */*

{
  "data": {
    "vaultAddress": "text",
    "lastPriceUpdates": [
      {
        "chainId": 1,
        "price": 1,
        "prevPrice": 1,
        "updatedAt": 1
      }
    ]
  }
}

get

Get recent transactions for a vault by slug

Path parameters

slugstring · min: 1Required

Unique slug identifier for the vault.

Example: nest-alpha-vault

Query parameters

chainIdnumber | nullableOptional

Optional chain ID

limitnumber · min: 1 · max: 100Optional

Maximum number of transactions to return

Default: 10Example: 10

Responses

200

Recent transactions for the specified vault by slug

application/json

404

Not found

application/json

500

Server error

application/json

get

/vaults/{slug}/recent-transactions

HTTPcURLJavaScriptPython

GET /v1/vaults/{slug}/recent-transactions HTTP/1.1
Host: api.nest.credit
Accept: */*

{
  "data": {
    "vaultAddress": "text",
    "recentTransactions": [
      {
        "transactionHash": "0x1234567890123456789012345678901234567890",
        "transactionType": "DEPOSIT",
        "vaultAddress": "0x1234567890123456789012345678901234567890",
        "user": "0x1234567890123456789012345678901234567890",
        "createdAt": 1717334400,
        "shares": 100,
        "sharesTokenAddress": "0x1234567890123456789012345678901234567890",
        "assets": 100,
        "assetsTokenAddress": "0x1234567890123456789012345678901234567890",
        "chainId": 1
      }
    ]
  }
}

get

Get Liquid Funds by slug

Path parameters

slugstring · min: 1Required

Unique slug identifier for the vault.

Example: nest-alpha-vault

Query parameters

liveLiquiditystringOptionalDefault: false

Responses

200

Liquid Funds

application/json

404

Not found

application/json

500

Server error

application/json

get

/vaults/{slug}/liquid-funds

HTTPcURLJavaScriptPython

GET /v1/vaults/{slug}/liquid-funds HTTP/1.1
Host: api.nest.credit
Accept: */*

{
  "data": {
    "vaultAddress": "text",
    "liquidFunds": 100,
    "breakdown": [
      {
        "assetAddress": "text",
        "chainId": 1,
        "balance": 1
      }
    ]
  }
}

get

Get the NAV, price and total supply for a vault by slug

Path parameters

slugstring · min: 1Required

Unique slug identifier for the vault.

Example: nest-alpha-vault

Responses

200

Vault last price update

application/json

404

Not found

application/json

500

Server error

application/json

get

/vaults/{slug}/price

HTTPcURLJavaScriptPython

GET /v1/vaults/{slug}/price HTTP/1.1
Host: api.nest.credit
Accept: */*

{
  "data": {
    "vaultAddress": "text",
    "nav": 1,
    "price": 1,
    "totalSupply": 1
  }
}

get

Get the upper and lower bounds for price update for a vault by slug and chainId

Path parameters

slugstring · min: 1Required

Unique slug identifier for the vault.

Example: nest-alpha-vault

Query parameters

chainIdnumber | nullableOptional

Chain ID. Defaults to Plume: 98866

Default: 98866

Responses

200

Vault last price update

application/json

404

Not found

application/json

500

Server error

application/json

get

/vaults/{slug}/price-range

HTTPcURLJavaScriptPython

GET /v1/vaults/{slug}/price-range HTTP/1.1
Host: api.nest.credit
Accept: */*

{
  "data": {
    "upperBound": 1,
    "lowerBound": 1
  }
}

get

Get the asset positions for a vault by slug

Path parameters

slugstring · min: 1Required

Unique slug identifier for the vault.

Example: nest-alpha-vault

Query parameters

liveLiquiditystringOptionalDefault: false

Responses

200

Vault asset positions

application/json

404

Not found

application/json

500

Server error

application/json

get

/vaults/{slug}/positions

HTTPcURLJavaScriptPython

GET /v1/vaults/{slug}/positions HTTP/1.1
Host: api.nest.credit
Accept: */*

{
  "data": {
    "vaultAddress": "text",
    "positions": {
      "liquidAssets": [
        {
          "tokenAddress": "text",
          "chainId": 1,
          "symbol": "text",
          "position": {
            "value": 1
          },
          "pendingTransactions": [
            {
              "value": 1
            }
          ]
        }
      ],
      "yieldAssets": [
        {
          "slug": "text",
          "tokens": [
            {
              "tokenAddress": "text",
              "chainId": 1,
              "symbol": "text",
              "position": {
                "amount": 1,
                "price": 1,
                "value": 1,
                "yield": 1
              },
              "pendingTransactions": [
                {
                  "type": "PendingDeposit",
                  "amount": 1,
                  "price": 1,
                  "value": 1,
                  "requestId": 1
                }
              ]
            }
          ]
        }
      ]
    },
    "supplyByChain": {
      "ANY_ADDITIONAL_PROPERTY": {
        "supply": 1
      }
    },
    "errors": [
      {
        "source": "superstate",
        "operation": "getPendingTransactions",
        "message": "superstate getPendingTransactions timed out after 10000ms",
        "code": "TIMEOUT",
        "timestamp": 1704067200
      }
    ]
  }
}