Ideal Postcodes Python SDK

Call the Ideal Postcodes API from Python 3.12 or later with typed methods and Pydantic v2 response models. The client is synchronous and built on HTTPX.

pip install ideal-postcodes

from ideal_postcodes import IdealPostcodes

with IdealPostcodes("ak_test") as client:
    for address in client.postcodes("BR8 7RE"):
        print(address.line_1, address.post_town, address.uprn)

Create one client and reuse it; close it with with or close(). Path parameters are positional, everything else is keyword-only. Methods return the API's result as models: read attributes, or call model_dump() for a dictionary.

Scope