complete (2).json

{"openapi":"3.0.3","info":{"title":"One Auto API","description":"Subscribe and generate an api key on our website: [https://www.oneautoapi.com](https://www.oneautoapi.com)","version":"1.0.0"},"servers":[{"url":"https://sandbox.oneautoapi.com","description":"(Sandbox)"},{"url":"https://api.oneautoapi.com","description":"(LIVE)"}],"paths":{"/autopredict/predict/v2":{"get":{"tags":["AutoPredict"],"operationId":"autopredict_predict","summary":"Predict","description":"This endpoint predicts the number of years a vehicle will remain on the road.","parameters":[{"name":"vehicle_registration_mark","in":"query","description":"Vehicle registration number","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"description":"Whether the api call was successful"},"result":{"type":"object","properties":{"vehicle_registration_mark":{"type":"string","example":"AB21ABC","description":"Vehicle registration number"},"years_left_prediction":{"type":"integer","example":1,"description":"The number of predicted years vehicle will remain on the road."},"prediction_string":{"type":"string","example":"1-2","description":"The predicted year range the vehicle will remain on the road."},"one_year_prediction":{"type":"number","example":0.12,"description":"The percentage likelihood of the vehicle lasting the next 12 months."}}},"error":{"type":"string","example":"If there is an error the message would go here","description":"Details of what went wrong with the api call"}}}}}}},"security":[{"x-api-key":[]}]}},"/autopredict/statistics/v2":{"get":{"tags":["AutoPredict"],"operationId":"autopredict_statistics","summary":"Statistics","description":"This endpoint provides manufacturer and model statistics to predict how long the vehicle is likely to remain on the road. This endpoint provides manufacturer and model statistics to predict how long the vehicle is likely to remain on the road.","parameters":[{"name":"vehicle_registration_mark","in":"query","description":"Vehicle registration number","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"description":"Whether the api call was successful"},"result":{"type":"object","properties":{"vehicle_registration_mark":{"type":"string","example":"AB21ABC","description":"Vehicle registration number"},"averages_data":{"type":"object","properties":{"manufacturer_average_final_miles":{"type":"integer","example":123456,"description":"The average number of final miles vehicles of this manufacturer complete."},"model_average_final_miles":{"type":"integer","example":123456,"description":"The average number of final miles vehicles of this model type completes."},"manufacturer_average_final_age":{"type":"integer","example":12,"description":"The average final age of vehicles of this manufacturer."},"model_average_final_age":{"type":"integer","example":12,"description":"The average final age of vehicles of this model."}}},"number_left_data":{"type":"object","properties":{"manufacturer_model_year_initially_registered":{"type":"integer","example":12345,"description":"The number of vehicles of this manufacturer and model year initially registered."},"manufacturer_model_year_currently_licensed":{"type":"integer","example":12345,"description":"The number of vehicles of this manufacturer and model year currently licenced."},"manufacturer_model_year_currently_sorn":{"type":"integer","example":123,"description":"The number of vehicles of this manufacturer and model year currently SORN."},"manufacturer_model_year_percentage_left":{"type":"number","example":0.12,"description":"The percentage of vehicles of this manufacturer and modelf year that remain on the road."}}}}},"error":{"type":"string","example":"If there is an error the message would go here","description":"Details of what went wrong with the api call"}}}}}}},"security":[{"x-api-key":[]}]}},"/autotrader/futurevaluationsfromid/currentmileage/v2":{"get":{"tags":["Autotrader"],"operationId":"autotrader_futurevaluationsfromid_currentmileage","summary":"Future Values from Current Mileage","description":"This endpoint returns two forecast valuations (Retail and Trade) and Auto Trader Derivative ID, for vehicles with a maximum age of 12 years and a maximum forecast of 72 months. This endpoint returns two forecast valuations (Retail and Trade) and Auto Trader Derivative ID, for vehicles with a maximum age of 12 years and a maximum forecast of 72 months.","parameters":[{"name":"autotrader_derivative_id","in":"query","description":"Auto Trader identifier for the derivative of the vehicle","required":true,"schema":{"type":"string"}},{"name":"current_mileage","in":"query","description":"The current mileage of the vehicle in full","required":true,"schema":{"type":"integer"}},{"name":"first_registration_date","in":"query","description":"The date the vehicle was first registered. For new (unregistered) vehicles use today's date.","required":true,"schema":{"type":"string"}},{"name":"forecast_date","in":"query","description":"This is the date when the forecasted value is required.","required":true,"schema":{"type":"string"}},{"name":"miles_per_annum","in":"query","description":"The expected annual mileage","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"description":"Whether the api call was successful"},"result":{"type":"object","properties":{"forecast_retail_valuation":{"type":"integer","example":12345,"description":"The suggested future market average retail valuation for the specified vehicle"},"forecast_trade_valuation":{"type":"integer","example":12345,"description":"The suggested future market average trade valuation for the specified vehicle"},"autotrader_derivative_id":{"type":"string","example":"1a2b345cf6d789ef1g0111h2i13j141k","description":"The Auto Trader Derivative ID"}}},"error":{"type":"string","example":"If there is an error the message would go here","description":"Details of what went wrong with the api call"}}}}}}},"security":[{"x-api-key":[]}]}},"/autotrader/futurevaluationsfromid/futuremileage/v2":{"get":{"tags":["Autotrader"],"operationId":"autotrader_futurevaluationsfromid_futuremileage","summary":"Future Values from Future Mileage","description":"This endpoint returns two forecast valuations (Retail and Trade) and Auto Trader Derivative ID, for vehicles with a maximum age of 12 years and a maximum forecast of 72 months.","parameters":[{"name":"autotrader_derivative_id","in":"query","description":"Auto Trader identifier for the derivative of the vehicle","required":true,"schema":{"type":"string"}},{"name":"future_mileage","in":"query","description":"The mileage the vehicle will complete by the forecast date","required":true,"schema":{"type":"integer"}},{"name":"first_registration_date","in":"query","description":"The date the vehicle was first registered. For new (unregistered) vehicles use today's date.","required":true,"schema":{"type":"string"}},{"name":"forecast_date","in":"query","description":"This is the date when the forecasted value is required.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"description":"Whether the api call was successful"},"result":{"type":"object","properties":{"forecast_retail_valuation":{"type":"integer","example":12345,"description":"The suggested future market average retail valuation for the specified vehicle"},"forecast_trade_valuation":{"type":"integer","example":12345,"description":"The suggested future market average trade valuation for the specified vehicle"},"autotrader_derivative_id":{"type":"string","example":"1a2b345cf6d789ef1g0111h2i13j141k","description":"The Auto Trader Derivative ID"}}},"error":{"type":"string","example":"If there is an error the message would go here","description":"Details of what went wrong with the api call"}}}}}}},"security":[{"x-api-key":[]}]}},"/autotrader/futurevaluationsfromvrm/currentmileage/v2":{"get":{"tags":["Autotrader"],"operationId":"autotrader_futurevaluationsfromvrm_currentmileage","summary":"Future Values from Current Mileage","description":"This endpoint returns two forecast valuations (Retail and Trade) along with the description of the vehicle and Auto Trader Derivative ID, for vehicles with a maximum age of 12 years and a maximum forecast of 72 months. This endpoint returns two forecast valuations (Retail and Trade) along with the description of the vehicle and Auto Trader Derivative ID, for vehicles with a maximum age of 12 years and a maximum forecast of 72 months. , for vehicles with a maximum age of 12 years and a maximum forecast of 72 months.","parameters":[{"name":"vehicle_registration_mark","in":"query","description":"Vehicle registration number","required":true,"schema":{"type":"string"}},{"name":"current_mileage","in":"query","description":"The current mileage of the vehicle in full","required":true,"schema":{"type":"integer"}},{"name":"forecast_date","in":"query","description":"This is the date when the forecasted value is required.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"description":"Whether the api call was successful"},"result":{"type":"object","properties":{"vehicle_registration_mark":{"type":"string","example":"AB21ABC","description":"Vehicle registration number"},"first_registration_date":{"type":"string","example":"2020-01-01","description":"Date of first registration"},"autotrader_derivative_id":{"type":"string","example":"1a2b345cf6d789ef1g0111h2i13j141k","description":"The Auto Trader Derivative ID"},"vehicle_description":{"type":"string","example":"MINI Convertible 1.5 Cooper Convertible 2dr Petrol Manual (s/s) (136 ps)","description":"The make, model and derivative description of the vehicle"},"forecast_retail_valuation":{"type":"integer","example":12345,"description":"The suggested future market average retail valuation for the specified vehicle"},"forecast_trade_valuation":{"type":"integer","example":12345,"description":"The suggested future market average trade valuation for the specified vehicle"}}},"error":{"type":"string","example":"If there is an error the message would go here","description":"Details of what went wrong with the api call"}}}}}}},"security":[{"x-api-key":[]}]}},"/autotrader/futurevaluationsfromvrm/futuremileage/v2":{"get":{"tags":["Autotrader"],"operationId":"autotrader_futurevaluationsfromvrm_futuremileage","summary":"Future Values from Future Mileage","description":"This endpoint returns two forecast valuations (Retail and Trade) along with the description of the vehicle and Auto Trader Derivative ID, for vehicles with a maximum age of 12 years and a maximum forecast of 72 months.","parameters":[{"name":"vehicle_registration_mark","in":"query","description":"Vehicle registration number","required":true,"schema":{"type":"string"}},{"name":"future_mileage","in":"query","description":"he mileage the vehicle will complete by the forecast date","required":true,"schema":{"type":"integer"}},{"name":"forecast_date","in":"query","description":"This is the date when the forecasted value is required.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"description":"Whether the api call was successful"},"result":{"type":"object","properties":{"vehicle_registration_mark":{"type":"string","example":"AB21ABC","description":"Vehicle registration number"},"first_registration_date":{"type":"string","example":"2020-01-01","description":"Date of first registration"},"autotrader_derivative_id":{"type":"string","example":"1a2b345cf6d789ef1g0111h2i13j141k","description":"The Auto Trader Derivative ID"},"vehicle_description":{"type":"string","example":"MINI Convertible 1.5 Cooper Convertible 2dr Petrol Manual (s/s) (136 ps)","description":"The make, model and derivative description of the vehicle"},"forecast_retail_valuation":{"type":"integer","example":12345,"description":"The suggested future market average retail valuation for the specified vehicle"},"forecast_trade_valuation":{"type":"integer","example":12345,"description":"The suggested future market average trade valuation for the specified vehicle"}}},"error":{"type":"string","example":"If there is an error the message would go here","description":"Details of what went wrong with the api call"}}}}}}},"security":[{"x-api-key":[]}]}},"/autotrader/getderivativesfromautotradergenerationid/v2":{"get":{"tags":["Autotrader"],"operationId":"autotrader_getderivativesfromautotradergenerationid","summary":"Derivatives","description":"This endpoint returns all Auto Trader derivative IDs and descriptions for the selected generation of a model.","parameters":[{"name":"autotrader_generation_id","in":"query","description":"The Auto Trader identifier for that generation of vehicle","required":true,"schema":{"type":"string"}},{"name":"current_production","in":"query","description":"When supplying a \"true\" value will return only derivatives currently in production","required":false,"schema":{"type":"boolean"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"description":"Whether the api call was successful"},"result":{"type":"object","properties":{"derivatives_data":{"type":"array","items":{"properties":{"autotrader_derivative_id":{"type":"string","example":"1a2b345cf6d789ef1g0111h2i13j141k","description":"The Auto Trader Derivative ID"},"derivative_desc":{"type":"string","example":"2.0 Sport Premium Convertible 2dr Petrol Steptronic Euro 6 (s/s) (178 ps)","description":"EV Database’s model variant"}}}}}},"error":{"type":"string","example":"If there is an error the message would go here","description":"Details of what went wrong with the api call"}}}}}}},"security":[{"x-api-key":[]}]}},"/autotrader/getgenerationsfromautotradermodelid/v2":{"get":{"tags":["Autotrader"],"operationId":"autotrader_getgenerationsfromautotradermodelid","summary":"Generations","description":"This endpoint returns all Auto Trader generation ids and descriptions for the requested model range.","parameters":[{"name":"autotrader_model_id","in":"query","description":"Auto Trader identifier for the vehicle model range","required":true,"schema":{"type":"string"}},{"name":"current_production","in":"query","description":"When supplying a \"true\" value will return only generations currently in production","required":false,"schema":{"type":"boolean"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"description":"Whether the api call was successful"},"result":{"type":"object","properties":{"generations_data":{"type":"array","items":{"properties":{"autotrader_generation_id":{"type":"string","example":"1a2b345cf6d789ef1g0111h2i13j141k","description":"The Auto Trader identifier for that generation of vehicle"},"generation_desc":{"type":"string","example":"Convertible (2019- 2022)","description":"The generation description"}}}}}},"error":{"type":"string","example":"If there is an error the message would go here","description":"Details of what went wrong with the api call"}}}}}}},"security":[{"x-api-key":[]}]}},"/autotrader/getmanufacturersfromassettype/v2":{"get":{"tags":["Autotrader"],"operationId":"autotrader_getmanufacturersfromassettype","summary":"Manufacturers","description":"This endpoint returns all Auto Trader manufacturers for the chosen asset type i.e. car or van.","parameters":[{"name":"asset_type","in":"query","description":"The vehicle asset type i.e. Car or Van** Note asset_type must start with a upper case followed by lower case.","required":true,"schema":{"type":"string"}},{"name":"current_production","in":"query","description":"When supplying a \"true\" value will return only generations currently in production","required":false,"schema":{"type":"boolean"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"description":"Whether the api call was successful"},"result":{"type":"object","properties":{"manufacturers_data":{"type":"array","items":{"properties":{"manufacturer_desc":{"type":"string","example":"BMW","description":"Manufacturer description"},"autotrader_manufacturer_id":{"type":"string","example":"1a2b345cf6d789ef1g0111h2i13j141k","description":"The Auto Trader identifier for the vehicle manufacturer"}}}}}},"error":{"type":"string","example":"If there is an error the message would go here","description":"Details of what went wrong with the api call"}}}}}}},"security":[{"x-api-key":[]}]}},"/autotrader/getmodelrangesfromautotradermanufacturerid/v2":{"get":{"tags":["Autotrader"],"operationId":"autotrader_getmodelrangesfromautotradermanufacturerid","summary":"Model Ranges","description":"This endpoint returns the Auto Trader model range ids and descriptions for the requested manufacturer.","parameters":[{"name":"autotrader_manufacturer_id","in":"query","description":"The Auto Trader identifier for the vehicle manufacturer","required":true,"schema":{"type":"string"}},{"name":"current_production","in":"query","description":"When supplying a \"true\" value will return only model ranges currently in production.","required":false,"schema":{"type":"boolean"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"description":"Whether the api call was successful"},"result":{"type":"object","properties":{"modelranges_data":{"type":"array","items":{"properties":{"model_range_desc":{"type":"string","example":"Hatch","description":"Model range description"},"autotrader_model_id":{"type":"string","example":"1a2b345cf6d789ef1g0111h2i13j141k","description":"Auto Trader identifier for the vehicle model range"}}}}}},"error":{"type":"string","example":"If there is an error the message would go here","description":"Details of what went wrong with the api call"}}}}}}},"security":[{"x-api-key":[]}]}},"/autotrader/inventoryaugmentationfromvrm/v2":{"get":{"tags":["Autotrader"],"operationId":"autotrader_inventoryaugmentationfromvrm","summary":"Inventory Augmentation from VRM","description":"In addition to Auto Trader's Vehicle Lookup service this endpoint also returns standard and optional features available on the vehicle at the date of registration.","parameters":[{"name":"vehicle_registration_mark","in":"query","description":"Vehicle registration number","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"description":"Whether the api call was successful"},"result":{"type":"object","properties":{"basic_vehicle_info":{"type":"object","properties":{"vehicle_registration_mark":{"type":"string","example":"AB21ABC","description":"Vehicle registration number"},"vehicle_identification_number":{"type":"string","example":"ABCDE123456F78910","description":"The vehicle identification number."},"first_registration_date":{"type":"string","example":"2020-01-01","description":"Date of first registration"},"country_of_origin":{"type":"string","example":"United Kingdom","description":"The country the vehicle was manufactured in"},"colour":{"type":"string","example":"Black","description":"Exterior colour of vehicle"},"autotrader_derivative_id":{"type":"string","example":"1a2b345cf6d789ef1g0111h2i13j141k","description":"The Auto Trader Derivative ID"},"autotrader_asset_type":{"type":"string","example":"Car","description":"Auto Trader's asset type"},"vehicle_sector":{"type":"string","example":"Supermini Conv","description":"The vehicle sector as defined by Auto Trader"},"manufacturer_desc":{"type":"string","example":"MINI","description":"Manufacturer description"},"model_range_desc":{"type":"string","example":"Convertible","description":"Model range description"},"generation_desc":{"type":"string","example":"Convertible (2015 - 2018)","description":"The generation description"},"derivative_desc":{"type":"string","example":"1.5 Cooper Convertible 2dr Petrol Manual (s/s) (136 ps)","description":"EV Database’s model variant"},"vehicle_description":{"type":"string","example":"MINI Convertible 1.5 Cooper Convertible 2dr Petrol Manual (s/s) (136 ps)","description":"The make, model and derivative description of the vehicle"},"trim_level_desc":{"type":"string","example":"Cooper","description":"The trim level description"},"autotrader_body_type_desc":{"type":"string","example":"Convertible","description":"Auto Trader's body type description"},"autotrader_fuel_type_desc":{"type":"string","example":"Petrol","description":"Auto Trader's fuel type"},"cab_type_desc":{"type":"string","example":"Crew cab","description":"The cab type"},"autotrader_transmission_desc":{"type":"string","example":"Manual","description":"Auto Trader's transmission description"},"wheelbase_type_desc":{"type":"string","example":"STD","description":"The wheelbase type description"},"roof_height_type_desc":{"type":"string","example":"Low","description":"The roof height description"},"autotrader_drivetrain_type_desc":{"type":"string","example":"Front Wheel Drive","description":"Auto Trader's drivetrain description"},"drive_type_desc":{"type":"string","example":"4X2","description":"The drive type description"},"number_seats":{"type":"integer","example":4,"description":"Number of seats"},"number_doors":{"type":"integer","example":2,"description":"The number of doors"},"number_gears":{"type":"integer","example":6,"description":"Number of gears"},"number_axles":{"type":"integer","example":2,"description":"The number of axles"},"style":{"type":"string","example":"tractor","description":"The style of vehicle"},"substyle":{"type":"string","example":"large tractor","description":"The substyle of vehicle"}}},"insurance_data":{"type":"object","properties":{"insurance_group_1to50":{"type":"string","example":"22","description":"The 1-50 insurance group"},"insurance_security_code":{"type":"string","example":"E","description":"The Insurance group rating"}}},"performance_data":{"type":"object","properties":{"top_speed_mph":{"type":"integer","example":123,"description":"The top speed (mph)"},"0to60_mph":{"type":"number","example":12.3,"description":"The number of seconds to go from Zero to 60 mph"},"0to100_kmph":{"type":"number","example":12.3,"description":"The number of seconds to go from Zero to 100 kmph"}}},"weight_dimension_capacities_data":{"type":"object","properties":{"vehicle_length_mm":{"type":"integer","example":1234,"description":"The vehicle length in mm"},"vehicle_height_mm":{"type":"integer","example":1234,"description":"The vehicle height in mm"},"vehicle_width_mm":{"type":"integer","example":1234,"description":"The vehicle width in mm"},"vehicle_wheelbase_mm":{"type":"integer","example":1234,"description":"The vehicle wheelbase in mm"},"bootspace_seats_up_litres":{"type":"integer","example":123,"description":"The bootspace with seats up in litres"},"bootspace_seats_down_litres":{"type":"integer","example":123,"description":"The bootspace with seats down in litres"},"payload_length_mm":{"type":"integer","example":1234,"description":"The payload length in mm"},"payload_width_mm":{"type":"integer","example":1234,"description":"The payload width in mm"},"payload_height_mm":{"type":"integer","example":1234,"description":"The payload height in mm"},"payload_weight_kg":{"type":"integer","example":123,"description":"The payload weight in kg"},"payload_volume_cubicmetres":{"type":"integer","example":123,"description":"The payload volume in cubic metres"},"min_kerbweight_kg":{"type":"integer","example":1234,"description":"Minimum kerbweight in kg"},"gross_vehicleweight_kg":{"type":"integer","example":1234,"description":"Gross vehicle weight in kg"},"maximum_permissable_mass_kg":{"type":"integer","example":1234,"description":"Maximum permissable mass in kg"},"gross_trainweight_kg":{"type":"integer","example":1234,"description":"The gross train weight in kg"}}},"engine_data":{"type":"object","properties":{"engine_manufacturer":{"type":"string","example":"MINI","description":"The engine manufacturer"},"engine_number":{"type":"string","example":"AB12345","description":"Vehicle engine number"},"engine_badged_size_litres":{"type":"number","example":1.2,"description":"The engine badged size in litres"},"engine_capacity_cc":{"type":"integer","example":1234,"description":"Engine capacity in cc"},"engine_bore_mm":{"type":"integer","example":12,"description":"The engine bore in mm"},"engine_stroke_mm":{"type":"integer","example":12,"description":"The engine stroke in mm"},"fuel_delivery":{"type":"string","example":"Turbo Common Rail","description":"The fuel delivery"},"fuel_capacity_litres":{"type":"integer","example":12,"description":"The fuel capacity in litres"},"number_cylinders":{"type":"integer","example":3,"description":"The number of cylinders"},"cylinder_arrangement":{"type":"string","example":"Inline","description":"The cylinder arrangement"},"valve_gear":{"type":"string","example":"Double Overhead Camshaft","description":"The type of valve gear"},"valves":{"type":"integer","example":12,"description":"The number of valves"},"power_ps":{"type":"integer","example":123,"description":"The power ps"},"power_bhp":{"type":"number","example":123.5,"description":"The power bhp"},"torque_nm":{"type":"integer","example":123,"description":"The engine torque in nm"},"torque_lbft":{"type":"number","example":123.45,"description":"The engine torque in lb-ft"},"emission_class":{"type":"string","example":"Euro 6","description":"The emission class"},"is_rde_compliant":{"type":"boolean","example":true,"description":"Is the vehicle rde compliant"},"co2_gkm":{"type":"integer","example":123,"description":"CO2 in g/km"},"is_startstop":{"type":"boolean","example":true,"description":"Does the vehicle have start stop technology"},"nedc_extra_urban_mpg":{"type":"number","example":12.3,"description":"The NEDC number of miles per gallon B-road, A-road and motorway driving ICE"},"nedc_urban_mpg":{"type":"number","example":12.3,"description":"The NEDC number of miles per gallon city driving ICE and SCH"},"nedc_combined_mpg":{"type":"number","example":12.3,"description":"The NEDC Average miles per gallon between urban (city driving) and extra urban (B-road, A-road and motorway) driving ICE and SCH"},"wltp_low_mpg":{"type":"number","example":12.3,"description":"The WLTP number of miles per gallon tested under wltp at speeds up to 35mph"},"wltp_medium_mpg":{"type":"number","example":12.3,"description":"The WLTP number of miles per gallon tested under wltp at speeds up to 47mph"},"wltp_high_mpg":{"type":"number","example":12.3,"description":"The WLTP number of miles per gallon tested under wltp at speeds up to 60mph"},"wltp_extra_high_mpg":{"type":"number","example":12.3,"description":"The WLTP number of miles per gallon tested under wltp at speeds up to 81mph"},"wltp_combined_mpg":{"type":"number","example":12.3,"description":"The WLTP average number of miles per gallon tested under wltp (low, medium, high & extra high)"}}},"ev_data":{"type":"object","properties":{"battery_chargetime_mins":{"type":"integer","example":123,"description":"The battery charge time in minutes"},"battery_fast_chargetime_mins":{"type":"integer","example":123,"description":"The battery fast charge time in minutes"},"battery_range_miles":{"type":"integer","example":123,"description":"The battery's range in miles"},"battery_capacity_kwh":{"type":"integer","example":12,"description":"Battery capacity in kwh"},"battery_capacity_usable_kwh":{"type":"integer","example":12,"description":"Usable capacity (the amount of energy the car can actually draw on to propel itself) in kwh"}}},"oem_data":{"type":"object","properties":{"oem_manufacturer_desc":{"type":"string","example":"MINI","description":"The manufacturer description as supplied by manufacturer"},"oem_model_range_desc":{"type":"string","example":"Convertible","description":"The model range description as supplied by manufacturer"},"oem_derivative_desc":{"type":"string","example":"Cooper Convertible","description":"The derivative description as supplied by manufacturer"},"oem_body_type_desc":{"type":"string","example":"Convertible","description":"The body type description as supplied by manufacturer"},"oem_transmission_type_desc":{"type":"string","example":"Manual","description":"The transmission type description as supplied by manufacturer"},"oem_drivetrain_desc":{"type":"string","example":"Front wheel drive","description":"The drivetrain description as supplied by manufacturer"},"oem_wheelbase_type_desc":{"type":"string","example":"STD","description":"The wheelbase description as supplied by the manufacturer"},"oem_roof_height_type_desc":{"type":"string","example":"Low","description":"The roof height description as supplied by the manufacturer"},"oem_engine_type_desc":{"type":"string","example":"DIG-T","description":"The engine type description as supplied by manufacturer"},"oem_engine_tech_desc":{"type":"string","example":"TBC","description":"The engine technical description as supplied by manufacturer"},"oem_engine_desc":{"type":"string","example":"58kWh","description":"The engine description as supplied by manufacturer"},"oem_edition_desc":{"type":"string","example":"TBC","description":"The edition description as supplied by manufacturer"},"oem_colour":{"type":"string","example":"Midnight Black","description":"The exterior colour as supplied by manufacturer"}}},"basic_vehicle_check":{"type":"object","properties":{"insurance_writeoff_category":{"type":"string","example":"A","description":"The insurance write off category"},"is_stolen":{"type":"boolean","example":false,"description":"Is the vehicle stolen"},"is_scrapped":{"type":"boolean","example":false,"description":"Has the vehicle been scrapped."},"is_exported":{"type":"boolean","example":false,"description":"Vehicle is exported"},"is_imported":{"type":"boolean","example":false,"description":"Vehicle is imported"},"number_previous_keepers":{"type":"integer","example":1,"description":"The number of previous keepers."},"date_of_last_keeper_change":{"type":"string","example":"2020-01-01","description":"The date of last keeper change."},"previous_keeper_acquisition_date":{"type":"string","example":"2020-01-01","description":"The previous keepers acquisition date"}}},"features_data":{"type":"array","items":{"properties":{"feature_desc":{"type":"string","example":"12Volt Socket in Front Centre Console","description":"The feature description"},"feature_generic_desc":{"type":"string","example":"12V Socket","description":"The feature generic description"},"feature_status":{"type":"string","example":"Optional","description":"The feature status (default options priced at '£0' & can be swapped for alternative option)"},"is_factory_fitted":{"type":"boolean","example":false,"description":"Is the feature factory fitted"},"feature_category":{"type":"string","example":"Audio and Communications","description":"The feature category"},"list_price_ex_vat":{"type":"number","example":123.45,"description":"The list price excluding VAT"},"list_price_vat":{"type":"number","example":12.34,"description":"The list price VAT"},"list_price_inc_vat":{"type":"number","example":123.45,"description":"The list price including VAT"}}}}}},"error":{"type":"string","example":"If there is an error the message would go here","description":"Details of what went wrong with the api call"}}}}}}},"security":[{"x-api-key":[]}]}},"/autotrader/mrrpfromid/v2":{"get":{"tags":["Autotrader"],"operationId":"autotrader_mrrpfromid","summary":"MRRP from ID","description":"This endpoint returns the pricing history of a vehicle (basic price, VAT price, delivery price, VAT delivery price and basic + delivery VAT price). By using an effective date (optional parameter), you can return the pricing relevant to the chosen vehicle for that moment in time.","parameters":[{"name":"autotrader_derivative_id","in":"query","description":"Auto Trader identifier for the derivative of the vehicle","required":true,"schema":{"type":"string"}},{"name":"effective_date","in":"query","description":"This optional parameter will ensure the pricing relevant to the chosen vehicle for that moment in time is returned","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"description":"Whether the api call was successful"},"result":{"type":"object","properties":{"prices_data":{"type":"array","items":{"properties":{"effective_from_date":{"type":"string","example":"2020-01-01","description":"The date the price is effective from"},"effective_to_date":{"type":"string","example":"2020-01-01","description":"The date the price is effective to"},"list_price_ex_vat":{"type":"number","example":12345.67,"description":"The list price excluding VAT"},"list_price_vat":{"type":"number","example":1234.56,"description":"The list price VAT"},"delivery_price_ex_vat":{"type":"integer","example":12345,"description":"Delivery price excluding VAT"},"delivery_price_vat":{"type":"number","example":1234.56,"description":"The delivery price VAT"},"list_price_inc_delivery_vat":{"type":"number","example":12345.67,"description":"The list price + delivery price including VAT"}}}},"autotrader_derivative_id":{"type":"string","example":"1a2b345cf6d789ef1g0111h2i13j141k","description":"The Auto Trader Derivative ID"}}},"error":{"type":"string","example":"If there is an error the message would go here","description":"Details of what went wrong with the api call"}}}}}}},"security":[{"x-api-key":[]}]}},"/autotrader/specandtechdatafromid/v2":{"get":{"tags":["Autotrader"],"operationId":"autotrader_specandtechdatafromid","summary":"Technical Data & Features from ID","description":"This endpoint returns standard and optional items, a description of the vehicle, along with the vehicle's technical data. By using an effective date (optional parameter), you can return the pricing relevant to the chosen vehicle for that moment in time.","parameters":[{"name":"autotrader_derivative_id","in":"query","description":"Auto Trader identifier for the derivative of the vehicle","required":true,"schema":{"type":"string"}},{"name":"effective_date","in":"query","description":"Return the pricing relevant to the chosen vehicle for that moment in time.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"description":"Whether the api call was successful"},"result":{"type":"object","properties":{"basic_vehicle_info":{"type":"object","properties":{"country_of_origin":{"type":"string","example":"United Kingdom","description":"The country the vehicle was manufactured in"},"autotrader_derivative_id":{"type":"string","example":"1a2b345cf6d789ef1g0111h2i13j141k","description":"The Auto Trader Derivative ID"},"autotrader_asset_type":{"type":"string","example":"Car","description":"Auto Trader's asset type"},"vehicle_sector":{"type":"string","example":"Supermini Conv","description":"The vehicle sector as defined by Auto Trader"},"manufacturer_desc":{"type":"string","example":"MINI","description":"Manufacturer description"},"model_range_desc":{"type":"string","example":"Convertible","description":"Model range description"},"generation_desc":{"type":"string","example":"Convertible (2015 - 2018)","description":"The generation description"},"vehicle_description":{"type":"string","example":"MINI Convertible 1.5 Cooper Convertible 2dr Petrol Manual (s/s) (136 ps)","description":"The make, model and derivative description of the vehicle"},"trim_level_desc":{"type":"string","example":"Cooper","description":"The trim level description"},"autotrader_body_type_desc":{"type":"string","example":"Convertible","description":"Auto Trader's body type description"},"autotrader_fuel_type_desc":{"type":"string","example":"Petrol","description":"Auto Trader's fuel type"},"cab_type_desc":{"type":"string","example":"Crew cab","description":"The cab type"},"autotrader_transmission_desc":{"type":"string","example":"Manual","description":"Auto Trader's transmission description"},"wheelbase_type_desc":{"type":"string","example":"STD","description":"The wheelbase type description"},"roof_height_type_desc":{"type":"string","example":"Low","description":"The roof height description"},"autotrader_drivetrain_type_desc":{"type":"string","example":"Front Wheel Drive","description":"Auto Trader's drivetrain description"},"drive_type_desc":{"type":"string","example":"4X2","description":"The drive type description"},"number_seats":{"type":"integer","example":4,"description":"Number of seats"},"number_doors":{"type":"integer","example":2,"description":"The number of doors"},"number_gears":{"type":"integer","example":6,"description":"Number of gears"},"number_axles":{"type":"integer","example":2,"description":"The number of axles"},"derivative_desc":{"type":"string","example":"1.5 Cooper Convertible (s/s) 2dr","description":"EV Database’s model variant"},"long_derivative_desc":{"type":"string","example":"1.5 Cooper Convertible 2dr Petrol Manual (s/s) (136 ps)","description":"Auto Trader's derivative description"},"introduced_date":{"type":"string","example":"2020-01-01","description":"The date the vehicle was available in the market from"},"discontinued_date":{"type":"string","example":"2020-01-01","description":"The date the vehicle was available to in the market"}}},"insurance_data":{"type":"object","properties":{"insurance_group_1to50":{"type":"string","example":"22","description":"The 1-50 insurance group"},"insurance_security_code":{"type":"string","example":"E","description":"The Insurance group rating"}}},"performance_data":{"type":"object","properties":{"top_speed_mph":{"type":"integer","example":123,"description":"The top speed (mph)"},"0to60_mph":{"type":"number","example":12.3,"description":"The number of seconds to go from Zero to 60 mph"},"0to100_kmph":{"type":"number","example":12.3,"description":"The number of seconds to go from Zero to 100 kmph"}}},"weight_dimension_capacities_data":{"type":"object","properties":{"vehicle_length_mm":{"type":"integer","example":1234,"description":"The vehicle length in mm"},"vehicle_height_mm":{"type":"integer","example":1234,"description":"The vehicle height in mm"},"vehicle_width_mm":{"type":"integer","example":1234,"description":"The vehicle width in mm"},"vehicle_wheelbase_mm":{"type":"integer","example":1234,"description":"The vehicle wheelbase in mm"},"bootspace_seats_up_litres":{"type":"integer","example":123,"description":"The bootspace with seats up in litres"},"bootspace_seats_down_litres":{"type":"integer","example":123,"description":"The bootspace with seats down in litres"},"payload_length_mm":{"type":"integer","example":1234,"description":"The payload length in mm"},"payload_width_mm":{"type":"integer","example":1234,"description":"The payload width in mm"},"payload_height_mm":{"type":"integer","example":1234,"description":"The payload height in mm"},"payload_weight_kg":{"type":"integer","example":123,"description":"The payload weight in kg"},"payload_volume_cubicmetres":{"type":"integer","example":123,"description":"The payload volume in cubic metres"},"min_kerbweight_kg":{"type":"integer","example":1234,"description":"Minimum kerbweight in kg"},"gross_vehicleweight_kg":{"type":"integer","example":1234,"description":"Gross vehicle weight in kg"},"gross_trainweight_kg":{"type":"integer","example":1234,"description":"The gross train weight in kg"}}},"engine_data":{"type":"object","properties":{"engine_manufacturer":{"type":"string","example":"MINI","description":"The engine manufacturer"},"engine_badged_size_litres":{"type":"number","example":1.2,"description":"The engine badged size in litres"},"engine_capacity_cc":{"type":"integer","example":1234,"description":"Engine capacity in cc"},"engine_bore_mm":{"type":"integer","example":12,"description":"The engine bore in mm"},"engine_stroke_mm":{"type":"integer","example":12,"description":"The engine stroke in mm"},"fuel_delivery":{"type":"string","example":"Turbo Common Rail","description":"The fuel delivery"},"fuel_capacity_litres":{"type":"integer","example":12,"description":"The fuel capacity in litres"},"number_cylinders":{"type":"integer","example":3,"description":"The number of cylinders"},"cylinder_arrangement":{"type":"string","example":"Inline","description":"The cylinder arrangement"},"valve_gear":{"type":"string","example":"Double Overhead Camshaft","description":"The type of valve gear"},"valves":{"type":"integer","example":12,"description":"The number of valves"},"power_ps":{"type":"integer","example":123,"description":"The power ps"},"power_bhp":{"type":"number","example":123.5,"description":"The power bhp"},"torque_nm":{"type":"integer","example":123,"description":"The engine torque in nm"},"torque_lbft":{"type":"number","example":123.45,"description":"The engine torque in lb-ft"},"emission_class":{"type":"string","example":"Euro 6","description":"The emission class"},"is_rde_compliant":{"type":"boolean","example":true,"description":"Is the vehicle rde compliant"},"co2_gkm":{"type":"integer","example":123,"description":"CO2 in g/km"},"is_startstop":{"type":"boolean","example":true,"description":"Does the vehicle have start stop technology"},"nedc_extra_urban_mpg":{"type":"number","example":12.3,"description":"The NEDC number of miles per gallon B-road, A-road and motorway driving ICE"},"nedc_urban_mpg":{"type":"number","example":12.3,"description":"The NEDC number of miles per gallon city driving ICE and SCH"},"nedc_combined_mpg":{"type":"number","example":12.3,"description":"The NEDC Average miles per gallon between urban (city driving) and extra urban (B-road, A-road and motorway) driving ICE and SCH"},"wltp_low_mpg":{"type":"number","example":12.3,"description":"The WLTP number of miles per gallon tested under wltp at speeds up to 35mph"},"wltp_medium_mpg":{"type":"number","example":12.3,"description":"The WLTP number of miles per gallon tested under wltp at speeds up to 47mph"},"wltp_high_mpg":{"type":"number","example":12.3,"description":"The WLTP number of miles per gallon tested under wltp at speeds up to 60mph"},"wltp_extra_high_mpg":{"type":"number","example":12.3,"description":"The WLTP number of miles per gallon tested under wltp at speeds up to 81mph"},"wltp_combined_mpg":{"type":"number","example":12.3,"description":"The WLTP average number of miles per gallon tested under wltp (low, medium, high & extra high)"}}},"ev_data":{"type":"object","properties":{"battery_chargetime_mins":{"type":"integer","example":123,"description":"The battery charge time in minutes"},"battery_fast_chargetime_mins":{"type":"integer","example":123,"description":"The battery fast charge time in minutes"},"battery_range_miles":{"type":"integer","example":123,"description":"The battery's range in miles"},"battery_capacity_kwh":{"type":"integer","example":12,"description":"Battery capacity in kwh"},"battery_capacity_usable_kwh":{"type":"integer","example":12,"description":"Usable capacity (the amount of energy the car can actually draw on to propel itself) in kwh"}}},"oem_data":{"type":"object","properties":{"oem_manufacturer_desc":{"type":"string","example":"MINI","description":"The manufacturer description as supplied by manufacturer"},"oem_model_range_desc":{"type":"string","example":"Convertible","description":"The model range description as supplied by manufacturer"},"oem_derivative_desc":{"type":"string","example":"Cooper Convertible","description":"The derivative description as supplied by manufacturer"},"oem_body_type_desc":{"type":"string","example":"Convertible","description":"The body type description as supplied by manufacturer"},"oem_transmission_type_desc":{"type":"string","example":"Manual","description":"The transmission type description as supplied by manufacturer"},"oem_drivetrain_desc":{"type":"string","example":"Front wheel drive","description":"The drivetrain description as supplied by manufacturer"},"oem_wheelbase_type_desc":{"type":"string","example":"STD","description":"The wheelbase description as supplied by the manufacturer"},"oem_roof_height_type_desc":{"type":"string","example":"Low","description":"The roof height description as supplied by the manufacturer"},"oem_engine_type_desc":{"type":"string","example":"DIG-T","description":"The engine type description as supplied by manufacturer"},"oem_engine_tech_desc":{"type":"string","example":"TBC","description":"The engine technical description as supplied by manufacturer"},"oem_engine_desc":{"type":"string","example":"58kWh","description":"The engine description as supplied by manufacturer"},"oem_edition_desc":{"type":"string","example":"TBC","description":"The edition description as supplied by manufacturer"},"oem_colour":{"type":"string","example":"Midnight Black","description":"The exterior colour as supplied by manufacturer"}}},"feature_data":{"type":"array","items":{"properties":{"feature_desc":{"type":"string","example":"12Volt Socket in Front Centre Console","description":"The feature description"},"feature_status":{"type":"string","example":"Standard","description":"The feature status (default options priced at '£0' & can be swapped for alternative option)"},"feature_category":{"type":"string","example":"Audio and Communications","description":"The feature category"},"list_price_ex_vat":{"type":"number","example":123.45,"description":"The list price excluding VAT"},"list_price_vat":{"type":"number","example":12.34,"description":"The list price VAT"},"list_price_inc_vat":{"type":"number","example":123.45,"description":"The list price including VAT"}}}}}},"error":{"type":"string","example":"If there is an error the message would go here","description":"Details of what went wrong with the api call"}}}}}}},"security":[{"x-api-key":[]}]}},"/autotrader/valuationandmetricsfromid/v2":{"get":{"tags":["Autotrader"],"operationId":"autotrader_valuationandmetricsfromid","summary":"Valuation and Market Metrics from ID","description":"This endpoint returns a VRM (vehicle registration mark), a description of the vehicle and four mileage adjusted valuations (Retail, Private, Trade and Part-Exchange). By using the optional vehicle_condition parameter (0-100 - where 0 is very poor and 100 is retail-ready) the valuations will also be condition adjusted*. Additional metrics providing insight into market supply & demand, and market conditions are also returned. * Days to Sell and Location Market Rating are based on postcode and advertised price.   * All Auto Trader valuations returned via the API are condition adjusted including the Part-Ex Valuation which is not currently adjusted within the Auto Trader Portal. * All Auto Trader valuations returned via the API are condition adjusted including the Part-Ex Valuation which is not currently adjusted within the Auto Trader Portal. * All Auto Trader valuations returned via the API are condition adjusted including the Part-Ex Valuation which is not currently adjusted within the Auto Trader Portal. * All","parameters":[{"name":"autotrader_derivative_id","in":"query","description":"Auto Trader identifier for the derivative of the vehicle","required":true,"schema":{"type":"string"}},{"name":"current_mileage","in":"query","description":"The current mileage of the vehicle in full","required":true,"schema":{"type":"integer"}},{"name":"first_registration_date","in":"query","description":"Date of first registration","required":true,"schema":{"type":"string"}},{"name":"vehicle_condition","in":"query","description":"Vehicle's condition (0-100 - where 0 is very poor and 100 is retail-ready)","required":false,"schema":{"type":"integer"}},{"name":"advertised_price","in":"query","description":"The advertised price of the vehicle","required":false,"schema":{"type":"integer"}},{"name":"post_code","in":"query","description":"Postcode for the area of interest. Use a comma separator for multiple postcode requests e.g RG303AT","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"description":"Whether the api call was successful"},"result":{"type":"object","properties":{"autotrader_derivative_id":{"type":"string","example":"1a2b345cf6d789ef1g0111h2i13j141k","description":"The Auto Trader Derivative ID"},"vehicle_description":{"type":"string","example":"MINI Convertible 1.5 Cooper Convertible 2dr Petrol Manual (s/s) (136 ps)","description":"The make, model and derivative description of the vehicle"},"retail_valuation":{"type":"integer","example":12345,"description":"The suggested market average retail valuation for the specified vehicle (cars only)."},"retail_valuation_ex_vat":{"type":"integer","example":12345,"description":"The suggested market average retail valuation excluding vat for the specified vehicle (cars only)."},"private_valuation":{"type":"integer","example":12345,"description":"The suggested market average private sale valuation for the specified vehicle (location, market and condition adjusted)."},"trade_valuation":{"type":"integer","example":12345,"description":"The suggested market average trade valuation for the specified vehicle (location, market and condition adjusted)."},"part_exchange_valuation":{"type":"integer","example":12345,"description":"The suggested market average part exchange valuation for the specified vehicle (location, market and condition adjusted)."},"market_supply":{"type":"number","example":1.2,"description":"A comparison of the national market supply observed on Auto Trader over the last 7 days relative to the market supply that has been observed over the last 6 months (-0 to 1+) (-0: high supply, 1+: average-limited supply)."},"market_demand":{"type":"number","example":1.23,"description":"A comparison of the national demand observed on Auto Trader over the last 7 days relative to the level of demand that has been observed over the last 6 months (-0 to 1+) (-0: low demand, 1+: average-high demand)."},"market_condition":{"type":"number","example":0.12,"description":"Modelled number to illustrate current market condition based on Supply & Demand metrics (-0-1+) (-0: poor market condition, 1+: average-good market condition)."},"locations":{"type":"array","items":{"properties":{"location_market_rating":{"type":"number","example":12.34,"description":"Modelled metric of the potential retail performance of a vehicle based on the Days to Sell, Supply and Demand  for the given location (1-100) (1: poor performance, 100: good performance)."},"days_to_sell":{"type":"number","example":123,"description":"The expected number of days it will take to sell the vehicle based on the chosen advertised price and postcode (0-150 days). If the advertised price is not provided as an input parameter this is based on the Auto Trader retail valuation."},"post_code":{"type":"string","example":"AB12ABC","description":"Postcode"}}}},"national_market_rating":{"type":"number","example":12.3,"description":"The  modelled metric of the potential retail performance of a vehicle based on the Days to Sell, Supply and Demand at national level."},"national_days_to_sell":{"type":"number","example":12.3,"description":" The expected number of days it will take to sell the vehicle based on the chosen advertised price at national level."}}},"error":{"type":"string","example":"If there is an error the message would go here","description":"Details of what went wrong with the api call"}}}}}}},"security":[{"x-api-key":[]}]}},"/autotrader/valuationandretailcheckfromid/v2":{"get":{"tags":["Autotrader"],"operationId":"autotrader_valuationandretailcheckfromid","summary":"Valuation and Retail Check from Id","description":"This endpoint returns the Auto Trader derivative ID, a description of the vehicle and four mileage adjusted valuations (Retail, Private, Trade and Part-Exchange). By using the optional vehicle_condition parameter (0-100 - where 0 is very poor and 100 is retail-ready) the valuations will also be condition adjusted. This endpoint returns the Auto Trader derivative ID, a description of the vehicle and four mileage adjusted valuations (Retail, Private, Trade and Part-Exchange). By using the optional vehicle_condition parameter (0-100 - where 0 is very poor and 100 is retail-ready) the valuations will also be condition adjusted.","parameters":[{"name":"autotrader_derivative_id","in":"query","description":"Auto Trader identifier for the derivative of the vehicle","required":true,"schema":{"type":"string"}},{"name":"current_mileage","in":"query","description":"The current mileage of the vehicle in full","required":true,"schema":{"type":"integer"}},{"name":"first_registration_date","in":"query","description":"Date of first registration","required":true,"schema":{"type":"string"}},{"name":"vehicle_condition","in":"query","description":"Vehicle's condition (0-100 - where 0 is very poor and 100 is retail-ready)","required":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"description":"Whether the api call was successful"},"result":{"type":"object","properties":{"retail_valuation":{"type":"integer","example":12345,"description":"The suggested market average retail valuation for the specified vehicle (cars only)."},"retail_valuation_ex_vat":{"type":"integer","example":12345,"description":"The suggested market average retail valuation excluding vat for the specified vehicle (cars only)."},"private_valuation":{"type":"integer","example":12345,"description":"The suggested market average private sale valuation for the specified vehicle (location, market and condition adjusted)."},"trade_valuation":{"type":"integer","example":12345,"description":"The suggested market average trade valuation for the specified vehicle (location, market and condition adjusted)."},"part_exchange_valuation":{"type":"integer","example":12345,"description":"The suggested market average part exchange valuation for the specified vehicle (location, market and condition adjusted)."},"national_market_rating":{"type":"number","example":12.3,"description":"The  modelled metric of the potential retail performance of a vehicle based on the Days to Sell, Supply and Demand at national level."},"autotrader_derivative_id":{"type":"string","example":"1a2b345cf6d789ef1g0111h2i13j141k","description":"The Auto Trader Derivative ID"}}},"error":{"type":"string","example":"If there is an error the message would go here","description":"Details of what went wrong with the api call"}}}}}}},"security":[{"x-api-key":[]}]}},"/autotrader/valuationandretailcheckfromvrm/v2":{"get":{"tags":["Autotrader"],"operationId":"autotrader_valuationandretailcheckfromvrm","summary":"Valuation and Retail Check from VRM","description":"This endpoint returns the Auto Trader derivative ID, a description of the vehicle and four mileage adjusted valuations (Retail, Private, Trade and Part-Exchange). By using the optional vehicle_condition parameter (0-100 - where 0 is very poor and 100 is retail-ready) the valuations will also be condition adjusted. This endpoint returns the Auto Trader derivative ID, a description of the vehicle and four mileage adjusted valuations (Retail, Private, Trade and Part-Exchange). By using the optional vehicle_condition parameter (0-100 - where 0 is very poor and 100 is retail-ready) the valuations will also be condition adjusted.","parameters":[{"name":"vehicle_registration_mark","in":"query","description":"The vehicle registration mark","required":true,"schema":{"type":"string"}},{"name":"current_mileage","in":"query","description":"The current mileage of the vehicle in full","required":true,"schema":{"type":"integer"}},{"name":"vehicle_condition","in":"query","description":"Vehicle's condition (0-100 - where 0 is very poor and 100 is retail-ready)","required":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"description":"Whether the api call was successful"},"result":{"type":"object","properties":{"vehicle_registration_mark":{"type":"string","example":"AB21ABC","description":"Vehicle registration number"},"first_registration_date":{"type":"string","example":"2020-01-01","description":"Date of first registration"},"autotrader_derivative_id":{"type":"string","example":"1a2b345cf6d789ef1g0111h2i13j141k","description":"The Auto Trader Derivative ID"},"vehicle_description":{"type":"string","example":"MINI Convertible 1.5 Cooper Convertible 2dr Petrol Manual (s/s) (136 ps)","description":"The make, model and derivative description of the vehicle"},"retail_valuation":{"type":"integer","example":12345,"description":"The suggested market average retail valuation for the specified vehicle (cars only)."},"retail_valuation_ex_vat":{"type":"integer","example":12345,"description":"The suggested market average retail valuation excluding vat for the specified vehicle (cars only)."},"private_valuation":{"type":"integer","example":12345,"description":"The suggested market average private sale valuation for the specified vehicle (location, market and condition adjusted)."},"trade_valuation":{"type":"integer","example":12345,"description":"The suggested market average trade valuation for the specified vehicle (location, market and condition adjusted)."},"part_exchange_valuation":{"type":"integer","example":12345,"description":"The suggested market average part exchange valuation for the specified vehicle (location, market and condition adjusted)."},"national_market_rating":{"type":"number","example":12.3,"description":"The  modelled metric of the potential retail performance of a vehicle based on the Days to Sell, Supply and Demand at national level."}}},"error":{"type":"string","example":"If there is an error the message would go here","description":"Details of what went wrong with the api call"}}}}}}},"security":[{"x-api-key":[]}]}},"/autotrader/valuationfromid/v2":{"get":{"tags":["Autotrader"],"operationId":"autotrader_valuationfromid","summary":"Valuation from ID","description":"This endpoint returns four mileage adjusted valuations (Retail, Private, Trade and Part-Exchange), the Auto Trader derivative id and the vehicle description. By using the optional vehicle_condition parameter (0-100 - where 0 is very poor and 100 is retail-ready) the valuations will also be condition adjusted*. * * All Auto Trader valuations returned via the API are condition adjusted including the Part-Ex Valuation which is not currently adjusted within the Auto Trader Portal. * All Auto Trader valuations returned via the API are condition adjusted including the Part-Ex Valuation which is not currently adjusted within the Auto Trader Portal. * All Auto Trader valuations returned via the API are condition adjusted including the Part-Ex Valuation which is not currently adjusted within the Auto Trader Portal. * All","parameters":[{"name":"autotrader_derivative_id","in":"query","description":"Auto Trader identifier for the derivative of the vehicle","required":true,"schema":{"type":"string"}},{"name":"current_mileage","in":"query","description":"The current mileage of the vehicle in full","required":true,"schema":{"type":"integer"}},{"name":"first_registration_date","in":"query","description":"Date of first registration","required":true,"schema":{"type":"string"}},{"name":"vehicle_condition","in":"query","description":"Vehicle's condition (0-100 - where 0 is very poor and 100 is retail-ready)","required":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"description":"Whether the api call was successful"},"result":{"type":"object","properties":{"autotrader_derivative_id":{"type":"string","example":"1a2b345cf6d789ef1g0111h2i13j141k","description":"The Auto Trader Derivative ID"},"retail_valuation":{"type":"integer","example":12345,"description":"The suggested market average retail valuation for the specified vehicle (cars only)."},"private_valuation":{"type":"integer","example":12345,"description":"The suggested market average private sale valuation for the specified vehicle (location, market and condition adjusted)."},"trade_valuation":{"type":"integer","example":12345,"description":"The suggested market average trade valuation for the specified vehicle (location, market and condition adjusted)."},"part_exchange_valuation":{"type":"integer","example":12345,"description":"The suggested market average part exchange valuation for the specified vehicle (location, market and condition adjusted)."},"retail_valuation_ex_vat":{"type":"integer","example":12345,"description":"The suggested market average retail valuation excluding vat for the specified vehicle (cars only)."}}},"error":{"type":"string","example":"If there is an error the message would go here","description":"Details of what went wrong with the api call"}}}}}}},"security":[{"x-api-key":[]}]}},"/autotrader/valuationfromvrm/v2":{"get":{"tags":["Autotrader"],"operationId":"autotrader_valuationfromvrm","summary":"Valuation from VRM","description":"This endpoint returns the Auto Trader derivative ID, a description of the vehicle and four mileage adjusted valuations (Retail, Private, Trade and Part-Exchange). By using the optional vehicle_condition parameter (0-100 - where 0 is very poor and 100 is retail-ready) the valuations will also be condition adjusted*.* All Auto Trader valuations returned via the API are condition adjusted including the Part-Ex Valuation which is not currently adjusted within the Auto Trader Portal. This endpoint returns the Auto Trader derivative ID, a description of the vehicle and four mileage adjusted valuations (Retail, Private, Trade and Part-Exchange). By using the optional vehicle_condition parameter (0-100 - where 0 is very poor and 100 is retail-ready) the valuations will also be condition adjusted*.* All Auto Trader valuations returned via the API are condition adjusted including the Part-Ex Valuation which is not currently adjusted within the Auto Trader Portal. *   * All Auto Trader valuations returned via the API are condition adjusted including the Part-Ex Valuation which is not currently adjusted within the Auto Trader Portal. * All Auto Trader valuations returned via the API are condition adjusted including the Part-Ex Valuation which is not currently adjusted within the Auto Trader Portal. * All","parameters":[{"name":"vehicle_registration_mark","in":"query","description":"The vehicle registration mark","required":true,"schema":{"type":"string"}},{"name":"current_mileage","in":"query","description":"The current mileage of the vehicle in full","required":true,"schema":{"type":"integer"}},{"name":"vehicle_condition","in":"query","description":"Vehicle's condition (0-100 - where 0 is very poor and 100 is retail-ready)","required":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"description":"Whether the api call was successful"},"result":{"type":"object","properties":{"autotrader_derivative_id":{"type":"string","example":"1a2b345cf6d789ef1g0111h2i13j141k","description":"The Auto Trader Derivative ID"},"vehicle_description":{"type":"string","example":"MINI Convertible 1.5 Cooper Convertible 2dr Petrol Manual (s/s) (136 ps)","description":"The make, model and derivative description of the vehicle"},"retail_valuation":{"type":"integer","example":12345,"description":"The suggested market average retail valuation for the specified vehicle (cars only)."},"retail_valuation_ex_vat":{"type":"integer","example":12345,"description":"The suggested market average retail valuation excluding vat for the specified vehicle (cars only)."},"private_valuation":{"type":"integer","example":12345,"description":"The suggested market average private sale valuation for the specified vehicle (location, market and condition adjusted)."},"trade_valuation":{"type":"integer","example":12345,"description":"The suggested market average trade valuation for the specified vehicle (location, market and condition adjusted)."},"part_exchange_valuation":{"type":"integer","example":12345,"description":"The suggested market average part exchange valuation for the specified vehicle (location, market and condition adjusted)."}}},"error":{"type":"string","example":"If there is an error the message would go here","description":"Details of what went wrong with the api call"}}}}}}},"security":[{"x-api-key":[]}]}},"/autotrader/vehiclelookupfromvrm/v2":{"get":{"tags":["Autotrader"],"operationId":"autotrader_vehiclelookupfromvrm","summary":"Vehicle Lookup from VRM","description":"This endpoint returns the basic vehicle information, insurance, performance, EV and OEM data. In addition, a basic vehicle check is returned along with weights dimensions and capacities.","parameters":[{"name":"vehicle_registration_mark","in":"query","description":"Vehicle registration number","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"description":"Whether the api call was successful"},"result":{"type":"object","properties":{"basic_vehicle_info":{"type":"object","properties":{"vehicle_registration_mark":{"type":"string","example":"AB21ABC","description":"Vehicle registration number"},"vehicle_identification_number":{"type":"string","example":"ABCDE123456F78910","description":"The vehicle identification number."},"first_registration_date":{"type":"string","example":"2020-01-01","description":"Date of first registration"},"country_of_origin":{"type":"string","example":"United Kingdom","description":"The country the vehicle was manufactured in"},"colour":{"type":"string","example":"Black","description":"Exterior colour of vehicle"},"autotrader_derivative_id":{"type":"string","example":"1a2b345cf6d789ef1g0111h2i13j141k","description":"The Auto Trader Derivative ID"},"autotrader_asset_type":{"type":"string","example":"Car","description":"Auto Trader's asset type"},"vehicle_sector":{"type":"string","example":"Supermini Conv","description":"The vehicle sector as defined by Auto Trader"},"manufacturer_desc":{"type":"string","example":"MINI","description":"Manufacturer description"},"model_range_desc":{"type":"string","example":"Convertible","description":"Model range description"},"generation_desc":{"type":"string","example":"Convertible (2015 - 2018)","description":"The generation description"},"derivative_desc":{"type":"string","example":"1.5 Cooper Convertible 2dr Petrol Manual (s/s) (136 ps)","description":"EV Database’s model variant"},"vehicle_description":{"type":"string","example":"MINI Convertible 1.5 Cooper Convertible 2dr Petrol Manual (s/s) (136 ps)","description":"The make, model and derivative description of the vehicle"},"trim_level_desc":{"type":"string","example":"Cooper","description":"The trim level description"},"autotrader_body_type_desc":{"type":"string","example":"Convertible","description":"Auto Trader's body type description"},"autotrader_fuel_type_desc":{"type":"string","example":"Petrol","description":"Auto Trader's fuel type"},"cab_type_desc":{"type":"string","example":"Crew cab","description":"The cab type"},"autotrader_transmission_desc":{"type":"string","example":"Manual","description":"Auto Trader's transmission description"},"wheelbase_type_desc":{"type":"string","example":"STD","description":"The wheelbase type description"},"roof_height_type_desc":{"type":"string","example":"Low","description":"The roof height description"},"autotrader_drivetrain_type_desc":{"type":"string","example":"Front Wheel Drive","description":"Auto Trader's drivetrain description"},"drive_type_desc":{"type":"string","example":"4X2","description":"The drive type description"},"number_seats":{"type":"integer","example":4,"description":"Number of seats"},"number_doors":{"type":"integer","example":2,"description":"The number of doors"},"number_gears":{"type":"integer","example":6,"description":"Number of gears"},"number_axles":{"type":"integer","example":2,"description":"The number of axles"},"style":{"type":"string","example":"tractor","description":"The style of vehicle"},"substyle":{"type":"string","example":"large tractor","description":"The substyle of vehicle"}}},"insurance_data":{"type":"object","properties":{"insurance_group_1to50":{"type":"string","example":"22","description":"The 1-50 insurance group"},"insurance_security_code":{"type":"string","example":"E","description":"The Insurance group rating"}}},"performance_data":{"type":"object","properties":{"top_speed_mph":{"type":"integer","example":123,"description":"The top speed (mph)"},"0to60_mph":{"type":"number","example":12.3,"description":"The number of seconds to go from Zero to 60 mph"},"0to100_kmph":{"type":"number","example":12.3,"description":"The number of seconds to go from Zero to 100 kmph"}}},"weight_dimension_capacities_data":{"type":"object","properties":{"vehicle_length_mm":{"type":"integer","example":1234,"description":"The vehicle length in mm"},"vehicle_height_mm":{"type":"integer","example":1234,"description":"The vehicle height in mm"},"vehicle_width_mm":{"type":"integer","example":1234,"description":"The vehicle width in mm"},"vehicle_wheelbase_mm":{"type":"integer","example":1234,"description":"The vehicle wheelbase in mm"},"bootspace_seats_up_litres":{"type":"integer","example":123,"description":"The bootspace with seats up in litres"},"bootspace_seats_down_litres":{"type":"integer","example":123,"description":"The bootspace with seats down in litres"},"payload_length_mm":{"type":"integer","example":1234,"description":"The payload length in mm"},"payload_width_mm":{"type":"integer","example":1234,"description":"The payload width in mm"},"payload_height_mm":{"type":"integer","example":1234,"description":"The payload height in mm"},"payload_weight_kg":{"type":"integer","example":123,"description":"The payload weight in kg"},"payload_volume_cubicmetres":{"type":"integer","example":123,"description":"The payload volume in cubic metres"},"min_kerbweight_kg":{"type":"integer","example":1234,"description":"Minimum kerbweight in kg"},"gross_vehicleweight_kg":{"type":"integer","example":1234,"description":"Gross vehicle weight in kg"},"maximum_permissable_mass_kg":{"type":"integer","example":1234,"description":"Maximum permissable mass in kg"},"gross_trainweight_kg":{"type":"integer","example":1234,"description":"The gross train weight in kg"}}},"engine_data":{"type":"object","properties":{"engine_manufacturer":{"type":"string","example":"MINI","description":"The engine manufacturer"},"engine_number":{"type":"string","example":"AB12345","description":"Vehicle engine number"},"engine_badged_size_litres":{"type":"number","example":1.2,"description":"The engine badged size in litres"},"engine_capacity_cc":{"type":"integer","example":1234,"description":"Engine capacity in cc"},"engine_bore_mm":{"type":"integer","example":12,"description":"The engine bore in mm"},"engine_stroke_mm":{"type":"integer","example":12,"description":"The engine stroke in mm"},"fuel_delivery":{"type":"string","example":"Turbo Common Rail","description":"The fuel delivery"},"fuel_capacity_litres":{"type":"integer","example":12,"description":"The fuel capacity in litres"},"number_cylinders":{"type":"integer","example":3,"description":"The number of cylinders"},"cylinder_arrangement":{"type":"string","example":"Inline","description":"The cylinder arrangement"},"valve_gear":{"type":"string","example":"Double Overhead Camshaft","description":"The type of valve gear"},"valves":{"type":"integer","example":12,"description":"The number of valves"},"power_ps":{"type":"integer","example":123,"description":"The power ps"},"power_bhp":{"type":"number","example":123.5,"description":"The power bhp"},"torque_nm":{"type":"integer","example":123,"description":"The engine torque in nm"},"torque_lbft":{"type":"number","example":123.45,"description":"The engine torque in lb-ft"},"emission_class":{"type":"string","example":"Euro 6","description":"The emission class"},"is_rde_compliant":{"type":"boolean","example":true,"description":"Is the vehicle rde compliant"},"co2_gkm":{"type":"integer","example":123,"description":"CO2 in g/km"},"is_startstop":{"type":"boolean","example":true,"description":"Does the vehicle have start stop technology"},"nedc_extra_urban_mpg":{"type":"number","example":12.3,"description":"The NEDC number of miles per gallon B-road, A-road and motorway driving ICE"},"nedc_urban_mpg":{"type":"number","example":12.3,"description":"The NEDC number of miles per gallon city driving ICE and SCH"},"nedc_combined_mpg":{"type":"number","example":12.3,"description":"The NEDC Average miles per gallon between urban (city driving) and extra urban (B-road, A-road and motorway) driving ICE and SCH"},"wltp_low_mpg":{"type":"number","example":12.3,"description":"The WLTP number of miles per gallon tested under wltp at speeds up to 35mph"},"wltp_medium_mpg":{"type":"number","example":12.3,"description":"The WLTP number of miles per gallon tested under wltp at speeds up to 47mph"},"wltp_high_mpg":{"type":"number","example":12.3,"description":"The WLTP number of miles per gallon tested under wltp at speeds up to 60mph"},"wltp_extra_high_mpg":{"type":"number","example":12.3,"description":"The WLTP number of miles per gallon tested under wltp at speeds up to 81mph"},"wltp_combined_mpg":{"type":"number","example":12.3,"description":"The WLTP average number of miles per gallon tested under wltp (low, medium, high & extra high)"}}},"ev_data":{"type":"object","properties":{"battery_chargetime_mins":{"type":"integer","example":123,"description":"The battery charge time in minutes"},"battery_fast_chargetime_mins":{"type":"integer","example":123,"description":"The battery fast charge time in minutes"},"battery_range_miles":{"type":"integer","example":123,"description":"The battery's range in miles"},"battery_capacity_kwh":{"type":"integer","example":12,"description":"Battery capacity in kwh"},"battery_capacity_usable_kwh":{"type":"integer","example":12,"description":"Usable capacity (the amount of energy the car can actually draw on to propel itself) in kwh"}}},"oem_data":{"type":"object","properties":{"oem_manufacturer_desc":{"type":"string","example":"MINI","description":"The manufacturer description as supplied by manufacturer"},"oem_model_range_desc":{"type":"string","example":"Convertible","description":"The model range description as supplied by manufacturer"},"oem_derivative_desc":{"type":"string","example":"Cooper Convertible","description":"The derivative description as supplied by manufacturer"},"oem_body_type_desc":{"type":"string","example":"Convertible","description":"The body type description as supplied by manufacturer"},"oem_transmission_type_desc":{"type":"string","example":"Manual","description":"The transmission type description as supplied by manufacturer"},"oem_drivetrain_desc":{"type":"string","example":"Front wheel drive","description":"The drivetrain description as supplied by manufacturer"},"oem_wheelbase_type_desc":{"type":"string","example":"STD","description":"The wheelbase description as supplied by the manufacturer"},"oem_roof_height_type_desc":{"type":"string","example":"Low","description":"The roof height description as supplied by the manufacturer"},"oem_engine_type_desc":{"type":"string","example":"DIG-T","description":"The engine type description as supplied by manufacturer"},"oem_engine_tech_desc":{"type":"string","example":"TBC","description":"The engine technical description as supplied by manufacturer"},"oem_engine_desc":{"type":"string","example":"58kWh","description":"The engine description as supplied by manufacturer"},"oem_edition_desc":{"type":"string","example":"TBC","description":"The edition description as supplied by manufacturer"},"oem_colour":{"type":"string","example":"Midnight Black","description":"The exterior colour as supplied by manufacturer"}}},"basic_vehicle_check":{"type":"object","properties":{"insurance_writeoff_category":{"type":"string","example":"A","description":"The insurance write off category"},"is_stolen":{"type":"boolean","example":false,"description":"Is the vehicle stolen"},"is_scrapped":{"type":"boolean","example":false,"description":"Has the vehicle been scrapped."},"is_exported":{"type":"boolean","example":false,"description":"Vehicle is exported"},"is_imported":{"type":"boolean","example":false,"description":"Vehicle is imported"},"number_previous_keepers":{"type":"integer","example":1,"description":"The number of previous keepers."},"date_of_last_keeper_change":{"type":"string","example":"2020-01-01","description":"The date of last keeper change."},"previous_keeper_acquisition_date":{"type":"string","example":"2020-01-01","description":"The previous keepers acquisition date"}}}}},"error":{"type":"string","example":"If there is an error the message would go here","description":"Details of what went wrong with the api call"}}}}}}},"security":[{"x-api-key":[]}]}},"/autotrader/valuationandmetricsfromvrm":{"get":{"tags":["Autotrader"],"operationId":"autotrader_valuationandmetricsfromvrm","summary":"Valuation and Market Metrics from VRM","description":"This endpoint returns a VRM (vehicle registration mark), a description of the vehicle and four mileage adjusted valuations (Retail, Private, Trade and Part-Exchange). By using the optional vehicle_condition parameter (0-100 - where 0 is very poor and 100 is retail-ready) the valuations will also be condition adjusted*. Additional metrics providing insight into market supply & demand, market condition are also returned. * Days to Sell and Location Market Rating are based on postcode and advertised price. * All Auto Trader valuations returned via the API are condition adjusted including the Part-Ex Valuation which is not currently adjusted within the Auto Trader Portal.   * All Auto Trader valuations returned via the API are condition adjusted including the Part-Ex Valuation which is not currently adjusted within the Auto Trader Portal. * All Auto Trader valuations returned via the API are condition adjusted including the Part-Ex Valuation which is not currently adjusted within the Auto Trader Portal. * All","parameters":[{"name":"vehicle_registration_mark","in":"query","description":"Vehicle registration number","required":true,"schema":{"type":"string"}},{"name":"current_mileage","in":"query","description":"The current mileage of the vehicle in full","required":true,"schema":{"type":"integer"}},{"name":"vehicle_condition","in":"query","description":"Vehicle's condition (0-100 - where 0 is very poor and 100 is retail-ready)","required":false,"schema":{"type":"integer"}},{"name":"advertised_price","in":"query","description":"The advertised price of the vehicle","required":false,"schema":{"type":"integer"}},{"name":"post_code","in":"query","description":"Postcode for the area of interest. Use a comma separator for multiple postcode requests e.g RG303AT","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"description":"Whether the api call was successful"},"result":{"type":"object","properties":{"vehicle_registration_mark":{"type":"string","example":"AB21ABC","description":"Vehicle registration number"},"first_registration_date":{"type":"string","example":"2020-01-01","description":"Date of first registration"},"autotrader_derivative_id":{"type":"string","example":"1a2b345cf6d789ef1g0111h2i13j141k","description":"The Auto Trader Derivative ID"},"vehicle_description":{"type":"string","example":"MINI Convertible 1.5 Cooper Convertible 2dr Petrol Manual (s/s) (136 ps)","description":"The make, model and derivative description of the vehicle"},"retail_valuation":{"type":"integer","example":12345,"description":"The suggested market average retail valuation for the specified vehicle (cars only)."},"retail_valuation_ex_vat":{"type":"integer","example":12345,"description":"The suggested market average retail valuation excluding vat for the specified vehicle (cars only)."},"private_valuation":{"type":"integer","example":12345,"description":"The suggested market average private sale valuation for the specified vehicle (location, market and condition adjusted)."},"trade_valuation":{"type":"integer","example":12345,"description":"The suggested market average trade valuation for the specified vehicle (location, market and condition adjusted)."},"part_exchange_valuation":{"type":"integer","example":12345,"description":"The suggested market average part exchange valuation for the specified vehicle (location, market and condition adjusted)."},"market_supply":{"type":"number","example":1.2,"description":"A comparison of the national market supply observed on Auto Trader over the last 7 days relative to the market supply that has been observed over the last 6 months (-0 to 1+) (-0: high supply, 1+: average-limited supply)."},"market_demand":{"type":"number","example":1.23,"description":"A comparison of the national demand observed on Auto Trader over the last 7 days relative to the level of demand that has been observed over the last 6 months (-0 to 1+) (-0: low demand, 1+: average-high demand)."},"market_condition":{"type":"number","example":0.12,"description":"Modelled number to illustrate current market condition based on Supply & Demand metrics (-0-1+) (-0: poor market condition, 1+: average-good market condition)."},"locations":{"type":"array","items":{"properties":{"location_market_rating":{"type":"number","example":12.34,"description":"Modelled metric of the potential retail performance of a vehicle based on the Days to Sell, Supply and Demand  for the given location (1-100) (1: poor performance, 100: good performance)."},"days_to_sell":{"type":"number","example":123,"description":"The expected number of days it will take to sell the vehicle based on the chosen advertised price and postcode (0-150 days). If the advertised price is not provided as an input parameter this is based on the Auto Trader retail valuation."},"post_code":{"type":"string","example":"AB12ABC","description":"Postcode"}}}},"national_market_rating":{"type":"number","example":12.3,"description":"The  modelled metric of the potential retail performance of a vehicle based on the Days to Sell, Supply and Demand at national level."},"national_days_to_sell":{"type":"number","example":12.3,"description":" The expected number of days it will take to sell the vehicle based on the chosen advertised price at national level."}}},"error":{"type":"string","example":"If there is an error the message would go here","description":"Details of what went wrong with the api call"}}}}}}},"security":[{"x-api-key":[]}]}},"/brego/currentandfuturevaluationsfromid/v2":{"get":{"tags":["Brego"],"operationId":"brego_currentandfuturevaluationsfromid","summary":"Current & Future Valuations from Id","description":"This endpoint returns high, average and low, retail and trade current & forecast valuations.","parameters":[{"name":"brego_derivative_id","in":"query","description":"The Brego Derivative ID","required":true,"schema":{"type":"string"}},{"name":"current_mileage","in":"query","description":"The current mileage of the vehicle in full","required":true,"schema":{"type":"integer"}},{"name":"miles_per_annum","in":"query","description":"The expected annual mileage","required":true,"schema":{"type":"integer"}},{"name":"forecast_date","in":"query","description":"This is the date when the forecasted value is required.","required":true,"schema":{"type":"string"}},{"name":"registration_date","in":"query","description":"The date the vehicle was first registered in the UK.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"description":"Whether the api call was successful"},"result":{"type":"object","properties":{"valuations":{"type":"array","items":{"properties":{"retail_low_valuation":{"type":"integer","example":12345,"description":"The suggested retail low valuation including VAT for the specified vehicle."},"retail_average_valuation":{"type":"integer","example":12345,"description":"The suggested retail average valuation including VAT for the specified vehicle."},"retail_high_valuation":{"type":"integer","example":12345,"description":"The suggested retail high valuation including VAT for the specified vehicle ."},"trade_low_valuation":{"type":"integer","example":12345,"description":"The suggested trade low valuation including VAT for the specified vehicle."},"trade_average_valuation":{"type":"integer","example":12345,"description":"The suggested trade average valuation including VAT for the specified vehicle."},"trade_high_valuation":{"type":"integer","example":12345,"description":"The suggested trade high valuation including VAT for the specified vehicle."},"current_mileage":{"type":"integer","example":12345,"description":"The current mileage of the vehicle in full."},"version":{"type":"string","example":"2020-01-01","description":"The version of the dataset the valuations are taken from (repeated for future valuations)."}}}},"brego_derivative_id":{"type":"string","example":"0a1bc3d4-ef56-789g-h10i-j111k21l3m14","description":"The Brego Derivative ID."},"currency_unit":{"type":"string","example":"gbp","description":"The currency unit."},"mileage_unit":{"type":"string","example":"mi","description":"The mileage unit."}}},"error":{"type":"string","example":"If there is an error the message would go here","description":"Details of what went wrong with the api call"}}}}}}},"security":[{"x-api-key":[]}]}},"/brego/currentandfuturevaluationsfromvin/v2":{"get":{"tags":["Brego"],"operationId":"brego_currentandfuturevaluationsfromvin","summary":"Current & Future Valuations from VIN","description":"This endpoint returns high, average and low, retail and trade forecast valuations.","parameters":[{"name":"vehicle_identification_number","in":"query","description":"Vehicle identification (VIN) number","required":true,"schema":{"type":"string"}},{"name":"current_mileage","in":"query","description":"The current mileage of the vehicle in full","required":true,"schema":{"type":"integer"}},{"name":"miles_per_annum","in":"query","description":"The expected annual mileage","required":true,"schema":{"type":"integer"}},{"name":"forecast_date","in":"query","description":"This is the date when the forecasted value is required.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"description":"Whether the api call was successful"},"result":{"type":"object","properties":{"valuations":{"type":"array","items":{"properties":{"retail_low_valuation":{"type":"integer","example":12345,"description":"The suggested retail low valuation including VAT for the specified vehicle."},"retail_average_valuation":{"type":"integer","example":12345,"description":"The suggested retail average valuation including VAT for the specified vehicle."},"retail_high_valuation":{"type":"integer","example":12345,"description":"The suggested retail high valuation including VAT for the specified vehicle ."},"trade_low_valuation":{"type":"integer","example":12345,"description":"The suggested trade low valuation including VAT for the specified vehicle."},"trade_average_valuation":{"type":"integer","example":12345,"description":"The suggested trade average valuation including VAT for the specified vehicle."},"trade_high_valuation":{"type":"integer","example":12345,"description":"The suggested trade high valuation including VAT for the specified vehicle."},"current_mileage":{"type":"integer","example":12345,"description":"The current mileage of the vehicle in full."},"version":{"type":"string","example":"2020-01-01","description":"The version of the dataset the valuations are taken from (repeated for future valuations)."}}}},"brego_derivative_id":{"type":"string","example":"0a1bc3d4-ef56-789g-h10i-j111k21l3m14","description":"The Brego Derivative ID."},"vehicle_identification_number":{"type":"string","example":"ABCDE123456F78910","description":"The vehicle identification number."},"currency_unit":{"type":"string","example":"gbp","description":"The currency unit."},"mileage_unit":{"type":"string","example":"mi","description":"The mileage unit."}}},"error":{"type":"string","example":"If there is an error the message would go here","description":"Details of what went wrong with the api call"}}}}}}},"security":[{"x-api-key":[]}]}},"/brego/currentandfuturevaluationsfromvrm/v2":{"get":{"tags":["Brego"],"operationId":"brego_currentandfuturevaluationsfromvrm","summary":"Current & Future Valuations from VRM","description":"This endpoint returns high, average and low, retail and trade forecast valuations.","parameters":[{"name":"vehicle_registration_mark","in":"query","description":"Vehicle registration mark","required":true,"schema":{"type":"string"}},{"name":"current_mileage","in":"query","description":"The current mileage of the vehicle in full","required":true,"schema":{"type":"integer"}},{"name":"miles_per_annum","in":"query","description":"The expected annual mileage","required":true,"schema":{"type":"integer"}},{"name":"forecast_date","in":"query","description":"This is the date when the forecasted value is required.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"description":"Whether the api call was successful"},"result":{"type":"object","properties":{"valuations":{"type":"array","items":{"properties":{"retail_low_valuation":{"type":"integer","example":12345,"description":"The suggested retail low valuation including VAT for the specified vehicle."},"retail_average_valuation":{"type":"integer","example":12345,"description":"The suggested retail average valuation including VAT for the specified vehicle."},"retail_high_valuation":{"type":"integer","example":12345,"description":"The suggested retail high valuation including VAT for the specified vehicle ."},"trade_low_valuation":{"type":"integer","example":12345,"description":"The suggested trade low valuation including VAT for the specified vehicle."},"trade_average_valuation":{"type":"integer","example":12345,"description":"The suggested trade average valuation including VAT for the specified vehicle."},"trade_high_valuation":{"type":"integer","example":12345,"description":"The suggested trade high valuation including VAT for the specified vehicle."},"current_mileage":{"type":"integer","example":12345,"description":"The current mileage of the vehicle in full."},"version":{"type":"string","example":"2020-01-01","description":"The version of the dataset the valuations are taken from (repeated for future valuations)."}}}},"brego_derivative_id":{"type":"string","example":"0a1bc3d4-ef56-789g-h10i-j111k21l3m14","description":"The Brego Derivative ID."},"vehicle_identification_number":{"type":"string","example":"ABCDE123456F78910","description":"The vehicle identification number."},"currency_unit":{"type":"string","example":"gbp","description":"The currency unit."},"mileage_unit":{"type":"string","example":"mi","description":"The mileage unit."}}},"error":{"type":"string","example":"If there is an error the message would go here","description":"Details of what went wrong with the api call"}}}}}}},"security":[{"x-api-key":[]}]}},"/brego/ireland/currentandfuturevaluationsfromid/v2":{"get":{"tags":["Brego"],"operationId":"brego_ireland_currentandfuturevaluationsfromid","summary":"Current & Future Valuations (Ireland) from Id","description":"This endpoint returns high, average and low, retail and trade current & forecast valuations.","parameters":[{"name":"brego_derivative_id","in":"query","description":"The Brego Derivative ID","required":true,"schema":{"type":"string"}},{"name":"current_kms","in":"query","description":"The current mileage of the vehicle in kms","required":true,"schema":{"type":"integer"}},{"name":"miles_per_annum","in":"query","description":"The expected annual mileage in kms","required":true,"schema":{"type":"integer"}},{"name":"forecast_date","in":"query","description":"This is the date when the forecasted value is required.","required":true,"schema":{"type":"string"}},{"name":"registration_date","in":"query","description":"The date the vehicle was first registered in the UK.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"description":"Whether the api call was successful"},"result":{"type":"object","properties":{"valuations":{"type":"array","items":{"properties":{"retail_low_valuation":{"type":"integer","example":12345,"description":"The suggested retail low valuation including VAT for the specified vehicle."},"retail_average_valuation":{"type":"integer","example":12345,"description":"The suggested retail average valuation including VAT for the specified vehicle."},"retail_high_valuation":{"type":"integer","example":12345,"description":"The suggested retail high valuation including VAT for the specified vehicle ."},"trade_low_valuation":{"type":"integer","example":12345,"description":"The suggested trade low valuation including VAT for the specified vehicle."},"trade_average_valuation":{"type":"integer","example":12345,"description":"The suggested trade average valuation including VAT for the specified vehicle."},"trade_high_valuation":{"type":"integer","example":12345,"description":"The suggested trade high valuation including VAT for the specified vehicle."},"current_mileage":{"type":"integer","example":12345,"description":"The current mileage of the vehicle in full."},"version":{"type":"string","example":"2020-01-01","description":"The version of the dataset the valuations are taken from (repeated for future valuations)."}}}},"brego_derivative_id":{"type":"string","example":"0a1bc3d4-ef56-789g-h10i-j111k21l3m14","description":"The Brego Derivative ID."},"currency_unit":{"type":"string","example":"eur","description":"The currency unit."},"mileage_unit":{"type":"string","example":"km","description":"The mileage unit."}}},"error":{"type":"string","example":"If there is an error the message would go here","description":"Details of what went wrong with the api call"}}}}}}},"security":[{"x-api-key":[]}]}},"/brego/ireland/currentandfuturevaluationsfromvin/v2":{"get":{"tags":["Brego"],"operationId":"brego_ireland_currentandfuturevaluationsfromvin","summary":"Current & Future Valuations (Ireland) from VIN","description":"This endpoint returns high, average and low, retail and trade forecast valuations.","parameters":[{"name":"vehicle_identification_number","in":"query","description":"Vehicle identification (VIN) number","required":true,"schema":{"type":"string"}},{"name":"current_kms","in":"query","description":"The current mileage of the vehicle in kms","required":true,"schema":{"type":"integer"}},{"name":"kms_per_annum","in":"query","description":"The expected annual mileage in kms","required":true,"schema":{"type":"integer"}},{"name":"forecast_date","in":"query","description":"This is the date when the forecasted value is required.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"description":"Whether the api call was successful"},"result":{"type":"object","properties":{"valuations":{"type":"array","items":{"properties":{"retail_low_valuation":{"type":"integer","example":12345,"description":"The suggested retail low valuation including VAT for the specified vehicle."},"retail_average_valuation":{"type":"integer","example":12345,"description":"The suggested retail average valuation including VAT for the specified vehicle."},"retail_high_valuation":{"type":"integer","example":12345,"description":"The suggested retail high valuation including VAT for the specified vehicle ."},"trade_low_valuation":{"type":"integer","example":12345,"description":"The suggested trade low valuation including VAT for the specified vehicle."},"trade_average_valuation":{"type":"integer","example":12345,"description":"The suggested trade average valuation including VAT for the specified vehicle."},"trade_high_valuation":{"type":"integer","example":12345,"description":"The suggested trade high valuation including VAT for the specified vehicle."},"current_mileage":{"type":"integer","example":12345,"description":"The current mileage of the vehicle in full."},"version":{"type":"string","example":"2020-01-01","description":"The version of the dataset the valuations are taken from (repeated for future valuations)."}}}},"brego_derivative_id":{"type":"string","example":"0a1bc3d4-ef56-789g-h10i-j111k21l3m14","description":"The Brego Derivative ID."},"vehicle_identification_number":{"type":"string","example":"abcde1234f56789101","description":"The vehicle identification number."},"currency_unit":{"type":"string","example":"eur","description":"The currency unit."},"mileage_unit":{"type":"string","example":"km","description":"The mileage unit."}}},"error":{"type":"string","example":"If there is an error the message would go here","description":"Details of what went wrong with the api call"}}}}}}},"security":[{"x-api-key":[]}]}},"/brego/ireland/currentandfuturevaluationsfromvrm/v2":{"get":{"tags":["Brego"],"operationId":"brego_ireland_currentandfuturevaluationsfromvrm","summary":"Current & Future Valuations (Ireland) from VRM","description":"This endpoint returns high, average and low, retail and trade forecast valuations.","parameters":[{"name":"vehicle_registration_mark","in":"query","description":"Vehicle registration mark","required":true,"schema":{"type":"string"}},{"name":"current_kms","in":"query","description":"The current mileage of the vehicle in kms","required":true,"schema":{"type":"integer"}},{"name":"kms_per_annum","in":"query","description":"The expected annual mileage in kms","required":true,"schema":{"type":"integer"}},{"name":"forecast_date","in":"query","description":"This is the date when the forecasted value is required.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"description":"Whether the api call was successful"},"result":{"type":"object","properties":{"valuations":{"type":"array","items":{"properties":{"retail_low_valuation":{"type":"integer","example":12345,"description":"The suggested retail low valuation including VAT for the specified vehicle."},"retail_average_valuation":{"type":"integer","example":12345,"description":"The suggested retail average valuation including VAT for the specified vehicle."},"retail_high_valuation":{"type":"integer","example":12345,"description":"The suggested retail high valuation including VAT for the specified vehicle ."},"trade_low_valuation":{"type":"integer","example":12345,"description":"The suggested trade low valuation including VAT for the specified vehicle."},"trade_average_valuation":{"type":"integer","example":12345,"description":"The suggested trade average valuation including VAT for the specified vehicle."},"trade_high_valuation":{"type":"integer","example":12345,"description":"The suggested trade high valuation including VAT for the specified vehicle."},"current_mileage":{"type":"integer","example":12345,"description":"The current mileage of the vehicle in full."},"version":{"type":"string","example":"2020-01-01","description":"The version of the dataset the valuations are taken from (repeated for future valuations)."}}}},"brego_derivative_id":{"type":"string","example":"0a1bc3d4-ef56-789g-h10i-j111k21l3m14","description":"The Brego Derivative ID."},"vehicle_identification_number":{"type":"string","example":"abcde1234f56789101","description":"The vehicle identification number."},"currency_unit":{"type":"string","example":"eur","description":"The currency unit."},"mileage_unit":{"type":"string","example":"km","description":"The mileage unit."}}},"error":{"type":"string","example":"If there is an error the message would go here","description":"Details of what went wrong with the api call"}}}}}}},"security":[{"x-api-key":[]}]}},"/brego/ireland/metadatafromvin/v2":{"get":{"tags":["Brego"],"operationId":"brego_ireland_metadatafromvin","summary":"Metadata (Ireland) from VIN","description":"This endpoint provides metrics about market supply, advert age and price movements.","parameters":[{"name":"vehicle_identification_number","in":"query","description":"Vehicle identification (VIN) number","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"description":"Whether the api call was successful"},"result":{"type":"object","properties":{"regions":{"type":"array","items":{"properties":{"region":{"type":"string","example":"national","description":"The region of the country the data applies to."},"average_advert_days":{"type":"integer","example":12,"description":"The average number of days vehicles of this model is advertised."},"average_advert_miles_per_month":{"type":"integer","example":123,"description":"The average monthly mileage of vehicles of this model advertised within this region."},"average_advert_price_change":{"type":"integer","example":-123,"description":"The average change to the advertised price for this model within the last 7 days and within this region."},"average_manufacturer_miles_per_month":{"type":"integer","example":123,"description":"The average monthly mileage of vehicles from this manufacturer ."},"average_model_range_miles_per_month":{"type":"integer","example":123,"description":"The average monthly miles advertised vehicles of this model range have completed ."},"average_model_miles_per_month":{"type":"integer","example":123,"description":"The average monthly miles advertised vehicles of this model have completed."},"min_advert_price":{"type":"integer","example":12345,"description":"The minimum advertised price for this model."},"max_advert_price":{"type":"integer","example":12345,"description":"The maximum advertised price for this model."},"min_advert_mileage":{"type":"integer","example":12345,"description":"The minimum advertised price for this model."},"max_advert_mileage":{"type":"integer","example":12345,"description":"The maximum advertised price for this model."},"weekly_advert_qty_change":{"type":"integer","example":-12,"description":"The maximum advertised price for this model."},"advert_qty":{"type":"integer","example":1234,"description":"The number of adverts matching the query parameters"},"average_advert_owners_per_annum":{"type":"number","example":0.12,"description":"The average number of keepers per annum for this model."},"min_advert_previous_owners":{"type":"integer","example":0,"description":"The minimum number of previous keepers for advertised models."},"max_advert_previous_owners":{"type":"integer","example":2,"description":"The maximum number of previous keepers for advertised models."},"advert_vehicle_colours":{"type":"array","items":{"properties":{"count":{"type":"integer","example":123,"description":"The number of vehicles of this colour advertised."},"colour":{"type":"string","example":"Black","description":"Exterior colour of vehicle"}}}}}}}}},"error":{"type":"string","example":"If there is an error the message would go here","description":"Details of what went wrong with the api call"}}}}}}},"security":[{"x-api-key":[]}]}},"/brego/ireland/metadatafromvrm/v2":{"get":{"tags":["Brego"],"operationId":"brego_ireland_metadatafromvrm","summary":"Metadata (Ireland) from VRM","description":"This endpoint provides metrics about market supply, advert age and price movements.","parameters":[{"name":"vehicle_registration_mark","in":"query","description":"Vehicle registration mark","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"description":"Whether the api call was successful"},"result":{"type":"object","properties":{"regions":{"type":"array","items":{"properties":{"region":{"type":"string","example":"national","description":"The region of the country the data applies to."},"average_advert_days":{"type":"integer","example":12,"description":"The average number of days vehicles of this model is advertised."},"average_advert_miles_per_month":{"type":"integer","example":123,"description":"The average monthly mileage of vehicles of this model advertised within this region."},"average_advert_price_change":{"type":"integer","example":-123,"description":"The average change to the advertised price for this model within the last 7 days and within this region."},"average_manufacturer_miles_per_month":{"type":"integer","example":123,"description":"The average monthly mileage of vehicles from this manufacturer ."},"average_model_range_miles_per_month":{"type":"integer","example":123,"description":"The average monthly miles advertised vehicles of this model range have completed ."},"average_model_miles_per_month":{"type":"integer","example":123,"description":"The average monthly miles advertised vehicles of this model have completed."},"min_advert_price":{"type":"integer","example":12345,"description":"The minimum advertised price for this model."},"max_advert_price":{"type":"integer","example":12345,"description":"The maximum advertised price for this model."},"min_advert_mileage":{"type":"integer","example":12345,"description":"The minimum advertised price for this model."},"max_advert_mileage":{"type":"integer","example":12345,"description":"The maximum advertised price for this model."},"weekly_advert_qty_change":{"type":"integer","example":-12,"description":"The maximum advertised price for this model."},"advert_qty":{"type":"integer","example":1234,"description":"The number of adverts matching the query parameters"},"average_advert_owners_per_annum":{"type":"number","example":0.12,"description":"The average number of keepers per annum for this model."},"min_advert_previous_owners":{"type":"integer","example":0,"description":"The minimum number of previous keepers for advertised models."},"max_advert_previous_owners":{"type":"integer","example":2,"description":"The maximum number of previous keepers for advertised models."},"advert_vehicle_colours":{"type":"array","items":{"properties":{"count":{"type":"integer","example":123,"description":"The number of vehicles of this colour advertised."},"colour":{"type":"string","example":"Black","description":"Exterior colour of vehicle"}}}}}}}}},"error":{"type":"string","example":"If there is an error the message would go here","description":"Details of what went wrong with the api call"}}}}}}},"security":[{"x-api-key":[]}]}},"/brego/ireland/search/v2":{"get":{"tags":["Brego"],"operationId":"brego_ireland_search","summary":"Search (Ireland)","description":"This endpoint allows you to search for matching derivatives using a combination of text and parameters.","parameters":[{"name":"vehicle_desc","in":"query","description":"The vehicle description","required":true,"schema":{"type":"string"}},{"name":"manufacturer_desc","in":"query","description":"The manufacturer description","required":false,"schema":{"type":"string"}},{"name":"model_range_desc","in":"query","description":"The model range description","required":false,"schema":{"type":"string"}},{"name":"first_registration_year","in":"query","description":"Year of registration","required":false,"schema":{"type":"integer"}},{"name":"fuel_type_desc","in":"query","description":"The vehicle's fuel type description","required":false,"schema":{"type":"string"}},{"name":"transmission_desc","in":"query","description":"The vehicle's transmission type","required":false,"schema":{"type":"string"}},{"name":"body_type_desc","in":"query","description":"The body type description","required":false,"schema":{"type":"string"}},{"name":"number_doors","in":"query","description":"The number of doors","required":false,"schema":{"type":"integer"}},{"name":"0to100_kmph","in":"query","description":"The number of seconds to go from Zero to 100 kmph","required":false,"schema":{"type":"number"}},{"name":"engine_capacity_cc","in":"query","description":"The engine capacity in cc","required":false,"schema":{"type":"integer"}},{"name":"number_cylinders","in":"query","description":"The number of cylinders","required":false,"schema":{"type":"integer"}},{"name":"power_bhp","in":"query","description":"The engine power bhp","required":false,"schema":{"type":"number"}},{"name":"number_gears","in":"query","description":"The number of gears","required":false,"schema":{"type":"integer"}},{"name":"top_speed_mph","in":"query","description":"The top speed (mph)","required":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"description":"Whether the api call was successful"},"result":{"type":"array","items":{"properties":{"brego_derivative_id":{"type":"string","example":"0a1bc3d4-ef56-789g-h10i-j111k21l3m14","description":"The Brego Derivative ID."},"brego_vehicle_description":{"type":"string","example":"MINI COUPE 1.6 Cooper 3dr (October 2011 - May 2015)","description":"The Brego vehicle description."}}}},"error":{"type":"string","example":"If there is an error the message would go here","description":"Details of what went wrong with the api call"}}}}}}},"security":[{"x-api-key":[]}]}},"/brego/ireland/valuationfromid/v2":{"get":{"tags":["Brego"],"operationId":"brego_ireland_valuationfromid","summary":"Current Valuation (Ireland) from Id","description":"This endpoint returns mileage adjusted high, average and low condition categories for retail and trade valuations.","parameters":[{"name":"brego_derivative_id","in":"query","description":"The Brego Derivative ID","required":true,"schema":{"type":"string"}},{"name":"current_kms","in":"query","description":"The current mileage of the vehicle in kms","required":true,"schema":{"type":"integer"}},{"name":"registration_date","in":"query","description":"Date the vehicle was first registered in the UK","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"description":"Whether the api call was successful"},"result":{"type":"object","properties":{"retail_low_valuation":{"type":"integer","example":12345,"description":"The suggested retail low valuation including VAT for the specified vehicle."},"retail_average_valuation":{"type":"integer","example":12345,"description":"The suggested retail average valuation including VAT for the specified vehicle."},"retail_high_valuation":{"type":"integer","example":12345,"description":"The suggested retail high valuation including VAT for the specified vehicle ."},"trade_low_valuation":{"type":"integer","example":12345,"description":"The suggested trade low valuation including VAT for the specified vehicle."},"trade_average_valuation":{"type":"integer","example":12345,"description":"The suggested trade average valuation including VAT for the specified vehicle."},"trade_high_valuation":{"type":"integer","example":12345,"description":"The suggested trade high valuation including VAT for the specified vehicle."},"current_mileage":{"type":"integer","example":12345,"description":"The current mileage of the vehicle in full."},"brego_derivative_id":{"type":"string","example":"0a1bc3d4-ef56-789g-h10i-j111k21l3m14","description":"The Brego Derivative ID."},"currency_unit":{"type":"string","example":"eur","description":"The currency unit."},"mileage_unit":{"type":"string","example":"km","description":"The mileage unit."},"version":{"type":"string","example":"2020-01-01","description":"The version of the dataset the valuations are taken from (repeated for future valuations)."}}},"error":{"type":"string","example":"If there is an error the message would go here","description":"Details of what went wrong with the api call"}}}}}}},"security":[{"x-api-key":[]}]}},"/brego/ireland/valuationfromvin/v2":{"get":{"tags":["Brego"],"operationId":"brego_ireland_valuationfromvin","summary":"Current Valuation (Ireland) from VIN","description":"This endpoint returns mileage adjusted high, average and low condition categories for retail and trade valuations.","parameters":[{"name":"vehicle_identification_number","in":"query","description":"The vehicle identification number","required":true,"schema":{"type":"string"}},{"name":"current_kms","in":"query","description":"The current mileage of the vehicle in kms","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"description":"Whether the api call was successful"},"result":{"type":"object","properties":{"retail_low_valuation":{"type":"integer","example":12345,"description":"The suggested retail low valuation including VAT for the specified vehicle."},"retail_average_valuation":{"type":"integer","example":12345,"description":"The suggested retail average valuation including VAT for the specified vehicle."},"retail_high_valuation":{"type":"integer","example":12345,"description":"The suggested retail high valuation including VAT for the specified vehicle ."},"trade_low_valuation":{"type":"integer","example":12345,"description":"The suggested trade low valuation including VAT for the specified vehicle."},"trade_average_valuation":{"type":"integer","example":12345,"description":"The suggested trade average valuation including VAT for the specified vehicle."},"trade_high_valuation":{"type":"integer","example":12345,"description":"The suggested trade high valuation including VAT for the specified vehicle."},"current_mileage":{"type":"integer","example":12345,"description":"The current mileage of the vehicle in full."},"brego_derivative_id":{"type":"string","example":"0a1bc3d4-ef56-789g-h10i-j111k21l3m14","description":"The Brego Derivative ID."},"vehicle_identification_number":{"type":"string","example":"abcde1234f56789101","description":"The vehicle identification number."},"currency_unit":{"type":"string","example":"eur","description":"The currency unit."},"mileage_unit":{"type":"string","example":"km","description":"The mileage unit."},"version":{"type":"string","example":"2020-01-01","description":"The version of the dataset the valuations are taken from (repeated for future valuations)."}}},"error":{"type":"string","example":"If there is an error the message would go here","description":"Details of what went wrong with the api call"}}}}}}},"security":[{"x-api-key":[]}]}},"/brego/ireland/valuationfromvrm/v2":{"get":{"tags":["Brego"],"operationId":"brego_ireland_valuationfromvrm","summary":"Current Valuation (Ireland) from VRM","description":"This endpoint returns mileage adjusted high, average and low condition categories for retail and trade valuations.","parameters":[{"name":"vehicle_registration_mark","in":"query","description":"The vehicle registration mark","required":true,"schema":{"type":"string"}},{"name":"current_kms","in":"query","description":"The current mileage of the vehicle in kms","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"description":"Whether the api call was successful"},"result":{"type":"object","properties":{"retail_low_valuation":{"type":"integer","example":12345,"description":"The suggested retail low valuation including VAT for the specified vehicle."},"retail_average_valuation":{"type":"integer","example":12345,"description":"The suggested retail average valuation including VAT for the specified vehicle."},"retail_high_valuation":{"type":"integer","example":12345,"description":"The suggested retail high valuation including VAT for the specified vehicle ."},"trade_low_valuation":{"type":"integer","example":12345,"description":"The suggested trade low valuation including VAT for the specified vehicle."},"trade_average_valuation":{"type":"integer","example":12345,"description":"The suggested trade average valuation including VAT for the specified vehicle."},"trade_high_valuation":{"type":"integer","example":12345,"description":"The suggested trade high valuation including VAT for the specified vehicle."},"current_mileage":{"type":"integer","example":12345,"description":"The current mileage of the vehicle in full."},"brego_derivative_id":{"type":"string","example":"0a1bc3d4-ef56-789g-h10i-j111k21l3m14","description":"The Brego Derivative ID."},"vehicle_identification_number":{"type":"string","example":"abcde1234f56789101","description":"The vehicle identification number."},"currency_unit":{"type":"string","example":"eur","description":"The currency unit."},"mileage_unit":{"type":"string","example":"km","description":"The mileage unit."},"version":{"type":"string","example":"2020-01-01","description":"The version of the dataset the valuations are taken from (repeated for future valuations)."}}},"error":{"type":"string","example":"If there is an error the message would go here","description":"Details of what went wrong with the api call"}}}}}}},"security":[{"x-api-key":[]}]}},"/brego/metadatafromvin/v2":{"get":{"tags":["Brego"],"operationId":"brego_metadatafromvin","summary":"Metadata from VIN","description":"This endpoint provides metrics about market supply, advert age and price movements.","parameters":[{"name":"vehicle_identification_number","in":"query","description":"Vehicle identification (VIN) number","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"description":"Whether the api call was successful"},"result":{"type":"object","properties":{"regions":{"type":"array","items":{"properties":{"region":{"type":"string","example":"national","description":"The region of the country the data applies to."},"average_advert_days":{"type":"integer","example":12,"description":"The average number of days vehicles of this model is advertised."},"average_advert_miles_per_month":{"type":"integer","example":123,"description":"The average monthly mileage of vehicles of this model advertised within this region."},"average_advert_price_change":{"type":"integer","example":-123,"description":"The average change to the advertised price for this model within the last 7 days and within this region."},"average_manufacturer_miles_per_month":{"type":"integer","example":123,"description":"The average monthly mileage of vehicles from this manufacturer ."},"average_model_range_miles_per_month":{"type":"integer","example":123,"description":"The average monthly miles advertised vehicles of this model range have completed ."},"average_model_miles_per_month":{"type":"integer","example":123,"description":"The average monthly miles advertised vehicles of this model have completed."},"min_advert_price":{"type":"integer","example":12345,"description":"The minimum advertised price for this model."},"max_advert_price":{"type":"integer","example":12345,"description":"The maximum advertised price for this model."},"min_advert_mileage":{"type":"integer","example":12345,"description":"The minimum advertised price for this model."},"max_advert_mileage":{"type":"integer","example":12345,"description":"The maximum advertised price for this model."},"weekly_advert_qty_change":{"type":"integer","example":-12,"description":"The maximum advertised price for this model."},"advert_qty":{"type":"integer","example":1234,"description":"The number of adverts matching the query parameters"},"average_advert_owners_per_annum":{"type":"number","example":0.12,"description":"The average number of keepers per annum for this model."},"min_advert_previous_owners":{"type":"integer","example":0,"description":"The minimum number of previous keepers for advertised models."},"max_advert_previous_owners":{"type":"integer","example":2,"description":"The maximum number of previous keepers for advertised models."},"advert_vehicle_colours":{"type":"array","items":{"properties":{"count":{"type":"integer","example":123,"description":"The number of vehicles of this colour advertised."},"colour":{"type":"string","example":"Black","description":"Exterior colour of vehicle"}}}}}}}}},"error":{"type":"string","example":"If there is an error the message would go here","description":"Details of what went wrong with the api call"}}}}}}},"security":[{"x-api-key":[]}]}},"/brego/metadatafromvrm/v2":{"get":{"tags":["Brego"],"operationId":"brego_metadatafromvrm","summary":"Metadata from VRM","description":"This endpoint provides metrics about market supply, advert age and price movements.","parameters":[{"name":"vehicle_registration_mark","in":"query","description":"Vehicle registration number","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"description":"Whether the api call was successful"},"result":{"type":"object","properties":{"regions":{"type":"array","items":{"properties":{"region":{"type":"string","example":"national","description":"The region of the country the data applies to."},"average_advert_days":{"type":"integer","example":12,"description":"The average number of days vehicles of this model is advertised."},"average_advert_miles_per_month":{"type":"integer","example":123,"description":"The average monthly mileage of vehicles of this model advertised within this region."},"average_advert_price_change":{"type":"integer","example":-123,"description":"The average change to the advertised price for this model within the last 7 days and within this region."},"average_manufacturer_miles_per_month":{"type":"integer","example":123,"description":"The average monthly mileage of vehicles from this manufacturer ."},"average_model_range_miles_per_month":{"type":"integer","example":123,"description":"The average monthly miles advertised vehicles of this model range have completed ."},"average_model_miles_per_month":{"type":"integer","example":123,"description":"The average monthly miles advertised vehicles of this model have completed."},"min_advert_price":{"type":"integer","example":12345,"description":"The minimum advertised price for this model."},"max_advert_price":{"type":"integer","example":12345,"description":"The maximum advertised price for this model."},"min_advert_mileage":{"type":"integer","example":12345,"description":"The minimum advertised price for this model."},"max_advert_mileage":{"type":"integer","example":12345,"description":"The maximum advertised price for this model."},"weekly_advert_qty_change":{"type":"integer","example":-12,"description":"The maximum advertised price for this model."},"advert_qty":{"type":"integer","example":1234,"description":"The number of adverts matching the query parameters"},"average_advert_owners_per_annum":{"type":"number","example":0.12,"description":"The average number of keepers per annum for this model."},"min_advert_previous_owners":{"type":"integer","example":0,"description":"The minimum number of previous keepers for advertised models."},"max_advert_previous_owners":{"type":"integer","example":2,"description":"The maximum number of previous keepers for advertised models."},"advert_vehicle_colours":{"type":"array","items":{"properties":{"count":{"type":"integer","example":123,"description":"The number of vehicles of this colour advertised."},"colour":{"type":"string","example":"Black","description":"Exterior colour of vehicle"}}}}}}}}},"error":{"type":"string","example":"If there is an error the message would go here","description":"Details of what went wrong with the api call"}}}}}}},"security":[{"x-api-key":[]}]}},"/brego/search/v2":{"get":{"tags":["Brego"],"operationId":"brego_search","summary":"Search","description":"This endpoint allows you to search for matching derivatives using a combination of text and parameters.","parameters":[{"name":"vehicle_desc","in":"query","description":"The vehicle description","required":true,"schema":{"type":"string"}},{"name":"manufacturer_desc","in":"query","description":"The manufacturer description","required":false,"schema":{"type":"string"}},{"name":"model_range_desc","in":"query","description":"The model range description","required":false,"schema":{"type":"string"}},{"name":"first_registration_year","in":"query","description":"Year of registration","required":false,"schema":{"type":"integer"}},{"name":"fuel_type_desc","in":"query","description":"The vehicle's fuel type description","required":false,"schema":{"type":"string"}},{"name":"transmission_desc","in":"query","description":"The vehicle's transmission type","required":false,"schema":{"type":"string"}},{"name":"body_type_desc","in":"query","description":"The body type description","required":false,"schema":{"type":"string"}},{"name":"number_doors","in":"query","description":"The number of doors","required":false,"schema":{"type":"integer"}},{"name":"0to100_kmph","in":"query","description":"The number of seconds to go from Zero to 100 kmph","required":false,"schema":{"type":"number"}},{"name":"engine_capacity_cc","in":"query","description":"The engine capacity in cc","required":false,"schema":{"type":"integer"}},{"name":"number_cylinders","in":"query","description":"The number of cylinders","required":false,"schema":{"type":"integer"}},{"name":"power_bhp","in":"query","description":"The engine power bhp","required":false,"schema":{"type":"number"}},{"name":"number_gears","in":"query","description":"The number of gears","required":false,"schema":{"type":"integer"}},{"name":"top_speed_mph","in":"query","description":"The top speed (mph)","required":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"description":"Whether the api call was successful"},"result":{"type":"array","items":{"properties":{"brego_derivative_id":{"type":"string","example":"0a1bc3d4-ef56-789g-h10i-j111k21l3m14","description":"The Brego Derivative ID."},"brego_vehicle_description":{"type":"string","example":"MINI COUPE 1.6 Cooper 3dr (October 2011 - May 2015)","description":"The Brego vehicle description."}}}},"error":{"type":"string","example":"If there is an error the message would go here","description":"Details of what went wrong with the api call"}}}}}}},"security":[{"x-api-key":[]}]}},"/brego/valuationfromid/v2":{"get":{"tags":["Brego"],"operationId":"brego_valuationfromid","summary":"Current Valuation from Id","description":"This endpoint returns mileage adjusted high, average and low condition categories for retail and trade valuations.","parameters":[{"name":"brego_derivative_id","in":"query","description":"The Brego Derivative ID","required":true,"schema":{"type":"string"}},{"name":"current_mileage","in":"query","description":"The current mileage of the vehicle in full","required":true,"schema":{"type":"integer"}},{"name":"registration_date","in":"query","description":"Date the vehicle was first registered in the UK","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"description":"Whether the api call was successful"},"result":{"type":"object","properties":{"retail_low_valuation":{"type":"integer","example":12345,"description":"The suggested retail low valuation including VAT for the specified vehicle."},"retail_average_valuation":{"type":"integer","example":12345,"description":"The suggested retail average valuation including VAT for the specified vehicle."},"retail_high_valuation":{"type":"integer","example":12345,"description":"The suggested retail high valuation including VAT for the specified vehicle ."},"trade_low_valuation":{"type":"integer","example":12345,"description":"The suggested trade low valuation including VAT for the specified vehicle."},"trade_average_valuation":{"type":"integer","example":12345,"description":"The suggested trade average valuation including VAT for the specified vehicle."},"trade_high_valuation":{"type":"integer","example":12345,"description":"The suggested trade high valuation including VAT for the specified vehicle."},"current_mileage":{"type":"integer","example":12345,"description":"The current mileage of the vehicle in full."},"brego_derivative_id":{"type":"string","example":"0a1bc3d4-ef56-789g-h10i-j111k21l3m14","description":"The Brego Derivative ID."},"currency_unit":{"type":"string","example":"gbp","description":"The currency unit."},"mileage_unit":{"type":"string","example":"mi","description":"The mileage unit."},"version":{"type":"string","example":"2020-01-01","description":"The version of the dataset the valuations are taken from (repeated for future valuations)."}}},"error":{"type":"string","example":"If there is an error the message would go here","description":"Details of what went wrong with the api call"}}}}}}},"security":[{"x-api-key":[]}]}},"/brego/valuationfromvin/v2":{"get":{"tags":["Brego"],"operationId":"brego_valuationfromvin","summary":"Current Valuation from VIN","description":"This endpoint returns mileage adjusted high, average and low condition categories for retail and trade valuations.","parameters":[{"name":"vehicle_identification_number","in":"query","description":"Vehicle identification number","required":true,"schema":{"type":"string"}},{"name":"current_mileage","in":"query","description":"The current mileage of the vehicle in full","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"description":"Whether the api call was successful"},"result":{"type":"object","properties":{"retail_low_valuation":{"type":"integer","example":12345,"description":"The suggested retail low valuation including VAT for the specified vehicle."},"retail_average_valuation":{"type":"integer","example":12345,"description":"The suggested retail average valuation including VAT for the specified vehicle."},"retail_high_valuation":{"type":"integer","example":12345,"description":"The suggested retail high valuation including VAT for the specified vehicle ."},"trade_low_valuation":{"type":"integer","example":12345,"description":"The suggested trade low valuation including VAT for the specified vehicle."},"trade_average_valuation":{"type":"integer","example":12345,"description":"The suggested trade average valuation including VAT for the specified vehicle."},"trade_high_valuation":{"type":"integer","example":12345,"description":"The suggested trade high valuation including VAT for the specified vehicle."},"current_mileage":{"type":"integer","example":12345,"description":"The current mileage of the vehicle in full."},"brego_derivative_id":{"type":"string","example":"0a1bc3d4-ef56-789g-h10i-j111k21l3m14","description":"The Brego Derivative ID."},"vehicle_identification_number":{"type":"string","example":"ABCDE123456F78910","description":"The vehicle identification number."},"currency_unit":{"type":"string","example":"gbp","description":"The currency unit."},"mileage_unit":{"type":"string","example":"mi","description":"The mileage unit."},"version":{"type":"string","example":"2020-01-01","description":"The version of the dataset the valuations are taken from (repeated for future valuations)."}}},"error":{"type":"string","example":"If there is an error the message would go here","description":"Details of what went wrong with the api call"}}}}}}},"security":[{"x-api-key":[]}]}},"/brego/valuationfromvrm/v2":{"get":{"tags":["Brego"],"operationId":"brego_valuationfromvrm","summary":"Current Valuation from VRM","description":"This endpoint returns mileage adjusted high, average and low condition categories for retail and trade valuations.","parameters":[{"name":"vehicle_registration_mark","in":"query","description":"The vehicle registration mark","required":true,"schema":{"type":"string"}},{"name":"current_mileage","in":"query","description":"The current mileage of the vehicle in full","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"description":"Whether the api call was successful"},"result":{"type":"object","properties":{"retail_low_valuation":{"type":"integer","example":12345,"description":"The suggested retail low valuation including VAT for the specified vehicle."},"retail_average_valuation":{"type":"integer","example":12345,"description":"The suggested retail average valuation including VAT for the specified vehicle."},"retail_high_valuation":{"type":"integer","example":12345,"description":"The suggested retail high valuation including VAT for the specified vehicle ."},"trade_low_valuation":{"type":"integer","example":12345,"description":"The suggested trade low valuation including VAT for the specified vehicle."},"trade_average_valuation":{"type":"integer","example":12345,"description":"The suggested trade average valuation including VAT for the specified vehicle."},"trade_high_valuation":{"type":"integer","example":12345,"description":"The suggested trade high valuation including VAT for the specified vehicle."},"current_mileage":{"type":"integer","example":12345,"description":"The current mileage of the vehicle in full."},"brego_derivative_id":{"type":"string","example":"0a1bc3d4-ef56-789g-h10i-j111k21l3m14","description":"The Brego Derivative ID."},"vehicle_identification_number":{"type":"string","example":"ABCDE123456F78910","description":"The vehicle identification number."},"currency_unit":{"type":"string","example":"gbp","description":"The currency unit."},"mileage_unit":{"type":"string","example":"mi","description":"The mileage unit."},"version":{"type":"string","example":"2020-01-01","description":"The version of the dataset the valuations are taken from (repeated for future valuations)."}}},"error":{"type":"string","example":"If there is an error the message would go here","description":"Details of what went wrong with the api call"}}}}}}},"security":[{"x-api-key":[]}]}},"/carguide/mothistoryandpredictions/v2":{"get":{"tags":["Car guide"],"operationId":"carguide_mothistoryandpredictions","summary":"MOT History & Predictions","description":"This endpoint returns the MOT history of a vehicle including advisories, mileage and predicted risk of failure.","parameters":[{"name":"vehicle_registration_mark","in":"query","description":"Vehicle registration number","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"description":"Whether the api call was successful"},"result":{"type":"object","properties":{"dvsa_vehicle_Data":{"type":"object","properties":{"dvsa_vehicle_id":{"type":"string","example":"a-BCeFg1hi_kLm2nOPQRSt=_","description":"The DVSA Vehicle ID."},"vehicle_registration_mark":{"type":"string","example":"AB21ABC","description":"Vehicle registration number"},"manufacturer_desc":{"type":"string","example":"MINI","description":"Manufacturer description"},"model_range_desc":{"type":"string","example":"Convertible","description":"Model range description"},"first_registration_date":{"type":"string","example":"2020-01-01","description":"Date of first registration"},"date_registration":{"type":"string","example":"2020-01-01","description":"The date the vehicle was first registered."},"manufactured_date":{"type":"string","example":"2020-01-01","description":"The date of manufacture "},"engine_capacity_cc":{"type":"integer","example":1234,"description":"Engine capacity in cc"}}},"mot_tests":{"type":"array","items":{"properties":{"mot_test_number":{"type":"integer","example":123456789,"description":"The MOT test number."},"mot_test_date":{"type":"string","example":"2020-01-01","description":"The MOT test date."},"mot_test_result":{"type":"string","example":"PASSED","description":"The MOT test result."},"observation_mileage":{"type":"integer","example":12345,"description":"The MOT test recorded mileage."},"reason_for_refusal_and_comments":{"type":"array","items":{"properties":{"comments":{"type":"string","example":"Nearside Rear Tyre worn close to legal limit","description":"The MOT comments."},"type":{"type":"string","example":"ADVISORY","description":"The refusal type."},"is_dangerous":{"type":"boolean","example":false,"description":"Is the vehicle dangerous to drive."}}}}}}},"mileage_observation":{"type":"array","items":{"properties":{"observation_date":{"type":"string","example":"2020-01-01","description":"The date of mileage observation."},"observation_source":{"type":"string","example":"DVSA","description":"The source of mileage observation."},"observation_mileage":{"type":"integer","example":12345,"description":"The MOT test recorded mileage."}}}},"component_failure_risk":{"type":"object","properties":{"trailingarm":{"type":"object","properties":{"predicted_fail_overall_percentage":{"type":"number","example":12.345678910111213,"description":"The probability of an overall fail."},"predicted_pass_overall_percentage":{"type":"number","example":12.345678910111213,"description":"The probability of an overall pass."},"straight_pass_percentage":{"type":"number","example":12.345678910111213,"description":"The probability of a straight pass."},"advisory_pass_percentage":{"type":"number","example":12.345678910111213,"description":"The probability of an MOT pass when the vehicle has an advisory note."},"minor_defect_pass_percentage":{"type":"number","example":12.345678910111213,"description":"The probability the defect is not severe enough to fail MOT but should be repaired soon ."}}},"foglamp":{"type":"object","properties":{"predicted_fail_overall_percentage":{"type":"number","example":12.345678910111213,"description":"The probability of an overall fail."},"predicted_pass_overall_percentage":{"type":"number","example":12.345678910111213,"description":"The probability of an overall pass."},"straight_pass_percentage":{"type":"number","example":12.345678910111213,"description":"The probability of a straight pass."},"advisory_pass_percentage":{"type":"number","example":12.345678910111213,"description":"The probability of an MOT pass when the vehicle has an advisory note."},"minor_defect_pass_percentage":{"type":"number","example":12.345678910111213,"description":"The probability the defect is not severe enough to fail MOT but should be repaired soon ."}}},"seatbelt":{"type":"object","properties":{"predicted_fail_overall_percentage":{"type":"number","example":12.345678910111213,"description":"The probability of an overall fail."},"predicted_pass_overall_percentage":{"type":"number","example":12.345678910111213,"description":"The probability of an overall pass."},"straight_pass_percentage":{"type":"number","example":12.345678910111213,"description":"The probability of a straight pass."},"advisory_pass_percentage":{"type":"number","example":12.345678910111213,"description":"The probability of an MOT pass when the vehicle has an advisory note."},"minor_defect_pass_percentage":{"type":"number","example":12.345678910111213,"description":"The probability the defect is not severe enough to fail MOT but should be repaired soon ."}}},"subframe":{"type":"object","properties":{"predicted_fail_overall_percentage":{"type":"number","example":12.345678910111213,"description":"The probability of an overall fail."},"predicted_pass_overall_percentage":{"type":"number","example":12.345678910111213,"description":"The probability of an overall pass."},"straight_pass_percentage":{"type":"number","example":12.345678910111213,"description":"The probability of a straight pass."},"advisory_pass_percentage":{"type":"number","example":12.345678910111213,"description":"The probability of an MOT pass when the vehicle has an advisory note."},"minor_defect_pass_percentage":{"type":"number","example":12.345678910111213,"description":"The probability the defect is not severe enough to fail MOT but should be repaired soon ."}}},"horn":{"type":"object","properties":{"predicted_fail_overall_percentage":{"type":"number","example":12.345678910111213,"description":"The probability of an overall fail."},"predicted_pass_overall_percentage":{"type":"number","example":12.345678910111213,"description":"The probability of an overall pass."},"straight_pass_percentage":{"type":"number","example":12.345678910111213,"description":"The probability of a straight pass."},"advisory_pass_percentage":{"type":"number","example":12.345678910111213,"description":"The probability of an MOT pass when the vehicle has an advisory note."},"minor_defect_pass_percentage":{"type":"number","example":12.345678910111213,"description":"The probability the defect is not severe enough to fail MOT but should be repaired soon ."}}},"indicator":{"type":"object","properties":{"predicted_fail_overall_percentage":{"type":"number","example":12.345678910111213,"description":"The probability of an overall fail."},"predicted_pass_overall_percentage":{"type":"number","example":12.345678910111213,"description":"The probability of an overall pass."},"straight_pass_percentage":{"type":"number","example":12.345678910111213,"description":"The probability of a straight pass."},"advisory_pass_percentage":{"type":"number","example":12.345678910111213,"description":"The probability of an MOT pass when the vehicle has an advisory note."},"minor_defect_pass_percentage":{"type":"number","example":12.345678910111213,"description":"The probability the defect is not severe enough to fail MOT but should be repaired soon ."}}},"brakepads":{"type":"object","properties":{"predicted_fail_overall_percentage":{"type":"number","example":12.345678910111213,"description":"The probability of an overall fail."},"predicted_pass_overall_percentage":{"type":"number","example":12.345678910111213,"description":"The probability of an overall pass."},"straight_pass_percentage":{"type":"number","example":12.345678910111213,"description":"The probability of a straight pass."},"advisory_pass_percentage":{"type":"number","example":12.345678910111213,"description":"The probability of an MOT pass when the vehicle has an advisory note."},"minor_defect_pass_percentage":{"type":"number","example":12.345678910111213,"description":"The probability the defect is not severe enough to fail MOT but should be repaired soon ."}}},"airbag":{"type":"object","properties":{"predicted_fail_overall_percentage":{"type":"number","example":12.345678910111213,"description":"The probability of an overall fail."},"predicted_pass_overall_percentage":{"type":"number","example":12.345678910111213,"description":"The probability of an overall pass."},"straight_pass_percentage":{"type":"number","example":12.345678910111213,"description":"The probability of a straight pass."},"advisory_pass_percentage":{"type":"number","example":12.345678910111213,"description":"The probability of an MOT pass when the vehicle has an advisory note."},"minor_defect_pass_percentage":{"type":"number","example":12.345678910111213,"description":"The probability the defect is not severe enough to fail MOT but should be repaired soon ."}}},"headlamp":{"type":"object","properties":{"predicted_fail_overall_percentage":{"type":"number","example":12.345678910111213,"description":"The probability of an overall fail."},"predicted_pass_overall_percentage":{"type":"number","example":12.345678910111213,"description":"The probability of an overall pass."},"straight_pass_percentage":{"type":"number","example":12.345678910111213,"description":"The probability of a straight pass."},"advisory_pass_percentage":{"type":"number","example":12.345678910111213,"description":"The probability of an MOT pass when the vehicle has an advisory note."},"minor_defect_pass_percentage":{"type":"number","example":12.345678910111213,"description":"The probability the defect is not severe enough to fail MOT but should be repaired soon ."}}},"tyre":{"type":"object","properties":{"predicted_fail_overall_percentage":{"type":"number","example":12.345678910111213,"description":"The probability of an overall fail."},"predicted_pass_overall_percentage":{"type":"number","example":12.345678910111213,"description":"The probability of an overall pass."},"straight_pass_percentage":{"type":"number","example":12.345678910111213,"description":"The probability of a straight pass."},"advisory_pass_percentage":{"type":"number","example":12.345678910111213,"description":"The probability of an MOT pass when the vehicle has an advisory note."},"minor_defect_pass_percentage":{"type":"number","example":12.345678910111213,"description":"The probability the defect is not severe enough to fail MOT but should be repaired soon ."}}},"engine":{"type":"object","properties":{"predicted_fail_overall_percentage":{"type":"number","example":12.345678910111213,"description":"The probability of an overall fail."},"predicted_pass_overall_percentage":{"type":"number","example":12.345678910111213,"description":"The probability of an overall pass."},"straight_pass_percentage":{"type":"number","example":12.345678910111213,"description":"The probability of a straight pass."},"advisory_pass_percentage":{"type":"number","example":12.345678910111213,"description":"The probability of an MOT pass when the vehicle has an advisory note."},"minor_defect_pass_percentage":{"type":"number","example":12.345678910111213,"description":"The probability the defect is not severe enough to fail MOT but should be repaired soon ."}}},"brakepipe":{"type":"object","properties":{"predicted_fail_overall_percentage":{"type":"number","example":12.345678910111213,"description":"The probability of an overall fail."},"predicted_pass_overall_percentage":{"type":"number","example":12.345678910111213,"description":"The probability of an overall pass."},"straight_pass_percentage":{"type":"number","example":12.345678910111213,"description":"The probability of a straight pass."},"advisory_pass_percentage":{"type":"number","example":12.345678910111213,"description":"The probability of an MOT pass when the vehicle has an advisory note."},"minor_defect_pass_percentage":{"type":"number","example":12.345678910111213,"description":"The probability the defect is not severe enough to fail MOT but should be repaired soon ."}}},"abs":{"type":"object","properties":{"predicted_fail_overall_percentage":{"type":"number","example":12.345678910111213,"description":"The probability of an overall fail."},"predicted_pass_overall_percentage":{"type":"number","example":12.345678910111213,"description":"The probability of an overall pass."},"straight_pass_percentage":{"type":"number","example":12.345678910111213,"description":"The probability of a straight pass."},"advisory_pass_percentage":{"type":"number","example":12.345678910111213,"description":"The probability of an MOT pass when the vehicle has an advisory note."},"minor_defect_pass_percentage":{"type":"number","example":12.345678910111213,"description":"The probability the defect is not severe enough to fail MOT but should be repaired soon ."}}},"seat":{"type":"object","properties":{"predicted_fail_overall_percentage":{"type":"number","example":12.345678910111213,"description":"The probability of an overall fail."},"predicted_pass_overall_percentage":{"type":"number","example":12.345678910111213,"description":"The probability of an overall pass."},"straight_pass_percentage":{"type":"number","example":12.345678910111213,"description":"The probability of a straight pass."},"advisory_pass_percentage":{"type":"number","example":12.345678910111213,"description":"The probability of an MOT pass when the vehicle has an advisory note."},"minor_defect_pass_percentage":{"type":"number","example":12.345678910111213,"description":"The probability the defect is not severe enough to fail MOT but should be repaired soon ."}}},"exhaust":{"type":"object","properties":{"predicted_fail_overall_percentage":{"type":"number","example":12.345678910111213,"description":"The probability of an overall fail."},"predicted_pass_overall_percentage":{"type":"number","example":12.345678910111213,"description":"The probability of an overall pass."},"straight_pass_percentage":{"type":"number","example":12.345678910111213,"description":"The probability of a straight pass."},"advisory_pass_percentage":{"type":"number","example":12.345678910111213,"description":"The probability of an MOT pass when the vehicle has an advisory note."},"minor_defect_pass_percentage":{"type":"number","example":12.345678910111213,"description":"The probability the defect is not severe enough to fail MOT but should be repaired soon ."}}},"body":{"type":"object","properties":{"predicted_fail_overall_percentage":{"type":"number","example":12.345678910111213,"description":"The probability of an overall fail."},"predicted_pass_overall_percentage":{"type":"number","example":12.345678910111213,"description":"The probability of an overall pass."},"straight_pass_percentage":{"type":"number","example":12.345678910111213,"description":"The probability of a straight pass."},"advisory_pass_percentage":{"type":"number","example":12.345678910111213,"description":"The probability of an MOT pass when the vehicle has an advisory note."},"minor_defect_pass_percentage":{"type":"number","example":12.345678910111213,"description":"The probability the defect is not severe enough to fail MOT but should be repaired soon ."}}}}}}},"error":{"type":"string","example":"If there is an error the message would go here","description":"Details of what went wrong with the api call"}}}}}}},"security":[{"x-api-key":[]}]}},"/carguide/salvagecheck/v2":{"get":{"tags":["Car guide"],"operationId":"carguide_salvagecheck","summary":"Salvage Check","description":"This endpoint identifies vehicles that have previously been listed for sale in a salvage auction. Salvage records include the lot date, description, mileage and damage details.","parameters":[{"name":"vehicle_registration_mark","in":"query","description":"Vehicle registration number","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"description":"Whether the api call was successful"},"result":{"type":"object","properties":{"salvage_auction_record_found":{"type":"boolean","example":true,"description":"Salvage record has been found"},"salvage_auction_records":{"type":"array","items":{"properties":{"salvage_auction_record_id":{"type":"integer","example":1234567,"description":"Salvage record id"},"salvage_auction_lot_desc":{"type":"string","example":"Nissan Qashqai","description":"Salvage auction lot description"},"salvage_auction_lot_date":{"type":"string","example":"2020-01-01","description":"The salvage auction date"},"mileage":{"type":"integer","example":12345,"description":" The current mileage of the vehicle in full"},"primary_damage_desc":{"type":"string","example":"Slight Front Damage","description":" The primary damage description"},"secondary_damage_desc":{"type":"string","example":"Unable to select 5th gear, steering poor.","description":" The secondary damage description"},"external_image_urls":{"type":"array","items":{}}}}}}},"error":{"type":"string","example":"If there is an error the message would go here","description":"Details of what went wrong with the api call"}}}}}}},"security":[{"x-api-key":[]}]}},"/carguide/taxicheck/v2":{"get":{"tags":["Car guide"],"operationId":"carguide_taxicheck","summary":"Taxi Check","description":"This endpoint returns a true/false identifier confirming whether the vehicle has been used as a taxi or private hire vehicle. If the vehicle has been previously used as a taxi or private hire vehicle, then make, model, fuel type, licence start & end date, whether the vehicle is wheelchair adapted and licence holder name is also returned. This endpoint returns a true/false identifier confirming whether the vehicle has been used as a taxi or private hire vehicle. If the vehicle has been previously used as a taxi or private hire vehicle, then make, model, fuel type, licence start & end date, whether the vehicle is wheelchair adapted and licence holder name is also returned.","parameters":[{"name":"vehicle_registration_mark","in":"query","description":"Vehicle registration number","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"description":"Whether the api call was successful"},"result":{"type":"object","properties":{"is_possible_taxi":{"type":"boolean","example":true,"description":"Has the vehicle been previously used as a taxi."},"taxi_records":{"type":"array","items":{"properties":{"taxi_record_id":{"type":"integer","example":123456,"description":"The taxi record ID."},"manufacturer_desc":{"type":"string","example":"MINI","description":"Manufacturer description"},"model_range_desc":{"type":"string","example":"Convertible","description":"Model range description"},"manufacturer_model_desc":{"type":"string","example":"MINI Convertible","description":"The model range description."},"licence_start_date":{"type":"string","example":"2020-01-01","description":"The taxi and private hire licence start date."},"licence_expiry_date":{"type":"string","example":"2020-01-01","description":"The taxi and private hire licence expiry date."},"is_wheelchair_adapted":{"type":"boolean","example":false,"description":"Is the vehicle wheelchair adapated."},"carguide_fuel_type_desc":{"type":"string","example":"Petrol","description":"The licence holder's name."},"licence_holder_name":{"type":"string","example":"Jane Smith","description":"The vehicle's fuel type"}}}}}},"error":{"type":"string","example":"If there is an error the message would go here","description":"Details of what went wrong with the api call"}}}}}}},"security":[{"x-api-key":[]}]}},"/clearwatt/expectedrangefromvrm":{"get":{"tags":["ClearWatt"],"operationId":"clearwatt_expectedrangefromvrm","summary":"Expected Range From VRM","description":"This endpoint provides realistic range expectations based on vehicle age and mileage, compared to benchmark real range when new.","parameters":[{"name":"vehicle_registration_mark","in":"query","description":"Vehicle registration number","required":true,"schema":{"type":"string"}},{"name":"current_mileage","in":"query","description":"The current mileage of the vehicle in full","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"description":"Whether the api call was successful"},"result":{"type":"object","properties":{"vehicle_info":{"type":"object","properties":{"vehicle_registration_mark":{"type":"string","example":"AB21ABC","description":"Vehicle registration number"},"current_mileage":{"type":"integer","example":35000,"description":"The current mileage of the vehicle in full."},"manufacturer_desc":{"type":"string","example":"Jaguar","description":"Manufacturer description"},"model_range_desc":{"type":"string","example":"I-Pace","description":"Model range description"},"variant_desc":{"type":"string","example":"EV400","description":"Variant description"},"manufactured_year":{"type":"integer","example":2020,"description":"Year of manufacturer"},"battery_capacity_kwh":{"type":"integer","example":90,"description":"Battery capacity in kwh"},"usable_battery_capacity_kwh":{"type":"number","example":84.7,"description":"The usable battery capacity in kwh"},"wltp_pure_electric_range_combined_miles_test_energy_low":{"type":"number","example":292,"description":"WLTP pure electric range combined miles test energy low"}}},"remaining_battery_warranty":{"type":"object","properties":{"miles":{"type":"integer","example":65000,"description":"The remaining battery warranty miles"},"months":{"type":"integer","example":59,"description":"The remaining battery warranty months"}}},"benchmark_real_electric_range_new":{"type":"object","properties":{"min_range_miles":{"type":"integer","example":218,"description":"The minimum range in miles"},"max_range_miles":{"type":"integer","example":236,"description":"The maximum range in miles"}}},"expected_real_electric_range_now":{"type":"object","properties":{"min_range_miles":{"type":"integer","example":203,"description":"The minimum range in miles"},"max_range_miles":{"type":"integer","example":220,"description":"The maximum range in miles"}}},"battery_health_test_result":{"type":"object","properties":{"is_record_available":{"type":"boolean","example":true,"description":"The maximum range in miles"},"test_date":{"type":"string","example":"2024-01-10","description":"The battery test date"},"test_result_grade":{"type":"string","example":"A+","description":"The battery test result grade"},"min_range_miles":{"type":"integer","example":205,"description":"The minimum range in miles"},"max_range_miles":{"type":"integer","example":223,"description":"The maximum range in miles"}}}}},"error":{"type":"string","example":"If there is an error the message would go here","description":"Details of what went wrong with the api call"}}}}}}},"security":[{"x-api-key":[]}]}},"/companycar/compare/v2":{"get":{"tags":["One Auto API"],"operationId":"companycar_compare","summary":"Company Car Cash or PCH","description":"This endpoint returns the tax savings when considering opting for a cash monthly allowance over a company car or PCH.","parameters":[{"name":"co2_gkm","in":"query","description":"CO2 in g/km","required":true,"schema":{"type":"integer"}},{"name":"list_price_inc_delivery_vat","in":"query","description":"List price + Delivery price including VAT","required":true,"schema":{"type":"number"}},{"name":"zero_emission_mileage","in":"query","description":"Maximum distance in miles that can be driven in electric mode without recharging the battery","required":true,"schema":{"type":"integer"}},{"name":"annual_earnings","in":"query","description":"Employee's annual earnings before tax","required":true,"schema":{"type":"integer"}},{"name":"scottish_tax_payer","in":"query","description":"Is the employee at Scottish tax payer i.e. true, false","required":true,"schema":{"type":"boolean"}},{"name":"monthly_allowance","in":"query","description":"The amount of monthly allowance you receive for a vehicle","required":true,"schema":{"type":"integer"}},{"name":"monthly_rental_inc_VAT","in":"query","description":"Monthly rental cost including VAT","required":true,"schema":{"type":"integer"}},{"name":"monthly_maintenance_inc_VAT","in":"query","description":"The monthly maintenance cost including VAT","required":true,"schema":{"type":"integer"}},{"name":"term_months","in":"query","description":"Term of agreement (months)","required":true,"schema":{"type":"integer"}},{"name":"number_advance_rentals","in":"query","description":"Number of advance rentals","required":true,"schema":{"type":"integer"}},{"name":"number_scheduled_rentals","in":"query","description":"Number of scheduled rental payments","required":true,"schema":{"type":"integer"}},{"name":"initial_payment","in":"query","description":"Initial payment towards PCH deal","required":false,"schema":{"type":"integer"}},{"name":"admin_fees","in":"query","description":"Administration fee","required":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"description":"Whether the api call was successful"},"result":{"type":"object","properties":{"net_costbenefit_per_month":{"type":"object","properties":{"net_costbenefit_per_month_Y1":{"type":"number","example":1.23,"description":"The net cost benefit per month for year one."},"net_costbenefit_per_month_Y2":{"type":"number","example":1.23,"description":"The net cost benefit per month for year two."},"net_costbenefit_per_month_Y3":{"type":"number","example":1.23,"description":"The net cost benefit per month for year three."},"net_costbenefit_per_month_Y4":{"type":"number","example":1.23,"description":"The net cost benefit per month for year four."},"net_costbenefit_per_month_Y5":{"type":"number","example":1.23,"description":"The net cost benefit per month for year five."}}},"tax_saving_per_month":{"type":"object","properties":{"tax_saving_per_month_Y1":{"type":"number","example":123.5,"description":"The tax saving per month for year one."},"tax_saving_per_month_Y2":{"type":"number","example":123.5,"description":"The tax saving per month for year two."},"tax_saving_per_month_Y3":{"type":"number","example":123.5,"description":"The tax saving per month for year three."},"tax_saving_per_month_Y4":{"type":"number","example":123.5,"description":"The tax saving per month for year four."},"tax_saving_per_month_Y5":{"type":"number","example":123.5,"description":"The tax saving per month for year five."}}},"additional_net_pay_per_month":{"type":"object","properties":{"additional_net_pay_per_month_Y1":{"type":"number","example":123.45,"description":"The additional net pay per month for year one."},"additional_net_pay_per_month_Y2":{"type":"number","example":123.45,"description":"The additional net pay per month for year two."},"additional_net_pay_per_month_Y3":{"type":"number","example":123.45,"description":"The additional net pay per month for year three."},"additional_net_pay_per_month_Y4":{"type":"number","example":123.45,"description":"The additional net pay per month for year four."},"additional_net_pay_per_month_Y5":{"type":"number","example":123.45,"description":"The additional net pay per month for year five."}}},"average_vehicle_cost_per_month":{"type":"number","example":123.45,"description":"The average cost per month."},"average_maintenance_cost_per_month":{"type":"number","example":123.45,"description":"The average maintenance cost per month."},"total_car_cost_per_month":{"type":"number","example":123.45,"description":"The total cost per month. i.e. vehicle and maintenance costs ."}}},"error":{"type":"string","example":"If there is an error the message would go here","description":"Details of what went wrong with the api call"}}}}}}},"security":[{"x-api-key":[]}]}},"/companycar/tax/v2":{"get":{"tags":["One Auto API"],"operationId":"companycar_tax","summary":"Company Car Tax Calculator","description":"This endpoint returns the percentage charge, benefit-in-kind (BIK) and additional monthly tax calculation.","parameters":[{"name":"co2_gkm","in":"query","description":"CO2 in g/km","required":true,"schema":{"type":"integer"}},{"name":"list_price_inc_options_delivery_vat","in":"query","description":"List price + options + delivery price including VAT","required":true,"schema":{"type":"integer"}},{"name":"zero_emission_mileage","in":"query","description":"Maximum distance in miles that can be driven in electric mode without recharging the battery","required":true,"schema":{"type":"integer"}},{"name":"capital_contribution","in":"query","description":"The payments the employee makes towards the cost of the car or qualifying accessories","required":true,"schema":{"type":"integer"}},{"name":"contribution_toward_private_use_per_annum","in":"query","description":"The payment the employee makes towards the car to allow them to use the vehicle for private purposes","required":true,"schema":{"type":"integer"}},{"name":"annual_earnings","in":"query","description":"Employee's annual earnings before tax","required":true,"schema":{"type":"integer"}},{"name":"scottish_tax_payer","in":"query","description":"Is the employee at Scottish tax payer i.e. true, false","required":true,"schema":{"type":"boolean"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"description":"Whether the api call was successful"},"result":{"type":"object","properties":{"percentage_charge":{"type":"object","properties":{"percentage_charge_Y1":{"type":"integer","example":12,"description":"The percentage_charge for year one."},"percentage_charge_Y2":{"type":"integer","example":12,"description":"The percentage_charge for year two."},"percentage_charge_Y3":{"type":"integer","example":12,"description":"The percentage_charge for year three."},"percentage_charge_Y4":{"type":"integer","example":12,"description":"The percentage_charge for year four."},"percentage_charge_Y5":{"type":"integer","example":12,"description":"The percentage_charge for year fifth."}}},"benefit_in_kind_per_annum":{"type":"object","properties":{"benefit_in_kind_per_annum_Y1":{"type":"string","example":"1234.50","description":"The benefit in kind (the valuation of the vehicle for tax purposes for each tax year ) for the first year ."},"benefit_in_kind_per_annum_Y2":{"type":"string","example":"1234.50","description":"The benefit in kind (the valuation of the vehicle for tax purposes for each tax year ) for the second year ."},"benefit_in_kind_per_annum_Y3":{"type":"string","example":"1234.50","description":"The benefit in kind (the valuation of the vehicle for tax purposes for each tax year ) for the third year ."},"benefit_in_kind_per_annum_Y4":{"type":"string","example":"1234.50","description":"The benefit in kind (the valuation of the vehicle for tax purposes for each tax year ) for the fourth year ."},"benefit_in_kind_per_annum_Y5":{"type":"string","example":"1234.50","description":"The benefit in kind (the valuation of the vehicle for tax purposes for each tax year ) for the fifth year ."}}},"calculated_tax_per_month":{"type":"object","properties":{"calculated_tax_per_month_Y1":{"type":"number","example":123.45,"description":"The calculated tax per month in the first year."},"calculated_tax_per_month_Y2":{"type":"number","example":123.45,"description":"The calculated tax per month in the second year."},"calculated_tax_per_month_Y3":{"type":"number","example":123.45,"description":"The calculated tax per month in the third year."},"calculated_tax_per_month_Y4":{"type":"number","example":123.45,"description":"The calculated tax per month in the forth year."},"calculated_tax_per_month_Y5":{"type":"number","example":123.45,"description":"The calculated tax per month in the fifth year."}}}}},"error":{"type":"string","example":"If there is an error the message would go here","description":"Details of what went wrong with the api call"}}}}}}},"security":[{"x-api-key":[]}]}},"/driverightdata/cataloguedata/v2":{"get":{"tags":["DriveRight"],"operationId":"driverightdata_cataloguedata","summary":"Tyre Catalogue by Size","description":"This endpoint returns the EAN coded catalogue data.","parameters":[],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"description":"Whether the api call was successful"},"result":{"type":"object","properties":{"exact_match_tyres":{"type":"array","items":{"properties":{"ean_number":{"type":"integer","example":1234567890,"description":"The EAN Number."},"description_1":{"type":"string","example":"123/45 R20 108W","description":"Description 1."},"description_2":{"type":"string","example":"Example 001 ABC","description":"Description 2."},"brand_desc":{"type":"string","example":"Example Brand","description":"The brand description."},"design_1_desc":{"type":"string","example":"Example 001","description":"The design 1 description."},"design_2_desc":{"type":"string","example":"Example 002","description":"The design 2 description."},"product_group_2_desc":{"type":"string","example":"Example Off Road","description":"The product group 2 description."},"tyre_width_mm":{"type":"string","example":"123","description":"The tyre width in mm."},"aspect_ratio":{"type":"string","example":"12","description":"The aspect ratio."},"rim_size_inch":{"type":"string","example":"12","description":"The rim size in inches."},"tubeless_or_tubetype":{"type":"string","example":"TL","description":"Is the tyre tubeless or if not the tyre tube type."},"construction_1":{"type":"string","example":"R","description":"The tyre construction type i.e. radial, bias and belted-bias."},"construction_2":{"type":"string","example":"B","description":"The tyre construction type i.e. radial, bias and belted-bias."},"tread_design_key":{"type":"string","example":"TBC","description":"The tread design key."},"is_run_flat":{"type":"string","example":"Y","description":"Is the tyre run flat."},"supplier_product_code":{"type":"string","example":"1234","description":"The supplier product code."},"product_type_code":{"type":"string","example":"123","description":"The product type code."},"product_lifecycle":{"type":"string","example":"3 - active","description":"The product lifecycle."},"product_attribute_1":{"type":"string","example":"summer (all axle)","description":"The product attribute (1)."},"product_attribute_2":{"type":"string","example":"off road","description":"The product attribute (2)."},"product_attribute_3":{"type":"string","example":"n/a","description":"The product attribute (3)."},"product_info":{"type":"string","example":"TBC","description":"The product info."},"design_variant":{"type":"string","example":"TBC","description":"The design variant."},"driveright_vehicle_type":{"type":"string","example":"L4","description":"The DriveRight vehicle type."},"ec_vehicle_class":{"type":"string","example":"C1","description":"The EC vehicle class."},"eu_directive_number":{"type":"string","example":"2020/123","description":"The EU directive number."},"gross_undiscounted_price_gbp_inc_vat":{"type":"string","example":"123.45","description":"The gross undiscounted price in GBP including VAT."},"gross_price_valid_from":{"type":"string","example":"20200101","description":"The date the gross price is valid from (yyyymmdd)."},"net_undiscounted_price_gbp_ex_vat":{"type":"string","example":"123.45","description":"The net undiscounted price in GBP excluding VAT."},"net_price_valid_from":{"type":"string","example":"20200101","description":"The date the net price is valid from (yyyymmdd)."},"recycling_fee_gbp":{"type":"string","example":"123.45","description":"The recycling fee in GBP."},"suggested_retail_price_gbp":{"type":"string","example":"123.45","description":"The suggested retail price in GBP."},"recommended_replacement_ean_number":{"type":"string","example":"1234567890","description":"The recommended replacement EAN Number."},"width_inch":{"type":"string","example":"12","description":"The width in inches."},"tread_depth_mm":{"type":"string","example":"1,00","description":"The tread depth in mm."},"rim_size_mm":{"type":"string","example":"1,00","description":"The rim size in mm."},"overall_diameter_inch":{"type":"string","example":"123","description":"The overall diameter in inches."},"load_index":{"type":"string","example":"123","description":"The load index."},"load_index_2":{"type":"string","example":"123","description":"The load index (2)."},"load_index_3_dual_wheelbase":{"type":"string","example":"TBC","description":"The load index (3) dual wheelbase."},"load_index_4_dual_wheelbase":{"type":"string","example":"TBC","description":"The load index (4) dual wheelbase."},"speed_index":{"type":"string","example":"W","description":"The speed index."},"is_3PMSF_mark":{"type":"string","example":"Y","description":"The tyre has a 3PMSF mark."},"reinforced":{"type":"string","example":"Y","description":"Is the tyre reinforced"},"special_compound":{"type":"string","example":"Y","description":"Is this a special compound tyre."},"is_assymetric":{"type":"string","example":"Y","description":"Is the tyre tread assymetric"},"is_directional":{"type":"string","example":"Y","description":"Is the tyre tread directional."},"tra_code":{"type":"string","example":"E3","description":"The TRA Code."},"internet_image_url":{"type":"string","example":"https://api.driverightdata.com/example/example.png","description":"The image URL."},"full_view_image_url":{"type":"string","example":"https://api.driverightdata.com/example/example.png","description":"The full view image URL."},"front_face_cutout_image_url":{"type":"string","example":"https://api.driverightdata.com/example/example.png","description":"The front face cutout image URL."},"front_face_half_image_url":{"type":"string","example":"https://api.driverightdata.com/example/example.png","description":"The front face half image URL."},"sidewall_image_url":{"type":"string","example":"https://api.driverightdata.com/example/example.png","description":"The sidewall image URL."},"sidewall_image_1_url":{"type":"string","example":"https://api.driverightdata.com/example/example.png","description":"The sidewall image (1) URL."},"is_flank_reinforced":{"type":"string","example":"Y","description":"Is the tyre flank reinforced."},"is_self_repairing":{"type":"string","example":"Y","description":"Is the tyre self repairing."},"weight_g":{"type":"string","example":"12,345","description":"The weight in grams."},"rolling_resistance_rating":{"type":"string","example":"B","description":"The rolling resistance rating."},"wet_grip_rating":{"type":"string","example":"A","description":"The wet grip rating."},"noise_performance_db":{"type":"string","example":"12","description":"The noise performance in decibels."},"noise_class":{"type":"string","example":"A","description":"The noise class."},"tyre_type_id":{"type":"string","example":"1234","description":"The tyre type id."},"ec_conforming_label_url":{"type":"string","example":"https://api.driverightdata.com/example/example","description":"The EC conforming label URL."}}}}}},"error":{"type":"string","example":"If there is an error the message would go here","description":"Details of what went wrong with the api call"}}}}}}},"security":[{"x-api-key":[]}]}},"/driverightdata/oetyrefitmentdata/v2":{"get":{"tags":["DriveRight"],"operationId":"driverightdata_oetyrefitmentdata","summary":"OE Tyre Fitment Data","description":"This endpoint returns the tyre size(s) for each of the OE wheel options. An object is returned for each of the OE primary and OE upgrade fitment ids.","parameters":[{"name":"vehicle_registration_mark","in":"query","description":"Vehicle registration number","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"description":"Whether the api call was successful"},"result":{"type":"object","properties":{"mvris_data":{"type":"object","properties":{"mvris_manufacturer_desc":{"type":"string","example":"NISSAN","description":"MVRIS manufacturer description"},"mvris_model_range_desc":{"type":"string","example":"QASHQAI (J10)","description":"MVRIS model range description"},"mvris_derivative_desc":{"type":"string","example":"DCI ACENTA IS","description":"MVRIS derivative description"},"mvris_vehicle_desc":{"type":"string","example":"NISSAN QASHQAI (J10) DCI ACENTA IS","description":"MVRIS vehicle description."},"mvris_code":{"type":"string","example":"A1ABC","description":"MVRIS Code"}}},"dvla_data":{"type":"object","properties":{"dvla_manufacturer_desc":{"type":"string","example":"NISSAN","description":"DVLA manufacturer description"},"dvla_model_desc":{"type":"string","example":"QASHQAI ACENTA PREMIUM DCI","description":"DVLA model description"},"first_registration_date":{"type":"string","example":"2020-01-01","description":"Date of first registration"},"vehicle_registration_mark":{"type":"string","example":"AB21ABC","description":"Vehicle registration number"},"vehicle_identification_number":{"type":"string","example":"ABCDE123456F78910","description":"The vehicle identification number."},"engine_number":{"type":"string","example":"A12345678","description":"Vehicle engine number"},"dvla_vehicle_desc":{"type":"string","example":"NISSAN QASHQAI ACENTA IS DCI","description":"DVLA vehicle description"}}},"drd_data":{"type":"object","properties":{"drd_chassis_id":{"type":"integer","example":12345,"description":"DriveRightData chassis ID"},"oe_primary_fitment_id":{"type":"integer","example":123456,"description":"OE primary fitment ID"},"oe_upgrade_1_fitment_id":{"type":"integer","example":123456,"description":"OE upgrade (1) fitment ID"},"oe_upgrade_2_fitment_id":{"type":"integer","example":123456,"description":"OE upgrade (2) fitment ID"},"oe_upgrade_3_fitment_id":{"type":"integer","example":123456,"description":"OE upgrade (3) fitment ID"},"oe_upgrade_4_fitment_id":{"type":"integer","example":123456,"description":"OE upgrade (4) fitment ID"},"oe_upgrade_5_fitment_id":{"type":"integer","example":123456,"description":"OE upgrade (5) fitment ID"}}},"oe_data":{"type":"object","properties":{"modelIDs":{"type":"array","items":{"properties":{"fitment_id":{"type":"integer","example":12345,"description":"Fitment ID"},"drd_model_name":{"type":"string","example":"Qashqai. 1.6 DCi Acenta","description":"DriveRightData model name"},"tyre_size_front":{"type":"string","example":"123/60R17","description":"Front tyre size"},"load_index_front":{"type":"integer","example":12,"description":"Front tyre load index"},"speed_index_front":{"type":"string","example":"H","description":"Front tyre speed index"},"rim_size_front_inch":{"type":"string","example":"1.2 x 12","description":"Front tyre rim size in inches"},"rim_offset_front_mm":{"type":"integer","example":12,"description":"Front tyre rim offset in millimetres"},"tyre_size_rear":{"type":"string","example":"123/60R17","description":"The rear tyre size."},"load_index_rear":{"type":"integer","example":12,"description":"Rear tyre load index"},"speed_index_rear":{"type":"string","example":"1.2 x 12","description":"Rear tyre rim size in inches"},"rim_size_rear_inch":{"type":"string","example":"1.2 x 12","description":"Rear tyre rim size in inches"},"rim_offset_rear_mm":{"type":"number","example":12,"description":"Rear tyre rim offset in millimetres"},"tyre_pressure_front_bar":{"type":"number","example":1.2,"description":"Tyre pressure front bar"},"laden_tyre_pressure_front_bar":{"type":"number","example":1.2,"description":"Laden tyre pressure front bar"},"tyre_pressure_rear_bar":{"type":"number","example":1.2,"description":"Tyre pressure rear bar"},"laden_tyre_pressure_rear_bar":{"type":"number","example":1.2,"description":"Laden tyre pressure rear bar"},"is_run_flat_front":{"type":"boolean","example":false,"description":"Is the tyre run flat"},"is_run_flat_rear":{"type":"boolean","example":false,"description":"Is the rear tyre run flat"},"extra_load_front":{"type":"string","example":"on","description":"Is front tyre reinforced for extra load"},"extra_load_rear":{"type":"string","example":"on","description":"Is the rear tyre reinforced for extra load"},"change_date":{"type":"string","example":"2020-01-01","description":"Date of tyre the change"},"tyre_pressure_front_psi":{"type":"number","example":12,"description":"Front tyre pressure psi"},"tyre_pressure_rear_psi":{"type":"number","example":12,"description":"Rear tyre pressure psi"},"laden_tyre_pressure_front_psi":{"type":"number","example":12,"description":"Rear tyre when laden pressure psi"},"laden_tyre_pressure_rear_psi":{"type":"number","example":12,"description":"Rear tyre when laden pressure psi"},"pitch_circle_diameter_mm":{"type":"string","example":"5x432.1","description":"Pitch circle diameter in mm"},"front_centrebore_diameter_mm":{"type":"number","example":12.3,"description":"Front centre bore in millimetres"},"nut_bolt_thread_type":{"type":"string","example":"M12x3.45","description":"Nut bolt thread type."},"nut_bolt_hex":{"type":"number","example":12,"description":"Cross measurement of hexagonal nut or bolt in millimetres"},"bolt_length_mm":{"type":"number","example":12,"description":"Bolt length in millimetres"},"nut_bolt_torque_lbft":{"type":"number","example":123,"description":"Tension used to tighten wheel nut"},"rear_centrebore_diameter_mm":{"type":"number","example":12.3,"description":"Rear centre bore diameter in milimetres"},"nut_or_bolt":{"type":"string","example":"nut","description":"Nut or bolt"},"min_einpress_tiefe_front_mm":{"type":"number","example":12,"description":"Minimum distance of the front wheels within the wheel well in millimetres"},"max_einpress_tiefe_front_mm":{"type":"number","example":12,"description":"The maximum distance of the front wheels within the wheel well in millimetres"},"min_einpress_tiefe_rear_mm":{"type":"number","example":12,"description":"Minimum distance of the rear wheels within the wheel well in millimetres."},"max_einpress_tiefe_rear_mm":{"type":"number","example":12,"description":"Maximum distance of the rear wheels within the wheel well in millimetres"},"max_wheel_load_kg":{"type":"integer","example":123,"description":"Maximum wheel load in kilograms"},"vehicle_track_front_mm":{"type":"number","example":1234,"description":"Front vehicle track in millimetres"},"vehicle_track_rear_mm":{"type":"number","example":1234,"description":"Rear vehicle track in millimetres"},"max_rim_width_front_inch":{"type":"number","example":123,"description":"Maximum rim width in inches (front)"},"max_rim_width_rear_inch":{"type":"number","example":123,"description":"Maximum rim width in inches (rear)"},"gross_vehicleweight_kg":{"type":"integer","example":1234,"description":"Gross vehicle weight in kg"},"max_speed_kmh":{"type":"number","example":123,"description":"The maximum speed in kmh."},"front_axle_weight_kg":{"type":"integer","example":1234,"description":"Front axle weight in kilograms"},"rear_axle_weight_kg":{"type":"integer","example":1234,"description":"Rear axle weight in kilograms"},"min_kerbweight_kg":{"type":"integer","example":1234,"description":"Minimum kerbweight in kg"},"tpms_fitted":{"type":"string","example":"on","description":"Is a tyre pressure monitor system fitted."},"comments":{"type":"string","example":"Example comments","description":"The MOT comments."},"max_rim_width_inch":{"type":"number","example":12,"description":"Maximum rim width in inches"},"min_rim_width_inch":{"type":"number","example":12,"description":"Minimum rim width in inches"},"min_bolt_length_mm":{"type":"number","example":12,"description":"Minimum bolt length in millimetres"},"max_bolt_length_mm":{"type":"number","example":12,"description":"Maximum bolt length in millimetres"},"nut_bolt_am":{"type":"string","example":"Nut","description":"Indicates nut or bolt type (am)"},"nut_bolt_am_length_mm":{"type":"number","example":12,"description":"Length of nut or bolt type (am) in millimetres"},"nut_bolt_oe_alloy_mm":{"type":"integer","example":12,"description":"Indicates nut or bolt type for OE alloy wheel in millimetres"},"nut_bolt_oe_alloy_length_mm":{"type":"number","example":12,"description":"Length of nut or bolt type OE alloy wheel in millimetres"},"nut_bolt_oe_steel":{"type":"string","example":"Nut","description":"Indicates nut or bolt type for OE steel wheel."},"nut_bolt_oe_steel_length_mm":{"type":"number","example":12,"description":"Length of nut or bolt type OE steel wheel in millimetres"}}}}}}}},"error":{"type":"string","example":"If there is an error the message would go here","description":"Details of what went wrong with the api call"}}}}}}},"security":[{"x-api-key":[]}]}},"/evdatabase/uk/car/bidirectionalcharging":{"get":{"tags":["EV Database"],"operationId":"evdatabase_uk_car_bidirectionalcharging","summary":"Bi Directional Charging (Car)","description":"","parameters":[{"name":"evdb_vehicle_id","in":"query","description":"EV Database Vehicle ID","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"description":"Whether the api call was successful"},"result":{"type":"object","properties":{"vehicle_to_load_support_status":{"type":"string","example":"Announced","description":"Indicates whether the vehicle battery can be used to power an electrical appliance"},"vehicle_to_load_power_output_kw":{"type":"integer","example":11,"description":" The maximum power output when powering an electrical appliance"},"vehicle_to_load_exterior_port_details":{"type":"string","example":"1 x Type 2 (Adapter)","description":"Details of the exterior Vehicle to Load ports"},"vehicle_to_load_interior_port_details":{"type":"string","example":"1 x UK Socket (BS1363)","description":"Details of the interior Vehicle to Load ports"},"vehicle_to_home_ac_support_status":{"type":"string","example":"Not Available","description":"Indicates whether the vehicle battery can be used to provide AC power to a home"},"vehicle_to_home_ac_power_output_kw":{"type":"integer","example":11,"description":"The maximum AC power output when powering a home"},"vehicle_to_home_dc_support_status":{"type":"string","example":"Announced","description":"Indicates whether the vehicle battery can be used to provide DC power to a home"},"vehicle_to_home_dc_power_output_kw":{"type":"integer","example":10,"description":"The maximum DC power output when powering a home"},"vehicle_to_grid_ac_support_status":{"type":"string","example":"Announced","description":"Indicates whether the vehicle battery can be used to provide AC power to the grid"},"vehicle_to_grid_ac_power_output_kw":{"type":"integer","example":11,"description":"The maximum AC power output to the grid"},"vehicle_to_grid_dc_support_status":{"type":"string","example":"Announced","description":"Indicates whether the vehicle battery can be used to provide DC power to the grid"},"vehicle_to_grid_dc_power_output_kw":{"type":"integer","example":11,"description":"The maximum DC power output to the grid"}}},"error":{"type":"string","example":"If there is an error the message would go here","description":"Details of what went wrong with the api call"}}}}}}},"security":[{"x-api-key":[]}]}},"/evdatabase/uk/car/coredata":{"get":{"tags":["EV Database"],"operationId":"evdatabase_uk_car_coredata","summary":"Core Data - Car","description":"","parameters":[{"name":"evdb_vehicle_id","in":"query","description":"EV Database Vehicle ID","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"description":"Whether the api call was successful"},"result":{"type":"object","properties":{"evdb_vehicle_id":{"type":"integer","example":1234,"description":"EV Database Vehicle ID"},"manufacturer_desc":{"type":"string","example":"Polestar","description":"Manufacturer description"},"model_range_desc":{"type":"string","example":"4","description":"Model range description"},"derivative_desc":{"type":"string","example":"Long Range Single Motor","description":"EV Database’s model variant"},"battery_capacity_usable_kwh":{"type":"integer","example":94,"description":"Usable capacity (the amount of energy the car can actually draw on to propel itself) in kwh"},"battery_capacity_kwh":{"type":"integer","example":100,"description":"Battery capacity in kwh"},"is_battery_capacity_estimated":{"type":"boolean","example":true,"description":"Is the battery capacity based on an estimate?"},"availability_status":{"type":"string","example":"Vehicle currently available to order in market / region","description":"Vehicle's UK availability status"},"introduced_date":{"type":"string","example":"2024-01-01","description":"The date the vehicle was available in the market from"},"is_introduced_date_estimated":{"type":"boolean","example":false,"description":"Is the date the vehicle was available in the market from estimated?"},"discontinued_date":{"type":"string","example":"2022-01-01","description":"The date the vehicle was available to in the market"},"evdb_fuel_type_desc":{"type":"string","example":"BEV","description":"EV Database fuel type description"},"successor_evdb_vehicle_id":{"type":"integer","example":2345,"description":"The related EV Database Vehicle ID"}}},"error":{"type":"string","example":"If there is an error the message would go here","description":"Details of what went wrong with the api call"}}}}}}},"security":[{"x-api-key":[]}]}},"/evdatabase/uk/car/fastcharging":{"get":{"tags":["EV Database"],"operationId":"evdatabase_uk_car_fastcharging","summary":"Fast Charger (Car)","description":"","parameters":[{"name":"evdb_vehicle_id","in":"query","description":"EV Database Vehicle ID","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"description":"Whether the api call was successful"},"result":{"type":"object","properties":{"fast_charger_port_type":{"type":"string","example":"CCS","description":" EV Database Vehicle ID"},"is_fast_charger_port_type_estimated":{"type":"boolean","example":false,"description":"Is the fast charger port type estimated"},"fast_charger_port_location":{"type":"string","example":"Left Side - Front","description":"Fast charger port location"},"fast_charger_max_power_kw":{"type":"integer","example":109,"description":"Fast charger maximum power in kw"},"fast_charger_average_power_kw":{"type":"integer","example":78,"description":"Fast charger average power in kw"},"fast_charger_chargetime_10to80_percent_mins":{"type":"integer","example":40,"description":"10-80% fast charger charge time in minutes"},"fast_charger_chargespeed_10to80_percent_mph":{"type":"number","example":149.1290856,"description":"UK Vehicle Data’s miles per charge hour."},"is_fast_charger_optional":{"type":"boolean","example":false,"description":"Is the fast charger optional"},"is_autocharge_possible":{"type":"boolean","example":true,"description":"Is autocharging possible"},"plug_and_charge_iso15118_status":{"type":"string","example":"Available","description":"Status of the vehicle for Plug and Charge ISO15118"},"plug_and_charge_iso15118_2_status":{"type":"string","example":"Available","description":"Status of the vehicle for Plug and Charge ISO15118-2"},"plug_and_charge_iso15118_20_status":{"type":"string","example":"Announced","description":"Status of the vehicle for Plug and Charge ISO15118-20"},"is_fast_charger_data_estimated":{"type":"boolean","example":false,"description":"Is the fast charger data estimated"},"is_fastned_tested":{"type":"boolean","example":true,"description":"Is the fast charger tested for Fastned charging"},"fast_charger_table":{"type":"array","items":{"properties":{"is_fast_charger_ave_power_limited":{"type":"boolean","example":true,"description":"Is the fast charger maximum power limited"},"fast_charger_max_power_kw":{"type":"integer","example":49,"description":"Fast charger maximum power in kw"},"fast_charger_average_power_kw":{"type":"integer","example":47,"description":"Fast charger average power in kw"},"fast_charger_chargetime_10to80_percent_mins":{"type":"integer","example":66,"description":"10-80% fast charger charge time in minutes"},"is_fast_charger_max_power_limited":{"type":"boolean","example":true,"description":"Is the fast charger maximum power limited"},"fast_charger_desc":{"type":"string","example":"CCS-50-DC","description":"Fast charger description"},"fast_charger_chargespeed_10to80_percent_mph":{"type":"number","example":150,"description":"UK Vehicle Data’s miles per charge hour."}}}}}},"error":{"type":"string","example":"If there is an error the message would go here","description":"Details of what went wrong with the api call"}}}}}}},"security":[{"x-api-key":[]}]}},"/evdatabase/uk/car/onboardcharging":{"get":{"tags":["EV Database"],"operationId":"evdatabase_uk_car_onboardcharging","summary":"Onboard Charging (Car)","description":"","parameters":[{"name":"evdb_vehicle_id","in":"query","description":"EV Database Vehicle ID","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"description":"Whether the api call was successful"},"result":{"type":"object","properties":{"charge_port_type":{"type":"string","example":"Type 2","description":"The charge port type."},"is_charge_port_type_estimated":{"type":"boolean","example":false,"description":"Is the charge port type estimated"},"charge_port_location":{"type":"string","example":"Left Side - Front","description":"The charge port location."},"additional_charge_port_location":{"type":"string","example":"Right Side - Front","description":"The additional charge port location"},"is_additional_charge_port_optional":{"type":"boolean","example":true,"description":"Is an additional charge port optional"},"standard_onboard_charger_max_power_kw":{"type":"integer","example":11,"description":"The maximum power the onboard charger can accept to charge the battery"},"standard_onboard_charger_number_phases":{"type":"integer","example":3,"description":"The number of phases the onboard charger can accept to achieve max power"},"standard_onboard_charger_max_current_amps":{"type":"integer","example":16,"description":"The maximum current the onboard charger accepts per phase to achieve max power"},"standard_onboard_charger_chargetime_0to100_percent_minutes":{"type":"integer","example":540,"description":"The standard onboard chargetime 0 to 100% in minutes"},"standard_onboard_charge_chargespeed_mph":{"type":"number","example":16.77702213,"description":" The standard onboard charge speed miles per hour "},"standard_onboard_charger_table":{"type":"array","items":{"properties":{"electric_vehicle_supply_equipment_voltage":{"type":"integer","example":230,"description":"The electric vehicle supply equipment voltage"},"charger_max_chargespeed_mph":{"type":"number","example":3.7282271399999996,"description":"The onboard charger maximum charge speed in mph"},"electric_vehicle_supply_equipment_phase_number":{"type":"integer","example":1,"description":"The electric vehicle supply equipment phase number"},"charger_chargetime_0to100_mins":{"type":"integer","example":2580,"description":"The onboard charger chargetime 1 to 100% in minutes"},"electric_vehicle_supply_equipment_power_kw":{"type":"number","example":2.3,"description":"The electric vehicle supply equipment in kw."},"charger_charge_volts":{"type":"integer","example":230,"description":"The onboard charger charge volts"},"charger_charge_phase":{"type":"integer","example":1,"description":"The number of onboard charger phases"},"electric_vehicle_supply_equipment_desc":{"type":"string","example":"230V10A1X","description":"The electric vehicle supply equipment description"},"electric_vehicle_supply_equipment_current_amps":{"type":"integer","example":10,"description":"The electric vehicle supply equipment current amps"},"charger_charge_power_kw":{"type":"number","example":2.3,"description":"Onboard charger charge power"},"charger_charge_amps":{"type":"integer","example":10,"description":"The onboard charger charge amps"}}}},"is_standard_onboard_charger_data_estimated":{"type":"boolean","example":false,"description":"Is the standard onboard charger data estimated?"},"optional_onboard_charger_max_power_kw":{"type":"integer","example":22,"description":"The optional onboard charger maximum power in kw"},"optional_onboard_charger_number_phases":{"type":"integer","example":3,"description":"The number of onboard charger phases"},"optional_onboard_charger_max_current_amps":{"type":"integer","example":32,"description":"The maximum current the optional onboard charger accepts per phase to achieve max power"},"optional_onboard_charger_chargetime_0to100_percent_minutes":{"type":"integer","example":270,"description":"The optional onboard chargetime 0 to 100% in minute"},"optional_onboard_charge_chargespeed_mph":{"type":"number","example":33.55404426,"description":"The optional onboard charge speed miles per hour"},"optional_onboard_charger_table":{"type":"array","items":{"properties":{"electric_vehicle_supply_equipment_voltage":{"type":"integer","example":230,"description":"The electric vehicle supply equipment voltage"},"charger_max_chargespeed_mph":{"type":"number","example":3.7282271399999996,"description":"The onboard charger maximum charge speed in mph"},"electric_vehicle_supply_equipment_phase_number":{"type":"integer","example":1,"description":"The electric vehicle supply equipment phase number"},"charger_chargetime_0to100_mins":{"type":"integer","example":2580,"description":"The onboard charger chargetime 1 to 100% in minutes"},"electric_vehicle_supply_equipment_power_kw":{"type":"number","example":2.3,"description":"The electric vehicle supply equipment in kw."},"charger_charge_volts":{"type":"integer","example":230,"description":"The onboard charger charge volts"},"charger_charge_phase":{"type":"integer","example":1,"description":"The number of onboard charger phases"},"electric_vehicle_supply_equipment_desc":{"type":"string","example":"230V10A1X","description":"The electric vehicle supply equipment description"},"electric_vehicle_supply_equipment_current_amps":{"type":"integer","example":10,"description":"The electric vehicle supply equipment current amps"},"charger_charge_power_kw":{"type":"number","example":2.3,"description":"Onboard charger charge power"},"charger_charge_amps":{"type":"integer","example":10,"description":"The onboard charger charge amps"}}}}}},"error":{"type":"string","example":"If there is an error the message would go here","description":"Details of what went wrong with the api call"}}}}}}},"security":[{"x-api-key":[]}]}},"/evdatabase/uk/car/pencepermile":{"get":{"tags":["EV Database"],"operationId":"evdatabase_uk_car_pencepermile","summary":"Range and Pence Per Mile","description":"","parameters":[{"name":"evdb_vehicle_id","in":"query","description":"EV Database Vehicle ID","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"description":"Whether the api call was successful"},"result":{"type":"object","properties":{"evdb_vehicle_id":{"type":"integer","example":1234,"description":"EV Database Vehicle ID"},"unit_costs":{"type":"object","properties":{"pence_per_kwh_electric_details":{"type":"object","properties":{"domestic_cheap":{"type":"number","example":7.5,"description":"Domestic cheap unit price pence per kilowatt hour (typical EV tariff)"},"domestic_standard":{"type":"number","example":34,"description":"Domestic standard unit price pence per kilowatt hour (typical EV tariff)"},"public_charger":{"type":"number","example":85,"description":"Public charger unit price pence per kilowatt hour (typical EV tariff)"}}}}},"range_data":{"type":"object","properties":{"evdb_real_electric_range_highway_cold_miles":{"type":"integer","example":235,"description":"EV Database electric range in miles for highway driving in temperatures of -10c using heating"},"evdb_real_electric_range_combined_cold_miles":{"type":"integer","example":270,"description":"EV Database electric range in miles for combined city and highway driving in temperatures of -10c"},"evdb_real_electric_range_city_cold_miles":{"type":"integer","example":305,"description":"EV Database electric range in miles for city driving in temperatures of -10c using heating"},"evdb_real_electric_range_highway_mild_miles":{"type":"number","example":272.5,"description":"EV Database electric range in miles for highway driving in mild conditions of +10c"},"evdb_real_electric_range_combined_mild_miles":{"type":"number","example":322.5,"description":"EV Database electric range in miles for combined city and highway driving in mild conditions of +10c"},"evdb_real_electric_range_city_mild_miles":{"type":"number","example":382.5,"description":"EV Database electric range in miles for city driving in mild conditions of +10c"},"evdb_real_electric_range_highway_warm_miles":{"type":"integer","example":310,"description":"EV Database electric range in miles for highway driving in warm conditions of 23c, using A/C"},"evdb_real_electric_range_combined_warm_miles":{"type":"integer","example":375,"description":"EV Database electric range in miles for combined city and highway driving in warm conditions of, 23c, using A/C"},"evdb_real_electric_range_city_warm_miles":{"type":"integer","example":460,"description":"EV Database electric range in miles for city driving in warm conditions of 23c, using A/C"}}},"pence_per_mile_data":{"type":"object","properties":{"pence_per_mile_highway_cold":{"type":"object","properties":{"domestic_cheap":{"type":"number","example":2.91,"description":"Domestic cheap unit price pence per kilowatt hour (typical EV tariff)"},"domestic_standard":{"type":"number","example":13.91,"description":"Domestic standard unit price pence per kilowatt hour (typical EV tariff)"},"public_charger":{"type":"number","example":32.98,"description":"Public charger unit price pence per kilowatt hour (typical EV tariff)"}}},"pence_per_mile_combined_cold":{"type":"object","properties":{"domestic_cheap":{"type":"number","example":2.46,"description":"Domestic cheap unit price pence per kilowatt hour (typical EV tariff)"},"domestic_standard":{"type":"number","example":11.15,"description":"Domestic standard unit price pence per kilowatt hour (typical EV tariff)"},"public_charger":{"type":"number","example":27.88,"description":"Public charger unit price pence per kilowatt hour (typical EV tariff)"}}},"pence_per_mile_city_cold":{"type":"object","properties":{"domestic_cheap":{"type":"number","example":2.08,"description":"Domestic cheap unit price pence per kilowatt hour (typical EV tariff)"},"domestic_standard":{"type":"number","example":9.45,"description":"Domestic standard unit price pence per kilowatt hour (typical EV tariff)"},"public_charger":{"type":"number","example":23.63,"description":"Public charger unit price pence per kilowatt hour (typical EV tariff)"}}},"pence_per_mile_highway_mild":{"type":"object","properties":{"domestic_cheap":{"type":"number","example":2.6,"description":"Domestic cheap unit price pence per kilowatt hour (typical EV tariff)"},"domestic_standard":{"type":"number","example":11.78,"description":"Domestic standard unit price pence per kilowatt hour (typical EV tariff)"},"public_charger":{"type":"number","example":29.45,"description":"Public charger unit price pence per kilowatt hour (typical EV tariff)"}}},"pence_per_mile_combined_mild":{"type":"object","properties":{"domestic_cheap":{"type":"number","example":2.14,"description":"Domestic cheap unit price pence per kilowatt hour (typical EV tariff)"},"domestic_standard":{"type":"number","example":9.69,"description":"Domestic standard unit price pence per kilowatt hour (typical EV tariff)"},"public_charger":{"type":"number","example":24.23,"description":"Public charger unit price pence per kilowatt hour (typical EV tariff)"}}},"pence_per_mile_city_mild":{"type":"object","properties":{"domestic_cheap":{"type":"number","example":1.74,"description":"Domestic cheap unit price pence per kilowatt hour (typical EV tariff)"},"domestic_standard":{"type":"number","example":7.89,"description":"Domestic standard unit price pence per kilowatt hour (typical EV tariff)"},"public_charger":{"type":"number","example":19.72,"description":"Public charger unit price pence per kilowatt hour (typical EV tariff)"}}},"pence_per_mile_highway_warm":{"type":"object","properties":{"domestic_cheap":{"type":"number","example":1.95,"description":"Domestic cheap unit price pence per kilowatt hour (typical EV tariff)"},"domestic_standard":{"type":"number","example":8.1,"description":"Domestic standard unit price pence per kilowatt hour (typical EV tariff)"},"public_charger":{"type":"number","example":25.93,"description":"Public charger unit price pence per kilowatt hour (typical EV tariff)"}}},"pence_per_mile_combined_warm":{"type":"object","properties":{"domestic_cheap":{"type":"number","example":1.81,"description":"Domestic cheap unit price pence per kilowatt hour (typical EV tariff)"},"domestic_standard":{"type":"number","example":8.23,"description":"Domestic standard unit price pence per kilowatt hour (typical EV tariff)"},"public_charger":{"type":"number","example":20.57,"description":"Public charger unit price pence per kilowatt hour (typical EV tariff)"}}},"pence_per_mile_city_warm":{"type":"object","properties":{"domestic_cheap":{"type":"number","example":1.4,"description":"Domestic cheap unit price pence per kilowatt hour (typical EV tariff)"},"domestic_standard":{"type":"number","example":6.32,"description":"Domestic standard unit price pence per kilowatt hour (typical EV tariff)"},"public_charger":{"type":"number","example":15.81,"description":"Public charger unit price pence per kilowatt hour (typical EV tariff)"}}}}}}},"error":{"type":"string","example":"If there is an error the message would go here","description":"Details of what went wrong with the api call"}}}}}}},"security":[{"x-api-key":[]}]}},"/evdatabase/uk/car/pricinggrantstaxes":{"get":{"tags":["EV Database"],"operationId":"evdatabase_uk_car_pricinggrantstaxes","summary":"Pricing Grants & Taxes (Car)","description":"","parameters":[{"name":"evdb_vehicle_id","in":"query","description":"EV Database Vehicle ID","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"description":"Whether the api call was successful"},"result":{"type":"object","properties":{"price_inc_grants_from":{"type":"integer","example":59990,"description":"Starting price based on OTR for the local market. Includes VAT, fees with any applicable grants deducted"},"p11d_price_from":{"type":"integer","example":59935,"description":" P11D value based on starting price"},"is_pricing_estimated":{"type":"boolean","example":false,"description":"Is pricing estimated"},"plug_in_vehicle_grant":{"type":"integer","example":5000,"description":"The amount of any plug-in car grant available for this vehiclet"},"benefit_in_kind_year":{"type":"string","example":"2023-24","description":"The fiscal year on which benefit in kind data is based"},"benefit_in_kind_percentage_charge":{"type":"integer","example":2,"description":"The percentage of the P11D values based on the vehicle's CO2"},"benefit_in_kind_gbp":{"type":"integer","example":1199,"description":"Benefit in kind amount in GBP"},"benefit_in_kind_per_annum_basic_rate_gbp":{"type":"integer","example":20,"description":"Basic rate benefit in kind per annum"},"benefit_in_kind_per_annum_higher_rate_gbp":{"type":"integer","example":40,"description":"Higher rate benefit in kind per annum"},"benefit_in_kind_per_annum_additional_rate_gbp":{"type":"integer","example":45,"description":"Additional rate benefit in kind per annum"}}},"error":{"type":"string","example":"If there is an error the message would go here","description":"Details of what went wrong with the api call"}}}}}}},"security":[{"x-api-key":[]}]}},"/evdatabase/uk/car/rangeefficiencybattery":{"get":{"tags":["EV Database"],"operationId":"evdatabase_uk_car_rangeefficiencybattery","summary":"Range Efficiency & Battery (car)","description":"","parameters":[{"name":"evdb_vehicle_id","in":"query","description":"EV Database Vehicle ID","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"description":"Whether the api call was successful"},"result":{"type":"object","properties":{"range":{"type":"object","properties":{"wltp_pure_electric_range_combined_test_energy_high_miles":{"type":"integer","example":331,"description":"WLTP pure electric range combined miles test energy high"},"wltp_pure_electric_range_combined_test_energy_low_miles":{"type":"integer","example":386,"description":"WLTP pure electric range combined miles test energy low"},"is_wltp_range_estimated":{"type":"boolean","example":false,"description":"Is the WLTP range estimated"},"nedc_max_ev_range_miles":{"type":"integer","example":118,"description":"NEDC maximum ev range in miles"},"is_nedc_range_estimated":{"type":"boolean","example":false,"description":"IIs the NEDC range estimated"},"evdb_real_electric_range_miles":{"type":"integer","example":325,"description":"EV Database electric range in miles"},"evdb_real_electric_range_mode":{"type":"string","example":"estimation","description":"EV Database real electric range mode"},"evdb_real_electric_range_highway_cold_miles":{"type":"integer","example":235,"description":"EV Database electric range in miles for highway driving in temperatures of -10c using heating"},"evdb_real_electric_range_combined_cold_miles":{"type":"integer","example":270,"description":"EV Database electric range in miles for combined city and highway driving in temperatures of -10c"},"evdb_real_electric_range_city_cold_miles":{"type":"integer","example":305,"description":"EV Database electric range in miles for city driving in temperatures of -10c using heating"},"evdb_real_electric_range_highway_mild_miles":{"type":"number","example":272.5,"description":"EV Database electric range in miles for highway driving in mild conditions of +10c"},"evdb_real_electric_range_combined_mild_miles":{"type":"number","example":322.5,"description":"EV Database electric range in miles for combined city and highway driving in mild conditions of +10c"},"evdb_real_electric_range_city_mild_miles":{"type":"number","example":382.5,"description":"EV Database electric range in miles for city driving in mild conditions of +10c"},"evdb_real_electric_range_highway_warm_miles":{"type":"integer","example":310,"description":"EV Database electric range in miles for highway driving in warm conditions of 23c, using A/C"},"evdb_real_electric_range_combined_warm_miles":{"type":"integer","example":375,"description":"EV Database electric range in miles for combined city and highway driving in warm conditions of, 23c, using A/C"},"evdb_real_electric_range_city_warm_miles":{"type":"integer","example":460,"description":"EV Database electric range in miles for city driving in warm conditions of 23c, using A/C"}}},"efficiency":{"type":"object","properties":{"wltp_electric_consumption_combined_test_energy_low_watt_hours_per_mile":{"type":"number","example":257.5,"description":"WLTP electric consumption per mile in watts based on test energy low in the most efficient trim"},"wltp_electric_consumption_combined_test_energy_low_miles_per_kwh":{"type":"number","example":3.9,"description":"WLTP electric consumption in miles per kwh based on test energy low in the most efficient trim"},"wltp_electric_consumption_equivalent_fuel_energy_test_energy_low_mpg":{"type":"number","example":152.5,"description":"WLTP electric consumption equivalent fuel energy miles per gallon test energy low"},"wltp_combined_test_energy_low_co2_gkm":{"type":"integer","example":0,"description":"WLTP combined CO2 g/km test energy low / most efficient trim"},"wltp_electric_consumption_combined_test_energy_high_watt_hours_per_mile":{"type":"number","example":306.5,"description":" WLTP electric consumption miles kilowatt-hour test energy high "},"wltp_electric_consumption_combined_test_energy_high_miles_per_kwh":{"type":"number","example":3.3,"description":"wltp_electric_consumption_combined_test_energy_high_miles_per_kwh"},"wltp_electric_consumption_equivalent_fuel_energy_test_energy_high_mpg":{"type":"number","example":129.5,"description":"The equivalent fuel energy expressed as petrol miles per gallon for test energy low in the least efficient trim"},"wltp_combined_test_energy_high_co2_gkm":{"type":"integer","example":0,"description":"WLTP combined CO2 g/km test energy high / least efficient trim"},"nedc_electric_consumption_watt_hours_per_mile":{"type":"number","example":257.5,"description":"NEDC electric consumption in watts per mile"},"nedc_electric_consumption_miles_per_kwh":{"type":"number","example":5.2,"description":"NEDC electric consumption in miles per kwh"},"nedc_electric_consumption_equivalent_fuel_energy_mpg":{"type":"number","example":241.5,"description":"The equivalent fuel energy expressed as petrol miles per gallon for NEDC electric consumption"},"real_electric_consumption_watt_hours_per_mile":{"type":"number","example":278.5,"description":"Calculated watts per mile based on real range and usable battery capacity"},"real_electric_consumption_miles_per_kwh":{"type":"number","example":3.6,"description":"Calculated miles per kwh based on real range and usable battery capacity"},"real_electric_consumption_equivalent_fuel_energy_mpg":{"type":"number","example":148.5,"description":"The equivalent fuel energy expressed as petrol miles per gallon based on real efficiency calculated from real range and usable battery capacity"},"evdb_real_electric_consumption_highway_cold_watt_hours_per_mile":{"type":"number","example":379.5,"description":"EV Database real electric consumption in miles per kilowatt-hours for highway driving in temperatures of -10c using heating"},"evdb_real_electric_consumption_combined_cold_watt_hours_per_mile":{"type":"number","example":330.5,"description":"EV Database real electric consumption in miles per kilowatt-hours for highway and city driving in temperatures of -10c using heating"},"evdb_real_electric_consumption_city_cold_watt_hours_per_mile":{"type":"number","example":292.5,"description":"EV Database real electric consumption in miles per kilowatt-hours for city driving in temperatures of -10c using heating"},"evdb_real_electric_consumption_highway_mild_watt_hours_per_mile":{"type":"number","example":333.5,"description":"EV Database real electric consumption in miles per kilowatt-hours for highway driving in mild conditions of +10c"},"evdb_real_electric_consumption_combined_mild_watt_hours_per_mile":{"type":"number","example":283.5,"description":"EV Database real electric consumption in miles per kilowatt-hours for highway and city driving in mild conditions of +10c"},"evdb_real_electric_consumption_city_mild_watt_hours_per_mile":{"type":"number","example":242.5,"description":"EV Database real electric consumption in miles per kilowatt-hours for city driving in mild conditions of +10c"},"evdb_real_electric_consumption_highway_warm_watt_hours_per_mile":{"type":"number","example":287.5,"description":"EV Database real electric consumption in miles per kilowatt-hours for highway driving in warm conditions of 23c, using A/C"},"evdb_real_electric_consumption_combined_warm_watt_hours_per_mile":{"type":"number","example":237.5,"description":" EV Database real electric consumption in miles per kilowatt-hours for highway and city driving in warm conditions of 23c, using A/C "},"evdb_real_electric_consumption_city_warm_watt_hours_per_mile":{"type":"number","example":193.5,"description":"EV Database real electric consumption in miles per kilowatt-hours for city driving in warm conditions of 23c, using A/C"}}},"battery":{"type":"object","properties":{"battery_type":{"type":"string","example":"Lithium-ion","description":"Battery type"},"battery_thermal_management_system":{"type":"string","example":"Active Liquid","description":"Battery type"},"battery_chemistry":{"type":"string","example":"NCM622","description":"Battery chemistry, may include ratios"},"battery_manufacturer":{"type":"string","example":"LGES","description":"Battery manufacturer"},"battery_architecture":{"type":"string","example":"400 V","description":"Battery and drivetrain architecture"},"battery_volts":{"type":"integer","example":350,"description":"Nominal battery voltage as defined by the manufacturer seats"},"battery_modules_qty":{"type":"integer","example":12,"description":"Number of battery modules"},"battery_cells_configuration":{"type":"string","example":"98s3p","description":"Number of cells in the battery pack, can include cell configuration"},"battery_weight_kg":{"type":"integer","example":349,"description":"Weight of the battery in kilograms"},"battery_warranty_years":{"type":"integer","example":10,"description":"Battery warranty period in years"},"battery_warranty_mileage":{"type":"integer","example":100000,"description":"Battery warranty in miles"}}}}},"error":{"type":"string","example":"If there is an error the message would go here","description":"Details of what went wrong with the api call"}}}}}}},"security":[{"x-api-key":[]}]}},"/evdatabase/uk/car/vehicledata":{"get":{"tags":["EV Database"],"operationId":"evdatabase_uk_car_vehicledata","summary":"Vehicle Data - Car","description":"","parameters":[{"name":"evdb_vehicle_id","in":"query","description":"EV Database Vehicle ID","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"description":"Whether the api call was successful"},"result":{"type":"object","properties":{"dimensions_weights":{"type":"object","properties":{"vehicle_length_mm":{"type":"integer","example":4839,"description":"The vehicle length in mm"},"vehicle_width_mm":{"type":"integer","example":2008,"description":"The vehicle width in mm"},"vehicle_width_inc_mirrors_mm":{"type":"integer","example":2139,"description":"Vehicle width including mirrors in mm"},"vehicle_height_mm":{"type":"integer","example":1544,"description":"The vehicle height in mm"},"is_length_width_height_estimated":{"type":"boolean","example":true,"description":"Is the length, width and height estimated"},"ground_clearance_mm":{"type":"integer","example":166,"description":"The ground clearance in mm"},"vehicle_wheelbase_mm":{"type":"integer","example":2999,"description":"The vehicle wheelbase in mm"},"is_wheelbase_estimated":{"type":"boolean","example":false,"description":"Is the wheelbase estimated"},"vehicleweight_kg":{"type":"integer","example":2232,"description":"Vehicle weight in kilograms"},"is_weight_estimated":{"type":"boolean","example":false,"description":"Is the vehicle weight estimated"},"gross_vehicleweight_kg":{"type":"integer","example":2555,"description":"Gross vehicle weight in kg"},"payload_weight_kg":{"type":"integer","example":586,"description":"The payload weight in kg"},"bootspace_min_litres":{"type":"integer","example":526,"description":"Minimum bootspace in litres"},"bootspace_max_litres":{"type":"integer","example":1536,"description":"Maximum bootspace in litres"},"bootspace_front_trunk_litres":{"type":"integer","example":15,"description":"Boot space front trunk in litres"},"is_tow_hook_allowed":{"type":"boolean","example":true,"description":"Is tow hook allowed"},"max_unbraked_towing_weight_kg":{"type":"integer","example":750,"description":"Maximum unbraked towing weight in kg"},"max_braked_towing_weight_kg":{"type":"integer","example":1500,"description":"Maximum braked towing weight in kg"},"is_towing_weight_estimated":{"type":"boolean","example":false,"description":"Is towing weight estimated"},"max_vertical_towing_load_weight_kg":{"type":"integer","example":100,"description":"Maximum vertical towing load weight in kg"},"max_roof_load_kg":{"type":"integer","example":75,"description":"Maximum roof load in kilograms"}}},"drivetrain_performance":{"type":"object","properties":{"drivetrain_desc":{"type":"string","example":"Rear Wheel Drive","description":"Drivetrain"},"is_drivetrain_desc_estimated":{"type":"boolean","example":false,"description":"Is drivetrain description estimated"},"drivetrain_power_kw":{"type":"integer","example":200,"description":"Drivetrain power in kilowatts"},"drivetrain_power_bhp":{"type":"integer","example":268,"description":"Drivetrain power bhp"},"is_drivetrain_power_estimated":{"type":"boolean","example":false,"description":"Is drivetrain power estimated"},"torque_nm":{"type":"integer","example":343,"description":"The engine torque in nm"},"is_torque_estimated":{"type":"boolean","example":false,"description":"Is torque estimated"},"acceleration_0to62_mph_seconds":{"type":"number","example":7.4,"description":"Acceleration - number of seconds to go from Zero to 62 mph"},"is_acceleration_estimated":{"type":"boolean","example":false,"description":"Is acceleration estimated"},"top_speed_mph":{"type":"integer","example":69,"description":"The top speed (mph)"},"is_top_speed_estimated":{"type":"boolean","example":false,"description":"Is top speed estimated"}}},"safety":{"type":"object","properties":{"ncap_overall_rating":{"type":"integer","example":5,"description":"The NCAP overall rating."},"ncap_rating_year":{"type":"integer","example":2021,"description":"ncap overall rating"},"ncap_adult_occupant_protection_percentage":{"type":"integer","example":92,"description":"The NCAP adult occupant protection percentage."},"ncap_child_occupant_protection_percentage":{"type":"integer","example":86,"description":"The NCAP child occupant protection percentage."},"ncap_vulnerable_road_user_percentage":{"type":"integer","example":69,"description":"ncap vulnerable road user percentage"},"ncap_safety_assist_percentage":{"type":"integer","example":82,"description":"The NCAP safety assist percentage."}}},"miscellaneous":{"type":"object","properties":{"body_type_desc":{"type":"string","example":"Liftback Saloon","description":"The body type description"},"number_seats":{"type":"integer","example":5,"description":"Number of seats"},"is_roof_rails_standard":{"type":"boolean","example":false,"description":"Are roof rails standard"},"is_isofix_standard":{"type":"boolean","example":true,"description":"Is ISOFIX standard"},"number_seats_isofix":{"type":"integer","example":2,"description":"Number of ISOFIX seats"},"turning_circle_kerb_to_kerb_m":{"type":"number","example":11.6,"description":"Turning circle from kerb to kerb in metres"},"vehicle_platform_desc":{"type":"string","example":"GEELY SEA1","description":"Vehicle platform description"},"is_dedicated_ev_platform":{"type":"boolean","example":true,"description":"Is dedicated EV platform"},"is_heatpump_available":{"type":"boolean","example":true,"description":"Is a heat pump available"},"is_heatpump_standard":{"type":"boolean","example":true,"description":"Is a heat pump standard"}}}}},"error":{"type":"string","example":"If there is an error the message would go here","description":"Details of what went wrong with the api call"}}}}}}},"security":[{"x-api-key":[]}]}},"/evdatabase/uk/idsearch":{"get":{"tags":["EV Database"],"operationId":"evdatabase_uk_idsearch","summary":"ID Search","description":"","parameters":[{"name":"manufacturer_desc","in":"query","description":"Manufacturer description","required":true,"schema":{"type":"string"}},{"name":"model_range_desc","in":"query","description":"Model range description","required":true,"schema":{"type":"string"}},{"name":"derivative_desc","in":"query","description":"The deriative description","required":true,"schema":{"type":"string"}},{"name":"battery_capacity_usable_kwh","in":"query","description":"Usable capacity (the amount of energy the car can actually draw on to propel itself) in kwh","required":false,"schema":{"type":"integer"}},{"name":"battery_capacity_kwh","in":"query","description":"Battery capacity in kwh e.g 100","required":false,"schema":{"type":"integer"}},{"name":"battery_volts","in":"query","description":"Nominal battery voltage as defined by the manufacturer","required":false,"schema":{"type":"integer"}},{"name":"gross_vehicleweight_kg","in":"query","description":"Gross vehicle weight in kilograms","required":false,"schema":{"type":"integer"}},{"name":"drivetrain_desc","in":"query","description":"Drivetrain","required":false,"schema":{"type":"string"}},{"name":"is_current","in":"query","description":"Is the vehicle currently available to order (includes pre-order open)","required":false,"schema":{"type":"boolean"}},{"name":"registration_date","in":"query","description":"Date the vehicle was first registered in the UK","required":false,"schema":{"type":"string"}},{"name":"vehicle_type","in":"query","description":"Vehicle type","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"description":"Whether the api call was successful"},"result":{"type":"array","items":{"properties":{"evdb_vehicle_id":{"type":"integer","example":1234,"description":"EV Database Vehicle ID"},"vehicle_type":{"type":"string","example":"car","description":"Vehicle type"},"manufacturer_desc":{"type":"string","example":"Polestar","description":"Manufacturer description"},"model_range_desc":{"type":"string","example":"4","description":"Model range description"},"derivative_desc":{"type":"string","example":"Long Range Single Motor","description":"EV Database’s model variant"},"battery_capacity_usable_kwh":{"type":"integer","example":94,"description":"Usable capacity (the amount of energy the car can actually draw on to propel itself) in kwh"},"battery_capacity_kwh":{"type":"integer","example":100,"description":"Battery capacity in kwh"},"battery_volts":{"type":"integer","example":407,"description":"Nominal battery voltage as defined by the manufacturer seats"},"gross_vehicleweight_kg":{"type":"integer","example":2940,"description":"Gross vehicle weight in kg"},"drivetrain_desc":{"type":"string","example":"Front Wheel Drive","description":"Drivetrain"},"introduced_date":{"type":"string","example":"2024-01-01","description":"The date the vehicle was available in the market from"},"discontinued_date":{"type":"string","example":"null","description":"The date the vehicle was available to in the market"},"availability_status":{"type":"string","example":"Vehicle currently available to order in market / region","description":"Vehicle's UK availability status"}}}},"error":{"type":"string","example":"If there is an error the message would go here","description":"Details of what went wrong with the api call"}}}}}}},"security":[{"x-api-key":[]}]}},"/evdatabase/uk/van/bidirectionalcharging":{"get":{"tags":["EV Database"],"operationId":"evdatabase_uk_van_bidirectionalcharging","summary":"Bi Directional Charging (Van)","description":"","parameters":[{"name":"evdb_vehicle_id","in":"query","description":"EV Database Vehicle ID","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"description":"Whether the api call was successful"},"result":{"type":"object","properties":{"vehicle_to_load_support_status":{"type":"string","example":"Announced","description":"Indicates whether the vehicle battery can be used to power an electrical appliance"},"vehicle_to_load_power_output_kw":{"type":"integer","example":11,"description":" The maximum power output when powering an electrical appliance"},"vehicle_to_load_exterior_port_details":{"type":"string","example":"1 x Type 2 (Adapter)","description":"Details of the exterior Vehicle to Load ports"},"vehicle_to_load_interior_port_details":{"type":"string","example":"1 x UK Socket (BS1363)","description":"Details of the interior Vehicle to Load ports"},"vehicle_to_home_ac_support_status":{"type":"string","example":"Not Available","description":"Indicates whether the vehicle battery can be used to provide AC power to a home"},"vehicle_to_home_ac_power_output_kw":{"type":"integer","example":11,"description":"The maximum AC power output when powering a home"},"vehicle_to_home_dc_support_status":{"type":"string","example":"Announced","description":"Indicates whether the vehicle battery can be used to provide DC power to a home"},"vehicle_to_home_dc_power_output_kw":{"type":"integer","example":10,"description":"The maximum DC power output when powering a home"},"vehicle_to_grid_ac_support_status":{"type":"string","example":"Announced","description":"Indicates whether the vehicle battery can be used to provide AC power to the grid"},"vehicle_to_grid_ac_power_output_kw":{"type":"integer","example":11,"description":"The maximum AC power output to the grid"},"vehicle_to_grid_dc_support_status":{"type":"string","example":"Announced","description":"Indicates whether the vehicle battery can be used to provide DC power to the grid"},"vehicle_to_grid_dc_power_output_kw":{"type":"integer","example":11,"description":"The maximum DC power output to the grid"}}},"error":{"type":"string","example":"If there is an error the message would go here","description":"Details of what went wrong with the api call"}}}}}}},"security":[{"x-api-key":[]}]}},"/evdatabase/uk/van/coredata":{"get":{"tags":["EV Database"],"operationId":"evdatabase_uk_van_coredata","summary":"Core Data - Van","description":"","parameters":[{"name":"evdb_vehicle_id","in":"query","description":"EV Database Vehicle ID","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"description":"Whether the api call was successful"},"result":{"type":"object","properties":{"evdb_vehicle_id":{"type":"integer","example":12345,"description":"EV Database Vehicle ID"},"manufacturer_desc":{"type":"string","example":"Fiat","description":"Manufacturer description"},"model_range_desc":{"type":"string","example":"Ducato","description":"Model range description"},"model_desc":{"type":"string","example":"H2","description":"The model description."},"model_length_desc":{"type":"string","example":"M","description":"The model length description"},"model_height_desc":{"type":"string","example":"H2","description":"The model height description"},"derivative_desc":{"type":"string","example":"47 kWh","description":"EV Database’s model variant"},"gross_vehicleweight_desc":{"type":"string","example":"3.5T","description":"The gross vehicle weight description"},"body_type_desc":{"type":"string","example":"PanelVan","description":"The body type description"},"battery_capacity_usable_kwh":{"type":"integer","example":42,"description":"Usable capacity (the amount of energy the car can actually draw on to propel itself) in kwh"},"battery_capacity_kwh":{"type":"integer","example":47,"description":"Battery capacity in kwh"},"is_battery_capacity_estimated":{"type":"boolean","example":true,"description":"Is the battery capacity based on an estimate?"},"availability_status":{"type":"string","example":"Vehicle currently available to order in market / region","description":"Vehicle's UK availability status"},"introduced_date":{"type":"string","example":"2020-01-01","description":"The date the vehicle was available in the market from"},"is_introduced_date_estimated":{"type":"boolean","example":false,"description":"Is the date the vehicle was available in the market from estimated?"},"discontinued_date":{"type":"string","example":"2022-01-01","description":"The date the vehicle was available to in the market"},"evdb_fuel_type_desc":{"type":"string","example":"BEV","description":"EV Database fuel type description"},"successor_evdb_vehicle_id":{"type":"integer","example":23456,"description":"The related EV Database Vehicle ID"}}},"error":{"type":"string","example":"If there is an error the message would go here","description":"Details of what went wrong with the api call"}}}}}}},"security":[{"x-api-key":[]}]}},"/evdatabase/uk/van/fastcharging":{"get":{"tags":["EV Database"],"operationId":"evdatabase_uk_van_fastcharging","summary":"Fast Charger (Van)","description":"","parameters":[{"name":"evdb_vehicle_id","in":"query","description":"EV Database Vehicle ID","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"description":"Whether the api call was successful"},"result":{"type":"object","properties":{"fast_charger_port_type":{"type":"string","example":"CCS","description":" EV Database Vehicle ID"},"is_fast_charger_port_type_estimated":{"type":"boolean","example":false,"description":"Is the fast charger port type estimated"},"fast_charger_port_location":{"type":"string","example":"Left Side - Front","description":"Fast charger port location"},"fast_charger_max_power_kw":{"type":"integer","example":109,"description":"Fast charger maximum power in kw"},"fast_charger_average_power_kw":{"type":"integer","example":78,"description":"Fast charger average power in kw"},"fast_charger_chargetime_10to80_percent_mins":{"type":"integer","example":40,"description":"10-80% fast charger charge time in minutes"},"fast_charger_chargespeed_10to80_percent_mph":{"type":"number","example":149.1290856,"description":"UK Vehicle Data’s miles per charge hour."},"is_fast_charger_optional":{"type":"boolean","example":false,"description":"Is the fast charger optional"},"is_autocharge_possible":{"type":"boolean","example":true,"description":"Is autocharging possible"},"is_fast_charger_data_estimated":{"type":"boolean","example":false,"description":"Is the fast charger data estimated"},"is_fastned_tested":{"type":"boolean","example":true,"description":"Is the fast charger tested for Fastned charging"},"fast_charger_table":{"type":"array","items":{"properties":{"is_fast_charger_ave_power_limited":{"type":"boolean","example":true,"description":"Is the fast charger maximum power limited"},"fast_charger_max_power_kw":{"type":"integer","example":49,"description":"Fast charger maximum power in kw"},"fast_charger_average_power_kw":{"type":"integer","example":47,"description":"Fast charger average power in kw"},"fast_charger_chargetime_10to80_percent_mins":{"type":"integer","example":66,"description":"10-80% fast charger charge time in minutes"},"is_fast_charger_max_power_limited":{"type":"boolean","example":true,"description":"Is the fast charger maximum power limited"},"fast_charger_desc":{"type":"string","example":"CCS-50-DC","description":"Fast charger description"},"fast_charger_chargespeed_10to80_percent_mph":{"type":"number","example":150,"description":"UK Vehicle Data’s miles per charge hour."}}}}}},"error":{"type":"string","example":"If there is an error the message would go here","description":"Details of what went wrong with the api call"}}}}}}},"security":[{"x-api-key":[]}]}},"/evdatabase/uk/van/onboardcharging":{"get":{"tags":["EV Database"],"operationId":"evdatabase_uk_van_onboardcharging","summary":"Onboard Charging (Van)","description":"","parameters":[{"name":"evdb_vehicle_id","in":"query","description":"EV Database Vehicle ID","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"description":"Whether the api call was successful"},"result":{"type":"object","properties":{"charge_port_type":{"type":"string","example":"Type 2","description":"The charge port type."},"is_charge_port_type_estimated":{"type":"boolean","example":false,"description":"Is the charge port type estimated"},"charge_port_location":{"type":"string","example":"Left Side - Front","description":"The charge port location."},"additional_charge_port_location":{"type":"string","example":"Right Side - Front","description":"The additional charge port location"},"is_additional_charge_port_optional":{"type":"boolean","example":true,"description":"Is an additional charge port optional"},"standard_onboard_charger_max_power_kw":{"type":"integer","example":11,"description":"The maximum power the onboard charger can accept to charge the battery"},"standard_onboard_charger_number_phases":{"type":"integer","example":3,"description":"The number of phases the onboard charger can accept to achieve max power"},"standard_onboard_charger_max_current_amps":{"type":"integer","example":16,"description":"The maximum current the onboard charger accepts per phase to achieve max power"},"standard_onboard_charger_chargetime_0to100_percent_minutes":{"type":"integer","example":540,"description":"The standard onboard chargetime 0 to 100% in minutes"},"standard_onboard_charge_chargespeed_mph":{"type":"number","example":16.77702213,"description":" The standard onboard charge speed miles per hour "},"standard_onboard_charger_table":{"type":"array","items":{"properties":{"electric_vehicle_supply_equipment_voltage":{"type":"integer","example":230,"description":"The electric vehicle supply equipment voltage"},"charger_max_chargespeed_mph":{"type":"number","example":3.7282271399999996,"description":"The onboard charger maximum charge speed in mph"},"electric_vehicle_supply_equipment_phase_number":{"type":"integer","example":1,"description":"The electric vehicle supply equipment phase number"},"charger_chargetime_0to100_mins":{"type":"integer","example":2580,"description":"The onboard charger chargetime 1 to 100% in minutes"},"electric_vehicle_supply_equipment_power_kw":{"type":"number","example":2.3,"description":"The electric vehicle supply equipment in kw."},"charger_charge_volts":{"type":"integer","example":230,"description":"The onboard charger charge volts"},"charger_charge_phase":{"type":"integer","example":1,"description":"The number of onboard charger phases"},"electric_vehicle_supply_equipment_desc":{"type":"string","example":"230V10A1X","description":"The electric vehicle supply equipment description"},"electric_vehicle_supply_equipment_current_amps":{"type":"integer","example":10,"description":"The electric vehicle supply equipment current amps"},"charger_charge_power_kw":{"type":"number","example":2.3,"description":"Onboard charger charge power"},"charger_charge_amps":{"type":"integer","example":10,"description":"The onboard charger charge amps"}}}},"is_standard_onboard_charger_data_estimated":{"type":"boolean","example":false,"description":"Is the standard onboard charger data estimated?"},"optional_onboard_charger_max_power_kw":{"type":"integer","example":22,"description":"The optional onboard charger maximum power in kw"},"optional_onboard_charger_number_phases":{"type":"integer","example":3,"description":"The number of onboard charger phases"},"optional_onboard_charger_max_current_amps":{"type":"integer","example":32,"description":"The maximum current the optional onboard charger accepts per phase to achieve max power"},"optional_onboard_charger_chargetime_0to100_percent_minutes":{"type":"integer","example":270,"description":"The optional onboard chargetime 0 to 100% in minute"},"optional_onboard_charge_chargespeed_mph":{"type":"number","example":33.55404426,"description":"The optional onboard charge speed miles per hour"},"optional_onboard_charger_table":{"type":"array","items":{"properties":{"electric_vehicle_supply_equipment_voltage":{"type":"integer","example":230,"description":"The electric vehicle supply equipment voltage"},"charger_max_chargespeed_mph":{"type":"number","example":3.7282271399999996,"description":"The onboard charger maximum charge speed in mph"},"electric_vehicle_supply_equipment_phase_number":{"type":"integer","example":1,"description":"The electric vehicle supply equipment phase number"},"charger_chargetime_0to100_mins":{"type":"integer","example":2580,"description":"The onboard charger chargetime 1 to 100% in minutes"},"electric_vehicle_supply_equipment_power_kw":{"type":"number","example":2.3,"description":"The electric vehicle supply equipment in kw."},"charger_charge_volts":{"type":"integer","example":230,"description":"The onboard charger charge volts"},"charger_charge_phase":{"type":"integer","example":1,"description":"The number of onboard charger phases"},"electric_vehicle_supply_equipment_desc":{"type":"string","example":"230V10A1X","description":"The electric vehicle supply equipment description"},"electric_vehicle_supply_equipment_current_amps":{"type":"integer","example":10,"description":"The electric vehicle supply equipment current amps"},"charger_charge_power_kw":{"type":"number","example":2.3,"description":"Onboard charger charge power"},"charger_charge_amps":{"type":"integer","example":10,"description":"The onboard charger charge amps"}}}}}},"error":{"type":"string","example":"If there is an error the message would go here","description":"Details of what went wrong with the api call"}}}}}}},"security":[{"x-api-key":[]}]}},"/evdatabase/uk/van/pencepermile":{"get":{"tags":["EV Database"],"operationId":"evdatabase_uk_van_pencepermile","summary":"Range and Pence Per Mile","description":"","parameters":[{"name":"evdb_vehicle_id","in":"query","description":"EV Database Vehicle ID","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"description":"Whether the api call was successful"},"result":{"type":"object","properties":{"evdb_vehicle_id":{"type":"integer","example":1234,"description":"EV Database Vehicle ID"},"unit_costs":{"type":"object","properties":{"pence_per_kwh_electric_details":{"type":"object","properties":{"domestic_cheap":{"type":"number","example":7.5,"description":"Domestic cheap unit price pence per kilowatt hour (typical EV tariff)"},"domestic_standard":{"type":"number","example":34,"description":"Domestic standard unit price pence per kilowatt hour (typical EV tariff)"},"public_charger":{"type":"number","example":85,"description":"Public charger unit price pence per kilowatt hour (typical EV tariff)"}}}}},"range_data":{"type":"object","properties":{"evdb_real_electric_range_highway_cold_miles":{"type":"integer","example":235,"description":"EV Database electric range in miles for highway driving in temperatures of -10c using heating"},"evdb_real_electric_range_combined_cold_miles":{"type":"integer","example":270,"description":"EV Database electric range in miles for combined city and highway driving in temperatures of -10c"},"evdb_real_electric_range_city_cold_miles":{"type":"integer","example":305,"description":"EV Database electric range in miles for city driving in temperatures of -10c using heating"},"evdb_real_electric_range_highway_mild_miles":{"type":"number","example":272.5,"description":"EV Database electric range in miles for highway driving in mild conditions of +10c"},"evdb_real_electric_range_combined_mild_miles":{"type":"number","example":322.5,"description":"EV Database electric range in miles for combined city and highway driving in mild conditions of +10c"},"evdb_real_electric_range_city_mild_miles":{"type":"number","example":382.5,"description":"EV Database electric range in miles for city driving in mild conditions of +10c"},"evdb_real_electric_range_highway_warm_miles":{"type":"integer","example":310,"description":"EV Database electric range in miles for highway driving in warm conditions of 23c, using A/C"},"evdb_real_electric_range_combined_warm_miles":{"type":"integer","example":375,"description":"EV Database electric range in miles for combined city and highway driving in warm conditions of, 23c, using A/C"},"evdb_real_electric_range_city_warm_miles":{"type":"integer","example":460,"description":"EV Database electric range in miles for city driving in warm conditions of 23c, using A/C"}}},"pence_per_mile_data":{"type":"object","properties":{"pence_per_mile_highway_cold":{"type":"object","properties":{"domestic_cheap":{"type":"number","example":2.91,"description":"Domestic cheap unit price pence per kilowatt hour (typical EV tariff)"},"domestic_standard":{"type":"number","example":13.91,"description":"Domestic standard unit price pence per kilowatt hour (typical EV tariff)"},"public_charger":{"type":"number","example":32.98,"description":"Public charger unit price pence per kilowatt hour (typical EV tariff)"}}},"pence_per_mile_combined_cold":{"type":"object","properties":{"domestic_cheap":{"type":"number","example":2.46,"description":"Domestic cheap unit price pence per kilowatt hour (typical EV tariff)"},"domestic_standard":{"type":"number","example":11.15,"description":"Domestic standard unit price pence per kilowatt hour (typical EV tariff)"},"public_charger":{"type":"number","example":27.88,"description":"Public charger unit price pence per kilowatt hour (typical EV tariff)"}}},"pence_per_mile_city_cold":{"type":"object","properties":{"domestic_cheap":{"type":"number","example":2.08,"description":"Domestic cheap unit price pence per kilowatt hour (typical EV tariff)"},"domestic_standard":{"type":"number","example":9.45,"description":"Domestic standard unit price pence per kilowatt hour (typical EV tariff)"},"public_charger":{"type":"number","example":23.63,"description":"Public charger unit price pence per kilowatt hour (typical EV tariff)"}}},"pence_per_mile_highway_mild":{"type":"object","properties":{"domestic_cheap":{"type":"number","example":2.6,"description":"Domestic cheap unit price pence per kilowatt hour (typical EV tariff)"},"domestic_standard":{"type":"number","example":11.78,"description":"Domestic standard unit price pence per kilowatt hour (typical EV tariff)"},"public_charger":{"type":"number","example":29.45,"description":"Public charger unit price pence per kilowatt hour (typical EV tariff)"}}},"pence_per_mile_combined_mild":{"type":"object","properties":{"domestic_cheap":{"type":"number","example":2.14,"description":"Domestic cheap unit price pence per kilowatt hour (typical EV tariff)"},"domestic_standard":{"type":"number","example":9.69,"description":"Domestic standard unit price pence per kilowatt hour (typical EV tariff)"},"public_charger":{"type":"number","example":24.23,"description":"Public charger unit price pence per kilowatt hour (typical EV tariff)"}}},"pence_per_mile_city_mild":{"type":"object","properties":{"domestic_cheap":{"type":"number","example":1.74,"description":"Domestic cheap unit price pence per kilowatt hour (typical EV tariff)"},"domestic_standard":{"type":"number","example":7.89,"description":"Domestic standard unit price pence per kilowatt hour (typical EV tariff)"},"public_charger":{"type":"number","example":19.72,"description":"Public charger unit price pence per kilowatt hour (typical EV tariff)"}}},"pence_per_mile_highway_warm":{"type":"object","properties":{"domestic_cheap":{"type":"number","example":1.95,"description":"Domestic cheap unit price pence per kilowatt hour (typical EV tariff)"},"domestic_standard":{"type":"number","example":8.1,"description":"Domestic standard unit price pence per kilowatt hour (typical EV tariff)"},"public_charger":{"type":"number","example":25.93,"description":"Public charger unit price pence per kilowatt hour (typical EV tariff)"}}},"pence_per_mile_combined_warm":{"type":"object","properties":{"domestic_cheap":{"type":"number","example":1.81,"description":"Domestic cheap unit price pence per kilowatt hour (typical EV tariff)"},"domestic_standard":{"type":"number","example":8.23,"description":"Domestic standard unit price pence per kilowatt hour (typical EV tariff)"},"public_charger":{"type":"number","example":20.57,"description":"Public charger unit price pence per kilowatt hour (typical EV tariff)"}}},"pence_per_mile_city_warm":{"type":"object","properties":{"domestic_cheap":{"type":"number","example":1.4,"description":"Domestic cheap unit price pence per kilowatt hour (typical EV tariff)"},"domestic_standard":{"type":"number","example":6.32,"description":"Domestic standard unit price pence per kilowatt hour (typical EV tariff)"},"public_charger":{"type":"number","example":15.81,"description":"Public charger unit price pence per kilowatt hour (typical EV tariff)"}}}}}}},"error":{"type":"string","example":"If there is an error the message would go here","description":"Details of what went wrong with the api call"}}}}}}},"security":[{"x-api-key":[]}]}},"/evdatabase/uk/van/pricinggrantstaxes":{"get":{"tags":["EV Database"],"operationId":"evdatabase_uk_van_pricinggrantstaxes","summary":"Pricing Grants & Taxes (Van)","description":"","parameters":[{"name":"evdb_vehicle_id","in":"query","description":"EV Database Vehicle ID","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"description":"Whether the api call was successful"},"result":{"type":"object","properties":{"price_inc_grants_from":{"type":"integer","example":17375,"description":"Starting price based on OTR for the local market. Includes VAT, fees with any applicable grants deducted"},"list_price_ex_vat_from":{"type":"integer","example":17298,"description":"Starting list price excluding"},"delivery_price_ex_vat":{"type":"integer","example":595,"description":"Delivery price excluding VAT"},"first_registration_fee":{"type":"integer","example":55,"description":" Registration fee (£55 for all vehicles)"},"p11d_price_from":{"type":"integer","example":59935,"description":" P11D value based on starting price"},"is_pricing_estimated":{"type":"boolean","example":false,"description":"Is pricing estimated"},"plug_in_vehicle_grant":{"type":"integer","example":5000,"description":"The amount of any plug-in car grant available for this vehiclet"}}},"error":{"type":"string","example":"If there is an error the message would go here","description":"Details of what went wrong with the api call"}}}}}}},"security":[{"x-api-key":[]}]}},"/evdatabase/uk/van/rangeefficiencybattery":{"get":{"tags":["EV Database"],"operationId":"evdatabase_uk_van_rangeefficiencybattery","summary":"Range Efficiency & Battery (van)","description":"","parameters":[{"name":"evdb_vehicle_id","in":"query","description":"EV Database Vehicle ID","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"description":"Whether the api call was successful"},"result":{"type":"object","properties":{"range":{"type":"object","properties":{"wltp_pure_electric_range_combined_test_energy_high_miles":{"type":"integer","example":331,"description":"WLTP pure electric range combined miles test energy high"},"wltp_pure_electric_range_combined_test_energy_low_miles":{"type":"integer","example":386,"description":"WLTP pure electric range combined miles test energy low"},"is_wltp_range_estimated":{"type":"boolean","example":false,"description":"Is the WLTP range estimated"},"nedc_max_ev_range_miles":{"type":"integer","example":118,"description":"NEDC maximum ev range in miles"},"is_nedc_range_estimated":{"type":"boolean","example":false,"description":"IIs the NEDC range estimated"},"evdb_real_electric_range_miles":{"type":"integer","example":325,"description":"EV Database electric range in miles"},"evdb_real_electric_range_mode":{"type":"string","example":"estimation","description":"EV Database real electric range mode"},"evdb_real_electric_range_highway_cold_miles":{"type":"integer","example":235,"description":"EV Database electric range in miles for highway driving in temperatures of -10c using heating"},"evdb_real_electric_range_combined_cold_miles":{"type":"integer","example":270,"description":"EV Database electric range in miles for combined city and highway driving in temperatures of -10c"},"evdb_real_electric_range_city_cold_miles":{"type":"integer","example":305,"description":"EV Database electric range in miles for city driving in temperatures of -10c using heating"},"evdb_real_electric_range_highway_mild_miles":{"type":"number","example":272.5,"description":"EV Database electric range in miles for highway driving in mild conditions of +10c"},"evdb_real_electric_range_combined_mild_miles":{"type":"number","example":322.5,"description":"EV Database electric range in miles for combined city and highway driving in mild conditions of +10c"},"evdb_real_electric_range_city_mild_miles":{"type":"number","example":382.5,"description":"EV Database electric range in miles for city driving in mild conditions of +10c"},"evdb_real_electric_range_highway_warm_miles":{"type":"integer","example":310,"description":"EV Database electric range in miles for highway driving in warm conditions of 23c, using A/C"},"evdb_real_electric_range_combined_warm_miles":{"type":"integer","example":375,"description":"EV Database electric range in miles for combined city and highway driving in warm conditions of, 23c, using A/C"},"evdb_real_electric_range_city_warm_miles":{"type":"integer","example":460,"description":"EV Database electric range in miles for city driving in warm conditions of 23c, using A/C"}}},"efficiency":{"type":"object","properties":{"wltp_electric_consumption_combined_test_energy_low_watt_hours_per_mile":{"type":"number","example":257.5,"description":"WLTP electric consumption per mile in watts based on test energy low in the most efficient trim"},"wltp_electric_consumption_combined_test_energy_low_miles_per_kwh":{"type":"number","example":3.9,"description":"WLTP electric consumption in miles per kwh based on test energy low in the most efficient trim"},"wltp_electric_consumption_equivalent_fuel_energy_test_energy_low_mpg":{"type":"number","example":152.5,"description":"WLTP electric consumption equivalent fuel energy miles per gallon test energy low"},"wltp_combined_test_energy_low_co2_gkm":{"type":"integer","example":0,"description":"WLTP combined CO2 g/km test energy low / most efficient trim"},"wltp_electric_consumption_combined_test_energy_high_watt_hours_per_mile":{"type":"number","example":306.5,"description":" WLTP electric consumption miles kilowatt-hour test energy high "},"wltp_electric_consumption_combined_test_energy_high_miles_per_kwh":{"type":"number","example":3.3,"description":"wltp_electric_consumption_combined_test_energy_high_miles_per_kwh"},"wltp_electric_consumption_equivalent_fuel_energy_test_energy_high_mpg":{"type":"number","example":129.5,"description":"The equivalent fuel energy expressed as petrol miles per gallon for test energy low in the least efficient trim"},"wltp_combined_test_energy_high_co2_gkm":{"type":"integer","example":0,"description":"WLTP combined CO2 g/km test energy high / least efficient trim"},"nedc_electric_consumption_watt_hours_per_mile":{"type":"number","example":257.5,"description":"NEDC electric consumption in watts per mile"},"nedc_electric_consumption_miles_per_kwh":{"type":"number","example":5.2,"description":"NEDC electric consumption in miles per kwh"},"nedc_electric_consumption_equivalent_fuel_energy_mpg":{"type":"number","example":241.5,"description":"The equivalent fuel energy expressed as petrol miles per gallon for NEDC electric consumption"},"real_electric_consumption_watt_hours_per_mile":{"type":"number","example":278.5,"description":"Calculated watts per mile based on real range and usable battery capacity"},"real_electric_consumption_miles_per_kwh":{"type":"number","example":3.6,"description":"Calculated miles per kwh based on real range and usable battery capacity"},"real_electric_consumption_equivalent_fuel_energy_mpg":{"type":"number","example":148.5,"description":"The equivalent fuel energy expressed as petrol miles per gallon based on real efficiency calculated from real range and usable battery capacity"},"evdb_real_electric_consumption_highway_cold_watt_hours_per_mile":{"type":"number","example":379.5,"description":"EV Database real electric consumption in miles per kilowatt-hours for highway driving in temperatures of -10c using heating"},"evdb_real_electric_consumption_combined_cold_watt_hours_per_mile":{"type":"number","example":330.5,"description":"EV Database real electric consumption in miles per kilowatt-hours for highway and city driving in temperatures of -10c using heating"},"evdb_real_electric_consumption_city_cold_watt_hours_per_mile":{"type":"number","example":292.5,"description":"EV Database real electric consumption in miles per kilowatt-hours for city driving in temperatures of -10c using heating"},"evdb_real_electric_consumption_highway_mild_watt_hours_per_mile":{"type":"number","example":333.5,"description":"EV Database real electric consumption in miles per kilowatt-hours for highway driving in mild conditions of +10c"},"evdb_real_electric_consumption_combined_mild_watt_hours_per_mile":{"type":"number","example":283.5,"description":"EV Database real electric consumption in miles per kilowatt-hours for highway and city driving in mild conditions of +10c"},"evdb_real_electric_consumption_city_mild_watt_hours_per_mile":{"type":"number","example":242.5,"description":"EV Database real electric consumption in miles per kilowatt-hours for city driving in mild conditions of +10c"},"evdb_real_electric_consumption_highway_warm_watt_hours_per_mile":{"type":"number","example":287.5,"description":"EV Database real electric consumption in miles per kilowatt-hours for highway driving in warm conditions of 23c, using A/C"},"evdb_real_electric_consumption_combined_warm_watt_hours_per_mile":{"type":"number","example":237.5,"description":" EV Database real electric consumption in miles per kilowatt-hours for highway and city driving in warm conditions of 23c, using A/C "},"evdb_real_electric_consumption_city_warm_watt_hours_per_mile":{"type":"number","example":193.5,"description":"EV Database real electric consumption in miles per kilowatt-hours for city driving in warm conditions of 23c, using A/C"}}},"battery":{"type":"object","properties":{"battery_type":{"type":"string","example":"Lithium-ion","description":"Battery type"},"battery_thermal_management_system":{"type":"string","example":"Active Liquid","description":"Battery type"},"battery_chemistry":{"type":"string","example":"NCM622","description":"Battery chemistry, may include ratios"},"battery_manufacturer":{"type":"string","example":"LGES","description":"Battery manufacturer"},"battery_architecture":{"type":"string","example":"400 V","description":"Battery and drivetrain architecture"},"battery_volts":{"type":"integer","example":350,"description":"Nominal battery voltage as defined by the manufacturer seats"},"battery_modules_qty":{"type":"integer","example":12,"description":"Number of battery modules"},"battery_cells_configuration":{"type":"string","example":"98s3p","description":"Number of cells in the battery pack, can include cell configuration"},"battery_weight_kg":{"type":"integer","example":349,"description":"Weight of the battery in kilograms"},"battery_warranty_years":{"type":"integer","example":10,"description":"Battery warranty period in years"},"battery_warranty_mileage":{"type":"integer","example":100000,"description":"Battery warranty in miles"}}}}},"error":{"type":"string","example":"If there is an error the message would go here","description":"Details of what went wrong with the api call"}}}}}}},"security":[{"x-api-key":[]}]}},"/evdatabase/uk/van/vehicledata":{"get":{"tags":["EV Database"],"operationId":"evdatabase_uk_van_vehicledata","summary":"Vehicle Data - Van","description":"","parameters":[{"name":"evdb_vehicle_id","in":"query","description":"EV Database Vehicle ID","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"description":"Whether the api call was successful"},"result":{"type":"object","properties":{"dimensions_weights":{"type":"object","properties":{"vehicle_length_mm":{"type":"integer","example":4282,"description":"The vehicle length in mm"},"vehicle_width_mm":{"type":"integer","example":1829,"description":"The vehicle width in mm"},"vehicle_width_inc_mirrors_mm":{"type":"integer","example":2138,"description":"Vehicle width including mirrors in mm"},"vehicle_height_mm":{"type":"integer","example":1805,"description":"The vehicle height in mm"},"is_length_width_height_estimated":{"type":"boolean","example":true,"description":"Is the length, width and height estimated"},"ground_clearance_mm":{"type":"integer","example":184,"description":"The ground clearance in mm"},"cargo_volume_m3":{"type":"integer","example":3,"description":"Cargo volume in cubic metres"},"load_length_mm":{"type":"integer","example":1731,"description":"The load length in mm."},"vehicle_wheelbase_mm":{"type":"integer","example":2697,"description":"The vehicle wheelbase in mm"},"is_wheelbase_estimated":{"type":"boolean","example":false,"description":"Is the wheelbase estimated"},"vehicleweight_kg":{"type":"integer","example":2044,"description":"Vehicle weight in kilograms"},"minimum_unladen_weight_kg":{"type":"boolean","example":false,"description":"Minimum unladen weight in kilograms"},"maximum_unladen_weight_kg":{"type":"boolean","example":false,"description":"Maximum unladen weight in kilograms"},"is_weight_estimated":{"type":"boolean","example":false,"description":"Is the vehicle weight estimated"},"minimum_gross_vehicleweight_kg":{"type":"integer","example":2830,"description":"Minimum gross vehicle weight in kilograms"},"maximum_gross_vehicleweight_kg":{"type":"integer","example":2840,"description":"Maximum gross vehicle weight in kilograms"},"minimum_gross_trainweight_kg":{"type":"integer","example":3830,"description":"Minimum gross train weight in kilograms"},"maximum_gross_trainweight_kg":{"type":"integer","example":3840,"description":"Maximum gross train weight in kilograms"},"minimum_payload_weight_kg":{"type":"integer","example":800,"description":"Maximum payload weight in kilograms"},"maximum_payload_weight_kg":{"type":"integer","example":800,"description":"Maximum gross payload weight in kilograms"},"is_tow_hook_allowed":{"type":"boolean","example":true,"description":"Is tow hook allowed"},"max_unbraked_towing_weight_kg":{"type":"integer","example":750,"description":"Maximum unbraked towing weight in kg"},"max_braked_towing_weight_kg":{"type":"integer","example":1500,"description":"Maximum braked towing weight in kg"},"is_towing_weight_estimated":{"type":"boolean","example":false,"description":"Is towing weight estimated"},"max_vertical_towing_load_weight_kg":{"type":"integer","example":100,"description":"Maximum vertical towing load weight in kg"},"min_roof_load_kg":{"type":"integer","example":100,"description":"Minimum roof load in kilograms"},"max_roof_load_kg":{"type":"integer","example":100,"description":"Maximum roof load in kilograms"}}},"drivetrain_performance":{"type":"object","properties":{"drivetrain_desc":{"type":"string","example":"Rear Wheel Drive","description":"Drivetrain"},"is_drivetrain_desc_estimated":{"type":"boolean","example":false,"description":"Is drivetrain description estimated"},"drivetrain_power_kw":{"type":"integer","example":200,"description":"Drivetrain power in kilowatts"},"drivetrain_power_bhp":{"type":"integer","example":268,"description":"Drivetrain power bhp"},"is_drivetrain_power_estimated":{"type":"boolean","example":false,"description":"Is drivetrain power estimated"},"torque_nm":{"type":"integer","example":343,"description":"The engine torque in nm"},"is_torque_estimated":{"type":"boolean","example":false,"description":"Is torque estimated"},"acceleration_0to62_mph_seconds":{"type":"number","example":20.3,"description":"Acceleration - number of seconds to go from Zero to 62 mph"},"is_acceleration_estimated":{"type":"boolean","example":false,"description":"Is acceleration estimated"},"top_speed_mph":{"type":"integer","example":50,"description":"The top speed (mph)"},"is_top_speed_estimated":{"type":"boolean","example":false,"description":"Is top speed estimated"}}},"miscellaneous":{"type":"object","properties":{"number_seats":{"type":"integer","example":5,"description":"Number of seats"},"is_roof_rails_standard":{"type":"boolean","example":false,"description":"Are roof rails standard"},"is_isofix_standard":{"type":"boolean","example":true,"description":"Is ISOFIX standard"},"number_seats_isofix":{"type":"integer","example":2,"description":"Number of ISOFIX seats"},"turning_circle_kerb_to_kerb_m":{"type":"number","example":11.6,"description":"Turning circle from kerb to kerb in metres"},"vehicle_platform_desc":{"type":"string","example":"PSA EMP21","description":"Vehicle platform description"},"is_dedicated_ev_platform":{"type":"boolean","example":true,"description":"Is dedicated EV platform"}}}}},"error":{"type":"string","example":"If there is an error the message would go here","description":"Details of what went wrong with the api call"}}}}}}},"security":[{"x-api-key":[]}]}},"/evox/colourimagesetfromdescription":{"get":{"tags":["Evox"],"operationId":"evox_colourimagesetfromdescription","summary":"colourimagesetfromdescription","description":"This endpoint returns high quality vehicle images, in multiple angles and all manufacturer colours. This endpoint returns","parameters":[{"name":"manufacturer_desc","in":"query","description":"Manufacturer description","required":true,"schema":{"type":"string"}},{"name":"model_range_desc","in":"query","description":"Model range description","required":true,"schema":{"type":"string"}},{"name":"image_specification","in":"query","description":"The size and type of images to be returned","required":true,"schema":{"type":"string"}},{"name":"number_doors","in":"query","description":"The number of doors","required":false,"schema":{"type":"integer"}},{"name":"oem_model_year","in":"query","description":"The OEM model year","required":false,"schema":{"type":"integer"}},{"name":"generic_colour_desc","in":"query","description":"The generic colour description","required":false,"schema":{"type":"string"}},{"name":"derivative_desc","in":"query","description":"The derivative description","required":false,"schema":{"type":"string"}},{"name":"body_type_desc","in":"query","description":"The body type description","required":false,"schema":{"type":"string"}},{"name":"oem_colour_desc","in":"query","description":"The OEM's colour description","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"description":"Whether the api call was successful"},"result":{"type":"array","items":{"properties":{"vehicle_desc":{"type":"string","example":"Mini Cooper S","description":"The Vehicle description"},"number_doors":{"type":"integer","example":3,"description":"The number of doors"},"body_type_desc":{"type":"string","example":"hatchback","description":"The body type description"},"oem_model_year":{"type":"integer","example":2021,"description":"The OEM's model year"},"image_library_source":{"type":"string","example":"EU","description":"The EVOX image library source"},"is_best_match":{"type":"boolean","example":true,"description":"Boolean identifying the closest matching image"},"images":{"type":"array","items":{"properties":{"oem_colour_desc":{"type":"string","example":"Midnight Black Metallic","description":"The OEM's colour description"},"generic_colour_desc":{"type":"string","example":"Black","description":"The generic colour description"},"side_image_url":{"type":"string","example":"https://a1bcdefghij2kl.example.net/3mn456o789p1011q1r2131rs41tu/color_1234_001/MY2013/1234/1234_cc1234_001_A94.jpg","description":"The side image URL"},"rear_image_url":{"type":"string","example":"https://a1bcdefghij2kl.example.net/3mn456o789p1011q1r2131rs41tu/color_1234_002/MY2013/1234/1234_cc1234_001_A94.jpg","description":"The rear image URL"},"front_image_url":{"type":"string","example":"https://a1bcdefghij2kl.example.net/3mn456o789p1011q1r2131rs41tu/color_1234_003/MY2013/1234/1234_cc1234_001_A94.jpg","description":"The front image URL"}}}},"end_user_licence_agreement_url":{"type":"string","example":"https://www.evox.com/20181025/eula/EVOX_sublicensee_EULA.pdf","description":"Theend user licence agreement"}}}},"error":{"type":"string","example":"If there is an error the message would go here","description":"Details of what went wrong with the api call"}}}}}}},"security":[{"x-api-key":[]}]}},"/evox/colourimagesetfromvin":{"get":{"tags":["Evox"],"operationId":"evox_colourimagesetfromvin","summary":"colourimagesetfromvin","description":"This endpoint returns high quality vehicle images, in multiple angles and all manufacturer colours. This endpoint returns","parameters":[{"name":"vehicle_identification_number","in":"query","description":"Vehicle identification number (VIN)","required":true,"schema":{"type":"string"}},{"name":"image_specification","in":"query","description":"The size and type of images to be returned","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"description":"Whether the api call was successful"},"result":{"type":"array","items":{"properties":{"vehicle_desc":{"type":"string","example":"Mini Cooper S","description":"The Vehicle description"},"number_doors":{"type":"integer","example":3,"description":"The number of doors"},"body_type_desc":{"type":"string","example":"hatchback","description":"The body type description"},"oem_model_year":{"type":"integer","example":2021,"description":"The OEM's model year"},"image_library_source":{"type":"string","example":"EU","description":"The EVOX image library source"},"is_best_match":{"type":"boolean","example":true,"description":"Boolean identifying the closest matching image"},"images":{"type":"array","items":{"properties":{"oem_colour_desc":{"type":"string","example":"Midnight Black Metallic","description":"The OEM's colour description"},"generic_colour_desc":{"type":"string","example":"Black","description":"The generic colour description"},"side_image_url":{"type":"string","example":"https://a1bcdefghij2kl.example.net/3mn456o789p1011q1r2131rs41tu/color_1234_001/MY2013/1234/1234_cc1234_001_A94.jpg","description":"The side image URL"},"rear_image_url":{"type":"string","example":"https://a1bcdefghij2kl.example.net/3mn456o789p1011q1r2131rs41tu/color_1234_002/MY2013/1234/1234_cc1234_001_A94.jpg","description":"The rear image URL"},"front_image_url":{"type":"string","example":"https://a1bcdefghij2kl.example.net/3mn456o789p1011q1r2131rs41tu/color_1234_003/MY2013/1234/1234_cc1234_001_A94.jpg","description":"The front image URL"}}}},"end_user_licence_agreement_url":{"type":"string","example":"https://www.evox.com/20181025/eula/EVOX_sublicensee_EULA.pdf","description":"Theend user licence agreement"}}}},"error":{"type":"string","example":"If there is an error the message would go here","description":"Details of what went wrong with the api call"}}}}}}},"security":[{"x-api-key":[]}]}},"/evox/colourimagesetfromvrm":{"get":{"tags":["Evox"],"operationId":"evox_colourimagesetfromvrm","summary":"colourimagesetfromvrm","description":"This endpoint returns high quality vehicle images, in multiple angles and all manufacturer colours. This endpoint returns","parameters":[{"name":"vehicle_registration_mark","in":"query","description":"Vehicle registration number","required":true,"schema":{"type":"string"}},{"name":"image_specification","in":"query","description":"The size and type of images to be returned","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"description":"Whether the api call was successful"},"result":{"type":"array","items":{"properties":{"vehicle_desc":{"type":"string","example":"Mini Cooper S","description":"The Vehicle description"},"number_doors":{"type":"integer","example":3,"description":"The number of doors"},"body_type_desc":{"type":"string","example":"hatchback","description":"The body type description"},"oem_model_year":{"type":"integer","example":2021,"description":"The OEM's model year"},"image_library_source":{"type":"string","example":"EU","description":"The EVOX image library source"},"is_best_match":{"type":"boolean","example":true,"description":"Boolean identifying the closest matching image"},"images":{"type":"array","items":{"properties":{"oem_colour_desc":{"type":"string","example":"Midnight Black Metallic","description":"The OEM's colour description"},"generic_colour_desc":{"type":"string","example":"Black","description":"The generic colour description"},"side_image_url":{"type":"string","example":"https://a1bcdefghij2kl.example.net/3mn456o789p1011q1r2131rs41tu/color_1234_001/MY2013/1234/1234_cc1234_001_A94.jpg","description":"The side image URL"},"rear_image_url":{"type":"string","example":"https://a1bcdefghij2kl.example.net/3mn456o789p1011q1r2131rs41tu/color_1234_002/MY2013/1234/1234_cc1234_001_A94.jpg","description":"The rear image URL"},"front_image_url":{"type":"string","example":"https://a1bcdefghij2kl.example.net/3mn456o789p1011q1r2131rs41tu/color_1234_003/MY2013/1234/1234_cc1234_001_A94.jpg","description":"The front image URL"}}}},"end_user_licence_agreement_url":{"type":"string","example":"https://www.evox.com/20181025/eula/EVOX_sublicensee_EULA.pdf","description":"Theend user licence agreement"}}}},"error":{"type":"string","example":"If there is an error the message would go here","description":"Details of what went wrong with the api call"}}}}}}},"security":[{"x-api-key":[]}]}},"/experian/autocheck/v3":{"get":{"tags":["Experian"],"operationId":"experian_autocheck","summary":"AutoCheck","description":"This vehicle history check endpoint returns basic vehicle information, including VRM, VIN, vehicle description, date of first registration, colour and CO2 emission. The number of gears, doors, seats, and transmission type are also returned. In addition, MVRIS codes, weight and power data, along with stolen, scrapped and imported/exported status are also included. By requesting both the VRM and VIN, a check will be completed to confirm a matching pair within the DVLA data.","parameters":[{"name":"vehicle_registration_mark","in":"query","description":"Vehicle registration number","required":true,"schema":{"type":"string"}},{"name":"vehicle_identification_number","in":"query","description":"Vehicle identification number","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"description":"Whether the api call was successful"},"result":{"type":"object","properties":{"date_last_updated":{"type":"string","example":"2020-01-01","description":"Date record was last updated"},"vehicle_registration_mark":{"type":"string","example":"AB21ABC","description":"Vehicle registration number"},"does_vehicle_identification_number_match":{"type":"boolean","example":true,"description":"Does the supplied vehicle_registration_mark and vehicle_identifcation input parameters match"},"dvla_manufacturer_desc":{"type":"string","example":"NISSAN","description":"DVLA manufacturer description"},"dvla_model_desc":{"type":"string","example":"QASHQAI ACENTA PREMIUM DCI","description":"DVLA model description"},"dvla_fuel_desc":{"type":"string","example":"DIESEL","description":"DVLA fuel description"},"dvla_body_desc":{"type":"string","example":"5 DOOR HATCHBACK","description":"DVLA body description"},"dvla_doorplan_code":{"type":"integer","example":12,"description":"DVLA door plan code"},"dvla_transmission_code":{"type":"string","example":"M","description":"DVLA transmission code"},"dvla_transmission_desc":{"type":"string","example":"MANUAL 6 GEARS","description":"DVLA transmission description"},"number_gears":{"type":"integer","example":6,"description":"Number of gears"},"mvris_manufacturer_code":{"type":"string","example":"A1","description":"MVRIS manufacturer code"},"mvris_model_code":{"type":"string","example":"ABC","description":"MVRIS model code"},"dvla_dtp_manufacturer_code":{"type":"string","example":"AB","description":"DVLA DTP manufacturer code"},"dvla_dtp_model_code":{"type":"integer","example":123,"description":"DVLA DTP model code"},"number_seats":{"type":"integer","example":5,"description":"Number of seats"},"dvla_wheelplan":{"type":"string","example":"2 AXLE RIGID BODY","description":"DVLA wheelplan code where available"},"registration_date":{"type":"string","example":"2020-01-01","description":"Date the vehicle was first registered in the UK"},"manufactured_year":{"type":"integer","example":2020,"description":"Year of manufacturer"},"vehicle_identification_number":{"type":"string","example":"ABCDE123456F78910","description":"The vehicle identification number."},"first_registration_date":{"type":"string","example":"2020-01-01","description":"Date of first registration"},"used_before_first_registration":{"type":"boolean","example":true,"description":"Vehicle was used before DVLA/DLNI first registration"},"co2_gkm":{"type":"integer","example":123,"description":"CO2 in g/km"},"engine_capacity_cc":{"type":"integer","example":1234,"description":"Engine capacity in cc"},"engine_number":{"type":"string","example":"A12345678","description":"Vehicle engine number"},"is_scrapped":{"type":"boolean","example":true,"description":"Has the vehicle been scrapped."},"scrapped_date":{"type":"string","example":"2020-01-01","description":"The date the vehicle was scrapped."},"is_exported":{"type":"boolean","example":true,"description":"Vehicle is exported"},"exported_date":{"type":"string","example":"2020-01-01","description":"Date vehicle was exported"},"is_imported":{"type":"boolean","example":true,"description":"Vehicle is imported"},"is_non_eu_import":{"type":"boolean","example":true,"description":"Vehicle is non-eu import"},"prior_gb_vrm":{"type":"string","example":"AB21ABC","description":"Previous GB vehicle registration mark"},"prior_ni_vrm":{"type":"string","example":"ABC1234","description":"Previous NI vehicle registration mark"},"colour":{"type":"string","example":"RED","description":"Exterior colour of vehicle"},"maximum_permissable_mass_kg":{"type":"integer","example":1234,"description":"Maximum permissable mass in kg"},"power_weight_ratio_kw_kg":{"type":"number","example":0.1234,"description":"Power to weight ratio kw per kg"},"min_kerbweight_kg":{"type":"integer","example":1234,"description":"Minimum kerbweight in kg"},"gross_vehicleweight_kg":{"type":"integer","example":1234,"description":"Gross vehicle weight in kg"},"max_netpower_kw":{"type":"integer","example":12,"description":"Maximum net power in kw"},"max_braked_towing_weight_kg":{"type":"integer","example":1234,"description":"Maximum braked towing weight in kg"},"max_unbraked_towing_weight_kg":{"type":"integer","example":123,"description":"Maximum unbraked towing weight in kg"},"stationary_soundlevel_db":{"type":"integer","example":12,"description":"Stationary sound level in decibels"},"stationary_soundlevel_rpm":{"type":"integer","example":1234,"description":"Stationary sound level rpm"},"driveby_soundlevel_db":{"type":"integer","example":12,"description":"Driveby soundlevel in db"},"v5c_data_qty":{"type":"integer","example":1,"description":"The v5c quantity"},"v5c_data_items":{"type":"array","items":{"properties":{"date_v5c_issued":{"type":"string","example":"2020-01-01","description":"The date the v5 was issued"}}}},"vehicle_identity_check_qty":{"type":"integer","example":1,"description":"The vehicle identity check quantity"},"vehicle_identity_check_items":{"type":"array","items":{"properties":{"date_of_vehicle_identity_check":{"type":"string","example":"2020-01-01","description":"Date of (previous) vehicle identity check(s)"},"result_of_vehicle_identity_check":{"type":"string","example":"Pass","description":"Result of vehicle identity check"}}}},"keeper_changes_qty":{"type":"integer","example":1,"description":"The keeper change quantity."},"keeper_data_items":{"type":"array","items":{"properties":{"date_last_updated":{"type":"string","example":"2020-01-01","description":"Date record was last updated"},"number_previous_keepers":{"type":"integer","example":1,"description":"The number of previous keepers."},"date_last_keeper_change":{"type":"string","example":"2020-01-01","description":"Date of last keeper change"}}}},"colour_changes_qty":{"type":"integer","example":1,"description":"The colour change quantity"},"colour_data_items":{"type":"array","items":{"properties":{"date_last_updated":{"type":"string","example":"2020-01-01","description":"Date record was last updated"},"number_previous_colours":{"type":"integer","example":1,"description":"The number of previous colours"},"date_last_colour_change":{"type":"string","example":"2020-01-01","description":"Date of last colour change"},"last_colour":{"type":"string","example":"BLUE","description":"The vehicle's last colour"}}}},"finance_data_qty":{"type":"integer","example":1,"description":"The finance data quantity."},"finance_data_items":{"type":"array","items":{"properties":{"date_last_updated":{"type":"string","example":"2020-01-01","description":"Date record was last updated"},"finance_start_date":{"type":"string","example":"2020-01-01","description":"The date finance agreement starts."},"finance_term_months":{"type":"integer","example":12,"description":"The term of finance agreement in months."},"finance_type":{"type":"string","example":"HIRE PURCHASE","description":"The finance type."},"finance_company":{"type":"string","example":"A FINANCE CO","description":"The finance company."},"finance_company_contact_number":{"type":"string","example":"01234 567891","description":"The finance company contact number."},"finance_agreement_number":{"type":"integer","example":1234567,"description":"The finance agreement number."},"financed_vehicle_desc":{"type":"string","example":"NISSAN QASHQAI ACENTA","description":"The financed vehicle."}}}},"cherished_data_qty":{"type":"integer","example":1,"description":"The cherished data quantity."},"cherished_data_items":{"type":"array","items":{"properties":{"cherished_plate_transfer_date":{"type":"string","example":"2020-01-01","description":"The date record was last updated."}}}},"cherish_data_items":{"type":"array","items":{"properties":{"previous_vehicle_registration_mark":{"type":"string","example":"AB21ABC","description":"The previous registration mark."},"date_of_receipt":{"type":"string","example":"2020-01-01","description":"The recorded date of transfer at DVLA."},"transfer_type":{"type":"string","example":"Marker","description":"Transfer type"},"current_vehicle_registration_mark":{"type":"string","example":"AB21ABC","description":"Current vehicle registration mark"}}}},"condition_data_qty":{"type":"integer","example":1,"description":"The condition data quantity."},"condition_data_items":{"type":"array","items":{"properties":{"date_last_updated":{"type":"string","example":"2020-01-01","description":"Date record was last updated"},"date_of_loss":{"type":"string","example":"2020-01-01","description":"The date of loss."},"vehicle_status":{"type":"string","example":"VEHICLE HAS BEEN STOLEN","description":"The vehicle status."},"theft_indictor_literal":{"type":"string","example":"STOLEN","description":"The theft indicator."},"date_of_miaftr_entry":{"type":"string","example":"2020-01-01","description":"The MIAFTR entry date."},"insurer_name":{"type":"string","example":"EXAMPLE INSURANCE CO","description":"The insurer's name."},"insurer_contact_number":{"type":"string","example":"01234 567891","description":"The insurer's contact number."},"insurer_claim_name":{"type":"string","example":"EXAMPLE NAME","description":"Insurer's claim name"},"loss_type":{"type":"string","example":"T","description":"The flag to indicate type of loss for old insurance motor claims."},"insurer_make":{"type":"string","example":"NISS","description":"The insurer's manufacturer description."},"insurer_model":{"type":"string","example":"QAS","description":"The insurer's model description."},"insurer_code":{"type":"string","example":"1234","description":"The insurer's code."},"insurer_branch":{"type":"integer","example":12345,"description":"The insurer's branch number."},"theft_indicator":{"type":"string","example":"Y","description":"The theft indicator."},"date_removed":{"type":"string","example":"2020-01-01","description":"The date the condition was removed."}}}},"stolen_vehicle_data_qty":{"type":"integer","example":1,"description":"The stolen vehicle data quantity."},"stolen_vehicle_data_items":{"type":"array","items":{"properties":{"date_last_updated":{"type":"string","example":"2020-01-01","description":"Date record was last updated"},"date_reported":{"type":"string","example":"2020-01-01","description":"The date vehicle was reported as stolen."},"is_stolen":{"type":"boolean","example":true,"description":"Is the vehicle stolen"},"police_force":{"type":"string","example":"COUNTY POLICE FORCE","description":"The investigating police force."},"police_force_contact_number":{"type":"string","example":"01234 567891","description":"The investigating police force contact number."}}}},"high_risk_data_qty":{"type":"integer","example":1,"description":"The high risk data quantity."},"high_risk_data_items":{"type":"array","items":{"properties":{"date_last_updated":{"type":"string","example":"2020-01-01","description":"Date record was last updated"},"date_of_interest":{"type":"string","example":"2020-01-01","description":"The date vehicle was marked as high risk."},"registration_period":{"type":"integer","example":12,"description":"The registration period in months."},"high_risk_type":{"type":"string","example":"AT RISK","description":"The high risk type."},"extra_information":{"type":"string","example":"Additional information relating to high risk","description":"The additional information relating to high risk."},"company_name":{"type":"string","example":"A FINANCE CO","description":"The company holding an interest in the vehicle."},"company_contact_number":{"type":"string","example":"01234 567891","description":"The company contact number."},"company_contact_reference":{"type":"string","example":"Reference","description":"The company contact reference."}}}},"previous_search_qty":{"type":"integer","example":1,"description":"The previous search quantity."},"previous_search_items":{"type":"array","items":{"properties":{"date_of_search":{"type":"string","example":"2021-08-14","description":"The date of the last search."},"time_of_search":{"type":"string","example":"10:56:18","description":"The time of search (hh:mm:ss)"},"business_type_searching":{"type":"string","example":"MOTOR TRADE & OTHER","description":"The business type"}}}},"indemnity_months":{"type":"integer","example":12,"description":"The indemnity period in months for any data guarantee purchased as part of the check"},"indemnity_gbp":{"type":"integer","example":10000,"description":"The indemnity amount in GBP for any data guarantee purchased as part of the check"}}},"error":{"type":"string","example":"If there is an error the message would go here","description":"Details of what went wrong with the api call"}}}}}}},"security":[{"x-api-key":[]}]}},"/experian/autocheck-10k-guarantee/v3":{"get":{"tags":["Experian"],"operationId":"experian_autocheck-10k-guarantee","summary":"AutoCheck 10k Guarantee","description":"This vehicle history check endpoint returns all the expected data associated withe Experian's AutoCheck service but also includes a data guarantee should incorrect data be returned. The check includes basic vehicle information, VRM, VIN, vehicle description, date of first registration, colour and CO2 emission. The number of gears, doors, seats, and transmission type are also returned. In addition, MVRIS codes, weight and power data, along with stolen, scrapped and imported/exported status are also included. By requesting both the VRM and VIN, a check will be completed to confirm a matching pair within the DVLA data.","parameters":[{"name":"vehicle_registration_mark","in":"query","description":"Vehicle registration number","required":true,"schema":{"type":"string"}},{"name":"vehicle_identification_number","in":"query","description":"Vehicle identification number","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"description":"Whether the api call was successful"},"result":{"type":"object","properties":{"date_last_updated":{"type":"string","example":"2020-01-01","description":"Date record was last updated"},"vehicle_registration_mark":{"type":"string","example":"AB21ABC","description":"Vehicle registration number"},"does_vehicle_identification_number_match":{"type":"boolean","example":true,"description":"Does the supplied vehicle_registration_mark and vehicle_identifcation input parameters match"},"dvla_manufacturer_desc":{"type":"string","example":"NISSAN","description":"DVLA manufacturer description"},"dvla_model_desc":{"type":"string","example":"QASHQAI ACENTA PREMIUM DCI","description":"DVLA model description"},"dvla_fuel_desc":{"type":"string","example":"DIESEL","description":"DVLA fuel description"},"dvla_body_desc":{"type":"string","example":"5 DOOR HATCHBACK","description":"DVLA body description"},"dvla_doorplan_code":{"type":"integer","example":12,"description":"DVLA door plan code"},"dvla_transmission_code":{"type":"string","example":"M","description":"DVLA transmission code"},"dvla_transmission_desc":{"type":"string","example":"MANUAL 6 GEARS","description":"DVLA transmission description"},"number_gears":{"type":"integer","example":6,"description":"Number of gears"},"mvris_manufacturer_code":{"type":"string","example":"A1","description":"MVRIS manufacturer code"},"mvris_model_code":{"type":"string","example":"ABC","description":"MVRIS model code"},"dvla_dtp_manufacturer_code":{"type":"string","example":"AB","description":"DVLA DTP manufacturer code"},"dvla_dtp_model_code":{"type":"integer","example":123,"description":"DVLA DTP model code"},"number_seats":{"type":"integer","example":5,"description":"Number of seats"},"dvla_wheelplan":{"type":"string","example":"2 AXLE RIGID BODY","description":"DVLA wheelplan code where available"},"registration_date":{"type":"string","example":"2020-01-01","description":"Date the vehicle was first registered in the UK"},"manufactured_year":{"type":"integer","example":2020,"description":"Year of manufacturer"},"vehicle_identification_number":{"type":"string","example":"ABCDE123456F78910","description":"The vehicle identification number."},"first_registration_date":{"type":"string","example":"2020-01-01","description":"Date of first registration"},"used_before_first_registration":{"type":"boolean","example":true,"description":"Vehicle was used before DVLA/DLNI first registration"},"co2_gkm":{"type":"integer","example":123,"description":"CO2 in g/km"},"engine_capacity_cc":{"type":"integer","example":1234,"description":"Engine capacity in cc"},"engine_number":{"type":"string","example":"A12345678","description":"Vehicle engine number"},"is_scrapped":{"type":"boolean","example":true,"description":"Has the vehicle been scrapped."},"scrapped_date":{"type":"string","example":"2020-01-01","description":"The date the vehicle was scrapped."},"is_exported":{"type":"boolean","example":true,"description":"Vehicle is exported"},"exported_date":{"type":"string","example":"2020-01-01","description":"Date vehicle was exported"},"is_imported":{"type":"boolean","example":true,"description":"Vehicle is imported"},"is_non_eu_import":{"type":"boolean","example":true,"description":"Vehicle is non-eu import"},"prior_gb_vrm":{"type":"string","example":"AB21ABC","description":"Previous GB vehicle registration mark"},"prior_ni_vrm":{"type":"string","example":"ABC1234","description":"Previous NI vehicle registration mark"},"colour":{"type":"string","example":"RED","description":"Exterior colour of vehicle"},"maximum_permissable_mass_kg":{"type":"integer","example":1234,"description":"Maximum permissable mass in kg"},"power_weight_ratio_kw_kg":{"type":"number","example":0.1234,"description":"Power to weight ratio kw per kg"},"min_kerbweight_kg":{"type":"integer","example":1234,"description":"Minimum kerbweight in kg"},"gross_vehicleweight_kg":{"type":"integer","example":1234,"description":"Gross vehicle weight in kg"},"max_netpower_kw":{"type":"integer","example":12,"description":"Maximum net power in kw"},"max_braked_towing_weight_kg":{"type":"integer","example":1234,"description":"Maximum braked towing weight in kg"},"max_unbraked_towing_weight_kg":{"type":"integer","example":123,"description":"Maximum unbraked towing weight in kg"},"stationary_soundlevel_db":{"type":"integer","example":12,"description":"Stationary sound level in decibels"},"stationary_soundlevel_rpm":{"type":"integer","example":1234,"description":"Stationary sound level rpm"},"driveby_soundlevel_db":{"type":"integer","example":12,"description":"Driveby soundlevel in db"},"v5c_data_qty":{"type":"integer","example":1,"description":"The v5c quantity"},"v5c_data_items":{"type":"array","items":{"properties":{"date_v5c_issued":{"type":"string","example":"2020-01-01","description":"The date the v5 was issued"}}}},"vehicle_identity_check_qty":{"type":"integer","example":1,"description":"The vehicle identity check quantity"},"vehicle_identity_check_items":{"type":"array","items":{"properties":{"date_of_vehicle_identity_check":{"type":"string","example":"2020-01-01","description":"Date of (previous) vehicle identity check(s)"},"result_of_vehicle_identity_check":{"type":"string","example":"Pass","description":"Result of vehicle identity check"}}}},"keeper_changes_qty":{"type":"integer","example":1,"description":"The keeper change quantity."},"keeper_data_items":{"type":"array","items":{"properties":{"date_last_updated":{"type":"string","example":"2020-01-01","description":"Date record was last updated"},"number_previous_keepers":{"type":"integer","example":1,"description":"The number of previous keepers."},"date_of_last_keeper_change":{"type":"string","example":"2020-01-01","description":"The date of last keeper change."}}}},"colour_changes_qty":{"type":"integer","example":1,"description":"The colour change quantity"},"colour_data_items":{"type":"array","items":{"properties":{"date_last_updated":{"type":"string","example":"2020-01-01","description":"Date record was last updated"},"number_previous_colours":{"type":"integer","example":1,"description":"The number of previous colours"},"date_of_last_colour_change":{"type":"string","example":"2020-01-01","description":"Date of last colour change"},"last_colour":{"type":"string","example":"BLUE","description":"The vehicle's last colour"}}}},"finance_data_qty":{"type":"integer","example":1,"description":"The finance data quantity."},"finance_data_items":{"type":"array","items":{"properties":{"date_last_updated":{"type":"string","example":"2020-01-01","description":"Date record was last updated"},"finance_start_date":{"type":"string","example":"2020-01-01","description":"The date finance agreement starts."},"finance_term_months":{"type":"integer","example":12,"description":"The term of finance agreement in months."},"finance_type":{"type":"string","example":"HIRE PURCHASE","description":"The finance type."},"finance_company":{"type":"string","example":"A FINANCE CO","description":"The finance company."},"finance_company_contact_number":{"type":"string","example":"01234 567891","description":"The finance company contact number."},"finance_agreement_number":{"type":"integer","example":1234567,"description":"The finance agreement number."},"financed_vehicle_desc":{"type":"string","example":"NISSAN QASHQAI ACENTA","description":"The financed vehicle."}}}},"cherished_data_qty":{"type":"integer","example":1,"description":"The cherished data quantity."},"cherished_data_items":{"type":"array","items":{"properties":{"cherished_plate_transfer_date":{"type":"string","example":"2020-01-01","description":"The date record was last updated."},"previous_vehicle_registration_mark":{"type":"string","example":"AB21ABC","description":"The previous registration mark."},"date_of_receipt":{"type":"string","example":"2020-01-01","description":"The recorded date of transfer at DVLA."},"transfer_type":{"type":"string","example":"Marker","description":"Transfer type"},"current_vehicle_registration_mark":{"type":"string","example":"AB21ABC","description":"Current vehicle registration mark"}}}},"condition_data_qty":{"type":"integer","example":1,"description":"The condition data quantity."},"condition_data_items":{"type":"array","items":{"properties":{"date_last_updated":{"type":"string","example":"2020-01-01","description":"Date record was last updated"},"date_of_loss":{"type":"string","example":"2020-01-01","description":"The date of loss."},"vehicle_status":{"type":"string","example":"VEHICLE HAS BEEN STOLEN","description":"The vehicle status."},"theft_indictor_literal":{"type":"string","example":"STOLEN","description":"The theft indicator."},"date_of_miaftr_entry":{"type":"string","example":"2020-01-01","description":"The MIAFTR entry date."},"insurer_name":{"type":"string","example":"EXAMPLE INSURANCE CO","description":"The insurer's name."},"insurer_contact_number":{"type":"string","example":"01234 567891","description":"The insurer's contact number."},"insurer_claim_number":{"type":"string","example":"EXAMPLE","description":"The insurer's claim number."},"loss_type":{"type":"string","example":"T","description":"The flag to indicate type of loss for old insurance motor claims."},"insurer_make":{"type":"string","example":"NISS","description":"The insurer's manufacturer description."},"insurer_model":{"type":"string","example":"QAS","description":"The insurer's model description."},"insurer_code":{"type":"string","example":"1234","description":"The insurer's code."},"insurer_branch":{"type":"integer","example":12345,"description":"The insurer's branch number."},"theft_indicator":{"type":"string","example":"Y","description":"The theft indicator."},"date_removed":{"type":"string","example":"2020-01-01","description":"The date the condition was removed."}}}},"stolen_vehicle_data_qty":{"type":"integer","example":1,"description":"The stolen vehicle data quantity."},"stolen_vehicle_data_items":{"type":"array","items":{"properties":{"date_last_updated":{"type":"string","example":"2020-01-01","description":"Date record was last updated"},"date_reported":{"type":"string","example":"2020-01-01","description":"The date vehicle was reported as stolen."},"is_stolen":{"type":"boolean","example":false,"description":"Is the vehicle stolen"},"police_force":{"type":"string","example":"COUNTY POLICE FORCE","description":"The investigating police force."},"police_force_contact_number":{"type":"string","example":"01234 567891","description":"The investigating police force contact number."}}}},"high_risk_data_qty":{"type":"integer","example":1,"description":"The high risk data quantity."},"high_risk_data_items":{"type":"array","items":{"properties":{"date_last_updated":{"type":"string","example":"2020-01-01","description":"Date record was last updated"},"date_of_interest":{"type":"string","example":"2020-01-01","description":"The date vehicle was marked as high risk."},"registration_period":{"type":"integer","example":12,"description":"The registration period in months."},"high_risk_type":{"type":"string","example":"AT RISK","description":"The high risk type."},"extra_information":{"type":"string","example":"Additional information relating to high risk","description":"The additional information relating to high risk."},"company_name":{"type":"string","example":"A FINANCE CO","description":"The company holding an interest in the vehicle."},"company_contact_number":{"type":"string","example":"01234 567891","description":"The company contact number."},"company_contact_reference":{"type":"string","example":"Reference","description":"The company contact reference."}}}},"previous_search_qty":{"type":"integer","example":1,"description":"The previous search quantity."},"previous_search_items":{"type":"array","items":{"properties":{"date_of_search":{"type":"string","example":"2021-08-14","description":"The date of the last search."},"time_of_search":{"type":"string","example":"10:56:18","description":"The time of search (hh:mm:ss)"},"business_type_searching":{"type":"string","example":"MOTOR TRADE & OTHER","description":"The business type"}}}},"indemnity_months":{"type":"integer","example":12,"description":"The indemnity period in months for any data guarantee purchased as part of the check"},"indemnity_gbp":{"type":"integer","example":10000,"description":"The indemnity amount in GBP for any data guarantee purchased as part of the check"}}},"error":{"type":"string","example":"If there is an error the message would go here","description":"Details of what went wrong with the api call"}}}}}}},"security":[{"x-api-key":[]}]}},"/experian/autocheck-20k-guarantee/v3":{"get":{"tags":["Experian"],"operationId":"experian_autocheck-20k-guarantee","summary":"AutoCheck 20k Guarantee","description":"This vehicle history check endpoint returns all the expected data associated withe Experian's AutoCheck service but also includes a data guarantee should incorrect data be returned. The check includes basic vehicle information, VRM, VIN, vehicle description, date of first registration, colour and CO2 emission. The number of gears, doors, seats, and transmission type are also returned. In addition, MVRIS codes, weight and power data, along with stolen, scrapped and imported/exported status are also included. By requesting both the VRM and VIN, a check will be completed to confirm a matching pair within the DVLA data.","parameters":[{"name":"vehicle_registration_mark","in":"query","description":"Vehicle registration number","required":true,"schema":{"type":"string"}},{"name":"vehicle_identification_number","in":"query","description":"Vehicle identification number","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"description":"Whether the api call was successful"},"result":{"type":"object","properties":{"date_last_updated":{"type":"string","example":"2020-01-01","description":"Date record was last updated"},"vehicle_registration_mark":{"type":"string","example":"AB21ABC","description":"Vehicle registration number"},"does_vehicle_identification_number_match":{"type":"boolean","example":true,"description":"Does the supplied vehicle_registration_mark and vehicle_identifcation input parameters match"},"dvla_manufacturer_desc":{"type":"string","example":"NISSAN","description":"DVLA manufacturer description"},"dvla_model_desc":{"type":"string","example":"QASHQAI ACENTA PREMIUM DCI","description":"DVLA model description"},"dvla_fuel_desc":{"type":"string","example":"DIESEL","description":"DVLA fuel description"},"dvla_body_desc":{"type":"string","example":"5 DOOR HATCHBACK","description":"DVLA body description"},"dvla_doorplan_code":{"type":"integer","example":12,"description":"DVLA door plan code"},"dvla_transmission_code":{"type":"string","example":"M","description":"DVLA transmission code"},"dvla_transmission_desc":{"type":"string","example":"MANUAL 6 GEARS","description":"DVLA transmission description"},"number_gears":{"type":"integer","example":6,"description":"Number of gears"},"mvris_manufacturer_code":{"type":"string","example":"A1","description":"MVRIS manufacturer code"},"mvris_model_code":{"type":"string","example":"ABC","description":"MVRIS model code"},"dvla_dtp_manufacturer_code":{"type":"string","example":"AB","description":"DVLA DTP manufacturer code"},"dvla_dtp_model_code":{"type":"integer","example":123,"description":"DVLA DTP model code"},"number_seats":{"type":"integer","example":5,"description":"Number of seats"},"dvla_wheelplan":{"type":"string","example":"2 AXLE RIGID BODY","description":"DVLA wheelplan code where available"},"registration_date":{"type":"string","example":"2020-01-01","description":"Date the vehicle was first registered in the UK"},"manufactured_year":{"type":"integer","example":2020,"description":"Year of manufacturer"},"vehicle_identification_number":{"type":"string","example":"ABCDE123456F78910","description":"The vehicle identification number."},"first_registration_date":{"type":"string","example":"2020-01-01","description":"Date of first registration"},"used_before_first_registration":{"type":"boolean","example":true,"description":"Vehicle was used before DVLA/DLNI first registration"},"co2_gkm":{"type":"integer","example":123,"description":"CO2 in g/km"},"engine_capacity_cc":{"type":"integer","example":1234,"description":"Engine capacity in cc"},"engine_number":{"type":"string","example":"A12345678","description":"Vehicle engine number"},"is_scrapped":{"type":"boolean","example":true,"description":"Has the vehicle been scrapped."},"scrapped_date":{"type":"string","example":"2020-01-01","description":"The date the vehicle was scrapped."},"is_exported":{"type":"boolean","example":true,"description":"Vehicle is exported"},"exported_date":{"type":"string","example":"2020-01-01","description":"Date vehicle was exported"},"is_imported":{"type":"boolean","example":true,"description":"Vehicle is imported"},"is_non_eu_import":{"type":"boolean","example":true,"description":"Vehicle is non-eu import"},"prior_gb_vrm":{"type":"string","example":"AB21ABC","description":"Previous GB vehicle registration mark"},"prior_ni_vrm":{"type":"string","example":"ABC1234","description":"Previous NI vehicle registration mark"},"colour":{"type":"string","example":"RED","description":"Exterior colour of vehicle"},"maximum_permissable_mass_kg":{"type":"integer","example":1234,"description":"Maximum permissable mass in kg"},"power_weight_ratio_kw_kg":{"type":"number","example":0.1234,"description":"Power to weight ratio kw per kg"},"min_kerbweight_kg":{"type":"integer","example":1234,"description":"Minimum kerbweight in kg"},"gross_vehicleweight_kg":{"type":"integer","example":1234,"description":"Gross vehicle weight in kg"},"max_netpower_kw":{"type":"integer","example":12,"description":"Maximum net power in kw"},"max_braked_towing_weight_kg":{"type":"integer","example":1234,"description":"Maximum braked towing weight in kg"},"max_unbraked_towing_weight_kg":{"type":"integer","example":123,"description":"Maximum unbraked towing weight in kg"},"stationary_soundlevel_db":{"type":"integer","example":12,"description":"Stationary sound level in decibels"},"stationary_soundlevel_rpm":{"type":"integer","example":1234,"description":"Stationary sound level rpm"},"driveby_soundlevel_db":{"type":"integer","example":12,"description":"Driveby soundlevel in db"},"v5c_data_qty":{"type":"integer","example":1,"description":"The v5c quantity"},"v5c_data_items":{"type":"array","items":{"properties":{"date_v5c_issued":{"type":"string","example":"2020-01-01","description":"The date the v5 was issued"}}}},"vehicle_identity_check_qty":{"type":"integer","example":1,"description":"The vehicle identity check quantity"},"vehicle_identity_check_items":{"type":"array","items":{"properties":{"date_of_vehicle_identity_check":{"type":"string","example":"2020-01-01","description":"Date of (previous) vehicle identity check(s)"},"result_of_vehicle_identity_check":{"type":"string","example":"Pass","description":"Result of vehicle identity check"}}}},"keeper_changes_qty":{"type":"integer","example":1,"description":"The keeper change quantity."},"keeper_data_items":{"type":"array","items":{"properties":{"date_last_updated":{"type":"string","example":"2020-01-01","description":"Date record was last updated"},"number_previous_keepers":{"type":"integer","example":1,"description":"The number of previous keepers."},"date_of_last_keeper_change":{"type":"string","example":"2020-01-01","description":"The date of last keeper change."}}}},"colour_changes_qty":{"type":"integer","example":1,"description":"The colour change quantity"},"colour_data_items":{"type":"array","items":{"properties":{"date_last_updated":{"type":"string","example":"2020-01-01","description":"Date record was last updated"},"number_previous_colours":{"type":"integer","example":1,"description":"The number of previous colours"},"date_of_last_colour_change":{"type":"string","example":"2020-01-01","description":"Date of last colour change"},"last_colour":{"type":"string","example":"BLUE","description":"The vehicle's last colour"}}}},"finance_data_qty":{"type":"integer","example":1,"description":"The finance data quantity."},"finance_data_items":{"type":"array","items":{"properties":{"date_last_updated":{"type":"string","example":"2020-01-01","description":"Date record was last updated"},"finance_start_date":{"type":"string","example":"2020-01-01","description":"The date finance agreement starts."},"finance_term_months":{"type":"integer","example":12,"description":"The term of finance agreement in months."},"finance_type":{"type":"string","example":"HIRE PURCHASE","description":"The finance type."},"finance_company":{"type":"string","example":"A FINANCE CO","description":"The finance company."},"finance_company_contact_number":{"type":"string","example":"01234 567891","description":"The finance company contact number."},"finance_agreement_number":{"type":"integer","example":1234567,"description":"The finance agreement number."},"financed_vehicle_desc":{"type":"string","example":"NISSAN QASHQAI ACENTA","description":"The financed vehicle."}}}},"cherished_data_qty":{"type":"integer","example":1,"description":"The cherished data quantity."},"cherished_data_items":{"type":"array","items":{"properties":{"cherished_plate_transfer_date":{"type":"string","example":"2020-01-01","description":"The date record was last updated."},"previous_vehicle_registration_mark":{"type":"string","example":"AB21ABC","description":"The previous registration mark."},"date_of_receipt":{"type":"string","example":"2020-01-01","description":"The recorded date of transfer at DVLA."},"transfer_type":{"type":"string","example":"Marker","description":"Transfer type"},"current_vehicle_registration_mark":{"type":"string","example":"AB21ABC","description":"Current vehicle registration mark"}}}},"condition_data_qty":{"type":"integer","example":1,"description":"The condition data quantity."},"condition_data_items":{"type":"array","items":{"properties":{"date_last_updated":{"type":"string","example":"2020-01-01","description":"Date record was last updated"},"date_of_loss":{"type":"string","example":"2020-01-01","description":"The date of loss."},"vehicle_status":{"type":"string","example":"VEHICLE HAS BEEN STOLEN","description":"The vehicle status."},"theft_indictor_literal":{"type":"string","example":"STOLEN","description":"The theft indicator."},"date_of_miaftr_entry":{"type":"string","example":"2020-01-01","description":"The MIAFTR entry date."},"insurer_name":{"type":"string","example":"EXAMPLE INSURANCE CO","description":"The insurer's name."},"insurer_contact_number":{"type":"string","example":"01234 567891","description":"The insurer's contact number."},"insurer_claim_number":{"type":"string","example":"EXAMPLE","description":"The insurer's claim number."},"loss_type":{"type":"string","example":"T","description":"The flag to indicate type of loss for old insurance motor claims."},"insurer_make":{"type":"string","example":"NISS","description":"The insurer's manufacturer description."},"insurer_model":{"type":"string","example":"QAS","description":"The insurer's model description."},"insurer_code":{"type":"string","example":"1234","description":"The insurer's code."},"insurer_branch":{"type":"integer","example":12345,"description":"The insurer's branch number."},"theft_indicator":{"type":"string","example":"Y","description":"The theft indicator."},"date_removed":{"type":"string","example":"2020-01-01","description":"The date the condition was removed."}}}},"stolen_vehicle_data_qty":{"type":"integer","example":1,"description":"The stolen vehicle data quantity."},"stolen_vehicle_data_items":{"type":"array","items":{"properties":{"date_last_updated":{"type":"string","example":"2020-01-01","description":"Date record was last updated"},"date_reported":{"type":"string","example":"2020-01-01","description":"The date vehicle was reported as stolen."},"is_stolen":{"type":"boolean","example":false,"description":"Is the vehicle stolen"},"police_force":{"type":"string","example":"COUNTY POLICE FORCE","description":"The investigating police force."},"police_force_contact_number":{"type":"string","example":"01234 567891","description":"The investigating police force contact number."}}}},"high_risk_data_qty":{"type":"integer","example":1,"description":"The high risk data quantity."},"high_risk_data_items":{"type":"array","items":{"properties":{"date_last_updated":{"type":"string","example":"2020-01-01","description":"Date record was last updated"},"date_of_interest":{"type":"string","example":"2020-01-01","description":"The date vehicle was marked as high risk."},"registration_period":{"type":"integer","example":12,"description":"The registration period in months."},"high_risk_type":{"type":"string","example":"AT RISK","description":"The high risk type."},"extra_information":{"type":"string","example":"Additional information relating to high risk","description":"The additional information relating to high risk."},"company_name":{"type":"string","example":"A FINANCE CO","description":"The company holding an interest in the vehicle."},"company_contact_number":{"type":"string","example":"01234 567891","description":"The company contact number."},"company_contact_reference":{"type":"string","example":"Reference","description":"The company contact reference."}}}},"previous_search_qty":{"type":"integer","example":1,"description":"The previous search quantity."},"previous_search_items":{"type":"array","items":{"properties":{"date_of_search":{"type":"string","example":"2021-08-14","description":"The date of the last search."},"time_of_search":{"type":"string","example":"10:56:18","description":"The time of search (hh:mm:ss)"},"business_type_searching":{"type":"string","example":"MOTOR TRADE & OTHER","description":"The business type"}}}},"indemnity_months":{"type":"integer","example":12,"description":"The indemnity period in months for any data guarantee purchased as part of the check"},"indemnity_gbp":{"type":"integer","example":10000,"description":"The indemnity amount in GBP for any data guarantee purchased as part of the check"}}},"error":{"type":"string","example":"If there is an error the message would go here","description":"Details of what went wrong with the api call"}}}}}}},"security":[{"x-api-key":[]}]}},"/experian/autocheck-30k-guarantee/v3":{"get":{"tags":["Experian"],"operationId":"experian_autocheck-30k-guarantee","summary":"AutoCheck 30k Guarantee","description":"This vehicle history check endpoint returns all the expected data associated withe Experian's AutoCheck service but also includes a data guarantee should incorrect data be returned. The check includes basic vehicle information, VRM, VIN, vehicle description, date of first registration, colour and CO2 emission. The number of gears, doors, seats, and transmission type are also returned. In addition, MVRIS codes, weight and power data, along with stolen, scrapped and imported/exported status are also included. By requesting both the VRM and VIN, a check will be completed to confirm a matching pair within the DVLA data.","parameters":[{"name":"vehicle_registration_mark","in":"query","description":"Vehicle registration number","required":true,"schema":{"type":"string"}},{"name":"vehicle_identification_number","in":"query","description":"Vehicle identification number","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"description":"Whether the api call was successful"},"result":{"type":"object","properties":{"date_last_updated":{"type":"string","example":"2020-01-01","description":"Date record was last updated"},"vehicle_registration_mark":{"type":"string","example":"AB21ABC","description":"Vehicle registration number"},"does_vehicle_identification_number_match":{"type":"boolean","example":true,"description":"Does the supplied vehicle_registration_mark and vehicle_identifcation input parameters match"},"dvla_manufacturer_desc":{"type":"string","example":"NISSAN","description":"DVLA manufacturer description"},"dvla_model_desc":{"type":"string","example":"QASHQAI ACENTA PREMIUM DCI","description":"DVLA model description"},"dvla_fuel_desc":{"type":"string","example":"DIESEL","description":"DVLA fuel description"},"dvla_body_desc":{"type":"string","example":"5 DOOR HATCHBACK","description":"DVLA body description"},"dvla_doorplan_code":{"type":"integer","example":12,"description":"DVLA door plan code"},"dvla_transmission_code":{"type":"string","example":"M","description":"DVLA transmission code"},"dvla_transmission_desc":{"type":"string","example":"MANUAL 6 GEARS","description":"DVLA transmission description"},"number_gears":{"type":"integer","example":6,"description":"Number of gears"},"mvris_manufacturer_code":{"type":"string","example":"A1","description":"MVRIS manufacturer code"},"mvris_model_code":{"type":"string","example":"ABC","description":"MVRIS model code"},"dvla_dtp_manufacturer_code":{"type":"string","example":"AB","description":"DVLA DTP manufacturer code"},"dvla_dtp_model_code":{"type":"integer","example":123,"description":"DVLA DTP model code"},"number_seats":{"type":"integer","example":5,"description":"Number of seats"},"dvla_wheelplan":{"type":"string","example":"2 AXLE RIGID BODY","description":"DVLA wheelplan code where available"},"registration_date":{"type":"string","example":"2020-01-01","description":"Date the vehicle was first registered in the UK"},"manufactured_year":{"type":"integer","example":2020,"description":"Year of manufacturer"},"vehicle_identification_number":{"type":"string","example":"ABCDE123456F78910","description":"The vehicle identification number."},"first_registration_date":{"type":"string","example":"2020-01-01","description":"Date of first registration"},"used_before_first_registration":{"type":"boolean","example":true,"description":"Vehicle was used before DVLA/DLNI first registration"},"co2_gkm":{"type":"integer","example":123,"description":"CO2 in g/km"},"engine_capacity_cc":{"type":"integer","example":1234,"description":"Engine capacity in cc"},"engine_number":{"type":"string","example":"A12345678","description":"Vehicle engine number"},"is_scrapped":{"type":"boolean","example":true,"description":"Has the vehicle been scrapped."},"scrapped_date":{"type":"string","example":"2020-01-01","description":"The date the vehicle was scrapped."},"is_exported":{"type":"boolean","example":true,"description":"Vehicle is exported"},"exported_date":{"type":"string","example":"2020-01-01","description":"Date vehicle was exported"},"is_imported":{"type":"boolean","example":true,"description":"Vehicle is imported"},"is_non_eu_import":{"type":"boolean","example":true,"description":"Vehicle is non-eu import"},"prior_gb_vrm":{"type":"string","example":"AB21ABC","description":"Previous GB vehicle registration mark"},"prior_ni_vrm":{"type":"string","example":"ABC1234","description":"Previous NI vehicle registration mark"},"colour":{"type":"string","example":"RED","description":"Exterior colour of vehicle"},"maximum_permissable_mass_kg":{"type":"integer","example":1234,"description":"Maximum permissable mass in kg"},"power_weight_ratio_kw_kg":{"type":"number","example":0.1234,"description":"Power to weight ratio kw per kg"},"min_kerbweight_kg":{"type":"integer","example":1234,"description":"Minimum kerbweight in kg"},"gross_vehicleweight_kg":{"type":"integer","example":1234,"description":"Gross vehicle weight in kg"},"max_netpower_kw":{"type":"integer","example":12,"description":"Maximum net power in kw"},"max_braked_towing_weight_kg":{"type":"integer","example":1234,"description":"Maximum braked towing weight in kg"},"max_unbraked_towing_weight_kg":{"type":"integer","example":123,"description":"Maximum unbraked towing weight in kg"},"stationary_soundlevel_db":{"type":"integer","example":12,"description":"Stationary sound level in decibels"},"stationary_soundlevel_rpm":{"type":"integer","example":1234,"description":"Stationary sound level rpm"},"driveby_soundlevel_db":{"type":"integer","example":12,"description":"Driveby soundlevel in db"},"v5c_data_qty":{"type":"integer","example":1,"description":"The v5c quantity"},"v5c_data_items":{"type":"array","items":{"properties":{"date_v5c_issued":{"type":"string","example":"2020-01-01","description":"The date the v5 was issued"}}}},"vehicle_identity_check_qty":{"type":"integer","example":1,"description":"The vehicle identity check quantity"},"vehicle_identity_check_items":{"type":"array","items":{"properties":{"date_of_vehicle_identity_check":{"type":"string","example":"2020-01-01","description":"Date of (previous) vehicle identity check(s)"},"result_of_vehicle_identity_check":{"type":"string","example":"Pass","description":"Result of vehicle identity check"}}}},"keeper_changes_qty":{"type":"integer","example":1,"description":"The keeper change quantity."},"keeper_data_items":{"type":"array","items":{"properties":{"date_last_updated":{"type":"string","example":"2020-01-01","description":"Date record was last updated"},"number_previous_keepers":{"type":"integer","example":1,"description":"The number of previous keepers."},"date_of_last_keeper_change":{"type":"string","example":"2020-01-01","description":"The date of last keeper change."}}}},"colour_changes_qty":{"type":"integer","example":1,"description":"The colour change quantity"},"colour_data_items":{"type":"array","items":{"properties":{"date_last_updated":{"type":"string","example":"2020-01-01","description":"Date record was last updated"},"number_previous_colours":{"type":"integer","example":1,"description":"The number of previous colours"},"date_of_last_colour_change":{"type":"string","example":"2020-01-01","description":"Date of last colour change"},"last_colour":{"type":"string","example":"BLUE","description":"The vehicle's last colour"}}}},"finance_data_qty":{"type":"integer","example":1,"description":"The finance data quantity."},"finance_data_items":{"type":"array","items":{"properties":{"date_last_updated":{"type":"string","example":"2020-01-01","description":"Date record was last updated"},"finance_start_date":{"type":"string","example":"2020-01-01","description":"The date finance agreement starts."},"finance_term_months":{"type":"integer","example":12,"description":"The term of finance agreement in months."},"finance_type":{"type":"string","example":"HIRE PURCHASE","description":"The finance type."},"finance_company":{"type":"string","example":"A FINANCE CO","description":"The finance company."},"finance_company_contact_number":{"type":"string","example":"01234 567891","description":"The finance company contact number."},"finance_agreement_number":{"type":"integer","example":1234567,"description":"The finance agreement number."},"financed_vehicle_desc":{"type":"string","example":"NISSAN QASHQAI ACENTA","description":"The financed vehicle."}}}},"cherished_data_qty":{"type":"integer","example":1,"description":"The cherished data quantity."},"cherished_data_items":{"type":"array","items":{"properties":{"cherished_plate_transfer_date":{"type":"string","example":"2020-01-01","description":"The date record was last updated."},"previous_vehicle_registration_mark":{"type":"string","example":"AB21ABC","description":"The previous registration mark."},"date_of_receipt":{"type":"string","example":"2020-01-01","description":"The recorded date of transfer at DVLA."},"transfer_type":{"type":"string","example":"Marker","description":"Transfer type"},"current_vehicle_registration_mark":{"type":"string","example":"AB21ABC","description":"Current vehicle registration mark"}}}},"condition_data_qty":{"type":"integer","example":1,"description":"The condition data quantity."},"condition_data_items":{"type":"array","items":{"properties":{"date_last_updated":{"type":"string","example":"2020-01-01","description":"Date record was last updated"},"date_of_loss":{"type":"string","example":"2020-01-01","description":"The date of loss."},"vehicle_status":{"type":"string","example":"VEHICLE HAS BEEN STOLEN","description":"The vehicle status."},"theft_indictor_literal":{"type":"string","example":"STOLEN","description":"The theft indicator."},"date_of_miaftr_entry":{"type":"string","example":"2020-01-01","description":"The MIAFTR entry date."},"insurer_name":{"type":"string","example":"EXAMPLE INSURANCE CO","description":"The insurer's name."},"insurer_contact_number":{"type":"string","example":"01234 567891","description":"The insurer's contact number."},"insurer_claim_number":{"type":"string","example":"EXAMPLE","description":"The insurer's claim number."},"loss_type":{"type":"string","example":"T","description":"The flag to indicate type of loss for old insurance motor claims."},"insurer_make":{"type":"string","example":"NISS","description":"The insurer's manufacturer description."},"insurer_model":{"type":"string","example":"QAS","description":"The insurer's model description."},"insurer_code":{"type":"string","example":"1234","description":"The insurer's code."},"insurer_branch":{"type":"integer","example":12345,"description":"The insurer's branch number."},"theft_indicator":{"type":"string","example":"Y","description":"The theft indicator."},"date_removed":{"type":"string","example":"2020-01-01","description":"The date the condition was removed."}}}},"stolen_vehicle_data_qty":{"type":"integer","example":1,"description":"The stolen vehicle data quantity."},"stolen_vehicle_data_items":{"type":"array","items":{"properties":{"date_last_updated":{"type":"string","example":"2020-01-01","description":"Date record was last updated"},"date_reported":{"type":"string","example":"2020-01-01","description":"The date vehicle was reported as stolen."},"is_stolen":{"type":"boolean","example":true,"description":"Is the vehicle stolen"},"police_force":{"type":"string","example":"COUNTY POLICE FORCE","description":"The investigating police force."},"police_force_contact_number":{"type":"string","example":"01234 567891","description":"The investigating police force contact number."}}}},"high_risk_data_qty":{"type":"integer","example":1,"description":"The high risk data quantity."},"high_risk_data_items":{"type":"array","items":{"properties":{"date_last_updated":{"type":"string","example":"2020-01-01","description":"Date record was last updated"},"date_of_interest":{"type":"string","example":"2020-01-01","description":"The date vehicle was marked as high risk."},"registration_period":{"type":"integer","example":12,"description":"The registration period in months."},"high_risk_type":{"type":"string","example":"AT RISK","description":"The high risk type."},"extra_information":{"type":"string","example":"Additional information relating to high risk","description":"The additional information relating to high risk."},"company_name":{"type":"string","example":"A FINANCE CO","description":"The company holding an interest in the vehicle."},"company_contact_number":{"type":"string","example":"01234 567891","description":"The company contact number."},"company_contact_reference":{"type":"string","example":"Reference","description":"The company contact reference."}}}},"previous_search_qty":{"type":"integer","example":1,"description":"The previous search quantity."},"previous_search_items":{"type":"array","items":{"properties":{"date_of_search":{"type":"string","example":"2021-08-14","description":"The date of the last search."},"time_of_search":{"type":"string","example":"10:56:18","description":"The time of search (hh:mm:ss)"},"business_type_searching":{"type":"string","example":"MOTOR TRADE & OTHER","description":"The business type"}}}},"indemnity_months":{"type":"integer","example":12,"description":"The indemnity period in months for any data guarantee purchased as part of the check"},"indemnity_gbp":{"type":"integer","example":10000,"description":"The indemnity amount in GBP for any data guarantee purchased as part of the check"}}},"error":{"type":"string","example":"If there is an error the message would go here","description":"Details of what went wrong with the api call"}}}}}}},"security":[{"x-api-key":[]}]}},"/experian/autocheck-40k-guarantee/v3":{"get":{"tags":["Experian"],"operationId":"experian_autocheck-40k-guarantee","summary":"AutoCheck 40k Guarantee","description":"This vehicle history check endpoint returns all the expected data associated withe Experian's AutoCheck service but also includes a data guarantee should incorrect data be returned. The check includes basic vehicle information, VRM, VIN, vehicle description, date of first registration, colour and CO2 emission. The number of gears, doors, seats, and transmission type are also returned. In addition, MVRIS codes, weight and power data, along with stolen, scrapped and imported/exported status are also included. By requesting both the VRM and VIN, a check will be completed to confirm a matching pair within the DVLA data.","parameters":[{"name":"vehicle_registration_mark","in":"query","description":"Vehicle registration number","required":true,"schema":{"type":"string"}},{"name":"vehicle_identification_number","in":"query","description":"Vehicle identification number","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"description":"Whether the api call was successful"},"result":{"type":"object","properties":{"date_last_updated":{"type":"string","example":"2020-01-01","description":"Date record was last updated"},"vehicle_registration_mark":{"type":"string","example":"AB21ABC","description":"Vehicle registration number"},"does_vehicle_identification_number_match":{"type":"boolean","example":true,"description":"Does the supplied vehicle_registration_mark and vehicle_identifcation input parameters match"},"dvla_manufacturer_desc":{"type":"string","example":"NISSAN","description":"DVLA manufacturer description"},"dvla_model_desc":{"type":"string","example":"QASHQAI ACENTA PREMIUM DCI","description":"DVLA model description"},"dvla_fuel_desc":{"type":"string","example":"DIESEL","description":"DVLA fuel description"},"dvla_body_desc":{"type":"string","example":"5 DOOR HATCHBACK","description":"DVLA body description"},"dvla_doorplan_code":{"type":"integer","example":12,"description":"DVLA door plan code"},"dvla_transmission_code":{"type":"string","example":"M","description":"DVLA transmission code"},"dvla_transmission_desc":{"type":"string","example":"MANUAL 6 GEARS","description":"DVLA transmission description"},"number_gears":{"type":"integer","example":6,"description":"Number of gears"},"mvris_manufacturer_code":{"type":"string","example":"A1","description":"MVRIS manufacturer code"},"mvris_model_code":{"type":"string","example":"ABC","description":"MVRIS model code"},"dvla_dtp_manufacturer_code":{"type":"string","example":"AB","description":"DVLA DTP manufacturer code"},"dvla_dtp_model_code":{"type":"integer","example":123,"description":"DVLA DTP model code"},"number_seats":{"type":"integer","example":5,"description":"Number of seats"},"dvla_wheelplan":{"type":"string","example":"2 AXLE RIGID BODY","description":"DVLA wheelplan code where available"},"registration_date":{"type":"string","example":"2020-01-01","description":"Date the vehicle was first registered in the UK"},"manufactured_year":{"type":"integer","example":2020,"description":"Year of manufacturer"},"vehicle_identification_number":{"type":"string","example":"ABCDE123456F78910","description":"The vehicle identification number."},"first_registration_date":{"type":"string","example":"2020-01-01","description":"Date of first registration"},"used_before_first_registration":{"type":"boolean","example":true,"description":"Vehicle was used before DVLA/DLNI first registration"},"co2_gkm":{"type":"integer","example":123,"description":"CO2 in g/km"},"engine_capacity_cc":{"type":"integer","example":1234,"description":"Engine capacity in cc"},"engine_number":{"type":"string","example":"A12345678","description":"Vehicle engine number"},"is_scrapped":{"type":"boolean","example":true,"description":"Has the vehicle been scrapped."},"scrapped_date":{"type":"string","example":"2020-01-01","description":"The date the vehicle was scrapped."},"is_exported":{"type":"boolean","example":true,"description":"Vehicle is exported"},"exported_date":{"type":"string","example":"2020-01-01","description":"Date vehicle was exported"},"is_imported":{"type":"boolean","example":true,"description":"Vehicle is imported"},"is_non_eu_import":{"type":"boolean","example":true,"description":"Vehicle is non-eu import"},"prior_gb_vrm":{"type":"string","example":"AB21ABC","description":"Previous GB vehicle registration mark"},"prior_ni_vrm":{"type":"string","example":"ABC1234","description":"Previous NI vehicle registration mark"},"colour":{"type":"string","example":"RED","description":"Exterior colour of vehicle"},"maximum_permissable_mass_kg":{"type":"integer","example":1234,"description":"Maximum permissable mass in kg"},"power_weight_ratio_kw_kg":{"type":"number","example":0.1234,"description":"Power to weight ratio kw per kg"},"min_kerbweight_kg":{"type":"integer","example":1234,"description":"Minimum kerbweight in kg"},"gross_vehicleweight_kg":{"type":"integer","example":1234,"description":"Gross vehicle weight in kg"},"max_netpower_kw":{"type":"integer","example":12,"description":"Maximum net power in kw"},"max_braked_towing_weight_kg":{"type":"integer","example":1234,"description":"Maximum braked towing weight in kg"},"max_unbraked_towing_weight_kg":{"type":"integer","example":123,"description":"Maximum unbraked towing weight in kg"},"stationary_soundlevel_db":{"type":"integer","example":12,"description":"Stationary sound level in decibels"},"stationary_soundlevel_rpm":{"type":"integer","example":1234,"description":"Stationary sound level rpm"},"driveby_soundlevel_db":{"type":"integer","example":12,"description":"Driveby soundlevel in db"},"v5c_data_qty":{"type":"integer","example":1,"description":"The v5c quantity"},"v5c_data_items":{"type":"array","items":{"properties":{"date_v5c_issued":{"type":"string","example":"2020-01-01","description":"The date the v5 was issued"}}}},"vehicle_identity_check_qty":{"type":"integer","example":1,"description":"The vehicle identity check quantity"},"vehicle_identity_check_items":{"type":"array","items":{"properties":{"date_of_vehicle_identity_check":{"type":"string","example":"2020-01-01","description":"Date of (previous) vehicle identity check(s)"},"result_of_vehicle_identity_check":{"type":"string","example":"Pass","description":"Result of vehicle identity check"}}}},"keeper_changes_qty":{"type":"integer","example":1,"description":"The keeper change quantity."},"keeper_data_items":{"type":"array","items":{"properties":{"date_last_updated":{"type":"string","example":"2020-01-01","description":"Date record was last updated"},"number_previous_keepers":{"type":"integer","example":1,"description":"The number of previous keepers."},"date_of_last_keeper_change":{"type":"string","example":"2020-01-01","description":"The date of last keeper change."}}}},"colour_changes_qty":{"type":"integer","example":1,"description":"The colour change quantity"},"colour_data_items":{"type":"array","items":{"properties":{"date_last_updated":{"type":"string","example":"2020-01-01","description":"Date record was last updated"},"number_previous_colours":{"type":"integer","example":1,"description":"The number of previous colours"},"date_of_last_colour_change":{"type":"string","example":"2020-01-01","description":"Date of last colour change"},"last_colour":{"type":"string","example":"BLUE","description":"The vehicle's last colour"}}}},"finance_data_qty":{"type":"integer","example":1,"description":"The finance data quantity."},"finance_data_items":{"type":"array","items":{"properties":{"date_last_updated":{"type":"string","example":"2020-01-01","description":"Date record was last updated"},"finance_start_date":{"type":"string","example":"2020-01-01","description":"The date finance agreement starts."},"finance_term_months":{"type":"integer","example":12,"description":"The term of finance agreement in months."},"finance_type":{"type":"string","example":"HIRE PURCHASE","description":"The finance type."},"finance_company":{"type":"string","example":"A FINANCE CO","description":"The finance company."},"finance_company_contact_number":{"type":"string","example":"01234 567891","description":"The finance company contact number."},"finance_agreement_number":{"type":"integer","example":1234567,"description":"The finance agreement number."},"financed_vehicle_desc":{"type":"string","example":"NISSAN QASHQAI ACENTA","description":"The financed vehicle."}}}},"cherished_data_qty":{"type":"integer","example":1,"description":"The cherished data quantity."},"cherished_data_items":{"type":"array","items":{"properties":{"cherished_plate_transfer_date":{"type":"string","example":"2020-01-01","description":"The date record was last updated."},"previous_vehicle_registration_mark":{"type":"string","example":"AB21ABC","description":"The previous registration mark."},"date_of_receipt":{"type":"string","example":"2020-01-01","description":"The recorded date of transfer at DVLA."},"transfer_type":{"type":"string","example":"Marker","description":"Transfer type"},"current_vehicle_registration_mark":{"type":"string","example":"AB21ABC","description":"Current vehicle registration mark"}}}},"condition_data_qty":{"type":"integer","example":1,"description":"The condition data quantity."},"condition_data_items":{"type":"array","items":{"properties":{"date_last_updated":{"type":"string","example":"2020-01-01","description":"Date record was last updated"},"date_of_loss":{"type":"string","example":"2020-01-01","description":"The date of loss."},"vehicle_status":{"type":"string","example":"VEHICLE HAS BEEN STOLEN","description":"The vehicle status."},"theft_indictor_literal":{"type":"string","example":"STOLEN","description":"The theft indicator."},"date_of_miaftr_entry":{"type":"string","example":"2020-01-01","description":"The MIAFTR entry date."},"insurer_name":{"type":"string","example":"EXAMPLE INSURANCE CO","description":"The insurer's name."},"insurer_contact_number":{"type":"string","example":"01234 567891","description":"The insurer's contact number."},"insurer_claim_number":{"type":"string","example":"EXAMPLE","description":"The insurer's claim number."},"loss_type":{"type":"string","example":"T","description":"The flag to indicate type of loss for old insurance motor claims."},"insurer_make":{"type":"string","example":"NISS","description":"The insurer's manufacturer description."},"insurer_model":{"type":"string","example":"QAS","description":"The insurer's model description."},"insurer_code":{"type":"string","example":"1234","description":"The insurer's code."},"insurer_branch":{"type":"integer","example":12345,"description":"The insurer's branch number."},"theft_indicator":{"type":"string","example":"Y","description":"The theft indicator."},"date_removed":{"type":"string","example":"2020-01-01","description":"The date the condition was removed."}}}},"stolen_vehicle_data_qty":{"type":"integer","example":1,"description":"The stolen vehicle data quantity."},"stolen_vehicle_data_items":{"type":"array","items":{"properties":{"date_last_updated":{"type":"string","example":"2020-01-01","description":"Date record was last updated"},"date_reported":{"type":"string","example":"2020-01-01","description":"The date vehicle was reported as stolen."},"is_stolen":{"type":"boolean","example":true,"description":"Is the vehicle stolen"},"police_force":{"type":"string","example":"COUNTY POLICE FORCE","description":"The investigating police force."},"police_force_contact_number":{"type":"string","example":"01234 567891","description":"The investigating police force contact number."}}}},"high_risk_data_qty":{"type":"integer","example":1,"description":"The high risk data quantity."},"high_risk_data_items":{"type":"array","items":{"properties":{"date_last_updated":{"type":"string","example":"2020-01-01","description":"Date record was last updated"},"date_of_interest":{"type":"string","example":"2020-01-01","description":"The date vehicle was marked as high risk."},"registration_period":{"type":"integer","example":12,"description":"The registration period in months."},"high_risk_type":{"type":"string","example":"AT RISK","description":"The high risk type."},"extra_information":{"type":"string","example":"Additional information relating to high risk","description":"The additional information relating to high risk."},"company_name":{"type":"string","example":"A FINANCE CO","description":"The company holding an interest in the vehicle."},"company_contact_number":{"type":"string","example":"01234 567891","description":"The company contact number."},"company_contact_reference":{"type":"string","example":"Reference","description":"The company contact reference."}}}},"previous_search_qty":{"type":"integer","example":1,"description":"The previous search quantity."},"previous_search_items":{"type":"array","items":{"properties":{"date_of_search":{"type":"string","example":"2021-08-14","description":"The date of the last search."},"time_of_search":{"type":"string","example":"10:56:18","description":"The time of search (hh:mm:ss)"},"business_type_searching":{"type":"string","example":"MOTOR TRADE & OTHER","description":"The business type"}}}},"indemnity_months":{"type":"integer","example":12,"description":"The indemnity period in months for any data guarantee purchased as part of the check"},"indemnity_gbp":{"type":"integer","example":10000,"description":"The indemnity amount in GBP for any data guarantee purchased as part of the check"}}},"error":{"type":"string","example":"If there is an error the message would go here","description":"Details of what went wrong with the api call"}}}}}}},"security":[{"x-api-key":[]}]}},"/experian/autocheck-50k-guarantee/v3":{"get":{"tags":["Experian"],"operationId":"experian_autocheck-50k-guarantee","summary":"AutoCheck 50k Guarantee","description":"This vehicle history check endpoint returns all the expected data associated withe Experian's AutoCheck service but also includes a data guarantee should incorrect data be returned. The check includes basic vehicle information, VRM, VIN, vehicle description, date of first registration, colour and CO2 emission. The number of gears, doors, seats, and transmission type are also returned. In addition, MVRIS codes, weight and power data, along with stolen, scrapped and imported/exported status are also included. By requesting both the VRM and VIN, a check will be completed to confirm a matching pair within the DVLA data.","parameters":[{"name":"vehicle_registration_mark","in":"query","description":"Vehicle registration number","required":true,"schema":{"type":"string"}},{"name":"vehicle_identification_number","in":"query","description":"Vehicle identification number","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"description":"Whether the api call was successful"},"result":{"type":"object","properties":{"date_last_updated":{"type":"string","example":"2020-01-01","description":"Date record was last updated"},"vehicle_registration_mark":{"type":"string","example":"AB21ABC","description":"Vehicle registration number"},"does_vehicle_identification_number_match":{"type":"boolean","example":true,"description":"Does the supplied vehicle_registration_mark and vehicle_identifcation input parameters match"},"dvla_manufacturer_desc":{"type":"string","example":"NISSAN","description":"DVLA manufacturer description"},"dvla_model_desc":{"type":"string","example":"QASHQAI ACENTA PREMIUM DCI","description":"DVLA model description"},"dvla_fuel_desc":{"type":"string","example":"DIESEL","description":"DVLA fuel description"},"dvla_body_desc":{"type":"string","example":"5 DOOR HATCHBACK","description":"DVLA body description"},"dvla_doorplan_code":{"type":"integer","example":12,"description":"DVLA door plan code"},"dvla_transmission_code":{"type":"string","example":"M","description":"DVLA transmission code"},"dvla_transmission_desc":{"type":"string","example":"MANUAL 6 GEARS","description":"DVLA transmission description"},"number_gears":{"type":"integer","example":6,"description":"Number of gears"},"mvris_manufacturer_code":{"type":"string","example":"A1","description":"MVRIS manufacturer code"},"mvris_model_code":{"type":"string","example":"ABC","description":"MVRIS model code"},"dvla_dtp_manufacturer_code":{"type":"string","example":"AB","description":"DVLA DTP manufacturer code"},"dvla_dtp_model_code":{"type":"integer","example":123,"description":"DVLA DTP model code"},"number_seats":{"type":"integer","example":5,"description":"Number of seats"},"dvla_wheelplan":{"type":"string","example":"2 AXLE RIGID BODY","description":"DVLA wheelplan code where available"},"registration_date":{"type":"string","example":"2020-01-01","description":"Date the vehicle was first registered in the UK"},"manufactured_year":{"type":"integer","example":2020,"description":"Year of manufacturer"},"vehicle_identification_number":{"type":"string","example":"ABCDE123456F78910","description":"The vehicle identification number."},"first_registration_date":{"type":"string","example":"2020-01-01","description":"Date of first registration"},"used_before_first_registration":{"type":"boolean","example":true,"description":"Vehicle was used before DVLA/DLNI first registration"},"co2_gkm":{"type":"integer","example":123,"description":"CO2 in g/km"},"engine_capacity_cc":{"type":"integer","example":1234,"description":"Engine capacity in cc"},"engine_number":{"type":"string","example":"A12345678","description":"Vehicle engine number"},"is_scrapped":{"type":"boolean","example":true,"description":"Has the vehicle been scrapped."},"scrapped_date":{"type":"string","example":"2020-01-01","description":"The date the vehicle was scrapped."},"is_exported":{"type":"boolean","example":true,"description":"Vehicle is exported"},"exported_date":{"type":"string","example":"2020-01-01","description":"Date vehicle was exported"},"is_imported":{"type":"boolean","example":true,"description":"Vehicle is imported"},"is_non_eu_import":{"type":"boolean","example":true,"description":"Vehicle is non-eu import"},"prior_gb_vrm":{"type":"string","example":"AB21ABC","description":"Previous GB vehicle registration mark"},"prior_ni_vrm":{"type":"string","example":"ABC1234","description":"Previous NI vehicle registration mark"},"colour":{"type":"string","example":"RED","description":"Exterior colour of vehicle"},"maximum_permissable_mass_kg":{"type":"integer","example":1234,"description":"Maximum permissable mass in kg"},"power_weight_ratio_kw_kg":{"type":"number","example":0.1234,"description":"Power to weight ratio kw per kg"},"min_kerbweight_kg":{"type":"integer","example":1234,"description":"Minimum kerbweight in kg"},"gross_vehicleweight_kg":{"type":"integer","example":1234,"description":"Gross vehicle weight in kg"},"max_netpower_kw":{"type":"integer","example":12,"description":"Maximum net power in kw"},"max_braked_towing_weight_kg":{"type":"integer","example":1234,"description":"Maximum braked towing weight in kg"},"max_unbraked_towing_weight_kg":{"type":"integer","example":123,"description":"Maximum unbraked towing weight in kg"},"stationary_soundlevel_db":{"type":"integer","example":12,"description":"Stationary sound level in decibels"},"stationary_soundlevel_rpm":{"type":"integer","example":1234,"description":"Stationary sound level rpm"},"driveby_soundlevel_db":{"type":"integer","example":12,"description":"Driveby soundlevel in db"},"v5c_data_qty":{"type":"integer","example":1,"description":"The v5c quantity"},"v5c_data_items":{"type":"array","items":{"properties":{"date_v5c_issued":{"type":"string","example":"2020-01-01","description":"The date the v5 was issued"}}}},"vehicle_identity_check_qty":{"type":"integer","example":1,"description":"The vehicle identity check quantity"},"vehicle_identity_check_items":{"type":"array","items":{"properties":{"date_of_vehicle_identity_check":{"type":"string","example":"2020-01-01","description":"Date of (previous) vehicle identity check(s)"},"result_of_vehicle_identity_check":{"type":"string","example":"Pass","description":"Result of vehicle identity check"}}}},"keeper_changes_qty":{"type":"integer","example":1,"description":"The keeper change quantity."},"keeper_data_items":{"type":"array","items":{"properties":{"date_last_updated":{"type":"string","example":"2020-01-01","description":"Date record was last updated"},"number_previous_keepers":{"type":"integer","example":1,"description":"The number of previous keepers."},"date_of_last_keeper_change":{"type":"string","example":"2020-01-01","description":"The date of last keeper change."}}}},"colour_changes_qty":{"type":"integer","example":1,"description":"The colour change quantity"},"colour_data_items":{"type":"array","items":{"properties":{"date_last_updated":{"type":"string","example":"2020-01-01","description":"Date record was last updated"},"number_previous_colours":{"type":"integer","example":1,"description":"The number of previous colours"},"date_of_last_colour_change":{"type":"string","example":"2020-01-01","description":"Date of last colour change"},"last_colour":{"type":"string","example":"BLUE","description":"The vehicle's last colour"}}}},"finance_data_qty":{"type":"integer","example":1,"description":"The finance data quantity."},"finance_data_items":{"type":"array","items":{"properties":{"date_last_updated":{"type":"string","example":"2020-01-01","description":"Date record was last updated"},"finance_start_date":{"type":"string","example":"2020-01-01","description":"The date finance agreement starts."},"finance_term_months":{"type":"integer","example":12,"description":"The term of finance agreement in months."},"finance_type":{"type":"string","example":"HIRE PURCHASE","description":"The finance type."},"finance_company":{"type":"string","example":"A FINANCE CO","description":"The finance company."},"finance_company_contact_number":{"type":"string","example":"01234 567891","description":"The finance company contact number."},"finance_agreement_number":{"type":"integer","example":1234567,"description":"The finance agreement number."},"financed_vehicle_desc":{"type":"string","example":"NISSAN QASHQAI ACENTA","description":"The financed vehicle."}}}},"cherished_data_qty":{"type":"integer","example":1,"description":"The cherished data quantity."},"cherished_data_items":{"type":"array","items":{"properties":{"cherished_plate_transfer_date":{"type":"string","example":"2020-01-01","description":"The date record was last updated."},"previous_vehicle_registration_mark":{"type":"string","example":"AB21ABC","description":"The previous registration mark."},"date_of_receipt":{"type":"string","example":"2020-01-01","description":"The recorded date of transfer at DVLA."},"transfer_type":{"type":"string","example":"Marker","description":"Transfer type"},"current_vehicle_registration_mark":{"type":"string","example":"AB21ABC","description":"Current vehicle registration mark"}}}},"condition_data_qty":{"type":"integer","example":1,"description":"The condition data quantity."},"condition_data_items":{"type":"array","items":{"properties":{"date_last_updated":{"type":"string","example":"2020-01-01","description":"Date record was last updated"},"date_of_loss":{"type":"string","example":"2020-01-01","description":"The date of loss."},"vehicle_status":{"type":"string","example":"VEHICLE HAS BEEN STOLEN","description":"The vehicle status."},"theft_indictor_literal":{"type":"string","example":"STOLEN","description":"The theft indicator."},"date_of_miaftr_entry":{"type":"string","example":"2020-01-01","description":"The MIAFTR entry date."},"insurer_name":{"type":"string","example":"EXAMPLE INSURANCE CO","description":"The insurer's name."},"insurer_contact_number":{"type":"string","example":"01234 567891","description":"The insurer's contact number."},"insurer_claim_number":{"type":"string","example":"EXAMPLE","description":"The insurer's claim number."},"loss_type":{"type":"string","example":"T","description":"The flag to indicate type of loss for old insurance motor claims."},"insurer_make":{"type":"string","example":"NISS","description":"The insurer's manufacturer description."},"insurer_model":{"type":"string","example":"QAS","description":"The insurer's model description."},"insurer_code":{"type":"string","example":"1234","description":"The insurer's code."},"insurer_branch":{"type":"integer","example":12345,"description":"The insurer's branch number."},"theft_indicator":{"type":"string","example":"Y","description":"The theft indicator."},"date_removed":{"type":"string","example":"2020-01-01","description":"The date the condition was removed."}}}},"stolen_vehicle_data_qty":{"type":"integer","example":1,"description":"The stolen vehicle data quantity."},"stolen_vehicle_data_items":{"type":"array","items":{"properties":{"date_last_updated":{"type":"string","example":"2020-01-01","description":"Date record was last updated"},"date_reported":{"type":"string","example":"2020-01-01","description":"The date vehicle was reported as stolen."},"is_stolen":{"type":"boolean","example":true,"description":"Is the vehicle stolen"},"police_force":{"type":"string","example":"COUNTY POLICE FORCE","description":"The investigating police force."},"police_force_contact_number":{"type":"string","example":"01234 567891","description":"The investigating police force contact number."}}}},"high_risk_data_qty":{"type":"integer","example":1,"description":"The high risk data quantity."},"high_risk_data_items":{"type":"array","items":{"properties":{"date_last_updated":{"type":"string","example":"2020-01-01","description":"Date record was last updated"},"date_of_interest":{"type":"string","example":"2020-01-01","description":"The date vehicle was marked as high risk."},"registration_period":{"type":"integer","example":12,"description":"The registration period in months."},"high_risk_type":{"type":"string","example":"AT RISK","description":"The high risk type."},"extra_information":{"type":"string","example":"Additional information relating to high risk","description":"The additional information relating to high risk."},"company_name":{"type":"string","example":"A FINANCE CO","description":"The company holding an interest in the vehicle."},"company_contact_number":{"type":"string","example":"01234 567891","description":"The company contact number."},"company_contact_reference":{"type":"string","example":"Reference","description":"The company contact reference."}}}},"previous_search_qty":{"type":"integer","example":1,"description":"The previous search quantity."},"previous_search_items":{"type":"array","items":{"properties":{"date_of_search":{"type":"string","example":"2021-08-14","description":"The date of the last search."},"time_of_search":{"type":"string","example":"10:56:18","description":"The time of search (hh:mm:ss)"},"business_type_searching":{"type":"string","example":"MOTOR TRADE & OTHER","description":"The business type"}}}},"indemnity_months":{"type":"integer","example":12,"description":"The indemnity period in months for any data guarantee purchased as part of the check"},"indemnity_gbp":{"type":"integer","example":10000,"description":"The indemnity amount in GBP for any data guarantee purchased as part of the check"}}},"error":{"type":"string","example":"If there is an error the message would go here","description":"Details of what went wrong with the api call"}}}}}}},"security":[{"x-api-key":[]}]}},"/experian/colourchanges/v3":{"get":{"tags":["Experian"],"operationId":"experian_colourchanges","summary":"Colour Changes","description":"This endpoint returns the total number of colour changes, the previous colour of vehicle, the date of last colour change and the number of changes. Data is repeated for multiple colour changes. Basic vehicle information is also returned and by requesting both the VRM and VIN, a check will be completed to confirm a matching pair within the DVLA data.","parameters":[{"name":"vehicle_registration_mark","in":"query","description":"Vehicle registration number","required":true,"schema":{"type":"string"}},{"name":"vehicle_identification_number","in":"query","description":"Vehicle identification number","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"description":"Whether the api call was successful"},"result":{"type":"object","properties":{"date_last_updated":{"type":"string","example":"2020-01-01","description":"Date record was last updated"},"vehicle_registration_mark":{"type":"string","example":"AB21ABC","description":"Vehicle registration number"},"does_vehicle_identification_number_match":{"type":"boolean","example":true,"description":"Does the supplied vehicle_registration_mark and vehicle_identifcation input parameters match"},"dvla_manufacturer_desc":{"type":"string","example":"NISSAN","description":"DVLA manufacturer description"},"dvla_model_desc":{"type":"string","example":"QASHQAI ACENTA PREMIUM DCI","description":"DVLA model description"},"dvla_fuel_desc":{"type":"string","example":"DIESEL","description":"DVLA fuel description"},"dvla_body_desc":{"type":"string","example":"5 DOOR HATCHBACK","description":"DVLA body description"},"dvla_doorplan_code":{"type":"integer","example":12,"description":"DVLA door plan code"},"dvla_transmission_code":{"type":"string","example":"M","description":"DVLA transmission code"},"dvla_transmission_desc":{"type":"string","example":"MANUAL 6 GEARS","description":"DVLA transmission description"},"number_gears":{"type":"integer","example":6,"description":"Number of gears"},"mvris_manufacturer_code":{"type":"string","example":"A1","description":"MVRIS manufacturer code"},"mvris_model_code":{"type":"string","example":"ABC","description":"MVRIS model code"},"dvla_dtp_manufacturer_code":{"type":"string","example":"AB","description":"DVLA DTP manufacturer code"},"dvla_dtp_model_code":{"type":"integer","example":123,"description":"DVLA DTP model code"},"number_seats":{"type":"integer","example":5,"description":"Number of seats"},"dvla_wheelplan":{"type":"string","example":"2 AXLE RIGID BODY","description":"DVLA wheelplan code where available"},"registration_date":{"type":"string","example":"2020-01-01","description":"Date the vehicle was first registered in the UK"},"manufactured_year":{"type":"integer","example":2020,"description":"Year of manufacturer"},"vehicle_identification_number":{"type":"string","example":"ABCDE123456F78910","description":"The vehicle identification number."},"first_registration_date":{"type":"string","example":"2020-01-01","description":"Date of first registration"},"used_before_first_registration":{"type":"boolean","example":true,"description":"Vehicle was used before DVLA/DLNI first registration"},"co2_gkm":{"type":"integer","example":123,"description":"CO2 in g/km"},"engine_capacity_cc":{"type":"integer","example":1234,"description":"Engine capacity in cc"},"engine_number":{"type":"string","example":"A12345678","description":"Vehicle engine number"},"is_scrapped":{"type":"boolean","example":true,"description":"Has the vehicle been scrapped."},"scrapped_date":{"type":"string","example":"2020-01-01","description":"The date the vehicle was scrapped."},"is_exported":{"type":"boolean","example":true,"description":"Vehicle is exported"},"exported_date":{"type":"string","example":"2020-01-01","description":"Date vehicle was exported"},"is_imported":{"type":"boolean","example":true,"description":"Vehicle is imported"},"imported_date":{"type":"string","example":"2020-01-01","description":"Date vehicle was imported"},"is_non_eu_import":{"type":"boolean","example":true,"description":"Vehicle is non-eu import"},"prior_gb_vrm":{"type":"string","example":"AB21ABC","description":"Previous GB vehicle registration mark"},"prior_ni_vrm":{"type":"string","example":"ABC1234","description":"Previous NI vehicle registration mark"},"colour":{"type":"string","example":"RED","description":"Exterior colour of vehicle"},"maximum_permissable_mass_kg":{"type":"integer","example":1234,"description":"Maximum permissable mass in kg"},"power_weight_ratio_kw_kg":{"type":"number","example":0.1234,"description":"Power to weight ratio kw per kg"},"min_kerbweight_kg":{"type":"integer","example":1234,"description":"Minimum kerbweight in kg"},"gross_vehicleweight_kg":{"type":"integer","example":1234,"description":"Gross vehicle weight in kg"},"max_netpower_kw":{"type":"integer","example":12,"description":"Maximum net power in kw"},"max_braked_towing_weight_kg":{"type":"integer","example":1234,"description":"Maximum braked towing weight in kg"},"max_unbraked_towing_weight_kg":{"type":"integer","example":123,"description":"Maximum unbraked towing weight in kg"},"stationary_soundlevel_db":{"type":"integer","example":12,"description":"Stationary sound level in decibels"},"stationary_soundlevel_rpm":{"type":"integer","example":1234,"description":"Stationary sound level rpm"},"driveby_soundlevel_db":{"type":"integer","example":12,"description":"Driveby soundlevel in db"},"v5c_data_qty":{"type":"integer","example":1,"description":"The v5c quantity"},"v5c_data_items":{"type":"array","items":{"properties":{"date_v5c_issued":{"type":"string","example":"2020-01-01","description":"The date the v5 was issued"}}}},"vehicle_identity_check_qty":{"type":"integer","example":1,"description":"The vehicle identity check quantity"},"vehicle_identity_check_items":{"type":"array","items":{"properties":{"date_of_vehicle_identity_check":{"type":"string","example":"2020-01-01","description":"Date of (previous) vehicle identity check(s)"},"result_of_vehicle_identity_check":{"type":"string","example":"Pass","description":"Result of vehicle identity check"}}}},"colour_changes_qty":{"type":"integer","example":1,"description":"The colour change quantity"},"colour_data_items":{"type":"array","items":{"properties":{"date_last_updated":{"type":"string","example":"2020-01-01","description":"Date record was last updated"},"number_previous_colours":{"type":"integer","example":1,"description":"The number of previous colours"},"date_of_last_colour_change":{"type":"string","example":"2020-01-01","description":"Date of last colour change"},"last_colour":{"type":"string","example":"BLACK","description":"The vehicle's last colour"}}}}}},"error":{"type":"string","example":"If there is an error the message would go here","description":"Details of what went wrong with the api call"}}}}}}},"security":[{"x-api-key":[]}]}},"/experian/conditioncheck/v3":{"get":{"tags":["Experian"],"operationId":"experian_conditioncheck","summary":"Condition Check","description":"This endpoint returns Motor Insurers Anti-Fraud and Theft Register (MIAFTR) data including date and type of loss, damage category and insurer details. Basic vehicle information is also returned and by requesting both the VRM and VIN, a check will be completed to confirm a matching pair within the DVLA data.","parameters":[{"name":"vehicle_registration_mark","in":"query","description":"Vehicle registration number","required":true,"schema":{"type":"string"}},{"name":"vehicle_identification_number","in":"query","description":"Vehicle identification number","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"description":"Whether the api call was successful"},"result":{"type":"object","properties":{"date_last_updated":{"type":"string","example":"2020-01-01","description":"Date record was last updated"},"vehicle_registration_mark":{"type":"string","example":"AB21ABC","description":"Vehicle registration number"},"does_vehicle_identification_number_match":{"type":"boolean","example":true,"description":"Does the supplied vehicle_registration_mark and vehicle_identifcation input parameters match"},"dvla_manufacturer_desc":{"type":"string","example":"NISSAN","description":"DVLA manufacturer description"},"dvla_model_desc":{"type":"string","example":"QASHQAI ACENTA PREMIUM DCI","description":"DVLA model description"},"dvla_fuel_desc":{"type":"string","example":"DIESEL","description":"DVLA fuel description"},"dvla_body_desc":{"type":"string","example":"5 DOOR HATCHBACK","description":"DVLA body description"},"dvla_doorplan_code":{"type":"integer","example":12,"description":"DVLA door plan code"},"dvla_transmission_code":{"type":"string","example":"M","description":"DVLA transmission code"},"dvla_transmission_desc":{"type":"string","example":"MANUAL 6 GEARS","description":"DVLA transmission description"},"number_gears":{"type":"integer","example":6,"description":"Number of gears"},"mvris_manufacturer_code":{"type":"string","example":"A1","description":"MVRIS manufacturer code"},"mvris_model_code":{"type":"string","example":"ABC","description":"MVRIS model code"},"dvla_dtp_manufacturer_code":{"type":"string","example":"AB","description":"DVLA DTP manufacturer code"},"dvla_dtp_model_code":{"type":"integer","example":123,"description":"DVLA DTP model code"},"number_seats":{"type":"integer","example":5,"description":"Number of seats"},"dvla_wheelplan":{"type":"string","example":"2 AXLE RIGID BODY","description":"DVLA wheelplan code where available"},"registration_date":{"type":"string","example":"2020-01-01","description":"Date the vehicle was first registered in the UK"},"manufactured_year":{"type":"integer","example":2020,"description":"Year of manufacturer"},"vehicle_identification_number":{"type":"string","example":"ABCDE123456F78910","description":"The vehicle identification number."},"first_registration_date":{"type":"string","example":"2020-01-01","description":"Date of first registration"},"used_before_first_registration":{"type":"boolean","example":true,"description":"Vehicle was used before DVLA/DLNI first registration"},"co2_gkm":{"type":"integer","example":123,"description":"CO2 in g/km"},"engine_capacity_cc":{"type":"integer","example":1234,"description":"Engine capacity in cc"},"engine_number":{"type":"string","example":"A12345678","description":"Vehicle engine number"},"is_scrapped":{"type":"boolean","example":true,"description":"Has the vehicle been scrapped."},"scrapped_date":{"type":"string","example":"2020-01-01","description":"The date the vehicle was scrapped."},"is_exported":{"type":"boolean","example":true,"description":"Vehicle is exported"},"exported_date":{"type":"string","example":"2020-01-01","description":"Date vehicle was exported"},"is_imported":{"type":"boolean","example":true,"description":"Vehicle is imported"},"is_non_eu_import":{"type":"boolean","example":true,"description":"Vehicle is non-eu import"},"prior_gb_vrm":{"type":"string","example":"AB21ABC","description":"Previous GB vehicle registration mark"},"prior_ni_vrm":{"type":"string","example":"ABC1234","description":"Previous NI vehicle registration mark"},"colour":{"type":"string","example":"RED","description":"Exterior colour of vehicle"},"maximum_permissable_mass_kg":{"type":"integer","example":1234,"description":"Maximum permissable mass in kg"},"power_weight_ratio_kw_kg":{"type":"number","example":0.1234,"description":"Power to weight ratio kw per kg"},"min_kerbweight_kg":{"type":"integer","example":1234,"description":"Minimum kerbweight in kg"},"gross_vehicleweight_kg":{"type":"integer","example":1234,"description":"Gross vehicle weight in kg"},"max_netpower_kw":{"type":"integer","example":12,"description":"Maximum net power in kw"},"max_braked_towing_weight_kg":{"type":"integer","example":1234,"description":"Maximum braked towing weight in kg"},"max_unbraked_towing_weight_kg":{"type":"integer","example":123,"description":"Maximum unbraked towing weight in kg"},"stationary_soundlevel_db":{"type":"integer","example":12,"description":"Stationary sound level in decibels"},"stationary_soundlevel_rpm":{"type":"integer","example":1234,"description":"Stationary sound level rpm"},"driveby_soundlevel_db":{"type":"integer","example":12,"description":"Driveby soundlevel in db"},"v5c_data_qty":{"type":"integer","example":1,"description":"The v5c quantity"},"v5c_data_items":{"type":"array","items":{"properties":{"date_v5c_issued":{"type":"string","example":"2020-01-01","description":"The date the v5 was issued"}}}},"vehicle_identity_check_qty":{"type":"integer","example":1,"description":"The vehicle identity check quantity"},"vehicle_identity_check_items":{"type":"array","items":{"properties":{"date_of_vehicle_identity_check":{"type":"string","example":"2020-01-01","description":"Date of (previous) vehicle identity check(s)"},"result_of_vehicle_identity_check":{"type":"string","example":"Pass","description":"Result of vehicle identity check"}}}},"condition_data_qty":{"type":"integer","example":1,"description":"The condition data quantity."},"condition_data_items":{"type":"array","items":{"properties":{"date_last_updated":{"type":"string","example":"2020-01-01","description":"Date record was last updated"},"date_of_loss":{"type":"string","example":"2020-01-01","description":"The date of loss."},"vehicle_status":{"type":"string","example":"VEHICLE HAS BEEN STOLEN","description":"The vehicle status."},"theft_indictor_literal":{"type":"string","example":"STOLEN","description":"The theft indicator."},"date_of_miaftr_entry":{"type":"string","example":"2020-01-01","description":"The MIAFTR entry date."},"insurer_name":{"type":"string","example":"EXAMPLE INSURANCE CO","description":"The insurer's name."},"insurer_contact_number":{"type":"string","example":"01234 567891","description":"The insurer's contact number."},"insurer_claim_number":{"type":"string","example":"EXAMPLE","description":"The insurer's claim number."},"loss_type":{"type":"string","example":"T","description":"The flag to indicate type of loss for old insurance motor claims."},"insurer_make":{"type":"string","example":"NISS","description":"The insurer's manufacturer description."},"insurer_model":{"type":"string","example":"QAS","description":"The insurer's model description."},"insurer_code":{"type":"string","example":"1234","description":"The insurer's code."},"insurer_branch":{"type":"integer","example":12345,"description":"The insurer's branch number."},"theft_indicator":{"type":"string","example":"Y","description":"The theft indicator."},"date_removed":{"type":"string","example":"2020-01-01","description":"The date the condition was removed."}}}}}},"error":{"type":"string","example":"If there is an error the message would go here","description":"Details of what went wrong with the api call"}}}}}}},"security":[{"x-api-key":[]}]}},"/experian/financerecords/v3":{"get":{"tags":["Experian"],"operationId":"experian_financerecords","summary":"Finance Check","description":"This endpoint returns the total number of finance agreements, the dates and terms associated to the agreements, the finance company details including finance agreement number and the vehicle description. Data is repeated for multiple finance agreements. Basic vehicle information is also returned and by requesting both the VRM and VIN, a check will be completed to confirm a matching pair within the DVLA data.","parameters":[{"name":"vehicle_registration_mark","in":"query","description":"Vehicle registration number","required":true,"schema":{"type":"string"}},{"name":"vehicle_identification_number","in":"query","description":"Vehicle identification number","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"description":"Whether the api call was successful"},"result":{"type":"object","properties":{"date_last_updated":{"type":"string","example":"2020-01-01","description":"Date record was last updated"},"vehicle_registration_mark":{"type":"string","example":"AB21ABC","description":"Vehicle registration number"},"does_vehicle_identification_number_match":{"type":"boolean","example":true,"description":"Does the supplied vehicle_registration_mark and vehicle_identifcation input parameters match"},"dvla_manufacturer_desc":{"type":"string","example":"NISSAN","description":"DVLA manufacturer description"},"dvla_model_desc":{"type":"string","example":"QASHQAI ACENTA PREMIUM DCI","description":"DVLA model description"},"dvla_fuel_desc":{"type":"string","example":"DIESEL","description":"DVLA fuel description"},"dvla_body_desc":{"type":"string","example":"5 DOOR HATCHBACK","description":"DVLA body description"},"dvla_doorplan_code":{"type":"integer","example":12,"description":"DVLA door plan code"},"dvla_transmission_code":{"type":"string","example":"M","description":"DVLA transmission code"},"dvla_transmission_desc":{"type":"string","example":"MANUAL 6 GEARS","description":"DVLA transmission description"},"number_gears":{"type":"integer","example":6,"description":"Number of gears"},"mvris_manufacturer_code":{"type":"string","example":"A1","description":"MVRIS manufacturer code"},"mvris_model_code":{"type":"string","example":"ABC","description":"MVRIS model code"},"dvla_dtp_manufacturer_code":{"type":"string","example":"AB","description":"DVLA DTP manufacturer code"},"dvla_dtp_model_code":{"type":"integer","example":123,"description":"DVLA DTP model code"},"number_seats":{"type":"integer","example":5,"description":"Number of seats"},"dvla_wheelplan":{"type":"string","example":"2 AXLE RIGID BODY","description":"DVLA wheelplan code where available"},"registration_date":{"type":"string","example":"2020-01-01","description":"Date the vehicle was first registered in the UK"},"manufactured_year":{"type":"integer","example":2020,"description":"Year of manufacturer"},"vehicle_identification_number":{"type":"string","example":"ABCDE123456F78910","description":"The vehicle identification number."},"first_registration_date":{"type":"string","example":"2020-01-01","description":"Date of first registration"},"used_before_first_registration":{"type":"boolean","example":true,"description":"Vehicle was used before DVLA/DLNI first registration"},"co2_gkm":{"type":"integer","example":123,"description":"CO2 in g/km"},"engine_capacity_cc":{"type":"integer","example":1234,"description":"Engine capacity in cc"},"engine_number":{"type":"string","example":"A12345678","description":"Vehicle engine number"},"is_scrapped":{"type":"boolean","example":true,"description":"Has the vehicle been scrapped."},"scrapped_date":{"type":"string","example":"2020-01-01","description":"The date the vehicle was scrapped."},"is_exported":{"type":"boolean","example":true,"description":"Vehicle is exported"},"exported_date":{"type":"string","example":"2020-01-01","description":"Date vehicle was exported"},"is_imported":{"type":"boolean","example":true,"description":"Vehicle is imported"},"is_non_eu_import":{"type":"boolean","example":true,"description":"Vehicle is non-eu import"},"prior_gb_vrm":{"type":"string","example":"AB21ABC","description":"Previous GB vehicle registration mark"},"prior_ni_vrm":{"type":"string","example":"ABC1234","description":"Previous NI vehicle registration mark"},"colour":{"type":"string","example":"RED","description":"Exterior colour of vehicle"},"maximum_permissable_mass_kg":{"type":"integer","example":1234,"description":"Maximum permissable mass in kg"},"power_weight_ratio_kw_kg":{"type":"number","example":0.1234,"description":"Power to weight ratio kw per kg"},"min_kerbweight_kg":{"type":"integer","example":1234,"description":"Minimum kerbweight in kg"},"gross_vehicleweight_kg":{"type":"integer","example":1234,"description":"Gross vehicle weight in kg"},"max_netpower_kw":{"type":"integer","example":12,"description":"Maximum net power in kw"},"max_braked_towing_weight_kg":{"type":"integer","example":1234,"description":"Maximum braked towing weight in kg"},"max_unbraked_towing_weight_kg":{"type":"integer","example":123,"description":"Maximum unbraked towing weight in kg"},"stationary_soundlevel_db":{"type":"integer","example":12,"description":"Stationary sound level in decibels"},"stationary_soundlevel_rpm":{"type":"integer","example":1234,"description":"Stationary sound level rpm"},"driveby_soundlevel_db":{"type":"integer","example":12,"description":"Driveby soundlevel in db"},"v5c_data_qty":{"type":"integer","example":1,"description":"The v5c quantity"},"v5c_data_items":{"type":"array","items":{"properties":{"date_v5c_issued":{"type":"string","example":"2020-01-01","description":"The date the v5 was issued"}}}},"vehicle_identity_check_qty":{"type":"integer","example":1,"description":"The vehicle identity check quantity"},"vehicle_identity_check_items":{"type":"array","items":{"properties":{"date_of_vehicle_identity_check":{"type":"string","example":"2020-01-01","description":"Date of (previous) vehicle identity check(s)"},"result_of_vehicle_identity_check":{"type":"string","example":"Pass","description":"Result of vehicle identity check"}}}},"finance_data_qty":{"type":"integer","example":1,"description":"The finance data quantity."},"finance_data_items":{"type":"array","items":{"properties":{"date_last_updated":{"type":"string","example":"2020-01-01","description":"Date record was last updated"},"finance_start_date":{"type":"string","example":"2020-01-01","description":"The date finance agreement starts."},"finance_term_months":{"type":"integer","example":12,"description":"The term of finance agreement in months."},"finance_type":{"type":"string","example":"HIRE PURCHASE","description":"The finance type."},"finance_company":{"type":"string","example":"A FINANCE CO","description":"The finance company."},"finance_company_contact_number":{"type":"string","example":"01234 567891","description":"The finance company contact number."},"finance_agreement_number":{"type":"integer","example":1234567,"description":"The finance agreement number."},"financed_vehicle_desc":{"type":"string","example":"NISSAN QASHQAI ACENTA","description":"The financed vehicle."}}}}}},"error":{"type":"string","example":"If there is an error the message would go here","description":"Details of what went wrong with the api call"}}}}}}},"security":[{"x-api-key":[]}]}},"/experian/highriskcheck/v3":{"get":{"tags":["Experian"],"operationId":"experian_highriskcheck","summary":"High Risk Check","description":"This endpoint returns the total number of high risk records, the date the vehicle was marked as high risk, high risk type and the date the record was last updated. Data is repeated for multiple high risk records. Basic vehicle information is also returned and by requesting both the VRM and VIN, a check will be completed to confirm a matching pair within the DVLA data.","parameters":[{"name":"vehicle_registration_mark","in":"query","description":"Vehicle registration number","required":true,"schema":{"type":"string"}},{"name":"vehicle_identification_number","in":"query","description":"Vehicle identification number","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"description":"Whether the api call was successful"},"result":{"type":"object","properties":{"date_last_updated":{"type":"string","example":"2020-01-01","description":"Date record was last updated"},"vehicle_registration_mark":{"type":"string","example":"AB21ABC","description":"Vehicle registration number"},"does_vehicle_identification_number_match":{"type":"boolean","example":true,"description":"Does the supplied vehicle_registration_mark and vehicle_identifcation input parameters match"},"dvla_manufacturer_desc":{"type":"string","example":"NISSAN","description":"DVLA manufacturer description"},"dvla_model_desc":{"type":"string","example":"QASHQAI ACENTA PREMIUM DCI","description":"DVLA model description"},"dvla_fuel_desc":{"type":"string","example":"DIESEL","description":"DVLA fuel description"},"dvla_body_desc":{"type":"string","example":"5 DOOR HATCHBACK","description":"DVLA body description"},"dvla_doorplan_code":{"type":"integer","example":12,"description":"DVLA door plan code"},"dvla_transmission_code":{"type":"string","example":"M","description":"DVLA transmission code"},"dvla_transmission_desc":{"type":"string","example":"MANUAL 6 GEARS","description":"DVLA transmission description"},"number_gears":{"type":"integer","example":6,"description":"Number of gears"},"mvris_manufacturer_code":{"type":"string","example":"A1","description":"MVRIS manufacturer code"},"mvris_model_code":{"type":"string","example":"ABC","description":"MVRIS model code"},"dvla_dtp_manufacturer_code":{"type":"string","example":"AB","description":"DVLA DTP manufacturer code"},"dvla_dtp_model_code":{"type":"integer","example":123,"description":"DVLA DTP model code"},"number_seats":{"type":"integer","example":5,"description":"Number of seats"},"dvla_wheelplan":{"type":"string","example":"2 AXLE RIGID BODY","description":"DVLA wheelplan code where available"},"registration_date":{"type":"string","example":"2020-01-01","description":"Date the vehicle was first registered in the UK"},"manufactured_year":{"type":"integer","example":2020,"description":"Year of manufacturer"},"vehicle_identification_number":{"type":"string","example":"ABCDE123456F78910","description":"The vehicle identification number."},"first_registration_date":{"type":"string","example":"2020-01-01","description":"Date of first registration"},"used_before_first_registration":{"type":"boolean","example":true,"description":"Vehicle was used before DVLA/DLNI first registration"},"co2_gkm":{"type":"integer","example":123,"description":"CO2 in g/km"},"engine_capacity_cc":{"type":"integer","example":1234,"description":"Engine capacity in cc"},"engine_number":{"type":"string","example":"A12345678","description":"Vehicle engine number"},"is_scrapped":{"type":"boolean","example":true,"description":"Has the vehicle been scrapped."},"scrapped_date":{"type":"string","example":"2020-01-01","description":"The date the vehicle was scrapped."},"is_exported":{"type":"boolean","example":true,"description":"Vehicle is exported"},"exported_date":{"type":"string","example":"2020-01-01","description":"Date vehicle was exported"},"is_imported":{"type":"boolean","example":true,"description":"Vehicle is imported"},"imported_date":{"type":"string","example":"2020-01-01","description":"Date vehicle was imported"},"is_non_eu_import":{"type":"boolean","example":true,"description":"Vehicle is non-eu import"},"prior_gb_vrm":{"type":"string","example":"AB21ABC","description":"Previous GB vehicle registration mark"},"prior_ni_vrm":{"type":"string","example":"ABC1234","description":"Previous NI vehicle registration mark"},"colour":{"type":"string","example":"RED","description":"Exterior colour of vehicle"},"maximum_permissable_mass_kg":{"type":"integer","example":1234,"description":"Maximum permissable mass in kg"},"power_weight_ratio_kw_kg":{"type":"number","example":0.1234,"description":"Power to weight ratio kw per kg"},"min_kerbweight_kg":{"type":"integer","example":1234,"description":"Minimum kerbweight in kg"},"gross_vehicleweight_kg":{"type":"integer","example":1234,"description":"Gross vehicle weight in kg"},"max_netpower_kw":{"type":"integer","example":12,"description":"Maximum net power in kw"},"max_braked_towing_weight_kg":{"type":"integer","example":1234,"description":"Maximum braked towing weight in kg"},"max_unbraked_towing_weight_kg":{"type":"integer","example":123,"description":"Maximum unbraked towing weight in kg"},"stationary_soundlevel_db":{"type":"integer","example":12,"description":"Stationary sound level in decibels"},"stationary_soundlevel_rpm":{"type":"integer","example":1234,"description":"Stationary sound level rpm"},"driveby_soundlevel_db":{"type":"integer","example":12,"description":"Driveby soundlevel in db"},"v5c_data_qty":{"type":"integer","example":1,"description":"The v5c quantity"},"v5c_data_items":{"type":"array","items":{"properties":{"date_v5c_issued":{"type":"string","example":"2020-01-01","description":"The date the v5 was issued"}}}},"vehicle_identity_check_qty":{"type":"integer","example":1,"description":"The vehicle identity check quantity"},"vehicle_identity_check_items":{"type":"array","items":{"properties":{"date_of_vehicle_identity_check":{"type":"string","example":"2020-01-01","description":"Date of (previous) vehicle identity check(s)"}}}},"high_risk_data_qty":{"type":"integer","example":1,"description":"The high risk data quantity."},"high_risk_data_items":{"type":"array","items":{"properties":{"date_last_updated":{"type":"string","example":"2020-01-01","description":"Date record was last updated"},"date_of_interest":{"type":"string","example":"2020-01-01","description":"The date vehicle was marked as high risk."},"registration_period":{"type":"integer","example":12,"description":"The registration period in months."},"high_risk_type":{"type":"string","example":"AT RISK","description":"The high risk type."},"extra_information":{"type":"string","example":"Additional information relating to high risk","description":"The additional information relating to high risk."},"company_name":{"type":"string","example":"A FINANCE CO","description":"The company holding an interest in the vehicle."},"company_contact_number":{"type":"string","example":"01234 567891","description":"The company contact number."},"company_contact_reference":{"type":"string","example":"Reference","description":"The company contact reference."}}}}}},"error":{"type":"string","example":"If there is an error the message would go here","description":"Details of what went wrong with the api call"}}}}}}},"security":[{"x-api-key":[]}]}},"/experian/keeperchanges/v3":{"get":{"tags":["Experian"],"operationId":"experian_keeperchanges","summary":"Keeper Change Check","description":"This endpoint returns the total number of keeper changes, number of previous keepers, previous keeper disposal date and date of last update. Data is repeated for multiple keeper changes. Basic vehicle information is also returned and by requesting both the VRM and VIN, a check will be completed to confirm a matching pair within the DVLA data.","parameters":[{"name":"vehicle_registration_mark","in":"query","description":"Vehicle registration number","required":true,"schema":{"type":"string"}},{"name":"vehicle_identification_number","in":"query","description":"Vehicle identification number","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"description":"Whether the api call was successful"},"result":{"type":"object","properties":{"date_last_updated":{"type":"string","example":"2020-01-01","description":"Date record was last updated"},"vehicle_registration_mark":{"type":"string","example":"AB21ABC","description":"Vehicle registration number"},"does_vehicle_identification_number_match":{"type":"boolean","example":true,"description":"Does the supplied vehicle_registration_mark and vehicle_identifcation input parameters match"},"dvla_manufacturer_desc":{"type":"string","example":"NISSAN","description":"DVLA manufacturer description"},"dvla_model_desc":{"type":"string","example":"QASHQAI ACENTA PREMIUM DCI","description":"DVLA model description"},"dvla_fuel_desc":{"type":"string","example":"DIESEL","description":"DVLA fuel description"},"dvla_body_desc":{"type":"string","example":"5 DOOR HATCHBACK","description":"DVLA body description"},"dvla_doorplan_code":{"type":"integer","example":12,"description":"DVLA door plan code"},"dvla_transmission_code":{"type":"string","example":"M","description":"DVLA transmission code"},"dvla_transmission_desc":{"type":"string","example":"MANUAL 6 GEARS","description":"DVLA transmission description"},"number_gears":{"type":"integer","example":6,"description":"Number of gears"},"mvris_manufacturer_code":{"type":"string","example":"A1","description":"MVRIS manufacturer code"},"mvris_model_code":{"type":"string","example":"ABC","description":"MVRIS model code"},"dvla_dtp_manufacturer_code":{"type":"string","example":"AB","description":"DVLA DTP manufacturer code"},"dvla_dtp_model_code":{"type":"integer","example":123,"description":"DVLA DTP model code"},"number_seats":{"type":"integer","example":5,"description":"Number of seats"},"dvla_wheelplan":{"type":"string","example":"2 AXLE RIGID BODY","description":"DVLA wheelplan code where available"},"registration_date":{"type":"string","example":"2020-01-01","description":"Date the vehicle was first registered in the UK"},"manufactured_year":{"type":"integer","example":2020,"description":"Year of manufacturer"},"vehicle_identification_number":{"type":"string","example":"ABCDE123456F78910","description":"The vehicle identification number."},"first_registration_date":{"type":"string","example":"2020-01-01","description":"Date of first registration"},"used_before_first_registration":{"type":"boolean","example":true,"description":"Vehicle was used before DVLA/DLNI first registration"},"co2_gkm":{"type":"integer","example":123,"description":"CO2 in g/km"},"engine_capacity_cc":{"type":"integer","example":1234,"description":"Engine capacity in cc"},"engine_number":{"type":"string","example":"A12345678","description":"Vehicle engine number"},"is_scrapped":{"type":"boolean","example":true,"description":"Has the vehicle been scrapped."},"scrapped_date":{"type":"string","example":"2020-01-01","description":"The date the vehicle was scrapped."},"is_exported":{"type":"boolean","example":true,"description":"Vehicle is exported"},"exported_date":{"type":"string","example":"2020-01-01","description":"Date vehicle was exported"},"is_imported":{"type":"boolean","example":true,"description":"Vehicle is imported"},"imported_date":{"type":"string","example":"2020-01-01","description":"Date vehicle was imported"},"is_non_eu_import":{"type":"boolean","example":true,"description":"Vehicle is non-eu import"},"prior_gb_vrm":{"type":"string","example":"AB21ABC","description":"Previous GB vehicle registration mark"},"prior_ni_vrm":{"type":"string","example":"ABC1234","description":"Previous NI vehicle registration mark"},"colour":{"type":"string","example":"RED","description":"Exterior colour of vehicle"},"maximum_permissable_mass_kg":{"type":"integer","example":1234,"description":"Maximum permissable mass in kg"},"power_weight_ratio_kw_kg":{"type":"number","example":0.1234,"description":"Power to weight ratio kw per kg"},"min_kerbweight_kg":{"type":"integer","example":1234,"description":"Minimum kerbweight in kg"},"gross_vehicleweight_kg":{"type":"integer","example":1234,"description":"Gross vehicle weight in kg"},"max_netpower_kw":{"type":"integer","example":12,"description":"Maximum net power in kw"},"max_braked_towing_weight_kg":{"type":"integer","example":1234,"description":"Maximum braked towing weight in kg"},"max_unbraked_towing_weight_kg":{"type":"integer","example":123,"description":"Maximum unbraked towing weight in kg"},"stationary_soundlevel_db":{"type":"integer","example":12,"description":"Stationary sound level in decibels"},"stationary_soundlevel_rpm":{"type":"integer","example":1234,"description":"Stationary sound level rpm"},"driveby_soundlevel_db":{"type":"integer","example":12,"description":"Driveby soundlevel in db"},"v5c_data_qty":{"type":"integer","example":1,"description":"The v5c quantity"},"v5c_data_items":{"type":"array","items":{"properties":{"date_v5c_issued":{"type":"string","example":"2020-01-01","description":"The date the v5 was issued"}}}},"vehicle_identity_check_qty":{"type":"integer","example":1,"description":"The vehicle identity check quantity"},"vehicle_identity_check_items":{"type":"array","items":{"properties":{"date_of_vehicle_identity_check":{"type":"string","example":"2020-01-01","description":"Date of (previous) vehicle identity check(s)"},"result_of_vehicle_identity_check":{"type":"string","example":"Pass","description":"Result of vehicle identity check"}}}},"keeper_changes_qty":{"type":"integer","example":1,"description":"The keeper change quantity."},"keeper_data_items":{"type":"array","items":{"properties":{"date_last_updated":{"type":"string","example":"2020-01-01","description":"Date record was last updated"},"number_previous_keepers":{"type":"integer","example":1,"description":"The number of previous keepers."},"date_of_last_keeper_change":{"type":"string","example":"2020-01-01","description":"The date of last keeper change."}}}}}},"error":{"type":"string","example":"If there is an error the message would go here","description":"Details of what went wrong with the api call"}}}}}}},"security":[{"x-api-key":[]}]}},"/experian/mileagecheck/v3":{"get":{"tags":["Experian"],"operationId":"experian_mileagecheck","summary":"Mileage Check","description":"This endpoint returns vehicle mileage observations, including the date, odometer reading and source. A basic vehicle identity check is included and by submitting both the VRM and VIN, a check will be completed to confirm a matching pair within the DVLA data.","parameters":[{"name":"vehicle_registration_mark","in":"query","description":"Vehicle registration number","required":true,"schema":{"type":"string"}},{"name":"vehicle_identification_number","in":"query","description":"Vehicle identification number","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"description":"Whether the api call was successful"},"result":{"type":"object","properties":{"date_last_updated":{"type":"string","example":"2020-01-01","description":"Date record was last updated"},"vehicle_registration_mark":{"type":"string","example":"AB21ABC","description":"Vehicle registration number"},"does_vehicle_identification_number_match":{"type":"boolean","example":true,"description":"Does the supplied vehicle_registration_mark and vehicle_identifcation input parameters match"},"dvla_manufacturer_desc":{"type":"string","example":"NISSAN","description":"DVLA manufacturer description"},"dvla_model_desc":{"type":"string","example":"QASHQAI ACENTA PREMIUM DCI","description":"DVLA model description"},"dvla_fuel_desc":{"type":"string","example":"DIESEL","description":"DVLA fuel description"},"dvla_body_desc":{"type":"string","example":"5 DOOR HATCHBACK","description":"DVLA body description"},"dvla_doorplan_code":{"type":"integer","example":12,"description":"DVLA door plan code"},"dvla_transmission_code":{"type":"string","example":"M","description":"DVLA transmission code"},"dvla_transmission_desc":{"type":"string","example":"MANUAL 6 GEARS","description":"DVLA transmission description"},"number_gears":{"type":"integer","example":6,"description":"Number of gears"},"mvris_manufacturer_code":{"type":"string","example":"A1","description":"MVRIS manufacturer code"},"mvris_model_code":{"type":"string","example":"ABC","description":"MVRIS model code"},"dvla_dtp_manufacturer_code":{"type":"string","example":"AB","description":"DVLA DTP manufacturer code"},"dvla_dtp_model_code":{"type":"integer","example":123,"description":"DVLA DTP model code"},"number_seats":{"type":"integer","example":5,"description":"Number of seats"},"dvla_wheelplan":{"type":"string","example":"2 AXLE RIGID BODY","description":"DVLA wheelplan code where available"},"registration_date":{"type":"string","example":"2020-01-01","description":"Date the vehicle was first registered in the UK"},"manufactured_year":{"type":"integer","example":2020,"description":"Year of manufacturer"},"vehicle_identification_number":{"type":"string","example":"ABCDE123456F78910","description":"The vehicle identification number."},"first_registration_date":{"type":"string","example":"2020-01-01","description":"Date of first registration"},"used_before_first_registration":{"type":"boolean","example":true,"description":"Vehicle was used before DVLA/DLNI first registration"},"co2_gkm":{"type":"integer","example":123,"description":"CO2 in g/km"},"engine_capacity_cc":{"type":"integer","example":1234,"description":"Engine capacity in cc"},"engine_number":{"type":"string","example":"A12345678","description":"Vehicle engine number"},"is_scrapped":{"type":"boolean","example":true,"description":"Has the vehicle been scrapped."},"scrapped_date":{"type":"string","example":"2020-01-01","description":"The date the vehicle was scrapped."},"is_exported":{"type":"boolean","example":true,"description":"Vehicle is exported"},"exported_date":{"type":"string","example":"2020-01-01","description":"Date vehicle was exported"},"is_imported":{"type":"boolean","example":true,"description":"Vehicle is imported"},"imported_date":{"type":"string","example":"2020-01-01","description":"Date vehicle was imported"},"is_non_eu_import":{"type":"boolean","example":true,"description":"Vehicle is non-eu import"},"prior_gb_vrm":{"type":"string","example":"AB21ABC","description":"Previous GB vehicle registration mark"},"prior_ni_vrm":{"type":"string","example":"ABC1234","description":"Previous NI vehicle registration mark"},"colour":{"type":"string","example":"RED","description":"Exterior colour of vehicle"},"maximum_permissable_mass_kg":{"type":"integer","example":1234,"description":"Maximum permissable mass in kg"},"power_weight_ratio_kw_kg":{"type":"number","example":0.1234,"description":"Power to weight ratio kw per kg"},"min_kerbweight_kg":{"type":"integer","example":1234,"description":"Minimum kerbweight in kg"},"gross_vehicleweight_kg":{"type":"integer","example":1234,"description":"Gross vehicle weight in kg"},"max_netpower_kw":{"type":"integer","example":12,"description":"Maximum net power in kw"},"max_braked_towing_weight_kg":{"type":"integer","example":1234,"description":"Maximum braked towing weight in kg"},"max_unbraked_towing_weight_kg":{"type":"integer","example":123,"description":"Maximum unbraked towing weight in kg"},"stationary_soundlevel_db":{"type":"integer","example":12,"description":"Stationary sound level in decibels"},"stationary_soundlevel_rpm":{"type":"integer","example":1234,"description":"Stationary sound level rpm"},"driveby_soundlevel_db":{"type":"integer","example":12,"description":"Driveby soundlevel in db"},"v5c_data_qty":{"type":"integer","example":1,"description":"The v5c quantity"},"v5c_data_items":{"type":"array","items":{"properties":{"date_v5c_issued":{"type":"string","example":"2020-01-01","description":"The date the v5 was issued"}}}},"vehicle_identity_check_qty":{"type":"integer","example":1,"description":"The vehicle identity check quantity"},"vehicle_identity_check_items":{"type":"array","items":{"properties":{"date_of_vehicle_identity_check":{"type":"string","example":"2020-01-01","description":"Date of (previous) vehicle identity check(s)"},"result_of_vehicle_identity_check":{"type":"string","example":"Pass","description":"Result of vehicle identity check"}}}},"mileage_data_qty":{"type":"integer","example":1,"description":"The mileage data quantity"},"mileage_data_items":{"type":"array","items":{"properties":{"source_of_mileage_observation":{"type":"string","example":"DVLA","description":"The source of the mileage observation"},"sub_source_of_mileage_observation":{"type":"string","example":"DVLA","description":"The sub-source of the mileage observation"},"date_of_mileage_observation":{"type":"string","example":"2020-01-01","description":"The date of the mileage observation"},"mileage_observed":{"type":"integer","example":12345,"description":"Vehicle odometer reading"}}}}}},"error":{"type":"string","example":"If there is an error the message would go here","description":"Details of what went wrong with the api call"}}}}}}},"security":[{"x-api-key":[]}]}},"/experian/platechanges/v3":{"get":{"tags":["Experian"],"operationId":"experian_platechanges","summary":"Plate Check","description":"This endpoint returns the total number of plate changes, the date of plate the change, previous VRM, date of receipt, transfer type and current VRM. Data is repeated for multiple plate changes. Basic vehicle information is also returned and by requesting both the VRM and VIN, a check will be completed to confirm a matching pair within the DVLA data.","parameters":[{"name":"vehicle_registration_mark","in":"query","description":"Vehicle registration number","required":true,"schema":{"type":"string"}},{"name":"vehicle_identification_number","in":"query","description":"Vehicle identification number","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"description":"Whether the api call was successful"},"result":{"type":"object","properties":{"date_last_updated":{"type":"string","example":"2020-01-01","description":"Date record was last updated"},"vehicle_registration_mark":{"type":"string","example":"AB21ABC","description":"Vehicle registration number"},"does_vehicle_identification_number_match":{"type":"boolean","example":true,"description":"Does the supplied vehicle_registration_mark and vehicle_identifcation input parameters match"},"dvla_manufacturer_desc":{"type":"string","example":"NISSAN","description":"DVLA manufacturer description"},"dvla_model_desc":{"type":"string","example":"QASHQAI ACENTA PREMIUM DCI","description":"DVLA model description"},"dvla_fuel_desc":{"type":"string","example":"DIESEL","description":"DVLA fuel description"},"dvla_body_desc":{"type":"string","example":"5 DOOR HATCHBACK","description":"DVLA body description"},"dvla_doorplan_code":{"type":"integer","example":12,"description":"DVLA door plan code"},"dvla_transmission_code":{"type":"string","example":"M","description":"DVLA transmission code"},"dvla_transmission_desc":{"type":"string","example":"MANUAL 6 GEARS","description":"DVLA transmission description"},"number_gears":{"type":"integer","example":6,"description":"Number of gears"},"mvris_manufacturer_code":{"type":"string","example":"A1","description":"MVRIS manufacturer code"},"mvris_model_code":{"type":"string","example":"ABC","description":"MVRIS model code"},"dvla_dtp_manufacturer_code":{"type":"string","example":"AB","description":"DVLA DTP manufacturer code"},"dvla_dtp_model_code":{"type":"integer","example":123,"description":"DVLA DTP model code"},"number_seats":{"type":"integer","example":5,"description":"Number of seats"},"dvla_wheelplan":{"type":"string","example":"2 AXLE RIGID BODY","description":"DVLA wheelplan code where available"},"registration_date":{"type":"string","example":"2020-01-01","description":"Date the vehicle was first registered in the UK"},"manufactured_year":{"type":"integer","example":2020,"description":"Year of manufacturer"},"vehicle_identification_number":{"type":"string","example":"ABCDE123456F78910","description":"The vehicle identification number."},"first_registration_date":{"type":"string","example":"2020-01-01","description":"Date of first registration"},"used_before_first_registration":{"type":"boolean","example":true,"description":"Vehicle was used before DVLA/DLNI first registration"},"co2_gkm":{"type":"integer","example":123,"description":"CO2 in g/km"},"engine_capacity_cc":{"type":"integer","example":1234,"description":"Engine capacity in cc"},"engine_number":{"type":"string","example":"A12345678","description":"Vehicle engine number"},"is_scrapped":{"type":"boolean","example":true,"description":"Has the vehicle been scrapped."},"scrapped_date":{"type":"string","example":"2020-01-01","description":"The date the vehicle was scrapped."},"is_exported":{"type":"boolean","example":true,"description":"Vehicle is exported"},"exported_date":{"type":"string","example":"2020-01-01","description":"Date vehicle was exported"},"is_imported":{"type":"boolean","example":true,"description":"Vehicle is imported"},"imported_date":{"type":"string","example":"2020-01-01","description":"Date vehicle was imported"},"is_non_eu_import":{"type":"boolean","example":true,"description":"Vehicle is non-eu import"},"prior_gb_vrm":{"type":"string","example":"AB21ABC","description":"Previous GB vehicle registration mark"},"prior_ni_vrm":{"type":"string","example":"ABC1234","description":"Previous NI vehicle registration mark"},"colour":{"type":"string","example":"RED","description":"Exterior colour of vehicle"},"maximum_permissable_mass_kg":{"type":"integer","example":1234,"description":"Maximum permissable mass in kg"},"power_weight_ratio_kw_kg":{"type":"number","example":0.1234,"description":"Power to weight ratio kw per kg"},"min_kerbweight_kg":{"type":"integer","example":1234,"description":"Minimum kerbweight in kg"},"gross_vehicleweight_kg":{"type":"integer","example":1234,"description":"Gross vehicle weight in kg"},"max_netpower_kw":{"type":"integer","example":12,"description":"Maximum net power in kw"},"max_braked_towing_weight_kg":{"type":"integer","example":1234,"description":"Maximum braked towing weight in kg"},"max_unbraked_towing_weight_kg":{"type":"integer","example":123,"description":"Maximum unbraked towing weight in kg"},"stationary_soundlevel_db":{"type":"integer","example":12,"description":"Stationary sound level in decibels"},"stationary_soundlevel_rpm":{"type":"integer","example":1234,"description":"Stationary sound level rpm"},"driveby_soundlevel_db":{"type":"integer","example":12,"description":"Driveby soundlevel in db"},"v5c_data_qty":{"type":"integer","example":1,"description":"The v5c quantity"},"v5c_data_items":{"type":"array","items":{"properties":{"date_v5c_issued":{"type":"string","example":"2020-01-01","description":"The date the v5 was issued"}}}},"vehicle_identity_check_qty":{"type":"integer","example":1,"description":"The vehicle identity check quantity"},"vehicle_identity_check_items":{"type":"array","items":{"properties":{"date_of_vehicle_identity_check":{"type":"string","example":"2020-01-01","description":"Date of (previous) vehicle identity check(s)"},"result_of_vehicle_identity_check":{"type":"string","example":"Pass","description":"Result of vehicle identity check"}}}},"cherished_data_qty":{"type":"integer","example":1,"description":"The cherished data quantity."},"cherished_data_items":{"type":"array","items":{"properties":{"cherished_plate_transfer_date":{"type":"string","example":"2020-01-01","description":"The date record was last updated."},"previous_vehicle_registration_mark":{"type":"string","example":"AB21ABC","description":"The previous registration mark."},"date_of_receipt":{"type":"string","example":"2020-01-01","description":"The recorded date of transfer at DVLA."},"transfer_type":{"type":"string","example":"Marker","description":"Transfer type"},"current_vehicle_registration_mark":{"type":"string","example":"AB21ABC","description":"Current vehicle registration mark"}}}}}},"error":{"type":"string","example":"If there is an error the message would go here","description":"Details of what went wrong with the api call"}}}}}}},"security":[{"x-api-key":[]}]}},"/experian/previoussearchcheck/v3":{"get":{"tags":["Experian"],"operationId":"experian_previoussearchcheck","summary":"Previous Searches","description":"This endpoint returns the total number of previous search records. The date, time and the type of business requesting the search is also returned. Data is repeated for multiple searches (up to 50 prior searches). Basic vehicle information is also returned and by requesting both the VRM and VIN, a check will be completed to confirm a matching pair within the DVLA data.","parameters":[{"name":"vehicle_registration_mark","in":"query","description":"Vehicle registration number","required":true,"schema":{"type":"string"}},{"name":"vehicle_identification_number","in":"query","description":"Vehicle identification number","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"description":"Whether the api call was successful"},"result":{"type":"object","properties":{"date_last_updated":{"type":"string","example":"2020-01-01","description":"Date record was last updated"},"vehicle_registration_mark":{"type":"string","example":"AB21ABC","description":"Vehicle registration number"},"does_vehicle_identification_number_match":{"type":"boolean","example":true,"description":"Does the supplied vehicle_registration_mark and vehicle_identifcation input parameters match"},"dvla_manufacturer_desc":{"type":"string","example":"NISSAN","description":"DVLA manufacturer description"},"dvla_model_desc":{"type":"string","example":"QASHQAI ACENTA PREMIUM DCI","description":"DVLA model description"},"dvla_fuel_desc":{"type":"string","example":"DIESEL","description":"DVLA fuel description"},"dvla_body_desc":{"type":"string","example":"5 DOOR HATCHBACK","description":"DVLA body description"},"dvla_doorplan_code":{"type":"integer","example":12,"description":"DVLA door plan code"},"dvla_transmission_code":{"type":"string","example":"M","description":"DVLA transmission code"},"dvla_transmission_desc":{"type":"string","example":"MANUAL 6 GEARS","description":"DVLA transmission description"},"number_gears":{"type":"integer","example":6,"description":"Number of gears"},"mvris_manufacturer_code":{"type":"string","example":"A1","description":"MVRIS manufacturer code"},"mvris_model_code":{"type":"string","example":"ABC","description":"MVRIS model code"},"dvla_dtp_manufacturer_code":{"type":"string","example":"AB","description":"DVLA DTP manufacturer code"},"dvla_dtp_model_code":{"type":"integer","example":123,"description":"DVLA DTP model code"},"number_seats":{"type":"integer","example":5,"description":"Number of seats"},"dvla_wheelplan":{"type":"string","example":"2 AXLE RIGID BODY","description":"DVLA wheelplan code where available"},"registration_date":{"type":"string","example":"2020-01-01","description":"Date the vehicle was first registered in the UK"},"manufactured_year":{"type":"integer","example":2020,"description":"Year of manufacturer"},"vehicle_identification_number":{"type":"string","example":"ABCDE123456F78910","description":"The vehicle identification number."},"first_registration_date":{"type":"string","example":"2020-01-01","description":"Date of first registration"},"used_before_first_registration":{"type":"boolean","example":true,"description":"Vehicle was used before DVLA/DLNI first registration"},"co2_gkm":{"type":"integer","example":123,"description":"CO2 in g/km"},"engine_capacity_cc":{"type":"integer","example":1234,"description":"Engine capacity in cc"},"engine_number":{"type":"string","example":"A12345678","description":"Vehicle engine number"},"is_scrapped":{"type":"boolean","example":true,"description":"Has the vehicle been scrapped."},"scrapped_date":{"type":"string","example":"2020-01-01","description":"The date the vehicle was scrapped."},"is_exported":{"type":"boolean","example":true,"description":"Vehicle is exported"},"exported_date":{"type":"string","example":"2020-01-01","description":"Date vehicle was exported"},"is_imported":{"type":"boolean","example":true,"description":"Vehicle is imported"},"imported_date":{"type":"string","example":"2020-01-01","description":"Date vehicle was imported"},"is_non_eu_import":{"type":"boolean","example":true,"description":"Vehicle is non-eu import"},"prior_gb_vrm":{"type":"string","example":"AB21ABC","description":"Previous GB vehicle registration mark"},"prior_ni_vrm":{"type":"string","example":"ABC1234","description":"Previous NI vehicle registration mark"},"colour":{"type":"string","example":"RED","description":"Exterior colour of vehicle"},"maximum_permissable_mass_kg":{"type":"integer","example":1234,"description":"Maximum permissable mass in kg"},"power_weight_ratio_kw_kg":{"type":"number","example":0.1234,"description":"Power to weight ratio kw per kg"},"min_kerbweight_kg":{"type":"integer","example":1234,"description":"Minimum kerbweight in kg"},"gross_vehicleweight_kg":{"type":"integer","example":1234,"description":"Gross vehicle weight in kg"},"max_netpower_kw":{"type":"integer","example":12,"description":"Maximum net power in kw"},"max_braked_towing_weight_kg":{"type":"integer","example":1234,"description":"Maximum braked towing weight in kg"},"max_unbraked_towing_weight_kg":{"type":"integer","example":123,"description":"Maximum unbraked towing weight in kg"},"stationary_soundlevel_db":{"type":"integer","example":12,"description":"Stationary sound level in decibels"},"stationary_soundlevel_rpm":{"type":"integer","example":1234,"description":"Stationary sound level rpm"},"driveby_soundlevel_db":{"type":"integer","example":12,"description":"Driveby soundlevel in db"},"v5c_data_qty":{"type":"integer","example":1,"description":"The v5c quantity"},"v5c_data_items":{"type":"array","items":{"properties":{"date_v5c_issued":{"type":"string","example":"2020-01-01","description":"The date the v5 was issued"}}}},"vehicle_identity_check_qty":{"type":"integer","example":1,"description":"The vehicle identity check quantity"},"vehicle_identity_check_items":{"type":"array","items":{"properties":{"date_of_vehicle_identity_check":{"type":"string","example":"2020-01-01","description":"Date of (previous) vehicle identity check(s)"},"result_of_vehicle_identity_check":{"type":"string","example":"Pass","description":"Result of vehicle identity check"}}}},"previous_search_qty":{"type":"integer","example":1,"description":"The previous search quantity."},"previous_search_items":{"type":"array","items":{"properties":{"date_of_search":{"type":"string","example":"2021-08-14","description":"The date of the last search."},"time_of_search":{"type":"string","example":"10:56:18","description":"The time of search (hh:mm:ss)"},"business_type_searching":{"type":"string","example":"MOTOR TRADE & OTHER","description":"The business type"}}}}}},"error":{"type":"string","example":"If there is an error the message would go here","description":"Details of what went wrong with the api call"}}}}}}},"security":[{"x-api-key":[]}]}},"/experian/stolenvehiclecheck/v3":{"get":{"tags":["Experian"],"operationId":"experian_stolenvehiclecheck","summary":"Stolen Check","description":"This endpoint returns a stolen vehicle check, the stolen status of the vehicle, the relevant police force and contact number, the date the vehicle was reported stolen and when the record was last updated. Basic vehicle information is also returned and by requesting both the VRM and VIN, a check will be completed to confirm a matching pair within the DVLA data.","parameters":[{"name":"vehicle_registration_mark","in":"query","description":"Vehicle registration number","required":true,"schema":{"type":"string"}},{"name":"vehicle_identification_number","in":"query","description":"Vehicle identification number","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"description":"Whether the api call was successful"},"result":{"type":"object","properties":{"date_last_updated":{"type":"string","example":"2020-01-01","description":"Date record was last updated"},"vehicle_registration_mark":{"type":"string","example":"AB21ABC","description":"Vehicle registration number"},"does_vehicle_identification_number_match":{"type":"boolean","example":true,"description":"Does the supplied vehicle_registration_mark and vehicle_identifcation input parameters match"},"dvla_manufacturer_desc":{"type":"string","example":"NISSAN","description":"DVLA manufacturer description"},"dvla_model_desc":{"type":"string","example":"QASHQAI ACENTA PREMIUM DCI","description":"DVLA model description"},"dvla_fuel_desc":{"type":"string","example":"DIESEL","description":"DVLA fuel description"},"dvla_body_desc":{"type":"string","example":"5 DOOR HATCHBACK","description":"DVLA body description"},"dvla_doorplan_code":{"type":"integer","example":12,"description":"DVLA door plan code"},"dvla_transmission_code":{"type":"string","example":"M","description":"DVLA transmission code"},"dvla_transmission_desc":{"type":"string","example":"MANUAL 6 GEARS","description":"DVLA transmission description"},"number_gears":{"type":"integer","example":6,"description":"Number of gears"},"mvris_manufacturer_code":{"type":"string","example":"A1","description":"MVRIS manufacturer code"},"mvris_model_code":{"type":"string","example":"ABC","description":"MVRIS model code"},"dvla_dtp_manufacturer_code":{"type":"string","example":"AB","description":"DVLA DTP manufacturer code"},"dvla_dtp_model_code":{"type":"integer","example":123,"description":"DVLA DTP model code"},"number_seats":{"type":"integer","example":5,"description":"Number of seats"},"dvla_wheelplan":{"type":"string","example":"2 AXLE RIGID BODY","description":"DVLA wheelplan code where available"},"registration_date":{"type":"string","example":"2020-01-01","description":"Date the vehicle was first registered in the UK"},"manufactured_year":{"type":"integer","example":2020,"description":"Year of manufacturer"},"vehicle_identification_number":{"type":"string","example":"ABCDE123456F78910","description":"The vehicle identification number."},"first_registration_date":{"type":"string","example":"2020-01-01","description":"Date of first registration"},"used_before_first_registration":{"type":"boolean","example":true,"description":"Vehicle was used before DVLA/DLNI first registration"},"co2_gkm":{"type":"integer","example":123,"description":"CO2 in g/km"},"engine_capacity_cc":{"type":"integer","example":1234,"description":"Engine capacity in cc"},"engine_number":{"type":"string","example":"A12345678","description":"Vehicle engine number"},"is_scrapped":{"type":"boolean","example":true,"description":"Has the vehicle been scrapped."},"scrapped_date":{"type":"string","example":"2020-01-01","description":"The date the vehicle was scrapped."},"is_exported":{"type":"boolean","example":true,"description":"Vehicle is exported"},"exported_date":{"type":"string","example":"2020-01-01","description":"Date vehicle was exported"},"is_imported":{"type":"boolean","example":true,"description":"Vehicle is imported"},"imported_date":{"type":"string","example":"2020-01-01","description":"Date vehicle was imported"},"is_non_eu_import":{"type":"boolean","example":true,"description":"Vehicle is non-eu import"},"prior_gb_vrm":{"type":"string","example":"AB21ABC","description":"Previous GB vehicle registration mark"},"prior_ni_vrm":{"type":"string","example":"ABC1234","description":"Previous NI vehicle registration mark"},"colour":{"type":"string","example":"RED","description":"Exterior colour of vehicle"},"maximum_permissable_mass_kg":{"type":"integer","example":1234,"description":"Maximum permissable mass in kg"},"power_weight_ratio_kw_kg":{"type":"number","example":0.1234,"description":"Power to weight ratio kw per kg"},"min_kerbweight_kg":{"type":"integer","example":1234,"description":"Minimum kerbweight in kg"},"gross_vehicleweight_kg":{"type":"integer","example":1234,"description":"Gross vehicle weight in kg"},"max_netpower_kw":{"type":"integer","example":12,"description":"Maximum net power in kw"},"max_braked_towing_weight_kg":{"type":"integer","example":1234,"description":"Maximum braked towing weight in kg"},"max_unbraked_towing_weight_kg":{"type":"integer","example":123,"description":"Maximum unbraked towing weight in kg"},"stationary_soundlevel_db":{"type":"integer","example":12,"description":"Stationary sound level in decibels"},"stationary_soundlevel_rpm":{"type":"integer","example":1234,"description":"Stationary sound level rpm"},"driveby_soundlevel_db":{"type":"integer","example":12,"description":"Driveby soundlevel in db"},"v5c_data_qty":{"type":"integer","example":1,"description":"The v5c quantity"},"v5c_data_items":{"type":"array","items":{"properties":{"date_v5c_issued":{"type":"string","example":"2020-01-01","description":"The date the v5 was issued"}}}},"vehicle_identity_check_qty":{"type":"integer","example":1,"description":"The vehicle identity check quantity"},"vehicle_identity_check_items":{"type":"array","items":{"properties":{"date_of_vehicle_identity_check":{"type":"string","example":"2020-01-01","description":"Date of (previous) vehicle identity check(s)"},"result_of_vehicle_identity_check":{"type":"string","example":"Pass","description":"Result of vehicle identity check"}}}},"stolen_vehicle_data_qty":{"type":"integer","example":1,"description":"The stolen vehicle data quantity."},"stolen_vehicle_data_items":{"type":"array","items":{"properties":{"date_last_updated":{"type":"string","example":"2020-01-01","description":"Date record was last updated"},"date_reported":{"type":"string","example":"2020-01-01","description":"The date vehicle was reported as stolen."},"is_stolen":{"type":"boolean","example":true,"description":"Is the vehicle stolen"},"police_force":{"type":"string","example":"COUNTY POLICE FORCE","description":"The investigating police force."},"police_force_contact_number":{"type":"string","example":"01234 567891","description":"The investigating police force contact number."}}}}}},"error":{"type":"string","example":"If there is an error the message would go here","description":"Details of what went wrong with the api call"}}}}}}},"security":[{"x-api-key":[]}]}},"/marketcheck/fairmarketvaluefromvrm/v2":{"get":{"tags":["Marketcheck"],"operationId":"marketcheck_fairmarketvaluefromvrm","summary":"Fair Market Value from VRM","description":"This endpoint provides national and local views of fair market value based on competitor vehicle listings, including stats on days to sold, the number of listings and market days supply","parameters":[{"name":"vehicle_registration_mark","in":"query","description":"Vehicle registration number","required":true,"schema":{"type":"string"}},{"name":"current_mileage","in":"query","description":"The current odometer reading of the vehicle","required":true,"schema":{"type":"integer"}},{"name":"post_code","in":"query","description":"The location of the stock vehicle used as the centre of the search","required":true,"schema":{"type":"string"}},{"name":"radius_miles","in":"query","description":"The radius used to calculate the fair market value (between 25-100 miles)*","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"description":"Whether the api call was successful"},"result":{"type":"object","properties":{"fair_market_value_gbp":{"type":"number","example":123.45,"description":"The fair market value of the vehicle based on the post code and radius specified"},"fair_market_value_type":{"type":"string","example":"local","description":"e.g. local or national. A national value will be provided as a fallback if insufficient sales observations are available"},"average_days_to_sold":{"type":"integer","example":123,"description":"The average days to sold of the observations used to provide the fair market value."}}},"error":{"type":"string","example":"If there is an error the message would go here","description":"Details of what went wrong with the api call"}}}}}}},"security":[{"x-api-key":[]}]}},"/marketcheck/historiclistingsfromvrm/v2":{"get":{"tags":["Marketcheck"],"operationId":"marketcheck_historiclistingsfromvrm","summary":"Historic Listings from VRM","description":"This endpoint provides all the historic listings for a vehicle since 1st January 2021 including the last advertised price, advertised mileage and seller's information.","parameters":[{"name":"vehicle_registration_mark","in":"query","description":"Vehicle registration number","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"description":"Whether the api call was successful"},"result":{"type":"array","items":{"properties":{"advert_id":{"type":"string","example":"X1234","description":"Advert Id"},"advertised_price_gbp":{"type":"number","example":12345.67,"description":"Advertised vehicle price"},"mileage_observed":{"type":"integer","example":12345,"description":"Vehicle odometer reading"},"vehicle_details_page_url":{"type":"string","example":"http://www.advert.com/advert=12345","description":"Url to the vehicle on the source website"},"seller_type":{"type":"string","example":"dealer","description":"e.g. dealer"},"ownership_condition":{"type":"string","example":"new","description":"e.g. new or used"},"last_seen_date":{"type":"string","example":"2023-02-21","description":"Last seen date for the current listing"},"first_seen_date":{"type":"string","example":"2023-01-15","description":"First seen date for the current listing"},"source_url":{"type":"string","example":"www.advert.com","description":"Website address"},"seller_name":{"type":"string","example":"ACME Motors","description":"Seller name"},"city":{"type":"string","example":"London","description":"City"},"post_code":{"type":"string","example":"AB1 2CD","description":"Postcode"}}}},"error":{"type":"string","example":"If there is an error the message would go here","description":"Details of what went wrong with the api call"}}}}}}},"security":[{"x-api-key":[]}]}},"/marketcheck/inventoryfromurl/v2":{"get":{"tags":["Marketcheck"],"operationId":"marketcheck_inventoryfromurl","summary":"Inventory From URL","description":"This endpoint allows you to pull all the inventory listed for a specific domain.","parameters":[{"name":"source_url","in":"query","description":"The source url for a specific dealer","required":true,"schema":{"type":"string"}},{"name":"advert_qty","in":"query","description":"The number of adverts returned per page. Defaults to 50 if not specified","required":false,"schema":{"type":"integer"}},{"name":"page","in":"query","description":"The number of pages returned. Defaults to 1 if not specified","required":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"description":"Whether the api call was successful"},"result":{"type":"object","properties":{"advert_qty":{"type":"integer","example":1,"description":"The number of adverts matching the query parameters"},"advert_list":{"type":"array","items":{"properties":{"advert_id":{"type":"string","example":"X12345","description":"Advert Id"},"vehicle_registration_mark":{"type":"string","example":"AB12ABC","description":"Vehicle registration number"},"advert_heading":{"type":"string","example":"Advert heading","description":"Advert heading"},"advertised_price_gbp":{"type":"number","example":12345.67,"description":"Advertised vehicle price"},"price_change_percentage":{"type":"number","example":12.3,"description":"Price change in % since vehicle was last scraped with the same dealer"},"mileage_observed":{"type":"integer","example":12345,"description":"Vehicle odometer reading"},"vehicle_details_page_url":{"type":"string","example":"http://www.advert.com/advert=12345","description":"Url to the vehicle on the source website"},"colour":{"type":"string","example":"blue","description":"Exterior colour of vehicle"},"days_on_market":{"type":"integer","example":123,"description":"The number of days for the current listing"},"seller_type":{"type":"string","example":"dealer","description":"e.g. dealer"},"ownership_condition":{"type":"string","example":"new","description":"e.g. new or used"},"last_seen_date":{"type":"string","example":"2023-02-21","description":"Last seen date for the current listing"},"first_seen_date":{"type":"string","example":"2023-01-15","description":"First seen date for the current listing"},"first_seen_at_source_date":{"type":"string","example":"2022-12-04","description":"This could be earlier than first seen at date if the vehicle was previously listed (removed for min 5 days)"},"source_url":{"type":"string","example":"http://www.advert.com","description":"Website address"},"co2_gkm":{"type":"integer","example":123,"description":"CO2 in g/km"},"number_previous_keepers":{"type":"integer","example":1,"description":"The number of previous keepers."},"insurance_group":{"type":"string","example":"8E","description":"Vehicle insurance group"},"vehicle_location_details":{"type":"object","properties":{"seller_name":{"type":"string","example":"ACME Motors","description":"Seller name"},"street":{"type":"string","example":"123 Fake Street","description":"Street"},"city":{"type":"string","example":"London","description":"City"},"county":{"type":"string","example":"Lancashire","description":"County"},"latitude":{"type":"number","example":123.456789,"description":"Latitude"},"longitude":{"type":"number","example":345.6789012,"description":"Longitude"},"post_code":{"type":"string","example":"AB1 2CD","description":"Postcode"}}},"image_links":{"type":"array","items":{}},"dealer_details":{"type":"object","properties":{"dealer_id":{"type":"string","example":"X12345","description":"Dealer Id"},"dealer_name":{"type":"string","example":"ACME Motors","description":"Dealer Name"},"website_url":{"type":"string","example":"http://www.acme-motors.com","description":"Website URL"},"street":{"type":"string","example":"123 Fake Street","description":"Street"},"city":{"type":"string","example":"London","description":"City"},"country":{"type":"string","example":"England","description":"Country"},"latitude":{"type":"number","example":123.456789,"description":"Latitude"},"longitude":{"type":"number","example":345.6789012,"description":"Longitude"},"post_code":{"type":"string","example":"AB1 2CD","description":"Postcode"},"phone_number":{"type":"string","example":"01234 567890","description":"Telephone number"},"email_address":{"type":"string","example":"hello@acme-motors.com","description":"Email address"}}},"vehicle_data":{"type":"object","properties":{"first_registration_year":{"type":"integer","example":2020,"description":"Year of registration"},"manufacturer_desc":{"type":"string","example":"Mini","description":"Manufacturer description"},"model_range_desc":{"type":"string","example":"Cooper","description":"Model range description"},"trim_desc":{"type":"string","example":"Clubman","description":"Trim description"},"variant_desc":{"type":"string","example":"5 door auto","description":"Variant description"},"body_type_desc":{"type":"string","example":"Estate","description":"The body type description"},"asset_type":{"type":"string","example":"Car","description":"The asset type"},"transmission_desc":{"type":"string","example":"Automatic","description":"The vehicle's transmission type"},"drivetrain_desc":{"type":"string","example":"Front wheel drive","description":"Drivetrain"},"fuel_type_desc":{"type":"string","example":"Petrol","description":"The vehicle's fuel type description"},"engine_data":{"type":"string","example":"1197cc, 69 HP, 75","description":"Engine data"},"engine_badged_power":{"type":"number","example":1.6,"description":"Badged engine size"},"number_doors":{"type":"integer","example":5,"description":"The number of doors"},"number_cylinders":{"type":"integer","example":4,"description":"The number of cylinders"},"number_seats":{"type":"integer","example":4,"description":"Number of seats"},"aspiration":{"type":"string","example":"Naturally aspirated","description":"Aspiration."}}}}}},"more_results":{"type":"boolean","example":true,"description":"The total number of adverts that can be returned."}}},"error":{"type":"string","example":"If there is an error the message would go here","description":"Details of what went wrong with the api call"}}}}}}},"security":[{"x-api-key":[]}]}},"/marketcheck/inventoryfromvrm/v2":{"get":{"tags":["Marketcheck"],"operationId":"marketcheck_inventoryfromvrm","summary":"Inventory From VRM","description":"This endpoint allows you to search for inventory based on a VRM. A list of vehicles will be returned in descending price order.","parameters":[{"name":"vehicle_registration_mark","in":"query","description":"Vehicle registration number","required":true,"schema":{"type":"string"}},{"name":"price_to_gbp","in":"query","description":"The maximum price of items returned","required":true,"schema":{"type":"integer"}},{"name":"post_code","in":"query","description":"Postcode for the area of interest e.g AB1ABC","required":true,"schema":{"type":"string"}},{"name":"radius_miles","in":"query","description":"The maximum distance from the specified postcode","required":true,"schema":{"type":"string"}},{"name":"required_manufacturers","in":"query","description":"The manufacturer(s) returned within the search","required":false,"schema":{"type":"string"}},{"name":"source_url","in":"query","description":"The source url for a specific dealer","required":false,"schema":{"type":"string"}},{"name":"current_mileage","in":"query","description":"The current mileage of the vehicle in full","required":false,"schema":{"type":"integer"}},{"name":"price_from_gbp","in":"query","description":"The minimum price of items returned","required":false,"schema":{"type":"integer"}},{"name":"advert_qty","in":"query","description":"The number of adverts returned per page. Defaults to 50 if not specified","required":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"description":"Whether the api call was successful"},"result":{"type":"object","properties":{"advert_qty":{"type":"integer","example":1,"description":"The number of adverts matching the query parameters"},"advert_list":{"type":"array","items":{"properties":{"advert_id":{"type":"string","example":"X12345","description":"Advert Id"},"vehicle_registration_mark":{"type":"string","example":"AB12ABC","description":"Vehicle registration number"},"distance_miles":{"type":"integer","example":123,"description":"The distance from the specified postcode of the car location. Returns null when no postcode is specified"},"advert_heading":{"type":"string","example":"Advert heading","description":"Advert heading"},"advertised_price_gbp":{"type":"number","example":12345.67,"description":"Advertised vehicle price"},"price_change_percentage":{"type":"number","example":12.3,"description":"Price change in % since vehicle was last scraped with the same dealer"},"mileage_observed":{"type":"integer","example":12345,"description":"Vehicle odometer reading"},"vehicle_details_page_url":{"type":"string","example":"http://www.advert.com/advert=12345","description":"Url to the vehicle on the source website"},"colour":{"type":"string","example":"blue","description":"Exterior colour of vehicle"},"days_on_market":{"type":"integer","example":123,"description":"The number of days for the current listing"},"seller_type":{"type":"string","example":"dealer","description":"e.g. dealer"},"ownership_condition":{"type":"string","example":"new","description":"e.g. new or used"},"last_seen_date":{"type":"string","example":"2023-02-21","description":"Last seen date for the current listing"},"first_seen_date":{"type":"string","example":"2023-01-15","description":"First seen date for the current listing"},"first_seen_at_source_date":{"type":"string","example":"2022-12-04","description":"This could be earlier than first seen at date if the vehicle was previously listed (removed for min 5 days)"},"source_url":{"type":"string","example":"http://www.advert.com","description":"Website address"},"co2_gkm":{"type":"integer","example":123,"description":"CO2 in g/km"},"number_previous_keepers":{"type":"integer","example":1,"description":"The number of previous keepers."},"insurance_group":{"type":"string","example":"8E","description":"Vehicle insurance group"},"vehicle_location_details":{"type":"object","properties":{"seller_name":{"type":"string","example":"ACME Motors","description":"Seller name"},"street":{"type":"string","example":"123 Fake Street","description":"Street"},"city":{"type":"string","example":"London","description":"City"},"county":{"type":"string","example":"Lancashire","description":"County"},"latitude":{"type":"number","example":123.456789,"description":"Latitude"},"longitude":{"type":"number","example":345.6789012,"description":"Longitude"},"post_code":{"type":"string","example":"AB1 2CD","description":"Postcode"}}},"image_links":{"type":"array","items":{}},"dealer_details":{"type":"object","properties":{"dealer_id":{"type":"string","example":"X12345","description":"Dealer Id"},"dealer_name":{"type":"string","example":"ACME Motors","description":"Dealer Name"},"website_url":{"type":"string","example":"http://www.acme-motors.com","description":"Website URL"},"street":{"type":"string","example":"123 Fake Street","description":"Street"},"city":{"type":"string","example":"London","description":"City"},"country":{"type":"string","example":"England","description":"Country"},"latitude":{"type":"number","example":123.456789,"description":"Latitude"},"longitude":{"type":"number","example":345.6789012,"description":"Longitude"},"post_code":{"type":"string","example":"AB1 2CD","description":"Postcode"},"phone_number":{"type":"string","example":"01234 567890","description":"Telephone number"},"email_address":{"type":"string","example":"hello@acme-motors.com","description":"Email address"}}},"vehicle_data":{"type":"object","properties":{"first_registration_year":{"type":"integer","example":2020,"description":"Year of registration"},"manufacturer_desc":{"type":"string","example":"Mini","description":"Manufacturer description"},"model_range_desc":{"type":"string","example":"Cooper","description":"Model range description"},"trim_desc":{"type":"string","example":"Clubman","description":"Trim description"},"variant_desc":{"type":"string","example":"5 door auto","description":"Variant description"},"body_type_desc":{"type":"string","example":"Estate","description":"The body type description"},"asset_type":{"type":"string","example":"Car","description":"The asset type"},"transmission_desc":{"type":"string","example":"Automatic","description":"The vehicle's transmission type"},"drivetrain_desc":{"type":"string","example":"Front wheel drive","description":"Drivetrain"},"fuel_type_desc":{"type":"string","example":"Petrol","description":"The vehicle's fuel type description"},"engine_data":{"type":"string","example":"1197cc, 69 HP, 75","description":"Engine data"},"engine_badged_power":{"type":"number","example":1.6,"description":"Badged engine size"},"number_doors":{"type":"integer","example":5,"description":"The number of doors"},"number_cylinders":{"type":"integer","example":4,"description":"The number of cylinders"},"number_seats":{"type":"integer","example":4,"description":"Number of seats"}}}}}},"more_results":{"type":"boolean","example":true,"description":"The total number of adverts that can be returned."}}},"error":{"type":"string","example":"If there is an error the message would go here","description":"Details of what went wrong with the api call"}}}}}}},"security":[{"x-api-key":[]}]}},"/marketcheck/inventorysearch/v2":{"get":{"tags":["Marketcheck"],"operationId":"marketcheck_inventorysearch","summary":"Inventory Search","description":"This endpoint allows you to search real-time market data by budget, location, brand preference and mileage.","parameters":[{"name":"price_to_gbp","in":"query","description":"The maximum price of items returned","required":true,"schema":{"type":"integer"}},{"name":"post_code","in":"query","description":"Postcode for the area of interest e.g AB1ABC","required":true,"schema":{"type":"string"}},{"name":"radius_miles","in":"query","description":"The maximum distance from the specified postcode","required":true,"schema":{"type":"string"}},{"name":"required_manufacturers","in":"query","description":"The manufacturer(s) returned within the search (comma separated)","required":false,"schema":{"type":"string"}},{"name":"registration_date_from","in":"query","description":"The earliest registration date for vehicles returned by the search","required":false,"schema":{"type":"string"}},{"name":"registration_date_to","in":"query","description":"The latest registration date for vehicles returned by the search","required":false,"schema":{"type":"string"}},{"name":"current_mileage_from","in":"query","description":"The lowest mileage for vehicles returned by the search","required":false,"schema":{"type":"string"}},{"name":"current_mileage_to","in":"query","description":"The highest mileage for vehicles returned by the search","required":false,"schema":{"type":"string"}},{"name":"price_from_gbp","in":"query","description":"The minimum price of items returned","required":false,"schema":{"type":"integer"}},{"name":"source_url","in":"query","description":"The source url for a specific dealer","required":false,"schema":{"type":"string"}},{"name":"advert_qty","in":"query","description":"The number of adverts returned per page. Defaults to 50 if not specified","required":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"description":"Whether the api call was successful"},"result":{"type":"object","properties":{"advert_qty":{"type":"integer","example":1,"description":"The number of adverts matching the query parameters"},"advert_list":{"type":"array","items":{"properties":{"advert_id":{"type":"string","example":"X12345","description":"Advert Id"},"vehicle_registration_mark":{"type":"string","example":"AB12ABC","description":"Vehicle registration number"},"distance_miles":{"type":"integer","example":123,"description":"The distance from the specified postcode of the car location. Returns null when no postcode is specified"},"advert_heading":{"type":"string","example":"Advert heading","description":"Advert heading"},"advertised_price_gbp":{"type":"number","example":12345.67,"description":"Advertised vehicle price"},"price_change_percentage":{"type":"number","example":12.3,"description":"Price change in % since vehicle was last scraped with the same dealer"},"mileage_observed":{"type":"integer","example":12345,"description":"Vehicle odometer reading"},"vehicle_details_page_url":{"type":"string","example":"http://www.advert.com/advert=12345","description":"Url to the vehicle on the source website"},"colour":{"type":"string","example":"blue","description":"Exterior colour of vehicle"},"days_on_market":{"type":"integer","example":123,"description":"The number of days for the current listing"},"seller_type":{"type":"string","example":"dealer","description":"e.g. dealer"},"ownership_condition":{"type":"string","example":"new","description":"e.g. new or used"},"last_seen_date":{"type":"string","example":"2023-02-21","description":"Last seen date for the current listing"},"first_seen_date":{"type":"string","example":"2023-01-15","description":"First seen date for the current listing"},"first_seen_at_source_date":{"type":"string","example":"2022-12-04","description":"This could be earlier than first seen at date if the vehicle was previously listed (removed for min 5 days)"},"source_url":{"type":"string","example":"http://www.advert.com","description":"Website address"},"co2_gkm":{"type":"integer","example":123,"description":"CO2 in g/km"},"number_previous_keepers":{"type":"integer","example":1,"description":"The number of previous keepers."},"insurance_group":{"type":"string","example":"8E","description":"Vehicle insurance group"},"vehicle_location_details":{"type":"object","properties":{"seller_name":{"type":"string","example":"ACME Motors","description":"Seller name"},"street":{"type":"string","example":"123 Fake Street","description":"Street"},"city":{"type":"string","example":"London","description":"City"},"county":{"type":"string","example":"Lancashire","description":"County"},"latitude":{"type":"number","example":123.456789,"description":"Latitude"},"longitude":{"type":"number","example":345.6789012,"description":"Longitude"},"post_code":{"type":"string","example":"AB1 2CD","description":"Postcode"}}},"image_links":{"type":"array","items":{}},"dealer_details":{"type":"object","properties":{"dealer_id":{"type":"string","example":"X12345","description":"Dealer Id"},"dealer_name":{"type":"string","example":"ACME Motors","description":"Dealer Name"},"website_url":{"type":"string","example":"http://www.acme-motors.com","description":"Website URL"},"street":{"type":"string","example":"123 Fake Street","description":"Street"},"city":{"type":"string","example":"London","description":"City"},"country":{"type":"string","example":"England","description":"Country"},"latitude":{"type":"number","example":123.456789,"description":"Latitude"},"longitude":{"type":"number","example":345.6789012,"description":"Longitude"},"post_code":{"type":"string","example":"AB1 2CD","description":"Postcode"},"phone_number":{"type":"string","example":"01234 567890","description":"Telephone number"},"email_address":{"type":"string","example":"hello@acme-motors.com","description":"Email address"}}},"vehicle_data":{"type":"object","properties":{"first_registration_year":{"type":"integer","example":2020,"description":"Year of registration"},"manufacturer_desc":{"type":"string","example":"Mini","description":"Manufacturer description"},"model_range_desc":{"type":"string","example":"Cooper","description":"Model range description"},"trim_desc":{"type":"string","example":"Clubman","description":"Trim description"},"variant_desc":{"type":"string","example":"5 door auto","description":"Variant description"},"body_type_desc":{"type":"string","example":"Estate","description":"The body type description"},"asset_type":{"type":"string","example":"Car","description":"The asset type"},"transmission_desc":{"type":"string","example":"Automatic","description":"The vehicle's transmission type"},"drivetrain_desc":{"type":"string","example":"Front wheel drive","description":"Drivetrain"},"fuel_type_desc":{"type":"string","example":"Petrol","description":"The vehicle's fuel type description"},"engine_data":{"type":"string","example":"1197cc, 69 HP, 75","description":"Engine data"},"engine_badged_power":{"type":"number","example":1.6,"description":"Badged engine size"},"number_doors":{"type":"integer","example":5,"description":"The number of doors"},"number_cylinders":{"type":"integer","example":4,"description":"The number of cylinders"},"number_seats":{"type":"integer","example":4,"description":"Number of seats"}}}}}},"more_results":{"type":"boolean","example":true,"description":"The total number of adverts that can be returned."}}},"error":{"type":"string","example":"If there is an error the message would go here","description":"Details of what went wrong with the api call"}}}}}}},"security":[{"x-api-key":[]}]}},"/marketcheck/similarlistingsfromvrm/v2":{"get":{"tags":["Marketcheck"],"operationId":"marketcheck_similarlistingsfromvrm","summary":"Similar Listings from VRM","description":"This endpoint provides additional insight into local competition when purchasing vehicles including number of adverts matching the query parameters, advertised prices, percentage price change, number of keepers and seller's details.","parameters":[{"name":"vehicle_registration_mark","in":"query","description":"Vehicle registration number","required":true,"schema":{"type":"string"}},{"name":"radius_miles","in":"query","description":"The distance from the location specified by postcode within which adverts should be returned","required":true,"schema":{"type":"string"}},{"name":"post_code","in":"query","description":"The location of the stock vehicle used as the centre of the search","required":true,"schema":{"type":"string"}},{"name":"number_items","in":"query","description":"The number of items you want returned (limited to a maximum of 25)","required":false,"schema":{"type":"integer"}},{"name":"price_from_gbp","in":"query","description":"The minimum price of items returned","required":false,"schema":{"type":"integer"}},{"name":"price_to_gbp","in":"query","description":"The maximum price of items returned","required":false,"schema":{"type":"integer"}},{"name":"mileage_observed_from","in":"query","description":"The minimum (observed) miles for the items returned","required":false,"schema":{"type":"integer"}},{"name":"mileage_observed_to","in":"query","description":"The maximum (observed) miles for the items returned","required":false,"schema":{"type":"integer"}},{"name":"match","in":"query","description":"When used* with one or more of the following will return advertised vehicles matching the specified parameters (first_registration_year, manufacturer_desc, model_desc, variant_desc) e.g match=first_registration_year,manufacturer_desc,model_desc,variant_desc* all 4 parameters will be applied when match= is not used","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"description":"Whether the api call was successful"},"result":{"type":"object","properties":{"advert_qty":{"type":"integer","example":1,"description":"The number of adverts matching the query parameters"},"advert_list":{"type":"array","items":{"properties":{"advert_id":{"type":"string","example":"X12345","description":"Advert Id"},"vehicle_registration_mark":{"type":"string","example":"AB12ABC","description":"Vehicle registration number"},"distance_miles":{"type":"integer","example":123,"description":"The distance from the specified postcode of the car location. Returns null when no postcode is specified"},"advert_heading":{"type":"string","example":"Advert heading","description":"Advert heading"},"advertised_price_gbp":{"type":"number","example":12345.67,"description":"Advertised vehicle price"},"price_change_percentage":{"type":"number","example":12.3,"description":"Price change in % since vehicle was last scraped with the same dealer"},"mileage_observed":{"type":"integer","example":12345,"description":"Vehicle odometer reading"},"vehicle_details_page_url":{"type":"string","example":"http://www.advert.com/advert=12345","description":"Url to the vehicle on the source website"},"colour":{"type":"string","example":"blue","description":"Exterior colour of vehicle"},"days_on_market":{"type":"integer","example":123,"description":"The number of days for the current listing"},"seller_type":{"type":"string","example":"dealer","description":"e.g. dealer"},"ownership_condition":{"type":"string","example":"new","description":"e.g. new or used"},"last_seen_date":{"type":"string","example":"2023-02-21","description":"Last seen date for the current listing"},"first_seen_date":{"type":"string","example":"2023-01-15","description":"First seen date for the current listing"},"first_seen_at_source_date":{"type":"string","example":"2022-12-04","description":"This could be earlier than first seen at date if the vehicle was previously listed (removed for min 5 days)"},"source_url":{"type":"string","example":"http://www.advert.com","description":"Website address"},"co2_gkm":{"type":"integer","example":123,"description":"CO2 in g/km"},"number_previous_keepers":{"type":"integer","example":1,"description":"The number of previous keepers."},"insurance_group":{"type":"string","example":"8E","description":"Vehicle insurance group"},"vehicle_location_details":{"type":"object","properties":{"seller_name":{"type":"string","example":"ACME Motors","description":"Seller name"},"street":{"type":"string","example":"123 Fake Street","description":"Street"},"city":{"type":"string","example":"York","description":"City"},"county":{"type":"string","example":"North Yorkshire","description":"County"},"latitude":{"type":"number","example":123.456789,"description":"Latitude"},"longitude":{"type":"number","example":345.6789012,"description":"Longitude"},"post_code":{"type":"string","example":"AB1 2BC","description":"Postcode"}}},"image_links":{"type":"array","items":{}},"dealer_details":{"type":"object","properties":{"dealer_id":{"type":"string","example":"X12345","description":"Dealer Id"},"dealer_name":{"type":"string","example":"ACME Motors","description":"Dealer Name"},"website_url":{"type":"string","example":"http://www.acme-motors.com","description":"Website URL"},"street":{"type":"string","example":"123 Fake Street","description":"Street"},"city":{"type":"string","example":"London","description":"City"},"country":{"type":"string","example":"England","description":"Country"},"latitude":{"type":"number","example":123.456789,"description":"Latitude"},"longitude":{"type":"number","example":345.6789012,"description":"Longitude"},"post_code":{"type":"string","example":"AB1 2BC","description":"Postcode"},"phone_number":{"type":"string","example":"01234 567890","description":"Telephone number"},"email_address":{"type":"string","example":"hello@acme-motors.com","description":"Email address"}}},"vehicle_data":{"type":"object","properties":{"first_registration_year":{"type":"integer","example":2020,"description":"Year of registration"},"manufacturer_desc":{"type":"string","example":"Mini","description":"Manufacturer description"},"model_range_desc":{"type":"string","example":"Cooper","description":"Model range description"},"trim_desc":{"type":"string","example":"Clubman","description":"Trim description"},"variant_desc":{"type":"string","example":"5 door auto","description":"Variant description"},"body_type_desc":{"type":"string","example":"Estate","description":"The body type description"},"asset_type":{"type":"string","example":"Car","description":"The asset type"},"transmission_desc":{"type":"string","example":"Automatic","description":"The vehicle's transmission type"},"drivetrain_desc":{"type":"string","example":"Front wheel drive","description":"Drivetrain"},"fuel_type_desc":{"type":"string","example":"Petrol","description":"The vehicle's fuel type description"},"engine_data":{"type":"string","example":"1197cc, 69 HP, 75","description":"Engine data"},"engine_badged_power":{"type":"number","example":1.6,"description":"Badged engine size"},"number_doors":{"type":"integer","example":5,"description":"The number of doors"},"number_cylinders":{"type":"integer","example":4,"description":"The number of cylinders"},"number_seats":{"type":"integer","example":4,"description":"Number of seats"},"aspiration":{"type":"string","example":"Naturally aspirated","description":"Aspiration."}}}}}}}},"error":{"type":"string","example":"If there is an error the message would go here","description":"Details of what went wrong with the api call"}}}}}}},"security":[{"x-api-key":[]}]}},"/oneauto/recallcheckfromvin/v2":{"get":{"tags":["One Auto API"],"operationId":"oneauto_recallcheckfromvin","summary":"Recall Check from VIN","description":"This endpoint identifies where a vehicle has been recalled by the manufacturer.","parameters":[{"name":"vehicle_identification_number","in":"query","description":"Vehicle identification number","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"description":"Whether the api call was successful"},"result":{"type":"object","properties":{"vehicle_registration_mark":{"type":"string","example":"AB21ABC","description":"Vehicle registration number"},"vehicle_identification_number":{"type":"string","example":"ABCDE123456F78910","description":"The vehicle identification number."},"smmt_manufacturer_model_desc":{"type":"string","example":"TBC - check with MF format.","description":"The SMMT model description."},"recall_status":{"type":"string","example":"Recall outstanding","description":"The vehicle's recall status."},"recall_status_checked_datetime":{"type":"string","example":"2022-01-01T16:07:33.6134574+00:00","description":"The date and time recall status was checked."},"recall_qty":{"type":"integer","example":1,"description":"The number of recalls."},"recall_data_items":{"type":"array","items":{"properties":{"recall_desc":{"type":"string","example":"REAR SPOILER OUTER SURFACE RETENTION","description":"The recall description."}}}}}},"error":{"type":"string","example":"If there is an error the message would go here","description":"Details of what went wrong with the api call"}}}}}}},"security":[{"x-api-key":[]}]}},"/oneauto/recallcheckfromvrm/v2":{"get":{"tags":["One Auto API"],"operationId":"oneauto_recallcheckfromvrm","summary":"Recall Check from VRM","description":"This endpoint identifies where a vehicle has been recalled by the manufacturer.","parameters":[{"name":"vehicle_registration_mark","in":"query","description":"Vehicle registration number","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"description":"Whether the api call was successful"},"result":{"type":"object","properties":{"vehicle_registration_mark":{"type":"string","example":"AB21ABC","description":"Vehicle registration number"},"vehicle_identification_number":{"type":"string","example":"ABCDE123456F78910","description":"The vehicle identification number."},"smmt_manufacturer_model_desc":{"type":"string","example":"TBC - check with MF format.","description":"The SMMT model description."},"recall_status":{"type":"string","example":"Recall outstanding","description":"The vehicle's recall status."},"recall_status_checked_datetime":{"type":"string","example":"2022-01-01T16:07:33.6134574+00:00","description":"The date and time recall status was checked."},"recall_qty":{"type":"integer","example":1,"description":"The number of recalls."},"recall_data_items":{"type":"array","items":{"properties":{"recall_desc":{"type":"string","example":"REAR SPOILER OUTER SURFACE RETENTION","description":"The recall description."}}}}}},"error":{"type":"string","example":"If there is an error the message would go here","description":"Details of what went wrong with the api call"}}}}}}},"security":[{"x-api-key":[]}]}},"/oneauto/settlementcalculator/v2":{"get":{"tags":["One Auto API"],"operationId":"oneauto_settlementcalculator","summary":"Settlement Calculator","description":"Provides an estimate of the amount to settle a finance agreement on a user defined date. Please contact us for free implementation consultancy if you plan on integrating this endpoint.","parameters":[{"name":"start_date","in":"query","description":"The date on which the agreement started.","required":true,"schema":{"type":"string"}},{"name":"term_months","in":"query","description":"The scheduled term of the finance agreement.","required":true,"schema":{"type":"integer"}},{"name":"number_monthly_payments","in":"query","description":"The number of monthly payments as supplied by the financial provider.","required":true,"schema":{"type":"integer"}},{"name":"settlement_date","in":"query","description":"The settlement date.","required":true,"schema":{"type":"string"}},{"name":"customer_rate","in":"query","description":"The customer rate (as supplied by financial institution) or APR if unavailable.","required":true,"schema":{"type":"number"}},{"name":"monthly_payment_gbp","in":"query","description":"The monthly payment in GBP.","required":true,"schema":{"type":"number"}},{"name":"advance_gbp","in":"query","description":"The advanced payment in GBP.","required":true,"schema":{"type":"integer"}},{"name":"gfv_gbp","in":"query","description":"The guaranteed future value in GBP. For Hire Purchase (HP) agreement this parameter should be set as zero.","required":true,"schema":{"type":"number"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"description":"Whether the api call was successful"},"result":{"type":"object","properties":{"settlement_amount_gbp":{"type":"number","example":12345.67,"description":"The settlement in GBP."}}},"error":{"type":"string","example":"If there is an error the message would go here","description":"Details of what went wrong with the api call"}}}}}}},"security":[{"x-api-key":[]}]}},"/oneauto/vehiclevalidation/v2":{"get":{"tags":["One Auto API"],"operationId":"oneauto_vehiclevalidation","summary":"Lead Validation","description":"Cleanse inbound leads by submitting a VRM. The service returns a fail (status code 200) or pass (status code 206) result. If result = fail the reason(s) for failure are identified in the response, enabling you to apply different handling rules for the lead and provide information to users.","parameters":[{"name":"vehicle_registration_mark","in":"query","description":"Vehicle registration number","required":true,"schema":{"type":"string"}},{"name":"maximum_age_months","in":"query","description":"the maximum age of a vehicle that can pass","required":false,"schema":{"type":"integer"}},{"name":"maximum_number_keepers","in":"query","description":"the maximum number of keepers in order to pass","required":false,"schema":{"type":"integer"}},{"name":"maximum_keeper_changes_last_12_months","in":"query","description":"the maximum number of keepers in the past 12 months","required":false,"schema":{"type":"integer"}},{"name":"minimum_months_since_last_keeper_change","in":"query","description":"the minimum number of months since the last keeper change in order to pass","required":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"description":"Whether the api call was successful"},"result":{"type":"object","properties":{"vehicle_registration_mark":{"type":"string","example":"AB21ABC","description":"Vehicle registration number"},"result":{"type":"string","example":"fail","description":"Has the vehicle passed all lead validation tests."},"fail_reason_qty":{"type":"integer","example":6,"description":"The number of lead validation failures."},"fail_reason_data_items":{"type":"array","items":{"properties":{"is_possible_taxi":{"type":"boolean","example":true,"description":"Has the vehicle been previously used as a taxi."},"taxi_records":{"type":"array","items":{"properties":{"taxi_record_id":{"type":"integer","example":123456,"description":"The taxi record ID."},"manufacturer_desc":{"type":"string","example":"NISSAN","description":"Manufacturer description"},"model_range_desc":{"type":"string","example":"Qashqai","description":"Model range description"},"manufacturer_model_desc":{"type":"string","example":"NISSAN Qashqai","description":"The model range description."},"licence_start_date":{"type":"string","example":"2020-01-02","description":"The taxi and private hire licence start date."},"licence_expiry_date":{"type":"string","example":"2020-01-01","description":"The taxi and private hire licence expiry date."},"is_wheelchair_adapted":{"type":"boolean","example":false,"description":"Is the vehicle wheelchair adapated."},"carguide_fuel_type_desc":{"type":"string","example":"Petrol","description":"The licence holder's name."},"licence_holder_name":{"type":"string","example":"TBC","description":"The vehicle's fuel type"}}}},"salvage_auction_record_found":{"type":"boolean","example":true,"description":"Salvage record has been found"},"salvage_auction_records":{"type":"array","items":{"properties":{"salvage_auction_record_id":{"type":"integer","example":1234567,"description":"Salvage record id"},"salvage_auction_lot_desc":{"type":"string","example":"Nissan Qashqai","description":"Salvage auction lot description"},"salvage_auction_lot_date":{"type":"string","example":"2020-01-01","description":"The salvage auction date"},"mileage":{"type":"integer","example":12345,"description":" The current mileage of the vehicle in full"},"primary_damage_desc":{"type":"string","example":"Slight Front Damage","description":" The primary damage description"},"secondary_damage_desc":{"type":"string","example":"Unable to select 5th gear, steering poor.","description":" The secondary damage description"},"external_image_urls":{"type":"string","example":"http://exampleauctionhouse/example/12345","description":"The URL returns external image of vehicle."}}}}}}},"is_scrapped":{"type":"boolean","example":true,"description":"Has the vehicle been scrapped."},"is_exported":{"type":"boolean","example":false,"description":"Vehicle is exported"},"is_imported":{"type":"boolean","example":false,"description":"Vehicle is imported"},"is_non_eu_import":{"type":"boolean","example":false,"description":"Vehicle is non-eu import"},"is_stolen":{"type":"boolean","example":true,"description":"Is the vehicle stolen"},"stolen_vehicle_data_items":{"type":"array","items":{"properties":{"datetime_added_pnc":{"type":"string","example":"2020-01-01T08:00:02Z","description":"The date and time the vehicle was added to the police national computer"},"date_reported":{"type":"string","example":"2020-01-01","description":"The date vehicle was reported as stolen."},"police_force":{"type":"string","example":"COUNTY POLICE","description":"The investigating police force."}}}},"exceeds_maximum_age_months":{"type":"boolean","example":true,"description":"Has the maximum age of the vehicle been exceeded."},"exceeds_maximum_number_keepers":{"type":"boolean","example":true,"description":"Has the maximum number keepers of the vehicle been exceeded."},"exceeds_maximum_keeper_changes_last_12_months":{"type":"boolean","example":false,"description":"Has the maximum number keepers of the vehicle in the last 12 months been exceeded."},"is_less_than_minimum_months_since_last_keeper_change":{"type":"boolean","example":false,"description":"Was the last keeper within the minimum number of months change specified."},"dvla_manufacturer_desc":{"type":"string","example":"NISSAN","description":"DVLA manufacturer description"},"dvla_model_desc":{"type":"string","example":"QASHQAI ACENTA PREMIUM DCI","description":"DVLA model description"},"dvla_fuel_desc":{"type":"string","example":"DIESEL","description":"DVLA fuel description"},"dvla_body_desc":{"type":"string","example":"5 DOOR HATCHBACK","description":"DVLA body description"},"registration_date":{"type":"string","example":"2020-01-01","description":"Date the vehicle was first registered in the UK"},"manufactured_year":{"type":"integer","example":2020,"description":"Year of manufacturer"},"vehicle_identification_number":{"type":"string","example":"ABCDE123456F78910","description":"The vehicle identification number."},"first_registration_date":{"type":"string","example":"2020-01-01","description":"Date of first registration"},"used_before_first_registration":{"type":"boolean","example":false,"description":"Vehicle was used before DVLA/DLNI first registration"},"co2_gkm":{"type":"integer","example":123,"description":"CO2 in g/km"},"engine_number":{"type":"string","example":"A12345678","description":"Vehicle engine number"},"scrapped_date":{"type":"string","example":"2020-01-01","description":"The date the vehicle was scrapped."},"exported_date":{"type":"string","example":"2020-01-01","description":"Date vehicle was exported"},"colour":{"type":"string","example":"RED","description":"Exterior colour of vehicle"},"v5c_qty":{"type":"integer","example":1,"description":"The v5c quantity"},"date_v5c_issued":{"type":"string","example":"2020-01-01","description":"The date the v5 was issued"},"keeper_change_list":{"type":"array","items":{"properties":{"number_previous_keepers":{"type":"integer","example":1,"description":"The number of previous keepers."},"date_of_last_keeper_change":{"type":"string","example":"2020-01-01","description":"The date of last keeper change."}}}}}},"error":{"type":"string","example":"If there is an error the message would go here","description":"Details of what went wrong with the api call"}}}}}}},"security":[{"x-api-key":[]}]}},"/sagacity/deceased":{"get":{"tags":["Sagacity"],"operationId":"sagacity_deceased","summary":"Deceased","description":"This endpoint identifies where a deceased record has been found.","parameters":[{"name":"full_name","in":"query","description":"The customer's full name","required":true,"schema":{"type":"string"}},{"name":"address_1","in":"query","description":"The first line of the customer's address","required":true,"schema":{"type":"string"}},{"name":"address_2","in":"query","description":"The second line of the address","required":false,"schema":{"type":"string"}},{"name":"address_3","in":"query","description":"The third line of the address","required":false,"schema":{"type":"string"}},{"name":"address_4","in":"query","description":"The fourth line of the address","required":false,"schema":{"type":"string"}},{"name":"address_5","in":"query","description":"The fifth line of the address","required":false,"schema":{"type":"string"}},{"name":"address_6","in":"query","description":"The sixth line of the address","required":false,"schema":{"type":"string"}},{"name":"address_7","in":"query","description":"The seventh line of the address","required":false,"schema":{"type":"string"}},{"name":"unique_reference","in":"query","description":"The unique reference number associated to the supplied name and address","required":false,"schema":{"type":"string"}},{"name":"date_of_birth","in":"query","description":"The person's date of birth","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"description":"Whether the api call was successful"},"result":{"type":"object","properties":{"is_deceased":{"type":"boolean","example":true,"description":"Is the person deceased"},"unique_reference":{"type":"string","example":"Your reference","description":"The unique reference number associated to the supplied name and address"},"source":{"type":"string","example":"Example Source","description":"The source of the data"}}},"error":{"type":"string","example":"If there is an error the message would go here","description":"Details of what went wrong with the api call"}}}}}}},"security":[{"x-api-key":[]}]}},"/sagacity/goneaway":{"get":{"tags":["Sagacity"],"operationId":"sagacity_goneaway","summary":"Gone Away","description":"This endpoint identify validated movers and goneaways in the UK.","parameters":[{"name":"full_name","in":"query","description":"The customer's full name","required":true,"schema":{"type":"string"}},{"name":"address_1","in":"query","description":"The first line of the customer's address","required":true,"schema":{"type":"string"}},{"name":"address_2","in":"query","description":"The second line of the person's address","required":false,"schema":{"type":"string"}},{"name":"address_3","in":"query","description":"The third line of the person's address","required":false,"schema":{"type":"string"}},{"name":"address_4","in":"query","description":"The fourth line of the person's address","required":false,"schema":{"type":"string"}},{"name":"address_5","in":"query","description":"The fifth line of the person's address","required":false,"schema":{"type":"string"}},{"name":"address_6","in":"query","description":"The sixth line of the person's address","required":false,"schema":{"type":"string"}},{"name":"address_7","in":"query","description":"The seventh line of the person's address","required":false,"schema":{"type":"string"}},{"name":"unique_reference","in":"query","description":"The unique reference number associated to the supplied name and address","required":false,"schema":{"type":"string"}},{"name":"date_of_birth","in":"query","description":"The person's date of birth","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"description":"Whether the api call was successful"},"result":{"type":"object","properties":{"is_goneaway":{"type":"boolean","example":true,"description":"Has the person moved away from this address"},"unique_reference":{"type":"string","example":"Your reference","description":"The unique reference number associated to the supplied name and address"},"is_forwarding_address_included":{"type":"boolean","example":true,"description":"Is there a forwarding address"},"new_address":{"type":"object","properties":{"address_1":{"type":"string","example":"1C The High Street","description":"The first line of the customer's address"},"address_2":{"type":"string","example":"Example Village","description":"The second line of the address"},"address_3":{"type":"string","example":" ","description":"The third line of the address"},"address_4":{"type":"string","example":" ","description":"The fourth line of the address"},"address_5":{"type":"string","example":" ","description":"The fifth line of the address"},"address_6":{"type":"string","example":"ABERDEEN","description":"The sixth line of the address"},"address_7":{"type":"string","example":"AB12 3BC","description":"The seventh line of the address"}}},"source":{"type":"string","example":"Example Source","description":"The source of the data"},"move_date":{"type":"string","example":"2020-01-01","description":"The move date"}}},"error":{"type":"string","example":"If there is an error the message would go here","description":"Details of what went wrong with the api call"}}}}}}},"security":[{"x-api-key":[]}]}},"/solifi/inventoryaugmentationfromidscode/v2":{"get":{"tags":["Solifi "],"operationId":"solifi_inventoryaugmentationfromidscode","summary":"Inventory Augmentation from IDS Code","description":"This endpoint returns a vehicle from an IDS code and provides technical data and features based on date of registration. This endpoint returns a vehicle from an IDS code and provides technical data and features based on date of registration.","parameters":[{"name":"ids_code","in":"query","description":"IDS code","required":true,"schema":{"type":"string"}},{"name":"effective_date","in":"query","description":"Returns the features relevant to the chosen vehicle for that moment in time.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"description":"Whether the api call was successful"},"result":{"type":"object","properties":{"basic_vehicle_info":{"type":"object","properties":{"ids_code":{"type":"string","example":"AB012345","description":"The IDS Code."},"effective_date":{"type":"string","example":"2020-01-01","description":"Return the pricing relevant to the chosen vehicle for that moment in time."},"homologation_class":{"type":"string","example":"M1","description":"The homologation class"},"asset_type":{"type":"string","example":"car","description":"The asset type"},"manufacturer_desc":{"type":"string","example":"Volkswagen","description":"Manufacturer description"},"model_range_desc":{"type":"string","example":"TIGUAN","description":"Model range description"},"model_sub_range_desc":{"type":"string","example":"TIGUAN","description":"The model sub range description"},"derivative_desc":{"type":"string","example":"Tiguan 1.5 TSI 150 R-Line Edition DSG7","description":"EV Database’s model variant"},"vehicle_description":{"type":"string","example":"Volkswagen Tiguan 1.5 TSI 150 R-Line Edition DSG7","description":"The make, model and derivative description of the vehicle"},"full_model_year":{"type":"number","example":2021.25,"description":"The full model year"},"trim_level_desc":{"type":"string","example":"R LINE EDITION","description":"The trim level description"},"ids_body_type_desc":{"type":"string","example":"Station Wagon","description":"The IDS body type description"},"ids_expanded_body_type_desc":{"type":"string","example":"Medium Crossover/SUV","description":"The expanded IDS body type description"},"ids_fuel_type_desc":{"type":"string","example":"Petrol","description":"The IDS fuel type"},"ids_transmission_desc":{"type":"string","example":"Automatic","description":"The IDS transmission description"},"ids_drivetrain_type_desc":{"type":"string","example":"Front Wheel","description":"The IDS drivetrain description"},"number_seats":{"type":"integer","example":5,"description":"Number of seats"},"number_doors":{"type":"integer","example":5,"description":"The number of doors"},"number_gears":{"type":"integer","example":7,"description":"Number of gears"},"number_axles":{"type":"integer","example":2,"description":"The number of axles"}}},"insurance_data":{"type":"object","properties":{"insurance_group_1to50":{"type":"string","example":"50","description":"The 1-50 insurance group"}}},"performance_data":{"type":"object","properties":{"top_speed_mph":{"type":"integer","example":123,"description":"The top speed (mph)"},"0to60_mph":{"type":"number","example":12.3,"description":"The number of seconds to go from Zero to 60 mph"},"0to100_kmph":{"type":"number","example":12.3,"description":"The number of seconds to go from Zero to 100 kmph"}}},"weight_dimension_capacities_data":{"type":"object","properties":{"vehicle_length_mm":{"type":"integer","example":1234,"description":"The vehicle length in mm"},"vehicle_height_mm":{"type":"integer","example":1234,"description":"The vehicle height in mm"},"vehicle_width_mm":{"type":"integer","example":1234,"description":"The vehicle width in mm"},"vehicle_wheelbase_mm":{"type":"integer","example":1234,"description":"The vehicle wheelbase in mm"},"ground_clearance_mm":{"type":"integer","example":123,"description":"The ground clearance in mm"},"bootspace_litres":{"type":"number","example":12.345678910112,"description":"The bootspace in litres"},"payload_length_mm":{"type":"integer","example":1234,"description":"The payload length in mm"},"payload_width_mm":{"type":"integer","example":1234,"description":"The payload width in mm"},"payload_height_mm":{"type":"integer","example":1234,"description":"The payload height in mm"},"payload_weight_kg":{"type":"integer","example":123,"description":"The payload weight in kg"},"payload_volume_cubicmetres":{"type":"integer","example":123,"description":"The payload volume in cubic metres"},"payload_width_between_wheel_arches_mm":{"type":"integer","example":1234,"description":"The payload width between wheel arches in mm"},"nose_weight_kg":{"type":"integer","example":123,"description":"The nose weight in kg"},"roof_load_limit_kg":{"type":"integer","example":123,"description":"The roof load limit in kg"},"turning_circle_kerb_to_kerb_metres":{"type":"number","example":12.3,"description":"The turning circle kerb to kerb in metres"},"min_kerbweight_kg":{"type":"integer","example":1234,"description":"Minimum kerbweight in kg"},"gross_vehicleweight_kg":{"type":"integer","example":1234,"description":"Gross vehicle weight in kg"},"max_braked_towing_weight_kg":{"type":"integer","example":123,"description":"Maximum braked towing weight in kg"},"max_unbraked_towing_weight_kg":{"type":"integer","example":123,"description":"Maximum unbraked towing weight in kg"}}},"engine_data":{"type":"object","properties":{"engine_capacity_cc":{"type":"integer","example":1234,"description":"Engine capacity in cc"},"fuel_delivery":{"type":"string","example":"Turbo","description":"The fuel delivery"},"fuel_capacity_litres":{"type":"integer","example":12,"description":"The fuel capacity in litres"},"is_ad_blue":{"type":"boolean","example":true,"description":"Does the vehicle have an ad blue tank"},"ad_blue_range_miles":{"type":"integer","example":123,"description":"The ad blue range"},"number_cylinders":{"type":"integer","example":3,"description":"The number of cylinders"},"cylinder_arrangement":{"type":"string","example":"4 Cylinder In-Line","description":"The cylinder arrangement"},"valves_per_cylinder":{"type":"integer","example":5,"description":"The valves per cylinder."},"power_ps":{"type":"integer","example":12,"description":"The power ps"},"power_bhp":{"type":"number","example":123.5,"description":"The power bhp"},"power_kw":{"type":"number","example":12.3456789101112,"description":"The maximum net power in kw"},"torque_nm":{"type":"integer","example":123,"description":"The engine torque in nm"},"torque_rpm":{"type":"integer","example":1234,"description":"The engine torque rpm."},"emission_class":{"type":"string","example":"Euro 6","description":"The emission class"},"rde_type":{"type":"integer","example":2,"description":"The rde type"},"co2_gkm":{"type":"integer","example":123,"description":"CO2 in g/km"},"nedc_extra_urban_mpg":{"type":"number","example":12.3,"description":"The NEDC number of miles per gallon B-road, A-road and motorway driving ICE"},"nedc_urban_mpg":{"type":"number","example":12.3,"description":"The NEDC number of miles per gallon city driving ICE and SCH"},"nedc_combined_mpg":{"type":"number","example":12.3,"description":"The NEDC Average miles per gallon between urban (city driving) and extra urban (B-road, A-road and motorway) driving ICE and SCH"},"wltp_low_mpg":{"type":"number","example":12.3,"description":"The WLTP number of miles per gallon tested under wltp at speeds up to 35mph"},"wltp_medium_mpg":{"type":"number","example":12.3,"description":"The WLTP number of miles per gallon tested under wltp at speeds up to 47mph"},"wltp_high_mpg":{"type":"number","example":12.3,"description":"The WLTP number of miles per gallon tested under wltp at speeds up to 60mph"},"wltp_extra_high_mpg":{"type":"number","example":12.3,"description":"The WLTP number of miles per gallon tested under wltp at speeds up to 81mph"},"wltp_combined_mpg":{"type":"number","example":12.3,"description":"The WLTP average number of miles per gallon tested under wltp (low, medium, high & extra high)"}}},"ev_data":{"type":"object","properties":{"battery_range_miles":{"type":"integer","example":123,"description":"The battery's range in miles"},"electric_consumption_miles_kwh_calculated":{"type":"integer","example":123,"description":"The electric vehicle's calculated consumption miles per kwh"},"battery_volts":{"type":"integer","example":123,"description":"Nominal battery voltage as defined by the manufacturer seats"},"battery_capacity_kwh":{"type":"integer","example":12,"description":"Battery capacity in kwh"},"battery_capacity_usable_kwh":{"type":"integer","example":12,"description":"Usable capacity (the amount of energy the car can actually draw on to propel itself) in kwh"},"is_battery_leased":{"type":"boolean","example":true,"description":"Is the battery leased"}}},"features_data":{"type":"array","items":{"properties":{"feature_desc":{"type":"string","example":"12Volt Socket in Front Centre Console","description":"The feature description"},"feature_generic_desc":{"type":"string","example":"12V Socket","description":"The feature generic description"},"feature_status":{"type":"string","example":"Optional","description":"The feature status (default options priced at '£0' & can be swapped for alternative option)"},"factory_code":{"type":"string","example":"1AB","description":"The factory code"},"feature_category":{"type":"string","example":"Audio and Communications","description":"The feature category"},"list_price_ex_vat":{"type":"number","example":123.45,"description":"The list price excluding VAT"},"list_price_vat":{"type":"number","example":12.34,"description":"The list price VAT"},"list_price_inc_vat":{"type":"number","example":123.45,"description":"The list price including VAT"}}}}}},"error":{"type":"string","example":"If there is an error the message would go here","description":"Details of what went wrong with the api call"}}}}}}},"security":[{"x-api-key":[]}]}},"/solifi/ppmfuelcost/v2":{"get":{"tags":["Solifi "],"operationId":"solifi_ppmfuelcost","summary":"PPM Fuel Cost (Solifi Licence)","description":"This endpoint returns the pence per mile fuel cost and total fuel cost per annum.","parameters":[{"name":"ids_code","in":"query","description":"IDS code","required":true,"schema":{"type":"string"}},{"name":"miles_per_annum","in":"query","description":"The expected annual mileage","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"description":"Whether the api call was successful"},"result":{"type":"object","properties":{"unit_costs":{"type":"object","properties":{"pence_per_kwh_electric":{"type":"number","example":12.34,"description":"The pence per kwh cost for electric vehicles."},"pence_per_kg_hydrogen":{"type":"number","example":12.34,"description":"The pence per kg cost for hydrogen vehicles."},"pence_per_litre_petrol":{"type":"number","example":12.34,"description":"The pence per litre cost for petrol vehicles."},"pence_per_litre_diesel":{"type":"number","example":12.34,"description":"The pence per litre cost for diesel vehicles."}}},"pence_per_mile":{"type":"number","example":12.34,"description":"The pence per mile cost."},"miles_per_annum":{"type":"integer","example":12345,"description":"The expected annual mileage"},"total_fuel_cost_per_annum":{"type":"number","example":12345,"description":"The total fuel cost per annum."},"ids_code":{"type":"string","example":"AB001234","description":"The IDS Code."}}},"error":{"type":"string","example":"If there is an error the message would go here","description":"Details of what went wrong with the api call"}}}}}}},"security":[{"x-api-key":[]}]}},"/solifi/vehiclelookupfromvrm/v2":{"get":{"tags":["Solifi "],"operationId":"solifi_vehiclelookupfromvrm","summary":"IDS Code from VRM","description":"This endpoint returns Solifi's basic vehicle information including the IDS Code. In addition, it returns the DVLA data block, including number of doors, seats, fuel type, body type, CO2, registration dates, VIN and scrappage status.","parameters":[{"name":"vehicle_registration_mark","in":"query","description":"Vehicle registration number","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"description":"Whether the api call was successful"},"result":{"type":"object","properties":{"solifi":{"type":"object","properties":{"ids_code":{"type":"string","example":"AB001234","description":"The IDS Code."},"introduced_date":{"type":"string","example":"2020-01-01","description":"The date the vehicle was available in the market from"},"engine_capacity_cc":{"type":"integer","example":1234,"description":"Engine capacity in cc"},"power_bhp":{"type":"number","example":123,"description":"The power bhp"},"ids_fuel_type":{"type":"string","example":"Petrol","description":"The IDS fuel type."},"fuel_delivery":{"type":"string","example":"Turbo","description":"The fuel delivery"},"ids_transmission_type":{"type":"string","example":"Manual","description":"The IDS transmission type."},"number_doors":{"type":"integer","example":5,"description":"The number of doors"},"ids_body_type_desc":{"type":"string","example":"Hatchback","description":"The IDS body type description"},"engine_configuration_type":{"type":"string","example":"4 Cylinder In-Line","description":"The engine configuration type."},"ids_drivetrain_desc":{"type":"string","example":"Front Wheel","description":"The IDS drivetrain description."},"ids_manufacturer_code":{"type":"string","example":"NI","description":"The IDS manufacturer code."},"manufacturer_desc":{"type":"string","example":"NISSAN","description":"Manufacturer description"},"ids_model_code":{"type":"string","example":"NIYF","description":"The IDS model code."},"ids_model_desc":{"type":"string","example":"Old QASHQAI model range","description":"The IDS model description."},"derivative_desc":{"type":"string","example":"QASHQAI HAT 1.6dCi ACENTA STOP/START","description":"EV Database’s model variant"},"model_desc":{"type":"string","example":"Qashqai","description":"The model description."},"ids_model_tree_desc":{"type":"string","example":"Old Qashqai","description":"The IDS model tree description."},"ids_derivative_tree_desc":{"type":"string","example":"1.6dCi Acenta Stop/Start","description":"The IDS derivative tree description."},"oem_model_range_desc":{"type":"string","example":"Qashqai Hatch","description":"The model range description as supplied by manufacturer"},"ids_model_year":{"type":"string","example":"12","description":"The IDS model year."},"full_model_year":{"type":"number","example":2020.25,"description":"The full model year"},"is_special_edition":{"type":"boolean","example":false,"description":"Is this a special edition vehicle."},"state":{"type":"string","example":"Old","description":"The vehicle model year status."},"is_commercial_vehicle":{"type":"boolean","example":false,"description":"Is this a commercial vehicle."},"P11D_price":{"type":"integer","example":12345,"description":"The list price including options and delivery including VAT."},"production_end_date":{"type":"string","example":"2020-01-01","description":"The date production of derivative ends."}}},"dvla":{"type":"object","properties":{"vehicle_registration_mark":{"type":"string","example":"AB21 ABC","description":"Vehicle registration number"},"dvla_body_desc":{"type":"string","example":"5 DOOR HATCHBACK","description":"DVLA body description"},"co2_gkm":{"type":"integer","example":123,"description":"CO2 in g/km"},"colour":{"type":"string","example":"RED","description":"Exterior colour of vehicle"},"cherished_plate_on_vehicle":{"type":"boolean","example":true,"description":"Is there a cherished plate on the vehicle."},"manufactured_date":{"type":"string","example":"2020-01-01","description":"The date of manufacture "},"first_registration_date":{"type":"string","example":"2020-01-01","description":"Date of first registration"},"dvla_manufacturer_desc":{"type":"string","example":"NISSAN","description":"DVLA manufacturer description"},"dvla_model_desc":{"type":"string","example":"QASHQAI ACENTA IS DCI","description":"DVLA model description"},"engine_number":{"type":"string","example":"A12345678","description":"Vehicle engine number"},"exported_date":{"type":"string","example":"2020-01-01","description":"Date vehicle was exported"},"is_exported":{"type":"boolean","example":false,"description":"Vehicle is exported"},"dvla_fuel_desc":{"type":"string","example":"DIESEL","description":"DVLA fuel description"},"imported_date":{"type":"string","example":"2020-01-01","description":"Date vehicle was imported"},"is_imported":{"type":"boolean","example":false,"description":"Vehicle is imported"},"is_imported_NI":{"type":"boolean","example":false,"description":"The vehicle is imported."},"previous_keeper_acquisition_date":{"type":"string","example":"2020-01-01","description":"The previous keepers acquisition date"},"previous_keeper_disposal_date":{"type":"string","example":"2020-01-01","description":"The date the previous keeper disposed of the vehicle."},"date_of_last_keeper_change":{"type":"string","example":"2020-01-01","description":"The date of last keeper change."},"date_Vic_issued":{"type":"string","example":"2020-01-01","description":"The date the Vic was issued."},"date_of_last_colour_change":{"type":"string","example":"2020-01-01","description":"Date of last colour change"},"min_kerbweight_kg":{"type":"integer","example":1234,"description":"Minimum kerbweight in kg"},"max_netpower_kw":{"type":"integer","example":12,"description":"Maximum net power in kw"},"maximum_permissable_mass_kg":{"type":"integer","example":1234,"description":"Maximum permissable mass in kg"},"mot_expiry_date":{"type":"string","example":"2020-01-01","description":"The MOT expiry date."},"mot_status":{"type":"string","example":"Valid","description":"The MOT status."},"keeper_changes_qty":{"type":"integer","example":1,"description":"The keeper change quantity."},"number_previous_colours":{"type":"integer","example":1,"description":"The number of previous colours"},"number_seats":{"type":"integer","example":5,"description":"Number of seats"},"power_weight_ratio_kw_kg":{"type":"number","example":12.34,"description":"Power to weight ratio kw per kg"},"is_scrapped":{"type":"boolean","example":false,"description":"Has the vehicle been scrapped."},"scrapped_date":{"type":"string","example":"2020-01-01","description":"The date the vehicle was scrapped."},"driveby_soundlevel_db":{"type":"integer","example":12,"description":"Driveby soundlevel in db"},"stationary_soundlevel_rpm":{"type":"integer","example":1234,"description":"Stationary sound level rpm"},"stationary_soundlevel_db":{"type":"integer","example":12,"description":"Stationary sound level in decibels"},"tax_expiry_date":{"type":"string","example":"2020-01-01","description":"The date the vehicle tax expires."},"tax_status":{"type":"string","example":"Taxed","description":"The tax status"},"max_braked_towing_weight_kg":{"type":"integer","example":1234,"description":"Maximum braked towing weight in kg"},"max_unbraked_towing_weight_kg":{"type":"integer","example":123,"description":"Maximum unbraked towing weight in kg"},"unscrapped":{"type":"boolean","example":false,"description":"The vehicle is marked as unscrapped."},"used_before_first_registration":{"type":"boolean","example":true,"description":"Vehicle was used before DVLA/DLNI first registration"},"date_v5c_issued":{"type":"string","example":"2020-01-01","description":"The date the v5 was issued"},"v5c_test_date":{"type":"string","example":"2020-01-01","description":"The v5c test date."},"gross_vehicleweight_kg":{"type":"integer","example":1234,"description":"Gross vehicle weight in kg"},"manufactured_year":{"type":"integer","example":2020,"description":"Year of manufacturer"},"vehicle_identification_number":{"type":"string","example":"ABCDE123456F78910","description":"The vehicle identification number."},"dvla_wheelplan":{"type":"string","example":"2 AXLE RIGID BODY","description":"DVLA wheelplan code where available"}}}}},"error":{"type":"string","example":"If there is an error the message would go here","description":"Details of what went wrong with the api call"}}}}}}},"security":[{"x-api-key":[]}]}},"/ukvehicledata/keeperchangefromvin/v2":{"get":{"tags":["UK Vehicle Data"],"operationId":"ukvehicledata_keeperchangefromvin","summary":"Keeper Change from VIN","description":"This endpoint identifies where a keeper change has occurred since a given date, returning UK Vehicle Data's key vehicle and basic provenance data.","parameters":[{"name":"vehicle_identification_number","in":"query","description":"Vehicle identification (VIN) number","required":true,"schema":{"type":"string"}},{"name":"last_seen_date","in":"query","description":"The date from which you would like to complete the check from","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"description":"Whether the api call was successful"},"result":{"type":"object","properties":{"keeper_change":{"type":"boolean","example":true,"description":"The has had a keeper change."},"date_of_last_keeper_change":{"type":"string","example":"2020-01-01","description":"The date of last keeper change."}}},"error":{"type":"string","example":"If there is an error the message would go here","description":"Details of what went wrong with the api call"}}}}}}},"security":[{"x-api-key":[]}]}},"/ukvehicledata/keeperchangefromvrm/v2":{"get":{"tags":["UK Vehicle Data"],"operationId":"ukvehicledata_keeperchangefromvrm","summary":"Keeper Change from VRM","description":"This endpoint identifies where a keeper change has occurred since a given date, returning UK Vehicle Data's key vehicle and basic provenance data.","parameters":[{"name":"vehicle_registration_mark","in":"query","description":"Vehicle registration number","required":true,"schema":{"type":"string"}},{"name":"last_seen_date","in":"query","description":"The date from which you would like to complete the check from","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"description":"Whether the api call was successful"},"result":{"type":"object","properties":{"keeper_change":{"type":"boolean","example":true,"description":"The has had a keeper change."},"date_of_last_keeper_change":{"type":"string","example":"2020-01-01","description":"The date of last keeper change."}}},"error":{"type":"string","example":"If there is an error the message would go here","description":"Details of what went wrong with the api call"}}}}}}},"security":[{"x-api-key":[]}]}},"/ukvehicledata/postcodelookup/v2":{"get":{"tags":["UK Vehicle Data"],"operationId":"ukvehicledata_postcodelookup","summary":"Postcode Lookup","description":"This endpoint returns an array of (one or more) addresses for a given postcode.","parameters":[{"name":"post_code","in":"query","description":"The postcode","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"description":"Whether the api call was successful"},"result":{"type":"object","properties":{"address_details":{"type":"object","properties":{"address_qty":{"type":"integer","example":1,"description":"The number of addresses returned"},"address_list":{"type":"array","items":{"properties":{"unique_delivery_point_reference_number":{"type":"integer","example":12345,"description":"The Royal Mail unique identifier for an address"},"address_summary":{"type":"string","example":"123456, Flat 4, ACME Motors, ACME House, 123 Fake Street, Fake Industrial Estate, York, North Yorkshire, AB21 ABC","description":"The summary address"},"address_details":{"type":"object","properties":{"organisation":{"type":"string","example":"ACME Motors","description":"The organisation name"},"premises":{"type":"string","example":"Flat 4, ACME House","description":"The premises' name"},"street":{"type":"string","example":"Fake Street","description":"Street"},"locality":{"type":"string","example":"Fake Industrial Estate","description":"The locality"},"city":{"type":"string","example":"York","description":"City"},"county":{"type":"string","example":"North Yorkshire","description":"County"},"post_code":{"type":"string","example":"AB21ABC","description":"Postcode"}}},"component_details":{"type":"object","properties":{"po_box_number":{"type":"integer","example":123456,"description":"The PO Box Number"},"sub_building_name":{"type":"string","example":"Flat 4","description":"The name of the sub-building for the address"},"building_name":{"type":"string","example":"ACME Mansion","description":"The name of the building"},"building_number":{"type":"integer","example":123,"description":"The building number"},"thoroughfare":{"type":"string","example":"Main Street","description":"The name of the main street"},"street":{"type":"string","example":"Fake Street","description":"Street"}}}}}},"license_notice":{"type":"string","example":"Usage of the AddressList data must be in accordance with the Royal Mail's PAF Data end user license terms, which can be found here: https://ukvehicledata.co.uk/policies/PAFLicencingEUA/PAFLicencingEUA.pdf","description":"The street name"}}}}},"error":{"type":"string","example":"If there is an error the message would go here","description":"Details of what went wrong with the api call"}}}}}}},"security":[{"x-api-key":[]}]}},"/ukvehicledata/scrappedmarkercheckfromvin/v2":{"get":{"tags":["UK Vehicle Data"],"operationId":"ukvehicledata_scrappedmarkercheckfromvin","summary":"Scrap Marker Check from VIN","description":"This endpoint identifies where a vehicle is marked as scrapped and when the marker was applied.","parameters":[{"name":"vehicle_identification_number","in":"query","description":"Vehicle identification (VIN) number","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"description":"Whether the api call was successful"},"result":{"type":"object","properties":{"vehicle_registration_mark":{"type":"string","example":"AB21ABC","description":"Vehicle registration number"},"vehicle_identification_number":{"type":"string","example":"ABCDE123456F78910","description":"The vehicle identification number."},"is_scrapped":{"type":"boolean","example":true,"description":"Has the vehicle been scrapped."},"scrapped_date":{"type":"string","example":"2020-01-01","description":"The date the vehicle was scrapped."}}},"error":{"type":"string","example":"If there is an error the message would go here","description":"Details of what went wrong with the api call"}}}}}}},"security":[{"x-api-key":[]}]}},"/ukvehicledata/scrappedmarkercheckfromvrm/v2":{"get":{"tags":["UK Vehicle Data"],"operationId":"ukvehicledata_scrappedmarkercheckfromvrm","summary":"Scrap Marker Check from VRM","description":"This endpoint identifies where a vehicle is marked as scrapped and when the marker was applied.","parameters":[{"name":"vehicle_registration_mark","in":"query","description":"Vehicle registration number","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"description":"Whether the api call was successful"},"result":{"type":"object","properties":{"vehicle_registration_mark":{"type":"string","example":"AB21ABC","description":"Vehicle registration number"},"vehicle_identification_number":{"type":"string","example":"ABCDE123456F78910","description":"The vehicle identification number."},"is_scrapped":{"type":"boolean","example":true,"description":"Has the vehicle been scrapped."},"scrapped_date":{"type":"string","example":"2020-01-01","description":"The date the vehicle was scrapped."}}},"error":{"type":"string","example":"If there is an error the message would go here","description":"Details of what went wrong with the api call"}}}}}}},"security":[{"x-api-key":[]}]}},"/ukvehicledata/stolenvehiclecheckfromvin/v2":{"get":{"tags":["UK Vehicle Data"],"operationId":"ukvehicledata_stolenvehiclecheckfromvin","summary":"Stolen Vehicle Check from VIN","description":"This endpoint identifies whether the vehicle is returned by UKVD as marked stolen on the Police National Computer.","parameters":[{"name":"vehicle_identification_number","in":"query","description":"Vehicle identification (VIN) number","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"description":"Whether the api call was successful"},"result":{"type":"object","properties":{"stolen_status":{"type":"object","properties":{"is_stolen":{"type":"boolean","example":true,"description":"Is the vehicle stolen"},"date_reported":{"type":"string","example":"2020-01-01","description":"The date vehicle was reported as stolen."},"datetime_added_pnc":{"type":"string","example":"2020-01-01T08:00:02Z","description":"The date and time the vehicle was added to the police national computer"},"police_force":{"type":"string","example":"COUNTY POLICE","description":"The investigating police force."}}}}},"error":{"type":"string","example":"If there is an error the message would go here","description":"Details of what went wrong with the api call"}}}}}}},"security":[{"x-api-key":[]}]}},"/ukvehicledata/stolenvehiclecheckfromvrm/v2":{"get":{"tags":["UK Vehicle Data"],"operationId":"ukvehicledata_stolenvehiclecheckfromvrm","summary":"Stolen Vehicle Check from VRM","description":"This endpoint identifies whether the vehicle is returned by UKVD as marked stolen on the Police National Computer.","parameters":[{"name":"vehicle_registration_mark","in":"query","description":"Vehicle registration number","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"description":"Whether the api call was successful"},"result":{"type":"object","properties":{"stolen_status":{"type":"object","properties":{"is_stolen":{"type":"boolean","example":true,"description":"Is the vehicle stolen"},"date_reported":{"type":"string","example":"2020-01-01","description":"The date vehicle was reported as stolen."},"datetime_added_pnc":{"type":"string","example":"2020-01-01T08:00:02Z","description":"The date and time the vehicle was added to the police national computer"},"police_force":{"type":"string","example":"COUNTY POLICE","description":"The investigating police force."}}}}},"error":{"type":"string","example":"If there is an error the message would go here","description":"Details of what went wrong with the api call"}}}}}}},"security":[{"x-api-key":[]}]}},"/ukvehicledata/vehicleandmodeldetailsfromvin/v2":{"get":{"tags":["UK Vehicle Data"],"operationId":"ukvehicledata_vehicleandmodeldetailsfromvin","summary":"Vehicle and Model Details from VIN","description":"This endpoint return UK Vehicle Data model and DVLA registration data.","parameters":[{"name":"vehicle_registration_mark","in":"query","description":"Vehicle registration number","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"description":"Whether the api call was successful"},"result":{"type":"object","properties":{"vehicle_details":{"type":"object","properties":{"vehicle_identification":{"type":"object","properties":{"ukvd_id":{"type":"string","example":"A-BCDEFG","description":"UK Vehicle Data's UKVD ID"},"ukvd_uvc":{"type":"string","example":"A-BCDEFG","description":"UK Vehicle Data's UKVD UVC"},"vehicle_registration_mark":{"type":"string","example":"AB21ABC","description":"Vehicle registration number"},"vehicle_identification_number":{"type":"string","example":"ABCDE123456F78910","description":"The vehicle identification number."},"dvla_manufacturer_desc":{"type":"string","example":"NISSAN","description":"DVLA manufacturer description"},"dvla_model_desc":{"type":"string","example":"QASHQAI ACENTA PREMIUM DCI","description":"DVLA model description"},"dvla_wheelplan":{"type":"string","example":"2 AXLE RIGID BODY","description":"DVLA wheelplan code where available"},"registration_date":{"type":"string","example":"2020-01-01","description":"Date the vehicle was first registered in the UK"},"first_registration_date":{"type":"string","example":"2020-01-01","description":"Date of first registration"},"used_before_first_registration":{"type":"boolean","example":true,"description":"Vehicle was used before DVLA/DLNI first registration"},"manufactured_year":{"type":"integer","example":2020,"description":"Year of manufacturer"},"v5c_qty":{"type":"integer","example":1,"description":"The v5c quantity"},"date_v5c_issued":{"type":"string","example":"2020-01-01","description":"The date the v5 was issued"},"engine_number":{"type":"string","example":"A12345678","description":"Vehicle engine number"},"prior_ni_vrm":{"type":"string","example":"ABC1234","description":"Previous NI vehicle registration mark"},"dvla_body_desc":{"type":"string","example":"5 DOOR HATCHBACK","description":"DVLA body description"},"dvla_fuel_desc":{"type":"string","example":"DIESEL","description":"DVLA fuel description"}}},"vehicle_status_details":{"type":"object","properties":{"is_non_eu_import":{"type":"boolean","example":true,"description":"Vehicle is non-eu import"},"is_imported":{"type":"boolean","example":true,"description":"Vehicle is imported"},"certificate_of_destruction_issued":{"type":"boolean","example":true,"description":"Has a certificate of destruction been issued."},"is_exported":{"type":"boolean","example":true,"description":"Vehicle is exported"},"exported_date":{"type":"string","example":"2020-01-01","description":"Date vehicle was exported"},"is_scrapped":{"type":"boolean","example":true,"description":"Has the vehicle been scrapped."},"scrapped_date":{"type":"string","example":"2020-01-01","description":"The date the vehicle was scrapped."}}},"vehicle_excise_duty_details":{"type":"object","properties":{"co2_gkm":{"type":"integer","example":123,"description":"CO2 in g/km"},"dvla_co2_band":{"type":"string","example":"A","description":"The DVLA co2 band"},"12_month_rfl_y1":{"type":"number","example":123,"description":"The year one 12 month Road Fund Licence"},"6_month_rfl_y2_to_y6_premium":{"type":"number","example":123.4,"description":"The year two to year six 6 month Road Fund Licence for vehicles over £40k"},"12_month_rfl_y2_to_y6_premium":{"type":"number","example":123,"description":"The year two to year six 12 month Road Fund Licence for vehicles over £40k"},"6_month_rfl_y2_to_y6":{"type":"number","example":12,"description":"The year two to year six 12 month Road Fund Licence"},"12_month_rfl_y2_to_y6":{"type":"number","example":123,"description":"The year two to year six 12 month Road Fund Licence"}}},"colour_details":{"type":"object","properties":{"colour":{"type":"string","example":"RED","description":"Exterior colour of vehicle"},"colour_changes_qty":{"type":"integer","example":1,"description":"The colour change quantity"},"original_colour":{"type":"string","example":"BLUE","description":"The vehicle's original colour"},"last_colour":{"type":"string","example":"RED","description":"The vehicle's last colour"},"date_of_last_colour_change":{"type":"string","example":"2020-01-01","description":"Date of last colour change"}}},"keeper_change_list":{"type":"array","items":{"properties":{"number_previous_keepers":{"type":"integer","example":1,"description":"The number of previous keepers."},"date_of_last_keeper_change":{"type":"string","example":"2020-01-01","description":"The date of last keeper change."}}}},"plate_change_list":{"type":"array","items":{"properties":{"current_vehicle_registration_mark":{"type":"string","example":"AB21ABC","description":"Current vehicle registration mark"},"transfer_type":{"type":"string","example":"DataMove","description":"Transfer type"},"date_of_receipt":{"type":"string","example":"2020-01-01","description":"The recorded date of transfer at DVLA."},"previous_vehicle_registration_mark":{"type":"string","example":"AB21ABC","description":"The previous registration mark."},"cherished_plate_transfer_date":{"type":"string","example":"2020-01-01","description":"The date record was last updated."}}}}}},"model_details":{"type":"object","properties":{"ukvd_variant_code":{"type":"integer","example":1,"description":"The code number identifying the vehicle (model) variant."},"model_data":{"type":"object","properties":{"manufacturer_desc":{"type":"string","example":"MINI","description":"Manufacturer description"},"model_range_desc":{"type":"string","example":"Convertible","description":"Model range description"},"model_desc":{"type":"string","example":"Cooper D","description":"The model description."},"model_variant":{"type":"string","example":"SPRINTER 516 CDI","description":"The model variant."},"ukvd_series_desc":{"type":"string","example":"A12","description":"The UKVD series description."},"ukvd_mark":{"type":"integer","example":6,"description":"The UKVD manufacturer’s mark. Where no mark is used ‘1’ will be returned."},"model_start_date":{"type":"string","example":"2020-01-01","description":"The date derivative was introduced."},"model_end_date":{"type":"string","example":"2020-01-01","description":"The date derivative was discontinued."},"emission_class":{"type":"string","example":"Euro 6","description":"The emission class"},"country_of_origin":{"type":"string","example":"United Kingdom","description":"The country the vehicle was manufactured in"},"ukvd_fuel_type_desc":{"type":"string","example":"Diesel","description":"The UK Vehicle Data fuel type."},"cab_type_desc":{"type":"string","example":"Crew Cab","description":"The cab type"},"type_approval_category":{"type":"string","example":"M1","description":"The type approval category."},"market_sector_code":{"type":"string","example":"AA","description":"The market sector code."},"vehicle_type":{"type":"string","example":"Car","description":"Vehicle type"},"vehicle_taxation_class":{"type":"string","example":"Car","description":"The vehicle taxation class."}}},"body_details":{"type":"object","properties":{"ukvd_body_shape":{"type":"string","example":"Standard Roof","description":"The UK Vehicle Data body shape."},"ukvd_body_type_desc":{"type":"string","example":"SUV Estate","description":"The UK Vehicle Data body type description."},"fuel_capacity_litres":{"type":"integer","example":12,"description":"The fuel capacity in litres"},"number_axles":{"type":"integer","example":2,"description":"The number of axles"},"number_doors":{"type":"integer","example":5,"description":"The number of doors"},"number_seats":{"type":"integer","example":5,"description":"Number of seats"},"payload_volume_square_metres":{"type":"integer","example":12,"description":"The payload volume in square metres."},"wheelbase_type_desc":{"type":"string","example":"Long Wheelbase","description":"The wheelbase type description"},"platform_desc":{"type":"string","example":"MLB","description":"The platform description."},"is_platform_shared":{"type":"boolean","example":false,"description":"Is the platform shared."}}},"dimensions":{"type":"object","properties":{"vehicle_height_mm":{"type":"integer","example":1234,"description":"The vehicle height in mm"},"vehicle_length_mm":{"type":"integer","example":1234,"description":"The vehicle length in mm"},"vehicle_width_mm":{"type":"integer","example":1234,"description":"The vehicle width in mm"},"vehicle_wheelbase_mm":{"type":"integer","example":1234,"description":"The vehicle wheelbase in mm"},"load_length_mm":{"type":"integer","example":1234,"description":"The load length in mm."}}},"weights":{"type":"object","properties":{"min_kerbweight_kg":{"type":"integer","example":1234,"description":"Minimum kerbweight in kg"},"gross_trainweight_kg":{"type":"integer","example":1234,"description":"The gross train weight in kg"},"unladen_weight_kg":{"type":"integer","example":1234,"description":"The unladen weight in kg."},"payload_weight_kg":{"type":"integer","example":1234,"description":"The payload weight in kg"},"gross_vehicleweight_kg":{"type":"integer","example":1234,"description":"Gross vehicle weight in kg"},"gross_combined_weight_kg":{"type":"integer","example":1234,"description":"The gross combined weight in kg."}}},"power_source":{"type":"object","properties":{"power_source_vehicle_type":{"type":"string","example":"ICE","description":"The power source vehicle type."},"ice_details":{"type":"object","properties":{"engine_family":{"type":"string","example":"EA89","description":"The power source vehicle type."},"engine_stroke_mm":{"type":"integer","example":12,"description":"The engine stroke in mm"},"valves_per_cylinder":{"type":"integer","example":4,"description":"The valves per cylinder."},"aspiration":{"type":"string","example":"Naturally aspirated","description":"Aspiration."},"number_cylinders":{"type":"integer","example":6,"description":"The number of cylinders"},"engine_location":{"type":"string","example":"Front","description":"The engine location."},"cylinder_arrangement":{"type":"string","example":"V","description":"The cylinder arrangement"},"valve_gear":{"type":"string","example":"DOHC","description":"The type of valve gear"},"ukvd_engine_desc":{"type":"string","example":"3.0LT TDV6-C","description":"The UK Vehicle Data engine description."},"engine_bore_mm":{"type":"integer","example":12,"description":"The engine bore in mm"},"engine_manufacturer":{"type":"string","example":"Ford","description":"The engine manufacturer"},"fuel_delivery":{"type":"string","example":"Injection","description":"The fuel delivery"},"power_delivery":{"type":"string","example":"Normal","description":"The power delivery."},"engine_capacity_cc":{"type":"integer","example":1234,"description":"Engine capacity in cc"},"engine_badged_size_litres":{"type":"number","example":1.2,"description":"The engine badged size in litres"}}},"electric_details":{"type":"object","properties":{"hardware":{"type":"object","properties":{"platform_shared":{"type":"boolean","example":false,"description":"Is the platform shared."},"platform_name":{"type":"string","example":"2022 JAGUAR, F-PACE S PHEV AWD AUTO","description":"The platform name."},"tesla_supercharger_compatible":{"type":"boolean","example":true,"description":"Is compatible with Tesla Supercharger."},"manufacturing_location":{"type":"string","example":"Poland","description":"The manufacturing location."}}},"vehicle_warranty_information":{"type":"object","properties":{"manufacturer_vehicle_warranty_miles":{"type":"integer","example":12345,"description":"The manufacturer's vehicle warranty miles."},"manufacturer_vehicle_warranty_months":{"type":"integer","example":12,"description":"The manufacturer's vehicle warranty months."}}},"range_figures":{"type":"object","properties":{"ukvd_real_electric_range_miles":{"type":"integer","example":123,"description":"UK Vehicle Data's electric range in miles."},"ukvd_real_electric_range_km":{"type":"number","example":123.4,"description":"UK Vehicle Data's electric range in kms."},"fast_charger_chargespeed_10to80_percent_mph":{"type":"number","example":123,"description":"UK Vehicle Data’s miles per charge hour."},"zero_emission_mileage":{"type":"integer","example":123,"description":"The maximum distance in miles that can be driven in electric mode without recharging the battery."},"ev_range_test_cycles":{"type":"array","items":{"properties":{"ev_range_test_type":{"type":"string","example":"WLTP","description":"The EV range test type."},"range_combined_miles":{"type":"integer","example":123,"description":"The combined range miles."},"range_combined_km":{"type":"number","example":123.45,"description":"The combined range in kms."},"range_city_miles":{"type":"integer","example":123,"description":"The city range in miles."},"range_city_km":{"type":"number","example":123.45,"description":"The city range in kms."}}}}}},"economy":{"type":"object","properties":{"max_kw_charge_input":{"type":"integer","example":12,"description":"The maximum kw charge."},"drag_coefficient":{"type":"number","example":0.12,"description":"The vehicle's drag coefficient."},"watt_hour_miles":{"type":"integer","example":123,"description":"The number of watt hours per mile."}}},"software":{"type":"object","properties":{"ota_upgradeable":{"type":"boolean","example":true,"description":"The software can be upgraded over-the-air."},"latest_ota_version":{"type":"string","example":"2022.36.2","description":"The latest version of the over-the-air software."},"in_vehicle_software":{"type":"string","example":"Example Android","description":"The vehicle infotainment software."}}},"charge_cable_list":{"type":"array","items":{"properties":{"is_standard":{"type":"boolean","example":true,"description":"Is the charge cable supplied as standard or optional."},"charge_cable_desc":{"type":"string","example":"3 pin plug","description":"The charge cable description."}}}},"tesla_supercharger_list":{"type":"array","items":{"properties":{"supercharger_max_charge_kw":{"type":"integer","example":123,"description":"The maximum charge for Tesla charger in kw."},"is_standard":{"type":"boolean","example":true,"description":"Is the charge cable supplied as standard or optional."},"requires_ccs_adaptor":{"type":"boolean","example":true,"description":"The Vehicle requires CCS adaptor."},"average_chargetime_10to80_percent_mins":{"type":"integer","example":123,"description":"The average charge time from 10% to 80% in minutes."}}}},"battery_detail_list":{"type":"array","items":{"properties":{"badged_battery_capacity_kwh":{"type":"integer","example":12,"description":"The badged battery capacity in kwh."},"battery_description":{"type":"string","example":"Audi E-tron 71kWh","description":"The battery description."},"battery_type":{"type":"string","example":"Lithium-Ion 375V","description":"Battery type"},"battery_volts":{"type":"integer","example":123,"description":"Nominal battery voltage as defined by the manufacturer seats"},"battery_location":{"type":"string","example":"Under Floor/Middle","description":"The battery location."},"battery_warranty_months":{"type":"integer","example":12,"description":"The battery warranty months."},"battery_warranty_mileage":{"type":"integer","example":123456,"description":"Battery warranty in miles"}}}},"charge_port_detail_list":{"type":"array","items":{"properties":{"charge_port_type":{"type":"string","example":"Type 2","description":"The charge port type."},"charge_port_location":{"type":"string","example":"Left/Front","description":"The charge port location."},"onboard_charger_max_power_kw":{"type":"integer","example":12,"description":"The kw maximum power for onboard charger."},"is_standard_charge_port":{"type":"boolean","example":true,"description":"Is the charge port standard."},"charge_times":{"type":"object","properties":{"average_charge_times_10_to_80_percent":{"type":"array","items":{"properties":{"electric_vehicle_supply_equipment_power_kw":{"type":"number","example":2.3,"description":"The electric vehicle supply equipment in kw."},"chargetime_mins":{"type":"integer","example":1234,"description":"The charge time in minutes."}}}}}}}}},"electric_motor_detail_list":{"type":"array","items":{"properties":{"manufacturer":{"type":"string","example":"Audi","description":"The electric motor manufacturer."},"motor_model":{"type":"string","example":"E-Tron","description":"The motor model."},"motor_type":{"type":"string","example":"Permanent magnet synchronous","description":"The motor type."},"max_netpower_kw":{"type":"integer","example":215,"description":"Maximum net power in kw"},"power_rpm":{"type":"integer","example":12,"description":"The power rpm."},"torque_nm":{"type":"integer","example":123,"description":"The engine torque in nm"},"is_regen_braking":{"type":"boolean","example":true,"description":"Does the vehicle have regenerative braking."},"motor_location":{"type":"string","example":"Front","description":"The location of the motor."},"driving_axle":{"type":"string","example":"Front","description":"The driving axle."},"additional_information":{"type":"string","example":"Example additional information","description":"Any additional information."}}}},"transmission_detail_list":{"type":"array","items":{"properties":{"transmission_type":{"type":"string","example":"Automatic","description":"The transmission type."},"number_gears":{"type":"integer","example":1,"description":"Number of gears"},"transmission_location":{"type":"string","example":"Front","description":"The transmission location."}}}}}}}},"euro_ncap":{"type":"object","properties":{"ncap_overall_rating":{"type":"integer","example":5,"description":"The NCAP overall rating."},"ncap_child_occupant_protection_percentage":{"type":"integer","example":12,"description":"The NCAP child occupant protection percentage."},"ncap_adult_occupant_protection_percentage":{"type":"integer","example":12,"description":"The NCAP adult occupant protection percentage."},"ncap_pedestrian_protection_percentage":{"type":"integer","example":12,"description":"The NCAP pedestrian protection percentage."},"ncap_safety_assist_percentage":{"type":"integer","example":12,"description":"The NCAP safety assist percentage."}}},"emissions":{"type":"object","properties":{"is_fuel_catalyst":{"type":"boolean","example":false,"description":"The vehicle has fuel catalyst fitted."},"co2_gkm":{"type":"integer","example":12,"description":"CO2 in g/km"}}},"performance":{"type":"object","properties":{"torque":{"type":"object","properties":{"torque_nm":{"type":"integer","example":123,"description":"The engine torque in nm"},"torque_lbft":{"type":"number","example":123.5,"description":"The engine torque in lb-ft"},"torque_rpm":{"type":"integer","example":1234,"description":"The engine torque rpm."},"torque_derived_from":{"type":"integer","example":123,"description":"The base figure the torque_nm is derived or calculated from."}}},"power":{"type":"object","properties":{"power_bhp":{"type":"number","example":123.4,"description":"The power bhp"},"power_ps":{"type":"integer","example":123,"description":"The power ps"},"kilowatt":{"type":"integer","example":123,"description":"The power kilowatt."},"power_rpm":{"type":"integer","example":1234,"description":"The power rpm."}}},"statistics":{"type":"object","properties":{"0to60_mph":{"type":"number","example":123.5,"description":"The number of seconds to go from Zero to 60 mph"},"0to100_kmph":{"type":"number","example":123.4,"description":"The number of seconds to go from Zero to 100 kmph"},"max_speed_kmh":{"type":"number","example":123.4,"description":"The maximum speed in kmh."},"top_speed_mph":{"type":"integer","example":123,"description":"The top speed (mph)"}}}}},"fuel_economy":{"type":"object","properties":{"nedc_extra_urban_litres_100km":{"type":"number","example":12.3,"description":"The extra Urban fuel consumption in Litres per 100 kilometres."},"nedc_extra_urban_mpg":{"type":"number","example":12.3,"description":"The NEDC number of miles per gallon B-road, A-road and motorway driving ICE"},"nedc_extra_urban_cold_litres_100km":{"type":"number","example":12.3,"description":"The urban cold fuel consumption in Litres per 100 kms."},"nedc_extra_urban_cold_mpg":{"type":"number","example":12.3,"description":"The urban cold fuel consumption in Miles per Gallon."},"combined_litres_100km":{"type":"number","example":12.3,"description":"The combined fuel consumption in MPG."},"combined_mpg":{"type":"number","example":12.3,"description":"The combined fuel consumption in MPG."}}},"sound_levels":{"type":"object","properties":{"stationary_soundlevel_db":{"type":"integer","example":123,"description":"Stationary sound level in decibels"},"stationary_soundlevel_rpm":{"type":"integer","example":123,"description":"Stationary sound level rpm"},"driveby_soundlevel_db":{"type":"integer","example":123,"description":"Driveby soundlevel in db"}}},"transmission":{"type":"object","properties":{"driving_axle":{"type":"string","example":"All - Permanent","description":"The driving axle."},"number_gears":{"type":"integer","example":1,"description":"Number of gears"},"transmission_type":{"type":"string","example":"Automatic","description":"The transmission type."},"drive_type_desc":{"type":"string","example":"4X4","description":"The drive type description"}}}}}}},"error":{"type":"string","example":"If there is an error the message would go here","description":"Details of what went wrong with the api call"}}}}}}},"security":[{"x-api-key":[]}]}},"/ukvehicledata/vehicleandmodeldetailsfromvrm/v2":{"get":{"tags":["UK Vehicle Data"],"operationId":"ukvehicledata_vehicleandmodeldetailsfromvrm","summary":"Vehicle and Model Details from VRM","description":"This endpoint return UK Vehicle Data model and DVLA registration data.","parameters":[{"name":"vehicle_registration_mark","in":"query","description":"Vehicle registration number","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"description":"Whether the api call was successful"},"result":{"type":"object","properties":{"vehicle_details":{"type":"object","properties":{"vehicle_identification":{"type":"object","properties":{"ukvd_id":{"type":"string","example":"A-BCDEFG","description":"UK Vehicle Data's UKVD ID"},"ukvd_uvc":{"type":"string","example":"A-BCDEFG","description":"UK Vehicle Data's UKVD UVC"},"vehicle_registration_mark":{"type":"string","example":"AB21ABC","description":"Vehicle registration number"},"vehicle_identification_number":{"type":"string","example":"ABCDE123456F78910","description":"The vehicle identification number."},"dvla_manufacturer_desc":{"type":"string","example":"NISSAN","description":"DVLA manufacturer description"},"dvla_model_desc":{"type":"string","example":"QASHQAI ACENTA PREMIUM DCI","description":"DVLA model description"},"dvla_wheelplan":{"type":"string","example":"2 AXLE RIGID BODY","description":"DVLA wheelplan code where available"},"registration_date":{"type":"string","example":"2020-01-01","description":"Date the vehicle was first registered in the UK"},"first_registration_date":{"type":"string","example":"2020-01-01","description":"Date of first registration"},"used_before_first_registration":{"type":"boolean","example":true,"description":"Vehicle was used before DVLA/DLNI first registration"},"manufactured_year":{"type":"integer","example":2020,"description":"Year of manufacturer"},"v5c_qty":{"type":"integer","example":1,"description":"The v5c quantity"},"date_v5c_issued":{"type":"string","example":"2020-01-01","description":"The date the v5 was issued"},"engine_number":{"type":"string","example":"A12345678","description":"Vehicle engine number"},"prior_ni_vrm":{"type":"string","example":"ABC1234","description":"Previous NI vehicle registration mark"},"dvla_body_desc":{"type":"string","example":"5 DOOR HATCHBACK","description":"DVLA body description"},"dvla_fuel_desc":{"type":"string","example":"DIESEL","description":"DVLA fuel description"}}},"vehicle_status_details":{"type":"object","properties":{"is_non_eu_import":{"type":"boolean","example":true,"description":"Vehicle is non-eu import"},"is_imported":{"type":"boolean","example":true,"description":"Vehicle is imported"},"certificate_of_destruction_issued":{"type":"boolean","example":true,"description":"Has a certificate of destruction been issued."},"is_exported":{"type":"boolean","example":true,"description":"Vehicle is exported"},"exported_date":{"type":"string","example":"2020-01-01","description":"Date vehicle was exported"},"is_scrapped":{"type":"boolean","example":true,"description":"Has the vehicle been scrapped."},"scrapped_date":{"type":"string","example":"2020-01-01","description":"The date the vehicle was scrapped."}}},"vehicle_excise_duty_details":{"type":"object","properties":{"co2_gkm":{"type":"integer","example":123,"description":"CO2 in g/km"},"dvla_co2_band":{"type":"string","example":"A","description":"The DVLA co2 band"},"12_month_rfl_y1":{"type":"number","example":123,"description":"The year one 12 month Road Fund Licence"},"6_month_rfl_y2_to_y6_premium":{"type":"number","example":123.4,"description":"The year two to year six 6 month Road Fund Licence for vehicles over £40k"},"12_month_rfl_y2_to_y6_premium":{"type":"number","example":123,"description":"The year two to year six 12 month Road Fund Licence for vehicles over £40k"},"6_month_rfl_y2_to_y6":{"type":"number","example":12,"description":"The year two to year six 12 month Road Fund Licence"},"12_month_rfl_y2_to_y6":{"type":"number","example":123,"description":"The year two to year six 12 month Road Fund Licence"}}},"colour_details":{"type":"object","properties":{"colour":{"type":"string","example":"RED","description":"Exterior colour of vehicle"},"colour_changes_qty":{"type":"integer","example":1,"description":"The colour change quantity"},"original_colour":{"type":"string","example":"BLUE","description":"The vehicle's original colour"},"last_colour":{"type":"string","example":"RED","description":"The vehicle's last colour"},"date_of_last_colour_change":{"type":"string","example":"2020-01-01","description":"Date of last colour change"}}},"keeper_change_list":{"type":"array","items":{"properties":{"number_previous_keepers":{"type":"integer","example":1,"description":"The number of previous keepers."},"date_of_last_keeper_change":{"type":"string","example":"2020-01-01","description":"The date of last keeper change."}}}},"plate_change_list":{"type":"array","items":{"properties":{"current_vehicle_registration_mark":{"type":"string","example":"AB21ABC","description":"Current vehicle registration mark"},"transfer_type":{"type":"string","example":"DataMove","description":"Transfer type"},"date_of_receipt":{"type":"string","example":"2020-01-01","description":"The recorded date of transfer at DVLA."},"previous_vehicle_registration_mark":{"type":"string","example":"AB21ABC","description":"The previous registration mark."},"cherished_plate_transfer_date":{"type":"string","example":"2020-01-01","description":"The date record was last updated."}}}}}},"model_details":{"type":"object","properties":{"ukvd_variant_code":{"type":"integer","example":1,"description":"The code number identifying the vehicle (model) variant."},"model_data":{"type":"object","properties":{"manufacturer_desc":{"type":"string","example":"MINI","description":"Manufacturer description"},"model_range_desc":{"type":"string","example":"Convertible","description":"Model range description"},"model_desc":{"type":"string","example":"Cooper D","description":"The model description."},"model_variant":{"type":"string","example":"SPRINTER 516 CDI","description":"The model variant."},"ukvd_series_desc":{"type":"string","example":"A12","description":"The UKVD series description."},"ukvd_mark":{"type":"integer","example":6,"description":"The UKVD manufacturer’s mark. Where no mark is used ‘1’ will be returned."},"model_start_date":{"type":"string","example":"2020-01-01","description":"The date derivative was introduced."},"model_end_date":{"type":"string","example":"2020-01-01","description":"The date derivative was discontinued."},"emission_class":{"type":"string","example":"Euro 6","description":"The emission class"},"country_of_origin":{"type":"string","example":"United Kingdom","description":"The country the vehicle was manufactured in"},"ukvd_fuel_type_desc":{"type":"string","example":"Diesel","description":"The UK Vehicle Data fuel type."},"cab_type_desc":{"type":"string","example":"Crew Cab","description":"The cab type"},"type_approval_category":{"type":"string","example":"M1","description":"The type approval category."},"market_sector_code":{"type":"string","example":"AA","description":"The market sector code."},"vehicle_type":{"type":"string","example":"Car","description":"Vehicle type"},"vehicle_taxation_class":{"type":"string","example":"Car","description":"The vehicle taxation class."}}},"body_details":{"type":"object","properties":{"ukvd_body_shape":{"type":"string","example":"Standard Roof","description":"The UK Vehicle Data body shape."},"ukvd_body_type_desc":{"type":"string","example":"SUV Estate","description":"The UK Vehicle Data body type description."},"fuel_capacity_litres":{"type":"integer","example":12,"description":"The fuel capacity in litres"},"number_axles":{"type":"integer","example":2,"description":"The number of axles"},"number_doors":{"type":"integer","example":5,"description":"The number of doors"},"number_seats":{"type":"integer","example":5,"description":"Number of seats"},"payload_volume_square_metres":{"type":"integer","example":12,"description":"The payload volume in square metres."},"wheelbase_type_desc":{"type":"string","example":"Long Wheelbase","description":"The wheelbase type description"},"platform_desc":{"type":"string","example":"MLB","description":"The platform description."},"is_platform_shared":{"type":"boolean","example":false,"description":"Is the platform shared."}}},"dimensions":{"type":"object","properties":{"vehicle_height_mm":{"type":"integer","example":1234,"description":"The vehicle height in mm"},"vehicle_length_mm":{"type":"integer","example":1234,"description":"The vehicle length in mm"},"vehicle_width_mm":{"type":"integer","example":1234,"description":"The vehicle width in mm"},"vehicle_wheelbase_mm":{"type":"integer","example":1234,"description":"The vehicle wheelbase in mm"},"load_length_mm":{"type":"integer","example":1234,"description":"The load length in mm."}}},"weights":{"type":"object","properties":{"min_kerbweight_kg":{"type":"integer","example":1234,"description":"Minimum kerbweight in kg"},"gross_trainweight_kg":{"type":"integer","example":1234,"description":"The gross train weight in kg"},"unladen_weight_kg":{"type":"integer","example":1234,"description":"The unladen weight in kg."},"payload_weight_kg":{"type":"integer","example":1234,"description":"The payload weight in kg"},"gross_vehicleweight_kg":{"type":"integer","example":1234,"description":"Gross vehicle weight in kg"},"gross_combined_weight_kg":{"type":"integer","example":1234,"description":"The gross combined weight in kg."}}},"power_source":{"type":"object","properties":{"power_source_vehicle_type":{"type":"string","example":"ICE","description":"The power source vehicle type."},"ice_details":{"type":"object","properties":{"engine_family":{"type":"string","example":"EA89","description":"The power source vehicle type."},"engine_stroke_mm":{"type":"integer","example":12,"description":"The engine stroke in mm"},"valves_per_cylinder":{"type":"integer","example":4,"description":"The valves per cylinder."},"aspiration":{"type":"string","example":"Naturally aspirated","description":"Aspiration."},"number_cylinders":{"type":"integer","example":6,"description":"The number of cylinders"},"engine_location":{"type":"string","example":"Front","description":"The engine location."},"cylinder_arrangement":{"type":"string","example":"V","description":"The cylinder arrangement"},"valve_gear":{"type":"string","example":"DOHC","description":"The type of valve gear"},"ukvd_engine_desc":{"type":"string","example":"3.0LT TDV6-C","description":"The UK Vehicle Data engine description."},"engine_bore_mm":{"type":"integer","example":12,"description":"The engine bore in mm"},"engine_manufacturer":{"type":"string","example":"Ford","description":"The engine manufacturer"},"fuel_delivery":{"type":"string","example":"Injection","description":"The fuel delivery"},"power_delivery":{"type":"string","example":"Normal","description":"The power delivery."},"engine_capacity_cc":{"type":"integer","example":1234,"description":"Engine capacity in cc"},"engine_badged_size_litres":{"type":"number","example":1.2,"description":"The engine badged size in litres"}}},"electric_details":{"type":"object","properties":{"hardware":{"type":"object","properties":{"platform_shared":{"type":"boolean","example":false,"description":"Is the platform shared."},"platform_name":{"type":"string","example":"2022 JAGUAR, F-PACE S PHEV AWD AUTO","description":"The platform name."},"tesla_supercharger_compatible":{"type":"boolean","example":true,"description":"Is compatible with Tesla Supercharger."},"manufacturing_location":{"type":"string","example":"Poland","description":"The manufacturing location."}}},"vehicle_warranty_information":{"type":"object","properties":{"manufacturer_vehicle_warranty_miles":{"type":"integer","example":12345,"description":"The manufacturer's vehicle warranty miles."},"manufacturer_vehicle_warranty_months":{"type":"integer","example":12,"description":"The manufacturer's vehicle warranty months."}}},"range_figures":{"type":"object","properties":{"ukvd_real_electric_range_miles":{"type":"integer","example":123,"description":"UK Vehicle Data's electric range in miles."},"ukvd_real_electric_range_km":{"type":"number","example":123.4,"description":"UK Vehicle Data's electric range in kms."},"fast_charger_chargespeed_10to80_percent_mph":{"type":"number","example":123,"description":"UK Vehicle Data’s miles per charge hour."},"zero_emission_mileage":{"type":"integer","example":123,"description":"The maximum distance in miles that can be driven in electric mode without recharging the battery."},"ev_range_test_cycles":{"type":"array","items":{"properties":{"ev_range_test_type":{"type":"string","example":"WLTP","description":"The EV range test type."},"range_combined_miles":{"type":"integer","example":123,"description":"The combined range miles."},"range_combined_km":{"type":"number","example":123.45,"description":"The combined range in kms."},"range_city_miles":{"type":"integer","example":123,"description":"The city range in miles."},"range_city_km":{"type":"number","example":123.45,"description":"The city range in kms."}}}}}},"economy":{"type":"object","properties":{"max_kw_charge_input":{"type":"integer","example":12,"description":"The maximum kw charge."},"drag_coefficient":{"type":"number","example":0.12,"description":"The vehicle's drag coefficient."},"watt_hour_miles":{"type":"integer","example":123,"description":"The number of watt hours per mile."}}},"software":{"type":"object","properties":{"ota_upgradeable":{"type":"boolean","example":true,"description":"The software can be upgraded over-the-air."},"latest_ota_version":{"type":"string","example":"2022.36.2","description":"The latest version of the over-the-air software."},"in_vehicle_software":{"type":"string","example":"Example Android","description":"The vehicle infotainment software."}}},"charge_cable_list":{"type":"array","items":{"properties":{"is_standard":{"type":"boolean","example":true,"description":"Is the charge cable supplied as standard or optional."},"charge_cable_desc":{"type":"string","example":"3 pin plug","description":"The charge cable description."}}}},"tesla_supercharger_list":{"type":"array","items":{"properties":{"supercharger_max_charge_kw":{"type":"integer","example":123,"description":"The maximum charge for Tesla charger in kw."},"is_standard":{"type":"boolean","example":true,"description":"Is the charge cable supplied as standard or optional."},"requires_ccs_adaptor":{"type":"boolean","example":true,"description":"The Vehicle requires CCS adaptor."},"average_chargetime_10to80_percent_mins":{"type":"integer","example":123,"description":"The average charge time from 10% to 80% in minutes."}}}},"battery_detail_list":{"type":"array","items":{"properties":{"badged_battery_capacity_kwh":{"type":"integer","example":12,"description":"The badged battery capacity in kwh."},"battery_description":{"type":"string","example":"Audi E-tron 71kWh","description":"The battery description."},"battery_type":{"type":"string","example":"Lithium-Ion 375V","description":"Battery type"},"battery_volts":{"type":"integer","example":123,"description":"Nominal battery voltage as defined by the manufacturer seats"},"battery_location":{"type":"string","example":"Under Floor/Middle","description":"The battery location."},"battery_warranty_months":{"type":"integer","example":12,"description":"The battery warranty months."},"battery_warranty_mileage":{"type":"integer","example":123456,"description":"Battery warranty in miles"}}}},"charge_port_detail_list":{"type":"array","items":{"properties":{"charge_port_type":{"type":"string","example":"Type 2","description":"The charge port type."},"charge_port_location":{"type":"string","example":"Left/Front","description":"The charge port location."},"onboard_charger_max_power_kw":{"type":"integer","example":12,"description":"The kw maximum power for onboard charger."},"is_standard_charge_port":{"type":"boolean","example":true,"description":"Is the charge port standard."},"charge_times":{"type":"object","properties":{"average_charge_times_10_to_80_percent":{"type":"array","items":{"properties":{"electric_vehicle_supply_equipment_power_kw":{"type":"number","example":2.3,"description":"The electric vehicle supply equipment in kw."},"chargetime_mins":{"type":"integer","example":1234,"description":"The charge time in minutes."}}}}}}}}},"electric_motor_detail_list":{"type":"array","items":{"properties":{"manufacturer":{"type":"string","example":"Audi","description":"The electric motor manufacturer."},"motor_model":{"type":"string","example":"E-Tron","description":"The motor model."},"motor_type":{"type":"string","example":"Permanent magnet synchronous","description":"The motor type."},"max_netpower_kw":{"type":"integer","example":215,"description":"Maximum net power in kw"},"power_rpm":{"type":"integer","example":12,"description":"The power rpm."},"torque_nm":{"type":"integer","example":123,"description":"The engine torque in nm"},"is_regen_braking":{"type":"boolean","example":true,"description":"Does the vehicle have regenerative braking."},"motor_location":{"type":"string","example":"Front","description":"The location of the motor."},"driving_axle":{"type":"string","example":"Front","description":"The driving axle."},"additional_information":{"type":"string","example":"Example additional information","description":"Any additional information."}}}},"transmission_detail_list":{"type":"array","items":{"properties":{"transmission_type":{"type":"string","example":"Automatic","description":"The transmission type."},"number_gears":{"type":"integer","example":1,"description":"Number of gears"},"transmission_location":{"type":"string","example":"Front","description":"The transmission location."}}}}}}}},"euro_ncap":{"type":"object","properties":{"ncap_overall_rating":{"type":"integer","example":5,"description":"The NCAP overall rating."},"ncap_child_occupant_protection_percentage":{"type":"integer","example":12,"description":"The NCAP child occupant protection percentage."},"ncap_adult_occupant_protection_percentage":{"type":"integer","example":12,"description":"The NCAP adult occupant protection percentage."},"ncap_pedestrian_protection_percentage":{"type":"integer","example":12,"description":"The NCAP pedestrian protection percentage."},"ncap_safety_assist_percentage":{"type":"integer","example":12,"description":"The NCAP safety assist percentage."}}},"emissions":{"type":"object","properties":{"is_fuel_catalyst":{"type":"boolean","example":false,"description":"The vehicle has fuel catalyst fitted."},"co2_gkm":{"type":"integer","example":12,"description":"CO2 in g/km"}}},"performance":{"type":"object","properties":{"torque":{"type":"object","properties":{"torque_nm":{"type":"integer","example":123,"description":"The engine torque in nm"},"torque_lbft":{"type":"number","example":123.5,"description":"The engine torque in lb-ft"},"torque_rpm":{"type":"integer","example":1234,"description":"The engine torque rpm."},"torque_derived_from":{"type":"integer","example":123,"description":"The base figure the torque_nm is derived or calculated from."}}},"power":{"type":"object","properties":{"power_bhp":{"type":"number","example":123.4,"description":"The power bhp"},"power_ps":{"type":"integer","example":123,"description":"The power ps"},"kilowatt":{"type":"integer","example":123,"description":"The power kilowatt."},"power_rpm":{"type":"integer","example":1234,"description":"The power rpm."}}},"statistics":{"type":"object","properties":{"0to60_mph":{"type":"number","example":123.5,"description":"The number of seconds to go from Zero to 60 mph"},"0to100_kmph":{"type":"number","example":123.4,"description":"The number of seconds to go from Zero to 100 kmph"},"max_speed_kmh":{"type":"number","example":123.4,"description":"The maximum speed in kmh."},"top_speed_mph":{"type":"integer","example":123,"description":"The top speed (mph)"}}}}},"fuel_economy":{"type":"object","properties":{"nedc_extra_urban_litres_100km":{"type":"number","example":12.3,"description":"The extra Urban fuel consumption in Litres per 100 kilometres."},"nedc_extra_urban_mpg":{"type":"number","example":12.3,"description":"The NEDC number of miles per gallon B-road, A-road and motorway driving ICE"},"nedc_extra_urban_cold_litres_100km":{"type":"number","example":12.3,"description":"The urban cold fuel consumption in Litres per 100 kms."},"nedc_extra_urban_cold_mpg":{"type":"number","example":12.3,"description":"The urban cold fuel consumption in Miles per Gallon."},"combined_litres_100km":{"type":"number","example":12.3,"description":"The combined fuel consumption in MPG."},"combined_mpg":{"type":"number","example":12.3,"description":"The combined fuel consumption in MPG."}}},"sound_levels":{"type":"object","properties":{"stationary_soundlevel_db":{"type":"integer","example":123,"description":"Stationary sound level in decibels"},"stationary_soundlevel_rpm":{"type":"integer","example":123,"description":"Stationary sound level rpm"},"driveby_soundlevel_db":{"type":"integer","example":123,"description":"Driveby soundlevel in db"}}},"transmission":{"type":"object","properties":{"driving_axle":{"type":"string","example":"All - Permanent","description":"The driving axle."},"number_gears":{"type":"integer","example":1,"description":"Number of gears"},"transmission_type":{"type":"string","example":"Automatic","description":"The transmission type."},"drive_type_desc":{"type":"string","example":"4X4","description":"The drive type description"}}}}}}},"error":{"type":"string","example":"If there is an error the message would go here","description":"Details of what went wrong with the api call"}}}}}}},"security":[{"x-api-key":[]}]}},"/ukvehicledata/vehicledetailsfromvin/v2":{"get":{"tags":["UK Vehicle Data"],"operationId":"ukvehicledata_vehicledetailsfromvin","summary":"Vehicle Details from VIN","description":"This endpoint return UK Vehicle Data basic vehicle, provenance and DVLA data.","parameters":[{"name":"vehicle_identification_number","in":"query","description":"Vehicle identification number","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"description":"Whether the api call was successful"},"result":{"type":"object","properties":{"vehicle_identification":{"type":"object","properties":{"ukvd_id":{"type":"string","example":"A-BCDEFG","description":"UK Vehicle Data's UKVD ID"},"uvc_id":{"type":"string","example":"A-BCDEF","description":"UK Vehicle Data's UVC Code"},"vehicle_registration_mark":{"type":"string","example":"AB21ABC","description":"Vehicle registration number"},"vehicle_identification_number":{"type":"string","example":"ABCDE123456F78910","description":"The vehicle identification number."},"dvla_manufacturer_desc":{"type":"string","example":"NISSAN","description":"DVLA manufacturer description"},"dvla_model_desc":{"type":"string","example":"QASHQAI ACENTA PREMIUM DCI","description":"DVLA model description"},"registration_date":{"type":"string","example":"2020-01-01","description":"Date the vehicle was first registered in the UK"},"first_registration_date":{"type":"string","example":"2020-01-01","description":"Date of first registration"},"used_before_first_registration":{"type":"boolean","example":true,"description":"Vehicle was used before DVLA/DLNI first registration"},"manufactured_year":{"type":"integer","example":2020,"description":"Year of manufacturer"},"v5c_qty":{"type":"integer","example":1,"description":"The v5c quantity"},"date_v5c_issued":{"type":"string","example":"2020-01-01","description":"The date the v5 was issued"},"engine_number":{"type":"string","example":"A12345678","description":"Vehicle engine number"},"prior_ni_vrm":{"type":"string","example":"ABC1234","description":"Previous NI vehicle registration mark"},"dvla_body_desc":{"type":"string","example":"5 DOOR HATCHBACK","description":"DVLA body description"},"dvla_fuel_desc":{"type":"string","example":"DIESEL","description":"DVLA fuel description"}}},"vehicle_status_details":{"type":"object","properties":{"is_non_eu_import":{"type":"boolean","example":true,"description":"Vehicle is non-eu import"},"is_imported":{"type":"boolean","example":true,"description":"Vehicle is imported"},"is_exported":{"type":"boolean","example":true,"description":"Vehicle is exported"},"exported_date":{"type":"string","example":"2020-01-01","description":"Date vehicle was exported"},"is_scrapped":{"type":"boolean","example":true,"description":"Has the vehicle been scrapped."},"scrapped_date":{"type":"string","example":"2020-01-01","description":"The date the vehicle was scrapped."}}},"vehicle_excise_duty_details":{"type":"object","properties":{"co2_gkm":{"type":"integer","example":123,"description":"CO2 in g/km"},"dvla_co2_band":{"type":"string","example":"A","description":"The DVLA co2 band"},"12_month_rfl_y1":{"type":"number","example":123,"description":"The year one 12 month Road Fund Licence"},"6_month_rfl_y2_to_y6_premium":{"type":"number","example":123.4,"description":"The year two to year six 6 month Road Fund Licence for vehicles over £40k"},"12_month_rfl_y2_to_y6_premium":{"type":"number","example":123,"description":"The year two to year six 12 month Road Fund Licence for vehicles over £40k"},"6_month_rfl_y2_to_y6":{"type":"number","example":12,"description":"The year two to year six 12 month Road Fund Licence"},"12_month_rfl_y2_to_y6":{"type":"number","example":123,"description":"The year two to year six 12 month Road Fund Licence"}}},"colour_details":{"type":"object","properties":{"colour":{"type":"string","example":"RED","description":"Exterior colour of vehicle"},"colour_changes_qty":{"type":"integer","example":1,"description":"The colour change quantity"},"original_colour":{"type":"string","example":"BLUE","description":"The vehicle's original colour"},"last_colour":{"type":"string","example":"BLUE","description":"The vehicle's last colour"},"date_of_last_colour_change":{"type":"string","example":"2020-01-01","description":"Date of last colour change"}}},"keeper_change_list":{"type":"array","items":{"properties":{"number_previous_keepers":{"type":"integer","example":1,"description":"The number of previous keepers."},"date_of_last_keeper_change":{"type":"string","example":"2020-01-01","description":"The date of last keeper change."}}}},"plate_change_list":{"type":"array","items":{"properties":{"current_vehicle_registration_mark":{"type":"string","example":"AB21ABC","description":"Current vehicle registration mark"},"transfer_type":{"type":"string","example":"DataMove","description":"Transfer type"},"date_of_receipt":{"type":"string","example":"2020-01-01","description":"The recorded date of transfer at DVLA."},"previous_vehicle_registration_mark":{"type":"string","example":"AB21ABC","description":"The previous registration mark."},"cherished_plate_transfer_date":{"type":"string","example":"2020-01-01","description":"The date record was last updated."}}}}}},"error":{"type":"string","example":"If there is an error the message would go here","description":"Details of what went wrong with the api call"}}}}}}},"security":[{"x-api-key":[]}]}},"/ukvehicledata/vehicledetailsfromvrm/v2":{"get":{"tags":["UK Vehicle Data"],"operationId":"ukvehicledata_vehicledetailsfromvrm","summary":"Vehicle Details from VRM","description":"This endpoint return UK Vehicle Data basic vehicle, provenance and DVLA data.","parameters":[{"name":"vehicle_registration_mark","in":"query","description":"Vehicle registration number","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"description":"Whether the api call was successful"},"result":{"type":"object","properties":{"vehicle_identification":{"type":"object","properties":{"ukvd_id":{"type":"string","example":"A-BCDEFG","description":"UK Vehicle Data's UKVD ID"},"uvc_id":{"type":"string","example":"A-BCDEF","description":"UK Vehicle Data's UVC Code"},"vehicle_registration_mark":{"type":"string","example":"AB21ABC","description":"Vehicle registration number"},"vehicle_identification_number":{"type":"string","example":"ABCDE123456F78910","description":"The vehicle identification number."},"dvla_manufacturer_desc":{"type":"string","example":"NISSAN","description":"DVLA manufacturer description"},"dvla_model_desc":{"type":"string","example":"QASHQAI ACENTA PREMIUM DCI","description":"DVLA model description"},"registration_date":{"type":"string","example":"2020-01-01","description":"Date the vehicle was first registered in the UK"},"first_registration_date":{"type":"string","example":"2020-01-01","description":"Date of first registration"},"used_before_first_registration":{"type":"boolean","example":true,"description":"Vehicle was used before DVLA/DLNI first registration"},"manufactured_year":{"type":"integer","example":2020,"description":"Year of manufacturer"},"v5c_qty":{"type":"integer","example":1,"description":"The v5c quantity"},"date_v5c_issued":{"type":"string","example":"2020-01-01","description":"The date the v5 was issued"},"engine_number":{"type":"string","example":"A12345678","description":"Vehicle engine number"},"prior_ni_vrm":{"type":"string","example":"ABC1234","description":"Previous NI vehicle registration mark"},"dvla_body_desc":{"type":"string","example":"5 DOOR HATCHBACK","description":"DVLA body description"},"dvla_fuel_desc":{"type":"string","example":"DIESEL","description":"DVLA fuel description"}}},"vehicle_status_details":{"type":"object","properties":{"is_non_eu_import":{"type":"boolean","example":true,"description":"Vehicle is non-eu import"},"is_imported":{"type":"boolean","example":true,"description":"Vehicle is imported"},"is_exported":{"type":"boolean","example":true,"description":"Vehicle is exported"},"exported_date":{"type":"string","example":"2020-01-01","description":"Date vehicle was exported"},"is_scrapped":{"type":"boolean","example":true,"description":"Has the vehicle been scrapped."},"scrapped_date":{"type":"string","example":"2020-01-01","description":"The date the vehicle was scrapped."}}},"vehicle_excise_duty_details":{"type":"object","properties":{"co2_gkm":{"type":"integer","example":123,"description":"CO2 in g/km"},"dvla_co2_band":{"type":"string","example":"A","description":"The DVLA co2 band"},"12_month_rfl_y1":{"type":"number","example":123,"description":"The year one 12 month Road Fund Licence"},"6_month_rfl_y2_to_y6_premium":{"type":"number","example":123.4,"description":"The year two to year six 6 month Road Fund Licence for vehicles over £40k"},"12_month_rfl_y2_to_y6_premium":{"type":"number","example":123,"description":"The year two to year six 12 month Road Fund Licence for vehicles over £40k"},"6_month_rfl_y2_to_y6":{"type":"number","example":12,"description":"The year two to year six 12 month Road Fund Licence"},"12_month_rfl_y2_to_y6":{"type":"number","example":123,"description":"The year two to year six 12 month Road Fund Licence"}}},"colour_details":{"type":"object","properties":{"colour":{"type":"string","example":"RED","description":"Exterior colour of vehicle"},"colour_changes_qty":{"type":"integer","example":1,"description":"The colour change quantity"},"original_colour":{"type":"string","example":"BLUE","description":"The vehicle's original colour"},"last_colour":{"type":"string","example":"BLUE","description":"The vehicle's last colour"},"date_of_last_colour_change":{"type":"string","example":"2020-01-01","description":"Date of last colour change"}}},"keeper_change_list":{"type":"array","items":{"properties":{"number_previous_keepers":{"type":"integer","example":1,"description":"The number of previous keepers."},"date_of_last_keeper_change":{"type":"string","example":"2020-01-01","description":"The date of last keeper change."}}}},"plate_change_list":{"type":"array","items":{"properties":{"current_vehicle_registration_mark":{"type":"string","example":"AB21ABC","description":"Current vehicle registration mark"},"transfer_type":{"type":"string","example":"DataMove","description":"Transfer type"},"date_of_receipt":{"type":"string","example":"2020-01-01","description":"The recorded date of transfer at DVLA."},"previous_vehicle_registration_mark":{"type":"string","example":"AB21ABC","description":"The previous registration mark."},"cherished_plate_transfer_date":{"type":"string","example":"2020-01-01","description":"The date record was last updated."}}}}}},"error":{"type":"string","example":"If there is an error the message would go here","description":"Details of what went wrong with the api call"}}}}}}},"security":[{"x-api-key":[]}]}}},"components":{"securitySchemes":{"x-api-key":{"type":"apiKey","name":"x-api-key","in":"header"}}}}