brasilapi-js
TypeScript icon, indicating that this package has built-in type declarations

1.0.0 • Public • Published

Logo da BrasilAPI

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.

Instalação

$ npm install brasilapi-js

Documentação

Documentação oficial da API com todas as chamadas poderão se encontradas neste link.

Utilização

Node.js ou Bun

import api from "brasilapi-js";

Deno

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.

const response = await api.bank.getAll();

Buscando um banco específico pelo seu código.

const response = await api.bank.getBy(1);

CEP V1

Buscando um CEP específico.

const response = await api.cepV1.getBy('01001000');

CEP V2

Buscando um CEP específico.

const response = await api.cep.getBy('01001000');

CNPJ

Buscando um CNPJ específico.

const response = await api.cnpj.getBy('00000000000191');

Corretoras

Buscando uma corretora específica pelo CNPJ.

const response = await api.cvm.getBy('76621457000185');

Buscando todas as corretoras listadas pela CVM.

const response = await api.cvm.getAll();

CPTEC

Buscando uma cidade pelo nome.

const response = await api.cptec.city.getBy('São Paulo');

Buscando todas as cidades disponíveis.

const response = await api.cptec.city.getAll();

Buscando as informações meteorológicas em todas as capitais dos estados brasileiros.

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.

const response = await api.cptec.weather.airport.getBy('SBGR');

Buscando as informações meteorológicas de uma cidade específica pelo seu código.

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.

const response = await api.cptec.weather.forecast.getBy(999, 6);

Buscando a previsão oceânica em uma cidade específica.

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.

const response = await api.cptec.weather.ocean.getBy(999, 6);

DDD

Buscando o estado e cidades que possuem determinado DDD.

const response = await api.ddd.getBy.getBy(77);

Feriados

Buscando todos os feriados nacionais em determinado ano.

const response = await api.holidays.getBy(2022);

FIPE

Buscando todas as marcas de veículos referente a um tipo de veículo.

const response = await api.fipe.brands.getBy('caminhoes');

Buscando o preço de um veículo específico pelo seu código FIPE.

const response = await api.fipe.price.getBy('001004-9');

Buscando as tabelas de referência existentes.

const response = await api.fipe.tables.getAll();

IBGE

Buscando todos os municípios de um estado específico pela sua sigla.

const response = await api.ibge.state.getBy('BA');

Buscando informações de todos os estados brasileiros.

const response = await api.ibge.state.getAll();

Buscando informações de um estado específico pela sua sigla.

const response = await api.ibge.country.getBy('BA');

ISBN

Buscando informações sobre um livro específico pelo seu código ISBN.

const response = await api.isbn.getBy('9788545702870');

NCM

Buscando informações sobre todos os NCMs.

const response = await api.ncm.getAll();

Buscando informações sobre um NCM específico.

const response = await api.ncm.getBy('01012100');

Buscando informações de um NCM a partir de um código ou descrição.

const response = await api.ncm.search('01012100');

Pix

Buscando informações de todos os participantes do PIX no dia atual ou anterior.

const response = await api.pix.getAll();

Registro BR

Buscando informações de um domínio específico.

const response = await api.registerBr.getBy('google.com');

Taxas

Buscando as taxas de juros e alguns índices oficiais do Brasil.

const response = await api.taxes.getAll();

Buscando informações de uma taxa a partir do seu nome/sigla.

const response = await api.taxes.getBy('Selic');

Readme

Keywords

none

Package Sidebar

Install

npm i brasilapi-js

Weekly Downloads

8

Version

1.0.0

License

MIT

Unpacked Size

37.3 kB

Total Files

102

Last publish

Collaborators

  • agostini_willian