/estat/observations/search

POST /api/estat/observations/search

Price: 20 credits

Get the values of one e-Stat statistical table (Government of Japan statistics) as observations: each cell's number, its unit, and the code and name of every dimension item it belongs to, optionally restricted to chosen item codes per dimension

How to use it

Dimension ids and item codes come from estat/tables. Without filters the table is walked from its first items; filter the time and area dimensions to get a specific slice. Columns with no data in the requested rows are not returned. 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)
• table string required — Statistical table ID or DB view URL (examples: "0003427113", "https://www.e-stat.go.jp/en/dbview?sid=0003427113")
• filters object nullable — Item codes to keep, keyed by dimension id (examples: {"1":["00000"],"2":["2026000808"]})
  • * array
• count integer required — Max number of results (min: 1; max: 20000)

Response

• @type string (default: "EstatObservation")
• table_id string required
• value number nullable
• value_text string nullable
• unit string nullable
• dimensions array (default: [])
  • @type string (default: "EstatObservationDimension")
  • dimension_id string required
  • dimension string required
  • code string required
  • name string required

Errors

• 422 — A filter names a dimension id or item code the table does not have 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 statistical table 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.