Address

Address is a collection of address related endpoints.

Hint

The Hint endpoint returns information about a geocoding address that could not be successfully processed with our Geocode endpoint. This information includes all geocoding results that are considered to be "close" to the original address.

SecuritybasicAuth

Request

Request Body schema: application/json

address	string Full address.
countryCode required	string Alpha-2 code of the country. Enum: "AT" "BE" "CZ" "DE" "DK" "ES" "FI" "FR" "GB" "HR" "HU" "IE" "IT" "LU" "NL" "PL" "PT" "RO" "SK" "SM" "US" "VA" "CA"

Responses

200

400

Bad Request

401

Unauthorized

500

Internal Server Error

post/api/v1/address/hints

Request samples

Payload
curl
Java
Python
JavaScript

application/json

{"address": "Viaaaa 20 Settembre, 196/R 16121 Genova",
"countryCode": "IT"
}

Response samples

application/json

{"normalization": {"components": {"street": "Via 20 Settembre",
"houseNumber": "196/R",
"distance": null,
"indoor": null,
"postalCode": 16121,
"preciseCode": null,
"locality": "Genova",
"subLocality": null,
"cityDistrict": null,
"region": null
},
"formatted": "Via 20 Settembre, 196/R 16121 Genova",
"similarities": {"street": 1,
"locality": 1
},
"parse": {"initialAddress": "viaaaa 20 settembre, 196/r 16121 genova IT",
"preparedAddress": "via 20 settembre, 196/r 16121 genova IT",
"separate": {"methodResults": [{"type": "Libpostal",
"inputAddress": "via 20 settembre, 196/r 16121 genova IT",
"components": [{"value": "via 20 settembre",
"componentType": "Libpostal.Road"
},
{"value": "196/r",
"componentType": "Libpostal.HouseNumber"
},
{"value": 16121,
"componentType": "Libpostal.Postcode"
},
{"value": "genova",
"componentType": "Libpostal.City"
},
{"value": "it",
"componentType": "Libpostal.Other"
}
],
"outputAddress": "via 20 settembre, 196/r 16121 genova IT"
}
],
"mergedComponents": [{"value": "via 20 settembre",
"componentType": "Libpostal.Road"
},
{"value": "196/r",
"componentType": "Libpostal.HouseNumber"
},
{"value": 16121,
"componentType": "Libpostal.Postcode"
},
{"value": "genova",
"componentType": "Libpostal.City"
},
{"value": "it",
"componentType": "Libpostal.Other"
}
]
},
"validate": {"components": [{"componentType": "Final.Street",
"source": {"value": "via 20 settembre",
"componentType": "Libpostal.Road"
},
"extractedValue": null,
"preparedValue": "via 20 settembre",
"validatedValue": "via 20 settembre",
"formattedValue": "via 20 settembre"
},
{"componentType": "Final.HouseNumber",
"source": {"value": "196/r",
"componentType": "Libpostal.HouseNumber"
},
"extractedValue": null,
"preparedValue": "196/R",
"validatedValue": "196/R",
"formattedValue": "196/R"
},
{"componentType": "Final.PostalCode",
"source": {"value": 16121,
"componentType": "Libpostal.Postcode"
},
"extractedValue": null,
"preparedValue": 16121,
"validatedValue": 16121,
"formattedValue": 16121
},
{"componentType": "Final.Locality",
"source": {"value": "genova",
"componentType": "Libpostal.City"
},
"extractedValue": null,
"preparedValue": "genova",
"validatedValue": "genova",
"formattedValue": "genova"
}
],
"updatedAddress": "via 20 settembre, 196/r 16121 genova IT"
},
"previousParse": null
}
},
"bbox": [8.9375147,
44.40621,
8.93766,
44.4063996
],
"items": [{"source": "GOOGLE",
"accuracy": {"houseNumberFallback": null,
"houseNumberChanged": true,
"postalCodeChanged": false,
"score": 80,
"level": "INTERPOLATED_POINT"
},
"geometry": {"center": {"lat": 44.4063996,
"lng": 8.9375147
},
"viewport": {"bbox": [8.936165719708498,
44.4050506197085,
8.938863680291503,
44.4077485802915
],
"diameter": 368.67
},
"bound": null
},
"item": {"geocodedAt": "2022-05-25T04:55:37.116387Z",
"data": {"street": "Via XX Settembre",
"number": 196,
"postalCode": 16121,
"city": "Genova",
"subLocality": null,
"formattedAddress": "Via XX Settembre, 196, 16121 Genova GE, Italy",
"coordinates": {"lat": 44.4063996,
"lng": 8.9375147
}
},
"accuracy": {"score": "INTERPOLATED_POINT",
"houseNumberFallback": null,
"postalCodeChangeValid": null
},
"placeId": "Ei1WaWEgWFggU2V0dGVtYnJlLCAxOTYsIDE2MTIxIEdlbm92YSBHRSwgSXRhbHkiMRIvChQKEgkBeUKPwkPTEhF13_twPaGachDEASoUChIJfet4a8JD0xIRX5dW8w4o3QM",
"partialMatch": false,
"addressComponents": [{"longName": 196,
"shortName": 196,
"types": ["STREET_NUMBER"
]
},
{"longName": "Via XX Settembre",
"shortName": "Via XX Settembre",
"types": ["ROUTE"
]
},
{"longName": "Genova",
"shortName": "Genova",
"types": ["LOCALITY",
"POLITICAL"
]
},
{"longName": "Genova",
"shortName": "Genova",
"types": ["ADMINISTRATIVE_AREA_LEVEL_3",
"POLITICAL"
]
},
{"longName": "Città Metropolitana di Genova",
"shortName": "GE",
"types": ["ADMINISTRATIVE_AREA_LEVEL_2",
"POLITICAL"
]
},
{"longName": "Liguria",
"shortName": "Liguria",
"types": ["ADMINISTRATIVE_AREA_LEVEL_1",
"POLITICAL"
]
},
{"longName": "Italy",
"shortName": "IT",
"types": ["COUNTRY",
"POLITICAL"
]
},
{"longName": 16121,
"shortName": 16121,
"types": ["POSTAL_CODE"
]
}
],
"types": ["STREET_ADDRESS"
],
"geometry": {"bounds": null,
"location": {"lat": 44.4063996,
"lng": 8.9375147
},
"locationType": "RANGE_INTERPOLATED",
"viewport": {"northeast": {"lat": 44.4077485802915,
"lng": 8.938863680291503
},
"southwest": {"lat": 44.4050506197085,
"lng": 8.936165719708498
}
}
},
"type": "GOOGLE"
}
},
{"source": "HERE",
"accuracy": {"houseNumberFallback": null,
"houseNumberChanged": false,
"postalCodeChanged": false,
"score": 80,
"level": "INTERPOLATED_POINT"
},
"geometry": {"center": {"lat": 44.40621,
"lng": 8.93766
},
"viewport": {"bbox": [8.93892,
44.40711,
8.9364,
44.40531
],
"diameter": 283.06
},
"bound": null
},
"item": {"geocodedAt": "2022-05-25T04:55:37.089314Z",
"data": {"street": "Via 20 Settembre",
"number": "196/r",
"postalCode": 16121,
"city": "Genova",
"subLocality": null,
"formattedAddress": "Via 20 Settembre, 196/r, 16121 Genova GE, Italia",
"coordinates": {"lat": 44.40621,
"lng": 8.93766
}
},
"accuracy": {"score": "INTERPOLATED_POINT",
"houseNumberFallback": null,
"postalCodeChangeValid": null
},
"resultType": "houseNumber",
"position": {"lat": 44.40621,
"lng": 8.93766
},
"mapView": {"west": 8.9364,
"north": 44.40711,
"east": 8.93892,
"south": 44.40531
},
"type": "HERE"
}
}
]
}