Get aggregated listing warehouse analytics
Query immutable market warehouse data with filters, grouping, time buckets, and aggregate metrics.
Authorization
apiKey Value for the X-API-KEY header parameter.
In: header
Query Parameters
Property type filter (multi-value).
Transaction type filter.
Value in
- "SELL"
- "RENT"
City IDs filter (multi-value).
District IDs filter (multi-value).
Neighborhood IDs filter (multi-value).
Warehouse event type filter (multi-value).
Inclusive start date for event_at.
date-timeInclusive end date for event_at.
date-timeMinimum displayed price filter.
Maximum displayed price filter.
Minimum displayed area filter.
Maximum displayed area filter.
Minimum rooms filter.
Maximum rooms filter.
Minimum bedrooms filter.
Maximum bedrooms filter.
DPE energy rating filter (multi-value).
Publisher type filter (multi-value).
Bounding box minimum latitude.
Bounding box maximum latitude.
Bounding box minimum longitude.
Bounding box maximum longitude.
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.
Optional event_at time bucket.
"day"Value in
- "day"
- "week"
- "month"
- "quarter"
- "year"
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://example.com/analytics/listings"{ "meta": { "sample_size": 18452, "min_event_at": "2026-01-01T00:00:00Z", "max_event_at": "2026-03-31T23:59:59Z" }, "data": [ { "group": { "city_id": 75056, "property_type": "FLAT" }, "metrics": { "count": 1284, "avg:price": 612500, "avg:price_per_sqm": 11240.5 } } ]}