Existing Casafari API · API v2 · Properties
Search properties
https://api.casafari.com/v2/properties/searchEnvíe Authorization: Token $CASAFARI_TOKEN con su token de API existente; consulte dónde obtenerlo.
The same path under /api, signed in with a bearer token, is in the REST API reference: POST /api/v2/properties/search.
Description
Search properties.
Parámetros de consulta
limitintegerorderstringasc descorder_bystringprice price_per_sqm total_area plot_area bedrooms construction_year last_update time_on_marketCuerpo de la solicitud
Content type application/json. Opcional. Tipo: object.
search_operationsstring[]obligatoriosale sold sale_hold rent rented rent_holdlocation_idsinteger[]custom_location_boundaryobject3 propiedades
polygonobject[]polygons field instead.2 propiedades
latitudenumberobligatoriolongitudenumberobligatoriocircleobject2 propiedades
distancenumbertarget_point solicitado hasta los inmuebles.target_pointobjectobligatorio3 propiedades
coordinatesobject2 propiedades
latitudenumberobligatoriolongitudenumberobligatorioaddressstringcadastral_referenceobject4 propiedades
country_codestringobligatorioEScadastral_referencestringobligatorioprovincestringmunicipalitystringpolygonsobject[][]2 propiedades
latitudenumberobligatoriolongitudenumberobligatorioconditionsstring[]used ruin very-good new otherproperty_date_fromcadena (fecha)YYYY-MM-DD) of the period for property of interest.property_date_tocadena (fecha)YYYY-MM-DD) of the period for property of interest.created_date_fromcadena (fecha y hora)YYYY-MM-DDTHH:mm:ss).created_date_tocadena (fecha y hora)YYYY-MM-DDTHH:mm:ss).updated_date_fromcadena (fecha y hora)YYYY-MM-DDTHH:mm:ss).updated_date_tocadena (fecha y hora)YYYY-MM-DDTHH:mm:ss).price_fromintegerprice_tointegerprice_per_sqm_fromintegerprice_per_sqm_tointegerbedrooms_fromintegerbedrooms_tointegerbathrooms_fromintegerbathrooms_tointegertotal_area_fromintegertotal_area_tointegerplot_area_fromintegerplot_area_tointegerconstruction_year_fromintegerconstruction_year_tointegerfloorstringfloors.no_floor ground middle topfloorsstring[]no_floor ground middle toporientationstringexterior interiorviewstringviews en su lugar.water landscape city golf parkviewsstring[]water landscape city golf parkdirectionstringdirections en su lugar.north south east westdirectionsstring[]north south east westcharacteristicsobject2 propiedades
must_havestring[]balcony elevator no_elevator garage garden parking storage swimming_pool terrace rental_license furniture rented_out life_annuityexcludestring[]balcony elevator no_elevator garage garden parking storage swimming_pool terrace rental_license furniture rented_out life_annuitytypesstring[]40 valores permitidos
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_buildingproperty_typesstring[]types field instead.40 valores permitidos
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_buildingprivatebooleanauctionbooleanbank filter is also set, the result will contain both auction and bank properties)bankbooleanauction filter is also set, the result will contain both bank and auction properties)casafari_connectbooleanlisting_agentsstring[]with_agenciesstring[]without_agenciesstring[]exclusivebooleanprivate, with_agencies, without_agencies.ref_numbersstring[]energy_certificatestringenergy_ratings en su lugar.Unknown A+ A B C D E F G Henergy_certificatesstring[]energy_ratings en su lugar.Unknown A+ A B C D E F G Henergy_ratingsstring[]Unknown A+ A B C D E F G Hdays_on_market_fromintegerdays_on_market_tointegergross_yield_fromnumbergross_yield_tonumberrooms_fromintegerrooms_tointegernumber_of_parkings_fromintegernumber_of_parkings_tointegerliving_area_fromintegerliving_area_tointegerfloor_numbersinteger[]Ejemplo de solicitud
Solo marcadores de posición: reemplace el token y los valores por los suyos.
curl -X POST "https://api.casafari.com/v2/properties/search" \
-H "Authorization: Token $CASAFARI_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"search_operations": [
"rented",
"rent"
],
"conditions": [
"used"
],
"location_ids": [
499
],
"custom_location_boundary": {
"circle": {
"distance": 30,
"target_point": {
"coordinates": {
"latitude": 38.71,
"longitude": -9.17
}
}
}
},
"price_from": 800,
"price_to": 10000,
"price_per_sqm_from": 5,
"price_per_sqm_to": 50,
"bedrooms_from": 1,
"bedrooms_to": 3,
"bathrooms_from": 1,
"bathrooms_to": 2,
"rooms_from": 1,
"rooms_to": 4,
"total_area_from": 30,
"total_area_to": 1000,
"living_area_from": 20,
"living_area_to": 800,
"floor_numbers": [
1,
2,
3
],
"views": [
"city"
],
"directions": [
"west",
"south"
],
"floors": [
"middle",
"top"
],
"energy_ratings": [
"A",
"B",
"C"
],
"casafari_connect": true
}'Respuestas
200
Tipo: object[].
Show the response shape (168 fields)
property_idintegerobligatorioprimary_listing_idintegerobligatoriotypestringobligatorio40 valores permitidos
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_buildingtype_groupstringobligatoriooperationsstring[]obligatoriosale rentlocationobjectobligatorio4 propiedades
location_idintegerobligatorionamestringobligatorioadministrative_levelstringobligatoriozip_codesstring[]locations_structureobject[]obligatorio4 propiedades
location_idintegerobligatorionamestringobligatorioadministrative_levelstringobligatoriozip_codesstring[]coordinatesobjectobligatorio2 propiedades
latitudenumberobligatoriolongitudenumberobligatoriototal_areaintegerobligatorioliving_areaintegerobligatorioplot_areaintegerobligatorioterrace_areaintegerobligatoriobathroomsintegerobligatoriobedroomsintegerobligatorioroomsintegerobligatorionumber_of_parkingsintegernullablefloor_numberintegerobligatoriorent_currencystringobligatoriorent_periodstringobligatorioday week fortnight month year nonerent_priceintegerobligatoriorent_currency).rent_statusstringobligatorioactive reserved hold rented nonesale_currencystringobligatoriosale_priceintegerobligatoriosale_currency).sale_statusstringobligatorioactive reserved hold sold noneis_private_propertybooleanobligatoriofeaturesobjectobligatorio7 propiedades
floorstringobligatoriono_floor ground middle toporientationstringobligatorioexterior interiorviewstringobligatorioviews en su lugar.water landscape city golf parkviewsstring[]obligatoriowater landscape city golf parkdirectionstringobligatoriodirections en su lugar.north south east westdirectionsstring[]obligatorionorth south east westcharacteristicsstring[]obligatoriobalcony elevator no_elevator garage garden parking storage swimming_pool terrace rental_license furniture rented_out life_annuityconditionstringobligatorioused ruin very-good new othersale_time_on_marketobjectobligatorio4 propiedades
date_startcadena (fecha)obligatoriodate_endcadena (fecha)obligatoriodays_on_marketintegerobligatoriohas_untracked_periodbooleanobligatoriorent_time_on_marketobjectobligatorio4 propiedades
date_startcadena (fecha)obligatoriodate_endcadena (fecha)obligatoriodays_on_marketintegerobligatoriohas_untracked_periodbooleanobligatoriolistingsobject[]obligatorio36 properties
listing_idintegerobligatoriototal_areaintegerobligatorioplot_areaintegerobligatorioterrace_areaintegerobligatoriobedroomsintegerobligatoriobathroomsintegerobligatorioroomsintegerobligatoriosale_statusstringobligatorioactive reserved hold sold nonesale_currencystringobligatoriosale_priceintegerobligatoriosale_currency).sale_price_baseintegerobligatoriorent_statusstringobligatorioactive reserved hold rented nonerent_currencystringobligatoriorent_priceintegerobligatoriorent_currency).rent_price_baseintegerobligatorioagency_legal_idstringobligatorioagencystringobligatoriolisting_urlstringnullablelisting_old_urlstringnullabledescriptionstringobligatoriolisting_uidstringobligatorioconstruction_yearintegerobligatoriosource_namestringobligatoriocontacts_infoobjectobligatorio3 propiedades
namestringobligatorioemailcadena (correo electrónico)obligatoriophonestringobligatorioenergy_certificatestringobligatorioenergy_rating en su lugar.energy_ratingstringobligatorioheating_typestringobligatorioceiling_labelstringobligatoriocommissionnumberobligatoriomin_rent_areaintegerobligatoriocompaniesobject[]obligatorio2 propiedades
namestringobligatoriocasafari_connect_onbooleanobligatoriocreated_atcadena (fecha)obligatoriofloor_numberintegerobligatoriois_privatebooleanobligatoriocasafari_connectbooleanobligatoriothumbnailsstring[]historyobject[]sale_price_history and rent_price_history.5 propiedades
sale_priceintegerobligatoriosale_currency).sale_currencystringobligatoriorent_priceintegerobligatoriorent_currency).rent_currencystringobligatoriochanged_atcadena (fecha)obligatoriosale_price_historyobject[]4 propiedades
date_startcadena (fecha)obligatoriodate_endcadena (fecha)obligatoriosale_price_oldintegerobligatoriosale_price_newintegerobligatoriorent_price_historyobject[]4 propiedades
date_startcadena (fecha)obligatoriodate_endcadena (fecha)obligatoriorent_price_oldintegerobligatoriorent_price_newintegerobligatoriosale_status_historyobject[]4 propiedades
date_startcadena (fecha)obligatoriodate_endcadena (fecha)obligatoriosale_status_oldstringobligatoriosale_status_newstringobligatoriorent_status_historyobject[]4 propiedades
date_startcadena (fecha)obligatoriodate_endcadena (fecha)obligatoriorent_status_oldstringobligatoriorent_status_newstringobligatorioproperty_urlstringnullableaddressstringobligatoriozip_codestringobligatoriodistancenumbernullablecustom_location_boundary.circle está definido en la solicitud.descriptionstringobligatorioconstruction_yearintegerobligatoriorent_price_baseintegerobligatoriorent_price_per_sqmnumberobligatoriorent_currency).rent_price_per_sqm_basenumberobligatoriosale_price_baseintegerobligatoriosale_price_per_sqmnumberobligatoriosale_currency).sale_price_per_sqm_basenumberobligatoriois_auction_propertybooleanobligatoriois_bank_propertybooleanobligatoriochanged_atcadena (fecha)obligatoriosale_price_last_changeobjectobligatorio3 propiedades
change_datecadena (fecha)obligatorioold_valueintegerobligatorionew_valueintegerobligatoriorent_price_last_changeobjectobligatorio3 propiedades
change_datecadena (fecha)obligatorioold_valueintegerobligatorionew_valueintegerobligatoriothumbnailsstring[]picturesstring[]gross_yieldnumberobligatoriotitlestringobligatorioenergy_certificatestringobligatorioenergy_rating en su lugar.energy_ratingstringobligatorioceiling_labelstringobligatoriomin_rent_areaintegerobligatorioref_numbersstring[]casafari_connectbooleanobligatoriosource_floor_numbersinteger[]retail_dataobjectnullable6 inmuebles
facade_measurementsobjectobligatorio3 propiedades
heightnumberobligatoriolengthnumberobligatoriosurfacenumberobligatoriotransfer_price_rangeobjectobligatorio2 propiedades
gteintegerobligatoriolteintegerobligatoriois_street_levelbooleanobligatorionumber_of_floorsintegerobligatorionumber_of_premisesintegerobligatoriopossible_business_typesstring[]obligatorio400 Solicitud incorrecta
Tipo: object.
Mostrar la estructura de la respuesta (1 campo)
errorsobject401 No autorizado
Tipo: object.
Mostrar la estructura de la respuesta (1 campo)
detailstring403 Prohibido
Tipo: object.
Mostrar la estructura de la respuesta (1 campo)
detailstring