Search published US or Canadian inventory
Choose one country (US by default). US supports a matching ZIP or coordinates; Canada supports a postal code/FSA or region/place but not raw coordinates until authoritative province containment is available. Quebec is unavailable. Do not combine origin forms.
Request
- Base URL: https://api.carhandshake.com
- URL: https://api.carhandshake.com/v1/vehicles
- 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.
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.
US state or Canadian code AB, BC, MB, NB, NL, NS, NT, NU, ON, PE, SK, or YT. QC is unavailable.
Resolvable US ZIP/ZIP+4 or Canadian postal code/FSA matching country; mutually exclusive with latitude/longitude.
US-only raw search origin; requires longitude and cannot accompany zip. For CA use a postal code/FSA or region.
US-only raw search origin; requires latitude and cannot accompany zip. For CA use a postal code/FSA or region.
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.
Northern latitude of a map viewport. Requires south, east, and west.
Southern latitude of a map viewport.
Eastern longitude. A value lower than west explicitly crosses the antimeridian.
Western longitude of a map viewport.
Return bounded map clusters. Requires a viewport and map_zoom.
Web map zoom used for geotile clustering.
Repeatable; comma-separated values are also accepted.
Repeatable; comma-separated values are also accepted.
Repeatable; comma-separated values are also accepted.
true returns only vehicles with an advertised price; false only those without. Omit to include both.
Miles for US searches; kilometres for Canadian searches.
Miles for US searches; kilometres for Canadian searches.
Miles for US searches; kilometres for Canadian searches.
Repeatable; comma-separated values are also accepted.
Deep-link pagination: skip this many results in the same sort. Cannot be combined with cursor (400). Use cursor for sequential paging, offset only where a page number must be addressable by URL.
Response
Search results
Changes
No recorded changes to this operation across all 1 revision of this API.