Skip to main content
GET
/
gateway
/
v1
/
onchain
/
yield
/
ranking
Yield Pool Ranking
curl --request GET \
  --url https://api.ask.surf/gateway/v1/onchain/yield/ranking
{
  "data": [
    {
      "apy": 123,
      "apy_base": 123,
      "apy_reward": 123,
      "pool_address": "<string>",
      "project": "<string>",
      "symbol": "<string>",
      "token_address": "<string>",
      "tvl_usd": 123,
      "version": "<string>"
    }
  ],
  "meta": {
    "cached": true,
    "credits_used": 123,
    "limit": 123,
    "offset": 123,
    "total": 123
  },
  "$schema": "<string>"
}

Query Parameters

project
string

Filter by protocol name like lido, aave, or uniswap

Example:

"aave"

sort_by
enum<string>
default:apy

Ranking metric: apy or tvl_usd. When sorted by apy, only pools with TVL >= $100k are included

Available options:
apy,
tvl_usd
Example:

"apy"

order
enum<string>
default:desc

Sort direction

Available options:
asc,
desc
Example:

"desc"

limit
integer<int64>
default:20

Results per page

Required range: 1 <= x <= 100
Example:

20

offset
integer<int64>
default:0

Pagination offset

Required range: x >= 0
Example:

0

Response

OK

data
object[] | null
required
meta
object
required
$schema
string<uri>

A URL to the JSON Schema for this object.

Example:

"https://example.com/schemas/DataResponseYieldRankingItem.json"