Stream EstateStream Estate
Alerts

Get an alert

Get an alert

GET
/alerts/{uuid}

Path Parameters

uuid*string

Alert identifier

Response Body

curl -X GET "https://api-v2.stream.estate/alerts/string"
{
  "name": "2-bedroom apartments in Paris",
  "active": true,
  "searchMode": "advanced",
  "criteria": {
    "transactionType": {
      "value": "SELL"
    },
    "propertyType": {
      "included": [
        1
      ],
      "excluded": [
        1
      ]
    },
    "price": {
      "min": 0,
      "max": 1
    },
    "area": {
      "min": 0,
      "max": 1
    },
    "rooms": {
      "bedrooms": {
        "min": 0,
        "max": 0,
        "allowNull": true
      },
      "rooms": {
        "min": 0,
        "max": 0,
        "allowNull": true
      },
      "bathrooms": {
        "min": 0,
        "max": 0,
        "allowNull": true
      }
    },
    "location": {
      "includedDivisionIds": [
        0
      ],
      "excludedDivisionIds": [
        0
      ],
      "centerPoint": "{\"lat\": 48.8566, \"lon\": 2.3522}",
      "radiusMeters": 1,
      "includedGeoShapeIds": [
        "string"
      ],
      "excludedGeoShapeIds": [
        "string"
      ]
    },
    "unit": {
      "furnished": {
        "value": true,
        "allowNull": true
      },
      "disabledAccess": {
        "value": true,
        "allowNull": true
      },
      "equippedKitchen": {
        "value": true,
        "allowNull": true
      },
      "balcony": {
        "value": true,
        "allowNull": true
      },
      "terrace": {
        "value": true,
        "allowNull": true
      },
      "garden": {
        "value": true,
        "allowNull": true
      },
      "floor": {
        "min": 0,
        "max": 0,
        "allowNull": true
      },
      "bathrooms": {
        "min": 0,
        "max": 0,
        "allowNull": true
      },
      "cellar": {
        "value": true,
        "allowNull": true
      },
      "lastFloor": {
        "value": true,
        "allowNull": true
      }
    },
    "amenities": {
      "elevator": {
        "value": true,
        "allowNull": true
      },
      "intercom": {
        "value": true,
        "allowNull": true
      },
      "gym": {
        "value": true,
        "allowNull": true
      },
      "swimmingPool": {
        "value": true,
        "allowNull": true
      },
      "parking": {
        "value": true,
        "allowNull": true
      }
    },
    "building": {
      "constructionYear": {
        "min": 0,
        "max": 0,
        "allowNull": true
      },
      "renovationYear": {
        "min": 0,
        "max": 0,
        "allowNull": true
      },
      "lots": {
        "min": 0,
        "max": 0,
        "allowNull": true
      }
    },
    "areas": {
      "indoor": {
        "min": 0,
        "max": 0,
        "allowNull": true
      },
      "outdoor": {
        "min": 0,
        "max": 0,
        "allowNull": true
      },
      "land": {
        "min": 0,
        "max": 0,
        "allowNull": true
      },
      "balcony": {
        "min": 0,
        "max": 0,
        "allowNull": true
      },
      "terrace": {
        "min": 0,
        "max": 0,
        "allowNull": true
      },
      "garden": {
        "min": 0,
        "max": 0,
        "allowNull": true
      }
    },
    "pricing": {
      "charges": {
        "min": 0,
        "max": 0,
        "allowNull": true
      },
      "agencyFees": {
        "min": 0,
        "max": 0,
        "allowNull": true
      },
      "securityDeposit": {
        "min": 0,
        "max": 0,
        "allowNull": true
      },
      "chargesIncluded": {
        "value": true,
        "allowNull": true
      },
      "feesIncluded": {
        "value": true,
        "allowNull": true
      }
    },
    "children": [
      {
        "transactionType": {
          "value": "SELL"
        },
        "propertyType": {
          "included": [
            1
          ],
          "excluded": [
            1
          ]
        },
        "price": {
          "min": 0,
          "max": 1
        },
        "area": {
          "min": 0,
          "max": 1
        },
        "rooms": {
          "bedrooms": {
            "min": 0,
            "max": 0,
            "allowNull": true
          },
          "rooms": {
            "min": 0,
            "max": 0,
            "allowNull": true
          },
          "bathrooms": {
            "min": 0,
            "max": 0,
            "allowNull": true
          }
        },
        "location": {
          "includedDivisionIds": [
            0
          ],
          "excludedDivisionIds": [
            0
          ],
          "centerPoint": "{\"lat\": 48.8566, \"lon\": 2.3522}",
          "radiusMeters": 1,
          "includedGeoShapeIds": [
            "string"
          ],
          "excludedGeoShapeIds": [
            "string"
          ]
        },
        "unit": {
          "furnished": {
            "value": true,
            "allowNull": true
          },
          "disabledAccess": {
            "value": true,
            "allowNull": true
          },
          "equippedKitchen": {
            "value": true,
            "allowNull": true
          },
          "balcony": {
            "value": true,
            "allowNull": true
          },
          "terrace": {
            "value": true,
            "allowNull": true
          },
          "garden": {
            "value": true,
            "allowNull": true
          },
          "floor": {
            "min": 0,
            "max": 0,
            "allowNull": true
          },
          "bathrooms": {
            "min": 0,
            "max": 0,
            "allowNull": true
          },
          "cellar": {
            "value": true,
            "allowNull": true
          },
          "lastFloor": {
            "value": true,
            "allowNull": true
          }
        },
        "amenities": {
          "elevator": {
            "value": true,
            "allowNull": true
          },
          "intercom": {
            "value": true,
            "allowNull": true
          },
          "gym": {
            "value": true,
            "allowNull": true
          },
          "swimmingPool": {
            "value": true,
            "allowNull": true
          },
          "parking": {
            "value": true,
            "allowNull": true
          }
        },
        "building": {
          "constructionYear": {
            "min": 0,
            "max": 0,
            "allowNull": true
          },
          "renovationYear": {
            "min": 0,
            "max": 0,
            "allowNull": true
          },
          "lots": {
            "min": 0,
            "max": 0,
            "allowNull": true
          }
        },
        "areas": {
          "indoor": {
            "min": 0,
            "max": 0,
            "allowNull": true
          },
          "outdoor": {
            "min": 0,
            "max": 0,
            "allowNull": true
          },
          "land": {
            "min": 0,
            "max": 0,
            "allowNull": true
          },
          "balcony": {
            "min": 0,
            "max": 0,
            "allowNull": true
          },
          "terrace": {
            "min": 0,
            "max": 0,
            "allowNull": true
          },
          "garden": {
            "min": 0,
            "max": 0,
            "allowNull": true
          }
        },
        "pricing": {
          "charges": {
            "min": 0,
            "max": 0,
            "allowNull": true
          },
          "agencyFees": {
            "min": 0,
            "max": 0,
            "allowNull": true
          },
          "securityDeposit": {
            "min": 0,
            "max": 0,
            "allowNull": true
          },
          "chargesIncluded": {
            "value": true,
            "allowNull": true
          },
          "feesIncluded": {
            "value": true,
            "allowNull": true
          }
        },
        "children": [],
        "operator": "AND"
      }
    ],
    "operator": "AND"
  },
  "notificationConfig": {
    "rules": [
      {
        "eventType": "NEW_MATCH",
        "thresholdPercentage": 5,
        "thresholdMinPercentage": 5,
        "thresholdMaxPercentage": 10,
        "thresholdDirection": "INCREASE",
        "enabled": true
      }
    ]
  },
  "eventDestinationId": "d885caf6-4ba7-4103-9f91-96705d0662e3",
  "signingKey": "whsec_abc123...",
  "destinationWebhookUrl": "string",
  "destinationEmail": "string",
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z"
}
{
  "title": "string",
  "detail": "string",
  "status": 404,
  "instance": "string",
  "type": "string"
}
{
  "title": "string",
  "detail": "string",
  "status": 404,
  "instance": "string",
  "type": "string"
}