Comprehensive guide to the Shovels REST API, including authentication, pagination, error handling, and getting started information.
X-API-Key: YOUR_API_KEY_HERE
.
Here’s an example request:
Type | Description |
---|---|
SSL Only | We require that all requests be made over SSL. |
UTF-8 Encoding | We use UTF-8 encoding for all requests and responses. |
Method | HTTP GET for all read calls. |
Date Format | All dates in the API are strings in the format: YYYY-MM-DD . |
Code | Description |
---|---|
200 OK | Everything worked as expected. |
400 Bad Request | There was something wrong with your request. Double-check your input. |
401 Unauthorized | You need to log in to access this. Make sure your API key is correct. |
402 Payment Required | You will get this error if your reach your trial API call limit. |
403 Forbidden | You don’t have permission to access this. |
404 Not Found | We couldn’t find what you’re looking for. Check the URL or resource ID. |
422 Unprocessable Entity | There’s an issue with the data you sent. Check Error Handling if you get this error. |
429 Too Many Requests | You’re sending requests too quickly. Slow down and try again later. |
500 Internal Server Error | Yikes, something went wrong on our end. Please let us know at support@shovels.ai |
next_cursor
value from the previous response using the cursor
parameternext_cursor
value will be null
.
page
parameter in your request:
cursor
and page
parameters are provided in the same request, cursor-based pagination takes precedence.
/v2/
. We plan to evolve our API by releasing new versions to ensure backward compatibility while maintaining a steady pace of continuous improvements.
api.shovels.ai/v2
.
geo_id
to point the query to the right place. If the query is for a specific object, like an individual permit, address, or contractor, then you’ll only need the corresponding id
field.
contractor_id
or address_id
, then it’s mandatory to first retrieve the foundational data point before getting the insights for it.
An example of this can be found in our Tutorial section.
body
: The error is in the request body.query
: The error is in the query parameters.path
: The error is in the URL path.header
: The error is in the request headers.404
error is to wonder if the query itself was incorrect, or somehow misconfigured.
While that may be the case, it’s also important to consider that there may be no data available at this time.
We talk about this in much more detail under the Shovels Foundations section, but to be succinct: there are many complications in obtaining complete and total permit data, from variability in digitization practices to required permit fields in individual jurisdictions. While we do our best, we aren’t there yet.
If you find that we’re missing key data for your needs, please reach out to Support and we’ll confirm for you whether we have it or not, and if not, add it to our roadmap to get it soon.