/ikyu/restaurants

POST /api/ikyu/restaurants

Price: 5 credits

Get a restaurant profile from Ikyu (一休.com レストラン): name, genre, area, address, coordinates, access, opening hours, holidays, seats, payment, charges, dress code, smoking, child and pet policy, lunch and dinner price ranges, diner rating with sub-scores, area rank, cancellation rules, tags, highlights and photos

How to use it

Restaurant ids come from ikyu/restaurants/search. Courses with prices are ikyu/restaurants/courses and diner reviews are ikyu/restaurants/reviews.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• restaurant string required — Ikyu restaurant id or restaurant URL (examples: "103903", "https://restaurant.ikyu.com/103903"; minLength: 1)

Response

• @type string (default: "IkyuRestaurant")
• id string required
• url string required
• name string nullable
• name_kana string nullable
• name_alt string nullable
• status string nullable
• genre string nullable
• genre_major string nullable
• genre_minor string nullable
• genre_minor_code string nullable
• area string nullable
• large_area string nullable
• medium_area string nullable
• small_area string nullable
• small_area_code string nullable
• large_area_code string nullable
• medium_area_code string nullable
• medium_area_key string nullable
• neighbourhoods array (default: [])
  • @type string (default: "IkyuNamedCode")
  • code string required
  • name string nullable
• nearby_spots array (default: [])
  • @type string (default: "IkyuNamedCode")
  • code string required
  • name string nullable
• address string nullable
• latitude number nullable
• longitude number nullable
• phone string nullable
• nearest_station string nullable
• nearest_station_distance_m integer nullable
• access array (default: [])
  • @type string (default: "IkyuRestaurantAccess")
  • line string nullable
  • station string nullable
  • note string nullable
• catchphrase string nullable
• introduction string nullable
• opening_hours string nullable
• opening_hours_notes string nullable
• regular_holidays string nullable
• seats string nullable
• payment_methods string nullable
• card_payment object nullable
  • @type string (default: "IkyuAvailabilityNote")
  • availability string nullable
  • note string nullable
• qr_payments array (default: [])
• service_charge string nullable
• table_charge string nullable
• dress_code string nullable
• parking object nullable
  • @type string (default: "IkyuAvailabilityNote")
  • availability string nullable
  • note string nullable
• smoking_policy string nullable
• smoking_note string nullable
• pets_allowed boolean nullable
• pets_note string nullable
• children_policy string nullable
• children_note string nullable
• children_age_limit string nullable
• children_chair_availability string nullable
• children_menu_availability string nullable
• children_seat_limit string nullable
• children_time_availability string nullable
• wheelchair_access string nullable
• notes string nullable
• hygiene_notes string nullable
• lunch_price object nullable
  • @type string (default: "IkyuPriceRange")
  • min integer nullable
  • max integer nullable
• dinner_price object nullable
  • @type string (default: "IkyuPriceRange")
  • min integer nullable
  • max integer nullable
• rating object nullable
  • @type string (default: "IkyuRestaurantRating")
  • average number nullable
  • count integer nullable
  • food number nullable
  • service number nullable
  • atmosphere number nullable
  • value_for_money number nullable
• area_rank integer nullable
• area_rank_total integer nullable
• area_rank_area string nullable
• is_casual boolean nullable
• is_supreme boolean nullable
• paypay_available boolean nullable
• points_available boolean nullable
• hotel_id string nullable
• hotel_name string nullable
• announcement_title string nullable
• announcement string nullable
• cancel_policy_note string nullable
• cancel_rules array (default: [])
  • @type string (default: "IkyuCancelRule")
  • days_before integer nullable
  • from_time string nullable
  • charge_rate integer nullable
  • charge_fee integer nullable
  • applies_to_visitor_decrease boolean nullable
• tags array (default: [])
  • @type string (default: "IkyuTag")
  • id string required
  • name string nullable
  • tag_type string nullable
• highlights array (default: [])
  • @type string (default: "IkyuHighlight")
  • text string nullable
  • image string nullable
  • image_caption string nullable
• coupons array (default: [])
  • @type string (default: "IkyuCoupon")
  • code string required
  • name string nullable
  • discount_amount integer nullable
  • minimum_reservation_amount integer nullable
  • reservable_from integer nullable
  • reservable_to integer nullable
  • visit_from integer nullable
  • visit_to integer nullable
  • usable_member_count integer nullable
• a_la_carte_menu array (default: [])
  • @type string (default: "IkyuMenuSection")
  • description string nullable
  • items array (default: [])
    • @type string (default: "IkyuMenuItem")
    • name string required
    • description string nullable
    • price integer nullable
    • is_recommended boolean nullable
• a_la_carte_menu_updated integer nullable
• drink_menu array (default: [])
  • @type string (default: "IkyuMenuSection")
  • description string nullable
  • items array (default: [])
    • @type string (default: "IkyuMenuItem")
    • name string required
    • description string nullable
    • price integer nullable
    • is_recommended boolean nullable
• drink_menu_updated integer nullable
• images array (default: [])
  • @type string (default: "IkyuImage")
  • url string required
  • caption string nullable
  • category string nullable
• nearby_restaurants array (default: [])
  • @type string (default: "IkyuNearbyRestaurant")
  • id string required
  • url string required
  • name string nullable
  • area string nullable
  • rating number nullable
  • review_count integer nullable

Errors

• 422 — restaurant is not an Ikyu restaurant id or URL 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 — No Ikyu restaurant under that id 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.