/jpportal/awards/search

POST /api/jpportal/awards/search

Price: 20 credits

Search Japanese national government award records for one fiscal year by procurement name, case number, winning business name or corporate number, organisation code, method code, award date window and amount range. Each record is the case number and name, award date and amount, the method and organisation codes, and the winning business with its corporate number.

How to use it

One call covers one fiscal year, April to March, newest award first. A case awarded to several businesses has one record per winner. `procurement_number` is the filter of the same name on jpportal/tenders/search, and `winner_corporate_number` is the id jpportal/suppliers takes.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• fiscal_year integer required — Japanese fiscal year the awards fall in, April to March (examples: 2025)
• keyword string nullable — Words in the procurement name (examples: "マスク"; minLength: 1)
• procurement_number string nullable — Procurement case number (examples: "0000000000000536939"; minLength: 1)
• winner_name string nullable — Words in the winning business name (examples: "綜合警備保障"; minLength: 1)
• winner_corporate_number string nullable — Winning business corporate number (examples: "7340001000891"; minLength: 1)
• org_code string nullable — Organisation code (examples: "8002010"; minLength: 1)
• method_code string nullable — Procurement method code (examples: "S1"; minLength: 1)
• awarded_from string nullable — Earliest award date (format: date; examples: "2025-10-01")
• awarded_to string nullable — Latest award date (format: date; examples: "2025-10-31")
• min_amount number nullable — Lowest award amount in JPY (examples: 1000000; min: 0)
• max_amount number nullable — Highest award amount in JPY (examples: 5000000; min: 0)
• count integer required — Max number of awards to return (min: 1; max: 5000)

Response

• @type string (default: "JpportalAward")
• id string required
• procurement_number string required
• awarded_date string nullable
• amount number nullable
• currency string nullable
• method_code string nullable
• org_code string nullable
• winner_name string nullable
• winner_corporate_number string nullable

Errors

• 422 — The request body did not validate 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.