International API
The Regrid International API is quite similar to our original US Parcel API. This section describes some differences and nuanced behavior that can be helpful in utilizing everything the API has to offer.
Country Codes
- Regrid supports multiple countries and can be switched to a different country when enabled on the account by including the country code in the URL.
To query Canada for example,
https://app.regrid.com/api/v2/ca/point?<parameters>...- Current countries supported: United States (US) and Canada (CA).
- A Country Code and
admin0values in results are refering to the two character ISO2 Country Code. - Use of country codes are treated as case-insensitive,
CAis treated the same asca, for example. - By default and for backward compatibility an API request URL without a country code returns United States parcel data if available on the account.
- If results from multiple countries are desired, one API call per country needs to be made.
Supported Endpoints
All endpoints are supported for international except: Typeahead, and Owner.
Supported Parameters
All international endpoints support the same parameters as US endpoints if the services exist.
For examples, requests including the paramaters return_matched_buildings, return_matched_addresses, return_enhanced_ownership and return_zoning set to true will be ignored in Canadian API requests.
return_custom: Custom fields are included in their owncustomcolumn within results if available.