PHPackages                             rudashi/gusapi - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [API Development](/categories/api)
4. /
5. rudashi/gusapi

ActiveLibrary[API Development](/categories/api)

rudashi/gusapi
==============

PHP GUS API library.

v1.0.4(4mo ago)4287ISCPHPPHP ^8.2 || ^8.3CI passing

Since Dec 8Pushed 2mo ago1 watchersCompare

[ Source](https://github.com/rudashi/GusApi)[ Packagist](https://packagist.org/packages/rudashi/gusapi)[ Docs](https://github.com/rudashi/gusapi)[ RSS](/packages/rudashi-gusapi/feed)WikiDiscussions master Synced 1mo ago

READMEChangelog (3)Dependencies (1)Versions (7)Used By (0)

PHP GUS API
===========

[](#php-gus-api)

[![GitHub](https://camo.githubusercontent.com/0245432547f62c248c4cb8656494d1a49dfaa7d5f65bda6af3bf8385ee71677e/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f6c6963656e73652f727564617368692f677573617069)](https://camo.githubusercontent.com/0245432547f62c248c4cb8656494d1a49dfaa7d5f65bda6af3bf8385ee71677e/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f6c6963656e73652f727564617368692f677573617069)[![GitHub repo size](https://camo.githubusercontent.com/b46ce46fae21e4da1b4668886d325d3dca42d10a98a3966527da5eef6ae9a05d/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f7265706f2d73697a652f727564617368692f677573617069)](https://camo.githubusercontent.com/b46ce46fae21e4da1b4668886d325d3dca42d10a98a3966527da5eef6ae9a05d/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f7265706f2d73697a652f727564617368692f677573617069)[![GitHub Workflow Status](https://camo.githubusercontent.com/b4f67e4e9f63a59cbf7f80ac724edb83176fb3e961168ad96557a344cc45b888/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f616374696f6e732f776f726b666c6f772f7374617475732f727564617368692f4775734170692f7068702e796d6c)](https://camo.githubusercontent.com/b4f67e4e9f63a59cbf7f80ac724edb83176fb3e961168ad96557a344cc45b888/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f616374696f6e732f776f726b666c6f772f7374617475732f727564617368692f4775734170692f7068702e796d6c)

PHP GUS API is a wrapper to get information from [Portal API GUS](https://api.stat.gov.pl/Home/RegonApi) based on official BIR1 API.
Official API REGON [documentation](https://api.stat.gov.pl/Home/RegonApi#menu3).

Installation
------------

[](#installation)

Use [Composer](https://getcomposer.org/), to install:

```
composer require rudashi/gusapi
```

Supported Versions
------------------

[](#supported-versions)

VersionPHP versionBIR service version1.0.2^8.2BIR1.1 (available since May 2019)1.0.1^8.1BIR1.1 (available since May 2019)------BIR1 (available from 2015)General usage
-------------

[](#general-usage)

```
$api = new \Rudashi\GusApi\GusApi('GUS API KEY');

$company = $api->login()->getByNip('xxx');

$api->logout();
```

Methods
-------

[](#methods)

BIR MethodParameterPHP methodDescriptionZalogujloginLogin with user keyWylogujlogoutTermination of session activity---isLoggedVerification if the user is logged in---getSessionIdReturns the session identifier---setSessionIdSets the session identifierDaneSzukajPodmiotyKrsgetByKrsSearches the REGON database looking for a record by KRS identifierDaneSzukajPodmiotyKrsygetByKrsesSearches the REGON database looking for records using several KRS identifiersDaneSzukajPodmiotyNipgetByNipSearches the REGON database looking for a record by NIP identifierDaneSzukajPodmiotyNipygetByNipsSearches the REGON database looking for records using several NIP identifiersDaneSzukajPodmiotyRegongetByRegonSearches the REGON database looking for a record by REGON identifierDaneSzukajPodmiotyRegony14zngetByRegonsSearches the REGON database looking for records using several 9char REGON identifiersDaneSzukajPodmiotyRegony9zngetByRegons14Searches the REGON database looking for records using several 14char REGON identifiersDanePobierzPelnyRaportgetFullReportFetches data regarding an activity registered in CEIDG or a legal entityDanePobierzRaportZbiorczy------GetValueStanDanychdataStatusReturns the status dateGetValueKomunikatKodgetMessageCodeReturns the message codeGetValueKomunikatTresc------GetValueStatusSesjigetSessionStatusReturns the session statusGetValueStatusUslugigetServiceStatusReturns the service statusGetValueKomunikatUslugigetServiceMessageReturns the service messageAuthors
-------

[](#authors)

- **Borys Żmuda** - Lead designer - [LinkedIn](https://www.linkedin.com/in/boryszmuda/), [Portfolio](https://rudashi.github.io/)

###  Health Score

46

—

FairBetter than 93% of packages

Maintenance81

Actively maintained with recent releases

Popularity19

Limited adoption so far

Community7

Small or concentrated contributor base

Maturity62

Established project with proven stability

 Bus Factor1

Top contributor holds 100% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~152 days

Recently: every ~161 days

Total

6

Last Release

130d ago

PHP version history (3 changes)v1.0.0PHP ^8.1

v1.0.2PHP ^8.2

v1.0.4PHP ^8.2 || ^8.3

### Community

Maintainers

![](https://www.gravatar.com/avatar/a2f436f983f0865fa6c1a1cabbf9909143ee48d1cf90ad66731657d85df77de5?d=identicon)[rudashi](/maintainers/rudashi)

---

Top Contributors

[![rudashi](https://avatars.githubusercontent.com/u/5038647?v=4)](https://github.com/rudashi "rudashi (31 commits)")

---

Tags

apilaravelregonnipGUSCEIDGkrsBIR1bir1.1birsisp-2

###  Code Quality

TestsPest

### Embed Badge

![Health badge](/badges/rudashi-gusapi/health.svg)

```
[![Health](https://phpackages.com/badges/rudashi-gusapi/health.svg)](https://phpackages.com/packages/rudashi-gusapi)
```

###  Alternatives

[gusapi/gusapi

Gus Api Library for PHP

1351.5M8](/packages/gusapi-gusapi)[joisarjignesh/bigbluebutton

BigBlueButton Server API Library for Laravel

162145.5k1](/packages/joisarjignesh-bigbluebutton)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)
