# /govdeals/lots/search

`POST /api/govdeals/lots/search`

Price: 10 credits

Search GovDeals surplus lots open for bidding by keyword, seller, event, category, make, model and year, distance from a ZIP code, seller type, condition, current bid range, country, state or province, reserve and Buy Now state, and closing or listing window. Each result has the lot id, title, photo, current bid, Buy Now price, location, seller and end time.

## How to use it

Find government and commercial surplus lots currently up for auction in the US and Canada. Pass a result id to govdeals/lots for the full lot, photos, bid state 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)
- `keyword` (string, nullable) — Words to match in lot titles and descriptions (examples: "truck")
- `seller_id` (string, nullable) — GovDeals seller id (examples: "23609"; pattern: ^\d{1,12}$)
- `category_id` (string, nullable) — GovDeals category id (examples: "94C", "36D"; pattern: ^[A-Za-z0-9]{1,8}$)
- `make` (string, nullable) — Vehicle or equipment make (examples: "Ford")
- `model` (string, nullable) — Vehicle or equipment model (examples: "F-150")
- `model_year` (integer, nullable) — Model year (examples: 2015; min: 1900; max: 2100)
- `zip_code` (string, nullable) — US ZIP code to measure distance from (examples: "32055"; pattern: ^\d{5}$)
- `distance_miles` (integer, nullable) — Radius around zip_code, in miles (min: 1; max: 5000)
- `seller_type` (string, nullable) — Kind of seller (one of: "government", "commercial", "nonprofit")
- `condition` (string, nullable) — Item condition (one of: "new", "used", "scrap")
- `price_min` (number, nullable) — Lowest current bid (min: 0)
- `price_max` (number, nullable) — Highest current bid (min: 0)
- `country` (string, nullable) — Country the lot is located in (one of: "US", "CA")
- `state` (string, nullable) — State or province the lot is located in, by name or US/Canadian two-letter code (examples: "Florida", "FL", "Ontario")
- `count` (integer, required) — Max number of lots to return (min: 1; max: 10000)
- `event_id` (string, nullable) — GovDeals event id (examples: "31038"; pattern: ^\d{1,12}$)
- `ending_within` (string, nullable) — Only lots closing within this window (one of: "1_hour", "8_hours", "24_hours", "48_hours")
- `listed_within` (string, nullable) — Only lots listed within this window (one of: "1_hour", "8_hours", "24_hours", "48_hours")
- `reserve_met` (boolean, nullable) — Only lots whose reserve is met (true) or not yet met (false)
- `has_buy_now` (boolean, nullable) — Only lots with (true) or without (false) a Buy Now price
- `sort_by` (string) — Result ordering (default: "best_match"; one of: "best_match", "current_bid", "end_time", "newest", "lot_number")
- `sort_order` (string) — Ordering direction (default: "desc"; one of: "asc", "desc")

## Response

### 200 — Successful Response

- `@type` (string) (default: "GovdealsLotCard")
- `id` (string, required)
- `asset_id` (string, required)
- `seller_id` (string, required)
- `url` (string, required)
- `make` (string, nullable)
- `model` (string, nullable)
- `model_year` (integer, nullable)
- `category_code` (string, nullable)
- `category_name` (string, nullable)
- `seller_name` (string, nullable)
- `city` (string, nullable)
- `state` (string, nullable)
- `state_name` (string, nullable)
- `zip_code` (string, nullable)
- `country` (string, nullable)
- `current_bid` (number, nullable)
- `buy_now_price` (number, nullable)
- `bid_count` (integer, nullable)
- `bid_increment` (number, nullable)
- `currency` (string, nullable)
- `has_reserve` (boolean, nullable)
- `is_reserve_met` (boolean, nullable)
- `is_reserve_reduced` (boolean, nullable)
- `is_sold` (boolean, nullable)
- `start_at` (integer, nullable)
- `end_at` (integer, nullable)
- `event_id` (string, nullable)
- `lot_number` (integer, nullable)
- `auction_type_id` (string, nullable)
- `image` (string, nullable)

## Errors

### 422 — Validation Error

The request body did not validate

What to do: Check the fields against this schema. A URN with the wrong prefix is the most common cause.

- `detail` (array)
  - `loc` (array, required)
  - `msg` (string, required)
  - `type` (string, required)
  - `input` (any)
  - `ctx` (object)

### 408

The request ran past its time limit

What to do: 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

What to do: 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

What to do: 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

What to do: 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

What to do: Wait at least 30 seconds, then retry.

## Response envelope

Success: Array of objects (may be empty if no results)

Error: Error may coexist with partial results if it occurs mid-execution. Check X-Error header and status code.

Every response carries these 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.

