Prefeitura SP - Consulta Valor Venal de Referência

O que é#

Na consulta de valor venal de referência você obtém o valor venal de referência de um imóvel da cidade de São Paulo, a partir do número de cadastro do imóvel (SQL), na data informada. O resultado inclui um comprovante da consulta em PDF.

Sobre a requisição#

Método: POST

Endereço: https://api.plexi.com.br/api/maestro/prefeitura-sp/valor-venal-referencia

URL Base: https://api.plexi.com.br/

Parâmetros do header#

Nome	Tipo	Obrigatório?	Descrição
Authorization	String	Sim	Chave de API gerada no cadastro no Plexi, prefixada com `Bearer`
Callback	String	Não	URL para onde o resultado da requisição será enviado via HTTP POST.

Parâmetros do body#

Nome	Tipo	Obrigatório?	Descrição
sql	string	Sim	Número do cadastro do imóvel (SQL), com 11 dígitos. Pode ser enviado com ou sem máscara (ex.: `999.999.9999-9`). O dígito verificador é validado.
data	string	Sim	Data de referência do valor venal, no formato `dd/mm/aaaa`. Deve estar entre 01/01/2005 e a data atual mais 7 dias (horário de Brasília).

Estrutura da resposta#

Status	Significado	Descrição	Informações retornadas
201	Created	Solicitação criada	Campo requestId, com o ID da requisição criada.
422	Unprocessable Entity	A solicitação contém erro	Em quais campos houve erro.

Exemplos de retornos quando você faz a requisição#

Status 201#

A consulta recebida com sucesso e será processada. Com o ID retornado você pode consultar se já houve resposta.

JSON

{
  "requestId": "1fdd4247-4f98-4113-887a-b182117b0e42"
}

Status 422#

Significa que ocorreu um erro de validação dos dados enviados.

JSON

{
  "message": "The given data was invalid.",
  "errors": {
    "cpf": [
      "O campo cpf é obrigatório."
    ],
    "nome": [
      "O campo nome é obrigatório."
    ]
  }
}

Exemplos de retornos do resultado da pesquisa#

Quando o valor venal de referência é encontrado, a resposta traz o SQL, a data, o valor e o endereço do imóvel, sem o campo status. Quando o site da Prefeitura responde com uma mensagem em vez do valor, a resposta traz status igual a erro e a mensagem exibida pelo site, sem alterações.

Nos dois casos, o campo pdf traz, em base64, um comprovante da consulta gerado pelo Plexi com as informações retornadas. Ele não é um documento emitido pela Prefeitura.

Valores possíveis do campo "status"#

Status	Significado
erro	O site retornou uma mensagem em vez do valor venal de referência, por exemplo quando o número de cadastro não existe na data informada ou não foi encontrado

Resposta com registro encontrado#

JSON

{
  "sql": "999.999.9999.9",
  "data": "01/01/2025",
  "valorVenalReferencia": 123456.78,
  "endereco": "RUA EXEMPLO, 123  01234-567",
  "pdf": "JVBERi0xLjQKMSAwIG9iago8..."
}

Resposta com erro#

JSON

{
  "status": "erro",
  "mensagem": "Número de cadastro inexistente em 01/01/2026. Favor informar o número de cadastro do imóvel existente a época da transação. Caso tenha dúvidas agende atendimento no seguinte link: http://agendamentosf.prefeitura.sp.gov.br/ Assunto: IPTU - Plantão Fiscal. Serviço: Pesquisa de SQL p/ fins de IPTU.",
  "pdf": "JVBERi0xLjQKMSAwIG9iago8..."
}

JSON

{
  "status": "erro",
  "mensagem": "NUMERO DO CADASTRO DO IMOVEL NAO ENCONTRADO",
  "pdf": "JVBERi0xLjQKMSAwIG9iago8..."
}