/openrice/restaurants/reviews

POST /api/openrice/restaurants/reviews

Price: 20 credits

List OpenRice reviews for a restaurant: review text, overall rating and smile/ok/cry verdict, the five sub-ratings (taste, decor, service, hygiene, value), per-person spend, recommended dishes, waiting time, attached photos, engagement counters and the reviewer profile. Filter by verdict, meal occasion, special occasion, editor's pick, presence of price or photos, tasting events and English-only reviews.

How to use it

List reviews of one OpenRice restaurant by id or page URL. Set region and lang to the restaurant's market. Filters: smile (smile/ok/cry), meal_time (breakfast/lunch/tea/dinner/supper/other), occasion_id, editor_pick, with_price, with_photo, tasting_event, english_only. Each review has text, rating on a 0-5 scale, rating_taste/decor/service/hygiene/value, price (spend per person in local currency), recommended_dishes, photos, view_count/like_count and the user object with grade and review counts.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• region string — OpenRice regional market the request is scoped to (default: "hongkong"; one of: "hongkong", "macau", "shenzhen", "guangzhou", "zhuhai", "dongguan", "foshan", "zhongshan", "taipei", "newtaipei-keelung", "taoyuan", "hsinchu-miaoli", "taichung", "changhua-nantou", "yunlin-chiayi", "tainan", "kaohsiung-pingtung", "eastern", "tokyo-kanto", "osaka-kobe", "kyoto-kinki", "nagoya-chubu", "hokkaido", "tohoku", "hiroshima-chugoku", "shikoku", "fukuoka-kyushu", "okinawa", "bangkok", "chonburi", "phuket", "prachuapkhirikhan", "chiangmai", "suratthani", "nakhonratchasima", "chiangrai", "others", "singapore", "manila")
• lang string — Content language for names, addresses and category labels (default: "en"; one of: "en", "tc", "sc", "tc-tw", "ja", "th", "id")
• smile string nullable — Keep only reviews with this overall verdict (one of: "smile", "ok", "cry")
• meal_time string nullable — Keep only reviews written about this meal occasion (one of: "breakfast", "lunch", "tea", "dinner", "supper", "other")
• occasion_id integer nullable — Special-occasion id the review was written for; resolve ids via openrice/facets
• editor_pick boolean nullable — Keep only editor's pick reviews
• with_price boolean nullable — Keep only reviews that report a per-person spend
• with_photo boolean nullable — Keep only reviews that include photos
• tasting_event boolean nullable — Keep only tasting-event reviews when true, exclude them when false
• english_only boolean nullable — Keep only reviews written in English
• sort string — Result ordering (default: "most_relevant"; one of: "most_relevant", "newest_published", "oldest_published")
• count integer required — Max number of reviews to return (min: 1)
• restaurant string required — Restaurant id or restaurant page URL (examples: "536198", "https://www.openrice.com/en/hongkong/r-sushi-masa-sheung-wan-r536198"; minLength: 1)

Response

• @type string (default: "OpenriceReview")
• id integer required
• url string nullable
• restaurant_id integer nullable
• restaurant_name string nullable
• restaurant_url string nullable
• review_title string nullable
• text string nullable
• rating number nullable
• smile string nullable
• rating_taste integer nullable
• rating_decor integer nullable
• rating_service integer nullable
• rating_hygiene integer nullable
• rating_value integer nullable
• price number nullable
• meal_time_id integer nullable
• occasion_id integer nullable
• occasion_name string nullable
• dining_method_id integer nullable
• wait_time string nullable
• recommended_dishes array (default: [])
• blog_url string nullable
• language string nullable
• view_count integer nullable
• like_count integer nullable
• dislike_count integer nullable
• recommend_count integer nullable
• photo_count integer nullable
• comment_count integer nullable
• reply_count integer nullable
• is_editor_choice boolean (default: false)
• is_tasting_event boolean (default: false)
• is_featured boolean (default: false)
• visited_at integer nullable
• submitted_at integer nullable
• published_at integer nullable
• last_comment_at integer nullable
• photos array (default: [])
  • @type string (default: "OpenricePhoto")
  • id integer required
  • url string nullable
  • image string nullable
  • image_full string nullable
  • image_thumbnail string nullable
  • caption string nullable
  • caption_other_lang string nullable
  • photo_type_id integer nullable
  • price number nullable
  • rating number nullable
  • width integer nullable
  • height integer nullable
  • view_count integer nullable
  • like_count integer nullable
  • comment_count integer nullable
  • review_id integer nullable
  • restaurant_id integer nullable
  • submitted_at integer nullable
  • user object nullable
    • @type string (default: "OpenriceUserBrief")
    • id integer required
    • sso_id string nullable
    • url string nullable
    • username string nullable
    • bio string nullable
    • image string nullable
    • grade integer nullable
    • grade_name string nullable
    • review_count integer nullable
    • follower_count integer nullable
    • following_count integer nullable
    • photo_count integer nullable
    • is_vip boolean (default: false)
    • is_vlogger boolean (default: false)
• user object nullable
  • @type string (default: "OpenriceUserBrief")
  • id integer required
  • sso_id string nullable
  • url string nullable
  • username string nullable
  • bio string nullable
  • image string nullable
  • grade integer nullable
  • grade_name string nullable
  • review_count integer nullable
  • follower_count integer nullable
  • following_count integer nullable
  • photo_count integer nullable
  • is_vip boolean (default: false)
  • is_vlogger boolean (default: false)

Errors

• 422 — The request body did not validate Check the fields against this schema. A URN with the wrong prefix is the most common cause.
• 408 — The request ran past its time limit Raise `timeout` in the request body, up to the maximum this endpoint documents. Lowering `count` or turning off the `with_*` flags also helps, because less work finishes sooner.
• 412 — Restaurant not found in this region Retrying will not help: either the entity does not exist, or the input points at a different one.
• 429 — Too many requests: a rate limit or a usage window is exhausted When the response carries an X-Retry-After header, wait that many seconds and retry: the same number is in the body as `detail.retry_after`, and the limit clears once that window passes. The message in the body names the limit that was hit.
• 500 — Something broke on our side Retrying will not help. If it keeps happening, send us the X-Request-ID from the response headers.
• 529 — Rate limit reached, or the endpoint is overloaded Wait at least 30 seconds, then retry.

Response headers

• X-Error — Error message text (present only on error)
• X-Request-ID — Unique request identifier
• X-Execution-Time — Execution time in seconds
• X-Result-Count — How many records the body carries. 0 means an empty result, which is a normal answer and not by itself an error. A non-zero count can come back together with X-Error when the failure happened partway through — read this header and X-Error independently.
• X-Total-Available-Results — How many records exist for this query, when the endpoint can say. On a `dry_run` request this is the answer and the body is empty. It saturates: the endpoint's documented maximum means 'at least that many', any smaller number is exact.
• X-Warning — Present when the request body carried keys this endpoint does not document. They were ignored, so any filter you meant to apply through them did not apply. Check the spelling against this schema and retry.
• X-Retry-After — Seconds to wait before retrying. Present only on 429.