/ppra/blacklist/search

POST /api/ppra/blacklist/search

Price: 10 credits

Search firms blacklisted from federal procurement in Pakistan, as published on the PPRA e-Publish system, currently blacklisted or de-listed, by keyword, firm name, PPRA or registry number, blacklisting agency, duration, earliest start and latest end date. Each row carries both numbers, the firm, the agency, the duration, the blacklisting period and status, the reasons, any remarks the record carries and the order document link where one is published.

How to use it

Set `scope` to delisted for firms whose blacklisting has been lifted, because the default lists only active ones. `end_date_to` leaves out rows that have no `end_date`, so do not use it to list everything up to a date.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• scope string — Firms blacklisted now, or firms de-listed since (default: "active"; one of: "active", "delisted")
• keyword string nullable — Words to search for (examples: "engineering"; minLength: 1)
• firm_name string nullable — Blacklisted firm name (examples: "Potentia"; minLength: 1)
• ppra_number string nullable — PPRA blacklisting number (examples: "BLK-396"; minLength: 1)
• registry_number string nullable — Blacklisting registry number (examples: "BLK-2026-000397"; minLength: 1)
• procurement_agency string nullable — Agency that blacklisted the firm (examples: "SSGC"; minLength: 1)
• duration string nullable — Blacklisting duration (examples: "Permanent", "2 Years"; minLength: 1)
• start_date_from string nullable — Earliest blacklisting start date (format: date)
• end_date_to string nullable — Latest blacklisting end date (format: date)
• count integer required — Max number of results (min: 1; max: 1000)

Response

• @type string (default: "PpraBlacklisting")
• id string required
• ppra_number string nullable
• firm_name string nullable
• buyer_name string nullable
• duration string nullable
• start_date string nullable
• end_date string nullable
• status string nullable
• reasons string nullable
• remarks string nullable
• document_url 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.