Country Information API
5 atoms
Base tier
About
This Utility API lets you query and finds details about a specific country.
This API provides data such as Country, State, Country calling code, Short country name or code, Country flag (as Emoji), and Currency details in JSON format. This API can provide information for a wide range of applications, from geolocation-based services to research and education. This can be used to retrieve specific pieces of data for each country, making it easy to integrate the API into existing applications.
API Playground
API Documentation
country data
GET
https://api.apyhub.com/data/info/country
Request example
Method:
GET
Content Type:
application/json
Query Parameter(s)
Attribute | Type | Mandatory | Description |
---|---|---|---|
country | String | Yes | The name of the country for which you want to find the details (country name or country code) |
Response
Attribute | Type | Description |
---|---|---|
data.key | String | Country code |
data.value | String | Name of the country |
data.cca3 | String | Three digit country code |
data.emoji | String | Flag emoji for the country |
data.calling_code | Array of Integers | Array of country codes (most often it is just one) |
data.subdivision | Array | Array of subdivision elements (states or regions ) |
data.subdivision[a].code | String | Subdivision code |
data.subdivision[a].name | String | Name of the subdivision |
data.currency.key | String | Currency code |
data.currency.value | String | Name of the Currency |
data.currency.symbol | String | Currency Symbol |
data.currency.emoji | String | Currency emoji for that currency |
Sample Response
A successful request returns country informaiton in JSON format. If the request fails, the response contains an error code and a message to help determine what went wrong.
HTTP Response Codes
The method may return one of the following HTTP status codes:
Status Code | Description |
---|---|
200 | The request was successful. |
400 | Invalid input - the country is not provided. |
401 | Required authentication information is either missing or not valid for the resource. |
500 | If 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
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.