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

Tools

Slug: MAPBOX_GEOCODE_BATCH_V6Tool to perform batch geocoding with up to 1000 queries in a single request. Use when you need to geocode multiple locations efficiently (forward, reverse, or structured). Supports mixing query types in the same batch.

Input Parameters

array
required
Array of geocoding queries (1-1000 queries). Each query can be forward, reverse, or structured geocoding.

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: MAPBOX_GEOCODE_FORWARD_V5Tool to search for places by name or address using Mapbox Geocoding v5 API (forward geocoding). Use when you need to convert place names or addresses to geographic coordinates using the v5 endpoint.

Input Parameters

string
Bounding box to limit results. Format: minLon,minLat,maxLon,maxLat
integer
Maximum number of results (max 10).
string
Filter by feature types (country, region, place, address, etc.).
string
ISO 3166 alpha 2 country codes, comma-separated.
boolean
Include routable point metadata for addresses.
string ("mapbox.places" | "mapbox.places-permanent")
Either ‘mapbox.places’ or ‘mapbox.places-permanent’. Use mapbox.places for user-triggered queries, mapbox.places-permanent for batch/permanent geocoding.
string
IETF language tags, comma-separated.
boolean
Include building entrance data (public preview).
string
Bias results near coordinates. Format: longitude,latitude or ‘ip’
string ("ar" | "cn" | "in" | "jp" | "ma" | "rs" | "ru" | "tr" | "us")
Geopolitical perspective (ar, cn, in, jp, ru, tr, us, etc.).
boolean
Allows approximate matching.
string
required
The feature to look up (address, city, etc.). URL-encoded UTF-8, no semicolons, max 20 words, max 256 characters.
boolean
Returns results starting with query string.

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: MAPBOX_GEOCODING_BATCHTool to perform batch forward or reverse geocoding for multiple locations. Use when you need consistent geocoding of up to 50 queries in one call.

Input Parameters

string
Bounding box to restrict results: minLon,minLat,maxLon,maxLat.
integer
Maximum number of results per query (1–10).
string
Comma-separated list of feature types to limit results.
string
Filter results to one or more ISO 3166 alpha-2 country codes (comma-separated).
array
List of search text strings for forward geocoding (up to 50 entries).
boolean
Include routable point metadata for address features.
string
IETF language tag(s) for returned text (comma-separated).
string
Bias results toward a geographic location: lon,lat or ‘ip’.
string ("ar" | "cn" | "in" | "jp" | "ma" | "rs" | "ru" | "tr" | "us")
Viewworld to bias results (e.g., ‘us’, ‘cn’).
array
List of [lon, lat] pairs for reverse geocoding (up to 50 entries).
boolean
Whether to allow approximate string matching (forward only; default true).
boolean
Whether to return autocomplete results (forward only; default true).
string ("distance" | "score")
Reverse geocoding mode: ‘distance’ or ‘score’ (reverse only).

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: MAPBOX_GEOCODING_FORWARDTool to convert free-form or structured address into geographic coordinates and place features. Use when you need forward geocoding from text or address components.

Input Parameters

string
Free-form search text (URL-encoded, ≤256 chars, ≤20 tokens, no semicolons). Required if no structured fields are provided.
string
Limit results to a bounding box: ‘minLon,minLat,maxLon,maxLat’.
string
Block component (used in some countries like Japan).
integer
Maximum number of results (default 5, max 10).
string
City or municipality component for structured input.
string
Comma-separated filter of feature types: country, region, postcode, district, place, locality, neighborhood, street, address.
string ("geojson" | "v5")
Response format: ‘geojson’ (default) or ‘v5’ for backward compatibility.
string
State or region component for structured input.
string
Street name component for structured input.
string
ISO 3166-1 alpha-2 country code or full country name for structured input, or comma-separated list of codes to filter results.
string
Comma-separated IETF language tags affecting response text and ranking.
string
Postal code component for structured input.
boolean
Whether results may be stored permanently (default false).
string
Bias results to this ‘lon,lat’ or ‘ip’ for IP-based biasing.
string ("ar" | "cn" | "in" | "jp" | "ma" | "rs" | "ru" | "tr" | "us")
Boundary worldview for results (default ‘us’).
boolean
Return autocomplete results (default true).
string
Combined house number and street name for structured input.
string
House number component for structured input.

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: MAPBOX_GEOCODING_PERMANENT_FORWARDTool to perform permanent forward geocoding. Use when you need enterprise-grade permanent geocoding after confirming account privileges.

Input Parameters

string
Limit results to bounding box: minLon,minLat,maxLon,maxLat; cannot cross 180th meridian.
integer
Maximum number of results to return (1-10).
string
Comma-separated list of feature types: country,region,postcode,district,place,locality,neighborhood,address.
string
Comma-separated ISO 3166-1 alpha-2 country codes to limit results.
boolean
Request routable points metadata for address features.
string
Comma-separated IETF language tags (up to 20 unique) controlling language of results.
string
Bias results toward this location: ‘lon,lat’ or ‘ip’.
string ("ar" | "cn" | "in" | "jp" | "ma" | "rs" | "ru" | "tr" | "us")
Return features according to worldview; one of ar,cn,in,jp,ma,rs,ru,tr,us.
boolean
Allow approximate (fuzzy) matching.
string
required
URL-encoded UTF-8 search text (max 256 chars, max 20 tokens, no semicolons).
boolean
Include autocomplete results that start with the query string.

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: MAPBOX_GEOCODING_PERMANENT_REVERSEReverse geocode coordinates through Mapbox’s permanent geocoding endpoint to obtain cacheable place data. A Mapbox access token must be supplied in the request.

Input Parameters

integer
Max number of results; default=1; max=10. If >1, must specify exactly one types value.
string
Filter by one or more feature types: country, region, postcode, district, place, locality, neighborhood, address.
string
Limit results to one or more countries; comma-separated ISO 3166-1 alpha-2 codes.
boolean
If true, include navigation metadata for address features; adds ‘routable_points’.
string
IETF language tags (ISO 639-1 + optional subtags); comma-separated; up to 20 unique values.
number
required
Latitude in decimal degrees for the coordinate pair.
number
required
Longitude in decimal degrees for the coordinate pair.
string ("ar" | "cn" | "in" | "jp" | "ma" | "rs" | "ru" | "tr" | "us")
Regional/political boundary perspective. One of: ar, cn, in, jp, ma, rs, ru, tr, us.
string ("distance" | "score")
Sorting when multiple results requested: ‘distance’ (closest first, default) or ‘score’ (prominence based).
string
required
Mapbox access token.

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: MAPBOX_GEOCODING_REVERSETool to reverse geocode coordinates into place names. Use after obtaining coordinates.

Input Parameters

integer
Maximum number of results to return; default 1, max 10. If >1, exactly one ‘types’ value must be set.
string
Comma-separated feature types to include. Options: country, region, postcode, district, place, locality, neighborhood, address.
string
ISO 3166-1 alpha-2 country codes to limit results, comma-separated.
boolean
Include metadata for recommended navigation destination; only applicable for address features.
string
IETF BCP 47 language tags, comma-separated, controlling response language.
number
required
Latitude of the location to reverse geocode.
number
required
Longitude of the location to reverse geocode.
string ("ar" | "cn" | "in" | "jp" | "ma" | "rs" | "ru" | "tr" | "us")
Boundary worldview for disputed areas; one of ar, cn, in, jp, ma, rs, ru, tr, us.
string ("distance" | "score")
Sort strategy when multiple results requested; ‘distance’ (default) or ‘score’.

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: MAPBOX_GET_ACCESS_TOKENExtract a Mapbox access token from connection metadata and check its format for downstream use. The format check does not establish that the token is active or has the required scopes.

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: MAPBOX_GET_ISOCHRONETool to calculate areas reachable within a specified amount of time or distance from a location. Use when you need to visualize travel time or distance zones for routing analysis.

Input Parameters

number
Removes smaller contours. Range: 0.0-1.0, default: 1.0.
string
Comma-separated exclusions: ‘motorway’, ‘toll’, ‘ferry’, ‘unpaved’, ‘cash_only_tolls’. Available only for driving profiles.
string ("mapbox/driving-traffic" | "mapbox/driving" | "mapbox/walking" | "mapbox/cycling")
required
Routing profile: ‘mapbox/driving-traffic’, ‘mapbox/driving’, ‘mapbox/walking’, or ‘mapbox/cycling’.
boolean
Return GeoJSON polygons (true) or linestrings (false, default).
string
ISO 8601 formatted timestamp for traffic-aware routing (YYYY-MM-DDThh:mm:ssZ). Example: ‘2024-12-01T09:00:00Z’.
number
Douglas-Peucker generalization tolerance in meters (positive floating-point number).
string
required
Longitude,latitude coordinate pair around which to center the isochrone lines (e.g., ‘-118.22258,33.99038’).
string
Comma-separated hexadecimal color codes without # prefix (e.g., ‘ff0000,00ff00,0000ff’). Must match the quantity of contours.
string
Comma-separated list of 1-4 distance values in meters (1-100000) in increasing order. Required if contours_minutes is not provided. Example: ‘1000,2000,3000’.
string
Comma-separated list of 1-4 time values in minutes (1-60) in increasing order. Required if contours_meters is not provided. Example: ‘5,10,15’.

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: MAPBOX_GET_MAP_MATCHINGTool to snap fuzzy GPS traces to roads on the road network. Use when you need to clean up inaccurate location traces for display or analysis.

Input Parameters

boolean
Remove clusters and provide uniform sample rate to improve match quality.
boolean
Include turn-by-turn instructions in the response.
string ("mapbox/driving" | "mapbox/driving-traffic" | "mapbox/walking" | "mapbox/cycling")
required
Routing profile: mapbox/driving, mapbox/driving-traffic, mapbox/walking, or mapbox/cycling.
string
Semicolon-separated maximum snap distances in meters (0-50) for each coordinate. Use ‘unlimited’ for no limit.
string ("geojson" | "polyline" | "polyline6")
Response geometry format: geojson, polyline, or polyline6 (default: polyline).
string
Semicolon-separated Unix timestamps (in seconds) corresponding to each coordinate, used to improve matching.
string
Comma-separated list of additional metadata: distance, duration, speed, congestion.
string
required
Semicolon-separated longitude,latitude coordinate pairs (2-100 coordinates). Format: lon1,lat1;lon2,lat2;lon3,lat3

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: MAPBOX_GET_OPTIMIZATION_V1Calculate optimized trips visiting a set of waypoints using driving, traffic-aware driving, walking, or cycling profiles. Use to find an efficient order for visiting multiple locations.

Input Parameters

boolean
Include turn-by-turn step instructions.
string ("any" | "first")
Starting waypoint: ‘any’ allows any coordinate as start, ‘first’ uses first coordinate.
string ("mapbox/driving-traffic" | "mapbox/driving" | "mapbox/walking" | "mapbox/cycling")
required
Routing profile: driving-traffic, driving, walking, or cycling.
string
Semicolon-separated bearing pairs (angle,degrees) to influence direction. Requires radiuses parameter.
string
Language for instructions (requires steps=true).
string ("full" | "simplified" | "false")
Level of overview geometry detail.
string
Semicolon-separated snap distances in meters per coordinate, or ‘unlimited’ for any distance.
boolean
Return to starting point (default true). If false, requires source=first and destination=last.
string
Semicolon-separated approach sides for waypoints: ‘unrestricted’ or ‘curb’. Requires steps=true.
string ("geojson" | "polyline" | "polyline6")
Format of route geometry in response.
array
Return metadata annotations (duration, distance, speed). Requires overview=full.
array
required
Ordered list of 2–12 longitude/latitude waypoints for optimization.
string ("any" | "last")
Ending waypoint: ‘any’ allows any coordinate as end, ‘last’ uses last coordinate.
string
Semicolon-separated pick-up/drop-off pairs as coordinate indices (e.g., ‘0,1;2,3’). Max 25 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: MAPBOX_GET_SPRITETool to retrieve a sprite image or its JSON document from a Mapbox style. Use when you need sprite assets for rendering map icons. Sprites are collections of small icons used in map styles. The JSON format returns metadata about icon positions and dimensions within the sprite sheet, while the PNG format returns the actual image. Sprite sheets optimize performance by combining multiple icons into a single image.

Input Parameters

string ("" | "@2x" | "@3x")
Scale factor for high-density displays. Use ” (standard) for 1x resolution, ‘@2x’ for 2x retina displays, or ‘@3x’ for 3x displays. Only applicable for high-DPI screens.
string ("json" | "png")
required
Return format: ‘json’ returns sprite metadata with icon positions and dimensions, ‘png’ returns the actual sprite image.
string
required
The ID of the style to which the sprite belongs. Common Mapbox styles include: ‘streets-v12’, ‘dark-v11’, ‘light-v11’, ‘satellite-v9’, ‘outdoors-v12’.
string
required
The username of the account to which the style belongs. Use ‘mapbox’ for official Mapbox styles like ‘streets-v12’, ‘dark-v11’, ‘light-v11’, ‘satellite-v9’.

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: MAPBOX_GET_STATIC_IMAGERequest a static map image from a Mapbox Studio style. Returns a PNG or JPEG image of the specified map area with customizable parameters including location, zoom level, camera angle, and optional overlays like markers or GeoJSON features. Use when you need to generate static map images for embedding in documents, emails, or web pages without interactive map functionality.

Input Parameters

number
required
Latitude coordinate for the center of the map image, must be between -85.0511 and 85.0511 (Web Mercator limits).
number
required
Longitude coordinate for the center of the map image, must be between -180 and 180.
number
required
Zoom level for the map, must be between 0 (world view) and 22 (maximum detail).
number
Camera pitch (tilt) in degrees, must be between 0 (looking straight down) and 60 (maximum tilt). Default is 0.
integer
required
Image width in pixels, must be between 1 and 1280.
integer
required
Image height in pixels, must be between 1 and 1280.
boolean
Request a retina (@2x) resolution image. When true, returns an image with double the specified width and height for high-DPI displays. Default is false.
number
Camera bearing (rotation) in degrees, must be between 0 and 359. Default is 0 (north-up).
string
Optional overlay to add to the map, such as GeoJSON features, markers, paths, or polygons. Must be properly URL-encoded. Examples: markers (pin-s-l+f00(lon,lat)), GeoJSON (geojson({…})), paths (path-5+f00-0.5(…)).
string
required
Unique identifier of the style to use for the map. Common Mapbox styles include: ‘streets-v12’ (detailed street map), ‘dark-v11’ (dark theme), ‘light-v11’ (light theme), ‘satellite-v9’ (satellite imagery), ‘outdoors-v12’ (topographic), ‘navigation-day-v1’, ‘navigation-night-v1’.
string
required
Mapbox account username that owns the style. Use ‘mapbox’ for official Mapbox styles like ‘streets-v12’, ‘dark-v11’, ‘light-v11’, ‘satellite-v9’.

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: MAPBOX_GET_STATIC_TILESTool to retrieve raster tiles from a Mapbox Studio style. Use when you need map tiles for specific coordinates and zoom levels. Returns PNG or JPG raster tiles that can be assembled to create map visualizations. Tiles follow the XYZ tiling scheme where the world is divided into a grid at each zoom level. Supports retina/high-DPI displays via the @2x suffix.

Input Parameters

integer
required
Tile X coordinate at the specified zoom level. Valid range depends on zoom level (0 to 2^z - 1).
integer
required
Tile Y coordinate at the specified zoom level. Valid range depends on zoom level (0 to 2^z - 1).
integer
required
Zoom level for the tile. Valid range is 0 to 22, where 0 is the most zoomed out (world view) and 22 is the most zoomed in.
boolean
If true, return high-DPI/retina display tile (@2x). This doubles the resolution of the returned tile.
string
required
The ID of the style. Common styles include ‘satellite-v9’ (satellite imagery), ‘streets-v12’ (detailed streets), ‘dark-v11’ (dark theme), ‘light-v11’ (light theme), ‘outdoors-v12’ (topographic).
integer
required
Size of the returned raster tile in pixels. Must be one of: 256 or 512. Default is 512.
string
required
The username of the style owner. Use ‘mapbox’ for official Mapbox 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: MAPBOX_GET_TOKENTool to retrieve information about a Mapbox access token and validate its status. Use when you need to check token validity or retrieve token metadata.

Input Parameters

string
required
The access token to retrieve and validate. Must be a valid Mapbox token.

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: MAPBOX_GET_VECTOR_TILESTool to retrieve vector tiles from Mapbox-hosted vector tilesets. Use when you need tile data for mapping applications at specific zoom levels and coordinates.

Input Parameters

integer
required
The x-coordinate of the tile
integer
required
The y-coordinate of the tile
integer
required
The zoom level for the tile (0-22)
string
Optional style URL to optimize vector tiles for a specific style
string ("mvt" | "vector.pbf" | "pbf")
The file format for the tile (mvt for Mapbox Vector Tile format, vector.pbf for legacy format, pbf for protocol buffer format)
string
required
The identifier for the Mapbox-hosted vector tileset (e.g., mapbox.mapbox-streets-v8)

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: MAPBOX_POST_MAP_MATCHINGTool to snap GPS coordinates to the road network using POST method for longer coordinate lists. Use when you have GPS traces to match to roads (2-100 coordinates).

Input Parameters

boolean
Remove clusters and resample traces for smoother matching.
boolean
Include turn-by-turn instructions in response.
string
Comma-separated restrictions to ignore: access, oneways, restrictions.
string ("mapbox/driving" | "mapbox/driving-traffic" | "mapbox/walking" | "mapbox/cycling")
required
Routing profile: mapbox/driving, mapbox/driving-traffic, mapbox/walking, or mapbox/cycling.
string
Language code for instructions (requires steps=true).
string ("full" | "simplified" | "false")
Level of geometry detail: full, simplified (default), or false.
string
Semicolon-separated max snap distances in meters per coordinate (0-50, use ‘unlimited’ for no limit).
string
ISO 8601 departure time for traffic-aware routing (requires driving-traffic profile).
string
Semicolon-separated zero-based indices of coordinates to treat as waypoints.
string
Semicolon-separated approach sides per waypoint: ‘unrestricted’ or ‘curb’.
string ("geojson" | "polyline" | "polyline6")
Format of route geometry: geojson, polyline (default), or polyline6.
string
Semicolon-separated Unix timestamps matching each coordinate for time-based matching.
string
Comma-separated metadata to include: distance, duration, speed, congestion, maxspeed. Requires overview=full.
string
required
Semicolon-separated longitude,latitude pairs (2-100 coordinates). Example: ‘-117.17282,32.71204;-117.17288,32.71225’
string ("tomtom" | "here")
OpenLR specification format: tomtom (default) or here.
string ("imperial" | "british_imperial" | "metric")
Unit system for voice instructions: imperial, british_imperial, or metric.
string
required
Mapbox access token for authentication.
string
Binary format for OpenLR: tomtom (default).
string
Semicolon-separated custom names for waypoints.
boolean
Emit separate instructions for roundabout entry and exit.
boolean
Return OpenLR location references for matched segments.
boolean
Return SSML voice guidance instructions.
boolean
Return banner instruction objects (requires steps=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: MAPBOX_QUERY_TILE_FEATURESTool to retrieve data about specific features from vector tilesets based on a location. Use when you need to query tileset features at a geographic point, such as finding buildings, roads, or points of interest near coordinates.

Input Parameters

number
required
Latitude coordinate to query.
number
required
Longitude coordinate to query.
string
Comma-separated list of band names for filtering rasterarray tileset results.
integer
Number of features to return, between 1 and 50. Default is 5.
boolean
Whether to de-duplicate features by ID. Default is true.
string
Comma-separated list of layer IDs to query. If not specified, queries all layers.
number
Approximate distance in meters to query for features. Default is 0 for point-in-polygon queries.
string ("point" | "linestring" | "polygon")
Filter by feature geometry type. If not specified, queries all geometry types.
string
required
The tileset ID to query (e.g., ‘mapbox.mapbox-streets-v8’). Can be comma-separated list for compositing.

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: MAPBOX_REQUEST_STYLE_EMBED_HTMLRetrieve embeddable HTML for a Mapbox style that can be embedded in an iframe. Returns a complete HTML document with Mapbox GL JS code that renders an interactive map with the specified style. Useful for quickly embedding Mapbox maps into web pages without custom JavaScript code.

Input Parameters

string ("copy" | "view")
Display a title box at the bottom of the map: ‘copy’ shows a button to copy the style to your account, ‘view’ shows a sign-up button. Leave null to hide the title box.
string
required
Style ID for which to return the embeddable HTML. Common Mapbox styles include streets-v12, satellite-streets-v12, outdoors-v12, light-v11, and dark-v11.
boolean
Serve a fallback raster map (true) or not (false).
string
required
Mapbox account username that owns the style. Use ‘mapbox’ for Mapbox’s standard public styles like streets-v12, satellite-v9, etc.
boolean
Enable mouse-wheel zoom (true) or disable (false).
string
Specific version of Mapbox GL JS library to use (e.g., ‘3.0.0’). Leave null to use the default latest stable version.
string
Specific version of the Mapbox GL Geocoder plugin for the search box (e.g., ‘5.0.0’). Leave null to use the default version.

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: MAPBOX_RETRIEVE_DIRECTIONSRetrieve directions between waypoints, with optional turn-by-turn instructions. A Mapbox access token must be supplied in the request.

Input Parameters

boolean
Include turn-by-turn step instructions.
string ("mapbox/driving-traffic" | "mapbox/driving" | "mapbox/walking" | "mapbox/cycling")
required
Routing profile: driving-traffic, driving, walking, or cycling.
string
Language for instructions (requires steps=true).
string ("full" | "simplified" | "false")
Level of overview geometry detail.
string ("geojson" | "polyline" | "polyline6")
Format of route geometry in response.
array
required
Ordered list of 2–25 longitude/latitude waypoints.
string
required
Mapbox access token for authentication.
boolean
Return up to two alternative routes if 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: MAPBOX_RETRIEVE_FONT_GLYPH_RANGESTool to retrieve font glyph ranges as PBF tiles. Use when you have confirmed the font name, codepoint range, and valid token.

Input Parameters

integer
required
End of codepoint range; must equal start + 255
string
required
Font name or comma-separated list (max 10 faces)
integer
required
Start of codepoint range; must be a multiple of 256
string
required
Mapbox account username that owns the font

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: MAPBOX_RETRIEVE_MARKERTool to retrieve a standalone marker image without any background map. Returns a PNG image file of the specified marker type. Use when you need to obtain marker icons for display or reference purposes.

Input Parameters

string
required
The marker type identifier. Common values: ‘pin-s’ (small pin), ‘pin-m’ (medium pin), ‘pin-l’ (large pin). The marker name determines the size and style of the marker image.

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: MAPBOX_RETRIEVE_MATRIXRetrieve a travel time and/or distance matrix between multiple locations. Results cover the selected origins and destinations, with durations in seconds and distances in meters when requested.

Input Parameters

string ("mapbox/driving" | "mapbox/walking" | "mapbox/cycling" | "mapbox/driving-traffic")
required
Transportation mode for routing: ‘mapbox/driving’ (car), ‘mapbox/walking’ (pedestrian), ‘mapbox/cycling’ (bicycle), or ‘mapbox/driving-traffic’ (car with live traffic, max 10 coords).
string
Which coordinates to use as origins (starting points). Use ‘all’ (default) for all coordinates, or semicolon-separated 0-based indices (e.g., ‘0;2;4’ for coords at index 0, 2, and 4).
string
Semicolon-separated ‘angle,deviation’ pairs per waypoint; angle 0–360, deviation in degrees; skip with ’;’.
string
BETA: desired departure time in ISO 8601 format (e.g., YYYY-MM-DDThh:mm:ssZ).
string
Semicolon-separated list per waypoint: ‘unrestricted’ or ‘curb’. Count must match number of coordinates; skip entries with ’;’.
string ("duration" | "distance" | "duration,distance")
Data to return in the matrix: ‘duration’ (travel time in seconds), ‘distance’ (travel distance in meters), or ‘duration,distance’ (both). Default: ‘duration’.
array
required
List of 2-25 geographic points (longitude, latitude pairs). The API calculates travel times/distances between these points. Maximum 10 for ‘mapbox/driving-traffic’ profile.
string
Mapbox access token (optional; auto-provided by auth).
string
Which coordinates to use as destinations (ending points). Use ‘all’ (default) for all coordinates, or semicolon-separated 0-based indices (e.g., ‘1;3;5’ for coords at index 1, 3, and 5).
integer
Speed in km/h for straight-line distance estimates when no routable path exists between points (e.g., across water). Must be > 0 if 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: MAPBOX_RETRIEVE_SEARCHBOX_PLACETool to retrieve full details for a specific place by its Mapbox ID. Use when you have a mapbox_id from a search suggestion and need complete place information.

Input Parameters

string
IETF language tag or comma-separated list of language codes to specify the language for results.
string
required
The Mapbox ID of the feature to retrieve, obtained from a /suggest endpoint response.
string
required
Session token to group requests together for billing purposes (UUID format).

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: MAPBOX_RETRIEVE_STYLERetrieve a Mapbox style’s details, including its layers, sources, sprite URL, and glyph URL, for inspecting or analyzing map configurations.

Input Parameters

string
required
Unique identifier of the style to retrieve. Common Mapbox styles include: ‘streets-v12’ (detailed street map), ‘dark-v11’ (dark theme), ‘light-v11’ (light theme), ‘satellite-v9’ (satellite imagery), ‘outdoors-v12’ (topographic), ‘navigation-day-v1’, ‘navigation-night-v1’.
string
required
Mapbox account username that owns the style. Use ‘mapbox’ for official Mapbox styles like ‘streets-v12’, ‘dark-v11’, ‘light-v11’, ‘satellite-v9’.

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: MAPBOX_RETRIEVE_STYLE_WMTSRetrieve a WMTS (Web Map Tile Service) capabilities document for a Mapbox style. This action returns an OGC-compliant WMTS XML document that describes how to access map tiles for the specified style. The document includes tile matrix sets, supported coordinate systems (EPSG:3857), and tile URL templates. Use this when integrating Mapbox styles with desktop GIS applications (ArcGIS, QGIS, CARTO, Tableau) or any WMTS-compliant mapping client. The WMTS endpoint works with both Mapbox’s official styles (e.g., streets-v12, satellite-v9) and custom styles created in Mapbox Studio.

Input Parameters

string
required
Style ID for which to return the WMTS document. Common Mapbox styles include: streets-v12 (vector streets), satellite-v9 (raster satellite imagery), outdoors-v12 (outdoor/terrain), dark-v11, light-v11, and navigation-day-v1.
string
required
Mapbox account username that owns the style. Use ‘mapbox’ for Mapbox’s official styles like streets-v12, satellite-v9, or outdoors-v12.

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: MAPBOX_RETRIEVE_TILESET_METADATATool to retrieve metadata for a Mapbox tileset. Use when you need TileJSON details including bounds, zooms, and layer info.

Input Parameters

boolean
If true, return HTTPS URLs in the TileJSON ‘tiles’ array.
string
required
Tileset identifier in the format ‘username.tilesetid’. For multiple tilesets, provide a comma-separated list (max 15).

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: MAPBOX_REVERSE_GEOCODE_V6Tool to convert geographic coordinates to place names using Geocoding v6 API. Use when you need to perform reverse geocoding from latitude/longitude coordinates.

Input Parameters

string
Comma-separated filter of feature types: country, region, postcode, district, place, locality, neighborhood, street, address.
string
Filter results by ISO 3166-1 alpha-2 country codes, comma-separated.
string
Specify the IETF BCP 47 language tag for results, comma-separated.
number
required
The latitude coordinate of the location to reverse geocode.
number
required
The longitude coordinate of the location to reverse geocode.
string ("ar" | "cn" | "in" | "jp" | "ma" | "rs" | "ru" | "tr" | "us")
Specify the worldview for disputed boundaries: ar, cn, in, jp, ma, rs, ru, tr, us.

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: MAPBOX_REVERSE_SEARCHBOXTool to convert coordinates to places using the Search Box API (reverse geocoding). Use when you need to find place names, addresses, or points of interest for given coordinates.

Input Parameters

integer
Quantity of results to return (maximum 10).
string
Comma-separated list of feature types to filter results: country, region, postcode, district, place, city, locality, street, address, etc.
string
Comma-separated list of ISO 3166 alpha-2 country codes to limit results.
string
ISO language code for results (default: English). Use IETF language tags.
number
required
The latitudinal coordinate for the reverse query.
number
required
The longitudinal coordinate for the reverse query.

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: MAPBOX_SEARCH_BOX_FORWARDTool to search for places by name or address using the Search Box API. Use when you need to find locations, addresses, or points of interest based on a text query.

Input Parameters

string
required
The user’s query string to search for places by name or address (limited to 256 characters).
string
Bounding box to constrain results: ‘minLon,minLat,maxLon,maxLat’.
integer
Maximum number of results to return (maximum 10).
string
Comma-separated feature types to filter results (address, poi, place, etc.).
string
Comma-separated ISO 3166-1 alpha-2 country codes to filter results.
string
ISO language code for results (e.g., ‘en’, ‘es’, ‘fr’). Defaults to English.
string
Location bias using ‘ip’ for IP-based biasing or ‘longitude,latitude’ coordinates.
string
Comma-separated POI categories to filter results.
boolean
Set to true for fuzzy/partial matching and autocomplete results.

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: MAPBOX_SEARCH_CATEGORYTool to search for places by category (e.g., restaurants, hotels, coffee shops). Use when you need to find POIs in a specific category, optionally filtered by location, bounding box, or proximity.

Input Parameters

string
Limit results to only those contained within the supplied bounding box (format: min_lon,min_lat,max_lon,max_lat).
integer
The number of results to return, up to 25.
string
Polyline-encoded route for search-along-route queries.
string
A comma-separated list of ISO 3166 alpha 2 country codes to limit results.
string
required
The canonical category ID or name to search for (e.g., restaurant, coffee, hotel).
string
The ISO language code to be returned. If not provided, the default is English.
string
Enable search-along-route functionality with value ‘isochrone’.
string
Bias results toward closer locations using either ‘ip’ or longitude,latitude coordinates.
string ("polyline" | "polyline6")
Specify route polyline precision as ‘polyline’ or ‘polyline6’.
number
Maximum detour allowed in estimated minutes from the route.
string
A comma-separated list of canonical category names that limits POI results by excluding specified categories.

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: MAPBOX_SUGGEST_SEARCHBOXTool to get autocomplete suggestions for a partial search query. Use when you need address or place suggestions as users type, before retrieving full details.

Input Parameters

string
required
The user’s query string. The query is limited to 256 characters.
string
Restrict results within a bounding box: ‘minLon,minLat,maxLon,maxLat’ (4 comma-separated coordinates).
integer
Number of results to return, maximum of 10.
string
Filter by feature types: country, region, postcode, district, place, locality, neighborhood, street, address, poi, category.
string
Location for distance calculations in ‘longitude,latitude’ format.
string
Comma-separated list of ISO 3166 alpha-2 country codes to filter results.
string
Set to ‘navigation’ to enable ETA calculations for results.
string
ISO 639-1 language code for results; defaults to English if not specified.
string
Bias the response to favor results closer to a specific location. Use ‘ip’ for IP-based location or ‘longitude,latitude’ format.
string
Limit results to specified POI categories (comma-separated).
string
required
A customer-provided session token value, which groups a series of requests together for billing purposes.
string
Routing profile when ETA enabled: driving, walking, or cycling.
string
Exclude results from specified POI categories (comma-separated).

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