Lista de parâmetros

• Formatos de envio do endereço
• Parâmetros obrigatórios
• Parâmetros opcionais
• Exemplos de requisição

Formatos de envio do endereço

O endereço pode ser enviado de duas formas:

• Label – Texto único com os componentes do endereço separados por vírgulas, na ordem road, number, district, zipcode, city, state;
• Estruturado – Cada componente do endereço informado em um parâmetro separado.

Os dois formatos podem ser enviados na mesma requisição. Nesse caso, os parâmetros estruturados têm precedência e o label será ignorado:

Parâmetros obrigatórios

Os parâmetros obrigatórios dependem do formato de envio do endereço.

Formato estruturado

• road – Texto com o logradouro. Pode conter o número e o complemento, que serão separados na resposta. Limite de 150 caracteres;
• zipcode – Texto com o CEP do endereço. Aceita o CEP com ou sem hífen (exemplo: 01310-200 ou 01310200). Após a remoção do hífen, deve conter exatamente 8 dígitos;
• city – Texto com o nome do município.

Formato label

• label – Texto com o endereço completo, com os componentes separados por vírgulas na ordem road, number, district, zipcode, city, state. O logradouro, o CEP e o município devem estar preenchidos no label.
  • As cinco vírgulas de separação devem estar presentes, mesmo quando algum componente estiver vazio. Exemplo: "av paulista,1578,,01310200,sao paulo,";
  • Caso alguma vírgula esteja ausente, será retornado o erro Structure error on label field.

Nota: requisições sem road, sem zipcode ou city serão rejeitadas com o erro 400.

Parâmetros opcionais

• number – Texto com o número do imóvel. Pode ser enviado vazio ou conter complemento após o número (exemplo: "654 bloco 3"); nesse caso, o texto após o número será retornado em complement. Caso não seja informado, o número será identificado no road;
• district – Texto com o nome do bairro;
• state – Texto com a sigla do estado (UF).

Exemplos de requisição

Exemplo com o formato label

{
  "label": "r da cantarera 306 box 12,,centro,01024-000,sao paulo,SP"
}

Exemplo com o formato estruturado

{
  "road": "r da cantarera 306 box 12",
  "number": "",
  "zipcode": "01024-000",
  "district": "centro",
  "city": "sao paulo",
  "state": "SP"
}

Exemplo com label e parâmetros estruturados

Nesse caso, apenas os parâmetros estruturados serão considerados:

{
  "label": "r da cantarera 306 box 12,,centro,01024-000,sao paulo,SP",
  "road": "r da cantarera 306 box 12",
  "number": "",
  "zipcode": "01024-000",
  "district": "centro",
  "city": "sao paulo",
  "state": "SP"
}