This page uses 2.19.0 of the Mapbox Navigation SDK. A newer version of the SDK is available. Learn about the latest version, 3.5.0, in the Navigation SDK documentation.
The Navigation SDK for iOS allows you to build a complete navigation experience with the power of the Mapbox Directions API. You can build a complete turn-by-turn navigation UI inside your application using our pre-built components or use the core logic directly to build something truly custom.
The Navigation SDK provides a collection of features that are critical when building navigation projects, including:
- Navigation routes
- Accurate device location updates
- Voice instruction announcements
- Real-time user progress to their destination
- Off-route detection and rerouting
- Dynamic camera adjustments during turn-by-turn navigation
- Pre-built UI components to show changing navigation information
- Support for navigating with limited or no network connection
Types of navigation
The Navigation SDK offers two types of navigation: turn-by-turn navigation and free-drive navigation.
Turn-by-turn navigation
Turn-by-turn navigation, also referred to as active guidance, is likely what comes to mind when you think about a typical navigation application: a user receives turn-by-turn instructions as they progress along the route. Read more in the Turn-by-turn navigation guides.
Free-drive navigation
Free-drive navigation, also referred to as passive navigation, is a unique Mapbox Navigation SDK feature that allows drivers to take advantage of some navigation features without selecting a route and following turn-by-turn instructions to a set destination. Read more in the Free-drive navigation guide.
Requirements
The Mapbox Navigation SDK is compatible with applications that are:
- Built in Xcode 13.3.1 or higher
- Written in Swift 5.6 or higher
- Run on iOS 12 or higher
Use with other Mapbox tools
The Mapbox Navigation SDK for iOS is designed to be used with several other Mapbox products.
Directions API
The Navigation SDK uses the Mapbox Directions API to generate routes between two or more coordinates. The Mapbox Directions for Swift framework has many route options like setting a profile identifier (for example driving, driving with traffic, or walking), waypoint heading (to influence the direction in which a route will begin), and roadClassesToAvoid (for example, avoiding tolls). Read more about Mapbox Directions for Swift in the API documentation.
Maps SDK for iOS
By default, the Navigation SDK comes with access to the Mapbox Maps SDK for iOS. The Navigation SDK uses the Maps SDK to display routes on a map and show the user's location on the map throughout their trip to provide both navigation-related context and nearby places that may be of interest to the driver. The Navigation SDK uses Mapbox Maps SDK v10, you can find documentation for your version in the Maps SDK API references listing.
Conditions
Attribution
If you use a Mapbox map in your application, you are required to provide attribution according to the Mapbox Maps SDK documentation.
Terms
The Mapbox Navigation SDK is distributed under Mapbox's Terms of Service.
Pricing
Read more about pricing for the Navigation SDK in the pricing guide.
Older versions of the SDK
Looking for an older version of the Navigation SDK? See the Navigation SDK v1 documentation.