API REFERENCE v1.0

Documentation API

Integrez l'intelligence immobiliere ORAKLE dans vos applications. API REST, reponses JSON, authentification par cle API.

Authentification

Toutes les requetes API necessitent un header Authorization.

Authorization: Bearer YOUR_API_KEY

Base URL : https://api.orakle.be/v1 — Rate limit : 100 req/min (Pro), 1000 req/min (Enterprise)

Parametres

qstringrequisTerme de recherche (adresse, commune, code postal)
property_typestringopt.Type de bien : house, apartment, villa, etc.
min_pricenumberopt.Prix minimum en euros
max_pricenumberopt.Prix maximum en euros
limitnumberopt.Nombre de resultats (defaut: 20, max: 100)
offsetnumberopt.Offset pour la pagination
Reponse :SearchResponse

Exemple de reponse

{
  "results": [
    {
      "id": "be-1000-rue-haute-42",
      "address_display": "Rue Haute 42, 1000 Bruxelles",
      "commune": "Bruxelles",
      "postal_code": "1000",
      "property_type": "apartment",
      "price_p50": 285000,
      "price_m2": 3250,
      "confidence": "high",
      "lat": 50.8389,
      "lon": 4.3487,
      "truth_meter": 82
    }
  ],
  "total": 156,
  "query": "Rue Haute Bruxelles"
}

Corps de la requete (JSON)

querystringRequete en langage naturel, ex: 'appartement 2 chambres a Ixelles moins de 300k'
limitnumberNombre max de resultats (defaut: 20)
Reponse :NLPQueryResponse

Exemple de reponse

{
  "query": "appartement 2 chambres a Ixelles moins de 300k",
  "parsed_filters": {
    "commune": "Ixelles",
    "property_type": "apartment",
    "max_price": 300000,
    "min_bedrooms": 2
  },
  "results": [...],
  "total": 23,
  "interpretation": "Appartements avec minimum 2 chambres a Ixelles, prix max 300 000 EUR"
}

Limites de requetes

Decouverte5 req/jour
Pro100 req/min
Enterprise1 000 req/min

Codes d'erreur

400Bad Request
401Unauthorized
404Not Found
429Too Many Requests
500Internal Error

Pret a integrer ORAKLE ?

Obtenez votre cle API et commencez a interroger le marche immobilier belge en quelques minutes.