curl --request GET \
--url https://api.shovels.ai/v2/meta/coverage \
--header 'X-API-Key: <api-key>'import requests
url = "https://api.shovels.ai/v2/meta/coverage"
headers = {"X-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)HttpResponse<String> response = Unirest.get("https://api.shovels.ai/v2/meta/coverage")
.header("X-API-Key", "<api-key>")
.asString();package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.shovels.ai/v2/meta/coverage"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-Key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}require 'uri'
require 'net/http'
url = URI("https://api.shovels.ai/v2/meta/coverage")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.shovels.ai/v2/meta/coverage",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-API-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}{
"items": [
{
"field": "fees",
"tier": "missing",
"fill_pct": 0.02,
"permits_total": 12034
},
{
"field": "job_value",
"tier": "partial",
"fill_pct": 0.41,
"permits_total": 12034
}
]
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Get Coverage
Returns per-field data coverage tiers (partial or missing) for the specified geography and date range. Coverage is bucketed by each permit’s start_date year; every calendar year the range touches is counted in full. For a whole-calendar-year window the totals equal a start_date-filtered permit search over the same window at 5-digit ZIP granularity. A sub-year window still counts its touched years in full, so it can report a broader population than the search. ZIP coverage is bucketed at the 5-digit level, so a search narrowed to a ZIP+4 extension returns a subset of that population. Fields classified as reliable (fill rate >= 80%) are omitted. Empty windows return every tracked field as missing with permits_total=0.
curl --request GET \
--url https://api.shovels.ai/v2/meta/coverage \
--header 'X-API-Key: <api-key>'import requests
url = "https://api.shovels.ai/v2/meta/coverage"
headers = {"X-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)HttpResponse<String> response = Unirest.get("https://api.shovels.ai/v2/meta/coverage")
.header("X-API-Key", "<api-key>")
.asString();package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.shovels.ai/v2/meta/coverage"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-Key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}require 'uri'
require 'net/http'
url = URI("https://api.shovels.ai/v2/meta/coverage")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.shovels.ai/v2/meta/coverage",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-API-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}{
"items": [
{
"field": "fees",
"tier": "missing",
"fill_pct": 0.02,
"permits_total": 12034
},
{
"field": "job_value",
"tier": "partial",
"fill_pct": 0.41,
"permits_total": 12034
}
]
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Authorizations
Query Parameters
One of 'state', 'county', 'city', 'zipcode', 'jurisdiction'. Determines how geo_id is parsed.
state, county, city, zipcode, jurisdiction 2-letter state code, 5-digit ZIP, or base64 geolocation ID for city/county/jurisdiction.
Inclusive lower bound of the window. Format: YYYY-MM-DD. The coverage year set includes every year the range touches.
Inclusive upper bound of the window. Format: YYYY-MM-DD. Must be >= date_from.
Response
Per-field coverage rows ordered by tier then field.
Response envelope for /v2/meta/coverage.
Bounded to one item per tracked field; no pagination.
Per-field coverage rows for fields in the partial or missing tier, ordered by tier then field.
Show child attributes
Show child attributes
Was this page helpful?

