/estat/indicator-values/search

POST /api/estat/indicator-values/search

Price: 20 credits

Get the values of prefecture-level indicators from e-Stat's System of Social and Demographic Statistics (Government of Japan) by indicator, area and survey year: indicator code, name and unit, area code and name, survey year and value

How to use it

Indicator codes come from estat/indicators/search; area 00000 is All Japan and prefectures are their JIS code followed by 000 (13000 Tokyo). value_text carries the table's own marker when a cell holds no number.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• indicators array required — Indicator codes (examples: ["A1101","A110101"]; minItems: 1; maxItems: 50)
• areas array nullable — Area codes; All Japan and the 47 prefectures when omitted (examples: ["00000","13000"])
• start_year integer nullable — Earliest survey year (examples: 2015; min: 1900)
• end_year integer nullable — Latest survey year (examples: 2024; min: 1900)
• count integer required — Max number of results (min: 1; max: 20000)

Response

• @type string (default: "EstatIndicatorValue")
• indicator_code string required
• indicator_name string nullable
• unit string nullable
• area_code string required
• area_name string nullable
• year integer nullable
• time_code string required
• value number nullable
• value_text string nullable

Errors

• 422 — An indicator or area code is unknown or malformed, or start_year is after end_year 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.