Skip to main content

Python package for interacting with the Crossroads Bank for Enterprises (CBE, BCE, KBO, ZDU)

Project description

CBE - Crossroads Bank for Enterprises Python Package

GitHub Repository: https://github.com/azizo-b/CBE

The CBE package provides a Python interface to work with the Crossroads Bank for Enterprises (CBE), also known as:

  • Kruispuntbank van Ondernemingen (KBO) in Dutch
  • Banque-Carrefour des Entreprises (BCE) in French
  • Zentrale Datenbank der Unternehmen (ZDU) in German

Features

  • Authenticate with CBE Open Data Portal: Log in to the CBE Open Data portal using your credentials.
  • List Available Extracts: Retrieve a list of available data extracts (e.g., Full or Update).
  • Download Extracts: Download specific or the latest data extracts as ZIP files.
  • Load CBE Open Data: Load data from ZIP files.
  • Efficient Querying: Data is loaded into an SQLite database for fast and efficient querying.
  • Query Enterprise Data: Retrieve enterprise details, denominations, addresses, activities, contacts, and more.
  • Code Table Lookups: Replace code-based fields with human-readable descriptions using CBE code tables.
  • Public Search Mimicry: Mimic the data structure available on the CBE Public Search website.

Installation

You can install the package via pip:

pip install cbe

Quick Start

Option 1: Authenticate and Download Extracts Using Python

You can use the CBEOpenDataPortal class to authenticate with the CBE Open Data portal and download the data extract directly in Python:

from cbe import CBEOpenData, CBEOpenDataPortal

# Initialize the portal class
portal = CBEOpenDataPortal(username="your_username", password="your_password")

# List available extracts
extracts = portal.list_available_extracts()
for extract in extracts:
    print(f"Extract: {extract}")

# Download the latest extract
zip_path = portal.download_zip(download_dir="data")

# Initialize the CBEOpenData class with the downloaded ZIP file
cbe = CBEOpenData(zip_path=zip_path)

# Search for an enterprise
enterprise_info = cbe.search("1234.567.890")
print(enterprise_info)

Option 2: Manually Download the ZIP File

Alternatively, you can manually download the ZIP file from the CBE Open Data Portal and pass the path to the CBEOpenData class:

from cbe import CBEOpenData

# Initialize the CBEOpenData class with the path to the manually downloaded ZIP file
cbe = CBEOpenData(zip_path="path/to/KboOpenData_0133_2025_03_Full.zip")

# Search for an enterprise
enterprise_info = cbe.search("1234.567.890")
print(enterprise_info)

Documentation

For detailed documentation, including examples and API reference, visit the CBE package Documentation.

Links

Contributing

Contributions are welcome! If you'd like to contribute, please open an issue or submit a pull request.

License

This project is licensed under the MIT License. See the LICENSE file for details.

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

cbe-0.1.8.tar.gz (12.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

cbe-0.1.8-py3-none-any.whl (12.3 kB view details)

Uploaded Python 3

File details

Details for the file cbe-0.1.8.tar.gz.

File metadata

  • Download URL: cbe-0.1.8.tar.gz
  • Upload date:
  • Size: 12.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for cbe-0.1.8.tar.gz
Algorithm Hash digest
SHA256 644cb718aca552e1a21644bff13f6b1fe56ae77390f78159964f9d8a4a385c6d
MD5 61e5ea9e6c894c3be2ad392d9cdaa2d8
BLAKE2b-256 236dc558807e494aed365e08e3ea225e752c4b036928f9d827e38132e0e202e6

See more details on using hashes here.

File details

Details for the file cbe-0.1.8-py3-none-any.whl.

File metadata

  • Download URL: cbe-0.1.8-py3-none-any.whl
  • Upload date:
  • Size: 12.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for cbe-0.1.8-py3-none-any.whl
Algorithm Hash digest
SHA256 d887132b4c637d83ad47b941cf512362c7f25f5ce9fc5ed2481e39551352e26b
MD5 a74fca422e6a22bf249432bf759e8ef2
BLAKE2b-256 83c2dbd9257795f4acaa6a25ce07eb2630ad92345613c5a647a2be212ef45f12

See more details on using hashes here.

Supported by

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