README.md

Untappd API (Node.js)

A Node.js client for the Untappd API. The original documentation for the API can be found here

Usage

const Untappd = require("untappd-js");
client = new Untappd(process.env.ACCESS_TOKEN);
client.pubFeed({lat, lon})
	.then(data => ...)

API

All methods are of the form method(data, [callback]). If the callback is not supplied, then the method returns a promise.

Feeds

• activityFeed: /v4/checkin/recent
• userActivityFeed: /v4/user/checkins/[USERNAME]
• pubFeed: /v4/thepub/local
• venueActivityFeed: /v4/venue/checkins/[VENUE_ID]
• beerActivityFeed: /v4/beer/checkins/${data.BID}
• breweryActivityFeed: /v4/brewery/checkins/[BREWERY_ID]
• notifications: /v4/notifications

Info / Search

• userInfo: /v4/user/info/[USERNAME]
• userWishList: /v4/user/wishlist/[USERNAME]
• userFriends: /v4/user/friends/[USERNAME]
• userBadges: /v4/user/badges/[USERNAME]
• userDistinctBeers: /v4/user/beers/[USERNAME]
• breweryInfo: /v4/brewery/info/[BREWERY_ID]
• beerInfo: /v4/beer/info/${data.BID}
• venueInfo: /v4/venue/info/[VENUE_ID]
• beerSearch: /v4/search/beer
• brewerySearch: /v4/search/brewery

Action

• checkin: /v4/checkin/add
• toast: /v4/checkin/toast/[CHECKIN_ID]
• pendingFriends: /v4/user/pending
• requestFriends: /v4/friend/request/[TARGET_ID]
• removeFriends: /v4/friend/remove/[TARGET_ID]
• acceptFriends: /v4/friend/accept/[TARGET_ID]
• rejectFriends: /v4/friend/reject/[TARGET_ID]
• addComment: /v4/checkin/addcomment/[CHECKIN_ID]
• removeComment: /v4/checkin/deletecomment/[COMMENT_ID]
• addToWishList: /v4/user/wishlist/add
• removeFromWishList: /v4/user/wishlist/remove

Utilities

• foursquareVenueLookup: /v4/venue/foursquare_lookup/[VENUE_ID]