PHPackages xivapi/xivapi-php - 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. xivapi/xivapi-php ActiveLibrary[API Development](/categories/api) xivapi/xivapi-php ================= A PHP SDK for xivapi.com 1.6.12(7y ago)1587810[3 PRs](https://github.com/xivapi/xivapi-php/pulls)MITPHPPHP ^7.2 Since Nov 29Pushed 3y ago2 watchersCompare [ Source](https://github.com/xivapi/xivapi-php)[ Packagist](https://packagist.org/packages/xivapi/xivapi-php)[ Docs](https://github.com/xivapi/xivapi-php)[ RSS](/packages/xivapi-xivapi-php/feed)WikiDiscussions master Synced 2mo ago READMEChangelog (10)Dependencies (2)Versions (28)Used By (0) XIVAPI PHP Client ================= [](#xivapi-php-client) This provides a very simple client to interact with the XIVAPI and obtain dynamic objects in return. Getting Started --------------- [](#getting-started) This library requires PHP 7.4+ Install vis composer: - `composer require xivapi/xivapi-php` Usage ----- [](#usage) The `xivapi-php` library is a very simple wrapper around Guzzle. **Initialize** ``` $api = new \XIVAPI\XIVAPI(); ``` **Setting your key if you have one** You can set the environment variable: `XIVAPI_KEY` Or via: ``` $api->environment->key('my_api_key'); ``` **Using Queries (excludes Search)** The API has a whole host of queries to allow you to customise the response, these are all passed to the API before you request data. Search has some extra queries that are hard coded as these interact with Elastic Search. - `limit=250` - - `ids=1,4,8,20` - - `minify=1` - - `language=en` - - `snake_case` - [https://xivapi.com/docs/Welcome#snake\_case](https://xivapi.com/docs/Welcome#snake_case) - `columns` - - `tags` - ### Content [](#content) Content is dynamically driven based on what content is available in the game files using magic methods for invoking the different types, eg: - `item()` - `instanceContent()` - `tripleTriadCard()` ``` $api->content->[contentName]()->list(); $api->content->[contentName]()->one($id); // examples $item = $api->content->item()->one(1675); $action = $api->content->action()->one(127); $instances = $api->content->instanceContent()->list(); // non dynamic methods: $api->content->list(); $api->content->servers(); $api->content->serversByDataCenter(); ``` ### Search [](#search) ``` $api->search->find($string)->results(); ``` Search modification methods are: ``` // The column to search on $api->search->findColumn($column); // the algorithm to use $api->search->findAlgorithm($searchStringAlgorithm); // the page to start on $api->search->page($number); // sorting order $api->search->sort($field, $order); // limit results $api->search->limit($limit); // columns in the results $api->search->columns($columns); // change elastics filter bool condition (eg: should, must, must_not) $api->search->bool($bool); ``` Filters are additive, multiple can be added, eg: ``` $api->search ->filter('LevelItem', 30, SearchFilters::GREATER_THAN) ->filter('ItemSearchCategory', 10, SearchFilters::GREATER_THAN_OR_EQUAL_TO); ``` ### Character [](#character) ``` $api->character->search($name, $server, $page); $api->character->get($id, $data = [], $extended = false); $api->character->verify($id); $api->character->update($id); $api->character->delete($id); ``` ### Free Company [](#free-company) ``` $api->freecompany->search($name, $server, $page); $api->freecompany->get($id, $data = []); $api->freecompany->update($id); $api->freecompany->delete($id); ``` ### Linkshell [](#linkshell) ``` $api->linkshell->search($name, $server, $page); $api->linkshell->get($id, $data = []); $api->linkshell->update($id); $api->linkshell->delete($id); ``` ### PvPTeam [](#pvpteam) ``` $api->pvpteam->search($name, $server, $page); $api->pvpteam->get($id, $data = []); $api->pvpteam->update($id); $api->pvpteam->delete($id); ``` > Note: The `_private` API is for internal use within XIVAPI and MogBoard. It cannot be used publicly and is locked behind an access key. ### Health Score 35 — LowBetter than 79% of packages Maintenance20 Infrequent updates — may be unmaintained Popularity25 Limited adoption so far Community16 Small or concentrated contributor base Maturity66 Established project with proven stability Bus Factor1 Top contributor holds 89.2% 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 ~7 days Total 24 Last Release 2555d ago ### Community Maintainers ![](https://avatars.githubusercontent.com/u/136744026?v=4)[viion](/maintainers/viion)[@viion](https://github.com/viion) --- Top Contributors [![vekien](https://avatars.githubusercontent.com/u/270800?v=4)](https://github.com/vekien "vekien (33 commits)")[![Colbydude](https://avatars.githubusercontent.com/u/575593?v=4)](https://github.com/Colbydude "Colbydude (2 commits)")[![emirii](https://avatars.githubusercontent.com/u/6307976?v=4)](https://github.com/emirii "emirii (1 commits)")[![Supamiu](https://avatars.githubusercontent.com/u/11519203?v=4)](https://github.com/Supamiu "Supamiu (1 commits)") --- Tags xivapiphpapisdkffxiv ### Code Quality TestsPHPUnit ### Embed Badge ![Health badge](/badges/xivapi-xivapi-php/health.svg) ``` [![Health](https://phpackages.com/badges/xivapi-xivapi-php/health.svg)](https://phpackages.com/packages/xivapi-xivapi-php) ``` ### Alternatives [openai-php/laravel OpenAI PHP for Laravel is a supercharged PHP API client that allows you to interact with the Open AI API 3.7k7.6M74](/packages/openai-php-laravel)[hubspot/api-client Hubspot API client 23414.2M16](/packages/hubspot-api-client)[php-opencloud/openstack PHP SDK for OpenStack APIs. Supports BlockStorage, Compute, Identity, Images, Networking and Metric Gnocchi 2292.2M24](/packages/php-opencloud-openstack)[mailchimp/transactional 458.9M16](/packages/mailchimp-transactional)[resend/resend-php Resend PHP library. 564.7M21](/packages/resend-resend-php)[checkout/checkout-sdk-php Checkout.com SDK for PHP 553.3M7](/packages/checkout-checkout-sdk-php) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)