module SimplyRetsClient
SimplyRETS API
The SimplyRETS API is an exciting step towards making it easier for developers and real estate agents to build something awesome with real estate data! The documentation below makes live requests to our API using the trial data. To get set up with the API using live MLS data, you must have RETS credentials from your MLS, which you can then use to create an app with SimplyRETS. For more information on that process, please see our [FAQ](simplyrets.com/faq), [Getting Started](simplyrets.com/blog/getting-set-up.html) page, or [contact us](simplyrets.com/\#home-contact). Below you’ll find the API endpoints, query parameters, response bodies, and other information about using the SimplyRETS API. You can run queries by clicking the ‘Try it Out’ button at the bottom of each section. ### Authentication The SimplyRETS API uses Basic Authentication. When you create an app, you’ll get a set of API credentials to access your listings. If you’re trying out the test data, you can use ‘simplyrets:simplyrets` for connecting to the API. ### Media Types The SimplyRETS API uses the `Accept` header to allow clients to control media types (content versions). We maintain backwards compatibility with API clients by allowing them to specify a content version. We highly recommend setting and explicity media type when your application reaches production. Both the structure and content of our API response bodies is subject to change so we can add new features while respecting the stability of applications which have already been developed. To always use the latest SimplyRETS content version, simply use `application/json` in your application `Accept` header. If you want to pin your clients media type to a specific version, you can use the vendor-specific SimplyRETS media type, e.g. `application/vnd.simplyrets-v0.1+json"` To view all valid content-types for making an `OPTIONS`, make a request to the SimplyRETS api root `curl -XOPTIONS -u simplyrets:simplyrets api.simplyrets.com/` The default media types used in our API responses may change in the future. If you’re building an application and care about the stability of the API, be sure to request a specific media type in the Accept header as shown in the examples below. The wordpress plugin automatically sets the ‘Accept` header for the compatible SimplyRETS media types. ### Pagination There a few pieces of useful information about each request stored in the HTTP Headers: - `X-Total-Count` shows you the total amount of listings that match your current query. - `Link` contains pre-built pagination links for accessing the next ’page’ of listings that match your query. Read more about that [here](simplyrets.com/blog/api-pagination.html).
OpenAPI spec version: 1.0.0
Generated by: github.com/swagger-api/swagger-codegen.git
Licensed under the Apache License, Version 2.0 (the “License”); you may not use this file except in compliance with the License. You may obtain a copy of the License at
www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an “AS IS” BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
SimplyRETS API
The SimplyRETS API is an exciting step towards making it easier for developers and real estate agents to build something awesome with real estate data! The documentation below makes live requests to our API using the trial data. To get set up with the API using live MLS data, you must have RETS credentials from your MLS, which you can then use to create an app with SimplyRETS. For more information on that process, please see our [FAQ](simplyrets.com/faq), [Getting Started](simplyrets.com/blog/getting-set-up.html) page, or [contact us](simplyrets.com/\#home-contact). Below you’ll find the API endpoints, query parameters, response bodies, and other information about using the SimplyRETS API. You can run queries by clicking the ‘Try it Out’ button at the bottom of each section. ### Authentication The SimplyRETS API uses Basic Authentication. When you create an app, you’ll get a set of API credentials to access your listings. If you’re trying out the test data, you can use ‘simplyrets:simplyrets` for connecting to the API. ### Media Types The SimplyRETS API uses the `Accept` header to allow clients to control media types (content versions). We maintain backwards compatibility with API clients by allowing them to specify a content version. We highly recommend setting and explicity media type when your application reaches production. Both the structure and content of our API response bodies is subject to change so we can add new features while respecting the stability of applications which have already been developed. To always use the latest SimplyRETS content version, simply use `application/json` in your application `Accept` header. If you want to pin your clients media type to a specific version, you can use the vendor-specific SimplyRETS media type, e.g. `application/vnd.simplyrets-v0.1+json"` To view all valid content-types for making an `OPTIONS`, make a request to the SimplyRETS api root `curl -XOPTIONS -u simplyrets:simplyrets api.simplyrets.com/` The default media types used in our API responses may change in the future. If you’re building an application and care about the stability of the API, be sure to request a specific media type in the Accept header as shown in the examples below. The wordpress plugin automatically sets the ‘Accept` header for the compatible SimplyRETS media types. ### Pagination There a few pieces of useful information about each request stored in the HTTP Headers: - `X-Total-Count` shows you the total amount of listings that match your current query. - `Link` contains pre-built pagination links for accessing the next ’page’ of listings that match your query. Read more about that [here](simplyrets.com/blog/api-pagination.html).
OpenAPI spec version: 1.0.0
Generated by: github.com/swagger-api/swagger-codegen.git
Licensed under the Apache License, Version 2.0 (the “License”); you may not use this file except in compliance with the License. You may obtain a copy of the License at
www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an “AS IS” BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
Constants
- VERSION
Public Class Methods
Customize default settings for the SDK using block.
SimplyRetsClient.configure do |config| config.username = "xxx" config.password = "xxx" end
If no block given, return the default Configuration
object.
# File lib/simplyrets.rb, line 58 def configure if block_given? yield(Configuration.default) else Configuration.default end end