Git Product home page Git Product logo

indices-bcb's Introduction

Indices BCB

Este projeto auxilia na obtenção de índices financeiros junto ao Banco Central do Brasil e a aplicação dele sobre valores.

Como usar:

Instalação

Para instalar a biblioteca através do composer:

composer require allgood/indices-bcb

Uso das funções

Para usar a biblioteca instalada pelo composer:

require_once "vendor/autoload.php"

use \Allgood\IndicesBCB\IndiceBCB;

$i = new IndiceBCB();

// obtém o último valor da série:
$ultimoIndice = $i->getUltimoValor();

// obtém os últimos 12 valores da série:
$ultimosDoze = $i->getUltimosDozeValores();

// corrige valor para um período específico
$corrigido = $i->reajustaValor(100,"01/05/2020","01/04/2021");

// indice acumulado em um período
$indice = $i->getIndiceAcumulado("01/05/2020","01/04/2021");

// percentual acumulado em um período
$percentual = $i->getPercentualAcumulado("01/05/2020","01/04/2021");

// indice acumulado referente aos últimos 12 valores:
$indice = IndiceBCB::getIndiceAcumuladoDoPeriodo($i->getUltimosDozeValores());

Índices suportados

As funções aceitam qualquer índice fornecido pela API do Banco Central com a única restrição de que seja um índice de percentual mensal, bastando informar o código do índice no Sistema Gerenciador de Séries Temporais.

Alguns códigos estão predefinidos em constantes para facilitar:

Constante Codigo Índice
IndiceBCB::BCB_INPC 188 INPC do IBGE
IndiceBCB::BCB_IGPM 28655 IGP-M da FGV
IndiceBCB::BCB_IGPDI 190 IGP-DI da FGV
IndiceBCB::BCB_IPCBR 191 IPC Brasil da FGV
IndiceBCB::BCB_IPCSP 193 IPC-SP do IBGE
IndiceBCB::BCB_IPCA 433 IPCA do IBGE

Como Default é utilizado o IGP-M da Fundação Getúlio Vargas.

A melhor documentação é o Código Fonte

Verificar o arquivo fonte para mais detalhes sobre as funções.

Licença

Todo o código deste projeto está licensiado sob a GNU Lesser General Public License versão 3.

Pode ser utilizado inalterado em qualquer projeto fechado ou open source, alterações efetuadas precisam ser fornecidas em código aberto aos usuários do sistema.

Facilitou sua vida?

Se o código do projeto ajudou você em uma tarefa complexa, considere fazer uma doação ao autor pelo PIX abaixo.

image

Chave Pix: 80fd8916-1131-4844-917e-2732eaa2ba74

indices-bcb's People

Contributors

allgood avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.