/kanpo/issues

POST /api/kanpo/issues

Price: 5 credits

Get one issue of Japan's official gazette (官報) with its full table of contents: every notice title in order with its section, subsection, category, issuing body, notice reference, page number and page links

How to use it

Issue ids come from kanpo/issues/search. Issues published before 2023-12-22 list notices without url; a catalogue (目録) issue lists no notices. Pass issue and page to kanpo/pages for the text of a published page.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• issue string required — Kanpo issue id or issue URL (examples: "20261002h01800", "https://www.kanpo.go.jp/20261002/20261002h01800/20261002h018000000f.html"; minLength: 1)

Response

• @type string (default: "KanpoIssueRecord")
• 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
• page_count integer nullable
• pdf_url string nullable
• notices array (default: [])
  • @type string (default: "KanpoNotice")
  • id string required
  • issue_id string required
  • issued_at integer required
  • issue_type string required (one of: "main", "extra", "government_procurement", "special_extra", "catalogue")
  • issue_number integer required
  • position integer required
  • section string nullable
  • subsection string nullable
  • category string nullable
  • issuer string nullable
  • reference string nullable
  • page integer nullable
  • url string nullable
  • pdf_url string nullable

Errors

• 422 — issue is not a Kanpo issue id or 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 gazette issue 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.