Skip to main content

Endpoint

POST /info

Request Body

ParameterTypeDescription
type*stringMust be "earn"

Response

{
  "apy": 1250,
  "tvl": "1000000.00",
  "available": "800000.00",
  "utilization": 0.2,
  "nextAccrualTimestamp": 1701234567890
}

Response Fields

FieldTypeDescription
apynumberAnnual Percentage Yield in basis points (1250 = 12.5%)
tvlstringTotal Value Locked in the pool (USDC)
availablestringAvailable liquidity for borrowing (USDC)
utilizationnumberUtilization rate as decimal (0.2 = 20%)
nextAccrualTimestampnumber | nullTimestamp of next interest accrual (ms)

Example Request

curl -X POST https://api.notional.xyz/info \
  -H "Content-Type: application/json" \
  -d '{
    "type": "earn"
  }'

Notes

  • APY in basis points (1250 = 12.5%)
  • APY changes dynamically based on utilization
  • Interest accrues hourly