/ekiten/shops

POST /api/ekiten/shops

Price: 5 credits

Get a shop profile from Ekiten (エキテン): name, reading, business type, genres, rating, review and photo counts, phone, address, coordinates, access, nearest stations and bus stops, weekly business hours, parking, payment, credit cards, official links and features

How to use it

Shop ids come from ekiten/shops/search. Reviews, photos and menus are ekiten/shops/reviews, ekiten/shops/photos and ekiten/shops/menus.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• shop string required — Ekiten shop id or shop URL (examples: "7084758", "https://www.ekiten.jp/shop_7084758/"; minLength: 1)

Response

• @type string (default: "EkitenShop")
• id string required
• url string required
• name string nullable
• name_kana string nullable
• business_type 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
• phone string nullable
• address string nullable
• postal_code string nullable
• prefecture string nullable
• city string nullable
• street_address string nullable
• latitude number nullable
• longitude number nullable
• access string nullable
• nearest_stations array (default: [])
  • @type string (default: "EkitenStation")
  • name string required
  • id string nullable
  • distance_m integer nullable
  • walk_minutes integer nullable
• bus_stops array (default: [])
• business_hours array (default: [])
  • @type string (default: "EkitenHours")
  • day string required
  • hours string nullable
• today_hours string nullable
• parking string nullable
• payment string nullable
• credit_cards array (default: [])
• links array (default: [])
  • @type string (default: "EkitenLink")
  • url string required
  • label string nullable
• features array (default: [])
  • @type string (default: "EkitenFeature")
  • id string required
  • name string nullable
• image string nullable
• published_date integer nullable
• updated_date integer nullable
• other_details array (default: [])
  • @type string (default: "EkitenDetail")
  • label string required
  • text string required

Errors

• 422 — shop is not an Ekiten shop 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 Ekiten shop 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.