X

Today is a good day to change your password - Read More

API Documentation (V4)

API Endpoints

The end point for all Untappd API is
http://api.untappd.com/v4

Client ID / Client Secret

In V4 of the API, we have added Client ID and Client Secrets. You can find them on your Dashboard page. You Client ID is your old API Key, while the Client Secret has been added. Whenever you are making a call to the API, you MUST pass both your Client ID and Client Secret as GET params like below:
http://api.untappd.com/v4/method_name?client_id=CLIENTID&client_secret=CLIENTSECRET

When making Authenticated requests, you will append the access token to the URL below.
http://api.untappd.com/v4/method_name?access_token=ACESSTOKENHERE See the Authentication section for more details.

Response

The responses in V4 has completely been re-written to match other APIs to make parsing easier. Responses are in the format below:

"meta":{
      "code":200,
      "response_time":{
         "time": X.XXX,
         "measure":"seconds"
      }
   },
   "notifications":{
      "type":"notifications",
      "unread_count":{
         "comments":0,
         "toasts":0,
         "friends":0,
         "news":0
      }
   },
   "response":{  ... }}
							

In the header packet, we pass 2 special attributes that can help you track the usage of your API key:

								X-Ratelimit-Limit: XXXX
								X-Ratelimit-Remaining: XXX
							

In the event of an error, the format looks like this:

"meta":{
      "code":500,
      "error_detail":"The user has not authorized this application or the token is invalid.",
      "error_type":"invalid_auth",
      "response_time":{
         "time":0.002,
         "measure":"seconds"
      }
   },
   "response":[]
							

Additonal Information

In every beer attribtue, you will see the following values auth_rating and wish_list. These values refer to the authenticated user's rating and if they have added this beer to their wish list.

Note: By using the API, you state that your application is in accordance with our Terms of Use for our API.

Authentication

Authentication is handled via OAuth Authentication. You must edit your app and add in a redirect URL that Untappd will callback after the authorization has taken place. You will receive an accesss token to make an authenticated calls. At this time, tokens do not expire.

Server Side Authentication (Recommended)

NOTE: You must use HTTPS, and not HTTP when making authentication calls. All API level calls must be done with HTTP, however this authentication process must be sent over HTTPS

Direct the user to the following URL:
https://untappd.com/oauth/authenticate/?client_id=CLIENTID&response_type=code&redirect_url=REDIRECT_URL

After the user has authenticated and authorized the application, we will redirect back to the following address:
http://REDIRECT_URL?code=CODE

Take the code paramater and then pass it back to the following address via GET (pass parameters via the Query String). Ensure that the REDIRECT_URL you supply in this call, is the same that was supplied in the authenticate call:
https://untappd.com/oauth/authorize/?client_id=CLIENTID&client_secret=CLIENTSECRET&response_type=code&redirect_url=REDIRECT_URL&code=CODE

Finally, we will send back the access_token that will you use for future requests:
"meta":{ "http_code":200 }, "response" : { "access_token":{ "TOKENHERE" } }

Client Side Authentication

Direct the user to the following URL:
http://untappd.com/oauth/authenticate/?client_id=CLIENTID&response_type=token&redirect_url=REDIRECT_URL

After the user has logged in we will redirect back to the following address:
http://REDIRECT_URL#access_token=TOKENHERE

Friend Feed

Authentication: Required

HTTP Method: GET

/v4/checkin/recent

This method allows you the obtain all the friend check-in feed of the authenticated user. This includes only beer checkin-ins from Friends. By default it will return at max 25 records.

Parameters

  • access_token (required) - The access token of the authenicated user
  • max_id (int, optional) - The checkin ID that you want the results to start with
  • limit (int, optional) - The number of results to return, max of 50, default is 25
"checkins":{
	"count":25,
	"items":[
	{
	   "checkin_id":10608945,
	   "created_at":"Sun, 29 Jul 2012 22:19:16 +0000",
	   "checkin_comment":"",
	   "rating_score":3,
	   "user":{
	      "uid":1,
	      "user_name":"gregavola",
	      "first_name":"Greg",
	      "last_name":"Avola",
	      "location":"New York, NY",
	      "url":"http:\/\/gregavola.me",
	      "bio":"Co-Founder and CTO of Untappd, Web Developer, Beer Drinker, Community Guy",
	      "relationship":"self",
	      "user_avatar":"http:\/\/gravatar.com\/avatar\/0c6922e238dae5cccce96a32889fc911?size=100&d=https%3A%2F%2Funtappd.s3.amazonaws.com%2Fsite%2Fassets%2Fimages%2Fdefault_avatar.jpg",
	      "is_private":0,
	      "contact":{
	         "gowalla":"gregavola",
	         "foursquare":195741,
	         "facebook":18603076,
	         "twitter":"gregavola"
	      }
	   },
	   "beer":{
	      "bid":3916,
	      "beer_name":"Samuel Adams Summer Ale",
	      "beer_label":"https:\/\/untappd.s3.amazonaws.com\/site\/beer_logos\/beer-SamAdamsSummerAle.jpg",
	      "beer_style":"American Pale Wheat Ale",
	      "beer_abv":5.2,
	      "auth_rating":3,
	      "wish_list":false
	   },
	   "brewery":{
	      "brewery_id":157,
	      "brewery_name":"Boston Beer Company",
	      "brewery_label":"https:\/\/untappd.s3.amazonaws.com\/site\/brewery_logos\/brewery-SamuelAdams.jpg",
	      "country_name":"United States",
	      "contact":{
	         "twitter":"SamuelAdamsBeer",
	         "facebook":"http:\/\/www.facebook.com\/pages\/Samuel-Adams-for-the-love-of-beer\/117341921610",
	         "url":"http:\/\/www.samueladams.com"
	      },
	      "location":{
	         "brewery_city":"Boston",
	         "brewery_state":"MA",
	         "lat":42.3144,
	         "lng":-71.1034
	      }
	   },
	   "venue":{
	      "venue_id":1222,
	      "venue_name":"Untappd HQ - East",
	      "primary_category":"Residence",
	      "parent_category_id":"4e67e38e036454776db1fb3a",
	      "categories":{
	         "count":2,
	         "items":[
	            {
	               "category_name":"Tech Startup",
	               "category_id":"4bf58dd8d48988d125941735",
	               "is_primary":false
	            },
	            {
	               "category_name":"Home (private)",
	               "category_id":"4bf58dd8d48988d103941735",
	               "is_primary":true
	            }
	         ]
	      },
	      "location":{
	         "venue_address":"",
	         "venue_city":"",
	         "venue_state":"",
	         "lat":40.7559,
	         "lng":-73.9536
	      },
	      "contact":{
	         "twitter":"@untappd",
	         "venue_url":"http:\/\/untappd.com"
	      },
	      "foursquare":{
	         "foursquare_id":"4ccf5fec1ac7a1cd6a5c1392",
	         "foursquare_url":"http:\/\/4sq.com\/boEpZE"
	      },
	      "venue_icon":{
	         "sm":"https:\/\/foursquare.com\/img\/categories\/building\/home_64.png",
	         "md":"https:\/\/foursquare.com\/img\/categories\/building\/home_88.png",
	         "lg":"https:\/\/foursquare.com\/img\/categories\/building\/home_256.png"
	      }
	   },
	   "comments":{
	      "count":0,
	      "items":[

	      ]
	   },
	   "toasts":{
	      "count":1,
	      "auth_toast":false,
	      "items":[
	         {
	            "user":{
	               "uid":42235,
	               "user_name":"peterepp",
	               "first_name":"Peter",
	               "last_name":"Epp",
	               "user_avatar":"http:\/\/gravatar.com\/avatar\/470b0592970286c93a8b735598c71b87?size=100&d=https%3A%2F%2Funtappd.s3.amazonaws.com%2Fsite%2Fassets%2Fimages%2Fdefault_avatar.jpg",
	               "user_link":"http:\/\/untappd.com\/user\/peterepp",
	               "account_type":"user",
	               "brewery_details":[

	               ]
	            },
	            "like_id":"1225920",
	            "like_owner":false,
	            "created_at":"Sun, 29 Jul 2012 22:29:51 +0000"
	         }
	      ]
	   },
	   "media":{
	      "count":0,
	      "items":[

	      ]
	   },
	   "source":{
	      "app_name":"Untappd for Android - (V2)",
	      "app_website":"http:\/\/untpd.it\/androidapp"
	   }
	}, 
            ...
							

User Feed

Authentication: Not required

HTTP Method: GET

/v4/user/checkins/USERNAME

This method allows you the obtain all the check-in feed of the selected user. By default it will return at max 25 records.

Parameters

  • access_token or client_id and client_secret (required) - Either pass the access_token for authorized calls OR the client_id and client_secret for unauthorized calls
  • USERNAME (optional) - The username that you wish to call the request upon. If you do not provide a username - the feed will return results from the authenticated user (if the access_token is provided)
  • max_id (int, optional) - The checkin ID that you want the results to start with
  • limit (int, optional) - The number of results to return, max of 50, default is 25
"checkins":{
	"count":25,
	"items":[
	{
	   "checkin_id":10608945,
	   "created_at":"Sun, 29 Jul 2012 22:19:16 +0000",
	   "checkin_comment":"",
	   "rating_score":3,
	   "user":{
	      "uid":1,
	      "user_name":"gregavola",
	      "first_name":"Greg",
	      "last_name":"Avola",
	      "location":"New York, NY",
	      "url":"http:\/\/gregavola.me",
	      "bio":"Co-Founder and CTO of Untappd, Web Developer, Beer Drinker, Community Guy",
	      "relationship":"self",
	      "user_avatar":"http:\/\/gravatar.com\/avatar\/0c6922e238dae5cccce96a32889fc911?size=100&d=https%3A%2F%2Funtappd.s3.amazonaws.com%2Fsite%2Fassets%2Fimages%2Fdefault_avatar.jpg",
	      "is_private":0,
	      "contact":{
	         "gowalla":"gregavola",
	         "foursquare":195741,
	         "facebook":18603076,
	         "twitter":"gregavola"
	      }
	   },
	   "beer":{
	      "bid":3916,
	      "beer_name":"Samuel Adams Summer Ale",
	      "beer_label":"https:\/\/untappd.s3.amazonaws.com\/site\/beer_logos\/beer-SamAdamsSummerAle.jpg",
	      "beer_style":"American Pale Wheat Ale",
	      "beer_abv":5.2,
	      "auth_rating":3,
	      "wish_list":false
	   },
	   "brewery":{
	      "brewery_id":157,
	      "brewery_name":"Boston Beer Company",
	      "brewery_label":"https:\/\/untappd.s3.amazonaws.com\/site\/brewery_logos\/brewery-SamuelAdams.jpg",
	      "country_name":"United States",
	      "contact":{
	         "twitter":"SamuelAdamsBeer",
	         "facebook":"http:\/\/www.facebook.com\/pages\/Samuel-Adams-for-the-love-of-beer\/117341921610",
	         "url":"http:\/\/www.samueladams.com"
	      },
	      "location":{
	         "brewery_city":"Boston",
	         "brewery_state":"MA",
	         "lat":42.3144,
	         "lng":-71.1034
	      }
	   },
	   "venue":{
	      "venue_id":1222,
	      "venue_name":"Untappd HQ - East",
	      "primary_category":"Residence",
	      "parent_category_id":"4e67e38e036454776db1fb3a",
	      "categories":{
	         "count":2,
	         "items":[
	            {
	               "category_name":"Tech Startup",
	               "category_id":"4bf58dd8d48988d125941735",
	               "is_primary":false
	            },
	            {
	               "category_name":"Home (private)",
	               "category_id":"4bf58dd8d48988d103941735",
	               "is_primary":true
	            }
	         ]
	      },
	      "location":{
	         "venue_address":"",
	         "venue_city":"",
	         "venue_state":"",
	         "lat":40.7559,
	         "lng":-73.9536
	      },
	      "contact":{
	         "twitter":"@untappd",
	         "venue_url":"http:\/\/untappd.com"
	      },
	      "foursquare":{
	         "foursquare_id":"4ccf5fec1ac7a1cd6a5c1392",
	         "foursquare_url":"http:\/\/4sq.com\/boEpZE"
	      },
	      "venue_icon":{
	         "sm":"https:\/\/foursquare.com\/img\/categories\/building\/home_64.png",
	         "md":"https:\/\/foursquare.com\/img\/categories\/building\/home_88.png",
	         "lg":"https:\/\/foursquare.com\/img\/categories\/building\/home_256.png"
	      }
	   },
	   "comments":{
	      "count":0,
	      "items":[

	      ]
	   },
	   "toasts":{
	      "count":1,
	      "auth_toast":false,
	      "items":[
	         {
	            "user":{
	               "uid":42235,
	               "user_name":"peterepp",
	               "first_name":"Peter",
	               "last_name":"Epp",
	               "user_avatar":"http:\/\/gravatar.com\/avatar\/470b0592970286c93a8b735598c71b87?size=100&d=https%3A%2F%2Funtappd.s3.amazonaws.com%2Fsite%2Fassets%2Fimages%2Fdefault_avatar.jpg",
	               "user_link":"http:\/\/untappd.com\/user\/peterepp",
	               "account_type":"user",
	               "brewery_details":[

	               ]
	            },
	            "like_id":"1225920",
	            "like_owner":false,
	            "created_at":"Sun, 29 Jul 2012 22:29:51 +0000"
	         }
	      ]
	   },
	   "media":{
	      "count":0,
	      "items":[

	      ]
	   },
	   "source":{
	      "app_name":"Untappd for Android - (V2)",
	      "app_website":"http:\/\/untpd.it\/androidapp"
	   }
	}, 
            ...
							

The Public Feed (Local)

Authentication: Not required

HTTP Method: GET

/v4/thepub/local

This method allows you the obtain all the public feed for Untappd, within a certain location. By default it will return at max 25 records.

Parameters

  • access_token or client_id and client_secret (required) - Either pass the access_token for authorized calls OR the client_id and client_secret for unauthorized calls
  • min_id (int, optional) - The numeric ID of the most recent check-in.
  • lng (float, optional) - The numeric Latitude to filter the public feed.
  • lat (float, optional) - The numeric Longitude to filter the public feed.
  • radius (int, optional) - The max radius you would like the check-ins to start within
  • max_id (int, optional) - The checkin ID that you want the results to start with
  • limit (int, optional) - The number of results to return, max of 50, default is 25
"checkins":{
	"count":25,
	"items":[
	{
	   "checkin_id":10608945,
	   "created_at":"Sun, 29 Jul 2012 22:19:16 +0000",
	   "checkin_comment":"",
	   "rating_score":3,
	   "user":{
	      "uid":1,
	      "user_name":"gregavola",
	      "first_name":"Greg",
	      "last_name":"Avola",
	      "location":"New York, NY",
	      "url":"http:\/\/gregavola.me",
	      "bio":"Co-Founder and CTO of Untappd, Web Developer, Beer Drinker, Community Guy",
	      "relationship":"self",
	      "user_avatar":"http:\/\/gravatar.com\/avatar\/0c6922e238dae5cccce96a32889fc911?size=100&d=https%3A%2F%2Funtappd.s3.amazonaws.com%2Fsite%2Fassets%2Fimages%2Fdefault_avatar.jpg",
	      "is_private":0,
	      "contact":{
	         "gowalla":"gregavola",
	         "foursquare":195741,
	         "facebook":18603076,
	         "twitter":"gregavola"
	      }
	   },
	   "beer":{
	      "bid":3916,
	      "beer_name":"Samuel Adams Summer Ale",
	      "beer_label":"https:\/\/untappd.s3.amazonaws.com\/site\/beer_logos\/beer-SamAdamsSummerAle.jpg",
	      "beer_style":"American Pale Wheat Ale",
	      "beer_abv":5.2,
	      "auth_rating":3,
	      "wish_list":false
	   },
	   "brewery":{
	      "brewery_id":157,
	      "brewery_name":"Boston Beer Company",
	      "brewery_label":"https:\/\/untappd.s3.amazonaws.com\/site\/brewery_logos\/brewery-SamuelAdams.jpg",
	      "country_name":"United States",
	      "contact":{
	         "twitter":"SamuelAdamsBeer",
	         "facebook":"http:\/\/www.facebook.com\/pages\/Samuel-Adams-for-the-love-of-beer\/117341921610",
	         "url":"http:\/\/www.samueladams.com"
	      },
	      "location":{
	         "brewery_city":"Boston",
	         "brewery_state":"MA",
	         "lat":42.3144,
	         "lng":-71.1034
	      }
	   },
	   "venue":{
	      "venue_id":1222,
	      "venue_name":"Untappd HQ - East",
	      "primary_category":"Residence",
	      "parent_category_id":"4e67e38e036454776db1fb3a",
	      "categories":{
	         "count":2,
	         "items":[
	            {
	               "category_name":"Tech Startup",
	               "category_id":"4bf58dd8d48988d125941735",
	               "is_primary":false
	            },
	            {
	               "category_name":"Home (private)",
	               "category_id":"4bf58dd8d48988d103941735",
	               "is_primary":true
	            }
	         ]
	      },
	      "location":{
	         "venue_address":"",
	         "venue_city":"",
	         "venue_state":"",
	         "lat":40.7559,
	         "lng":-73.9536
	      },
	      "contact":{
	         "twitter":"@untappd",
	         "venue_url":"http:\/\/untappd.com"
	      },
	      "foursquare":{
	         "foursquare_id":"4ccf5fec1ac7a1cd6a5c1392",
	         "foursquare_url":"http:\/\/4sq.com\/boEpZE"
	      },
	      "venue_icon":{
	         "sm":"https:\/\/foursquare.com\/img\/categories\/building\/home_64.png",
	         "md":"https:\/\/foursquare.com\/img\/categories\/building\/home_88.png",
	         "lg":"https:\/\/foursquare.com\/img\/categories\/building\/home_256.png"
	      }
	   },
	   "comments":{
	      "count":0,
	      "items":[

	      ]
	   },
	   "toasts":{
	      "count":1,
	      "auth_toast":false,
	      "items":[
	         {
	            "user":{
	               "uid":42235,
	               "user_name":"peterepp",
	               "first_name":"Peter",
	               "last_name":"Epp",
	               "user_avatar":"http:\/\/gravatar.com\/avatar\/470b0592970286c93a8b735598c71b87?size=100&d=https%3A%2F%2Funtappd.s3.amazonaws.com%2Fsite%2Fassets%2Fimages%2Fdefault_avatar.jpg",
	               "user_link":"http:\/\/untappd.com\/user\/peterepp",
	               "account_type":"user",
	               "brewery_details":[

	               ]
	            },
	            "like_id":"1225920",
	            "like_owner":false,
	            "created_at":"Sun, 29 Jul 2012 22:29:51 +0000"
	         }
	      ]
	   },
	   "media":{
	      "count":0,
	      "items":[

	      ]
	   },
	   "source":{
	      "app_name":"Untappd for Android - (V2)",
	      "app_website":"http:\/\/untpd.it\/androidapp"
	   }
	}, 
            ...
							

Beer Feed

Authentication: Not required

HTTP Method: GET

/v4/beer/checkins/BID

This method allows you the obtain a feed for a single beer for Untappd. By default it will return at max 25 records.

Parameters

  • BID (required) - The beer ID that you want to display checkins
  • access_token or client_id and client_secret (required) - Either pass the access_token for authorized calls OR the client_id and client_secret for unauthorized calls
  • min_id (int, optional) - The numeric ID of the most recent check-in. This provided to you in the next_query attribute.
  • max_id (int, optional) - The checkin ID that you want the results to start with
  • limit (int, optional) - The number of results to return, maximum of 50, default fault is 25
"checkins":{
	"count":25,
	"items":[
	{
	   "checkin_id":10608945,
	   "created_at":"Sun, 29 Jul 2012 22:19:16 +0000",
	   "checkin_comment":"",
	   "rating_score":3,
	   "user":{
	      "uid":1,
	      "user_name":"gregavola",
	      "first_name":"Greg",
	      "last_name":"Avola",
	      "location":"New York, NY",
	      "url":"http:\/\/gregavola.me",
	      "bio":"Co-Founder and CTO of Untappd, Web Developer, Beer Drinker, Community Guy",
	      "relationship":"self",
	      "user_avatar":"http:\/\/gravatar.com\/avatar\/0c6922e238dae5cccce96a32889fc911?size=100&d=https%3A%2F%2Funtappd.s3.amazonaws.com%2Fsite%2Fassets%2Fimages%2Fdefault_avatar.jpg",
	      "is_private":0,
	      "contact":{
	         "gowalla":"gregavola",
	         "foursquare":195741,
	         "facebook":18603076,
	         "twitter":"gregavola"
	      }
	   },
	   "beer":{
	      "bid":3916,
	      "beer_name":"Samuel Adams Summer Ale",
	      "beer_label":"https:\/\/untappd.s3.amazonaws.com\/site\/beer_logos\/beer-SamAdamsSummerAle.jpg",
	      "beer_style":"American Pale Wheat Ale",
	      "beer_abv":5.2,
	      "auth_rating":3,
	      "wish_list":false
	   },
	   "brewery":{
	      "brewery_id":157,
	      "brewery_name":"Boston Beer Company",
	      "brewery_label":"https:\/\/untappd.s3.amazonaws.com\/site\/brewery_logos\/brewery-SamuelAdams.jpg",
	      "country_name":"United States",
	      "contact":{
	         "twitter":"SamuelAdamsBeer",
	         "facebook":"http:\/\/www.facebook.com\/pages\/Samuel-Adams-for-the-love-of-beer\/117341921610",
	         "url":"http:\/\/www.samueladams.com"
	      },
	      "location":{
	         "brewery_city":"Boston",
	         "brewery_state":"MA",
	         "lat":42.3144,
	         "lng":-71.1034
	      }
	   },
	   "venue":{
	      "venue_id":1222,
	      "venue_name":"Untappd HQ - East",
	      "primary_category":"Residence",
	      "parent_category_id":"4e67e38e036454776db1fb3a",
	      "categories":{
	         "count":2,
	         "items":[
	            {
	               "category_name":"Tech Startup",
	               "category_id":"4bf58dd8d48988d125941735",
	               "is_primary":false
	            },
	            {
	               "category_name":"Home (private)",
	               "category_id":"4bf58dd8d48988d103941735",
	               "is_primary":true
	            }
	         ]
	      },
	      "location":{
	         "venue_address":"",
	         "venue_city":"",
	         "venue_state":"",
	         "lat":40.7559,
	         "lng":-73.9536
	      },
	      "contact":{
	         "twitter":"@untappd",
	         "venue_url":"http:\/\/untappd.com"
	      },
	      "foursquare":{
	         "foursquare_id":"4ccf5fec1ac7a1cd6a5c1392",
	         "foursquare_url":"http:\/\/4sq.com\/boEpZE"
	      },
	      "venue_icon":{
	         "sm":"https:\/\/foursquare.com\/img\/categories\/building\/home_64.png",
	         "md":"https:\/\/foursquare.com\/img\/categories\/building\/home_88.png",
	         "lg":"https:\/\/foursquare.com\/img\/categories\/building\/home_256.png"
	      }
	   },
	   "comments":{
	      "count":0,
	      "items":[

	      ]
	   },
	   "toasts":{
	      "count":1,
	      "auth_toast":false,
	      "items":[
	         {
	            "user":{
	               "uid":42235,
	               "user_name":"peterepp",
	               "first_name":"Peter",
	               "last_name":"Epp",
	               "user_avatar":"http:\/\/gravatar.com\/avatar\/470b0592970286c93a8b735598c71b87?size=100&d=https%3A%2F%2Funtappd.s3.amazonaws.com%2Fsite%2Fassets%2Fimages%2Fdefault_avatar.jpg",
	               "user_link":"http:\/\/untappd.com\/user\/peterepp",
	               "account_type":"user",
	               "brewery_details":[

	               ]
	            },
	            "like_id":"1225920",
	            "like_owner":false,
	            "created_at":"Sun, 29 Jul 2012 22:29:51 +0000"
	         }
	      ]
	   },
	   "media":{
	      "count":0,
	      "items":[

	      ]
	   },
	   "source":{
	      "app_name":"Untappd for Android - (V2)",
	      "app_website":"http:\/\/untpd.it\/androidapp"
	   }
	}, 
            ...
							

Brewery Feed

Authentication: Not required

HTTP Method: GET

/v4/brewery/checkins/BREWERY_ID

This method allows you the obtain a feed for a single brewery for Untappd. This includes only beer checkin-ins non private users by an authenticated user. By default it will return at max 25 records.

Parameters

  • BREWERY_ID (required) - The Brewery ID that you want to display checkins
  • access_token or client_id and client_secret (required) - Either pass the access_token for authorized calls OR the client_id and client_secret for unauthorized calls
  • min_id (int, optional) - The numeric ID of the most recent check-in. New results will only be shown if there are checkins before this ID
  • max_id (int, optional) - The checkin ID that you want the results to start with
  • limit (int, optional) - The number of results to return, max of 50, default is 25
"checkins":{
	"count":25,
	"items":[
	{
	   "checkin_id":10608945,
	   "created_at":"Sun, 29 Jul 2012 22:19:16 +0000",
	   "checkin_comment":"",
	   "rating_score":3,
	   "user":{
	      "uid":1,
	      "user_name":"gregavola",
	      "first_name":"Greg",
	      "last_name":"Avola",
	      "location":"New York, NY",
	      "url":"http:\/\/gregavola.me",
	      "bio":"Co-Founder and CTO of Untappd, Web Developer, Beer Drinker, Community Guy",
	      "relationship":"self",
	      "user_avatar":"http:\/\/gravatar.com\/avatar\/0c6922e238dae5cccce96a32889fc911?size=100&d=https%3A%2F%2Funtappd.s3.amazonaws.com%2Fsite%2Fassets%2Fimages%2Fdefault_avatar.jpg",
	      "is_private":0,
	      "contact":{
	         "gowalla":"gregavola",
	         "foursquare":195741,
	         "facebook":18603076,
	         "twitter":"gregavola"
	      }
	   },
	   "beer":{
	      "bid":3916,
	      "beer_name":"Samuel Adams Summer Ale",
	      "beer_label":"https:\/\/untappd.s3.amazonaws.com\/site\/beer_logos\/beer-SamAdamsSummerAle.jpg",
	      "beer_style":"American Pale Wheat Ale",
	      "beer_abv":5.2,
	      "auth_rating":3,
	      "wish_list":false
	   },
	   "brewery":{
	      "brewery_id":157,
	      "brewery_name":"Boston Beer Company",
	      "brewery_label":"https:\/\/untappd.s3.amazonaws.com\/site\/brewery_logos\/brewery-SamuelAdams.jpg",
	      "country_name":"United States",
	      "contact":{
	         "twitter":"SamuelAdamsBeer",
	         "facebook":"http:\/\/www.facebook.com\/pages\/Samuel-Adams-for-the-love-of-beer\/117341921610",
	         "url":"http:\/\/www.samueladams.com"
	      },
	      "location":{
	         "brewery_city":"Boston",
	         "brewery_state":"MA",
	         "lat":42.3144,
	         "lng":-71.1034
	      }
	   },
	   "venue":{
	      "venue_id":1222,
	      "venue_name":"Untappd HQ - East",
	      "primary_category":"Residence",
	      "parent_category_id":"4e67e38e036454776db1fb3a",
	      "categories":{
	         "count":2,
	         "items":[
	            {
	               "category_name":"Tech Startup",
	               "category_id":"4bf58dd8d48988d125941735",
	               "is_primary":false
	            },
	            {
	               "category_name":"Home (private)",
	               "category_id":"4bf58dd8d48988d103941735",
	               "is_primary":true
	            }
	         ]
	      },
	      "location":{
	         "venue_address":"",
	         "venue_city":"",
	         "venue_state":"",
	         "lat":40.7559,
	         "lng":-73.9536
	      },
	      "contact":{
	         "twitter":"@untappd",
	         "venue_url":"http:\/\/untappd.com"
	      },
	      "foursquare":{
	         "foursquare_id":"4ccf5fec1ac7a1cd6a5c1392",
	         "foursquare_url":"http:\/\/4sq.com\/boEpZE"
	      },
	      "venue_icon":{
	         "sm":"https:\/\/foursquare.com\/img\/categories\/building\/home_64.png",
	         "md":"https:\/\/foursquare.com\/img\/categories\/building\/home_88.png",
	         "lg":"https:\/\/foursquare.com\/img\/categories\/building\/home_256.png"
	      }
	   },
	   "comments":{
	      "count":0,
	      "items":[

	      ]
	   },
	   "toasts":{
	      "count":1,
	      "auth_toast":false,
	      "items":[
	         {
	            "user":{
	               "uid":42235,
	               "user_name":"peterepp",
	               "first_name":"Peter",
	               "last_name":"Epp",
	               "user_avatar":"http:\/\/gravatar.com\/avatar\/470b0592970286c93a8b735598c71b87?size=100&d=https%3A%2F%2Funtappd.s3.amazonaws.com%2Fsite%2Fassets%2Fimages%2Fdefault_avatar.jpg",
	               "user_link":"http:\/\/untappd.com\/user\/peterepp",
	               "account_type":"user",
	               "brewery_details":[

	               ]
	            },
	            "like_id":"1225920",
	            "like_owner":false,
	            "created_at":"Sun, 29 Jul 2012 22:29:51 +0000"
	         }
	      ]
	   },
	   "media":{
	      "count":0,
	      "items":[

	      ]
	   },
	   "source":{
	      "app_name":"Untappd for Android - (V2)",
	      "app_website":"http:\/\/untpd.it\/androidapp"
	   }
	}, 
            ...
							

Venue Feed

Authentication: Not required

HTTP Method: GET

/v4/venue/checkins/VENUE_ID

This method allows you the obtain a feed for a single venue for Untappd. By default it will return at max 25 records.

Parameters

  • VENUE_ID (required) - The Brewery ID that you want to display checkins
  • access_token or client_id and client_secret (required) - Either pass the access_token for authorized calls OR the client_id and client_secret for unauthorized calls
  • min_id (int, optional) - The numeric ID of the most recent check-in. New results will only be shown if there are checkins before this ID
  • max_Id (int, optional) - The checkin ID that you want the results to start with
  • limit (int, optional) - The number of results to return, max of 50, default is 25
"checkins":{
	"count":25,
	"items":[
	{
	   "checkin_id":10608945,
	   "created_at":"Sun, 29 Jul 2012 22:19:16 +0000",
	   "checkin_comment":"",
	   "rating_score":3,
	   "user":{
	      "uid":1,
	      "user_name":"gregavola",
	      "first_name":"Greg",
	      "last_name":"Avola",
	      "location":"New York, NY",
	      "url":"http:\/\/gregavola.me",
	      "bio":"Co-Founder and CTO of Untappd, Web Developer, Beer Drinker, Community Guy",
	      "relationship":"self",
	      "user_avatar":"http:\/\/gravatar.com\/avatar\/0c6922e238dae5cccce96a32889fc911?size=100&d=https%3A%2F%2Funtappd.s3.amazonaws.com%2Fsite%2Fassets%2Fimages%2Fdefault_avatar.jpg",
	      "is_private":0,
	      "contact":{
	         "gowalla":"gregavola",
	         "foursquare":195741,
	         "facebook":18603076,
	         "twitter":"gregavola"
	      }
	   },
	   "beer":{
	      "bid":3916,
	      "beer_name":"Samuel Adams Summer Ale",
	      "beer_label":"https:\/\/untappd.s3.amazonaws.com\/site\/beer_logos\/beer-SamAdamsSummerAle.jpg",
	      "beer_style":"American Pale Wheat Ale",
	      "beer_abv":5.2,
	      "auth_rating":3,
	      "wish_list":false
	   },
	   "brewery":{
	      "brewery_id":157,
	      "brewery_name":"Boston Beer Company",
	      "brewery_label":"https:\/\/untappd.s3.amazonaws.com\/site\/brewery_logos\/brewery-SamuelAdams.jpg",
	      "country_name":"United States",
	      "contact":{
	         "twitter":"SamuelAdamsBeer",
	         "facebook":"http:\/\/www.facebook.com\/pages\/Samuel-Adams-for-the-love-of-beer\/117341921610",
	         "url":"http:\/\/www.samueladams.com"
	      },
	      "location":{
	         "brewery_city":"Boston",
	         "brewery_state":"MA",
	         "lat":42.3144,
	         "lng":-71.1034
	      }
	   },
	   "venue":{
	      "venue_id":1222,
	      "venue_name":"Untappd HQ - East",
	      "primary_category":"Residence",
	      "parent_category_id":"4e67e38e036454776db1fb3a",
	      "categories":{
	         "count":2,
	         "items":[
	            {
	               "category_name":"Tech Startup",
	               "category_id":"4bf58dd8d48988d125941735",
	               "is_primary":false
	            },
	            {
	               "category_name":"Home (private)",
	               "category_id":"4bf58dd8d48988d103941735",
	               "is_primary":true
	            }
	         ]
	      },
	      "location":{
	         "venue_address":"",
	         "venue_city":"",
	         "venue_state":"",
	         "lat":40.7559,
	         "lng":-73.9536
	      },
	      "contact":{
	         "twitter":"@untappd",
	         "venue_url":"http:\/\/untappd.com"
	      },
	      "foursquare":{
	         "foursquare_id":"4ccf5fec1ac7a1cd6a5c1392",
	         "foursquare_url":"http:\/\/4sq.com\/boEpZE"
	      },
	      "venue_icon":{
	         "sm":"https:\/\/foursquare.com\/img\/categories\/building\/home_64.png",
	         "md":"https:\/\/foursquare.com\/img\/categories\/building\/home_88.png",
	         "lg":"https:\/\/foursquare.com\/img\/categories\/building\/home_256.png"
	      }
	   },
	   "comments":{
	      "count":0,
	      "items":[

	      ]
	   },
	   "toasts":{
	      "count":1,
	      "auth_toast":false,
	      "items":[
	         {
	            "user":{
	               "uid":42235,
	               "user_name":"peterepp",
	               "first_name":"Peter",
	               "last_name":"Epp",
	               "user_avatar":"http:\/\/gravatar.com\/avatar\/470b0592970286c93a8b735598c71b87?size=100&d=https%3A%2F%2Funtappd.s3.amazonaws.com%2Fsite%2Fassets%2Fimages%2Fdefault_avatar.jpg",
	               "user_link":"http:\/\/untappd.com\/user\/peterepp",
	               "account_type":"user",
	               "brewery_details":[

	               ]
	            },
	            "like_id":"1225920",
	            "like_owner":false,
	            "created_at":"Sun, 29 Jul 2012 22:29:51 +0000"
	         }
	      ]
	   },
	   "media":{
	      "count":0,
	      "items":[

	      ]
	   },
	   "source":{
	      "app_name":"Untappd for Android - (V2)",
	      "app_website":"http:\/\/untpd.it\/androidapp"
	   }
	}, 
            ...
							

Beer Info

Authentication: Not required

HTTP Method: GET

/v4/beer/info/BID

This method will allow you to see extended information about a beer.

Parameters

  • BID (required) - The Beer ID that you want to display information
  • access_token or client_id and client_secret (required) - Either pass the access_token for authorized calls OR the client_id and client_secret for unauthorized calls
  • compact (optional, string) - Pass 'true' for a compact listing of the beer object that doesn't include checkins, similar or media
							 "response":{
      "beer":{
         "bid":3558,
         "beer_name":"Brooklyn Lager",
         "beer_label":"https://untappd.s3.amazonaws.com/site/beer_logos/beer-BrooklynLager_3558.jpeg",
         "beer_abv":5.2,
         "beer_description":"Brooklyn Lager is a wonderfully flavorful beer, smooth, refreshing and very versatile with food. It is amber-gold in color and displays a firm malt center supported by a refreshing bitterness and floral hop aroma. Caramel malts show in the finish. The aromatic qualities of the beer are enhanced by “dry-hopping”, the centuries-old practice of steeping the beer with fresh hops as it undergoes a long, cold maturation.",
         "beer_style":"Vienna Lager",
         "is_in_production":1,
         "beer_slug":"brooklyn-brewery-brooklyn-lager",
         "is_homebrew":0,
         "created_at":"Sat, 21 Aug 2010 07:26:35 +0000",
         "rating_count":4757,
         "rating_score":3.42,
         "stats":{
            "total_count":12682,
            "monthly_count":1333,
            "user_count":24,
            "total_user_count":7332
         },
         "brewery":{
            "brewery_id":259,
            "brewery_name":"Brooklyn Brewery",
            "brewery_label":"https://untappd.s3.amazonaws.com/site/brewery_logos/brewery-BrooklynBrewery_259.jpeg",
            "country_name":"United States",
            "contact":{
               "twitter":"brooklynbrewery",
               "facebook":"https://www.facebook.com/thebrooklynbrewery",
               "url":"http://brooklynbrewery.com"
            },
            "location":{
               "brewery_city":"Brooklyn",
               "brewery_state":"NY",
               "lat":40.7215,
               "lng":-73.9575
            }
         },
         "auth_rating":3,
         "wish_list":false,
         "media":{
            "count":10,
            "items":[
               {
                  "photo_id":738199,
                  "photo":{
                     "photo_img_sm":"https://untappd.s3.amazonaws.com/photo/2012_07_29/6520952d6e365dd8d32dda3151a38466_100x100.jpg",
                     "photo_img_md":"https://untappd.s3.amazonaws.com/photo/2012_07_29/6520952d6e365dd8d32dda3151a38466_320x320.jpg",
                     "photo_img_lg":"https://untappd.s3.amazonaws.com/photo/2012_07_29/6520952d6e365dd8d32dda3151a38466_640x640.jpg",
                     "photo_img_og":"https://untappd.s3.amazonaws.com/photo/2012_07_29/6520952d6e365dd8d32dda3151a38466_raw.jpg"
                  },
                  ...
          },
          "checkins": { ... }
         }

							

Brewery Info

Authentication: Not required

HTTP Method: GET

/v4/brewery/info/BREWERY_ID

This method will allow you to see extended information about a brewery.

Parameters

  • BREWERY_ID (required) - The Brewery ID that you want to display information
  • access_token or client_id and client_secret (required) - Either pass the access_token for authorized calls OR the client_id and client_secret for unauthorized calls
  • compact (optional, string) - Pass 'true' for a compact listing of the brewery object that doesn't include checkins, beer_list or media
								"brewery":{
         "brewery_id":1009,
         "brewery_name":"Port Brewing Company",
         "brewery_label":"https://untappd.s3.amazonaws.com/site/brewery_logos/brewery-PortBrewingCompany_1009.jpeg",
         "country_name":"United States",
         "brewery_in_production":0,
         "claimed_status":{
            "is_claimed":false,
            "claimed_slug":"",
            "follow_status":false,
            "follower_count":0,
            "uid":0
         },
         "beer_count":114,
         "contact":{
            "twitter":"lostabbey",
            "facebook":"http://www.facebook.com/pages/Port-Brewing-The-Lost-abbey/75438839471?ref=nf",
            "url":"http://www.portbrewing.com/"
         },
         "brewery_type":"Micro Brewery",
         "location":{
            "brewery_address":"155 Mata Way, Suite 104",
            "brewery_city":"San Marcos",
            "brewery_state":"CA",
            "brewery_lat":33.1413,
            "brewery_lng":-117.15
         },
         "rating":{
            "count":16828,
            "rating_score":3.715
         },
         "owners": {
         	"count": 1,
         	"items": [
         	{
         		"brewery_id": 157,
         		"brewery_name": Brewery name
         	}]	
     	},
         "brewery_description":"",
         "stats":{
            "total_count":33062,
            "unique_count":10170,
            "monthly_count":41442,
            "weekly_count":12358,
            "user_count":17
         },
         "media":{
            …
         },
         "checkins":{
            …
         },
         "beer_list":{
            "count":15,
            "items":[
               {
                  "has_had":false,
                  "total_count":4176,
                  "beer":{
                     "bid":5809,
                     "beer_name":"Mongo Double IPA",
                     "beer_label":"https://untappd.s3.amazonaws.com/site/beer_logos/beer-portMongo.jpg",
                     "beer_style":"Imperial / Double IPA",
                     "beer_abv":8.5,
                     "auth_rating":0,
                     "wish_list":false,
                     "beer_description":"A Double IPA brewed in memory of the brew cat. In honor of Mongo, Mike Rodriguez made his first Double IPA, as he loved the cat and wanted to honor him with this beer. This 8.5% abv beer was made with Columbus hops (Mongo’s Birthname), Cascade for the Mama cat, and Simocoe because that is Mike’s favorite hop.",
                     "rating_score":3.98
                  },
                  "brewery":{
                     "brewery_id":1009,
                     "brewery_name":"Port Brewing Company",
                     "brewery_label":"https://untappd.s3.amazonaws.com/site/brewery_logos/brewery-PortBrewingCompany_1009.jpeg",
                     "country_name":"United States",
                     "contact":{
                        "twitter":"lostabbey",
                        "facebook":"http://www.facebook.com/pages/Port-Brewing-The-Lost-abbey/75438839471?ref=nf",
                        "url":"http://www.portbrewing.com/"
                     },
                     "location":{
                        "brewery_city":"San Marcos",
                        "brewery_state":"CA",
                        "lat":33.1413,
                        "lng":-117.15
                     }
                  },
                  "friends":{
                     "count":0,
                     "items":[

                     ]
                  }
               },
               ...
            ]
         }
      }
							

Venue Info

Authentication: Not required

HTTP Method: GET

/v4/venue/info/VENUE_ID

This method will allow you to see extended information about a venue.

Parameters

  • VENUE_ID (required) - The Venue ID that you want to display information
  • access_token or client_id and client_secret (required) - Either pass the access_token for authorized calls OR the client_id and client_secret for unauthorized calls
  • compact (optional, string) - Pass 'true' for a compact listing of the beer object that doesn't include checkins, top_beers or media
								"response":{
								      "venue":{
								         "venue_id":1222,
								         "venue_name":"Untappd HQ - East",
								         "last_updated":"Fri, 03 Aug 2012 14:12:55 +0000",
								         "primary_category":"Residence",
								         "categories":{
								            "count":2,
								            "items":[
								               {
								                  "category_name":"Tech Startup",
								                  "category_id":"4bf58dd8d48988d125941735",
								                  "is_primary":false
								               },
								               {
								                  "category_name":"Home (private)",
								                  "category_id":"4bf58dd8d48988d103941735",
								                  "is_primary":true
								               }
								            ]
								         },
								         "stats":{
								            "total_count":266,
								            "user_count":0,
								            "total_user_count":12
								         },
								         "venue_icon":{
								            "sm":"https://foursquare.com/img/categories/building/home_64.png",
								            "md":"https://foursquare.com/img/categories/building/home_88.png",
								            "lg":"https://foursquare.com/img/categories/building/home_256.png"
								         },
								         "location":{
								            "venue_address":"",
								            "venue_city":"",
								            "venue_state":"",
								            "lat":40.7559,
								            "lng":-73.9536
								         },
								         "contact":{
								            "twitter":"@untappd",
								            "venue_url":"http://untappd.com"
								         },
								         "foursquare":{
								            "foursquare_id":"4ccf5fec1ac7a1cd6a5c1392",
								            "foursquare_url":"http://4sq.com/boEpZE"
								         },
								         "media":{
								            …
								         },
								         "checkins":{
								            …
								         },
								         "top_beers":{
								            "count":6,
								            "items":[
								               {
								                  "total_count":3,
								                  "your_count":0,
								                  "beer":{
								                     "bid":3916,
								                     "beer_name":"Samuel Adams Summer Ale",
								                     "beer_label":"https://untappd.s3.amazonaws.com/site/beer_logos/beer-SamAdamsSummerAle.jpg",
								                     "beer_style":"American Pale Wheat Ale",
								                     "beer_abv":5.2,
								                     "beer_description":"right and citrusy, brewed with mysterious grains of paradise.\nSamuel Adams® Summer Ale is an American wheat ale. This summer seasonal uses malted wheat as well as lemon zest and grains of paradise, a rare pepper from Africa first used as a brewing spice in the 13th Century to create a crisp and spicy flavor and body. The ale fermentation imparts a background tropical fruit note reminiscent of mangos and peaches. All of these come together to create a quenching, clean finishing beer perfect for those warm Summer days",
								                     "auth_rating":0,
								                     "wish_list":false
								                  },
								                  "brewery":{
								                     "brewery_id":157,
								                     "brewery_name":"Boston Beer Company",
								                     "brewery_label":"https://untappd.s3.amazonaws.com/site/brewery_logos/brewery-SamuelAdams.jpg",
								                     "country_name":"United States",
								                     "contact":{
								                        "twitter":"SamuelAdamsBeer",
								                        "facebook":"http://www.facebook.com/pages/Samuel-Adams-for-the-love-of-beer/117341921610",
								                        "url":"http://www.samueladams.com"
								                     },
								                     "location":{
								                        "brewery_city":"Boston",
								                        "brewery_state":"MA",
								                        "lat":42.3144,
								                        "lng":-71.1034
								                     }
								                  },
								                  "friends":{
								                     "count":0,
								                     "items":[

								                     ]
								                  }
								               },
								               ...
								            ]
								         }
								      }
								   }
							

Checkin Details

Authentication: Not required

HTTP Method: GET

/v4/checkin/view/CHECKIN_ID

This method will allow you to see extended details for a particular checkin, which includes location, comments and toasts.

Parameters

  • CHECKIN_ID (required) - The Checkin ID that you want to display information
  • access_token or client_id and client_secret (required) - Either pass the access_token for authorized calls OR the client_id and client_secret for unauthorized calls
								"response":{
      "checkin":{
         "checkin_id":10888893,
         "created_at":"Sun, 05 Aug 2012 00:48:33 +0000",
         "rating_score":4,
         "checkin_comment":"",
         "user":{
            "uid":1,
            "user_name":"gregavola",
            "first_name":"Greg",
            "last_name":"A.",
            "relationship":"none",
            "location":"New York, NY",
            "url":"http://gregavola.me",
            "bio":"Co-Founder and CTO of Untappd, Web Developer, Beer Drinker, Community Guy",
            "user_avatar":"http://gravatar.com/avatar/0c6922e238dae5cccce96a32889fc911?size=100&d=https%3A%2F%2Funtappd.s3.amazonaws.com%2Fsite%2Fassets%2Fimages%2Fdefault_avatar.jpg",
            "is_private":0,
            "contact":[
               {
                  "foursquare":195741,
                  "facebook":18603076,
                  "twitter":"gregavola"
               }
            ]
         },
         "beer":{
            "bid":3952,
            "beer_name":"60 Minute IPA",
            "beer_label":"https://untappd.s3.amazonaws.com/site/beer_logos/beer-dfh60MinIPA.jpg",
            "beer_style":"American IPA",
            "beer_abv":6,
            "auth_rating":0,
            "wish_list":false
         },
         "brewery":{
            "brewery_id":459,
            "brewery_name":"Dogfish Head Craft Brewery",
            "brewery_label":"https://untappd.s3.amazonaws.com/site/brewery_logos/brewery-DogfishHeadCraftBrewery_459.jpeg",
            "country_name":"United States",
            "contact":{
               "twitter":"dogfishbeer",
               "facebook":"http://www.facebook.com/dogfishheadbeer",
               "url":"http://www.dogfish.com/"
            },
            "location":{
               "brewery_city":"Milton",
               "brewery_state":"DE",
               "lat":38.7776,
               "lng":-75.3099
            }
         },
         "venue":{
            "venue_id":6820,
            "venue_name":"BlackbirdTavern",
            "primary_category":"Nightlife Spot",
            "parent_category_id":"4d4b7105d754a06376d81259",
            "categories":{
               "count":1,
               "items":[
                  {
                     "category_name":"Bar",
                     "category_id":"4bf58dd8d48988d116941735",
                     "is_primary":true
                  }
               ]
            },
            "location":{
               "venue_address":"6 Way Rd",
               "venue_city":"Middlefield",
               "venue_state":"CT",
               "lat":41.5127,
               "lng":-72.7243
            },
            "contact":{
               "twitter":"",
               "venue_url":""
            },
            "foursquare":{
               "foursquare_id":"4c2e93d13896e21e8094e290",
               "foursquare_url":"http://4sq.com/9NMvEo"
            },
            "venue_icon":{
               "sm":"https://foursquare.com/img/categories/nightlife/bar_64.png",
               "md":"https://foursquare.com/img/categories/nightlife/bar_88.png",
               "lg":"https://foursquare.com/img/categories/nightlife/bar_256.png"
            }
         },
         "comments":{
            "count":0,
            "items":[

            ]
         },
         "toasts":{
            "count":1,
            "auth_toast":false,
            "items":[
               {
                  "user":{
                     "uid":6637,
                     "user_name":"andrecharland",
                     "first_name":"Andre",
                     "last_name":"C.",
                     "user_avatar":"http://gravatar.com/avatar/46eb1cc687d40b1d33216f54da74a63f?size=100&d=https%3A%2F%2Funtappd.s3.amazonaws.com%2Fsite%2Fassets%2Fimages%2Fdefault_avatar.jpg",
                     "user_link":"http://untappd.com/user/andrecharland",
                     "account_type":"user",
                     "brewery_details":[

                     ]
                  },
                  "like_id":"1271596",
                  "like_owner":false,
                  "created_at":"Sun, 05 Aug 2012 03:41:14 +0000"
               }
            ]
         },
         "media":{
            "count":0,
            "items":[

            ]
         },
         "source":{
            "app_name":"Untappd for iPhone - (V2)",
            "app_website":"http://untpd.it/iphoneapp"
         }
      }
   }

							

User Info

Authentication: Not required

HTTP Method: GET

/v4/user/info/USERNAME

This method will return the user information for a selected user. If you want to obtain the authenticated user's information, you don't need to pass the "user" query string.

Please note: The settings attribute will only be visible if the user that you are making the call on is authenticated. Unauthenticated calls do not return this attribtue.

Parameters

  • USERNAME (required) - The Username that you want to display information
  • access_token or client_id and client_secret (required) - Either pass the access_token for authorized calls OR the client_id and client_secret for unauthorized calls
  • compact (optional, string) - Pass 'true' for a compact listing of the user object that doesn't include recent_brews, media or checkins.
							"response":{
      "user":{
         "id":1,
         "user_name":"gregavola",
         "first_name":"Greg",
         "last_name":"Avola",
         "user_avatar":"http://gravatar.com/avatar/0c6922e238dae5cccce96a32889fc911?size=100&d=https%3A%2F%2Funtappd.s3.amazonaws.com%2Fsite%2Fassets%2Fimages%2Fdefault_avatar.jpg",
         "is_private":0,
         "location":"New York, NY",
         "url":"http://gregavola.me",
         "bio":"Co-Founder and CTO of Untappd, Web Developer, Beer Drinker, Community Guy",
         "relationship":"self",
         "untappd_url":"http://untappd.com/user/gregavola",
         "account_type":"user",
         "stats":{
            "total_badges":121,
            "total_friends":1042,
            "total_checkins":1260,
            "total_beers":649,
            "total_created_beers":54
         },
         "recent_brews":{…},
         "checkins":{…},
         "media":{…},
         "contact":{
            "foursquare":195741,
            "facebook":18603076,
            "twitter":"gregavola"
         },
         "date_joined":"Wed, 07 Jul 2010 05:51:10 +0000",
         "settings":{
            "badge":{
               "badges_to_facebook":0,
               "badges_to_twitter":1
            },
            "checkin":{
               "checkin_to_facebook":0,
               "checkin_to_twitter":0,
               "checkin_to_foursquare":0
            },
            "navigation":{
               "default_to_checkin":0
            },
            "user_birthday":"",
            "email_address": "",
         }
      }
   }
							

User Friends

Authentication: Not required

HTTP Method: GET

/v4/user/friends/USERNAME

This method will return the last 25 friends for a selected. If you want to obtain the authenticated user's information, you don't need to pass the "USERNAME" parameter

Parameters

  • USERNAME (required) - The Username that you want to display information
  • access_token or client_id and client_secret (required) - Either pass the access_token for authorized calls OR the client_id and client_secret for unauthorized calls
  • offset (int, optional) - The numeric offset that you what results to start
  • limit (optional) - The number of records that you will return (max 25)

								"response":{
      "count":25,
      "items":[
         {
            "friendship_hash":"68a348378ccf02908bbf89bcf6c45d3d",
            "created_at":"Sat, 28 Jul 2012 10:41:07 +0000",
            "user":{
               "uid":104315,
               "user_name":"TommBauer",
               "location":"NJ",
               "bio":"Host of the upcoming reality show \"Brew York\". I freeze time and play make believe for a living and create human beings ",
               "first_name":"Tomm",
               "last_name":"Bauer",
               "relationship":"friends",
               "user_avatar":"https://untappd.s3.amazonaws.com/profile/7b553bcff487141b23f7923390704409_thumb.jpg"
            }
         },
         ....


							

User Badges

Authentication: Not required

HTTP Method: GET

/v4/user/badges/USERNAME

This method will return a list of the last 50 the user's earned badges. If you want to obtain the authenticated user's information, you don't need to pass the "USERNAME" parameter.

Parameters

  • USERNAME (required) - The Username that you want to display information
  • access_token or client_id and client_secret (required) - Either pass the access_token for authorized calls OR the client_id and client_secret for unauthorized calls
  • offset (int, optional) - The numeric offset that you what results to start
"response": {

    "type": "earned",
    "sort": "all",
    "count": 50,
    "items": [
        {
            "badge_id": 176,
            "user_badge_id": 1464621,
            "checkin_id": 10240366,
            "badge_name": "Summer Squeeze",
            "badge_description": "Summer Squeeze is a bright, crisp ale that keeps you refreshed all summer long. 10 lucky fans will win Summer Squeeze pint glasses from Bridgeport.",
            "badge_hint": "Check into a Summer Squeeze by Bridgeport from 6/1 to 7/21!",
            "badge_active_status": 1,
            "media": {
                "badge_image_sm": "https://untappd.s3.amazonaws.com/assets/badges/bdg_summerSqueeze_sm.png",
                "badge_image_md": "https://untappd.s3.amazonaws.com/assets/badges/bdg_summerSqueeze_md.png",
                "badge_image_lg": "https://untappd.s3.amazonaws.com/assets/badges/bdg_summerSqueeze_lg.png"
            },
            "created_at": "Sat, 21 Jul 2012 20:04:45 +0000",
            "is_level": false,
            "levels": [ ]
        },
        ...


							

User Wish List

Authentication: Not required

HTTP Method: GET

/v4/user/wishlist/USERNAME

This method will allow you to see all the user's wish listed beers.

Parameters

  • USERNAME (required) - The Username that you want to display information
  • access_token or client_id and client_secret (required) - Either pass the access_token for authorized calls OR the client_id and client_secret for unauthorized calls
  • sort (string, optional) - Your can sort the results using these values: date - sorts by date (default), checkin - sorted by highest checkin, highest_rated - sorts by global rating descending order, lowest_rated - sorts by global rating ascending order, highest_abv - highest ABV from the wishlist, lowest_abv - lowest ABV from the wishlist
  • offset (int, optional) - The numeric offset that you what results to start
							 "response":{
	  "sort": "",
      "beers":{
         "count":22,
         "items":[
            {
               "created_at":"Thu, 19 Jul 2012 17:58:31 +0000",
               "beer":{
                  "bid":164941,
                  "beer_name":"What Is Enlightenment?",
                  "beer_slug": "hill-farmstead-brewery-what-is-englightment",
                  "beer_label":"https://untappd.s3.amazonaws.com/site/assets/images/temp/badge-beer-default.png",
                  "beer_abv":"5.4",
                  "beer_description":"American Pale Ale brewed in honor of our Second Anniversary. Simcoe and Amarillo hops.",
                  "beer_style":"American Pale Ale",
                  "beer_rating":4.23,
                  "rating_count": 23452,
                  "created_at":"Fri, 27 Apr 2012 15:08:55 +0000",
                  "auth_rating":0,
                  "wish_list":true
               },
               "brewery":{
                  "brewery_id":2562,
                  "brewery_name":"Hill Farmstead Brewery",
                  "brewery_label":"https://untappd.s3.amazonaws.com/site/brewery_logos/brewery-HillFarmsteadBrewery_2562.jpeg",
                  "country_name":"United States",
                  "contact":{
                     "twitter":"HillFarmstead",
                     "facebook":"http://www.facebook.com/hillfarmstead",
                     "url":"http://www.hillfarmstead.com"
                  },
                  "location":{
                     "brewery_city":"Greensboro",
                     "brewery_state":"VT",
                     "lat":44.6072,
                     "lng":-72.2623
                  }
               },
               "friends":{
                  "count":10,
                  "items":[
                     {
                        "user":{
                           "uid":3325,
                           "user_name":"Clefoodandbrews",
                           "first_name":"Clefoodandbrews",
                           "last_name":"",
                           "user_link":"http://untappd.com/user/Clefoodandbrews",
                           "user_avatar":"https://untappd.s3.amazonaws.com/profile/025765a9b343adad2bf56d9803f6433f_thumb.jpg"
                        },
                        "created_at":"Sat, 28 Jul 2012 17:11:27 +0000"
                     },
                     ...
                }
                ...


							

User Distinct Beers

Authentication: Not required

HTTP Method: GET

/v4/user/beers/USERNAME

This method will allow you to see all the user's distinct beers.

Parameters

  • USERNAME (required) - The Username that you want to display information
  • access_token or client_id and client_secret (required) - Either pass the access_token for authorized calls OR the client_id and client_secret for unauthorized calls
  • sort (string, optional) - Your can sort the results using these values: date - sorts by date (default), checkin - sorted by highest checkin, highest_rated - sorts by global rating descending order, lowest_rated - sorts by global rating ascending order, highest_rated_you - the user's highest rated beer, lowest_rated_you - the user's lowest rated beer
  • offset (int, optional) - The numeric offset that you what results to start
								"response":{
      "beers":{
         "sort": "date",
         "count":25,
         "items":[
            {
               "recent_created_at":"Sat, 28 Jul 2012 01:30:25 +0000",
               "first_had":"Sat, 28 Jul 2012 01:30:25 +0000",
               "count":1,
               "beer":{
                  "bid":18693,
                  "beer_name":"Shipwrecked",
                  "beer_label":"https://untappd.s3.amazonaws.com/site/beer_logos/beer-Shipwrecked_18693.jpeg",
                  "beer_abv":9.25,
                  "beer_style":"Imperial / Double IPA",
                  "beer_description":"An amazingly balanced and hoppy beer, yet finishes as smooth as silk with no hint of high alcohol hotness usually associated with strong double IPA’s. Super citrus and grapefruit aromas and flavors from the generous use of Cascade, Magnum, Centennial and CTZ hops.",
                  "created_at":"Wed, 29 Dec 2010 11:50:22 +0000",
                  "auth_rating":3,
                  "wish_list":false,
                  "rating_score":3.778
               },
               "brewery":{
                  "brewery_id":2228,
                  "brewery_name":"Mission Brewery",
                  "brewery_label":"https://untappd.s3.amazonaws.com/site/brewery_logos/brewery-MissionBrewery_2228.jpeg",
                  "country_name":"United States",
                  "contact":{
                     "twitter":"missionbrewery",
                     "facebook":"http://www.facebook.com/MissionBrewery",
                     "url":"http://missionbrewery.com"
                  },
                  "location":{
                     "brewery_city":"San Diego",
                     "brewery_state":"CA",
                     "lat":32.7073,
                     "lng":-117.149
                  }
               }
            },
            ...
							

Checkin

Authentication: Required

HTTP Method: POST

/v4/checkin/add

This will allow you to perform a live checkin.

Parameters

  • access_token (required) - The access_token for authorized calls (Note: this must be called via a GET parameter - ?access_token=XXXXXX, everything else is a POST parameter)
  • gmt_offset (required) - The numeric value of hours the user is away from the GMT (Greenwich Mean Time)
  • timezone (required) - The timezone of the user, such as EST or PST.
  • bid (required) - The numeric Beer ID you want to check into.
  • foursquare_id (optional) - The MD5 hash ID of the Venue you want to attach the beer checkin. This HAS TO BE the MD5 non-numeric hash from the foursquare v2.
  • geolat (optional) - The numeric Latitude of the user. This is required if you add a location.
  • geolng (optional) - The numeric Longitude of the user. This is required if you add a location.
  • shout (optional) - The text you would like to include as a comment of the checkin. Max of 140 characters.
  • rating (optional) - The rating score you would like to add for the beer. This can only be 1 to 5 (half ratings are included). You can't rate a beer a 0.
  • facebook (optional) - Default = "off", Pass "on" to post to facebook
  • twitter (optional) - Default = "off", Pass "on" to post to twitter
  • foursquare (optional) - Default = "off", Pass "on" to checkin on foursquare

Please Note It's possible that you could pass through a foursquare venue ID, and not get back a "venue" object in the response. This can be due to many reasons, but mainly due to a Foursquare connectivity issue. Your app or service should never depending on a one-to-one match on the foursquare ID send, and a venue object returned as part of the response. Always do a "nulL" check to make sure that the object's attributes exists before digging deeper into it.

Example Response


								{
    ...
    "response": {
        "result": "success",
        "badge_valid": true,
        "checkin_id": 13076620,
        "checkin_comment": "Great beer!",
        "stats": {
            "beer": "1st",
            "beer_month": "1st"
        },
       "rating": {
		    "result": "success",
		    "rating_method": "insert",
		    "old_score": 0,
		    "new_score": 4
		},
        "user": {
            "uid": 54194,
            "user_name": "gregavola",
            "first_name": "Greg Avola",
            "last_name": "",
            "location": "",
            "url": "",
            "bio": "",
            "user_avatar": "http://gravatar.com/avatar/0d8e7b11de5f0f6bea658ed5bd67b253?size=100&d=https%3A%2F%2Funtappd.s3.amazonaws.com%2Fsite%2Fassets%2Fimages%2Fdefault_avatar.jpg",
            "account_type": "user",
            "contact": {
                "twitter": "gregavola",
                "foursquare": 5257472,
                "facebook": 100003555907560
            }
        },
        "beer": {
            "bid": 3558,
            "beer_name": "Brooklyn Lager",
            "beer_label": "https://untappd.s3.amazonaws.com/site/beer_logos/beer-BrooklynLager_3558.jpeg",
            "beer_abv": 5.2,
            "beer_ibu": 33,
            "beer_description": "Brooklyn Lager is a wonderfully flavorful beer, smooth, refreshing and very versatile with food. It is amber-gold in color and displays a firm malt center supported by a refreshing bitterness and floral hop aroma. Caramel malts show in the finish. The aromatic qualities of the beer are enhanced by “dry-hopping”, the centuries-old practice of steeping the beer with fresh hops as it undergoes a long, cold maturation.",
            "beer_style_id": 50,
            "beer_style": "Vienna Lager",
            "auth_rating": 0
        },
        "brewery": {
            "brewery_id": 259,
            "brewery_name": "Brooklyn Brewery",
            "brewery_label": "https://untappd.s3.amazonaws.com/site/brewery_logos/brewery-BrooklynBrewery_259.jpeg",
            "country_name": "United States"
        },
        "venue": [],
        "recommendations": [],
        "distance": 0,
        "media": {
            "is_photo": true,
            "photo_data": false,
            "photo_key": "4b5ebfb70806ab7608805c1c6aca7b47"
        },
        "media_allowed": true,
        "social_settings": {
            "facebook": "off",
            "twitter": "off",
            "foursquare": "off"
        },
        "source": {
            "app_name": "Untappd for iPhone - (V2)",
            "app_website": "http://untpd.it/iphoneapp"
        },
        "follow_status": {
            "is_follow": true,
            "status": false,
            "hash": "d221db443564f9054700b47f70b5fdff",
            "uid": 109298
        },
        "promotions": {
            "count": 0,
            "items": []
        },
        "badges": {
            "count": 0,
            "items": []
        },
        "social": []
    }
}
							

Add Comment

Authentication: Required

HTTP Method: POST

/v4/checkin/addcomment/CHECKIN_ID

This method will allow you comment on a checkin.

Parameters

  • access_token (required) - The access_token for authorized calls
  • CHECKIN_ID (required) - The numeric check-in ID that you wish to add a comment.
  • comment (required) - The comment text that you would like to add. It must be less than 140 characters.

Example Response

{ ... "response": { "result": "success", "comments": { "count": 1, "items": [ { "user": { "uid": 1, "user_name": "gregavola", "first_name": "Greg", "last_name": "Avola", "user_avatar": "http://gravatar.com/avatar/0c6922e238dae5cccce96a32889fc911?size=100&d=https%3A%2F%2Funtappd.s3.amazonaws.com%2Fsite%2Fassets%2Fimages%2Fdefault_avatar.jpg", "user_link": "http://untappd.com/user/gregavola", "account_type": "user", }, "comment_id": "916093", "comment_owner": true, "comment": "Nice shot!", "created_at": "Wed, 19 Sep 2012 11:43:08 +0000", "comment_source": "mobile" } ] } } }

Remove Comment

Authentication: Required

HTTP Method: POST

/v4/checkin/deletecomment/COMMENT_ID

This method will allow you to delete your comment on a checkin.

Parameters

  • access_token (required) - The access_token for authorized calls
  • COMMENT_ID (required) - The comment ID you wish to delete.

Example Response

							

{ ... "response": { "result": "success", } }

Toast

Authentication: Required

HTTP Method: GET

/v4/checkin/toast/CHECKIN_ID

This method will allow you to toast a checkin. Please note, if the user has already toasted this check-in, it will delete the toast.

Parameters

  • access_token (required) - The access_token for authorized calls
  • CHECKIN_ID (required) - The checkin ID you wish you toast.

Like Owner is the owner of the the toast.

Example Response

{
    "response": {
        "result": "success",
        "like_type": "toast",
        "toasts": {
            "count": 1,
            "auth_toast": true,
            "items": [
                {
                    "user": {
                        "uid": 1,
                        "user_name": "gregavola",
                        "first_name": "Greg",
                        "last_name": "Avola",
                        "user_avatar": "http://gravatar.com/avatar/0c6922e238dae5cccce96a32889fc911?size=100&d=https%3A%2F%2Funtappd.s3.amazonaws.com%2Fsite%2Fassets%2Fimages%2Fdefault_avatar.jpg",
                        "user_link": "http://untappd.com/user/gregavola",
                        "account_type": "user",
                        "brewery_details": [ ]
                    },
                    "like_id": 1610306,
                    "like_owner": true,
                    "created_at": "Wed, 19 Sep 2012 03:08:46 +0000"
                }
            ]
        }
    }

}
							

Pending Friends

Authentication: Required

HTTP Method: GET

/v4/user/pending

This will allow you to return your pending friends requests

Parameters

  • access_token (required) - The access_token for authorized calls

Example Response

							{
    "response": {
        "count": 5,
        "items": [
            {
                "friendship_hash": "5f1f12cfb504d92718bdb38df062ebc2",
                "created_at": "Tue, 18 Sep 2012 19:19:49 +0000",
                "user": {
                    "uid": 273954,
                    "user_name": "AlewifeNYC",
                    "location": "",
                    "bio": "Kick ass Beer Hall located in Long Island City - good beer - good food - good times",
                    "first_name": "Alewife",
                    "last_name": "NYC",
                    "user_avatar": "http://gravatar.com/avatar/41dc5138a76bc55d270390c14dca685c?size=100&d=https%3A%2F%2Funtappd.s3.amazonaws.com%2Fsite%2Fassets%2Fimages%2Fdefault_avatar.jpg"
                }
            },
            ...
        ]
    }

}
							

Accept Friends

Authentication: Required

HTTP Method: POST

/v4/friend/accept/TARGET_ID

This will allow you to accept a pending friend request

Parameters

  • access_token (required) - The access_token for authorized calls
  • target_id (required) - The target user id that you wish to accept.

Example Response

{
    "response": {
        "result": "success",
        "request_type": "accept",
        "friendship_type": "friend",
        "target_user": {
            "uid": 273954,
            "user_name": "AlewifeNYC",
            "first_name": "Alewife",
            "last_name": "NYC",
            "location": "",
            "url": "",
            "bio": "Kick ass Beer Hall located in Long Island City - good beer - good food - good times",
            "user_avatar": "http://gravatar.com/avatar/41dc5138a76bc55d270390c14dca685c?size=100&d=https%3A%2F%2Funtappd.s3.amazonaws.com%2Fsite%2Fassets%2Fimages%2Fdefault_avatar.jpg",
            "account_type": "user",
            "contact": {
                "twitter": "AlewifeNYC"
            }
        }
    }

}
							

Reject Friends

Authentication: Required

HTTP Method: POST

/v4/friend/reject/TARGET_ID

This will allow you to return you to ignore a pending friend request

Parameters

  • access_token (required) - The access_token for authorized calls
  • target_id (required) - The target user id that you wish to reject/ignore.

Example Response

{
    "response": {
        "result": "success",
        "request_type": "reject",
        "friendship_type": "friend",
        "target_user": {
            "uid": 273954,
            "user_name": "AlewifeNYC",
            "first_name": "Alewife",
            "last_name": "NYC",
            "location": "",
            "url": "",
            "bio": "Kick ass Beer Hall located in Long Island City - good beer - good food - good times",
            "user_avatar": "http://gravatar.com/avatar/41dc5138a76bc55d270390c14dca685c?size=100&d=https%3A%2F%2Funtappd.s3.amazonaws.com%2Fsite%2Fassets%2Fimages%2Fdefault_avatar.jpg",
            "account_type": "user",
            "contact": {
                "twitter": "AlewifeNYC"
            }
        }
    }

}
							

Remove Friends

Authentication: Required

HTTP Method: GET

/v3/friend/remove/TARGET_ID

This will allow you to return you to revoke a current friendship

Parameters

  • access_token (required) - The access_token for authorized calls
  • target_id (required) - The target user id that you wish to remove/revoke.

Example Response

"response": {

    "result": "success"

}

Friend Request

Authentication: Required

HTTP Method: GET

/v4/friend/request/TARGET_ID

This will allow you to request to be someone's friend on Untappd

Parameters

  • access_token (required) - The access_token for authorized calls
  • target_id (required) - The target user id that you wish to request to be their friend.

Example Response

{
	....
    "response": {
        "result": "success",
        "request_type": "request",
        "friendship_type": "friend",
        "target_user": {
            "uid": 2,
            "user_name": "timm3h",
            "first_name": "Tim",
            "last_name": "Mather",
            "location": "Los Angeles, CA",
            "url": "http://itst.im",
            "bio": "Untappd co-founder, designer, web tech nerd, music lover, beer drinker.",
            "user_avatar": "https://untappd.s3.amazonaws.com/profile/3d90e6e1b648b0c47bc179ac930122d1_thumb.jpg",
            "account_type": "user",
            "contact": {
                "facebook": 138700053,
                "foursquare": 13034,
                "twitter": "timm3h"
            },
        }
    }

}
							

Add To Wish List

Authentication: Required

HTTP Method: GET

/v4/user/wishlist/add

This method will allow you to add a beer to your wish list

Parameters

  • access_token (required) - The access_token for authorized calls
  • bid (required) - The numeric beer ID that you wish to add to your wishlist.

Example Response

{
	...
    "response": {
        "result": "success",
        "action": "add",
        "beer": {
            "beer": {
                "bid": 3839,
                "beer_name": "Blue Moon Belgian White",
                "beer_label": "https://untappd.s3.amazonaws.com/site/beer_logos/beer-blueMoon.jpg",
                "beer_abv": 5.4,
                "beer_ibu": 0,
                "beer_description": "Blue Moon Belgian White, Belgian-style wheat ale, is a refreshing, medium-bodied, unfiltered Belgian-style wheat ale spiced with fresh coriander and orange peel for a uniquely complex taste and an uncommonly smooth finish.",
                "beer_style_id": 83,
                "beer_style": "Witbier",
                "auth_rating": 3
            },
            "brewery": {
                "brewery_id": 399,
                "brewery_name": "Coors Brewing Company",
                "brewery_label": "https://untappd.s3.amazonaws.com/site/brewery_logos/brewery-coors.jpg",
                "country_name": "United States"
            }
        }
    }
}
							

Remove From Wish List

Authentication: Required

HTTP Method: GET

/v4/user/wishlist/delete

This method will allow you to remove a beer from your wish list

Parameters

  • access_token (required) - The access_token for authorized calls
  • bid (required) - The numeric beer ID that you wish to remove from your wishlist.

Example Response

{
	...
    "response": {
        "result": "success",
        "action": "remove",
        "beer": {
            "beer": {
                "bid": 3839,
                "beer_name": "Blue Moon Belgian White",
                "beer_label": "https://untappd.s3.amazonaws.com/site/beer_logos/beer-blueMoon.jpg",
                "beer_abv": 5.4,
                "beer_ibu": 0,
                "beer_description": "Blue Moon Belgian White, Belgian-style wheat ale, is a refreshing, medium-bodied, unfiltered Belgian-style wheat ale spiced with fresh coriander and orange peel for a uniquely complex taste and an uncommonly smooth finish.",
                "beer_style_id": 83,
                "beer_style": "Witbier",
                "auth_rating": 3
            },
            "brewery": {
                "brewery_id": 399,
                "brewery_name": "Coors Brewing Company",
                "brewery_label": "https://untappd.s3.amazonaws.com/site/brewery_logos/brewery-coors.jpg",
                "country_name": "United States"
            }
        }
    }
}
							

Notifications

Authentication: Required

HTTP Method: GET

/v4/notifications

This method will allow you pull in a feed of notifications (toasts and comments) on the authenticated user. It will return the 25 items by default and pagination is not supported. It will also show the last 25 news items in the order of created date.

Parameters

  • access_token (required) - The access_token for authorized calls

Example Response

								{
	...							
    "response": {
        "notifications": {
            "count": 25,
            "items": [
                {
                    "notification_type": "toast",
                    "message": null,
                    "created_at": "Wed, 19 Sep 2012 02:10:14 +0000",
                    "checkin_id": 13025487,
                    "checkin_comment": "Sweet and dry",
                    "rating_score": 3,
                    "checkin_owner": true,
                    "actor": {
                        "uid": 97323,
                        "user_name": "aslezak",
                        "first_name": "Andy",
                        "last_name": "Slezak",
                        "location": "Hoboken, NJ",
                        "url": "http://aslezak.com",
                        "bio": "loves beer, wine, coffee, virtualization, google reader, posterous, and a good shave...",
                        "user_avatar": "https://untappd.s3.amazonaws.com/profile/173ed65920d9ce32c9780b453848b34a_thumb.jpg",
                        "contact": {
                            "twitter": "aslezak",
                            "foursquare": 1398377,
                            "facebook": 1159093832
                        }
                    },
                    "user": {
                        "uid": 1,
                        "user_name": "gregavola",
                        "first_name": "Greg",
                        "last_name": "Avola",
                        "location": "New York, NY",
                        "url": "http://gregavola.me",
                        "bio": "Co-Founder and CTO of Untappd, Web Developer, Beer Drinker, Community Guy",
                        "user_avatar": "http://gravatar.com/avatar/0c6922e238dae5cccce96a32889fc911?size=100&d=https%3A%2F%2Funtappd.s3.amazonaws.com%2Fsite%2Fassets%2Fimages%2Fdefault_avatar.jpg",
                        "account_type": "user",
                        "contact": {
                            "foursquare": 195741,
                            "facebook": 18603076,
                            "twitter": "gregavola"
                        },
                        "email_prefs": {
                            "is_friend_request": 1,
                            "is_toast": 1,
                            "is_comment": 1
                        },
                        "relationship": "self"
                    },
                    "beer": {
                        "bid": 7156,
                        "beer_name": "Carolina India Pale Ale (IPA)",
                        "beer_label": "https://untappd.s3.amazonaws.com/site/beer_logos/beer-CarolinaIndiaPaleAleIPA_7156.jpeg",
                        "beer_style": "American IPA",
                        "auth_rating": 3,
                        "wish_list": false
                    },
                    "brewery": {
                        "brewery_id": 1826,
                        "brewery_name": "Carolina Brewing Company",
                        "brewery_label": "https://untappd.s3.amazonaws.com/site/brewery_logos/brewery-CarolinaBrewingCompany_1826.jpeg",
                        "country_name": "United States",
                        "contact": {
                            "twitter": "CarolinaBrewing",
                            "facebook": "http://www.facebook.com/pages/Carolina-Brewing-Company/106393626067978",
                            "url": "http://www.carolinabrew.com/"
                        },
                        "location": {
                            "brewery_city": "Holly Springs",
                            "brewery_state": "NC",
                            "lat": 35.6557,
                            "lng": -78.8539
                        }
                    },
                    "venue": {
                        "venue_id": 1222,
                        "venue_name": "Untappd HQ - East",
                        "primary_category": "Residence",
                        "parent_category_id": "4e67e38e036454776db1fb3a",
                        "categories": {
                            "count": 2,
                            "items": [
                                {
                                    "category_name": "Tech Startup",
                                    "category_id": "4bf58dd8d48988d125941735",
                                    "is_primary": false
                                },
                                {
                                    "category_name": "Home (private)",
                                    "category_id": "4bf58dd8d48988d103941735",
                                    "is_primary": true
                                }
                            ]
                        },
                        "location": {
                            "venue_address": "",
                            "venue_city": "",
                            "venue_state": "",
                            "lat": 40.7559,
                            "lng": -73.9536
                        },
                        "contact": {
                            "twitter": "@untappd",
                            "venue_url": "http://untappd.com"
                        },
                        "foursquare": {
                            "foursquare_id": "4ccf5fec1ac7a1cd6a5c1392",
                            "foursquare_url": "http://4sq.com/boEpZE"
                        },
                        "venue_icon": {
                            "sm": "https://foursquare.com/img/categories/building/home_64.png",
                            "md": "https://foursquare.com/img/categories/building/home_88.png",
                            "lg": "https://foursquare.com/img/categories/building/home_256.png"
                        }
                    },
                    "comments": {
                        "count": 0,
                        "items": [ ]
                    },
                    "toasts": {
                        "count": 7,
                        "auth_toast": false,
                        "items": [
                            {
                                "user": {
                                    "uid": 77374,
                                    "user_name": "beerandracing",
                                    "first_name": "beer",
                                    "last_name": "and racing (Jon)",
                                    "user_avatar": "https://untappd.s3.amazonaws.com/profile/91387fd0f42f3ea74dee66108218454a_thumb.jpg",
                                    "user_link": "http://untappd.com/user/beerandracing",
                                    "account_type": "user",
                                    "brewery_details": [ ]
                                },
                                "like_id": 1602654,
                                "like_owner": false,
                                "created_at": "Mon, 17 Sep 2012 23:24:51 +0000"
                            },
                            {
                                "user": {
                                    "uid": 90421,
                                    "user_name": "mjongbloets",
                                    "first_name": "Maarten",
                                    "last_name": "Jongbloets",
                                    "user_avatar": "https://untappd.s3.amazonaws.com/profile/4fbacf1f2cdc75a1f9cfd16a87f5415e_thumb.JPG",
                                    "user_link": "http://untappd.com/user/mjongbloets",
                                    "account_type": "user",
                                    "brewery_details": [ ]
                                },
                                "like_id": 1602655,
                                "like_owner": false,
                                "created_at": "Mon, 17 Sep 2012 23:24:54 +0000"
                            },
                            {
                                "user": {
                                    "uid": 14550,
                                    "user_name": "boomerdogg",
                                    "first_name": "Kyle",
                                    "last_name": "Thomas",
                                    "user_avatar": "https://untappd.s3.amazonaws.com/profile/5efc1b611e02f97447775259b897f67e_thumb.jpg",
                                    "user_link": "http://untappd.com/user/boomerdogg",
                                    "account_type": "user",
                                    "brewery_details": [ ]
                                },
                                "like_id": 1602882,
                                "like_owner": false,
                                "created_at": "Mon, 17 Sep 2012 23:40:45 +0000"
                            },
                            {
                                "user": {
                                    "uid": 2091,
                                    "user_name": "IdleHandsRev",
                                    "first_name": "Rev",
                                    "last_name": "IdleHands",
                                    "user_avatar": "https://untappd.s3.amazonaws.com/profile/bd0807ddd8b7d3501a181f783de0053e_thumb.JPG",
                                    "user_link": "http://untappd.com/user/IdleHandsRev",
                                    "account_type": "user",
                                    "brewery_details": [ ]
                                },
                                "like_id": 1602996,
                                "like_owner": false,
                                "created_at": "Mon, 17 Sep 2012 23:55:46 +0000"
                            },
                            {
                                "user": {
                                    "uid": 76444,
                                    "user_name": "Byron_Hadley",
                                    "first_name": "Craig",
                                    "last_name": "",
                                    "user_avatar": "http://gravatar.com/avatar/0510da74f4b2c8af035aacc39ce76945?size=100&d=https%3A%2F%2Funtappd.s3.amazonaws.com%2Fsite%2Fassets%2Fimages%2Fdefault_avatar.jpg",
                                    "user_link": "http://untappd.com/user/Byron_Hadley",
                                    "account_type": "user",
                                    "brewery_details": [ ]
                                },
                                "like_id": 1603107,
                                "like_owner": false,
                                "created_at": "Tue, 18 Sep 2012 00:08:42 +0000"
                            },
                            {
                                "user": {
                                    "uid": 489,
                                    "user_name": "jeremyperry",
                                    "first_name": "Jeremy",
                                    "last_name": "Perry",
                                    "user_avatar": "https://untappd.s3.amazonaws.com/profile/8d0e83967fa2eced73839ab9b0a0313c_thumb.jpg",
                                    "user_link": "http://untappd.com/user/jeremyperry",
                                    "account_type": "user",
                                    "brewery_details": [ ]
                                },
                                "like_id": 1604950,
                                "like_owner": false,
                                "created_at": "Tue, 18 Sep 2012 03:18:46 +0000"
                            },
                            {
                                "user": {
                                    "uid": 97323,
                                    "user_name": "aslezak",
                                    "first_name": "Andy",
                                    "last_name": "Slezak",
                                    "user_avatar": "https://untappd.s3.amazonaws.com/profile/173ed65920d9ce32c9780b453848b34a_thumb.jpg",
                                    "user_link": "http://untappd.com/user/aslezak",
                                    "account_type": "user",
                                    "brewery_details": [ ]
                                },
                                "like_id": 1609773,
                                "like_owner": false,
                                "created_at": "Wed, 19 Sep 2012 02:10:14 +0000"
                            }
                        ]
                    },
                    "media": {
                        "count": 0,
                        "items": [ ]
                    },
                    "source": {
                        "app_name": "Untappd for Android - (V2)",
                        "app_website": "http://untpd.it/androidapp"
                    }
                },
                {
                    "notification_type": "comment",
                    "message": null,
                    "created_at": "Sun, 16 Sep 2012 17:36:51 +0000",
                    "checkin_id": 12969982,
                    "checkin_comment": "Post half marathon beer! Tastes sooo good.",
                    "rating_score": 3,
                    "checkin_owner": false,
                    "actor": {
                        "uid": 14834,
                        "user_name": "scrapdog",
                        "first_name": "Chris",
                        "last_name": "Betz",
                        "location": "Philadelphia, PA",
                        "url": "http://cbetz.com",
                        "bio": "Untappd Super User. BeerSpec creator. Lover of beer, technology, and running. ",
                        "user_avatar": "http://gravatar.com/avatar/ed2e9bc381eccc05c82c906328cb25ec?size=100&d=https%3A%2F%2Funtappd.s3.amazonaws.com%2Fsite%2Fassets%2Fimages%2Fdefault_avatar.jpg",
                        "contact": {
                            "twitter": "thechrisbetz",
                            "foursquare": 577208,
                            "facebook": 9505105
                        }
                    },
                    "user": {
                        "uid": 14834,
                        "user_name": "scrapdog",
                        "first_name": "Chris",
                        "last_name": "Betz",
                        "location": "Philadelphia, PA",
                        "url": "http://cbetz.com",
                        "bio": "Untappd Super User. BeerSpec creator. Lover of beer, technology, and running. ",
                        "user_avatar": "http://gravatar.com/avatar/ed2e9bc381eccc05c82c906328cb25ec?size=100&d=https%3A%2F%2Funtappd.s3.amazonaws.com%2Fsite%2Fassets%2Fimages%2Fdefault_avatar.jpg",
                        "account_type": "user",
                        "contact": {
                            "twitter": "thechrisbetz",
                            "foursquare": 577208,
                            "facebook": 9505105
                        },
                        "email_prefs": {
                            "is_friend_request": 1,
                            "is_toast": 1,
                            "is_comment": 1
                        },
                        "relationship": "friends"
                    },
                    "beer": {
                        "bid": 6775,
                        "beer_name": "Oktoberfest",
                        "beer_label": "https://untappd.s3.amazonaws.com/site/beer_logos/beer-leftHandOktoberfest.jpg",
                        "beer_style": "Oktoberfest/Märzen",
                        "auth_rating": 0,
                        "wish_list": false
                    },
                    "brewery": {
                        "brewery_id": 779,
                        "brewery_name": "Left Hand Brewing Company",
                        "brewery_label": "https://untappd.s3.amazonaws.com/site/brewery_logos/brewery-LeftHandBrewingCompany_779.jpeg",
                        "country_name": "United States",
                        "contact": {
                            "twitter": "LeftHandBrewing",
                            "facebook": "http://www.facebook.com/LeftHandBrewing",
                            "url": "http://www.lefthandbrewing.com"
                        },
                        "location": {
                            "brewery_city": "Longmont",
                            "brewery_state": "CO",
                            "lat": 40.1586,
                            "lng": -105.116
                        }
                    },
                    "venue": {
                        "venue_id": 5931,
                        "venue_name": "Pub & Kitchen",
                        "primary_category": "Food",
                        "parent_category_id": "4d4b7105d754a06374d81259",
                        "categories": {
                            "count": 2,
                            "items": [
                                {
                                    "category_name": "Burger Joint",
                                    "category_id": "4bf58dd8d48988d16c941735",
                                    "is_primary": false
                                },
                                {
                                    "category_name": "Gastropub",
                                    "category_id": "4bf58dd8d48988d155941735",
                                    "is_primary": true
                                }
                            ]
                        },
                        "location": {
                            "venue_address": "1946 Lombard St",
                            "venue_city": "Philadelphia",
                            "venue_state": "PA",
                            "lat": 39.9458,
                            "lng": -75.1748
                        },
                        "contact": {
                            "twitter": "@PubandKitchen",
                            "venue_url": "http://thepubandkitchen.com/"
                        },
                        "foursquare": {
                            "foursquare_id": "4a302adbf964a5202c991fe3",
                            "foursquare_url": "http://4sq.com/8hUWRs"
                        },
                        "venue_icon": {
                            "sm": "https://foursquare.com/img/categories/food/default_64.png",
                            "md": "https://foursquare.com/img/categories/food/default_88.png",
                            "lg": "https://foursquare.com/img/categories/food/default_256.png"
                        }
                    },
                    "comments": {
                        "count": 2,
                        "items": [
                            {
                                "user": {
                                    "uid": 1,
                                    "user_name": "gregavola",
                                    "first_name": "Greg",
                                    "last_name": "Avola",
                                    "user_avatar": "http://gravatar.com/avatar/0c6922e238dae5cccce96a32889fc911?size=100&d=https%3A%2F%2Funtappd.s3.amazonaws.com%2Fsite%2Fassets%2Fimages%2Fdefault_avatar.jpg",
                                    "user_link": "http://untappd.com/user/gregavola",
                                    "account_type": "user",
                                    "brewery_details": [ ]
                                },
                                "comment_id": "907681",
                                "comment_owner": true,
                                "comment": "Congrats!",
                                "created_at": "Sun, 16 Sep 2012 17:30:51 +0000",
                                "comment_source": "web"
                            },
                            {
                                "user": {
                                    "uid": 14834,
                                    "user_name": "scrapdog",
                                    "first_name": "Chris",
                                    "last_name": "Betz",
                                    "user_avatar": "http://gravatar.com/avatar/ed2e9bc381eccc05c82c906328cb25ec?size=100&d=https%3A%2F%2Funtappd.s3.amazonaws.com%2Fsite%2Fassets%2Fimages%2Fdefault_avatar.jpg",
                                    "user_link": "http://untappd.com/user/scrapdog",
                                    "account_type": "user",
                                    "brewery_details": [ ]
                                },
                                "comment_id": "907712",
                                "comment_owner": false,
                                "comment": "Thanks dude!",
                                "created_at": "Sun, 16 Sep 2012 17:36:51 +0000",
                                "comment_source": "mobile"
                            }
                        ]
                    },
                    "toasts": {
                        "count": 0,
                        "auth_toast": false,
                        "items": [ ]
                    },
                    "media": {
                        "count": 0,
                        "items": [ ]
                    },
                    "source": {
                        "app_name": "Untappd for Android - (V2)",
                        "app_website": "http://untpd.it/androidapp"
                    }
                },
               	...
            ]
        },
        "news": {
            "count": 25,
            "items": [
                {
                    "news_id": 68,
                    "news_title": "Fresh Hops Everywhere!",
                    "news_link": "http://untpd.it/hopharvest ",
                    "news_text": "Craving fresh hops? Find a Hop Harvest Pils from our friends BridgePort Brewing and unlock a new badge!",
                    "created_at": "Fri, 14 Sep 2012 18:32:30 +0000",
                    "news_type": "New Badge / Promotions"
                },
                ...
            ]
        }
    }

}
							

Foursquare Venue Lookup

Authentication: Not Required

HTTP Method: GET

/v4/venue/foursquare_lookup/VENUE_ID

This method will allow you to pass in a foursquare v2 ID and return a Untappd Venue ID to be used for /v4/venue/info or /v4/venue/checkins

Parameters

  • access_token or client_id and client_secret (required) - Either pass the access_token for authorized calls OR the client_id and client_secret for unauthorized calls
  • VENUE_ID (required) - The foursquare venue v2 ID that you wish to translate into a Untappd venue ID.

Example Response

{
    ...
    "response": {
        "venue": {
            "count": 1,
            "items": [
                {
                    "venue_name": "Untappd HQ - East",
                    "venue_id": 1222,
                    "foursquare_id": "4ccf5fec1ac7a1cd6a5c1392",
                    "last_updated": "Mon, 17 Sep 2012 16:20:10 +0000"
                }
            ]
        }
    }
}