Geocode Address
GET {{baseUrl}}/geocode-address?address=<string>&house-number=<string>&street=<string>&city=<string>&county=<string>&state=<string>&postal-code=<string>&country-code=<string>&language-code=en&fuzzy-search=false
Geocode an address, partial address or just the name of a place
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
address | string | The full address, partial address or name of a place to try and locate. Comma separated address components are preferred. | |
house-number | string | The house/building number to locate | |
street | string | The street/road name to locate | |
city | string | The city/town name to locate | |
county | string | The county/region name to locate | |
state | string | The state name to locate | |
postal-code | string | The postal code to locate | |
country-code | string | Limit result to this country (the default is no country bias) | |
language-code | string | The language to display results in, available languages are: <ul> <li>de, en, es, fr, it, pt, ru, zh</li> </ul> | |
fuzzy-search | boolean | If no matches are found for the given address, start performing a recursive fuzzy search until a geolocation is found. This option is recommended for processing user input or implementing auto-complete. We use a combination of approximate string matching and data cleansing to find possible location matches |
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
Accept | string |
RESPONSES
status: OK
{"found":"\u003cinteger\u003e","locations":[{"country":"\u003cstring\u003e","address":"\u003cstring\u003e","city":"\u003cstring\u003e","country-code":"\u003cstring\u003e","country-code3":"\u003cstring\u003e","latitude":"\u003cnumber\u003e","postal-code":"\u003cstring\u003e","longitude":"\u003cnumber\u003e","state":"\u003cstring\u003e","address-components":{"proidentb":"\u003cstring\u003e","in2":"\u003cstring\u003e"},"currency-code":"\u003cstring\u003e","location-type":"\u003cstring\u003e","location-tags":["\u003cstring\u003e","\u003cstring\u003e"],"timezone":{"id":"\u003cstring\u003e","name":"\u003cstring\u003e","abbr":"\u003cstring\u003e","date":"\u003cstring\u003e","time":"\u003cstring\u003e","offset":"\u003cstring\u003e"},"region-code":"\u003cstring\u003e","postal-address":"\u003cstring\u003e"},{"country":"\u003cstring\u003e","address":"\u003cstring\u003e","city":"\u003cstring\u003e","country-code":"\u003cstring\u003e","country-code3":"\u003cstring\u003e","latitude":"\u003cnumber\u003e","postal-code":"\u003cstring\u003e","longitude":"\u003cnumber\u003e","state":"\u003cstring\u003e","address-components":{"fugiat_51_":"\u003cstring\u003e","occaecate4b":"\u003cstring\u003e"},"currency-code":"\u003cstring\u003e","location-type":"\u003cstring\u003e","location-tags":["\u003cstring\u003e","\u003cstring\u003e"],"timezone":{"id":"\u003cstring\u003e","name":"\u003cstring\u003e","abbr":"\u003cstring\u003e","date":"\u003cstring\u003e","time":"\u003cstring\u003e","offset":"\u003cstring\u003e"},"region-code":"\u003cstring\u003e","postal-address":"\u003cstring\u003e"}]}