# /openrice/restaurants/search

`POST /api/openrice/restaurants/search`

Price: 20 credits

Search OpenRice restaurants in a regional market with the full site filter surface: free-text what/where query, districts, landmarks and malls, cuisines, dishes, restaurant types, dining themes, features, accepted payment methods, cuisine/dish groups, seasonal promotions, spending tiers, offer types, OpenRice services, operating status, a reference point to rank by distance, and sort order. Returns restaurant cards with names, address, postal code, district, geo coordinates, weekly opening hours, rating and smile/ok/cry counts, cuisines, dishes, recommended dishes, price tier, photos, videos, chart badges and engagement counters. Results are the editorial listing only — sponsored placements the website shows alongside it are not part of the response.

## How to use it

Search OpenRice restaurants. Pick region (hongkong, macau, shenzhen, taipei, tokyo-kanto, bangkok, singapore, manila, ...) and lang, then filter with keyword/where free text and/or id filters (district_ids, landmark_ids, cuisine_ids, dish_ids, amenity_ids, theme_ids, condition_ids, payment_ids, category_group_ids, promotion_ids). Ids are region-specific: call openrice/facets for the same region to look them up by name. price_ranges selects spending tiers, offers filters on booking offers, vouchers and coupons, services on booking/queuing/OpenRice Pay, statuses on operating state (operating, closed, changed_hands, under_renovation, moved). sort accepts overall_rating, most_smiles, most_reviews, most_bookmarked, spending_low_to_high and more; the distance sort needs latitude and longitude, and then every card carries its distance in kilometres. Only the editorial listing is returned; sponsored placements shown on the website are not included.

## 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")
- `keyword` (string, nullable) — Free-text query: restaurant name, cuisine or dish (examples: "sushi", "hot pot")
- `where` (string, nullable) — Free-text location query: district, street or landmark name (examples: "Central")
- `district_ids` (array, nullable) — District ids to match (any of); resolve ids via the openrice/facets endpoint
- `cuisine_ids` (array, nullable) — Cuisine ids to match (any of); resolve ids via the openrice/facets endpoint
- `dish_ids` (array, nullable) — Dish ids to match (any of); resolve ids via the openrice/facets endpoint
- `amenity_ids` (array, nullable) — Restaurant-type / amenity ids to match (any of); resolve ids via openrice/facets
- `theme_ids` (array, nullable) — Dining-theme ids to match (any of); resolve ids via the openrice/facets endpoint
- `condition_ids` (array, nullable) — Feature / condition ids the restaurant must have (all of); resolve ids via openrice/facets
- `payment_ids` (array, nullable) — Accepted payment-method ids to match (any of); resolve ids via the openrice/facets endpoint
- `category_group_ids` (array, nullable) — Cuisine or dish group ids to match (any of); resolve ids via the openrice/facets endpoint
- `promotion_ids` (array, nullable) — Seasonal promotion / award scheme ids to match (any of); ids come from the promotions list carried by restaurant cards and restaurant profiles
- `price_ranges` (array, nullable) — Spending-per-person tiers to match (any of); tier boundaries differ per region (one of: "tier_1_cheapest", "tier_2", "tier_3", "tier_4", "tier_5", "tier_6_most_expensive")
- `offers` (array, nullable) — Only restaurants carrying every selected offer type (one of: "booking_offer", "prepaid_booking_menu", "premium_booking_menu", "voucher", "coupon")
- `services` (array, nullable) — Only restaurants with every selected OpenRice service enabled (one of: "online_booking", "queuing", "openrice_pay")
- `statuses` (array, nullable) — Keep only restaurants in one of these operating states (one of: "operating", "closed", "changed_hands", "under_renovation", "moved", "delisted", "hidden")
- `latitude` (number, nullable) — Latitude to measure distance from; required by the distance sort (min: -90; max: 90)
- `longitude` (number, nullable) — Longitude to measure distance from; required by the distance sort (min: -180; max: 180)
- `sort` (string) — Result ordering (default: "overall_rating"; one of: "overall_rating", "most_smiles", "most_cries", "most_reviews", "most_bookmarked", "highest_total_score", "spending_low_to_high", "spending_high_to_low", "distance")
- `count` (integer, required) — Max number of restaurants to return (min: 1; max: 10000)
- `landmark_ids` (array, nullable) — Landmark / mall ids to match (any of); resolve ids via the openrice/facets endpoint

## Response

### 200 — Successful Response

- `@type` (string) (default: "OpenriceRestaurantCard")
- `id` (integer, required)
- `url` (string, required)
- `alias` (string, nullable)
- `name` (string, required)
- `name_other_lang` (string, nullable)
- `address` (string, nullable)
- `address_other_lang` (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)
- `latitude` (number, nullable)
- `longitude` (number, nullable)
- `mall_name` (string, nullable)
- `floor` (string, nullable)
- `unit` (string, nullable)
- `phones` (array) (default: [])
- `phone_remarks` (array) (default: [])
- `website` (string, nullable)
- `opened_at` (integer, nullable)
- `opening_hours` (array) (default: [])
  - `@type` (string) (default: "OpenriceWeekHours")
  - `day_of_week` (integer, nullable)
  - `times` (array) (default: [])
  - `is_open_24h` (boolean) (default: false)
  - `is_closed` (boolean) (default: false)
  - `is_holiday` (boolean) (default: false)
  - `is_holiday_eve` (boolean) (default: false)
- `rating` (number, nullable)
- `or_score` (number, nullable)
- `smile_count` (integer, nullable)
- `cry_count` (integer, nullable)
- `review_count` (integer, nullable)
- `photo_count` (integer, nullable)
- `restaurant_photo_count` (integer, nullable)
- `media_count` (integer, nullable)
- `bookmark_count` (integer, nullable)
- `price_range_id` (integer, 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)
- `recommended_dishes` (array) (default: [])
- `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: [])
- `payment_ids` (array) (default: [])
- `image` (string, nullable)
- `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)
- `status` (integer, nullable)
- `status_text` (string, nullable)
- `moved_to_restaurant_id` (integer, nullable)
- `is_open_now` (boolean) (default: false)
- `is_new` (boolean) (default: false)
- `is_queuing_enabled` (boolean) (default: false)
- `has_offer` (boolean) (default: false)
- `has_premium_menu` (boolean) (default: false)
- `distance` (number, nullable)
- `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

The entity was not found, or a precondition failed

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.