Understanding Pagination

​

Overview

​

How It Works

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"

// Get the first page with 10 results
const response = await fetch(
  'https://api.blockworks.com/v1/assets?limit=10&page=1',
  { headers: { 'x-api-key': 'YOUR_API_KEY' } }
)
const data = await response.json()

import requests

# Get the first page with 10 results
response = requests.get(
    'https://api.blockworks.com/v1/assets',
    headers={'x-api-key': 'YOUR_API_KEY'},
    params={'limit': 10, 'page': 1}
)
data = response.json()

​

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

# 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 }

• The current page number × limit ≥ total count
• The data array is shorter than your limit
• The data array is empty

​

Related Endpoints

• List Assets - Paginated asset directory
• List Metrics - Paginated metrics catalog