Sign in

v1

latestOpenAPI 3.0.12026-07-265331168.0 KB
Country

Search Country

Search Country entries using various filters.

get/public/user/country/search

Query parameters

country_idstring

Unique two-letter identifier of the Country

country_namestring

Name of the Country

continent_idstring

Identifier of the Continent where the Country is located

country_is_european_unionboolean

Boolean flag indicating if the Country is a member of the European Union

country_aliasstring

Alias or alternative name for the Country

country_node_countinteger

The current number of online nodes in the Country

per_pageinteger

Number of items per page for pagination

pageinteger

Page number for pagination

sort_bystring

Key for sorting or random.

Response

Successful Country search

item_countinteger

Total number of Country items returned in the data field.

messagestring

Status message for the search.

pageinteger

Current page number of the search results returned.

per_pageinteger

Number of Country items returned per page.

total_countinteger

Total of Country items that match the search filter.

Example response

{
  "data": [
    {
      "continent_id": "eu",
      "country_alias": "fr",
      "country_id": "fr",
      "country_is_european_union": true,
      "country_name": "France",
      "country_node_count": 1234
    }
  ],
  "item_count": 1,
  "message": "Country search successful.",
  "page": 1,
  "per_page": 10,
  "total_count": 1
}