@hmcts/os-places-client
Ordnance Survey address lookup client (https://apidocs.os.uk/docs/os-places-postcode)
Last updated 6 months ago by jenkins-reform-hmcts .
MIT · Repository · Bugs · Original npm · Tarball · package.json
$ cnpm install @hmcts/os-places-client 
SYNC missed versions from official npm registry.

os-places-client-node

Written to directly replace the deprecated postcode-info-client-node

API Client wrapper for Ordnance Survey Places Postcode API.

Build Status
MIT license
Greenkeeper badge

Usage

Authentication

You will need an API key for OS Places API - Capture and Verification. You can get one by emailing platforms@digital.justice.gov.uk 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')

Current Tags

  • 1.0.6                                ...           latest (6 months ago)

6 Versions

  • 1.0.6                                ...           6 months ago
  • 1.0.4                                ...           a year ago
  • 1.0.3                                ...           a year ago
  • 1.0.2                                ...           a year ago
  • 1.0.1                                ...           a year ago
  • 1.0.0                                ...           a year ago
Downloads
Today 0
This Week 0
This Month 0
Last Day 0
Last Week 6
Last Month 6
Dependencies (2)
Dev Dependencies (16)
Dependents (0)
None

Copyright 2014 - 2016 © taobao.org |