Lua

UK Vehicle Data VRM Lookup

See more REST Examples

Demonstrates how to query the UK Vehicle Data VRM online API's. (See https://ukvehicledata.co.uk/) Lua

local chilkat = require("chilkat")

-- This example requires the Chilkat API to have been previously unlocked.
-- See Global Unlock Sample for sample code.

local rest = chilkat.Rest.new()

-- Connect using TLS.
local bAutoReconnect = true
local success = rest:connect("uk1.ukvehicledata.co.uk", 443, true, bAutoReconnect)
if not success then
    print(rest.last_error_text)
    return
end

-- Replace UKVD-API-KEY with your actual API KEY,
-- which looks something like "abcdb1234-0abc-1235-abcf-1234c3d1abcd"
rest.authorization = "ukvd-ipwhitelist UKVD-API-KEY"

-- Replace "ABCDE" with a real VRM...
rest:add_query_param("key_vrm", "ABCDE")

-- Add the Content-Type HTTP request header.
-- success = rest.AddHeader("Content-Type","application/json; charset=UTF-8");

-- This request gets vehicle data.
-- See below for a request to get battery data.
local jsonResponseStr = rest:full_request_no_body("GET", "/api/datapackage/vehicledata")
if not rest.last_method_success then
    print(rest.last_error_text)
    return
end

if rest.response_status_code ~= 200 then
    print("Response Status Code = " .. rest.response_status_code)
    print(jsonResponseStr)
    return
end

local json = chilkat.JsonObject.new()
json:load(jsonResponseStr)
json.emit_compact = false

-- Show the JSON response.
print(json:emit())

-- A sample vehicledata response will be as shown below.
-- To get a few bits of data from the response:
print("RequestGuid: " .. json:string_of("RequestGuid"))
print("EngineNumber: " .. json:string_of("DataItems.EngineNumber"))
print("Vrm: " .. json:string_of("DataKeys.Vrm"))

-- {
--   "RequestGuid": "xxxxxxxx-cc72-4b63-xxxxxxxxxxxx",
--   "StatusCode": 0,
--   "StatusMessage": "Success",
--   "PackageId": "xxxxxxxx-a4bc-4a84-af22-xxxxxxxxxxxx",
--   "PackageVersion": 1,
--   "DataKeys": {
--     "Vrm": "ABCDE"
--   },
--   "DataItems": {
--     "DriveAxle": "4x2",
--     "Exported": "False",
--     "DriverSeatPosition": "RHD",
--     "EngineNumber": "LN910940728622",
--     "Class": "Sport",
--     "ImportedNorthernIreland": "False",
--     "HistoryPreviousKeeperAcquisitionDate": "2013-01-12",
--     "RoadFundLicenseSixMonth": "�126.50",
--     "EnginePowerBhp": "262",
--     "SpecDateRangeFrom": "1987-10-01",
--     "RegistrationDateUK": "1994-08-03",
--     "SoundLevelDriveBy": "0",
--     "RoadFundLicenseTwelveMonth": "�235.00",
--     "RoadFundLicenseBand": "Not available",
--     "Vrm": "J5YVK",
--     "TrimCode": "BA",
--     "Derivative": "S4",
--     "EngineSizeCc": "2174",
--     "EngineCylinderCount": "4",
--     "HistoryLatestV5cIssueDate": "2015-05-12",
--     "Category": "Car",
--     "HistoryPreviousKeeperCount": "9",
--     "ConditionScrapped": "False",
--     "EngineValveCount": "16",
--     "WeightUnladen": "0",
--     "RoadFundLicenseRenewalDate": "2017-04-01",
--     "Model": "Esprit",
--     "SpecDateRangeTo": "2003-06-01",
--     "RoadFundLicenseCurrentStatus": "Tax not due",
--     "BuildYear": "1994",
--     "BuildDate": "1994-12-31",
--     "VinLast4": "1448",
--     "GearCount": "5",
--     "SeatCount": "2",
--     "Make": "Lotus",
--     "Vin": "SCC082910RHA61448",
--     "ColourChangeCount": "0",
--     "DriveType": "Rear Wheel Drive",
--     "WeightGross": "0",
--     "EngineCode": "N/A",
--     "EnginePowerKw": "193",
--     "SoundLevelEngineSpeed": "0",
--     "ConditionUnscrapped": "False",
--     "HistoryPreviousKeeperDisposalDate": "2014-04-26",
--     "EngineAlignment": "Longitudinal",
--     "Imported": "False",
--     "BodyType": "Coupe",
--     "EnginePosition": "Mid",
--     "TransmissionType": "Manual",
--     "WeightFullyLaden": "0",
--     "SoundLevelStationary": "0",
--     "FuelType": "Petrol",
--     "Colour": "YELLOW",
--     "EngineSizeLitre": "2.2",
--     "RegistrationDate": "1994-08-03",
--     "Co2Emissions": "000",
--     "WeightMaxTowingUnbraked": "0",
--     "HistoryCurrentKeeperAcquisitionDate": "2015-04-25",
--     "WeightMaxTowingBraked": "0",
--     "DoorCount": "2",
--     "EngineCylinderConfig": "Inline",
--     "EngineFuelDelivery": "Turbo Injection"
--   }
-- }

-- -----------------------------------------------------------------------------------
-- Now get battery data...
jsonResponseStr = rest:full_request_no_body("GET", "/api/datapackage/batterydata")
if not rest.last_method_success then
    print(rest.last_error_text)
    return
end

if rest.response_status_code ~= 200 then
    print("Response Status Code = " .. rest.response_status_code)
    print(jsonResponseStr)
    return
end

json:load(jsonResponseStr)

-- Show the JSON response containing battery data.
print(json:emit())

-- To get a few pieces of information out of the response...
local numBatteries = json:size_of_array("DataItems.BatteryList")
local i = 0
while i < numBatteries do
    json.i = i
    print("---- Battery " .. i .. ":")
    print("  Type = " .. json:string_of("DataItems.BatteryList[I].Type"))
    print("  LayoutImage = " .. json:string_of("DataItems.BatteryList[I].LayoutImage"))
    print("  TerminalCode = " .. json:string_of("DataItems.BatteryList[I].TerminalCode"))
    i = i + 1
end

-- The battery data looks like this:
-- {
--   "RequestGuid": "xxxxxxxx-5030-4b3d-a2ed-xxxxxxxxxxxx",
--   "StatusCode": 0,
--   "StatusMessage": "Success",
--   "PackageId": "xxxxxxxx-9ec2-4fd3-9247-xxxxxxxxxxxx",
--   "PackageVersion": 1,
--   "DataKeys": {
--     "Vrm": "ABCDE"
--   },
--   "DataItems": {
--     "BatteryList": [
--       {
--         "Type": "Primary",
--         "UkRef": "075",
--         "LayoutCode": "0",
--         "LayoutImage": "http://cdn.ukvehicledata.co.uk/battery/layout/0.png",
--         "TerminalCode": "T1",
--         "TerminalImage": "http://cdn.ukvehicledata.co.uk/battery/terminal/T1.png",
--         "HoldDownCode": "B13",
--         "HoldDownImage": "http://cdn.ukvehicledata.co.uk/battery/holddown/B13.png"
--       }
--     ],
--     "BatteryCount": "1"
--   }
-- }