Skip to main content
HERE logo
  • Category: places & weather
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 99
  • Triggers: 0
  • Slug: HERE
  • Version: 20261101_00

Tools

Slug: HERE_AUTOSUGGESTTool to fetch possible completions for a partial search term. Use after capturing a partial query and location context to generate typeahead suggestions.

Input Parameters

string
required
Free-form text to suggest on (partial or misspelled)
string
Latitude,longitude to bias suggestions (e.g., ‘52.5200,13.4050’)
string
Geographic filter region. Must be one of: ‘circle:lat,lon;r=meters’ (e.g., ‘circle:52.5200,13.4050;r=1000’), ‘bbox:west,south,east,north’, or ‘ring:lat1,lon1,lat2,lon2,…’
string
IETF BCP 47 language tag for results (e.g., ‘en-US’)
integer
Maximum number of suggestions to return

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HERE_BROWSETool to search for places around a given location with optional filters. Use when you need nearby points of interest filtered by categories, food types, or name.

Input Parameters

string
required
Center point for the search area, formatted as ‘lat,lng’.
string
BCP 47 language tag for localized results, e.g., ‘en-US’.
string
Text filter to match place names within the chosen categories.
integer
Maximum number of items to return.
string
Comma-separated HERE Places cuisine/food type IDs to filter results.
string
Comma-separated HERE Places category IDs to filter results (e.g., ‘700-7000-0322’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HERE_CALCULATE_ROUTECalculate a route between waypoints for car, truck, bicycle or pedestrian travel, with leg travel times and distances. The request accepts routing options such as fuel type and preferred truck routes. DEPRECATED: HERE Fleet Telematics is deprecated; its routing capabilities have moved to Routing v8.

Input Parameters

string
required
Routing profile in format ‘{routingType};{transportMode}’ where routingType is ‘fastest’ or ‘shortest’, and transportMode is ‘car’, ‘truck’, ‘bicycle’, or ‘pedestrian’.
string ("petrol" | "diesel" | "lng" | "lpg" | "cng" | "ethanol" | "propane" | "hydrogen" | "electric")
Fuel type affecting toll/environmental rules.
string
Comma-separated map overlay names for custom routing layers.
array
required
List of waypoints in ‘latitude,longitude’ format. First waypoint is origin, last is destination. Intermediate waypoints are via points the route must pass through. Minimum 2 waypoints required.
array
List of route attributes to return. Note: ‘shape’ attribute is only available when Fleet Telematics API succeeds (not in v8 fallback). Common values: ‘shape’, ‘summary’, ‘legs’.
string ("text" | "html")
Format for maneuver instructions.
array
Additional maneuver attributes to include, e.g., [‘direction’,‘action’].
boolean
Disable preferred truck routes when true.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HERE_CANCEL_PROBLEMTool to cancel a running asynchronous tour planning optimization job. Use when you need to stop an in-progress optimization calculation that is no longer needed or was submitted in error.

Input Parameters

string
required
The unique identifier of the tour planning problem to cancel. This ID is returned when submitting a problem for asynchronous optimization.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HERE_COORDINATES_TO_TILE_INDICESConvert geographic coordinates to Web Mercator XYZ tile indices and geographic bounds at a given zoom level. At longitude 180 degrees, the returned x index is 2 raised to the zoom level, outside the usual XYZ tile range.

Input Parameters

number
required
Latitude in degrees, must be between -85 and 85
number
required
Longitude in degrees, must be between -180 and 180
integer
required
Zoom level, integer between 0 and 20

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HERE_DECODE_ROUTE_HANDLEDecode and retrieve a route from a previously calculated route handle using a GET request. Route handles can be invalidated and are not suitable for persistent storage.

Input Parameters

array
List of preferred languages for the response (IETF BCP 47). First supported language is used.
object
Avoid configuration for POST body.
array
Map content attributes to include in response spans. Requires ‘polyline’ in return parameter.
string ("metric" | "imperial")
Units of measurement used in guidance instructions. Defaults to ‘metric’.
string
A location defining the origin of the trip in format ‘{lat},{lng}[PlaceOptions][WaypointOptions]’. The origin has to be located along the previously calculated route.
array
Attributes to include in the response. Options: ‘polyline’, ‘actions’, ‘instructions’, ‘summary’, ‘travelSummary’, ‘turnByTurnActions’, ‘mlDuration’, ‘typicalDuration’, ‘elevation’, ‘routeHandle’, ‘passthrough’, ‘incidents’, ‘routingZones’, ‘truckRoadTypes’, ‘tolls’.
string
ISO 4217 currency code for route costs. Router will specify it if not provided.
string
required
Route handle returned from a previous route calculation. See ‘return’ parameter of ‘/routes’ endpoint for more information.
string
User-provided token to trace requests sent to the service.
string
Time of departure in RFC 3339 format (e.g., ‘2019-06-24T01:23:45’). Special value ‘any’ indicates time should not be considered. Defaults to current time if not specified.
string ("car" | "truck" | "pedestrian" | "bicycle" | "scooter" | "taxi" | "bus" | "privateBus")
required
Mode of transport to be used for the calculation of the route. Note: ‘bicycle’, ‘bus’, ‘privateBus’, and ‘taxi’ modes are currently provided as Beta with limited functionality.
number
Walking speed in meters per second. Influences walking segment duration.
array
Segments with restrictions on maximum baseSpeed. Maximum 250 penalized segments per request.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HERE_DISCOVERTool to discover places and addresses by free-form text near a location. Use when you need to find points of interest or specific addresses from a natural-language query.

Input Parameters

string
required
Free-form search query for places or addresses.
string
Latitude and longitude to center the search, formatted ‘lat,lng’. Required if ‘in’ is omitted.
string
Geographical filter for search area. Must use one of: ‘bbox:west,south,east,north’ (bounding box), ‘circle:lat,lng;r=meters’ (circle with radius), or ‘ring:encoded_polyline’ (polygon area). Cannot be used alone with countryCode - requires ‘at’ parameter if using country filtering.
string
Preferred response language (BCP-47), e.g., ‘en-US’.
integer
Maximum number of results to return (1-100).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HERE_FIND_SEQUENCETool to solve a Vehicle Routing Problem (VRP) by optimizing routes for a fleet of vehicles serving multiple jobs. Use when you need to optimize delivery routes, pickup sequences, or multi-stop journeys with vehicle capacity constraints. This is a preview feature and subject to change.

Input Parameters

string
Unique identifier for this problem. Avoid confidential or personal information.
object
required
Plan containing jobs to be served.
object
required
Fleet definition with vehicle profiles and types.
string
Optional application identifier.
object
Optional configuration to tweak solver behavior.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HERE_FIND_WAYPOINT_SEQUENCETool to find the optimal sequence of waypoints using POST request to solve the Travelling Salesman Problem. Supports advanced vehicle parameters including truck restrictions, hazardous goods, toll calculations, and environmental zones. Returns optimized visit order with distance, time, and interconnections between waypoints.

Input Parameters

string
Ending waypoint as ‘lat,lon’. If not provided, optimization ends at the last destination.
string
Algorithm to use for sequence optimization.
string
required
Routing mode in format ‘{type};{transport}’ where type is ‘fastest’ or ‘shortest’, and transport is ‘car’, ‘truck’, ‘bicycle’, or ‘pedestrian’. Example: ‘fastest;car’
string
Starting waypoint as ‘lat,lon’. If not provided, optimization starts from the first destination.
string
Vehicle width with unit (e.g., ‘2.5m’, ‘250cm’). Used for truck restrictions.
string
Vehicle height with unit (e.g., ‘3.5m’, ‘350cm’, ‘138in’). Used for truck restrictions and toll calculations.
string
Vehicle length with unit (e.g., ‘10m’, ‘1000cm’). Used for truck restrictions and toll calculations.
string
Arrival time in ISO 8601 format. Cannot be used together with departure time.
string
Vehicle fuel type: Diesel, Petrol, LPG, LNG, CNG, Ethanol, Propane, Hydrogen, Electric. Used for environmental zones, toll cost, and consumption routing.
string
Departure time in ISO 8601 format (e.g., ‘2023-01-01T08:00:00Z’) or relative format (e.g., ‘2023-01-01T08:00:00+01:00’).
string
Custom request identifier for tracking.
string
Response verbosity level.
string
Areas to avoid in routing, specified as bounding boxes.
Comma-separated list of link IDs to avoid in routing.
string
1=commercial vehicle, 0=otherwise. Used for toll cost, environmental zones, and delivery-only zones.
string
Whether vehicle has a trailer attached (true/false).
string
Optimization objective: ‘time’ for fastest route, ‘distance’ for shortest. If not specified, uses mode type.
array
required
List of destination waypoints as ‘lat,lon’ strings. These will be optimized for the best visit sequence. Minimum 1 destination required.
string
Emission standard: 1=EURO I, 2=EURO II, 3=EURO III, 4=EURO IV, 5=EURO V, 6=EURO VI, 7=EURO EEV, 8=Electric. Used for toll cost and environmental zones.
string
Total vehicle weight including payload and trailers with unit (e.g., ‘7.5t’, ‘7500kg’, ‘16500lbs’). Used for truck restrictions, speed profile, and toll calculations.
string
Total weight of trailers with payload (e.g., ‘3t’, ‘3000kg’). Used for toll calculations.
string
Number of trailers: 0=none, 1=one or more, 2=two or more, 3=three or more, 4=one or more semi-trailers. Used for toll cost and truck restrictions.
string
Vehicle weight excluding trailers with unit (e.g., ‘5t’, ‘5000kg’). Used for toll calculations.
string
Weight per axle including payload with unit (e.g., ‘2t’, ‘2000kg’). Used for toll cost and truck restrictions.
string
Tunnel categories to avoid: B, C, D, or E. A tunnels have no restrictions, E have most. If C is specified, route uses A and B tunnels but not C, D, or E.
string
Actual number of passengers. Used for toll cost calculations and carpool/HOV lanes.
string
Number of trailer axles. Used for toll cost and country-wide truck restrictions.
string
Number of vehicle axles excluding trailers. Used for toll cost and country-wide truck restrictions.
string
Comma-separated list of hazardous goods: explosive, gas, flammable, combustible, organic, poison, radioActive, corrosive, poisonousInhalation, harmfulToWater, other, allhazardousGoods, explosiveFlammable. Used for toll cost and truck restrictions.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HERE_GEOCODETool to convert structured address data into geographic coordinates. Use when you need precise lat/lng from a free-text or qualified address input.

Input Parameters

string
Free-text address or place query. Required if ‘qq’ is not used.
string
Position context to bias results, formatted ‘lat,lng’.
string
Qualified key=value query string, e.g., ‘street=Invalidenstr;city=Berlin;postalCode=10115;country=DE’. Required if ‘q’ is not used.
string
Spatial filter for search area, e.g., ‘circle:lat,lng;r=radius’, ‘bbox:west,south,east,north’, or country/region filters as documented.
string
Response language (BCP-47), e.g., ‘en-US’.
string
Additional sections to include, e.g., ‘tz’ for time zone.
integer
Maximum number of results to return.
string
Political view to use for disputed areas (ISO country code).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HERE_GET_ALIASES_HEALTHTool to check the health status of the HERE Tracking aliases service. Use to verify service availability before making other aliases API calls.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HERE_GET_ALIASES_VERSIONTool to get the current version of the HERE Tracking Aliases service. Use when you need to verify the service version for compatibility or debugging purposes.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HERE_GET_ASSOCIATIONS_HEALTHTool to check the health status of the HERE Tracking Associations API service. Use when you need to verify that the associations service is operational and responding correctly.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HERE_GET_ASSOCIATIONS_VERSIONTool to retrieve the current version of the HERE Associations tracking service. Use when you need to verify the service version or check service availability.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HERE_GET_AUTOCOMPLETETool to get address autocomplete suggestions for partial address queries. Use when you need address-specific completions focusing on addresses and administrative areas, unlike autosuggest which includes broader place categories.

Input Parameters

string
required
Free-text query for address autocomplete suggestions. Enter partial address text (e.g., ‘ber’, ‘berl’, ‘berlin+p’). Whitespace, URLs, email addresses, or other out-of-scope queries will yield no results.
string
Center of the search context expressed as coordinates. Format: ‘{latitude},{longitude}’ (e.g., ‘-13.163068,-72.545128’ for Machu Picchu Mountain, Peru).
string
Search within a geographic area. This is a hard filter. Results will be returned only if they are located within the specified area. Format: ‘countryCode:{countryCode}[,{countryCode}]*’ (e.g., ‘countryCode:USA’ or ‘countryCode:CAN,MEX,USA’). Country codes must be ISO 3166-1 alpha-3 in uppercase.
string
Select the preferred response language for result rendering from a list of BCP47 compliant Language Codes. The autocomplete endpoint tries to detect the query language based on matching name variants and then chooses the same language for the response.
string
Select additional fields to be rendered in the response. Supported values: ‘streetInfo’ (renders additional block with street name decomposed into parts like base name, street type, etc.).
integer
Maximum number of results to be returned. Default is 5.
string
BETA: Limit the result items to the specified types. Provide one of the supported values or a comma separated list. Supported values: ‘area’ (restricts to locality or administrativeArea including sub-types), ‘city’ (restricts to locality type city), ‘postalCode’ (restricts to locality type postalCode).
string
Used to correlate requests with their responses within a customer’s application, for logging and error reporting. A valid UUIDv4 is recommended.
string
Toggle the political view. This parameter accepts single ISO 3166-1 alpha-3 country code in uppercase. Supported views: ARG, EGY, IND, KEN, MAR, PAK, RUS, SDN, SRB, SUR, SYR, TUR, TZA, URY.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HERE_GET_BASE_MAP_TILERetrieves a base map tile image from HERE Raster Tile API v3. Returns map tiles in various styles (normal day/night, satellite, reduced/lite) at specified zoom levels and tile coordinates using the Web Mercator projection. Tiles are provided in 256x256 or 512x512 pixel sizes in PNG or JPEG format. Use this to display map imagery in applications requiring tiled map rendering.

Input Parameters

integer
required
Tile column index in Web Mercator grid, zero-based.
integer
required
Tile row index in Web Mercator grid, zero-based.
integer ("256" | "512")
required
Tile image size in pixels. Allowed values: 256 or 512.
integer
required
Zoom level as an integer between 0 (world) and 20 (street-level).
string ("png" | "png8" | "png32" | "jpg" | "jpg70")
required
Image format for the tile.
string ("normal.day" | "normal.day.grey" | "normal.day.transit" | "normal.night" | "normal.night.grey" | "normal.night.transit" | "reduced.day" | "reduced.night" | "satellite.day" | "satellite.day.transit")
required
Map style/scheme for the base tile. Common options: ‘normal.day’ for standard day map, ‘normal.night’ for night mode, ‘satellite.day’ for satellite imagery, ‘reduced.day’ for simplified map.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HERE_GET_BULKJOBS_HEALTHTool to check the health status of the HERE Tracking bulkjobs service. Use to verify service availability before making other bulkjobs API calls.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HERE_GET_BULKJOBS_VERSIONTool to retrieve the current version of the HERE Bulkjobs tracking service. Use when you need to verify the service version number.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HERE_GET_C2_C_HEALTHChecks the health status of the HERE Tracking C2C service, which supports ingestion of devices from external cloud providers.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HERE_GET_C2_C_VERSIONTool to get the current version of the HERE C2C tracking service. Use when you need to check the service version for compatibility or monitoring purposes.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HERE_GET_DEPARTURESTool to get next departures from transit stations. Returns upcoming departures with line information, destination, and real-time delays. Use when you need to find public transit departure times either by station ID or by geographic location.

Input Parameters

string
Comma-separated list of station IDs to query (max 50). Required if ‘in_location’ is not provided.
string
Preferred language of response (IETF BCP 47 format).
string ("time" | "transport")
Sort order for departures.
string
Time of earliest departure in RFC 3339 format (e.g., ‘2019-06-24T01:23:45’). Converts to local time at each location. When timezone offset is not specified, time is assumed to be local. If not set, current time at departure place is used.
string
Transit mode filter (comma-separated). Supported modes: highSpeedTrain, intercityTrain, interRegionalTrain, regionalTrain, cityTrain, bus, ferry, subway, lightRail, privateBus, inclined, aerial, busRapid, monorail, flight, spaceship. Can use exclusion list by prefixing with ’-’ (e.g., ‘-subway,-bus’). Cannot mix inclusive and exclusive modes.
string
Limit departures to defined time window starting from ‘time’. Format is ISO 8601 duration (e.g., ‘PT2H’ for 2 hours). When not set, max 24 hours of departures can be returned.
string
Location-based query in format ‘latitude,longitude;r=radius_in_meters’. Default radius is 500m if not specified. Required if ‘ids’ is not provided.
integer
Maximum number of subsequent departures per station board to include in response.
integer
Maximum number of subsequent departures per transport (identified by name, direction, and mode). When not set, all departures are returned.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HERE_GET_EVENTS_HEALTHTool to check the health status of the HERE Events API service. Use to verify if the Events API is operational.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HERE_GET_EVENTS_VERSIONTool to get the current version of the HERE Events service. Use when you need to check the service version for compatibility or monitoring purposes.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HERE_GET_FEATURESTool to retrieve available map features per style for tile rendering. Use when you need to discover which features (environmental zones, congestion zones, POIs, vehicle restrictions) are supported by different map styles.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HERE_GET_GEOFENCES_HEALTHTool to check the health status of the HERE Geofences service. Use when you need to verify if the geofences API is operational before making other requests.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HERE_GET_GEOFENCES_VERSIONTool to get the current version of the HERE Geofences service. Use when you need to check the service version for compatibility or monitoring purposes.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HERE_GET_HEALTHTool to check the health status of the HERE Tracking API service. Use when you need to verify if the service is operational and performing as expected.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HERE_GET_INCIDENTS_BY_IDRetrieve a traffic incident by its original incident ID, with a selected location-referencing scheme. The response includes modeled incident and location details, which may include descriptions, severity, and road geometry.

Input Parameters

string
The language to be used for incident descriptions (BCP47 format). Supported values are available at iana.org.
string ("metric" | "imperial")
Units of measurement for incident descriptions.
string
required
Identifier of the first traffic incident in a chain of updates. Once an incident chain has been created, this value will never change.
string
User-provided token for tracing requests. Any string is accepted, but UUID is preferred.
string ("none" | "olr" | "shape" | "tmc")
required
The location referencing scheme to be used in the response. Options: none (no location references), olr (TISA OpenLR standard), shape (series of geo-coordinates), tmc (Traffic Message Channel).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HERE_GET_INFOTool to get metadata about the HERE Raster Tile API v3. Returns information about accepted values of API parameters including supported image formats, sizes, styles, projections, resources, and zoom level ranges. Use when you need to discover available options before requesting map tiles.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HERE_GET_ISOLINESTool to calculate isolines. Use when you need reachable area polygons based on time, distance, or consumption ranges.

Input Parameters

string
Starting coordinate for forward isolines, formatted as ‘lat,lng’. Required if destination is not provided.
string ("time" | "distance" | "consumption")
required
Basis of isoline calculation: time (seconds), distance (meters), or consumption.
string
Target coordinate for reverse isolines, formatted as ‘lat,lng’. Required if origin is not provided.
string ("fast" | "short")
Routing preference for calculation.
array
required
One or more range break values; seconds for time, meters for distance.
string
Departure time in ISO 8601 format for traffic-aware isolines.
string ("car" | "pedestrian" | "truck" | "taxi" | "bus")
Transport mode for calculation. Defaults to ‘car’ if not specified.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HERE_GET_LABELS_HEALTHTool to check the health status of the HERE Labels service. Use when you need to verify if the labels service is operational.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HERE_GET_LABELS_VERSIONTool to retrieve the current version of the HERE Labels service. Use when you need to check the service version for compatibility or debugging purposes.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HERE_GET_LABEL_TILERetrieves a map tile image with text labels using HERE Raster Tile API v3. Returns map tiles in various styles (day/night, grayscale, terrain) with street names, city names, and POI labels rendered in specified language(s). Use this when you need labeled map imagery at specific tile coordinates and zoom levels for tiled map rendering. Tiles use Web Mercator projection in standard 256x256 or 512x512 pixel sizes.

Input Parameters

integer
required
Tile column index in Web Mercator grid. Must be 0 ≤ x < 2^zoom. For zoom=10, valid range is 0-1023.
integer
required
Tile row index in Web Mercator grid. Must be 0 ≤ y < 2^zoom. For zoom=10, valid range is 0-1023.
integer ("100" | "200" | "400")
Pixels-per-inch for label rendering. Higher values = sharper images. 100=low-res, 200=standard, 400=high-res.
string
Primary label language code (ISO 639-1, e.g., ‘en’, ‘de’, ‘fr’, ‘es’). Labels will be displayed in this language when available.
integer ("256" | "512")
Tile image size in pixels (width and height). 256 is standard, 512 provides higher detail.
integer
required
Zoom level as integer between 0 (world view) and 20 (street-level detail).
string
Secondary label language code (ISO 639-1, e.g., ‘de’, ‘en’). Used as fallback when primary language is unavailable for a label.
string
Geopolitical view code (three-letter country code, e.g., ‘USA’). Adjusts border rendering based on country’s territorial claims. Note: not all country codes are supported; check ‘/politicalViews’ endpoint for valid values.
string ("png" | "png8")
Image format for the tile. ‘png’ for full 32-bit color with transparency, ‘png8’ for smaller 8-bit indexed color.
string ("normal.day" | "normal.day.grey" | "normal.day.transit" | "normal.night" | "normal.night.grey" | "normal.night.transit" | "terrain.day" | "terrain.day.grey" | "terrain.day.transit")
required
Map rendering scheme for the tile. ‘normal.day’ for standard daytime colors, ‘normal.night’ for dark mode, ‘.grey’ for grayscale, ‘.transit’ includes public transport labels, ‘terrain.*’ for topographic maps. Maps to Raster Tile API v3 styles (explore/lite).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HERE_GET_LANGUAGESTool to retrieve supported languages for map tile labels from HERE Raster Tile API. Use when you need to determine which language options are available for rendering map labels and text on different map layers.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HERE_GET_LARGEDATA_HEALTHTool to check the health status of the HERE Tracking largedata service. Use to verify service availability before making other largedata API calls.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HERE_GET_LARGEDATA_VERSIONTool to retrieve the current version of the HERE largedata tracking service. Use when you need to verify the service version number.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HERE_GET_LOCATIONS_HEALTHTool to check the health status of HERE’s locations tracking service. Use when you need to verify if the locations API is operational and responding correctly.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HERE_GET_LOCATIONS_VERSIONTool to retrieve the current version of the HERE Tracking Locations service. Use when you need to check the service version or verify service availability.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HERE_GET_MAP_IMAGERetrieves a static map image from HERE Map Image API v3. Returns a downloadable PNG image with customizable center/zoom, dimensions, style, and overlay markers/shapes. Useful for generating map snapshots for reports, visualizations, or embedding in applications.

Input Parameters

string
required
Image dimensions in pixels as ‘{width}x{height}’, e.g., ‘480x370’.
string
Map style identifier. Common values: ‘lite.day’, ‘explore.day’, ‘explore.night’. Defaults to standard style if not specified.
string ("png8" | "png")
required
Output image format. Supported values: ‘png8’ (8-bit PNG, smaller file size) or ‘png’ (24-bit PNG, higher quality).
string
URL-encoded GeoJSON FeatureCollection to overlay custom shapes. Must be valid JSON string.
string
Compact overlay encoding for custom points/lines/polygons with styling. Format: ‘type:coordinates[;property=value]’. Examples: ‘point:52.5,13.4’, ‘line:52.5,13.4,52.6,13.5;color=#E82D89;width=5’
string
Comma-separated list of feature toggles with modes. E.g., ‘vehicle_restrictions:active_and_inactive,pois:disabled’.
string
Units for the scale bar, e.g., ‘mi’ or ‘km’.
string
required
Path segment defining map positioning. Use ‘center:latitude,longitude;zoom=level’ for fixed center (zoom 0-20, where 0 is world view and 20 is street level), or ‘overlay:padding=pixels’ to auto-fit overlay content with specified padding. Example: ‘center:52.5200,13.4050;zoom=14’

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HERE_GET_MAP_TILE_TRANSITTool to request a map tile with public transport overlay from HERE Raster Tile API v3. Use when you need street map tiles with transit information displayed (buses, trains, tram lines, etc.). Returns a PNG image with base map and public transport overlays.

Input Parameters

integer
required
The x-coordinate (column) of the tile in the tile grid, must be non-negative
integer
required
The y-coordinate (row) of the tile in the tile grid, must be non-negative
integer
required
Zoom level for the map tile, integer between 0 (world view) and 20 (street level)
string
Map style to use. Supported values: explore.day, explore.night, explore.satellite.day, satellite.day

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HERE_GET_MATRIXCompute routing matrices of distances and travel times between multiple origins and destinations. Results use flat row-major arrays; asynchronous requests can return a matrix ID and status URL instead of immediate results.

Input Parameters

array
required
List of origin points (up to 10,000). Each origin is paired with each destination.
boolean
If true, request is processed asynchronously and returns immediately with matrixId and statusUrl for polling. If false (default), waits for computation and returns results directly.
array
required
List of destination points (up to 10,000). Each destination is paired with each origin.
string
ISO 8601 departure time (e.g., ‘2024-12-01T08:00:00Z’). Required when ‘travelTime’ is in summaryAttributes for traffic-aware calculations.
string ("car" | "truck" | "pedestrian" | "bicycle")
Transportation mode for routing calculations. Affects speed, route selection, and restrictions.
array
Metrics to compute for each route: ‘distance’ (meters), ‘travelTime’ (seconds, requires departureTime), ‘consumptions’ (fuel usage), ‘tollCost’ (estimated toll charges). Default: [‘distance’, ‘travelTime’]

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HERE_GET_MATRIX_MATRIX_IDTool to retrieve the result of a successfully completed matrix calculation. Use when you have a matrixId from a previous matrix calculation request and need to fetch the computed distances and travel times.

Input Parameters

string
required
Matrix ID obtained upon successful submission of a matrix calculation request.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HERE_GET_METADATA_HEALTHTool to retrieve the health status of the HERE Tracking metadata service. Use when you need to verify if the service is operational.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HERE_GET_METADATA_VERSIONTool to retrieve the current version number of the HERE Tracking service. Use when you need to verify the service version or check API compatibility.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HERE_GET_META_INFO_TILEDEPRECATED: This action uses HERE Map Tile API v2 which was shut down in Q1 2025. The metainfo/metadata endpoint is not available in the replacement Raster Tile API v3. For tile metadata, consider using HERE Vector Tile API v2 which provides geometric data and metadata in vector format. Original functionality: Retrieve JSON metadata for a specific map tile including information about street labels, POIs, buildings, and other rendered objects without downloading the tile image.

Input Parameters

integer
required
Tile column index (XYZ scheme), must be non-negative
integer
required
Tile row index (XYZ scheme), must be non-negative
boolean
Include POI-related information in metadata if true
integer ("256" | "512")
required
Tile size in pixels (width and height), either 256 or 512
integer
required
Tile zoom level (XYZ scheme), must be between 0 and 22 inclusive
string ("png" | "png8")
required
Tile image format, either ‘png’ or ‘png8’
string ("normal.day" | "normal.day.grey" | "normal.day.mobile" | "normal.night" | "normal.night.grey" | "terrain.day")
required
Map tile scheme, e.g., ‘normal.day’, ‘terrain.day’

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HERE_GET_NOTIFICATIONS_HEALTHCheck the health of the HERE Tracking Notifications service to determine whether it is operational. DEPRECATED: This action uses the Notifications v3 API, which HERE has removed, so it is no longer available.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HERE_GET_NOTIFICATIONS_VERSIONRetrieve the HERE Tracking Notifications service version for compatibility checks or monitoring. DEPRECATED: This action uses the Notifications v3 API, which HERE has removed, so it is no longer available.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HERE_GET_OPENAPIRetrieves the OpenAPI 3 specification for the HERE Traffic API v7 as JSON. Use it to inspect the service’s API schema and documentation; an optional request ID can help trace the request.

Input Parameters

string
User-provided token that can be used to trace a request or a group of requests sent to the service. This can be any string but UUID is preferred.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HERE_GET_POLITICAL_VIEWSTool to retrieve available geopolitical views for HERE map rendering. Returns a mapping of map resources to supported country-specific boundary representations (ISO 3166-1 alpha-2 codes). Use when you need to determine which political views are available for displaying maps with region-specific boundaries.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HERE_GET_PROBLEMS_SOLUTIONTool to retrieve the solution for a completed tour planning problem. Returns optimized tours with routes, stops, schedules, and statistics. Use after submitting a problem asynchronously to get the calculated solution.

Input Parameters

string
required
Problem ID from the async submission. This is the unique identifier returned when you submit a tour planning problem.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HERE_GET_PROFILETool to retrieve a specific matrix routing profile definition by its ID. Use when you need to inspect predefined routing configurations including transport mode, routing optimization, avoid options, and region definitions.

Input Parameters

string
required
Profile ID. This parameter is case-sensitive. Examples: ‘carFast’, ‘carShort’, ‘truckFast’, ‘bicycleFast’, ‘pedestrianFast’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HERE_GET_PROFILESTool to list all supported predefined routing profiles for matrix routing calculations. Use when you need to discover available profiles with their transport modes, routing optimizations, and constraints.

Input Parameters

string
User-provided token that can be used to trace a request or a group of requests sent to the service. This can be any string but UUID is preferred.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HERE_GET_REGISTRY_HEALTHTool to check the health status of the HERE Tracking Registry service. Use this to verify if the registry service is operational and responding normally.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HERE_GET_REGISTRY_VERSIONTool to get the current version of the HERE Registry service. Use when you need to check the service version for compatibility or monitoring purposes.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HERE_GET_REPORTS_HEALTHTool to check the HERE Tracking service health status. Use when you need to verify if the service is operational and performing as expected.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HERE_GET_RESOURCE_PROJECTION_ZOOM_COLUMN_ROW_FORMATTool to retrieve a raster map tile image for a specific zoom level, column, and row from HERE Raster Tile API v3. Use when you need to fetch map tiles in various formats (PNG, JPEG) for different resource types (base maps, aerial imagery, traffic overlays, etc.). Supports customization options including language, geopolitical views, styles, and resolution.

Input Parameters

string
Map version identifier. If not specified, the latest map version is used. Query the /info endpoint to retrieve the current map version.
integer ("100" | "400")
Pixels per inch resolution. Valid values: 100 for normal resolution, 400 for high-resolution (hi-res) tiles. Default is 100 if not specified.
integer
required
Tile row index (y-coordinate in tile grid), must be non-negative. Valid range is 0 to (2^zoom - 1). The coordinate [0,0] (column, row) corresponds to the top-left of a map in Mercator projection.
string
Primary language for map labels using BCP47 language code (ISO 639-1 two-letter code, optionally with ISO 15924 script code). If not specified, each country uses its default language. Supported languages are listed in the /languages resource endpoint.
integer
Tile image size in pixels (width and height). Common values: 256, 512. Default is 256 if not specified. Supported sizes are listed in the info resource endpoint.
integer
required
Zoom level of the map tile, must be non-negative. Minimum and maximum zoom levels are specified in the info resource endpoint. Typical range is 0 (world view) to 20 (street level).
string
Secondary language for dual labeling, follows same format as lang parameter (BCP47 language code). Use this to show labels in two languages simultaneously.
string
Geopolitical view for rendering boundaries. Uses ISO 3166-1 alpha-2 country codes (e.g., ‘IN’ for India, ‘US’ for United States). If not specified, the international view is used. Check /politicalViews endpoint for supported values.
string
Map style to use for rendering the tile. Common values: ‘explore.day’, ‘explore.night’, ‘lite.day’, ‘satellite.day’. If not provided, the default style ‘explore.day’ is used. See the info resource endpoint for all supported styles.
integer
required
Tile column index (x-coordinate in tile grid), must be non-negative. Valid range is 0 to (2^zoom - 1). The coordinate [0,0] (column, row) corresponds to the top-left of a map in Mercator projection.
string
required
Output image format for the tile. Common values: ‘png’, ‘png8’, ‘jpeg’, ‘jpg’. Supported formats are listed in the info resource endpoint.
string
Comma-separated list of map features with modes in format ‘feature:mode’. Features are rendered independently. Examples: ‘congestion_zones:active’, ‘environmental_zones:all’, ‘pois:default’, ‘vehicle_restrictions:active’. See /features endpoint for supported values.
string
required
Type of tile resource. Common values include ‘base’ for base map tiles, ‘aerial’ for aerial imagery, ‘traffic’ for traffic overlay, ‘hybrid’ for satellite with labels. See the info resource endpoint for all supported values for this map version.
string
required
Tile projection system. Supported value: ‘mc’ for Mercator Projection. See the info resource endpoint for all supported projections.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HERE_GET_ROUTESCalculates routes between waypoints for multiple vehicle and pedestrian modes. Depending on requested return options, results can include route geometry, actions, travel time and distance; detailed turn-by-turn actions are not preserved in the response.

Input Parameters

array
List of intermediate waypoints in ‘lat,lng’ format. Route will traverse these sequentially between origin and destination. Can include place and waypoint options.
array
List of preferred languages for the response (IETF BCP 47 format). First supported language is used. Default is [‘en-US’].
array
Map content attributes to include in route spans (e.g., ‘speedLimit’, ‘dynamicSpeedInfo’). Requires ‘polyline’ in return parameter.
string ("metric" | "imperial")
Units of measurement
string
required
Origin waypoint in format ‘lat,lng’ (e.g., ‘52.5200,13.4050’). Can include place options (e.g., ‘;radius=200’) and waypoint options (e.g., ‘!stopDuration=60’).
array
Attributes to include in response. Options: ‘polyline’ (route geometry), ‘actions’ (maneuvers), ‘instructions’ (localized guidance), ‘summary’ (route summary), ‘travelSummary’, ‘turnByTurnActions’, ‘elevation’, ‘routeHandle’, ‘passthrough’, ‘incidents’, ‘routingZones’, ‘truckRoadTypes’, ‘tolls’, ‘typicalDuration’, ‘mlDuration’. Some require other attributes (e.g., ‘actions’ requires ‘polyline’).
string
ISO 4217 currency code for toll costs. If not provided, router will specify local currency on best-effort basis.
string
Arrival time in RFC 3339 format (e.g., ‘2019-06-24T01:23:45’). Not supported for EV routing, route handle, or route import. Cannot be used with departureTime.
string
required
Destination waypoint in format ‘lat,lng’ (e.g., ‘48.1351,11.5820’). Can include place and waypoint options like origin.
string ("fast" | "short")
Routing optimization mode
string
User-provided token for tracing requests to the service.
integer
Number of alternative routes to return in addition to the optimal route. Default is 0.
string
Departure time in RFC 3339 format (e.g., ‘2019-06-24T01:23:45’ or ‘2019-06-24T01:23:45Z’). Use ‘any’ to ignore time. If not specified, current time is used.
string ("car" | "truck" | "pedestrian" | "bicycle" | "scooter" | "taxi" | "bus" | "privateBus")
required
Mode of transport for route calculation. Note: bicycle, bus, privateBus, and taxi are Beta features with limited functionality.
number
Walking speed in meters per second for pedestrian transport mode. Default is 1 m/s. Influences duration of walking segments.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HERE_GET_RULES_HEALTHTool to check the health status of the HERE Tracking Rules service. Use when you need to verify if the Rules API service is operational. Returns a simple health status message.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HERE_GET_RULES_VERSIONTool to retrieve the current version of the HERE Tracking Rules service. Use when you need to check the service version for compatibility or debugging purposes.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HERE_GET_SENSORS_HEALTHTool to check the health status of the HERE Tracking Sensors service. Use this to verify that the service is operational and performing as expected.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HERE_GET_SENSORS_VERSIONTool to retrieve the current version of the HERE Tracking sensors service. Use when you need to check the service version information.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HERE_GET_SHADOWS_HEALTHTool to check the health status of the HERE Tracking Shadows service. Use when you need to verify if the shadows service is operational and performing as expected.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HERE_GET_SHADOWS_VERSIONTool to retrieve the current version of the HERE Shadows tracking service. Use when you need to verify the service version number.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HERE_GET_SHIPMENTS_HEALTHTool to check the health status of the HERE Shipments service. Use when you need to verify if the tracking service is operational.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HERE_GET_SHIPMENTS_VERSIONTool to get the HERE shipments tracking service version. Use when you need to check the current version of the shipments API service.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HERE_GET_STATIONSTool to search for transit stations around a location. Returns station names, locations, and available transit lines. Use when you need to find public transportation stations within a specific area or by station ID.

Input Parameters

string
Comma-separated list of station IDs (max 50, up to 1000 chars). At least one of ids, in, or name+in must be provided.
string
Circular area with center coordinates and optional radius. Format: {lat},{lng};r={radius}. Radius in meters (default: 500). At least one of ids, in, or name+in must be provided.
string
Station name or partial name for search (requires ‘in’ parameter to be set as well)
string
For name searches only - ‘fuzzy’ (default) or ‘strict’ matching
string
Defines which place attributes are included. Comma-separated values: transport, accessPoints
integer
Maximum number of stations to return (default: 5, max: 50 for location search or 25 for name search)
string
Transit mode filter (inclusive or exclusive list)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HERE_GET_STATUS_STATUS_IDCheck the status of an asynchronous tour planning optimization job. Use when you have submitted a tour planning problem and need to poll for completion. Returns the current status (‘pending’, ‘inProgress’, ‘success’, ‘timeout’, or ‘failure’). When completed successfully, provides resource object with problemId and solution URL.

Input Parameters

string
required
Status ID returned from async tour planning problem submission. Use this to poll for job completion status.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HERE_GET_TIMESTAMPTool to get the current server timestamp from HERE Tracking API. Use when you need a synchronized Unix epoch timestamp (seconds since 1970-01-01 00:00:00 UTC) from HERE servers.

Input Parameters

string
ID used for correlating requests within HERE Tracking. Used for logging and error reporting. Must be a valid UUIDv4.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HERE_GET_TRACES_HEALTHTool to check the health status of the HERE Tracking service. Use when you need to verify if the traces API is operational and performing as expected.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HERE_GET_TRACES_VERSIONRetrieve the current version of the HERE Tracking Traces service for compatibility or diagnostic purposes.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HERE_GET_TRAFFIC_FLOWTool to retrieve real-time traffic flow data. Use when you need current congestion metrics for a specified area.

Input Parameters

string
required
Spatial filter defining area of interest. Formats: circle:lat,lng;r=radiusMeters | bbox:west,south,east,north | corridor:flexiblePolyline;r=bufferMeters
string
Optional advanced feature flag; e.g., ‘deepCoverage’.
boolean
Optional flag for reference replacements in corridor requests.
string ("shape" | "tmc" | "olr")
required
Location referencing scheme for road segments.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HERE_GET_TRAFFIC_INCIDENTSTool to fetch real-time traffic incidents within a specified area. Use when you need up-to-date incident data for a geographic region.

Input Parameters

string
required
Geospatial filter for the query area. Syntax: circle:lat,lng;r=meters | bbox:w,s,e,n | corridor:ENCODED_POLYLINE;r=meters
string
Filter incidents by type (e.g., construction, accident).
string
Filter incidents by severity (e.g., major, minor).
string ("shape" | "tmc" | "olr")
required
Road location referencing scheme; one of shape, tmc (Traffic Message Channel), or olr (OpenLR).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HERE_GET_TRAFFIC_TILERetrieve a traffic flow overlay tile image showing real-time traffic conditions. Returns a PNG image tile that can be overlaid on maps to visualize traffic speed and congestion. Use this when you need to display traffic flow data for a specific geographic area defined by tile coordinates (zoom, x, y).

Input Parameters

integer
required
Tile column index (XYZ scheme), must be non-negative
integer
required
Tile row index (XYZ scheme), must be non-negative
integer ("256" | "512")
required
Tile size in pixels. Allowed values: 256 or 512.
integer
required
Tile zoom level (XYZ scheme), must be between 0 and 20
string ("png" | "png8")
required
Image format for the traffic tile (only png and png8 are supported by the v3 flow API)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HERE_GET_USERS_HEALTHTool to check the HERE Tracking Users API service health status. Use this to verify that the service is operational before making other API calls.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HERE_GET_USERS_VERSIONTool to get the current version of the HERE tracking service. Use when you need to verify the service version or check service availability.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HERE_GET_VECTOR_TILERetrieves protocol buffer encoded binary vector tiles using HERE Vector Tile API v2. Returns map tiles in OMV (Optimized Map for Visualization) format following the Map Vector Tile open specification. Use this when you need vector tile data at specific tile coordinates and zoom levels for client-side map rendering. Supports layer exclusion and conditional requests via ETags.

Input Parameters

integer
required
Specifies the X coordinate index. This parameter is dependent upon the tile Zoom level. Minimum is 0, maximum is 2^z-1 (depends on the Zoom level).
integer
required
Specifies the Y coordinate index. This parameter is dependent upon the tile Zoom level. Minimum is 0, maximum is 2^z-1 (depends on the Zoom level).
integer
required
Specifies the tile Zoom level. Accepted values range from 0-17.
string
Specifies the map version to be used. The map version can be retrieved by querying /info endpoint.
string ("base" | "core")
required
Specifies the layers available in the tile. The access to each layer is determined by the contract of the user. ‘base’ includes base layer, ‘core’ includes everything from ‘base’ and additional data for some countries (for example: Japan).
string ("omv")
required
Specifies the tile format. ‘omv’ = Optimized Map for Visualization (follows Map Vector Tile open specification).
string
Specifies comma separated list of layer names to be excluded from the resulting Map Vector Tile. Should follow: (-LAYER_1,-LAYER_2,…). Examples: (-roads) to remove just roads, (-roads,-water,-buildings) to remove roads, water areas and buildings.
string ("mc")
required
Specifies the tile projection. ‘mc’ = Mercator Projection.
string
Specifies an optional entity tag of the resource cached in the client. Used for conditional requests.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HERE_GET_VECTORTILE_DOCS_LAYERS_JSONTool to retrieve OMV-2 layers documentation for HERE Vector Tiles. Returns comprehensive schema documentation including layer definitions, geometry types, field names, and possible values in TileJSON 3.0.0 format. Use when you need to understand the data structure of vector tiles before requesting or processing them.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HERE_GET_VECTORTILES_INFOTool to retrieve the current map version from HERE Vector Tiles Service. Use when you need the encoded map version identifier, which is valid for 24 hours and must be refreshed after that period.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HERE_GET_VECTORTILES_LANGUAGESTool to retrieve supported languages for vector map tiles from HERE Vector Tiles API. Use when you need to determine which language options are available for rendering vector map labels and text on different layers (base, core).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HERE_GET_VECTORTILES_OPENAPITool to retrieve the OpenAPI specification for the HERE Vector Tiles API v2. Use when you need the complete API schema documentation for vector tile endpoints.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HERE_GET_VECTORTILES_PROTOTool to retrieve a list of available protocol buffer formats from HERE Vector Tiles Service. Use when you need to discover available proto file formats for subsequent requests.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HERE_GET_VECTORTILES_PROTO_NAMETool to retrieve protocol buffer (.proto) file format definitions from HERE Vector Tiles API. Returns the specified .proto file that defines the data structure for vector tiles. Use when you need the protocol buffer schema to parse or understand the binary vector tile format.

Input Parameters

string
required
Specifies the name of the requested protocol buffer format file. This is the filename of the .proto file to retrieve, such as ‘vector_tile.proto’ which defines the structure for vector tile data.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HERE_GET_VECTORTILES_PVIEWSTool to retrieve available political views for HERE vector tiles. Returns lists of country codes that have disputed territories in base and core map data. Use when you need to determine which political view codes are valid for the ‘pview’ parameter in tile requests.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HERE_GET_VERSIONTool to retrieve the version information of the HERE Traffic API. Use when you need to check the current API version or service version.

Input Parameters

string
User-provided token that can be used to trace a request or a group of requests sent to the service. This can be any string but UUID is preferred.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HERE_GET_WAYPOINT_SEQUENCEOptimizes the visit order of multiple waypoints between a fixed origin and destination. Returns the most efficient sequence to visit all intermediate points, minimizing either travel time or distance. Useful for delivery routing, tour planning, and multi-stop journey optimization.

Input Parameters

string
required
Start coordinate as ‘lat,lon’, e.g., ‘52.53086,13.38474’.
array
Additional response data to include. ‘summary’ contains travel time and distance (always included). ‘polyline’ adds encoded route geometry.
array
required
One or more intermediate waypoints as ‘lat,lon’.
string
ISO 8601 arrival time, e.g., ‘2023-01-01T17:00:00Z’.
string
required
End coordinate as ‘lat,lon’, e.g., ‘52.52079,13.40942’.
string ("fast" | "short")
Routing optimization objective: ‘fast’ minimizes travel time, ‘short’ minimizes distance. Defaults to ‘fast’.
boolean
If true, include alternative optimized sequence if available.
string
ISO 8601 departure time, e.g., ‘2023-01-01T08:00:00Z’.
string ("car" | "truck" | "pedestrian" | "bicycle")
Mode of transport for route optimization. Different modes use different speeds and road access rules. Defaults to ‘car’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HERE_GET_WEATHER_FORECAST_DAILYGet 7-day weather forecasts for any location worldwide. Returns either detailed segment-level forecasts (morning/afternoon/evening/night) or simplified daily summaries. Supports location queries by city name, coordinates, or U.S. ZIP codes. Use ‘forecast7days’ for comprehensive weather planning, ‘forecast7daysSimple’ for quick daily overview.

Input Parameters

string
Location as free-form text query (e.g., ‘Berlin,Germany’ or ‘Tokyo,Japan’). Provide exactly one of: q, location, or zipCode.
string
Response language as IETF BCP-47 language tag (e.g., ‘en-US’ for English, ‘fr-FR’ for French, ‘de-DE’ for German). Affects weather descriptions and text.
string ("metric" | "imperial")
Measurement system. One of ‘metric’ (default) or ‘imperial’.
string
U.S. ZIP code for location (e.g., ‘90210’ for Beverly Hills). Only works for U.S. locations. Provide exactly one of: q, location, or zipCode.
string
Geographic coordinates as ‘latitude,longitude’ in WGS-84 format (e.g., ‘40.7128,-74.0060’ for NYC). Provide exactly one of: q, location, or zipCode.
string ("forecast7days" | "forecast7daysSimple")
required
Forecast product type: ‘forecast7days’ returns detailed segment-level forecasts (morning/afternoon/evening/night) with full weather data, ‘forecast7daysSimple’ returns one summary per day with high/low temps and UV index.
string
Political view for disputed territories as ISO 3166-1 alpha-3 country code (e.g., ‘CHN’ for China, ‘IND’ for India). Affects how borders/territories are represented.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HERE_GET_WEATHER_OBSERVATIONTool to retrieve current weather observation. Use after determining a specific location to get up-to-date weather conditions.

Input Parameters

string
Free-text location query (e.g., ‘Berlin, Germany’)
string
Response language (BCP-47 language tag, e.g., ‘en-US’)
string ("metric" | "imperial")
Units of measurement: ‘metric’ (SI) or ‘imperial’
string
US ZIP code (e.g., ‘10001’)
string
Latitude,longitude pair in WGS-84 format (e.g., ‘52.52,13.4050’)
string
Political view (ISO country code) for disputed territories

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HERE_IMPORT_ROUTEImport and calculate a route from a sequence of GPS trace points. The response can include route sections, summaries, polylines, actions, and notices when available or requested.

Input Parameters

array
List of via waypoints specifying indices in the trace array that must be passed through.
array
List of preferred languages for response (IETF BCP 47 format, e.g., [‘en-US’, ‘de-DE’]). First supported language will be used.
array
Map content attributes to include in response spans (e.g., attributes, length, countryCode). Requires polyline in return parameter.
array
required
List of GPS trace points defining the route path. Minimum 2 points required, maximum 50,000 points allowed.
string ("metric" | "imperial")
Units of measurement for guidance instructions.
array
Attributes to include in response. Options: polyline, actions, instructions, summary, travelSummary, turnByTurnActions, mlDuration, typicalDuration, elevation, routeHandle, passthrough, incidents, routingZones, truckRoadTypes, tolls. Note: actions requires polyline; instructions requires actions; turnByTurnActions requires polyline.
string
Departure time in RFC 3339 format (e.g., ‘2019-06-24T01:23:45’). Use ‘any’ to ignore time. If omitted, current time at departure is used.
string ("car" | "truck" | "pedestrian" | "bicycle" | "scooter" | "taxi" | "bus" | "privateBus")
required
Mode of transport for route calculation. Note: bicycle, bus, privateBus, and taxi are Beta with limited functionality.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HERE_LOCATE_DEVICEEstimate a device’s location from WiFi or cellular network measurements instead of GPS. Supports GSM, WCDMA, TD-SCDMA, LTE, CDMA, and WLAN measurements; at least one measurement type is required.

Input Parameters

array
GSM cell measurements (GERAN, 2G). Minimum 1, maximum 16 items. At least one of gsm, wcdma, tdscdma, lte, cdma, or wlan must be provided.
array
LTE cell measurements (E-UTRA, 4G). Minimum 1, maximum 16 items. At least one of gsm, wcdma, tdscdma, lte, cdma, or wlan must be provided.
array
CDMA cell measurements (CDMA2000). Minimum 1, maximum 16 items. At least one of gsm, wcdma, tdscdma, lte, cdma, or wlan must be provided.
array
WLAN access point measurements. Minimum 1, maximum 256 items. For privacy, positioning based on a single WLAN AP requires fallback=singleWifi. At least one of gsm, wcdma, tdscdma, lte, cdma, or wlan must be provided.
array
WCDMA cell measurements (UTRA-FDD, 3G UMTS). Minimum 1, maximum 16 items. At least one of gsm, wcdma, tdscdma, lte, cdma, or wlan must be provided.
object
required
Information about the client device and software.
array
Additional data fields to include in the response if data is available. Supports value ‘altitude’.
array
TD-SCDMA cell measurements (UTRA-TDD, 3G UMTS TDD). Minimum 1, maximum 16 items. At least one of gsm, wcdma, tdscdma, lte, cdma, or wlan must be provided.
array
Acceptable fallback options for cell and WLAN positioning. Values ‘area’ and ‘any’ apply to cell based positioning, and value ‘singleWifi’ applies to WLAN based positioning.
array
Additional data fields that must be included in the response. If the data is not available, the response contains an error message. Supports value ‘altitude’.
integer
Confidence level in percent for the accuracy/uncertainty in the location estimate response. If not specified, the default is 68 (this corresponds to a 68%% probability that the true position is within the accuracy/uncertainty radius: the higher the number, the greater the confidence level).
string
ID used for correlating customer requests within HERE services. Used for logging and error reporting. Can be any string, but UUID is recommended.
string ("gzip")
Content encoding types for request body.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HERE_LOOKUPLook up a place or address by HERE ID and return structured location details, including address and coordinates, with categories, contacts, and references when available.

Input Parameters

string
required
HERE location identifier to look up. Must be a valid HERE ID obtained from geocoding, search, or discovery endpoints. Supports place IDs (e.g., ‘here:pds:place:…’) and address IDs (e.g., ‘here:af:streetsection:…’).
string
Language code for localized results (BCP-47 format, e.g., ‘en-US’, ‘de-DE’, ‘fr-FR’). If not specified, defaults to the location’s native language.
string
Comma-separated list of additional data sections to include. Use ‘tz’ to include timezone information.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HERE_POST_ROUTESCalculates HERE routes between an origin and destination for car, truck, pedestrian, bicycle, scooter, taxi, bus, and private bus modes. Optional waypoints, timing, alternatives, segment avoidance, preferred charging brands, and segment speed restrictions can help tailor the route.

Input Parameters

object
EV parameters for electric vehicle routing
array
Via waypoints in format ‘{lat},{lng}[PlaceOptions][WaypointOptions]’. Route will traverse these sequentially.
array
List of preferred languages (IETF BCP 47). First supported language will be used. Example: [‘zh-tw’, ‘en-gb’]
object
Avoid routes through specified areas or segments
array
Map content attributes for spans (e.g., ‘attributes’, ‘length’). Requires ‘polyline’ in return parameter.
string ("metric" | "imperial")
Units of measurement for guidance instructions. Default is ‘metric’.
string
required
Origin location in format ‘{lat},{lng}[PlaceOptions][WaypointOptions]’. Example: ‘52.5200,13.4050’
array
Route/section attributes to include: ‘polyline’, ‘actions’, ‘instructions’, ‘summary’, ‘travelSummary’, ‘turnByTurnActions’, ‘elevation’, ‘routeHandle’, ‘incidents’, ‘tolls’, etc. Note: ‘actions’ requires ‘polyline’.
string
ISO 4217 currency code for toll cost calculation. If not provided, router specifies local currency.
string
Arrival time in RFC 3339 format. Not supported for EV routing, route handle, or route import.
string
required
Destination location in format ‘{lat},{lng}[PlaceOptions][WaypointOptions]’. Example: ‘50.1109,8.6821’
string ("fast" | "short")
Optimization type: ‘fast’ optimizes by travel time, ‘short’ minimizes distance. Note: bicycle, bus, pedestrian, privateBus, scooter, taxi only support ‘fast’.
integer
Number of alternative routes to return aside from optimal route.
string
Departure time in RFC 3339 format (e.g., ‘2019-06-24T01:23:45’). Special value ‘any’ means time-independent routing.
string ("car" | "truck" | "pedestrian" | "bicycle" | "scooter" | "taxi" | "bus" | "privateBus")
required
Mode of transport for route calculation. Note: bicycle, bus, privateBus, and taxi modes are Beta with limited functionality.
number
Walking speed in meters per second. Influences duration of walking segments.
array
Segments with maximum base speed restrictions. Max 250 penalized segments total.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HERE_REVERSE_GEOCODEConverts geographic coordinates (latitude, longitude) into human-readable addresses and location details. Use this tool when you need to: - Find the street address for a specific GPS coordinate - Identify what place or building is at a location - Get detailed address components (street, city, postal code, country) - Determine timezone information for coordinates Returns structured address data including full labels, administrative divisions, and distance from query point. Supports worldwide coverage with responses in multiple languages.

Input Parameters

string
required
Geographic coordinates to reverse geocode, formatted as ‘latitude,longitude’ (e.g., ‘52.5160,13.3779’ for Berlin). Use decimal degrees with up to 5 decimal places for precision.
string
Preferred language for the response using BCP-47 language tags (e.g., ‘en-US’ for English, ‘de-DE’ for German, ‘ja-JP’ for Japanese). Affects address labels and place names.
string
Additional information to include in the response. Use ‘tz’ to include timezone data (name and UTC offset) for the location. Can be useful for determining local time at coordinates.
string
Navigation-specific attributes to include, such as ‘speedLimits’ for road speed limit information. Useful for routing and navigation applications.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HERE_SUBMIT_TOUR_PLANNING_PROBLEMSubmit a tour planning problem synchronously to solve vehicle routing problems with constraints like time windows, capacity, and vehicle types. Returns optimized tours for the fleet with routes, schedules, and statistics. Use when you need to optimize delivery/pickup routes for multiple vehicles.

Input Parameters

object
required
Plan containing jobs with delivery/pickup tasks and time windows.
object
required
Fleet definition with vehicle types and routing profiles.
object
Optional algorithm configuration including termination criteria.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HERE_SUBMIT_TOUR_PLANNING_PROBLEM_ASYNCSubmit a tour planning problem asynchronously for large-scale vehicle routing optimization. Returns a status ID to poll for results. Use this for complex problems with multiple vehicles, jobs, and constraints. Supports up to 3000 jobs and 150 vehicle types.

Input Parameters

object
required
Tour planning problem definition with jobs
object
required
Fleet configuration with vehicle types and profiles

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HERE_WEATHER_ALERTSRetrieve HERE severe weather alerts for a location specified by free-text query, coordinates, or US ZIP code. The request requires an API key and can include units, language, and political view.

Input Parameters

string
Free-text location query (e.g., ‘Berlin, Germany’)
object
GeoJSON FeatureCollection describing points or routes to check
string
Response language (IETF BCP-47 tag, e.g., ‘en-US’)
string ("metric" | "imperial")
Units of measurement: ‘metric’ or ‘imperial’
string
required
HERE API key for authentication
string
US ZIP code (e.g., ‘10001’)
string
Coordinates in ‘lat,lng’ WGS-84 format (e.g., ‘52.5200,13.4050’)
string
Political view (ISO country code) for disputed territories

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HERE_WEATHER_ASTRONOMYTool to fetch astronomical data (sunrise, sunset) for a specific location. Use when you need daily sun and moon event times.

Input Parameters

string
Free-text place query (e.g., ‘Riga, Latvia’).
string
IETF BCP-47 language tag for response (e.g., ‘en-US’).
string ("metric" | "imperial")
Measurement units: ‘metric’ (default) or ‘imperial’.
string
U.S. ZIP code (e.g., ‘90210’).
string
Coordinates as ‘latitude,longitude’ (e.g., ‘52.5251,13.3694’).
string
Filter hourly products by date ‘YYYY-MM-DD’.
string
ISO-3166-1 country code for disputed territories (e.g., ‘CHN’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HERE_WEATHER_FORECAST_HOURLYFetch hourly weather forecasts for a location specified by free-text query, US ZIP code, or coordinates. An API key must be supplied in the request.

Input Parameters

string
Free-text location query (e.g., ‘Berlin, Germany’)
string
IETF language tag for localized output (e.g., ‘en-US’)
string ("metric" | "imperial")
Measurement units: ‘metric’ (default) or ‘imperial’
string
required
HERE API key for authentication
string
U.S. ZIP code (e.g., ‘90210’), US only
string
Coordinates in ‘lat,lon’ WGS-84 format (e.g., ‘52.5200,13.4050’)
string
required
Must be ‘forecastHourly’ to retrieve hourly forecasts
string
Date (YYYY-MM-DD) for which hourly data is requested
string
Political view for disputed territories, ISO country code

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not