Présentation
Documentation de l'API Fonciq v1. Consultations sur le compte du Registre de votre organisation.
L'API Fonciq v1 permet de résoudre un lot, de lire la fiche du lot, de commander un index ou un acte, de grouper des lots et de surveiller un lot. Un index récupéré renvoie toujours son PDF, qui fait foi. Le CSV est une option. La référence des chemins est générée à partir du seul document OpenAPI de la v1.
Démarrage
Créer une clé, ajouter un compte du Registre, lancer un premier appel.
Que désirez-vous faire ?
| Objectif | Page |
|---|---|
| Trouver le lot à partir d'une adresse ou d'un matricule | Données Fonciq › Résoudre une adresse ou un matricule |
| Obtenir la fiche d'un lot | Données Fonciq › Lire la fiche d'un lot |
| Commander l'index des immeubles d'un lot | Registre foncier › Commander un index |
| Obtenir la copie d'un acte conservé | Registre foncier › Commander un acte |
| Commander le plan cadastral d'un lot | Registre foncier › Commander un plan |
| Suivre les frais et l'usage du Registre | Registre foncier › Facturation |
| Créer une clé API | Plateforme › Démarrage |
Compte du Registre
Les consultations du Registre foncier s'exécutent sur un compte du Registre que votre organisation ajoute dans les paramètres de l'API. Vous pouvez en enregistrer plusieurs. L'un d'eux est le compte par défaut. Une requête peut en désigner un autre avec rf_account_id. account_id est accepté comme alias de ce paramètre.
L'ajout passe par un écran de consentement. La valeur est chiffrée, en écriture seule, et peut être révoquée. Le traitement du compte est décrit dans le tableau de bord. L'ajout se fait après la connexion au studio.
Facturation
L'index, le PDF d'un acte et le plan cadastral sont facturés 0,99 $ par appel. L'analyse structurée d'un acte, à 4,99 $, n'est pas encore disponible : ce montant comprendrait le tirage et ne s'ajouterait pas aux 0,99 $. Bientôt. Les frais du Registre de 1,50 $ s'appliquent seulement lorsque l'appel consulte le Registre. L'index consulte toujours le Registre. Un acte conservé ou un plan conservé n'entraîne pas de frais du Registre. Fonciq ne prélève pas ce 1,50 $ et ne tient pas de portefeuille pour lui. Le détail est dans Coûts. Le panneau d'essai n'effectue aucun débit. Le suivi dans le studio passe par la connexion au studio.
Sources
Les appels livrés aujourd'hui couvrent le Registre foncier. GET /v1/lots/resolve, GET /v1/lots/{lot} et POST /v1/watches interrogent 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. Les autres jeux des Données Fonciq, le RDPRM, le REQ et le SLRI sont marqués Bientôt : leurs appels ne sont pas disponibles. Fonciq n'est affilié à aucun de ces organismes.
Par où commencer
Démarrage
Créer une clé, ajouter un compte du Registre, lancer un premier appel.
Authentification
Clé d'API, portées, compte par défaut et épingle rf_account_id.
Facturation
Frais du Registre par compte. Aucun relevé du portail n'est lu.
Coûts
0,99 $ par appel. Frais du Registre lorsque le Registre est consulté.
Registre foncier
Index, tâches, lots groupés et facturation.