xivapi/companion-php

A library for interacting with the FFXIV Companion App API

1.2.8 2019-07-17 08:54 UTC

README

A library for interacting with the FFXIV Companion App API

To learn more about the FFXIV Companion App, read the Research Doc.

If you are just interested in market data and not access Companion App features, have a look at XIVAPI: https://xivapi.com/docs/Market

Terminology:

  • Companion: The Official FFXIV Companioon Mobile App.
  • Sight: The API that SE uses within the app to talk to the Game Servers.

Library Documentation

todo ... move more of this to the wiki

Character Select Process

In order to use the Sight API you need a valid character with an active Subscription (it cannot be in the free trial period). A character does not need to be at any "stage" in the game, a brand new-never logged into character will have full market board access the moment you enter a name and click "create".

Selecting a character

To access the market we first need to select our character and this requires knowing the unique "Character ID". We can find this by listing out our characters:

foreach ($api->Login()->getCharacters()->accounts[0]->characters as $character) {
    echo "- {$character->cid} :: {$character->name} ({$character->world})\n";
}

Characters have a unique Character ID property known as: cid. This ID is not the one you see on Lodestone or anything you'll be familiar with, once you find the character you want take its cid over to the loginCharacter function, for example:

$api->login()->loginCharacter('character_id');

This will confirm with Sight that you want to use this character, you can confirm yourself by performing the following optional code:

// Get current logged in character#echo "Confirming logged in character ...\n";
$character = $api->login()->getCharacter()->character;
echo "- Logged in as: {$character->name} ({$character->world}) \n";

Now that we've told it what character to use, we have to confirm its worlds status. This is a new addition in Patch 4.4 and I believe it will be used for when World Visit system is in place. For now it is a requirement and returns the current world and your home world:

$api->login()->getCharacterWorlds();

Once you have done this, you can now access the market board as well as any other Sight endpoint! You can find all API calls below.

Async Requests

The library supports async requests for all main data actions (not Account or Login actions). This allows you to query multiple endpoints at the same time.

When you enable async it will by pass the "garauntee response" feature. The Sight API doesn't provide data in the first request, instead it will take your request and queue it up, you then need to perform the same request again to get the response. Usually a Sight request will fulfill within 3 seconds, so you could 20 concurrent requests, wait 3 seconds and then perform the same 20 concurrent requests again using the same Request ID to get your response.

You can view an example of Async usage in bin/cli_async

API

Account

AddressBook

ChatRoom

Item

Login

Market

$api->market()->getItemMarketListings(int $itemId)

Get the current Market Prices for an item. The item id must be the in-game dat value which is an integer, not the one on Lodestone.

$api->market()->getTransactionHistory(int $itemId)

Get the current Market History for an item. The item id must be the in-game dat value which is an integer, not the one on Lodestone. The maximum returned history is currently 20, this cannot be changed.

$api->market()->getMarketListingsByCategory(int $categoryId)

Get the current stock listings for a market category

Payments

Reports

Schedule

Testing

  • php bin/cli - Have a look into thisclass for examples

Library by: Josh Freeman (Vekien on Discord: (XIVAPI) https://discord.gg/MFFVHWC)

License is MIT, do whatever you want with it :)