Skip to main content

Kadaster - KIK Inzage API Python client

Project description

Kadaster - KIK Inzage API Python client

PyPI Status Python Version License

Read the documentation at https://kadaster-kik-inzage-api-python-client.readthedocs.io/ Tests Codecov

pre-commit Black

Features

Requirements

  • Pydantic V2
  • httpx

Installation

You can install _ Kadaster - KIK Inzage API Python client_ via pip from PyPI:

$ pip install kadaster-kikinzage-client

Usage

import os
from kikinzage.client import DefaultClient,AsyncClient
from kikinzage.models import Formaat, Eigendomsinformatie


def create_client(client_class):
    client = client_class(
        # required
        password=os.getenv("KIK_PASSWORD"),
        username=os.getenv("KIK_PASSWORD"),
        # for testing
        # base_url="https://service10.kadaster.nl/kik-inzage-eto/v6/"
        base_url="https://service10.kadaster.nl/kik-inzage/v6/",
        # optional defaults added to each request when available
        formaat=Formaat.PDF_JSON,
        klantreferentie="Standaard klantreferentie",
        hyperlinkopproduct=True,
        inkoopnummer="Standaard inkoopnummer",
        gebruikeridentificatie="Standaard gebruikeridentificatie",
    )

    return client


kik = create_client(DefaultClient)

info: Eigendomsinformatie = kik.eigendomsinformatie_postcode("4884ME", "16")

async with create_client(AsyncClient) as kik:
    info_async: Eigendomsinformatie = await kik.eigendomsinformatie_kadastraalobjectidentificatie("BRD01K:G:0000", "1")

Contributing

Contributions are very welcome. To learn more, see the Contributor Guide.

License

Distributed under the terms of the MIT license, _ Kadaster - KIK Inzage API Python client_ is free and open source software.

Issues

If you encounter any problems, please file an issue along with a detailed description.

Credits

This project was generated from @cjolowicz's Hypermodern Python Cookiecutter template.

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

kadaster_kikinzage_client-0.3.0.tar.gz (16.6 kB view hashes)

Uploaded Source

Built Distribution

kadaster_kikinzage_client-0.3.0-py3-none-any.whl (23.0 kB view hashes)

Uploaded Python 3

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