Address Analyzer

Exemplos

Exemplo 1 – Endereço com sugestão de correção

Nesse exemplo, temos um endereço enviado no formato label, com o tipo de logradouro abreviado, o CEP com hífen e a cidade sem acento.

Requisição

{
  "label": "av paulista 1578 museu,,bela vista,01310-200,sao paulo,SP"
}

Resposta

A resposta traz a grafia oficial sugerida para o logradouro, o bairro e a cidade, com o número e o complemento separados. O status retornado será CORRECTED.

{
  "road": "Avenida Paulista",
  "number": "1578",
  "complement": "museu",
  "district": "Bela Vista",
  "zipcode": "01310200",
  "city": "São Paulo",
  "state": "SP",
  "status": "CORRECTED",
  "matchScore": 100.0,
  "label": "Avenida Paulista, 1578, Bela Vista, 01310200, São Paulo, SP"
}

Exemplo 2 – Endereço sem sugestão de correção

Nesse exemplo, temos um endereço enviado no formato estruturado em que o logradouro não corresponde ao CEP informado.

Requisição

{
  "road": "rua das acacias 45",
  "number": "",
  "zipcode": "01310200",
  "district": "bela vista",
  "city": "São Paulo",
  "state": "SP"
}

Resposta

O número foi separado do logradouro, mas não há sugestão de correção. O status retornado será NORMALIZED.

{
  "road": "rua das acacias",
  "number": "45",
  "complement": "",
  "district": "bela vista",
  "zipcode": "01310200",
  "city": "São Paulo",
  "state": "SP",
  "status": "NORMALIZED",
  "matchScore": 18.75,
  "label": "rua das acacias, 45, bela vista, 01310200, São Paulo, SP"
}

Exemplo 3 – Endereço com vários problemas de digitação

Nesse exemplo, o endereço enviado no formato label tem o tipo de logradouro abreviado com ponto, um erro de digitação no nome da rua, o número colado ao marcador “nº”, o complemento separado por hífen, o CEP com hífen e o bairro e a cidade sem acento.

Requisição

{
  "label": "R. da Cantarera nº306 - box 12,,centro,01024-000,sao paulo,SP"
}

Resposta

A API corrige o nome da rua, separa o número e o complemento e retorna a grafia oficial do bairro e da cidade. O status retornado será CORRECTED.

{
  "road": "Rua da Cantareira",
  "number": "306",
  "complement": "box 12",
  "district": "Centro",
  "zipcode": "01024000",
  "city": "São Paulo",
  "state": "SP",
  "status": "CORRECTED",
  "matchScore": 94.74,
  "label": "Rua da Cantareira, 306, Centro, 01024000, São Paulo, SP"
}

Exemplo 4 – Complemento enviado no parâmetro number

Nesse exemplo, o endereço é enviado no formato estruturado e o parâmetro number contém o número seguido do complemento.

Requisição

{
  "road": "av paulista",
  "number": "1578 museu masp",
  "zipcode": "01310200",
  "district": "bela vista",
  "city": "sao paulo",
  "state": "SP"
}

Resposta

O texto após o número é retornado em complement, e o number fica apenas com o número. O status retornado será CORRECTED.

{
  "road": "Avenida Paulista",
  "number": "1578",
  "complement": "museu masp",
  "district": "Bela Vista",
  "zipcode": "01310200",
  "city": "São Paulo",
  "state": "SP",
  "status": "CORRECTED",
  "matchScore": 100.0,
  "label": "Avenida Paulista, 1578, Bela Vista, 01310200, São Paulo, SP"
}

Exemplo 5 – Endereço sem número (s/n)

Nesse exemplo, o endereço enviado no formato label indica que o imóvel não tem número (“s/n”) e traz uma referência após o logradouro.

Requisição

{
  "label": "rua augusta s/n esquina com al santos,,consolacao,01305-000,sao paulo,SP"
}

Resposta

O number é retornado vazio e a referência é retornada em complement. O status retornado será CORRECTED.

{
  "road": "Rua Augusta",
  "number": "",
  "complement": "esquina com al santos",
  "district": "Consolação",
  "zipcode": "01305000",
  "city": "São Paulo",
  "state": "SP",
  "status": "CORRECTED",
  "matchScore": 100.0,
  "label": "Rua Augusta, , Consolação, 01305000, São Paulo, SP"
}

Exemplo 6 – Cidade que não corresponde ao CEP

Nesse exemplo, o endereço é enviado no formato estruturado com um CEP de São Paulo, mas com a cidade e o estado do Rio de Janeiro.

Requisição

{
  "road": "av paulista 1578",
  "number": "",
  "zipcode": "01310-200",
  "district": "bela vista",
  "city": "rio de janeiro",
  "state": "RJ"
}

Resposta

Como a cidade não corresponde ao CEP informado, não há sugestão de correção: o endereço é apenas padronizado, com o número separado do logradouro. O status retornado será NORMALIZED.

{
  "road": "avenida paulista",
  "number": "1578",
  "complement": "",
  "district": "bela vista",
  "zipcode": "01310200",
  "city": "rio de janeiro",
  "state": "RJ",
  "status": "NORMALIZED",
  "matchScore": 0.0,
  "label": "avenida paulista, 1578, bela vista, 01310200, rio de janeiro, RJ"
}

Exemplo 7 – CEP inexistente

Nesse exemplo, o endereço é enviado no formato estruturado com um CEP que não existe.

Requisição

{
  "road": "rua das flores 120 apto 32",
  "number": "",
  "zipcode": "99999-999",
  "district": "centro",
  "city": "sao paulo",
  "state": "SP"
}

Resposta

Como o CEP não foi encontrado, não há sugestão de correção. O número e o complemento são separados do logradouro e o status retornado será NORMALIZED.

{
  "road": "rua das flores",
  "number": "120",
  "complement": "apto 32",
  "district": "centro",
  "zipcode": "99999999",
  "city": "sao paulo",
  "state": "SP",
  "status": "NORMALIZED",
  "matchScore": 0.0,
  "label": "rua das flores, 120, centro, 99999999, sao paulo, SP"
}