Estructura de respuesta – Geocode API
Para todos los endpoints, Geocode, Suggestions, Reverse y Multi Geocode, el formato de respuesta seguirá la estructura a continuación:
found
– Número de registros devueltos;results
– Array de objetos con todos los resultados encontrados:id
– Identificador de la dirección proporcionada en la solicitud;address
– Objeto con información de dirección:road
– Nombre de la carretera;number
– Número de dirección en formato de string;district
– Bairro;zipCode
– Código postal;city
– Ciudad;state
– Objeto con datos del estado:name
– Nombre del estado;code
– Acrónimo del estado;
mainLocation
– Objeto con las coordenadas geográficas del punto:lat
– Latitud;lon
– Longitud;
numberAsInteger
– Número de dirección, pero devuelto como un número entero en lugar de una string;
type
– Indica el tipo de datos devueltos. Los valores posibles son:ROAD
,CITY
ySTATE
;precision
– Indica el grado de confianza de los datos devueltos. Los valores posibles son:NUMBER_EXACT
– Indica que las coordenadas devueltas se refieren al punto exacto solicitado.;NUMBER_HIGH_PRECISION
– Indica que las coordenadas devueltas se refieren al punto solicitado, pero no disponemos de la ubicación exacta y que las coordenadas fueron interpoladas, con un margen de hasta 20 metros.;NUMBER_MEDIUM_PRECISION
– Indica que las coordenadas devueltas se refieren al punto solicitado, pero no disponemos de la ubicación exacta y que las coordenadas fueron interpoladas, con un margen de hasta 100 metros;NUMBER_LOW_PRECISION
– Indica que las coordenadas devueltas se refieren al punto solicitado, pero no disponemos de la ubicación exacta y que las coordenadas fueron interpoladas, con un margen de hasta 1000 metros;ROAD_CENTROID
– Indica que las coordenadas devueltas se refieren al centroide de la calle solicitada;CITY_CENTROID
– Indica que las coordenadas devueltas se refieren al centroide de la ciudad;STATE_CENTROID
– Indica que las coordenadas devueltas se refieren al centroide del estado.
score
– Puntuación numérica que representa el grado de correspondencia textual entre la dirección proporcionada en la solicitud y la dirección devuelta por el proceso de geocodificación;label
– Dirección completa encontrada utilizada en el proceso de geocodificación.
Ejemplo de respuesta completa:
{ "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 }