0 credits
�My account ( 0 credits )
�Dashboard
�File Upload
�File History
�News 107
Bosch ECU Numbers
�Shop
�Invoices
Language - Logout
API Doc
Prerequisites
In order to access the OLSx API, you first need to
purchase the Database API package. This option is
activated by administrator. Read the sections below
before you start using the OLSx API.
Our API allows you to integrate our entire vehicle
database on any third-party application. You can
extract the JSON data from your code.
The API service is easy to use. However, this
documentation is intended primarily for developers
or other technical profiles that can properly use the
data provided.
Authentication
You only need API token in order to make API calls.
Status
Code Description
2xx Success
Code Description
4xx Bad request sent to server
5xx Server side error
Coefficients
Coefficients
API Calls
Request basis
Parameter Description
Api Key Api key linked to your OLSx account
curl -H "X-AUTH-TOKEN: {Api Key}"
https://...........
OR
$host = 'https://api.olsx.lu/car-
configurator/v2/manufacturers';
$ch = curl_init($host);
curl_setopt($ch, CURLOPT_HTTPHEADER,
array('Content-Type:
application/json', 'X-AUTH-TOKEN: {Api
Key}'));
curl_setopt($ch, CURLOPT_HEADER, 1);
curl_setopt($ch, CURLOPT_TIMEOUT, 10);
curl_setopt($ch,
CURLOPT_RETURNTRANSFER, TRUE);
$response = curl_exec($ch);
curl_close($ch);
1. Get brands
Request : https://api.olsx.lu/car-
configurator/v2/manufacturers
Paramete
Description
r
id Brand ID
name Brand name
uri Useful information to build your URL
models List of models for brand
type Brand type
Logo URL :
https://www.olsx.lu/manufacturers/XXXX
logo
XX.png
(On-demand activation)
Dark logo URL :
https://www.olsx.lu/manufacturers/XXXX
logo_dark
XX.png
(On-demand activation)
Formatted JSON Data
{
"code":200,
"manufacturers":[
{
"id": 51,
"name": "Abarth",
"uri": "abarth",
"type": "car",
"models": 3,
"logo": "",
"logo_dark": ""
},
{
"id": 19,
"name": "Alfa Romeo",
"uri": "alfa-romeo",
"type": "car",
"models": 14,
"logo": "",
"logo_dark": ""
},
{
"id": 39,
"name": "Alpina",
"uri": "alpina",
"type": "car",
"models": 12,
"logo": "",
"logo_dark": ""
},
...
}
2. Get models of a brand
Request : https://api.olsx.lu/car-
configurator/v2/manufacturer/{id manufacturer}
Brand parameters
Paramete
Description
r
id Brand ID
name Brand name
uri Useful information to build your URL
type Brand type
Logo URL :
https://www.olsx.lu/manufacturers/XXXX
logo
XX.png
(On-demand activation)
Dark logo URL :
https://www.olsx.lu/manufacturers/XXXX
logo_dark
XX.png
(On-demand activation)
models List of models for brand
Model parameters
Parameter Description
id Model ID
name Model name
uri Useful information to build your URL
Parameter Description
versions Number of versions linked to this model
Formatted JSON Data
{
{
"code": 200,
"id": 5,
"name": "Audi",
"uri": "audi",
"type": "car",
"logo": "",
"logo_dark": "",
"models":[
{
"id":116,
"name":"A1",
"uri":"a1",
"versions":2
},
{
"id":56,
"name":"A2",
"uri":"a2",
"versions":1
},
{
"id":346,
"name":"A3",
"uri":"a3",
"versions":5
},
{
"id":387,
"name":"A4",
"uri":"a4",
"versions":5
},
{
"id":145,
"name":"A5",
"uri":"a5",
"versions":2
},
{
"id":238,
"name":"A6",
"uri":"a6",
"versions":4
},
...
}
3. Get versions of a model
Request : https://api.olsx.lu/car-
configurator/v2/model/{id model}
Model parameters
Parameter Description
id Model ID
name Model name
uri Useful information to build your URL
manufacturer Informations of corresponding brand
Parameter Description
versions Number of versions linked to this model
Brand parameters
Paramete
Description
r
id Brand ID
name Brand name
uri Useful information to build your URL
type Brand type
Logo URL :
https://www.olsx.lu/manufacturers/XXXX
logo
XX.png
(On-demand activation)
Dark logo URL :
https://www.olsx.lu/manufacturers/XXXX
logo_dark
XX.png
(On-demand activation)
Version parameters
Parameter Description
id Version ID
Parameter Description
name Version name (could be empty)
uri Useful information to build your URL
from Start year
to End year
engines Number of engines linked to this version
Formatted JSON Data
{
"code":200,
"id":145,
"name":"A5",
"uri":"a5",
"manufacturer":{
"id":5,
"name":"Audi",
"uri":"audi",
"type": "car",
"logo":"",
"logo_dark":""
},
"versions":[
{
"id":33,
"name":"B8",
"uri":"2007-b8",
"from":"2007",
"to":null,
"engines":13
},
{
"id":700,
"name":"B8",
"uri":"2012-b8",
"from":"2012",
"to":null,
"engines":19
}
]
}
4. Get engines of a version
Request : https://api.olsx.lu/car-
configurator/v2/version/{id version}
Version parameters
Parameter Description
id Version ID
name Version name (could be empty)
uri Useful information to build your URL
from Start year
to End year
model Model
Parameter Description
manufacture
Brand
r
Number of engines linked to this
engines
version
Model parameters
Parameter Description
id Model ID
name Model name
uri Useful information to build your URL
Brand parameters
Paramete
Description
r
id Brand ID
name Brand name
uri Useful information to build your URL
type Brand type
Logo URL :
logo
https://www.olsx.lu/manufacturers/XXXX
Paramete
Description
r
XX.png
(On-demand activation)
Dark logo URL :
https://www.olsx.lu/manufacturers/XXXX
logo_dark
XX.png
(On-demand activation)
Engine parameters
Parameter Description
id Tuning ID
name Engine name
Useful information to build your
uri
URL
Recommended retail price for the
price
tuning
powerType Diesel or Petrol
horsepower Power
torque Original torque
horsepowerGain Power increase
Parameter Description
torqueGain Torque increase
horsepowerTotal Tuned power
torqueTotal Tuned torque
developed Development done
Formatted JSON Data
{
"code":200,
"id":33,
"name":"B8",
"uri":"2007-b8",
"from":"2007",
"to":null,
"model":{
"id":145,
"name":"A5",
"uri":"a5"
},
"manufacturer":{
"id":5,
"name":"Audi",
"uri":"Audi",
"type":"car",
"logo":"",
"logo_dark":""
},
"engines":[
{
"id":1316,
"name":"2.7 TDI",
"uri":"2.7-tdi-190",
"price":650,
"powerType":"diesel",
"horsepower":190,
"torque":400,
"horsepowerGain":40,
"torqueGain":80,
"horsepowerTotal":230,
"torqueTotal":480,
"developed": true,
},
{
"id":1323,
"name":"3.0 TDI",
"uri":"3.0-tdi-240",
"price":690,
"powerType":"diesel",
"horsepower":240,
"torque":500,
"horsepowerGain":55,
"torqueGain":100,
"horsepowerTotal":295,
"torqueTotal":600,
"developed": true,
},
{
"id":1397,
"name":"1.8 TSI TFSI",
"uri":"1.8-tsi-tfsi-160",
"price":650,
"powerType":"petrol",
"horsepower":160,
"torque":250,
"horsepowerGain":50,
"torqueGain":70,
"horsepowerTotal":210,
"torqueTotal":320,
"developed": true,
},
...
}
5. Get tuning
Request : https://api.olsx.lu/car-
configurator/v2/engine/{id engine}
Engine parameters
Parameter Description
id Tuning ID
name Engine name
Useful information to build your
uri
URL
Recommended retail price for the
price
tuning
powerType Diesel or Petrol
horsepower Original power
torque Original torque
horsepowerGain Power increase
torqueGain Torque increase
horsepowerTotal Tuned power
Parameter Description
torqueTotal Tuned torque
developed Development done
Version parameters
Parameter Description
id Version ID
name Version name (could be empty)
uri Useful information to build your URL
from Start year
to End year
model Model
manufacture
Brand
r
Number of engines linked to this
engines
version
Model parameters
Parameter Description
id Model ID
name Model name
uri Useful information to build your URL
Brand parameters
Paramete
Description
r
id Brand ID
name Brand name
uri Useful information to build your URL
type Brand type
Logo URL :
https://www.olsx.lu/manufacturers/XXXX
logo
XX.png
(On-demand activation)
Dark logo URL :
https://www.olsx.lu/manufacturers/XXXX
logo_dark
XX.png
(On-demand activation)
Formatted JSON Data
{
"code":200,
"id":1397,
"name":"1.8 TSI TFSI",
"uri":"1.8-tsi-tfsi-160",
"price":650,
"powerType":"petrol",
"horsepower":160,
"torque":250,
"horsepowerGain":50,
"torqueGain":70,
"horsepowerTotal":210,
"torqueTotal":320,
"developed": true,
"modelVersion":{
"id":33,
"name":"B8",
"from":"2007",
"to":null,
"uri":"2007-b8"
},
"model":{
"id":145,
"name":"A5",
"uri":"a5"
},
"manufacturer":{
"id":5,
"name":"Audi",
"uri":"Audi",
"type":"car",
"logo":""
"logo_dark"
}
}
