All docsAPIChangelog


December 3, 2020

December 1, 2020

November 30, 2020

  • Documented the speedLimitSign and speedLimitUnit properties in the Directions API route step object.

November 12, 2020

  • Added documentation for using the optional padding parameter with the Static Images API.

November 4, 2020

  • Added documentation for retrieving font metadata using the Fonts API.

October 30, 2020

  • Added documentation for updating font metadata using the Fonts API.
  • Added continuous lane guidance documentation for the Directions API.

October 29, 2020

  • Updated the Styles API documentation to include information about how to access immutable, versioned sprites.
  • Included note about supporting decimal values of scaled sprite displays.
  • Added 422: invalid style source HTTP response code to the Static Images API and Static Tiles API to denote that styles will fail if the underlying source contains invalid values.

October 26, 2020

  • Documented the optional worldview parameter for the Geocoding API.

October 2, 2020

October 1, 2020

  • Added documentation for several new intersection-related properties returned by the Directions API.

September 14, 2020

August 17, 2020

August 13, 2020

  • Added documentation for font deletion to the Fonts API.

August 10, 2020

  • Added two optional parameters to the Directions API for use with the mapbox/driving profile: arrive_by and depart_at.

August 6, 2020

August 5, 2020

July 31, 2020

  • Add Tilesets API PUT endpoint for replacing a tileset's source data.

June 25, 2020

  • Added the Offline Data API in private beta.

June 22, 2020

June 11, 2020

May 28, 2020

  • The Tilesets API has a new name! It's now called Mapbox Tiling Service (MTS). The endpoints that you use to access MTS have not changed, and still follow the format /tilesets/v1/.
  • Corrected an error in the maximum-supported number of features returned in reverse geocodes.

May 13, 2020

  • Documented new Datasets API sortby query parameter on the list endpoint, which allows you to sort by modified or created (default) dates.

May 7, 2020

  • Documented new Tilesets API PATCH endpoint for updating tileset information, such as name, description, private, and attribution.

April 17, 2020

  • Remove the deprecated Surface API.

April 16, 2020

April 2, 2020

  • Changed the response for deleting tileset source from 201 to 204 in Tilesets API.

February 20, 2020

  • Limited the GET sources endpoint in the Tilesets API to 2000 results.

February 17, 2020

  • Changed the response of the GET status endpoint in the Tilesets API. Users relying on the last_completed_job, success, failed, queued, or processing attributes should update their applications to use latest_job and status.

February 6, 2020

  • Removed metadata parameter documentation for the GET style endpoint: Styles API.

February 03, 2020

  • Updated the rate-limits for various end-points associated with tilesets endpoints.
  • Fixed an invalid URL warning found during unit test

January 30, 2020

  • Increase limit of images per sprite from 500 to 1,000: Styles API.
  • Documented metadata parameter of the GET style endpoint: Styles API.

January 8, 2020

November 13, 2019

November 12, 2019

November 5, 2019

  • Added a new private property to the Uploads API.
  • Updated the existing private property in the Tilesets API, which is now available to all Mapbox users and true by default.

October 17, 2019

September 27, 2019

September 25, 2019

  • Updated the rate limit for the Static Tiles API from 2,000 requests per minute to 5,000 requests per minute.
  • Updated the rate limit for the Static Images API from 600 requests per minute to 1,200 requests per minute.

September 24, 2019

August 28, 2019

August 26, 2019

August 5, 2019

  • Updated the Static Images API to reflect the fact that if the referenced style contains raster sources, the returned file will be a JPEG rather than a PNG.

August 1, 2019

July 25, 2019

  • Updated Styles API to show parameters for mapboxGLVersion and mapboxGLGeocoderVersion.

June 26, 2019

June 5, 2019

  • Moved the Retrieve TileJSON metadata endpoint from the Maps API documentation to the Tilesets API documentation to better reflect the fact that TileJSON describes a tileset.

May 23, 2019

  • Updated Styles API to show parameter for draft style.

May 22, 2019

  • Updated Maps service API documentation to reflect the new naming structure:
    • The endpoint that serves static map images generated from vector map styles is now the Static Images API.
    • The endpoint that serves raster tiles generated from Mapbox Studio styles is now the Static Tiles API.
    • The endpoint that serves vector tiles generated from Mapbox Studio styles is now the Vector Tiles API.
    • The endpoint that serves raster tiles generated from satellite imagery tilesets and tilesets generated from raster data uploaded to is now the Raster Tiles API.
    • The Static (Classic) API is now the Legacy Static Images API.
  • Updated the Analytics API documentation to reflect that the beta period has finished.
    • The Analytics API documentation is available at
    • The Analytics API is still available for use, but Mapbox will not incorporate any new features or new metrics right now.
    • Note that map views, which are returned by the API, are deprecated and are no longer used to track map usage for Mapbox products.

May 2, 2019

  • Updated the Tokens API to show that the allowedUrls property is in general availability.

March 21, 2019

March 18, 2019

  • Added documentation for new beta allowedUrls property to the Tokens API.

February 25, 2019

  • Updated cURL examples with the {username} placeholder to display a user's username if they are logged in to Mapbox. If the user is not logged in, the cURL request will display the {username} placeholder.

February 7, 2019

February 5, 2019

  • Restructured the example request and response headers so they are all unique can can be linked to.

February 1, 2019

  • Added the delete endpoint to the Tilesets API.
  • Document the waypoints parameter on the Directions API

January 25, 2019

November 27, 2018

November 19, 2018

  • Added an Objective-C example of batch geocoding using MapboxGeocoder.swift.

September 28, 2018

  • Updates to the Geocoding API documentation:
    • General restructuring of how content is presented, based on work done by the Search team.
    • Added information indicating that the types value poi.landmark is deprecated.
    • Expanded the description for batch geocoding requests.
    • Added routing to the list of available parameters for forward and reverse geocoding requests.
    • Added routeable_points and routable_points.points to the list of potential values in a response from the geocoder.

September 27, 2018

  • Updated the examples for the Analytics and Tokens APIs to be more informative and user-friendly.

September 17, 2018

August 24, 2018

  • Updated the list of Mapbox-designed styles available to all access tokens to include version 4 of the Mapbox Navigation styles.
  • The Directions API now supports Burmese, Finnish, Korean, and Norwegian (Bokmål) for turn-by-turn instructions.

May 23, 2018

  • Added HTTP POST support for the /matching/v5 endpoint.

May 3, 2018

April 18, 2018

April 13, 2018

  • Added European Portuguese to the list of instruction languages available in the Directions API.

March 2, 2018

  • Added voice_instructions, voice_units and banner_instructions flags to the /directions/v5 endpoint along with explanations for the new content returned.

February 27, 2018

  • Added Danish and Hebrew to the list of instruction languages available in the Directions API.

February 15, 2018

  • Remove the deprecated Distance API /distances/v1

December 7, 2017

  • Added character limit notes to tileset and name parameters in the Uploads API create endpoint.

November 29, 2017

  • Added the driving_side step property to the Directions API

November 14, 2017

  • Computing alternative routes in the Directions API is supported on the traffic profile by now.

October 4, 2017

  • Added docs for preview of Geocoding category search for POIs.

September 29, 2017

  • Added Brazilian Portuguese, Castilian Spanish, Esperanto, Italian, Polish, Romanian, Turkish, and Ukrainian to the list of instruction languages available in the Directions API.

August 30, 2017

  • Changed all mentions of Starter to Pay-as-you-go and Premium to Commercial per updates to our pricing structure.

August 24, 2017

  • Removed traffic-day-v2 and traffic-night-v2 from the list of available Mapbox styles in the Styles API.
  • Added navigation-preview-day-v2, navigation-preview-night-v2, navigation-guidance-day-v2, and navigation-guidance-night-v2 to the list of available Mapbox styles in the Styles API.

August 15, 2017

  • Added documentation for the congestion option in the annotations parameter in the Directions API

August 7, 2017

  • Added documentation for the proximity parameter in the Geocoding API
  • Added documentation for the interpolated response field in the Geocoding API

July 28, 2017

  • Added documentation for the classes response field in the Directions API
  • Added documentation for the tidy parameter in the Map Matching API
  • Added documentation for the exits response field in the Directions API

July 7, 2017

  • Added documentation for the response object of the Geocoding API.

May 16, 2017

  • Updated the Styles API documentation with URLs to the Mapbox Streets v10, Mapbox Outdoors v10, and Mapbox Satellite Streets v10 styles.

May 15, 2017

  • Added documentation for weight and weight_name properties of Directions API.
  • Added documentation for alternative_count properties of Map Matching API.

May 9, 2017

  • Added a POST request endpoint to Uploads API credentials POST /uploads/v1/{username}/credentials and updated documentation. GET requests will still work.

April 11, 2017

April 10, 2017

April 4, 2017

March 14, 2017

  • Added documentation for styling stroke width for encoded polyline static requests.

March 10, 2017

  • Added support for ?annotations=speed in the Directions, Map Matching and Optimized Trips APIs.

February 23, 2017

  • Added documentation for the Static API with overlays.

February 21, 2017

January 13, 2017

  • Document Tilesets API

November 7, 2016

  • Document the geocoding limit parameter

November 2, 2016

  • Removed preview label for Datasets API and Tokens API.

October 31, 2016

  • Document poi.landmark value for geocoding types query parameter.

October 28, 2016

  • Document .mvt extension for vector tiles, over .vector.pbf.

October 17, 2016

  • Removed documentation for the bulk write endpoint for datasets.

September 30, 2016

  • Add Scopes API
  • Add temporary tokens to Tokens API
  • Note that the Tokens List is paginated

September 22, 2016

  • Adds documentation for the bearings parameter in the Directions API.

September 8, 2016

  • Add Tokens API
  • Update Datasets listing endpoint scope to be datasets:list, instead of datasets:read

August 15, 2016

  • Link to Directions API Playground interface

August 8, 2016

  • Corrected the maximum size of a custom icon placed on a static map.

August 3, 2016

  • Specifies that map tiles including mapbox.satellite are delivered as JPEG regardless of requested format.

August 1, 2016

  • Specifies that the feature endpoint of the Datasets API does not yet support GeometryCollection geometries or features without geometries.

July 28, 2016

  • Documents word and length limits of queries to the Geocoding API.

July 18, 2016

  • Restore listing endpoint for styles.

July 11, 2016

  • Removed documentation for listing endpoint for styles.

June 20, 2016

  • Added documentation for the new OGC WMTS endpoint for maps.

June 16, 2016

  • Updated JS, Python, and CLI geocoding examples to include the {bbox} parameter.

June 9, 2016

  • Updated the radius parameter of the Directions API to clarify that it is measured in meters.

June 6, 2016

May 22, 2016

May 16, 2016

  • Updated Swift classic Static API example for MapboxStatic.swift v0.6.0.
  • Added Objective-C examples for MapboxGeocoder.swift and MapboxStatic.swift.

May 13, 2016

  • Updated Swift classic Static API example for MapboxStatic.swift v0.5.0.
  • Adds new types off ramp, on ramp and roundabout turn which were added in OSRM v5.1.0.

May 11, 2016

  • Adds documentation for Swift & Java languages using mapbox-java,MapboxDirections.swift,MapboxStatic.swift, and MapboxGeocoder.swift
  • Adds the new {bbox} parameter of the Geocoding API.
  • Updated documentation from Directions API v4 to v5
    • Changed: URL format change:
      • old: /v4/directions/mapbox.driving/{lon,lat};{lon,lat}.json
      • new /directions/v5/mapbox/driving/{lon,lat};{lon,lat}
    • Removed: no more html text instructions, instead it is plain text instructions only. The client may compile text instructions themselves
    • Added: response body has code and message properties to signify errors
    • Added: response body has routes split into several legs
    • Added: response body has legs split into steps, each with a maneuver
    • Added: response body has every step with a geometry
    • Changed: response body has for every step bearing_before and bearing_after instead of only heading
    • Added: response body has every step with a geometry
    • Changed: query parameter geometry was renamed to geometries
    • Changed: by default, return polyline geometries
    • Added: query parameter overview can be full, simplified or false
    • Changed: polyline geometries have a precision of 5 (instead of 6 before)
    • Changed: by default, steps and alternatives are disabled
    • Changed: uturns query parameter was renamed to continue_straight

May 10, 2016

  • Update the Styles API section with latest v9 styles, remove basic and bright styles from documentation.

May 6, 2016

  • Added a wikidata property to the Geocoding output example.

April 26, 2016

  • Document the maximum length of a period in the Analytics API as one year.

April 22, 2016

  • The Reverse Geocoding API documentation said that a reverse geocode returns at most one result per mode, when it in fact returns at most one result per type.

April 5, 2016

  • Separates Parameters & Options in all documentation sections for consistency
  • Adds new topic section on how to read documentation
  • Reiterates that even with the attribution=false option, attribution is required for static maps that include OpenStreetMap data.

April 4, 2016

  • Adds documentation for the new Analytics API, which is a preview for Premium and Enterprise accounts only.

March 30, 2016

  • Fixes documentation for the Datasets API batch endpoint: the URL ends with /features and is a POST endpoint, not a PUT endpoint as written earlier.

March 15, 2016

  • Fixes the {country} parameter of the Geocoding API, which had been documented incorrectly as {cc}
  • Adds the new {autocomplete} parameter of the Geocoding API

March 8, 2016

  • Adds new distance and duration properties to the responses of the Map Matching API

March 4, 2016

  • Clarified that Link is header required for pagination, instead of recommended
  • Increased public Upload limits