Skip to main content
GET
/
v1
/
realtor
/
autocomplete
Location Suggestions
curl --request GET \
  --url https://scrapebadger.com/v1/realtor/autocomplete \
  --header 'x-api-key: <api-key>'
{
  "market": "<string>",
  "query": "<string>",
  "suggestions": [
    {
      "id": "<string>",
      "type": "<string>",
      "label": "<string>",
      "city": "<string>",
      "state_code": "<string>",
      "postal_code": "<string>",
      "country": "<string>",
      "slug_id": "<string>",
      "geo_id": "<string>",
      "coordinate": {
        "lat": 123,
        "lon": 123
      },
      "market": "<string>"
    }
  ]
}

​
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

{
  "market": "us",
  "query": "austi",
  "suggestions": [
    {
      "id": "city:austin_tx",
      "type": "city",
      "label": "Austin, TX",
      "city": "Austin",
      "state_code": "TX",
      "postal_code": null,
      "country": "US",
      "slug_id": "Austin_TX",
      "geo_id": "1234",
      "coordinate": { "lat": 30.2672, "lon": -97.7431 },
      "market": "us"
    }
  ]
}
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[]