/yogiyo/restaurants/search

POST /api/yogiyo/restaurants/search

Price: 10 credits

List Yogiyo (요기요) restaurants that deliver to a point, optionally by keyword and category and in a chosen order: one row per restaurant with rating and review counts, distance, open status, delivery fee tiers, estimated delivery time, discounts and representative menus

How to use it

Take the delivery point from yogiyo/addresses/search. Pass a returned id to yogiyo/restaurants, yogiyo/restaurants/menu or yogiyo/restaurants/reviews. Money is in KRW.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• latitude number required — Latitude of the delivery address (min: 33; max: 39)
• longitude number required — Longitude of the delivery address (min: 124; max: 132)
• keyword string nullable — Restaurant name, brand or dish to look for among the restaurants that deliver to the point (examples: "치킨", "bhc")
• category string nullable — Food category (one of: "one_dish", "franchise", "chicken", "pizza", "chinese_dish", "korean_dish", "japanese_dish", "pig_trotter", "late_night_snack", "korean_snack", "cafe_dessert")
• sort string — Result order (default: "recommended"; one of: "recommended", "rating", "review_count", "delivery_fee", "distance", "delivery_time")
• count integer required — Max number of restaurants to return (min: 1; max: 1000)

Response

• @type string (default: "YogiyoRestaurantCard")
• id string required
• url string required
• name string nullable
• franchise_id string nullable
• franchise_name string nullable
• categories array (default: [])
• tags array (default: [])
• latitude number nullable
• longitude number nullable
• distance_m number nullable
• thumbnail string nullable
• logo_image string nullable
• images array (default: [])
• open_status string nullable
• next_open_status string nullable
• next_open_status_at integer nullable
• is_delivery_available boolean nullable
• rating number nullable
• review_count integer nullable
• review_image_count integer nullable
• review_reply_count integer nullable
• exposure_type string nullable
• vertical_type string nullable
• serving_priority array (default: [])
• serving_options array (default: [])
  • @type string (default: "YogiyoServing")
  • serving_type string required
  • available boolean nullable
  • status string nullable
  • delivery_fee number nullable
  • delivery_fee_tiers array (default: [])
    • @type string (default: "YogiyoFeeTier")
    • order_amount number nullable
    • delivery_fee number nullable
  • delivery_fee_surcharge number nullable
  • delivery_fee_funding number nullable
  • delivery_minutes_min integer nullable
  • delivery_minutes_max integer nullable
  • pickup_minutes_min integer nullable
  • payment_methods array (default: [])
  • coupon object nullable
    • @type string (default: "YogiyoCoupon")
    • mode string nullable
    • amount number nullable
    • rate_percent number nullable
    • maximum_amount number nullable
    • minimum_order_amount number nullable
    • payment_restriction string nullable
  • additional_discount_amount number nullable
  • additional_discount_minimum_order number nullable
  • additional_discount_members_only boolean nullable
  • additional_discount_specific_menu_only boolean nullable
  • shop_discount_percent number nullable
  • membership_point_percent number nullable
• representative_menus array (default: [])
  • @type string (default: "YogiyoRepresentativeMenu")
  • id string nullable
  • name string nullable
  • price number nullable
  • image_path string nullable
  • is_popular boolean nullable
• minimum_order_amount number nullable
• promotion_texts array (default: [])
• is_new boolean nullable
• has_shop_coupons boolean nullable
• status_message string nullable

Errors

• 422 — Yogiyo does not serve that location 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.