Countries

Get countries

get

Query parameters

RegionstringOptional

The region of the country.

SubregionstringOptional

The subregion of the country.

CodeAlpha2stringOptional

The code alpha 2 of the country.

CodeAlpha3stringOptional

The code alpha 3 of the country.

CodeNumericinteger · int32Optional

The code numeric of the country.

CodePhonestringOptional

The code phone of the country.

NamestringOptional

The name of the country.

CapitalstringOptional

The capital of the country.

CurrencystringOptional

The currency of the country.

TldstringOptional

The tld of the country.

NativestringOptional

The native of the country.

TagsstringOptional

The tags of the country.

KeywordsstringOptional

Filter by keywords.

SortDataFieldstringOptional

The sort data field of the pagination.

SortOrderstringOptional

The sort order of the pagination.

PageNumberinteger · int32Optional

The page number of the pagination. Default value is 0.

PageSizeinteger · int32Optional

The page size of the pagination. Default value is 200.

Header parameters

BrandUrlstringRequired

The brand URL of the request. This is used to identify the brand.

Example: YOUR_BRAND_URL

Responses

200

The request was successful.

application/json

429

The user has exceeded the rate limit.

application/json

get

HTTPcURLJavaScriptPython

GET /api/countries HTTP/1.1
Host: protocol.jframework.dev
BrandUrl: text
Accept: */*

{
  "success": true,
  "statusCode": 200,
  "message": "The request was successful.",
  "data": {
    "items": [
      {
        "region": "Americas",
        "subregion": "Northern America",
        "codeAlpha2": "US",
        "codeAlpha3": "USA",
        "codeNumeric": 840,
        "codePhone": "+1",
        "name": "United States",
        "capital": "Washington, D.C.",
        "currency": "USD",
        "tld": ".us",
        "native": "United States",
        "tags": "USA",
        "iso3166": "US",
        "iso3": "USA",
        "numericCode": 840,
        "phoneCode": "+1",
        "id": "sApKpllz4sAplsmzha"
      }
    ],
    "totalItems": 1,
    "pageNumber": null,
    "pageSize": null
  },
  "errors": []
}