countries-states-cities-service/README.md

Get the World's countries, states, regions and cities

<div align="center">
  
# Countries States Cities Service

[![NPM](https://nodei.co/npm/countries-states-cities-service.png?compact=true)](https://nodei.co/npm/countries-states-cities-service/)
<br />
[![](https://img.shields.io/npm/dt/countries-states-cities-service.svg?style=flat-square)](https://www.npmjs.com/package/countries-states-cities-service)

</div>

## Table of contents

1. [Mission](#mission)
2. [Getting started](#getting-started)
   - [Installation](#installation)
   - [Import](#import)
3. [Usage](#usage)
   - [Countries](#countries)
   - [States](#states)
   - [Cities](#cities)
4. [Contributors](#contributors)
5. [Need help](#need-help)
6. [Licence](#license)
7. [Sponsor](#sponsor)

## Mission

- I've never found any complete library to get all world countries, states, and cities. I want to develop the best one. Of course, contributors are welcome!!
- I took this [data](https://github.com/dr5hn/countries-states-cities-database) as a starting point.

## Getting started

To get started with this library, you need to install it and add it to your project.

### Installation

Countries States Cities Service is available as an npm package.

```bash
# npm
npm install countries-states-cities-service

# yarn
yarn add countries-states-cities-service
```

### Import

Import single named import as follow:

```typescript
import { Countries, States, Cities } from 'countries-states-cities-service'
```

## Usage

The code snippet below shows how to put into action `countries-states-cities-service` in some common use cases.

- [Countries](#countries)
- [States](#states)
- [Cities](#cities)

### Countries

- Get all countries.

```typescript
const countries = Countries.getCountries()
```

- Get all countries by `asc` sort.

```typescript
const countries = Countries.getCountries({
  sort: {
    mode: 'asc',
  },
})
```

- Get all countries by `desc` sort.

```typescript
const countries = Countries.getCountries({
  sort: {
    mode: 'desc',
  },
})
```

- Get all countries by alphabetical sort.

```typescript
const countries = Countries.getCountries({
  sort: {
    mode: 'alphabetical',
    key: 'iso2',
  },
})
```

- Get all countries with localization.

```typescript
const countries = Countries.getCountries({ locale: 'it' })
```

- Get a country by iso2 code.

```typescript
const countries = Countries.getCountries({ filters: { iso2: 'US' } })
```

- Get a country by iso2 code and localization.

```typescript
const countries = Countries.getCountries({
  filters: { iso2: 'IT' },
  locale: 'it',
})
```

- Get a country by iso3 code.

```typescript
const countries = Countries.getCountries({ filters: { iso3: 'ITA' } })
```

### States

- Get all states.

```typescript
const states = States.getStates()
```

- Get all states by `asc` sort.

```typescript
const states = States.getStates({
  sort: {
    mode: 'asc',
  },
})
```

- Get all states by `desc` sort.

```typescript
const states = States.getStates({
  sort: {
    mode: 'desc',
  },
})
```

- Get all states by `alphabetical` sort.

```typescript
const states = States.getStates({
  sort: {
    mode: 'alphabetical',
    key: 'name',
  },
})
```

- Get all states with localization.

```typescript
const states = States.getStates({ locale: 'it' })
```

- Get states by country code.

```typescript
const states = States.getStates({ filters: { country_code: 'IT' } })
```

- Get states by country code and localization _(available only for Italian states for now)_.

```typescript
const states = States.getStates({
  filters: { country_code: 'IT' },
  locale: 'it',
})
```

- Get regions by country code _(available only for Italian states for now)_.

```typescript
const states = States.getStates({
  filters: {
    country_code: 'IT',
    is_region: true,
  },
})
```

- Get a state by country code and state code.

```typescript
const states = States.getStates({
  filters: {
    country_code: 'IT',
    state_code: 'GE',
  },
})
```

### Cities

- Get all cities.

```typescript
const cities = Cities.getCities()
```

- Get all cities by `asc` sort.

```typescript
const cities = Cities.getCities({
  sort: {
    mode: 'asc',
  },
})
```

- Get all cities by `desc` sort.

```typescript
const cities = Cities.getCities({
  sort: {
    mode: 'desc',
  },
})
```

- Get all cities by `alphabetical` sort.

```typescript
const cities = Cities.getCities({
  sort: {
    mode: 'alphabetical',
    key: 'name',
  },
})
```

- Get Italian cities.

```typescript
const cities = Cities.getCities({
  filters: {
    country_code: 'IT',
  },
})
```

- Get Italian Ligurian cities.

```typescript
const cities = Cities.getCities({
  filters: {
    country_code: 'IT',
    state_code: '42', // Region iso2
  },
})
```

## Contributors

Any contribution is appreciated. You can get started with the steps below:

1. Fork [this repository](https://github.com/Randagio13/countries-states-cities-service) (learn how to do this [here](https://help.github.com/articles/fork-a-repo)).

2. Clone the forked repository.

3. Make your changes and create a pull request ([learn how to do this](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request)).

4. I will attend to your pull request and provide some feedback.

## Need help?

Ping me [on Twitter](https://twitter.com/randagio19)

## License

This repository is licensed under the [MIT](LICENSE) License.

## Sponsor

Don't be shy! 😜

[:heart: Sponsor](https://github.com/sponsors/Randagio13)