API Reference

Sample Use Case - geoid and Postcode

get
https://app.regrid.com/api/v2//parcels/query?fields[geoid][eq]=2488&fields[postcode][eq]=J9T1H7

Find all parcels with geoid 2488 and Postcode J9T1H7. Limit your result with the limit parameter. Note: the example shown uses Canada (ca).

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
enum
required

ISO 3166-1 alpha-2 country code for international data. Available countries: ca (Canada), es (Spain), fr (France), it (Italy).

Allowed:
Query Params
string
required

Using the geoid code

string
required

Using the Postcode.

boolean

Default false: A true value allows county-specific fields to be passed through beyond standard schema fields only. Note: only supported for Canada (ca).

boolean

Set to true to enable count of parcels in query.

boolean

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

boolean

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

Responses

Updated about 1 month ago

Did this page help you?
Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 1 month ago

Did this page help you?