Terra Caribbean APIterracaribbean.com ↗

"""Walkthrough: Terra Caribbean SDK — search Caribbean properties, drill into details, estimate mortgages."""
from parse_apis.terra_caribbean_api import (
    TerraCaribbean, CountryCode, ListingType, Zoning, Country, PropertyNotFound
)

client = TerraCaribbean()

# List available locations
for loc in client.locations.list(limit=4):
    print(loc.name, loc.id)

# Search residential properties for sale in Barbados
listing = client.propertysummaries.search(
    country_code=CountryCode.BARBADOS,
    listing_type=ListingType.SALE,
    zoning=Zoning.RESIDENTIAL,
    limit=1,
).first()

# Drill into full property details from the summary
if listing:
    detail = listing.details()
    print(detail.title, detail.price, detail.reference_number)
    print(f"Photos: {len(detail.photos)}, Office: {detail.office_info.phone}")

# Calculate mortgage on a property
estimate = client.mortgageestimates.calculate(amount=200000, rate=5.5, years=20)
print(estimate.monthly_payment, estimate.total_payment, estimate.total_interest)

# Browse blog posts for Barbados using the Country enum
for post in client.blogposts.list(country=Country.BARBADOS, limit=3):
    print(post.title, post.date)

# List amenities available for filtering
for amenity in client.amenities.list(limit=5):
    print(amenity.name)

# Access parishes via location sub-resource
barbados = client.locations.list(limit=4).first()
if barbados:
    for parish in barbados.parishes.list(limit=5):
        print(parish.name)

# Typed error handling for missing property
try:
    client.properties.get(url="https://terracaribbean.com/INVALID/barbados/residential-sale/land/nonexistent/")
except PropertyNotFound as exc:
    print(f"Property not found: {exc.url}")

print("exercised: locations.list / propertysummaries.search / details / properties.get / mortgageestimates.calculate / blogposts.list / amenities.list / parishes.list")