Download the PHP package xivapi/xivapi-php without Composer
On this page you can find all versions of the php package xivapi/xivapi-php. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Informations about the package xivapi-php
XIVAPI PHP Client
This provides a very simple client to interact with the XIVAPI and obtain dynamic objects in return.
Getting Started
This library requires PHP 7.4+
Install vis composer: https://packagist.org/packages/xivapi/xivapi-php
composer require xivapi/xivapi-php
Usage
The xivapi-php
library is a very simple wrapper around Guzzle.
Initialize
Setting your key if you have one
You can set the environment variable: XIVAPI_KEY
Or via:
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
- https://xivapi.com/docs/Content#limitids=1,4,8,20
- https://xivapi.com/docs/Content#idsminify=1
- https://xivapi.com/docs/Content#minifylanguage=en
- https://xivapi.com/docs/Welcome#languagesnake_case
- https://xivapi.com/docs/Welcome#snake_casecolumns
- https://xivapi.com/docs/Welcome#columnstags
- https://xivapi.com/docs/Welcome#tags
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()
Search
Search modification methods are:
Filters are additive, multiple can be added, eg:
Character
Free Company
Linkshell
PvPTeam
Note: The
_private
API is for internal use within XIVAPI and MogBoard. It cannot be used publicly and is locked behind an access key.