Business API

Request

Name	Method	Description
/v2/business/{id}	GET	Lookup business information by id.

Sample Request:

http://api.yelp.com/v2/business/yelp-san-francisco

Locale Parameters

The following lists optional locale parameters. Results will be localized in the region format and language if supported. Both cc and lang should be specified for proper localization.

Name	Data Type	Required/Optional	Description
cc	string	optional	ISO 3166-1 alpha-2 country code. Default country to use when parsing the location field. United States = US, Canada = CA, United Kingdom = GB (not UK).
lang	string	optional	ISO 639 language code (default=en). Reviews written in the specified language will be shown.
lang_filter	bool	optional	Whether to filter business reviews by the specified lang

Response Value:

Name	Type	Definition
id	string	Yelp ID for this business
name	string	Name of this business
image_url	string	URL of photo for this business
url	string	URL for business page on Yelp
mobile_url	string	URL for mobile business page on Yelp
phone	string	Phone number for this business with international dialing code (e.g. `+442079460000`)
display_phone	string	Phone number for this business formatted for display
review_count	number	Number of reviews for this business
categories	list	Provides a list of category name, alias pairs that this business is associated with. For example, `[["Local Flavor", "localflavor"], ["Active Life", "active"], ["Mass Media", "massmedia"]]` The alias is provided so you can search with the category_filter.
distance	number	Distance that business is from search location in meters, if a latitude/longitude is specified.
rating	number	Rating for this business (value ranges from 1, 1.5, ... 4.5, 5)
rating_img_url	string	URL to star rating image for this business (size = 84x17)
rating_img_url_small	string	URL to small version of rating image for this business (size = 50x10)
rating_img_url_large	string	URL to large version of rating image for this business (size = 166x30)
snippet_text	string	Snippet text associated with this business
snippet_image_url	string	URL of snippet image associated with this business
location	dict	Location data for this business
location.coordinate	dict	Coordinates for this business
location.coordinate.latitude	number	Latitude for this business
location.coordinate.longitude	number	Longitude for this business
location.address	list	Address for this business. Only includes address fields.
location.display_address	list	Address for this business formatted for display. Includes all address fields, cross streets and city, state_code, etc.
location.city	string	City for this business
location.state_code	string	ISO 3166-2 state code for this business
location.postal_code	string	Postal code for this business
location.country_code	string	ISO 3166-1 country code for this business
location.cross_streets	string	Cross streets for this business
location.neighborhoods	list	List that provides neighborhood(s) information for business
location.geo_accuracy	number	Contains a value that corresponds to the accuracy with which the latitude / longitude was determined in the geocoder. These correspond to Google's GGeoAddressAccuracy field.
deals	list	Deal info for this business (optional: this field is present only if there's a Deal)
deals.id	string	Deal identifier
deals.title	string	Deal title
deals.url	url	Deal url
deals.image_url	url	Deal image url
deals.currency_code	string	ISO_4217 Currency Code
deals.time_start	number	Deal start time (Unix timestamp)
deals.time_end	number	Deal end time (optional: this field is present only if the Deal ends)
deals.what_you_get	string	Additional details for the Deal, separated by newlines
deals.important_restrictions	string	Important restrictions for the Deal, separated by newlines
deals.additional_restrictions	string	Deal additional restrictions
deals.options	list	Deal options
deals.options.title	string	Deal option title
deals.options.purchase_url	url	Deal option url for purchase
deals.options.price	number	Deal option price (in cents)
deals.options.formatted_price	string	Deal option price (formatted, e.g. "$6")
deals.options.original_price	number	Deal option original price (in cents)
deals.options.formatted_original_price	string	Deal option original price (formatted, e.g. "$12")
deals.options.is_quantity_limited	bool	Whether the deal option is limited or unlimited
deals.options.remaining_count	number	The remaining deal options available for purchase (optional: this field is only present if the deal is limited)
is_claimed	bool	Whether business has been claimed by a business owner
is_closed	bool	Whether business has been (permanently) closed
reviews	list	List of up to 3 review snippets for the business
reviews.id	string	Review identifier
reviews.rating	number	Rating from 1-5
reviews.rating_img_url	url	URL to star rating image for this business (size = 84x17)
reviews.rating_img_url_small	url	URL to small version of rating image for this business (size = 50x10)
reviews.rating_img_url_large	url	URL to large version of rating image for this business (size = 166x30)
reviews.time_created	number	Time created (Unix timestamp)
reviews.user	dict	User who wrote the review
reviews.user.id	string	User identifier
reviews.user.image_url	url	User profile image url
reviews.user.name	string	User name

Sample Response:


{
  "categories": [
    [
      "Indian",
      "indpak"
    ],
    [
      "Pakistani",
      "pakistani"
    ]
  ],
  "deals": [
    {
      "currency_code": "USD",
      "image_url": "http://s3-media4.ak.yelpcdn.com/dphoto/ShQGf5qi-52HwPiKyZTZ3w/m.jpg",
      "options": [
        {
          "formatted_original_price": "$20",
          "formatted_price": "$10",
          "is_quantity_limited": true,
          "original_price": 20000,
          "price": 10000,
          "purchase_url": "http://www.yelp.com/deal/cC24ccQGIH8mowfu5Vbe0Q/view",
          "remaining_count": 36,
          "title": "$10 for $20 voucher"
        }
      ],
      "currency_code": "USD",
      "url": "http://www.yelp.com/biz/urban-curry-san-francisco?deal=1",
      "time_start": 1317414369,
      "title": "$10 for $20 voucher"
    }
  ],
  "display_phone": "+1-415-677-9744",
  "id": "urban-curry-san-francisco",
  "image_url": "http://s3-media4.ak.yelpcdn.com/bphoto/Hv5vsWpqeaUKepr9nffJnw/ms.jpg",
  "is_claimed": true,
  "is_closed": false,
  "location": {
    "address": [
      "523 Broadway"
    ],
    "city": "San Francisco",
    "coordinate": {
      "latitude": 37.797745900000002,
      "longitude": -122.40586399999999
    },
    "country_code": "US",
    "cross_streets": "Kearny St & Romolo Pl",
    "display_address": [
      "523 Broadway",
      "(b/t Kearny St & Romolo Pl)",
      "North Beach/Telegraph Hill",
      "San Francisco, CA 94133"
    ],
    "geo_accuracy": 8,
    "neighborhoods": [
      "North Beach/Telegraph Hill"
    ],
    "postal_code": "94133",
    "state_code": "CA"
  },
  "mobile_url": "http://m.yelp.com/biz/EFjaNaqg2foSIM--mML49g",
  "name": "Urban Curry",
  "phone": "4156779744",
  "rating": 4.0,
  "rating_img_url": "http://media2.ak.yelpcdn.com/static/201012164084228337/img/ico/stars/stars_4.png",
  "rating_img_url_large": "http://media4.ak.yelpcdn.com/static/20101216169592178/img/ico/stars/stars_large_4.png",
  "rating_img_url_small": "http://media2.ak.yelpcdn.com/static/20101216418129184/img/ico/stars/stars_small_4.png",
  "review_count": 227,
  "reviews": [
    {
      "excerpt": "I gave this restaurant two stars just because of the extremely quick delivery and friendly delivery guy, but the food was nothing I would order again....",
      "id": "-RDZxLTUExM9Q02x4hZmHg",
      "rating": 2,
      "rating_image_large_url": "http://media2.ak.yelpcdn.com/static/20101216220207235/img/ico/stars/stars_large_2.png",
      "rating_image_small_url": "http://media4.ak.yelpcdn.com/static/201012164278297776/img/ico/stars/stars_small_2.png",
      "rating_image_url": "http://media4.ak.yelpcdn.com/static/201012163489049252/img/ico/stars/stars_2.png",
      "time_created": 1317939620,
      "user": {
        "id": "AUEDVbP9XNlOcgYOAfR8yg",
        "image_url": "http://s3-media2.ak.yelpcdn.com/photo/0CX0RSoz8NkPlOTo7Ckqdg/ms.jpg",
        "name": "Holly E."
      }
    },
    {
      "excerpt": "word on the streets!...get the goat!...quick call to check on the goat...goat is available!...pre-drinking before dinner...no alcohol at urban...",
      "id": "Zpfqx8FI8Pdpo-QVi8BCFA",
      "rating": 3,
      "rating_image_large_url": "http://media3.ak.yelpcdn.com/static/201012161053250406/img/ico/stars/stars_large_3.png",
      "rating_image_small_url": "http://media1.ak.yelpcdn.com/static/201012162337205794/img/ico/stars/stars_small_3.png",
      "rating_image_url": "http://media1.ak.yelpcdn.com/static/201012161694360749/img/ico/stars/stars_3.png",
      "time_created": 1317918655,
      "user": {
        "id": "JnGtgOPpkjyWOvWM0SYEXg",
        "image_url": "http://s3-media4.ak.yelpcdn.com/photo/On-6060NIAqIS_PfAVwDrg/ms.jpg",
        "name": "hen a."
      }
    },
    {
      "excerpt": "Urban Curry was okay. Friendly service and quick delivery but the food was very average in my opinion.\n\nThe best part of the meal was the vegetable pakoras...",
      "id": "FPagv5DTlPQ2h_Son5N0UA",
      "rating": 3,
      "rating_image_large_url": "http://media3.ak.yelpcdn.com/static/201012161053250406/img/ico/stars/stars_large_3.png",
      "rating_image_small_url": "http://media1.ak.yelpcdn.com/static/201012162337205794/img/ico/stars/stars_small_3.png",
      "rating_image_url": "http://media1.ak.yelpcdn.com/static/201012161694360749/img/ico/stars/stars_3.png",
      "time_created": 1317746299,
      "user": {
        "id": "tZA9Uztmj69tgvlHiiMKsg",
        "image_url": "http://s3-media3.ak.yelpcdn.com/photo/I87X9o6NgGrkO1lfBL5-4Q/ms.jpg",
        "name": "Chelsea J."
      }
    }
  ],
  "snippet_image_url": "http://s3-media1.ak.yelpcdn.com/photo/39c5Vpe0cFCtZ-rmgAr3YQ/ms.jpg",
  "snippet_text": "Shame on me for taking so long to update a review.\n\nI have been there several times now and love it everytime.\n\nDevour:  My fav the Lamb Tikka Masala, my...",
  "url": "http://www.yelp.com/biz/urban-curry-san-francisco"
}

Yelp for Developers

Business API

Request

Sample Request:

Locale Parameters

Response Value:

Sample Response: