Skip to main content
GET
Location Suggestions

Query Parameters

query
string
required
Partial location to autocomplete (e.g. austi, 9021, toron).
market
string
default:"us"
Which market to source suggestions from: us (realtor.com) or ca (realtor.ca).
limit
integer
default:10
Maximum number of suggestions to return. Range: 1 - 25.

Response

market
string
The market the suggestions came from.
query
string
The query prefix that was autocompleted.
suggestions
array
Array of suggestion objects.

Example Response

Each autocomplete request costs 2 credits. Failed requests are not charged.

Authorizations

x-api-key
string
header
required

Query Parameters

query
string
required

Partial location prefix.

market
enum<string>
default:us

Market to source suggestions from.

Available options:
us,
ca
limit
integer
default:10

Maximum number of suggestions (1-25).

Required range: 1 <= x <= 25

Response

200 - application/json

Suggestions

market
string
query
string
suggestions
object[]