---
title: "Catalogue des jeux de données"
method: GET
path: "/jeux/{jeu}/schema"
---

# Catalogue des jeux de données

`GET /jeux/{jeu}/schema`

## Request

- Base URL: `https://pillr.fr/api/v1`
- URL: `https://pillr.fr/api/v1/jeux/{jeu}/schema`
- Auth: HTTP bearer

Le catalogue des jeux que lisent lire_jeu et agreger_jeu, tel que chaque base le déclare (liste blanche des colonnes, relue sur la vue du jeu) : pour chaque jeu, sa description, sa base, sa nature (calculé par Pillr ou public brut), sa maille, sa source et sa licence d'origine, son volume estimé, sa clé de tri, son coût par ligne, la date de ses données quand un journal de chargement la donne, et ses colonnes avec leur type, leur définition, leurs opérateurs de filtre et si elles sont indexées, groupables ou mesurables. GET /jeux/{jeu}/schema rend un seul jeu. Coût : 0 crédit par appel réussi.

## Path parameters

- `jeu` 'annonces' | 'evenements_prix' | 'diffusions' | 'communes' | 'prix_iris' | 'loyers' | 'mutations' | 'indice_travaux' | 'adresses' | 'dvf' | 'dvf_ancien' | 'ban' | 'dpe_existant' | 'dpe_neuf' | 'dpe_tertiaire' | 'dpe_ancien' | 'audits' | 'coproprietes' | 'permis_logements' | 'permis_locaux' | 'permis_demolir' | 'permis_amenager' | 'bodacc' | 'lovac' | 'plu' | 'signaux_communes' | 'marche_commune' | 'agences_commune' | 'sirene_immobilier' | 'annonces_archives' | 'biens', required: Nom du jeu, tel que GET /jeux le liste.

## Response `200`

Réponse servie et débitée (sauf réponse identique déjà servie dans les 24 h).

- object
  - `jeux` object[], required
    - `jeu` string, required
    - `titre` string, required
    - `description` string, required
    - `base` 'servie' | 'lac', required: servie : la base du site ; lac : le lac de données.
    - `nature` 'calcule_pillr' | 'public_brut', required: calcule_pillr : jeu calculé par Pillr ; public_brut : jeu public, tel que publié par sa source.
    - `maille` string, required: Ce qu'est une ligne du jeu.
    - `source` string, required: Source d'origine, en clair.
    - `licence` string, required: Licence d'origine des données.
    - `volume` object, required: Nombre de lignes du jeu, estimé par les statistiques de la base à la déclaration du jeu.
      - `valeur` number, nullable, required
      - `qualite` object, required: Ce qui permet de juger la valeur : nombre, provenance, incertitude, drapeaux, date et source.
        - `n` integer, nullable, required: Nombre d'observations derrière la valeur ; null si sans objet.
        - `provenance` 'mesure' | 'estime', nullable, required: mesure : observé sur la donnée ; estime : modèle, barème ou imputation ; null : sans objet.
        - `incertitude` object, nullable, required: Incertitude de la valeur : fourchette et demi-largeur.
          - `demi_largeur_pct` number, nullable, required: Demi-largeur de la fourchette, en % de la valeur.
          - `bas` number, nullable, required
          - `haut` number, nullable, required
        - `drapeaux` string[], required: Ce qui doit faire lire la valeur avec prudence ; vide si rien.
        - `methode` string, nullable, required: Méthode de calcul ou de rattachement, en clair.
        - `donnees_du` string, nullable, required: Date de la donnée (AAAA-MM-JJ ou horodatage ISO 8601).
        - `source` string, required: Source publique ou moteur Pillr, en clair.
    - `cle_tri` string[], required: Colonnes de la clé de tri : les lignes sont rendues dans cet ordre, et le curseur s'y lit.
    - `limite_max` integer, required: Lignes par page au plus.
    - `filtre_indexe_requis` boolean, required: Vrai : une lecture exige au moins un filtre sur une colonne indexée.
    - `creneau_lourd` boolean, required: Vrai : le jeu n'est pas lu de 20h30 à minuit (heure de Paris).
    - `cout` object, required
      - `bareme` 'element_public' | 'ligne_brute', required: Ligne du barème.
      - `credits` integer, required: Crédits par unité.
      - `unite` 'element' | 'tranche', required: element : par ligne rendue ; tranche : par tranche entamée de lignes rendues.
      - `lignes_par_unite` integer, required
      - `libelle` string, required
    - `fraicheur` object, required
      - `donnees_du` string, nullable, required: Date des données du jeu, quand elle se lit dans un journal de chargement ; null sinon.
      - `mesure` string, nullable, required: Ce que date donnees_du.
    - `declare_le` string, nullable, required: Date de la dernière déclaration du jeu (liste blanche relue sur la vue).
    - `colonnes` object[], required
      - `nom` string, required
      - `type` string, required: Type Postgres de la colonne.
      - `definition` string, required
      - `filtrable` boolean, required
      - `indexee` boolean, required: Vrai : un filtre sur cette colonne compte comme filtre indexé.
      - `operateurs` string[], required
      - `groupable` boolean, required
      - `mesurable` boolean, required
  - `retrait_particuliers` string, required: La règle appliquée à toute ligne servie.
  - `credits` object, required: Crédits débités par cet appel (réservés, pour une tâche en cours), et crédits encore utilisables ce mois avant la coupure : crédits offerts, crédits inclus du mois et crédits facturables sous le plafond de dépense (null si inconnus ou en bac à sable).
    - `debites` integer, required
    - `restants` integer, nullable, required

## Other responses

- `304`: Non modifiée depuis l'ETag fourni : rien n'est débité.
- `400`: Paramètres invalides
- `401`: Clé d'API absente
- `402`: Crédits insuffisants ; Carte requise ; Plafond mensuel de dépense atteint
- `403`: Portée insuffisante
- `404`: Ressource absente : rien n'est débité
- `429`: Trop de requêtes par minute
- `500`: Erreur interne
- `503`: API indisponible ; Donnée momentanément indisponible

---

[API](https://skmtc.dev/pillr/apis/api-pillr.md) · [All operations](https://skmtc.dev/pillr/apis/api-pillr/llms.txt) · [OpenAPI document](https://skmtc.dev/pillr/apis/api-pillr/revisions/218b2866bd6c?raw)