/ppra/contracts

POST /api/ppra/contracts

Price: 1 credit

One awarded federal contract from Pakistan's PPRA e-Publish system by contract number: title, description, remarks, procuring organisation and office with contacts, nature of purchase, signing date, procurement plan number, contract value and band, tender value, engineer's estimate, revision count, bids received, integrity pact and complaint flags, winning bidder with address and beneficial owners, the originating tender and publication dates.

How to use it

Pass a contract number from ppra/contracts/search; `tender_id` links back to ppra/tenders.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• id string required — PPRA contract number or contract URL (examples: "PCN-1288294793", "https://epms.ppra.gov.pk/public/contracts/contract-details/PCN-1288294793"; minLength: 1)

Response

• @type string (default: "PpraContract")
• id string required
• name string nullable
• description string nullable
• remarks string nullable
• organization string nullable
• buyer_name string nullable
• buyer_address string nullable
• city string nullable
• contact_email string nullable
• contact_phone string nullable
• tender_nature string nullable
• contract_signed_date string nullable
• procurement_plan_number string nullable
• contract_value number nullable
• value_band string nullable
• tender_value number nullable
• engineer_estimate number nullable
• revisions_count integer nullable
• bids_received_count integer nullable
• has_integrity_pact boolean nullable
• has_complaint boolean nullable
• supplier_name string nullable
• supplier_address string nullable
• beneficial_owners array (default: [])
  • @type string (default: "PpraOwner")
  • name string nullable
  • id_type string nullable
  • id_number string nullable
  • nationality string nullable
  • is_indirect boolean nullable
  • share number nullable
• tender_id string nullable
• tender_name string nullable
• advertised_date string nullable
• published_date string nullable
• published_at integer nullable
• currency string (default: "PKR")
• 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 — No contract under that number 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.