API Reference¶
Reference pages for the public WFRMLS Python client surface, generated helpers, and support modules documented in this repository.
Quick Navigation¶
-
Client
Start with the main client and service access pattern.
-
Core Resources
Properties, members, offices, and open houses.
-
Analytics
Higher-level analytics helpers built on top of the client.
-
Exceptions
Review the custom exception classes raised by the library.
Core API Pages¶
- Client - Main entry point and shared usage patterns.
- Properties - Listing search and property details.
- Members - Member and agent lookups.
- Offices - Office and brokerage records.
- Open House - Open house schedules and convenience helpers.
Supporting API Pages¶
- Analytics - Market-analysis utilities that compose core endpoints.
- Lookup - Lookup tables and supporting values.
- ADU - Accessory dwelling unit-related endpoints.
- Property Unit Types - Property unit-type resources.
- Deleted Records - Deleted-record synchronization support.
- Resource - API resource discovery.
- Data System - System and configuration information.
- Live API Updates - Notes related to live-update behavior.
- Exceptions - Custom exception hierarchy.
Shared Guides¶
- Authentication Guide - Configure credentials.
- Quick Start - Make the first request.
- OData Queries Guide - Build filters and sort expressions.
- Error Handling Guide - Work with the exception types documented here.
- Examples - Practical usage patterns.