Vepler API Documentation

Five endpoints return property records and take an attributes parameter:

GET /v1/property/{locationIds}
GET /v1/property/propertyId/{propertyIds}
GET /v1/property/sources/{sourceIds}
POST /v1/property/properties/by-slugs
POST /v1/property/query

List the dotted paths you want. Only those are returned, plus locationId, which is always included. The GET endpoints take a comma-separated string with no spaces, POST /v1/property/properties/by-slugs takes an array, and POST /v1/property/query takes either. Without attributes you get locationId, propertyId, slug and address. A group path such as epc returns everything under it.

The attribute catalogue

GET /v1/property/attributes lists every attribute, with the names that filters and sorts accept. It is free to call.

curl https://api.vepler.com/v1/property/attributes \
  -H "x-api-key: $VEPLER_API_KEY"

import { SDK } from "@vepler/sdk";

const vepler = new SDK({ apiKeyAuth: process.env.VEPLER_API_KEY });
const catalogue = await vepler.property.getPropertyAttributes();

Field	Contents
`attributes`	One entry per attribute: `path`, `group`, `type`, `description`, `enumValues` where the values are fixed, `tier`, `requiresPermission` and `filterable`.
`groups`	Each top-level group: `key`, `label`, `attributeCount` and the highest `tier` among its attributes.
`tiers`	Each billing tier: `code`, `label` and its list price in `credits` per property record.
`pencePerCredit`	What one credit costs in pence on pay-as-you-go.
`filterFields`	Every name a filter condition accepts, with the attribute it targets (`target`) and its `kind`.
`comparators`	Every comparator name.
`sortFields`	Every name `sort[].field` accepts.
`defaultAttributes`	The attributes returned when you omit `attributes`.
`grantedPermissions`	The extended permissions your account holds.
`generatedAt`	When the catalogue was built.

tiers[].credits and pencePerCredit are null when the price could not be read.

What a record costs

Property records are charged per record returned, by tier:

Every record is charged tier_core.
Each attribute you request by its catalogue path adds that attribute’s tier, for every record in the response, whether or not the record has a value for it.
Any tier above tier_core also adds tier_detail.

So ["address", "roomDetails.beds", "pricing.currentSale"] costs tier_core, tier_detail and tier_market per record. The catalogue gives list prices. The pricing page in the dashboard shows the rates your account pays, and the query builder adds up the cost per record as you pick attributes.

Filtering and sorting

POST /v1/property/query filters with conditions, each a field, a comparator and a value:

{
  "area": [{ "type": "postcode", "value": "SW1A" }],
  "query": [
    {
      "operator": "AND",
      "groups": [
        {
          "conditions": [
            { "field": "beds", "comparator": "gte", "value": 3 },
            { "field": "pricing.currentSale", "comparator": "lte", "value": 1500000 }
          ]
        }
      ]
    }
  ],
  "sort": [{ "field": "pricing.currentSale", "order": "asc" }],
  "attributes": ["address", "roomDetails.beds", "pricing.currentSale"],
  "limit": 25
}

query is required; send [] to apply no filters. A condition’s field takes any name in filterFields: an attribute’s own path, where its filterable is true, or an alias such as beds for roomDetails.beds. Any other name is rejected with a 400. The comparators a field accepts depend on its kind:

`kind`	Comparators
`term`	`eq`, `ne`, `in`, `nin`
`range`	`eq`, `ne`, `in`, `nin`, `gt`, `gte`, `lt`, `lte`

in and nin take an array. The other names in comparators, such as contains, are rejected with a 400. sort takes up to three entries, each a field from sortFields and an order of asc or desc.

Permissions

Some attributes need an extended permission, named in requiresPermission. grantedPermissions lists the ones your account holds. An attribute you lack the permission for is left out of responses, without an error. Filtering on one is rejected with a 403.

Guides

Property attributes

The attribute catalogue

What a record costs

Filtering and sorting

Permissions

​The attribute catalogue

​What a record costs

​Filtering and sorting

​Permissions

The attribute catalogue

What a record costs

Filtering and sorting

Permissions