PHPackages                             marcingladkowski/gus-regon-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. marcingladkowski/gus-regon-bundle

ActiveSymfony-bundle[API Development](/categories/api)

marcingladkowski/gus-regon-bundle
=================================

Symfony bundle for GUS (Central Statistical Office) REGON API integration - Polish business registry lookup

0.5.1(3mo ago)00MITPHPPHP >=8.2CI passing

Since Jan 8Pushed 3mo agoCompare

[ Source](https://github.com/MarcinGladkowski/gus-regon-bundle)[ Packagist](https://packagist.org/packages/marcingladkowski/gus-regon-bundle)[ RSS](/packages/marcingladkowski-gus-regon-bundle/feed)WikiDiscussions main Synced 1mo ago

READMEChangelogDependencies (15)Versions (8)Used By (0)

GUS REGON Bundle for Symfony
============================

[](#gus-regon-bundle-for-symfony)

A Symfony bundle for integrating with the Polish GUS (Central Statistical Office) REGON API. This bundle provides easy access to business registry data for Polish companies.

Features
--------

[](#features)

- 🔍 **Business Lookup**: Search for companies by NIP (Tax ID) or REGON number
- 📊 **Complete Data**: Retrieve comprehensive business information including addresses, PKD codes, and more
- ✅ **Validation**: Built-in NIP and REGON number validators
- 🚀 **Easy Integration**: Simple Symfony service integration
- 💾 **Caching**: Optional caching support for API responses
- 🔒 **Type Safety**: Full PHP 8.2+ type declarations and DTOs

Requirements
------------

[](#requirements)

- PHP >= 8.2
- Symfony >= 7.0
- GUS API credentials (user key)

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

[](#installation)

```
composer require marcingladkowski/gus-regon-bundle
```

Configuration
-------------

[](#configuration)

Register the bundle in your `config/bundles.php`:

```
return [
    // ...
    GusBundle\GusBundle::class => ['all' => true],
];
```

Configure your GUS API credentials in `config/packages/gus.yaml`:

```
gus:
    api_key: '%env(GUS_API_KEY)%'
    environment: 'production' # or 'test'
    cache:
        enabled: true
        ttl: 3600
```

Set your API key in `.env`:

```
GUS_API_KEY=your_gus_api_key_here
```

Usage
-----

[](#usage)

### Basic Company Lookup

[](#basic-company-lookup)

```
use GusBundle\Client\RegonClientInterface;
use GusApi\SearchReport;

class YourController
{
    public function __construct(
        private RegonClientInterface $gusClient
    ) {}

    public function lookup(string $nip): Response
    {
        $reports = $this->gusClient->getByNip($nip);

        foreach ($reports as $report) {
            /** @var SearchReport $report */
            $name = $report->getName();
            $regon = $report->getRegon();

            // ...
        }
    }
}
```

Data Transfer Objects
---------------------

[](#data-transfer-objects)

The bundle provides comprehensive DTOs for structured data:

- `BusinessDataDTO`: Main business entity data
- `AddressDTO`: Address information
- `PkdCodeDTO`: PKD (Polish Classification of Activities) codes

Testing
-------

[](#testing)

```
composer install
vendor/bin/phpunit
```

Documentation
-------------

[](#documentation)

For detailed documentation, see the [docs](docs/) directory:

- [Example Companies Data](docs/EXAMPLE_COMPANIES.md)
- [Contributing Guide](CONTRIBUTING.md)

License
-------

[](#license)

MIT License. See [LICENSE](LICENSE) file for details.

Credits
-------

[](#credits)

Created by [Marcin Gladkowski](https://github.com/MarcinGladkowski)

Uses the [gusapi/gusapi](https://github.com/johnzuk/GusApi) library for GUS API communication.

Support
-------

[](#support)

- 🐛 [Report Issues](https://github.com/MarcinGladkowski/gus-regon-bundle/issues)
- 💬 [Discussions](https://github.com/MarcinGladkowski/gus-regon-bundle/discussions)

###  Health Score

33

—

LowBetter than 75% of packages

Maintenance78

Regular maintenance activity

Popularity0

Limited adoption so far

Community6

Small or concentrated contributor base

Maturity41

Maturing project, gaining track record

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

Total

7

Last Release

116d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/9f230178cf54e906cf8240284f85312a65a943196e3a39dfdf979af903dcd080?d=identicon)[MarcinGladkowski](/maintainers/MarcinGladkowski)

---

Top Contributors

[![MarcinGladkowski](https://avatars.githubusercontent.com/u/19622673?v=4)](https://github.com/MarcinGladkowski "MarcinGladkowski (36 commits)")

---

Tags

apisymfonybundleregonGUSpolandBusiness Registry

###  Code Quality

TestsPHPUnit

Static AnalysisPHPStan

Code StylePHP CS Fixer

Type Coverage Yes

### Embed Badge

![Health badge](/badges/marcingladkowski-gus-regon-bundle/health.svg)

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

###  Alternatives

[sylius/sylius

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

8.4k5.6M650](/packages/sylius-sylius)[sulu/sulu

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

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

A PHP implementation of a SAML 2.0 service provider and identity provider.

1.1k12.4M193](/packages/simplesamlphp-simplesamlphp)[shopware/platform

The Shopware e-commerce core

3.3k1.5M3](/packages/shopware-platform)[kreait/firebase-bundle

Symfony Bundle for the Firebase Admin SDK

1534.7M2](/packages/kreait-firebase-bundle)[shopware/core

Shopware platform is the core for all Shopware ecommerce products.

595.2M386](/packages/shopware-core)

PHPackages © 2026

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