/kanpo/issues/search

POST /api/kanpo/issues/search

Price: 20 credits

List Japan's official gazette (官報) issues by publication date, newest first: issue id, date, type (本紙, 号外, 政府調達, 特別号外, 目録), issue number, page range, whole-issue PDF link and size

How to use it

Issues published before 2023-12-22 come without a page range or whole-issue PDF. Pass an issue id to kanpo/issues for its table of contents, or to kanpo/pages with a page number for that page's text.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• date_from integer nullable — Earliest issue date, unix seconds (examples: 1782831600; min: 0)
• date_to integer nullable — Latest issue date, unix seconds (examples: 1790694000; min: 0)
• issue_types array nullable — Gazette issue types (one of: "main", "extra", "government_procurement", "special_extra", "catalogue"; examples: ["main","extra"])
• count integer required — Max number of results (min: 1; max: 10000)

Response

• @type string (default: "KanpoIssue")
• id string required
• url string required
• issued_at integer required
• issue_type string required (one of: "main", "extra", "government_procurement", "special_extra", "catalogue")
• issue_type_label string required
• number integer required
• is_archived boolean required
• first_page integer nullable
• last_page integer nullable
• page_count integer nullable
• pdf_url string nullable
• pdf_size_mb integer nullable

Errors

• 422 — date_from is after date_to 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.