Skip to main content
POST
/
api
/
zapimoveis
/
locations
/
search
/zapimoveis/locations/search
curl --request POST \
  --url https://api.anysite.io/api/zapimoveis/locations/search \
  --header 'Content-Type: application/json' \
  --header 'access-token: <api-key>' \
  --data '
{
  "query": "<string>",
  "count": 2,
  "timeout": 300
}
'
[
  {
    "@type": "@zapimoveis_location",
    "category": "<string>",
    "name": "<string>",
    "neighborhood": "<string>",
    "zone": "<string>",
    "city": "<string>",
    "state": "<string>",
    "location_id": "<string>",
    "latitude": 123,
    "longitude": 123,
    "url": "<string>"
  }
]

Authorizations

access-token
string
header
required

API token from the dashboard

Headers

access-token
string
required

Body

application/json
query
string
required

Free-text location query (city, neighborhood or street name)

Minimum string length: 1
Examples:

"São Paulo"

"Moema"

"Avenida Paulista"

count
integer
required

Max number of locations to return

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

Max scrapping execution timeout (in seconds)

Required range: 20 <= x <= 1500

Response

Successful Response

@type
string
default:@zapimoveis_location
category
string | null
name
string | null
neighborhood
string | null
zone
string | null
city
string | null
state
string | null
location_id
string | null
latitude
number | null
longitude
number | null
url
string | null