API de Índices de Correção Monetária

A API de Índices de Correção Monetária do Cálculo Jurídico permite o acesso programático a diversos índices econômicos e financeiros utilizados no Brasil. Ideal para escritórios de advocacia, departamentos jurídicos, sistemas de cálculos e aplicações financeiras que necessitam de dados precisos e atualizados.

Índices Disponíveis

Nossa API fornece acesso a diversos índices, incluindo:

  • Índices Inflacionários: IPCA, INPC, IGP-M, IGP-DI, etc
  • Índices Financeiros: Taxa SELIC, TR, TBF, CDI, etc
  • Índices Judiciais: Índices específicos dos tribunais brasileiros (TJSP, TJRJ, TJMG, TJPR, etc.) Já padronizados num formato fácil de usar
  • Índices Trabalhistas: Índices usados no Direito do Trabalho
  • Índices Previdenciários: Índices usados no Direito Previdenciários
  • Taxa Legal: Nova taxa legal, estabelecida pela Lei 14.905/2024
  • Moedas: Dólar, Euro, e outras moedas
  • Outros: Índices compostos e outros índices usados em cálculos judiciais

Autenticação

Todas as requisições exigem uma chave de API válida enviada no header X-CJ-API-KEY.

curl https://indices.calculojuridico.com.br/v1/list \
-H"X-CJ-API-KEY: SUA_CHAVE"

Endpoints Principais

1. Listar Índices Disponíveis

GET/POST /v1/list

Parâmetros:

  • show_last_available_competence (opcional): Define se exibe a última competência disponível (“true”/”false”)

Exemplo de Requisição:

curl https://indices.calculojuridico.com.br/v1/list \
-X POST \
-H"Content-Type: application/json"\
-H"X-CJ-API-KEY: SUA_CHAVE"\
-d'{"show_last_available_competence": "true"}'

Exemplo de Resposta:

[
{
"chave":"ipca",
"nome":"IPCA",
"descricao":"Índice Nacional de Preços ao Consumidor Amplo",
"last_available_competence":"05/2024"
},
{
"chave":"inpc",
"nome":"INPC",
"descricao":"Índice Nacional de Preços ao Consumidor",
"last_available_competence":"05/2024"
},
{
"chave":"igpm",
"nome":"IGP-M",
"descricao":"Índice Geral de Preços do Mercado",
"last_available_competence":"05/2024"
},
{
"chave":"tr",
"nome":"TR",
"descricao":"Taxa Referencial",
"last_available_competence":"06/2024"
}
]

2. Obter Valores de um Índice

GET/POST /v1/index

Parâmetros:

  • index_kind (obrigatório): Tipo de índice (ex: “ipca”, “inpc”, “igpm”, “tr”)
  • start_date (opcional): Data inicial (formato “DD/MM/AAAA”)
  • end_date (opcional): Data final (formato “DD/MM/AAAA”, padrão: data atual)
  • fill_incomplete_months (opcional): Preenche meses sem dados com variação zero (“true”/”false”, padrão: “true”)
  • sum_variations (opcional): Retorna a soma das variações percentuais (“true”/”false”, padrão: “true”)

Exemplo de Requisição:

curl https://indices.calculojuridico.com.br/v1/index \
-X POST \
-H"Content-Type: application/json"\
-H"X-CJ-API-KEY: SUA_CHAVE"\
-d'{
"index_kind": "ipca",
"start_date": "01/01/2023",
"end_date": "01/06/2024",
"fill_incomplete_months": "true"
}'

Exemplo de Resposta:

{
"name":"IPCA",
"sandbox_mode":false,
"key":"ipca",
"last_available_competence":"05/2024",
"fill_incomplete_months":true,
"warning":"Última competência disponível (05/2024) inferior à data final solicitada (06/2024). Competências incompletas preenchidas automaticamente (opção fill_incomplete_months)",
"indices":[
{
"year":2023,
"month":1,
"factor":"1.0053",
"variation_percentage":"0.53",
"cumulative_value":7384.3001
},
{
"year":2023,
"month":2,
"factor":"1.0076",
"variation_percentage":"0.76",
"cumulative_value":7440.3998
},
//...outrosmeses
{
"year":2024,
"month":5,
"factor":"1.0049",
"variation_percentage":"0.49",
"cumulative_value":7863.4592
},
{
"year":2024,
"month":6,
"factor":"1.0000",
"variation_percentage":"0.00",
"cumulative_value":7863.4592,
"filled_automatically":true,
"message":"Competência adicionada automaticamente com variação de 0%."
}
],
"variation_sum":8.32,
"resulting_factor":1.0832
}

3. Obter Valores Diários

GET/POST /v1/daily_values

Parâmetros:

  • index_kind (opcional): Tipo de índice (ex: “dolar”, “euro”, “selic”, “cdi”)
  • start_date (opcional): Data inicial (formato “DD/MM/AAAA”)
  • end_date (opcional): Data final (formato “DD/MM/AAAA”, padrão: data atual)

Exemplo de Requisição:

curl https://indices.calculojuridico.com.br/v1/daily_values \
-X POST \
-H"Content-Type: application/json"\
-H"X-CJ-API-KEY: SUA_CHAVE"\
-d'{
"index_kind": "dolar",
"start_date": "01/01/2024",
"end_date": "10/01/2024"
}'

Exemplo de Resposta:

{
"name":"Dólar Comercial",
"sandbox_mode":false,
"values":[
{
"date":"2024-01-01",
"value":4.8536
},
{
"date":"2024-01-02",
"value":4.9099
},
//...outrosdias
{
"date":"2024-01-10",
"value":4.9295
}
]
}

Campos Calculados para Índices

Ao consultar a API pelo endpoint /v1/index, a resposta inclui dois campos calculados importantes:

variation_sum

Representa a soma aritmética das variações percentuais de todos os períodos solicitados. Por exemplo, se você consultar o IPCA de Jan/2023 a Jun/2024 e as variações mensais forem 0.53%, 0.76%, 0.49%, etc., o variation_sum será a soma desses valores (por exemplo, 8.32%).

resulting_factor

Representa o fator acumulado para o período completo consultado. É o resultado da multiplicação dos fatores individuais mensais, arredondado para 12 casas decimais. Este valor pode ser usado diretamente como multiplicador para obter o valor corrigido de um montante.

Exemplo de uso:

Valor a ser corrigido: R$ 1.000,00
Período: Jan/2023 a Jun/2024
Resulting factor: 1.0832
Valor corrigido: R$ 1.000,00 × 1.0832 = R$ 1.083,20

Casos de Uso Comuns

Atualização de valores por índice inflacionário

curl https://indices.calculojuridico.com.br/v1/index \
-X POST \
-H"Content-Type: application/json"\
-H"X-CJ-API-KEY: SUA_CHAVE"\
-d'{
"index_kind": "ipca",
"start_date": "01/01/2022",
"end_date": "01/01/2024"
}'

Cálculo de juros com base na Taxa SELIC

curl https://indices.calculojuridico.com.br/v1/index \
-X POST \
-H"Content-Type: application/json"\
-H"X-CJ-API-KEY: SUA_CHAVE"\
-d'{
"index_kind": "selic",
"start_date": "01/01/2023",
"end_date": "01/01/2024"
}'

Histórico de cotação do dólar

curl https://indices.calculojuridico.com.br/v1/daily_values \
-X POST \
-H"Content-Type: application/json"\
-H"X-CJ-API-KEY: SUA_CHAVE"\
-d'{
"index_kind": "dolar",
"start_date": "01/01/2024",
"end_date": "01/06/2024"
}'

Modo Sandbox

As chaves de API podem ter o modo sandbox ativado, limitando os dados aos últimos 5 anos. Quando o modo sandbox está ativo:

  • O nome do índice terá o sufixo “[Sandbox: últimos 5 anos]”
  • A resposta conterá "sandbox_mode": true
  • Apenas dados dos últimos 5 anos serão retornados

O modo sandbox é ideal para testes e desenvolvimento sem consumir sua franquia completa de requisições.

Considerações Técnicas

Content-Type

Todas as requisições devem utilizar o content-type application/json.

URL Base

  • Desenvolvimento local: http://localhost:8080/correction_index_api
  • Produção: https://indices.calculojuridico.com.br

Limites de Requisições

Dependendo do seu plano, há limites diários ou mensais de requisições. Consulte seu painel administrativo para verificar seu limite atual.

Tratamento de Erros

Chave Inválida (HTTP 401)

{
"errors":"Chave inválida"
}

Chave Revogada (HTTP 403)

{
"errors":"Chave revogada"
}

Índice Inválido (HTTP 400)

{
"errors":"Índice inválido"
}

Parâmetro Inválido (HTTP 400)

{
"errors":"Parâmetro 'start_date' com formato inválido"
}

Endpoint Não Encontrado (HTTP 404)

{
"errors":"Not found"
}

Limite de Requisições Excedido (HTTP 429)

{
"errors":"Limite de requisições excedido",
"quota":{
"limit":1000,
"used":1000,
"reset_at":"2024-07-01T00:00:00Z"
}
}

Como Obter Acesso

Para obter uma chave de API e integrar o serviço de índices ao seu sistema:

  1. Entre em contato com nossa equipe através do e-mail contato@calculojuridico.com.br
  2. Solicite uma chave de testes para acesso sandbox à API
  3. Feche com o CJ e tenha todos os índices necessários para seu software

Suporte Técnico

Para dúvidas técnicas sobre a integração ou uso da API, entre em contato com nossa equipe de suporte técnico pelo e-mail suporte@calculojuridico.com.br.