/ekiten/shops/search

POST /api/ekiten/shops/search

Price: 20 credits

Search shops on Ekiten (エキテン) by genre with a city or station, features and order, or by keyword: name, tags, rating, review and photo counts, genres, address, today's hours, features and photos

How to use it

Genre codes come from ekiten/genres, city codes and station ids from ekiten/areas, feature ids from ekiten/filters. Pass a returned id to ekiten/shops for the full profile.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• genre string nullable — Ekiten genre code from ekiten/genres (examples: "0612")
• city string nullable — Ekiten city code from ekiten/areas (examples: "27127")
• station string nullable — Ekiten station id from ekiten/areas (examples: "1482")
• keyword string nullable — Free-text keyword (examples: "整体"; minLength: 1)
• features array nullable — Feature ids from ekiten/filters; all must match (examples: ["12","13"])
• sort string — Result order (default: "recommended"; one of: "recommended", "highest_rated", "most_reviewed")
• count integer required — Max number of results (min: 1; max: 900)

Response

• @type string (default: "EkitenShopCard")
• id string required
• url string required
• name string nullable
• tags array (default: [])
• rating number nullable
• review_count integer nullable
• photo_count integer nullable
• genres array (default: [])
  • @type string (default: "EkitenGenre")
  • code string required
  • name string nullable
• address string nullable
• access string nullable
• today_hours string nullable
• price_range string nullable
• main_menus array (default: [])
  • @type string (default: "EkitenMainMenu")
  • category string nullable
  • name string nullable
  • price string nullable
• features array (default: [])
  • @type string (default: "EkitenFeature")
  • id string required
  • name string nullable
• image_urls 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 — Ekiten serves no shop list for this combination of filters 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.