/ghaneps/awards/search

POST /api/ghaneps/awards/search

Price: 5 credits

List the contracts awarded on the Ghana Electronic Procurement System (ghaneps.gov.gh), every procurement method included, sorted by award date, amount, tender, procuring entity or supplier. Returns one row per awarded lot and supplier: tender resource id and title, procuring entity, supplier name, award date, award amount with its currency, lot and notice PDF.

How to use it

The source offers no filter on this list, only ordering; sorting by `amount` descending puts the awards without an amount first. A tender awarded in lots returns one row per lot. Pass `tender_id` to ghaneps/tenders for the notice, where some awarded tenders answer 412, or to ghaneps/opened_bids for every bid. `tender_url` is not filled.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• sort string nullable — Field to order the awards by (one of: "awarded_at", "amount", "tender_name", "buyer_name", "supplier_name")
• order string — Direction of the sort (default: "desc"; one of: "desc", "asc")
• count integer required — Max number of awards to return (min: 1; max: 1000)

Response

• @type string (default: "GhanepsAward")
• tender_id string nullable
• tender_name string nullable
• buyer_name string nullable
• supplier_name string nullable
• awarded_at integer nullable
• amount number nullable
• currency string nullable
• lot_name string nullable
• notice_url string nullable
• tender_url string nullable
• country string (default: "GH")

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.