ZIP codes and coverage
Snapshots of one or several ZIP codes, the sellers in a ZIP code, and where the data service has data.
Read a ZIP code’s snapshot
Cost: Free
Returns the headline numbers the data service holds for one ZIP code: its purchases, prices, buyers, listings and agents.
Free: nothing is charged. An Idempotency-Key is ignored here.
Coverage. A place outside the data’s coverage is refused before anything is charged; the docs page states where the data covers.
path Parameters
zip^[0-9]{5}$ · requiredA five-digit ZIP code. A ZIP code in any other form is refused before anything is charged.
Headers
AuthorizationThe Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
Read a ZIP code’s snapshot › Responses
The data service’s answer: a JSON object carrying data and meta. A valid answer with nothing in it is still an answer; this call is free either way.
List the sellers in a ZIP code
Cost: $1.00 per list · desks only
Returns the companies that sold homes in one ZIP code, most sales first, with how quickly they resold.
This is a Metered Call. If the data service rejects the request, fails or does not answer in time, the charge is returned to the Account as a Refund. An empty answer for a place inside the data’s coverage is an answer, and it is charged.
Coverage. A place outside the data’s coverage is refused before anything is charged; the docs page states where the data covers. When the place a request names cannot be checked against the coverage and the answer is empty, the call answers 422 property-not-found and its charge is returned.
path Parameters
zip^[0-9]{5}$ · requiredA five-digit ZIP code. A ZIP code in any other form is refused before anything is charged.
Headers
AuthorizationThe Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
Idempotency-KeyAn opaque string of your choosing that makes retrying this request safe. Optional — a request without one is never an error, and is charged per call. Reusing a key with the same request — the same path and the same query string — within 24 hours returns the stored result and is not charged again, but only when the earlier call succeeded and its response was stored. If the earlier call was refunded or ended without a stored response, the key is taken over: the new request runs and is charged. Otherwise reusing a key with a different request, or on another endpoint, is refused as a conflict, and nothing is charged for it. If an identical request carrying the same key is still in flight, this one waits briefly for that result; if it does not arrive, the response is 409 with a Retry-After header and nothing is consumed for it. Keys are scoped to your Account — one Account never replays another Account’s result.
X-Customer-Reference^[A-Za-z0-9._:-]{1,6…Optional. Your own ID for the customer this call is for — an ID, not a name or email. Shown back to you grouped by customer on the Usage page.
List the sellers in a ZIP code › Responses
The data service’s answer: a JSON object carrying data and meta. A valid answer with nothing in it is still an answer, and it is charged.
Read a snapshot of several ZIP codes
Cost: Free
Returns the headline numbers the data service holds for a list of ZIP codes read together (the ZIP snapshot), and says which of them the data covers. zip is required.
Free: nothing is charged. An Idempotency-Key is ignored here.
Coverage. A place outside the data’s coverage is refused before anything is charged; the docs page states where the data covers.
query Parameters
zipFive-digit ZIP codes, comma-separated or as repeated zip parameters. Required. The data service checks the list: a list it refuses is answered 400 upstream-rejected-request, and the charge comes back as a Refund.
Headers
AuthorizationThe Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
Read a snapshot of several ZIP codes › Responses
The data service’s answer: a JSON object carrying data and meta. A valid answer with nothing in it is still an answer; this call is free either way.
See where the data service has data
Cost: Free
Returns which states the data service covers, with the dates of the data behind each.
Free: nothing is charged. An Idempotency-Key is ignored here.
Headers
AuthorizationThe Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
See where the data service has data › Responses
The data service’s answer: a JSON object carrying data and meta. A valid answer with nothing in it is still an answer; this call is free either way.