/austender/atms/search

POST /api/austender/atms/search

Price: 20 credits

List the approaches to market currently open on AusTender — requests for tender, expressions of interest and industry notices — by keyword or ATM id, with the agency, category, description and closing time of each.

How to use it

Only approaches still open for responses are listed; a closed one is not here even by its exact atm_id. atm_id is an exact match and returns that single approach, so combine it with nothing else.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• count integer required — Max number of results (min: 1)
• keyword string nullable — Words to match in the approach to market (examples: "services"; minLength: 1)
• atm_id string nullable — Approach to market id (examples: "DFAT-1112"; minLength: 1)
• order string — Result order (default: "close_date_ascending"; one of: "close_date_ascending", "close_date_descending", "title", "atm_id", "agency", "category", "last_updated_ascending", "last_updated_descending")

Response

• @type string (default: "AustenderAtmSummary")
• id string required
• guid string required
• buyer object nullable
  • @type string (default: "AustenderPartyRef")
  • id string nullable
  • name string nullable
• category string nullable
• description string nullable
• closes_at integer nullable
• updated_at integer nullable
• country string (default: "AU")
• 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 open approach to market with this atm_id on AusTender 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.