/hotpepper/restaurants/search

POST /api/hotpepper/restaurants/search

Price: 10 credits

Search Hot Pepper Gourmet (ホットペッパーグルメ) restaurants within a prefecture by keyword and/or genre with optional filters: budget range (dinner or lunch), usage scene, amenity features (こだわり), smoking policy, online/instant reservation, points, takeout, smart payment and coupons. Returns restaurant cards with name, image, genre, area, catch copy, keywords, access, dinner/lunch budgets and coupon titles.

How to use it

Search Hot Pepper Gourmet (ホットペッパーグルメ) restaurants. Always provide area (Japanese prefecture) and at least one of keyword or genre. Optional: budget_min/budget_max (JPY per person, budget_for_lunch to target lunch), scene, features (こだわり list), smoking, net_reserve, instant_reserve, point_earn/point_use/point_plus, takeout, smart_pay, covid_info, has_coupon. Use keyword to narrow by sub-area, station or dish. Each result has id ('J003433499'), url, name, image, genre, area, catch_copy, keywords, access, budget_dinner/budget_lunch and coupons.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• area string required — Prefecture to scope the search (one of: "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")
• keyword string nullable — Free-text keyword — narrows by sub-area, station, shop name or dish (e.g. '渋谷', '新宿駅', '刺身') (examples: "個室", "焼肉", "渋谷", "刺身")
• genre string nullable — Restaurant genre filter (one of: "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 nullable — Minimum per-person budget (JPY) (min: 0)
• budget_max integer nullable — Maximum per-person budget (JPY) (min: 0)
• budget_for_lunch boolean — Apply the budget filter to lunch instead of dinner (default: false)
• scene string nullable — Usage scene filter (one of: "date", "friends", "family", "business_dining", "solo", "large_banquet", "company_banquet", "anniversary", "group_date")
• features array — Amenity/feature filters (こだわり) (default: []; one of: "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 string nullable — Smoking policy filter (one of: "non_smoking", "separated", "smoking_ok")
• net_reserve boolean — Only restaurants with online reservation (default: false)
• instant_reserve boolean — Only restaurants with instant online reservation (default: false)
• point_earn boolean — Only restaurants where points can be earned (default: false)
• point_use boolean — Only restaurants where points can be spent (default: false)
• point_plus boolean — Only restaurants in the bonus-point (point plus) program (default: false)
• takeout boolean — Only restaurants offering takeout (default: false)
• smart_pay boolean — Only restaurants accepting smart (online) payment (default: false)
• covid_info boolean — Only restaurants publishing infection-control information (default: false)
• has_coupon boolean — Only restaurants with coupons (default: false)
• count integer required — Max number of results to return (min: 1)

Response

• @type string (default: "HotpepperSearchCard")
• id string required
• url string required
• name string nullable
• image string nullable
• genre string nullable
• area string nullable
• catch_copy string nullable
• keywords string nullable
• access string nullable
• budget_dinner string nullable
• budget_lunch string nullable
• coupons array (default: [])

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.