PHPackages                             mihaikelemen/vaultre - 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. mihaikelemen/vaultre

AbandonedArchivedLibrary

mihaikelemen/vaultre
====================

Abstraction layer for the VaultRE API endpoint

1.2.1(5y ago)010Apache-2.0PHPPHP >=7.2

Since Feb 21Pushed 5y ago1 watchersCompare

[ Source](https://github.com/mihaikelemen/vaultre)[ Packagist](https://packagist.org/packages/mihaikelemen/vaultre)[ Docs](https://github.com/mihaikelemen/vaultre)[ RSS](/packages/mihaikelemen-vaultre/feed)WikiDiscussions main Synced today

READMEChangelog (2)Dependencies (1)Versions (5)Used By (0)

VaultRe API wrapper
===================

[](#vaultre-api-wrapper)

Small utility, inspired by the [official examples](https://github.com/VaultGroup/api-samples), to handle API calls on VaultRE endpoints.

Installation
------------

[](#installation)

You can install this library with Composer, by running `composer require mihaikelemen/vaultre`

Usage
-----

[](#usage)

To access a specific data type (eg. attribute) such as: *properties*, *advertising*, *categories*, etc., you need to use the `setAtrribute()` method. How you know what attribute to use? Is simple: for example check this API endpoints `/advertising/suppliers` or `/contacts/{id}/context`. The attribute for the first example is `advertising` and for the second is `contacts`.

The second part of the endpoint (what is after the *attribute*) is the action that needs to be performed: `suppliers` or `{id}/context`

EXAMPLES:

- retrive a single property (eg. ID 123):

```
use MihaiKelemen\VaultRe\VaultRe

require_once 'vendor/autoload.php';

$valutre = new ValutRe(API_KEY, TOKEN);
$valutre->setAttribute('properties')
->fetch('123');

// access the data
if ($valutre->isSuccess()) {
	$property = $valutre->getResponse();
}
```

- retrieve [residential properties](https://docs.api.vaultre.com.au/#/residentialProperties/getResidentialSaleProperties) available for sale (the first 100 results):

```
use MihaiKelemen\VaultRe\VaultRe

require_once 'vendor/autoload.php';

$valutre = new ValutRe(API_KEY, TOKEN);
$valutre->setAttribute('properties')
->setPageSize(100)
->fetch('residential/sale');

$properties = $api->properties();
```

- based on the previous example, retrive all residential properties available for sale, with auto-pagination

```
use MihaiKelemen\VaultRe\VaultRe;

require_once 'vendor/autoload.php';

function nextPageNumber(array $nav=[])
{
    $url = $nav['navigation']['next'];
    if (is_null($url)) {
        return 0;
    }
    parse_str(parse_url($url, PHP_URL_QUERY), $result);
    return $result['page'];
}

$valutre = new ValutRe(API_KEY, TOKEN);
$valutre->setAttribute('properties')
->setPageSize(100)
->fetch('residential/sale');

if ($valutre->isSuccess()) {

    $page = nextPageNumber($valutre->pagination());

    // code here to process the properties returned by VaultRe (eg. $vaultre->properties())

    while ($page > 0) {

        $valutre->setPage($page)
        ->fetch('residential/sale');

        if ($valutre->isSuccess()) {
            // code here to process the properties returned by VaultRe (eg. $vaultre->properties())
            $page = nextPageNumber($valutre->pagination());
        } else {
            die($valutre->errors());
        }

    }
} else {
    die($valutre->errors());
}
```

- update a property (eg. property ID 123) details, by adding a new photo

```
use MihaiKelemen\VaultRe\VaultRe;

require_once 'vendor/autoload.php';

$valutre = new ValutRe(API_KEY, TOKEN);
$valutre->setAttribute('properties')
->update('123/photos', [
	"photo" => "string (binary data)",
	"caption" => "string",
	"published" => true|false,
	"type" => "Photograph|Floorplan"
]);
```

- deleting a property

```
use MihaiKelemen\VaultRe\VaultRe;

require_once 'vendor/autoload.php';

$valutre = new ValutRe(API_KEY, TOKEN);
$valutre->setAttribute('properties')
->delete('123');
```

Actions that can be performed on an attribute:`fetch`, `update`, `delete`, `add`. For the `update` and `add` methods you need to pass a second argument which is the payload that needs to be sent over to VaultRe.

Links
-----

[](#links)

- Official API docs:
- Github:

Todo
----

[](#todo)

- add unit testing

###  Health Score

23

—

LowBetter than 27% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity5

Limited adoption so far

Community7

Small or concentrated contributor base

Maturity51

Maturing project, gaining track record

 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 ~2 days

Total

4

Last Release

1897d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/f9fffde4a4d0ed22fc7163d71a4f959e86751544a67ef1ec3afa7e351d5d0abd?d=identicon)[mihaikelemen](/maintainers/mihaikelemen)

---

Top Contributors

[![mihaikelemen](https://avatars.githubusercontent.com/u/17508016?v=4)](https://github.com/mihaikelemen "mihaikelemen (11 commits)")

---

Tags

real-estatevaultre

### Embed Badge

![Health badge](/badges/mihaikelemen-vaultre/health.svg)

```
[![Health](https://phpackages.com/badges/mihaikelemen-vaultre/health.svg)](https://phpackages.com/packages/mihaikelemen-vaultre)
```

###  Alternatives

[neuron-core/neuron-ai

The PHP Agentic Framework.

1.8k245.3k20](/packages/neuron-core-neuron-ai)[tencentcloud/tencentcloud-sdk-php

TencentCloudApi php sdk

3731.2M42](/packages/tencentcloud-tencentcloud-sdk-php)[aedart/athenaeum

Athenaeum is a mono repository; a collection of various PHP packages

255.2k](/packages/aedart-athenaeum)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)