### Get Storage Credentials URL Example Source: https://docs.tomtom.com/global-entity-matcher/api-pdg-get-credentials An example URL demonstrating how to request temporary credentials for a specific storage ID. ```text https://api.tomtom.com/maps/orbis/platform/private-gateway/storages/storage-001/credentials?type=READ_WRITE ``` -------------------------------- ### Get Storage Details URL Example Source: https://docs.tomtom.com/global-entity-matcher/api-pdg-get-storage An example URL for fetching storage details, using 'storage-001' as the identifier. ```text https://api.tomtom.com/maps/orbis/platform/private-gateway/storages/storage-001 ``` -------------------------------- ### Get Job Details URL Example Source: https://docs.tomtom.com/global-entity-matcher/api-gem-get-job An example URL for fetching job details, demonstrating the structure with a sample `job_id`. ```text https://api.tomtom.com/maps/orbis/platform/gem/jobs/123456789 ``` -------------------------------- ### GET URL Request Example Source: https://docs.tomtom.com/snap-to-roads-api/documentation/snap-to-roads-api/asynchronous-snap-to-roads-status An example of a GET request URL to check the status of a specific batch job. Ensure you replace {Your_API_Key} with your actual API key. ```http https://api.tomtom.com/snapToRoads/batch/1/b4086eb3-dead-beef-afbf-cc521fe1d9d8/status?key={Your_API_Key} ``` -------------------------------- ### O/D Analysis Flow Matrix Example Request Source: https://docs.tomtom.com/od-analysis/documentation/analysis/flow-matrix-analysis/analysis-preview This is a concrete example of a GET request to preview the origin-destination analysis flow matrix. Ensure you replace {Your_API_Key} with your valid API key. ```http https://api.tomtom.com/origindestination/1/analysis/flowmatrix/512?key={Your_API_Key} ``` -------------------------------- ### Example Request for Analysis List Source: https://docs.tomtom.com/od-analysis/documentation/analysis/analysis-list An example of a GET request to the analysis list endpoint. This specific example requests the first page with 15 analyses per page. ```http https://api.tomtom.com/origindestination/1/analysis?page=1&limit=15&key={Your_API_Key} ``` -------------------------------- ### Get Parking Locations URL Example Source: https://docs.tomtom.com/on-street-parking-api/documentation/parking-locations/parking-locations An example of a complete URL to request parking locations, including specific parameters for point, radius, and fields. ```http https://api.tomtom.com/parking/services/1/locations?key={Your_API_Key}&point=-33.872809993512945,151.20807219091648&radius=100&targetTime=2022-01-01T00:00:01Z&fields=probability&maxLocations=150&selectionType=probability ``` -------------------------------- ### Get Storage Details Response Example Source: https://docs.tomtom.com/global-entity-matcher/api-pdg-get-storage Example JSON response when successfully retrieving storage details. It includes the storage ID, URL, and type. ```json { "id": "storage-001", "url": "https://storage-001.blob.core.windows.net/default/", "type": "AZURE_BLOB_STORAGE" } ``` -------------------------------- ### Example URL Request for Archive Structure Source: https://docs.tomtom.com/geofencing-api/documentation/archive-service/archive-structure This is a concrete example of a URL request to get an archive of transitions. It shows the structure with actual domain and version. ```http https://api.tomtom.com/geofencing/1/archive/structure?key={Your_API_Key}&adminKey={Your_Admin_Key} ``` -------------------------------- ### Snap to Road URL Request Example (All Possible Data) Source: https://docs.tomtom.com/snap-to-roads-api/documentation/snap-to-roads-api/synchronous-snap-to-roads Example GET request to retrieve all possible data from the Snap to Road API. This includes detailed route information, projected points, and distances. ```http https://api.tomtom.com/snapToRoads/1?key={Your_API_Key}&points=4.6104919036936565,52.37576529649988;4.614096792595859,52.38341473290629&headings=0;0×tamps=2021-01-01T00:00:00Z;2021-01-01T00:01:00Z&fields={projectedPoints{type,geometry{type,coordinates},properties{routeIndex,snapResult}},route{type,geometry{type,coordinates},properties{id,linearReference,speedLimits{value,unit,type},speedProfile{value,unit},address{roadName,roadNumbers,municipality,countryName,countryCode,countrySubdivision},maximumDimensions{height{value,unit},length{value,unit},width{value,unit},totalWeight{value,unit},weightPerAxle{value,unit}},traveledDistance{value,unit},privateRoad,partOfTunnel,urbanArea,elementType,frc,formOfWay,roadUse,laneInfo{numberOfLanes},heightInfo{height,chainage,unit},trafficSigns{signType,chainage,unit},trafficLight,confidence,emissionRegulations{restrictionType,emissionClass,engineType}}},distances{total,ferry,publicRoad,privateRoad,road,offRoad,unit}}&vehicleType=PassengerCar&measurementSystem=auto&offroadMargin=50 ``` -------------------------------- ### curl Command Request Example Source: https://docs.tomtom.com/snap-to-roads-api/documentation/snap-to-roads-api/asynchronous-snap-to-roads-status This example shows how to make a GET request using curl to check the status of an asynchronous Snap to Roads job. Remember to replace {Your_API_Key} with your valid API key. ```curl curl -X GET 'https://api.tomtom.com/snapToRoads/batch/1/b4086eb3-dead-beef-afbf-cc521fe1d9d8/status?key={Your_API_Key}' ``` -------------------------------- ### Get Fence Details URL Request Example Source: https://docs.tomtom.com/geofencing-api/documentation/fences-service/get-fence-details An example of a GET request URL for retrieving fence details, showing a sample fence ID. ```http https://api.tomtom.com/geofencing/1/fences/a334029d-3003-43d6-adf8-de0b7e35b6cb?key={Your_API_Key} ``` -------------------------------- ### Initialize Navigation using OnlineTomTomNavigationFactory Source: https://docs.tomtom.com/navigation/android/getting-started/migrate-to-sdk-v2/step-by-step-guide Example of initializing navigation using the old OnlineTomTomNavigationFactory.create() method. ```java navigation = OnlineTomTomNavigationFactory.create( Configuration( context = this, navigationTileStore = navigationTileStore, locationProvider = locationProvider, routePlanner = routePlanner, ), ) ``` -------------------------------- ### GET Request URL Example Source: https://docs.tomtom.com/od-analysis/documentation/analysis/flow-matrix-analysis/analysis-trips-result An example of a GET request URL for retrieving analysis trips results. Ensure you replace {Your_API_Key} with your actual API key. ```http https://api.tomtom.com/origindestination/1/analysis/flowmatrix/123/result/trips?key={Your_API_Key}&dateRange=0&timeRange=0 ``` -------------------------------- ### Complete Authentication Example Source: https://docs.tomtom.com/global-entity-matcher/api-authentication A comprehensive bash script demonstrating how to obtain both API key and authorization token, and then make an authenticated API request. ```APIDOC ## Complete authentication example Here’s a complete example showing how to authenticate and make an API request: ```bash #!/bin/bash # Set your TomTom API key TOMTOM_API_KEY= # Log in to Azure (interactive, do this once) az login # Get authorization token TOKEN_RESPONSE=$(az account get-access-token --scope https://gem.core.orbis.tomtom.com/user_impersonation) AUTH_TOKEN=$(echo $TOKEN_RESPONSE | jq -r '.accessToken') # Make an API request curl -X GET "https://api.tomtom.com/maps/orbis/platform/private-gateway/storages" \ -H "tomtom-api-key: $TOMTOM_API_KEY" \ -H "Authorization: Bearer $AUTH_TOKEN" ``` ``` -------------------------------- ### Get Project Details with Default Objects URL Example Source: https://docs.tomtom.com/geofencing-api/documentation/projects-service/get-project-details This URL example shows how to retrieve project details, specifically including objects for which the project is set as the default. Replace {Your_API_Key} with your valid API key. ```http https://api.tomtom.com/geofencing/1/projects/44de824d-c368-46cf-a234-a6792682dfd6?key={Your_API_Key}&defaultObjects=true ``` -------------------------------- ### Getting Started with TomTom Traffic APIs Source: https://docs.tomtom.com/traffic-api/documentation/tomtom-maps/traffic-incidents/traffic-incidents-service Resources to help developers get started with the TomTom Traffic APIs, including obtaining API keys and accessing support. ```APIDOC ## Getting Started ### How to get a TomTom API Key Follow these instructions to obtain an API key, which is required to identify your application when making requests to TomTom's location service APIs. ### TomTom Knowledge Base Access articles, blogs, FAQs, tutorials, and videos for information and reference on TomTom APIs. ### Traffic Incidents in your map Watch this video on how to display traffic incidents and traffic flow on a map using the TomTom Traffic API. ### FAQs over the Traffic APIs Visit the knowledgebase for up-to-date information on TomTom APIs and SDKs. ``` -------------------------------- ### URL Request Example for Listing All Projects Source: https://docs.tomtom.com/geofencing-api/documentation/projects-service/list-projects This is a concrete example of a URL to list all projects available to the requesting user via the Geofencing API. Replace {Your_API_Key} with your actual API key. ```http https://api.tomtom.com/geofencing/1/projects?key={Your_API_Key} ``` -------------------------------- ### GET cURL Command Example for Geometry Search Source: https://docs.tomtom.com/search-api/documentation/search-service/geometry-search A cURL command that replicates the GET request example for geometry search. This is useful for testing API calls from the command line. ```curl curl 'https://api.tomtom.com/search/2/geometrySearch/pizza.json?key={Your_API_Key}&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 } ]' ``` -------------------------------- ### Get Specific Transition Alert Rule Request Example Source: https://docs.tomtom.com/geofencing-api/documentation/transition-alerts-deprecated/get-transition-alert-rule-deprecated This is a concrete example of a URL request to get the details of a specific Transition Alert Rule. It includes a sample rule ID and API key. ```http https://api.tomtom.com/geofencing/1/alerts/transitions/1f9e811f-867b-4d4d-aed9-7d8266fac0ae?key=PJD7y0G5AFj9Jiok6F0tIK16NiWYotb3 ``` -------------------------------- ### URL Request Example for Adding a New Project Source: https://docs.tomtom.com/geofencing-api/documentation/projects-service/add-new-project An example of the URL used to add a new project, including the base URL, service version, and API keys. ```http https://api.tomtom.com/geofencing/1/projects/project?key={Your_API_Key}&adminKey={Your_Admin_Key} ``` -------------------------------- ### Response Body Example for Adding a New Project Source: https://docs.tomtom.com/geofencing-api/documentation/projects-service/add-new-project An example of a successful response after creating a project, showing the project name and its generated UUID. ```json { "name": "Airports in Germany", "id": "44de824d-c368-46cf-a234-a6792682dfd6" } ``` -------------------------------- ### Example URL for Batch Download Source: https://docs.tomtom.com/batch-search-api/documentation/asynchronous-batch-download An example of a complete URL to fetch batch search results. Ensure you replace {Your_API_Key} with your actual API key. ```http https://api.tomtom.com/search/2/batch/45e0909c-625a-4822-a060-8f7f88498c0e?key={Your_API_Key} ``` -------------------------------- ### Start Navigation Session Source: https://docs.tomtom.com/navigation/ios/guides/navigation/turn-by-turn-navigation Initializes navigation with a RoutePlan. Ensure a Route and RoutePlanningOptions are prepared beforehand. This action can throw an error if navigation fails to start. ```swift do { let navigationOptions = NavigationOptions(activeRoutePlan: routePlan) try navigation.start(navigationOptions: navigationOptions) } catch { print("An error occurred: \(error)") } ``` -------------------------------- ### GET URL Request Example Source: https://docs.tomtom.com/search-api/documentation/filters-service/geometry-filter An example of a GET request to the geometry filter endpoint, demonstrating the structure of the geometryList and poiList parameters. The geometryList includes a CIRCLE and a POLYGON, while the poiList contains two POI objects with name, address, and position. ```http https://api.tomtom.com/search/2/geometryFilter.json?key={Your_API_Key}&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 } } ] ``` -------------------------------- ### Initialize OnlineRoutePlanner Source: https://docs.tomtom.com/navigation/android/getting-started/migrate-to-sdk-v2/step-by-step-guide Example of initializing OnlineRoutePlanner using the old factory method. ```java routePlanner = OnlineRoutePlanner.create( context = this, apiKey = BuildConfig.TOMTOM_API_KEY, ) ``` -------------------------------- ### Example GET Request with IDs Source: https://docs.tomtom.com/traffic-api/documentation/tomtom-maps/traffic-incidents/incident-details An example of a GET request to the Incident Details API specifying incident IDs. This includes parameters for API key, incident IDs, fields to retrieve, language, traffic model ID, and time validity filter. ```http https://api.tomtom.com/traffic/services/5/incidentDetails?key={Your_Api_Key}&ids=4819f7d0a15db3d9b0c3cd9203be7ba5&fields={incidents{type,geometry{type,coordinates},properties{iconCategory}}}&language=en-GB&t=1111&timeValidityFilter=present ``` -------------------------------- ### Start Navigation Source: https://docs.tomtom.com/navigation/android/guides/navigation/free-driving Call this method to initiate navigation. Ensure `TomTomNavigation` is initialized before calling. ```java tomTomNavigation.start() ``` -------------------------------- ### Incident Viewport API Request Example Source: https://docs.tomtom.com/traffic-api/documentation/tomtom-maps/traffic-incidents/incident-viewport An example of a complete GET request to the Incident Viewport API, demonstrating parameter usage. ```http https://api.tomtom.com/traffic/services/4/incidentViewport/-939584.4813015489,-23954526.723651607,14675583.153020501,25043442.895825107/2/-939584.4813015489,-23954526.723651607,14675583.153020501,25043442.895825107/2/true/xml?key={Your_API_Key} ``` -------------------------------- ### Example URL for Listing Road Matching Jobs Source: https://docs.tomtom.com/global-entity-matcher/api-gem-list-jobs This example shows how to list jobs specifically of type ROAD_MATCHING. ```text https://api.tomtom.com/maps/orbis/platform/gem/jobs?job_type=ROAD_MATCHING ``` -------------------------------- ### Example GET Request with Category Filter Source: https://docs.tomtom.com/traffic-api/documentation/tomtom-maps/traffic-incidents/incident-details This example demonstrates how to filter traffic incidents by category using a GET request. It includes parameters for API key, bounding box, fields, language, traffic model ID, category filter, and time validity. ```http https://api.tomtom.com/traffic/services/5/incidentDetails?key={Your_Api_Key}&bbox=4.8854592519716675,52.36934334773164,4.897883244144765,52.37496348620152&fields={incidents{type,geometry{type,coordinates},properties{iconCategory}}}&language=en-GB&t=1111&categoryFilter=Accident&timeValidityFilter=present ``` -------------------------------- ### Location Intelligence Example Source: https://docs.tomtom.com/tomtom-mcp/documentation/examples/use-cases This example shows how to get the precise address for given coordinates and find nearby places within a specified radius. ```natural-language "What's the exact address of the coordinates 52.3676, 4.9041? Find nearby restaurants within 500 meters." ``` -------------------------------- ### Example URL for Listing Enabled Alert Rules Source: https://docs.tomtom.com/geofencing-api/documentation/generic-alerts/list-alert-rules This example URL shows how to list all enabled alert rules for a specific project and alert type. It includes parameters for filtering and pagination. ```http https://api.tomtom.com/geofencing/1/alerts/rules?key=PJD7y0G5AFj9Jiok6F0tIK16NiWYotb3&project=ea06d8ab-762c-4f54-bb92-bde5cf35b9ff&alertType=TRANSITION&enabled=true&maxResults=3&pageNumber=1 ``` -------------------------------- ### Example URL Request for Additional Data API Source: https://docs.tomtom.com/search-api/documentation/additional-data-service/additional-data An example of a GET request to the Additional Data API, specifying geometry IDs for retrieval. ```http https://api.tomtom.com/search/2/additionalData.json?key={Your_API_Key}&geometries=00004631-3400-3c00-0000-0000673c4d2e,00004631-3400-3c00-0000-0000673c42fe ``` -------------------------------- ### Example GET Request with Bounding Box Source: https://docs.tomtom.com/traffic-api/documentation/tomtom-maps/traffic-incidents/incident-details An example of a GET request to the Incident Details API using a bounding box. This includes parameters for API key, bounding box coordinates, fields to retrieve, language, traffic model ID, and time validity filter. ```http https://api.tomtom.com/traffic/services/5/incidentDetails?key={Your_Api_Key}&bbox=4.8854592519716675,52.36934334773164,4.897883244144765,52.37496348620152&fields={incidents{type,geometry{type,coordinates},properties{iconCategory}}}&language=en-GB&t=1111&timeValidityFilter=present ``` -------------------------------- ### Example URL for Selected Link Analysis Source: https://docs.tomtom.com/od-analysis/documentation/analysis/selected-link-analysis/analysis-creation An example of a complete URL for creating a Selected Link Analysis. Ensure you replace {Your_API_Key} with your valid authorization key. ```http https://api.tomtom.com/origindestination/1/analysis/selected-link?key={Your_API_Key} ``` -------------------------------- ### Nearby Search URL Request Example Source: https://docs.tomtom.com/search-api/documentation/search-service/nearby-search An example of a GET request to the Nearby Search endpoint. Ensure you replace '{Your_API_Key}' with your actual API key. ```http https://api.tomtom.com/search/2/nearbySearch/.json?key={Your_API_Key}&lat=36.98844&lon=-121.97483 ``` -------------------------------- ### POST Request Body Example for Adding a New Project Source: https://docs.tomtom.com/geofencing-api/documentation/projects-service/add-new-project An example JSON payload for creating a new project named 'Airports in Germany'. ```json { "name": "Airports in Germany" } ``` -------------------------------- ### Example URL for Batch Submission Source: https://docs.tomtom.com/batch-search-api/documentation/asynchronous-batch-submission An example of a complete URL for submitting a batch request. Ensure you replace {Your_API_Key} with your actual API key. ```http https://api.tomtom.com/search/2/batch.json?key={Your_API_Key} ``` -------------------------------- ### Get Parking Locations cURL Command Example Source: https://docs.tomtom.com/on-street-parking-api/documentation/parking-locations/parking-locations Demonstrates how to execute a request for parking locations using cURL, including all necessary parameters. ```curl curl 'https://api.tomtom.com/parking/services/1/locations?{Your_API_Key}&point=-33.872809993512945,151.20807219091648&radius=100&targetTime=2022-01-01T00:00:01Z&fields=probability&maxLocations=150&selectionType=probability' ``` -------------------------------- ### Traffic Stats API Job Search Request Example Source: https://docs.tomtom.com/traffic-stats/documentation/api/search-jobs An example of a GET request to the Traffic Stats API for searching jobs. This example includes parameters for filtering by creation date, name, type, and state. ```http https://api.tomtom.com/traffic/trafficstats/job/search/1?key={Your_API_Key}&createdAfter=2018-01-01&createdBefore=2018-02-01&name=%London%&type=routeanalysis&state=DONE ``` -------------------------------- ### Register Customer - POST URL Request Example Source: https://docs.tomtom.com/geofencing-api/documentation/configuration-service/register-admin-key An example of a POST request URL for registering a customer with the Geofencing API, including sample API key. ```http https://api.tomtom.com/geofencing/1/register?key=yPMFGLgBoejrRoWS8qYS ``` -------------------------------- ### Traffic Incident Details Request Example Source: https://docs.tomtom.com/traffic-api/documentation/tomtom-maps/traffic-incidents/incident-details-deprecated An example of a GET request to the Traffic Incident Details API. This specific example uses version 4 of the service and a particular bounding box and traffic model ID. ```http https://api.tomtom.com/traffic/services/4/incidentDetails/s3/6841263.950712,511972.674418,6886056.049288,582676.925582/11/1335294634919/xml?key={Your_Api_Key} ``` -------------------------------- ### Example URL for Adding a Fence Source: https://docs.tomtom.com/geofencing-api/documentation/fences-service/add-new-fence-to-a-project This is a concrete example of a URL used to add a new fence to a project. Replace the placeholder values with your specific API key, admin key, and project ID. ```http https://api.tomtom.com/geofencing/1/projects/44de824d-c368-46cf-a234-a6792682dfd6/fence?key=Your_API_Key&adminKey=Your_Admin_Key ``` -------------------------------- ### Example Flow Segment Data Request Source: https://docs.tomtom.com/traffic-api/documentation/tomtom-maps/traffic-flow/flow-segment-data An example of a GET request to the Flow Segment Data endpoint. This specific example requests data in XML format for a point with coordinates 52.41072,4.84239 at zoom level 10. ```http https://api.tomtom.com/traffic/services/4/flowSegmentData/absolute/10/xml?key={Your_API_Key}&point=52.41072,4.84239 ``` -------------------------------- ### Sample Details File Source: https://docs.tomtom.com/traffic-stats/documentation/api/route-analysis This JSON file provides detailed summaries for a job that requires confirmation, including route names, date ranges, and traffic statistics. ```json { "summaries": [ { "locationName": "Some Route", "dateRangeName": "October 2024", "timeSetName": "Friday morning hour", "averageSampleSize": 150.93, "networkLength": 2.07, "coveredNetworkLength": 2.07, "distanceUnit": "KILOMETERS" } ] } ``` -------------------------------- ### Autocomplete API URL Request Example Source: https://docs.tomtom.com/search-api/documentation/autocomplete-service/autocomplete An example of a GET request to the Autocomplete API for 'pizza' results in JSON format, specifying the API key and language. ```http https://api.tomtom.com/search/2/autocomplete/pizza.json?key={Your_API_Key}&language=en-US ``` -------------------------------- ### Snap To Roads Batch Query Example (Metric) Source: https://docs.tomtom.com/snap-to-roads-api/documentation/snap-to-roads-api/asynchronous-snap-to-roads-submission This example demonstrates the structure of a POST body request for the Snap To Roads service using metric measurement system. It includes a batch item with a query and multiple points. ```json { "batchItems": [ { "query": "/snapToRoads/1?fields={projectedPoints{type,geometry{type,coordinates},properties{routeIndex,snapResult}},route{type,geometry{type,coordinates},properties{id,speedLimits{value,unit},address{roadName,roadNumbers,municipality,countryName,countryCode,countrySubdivision},elementType,traveledDistance,privateRoad,partOfTunnel,frc,formOfWay,roadUse,laneInfo{numberOfLanes}}},distances{total,ferry,publicRoad,privateRoad,road,offRoad}}&vehicleType=PassengerCar&measurementSystem=metric", "post": { "points": [ { "type": "Feature", "geometry": { "type": "Point", "coordinates": [19.4389141359581, 51.78057462411982] }, "properties": {} }, { "type": "Feature", "geometry": { "type": "Point", "coordinates": [19.439257458711324, 51.78057794294989] }, "properties": {} }, { "type": "Feature", "geometry": { "type": "Point", "coordinates": [19.43963296797358, 51.78064100067553] }, "properties": {} }, { "type": "Feature", "geometry": { "type": "Point", "coordinates": [19.44012113001449, 51.780690783028064] }, "properties": {} } ] } } ] } ```