/hemmings/listings/similar

POST /api/hemmings/listings/similar

Price: 5 credits

Get the listings Hemmings shows as similar to a given listing: cards with title, year, make, model, VIN, price, mileage, exterior color, location, seller or dealer and photos.

How to use it

Get the similar-listings rail for one Hemmings listing by its slug; the source picks the set and its size.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• listing string required — Listing slug from a hemmings.com/listing/<slug> or /auction/<slug> URL, or the URL itself (examples: "1967-ford-mustang-salem-wi-989913"; minLength: 1)

Response

• @type string (default: "HemmingsListingCard")
• id string required
• sale_type string nullable
• listing_type string nullable
• status string nullable
• url string nullable
• long_title string nullable
• description string nullable
• year integer nullable
• make object nullable
  • @type string (default: "HemmingsMakeModel")
  • id string required
  • name string nullable
  • alias string nullable
• model object nullable
  • @type string (default: "HemmingsMakeModel")
  • id string required
  • name string nullable
  • alias string nullable
• vin string nullable
• stock_number string nullable
• price number nullable
• price_text string nullable
• current_price number nullable
• current_bid number nullable
• offer_count integer nullable
• has_reserve boolean nullable
• is_reserve_met boolean nullable
• is_reserve_lowered boolean nullable
• is_trending boolean nullable
• is_featured boolean nullable
• is_certified_dealer boolean nullable
• badge_text string nullable
• location string nullable
• city string nullable
• state string nullable
• country_code string nullable
• starts_at integer nullable
• ends_at integer nullable
• sold_at integer nullable
• seller_name string nullable
• dealer object nullable
  • @type string (default: "HemmingsDealer")
  • id string required
  • name string nullable
  • alias string nullable
  • address string nullable
  • city string nullable
  • state string nullable
  • postal_code string nullable
  • country string nullable
• brand string nullable
• image string nullable
• images array (default: [])
• mileage integer nullable
• exterior_color 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 Hemmings listing exists at this slug. 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.