Developer

Region-specific content

Last edit: 2022.11.14

Some parts of TomTom data are subject to additional legal terms and conditions. When used, the customer must agree to and follow these additional conditions. Also, for some regions our APIs can have differences in requests and responses compared to the default API behavior. Customers should be aware of these differences before using the region-specific content.

Available region-specific contents

Hostname

Description

kr-api.tomtom.com

  • Hostname, where detailed South Korea data is available.

  • Detailed South Korean data is processed and hosted in South Korea.

    • It may impact the latency for requests sent from outside of South Korea.

  • The service customers are not allowed to download, store, cache nor host the South Korean data outside of South Korea (except for web browser cache).

  • The service customers are not allowed to display any coordinates of any place within South Korea.

  • Response data for South Korea can have additional response data.

Region-specific API changes

Response data for South Korea

South Korea switched from a land lot-based addressing format to a street name-based format in 2011. The old format is still widely used and therefore supported by the Search API, which means both address formats can be found and returned by various Search APIs (geocode, search, and reverse geocode).

Changes to the API response only apply to results of type Point Address. The Search API supports Point Address results with

  1. only a street name-based address
  2. both a street name-based address and a land lot-based address

Street name-based address only

For a Point Address with only a street name-based address, the API response is identical to the default API response.

Both address formats

Most street name-based addresses have a matching land lot-based address linked to it. To support this dual-addressing scheme, the API response contains the address field, as well as an additional field linkedAddress. The address field contains the street name-based address, while the region-specific linkedAddress field contains the land lot-based address. The linkedAddress response object mostly follows the default address object, except for the addition of the following two fields.

FieldDescription

landCode
string

Land-lot number.

dependentLocalName
string

Neighborhood ( dong ).

An Point Address element in the results array with both address formats present is represented in JSON as follows:

Response structure - JSON
1{
2  "summary": {
3    "query": "2501 soquel dr santa cruz ca 95065",
4    "queryType": "NON_NEAR",
5    "queryTime": 8,
6    "numResults": 1,
7    "offset": 0,
8    "totalResults": 1,
9    "fuzzyLevel": 1,
10    "geoBias": {
11      "lat": 36.98844,
12      "lon": -121.97483
13    }
14  },
15  "results": []
16}

Where each element of the results array is in the following format:

Results array elements format - JSON
1{
2  "type": "Point Address",
3  "id": "US/PAD/p0/45619296",
4  "score": 15.725,
5  "matchConfidence": {
6    "score": 1
7  },
8  "dist": 0.8875712594288668,
9  "address": {
10    "streetNumber": "2501",
11    "streetName": "Soquel Dr",
12    "municipalitySubdivision": "Santa Cruz, Live Oak",
13    "municipality": "Santa Cruz, Live Oak",
14    "countrySecondarySubdivision": "Santa Cruz",
15    "countryTertiarySubdivision": "Santa Cruz",
16    "countrySubdivision": "CA",
17    "postalCode": "95065",
18    "extendedPostalCode": "950652023",
19    "countryCode": "US",
20    "country": "United States Of America",
21    "countryCodeISO3": "USA",
22    "freeformAddress": "2501 Soquel Dr, Santa Cruz, CA 95065",
23    "countrySubdivisionName": "California",
24    "localName": "Santa Cruz"
25  },
26  "position": {
27    "lat": 36.98844,
28    "lon": -121.97482
29  },
30  "mapcodes":[
31    {
32      "type":"Local",
33      "fullMapcode":"US-CA FS.WRH3",
34      "territory":"US-CA",
35      "code":"FS.WRH3"
36    },
37    {
38      "type":"International",
39      "fullMapcode":"S4ZW4.990V"
40    },
41    {
42      "type":"Alternative",
43      "fullMapcode":"US-CA 4349.S8W",
44      "territory":"US-CA",
45      "code":"4349.S8W"
46    },
47    {
48      "type":"Alternative",
49      "fullMapcode":"US-CA JJCH.H9DF",
50      "territory":"US-CA",
51      "code":"JJCH.H9DF"
52    },
53    {
54      "type":"Alternative",
55      "fullMapcode":"USA JJCH.H9DF",
56      "territory":"USA",
57      "code":"JJCH.H9DF"
58    }
59  ],
60  "viewport": {
61    "topLeftPoint": {
62      "lat": 36.98934,
63      "lon": -121.97595
64    },
65    "btmRightPoint": {
66      "lat": 36.98754,
67      "lon": -121.97369
68    }
69  },
70  "entryPoints": [
71    {
72      "type": "main",
73      "position": {
74        "lat": 36.98817,
75        "lon": -121.97487
76      }
77    }
78  ],
79  "addressRanges": {
80    "rangeLeft": "1 - 3",
81    "rangeRight": "2 - 12",
82    "from": {
83      "lat": 51.16561,
84      "lon": 19.48489
85    },
86    "to": {
87      "lat": 51.16545,
88      "lon": 19.4863
89    }
90  },
91  "dataSources": {
92    "geometry": {
93      "id": "00004e4c-3100-3c00-0000-0000685e23c7"
94    }
95  }
96}