api---properties

Search properties (v1)

Search properties.

post/api/v1/properties/search

Request

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

Query parameters

limitinteger

Number of results to return per page.

offsetinteger

The initial index from which to return the results.

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, dachgeschosswohnung, erdgeschosswohnung, apartment, etagenwohnung, studio, duplex<br/><strong>house:</strong> townhouse, reihenmittelhaus, landwirtschaftliche_betriebe, country_house, family_house (<span style="color:red">DEPRECATED</span>), villa, palace, chalet, zweifamilienhaus, country_estate, reihenendhaus, reihenhaus, bungalow, einfamilienhaus, house<br/><strong>room:</strong> room<br/><strong>building:</strong> office_building, apartment_building, mix_use_building<br/><strong>investment:</strong> retail, hotel, warehouse, office, restaurant, industrial, other_commercial, werkstatt<br/><strong>plot:</strong> rural_plot, urban_plot, plot (<span style="color:red">DEPRECATED</span>)<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

countinteger
nextstring uri nullable
previousstring uri nullable

Example response

[
  {
    "count": 123,
    "next": "http://api.example.org/accounts/?offset=400&limit=100",
    "previous": "http://api.example.org/accounts/?offset=200&limit=100"
  }
]

Changes

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