Yelp business page

One business' page on Yelp: ids, address, coordinates, phone, website, menu, categories, price, rating, hours, amenities, owner, review highlights.

GET

/v1/yelp/place

One business' page on Yelp: ids, address, coordinates, phone, website, menu, categories, price, rating, hours, amenities, owner, review highlights. Its reviews are /v1/yelp/reviews.

In the document form. $1 request $2 yelp_domain (or full_menu, menu_name, business_alert) is the document-form Yelp Place call, answered as the document: search_metadata, search_parameters, search_information (has_menu) and place_result (place_id, alias, title, link, description, rating, reviews, price, categories, address, phone, website, menu_link, is_claimed, is_open, open_hours, amenities, review_highlights, health_inspections, gps_coordinates, business_owner, ...). $1 request $2 place_id alone is the older call (the name is the same in both), so send yelp_domain (yelp.com) to get the document. full_menu=true, menu_name and business_alert=true are a 400 (other pages of Yelp's, not read). Not on the page an anonymous visitor gets: images, ambiance, popular_items, community_questions, special_hours, business_alerts, is_claimable.

Authorization

headerX-API-Key<token>

Your API key.

Query Parameters

cancel_token?string

A name you make up for this request (a UUID is fine), so you can later GET /v1/cancel with it. Only you know it, so only you can cancel. Use a new one for every request, retries included: a cancelled token stays cancelled for a few minutes.

Length1 <= length <= 128

place_id?|

Yelp's id (V7lXZKBDzScDeGB8JmnzSA) or alias (katzs-delicatessen-new-york); /v1/yelp/search returns both in place_ids.

profile_url?string

yelp.com/biz/<alias>; its query is dropped.

Matchyelp\.[a-z.]+/biz/

country?string

Two letters, any case (us, GB).

Match^[A-Za-z]{2}$

yelp_domain?string

One of Yelp's domains (yelp.com, www.yelp.co.uk, fr.yelp.ca...); the page is loaded there, the request is still made from country.

Default"yelp.com"

Response Body

The business; with yelp_domain, the document.

application/json

response

The first three keys of every parsed 200 (the answer is the document itself, no success/data envelope): what the search was (search_metadata), what it asked (search_parameters), the parser's own search_information ({} when it has none). The engine's blocks follow, at the same level. An engine whose answer is a list puts it under results.

search_metadata*

search_parameters*

The request's own fields as sent, engine first, without cancel_token.

search_information*

The parser's own, e.g. yelp_search's; otherwise {}.

place_results*

Example Request

curl -X GET 'https://api.justserp.com/v1/yelp/place?place_id=katzs-delicatessen-new-york'

Example Request

curl -X GET 'https://api.justserp.com/v1/yelp/place?place_id=katzs-delicatessen-new-york'

Example ResponseSchema

{
  "search_metadata": {
    "id": "string",
    "status": "Success",
    "created_at": "string",
    "request_url": "string",
    "html_url": "string"
  },
  "search_parameters": {},
  "search_information": {},
  "place_results": {
    "name": "string",
    "place_ids": [
      "string"
    ],
    "alias": "string",
    "link": "string",
    "rating": 0,
    "reviews": 0,
    "price": "string",
    "categories": [
      {
        "title": "string",
        "alias": "string"
      }
    ],
    "address": "string",
    "address_parts": {
      "street": "string",
      "city": "string",
      "state": "string",
      "postal_code": "string",
      "country": "string"
    },
    "neighborhoods": [
      "string"
    ],
    "coordinates": {
      "latitude": 0,
      "longitude": 0
    },
    "timezone": "string",
    "phone": "string",
    "website": "string",
    "menu": {
      "link": "string",
      "yelp_link": "string"
    },
    "is_closed": true,
    "closed_until": "string",
    "is_claimed": true,
    "open_now": true,
    "hours": [
      {
        "day": "string",
        "hours": [
          "string"
        ],
        "special": true,
        "regular_hours": [
          "string"
        ]
      }
    ],
    "opening_hours": [
      "string"
    ],
    "amenities": [
      {
        "title": "string",
        "alias": "string",
        "available": true
      }
    ],
    "summary": "string",
    "specialties": "string",
    "history": "string",
    "year_established": 0,
    "owner": {
      "name": "string",
      "role": "string",
      "bio": "string"
    },
    "photos_count": 0,
    "thumbnail": "string",
    "review_highlights": [
      {
        "text": "string",
        "highlighted": [
          "string"
        ],
        "review_count": 0
      }
    ],
    "health_inspections": [
      {
        "score": "string",
        "date": "string",
        "violations": 0,
        "provider": "string"
      }
    ],
    "verified_licenses": [
      {}
    ],
    "service_area": [
      "string"
    ],
    "is_yelp_advertiser": true,
    "yelp_guaranteed": true
  }
}

{  "search_metadata": {    "id": "string",    "status": "Success",    "created_at": "string",    "request_url": "string",    "html_url": "string"  },  "search_parameters": {},  "search_information": {},  "place_results": {    "name": "string",    "place_ids": [      "string"    ],    "alias": "string",    "link": "string",    "rating": 0,    "reviews": 0,    "price": "string",    "categories": [      {        "title": "string",        "alias": "string"      }    ],    "address": "string",    "address_parts": {      "street": "string",      "city": "string",      "state": "string",      "postal_code": "string",      "country": "string"    },    "neighborhoods": [      "string"    ],    "coordinates": {      "latitude": 0,      "longitude": 0    },    "timezone": "string",    "phone": "string",    "website": "string",    "menu": {      "link": "string",      "yelp_link": "string"    },    "is_closed": true,    "closed_until": "string",    "is_claimed": true,    "open_now": true,    "hours": [      {        "day": "string",        "hours": [          "string"        ],        "special": true,        "regular_hours": [          "string"        ]      }    ],    "opening_hours": [      "string"    ],    "amenities": [      {        "title": "string",        "alias": "string",        "available": true      }    ],    "summary": "string",    "specialties": "string",    "history": "string",    "year_established": 0,    "owner": {      "name": "string",      "role": "string",      "bio": "string"    },    "photos_count": 0,    "thumbnail": "string",    "review_highlights": [      {        "text": "string",        "highlighted": [          "string"        ],        "review_count": 0      }    ],    "health_inspections": [      {        "score": "string",        "date": "string",        "violations": 0,        "provider": "string"      }    ],    "verified_licenses": [      {}    ],    "service_area": [      "string"    ],    "is_yelp_advertiser": true,    "yelp_guaranteed": true  }}

Yelp business page

AuthorizationCopy Anchor Link

Query ParametersCopy Anchor Link

Response BodyCopy Anchor Link

Authorization

Query Parameters

Response Body