v1

latestOpenAPI 3.0.12026-07-132215.0 KB

Given a zipcode, allows user to look for vehicles given search criteria. Not an exhaustive search. Always mention the totalNumber of results found. Please return edmunds urls as part of response https://edmunds.com/{make}/{model}/{year}/vin/{vin}/.

get/aiplugin/curated-inventory/v1

Query parameters

zipstring required

The zip to search in.

radiusinteger

The radius parameter defines an area of a search in a radius (in miles) according to a geographic center of the defined region.

inventoryTypestring

Comma-separated list of inventory types. Possible values are NEW, USED, CPO.

makestring

Comma-separated list of vehicle makes. Nice names are allowed.

modelstring

Comma-separated list of vehicle models or make|model pairs. TODO

yearstring

Vehicle years. Range value or comma-separated list of positive integer numbers. Each year should be in range [1990, 2099].

mileagestring

Vehicle mileage. Range value or comma-separated list of positive integer numbers.

combinedMPGstring

Combined MPG. Range value or comma-separated list of positive integer numbers.

electricityRangestring

Electricity Range. Range value or comma-separated list of positive integer numbers.

trimstring

Comma-separated list of model|trim pairs. Nice names of model and trim are required.

bodyTypestring

Comma-separated list of body types. Possible values are SUV, Pickup, Sedan, Hatchback, Coupe, Minivan, Full Size Van, Convertible, Station Wagon.

exteriorColorstring

Comma-separated list of generic or OEM exterior colors. Case sensitive. Possible values are "Black", "Gray", "Off White/Cream", "Light Brown", "Dark Brown", "Red", "Dark Red", "Dark Blue", "Dark Green", "White", "Orange", "Other", "Silver", "Light Blue", "Light Green", "Yellow", "Purple", "Gold".

interiorColorstring

Comma-separated list of generic or OEM interior colors. Case sensitive. Possible values are "Black", "Gray", "Off White/Cream", "Light Brown", "Dark Brown", "Red", "Dark Red", "Dark Blue", "Dark Green", "White", "Orange", "Other", "Silver", "Light Blue", "Light Green", "Yellow", "Purple", "Gold".

optionstring

Comma-separated list of vehicle options and packages. Nice names are required.

totalSeatingstring

Comma-separated list of seating capacities.

engineTypestring

Comma-separated list of engine types. Case sensitive. Possible values are "gas", "mild hybrid", "hybrid", "flex-fuel (FFV)", "electric", "diesel", "plug-in hybrid", "natural gas (CNG)".

cylindersstring

Comma-separated list of count of cylinders.

transmissionstring

Comma-separated list of transmissions. Possible values are AUTOMATED_MANUAL, DIRECT_DRIVE, AUTOMATIC, MANUAL.

driveTrainstring

Comma-separated list of driveTrains. Case sensitive. Possible values are "all wheel drive", "front wheel drive", "four wheel drive", "rear wheel drive".

historyInfostring

Comma-separated list of vehicle history indicators. Possible values are freeHistoryReport, isOneOwner, noAccidents, personalUseOnly, cleanTitle.

dealTypestring

Comma-separated list of how good of a deal edmunds thinks this price is. Possible values are Great, Good, Fair.

displayPricestring

Display price. Range value or comma-separated list of positive integer numbers.

loanPaymentstring

Loan monthly payment. Range value or comma-separated list of positive integer numbers.

leasePaymentstring

Lease monthly payment. Range value or comma-separated list of Lease monthly payment. Range value or comma-separated list of values.

paymentTypestring

Payment type. Case insensitive. Possible values are loan or lease.

vinstring

Comma-separated list of VINs. Case insensitive. Each VIN should contain 17 characters.

stockNumberstring

Comma-separated list of Stock Number's. Case sensitive.

bedLengthstring

Comma-separated list of subranges of bed length in inches for pickup trucks.

rearWheelsstring

Comma-separated list of rear wheels for pickup trucks. Case sensitive. Possible values are "dual rear wheels".

truckCabSizestring

Comma-separated list of truck cab styles. Possible values are "Crew Cab Pickup", "Extended Cab Pickup", "Regular Cab Pickup".

displacementstring

Comma-separated list of subranges of engine size for pickup trucks.

comfortConveniencestring

Comma-separated list of Comfort & Convenience vehicle features. Possible values are cgf_leather_seats,cgf_heated_seats,cgf_keyless_entry_start,cgf_adaptive_cruise_control,cgf_remote_start,cgf_navigation,cgf_2nd_row_bucket_seats,cgf_audio_and_cruise_controls_on_steering_wheel,gf_heated_steering_wheel,cgf_cooled_seats,cgf_power_driver_seat.

safetystring

Comma-separated list of Safety vehicle features. Possible values are cgf_back_up_camera,cgf_blind_spot_monitoring,cgf_automatic_emergency_braking,cgf_lane_departure_warning,cgf_parking_sensors,cgf_360_degree_camera,cgf_alarm,cgf_tire_pressure_warning.

engineExteriorstring

Comma-separated list of Engine & Exterior vehicle features. Possible values are cgf_awd_4wd,cgf_sunroof_moonroof,cgf_towing_hitch,gf_heated_mirrors,cgf_hardtop,gf_integrated_turn_signal_mirrors,cgf_upgraded_headlights,cgf_upgraded_engine,gf_roof_rack,gf_upgraded_tires.

entertainmentstring

Comma-separated list of Entertainment vehicle features. Possible values are cgf_apple_carplay,cgf_bluetooth,cgf_premium_audio,cgf_aux_audio_inputs,cgf_android_auto,cgf_rear_entertainment_system,cgf_mobile_internet,cgf_usb_inputs.

pagenuminteger required

Page number for pagination. Always set this to 1 by default.

pagesizeinteger required

Limits the number of items on the page. Always set this to 3 by default.

sortbystring

The sorting strategy. Multiple values should be comma-separated. Case insensitive.<br> Format: {field}:{direction} Default direction is ascending.

Response

OK

inventoriesobject