Skip to main content
POST
/
api
/
propertyfinder
/
locations
/
search
/propertyfinder/locations/search
curl --request POST \
  --url https://api.anysite.io/api/propertyfinder/locations/search \
  --header 'Content-Type: application/json' \
  --header 'access-token: <api-key>' \
  --data '
{
  "keyword": "<string>",
  "count": 2,
  "timeout": 300,
  "domain": "ae"
}
'
[
  {
    "id": "<string>",
    "@type": "@propertyfinder_location",
    "name": "<string>",
    "alias": "<string>",
    "path": "<string>",
    "path_name": "<string>",
    "location_type": "<string>",
    "latitude": 123,
    "longitude": 123,
    "children_count": 123
  }
]

Authorizations

​
access-token
string
header
required

API token from the dashboard

Headers

​
access-token
string
required

Body

application/json
​
keyword
string
required

Location name to look up (city, community or building)

Minimum string length: 1
​
count
integer
required

Max number of results to return

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

Max scrapping execution timeout (in seconds)

Required range: 20 <= x <= 1500
​
domain
enum<string>
default:ae

Country marketplace

Available options:
ae,
sa,
qa,
bh,
eg

Response

Successful Response

​
id
string
required
​
@type
string
default:@propertyfinder_location
​
name
string | null
​
alias
string | null
​
path
string | null
​
path_name
string | null
​
location_type
string | null
​
latitude
number | null
​
longitude
number | null
​
children_count
integer | null