India (IND)
This section defines the supported geocoding datasets, operations, and input and output field information for India.
Supported Geocoding Datasets
The following table lists the supported geocoding dataset(s) with the available geocoding levels for India.
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
- 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.
- Interactive Geocoding— 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.
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 a double ampersand (&&). |
lastLine | String | The last line of the address. Optional. For example:
Gunjur Road |
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: www.indiapost.gov.in.
- 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.
Output Fields
The following table lists the address fields returned for a candidate located in India.
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. |
Custom Output Fields
The following table lists the output fields that are unique for India. Unless otherwise noted, these fields can be returned for both forward and reverse geocoding.
Name | Description |
---|---|
ISRURAL | When true, indicates the candidate's address is located in a rural region (village). |
POI_CATEGORY | Point of interest category. This field describes the type of POI, such as a bank, ATM, or restaurant. |
BLOCK | Block information. |
SUB_LOCALITY | The municipal division below locality (areaName4) level. This returns an SL result code. |