/samgov/opportunities/search

POST /api/samgov/opportunities/search

Price: 5 credits

Search U.S. federal contract opportunities by keyword

How to use it

Search U.S. federal contract opportunities (solicitations, presolicitations, sources sought, award notices, special notices) on SAM.gov by a full-text keyword. Returns a list projection of each opportunity — notice id, title, notice type, solicitation number, publish/modified/response dates, description snippets, the awarding organization hierarchy (department, agency, office), and award details when present. Use the returned notice id with the 'opportunities' endpoint for full details.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• query string required — Full-text search query matched against opportunity title and description (minLength: 1)
• count integer required — Number of opportunities to return (min: 1; max: 10000)
• is_active boolean — Restrict to currently active (open) opportunities (default: true)

Response

• @type string (default: "SamgovOpportunitySearchResult")
• notice_id string required
• type object nullable
  • @type string (default: "SamgovOpportunityType")
  • code string nullable
  • value string nullable
• solicitation_number string nullable
• parent_notice_id string nullable
• is_active boolean nullable
• is_canceled boolean nullable
• published_at string nullable
• modified_at string nullable
• response_at string nullable
• response_time_zone string nullable
• descriptions array (default: [])
• organization_hierarchy array (default: [])
  • @type string (default: "SamgovOrganizationNode")
  • organization_id string nullable
  • code string nullable
  • name string nullable
  • type string nullable
  • level integer nullable
  • status string nullable
  • location object nullable
    • @type string (default: "SamgovLocation")
    • street_address string nullable
    • street_address2 string nullable
    • city string nullable
    • state string nullable
    • zip string nullable
    • country string nullable
• award object nullable
  • @type string (default: "SamgovAward")
  • number string nullable
  • amount string nullable
  • date string nullable
  • delivery_order_number string nullable
  • line_item_number string nullable
  • awardee object nullable
    • @type string (default: "SamgovAwardee")
    • name string nullable
    • uei_sam string nullable
    • cage_code string nullable
    • location object nullable
      • @type string (default: "SamgovLocation")
      • street_address string nullable
      • street_address2 string nullable
      • city string nullable
      • state string nullable
      • zip string nullable
      • country 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.