Return reference areas within a distance range of a geometry

Accepts a GeoJSON Polygon, MultiPolygon, or Point and returns reference areas whose great-circle distance to the input lies in [min_distance_m, max_distance_m] across all registered datasets. Content is negotiated via the Accept header:

• application/json (default) — StandardResponse[DistanceResponse].
• application/geo+json — a GeoJSON FeatureCollection.
• application/x-ndjson — server-side fan-out streamed as NDJSON. Within each per-source frame hits are sorted ASC by distance_m; cross-source ordering is completion order, so clients re-sort once the stream ends if they want a global view.

POST /v1/distance

Return reference areas within a distance range of a geometry

cURL

curl --request POST \
  --url https://api.example.com/v1/distance \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "input": {
    "geometry": {
      "coordinates": [
        [
          [
            123
          ]
        ]
      ],
      "type": "Polygon",
      "bbox": [
        123
      ]
    },
    "max_distance_m": 1,
    "crs": "<string>",
    "min_distance_m": 0
  },
  "reference_areas_country_iso3": "<string>",
  "reference_areas_source": "<string>",
  "reference_id": "<string>"
}
'

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

accept · string | null

Idempotency-Key · string | null

Body

application/json

input · DistanceInput · object · required

User-supplied data for the request — geometry, optional CRS, and the [min_distance_m, max_distance_m] bounds. Required.

Show child attributes

reference_areas_country_iso3 · string | null

ISO3 filter (e.g. 'BRA').

Required string length: 3

reference_areas_source · string | null

Source filter (e.g. 'wfs').

Maximum string length: 64

reference_id · string | null

Optional caller-provided reference identifier for audit/trace.

Maximum string length: 128

Response

200

application/json

Distance matches returned.