Premium. Simple Vehicle Market Report Over Arbitrary Locations and Vehicles.

v1.0.0

Premium. Provides the average, stdDev, and count, of the sale price and mileage of similar new or used vehicles based off the provided VIN and matching the provided other search criteria. This endpoint can be easily used to determine market values in arbitrary geographic locations (like a city) for specific vehicles. See /listings2 endpoint for documentation on location, vehicle, and time search parameters. Date selection is restricted by your subscription tier, same as with the /listings2 endpoint. Optionally restricts report to vehicles of the same model year.

Input

{
  "type": "object",
  "properties": {
    "daysBack": {
      "type": "integer"
    },
    "dealerID": {
      "type": "integer"
    },
    "endDate": {
      "type": "string",
      "format": "date"
    },
    "extendedSearch": {
      "type": "boolean"
    },
    "jwt": {
      "type": "string"
    },
    "latitude": {
      "type": "number"
    },
    "longitude": {
      "type": "number"
    },
    "mileageHigh": {
      "type": "integer"
    },
    "mileageLow": {
      "type": "integer"
    },
    "newCars": {
      "type": "boolean"
    },
    "radius": {
      "type": "number"
    },
    "regionName": {
      "type": "string"
    },
    "sameYear": {
      "type": "boolean"
    },
    "startDate": {
      "type": "string",
      "format": "date"
    },
    "vin": {
      "type": "string"
    },
    "zipCode": {
      "type": "integer"
    }
  },
  "required": [
    "jwt",
    "vin"
  ],
  "additionalProperties": false
}

Output

{
  "type": "object",
  "required": [
    "data",
    "endDate",
    "startDate"
  ],
  "properties": {
    "brandName": {
      "type": "string"
    },
    "cacheTimeLimit": {
      "type": "integer"
    },
    "condition": {
      "type": "string"
    },
    "data": {
      "type": "object",
      "required": [
        "daysBack",
        "mileCount",
        "milesAvg",
        "milesStdDev",
        "newCount",
        "newSaleAvg",
        "newSaleStdDev",
        "usedCount",
        "usedSaleAvg",
        "usedSaleStdDev"
      ],
      "properties": {
        "daysBack": {
          "type": "integer"
        },
        "mileCount": {
          "type": "integer"
        },
        "milesAvg": {
          "type": "number"
        },
        "milesStdDev": {
          "type": "number"
        },
        "newCount": {
          "type": "integer"
        },
        "newSaleAvg": {
          "type": "number"
        },
        "newSaleStdDev": {
          "type": "number"
        },
        "usedCount": {
          "type": "integer"
        },
        "usedSaleAvg": {
          "type": "number"
        },
        "usedSaleStdDev": {
          "type": "number"
        }
      }
    },
    "endDate": {
      "type": "string",
      "format": "date"
    },
    "modelName": {
      "type": "string"
    },
    "msg": {
      "type": "string"
    },
    "regionName": {
      "type": "string"
    },
    "startDate": {
      "type": "string",
      "format": "date"
    }
  }
}