This document provides an overview of the Foursquare API. It defines what an API is and describes the Foursquare API, including authentication, endpoints for accessing public and private data, usage rules, and examples of applications that utilize the Foursquare API. The agenda covers API definition, insights into the Foursquare API, samples of accessing venue data without and with user authentication.

1. FOURSQUARE API
4sqCamp 2014

2. Frontend
Foursquare API
4sqtypecast
Webmontag Karlsruhe Orga
ODL
Corgi
Swarm
PHP
opendata
Cheeseburger
SU2
FirstSquare
agency
Karlsruhe
allesfoursquare

3. Agenda
API definition
__ API & Foursquare API
Foursquare API insights
__ setup, connect, response & usage rules
Venues API
__ samples without user authentification
Standard API
__ samples with user authentification

4. API
Definition

5. API Definition
In computer programming, an application
programming interface (API) is a set of routines,
protocols, and tools for building software
applications. An API expresses a software
component in terms of its operations, inputs,
outputs, and underlying types. [...] A good API
makes it easier to develop a program by providing
all the building blocks. A programmer then puts
the blocks together.
Source: Wikipedia (http://en.wikipedia.org/wiki/Application_programming_interface)

6. Foursquare API
Overview

7. Foursquare API
The Foursquare API gives you access to our
world-class places database and the ability to
interact with Foursquare users and merchants.
Start using the only location API you'll ever need.
Source: Foursquare (https://developer.foursquare.com/)

8. Authentication & Connecting
__ Set up an Foursquare Account
__ Set up your APP
__ Authenticate your APP
(client ID & client secret )
__ Ready!
https://developer.foursquare.com/start

9. Exact the same API that both
Foursquare 8.0 and Swarm use

10. Versioning & Mode
Versioning
__ API versions v >= 20140806
Mode
__ API mode m = foursquare | swarm
Foursquare mode
__ venue oriented data
Swarm mode
__ user oriented data

11. Internationalization
HTTP header
__ Accept Language
Locale parameter
__ API locale locale = en (default) | de | es | ...
HTTP header specification is preferred

12. Response
Status Codes
__ Foursquare attempts to use appropriate
HTTP status codes
For example
__ 200 = OK
__ 401 = Unauthorized
__ 500 = Internal Server Error

13. Usage Rules
We love it when people use Foursquare as their location database, but
there are some basic rules everyone has to follow. We like to think of our
policy as “you can do basically what you want, except...”

14. Usage Rules
__ free to use
__ provide proper attribution
__ allowed to cache as long as it is
refreshed appropriately
__ display Foursquare location data with
other information (attribute the data
that’s from Foursquare)

15. Usage Rules
__ scraping is allowed if it is less than
1,000 calls
__ prevent needless API calls! (prefetching)
__ don‘t show more than 4 tips/photos from
the same venue simultaneously
__ sell, rent or transfer

16. Venues API
public access - without requiring end user authentication

17. 4sqEmojiSearch
http://www.redcouchcoding.com/playground/4sq-emoticon.php

18. 4sqEmojiSearch
http://www.redcouchcoding.com/playground/4sq-emoticon.php

19. 4sqEmojiSearch
http://www.redcouchcoding.com/playground/4sq-emoticon.php

20. 4sqBarometer
Foursquare API data & offline usage

22. Allesfoursquare.de Sample
http://allesfoursquare.de/anfang-war-die-venue-erste-gehversuche-mit-der-foursquare-
venue-api/

23. Facebook APP Deutsche Bahn
https://apps.facebook.com/dbfoursquare
FB-App für @DB_Bahn by @raysono (Ray Sono)

24. Facebook APP Deutsche Bahn
https://apps.facebook.com/dbfoursquare
FB-App für @DB_Bahn by @raysono (Ray Sono)

25. Facebook APP Deutsche Bahn
https://apps.facebook.com/dbfoursquare
FB-App für @DB_Bahn by @raysono (Ray Sono)

26. Endpoints
__ venues
__categories
__explore
__search
__suggestcompletion
__trending
Aspects: events, hours, likes, links, listed, menu,
nextvenues, photos, tips

27. Endpoints
__ specials
__ search
__ tips
Aspects: likes, listed & saves
__ lists
Aspects: followers & saves

28. Standard API
private access - users need to authorize your application to
access their sensitive data

30. 4sqtypecast
http://4sq-typecast.redcouchcoding.com/

31. 4sqtypecast
http://4sq-typecast.redcouchcoding.com/

32. 4sqtypecast
http://4sq-typecast.redcouchcoding.com/

33. 4sqtypecast
http://4sq-typecast.redcouchcoding.com/

35. Telescope | Little city guides
http://www.telescopecards.com/

36. Telescope | Little city guides
http://www.telescopecards.com/

37. Telescope | Little city guides
http://www.telescopecards.com/

39. Foodspotting
http://www.foodspotting.com/ - „check-in with a photo“

40. Foodspotting
http://www.foodspotting.com/ - „check-in with a photo“

41. Jet Lovers
http://www.jetlovers.com/

42. Jet Lovers
http://www.jetlovers.com/

43. Endpoints
__ users
__requests
__search
Aspects: checkins, friends, lists, mayorships
Photos, tastes, tips, venuehistory, venuelikes
__ venues
__categories
__explore
see public access

44. Endpoints
__ venuegroups
__ checkins
__ tips
__ lists
__ updates
__ photos
__ settings
__ specials
__ events
__ pages
__ pageupdates
__ multi (up to 5 multiple requests)

45. Questions. Answers.
Discussion.

46. Thank you!
Daniel Wiegand
@wiegimania