Logo

searchRegions

Returns a list of regions by a search term.

Request

curl -X GET 'https://data-api.oxilor.com/rest/search-regions' \
	-H 'Authorization: Bearer YOUR_API_KEY'

Arguments

Name
Type
Description
searchTerm
Required
String
A query used to search for regions by name.
first
Optional
Int
The number of regions.
type
Optional
String
The type of the region. Possible values: continent, country, division1, division2, division3, division4, city.
countryCode
Optional
String
The code of the country (ISO-639-1).
division1Code
Optional
String
The code of the first-order country division.
division2Code
Optional
String
The code of the second-order country division.
division3Code
Optional
String
The code of the third-order country division.
division4Code
Optional
String
The code of the fourth-order country division.

Response

The method return Region[].

Make a real request

URL:
Response:
The response will be here

Other methods

Determines whether the request is authorized.

Returns the region by ID.

Returns a list of all continents.

Returns a list of all countries.

Returns a list of regions.

Returns a list of regions located within the specified region.

Returns a list of regions located near the specified location.

Detects the region by the IP address.