Stream Estate

https://next.docs.stream.estate
Admin
Stream Estate is a real estate aggregation platform API providing advanced property search, saved...
Tokens:17,899
Snippets:127
Trust Score:6.9
Update:1 month ago
Show doc for...
Tokens:
Raw
### Create an Alert with POST /alerts

Source: https://next.docs.stream.estate/docs/concepts/alert

Example request body for creating a new alert with a webhook destination and notification rules.

```json
{
  "name": "T3 Bordeaux",
  "notificationDestination": { "webhookUrl": "https://your-server.com/webhooks/alerts" },
  "notificationConfig": { "rules": [{ "eventType": "NEW_MATCH" }] }
}
```

--------------------------------

### GET /event-notifications

Source: https://next.docs.stream.estate/docs/concepts/notifications

List delivery logs for notifications.

```APIDOC
## GET /event-notifications

### Description
List delivery logs for notifications. Results are paginated.

### Method
GET

### Endpoint
/event-notifications

### Parameters
#### Query Parameters
- **page** (integer) - Optional - The page number for pagination.
```

--------------------------------

### GET /alerts

Source: https://next.docs.stream.estate/docs/concepts/alert

Retrieves a list of all alerts associated with the account.

```APIDOC
## GET /alerts

### Description
Lists all saved alerts.

### Method
GET

### Endpoint
/alerts
```

--------------------------------

### GET /account/event-destinations

Source: https://next.docs.stream.estate/docs/concepts/notifications

List all configured event destinations for the account.

```APIDOC
## GET /account/event-destinations

### Description
Retrieve a list of all event destinations configured for the account.

### Method
GET

### Endpoint
/account/event-destinations
```

--------------------------------

### Search properties with cURL

Source: https://next.docs.stream.estate/api-reference/property/searchProperties

Example of a POST request to search for properties in Paris with specific criteria using cURL.

```bash
curl -X POST "https://api-v2.stream.estate/properties" \
  -H "X-API-KEY: " \
  -H "Content-Type: application/json" \
  -d '{
    "paginationType": "PAGE",
    "page": 1,
    "size": 20,
    "criteria": {
      "property": {
        "type": {
          "in": [
            "FLAT",
            "HOUSE"
          ]
        },
        "transaction": {
          "type": "SELL"
        },
        "pricing": {
          "displayed": {
            "gte": 350000,
            "lte": 750000
          },
          "pricePerArea": {
            "gte": 8000,
            "lte": 14000
          },
          "sale": {
            "netPrice": {
              "gte": 300000,
              "orMissing": true
            },
            "fees": {
              "agency": {
                "paidBy": "SELLER",
                "includedInPrice": true
              }
            }
          }
        },
        "areas": {
          "displayed": {
            "gte": 45
          }
        },
        "locations": {
          "countryCode": "FR",
          "in": {
            "uniqueCodes": [
              "75056"
            ]
          },
          "nin": {
            "uniqueCodes": [
              "75118"
            ]
          },
          "accuracy": [
            "PRECISE",
            "STREET"
          ]
        },
        "unit": {
          "features": {
            "in": [
              "BALCONY"
            ],
            "nin": [
              "GROUND_FLOOR"
            ],
            "inOrMissing": [
              "FURNISHED"
            ]
          },
          "rooms": {
            "gte": 2,
            "lte": 5,
            "orMissing": false
          },
          "bedrooms": {
            "gte": 1,
            "orMissing": true
          },
          "orientation": {
            "inOrMissing": [
              "SOUTH",
              "SOUTH_WEST"
            ]
          },
          "condition": {
            "nin": [
              "TO_RENOVATE"
            ]
          },
          "energy": {
            "heating": {
              "energyCarrier": {
                "nin": [
                  "OIL"
                ]
              },
              "collective": false
            }
          }
        },
        "building": {
          "constructionYear": {
            "gte": 1900,
            "lte": 2024,
            "orMissing": true
          },
          "constructionType": {
            "in": [
              "HAUSSMANNIAN",
              "STONE"
            ]
          },
          "condition": {
            "inOrMissing": [
              "GOOD",
              "NEW"
            ]
          }
        },
        "body": {
          "title": "lumineux balcon"
        }
      },
      "publisher": {
        "type": {
          "in": [
            "PROFESSIONAL"
          ]
        },
        "mandate": {
          "in": [
            "EXCLUSIVE",
            "SEMI_EXCLUSIVE"
          ]
        },
        "hasEmail": true,
        "hasPhone": true
      },
      "listings": {
        "marketing": {
          "urgent": true
        }
      },
      "dates": {
        "updatedAt": {
          "from": "2026-01-01T00:00:00Z"
        }
      }
    }
  }'
```

--------------------------------

### Search properties response structure

Source: https://next.docs.stream.estate/api-reference/property/searchProperties

Example of the JSON response structure returned by the search properties endpoint.

```json
{
  "items": [
    {
      "id": "",
      "property": {
        "createdAt": "",
        "updatedAt": "",
        "expired": false,
        "propertyType": "FLAT",
        "constructionStatus": "OLD",
        "transaction": {

```

--------------------------------

### GET /account/api-usage

Source: https://next.docs.stream.estate/docs/getting-started/authentication

Récupère les agrégats de consommation facturable du compte, incluant les totaux et les ventilations par clé API ou par route.

```APIDOC
## GET /account/api-usage

### Description
Expose les agrégats de consommation facturable de votre compte, incluant les totaux, les ventilations par clé API et par route, ainsi qu'une série temporelle.

### Method
GET

### Endpoint
/account/api-usage

### Parameters
#### Query Parameters
- **startDate** (ISO 8601) - Optional - Date de début pour le filtrage (défaut = 30 derniers jours)
- **endDate** (ISO 8601) - Optional - Date de fin pour le filtrage (défaut = maintenant)
- **apiKeyId** (UUID) - Optional - UUID public d'une clé API pour filtrer les résultats
- **granularity** (string) - Optional - Paramètre pour regrouper les données
```

--------------------------------

### GET /event-notifications/{uuid}

Source: https://next.docs.stream.estate/docs/concepts/notifications

Retrieve details of a specific delivery log entry.

```APIDOC
## GET /event-notifications/{uuid}

### Description
Get the details of a specific notification delivery log entry by its UUID.

### Method
GET

### Endpoint
/event-notifications/{uuid}

### Parameters
#### Path Parameters
- **uuid** (string) - Required - The unique identifier of the notification log.
```

--------------------------------

### GET /alerts/{uuid}

Source: https://next.docs.stream.estate/docs/concepts/alert

Retrieves the details of a specific alert by its UUID.

```APIDOC
## GET /alerts/{uuid}

### Description
Retrieves detailed information for a specific alert.

### Method
GET

### Endpoint
/alerts/{uuid}

### Parameters
#### Path Parameters
- **uuid** (string) - Required - The unique identifier of the alert.
```

--------------------------------

### GET /properties/{uuid}

Source: https://next.docs.stream.estate/docs/concepts/property

Retrieve the detailed canonical view of a specific property by its UUID.

```APIDOC
## GET /properties/{uuid}

### Description
Retrieve the detailed canonical view of a specific property by its UUID.

### Method
GET

### Endpoint
/properties/{uuid}

### Parameters
#### Path Parameters
- **uuid** (string) - Required - The unique identifier of the property.
```

--------------------------------

### GET /account/event-destinations/{uuid}

Source: https://next.docs.stream.estate/docs/concepts/notifications

Retrieve details of a specific event destination.

```APIDOC
## GET /account/event-destinations/{uuid}

### Description
Get the details of a specific event destination by its UUID.

### Method
GET

### Endpoint
/account/event-destinations/{uuid}

### Parameters
#### Path Parameters
- **uuid** (string) - Required - The unique identifier of the event destination.
```

--------------------------------

### GET /alerts/{alertUuid}/events/{uuid}

Source: https://next.docs.stream.estate/docs/concepts/alert

Retrieves the details of a specific AlertEvent.

```APIDOC
## GET /alerts/{alertUuid}/events/{uuid}

### Description
Retrieves details for a specific event generated by an alert.

### Method
GET

### Endpoint
/alerts/{alertUuid}/events/{uuid}

### Parameters
#### Path Parameters
- **alertUuid** (string) - Required - The unique identifier of the alert.
- **uuid** (string) - Required - The unique identifier of the event.
```

--------------------------------

### GET /alerts/{alertUuid}/events

Source: https://next.docs.stream.estate/docs/concepts/alert

Retrieves the list of AlertEvents produced by a specific alert.

```APIDOC
## GET /alerts/{alertUuid}/events

### Description
Lists events generated by the specified alert.

### Method
GET

### Endpoint
/alerts/{alertUuid}/events

### Parameters
#### Path Parameters
- **alertUuid** (string) - Required - The unique identifier of the alert.
```

--------------------------------

### POST /properties

Source: https://next.docs.stream.estate/docs/guides/filtering

Recherche et filtrage de propriétés immobilières via un arbre de critères récursif.

```APIDOC
## POST /properties

### Description
Récupère une liste de propriétés en fonction de critères de filtrage complexes et de paramètres de pagination.

### Method
POST

### Endpoint
https://api-v2.stream.estate/properties

### Parameters
#### Request Body
- **criteria** (CriteriaNode) - Optional - Un arbre récursif composé de feuilles (Filters), de nœuds "and" ou de nœuds "or".
- **paginationType** (enum) - Optional - "PAGE" (défaut) ou "CURSOR".
- **page** (integer) - Optional - Numéro de page (défaut 1, min 1). Honoré uniquement en mode PAGE.
- **cursor** (string) - Optional - Valeur de curseur pour la pagination. Honoré uniquement en mode CURSOR.
- **size** (integer) - Optional - Nombre d'éléments par page (1-100, défaut 10).
- **sort** (object) - Optional - Directive de tri.

### Request Example
{
  "criteria": {
    "property": {
      "type": { "in": ["FLAT"] },
      "transaction": { "type": "SELL" }
    }
  },
  "paginationType": "PAGE",
  "page": 1,
  "size": 20
}

### Response
#### Success Response (200)
- **items** (array) - Liste des résultats (PropertySearchResultDTO).
- **totalItems** (integer) - Nombre total de correspondances.
- **hasNextPage** (boolean) - Indique s'il reste des résultats.
- **cursor** (string) - Curseur pour la pagination suivante.

#### Response Example
{
  "items": [],
  "totalItems": 1847,
  "hasNextPage": true,
  "cursor": "eyJzb3J0Ijpb..."
}
```

--------------------------------

### Exemple de nœud OR

Source: https://next.docs.stream.estate/docs/guides/filtering

Utilisation d'un nœud OR pour combiner des critères de recherche alternatifs.

```json
{
  "criteria": {
    "or": [
      {
        "property": {
          "type": { "in": ["FLAT"] },
          "areas": { "displayed": { "gte": 60 } }
        }
      },
      {
        "property": {
          "type": { "in": ["HOUSE"] },
          "areas": { "displayed": { "gte": 100 }, "land": { "gte": 300 } }
        }
      }
    ]
  },
  "paginationType": "PAGE",
  "size": 20
}
```

--------------------------------

### Exemple de feuille simple

Source: https://next.docs.stream.estate/docs/guides/filtering

Requête curl pour filtrer des appartements à vendre à Paris avec des critères de prix, de surface et d'équipements.

```bash
curl -X POST "https://api-v2.stream.estate/properties" \
  -H "X-API-KEY: <votre_clé>" \
  -H "Content-Type: application/json" \
  -d '{
    "criteria": {
      "property": {
        "type":      { "in": ["FLAT"] },
        "transaction": { "type": "SELL" },
        "pricing":   { "displayed": { "gte": 200000, "lte": 600000 } },
        "areas":     { "displayed": { "gte": 50 } },
        "unit":      {
          "rooms":    { "gte": 3, "lte": 5 },
          "features": { "in": ["BALCONY"] }
        },
        "locations": {
          "countryCode": "FR",
          "in": { "uniqueCodes": ["75056"] }
        }
      }
    },
    "paginationType": "PAGE",
    "page": 1,
    "size": 20
  }'
```

--------------------------------

### POST /alerts

Source: https://next.docs.stream.estate/docs/guides/webhooks

Creates an alert destination with a webhook URL.

```APIDOC
## POST /alerts

### Description
Creates an alert destination to receive notifications via a webhook URL.

### Method
POST

### Endpoint
/alerts

### Request Body
- **notificationDestination** (object) - Required - Contains the webhook configuration.
  - **webhookUrl** (string) - Required - The URL where the webhook events will be sent.
```

--------------------------------

### POST /alerts

Source: https://next.docs.stream.estate/docs/concepts/alert

Creates a new alert. If a webhookUrl is provided, it creates or reuses an event destination. The response includes a signingKey only if it is the first webhook destination created for the account.

```APIDOC
## POST /alerts

### Description
Creates a new alert with specified criteria and notification configuration.

### Method
POST

### Endpoint
/alerts

### Request Body
- **name** (string) - Optional - Name of the alert.
- **enabled** (boolean) - Optional - Whether the alert is active.
- **criteria** (CriteriaNode) - Optional - Recursive tree of search criteria.
- **notificationConfig** (AlertNotificationConfigDTO) - Optional - Rules for notification triggers.
- **notificationDestination** (NotificationDestination) - Optional - Destination configuration (oneOf: eventDestination or webhookUrl).

### Request Example
{
  "name": "T3 Bordeaux",
  "notificationDestination": { "webhookUrl": "https://your-server.com/webhooks/alerts" },
  "notificationConfig": { "rules": [{ "eventType": "NEW_MATCH" }] }
}

### Response
#### Success Response (200)
- **id** (string) - Alert identifier.
- **signingKey** (string) - HMAC key for webhook signatures (returned only once).
```

--------------------------------

### Ajouter le serveur MCP avec Claude Code

Source: https://next.docs.stream.estate/docs/guides/mcp

Commande pour configurer le serveur MCP de Stream Estate dans Claude Code en utilisant l'en-tête X-API-KEY.

```bash
claude mcp add --transport http streamestate https://api-v2.stream.estate/mcp \
    --header "X-API-KEY: <votre_clé>"
```

--------------------------------

### Exemple de requête cURL

Source: https://next.docs.stream.estate/docs/getting-started/authentication

Exemple d'utilisation de la clé API avec une requête cURL pour lister les sources.

```bash
curl https://api-v2.stream.estate/sources \
  -H "X-API-KEY: <votre_clé>"
```

--------------------------------

### POST /properties

Source: https://next.docs.stream.estate/docs/concepts/property

Search for properties using a criteria tree.

```APIDOC
## POST /properties

### Description
Search for properties based on a provided criteria tree.

### Method
POST

### Endpoint
/properties
```

--------------------------------

### En-tête X-API-KEY requis

Source: https://next.docs.stream.estate/docs/getting-started/authentication

L'en-tête HTTP obligatoire pour authentifier chaque requête adressée à l'API.

```http
X-API-KEY: <votre_clé>
```

--------------------------------

### POST /account/event-destinations

Source: https://next.docs.stream.estate/docs/concepts/notifications

Create a new event destination for receiving webhooks.

```APIDOC
## POST /account/event-destinations

### Description
Create a new event destination. The first destination created will automatically become the default.

### Method
POST

### Endpoint
/account/event-destinations
```

--------------------------------

### Webhook Signature Verification Logic

Source: https://next.docs.stream.estate/docs/guides/webhooks

Implementation details for verifying the X-Webhook-Signature and X-Webhook-Timestamp headers to ensure request authenticity.

```APIDOC
## Webhook Signature Verification

### Description
To ensure that a webhook request originated from Next Stream Estate and has not been tampered with, you must verify the HMAC-SHA256 signature provided in the headers.

### Verification Steps
1. **Timestamp Validation**: Extract `X-Webhook-Timestamp`. Reject the request if the difference between the timestamp and your server's current time exceeds 5 minutes (300 seconds).
2. **Payload Construction**: Concatenate the timestamp, a literal dot (.), and the raw request body bytes.
3. **Signature Calculation**: Compute the HMAC-SHA256 hash of the constructed payload using your `signingKey` and encode it in hexadecimal, prefixed with `sha256=`.
4. **Comparison**: Compare the calculated signature with the `X-Webhook-Signature` header using a constant-time comparison function to prevent timing attacks.

### Implementation Example (Node.js)
```javascript
import crypto from "node:crypto";

const TOLERANCE_SECONDS = 300;

export function verifyStreamEstateWebhook(rawBody, headers, signingKey) {
  const timestamp = headers["x-webhook-timestamp"];
  const signature = headers["x-webhook-signature"];
  if (!timestamp || !signature) return false;

  // Replay protection
  if (Math.abs(Date.now() / 1000 - Number(timestamp)) > TOLERANCE_SECONDS) {
    return false;
  }

  const expected =
    "sha256=" +
    crypto
      .createHmac("sha256", signingKey)
      .update(`${timestamp}.${rawBody}`)
      .digest("hex");

  return crypto.timingSafeEqual(
    Buffer.from(signature),
    Buffer.from(expected),
  );
}
```
```

--------------------------------

### Structure de la réponse

Source: https://next.docs.stream.estate/docs/guides/filtering

Format de la réponse renvoyée par l'API pour une recherche de propriétés.

```json
{
  "items": [ /* PropertySearchResultDTO[] */ ],
  "totalItems": 1847,
  "hasNextPage": true,
  "cursor": "eyJzb3J0Ijpb..."
}
```

--------------------------------

### Exemple de payload de webhook

Source: https://next.docs.stream.estate/docs/guides/webhooks

Structure JSON envoyée lors d'un événement de webhook. Le champ 'data' contient la représentation complète du bien, permettant une ingestion sans appel API supplémentaire.

```json
{
  "eventType": "NEW_MATCH",
  "eventId": "01929ec5-3a4f-7000-bcde-f0123456789a",
  "alert": {
    "id": "01929ec5-2b3c-7000-aaaa-b00000000000",
    "name": "Appartements Paris 11e"
  },
  "listing": {
    "id": "01929ec5-1a2b-7000-cccc-d00000000000"
  },
  "data": {
    "id": "019dedb1-fdf4-714c-8392-5b9cfd63cde3",
    "property":   { "propertyType": "FLAT", "transaction": { "type": "SELL" } /* … vue canonique complète */ },
    "publishers": [ /* PublisherSection[] dédoublonnés */ ],
    "listings":   [ /* ListingSection[] */ ]
  }
}
```

--------------------------------

### Handle Webhook Idempotence

Source: https://next.docs.stream.estate/docs/guides/webhooks

Use an INSERT statement with ON CONFLICT DO NOTHING to ensure that events are processed only once by storing the eventId in a database table.

```javascript
async function handleWebhook(payload) {
  const { rowCount } = await db.query(
    "INSERT INTO processed_events (id) VALUES ($1) ON CONFLICT DO NOTHING",
    [payload.eventId],
  );

  if (rowCount === 0) return; // déjà traité, ack 200

  await processMatch(payload);
}
```

--------------------------------

### Structure de réponse PropertySearchResultDTO

Source: https://next.docs.stream.estate/docs/migration

Exemple de la structure JSON renvoyée par POST /properties en v2, séparant les données canoniques des listings et publishers.

```json
{
  "id": "019dedb1-fdf4-714c-8392-5b9cfd63cde3",
  "property": {
    "createdAt": "2025-01-15T10:30:00+00:00",
    "updatedAt": "2025-06-15T12:00:00+00:00",
    "propertyType": "FLAT",
    "transaction": { "type": "SELL" /* + status, saleType, availableAt */ },
    "area":     { /* displayed, indoor, outdoor, land */ },
    "unit":     { /* rooms, bedrooms, floor, condition */ },
    "building": { /* constructionYear, floors, condition */ }
  },
  "publishers": [/* PublisherSectionDTO[] dédoublonnés */],
  "listings":   [/* ListingSectionDTO[] : url, source, publishedAt, lastSeenAt et toutes les variantes qui diffèrent du canonique */]
}
```

--------------------------------

### Property Data Structure

Source: https://next.docs.stream.estate/api-reference/property/searchProperties

The JSON structure for property objects, covering physical characteristics, unit details, building status, amenities, and financial pricing information.

```json
          "type": "SELL",
          "status": "AVAILABLE",
          "saleType": "STANDARD",
          "availableAt": "string"
        },
        "area": {
          "displayed": 0,
          "unit": "SQM",
          "indoor": {
            "unit": "SQM",
            "legal": {
              "value": 0,
              "law": "CARREZ"
            },
            "living": 0,
            "total": 0
          },
          "outdoor": {
            "unit": "SQM",
            "terrace": 0,
            "balcony": 0,
            "garden": 0
          },
          "annexes": {
            "unit": "SQM",
            "basement": 0,
            "parking": 0
          },
          "land": {
            "unit": "SQM",
            "value": 0
          }
        },
        "unit": {
          "rooms": 0,
          "bedrooms": 0,
          "bathrooms": 0,
          "showerRooms": 0,
          "wc": 0,
          "livingRooms": 0,
          "kitchens": 0,
          "floor": 0,
          "lastFloor": true,
          "groundFloor": true,
          "gardenFloor": true,
          "orientation": [
            "NORTH"
          ],
          "condition": "NEW",
          "furnished": true,
          "disabledAccess": true,
          "equippedKitchen": true,
          "fireplace": true,
          "airConditioning": true,
          "doubleGlazing": true,
          "parquet": true,
          "balcony": true,
          "terrace": true,
          "garden": true,
          "dressing": true,
          "crossing": true,
          "quiet": true,
          "cellar": true,
          "basement": true,
          "storage": true,
          "parking": {
            "total": 0,
            "spots": [
              {
                "type": "GARAGE",
                "box": false
              }
            ]
          },
          "diagnostic": {
            "type": "DPE",
            "date": "string",
            "scores": {
              "property1": {
                "rating": "A",
                "value": 0,
                "unit": "KWH_EP_PER_SQM_YEAR"
              },
              "property2": {
                "rating": "A",
                "value": 0,
                "unit": "KWH_EP_PER_SQM_YEAR"
              }
            }
          },
          "energy": {
            "heating": [
              {
                "system": "BOILER",
                "energyCarrier": "GAS",
                "collective": true
              }
            ]
          }
        },
        "building": {
          "constructionYear": 0,
          "renovationYear": 0,
          "constructionType": "HAUSSMANNIAN",
          "condition": "NEW",
          "floors": 0,
          "numberOfLots": 0,
          "legalStatus": {
            "underLegalProceedings": true
          },
          "energy": {
            "heating": [
              {
                "system": "BOILER",
                "energyCarrier": "GAS",
                "collective": true
              }
            ]
          }
        },
        "amenities": {
          "parking": {
            "type": "GARAGE",
            "spaces": 0
          },
          "elevator": true,
          "intercom": true,
          "digicode": true,
          "caretaker": true,
          "bikeRoom": true,
          "disabledAccess": true,
          "gym": true,
          "playground": true,
          "partyHall": true,
          "sportCourt": true,
          "adultGameRoom": true,
          "gatedCommunity": true,
          "barbecueGrill": true,
          "swimmingPool": true,
          "connectivity": [
            "CABLE"
          ]
        },
        "body": {
          "title": "string",
          "description": "string"
        },
        "pricing": {
          "displayed": 0,
          "currency": "EUR",
          "sale": {
            "netPrice": 0,
            "fees": {
              "agency": {
                "amount": 0,
                "percentage": 0,
                "currency": "EUR",
                "paidBy": "BUYER",
                "includedInPrice": true
              },
              "legal": {
                "type": "NOTARY",
                "currency": "EUR",
                "amount": 0,
                "percentage": 0,
                "paidBy": "BUYER"
              },
              "condominium": {
                "total": 0,
                "currency": "EUR",
                "frequency": "WEEKLY",
                "breakdown": [
                  {
                    "type": "HEATING",
                    "amount": 0,
                    "currency": "EUR",
                    "frequency": "WEEKLY"
                  }
                ]
              },
              "taxes": {
                "propertyTax": {
                  "amount": 0,
                  "currency": "EUR",
                  "frequency": "WEEKLY",
                  "paidBy": "BUYER"
                }
              }
            }
          },
          "rental": {
            "rent": {
```

--------------------------------

### Vérification de signature en Node.js

Source: https://next.docs.stream.estate/docs/guides/webhooks

Fonction utilitaire pour valider la signature HMAC-SHA256 et le timestamp d'une requête webhook. Elle utilise crypto.timingSafeEqual pour prévenir les attaques par analyse temporelle.

```javascript
import crypto from "node:crypto";

const TOLERANCE_SECONDS = 300;

export function verifyStreamEstateWebhook(rawBody, headers, signingKey) {
  const timestamp = headers["x-webhook-timestamp"];
  const signature = headers["x-webhook-signature"];
  if (!timestamp || !signature) return false;

  // Replay protection
  if (Math.abs(Date.now() / 1000 - Number(timestamp)) > TOLERANCE_SECONDS) {
    return false;
  }

  const expected =
    "sha256=" +
    crypto
      .createHmac("sha256", signingKey)
      .update(`${timestamp}.${rawBody}`)
      .digest("hex");

  return crypto.timingSafeEqual(
    Buffer.from(signature),
    Buffer.from(expected),
  );
}
```

--------------------------------

### application/vnd.api+json Property Response Structure

Source: https://next.docs.stream.estate/api-reference/property/searchProperties

The JSON structure for a property search response, detailing financial fees, geographical location, media, and listing metadata.

```json
{
  "application/vnd.api+json": {
    "amount": 0,
    "currency": "EUR",
    "frequency": "WEEKLY",
    "includesCharges": true
  },
  "fees": {
    "charges": {
      "amount": 0,
      "currency": "EUR",
      "frequency": "WEEKLY",
      "details": [
        {
          "type": "HEATING",
          "amount": 0,
          "currency": "EUR"
        }
      ]
    },
    "deposit": {
      "amount": 0,
      "currency": "EUR",
      "months": 0,
      "paidBy": "BUYER"
    },
    "taxes": {
      "housingTax": {
        "amount": 0,
        "currency": "EUR",
        "frequency": "WEEKLY",
        "paidBy": "BUYER",
        "includedInCharges": true
      }
    },
    "inventory": {
      "amount": 0,
      "percentage": 0,
      "currency": "EUR",
      "paidBy": "BUYER"
    },
    "agency": {
      "amount": 0,
      "percentage": 0,
      "currency": "EUR",
      "paidBy": "BUYER"
    }
  }
},
"location": {
  "geometry": {
    "type": "Point",
    "coordinates": [
      0
    ]
  },
  "accuracy": "PRECISE",
  "address": "string",
  "countryCode": "FR",
  "city": {
    "iri": "",
    "id": "",
    "name": "string",
    "type": "COUNTRY",
    "uniqueCode": "string",
    "postalCodes": [
      "string"
    ]
  },
  "neighborhood": {
    "iri": "",
    "id": "",
    "name": "string",
    "type": "COUNTRY",
    "uniqueCode": "string",
    "postalCodes": [
      "string"
    ]
  },
  "subNeighborhood": {
    "iri": "",
    "id": "",
    "name": "string",
    "type": "COUNTRY",
    "uniqueCode": "string",
    "postalCodes": [
      "string"
    ]
  }
},
"pictures": [
  {
    "url": ""
  }
],
"changes": [
  {
    "attribute": "DISPLAYED_PRICE",
    "occurredAt": "",
    "listingId": "",
    "revisionId": "",
    "variationPercent": 0,
    "numericOld": 0,
    "numericNew": 0
  }
]
},
"publishers": [
  {
    "id": "",
    "publisherType": "PRIVATE_INDIVIDUAL",
    "agencyName": "string",
    "professionalCardNumber": "string",
    "website": "string",
    "mandate": "NON_EXCLUSIVE",
    "reference": "string",
    "contact": {
      "email": "string",
      "phone": "string",
      "profileUrl": "string"
    }
  }
],
"listings": [
  {
    "id": "",
    "url": "string",
    "source": {
      "iri": "",
      "uuid": "",
      "slug": ""
    },
    "publishedAt": "string",
    "expiredAt": "string",
    "lastSeenAt": "string",
    "title": "string",
    "description": "string",
    "createdAt": "",
    "updatedAt": "",
    "area": 0,
    "rooms": 0,
    "bedrooms": 0,
    "bathrooms": 0,
    "showerRooms": 0,
    "wc": 0,
    "livingRooms": 0,
    "kitchens": 0,
    "floor": 0,
    "lastFloor": true,
    "groundFloor": true,
    "gardenFloor": true,
    "condition": "NEW",
    "furnished": true,
    "disabledAccess": true,
    "equippedKitchen": true,
    "fireplace": true,
    "airConditioning": true,
    "doubleGlazing": true,
    "parquet": true,
    "balcony": true,
    "terrace": true,
    "garden": true,
    "dressing": true,
    "crossing": true,
    "quiet": true,
    "cellar": true,
    "basement": true,
    "storage": true,
    "transactionStatus": "AVAILABLE",
    "displayedPrice": 0,
    "propertyType": "FLAT",
    "transactionType": "SELL",
    "marketing": {
      "favorites": 0,
      "urgent": true,
      "boosted": true,
      "highlighted": true
    }
  }
]
},
"totalItems": 0,
"hasNextPage": false,
"cursor": "string"
}
```

--------------------------------

### Structure de requête Alert v2

Source: https://next.docs.stream.estate/docs/migration

Exemple de corps de requête pour POST /alerts utilisant un arbre criteria unique et une destination déclarative.

```json
{
  "name": "Appartements 3+ pièces à Paris",
  "active": true,
  "criteria": {
    "property": {
      "type": { "in": ["FLAT"] },
      "transaction": { "type": "SELL" },
      "unit": { "rooms": { "gte": 3 } },
      "locations": { "countryCode": "FR", "in": { "uniqueCodes": ["75056"] } }
    }
  },
  "notificationConfig": {
    "rules": [
      { "eventType": "NEW_MATCH", "enabled": true },
      { "eventType": "PRICE_CHANGED", "thresholdPercentage": 5, "thresholdDirection": "DECREASE", "enabled": true }
    ]
  },
  "notificationDestination": {
    "webhookUrl": "https://your.app/hook"
  }
}
```

--------------------------------

### Structure du corps de la requête POST

Source: https://next.docs.stream.estate/docs/guides/filtering

Schéma de base pour le corps de la requête POST /properties.

```json
{
  "criteria": { /* CriteriaNode */ },
  "paginationType": "PAGE",
  "page": 1,
  "size": 20
}
```

--------------------------------

### PUT /alerts/{uuid}

Source: https://next.docs.stream.estate/docs/concepts/alert

Updates an existing alert.

```APIDOC
## PUT /alerts/{uuid}

### Description
Updates the configuration of an existing alert.

### Method
PUT

### Endpoint
/alerts/{uuid}

### Parameters
#### Path Parameters
- **uuid** (string) - Required - The unique identifier of the alert.
```

--------------------------------

### Exemple d'erreur de validation 422

Source: https://next.docs.stream.estate/docs/reference/error-codes

Exemple de réponse pour une erreur de validation (ConstraintViolation) où le champ detail contient le chemin du champ fautif.

```json
{
  "type": "/validation_errors/c1051bb4-d103-4f74-8988-acbcafc7fdc3",
  "title": "Validation Failed",
  "status": 422,
  "detail": "name: This value should not be blank.",
  "instance": "/alerts"
}
```
Tokens:
Raw