Developer Documentation
Platform Overview
API Services
Overview Accounts Accounts: Associations Accounts: Metadata Accounts: Profile Appstore: Users Broker Distributions Broker Tours Consumers Consumers: Linked Agents Contacts Contacts: Activity Contacts: Export Contacts: Tags Contacts: Portal Accounts Developers: Identities Developers: Keys Developers: Authorizations Developers: Billing Summary Developers: Change History Developers: Domains Developers: News Feed Webhooks Developers: Roles Developers: Syndications Developers: Templates Developers: Usage Detail Developers: Usage Summary Devices Flexmls: Email Links Flexmls: Listing Meta Origins Flexmls: Listing Meta Translations Flexmls: Listing Meta Field List Translations Flexmls: Listing Reports Flexmls: Mapping Layers Flexmls: Mapping Shapegen IDX IDX Links Listing Carts Listing Carts: Portal/VOW Carts Incomplete Listings Incomplete Listings: Documents Incomplete Listings: Documents Metadata Incomplete Listings: Document Uploads Incomplete Listings: Floor Plans Incomplete Listings: FloPlans Incomplete Listings: Photos Incomplete Listings: Photos Metadata Incomplete Listings: Photo Uploads Incomplete Listings: Rooms Incomplete Listings: Tickets Incomplete Listings: Units Incomplete Listings: Videos Incomplete Listings: Videos Metadata Incomplete Listings: Virtual Tours Incomplete Listings: Virtual Tours Metadata Listings Listings: Clusters Listings: Documents Listings: Documents Metadata Listings: Floor Plans Listings: FloPlans Listings: Historical Listings: History Listings: Notes Listings: Search Parameters Listings: Open Houses Listings: Photos Listings: Photos Metadata Listings: Photo Uploads Listings: Document Uploads Listings: Rental Calendar Listings: Rooms Listings: Rules Listings: Tour of Homes Listings: Tickets Listings: Units Listings: Validation Listings: Videos Listings: Videos Metadata Listings: Virtual Tours Listings: Virtual Tours Metadata Listing Meta: Custom Fields Listing Meta: Custom Field Groups Listing Meta: Field Order Listing Meta: Field Relations Listing Meta: Property Types Listing Meta: Rooms Listing Meta: Standard Fields Listing Meta: Units Registered Listings Market Statistics News Feed News Feed: Curation News Feed: Events News Feed: Metadata News Feed: Restrictions News Feed: Schedule News Feed: Settings News Feed: Templates Open Houses Overlays Overlays: Shapes Portals Preferences Saved Searches Saved Searches: Provided Saved Searches: Restrictions Saved Searches: Tags Search Templates: Quick Searches Search Templates: Views Search Templates: Sorts Shared Links System Info System Info: Languages System Info: Search Templates
Supporting Documentation
Terms of Use

RESO Web API Overview

Built within the Spark® API is a /Reso/OData endpoint that implements the RESO Web API and provides data using the RESO Data Dictionary.

The documentation we provide does not fully document the RESO Web API itself; rather, it's meant to get you up and running on our implementation of the standard.

  1. Overview
  2. Authorization
  3. Making Requests
    1. Resources
    2. Retrieving Metadata
    3. Retrieving Data
    4. Request Parameters
  4. Response Description
  5. Replication

1. Overview

The RESO Web API endpoint is at:

Because our RESO Web API shares the same authentication and authorization infrastructure as the Spark API, you can use the same API keys provided for the Spark API to access the RESO Web API endpoints.


2. Authorization

The method for obtaining authorization from end users and making authenticated requests is identical to accessing the Spark API directly. See our authentication documentation for more information.


3. Making Requests

  1. Resources
  2. Retrieving Metadata
  3. Retrieving Data
  4. Request Parameters


Our RESO Web API provides the following distinct endpoints:


Retrieving Metadata

Metadata is accessible at:$metadata

Retrieving Data

Using the Property resource as our example, all properties can be retrieved at:

An individual property can be retrieved at:'<ListingKey>')

For example, if a listing's ListingKey is 20100000000000000000000000, your request should be:'20100000000000000000000000')

To access Property Media, Rooms and other related resource records, FBS recommends utilizing the $expand parameter. All allowed expansions are listed in the NavigationProperty entities in your feed metadata (see above).$expand=Media,OpenHouse

If desired, these related resource records can instead be accessed as a subresource of each Property record. Here are a couple examples:'20100000000000000000000000')/Media'20100000000000000000000000')/OpenHouse

Request Parameters

Each service supports some or all of the request parameters documented on our RESO request parameters page.


Response Description

This OData service only responds to JSON format except for the $metadata endpoint, which returns XML.


Encoded values

OData specifications that the RESO Web API is built upon dictate that certain data attributes and values can't contain spaces, non-alpha-numeric characters, etc. When they do, the values need to be encoded. For this reason some custom field names are encoded, and the corresponding human-readable names can be looked up in the metadata. The EntityType Name="CustomFields" section of the metadata will list all custom field names and their human readable translations. Here's an example of a metadata entry that connects an encoded name and a display name:

<Property Name="Documents_co_Exclusive_sp_Right_sp_to_sp_Sell_sp__lbracket_private_rbracket_" Type="Edm.Boolean">
          <Annotation Term="MLS.OData.Metadata.LocalName" String="Documents Exclusive Right to Sell [private]"/>