/publicsurplus/auctions

POST /api/publicsurplus/auctions

Price: 20 credits

Get one Public Surplus government surplus auction by number: title, open or closed status, start and end time, current or final price, bid count, increment and minimum bid, high bidder, selling agency, pick-up location, payment methods, item attributes, description, full-size images, videos, attachments and terms.

How to use it

Read one Public Surplus lot in full before bidding or to check its outcome. Pass an id from publicsurplus/auctions/search, publicsurplus/categories/auctions or publicsurplus/agencies/auctions.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• auction string required — Public Surplus auction number or auction URL (examples: "4092211", "https://www.publicsurplus.com/sms/auction/view?auc=4092211"; minLength: 1)

Response

• @type string (default: "PublicsurplusAuction")
• id string required
• url string required
• status string nullable
• sale_type string nullable
• is_reserve_met boolean nullable
• is_extended boolean (default: false)
• is_extendable boolean (default: false)
• starts_at integer nullable
• ends_at integer nullable
• region string nullable
• currency string nullable
• price number nullable
• price_type string nullable
• bid_count integer nullable
• bid_increment number nullable
• minimum_bid number nullable
• bid_deposit string nullable
• high_bidders array (default: [])
  • @type string (default: "PublicsurplusBidder")
  • name string required
  • years_registered integer nullable
  • badge string nullable
• agency object nullable
  • @type string (default: "PublicsurplusAgency")
  • id string required
  • name string nullable
  • alias string nullable
  • url string nullable
  • image string nullable
• pickup_location object nullable
  • @type string (default: "PublicsurplusPickupLocation")
  • name string nullable
  • address string nullable
  • city string nullable
  • state string nullable
  • postal_code string nullable
• payment_methods array (default: [])
• payment_note string nullable
• shipping string nullable
• attributes array (default: [])
  • @type string (default: "PublicsurplusAttribute")
  • name string required
  • value string nullable
• description string nullable
• images array (default: [])
• videos array (default: [])
• attachments array (default: [])
  • @type string (default: "PublicsurplusAttachment")
  • name string nullable
  • url string required
• terms 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 — No public auction with this number: it does not exist or its agency does not publish it 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.