Discovery

Get one search facet

get/v1/facets

Request

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

Query parameters

One URL-encoded JSON array. For large filters use POST /v1/vehicles/search.

One URL-encoded JSON array. For large filters use POST /v1/vehicles/search.

One URL-encoded JSON array. For large filters use POST /v1/vehicles/search.

One URL-encoded JSON array. For large filters use POST /v1/vehicles/search.

sstring

Committed SearchSpec v2 encoded as v2.<base64url of canonical JSON>, with at most 2 KiB decoded JSON and a 4 KiB complete URL. Contains typed catalog values and coarse location only. Do not combine with query text, legacy filters, location, or sort; update the specification instead. A supplied country must match its market. Cursor, offset, limit, facets and map viewport controls remain transport parameters.

dimension'vehicle_type' | 'make' | 'model' | 'trim' | 'condition' | 'body' | 'fuel' | 'exterior_color' | 'interior_color' | 'year' | 'charge_port' | 'dc_fast_charge' required
qstring
country'US' | 'CA'
region_codestring

US state or Canadian code AB, BC, MB, NB, NL, NS, NT, NU, ON, PE, SK, or YT. QC is unavailable.

zipstring

Resolvable US ZIP/ZIP+4 or Canadian postal code/FSA matching country; mutually exclusive with latitude/longitude.

latitudenumber

US-only raw search origin; requires longitude and cannot accompany zip. For CA use a postal code/FSA or region.

longitudenumber

US-only raw search origin; requires latitude and cannot accompany zip. For CA use a postal code/FSA or region.

number
OR
'any'

Inclusive radius from 1 to 500 miles for US or kilometres for CA (wire name retained), or the literal 'any' for no distance cap; requires a postal or coordinate origin. Defaults to 50.

makestring[]
modelstring[]
conditionstring[]
year_mininteger
year_maxinteger
northnumber
southnumber
eastnumber
westnumber
limitinteger

Response

Facet buckets

idstring
labelstring
selectedboolean
model_scope'family'
countinteger required

Changes

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