/canadabuys/tenders

POST /api/canadabuys/tenders

Price: 15 credits

Get one CanadaBuys record by its reference or URL — a tender notice, an award notice or a contract history entry: title and description, status, solicitation and contract numbers, publication, closing, award, amendment and expiry dates, contract duration, procurement method, selection criteria, reason for limited tendering, delivery regions, trade agreements, UNSPSC and GSIN codes, languages, the contracting and buying organizations with addresses, the contracting authority's name, email, phone and its own postal address, the supplier with its standardized name and employee count, the amendment and total contract values, the attached documents and the third-party URL of an externally sourced notice.

How to use it

A row id from canadabuys/tenders/search, canadabuys/awards/search or canadabuys/contracts/search resolves here; pass notice_kind alongside a bare reference so the right register is read, or pass the row URL and it is taken from there. Which fields are filled depends on the register: a tender notice carries the closing date and documents, an award or contract history entry carries the supplier and the values.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• notice string required — Notice reference or notice URL (examples: "cb-139-55001085", "https://canadabuys.canada.ca/en/tender-opportunities/tender-notice/cb-139-55001085", "https://canadabuys.canada.ca/en/tender-opportunities/award-notice/31184-180420001cal"; minLength: 1)
• notice_kind string nullable — Which register the reference belongs to, when it is passed without its URL (one of: "tender", "award", "contract_history")

Response

• @type string (default: "CanadabuysNotice")
• id string required
• notice_kind string required (one of: "tender", "award", "contract_history")
• description string nullable
• status string nullable
• solicitation_number string nullable
• contract_number string nullable
• notice_type string nullable
• contract_instrument_type string nullable
• amendment_type string nullable
• published_at integer nullable
• closing_at integer nullable
• awarded_at integer nullable
• amended_at integer nullable
• expires_at integer nullable
• contract_duration string nullable
• procurement_method string nullable
• selection_criteria string nullable
• limited_tendering_reason string nullable
• delivery_regions array (default: [])
• region_of_opportunity array (default: [])
• trade_agreements array (default: [])
• unspsc array (default: [])
• gsin array (default: [])
• languages array (default: [])
• buyer object nullable
  • @type string (default: "CanadabuysOrganization")
  • name string nullable
  • address string nullable
• end_user_organizations array (default: [])
  • @type string (default: "CanadabuysOrganization")
  • name string nullable
  • address string nullable
• contact_name string nullable
• contact_email string nullable
• contact_phone string nullable
• contact_address string nullable
• supplier object nullable
  • @type string (default: "CanadabuysOrganization")
  • name string nullable
  • address string nullable
• supplier_standardized_name string nullable
• supplier_operating_name string nullable
• supplier_employees integer nullable
• amendment_value object nullable
  • @type string (default: "CanadabuysValue")
  • amount number nullable
  • currency string nullable
• total_contract_value object nullable
  • @type string (default: "CanadabuysValue")
  • amount number nullable
  • currency string nullable
• documents array (default: [])
  • @type string (default: "CanadabuysDocument")
  • url string nullable
  • amendment_number string nullable
  • language string nullable
  • downloads integer nullable
  • added_at integer nullable
• country string (default: "CA")
• external_notice_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 — No notice with this reference on CanadaBuys 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.