Search API description

The Search-API is also known as Ad-Integration (german: Inserats-Einbindung).

Introduction

We offer a search API for...

• ...downloading single ads by ad-key (ad ID).
• ...finding ads by various criteria (make-model, category, modification-time, ...).

Please note that a search result has a lower data coverage than a direct ad download by an ad-key.
Thus some ad properties obtainable via a direct download (using ad-key) are not gettable in a search result containing that ad.

REST

Language support

Numerous ad properties provide a translated description.
Default language is English, yet sending an HTTP header field Accept-Language enriched by the appropriate value enables the requester to get a translated description in all supported languages at mobile.de.

Authentication

You must authenticate yourself with a username and password using the HTTP basic authentication scheme.
For detailed information on HTTP basic authentication see http://en.wikipedia.org/wiki/Basic_access_authentication or http://tools.ietf.org/html/rfc1945#section-10.2.

HTTP header fields

Reference data

Some search parameters and parts of the returned XML refer to our reference data. Here you find reference tables for the enumerated fields, like features, colors, makes, models and others.

XML schema files

• Please check the XML schema definition of our data format to understand the response returned by this API.
• Also see our general XML notes.

Downloading single ads by an ad-key

Fetch details of an ad

Request

Example request-line and headers

GET /search-api/ad/456 HTTP/1.0
Host: services.mobile.de
Authorization: QWxhZGluOnNlc2FtIG9wZW4=
Accept: application/xml

Response

Finding ads

Search for ads by various criteria

Request

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
Authorization: QWxhZGluOnNlc2FtIG9wZW4=
Accept: application/xml

Response

Number of search results and paginating

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

Error response

<?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>

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

• There is the possibility to send multiple comma separated values for all search parameters with type Set
• It is not possible to use only numeric and boolean search parameters, there must be minimum one parameter in the request with a type different then numeric or boolean

Impressum / Imprint