Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/fegoa89/rest-countries-node
A Node.js wrapper library around the API provided by https://restcountries.com
https://github.com/fegoa89/rest-countries-node
nodejs restcountries
Last synced: 10 days ago
JSON representation
A Node.js wrapper library around the API provided by https://restcountries.com
- Host: GitHub
- URL: https://github.com/fegoa89/rest-countries-node
- Owner: fegoa89
- License: mit
- Created: 2018-08-06T08:55:29.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2023-03-07T07:51:44.000Z (over 1 year ago)
- Last Synced: 2024-10-05T07:18:27.045Z (about 1 month ago)
- Topics: nodejs, restcountries
- Language: JavaScript
- Homepage:
- Size: 222 KB
- Stars: 3
- Watchers: 2
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://semaphoreci.com/fegoa89/rest-countries-node)
[](https://badge.fury.io/js/rest-countries-node)
# Rest Country Node
A Node.js wrapper library around the API provided by https://restcountries.com. Using API version 3.1.
## Available methods
[`getAll()`](#getAll)
[`findByName()`](#findByName)
[`findByFullName()`](#findByFullName)
[`findByIsoCountryCode()`](#findByIsoCountryCode)
[`findByIsoCountryCodes()`](#findByIsoCountryCodes)
[`findByCurrency()`](#findByCurrency)
[`findByLanguageCode()`](#findByLanguageCode)
[`findByCapitalCity()`](#findByCapitalCity)
[`findByCallingCode()`](#findByCallingCode)
[`findByRegion()`](#findByRegion)
[`getAllGroupedByRegion()`](#getAllGroupedByRegion)
[`getAllGroupedBySubRegion()`](#getAllGroupedBySubRegion)
[`findCountryFlagByCountryName()`](#findCountryFlagByCountryName)
[`findCountryByForeignName()`](#findCountryByForeignName)
[`getNearestCountryToPosition()`](#getNearestCountryToPosition)
[`getAllGroupedByTimezone()`](#getAllGroupedByTimezone)
[`getCountriesByTimezone()`](#getCountriesByTimezone)
## Usage
```javascript
var RestCountries = require('rest-countries-node');
restCountries = new RestCountries;
```
### getAll
Returns all countries information:
```javascript
restCountries.getAll()
.then(response => {
/*...*/
});
```
### findByName
Search by country name. It can be the native name or partial name:
```javascript
restCountries.findByName('france')
.then(response => {
/*
[
{
"alpha2Code": "FR",
"alpha3Code": "FRA",
"altSpellings": [
"FR",
"French Republic",
"République française"
],
...
}
]
*/
});
```
### findByFullName
Search by country full name:
```javascript
restCountries.findByFullName('france')
.then(response => {
/*
[
{
"alpha2Code": "FR",
"alpha3Code": "FRA",
"altSpellings": [
"FR",
"French Republic",
"République française"
],
...
}
]
*/
});
```
### findByIsoCountryCode
Search by ISO 3166-1 2-letter or 3-letter country code:
```javascript
restCountries.findByIsoCountryCode('bg')
.then(response => {
/*
{
"alpha2Code": "BG",
"alpha3Code": "BGR",
"altSpellings": [
"BG",
"Republic of Bulgaria",
"Република България"
],
...
}
*/
});
```
### findByIsoCountryCodes
Search by list of ISO 3166-1 2-letter or 3-letter country codes:
```javascript
restCountries.findByIsoCountryCodes('pl;gb;it')
.then(response => {
/*
[
{
"alpha2Code": "PL",
"alpha3Code": "POL",
"altSpellings": [
"PL",
"Republic of Poland",
"Rzeczpospolita Polska"
],
...
},
{
"alpha2Code": "GB",
"alpha3Code": "GBR",
"altSpellings": [
"GB",
"UK",
"Great Britain"
],
...
},
{
"alpha2Code": "IT",
"alpha3Code": "ITA",
"altSpellings": [
"IT",
"Italian Republic",
"Repubblica italiana"
],
...
}
]
*/
});
```
### findByCurrency
Search by ISO 4217 currency code:
```javascript
restCountries.findByCurrency('pln')
.then(response => {
/*
[
{
"alpha2Code": "PL",
"alpha3Code": "POL",
"altSpellings": [
"PL",
"Republic of Poland",
"Rzeczpospolita Polska"
],
...
}
]
*/
});
```
### findByLanguageCode
Search by ISO 639-1 language code:
```javascript
restCountries.findByLanguageCode('italian')
.then(response => {
/*
[
{
"alpha2Code": "VA",
"alpha3Code": "VAT",
"altSpellings": [
"Sancta Sedes",
"Vatican",
"The Vatican"
],
...
},
{
"alpha2Code": "IT",
"alpha3Code": "ITA",
"altSpellings": [
"IT",
"Italian Republic",
"Repubblica italiana"
],
...
}
]
*/
});
```
### findByCapitalCity
Search by capital city:
```javascript
restCountries.findByCapitalCity('tallinn')
.then(response => {
/*
[
{
"alpha2Code": "EE",
"alpha3Code": "EST",
"altSpellings": [
"EE",
"Eesti",
"Republic of Estonia",
"Eesti Vabariik"
],
...
}
]
*/
});
```
### findByCallingCode
Search by calling code:
```javascript
restCountries.findByCallingCode('377')
.then(response => {
/*
[
{
"alpha2Code": "MC",
"alpha3Code": "MCO",
"altSpellings": [
"MC",
"Principality of Monaco",
"Principauté de Monaco"
],
...
}
]
*/
});
```
### findByRegion
Search by region (Africa, Americas, Asia, Europe, Oceania) :
```javascript
restCountries.findByRegion('oceania')
.then(response => {
/*
[
{
"alpha2Code": "AS",
"alpha3Code": "ASM",
"altSpellings": [
"AS",
"Amerika Sāmoa",
"Amelika Sāmoa",
"Sāmoa Amelika"
],
...
},
...
]
*/
});
```
### getAllGroupedBySubRegion
Returns a list of countries grouped by subregions:
```javascript
restCountries.getAllGroupedBySubRegion()
.then(response => {
/*
{ "southern-europe":
[
{
"alpha2Code": "ES",
"alpha3Code": "ESP",
"altSpellings": [
"ES",
"Kingdom of Spain",
"Reino de España"
],
...
},
...
],
"south-america":
[
{
"alpha2Code": "CO",
"alpha3Code": "COL",
"altSpellings": [
"CO",
"Republic of Colombia",
"República de Colombia"
],
...
},
...
],
...
}
*/
});
```
### getAllGroupedByRegion
Returns a list of countries grouped by regions:
```javascript
restCountries.getAllGroupedByRegion()
.then(response => {
/*
{
"europe": [
{
"alpha2Code": "ES",
"alpha3Code": "ESP",
"altSpellings": [
"ES",
"Kingdom of Spain",
"Reino de España"
],
...
},
{
"alpha2Code": "DE",
"alpha3Code": "DEU",
"altSpellings": [
"DE",
"Federal Republic of Germany",
"Bundesrepublik Deutschland"
],
}
],
"americas": [
{
"alpha2Code": "CO",
"alpha3Code": "COL",
"altSpellings": [
"CO",
"Republic of Colombia",
"República de Colombia"
],
...
}
]
}
*/
});
```
### findCountryFlagByCountryName
Returns the flag for a given country :
```javascript
restCountries.findCountryFlagByCountryName('Spain')
.then(response => {
/*
{
"countryName": "Spain",
"flag": "https://restcountries.com/data/esp.svg"
}
*/
});
```
### findCountryByForeignName
Returns the flag for a given country :
```javascript
restCountries.findCountryByForeignName('スペイン')
.then(response => {
/*
{
"alpha2Code": "ES",
"alpha3Code": "ESP",
"altSpellings": [
"ES",
"Kingdom of Spain",
"Reino de España"
],
...
}
*/
});
```
### getNearestCountryToPosition
Returns the nearest country to the input lat/lon:
```javascript
restCountries.getNearestCountryToPosition({lat: 50.0, lon: 9.0})
.then(response => {
/*
{
"alpha2Code": "DE",
"alpha3Code": "DEU",
"altSpellings": [
"DE",
"Federal Republic of Germany",
"Bundesrepublik Deutschland"
],
...
}
*/
});
```
### getAllGroupedByTimezone
Returns a list of countries grouped by timezone:
```javascript
restCountries.getAllGroupedByTimezone()
.then(response => {
/*
{
"UTC": [
{
"alpha2Code": "ES",
"alpha3Code": "ESP",
"altSpellings": [
"ES",
"Kingdom of Spain",
"Reino de España"
],
...
}
],
"UTC+01:00": [
{
"alpha2Code": "ES",
"alpha3Code": "ESP",
"altSpellings": [
"ES",
"Kingdom of Spain",
"Reino de España"
],
...
},
{
"alpha2Code": "DE",
"alpha3Code": "DEU",
"altSpellings": [
"DE",
"Federal Republic of Germany",
"Bundesrepublik Deutschland"
],
...
}
],
"UTC-05:00": [
{
"alpha2Code": "CO",
"alpha3Code": "COL",
"altSpellings": [
"CO",
"Republic of Colombia",
"República de Colombia"
],
...
}
]
}
*/
});
```
### getCountriesByTimezone
Returns a list of countries that belong to a timezone:
```javascript
restCountries.getCountriesByTimezone('UTC-05:00')
.then(response => {
/*
{
"UTC-05:00": [
{
"alpha2Code": "CO",
"alpha3Code": "COL",
"altSpellings": [
"CO",
"Republic of Colombia",
"República de Colombia"
],
...
}
]
}
*/
});
```