Skip to main content
POST
/
api
/
rightmove
/
locations
/
search
/rightmove/locations/search
curl --request POST \
  --url https://api.anysite.io/api/rightmove/locations/search \
  --header 'Content-Type: application/json' \
  --header 'access-token: <api-key>' \
  --data '
{
  "query": "<string>",
  "count": 10,
  "timeout": 300
}
'
[
  {
    "location_id": "<string>",
    "@type": "@rightmove_location",
    "type": "<string>",
    "display_name": "<string>"
  }
]

Authorizations

​
access-token
string
header
required

API token from the dashboard

Headers

​
access-token
string
required

Body

application/json
​
query
string
required

Location text to resolve

Minimum string length: 1
Examples:

"London"

"SW1X"

"Manchester"

​
count
integer
required

Max number of matches to return

Required range: 1 <= x <= 20
​
timeout
integer
default:300

Max scrapping execution timeout (in seconds)

Required range: 20 <= x <= 1500

Response

Successful Response

​
location_id
string
required
​
@type
string
default:@rightmove_location
​
type
string | null
​
display_name
string | null