{
"opencollection": "1.0.0",
"info": {
"name": "Maps Additional Data Geocoding API",
"version": "3.0"
},
"request": {
"auth": {
"type": "apikey",
"key": "key",
"value": "{{key}}",
"placement": "query"
}
},
"items": [
{
"info": {
"name": "Geocoding",
"type": "folder"
},
"items": [
{
"info": {
"name": "Geocode",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.tomtom.com/search/:versionNumber/geocode/:query.:ext",
"params": [
{
"name": "versionNumber",
"value": "",
"type": "path",
"description": "Service version number. The current value is 2."
},
{
"name": "query",
"value": "4 north 2nd street san jose",
"type": "path",
"description": "Query string. Must be properly URL encoded."
},
{
"name": "ext",
"value": "xml",
"type": "path",
"description": "Expected response format."
},
{
"name": "storeResult",
"value": "",
"type": "query",
"description": "If the \"storeResult\" flag is set, the query will be interpreted as a stored geocode and will be billed according to the terms of use."
},
{
"name": "typeahead",
"value": "",
"type": "query",
"description": "If the \"typeahead\" flag is set, the query will be interpreted as a partial input and the search will enter predictive mode."
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Maximum number of search results that will be returned."
},
{
"name": "ofs",
"value": "",
"type": "query",
"description": "Starting offset of the returned results within the full result set."
},
{
"name": "countrySet",
"value": "FR",
"type": "query",
"description": "Comma separated string of country codes. This will limit the search to the specified countries."
},
{
"name": "lat",
"value": "37.337",
"type": "query",
"description": "Latitude where results should be biased. \nNOTE: supplying a lat/lon without a radius will return search results biased to that point."
},
{
"name": "lon",
"value": "-121.89",
"type": "query",
"description": "Longitude where results should be biased\nNOTE: supplying a lat/lon without a radius will return search results biased to that point."
},
{
"name": "radius",
"value": "",
"type": "query",
"description": "If radius and position are set, the results will be constrained to the defined area. The radius parameter is specified in meters."
},
{
"name": "topLeft",
"value": "37.553,-122.453",
"type": "query",
"description": "Top left position of the bounding box. This is specified as a comma separated string composed of lat., lon."
},
{
"name": "btmRight",
"value": "37.4,-122.55",
"type": "query",
"description": "Bottom right position of the bounding box. This is specified as a comma separated string composed of lat., lon."
},
{
"name": "language",
"value": "",
"type": "query",
"description": "Language in which search results should be returned. Should be one of supported IETF language tags, case insensitive."
},
{
"name": "extendedPostalCodesFor",
"value": "",
"type": "query",
"description": "Indexes for which extended postal codes should be included in the results. Available indexes are:\n - Addr = Address ranges\n - Geo = Geographies\n - PAD = Point Addresses\n - POI = Points of Interest\n - Str = Streets\n - XStr = Cross Streets (intersections)"
},
{
"name": "view",
"value": "",
"type": "query",
"description": "Geopolitical View."
}
]
},
"docs": "Geocode"
},
{
"info": {
"name": "Structured Geocode",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.tomtom.com/search/:versionNumber/structuredGeocode.:ext",
"params": [
{
"name": "versionNumber",
"value": "",
"type": "path",
"description": "Service version number. The current value is 2."
},
{
"name": "ext",
"value": "xml",
"type": "path",
"description": "Expected response format."
},
{
"name": "countryCode",
"value": "NL",
"type": "query",
"description": "2 or 3 letter country code (e.g.: FR, ES)."
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Maximum number of search results that will be returned."
},
{
"name": "ofs",
"value": "",
"type": "query",
"description": "Starting offset of the returned results within the full result set."
},
{
"name": "streetNumber",
"value": "",
"type": "query",
"description": "The street number for the structured address."
},
{
"name": "streetName",
"value": "",
"type": "query",
"description": "The street name for the structured address."
},
{
"name": "crossStreet",
"value": "",
"type": "query",
"description": "The cross street name for the structured address."
},
{
"name": "municipality",
"value": "Amsterdam",
"type": "query",
"description": "The municipality (city/town) for the structured address."
},
{
"name": "municipalitySubdivision",
"value": "",
"type": "query",
"description": "The municipality subdivision (sub/super city) for the structured address."
},
{
"name": "countryTertiarySubdivision",
"value": "",
"type": "query",
"description": "The named area for the structured address."
},
{
"name": "countrySecondarySubdivision",
"value": "",
"type": "query",
"description": "The county for the structured address."
},
{
"name": "countrySubdivision",
"value": "",
"type": "query",
"description": "The state or province for the structured address."
},
{
"name": "postalCode",
"value": "",
"type": "query",
"description": "The zip code or postal code for the structured address."
},
{
"name": "language",
"value": "",
"type": "query",
"description": "Language in which search results should be returned. Should be one of supported IETF language tags, case insensitive."
},
{
"name": "extendedPostalCodesFor",
"value": "",
"type": "query",
"description": "Indexes for which extended postal codes should be included in the results. Available indexes are:\n - Addr = Address ranges\n - Geo = Geographies\n - PAD = Point Addresses\n - POI = Points of Interest\n - Str = Streets\n - XStr = Cross Streets (intersections)"
}
]
},
"docs": "Structured Geocode"
}
]
}
],
"bundled": true
}