Pagination Best Practices

import requests

API_KEY = "your-api-key"
BASE_URL = "https://connect.fordje.com"


def fetch_all_pages(endpoint, params=None):
    """Fetch all pages from a paginated endpoint."""
    if params is None:
        params = {}

    params.setdefault("page", 1)
    params.setdefault("page_size", 500)

    all_items = []

    while True:
        response = requests.get(
            f"{BASE_URL}{endpoint}",
            headers={"X-API-Key": API_KEY},
            params=params,
        )
        response.raise_for_status()
        body = response.json()

        items = body["data"]["items"]
        pagination = body["data"]["pagination"]

        all_items.extend(items)

        if pagination["page"] >= pagination["total_pages"]:
            break

        params["page"] = pagination["page"] + 1

    return all_items


# Fetch all AHJs
all_ahjs = fetch_all_pages("/v1/ahjs")
print(f"Retrieved {len(all_ahjs)} AHJs")

# Fetch all data points for California
ca_data_points = fetch_all_pages("/v1/data-points", {"state_codes": "CA"})
print(f"Retrieved {len(ca_data_points)} data points")

// Requires Node.js 18+ or an ES module environment for top-level await
const API_KEY = "your-api-key";
const BASE_URL = "https://connect.fordje.com";

async function fetchAllPages(endpoint, params = {}) {
  params.page = params.page || 1;
  params.page_size = params.page_size || 500;

  const allItems = [];

  while (true) {
    const query = new URLSearchParams(params).toString();
    const response = await fetch(`${BASE_URL}${endpoint}?${query}`, {
      headers: { "X-API-Key": API_KEY },
    });

    if (!response.ok) {
      throw new Error(`Request failed: ${response.status}`);
    }

    const body = await response.json();
    const { items } = body.data;
    const { page, total_pages } = body.data.pagination;

    allItems.push(...items);

    if (page >= total_pages) break;
    params.page = page + 1;
  }

  return allItems;
}

const allAhjs = await fetchAllPages("/v1/ahjs");
console.log(`Retrieved ${allAhjs.length} AHJs`);