What is the RESO Web API?
The RESO Web API is the modern way to transport data in the real estate industry. It is built on well-known, open technology standards so that any organization can use it to deliver or receive data quickly and efficiently.
Using the RESO Web API for data transport allows for more interoperability: systems and apps can interact with each other in a more efficient manner. Real estate professionals and consumers have access to more seamless technology experiences when all industry participants adopt the Web API in their exchanges of data.
Michaal Wurzer, RESO Vice Chair and CEO of FBS, explains the need for the industry to move forward with the transition to the RESO Web API:
The RESO Web API moves the industry forward to widely-adopted RESTful design in use by most industries today. The Web API promotes greater access to real estate information directly from the web, mobile, social and other HTTP-based applications.
RESO uses open standards and off-the-shelf tools that are supported across industries. By ensuring standards and protocols like OData and OAuth are at the core of the Web API’s functionality, industry incumbents and newcomers can be assured that they’re building technology that will be well-supported in the future.
RESO Web API Technical Specifications and Testing Rules
These documents describe RESO’s specifications. Because MLSs certify Data Dictionary standards on the RESO Web API, both sets of specifications are important for technical developers to understand. By downloading these resources, you confirm that you agree to the RESO EULA.
- Web API Core 2.0.0 Specification (renamed from Web API Core 1.0.2 on 9/13/21)
- Data Dictionary 1.7 Specification
- Data Dictionary 1.7 Approved Spreadsheet
- Common Schema Reference Metadata (Web API Core 1.0.2+, DD 1.7)
- Common Schema Open API Reference (Web API Core 1.0.2+, DD 1.7)
- RCP – WEBAPI-031 Data Dictionary Representation in the Web API
Common Questions About the Web API:
Can I get data from RESO through the Web API?
RESO does not provide MLS real estate data. RESO creates the standard for the data, and other organizations build technology based upon it.
Brokers and technology companies should go directly to MLSs to request data via the Web API. MLSs owned and operated by REALTOR® associations are required by the National Association of REALTORS® to have production-level access available to their data via Web API.
How do I get credentials to use the Web API?
Access to data from the Web API will come from local MLSs. After agreeing to an MLS’s data use and licensing policies, data recipients will work directly with that MLS’s software provider or technical staff to receive credentials and instructions on how to access that MLS’s data.
Why Web API Instead of RETS?
RETS is an older standard that is proprietary to the real estate industry. It has been deprecated (it’s no longer being supported or improved at RESO) because the industry needs to move to a more well-known technology standard. While RETS still works for many applications, all technology evolves. RETS created great value for 20 years, and the conversion to Web API is underway.
Do You Have Other Questions?
Please email us at firstname.lastname@example.org.
API is short for Application Programming Interface. In a nontechnical sense, you can think of it as the panel on the back of a TV with ports and jacks to input and output media. It’s a set of standardized ways for technology systems to interact with each other. An API is an interface for access and delivery of data.
Authorization identifies what kinds of data a user is allowed to access. To access data through an API, a data requestor supplies an authorization code – an API key or API token – and the user’s allowed level of data access is delivered through the API.
Endpoint is a web address where data can be accessed. An API service may have one or many endpoints where different kinds of data can be accessed.
JSON is a way to represent data that is simple for humans and machines to interpret. RESO’s Web API can return data to requestors in this format for ease of use.
OAuth is an open standard that allows for authentication and authorization in one step. It allows previously-identified users of systems (think Facebook and Google accounts) to log in to other APIs and get access to services quickly.
Metadata is “data about the data.” It is a user guide to explain what data is available and how it is organized. Metadata can be analyzed so that data requestors understand exactly what the data they access from an API will look like.
Payload is a set of data which has a predetermined structure. An “IDX Payload” would include all of the fields needed for display on a real estate IDX website in a structured format that can be understood and easily consumed by the data recipient.
Query is a request a user makes to an API explaining what kind of data is needed. The RESO Web API can handle “live queries” that allow for immediate results in web applications.
Replication is the copying of a database. Replicators initially pull an entire data set, and then continually request the most recent data changes to update their copy and keep it in sync with the primary database.
REST is REpresentational State Transfer. It is a design for creating an API to efficiently communicate between systems. REST APIs, like the RESO Web API, use RESTful HTTP (web-based) requests to input, update, delete or get data through the API.