Introduction
This endpoint allows you to search for matching derivatives using a combination of text and parameters.
Header
When making calls to our API, include the following header:
x-api-key:your-api-key-here
Example Request
https://api.oneautoapi.com/brego/search?vehicle_desc=Mini Cooper&manufacturer_desc=MINI&model_range_desc=Cooper&first_registration_year=2022&fuel_type_desc=Petrol&transmission_desc=Manual&body_type_desc=Convertible&number_doors=5&0to100_kmph=8.1&engine_capacity_cc=1499&number_cylinders=3&power_bhp=134&number_gears=6&top_speed_mph=129
Example Sandbox Request
https://sandbox.oneautoapi.com/brego/search?vehicle_desc=Mini Cooper&manufacturer_desc=MINI&model_range_desc=Cooper&first_registration_year=2022&fuel_type_desc=Petrol&transmission_desc=Manual&body_type_desc=Convertible&number_doors=5&0to100_kmph=8.1&engine_capacity_cc=1499&number_cylinders=3&power_bhp=134&number_gears=6&top_speed_mph=129
Request Parameters
vehicle_desc
mandatory, string, e.g. Mini Cooper
The vehicle description
manufacturer_desc
optional, string, e.g. MINI
The manufacturer description
model_range_desc
optional, string, e.g. Cooper
The model range description
first_registration_year
mandatory, string, e.g. 2022
Year of registration
fuel_type_desc
optional, string, e.g. Petrol
The vehicle's fuel type description
transmission_desc
optional, string, e.g. Manual
The vehicle's transmission type
body_type_desc
optional, string, e.g. Convertible
The body type description
number_doors
optional, string, e.g. 5
The number of doors
0to100_kmph
optional, string, e.g. 8.1
The number of seconds to go from Zero to 100 kmph
engine_capacity_cc
optional, string, e.g. 1499
The engine capacity in cc
number_cylinders
optional, string, e.g. 3
The number of cylinders
power_bhp
optional, string, e.g. 134
The engine power bhp
number_gears
optional, string, e.g. 6
The number of gears
top_speed_mph
optional, string, e.g. 129
The top speed (mph)
Sample Response
{
"success": true,
"result": {
"search_results": [
{
"brego_derivative_id": "0a1bc3d4-ef56-789g-h10i-j111k21l3m14",
"brego_vehicle_description": "MINI COUPE 1.6 Cooper 3dr (October 2011 - May 2015)"
}
],
"error": "If there is an error the message would go here"
}
}Response Parameters
success
e.g. true
Whether the api call was successful
brego_derivative_id
e.g. 0a1bc3d4-ef56-789g-h10i-j111k21l3m14
The Brego Derivative ID.
brego_vehicle_description
e.g. MINI COUPE 1.6 Cooper 3dr (October 2011 - May 2015)
The Brego vehicle description.
error
e.g. If there is an error the message would go here
Details of what went wrong with the api call
Status Codes
200
success, chargeable
Request has been successfully received and a response has been sent.
202
accepted, non-chargeable
Request has been received and accepted for processing, but the action has not yet been completed.
204
no content, non-chargeable
Request has been successfully received but there is no content to return e.g. if an invalid VRM has been sent.
206
partial content, non-chargeable
Request has been successfully received but limited content is returned e.g. if an invalid VRM has been sent.
400
bad request, non-chargeable
Request was not received e.g. if any required parameters are missing.
403
forbidden, non-chargeable
Request was rejected e.g. if the API key is invalid or the service is not enabled.
429
too many requests, non-chargeable
API key rate limit/quota has been exceeded.
500
internal server error, non-chargeable
We are unable to process the request e.g. if the API is under extremely heavy load.
503
service unavailable, non-chargeable
Service is temporarily unavailable. Contact help@oneautoapi.com
