/openrice/restaurants/menu

POST /api/openrice/restaurants/menu

Price: 5 credits

List the menu pages an OpenRice restaurant publishes as images, both the ones supplied by the restaurant itself and the ones uploaded by members: full-size, standard and thumbnail URLs, captions, upload time and the uploader profile. Menus are photographed pages, so prices and dishes are readable from the images rather than returned as structured rows.

How to use it

List menu page images of one OpenRice restaurant by id or page URL. Set region and lang to the restaurant's market. Restaurant-supplied pages come first, then member uploads. Each item has image (standard), image_full for OCR, image_thumbnail, submitted_at and, for member uploads, the user object.

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")
• 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)
• count integer required — Max number of menu pages to return (min: 1)

Response

• @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)

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.