v1

latestOpenAPI 3.1.02026-07-226250251.5 KB

Catalogue

List Generic Country Codes

Retrieve a list of country specific codes following ISO 3166-1 alpha-3 standard

get/v1/countries

Query parameters

per_pageinteger

Number of items to return per page

current_pageinteger

The page number to retrieve

Response

List of countries retrieved successfully

Example response

{
  "data": {
    "pagination": {
      "current_page": 1,
      "per_page": 10,
      "total_page": 1,
      "total": 10
    },
    "countries": [
      {
        "code": "BLR",
        "name": "Belarus",
        "currency_code": "BYN",
        "phone_code": "+375",
        "flag_url": "https://flagcdn.com/by.svg",
        "postal_code": {
          "required": true,
          "regex": "\\A\\d{6}\\Z"
        }
      }
    ]
  }
}