Response Structure – Geocode API
For all endpoints, Geocode, Suggestions, Reverse and Multi Geocode, the response format will follow the structure below:
found– Number of records returned.results– Array of objects with all the results found:id– Identifier of the address entered in the request;address– Object with address information:road– Name of the road;number– Address number in string format;district– District;zipCode– Zipcode;city– City;state– Object with state data:name– State name;code– State acronym;
mainLocation– Object with the geographic coordinates of the point:lat– Latitude;lon– Longitude;
numberAsInteger– Address number, but returned as an integer instead of a string;
type– Indicates the type of data returned. Possible values are:ROAD,CITYandSTATE;precision– Indicates the confidence level of the returned data. Possible values are:NUMBER_EXACT– Indicates that the returned coordinates refer to the exact point that was requested;NUMBER_HIGH_PRECISION– Indicates that the returned coordinates refer to the requested point, but we do not have the exact location and the coordinates were interpolated, with a possible distance margin of up to 20 meters;NUMBER_MEDIUM_PRECISION– Indicates that the returned coordinates refer to the requested point, but we do not have the exact location and the coordinates were interpolated, with a possible distance margin of up to 100 meters;NUMBER_LOW_PRECISION– Indicates that the returned coordinates refer to the requested point, but we do not have the exact location and the coordinates were interpolated, with a possible margin of distance of up to 1000 meters;ROAD_CENTROID– Indicates that the returned coordinates refer to the centroid of the requested street;CITY_CENTROID– Indicates that the returned coordinates refer to the centroid of the city;STATE_CENTROID– Indicates that the returned coordinates refer to the centroid of the state.
score– Numerical score representing the degree of textual correspondence between the address provided in the request and the address returned by the geocoding process;label– Complete address found used in the geocoding process.
Response example:
{
"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
}
