AutoComplete
AutoComplete turns partial address input into ranked property and place suggestions. It is built for search bars: feed it keystrokes, then pass the chosen result straight into Property Search or Property Detail.
POST/v2/AutoComplete
Complete an address
Request attributes
- Name
search- Type
- string
- Description
The partial address or place string to complete. Required.
- Name
search_types- Type
- array
- Description
Which result types to return — address, city, county, neighborhood, ZIP, or APN. Defaults to full address.
- Name
latitude- Type
- number
- Description
Bias results toward this latitude.
- Name
longitude- Type
- number
- Description
Bias results toward this longitude.
- Name
precision- Type
- integer
- Description
How precise the returned matches must be.
Request
POST
/v2/AutoCompletecurl -X POST https://api.realestateapi.com/v2/AutoComplete \
-H "x-api-key: $REALESTATEAPI_KEY" \
-H "Content-Type: application/json" \
-d '{"search": "1 Rocket", "search_types": ["A"]}'
The full response schema for this endpoint — every field and enum — lives in the canonical reference. That content has not been ported to this site yet.