The RegonAPI Object

The RegonAPI is the main interface object between client and REGON SOAP server. It provides a searchData and dataDownloadFullReport methods allowing searching for business entities and fetching reports.

Configuring the client

To configure RegonAPI interface, attribute bir_version needs to be set to desired BIR version. You can initialize the object using the following code:

from RegonAPI import RegonAPI

# bir1 bir1.1 ...
api = RegonAPI(bir_version="bir1")

To see all available BIR versions click here BIR Versions

Authentication

To authenticate client with your API Key use authenticate method.

# This is an official key for testing
API_KEY = "abcde12345abcde12345"
api = RegonAPI(bir_version="bir1")
api.authenticate(key=API_KEY)

Want to get key for production? Check out Obtaining API Key