data.soe.com

Welcome to the home of the SOE data service, a RESTful API to get information directly from the source. This is available using HTTP and HTTPS.

Game Query

This service allows one to request information directly from SOE regarding the status of a game or game entity (e.g. character, item, spell, etc.).

Game queries use the following pattern:

[s:serviceID]/[format]/{verb}/{game}/{collection}/[{identifier}][?{queryString}]

Any item within brackets ("[]") are optional and may be omitted. For instance, if you don't have a serviceID, you can just skip that part of the pattern.

http://data.soe.com/json/get/eq2/item/2906185062

...is functionally equivalent (from a query perspective) to...

http://data.soe.com/s:serviceID/json/get/eq2/item/2906185062

Using a serviceID allows SOE to provide more capabilities to sites who use this API. It is not currently required, but is encouraged. Your service must be registered with SOE to use this facility. The first step to getting this done is to become a developer.

By default, results will be returned in what we call "jml" (JSON as HTML) which allows the data to be easily read by humans. The data is available in xml, json and yaml formats as well.

A special form of the game query is to query for server status. This is done by using the verb, "status".

[s:serviceID]/[format]/status/game[/serverName]

This is used to retrieve the current status of the game worlds for the given game. This drives a number of sites such as the SOE Status Page.

 

Game Images

Game images are also available through this service. These include images representing characters (paperdolls, headshots) or in-game items or abilities.

Requests for game images follow the pattern:

/[s:serviceID]/img/{game}/{collection}/{itemInCollection}/{category}[/{itemInCategory}]

Each item within a collection can have a number of "attachments" - usually an image, but can be any file. For games that support many attachments, there can also be a category and items within each category. The category and the ID for items within each category is game-specific.

EverQuest® II has an category for paperdoll, headshot, housethumb and petpaperdoll. The itemInCategory is used only if there is more than one item in the category. There is only one paperdoll, but there could be multiple housethumb attachments.

The REST interface will return all results that match the attributes provided within the query string. The data returned is in the form of a list containing zero or more items from the collection provided in the URL. When using the XML format, the results will be provided in a parent element. In JSON, the results will be in a parent dictionary.

 

More Information

More information about the API may be found in the Accessing Data forum. You may also get access to more information and discussion around the direction of the API by becoming a registered developer.