xcountry-state-city

Installation

npm i xcountry-state-city

Example

let {getAllCountries} = require('xcountry-state-city');
let {getAllCountries} = require('xcountry-state-city');

getAllCountries();
getAllCountries();

Countries

getAllCountries( )

getAllCountries( )

getAllCountries();
getAllCountries();
// it will return array of countries object

Response :

[
    {
        "id":101,
        "name":"India",
        "iso2":"IN",
        "iso3":"IND",
        "phone_code":"91",
        "capital":"New Delhi",
        "region":"Asia"
    },
    ...many more
]

getCountryDetailByCountryCode( )

getCountryDetailByCountryCode(CountryCode:String);
// it will return details of the country

Response :

{
        "id":101,
        "name":"India",
        "iso2":"IN",
        "iso3":"IND",
        "phone_code":"91",
        "capital":"New Delhi",
        "region":"Asia"
}

States

getStatesByCountry( )

getStatesByCountry( )

getStatesByCountry( countryCode:string );
getStatesByCountry( countryCode:string );
// it will return array of states

Response :

[
    {
        "id": 4023,
        "name": "Andaman and Nicobar Islands",
        "state_code": "AN"
    },
    ...many more
]

getStateDetailByStateAndCountry( )

getStateDetailByStateAndCountry(countryCode:string , stateCode:string)
// it will return details of state

Response :

[
    {
        "id":4039,
        "name":"Madhya Pradesh",
        "country_id":101,
        "country_code":"IN",
        "country_name":"India",
        "state_code":"MP"
    }
]

Cities

getCitiesByStateAndCountry( )

getCitiesByStateAndCountry( countryCode:string , stateCode:string );
// it will return array of cities

Response :

[
    {
        "id":132166,
        "name":"Indore",
        "state_code":"MP",
        "country_code":"IN"
    },
    ...many more
]