POST
/
searches
curl --location 'https://api.notif.immo/searches' \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: <api_key>' \
--data-raw '{
  "bedroomMin": 0,
  "budgetMax": 1500000,
  "budgetMin": 0,
  "endpointRecipient": "https://hook.eu1.make.com/xyz",
  "eventEndpoint": "https://hook.eu1.make.com/xyz",
  "lat": 48.864716,
  "lon": 2.349014,
  "notificationEnabled": true,
  "notificationRecipient": "foo@bar.com",
  "propertyTypes": [0, 1],
  "radius": 20,
  "subscribedEvents": [
    "property.ad.create"
  ],
  "surfaceMax": 0,
  "surfaceMin": 20,
  "transactionType": 0,
  "title": "mySearch"
}'
{
    "@context": "/contexts/Search",
    "@id": "/searches/xyz",
    "@type": "Search",
    "title": "mySearch",
    "user": "/users/xyz",
    "transactionType": 0,
    "budgetMax": 1500000,
    "budgetMin": 0,
    "bedroomMin": 0,
    "roomMin": null,
    "surfaceMin": 20,
    "surfaceMax": 0,
    "propertyTypes": [
        0,
        1
    ],
    "publisherTypes": [],
    "lastAlertAt": null,
    "token": "xyz",
    "pricePerMeterMin": null,
    "pricePerMeterMax": null,
    "createdAt": "2023-06-04T00:39:53+02:00",
    "updatedAt": "2023-06-04T00:39:53+02:00",
    "notificationEnabled": true,
    "includedCities": [],
    "includedDepartments": [],
    "excludedCities": [],
    "expressions": [],
    "notificationRecipient": "foo@bar.com",
    "furnished": null,
    "hidePropertyContact": false,
    "withVirtualTour": null,
    "withCoherentPrice": true,
    "landSurfaceMin": null,
    "landSurfaceMax": null,
    "includedSiteCategories": [],
    "excludedSiteCategories": [],
    "endpointRecipient": "https://hook.eu1.make.com/xyz",
    "eventEndpoint": "https://hook.eu1.make.com/xyz",
    "subscribedEvents": [
        "property.ad.create"
    ],
    "radius": 20,
    "lon": 2.349014,
    "lat": 48.864716
}

Body

bedroomMin
integer

Minimum number of bedrooms in the property.

bedroomMin
integer

Minimum number of bedrooms in the property.

budgetMax
number

Maximum budget for the property.

budgetMin
integer

Minimum budget for the property.

endpointRecipient
string

Endpoint webhook to receive new matches in real time. Https url is required. You can test your endpoint here using our webhhook simulator.

eventEndpoint
string

Endpoint webhook to receive adverts events in real time. Https url is required. You can test your endpoint using our webhhook simulator

excludedCities
array

Cities to be excluded.

excludedSiteCategories
array

Site categories to be excluded.

expressions
array

Full text matching including/excluding words & phrases in the title or the description of the property. Example: expressions[0][0][word]=travaux&expressions[0][0][options][includes]=true&expressions[0][0][options][strict]=false&expressions[0][1][word]=lumineux&expressions[0][1][options][includes]=true&expressions[0][1][options][strict]=false which will search for properties that contain both the keywords lumineux and travaux.

furnished
boolean

Whether the property is furnished or not.

hidePropertyContact
boolean

Whether to hide property contact information or not.

includedCities
array

Included cities.

includedDepartments
array

Included departments.

includedSiteCategories
array

Included site categories.

includedZipcodes
array

Included zipcodes.

landSurfaceMax
integer

Maximum land surface.

landSurfaceMin
integer

Minimum land surface.

lat
number

Latitude. Will work if latitude exists in the property. Example: lat=48.864716

lon
number

Longitude. Will work if latitude exists in the property. Example: lon=2.349014

notificationEnabled
boolean
default: "false"

Enable notifications which can be webhooks or emails.

pricePerMeterMax
integer

Maximum price per meter.

pricePerMeterMin
integer

Minimum price per meter.

propertyTypes
number[]
required

Type of property. Apartment 0, House 1, Building 2, Parking 3, Office 4, Land 5, Shop 6. Example: propertyTypes[]=0&propertyTypes[]=1

publisherTypes
array

Type of publisher. Individual 0, Professional 1. Example: publisherTypes[]=0&publisherTypes[]=1

radius
integer

Distance expressed in kilometers. Will work if latitude & longitude parameters are also set. Example: radius=20

roomMin
integer

Minimum number of rooms.

roomMax
integer

Maximum number of rooms.

subscribedEvents
array

Events you want to be alerted which will be sent to the eventEndpoint.

surfaceMax
integer

Maximum property surface area.

surfaceMin
integer

Minimum property surface area.

title
string
required

Title of the created search.

transactionType
integer
required

Type of transaction. Sell 0, Rent 1. Example: transactionType=0

withCoherentPrice
boolean
default: "true"

Having properties with coherent prices.

withVirtualTour
boolean

Whether the property includes a virtual tour.