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.0.tar.gz (4.3 kB view details)

Uploaded Source

File details

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

File metadata

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

File hashes

Hashes for gusregon-1.1.0.tar.gz
Algorithm Hash digest
SHA256 6ecf04cb8324af0253ae0106102b1a42fd6b3c3c238b9a471f2600eba3b4fb13
MD5 dbce8a02d152480740e9e6d6ba2f4d4a
BLAKE2b-256 e923ff105c7931de9654100cc66d56348385e41e7ec7b587d877442fba5d3f63

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