/boamp/tenders

POST /api/boamp/tenders

Price: 20 credits

Get one BOAMP notice by its id or URL: title, description, nature, family, procedure and legal framework, buyer with SIRET, address and contact, CPV codes, estimated and awarded values, duration, lots, awards with winners, amounts and tender counts, correction or cancellation text, linked and previous notices, and the whole structured notice body.

How to use it

Pass the id of a boamp/tenders/search row such as 26-91184. awards lists each winner per lot with the amount; notice holds the complete notice as published, where a selected option tag carries true, and its layout follows the notice family and year. related_notice_ids and previous_notices link a correction or award to its original call for tenders; links out of notices from 2019 on resolve here by their own id, while links out of the oldest awards and corrections (2014-2015) point at 14-… ids that answer 412.

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: "26-91184", "https://www.boamp.fr/pages/avis/?q=idweb:26-91184"; minLength: 1)

Response

• @type string (default: "BoampTender")
• id string required
• contract_folder_id string nullable
• family string nullable
• family_label string nullable
• stage string nullable
• nature string nullable
• nature_label string nullable
• sub_nature string nullable
• sub_nature_label string nullable
• nature_category string nullable
• nature_category_label string nullable
• state string nullable
• perimeter string nullable
• procedure_type string nullable
• procedure_subtype string nullable
• procedure_label string nullable
• procedure_category string nullable
• buyer object nullable
  • @type string (default: "BoampOrganisation")
  • id string nullable
  • name string nullable
  • national_id string nullable
  • department string nullable
  • street string nullable
  • city string nullable
  • postcode string nullable
  • nuts string nullable
  • country string nullable
  • contact_name string nullable
  • email string nullable
  • phone string nullable
  • fax string nullable
  • website_url string nullable
  • buyer_profile_url string nullable
  • size string nullable
• suppliers array (default: [])
  • @type string (default: "BoampOrganisation")
  • id string nullable
  • name string nullable
  • national_id string nullable
  • department string nullable
  • street string nullable
  • city string nullable
  • postcode string nullable
  • nuts string nullable
  • country string nullable
  • contact_name string nullable
  • email string nullable
  • phone string nullable
  • fax string nullable
  • website_url string nullable
  • buyer_profile_url string nullable
  • size string nullable
• contract_types array (default: [])
• contract_type_labels array (default: [])
• departments array (default: [])
• performance_department string nullable
• descriptors array (default: [])
  • @type string (default: "BoampDescriptor")
  • code string nullable
  • label string nullable
• criteria array (default: [])
• notice_type_codes array (default: [])
• simplified_procedure string nullable
• simplified_procedure_label string nullable
• related_notice_ids array (default: [])
• previous_notices array (default: [])
  • @type string (default: "BoampPreviousNotice")
  • id string nullable
  • family string nullable
  • perimeter string nullable
  • nature string nullable
  • sub_nature string nullable
  • status string nullable
  • sent_date string nullable
  • published_date string nullable
  • ojeu_notice_number string nullable
  • ojeu_issue_number string nullable
  • ojeu_year string nullable
  • ojeu_published_date string nullable
• published_date string nullable
• display_end_date string nullable
• deadline_at integer nullable
• schema_version string nullable
• country string (default: "FR")
• url string required
• description string nullable
• cpv string nullable
• cpv_additional array (default: [])
• contract_nature string nullable
• value object nullable
  • @type string (default: "BoampValue")
  • amount number nullable
  • currency string nullable
• awarded_value object nullable
  • @type string (default: "BoampValue")
  • amount number nullable
  • currency string nullable
• duration_months integer nullable
• organisations array (default: [])
  • @type string (default: "BoampOrganisation")
  • id string nullable
  • name string nullable
  • national_id string nullable
  • department string nullable
  • street string nullable
  • city string nullable
  • postcode string nullable
  • nuts string nullable
  • country string nullable
  • contact_name string nullable
  • email string nullable
  • phone string nullable
  • fax string nullable
  • website_url string nullable
  • buyer_profile_url string nullable
  • size string nullable
• lots array (default: [])
  • @type string (default: "BoampLot")
  • id string nullable
  • description string nullable
  • cpv string nullable
  • cpv_additional array (default: [])
  • value object nullable
    • @type string (default: "BoampValue")
    • amount number nullable
    • currency string nullable
  • duration_months integer nullable
  • start_date string nullable
  • end_date string nullable
  • place string nullable
  • nuts string nullable
  • deadline_at integer nullable
• awards array (default: [])
  • @type string (default: "BoampAward")
  • lot_id string nullable
  • supplier object nullable
    • @type string (default: "BoampOrganisation")
    • id string nullable
    • name string nullable
    • national_id string nullable
    • department string nullable
    • street string nullable
    • city string nullable
    • postcode string nullable
    • nuts string nullable
    • country string nullable
    • contact_name string nullable
    • email string nullable
    • phone string nullable
    • fax string nullable
    • website_url string nullable
    • buyer_profile_url string nullable
    • size string nullable
  • suppliers array (default: [])
    • @type string (default: "BoampOrganisation")
    • id string nullable
    • name string nullable
    • national_id string nullable
    • department string nullable
    • street string nullable
    • city string nullable
    • postcode string nullable
    • nuts string nullable
    • country string nullable
    • contact_name string nullable
    • email string nullable
    • phone string nullable
    • fax string nullable
    • website_url string nullable
    • buyer_profile_url string nullable
    • size string nullable
  • value object nullable
    • @type string (default: "BoampValue")
    • amount number nullable
    • currency string nullable
  • award_date string nullable
  • contract_date string nullable
  • contract_id string nullable
  • tenders_count integer nullable
  • is_unsuccessful boolean nullable
• change_description string nullable
• award_description string nullable
• award_criteria string nullable
• previous_notice_id string nullable
• notice_type_code string nullable
• eforms_version string nullable
• html_file string nullable
• notice object 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 — No BOAMP notice with this identifier 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.