About Our Car Options Lists
Our Car Options List API provides details of manufacturers' fitted Options for each model derivative for around 6,000 new cars currently for sale in the UK.
Dataset
The dataset provides a list of the Options for a specified car including the manufacturer's description of the item and the CAP-HPI item code (for additional referencing).
The dataset can be provided in 'JSON' or 'XML' format. You can choose the type of data returned in your HTTPS request by declaring 'json' or 'xml' in the 'd_Type' element of the request string.
JSON is the default type for the dataset if no 'd_Type' is set.
Our Demo
Our demonstrator provides an illustration of how the API delivers Options lists for cars using XML.
To obtain a Options list for a vehicle just choose a manufacturer, then a range and model from the list boxes below.
We will display the relative HTTPS {GET} requests for each stage of car selection; you can copy and paste the sample request strings into a browser address bar to see the raw XML data returned for the request (right click on the browser page displayed and you will see the XML dataset).
You can also substitute XML for JSON when you perform the 'copy|paste' exercise.
As each vehicle model selection is made the returned dataset in our demo also includes the vehicle derivative's CAP-HPI ID code ('CAPID'), manufacturer, range and model name for verification.
{GET} Requirements
The {GET} request follows HTTPS key:value pair protocols. No response will be given for an HTTP request.
The {GET} request for a car's Options list only requires our security login/session token and the car's CAPID.
The manufacturer, range and model name are not required for the calculation, but these items will be returned as part of the dataset for verification purposes.
The CAPID must be for a vehicle currently for sale new in the UK - a CAPID for a discontinued model or retired derivative will not return a dataset.
A dataset will only be provided where CAP-HPI has published a Options list for a vehicle - new vehicle model ranges/derivatives may not return a dataset.
Data Retrieval
Once you have selected a vehicle below click on the 'Options' button to see a returned dataset.
You will also see the entire {GET} request string as an example and the returned dataset structured as a typical online representation of XML for the car.
This will include the dataset XML node descriptions so that you can see the schema.
The returned dataset for car options provides:
- A listing of the options available for a car
- The CAP code for the option
- The status of the option as a default (see below)
- The basic price of the option, that VAT on the option price and the VAT inclusive price
Once you've gone through the selection process you can also see a sample implementation of the Options list.
Click on the 'View Sample Implementation' button to open a new browser window with a sample web display page.
Security
A session token is created on initial login and must be included as a cookie with all HTTPS requests or the request will fail.
If the user's browser does not allow functional cookies then the {GET} request will become orphaned and the request cannot be linked to any other requests in the same session.
If the session token is not included then the session will be terminated, any data created in the session may be erased at the server and the user may need to re-authenticate with a new session.
For security reasons the HTTPS protocol must be used for all {GET} requests so that all data passed between the browser and the server is encrypted, including the session token.
Pair:Value Summary
d_type: xml or json for the required return data type (json if not specified)
CAPID: valid CAPID for a car not discontinued