Tomtom

Search

Search API is a RESTful API that allows developers to run a single line fuzzy search for addresses and POIs. Search API returns the latitude/longitude of a…

Maps & location#openapi#location

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

Search API is a RESTful API that allows developers to run a single line fuzzy search for addresses and POIs. Search API returns the latitude/longitude of a specific address, cross street, geographic feature, or point of interest (POI).

Endpoints 19

Additional Data

  • GETAdditional Data/search/:versionNumber/additionalData.:ext?geometries=00004631-3400-3c00-0000-0000673c4d2e,00004631-3400-3c00-0000-0000673c42fe&geometriesZoom=0

Search

  • GETLow Bandwith Category Search/search/:versionNumber/cS/:category.:ext?typeahead=false&limit=10&ofs=0&countrySet=FR&lat=37.337&lon=-121.89&radius=0&topLeft=37.553,-122.453&btmRight=37.4,-122.55&language=string&idxSet=POI&view=UnifiedDeprecated.
  • GETCategory Search/search/:versionNumber/categorySearch/:query.:ext?typeahead=false&limit=10&ofs=0&countrySet=FR&lat=37.337&lon=-121.89&radius=0&topLeft=37.553,-122.453&btmRight=37.4,-122.55&language=string&extendedPostalCodesFor=string&view=Unified
  • GETGeometry Search/search/:versionNumber/geometrySearch/:query.:ext?geometryList=[{"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}]&limit=10&language=string&extendedPostalCodesFor=string&idxSet=POI
  • POSTGeometry Search/search/:versionNumber/geometrySearch/:query.:ext?limit=10&language=string&extendedPostalCodesFor=string&idxSet=POI
  • GETNearby Search/search/:versionNumber/nearbySearch/.:ext?lat=37.337&lon=-121.89&limit=10&ofs=0&countrySet=FR&radius=10000&topLeft=37.553,-122.453&btmRight=37.4,-122.55&language=string&extendedPostalCodesFor=string&minFuzzyLevel=1&maxFuzzyLevel=2&idxSet=POI&view=Unified
  • GETPoints of Interest Search/search/:versionNumber/poiSearch/:query.:ext?typeahead=false&limit=10&ofs=0&countrySet=FR&lat=37.337&lon=-121.89&radius=0&topLeft=37.553,-122.453&btmRight=37.4,-122.55&language=string&extendedPostalCodesFor=string&view=Unified
  • GETRouted Search/search/:versionNumber/routedSearch/:query/:position/:heading.:ext?typeahead=false&limit=10&multiplier=2&routingTimeout=4000&language=string&extendedPostalCodesFor=string&idxSet=POIDeprecated.
  • GETLow bandwith Search/search/:versionNumber/s/:query.:ext?typeahead=false&limit=10&ofs=0&countrySet=FR&lat=37.337&lon=-121.89&radius=0&topLeft=37.553,-122.453&btmRight=37.4,-122.55&language=string&idxSet=POI&view=UnifiedDeprecated.
  • GETFuzzy Search/search/:versionNumber/search/:query.:ext?typeahead=false&limit=10&ofs=0&countrySet=FR&lat=37.337&lon=-121.89&radius=0&topLeft=37.553,-122.453&btmRight=37.4,-122.55&language=string&extendedPostalCodesFor=string&minFuzzyLevel=1&maxFuzzyLevel=2&idxSet=POI&view=Unified
  • POSTAlong Route Search/search/:versionNumber/searchAlongRoute/:query.:ext?maxDetourTime=1200&limit=10

Geocoding

  • GETGeocode/search/:versionNumber/geocode/:query.:ext?storeResult=false&typeahead=false&limit=10&ofs=0&countrySet=FR&lat=37.337&lon=-121.89&radius=0&topLeft=37.553,-122.453&btmRight=37.4,-122.55&language=string&extendedPostalCodesFor=string&view=Unified
  • GETStructured Geocode/search/:versionNumber/structuredGeocode.:ext?countryCode=NL&limit=10&ofs=0&streetNumber=string&streetName=string&crossStreet=string&municipality=Amsterdam&municipalitySubdivision=string&countryTertiarySubdivision=string&countrySecondarySubdivision=string&countrySubdivision=string&postalCode=string&language=string&extendedPostalCodesFor=string

Filters

  • GETGeometry Filter/search/:versionNumber/geometryFilter.:ext?geometryList=[{"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"]}]&poiList=[{"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}}]
  • POSTGeometry Filter/search/:versionNumber/geometryFilter.:ext
  • GETRouted Filter/search/:versionNumber/routedFilter/:position/:heading.:ext?poiList=[{"poi":{"name":"Cleaire Advanced Emission Controls"},"address":{"freeformAddress":"7220 Trade St, San Diego, CA 92121"},"position":{"lat":"37.83274","lon":"-122.27631"}}]&routingTimeout=4000Deprecated.
  • POSTRouted Filter/search/:versionNumber/routedFilter/:position/:heading.:ext?routingTimeout=4000Deprecated.

Reverse Geocoding

  • GETCross Street lookup/search/:versionNumber/reverseGeocode/crossStreet/:position.:ext?limit=1&spatialKeys=false&heading=0.0&radius=10000&language=string
  • GETReverse Geocode/search/:versionNumber/reverseGeocode/:position.:ext?spatialKeys=false&returnSpeedLimit=false&heading=0.0&radius=10000&number=string&returnRoadUse=false&roadUse=string&callback=cb

API details

Base URL
https://api.tomtom.com
Authentication
An API key in the key query parameter
Operations
19 operations on 16 pathsGET 15POST 4
5 marked deprecated
Main resources
Search 10Filters 4Geocoding 2Reverse Geocoding 2Additional Data 1
Description format
OpenAPI 3.0.0, API version 1.0.0
Listed from
APIs.guru OpenAPI Directory (CC0-1.0)
Source updated

How to test the Search in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Search collection, without the publisher's secrets.
  3. Add your credentialsThis API uses an API key in the key query parameter. Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Additional Data” (GET /search/:versionNumber/additionalData.:ext?geometries=00004631-3400-3c00-0000-0000673c4d2e,00004631-3400-3c00-0000-0000673c42fe&geometriesZoom=0), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Search?

Search API is a RESTful API that allows developers to run a single line fuzzy search for addresses and POIs. Search API returns the latitude/longitude of a… It is listed under Maps & location and has 19 endpoints.

Who publishes the Search?

It is listed from Tomtom's public API description (an OpenAPI document), not published by Tomtom on Swastik Codes. Anyone who controls tomtom.com can claim the profile by adding a DNS TXT record.

What is the base URL of the Search?

Requests go to https://api.tomtom.com. Endpoint paths are added to this base URL.

How do I authenticate with the Search?

With an API key in the key query parameter.

How many endpoints does the Search have?

19 operations on 16 paths (15 GET, 4 POST). The largest groups are Search, Filters, Geocoding, Reverse Geocoding.

Is forking the Search free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.