/publicsurplus/categories/auctions

POST /api/publicsurplus/categories/auctions

Price: 20 credits

List live Public Surplus auctions in one category or subcategory, optionally within one state or province. Each result has the auction id, title, thumbnail, state, current price, start and end time.

How to use it

Browse everything a government surplus category currently has up for auction, such as 17 for heavy equipment or 1717 for forklifts. Pass a result id to publicsurplus/auctions for the full lot.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• category_id integer required — Public Surplus category or subcategory id (examples: 17, 1717; min: 1)
• count integer required — Max number of auctions to return (min: 1; max: 2500)
• 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")
• 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 — No Public Surplus category with this id 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.