MeloMelo / Search Properties

appKey: melo
actionKey: search-properties

Action Inputs

The following parameters are available when configuring this action:
bedroomMax
Bedroom Max
Maximum number of bedrooms in the property.
string | undefined
bedroomMin
Bedroom Min
Minimum number of bedrooms in the property.
string | undefined
budgetMax
Budget Max
Maximum budget for the property.
string | undefined
budgetMin
Budget Min
Minimum budget for the property.
string | undefined
condominiumFeesMax
Condominium Fees Max
Maximum condominium fees for the property.
string | undefined
condominiumFeesMin
Condominium Fees Min
Minimum condominium fees for the property.
string | undefined
constructionYearMax
Construction Year Max
Maximum construction year of the property.
string | undefined
constructionYearMin
Construction Year Min
Minimum construction year of the property.
string | undefined
energyCategories
Energy Categories
(string | Array<string>) | undefined
energyValueMax
Energy Value Max
Maximum energy value of the property.
string | undefined
energyValueMin
Energy Value Min
Minimum energy value of the property.
string | undefined
eventPriceVariationFromCreatedAt
Event Price Variation From Created At
Date from which an event of type price is created β€” inclusive.
string | undefined
eventPriceVariationMax
Event Price Variation Max
Maximum percent variation of an event of type price.
string | undefined
eventPriceVariationMin
Event Price Variation Min
Minimum percent variation of an event of type price.
string | undefined
eventPriceVariationToCreatedAt
Event Price Variation To Created At
Date before which an event of type price is created β€” inclusive.
string | undefined
eventSurfaceVariationFromCreatedAt
Event Surface Variation From Created At
Date from which an event of type surface is created β€” inclusive.
string | undefined
eventSurfaceVariationMax
Event Surface Variation Max
Maximum percent variation of an event of type surface.
string | undefined
eventSurfaceVariationMin
Event Surface Variation Min
Minimum percent variation of an event of type surface.
string | undefined
eventSurfaceVariationToCreatedAt
Event Surface Variation To Created At
Date before which an event of type surface is created β€” inclusive.
string | undefined
excludedCities
Excluded Cities
Cities to be excluded.
string | undefined
excludedInseeCodes
Excluded Insee Codes
Insee codes to be excluded.
string | undefined
excludedProperties
Excluded Properties
Properties to be excluded.
string | undefined
excludedZipcodes
Excluded Zipcodes
Zipcodes to be excluded.
string | undefined
expired
Expired
Whether to show properties that are expired. A property is considered expired when all its adverts are expired. Can be `true`, `false` or `null`. Default is `null` which returns all properties no matter if they’re expired or not.
boolean | undefined
feesPercentageMax
Fees Percentage Max
Maximum percentage of fees.
string | undefined
feesPercentageMin
Fees Percentage Min
Minimum percentage of fees.
string | undefined
feesResponsibility
Fees Responsibility
Responsibility for fees. 0 for seller, 1 for buyer.
string | undefined
floorQuantityMax
Floor Quantity Max
Maximum number of floors in the property.
string | undefined
floorQuantityMin
Floor Quantity Min
Minimum number of floors in the property.
string | undefined
fromDate
From Date
Date from which the property is created β€” inclusive.
string | undefined
fromUpdatedAt
From Updated At
Date from which the property is updated β€” inclusive.
string | undefined
furnished
Furnished
Filter for furnished properties.
boolean | undefined
greenHouseGasCategories
Green House Gas Categories
(string | Array<string>) | undefined
greenHouseGasValueMax
Green House Gas Value Max
Maximum value of green house gas of the property.
string | undefined
greenHouseGasValueMin
Green House Gas Value Min
Minimum value of green house gas of the property.
string | undefined
includedCities
Included Cities
Located in given cities.
string | undefined
includedDepartments
Included Departments
Located in given departments.
string | undefined
includedInseeCodes
Included Insee Codes
Located in given insee codes.
string | undefined
includedZipcodes
Included Zipcodes
Located in given zipcodes.
string | undefined
inventoryPriceMax
Inventory Price Max
Lower than or equal to given inventory price.
string | undefined
inventoryPriceMin
Inventory Price Min
Greater than or equal to given inventory price.
string | undefined
lat
Lat
Latitude. Will work if latitude exists in the property.
string | undefined
lon
Lon
Longitude. Will work if longitude exists in the property.
string | undefined
lotCountMax
Lot Count Max
Lower than or equal to given lot count.
string | undefined
lotCountMin
Lot Count Min
Greater than or equal to given lot count.
string | undefined
orderCreatedAt
Order Created At
Order properties by creation date. Can be asc or desc.
string | undefined
orderUpdatedAt
Order Updated At
Order properties by update date. Can be asc or desc.
string | undefined
priceExcludingFeesMax
Price Excluding Fees Max
Lower than or equal to given price excluding fees.
string | undefined
priceExcludingFeesMin
Price Excluding Fees Min
Greater than or equal to given price excluding fees.
string | undefined
pricePerMeterMax
Price Per Meter Max
Lower than or equal to given price per meter.
string | undefined
pricePerMeterMin
Price Per Meter Min
Greater than or equal to given price per meter.
string | undefined
propertyTypes
Property Types
(string | Array<string>) | undefined
publisherTypes
Publisher Types
(string | Array<string>) | undefined
radius
Radius
Distance expressed in kilometers. Will work if latitude & longitude parameters are also set.
string | undefined
rentalChargesMax
Rental Charges Max
Lower than or equal to given rental charges amount.
string | undefined
rentalChargesMin
Rental Charges Min
Greater than or equal to given rental charges amount.
string | undefined
rentalPledgeMax
Rental Pledge Max
Lower than or equal to given rental pledge amount.
string | undefined
rentalPledgeMin
Rental Pledge Min
Greater than or equal to given rental pledge amount.
string | undefined
renterFeesMax
Renter Fees Max
Lower than or equal to given renter fees.
string | undefined
renterFeesMin
Renter Fees Min
Greater than or equal to given renter fees.
string | undefined
roomMax
Room Max
Maximum rooms of the property.
string | undefined
roomMin
Room Min
Minimum rooms of the property.
string | undefined
surfaceMax
Surface Max
Lower than or equal to given surface.
string | undefined
surfaceMin
Surface Min
Greater than or equal to given surface.
string | undefined
toDate
To Date
To datetime β€” inclusive.
string | undefined
toUpdatedAt
To Updated At
Since datetime β€” inclusive.
string | undefined
transactionType
Transaction Type
Type of transaction. Sell 0, Rent 1.
string | undefined
withCoherentPrice
With Coherent Price
Filter properties with coherent price.
boolean | undefined
withVirtualTour
With Virtual Tour
Having a virtual tour video link.
boolean | undefined