• Home
  • My Account
  • Docs
  • Catalog Browser
  • API Status
Show / Hide Table of Contents

Guides

The following guides provide stepwise instructions for accessing the WhenFresh API via HTTP.

  • Quick Start
  • Authenticating with the API
  • Purchasing Variables from a Catalog

Most of our data is exposed on the API on the Spatial Address catalog resource, so obtaining a UPRN first is a common pattern.

  • Obtain a UPRN when you only have an address string (Address Matching)
  • Obtain UPRNs for a Postcode
  • Obtain a UPRN from a Royal Mail UDPRN or UMRRN
  • Obtain a UPRN from a HMLR Title Number

Advanced scenarios (please contact us if you feel a need for those)

  • Retrieving the Catalog for a Spatial Address
  • Long running requests / Asynchronous processing

Special variables

  • Land Registry Ownership Verification
  • Improve this Doc