Skip to main content
POST
/
api
/
housing
/
locations
/
autocomplete
/housing/locations/autocomplete
curl --request POST \
  --url https://api.anysite.io/api/housing/locations/autocomplete \
  --header 'Content-Type: application/json' \
  --header 'access-token: <api-key>' \
  --data '
{
  "keyword": "<string>",
  "count": 2,
  "timeout": 300,
  "channel": "buy"
}
'
[
  {
    "id": "<string>",
    "@type": "@housing_location",
    "name": "<string>",
    "type": "<string>",
    "sub_type": "<string>",
    "display_type": "<string>",
    "city": "<string>",
    "locality_gid": "<string>",
    "url": "<string>"
  }
]

Authorizations

​
access-token
string
header
required

API token from the dashboard

Headers

​
access-token
string
required

Body

application/json
​
keyword
string
required

Search prefix: locality, landmark, project, builder or city name

Minimum string length: 1
​
count
integer
required

Max number of suggestions to return

Required range: x >= 1
​
timeout
integer
default:300

Max scrapping execution timeout (in seconds)

Required range: 20 <= x <= 1500
​
channel
enum<string>
default:buy

Search channel the suggestions are scoped to

Available options:
buy,
rent,
commercial,
paying_guest,
plots

Response

Successful Response

​
id
string
required
​
@type
string
default:@housing_location
​
name
string | null
​
type
string | null
​
sub_type
string | null
​
display_type
string | null
​
city
string | null
​
locality_gid
string | null
​
url
string | null