PHPackages                             karotz/karotz - 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. karotz/karotz

ActiveLibrary[API Development](/categories/api)

karotz/karotz
=============

PHP library for the Karotz REST API

1.0.1-alpha(14y ago)581MITPHPPHP >=5.3.0

Since Jan 4Pushed 14y ago1 watchersCompare

[ Source](https://github.com/devster/KarotzPhp)[ Packagist](https://packagist.org/packages/karotz/karotz)[ Docs](http://github.com/devster/KarotzPhp)[ RSS](/packages/karotz-karotz/feed)WikiDiscussions master Synced 2w ago

READMEChangelogDependenciesVersions (3)Used By (0)

KarotzPhp - PHP library for the Karotz REST API
===============================================

[](#karotzphp---php-library-for-the-karotz-rest-api)

Installation
============

[](#installation)

Old school
----------

[](#old-school)

Download the latest version of KarotzPhp and add the `Karotz` namespace to your PSR-0 autoloading system, or simply require the autoload.php

Composer
--------

[](#composer)

```
{
    "require": {
        "karotz/karotz": ">=1.0.0-alpha"
    }
}
```

Usage
=====

[](#usage)

```
use Karotz\Karotz;

$kz = new Karotz('Interactive ID');

try {
	// Make flash your Karotz LED in red
	$response = $kz->ledPulse('FF0000', 500, 500);

	// Test the response
	if ($response->getStatus())
	    echo "Rabbit flashs red light!";
	else
	    echo $response->getCode().": ".$response->getDescription();

} catch(\Exception $e) {
	echo $e->getMessage();
}
```

Get the Interactive ID
----------------------

[](#get-the-interactive-id)

To run, the Karotz REST API needs an Interactive ID, which is reset every 15 minutes. Check the official documentation to know how retrieve this ID. KarotzPhp is not involved in managing the life cycle of the Interactive ID, but provides a way to get it with the signed START method:

```
use Karotz\Karotz;

$kz = new Karotz();

// Open a session and save the Interactive ID in the Karotz object
$response = $kz->start('install ID', 'API key', 'secret key');
```

Features
========

[](#features)

Work in progress... waiting for some test

About
=====

[](#about)

Requirements
------------

[](#requirements)

- Any flavor of PHP 5.3 should do

Author
------

[](#author)

- Jeremy Perret
- Thierry Geindre

License
-------

[](#license)

KarotzPhp is licensed under the MIT License - see the LICENSE file for details

###  Health Score

23

—

LowBetter than 26% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity10

Limited adoption so far

Community8

Small or concentrated contributor base

Maturity45

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

Unknown

Total

1

Last Release

5291d ago

### Community

Maintainers

![](https://avatars.githubusercontent.com/u/1135083?v=4)[Jeremy Perret](/maintainers/devster)[@devster](https://github.com/devster)

---

Top Contributors

[![devster](https://avatars.githubusercontent.com/u/1135083?v=4)](https://github.com/devster "devster (14 commits)")

---

Tags

api-restNabaztagKarotz

### Embed Badge

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

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

###  Alternatives

[exsyst/swagger

A php library to manipulate Swagger specifications

35816.3M7](/packages/exsyst-swagger)[hubspot/api-client

Hubspot API client

24015.5M18](/packages/hubspot-api-client)[pocketmine/bedrock-protocol

An implementation of the Minecraft: Bedrock Edition protocol in PHP

172437.8k11](/packages/pocketmine-bedrock-protocol)[phplicengine/bitly

Bitly API v4

21291.7k](/packages/phplicengine-bitly)[botman/driver-telegram

Telegram driver for BotMan

94452.6k6](/packages/botman-driver-telegram)[uderline/openapi-php-attributes

Automatically render your OpenApi 3 file describing your PHP API using attributes

2136.7k](/packages/uderline-openapi-php-attributes)

PHPackages © 2026

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