Foursquare api tools (foursquare_api_tools)

Some functions to interact with foursquare using 'foursquare' package

Small intro

I needed to get the venues around a coordinate for a project, but wanted to get them on a dataframe to play with the data using pandas.

I found https://pypi.python.org/pypi/foursquare/ which works really good, but still had to clean the result, thus this.

I've only tried this with [https://developer.foursquare.com/docs/api/configuration/authentication](Userless Auth from Foursquare). As I'm using foursquare package it should work with user authentication.

Installation

pip install foursquare

pip install git+https://github.com/dacog/foursquare_api_tools.git#egg=foursquare_api_tools

If you are using Jupyter Notebooks use:

!pip install foursquare

!pip install git+https://github.com/dacog/foursquare_api_tools.git#egg=foursquare_api_tools

Details

help(ft)

Help on module foursquare_api_tools.foursquare_api_tools in foursquare_api_tools:

NAME
    foursquare_api_tools.foursquare_api_tools

FUNCTIONS
    get_categories()
        Function to get a Pandas DataFrame of all categories in Foursquare as listed in https://developer.foursquare.com/docs/resources/categories
        It uses json_normalize to get nested information and return a DataFrame with main, sub and sub-sub categories name and ID
    
    venues_explore(client, lat, lng, limit=100, verbose=0, sort='popular', radius=2000, offset=1, day='any')
        funtion to get n-places using explore in foursquare, where n is the limit when calling the function.
        This returns a pandas dataframe with name, city ,country, lat, long, address and main category as columns
        Arguments: *client, *lat, *long, limit (defaults to 100), radius (defaults to 2000), verbose (defaults to 0), offset (defaults to 1), day (defaults to any)

Example of use

Import libraries

import foursquare as fs
from foursquare_api_tools import foursquare_api_tools as ft

Initialize the client

CLIENT_ID = 'YOUR_CLIENT_ID' # your Foursquare ID
CLIENT_SECRET = 'YOUR_SECRET' # your Foursquare Secret
VERSION = '20180605' # Foursquare API version`

this example is Userless Auth

# Construct the client object 
client = fs.Foursquare(client_id=CLIENT_ID, client_secret=CLIENT_SECRET, version=VERSION)

Use the function

venues_explore(client,lat='40.7233',lng='-74.0030',limit=100)

Example

Here is an example on dataplatform.cloud.ibm.com https://gist.github.com/e26e21df3b93860e75fc374be89a1a53

More details about usage

def venues_explore(client,lat,lng, limit=100, verbose=0, sort='popular', radius=2000, offset=1, day='any'):
	'''funtion to get n-places using explore in foursquare, where n is the limit when calling the function.
	This returns a pandas dataframe with name, city ,country, lat, long, address and main category as columns
	Arguments: *client, *lat, *long, limit (defaults to 100), radius (defaults to 2000), verbose (defaults to 0), offset (defaults to 1), day (defaults to any)'''