/kanpo/notices/search

POST /api/kanpo/notices/search

Price: 20 credits

Search notice titles in the tables of contents of Japan's official gazette (官報) across publication dates, newest first, by title text, heading and issue type: title, section, subsection, category, issuing body, notice reference, page and page links, with the issue's id, date, type and number

How to use it

With keyword, section or only special_extra issue types and no date_from, the latest 183 days are searched. Catalogue (目録) issues list no notices. Court notices (裁判所), company notices (会社その他) and financial statements (会社決算公告) are one entry per issue covering many pages; pass issue_id and page to kanpo/pages for the page 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"])
• keyword string nullable — Text the notice title contains (examples: "解散", "入札"; minLength: 1)
• section string nullable — Table-of-contents heading the notice sits under, at any level (examples: "公告", "人事異動", "入札公告"; minLength: 1)
• count integer required — Max number of results (min: 1; max: 5000)

Response

• @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 — date_from is after date_to, or a keyword, section or special_extra-only search spans more than 183 days 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.