/govdeals/lots

POST /api/govdeals/lots

Price: 1 credit

Get one GovDeals surplus auction lot by id or URL: title, description, condition, make, model, year, VIN, specifications, seller amendments, all photos, current bid, Buy Now price, starting bid, bid count, reserve state, sold price, buyer premium, visitor, view and watcher counts, start and end time, seller, pick-up location, and inspection, payment and removal terms. Works for live and sold lots.

How to use it

Read one GovDeals lot in full before bidding or to check what it sold for. Pass an id from govdeals/lots/search, govdeals/lots/sold or the featured lots of govdeals/events.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• lot string required — GovDeals lot id or lot URL (examples: "282-23609", "https://www.govdeals.com/en/asset/282/23609"; minLength: 1)

Response

• @type string (default: "GovdealsLot")
• id string required
• asset_id string required
• seller_id string required
• url string required
• description string nullable
• status string nullable
• is_sold boolean nullable
• quantity integer nullable
• quantity_unit string nullable
• make string nullable
• model string nullable
• model_year integer nullable
• vin string nullable
• condition_code string nullable
• condition string nullable
• title_status string nullable
• meter_unit string nullable
• meter_reading number nullable
• is_meter_accurate boolean nullable
• inventory_number string nullable
• category_code string nullable
• category_name string nullable
• parent_category_code string nullable
• parent_category_name string nullable
• categories array (default: [])
  • @type string (default: "GovdealsCategory")
  • id string required
  • name string nullable
  • alias string nullable
  • level integer nullable
• attributes array (default: [])
  • @type string (default: "GovdealsAttribute")
  • group string nullable
  • label string required
  • value string nullable
• images array (default: [])
• video_url string nullable
• attachments array (default: [])
  • @type string (default: "GovdealsAttachment")
  • file_name string nullable
• amendments array (default: [])
• current_bid number nullable
• buy_now_price number nullable
• starting_bid number nullable
• bid_count integer nullable
• bid_increment number nullable
• high_bidder string nullable
• currency string nullable
• has_reserve boolean nullable
• is_reserve_met boolean nullable
• is_reserve_reduced boolean nullable
• sold_price number nullable
• buyer_premium_percent number nullable
• buyer_premium_amount number nullable
• sold_total_price number nullable
• is_auto_extend boolean nullable
• auto_extension_count integer nullable
• visitor_count integer nullable
• view_count integer nullable
• watcher_count integer nullable
• question_count integer nullable
• start_at integer nullable
• end_at integer nullable
• event_id string nullable
• event_title string nullable
• lot_number integer nullable
• auction_type_id string nullable
• restriction string nullable
• bidder_requirements string nullable
• is_shipping_available boolean nullable
• seller_name string nullable
• seller_type_id string nullable
• seller_type string nullable
• seller_website_url string nullable
• seller_logo string nullable
• seller_contact object nullable
  • @type string (default: "GovdealsSellerContact")
  • name string nullable
  • email string nullable
  • phone string nullable
  • phone_extension string nullable
• address_line1 string nullable
• address_line2 string nullable
• city string nullable
• state string nullable
• state_name string nullable
• zip_code string nullable
• country string nullable
• latitude number nullable
• longitude number nullable
• weight number nullable
• weight_unit string nullable
• inspection_instructions string nullable
• payment_instructions string nullable
• removal_instructions string nullable
• special_instructions 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 GovDeals lot 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.