api---comparables

Search comparables (v2)

Returns comparable properties by the given parameters.

post/api/v2/comparables/search

Request

  • Base URL: https://api.casafari.com
  • URL: https://api.casafari.com/api/v2/comparables/search
  • Auth: HTTP bearer

Request body

comparables_countinteger required

Maximum number of comparable properties in results.

distancenumber

Maximum distance in kilometers from the requested target_point to comparable properties.<br/><strong>This field is deprecated and will be removed in the next major update.</strong><br/><strong>Please, use location_boundary.circle field instead.</strong>

sold_or_rented_afterstring date nullable

Properties sold/rented since this date (in the format YYYY-MM-DD) will be considered as possible comparables. Default value: 9 months ago, counting from today. If null is passed, only active properties will be considered.

operation'sale' | 'rent' required

Operation type.

business_type'sale' | 'rent'

Operation type.<br/><strong>This field is deprecated and will be removed in the next major update.</strong><br/><strong>Please, use operation field instead.</strong>

comparables_type'apartment' | 'studio' | 'duplex' | 'penthouse' | 'dachgeschosswohnung' | 'etagenwohnung' | 'erdgeschosswohnung' | 'country_house' | 'house' | 'palace' | 'townhouse' | 'villa' | 'country_estate' | 'chalet' | 'bungalow' | 'family_house' | 'reihenhaus' | 'reihenendhaus' | 'reihenmittelhaus' | 'einfamilienhaus' | 'zweifamilienhaus' | 'landwirtschaftliche_betriebe' | 'retail' | 'office' | 'industrial' | 'warehouse' | 'hotel' | 'other_commercial' | 'restaurant' | 'werkstatt' | 'plot' | 'urban_plot' | 'rural_plot' | 'room' | 'other' | 'garage' | 'parking' | 'apartment_building' | 'office_building' | 'mix_use_building'

Comparables property type, as returned by the GET /api/v1/references/types endpoint.<br/><strong>This field is deprecated and will be removed in the next major update.</strong><br/><strong>Please, use comparables_types field instead.</strong>

comparables_typesstring[] required

<br>Country availability per type is available at the GET /api/v1/references/types endpoint.<br><br>Property types by type groups:<br/><strong>apartment:</strong> penthouse, apartment, dachgeschosswohnung, erdgeschosswohnung, duplex, etagenwohnung, studio<br/><strong>house:</strong> einfamilienhaus, family_house (<span style="color:red">DEPRECATED</span>), reihenmittelhaus, house, villa, country_house, zweifamilienhaus, landwirtschaftliche_betriebe, palace, bungalow, townhouse, reihenhaus, chalet, country_estate, reihenendhaus<br/><strong>room:</strong> room<br/><strong>building:</strong> mix_use_building, office_building, apartment_building<br/><strong>investment:</strong> other_commercial, warehouse, office, retail, hotel, werkstatt, industrial, restaurant<br/><strong>plot:</strong> urban_plot, plot (<span style="color:red">DEPRECATED</span>), rural_plot<br/><strong>other:</strong> garage, other, parking<br/><br/><i><span style="color:red">Note that you can select multiple types only from one property type group.</span></i>

property_type'apartment' | 'studio' | 'duplex' | 'penthouse' | 'dachgeschosswohnung' | 'etagenwohnung' | 'erdgeschosswohnung' | 'country_house' | 'house' | 'palace' | 'townhouse' | 'villa' | 'country_estate' | 'chalet' | 'bungalow' | 'family_house' | 'reihenhaus' | 'reihenendhaus' | 'reihenmittelhaus' | 'einfamilienhaus' | 'zweifamilienhaus' | 'landwirtschaftliche_betriebe' | 'retail' | 'office' | 'industrial' | 'warehouse' | 'hotel' | 'other_commercial' | 'restaurant' | 'werkstatt' | 'plot' | 'urban_plot' | 'rural_plot' | 'room' | 'other' | 'garage' | 'parking' | 'apartment_building' | 'office_building' | 'mix_use_building'

Comparables property type, as returned by the GET /api/v1/references/types endpoint.<br/><strong>This field is deprecated and will be removed in the next major update.</strong><br/><strong>Please, use comparables_types field instead.</strong>

min_priceinteger

The minimum price filter for comparables result.

max_priceinteger

The maximum price filter for comparables result.

condition'used' | 'ruin' | 'very-good' | 'new' | 'other'

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

bedroomsinteger

Number of bedrooms (cannot be used together with rooms).

roomsinteger

Number of rooms (cannot be used together with bedrooms).

bathroomsinteger

Number of bathrooms.

construction_yearinteger

Desired construction year.

total_areainteger

Desired total area, square meters. This field is required for hotel, industrial, office, other_commercial, restaurant, retail, warehouse, werkstatt property types if target_point.cadastral_reference is not provided.

plot_areainteger

Desired plot area, square meters. This field is required for rural_plot and urban_plot property types if target_point.cadastral_reference is not provided.

floor'no_floor' | 'ground' | 'middle' | 'top'

Floor type. <br/><strong>This field is deprecated and will be removed in the next major update.</strong><br/><strong>Please, use floors field instead.</strong>

floorsstring[]

List of floor types.

floor_numberinteger[]

Desired list of floor numbers. Negative values indicate underground floors (e.g. basements).<br>Minimum value is -250.<br>Maximum value is 250.

orientation'exterior' | 'interior'

Property view orientation.

view'water' | 'landscape' | 'city' | 'golf' | 'park'

View from the property. <br/><strong>This field is deprecated and will be removed in the next major update.</strong><br/><strong>Please, use views field instead.</strong>

viewsstring[]

List of views from the property.

direction'north' | 'south' | 'east' | 'west'

Cardinal direction the property faces. <br/><strong>This field is deprecated and will be removed in the next major update.</strong><br/><strong>Please, use directions field instead.</strong>

directionsstring[]

List of cardinal directions the property faces.

energy_certificate'Unknown' | 'A+' | 'A' | 'B' | 'C' | 'D' | 'E' | 'F' | 'G' | 'H'

Energy certificate. <br/><strong>This field is deprecated and will be removed in the next major update.</strong><br/><strong>Please, use energy_ratings field instead.</strong>

energy_certificatesstring[]

List of energy certificates. <br/><strong>This field is deprecated and will be removed in the next major update.</strong><br/><strong>Please, use energy_ratings field instead.</strong>

energy_ratingsstring[]

List of energy ratings.

days_on_market_frominteger

Minimum days on market value.

days_on_market_tointeger

Maximum days on market value.

with_agenciesstring[]

Return properties from specified agencies, companies or sources. To find allowed agency names use the GET /api/v1/references/agencies endpoint.

without_agenciesstring[]

Exclude properties from specified agencies, companies or sources. To find allowed agency names use the GET /api/v1/references/agencies endpoint.

exclude_outliersboolean

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

Response

casafari_linkstring uri nullable required

Link to Comparative Market Analysis page.

valuation_idinteger nullable

Persistent valuation ID used to generate Smart Link or a PDF. Expires in a year.

Changes

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