OficialData · API v1 · Referência
Documentação da API
Consultas em fontes oficiais por integração. Cada fonte tem dois endpoints: um que diz o preço do alvo real sem executar e sem cobrar, e outro que executa e debita. O resultado sai por protocolo, não pela conexão aberta.
- Base URL
- api.oficialdata.com.br
- Autenticação
- Bearer, escopo por fonte
- Envelope
- Igual em erro e sucesso
- Formato
- JSON · OpenAPI 3.1
Guia de integração da cadeia do
registro de imóveis — a ordem de uso em prosa: do cadastro à primeira chamada
paga, com curl de cada passo, preço por estado e os erros de leitura que
custam dinheiro. Esta página é a referência; o guia é o caminho.
1. Autenticação
Authorization: Bearer <token>, e só.
Token na query string é recusado — a URL vive em log de proxy e no Referer.
Cada token carrega os escopos das fontes que pode chamar
(consultas:{fonte}). Emita em
Minha conta › APIs › Tokens.
Confira o token com GET /v1/token
antes de gastar: ele diz quem você é, o que pode e até quando — sem cobrar.
2. Ciclo de uma consulta
POST /v1/orcamento/{fonte}— preço e disponibilidade do alvo. Não cobra.POST /v1/consultas/{fonte}— executa e debita. Responde 202 com protocolo.GET /v1/consultas/{protocolo}— o resultado. Não cobra e não chama a origem de novo.GET /v1/consultas/{protocolo}/documento— o arquivo, quando a fonte emite um.
Basta enviar o token e os dados no passo 2. Cada POST inicia uma nova consulta, mesmo com dados iguais, com protocolo e cobrança próprios. Recebeu o protocolo? Acompanhe por GET.
3. O envelope
Toda resposta usa o mesmo envelope, inclusive as de erro.
header.billable diz se aquela chamada foi
faturada e header.price o que foi
debitado — não o de tabela.
data é sempre lista, mesmo com um item só.
header.request_id é o número a citar no chamado.
Máquina: openapi.json (OpenAPI 3.1, gerado do mesmo catálogo que gera esta página).
Endpoints disponíveis (6)
POST /v1/consultas/car-imovel
R$ 2,99
beta
POST /v1/consultas/car-demonstrativo
R$ 2,99
beta
POST /v1/consultas/certidao-inteiro-teor
R$ 54,20
beta
POST /v1/consultas/pesquisa-previa-bens
R$ 17,52
beta
POST /v1/consultas/processos-tjgo
R$ 0,30
beta
POST /v1/consultas/visualizacao-matricula
R$ 24,83
beta
Contrato publicado — porta fechada (15)
Contrato publicado, porta ainda fechada: chamar estes caminhos hoje responde
404. Use a doc para escrever o
cliente antes: o endpoint é construído contra ela.
POST /v1/consultas/certidao-tjmg-criminal
Preço a definir
POST /v1/consultas/certidao-tjmg-civel
Preço a definir
POST /v1/consultas/cndt
Preço a definir
POST /v1/consultas/cnd-estadual-mg
Preço a definir
POST /v1/consultas/cnd-municipal-direta
Preço a definir
POST /v1/consultas/cetesb-licenciamento
Preço a definir
POST /v1/consultas/participacao-societaria
Preço a definir
POST /v1/consultas/siam-processos-mg
Preço a definir
POST /v1/consultas/processos-tjac-primeiro-grau
Preço a definir
POST /v1/consultas/processos-tjal-primeiro-grau
Preço a definir
POST /v1/consultas/processos-tjam-primeiro-grau
Preço a definir
POST /v1/consultas/processos-tjce-primeiro-grau
Preço a definir
POST /v1/consultas/processos-tjsp-primeiro-grau
Preço a definir
POST /v1/consultas/processos-tjsp-segundo-grau
Preço a definir
POST /v1/consultas/areas-contaminadas-sp
Preço a definir
Preço de tabela, sem assinatura. Planos reduzem o valor por consulta, e fonte de repasse
(cartório) cobra o emolumento da UF do alvo — que varia. O número que vale é sempre o do
POST /v1/orcamento/{fonte},
calculado sobre o alvo real.
O orçamento explica o valor em preco.motivo e preco.justificativa,
indica o piso mínimo e informa a situação da cota sem reservar unidades.
Veja como interpretar preço e cota.