View as Markdown
Melo icon

Melo ACTION

Search Properties

Searches properties in Melo. See the documentation
  • Action
  • Read only
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Melo account once, then configure and run Search Properties from your backend or agent.

import { PipedreamClient } from "@pipedream/sdk"

const pd = new PipedreamClient({
  projectId: process.env.PIPEDREAM_PROJECT_ID!,
  clientId: process.env.PIPEDREAM_CLIENT_ID!,
  clientSecret: process.env.PIPEDREAM_CLIENT_SECRET!,
  projectEnvironment: "production",
})

const result = await pd.actions.run({
  id: "melo-search-properties",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    melo: { authProvisionId: "apn_xxxxxxx" },
    bedroomMax: 10,
    bedroomMin: 10,
  },
})

console.log(result)

SCHEMA

Inputs

Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.

Search Properties inputs
Property Type Description
bedroomMax Maximum Bedrooms integer
Maximum number of bedrooms in the property.
Optional
bedroomMin Minimum Bedrooms integer
Minimum number of bedrooms in the property.
Optional
budgetMax Maximum Budget integer
Maximum budget for the property.
Optional
budgetMin Minimum Budget integer
Minimum budget for the property.
Optional
condominiumFeesMax Maximum Condominium Fees integer
Maximum condominium fees for the property.
Optional
condominiumFeesMin Minimum Condominium Fees integer
Minimum condominium fees for the property.
Optional
constructionYearMax Maximum Construction Year integer
Maximum construction year of the property.
Optional
constructionYearMin Minimum Construction Year integer
Minimum construction year of the property.
Optional
energyCategories Energy Efficiency Categories string[]
The energy efficiency categories of the property.
Optional
energyValueMax Maximum Energy Value integer
Maximum energy value of the property.
Optional
energyValueMin Minimum Energy Value integer
Minimum energy value of the property.
Optional
eventPriceVariationFromCreatedAt Event Price Variation From Created At string
Date from which an event of type price is created — inclusive.
Optional
eventPriceVariationMax Maximum Event Price Variation integer
Maximum percent variation of an event of type price.
Optional
eventPriceVariationMin Minimum Event Price Variation integer
Minimum percent variation of an event of type price.
Optional
eventPriceVariationToCreatedAt Event Price Variation To Created At string
Date before which an event of type price is created — inclusive.
Optional
eventSurfaceVariationFromCreatedAt Event Surface Variation From Created At string
Date from which an event of type surface is created — inclusive.
Optional
eventSurfaceVariationMax Maximum Event Surface Variation integer
Maximum percent variation of an event of type surface.
Optional
eventSurfaceVariationMin Minimum Event Surface Variation integer
Minimum percent variation of an event of type surface.
Optional
eventSurfaceVariationToCreatedAt Event Surface Variation To Created At string
Date before which an event of type surface is created — inclusive.
Optional
excludedCities Excluded Cities string[]
Cities to be excluded.
Optional
excludedInseeCodes Excluded Insee Codes string[]
Insee codes to be excluded.
Optional
excludedProperties Excluded Properties string[]
Properties to be excluded.
Optional
excludedZipcodes Excluded Zipcodes string[]
Zipcodes to be excluded.
Optional
expired Expired boolean
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.
Optional
feesPercentageMax Maximum Fees Percentage integer
Maximum percentage of fees.
Optional
feesPercentageMin Minimum Fees Percentage integer
Minimum percentage of fees.
Optional
feesResponsibility Fees Responsibility string
Responsibility for fees. 0 for seller, 1 for buyer.
Optional
floorQuantityMax Maximum Floor Quantity integer
Maximum number of floors in the property.
Optional
floorQuantityMin Minimum Floor Quantity integer
Minimum number of floors in the property.
Optional
fromDate From Date string
Date from which the property is created — inclusive.
Optional
fromUpdatedAt From Updated At string
Date from which the property is updated — inclusive.
Optional
furnished Furnished boolean
Filter for furnished properties.
Optional
greenHouseGasCategories Green House Gas Categories string[]
Green house gas performance letter array of the property.
Optional
greenHouseGasValueMax Maximum Green House Gas Value integer
Maximum value of green house gas of the property.
Optional
greenHouseGasValueMin Minimum Green House Gas Value integer
Minimum value of green house gas of the property.
Optional
includedCities Included Cities string[]
Located in given cities.
Optional
includedDepartments Included Departments string[]
Located in given departments.
Optional
includedInseeCodes Included Insee Codes string[]
Located in given insee codes.
Optional
includedZipcodes Included Zipcodes string[]
Located in given zipcodes.
Optional
inventoryPriceMax Maximum Inventory Price integer
Lower than or equal to given inventory price.
Optional
inventoryPriceMin Minimum Inventory Price integer
Greater than or equal to given inventory price.
Optional
lat Latitude string
Latitude. Will work if latitude exists in the property.
Optional
lon Longitude string
Longitude. Will work if longitude exists in the property.
Optional
lotCountMax Maximum Lot Count integer
Lower than or equal to given lot count.
Optional
lotCountMin Minimum Lot Count integer
Greater than or equal to given lot count.
Optional
orderCreatedAt Order by Creation Date string
Order properties by creation date. Can be asc or desc.
Optional
orderUpdatedAt Order by Update Date string
Order properties by update date. Can be asc or desc.
Optional
priceExcludingFeesMax Maximum Price Excluding Fees integer
Lower than or equal to given price excluding fees.
Optional
priceExcludingFeesMin Minimum Price Excluding Fees integer
Greater than or equal to given price excluding fees.
Optional
pricePerMeterMax Maximum Price Per Meter integer
Lower than or equal to given price per meter.
Optional
pricePerMeterMin Minimum Price Per Meter integer
Greater than or equal to given price per meter.
Optional
propertyTypes Property Types string[]
Type of property. Apartment 0, House 1, Building 2, Parking 3, Office 4, Land 5, Shop 6.
Optional
publisherTypes Publisher Types string[]
Type of publisher. Individual 0, Professional 1.
Optional
radius Radius integer
Distance expressed in kilometers. Will work if latitude & longitude parameters are also set.
Optional
rentalChargesMax Maximum Rental Charges integer
Lower than or equal to given rental charges amount.
Optional
rentalChargesMin Minimum Rental Charges integer
Greater than or equal to given rental charges amount.
Optional
rentalPledgeMax Maximum Rental Pledge integer
Lower than or equal to given rental pledge amount.
Optional
rentalPledgeMin Minimum Rental Pledge integer
Greater than or equal to given rental pledge amount.
Optional
renterFeesMax Maximum Renter Fees integer
Lower than or equal to given renter fees.
Optional
renterFeesMin Minimum Renter Fees integer
Greater than or equal to given renter fees.
Optional
roomMax Maximum Rooms integer
Maximum rooms of the property.
Optional
roomMin Minimum Rooms integer
Minimum rooms of the property.
Optional
surfaceMax Surface Max integer
Lower than or equal to given surface.
Optional
surfaceMin Surface Min integer
Greater than or equal to given surface.
Optional
toDate To Date string
To datetime — inclusive.
Optional
toUpdatedAt To Updated At string
Since datetime — inclusive.
Optional
transactionType Transaction Type integer
Type of transaction. Sell 0, Rent 1.
Optional
withCoherentPrice With Coherent Price boolean
Filter properties with coherent price.
Optional
withVirtualTour With Virtual Tour boolean
Having a virtual tour video link.
Optional

REFERENCE

Tool details

Behavior hints are published with the component in the Pipedream registry and surface as MCP tool annotations, so an agent can reason about a tool before it calls it.

Registry key
melo-search-properties
Version
0.0.2
App
Melo
Authentication
API key
Read-only
Yes
Destructive
No
Open world
Yes