API Explorer

• Geocoding

  • List Methods
  • Expand Methods

  • GET Geocoding geocode
    Returns a set of coordinates that match the geographical data entered.

    Parameter	Value	Type	Description
    maxResults		integer (1-20)	Maximum number of results to be returned
    language	English Dutch French German Italian Polish Portugese Spanish Swedish	string	language used in the returned address information
    ST		string	House number
    T		string	Thoroughfare or street name. Can include adjuncts ('Street', 'Rue', etc.)
    SL		string	Sub-locality or district within a city
    L		string	Locality, city or town
    AA		string	Administrative area, state or province
    PC		string	Postal code
    CN		string	Country name
    CC		string	3-character country code
    IS		string	Intersecting street (must intersect with Thoroughfare)
    FN		string	Feature or category name for a Point of Interest
    poiCategories		string	Category number for a Point of Interest, or comma-separated list of more than one category number.
    query		string	Freetext query field
    format	xml json jsonp: specify callback method in the query parameters	string	Specify content type of the response structure.
    callback		string	Callback method for jsonp responses

• Map Tiles

  • List Methods
  • Expand Methods

  • GET Basic Map Tiles lbs/map/3/basic/style/zoom/x/y.mimeType
    Returns 256 x 256 pixel tiles containing the requested map data. Refer to the written documentation for an explanation of the zoom grid.

    Parameter	Value	Type	Description
    style	1 1-hybrid	string	Style of tile to be returned
    zoom		integer	Map zoom level (0-18)
    x		integer	X position on zoom grid
    y		integer	Y position on zoom grid
    mimeType	png format JPEG format	string	Image format to be returned

  • GET Route Tiles lbs/map/3/route/style/zoom/x/y.mimeType
    Returns 256 x 256 pixel tiles containing the requested route path. Refer to the written documentation for an explanation of the zoom grid.

    Parameter	Value	Type	Description
    style	red route line green route line	integer	Style of route line to render
    zoom		integer	Zoom level (0-18)
    x		integer	X position on zoom grid
    y		integer	Y position on zoom grid
    mimeType	png format gif format	string	Image format to be returned
    r		string	Key for the route to be rendered on the tile, obtained from the Routing API
    i		string	Instruction step to be indicated with an arrow. Default: no arrow.

  • GET Traffic Tiles lbs/map/3/traffic/style/zoom/x/y.mimeType
    Returns 256 x 256 pixel tiles containing the requested traffic data. Refer to the written documentation for an explanation of the zoom grid.

    Parameter	Value	Type	Description
    style	plain lines plain lines with slightly less glow traffic tubes with chevrons	string	Style of traffic to be rendered
    zoom		integer	Zoom level (0-18)
    x		integer	X position on zoom grid
    y		integer	Y position on zoom grid
    mimeType	png format gif format	string	Image format to be returned
    t		string	Reference value for the state of traffic at a particular time, obtained from the Viewport API call. Use -1 to get the most recent traffic information. Default: most recent traffic information.

• WMS Calls

  • List Methods
  • Expand Methods

  • GET GetCapabilities lbs/map/3/wms/
    Returns a list of WMS calls supported by the TomTom Developers Portal.

    Parameter	Value	Type	Description
    request	GetCapabilities	string	Request type
    service	WMS	string	Service type
    version	1.1.1	string	WMS service version. Default: 1.1.1

  • GET GetMap lbs/map/3/wms/
    Returns map tiles for the requested bounding box in the requested size.

    Parameter	Value	Type	Description
    request	GetMap	string	Request type
    version	1.1.1	string	WMS service version
    srs	EPSG:3857 (EPSG:900913/EPSG:3785) EPSG:4326	string	Projection used in describing the bbox
    bbox		string	Comma-separated coordinates for the bounding box, in the projection stated in srs
    width		integer	Width of the resulting image (in pixels, max 2048)
    height		integer	Height of the resulting image (in pixels, max 2048)
    format	jpeg png	string	Image format to be returned
    layers	basic	string	Map layers requested
    styles		string	Map styles to be returned: leave blank
    service	WMS	string	Service type. Default: WMS.

• Initialize

  • List Methods
  • Expand Methods

  • GET Initialize lbs/services/initialize/3/contentType
    Returns dynamic information about maps.

    Parameter	Value	Type	Description
    contentType	xml json jsonp: specify callback method in the query parameters	string	Response content type
    projection	EPSG4326 EPSG900913	string	Projection used in geographic coordinates returned. Default: EPSG900913.
    jsonp		string	Callback method for jsonp responses

• Viewport

  • List Methods
  • Expand Methods

  • GET Viewport lbs/services/viewportDesc/3/minY,minX,maxY,maxX/zoom/oMinY,oMinX,oMaxY,oMaxX/oZoom/copyright/contentType
    Returns legal and technical information about the area inside a requested bounding box. If the map display will include an overview map, that bounding box is also used in the calculation. (If no overview map is used, set the overview coordinates to match the main coordinates). All coordinates must be in EPSG900913 format.

    Parameter	Value	Type	Description
    minY		string	Minimum Y value for the bounding box
    minX		string	Minimum X value for the bounding box
    maxY		string	Maximum Y value for the bounding box
    maxX		string	Maximum X value for the bounding box
    zoom		integer	Zoom level for the bounding box (0-18)
    oMinY		string	Minimum Y value for the overview box
    oMinX		string	Minimum X value for the overview box
    oMaxY		string	Maximum Y value for the overview box
    oMaxX		string	Maximum X value for the overview box
    oZoom		integer	Zoom level for the overview box (0-18)
    copyright	Return text description Return copyright index	boolean	Return copyright text?
    contentType	xml json jsonp: specify callback method in the query parameters	string	Response content type
    jsonp		string	Callback method for jsonp responses

• HD Traffic Regions

  • List Methods
  • Expand Methods

  • GET HD Traffic Regions lbs/services/hdtRegions/3/contentType
    Provides a traffic summary for all of the countries where TomTom has traffic information.

    Parameter	Value	Type	Description
    contentType	xml json jsonp: specify callback method in the query parameters	string	Response content type
    projection	EPSG900913 EPSG4326	string	Projection used in geographic coordinates returned. Default: EPSG4326.
    language	English Afrikaans Czech Danish Dutch German Finnish French Hungarian Italian Norwegian Polish Portuguese Spanish Swedish Turkish	string	Language of region and country names returned. Default: English.
    jsonp		string	Callback method for jsonp responses

• Traffic

  • List Methods
  • Expand Methods

  • GET Traffic Icons lbs/services/trafficIcons/3/style/minY,minX,maxY,maxX/zoom/trafficModelID/contentType
    Returns traffic information for a specified geographic extent.

    Parameter	Value	Type	Description
    style	plain lines plain lines with slightly less glow traffic tubes with chevrons	string	Style to be used in subsequent traffic tile calls
    minY		string	Minimum Y value/latitude for the bounding box
    minX		string	Minimum X value/longitude for the bounding box
    maxY		string	Maximum Y value/latitude for the bounding box
    maxX		string	Maximum X value/longitude for the bounding box
    zoom		integer	Zoom level (0 - 18)
    trafficModelID		string	Reference value for the state of traffic at a particular time, obtained from the Viewport API call. Use -1 to get the most recent traffic information.
    contentType	xml json jsonp: specify callback method in the query parameters	string	Response content type
    language	English Czech Danish Dutch German Finnish French Hungarian Italian Norwegian Polish Portuguese Spanish Swedish Turkish	string	Language of cause and description fields for traffic incidents returned. Default: English.
    projection	EPSG900913 EPSG4326	string	Projection for input and output coordinates. Default: EPSG900913.
    expandCluster	expand incident clusters do not expand inciedent clusters	boolean	List individual incidents in incident clusters separately?. Default: no.
    jsonp		string	Callback method for jsonp responses

• Routing

  • List Methods
  • Expand Methods

  • GET Routing lbs/services/route/3/points/routeType/contentType
    Returns the path points and travel instructions to get from a start point to an end point

    Parameter	Value	Type	Description
    points		string	Start point, 0-3 intermediate points, and end point. Coordinate pairs must be in lat:lon or y:x format (52.37,4.91:52.25,4.91:52.3,4.9 or 6877435.5,544110.75:6868254.5,543921.5).
    routeType	Quickest Shortest (in distance) AvoidMotorway Walk Bicycle SpeedLimited (no roads with limits over 80kph/50 mph) Green (optimized fuel usage)	string	Type of route requested
    contentType	xml json jsonp: specify callback method in the query parameters	string	Response content type
    avoidTraffic	use traffic information to plan do not use traffic information to plan	boolean	Use current traffic information when planning the route? Default: no.
    includeTraffic	describe delays omit delay information	boolean	Include traffic delay time in route summary returned? Default: no.
    language	English Afrikaans Czech Danish Dutch German Finnish French Hungarian Italian Norwegian Polish Portuguese Spanish Swedish Turkish	string	Language of the route instructions. Default: English.
    day	today tomorrow Monday Tuesday Wednesday Thursday Friday Saturday Sunday	string	Day of departure. Default: today.
    time		string	Time of departure, either 'now' or a number of minutes since local midnight. Default: now.
    iqRoutes	none take day and time into account	string	Type of IQ Routes (historic traffic delays) to use in calculating travel times. Default: take day and time into account.
    trafficModelID		string	Reference value for the state of traffic at a particular time, obtained from the Viewport API call. Use -1 to get the most recent traffic information. Default: most recent traffic information.
    avoidTolls	avoid toll roads allow routing over toll roads	boolean	Avoid toll roads when planning the route? Default: no.
    includeInstructions	include turn-by-turn instructions omit turn-by-turn instructions	string	Include turn-by-turn instructions in the response? Default: yes.
    projection	EPSG900913 EPSG4326	string	Projection for input and output coordinates. Default: EPSG4326.
    pathPoints		integer (0-18)	Should data path points be included in the response, and for what zoom level should they be plotted? Leave blank to omit pathPoints entirely.
    jsonp		string	Callback method for jsonp responses

• Geocoding

  • List Methods
  • Expand Methods

  • GET Geocoding lbs/services/geocode/4/geocode
    Returns a set of coordinates that match the geographical data entered.

    Parameter	Value	Type	Description
    maxResults		integer (1-20)	Maximum number of results to be returned. Default: 20.
    language	English Dutch French German Italian Polish Portugese Spanish Swedish	string	Language used in the returned address information. Default: English.
    ST		string	House number
    T		string	Thoroughfare or street name. Can include adjuncts ('Street', 'Rue', etc.)
    SL		string	Sub-locality or district within a city
    L		string	Locality, city or town
    AA		string	Administrative area, state or province
    PC		string	Postal code
    CN		string	Country name
    CC		string	3-character country code
    IS		string	Intersecting street (must intersect with Thoroughfare)
    FN		string	Feature or category name for a Point of Interest
    poiCategories		string	Category number for a Point of Interest, or comma-separated list of more than one category number.
    query		string	Freetext query field
    format	xml json jsonp: callback method must be specified	string	Response content type. Default: xml.
    jsonp		string	Callback method for jsonp responses

  • GET Reverse Geocoding lbs/services/reverseGeocode/3/contentType
    Returns geographical data matching entered coordinates.

    Parameter	Value	Type	Description
    contentType	xml json jsonp: specify callback method in the query parameters	string	Response content type
    point		string	Comma separated coordinate pair in the projection selected: lat,lon (default) or Y,X
    type	limited fields returned all types of result values of nearest big locations values of nearest medium-sized locations values of nearest locations	string	Geographic importance of the result returned. Default: limited fields returned.
    projection	EPSG4326 EPSG900913	string	Projection used in geographic coordinates. Default: EPSG4326.
    language	English Dutch French German Italian Spanish	string	Language of the returned address information. Default: English.
    jsonp		string	Callback method for jsonp responses

• Traffic Cameras

  • List Methods
  • Expand Methods

  • GET Boxquery trafficcams/boxquery
    Returns a list of cameras inside a bounding box

    Parameter	Value	Type	Description
    top		string	Latitude of the top of the bounding box
    bottom		string	Latitude of the bottom of the bounding box
    left		string	Longitude of the left (western) side of the bounding box
    right		string	Longitude of the right (eastern) of the bounding box
    format	json/jsonp xml	string	Response format. For jsonp, select json and add a callback method.
    callback		string	Callback method for jsonp responses

  • GET Get Cameras trafficcams/getsize/cameraId.jpg
    Returns the current image from a traffic camera.

    Parameter	Value	Type	Description
    getsize	reduced-size image full-size image	string	Size of image to retrieve
    cameraId		integer	ID of the camera to retrieve