Country Method
This method is used to get a country information by passing the Country code.
Option | Type | Description |
|---|---|---|
countryCode * | String | |
params | Array | Specifies the modules you want to retrieve as visitor information.
It's an Array of consist some Strings as it's items.
Accepts: location, language, flag, currency and/or timezone.
Default: [] |
format | String | You can use this option to specify the API output format.
Accepts: JSON, XML, CSV or Newline.
Default: JSON |
lang | String | Specifies the API output language.
Accepts: EN, AR, DE, FR, ES, JA, JA, ZH or RU.
Default: EN |
mode | String | You can use this option for using the Development Environment of the API, read more.
Accepts: live or test.
Default: live |
Basic example of using this method:
await Country({
key: 'your-api-key',
countryCode: 'US'
})
.then(res => {
console.log(res);
})
.catch(error => {
console.log(error);
});
Description:
This method accepts one parameter of type
Object. The object contains the options you want to specify for this method. Let's dive into this:Let's say that we want to retrieve the country information and also the language and currency information. So the code will be like this:
await Country({
key: 'your-api-key',
countryCode: 'US',
params: ['language', 'currency']
})
.then(res => {
console.log(res);
})
.catch(error => {
console.log(error);
});
Beside this, we can inform the module to return the response as
XML:await Country({
key: 'your-api-key',
countryCode: 'US',
params: ['timezone', 'device'],
format: 'XML'
})
.then(res => {
console.log(res);
})
.catch(error => {
console.log(error);
});
And so on...
The
.then() will return the response if it's successfully fetched and the .catch() will return the error if something goes wrong.If the request completed successfully, so the
res variable of .then() returns the data in the format you specified. And we can read the data like this:await Country({
key: 'your-api-key',
countryCode: 'US',
params: ['timezone', 'device']
})
.then(res => {
console.log(res?.data?.population);
})
.catch(error => {
console.log(error);
});
Last modified 1mo ago