PHPackages                             pbxg33k/vocadb - 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. pbxg33k/vocadb

ActiveLibrary[API Development](/categories/api)

pbxg33k/vocadb
==============

PHP API client for the VocaDB Public API (v1)

v0.1.3.3(9y ago)01.7k1MITPHP

Since May 5Pushed 9y ago2 watchersCompare

[ Source](https://github.com/PBXg33k/vocadb-php)[ Packagist](https://packagist.org/packages/pbxg33k/vocadb)[ RSS](/packages/pbxg33k-vocadb/feed)WikiDiscussions develop Synced 1mo ago

READMEChangelog (1)Dependencies (5)Versions (14)Used By (1)

[![Build Status](https://camo.githubusercontent.com/c0d87c8621ddc3ed744daf47e02b9d9646278e5444914cc6282bc8394ef655e7/68747470733a2f2f7472617669732d63692e6f72672f5042586733336b2f766f636164622d7068702e737667)](https://travis-ci.org/PBXg33k/vocadb-php) [![Scrutinizer quality score](https://camo.githubusercontent.com/aeda0543a15455c124dd25f29b48f97b16b38c85718569b8af4b8a8945d107d3/68747470733a2f2f7363727574696e697a65722d63692e636f6d2f672f5042586733336b2f766f636164622d7068702f6261646765732f7175616c6974792d73636f72652e706e673f623d6d6173746572)](https://camo.githubusercontent.com/aeda0543a15455c124dd25f29b48f97b16b38c85718569b8af4b8a8945d107d3/68747470733a2f2f7363727574696e697a65722d63692e636f6d2f672f5042586733336b2f766f636164622d7068702f6261646765732f7175616c6974792d73636f72652e706e673f623d6d6173746572) [![Latest Stable Version](https://camo.githubusercontent.com/bf58706cff26dcb74f99168769c5367d4666ea48f7e03199bedb55d77d90e67d/68747470733a2f2f706f7365722e707567782e6f72672f7062786733336b2f766f636164622f762f737461626c65)](https://packagist.org/packages/pbxg33k/vocadb) [![Total Downloads](https://camo.githubusercontent.com/9186db1845ca87263b65e251d7f1ebeddc91e4dace7904534110414b78448abe/68747470733a2f2f706f7365722e707567782e6f72672f7062786733336b2f766f636164622f646f776e6c6f616473)](https://packagist.org/packages/pbxg33k/vocadb) [![Latest Unstable Version](https://camo.githubusercontent.com/a8cfb6b9a0eff96bd47a26b0ea7f08c37a026e273b3979ebe82d4b144cba1efa/68747470733a2f2f706f7365722e707567782e6f72672f7062786733336b2f766f636164622f762f756e737461626c65)](https://packagist.org/packages/pbxg33k/vocadb) [![License](https://camo.githubusercontent.com/e605529493a7cba8ebd26a5b660c0f676d9746e3e6201a069d4b6cf2483fc772/68747470733a2f2f706f7365722e707567782e6f72672f7062786733336b2f766f636164622f6c6963656e7365)](https://packagist.org/packages/pbxg33k/vocadb)

VocaDB API PHP Client
=====================

[](#vocadb-api-php-client)

**NOTE: This is an early alpha release which is still in development!**

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

[](#installation)

### Using composer (recommended)

[](#using-composer-recommended)

Simply run: `composer require pbxg33k/vocadb dev-master`

or add the following line to your require in composer.json: `"pbxg33k/vocadb":"dev-master"`

### Without composer

[](#without-composer)

1. Download this repository as a zip file.
2. Extract to a directory in your application
3. Add files to your project
    - Map "pbxg33k/vocadb" to this directory if your autoloader is PSR-4 compatible
    - Include `autoload.php` to your project if either you don't have an autoloader or your autoloader is not PSR-4 compatible

How to use
----------

[](#how-to-use)

The goal of this project is an easy integration with VocaDB's public API.

Before you can do anything you must load the client

```
	$client = new Pbxg33k\VocaDB\Client();
```

The client uses Guzzle to communicate with the API. You can pass any guzzle configuration in an array mapped to the 'guzzle' key.

Let's say for example your server is behind a proxy and cannot communicate directly with VocaDB's API. We can instruct Guzzle to use a proxy for communication by simply adding the proxy information to the constuctor.

```
	$guzzleConfig = [
		'request.options' => [
			'proxy' => 'tcp://localhost:80/'
		]
	];

	// We assign the $guzzleConfig to array('guzzle' => data) so we don't mix up the library's own config.
	$clientConfig = ['guzzle' => $guzzleConfig];

	$client = new Pbxg33k\VocaDB\Client($clientConfig);
```

From this point on you can communicate with the API by simply calling the client's methods.

```
	// Get Livetune's information
	$livetune = $client->artist->getByName('livetune');

	// $livetune is now an array with searchresults
```

TODO
----

[](#todo)

- Add all missing endpoints
    - `PARTIALLY DONE` Song
    - Entry
    - SongList
    - `PARTIALLY DONE` Album
    - User
    - `PARTIALLY DONE` Tag
    - `PARTIALLY DONE` Artist
    - `PARTIALLY DONE` ReleaseEvent
    - Discussion

###  Health Score

29

—

LowBetter than 59% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity15

Limited adoption so far

Community12

Small or concentrated contributor base

Maturity60

Established project with proven stability

 Bus Factor1

Top contributor holds 98.9% 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 ~77 days

Recently: every ~138 days

Total

10

Last Release

3337d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/056e16095aa1c6f1b8c0f914ca98d0d00fa7289d5c5c78d95face22210102ad5?d=identicon)[PBX\_g33k](/maintainers/PBX_g33k)

---

Top Contributors

[![PBXg33k](https://avatars.githubusercontent.com/u/1777196?v=4)](https://github.com/PBXg33k "PBXg33k (86 commits)")[![scrutinizer-auto-fixer](https://avatars.githubusercontent.com/u/6253494?v=4)](https://github.com/scrutinizer-auto-fixer "scrutinizer-auto-fixer (1 commits)")

###  Code Quality

TestsPHPUnit

### Embed Badge

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

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

###  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)
