api---properties

Search properties (v2)

Search properties.

post/api/v2/properties/search

Request

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

Query parameters

limitinteger

Number of results to return per page.

order'asc' | 'desc'

The order of search results.

order_by'price' | 'price_per_sqm' | 'total_area' | 'plot_area' | 'bedrooms' | 'construction_year' | 'last_update' | 'time_on_market'

The field by which to sort the results.

Request body

search_operationsstring[] required

Search business types for which the property is available.

location_idsinteger[]

List of location IDs, as returned by the POST /api/v1/references/locations endpoint.

conditionsstring[]

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

property_date_fromstring date

Start date (in the format YYYY-MM-DD) of the period for property of interest.

property_date_tostring date

End date (in the format YYYY-MM-DD) of the period for property of interest.

created_date_fromstring date-time

Created date from (in the format YYYY-MM-DDTHH:mm:ss).

created_date_tostring date-time

Created date to (in the format YYYY-MM-DDTHH:mm:ss).

updated_date_fromstring date-time

Updated date from (in the format YYYY-MM-DDTHH:mm:ss).

updated_date_tostring date-time

Updated date to (in the format YYYY-MM-DDTHH:mm:ss).

price_frominteger

Minimum price value.

price_tointeger

Maximum price value.

price_per_sqm_frominteger

Minimum value for price per square meter.

price_per_sqm_tointeger

Maximum value for price per square meter.

bedrooms_frominteger

Minimum number of bedrooms.

bedrooms_tointeger

Maximum number of bedrooms.

bathrooms_frominteger

Minimum number of bathrooms.

bathrooms_tointeger

Maximum number of bathrooms.

total_area_frominteger

Minimum total area.

total_area_tointeger

Maximum total area.

plot_area_frominteger

Minimum plot area.

plot_area_tointeger

Maximum plot area.

construction_year_frominteger

Minimum construction year.

construction_year_tointeger

Maximum construction year.

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.

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.

typesstring[]

<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

property_typesstring[]

Property types, 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 types field instead.</strong>

privateboolean

Whether to return properties listed by a private individual, as opposed to an agent or a professional.

auctionboolean

Whether to return auction properties. (If the bank filter is also set, the result will contain both auction and bank properties)

bankboolean

Whether to return bank properties. (If the auction filter is also set, the result will contain both bank and auction properties)

casafari_connectboolean

Whether to return properties that have at least one listing with a company connected to Casafari Connect.

listing_agentsstring[]

Return properties from specified agents. To find allowed agent names use the GET /api/v1/references/agents endpoint.

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.

exclusiveboolean

Whether to return properties that are available on market exclusively from a single agency or private individual.<br/>Can be passed only along with at least one of the fields: private, with_agencies, without_agencies.

ref_numbersstring[]

List of reference numbers from listings.

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.

gross_yield_fromnumber

Minimum gross yield value.

gross_yield_tonumber

Maximum gross yield value.

rooms_frominteger

Minimum number of rooms.

rooms_tointeger

Maximum number of rooms.

number_of_parkings_frominteger

Minimum number of parking spaces.

number_of_parkings_tointeger

Maximum number of parking spaces.

living_area_frominteger

Minimum living area.

living_area_tointeger

Maximum living area.

floor_numbersinteger[]

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

Response

property_idinteger required

ID of the property.

primary_listing_idinteger required

Primary listing (ad) ID of the property which is defined after the matching into 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' required

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

type_groupstring required

Property type group, as returned by the GET /api/v1/references/types endpoint.

operationsstring[] required

Operation types for which property is available.

total_areainteger required

Total area.

living_areainteger required

Living area.

plot_areainteger required

Plot area.

terrace_areainteger required

Terrace area.

bathroomsinteger required

Number of bathrooms.

bedroomsinteger nullable required

Number of bedrooms.

roomsinteger required

Number of rooms.

number_of_parkingsinteger nullable

Number of parking spaces.

floor_numberinteger nullable required

Exact floor number. Negative values indicate underground floors (e.g. basements).

rent_currencystring required

Rent price currency code.

rent_period'day' | 'week' | 'fortnight' | 'month' | 'year' | 'none' required

Rent period.

rent_priceinteger required

Current rent price, in the currency of the listings (specified by the rent_currency field).

rent_status'active' | 'reserved' | 'hold' | 'rented' | 'none' required

Current rent status of the property.

sale_currencystring required

Sale price currency code.

sale_priceinteger required

Current sale price, in the currency of the listings (specified by the sale_currency field).

sale_status'active' | 'reserved' | 'hold' | 'sold' | 'none' required

Current sale status of the property.

is_private_propertyboolean required

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

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

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

property_urlstring nullable

URL of the property in the CASAFARI website.

addressstring required

Property address.

zip_codestring nullable required

The location zip code.

distancenumber nullable

Distance in kilometers from target point to the property.Available only when the custom_location_boundary.circle field is defined in the request.

descriptionstring required

Property description.

construction_yearinteger required

Construction year.

rent_price_baseinteger required

Current rent price, in Euros.

rent_price_per_sqmnumber required

Current rent price per square meter, in the currency of the listings (specified by the rent_currency field).

rent_price_per_sqm_basenumber required

Current rent price per square meter, in Euros.

sale_price_baseinteger required

Current sale price, in Euros.

sale_price_per_sqmnumber required

Current sale price per square meter, in the currency of the listings (specified by the sale_currency field).

sale_price_per_sqm_basenumber required

Current sale price per square meter, in Euros.

is_auction_propertyboolean required

Whether the property is an auction property.

is_bank_propertyboolean required

Whether the property is a bank property.

changed_atstring date required

The date and time when the property was last updated.

thumbnailsstring[]

List of the thumbnail image URLs.

picturesstring[]

List of the original picture image URLs.

gross_yieldnumber required

Gross yield in percentage.

titlestring required

Property title.

energy_certificatestring required

Energy certificate classification that attests to the energy efficiency of a property. <br/><strong>This field is deprecated and will be removed in the next major update.</strong><br/><strong>Please, use energy_rating field instead.</strong>

energy_ratingstring required

Energy rating that attests to the energy efficiency of a property.

ceiling_labelstring nullable required

Ceiling height in meters.<br><span style="color:red">Available only for Germany.</span>

min_rent_areainteger nullable required

Minimum rental area in square meters (mainly applicable to commercial properties).<br><span style="color:red">Available only for Germany.</span>

ref_numbersstring[]

List of reference numbers from listings.

casafari_connectboolean nullable required

Whether the company is connected to Casafari Connect.

source_floor_numbersinteger[]

List of property floor numbers based on listings data. Negative values indicate underground floors (e.g. basements).

Changes

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