PHPackages anecka/retsrabbit - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. [API Development](/categories/api) 4. / 5. anecka/retsrabbit ActiveLibrary[API Development](/categories/api) anecka/retsrabbit ================= This is the PHP SDK for RetsRabbit 1.3(10y ago)897PHP Since Feb 26Pushed 10y ago1 watchersCompare [ Source](https://github.com/patpohler/retsrabbit-php-sdk)[ Packagist](https://packagist.org/packages/anecka/retsrabbit)[ RSS](/packages/anecka-retsrabbit/feed)WikiDiscussions master Synced today READMEChangelogDependencies (2)Versions (4)Used By (0) Rets Rabbit Client, PHP SDK for the Rets Rabbit API =================================================== [](#rets-rabbit-client-php-sdk-for-the-rets-rabbit-api) Rets Rabbit Client PHP SDK is a library that makes it easy to work with the [Rets Rabbit API](http://retsrabbit.com). The API simplifies working with real estate lisitng data. The GitHub repository for the project is here . ``` //New instance of the client $client = new Anecka\retsrabbit\RetsRabbitClient($access_token); //If using a custom API endpoint (ex. https://.retsrabbit.com/api) //If your endpoint is https//api.retsrabbit.com you don't need to set this $client->setEndpoint($endpoint_url); //Get a listing from the MLS w/ an id of '5456655' $listing = $client->getListing($server_id, '5456655'); //Run a search for listings on a price range $listings = $client->getSearchListings($server_id, array('ListPrice' => '90000-100000')); ``` ### Installing via Composer [](#installing-via-composer) The recommended way to install the SDK is through [Composer](http://getcomposer.org). ``` # Install Composer curl -sS https://getcomposer.org/installer | php ``` Next update your project's composer.json file to include the SDK ``` "require": { "anecka/retsrabbit": "dev-master" } ``` Run `composer install` to install the library, after installing you need to require Composer's autoloader: ``` require 'vendor/autoload.php'; ``` ### Authentication [](#authentication) In order to use the libary, you need to have valid client credentials to Rets Rabbit and an API endpoint URL (usually in the form of https://.retrabbit.com/api). You'll need the credentials to create an access token in order to sender requests to the API. ``` $client = new Anecka\retsrabbit\RetsRabbitClient; //If using a custom API endpoint (ex. https://.retsrabbit.com/api) //If your endpoint is https//api.retsrabbit.com you don't need to set this $client->setEndpoint($endpoint_url); $client->getAccessCode($client_id, $client_secret); //after you get the token you can save to a session variable for future requests, tokens are valid for 10 hours echo $client->access_token /* instantiating the client by passing an access_token */ $client = new Anecka\retsrabbit\RetsRabbitClient($_SESSION['access_token'], $endpoint_url); ``` ### Getting a list of servers [](#getting-a-list-of-servers) To get a list of rets servers registered to your account, you can use the following method. ``` $servers = $client->getServers(); ``` The return will be a multi-dimensional array. Here's an example ``` [ [ "access_url": "http://rets.ranwrealtors.com:8080/wis/server/login", "server_hash": "6cb1ab75588f1af22098f4df183cb988", "listing_field": "MLSNumber", "created_at": "2014-06-23 15:52:05", "updated_at": "2014-06-23 15:52:05", "listing_date_field": "ModificationTimeStamp", "photo_class": "HQPhoto", "last_run": null ], ... ] ``` `server_hash` is important as you'll need it to access listing information and run MLS searches. The hash will never change, so you can save this value in an environment variable or configuration setting in your application. ### Getting metadata for the server [](#getting-metadata-for-the-server) Getting the metadata for a server can be done by using the following method. ``` $metadatas = $client->getServerMetadata($server_hash); ``` ### Running a property search [](#running-a-property-search) To run a search for properties, just call the `getSearchListings` method and pass the server hash and an array containing the search parameters. Since fields vary from board to board, you'll need to reference the metadata for your real estate board. ``` $params = array( 'ListPrice' => '90000-95000', ); $listings = $client->getSearchListings($server_hash, $params); ``` The return will be a multi-dimensional of stdClass objects. You can access the listing data and photos by using the `fields` and `photos` attributes. ``` foreach($listings as $listing) { echo $listing->fields->MLSNumber; echo $listing->fields->ListPrice; foreach($listing->photos as $photo) { echo $photo->url; } } ``` ### Getting a single listing [](#getting-a-single-listing) To get a single listing, use the `getListing` method and pass the server hash and the unique MLS id for the listing. ``` $listing = $rets_client->getListing('6cb1ab75588f1af22098f4df183cb988', '50077235'); ``` The return will be a single stdClass object. --- ©2016 Anecka, LLC All rights reserved. ### Health Score 30 — LowBetter than 62% of packages Maintenance20 Infrequent updates — may be unmaintained Popularity15 Limited adoption so far Community7 Small or concentrated contributor base Maturity65 Established project with proven stability Bus Factor1 Top contributor holds 100% of commits — single point of failure How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** — Project age, version count, PHP version support, and release stability. ### Release Activity Cadence Every ~47 days Total 3 Last Release 3684d ago ### Community Maintainers ![](https://avatars.githubusercontent.com/u/854401?v=4)[Patrick Pohler](/maintainers/patpohler)[@patpohler](https://github.com/patpohler) --- Top Contributors [![patpohler](https://avatars.githubusercontent.com/u/854401?v=4)](https://github.com/patpohler "patpohler (16 commits)") ### Code Quality TestsPHPUnit ### Embed Badge ![Health badge](/badges/anecka-retsrabbit/health.svg) ``` [![Health](https://phpackages.com/badges/anecka-retsrabbit/health.svg)](https://phpackages.com/packages/anecka-retsrabbit) ``` ### Alternatives [statamic/cms The Statamic CMS Core Package 4.8k3.6M971](/packages/statamic-cms)[tencentcloud/tencentcloud-sdk-php TencentCloudApi php sdk 3741.3M46](/packages/tencentcloud-tencentcloud-sdk-php)[neuron-core/neuron-ai The PHP Agentic Framework. 2.0k656.1k38](/packages/neuron-core-neuron-ai)[avalara/avataxclient Client library for Avalara's AvaTax suite of business tax calculation and processing services. Uses the REST v2 API. 528.5M7](/packages/avalara-avataxclient)[files.com/files-php-sdk Files.com PHP SDK 2481.1k](/packages/filescom-files-php-sdk)[aimeos/prisma A powerful PHP package for integrating media related Large Language Models (LLMs) into your applications 1943.1k5](/packages/aimeos-prisma) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)