Skip to main content
GET
List vehicles

Authorizations

X-API-Key
string
header
required

Your Hrizn API key (prefix hzk_)

Query Parameters

limit
integer
default:25

Number of results per page

Required range: 1 <= x <= 100
cursor
string

Base64-encoded pagination cursor

make
string

Filter by make (case-insensitive partial match)

model
string

Filter by model (case-insensitive partial match)

year
integer

Filter by exact model year (wins over min_year/max_year)

min_year
integer

Minimum model year

max_year
integer

Maximum model year

vehicle_type
string

Filter by vehicle type (New or Used)

min_price
number
max_price
number
min_mileage
integer
max_mileage
integer
min_days_on_lot
integer

Minimum days in stock (from instock_date)

max_days_on_lot
integer

Maximum days in stock

q
string

Exact text match on make, model, stock number, or VIN (every word must match)

semantic_query
string

Natural-language shopper request (e.g. "roomy family SUV for road trips"). Recognized attributes become filters; the remaining words rank vehicles by meaning. Required for sort=relevance.

trim
string
body_style
string

SUV, Truck, Minivan, Van, Sedan, Coupe, Hatchback, Wagon, or Convertible

drivetrain
string

AWD, 4WD, FWD, or RWD ("4x4" and "all-wheel drive" are accepted)

fuel_type
string

Gas, Hybrid, Electric, or Diesel

transmission
string

Automatic or Manual

equipment
string

Comma-separated features that must all be present (e.g. "sunroof,apple carplay,third row"). Unknown features return no vehicles.

certified
enum<string>
Available options:
true,
false
min_photos
integer
has_description
enum<string>

Filter units with or without a Hrizn AI description

Available options:
true,
false
exterior_color
string

Filter by OEM exterior paint name (path-scoped substring against inventory metadata exteriorcolor). For generic colors like white/blue, prefer color_family so OEM names such as Ice Cap are included.

color_family
string

Filter by Hrizn color family (e.g. white, blue, black). Expands to matching OEM paint names/codes observed on this site's inventory (Ice Cap → white). Does not match unrelated metadata text.

sort
enum<string>
default:vin_asc

relevance ranks by semantic_query and requires it

Available options:
vin_asc,
newest,
oldest,
price_asc,
price_desc,
mileage_asc,
mileage_desc,
aging,
relevance

Response

Paginated list of vehicles

data
object[]
pagination
object