Global Geocode Input Fields

The following table defines the Geocoding input fields.
Field Name Type Description
placeName String Building name, place name, Point of Interest (POI), company or firm name associated with the input address. Optional. For example:

Pitney Bowes
4750 Walnut St.
Boulder, CO 80301

mainAddress String Single Line input—If no other field is populated, then the mainAddress entry will be treated as a single line input and can be a collection of address field elements. The input order of the address fields should reflect the normal address formatting for your country. Optional. For example:

4750 Walnut St., Boulder CO, 80301

Street Address—If the address fields (placeName, lastLine, postalCode, etc.) are provided separately, then the content of this field 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 a double ampersand (&&).

lastLine String The last line of the address. Optional.
areaName1 String Specifies the largest geographic area, typically a state or province. Optional.
areaName2 String Specifies the secondary geographic area, typically a county or district. Optional.
areaName3 String Specifies a city or town name. Optional.
areaName4 String Specifies a city subdivision or locality. Optional.
postalCode String The postal code in the appropriate format for the country. Optional.
country String ISO 3166-1 alpha-3 country code. Required. For country codes, see Country Reference Listing and ISO 3166-1 Country Codes.
addressNumber String House or building number.
streetName String Street name.
unitType String Specifies the type of unit, such as Apt., Ste. and Bldg.
unitValue String Specifies the unit value/number, such as "3B".
maxRanges Integer A range is a series of addresses along a street segment. For example, 5400-5499 Main St. is an address range representing addresses in the 5400 block of Main St. A range may represent just odd or even addresses within a segment, or both odd and even addresses. A range may also represent a single building with multiple units, such as an apartment building.

This option specifies the maximum number of ranges to return for each candidate. Since the geocoder returns one candidate per segment, and since a segment may contain multiple ranges, this option allows you to see the other ranges in a candidate's segment.

Optional. Must be an integer value. Default = 1. (For USA: Default = 0)
maxRangeUnits Integer This option specifies the maximum number of units (for example, apartments or suites) to return for each range.

For example, if you were to geocode an office building at 65 Main St. containing four suites, there would be a maximum of four units returned for the building's range: 65 Suite 1, 65 Suite 2, 65 Suite 3, and 65 Suite 4. If you were to specify a maximum number of units as 2, then only two units would be returned instead of all four.

Optional. Must be an integer value. Default = 0.