Aller au contenu principal

SKU : Indicateur bien (PROPERTY_ANALYTIC)

Clément Lardeur
  • Mise à jour

Tarification

  • Coût unitaire : 0.01 € (par SKU)

Endpoints

Endpoint : /properties/count

  • Requête
GET https://api.yanport.com/properties/count?marketingTypes=SALE&propertyTypes=LAND&cityIds=53284461&surfaceMin=800
  •  Réponse
{
  "count": 67
}
  • Consommation: 1 SKU (soit 0.01 €)

Le nombre de SKU est égale au nombre de requête HTTP. 

Endpoint : /properties/count/group-by-{groupBy}

  • Requête
GET https://api.yanport.com/properties/count/group-by-property-type?source=DVF&marketingTypes=SALE&propertyTypes=HOUSE&cityIds=48671445
  •  Réponse
{
  "HOUSE": {
    "count": 1371
  }
  "APARTMENT": {
    "count": 1509
  }
}
  • Consommation: 2 SKU (soit 0.02 €)

Le nombre de SKU est égale au nombre de regroupement (propriété count) de requête HTTP. 

Endpoint : /properties/count/group-by-{groupBy}-and-{subGroupBy}

  • Requête
GET https://api.yanport.com/properties/count/group-by-property-type-and-room-count?source=DVF&marketingTypes=SALE&propertyTypes=APARTMENT&cityIds=48671445
  •  Réponse
{
  "APARTMENT": {
    "1": {
      "count": 862
    },
    "2": {
      "count": 687
    },
    "3": {
      "count": 607
    },
    "4": {
      "count": 410
    },
    "5": {
      "count": 135
    },
    "6": {
      "count": 5
    }
  },
  "HOUSE": {
    "1": {
      "count": 546
    },
    "2": {
      "count": 154
    },
    "3": {
      "count": 78
    },
    "4": {
      "count": 5
    }
  }
}
  • Consommation: 10 SKU (soit 0.1 €)

Le nombre de SKU est égale au nombre de regroupement (propriété count) renvoyé par la requête HTTP. 

Endpoint : /properties/distribution

  • Requête
GET https://api.yanport.com/properties/distribution?field=PRICE_M2&intervalField=ROOM_COUNT&interval=1&percentiles=25&percentiles=50&percentiles=75&zipCodes=92300&marketingTypes=SALE&roomCounts=1&roomCounts=2&roomCounts=3
  •  Réponse
{
  "points": [
    {
      "x": "1.0",
      "y": {
        "count": 2173,
        "values": {
          "75.0": 9898.930000000002,
          "25.0": 7942.8943891402705,
          "50.0": 8855.451650537634
        }
      }
    },
    {
      "x": "2.0",
      "y": {
        "count": 5291,
        "values": {
          "75.0": 9386.884932126697,
          "25.0": 7627.505633928572,
          "50.0": 8481.995576161247
        }
      }
    },
    {
      "x": "3.0",
      "y": {
        "count": 4438,
        "values": {
          "75.0": 9713.579792145594,
          "25.0": 7936.20127218935,
          "50.0": 8770.988205128204
        }
      }
    }
  ],
  "type": "PERCENTILES"
}
  • Consommation: 12 SKU (soit 0.12 €)

Le nombre de SKU est égale au nombre de percentiles (q25, q50, q75) et des propriétés count renvoyés pour chaque point de la distribution.

Endpoint : /properties/evolution

  • Requête
GET https://api.yanport.com/properties/evolution?field=PRICE_M2&intervalField=DELETE_DATE&interval=1&percentiles=25&percentiles=50&percentiles=75&zipCodes=92300&marketingTypes=SALE&roomCounts=1&roomCounts=2&roomCounts=3&deleteDateMin=2020-01-01T00:00
  •  Réponse
{
  "points": [
    {
      "x": "2020-01-01",
      "y": {
        "count": 138,
        "values": {
          "75.0": 10884.7725,
          "25.0": 8895.0825,
          "50.0": 9978.095000000001
        }
      }
    },
    {
      "x": "2020-02-01",
      "y": {
        "count": 125,
        "values": {
          "75.0": 10987.805,
          "25.0": 9222.66,
          "50.0": 10298.97
        }
      }
    },
    {
      "x": "2020-03-01",
      "y": {
        "count": 3,
        "values": {
          "75.0": 11176.439999999999,
          "25.0": 9812.035,
          "50.0": 9980.0
        }
      }
    }
  ],
  "type": "PERCENTILES"
}
  • Consommation: 12 SKU (soit 0.12 €)

Le nombre de SKU est égale au nombre de percentiles (q25, q50, q75) et des propriétés count renvoyés pour chaque point de l'histogramme.

Endpoint : /properties/evolution/stock

  • Requête
GET https://api.yanport.com/properties/evolution/stock?intervalUnit=MONTHS&zipCodes=92300&marketingTypes=SALE&dateMin=2020-01-01&dateMax=2020-03-01
  •  Réponse
{
  "in": {
    "points": [
      {
        "x": "2020-01-01",
        "y": {
          "count": 209,
          "values": {}
        }
      },
      {
        "x": "2020-02-01",
        "y": {
          "count": 224,
          "values": {}
        }
      }
    ],
    "type": "PERCENTILES"
  },
  "out": {
    "points": [
      {
        "x": "2020-01-01",
        "y": {
          "count": 306,
          "values": {}
        }
      },
      {
        "x": "2020-02-01",
        "y": {
          "count": 244,
          "values": {}
        }
      }
    ],
    "type": "PERCENTILES"
  },
  "global": {
    "points": [
      {
        "x": "2020-01-01",
        "y": {
          "count": 253,
          "values": {}
        }
      },
      {
        "x": "2020-02-01",
        "y": {
          "count": 233,
          "values": {}
        }
      }
    ],
    "type": "PERCENTILES"
  }
}
  • Consommation: 6 SKU (soit 0,06 €)

Le nombre de SKU est égale à la somme du nombre de biens immobiliers (propriétés count) renvoyés par la requête HTTP.

Endpoint : /properties/percentiles

  • Requête
GET https://api.yanport.com/properties/percentiles?field=PRICE_M2&percentiles=50&percentiles=25&percentiles=75&marketingTypes=SALE&zipCodes=92300
  •  Réponse
{
  "count": 18149,
  "values": {
    "75.0": 9753.574377229656,
    "25.0": 7701.700425603809,
    "50.0": 8683.381504818384
  }
}
  • Consommation: 4 SKU (soit 0.04 €)

Le nombre de SKU est égale au nombre de percentiles demandés (q25, q50, q75) plus le total des biens (propriété count).

Endpoint : /properties/percentiles/group-by-{groupBy}

  • Requête
GET https://api.yanport.com/properties/percentiles/group-by-property-type?field=PRICE_M2&percentiles=50&marketingTypes=SALE&zipCodes=92300
  •  Réponse
{
  "BUILDING": {
    "count": 33,
    "values": {
      "50.0": 8309.04
    }
  },
  "APARTMENT": {
    "count": 16538,
    "values": {
      "50.0": 8780.869397480476
    }
  },
  "PREMISES": {
    "count": 815,
    "values": {
      "50.0": 3061.004
    }
  },
  "LAND": {
    "count": 3,
    "values": {
      "50.0": 89.66
    }
  },
  "HOUSE": {
    "count": 386,
    "values": {
      "50.0": 8252.48
    }
  },
  "PARKING": {
    "count": 374,
    "values": {
      "50.0": 2000.0
    }
  }
}
  • Consommation: 12 SKU (soit 0.12 €)

Le nombre de SKU est égale au nombre de percentiles (q50) et au total de biens de chaque regroupement renvoyés par la requête HTTP.

Endpoint : /properties/percentiles/group-by-{groupBy}-and-{subGroupBy}

  • Requête
GET https://api.yanport.com/properties/percentiles/group-by-property-type-and-room-count?field=PRICE_M2&percentiles=50&marketingTypes=SALE&zipCodes=34000&roomCounts=1&roomCounts=2&roomCounts=3&propertyTypes=APARTMENT&propertyTypes=HOUSE
  •  Réponse
{
  "APARTMENT": {
    "1": {
      "count": 10364,
      "values": {
        "50.0": 3864.9744653679654
      }
    },
    "2": {
      "count": 26784,
      "values": {
        "50.0": 3711.1476541176858
      }
    },
    "3": {
      "count": 30917,
      "values": {
        "50.0": 3407.2614602417534
      }
    }
  },
  "HOUSE": {
    "1": {
      "count": 87,
      "values": {
        "50.0": 2755.0299999999997
      }
    },
    "2": {
      "count": 264,
      "values": {
        "50.0": 3488.37
      }
    },
    "3": {
      "count": 1137,
      "values": {
        "50.0": 3313.7432000000003
      }
    }
  }
}
  • Consommation: 12 SKU (soit 0.12 €)

Le nombre de SKU est égale au nombre de percentiles (q50) et au total de biens de chaque regroupement renvoyés par la requête HTTP.

Endpoint : /properties/stats

  • Requête
GET https://api.yanport.com/properties/stats?field=SURFACE&zipCodes=92300&marketingTypes=SALE
  •  Réponse
{
  "count": 17808,
  "min": 5.5,
  "max": 5360.0,
  "avg": 69.72658636567836,
  "sum": 1241691.0500000003
}
  • Consommation: 5 SKU (soit 0.05 €)

Le nombre de SKU est égale au nombre de propriétés renvoyés par la requête HTTP.

Endpoint : /properties/stats/group-by-{groupBy}

  • Requête
GET https://api.yanport.com/properties/stats/group-by-room-count?field=SURFACE&zipCodes=92300&roomCounts=1&roomCounts=2&propertyTypes=APARTMENT
  •  Réponse
{
  "1": {
    "count": 8229,
    "min": 5.5,
    "max": 190.0,
    "avg": 23.172838741037797,
    "sum": 190689.29000000004
  },
  "2": {
    "count": 13009,
    "min": 10.0,
    "max": 330.0,
    "avg": 40.792986394034884,
    "sum": 530675.9599999998
  }
}
  • Consommation: 10 SKU (soit 0.1 €)

Le nombre de SKU est égale au nombre de valeur du regroupement demandé multiplié par le nombre de propriété de chacun de ces regroupements, soit le nombre de propriétés au total renvoyé par la requête HTTP.

Endpoint : /properties/stats/group-by-{groupBy}-and-{subGroupBy}

  • Requête
GET https://api.yanport.com/properties/stats/group-by-room-count-and-surface?field=PRICE&zipCodes=92300&roomCounts=1&roomCounts=2&propertyTypes=APARTMENT&termsSize=10
  •  Réponse
{
  "1": {
    "16.0": {
      "count": 302,
      "min": 45.0,
      "max": 199500.0,
      "avg": 29192.973741721857,
      "sum": 8816278.07
    },
    "15.0": {
      "count": 316,
      "min": 40.0,
      "max": 215000.0,
      "avg": 32444.512911392405,
      "sum": 1.025246608E7
    },
    "25.0": {
      "count": 430,
      "min": 80.0,
      "max": 379000.0,
      "avg": 45944.225581395345,
      "sum": 1.9756017E7
    },
    "24.0": {
      "count": 300,
      "min": 375.0,
      "max": 320000.0,
      "avg": 51635.471633333334,
      "sum": 1.549064149E7
    },
    "23.0": {
      "count": 288,
      "min": 400.0,
      "max": 392000.0,
      "avg": 38050.05868055556,
      "sum": 1.09584169E7
    },
    "22.0": {
      "count": 284,
      "min": 375.0,
      "max": 269000.0,
      "avg": 33894.22503521127,
      "sum": 9625959.91
    },
    "20.0": {
      "count": 462,
      "min": 35.0,
      "max": 220000.0,
      "avg": 29688.700259740257,
      "sum": 1.371617952E7
    },
    "30.0": {
      "count": 425,
      "min": 50.0,
      "max": 385000.0,
      "avg": 71447.72724705882,
      "sum": 3.036528408E7
    },
    "18.0": {
      "count": 321,
      "min": 480.0,
      "max": 259000.0,
      "avg": 39360.51981308411,
      "sum": 1.263472686E7
    },
    "28.0": {
      "count": 303,
      "min": 250.0,
      "max": 460000.0,
      "avg": 72731.37768976898,
      "sum": 2.203760744E7
    }
  },
  "2": {
    "36.0": {
      "count": 381,
      "min": 369.0,
      "max": 445000.0,
      "avg": 113036.01257217847,
      "sum": 4.306672079E7
    },
    "35.0": {
      "count": 534,
      "min": 75.0,
      "max": 399000.0,
      "avg": 82422.8095692884,
      "sum": 4.401378031E7
    },
    "50.0": {
      "count": 504,
      "min": 550.0,
      "max": 970000.0,
      "avg": 187359.27984126986,
      "sum": 9.442907704E7
    },
    "40.0": {
      "count": 644,
      "min": 60.0,
      "max": 740000.0,
      "avg": 139611.75400621118,
      "sum": 8.990996958E7
    },
    "32.0": {
      "count": 344,
      "min": 550.0,
      "max": 470000.0,
      "avg": 90337.49418604652,
      "sum": 3.1076098E7
    },
    "30.0": {
      "count": 522,
      "min": 60.0,
      "max": 390000.0,
      "avg": 95117.68582375479,
      "sum": 4.9651432E7
    },
    "42.0": {
      "count": 470,
      "min": 875.0,
      "max": 545000.0,
      "avg": 167306.72634042552,
      "sum": 7.863416138E7
    },
    "45.0": {
      "count": 463,
      "min": 500.0,
      "max": 520689.0,
      "avg": 161209.2836285097,
      "sum": 7.463989832E7
    },
    "37.0": {
      "count": 378,
      "min": 500.0,
      "max": 399000.0,
      "avg": 118731.98682539682,
      "sum": 4.4880691019999996E7
    },
    "38.0": {
      "count": 400,
      "min": 500.0,
      "max": 470000.0,
      "avg": 132925.0925,
      "sum": 5.3170037E7
    }
  }
}
  • Consommation: 100 SKU (soit 1,00 €)

Le nombre de SKU est égale au nombre de valeur du regroupement demandé multiplié par le nombre de propriété de chacun de ces regroupements, soit le nombre de propriétés au total renvoyé par la requête HTTP.

 

Articles associés

Commentaires

0 commentaire

Vous devez vous connecter pour laisser un commentaire.