Create a country-specific points batch job

post

https://app.regrid.com/api/v2/{country_code}/batch/points

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.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

country_code

string

enum

required

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

Allowed:

Query Params

callback_url

string

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

return_geometry

boolean

Defaults to true

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

radius

integer

≤ 32000

Defaults to 0

(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_stacked

boolean

Defaults to true

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

return_custom

boolean

Defaults to false

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

return_field_labels

boolean

Defaults to false

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

return_custom_id

boolean

Defaults to false

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).

Body Params

file

A CSV file with a header column containing lat, lon, custom_id (optional) columns

Responses

400

Bad request. Invalid input parameters.

401

Unauthorized. Invalid API token.

413

Payload too large. Maximum allowed is 50MB or 100,000 points.

202Batch job created successfully