---
title: "Lecture structurée d'un jeu de données"
method: GET
path: "/jeux/{jeu}"
---

# Lecture structurée d'un jeu de données

`GET /jeux/{jeu}`

## Request

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

Les lignes d'un jeu de données, sans SQL : filtre[colonne][operateur]=valeur sur les colonnes filtrables du jeu (eq, in, lt, lte, gt, gte, entre, prefixe, nul ; combinés par « et »), colonnes choisies par champs, pagination par curseur. Un jeu volumineux exige au moins un filtre sur une colonne indexée (schéma du jeu : GET /jeux/{jeu}/schema). Les lignes sont triées par la clé de tri du jeu, en ordre croissant ; aucun autre tri n'est offert. Toute ligne passe le retrait des particuliers : les professionnels sont nommés, un particulier jamais. Un jeu marqué creneau_lourd n'est pas lu de 20h30 à minuit (heure de Paris) ; une lecture trop large pour le délai de la base répond 503 : resserrez les filtres. Coût : 1 crédit par tranche de 10 lignes rendues ; 1 crédit par élément rendu pour un jeu calculé par Pillr.

## 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.

## Query parameters

- `filtre` object: Filtres : filtre[colonne][operateur]=valeur, 12 au plus, combinés par « et ». Opérateurs : eq, in, lt, lte, gt, gte, entre, prefixe, nul. Les colonnes filtrables et leurs opérateurs sont dans le schéma du jeu ; un jeu volumineux exige au moins un filtre sur une colonne indexée.
- `champs` union: Colonnes rendues, séparées par des virgules ; toutes si absent. Les colonnes de la clé de tri sont toujours rendues (elles portent le curseur).
  - string
  - string[]
- `limite` integer: Nombre d'éléments par page (1000 au plus).
- `curseur` string: Curseur opaque rendu par la page précédente (curseur_suivant), à repasser tel quel.

## Response `200`

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

- object
  - `jeu` string, required
  - `titre` string, required
  - `base` 'servie' | 'lac', required
  - `nature` 'calcule_pillr' | 'public_brut', required
  - `colonnes` object[], required: Les colonnes rendues, dans l'ordre du schéma du jeu, avec leur type Postgres.
    - `nom` string, required
    - `type` string, required
  - `cle_tri` string[], required
  - `lignes` object[], required: Les lignes, triées par la clé du jeu, en ordre croissant (une valeur vide en dernier).
    - `vendeur_nom` unknown
    - `vendeur_enseigne` unknown
    - `vendeur_siren` unknown
    - `vendeur_telephone` unknown
    - `vendeur_email` unknown
    - `vendeur_identifiant_portail` unknown
    - `publisher_type` unknown
    - `annonce_publisher` unknown
    - `annonce_empreinte_publisher` unknown
    - `prenom` unknown
    - `titre` unknown
    - `title` unknown
    - `description` unknown
  - `n` integer, required: Lignes rendues dans cette page.
  - `volume_jeu` number, nullable, required: Nombre de lignes du jeu entier, estimé à sa déclaration ; ce n'est pas le nombre de lignes filtrées.
  - `donnees_du` string, nullable, required: Date des données : dernier chargement de la source publique, ou date la plus récente des lignes servies ; null si inconnue.
  - `retrait_particuliers` string, 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.
  - `curseur_suivant` string, nullable, required: Curseur de la page suivante, à repasser dans curseur ; null sur la dernière page.
  - `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 ; Curseur invalide
- `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)