Check ZIP coverage

Returns whether DirtSignal has imported event records in a 5-digit ZIP, with the approximate record lookback age. This is a coverage signal only; it is not a title search, lien search, or guarantee that no records exist.

get/api/v1/coverage

Request

  • Base URL: https://dirtsignal.com
  • URL: https://dirtsignal.com/api/v1/coverage
  • Auth: none declared

Query parameters

zipstring
Example:33602

5-digit ZIP code. Either zip or address is accepted.

addressstring
Example:2309 N Riverside Dr Tampa FL 33602

Address text containing a 5-digit ZIP. Used when zip is omitted.

typestring
Example:code,sm

Optional comma-separated coverage source type filter: code, clerk, or sm. Special magistrate coverage is only returned by sm.

Response

Coverage result

zipstring nullable
coveredboolean nullable

True when imported event records exist in this ZIP; false when a ZIP was supplied and no imported rows exist; null when no ZIP could be parsed.

oldest_record_atstring nullable

Oldest event date found for the returned coverage sources.

lookback_labelstring nullable
messagestring nullable
typesstring[]

Coverage source types present in the returned, filtered sources.

Example response

{
  "zip": "33602",
  "lookback_label": "in the last 4 months",
  "message": "ZIP 33602 is covered by DirtSignal's imported records in the last 4 months.",
  "regions": [
    {
      "slug": "tampa-bay",
      "name": "Tampa Bay, FL"
    }
  ],
  "sources": [
    {
      "source_id": "us_fl_tampa_accela",
      "jurisdiction": "Tampa, FL",
      "type": "code",
      "region_slug": "tampa-bay",
      "region_name": "Tampa Bay, FL"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.