Listing publication dates may be null, and ward crime figures say how closely they fit (v6.1.0)

publishedDate is optional and nullable on GET /v1/listings/{id}, GET /v1/listings/source/{provider}/{key}, GET /v1/listings/location/{locationId}, POST /v1/listings/query and POST /v1/listings/source/query, where it was a required string. It is when the source first published the listing, and it is null or absent when the source does not publish a date. To migrate, type the field as string | null, treat an absent key as null, and do not substitute another date for it.
The same field is nullable on POST /v1/listings/query/advanced and on each listings item in property responses from GET /v1/property/{locationIds}, GET /v1/property/propertyId/{propertyIds}, GET /v1/property/sources/{sourceIds}, POST /v1/property/properties/by-slugs and POST /v1/property/query. @vepler/sdk 6.1.0 types it as Date | null | undefined throughout.
Undated listings sort after dated ones on GET /v1/listings/location/{locationId}. POST /v1/listings/query returns only listings that carry a date, and a publishedDate range filter matches dated listings only.
Ward and built-up-area rows from GET /v1/safety/geography/metrics carry geographyFit: the share of the area's footprint covered by the Lower Layer Super Output Areas its figures are aggregated from, as a fraction from 0 to 1. Ward (E05, W05) and built-up-area (E63, W45, K08) figures are summed from those smaller areas, so they are approximations, and geographyFit tells a ward at 0.99 from one at 0.4. Their entityType reads district_borough_unitary_ward or built_up_area_250.
GET /v1/safety/geography/metrics accepts GSS codes at eight levels: Lower Layer Super Output Area (E01, W01), Middle Layer Super Output Area (E02, W02), ward, built-up area, local authority district or unitary authority (E06 to E09, W06), county (E10), English region (E12) and country (E92, W92). Percentiles rank an area against others of its own type, so a ward is ranked among wards and a built-up area among built-up areas.
A null geographyFit is not an unknown value. It means the area is made up of whole Lower Layer Super Output Areas and no approximation arises, which holds at every level from LSOA to country, and it is also null on merged rows. A built-up area smaller than the Lower Layer Super Output Area that contains it has no figures and returns an empty data list.
@vepler/sdk 6.1.0 is generated from this release. Alongside the listing and crime fields above, it adds typed methods for GET /v1/title-deeds/{titleNumber}/availability and GET /v1/title-deeds/{titleNumber}/applications, types failure_code and failure_message on the 404 from GET /v1/title-deeds/{titleNumber}/purchase-status, and adds a geography namespace for the /v1/geography endpoints.

Listing publication dates may be null, and ward crime figures say how closely they fit

Changed

Affected endpoints

Keep in touch