> For the complete documentation index, see [llms.txt](https://docs.mapbox.com/ios/search/llms.txt)

# Get Started

To use the Search SDK, you must first configure your credentials and then add the SDK as a dependency in your project. Here's a brief overview of the steps:

## Configure credentials

To download and install the SDK, follow the steps below. Start by logging into your Mapbox account, then create and configure a secret access token, and lastly add your public access token to your `Info.plist`.

### Step 1: Log in/Sign up for a Mapbox account

Login to your [Mapbox account](https://console.mapbox.com/). If you don't have an account, [sign up for free here](https://account.mapbox.com/auth/signup/).

Your account includes a [default public access token](https://docs.mapbox.com/accounts/guides/tokens/#default-public-access-token), and allows you to create a secret access token for use in the installation of the SDK.

### Step 2: Create a secret token

A secret access token can enable access to various products/services at Mapbox, including the ability to download an SDK. To allow download access to an SDK, follow these steps:

1.  From your account's [tokens page](https://console.mapbox.com/account/access-tokens/), 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.

> **Note (warning): Protect secret access tokens**
> 
> Store secret tokens in secure a location, outside of your project folder to make sure unauthorized users cannot find it.

### Step 3: Configure your secret token

Your secret access token is used only when downloading the SDK binaries for use in your project.

To use your secret token, you must store it in a `.netrc` file in your home directory (not your project folder). This approach helps avoid accidentally exposing your secret token by keeping it out of your application's source code.

To create a `.netrc` file follow these steps:

**Step 3-1:** Check if you have already created a `.netrc` file on your computer.

1.  In a terminal, go to your home directory.

```bash
$ cd ~
```

2.  Run `file .netrc` to check whether a `.netrc` file already exists. You will see the following message if there is no `.netrc` file:

```bash
$ file .netrc
.netrc: cannot open `.netrc' (No such file or directory)
```

3.  If you already have a `.netrc` file, skip the next step.

**Step 3-2:** Create the `.netrc` file.

-   From the same terminal, run `touch .netrc`.

**Step 3-3:** Open the `.netrc` file.

-   From the same terminal, run `open .netrc`.

**Step 3-4:** Add Mapbox credentials to the `.netrc` file

Add the following lines of text to your `.netrc` file, replacing `<INSERT SECRET ACCESS TOKEN>` with the secret access token you created in step 2:

```bash
machine api.mapbox.com
login mapbox
password <INSERT SECRET ACCESS TOKEN>
```

**Step 3-5:** Set `.netrc` file permissions to Read & Write for the current user

**Finder**

1.  Go to your home directory: `/Users/[CurrentUser]`.

-   If you do not see the `.netrc` file, press `Command` + `Shift` + `.` (the period key).

2.  Right click on the `.netrc`.
3.  Click `Get Info`.
4.  Scroll down to `Sharing & Permissions`.
5.  Under your current username, make sure to set `Privilege` to `Read & Write`.

**Terminal**

From the same terminal, run `chmod -R 0600 .netrc`

### Step 4: Configure your public token

Your public access token is used in your application code when requesting Mapbox resources.

To configure your public access token, follow these steps:

1.  Open your project's `Info.plist` file
2.  Hover over a key and click the plus button
3.  Type `MBXAccessToken` into the key field
4.  Click the value field and paste in your public access token.

> **Note: Rotating Tokens**
> 
> When you need to [rotate your access token](https://docs.mapbox.com/help/how-mapbox-works/access-tokens/), you will need to update the token value in your `Info.plist` file.

Your browser doesn't support HTML5 video. Open [link to the video](https://docs.mapbox.com/ios/ios/assets/medias/MapsInstallPublicToken-eb2f6fbf8715def5ae8eaa35a5b562c4.mp4).

> **Related content (guide): [Access token best practices](https://docs.mapbox.com/help/dive-deeper/private-access-token-android-and-ios/)**
> 
> Learn how to keep access tokens private in mobile apps.

## Add the dependency

Mapbox provides the Search SDK via **Swift Package Manager** and **CocoaPods**.

> **Note (warning): CocoaPods support ending December 2026**
> 
> Mapbox will end support for CocoaPods in December 2026. After that date, new versions of the Search SDK for iOS will not be published to CocoaPods. We recommend installing the SDK via **Swift Package Manager** to continue receiving updates.

**Swift Package Manager**

The Mapbox Search SDK can be consumed via Swift Package Manager (SPM). To add the Search SDK with SPM, you will need to configure your environment to download it from Mapbox. This requires a Mapbox access token with the `Downloads:Read` scope. In a previous step, you added this token to your `.netrc` file.

1.  Open your Xcode project or workspace, then go to **File** > **Swift Packages** > **Add Package Dependency**.
2.  Enter `https://github.com/mapbox/search-ios.git` as the URL, press `Enter` to pull in the package, and click **Next**.
3.  Set **Version** to **Exact** and enter `2.28.4`. Click **Next**.
4.  Once Xcode finishes fetching and checking out all the dependencies, select the **MapboxSearchUI** library (or **MapboxSearch** if you don't need any UI components). Click **Next**.
5.  In your code, you can now `import MapboxSearch` as well as any of the other packages that were downloaded as dependencies.

**Notes**

-   If you need to update your packages, you can click on **File** > **Swift Packages** > **Update To Latest Package Versions**.
-   Sometimes, artifacts cannot be resolved or errors can occur, in this case select **File** > **Swift Packages** > **Reset Package Cache**.
-   If your Xcode crashes, delete your derived data folder.

**CocoaPods**

To add the Mapbox Search SDK dependency with CocoaPods, you will need to configure your build to download the Search 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.  Add the dependency to your `Podfile`. There are two options:
    
    -   **Option 1:** To use the Search SDK with pre-built UI components, add the `MapboxSearchUI` dependency. This will also include `MapboxSearch` automatically.
    
    ```ruby
    use_frameworks!
    target "TargetNameForYourApp" do
      pod 'MapboxSearchUI', ">= 2.28.4", "< 3.0"
    end
    ```
    
    -   **Option 2:** To use the Search SDK without pre-built UI components, add the `MapboxSearch` dependency.
    
    ```ruby
    use_frameworks!
    target "TargetNameForYourApp" do
      pod 'MapboxSearch', ">= 2.28.4", "< 3.0"
    end
    ```
    
2.  Run `pod install` to install the dependency.
    

> **Note (warning): Mapbox Maps SDK and Navigation SDK compatibility**
> 
> If you want to use the Search SDK with the Mapbox Maps and Navigation SDKs, make sure you are using SDKs with the same sub-version number. For example if you are using v2.18.0 of the Search SDK, you should use v3.18.0 of the Maps SDK and use v3.18.0 of the Navigation SDK.
> 
> If you are using v2.16.0 of the Search SDK or older, review the [Search SDK release notes](https://github.com/mapbox/mapbox-search-ios/releases) to check for the correct compatible versions.

## Add search to an app

You can start by adding a search UI to your application using **Swift**.

Insert the following code snippets into your `ViewController`.

```swift
import UIKit
import MapboxSearch
import MapboxSearchUI

class ViewController: UIViewController {
    let searchController = MapboxSearchController()

    override func viewDidLoad() {
        super.viewDidLoad()
        searchController.delegate = self
        let panelController = MapboxPanelController(rootViewController: searchController)
        addChild(panelController)
    }
}

extension ViewController: SearchControllerDelegate {
    func searchResultSelected(_ searchResult: SearchResult) { }
    func categorySearchResultsReceived(category: SearchCategory, results: [SearchResult]) { }
    func userFavoriteSelected(_ userFavorite: FavoriteRecord) { }
}
```

Run your application and you will see a functional search UI. Begin typing in the search bar or click on a category to see results.

![A screenshot of the resulting application.](https://docs.mapbox.com/ios/assets/ideal-img/search-overview-final-product.46b3994.480.png)