Input Fields
The input address may contain some or all of the following address elements.
Field Name Parameter | Type | Description |
---|---|---|
placeName | String | Specifies the building name, place name, Point of Interest (POI), company or firm name associated with the input address. Optional. |
mainAddress | String |
Single Line Input—If no other address field is populated, then the
mainAddress entry will be treated as a single line input.
Single line input can consist of multiple input address fields; these should be
entered in the typical address order for the country. For more details, refer to the
section "Single Line Input" below. Street Address—If the post address components (city, postalCode, etc.) are provided separately or in the lastLine field, then the contents of mainAddress will be treated as the street address part and can include company name, house number, building names and street names. Optional. Street Intersection Input—To enter an intersection, specify the two street names separated by one of the following tokens: and, &, &&, at, AT, or @. |
lastLine | String | The last line of the address. Optional. For example:
3001 Summer St. |
areaName1 | String | Specifies the state. Optional. |
areaName2 | String | Specifies the county. Optional. |
areaName3 | String | Specifies the town or city. Optional. |
areaName4 | String | Specifies the urbanization (used only for Puerto Rico). Optional. |
postalCode | String | ZIP Code. Optional. |
country | String | The three-letter ISO 3166-1 Alpha-3 country code. For the United States and its territories: Puerto Rico, American Samoa, Guam, North Mariana Islands, Palau, and Virgin Islands, the country code is USA. Required for forward geocoding. |