Simple node.js client library to Statistics Poland (GUS) information about companies api REGON
npm i bir1
import Bir from 'bir1'
const bir = new Bir()
await bir.login()
console.log(await bir.search({ nip: '5261040567' }))
/*
output:
{
regon: '011417295',
nip: '5261040567',
statusNip: null,
nazwa: 'T-MOBILE POLSKA SPÓŁKA AKCYJNA',
wojewodztwo: 'MAZOWIECKIE',
powiat: 'Warszawa',
gmina: 'Mokotów',
miejscowosc: 'Warszawa',
kodPocztowy: '02-674',
ulica: 'ul. Marynarska',
nrNieruchomosci: '12',
nrLokalu: null,
typ: 'P',
silosID: '6',
dataZakonczeniaDzialalnosci: null,
miejscowoscPoczty: 'Warszawa'
}
*/
• new Bir(options?)
| Name | Type | Notes |
|---|---|---|
options | Object | |
options.key? | string | production API key |
Note: by default it connects to non production GUS database using public default key. In order to connect to production database with current company data provide a key granted by GUS.
▸ login(): Promise<void>
Promise<void>
▸ search(query): Promise<any>
| Name | Type | Notes |
|---|---|---|
query | Object | |
query.nip? | string | |
query.regon? | string | |
query.krs? | string |
Promise<any>
▸ report(query): Promise<any>
| Name | Type | Notes |
|---|---|---|
query | Object | |
query.regon | string | |
query.report | string | e.g.: BIR11OsPrawna |
See BIR1 original documentation for more report types.
Promise<any>
▸ value(value): Promise<string>
| Name | Type |
|---|---|
value | string |
Promise<string>
FAQs
GUS REGON api client
The npm package bir1 receives a total of 195 weekly downloads. As such, bir1 popularity was classified as not popular.
We found that bir1 demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 0 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
PEP 770 proposes adding SBOM support to Python packages to improve transparency and catch hidden non-Python dependencies that security tools often miss.
Security News
Socket CEO Feross Aboukhadijeh discusses open source security challenges, including zero-day attacks and supply chain risks, on the Cyber Security Council podcast.
Security News
Research
Socket researchers uncover how threat actors weaponize Out-of-Band Application Security Testing (OAST) techniques across the npm, PyPI, and RubyGems ecosystems to exfiltrate sensitive data.