Estrutura de resposta – Geocode API
Para todos os endpoints, Geocode, Suggestions, Reverse e Multi Geocode, o formato da resposta seguirá a estrutura abaixo:
found– Quantidade de registros retornados.results– Array de objetos com todos os resultados encontrados:id– Identificador do endereço informado na requisição;address– Objeto com informações do endereço:road– Nome da via;number– Número do endereço no formato string;district– Bairro;zipCode– CEP;city– Cidade;state– Objeto com dados do estado:name– Nome do estado;code– Sigla do estado;
mainLocation– Objeto com as coordenadas geográficas do ponto:lat– Latitude;lon– Longitude;
numberAsInteger– Número do endereço, mas retornado como número inteiro ao invés de string;
type– Indica o tipo do dado retornado. Os valores possíveis são:ROAD,CITYeSTATE;precision– Indica o grau de confiança do dado retornado. Os valores possíveis são:NUMBER_EXACT– Indica que as coordenadas retornadas referem-se ao ponto exato que foi solicitado;NUMBER_HIGH_PRECISION– Indica que as coordenadas retornadas referem-se ao ponto solicitado, mas não temos a localização exata e as coordenadas foram interpoladas, com uma possível margem de distância de até 20 metros;NUMBER_MEDIUM_PRECISIONIndica que as coordenadas retornadas referem-se ao ponto solicitado, mas não temos a localização exata e as coordenadas foram interpoladas, com uma possível margem de distância de até 100 metros;NUMBER_LOW_PRECISION– Indica que as coordenadas retornadas referem-se ao ponto solicitado, mas não temos a localização exata e as coordenadas foram interpoladas, com uma possível margem de distância de até 1000 metros;ROAD_CENTROID– Indica que as coordenadas retornadas referem-se ao centróide da rua solicitada;CITY_CENTROID– Indica que as coordenadas retornadas referem-se ao centróide da cidade;STATE_CENTROID– Indica que as coordenadas retornadas referem-se ao centróide do estado.
score– Pontuação numérica que representa o grau de correspondência textual entre o endereço informado na requisição e o endereço retornado pelo processo de geocodificação;label– Endereço completo encontrado utilizado no processo de geocodificação.
Exemplo completo de resposta:
{
"results": [
{
"id": "6684353bf0662a1541ff635d",
"address": {
"road": "ALAMEDA CAMPINAS",
"number": "579",
"district": "JARDIM PAULISTA",
"zipCode": "01404000",
"city": "SÃO PAULO",
"state": {
"name": "SÃO PAULO",
"code": "SP"
},
"mainLocation": {
"lat": -23.566287789653508,
"lon": -46.6537028592172
},
"numberAsInteger": 579
},
"type": "ROAD",
"label": "ALAMEDA CAMPINAS, 01404000, JARDIM PAULISTA, SÃO PAULO, SP",
"score": 98.81773828023887,
"precision": "NUMBER_MEDIUM_PRECISION"
},
{
"id": "6684353bf0662a1541ff637b",
"address": {
"road": "ALAMEDA CAMPINAS",
"district": "JARDIM PAULISTA",
"zipCode": "01404001",
"city": "SÃO PAULO",
"state": {
"name": "SÃO PAULO",
"code": "SP"
},
"mainLocation": {
"lat": -23.56880844109,
"lon": -46.65604091167
}
},
"type": "ROAD",
"label": "ALAMEDA CAMPINAS, 01404001, JARDIM PAULISTA, SÃO PAULO, SP",
"score": 92.9419580012093,
"precision": "ROAD_CENTROID"
},
{
"id": "6684353bf0662a1541ff637c",
"address": {
"road": "ALAMEDA CAMPINAS",
"district": "JARDIM PAULISTA",
"zipCode": "01404003",
"city": "SÃO PAULO",
"state": {
"name": "SÃO PAULO",
"code": "SP"
},
"mainLocation": {
"lat": -23.5727482959,
"lon": -46.65984093151
}
},
"type": "ROAD",
"label": "ALAMEDA CAMPINAS, 01404003, JARDIM PAULISTA, SÃO PAULO, SP",
"score": 92.9419580012093,
"precision": "ROAD_CENTROID"
},
{
"id": "6684353bf0662a1541ff63b9",
"address": {
"road": "ALAMEDA CAMPINAS",
"district": "JARDIM PAULISTA",
"zipCode": "01404002",
"city": "SÃO PAULO",
"state": {
"name": "SÃO PAULO",
"code": "SP"
},
"mainLocation": {
"lat": -23.57150846699,
"lon": -46.65863824537
}
},
"type": "ROAD",
"label": "ALAMEDA CAMPINAS, 01404002, JARDIM PAULISTA, SÃO PAULO, SP",
"score": 92.9419580012093,
"precision": "ROAD_CENTROID"
},
{
"id": "6684353bf0662a1541ff6385",
"address": {
"road": "ALAMEDA CAMPINAS",
"district": "JARDIM PAULISTA",
"zipCode": "01404100",
"city": "SÃO PAULO",
"state": {
"name": "SÃO PAULO",
"code": "SP"
},
"mainLocation": {
"lat": -23.56631144908,
"lon": -46.65360036597
}
},
"type": "ROAD",
"label": "ALAMEDA CAMPINAS, 01404100, JARDIM PAULISTA, SÃO PAULO, SP",
"score": 92.78814049548771,
"precision": "ROAD_CENTROID"
},
{
"id": "6684353bf0662a1541ff63a2",
"address": {
"road": "ALAMEDA CAMPINAS",
"district": "JARDIM PAULISTA",
"zipCode": "01404200",
"city": "SÃO PAULO",
"state": {
"name": "SÃO PAULO",
"code": "SP"
},
"mainLocation": {
"lat": -23.56714829171,
"lon": -46.65440337412
}
},
"type": "ROAD",
"label": "ALAMEDA CAMPINAS, 01404200, JARDIM PAULISTA, SÃO PAULO, SP",
"score": 92.78814049548771,
"precision": "ROAD_CENTROID"
},
{
"id": "6684353bf0662a1541ff63a3",
"address": {
"road": "ALAMEDA CAMPINAS 150",
"district": "JARDIM PAULISTA",
"zipCode": "01404900",
"city": "SÃO PAULO",
"state": {
"name": "SÃO PAULO",
"code": "SP"
},
"mainLocation": {
"lat": -23.56343039334,
"lon": -46.6507807755
}
},
"type": "ROAD",
"label": "ALAMEDA CAMPINAS 150, 01404900, JARDIM PAULISTA, SÃO PAULO, SP",
"score": 91.48049238291864,
"precision": "ROAD_CENTROID"
},
{
"id": "6684344df0662a1541f5baee",
"address": {
"road": "RUA HAITI",
"district": "JARDIM PAULISTA",
"zipCode": "01404010",
"city": "SÃO PAULO",
"state": {
"name": "SÃO PAULO",
"code": "SP"
},
"mainLocation": {
"lat": -23.571433,
"lon": -46.6607828
}
},
"type": "ROAD",
"label": "RUA HAITI, 01404010, JARDIM PAULISTA, SÃO PAULO, SP",
"score": 84.24055564325018,
"precision": "ROAD_CENTROID"
},
{
"id": "6684342ef0662a1541f41a70",
"address": {
"road": "ALAMEDA LORENA",
"number": "579",
"district": "JARDIM PAULISTA",
"zipCode": "01424000",
"city": "SÃO PAULO",
"state": {
"name": "SÃO PAULO",
"code": "SP"
},
"mainLocation": {
"lat": -23.56994038386821,
"lon": -46.65933806789288
},
"numberAsInteger": 579
},
"type": "ROAD",
"label": "ALAMEDA LORENA, 01424000, JARDIM PAULISTA, SÃO PAULO, SP",
"score": 84.15016434701576,
"precision": "NUMBER_MEDIUM_PRECISION"
},
{
"id": "66843453f0662a1541f60988",
"address": {
"road": "ALAMEDA CASA BRANCA",
"number": "579",
"district": "JARDIM PAULISTA",
"zipCode": "01408000",
"city": "SÃO PAULO",
"state": {
"name": "SÃO PAULO",
"code": "SP"
},
"mainLocation": {
"lat": -23.565856915927288,
"lon": -46.659742464053295
},
"numberAsInteger": 579
},
"type": "ROAD",
"label": "ALAMEDA CASA BRANCA, 01408000, JARDIM PAULISTA, SÃO PAULO, SP",
"score": 84.01280084636662,
"precision": "NUMBER_MEDIUM_PRECISION"
}
],
"found": 10
}
