Rest Country Node

A Node.js wrapper library around the API provided by https://restcountries.com. Using API version 3.1.

Available methods

getAll()

findByName()

findByFullName()

findByIsoCountryCode()

findByIsoCountryCodes()

findByCurrency()

findByLanguageCode()

findByCapitalCity()

findByCallingCode()

findByRegion()

getAllGroupedByRegion()

getAllGroupedBySubRegion()

findCountryFlagByCountryName()

findCountryByForeignName()

getNearestCountryToPosition()

getAllGroupedByTimezone()

getCountriesByTimezone()

Usage

1var RestCountries = require('rest-countries-node');
2restCountries = new RestCountries;

getAll

Returns all countries information:

1restCountries.getAll()
2  .then(response => {
3    /*...*/
4  });

findByName

Search by country name. It can be the native name or partial name:

1restCountries.findByName('france')
2  .then(response => {
3    /*
4      [
5        {
6          "alpha2Code": "FR",
7          "alpha3Code": "FRA",
8          "altSpellings": [
9            "FR",
10            "French Republic",
11            "République française"
12          ],
13          ...
14        }
15      ]
16    */
17  });

findByFullName

Search by country full name:

1restCountries.findByFullName('france')
2  .then(response => {
3    /*
4      [
5        {
6          "alpha2Code": "FR",
7          "alpha3Code": "FRA",
8          "altSpellings": [
9            "FR",
10            "French Republic",
11            "République française"
12          ],
13          ...
14        }
15      ]
16    */
17  });

findByIsoCountryCode

Search by ISO 3166-1 2-letter or 3-letter country code:

1restCountries.findByIsoCountryCode('bg')
2  .then(response => {
3    /*
4      {
5        "alpha2Code": "BG",
6        "alpha3Code": "BGR",
7        "altSpellings": [
8          "BG",
9          "Republic of Bulgaria",
10          "Република България"
11        ],
12        ...
13      }
14    */
15  });

findByIsoCountryCodes

Search by list of ISO 3166-1 2-letter or 3-letter country codes:

1restCountries.findByIsoCountryCodes('pl;gb;it')
2  .then(response => {
3    /*
4      [
5        {
6          "alpha2Code": "PL",
7          "alpha3Code": "POL",
8          "altSpellings": [
9            "PL",
10            "Republic of Poland",
11            "Rzeczpospolita Polska"
12          ],
13          ...
14        },
15        {
16          "alpha2Code": "GB",
17          "alpha3Code": "GBR",
18          "altSpellings": [
19            "GB",
20            "UK",
21            "Great Britain"
22          ],
23          ...
24        },
25        {
26          "alpha2Code": "IT",
27          "alpha3Code": "ITA",
28          "altSpellings": [
29            "IT",
30            "Italian Republic",
31            "Repubblica italiana"
32          ],
33          ...
34        }
35      ]
36    */
37  });

findByCurrency

Search by ISO 4217 currency code:

1restCountries.findByCurrency('pln')
2  .then(response => {
3    /*
4      [
5        {
6          "alpha2Code": "PL",
7          "alpha3Code": "POL",
8          "altSpellings": [
9            "PL",
10            "Republic of Poland",
11            "Rzeczpospolita Polska"
12          ],
13          ...
14        }
15      ]
16    */
17  });

findByLanguageCode

Search by ISO 639-1 language code:

1restCountries.findByLanguageCode('italian')
2  .then(response => {
3    /*
4      [
5        {
6          "alpha2Code": "VA",
7          "alpha3Code": "VAT",
8          "altSpellings": [
9            "Sancta Sedes",
10            "Vatican",
11            "The Vatican"
12          ],
13          ...
14        },
15        {
16          "alpha2Code": "IT",
17          "alpha3Code": "ITA",
18          "altSpellings": [
19            "IT",
20            "Italian Republic",
21            "Repubblica italiana"
22          ],
23          ...
24        }
25      ]
26    */
27  });

findByCapitalCity

Search by capital city:

1restCountries.findByCapitalCity('tallinn')
2  .then(response => {
3    /*
4      [
5        {
6          "alpha2Code": "EE",
7          "alpha3Code": "EST",
8          "altSpellings": [
9            "EE",
10            "Eesti",
11            "Republic of Estonia",
12            "Eesti Vabariik"
13          ],
14          ...
15        }
16      ]
17    */
18  });

findByCallingCode

Search by calling code:

1restCountries.findByCallingCode('377')
2  .then(response => {
3    /*
4      [
5        {
6          "alpha2Code": "MC",
7          "alpha3Code": "MCO",
8          "altSpellings": [
9            "MC",
10            "Principality of Monaco",
11            "Principauté de Monaco"
12          ],
13          ...
14        }
15      ]
16    */
17  });

findByRegion

Search by region (Africa, Americas, Asia, Europe, Oceania) :

1restCountries.findByRegion('oceania')
2  .then(response => {
3    /*
4      [
5        {
6          "alpha2Code": "AS",
7          "alpha3Code": "ASM",
8          "altSpellings": [
9            "AS",
10            "Amerika Sāmoa",
11            "Amelika Sāmoa",
12            "Sāmoa Amelika"
13          ],
14          ...
15        },
16        ...
17      ]
18    */
19  });

getAllGroupedBySubRegion

Returns a list of countries grouped by subregions:

1restCountries.getAllGroupedBySubRegion()
2  .then(response => {
3    /*
4      { "southern-europe":
5        [
6          {
7            "alpha2Code": "ES",
8            "alpha3Code": "ESP",
9            "altSpellings": [
10              "ES",
11              "Kingdom of Spain",
12              "Reino de España"
13            ],
14            ...
15          },
16          ...
17        ],
18        "south-america":
19        [
20          {
21            "alpha2Code": "CO",
22            "alpha3Code": "COL",
23            "altSpellings": [
24              "CO",
25              "Republic of Colombia",
26              "República de Colombia"
27            ],
28            ...
29          },
30          ...
31        ],
32        ...
33      }
34    */
35  });

getAllGroupedByRegion

Returns a list of countries grouped by regions:

1restCountries.getAllGroupedByRegion()
2  .then(response => {
3    /*
4      {
5        "europe": [
6          {
7            "alpha2Code": "ES",
8            "alpha3Code": "ESP",
9            "altSpellings": [
10              "ES",
11              "Kingdom of Spain",
12              "Reino de España"
13            ],
14            ...
15          },
16          {
17            "alpha2Code": "DE",
18            "alpha3Code": "DEU",
19            "altSpellings": [
20              "DE",
21              "Federal Republic of Germany",
22              "Bundesrepublik Deutschland"
23            ],
24          }
25        ],
26        "americas": [
27          {
28            "alpha2Code": "CO",
29            "alpha3Code": "COL",
30            "altSpellings": [
31              "CO",
32              "Republic of Colombia",
33              "República de Colombia"
34            ],
35            ...
36          }
37        ]
38      }
39
40    */
41  });

findCountryFlagByCountryName

Returns the flag for a given country :

1restCountries.findCountryFlagByCountryName('Spain')
2  .then(response => {
3    /*
4      {
5        "countryName": "Spain",
6        "flag": "https://restcountries.com/data/esp.svg"
7      }
8    */
9  });

findCountryByForeignName

Returns the flag for a given country :

1restCountries.findCountryByForeignName('スペイン')
2  .then(response => {
3    /*
4      {
5        "alpha2Code": "ES",
6        "alpha3Code": "ESP",
7        "altSpellings": [
8          "ES",
9          "Kingdom of Spain",
10          "Reino de España"
11        ],
12        ...
13      }
14    */
15  });

getNearestCountryToPosition

Returns the nearest country to the input lat/lon:

1restCountries.getNearestCountryToPosition({lat: 50.0, lon: 9.0})
2  .then(response => {
3    /*
4      {
5        "alpha2Code": "DE",
6        "alpha3Code": "DEU",
7        "altSpellings": [
8          "DE",
9          "Federal Republic of Germany",
10          "Bundesrepublik Deutschland"
11        ],
12        ...
13      }
14    */
15  });

getAllGroupedByTimezone

Returns a list of countries grouped by timezone:

1restCountries.getAllGroupedByTimezone()
2  .then(response => {
3    /*
4      {
5        "UTC": [
6          {
7            "alpha2Code": "ES",
8            "alpha3Code": "ESP",
9            "altSpellings": [
10              "ES",
11              "Kingdom of Spain",
12              "Reino de España"
13            ],
14            ...
15          }
16        ],
17        "UTC+01:00": [
18          {
19            "alpha2Code": "ES",
20            "alpha3Code": "ESP",
21            "altSpellings": [
22              "ES",
23              "Kingdom of Spain",
24              "Reino de España"
25            ],
26            ...
27          },
28          {
29            "alpha2Code": "DE",
30            "alpha3Code": "DEU",
31            "altSpellings": [
32              "DE",
33              "Federal Republic of Germany",
34              "Bundesrepublik Deutschland"
35            ],
36            ...
37          }
38        ],
39        "UTC-05:00": [
40          {
41            "alpha2Code": "CO",
42            "alpha3Code": "COL",
43            "altSpellings": [
44              "CO",
45              "Republic of Colombia",
46              "República de Colombia"
47            ],
48            ...
49          }
50        ]
51      }
52    */
53  });

getCountriesByTimezone

Returns a list of countries that belong to a timezone:

1restCountries.getCountriesByTimezone('UTC-05:00')
2  .then(response => {
3    /*
4      {
5        "UTC-05:00": [
6          {
7            "alpha2Code": "CO",
8            "alpha3Code": "COL",
9            "altSpellings": [
10              "CO",
11              "Republic of Colombia",
12              "República de Colombia"
13            ],
14            ...
15          }
16        ]
17      }
18    */
19  });