Developer Portal

Step 1 — Get your API key

Create a free account at chathome.lu/developers to get your API key. Keys are shown once at creation — store them securely.

# Your API key looks like this:\nch_a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6

Step 2 — Authenticate

Pass your API key in every request using the X-API-Key header.

curl -X GET 'https://chathome.lu/api/public/v1/communes' \
  -H 'X-API-Key: ch_your_api_key_here' \
  -H 'Accept: application/json'

Step 3 — Make your first request

Try the communes endpoint to get all Luxembourg communes with their liveability scores.

curl -X GET \
  '/api/public/v1/communes?locale=en' \
  -H 'Accept: application/json'

Preferred natural-language search for lifestyle, proximity, mood, and other soft preferences.

{
  "query": "quiet two-bedroom near Kirchberg with a balcony",
  "intent": "rent"
}

Search rental properties by commune, price range, bedrooms, and more.

{
  "commune": "luxembourg",
  "maxPrice": 2500,
  "beds": 2
}

Search properties for sale across Luxembourg and its cross-border commuter belt.

{
  "commune": "esch-sur-alzette",
  "propertyType": "apartment"
}

Render exact results from a prior search as a cross-platform MCP Apps property carousel.

{
  "listings": [
    {
      "id": "abc123",
      "score": 91,
      "matchReasons": [
        "Near Kirchberg"
      ]
    }
  ],
  "heading": "Quiet homes near Kirchberg",
  "locale": "en"
}

Retrieve the full fail-closed listing-page record plus normalized costs, property checks, station frequency, and commute context.

{
  "id": "abc123",
  "locale": "en"
}

Compare two to eight homes through one normalized response with costs, property checks, mobility, value context, and evidence.

{
  "ids": [
    "abc123",
    "def456"
  ],
  "locale": "en"
}

Inspect the full listing-page record, normalized decision facts, sources, freshness, unknowns, and privacy-safe correction summaries.

{
  "id": "abc123",
  "locale": "en"
}

Get real estate market data and liveability scores for a Luxembourg commune.

{
  "commune": "kirchberg",
  "locale": "en"
}

Get every agency with active listings in a supported Luxembourg town, including current buy/rent stock and asking-price ranges.

{
  "commune": "mersch",
  "locale": "en"
}

Resolve supported place names, aliases and IDs, without guessing ambiguous names.

{
  "query": "Kirchberg",
  "country": "LU",
  "locale": "en"
}

Numeric estimate with ranges, scope and limitations; no AI-written report or account.

{
  "commune": "mersch",
  "propertyType": "apartment",
  "listingType": "sale",
  "areaSqm": 85,
  "hasGarage": false
}

AI-powered price estimate for a property using the chathome valuation model.

{
  "propertyType": "apartment",
  "listingType": "sale",
  "commune": "luxembourg",
  "areaSqm": 85,
  "bedrooms": 2,
  "constructionYear": 2010,
  "energyClass": "B"
}

Calculate Luxembourg purchasing power with a complete or known-cost-only acquisition-cost basis. Bëllegen credit requires explicit residence use, eligible acquirer count, and confirmed unused balance; isFirstTimeBuyer is deprecated compatibility only.

{
  "annualNetIncome": 84000,
  "maxDebtToIncomeRatio": 0.35,
  "monthlyDebts": 500,
  "savingsAvailable": 100000,
  "householdType": "couple",
  "employmentType": "salaried",
  "residencyType": "luxembourg",
  "residenceUse": "primary",
  "bellegenAktEligibleBuyers": 2,
  "bellegenAktCreditAvailable": 80000,
  "isFirstTimeBuyer": false
}

Anonymous loan payment and repayment calculation from explicit assumptions. No user profile or loan application is saved.

{
  "principal": 400000,
  "annualRatePct": 3,
  "years": 25,
  "extraMonthlyPayment": 0
}

Anonymous buy-versus-rent scenario from explicit price, rent and rate; the winner stays null until acquisition costs are complete.

{
  "price": 650000,
  "monthlyRent": 2400,
  "mortgageRatePct": 3.2
}

Anonymous Luxembourg purchase duties and notary costs; Bëllegen Akt only when confirmed.

{
  "price": 750000,
  "residenceUse": "primary",
  "eligibleAcquirerCount": 1
}

Anonymous indicative rent subsidy with dated thresholds; never an entitlement.

{
  "householdSize": 2,
  "monthlyNetIncome": 3500,
  "monthlyRent": 1600
}

Anonymous legal rent ceiling (5% rule) for a rent or the owner's purchase figures.

{
  "monthlyRent": 1800,
  "price": 600000,
  "purchaseYear": 2015,
  "buildingYear": 1995
}

Anonymous Luxembourg plot check from a cadastral reference or precise point; information, not legal advice.

{
  "lat": 49.6116,
  "lng": 6.1319
}

Anonymous source-dated full-term fixed market observations; unavailable data never becomes a current personal bank quote.

{}

Commute time estimates from a commune to Luxembourg City, Kirchberg, or Belval.

{
  "commune": "differdange",
  "destination": "belval",
  "mode": "transit"
}

Send an inquiry about a listing. Creates a conversation thread for chathome-hosted listings, or returns external agency contact details.

{
  "listingId": "abc123",
  "message": "My client is interested in this apartment. Is it still available?",
  "agentName": "Acme Property AI",
  "contactEmail": "ai@acme.example"
}

Poll an MCP agent inquiry conversation for replies. Only accessible for conversations created via the MCP agent channel.

{
  "conversationId": "conv_xyz789"
}