Sign in

v1

latestOpenAPI 3.0.02026-07-26432882.9 KB
Batch Operations

Create a country-specific points batch job

Same as batch/points but for a specific country code like 'ca' for Canada. This endpoint receives a list of points in two forms: A standard CSV file upload, or the API v2 standard GeoJSON format containing a Feature Collection of Point Features.

post/{country_code}/batch/points

Path parameters

country_code'ca' | 'us' required

The country code (e.g., 'ca' for Canada)

Query parameters

callback_urlstring

Optional webhook to notify when the job is complete (tries up to 3 times)

return_geometryboolean

Default true. Features are returned without geometry values. This reduces the payload size significantly if only field data is required.

radiusinteger

(Default 0, Maximum 32000) Radius in meters for which all Parcel records will be returned if they are within the radius zone from each point. Note area limit applies to the total area of all points.

return_stackedboolean

Default true. A false value returns the first parcel if geometries are identical.

return_customboolean

Default false. A true value allows county-specific fields to be passed through beyond standard schema fields only.

return_field_labelsboolean

Default false. A true value shows the naming convention for each standardized schema field.

return_custom_idboolean

Default false. Set to true when input GeoJSON features include a 'custom_id' field in the 'properties' object. This flag enables the resulting parcels to include the user-set custom ID for matching parcel(s).

Response

Batch job created successfully

messagestring
job_uuidstring uuid
status'queued'

Example response

{
  "message": "Processing 'points' job type",
  "job_uuid": "9fa5920e-29ab-49a7-98a9-e781da6385c8",
  "status": "queued"
}