WFRMLS Python Client¶

A comprehensive Python wrapper for the Wasatch Front Regional MLS (WFRMLS) API, providing easy access to all RESO-certified endpoints for real estate data integration.

🚀 Quick Navigation¶

📋 Quick Reference¶

Core Components¶

Common Patterns¶

from wfrmls import WFRMLSClient

# Initialize client
client = WFRMLSClient(bearer_token="your_token")

# Get active properties
properties = client.property.get_properties(
    top=10,
    filter_query="StandardStatus eq 'Active'"
)

from wfrmls.exceptions import WFRMLSError, NotFoundError

try:
    property_data = client.property.get_property("12345678")
    print(property_data["ParcelNumber"])
except NotFoundError:
    print("Property not found")
except WFRMLSError as e:
    print(f"API error: {e}")

# Complex queries with filtering and sorting
properties = client.property.get_properties(
    select=["ListingId", "ListPrice", "StandardStatus"],
    filter_query="ListPrice ge 200000 and ListPrice le 500000",
    orderby="ListPrice desc",
    top=50
)

🔧 Installation¶

Quick Setup¶

# Install via pip
pip install wfrmls

# Set up environment variable
export WFRMLS_BEARER_TOKEN="your_bearer_token_here"

First API Call¶

from wfrmls import WFRMLSClient

client = WFRMLSClient()  # Uses environment variable
data = client.property.get_properties(top=5)
print(f"Retrieved {len(data)} properties")

🎯 Key Features¶

🏗️ Core Resources¶

Complete access to primary MLS data:

• Properties - Residential and commercial listings with full details
• Members - Real estate agent profiles and contact information
• Offices - Brokerage data and office locations
• Open Houses - Scheduled showings and events

🔍 Advanced Queries¶

Powerful search and filtering capabilities:

• Geolocation Search - Radius and polygon-based property searches
• OData Queries - Complex filtering, sorting, and field selection
• Data Synchronization - Incremental updates and change tracking

⚡ Developer Experience¶

Built for production use:

• Type Safety: Full type hints and modern Python practices
• Error Handling: Comprehensive exception handling with clear messages
• Rate Limiting: Built-in handling for API rate limits and quotas
• Testing: 100% test coverage with comprehensive test suite

🌟 Real-World Applications¶

Property Search Portals¶

• Build consumer-facing property search websites
• Implement map-based property discovery
• Create advanced filtering and sorting interfaces

Market Analytics Dashboards¶

• Track market trends and pricing patterns
• Generate automated market reports
• Monitor inventory levels and days on market

CRM Integration¶

• Sync agent and office data with customer management systems
• Track open house attendance and lead generation
• Automate client communication workflows

Data Warehousing¶

• Extract property data for business intelligence
• Maintain synchronized local databases
• Generate custom reports and analytics

📚 Related Documentation¶

🚀 Quick Start¶

New to the WFRMLS API? Start here:

1. Install the client - Get up and running in minutes
2. Configure authentication - Set up your API credentials
3. Try the quick start - Make your first API call
4. Explore examples - See real-world use cases

🆘 Support & Community¶

Getting Help¶

• API Issues: Contact UtahRealEstate.com Support
• Library Issues: GitHub Issues
• Feature Requests: GitHub Discussions

Contributing¶

We welcome contributions! See our Contributing Guide for details on:

• Setting up the development environment
• Running tests and quality checks
• Submitting pull requests
• Following coding standards

License¶

This project is licensed under the MIT License - see the license details for more information.

Ready to get started? Jump to the Quick Start Guide or explore the API Reference.