Offer Statistics Light
POST
offers/statistics_light
Returns a percentage of offers (percentile rank) of the same type (apartment
or house
) in the given location which are cheaper than the provided price (salePrice
).
If for a salePrice
of 750’000
the returned percentileRank
is 32
that means in the selected location 32% of similar properties are cheaper and 68% of similar properties are more expensive.
The location currently can only be specified by a post code (divisionLevel100
).
This endpoint is a simplified version of Offer Statistics. For advanced requirements, use that endpoint instead.
Request#
curl -X POST 'https://api.pricehubble.com/api/v1/offers/statistics_light' \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer 74126eab0a9048d993bda4b1b55ae074' \
-d '{
"salePrice": 750000,
"divisionLevel100": "8001",
"propertyType": "apartment",
"dossierId": "3bac39b8-2d84-4ae9-a693-40502071ea5d",
"countryCode": "CH"
}'
Field | Description | Type | Remarks |
---|---|---|---|
salePrice | Price to which the offers will be compared against | integer | |
propertyType | string | Valid values are apartment or house |
|
divisionLevel100 | Postal code / official ID of the level 100 division | string | |
dossierId | ID of the dossier | string | If this field is added to the request, then the location must be the same as the dossier's location (address or coordinates) |
countryCode | ISO country code | string |
Response#
{
"percentileRank": 32
}
Field | Description | Type | Remarks |
---|---|---|---|
percentileRank | Percentage of offers that are cheaper in the specified area than the provided salePrice |
integer |