{"openapi":"3.1.0","info":{"title":"Apizie","version":"2.0.0","description":"One API key, one envelope, many public data sources."},"servers":[{"url":"https://apizie.tech"}],"security":[{"ApiKeyAuth":[]}],"paths":{"/v1/places:tomtom-search/get-search-version-number-additional-data-ext":{"get":{"operationId":"places_tomtom_search_get_search_version_number_additional_data_ext","summary":"Additional Data","description":"GET /search/{versionNumber}/additionalData.{ext}","tags":["places"],"parameters":[{"name":"versionNumber","in":"query","required":true,"description":"Service version number. The current value is 2.","schema":{"type":"integer","enum":[2],"description":"Service version number. The current value is 2."}},{"name":"ext","in":"query","required":true,"description":"Expected response format.","schema":{"type":"string","enum":["json"],"description":"Expected response format."}},{"name":"geometries","in":"query","required":true,"description":"Comma separated list of geometry UUIDs, previously retrieved from an Search API request.","schema":{"type":"string","description":"Comma separated list of geometry UUIDs, previously retrieved from an Search API request."},"example":"00004631-3400-3c00-0000-0000673c4d2e,00004631-3400-3c00-0000-0000673c42fe"},{"name":"geometriesZoom","in":"query","required":false,"description":"Defines the precision of the geometries.","schema":{"type":"integer","enum":[0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22],"description":"Defines the precision of the geometries."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/places:tomtom-search/get-search-version-number-category-search-query-ext":{"get":{"operationId":"places_tomtom_search_get_search_version_number_category_search_query_ext","summary":"Category Search","description":"GET /search/{versionNumber}/categorySearch/{query}.{ext}","tags":["places"],"parameters":[{"name":"versionNumber","in":"query","required":true,"description":"Service version number. The current value is 2.","schema":{"type":"integer","enum":[2],"description":"Service version number. The current value is 2."}},{"name":"query","in":"query","required":true,"description":"Query string. Must be properly URL encoded.","schema":{"type":"string","description":"Query string. Must be properly URL encoded."},"example":"pizza"},{"name":"ext","in":"query","required":true,"description":"Expected response format.","schema":{"type":"string","enum":["json","jsonp","js","xml"],"description":"Expected response format."},"example":"xml"},{"name":"typeahead","in":"query","required":false,"description":"If the \"typeahead\" flag is set, the query will be interpreted as a partial input and the search will enter predictive mode.","schema":{"type":"boolean","default":false,"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","in":"query","required":false,"description":"Maximum number of search results that will be returned.","schema":{"type":"integer","default":10,"description":"Maximum number of search results that will be returned."}},{"name":"ofs","in":"query","required":false,"description":"Starting offset of the returned results within the full result set.","schema":{"type":"integer","default":0,"description":"Starting offset of the returned results within the full result set."}},{"name":"countrySet","in":"query","required":false,"description":"Comma separated string of country codes. This will limit the search to the specified countries.","schema":{"type":"string","description":"Comma separated string of country codes. This will limit the search to the specified countries."},"example":"FR"},{"name":"lat","in":"query","required":false,"description":"Latitude where results should be biased. NOTE: supplying a lat/lon without a radius will return search results biased to that point.","schema":{"type":"number","description":"Latitude where results should be biased. NOTE: supplying a lat/lon without a radius will return search results biased to that point."},"example":37.337},{"name":"lon","in":"query","required":false,"description":"Longitude where results should be biased NOTE: supplying a lat/lon without a radius will return search results biased to that point.","schema":{"type":"number","description":"Longitude where results should be biased NOTE: supplying a lat/lon without a radius will return search results biased to that point."},"example":-121.89},{"name":"radius","in":"query","required":false,"description":"If radius and position are set, the results will be constrained to the defined area. The radius parameter is specified in meters.","schema":{"type":"integer","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","in":"query","required":false,"description":"Top left position of the bounding box. This is specified as a comma separated string composed of lat., lon.","schema":{"type":"string","description":"Top left position of the bounding box. This is specified as a comma separated string composed of lat., lon."},"example":"37.553,-122.453"},{"name":"btmRight","in":"query","required":false,"description":"Bottom right position of the bounding box. This is specified as a comma separated string composed of lat., lon.","schema":{"type":"string","description":"Bottom right position of the bounding box. This is specified as a comma separated string composed of lat., lon."},"example":"37.4,-122.55"},{"name":"language","in":"query","required":false,"description":"Language in which search results should be returned. Should be one of supported IETF language tags , case insensitive.","schema":{"type":"string","description":"Language in which search results should be returned. Should be one of supported IETF language tags , case insensitive."}},{"name":"extendedPostalCodesFor","in":"query","required":false,"description":"Indexes for which extended postal codes should be included in the results. Available indexes are: - Addr = Address ranges - Geo =…","schema":{"type":"string","description":"Indexes for which extended postal codes should be included in the results. Available indexes are: - Addr = Address ranges - Geo =…"}},{"name":"view","in":"query","required":false,"description":"Geopolitical View.","schema":{"type":"string","enum":["Unified","IN","PK","IL","MA"],"default":"Unified","description":"Geopolitical View."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/places:tomtom-search/get-search-version-number-geocode-query-ext":{"get":{"operationId":"places_tomtom_search_get_search_version_number_geocode_query_ext","summary":"Geocode","description":"GET /search/{versionNumber}/geocode/{query}.{ext}","tags":["places"],"parameters":[{"name":"versionNumber","in":"query","required":true,"description":"Service version number. The current value is 2.","schema":{"type":"integer","enum":[2],"description":"Service version number. The current value is 2."}},{"name":"query","in":"query","required":true,"description":"Query string. Must be properly URL encoded.","schema":{"type":"string","description":"Query string. Must be properly URL encoded."},"example":"4 north 2nd street san jose"},{"name":"ext","in":"query","required":true,"description":"Expected response format.","schema":{"type":"string","enum":["json","jsonp","js","xml"],"description":"Expected response format."},"example":"xml"},{"name":"storeResult","in":"query","required":false,"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.","schema":{"type":"boolean","default":false,"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","in":"query","required":false,"description":"If the \"typeahead\" flag is set, the query will be interpreted as a partial input and the search will enter predictive mode.","schema":{"type":"boolean","default":false,"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","in":"query","required":false,"description":"Maximum number of search results that will be returned.","schema":{"type":"integer","default":10,"description":"Maximum number of search results that will be returned."}},{"name":"ofs","in":"query","required":false,"description":"Starting offset of the returned results within the full result set.","schema":{"type":"integer","default":0,"description":"Starting offset of the returned results within the full result set."}},{"name":"countrySet","in":"query","required":false,"description":"Comma separated string of country codes. This will limit the search to the specified countries.","schema":{"type":"string","description":"Comma separated string of country codes. This will limit the search to the specified countries."},"example":"FR"},{"name":"lat","in":"query","required":false,"description":"Latitude where results should be biased. NOTE: supplying a lat/lon without a radius will return search results biased to that point.","schema":{"type":"number","description":"Latitude where results should be biased. NOTE: supplying a lat/lon without a radius will return search results biased to that point."},"example":37.337},{"name":"lon","in":"query","required":false,"description":"Longitude where results should be biased NOTE: supplying a lat/lon without a radius will return search results biased to that point.","schema":{"type":"number","description":"Longitude where results should be biased NOTE: supplying a lat/lon without a radius will return search results biased to that point."},"example":-121.89},{"name":"radius","in":"query","required":false,"description":"If radius and position are set, the results will be constrained to the defined area. The radius parameter is specified in meters.","schema":{"type":"integer","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","in":"query","required":false,"description":"Top left position of the bounding box. This is specified as a comma separated string composed of lat., lon.","schema":{"type":"string","description":"Top left position of the bounding box. This is specified as a comma separated string composed of lat., lon."},"example":"37.553,-122.453"},{"name":"btmRight","in":"query","required":false,"description":"Bottom right position of the bounding box. This is specified as a comma separated string composed of lat., lon.","schema":{"type":"string","description":"Bottom right position of the bounding box. This is specified as a comma separated string composed of lat., lon."},"example":"37.4,-122.55"},{"name":"language","in":"query","required":false,"description":"Language in which search results should be returned. Should be one of supported IETF language tags , case insensitive.","schema":{"type":"string","description":"Language in which search results should be returned. Should be one of supported IETF language tags , case insensitive."}},{"name":"extendedPostalCodesFor","in":"query","required":false,"description":"Indexes for which extended postal codes should be included in the results. Available indexes are: - Addr = Address ranges - Geo =…","schema":{"type":"string","description":"Indexes for which extended postal codes should be included in the results. Available indexes are: - Addr = Address ranges - Geo =…"}},{"name":"view","in":"query","required":false,"description":"Geopolitical View.","schema":{"type":"string","enum":["Unified","IN","PK","IL","MA"],"default":"Unified","description":"Geopolitical View."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/places:tomtom-search/get-search-version-number-geometry-filter-ext":{"get":{"operationId":"places_tomtom_search_get_search_version_number_geometry_filter_ext","summary":"Geometry Filter","description":"GET /search/{versionNumber}/geometryFilter.{ext}","tags":["places"],"parameters":[{"name":"versionNumber","in":"query","required":true,"description":"Service version number. The current value is 2.","schema":{"type":"integer","enum":[2],"description":"Service version number. The current value is 2."}},{"name":"ext","in":"query","required":true,"description":"Expected response format.","schema":{"type":"string","enum":["json","jsonp","js","xml"],"description":"Expected response format."},"example":"xml"},{"name":"geometryList","in":"query","required":true,"description":"List of geometries to filter by. Available types are CIRCLE (with the radius expressed in meters) and POLYGON.","schema":{"type":"string","description":"List of geometries to filter by. Available types are CIRCLE (with the radius expressed in meters) and POLYGON."},"example":"[{\"type\":\"CIRCLE\", \"position\":\"40.80558, -73.96548\", \"radius\":100}, {\"type\":\"POLYGON\", \"vertices\":[\"37.7524152343544, -122.43576049804686\", \"37.70660472542312, -122.43301391601562\", \"37.712059855877314, -122.36434936523438\", \"37.75350561243041, -122.37396240234374\"]}]"},{"name":"poiList","in":"query","required":true,"description":"List of POIs to filter. The only required attribute of a POI is position, everything else is optional and will be echoed back when passed…","schema":{"type":"string","description":"List of POIs to filter. The only required attribute of a POI is position, everything else is optional and will be echoed back when passed…"},"example":"[{\"poi\":{\"name\":\"S Restaurant Toms\"},\"address\":{\"freeformAddress\":\"2880 Broadway, New York, NY 10025\"},\"position\":{\"lat\":40.80558,\"lon\":-73.96548}},{\"poi\":{\"name\":\"Yasha Raman Corporation\"},\"address\":{\"freeformAddress\":\"940 Amsterdam Ave, New York, NY 10025\"},\"position\":{\"lat\":40.80076,\"lon\":-73.96556}}]"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/places:tomtom-search/post-search-version-number-geometry-filter-ext":{"post":{"operationId":"places_tomtom_search_post_search_version_number_geometry_filter_ext","summary":"Geometry Filter","description":"POST /search/{versionNumber}/geometryFilter.{ext}","tags":["places"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["versionNumber","ext"],"properties":{"versionNumber":{"type":"integer","enum":[2],"description":"Service version number. The current value is 2."},"ext":{"type":"string","enum":["json","jsonp","js","xml"],"description":"Expected response format."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/places:tomtom-search/get-search-version-number-geometry-search-query-ext":{"get":{"operationId":"places_tomtom_search_get_search_version_number_geometry_search_query_ext","summary":"Geometry Search","description":"GET /search/{versionNumber}/geometrySearch/{query}.{ext}","tags":["places"],"parameters":[{"name":"versionNumber","in":"query","required":true,"description":"Service version number. The current value is 2.","schema":{"type":"integer","enum":[2],"description":"Service version number. The current value is 2."}},{"name":"query","in":"query","required":true,"description":"Query string. Must be properly URL encoded.","schema":{"type":"string","description":"Query string. Must be properly URL encoded."},"example":"pizza"},{"name":"ext","in":"query","required":true,"description":"Expected response format.","schema":{"type":"string","enum":["json","jsonp","js","xml"],"description":"Expected response format."},"example":"xml"},{"name":"geometryList","in":"query","required":false,"description":"List of geometries to filter by. Available types are CIRCLE (with the radius expressed in meters) and POLYGON.","schema":{"type":"string","description":"List of geometries to filter by. Available types are CIRCLE (with the radius expressed in meters) and POLYGON."},"example":"[{\"type\":\"POLYGON\", \"vertices\":[\"37.7524152343544, -122.43576049804686\", \"37.70660472542312, -122.43301391601562\", \"37.712059855877314, -122.36434936523438\", \"37.75350561243041, -122.37396240234374\"]}, {\"type\":\"CIRCLE\", \"position\":\"37.71205, -121.36434\", \"radius\":6000}, {\"type\":\"CIRCLE\", \"position\":\"37.31205, -121.36434\", \"radius\":1000}]"},{"name":"limit","in":"query","required":false,"description":"Maximum number of search results that will be returned.","schema":{"type":"integer","default":10,"description":"Maximum number of search results that will be returned."}},{"name":"language","in":"query","required":false,"description":"Language in which search results should be returned. Should be one of supported IETF language tags , case insensitive.","schema":{"type":"string","description":"Language in which search results should be returned. Should be one of supported IETF language tags , case insensitive."}},{"name":"extendedPostalCodesFor","in":"query","required":false,"description":"Indexes for which extended postal codes should be included in the results. Available indexes are: - Addr = Address ranges - Geo =…","schema":{"type":"string","description":"Indexes for which extended postal codes should be included in the results. Available indexes are: - Addr = Address ranges - Geo =…"}},{"name":"idxSet","in":"query","required":false,"description":"A comma separated list of indexes which should be utilized for the search. Item order does not matter. Available indexes are: - Addr =…","schema":{"type":"string","description":"A comma separated list of indexes which should be utilized for the search. Item order does not matter. Available indexes are: - Addr =…"},"example":"POI"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/places:tomtom-search/post-search-version-number-geometry-search-query-ext":{"post":{"operationId":"places_tomtom_search_post_search_version_number_geometry_search_query_ext","summary":"Geometry Search","description":"POST /search/{versionNumber}/geometrySearch/{query}.{ext}","tags":["places"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["versionNumber","query","ext"],"properties":{"versionNumber":{"type":"integer","enum":[2],"description":"Service version number. The current value is 2."},"query":{"type":"string","description":"Query string. Must be properly URL encoded."},"ext":{"type":"string","enum":["json","jsonp","js","xml"],"description":"Expected response format."},"limit":{"type":"integer","default":10,"description":"Maximum number of search results that will be returned."},"language":{"type":"string","description":"Language in which search results should be returned. Should be one of supported IETF language tags , case insensitive."},"extendedPostalCodesFor":{"type":"string","description":"Indexes for which extended postal codes should be included in the results. Available indexes are: - Addr = Address ranges - Geo =…"},"idxSet":{"type":"string","description":"A comma separated list of indexes which should be utilized for the search. Item order does not matter. Available indexes are: - Addr =…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/places:tomtom-search/get-search-version-number-nearby-search-ext":{"get":{"operationId":"places_tomtom_search_get_search_version_number_nearby_search_ext","summary":"Nearby Search","description":"GET /search/{versionNumber}/nearbySearch/.{ext}","tags":["places"],"parameters":[{"name":"versionNumber","in":"query","required":true,"description":"Service version number. The current value is 2.","schema":{"type":"integer","enum":[2],"description":"Service version number. The current value is 2."}},{"name":"ext","in":"query","required":true,"description":"Expected response format.","schema":{"type":"string","enum":["json","jsonp","js","xml"],"description":"Expected response format."},"example":"xml"},{"name":"lat","in":"query","required":true,"description":"Latitude where results should be biased. NOTE: supplying a lat/lon without a radius will return search results biased to that point.","schema":{"type":"number","description":"Latitude where results should be biased. NOTE: supplying a lat/lon without a radius will return search results biased to that point."},"example":37.337},{"name":"lon","in":"query","required":true,"description":"Longitude where results should be biased NOTE: supplying a lat/lon without a radius will return search results biased to that point.","schema":{"type":"number","description":"Longitude where results should be biased NOTE: supplying a lat/lon without a radius will return search results biased to that point."},"example":-121.89},{"name":"limit","in":"query","required":false,"description":"Maximum number of search results that will be returned.","schema":{"type":"integer","default":10,"description":"Maximum number of search results that will be returned."}},{"name":"ofs","in":"query","required":false,"description":"Starting offset of the returned results within the full result set.","schema":{"type":"integer","default":0,"description":"Starting offset of the returned results within the full result set."}},{"name":"countrySet","in":"query","required":false,"description":"Comma separated string of country codes. This will limit the search to the specified countries.","schema":{"type":"string","description":"Comma separated string of country codes. This will limit the search to the specified countries."},"example":"FR"},{"name":"radius","in":"query","required":false,"description":"If radius and position are set, the results will be constrained to the defined area. The radius parameter is specified in meters.","schema":{"type":"integer","default":10000,"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","in":"query","required":false,"description":"Top left position of the bounding box. This is specified as a comma separated string composed of lat., lon.","schema":{"type":"string","description":"Top left position of the bounding box. This is specified as a comma separated string composed of lat., lon."},"example":"37.553,-122.453"},{"name":"btmRight","in":"query","required":false,"description":"Bottom right position of the bounding box. This is specified as a comma separated string composed of lat., lon.","schema":{"type":"string","description":"Bottom right position of the bounding box. This is specified as a comma separated string composed of lat., lon."},"example":"37.4,-122.55"},{"name":"language","in":"query","required":false,"description":"Language in which search results should be returned. Should be one of supported IETF language tags , case insensitive.","schema":{"type":"string","description":"Language in which search results should be returned. Should be one of supported IETF language tags , case insensitive."}},{"name":"extendedPostalCodesFor","in":"query","required":false,"description":"Indexes for which extended postal codes should be included in the results. Available indexes are: - Addr = Address ranges - Geo =…","schema":{"type":"string","description":"Indexes for which extended postal codes should be included in the results. Available indexes are: - Addr = Address ranges - Geo =…"}},{"name":"minFuzzyLevel","in":"query","required":false,"description":"Minimum fuzziness level to be used.","schema":{"type":"integer","default":1,"description":"Minimum fuzziness level to be used."}},{"name":"maxFuzzyLevel","in":"query","required":false,"description":"Maximum fuzziness level to be used.","schema":{"type":"integer","default":2,"description":"Maximum fuzziness level to be used."}},{"name":"idxSet","in":"query","required":false,"description":"A comma separated list of indexes which should be utilized for the search. Item order does not matter. Available indexes are: - Addr =…","schema":{"type":"string","description":"A comma separated list of indexes which should be utilized for the search. Item order does not matter. Available indexes are: - Addr =…"},"example":"POI"},{"name":"view","in":"query","required":false,"description":"Geopolitical View.","schema":{"type":"string","enum":["Unified","IN","PK","IL","MA"],"default":"Unified","description":"Geopolitical View."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/places:tomtom-search/get-search-version-number-poi-search-query-ext":{"get":{"operationId":"places_tomtom_search_get_search_version_number_poi_search_query_ext","summary":"Points of Interest Search","description":"GET /search/{versionNumber}/poiSearch/{query}.{ext}","tags":["places"],"parameters":[{"name":"versionNumber","in":"query","required":true,"description":"Service version number. The current value is 2.","schema":{"type":"integer","enum":[2],"description":"Service version number. The current value is 2."}},{"name":"query","in":"query","required":true,"description":"Query string. Must be properly URL encoded.","schema":{"type":"string","description":"Query string. Must be properly URL encoded."},"example":"pizza"},{"name":"ext","in":"query","required":true,"description":"Expected response format.","schema":{"type":"string","enum":["json","jsonp","js","xml"],"description":"Expected response format."},"example":"xml"},{"name":"typeahead","in":"query","required":false,"description":"If the \"typeahead\" flag is set, the query will be interpreted as a partial input and the search will enter predictive mode.","schema":{"type":"boolean","default":false,"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","in":"query","required":false,"description":"Maximum number of search results that will be returned.","schema":{"type":"integer","default":10,"description":"Maximum number of search results that will be returned."}},{"name":"ofs","in":"query","required":false,"description":"Starting offset of the returned results within the full result set.","schema":{"type":"integer","default":0,"description":"Starting offset of the returned results within the full result set."}},{"name":"countrySet","in":"query","required":false,"description":"Comma separated string of country codes. This will limit the search to the specified countries.","schema":{"type":"string","description":"Comma separated string of country codes. This will limit the search to the specified countries."},"example":"FR"},{"name":"lat","in":"query","required":false,"description":"Latitude where results should be biased. NOTE: supplying a lat/lon without a radius will return search results biased to that point.","schema":{"type":"number","description":"Latitude where results should be biased. NOTE: supplying a lat/lon without a radius will return search results biased to that point."},"example":37.337},{"name":"lon","in":"query","required":false,"description":"Longitude where results should be biased NOTE: supplying a lat/lon without a radius will return search results biased to that point.","schema":{"type":"number","description":"Longitude where results should be biased NOTE: supplying a lat/lon without a radius will return search results biased to that point."},"example":-121.89},{"name":"radius","in":"query","required":false,"description":"If radius and position are set, the results will be constrained to the defined area. The radius parameter is specified in meters.","schema":{"type":"integer","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","in":"query","required":false,"description":"Top left position of the bounding box. This is specified as a comma separated string composed of lat., lon.","schema":{"type":"string","description":"Top left position of the bounding box. This is specified as a comma separated string composed of lat., lon."},"example":"37.553,-122.453"},{"name":"btmRight","in":"query","required":false,"description":"Bottom right position of the bounding box. This is specified as a comma separated string composed of lat., lon.","schema":{"type":"string","description":"Bottom right position of the bounding box. This is specified as a comma separated string composed of lat., lon."},"example":"37.4,-122.55"},{"name":"language","in":"query","required":false,"description":"Language in which search results should be returned. Should be one of supported IETF language tags , case insensitive.","schema":{"type":"string","description":"Language in which search results should be returned. Should be one of supported IETF language tags , case insensitive."}},{"name":"extendedPostalCodesFor","in":"query","required":false,"description":"Indexes for which extended postal codes should be included in the results. Available indexes are: - Addr = Address ranges - Geo =…","schema":{"type":"string","description":"Indexes for which extended postal codes should be included in the results. Available indexes are: - Addr = Address ranges - Geo =…"}},{"name":"view","in":"query","required":false,"description":"Geopolitical View.","schema":{"type":"string","enum":["Unified","IN","PK","IL","MA"],"default":"Unified","description":"Geopolitical View."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/places:tomtom-search/get-search-version-number-reverse-geocode-cross-street-posit":{"get":{"operationId":"places_tomtom_search_get_search_version_number_reverse_geocode_cross_street_posit","summary":"Cross Street lookup","description":"GET /search/{versionNumber}/reverseGeocode/crossStreet/{position}.{ext}","tags":["places"],"parameters":[{"name":"versionNumber","in":"query","required":true,"description":"Service version number. The current value is 2.","schema":{"type":"integer","enum":[2],"description":"Service version number. The current value is 2."}},{"name":"position","in":"query","required":true,"description":"This is specified as a comma separated string composed of lat., lon.","schema":{"type":"string","description":"This is specified as a comma separated string composed of lat., lon."},"example":"37.8328,-122.27669"},{"name":"ext","in":"query","required":true,"description":"Expected response format.","schema":{"type":"string","enum":["json","jsonp","js","xml"],"description":"Expected response format."},"example":"xml"},{"name":"limit","in":"query","required":false,"description":"Maximum number of cross-streets to return.","schema":{"type":"integer","default":1,"description":"Maximum number of cross-streets to return."}},{"name":"spatialKeys","in":"query","required":false,"description":"If the \"spatialKeys\" flag is set, the response will also contain a proprietary geospatial keys for a specified location.","schema":{"type":"boolean","default":false,"description":"If the \"spatialKeys\" flag is set, the response will also contain a proprietary geospatial keys for a specified location."}},{"name":"heading","in":"query","required":false,"description":"The directional heading in degrees, usually similar to the course along a road segment. Entered in degrees, measured clockwise from north…","schema":{"type":"number","description":"The directional heading in degrees, usually similar to the course along a road segment. Entered in degrees, measured clockwise from north…"}},{"name":"radius","in":"query","required":false,"description":"The maximum distance in meters from the specified position for the reverse geocoder to consider.","schema":{"type":"integer","default":10000,"description":"The maximum distance in meters from the specified position for the reverse geocoder to consider."}},{"name":"language","in":"query","required":false,"description":"Language in which search results should be returned. Should be one of supported IETF language tags , case insensitive.","schema":{"type":"string","description":"Language in which search results should be returned. Should be one of supported IETF language tags , case insensitive."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/places:tomtom-search/get-search-version-number-reverse-geocode-position-ext":{"get":{"operationId":"places_tomtom_search_get_search_version_number_reverse_geocode_position_ext","summary":"Reverse Geocode","description":"GET /search/{versionNumber}/reverseGeocode/{position}.{ext}","tags":["places"],"parameters":[{"name":"versionNumber","in":"query","required":true,"description":"Service version number. The current value is 2.","schema":{"type":"integer","enum":[2],"description":"Service version number. The current value is 2."}},{"name":"position","in":"query","required":true,"description":"This is specified as a comma separated string composed of lat., lon.","schema":{"type":"string","description":"This is specified as a comma separated string composed of lat., lon."},"example":"37.8328,-122.27669"},{"name":"ext","in":"query","required":true,"description":"Expected response format.","schema":{"type":"string","enum":["json","jsonp","js","xml"],"description":"Expected response format."},"example":"xml"},{"name":"spatialKeys","in":"query","required":false,"description":"If the \"spatialKeys\" flag is set, the response will also contain a proprietary geospatial keys for a specified location.","schema":{"type":"boolean","default":false,"description":"If the \"spatialKeys\" flag is set, the response will also contain a proprietary geospatial keys for a specified location."}},{"name":"returnSpeedLimit","in":"query","required":false,"description":"To enable return of the posted speed limit (where available).","schema":{"type":"boolean","default":false,"description":"To enable return of the posted speed limit (where available)."}},{"name":"heading","in":"query","required":false,"description":"The directional heading in degrees, usually similar to the course along a road segment. Entered in degrees, measured clockwise from north…","schema":{"type":"number","description":"The directional heading in degrees, usually similar to the course along a road segment. Entered in degrees, measured clockwise from north…"}},{"name":"radius","in":"query","required":false,"description":"The maximum distance in meters from the specified position for the reverse geocoder to consider.","schema":{"type":"integer","default":10000,"description":"The maximum distance in meters from the specified position for the reverse geocoder to consider."}},{"name":"number","in":"query","required":false,"description":"If a number is sent in along with the request, the response may include the side of the street (Left/Right) and an offset position for…","schema":{"type":"string","description":"If a number is sent in along with the request, the response may include the side of the street (Left/Right) and an offset position for…"}},{"name":"returnRoadUse","in":"query","required":false,"description":"Enables return of the road use array for reverse geocodes at street level.","schema":{"type":"boolean","default":false,"description":"Enables return of the road use array for reverse geocodes at street level."}},{"name":"roadUse","in":"query","required":false,"description":"Restricts reverse geocodes to a certain type of road use. The road use array for reverse geocodes can be one or more of: [\"LimitedAccess\",…","schema":{"type":"string","description":"Restricts reverse geocodes to a certain type of road use. The road use array for reverse geocodes can be one or more of: [\"LimitedAccess\",…"}},{"name":"callback","in":"query","required":false,"description":"Specifies the jsonp callback method.","schema":{"type":"string","default":"cb","description":"Specifies the jsonp callback method."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/places:tomtom-search/get-search-version-number-search-query-ext":{"get":{"operationId":"places_tomtom_search_get_search_version_number_search_query_ext","summary":"Fuzzy Search","description":"GET /search/{versionNumber}/search/{query}.{ext}","tags":["places"],"parameters":[{"name":"versionNumber","in":"query","required":true,"description":"Service version number. The current value is 2.","schema":{"type":"integer","enum":[2],"description":"Service version number. The current value is 2."}},{"name":"query","in":"query","required":true,"description":"Query string. Must be properly URL encoded. To perform a reverse geocode, the user can provide latitude and longitude coordinates directly…","schema":{"type":"string","description":"Query string. Must be properly URL encoded. To perform a reverse geocode, the user can provide latitude and longitude coordinates directly…"},"example":"pizza"},{"name":"ext","in":"query","required":true,"description":"Expected response format.","schema":{"type":"string","enum":["json","jsonp","js","xml"],"description":"Expected response format."},"example":"xml"},{"name":"typeahead","in":"query","required":false,"description":"If the \"typeahead\" flag is set, the query will be interpreted as a partial input and the search will enter predictive mode.","schema":{"type":"boolean","default":false,"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","in":"query","required":false,"description":"Maximum number of search results that will be returned.","schema":{"type":"integer","default":10,"description":"Maximum number of search results that will be returned."}},{"name":"ofs","in":"query","required":false,"description":"Starting offset of the returned results within the full result set.","schema":{"type":"integer","default":0,"description":"Starting offset of the returned results within the full result set."}},{"name":"countrySet","in":"query","required":false,"description":"Comma separated string of country codes. This will limit the search to the specified countries.","schema":{"type":"string","description":"Comma separated string of country codes. This will limit the search to the specified countries."},"example":"FR"},{"name":"lat","in":"query","required":false,"description":"Latitude where results should be biased. NOTE: supplying a lat/lon without a radius will return search results biased to that point.","schema":{"type":"number","description":"Latitude where results should be biased. NOTE: supplying a lat/lon without a radius will return search results biased to that point."},"example":37.337},{"name":"lon","in":"query","required":false,"description":"Longitude where results should be biased NOTE: supplying a lat/lon without a radius will return search results biased to that point.","schema":{"type":"number","description":"Longitude where results should be biased NOTE: supplying a lat/lon without a radius will return search results biased to that point."},"example":-121.89},{"name":"radius","in":"query","required":false,"description":"If radius and position are set, the results will be constrained to the defined area. The radius parameter is specified in meters.","schema":{"type":"integer","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","in":"query","required":false,"description":"Top left position of the bounding box. This is specified as a comma separated string composed of lat., lon.","schema":{"type":"string","description":"Top left position of the bounding box. This is specified as a comma separated string composed of lat., lon."},"example":"37.553,-122.453"},{"name":"btmRight","in":"query","required":false,"description":"Bottom right position of the bounding box. This is specified as a comma separated string composed of lat., lon.","schema":{"type":"string","description":"Bottom right position of the bounding box. This is specified as a comma separated string composed of lat., lon."},"example":"37.4,-122.55"},{"name":"language","in":"query","required":false,"description":"Language in which search results should be returned. Should be one of supported IETF language tags , case insensitive.","schema":{"type":"string","description":"Language in which search results should be returned. Should be one of supported IETF language tags , case insensitive."}},{"name":"extendedPostalCodesFor","in":"query","required":false,"description":"Indexes for which extended postal codes should be included in the results. Available indexes are: - Addr = Address ranges - Geo =…","schema":{"type":"string","description":"Indexes for which extended postal codes should be included in the results. Available indexes are: - Addr = Address ranges - Geo =…"}},{"name":"minFuzzyLevel","in":"query","required":false,"description":"Minimum fuzziness level to be used.","schema":{"type":"integer","default":1,"description":"Minimum fuzziness level to be used."}},{"name":"maxFuzzyLevel","in":"query","required":false,"description":"Maximum fuzziness level to be used.","schema":{"type":"integer","default":2,"description":"Maximum fuzziness level to be used."}},{"name":"idxSet","in":"query","required":false,"description":"A comma separated list of indexes which should be utilized for the search. Item order does not matter. Available indexes are: - Addr =…","schema":{"type":"string","description":"A comma separated list of indexes which should be utilized for the search. Item order does not matter. Available indexes are: - Addr =…"},"example":"POI"},{"name":"view","in":"query","required":false,"description":"Geopolitical View.","schema":{"type":"string","enum":["Unified","IN","PK","IL","MA"],"default":"Unified","description":"Geopolitical View."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/places:tomtom-search/post-search-version-number-search-along-route-query-ext":{"post":{"operationId":"places_tomtom_search_post_search_version_number_search_along_route_query_ext","summary":"Along Route Search","description":"POST /search/{versionNumber}/searchAlongRoute/{query}.{ext}","tags":["places"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["versionNumber","query","ext","maxDetourTime"],"properties":{"versionNumber":{"type":"integer","enum":[2],"description":"Service version number. The current value is 2."},"query":{"type":"string","description":"Query string. Must be properly URL encoded."},"ext":{"type":"string","enum":["json","jsonp","js","xml"],"description":"Expected response format."},"maxDetourTime":{"type":"integer","description":"Maximum detour time"},"limit":{"type":"integer","default":10,"description":"Maximum number of search results that will be returned."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/places:tomtom-search/get-search-version-number-structured-geocode-ext":{"get":{"operationId":"places_tomtom_search_get_search_version_number_structured_geocode_ext","summary":"Structured Geocode","description":"GET /search/{versionNumber}/structuredGeocode.{ext}","tags":["places"],"parameters":[{"name":"versionNumber","in":"query","required":true,"description":"Service version number. The current value is 2.","schema":{"type":"integer","enum":[2],"description":"Service version number. The current value is 2."}},{"name":"ext","in":"query","required":true,"description":"Expected response format.","schema":{"type":"string","enum":["json","jsonp","js","xml"],"description":"Expected response format."},"example":"xml"},{"name":"countryCode","in":"query","required":true,"description":"2 or 3 letter country code (e.g.: FR, ES).","schema":{"type":"string","description":"2 or 3 letter country code (e.g.: FR, ES)."},"example":"NL"},{"name":"limit","in":"query","required":false,"description":"Maximum number of search results that will be returned.","schema":{"type":"integer","default":10,"description":"Maximum number of search results that will be returned."}},{"name":"ofs","in":"query","required":false,"description":"Starting offset of the returned results within the full result set.","schema":{"type":"integer","default":0,"description":"Starting offset of the returned results within the full result set."}},{"name":"streetNumber","in":"query","required":false,"description":"The street number for the structured address.","schema":{"type":"string","description":"The street number for the structured address."}},{"name":"streetName","in":"query","required":false,"description":"The street name for the structured address.","schema":{"type":"string","description":"The street name for the structured address."}},{"name":"crossStreet","in":"query","required":false,"description":"The cross street name for the structured address.","schema":{"type":"string","description":"The cross street name for the structured address."}},{"name":"municipality","in":"query","required":false,"description":"The municipality (city/town) for the structured address.","schema":{"type":"string","description":"The municipality (city/town) for the structured address."},"example":"Amsterdam"},{"name":"municipalitySubdivision","in":"query","required":false,"description":"The municipality subdivision (sub/super city) for the structured address.","schema":{"type":"string","description":"The municipality subdivision (sub/super city) for the structured address."}},{"name":"countryTertiarySubdivision","in":"query","required":false,"description":"The named area for the structured address.","schema":{"type":"string","description":"The named area for the structured address."}},{"name":"countrySecondarySubdivision","in":"query","required":false,"description":"The county for the structured address.","schema":{"type":"string","description":"The county for the structured address."}},{"name":"countrySubdivision","in":"query","required":false,"description":"The state or province for the structured address.","schema":{"type":"string","description":"The state or province for the structured address."}},{"name":"postalCode","in":"query","required":false,"description":"The zip code or postal code for the structured address.","schema":{"type":"string","description":"The zip code or postal code for the structured address."}},{"name":"language","in":"query","required":false,"description":"Language in which search results should be returned. Should be one of supported IETF language tags , case insensitive.","schema":{"type":"string","description":"Language in which search results should be returned. Should be one of supported IETF language tags , case insensitive."}},{"name":"extendedPostalCodesFor","in":"query","required":false,"description":"Indexes for which extended postal codes should be included in the results. Available indexes are: - Addr = Address ranges - Geo =…","schema":{"type":"string","description":"Indexes for which extended postal codes should be included in the results. Available indexes are: - Addr = Address ranges - Geo =…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}}},"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"x-api-key"}},"schemas":{"RunEnvelope":{"type":"object","required":["project","data","timestamp"],"properties":{"project":{"type":"string","example":"dev-tools:hash"},"data":{},"timestamp":{"type":"string","format":"date-time"}}},"ErrorEnvelope":{"type":"object","properties":{"content":{},"message":{"type":"string"},"errors":{"type":"array","items":{}},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}}}}}},"responses":{"Error":{"description":"Invalid key, plan gate, rate limit or upstream failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}}}}