/ppra/contracts/search

POST /api/ppra/contracts/search

Price: 20 credits

Search awarded federal contracts published on Pakistan's PPRA e-Publish system by keyword, contract number, reference, originating tender number, procuring organisation, contract value range, revised or original status and advertisement date range. Each row carries the contract number and reference, tender number, ministry, title, winning bidder and address, nature, office, city, contract value and value band, advertisement date and the contract document link.

How to use it

Pass a tender number as `tender_no` to list every contract one tender produced. Pass a row's `id` to ppra/contracts for signing date, bids received, tender value and beneficial owners.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• keyword string nullable — Words to search for (examples: "vehicles"; minLength: 1)
• contract_no string nullable — PPRA contract number (examples: "PCN-1288294793"; minLength: 1)
• reference string nullable — Contract reference number (examples: "TS0000010130E-15"; minLength: 1)
• tender_no string nullable — PPRA tender number the contract came from (examples: "TS0000010130E"; minLength: 1)
• organization string nullable — Organisation name as listed in a row's organization field (examples: "Federal Shariat Court"; minLength: 1)
• value_min integer nullable — Lowest contract value in PKR (min: 0)
• value_max integer nullable — Highest contract value in PKR (min: 0)
• is_revised boolean nullable — Revised contracts only, or original ones only
• advertised_from string nullable — Earliest advertisement date (format: date)
• advertised_to string nullable — Latest advertisement date (format: date)
• count integer required — Max number of results (min: 1; max: 1000)

Response

• @type string (default: "PpraContractSummary")
• id string required
• reference string nullable
• tender_id string nullable
• organization string nullable
• name string nullable
• supplier_name string nullable
• supplier_address string nullable
• tender_nature string nullable
• buyer_name string nullable
• city string nullable
• contract_value number nullable
• value_band string nullable
• advertised_date string nullable
• document_url string nullable
• url string required

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.