market-analytics-api---distributions

Price Distribution

Returns the number of properties distributed across price ranges.<br>Each range is defined by price boundaries and shows the number of properties with prices falling within those boundaries.

post/market-analytics-api/distributions/prices

Request

  • Base URL: https://api.casafari.com
  • URL: https://api.casafari.com/market-analytics-api/distributions/prices
  • Auth: HTTP bearer

Request body

typesMarketAnalyticsApiExternalEstateTypeEnum[] required

The list of property types by type groups:<br/><strong>apartment: </strong>["apartment", "studio", "duplex", "penthouse", "dachgeschosswohnung", "etagenwohnung", "erdgeschosswohnung"]<br/><strong>house: </strong>["country_house", "house", "palace", "townhouse", "villa", "country_estate", "chalet", "bungalow", "family_house", "reihenhaus", "reihenendhaus", "reihenmittelhaus", "einfamilienhaus", "zweifamilienhaus", "landwirtschaftliche_betriebe"]<br/><strong>room: </strong>["room"]<br/><strong>building: </strong>["apartment_building", "office_building", "mix_use_building"]<br/><strong>investment: </strong>["retail", "office", "industrial", "warehouse", "hotel", "building", "other_commercial", "restaurant", "werkstatt"]<br/><strong>development: </strong>["apartment_development", "house_development"]<br/><strong>plot: </strong>["urban_plot", "rural_plot"]<br/><strong>other: </strong>["parking", "garage", "other"]<br/><br/><i>Note that you can select multiple types only from one property type group.</i><br><br><span style="color:red">The list of property types specific to certain countries</span>:<br/><strong>apartment:</strong><br/>○ dachgeschosswohnung: <strong>Germany</strong><br/>○ etagenwohnung: <strong>Germany</strong><br/>○ erdgeschosswohnung: <strong>Germany</strong><br/><strong>house:</strong><br/>○ family_house: <strong>Germany</strong><br/>○ reihenhaus: <strong>Germany</strong><br/>○ reihenendhaus: <strong>Germany</strong><br/>○ reihenmittelhaus: <strong>Germany</strong><br/>○ einfamilienhaus: <strong>Germany</strong><br/>○ zweifamilienhaus: <strong>Germany</strong><br/>○ landwirtschaftliche_betriebe: <strong>Germany</strong><br/><strong>investment:</strong><br/>○ restaurant: <strong>Germany</strong><br/>○ werkstatt: <strong>Germany</strong><br/><strong>plot:</strong><br/>○ urban_plot: <strong>Italy, Germany, Portugal, Spain, France</strong><br/>○ rural_plot: <strong>Italy, Germany, Portugal, Spain, France</strong>

business_type'sale' | 'rent' required
conditionsMarketAnalyticsApiExternalConditionEnum[]

Property conditions, as returned by the GET /api/v1/references/conditions endpoint.

privateboolean

Whether the property is listed by a private individual, as opposed to an agent or a professional.

bankboolean

Whether the property is owned by the bank.

auctionboolean

Whether the property is the subject of an auction.

exclude_outliersboolean

Exclude properties that are significantly underpriced or overpriced compared to similar properties.

Response

Successful Response

lower_boundinteger required

The lower price bound of the distribution unit.

upper_boundinteger nullable required

The upper price bound of the distribution unit.

properties_countinteger required

The number of properties that participated in the distribution.

is_meanboolean required

Indicates whether the mean value is within this distribution unit.

Changes

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