Skip to main content

​
Overview

The Blockworks API uses page-based pagination for endpoints that return large collections of data. This allows you to efficiently retrieve results in manageable chunks rather than loading everything at once.
TopicDetails
Pagination stylePage-based with ?page= and ?limit= query parameters.
Limit (results per page)Default is 100, max is 1000
Response structure{ data: [], total: number, page: number }
Affects these endpointsList Assets, List Metrics

​
How It Works

All paginated endpoints follow the same pattern:
  1. Request: Include ?page= and (optionally) ?limit= query parameters.
  2. Response: Contains data array, total count, and current page.
  3. Navigation: Increment page until you’ve retrieved all results.

​
Basic Example

# Get the first page with 10 results
curl -H "x-api-key: YOUR_API_KEY" \
  "https://api.blockworks.com/v1/assets?limit=10&page=1"

​
Response Structure

{
  "data": [
    {
      "id": 2,
      "code": "ETH",
      "title": "Ethereum",
      "slug": "ethereum",
      "category": "Infrastructure",
      "sector_id": 40,
      "is_supported": true
    },
    // ... 9 more assets
  ],
  "total": 1247,
  "page": 1
}

​
Best Practices

  • Respect rate limits by adding delays between requests when paging through large datasets.
  • Cache results when possible to avoid re-fetching the same data.
  • Use filters (project, category, etc.) to reduce the total number of pages needed.

​
Example Output

Here’s what you might see when paging through assets with limit=10: 
# Page 1 (10 items, total: 1247)
GET /v1/assets?limit=10&page=1
Response: { "data": [...], "total": 1247, "page": 1 }

# Page 2 (10 items, total: 1247)
GET /v1/assets?limit=10&page=2
Response: { "data": [...], "total": 1247, "page": 2 }

# Continue until page 125 (7 items remaining)
GET /v1/assets?limit=10&page=125
Response: { "data": [7 items], "total": 1247, "page": 125 }
You know you’ve reached the end when any of the following are true:
  • The current page number × limit ≥ total count
  • The data array is shorter than your limit
  • The data array is empty