PHP Code Sample

We recommending using the PHRETS library by troydavisson, found for free on GitHub here: https://github.com/troydavisson/PHRETS Sample.php

C# Code Sample

App.config IdxApiExample.cs

Metadata Transaction

Description The Metadata transaction is used to retrieve information about the structure and definitions of the data available through the MLS® IDX API. Metadata allows clients to properly format listing data for display and to organize it efficiently for future retrieval and storage. End Point Argument Type Description Default Required Supported Values Type String Selects the type

Login Transaction

Description Before any other request can be made, a client must issue a Login request. The Login transaction verifies the provided credentials and establishes a session. Session control may be managed through HTTP cookies or other supported methods, but all clients must support cookie-based session handling. The server’s response to the Login request includes all the necessary details for

Authentication

All access to the MLS IDX API requires authentication using digest authentication (RFC 2617, HTTP Authentication).

RETS Support

The MLS IDX API follows the Real Estate Transaction Standard (RETS) version 1.7.2 as closely as possible. However, there are a few important differences between this service and a fully certified RETS server:

Data Feed Overview

The MLS IDX API supports five core transactions: Login, Metadata, Search, GetObject, and Logout. These transactions are built on Representation State Transfer (REST) architecture, ensuring smooth and reliable data exchange between the MLS IDX API server and the websites or applications consuming the data. All transactions can be performed by clients using either HTTPS GET or HTTPS POST methods. Security Requirements:

Recommended Time to Pull Data

Data collection, synchronization, and distribution through the MLS IDX API occur through centralized processes that run during the early hours of each day. To ensure you are receiving the most accurate and up-to-date listing information, and to avoid possible inconsistencies, it is recommended that clients begin pulling data from MLS IDX API feeds after 10:00 AM.