Skip to main content

GUS REGON Internet Database Client

Project description

https://img.shields.io/circleci/project/bogdal/gusregon/master.svg https://img.shields.io/pypi/v/gusregon.svg

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

from gusregon import GUS

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

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

# returns all data from BIR1 service
gus.search(nip='1112223344')

{
    '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.

Source Distribution

gusregon-1.1.1.tar.gz (4.6 kB view details)

Uploaded Source

File details

Details for the file gusregon-1.1.1.tar.gz.

File metadata

  • Download URL: gusregon-1.1.1.tar.gz
  • Upload date:
  • Size: 4.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for gusregon-1.1.1.tar.gz
Algorithm Hash digest
SHA256 243bcbb54a46eaefb431bd9ceedc812327cb298c621148ca74b080ac62505201
MD5 4cb3ef801967dbbaea946a8186c201f6
BLAKE2b-256 4d52ad9ddbddc1e77ec3b9cc169597a0eaf9cc75d314d2c55b1e90007e84369f

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page