Skip to main content
POST
/openrice/restaurants/chart

Authorizations

access-token
string
header
required

API token from the dashboard

Headers

access-token
string
required

Body

application/json
count
integer
required
Required range: 1 <= x <= 500
timeout
integer
default:300
Required range: 20 <= x <= 1500
region
enum<string>
default:hongkong
Available options:
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
enum<string>
default:en
Available options:
en,
tc,
sc,
tc-tw,
ja,
th,
id
chart
enum<string>
default:best_rating
Available options:
best_rating,
most_popular,
best_dessert,
most_bookmarked

Response

Successful Response

rank
integer
required
restaurant
object
required
@type
string
default:OpenriceChartEntry
previous_rank
integer | null
trend
string | null
weeks_on_chart
integer | null
chart_updated_at
integer | null