/hotpepper/restaurants

POST /api/hotpepper/restaurants

Price: 5 credits

Get full Hot Pepper Gourmet (ホットペッパーグルメ) restaurant details by id (strJ{id} or J{id}, or restaurant URL): name, address, geo, telephone, genres, area, nearest station, access directions, rating, review/course/coupon counts, dinner/lunch budgets, opening hours, closed days, net reservation, point and smart payment, accepted cards/e-money/QR payments, smoking policy, seats and banquet capacity, private room/tatami/counter/terrace/charter/parking/Wi-Fi amenities, all-you-can-drink/eat, drink features, visit scenes and remarks.

How to use it

Fetch a single Hot Pepper Gourmet (ホットペッパーグルメ) restaurant by id ('J003433499' or 'strJ003433499') or a full restaurant URL. Returns name, catch_copy, address (street/locality/region/country), latitude/longitude, telephone, genres, area, nearest_station, access, rating, review_count, course_count, coupon_count, budget_dinner/budget_lunch, budget_note, open_hours, closed_days, is_net_reservable, point_use, smart_pay, credit_cards, e_money, qr_payments, smoking, total_seats, max_banquet_capacity, amenity flags (has_private_room/has_tatami/has_counter/has_terrace/has_charter/has_wifi/has_parking/...), has_all_you_can_drink/eat, drink_features, kids_friendly, celebration_ok, shop_features, remarks and visit scenes (name + percentage).

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• restaurant string required — Hot Pepper restaurant id (strJ{id} or J{id}) or a full restaurant URL (examples: "J003433499", "strJ003433499", "https://www.hotpepper.jp/strJ003433499/"; minLength: 1)

Response

• @type string (default: "HotpepperRestaurant")
• id string required
• url string required
• name string nullable
• image string nullable
• catch_copy string nullable
• address object nullable
  • @type string (default: "HotpepperRestaurantAddress")
  • street string nullable
  • locality string nullable
  • region string nullable
  • country string nullable
• latitude number nullable
• longitude number nullable
• telephone string nullable
• genres array (default: [])
• area string nullable
• nearest_station string nullable
• access string nullable
• rating number nullable
• review_count integer nullable
• course_count integer nullable
• coupon_count integer nullable
• budget_dinner string nullable
• budget_lunch string nullable
• budget_note string nullable
• open_hours string nullable
• closed_days string nullable
• is_net_reservable boolean (default: false)
• point_use boolean nullable
• smart_pay boolean nullable
• credit_cards array (default: [])
• e_money array (default: [])
• qr_payments array (default: [])
• smoking string nullable
• total_seats integer nullable
• max_banquet_capacity integer nullable
• has_private_room boolean nullable
• has_tatami boolean nullable
• has_horigotatsu boolean nullable
• has_counter boolean nullable
• has_sofa boolean nullable
• has_terrace boolean nullable
• has_charter boolean nullable
• has_wifi boolean nullable
• has_barrier_free boolean nullable
• has_parking boolean nullable
• other_facilities array (default: [])
• has_all_you_can_drink boolean nullable
• has_all_you_can_eat boolean nullable
• drink_features array (default: [])
• kids_friendly string nullable
• celebration_ok boolean nullable
• shop_features string nullable
• remarks string nullable
• scenes array (default: [])
  • @type string (default: "HotpepperRestaurantScene")
  • name string required
  • percentage integer 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 — Restaurant not found (well-formed id but the restaurant page does not exist) 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.