API

You can build on top of APY using our public API. Feel free to mention us on Twitter if you create a useful tool for the community.

Pools

GET /pools

Retrieve metadata and details for all available pools.

200

{
  "pools": [
  {
    "tokenName": "Yield",
    "tokenSymbol": "YIELD",
    "tokenAddress": "XXX",
    "poolId": 0,
    "poolEnabled": true,
    "totalStaked": 1001000,
    "amountTokenRequired": 1,
    "rewardMultiplier": 100,
    "tokenSupply": 10000028,
    "tokenMarketCap": 8.140916842512661,
    "tokenPrice": 0.8140894048009326,
    "creationTime": 1728852130,
    "lockTime": 300,
    "percent": 100,
    "decimals": 6,
    "apr": 1451214786.0559258,
    "tips": 10200000000
  },
  ]
}

400

{
  "error": "Invalid request"
}

Tips

GET /tips

Retrieve tipping steps and multipliers for pools.

200

{
  "tipsStepsAndMultiplier": [
    "steps": [],
    "multiplier": [
        1,
        0,
        0,
        0,
        0,
        188,
        160
        ]
    ]
}

400

{
  "error": "Invalid request"
}

Yield

GET /yield-price

Get the current market price of the $YIELD token.

200

{
  "yieldPrice": 1.5
}

400

{
  "error": "Invalid request"
}

Frontend

GET /front

Retrieve full frontend data: pools, tips, $YIELD price, and SOL price.

Response

200

{
  "pools": [...],
  "tipsStepsAndMultiplier": {...},
  "yieldPrice": 1.5,
  "solPrice": 187.77,
}

400

{
  "error": "Invalid request"
}