India (IND) - geo_addressing_sdk - 5.0

Geo Addressing SDK Developer Guide

Product type
Product family
Geo Addressing
Geo Addressing SDK
Product name
Geo Addressing SDK
Geo Addressing SDK Developer Guide
First publish date

This section defines the supported geocoding datasets, operations, and input and output field information for India. For the list of output fields that India supports, see output fields.

Supported Geocoding Datasets

The following table lists the supported geocoding dataset(s) with the available geocoding levels for India.

Note: Custom User Dictionaries are not supported.
Geocoding Dataset City Centroid Suburb/Village Centroid Postal Centroid Street Centroid Interpolated Street Address Point-level Address Point of Interest
TomTom English Yes Yes Yes Yes Yes Yes No
Lepton English Yes Yes Yes Yes Yes Yes No

Supported Operations

The following operations are supported for India:
  • Geocoding—Takes one or more addresses as input and returns latitude/longitude coordinates and other information.
  • Reverse Geocoding—Takes one or more latitude and longitude coordinates as input and returns the address of the location.
  • Address Autocomplete— Returns potential match candidates as the adddress is typed in.
  • Global Key Lookup—Returns geocode candidates when given a unique key as input. USA MLD and AUS GNAF data only.

Input Fields

The input address may contain some or all of the following address elements.

Field Name Parameter Type Description
PlaceName placeName String Specifies the building name, place name, Point of Interest (POI), company or firm name associated with the input address. Optional.
MainAddressLine mainAddress String Single Line Input—If no other address field is populated, then the MainAddressLinemainAddress entry will be treated as a single line input. Single line input can consist of multiple input address fields including POBox numbers or range of numbers; 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 MainAddressLinemainAddress 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. For example:

Gunjur Road
Marattahalli 560017

areaName1 String Specifies the state. Optional.
areaName2 String Specifies the district. Optional.
areaName3 String Specifies the city or town. Optional.
areaName4 String Specifies the locality. Optional.
postalCode String India uses a 6-digit postal code. Optional.
country String The three-letter ISO 3166-1 Alpha-3 country code. For India, the country code is Required for forward geocoding.

Address Guidelines for India

Follow these suggestions to ensure that your input address data is in the best format possible for optimum matching and geocoding. For additional information about the India postal system, see the India Post website:

  • Required fields—Addresses must contain either a city or a postal code.
  • Thoroughfare types—Thoroughfare types and their common abbreviations are recognized and fully supported on input and output.
  • Common words and abbreviations in addresses—The geocoder recognizes common words that are used in street names, directionals, building identifiers, and Points of Interest and can successfully geocode addresses that use these common words. Common abbreviations are also recognized within addresses.
  • Numbers, Numeric Equivalents, and Ordinals—Numbered streets are mapped to the named equivalents. Ordinals are also recognized in input addresses.
  • Point of Interest—The geocoder can return S8 match candidates based on a placename combined with any valid locational input (town, locality, or postcode). Points of Interest (POI) can include restaurants, hotels, police stations, banks, ATMs, hospitals, schools, stores, and other businesses and organizations. POI candidates also return sublocality, if that information is available in the data.
  • Sublocality—The geocoder can return SL sublocality candidates. This indicates a sublocality (block or sector) street level match. An SL result code also requires a match on other geographic input fields (city, district, or state).
  • Street level geocoding— Street geocoded India addresses can return candidates based on Placename/Point of Interest (S8 result code), sublocality (SL result code), and street centroid (S4 result code).

Single Line Input

Instead of entering each address component in separate fields, you can enter the entire address in the mainAddress input field with the address elements ordered as follows:

[unit_type][unit_value][address_number][pre_directional][street_name] [post_directional][area_name_3][area_name_1][post_code]

For best results, put a comma between the street information and the last address line information.

Custom Options

There are no options specific to India.

Parsed Address Output Fields

The following table lists the parsed address fields returned for a candidate located in India.

To return the Parsed Address fields using Management Console, select one of the following options:
  • To return the Parsed Address fields: In the Country Filters dropdown menu, select Global Defaults. Then, on the Return Values tab, select Parsed Address.
  • To return all output fields: In the Country Filters dropdown, select Global Defaults. Then, on the Return Values tab, select Return all available information.
Note: The placeName, addressNumber, unitType and unitValue field values are only returned when a geocoding dataset that supports street address interpolation is installed.
Field Name Description
mainAddressLine The street address which may include company name, house number, building names and street names.
addressLastLine The last line of the address.
placeName The building name, place name, Point of Interest (POI), company or firm name associated with the address.
areaName1 The state.
areaName2 The district.
areaName3 The city or town.
areaName4 The locality.
postCode1 The 6-digit postal code.
postCode2 Not used.
country The three-letter ISO 3166-1 Alpha-3 country code. For India, the country code is IND.
addressNumber The address number.
streetName The street or road name.
unitType The unit type such as APT, STE, etc.
unitValue The unit value/number, such as "3B".
customFields The following table lists the custom output fields for India.