RESO Web API

The RESO Web API endpoint returns data using the RESO Data Dictionary. See the RESO Web API documentation for more information.

The Ruby client can be used with the RESO Web API by applying the RESO API middleware in the configuration settings:

SparkApi.configure do |config|
  config.middleware = :reso_api
end

Pass parameters to the RESO Web API as a Ruby hash. Be sure to append a $ to the beginning of the parameter name:

SparkApi.client.get("/Property", {:$top => 25, :$count => true } )

Or, generate the query string directly:

SparkApi.client.get("/Property?$top=25&$count=true")

Refer to the RESO Web API parameters documentation for more information.