Classement de communes (screener)

Communes classées par rendement brut théorique (loyer multiplié par douze, divisé par le prix au m², pour les appartements ou les maisons), par score Pillr ou par distance, avec la logique de l'outil de screening du Hub. Filtres : budget et surface type, prix au m² maximal, rendement minimal, population, sécurité, vacance, évolution à 3 ans, exclusion des QPV, type de bien, distance réelle autour d'une commune (entre centres habités), et les stratégies cashflow, patrimonial, pinel et deal de la page des opportunités. Chaque commune porte la provenance et le nombre de ventes de son prix. Liste paginée. Coût : 1 crédit par élément rendu.

get/communes/classement

Request

  • Base URL: https://pillr.fr/api/v1
  • URL: https://pillr.fr/api/v1/communes/classement
  • Auth: HTTP bearer

Query parameters

autour_destring

Code INSEE de la commune de départ du rayon.

rayon_kmnumber

Rayon autour de la commune de départ, en km (50 par défaut, 150 au plus).

budget_eurnumber

Budget d'achat, en euros : fixe le prix au m² maximal avec la surface type.

surface_type_m2number

Surface type pour le budget, en m² (50 par défaut).

rendement_brut_min_pctnumber
prix_m2_maxnumber
population_minnumber

Population minimale (2 000 par défaut).

securite_minnumber

Sous-score de sécurité minimal, sur 100.

vacance_max_pctnumber
evol_3y_min_pctnumber
boolean
OR
'true' | 'false' | 'oui' | 'non'
type'appartement' | 'maison'

Type de bien : appartement (par défaut) ou maison.

strategie'rendement' | 'cashflow' | 'patrimonial' | 'pinel' | 'deal'

rendement (par défaut, aucun filtre de plus), cashflow, patrimonial, pinel ou deal : les seuils de la page des opportunités.

tri'rendement' | 'score_pillr' | 'distance'

Tri : rendement (par défaut), score_pillr ou distance (avec autour_de).

limiteinteger

Nombre d'éléments par page (50 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).

candidatesinteger required

Communes qui passent les critères, toutes pages confondues.

donnees_dustring nullable 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.