PHPackages                             uwebpro/scrapoxy-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. uwebpro/scrapoxy-api

ActiveLibrary[API Development](/categories/api)

uwebpro/scrapoxy-api
====================

PHP API Container for Scrapoxy Commander

v2.1.0(5y ago)068[1 issues](https://github.com/willpercey-gb/scrapoxy-php-api/issues)1proprietaryPHPPHP ^7.3|^8.0

Since Oct 19Pushed 2y ago1 watchersCompare

[ Source](https://github.com/willpercey-gb/scrapoxy-php-api)[ Packagist](https://packagist.org/packages/uwebpro/scrapoxy-api)[ RSS](/packages/uwebpro-scrapoxy-api/feed)WikiDiscussions main Synced 1mo ago

READMEChangelog (10)Dependencies (1)Versions (13)Used By (1)

Scrapoxy Controller
===================

[](#scrapoxy-controller)

This package interacts with the API from scrapoxy via a straight-forward interface

Installing
----------

[](#installing)

```
$ composer require uwebpro/scrapoxy-api
```

Usage
-----

[](#usage)

Initialse like so, parameter one is your scrapoxy conf.json file containing

```
    use UWebPro\Scrapoxy\Container;

    $api = new Container(__DIR__ . '/conf.json');

```

If you are using a different scrapoxy host that can be changed like so, by default it is

```
    use UWebPro\Scrapoxy\Container;

    $api = new Container(__DIR__ . '/conf.json', 'http://127.0.0.1:8889);

```

Common functions
----------------

[](#common-functions)

To start and stop a proxy pool

if values are left as null they will resume from previously set scaling

```
    $api->start(?int $min, ?int $required, ?int $max);
    $api->stop();

```

To Scale your proxy pool

```
    $api->rescale(int $min, int $required, int $max);

```

To list proxy instances as objects

```
    $api->getInstances();

```

### Instance object

[](#instance-object)

The following properties are available on the instance object

```
    public string $name;
    public string $type;
    public string $status;
    public array $address;
    public string $region;
    public bool $alive;
    public string $useragent;

```

As well as the following method

```
    $instance->remove();

```

An alternative to removing instances is

```
    $api->removeInstance($name);

```

### Scrapoxy config

[](#scrapoxy-config)

Scrapoxy's config can be read and updated using the following methods

```
    $api->getConfig(); //returns of config array

    $api->updateConfig($configArray);

```

ALL METHODS RETURN API RESPONSE

Contributing
------------

[](#contributing)

You can contribute in one of three ways:

1. File bug reports using the [issue tracker](https://github.com/vendor/package/issues).
2. Answer questions or fix bugs on the [issue tracker](https://github.com/vendor/package/issues).
3. Contribute new features or update the wiki.

You just need to make sure that you follow PSR coding guidelines.

License
-------

[](#license)

MIT

###  Health Score

29

—

LowBetter than 59% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity9

Limited adoption so far

Community11

Small or concentrated contributor base

Maturity66

Established project with proven stability

 Bus Factor1

Top contributor holds 97% 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 ~10 days

Recently: every ~25 days

Total

12

Last Release

1926d ago

Major Versions

v1.0.7 → v2.0.02020-12-23

PHP version history (3 changes)v1.0.0PHP ^7.3

v2.0.0PHP ^8.0

v2.1.0PHP ^7.3|^8.0

### Community

Maintainers

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

---

Top Contributors

[![willpercey-gb](https://avatars.githubusercontent.com/u/33656628?v=4)](https://github.com/willpercey-gb "willpercey-gb (32 commits)")[![dependabot[bot]](https://avatars.githubusercontent.com/in/29110?v=4)](https://github.com/dependabot[bot] "dependabot[bot] (1 commits)")

### Embed Badge

![Health badge](/badges/uwebpro-scrapoxy-api/health.svg)

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

###  Alternatives

[tencentcloud/tencentcloud-sdk-php

TencentCloudApi php sdk

3731.2M42](/packages/tencentcloud-tencentcloud-sdk-php)[convertkit/convertkitapi

Kit PHP SDK for the Kit API

2167.1k1](/packages/convertkit-convertkitapi)[mapado/rest-client-sdk

Rest Client SDK for hydra API

1125.9k2](/packages/mapado-rest-client-sdk)

PHPackages © 2026

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