Skip to main content
GET
Search Subdivision

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

subdivision_id
string

Unique identifier of the Subdivision

subdivision_name
string

Name of the Subdivision

country_id
string

Country identifier to which the Subdivision belongs

subdivision_alias
string

Alias or alternative name for the Subdivision

subdivision_node_count
integer

Current number of online nodes in the Subdivision

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 Subdivision search

Subdivision search was successful.

data
object[]

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

item_count
integer

Total number of Subdivision 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 Subdivision items returned per page.

total_count
integer

Total of Subdivision items that match the search filter.