/openrice/restaurants/chart

POST /api/openrice/restaurants/chart

Price: 20 credits

Read an OpenRice restaurant ranking for a regional market: best rated, most popular, best dessert or most bookmarked. Each entry carries the current rank, previous rank, movement on the chart, weeks on chart and the full restaurant card (name, district, rating, smile/ok/cry counts, cuisines, photos, counters).

How to use it

Read a weekly OpenRice restaurant chart for a region. chart accepts best_rating, most_popular, best_dessert and most_bookmarked. Each entry has rank, previous_rank, trend (up/down/new/no_change), weeks_on_chart, chart_updated_at and a nested restaurant card.

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")
• chart string — Which OpenRice ranking to read (default: "best_rating"; one of: "best_rating", "most_popular", "best_dessert", "most_bookmarked")
• count integer required — Max number of ranked restaurants to return (min: 1; max: 500)

Response

• @type string (default: "OpenriceChartEntry")
• rank integer required
• previous_rank integer nullable
• trend string nullable
• weeks_on_chart integer nullable
• chart_updated_at integer nullable
• restaurant object required
  • @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 — 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.