Navigation SDK for iOS

Current version: v1.0.0 View changelog

  • A navigation UI ready to drop into your application
  • Professionally designed map styles
  • Worldwide driving, cycling, and walking directions
  • Traffic avoidance and proactive rerouting

The Mapbox Navigation SDK gives you all the tools you need to add turn-by-turn navigation to your application. It takes only a few minutes to drop a full-fledged turn-by-turn navigation view controller into your application. Or use the Core Navigation framework directly to build something truly custom.

Structure of the SDK

The Navigation SDK is divided into two frameworks: the Mapbox Core Navigation framework (MapboxCoreNavigation) and the Mapbox Navigation framework (MapboxNavigation).

Mapbox Core Navigation

The Mapbox Core Navigation framework (MapboxCoreNavigation) contains the logic that allows you to receive user location updates, determine their relation to the route line, and get notifications that indicate the current state of the application in the form of a RouteProgress object.

You can use MapboxCoreNavigation directly in your project to build a completely custom navigation UI or use it via the Mapbox Navigation framework (MapboxNavigation), which is powered by MapboxCoreNavigation.

Mapbox Navigation

The Mapbox Navigation framework (MapboxNavigation) is the ready-made turn-by-turn navigation user interface (UI). Use MapboxNavigation to get up and running quickly with an in-app navigation experience. With a few lines of code, add a drop-in UI, automatic day-to-night map switching, and automatic rerouting in traffic. Adjust the style of various elements of the ready-made UI, react to location-related events as they occur, and adjust various aspects of the map view’s appearance.

Requirements

The Mapbox Navigation SDK and Core Navigation are compatible with applications written in Swift 5 in Xcode 10.2 and above. The Mapbox Navigation and Mapbox Core Navigation frameworks run on iOS 10.0 and above.

Install the Navigation SDK

Before starting to develop your application with the Navigation SDK, you'll need to configure your credentials and add the SDK as a dependency.

Configure credentials

Before installing the SDK, you will need to gather the appropriate credentials. The SDK requires two pieces of sensitive information from your Mapbox account. If you don't have a Mapbox account: sign up and navigate to your Account page. You'll need:

  • A public access token: From your account's tokens page, you can either copy your default public token or click the Create a token button to create a new public token.
  • A secret access token with the Downloads:Read scope.
    1. From your account's tokens page, click the Create a token button.
    2. From the token creation page, give your token a name and make sure the box next to the Downloads:Read scope is checked.
    3. Click the Create token button at the bottom of the page to create your token.
    4. The token you've created is a secret token, which means you will only have one opportunity to copy it somewhere secure.

You should not expose these access tokens in publicly-accessible source code where unauthorized users might find them. Instead, you should store them somewhere safe on your computer and make sure they're only added when your app is compiled. Once this configuration step has been completed, you will be able to reference your credentials in other parts of your app.

Configure your secret token

Your secret token enables you to download the SDK directly from Mapbox. In order to use your secret token, you will need to store it a .netrc file in your home directory. This approach helps avoid accidentally exposing your secret token by keeping it out of your application's source code. Depending on your environment, you may have this file already, so check first before creating a new one.

The .netrc file is a plain text file that is used in certain development environments to store credentials used to access remote servers. To set up the credentials required to download the SDK, add the following entry to your .netrc file:

machine api.mapbox.com 
login mapbox
password <INSERT API TOKEN>

Configure your public token

To configure your public access token, open your project's Info.plist file and add a MGLMapboxAccessToken key whose value is your public access token.

If you ever need to rotate your access token, you will need to update the token value in your Info.plist file accordingly.

Users expect the SDK to continue to track the user’s location and deliver audible instructions even while a different application is visible or the device is locked. To do this, go to the Signing & Capabilities tab. Under the Background Modes section, enable “Audio, AirPlay, and Picture in Picture” and “Location updates”. (Alternatively, add the audio and location values to the UIBackgroundModes array in the Info tab.)

Add the dependency

Installing MapboxNavigation versus MapboxCoreNavigation

MapboxCoreNavigation is a dependency of MapboxNavigation. If you install MapboxNavigation you will also have access to all MapboxCoreNavigation's classes and methods. If you do not plan to use the drop-in UI, you can replace MapboxNavigation with MapboxCoreNavigation in the Podfile code snippet below.

Mapbox provides the Navigation SDK via CocoaPods and Carthage. You can choose whichever you prefer.

To add the Mapbox Navigation SDK dependency with CocoaPods, you will need to configure your build to download the Navigation SDK from Mapbox directly. This requires a valid username and an access token with the Downloads: Read scope. In a previous step, you added these items to your .netrc file.

  1. Create a Podfile with the following specification:

    use_frameworks!
    target 'TargetNameForYourApp' do
      pod 'MapboxNavigation', '~> 1.0'
    end
    
  2. Run pod repo update && pod install and open the resulting Xcode workspace.

Request a route

Request your first route and simulate a navigation experience using our drop-in UI.

Insert the following code snippets into your ViewController.

import MapboxDirections
import MapboxCoreNavigation
import MapboxNavigation
class ViewController: UIViewController {
override func viewDidLoad() {
super.viewDidLoad()
// Define two waypoints to travel between
let origin = Waypoint(coordinate: CLLocationCoordinate2D(latitude: 38.9131752, longitude: -77.0324047), name: "Mapbox")
let destination = Waypoint(coordinate: CLLocationCoordinate2D(latitude: 38.8977, longitude: -77.0365), name: "White House")
// Set options
let routeOptions = NavigationRouteOptions(waypoints: [origin, destination])
// Request a route using MapboxDirections.swift
Directions.shared.calculate(routeOptions) { [weak self] (session, result) in
switch result {
case .failure(let error):
print(error.localizedDescription)
case .success(let response):
guard let route = response.routes?.first, let strongSelf = self else {
return
}
// Pass the first generated route to the the NavigationViewController
let viewController = NavigationViewController(for: route, routeIndex: 0, routeOptions: routeOptions)
viewController.modalPresentationStyle = .fullScreen
strongSelf.present(viewController, animated: true, completion: nil)
}
}
}
}

Run the application and you will see a simulated navigation experience along a route.

guide
Access token best practices

Learn how to keep access tokens private in mobile apps.

Testing and development

Simulate a route

Use MapboxNavigationService(simulating:.always) to simulate progress along a route. This simulation mode is different from the simulation features built into both the Simulator and Xcode. The simulation mode built into the Navigation SDK never deviates from the current route, but it does behave more realistically by accounting for the expected travel speed and course at any given time. While navigating, you can double-tap the left or right side of the “Simulating” banner to adjust the playback speed.

let navigationService = MapboxNavigationService(route: route, routeOptions: routeOptions, simulating: .always)
let navigationOptions = NavigationOptions(navigationService: navigationService)
let viewController = NavigationViewController(for: route, routeOptions: routeOptions, navigationOptions: navigationOptions)

Pricing

Upgrading to the Navigation SDK v1.0.0+

Usage of the Navigation SDK v1.0.0 and higher is billed differently than pre-1.0.0 versions. If you are upgrading your application from an earlier version of the Navigation SDK, please read the pricing documentation to understand how these pricing changes will impact your monthly invoice.

Pricing by products: Navigation SDK for iOS and Android

Navigation SDK usage is billed by monthly active users (MAUs). To estimate the cost of your usage, see the following resources:

Available resources

For further details, consult the guides and examples included with this API reference. Documentation for the Mapbox Navigation SDK for iOS comes in the form of:

We welcome your bug reports, feature requests, and contributions. If you can't find what you're looking for, reach out to our support team.

Was this page helpful?