Logo

regions

Returns a list of regions.

Request

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

Arguments

Name
Type
Description
first
Optional
Int
The number of items on the page. Used for forward pagination.
after
Optional
String
The cursor of the item relative to which the next items should be returned. Used for forward pagination.
last
Optional
Int
The number of items on the page. Used for backward pagination.
before
Optional
String
The cursor of the item relative to which the previous items should be returned. Used for backward pagination.
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 RegionConnection.

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 located within the specified region.

Returns a list of regions by a search term.

Returns a list of regions located near the specified location.

Detects the region by the IP address.