API: 
Vehicle Market Metrics Summary API
API Class: 
Vehicle Market Metrics Summary API
Description: 

This method retrieves vehicle metric data in a given market or set of Zip Codes, along with that vehicle's average days on site and high, low, and average price.

URL

Note: Ensure all testing is done in development environment prior to moving to production.

Environment URL
development https://api-st.cars.com/VehicleMarketSummary/1.0/rest/reports/vehicledetails/metrics
production https://api.cars.com/VehicleMarketSummary/1.0/rest/reports/vehicledetails/metrics

 

Request

Request Example

https://api.cars.com/VehicleMarketSummary/1.0/rest/reports/vehicledetails/metrics? make=Acura&model=MDX&vehicleYear=2014&cpoIndicator=N&zipCode=10538,12345,99999 &startDate=05/03/2016&endDate=05/03/2016&apikey=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

Request Parameters
Request Parameter Type Example value Description Required
make String Acura Vehicle Make yes
model String MDX Vehicle Model yes
vehicleYear Integer 2014 Vehicle Year yes
cpoIndicator String 'Y' or 'N' CPO Indicator flag to return CPO vehicles or Non-CPO vehicles. Leaving this parameter off will return both CPO and Non-CPO vehicles. no
zipCode String 12345,99999 Comma delimited list of Zip Codes. Up to 10 zip codes can be entered yes
startDate Date 05/15/2016 Start Date of date range. Must be within 60 days of yesterday's date. yes
endDate Date 07/15/2016 End Date of data range. Must be after Start Date. yes
apikey String xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx API Key given by Cars.com yes

 

Response

Response Data Formats
Response type Header value
xml Accept: application/xml
json Accept: application/json
VehicleDetailsResult
Element Type Description
vehicleMetricInfo VehicleMetricInfo See VehicleMetricInfo element description below
VehicleMetricInfo
Element Type Description
summaryDate Date Summary Date
vehicleMake String Vehicle Make
vehicleModel String Vehicle Model
trim String Vehicle Trim
vehicleYear String Vehicle Year
zipCode String Zip Code
cpoIndicator String CPO Indicator Flag
totalVehicleCount Int Total Vehicle Count
vehicleHighestPrice String Highest Listed Price
vehicleLowestPrice String Highest Listed Price
vehicleAveragePrice String Average Listed Price
Response XML example
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<vehicleDetailsResult>
    <vehicleMetricInfo>
        <summaryDate>2016-06-22 00:00:00</summaryDate>
        <vehicleMake>Acura</vehicleMake>
        <vehicleModel>MDX</vehicleModel>
        <trim>3.5L Technology Package</trim>
        <vehicleYear>2014</vehicleYear>
        <zipCode>10538</zipCode>
        <cpoIndicator>N</cpoIndicator>
        <totalVehicleCount>16</totalVehicleCount>
        <vehicleHighestPrice>$39,116.00</vehicleHighestPrice>
        <vehicleLowestPrice>$34,786.00</vehicleLowestPrice>
        <vehicleAveragePrice>$37,201.13</vehicleAveragePrice>
    </vehicleMetricInfo>
    <vehicleMetricInfo>
        <summaryDate>2016-06-22 00:00:00</summaryDate>
        <vehicleMake>Acura</vehicleMake>
        <vehicleModel>MDX</vehicleModel>
        <trim>3.5L Technology Package</trim>
        <vehicleYear>2014</vehicleYear>
        <zipCode>10538</zipCode>
        <cpoIndicator>Y</cpoIndicator>
        <totalVehicleCount>3</totalVehicleCount>
        <vehicleHighestPrice>$39,302.00</vehicleHighestPrice>
        <vehicleLowestPrice>$36,819.00</vehicleLowestPrice>
        <vehicleAveragePrice>$37,714.00</vehicleAveragePrice>
    </vehicleMetricInfo>
    <vehicleMetricInfo>
        <summaryDate>2016-06-22 00:00:00</summaryDate>
        <vehicleMake>Acura</vehicleMake>
        <vehicleModel>MDX</vehicleModel>
        <trim>3.5L</trim>
        <vehicleYear>2014</vehicleYear>
        <zipCode>10538</zipCode>
        <cpoIndicator>N</cpoIndicator>
        <totalVehicleCount>12</totalVehicleCount>
        <vehicleHighestPrice>$39,217.00</vehicleHighestPrice>
        <vehicleLowestPrice>$34,755.00</vehicleLowestPrice>
        <vehicleAveragePrice>$36,355.92</vehicleAveragePrice>
    </vehicleMetricInfo>
    <vehicleMetricInfo>
        <summaryDate>2016-06-22 00:00:00</summaryDate>
        <vehicleMake>Acura</vehicleMake>
        <vehicleModel>MDX</vehicleModel>
        <trim>3.5L</trim>
        <vehicleYear>2014</vehicleYear>
        <zipCode>10538</zipCode>
        <cpoIndicator>Y</cpoIndicator>
        <totalVehicleCount>6</totalVehicleCount>
        <vehicleHighestPrice>$37,321.00</vehicleHighestPrice>
        <vehicleLowestPrice>$32,770.00</vehicleLowestPrice>
        <vehicleAveragePrice>$35,624.17</vehicleAveragePrice>
    </vehicleMetricInfo>
    <vehicleMetricInfo>
        <summaryDate>2016-06-23 00:00:00</summaryDate>
        <vehicleMake>Acura</vehicleMake>
        <vehicleModel>MDX</vehicleModel>
        <trim>3.5L</trim>
        <vehicleYear>2014</vehicleYear>
        <zipCode>10538</zipCode>
        <cpoIndicator>Y</cpoIndicator>
        <totalVehicleCount>5</totalVehicleCount>
        <vehicleHighestPrice>$37,321.00</vehicleHighestPrice>
        <vehicleLowestPrice>$34,324.00</vehicleLowestPrice>
        <vehicleAveragePrice>$36,195.00</vehicleAveragePrice>
    </vehicleMetricInfo>
    <vehicleMetricInfo>
        <summaryDate>2016-06-23 00:00:00</summaryDate>
        <vehicleMake>Acura</vehicleMake>
        <vehicleModel>MDX</vehicleModel>
        <trim>3.5L Technology Package</trim>
        <vehicleYear>2014</vehicleYear>
        <zipCode>10538</zipCode>
        <cpoIndicator>N</cpoIndicator>
        <totalVehicleCount>16</totalVehicleCount>
        <vehicleHighestPrice>$39,116.00</vehicleHighestPrice>
        <vehicleLowestPrice>$34,786.00</vehicleLowestPrice>
        <vehicleAveragePrice>$37,201.13</vehicleAveragePrice>
    </vehicleMetricInfo>
</vehicleDetailsResult>

Response JSON example
{
  "VehicleDetailsResult": {
    "vehicleMetricInfo": [
      {
        "summaryDate": "2016-06-22 00:00:00",
        "vehicleMake": "Acura",
        "vehicleModel": "MDX",
        "trim": "3.5L Technology Package",
        "vehicleYear": "2014",
        "zipCode": "10538",
        "cpoIndicator": "N",
        "totalVehicleCount": "16",
        "vehicleHighestPrice": "$39,116.00",
        "vehicleLowestPrice": "$34,786.00",
        "vehicleAveragePrice": "$37,201.13"
      },
      {
        "summaryDate": "2016-06-22 00:00:00",
        "vehicleMake": "Acura",
        "vehicleModel": "MDX",
        "trim": "3.5L Technology Package",
        "vehicleYear": "2014",
        "zipCode": "10538",
        "cpoIndicator": "Y",
        "totalVehicleCount": "3",
        "vehicleHighestPrice": "$39,302.00",
        "vehicleLowestPrice": "$36,819.00",
        "vehicleAveragePrice": "$37,714.00"
      },
      {
        "summaryDate": "2016-06-22 00:00:00",
        "vehicleMake": "Acura",
        "vehicleModel": "MDX",
        "trim": "3.5L",
        "vehicleYear": "2014",
        "zipCode": "10538",
        "cpoIndicator": "N",
        "totalVehicleCount": "12",
        "vehicleHighestPrice": "$39,217.00",
        "vehicleLowestPrice": "$34,755.00",
        "vehicleAveragePrice": "$36,355.92"
      },
      {
        "summaryDate": "2016-06-22 00:00:00",
        "vehicleMake": "Acura",
        "vehicleModel": "MDX",
        "trim": "3.5L",
        "vehicleYear": "2014",
        "zipCode": "10538",
        "cpoIndicator": "Y",
        "totalVehicleCount": "6",
        "vehicleHighestPrice": "$37,321.00",
        "vehicleLowestPrice": "$32,770.00",
        "vehicleAveragePrice": "$35,624.17"
      },
      {
        "summaryDate": "2016-06-23 00:00:00",
        "vehicleMake": "Acura",
        "vehicleModel": "MDX",
        "trim": "3.5L",
        "vehicleYear": "2014",
        "zipCode": "10538",
        "cpoIndicator": "Y",
        "totalVehicleCount": "5",
        "vehicleHighestPrice": "$37,321.00",
        "vehicleLowestPrice": "$34,324.00",
        "vehicleAveragePrice": "$36,195.00"
      },
      {
        "summaryDate": "2016-06-23 00:00:00",
        "vehicleMake": "Acura",
        "vehicleModel": "MDX",
        "trim": "3.5L Technology Package",
        "vehicleYear": "2014",
        "zipCode": "10538",
        "cpoIndicator": "N",
        "totalVehicleCount": "16",
        "vehicleHighestPrice": "$39,116.00",
        "vehicleLowestPrice": "$34,786.00",
        "vehicleAveragePrice": "$37,201.13"
      }
    ]
  }
}

 

No Match Response

No Match Response Example
{
  "VehicleDetailsResult": {
    "message": " No Cars.com Make_Year match. We have the following Model(s) available for Year 2014, Make - Acura",
    "vehicleMetricInfo": [
      {
        "vehicleMake": "Acura",
        "vehicleModel": "MDX",
        "vehicleYear": "2014"
      },
      {
        "vehicleMake": "Acura",
        "vehicleModel": "RDX",
        "vehicleYear": "2014"
      },
      {
        "vehicleMake": "Acura",
        "vehicleModel": "TL",
        "vehicleYear": "2014"
      },
      {
        "vehicleMake": "Acura",
        "vehicleModel": "TSX",
        "vehicleYear": "2014"
      },
      {
        "vehicleMake": "Acura",
        "vehicleModel": "ILX",
        "vehicleYear": "2014"
      },
      {
        "vehicleMake": "Acura",
        "vehicleModel": "ILX Hybrid",
        "vehicleYear": "2014"
      },
      {
        "vehicleMake": "Acura",
        "vehicleModel": "RLX",
        "vehicleYear": "2014"
      },
      {
        "vehicleMake": "Acura",
        "vehicleModel": "RLX Sport Hybrid",
        "vehicleYear": "2014"
      }
    ]
  }
}

 

No Summary Data Response

No Summary Data Response Example
{
  "VehicleDetailsResult": {
    "message": " No market summary data found for - Make - Acura, Model - MDX, Year - 2014, CpoIndicator - [N] in ZipCode(s)- [12345]",
    "vehicleMetricInfo": []
  }
}
Test
Method Type: 
GET
Endpoint URI: 
https://api.cars.com/VehicleMarketSummary/1.0/rest/reports/vehicledetails/metrics