@hmcts/postcodeinfo-client
MoJ postcode lookup client
Last updated 2 years ago by jenkins-reform-hmcts .
MIT · Repository · Bugs · Original npm · Tarball · package.json
$ cnpm install @hmcts/postcodeinfo-client 
SYNC missed versions from official npm registry.

postcode-info-client-node

API Client wrapper for MoJ Postcode Info API which contains public sector information licensed under the Open Government License v2.0

Build Status
MIT license
Greenkeeper badge

Usage

Authentication

You will need an authentication token ('auth token'). If you're using MoJ DS's Postcode Info server, 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

If you're running your own server, see https://github.com/ministryofjustice/postcodeinfo#auth_tokens for instructions on how to set a token up.

Quick start

$ yarn add @hmcts/postcodeinfo-client

Typescript:

import { PostcodeInfoClient  } from '@hmcts/postcodeinfo-client'

new PostcodeInfoClient('<token here>').lookupPostcode('SN15NB')

  • Javascript -
const PostcodeInfoClient = require('@hmcts/postcodeinfo-client').PostcodeInfoClient

new PostcodeInfoClient('<token here>').lookupPostcode('SN15NB')

Current Tags

  • 1.1.0                                ...           latest (2 years ago)

3 Versions

  • 1.1.0                                ...           2 years ago
  • 1.0.0                                ...           2 years ago
  • 0.0.1                                ...           2 years ago
Downloads
Today 0
This Week 0
This Month 0
Last Day 0
Last Week 3
Last Month 10
Dependencies (2)
Dev Dependencies (16)
Dependents (0)
None

Copyright 2014 - 2016 © taobao.org |