regon v1.1.8

REGON

Polish README

REGON is Polish company registry. This library is an interface connecting to BIR1.1 service.

Instalation

npm i regon or yarn add regon

Usage

First you need to obtain REGON API key (instruction).

Then:

// Typescript import
import { Regon } from 'Regon';
// CommonJS require
const Regon = require('Regon');

const regon = new Regon({ key: 'api_key' }); // or new Regon({ dev: true }) for testing purposes, key not required

const searchParameters: ParametryWyszukiwania = {
	Krs?: string,
	Krsy?: string[],
	Nip?: string,
	Nipy?: string[],
	Regon?: string,
	Regony14zn?: string[],
	Regony9zn?: string[]
};

regon.getCompanyData(searchParameters) // returns Promise
	.then( companyInfo => ... );