Get metric breakdown aggregation for multiple projects, chains, or products

curl --request POST \
  --url https://api.tokenterminal.com/v2/metric-breakdown \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "metric_ids": [
    "<string>"
  ],
  "interval": "24h",
  "group_by": "projects",
  "project_ids": [
    "<string>"
  ],
  "product_ids": [
    "<string>"
  ],
  "chain_ids": [
    "<string>"
  ],
  "market_sector_ids": [
    "blockchains-l1",
    "lending"
  ],
  "start": "2023-12-25",
  "end": "2023-12-25"
}
'

{
  "data": [
    {
      "data_id": "usual",
      "chain_id": "usual",
      "product_id": "usual",
      "metrics": {}
    }
  ],
  "errors": [
    {
      "code": "NOT_FOUND",
      "field": "project_ids",
      "value": "invalid-project"
    }
  ]
}

Metrics

Get metric breakdown aggregation for multiple projects, chains, or products

Use this endpoint to retrieve metric breakdown aggregation for multiple projects including avg, change, sum, trend, and latest values over a given interval or date range. When looking at cumulative metrics such as fees, reference sums for the total aggregate, and when looking at static metrics such as total value locked, reference latest values for the latest running total. See the response reference below for more details.

This endpoint supports partial success - if some of the requested metric, project, chain, or product IDs are not found, the endpoint will return data for the valid entities and include an errors array with details about the invalid ones.

POST

metric-breakdown

curl --request POST \
  --url https://api.tokenterminal.com/v2/metric-breakdown \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "metric_ids": [
    "<string>"
  ],
  "interval": "24h",
  "group_by": "projects",
  "project_ids": [
    "<string>"
  ],
  "product_ids": [
    "<string>"
  ],
  "chain_ids": [
    "<string>"
  ],
  "market_sector_ids": [
    "blockchains-l1",
    "lending"
  ],
  "start": "2023-12-25",
  "end": "2023-12-25"
}
'

{
  "data": [
    {
      "data_id": "usual",
      "chain_id": "usual",
      "product_id": "usual",
      "metrics": {}
    }
  ],
  "errors": [
    {
      "code": "NOT_FOUND",
      "field": "project_ids",
      "value": "invalid-project"
    }
  ]
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

metric_ids

string[]

required

Array of metric IDs to retrieve data for

interval

enum<string>

required

Time interval for aggregation

Available options:

24h,

7d,

30d,

90d,

180d,

365d,

ytd,

max

group_by

enum<string>

required

How to group the results

Available options:

projects,

chains,

chain-project,

chain-product,

chain-market-sector,

market-sector,

product

project_ids

string[]

Optional array of project IDs to filter by

product_ids

string[]

Optional array of product IDs to filter by

chain_ids

string[]

Optional array of chain IDs to filter by

market_sector_ids

string[]

Optional list of market sector IDs to filter by

Example:

["blockchains-l1", "lending"]

start

string<date>

Start date for the query

end

string<date>

End date for the query

Response

200 - application/json

data

object[]

Show child attributes

data.data_id

string

The ID of the project depending on grouping this may not be in the return.

Example:

"usual"

data.chain_id

string

The ID of the chain depending on grouping this may not be in the return.

Example:

"usual"

data.product_id

string

The ID of the product depending on grouping this may not be in the return.

Example:

"usual"

data.metrics

object

Show child attributes

data.metrics.{key}

object

Show child attributes

data.metrics.{key}.avg

number

Average value over the selected interval

data.metrics.{key}.change

number

Percentage change over the selected interval. Most useful with static metrics such as averages and running totals.

data.metrics.{key}.sum

number

Sum of values over the selected interval. Most useful for non-static or cumulative metrics where each day's values are unique.

data.metrics.{key}.trend

number

Trend indicator value. Most useful for non-static or cumulative metrics where each day's values are unique.

data.metrics.{key}.latest

number

Latest value for the metric. Most useful for static metrics such as averages and running totals.

errors

object[]

Optional array of errors that occurred during request processing. Only present if some requested entities were not found.

The endpoint returns data for valid entities even when errors are present, allowing partial success.

Show child attributes

errors.code

enum<string>

required

Error code indicating the entity was not found

Available options:

NOT_FOUND

errors.field

enum<string>

required

The request parameter field that contained the invalid value

Available options:

project_ids,

metric_ids,

chain_ids,

product_ids,

market_sector_ids

errors.value

string

required

The invalid ID value that was not found

Get metric aggregations for multiple projects List all datasets

⌘I

Overview

Endpoints

Get metric breakdown aggregation for multiple projects, chains, or products

Authorizations

Body

Response