Dodge

An API client for Foursquare's Venues Service.

Installation

npm install dodge --save

Usage

Register your app with the Foursquare API to recieve a Client ID and Client Secret.

var Dodge, client, apiOptions;

Dodge = require('dodge');

client = new Dodge({
  clientId: 'four',
  clientSecret: 'square'
});

/* varies by endpoint; refer to Foursquare documentation */
apiOptions = {
  categoryId: '4bf58dd8d48988d122941735',
  intent: 'browse',
  near: 'Chicago, IL'
}

client.venues.search(apiOptions, function(err, venues){
  /* do something */
});

Endpoints

Dodge supports endpoints that are part of Foursquare's Venues Service and do not require user authentication.

General Endpoints

| Endpoint | Description (link to API documentation) | Supported? | | -------------------------- | -------------------------------------------------------- | ---------------------- | | venues/categories | Venue Categories | Yes :white_check_mark: | | venues/explore | Explore Recommended and Popular Venues | Not Yet :x: | | venues/search | Search Venues | Yes :white_check_mark: | | venues/suggestcompletion | Suggest Completion Venues | Yes :white_check_mark: | | venues/trending | Trending Venues | Not Yet :x: |

Venue-specific Endpoints

| Endpoint | Description (link to API documentation) | Supported? | | ---------------------------- | -------------------------------------------------- | ---------------------------------- | | venues/<venue> | Venue Details | Yes :white_check_mark: | | venues/<venue>/events | Venue Events | Yes :white_check_mark: | | venues/<venue>/hours | Venue Hours | Yes :white_check_mark: | | venues/<venue>/likes | Users who have liked a venue | Yes :white_check_mark: | | venues/<venue>/links | Links For a Venue | Yes :white_check_mark: | | venues/<venue>/listed | Lists | Yes1 :white_check_mark: | | venues/<venue>/menu | Venue Menu | Yes :white_check_mark: | | venues/<venue>/nextvenues | Next Venues | Yes :white_check_mark: | | venues/<venue>/photos | Photos from a Venue | Yes2 :white_check_mark: | | venues/<venue>/tips | Tips from a Venue | Yes :white_check_mark: |

1: Does not accept a group parameter. Only others is supported without an acting user, so that parameter is passed by the library.

2: Supported group parameters: none or venue (checkin require an acting user, which is not supported.)