Vepler logo
v5.13.0

Nine more reference sections, and a description on every parameter in the API reference

Every parameter and operation in the API reference is documented for integrators, nine more sections say what they cover, and the property attribute catalogue defines its own fields.

Added

  • Nine more API sections are named and described in the reference. Buildings, Transactions, Title Deeds, Air Quality, Flood Risk, Prosperity, Land Constraint, Schools Catchment and Schools Reference each open with a summary of what the section covers, across 30 operations. The endpoints inside them are unchanged, so the sections are a way into the reference rather than a new surface to integrate against.

Changed

  • Every operation in the reference, and every query and path parameter on it, carries a description written for the integrator: what the value means, its unit or format, and the defaults and limits its schema enforces. All 298 parameters in the reference are described, across its 153 operations. Most response fields are documented the same way, so a payload can be read without leaving the page.
  • Every documented error response says what the status code means for the caller, worded consistently across the API: 400 points at the parameter that failed, 401 a missing key, 403 a key without access to that resource, 404 no matching record, 429 the interval to wait given in the Retry-After header, and 500 a failure worth retrying. Where an endpoint returns a code for a particular reason it says so: the 403 on GET /v1/title-deeds/{titleNumber} means the title has not been purchased on this account.
  • GET /v1/property/attributes returns a definition in plain English for the attributes in its catalogue that carry one, on attributes[].description, so a client can render what those fields mean straight from the API response. The reference now spells out the catalogue's own fields as well: filterFields[].kind says whether a field takes term or range comparators, and pencePerCredit gives the pay-as-you-go rate a credit converts at. The endpoint is free to call.

Affected endpoints