Query coverage

get

Query coverage data by bounding box or point. Returns aggregated zones with coverage information. 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.

Query parameters

bboxstringOptional

Bounding box to query, in format minLon,minLat,maxLon,maxLat. Provide at least one of bbox or point; if both are supplied, bbox is used. Example: -123.2,49.1,-122.9,49.3

pointstringOptional

Point to query, in format lon,lat. Provide at least one of bbox or point; ignored when bbox is also supplied. Example: -123.1,49.25

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). Example: 2024-01-01T00:00:00.000Z

endDatestring · date-timeOptional

Inclusive upper bound on capture date (ISO 8601). Example: 2024-12-31T23:59:59.000Z

limitinteger · min: 1 · max: 1000Optional

Maximum number of zones to return. Must be between 1 and 1000. The default is 100.

Default: 100

entitledbooleanOptional

Filter by user entitlements (requires auth)

Default: false

Responses

200

Coverage query results

application/json

totalintegerRequired

Number of zones returned after applying the query limit.

400

Invalid query: missing bbox/point, malformed bbox/point format, or coordinates out of range

401

Unauthorized - entitled=true requires authentication

get/developer-api/coverage-map/query

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

{
  "zones": [
    {
      "h3Id": "text",
      "captureTypes": [
        "panorama"
      ],
      "latestCapture": "2026-01-01T00:00:00.000Z",
      "missionCount": 1
    }
  ],
  "total": 1
}