# Selic
<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
[![All Contributors](https://img.shields.io/badge/all_contributors-2-orange.svg?style=flat-square)](#contributors-)
<!-- ALL-CONTRIBUTORS-BADGE:END --> 
[![Donate via Paypal](https://img.shields.io/badge/donate-paypal-blue)](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=L8MUNAKECUULY&source=url) [![Build Status](https://github.com/caio-ribeiro-pereira/selic/actions/workflows/ci.yml/badge.svg)](https://github.com/caio-ribeiro-pereira/selic/actions) [![License](https://img.shields.io/github/license/caio-ribeiro-pereira/selic)](https://raw.githubusercontent.com/caio-ribeiro-pereira/selic/main/LICENSE) [![NPM Dependencies](https://badgen.net/npm/dependents/selic)](https://www.npmjs.com/package/selic) [![GitHub stars](https://img.shields.io/github/stars/caio-ribeiro-pereira/selic)](https://github.com/caio-ribeiro-pereira/selic) [![GitHub forks](https://img.shields.io/github/forks/caio-ribeiro-pereira/selic)](https://github.com/caio-ribeiro-pereira/selic)


[![Node.js](https://img.shields.io/badge/Node.js-339933?style=for-the-badge&logo=nodedotjs&logoColor=white)](https://www.npmjs.com/package/selic) ![TypeScript](https://img.shields.io/badge/TypeScript-007ACC?style=for-the-badge&logo=typescript&logoColor=white) ![Jest](https://img.shields.io/badge/Jest-C21325?style=for-the-badge&logo=jest&logoColor=white)

A tiny lib to fetch brazilian's selic, ipca and cdi rates.

## About

This is a tiny lib compatible with **Node.js v18+** with zero dependencies, supports ESImport and CommonJS.

Basically this lib fetchs the current brazilian SELIC, IPCA and CDI rates, all values in apy (percentage per year).

The Selic rate and IPCA rate are fetched from [Banco Central do Brasil](https://bcb.gov.br)  
The CDI rate is fetched from [B3](https://b3.com.br)  

## How to install

### For Node.js via NPM
``` bash
npm install --save selic
```

### For Node.js via Yarn
``` bash
yarn add selic
```

## How to use

### ESImport

``` javascript
import * as selic from 'selic';
```

### CommonJS

``` javascript
const selic = require('selic');
```

### Fetch selic, ipca and cdi brazilian rates in list version

``` javascript
(async () => {
  const output = await selic.getRatesList();
  /*
   * [
   *  { name: 'Selic', apy: 7.75 },
   *  { name: 'CDI', apy: 7.65 },
   *  { name: 'IPCA', apy: 9.32 },
   * ]
   */
  console.log(output);
})()
```

### Fetch selic, ipca and cdi brazilian rates in object version

``` javascript
(async () => {
  const output = await selic.getRatesObject();
  console.log(output); // { selic: 7.75, cdi: 7.65, ipca: 9.32 }
})()
```

### Get only Selic rate

``` javascript
(async () => {
  const output = await selic.getSelicRate();
  console.log(output); // 7.75
})()
```

### Get only IPCA rate

``` javascript
(async () => {
  const output = await selic.getIpcaRate();
  console.log(output); // 9.32
})()
```

### Get only CDI rate

``` javascript
(async () => {
  const output = await selic.getCdiRate();
  console.log(output); // 7.65
})()
```

## Author

Caio Ribeiro Pereira <caio.ribeiro.pereira@gmail.com>  
Twitter: <https://twitter.com/crp_underground>  
About me: <https://crpwebdev.github.io>

## Contributors ✨

Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):

<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
<!-- prettier-ignore-start -->
<!-- markdownlint-disable -->
<table>
  <tr>
    <td align="center"><a href="https://github.com/maico910"><img src="https://avatars.githubusercontent.com/u/24510745?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Michael Wu</b></sub></a><br /><a href="https://github.com/caio-ribeiro-pereira/selic/commits?author=maico910" title="Code">💻</a></td>
    <td align="center"><a href="https://crpwebdev.github.io"><img src="https://avatars.githubusercontent.com/u/551228?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Caio Ribeiro Pereira</b></sub></a><br /><a href="https://github.com/caio-ribeiro-pereira/selic/commits?author=caio-ribeiro-pereira" title="Code">💻</a></td>
  </tr>
</table>

<!-- markdownlint-restore -->
<!-- prettier-ignore-end -->

<!-- ALL-CONTRIBUTORS-LIST:END -->

This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!