Documentação da API

Consulta processual multi-tribunal

Serviço de integração com tribunais. A API infere o tribunal pelo número CNJ enviado. Todas as rotas em /api/v1/ exigem autenticação por chave. Esta página é pública para leitura.

Base URL

Em produção, use o host configurado no Traefik (ex.: https://crawler.unithub.com.br). Os exemplos abaixo usam / como caminho relativo à origem atual.

Autenticação

Defina API_KEY no servidor. Em cada requisição à API, envie um dos seguintes:

Authorization: Bearer <API_KEY>
X-API-Key: <API_KEY>

Requisições OPTIONS (preflight CORS) não exigem chave. A documentação em HTML e o arquivo OpenAPI em /openapi.yaml são públicos.

Tribunais suportados

O tribunal é identificado automaticamente a partir do número CNJ — não é necessário informá-lo na requisição.

Código	Tribunal	Fonte
`tjmt`	Tribunal de Justiça de Mato Grosso	API do portal (Hellgate)
`trf1`	TRF da 1ª Região	Crawler PJe
`trf2`	TRF da 2ª Região	API Datajud / CNJ ¹
`trf3`	TRF da 3ª Região	API Datajud / CNJ ¹
`trf4`	TRF da 4ª Região	API Datajud / CNJ ¹
`trf5`	TRF da 5ª Região	API Datajud / CNJ ¹
`trf6`	TRF da 6ª Região	Crawler PJe

¹ TRF2–5 exigem DATAJUD_API_KEY no ambiente do servidor. Sem ela a consulta retorna 503 com error: datajud_api_key_ausente. Os dados podem ter defasagem em relação ao portal.

Endpoints

POST /api/v1/oab

Retorna todos os processos de um advogado que tiveram movimentação no período informado, consultando TRF1–6 em paralelo. Campo obrigatório: oab (formatos: MT16512/O, MT16512 ou 16512/MT). Opcionais: dataInicio e dataFim no formato DD/MM/YYYY — padrão é ontem → hoje.

curl -sS -X POST -H "Content-Type: application/json" \
  -H "X-API-Key: SUA_API_KEY" \
  -d '{"oab":"MT16512/O","dataInicio":"20/06/2026","dataFim":"21/06/2026"}' \
  "ORIGEM/api/v1/oab"

POST /api/v1/andamentos/cnj

Alias de /api/v1/andamentos — aceita os mesmos campos e retorna a mesma estrutura. Mantido para integrações existentes. Requer DATAJUD_API_KEY.

curl -sS -X POST -H "Content-Type: application/json" \
  -H "X-API-Key: SUA_API_KEY" \
  -d '{"numeroProcesso":"0003260-31.2007.4.02.5050"}' \
  "ORIGEM/api/v1/andamentos/cnj"

POST /api/v1/andamentos

Retorna andamentos de um ou mais processos via API pública Datajud (CNJ), com descrições normalizadas e numeroProcesso no formato de máscara CNJ. Cobre STF, STJ, STM, TST, TSE, TRF1–6, TRT1–24, todos os 27 TJs estaduais, TJDFT e tribunais militares estaduais. Requer DATAJUD_API_KEY.

Modo simples — numeroProcesso: retorna { encontrado, tribunal, andamentos[] }. Modo lote — numeroProcessos (array, máx. 50): consultas paralelas, retorna { total, encontrados, andamentos[] }.

curl -sS -X POST -H "Content-Type: application/json" \
  -H "X-API-Key: SUA_API_KEY" \
  -d '{"numeroProcesso":"0003260-31.2007.4.02.5050"}' \
  "ORIGEM/api/v1/andamentos"

curl -sS -X POST -H "Content-Type: application/json" \
  -H "X-API-Key: SUA_API_KEY" \
  -d '{"numeroProcessos":["0003260-31.2007.4.02.5050","0001234-56.2023.5.23.0001"]}' \
  "ORIGEM/api/v1/andamentos"

POST /api/v1/consulta

Consulta um processo pelo número CNJ. O tribunal é identificado automaticamente. Campo obrigatório: numeroUnico (aceita também numero, cnj ou numeroProcesso). Opcionais: exibirArquivados e incluirTextoDocumento (tenta extrair texto dos documentos anexados).

curl -sS -X POST -H "Content-Type: application/json" \
  -H "X-API-Key: SUA_API_KEY" \
  -d '{"numeroUnico":"1011293-58.2019.8.11.0015","exibirArquivados":true,"incluirTextoDocumento":false}' \
  "ORIGEM/api/v1/consulta"

GET /api/v1/tribunais

Lista os tribunais suportados com codigo, nome e implementado.

curl -sS -H "X-API-Key: SUA_API_KEY" "ORIGEM/api/v1/tribunais"

GET /openapi.yaml

Especificação OpenAPI 3 (pública). Importe no Postman, Insomnia ou gere cliente automaticamente.

GET /health

Health check — retorna ok. Público para balanceadores e probes.

Resposta

JSON com tribunal, tribunalNome, encontrado, movimentações quando aplicável, etc. Em caso de processo não encontrado, encontrado: false e numeroConsulta. Em cada movimentação existe documento com URL (quando disponível) e, se solicitado, texto / textoDisponivel / textoErro.

Referência

Especificação OpenAPI (/openapi.yaml)