Country-City-Search

A Project to get Data about the country cities and states according the request.

Installation

Install country city search with npm

1  npm i country-city-search

Features

• Get all countries names across the world in single array
• Get exact city using country,state,city name
• Get All cities in particular state using country name and state name
• Search city by it's name Get Country details by using country code Get All states from the country by using country code
• Cross platform usable for frontend and backend

Usage/Examples

1import { getAllCountries, getCitiesByStateAndCountry, getCityByNameAndCountryData, searchCityByName } from "country-city-search";
2
3const Home = () => {
4  const fetchData = async () => {
5    //Get All Countries Name with country code in single array
6
7    const allCountries = await getAllCountries();
8
9    // Output : ['Afghanistan (AF)', 'Albania (AL)',....]
10    //------------------------------------------------------
11
12    //Get City object using city name, state name and country name
13
14    const cityObject = await getCityByNameAndCountryData({
15      cityName: "rajkot",
16      state_name: "gujarat",
17      country_name: "India",
18    });
19
20    /*Output :
21     {
22        country_code: "IN";
23        country_id: "101";
24        country_name: "India";
25        id: "133679";
26        latitude: "22.33333000";
27        longitude: "70.83333000";
28        name: "Rajkot";
29        state_code: "GJ";
30        state_id: "4030";
31        state_name: "Gujarat";
32        time_zone_name: "Asia/Kolkata";
33        wikiDataId: "Q11854";
34      }
35*/
36    //------------------------------------------------------------
37
38    //Get List array of cities object using state and country name
39
40    const allCitiesFromState = await getCitiesByStateAndCountry("gujarat", "India");
41
42    /*
43    Output :
44    [{
45      "id": "57588",
46      "name": "Abrama",
47      "state_id": "4030",
48      "state_code": "GJ",
49      "state_name": "Gujarat",
50      "country_id": "101",
51      "country_code": "IN",
52      "country_name": "India",
53      "latitude": "20.85865000",
54      "longitude": "72.90648000",
55      "wikiDataId": "Q490916",
56      "time_zone_name": "Asia/Kolkata"
57    }....]
58    */
59    //------------------------------------------------------------
60
61    //Search City by it's Name
62
63    const city = await searchCityByName("ahmedabad");
64
65    /*
66    Output :
67        [
68         {
69           "id": "57606",
70           "name": "Ahmedabad",
71           "state_id": "4030",
72           "state_code": "GJ",
73           "state_name": "Gujarat",
74           "country_id": "101",
75           "country_code": "IN",
76           "country_name": "India",
77           "latitude": "23.02579000",
78           "longitude": "72.58727000",
79           "wikiDataId": "Q1070",
80           "time_zone_name": "Asia/Kolkata"
81          }, ...
82        ]
83
84    */
85
86    //------------------------------------------------------------
87
88    //Get country by its Country code
89    const country = await getCountryByCode("IN");
90    /*
91    Output =
92    [
93      {
94        name: "India",
95        iso3: "IND",
96        iso2: "IN",
97        numeric_code: "356",
98        phone_code: "91",
99        capital: "New Delhi",
100        currency: "INR",
101        currency_name: "Indian rupee",
102        currency_symbol: "₹",
103        tld: ".in",
104        native: "भारत",
105        region: "Asia",
106        region_id: "3",
107        subregion: "Southern Asia",
108        subregion_id: "14",
109        nationality: "Indian",
110        timezones: [...],
111        translations: {....},
112        latitude: "20.00000000",
113        longitude: "77.00000000",
114        emoji: "🇮🇳",
115        emojiU: "U+1F1EE U+1F1F3",
116      }
117    ];
118    */
119    //------------------------------------------------------------
120
121    //Get All States List from the country code
122    const state = await getStatesOfCountry("IN");
123
124    /*  Output :
125     [
126      {
127            "id": 4023,
128            "name": "Andaman and Nicobar Islands",
129            "state_code": "AN",
130            "latitude": "11.74008670",
131            "longitude": "92.65864010",
132            "type": "Union territory"
133      } ....]
134    */
135
136    //------------------------------------------------------------
137
138    //Get All States List from the country code
139    const cityies = await getAllCitiesOfState("BDS");
140
141    /* Output :
142     [
143      {
144        "id": "52",
145        "name": "Ashkāsham",
146        "state_id": "3901",
147        "state_code": "BDS",
148        "state_name": "Badakhshan",
149        "country_id": "1",
150        "country_code": "AF",
151        "country_name": "Afghanistan",
152        "latitude": "36.68333000",
153        "longitude": "71.53333000",
154        "wikiDataId": "Q4805192",
155        "time_zone_name": "Asia/Kabul",
156        "emoji": "🇦🇫",
157        "currency_symbol": "؋"
158        }....]
159
160     */
161  };
162
163  useEffect(() => {
164    fetchData();
165  });
166
167  return (
168    <>
169      <div> Simple Examples for country-city-search package</div>
170    </>
171  );
172};

Package Enhancement Suggestions

• Please identify any additional functionalities or data types that would enhance the package.
• Kindly suggest any further functionalities or data types to be integrated into the package.

Author

• @Dharmesh Pal

Support

For support, email dharmeshpal42@gmail.com

License

MIT