@hmcts/os-places-client
v1.1.7
Published
Ordnance Survey address lookup client (https://apidocs.os.uk/docs/os-places-postcode)
Downloads
1,508
Maintainers
Keywords
Readme
os-places-client-node
Written to directly replace the deprecated postcode-info-client-node
API Client wrapper for Ordnance Survey Places Postcode API.
Usage
Authentication
You will need an API key for OS Places API - Capture and Verification
. You can get one by emailing [email protected] with a brief summary of:
- Who you are
- What project you're going to be using it on
- Roughly how many lookups you expect to do per day
- No. of keys required
- Product and environment type for each key
- Contact name and email address for issuing keys
Quick start
$ yarn add @hmcts/os-places-client
Typescript:
import { OSPlacesClient } from '@hmcts/os-places-client'
new OSPlacesClient('<token here>').lookupByPostcode('SN15NB')
- Javascript -
const OSPlacesClient = require('@hmcts/os-places-client').OSPlacesClient
new OSPlacesClient('<token here>').lookupByPostcode('SN15NB')
Version 1.1.0+
Changing the api url to https://api.os.uk/search/places/v1/postcode You will need a new token when upgrading to version 1.1.0+ from version 1.0.6