apyhub-logo
5 atoms
Base tier

About

This Utility API provides the list of all officially listed countries.
With this API, resources that would be required for collecting, organizing, and managing country-related data like country calling codes and their ISO standard codes can be saved.
Apy Dictionaries provide standardized key-value pairs and some additional contextual information. For the country dictionary, the key attribute is the ISO standard code for the country and the value is the English value of the country.

API Playground

API Documentation

country dictionary
GET
https://api.apyhub.com/data/dictionary/country

Request example

1
```cURL
2
3
curl --location --request GET 'https://api.apyhub.com/data/dictionary/country' \
4
--header 'apy-token: {{token}}' \
5
--header 'Content-Type: application/json' \
Method: GET
Content Type: application/json
Response
AttributeTypeDescription
dataArrayArray of country key value pairs
data[a].keyStringCountry code
data[a].valueStringName of the country
data[a].cca3StringThree digit country code
data[a].emojiStringFlag emoji for the country
data[a].calling_codeArray of IntegersArray of country codes (most often it is just one)
data[a].currency.keyStringCurrency code
data[a].currency.valueStringName of the Currency
data[a].currency.symbolStringCurrency Symbol
data[a].currency.emojiStringCurrency emoji for that currency
Sample Response
1
{
2
"data": [
3
{
4
"calling_codes": [
5
61
6
],
7
"cca3": "AUS",
8
"currency": {
9
"emoji": "AUD",
10
"key": "AUD",
11
"symbol": "$",
12
"value": "Australian Dollar"
13
},
14
"emoji": "🇦🇺",
15
"key": "AU",
16
"value": "Australia"
17
},
18
{
19
"calling_codes": [
20
43
21
],
22
"cca3": "AUT",
23
"currency": {
24
"emoji": "💶",
25
"key": "EUR",
26
"symbol": "€",
27
"value": "Euro"
28
},
29
"emoji": "🇦🇹",
30
"key": "AT",
31
"value": "Austria"
32
},
33
....
34
35
]
36
}

HTTP Response Codes

The method may return one of the following HTTP status codes:
Status CodeDescription
200The request was successful.
401Required authentication information is either missing or not valid for the resource.
500If any unexpected error occurs while processing the request

Authentication

All API requests to ApyHub services need to be authenticated. Currently we support tokens or basic authentication mechanisms. You can generate and view your existing credentials from your workspace settings (on the left side of the navbar) and go to “API Keys".
Points to note:
  • Credential secrets are generated on the fly and are not stored in plain text, so on generating a credential please save the secrets somewhere safe.
  • Use the apy-token as the header parameter to pass the token.
  • Use the Authorization header to send the basic authentication credentials.

Error codes

1
{
2
"error": {
3
"code": 105,
4
"message": "Invalid URL"
5
}
6
}
To search for a specific error code, enter the code in the search box below. Alternatively, you can click on the button to view a complete list of all error codes.