/contractsfinder/tenders

POST /api/contractsfinder/tenders

Price: 15 credits

Get one Contracts Finder notice by its id or URL: title and description, buyer, contracting contact with address, email and phone, notice kind, status, value range, publication, deadline, contract start and end dates, CPV codes with their descriptions, delivery location, procedure type, framework and extension flags, every award with its supplier, DUNS number, value and dates, the attachments and the published version history.

How to use it

Pass the id of a contractsfinder/tenders/search row or the notice URL. Awards and their suppliers live here, not in the search row, which carries only the first awarded supplier name. A Find a Tender ocid or notice id is a different register and is rejected as an invalid payload.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• tender string required — Notice id or notice URL (examples: "a20defc8-95bf-4f3c-9241-a0677f676953", "https://www.contractsfinder.service.gov.uk/notice/a20defc8-95bf-4f3c-9241-a0677f676953"; minLength: 1)

Response

• @type string (default: "ContractsfinderNotice")
• id string required
• parent_id string nullable
• parent_identifier string nullable
• link_reason string nullable
• notice_identifier string nullable
• version integer nullable
• description string nullable
• notice_type string nullable
• status string nullable
• stage string nullable
• buyer object nullable
  • @type string (default: "ContractsfinderPartyRef")
  • id string nullable
  • name string nullable
• suppliers array (default: [])
  • @type string (default: "ContractsfinderPartyRef")
  • id string nullable
  • name string nullable
• contact object nullable
  • @type string (default: "ContractsfinderContact")
  • name string nullable
  • email string nullable
  • telephone string nullable
  • url string nullable
• contact_address object nullable
  • @type string (default: "ContractsfinderAddress")
  • street string nullable
  • locality string nullable
  • region string nullable
  • postal_code string nullable
  • country_name string nullable
  • text string nullable
• value object nullable
  • @type string (default: "ContractsfinderValue")
  • amount number nullable
  • amount_min number nullable
  • amount_max number nullable
  • currency string nullable
• dates object nullable
  • @type string (default: "ContractsfinderSummaryDates")
  • published_at integer nullable
  • deadline_at integer nullable
  • awarded_at integer nullable
  • approach_market_at integer nullable
  • contract_start_at integer nullable
  • contract_end_at integer nullable
  • last_update_at integer nullable
• cpv array (default: [])
  • @type string (default: "ContractsfinderClassification")
  • scheme string nullable
  • code string nullable
  • description string nullable
  • parent_code string nullable
  • has_children boolean nullable
• cpv_description string nullable
• sector string nullable
• location object nullable
  • @type string (default: "ContractsfinderLocation")
  • postcode string nullable
  • region string nullable
  • region_text string nullable
  • latitude number nullable
  • longitude number nullable
  • is_nationwide boolean nullable
• procedure_type string nullable
• procedure_type_other string nullable
• procedure_accelerated_justification string nullable
• annex_d_option string nullable
• reason_contract_lawful string nullable
• contract_type string nullable
• is_framework_agreement boolean nullable
• is_extension_possible boolean nullable
• is_supply_chain boolean nullable
• is_sme_suitable boolean nullable
• is_vcse_suitable boolean nullable
• is_published boolean nullable
• is_pre_awarded boolean nullable
• spend_profile array (default: [])
  • @type string (default: "ContractsfinderSpendLine")
  • start_year integer nullable
  • budget number nullable
• awards array (default: [])
  • @type string (default: "ContractsfinderNoticeAward")
  • id string required
  • notice_id string nullable
  • award_guid string nullable
  • supplier object nullable
    • @type string (default: "ContractsfinderPartyRef")
    • id string nullable
    • name string nullable
  • supplier_address object nullable
    • @type string (default: "ContractsfinderAddress")
    • street string nullable
    • locality string nullable
    • region string nullable
    • postal_code string nullable
    • country_name string nullable
    • text string nullable
  • supplier_duns string nullable
  • supplier_contact object nullable
    • @type string (default: "ContractsfinderContact")
    • name string nullable
    • email string nullable
    • telephone string nullable
    • url string nullable
  • value object nullable
    • @type string (default: "ContractsfinderValue")
    • amount number nullable
    • amount_min number nullable
    • amount_max number nullable
    • currency string nullable
  • supplier_awarded_value object nullable
    • @type string (default: "ContractsfinderValue")
    • amount number nullable
    • amount_min number nullable
    • amount_max number nullable
    • currency string nullable
  • awarded_at integer nullable
  • contract_period object nullable
    • @type string (default: "ContractsfinderPeriod")
    • start_at integer nullable
    • end_at integer nullable
  • procedure_type string nullable
  • procedure_type_other string nullable
  • procedure_accelerated_justification string nullable
  • annex_d_option string nullable
  • reason_contract_lawful string nullable
  • reference string nullable
  • reference_type string nullable
  • is_supplier_sme boolean nullable
  • is_supplier_vcse boolean nullable
  • additional_details string nullable
• attachments array (default: [])
  • @type string (default: "ContractsfinderAttachment")
  • id string nullable
  • description string nullable
  • data_type string nullable
  • text string nullable
  • filename string nullable
  • media_type string nullable
  • url string nullable
  • award_guid string nullable
• versions array (default: [])
  • @type string (default: "ContractsfinderVersion")
  • id string nullable
  • version_number integer nullable
  • notice_type string nullable
  • notice_status string nullable
  • published_notice_id string nullable
  • changed_at integer nullable
  • is_visible_to_public boolean nullable
• withdrawn_at integer nullable
• withdrawn_reason string nullable
• created_at integer nullable
• updated_at integer nullable
• views integer nullable
• country string (default: "GB")
• url string required

Errors

• 422 — tender is not a Contracts Finder notice id or notice URL 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 identifier on Contracts Finder 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.