PHPackages                             fw4/sweepbright-api - 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. fw4/sweepbright-api

ActiveLibrary[API Development](/categories/api)

fw4/sweepbright-api
===================

PHP library for implementing the SweepBright API

v1.2.1(2y ago)13.4k↓66.2%2[1 issues](https://github.com/fw4-bvba/sweepbright-api/issues)MITPHPPHP ^7.1|^8.0CI failing

Since Oct 28Pushed 2y ago3 watchersCompare

[ Source](https://github.com/fw4-bvba/sweepbright-api)[ Packagist](https://packagist.org/packages/fw4/sweepbright-api)[ RSS](/packages/fw4-sweepbright-api/feed)WikiDiscussions master Synced 2w ago

READMEChangelogDependencies (4)Versions (8)Used By (0)

SweepBright API
===============

[](#sweepbright-api)

PHP client for the [SweepBright](https://www.sweepbright.com) Website API. For terms of use and API credentials, refer to [the official documentation](https://website.sweepbright.com/docs/).

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

[](#installation)

`composer require fw4/sweepbright-api`

Usage
-----

[](#usage)

```
$client = new \SweepBright\SweepBright();
$accessToken = getAccessTokenFromDataStore();
if (empty($accessToken) || $accessToken->hasExpired()) {
    $accessToken = $client->requestAccessToken($clientId, $clientSecret);
    saveAccessTokenToDataStore($accessToken);
} else {
    $client->setAccessToken($accessToken);
}
$estate = $client->getEstate($estateId);
```

The API client provides the following methods:

- `public function getEstate(string $estate_id): Response`
- `public function setEstateUrl(string $estate_id, string $url): void`
- `public function saveContact(array $data, ?array $preferences = null, ?array $location_preference = null): void`
- `public function saveEstateContact(string $estate_id, array $data): void`

For more information about available request parameters and response properties, refer to [the official API documentation](https://website.sweepbright.com/docs/). Properties on both requests and responses are style agnostic, and are accessible through both snake\_case and camelCase.

###  Health Score

30

—

LowBetter than 61% of packages

Maintenance0

Infrequent updates — may be unmaintained

Popularity25

Limited adoption so far

Community12

Small or concentrated contributor base

Maturity68

Established project with proven stability

 Bus Factor1

Top contributor holds 87.5% 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 ~467 days

Total

4

Last Release

1085d ago

PHP version history (2 changes)1.0PHP ^7.1

1.2.0PHP ^7.1|^8.0

### Community

Maintainers

![](https://www.gravatar.com/avatar/2fe7a44c5e07cf8dd0eed2941b88dcab03342fb149ede5347b3467bc17691d4e?d=identicon)[Fyrts](/maintainers/Fyrts)

---

Top Contributors

[![fyrts](https://avatars.githubusercontent.com/u/5918336?v=4)](https://github.com/fyrts "fyrts (7 commits)")[![DeKerpelLaurent](https://avatars.githubusercontent.com/u/7040102?v=4)](https://github.com/DeKerpelLaurent "DeKerpelLaurent (1 commits)")

---

Tags

apisdksweepbright

###  Code Quality

TestsPHPUnit

### Embed Badge

![Health badge](/badges/fw4-sweepbright-api/health.svg)

```
[![Health](https://phpackages.com/badges/fw4-sweepbright-api/health.svg)](https://phpackages.com/packages/fw4-sweepbright-api)
```

###  Alternatives

[tempest/framework

The PHP framework that gets out of your way.

2.3k37.6k21](/packages/tempest-framework)[eslazarev/wildberries-sdk

Wildberries OpenAPI clients (generated).

353.6k](/packages/eslazarev-wildberries-sdk)[xeroapi/xero-php-oauth2

Xero official PHP SDK for oAuth2 generated with OpenAPI spec 3

1074.9M20](/packages/xeroapi-xero-php-oauth2)[civicrm/civicrm-core

Open source constituent relationship management for non-profits, NGOs and advocacy organizations.

762297.9k53](/packages/civicrm-civicrm-core)[tencentcloud/tencentcloud-sdk-php

TencentCloudApi php sdk

3661.3M49](/packages/tencentcloud-tencentcloud-sdk-php)[resend/resend-php

Resend PHP library.

608.3M53](/packages/resend-resend-php)

PHPackages © 2026

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