Search one property for code-violation records

Returns indexed records for one address. The default is indexed-only; set live_search=true to query every eligible portal covering the property. Indexed records remain in the response when an optional live search is unavailable or fails, with details in live_search.message. A 202 response means portal work is pending—retry the identical request with the same Idempotency-Key after retry_after_seconds. Successful intervals, including zero-result searches, are memoized per property and portal, so later searches pull only missing coverage. Statuses: complete = all portals finished, complete_with_errors = indexed results plus a live-search error, pending = indexed results plus unfinished live work, unavailable = indexed results with no healthy live portal. One idempotency key creates one customer search even when several portals are queried.

get/api/v1/property/search

Request

  • Base URL: https://dirtsignal.com
  • URL: https://dirtsignal.com/api/v1/property/search
  • Auth: HTTP bearer

Query parameters

addressstring required
Example:2309 N Riverside Dr
citystring required
Example:Tampa
statestring required
Example:FL
live_searchboolean

Explicit opt-in for the broader public-portal query. The default indexed-only search never contacts a live portal.

Headers

Idempotency-Keystring

Recommended unique client request ID. Retrying with the same key reuses the original usage event and does not create a second billable search.

Response

Property search result and billing usage ID

Changes

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