TradeMe APItrademe.co.nz ↗

"""Walkthrough: TradeMe Property Listings — search properties across New Zealand."""
from parse_apis.trademe_property_listings_api import TradeMe, PropertyType, PropertyNotFound

client = TradeMe()

# List all regions to discover the locality hierarchy
for region in client.regions.list(limit=3):
    print(region.name, f"({len(region.districts)} districts)")

# Search for houses in Christchurch with bedroom/price filters
for prop in client.properties.search(
    location="/property/residential/sale/canterbury/christchurch-city",
    property_type=PropertyType.HOUSE,
    bedrooms_min=3,
    price_max=900000,
    limit=5,
):
    print(prop.title, prop.price_display, prop.bedrooms, prop.suburb)

# Drill into one result
listing = client.properties.search(
    location="/property/residential/sale/auckland",
    property_type=PropertyType.APARTMENT,
    limit=1,
).first()
if listing:
    print(listing.title, listing.address, listing.latitude, listing.longitude)

# Typed error handling
try:
    results = client.properties.search(
        location="/property/residential/sale/canterbury/christchurch-city",
        search_string="pool",
        limit=3,
    )
    for prop in results:
        print(prop.listing_id, prop.title, prop.price_display)
except PropertyNotFound as exc:
    print(f"Not found: {exc}")

print("exercised: regions.list / properties.search (multiple filters, drill-down, error handling)")