Démarrage

Trois étapes : une clé d'API, un compte du Registre foncier, un premier appel. Le panneau d'essai n'envoie qu'une clé fq_test_ et n'effectue aucun débit.

1. Créer une clé

Dans le tableau de bord, créez une clé. Le secret n'est affiché qu'une fois. Le préfixe visible d'une clé d'essai est fq_test_. Transmettez-le dans l'en-tête Authorization: Bearer fq_test_…. La clé se crée après la connexion au studio.

Le panneau d'essai n'envoie qu'une clé de ce préfixe. Il est sur chaque appel, par exemple résoudre un lot.

2. Ajouter un compte du Registre

Dans les paramètres de l'API, ajoutez un compte du Registre foncier. Un écran de consentement précède l'enregistrement. La valeur est chiffrée, en écriture seule, et vous pouvez la révoquer. Le traitement du compte est décrit dans le tableau de bord. L'ajout se fait après la connexion au studio.

Le compte que vous désignez comme compte par défaut sert lorsqu'une requête omet account_id. Vous pouvez en ajouter plusieurs. Une organisation sans compte ne peut pas commander d'index ni d'acte.

3. Premier appel

GET /v1/lots/resolve interroge les rôles d'évaluation foncière des municipalités du Québec, l'un des jeux de données publics intégrés aux Données Fonciq. Il ne débite pas Fonciq.

curl "https://api.fonciq.ca/v1/lots/resolve?address=100%20rue%20Saint-Paul%20Est%2C%20Montr%C3%A9al" \
  -H "Authorization: Bearer fq_test_…"

Pour commander un index sur le compte par défaut, envoyez une clé d'idempotence. Cet appel d'index est facturé 0,99 $ sur une clé réelle. L'index consulte toujours le Registre : 1,50 $, Loi sur les bureaux de la publicité des droits (B-9), annexe I, art. 15 (Avis du 30 mars 2026). Une clé fq_test_ ne débite pas. Le détail est dans coûts par appel. Le suivi des frais du Registre est dans facturation.

curl -X POST https://api.fonciq.ca/v1/registre/requests \
  -H "Authorization: Bearer fq_test_…" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: 3f1c0b2e-7a4d-4e1a-9c2b-0d5e6f7a8b9c" \
  -d '{"lot":"1234567","documents":["index"]}'

La réponse contient job_id. Lisez l'état avec GET /v1/jobs/{id}. Pour épingler un autre compte, ajoutez account_id au corps. Le journal de la tâche est dans le studio, après la connexion au studio.

Lorsque la tâche est succeeded, l'index renvoie toujours son PDF (GET /v1/documents/{id}). Ce PDF fait foi. Le résultat structuré est sur result.index, ou sur GET /v1/documents/{id}/entries. Le CSV est une option. Le détail est dans tâches.

La suite : authentification, facturation, tâches.