Skip to main content
GET
/
meta
/
coverage
Get Coverage
curl --request GET \
  --url https://api.shovels.ai/v2/meta/coverage \
  --header 'X-API-Key: <api-key>'
{
  "items": [
    {
      "field": "fees",
      "tier": "missing",
      "fill_pct": 0.02,
      "permits_total": 12034
    },
    {
      "field": "job_value",
      "tier": "partial",
      "fill_pct": 0.41,
      "permits_total": 12034
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.shovels.ai/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
X-API-Key
string
header
required

Query Parameters

​
geo_type
enum<string>
required

One of 'state', 'county', 'city', 'zipcode', 'jurisdiction'. Determines how geo_id is parsed.

Available options:
state,
county,
city,
zipcode,
jurisdiction
​
geo_id
string
required

2-letter state code, 5-digit ZIP, or base64 geolocation ID for city/county/jurisdiction.

​
date_from
string<date>
required

Inclusive lower bound of the window. Format: YYYY-MM-DD. The coverage year set includes every year the range touches.

​
date_to
string<date>
required

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 at most 10 items (one per tracked field); no pagination.

​
items
CoverageItem · object[]
required

Per-field coverage rows for fields in the partial or missing tier, ordered by tier then field.