/gurunavi/restaurants/search

POST /api/gurunavi/restaurants/search

Price: 20 credits

Search Gurunavi (楽天ぐるなび) restaurants by keyword, area, cuisine genre and こだわり filters (condition / usage scene / smoking / business hours), with optional budget range, private room, seat-reservable, reservation-type and coupon filters. Returns restaurant cards with name, category, dinner/lunch budgets, access, course plans, photos with metadata and promo flags.

How to use it

Search Gurunavi (楽天ぐるなび) restaurants. Provide at least one of keyword, genre, a こだわり filter (condition / usage_scene / smoking / business_hours — at most ONE, they share a single filter slot), coupon, or a specific area (slug like 'tokyo', 'osaka'; 'jp' = nationwide). Optional: budget_min/budget_max (JPY per person, dinner), private_room, seat_reservable, reservation (course_reserve/seat_reserve), coupon (regular/reserve/secret/takeout); sort by standard or point. Each result has id, url, name, name_sub, category, budget_dinner, budget_lunch, access, is_suspended, sanitary_measure_count, attractive_points, image, photos (image/type/summary/price/space_name) and courses (name/price/discount_price/dish_count).

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• keyword string nullable — Search keyword (examples: "焼肉", "寿司", "ラーメン")
• area string — Area slug to scope the search ('jp' for nationwide) (default: "jp"; examples: "jp", "tokyo", "osaka")
• genre string nullable — Cuisine genre filter (one of: "izakaya", "japanese", "sushi", "roastmeat", "western", "buffet", "curry", "chinese", "continental", "hotpots", "ethnic", "noodle", "beerandcuisine", "cafe", "entertainment", "casual", "others")
• condition string nullable — Facility / feature condition filter (one of: "private_room", "parking", "kids_ok", "pets_ok", "all_you_can_eat", "all_you_can_drink", "birthday_perk", "takeout", "night_view", "solo_friendly", "large_banquet")
• usage_scene string nullable — Usage occasion filter (one of: "girls_party", "date", "anniversary", "reunion", "welcome_party", "farewell_party", "celebration", "family", "daytime_business", "evening_business", "after_party", "group_date")
• smoking string nullable — Smoking policy filter (one of: "non_smoking", "smoking_allowed")
• business_hours string nullable — Business hours filter (one of: "open_24h", "sunday_open")
• coupon string nullable — Restrict to restaurants offering a coupon type (one of: "regular", "reserve", "secret", "takeout")
• budget_min integer nullable — Minimum per-person dinner budget (JPY) (min: 0)
• budget_max integer nullable — Maximum per-person dinner budget (JPY) (min: 0)
• private_room boolean — Only restaurants with a private room (default: false)
• seat_reservable boolean — Only restaurants that accept online seat reservations (default: false)
• reservation string nullable — Restrict to course-reservable or seat-reservable restaurants (one of: "course_reserve", "seat_reserve")
• sort string — Sort order (default: "standard"; one of: "standard", "point")
• count integer required — Max number of results to return (min: 1)

Response

• @type string (default: "GurunaviSearchCard")
• id string required
• url string required
• name string nullable
• name_sub string nullable
• category string nullable
• budget_dinner integer nullable
• budget_lunch integer nullable
• access string nullable
• is_suspended boolean nullable
• sanitary_measure_count integer nullable
• attractive_points array (default: [])
• image string nullable
• photos array (default: [])
  • @type string (default: "GurunaviCardPhoto")
  • image string required
  • type string nullable
  • summary string nullable
  • price string nullable
  • space_name string nullable
• courses array (default: [])
  • @type string (default: "GurunaviCardCourse")
  • id string nullable
  • name string nullable
  • price integer nullable
  • discount_price integer nullable
  • dish_count integer nullable
  • is_seat_only boolean 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.