/japan_customs/datasets/search

POST /api/japan_customs/datasets/search

Price: 5 credits

List the Japan Customs statistical tables published on e-Stat for one table family, direction and year, with the identifier each one is downloaded by

How to use it

Start here: the source publishes a file per slice, and the trades endpoint reads one file at a time, so a `dataset_id` from here is what it takes. A year is split into several files for the wide tables — Commodity by Country into 22 HS sections, Country by Commodity into regional groups — and into a single file for the narrow ones, and the title says which slice a file holds. The current year is published up to the latest closed month, so asking for it returns the year so far rather than nothing.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• table string required — Which published table to list. The name says what the rows are cut by, and the air_cargo_* and sea_container_cargo_* tables are the same cuts restricted to one transport mode (one of: "commodity_by_country", "values_by_commodity", "country_by_commodity", "values_by_country", "values_by_principal_commodity", "principal_commodity_by_country", "country_by_principal_commodity", "principal_commodity_by_commodity", "commodity_by_customs_by_country", "country_by_customs_by_commodity", "principal_commodity_by_customs_by_country", "country_by_customs_by_principal_commodity", "customs_by_commodity", "customs_by_commodity_by_country", "customs_by_principal_commodity", "customs_by_country_by_principal_commodity", "air_cargo_commodity_by_country", "air_cargo_by_commodity", "air_cargo_country_by_commodity", "air_cargo_values_by_country", "sea_container_cargo_commodity_by_country", "sea_container_cargo_by_commodity", "sea_container_cargo_country_by_commodity", "sea_container_cargo_values_by_country")
• direction string — Export or import; the source publishes them separately (default: "export"; one of: "export", "import")
• year integer required — Calendar year of the data. Half the tables are published from 1988 and the other half only from 2009, in both directions alike, so a year earlier than the chosen table's own first published year is rejected with a message naming it (examples: 2024, 2023; min: 1988)
• keyword string nullable — Keep only datasets whose title contains this text, matched case-insensitively (examples: "Section I", "East Asia"; minLength: 1)
• count integer required — Max number of datasets to return (min: 1)

Response

• @type string (default: "JapanCustomsDataset")
• dataset_id string required
• dataset_title string required
• table string required (one of: "commodity_by_country", "values_by_commodity", "country_by_commodity", "values_by_country", "values_by_principal_commodity", "principal_commodity_by_country", "country_by_principal_commodity", "principal_commodity_by_commodity", "commodity_by_customs_by_country", "country_by_customs_by_commodity", "principal_commodity_by_customs_by_country", "country_by_customs_by_principal_commodity", "customs_by_commodity", "customs_by_commodity_by_country", "customs_by_principal_commodity", "customs_by_country_by_principal_commodity", "air_cargo_commodity_by_country", "air_cargo_by_commodity", "air_cargo_country_by_commodity", "air_cargo_values_by_country", "sea_container_cargo_commodity_by_country", "sea_container_cargo_by_commodity", "sea_container_cargo_country_by_commodity", "sea_container_cargo_values_by_country")
• direction string required (one of: "export", "import")
• year integer required
• survey_date string nullable
• update_date string nullable
• url string nullable

Errors

• 422 — The chosen table does not go back to the requested year; the message names its first published 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.