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

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.

get/jeux/{jeu}

Request

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

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

filtreobject

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.

string
OR
string[]
limiteinteger

Nombre d'éléments par page (1000 au plus).

curseurstring

Curseur opaque rendu par la page précédente (curseur_suivant), à repasser tel quel.

Response

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

jeustring required
titrestring required
base'servie' | 'lac' required
nature'calcule_pillr' | 'public_brut' required
cle_tristring[] required
ninteger required

Lignes rendues dans cette page.

volume_jeunumber nullable required

Nombre de lignes du jeu entier, estimé à sa déclaration ; ce n'est pas le nombre de lignes filtrées.

donnees_dustring 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_particuliersstring required
curseur_suivantstring nullable required

Curseur de la page suivante, à repasser dans curseur ; null sur la dernière page.

Changes

No recorded changes to this operation across all 1 revision of this API.