The Search-API is also known as Ad-Integration (german: Inserats-Einbindung).
Introduction
We offer a search API for…
-
Fetch single ads by an ad-key (ad ID)
-
Finding Ads by various criteria (make-model, category, modification-time, …).
It’s important to note that accessing ad data through a search result offers a more limited scope compared to a direct ad download facilitated by an ad-key. Consequently, certain ad properties accessible via direct ad download (using ad-key) may not be available in a search result containing the same ad.
Rest
Our API design adheres to the REST principle (Representational State Transfer), ensuring efficiency and clarity in data transmission. For further insights into this software architecture, refer to this link.
Language support
Many ad properties come with translated descriptions. While the default language is English, enriching the HTTP header field Accept-Language with the relevant value allows the client to obtain a translated description in all supported languages on mobile.de.
-
Please note that this feature is solely supported for Legacy XML/JSON (with content type application/xml or application/json).
Authentication
To access our API, authentication via HTTP basic authentication with a username and password is mandatory. For a comprehensive understanding of HTTP basic authentication, consult this resource or RFC 1945 Section 10.2.
Media Types
The API supports data retrieval in Legacy XML
, New Json
and New XML
format.
Detailed description of data structures for
individual data format is available in the Data Formats section.
To specify the preferred data format, the API client must use the appropriate Accept
header in the HTTP request:
Media type | Http header |
---|---|
Legacy Xml |
Accept: |
New Json |
Accept: |
New Xml |
Accept: |
HTTP header fields
HTTP header field | Possible values | Description |
---|---|---|
Accept |
|
|
Accept-Encoding |
gzip |
Sending this field allows you to receive a zipped result file. |
Accept-Language |
cz, de, en, es, fr, it, pl, ro or ru |
Sending this field allows you to control the result language. (Only for Legacy XML) |
Fetch single ads by an ad-key
Fetch details of an ad
Request
Resource Path | Method | Content-Type / Accept header |
---|---|---|
GET |
|
Example request-line and headers
GET /search-api/ad/456 HTTP/1.0 Host: services.mobile.de Accept: application/xml
Response
Response Status | Explanation |
---|---|
200 (OK) |
Success |
404 |
You Provided a wrong ad-key |
Finding Ads
Search for ads by various criteria
Request
Resource Path | Method | Content-Type / Accept header |
---|---|---|
https://services.mobile.de/search-api/search?{search-parameters} |
GET |
|
Example request-line and headers
GET /search-api/search?exteriorColor=BLACK&modificationTime.min=2012-05-04T18:13:51.0Z HTTP/1.0 Host: services.mobile.de Accept: application/xml
Response
Response Status | Explanation |
---|---|
200 (OK) |
Success |
400 |
This code is returned when there is an issue with the query you submitted. In these cases, the API attempts to include as many details as possible in the error response to help you identify and resolve the problem. |
Number of search results and paginating
Due to technical constraints, the maximum number of ads that can be retrieved through paginated result pages is limited to 2000. This means if your search query matches more than 2000 ads, and you have set page.size to 20, only the first 100 pages will contain ads (or 20 pages if page.size is set to 100). Subsequent pages will be empty.
This limitation is indicated at the top of the search result:
<search:total>1813062</search:total>
<search:page-size>100</search:page-size>
<search:current-page>1</search:current-page>
<search:max-pages>20</search:max-pages>
<searchResult>
<total>1813062</total>
<pageSize>100</pageSize>
<currentPage>1</currentPage>
<maxPages>20</maxPages>
<ads>
</ads>
</searchResult>
{
"total": 1813062,
"currentPage": 1,
"maxPages": 20,
"pageSize": 100,
"ads": []
}
If your search results contain more than 2000 ads and you need to access the remaining data, please refine your query by adding more parameters, such as the price filter, to limit the results.
Error response
The Search API returns an HTTP status code of 400 (Bad Request) for errors attributable to the user.
To identify the exact issue, inspect the response body, which contains a list of error elements, each associated with an error key. Additionally, there may be an optional message attribute offering a localized description of the error key.
Legacy XML Example:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<error:errors xmlns:error="http://services.mobile.de/schema/common/error-1.0">
<error:error key="invalid-search-parameter" message="Invalid search parameter">
<error:args key="field">exteriorColor</error:args>
<error:args key="code">typeMismatch</error:args>
<error:args key="rejected-value">BLACK11,RED</error:args>
</error:error>
</error:errors>
New JSON Example:
{
"errors": [
{
"key": "invalid-search-parameter",
"message": "Invalid search parameter",
"args": [
{
"key": "field",
"value": "exteriorColor"
},
{
"key": "code",
"value": "typeMismatch"
},
{
"key": "rejected-value",
"value": "Black1"
}
]
}
]
}
New XML Example:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<errorResponse>
<errors>
<error>
<key>invalid-search-parameter</key>
<message>Invalid search parameter</message>
<args>
<arg>
<key>field</key>
<value>exteriorColor</value>
</arg>
<arg>
<key>code</key>
<value>typeMismatch</value>
</arg>
<arg>
<key>rejected-value</key>
<value>Black1</value>
</arg>
</args>
</error>
</errors>
</errorResponse>
Other examples
-
Search for black and red vehicles with a specific first registration: https://services.mobile.de/search-api/search?exteriorColor=BLACK&exteriorColor=RED&firstRegistrationDate.min=2008-05
-
Search for black vehicles with a specific first registration and last ad modification time, page 3 with 100 ads per page: https://services.mobile.de/search-api/search?exteriorColor=BLACK&modificationTime.min=2008-05-04T18:13:51.0Z&page.number=3&page.size=100
-
Search for Audi A4 2.5 Avant: https://services.mobile.de/search-api/search?classification=refdata/classes/Car/makes/AUDI/models/A4&modelDescription=2.5%20TDI%20Avant
Search Parameters
-
You can send multiple comma-separated values for all search parameters with type Set.
-
It’s important to note that using only numeric and boolean search parameters isn’t allowed. Your request must include at least one parameter with a type different from numeric or boolean.
Parameter | Type | Description/Example |
---|---|---|
page.number |
int |
page number of result set - it starts with 1 |
page.size |
int |
default: 20, max size 100 |
sort.field |
String |
The name of the field to sort. Must be combined with sort.order. |
sort.order |
String |
Possible Values are ASCENDING, DESCENDING |
customerNumber |
Set(Long) |
Search for vehicles of specific sellers defined by customerNumber.
|
customerId |
Set(Long) |
Search for vehicles of specific sellers defined by customer ID.
|
classification |
Set(String) |
Classification is used to define the make/model or make/modelgroup combination for cars. It is also possible to use this parameter to specify a certain vehicle class. The definition of a make is possible for all vehicles with this parameter. |
category |
Set(enum) |
Example: https://services.mobile.de/search-api/search?category=Limousine,OffRoad |
feature |
Set(enum) |
Example search for vehicles with sunroof and central locking: https://services.mobile.de/search-api/search?feature=SUNROOF,CENTRAL_LOCKING |
excludeFeature |
Set(enum) |
Example exclude export vehicles from the search result: https://services.mobile.de/search-api/search?classification=refdata/classes/Car&excludeFeature=EXPORT |
condition |
Set(enum) |
USED, NEW |
exteriorColor |
Set(enum) |
Example search for black and red vehicles: https://services.mobile.de/search-api/search?exteriorColor=BLACK,RED |
emissionClass |
Set(enum) |
Example search for vehicles with emission class EURO3: https://services.mobile.de/search-api/search?emissionClass=EURO3 |
fuel |
Set(enum) |
Example search for hybrid fuel vehicles: https://services.mobile.de/search-api/search?fuel=HYBRID |
climatisation |
Set(enum) |
Example search for vehicles with any climatisation: https://services.mobile.de/search-api/search?climatisation=MANUAL_CLIMATISATION,AUTOMATIC_CLIMATISATION |
emissionSticker |
Set(enum) |
Example search for vehicles with green emissionsticker (Germany only): https://services.mobile.de/search-api/search?emissionSticker=EMISSIONSSTICKER_GREEN |
gearbox |
Set(enum) |
Example search for vehicles with semi-automatic gearshift: https://services.mobile.de/search-api/search?gearbox=SEMIAUTOMATIC_GEAR |
usageType |
Set(enum) |
Example search for classic cars: https://services.mobile.de/search-api/search?usageType=CLASSIC |
drivingMode |
Set(enum) |
Example search for motorbikes with belt transmission (only available for Motorbikes): https://services.mobile.de/search-api/search?drivingMode=BELT_DRIVE |
modelDescription |
String |
Search for vehicles with "right hand drive" in model description: https://services.mobile.de/search-api/search?modelDescription=right%20hand%20drive |
price.min |
decimal |
Minimum price(gros price) in EUR |
price.max |
decimal |
Maximum price(gros price) in EUR |
vatable |
bool |
Use vatable=1 for get all vehicles where VAT is vatable |
country |
ISO-3166-1 alpha-2 |
Example search for all vehicles from Austrian sellers: https://services.mobile.de/search-api/search?country=AT |
firstRegistrationDate.min |
Example search for all vehicles with a first Registration in 01.2007 or later: https://services.mobile.de/search-api/search?firstRegistrationDate.min=2007-01&classification=refdata/classes/Car |
|
firstRegistrationDate.max |
Example search for all vehicles with a first Registration earlier than 01.1971: https://services.mobile.de/search-api/search?firstRegistrationDate.max=1971-01&classification=refdata/classes/Car |
|
constructionYear.min |
int, YYYY |
Example search for vehicles with a construction year 1988 or later: https://services.mobile.de/search-api/search?constructionYear.min=1988&classification=refdata/classes/ConstructionMachine |
constructionYear.max |
int, YYYY |
Example search for vehicles with a construction year 1971 or earlier: https://services.mobile.de/search-api/search?constructionYear.max=1971&classification=refdata/classes/ConstructionMachine |
modificationTime.min |
Example search for all vehicles/ads modified after a specific time: modificationTime.min=2008-05-04T18:13:51%2B01:00&classification=refdata/classes/Car ormodificationTime.min=2008-05-04&classification=refdata/classes/Car |
|
modificationTime.max |
Example search for all vehicles/ads modified before a specific time: modificationTime.max=2008-05-04T18:13:51%2B01:00&classification=refdata/classes/Car ormodificationTime.max=2008-05-04&classification=refdata/classes/Car |
|
creationTime.min |
Example search for all vehicles/ads created after a specific time: creationTime.min=2008-05-04T18:13:51%2B01:00&classification=refdata/classes/Car orcreationTime.min=2008-05-04&classification=refdata/classes/Car |
|
creationTime.max |
Example search for all vehicles/ads created before a specific time: creationTime.max=2008-05-04T18:13:51%2B01:00&classification=refdata/classes/Car orcreationTime.max=2008-05-04&classification=refdata/classes/Car |
|
damageUnrepaired |
bool |
Use damageUnrepaired=0 to suppress damaged and unrepaired vehicles. Please see Damaged, Accident, Roadworthy for more details. |
accidentDamaged |
bool |
The vehicle once had an accident which may be repaired or not. Please see Damaged, Accident, Roadworthy for more details. |
roadworthy |
bool |
The vehicle is ready to drive. Please see Damaged, Accident, Roadworthy for more details. |
mileage.min |
int |
Minimum mileage in kilometers Example search for vehicles with mileage over 100.000 kilometers: https://services.mobile.de/search-api/search?mileage.min=100000&classification=refdata/classes/Car |
mileage.max |
int |
Maximum mileage in kilometers Example search for vehicles with mileage under 40.000 kilometers: https://services.mobile.de/search-api/search?mileage.max=40000&classification=refdata/classes/Car |
power.min |
decimal |
Minimum power in kilowatt (kW) |
power.max |
decimal |
Maximum power in kilowatt (kW) |
liftingCapacity.min |
int |
Minimum lifting capacity for commercial vehicles in kilogramm (kg) |
liftingCapacity.max |
int |
Maximum lifting capacity for commercial vehicles in kilogramm (kg) |
installationHeight.min |
int |
Minimum installation height for forklift trucks in mm |
installationHeight.max |
int |
Maximum installation height for forklift trucks in mm |
operatingHours.min |
int |
Minimum value of operating hours for construction machines in h |
operatingHours.max |
int |
Maximum value of operating hours for construction machines in h |
liftingHeight.min |
int |
Minimum lifting height for forklift trucks in mm |
liftingHeight.max |
int |
Maximum lifting height for forklift trucks in mm |
axles.min |
int |
Minimum number of axles for commercial vehicles |
axles.max |
int |
Maximum number of axles for commercial vehicles |
loadCapacity.min |
int |
Minimum load capacity for trailers and semi-trailers in kg |
loadCapacity.max |
int |
Maximum load capacity for trailers and semi-trailers in kg |
cubicCapacity.min |
int |
Minimum cubic capacity for motorbikes in ccm |
cubicCapacity.max |
int |
Maximum cubic capacity for motorbikes in ccm |
numSeats.min |
int |
Number of min passenger seats |
numSeats.max |
int |
Number of max passenger seats |
deliveryPeriod.min |
int |
Minimum number of days until a vehicle is available |
deliveryPeriod.max |
int |
Maximum number of days until a vehicle is available |
sellerType |
String |
Defines the type of seller |
doorCount |
Set(enum) |
|
drivingCab |
Set(enum) |
|
licensedWeight.min |
int |
|
licensedWeight.max |
int |
|
wheelFormula |
Set(enum) |
Possible values: https://services.mobile.de/refdata/wheelformulas |
ambit.zipcode |
String |
Zipcode for regional search. Currently only available in Germany; only valid German zip codes are accepted. |
ambit.radius |
int |
Radius size in kilometers for regional search. Default value is 0. |
ambit.country |
ISO-3166-1 alpha-2 |
Country code for regional search. Default is DE (currently, the only accepted value). |
imageCount.min |
int |
Minimum number of images attached to the ad |
imageCount.max |
int |
Maximum number of images attached to the ad |
numberOfPreviousOwners.min |
int |
Minimum number of previous owners |
numberOfPreviousOwners.max |
int |
Maximum number of previous owners |
monthsTillInspection |
int |
Minimum number of months till next inspection |
interiorColor |
Set(enum) |
Example search for vehicles with brown interior: https://services.mobile.de/search-api/search?interiorColor=BROWN |
interiorType |
Set(enum) |
Example search for vehicles with brown interior: https://services.mobile.de/search-api/search?interiorType=ALCANTARA |
airbag |
Set(enum) |
Example search for vehicles with front and side airbags: https://services.mobile.de/search-api/search?airbag=FRONT_AND_SIDE_AIRBAGS |
parkingAssistant |
Set(enum) |
Example search for vehicles in Germany with front parking sensors: https://services.mobile.de/search-api/search?country=DE&parkingAssistant=FRONT_SENSORS |
countryVersion |
Set(enum) |
Example search for vehicles that were manufactured for German or French market: https://services.mobile.de/search-api/search?countryVersion=DE,FR |
speedControl |
Set(enum) |
Example search for vehicles in Germany with cruise control https://services.mobile.de/search-api/search?country=DE&speedControl=CRUISE_CONTROL,ADAPTIVE_CRUISE_CONTROL |
radio |
Set(enum) |
Example search for vehicles in Germany with DAB radio https://services.mobile.de/search-api/search?country=DE&radio=DAB_RADIO |
daytimeRunningLamps |
Set(enum) |
Example search for vehicles in Germany with daytime running lights https://services.mobile.de/search-api/search?country=DE&daytimeRunningLamps=DAYTIME_RUNNING_LIGHTS |
slidingDoor |
Set(enum) |
Example search for vehicles in Germany with sliding doors left https://services.mobile.de/search-api/search?country=DE&slidingDoor=SLIDING_DOOR_LEFT |
headlightType |
Set(enum) |
Example search for vehicles in Germany with xenon headlights https://services.mobile.de/search-api/search?country=DE&headlightType=XENON_HEADLIGHTS |
bendingLightsType |
Set(enum) |
Example search for vehicles in Germany with adaptive bending lights https://services.mobile.de/search-api/search?country=DE&bendingLightsType=ADAPTIVE_BENDING_LIGHTS |
breakdownService |
Set(enum) |
Example search for vehicles in Germany with spare wheel https://services.mobile.de/search-api/search?country=DE&breakdownService=SPARE_WHEEL |
battery |
Set(enum) |
Example search for vehicles in Germany with rented battery https://services.mobile.de/search-api/search?country=DE&battery=BATTERY_RENTED |
batteryCapacity.min |
int |
Minimum battery capacity for vehicles in kWh. (0 < x < 1000) kWh |
batteryCapacity.max |
int |
Maximum battery capacity for vehicles in kWh. (0 < x < 1000) kWh |
trailerCouplingType |
Set(enum) |
Example search for vehicles in Germany with a fixed trailer coupling type https://services.mobile.de/search-api/search?country=DE&trailerCouplingType=TRAILER_COUPLING_FIX |
numberOfGears.min |
Int |
Number of min gears |
numberOfGears.max |
Int |
Number of max gears |
frameShape |
Set(enum) |
|
frameHeight.min |
Int |
Minimum frame height of EBike |
frameHeight.max |
Int |
Maximum frame height of EBike |
frameMaterial |
Set(enum) |
|
wheelSize |
String |
Wheel size of EBike |
batteryCapacityWh.min |
Int |
Minimum battery capacity of EBike |
batteryCapacityWh.max |
Int |
Maximum battery capacity of EBike |
weight.min |
Int |
Minimum weight of EBike |
weight.max |
Int |
Maximum weight of EBike |
bikeGearType |
Set(enum) |
|
batteryManufacturer |
Set(enum) |
|
bikeSuitableFor |
Set(enum) |
|
motorPosition |
Set(enum) |
|
batteryPosition |
Set(enum) |
|
trailerLoadBraked.min |
int |
|
trailerLoadBraked.max |
int |
|
trailerLoadUnbraked.min |
int |
|
trailerLoadUnbraked.max |
int |
|
maxNoseWeight.min |
int |
|
maxNoseWeight.max |
int |
|
operatingWeight.min |
int |
|
operatingWeight.max |
int |
|
seatHeight.min |
int |
|
seatHeight.max |
int |
|
cylinder.min |
int |
|
cylinder.max |
int |
|
fuelTankVolume.min |
int |
|
fuelTankVolume.max |
int |
|
standingHeight.min |
int |
|
standingHeight.max |
int |
|
payload.min |
int |
|
payload.max |
int |
|
seatbeltSeats.min |
int |
|
seatbeltSeats.max |
int |
|
heating |
Set(enum) |
Example: https://services.mobile.de/search-api/search?heating=Gas |
heightType |
Set(enum) |
Example: https://services.mobile.de/search-api/search?heightType=H1 |
lengthType |
Set(enum) |
Example: https://services.mobile.de/search-api/search?lengthType=L1 |
driveType |
Set(enum) |
Example: https://services.mobile.de/search-api/search?driveType=FRONT |
wheelBase |
Set(enum) |
Example: https://services.mobile.de/search-api/search?wheelBase=SHORT |
Data Format
The SearchAPI offers support for three data formats:
-
New JSON (Accept: application/vnd.de.mobil.api+json)
-
New XML (Accept: application/vnd.de.mobil.api+xml)
-
Legacy XML (Accept: application/xml)
Both the new JSON and new XML formats share the same schema in terms of field names and types. You can find detailed descriptions of field names and types in the Data Format Reference.
For those utilizing the legacy XML schema, it’s described in the Legacy XML schema files (Deprecated).
{
"total": 16,
"currentPage": 1,
"maxPages": 16,
"pageSize": 1,
"ads": [
{
"mobileAdId": "15012",
"mobileSellerId": "11",
"creationDate": "2024-04-26T02:35:10+02:00",
"modificationDate": "2024-05-15T16:08:18+02:00",
"vehicleClass": "Car",
"category": "EstateCar",
"make": "ABARTH",
"model": "500",
"modelDescription": "500",
"condition": "USED",
"firstRegistration": "202007",
"mileage": 500,
"fuel": "DIESEL",
"damageUnrepaired": false,
"plainTextDescription": "",
"detailPageUrl": "https://suchen.mobile.de/auto-inserat/abarth-500-w-stheuterode/15012.html?source=api",
"seller": {
"mobileSellerId": "00",
"email": "someemail@email.email",
"geoData": {
"lon": 01.0000000,
"lat": 01.0000000
},
"phones": [],
"address": {
"zipcode": "00000",
"city": "some city",
"country": "DE"
},
"type": "DEALER",
"commercial": true,
"dealerLogo": {
"icon": "https://img.classistatic.de/api/v1/mo-nonprod/images/ad/adac0001-1874-4c8c-ad4f-8decda8dbd09?rule=mo-80.jpg",
"s": "https://img.classistatic.de/api/v1/mo-nonprod/images/ad/adac0001-1874-4c8c-ad4f-8decda8dbd09?rule=mo-200.jpg",
"m": "https://img.classistatic.de/api/v1/mo-nonprod/images/ad/adac0001-1874-4c8c-ad4f-8decda8dbd09?rule=mo-240.jpg",
"l": "https://img.classistatic.de/api/v1/mo-nonprod/images/ad/adac0001-1874-4c8c-ad4f-8decda8dbd09?rule=mo-360.jpg",
"xl": "https://img.classistatic.de/api/v1/mo-nonprod/images/ad/adac0001-1874-4c8c-ad4f-8decda8dbd09?rule=mo-640.jpg",
"xxl": "https://img.classistatic.de/api/v1/mo-nonprod/images/ad/adac0001-1874-4c8c-ad4f-8decda8dbd09?rule=mo-1024.jpg",
"xxxl": "https://img.classistatic.de/api/v1/mo-nonprod/images/ad/adac0001-1874-4c8c-ad4f-8decda8dbd09?rule=mo-1600.jpg"
}
},
"price": {
"consumerPriceGross": "1000.00",
"type": "FIXED",
"currency": "EUR"
}
}
]
}
<?xml version="1.0" encoding="UTF-8"?>
<searchResult>
<total>16</total>
<currentPage>1</currentPage>
<maxPages>16</maxPages>
<pageSize>1</pageSize>
<ads>
<ad>
<mobileAdId>15012</mobileAdId>
<mobileSellerId>11</mobileSellerId>
<creationDate>2024-04-26T02:35:10+02:00</creationDate>
<modificationDate>2024-05-15T16:08:18+02:00</modificationDate>
<vehicleClass>Car</vehicleClass>
<category>EstateCar</category>
<make>ABARTH</make>
<model>500</model>
<modelDescription>500</modelDescription>
<condition>USED</condition>
<firstRegistration>202007</firstRegistration>
<mileage>500</mileage>
<fuel>DIESEL</fuel>
<damageUnrepaired>false</damageUnrepaired>
<plainTextDescription></plainTextDescription>
<detailPageUrl>https://suchen.mobile.de/auto-inserat/abarth-500-w-stheuterode/15012.html?source=api</detailPageUrl>
<seller>
<mobileSellerId>00</mobileSellerId>
<email>someemail@email.email</email>
<geoData>
<lon>01.0000000</lon>
<lat>01.0000000</lat>
</geoData>
<phones></phones>
<address>
<zipcode>00000</zipcode>
<city>some city</city>
<country>DE</country>
</address>
<type>DEALER</type>
<commercial>true</commercial>
<dealerLogo>
<icon>https://img.classistatic.de/api/v1/mo-nonprod/images/ad/adac0001-1874-4c8c-ad4f-8decda8dbd09?rule=mo-80.jpg</icon>
<s>https://img.classistatic.de/api/v1/mo-nonprod/images/ad/adac0001-1874-4c8c-ad4f-8decda8dbd09?rule=mo-200.jpg</s>
<m>https://img.classistatic.de/api/v1/mo-nonprod/images/ad/adac0001-1874-4c8c-ad4f-8decda8dbd09?rule=mo-240.jpg</m>
<l>https://img.classistatic.de/api/v1/mo-nonprod/images/ad/adac0001-1874-4c8c-ad4f-8decda8dbd09?rule=mo-360.jpg</l>
<xl>https://img.classistatic.de/api/v1/mo-nonprod/images/ad/adac0001-1874-4c8c-ad4f-8decda8dbd09?rule=mo-640.jpg</xl>
<xxl>https://img.classistatic.de/api/v1/mo-nonprod/images/ad/adac0001-1874-4c8c-ad4f-8decda8dbd09?rule=mo-1024.jpg</xxl>
<xxxl>https://img.classistatic.de/api/v1/mo-nonprod/images/ad/adac0001-1874-4c8c-ad4f-8decda8dbd09?rule=mo-1600.jpg</xxxl>
</dealerLogo>
</seller>
<price>
<consumerPriceGross>1000.00</consumerPriceGross>
<type>FIXED</type>
<currency>EUR</currency>
</price>
</ad>
</ads>
</searchResult>
<?xml version="1.0" encoding="UTF-8"?>
<search:search-result xmlns:error="http://services.mobile.de/schema/common/error-1.0" xmlns:financing="http://services.mobile.de/schema/common/financing-1.0" xmlns:ad="http://services.mobile.de/schema/ad" xmlns:resource="http://services.mobile.de/schema/resource" xmlns:search="http://services.mobile.de/schema/search" xmlns:seller="http://services.mobile.de/schema/seller" xmlns:leasing="http://services.mobile.de/schema/common/leasing-1.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://services.mobile.de/schema/search http://services.mobile.de/schema/search-1.0.xsd">
<search:total>16</search:total>
<search:page-size>1</search:page-size>
<search:current-page>1</search:current-page>
<search:max-pages>16</search:max-pages>
<search:ads>
<ad:ad key="15012" url="https://services.mobile.de/search-api/ad/15012">
<ad:creation-date value="2024-04-26T02:35:10+02:00"/>
<ad:modification-date value="2024-05-15T16:08:18+02:00"/>
<ad:detail-page url="https://suchen.mobile.de/auto-inserat/abarth-500-w-stheuterode/15012.html?source=api"/>
<ad:vehicle>
<ad:class key="Car" url="https://services.mobile.de/refdata/classes/Car">
<resource:local-description xml-lang="en">Car</resource:local-description>
</ad:class>
<ad:category key="EstateCar" url="https://services.mobile.de/refdata/classes/Car/categories/EstateCar">
<resource:local-description xml-lang="en">Estate Car</resource:local-description>
</ad:category>
<ad:make key="ABARTH" url="https://services.mobile.de/refdata/classes/Car/makes/ABARTH">
<resource:local-description xml-lang="en">Abarth</resource:local-description>
</ad:make>
<ad:model key="500" url="https://services.mobile.de/refdata/classes/Car/makes/ABARTH/models/500">
<resource:local-description xml-lang="en">500</resource:local-description>
</ad:model>
<ad:model-description value="500"/>
<ad:damage-and-unrepaired value="false"/>
<ad:specifics>
<ad:mileage value="500"/>
<ad:first-registration value="2020-07"/>
<ad:fuel key="DIESEL" url="https://services.mobile.de/refdata/fuels/DIESEL">
<resource:local-description xml-lang="en">Diesel</resource:local-description>
</ad:fuel>
<ad:condition key="USED" url="https://services.mobile.de/refdata/conditions/USED">
<resource:local-description xml-lang="en">Used vehicle</resource:local-description>
</ad:condition>
</ad:specifics>
</ad:vehicle>
<ad:description></ad:description>
<ad:price currency="EUR" type="FIXED">
<ad:consumer-price-amount value="1000.00"/>
<ad:vatable value="false"/>
</ad:price>
<seller:seller key="00" url="https://services.mobile.de/search-api/seller/00">
<seller:type value="DEALER" commercial="true"/>
<seller:address>
<seller:zipcode value="00000"/>
<seller:city value="some city"/>
<seller:country-code value="DE"/>
</seller:address>
<seller:email value="someemail@email.email"/>
<seller:coordinates>
<seller:latitude>01.0000000</seller:latitude>
<seller:longitude>01.0000000</seller:longitude>
</seller:coordinates>
</seller:seller>
</ad:ad>
</search:ads>
</search:search-result>
{
"mobileAdId": "15012",
"mobileSellerId": "11",
"creationDate": "2024-04-26T02:35:10+02:00",
"modificationDate": "2024-05-15T16:08:18+02:00",
"vehicleClass": "Car",
"category": "EstateCar",
"make": "ABARTH",
"model": "500",
"modelDescription": "500",
"condition": "USED",
"firstRegistration": "202007",
"mileage": 500,
"fuel": "DIESEL",
"costModel": {
"timeFrame": {},
"co2Costs": {}
},
"damageUnrepaired": false,
"plainTextDescription": "",
"detailPageUrl": "https://suchen.mobile.de/auto-inserat/abarth-500-w-stheuterode/15012.html?source=api",
"seller": {
"mobileSellerId": "00",
"mobileSellerSince": "2014-03-24T23:00:00Z",
"email": "someemail@email.email",
"geoData": {
"lon": 01.0000000,
"lat": 01.0000000
},
"companyName": "Some Company Name",
"phones": [
{
"internationalPrefix": 49,
"nationalPrefix": "001",
"number": "0000000"
},
{
"internationalPrefix": 49,
"nationalPrefix": "002",
"number": "0000000"
}
],
"cell": {
"internationalPrefix": 49,
"nationalPrefix": "003",
"number": "0000000"
},
"fax": {
"internationalPrefix": 49,
"nationalPrefix": "004",
"number": "0000000"
},
"address": {
"street": "Some Strasse",
"zipcode": "00000",
"city": "Some City",
"country": "DE"
},
"type": "DEALER",
"commercial": true,
"homepage": "https://home.mobile.de/home/redirect.html?customerId=00",
"dealerLogo": {
"icon": "https://img.classistatic.de/api/v1/mo-nonprod/images/ad/adac0001-1874-4c8c-ad4f-8decda8dbd09?rule=mo-80.jpg",
"s": "https://img.classistatic.de/api/v1/mo-nonprod/images/ad/adac0001-1874-4c8c-ad4f-8decda8dbd09?rule=mo-200.jpg",
"m": "https://img.classistatic.de/api/v1/mo-nonprod/images/ad/adac0001-1874-4c8c-ad4f-8decda8dbd09?rule=mo-240.jpg",
"l": "https://img.classistatic.de/api/v1/mo-nonprod/images/ad/adac0001-1874-4c8c-ad4f-8decda8dbd09?rule=mo-360.jpg",
"xl": "https://img.classistatic.de/api/v1/mo-nonprod/images/ad/adac0001-1874-4c8c-ad4f-8decda8dbd09?rule=mo-640.jpg",
"xxl": "https://img.classistatic.de/api/v1/mo-nonprod/images/ad/adac0001-1874-4c8c-ad4f-8decda8dbd09?rule=mo-1024.jpg",
"xxxl": "https://img.classistatic.de/api/v1/mo-nonprod/images/ad/adac0001-1874-4c8c-ad4f-8decda8dbd09?rule=mo-1600.jpg"
}
},
"price": {
"consumerPriceGross": "1000.00",
"type": "FIXED",
"currency": "EUR"
}
}
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ad>
<mobileAdId>15012</mobileAdId>
<mobileSellerId>11</mobileSellerId>
<creationDate>2024-04-26T02:35:10+02:00</creationDate>
<modificationDate>2024-05-15T16:08:18+02:00</modificationDate>
<vehicleClass>Car</vehicleClass>
<category>EstateCar</category>
<make>ABARTH</make>
<model>500</model>
<modelDescription>500</modelDescription>
<condition>USED</condition>
<firstRegistration>202007</firstRegistration>
<mileage>500</mileage>
<fuel>DIESEL</fuel>
<costModel>
<timeFrame/>
<co2Costs/>
</costModel>
<damageUnrepaired>false</damageUnrepaired>
<plainTextDescription></plainTextDescription>
<detailPageUrl>https://suchen.mobile.de/auto-inserat/abarth-500-w-stheuterode/15012.html?source=api</detailPageUrl>
<seller>
<mobileSellerId>11</mobileSellerId>
<mobileSellerSince>2014-03-24T23:00:00Z</mobileSellerSince>
<email>someemail@email.email</email>
<geoData>
<lon>01.0000000</lon>
<lat>01.0000000</lat>
</geoData>
<companyName>Some Company Name</companyName>
<phones>
<phone>
<internationalPrefix>49</internationalPrefix>
<nationalPrefix>001</nationalPrefix>
<number>0000000</number>
</phone>
<phone>
<internationalPrefix>49</internationalPrefix>
<nationalPrefix>002</nationalPrefix>
<number>0000000</number>
</phone>
</phones>
<cell>
<internationalPrefix>49</internationalPrefix>
<nationalPrefix>003</nationalPrefix>
<number>0000000</number>
</cell>
<fax>
<internationalPrefix>49</internationalPrefix>
<nationalPrefix>004</nationalPrefix>
<number>0000000</number>
</fax>
<address>
<street>Some Strasse</street>
<zipcode>00000</zipcode>
<city>Some City</city>
<country>DE</country>
</address>
<type>DEALER</type>
<commercial>true</commercial>
<homepage>https://home.mobile.de/home/redirect.html?customerId=00</homepage>
<dealerLogo>
<icon>https://img.classistatic.de/api/v1/mo-nonprod/images/ad/adac0001-1874-4c8c-ad4f-8decda8dbd09?rule=mo-80.jpg</icon>
<s>https://img.classistatic.de/api/v1/mo-nonprod/images/ad/adac0001-1874-4c8c-ad4f-8decda8dbd09?rule=mo-200.jpg</s>
<m>https://img.classistatic.de/api/v1/mo-nonprod/images/ad/adac0001-1874-4c8c-ad4f-8decda8dbd09?rule=mo-240.jpg</m>
<l>https://img.classistatic.de/api/v1/mo-nonprod/images/ad/adac0001-1874-4c8c-ad4f-8decda8dbd09?rule=mo-360.jpg</l>
<xl>https://img.classistatic.de/api/v1/mo-nonprod/images/ad/adac0001-1874-4c8c-ad4f-8decda8dbd09?rule=mo-640.jpg</xl>
<xxl>https://img.classistatic.de/api/v1/mo-nonprod/images/ad/adac0001-1874-4c8c-ad4f-8decda8dbd09?rule=mo-1024.jpg</xxl>
<xxxl>https://img.classistatic.de/api/v1/mo-nonprod/images/ad/adac0001-1874-4c8c-ad4f-8decda8dbd09?rule=mo-1600.jpg</xxxl>
</dealerLogo>
</seller>
<price>
<consumerPriceGross>1000.00</consumerPriceGross>
<type>FIXED</type>
<currency>EUR</currency>
</price>
</ad>
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ad:ad xmlns:resource="http://services.mobile.de/schema/resource" xmlns:ad="http://services.mobile.de/schema/ad" xmlns:financing="http://services.mobile.de/schema/common/financing-1.0" xmlns:leasing="http://services.mobile.de/schema/common/leasing-1.0" xmlns:seller="http://services.mobile.de/schema/seller" key="15012" url="https://services.mobile.de/search-api/ad/15012">
<ad:creation-date value="2024-04-26T02:35:10+02:00"/>
<ad:modification-date value="2024-05-15T16:08:18+02:00"/>
<ad:detail-page url="https://suchen.mobile.de/auto-inserat/abarth-500-w-stheuterode/15012.html?source=api"/>
<ad:vehicle>
<ad:class key="Car" url="https://services.mobile.de/refdata/classes/Car">
<resource:local-description xml-lang="en">Car</resource:local-description>
</ad:class>
<ad:category key="EstateCar" url="https://services.mobile.de/refdata/classes/Car/categories/EstateCar">
<resource:local-description xml-lang="en">Estate Car</resource:local-description>
</ad:category>
<ad:make key="ABARTH" url="https://services.mobile.de/refdata/classes/Car/makes/ABARTH">
<resource:local-description xml-lang="en">Abarth</resource:local-description>
</ad:make>
<ad:model key="500" url="https://services.mobile.de/refdata/classes/Car/makes/ABARTH/models/500">
<resource:local-description xml-lang="en">500</resource:local-description>
</ad:model>
<ad:model-description value="500"/>
<ad:damage-and-unrepaired value="false"/>
<ad:specifics>
<ad:mileage value="500"/>
<ad:first-registration value="2020-07"/>
<ad:fuel key="DIESEL" url="https://services.mobile.de/refdata/fuels/DIESEL">
<resource:local-description xml-lang="en">Diesel</resource:local-description>
</ad:fuel>
<ad:condition key="USED" url="https://services.mobile.de/refdata/conditions/USED">
<resource:local-description xml-lang="en">Used vehicle</resource:local-description>
</ad:condition>
<ad:cost-model>
<ad:co2-costs/>
</ad:cost-model>
</ad:specifics>
</ad:vehicle>
<ad:description></ad:description>
<ad:price currency="EUR" type="FIXED">
<ad:consumer-price-amount value="1000.00"/>
<ad:vatable value="false"/>
</ad:price>
<seller:seller key="11" url="https://services.mobile.de/search-api/seller/00">
<seller:type value="DEALER" commercial="true"/>
<seller:company-name value="Some Company Name"/>
<seller:address>
<seller:street value="Some Strasse"/>
<seller:zipcode value="00000"/>
<seller:city value="Some City"/>
<seller:country-code value="DE"/>
</seller:address>
<seller:phone type="FIXED" country-calling-code="49" area-code="001" number="000000"/>
<seller:phone type="FIXED" country-calling-code="49" area-code="002" number="000000"/>
<seller:phone type="CELL" country-calling-code="49" area-code="002" number="000000"/>
<seller:phone type="FAX" country-calling-code="49" area-code="003" number="000000"/>
<seller:email value="smoke.location@test.de"/>
<seller:homepage value="https://home.mobile.de/home/redirect.html?customerId=11"/>
<seller:mobile-seller-since value="2014-03-25+01:00"/>
<seller:coordinates>
<seller:latitude>01.000000</seller:latitude>
<seller:longitude>01.000000</seller:longitude>
</seller:coordinates>
<seller:logo-image>
<seller:representation size="S" url="https://img.classistatic.de/api/v1/mo-nonprod/images/ad/adac0001-1874-4c8c-ad4f-8decda8dbd09?rule=mo-200.jpg"/>
<seller:representation size="XL" url="https://img.classistatic.de/api/v1/mo-nonprod/images/ad/adac0001-1874-4c8c-ad4f-8decda8dbd09?rule=mo-640.jpg"/>
<seller:representation size="ICON" url="https://img.classistatic.de/api/v1/mo-nonprod/images/ad/adac0001-1874-4c8c-ad4f-8decda8dbd09?rule=mo-80.jpg"/>
<seller:representation size="L" url="https://img.classistatic.de/api/v1/mo-nonprod/images/ad/adac0001-1874-4c8c-ad4f-8decda8dbd09?rule=mo-360.jpg"/>
<seller:representation size="M" url="https://img.classistatic.de/api/v1/mo-nonprod/images/ad/adac0001-1874-4c8c-ad4f-8decda8dbd09?rule=mo-240.jpg"/>
<seller:representation size="XXL" url="https://img.classistatic.de/api/v1/mo-nonprod/images/ad/adac0001-1874-4c8c-ad4f-8decda8dbd09?rule=mo-1024.jpg"/>
<seller:representation size="XXXL" url="https://img.classistatic.de/api/v1/mo-nonprod/images/ad/adac0001-1874-4c8c-ad4f-8decda8dbd09?rule=mo-1600.jpg"/>
</seller:logo-image>
<seller:contact-languages>
<seller:language>de</seller:language>
<seller:language>fr</seller:language>
<seller:language>en</seller:language>
</seller:contact-languages>
</seller:seller>
</ad:ad>
References
Resources Reference
This section contains a detailed description of all rest apis provided by the Search API
.
Please note the that below endpoints are available on the following base url: Please refer to the Introduction paragraph to get more information how to access the api. |
Name | Method | Endpoint |
---|---|---|
|
|
|
|
|
Data Format Reference
This section describes various aspects of the data exchanged through the api calls.
Data Types Reference
This section contains a detailed definition of the data produced by Search API
.
The data consists of a number of fields
and each field is of certain type
.
A type could be a simple value such as String
or Int
or a complex type that groups logically other fields.
The below sections contain explanation of all the fields and how they are grouped together into types.
Legacy XML schema files (Deprecated)
-
Please check the Legacy XML schema definition of our data format to understand the response returned by this API.
Resource data type (parent for many other types) |
|
Search result |
|
Ad data (standalone or part of a search result) |
|
Seller data (part of an ad) |
|
Leasing data (part of an ad, only if leasing applicable to ad) |
New Data Format (New Json/XML)
SearchResult
Field Name | Type | Description |
---|---|---|
Int |
The total number of results. |
|
Int |
The total number of results-pages. |
|
Int |
The number of results per page |
|
Int |
The current page number. |
|
Collection of Ad |
The ad results (of this page). |
|
A list of non fatal errors related to this search request e.g. invalid or deprecated search parameters. If this list is present then the search result might not be as intended by the client, so always check that this not present. |
Ad
Top level type for representing Ad data.
Field Name | Type | Description |
---|---|---|
PLATFORM METADATA |
||
String |
mobile-platform Ad ID |
|
String |
mobile-platform Seller ID |
|
String |
e.g. 2015-06-12T11:58:32+02:00. See Date Time Representation for details. |
|
String |
e.g. 2015-06-12T11:58:32+02:00. See Date Time Representation for details. |
|
VEHICLE |
||
Key Fields |
||
String |
The GENERAL classification of vehicles e.g. Car or Motorbike. See vehicle classes for possible values. |
|
String |
The DETAILED classification of vehicles e.g. Cabrio or Limousine. See categories for possible values. |
|
String |
Make of the vehicle e.g. Mercedes, Toyota. See makes for possible values. |
|
String |
Model of the vehicle e.g. X5, Prius. See models for possible values. |
|
String |
Detailed description of the model. Also used as ad title. Example Golf III always parked in garage. This field is restricted to a subset of UTF-8 characters. |
|
String |
Is the vehicle new or used? See conditions for possible values. |
|
String |
Type of used car. See usage types for possible values. |
|
String |
yyyyMM. See Date Time Representation for details. |
|
Int |
mileage in km |
|
String |
The vehicle identification number (aka VIN or FIN). See http://en.wikipedia.org/wiki/Vehicle_Identification_Number. The field is case sensitive. Please send capital letters. |
|
String |
A reference key used by the seller. Also known as internal-number or internal-ID. If it is present, then it must be unique per seller. An empty string is treated same as if the element was not present. This field is restricted to a subset of UTF-8 characters. |
|
Engine / Drive Train |
||
Int |
Cubic-capacity of the engine. Notation integer. |
|
Int |
Power of the vehicle. Notation in KW |
|
String |
Stickshift, automatic? See gear boxes for possible values. |
|
String |
Type of fuel. See fuel for possible values. |
|
Int |
Number of axles, integer. Information only for commercial vehicles |
|
Boolean |
Four wheel drive |
|
String |
The actuation of the vehicle. See wheel formulas for possible values. |
|
Boolean |
A plug-in hybrid electric vehicle (PHEV) is a hybrid electric vehicle that uses rechargeable batteries, or another energy storage device, that can be recharged by plugging it in to an external source of electric power. |
|
Boolean |
is the vehicle enabled for using E10 fuel |
|
Boolean |
Catalytic converter - motorcycles only |
|
Boolean |
Particulate filter diesel |
|
Boolean |
Biodiesel conversion |
|
Boolean |
Biodiesel suitable - Biodiesel suitable, only for diesel fuel - Biodiesel geeignet |
|
Boolean |
Vegetableoilfuel conversion |
|
Boolean |
Vegetableoilfuel suitable - only cars and semi trailer trucks, only diesel fuel |
|
Boolean |
Performance handling system - (Sportfahrwerk) |
|
Boolean |
Start stop system |
|
Boolean |
If the vehicle is compliant with German legal requirements (EnVKV) |
|
String |
the label for the applicable class of energy consumption, ranges between A+++, A++, A+, A, B, C, D, E, F or G |
|
Float |
Indicates the amount of carbon dioxide emissions in grams per kilometer traveled. |
|
Float |
Fuel consumption as measured in specific tests executed in city traffic situations. Number in l/100km (natural gas (CNG) in kg/100km, is ignored for electric vehicles) |
|
Float |
Fuel consumption as measured in specific tests executed in highway traffic situations. Number in l/100km (natural gas (CNG) in kg/100km, is ignored for electric vehicles) |
|
Float |
Fuel consumption as measured in specific tests executed in city and highway traffic situations. Number in l/100km (natural gas (CNG) in kg/100km, electric vehicles in kWh/100km) |
|
String |
The unit of the consumption values. This element is only readonly. For write usecases the unit is derived from the fuel type. fuel consumption units |
|
String |
When you want to provide EnVKV compliant values, for fuel type petrol, you have to specify the exact petrol type, that the consumption values are based on. petrol types |
|
Float |
Combined power consumption for electric vehicles in in kWh/100km |
|
String |
Emission sticker for German low emission zones (Feinstaubplakette für Umweltzone). See emission stickers for possible values. |
|
String |
EURO 1, 2, 3, 4, …. See emission classes for possible values. |
|
Additional values from WLTP (Worldwide Harmonised Light-Duty Vehicles Test Procedure) |
||
Int |
WLTP electric range (EAER) in km (only for plugin hybrids) |
|
Emission values, legally required for new cars |
||
Consumption values, legally required for new cars |
||
Cost Model values, legally required for new cars |
||
Int |
electric range in km. |
|
Exterior / Interior |
||
String |
The mobile.de color name. This is a fixed set of colors. colors for possible values |
|
String |
free text field for color. This field is restricted to a subset of UTF-8 characters. |
|
Boolean |
Metallic |
|
String |
Number of doors. See door counts for possible values. |
|
Int |
number of seats. For categories Car, Bus, Truck up to 7,5t. |
|
String |
Information about the color of the interior of the vehicle. See interior colors for possible values. |
|
String |
Information about the material used in the interior of the vehicle. See interior types for possible values. |
|
Facts |
||
String |
yyyyMM. See Date Time Representation for details. |
|
String |
yyyyMM. See Date Time Representation for details. |
|
Boolean |
Buyer get’s a new HU/AU |
|
Int |
Format yyyy. Information only for commercial vehicles |
|
String |
The day when the vehicle was built. See Date Time Representation for details. |
|
Int |
Information about the number of previous owners of the vehicle |
|
Boolean |
Full service history - (Scheckheftgeplfegt) |
|
Boolean |
Nonsmoker vehicle |
|
String |
ISO-3166-1 alpha-2 code of the country for which the vehicle was built. See country versions for possible values. For newcars this field is mandatory. |
|
Boolean |
||
Boolean |
See http://services.mobile.de/manual/damage.html (available only for cars) |
|
Boolean |
See http://services.mobile.de/manual/damage.html (available only for cars) |
|
Boolean |
Usable if the car is or was a taxi |
|
Vehicle Details |
||
Boolean |
Abs |
|
String |
Information about the airbags of the vehicle. See airbags for possible values. |
|
Boolean |
Air suspension |
|
Boolean |
Alloy wheels |
|
Boolean |
Rain sensor |
|
Boolean |
Auxiliary heating |
|
Boolean |
An awning or overhang is a secondary covering attached to the exterior wall of a building. |
|
Boolean |
Bed |
|
Boolean |
Bluetooth |
|
Boolean |
Box |
|
Boolean |
Boom Suspension System |
|
Boolean |
Bunk bed |
|
Boolean |
Cabin |
|
Boolean |
CD multichanger |
|
Boolean |
CD Player |
|
Boolean |
Central locking |
|
Boolean |
A system that delivers controlled amounts of lubricant to multiple locations on a machine while the machine is operating. |
|
Boolean |
Circular seating arrangement |
|
String |
Information on the climatisation of the vehicle. See climatisations for possible values. |
|
Boolean |
Fridge |
|
Boolean |
Compressor |
|
Boolean |
Crane |
|
Boolean |
Damage by hail |
|
The external dimension of the vehicle. |
||
Boolean |
Disabled accessible |
|
Boolean |
Disabled conversion |
|
Boolean |
Disc brake |
|
Boolean |
Divider |
|
Boolean |
Drivers sleeping compartment |
|
String |
Information about the cab of the truck. See driving cabs for possible values. |
|
String |
Does the motorbike have a chain or something else? See driving modes for possible values. |
|
Boolean |
Electronic Braking System |
|
Boolean |
Electric adjustable seats |
|
Boolean |
Electric mirrors |
|
Boolean |
Electric heated seats |
|
Boolean |
Electric starter |
|
Boolean |
Electric windows |
|
Boolean |
Esp |
|
Int |
Information about how many europallets suit in the vehicle. |
|
Boolean |
Front fog lights |
|
Boolean |
Front hydraulics |
|
Boolean |
Front Jack for Accessoires |
|
Boolean |
Full fairing increases effiency |
|
Boolean |
Hands free phone system |
|
Boolean |
Headup display |
|
String |
Indicates the type of hydraulic installation. See hydraulic installations for possible values. |
|
Boolean |
Immobilizer |
|
Int |
Notation in mm, integer. Information only for commercial vehicles |
|
Boolean |
ISOFIX is the international standard for attachment points for child safety seats in passenger cars |
|
Boolean |
Kickstarter - motorcycles only |
|
Boolean |
Kitchen |
|
Int |
Notation in kg, integer. Information only for commercial vehicles. |
|
Int |
Notation in kg, integer. Information only for commercial vehicles |
|
Int |
Notation in mm, integer. Information only for commercial vehicles |
|
Boolean |
Light sensor |
|
Int |
Notation in kg, integer. Information only for commercial vehicles |
|
The loading space dimensions. |
||
Boolean |
Middle seating arrangement |
|
Boolean |
Multifunctional wheel |
|
Boolean |
Municipal |
|
Boolean |
Is the car having a build in navigation system. Not be be set for portable navigation systems |
|
Int |
The number of bunks. Only for Motorhome. |
|
Boolean |
On board computer |
|
Int |
Notation integer. Information only for commercial vehicles |
|
Boolean |
Panoramic glass roof |
|
Collection of String |
Information about the parking assistants of the vehicle. parking assistants for possible values. |
|
String |
Information about the speed control of the vehicle. See speed controls for possible values. |
|
Collection of String |
Information about the radio of the vehicle. See radios for possible values. |
|
String |
Information about the type of daytime running lamps of the vehicle. See daytime running lamps for possible values. |
|
String |
Information about the type of sliding door of the vehicle. See sliding door types for possible values. |
|
String |
Information about the headlight types of the vehicle. See headlight types for possible values. |
|
String |
Information about the type of cornering/bending lights of the vehicle. See bending lights types for possible values. |
|
String |
Information about the type of breakdown service kit of the vehicle. See breakdown services for possible values. |
|
String |
Information about the battery of the electric vehicle. See batteries for possible values. |
|
String |
Information about the trailer coupling type of the vehicle. See trailer coupling types for possible values. |
|
String |
Information about the trim line a.k.a feature sets (Ausstattungslinie) of the vehicle. See trimlines. |
|
String |
Information about the model range a.k.a. Baureihe of the vehicle. See modelranges. |
|
String |
yyyyMM. See Date Time Representation for details. |
|
Int |
Battery capacity of the vehicle. Notation in kWh, integer |
|
Boolean |
Power assisted steering |
|
Boolean |
Protection roof |
|
Boolean |
Quick change attachment |
|
Boolean |
Rear garage |
|
Boolean |
Used if the vehicle has an retader or intarder |
|
Boolean |
Road licence |
|
Boolean |
Roll over bar |
|
Boolean |
Roofrails |
|
Boolean |
Secondary air conditioning - (Standklimaanlage) |
|
Boolean |
Seperate Shower |
|
Int |
The loading space volume. Notation in cubic meter |
|
Boolean |
Side seating arrangement |
|
Boolean |
Ski bag |
|
Boolean |
Sleep seats |
|
Boolean |
Solar energy system |
|
Boolean |
Sport package |
|
Boolean |
Sport seats |
|
Boolean |
Sunroof |
|
Boolean |
Super single wheels |
|
Boolean |
Tail lift |
|
Boolean |
Traction control system |
|
Boolean |
Tv |
|
Boolean |
Urea tank ad blue |
|
Boolean |
Toilet |
|
Boolean |
Windshield |
|
Boolean |
The vehicle makes itself heard / seen, if someone tries to break into the car |
|
Boolean |
Arm rest between driver and front passenger seat |
|
Boolean |
Windshield has heating elements integrated (dedicated blowers to heat windshield are not to be considered as heated windshield) |
|
Boolean |
Steering wheel can be heated |
|
Boolean |
Could be Hill Holder, Hill Hold Control or Hill Start Assist as well. A system to automatically support the driver when starting up from a stop on an up or down gradient |
|
Boolean |
tailgate is able to be operated electrically, either from the driver position, with a button on the tailgate or from a key fob as some examples |
|
Boolean |
Steering wheel is covered with leather |
|
Boolean |
Mechanism within at least the drivers seat which supports the back of a person during longer drives |
|
Boolean |
At least driver seat has an active massage functionality |
|
Boolean |
Vehicle warns driver if they get tired |
|
Boolean |
The vehicle supports the driver while driving at night. It might show heat signatures of larger living things and might warn the driver if there could be a collision possibility |
|
Boolean |
Vehicle is able to initiate (automatically) an emergency call if in an accident |
|
Boolean |
Tire pressure is (constantly) measured and reported by the vehicle |
|
Boolean |
It is possible to change gears with paddles at the steering wheel |
|
Boolean |
Rear passenger seats can be heated |
|
Boolean |
Vehicle has a better sound system compared to the standard audio system of this model |
|
Boolean |
Certain aspects of a car (usually hands free phone system) can be controlled by voice |
|
Boolean |
Certain aspects of the car, usually the entertainment system, have a touch screen interface |
|
Boolean |
The vehicle has a USB port in the passenger area, usually for connecting a media player or smart phone to the entertainment system or for charging devices |
|
Boolean |
Vehicle is able to recognize traffic signs and show the recognized signs to the driver |
|
Boolean |
Vehicle recognizes oncoming traffic and switches between high and low beam |
|
Boolean |
Vehicle does include summer tires. This does not have to include rims |
|
Boolean |
Vehicle does include winter tires. This does not have to include rims |
|
Boolean |
Vehicle does include all season tires. This does not have to include rims |
|
Boolean |
Vehicle does include steel rims. The vehicle might include steel and alloy rims, together with summer and winter tires, this would be a complete 8 tire set |
|
Boolean |
High beam is able to mask oncoming traffic automatically. This is not to be mistaken for high beam assist. |
|
Boolean |
system to clean main front headlights |
|
Boolean |
Package usually named with any manufacturer winter package |
|
Boolean |
Package usually named with any manufacturer smoker´s package. Might include things like ashtrays or cigarette lighters |
|
Boolean |
Vehicle tries to prevent a collision with other vehicles or objects by warning the driver |
|
Boolean |
Back Passanger Seats are electrically adjustable |
|
Boolean |
(various) parts of the vehicle interior can be lighted with soft lights during driving. Color of those lights might be able to be changed |
|
Boolean |
Vehicle has an integrated WiFi Hotspot and probable Internet connection to allow passengers to use WiFi devices |
|
Boolean |
Vehicles entertainment system supports Apples CarPlay system. This allows an iPhone to take over the user interface of the entertainment systems (in part) |
|
Boolean |
Vehicles entertainment system supports Android Auto system. This allows an Android Phone to take over the user interface of the entertainment systems (in part) |
|
Boolean |
There are no dedicated, single purpose instruments behind the steering wheel. The whole area is a screen and can be adjusted to the drivers requirements. |
|
Boolean |
Front passager seat has Isofix connection points for anchoring a child seat |
|
Boolean |
Vehicle has the capability to inductively charge a smartphone for example via the Qi standard |
|
Boolean |
Vehicle has a streaming service client (e.g. Spotify client) integrated to play music via this streaming service without a smart phone being present |
|
Boolean |
Interior monitor dims automatically if it senses to much light coming from following vehicles |
|
Boolean |
Front passager seat is completely foldable allowing for transporting longer items |
|
Boolean |
It is possible to have a stable barrier between the cargo area / trunk and passenger area, e.g. with a net |
|
Boolean |
The vehicle provides the possibility to set a speed limit, the driver usually is able to override this speed limit for example by pressing the gas pedal harder |
|
Boolean |
Electric vehicle has a petrol support motor charging the battery if it is empty. Main engine(s) are driven with electrical power |
|
Boolean |
Vehicle tries to prevent a collision with other vehicles or objects by warning the driver and enforcing an emergency break or supporting the breaking effort of the driver |
|
Boolean |
Vehicle doors can be opened without a key. This could be done with pressing a button on a key fob or automatically by proximity |
|
Boolean |
At least driver seat is ventilated |
|
Boolean |
Vehicle tries to either actively (vehicle steers itself) or passively (warns driver if lane is left) to keep itself in a lane |
|
Boolean |
Vehicle warns the driver, if there are objects in the blind spots of the car |
|
Int |
Information about the number of EBike gears, integer, Only for EBikes |
|
String |
Information about the frame shape of the EBike. See frame shapes for possible values. Only for EBikes |
|
String |
Information about the frame material of the EBike. See frame materials for possible values. Only for EBikes |
|
String |
Information about the battery position of the EBike. battery positions for possible values. Only for EBikes |
|
String |
Information about the battery manufacturer of the EBike. See battery manufacturers for possible values. Only for EBikes |
|
String |
Information about the motor position of the EBike. See motor positions for possible values. Only for EBikes |
|
String |
Information about for whom the EBike is suitable for. See bike suitable for for possible values. Only for EBikes |
|
String |
Information about the gear type of the EBike. See bike gear types for possible values. Only for EBikes |
|
String |
Information about the wheel size of EBike, Free text, Only for EBikes |
|
Int |
Information about the frame height of the EBike, integer, Only for EBikes |
|
Int |
Battery capacity of the EBike. Notation in Wh, integer, Only for EBikes |
|
String |
The number of EBike Frame, Free text |
|
Int |
weight in kg |
|
String |
The last maintenance date of vehicle in ISO 8601 date e. g. 2016-07 |
|
Int |
mileage as of last maintenance/service date |
|
Int |
maximum trailer load, braked |
|
Int |
maximum trailer load, unbraked |
|
Int |
maximum weight or downward force from the caravan’s hitch to the tow car’s tow ball |
|
Int |
operating weight in kg |
|
Int |
height of seats in mm |
|
Int |
amount of cylinders |
|
Int |
volume of fuel tank in liters |
|
Collection of String |
available heating types, possible enum values are GAS, DIESEL, PETROL, ELECTRIC, WOOD |
|
Int |
standing height in cm |
|
Int |
maximum payload in kg |
|
Int |
amount of seats with seat belts |
|
String |
length type, possible enum values are L1, L2, L3, L4, L5 |
|
String |
height type, possible enum values are H1, H2, H3 |
|
String |
drive type, possible values are FRONT, REAR, ALL_WHEEL |
|
String |
wheel base, possible enum values are SHORT, MIDDLE, LONG, EXTRA_LONG |
|
Boolean |
If the vehicle has suspended front axle |
|
Boolean |
If the vehicle has suspended cab |
|
Boolean |
If the vehicle has air brake system |
|
Boolean |
frontal power take-off shaft |
|
Boolean |
If the vehicle has virtual side mirrors |
|
Boolean |
on purchase, vehicle gets a new service/inspection |
|
Boolean |
if the vehicle has navigation preparation |
|
Boolean |
if the vehicle has matter color |
|
Boolean |
If the vehicle Eligible for BAFA funding |
|
Boolean |
battery health certificate available |
|
Boolean |
If the vehicle is right hand drive |
|
Boolean |
If the vehicle has bidirectional charging |
|
Boolean |
If the vehicle has folding roof |
|
Boolean |
If the vehicle has heat pump |
|
Boolean |
If the vehicle has memory seats |
|
Boolean |
If the vehicle has stoppie control |
|
Boolean |
If the vehicle has wheelie control |
|
Boolean |
If the vehicle has banking abs |
|
Boolean |
If the vehicle has quick shifter |
|
Boolean |
If the vehicle has blipper |
|
Boolean |
If the vehicle has handle heating |
|
Boolean |
If the vehicle has semi active chassis |
|
Boolean |
If the vehicle has throttle |
|
Boolean |
If the vehicle has satellite system |
|
Boolean |
If the vehicle has bike rack |
|
Boolean |
If the vehicle has manoeuvring system |
|
Boolean |
If the vehicle has hot water |
|
Boolean |
If the vehicle has steering axle |
|
Boolean |
If the vehicle has reat traffic alert |
|
Boolean |
If the vehicle has dynamic chassis control |
|
Boolean |
If the vehicle has trailer assist |
|
Boolean |
If the vehicle has tinted windows |
|
Boolean |
If the vehicle has folding exterior mirrors |
|
Boolean |
If the vehicle has queen size bed |
|
Boolean |
If the vehicle has french bed |
|
Boolean |
If the vehicle has single |
|
Boolean |
If the vehicle has rear double bed |
|
Boolean |
If the vehicle has front double bed |
|
Boolean |
If the vehicle has drop down bed |
|
Boolean |
If the vehicle has popup roof double bed |
|
Boolean |
If the vehicle has seat conversion bed |
|
Boolean |
If the vehicle has l shaped seating arrangement |
|
Boolean |
If the vehicle has bar version seating arrangement |
|
Boolean |
If the dealer sells vehicle on customer’s behalf |
|
Description / Images / Video |
||
String |
Free text description of the vehicle. |
|
String |
vehicle description in plain text. |
|
Collection of Image |
List of images |
|
String |
Youtube url in youtube.com/xxx format |
|
Collection of String |
Short notes highlighting key features of the vehicle. |
|
String |
URL pointing to the detail page of this ad. |
|
Contact data. |
||
Catalog Data |
||
Germany only, Classification of makes and models, given by Kraftfahrtbundesamt (KBA) |
||
Int |
Classification of makes and models given by Eurotax/Schwacke |
|
OFFER |
||
String |
Date when the vehicle is ready to be delivered to the customer, e.g. 2015-06-12. See Date Time Representation for details. |
|
Int |
Time-span in days until the vehicle is ready to be delivered. Information only for new vehicles. Allowed Values: 1, 2, 3, 4, 5, 6, 7, 14, 42, 60, 90, 120, 150, 180, 270 and 360 |
|
String |
Information and restrictions about Used-Car-Seals can be found here. Not visible to all users. See used car seals for possible values. |
|
Boolean |
Visible as featured item on the dealers homepage ("Unsere Empfehlung") |
|
Boolean |
Visible only in closed domain not in public domain |
|
Boolean |
No private Selling offer, only for commercial or export |
|
Boolean |
Vehicle is sold including additional warranty on top of the statutory warranty that is mandatory when selling to private persons. |
|
Boolean |
Renting possible |
|
Price information. Check details of the |
||
Financing offer information. Check details of the |
||
Information on leasing conditions. |
||
Deprecated Fields |
Financing
Field Name | Type | Description |
---|---|---|
String |
Percentage. AKA rate-per-cent (seller-ad-1.1.xsd), effektiver Jahreszins (German). Must be between 0 and 19.99 and can only have two digits after comma. |
|
String |
Percentage. AKA nominal-interest-rate (seller-ad-1.1.xsd), Sollzinssatz (German). |
|
String |
AKA type-of-nominal-interest-rate (seller-ad-1.1.xsd), Art des Sollzinssatzes (German). nominal interest rate types |
|
Int |
A nonrecurring payment at the beginning of the payback period. Currency is the same as the vehicle price. AKA Anzahlung (German). |
|
Int |
The monthly recurring payment. Currency is the same as the vehicle price. AKA monthly-rate (seller-ad-1.1.xsd), monatliche Rate (German). |
|
Int |
A nonrecurring payment at the end of the payback period. Currency is the same as the vehicle price. AKA ending-rate (seller-ad-1.1.xsd), Schlussrate (German). |
|
String |
Duration in months. AKA period (seller-ad-1.1.xsd), Laufzeit in Monaten (German). payback periods |
|
String |
Currency is the same as the vehicle price. AKA net-credit-amount (seller-ad-1.1.xsd), Nettokreditbetrag (German). |
|
String |
Currency is the same as the vehicle price. AKA gross-credit-amount (seller-ad-1.1.xsd), Bruttokreditbetrag (German). |
|
String |
A fee for placing the loan contract. Currency is the same as the vehicle price. AKA Abschlussgebühren (German). |
|
String |
Costs of such insurance. Currency is the same as the vehicle price. AKA rate-insurance (seller-ad-1.1.xsd), Ratenabsicherung (EUR) (German). |
|
String |
Description of the bank. AKA Anbieterbank (German) max. 150 characters. |
|
String |
Description of further conditions. max. 60 characters. |
|
String |
Leasing comment, will show up in leasing description for the potential buyer |
Leasing
The currency fields are represented as String using the .
as decimal separator with two
digits precision. The fields should be parsed using arbitrary rounding strategy.
Field Name | Type | Description |
---|---|---|
Int |
Price of the vehicle for other dealers including VAT if reclaimable. Only visible in dealer area. |
|
String |
The VAT rate as percent number. |
|
String |
Name of the lender / leasing bank. |
|
Collection of LeasingRate |
List of leasing rates. At least one PRIVATE rate is required. |
|
String |
Leasing comment, will show up in leasing description for the potential buyer. |
LeasingRate
Leasing Rate.
Field Name | Type | Description |
---|---|---|
Target group of this leasing rate. |
||
Int |
This is the amount the buyer needs to pay at the beginning of the leasing contract. |
|
Int |
This is the length of the leasing contract in months. |
|
Int |
Annual mileage in KM. At least one rate for type PRIVATE with 10000km annual mileage is mandatory for a leasing offer. |
|
String |
The rate the buyer needs to pay in a given month during the contract period. It includes the German VAT rate, as these offers are currently only for customers in Germany. (Required for type PRIVATE) |
|
String |
Net leasing rate, see above (not including VAT for commercial leasing). (Required for type COMMERCIAL) |
|
String |
Net loan amount (in German Nettodarlehnbetrag). (Required for type PRIVATE) |
|
String |
This is the total amount the buyer needs to pay over the length of the contract. Usually this is the rate times the number of months in the contract duration. |
|
String |
Annual percentage rate, (in German Effektiver Jahreszins). (Required for type PRIVATE) |
|
String |
Nominal interest rate (in German Sollzins p.a.) (Required for type PRIVATE) |
|
String |
Destination charges / freight costs. These are the costs the buyer needs to pay for freight costs (in German Überführungskosten). If it is "0.00", we will display charges, including to the buyer. This field is optional (we will show, "no information available" to the buyer by default). |
|
String |
Registration fees (in German Zulassungskosten). Same rules as for Destination Charges. |
|
String |
Extra mileage costs, (in German Mehrkilometer Kosten). The costs a buyer needs to pay at the end of the contract if they have incurred a higher mileage than allowed for in the leasing contract. |
|
String |
Low mileage compensation, (in German Minderkilometer Erstattung). The amount a buyer gets returned at the end of the contract if they have incurred a lower mileage than agreed for in the leasing contract. |
Price
The currency fields are represented as String using the .
as decimal separator with two
digits precision. The fields should be parsed using arbitrary rounding strategy.
Field Name | Type | Description |
---|---|---|
String |
Price of the vehicle for other dealers including VAT if reclaimable. Only visible in dealer area. |
|
String |
Price of the vehicle for private buyers including VAT if reclaimable. This is the main price shown. |
|
String |
Net price of the vehicle for other dealers. Can only be used when providing a VAT rate as gross price is calculated then. Only visible in dealer area. |
|
String |
Net price of the vehicle for private buyers. Can only be used when providing a VAT rate as gross price is calculated then. price type explanation of values price types |
|
String |
The VAT rate as percent number (a number between 0 and 100). For example 19. When you add this attribute then your vehicle is displayed as VAT deductible. See vat rates |
|
String |
For AgricultureVehicle, Bus, ConstructionMachine, ForkliftTruck, SemiTrailer, SemiTrailerTruck, Trailer, TruckOver7500, VanUpTo7500 it is possible to set price type ON_REQUEST. In that case price element must only contain the price type. The following price types are possible price types. FIXED is the default value. |
|
String |
Information in which currency the price is stated. During upload this field is ignored and the currency taken from the sellers site-ID instead. |
Image
Field Name | Type | Description |
---|---|---|
String |
MD5 checksum of the original uploaded customer image |
|
String |
url to the 80x60 image |
|
String |
url to the 200x150 image |
|
String |
url to the 240x180 image (298 x 244 until Q2 2022) |
|
String |
url to the 360x270 image (400 x 300 until Q2 2022) |
|
String |
url to the 640x480 image |
|
String |
url to the 1024x768 image |
|
String |
url to the 1600x1200 image |
Images
Field Name | Type | Description |
---|---|---|
Collection of Image |
List of images |
Dimension
Field Name | Type | Description |
---|---|---|
Int |
Length. Notation in mm |
|
Int |
Width. Notation in mm |
|
Int |
Height. Notation in mm |
Kba
Field Name | Type | Description |
---|---|---|
String |
Germany only, Herstellerschlüsselnummer |
|
String |
Germany only, Typschlüsselnummer |
Seller
Field Name | Type | Description |
---|---|---|
String |
mobile-platform Seller ID |
|
String |
e.g. 2015-06-12T11:58:32+02:00. |
|
String |
Contact email. |
|
Geolocation of the seller. |
||
String |
First name of a private seller. |
|
String |
Last name of a private seller. |
|
String |
Legal name for commercial sellers. |
|
Boolean |
When set to 'false' the customers name won’t be displayed in its ads. |
|
Boolean |
When set to 'false' the customers phone number won’t be shown in its ads. |
|
Collection of Phone |
Contact phone numbers. |
|
Contact cell phone number. |
||
Contact fax number. |
||
Address. |
||
String |
Commercial or private seller. |
|
Boolean |
Commercial or non-profit seller. |
|
String |
Url to the seller home pgae. |
|
String |
DEPRECATED - use |
|
dealer logo |
GeoData
Field Name | Type | Description |
---|---|---|
Double |
Longitude - decimal representation. |
|
Double |
Latitude - decimal representation. |
Phone
Field Name | Type | Description |
---|---|---|
Int |
County code. |
|
String |
Area code. |
|
String |
Phone number. |
Address
Field Name | Type | Description |
---|---|---|
String |
Address. |
|
String |
||
String |
Address. |
|
String |
Address. |
|
String |
Address. |
|
String |
Address - notation http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2. |
WltpValues
Field Name | Type | Description |
---|---|---|
Float |
Amount of carbon dioxide emissions in g/km for all vehicles, optional for plugin hybrids. |
|
Float |
Weighted amount of carbon dioxide emissions in g/km for plugin hybrids |
|
Float |
Combined power consumption for electric vehicles in in kWh/100km |
|
Float |
Weighted combined power consumption for plugin hybrids in kWh/100km |
|
Float |
Combined fuel consumption for all nonelectric vehicles, optional for plugin hybrids, number in l/100km (natural gas (CNG) in kg/100km) |
|
Float |
Weighted combined fuel consumption for plugin hybrids |
|
Int |
Electric Range for plugin hybrids and electric vehicles in km |
Emissions
Field Name | Type | Description |
---|---|---|
Combined (in case of plugin hybrid → combined/weighted) emission values |
||
Emission values for plugin hybrid when battery is discharged |
Emission
Field Name | Type | Description |
---|---|---|
String |
CO₂ emission value in g/100 km. |
|
String |
CO₂ class. This property can have the following values → A, B, C, D, E, F, G |
Consumptions
Field Name | Type | Description |
---|---|---|
String |
WLTP weighted/combined fuel consumption value. Only for plugin hybrid. |
|
String |
WLTP weighted/combined power consumption value. Only for plugin hybrid. |
|
WLTP fuel consumption values. In case of plugin hybrid → fuel consumption when battery is discharged. |
||
WLTP electrical power consumption values. For plugin hybrid → electrical power consumption in pure electric mode. |
Consumption
Field Name | Type | Description |
---|---|---|
String |
energy consumption combined. |
|
String |
energy consumption inner city. |
|
String |
energy consumption in the outskirts of city. |
|
String |
energy consumption on country roads. |
|
String |
energy consumption on highways. |
CostModel
Field Name | Type | Description |
---|---|---|
String |
Assumed price of fuel in EUR per liter or kg |
|
String |
Assumed price of electricity in EUR per kWh |
|
String |
Predicted energy (fuel and power) costs in EUR for an annual mileage of 15,000 km. |
|
Int |
Year of which the average fuel and power prices are based upon |
|
String |
Annual vehicle tax in EUR |
|
The time frame for the predictions being made. |
||
Predicted CO₂ costs in EUR" |
TimeFrame
Field Name | Type | Description |
---|---|---|
Int |
The start year for the predictions being made |
|
Int |
The end year for the predictions being made |
Co2Costs
Field Name | Type | Description |
---|---|---|
model for low CO₂ prices |
||
model for high CO₂ prices |
||
model for middle CO₂ prices |
Co2Cost
Field Name | Type | Description |
---|---|---|
String |
The possible CO₂ cost in EUR/t |
|
String |
The possible accumulated CO₂ cost in EUR for the next 10 years and 15.000 km annual mileage |
ErrorResponse
Top level type that describes api call failure
Field Name | Type | Description |
---|---|---|
Collection of Error |
List of errors. For example a list of missing fields that are required for given operation. |
Error
Describes an api error.
Field Name | Type | Description |
---|---|---|
String |
Indicates a type of problem - e.g. missing required field or invalid field value |
|
String |
Human readable error description |
|
Collection of Arg |
List of key-value pairs detailing the failure |
Arg
Field Name | Type | Description |
---|---|---|
String |
Key of detailed error |
|
String |
Description of detailed error |
LeasingType
Possible Value | Description |
---|---|
PRIVATE |
Leasing rate is offered to private persons. |
COMMERCIAL |
Leasing rate is offered to commercial entities, could be a single person or a company. |
Date Time Representation
This part contains general information regarding how to work with date/time based fields in the APIs of mobile.de.
Date Time
The datetime information is represented as text that conforms to the ISO_8601 standard.
It is formatted using the Europe/Berlin
time zone offset, for example 2015-12-01T18:40:44+01:00
.
{
"creationDate": "2015-12-01T18:40:44+01:00"
}
<creationDate>2015-12-01T18:40:44+01:00</creationDate>
Month and Year
Some fields require only year and month precision. They are represented as text using yyyyMM
format.
{
"firstRegistration": "200909",
"generalInspection": "201611"
}
Year
The fields that require information only about the year are represented as a number using yyyy
format.
{
"constructionYear": 2010
}
Reference Data
Reference data is a set of tables that define valid values for a number of fields such as colors, makes, models and others.
Base url
The base url for the reference data endpoints is:
Authentication is not required for reference data endpoints. |
Media Type
The reference data is exposed using Legacy-Xml
, New Json
and New Xml
representation.
Please refer to MediaTypes section for more details.
Legacy Xml request
GET /refdata/petroltypes HTTP/1.1
Accept: application/xml
Legacy Xml response
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<reference:reference xmlns:seller="http://services.mobile.de/schema/seller" xmlns:ad="http://services.mobile.de/schema/ad" xmlns:financing="http://services.mobile.de/schema/common/financing-1.0" xmlns:reference="http://services.mobile.de/schema/reference" xmlns:resource="http://services.mobile.de/schema/resource" xmlns:leasing="http://services.mobile.de/schema/common/leasing-1.0">
<reference:item key="SUPER_PLUS" url="https://services.mobile.de/refdata/petroltypes/SUPER_PLUS">
<resource:local-description xml-lang="de">Super Plus</resource:local-description>
</reference:item>
<reference:item key="SUPER" url="https://services.mobile.de/refdata/petroltypes/SUPER">
<resource:local-description xml-lang="de">Super</resource:local-description>
</reference:item>
<reference:item key="NORMAL" url="https://services.mobile.de/refdata/petroltypes/NORMAL">
<resource:local-description xml-lang="de">Normal</resource:local-description>
</reference:item>
</reference:reference>
New Xml request
GET /refdata/petroltypes HTTP/1.1
Accept: application/vnd.de.mobile.api+xml
New Xml response
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<refList>
<values>
<refType>
<name>SUPER_PLUS</name>
<description>Super Plus</description>
<url>https://services.mobile.de/refdata/petroltypes/SUPER_PLUS</url>
</refType>
<refType>
<name>SUPER</name>
<description>Super</description>
<url>https://services.mobile.de/refdata/petroltypes/SUPER</url>
</refType>
<refType>
<name>NORMAL</name>
<description>Normal</description>
<url>https://services.mobile.de/refdata/petroltypes/NORMAL</url>
</refType>
</values>
</refList>
New Json request
GET /refdata/petroltypes HTTP/1.1
Accept: application/vnd.de.mobile.api+json
New Json response
{
"values": [
{
"name": "SUPER_PLUS",
"description": "Super Plus",
"url": "https://services.mobile.de/refdata/petroltypes/SUPER_PLUS"
},
{
"name": "SUPER",
"description": "Super",
"url": "https://services.mobile.de/refdata/petroltypes/SUPER"
},
{
"name": "NORMAL",
"description": "Normal",
"url": "https://services.mobile.de/refdata/petroltypes/NORMAL"
}
]
}
Internationalization Support
The reference data is localized.
Specifying the Accept-Language
header controls the language of the output.
Localized request
GET /refdata/gearboxes HTTP/1.1
Accept: application/vnd.de.mobile.api+json
Accept-Language: de
Localized response
{
"values": [
{
"name": "MANUAL_GEAR",
"description": "Schaltgetriebe"
},
{
"name": "SEMIAUTOMATIC_GEAR",
"description": "Halbautomatik"
},
{
"name": "AUTOMATIC_GEAR",
"description": "Automatik"
}
]
}
Reference Data Types
Site Dependent Types
Some reference data may depend on the Site Id
or could be based on some other types e.g. list of models
depends on selected make
.
The endpoints are parametrized using path parameters.
Furthermore, there is a site independent resource which contains all summarized site specific values and resources.
Type | Endpoint (site independent and site specific) |
---|---|
|
|
|
|
|
|
|
|
|
Site Independent Reference Data
Table | Endpoint |
---|---|
Support
Customer Support Contact
Please contact the Customer Support team if you need further assistance.
Country | Contact Details |
---|---|
Germany |
Phone: +49 (0) 30 81097500 or Contact Form |