Suggest US property addresses from a partial string
GET /api/properties/auto-complete/
Free
What it returns
Up to 5 address suggestions matching a partial address string. Powered by a national address graph and curated to US street-level results only — city names, state codes, and ZIP codes alone return no matches.
When to use it
- Power a typeahead input on a "lookup property" form.
- Resolve user-typed input to a canonical address string before calling info / current-estimate.
- Disambiguate between similar-named streets in the same city.
Pricing
Free — 0 credits. Safe to fire on every keystroke (debounce in the client recommended for cost-of-network, not credits).
Errors
| Status | Meaning |
|---|---|
| 400 | input parameter missing or shorter than 2 characters. |
| 401 | Authentication failed. |
| 503 | Upstream address service unavailable. Retry with backoff. |
FAQ
Does this work for commercial addresses?
No. Only US residential street addresses are returned. The endpoint upstream filters to area_type == "address" records only.
Can I autocomplete by ZIP code?
No — ZIP-only input returns an empty data array. Provide a street fragment with at least one number or street word.
Parameters
input(query, required) — Partial address. Minimum 2 characters. Example: 4411 E Hidden.
Responses
200400— input is missing or shorter than 2 characters.401— Authentication failed — missing or invalid API key. Costs 0 credits.503— Upstream address service is unavailable. Retry with backoff.
More in Property Lookup
- Full property record for a US residential property —
GET /api/properties/info/
Full property record for a single US residential property — address, coordinates, listing status and price, AVM-estimated value, size, days on market, building/lot/parking/interior breakdown, listing-office details, recent property history, and nearby school ratings. - Same as `info` but always force-fetches fresh data from the source —
GET /api/properties/updated-info/
Identical response shape to info — see that endpoint's docs for fields and FAQ. - Paginated, filterable property search with ROI fields —
GET /api/properties/bulk-info/
Paginated search across all US residential properties matching geo + price + bed/bath/sqft/year-built/DOM/lot filters.