fonciqAPI
Lots

Résoudre une adresse ou un matricule

Portée `lots:read`. Cette lecture 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. Elle n'entraîne pas de frais de document. Fournir `address` ou `matricule`. La réponse énumère le lot, le cadastre, le matricule et indique si le rôle corrobore le lot.

GET
/v1/lots/resolve

Autorisation

AuthorizationBearer <token>

Clé d'API de l'organisation. Le secret n'est montré qu'une fois. Le préfixe affichable d'une clé d'essai est fq_test_. Le hachage SHA-256 est la seule forme conservée. Le panneau d'essai de cette documentation n'envoie qu'une clé fq_test_ et n'effectue aucun débit.

Dans : en-tête

Paramètres de requête

address?string

Adresse au Québec. Mutuellement exclusif avec matricule dans l'usage attendu ; fournir l'un des deux.

matricule?string

Matricule du rôle d'évaluation.

Corps de la réponse

application/json

application/json

application/json

application/json

curl -X GET "https://api.fonciq.ca/v1/lots/resolve"
{
  "lots": [
    {
      "lot": "1234567",
      "cadastre": "Cadastre du Québec",
      "matricule": "1234-56-7890-1-234-5678",
      "role_matched": true
    }
  ]
}
{
  "error": {
    "code": "invalid_request",
    "message": "Indiquer une adresse ou un matricule.",
    "request_id": "req_01HZX"
  }
}
{
  "error": {
    "code": "unauthorized",
    "message": "Clé d'API refusée.",
    "request_id": "req_01HZX"
  }
}
{
  "error": {
    "code": "rate_limited",
    "message": "Trop de requêtes pour cette clé.",
    "request_id": "req_01HZX"
  }
}

Lire la fiche d'un lot GET

Portée `lots:read`. Cette lecture 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. Elle ne débite pas Fonciq. La fiche réunit le cadastre, l'évaluation du rôle en cents et les lignes d'index de `registre.entries`. Même objet qu'une tâche terminée. Cette opération ne tire pas un index. JSON par défaut. `format=csv` ou `Accept: text/csv` renvoie ces lignes en CSV à la place de la fiche. `format` l'emporte. Toute autre valeur de `format` reçoit `400` et le code `invalid_request`.

Créer une surveillance POST

Portée `watches:write`. En-tête `Idempotency-Key` obligatoire, conservé 24 heures. Le Registre foncier n'offre pas de flux poussé. Une surveillance est une revérification planifiée, comparée à un instantané de référence pris à la création. Sans `account_id`, elle est placée sur le compte par défaut. Avec `account_id`, elle est épinglée à ce compte. Elle consomme la capacité quotidienne d'index de ce compte (plafond 540, dont 180 réservés aux appels à la demande). Créer la surveillance 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. `cadence` vaut `weekly` (défaut) ou `daily`. Créer la surveillance ne débite pas Fonciq. Chaque index consulté ensuite débite 99 cents sur une clé réelle et 150 cents au Registre, parce que l'index consulte toujours le Registre. Les frais du Registre s'appliquent lorsque le Registre est consulté. Ce débit de 99 cents n'est pas renvoyé ici. Plafonds d'organisation : 25 surveillances actives, et 20 revérifications d'index de surveillance par jour (heure de Toronto). Au-delà du plafond de surveillances actives, la réponse est `409` et le code `watch_cap_reached`. La pause, la suppression, l'historique et le renvoi manuel se font dans le tableau de bord.