SHshovels
Meta

Get Coverage

Changed on

Returns per-field data coverage tiers (partial or missing) for the specified geography and date range. Coverage is counted over the exact inclusive date_from–date_to window, on each permit's start_date — the same column and bounds permit search applies. ZIP coverage is reported at five-digit granularity; a ZIP+4 input is truncated to its five-digit prefix and therefore describes a broader population than a ZIP+4 permit search. Fields classified as reliable (fill rate >= 80%) are omitted. Empty windows return every tracked field as missing with permits_total=0.

get/meta/coverage

Request

  • Base URL
    https://api.shovels.ai/v2
  • Auth
    API key in header X-API-Key

Query parameters

geo_type'state' | 'county' | 'city' | 'zipcode' | 'jurisdiction' required

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

geo_idstring required

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

date_fromstring date required

Inclusive lower bound of the window. Format: YYYY-MM-DD.

date_tostring 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.

Changes

  • e9f48948b723Revision changes
    • info

      added the optional property // to the response with the status

  • 64df4c8074f5Revision changes
    • warning

      added the new property_assess_market_value enum value to the // response property for the response status

    • warning

      added the new property_lot_size enum value to the // response property for the response status

    • warning

      added the new property_story_count enum value to the // response property for the response status

    • warning

      added the new property_unit_count enum value to the // response property for the response status