/publicsurplus/auctions/search

POST /api/publicsurplus/auctions/search

Price: 20 credits

Search live Public Surplus government surplus auctions by keyword, category, state or province, end or start window, price range and distance from a ZIP code. Each result has the auction id, title, thumbnail, state, current price and end time.

How to use it

Find government surplus lots currently up for auction in the US and Canada. Pass a result id to publicsurplus/auctions for the full lot, bids and pick-up terms.

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 auctions to return (min: 1; max: 5000)
• keyword string nullable — Search words (examples: "ford"; minLength: 1)
• category_id integer nullable — Public Surplus category or subcategory id (examples: 17, 1717; min: 1)
• region string nullable — US state, territory or Canadian province (one of: "AL", "AK", "AS", "AZ", "AR", "CA", "CO", "CT", "DE", "FL", "GA", "GU", "HI", "ID", "IL", "IN", "IA", "KS", "KY", "LA", "ME", "MD", "MA", "MI", "MN", "MS", "MO", "MT", "NE", "NV", "NH", "NJ", "NM", "NY", "NC", "ND", "OH", "OK", "OR", "PA", "PR", "RI", "SC", "SD", "TN", "TX", "VI", "UT", "VT", "VA", "WA", "DC", "WV", "WI", "WY", "AB", "BC", "MB", "NB", "NL", "NT", "NS", "NU", "ON", "PE", "QC", "SK", "YT")
• ending_within string nullable — Only auctions ending within this window (one of: "1_hour", "6_hours", "1_day", "5_days", "10_days")
• listed_within string nullable — Only auctions that started within this window (one of: "1_hour", "1_day", "2_days", "1_week")
• price_min number nullable — Lowest current price, USD (min: 0)
• price_max number nullable — Highest current price, USD (min: 0)
• zip_code string nullable — US ZIP code to measure distance from (examples: "90001"; pattern: ^\d{5}$)
• distance_miles string nullable — Radius around zip_code, in miles (one of: "20", "50", "100", "200", "300", "400", "500", "600", "700", "800", "900", "1000")
• sort_by string — Result ordering (default: "end_time"; one of: "end_time", "auction_id", "title", "price")
• sort_order string — Ordering direction (default: "asc"; one of: "asc", "desc")

Response

• @type string (default: "PublicsurplusAuctionCard")
• id string required
• url string required
• image string nullable
• region string nullable
• price number nullable
• starts_at integer nullable
• ends_at integer nullable
• agency object nullable
  • @type string (default: "PublicsurplusAgency")
  • id string required
  • name string nullable
  • alias string nullable
  • url string nullable
  • image 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.