SimplyRETS Ruby SDK
Ruby Makefile
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
lib
spec
.gitignore
Gemfile
Gemfile.lock
LICENSE
Makefile
README.org
Rakefile
example.rb
multi-query-param.patch
simplyrets.gemspec

README.org

SimplyRETS Ruby SDK (Beta)

Deprecation Notice: This SDK is deprecated and will not receive any future updates. The recommended workflow is to use the API directly, or generate an SDK for your use-case from the Swagger Spec

The official Ruby SDK for the SimplyRETS Listings API.

SimplyRETS provides a modern and simple interface for building robust applications and websites with Real Estate data.

You can view the full API Documentation here.

Installation

Clone the repo or install the simplyrets gem:

$ git clone git@github.com/SimplyRETS/simplyrets-ruby-sdk

or

$ gem install simplyrets

Quick Start

Here’s a quick example to set up the client and make a request:

%w(rubygems simplyrets).each {|lib| require lib}
%w(rubygems simplyrets).each {|models| require models}

require "simplyrets"

SimplyRetsClient.configure do |config|
  config.username = 'simplyrets'
  config.password = 'simplyrets'
end

# all properties
listings =  SimplyRetsClient::DefaultApi.new.properties_get()
p listings

See the examples.rb file for more examples on how to call the api with query parameters.

Additional Info

View the complete interactive API on the docs page. Here you can find all the available query parameters and the complete response body. You can even see the URL made for that request.

Support

For support regarding the API or bugs in the SDK, can contact us at support (at) simplyrets (dot) com - or leave an issue on the Github page!