companies-house-api-2023
v1.0.2
Published
This service will do a companies house lookup for a registered UK company
Downloads
3
Readme
Companies House
An ES6 Node.js library for the Companies House API
Installation instructions
Run npm install --save companies-house-api-2023
Usage
First you will need to create an account on companies house and get an API Key
Then you will need to include the library
const CHA = require('companies-house-api-2023');
const cha = new CHA('YOUR_API_KEY');
Here is an example
cha.searchForCompanyById(companyID).then(result => {
console.log(result);
}).catch(err => {
console.log(err);
});
For a full list of response formats please visit Companies House API Docs
Search Methods
searchForCompanyById(id)
//These methods can take an optional second argument which
//is an integer limit of how many results you want back
searchForCompanyByGenericTerm(query)
searchAll(query)
searchForOfficer(query)
searchForDisqualifiedOfficer(query)
Profile Methods
returnProfileBy(companyNumber)