Developers
Get access

Versioning and changelog

What changed, and when. Entries are tagged API change for the request and response contract, or Model update for a new model build.

Versioning

  • The major version is in every path: /partners/v1.
  • Each valuation records the model build that produced it in model.version.
  • Deprecations are announced on this page and marked Deprecation.

Changelog

Street analysis, a token address of its own, daily limits

  • GET /partners/v1/street-analysis/{postcode}: sold prices, crime, transport by distance band, rents and yields, energy use and the local price index. The first read of a postcode in 30 days is charged.
  • Tokens come from https://auth.checkmystreet.co.uk/oauth2/token.
  • Daily limits: 5,000 paid and 1,000 test calls an account. Past them, 429 rate-limited carries "code": "daily_limit".
  • The API reference sends test requests from the page, with the sandbox credential.
  • Valuations can include the written commentary and a rebuild cost estimate: send "include": ["commentary", "rebuildCost"]. Both are free.

Partner API v1 draft contract: Valuation

The first draft of the v1 contract:

  • POST /partners/v1/valuations, with an optional Idempotency-Key header
  • GET /partners/v1/valuations/{id}, free
  • OAuth 2.0 client credentials, 30 minute tokens
  • RFC 9457 problem details for every error

Details may still change before launch.

Updated