plannexus 0.1.0

Official Python client for the PlanNexus planning data API.

PlanNexus Python SDK

Official Python client for the PlanNexus planning data API — access live planning applications from 100+ UK local authorities through one consistent interface.

Install

pip install plannexus

Requires Python 3.10+. Depends only on httpx.

Usage

Synchronous

from plannexus import PlanNexus

with PlanNexus(api_key="pn_live_...") as client:
    # Full-text + structured search
    result = client.applications.search(q="extension", postcode="SW1", per_page=10)
    for app in result["data"]:
        print(app["reference"], "-", app["address"])

    # Nearby (radius in metres)
    nearby = client.applications.nearby(lat=51.509, lng=-0.118, radius=500)

    # Single record with full detail
    full = client.applications.get(app["id"])

Asynchronous

import asyncio
from plannexus import AsyncPlanNexus

async def main():
    async with AsyncPlanNexus(api_key="pn_live_...") as client:
        result = await client.applications.search(postcode="SW1")
        print(f"Matched {result['meta']['total']} applications")

asyncio.run(main())

Rate limits & retries

The client automatically retries 429 Too Many Requests up to 3 times, honouring the Retry-After header when present. After retries are exhausted a RateLimitError is raised with the .retry_after attribute.

from plannexus import PlanNexus, RateLimitError

try:
    client.applications.search(...)
except RateLimitError as e:
    print(f"Still rate-limited; hint was {e.retry_after}s")

Error handling

Any non-2xx (other than handled 429s) raises PlanNexusError with .status_code, .detail, and .body populated from the response.

Links

• API reference
• Coverage
• Source