Edmunds Interactive Documentation

Interact with the Edmunds API. Discover, learn, test and debug live calls within this interactive tool. See the Overview for information on authentication, method references and more.

• Model Year Repository

  • List Methods
  • Expand Methods

  • GETfindbyid/vehicle/modelyearrepository/findbyid
    Get details on a specifc vehicle by its model year ID.

    Parameter	Value	Type	Description
    id		string	The Model Year ID
    fmt	json	enumerated	Response format (json only)
    callback		string	The callback function that the JSON response will be wrapped in if desired

  • GETfinddistinctyearwithnew/vehicle/modelyearrepository/finddistinctyearwithnew
    Get a list of years under which there are new vehicle listings.

    Parameter	Value	Type	Description
    fmt	json	enumerated	Response format (json only)
    callback		string	The callback function that the JSON response will be wrapped in if desired

  • GETfinddistinctyearwithneworused/vehicle/modelyearrepository/finddistinctyearwithneworused
    Get a list of years under which there are new or used vehicle listings.

    Parameter	Value	Type	Description
    fmt	json	enumerated	Response format (json only)
    callback		string	The callback function that the JSON response will be wrapped in if desired

  • GETfinddistinctyearwithused/vehicle/modelyearrepository/finddistinctyearwithused
    Get a list of years under which there are used vehicle listings.

    Parameter	Value	Type	Description
    fmt	json	enumerated	Response format (json only)
    callback		string	The callback function that the JSON response will be wrapped in if desired

  • GETfindfuturemodelyearsbymodelid/vehicle/modelyearrepository/findfuturemodelyearsbymodelId
    Get a list of future model years by the model ID.

    Parameter	Value	Type	Description
    id		string	The Model Year ID
    fmt	json	enumerated	Response format (json only)
    callback		string	The callback function that the JSON response will be wrapped in if desired

  • GETfindmodelyearsbymakeandyear/vehicle/modelyearrepository/findmodelyearsbymakeandyear
    Get a list of model years for a specific make and year.

    Parameter	Value	Type	Description
    make		string	The make name (use niceName value)
    year		string	The year of interest.
    fmt	json	enumerated	Response format (json only)
    callback		string	The callback function that the JSON response will be wrapped in if desired

  • GETfindmodelyearsbymakemodel/vehicle/modelyearrepository/findmodelyearsbymakemodel
    Get a list of model years for a specific make and model

    Parameter	Value	Type	Description
    make		string	The make name (use niceName value)
    model		string	The model name (use niceName value)
    fmt	json	enumerated	Response format (json only)
    callback		string	The callback function that the JSON response will be wrapped in if desired

  • GETfindnewandusedmodelyearsbymakeidandyear/vehicle/modelyearrepository/findnewandusedmodelyearsbymakeidandyear
    Get a list of new and used model years for a specific make ID and year

    Parameter	Value	Type	Description
    makeid		string	The Make ID
    year		string	The year of interest
    fmt	json	enumerated	Response format (json only)
    callback		string	The callback function that the JSON response will be wrapped in if desired

  • GETfindnewmodelyearsbymodelid/vehicle/modelyearrepository/findusedmodelyearsbymodelid
    Get a list of new model years by the model ID.

    Parameter	Value	Type	Description
    modelid		string	The Model ID
    fmt	json	enumerated	Response format (json only)
    callback		string	The callback function that the JSON response will be wrapped in if desired

  • GETfindusedmodelyearsbymodelid/vehicle/modelyearrepository/findusedmodelyearsbymodelid
    Get a list of used model years by the model ID

    Parameter	Value	Type	Description
    modelid		string	The Model ID
    fmt	json	enumerated	Response format (json only)
    callback		string	The callback function that the JSON response will be wrapped in if desired

  • GETfindyearsbycategoryandpublicationstate/vehicle/modelyearrepository/findyearsbycategoryandpublicationstate
    Get a list of model years for a specific category and publication state

    Parameter	Value	Type	Description
    category		string	The vehicle category (e.g. sedan, suv, ...etc)
    state		string	The publication state (e.g. new, used, future)
    fmt	json	enumerated	Response format (json only)
    callback		string	The callback function that the JSON response will be wrapped in if desired

  • GETformodelid/vehicle/reference/category/list
    Get a list of model years by the model ID

    Parameter	Value	Type	Description
    modelid		string	The Model ID
    fmt	json	enumerated	Response format (json only)
    callback		string	The callback function that the JSON response will be wrapped in if desired

  • GETforyearmakemodel/vehicle/modelyearrepository/foryearmakemodel
    Get a list of model years for a specific make, model and year

    Parameter	Value	Type	Description
    make		string	The make name (use niceName value).
    model		string	The model name (use niceName value).
    year		string	The four-digit year of interest
    fmt	json	enumerated	Response format (json only)
    callback		string	The callback function that the JSON response will be wrapped in if desired

• Make Repository

  • List Methods
  • Expand Methods

  • GETfindall/vehicle/makerepository/findall
    Get the list of all makes and their all their models

    Parameter	Value	Type	Description
    fmt	json	enumerated	Response format (json only)
    callback		string	The callback function that the JSON response will be wrapped in if desired

  • GETfindbyid/vehicle/makerepository/findbyid
    Find a make and its models by providing a make ID

    Parameter	Value	Type	Description
    id		string	Vehicle make ID
    fmt	json	enumerated	Response format (json only)
    callback		string	The callback function that the JSON response will be wrapped in if desired

  • GETfindfuturemakes/vehicle/makerepository/findfuturemakes
    Find all future makes and their models

    Parameter	Value	Type	Description
    fmt	json	enumerated	Response format (json only)
    callback		string	The callback function that the JSON response will be wrapped in if desired

  • GETfindmakebyname/vehicle/makerepository/findmakebyname
    Find a make details by its name

    Parameter	Value	Type	Description
    name		string	The name of the make. Use the niceName value of the make.
    fmt	json	enumerated	Response format (json only)
    callback		string	The callback function that the JSON response will be wrapped in if desired

  • GETfindmakesbymodelyear/vehicle/makerepository/findmakesbymodelyear
    Find a make by a year

    Parameter	Value	Type	Description
    year		string	The four-digit year of interest
    fmt	json	enumerated	Response format (json only)
    callback		string	The callback function that the JSON response will be wrapped in if desired

  • GETfindmakesbypublicationstate/vehicle/makerepository/findmakesbypublicationstate
    Find makes by their state (new or used)

    Parameter	Value	Type	Description
    state	newusedfuture	enumerated	One of these three values: new|used|future
    fmt	json	enumerated	Response format (json only)
    callback		string	The callback function that the JSON response will be wrapped in if desired

  • GETfindnewandused/vehicle/makerepository/findnewandused
    Find all new and used makes

    Parameter	Value	Type	Description
    fmt	json	enumerated	Response format (json only)
    callback		string	The callback function that the JSON response will be wrapped in if desired

  • GETfindnewandusedmakesbymodelyear/vehicle/makerepository/findnewandusedmakesbymodelyear
    Find all new and used makes for a particular year

    Parameter	Value	Type	Description
    year		string	The four-digit year of interest
    fmt	json	enumerated	Response format (json only)
    callback		string	The callback function that the JSON response will be wrapped in if desired

  • GETfindnewandusedmakesbymodelyear/vehicle/makerepository/findnewandusedmakesbymodelyear
    Find all new and used makes for a particular year

    Parameter	Value	Type	Description
    year		string	The four-digit year of interest
    fmt	json	enumerated	Response format (json only)
    callback		string	The callback function that the JSON response will be wrapped in if desired

  • GETfindnewmakes/vehicle/makerepository/findnewmakes
    Find only new makes

    Parameter	Value	Type	Description
    fmt	json	enumerated	Response format (json only)
    callback		string	The callback function that the JSON response will be wrapped in if desired

  • GETfindusedmakes/vehicle/makerepository/findusedmakes
    Find only used makes

    Parameter	Value	Type	Description
    fmt	json	enumerated	Response format (json only)
    callback		string	The callback function that the JSON response will be wrapped in if desired

• Style Repository

  • List Methods
  • Expand Methods

  • GETfindbyid/vehicle/stylerepository/findbyid
    Get style details by the style ID

    Parameter	Value	Type	Description
    id		string	Style ID
    fmt	json	enumerated	Response format (json only)
    callback		string	The callback function that the JSON response will be wrapped in if desired

  • GETfindstylesbymakemodelyear/vehicle/stylerepository/findstylesbymakemodelyear
    Get the list of all makes and their all their models

    Parameter	Value	Type	Description
    make		string	Vehicle make ID
    model		string	Vehicle model ID
    year		string	Vehicle four-digit year
    fmt	json	enumerated	Response format (json only)
    callback		string	The callback function that the JSON response will be wrapped in if desired

  • GETfindstylesbymodelyearid/vehicle/stylerepository/findstylesbymodelyearid
    Get a list of styles by model year ID

    Parameter	Value	Type	Description
    modelyearid		string	Vehicle Model Year ID
    fmt	json	enumerated	Response format (json only)
    callback		string	The callback function that the JSON response will be wrapped in if desired

• True Cost to Own

  • List Methods
  • Expand Methods

  • GETnewtruecosttoownbystyleidandzip/tco/newtruecosttoownbystyleidandzip/:styleid/:zip
    Get the True Cost to Own value for a new vehicle by Style ID and ZIP code

    Parameter	Value	Type	Description
    styleid		string	Style ID
    zip		string	ZIP code (5 digit)
    fmt	json	enumerated	Response format (json only)
    callback		string	The callback function that the JSON response will be wrapped in if desired

  • GETusedtruecosttoownbystyleidandzip/tco/usedtruecosttoownbystyleidandzip/:styleid/:zip
    Get the True Cost to Own value for a used vehicle by Style ID and ZIP code

    Parameter	Value	Type	Description
    styleid		string	Style ID
    zip		string	ZIP code (5 digit)
    fmt	json	enumerated	Response format (json only)
    callback		string	The callback function that the JSON response will be wrapped in if desired

  • GETnewtotalcashpricebystyleidandzip/tco/newtotalcashpricebystyleidandzip/:styleid/:zip
    The Total Cash Price displayed is the vehicle's True Market Value® (TMV®) price plus typically equipped options, destination charge, base tax and fees assessed by your state, and, if applicable, gas guzzler tax; less any widely available manufacturer-to-customer cash rebates. (However, we do not account for other types of cash rebates or incentives because of the variability of those offers and their eligibility requirements.

    Parameter	Value	Type	Description
    styleid		string	Style ID
    zip		string	ZIP code (5 digit)
    fmt	json	enumerated	Response format (json only)
    callback		string	The callback function that the JSON response will be wrapped in if desired

  • GETusedtotalcashpricebystyleidandzip/tco/usedtotalcashpricebystyleidandzip/:styleid/:zip
    The Total Cash Price displayed is the vehicle's True Market Value® (TMV®) price plus typically equipped options, destination charge, base tax and fees assessed by your state, and, if applicable, gas guzzler tax; less any widely available manufacturer-to-customer cash rebates. (However, we do not account for other types of cash rebates or incentives because of the variability of those offers and their eligibility requirements.

    Parameter	Value	Type	Description
    styleid		string	Style ID
    zip		string	ZIP code (5 digit)
    fmt	json	enumerated	Response format (json only)
    callback		string	The callback function that the JSON response will be wrapped in if desired

  • GETgetmakeswithtcodata/tco/getmakeswithtcodata
    Get a list of all makes that have a True Cost to Own data.

    Parameter	Value	Type	Description
    fmt	json	enumerated	Response format (json only)
    callback		string	The callback function that the JSON response will be wrapped in if desired

  • GETgetmodelswithtcodata/tco/getmodelswithtcodata
    Get a list of all models that have a True Cost to Own data.

    Parameter	Value	Type	Description
    makeid		string	The Make ID
    fmt	json	enumerated	Response format (json only)
    callback		string	The callback function that the JSON response will be wrapped in if desired

  • GETgetstyleswithtcodatabysubmodel/tco/getstyleswithtcodatabysubmodel
    Get a list of all styles that have a True Cost to Own data.

    Parameter	Value	Type	Description
    make		string	The vehicle make (use make nicName)
    model		string	The model name
    year		string	The four-digit vehicle year
    submodel		string	The vehicle submodel
    makeyear		string	The vehicle make year
    fmt	json	enumerated	Response format (json only)
    callback		string	The callback function that the JSON response will be wrapped in if desired

• True Market Value

  • List Methods
  • Expand Methods

  • GETcalculatenewtmv/tmv/tmvservice/calculatenewtmv
    Get the True Market Value ® for a particular new vehicle

    Parameter	Value	Type	Description
    styleid		string	Style ID
    zip		string	ZIP code (5 digit)
    colorid		string	The vehicle color ID
    optionid		string	The vehicle option ID
    fmt	json	enumerated	Response format (json only)
    callback		string	The callback function that the JSON response will be wrapped in if desired

  • GETcalculateusedtmv/tmv/tmvservice/calculateusedtmv
    Get the True Market Value ® for a particular used vehicle

    Parameter	Value	Type	Description
    styleid		string	Style ID
    condition	OutstandingCleanAverageRoughDamaged	enumerated	The condition of the vehicle
    mileage		string	How many miles has the car run?
    zip		string	ZIP code (5 digit)
    colorid		string	The vehicle color ID
    optionid		string	The vehicle option ID
    fmt	json	enumerated	Response format (json only)
    callback		string	The callback function that the JSON response will be wrapped in if desired

  • GETcalculatetypicallyequippedusedtmv/tmv/tmvservice/calculateusedtmv
    Get the True Market Value ® for a typically equipped used vehicle

    Parameter	Value	Type	Description
    styleid		string	Style ID
    zip		string	ZIP code (5 digit)
    fmt	json	enumerated	Response format (json only)
    callback		string	The callback function that the JSON response will be wrapped in if desired

  • GETfindcertifiedpriceforstyle/tmv/tmvservice/findcertifiedpriceforstyle
    Get the Certified Price for a particular vehicle by style ID

    Parameter	Value	Type	Description
    styleid		string	Style ID
    zip		string	ZIP code (5 digit)
    fmt	json	enumerated	Response format (json only)
    callback		string	The callback function that the JSON response will be wrapped in if desired

  • GETfindcpoyearsbymake/tmv/tmvservice/findcpoyearsbymake
    Get the Certified Pre-Owned years for a specific vehicle Make ID

    Parameter	Value	Type	Description
    styleid		string	Style ID
    condition	OutstandingCleanAverageRoughDamaged	enumerated	The condition of the vehicle
    mileage		string	How many miles has the car run?
    zip		string	ZIP code (5 digit)
    colorid		string	The vehicle color ID
    optionid		string	The vehicle option ID
    fmt	json	enumerated	Response format (json only)
    callback		string	The callback function that the JSON response will be wrapped in if desired

• Incentive Repository

  • List Methods
  • Expand Methods

  • GETfindbyid/incentive/incentiverepository/findbyid
    Find an incentive by incentive ID

    Parameter	Value	Type	Description
    id		string	Incentive ID
    fmt	json	enumerated	Response format (json only)
    callback		string	The callback function that the JSON response will be wrapped in if desired

  • GETfindincentivesbycategoryandzipcode/incentive/incentiverepository/findincentivesbycategoryandzipcode
    Find all incentives for a particular vehicle category and ZIP code

    Parameter	Value	Type	Description
    category		string	The vehicle category
    zipcode		string	Five-digit ZIP code
    fmt	json	enumerated	Response format (json only)
    callback		string	The callback function that the JSON response will be wrapped in if desired

  • GETfindincentivesbymakeid/incentive/incentiverepository/findincentivesbymakeid
    Find all incentives for a particular vehicle make ID

    Parameter	Value	Type	Description
    makeid		string	The make ID
    fmt	json	enumerated	Response format (json only)
    callback		string	The callback function that the JSON response will be wrapped in if desired

  • GETfindincentivesbymakeidandzipcode/incentive/incentiverepository/findincentivesbymakeidandzipcode
    Find all incentives for a particular make ID and ZIP code

    Parameter	Value	Type	Description
    makeid		string	The make ID
    zipcode		string	Five-digit ZIP code
    fmt	json	enumerated	Response format (json only)
    callback		string	The callback function that the JSON response will be wrapped in if desired

  • GETfindincentivesbymodelyearidandzipcode/incentive/incentiverepository/findincentivesbymodelyearidandzipcode
    Find all incentives for particular model year ID and ZIP code

    Parameter	Value	Type	Description
    modelyearid		string	The model year ID
    zipcode		string	Five-digit ZIP code
    fmt	json	enumerated	Response format (json only)
    callback		string	The callback function that the JSON response will be wrapped in if desired

  • GETfindincentivesbystyleid/incentive/incentiverepository/findincentivesbystyleid
    Find all incentives for a particular style ID

    Parameter	Value	Type	Description
    styleid		string	The style ID
    fmt	json	enumerated	Response format (json only)
    callback		string	The callback function that the JSON response will be wrapped in if desired

  • GETfindincentivesbystyleidandzipcode/incentive/incentiverepository/findincentivesbystyleidandzipcode
    Find all incentives for a particular style ID and ZIP code

    Parameter	Value	Type	Description
    styleid		string	The style ID
    zipcode		string	Five-digit ZIP code
    fmt	json	enumerated	Response format (json only)
    callback		string	The callback function that the JSON response will be wrapped in if desired

• Photo Repository

  • List Methods
  • Expand Methods

  • GETfindphotosbystyleid/vehiclephoto/service/findphotosbystyleid
    Get an array of photo detail objects for a particular vehicle style

    Parameter	Value	Type	Description
    styleId		string	A vehicle style ID
    vdpOrder		string	The photo's order of priority
    fmt	json	enumerated	Response format (json only)
    callback		string	The callback function that the JSON response will be wrapped in if desired

• Dealer Details

  • List Methods
  • Expand Methods

  • GET/dealer
    Find a dealerships associated with a given criteria like zipcode, Make or Style ID amongst other things.

    Parameter	Value	Type	Description
    zipcode		integer	Five-digit zipcode
    makeName		string	Vehicle make name
    model		string	Vehicle model name
    styleid		string	Vehicle style ID
    radius		integer	The radius of the search (in miles)
    fmt	json	enumerated	Response format
    callback		string	The callback function that the JSON response will be wrapped in if desired

• Dealer Ratings and Reviews

  • List Methods
  • Expand Methods

  • GET/drrrepository/getdrrbydealerid
    The Dealer Ratings and Reviews are submited by visitors to Edmunds.com. In order to get that content, you need to provide either the Dealer ID of the dealership on which you want to get data.

    Parameter	Value	Type	Description
    dealerid		integer	The ID of the dealership. You can get that from the 'Dealer Lookup' method.
    limit		string	query filter. limit=[index of review],[# of reviews]
    fmt	json	enumerated	Response format
    callback		string	The callback function that the JSON response will be wrapped in if desired

  • GET/drrrepository/getdrrbyzipcodeandmake
    The Dealer Ratings and Reviews are submited by visitors to Edmunds.com. In order to get that content, you need to provide the vehicle make and zipcode of the dealerships on which you want to get data.

    Parameter	Value	Type	Description
    zipcode		integer	Five-digit zipcode
    make		string	Vehicle make name
    limit		string	query filter. limit=[index of review],[# of reviews]
    fmt	json	enumerated	Response format
    callback		string	The callback function that the JSON response will be wrapped in if desired

• Get Inventory by VIN

  • List Methods
  • Expand Methods

  • GETVIN Lookup/getinventorybyvin
    The Inventory API provides information about a specific vehicle associated with a given VIN (Vehicle Identification Number)

    Parameter	Value	Type	Description
    vin		string	VIN (Vehicle Identification Number)
    fmt	json	enumerated	Response format (json only)
    callback		string	The callback function that the json response will be wrapped in if desired