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

KeyDatatypeRequiredDescription
addressstringThe full address, partial address or name of a place to try and locate. Comma separated address components are preferred.
house-numberstringThe house/building number to locate
streetstringThe street/road name to locate
citystringThe city/town name to locate
countystringThe county/region name to locate
statestringThe state name to locate
postal-codestringThe postal code to locate
country-codestringLimit result to this country (the default is no country bias)
language-codestringThe language to display results in, available languages are: <ul> <li>de, en, es, fr, it, pt, ru, zh</li> </ul>
fuzzy-searchbooleanIf 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

KeyDatatypeRequiredDescription
Acceptstring

RESPONSES

status: OK

{&quot;found&quot;:&quot;\u003cinteger\u003e&quot;,&quot;locations&quot;:[{&quot;country&quot;:&quot;\u003cstring\u003e&quot;,&quot;address&quot;:&quot;\u003cstring\u003e&quot;,&quot;city&quot;:&quot;\u003cstring\u003e&quot;,&quot;country-code&quot;:&quot;\u003cstring\u003e&quot;,&quot;country-code3&quot;:&quot;\u003cstring\u003e&quot;,&quot;latitude&quot;:&quot;\u003cnumber\u003e&quot;,&quot;postal-code&quot;:&quot;\u003cstring\u003e&quot;,&quot;longitude&quot;:&quot;\u003cnumber\u003e&quot;,&quot;state&quot;:&quot;\u003cstring\u003e&quot;,&quot;address-components&quot;:{&quot;proidentb&quot;:&quot;\u003cstring\u003e&quot;,&quot;in2&quot;:&quot;\u003cstring\u003e&quot;},&quot;currency-code&quot;:&quot;\u003cstring\u003e&quot;,&quot;location-type&quot;:&quot;\u003cstring\u003e&quot;,&quot;location-tags&quot;:[&quot;\u003cstring\u003e&quot;,&quot;\u003cstring\u003e&quot;],&quot;timezone&quot;:{&quot;id&quot;:&quot;\u003cstring\u003e&quot;,&quot;name&quot;:&quot;\u003cstring\u003e&quot;,&quot;abbr&quot;:&quot;\u003cstring\u003e&quot;,&quot;date&quot;:&quot;\u003cstring\u003e&quot;,&quot;time&quot;:&quot;\u003cstring\u003e&quot;,&quot;offset&quot;:&quot;\u003cstring\u003e&quot;},&quot;region-code&quot;:&quot;\u003cstring\u003e&quot;,&quot;postal-address&quot;:&quot;\u003cstring\u003e&quot;},{&quot;country&quot;:&quot;\u003cstring\u003e&quot;,&quot;address&quot;:&quot;\u003cstring\u003e&quot;,&quot;city&quot;:&quot;\u003cstring\u003e&quot;,&quot;country-code&quot;:&quot;\u003cstring\u003e&quot;,&quot;country-code3&quot;:&quot;\u003cstring\u003e&quot;,&quot;latitude&quot;:&quot;\u003cnumber\u003e&quot;,&quot;postal-code&quot;:&quot;\u003cstring\u003e&quot;,&quot;longitude&quot;:&quot;\u003cnumber\u003e&quot;,&quot;state&quot;:&quot;\u003cstring\u003e&quot;,&quot;address-components&quot;:{&quot;fugiat_51_&quot;:&quot;\u003cstring\u003e&quot;,&quot;occaecate4b&quot;:&quot;\u003cstring\u003e&quot;},&quot;currency-code&quot;:&quot;\u003cstring\u003e&quot;,&quot;location-type&quot;:&quot;\u003cstring\u003e&quot;,&quot;location-tags&quot;:[&quot;\u003cstring\u003e&quot;,&quot;\u003cstring\u003e&quot;],&quot;timezone&quot;:{&quot;id&quot;:&quot;\u003cstring\u003e&quot;,&quot;name&quot;:&quot;\u003cstring\u003e&quot;,&quot;abbr&quot;:&quot;\u003cstring\u003e&quot;,&quot;date&quot;:&quot;\u003cstring\u003e&quot;,&quot;time&quot;:&quot;\u003cstring\u003e&quot;,&quot;offset&quot;:&quot;\u003cstring\u003e&quot;},&quot;region-code&quot;:&quot;\u003cstring\u003e&quot;,&quot;postal-address&quot;:&quot;\u003cstring\u003e&quot;}]}