Query premium locations
POST/location/query
Searches premium property data for locations that match a date range and optional geographic filters.
Supported query types are new_move_ins and permits. New move-in results are sorted by latest deed recording date. Permit results are sorted by addressMasterId.
Entitlements required: new_move_ins queries require the new_move_ins entitlement. permits queries require the permits entitlement, plus the entitlement for each requested permit type.
Each response returns up to 1,000 locations. If the response includes a cursor, send it with the same filter to fetch the next page.
Permit status mapping: the permitStatuses filter accepts generalized statuses, each of which expands to one or more raw permit statuses:
| Generalized status | Raw statuses |
|---|---|
submitted | applied, filed, triage, plancheck |
approved | approved, issued, reinstated |
completed | complete, final |
cancelled | rejected, revoked, canceled, suspended, withdrawn, expired |
any | all statuses (no filter applied) |
Request
Responses
- 200
- default
- 4XX
Success
Error
Unauthorized