Welcome

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.

With Pilgrim enabled you can customize events when a user:

  • Enters and exits any venue in our global database of over 105M places
  • Arrives at or leaves their home or work
  • Is nearby a specific venue, category of venue (i.e. Coffee Shop), or chain (i.e. Starbucks)

Pilgrim can run entirely on the client, send events to your webhook, and/or integrate directly with third-party services like Appboy, Localytics, MParticle and Urban Airship.

If you haven’t already, set up a Foursquare API key to get started!


Pilgrim SDK Access

While the Pilgrim SDK is in a beta, Foursquare must whitelist your app to enable access to the Pilgrim SDK.

Request Access


Next Steps

After Foursquare has granted you access to the SDK, learn how to configure the events you want to recieve.

Configuring Events