Sold-price range for a described item (full-market aggregate)

get/comps

Request

  • Base URL: https://govauctions.app/api/v1
  • URL: https://govauctions.app/api/v1/comps
  • Auth: HTTP bearer

Query parameters

qstring required

Item description, e.g. '2015 Ford F-150'

categorystring
country'US' | 'UK' | 'CA' | 'AU' | 'DE' | 'FR'
statestring

Optional 2-letter state/region code for a regional range. Falls back to national when that state is too thin; the response scope field reports which pool was used.

include'comps'

Set to comps to also return the individual sales the range was computed from (title, finalBid, year, state, soldMonth). Sample size is capped by plan. Not served for EU markets (DE, FR, NL, PL): the range comes back with compsWithheld: true.

limitinteger

How many underlying sales to return with include=comps. Capped by the plan's sample limit.

Response

Comp range (p25/median/p75), with scope=state|national when a state was requested, and comps when include=comps. A miss carries data: null plus a reason: insufficient_comps (too few comparable sales yet — worth retrying as the archive grows) or category_not_priceable (the requested category can NEVER return a range — the body lists them in excludedCategories). A catch-all category such as miscellaneous is NOT refused: the label is dropped and the item is priced on its title alone, and the body then carries requestedCategory + categoryDropped next to the category we actually resolved, so check category and confidence before trusting that range. An insufficient_comps miss can still carry categoryStats (the whole category's p25/median/p75, when the item's category is clear) and retryHint (when q was a long listing title: retry with just the brand and model).

Changes

No recorded changes to this operation across all 1 revision of this API.