← Tools Reference

Mapbox

Mapbox integration (Location, Developer Tools). Imported from open-connector.

API key4 toolshttps://api.mapbox.com
GET
mapbox_forward_geocode
Convert free-form text into geographic features with Mapbox Geocoding v6.

/search/geocode/v6/forward

8 parameters
ParamTypeRequiredDescription
qstringrequiredThe free-form text query to geocode.
autocompletebooleanoptionalWhether Mapbox should return autocomplete-style results.
limitintegeroptionalThe maximum number of features to return.
languagestringoptionalThe IETF language tag used for localized feature names.
countryarrayoptionalCountry filters applied to the geocoding request.
typesarrayoptionalFeature types to include in the response.
bboxarrayoptionalThe `[minLon, minLat, maxLon, maxLat]` bounding box.
proximityarrayoptionalA `[longitude, latitude]` coordinate pair.
GET
mapbox_reverse_geocode
Convert a coordinate pair into place features with Mapbox Geocoding v6.

/search/geocode/v6/reverse

6 parameters
ParamTypeRequiredDescription
longitudenumberrequiredThe longitude of the coordinate to reverse geocode.
latitudenumberrequiredThe latitude of the coordinate to reverse geocode.
limitintegeroptionalThe maximum number of features to return.
languagestringoptionalThe IETF language tag used for localized feature names.
typesarrayoptionalFeature types to include in the response.
worldviewstringoptionalThe worldview applied to the response.
GET
mapbox_get_directions
Compute a route between multiple coordinates with the Mapbox Directions API.

/directions/v5/{profile}/{coordinates}

17 parameters
ParamTypeRequiredDescription
profilestringrequiredRouting profile used by the request.
coordinatesarrayrequiredRoute coordinates in travel order.
alternativesbooleanoptionalWhether to request alternative routes.
annotationsarrayoptionalRoute annotations to include in the response.
continue_straightbooleanoptionalWhether the router should prefer continuing straight at waypoints.
excludearrayoptionalRoute features to exclude.
geometriesstringoptionalGeometry encoding used in the route response.
languagestringoptionalLanguage used for route instructions.
overviewstringoptionalRoute overview geometry detail level.
roundabout_exitsbooleanoptionalWhether roundabout maneuver exits should be included.
stepsbooleanoptionalWhether step-by-step route instructions should be included.
voice_instructionsbooleanoptionalWhether voice instructions should be included.
banner_instructionsbooleanoptionalWhether banner instructions should be included.
avoid_maneuver_radiusnumberoptionalRadius in meters used to avoid immediate maneuvers.
depart_atstringoptionalDeparture time used for time-aware routing.
arrive_bystringoptionalArrival time used for time-aware routing.
waypointsarrayoptionalCoordinate indexes that should be treated as waypoints.
GET
mapbox_get_matrix
Compute a travel time or distance matrix with the Mapbox Matrix API.

/directions-matrix/v1/{profile}/{coordinates}

8 parameters
ParamTypeRequiredDescription
profilestringrequiredRouting profile used by the request.
coordinatesarrayrequiredCoordinates included in the matrix calculation.
annotationsarrayoptionalMatrix annotations to include in the response.
approachesarrayoptionalCurb approach constraints for the coordinates.
bearingsarrayoptionalBearing filters applied to the coordinates.
fallback_speednumberoptionalFallback speed in meters per second.
sourcesarrayoptionalCoordinates used as matrix sources.
destinationsarrayoptionalCoordinates used as matrix destinations.