Vehicles

Compare two to four published listings

post/v1/vehicles/compare

Request

  • Base URL: https://api.carhandshake.com
  • URL: https://api.carhandshake.com/v1/vehicles/compare
  • Auth: none required

Request body

listing_idsstring[] required

Response

Visible listings in requested order

canonical_attributesobject
feature_idsstring[]
taxonomy_versionstring
normalizer_versionstring
listing_idstring uuid required
vinstring required
stockstring nullable required
yearinteger required
makestring required
modelstring required
trimstring nullable required
vehicle_type'car' | 'motorcycle' | 'trailer' | 'rv' | 'other' required
displacement_ccnumber nullable required
battery_kwhnumber nullable required
motor_power_hpnumber nullable required
dc_fast_chargeboolean nullable required
charge_portstring nullable required
condition'new' | 'used' | 'cpo' | 'null' nullable required
bodystring nullable required
fuelstring nullable required
drivelinestring nullable required
transmissionstring nullable required
exterior_colorstring nullable required
interior_colorstring nullable required
priceinteger nullable required

Current advertised amount in the listing currency (USD for US, CAD for CA), or null when omitted.

msrpinteger nullable required

USD for US listings; CAD for Canadian listings.

currency'USD' | 'CAD' required

Required to match location.country: USD for US and CAD for CA.

mileageinteger nullable required

Miles for US listings; kilometres for Canadian listings.

electric_range_milesnumber nullable required

Miles for US listings; kilometres for Canadian listings. Wire name retained for compatibility.

status'available' | 'intransit' required
primary_photo_urlstring uri nullable required
updated_atstring date-time required

Catalog record update time; not seller confirmation or inventory observation. Optional quality.observation distinguishes those facts.

distance_milesnumber nullable required

Miles for a US search or kilometres for a Canadian search; wire name retained for compatibility.

canonical_urlstring uri nullable required

Canonical Car Handshake VDP URL when website publication is permitted.

dealer_vdp_urlstring uri nullable required
descriptionstring nullable required
enginestring nullable required
city_mpginteger nullable required
highway_mpginteger nullable required
photosstring[] required
featuresstring[] required

Changes

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