City-State-Country

Get all Cities, States, Countries list all over the world.

Steps for Installation

  npm i city-state-country --save
  

Usage

  var worldMapData = require('city-state-country');

Supported Methods

Countries Methods

Get list of all Countries

 const countriesList = await worldMapData.getAllCountries();

Search Country

The search text field is case insensitive.

 const countriesList = await worldMapData.searchCountry('indi');

Search Country by CountryCode (ISO2)

Only ISO2 Country code value is supported.

 const countriesList = await worldMapData.searchCountryByCountryCode('IN');

State Methods

Get list of all States by a Country Name

The search text field is case insensitive.

 const statesList = await worldMapData.getAllStatesFromCountry('India');

Get list of all States by Country Id

Use Country Id from country data.

 const statesList = await worldMapData.getStatesByCountryId('101');

Search State details

This method will return all states from world which starts with 'maha'. The search text field is case insensitive.

 const statesList = await worldMapData.searchState('maha');
 

City Methods

Get list of all Cities by State Name

The search text field is case sensitive.

 const citiesList = await worldMapData.getAllCitiesFromState('Maharashtra');

Get list of all Cities by State Id

Use State Id from state data.

 const citiesList = await worldMapData.getAllCitiesByStateId('4008');

Search City details

This method will return all cities from world which starts with 'parbh'.

 const citiesList = await worldMapData.searchCity('parbh');

Submit Issues

Email me regarding any issue me at [email protected]

Note

Database used for this plugin is updated. This database is taken from : https://github.com/dr5hn/countries-states-cities-database.

License

This Countries States Cities Database is made available under the Open Database License. Any rights in individual contents of the database are licensed under the Database Contents License.