/estat/tables/search

POST /api/estat/tables/search

Price: 10 credits

Search the statistical tables (datasets) of e-Stat, the Government of Japan's statistics portal, by keywords, statistics, dataset category, theme, organization, frequency and tabulation area: table ID, title, table number, statistics name, dataset category, survey period and update date

How to use it

Pass a table id to estat/tables for its dimensions and to estat/observations/search for its values. Statistics codes and dataset category IDs come from estat/statistics/search and estat/statistics.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• query string nullable — Keywords (examples: "consumer price index", "population census"; minLength: 1)
• statistics_code string nullable — Statistics code (examples: "00200573")
• dataset_category string nullable — Dataset category ID (examples: "000001150147")
• theme string nullable — Theme (major classification) (one of: "population_and_households", "labor_and_wages", "agriculture_forestry_and_fisheries", "mining_and_manufacturing", "domestic_trade_and_services", "business_household_economy", "housing_estate_and_construction", "energy_and_water", "transport_and_sightseeing", "information_communication_science_and_technology", "education_culture_sports_and_life", "administration_and_public_finance", "justice_security_and_environment", "social_security_and_sanitation", "international", "others"; examples: "population_and_households")
• organization string nullable — Organization code (examples: "00200", "00450")
• frequency string nullable — Release frequency (one of: "monthly", "quarterly", "yearly", "fiscal_yearly"; examples: "monthly")
• tabulation_area string nullable — Geographic level the table is tabulated at (one of: "nationwide", "prefectures", "municipalities"; examples: "prefectures")
• count integer required — Max number of results (min: 1; max: 2500)

Response

• @type string (default: "EstatTableSummary")
• id string required
• url string required
• table_number string nullable
• table_category string nullable
• statistics_name string nullable
• dataset_category string nullable
• survey_period string nullable
• updated_date integer nullable

Errors

• 422 — statistics_code, dataset_category or organization is not in e-Stat's code format 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.