General Introduction
The Regrid API offers a flexible and dynamic set of features for querying Regrid Parcels by numerous fields, operators, geometries and allows for simple composition of API calls, from the output of one endpoint, to the input of another.
Our OpenAPI specification is available for download in the API section of your account, and in usable form in our API Sandbox. The following documentation expands upon the endpoint descriptions and field name and operator use in the OpenAPI spec.
Endpoints
All API requests are to the https://app.regrid.com/
domain. You can review our full description of endpoints at Regrid API Endpoints.
Responses
All API requests return a GeoJSON Feature Collection object containing an array of GeoJSON Features. Each Feature contains one Parcel Record with all of its attributes in the properties
object and its GeoJSON geometry in the geometry
object. A Feature Collection with an empty features
array means no Parcel Records could be matched based on the search criteria.
API Billing
Parcel API requests are tracked for billing by how many Parcel Records are returned in a response.
You will get multiple Parcel Records returned per Parcel API request depending on how you search for parcels via our Parcel API. Searches by specific fields like address, parcel number, owner name, polygon, and point with or without a radius
parameter are all examples of Parcel API requests that return multiple Parcel Records in each response.
The limit
parameter will limit the number of Parcel Records returned by a Parcel API request. The default limit is 20 Parcel Records, but can be set to any number from 1 to 1000. The limit
parameter is available for any Parcel API request that can return more than one Parcel Record.
The Parcel API Account Usage endpoint also provides real time usage information that can be used for monitoring Parcel Records remaining in your monthly or annual plan. There is no cost to using this endpoint. You are also able to use this endpoint within your workflow to track usage internally.
Authentication
All API requests must include a token
parameter. You can find this in Account Profile > API after logging into your account at regrid.com.
API request rates
API request rates are defined in terms of the maximum number of requests allowed per minute. Exceeding the API request rate will result in a 429 error
for rate limiting/throttling. The API server will reject any additional requests until the rate limit resets. It is important to adhere to the rate limits to avoid disruption in service and ensure compliance with the Regrid Terms of Use.
Rates are limited to 10 simultaneous API requests or approximately 200 API requests per minute. Additional capacity is available; please contact our sales team at parcels@regrid.com for details.