https://github.com/rfoel/viacep

Procurando um webservice gratuito e de alto desempenho para consultar Códigos de Endereçamento Postal (CEP) do Brasil? Utilize o serviço, melhore a qualidade de suas aplicações web e colabore para manter esta base de dados atualizada.
https://github.com/rfoel/viacep

cep viacep

Last synced: about 2 months ago
JSON representation

Procurando um webservice gratuito e de alto desempenho para consultar Códigos de Endereçamento Postal (CEP) do Brasil? Utilize o serviço, melhore a qualidade de suas aplicações web e colabore para manter esta base de dados atualizada.

• Host: GitHub
• URL: https://github.com/rfoel/viacep
• Owner: rfoel
• License: mit
• Created: 2020-12-15T20:26:51.000Z (about 4 years ago)
• Default Branch: main
• Last Pushed: 2023-01-11T08:12:14.000Z (almost 2 years ago)
• Last Synced: 2024-09-18T17:49:38.630Z (4 months ago)
• Topics: cep, viacep
• Language: TypeScript
• Homepage: https://viacep.com.br/
• Size: 693 KB
• Stars: 4
• Watchers: 1
• Forks: 1
• Open Issues: 10
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

        
# viacep

[![npm](https://img.shields.io/npm/v/viacep)](https://www.npmjs.com/viacep)

[![npm bundle size](https://img.shields.io/bundlephobia/minzip/viacep)](https://www.npmjs.com/viacep)

[![NPM](https://img.shields.io/npm/l/viacep)](LICENSE)

[![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)

Procurando um webservice gratuito e de alto desempenho para consultar Códigos de Endereçamento Postal (CEP) do Brasil? Utilize o serviço, melhore a qualidade de suas aplicações web e colabore para manter esta base de dados atualizada. Mais informações no [site oficial](https://viacep.com.br/).

## Instalação

Para instalar o pacote rode:

```

npm install viacep

```

ou

```

yarn add viacep

```

## Início rápido

```js

import { ViaCEP } from 'viacep'

const viacep = new ViaCEP()

;(async () => {

  try {

    const data = await viacep.cep('01001-000')

    console.log(data)

  } catch (error) {

    console.log(error)

  }

})()

```

## Métodos disponíveis

### CEP

Busca por endereço pelo número do CEP.

```js

viacep.cep('01001-000')

// {

//   cep: '01310-000',

//   logradouro: 'Avenida Paulista',

//   complemento: 'até 610 - lado par',

//   bairro: 'Bela Vista',

//   localidade: 'São Paulo',

//   uf: 'SP',

//   ibge: '3550308',

//   gia: '1004',

//   ddd: '11',

//   siafi: '7107'

// }

```

Também existe um overload para encontrar endereços a partir de estado, cidade e rua. O retorno desse método é uma array de endereços.

```js

viacep.cep({ state: 'SP', city: 'São Paulo', street: 'Praça da Sé' })

// [

//   {

//     cep: '01001-000',

//     logradouro: 'Praça da Sé',

//     complemento: 'lado ímpar',

//     bairro: 'Sé',

//     localidade: 'São Paulo',

//     uf: 'SP',

//     ibge: '3550308',

//     gia: '1004',

//     ddd: '11',

//     siafi: '7107'

//   },

//   ...

// ]

```

## Contribuindo

Issues e Pull requests são bem-vindos.

## Licença

[MIT](https://github.com/rfoel/viacep/blob/main/LICENSE)