Skip to main content
GET
Search Country

Authorizations

X-API-Private-Key
string
header
required

Private API key for user-level authentication.

X-API-Public-Key
string
header
required

Public API key for user-level authentication.

Query Parameters

country_id
string

Unique two-letter identifier of the Country

country_name
string

Name of the Country

continent_id
string

Identifier of the Continent where the Country is located

country_is_european_union
boolean

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

country_alias
string

Alias or alternative name for the Country

country_node_count
integer

The current number of online nodes in the Country

per_page
integer

Number of items per page for pagination

page
integer

Page number for pagination

sort_by
string

Key for sorting or random.

Response

200 - application/json

Successful Country search

Country search was successful.

data
object[]

Array of Country items matching the search criteria up to the limit of per_page paramater.

item_count
integer

Total number of Country items returned in the data field.

message
string

Status message for the search.

page
integer

Current page number of the search results returned.

per_page
integer

Number of Country items returned per page.

total_count
integer

Total of Country items that match the search filter.