API Documentation v1

Overview

Welcome to the Spring API.  This RESTful API allows access to local Multiple Listing Service real estate data.  It enables third-party developers to create apps using local real estate data.  Response payloads are formatted as JSON based on the RESO data-dictionary.

 There is a Production and Sandbox environment which require separate api keys.  If you are new to the Spring API, it is recommended to use the Sandbox environment to establish test calls.   Each environment has access to both public and protected data depending on your plan.

We have organized the methods into the following resources:

 

 

Professional

Agent and Office methods

Search  

Search listings

Listings  

Get detail information about a listing

Collections  

Full access to users’ collections with authorized approval.   

Events

View top events for the selected MLS

OAuth2

Get user authorization to access identity data and methods

Leads

Coming soon


Feel free to make test calls using our Web Interactive Console (I/O Docs)

 

cURL

We use cURL throughout our documentation with examples of the various method calls.  If you would like to follow along with the tools we are using you can find cURL here.

 

URI Format

The Spring API uses the following format for public:

{protocal}://api.solidearth.com/{endpoint}?format={response format}&api_key={YOUR_API_KEY}&callback={YOUR_CALLBACK_FUNCTION}

For Protected methods use:

{protocal}://api.solidearth.com/{endpoint}?format={response format}&access_token={ACCESS_TOKEN}




 

Name

Description

Required

protocal

http | https -  https required for protected methods.

yes

endpoint

path to the API method

yes

response format

JSON | XML

no, JSON is default.

YOUR_CALLBACK_FUNCTION

name of callback function.

no

YOUR_API_KEY

key given to you when app is registered

yes, for public methods

ACCESS_TOKEN

token given to the app when user authorizes

yes, for protected methods



Error Code

 

HTTP Error Code

Description

400

Bad Request

403

Not Authorized

403

Account Inactive

403

Over Queries Per Second Limit

403

Over Rate Limit

403

Unknown Referer

403

Service Over Queries-per-second-limit

403

Service Requires SSL

404

No data returned

414

Request URI Too Long

502

Bad Gateway

503

Service Unavailable

504

Gateway Timeout


Error Results

In addition to the code you will get back an error result like:

{
 "responseStatus": {
   "errorCode": "",
   "message": "the error message from Spring",
   "errors": []
 }
}