Vepler logo
v5.3.0

Every property attribute, its tier and its live price, from one free endpoint

GET /v1/property/attributes returns every attribute path with its billing tier, live credit price and required permissions, plus the filter and sort whitelists. The dashboard adds a query builder.

Added

  • GET /v1/property/attributes is a free, machine-readable catalogue of the property surface. Each entry lists the dotted path accepted by the attributes parameter, its type, the billing tier it triggers (tier_core through tier_planning) and any extended permission it requires. The response also carries the filterFields, comparators and sortFields accepted by POST /v1/property/query, the default attribute set, live per-tier credit prices with the flat pencePerCredit rate, and the permissions your key holds. It is generated from the same registries the serving path executes, so it cannot drift from real behaviour. Call it with your API key; it is safe to cache.
  • The dashboard gains a query builder (Build, then Query builder): compose a property query visually from a grouped, searchable attribute tree, watch the per-record cost update across the cumulative tier ladder, see which attributes your key is licensed for, and copy the generated JSON or cURL request.

Changed

  • The POST /v1/property/query condition documentation now points at the whitelisted filter aliases (for example beds, currentSaleListingPrice, epc.currentRatingBand) rather than response attribute paths; the full alias list is served by the attribute catalogue.
  • The documented sort whitelist lists only fields validated by both the request contract and the query engine, so every advertised sort works end to end.

Affected endpoints