Skip to main content
POST
/
api
/
zefix
/
localities
/zefix/localities
curl --request POST \
  --url https://api.anysite.io/api/zefix/localities \
  --header 'Content-Type: application/json' \
  --header 'access-token: <api-key>' \
  --data '{
  "timeout": 300
}'
[
  {
    "name": "<string>",
    "@type": "@zefix_locality",
    "id": 123,
    "bfs_id": 123,
    "canton": "<string>",
    "register_office_id": 123,
    "alternate_names": [
      "<string>"
    ]
  }
]

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

Response

Successful Response

​
name
string
required
​
@type
string
default:@zefix_locality
​
id
integer | null
​
bfs_id
integer | null
​
canton
string | null
​
register_office_id
integer | null
​
alternate_names
string[]