Savings

Get current savings data

Returns the current APY, TVL, deposit cap, liquidity, and collateral composition for a savings vault, along with the vault share token and underlying asset token details (address, decimals, symbol, name).

get/v1/savings/{protocol}/{chain}/{token}

Path parameters

protocolstring required

Savings protocol. Supported: spark, sky (case-insensitive).

Example:spark

chainstring required

Chain name. Supported: mainnet (case-insensitive).

Example:mainnet

tokenstring required

Underlying asset symbol. Supported: usdc, usdt (case-insensitive). Not every protocol/chain/token combination exists — see the API description for the available vaults.

Example:usdc

Response

Current savings data for the requested vault.

Example response

{
  "data": {
    "vault": {
      "address": "0x28B3a8fb53B741A8Fd78c0fb9A6B2393d896a43d",
      "decimals": 6,
      "symbol": "spUSDC",
      "name": "Spark USDC"
    },
    "asset": {
      "address": "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48",
      "decimals": 6,
      "symbol": "USDC",
      "name": "USD Coin"
    },
    "apy": "0.0365",
    "tvl": "403886846.850673",
    "users": 1111,
    "depositCap": "2000000000",
    "liquidity": [
      {
        "protocol": "psm",
        "value": "3849983274.646926"
      }
    ],
    "collateralComposition": {
      "usds": [
        {
          "category": "Stablecoins",
          "value": "195743150.920491"
        },
        {
          "category": "Onchain Crypto Lending",
          "value": "68567180.437736"
        },
        {
          "category": "Short Duration Treasury Bills",
          "value": "66092816.698696"
        },
        {
          "category": "AAA Corporate Debt",
          "value": "18079571.770374"
        }
      ],
      "usdc": [
        {
          "category": "Idle",
          "value": "9999969.995893"
        }
      ]
    }
  }
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.