Skip to main content
POST
/
api
/
hotpepper
/
restaurants
/
search
/hotpepper/restaurants/search
curl --request POST \
  --url https://api.anysite.io/api/hotpepper/restaurants/search \
  --header 'Content-Type: application/json' \
  --header 'access-token: <api-key>' \
  --data '
{
  "count": 2,
  "timeout": 300,
  "keyword": "個室",
  "budget_min": 1,
  "budget_max": 1,
  "budget_for_lunch": false,
  "features": [],
  "net_reserve": false,
  "instant_reserve": false,
  "point_earn": false,
  "point_use": false,
  "point_plus": false,
  "takeout": false,
  "smart_pay": false,
  "covid_info": false,
  "has_coupon": false
}
'
[
  {
    "id": "<string>",
    "url": "<string>",
    "@type": "HotpepperSearchCard",
    "name": "<string>",
    "image": "<string>",
    "genre": "<string>",
    "area": "<string>",
    "catch_copy": "<string>",
    "keywords": "<string>",
    "access": "<string>",
    "budget_dinner": "<string>",
    "budget_lunch": "<string>",
    "coupons": []
  }
]

Authorizations

​
access-token
string
header
required

API token from the dashboard

Headers

​
access-token
string
required

Body

application/json
​
area
enum<string>
required

Prefecture to scope the search

Available options:
hokkaido,
aomori,
iwate,
miyagi,
akita,
yamagata,
fukushima,
tokyo,
kanagawa,
saitama,
chiba,
ibaraki,
tochigi,
gunma,
niigata,
toyama,
ishikawa,
fukui,
yamanashi,
nagano,
gifu,
shizuoka,
aichi,
mie,
shiga,
kyoto,
osaka,
hyogo,
nara,
wakayama,
tottori,
shimane,
okayama,
hiroshima,
yamaguchi,
tokushima,
kagawa,
ehime,
kochi,
fukuoka,
saga,
nagasaki,
kumamoto,
oita,
miyazaki,
kagoshima,
okinawa
​
count
integer
required

Max number of results to return

Required range: x >= 1
​
timeout
integer
default:300

Max scrapping execution timeout (in seconds)

Required range: 20 <= x <= 1500
​
keyword
string | null

Free-text keyword — narrows by sub-area, station, shop name or dish (e.g. '渋谷', '新宿駅', '刺身')

Example:

"個室"

​
genre
enum<string> | null

Restaurant genre filter

Available options:
izakaya,
dining_bar,
creative_cuisine,
japanese,
western,
italian_french,
chinese,
yakiniku,
asian_ethnic,
world_cuisine,
karaoke_party,
bar,
ramen,
cafe_sweets,
other_gourmet,
okonomiyaki,
korean
​
budget_min
integer | null

Minimum per-person budget (JPY)

Required range: x >= 0
​
budget_max
integer | null

Maximum per-person budget (JPY)

Required range: x >= 0
​
budget_for_lunch
boolean
default:false

Apply the budget filter to lunch instead of dinner

​
scene
enum<string> | null

Usage scene filter

Available options:
date,
friends,
family,
business_dining,
solo,
large_banquet,
company_banquet,
anniversary,
group_date
​
features
enum<string>[]

Amenity/feature filters (こだわり)

Available options:
course,
all_you_can_drink,
all_you_can_eat,
private_room,
horigotatsu,
tatami,
cocktails,
shochu,
sake,
wine,
card_ok,
charter,
parking,
barrier_free,
night_view,
live_show,
karaoke,
band,
tv_projector,
lunch,
open_after_23,
food_after_23,
english_menu,
pets_ok,
kids_ok,
wifi,
counter,
sofa,
terrace,
celebration,
e_money,
sunday_open
​
smoking
enum<string> | null

Smoking policy filter

Available options:
non_smoking,
separated,
smoking_ok
​
net_reserve
boolean
default:false

Only restaurants with online reservation

​
instant_reserve
boolean
default:false

Only restaurants with instant online reservation

​
point_earn
boolean
default:false

Only restaurants where points can be earned

​
point_use
boolean
default:false

Only restaurants where points can be spent

​
point_plus
boolean
default:false

Only restaurants in the bonus-point (point plus) program

​
takeout
boolean
default:false

Only restaurants offering takeout

​
smart_pay
boolean
default:false

Only restaurants accepting smart (online) payment

​
covid_info
boolean
default:false

Only restaurants publishing infection-control information

​
has_coupon
boolean
default:false

Only restaurants with coupons

Response

Successful Response

​
id
string
required
​
url
string
required
​
@type
string
default:HotpepperSearchCard
​
name
string | null
​
image
string | null
​
genre
string | null
​
area
string | null
​
catch_copy
string | null
​
keywords
string | null
​
access
string | null
​
budget_dinner
string | null
​
budget_lunch
string | null
​
coupons
string[]