# Mapbox

Mapbox is a platform that provides mapping, navigation, and location data services for developers to integrate into their applications.

- **Category:** developer tools
- **Auth:** API_KEY
- **Composio Managed App Available?** N/A
- **Tools:** 32
- **Triggers:** 0
- **Slug:** `MAPBOX`
- **Version:** 20260312_00

## Tools

### Batch Geocode V6

**Slug:** `MAPBOX_GEOCODE_BATCH_V6`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `queries` | array | Yes | Array of geocoding queries (1-1000 queries). Each query can be forward, reverse, or structured geocoding. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Forward Geocode V5

**Slug:** `MAPBOX_GEOCODE_FORWARD_V5`

Tool 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

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Batch Geocoding

**Slug:** `MAPBOX_GEOCODING_BATCH`

Tool 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

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Forward Geocoding

**Slug:** `MAPBOX_GEOCODING_FORWARD`

Tool 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

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Permanent Forward Geocoding

**Slug:** `MAPBOX_GEOCODING_PERMANENT_FORWARD`

Tool to perform permanent forward geocoding. Use when you need enterprise-grade permanent geocoding after confirming account privileges.

#### Input Parameters

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Permanent Reverse Geocoding

**Slug:** `MAPBOX_GEOCODING_PERMANENT_REVERSE`

Tool to perform permanent reverse geocoding. Use after obtaining coordinates to get cacheable place data. Example: lon=-73.989, lat=40.733

#### Input Parameters

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Reverse Geocoding

**Slug:** `MAPBOX_GEOCODING_REVERSE`

Tool to reverse geocode coordinates into place names. Use after obtaining coordinates.

#### Input Parameters

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Access Token

**Slug:** `MAPBOX_GET_ACCESS_TOKEN`

Tool to extract and validate Mapbox access token from connection metadata. Use when you need a valid token for downstream actions.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Isochrone

**Slug:** `MAPBOX_GET_ISOCHRONE`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `denoise` | number | No | Removes smaller contours. Range: 0.0-1.0, default: 1.0. |
| `exclude` | string | No | Comma-separated exclusions: 'motorway', 'toll', 'ferry', 'unpaved', 'cash_only_tolls'. Available only for driving profiles. |
| `profile` | string ("mapbox/driving-traffic" | "mapbox/driving" | "mapbox/walking" | "mapbox/cycling") | Yes | Routing profile: 'mapbox/driving-traffic', 'mapbox/driving', 'mapbox/walking', or 'mapbox/cycling'. |
| `polygons` | boolean | No | Return GeoJSON polygons (true) or linestrings (false, default). |
| `depart_at` | string | No | ISO 8601 formatted timestamp for traffic-aware routing (YYYY-MM-DDThh:mm:ssZ). Example: '2024-12-01T09:00:00Z'. |
| `generalize` | number | No | Douglas-Peucker generalization tolerance in meters (positive floating-point number). |
| `coordinates` | string | Yes | Longitude,latitude coordinate pair around which to center the isochrone lines (e.g., '-118.22258,33.99038'). |
| `contours_colors` | string | No | Comma-separated hexadecimal color codes without # prefix (e.g., 'ff0000,00ff00,0000ff'). Must match the quantity of contours. |
| `contours_meters` | string | No | 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'. |
| `contours_minutes` | string | No | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Map Matching

**Slug:** `MAPBOX_GET_MAP_MATCHING`

Tool 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

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Optimization V1

**Slug:** `MAPBOX_GET_OPTIMIZATION_V1`

Tool to calculate optimal driving routes and trips that visit a set of waypoints. Use when you need to find the best order to visit multiple locations with optimized routing.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `steps` | boolean | No | Include turn-by-turn step instructions. |
| `source` | string ("any" | "first") | No | Starting waypoint: 'any' allows any coordinate as start, 'first' uses first coordinate. |
| `profile` | string ("mapbox/driving-traffic" | "mapbox/driving" | "mapbox/walking" | "mapbox/cycling") | Yes | Routing profile: driving-traffic, driving, walking, or cycling. |
| `bearings` | string | No | Semicolon-separated bearing pairs (angle,degrees) to influence direction. Requires radiuses parameter. |
| `language` | string | No | Language for instructions (requires steps=true). |
| `overview` | string ("full" | "simplified" | "false") | No | Level of overview geometry detail. |
| `radiuses` | string | No | Semicolon-separated snap distances in meters per coordinate, or 'unlimited' for any distance. |
| `roundtrip` | boolean | No | Return to starting point (default true). If false, requires source=first and destination=last. |
| `approaches` | string | No | Semicolon-separated approach sides for waypoints: 'unrestricted' or 'curb'. Requires steps=true. |
| `geometries` | string ("geojson" | "polyline" | "polyline6") | No | Format of route geometry in response. |
| `annotations` | array | No | Return metadata annotations (duration, distance, speed). Requires overview=full. |
| `coordinates` | array | Yes | Ordered list of 2–12 longitude/latitude waypoints for optimization. |
| `destination` | string ("any" | "last") | No | Ending waypoint: 'any' allows any coordinate as end, 'last' uses last coordinate. |
| `distributions` | string | No | Semicolon-separated pick-up/drop-off pairs as coordinate indices (e.g., '0,1;2,3'). Max 25 per request. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Sprite

**Slug:** `MAPBOX_GET_SPRITE`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `scale` | string ("" | "@2x" | "@3x") | No | 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. |
| `format` | string ("json" | "png") | Yes | Return format: 'json' returns sprite metadata with icon positions and dimensions, 'png' returns the actual sprite image. |
| `style_id` | string | Yes | The ID of the style to which the sprite belongs. Common Mapbox styles include: 'streets-v12', 'dark-v11', 'light-v11', 'satellite-v9', 'outdoors-v12'. |
| `username` | string | Yes | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Static Image

**Slug:** `MAPBOX_GET_STATIC_IMAGE`

Request 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `lat` | number | Yes | Latitude coordinate for the center of the map image, must be between -85.0511 and 85.0511 (Web Mercator limits). |
| `lon` | number | Yes | Longitude coordinate for the center of the map image, must be between -180 and 180. |
| `zoom` | number | Yes | Zoom level for the map, must be between 0 (world view) and 22 (maximum detail). |
| `pitch` | number | No | Camera pitch (tilt) in degrees, must be between 0 (looking straight down) and 60 (maximum tilt). Default is 0. |
| `width` | integer | Yes | Image width in pixels, must be between 1 and 1280. |
| `height` | integer | Yes | Image height in pixels, must be between 1 and 1280. |
| `retina` | boolean | No | 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. |
| `bearing` | number | No | Camera bearing (rotation) in degrees, must be between 0 and 359. Default is 0 (north-up). |
| `overlay` | string | No | 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(...)). |
| `style_id` | string | Yes | 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'. |
| `username` | string | Yes | Mapbox account username that owns the style. Use 'mapbox' for official Mapbox styles like 'streets-v12', 'dark-v11', 'light-v11', 'satellite-v9'. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Static Tiles

**Slug:** `MAPBOX_GET_STATIC_TILES`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `x` | integer | Yes | Tile X coordinate at the specified zoom level. Valid range depends on zoom level (0 to 2^z - 1). |
| `y` | integer | Yes | Tile Y coordinate at the specified zoom level. Valid range depends on zoom level (0 to 2^z - 1). |
| `z` | integer | Yes | 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. |
| `retina` | boolean | No | If true, return high-DPI/retina display tile (@2x). This doubles the resolution of the returned tile. |
| `style_id` | string | Yes | 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). |
| `tilesize` | integer | Yes | Size of the returned raster tile in pixels. Must be one of: 256 or 512. Default is 512. |
| `username` | string | Yes | The username of the style owner. Use 'mapbox' for official Mapbox styles. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Token Information

**Slug:** `MAPBOX_GET_TOKEN`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `access_token` | string | Yes | The access token to retrieve and validate. Must be a valid Mapbox token. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Vector Tiles

**Slug:** `MAPBOX_GET_VECTOR_TILES`

Tool 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

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Map Matching (POST)

**Slug:** `MAPBOX_POST_MAP_MATCHING`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `tidy` | boolean | No | Remove clusters and resample traces for smoother matching. |
| `steps` | boolean | No | Include turn-by-turn instructions in response. |
| `ignore` | string | No | Comma-separated restrictions to ignore: access, oneways, restrictions. |
| `profile` | string ("mapbox/driving" | "mapbox/driving-traffic" | "mapbox/walking" | "mapbox/cycling") | Yes | Routing profile: mapbox/driving, mapbox/driving-traffic, mapbox/walking, or mapbox/cycling. |
| `language` | string | No | Language code for instructions (requires steps=true). |
| `overview` | string ("full" | "simplified" | "false") | No | Level of geometry detail: full, simplified (default), or false. |
| `radiuses` | string | No | Semicolon-separated max snap distances in meters per coordinate (0-50, use 'unlimited' for no limit). |
| `depart_at` | string | No | ISO 8601 departure time for traffic-aware routing (requires driving-traffic profile). |
| `waypoints` | string | No | Semicolon-separated zero-based indices of coordinates to treat as waypoints. |
| `approaches` | string | No | Semicolon-separated approach sides per waypoint: 'unrestricted' or 'curb'. |
| `geometries` | string ("geojson" | "polyline" | "polyline6") | No | Format of route geometry: geojson, polyline (default), or polyline6. |
| `timestamps` | string | No | Semicolon-separated Unix timestamps matching each coordinate for time-based matching. |
| `annotations` | string | No | Comma-separated metadata to include: distance, duration, speed, congestion, maxspeed. Requires overview=full. |
| `coordinates` | string | Yes | Semicolon-separated longitude,latitude pairs (2-100 coordinates). Example: '-117.17282,32.71204;-117.17288,32.71225' |
| `openlr_spec` | string ("tomtom" | "here") | No | OpenLR specification format: tomtom (default) or here. |
| `voice_units` | string ("imperial" | "british_imperial" | "metric") | No | Unit system for voice instructions: imperial, british_imperial, or metric. |
| `access_token` | string | Yes | Mapbox access token for authentication. |
| `openlr_format` | string | No | Binary format for OpenLR: tomtom (default). |
| `waypoint_names` | string | No | Semicolon-separated custom names for waypoints. |
| `roundabout_exits` | boolean | No | Emit separate instructions for roundabout entry and exit. |
| `linear_references` | boolean | No | Return OpenLR location references for matched segments. |
| `voice_instructions` | boolean | No | Return SSML voice guidance instructions. |
| `banner_instructions` | boolean | No | Return banner instruction objects (requires steps=true). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Query Tile Features

**Slug:** `MAPBOX_QUERY_TILE_FEATURES`

Tool 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

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Request Style Embed HTML

**Slug:** `MAPBOX_REQUEST_STYLE_EMBED_HTML`

Retrieve 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `title` | string ("copy" | "view") | No | 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. |
| `fallback` | boolean | No | Serve a fallback raster map (true) or not (false). |
| `style_id` | string | Yes | 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. |
| `username` | string | Yes | Mapbox account username that owns the style. Use 'mapbox' for Mapbox's standard public styles like streets-v12, satellite-v9, etc. |
| `zoomwheel` | boolean | No | Enable mouse-wheel zoom (true) or disable (false). |
| `mapboxGLVersion` | string | No | Specific version of Mapbox GL JS library to use (e.g., '3.0.0'). Leave null to use the default latest stable version. |
| `mapboxGLGeocoderVersion` | string | No | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Retrieve Directions

**Slug:** `MAPBOX_RETRIEVE_DIRECTIONS`

Tool to retrieve directions between waypoints. Use when you need navigation routes with optional turn-by-turn instructions after confirming origin and destination.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `steps` | boolean | No | Include turn-by-turn step instructions. |
| `profile` | string ("mapbox/driving-traffic" | "mapbox/driving" | "mapbox/walking" | "mapbox/cycling") | Yes | Routing profile: driving-traffic, driving, walking, or cycling. |
| `language` | string | No | Language for instructions (requires steps=true). |
| `overview` | string ("full" | "simplified" | "false") | No | Level of overview geometry detail. |
| `geometries` | string ("geojson" | "polyline" | "polyline6") | No | Format of route geometry in response. |
| `coordinates` | array | Yes | Ordered list of 2–25 longitude/latitude waypoints. |
| `access_token` | string | Yes | Mapbox access token for authentication. |
| `alternatives` | boolean | No | Return up to two alternative routes if available. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Retrieve Font Glyph Ranges

**Slug:** `MAPBOX_RETRIEVE_FONT_GLYPH_RANGES`

Tool to retrieve font glyph ranges as PBF tiles. Use when you have confirmed the font name, codepoint range, and valid token.

#### Input Parameters

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Retrieve Marker

**Slug:** `MAPBOX_RETRIEVE_MARKER`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `marker_name` | string | Yes | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Retrieve Matrix

**Slug:** `MAPBOX_RETRIEVE_MATRIX`

Retrieve a travel time and distance matrix between multiple locations. Use this tool when you need to calculate travel times and/or distances between many origin-destination pairs efficiently (e.g., comparing routes from multiple starting points to multiple destinations, finding the nearest location from a set, or optimizing multi-stop routing). Returns matrices showing durations (in seconds) and distances (in meters) between all coordinate pairs.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `profile` | string ("mapbox/driving" | "mapbox/walking" | "mapbox/cycling" | "mapbox/driving-traffic") | Yes | Transportation mode for routing: 'mapbox/driving' (car), 'mapbox/walking' (pedestrian), 'mapbox/cycling' (bicycle), or 'mapbox/driving-traffic' (car with live traffic, max 10 coords). |
| `sources` | string | No | 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). |
| `bearings` | string | No | Semicolon-separated 'angle,deviation' pairs per waypoint; angle 0–360, deviation in degrees; skip with ';'. |
| `depart_at` | string | No | BETA: desired departure time in ISO 8601 format (e.g., YYYY-MM-DDThh:mm:ssZ). |
| `approaches` | string | No | Semicolon-separated list per waypoint: 'unrestricted' or 'curb'. Count must match number of coordinates; skip entries with ';'. |
| `annotations` | string ("duration" | "distance" | "duration,distance") | No | Data to return in the matrix: 'duration' (travel time in seconds), 'distance' (travel distance in meters), or 'duration,distance' (both). Default: 'duration'. |
| `coordinates` | array | Yes | 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. |
| `access_token` | string | No | Mapbox access token (optional; auto-provided by auth). |
| `destinations` | string | No | 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). |
| `fallback_speed` | integer | No | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Retrieve Searchbox Place Details

**Slug:** `MAPBOX_RETRIEVE_SEARCHBOX_PLACE`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `language` | string | No | IETF language tag or comma-separated list of language codes to specify the language for results. |
| `mapbox_id` | string | Yes | The Mapbox ID of the feature to retrieve, obtained from a /suggest endpoint response. |
| `session_token` | string | Yes | Session token to group requests together for billing purposes (UUID format). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Retrieve Style

**Slug:** `MAPBOX_RETRIEVE_STYLE`

Retrieves the complete Mapbox style specification as JSON, including all layers, sources, sprites, and configuration. A Mapbox style defines how a map is rendered, including data sources, layer styling, fonts, and sprites. This action returns the full style specification conforming to the Mapbox Style Specification, which can be used with Mapbox GL JS, mobile SDKs, or for analyzing map configurations. Use this action when you need to: - Inspect or analyze a map style's configuration - Retrieve style definitions for programmatic rendering - Examine layers, sources, and styling rules - Get complete style specifications for custom map implementations

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `style_id` | string | Yes | 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'. |
| `username` | string | Yes | Mapbox account username that owns the style. Use 'mapbox' for official Mapbox styles like 'streets-v12', 'dark-v11', 'light-v11', 'satellite-v9'. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Retrieve Style WMTS

**Slug:** `MAPBOX_RETRIEVE_STYLE_WMTS`

Retrieve 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `style_id` | string | Yes | 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. |
| `username` | string | Yes | Mapbox account username that owns the style. Use 'mapbox' for Mapbox's official styles like streets-v12, satellite-v9, or outdoors-v12. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Retrieve Tileset Metadata

**Slug:** `MAPBOX_RETRIEVE_TILESET_METADATA`

Tool to retrieve metadata for a Mapbox tileset. Use when you need TileJSON details including bounds, zooms, and layer info.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `secure` | boolean | No | If true, return HTTPS URLs in the TileJSON 'tiles' array. |
| `tileset_id` | string | Yes | Tileset identifier in the format 'username.tilesetid'. For multiple tilesets, provide a comma-separated list (max 15). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Reverse Geocoding V6

**Slug:** `MAPBOX_REVERSE_GEOCODE_V6`

Tool 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

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search Box Reverse Geocoding

**Slug:** `MAPBOX_REVERSE_SEARCHBOX`

Tool 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

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search Box Forward

**Slug:** `MAPBOX_SEARCH_BOX_FORWARD`

Tool 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

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search by Category

**Slug:** `MAPBOX_SEARCH_CATEGORY`

Tool 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

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search Box Suggest

**Slug:** `MAPBOX_SUGGEST_SEARCHBOX`

Tool 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

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |