Geocode Address 18.0

post

https://{host}/li/geocode/18.0

Geocodes a location based on attributes specified in the request body.

The countryCode and countryScheme parameters are required. All other body parameters are optional.

Body Params

Address to geocode

int64

User defined id

admin1Code

string

length ≤ 16

Code for administrative level 1. Admin1 represents large geographic divisions, such as states and provinces.

admin1Name

string

length ≤ 256

Name of administrative level 1

admin2Code

string

length ≤ 16

Code for administrative level 2. Admin2 represents smaller geographic divisions than Admin1, such as counties.

admin2Name

string

length ≤ 256

Name of administrative level 2

admin3Code

string

length ≤ 16

Code for administrative level 3. Admin3 represents even smaller geographic divisions than Admin2, such as districts.

admin3Name

string

length ≤ 256

Name of administrative level 3

admin4Code

string

length ≤ 16

Code for administrative level 4

admin4Name

string

length ≤ 256

Name of administrative level 4

cityName

string

length ≤ 256

Name of City/Town

countryCode

string

required

length ≤ 4

Country Code (optional for geocoding if latitude and longitude are provided)

countryName

string

length ≤ 512

Name of Country

countryScheme

string

enum

required

Standard for user-supplied country code (optional for geocoding if latitude and longitude are provided)

Allowed:

latitude

double

-90 to 90

Location Latitude

longitude

double

-180 to 180

Location Longitude

postalCode

string

length ≤ 16

Postal Code

streetAddress

string

length ≤ 256

Address containing Number, Street Name, Street Type, etc.

name

string

length ≤ 512

Supplemental text captured for the address

Responses

200Everything worked as expected.

400The request was unacceptable, likely due to missing a required input.

401No valid API key provided.

500Something went wrong on our end (this happens rarely)