# /openrice/restaurants

`POST /api/openrice/restaurants`

Price: 5 credits

Get a full OpenRice restaurant profile by restaurant id or restaurant page URL: multilingual names and addresses, district, malls and landmarks it sits in, geo coordinates, directions and nearest station exit, phones, website and social links, opening hours (weekly, today, special and free-text), price range and currency, seat count, overall rating plus taste/decor/service/hygiene/value sub-ratings, smile/ok/cry counts, cuisines, dishes, themes, amenities, features, accepted payment methods, recommended dishes, award history, chart badges, promotion schemes, editorial articles, the restaurant chain it belongs to, operating status with the relocation notice, photos, menu photos, videos and engagement counters.

## How to use it

Fetch one OpenRice restaurant by numeric id (e.g. 536198) or by its page URL. Set region to the market the restaurant belongs to (hongkong, macau, shenzhen, taipei, tokyo-kanto, bangkok, singapore, manila, ...) and lang for the content language. Returns id, url, name (+name_other_lang and name_langs), address, district, mall_name and landmarks, latitude/longitude, phones, website, opening_hours, price_min/price_max, currency, seat_count, rating (0-5), smile_count/ok_count/cry_count, rating_taste/decor/service/hygiene/value, cuisines, dishes, amenities, conditions, payments, popular_dishes, recommended_dishes, awards, badges, promotions, articles, chain (id, name and how many branches it has), status/status_text/status_note, images, menu_images and review/photo/bookmark counters.

## 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)

## Response

### 200 — Successful Response

- `@type` (string) (default: "OpenriceRestaurant")
- `id` (integer, required)
- `url` (string, required)
- `alias` (string, nullable)
- `name` (string, required)
- `name_other_lang` (string, nullable)
- `name_langs` (object) (default: {})
  - `*` (string)
- `alias_langs` (object) (default: {})
  - `*` (string)
- `address` (string, nullable)
- `address_other_lang` (string, nullable)
- `display_address` (string, nullable)
- `postal_code` (string, nullable)
- `district` (object, nullable)
  - `@type` (string) (default: "OpenriceDistrict")
  - `id` (integer, required)
  - `name` (string, required)
  - `alias` (string, nullable)
  - `group_id` (integer, nullable)
  - `latitude` (number, nullable)
  - `longitude` (number, nullable)
- `landmark_ids` (array) (default: [])
- `landmarks` (array) (default: [])
  - `@type` (string) (default: "OpenriceLandmarkBrief")
  - `id` (integer, required)
  - `name` (string, required)
  - `address` (string, nullable)
  - `district_id` (integer, nullable)
  - `landmark_type_id` (integer, nullable)
- `mall_name` (string, nullable)
- `floor` (string, nullable)
- `unit` (string, nullable)
- `latitude` (number, nullable)
- `longitude` (number, nullable)
- `directions` (string, nullable)
- `nearby_station_exit` (string, nullable)
- `phones` (array) (default: [])
- `phone_remarks` (array) (default: [])
- `website` (string, nullable)
- `facebook` (string, nullable)
- `instagram` (string, nullable)
- `opened_at` (integer, nullable)
- `price_min` (number, nullable)
- `price_max` (number, nullable)
- `price_range_id` (integer, nullable)
- `currency_symbol` (string, nullable)
- `seat_count` (integer, nullable)
- `rating` (number, nullable)
- `or_score` (number, nullable)
- `smile_count` (integer, nullable)
- `ok_count` (integer, nullable)
- `cry_count` (integer, nullable)
- `rating_taste` (integer, nullable)
- `rating_decor` (integer, nullable)
- `rating_service` (integer, nullable)
- `rating_hygiene` (integer, nullable)
- `rating_value` (integer, nullable)
- `review_count` (integer, nullable)
- `featured_review_count` (integer, nullable)
- `photo_count` (integer, nullable)
- `restaurant_photo_count` (integer, nullable)
- `menu_photo_count` (integer, nullable)
- `media_count` (integer, nullable)
- `bookmark_count` (integer, nullable)
- `popular_dish_count` (integer, nullable)
- `article_count` (integer, nullable)
- `coupon_count` (integer, nullable)
- `chain` (object, nullable)
  - `@type` (string) (default: "OpenriceChain")
  - `id` (integer, required)
  - `name` (string, required)
  - `restaurant_count` (integer, nullable)
  - `url` (string, nullable)
- `cuisines` (array) (default: [])
  - `@type` (string) (default: "OpenriceCategory")
  - `id` (integer, required)
  - `name` (string, required)
  - `alias` (string, nullable)
- `dishes` (array) (default: [])
  - `@type` (string) (default: "OpenriceCategory")
  - `id` (integer, required)
  - `name` (string, required)
  - `alias` (string, nullable)
- `themes` (array) (default: [])
  - `@type` (string) (default: "OpenriceCategory")
  - `id` (integer, required)
  - `name` (string, required)
  - `alias` (string, nullable)
- `amenities` (array) (default: [])
  - `@type` (string) (default: "OpenriceCategory")
  - `id` (integer, required)
  - `name` (string, required)
  - `alias` (string, nullable)
- `conditions` (array) (default: [])
  - `@type` (string) (default: "OpenriceCondition")
  - `id` (integer, required)
  - `name` (string, required)
  - `alias` (string, nullable)
  - `note` (string, nullable)
- `payments` (array) (default: [])
  - `@type` (string) (default: "OpenricePayment")
  - `id` (integer, required)
  - `name` (string, required)
  - `is_credit_card` (boolean) (default: false)
- `opening_hours` (array) (default: [])
  - `@type` (string) (default: "OpenriceOpeningHours")
  - `days` (string, required)
  - `times` (array) (default: [])
- `opening_hours_today` (object, nullable)
  - `@type` (string) (default: "OpenriceOpeningHours")
  - `days` (string, required)
  - `times` (array) (default: [])
- `opening_hours_special` (array) (default: [])
  - `@type` (string) (default: "OpenriceOpeningHours")
  - `days` (string, required)
  - `times` (array) (default: [])
- `opening_hours_note` (string, nullable)
- `opening_hours_text` (string, nullable)
- `last_order_text` (string, nullable)
- `info` (string, nullable)
- `other_info` (string, nullable)
- `popular_dishes` (array) (default: [])
  - `@type` (string) (default: "OpenricePopularDish")
  - `id` (integer, required)
  - `name` (string, required)
  - `rating` (number, nullable)
  - `price` (number, nullable)
  - `user_count` (integer, nullable)
  - `image` (string, nullable)
- `recommended_dishes` (array) (default: [])
- `articles` (array) (default: [])
  - `@type` (string) (default: "OpenriceArticleBrief")
  - `id` (integer, required)
  - `article_title` (string, required)
  - `url` (string, nullable)
  - `image` (string, nullable)
  - `published_at` (integer, nullable)
- `images` (array) (default: [])
- `image` (string, nullable)
- `menu_images` (array) (default: [])
- `videos` (array) (default: [])
  - `@type` (string) (default: "OpenriceVideo")
  - `id` (integer, required)
  - `video_url` (string, nullable)
  - `image` (string, nullable)
  - `caption` (string, nullable)
  - `width` (integer, nullable)
  - `height` (integer, nullable)
  - `view_count` (integer, nullable)
  - `like_count` (integer, nullable)
  - `comment_count` (integer, nullable)
  - `submitted_at` (integer, nullable)
- `first_review_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)
- `michelin_text` (string, nullable)
- `promotions` (array) (default: [])
  - `@type` (string) (default: "OpenricePromotion")
  - `id` (integer, required)
  - `name` (string, required)
  - `description` (string, nullable)
  - `terms` (string, nullable)
  - `is_credit_card` (boolean) (default: false)
- `badges` (array) (default: [])
- `awards` (array) (default: [])
- `status` (integer, nullable)
- `status_text` (string, nullable)
- `status_note` (string, nullable)
- `moved_to_restaurant_id` (integer, nullable)
- `is_open_now` (boolean) (default: false)
- `is_open_late` (boolean) (default: false)
- `is_open_early` (boolean) (default: false)
- `is_new` (boolean) (default: false)
- `is_verified` (boolean) (default: false)
- `is_queuing_enabled` (boolean) (default: false)
- `has_premium_menu` (boolean) (default: false)
- `short_url` (string, nullable)

## Errors

### 422 — Validation Error

The request body did not validate

What to do: Check the fields against this schema. A URN with the wrong prefix is the most common cause.

- `detail` (array)
  - `loc` (array, required)
  - `msg` (string, required)
  - `type` (string, required)
  - `input` (any)
  - `ctx` (object)

### 408

The request ran past its time limit

What to do: 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 (valid id format but no such restaurant)

What to do: 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

What to do: 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

What to do: 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

What to do: Wait at least 30 seconds, then retry.

## Response envelope

Success: Array of objects (may be empty if no results)

Error: Error may coexist with partial results if it occurs mid-execution. Check X-Error header and status code.

Every response carries these 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.