/philgeps/awards

POST /api/philgeps/awards

Price: 1 credit

One Philippine government contract award notice from PhilGEPS (notices.philgeps.gov.ph) by award id and bid notice reference number: contract title and amount, award status and reason, award, publish, proceed and contract dates, contract number, funding source, UNSPSC code, the winning suppliers with address and contact, bidders, the awarded line item, the procuring entity, and the source tender with its approved budget and procurement mode. An award whose bidders, reasons or status codes could not be read is served without them and marked by an X-Warning header.

How to use it

Takes an award id with the reference number of its bid notice, or the award notice page URL alone. One bid notice can have one award per line item, so the same `tender_id` recurs across awards.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• award_id string required — Award id or award notice page URL (examples: "6249175", "https://notices.philgeps.gov.ph/GEPSNONPILOT/R4/R3_AwardNotice_AwardAbstract.html?RefID=12612768&LineItemID=21&OrgID=117744&AwardID=6249175"; minLength: 1)
• tender_id string nullable — Reference number of the bid notice the award belongs to (examples: "12612768")

Response

• @type string (default: "PhilgepsAward")
• id string required
• tender_id string required
• line_item_id string nullable
• name string nullable
• award_type string nullable
• type_code string nullable
• status string nullable
• status_id string nullable
• classification_code string nullable
• amount number nullable
• currency string (default: "PHP")
• previous_award_id string nullable
• previous_amount number nullable
• awarded_date string nullable
• published_date string nullable
• updated_date string nullable
• closing_date string nullable
• contract_number string nullable
• proceed_date string nullable
• contract_start_date string nullable
• contract_end_date string nullable
• has_notice_to_proceed boolean nullable
• is_updated boolean nullable
• funding_source string nullable
• funding_source_id string nullable
• procurement_mode_id string nullable
• unspsc_code string nullable
• unspsc_description string nullable
• bidder_count integer nullable
• document_count integer nullable
• line_item_count integer nullable
• award_reason string nullable
• cancellation_reason string nullable
• disapproval_reason string nullable
• created_by string nullable
• created_date string nullable
• approver string nullable
• tender object nullable
  • @type string (default: "PhilgepsAwardTender")
  • id string nullable
  • reference string nullable
  • name string nullable
  • approved_budget number nullable
  • procurement_mode string nullable
  • procurement_rules string nullable
  • classification string nullable
  • category string nullable
  • funding_source string nullable
  • funding_instrument string nullable
  • delivery_area string nullable
  • contract_duration string nullable
  • contact_person string nullable
  • created_by string nullable
  • alternative_mode_condition string nullable
  • url string nullable
• buyer object nullable
  • @type string (default: "PhilgepsAwardBuyer")
  • id string nullable
  • name string nullable
  • address string nullable
• suppliers array (default: [])
  • @type string (default: "PhilgepsAwardSupplier")
  • name string nullable
  • address string nullable
  • contact_person string nullable
  • designation string nullable
• bidders array (default: [])
  • @type string (default: "PhilgepsBidder")
  • id string nullable
  • name string nullable
  • city string nullable
  • rank integer nullable
• line_item object nullable
  • @type string (default: "PhilgepsAwardLineItem")
  • id string nullable
  • unspsc_code string nullable
  • unspsc_description string nullable
  • name string nullable
  • description string nullable
  • quantity number nullable
  • unit string nullable
  • unit_id string nullable
  • budget number nullable
• country string (default: "PH")
• 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 award notice under that award id and reference 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.