node-countries

Countries JSON data

Installation

Install via npm:

$ npm install node-countries

Documentation

This module currently has states and provinces for:

• United States (US)
• United Kingdom (GB)
• Canada (CA)
• Mexico (MX)
• Australia (AU)
• China (CN)
• Germany (DE)
• Belgium (BE)
• Netherlands (NL)
• Denmark (DK)
• Turkey (TR)
• Indonesia (ID)
• Jordan (JO)
• India (IN)
• Cambodia (KH)
• Ethiopia (ET)
• Peru (PE)
• Cuba (CU)
• Argentina (AR)
• Chile (CL)
• Bolivia (BO)
• Spain (ES)
• Bangladesh (BD)
• Pakistan (PK)
• Nigeria (NG)
• Japan (JP)
• Austria (AT)
• Brazil (BR)
• Philippines (PH)
• Vietnam (VN)
• Bulgaria (BG)

Data

getCountries()

1import { getCountries } from 'node-countries'

Return a JSON array with all the countries

1[
2  {
3    "alpha2": "AC",
4    "alpha3": "",
5    "countryCallingCodes": [
6      "+247"
7    ],
8    "currencies": [
9      "USD"
10    ],
11    "ioc": "SHP",
12    "languages": [
13      "eng"
14    ],
15    "name": "Ascension Island",
16    "status": "reserved",
17    "provinces": null,
18    "alias": null
19  },
20  {
21    "alpha2": "AD",
22    "alpha3": "AND",
23    "countryCallingCodes": [
24      "+376"
25    ],
26    "currencies": [
27      "EUR"
28    ],
29    "ioc": "AND",
30    "languages": [
31      "cat"
32    ],
33    "name": "Andorra",
34    "status": "assigned",
35    "provinces": null,
36    "alias": null
37  },
38  ...
39]

Short cut

All the countries are accessible directly through their ISO 639-1 (two letter code)

1import countries from 'node-countries';
2
3console.log(countries.AC);
4/*
5  {
6    "alpha2": "AC",
7    "alpha3": "",
8    "countryCallingCodes": [
9      "+247"
10    ],
11    "currencies": [
12      "USD"
13    ],
14    "ioc": "SHP",
15    "languages": [
16      "eng"
17    ],
18    "name": "Ascension Island",
19    "status": "reserved",
20    "provinces": null,
21    "alias": null
22  }
23*/

Methods

getCountryByName(name, [useAlias])

1import { getCountryByName } from 'node-countries'

Return the matched country object, else null (alias: findCountryByName)

getCountryByNameOrShortName(name or short name (alpha2, alpha3), [useAlias])

1import { getCountryByNameOrShortName } from 'node-countries'

Return the matched country object, else null (alias: findCountryByNameOrShortName)

getProvinceByName(country, provinceName, [useAlias])

Return the matched province object, else null (alias: findProvinceByName)

getProvinceByNameOrShortName(country, provinceName or short name, [useAlias])

Return the matched province object, else null (alias: findProvinceByNameOrShortName)

Examples

1import { getCountryByName } from 'node-countries'
2
3console.log(getCountryByName("Andorra"));
4/*
5  {
6    "alpha2": "AD",
7    "alpha3": "AND",
8    "countryCallingCodes": [
9      "+376"
10    ],
11    "currencies": [
12      "EUR"
13    ],
14    "ioc": "AND",
15    "languages": [
16      "cat"
17    ],
18    "name": "Andorra",
19    "status": "assigned",
20    "provinces": null,
21    "alias": null
22  }
23*/

1import countries from "node-countries";
2
3console.log(getProvinceByName(countries.CA, "Labrador", false));
4/*
5  null
6*/
7
8console.log(getProvinceByName(countries.CA, "Labrador", true));
9/*
10  {
11    "short": "NL",
12    "name": "Newfoundland and Labrador",
13    "alias": [
14      "Newfoundland",
15      "Labrador"
16    ]
17  }
18*/

Note

Inspired by country-data and provinces

Contributing

This project is a work in progress and subject to API changes, please feel free to contribute