Stream EstateStream Estate
Analytics

Get aggregated listing warehouse analytics

Query immutable market warehouse data with filters, grouping, time buckets, and aggregate metrics.

GET
/analytics/listings

Query Parameters

property_type?array<>

Property type filter (multi-value).

transaction_type?string

Transaction type filter.

Value in"SELL" | "RENT"
city_id?array<>

City IDs filter (multi-value).

district_id?array<>

District IDs filter (multi-value).

neighborhood_id?array<>

Neighborhood IDs filter (multi-value).

event_type?array<>

Warehouse event type filter (multi-value).

event_at_from?string

Inclusive start date for event_at.

Formatdate-time
event_at_to?string

Inclusive end date for event_at.

Formatdate-time
price_min?number

Minimum displayed price filter.

price_max?number

Maximum displayed price filter.

area_min?number

Minimum displayed area filter.

area_max?number

Maximum displayed area filter.

rooms_min?integer

Minimum rooms filter.

rooms_max?integer

Maximum rooms filter.

bedrooms_min?integer

Minimum bedrooms filter.

bedrooms_max?integer

Maximum bedrooms filter.

dpe_energy_rating?array<>

DPE energy rating filter (multi-value).

publisher_type?array<>

Publisher type filter (multi-value).

lat_min?number

Bounding box minimum latitude.

lat_max?number

Bounding box maximum latitude.

lng_min?number

Bounding box minimum longitude.

lng_max?number

Bounding box maximum longitude.

group_by?array<string>

Categorical columns to group by (max 10 fields). Allowed fields: property_type, transaction_type, event_type, city_id, district_id, neighborhood_id, dpe_energy_rating, dpe_ghg_rating, publisher_type, price_currency, transaction_status, sale_type, mandate_type, condition, location_accuracy, heating_system, energy_carrier, source_id.

time_bucket?string

Optional event_at time bucket.

Default"day"
Value in"day" | "week" | "month" | "quarter" | "year"
metrics?array<string>

Aggregation metrics (max 20 metrics). Available functions: count, avg, median, min, max, percentile. Available fields for avg|median|min|max|percentile: price, price_displayed, price_per_sqm, area, area_displayed, rooms, bedrooms, days_between_events. Format: count | : | percentile:: (0 < p <= 100).

Response Body

curl -X GET "https://api-v2.stream.estate/analytics/listings"
{
  "meta": {
    "sample_size": 0,
    "min_event_at": "string",
    "max_event_at": "string"
  },
  "data": [
    {
      "group": {
        "property1": true,
        "property2": true
      },
      "metrics": {
        "property1": 0,
        "property2": 0
      }
    }
  ]
}
{
  "title": "string",
  "detail": "string",
  "status": 404,
  "instance": "string",
  "type": "string"
}
{
  "title": "string",
  "detail": "string",
  "status": 404,
  "instance": "string",
  "type": "string"
}