Skip to main content

Response Format

All successful API responses follow this structure:

Response Fields

  • results - Array of result objects
  • filter - Applied filter (if any)
  • sort - Applied sort configuration
  • pagination - Pagination metadata
    • page - Current page number
    • perPage - Results per page
    • pageCount - Total number of pages
    • resultCount - Total number of results matching the query

Metric Objects

Numeric metrics on assets and tokens are returned as objects containing the current value plus historical snapshots and deltas:
Not all fields are present on every metric — only periods with available data are included.

Timeseries Responses

Aggregate timeseries endpoints (/v4/assets/aggregates/timeseries, /v4/tokens/aggregates/timeseries) return a different shape. Each result contains a measure descriptor, a group descriptor, and an array of points:
  • measure — the metric being returned (use the Data Catalog to discover available measures)
  • group — what the data is grouped by (e.g., a specific asset, token, or asset class)
  • points — array of [date, value] pairs in chronological order

Error Handling

HTTP Status Codes

Error Response Format

Common Errors

Invalid Filter

Invalid Operator

Rate Limit Exceeded

When you exceed a rate limit, the API returns 429 with headers indicating when you can retry. See Rate Limits for details.