Skip to main content

GUS REGON Internet Database Client

Project description

GUS (Główny Urząd Statystyczny) REGON Internet Database client which allows to get detailed information about company based on NIP, Regon or KRS number.

It requires an API key to the BIR1 service.

Note: Currently django-gusregon package is outdated and should be replaced by gusregon.

Quickstart

Install the package via pip:

pip install gusregon

Usage

Returns the business address

from gusregon import GUS

gus = GUS(api_key='my_api_key')
gus.get_address(nip='1112223344')

output

{
    'name': 'REGON SYSTEMS SPÓŁKA AKCYJNA',
    'street_address': 'ul. Tęczowa 14',
    'postal_code': '35-322',
    'city': 'Rzeszów'
}

Returns PKD codes

gus.get_pkd(nip='1112223344')

output

[
    {
        'code': '6201Z',
        'name': 'DZIAŁALNOŚĆ ZWIĄZANA Z OPROGRAMOWANIEM',
        'main': True
    },
    {
        'code': '6312Z':
        'name': 'DZIAŁALNOŚĆ PORTALI INTERNETOWYCH',
        'main': False
    },
    ...
]

Returns all data from BIR1 service

gus.search(nip='1112223344')

output

{
    'adsiedzkraj_symbol': 'PL',
    'datazawieszeniadzialalnosci': '',
    'jednosteklokalnych': '0',
    'rodzajrejestruewidencji_symbol': '138',
    'adkorulica_nazwa': '',
    ...
    'adkorpowiat_symbol': '63',
    'datawpisudoregon': '2012-06-01',
    'rodzajrejestruewidencji_nazwa': 'REJESTR PRZEDSIĘBIORCÓW',
    'adsiedznumernieruchomosci': '14',
    'adkorkodpocztowy': '35322',
    'adsiedzkraj_nazwa': 'POLSKA',
    'adsiedzulica_symbol': '10013',
    'adsiedzkodpocztowy': '35322',
}

Sandbox mode for testing:

from gusregon import GUS

gus = GUS(sandbox=True)
gus.get_address(nip='1112223344')

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
gusregon-1.1.3.tar.gz (5.3 kB) Copy SHA256 hash SHA256 Source None Feb 4, 2018

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page