Tchabita Tchabita
Créer un compte
API publique · v1.0.0

Documentation API Tchabita

Poussez vos annonces depuis votre CRM (Apimo, Hektor, Périclès, custom) vers Tchabita en quelques minutes.

🚀 Démarrer 🔑 Mes clés API 💼 Partenariat éditeur CRM
Base URL
https://api.tchabita.com/v1
Sandbox : https://api.tchabita.com/v1/sandbox · TLS 1.3 obligatoire · CORS désactivé (server-to-server)

🚀 Démarrer en 5 minutes

  1. 1

    Créez votre compte Pro sur Tchabita

    Inscription → vérification SIRET/Kbis sous 48h

  2. 2

    Allez sur /pro/api-keys

    Générez une clé API LIVE (1 clic, à copier une seule fois)

  3. 3

    Faites votre premier POST

    Voir l'exemple cURL ci-dessous

  4. 4

    L'annonce est en attente de modération

    Vérif auto + manuelle si nécessaire. Publication sous 2h en moyenne

  5. 5

    Vous pouvez sync 1000 à 10 000 annonces/jour

    Selon votre plan Pro Solo / Agence / Réseau

🔐 Authentification

Toutes les requêtes nécessitent un Bearer token dans l'en-tête HTTP :

Authorization: Bearer tchabita_pk_LIVE_xxxxxxxxxxxxxxxxxxxxxxxxxx
  • ✓Préfixe tchabita_pk_LIVE_ en prod, tchabita_pk_TEST_ en sandbox
  • ✓Hashée bcrypt cost 12 en BDD · révocable instantanément
  • ✓Affichée une seule fois à la génération
  • ⚠Ne jamais commit dans Git · stocker dans un secret manager / variable d'env

📝 Créer ou mettre à jour une annonce

Endpoint idempotent : si l'externalId existe déjà, l'annonce est mise à jour. Sinon, créée.

POST /v1/listings
Exemple cURL
curl -X POST https://api.tchabita.com/v1/listings \
  -H "Authorization: Bearer tchabita_pk_LIVE_xxx" \
  -H "Content-Type: application/json" \
  -d '{
    "externalId": "AM-IMMO-2026-456",
    "type": "vente",
    "category": "maison",
    "title": "Maison de ville rénovée 5p",
    "description": "Magnifique maison rénovée 2024 dans le quartier Saint-Martin...",
    "price": 395000,
    "priceUnit": "EUR",
    "city": "Pontoise",
    "postcode": "95300",
    "surface": 112,
    "rooms": 5,
    "bedrooms": 3,
    "dpe": "C",
    "ges": "C",
    "photos": [
      { "url": "https://am-immo.fr/photos/456-1.jpg", "label": "Façade", "order": 0 },
      { "url": "https://am-immo.fr/photos/456-2.jpg", "label": "Salon", "order": 1 }
    ],
    "fees": { "agencyFees": 12000, "feesPaidBy": "buyer", "feeIncluded": true }
  }'
Réponse 201 Created
{
  "ok": true,
  "tchabitaId": "annonce_abc123",
  "externalId": "AM-IMMO-2026-456",
  "status": "pending_moderation",
  "publicUrl": "https://tchabita.com/annonces/annonce_abc123",
  "version": 1,
  "createdAt": "2026-05-20T08:50:00Z"
}

📋 Autres endpoints

GET /v1/listings Lister mes annonces (filtres : status, page, modifiedSince)
GET /v1/listings/{tchabitaId} Récupérer une annonce par ID Tchabita
GET /v1/listings/by-external/{externalId} Récupérer par ID interne agence
PUT /v1/listings/{tchabitaId} Mise à jour complète (partial body OK)
PATCH /v1/listings/{tchabitaId}/status Changer le statut (active/paused/sold/rented/withdrawn)
DELETE /v1/listings/{tchabitaId} Soft-delete (retire de Tchabita)
POST /v1/listings/batch Sync en masse (max 100/req)
GET /v1/me Info sur ma clé API + rate limit restant

⚠️ Codes erreur

HTTP Code Description
400 validation_error Body invalide (détails dans errors[])
401 unauthorized Pas de token / token invalide
403 forbidden Pas les droits (scope manquant)
404 not_found Annonce introuvable
409 conflict externalId déjà utilisé
422 business_error Données métier invalides (DPE incohérent, etc.)
429 rate_limit_exceeded Quota dépassé (Retry-After dans header)
500 server_error Erreur interne (loggée + investiguée)

🎬 Vidéo tutoriel

Suivez le pas-à-pas pour intégrer votre CRM en 5 minutes — création de la clé, premier push, vérification.

🎬

Vidéo bientôt disponible

Tutoriel complet "Intégrer votre CRM à Tchabita en 5 min" — bientôt sur YouTube + intégré ici.

📧 M'avertir à la sortie
Durée estimée : 5 min · Niveau : débutant 🎥 Chaîne YouTube Tchabita

⏱ Quotas par plan

🎁

100 % gratuit pendant 1 an pour les Pros Pionniers

Tous les plans Pro débloqués offerts pendant 12 mois pour les agences qui rejoignent la bêta. Les tarifs ci-dessous sont indicatifs et s'appliqueront à partir de mai 2027.

Pro Solo

Gratuit à vie
  • 1 000 requêtes/jour
  • Batch max 10 annonces/req
  • Webhooks : Non

Pro Agence

🎁 Gratuit 1 an
29 €/mois après
  • 10 000 requêtes/jour
  • Batch max 50 annonces/req
  • Webhooks : Oui (1)

Pro Réseau

🎁 Gratuit 1 an
Sur devis après
  • Illimité requêtes/jour
  • Batch max 100 annonces/req
  • Webhooks : Oui (3)

Header de réponse : X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset. Erreur 429 si dépassé.

📚 SDK & exemples

JavaScript / Node

Officiellement supporté · npm install @tchabita/api

PHP

Bientôt

Pour intégrer dans WordPress / Symfony / CRM PHP

Python

Bientôt

Pour les CRM Python ou scripts ad-hoc

Postman

Collection Postman officielle (download)

OpenAPI 3.1

Spec OpenAPI (auto-generate SDKs)

cURL

Exemples sur tous les endpoints (cf. doc complète)

Vous éditez un CRM immo ?

On propose un partenariat passerelle officielle : intégration native, co-marketing, support dédié.

📧 Discutons