{"openapi":"3.1.0","info":{"title":"Método Geoportal · API de integração","version":"1.0.0","description":"Consulta do cadastro territorial multifinalitário (lotes, unidades, titulares, busca de pessoas, alterações e transferências) por sistemas da prefeitura, como o tributário (IPTU). Somente leitura. Documentação: /documentacao/api"},"servers":[{"url":"https://geometodo.tech/api/v1"}],"security":[{"chave":[]}],"paths":{"/{cidade}/lotes":{"get":{"summary":"Lista lotes","parameters":[{"name":"cidade","in":"path","required":true,"schema":{"type":"string","example":"araguainha"}},{"name":"pagina","in":"query","schema":{"type":"integer","minimum":1,"default":1}},{"name":"por_pagina","in":"query","schema":{"type":"integer","minimum":1,"maximum":500,"default":100}},{"name":"situacao","in":"query","schema":{"type":"string","enum":["ativo","extinto","todos"],"default":"ativo"}},{"name":"alterados_desde","in":"query","description":"Só registros alterados a partir desta data/hora (ISO 8601).","schema":{"type":"string","format":"date-time"}},{"name":"geometria","in":"query","description":"Inclui a geometria do lote (SIRGAS 2000, EPSG:4674).","schema":{"type":"string","enum":["nenhuma","geojson","wkt"],"default":"nenhuma"}},{"name":"matricula","in":"query","description":"Só o(s) lote(s) com esta matrícula do Registro de Imóveis (compara letras e dígitos: 45.678 = 45678).","schema":{"type":"string","example":"45.678"}},{"name":"cartorio_cns","in":"query","description":"CNS da serventia de Registro de Imóveis (6 dígitos); use com matricula quando o município tem mais de um cartório.","schema":{"type":"string","pattern":"^\\d{6}$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"dados":{"type":"array","items":{"$ref":"#/components/schemas/Lote"}},"paginacao":{"$ref":"#/components/schemas/Paginacao"}}}}}},"400":{"$ref":"#/components/responses/Erro"},"401":{"$ref":"#/components/responses/Erro"},"403":{"$ref":"#/components/responses/Erro"},"429":{"$ref":"#/components/responses/Erro"}}}},"/{cidade}/lotes/{inscricao}":{"get":{"summary":"Um lote pela inscrição","parameters":[{"name":"cidade","in":"path","required":true,"schema":{"type":"string","example":"araguainha"}},{"name":"inscricao","in":"path","required":true,"schema":{"type":"string","example":"01.002.0001"}},{"name":"geometria","in":"query","description":"Inclui a geometria do lote (SIRGAS 2000, EPSG:4674).","schema":{"type":"string","enum":["nenhuma","geojson","wkt"],"default":"nenhuma"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"dados":{"$ref":"#/components/schemas/Lote"}}}}}},"400":{"$ref":"#/components/responses/Erro"},"401":{"$ref":"#/components/responses/Erro"},"403":{"$ref":"#/components/responses/Erro"},"404":{"$ref":"#/components/responses/Erro"},"429":{"$ref":"#/components/responses/Erro"}}}},"/{cidade}/unidades":{"get":{"summary":"Lista unidades imobiliárias","parameters":[{"name":"cidade","in":"path","required":true,"schema":{"type":"string","example":"araguainha"}},{"name":"pagina","in":"query","schema":{"type":"integer","minimum":1,"default":1}},{"name":"por_pagina","in":"query","schema":{"type":"integer","minimum":1,"maximum":500,"default":100}},{"name":"situacao","in":"query","schema":{"type":"string","enum":["ativo","extinto","todos"],"default":"ativo"}},{"name":"alterados_desde","in":"query","description":"Só registros alterados a partir desta data/hora (ISO 8601).","schema":{"type":"string","format":"date-time"}},{"name":"incluir","in":"query","description":"titulares: exige o escopo titulares","schema":{"type":"string","enum":["titulares"]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"dados":{"type":"array","items":{"$ref":"#/components/schemas/Unidade"}},"paginacao":{"$ref":"#/components/schemas/Paginacao"}}}}}},"400":{"$ref":"#/components/responses/Erro"},"401":{"$ref":"#/components/responses/Erro"},"403":{"$ref":"#/components/responses/Erro"},"429":{"$ref":"#/components/responses/Erro"}}}},"/{cidade}/unidades/{inscricao}":{"get":{"summary":"Uma unidade pela inscrição","parameters":[{"name":"cidade","in":"path","required":true,"schema":{"type":"string","example":"araguainha"}},{"name":"inscricao","in":"path","required":true,"schema":{"type":"string","example":"01.002.0001.001"}},{"name":"incluir","in":"query","schema":{"type":"string","enum":["titulares"]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"dados":{"$ref":"#/components/schemas/Unidade"}}}}}},"400":{"$ref":"#/components/responses/Erro"},"401":{"$ref":"#/components/responses/Erro"},"403":{"$ref":"#/components/responses/Erro"},"404":{"$ref":"#/components/responses/Erro"},"429":{"$ref":"#/components/responses/Erro"}}}},"/{cidade}/pessoas":{"get":{"summary":"Busca titulares por CPF/CNPJ ou nome/razão social (escopo titulares)","description":"Informe cpf_cnpj (exato, com ou sem pontuação; aceita o CNPJ alfanumérico) ou nome (aproximado: sem acento, tolera erro de digitação, mínimo 4 letras). Cada consulta é registrada como acesso a dado pessoal.","parameters":[{"name":"cidade","in":"path","required":true,"schema":{"type":"string","example":"araguainha"}},{"name":"cpf_cnpj","in":"query","schema":{"type":"string","example":"529.982.247-25"}},{"name":"nome","in":"query","schema":{"type":"string","minLength":4,"example":"Maria Souza"}},{"name":"vinculos","in":"query","description":"atuais: só titularidades vigentes (e só quem tem alguma); todos: inclui as encerradas.","schema":{"type":"string","enum":["atuais","todos"],"default":"atuais"}},{"name":"limite","in":"query","description":"Só na busca por nome.","schema":{"type":"integer","minimum":1,"maximum":50,"default":20}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"dados":{"type":"array","items":{"$ref":"#/components/schemas/Pessoa"}}}}}}},"400":{"$ref":"#/components/responses/Erro"},"401":{"$ref":"#/components/responses/Erro"},"403":{"$ref":"#/components/responses/Erro"},"429":{"$ref":"#/components/responses/Erro"}}}},"/{cidade}/pessoas/{cpf_cnpj}":{"get":{"summary":"Uma pessoa pelo CPF/CNPJ, com os imóveis (escopo titulares)","parameters":[{"name":"cidade","in":"path","required":true,"schema":{"type":"string","example":"araguainha"}},{"name":"cpf_cnpj","in":"path","required":true,"schema":{"type":"string","example":"52998224725"}},{"name":"vinculos","in":"query","schema":{"type":"string","enum":["atuais","todos"],"default":"todos"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"dados":{"$ref":"#/components/schemas/Pessoa"}}}}}},"400":{"$ref":"#/components/responses/Erro"},"401":{"$ref":"#/components/responses/Erro"},"403":{"$ref":"#/components/responses/Erro"},"404":{"$ref":"#/components/responses/Erro"},"429":{"$ref":"#/components/responses/Erro"}}}},"/{cidade}/alteracoes":{"get":{"summary":"Feed de alterações (sincronização incremental)","parameters":[{"name":"cidade","in":"path","required":true,"schema":{"type":"string","example":"araguainha"}},{"name":"apos_id","in":"query","description":"Cursor: devolve alterações com id maior que este.","schema":{"type":"integer","default":0}},{"name":"desde","in":"query","schema":{"type":"string","format":"date-time"}},{"name":"limite","in":"query","schema":{"type":"integer","minimum":1,"maximum":1000,"default":500}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"dados":{"type":"array","items":{"$ref":"#/components/schemas/Alteracao"}},"cursor":{"type":"object","properties":{"proximo_apos_id":{"type":"integer"},"ultimo_id":{"type":"integer","description":"Id da alteração mais recente no momento da consulta"},"tem_mais":{"type":"boolean"},"proxima":{"type":"string"}}}}}}}},"400":{"$ref":"#/components/responses/Erro"},"401":{"$ref":"#/components/responses/Erro"},"403":{"$ref":"#/components/responses/Erro"},"429":{"$ref":"#/components/responses/Erro"}}}},"/{cidade}/transferencias":{"get":{"summary":"Transferências de titularidade (escopo titulares)","parameters":[{"name":"cidade","in":"path","required":true,"schema":{"type":"string","example":"araguainha"}},{"name":"apos_id","in":"query","schema":{"type":"integer","default":0}},{"name":"desde","in":"query","schema":{"type":"string","format":"date-time"}},{"name":"limite","in":"query","schema":{"type":"integer","minimum":1,"maximum":500,"default":100}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"dados":{"type":"array","items":{"$ref":"#/components/schemas/Transferencia"}},"cursor":{"type":"object","properties":{"proximo_apos_id":{"type":"integer"},"tem_mais":{"type":"boolean"}}}}}}}},"400":{"$ref":"#/components/responses/Erro"},"401":{"$ref":"#/components/responses/Erro"},"403":{"$ref":"#/components/responses/Erro"},"429":{"$ref":"#/components/responses/Erro"}}}}},"components":{"securitySchemes":{"chave":{"type":"http","scheme":"bearer","description":"Chave criada pelo administrador do município (aba API)."}},"responses":{"Erro":{"description":"Erro","content":{"application/json":{"schema":{"type":"object","properties":{"erro":{"type":"object","properties":{"codigo":{"type":"string"},"mensagem":{"type":"string"}}}}}}}}},"schemas":{"Paginacao":{"type":"object","properties":{"pagina":{"type":"integer"},"por_pagina":{"type":"integer"},"total":{"type":"integer"},"proxima":{"type":["string","null"]}}},"Lote":{"type":"object","properties":{"inscricao":{"type":"string"},"situacao":{"type":"string","enum":["ativo","extinto"]},"setor":{"type":["string","null"]},"quadra":{"type":["string","null"]},"numero":{"type":["string","null"]},"loteamento":{"type":["string","null"]},"bairro":{"type":["string","null"]},"endereco":{"type":["object","null"],"properties":{"logradouro":{"type":"string"},"numero":{"type":["string","null"]}}},"testadas":{"type":"array","items":{"type":"object","properties":{"logradouro":{"type":"string"},"extensao_m":{"type":["number","null"]},"principal":{"type":"boolean"}}}},"area_medida_m2":{"type":["number","null"]},"area_matricula_m2":{"type":["number","null"]},"matricula":{"type":["string","null"]},"cartorio_cns":{"type":["string","null"]},"cnm":{"type":["string","null"],"description":"Código Nacional de Matrícula (Provimento CNJ 143), calculado do CNS e da matrícula numérica: CCCCCC.2.NNNNNNN-DD"},"cib":{"type":["string","null"],"description":"CIB (SINTER) quando o lote tem uma única unidade ativa; o CIB é atribuído à unidade imobiliária"},"edificacoes":{"type":"object","properties":{"quantidade":{"type":"integer"},"area_construida_m2":{"type":["number","null"]},"pavimentos_max":{"type":["integer","null"]}}},"unidades":{"type":"integer"},"versao":{"type":"integer"},"atualizado_em":{"type":"string","format":"date-time"},"extinto_em":{"type":["string","null"],"format":"date"},"geometria":{"description":"GeoJSON ou WKT, quando pedido"},"srid":{"type":"integer","const":4674}}},"Titular":{"type":"object","properties":{"nome":{"type":"string"},"tipo":{"type":"string","enum":["fisica","juridica"]},"cpf_cnpj":{"type":["string","null"]},"vinculo":{"type":"string","enum":["proprietario","possuidor","compromissario","usufrutuario","enfiteuta"]},"percentual":{"type":["number","null"]},"responsavel_tributario":{"type":"boolean"},"inicio":{"type":["string","null"],"format":"date"}}},"Unidade":{"type":"object","properties":{"inscricao":{"type":"string"},"inscricao_lote":{"type":"string"},"situacao":{"type":"string","enum":["ativo","extinto"]},"cib":{"type":["string","null"],"description":"Código do Cadastro Imobiliário Brasileiro atribuído pelo SINTER (8 caracteres, sem hífen)"},"uso":{"type":["object","null"],"properties":{"codigo":{"type":"string"},"descricao":{"type":"string"}}},"endereco":{"type":["object","null"],"properties":{"logradouro":{"type":"string"},"numero":{"type":["string","null"]},"complemento":{"type":["string","null"]}}},"area_privativa_m2":{"type":["number","null"]},"fracao_ideal":{"type":["number","null"]},"edificacao":{"type":["object","null"],"properties":{"pavimentos":{"type":["integer","null"]},"ano_construcao":{"type":["integer","null"]},"area_construida_m2":{"type":["number","null"]}}},"titulares":{"type":"array","items":{"$ref":"#/components/schemas/Titular"},"description":"Só com incluir=titulares"},"versao":{"type":"integer"},"atualizado_em":{"type":"string","format":"date-time"}}},"Alteracao":{"type":"object","properties":{"id":{"type":"integer"},"quando":{"type":"string","format":"date-time"},"entidade":{"type":"string","enum":["lote","unidade","titularidade","edificacao","testada","transferencia","pessoa"]},"operacao":{"type":"string","enum":["inclusao","alteracao","exclusao"]},"inscricao":{"type":["string","null"],"description":"Lote ou unidade afetada"},"unidades":{"type":"array","items":{"type":"string"},"description":"Só para entidade pessoa"},"campos":{"type":"array","items":{"type":"string"}}}},"Pessoa":{"type":"object","properties":{"cpf_cnpj":{"type":["string","null"],"description":"Só dígitos/letras, sem pontuação"},"tipo":{"type":"string","enum":["fisica","juridica"]},"nome":{"type":"string","description":"Nome ou razão social"},"contato":{"type":"object","properties":{"email":{"type":["string","null"]},"telefone":{"type":["string","null"],"description":"Formato \"+DDI DDD número\", ex.: +55 19 981234567"},"telefone2":{"type":["string","null"],"description":"Segundo telefone, mesmo formato"},"endereco_correspondencia":{"type":["string","null"],"description":"Endereço em uma linha, montado a partir de `endereco`"},"endereco":{"type":["object","null"],"properties":{"logradouro":{"type":"string"},"numero":{"type":["string","null"]},"complemento":{"type":["string","null"]},"bairro":{"type":["string","null"]},"cidade":{"type":"string"},"uf":{"type":"string","description":"Sigla do estado"},"cep":{"type":["string","null"],"description":"8 dígitos, sem hífen"},"conferido_no_cadastro":{"type":"boolean","description":"Endereço do próprio município, com o logradouro encontrado no cadastro municipal"}}}}},"relevancia":{"type":"number","description":"Só na busca por nome: semelhança de 0 a 1"},"atualizado_em":{"type":"string","format":"date-time"},"imoveis":{"type":"array","items":{"type":"object","properties":{"inscricao_unidade":{"type":"string"},"inscricao_lote":{"type":"string"},"endereco":{"type":["object","null"],"properties":{"logradouro":{"type":"string"},"numero":{"type":["string","null"]},"complemento":{"type":["string","null"]}}},"vinculo":{"type":"string","enum":["proprietario","possuidor","compromissario","usufrutuario","enfiteuta"]},"percentual":{"type":["number","null"]},"responsavel_tributario":{"type":"boolean"},"inicio":{"type":["string","null"],"format":"date"},"fim":{"type":["string","null"],"format":"date"},"vigente":{"type":"boolean"}}}}}},"Transferencia":{"type":"object","properties":{"id":{"type":"integer"},"inscricao_lote":{"type":"string"},"unidades":{"type":"array","items":{"type":"string"}},"natureza":{"type":"string"},"matricula":{"type":"string"},"cartorio_cns":{"type":["string","null"]},"ato_registro":{"type":"string"},"data_registro":{"type":"string","format":"date"},"processo":{"type":["string","null"]},"registrada_em":{"type":"string","format":"date-time"},"adquirentes":{"type":"array","items":{"$ref":"#/components/schemas/Titular"}},"transmitentes":{"type":"array","items":{"$ref":"#/components/schemas/Titular"}}}}}}}