Mapbox

Parámetros de entrada

• bboxstring

  Bounding box to restrict results: minLon,minLat,maxLon,maxLat.

• limitinteger

  Maximum number of results per query (1–10).

• typesstring

  Comma-separated list of feature types to limit results.

• countrystring

  Filter results to one or more ISO 3166 alpha-2 country codes (comma-separated).

• queriesstring[]

  List of search text strings for forward geocoding (up to 50 entries).

• routingboolean

  Include routable point metadata for address features.

• languagestring

  IETF language tag(s) for returned text (comma-separated).

• proximitystring

  Bias results toward a geographic location: lon,lat or 'ip'.

• worldviewstringenum

  Viewworld to bias results (e.g., 'us', 'cn').

  arcninjpmarsrutrus
• coordinatesarray[]

  List of [lon, lat] pairs for reverse geocoding (up to 50 entries).

• fuzzy_matchboolean

  Whether to allow approximate string matching (forward only; default true).

• autocompleteboolean

  Whether to return autocomplete results (forward only; default true).

• reverse_modestringenum

  Reverse geocoding mode: 'distance' or 'score' (reverse only).

  distancescore

Parámetros de salida

• dataobject[]Obligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• qstring

  Free-form search text (URL-encoded, ≤256 chars, ≤20 tokens, no semicolons). Required if no structured fields are provided.

• bboxstring

  Limit results to a bounding box: 'minLon,minLat,maxLon,maxLat'.

• blockstring

  Block component (used in some countries like Japan).

• limitinteger

  Maximum number of results (default 5, max 10).

• placestring

  City or municipality component for structured input.

• typesstring

  Comma-separated filter of feature types: country, region, postcode, district, place, locality, neighborhood, street, address.

• formatstringenum

  Response format: 'geojson' (default) or 'v5' for backward compatibility.

  geojsonv5
• regionstring

  State or region component for structured input.

• streetstring

  Street name component for structured input.

• countrystring

  ISO 3166-1 alpha-2 country code or full country name for structured input, or comma-separated list of codes to filter results.

• languagestring

  Comma-separated IETF language tags affecting response text and ranking.

• postcodestring

  Postal code component for structured input.

• permanentboolean

  Whether results may be stored permanently (default false).

• proximitystring

  Bias results to this 'lon,lat' or 'ip' for IP-based biasing.

• worldviewstringenum

  Boundary worldview for results (default 'us').

  arcninjpmarsrutrus
• autocompleteboolean

  Return autocomplete results (default true).

• address_line1string

  Combined house number and street name for structured input.

• address_numberstring

  House number component for structured input.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• bboxstring

  Limit results to bounding box: minLon,minLat,maxLon,maxLat; cannot cross 180th meridian.

• limitinteger

  Maximum number of results to return (1-10).

• typesstring

  Comma-separated list of feature types: country,region,postcode,district,place,locality,neighborhood,address.

• countrystring

  Comma-separated ISO 3166-1 alpha-2 country codes to limit results.

• routingboolean

  Request routable points metadata for address features.

• languagestring

  Comma-separated IETF language tags (up to 20 unique) controlling language of results.

• proximitystring

  Bias results toward this location: 'lon,lat' or 'ip'.

• worldviewstringenum

  Return features according to worldview; one of ar,cn,in,jp,ma,rs,ru,tr,us.

  arcninjpmarsrutrus
• fuzzyMatchboolean

  Allow approximate (fuzzy) matching.

• search_textstringObligatorio

  URL-encoded UTF-8 search text (max 256 chars, max 20 tokens, no semicolons).

• autocompleteboolean

  Include autocomplete results that start with the query string.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• limitinteger

  Max number of results; default=1; max=10. If >1, must specify exactly one types value.

• typesstring

  Filter by one or more feature types: country, region, postcode, district, place, locality, neighborhood, address.

• countrystring

  Limit results to one or more countries; comma-separated ISO 3166-1 alpha-2 codes.

• routingboolean

  If true, include navigation metadata for address features; adds 'routable_points'.

• languagestring

  IETF language tags (ISO 639-1 + optional subtags); comma-separated; up to 20 unique values.

• latitudenumberObligatorio

  Latitude in decimal degrees for the coordinate pair.

• longitudenumberObligatorio

  Longitude in decimal degrees for the coordinate pair.

• worldviewstringenum

  Regional/political boundary perspective. One of: ar, cn, in, jp, ma, rs, ru, tr, us.

  arcninjpmarsrutrus
• reverseModestringenum

  Sorting when multiple results requested: 'distance' (closest first, default) or 'score' (prominence based).

  distancescore
• access_tokenstringObligatorio

  Mapbox access token.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• limitinteger

  Maximum number of results to return; default 1, max 10. If >1, exactly one 'types' value must be set.

• typesstring

  Comma-separated feature types to include. Options: country, region, postcode, district, place, locality, neighborhood, address.

• countrystring

  ISO 3166-1 alpha-2 country codes to limit results, comma-separated.

• routingboolean

  Include metadata for recommended navigation destination; only applicable for address features.

• languagestring

  IETF BCP 47 language tags, comma-separated, controlling response language.

• latitudenumberObligatorio

  Latitude of the location to reverse geocode.

• longitudenumberObligatorio

  Longitude of the location to reverse geocode.

• worldviewstringenum

  Boundary worldview for disputed areas; one of ar, cn, in, jp, ma, rs, ru, tr, us.

  arcninjpmarsrutrus
• reverse_modestringenum

  Sort strategy when multiple results requested; 'distance' (default) or 'score'.

  distancescore

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

Sin parámetros.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• titlestringenum

  Show a title box: 'copy' adds a copy link, 'view' adds a view button.

  copyview
• fallbackboolean

  Serve a fallback raster map (true) or not (false).

• style_idstringObligatorio

  Style ID for which to return the embeddable HTML.

• usernamestringObligatorio

  Mapbox account username that owns the style.

• zoomwheelboolean

  Enable mouse-wheel zoom (true) or disable (false).

• mapboxGLVersionstring

  Version of Mapbox GL JS to render the map.

• mapboxGLGeocoderVersionstring

  Version of the Mapbox GL Geocoder plugin for the search box.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• stepsboolean

  Include turn-by-turn step instructions.

• profilestringObligatorioenum

  Routing profile: driving-traffic, driving, walking, or cycling.

  mapbox/driving-trafficmapbox/drivingmapbox/walkingmapbox/cycling
• languagestring

  Language for instructions (requires steps=true).

• overviewstringenum

  Level of overview geometry detail.

  fullsimplifiedfalse
• geometriesstringenum

  Format of route geometry in response.

  geojsonpolylinepolyline6
• coordinatesobject[]Obligatorio

  Ordered list of 2–25 longitude/latitude waypoints.

• access_tokenstringObligatorio

  Mapbox access token for authentication.

• alternativesboolean

  Return up to two alternative routes if available.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• endintegerObligatorio

  End of codepoint range; must equal start + 255

• fontstringObligatorio

  Font name or comma-separated list (max 10 faces)

• startintegerObligatorio

  Start of codepoint range; must be a multiple of 256

• usernamestringObligatorio

  Mapbox account username that owns the font

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• profilestringObligatorioenum

  Routing profile ID: driving, walking, cycling, or driving-traffic.

  mapbox/drivingmapbox/walkingmapbox/cyclingmapbox/driving-traffic
• sourcesstring

  Indices of source waypoints; semicolon-separated 0-based indices or 'all'.

• bearingsstring

  Semicolon-separated 'angle,deviation' pairs per waypoint; angle 0–360, deviation in degrees; skip with ';'.

• depart_atstring

  BETA: desired departure time in ISO 8601 format (e.g., YYYY-MM-DDThh:mm:ssZ).

• approachesstring

  Semicolon-separated list per waypoint: 'unrestricted' or 'curb'. Count must match number of coordinates; skip entries with ';'.

• annotationsstringenum

  Which matrices to return: duration, distance, or both.

  durationdistanceduration,distance
• coordinatesobject[]Obligatorio

  Ordered list of 2–25 coordinates for matrix calculations.

• access_tokenstringObligatorio

  Mapbox access token.

• destinationsstring

  Indices of destination waypoints; semicolon-separated 0-based indices or 'all'.

• fallback_speedinteger

  Legacy: speed in km/h for straight-line fallback estimates; must be >0.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• style_idstringObligatorio

  ID of the style to retrieve.

• usernamestringObligatorio

  Mapbox account username that owns the style.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• style_idstringObligatorio

  Style ID for which to return the WMTS document.

• usernamestringObligatorio

  Mapbox account username that owns the style.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• secureboolean

  If true, return HTTPS URLs in the TileJSON 'tiles' array.

• tileset_idstringObligatorio

  Tileset identifier in the format 'username.tilesetid'. For multiple tilesets, provide a comma-separated list (max 15).

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not