Skip to main content

Orte suchen

Mit diesem Endpunkt können Sie nach Orten suchen und Location-IDs mit geografischen Informationen abrufen, die für die Umkreissuche verwendet werden können.

Endpunkt

GET https://api.kleinanzeigen-agent.de/ads/v1/kleinanzeigen/locations

Parameter

ParameterTypBeschreibungStandard
querystringSuchbegriff für Stadt, PLZ oder Bundesland-
limitnumberMaximale Anzahl der Ergebnisse20

Beispielanfrage

const apiKey = "IHR_API_SCHLÜSSEL";
const url = new URL(
  "https://api.kleinanzeigen-agent.de/ads/v1/kleinanzeigen/locations"
);

url.searchParams.append("query", "Berlin");
url.searchParams.append("limit", 10);

const response = await fetch(url, {
  headers: {
    ads_key: apiKey,
    "Content-Type": "application/json",
  },
});

const data = await response.json();
console.log(data);

Beispielantwort

{
  "message": "Data fetched successfully",
  "success": true,
  "data": {
    "meta": {
      "query": "Berlin",
      "limit": 10,
      "total": 10
    },
    "locations": [
      {
        "id": 1517,
        "city": "Mitte",
        "state": "Berlin",
        "zip": "10115",
        "latitude": "52.532614",
        "longitude": "13.3777035"
      },
      {
        "id": 2031,
        "city": "Mitte",
        "state": "Berlin",
        "zip": "10117",
        "latitude": "52.5155098",
        "longitude": "13.3847539"
      }
    ]
  },
  "request_id": "7f2a9e8d-4b3c-5d6e-8f9a-0b1c2d3e4f5g"
}

Antwortfelder

Die API liefert die folgenden Felder zurück:

Hauptobjekt

FeldTypBeschreibung
messagestringStatusmeldung der Anfrage
successbooleanErfolgsindikator (true/false)
dataobjectEnthält die Suchergebnisse
request_idstringEindeutige ID dieser Anfrage

Data-Objekt

FeldTypBeschreibung
metaobjectMetainformationen zur Suchanfrage
locationsarrayArray mit den gefundenen Orten

Location-Objekt

FeldTypBeschreibung
idnumberEindeutige ID des Ortes
citystringName der Stadt
statestringBundesland
zipstringPostleitzahl
latitudenumberBreitengrad
longitudenumberLängengrad

Verwendung für Umkreissuche

Die erhaltenen Location-IDs können Sie anschließend für die Umkreissuche im Search-Endpunkt verwenden:
// 1. Ort suchen
const locationResponse = await fetch(
  "https://api.kleinanzeigen-agent.de/ads/v1/kleinanzeigen/locations?query=München",
  { headers: { ads_key: apiKey } }
);
const locations = await locationResponse.json();

// 2. Location-ID extrahieren
const locationId = locations.data.locations[0].id;

// 3. Umkreissuche durchführen
const searchUrl = new URL(
  "https://api.kleinanzeigen-agent.de/ads/v1/kleinanzeigen/search"
);
searchUrl.searchParams.append("location_id", locationId);
searchUrl.searchParams.append("radius", 25); // 25km Umkreis
searchUrl.searchParams.append("query", "fahrrad");

const searchResponse = await fetch(searchUrl, {
  headers: { ads_key: apiKey },
});