Skip to main content
POST
/
searches
curl --location 'https://api.stream.estate/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
number
Minimum number of bedrooms in the property.
​
bedroomMax
number
Maximum number of bedrooms in the property.
​
budgetMax
number
Maximum budget for the property.
​
budgetMin
number
Minimum budget for the property.
​
endpointRecipient
string
HTTPS webhook that receives match payloads whenever a property satisfies the search. Requires notificationEnabled=true. You can test your endpoint with our webhook simulator.
​
eventEndpoint
string
HTTPS webhook that receives advert event payloads (price changes, expirations, etc.) from the searches you subscribe to. Requires notificationEnabled=true and at least one entry in subscribedEvents. You can test your endpoint with our webhook simulator.
​
excludedCities
array
Cities to be excluded.
​
excludedSites
array
Source sites 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.
​
geoAccuracy
number
Filters properties by geocoding confidence level. Use 1 to keep only house-number level matches and 2 to include neighborhood-level approximations. Leave empty to allow both.
​
geoShapes
array
Filters properties within specified geographic areas. Example: geoShapes=geoShapes[0][0][0]=6.063201&geoShapes[0][0][1]=44.549092&geoShapes[0][1][0]=6.063201&geoShapes[0][1][1]=44.543009&geoShapes[0][2][0]=6.073453&geoShapes[0][2][1]=44.543293&geoShapes[0][3][0]=6.073453&geoShapes[0][3][1]=44.549092&geoShapes[0][4][0]=6.063201&geoShapes[0][4][1]=44.549092.
​
hidePropertyContact
boolean
Whether to hide property contact information or not.
​
includedCities
array
Included cities. Use locations to get the desired city ids.
​
includedDepartments
array
Included departments. Use locations to get the desired city ids.
​
includedSiteCategories
array
Included site categories.
​
includedSites
array
Source sites to be included.
​
includedZipcodes
array
Included zipcodes.
​
includedZipcodesInsee
array
Included INSEE codes (used to infer the cities associated with the search).
​
landSurfaceMax
number
Maximum land surface.
​
landSurfaceMin
number
Minimum land surface.
​
lat
number
Latitude of the center point used for radial filtering. Provide together with lon, otherwise this filter has no effect. Example: lat=48.864716
​
lon
number
Longitude of the center point used for radial filtering. Provide together with lat. Example: lon=2.349014
​
notificationEnabled
boolean
default:"false"
Enables delivery of matches and events either by webhook (endpointRecipient, eventEndpoint) or by email (notificationRecipient).
​
notificationRecipient
string
Email address that receives alert summaries when notificationEnabled=true. Use this as a fallback if you do not have a webhook yet.
​
pricePerMeterMax
number
Maximum price per meter.
​
pricePerMeterMin
number
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
number
Distance in kilometers around the provided lat/lon. Example: radius=20, radius=0.5
​
roomMin
number
Minimum number of rooms.
​
roomMax
number
Maximum number of rooms.
​
subscribedEvents
array
Event codes (e.g. property.ad.create, ad.update.price, ad.update.expired) you want to receive on the eventEndpoint. See the webhook simulator page for the full list.
​
surfaceMax
number
Maximum property surface area.
​
surfaceMin
number
Minimum property surface area.
​
title
string
required
Title of the created search.
​
transactionType
number
required
Type of transaction. Sell 0, Rent 1. Example: transactionType=0
​
withCoherentPrice
boolean
default:"true"
Excludes adverts whose price has been flagged as incoherent/outlier by our quality checks. Set to false to return every result regardless of price sanity.
​
withVirtualTour
boolean
Whether the property includes a virtual tour.
curl --location 'https://api.stream.estate/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
}