Abrangência

Este endpoint retorna a abrangência disponível na ferramenta, permitindo identificar quais tribunais, plataformas e instâncias possuem suporte para consulta de dados públicos.

Também informa quais parâmetros devem ser enviados para cada tipo de consulta, garantindo a correta utilização da ferramenta.

Requisição

GET https://api.consulta.codilo.com.br/v1/available

Status de Retorno

Status	Significado	Descrição
200	OK	Requisição realizada com sucesso
401	Unauthorized	Token inválido, expirado ou não informado
429	Too Many Requests	Limite de requisições excedido

Exemplos de Requisição

cURL

curl -X GET "https://api.consulta.codilo.com.br/v1/available" \
  -H "accept: */*" \
  -H "Authorization: Bearer SEU_ACCESS_TOKEN"

Python

import requests

headers = {
    "accept": "*/*",
    "Authorization": "Bearer SEU_ACCESS_TOKEN",
}

response = requests.get(
    "https://api.consulta.codilo.com.br/v1/available",
    headers=headers
)

print(response.json())

PHP

<?php

$ch = curl_init();

curl_setopt($ch, CURLOPT_URL, "https://api.consulta.codilo.com.br/v1/available");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "GET");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "accept: */*",
    "Authorization: Bearer SEU_ACCESS_TOKEN",
]);

$response = curl_exec($ch);

curl_close($ch);

echo $response;

Node.js

const request = require("request");

const options = {
  url: "https://api.consulta.codilo.com.br/v1/available",
  headers: {
    accept: "*/*",
    Authorization: "Bearer SEU_ACCESS_TOKEN",
  },
};

request(options, function (error, response, body) {
  if (!error && response.statusCode === 200) {
    console.log(JSON.parse(body));
  }
});

Estrutura da Resposta

A resposta contém a estrutura completa de plataformas disponíveis, tribunais suportados, tipos de consulta e parâmetros exigidos.

Campos Principais

Campo	Descrição
platform	Plataforma/Sistema utilizado pelo tribunal
search	Identificador do tribunal ou órgão consultado
query	Instância ou tipo de consulta disponível
tag	Tipo de parâmetro exigido para consulta

Plataformas (Platform)

Plataforma	Descrição
creta	Plataforma Creta
custom	Plataforma desenvolvida pelo próprio tribunal
eproc	Plataforma Eproc
esaj	Plataforma ESAJ
jurisconsult	Plataforma Jurisconsult
pje	Plataforma PJe
pje-jf	Plataforma PJe
pje-jt-merged	Plataforma PJe
projudi	Plataforma Projudi
siep	Plataforma Siep
superiores	Tribunais Superiores
tucujuris	Tribunais Tucujuris

Instâncias (Query)

Query	Descrição
eletronico	Eletrônico
jespecial	Juizados Especiais
precatorio	Precatórios
principal	1º Grau
recursal	2º Grau
requisitorios	Requisitórios
tru	TRU
turmarecursal	Turma Recursal
unificada	Plataforma não permite informar instância. A instância identificada será retornada na resposta

Tipos de consulta (Param)

Nome	Tipo	Obrigatório	Descrição
key	string	true	Tipo da consulta.
value	string	true	Valor para o tipo de consulta.

Key	Descrição
cnj	Numeração Única: NNNNNNN-DD.AAAA.J.TR.OOOO
doc	Documento da parte (CPF ou CNPJ) Ex: 354.958.000-28, 66.115.152/0001-48
legado	Número antigo Ex: 675312C, 000.10.244520-0
nome	Nome da parte Ex: Banco Inter, José da Silva
nomeadv	Nome do advogado Ex: José da Silva
nomeadvogado	Nome do advogado Ex: José da Silva
nomeparte	Nome da parte Ex: José da Silva
numstj	Número no STJ Ex: REsp 7842
oab	Número da OAB: NÚMERO-DÍGITO-UF Ex: 1234-X-SP, 1234--SP, 1234--

Exemplo de Sucesso

{
  "success": true,
  "data": [
    {
      "source": "courts",
      "description": "Consulta de Tribunais",
      "platforms": [
        {
          "platform": "custom",
          "description": "Plataforma Personalizada",
          "searches": [
            {
              "search": "jef-trf3",
              "description": "Juizado Especial Federal da 3ª Região",
              "queries": [
                {
                  "query": "unificada",
                  "description": "Consulta Unificada",
                  "params": [
                    {
                      "label": "Numeração Única",
                      "tag": "cnj",
                      "mask": "#######-##.####.#.##.####",
                      "required": true,
                      "nested": []
                    }
                  ]
                }
              ]
            }
          ]
        }
      ]
    }
  ]
}