This is a simple script to extract your Foursquare Checkins to a local database. This may be for a personal backup or for easy generation of other formats such as ICS or KML.
Foursquare used to provide feeds for personal checkins in RSS, KML, and ICS formats. Sadly in early 2019 these feeds were abandoned by Foursquare and many users report they no longer work.
One of the included scripts will generate a ICS calendar file in a similar format to what Foursquare used to provide.
-
MariaDB or MySQL for a local database
(Note: ics is potential alternative calendar library but it doesn't appear to support the GEO field)
You will need to sign up for a free Foursquare Developer account and create your own Client APP with permission to use the Places API. In creating a Client you will be asked to set an Application URL and Redirect URL - this app does not need them, but they are required to be set to allow for the initial authentication.
-
Install virtual-env
python3 -m venv venvsource venv/bin/activate -
Install the dependencies: Foursquare API library
foursquareand optionally the iCalendar library to enable ICS exporticalendarpip3 install -r requirements.txt -
Create your database with the provided schema.sql.
-
Create config.ini and fill in the database details and your Foursquare Client details from your developer account.
Authentication only needs to be done once per user. Once a user is authenticated a token is stored in the local database and this token remains valid indefinitely.
Run the auth command to generate an authentication request
./foursquare-api.py auth
https://foursquare.com/oauth2/authenticate?client_id=...
Open the printed link in your browser to grant access to this app from your own Foursquare account. This will generate a code in return.
Run the next command with the returned auth code
./foursquare-api.py auth_redirect <CODE>
A user will be inserted in the local database with a token to grant access to checkins.
Commands:
- checkins: fetch most recent 100 checkins and insert into database.
- all_checkins: fetch ALL checkins and insert into database (this may take a while).
The USER_ID will be listed in the users table after authentication.
./foursquare-api.py checkins <USER_ID>
./ics_export.py <USER_ID> <FILE.ICS>
- add sqlite database support
- streamline database creation
- streamline authentication (requires a webserver to handle redirect)
- define ICS template in a config file
- add support for exporting as KML