RESO Web API Overview

Built within Spark API is a /Reso/OData endpoint that implements RESO's 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. Web API Version
    2. Resources
    3. Retrieving Meta Data
    4. Retrieving Data
    5. Request Parameters
  4. Response Description
  5. Replication

1. Overview

The RESO Web API endpoint is at: 

https://sparkapi.com/Reso/OData

Because the RESO Web endpoint is built on Spark API, you can use the same API keys provided for Spark to access the RESO Web endpoint.

2. Authorization

The method for obtaining authorization from end users and making authenticated requests is identical to accessing Spark directly.

See our authentication documentation for more information.

3. Making Requests

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

Our RESO Web API provides the following distinct endpoints:

Retrieving Meta Data

Metadata is accessible at: 

https://sparkapi.com/Reso/OData/$metadata

Retrieving Data

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

https://sparkapi.com/Reso/OData/Property
...and an individual property can be retrieved at... 
https://sparkapi.com/Reso/OData/Property('<PropertyId>')
<PropertyId> is the same data as StandardFields.ListingKey or Id when using the Spark API listing's service. So, if the listing's Id was 20100000000000000000000000, your request would be: 
https://sparkapi.com/Reso/OData/Property('20100000000000000000000000')
Note that the Media endpoint is accessed as a subresource of listings. So, to find the media for listing 20100000000000000000000000, your would hit the URI: 
https://sparkapi.com/Reso/OData/Property('20100000000000000000000000')/Media

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.

Replication

Special considerations often apply when replicating. If you want to replicate data using our RESO Web API endpoints, please review our replication documentation.