Brasil API JS

https://github.com/willianagostini/brasilapi-js
Admin
A flexible Javascript/Typescript SDK for the BrasilAPI, providing access to various Brazilian public...
Tokens:2,605
Snippets:39
Trust Score:8
Update:1 year ago
Show doc for...
Tokens:
Raw
### Install brasilapi-js via npm

Source: https://github.com/willianagostini/brasilapi-js/blob/master/README.md

Installs the brasilapi-js library using npm, a package manager for JavaScript. This command adds the package to your project's dependencies.

```shell
npm install brasilapi-js
```

--------------------------------

### Registro BR: Get Domain Information (JavaScript)

Source: https://github.com/willianagostini/brasilapi-js/blob/master/README.md

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

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

--------------------------------

### Pix: Get All Participants (JavaScript)

Source: https://github.com/willianagostini/brasilapi-js/blob/master/README.md

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

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

--------------------------------

### NCM: Get All NCM Codes (JavaScript)

Source: https://github.com/willianagostini/brasilapi-js/blob/master/README.md

Buscando informações sobre todos os NCMs.

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

--------------------------------

### ISBN: Get Book Information by Code (JavaScript)

Source: https://github.com/willianagostini/brasilapi-js/blob/master/README.md

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

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

--------------------------------

### Cambio: Get All Currencies (JavaScript)

Source: https://github.com/willianagostini/brasilapi-js/blob/master/README.md

Retorna a lista de moedas que podem ser usadas como parâmetros para este conjunto de dados.

```javascript
const response = await api.exchange.currency.getAll();
```

--------------------------------

### Cambio: Get Exchange Rate by Date (JavaScript)

Source: https://github.com/willianagostini/brasilapi-js/blob/master/README.md

Busca pelo câmbio do Real com outra moeda, em uma data específica.

```javascript
const response = await api.exchange.rates.getBy('USD', '2025-02-13');
```

--------------------------------

### NCM: Get Specific NCM by Code (JavaScript)

Source: https://github.com/willianagostini/brasilapi-js/blob/master/README.md

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

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

--------------------------------

### Taxas: Get Rate by Name or Acronym (JavaScript)

Source: https://github.com/willianagostini/brasilapi-js/blob/master/README.md

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

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

--------------------------------

### Retrieve all CPTEC cities

Source: https://github.com/willianagostini/brasilapi-js/blob/master/README.md

Fetches a list of all available cities from CPTEC data. This can be used to get a full list of cities for which weather data is available.

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

--------------------------------

### Taxas: Get All Official Rates (JavaScript)

Source: https://github.com/willianagostini/brasilapi-js/blob/master/README.md

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

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

--------------------------------

### NCM: Search NCM by Code or Description (JavaScript)

Source: https://github.com/willianagostini/brasilapi-js/blob/master/README.md

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

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

--------------------------------

### Request: Make Direct API Call (JavaScript)

Source: https://github.com/willianagostini/brasilapi-js/blob/master/README.md

Realizando uma chamada direta a qualquer URL da API BrasilAPI.

```javascript
const response = await api.request.get('taxas/v1');
```

--------------------------------

### Import brasilapi-js in Node.js or Bun

Source: https://github.com/willianagostini/brasilapi-js/blob/master/README.md

Imports the brasilapi-js library into a Node.js or Bun project using ES module syntax. This makes the API client available for use.

```javascript
import api from "brasilapi-js";
```

--------------------------------

### Retrieve all FIPE reference tables

Source: https://github.com/willianagostini/brasilapi-js/blob/master/README.md

Fetches a list of all available reference tables used by FIPE for vehicle pricing. These tables define the periods for which prices are valid.

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

--------------------------------

### Import brasilapi-js in Deno

Source: https://github.com/willianagostini/brasilapi-js/blob/master/README.md

Imports the brasilapi-js library into a Deno project, specifying the npm registry for the package. This allows Deno to resolve and use the npm package.

```javascript
import api from "npm:brasilapi-js";
```

--------------------------------

### Retrieve all CVM listed brokers

Source: https://github.com/willianagostini/brasilapi-js/blob/master/README.md

Fetches a list of all brokerage firms registered with CVM. This provides a comprehensive overview of regulated brokers.

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

--------------------------------

### Retrieve all available banks

Source: https://github.com/willianagostini/brasilapi-js/blob/master/README.md

Fetches a list of all banks available through the BrasilAPI. This endpoint provides comprehensive data on financial institutions.

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

--------------------------------

### Retrieve IBGE state information by abbreviation

Source: https://github.com/willianagostini/brasilapi-js/blob/master/README.md

Fetches detailed information for a specific Brazilian state using its abbreviation. This includes data like name, region, and capital.

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

--------------------------------

### Retrieve CPTEC weather for all capitals

Source: https://github.com/willianagostini/brasilapi-js/blob/master/README.md

Fetches meteorological information for all Brazilian state capitals from CPTEC. This provides current weather conditions for major cities.

```javascript
const response = await api.cptec.weather.capital.getAll();
```

--------------------------------

### Retrieve FIPE vehicle price by code

Source: https://github.com/willianagostini/brasilapi-js/blob/master/README.md

Fetches the price of a specific vehicle using its FIPE (Fundação Instituto de Pesquisas Econômicas) code. This provides market reference prices for vehicles.

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

--------------------------------

### Retrieve FIPE vehicles by type and brand

Source: https://github.com/willianagostini/brasilapi-js/blob/master/README.md

Fetches vehicles based on their type and a specific brand ID from FIPE. This allows for detailed searches within the FIPE database.

```javascript
const response = await api.fipe.vehicles.getBy('carros', 36);
```

--------------------------------

### Retrieve CPTEC weather forecast for city by code and days

Source: https://github.com/willianagostini/brasilapi-js/blob/master/README.md

Fetches meteorological forecast information for a specific city over a given number of days (1-6) using its code from CPTEC. The first parameter is the city code, and the second is the number of days.

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

--------------------------------

### Retrieve CPTEC ocean forecast for city by code and days

Source: https://github.com/willianagostini/brasilapi-js/blob/master/README.md

Fetches oceanic forecast information for a specific city over a given number of days (1-6) using its code from CPTEC. The first parameter is the city code, and the second is the number of days.

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

--------------------------------

### Retrieve CPTEC ocean forecast for city by code

Source: https://github.com/willianagostini/brasilapi-js/blob/master/README.md

Fetches oceanic forecast information for a specific city using its code from CPTEC. This provides predictions for sea conditions.

```javascript
const response = await api.cptec.weather.ocean.getBy(999);
```

--------------------------------

### Retrieve a specific bank by ID

Source: https://github.com/willianagostini/brasilapi-js/blob/master/README.md

Fetches details for a specific bank using its unique identifier. This allows for targeted retrieval of bank information.

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

--------------------------------

### Retrieve CPTEC city by name

Source: https://github.com/willianagostini/brasilapi-js/blob/master/README.md

Fetches information for a specific city from CPTEC (Centro de Previsão de Tempo e Estudos Climáticos) data using its name. This is useful for weather-related queries.

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

--------------------------------

### Retrieve CVM broker by CNPJ

Source: https://github.com/willianagostini/brasilapi-js/blob/master/README.md

Fetches details for a specific brokerage firm registered with CVM (Comissão de Valores Mobiliários) using its CNPJ. This provides regulatory information.

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

--------------------------------

### Retrieve all IBGE Brazilian states

Source: https://github.com/willianagostini/brasilapi-js/blob/master/README.md

Fetches information for all Brazilian states from IBGE (Instituto Brasileiro de Geografia e Estatística). This provides a complete list of states.

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

--------------------------------

### Retrieve IBGE municipalities by state abbreviation

Source: https://github.com/willianagostini/brasilapi-js/blob/master/README.md

Fetches a list of all municipalities (cities) within a specific Brazilian state using its abbreviation (e.g., 'SP' for São Paulo). This provides geographical data.

```javascript
const response = await api.ibge.city.getBy('SP');
```

--------------------------------

### Retrieve CPTEC weather forecast for city by code

Source: https://github.com/willianagostini/brasilapi-js/blob/master/README.md

Fetches meteorological forecast information for a specific city using its code from CPTEC. This provides future weather predictions.

```javascript
const response = await api.cptec.weather.forecast.getBy(999);
```

--------------------------------

### Retrieve national holidays by year

Source: https://github.com/willianagostini/brasilapi-js/blob/master/README.md

Fetches a list of all national holidays for a specified year. This provides a calendar of official non-working days in Brazil.

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

--------------------------------

### Retrieve CEP V1 address by number

Source: https://github.com/willianagostini/brasilapi-js/blob/master/README.md

Fetches address information for a specific Brazilian postal code (CEP) using the V1 endpoint. This provides details like street, neighborhood, city, and state.

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

--------------------------------

### Retrieve state and cities by DDD

Source: https://github.com/willianagostini/brasilapi-js/blob/master/README.md

Fetches the state and cities associated with a specific Brazilian area code (DDD). This helps in identifying geographical regions based on phone prefixes.

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

--------------------------------

### Retrieve CNPJ details by number

Source: https://github.com/willianagostini/brasilapi-js/blob/master/README.md

Fetches details for a specific Brazilian company registration number (CNPJ). This includes information about the company's legal status and address.

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

--------------------------------

### Retrieve CPTEC weather for airport by ICAO code

Source: https://github.com/willianagostini/brasilapi-js/blob/master/README.md

Fetches meteorological information for a specific airport using its ICAO code from CPTEC. This is crucial for aviation-related weather data.

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

--------------------------------

### Retrieve CEP V2 address by number

Source: https://github.com/willianagostini/brasilapi-js/blob/master/README.md

Fetches address information for a specific Brazilian postal code (CEP) using the V2 endpoint. This is the updated version for CEP queries.

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

--------------------------------

### Retrieve FIPE vehicle brands by type

Source: https://github.com/willianagostini/brasilapi-js/blob/master/README.md

Fetches all vehicle brands available for a specific vehicle type (e.g., 'caminhoes' for trucks) from FIPE. This is useful for filtering vehicle data.

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

--------------------------------

### Retrieve IBGE country information by state abbreviation (deprecated)

Source: https://github.com/willianagostini/brasilapi-js/blob/master/README.md

Fetches information for a specific Brazilian state using its abbreviation. This method is deprecated; it is recommended to use `api.ibge.city.getBy("UF")` for municipalities instead.

```javascript
const response = await api.ibge.country.getBy('BA');
```
Tokens:
Raw