PHPackages                             mymediamagnet/homeup-api-php - 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. mymediamagnet/homeup-api-php

ActiveLibrary[API Development](/categories/api)

mymediamagnet/homeup-api-php
============================

Access to the centralized database API.

085PHP

Since Jan 10Pushed 5y agoCompare

[ Source](https://github.com/MyMediaMagnet/api-homeup-php)[ Packagist](https://packagist.org/packages/mymediamagnet/homeup-api-php)[ RSS](/packages/mymediamagnet-homeup-api-php/feed)WikiDiscussions master Synced 4d ago

READMEChangelogDependenciesVersions (1)Used By (0)

HomeUP API
==========

[](#homeup-api)

API keys are not publicly available. Please contact us if you would like access.

Features
--------

[](#features)

- Easily query listings from multiple boards in Canada
- Clean, logical listing formats
- Normalized data across multiple boards
- Intuitive relationships
- Google Place data for all listings
- Uses Amazon S3 for storage, other users using Amazon can utilize the "quick copy" feature for images

How To Use
----------

[](#how-to-use)

First, initialize your class with your API keys. It's suggested you store these values in an environment file

```
$homeup = new HomeUp\Api\HomeUp('your_key', 'your_token');
```

Then you can simply use any of the following commands to get data from the centralized feed.

To get a list of listings. Please note, requests with a limit of more than 100 will not include listing images

```
$homeup->listings(['board', 'insert_board_id', 'limit' => 20]);
```

To get an individual listing use the following along with the listing ID provided from the API

```
$homeup->listing($listing_id, []);
```

To get an individual listings images use the following along with the listing ID provided from the API

```
$homeup->images($listing_id, []);
```

Enter the hours in the "removed" method in order to retrieve listings that have been taken off the MLS in that timeframe

```
$homeup->removed(24);
```

### Queries

[](#queries)

You can also do a query based on nearly any field in the database

```
$homeup->query()->where('square_feet', '>', 2000)->where('price', '', 2000)
                ->where('price', '', 1000);
    $q->orWhere('price', '