iOS SDK

These are the docs for iOS SDK v3.2. See docs for v3.1 here.

The Radar SDK abstracts away cross-platform differences between location services, allowing you to add geofencing, location tracking, trip tracking, geocoding, and search to your apps with just a few lines of code.

Learn how to integrate the iOS SDK below. You can also see the source and a detailed SDK reference on GitHub.

Install SDK#

The best way to install the SDK is via CocoaPods or Carthage.

For details on the latest SDK releases, see the releases page on GitHub. You can also star ⭐️ and watch 👀 the repo.

The SDK is small and typically adds less than 500 KB to your compiled app.

CocoaPods#

Install CocoaPods. If you don't have an existing Podfile, run pod init in your project directory. Add the following to your Podfile:

pod 'RadarSDK', '~> 3.2.0'

Then, run pod install. You may also need to run pod repo update.

After installing, use the .xcworkspace file to open your project in Xcode instead of the .xcproject file.

Swift Package Manager#

In Xcode, go to File > Swift Packages > Add Package Dependency. Enter https://github.com/radarlabs/radar-sdk-ios.git for the Package Repository URL.

Carthage#

Install Carthage. To include Radar as a github origin, add the following to your Cartfile:

github "radarlabs/radar-sdk-ios" ~> 3.2.0

To include Radar as a binary origin, add the following to your Cartfile:

binary "https://raw.githubusercontent.com/radarlabs/radar-sdk-ios/master/RadarSDK.json" ~> 3.2.0

Then, run carthage update and drag Build/iOS/RadarSDK.framework into the Linked Frameworks and Libraries section of your target. Do not add the framework as an input to your copy-frameworks run script.

Add manually#

You can also add the SDK to your project manually. Download the current release, unzip the package, and drag RadarSDK.xcframework into your Xcode project. It will automatically appear in the Frameworks, Libraries, and Embedded Content section of your target settings. Switch Do Not Embed to Embed & Sign.

Dependencies#

The SDK depends on Apple's CoreLocation framework. In your target settings, go to General > Frameworks, Libraries, and Embedded Content and add CoreLocation if you haven't already.

The SDK currently supports iOS 10 and higher.

Initialize SDK#

When your app starts, initialize the SDK with your publishable API key, found on the Settings page.

Use your Test Publishable key for testing and non-production environments. Use your Live Publishable key for production environments.

Note that you should always use your publishable API keys, which are restricted in scope, in the SDK. Do not use your secret API keys, which are unrestricted in scope, in any client-side code.

Swift
Objective-C

import UIKit
import RadarSDK

@UIApplicationMain
class AppDelegate: UIResponder, UIApplicationDelegate {

    func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?) -> Bool {
        Radar.initialize(publishableKey: "prj_test_pk_...")

        return true
    }

}

Request permissions#

Radar respects standard iOS location permissions.

For foreground tracking or trip tracking with continuous mode, the app's location authorization status must be or. For background tracking or geofencing with responsive mode, the app's location authorization status must be .

If your app already requests the necessary location permissions, you can skip this step.

Before requesting permissions, you must add location usage strings to your Info.plist file. For foreground permissions, you must add a value for NSLocationWhenInUseUsageDescription (Privacy - Location When In Use Usage Description). For background permissions, you must add a value for NSLocationAlwaysAndWhenInUseUsageDescription (Privacy - Location Always and When In Use Usage Description). These strings are displayed in permissions prompts.

To request foreground permissions, call on a CLLocationManager instance. To request background permissions in the app, make sure the user has granted foreground permissions first, then call on a CLLocationManager instance.

To request foreground location permissions and then immediately request background location permissions:

Swift
Objective-C

import UIKit
import RadarSDK

@UIApplicationMain
class AppDelegate: UIResponder, UIApplicationDelegate, CLLocationManagerDelegate {

    let locationManager = CLLocationManager()

    func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?) -> Bool {
        Radar.initialize(publishableKey: "prj_test_pk_...")
        self.locationManager.delegate = self
        self.requestLocationPermissions()

        return true
    }

    func locationManager(_ manager: CLLocationManager, didChangeAuthorization status: CLAuthorizationStatus) {
        self.requestLocationPermissions()
    }

    func requestLocationPermissions() {
        let status = self.locationManager.authorizationStatus()

        if status == .notDetermined {
            self.locationManager.requestWhenInUseAuthorization()
        } else if status == .authorizedWhenInUse {
            self.locationManager.requestAlwaysAuthorization()
        }
    }

}

Build and run the app to make sure permissions prompts are displayed!

Not seeing permissions prompts? First, make sure your location manager is in memory when you request permissions. Second, make sure you've added location usage strings to your Info.plist file. Finally, check your device settings to make sure you haven't already granted location permissions.

If you are requesting background permissions, in your project settings, go to Signing & Capabilities, add Background Modes, and turn on Background fetch and Location updates. Note that this requires additional justification during App Store review. Learn more below.

Foreground tracking#

Once the user has granted foreground permissions, you can track the user's location in the foreground.

To track the user's location once in the foreground, call:

Swift
Objective-C

Radar.trackOnce { (status: RadarStatus, location: CLLocation?, events: [RadarEvent]?, user: RadarUser?) in
    // do something with location, events, user
}

You may provide an optional completionHandler that receives the request status, the user's location, the events generated, if any, and the user. The request status can be:

: success
: SDK not initialized
: location permissions not granted
: location services error or timeout (10 seconds)
: network error or timeout (10 seconds)
: bad request (missing or invalid params)
: unauthorized (invalid API key)
: payment required (organization disabled or usage exceeded)
: forbidden (insufficient permissions)
: not found
: too many requests (rate limit exceeded)
: internal server error
: unknown error

Build and run the app, then find your user on the Users page! To trigger an event, you'll need to create a geofence if you haven't already. Not seeing your user on the Users page? Check status in the completionHandler to see what went wrong.

Background tracking for geofencing#

Once you have initialized the SDK and the user has authorized background permissions, you can start tracking the user's location in the background.

The SDK supports custom tracking options as well as three presets.

For geofencing, we recommend using RadarTrackingOptions.presetResponsive. This preset detects whether the device is stopped or moving. When moving, it tells the SDK to send location updates to the server every 2-3 minutes. When stopped, it tells the SDK to shut down to save battery. Once stopped, the device will need to move more than 100 meters to wake up and start moving again.

Assuming the user has authorized background permissions, background tracking will work even if the app has been backgrounded or killed, as iOS location services will wake up the app to deliver events.

Note that location updates may be delayed by if the device has connectivity issues, low battery, or wi-fi disabled.

Though we recommend using presets for most use cases, you can modify the presets. See the tracking options reference.

To start tracking for geofencing, call:

Swift
Objective-C

Radar.startTracking(trackingOptions: RadarTrackingOptions.presetResponsive)

To stop tracking (e.g., when the user logs out), call:

Swift
Objective-C

Radar.stopTracking()

You only need to call these methods once, as these settings will be persisted across app sessions.

To test, go for a walk or a drive! Not seeing location updates or events? Remember that, once stopped, the device will need to move more than 100 meters to wake up and start moving again. Also, check your device settings to make sure you've granted background location permissions.

Don't forget! You can always find your user on the Users page or events on the Events page. To trigger an event, you'll need to create a geofence if you haven't already.

Background tracking for trips#

For trips, we recommend using RadarTrackingOptions.presetContinuous. This preset tells the SDK to send location updates to the server every 30 seconds, regardless of whether the device is moving.

By default, this preset shows the flashing blue status bar while tracking. If the flashing blue status bar is shown, only foreground permissions are required for tracking.

To start tracking for trips, call:

Swift
Objective-C

Radar.startTracking(trackingOptions: RadarTrackingOptions.presetContinuous)

Not seeing the flashing blue status bar while tracking? Make sure you've added the Location updates background mode in your project settings.

To stop tracking, call:

Swift
Objective-C

Radar.stopTracking()

Learn more about starting, completing, and canceling trips in the trip tracking documentation.

Don't forget! You can always find your user on the Users page or events on the Events page. To trigger an event, you'll need to create a geofence or start a trip if you haven't already. Also, check your device settings to make sure you've granted location permissions.

Mock tracking for testing#

Can't go for a walk or a drive? You can simulate a sequence of location updates. For example, to simulate a sequence of 10 location updates every 3 seconds by car from an origin to a destination, call:

Swift
Objective-C

Radar.mockTracking(
  origin: CLLocation(latitude: 40.714708, longitude: -74.035807),
  destination: CLLocation(latitude: 40.717410, longitude: -74.053334),
  mode: .car,
  steps: 10,
  interval: 3) { (status: RadarStatus, location: CLLocation?, events: [RadarEvent]?, user: RadarUser?) in
    // do something with location, events, user
}

Don't forget! You can always find your user on the Users page or events on the Events page. To trigger an event, you'll need to create a geofence if you haven't already.

Listening for events with a delegate#

To listen for events, location updates, and errors client-side, set a RadarDelegate. Set your RadarDelegate in a codepath that will be initialized and executed in the background. For example, make your AppDelegate implement RadarDelegate, not a ViewController. AppDelegate will be initialized in the background, whereas a ViewController may not be.

Swift
Objective-C

import UIKit
import RadarSDK

@UIApplicationMain
class AppDelegate: UIResponder, UIApplicationDelegate, RadarDelegate {

    func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplicationLaunchOptionsKey: Any]?) -> Bool {
        Radar.initialize(publishableKey: "prj_test_pk...")
        Radar.setDelegate(self)

        return true
    }

    func didReceiveEvents(_ events: [RadarEvent], user: RadarUser?) {
        // do something with events, user
    }

    func didUpdateLocation(_ location: CLLocation, user: RadarUser) {
        // do something with location, user
    }

    func didUpdateClientLocation(_ location: CLLocation, stopped: Bool, source: RadarLocationSource) {
        // do something with location, stopped, source
    }

    func didFail(status: RadarStatus) {
        // do something with status
    }

}

To listen for events server-side instead, add a webhook or enable an integration.

Manual tracking#

If you want to manage location services yourself, you can manually update the user's location instead by calling:

Swift
Objective-C

Radar.trackOnce(
  location: location
) { (status: RadarStatus, location: CLLocation?, events: [RadarEvent]?, user: RadarUser?) in
    // do something with location, events, user
}

where location is a CLLocation instance with a valid latitude, longitude, and horizontal accuracy.

Identify user#

The SDK automatically generates a unique installId on every fresh install. Radar creates a new user record for every unique installId.

In addition, you can use other identifiers to identify the user.

Radar will automatically identify the user by deviceId (IDFV).

To set a custom userId, call:

Swift
Objective-C

Radar.setUserId(userId)

where userId is a stable unique ID for the user.

Do not send any PII, like names, email addresses, or publicly available IDs, for userId. See privacy best practices for more information.

To set a dictionary of custom metadata for the user, call:

Swift
Objective-C

Radar.setMetadata(metadata)

where metadata is a dictionary with up to 16 keys and values of type string, boolean, or number.

Finally, to set an optional description for the user, displayed in the dashboard, call:

Swift
Objective-C

Radar.setDescription(description)

You only need to call these methods once, as these settings will be persisted across app sessions.

Submit to App Store#

Apple requires that you justify your use of background location. Add something materially similar to the following to the bottom of your App Store description: This app uses background location to (insert use case here). Continued use of background location may decrease battery life.

If you turned on the Location updates background mode, Apple requires additional justification in your App Store review notes. If using RadarTrackingOptions.presetResponsive, add something like: This app uses the Radar SDK (https://radar.io) to (insert use case here). The Radar SDK requires the background location mode to support polygon geofences and nearby place detection, which cannot be accomplished with region monitoring or visit monitoring. Or, if using RadarTrackingOptions.presetContinuous, add something like This app uses the Radar SDK (https://radar.io) to (insert use case here). The Radar SDK requires the location background mode for live trip tracking and live ETAs.

Learn more about this requirement in section 2.5.4 of the App Store Review Guidelines here.

Other APIs#

The iOS SDK also exposes APIs for beacons, anonymous context, geocoding, search, and distance.

Beacons#

If the user has granted location permissions, you can range and monitor beacons.

To range beacons in the foreground, call:

Swift
Objective-C

Radar.trackOnce(desiredAccuracy: .high, beacons: true) { (status: RadarStatus, location: CLLocation?, events: [RadarEvent]?, user: RadarUser?) in
    // do something with user.beacons
}

To monitor beacons in the background, update your tracking options:

Swift
Objective-C

let trackingOptions = RadarTrackingOptions.presetResponsive
trackingOptions.beacons = true
Radar.startTracking(trackingOptions: trackingOptions)

Get location#

Get a single location update without sending it to the server:

Swift
Objective-C

Radar.getLocation { (status: RadarStatus, location: CLLocation?, stopped: Bool) in
    // do something with location
}

Context#

With the context API, get context for a location without sending device or user identifiers to the server:

Swift
Objective-C

Radar.getContext { (status: RadarStatus, location: CLLocation?, context: RadarContext?) in
    // do something with context
}

Geocoding#

With the forward geocoding API, geocode an address, converting address to coordinates:

Swift
Objective-C

Radar.geocode(
    address: "20 jay st brooklyn ny"
) { (status: RadarStatus, addresses: [RadarAddress]?) in
    // do something with addresses
}

With the reverse geocoding API, reverse geocode a location, converting coordinates to address:

Swift
Objective-C

Radar.reverseGeocode(
    location: location
) { (status: RadarStatus, addresses: [RadarAddress]?) in
    // do something with addresses
}

With the IP geocoding API, geocode the device's current IP address, converting IP address to city, state, and country:

Swift
Objective-C

Radar.ipGeocode { (status: RadarStatus, address: RadarAddress, proxy: Bool) in
    // do something with address, proxy
}

Search#

With the autocomplete API, autocomplete partial addresses and place names, sorted by relevance:

Swift
Objective-C

Radar.autocomplete(
    query: "brooklyn roasting",
    near: location,
    limit: 10
) { (status: RadarStatus, addresses: [RadarAddress]?) in
  // do something with addresses
}

With the geofence search API, search for geofences near a location, sorted by distance:

Swift
Objective-C

Radar.searchGeofences(
    near: location,
    radius: 1000, // meters
    tags: ["store"],
    metadata: nil,
    limit: 10
) { (status: RadarStatus, location: CLLocation?, geofences: [RadarGeofence]?) in
  // do something with geofences
}

With the places search API, search for places near a location, sorted by distance:

Swift
Objective-C

Radar.searchPlaces(
    near: location,
    radius: 1000, // meters
    chains: ["starbucks"],
    categories: nil,
    groups: nil,
    limit: 10
) { (status: RadarStatus, location: CLLocation?, places: [RadarPlace]?) in
  // do something with places
}

Distance#

With the distance API, calculate the travel distance and duration between an origin and a destination:

Swift
Objective-C

Radar.getDistance(
    origin: origin,
    destination: destination,
    modes: [.foot, .car],
    units: .imperial
) { (status: RadarStatus, routes: RadarRoutes?) in
  // do something with routes
}

Matrix#

With the matrix API, calculate the travel distance and duration between multiple origins and destinations for up to 25 routes:

Swift
Objective-C

Radar.getMatrix(
    origins: origins,
    destinations: destinations,
    mode: .car,
    units: .imperial
) { (status: RadarStatus, matrix: RadarRouteMatrix?) in
  // do something with matrix.routeBetween(originIndex:destinationIndex:)
}