The Available Options Packages API retrieves all manufacturer options packages available for a specific vehicle identified by its VIN. This endpoint leverages NeoVIN decoder data to provide comprehensive information about factory-available options, including option codes, names, and MSRP values.
This API is useful for applications that need to display all possible configuration options for a vehicle, such as automotive marketplaces, vehicle configurators, and inventory management systems.
GET https://api.marketcheck.com/v2/decode/car/neovin/{vin}/options-packages
Path Parameters:
vin: The 17-character VIN of the vehicle to retrieve options for.The following example demonstrates a basic request to the Available Options Packages API:
import axios from 'axios';
const options = {
method: 'GET',
url: 'https://api.marketcheck.com/v2/decode/car/neovin/3GNKBHR48PS212775/options-packages',
params: {api_key: 'YOUR_API_KEY'},
headers: {Accept: 'application/json'}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}
The Available Options Packages API returns all available manufacturer options packages for a vehicle using NeoVIN decoder data. The request requires a valid 17-character VIN provided as a path parameter.
Available parameters for options packages requests:
Your MarketCheck API authentication key. Required for every request, unless OAuth is used.
The following parameters are required for options packages requests:
The Available Options Packages API returns a JSON object containing the VIN, country, and an array of available options packages.
interface Response {
vin: string; // Vehicle Identification Number
country: string; // Country of the decoded vehicle
available_options_packages: AvailableOptionPackage[]; // Array of available options
}
interface AvailableOptionPackage {
code: string; // Option package code
name: string; // Option package name
msrp: string; // MSRP of the option package
}
| Status Code | Description | Common Causes |
|---|---|---|
| 400 | Bad Request | VIN is too short (less than 17 characters) |
| 401 | Unauthorized | Missing or invalid API key |
| 403 | Forbidden | API key does not have access to this endpoint |
| 422 | Unprocessable Entity | Unable to get available options for the specified VIN |
| 429 | Too Many Requests | Rate limit exceeded |
| 500 | Internal Server Error | Temporary server issues |
Example Error Responses:
Invalid VIN length (400):
{
"code": 400,
"message": "Request validation failed: Parameter (vin) is too short (16 chars), minimum 17"
}
VIN not found or decode unavailable (422):
{
"code": 422,
"message": "Unable to get available options for {vin}"
}
Use this endpoint to get a complete list of all manufacturer options packages available for a specific vehicle. This is useful for displaying configuration options, understanding the full range of features available for a VIN, and for vehicle valuation and comparison purposes.
Example:
Here we're retrieving all available options packages for a vehicle:
import axios from 'axios';
const options = {
method: 'GET',
url: 'https://api.marketcheck.com/v2/decode/car/neovin/3GNKBHR48PS212775/options-packages',
params: {api_key: 'YOUR_API_KEY'},
headers: {Accept: 'application/json'}
};
try {
const { data } = await axios.request(options);
console.log(data);
} catch (error) {
console.error(error);
}