11# Kadaster - KIK Inzage API Python client
22
3- [ ![ PyPI] ( https://img.shields.io/pypi/v/kadaster-kik-inzage-api-python -client.svg )] [ pypi status ]
4- [ ![ Status] ( https://img.shields.io/pypi/status/kadaster-kik-inzage-api-python -client.svg )] [ pypi status ]
5- [ ![ Python Version] ( https://img.shields.io/pypi/pyversions/kadaster-kik-inzage-api-python -client )] [ pypi status ]
6- [ ![ License] ( https://img.shields.io/pypi/l/kadaster-kik-inzage-api-python -client )] [ license ]
3+ [ ![ PyPI] ( https://img.shields.io/pypi/v/kadaster-kikinzage -client.svg )] [ pypi status ]
4+ [ ![ Status] ( https://img.shields.io/pypi/status/kadaster-kikinzage -client.svg )] [ pypi status ]
5+ [ ![ Python Version] ( https://img.shields.io/pypi/pyversions/kadaster-kikinzage -client )] [ pypi status ]
6+ [ ![ License] ( https://img.shields.io/pypi/l/kadaster-kikinzage -client )] [ license ]
77
88[ ![ Read the documentation at https://kadaster-kik-inzage-api-python-client.readthedocs.io/ ] ( https://img.shields.io/readthedocs/kadaster-kik-inzage-api-python-client/latest.svg?label=Read%20the%20Docs )] [ read the docs ]
99[ ![ Tests] ( https://github.com/foarsitter/kadaster-kik-inzage-api-python-client/workflows/Tests/badge.svg )] [ tests ]
1212[ ![ pre-commit] ( https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white )] [ pre-commit ]
1313[ ![ Black] ( https://img.shields.io/badge/code%20style-black-000000.svg )] [ black ]
1414
15- [ pypi status ] : https://pypi.org/project/kadaster-kik-inzage-api-python -client/
15+ [ pypi status ] : https://pypi.org/project/kadaster-kikinzage -client/
1616[ read the docs ] : https://kadaster-kik-inzage-api-python-client.readthedocs.io/
1717[ tests ] : https://github.com/foarsitter/kadaster-kik-inzage-api-python-client/actions?workflow=Tests
1818[ codecov ] : https://app.codecov.io/gh/foarsitter/kadaster-kik-inzage-api-python-client
2121
2222## Features
2323
24- - TODO
24+ - Fully typed client for the [ Kadaster KIK Inzage API] version 6.0
25+ - Asyncio support with httpx
2526
2627## Requirements
2728
28- - TODO
29+ - Pydantic V2
30+ - httpx
2931
3032## Installation
3133
3234You can install _ Kadaster - KIK Inzage API Python client_ via [ pip] from [ PyPI] :
3335
3436``` console
35- $ pip install kadaster-kik-inzage-api-python -client
37+ $ pip install kadaster-kikinzage -client
3638```
3739
3840## Usage
3941
40- Please see the [ Command-line Reference] for details.
42+ ``` python
43+
44+ import os
45+ from kikinzage.client import DefaultClient,AsyncClient
46+ from kikinzage.models import Formaat, Eigendomsinformatie
47+
48+
49+ def create_client (client_class ):
50+ client = client_class(
51+ # required
52+ password = os.getenv(" KIK_PASSWORD" ),
53+ username = os.getenv(" KIK_PASSWORD" ),
54+ # for testing
55+ # base_url="https://service10.kadaster.nl/kik-inzage-eto/v6/"
56+ base_url = " https://service10.kadaster.nl/kik-inzage/v6/" ,
57+ # optional defaults added to each request when available
58+ formaat = Formaat.PDF_JSON ,
59+ klantreferentie = " Standaard klantreferentie" ,
60+ hyperlinkopproduct = True ,
61+ inkoopnummer = " Standaard inkoopnummer" ,
62+ gebruikeridentificatie = " Standaard gebruikeridentificatie" ,
63+ )
64+
65+ return client
66+
67+
68+ kik = create_client(DefaultClient)
69+
70+ info: Eigendomsinformatie = kik.eigendomsinformatie_postcode(" 4884ME" , " 16" )
71+
72+ async with create_client(AsyncClient) as kik:
73+ info_async: Eigendomsinformatie = await kik.eigendomsinformatie_kadastraalobjectidentificatie(" BRD01K:G:0000" , " 1" )
74+
75+ ```
4176
4277## Contributing
4378
@@ -63,6 +98,7 @@ This project was generated from [@cjolowicz]'s [Hypermodern Python Cookiecutter]
6398[ hypermodern python cookiecutter ] : https://github.com/cjolowicz/cookiecutter-hypermodern-python
6499[ file an issue ] : https://github.com/foarsitter/kadaster-kik-inzage-api-python-client/issues
65100[ pip ] : https://pip.pypa.io/
101+ [ kadaster kik inzage api ] : https://developer.kadaster.nl/schemas/-/categories/2669182
66102
67103<!-- github-only -->
68104
0 commit comments