v1

latestOpenAPI 3.0.12026-07-265331168.0 KB

Subdivision

Search Subdivision

Search Subdivision entries using various filters. This endpoint allows users to query subdivisions based on specific attributes.

get/public/user/subdivision/search

Query parameters

subdivision_idstring

Unique identifier of the Subdivision

subdivision_namestring

Name of the Subdivision

country_idstring

Country identifier to which the Subdivision belongs

subdivision_aliasstring

Alias or alternative name for the Subdivision

subdivision_node_countinteger

Current number of online nodes in the Subdivision

per_pageinteger

Number of items per page for pagination

pageinteger

Page number for pagination

sort_bystring

Key for sorting or random.

Response

Successful Subdivision search

item_countinteger

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

total_countinteger

Total of Subdivision items that match the search filter.

Example response

{
  "data": [
    {
      "country_id": "fr",
      "subdivision_alias": "fr_idf",
      "subdivision_id": "fr-idf",
      "subdivision_name": "Île-de-France",
      "subdivision_node_count": 1345
    }
  ],
  "item_count": 1,
  "message": "Subdivision search successful.",
  "page": 1,
  "per_page": 10,
  "total_count": 1
}