rudashi/gusapi

PHP GUS API library.

Maintainers

Details

github.com/rudashi/GusApi

Homepage

Source

Issues

Installs: 165

Dependents: 0

Suggesters: 0

Security: 0

Stars: 4

Watchers: 1

Forks: 0

Open Issues: 0

pkg:composer/rudashi/gusapi

v1.0.3 2025-01-21 07:49 UTC

Requires

Requires (Dev)

ISC 13806bfa3ee685f8eed0c02880d03ea4555dd4c7

apilaravelregonnipGUSCEIDGkrsBIR1bir1.1birsisp-2

This package is auto-updated.

Last update: 2025-10-16 06:01:21 UTC

README

GitHub GitHub repo size GitHub Workflow Status

PHP GUS API is a wrapper to get information from Portal API GUS based on official BIR1 API.
Official API REGON documentation.

Installation

Use Composer, to install:

composer require rudashi/gusapi

Supported Versions

Version PHP version BIR service version
1.0.2 ^8.2 BIR1.1 (available since May 2019)
1.0.1 ^8.1 BIR1.1 (available since May 2019)
--- --- BIR1 (available from 2015)

General usage

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

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

$api->logout();

Methods

BIR Method Parameter PHP method Description
Zaloguj login Login with user key
Wyloguj logout Termination of session activity
--- isLogged Verification if the user is logged in
--- getSessionId Returns the session identifier
--- setSessionId Sets the session identifier
DaneSzukajPodmioty Krs getByKrs Searches the REGON database looking for a record by KRS identifier
DaneSzukajPodmioty Krsy getByKrses Searches the REGON database looking for records using several KRS identifiers
DaneSzukajPodmioty Nip getByNip Searches the REGON database looking for a record by NIP identifier
DaneSzukajPodmioty Nipy getByNips Searches the REGON database looking for records using several NIP identifiers
DaneSzukajPodmioty Regon getByRegon Searches the REGON database looking for a record by REGON identifier
DaneSzukajPodmioty Regony14zn getByRegons Searches the REGON database looking for records using several 9char REGON identifiers
DaneSzukajPodmioty Regony9zn getByRegons14 Searches the REGON database looking for records using several 14char REGON identifiers
DanePobierzPelnyRaport getFullReport Fetches data regarding an activity registered in CEIDG or a legal entity
DanePobierzRaportZbiorczy --- ---
GetValue StanDanych dataStatus Returns the status date
GetValue KomunikatKod getMessageCode Returns the message code
GetValue KomunikatTresc --- ---
GetValue StatusSesji getSessionStatus Returns the session status
GetValue StatusUslugi getServiceStatus Returns the service status
GetValue KomunikatUslugi getServiceMessage Returns the service message

Authors