Documentation API Kaabo

L'API Kaabo est une API REST: elle utilise des URL prévisibles, l'authentification par clé (Bearer), renvoie du JSONet s'appuie sur les codes de statut HTTP standards. Toutes les requêtes se font en HTTPS.

Les données exposées sont publiques(annonces disponibles). Aucune donnée personnelle d'utilisateur n'est accessible via l'API.

Chaque requête doit inclure votre clé API dans l'en-tête Authorization au format Bearer :

Authorization: Bearer kaabo_live_xxxxxxxxxxxxxxxxxxxx

Générez et gérez vos clés depuis votre espace API & Développeurs. Une clé n'est affichée qu'une seule fois à sa création : conservez-la en lieu sûr. En cas de fuite, révoquez-la et générez-en une nouvelle.

Toutes les requêtes partent de l'URL de base suivante :

https://kaza-topaz.vercel.app/api/v1

La version de l'API est indiquée dans le chemin (/v1). Les évolutions rétro-incompatibles donneront lieu à une nouvelle version (v2, …) ; la v1 restera maintenue.

Chaque clé dispose d'un quota de requêtes par jour :

En cas de dépassement, l'API renvoie un statut 429 (Too Many Requests).

Les listes sont paginées via les paramètres de requête limit (1–100, défaut 20) et offset (défaut 0). Chaque réponse indique count, limit et offset.

L'API utilise les codes de statut HTTP standards. Le corps d'une erreur contient un objet error et un message lisible.

{
  "error": "unauthorized",
  "message": "Clé API invalide ou révoquée."
}

cURL

curl "https://kaza-topaz.vercel.app/api/v1/properties?limit=20" \
  -H "Authorization: Bearer kaabo_live_xxxxxxxx"

JavaScript (Node.js / fetch)

const res = await fetch(
  "https://kaza-topaz.vercel.app/api/v1/properties?limit=20",
  { headers: { Authorization: "Bearer " + process.env.KAABO_API_KEY } }
);
const { data } = await res.json();
console.log(data);

Python (requests)

import os, requests

r = requests.get(
    "https://kaza-topaz.vercel.app/api/v1/properties",
    params={"limit": 20},
    headers={"Authorization": f"Bearer {os.environ['KAABO_API_KEY']}"},
)
print(r.json()["data"])

Recevez une notification en temps réel lorsqu'un événement se produit, plutôt que d'interroger l'API en continu. Configurez une URL de réception (HTTPS) depuis votre espace API & Développeurs.

Événements disponibles

• property.created — une nouvelle annonce est publiée
• property.updated — une annonce est mise à jour
• property.rented — une annonce passe en louée

Format reçu (POST)

{
  "event": "property.created",
  "createdAt": "2026-07-20T10:00:00Z",
  "data": {
    "id": "ce71652d-...",
    "title": "Appartement 2 chambres à Lomé",
    "price": 140000,
    "listingType": "RENT",
    "propertyType": "APARTMENT",
    "address": "Quartier Tokoin, Lomé, Togo"
  }
}

Chaque requête inclut l'en-tête X-Kaabo-Signature (sha256=…) : un HMAC-SHA256 du corps brut, calculé avec le secret de votre endpoint. Vérifiez-le pour garantir l'authenticité :

import crypto from "node:crypto";

function verify(rawBody, signature, secret) {
  const expected =
    "sha256=" +
    crypto.createHmac("sha256", secret).update(rawBody).digest("hex");
  return crypto.timingSafeEqual(
    Buffer.from(signature),
    Buffer.from(expected),
  );
}

L'accès à l'API est gratuit. Il vous suffit d'un compte développeur(inscription gratuite) ou d'un compte agence pour générer vos clés et vos webhooks depuis votre espace développeur.