GET /v1/vehicles/options

The values each of a Vehicle field's list filters accepts, other than makes and models.

Request

No body, no query parameters.

curl https://api.alchemy.example/v1/vehicles/options \
  -H "X-Api-Key: YOUR_API_KEY"

Response

An object with one array per filter:

Property	Filter
`bodyCategories`	`bodyCategories`
`drives`	`drives`
`powertrains`	`powertrains`
`registrationRegions`	`registrationStates`, or its synonym `registrationRegions`
`transmissionTypes`	`transmissionTypes`
`vehicleClasses`	`vehicleClasses`

Every array except registrationRegions contains { value, label, firstYear, lastYear, vehicles }, alphabetical by label. value is the value the filter accepts, label is the same value written for display, firstYear and lastYear are the earliest and latest model years with that value, and vehicles is the number of vehicle configurations with that value.

registrationRegions contains { value, label }, alphabetical by label. value is the state's two-letter code and label is its name. These entries have no model years or counts, because the registration state does not depend on the vehicle.

{
  "bodyCategories": [
    { "value": "Car", "label": "Car", "firstYear": 1990, "lastYear": 2025, "vehicles": 1000 },
    { "value": "SportUtility", "label": "Sport Utility Vehicle", "firstYear": 1990, "lastYear": 2025, "vehicles": 1000 }
  ],
  "drives": [
    { "value": "FrontWheel", "label": "Front-Wheel Drive", "firstYear": 1990, "lastYear": 2025, "vehicles": 1000 }
  ],
  "powertrains": [
    { "value": "PlugInHybrid", "label": "Plug-in Hybrid", "firstYear": 2010, "lastYear": 2025, "vehicles": 100 }
  ],
  "registrationRegions": [
    { "value": "AL", "label": "Alabama" },
    { "value": "AK", "label": "Alaska" }
  ],
  "transmissionTypes": [
    { "value": "ContinuouslyVariable", "label": "Continuously Variable", "firstYear": 1990, "lastYear": 2025, "vehicles": 1000 }
  ],
  "vehicleClasses": [
    { "value": "Compact Cars", "label": "Compact Cars", "firstYear": 1990, "lastYear": 2025, "vehicles": 1000 }
  ]
}

The entries above are an example. Call the endpoint for the current lists and values.

Pass value back to the filter, not label. A registrationRegions value goes in the state of a registrationStates entry:

{
  "type": "Vehicle",
  "powertrains": ["PlugInHybrid"],
  "vehicleClasses": ["Compact Cars"],
  "registrationStates": [{ "state": "AL" }],
  "map": { "model": { "column": "model", "dataType": "VarChar" } }
}

Requires an API key (see Authentication) but is not billed.

Table of Contents

GET /v1/vehicles/options

Request

Response