# regon

> Node interface for REGON API

Latest version **1.1.8** (published 2020-04-26) · MIT license · 0 weekly downloads

## Install

```sh
npm install regon
pnpm add regon
yarn add regon
bun add regon
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.1.8 |
| Published | 2020-04-26 |
| First published | 2020-03-07 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 20.2 KB |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| Author | Mustafa Ucuncu |
| Maintainers | mustafa115 |
| Keywords | regon, nip, krs, gus |

## Links

- npm: https://www.npmjs.com/package/regon
- Repository: https://github.com/mustaf115/regon
- Homepage: https://github.com/mustaf115/regon#readme
- Issues: https://github.com/mustaf115/regon/issues
- npm.io page: https://npm.io/package/regon

## Dependencies (2)

- [xml2js](https://npm.io/package/xml2js.md) ^0.4.23
- [node-fetch](https://npm.io/package/node-fetch.md) ^2.6.0

## Recent versions

- 1.1.8 (latest) — 2020-04-26
- 1.1.7 — 2020-03-18
- 1.1.6 — 2020-03-18
- 1.1.5 — 2020-03-18
- 1.1.4 — 2020-03-18
- 1.1.3 — 2020-03-17
- 1.1.2 — 2020-03-17
- 1.1.1 — 2020-03-17
- 1.1.0 — 2020-03-10
- 1.0.1 — 2020-03-07

## README

# REGON
[Polish README](https://github.com/mustaf115/regon/blob/master/README_PL.md)

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](https://api.stat.gov.pl/Home/RegonApi?lang=en)).

Then:
```js
// 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 => ... );
```

---
_Source: https://npm.io/package/regon · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._