Skip to main content
POST
/
api
/
hh
/
areas
/hh/areas
curl --request POST \
  --url https://api.anysite.io/api/hh/areas \
  --header 'Content-Type: application/json' \
  --header 'access-token: <api-key>' \
  --data '
{
  "timeout": 300,
  "area_id": "113"
}
'
[
  {
    "@type": "@hh_area",
    "id": 123,
    "parent_id": 123,
    "name": "<string>",
    "utc_offset": "<string>",
    "lat": 123,
    "lng": 123,
    "areas": []
  }
]

Authorizations

​
access-token
string
header
required

API token from the dashboard

Headers

​
access-token
string
required

Body

application/json
​
timeout
integer
default:300

Max scrapping execution timeout (in seconds)

Required range: 20 <= x <= 1500
​
area_id
string | null

Optional area id to return only that region and its nested sub-areas. Omit to return the full worldwide area tree.

Example:

"113"

Response

Successful Response

​
@type
string
default:@hh_area
​
id
integer | null
​
parent_id
integer | null
​
name
string | null
​
utc_offset
string | null
​
lat
number | null
​
lng
number | null
​
areas
Areas · array