README

brasilapi

Vamos transformar o Brasil em uma API?

Essa biblioteca é um wrapper da REST API do BrasilAPI.

Instalação

Para instalar o pacote rode:

npm install brasilapi

yarn add brasilapi

Início rápido

import { BrasilAPI } from 'brasilapi'

const brasilapi = new BrasilAPI()

;(async () => {
  try {
    const data = await brasilapi.cep('01001-000')
    console.log(data)
  } catch (error) {
    console.log(error)
  }
})()

Métodos disponíveis

CEP

Busca por CEP com múltiplos providers de fallback.

Exemplo

brasilapi.cep('01001-000')

Bancos

Busca por dados dos bancos brasileiros direto na base de dados do Bacen.

Lista de bancos

brasilapi.banks()

Busca por um banco específico passando o código

brasilapi.banks('260')

Contribuindo

Issues e Pull requests são bem-vindos.

Licença

MIT

Usage no npm install needed!