Documentationarrow right
iconHomeHomeiconPlacesApiPlaces APIiconPilgrimSdkPilgrim SDKiconPlacesDatabasePlaces DatabaseiconBuildWithFoursquareBuild with FoursquareiconDevConsoleDeveloper ConsoleiconUserGuidelinesUsage Guidelines

Welcome to the Pilgrim SDK—the always on, passive location detection engine by Foursquare.

The Pilgrim SDK provides contextual awareness to mobile applications and connected devices to understand where and how your users are moving through the real world.

Key Features

Feature Description
Visit Detection Identify when a user has entered and stopped at a specific venue, category, or chain.
Geofence Events Tell when a device’s GPS has entered, exited, or remained within a place for a certain amount of time (dwell).
Home and Work Detection Determine the user’s home and work location after 3-7 days of SDK usage
User States Interact with your users based on their current state: home/work, travel, or commute
Integrations Integrate Pilgrim event detection with server-side or third-party integrations
Event Logging Get visibility into device activity to confirm Pilgrim is properly implemented into your app
Usage Statistics Explore past analytics on tracked users, visits, geofence events

Get Started in 5 Easy Steps!

Install the SDK

Get the SDK for any of the following platforms:

iOS Android

Customize and Configure Events

Configure events for when a user enters and exits a venue, arrives at or leaves home/work, or is at at specific venue, category, or chain.

Configuration

Advanced setup

Integrate

Handle events on the client, send to your webhook, and/or integrate directly with third-party services such as Braze, Localytics, and Urban Airship.

All Integrations

Webhooks

Third-Party

Next Steps

Now that you're all set to use our Pilgrim SDK, be sure to check out these additional links to get you live:

Debug Mode

Geofences

FAQ