PHPackages                             aternos/spigot-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. aternos/spigot-api

ActiveLibrary[API Development](/categories/api)

aternos/spigot-api
==================

PHP Client for the SpigotMC XenforoResourceManagerAPI. This client is based on the openapi spec.

v2.3.0(2mo ago)12.4k↓38.1%MITPHPPHP ^8.3CI passing

Since Oct 6Pushed 5mo agoCompare

[ Source](https://github.com/aternosorg/php-spigot-api)[ Packagist](https://packagist.org/packages/aternos/spigot-api)[ Docs](https://github.com/aternosorg/php-spigot-api)[ RSS](/packages/aternos-spigot-api/feed)WikiDiscussions main Synced 1mo ago

READMEChangelog (4)Dependencies (6)Versions (7)Used By (0)

Aternos/php-spigot-api
======================

[](#aternosphp-spigot-api)

An API client for the SpigotMC API written in PHP. This client is a combination of code generated by OpenAPI Generator and thin wrappers to improve usability. It builds upon the [XenforoResourceManagerAPI](https://github.com/SpigotMC/XenforoResourceManagerAPI/) and uses its [OpenAPI specification](https://github.com/SpigotMC/XenforoResourceManagerAPI/blob/master/src/openapi.yaml).

The generated code can be found in `src/Api` and `src/Model`. It is recommended to use the wrappers in `src/Client` instead of the generated code.

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

[](#requirements)

- PHP 8.3 or newer
- PHP extensions: curl, json, mbstring

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

[](#installation)

Install the package via composer:

```
composer require aternos/spigot-api
```

Usage
-----

[](#usage)

The main entry point for the API is the `SpigotAPIClient` class.

```