Skip to main content
Your API key is required to authenticate all requests to the Shovels API.

​
Accessing Your API Key

  1. Log into your Shovels account
  2. Navigate to the Profile Settings section
  3. Your API key is displayed in the API Key field

​
Using Your API Key

Include your API key in the header of every API request: 
curl -X GET "https://api.shovels.ai/v2/meta/release" \
  -H "X-API-Key: YOUR_API_KEY_HERE"

​
Free Trial API Access

New accounts receive 250 credits to explore our capabilities before committing to a paid plan.
Each record returned by the API counts against your credits. A search returning 100 permits uses 100 credits; a single permit lookup uses 1 credit.

​
Tracking Your Usage

You can view your API credit usage in the Profile Settings or by calling the GET /v2/usage endpoint. Credits operate on a 30-day rolling window.

​
Need More Credits?

If you hit your limit and need more credits: