Skip to main content
GET
/
gateway
/
v1
/
project
/
defi
/
metrics
Project DeFi Metrics
curl --request GET \
  --url https://api.ask.surf/gateway/v1/project/defi/metrics
{
  "data": [
    {
      "timestamp": 123,
      "value": 123
    }
  ],
  "meta": {
    "cached": true,
    "credits_used": 123,
    "limit": 123,
    "offset": 123,
    "total": 123
  },
  "$schema": "<string>"
}

Query Parameters

id
string

Surf project UUID. PREFERRED — always use this when available from a previous response (e.g. project_id from /fund/portfolio or id from /search/project). Takes priority over q.

Example:

"25c6612a-395c-4974-94eb-3b5f9f4b2ed7"

q
string

Fuzzy entity name search. Only use when 'id' is not available. May return unexpected results for ambiguous names.

Example:

"uniswap"

metric
enum<string>
required

Metric to query. Can be volume, fees (or fee alias), revenue, tvl, or users.

Available options:
volume,
fee,
fees,
revenue,
tvl,
users
Example:

"tvl"

from
string

Start of time range. Accepts Unix seconds (1704067200) or date string (2024-01-01)

Example:

"2024-01-01"

to
string

End of time range. Accepts Unix seconds (1706745600) or date string (2024-02-01)

Example:

"2024-02-01"

chain
enum<string>

Filter by chain. Can be ethereum, polygon, bsc, arbitrum, optimism, base, avalanche, fantom, or solana.

Available options:
ethereum,
polygon,
bsc,
arbitrum,
optimism,
base,
avalanche,
fantom,
solana
Example:

"ethereum"

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/DataResponseProjectMetricPoint.json"