Get zone details

get

Returns detailed information about a specific zone (H3 cell), including available capture types and mission dates. Pass ?entitled=true to return only data the authenticated user is entitled to.

Authorizations

x-api-keystringRequired

API key passed via request header. Either this or the api_key query parameter is required.

Path parameters

h3IdstringRequired

H3 cell identifier (zone hash)

Example: 89283082803ffffPattern: ^[0-9a-fA-F]+$

Query parameters

captureTypesstringOptional

Comma-separated list of capture types to filter by. Valid values: panorama, orthomosaic, image. Unrecognized values are ignored. Example: panorama,orthomosaic

startDatestring · date-timeOptional

Inclusive lower bound on capture date (ISO 8601). Coverage captured before this is excluded. Example: 2024-01-01T00:00:00.000Z

endDatestring · date-timeOptional

Inclusive upper bound on capture date (ISO 8601). Coverage captured after this is excluded. Example: 2024-12-31T23:59:59.000Z

entitledbooleanOptional

Filter by user entitlements (requires auth)

Default: false

Responses

200

Zone details

application/json

h3IdstringRequired

H3 cell identifier

latestCapturestring · date-time · nullableRequired

Most recent capture date

missionCountintegerRequired

Total number of missions

previewUrlstring · nullableOptional

Relative URL path for preview image

401

Unauthorized - entitled=true requires authentication

404

Zone not found

get/developer-api/coverage-map/zone/{h3Id}

GET /developer-api/coverage-map/zone/{h3Id} HTTP/1.1
Host: world.spexi.com
x-api-key: YOUR_API_KEY
Accept: */*

{
  "h3Id": "text",
  "captureTypes": [
    "panorama"
  ],
  "missions": [
    {
      "missionId": 1,
      "captureTypes": [
        "panorama"
      ],
      "captureDate": "2026-01-01T00:00:00.000Z"
    }
  ],
  "latestCapture": "2026-01-01T00:00:00.000Z",
  "missionCount": 1,
  "previewUrl": "text"
}