Read the cells of a cell zone
Returns the H3 cells of a cell-layer zone.
format=list(default): a page of cell IDs in index order,limitup to 100,000 (default 10,000), paged withnext_cursor.values=trueadds the layer's per-cell values as arrays aligned withcells.format=count: just{h3_resolution, count}.bbox(west,south,east,north) limits the answer to cells inside the box. A box covering more than 500,000 cells is 413.
A zone that is not in a cell layer is 404 Not a cell zone.
This is our own API, not Geoapify-compatible. Every request costs 1 rivet.
apiKey<token>Your API key from the dashboard, sent as ?apiKey=<key>.
id*stringZone ID: the zone's layer Place ID, gp:layer:<slug>:<uuid>, exactly as place_id returns it. Colons may be sent raw or as %3A. A bare UUID is 404.
^gp:layer:[a-z0-9_]{2,40}:[0-9a-f-]{36}$format?stringlist for cell IDs, count for the number of cells.
"list""list""count"bbox?stringwest,south,east,north.
limit?integerCells per page (list format).
1 <= value <= 10000010000values?booleantrue adds the per-cell values.
falsecursor?stringOpaque next_cursor from the previous page. Omit for the first page.
Cells of the zone.
application/json- response
format=list: a page of cell IDs. format=count: just h3_resolution and count (of the whole zone, or of the bbox).
h3_resolution*integercount*integercells?array<string>H3 cell IDs in index order. List format only.
next_cursor?|List format only.
values?List format with values=true: one array per layer cell_value_keys entry, aligned with cells.
curl -X GET 'https://api.data.graphitelab.ai/v1/custom/zones/gp:layer:coverage:3f6c0a52-8c1e-4c5e-9a64-0f1b2d7e9a10/cells'{ "h3_resolution": 7, "count": 3, "cells": [ "872661a20ffffff", "872661a21ffffff", "872661a23ffffff" ], "next_cursor": null, "values": { "households": [ 95, 120, 40 ] }}