PHPackages                             mmierzynski/gus-api-bundle - 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. mmierzynski/gus-api-bundle

ActiveLibrary[API Development](/categories/api)

mmierzynski/gus-api-bundle
==========================

Symfony bundle that allows to search data in GUS database

0.2(3y ago)02MITPHPPHP >=7.1

Since Aug 27Pushed 3y ago1 watchersCompare

[ Source](https://github.com/MMierzynski/gus-api-bundle)[ Packagist](https://packagist.org/packages/mmierzynski/gus-api-bundle)[ RSS](/packages/mmierzynski-gus-api-bundle/feed)WikiDiscussions main Synced 1w ago

READMEChangelog (2)Dependencies (6)Versions (4)Used By (0)

Gus Api Bundle
==============

[](#gus-api-bundle)

Description
-----------

[](#description)

Symfony 6 Bundle that allows to get information from [REGON GUS API](https://api.stat.gov.pl/Home/RegonApi)

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

[](#installation)

`composer require mmierzynski/gus-api-bundle`

Usage
-----

[](#usage)

### Configuration

[](#configuration)

```
# config/packages/gus_api.yaml

gus_api:
  regon:
    env: test
    api_key: 'abcde12345abcde12345'
```

- env - **\[Required\]** GUS API environment. Accepted values: ***test***, ***prod***
- api\_key - **\[Required\]** Your API key. For test env you can use: ***abcde12345abcde12345***

### Usage

[](#usage-1)

#### Login user

[](#login-user)

```
use MMierzynski\GusApi\Client\RegonApiClient;
use MMierzynski\GusApi\Exception\InvalidUserCredentialsException;

public function index(RegonApiClient $client): JsonResponse
{
    if (!$client->isUserLogged()){
        try{
            $accessKey = $client->login();
        } catch (InvalidUserCredentialsException $credentialsException) {
            // do something
        }
    }

    ...
}
```

#### Search for company

[](#search-for-company)

```
use MMierzynski\GusApi\Client\RegonApiClient;
use MMierzynski\GusApi\Model\DTO\Request\SearchCompanyParams;

public function index(RegonApiClient $client): JsonResponse
{
    ...
    $searchParams = new SearchCompanyParams(Nip:'8992689516');
    $company = $client->searchForCompany($accessKey, $searchParams);
    ...
}
```

#### Get full report

[](#get-full-report)

```
use MMierzynski\GusApi\Client\RegonApiClient;

public function index(RegonApiClient $client): JsonResponse
{
    ...
    $fullReport = $client->getFullReport(
        $accessKey,
        '000331501',
        'BIR11OsPrawna'
    );
    ...
}
```

#### Get summary report

[](#get-summary-report)

```
use MMierzynski\GusApi\Client\RegonApiClient;

public function index(RegonApiClient $client): JsonResponse
{
    ...
    $reportDate = (new DateTimeImmutable())->setDate(2014, 11, 7);
    $summaryReport = $client->getSummaryReport(
        $accessKey,
        'BIR11NowePodmiotyPrawneOrazDzialalnosciOsFizycznych',
        $reportDate
    );
    ...
}
```

###  Health Score

16

—

LowBetter than 5% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity2

Limited adoption so far

Community4

Small or concentrated contributor base

Maturity34

Early-stage or recently created project

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 ~63 days

Total

2

Last Release

1297d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/99ecbc4af835eeddadc435c413a4a564efe25cc7f0a39d5f7b52b90146b7b259?d=identicon)[mmierzynski](/maintainers/mmierzynski)

###  Code Quality

TestsPHPUnit

Code StylePHP CS Fixer

### Embed Badge

![Health badge](/badges/mmierzynski-gus-api-bundle/health.svg)

```
[![Health](https://phpackages.com/badges/mmierzynski-gus-api-bundle/health.svg)](https://phpackages.com/packages/mmierzynski-gus-api-bundle)
```

###  Alternatives

[sylius/sylius

E-Commerce platform for PHP, based on Symfony framework.

8.4k5.6M651](/packages/sylius-sylius)[shopware/platform

The Shopware e-commerce core

3.3k1.5M3](/packages/shopware-platform)[sulu/sulu

Core framework that implements the functionality of the Sulu content management system

1.3k1.3M152](/packages/sulu-sulu)[shopware/core

Shopware platform is the core for all Shopware ecommerce products.

595.2M386](/packages/shopware-core)[open-dxp/opendxp

Content & Product Management Framework (CMS/PIM)

7310.3k29](/packages/open-dxp-opendxp)[stfalcon-studio/api-bundle

Base classes and helper services to build API application via Symfony.

1032.1k](/packages/stfalcon-studio-api-bundle)

PHPackages © 2026

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