Uma lib para a API do BrasilAPI (para Node, Deno ou Bun) utilizando Javascript/Typescript
# Introdução
Esse SDK foi construído com o intuito de ser flexível, de forma que todos possam utilizar todas as features
e versões da BrasilAPI.
Você pode acessar a documentação oficial da BrasilAPI acessando esse [link](https://brasilapi.com.br/docs).
# Instalação
```shell
$ npm install brasilapi-js
```
# Documentação
Documentação oficial da API com todas as chamadas poderão se encontradas [neste link](https://brasilapi.com.br/docs).
# Utilização
## Node.js ou Bun
```js
import api from "brasilapi-js";
```
## Deno
```js
import api from "npm:brasilapi-js";
```
## Endpoints
Abaixo você pode ver todos os endpoints disponíveis, por padrão, na biblioteca:
### Banks
Buscando todos os bancos disponíveis na API.
```js
const response = await api.bank.getAll();
```
Buscando um banco específico pelo seu código.
```js
const response = await api.bank.getBy(1);
```
### CEP V1
Buscando um CEP específico.
```js
const response = await api.cepV1.getBy('01001000');
```
### CEP V2
Buscando um CEP específico.
```js
const response = await api.cep.getBy('01001000');
```
### CNPJ
Buscando um CNPJ específico.
```js
const response = await api.cnpj.getBy('00000000000191');
```
### Corretoras
Buscando uma corretora específica pelo CNPJ.
```js
const response = await api.cvm.getBy('76621457000185');
```
Buscando todas as corretoras listadas pela CVM.
```js
const response = await api.cvm.getAll();
```
### CPTEC
Buscando uma cidade pelo nome.
```js
const response = await api.cptec.city.getBy('São Paulo');
```
Buscando todas as cidades disponíveis.
```js
const response = await api.cptec.city.getAll();
```
Buscando as informações meteorológicas em todas as capitais dos estados brasileiros.
```js
const response = await api.cptec.weather.capital.getAll();
```
Buscando as informações meteorológicas em um aeroporto específico através do seu código ICAO.
```js
const response = await api.cptec.weather.airport.getBy('SBGR');
```
Buscando as informações meteorológicas de uma cidade específica pelo seu código.
```js
const response = await api.cptec.weather.forecast.getBy(999);
```
Buscando as informações meteorológicas de uma cidade específica no período de X dias.
**Obs.:** O primeiro parâmetro se refere ao código da cidade e o segundo parâmetro refere-se a quantidade de dias.
Lembrando que só é possível buscar informações entre 1 a 6 dias.
```js
const response = await api.cptec.weather.forecast.getBy(999, 6);
```
Buscando a previsão oceânica em uma cidade específica.
```js
const response = await api.cptec.weather.ocean.getBy(999);
```
Buscando a previsão oceânica em uma cidade específica no período de X dias.
**Obs.:** O primeiro parâmetro se refere ao código da cidade e o segundo parâmetro refere-se a quantidade de dias.
Lembrando que só é possível buscar informações entre 1 a 6 dias.
```js
const response = await api.cptec.weather.ocean.getBy(999, 6);
```
### DDD
Buscando o estado e cidades que possuem determinado DDD.
```js
const response = await api.ddd.getBy('77');
```
### Feriados
Buscando todos os feriados nacionais em determinado ano.
```js
const response = await api.holidays.getBy('2022');
```
### FIPE
Buscando todas as marcas de veículos referente a um tipo de veículo.
```js
const response = await api.fipe.brands.getBy('caminhoes');
```
Buscando o preço de um veículo específico pelo seu código FIPE.
```js
const response = await api.fipe.price.getBy('001004-9');
```
Buscando as tabelas de referência existentes.
```js
const response = await api.fipe.tables.getAll();
```
Buscando os veículos de acordo com a marca e o tipo de veículo.
```js
const response = await api.fipe.vehicles.getBy('carros', 36);
```
### IBGE
Buscando todos os municipios de um estado específico pela sua sigla.
```js
const response = await api.ibge.city.getBy('SP');
```
>ℹ️ A função city.getBy retorna a lista de municípios (cidades) do estado informado.
>A função country.getBy permanece para compatibilidade, mas não representa corretamente esses dados
>Buscando informações de um estado específico pela sua sigla.
```js
const response = await api.ibge.state.getBy('BA');
```
Buscando informações de todos os estados brasileiros.
```js
const response = await api.ibge.state.getAll();
```
Buscando informações de um estado específico pela sua sigla.
```js
const response = await api.ibge.country.getBy('BA');
```
> ⚠️ `api.ibge.country.getBy()` está obsoleto.
> Recomendamos usar `api.ibge.city.getBy("UF")` para obter municípios de um estado.
### ISBN
Buscando informações sobre um livro específico pelo seu código ISBN.
```js
const response = await api.isbn.getBy('9788545702870');
```
### NCM
Buscando informações sobre todos os NCMs.
```js
const response = await api.ncm.getAll();
```
Buscando informações sobre um NCM específico.
```js
const response = await api.ncm.getBy('01012100');
```
Buscando informações de um NCM a partir de um código ou descrição.
```js
const response = await api.ncm.search('01012100');
```
### Pix
Buscando informações de todos os participantes do PIX no dia atual ou anterior.
```js
const response = await api.pix.getAll();
```
### Registro BR
Buscando informações de um domínio específico.
```js
const response = await api.registerBr.getBy('google.com');
```
### Taxas
Buscando as taxas de juros e alguns índices oficiais do Brasil.
```js
const response = await api.taxes.getAll();
```
Buscando informações de uma taxa a partir do seu nome/sigla.
```js
const response = await api.taxes.getBy('Selic');
```
### Cambio
Retorna a lista de moedas que podem ser usadas como parâmetros para este conjunto de dados.
```js
const response = await api.exchange.currency.getAll();
```
Busca pelo câmbio do Real com outra moeda, em uma data específica.
```js
const response = await api.exchange.rates.getBy('USD', '2025-02-13');
```
### Request
Realizando uma chamada direta a qualquer URL da API BrasilAPI.
```js
const response = await api.request.get('taxas/v1');
```
