/estat/tables

POST /api/estat/tables

Price: 20 credits

Get one statistical table of e-Stat, the Government of Japan's statistics portal, by table ID: title, statistics, dataset category, theme, publisher and contacts, publication date, cell count, and every dimension of the table with all of its item codes, names, hierarchy levels and units

How to use it

Table IDs come from estat/tables/search. Dimension ids and item codes are the keys of the filters parameter of estat/observations/search.

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")

Response

• @type string (default: "EstatTable")
• id string required
• url string required
• table_number string nullable
• overview string nullable
• statistics_code string nullable
• statistics_name string nullable
• dataset_categories array (default: [])
  • @type string (default: "EstatDatasetCategory")
  • id string nullable
  • name string required
• theme string nullable
• theme_code string nullable
• sub_theme string nullable
• sub_theme_code string nullable
• organization string nullable
• organization_code string nullable
• email string nullable
• phone string nullable
• statistics_url string nullable
• statistical_type string nullable
• survey_period string nullable
• frequency string nullable
• tabulation_areas array (default: [])
• table_categories array (default: [])
• cell_count integer nullable
• published_at integer nullable
• dimensions array (default: [])
  • @type string (default: "EstatDimension")
  • id string required
  • name string required
  • kind string nullable
  • dimension_type string nullable
  • position string required
  • item_count integer required
  • members array (default: [])
    • @type string (default: "EstatDimensionItem")
    • code string required
    • name string required
    • level string nullable
    • parent_code string nullable
    • unit string nullable
    • explanation string nullable

Errors

• 422 — table is not a 10-digit table ID or DB view 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 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.