Documentation de l'API

L'API fournit deux indices officiels suisses utilisés dans les contrats de bail : l'IPC (indice suisse des prix à la consommation, publié mensuellement par l'OFS) et le TRH (taux hypothécaire de référence, publié trimestriellement par l'OFL).

Authentification

Chaque requête vers /api/indices doit porter votre clé dans l'en-tête X-API-Key. Pour obtenir une clé, contactez notre équipe.

Service Indices — points d'accès

D'autres familles de services (manipulation de PDF, …) rejoindront l'API sous leur propre préfixe ; l'authentification par clé et le suivi de consommation s'appliquent de la même manière.

Paramètres communs

Exemples

$ curl -H "X-API-Key: votre-clé" \
    "https://api.swissautomate.ch/api/ipc?date=2026-05-15"
{ "ipc": 108.3, "ipcdate": "2026-05-01" }

$ curl -H "X-API-Key: votre-clé" \
    "https://api.swissautomate.ch/api/trh?date=2026-05-15"
{ "trh": 1.25, "trhdate": "2026-03-03" }

$ curl -H "X-API-Key: votre-clé" \
    "https://api.swissautomate.ch/api/indices?date=2026-05-15"
{
  "ipc": 108.3,           // indice du mois de la date demandée
  "trh": 1.25,            // taux en vigueur à la date demandée (%)
  "ipcdate": "2026-05-01",  // mois de référence de l'IPC
  "trhdate": "2026-03-03"   // date « valable dès le » de la publication OFL
}

Utiliser une base IPC différente

L'IPC est disponible sur plusieurs bases d'indexation (mois de référence valant 100). Par défaut, la base 2020-12 est utilisée. Pour choisir une autre base, passez le paramètre base :

$ curl -H "X-API-Key: votre-clé" \
    "https://api.swissautomate.ch/api/ipc?date=2026-05-15&base=1977-09"
{ "ipc": 215.4, "ipcdate": "2026-05-01" }  // valeur sur la base sept. 1977 = 100

Bases disponibles : 1914-06, 1939-08, 1966-09, 1977-09, 1982-12, 1993-05, 2000-05, 2005-12, 2010-12, 2015-12, 2020-12, 2025-12.

• ipc et trh sont des nombres JSON ; les dates sont des chaînes YYYY-MM-DD.
• Si le mois demandé n'est pas encore publié par l'OFS, l'API renvoie le dernier mois disponible (visible via ipcdate).
• Le TRH renvoyé est celui de la dernière publication dont la date « valable dès le » est antérieure ou égale à la date demandée.

Codes de statut

Service PDF — points d'accès

Manipulation de documents PDF, 100 % en JSON : les fichiers sont transmis et renvoyés en base64. Méthode POST, en-tête X-API-Key, réponses {"success": true, "file": …} ou {"success": true, "files": […]} ; en cas d'erreur métier : HTTP 422 et {"success": false, "error": "…"}.

$ BASE64=$(base64 -w 0 dossier.pdf)
$ curl -s -X POST -H "X-API-Key: votre-clé" -H "Content-Type: application/json" \
    -d "{\"file\":\"$BASE64\"}" \
    "https://api.swissautomate.ch/api/pdf/extract-first-page" \
  | jq -r '.file' | base64 -d > premiere-page.pdf

Service Excel — points d'accès

Service Avis de fixation — points d'accès

Génération d'avis de fixation de loyer officiels pour les cantons GE, VD, FR et LU. Méthode POST, en-tête X-API-Key, corps JSON {canton, mode, fields} :

$ curl -s -X POST -H "X-API-Key: votre-clé" -H "Content-Type: application/json" \
    -d "{\"canton\":\"GE\",\"mode\":\"fields-only\",\"fields\":{\"tenant\":\"Jean Exemple\",\"owner\":\"Immo Exemple SA\",\"new_annual_rent\":\"38400.00\"}}" \
    "https://api.swissautomate.ch/api/v1/avis/render" \
  | jq -r '.file' | base64 -d > avis-ge.pdf

Les valeurs sont rendues verbatim (aucun formatage côté API). Les cantons non supportés (BE, ZH, …) renvoient HTTP 422.

Canton FR

Canton GE

Canton LU

Canton VD

Service Factures — points d'accès

Génération de factures white-label pour votre client final : logo, coordonnées bancaires et calculs TVA proviennent du profil de facturation associé à votre clé. Méthode POST, en-tête X-API-Key, corps JSON {brand_profile, language, header, lines, iban_override} :

$ curl -s -X POST -H "X-API-Key: votre-clé" -H "Content-Type: application/json" \
    -d "{\"brand_profile\":\"acme\",\"language\":\"fr\",\"header\":{\"invoice_number\":\"F-2026-001\",\"booking_contact\":\"Jean Exemple\",\"building\":\"Résidence Alpina\",\"customer_ref\":\"CL-042\",\"start_date\":\"2026-05-01\",\"end_date\":\"2026-05-07\",\"guests\":2},\"lines\":[{\"description\":\"Séjour 6 nuits\",\"quantity\":6,\"unit_price\":150,\"vat_rate\":0.081},{\"description\":\"Frais de dossier\",\"quantity\":1,\"unit_price\":150.00,\"vat_rate\":0.081}]}" \
    "https://api.swissautomate.ch/api/v1/invoice/render" \
  | jq -r '.file' | base64 -d > facture.pdf

L'API calcule les montants TTC et le total — envoyez les valeurs brutes. Le profil de facturation est géré dans le portail admin et appartient à votre clé.

Accès MCP (assistants IA)

Les mêmes services sont accessibles à votre assistant IA (Claude, …) via le protocole MCP : connectez https://api.swissautomate.ch/mcp/api avec votre clé API comme jeton Bearer. Outils disponibles : get_ipc, get_trh, get_indices, list_ipc_bases. Les appels sont comptabilisés comme les appels REST.

claude mcp add --transport http swissautomate-api https://api.swissautomate.ch/mcp/api \
  --header "Authorization: Bearer votre-clé"

GET /api/health

Point de contrôle public (sans authentification) exposant l'état du service :

{
  "status": "ok",
  "ipc_rows": 5483,
  "trh_rows": 72,
  "latest_trh_from": "2026-06-02",
  "latest_ipc_month": "2026-06",
  "ipc_default_base": "2020-12",
  "ipc_bases": ["1914-06", "…", "2025-12"]
}

Sources des données

• IPC : OFS, « LIK, Totalindex auf allen Indexbasen » (tableaux d'indexation, n° cc-d-05.02.08).
• TRH : OFL, « Évolution du taux de référence et du taux d'intérêt moyen ».