Options
All
  • Public
  • Public/Protected
  • All
Menu

Index

Functions

Const checkKeyUsability

Const lookupAddress

Const lookupPostcode

  • Lookup Postcode

    Search for addresses given a postcode. Postcode queries are case and space insensitive

    Invalid postcodes return an empty array address result []

    API Documentation for /postcodes

    Parameters

    Returns Promise<Address[]>

Const lookupUdprn

Const lookupUmprn

Const ping

  • Ping API base (/)

    Dispatches HTTP request to root endpoint "/"

    Parameters

    Returns Promise<HttpResponse>