Skip to main content
POST
/
api
/
twogis
/
regions
/
search
/twogis/regions/search
curl --request POST \
  --url https://api.anysite.io/api/twogis/regions/search \
  --header 'Content-Type: application/json' \
  --header 'access-token: <api-key>' \
  --data '
{
  "count": 2,
  "timeout": 300,
  "query": "Москва"
}
'
[
  {
    "id": "<string>",
    "name": "<string>",
    "@type": "@twogis_region",
    "type": "<string>"
  }
]

Authorizations

​
access-token
string
header
required

API token from the dashboard

Headers

​
access-token
string
required

Body

application/json
​
count
integer
required

Max number of regions to return

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

Max scrapping execution timeout (in seconds)

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

City/region name to filter by; omit to list all 2GIS regions

Example:

"Москва"

Response

Successful Response

​
id
string
required
​
name
string
required
​
@type
string
default:@twogis_region
​
type
string | null