Filter listings - Visor Public API

Authorizations

Authorization

string

header

required

Send API keys as Authorization: Bearer <api_key>. Query-string API keys are rejected.

Query Parameters

limit

string

Page size as an integer string. Defaults to 50; maximum 100.

offset

string

Zero-based page offset as an integer string. Defaults to 0.

sort

enum<string>

Sort order. Use field names with optional - for descending, for example price or -price. Defaults to days_on_market, which returns newest listings first. discount returns best discount from MSRP first. distance requires postal_code or latitude and longitude.

Available options:

days_on_market,

-days_on_market,

price,

-price,

miles,

-miles,

msrp,

-msrp,

discount,

-discount,

distance

fields

string

Comma-separated public listing summary fields to return. This controls response projection only; filters such as availability_status, options_packages, and features do not belong in fields. id and vin are always returned. Use default to include the default listing summary fieldset plus selected extras. Unknown fields are rejected. Supported fields: default, id, vin, year, make, model, trim, version, body_type, drivetrain, fuel_type, powertrain_type, transmission, engine, cylinders, doors, seating_capacity, exterior_color, interior_color, base_exterior_color, base_interior_color, msrp, discount_from_msrp, price, miles, days_on_market, status, inventory_status, inventory_type, stock_number, vdp_url, sold_date, dealer_id, dealer_name, dealer_type, city, state, latitude, longitude, distance_miles, photo_urls, features, options_packages.

include

string

Comma-separated optional expansions. Supported values are price_history and options.

make

string

Comma-separated make names or slugs, for example toyota,honda.

model

string

Comma-separated model names or slugs. Combine with make when possible for narrower results.

trim

string

Comma-separated trim names.

year

string

Comma-separated model years, for example 2023,2024.

state

string

Comma-separated two-letter dealer states, for example CA,TX.

dealer_id

string

Comma-separated dealer UUIDs. Accepts up to 50 dealer IDs and uses dealer-filtered listing metering.

dealer_type

string

Comma-separated dealer types, for example franchise,independent.

availability_status

string

Comma-separated availability statuses: stock, transit, build.

inventory_type

string

Comma-separated inventory classes: new, used, certified. cpo is accepted as an alias for certified.

body_type

string

Comma-separated body types.

transmission

string

Comma-separated transmission values.

drivetrain

string

Comma-separated drivetrain values.

assembly_location

string

Pipe-separated assembly locations. Uses | because locations often contain commas.

assembly_country

string

Comma-separated assembly country values.

fuel_type

string

Comma-separated fuel type values.

powertrain_type

string

Comma-separated powertrain type values.

engine

string

Comma-separated engine descriptions.

version

string

Comma-separated vehicle version values.

exterior_color

string

Comma-separated exterior color values.

interior_color

string

Comma-separated interior color values.

base_exterior_color

string

Comma-separated normalized exterior color values.

base_interior_color

string

Comma-separated normalized interior color values.

seating_capacity

string

Comma-separated seating capacity integers.

cylinders

string

Comma-separated cylinder count integers.

doors

string

Comma-separated door count integers.

options_packages

string

Comma-separated manufacturer option/package codes.

features

string

Comma-separated feature tokens.

keywords

string

Comma-separated provenance/history keyword tokens. Supported values: one_owner, clean_title, branded, fleet. Positive tokens must be present; negative history tokens are excluded.

vin_pattern

string

Comma-separated VIN masks, up to 10 distinct patterns. VIN characters match themselves, ? matches one VIN position, and * is allowed only at the end. Short masks are treated as prefixes, for example 1HG or 1HGCM826*.

exclude_make

string

Comma-separated makes to exclude.

exclude_model

string

Comma-separated models to exclude.

exclude_trim

string

Comma-separated trims to exclude.

exclude_year

string

Comma-separated model years to exclude.

exclude_state

string

Comma-separated dealer states to exclude.

exclude_inventory_type

string

Comma-separated inventory classes to exclude: new, used, certified. cpo is accepted as an alias for certified.

exclude_body_type

string

Comma-separated body types to exclude.

exclude_transmission

string

Comma-separated transmission values to exclude.

exclude_drivetrain

string

Comma-separated drivetrain values to exclude.

exclude_version

string

Comma-separated vehicle versions to exclude.

exclude_engine

string

Comma-separated engine descriptions to exclude.

exclude_assembly_location

string

Plus-separated assembly locations to exclude. Uses + to match the private API separator.

exclude_assembly_country

string

Comma-separated assembly countries to exclude.

exclude_exterior_color

string

Comma-separated exterior colors to exclude.

exclude_interior_color

string

Comma-separated interior colors to exclude.

exclude_base_exterior_color

string

Comma-separated normalized exterior colors to exclude.

exclude_base_interior_color

string

Comma-separated normalized interior colors to exclude.

exclude_options_packages

string

Comma-separated manufacturer option/package codes to exclude.

exclude_features

string

Comma-separated feature tokens to exclude.

exclude_fuel_type

string

Comma-separated fuel types to exclude.

exclude_powertrain_type

string

Comma-separated powertrain types to exclude.

exclude_keywords

string

Comma-separated keyword tokens to exclude.

inventory_status

enum<string>

Inventory mode. active is the default; sold searches historical sold inventory.

Available options:

active,

sold

sold_within_days

string

Positive integer day window for sold inventory, for example 30. Cannot be combined with snapshot_date.

snapshot_date

string

Historical active-inventory snapshot date in YYYY-MM-DD format. Cannot be combined with sold inventory filters.

min_price

string

Minimum listed price in whole dollars.

max_price

string

Maximum listed price in whole dollars.

min_mileage

string

Minimum odometer mileage.

max_mileage

string

Maximum odometer mileage.

min_msrp

string

Minimum combined MSRP in whole dollars.

max_msrp

string

Maximum combined MSRP in whole dollars.

min_days_on_market

string

Minimum days on market.

max_days_on_market

string

Maximum days on market.

latitude

string

Search origin latitude for sort=distance, distance_miles, and radius filtering.

longitude

string

Search origin longitude for sort=distance, distance_miles, and radius filtering.

postal_code

string

US ZIP/postal search origin for sort=distance, distance_miles, and radius filtering.

radius

string

Maximum distance from the search origin, in miles. Requires postal_code or latitude and longitude. Maximum 500.

bbox

string

Map viewport as west,south,east,north. Cannot be combined with radius. Maximum diagonal is 1000 miles.

Response

Successful public API response.

data

object[]

required

Records returned for this page.

Show child attributes

pagination

object

required

Offset pagination metadata returned by collection endpoints.

Show child attributes