Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.
openapi: 3.2.0
info:
title: Stream Estate Webhooks API
description: The Stream Estate API is designed to enable builders to easily query, observe, and automate real estate data and insights. All API calls require the `X-API-KEY` header. Sign up at https://stream.estate/signup and create an API key in your settings.
version: 1.0.0
contact:
url: https://stream.estate
servers:
- url: https://api.stream.estate
security:
- apiKey: []
tags:
- name: Webhooks
description: Tools to test webhook integrations.
paths:
/webhook-tester:
get:
tags:
- Webhooks
summary: Simulate a webhook
description: 'Simulates a `match` or an `event` to the given endpoint. Your server implementation should return a `200` HTTP status code if the data was received successfully. If a webhook fails, it will be retried up to five times, each retry 1 hour after the previous one. Restricting your endpoints to the Stream Estate IP addresses is highly recommended: sandbox `178.238.226.136`, production `144.76.91.183`.'
operationId: simulateWebhook
parameters:
- name: endpoint
in: query
description: Endpoint where the match or the event will be sent to.
schema:
type: string
format: uri
required: true
- name: eventType
in: query
description: The type of event you want to trigger. Omit it to simulate a `match`.
schema:
type: string
enum:
- ad.update.price
- ad.update.surface
- ad.update.pictures
- ad.update.expired
- property.ad.create
- property.ad.update
responses:
'200':
description: The simulated payload was sent to the given endpoint.
'400':
description: Bad Request — your request is incorrect.
'401':
description: Unauthorized — your API key is wrong.
components:
securitySchemes:
apiKey:
type: apiKey
in: header
name: X-API-KEY
description: API key created in your Stream Estate settings.