Spatial Queries

Batch nearest neighbor

Find nearest features for multiple points against a single dataset. Points can be provided in the request body or referenced from an existing point dataset via the points_* parameters.

post/v1/nearest/batch

Request

  • Base URL: https://api.terranode.co
  • URL: https://api.terranode.co/v1/nearest/batch
  • Auth: API key in header x-api-key

Query parameters

system_datasetstring

System dataset slug (e.g., "us-counties"). Exactly one of system_dataset, dataset, or dataset_id is required.

datasetstring

User dataset slug. Exactly one of system_dataset, dataset, or dataset_id is required.

dataset_idstring uuid

User dataset UUID. Exactly one of system_dataset, dataset, or dataset_id is required.

versioninteger

Specific dataset version to query. Defaults to the latest version.

ninteger

Number of nearest features to return (max 20).

radiusnumber

Maximum search radius in meters (max 500,000 m / 500 km).

format'json' | 'csv'

Response output format.

async'true'

Set to "true" to submit as an asynchronous batch job. Returns a job ID for polling via GET /v1/jobs/{job_id}.

webhook_urlstring uri

URL to receive a webhook notification when the async job completes.

points_system_datasetstring

System dataset slug to use as the point source instead of the request body. The referenced dataset must contain Point geometries.

points_datasetstring

User dataset slug to use as the point source instead of the request body. The referenced dataset must contain Point geometries.

points_dataset_idstring uuid

User dataset UUID to use as the point source instead of the request body. The referenced dataset must contain Point geometries.

Request body

latnumber required
lngnumber required

Response

Synchronous batch result.

datasetstring required
versioninteger required
latency_msnumber required
api_versionstring required
semantics_versionstring required

Changes

No recorded changes to this operation across all 1 revision of this API.