Table of Contents

Introduction

Overview

Ad Stream is a push based interface that provides information about new and updated listings on the mobile.de platform.

It eliminates the need to actively poll the rest interface in order to get the newest listings. As soon as a listing is created and it becomes visible on the platform the Ad Stream interface will send the notification to the connected clients.

The Ad Stream is an interface to allow the users getting information about the latest listings. It also could be used for synchronizing a copy of the mobile.de inventory as it publishes events when listings are changed or deleted.

The interface uses the Web Socket protocol to send the events.

Endpoint and test environment

How to access the api.

Websocket endpoint url

The API is available at this url:

wss://services.mobile.de/ad-stream/events

Please contact the Customer Support and refer to the Authentication and Authorization section in order to get access to the service.

Test Environment

Test environment is only available for API Users that are having an active live account.

The test endpoint is available at

wss://services.mobile.de/test-ad-stream/events

It provides the same functionality as the live endpoint except the following:

  • the Delay is 60 seconds longer

  • it sends only 10% of all events

High Level Concepts

API User

An API user is an entity that has an API account and uses that account to connect to the interface. Please contact the Customer Support in order to set up the account and get the login credentials.

Ad

The ad represents a vehicle for sale that is published on the mobile.de platform. It consists among the others of:

  • vehicle details

  • price

  • images

Seller

The seller represents information about the owner of the vehicle. It consists among the others of:

  • seller name

  • address

  • contact details

Ad Stream Event

Ad Stream event is a message published to the connected users. Events are triggered when a new listing is created, updated or deleted on the mobile.de platform. The event payload contains full details about the relevant Ad and Seller.

Delay

The events are delivered to the client after a predefined delay. The actual delay depends on the contract. Please contact the Customer Support for more details.

Technical Overview

This section contains information how to use the Ad Stream from a technical perspective.

Web Socket

The interface uses the Web Socket protocol to send the events. Please refer to the following documents for more details

Once the connection is established the server starts publishing the events to the client. The connection is a long running communication channel and it could remain active for many days. Sometimes the connection gets terminated e.g. due to network problems or a new version of software installed on the mobile.de site. The client must ensure that it has a mechanism to automatically establish a new connection in that case. Please refer to the Ensuring Consistency section to find out how to make sure that no messages are lost during the reconnecting process.

Authentication and Authorization

Access to the interface is only possible for the authenticated users. The user must be authenticated with a username and password using the HTTP basic authentication scheme. For detailed information on HTTP basic authentication please refer to:

During the activation process the Customer Support will set up an API User and provide you with instructions how to get the access credentials.

Filters

The amount of events can be limited by a predefined filter (only vehicles from private sellers). Please contact the Customer Support for filters activation and more details.

Multiple connections

The Adstream application is limited to one connection per user. Once the user tries to establish more concurrent connections the previous connections will be closed automatically. Because of the latency after reconnecting and closing connections, there is no advantage in terms of reliability or consistency.

Ensuring Consistency

The interface provides a mechanism to ensure that all events are delivered to a given user even though the user connection is not active for a while. When a connection is established, first the historical events are delivered starting at the point when the previous connection was terminated. The historical events are kept for 24 hours.

The consistency option is not enabled by default. In order to activate it please include the catchup=true query parameter in the url.

wss://services.mobile.de/ad-stream/events?catchup=true

Please use the catchup=true option consistently across all active connections. Mixing the consistency option with regular connections at the same time will cause some unpredicted behavior of the interface.

Media Types

The events can be requested in different data formats.

Detailed description of data structures for individual data formats is available in the Data Format section.

The Ad Stream client indicates the preferred data representation using the Accept header with the corresponding media type.

Media type Http header

json

Accept: application/vnd.de.mobile.api+json

xml

Accept: application/vnd.de.mobile.api+xml

In case you do not use an Accept header you will retrieve the data in a third deprecated xml format, which is defiend in https://services.mobile.de/schema/search-1.0.xsd schema. This data format exists for backward compatibility and will be removed in near future. Detailed information can be found at the Deprecated Data Format section.

Data Format

The Ad Stream is representing data using either json or xml format. Both representations (media types) use the same schema in terms of field names and types. The Field names and types are described in Data Format Reference.

Sample event json
{
  "type": "AD_CREATE_OR_UPDATE",
  "mobileAdId": "474944",
  "ad": {
    "mobileAdId": "474944",
    "mobileSellerId": "15",
    "creationDate": "2018-04-10T15:29:21+02:00",
    "modificationDate": "2018-04-13T12:36:18+02:00",
    "vehicleClass": "Car",
    "category": "EstateCar",
    "make": "OPEL",
    "model": "Astra",
    "modelDescription": "Astra",
    "condition": "USED",
    "firstRegistration": "201301",
    "mileage": 123456,
    "cubicCapacity": 1984,
    "power": 108,
    "gearbox": "MANUAL_GEAR",
    "fuel": "PETROL",
    "fourWheelDrive": true,
    "e10Enabled": true,
    "performanceHandlingSystem": true,
    "startStopSystem": true,
    "envkvCompliant": false,
    "energyEfficiencyClass": "A+",
    "co2": 175,
    "consumptionInner": 10.2,
    "consumptionOuter": 5.9,
    "consumptionCombined": 7.5,
    "consumptionUnit": "LITER",
    "envkvPetrolType": "SUPER",
    "emissionSticker": "EMISSIONSSTICKER_GREEN",
    "exteriorColor": "BLACK",
    "metallic": true,
    "doors": "FOUR_OR_FIVE",
    "seats": 5,
    "interiorColor": "BLACK",
    "interiorType": "LEATHER",
    "generalInspection": "201801",
    "constructionDate": "2011-05-01T00:00:00+02:00",
    "numberOfPreviousOwners": 1,
    "fullServiceHistory": true,
    "nonSmokerVehicle": true,
    "countryVersion": "DE",
    "damageUnrepaired": false,
    "accidentDamaged": false,
    "roadworthy": true,
    "abs": true,
    "airbag": "FRONT_AND_SIDE_AND_MORE_AIRBAGS",
    "airSuspension": true,
    "alloyWheels": true,
    "automaticRainSensor": true,
    "auxiliaryHeating": true,
    "bendingLights": true,
    "bluetooth": true,
    "cdPlayer": true,
    "centralLocking": true,
    "disabledAccessible": true,
    "electricAdjustableSeats": true,
    "electricExteriorMirrors": true,
    "electricHeatedSeats": true,
    "electricWindows": true,
    "esp": true,
    "frontFogLights": true,
    "handsFreePhoneSystem": true,
    "headUpDisplay": true,
    "immobilizer": true,
    "isofix": true,
    "lightSensor": true,
    "multifunctionalWheel": true,
    "navigationSystem": true,
    "onBoardComputer": true,
    "panoramicGlassRoof": true,
    "parkingAssistants": [
      "CAM_360_DEGREES"
    ],
    "speedControl": "CRUISE_CONTROL",
    "radio": [
      "DAB_RADIO"
    ],
    "daytimeRunningLamps": "LED_RUNNING_LIGHTS",
    "slidingDoorType": "SLIDING_DOOR_RIGHT",
    "headlightType": "LED_HEADLIGHTS",
    "bendingLightsType": "BENDING_LIGHTS",
    "breakdownService": "SPARE_WHEEL",
    "battery": "BATTERY_RENTED",
    "trailerCouplingType": "TRAILER_COUPLING_FIX",
    "trimLine": "PREMIUM",
    "modelRange": "PDE",
    "firstModelsProductionDate": "201701",
    "batteryCapacity": 999,
    "powerAssistedSteering": true,
    "roofRails": true,
    "skiBag": true,
    "sportPackage": true,
    "sportSeats": true,
    "sunroof": true,
    "tractionControlSystem": true,
    "tv": true,
    "alarmSystem": true,
    "armRest": true,
    "heatedWindshield": true,
    "heatedSteeringWheel": true,
    "hillStartAssist": true,
    "electricTailgate": true,
    "leatherSteeringWheel": true,
    "lumbarSupport": true,
    "massageSeats": true,
    "fatigueWarningSystem": true,
    "nightVisionAssist": true,
    "emergencyCallSystem": true,
    "tirePressureMonitoring": true,
    "paddleShifters": true,
    "electricHeatedRearSeats": true,
    "soundSystem": true,
    "voiceControl": true,
    "touchscreen": true,
    "usb": true,
    "trafficSignRecognition": true,
    "highBeamAssist": true,
    "summerTires": true,
    "winterTires": true,
    "allSeasonTires": true,
    "steelWheels": true,
    "glareFreeHighBeam": true,
    "headlightWasherSystem": true,
    "winterPackage": true,
    "smokersPackage": true,
    "distanceWarningSystem": true,
    "electricBackseatAdjustment": true,
    "ambientLighting": true,
    "wifiHotspot": true,
    "carplay": true,
    "androidAuto": true,
    "digitalCockpit": true,
    "passengerSeatIsofixPoint": true,
    "wirelessCharging": true,
    "integratedMusicStreaming": true,
    "dimmingInteriorMirror": true,
    "foldFlatPassengerSeat": true,
    "cargoBarrier": true,
    "speedLimiter": true,
    "rangeExtender": true,
    "collisionAvoidance": true,
    "keylessEntry": true,
    "ventilatedSeats": true,
    "laneDepartureWarning": true,
    "blindSpotMonitor": true,
    "description": "Bla blub test ad with attributes 2018",
    "highlights": [
      "high one",
      "high two",
      "high three"
    ],
    "kba": {
      "hsn": "8004",
      "tsn": "AEC"
    },
    "schwackeCode": 10461443,
    "warranty": true,
    "price": {
      "consumerPriceGross": "29000.00",
      "type": "FIXED",
      "currency": "EUR"
    },
    "detailPageUrl": "https://suchen.mobile.de/auto-inserat/opel-astra-hamburg/474944.html",
    "seller": {
      "mobileSellerId": "15",
      "mobileSellerSince": "2013-10-23T22:00:00Z",
      "email": "1382625053197@gmx.net",
      "companyName": "Claus Test GmbH",
      "phones": [
        {
          "internationalPrefix": 49,
          "nationalPrefix": "0226",
          "number": "25053211"
        },
        {
          "internationalPrefix": 49,
          "nationalPrefix": "0226",
          "number": "25053212"
        }
      ],
      "cell": {
        "internationalPrefix": 49,
        "nationalPrefix": "0226",
        "number": "25053214"
      },
      "fax": {
        "internationalPrefix": 49,
        "nationalPrefix": "0226",
        "number": "25053213"
      },
      "address": {
        "street": "Eeixczszeesifms",
        "additionalAddressInfo": "",
        "zipcode": "20359",
        "city": "Hamburg",
        "country": "DE"
      },
      "type": "DEALER",
      "commercial": true,
      "homepage": "http://home.mobile.de/STORYTEST_DE_1382625053188251932957351843",
      "dealerLogoBaseUrl": "img.classistatic.de/api/v1/mo-prod/images/46/467621f9-acce-1d7f-ca2b-9f13912d713b?rule=eps_"
    }
  }
Sample event xml
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<event>
  <type>AD_CREATE_OR_UPDATE</type>
  <mobileAdId>474944</mobileAdId>
  <ad>
    <mobileAdId>474944</mobileAdId>
    <mobileSellerId>15</mobileSellerId>
    <creationDate>2018-04-10T15:29:21+02:00</creationDate>
    <modificationDate>2018-04-13T12:44:57+02:00</modificationDate>
    <vehicleClass>Car</vehicleClass>
    <category>EstateCar</category>
    <make>OPEL</make>
    <model>Astra</model>
    <modelDescription>Astra</modelDescription>
    <condition>USED</condition>
    <firstRegistration>201301</firstRegistration>
    <mileage>123456</mileage>
    <cubicCapacity>1984</cubicCapacity>
    <power>108</power>
    <gearbox>MANUAL_GEAR</gearbox>
    <fuel>PETROL</fuel>
    <fourWheelDrive>true</fourWheelDrive>
    <e10Enabled>true</e10Enabled>
    <performanceHandlingSystem>true</performanceHandlingSystem>
    <startStopSystem>true</startStopSystem>
    <envkvCompliant>false</envkvCompliant>
    <energyEfficiencyClass>A+</energyEfficiencyClass>
    <co2>175.0</co2>
    <consumptionInner>10.2</consumptionInner>
    <consumptionOuter>5.9</consumptionOuter>
    <consumptionCombined>7.5</consumptionCombined>
    <consumptionUnit>LITER</consumptionUnit>
    <envkvPetrolType>SUPER</envkvPetrolType>
    <emissionSticker>EMISSIONSSTICKER_GREEN</emissionSticker>
    <emissionClass>EURO6D</emissionClass>
    <exteriorColor>BLACK</exteriorColor>
    <metallic>true</metallic>
    <doors>FOUR_OR_FIVE</doors>
    <seats>5</seats>
    <interiorColor>BLACK</interiorColor>
    <interiorType>LEATHER</interiorType>
    <generalInspection>201801</generalInspection>
    <constructionDate>2011-05-01T00:00:00+02:00</constructionDate>
    <numberOfPreviousOwners>1</numberOfPreviousOwners>
    <fullServiceHistory>true</fullServiceHistory>
    <nonSmokerVehicle>true</nonSmokerVehicle>
    <countryVersion>DE</countryVersion>
    <damageUnrepaired>false</damageUnrepaired>
    <accidentDamaged>false</accidentDamaged>
    <roadworthy>true</roadworthy>
    <abs>true</abs>
    <airbag>FRONT_AND_SIDE_AND_MORE_AIRBAGS</airbag>
    <airSuspension>true</airSuspension>
    <alloyWheels>true</alloyWheels>
    <automaticRainSensor>true</automaticRainSensor>
    <auxiliaryHeating>true</auxiliaryHeating>
    <bendingLights>true</bendingLights>
    <bluetooth>true</bluetooth>
    <cdPlayer>true</cdPlayer>
    <centralLocking>true</centralLocking>
    <climatisation>AUTOMATIC_CLIMATISATION_2_ZONES</climatisation>
    <disabledAccessible>true</disabledAccessible>
    <electricAdjustableSeats>true</electricAdjustableSeats>
    <electricExteriorMirrors>true</electricExteriorMirrors>
    <electricHeatedSeats>true</electricHeatedSeats>
    <electricWindows>true</electricWindows>
    <esp>true</esp>
    <frontFogLights>true</frontFogLights>
    <handsFreePhoneSystem>true</handsFreePhoneSystem>
    <headUpDisplay>true</headUpDisplay>
    <immobilizer>true</immobilizer>
    <isofix>true</isofix>
    <lightSensor>true</lightSensor>
    <multifunctionalWheel>true</multifunctionalWheel>
    <navigationSystem>true</navigationSystem>
    <onBoardComputer>true</onBoardComputer>
    <panoramicGlassRoof>true</panoramicGlassRoof>
    <parkingAssistants>
      <value>CAM_360_DEGREES</value>
    </parkingAssistants>
    <speedControl>CRUISE_CONTROL</speedControl>
    <radio>
      <value>DAB_RADIO</value>
    </radio>
    <daytimeRunningLamps>LED_RUNNING_LIGHTS</daytimeRunningLamps>
    <slidingDoorType>SLIDING_DOOR_RIGHT</slidingDoorType>
    <headlightType>LED_HEADLIGHTS</headlightType>
    <bendingLightsType>BENDING_LIGHTS</bendingLightsType>
    <breakdownService>SPARE_WHEEL</breakdownService>
    <battery>BATTERY_RENTED</battery>
    <trailerCouplingType>TRAILER_COUPLING_FIX</trailerCouplingType>
    <trimLine>PREMIUM</trimLine>
    <modelRange>PDE</modelRange>
    <firstModelsProductionDate>201701</firstModelsProductionDate>
    <batteryCapacity>999</batteryCapacity>
    <powerAssistedSteering>true</powerAssistedSteering>
    <roofRails>true</roofRails>
    <skiBag>true</skiBag>
    <sportPackage>true</sportPackage>
    <sportSeats>true</sportSeats>
    <sunroof>true</sunroof>
    <tractionControlSystem>true</tractionControlSystem>
    <tv>true</tv>
    <alarmSystem>true</alarmSystem>
    <armRest>true</armRest>
    <heatedWindshield>true</heatedWindshield>
    <heatedSteeringWheel>true</heatedSteeringWheel>
    <hillStartAssist>true</hillStartAssist>
    <electricTailgate>true</electricTailgate>
    <leatherSteeringWheel>true</leatherSteeringWheel>
    <lumbarSupport>true</lumbarSupport>
    <massageSeats>true</massageSeats>
    <fatigueWarningSystem>true</fatigueWarningSystem>
    <nightVisionAssist>true</nightVisionAssist>
    <emergencyCallSystem>true</emergencyCallSystem>
    <tirePressureMonitoring>true</tirePressureMonitoring>
    <paddleShifters>true</paddleShifters>
    <electricHeatedRearSeats>true</electricHeatedRearSeats>
    <soundSystem>true</soundSystem>
    <voiceControl>true</voiceControl>
    <touchscreen>true</touchscreen>
    <usb>true</usb>
    <trafficSignRecognition>true</trafficSignRecognition>
    <highBeamAssist>true</highBeamAssist>
    <summerTires>true</summerTires>
    <winterTires>true</winterTires>
    <allSeasonTires>true</allSeasonTires>
    <steelWheels>true</steelWheels>
    <glareFreeHighBeam>true</glareFreeHighBeam>
    <headlightWasherSystem>true</headlightWasherSystem>
    <winterPackage>true</winterPackage>
    <smokersPackage>true</smokersPackage>
    <distanceWarningSystem>true</distanceWarningSystem>
    <electricBackseatAdjustment>true</electricBackseatAdjustment>
    <ambientLighting>true</ambientLighting>
    <wifiHotspot>true</wifiHotspot>
    <carplay>true</carplay>
    <androidAuto>true</androidAuto>
    <digitalCockpit>true</digitalCockpit>
    <passengerSeatIsofixPoint>true</passengerSeatIsofixPoint>
    <wirelessCharging>true</wirelessCharging>
    <integratedMusicStreaming>true</integratedMusicStreaming>
    <dimmingInteriorMirror>true</dimmingInteriorMirror>
    <foldFlatPassengerSeat>true</foldFlatPassengerSeat>
    <cargoBarrier>true</cargoBarrier>
    <speedLimiter>true</speedLimiter>
    <rangeExtender>true</rangeExtender>
    <collisionAvoidance>true</collisionAvoidance>
    <keylessEntry>true</keylessEntry>
    <ventilatedSeats>true</ventilatedSeats>
    <laneDepartureWarning>true</laneDepartureWarning>
    <blindSpotMonitor>true</blindSpotMonitor>
    <description>Bla blub test ad with attributes 2018</description>
    <highlights>
      <value>high one</value>
      <value>high two</value>
      <value>high three</value>
    </highlights>
    <kba>
      <hsn>8004</hsn>
      <tsn>AEC</tsn>
    </kba>
    <schwackeCode>10461443</schwackeCode>
    <warranty>true</warranty>
    <price>
      <consumerPriceGross>29000.00</consumerPriceGross>
      <type>FIXED</type>
      <currency>EUR</currency>
    </price>
    <detailPageUrl>https://suchen.mobile.de/auto-inserat/opel-astra-hamburg/474944.html
    </detailPageUrl>
    <seller>
      <mobileSellerId>15</mobileSellerId>
      <mobileSellerSince>2013-10-23T22:00:00Z</mobileSellerSince>
      <email>1382625053197@gmx.net</email>
      <companyName>Claus Test GmbH</companyName>
      <phones>
        <phone>
          <internationalPrefix>49</internationalPrefix>
          <nationalPrefix>0226</nationalPrefix>
          <number>25053211</number>
        </phone>
        <phone>
          <internationalPrefix>49</internationalPrefix>
          <nationalPrefix>0226</nationalPrefix>
          <number>25053212</number>
        </phone>
      </phones>
      <cell>
        <internationalPrefix>49</internationalPrefix>
        <nationalPrefix>0226</nationalPrefix>
        <number>25053214</number>
      </cell>
      <fax>
        <internationalPrefix>49</internationalPrefix>
        <nationalPrefix>0226</nationalPrefix>
        <number>25053213</number>
      </fax>
      <address>
        <street>Eeixczszeesifms</street>
        <additionalAddressInfo></additionalAddressInfo>
        <zipcode>20359</zipcode>
        <city>Hamburg</city>
        <country>DE</country>
      </address>
      <type>DEALER</type>
      <commercial>true</commercial>
      <homepage>http://home.mobile.de/STORYTEST_DE_1382625053188251932957351843</homepage>
      <dealerLogoBaseUrl>img.classistatic.de/api/v1/mo-prod/images/46/467621f9-acce-1d7f-ca2b-9f13912d713b?rule=eps_
      </dealerLogoBaseUrl>
    </seller>
  </ad>
</event>

Data Format Reference

This section describes various aspects of the data provided by the service.

Data Types Reference

This section contains a detailed definition of the data produced by the Ad Stream application. 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.

For Example

The data fragment below contains fields of types String, Int, Boolean and Price

{
  "type": "AD_CREATE_OR_UPDATE",
  "mobileAdId": "474944",
  "ad": {
    "make": "AUDI", (1)
    "cubicCapacity": 665, (2)
    "fullServiceHistory": true, (3)
    "price": { (4)
      "consumerPriceGross": "2000.00",
      "type": "FIXED",
      "currency": "EUR"
    }
    ...
  }
  ...
} (5)
1 The make field is of type String
2 The cubicCapacity field is of type Int
3 The fullServiceHistory field is of type Boolean
4 The price field is of type Price which logically groups some other fields
5 The top level type for event data is Event - it specifies that e.g. type and ad are valid field names on this level

The below sections contain explanation of all the fields and how they are grouped together into types.

Ad

Top level type for representing Ad data.

Field Name Type Description

PLATFORM METADATA

mobileAdId

String

mobile-platform Ad ID

mobileSellerId

String

mobile-platform Seller ID

creationDate

String

e.g. 2015-06-12T11:58:32+02:00. See Date Time Representation for details.

modificationDate

String

e.g. 2015-06-12T11:58:32+02:00. See Date Time Representation for details.

VEHICLE

Key Fields

vehicleClass

String

The GENERAL classification of vehicles e.g. Car or Motorbike. See vehicle classes for possible values.

category

String

The DETAILED classification of vehicles e.g. Cabrio or Limousine. See categories for possible values.

make

String

Make of the vehicle e.g. Mercedes, Toyota. See makes for possible values.

model

String

Model of the vehicle e.g. X5, Prius. See models for possible values.

modelDescription

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.

condition

String

Is the vehicle new or used? See conditions for possible values.

usageType

String

Type of used car. See usage types for possible values.

firstRegistration

String

yyyyMM. See Date Time Representation for details.

mileage

Int

mileage in km

vin

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.

internalNumber

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

cubicCapacity

Int

Cubic-capacity of the engine. Notation integer.

power

Int

Power of the vehicle. Notation in KW

gearbox

String

Stickshift, automatic? See gear boxes for possible values.

fuel

String

Type of fuel. See fuel for possible values.

axles

Int

Number of axles, integer. Information only for commercial vehicles

fourWheelDrive

Boolean

Four wheel drive

wheelFormula

String

The actuation of the vehicle. See wheel formulas for possible values.

hybridPlugin

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. See Fuel And Energy Consumption Validation Rules.

e10Enabled

Boolean

is the vehicle enabled for using E10 fuel

catalyticConverter

Boolean

Catalytic converter - motorcycles only

particulateFilterDiesel

Boolean

Particulate filter diesel

biodieselConversion

Boolean

Biodiesel conversion

biodieselSuitable

Boolean

Biodiesel suitable - Biodiesel suitable, only for diesel fuel - Biodiesel geeignet

vegetableoilfuelConversion

Boolean

Vegetableoilfuel conversion

vegetableoilfuelSuitable

Boolean

Vegetableoilfuel suitable - only cars and semi trailer trucks, only diesel fuel

performanceHandlingSystem

Boolean

Performance handling system - (Sportfahrwerk)

startStopSystem

Boolean

Start stop system

envkvCompliant

Boolean

Option to send vehicle with envkv values (energy consumption labelling scheme established by the European Union) - see semantic rules if applicable (EnVKV values are required for new cars, single day registration and demonstration vehicles). See http://services.mobile.de/docs/seller-api.html#_semantic_validation

energyEfficiencyClass

String

the label for the applicable class of energy consumption, ranges between A+++, A++, A+, A, B, C, D, E, F or G

co2

Float

Indicates the amount of carbon dioxide emissions in grams per kilometer traveled.

consumptionInner

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)

consumptionOuter

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)

consumptionCombined

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)

consumptionUnit

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

envkvPetrolType

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

consumptionPowerCombined

Float

See Fuel And Energy Consumption Validation Rules

emissionSticker

String

Emission sticker for German low emission zones (Feinstaubplakette für Umweltzone). See emission stickers for possible values.

emissionClass

String

EURO 1, 2, 3, 4, …​. See emission classes for possible values.

range

Int

electric range in km.

equivalentAllElectricRange

Int

WLTP electric range (EAER) in km (only for plugin hybrids)

emissions

Emissions

consumptions

Consumptions

costModel

CostModel

Exterior / Interior

exteriorColor

String

The mobile.de color name. This is a fixed set of colors. colors for possible values

manufacturerColorName

String

free text field for color. This field is restricted to a subset of UTF-8 characters.

metallic

Boolean

Metallic

doors

String

Number of doors. See door counts for possible values.

seats

Int

number of seats. For categories Car, Bus, Truck up to 7,5t.

interiorColor

String

Information about the color of the interior of the vehicle. See interior colors for possible values.

interiorType

String

Information about the material used in the interior of the vehicle. See interior types for possible values.

Facts

generalInspection

String

yyyyMM. See Date Time Representation for details.

exhaustInspection

String

yyyyMM. See Date Time Representation for details.

newHuAu

Boolean

Buyer get’s a new HU/AU

constructionYear

Int

Format yyyy. Information only for commercial vehicles

constructionDate

String

The day when the vehicle was built. See Date Time Representation for details.

numberOfPreviousOwners

Int

Information about the number of previous owners of the vehicle

fullServiceHistory

Boolean

Full service history - (Scheckheftgeplfegt)

nonSmokerVehicle

Boolean

Nonsmoker vehicle

countryVersion

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.

damageUnrepaired

Boolean

See http://services.mobile.de/manual/damage.html

accidentDamaged

Boolean

See http://services.mobile.de/manual/damage.html (available only for cars)

roadworthy

Boolean

See http://services.mobile.de/manual/damage.html (available only for cars)

taxi

Boolean

Usable if the car is or was a taxi

Vehicle Details

wltpValues

WltpValues

Information about the WLTP values. See type WltpValues for more information.

abs

Boolean

Abs

airbag

String

Information about the airbags of the vehicle. See airbags for possible values.

airSuspension

Boolean

Air suspension

alloyWheels

Boolean

Alloy wheels

automaticRainSensor

Boolean

Rain sensor

auxiliaryHeating

Boolean

Auxiliary heating

awning

Boolean

An awning or overhang is a secondary covering attached to the exterior wall of a building.

bed

Boolean

Bed

bluetooth

Boolean

Bluetooth

box

Boolean

Box

bss

Boolean

Boom Suspension System

bunkBed

Boolean

Bunk bed

cabin

Boolean

Cabin

cdMultichanger

Boolean

CD multichanger

cdPlayer

Boolean

CD Player

centralLocking

Boolean

Central locking

centralLubricantApplication

Boolean

A system that delivers controlled amounts of lubricant to multiple locations on a machine while the machine is operating.

circularSeatingArrangement

Boolean

Circular seating arrangement

climatisation

String

Information on the climatisation of the vehicle. See climatisations for possible values.

coldstore

Boolean

Fridge

compressor

Boolean

Compressor

crane

Boolean

Crane

damageByHail

Boolean

Damage by hail

dimension

Dimension

The external dimension of the vehicle.

disabledAccessible

Boolean

Disabled accessible

disabledConversion

Boolean

Disabled conversion

discBrake

Boolean

Disc brake

divider

Boolean

Divider

driversSleepingCompartment

Boolean

Drivers sleeping compartment

drivingCab

String

Information about the cab of the truck. See driving cabs for possible values.

drivingMode

String

Does the motorbike have a chain or something else? See driving modes for possible values.

ebs

Boolean

Electronic Braking System

electricAdjustableSeats

Boolean

Electric adjustable seats

electricExteriorMirrors

Boolean

Electric mirrors

electricHeatedSeats

Boolean

Electric heated seats

electricStarter

Boolean

Electric starter

electricWindows

Boolean

Electric windows

esp

Boolean

Esp

europalletStorageSpaces

Int

Information about how many europallets suit in the vehicle.

frontFogLights

Boolean

Front fog lights

frontHydraulics

Boolean

Front hydraulics

frontJack

Boolean

Front Jack for Accessoires

fullFairing

Boolean

Full fairing increases effiency

handsFreePhoneSystem

Boolean

Hands free phone system

headUpDisplay

Boolean

Headup display

hydraulicInstallation

String

Indicates the type of hydraulic installation. See hydraulic installations for possible values.

immobilizer

Boolean

Immobilizer

installationHeight

Int

Notation in mm, integer. Information only for commercial vehicles

isofix

Boolean

ISOFIX is the international standard for attachment points for child safety seats in passenger cars

kickstarter

Boolean

Kickstarter - motorcycles only

kitchen

Boolean

Kitchen

licensedWeight

Int

Notation in kg, integer. Information only for commercial vehicles.

liftingCapacity

Int

Notation in kg, integer. Information only for commercial vehicles

liftingHeight

Int

Notation in mm, integer. Information only for commercial vehicles

lightSensor

Boolean

Light sensor

loadCapacity

Int

Notation in kg, integer. Information only for commercial vehicles

loadingSpace

Dimension

The loading space dimensions.

middleSeatingArrangement

Boolean

Middle seating arrangement

multifunctionalWheel

Boolean

Multifunctional wheel

municipal

Boolean

Municipal

navigationSystem

Boolean

Is the car having a build in navigation system. Not be be set for portable navigation systems

numberOfBunks

Int

The number of bunks. Only for Motorhome.

onBoardComputer

Boolean

On board computer

operatingHours

Int

Notation integer. Information only for commercial vehicles

panoramicGlassRoof

Boolean

Panoramic glass roof

parkingAssistants

Collection of String

Information about the parking assistants of the vehicle. parking assistants for possible values.

speedControl

String

Information about the speed control of the vehicle. See speed controls for possible values.

radio

Collection of String

Information about the radio of the vehicle. See radios for possible values.

daytimeRunningLamps

String

Information about the type of daytime running lamps of the vehicle. See [daytimeRunningLamps_refdata. daytime running lamps] for possible values.

slidingDoorType

String

Information about the type of sliding door of the vehicle. See sliding door types for possible values.

headlightType

String

Information about the headlight types of the vehicle. See headlight types for possible values.

bendingLightsType

String

Information about the type of cornering/bending lights of the vehicle. See bending lights types for possible values.

breakdownService

String

Information about the type of breakdown service kit of the vehicle. See breakdown services for possible values.

battery

String

Information about the battery of the electric vehicle. See batteries for possible values.

trailerCouplingType

String

Information about the trailer coupling type of the vehicle. See trailer coupling types for possible values.

trimLine

String

Information about the trim line a.k.a feature sets (Ausstattungslinie) of the vehicle. See trimlines.

modelRange

String

Information about the model range a.k.a. Baureihe of the vehicle. See modelranges.

firstModelsProductionDate

String

yyyyMM. See Date Time Representation for details.

batteryCapacity

Int

Battery capacity of the vehicle. Notation in kWh, integer

powerAssistedSteering

Boolean

Power assisted steering

protectionRoof

Boolean

Protection roof

quickChangeAttachment

Boolean

Quick change attachment

rearGarage

Boolean

Rear garage

retarder

Boolean

Used if the vehicle has an retader or intarder

roadLicence

Boolean

Road licence

rollOverBar

Boolean

Roll over bar

roofRails

Boolean

Roofrails

secondaryAirConditioning

Boolean

Secondary air conditioning - (Standklimaanlage)

sepShower

Boolean

Seperate Shower

shippingVolume

Int

The loading space volume. Notation in cubic meter

sideSeatingArrangement

Boolean

Side seating arrangement

skiBag

Boolean

Ski bag

sleepSeats

Boolean

Sleep seats

solarEnergySystem

Boolean

Solar energy system

sportPackage

Boolean

Sport package

sportSeats

Boolean

Sport seats

sunroof

Boolean

Sunroof

superSingleWheels

Boolean

Super single wheels

tailLift

Boolean

Tail lift

tractionControlSystem

Boolean

Traction control system

tv

Boolean

Tv

ureaTankAdBlue

Boolean

Urea tank ad blue

wc

Boolean

Toilet

windshield

Boolean

Windshield

alarmSystem

Boolean

The vehicle makes itself heard / seen, if someone tries to break into the car

armRest

Boolean

Arm rest between driver and front passenger seat

heatedWindshield

Boolean

Windshield has heating elements integrated (dedicated blowers to heat windshield are not to be considered as heated windshield)

heatedSteeringWheel

Boolean

Steering wheel can be heated

hillStartAssist

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

electricTailgate

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

leatherSteeringWheel

Boolean

Steering wheel is covered with leather

lumbarSupport

Boolean

Mechanism within at least the drivers seat which supports the back of a person during longer drives

massageSeats

Boolean

At least driver seat has an active massage functionality

fatigueWarningSystem

Boolean

Vehicle warns driver if they get tired

nightVisionAssist

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

emergencyCallSystem

Boolean

Vehicle is able to initiate (automatically) an emergency call if in an accident

tirePressureMonitoring

Boolean

Tire pressure is (constantly) measured and reported by the vehicle

paddleShifters

Boolean

It is possible to change gears with paddles at the steering wheel

electricHeatedRearSeats

Boolean

Rear passenger seats can be heated

soundSystem

Boolean

Vehicle has a better sound system compared to the standard audio system of this model

voiceControl

Boolean

Certain aspects of a car (usually hands free phone system) can be controlled by voice

touchscreen

Boolean

Certain aspects of the car, usually the entertainment system, have a touch screen interface

usb

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

trafficSignRecognition

Boolean

Vehicle is able to recognize traffic signs and show the recognized signs to the driver

highBeamAssist

Boolean

Vehicle recognizes oncoming traffic and switches between high and low beam

summerTires

Boolean

Vehicle does include summer tires. This does not have to include rims

winterTires

Boolean

Vehicle does include winter tires. This does not have to include rims

allSeasonTires

Boolean

Vehicle does include all season tires. This does not have to include rims

steelWheels

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

glareFreeHighBeam

Boolean

High beam is able to mask oncoming traffic automatically. This is not to be mistaken for high beam assist.

headlightWasherSystem

Boolean

system to clean main front headlights

winterPackage

Boolean

Package usually named with any manufacturer winter package

smokersPackage

Boolean

Package usually named with any manufacturer smoker´s package. Might include things like ashtrays or cigarette lighters

distanceWarningSystem

Boolean

Vehicle tries to prevent a collision with other vehicles or objects by warning the driver

electricBackseatAdjustment

Boolean

Back Passanger Seats are electrically adjustable

ambientLighting

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

wifiHotspot

Boolean

Vehicle has an integrated WiFi Hotspot and probable Internet connection to allow passengers to use WiFi devices

carplay

Boolean

Vehicles entertainment system supports Apples CarPlay system. This allows an iPhone to take over the user interface of the entertainment systems (in part)

androidAuto

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)

digitalCockpit

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.

passengerSeatIsofixPoint

Boolean

Front passager seat has Isofix connection points for anchoring a child seat

wirelessCharging

Boolean

Vehicle has the capability to inductively charge a smartphone for example via the Qi standard

integratedMusicStreaming

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

dimmingInteriorMirror

Boolean

Interior monitor dims automatically if it senses to much light coming from following vehicles

foldFlatPassengerSeat

Boolean

Front passager seat is completely foldable allowing for transporting longer items

cargoBarrier

Boolean

It is possible to have a stable barrier between the cargo area / trunk and passenger area, e.g. with a net

speedLimiter

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

rangeExtender

Boolean

Electric vehicle has a petrol support motor charging the battery if it is empty. Main engine(s) are driven with electrical power

collisionAvoidance

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

keylessEntry

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

ventilatedSeats

Boolean

At least driver seat is ventilated

laneDepartureWarning

Boolean

Vehicle tries to either actively (vehicle steers itself) or passively (warns driver if lane is left) to keep itself in a lane

blindSpotMonitor

Boolean

Vehicle warns the driver, if there are objects in the blind spots of the car

numberOfGears

Int

Information about the number of EBike gears, integer, Only for EBikes

frameShape

String

Information about the frame of the EBike. See https://services.mobile.de/refdata/frameshapes for possible values. Only for EBikes

frameMaterial

String

Information about the frame of the EBike. See https://services.mobile.de/refdata/framematerials for possible values. Only for EBikes

batteryPosition

String

Information about the frame material of the EBike. See https://services.mobile.de/refdata/batterypositions for possible values. Only for EBikes

batteryManufacturer

String

Information about the frame material of the EBike. See https://services.mobile.de/refdata/batterymanufacturers for possible values. Only for EBikes

motorPosition

String

Information about the frame material of the EBike. See https://services.mobile.de/refdata/motorpositions for possible values. Only for EBikes

bikeSuitableFor

String

Information about the frame material of the EBike. See https://services.mobile.de/refdata/bikesuitablefor for possible values. Only for EBikes

bikeGearType

String

Information about the frame material of the EBike. See https://services.mobile.de/refdata/bikegeartypes for possible values. Only for EBikes

wheelSize

String

Information about the wheel size of EBike, Free text, Only for EBikes

frameHeight

Int

Information about the number of EBike gears, integer, Only for EBikes

batteryCapacityWh

Int

Battery capacity of the EBike. Notation in Wh, integer, Only for EBikes

frameNumber

String

The number of EBike Frame, Free text

weight

Int

Information about the Weight of EBike, integer, Only for EBikes

Description / Images / Video

description

String

Free text description of the vehicle. Please be aware of special characters when sending formatted texts. More details via https://services.mobile.de/docs/seller-api.html#_special_characters_in_payload.

plainTextDescription

String

vehicle description in plain text.

images

Collection of Image

List of images

videoUrl

String

Youtube url in youtube.com/xxx format

highlights

Collection of String

Short notes highlighting key features of the vehicle The number of allowed highlights could be inspected via https://services.mobile.de/docs/seller-api.html#_retrieve_a_single_seller. This field is restricted to a subset of UTF-8 characters and has a max length of 22 characters.

detailPageUrl

String

URL pointing to the detail page of this ad.

seller

Seller

Contact data.

Catalog Data

kba

Kba

Germany only, Classification of makes and models, given by Kraftfahrtbundesamt (KBA)

schwackeCode

Int

Classification of makes and models given by Eurotax/Schwacke

OFFER

deliveryDate

String

Date when the vehicle is ready to be delivered to the customer, e.g. 2015-06-12. See Date Time Representation for details.

deliveryPeriod

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

usedCarSeal

String

Information and restrictions about Used-Car-Seals can be found here. Not visible to all users. See used car seals for possible values.

dealerHomepage

Boolean

Visible as featured item on the dealers homepage ("Unsere Empfehlung")

closedDomain

Boolean

Visible only in closed domain not in public domain

export

Boolean

No private Selling offer, only for commercial or export

warranty

Boolean

Vehicle is sold including additional warranty on top of the statutory warranty that is mandatory when selling to private persons.

rentingPossible

Boolean

Renting possible

price

Price

Price information. Check details of the Price type for more information.

financing

Financing

Financing offer information. Check details of the Financing type for more information.

leasing

Leasing

Information on leasing conditions.

Financing

Field Name Type Description

annualPercentageRate

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.

nominalInterestRate

String

Percentage. AKA nominal-interest-rate (seller-ad-1.1.xsd), Sollzinssatz (German).

typeOfNominalInterestRate

String

AKA type-of-nominal-interest-rate (seller-ad-1.1.xsd), Art des Sollzinssatzes (German). nominal interest rate types

firstInstallment

Int

A nonrecurring payment at the beginning of the payback period. Currency is the same as the vehicle price. AKA Anzahlung (German).

monthlyInstallment

Int

The monthly recurring payment. Currency is the same as the vehicle price. AKA monthly-rate (seller-ad-1.1.xsd), monatliche Rate (German).

finalInstallment

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).

paybackPeriod

String

Duration in months. AKA period (seller-ad-1.1.xsd), Laufzeit in Monaten (German). payback periods

netLoanAmount

String

Currency is the same as the vehicle price. AKA net-credit-amount (seller-ad-1.1.xsd), Nettokreditbetrag (German).

grossLoanAmount

String

Currency is the same as the vehicle price. AKA gross-credit-amount (seller-ad-1.1.xsd), Bruttokreditbetrag (German).

closingCosts

String

A fee for placing the loan contract. Currency is the same as the vehicle price. AKA Abschlussgebühren (German).

paymentProtectionInsurance

String

Costs of such insurance. Currency is the same as the vehicle price. AKA rate-insurance (seller-ad-1.1.xsd), Ratenabsicherung (EUR) (German).

bank

String

Description of the bank. AKA Anbieterbank (German) max. 150 characters.

conditions

String

Description of further conditions. max. 60 characters.

comment

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

grossListPrice

Int

Price of the vehicle for other dealers including VAT if reclaimable. Only visible in dealer area.

vatRate

String

The VAT rate as percent number.

lender

String

Name of the lender / leasing bank.

rates

Collection of LeasingRate

List of leasing rates. At least one PRIVATE rate is required.

comment

String

Leasing comment, will show up in leasing description for the potential buyer.

LeasingRate

Leasing Rate.

Field Name Type Description

type

LeasingType

Target group of this leasing rate.

downPayment

Int

This is the amount the buyer needs to pay at the beginning of the leasing contract.

termOfContract

Int

This is the length of the leasing contract in months.

annualMileage

Int

Annual mileage in KM. At least one rate for type PRIVATE with 10000km annual mileage is mandatory for a leasing offer.

grossRate

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)

netRate

String

Net leasing rate, see above (not including VAT for commercial leasing). (Required for type COMMERCIAL)

netLoanAmount

String

Net loan amount (in German Nettodarlehnbetrag). (Required for type PRIVATE)

totalAmount

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.

annualPercentageRate

String

Annual percentage rate, (in German Effektiver Jahreszins). (Required for type PRIVATE)

nominalInterestRate

String

Nominal interest rate (in German Sollzins p.a.) (Required for type PRIVATE)

destinationCharges

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).

registrationFees

String

Registration fees (in German Zulassungskosten). Same rules as for Destination Charges.

extraMileageCosts

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.

lowMileageCompensation

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

dealerPriceGross

String

Price of the vehicle for other dealers including VAT if reclaimable. Only visible in dealer area.

consumerPriceGross

String

Price of the vehicle for private buyers including VAT if reclaimable. This is the main price shown.

dealerPriceNet

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.

consumerPriceNet

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

vatRate

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

type

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.

currency

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

baseUrl

String

DEPRECATED - use fields icon, s, m, l, xl, xxl and xxxl instead

Base for builing urls for images in different sizes
icon - $baseUrl/$_23.JPG,
small - $baseUrl/$_18.JPG,
medium - $baseUrl/$_24.JPG,
large - $baseUrl/$_1.JPG,
XL - $baseUrl/$_27.JPG

ref

String

DEPRECATED

hash

String

MD5 checksum of the original uploaded customer image

icon

String

url to the 80x60 image

s

String

url to the 200x150 image

m

String

url to the 240x180 image (298 x 244 until Q2 2022)

l

String

url to the 360x270 image (400 x 300 until Q2 2022)

xl

String

url to the 640x480 image

xxl

String

url to the 1024x768 image

xxxl

String

url to the 1600x1200 image

Images

Field Name Type Description

images

Collection of Image

List of images

Dimension

Field Name Type Description

length

Int

Length. Notation in mm

width

Int

Width. Notation in mm

height

Int

Height. Notation in mm

Kba

Field Name Type Description

hsn

String

Germany only, Herstellerschlüsselnummer

tsn

String

Germany only, Typschlüsselnummer

Seller

Field Name Type Description

mobileSellerId

String

mobile-platform Seller ID

mobileSellerSince

String

e.g. 2015-06-12T11:58:32+02:00.

email

String

Contact email.

geoData

GeoData

Geolocation of the seller.

firstName

String

First name of a private seller.

lastName

String

Last name of a private seller.

companyName

String

Legal name for commercial sellers.

nameVisible

Boolean

When set to 'false' the customers name won’t be displayed in its ads.

phoneNumberVisible

Boolean

When set to 'false' the customers phone number won’t be shown in its ads.

phones

Collection of Phone

Contact phone numbers.

cell

Phone

Contact cell phone number.

fax

Phone

Contact fax number.

address

Address

Address.

type

String

Commercial or private seller.

commercial

Boolean

Commercial or non-profit seller.

homepage

String

Url to the seller home pgae.

dealerLogoBaseUrl

String

DEPRECATED - use dealerLogo instead

dealerLogo

Image

dealer logo

GeoData

Field Name Type Description

lon

Double

Longitude - decimal representation.

lat

Double

Latitude - decimal representation.

Phone

Field Name Type Description

internationalPrefix

Int

County code.

nationalPrefix

String

Area code.

number

String

Phone number.

Address

Field Name Type Description

street

String

Address.

additionalAddressInfo

String

Address.

zipcode

String

Address.

city

String

Address.

country

String

Address - notation http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2.

Event

Top level type for published messages

Field Name Type Description

type

EventType

Type of event indicates if ad was modified or deleted.

mobileAdId

String

Key which indentifies an ad on mobile site.

ad

Ad

The ad containing vehicle, price and contact data.

WltpValues

Emission, range and consumption values according to WLTP (Worldwide harmonized Light Duty Test Procedure).

Field Name Type Description

consumptionFuelCombined

Float

Combined fuel consumption for all nonelectric vehicles, optional for plugin hybrids, number in l/100km (natural gas (CNG) in kg/100km)

co2EmissionCombined

Float

Amount of carbon dioxide emissions in g/km for all vehicles, optional for plugin hybrids.

consumptionPowerCombined

Float

Combined power consumption for electric vehicles in in kWh/100km

electricRange

Int

Electric Range for plugin hybrids and electric vehicles in km

consumptionFuelCombinedWeighted

Float

Weighted combined fuel consumption for plugin hybrids

consumptionPowerCombinedWeighted

Float

Weighted combined power consumption for plugin hybrids in kWh/100km

co2EmissionCombinedWeighted

Float

Weighted amount of carbon dioxide emissions in g/km for plugin hybrids

Emissions

Field Name Type Description

combined

Emission

Combined (in case of plugin hybrid → combined/weighted) emission values

discharged

Emission

Emission values for plugin hybrid when battery is discharged

Emission

Field Name Type Description

co2

String

CO₂ emission value in g/100 km.

co2Class

String

CO₂ class. This property can have the following values → A, B, C, D, E, F, G

Consumptions

Field Name Type Description

weightedCombinedFuel

String

WLTP weighted/combined fuel consumption value. Only for plugin hybrid.

weightedCombinedPower

String

WLTP weighted/combined power consumption value. Only for plugin hybrid.

fuel

Consumption

WLTP fuel consumption values. In case of plugin hybrid → fuel consumption when battery is discharged.

power

Consumption

WLTP electrical power consumption values. For plugin hybrid → electrical power consumption in pure electric mode.

Consumption

Field Name Type Description

combined

String

energy consumption combined.

city

String

energy consumption inner city.

suburban

String

energy consumption in the outskirts of city.

rural

String

energy consumption on country roads.

highway

String

energy consumption on highways.

CostModel

Field Name Type Description

fuelPrice

String

Assumed price of fuel in EUR per liter or kg

powerPrice

String

Assumed price of electricity in EUR per kWh

consumptionCosts

String

Predicted energy (fuel and power) costs in EUR for an annual mileage of 15,000 km.

consumptionPriceYear

Int

Year of which the average fuel and power prices are based upon

tax

String

Annual vehicle tax in EUR

timeFrame

TimeFrame

The time frame for the predictions being made.

co2Costs

Co2Costs

Predicted CO₂ costs in EUR"

TimeFrame

Field Name Type Description

from

Int

The start year for the predictions being made

till

Int

The end year for the predictions being made

Co2Costs

Field Name Type Description

low

Co2Cost

model for low CO₂ prices

high

Co2Cost

model for high CO₂ prices

middle

Co2Cost

model for middle CO₂ prices

Co2Cost

Field Name Type Description

basePrice

String

The possible CO₂ cost in EUR/t

accumulated

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

errors

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

key

String

Indicates a type of problem - e.g. missing required field or invalid field value

message

String

Human readable error description

args

Collection of Arg

List of key-value pairs detailing the failure

Arg

Field Name Type Description

key

String

Key of detailed error

value

String

Description of detailed error

EventType

Possible Value Description

AD_CREATE_OR_UPDATE

An ad was created or modified.

AD_DELETE

An ad was deleted.

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.

Deprecated Data Format

For backward compatibility we still support a third deprecated xml format that conforms to the https://services.mobile.de/schema/search-1.0.xsd schema . New clients should adapt to the newer data formats, see Data Format section.

Sample event
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<search:event xmlns:seller="http://services.mobile.de/schema/seller"
              xmlns:search="http://services.mobile.de/schema/search"
              xmlns:ad="http://services.mobile.de/schema/ad"
              xmlns:resource="http://services.mobile.de/schema/resource"
              xmlns:financing="http://services.mobile.de/schema/common/financing-1.0"
              xmlns:error="http://services.mobile.de/schema/common/error-1.0">
    <search:event-type>AD_CREATE_OR_UPDATE</search:event-type>
    <search:ad-key>152229071</search:ad-key>
    <ad:ad key="152229071" url="https://services.mobile.de/search-api/ad/152229071">
        <ad:creation-date value="2017-10-18T09:26:40+02:00"/>
        <ad:modification-date value="2017-10-18T09:26:42+02:00"/>
        <ad:detail-page url="https://suchen.mobile.de/auto-inserat/mercedes-benz-vito-116cdi-l-klima-tempomat-sitzheizung-pts-kevelaer/152229071.html"/>
        <ad:seller-inventory-key value="NFZ708645HND02"/>
        <ad:vehicle>
            <ad:class key="Car" url="https://services.mobile.de/refdata/classes/Car"/>
            <ad:category key="Van" url="https://services.mobile.de/refdata/classes/Car/categories/Van"/>
            <ad:make key="MERCEDES-BENZ" url="https://services.mobile.de/refdata/classes/Car/makes/MERCEDES-BENZ"/>
            <ad:model key="Vito" url="https://services.mobile.de/refdata/classes/Car/makes/MERCEDES-BENZ/models/Vito"/>
            <ad:model-description value="Vito 116CDI L *Klima*Tempomat*Sitzheizung*PTS*"/>
            <ad:damage-and-unrepaired value="false"/>
            <ad:features>
                <ad:feature key="CENTRAL_LOCKING" url="https://services.mobile.de/refdata/classes/Car/features/CENTRAL_LOCKING"/>
                <ad:feature key="ELECTRIC_WINDOWS" url="https://services.mobile.de/refdata/classes/Car/features/ELECTRIC_WINDOWS"/>
                <ad:feature key="IMMOBILIZER" url="https://services.mobile.de/refdata/classes/Car/features/IMMOBILIZER"/>
                <ad:feature key="POWER_ASSISTED_STEERING" url="https://services.mobile.de/refdata/classes/Car/features/POWER_ASSISTED_STEERING"/>
                <ad:feature key="ABS" url="https://services.mobile.de/refdata/classes/Car/features/ABS"/>
                <ad:feature key="ESP" url="https://services.mobile.de/refdata/classes/Car/features/ESP"/>
                <ad:feature key="FULL_SERVICE_HISTORY" url="https://services.mobile.de/refdata/classes/Car/features/FULL_SERVICE_HISTORY"/>
                <ad:feature key="CRUISE_CONTROL" url="https://services.mobile.de/refdata/classes/Car/features/CRUISE_CONTROL"/>
                <ad:feature key="PARKING_SENSORS" url="https://services.mobile.de/refdata/classes/Car/features/PARKING_SENSORS"/>
                <ad:feature key="ELECTRIC_HEATED_SEATS" url="https://services.mobile.de/refdata/classes/Car/features/ELECTRIC_HEATED_SEATS"/>
                <ad:feature key="PARTICULATE_FILTER_DIESEL" url="https://services.mobile.de/refdata/classes/Car/features/PARTICULATE_FILTER_DIESEL"/>
                <ad:feature key="HU_AU_NEU" url="https://services.mobile.de/refdata/classes/Car/features/HU_AU_NEU"/>
                <ad:feature key="WARRANTY" url="https://services.mobile.de/refdata/classes/Car/features/WARRANTY"/>
                <ad:feature key="AUTOMATIC_RAIN_SENSOR" url="https://services.mobile.de/refdata/classes/Car/features/AUTOMATIC_RAIN_SENSOR"/>
                <ad:feature key="BLUETOOTH" url="https://services.mobile.de/refdata/classes/Car/features/BLUETOOTH"/>
                <ad:feature key="ON_BOARD_COMPUTER" url="https://services.mobile.de/refdata/classes/Car/features/ON_BOARD_COMPUTER"/>
                <ad:feature key="HANDS_FREE_PHONE_SYSTEM" url="https://services.mobile.de/refdata/classes/Car/features/HANDS_FREE_PHONE_SYSTEM"/>
                <ad:feature key="MULTIFUNCTIONAL_WHEEL" url="https://services.mobile.de/refdata/classes/Car/features/MULTIFUNCTIONAL_WHEEL"/>
                <ad:feature key="TUNER" url="https://services.mobile.de/refdata/classes/Car/features/TUNER"/>
                <ad:feature key="TRACTION_CONTROL_SYSTEM" url="https://services.mobile.de/refdata/classes/Car/features/TRACTION_CONTROL_SYSTEM"/>
                <ad:feature key="ROOF_RAILS" url="https://services.mobile.de/refdata/classes/Car/features/ROOF_RAILS"/>
            </ad:features>
            <ad:specifics>
                <ad:exterior-color key="WHITE" url="https://services.mobile.de/refdata/colors/WHITE">
                    <ad:manufacturer-color-name value="arktikweiß"/>
                </ad:exterior-color>
                <ad:mileage value="41562"/>
                <ad:door-count key="FOUR_OR_FIVE" url="https://services.mobile.de/refdata/doorcounts/FOUR_OR_FIVE"/>
                <ad:first-registration value="2016-03"/>
                <ad:emission-class key="EURO5" url="https://services.mobile.de/refdata/emissionclasses/EURO5"/>
                <ad:emission-fuel-consumption envkv-compliant="false" co2-emission="163.0" inner="7.8" outer="5.2" combined="6.2" unit="LITER_PER_100_KM"/>
                <ad:emission-sticker key="EMISSIONSSTICKER_GREEN" url="https://services.mobile.de/refdata/emissionstickers/EMISSIONSSTICKER_GREEN"/>
                <ad:fuel key="DIESEL" url="https://services.mobile.de/refdata/fuels/DIESEL"/>
                <ad:power value="120"/>
                <ad:kba hsn="1313" tsn="BQK"/>
                <ad:gearbox key="MANUAL_GEAR" url="https://services.mobile.de/refdata/gearboxes/MANUAL_GEAR"/>
                <ad:climatisation key="MANUAL_CLIMATISATION" url="https://services.mobile.de/refdata/climatisations/MANUAL_CLIMATISATION"/>
                <ad:num-seats value="3"/>
                <ad:construction-date value="2016-02-11+01:00"/>
                <ad:cubic-capacity value="2143"/>
                <ad:condition key="USED" url="https://services.mobile.de/refdata/conditions/USED"/>
                <ad:interior-type key="FABRIC" url="https://services.mobile.de/refdata/interiorTypes/FABRIC"/>
                <ad:airbag key="FRONT_AIRBAGS" url="https://services.mobile.de/refdata/airbags/FRONT_AIRBAGS"/>
                <ad:countryVersion key="DE" url="https://services.mobile.de/refdata/countryVersion/DE"/>
                <ad:parking-assistants>
                    <ad:parking-assistant key="FRONT_SENSORS" url="https://services.mobile.de/refdata/parkingassistants/FRONT_SENSORS"/>
                    <ad:parking-assistant key="REAR_SENSORS" url="https://services.mobile.de/refdata/parkingassistants/REAR_SENSORS"/>
                </ad:parking-assistants>
            </ad:specifics>
        </ad:vehicle>
        <ad:description>- Klimaanlage TEMPMATIC, TEMPOMAT, Aktiver Park-Assistent, Radio Audio 10 ( Bluetooth, USB, AUX &amp; SD-Karte ), Multifunktionslenkrad mit Reiserechner, Lederlenkrad und Lederschalthebel, Komfort-Fahrersitz, Sitzheizung für Fahrer, Airbag Fahrer, Beifahrersitz Zweisitzer, Airbag Beifahrer, Stoff Tunja schwarz, 6-Gang-Schaltgetriebe TSG 380, Komfort-Öffnung u.Schließung mit IR-Fernbedienung, Fahrlichtassistent, Aufmerksamkeits-Assistent ATTENTION ASSIST, Berganfahrhilfe, Regensensor, Reifenluftdrucküberwachung an VA u. HA, drahtlos, Dachreling, Trennwand durchgehend mit 1 Fenster, Holzfußboden, Lastenverankerungsschienensystem, Innenverkleidung Laderaum bis Dachhöhe, LED-Lichtband im Laderaum, Hecktüren, zweiflügelig, Öffnung bis Seitenwand, Adaptives Bremslicht, Elektrik für Anhängersteckdose, Fahrzeug schadstoffarm Euro 5b+ Gr. III, Zulassung als LKW, Motor OM 651 DE 22 LA 120 kW (163 PS) 3800/min, Paket EASY CARGO, Inland - Code - - - Zubehörangaben ohne Gewähr, Änderungen, Zwischenverkauf und Irrtümer vorbehalten.</ad:description>
        <ad:enrichedDescription>* Klimaanlage TEMPMATIC\\* TEMPOMAT\\* Aktiver Park-Assistent\\* Radio Audio 10 ( Bluetooth, USB, AUX &amp; SD-Karte )\\* Multifunktionslenkrad mit Reiserechner\\* Lederlenkrad und Lederschalthebel\\* Komfort-Fahrersitz\\* Sitzheizung für Fahrer\\* Airbag Fahrer\\* Beifahrersitz Zweisitzer\\* Airbag Beifahrer\\* Stoff Tunja schwarz\\* 6-Gang-Schaltgetriebe TSG 380\\* Komfort-Öffnung u.Schließung mit IR-Fernbedienung\\* Fahrlichtassistent\\* Aufmerksamkeits-Assistent ATTENTION ASSIST\\* Berganfahrhilfe\\* Regensensor\\* Reifenluftdrucküberwachung an VA u. HA, drahtlos\\* Dachreling\\* Trennwand durchgehend mit 1 Fenster\\* Holzfußboden\\* Lastenverankerungsschienensystem\\* Innenverkleidung Laderaum bis Dachhöhe\\* LED-Lichtband im Laderaum\\* Hecktüren, zweiflügelig, Öffnung bis Seitenwand\\* Adaptives Bremslicht\\* Elektrik für Anhängersteckdose\\* Fahrzeug schadstoffarm Euro 5b+ Gr. III\\* Zulassung als LKW\\* Motor OM 651 DE 22 LA 120 kW (163 PS) 3800/min\\* Paket EASY CARGO\\* Inland - Code\\\\ \\ Zubehörangaben ohne Gewähr, Änderungen, Zwischenverkauf und Irrtümer vorbehalten.</ad:enrichedDescription>
        <ad:images count="3" gallery-url="https://img.classistatic.de/api/v1/mo-prod/images/46/467621f9-dcca-4c7f-ba2b-5f50942b713b?rule=mo-80.jpg" url="https://services.mobile.de/search-api/ad/152229071/images">
            <ad:image>
                <ad:representation size="S" url="https://img.classistatic.de/api/v1/mo-prod/images/46/467621f9-dcca-4c7f-ba2b-5f50942b713b?rule=mo-200.jpg"/>
                <ad:representation size="XL" url="https://img.classistatic.de/api/v1/mo-prod/images/46/467621f9-dcca-4c7f-ba2b-5f50942b713b?rule=mo-640.jpg"/>
                <ad:representation size="ICON" url="https://img.classistatic.de/api/v1/mo-prod/images/46/467621f9-dcca-4c7f-ba2b-5f50942b713b?rule=mo-80.jpg"/>
                <ad:representation size="L" url="https://img.classistatic.de/api/v1/mo-prod/images/46/467621f9-dcca-4c7f-ba2b-5f50942b713b?rule=mo-640.jpg"/>
                <ad:representation size="M" url="https://img.classistatic.de/api/v1/mo-prod/images/46/467621f9-dcca-4c7f-ba2b-5f50942b713b?rule=mo-640.jpg"/>
            </ad:image>
            <ad:image>
                <ad:representation size="S" url="https://img.classistatic.de/api/v1/mo-prod/images/46/467621f9-dcca-4c7f-ba2b-5f50942b713b?rule=mo-200.jpg"/>
                <ad:representation size="XL" url="https://img.classistatic.de/api/v1/mo-prod/images/46/467621f9-dcca-4c7f-ba2b-5f50942b713b?rule=mo-640.jpg"/>
                <ad:representation size="ICON" url="https://img.classistatic.de/api/v1/mo-prod/images/46/467621f9-dcca-4c7f-ba2b-5f50942b713b?rule=mo-80.jpg"/>
                <ad:representation size="L" url="https://img.classistatic.de/api/v1/mo-prod/images/46/467621f9-dcca-4c7f-ba2b-5f50942b713b?rule=mo-640.jpg"/>
                <ad:representation size="M" url="https://img.classistatic.de/api/v1/mo-prod/images/46/467621f9-dcca-4c7f-ba2b-5f50942b713b?rule=mo-640.jpg"/>
            </ad:image>
            <ad:image>
                <ad:representation size="S" url="https://img.classistatic.de/api/v1/mo-prod/images/46/467621f9-dcca-4c7f-ba2b-5f50942b713b?rule=mo-200.jpg"/>
                <ad:representation size="XL" url="https://img.classistatic.de/api/v1/mo-prod/images/46/467621f9-dcca-4c7f-ba2b-5f50942b713b?rule=mo-640.jpg"/>
                <ad:representation size="ICON" url="https://img.classistatic.de/api/v1/mo-prod/images/46/467621f9-dcca-4c7f-ba2b-5f50942b713b?rule=mo-80.jpg"/>
                <ad:representation size="L" url="https://img.classistatic.de/api/v1/mo-prod/images/46/467621f9-dcca-4c7f-ba2b-5f50942b713b?rule=mo-640.jpg"/>
                <ad:representation size="M" url="https://img.classistatic.de/api/v1/mo-prod/images/46/467621f9-dcca-4c7f-ba2b-5f50942b713b?rule=mo-640.jpg"/>
            </ad:image>
        </ad:images>
        <ad:price currency="EUR" type="FIXED">
            <ad:consumer-price-amount value="23193.10"/>
            <ad:vatable value="true"/>
            <ad:vat-rate value="0.19"/>
        </ad:price>
        <seller:seller key="1177" url="https://services.mobile.de/search-api/seller/1177">
            <seller:type value="DEALER" commercial="true"/>
            <seller:company-name value="Herbrand GmbH"/>
            <seller:address>
                <seller:street value="Wettener Straße 18"/>
                <seller:zipcode value="20359"/>
                <seller:city value="Hamburg"/>
                <seller:country-code value="DE"/>
            </seller:address>
            <seller:phone type="FIXED" country-calling-code="49" area-code="01234" number="2222333"/>
            <seller:phone type="FAX" country-calling-code="49" area-code="01234" number="3333222"/>
            <seller:coordinates>
                <seller:latitude>52.401543</seller:latitude>
                <seller:longitude>13.178085</seller:longitude>
            </seller:coordinates>
            <seller:contact-languages>
                <seller:language>de</seller:language>
            </seller:contact-languages>
        </seller:seller>
    </ad:ad>
</search:event>

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.

Reference Data Types

Site Id

List of supported Site Ids

Type Endpoint

site

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)

class

/refdata/classes
/refdata/sites/:siteId/classes Example

category

/refdata/classes/:class/categories Example
/refdata/sites/:siteId/classes/:class/categories Example

make

/refdata/classes/:class/makes Example
/refdata/sites/:siteId/classes/:class/makes Example

model

/refdata/classes/:class/makes/:make/models Example
/refdata/:siteId/classes/:class/makes/:make/models Example

model group

/refdata/classes/:class/makes/:make/modelgroups Example
/refdata/sites/:siteId/classes/:class/makes/:make/modelgroups Example

model of a model group

/refdata/classes/:class/makes/:make/modelgroups/:modelgroup/models Example
/refdata/sites/:siteId/classes/:class/makes/:make/modelgroups/:modelgroup/models
Example

usedcarseal

/refdata/sites/:siteId/classes/:class/usedcarseals Example

vatrate

/refdata/sites/:siteId/vatrates Example

modelrange

/refdata/sites/:siteId/classes/:class/makes/:make/models/:model/modelranges?firstregistration=YYYYMM Example
query parameters
- firstregistration= YYYYMM (required)
- category= one of categories
- fuel= one of fuel
- doorcount= one of door counts
- trimline= one of trimlines

trimline

/refdata/sites/:siteId/classes/:class/makes/:make/models/:model/trimlines?firstregistration=YYYYMM Example
query parameters
- firstregistration= YYYYMM (required)
- category= one of categories
- fuel= one of fuel
- doorcount= one of door counts
- modelrange= one of modelranges

Site Independent Reference Data

Table Endpoint

airbag

batteryManufacturer

battery

batteryPosition

bendingLightsType

bikeGearType

bikeSuitableFor

breakdownService

climatisation

color

condition

countryVersion

daytimeRunningLamps

doorCount

drivingCab

drivingModes

emissionClass

emissionSticker

frameMaterial

frameShape

fuelConsumptionUnit

fuel

gearbox

headlightType

hydraulicInstallation

interiorColor

interiorType

motorPosition

nominalInterestRateType

parkingAssistant

paybackPeriod

petrolType

plugType

priceRating

priceType

radio

slidingDoorType

speedControl

trailerCouplingType

usageType

wheelFormula

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.

Json example
{
    "creationDate": "2015-12-01T18:40:44+01:00"
}
Xml example
    <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.

Example
{
    "firstRegistration": "200909",
    "generalInspection": "201611"
}

Year

The fields that require information only about the year are represented as a number using yyyy format.

Example
{
    "constructionYear": 2010
}

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

Italy

Phone: +39 02 30410311 or Contact Form

France

Phone: +33 (0) 810 000 220 or Contact Form