/openrice/facets

POST /api/openrice/facets

Price: 20 credits

Get the full filter catalog OpenRice uses for one regional market: districts with their coordinates, landmarks and malls with address and coordinates, cuisines and cuisine groups, dishes and dish groups, restaurant types, dining themes, features, accepted payment methods, and the review facets (meal times, special occasions, photo types, dining methods, dining offers). Every catalog is region-specific, so these ids are what the search, coupon and review endpoints expect.

How to use it

Look up the numeric filter ids that openrice/restaurants/search, openrice/coupons/search and the review endpoints accept. Ids differ per region, so request the same region you intend to search. Use groups to fetch only the catalogs you need (e.g. groups=['cuisines','districts']) instead of the whole catalog. Every option has id and name in the requested language; cuisines, dishes and restaurant types also carry group_ids, cuisine_groups and dish_groups list their category_ids, districts carry coordinates and landmarks carry address, district_id and coordinates.

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")
• groups array nullable — Limit the response to these filter catalogs; all catalogs are returned when omitted (one of: "districts", "landmarks", "cuisines", "cuisine_groups", "dishes", "dish_groups", "amenities", "themes", "conditions", "payments", "meal_times", "occasions", "photo_types", "dining_methods", "dining_offers")

Response

• @type string (default: "OpenriceFacets")
• region string required
• region_id integer required
• lang string required
• districts array (default: [])
  • @type string (default: "OpenriceFacetDistrict")
  • id integer required
  • name string required
  • alias string nullable
  • latitude number nullable
  • longitude number nullable
• landmarks array (default: [])
  • @type string (default: "OpenriceFacetLandmark")
  • id integer required
  • name string required
  • address string nullable
  • district_id integer nullable
  • landmark_type_id integer nullable
  • latitude number nullable
  • longitude number nullable
• cuisines array (default: [])
  • @type string (default: "OpenriceFacetCategory")
  • id integer required
  • name string required
  • alias string nullable
  • group_ids array (default: [])
• cuisine_groups array (default: [])
  • @type string (default: "OpenriceFacetCategoryGroup")
  • id integer required
  • name string required
  • alias string nullable
  • category_ids array (default: [])
• dishes array (default: [])
  • @type string (default: "OpenriceFacetCategory")
  • id integer required
  • name string required
  • alias string nullable
  • group_ids array (default: [])
• dish_groups array (default: [])
  • @type string (default: "OpenriceFacetCategoryGroup")
  • id integer required
  • name string required
  • alias string nullable
  • category_ids array (default: [])
• amenities array (default: [])
  • @type string (default: "OpenriceFacetCategory")
  • id integer required
  • name string required
  • alias string nullable
  • group_ids array (default: [])
• themes array (default: [])
  • @type string (default: "OpenriceFacetTag")
  • id integer required
  • name string required
  • alias string nullable
• conditions array (default: [])
  • @type string (default: "OpenriceFacetTag")
  • id integer required
  • name string required
  • alias string nullable
• payments array (default: [])
  • @type string (default: "OpenriceFacetPayment")
  • id integer required
  • name string required
  • is_credit_card boolean (default: false)
• meal_times array (default: [])
  • @type string (default: "OpenriceFacetLabel")
  • id integer required
  • name string required
• occasions array (default: [])
  • @type string (default: "OpenriceFacetLabel")
  • id integer required
  • name string required
• photo_types array (default: [])
  • @type string (default: "OpenriceFacetLabel")
  • id integer required
  • name string required
• dining_methods array (default: [])
  • @type string (default: "OpenriceFacetLabel")
  • id integer required
  • name string required
• dining_offers array (default: [])
  • @type string (default: "OpenriceFacetLabel")
  • id integer required
  • name string required

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 — The entity was not found, or a precondition failed 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.