/jalan/areas

POST /api/jalan/areas

Price: 1 credit

Browse the Jalan (じゃらん) area taxonomy used to scope hotel/ryokan searches: prefectures, their large areas (大エリア) and small areas (小エリア), each with its area code, name and canonical URL. Call without arguments to list all 47 prefectures; pass a prefecture to list its large areas; pass a prefecture and large area to list its small areas.

How to use it

Navigate the Jalan (じゃらん) Japanese hotel area taxonomy. With no arguments returns all 47 prefectures (level=prefecture). With prefecture (code like '130000' or name like '東京都') returns that prefecture's large areas (level=large_area). With prefecture + large_area (code like '137100') returns its small areas (level=small_area). Each item has id (area code), name, level, url, and parent prefecture_id/prefecture_name (and large_area_id/large_area_name for small areas). Use the codes to scope hotel searches.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• prefecture string nullable — Prefecture to list large areas for, by Jalan prefecture code (e.g. 130000), Japanese name (e.g. 東京都) or area URL. Omit to list all 47 prefectures. (examples: "130000", "東京都")
• large_area string nullable — Large area to list small areas for, by Jalan large-area code (e.g. 137100). Requires prefecture. Omit to list the prefecture's large areas. (examples: "137100")

Response

• @type string (default: "JalanArea")
• id string required
• name string required
• level string required (one of: "prefecture", "large_area", "small_area")
• url string required
• prefecture_id string nullable
• prefecture_name string nullable
• large_area_id string nullable
• large_area_name string 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 — Area not found (well-formed code but the prefecture/large area does not exist on Jalan) 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.