Search by 
mariankustusch / regon-api
GUS Regon API
2.0.1
2025-08-19 10:47 UTC
Requires
- php: >=7.2
- ext-dom: *
- ext-json: *
- ext-simplexml: *
- ext-soap: *
- gregwar/cache: ^1
- laminas/laminas-json: ^3
- mrcnpdlk/lib-configuration: ^0
- mrcnpdlk/lib-exception: ^0
- mrcnpdlk/lib-mapper: ^0
- myclabs/php-enum: ^1
- psr/log: ^3
- psr/simple-cache: ^3
Requires (Dev)
This package is auto-updated.
Last update: 2025-09-19 11:01:40 UTC
README
REGON API - Polish companies database v2
Installation
Install the latest version with composer
composer require mariankustusch/regon-api
API uses BIR 1.1
Basic usage
Configuration
Available options:
| Parameter name | Description | Is required |
|---|---|---|
| password | Password to REGON api | YES |
| wsdl | path to WSDL | NO |
| location | path do SVC location | NO |
| cacheDir | path do cache directory | NO (system dir cache) |
| cacheTtl | cache ttl [sec] | NO (60 sec) |
Creating instance
$oConfig = new Mrcnpdlk\Api\Regon\Config([ 'password' => 'my_password', ]); $oNativeApi = new \Mrcnpdlk\Api\Regon\NativeApi($oConfig); $oApi = new \Mrcnpdlk\Api\Regon\Api($oConfig);
NativeApi
NativeApi class implements native GUS methods such like:
- Zaloguj()
- Wyloguj()
- GetValue(ValueEnum $param)
- DaneSzukajPodmioty( string $regon = null, string $nip = null, string $krs = null, array $tRegon = [], array $tNip = [], array $tKrs = [])
- DanePobierzRaportZbiorczy(string $date, ReportCompactEnum $report)
- DanePobierzPelnyRaport(string $regon, ReportFullEnum $report)
Api
Api class implements usable methods based on NativeApi class.
- searchByNip()
- searchByKrs()
- searchByRegon()
- getPKD()
- getReport()