# @magicwrites/gus-api

> Service to communicate with Polish GUS

Latest version **1.0.9** (published 2022-12-15) · MIT license · 0 weekly downloads

## Install

```sh
npm install @magicwrites/gus-api
pnpm add @magicwrites/gus-api
yarn add @magicwrites/gus-api
bun add @magicwrites/gus-api
```

## 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.0.9 |
| Published | 2022-12-15 |
| First published | 2022-12-14 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >= 10 |
| Dependencies | 2 |
| Unpacked size | 85.6 KB |
| Known vulnerabilities | 0 (+2 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 0 |
| Maintainers | maciejmazur |

## Links

- npm: https://www.npmjs.com/package/@magicwrites/gus-api
- Repository: https://github.com/magicwrites/gus-api
- Issues: https://github.com/magicwrites/gus-api/issues
- npm.io page: https://npm.io/package/@magicwrites/gus-api

## Dependencies (2)

- [soap](https://npm.io/package/soap.md) ^0.37.0
- [fast-xml-parser](https://npm.io/package/fast-xml-parser.md) ^3.19.0

## Recent versions

- 1.0.9 (latest) — 2022-12-15
- 1.0.8 — 2022-12-14

## README

# Quickstart

## Installation

```bash
npm install @magicwrites/gus-api
```

## Example usage

```javascript
import { GusApiRegon } from '@magicwrites/gus-api';

const service = new GusApiRegon('YOUR_API_KEY');

const results = await service.search({
  Nip: '1234567890',
});

console.log('Results', results);
```

## Search params

| Name       | Example                       | Optional |
| ---------- | ----------------------------- | -------- |
| Nip        | 9471986146                    | true     |
| Krs        | 0000090577                    | true     |
| Regon      | 008376680 or 00000008376680   | true     |
| Krsy       | 0000090577,0000090577         | true     |
| Nipy       | 9471986146,9471986146         | true     |
| Regony14zn | 00000008376680,00000008376680 | true     |
| Regony9zn  | 008376680,008376680           | true     |

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