Skip to main content
PUT
/
searches
/
{id}
curl --location --request POST 'https://api.stream.estate/searches/{id}' \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: <api_key>' \
--data-raw '{
  "bedroomMin": 0,
  "budgetMax": 0,
  "budgetMin": 0,
  "endpointRecipient": "https://www.mycompany.com/webhook_melo_match",
  "eventEndpoint": "https://www.mycompany.com/webhook_melo_updates",
  "excludedCities": [
    "string"
  ],
  "excludedSiteCategories": [
    "string"
  ],
  "expressions": "expressions[0][0][options][includes]=true&expressions[0][0][options][strict]=true&expressions[1][0][word]=viager&expressions[1][0][options][includes]=true&expressions[1][0][options][strict]=true",
  "furnished": true,
  "hidePropertyContact": true,
  "includedCities": [
    "string"
  ],
  "includedDepartments": [
    "string"
  ],
  "includedSiteCategories": [
    "string"
  ],
  "landSurfaceMax": 0,
  "landSurfaceMin": 0,
  "lat": "48.864716",
  "lon": "2.349014",
  "notificationEnabled": false,
  "notificationRecipient": "foo@bar.com",
  "pricePerMeterMax": 0,
  "pricePerMeterMin": 0,
  "propertyTypes": 3,
  "publisherTypes": 3,
  "radius": "20",
  "roomMin": 0,
  "subscribedEvents": [
    "ad.update.price"
  ],
  "surfaceMax": 0,
  "surfaceMin": 0,
  "title": "string",
  "transactionType": "0",
  "withCoherentPrice": true,
  "withVirtualTour": true
}'

{
  "bedroomMin": 0,
  "budgetMax": 0,
  "budgetMin": 0,
  "endpointRecipient": "https://www.mycompany.com/webhook_melo_match",
  "eventEndpoint": "https://www.mycompany.com/webhook_melo_updates",
  "excludedCities": [
    "string"
  ],
  "excludedSiteCategories": [
    "string"
  ],
  "expressions": "expressions[0][0][options][includes]=true&expressions[0][0][options][strict]=true&expressions[1][0][word]=viager&expressions[1][0][options][includes]=true&expressions[1][0][options][strict]=true",
  "furnished": true,
  "hidePropertyContact": true,
  "includedCities": [
    "string"
  ],
  "includedDepartments": [
    "string"
  ],
  "includedSiteCategories": [
    "string"
  ],
  "landSurfaceMax": 0,
  "landSurfaceMin": 0,
  "lat": "48.864716",
  "lon": "2.349014",
  "notificationEnabled": false,
  "notificationRecipient": "foo@bar.com",
  "pricePerMeterMax": 0,
  "pricePerMeterMin": 0,
  "propertyTypes": 3,
  "publisherTypes": 3,
  "radius": "20",
  "roomMin": 0,
  "subscribedEvents": [
    "ad.update.price"
  ],
  "surfaceMax": 0,
  "surfaceMin": 0,
  "title": "string",
  "transactionType": "0",
  "withCoherentPrice": true,
  "withVirtualTour": true
}

Documentation Index

Fetch the complete documentation index at: https://docs.stream.estate/llms.txt

Use this file to discover all available pages before exploring further.

​
Path

​
id
string
required
UUID of the existing search

​
Body

​
bedroomMin
integer
Minimum number of bedrooms in the property.
​
bedroomMax
integer
Maximum number of bedrooms in the property.
​
budgetMax
integer
Maximum budget for the property.
​
budgetMin
integer
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
array
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[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.
​
includedDepartments
array
Included departments.
​
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
integer
Maximum land surface.
​
landSurfaceMin
integer
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
integer
Maximum price per meter.
​
pricePerMeterMin
integer
Minimum price per meter.
​
propertyTypes
integer
required
Type of property. Apartment 0, House 1, Building 2, Parking 3, Office 4, Land 5, Shop 6. Example: propertyTypes[]=0&propertyTypes[]=1
​
publisherTypes
integer
Type of publisher. Individual 0, Professional 1. Example: publisherTypes[]=0&publisherTypes[]=1
​
radius
integer
Distance in kilometers around the provided lat/lon. Example: radius=20
​
roomMin
integer
Minimum number of rooms.
​
roomMax
integer
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
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"
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 --request POST 'https://api.stream.estate/searches/{id}' \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: <api_key>' \
--data-raw '{
  "bedroomMin": 0,
  "budgetMax": 0,
  "budgetMin": 0,
  "endpointRecipient": "https://www.mycompany.com/webhook_melo_match",
  "eventEndpoint": "https://www.mycompany.com/webhook_melo_updates",
  "excludedCities": [
    "string"
  ],
  "excludedSiteCategories": [
    "string"
  ],
  "expressions": "expressions[0][0][options][includes]=true&expressions[0][0][options][strict]=true&expressions[1][0][word]=viager&expressions[1][0][options][includes]=true&expressions[1][0][options][strict]=true",
  "furnished": true,
  "hidePropertyContact": true,
  "includedCities": [
    "string"
  ],
  "includedDepartments": [
    "string"
  ],
  "includedSiteCategories": [
    "string"
  ],
  "landSurfaceMax": 0,
  "landSurfaceMin": 0,
  "lat": "48.864716",
  "lon": "2.349014",
  "notificationEnabled": false,
  "notificationRecipient": "foo@bar.com",
  "pricePerMeterMax": 0,
  "pricePerMeterMin": 0,
  "propertyTypes": 3,
  "publisherTypes": 3,
  "radius": "20",
  "roomMin": 0,
  "subscribedEvents": [
    "ad.update.price"
  ],
  "surfaceMax": 0,
  "surfaceMin": 0,
  "title": "string",
  "transactionType": "0",
  "withCoherentPrice": true,
  "withVirtualTour": true
}'

{
  "bedroomMin": 0,
  "budgetMax": 0,
  "budgetMin": 0,
  "endpointRecipient": "https://www.mycompany.com/webhook_melo_match",
  "eventEndpoint": "https://www.mycompany.com/webhook_melo_updates",
  "excludedCities": [
    "string"
  ],
  "excludedSiteCategories": [
    "string"
  ],
  "expressions": "expressions[0][0][options][includes]=true&expressions[0][0][options][strict]=true&expressions[1][0][word]=viager&expressions[1][0][options][includes]=true&expressions[1][0][options][strict]=true",
  "furnished": true,
  "hidePropertyContact": true,
  "includedCities": [
    "string"
  ],
  "includedDepartments": [
    "string"
  ],
  "includedSiteCategories": [
    "string"
  ],
  "landSurfaceMax": 0,
  "landSurfaceMin": 0,
  "lat": "48.864716",
  "lon": "2.349014",
  "notificationEnabled": false,
  "notificationRecipient": "foo@bar.com",
  "pricePerMeterMax": 0,
  "pricePerMeterMin": 0,
  "propertyTypes": 3,
  "publisherTypes": 3,
  "radius": "20",
  "roomMin": 0,
  "subscribedEvents": [
    "ad.update.price"
  ],
  "surfaceMax": 0,
  "surfaceMin": 0,
  "title": "string",
  "transactionType": "0",
  "withCoherentPrice": true,
  "withVirtualTour": true
}