Planning Portal APIplanningportal.co.uk ↗

"""Walkthrough: Planning Portal UK API — find your local planning authority and explore guidance."""
from parse_apis.planning_portal_uk_api import PlanningPortal, Path, PageNotFound

client = PlanningPortal()

# Look up the Local Planning Authority for a UK postcode.
lookup = client.postcodelookups.get(postcode="SW1A 2AA")
print(f"Postcode: {lookup.postcode}, Coordinates: ({lookup.coordinates.x}, {lookup.coordinates.y})")
for auth in lookup.lpa_lookup:
    print(f"  LPA: {auth.lpa_name} ({auth.lpa_code}), GLA: {auth.is_gla}")

# Get full authority details and its planning service URLs.
authority = client.authorities.get(lpa_code="X5990")
print(f"Authority: {authority.contact_information.name}")
print(f"  Email: {authority.contact_information.email_address}")
print(f"  Phone: {authority.contact_information.telephone_one}")

for url_item in authority.urls.list(limit=3):
    print(f"  Service: {url_item.name} -> {url_item.url}")

# List consent types available in England.
consent = client.consenttypes.list(limit=3).first()
if consent:
    print(f"First consent type: {consent.title} ({consent.slug})")

# Retrieve page content with typed-error handling.
try:
    page = client.pages.get(path=Path.PLANNING_PLANNING_APPLICATIONS)
    print(f"Page: {page.path}, template: {page.component_chunk_name}")
    print(f"  Description: {page.page_context.description}")
except PageNotFound as exc:
    print(f"Page not found: {exc}")

# Discover available guidance paths.
for p in client.pages.list_paths(limit=5):
    print(f"  Available path: {p}")

print("Exercised: postcodelookups.get / authorities.get / authority.urls.list / consenttypes.list / pages.get / pages.list_paths")