Supported Games

The only games supported by the Daybreak API are EQ2, PS2, DCUO, and MTGO. You may not utilize the API in connection with any other game(s). Any attempt to reverse engineer or circumvent the system to gain access to data other than as expressly provided herein is strictly prohibited and a violation of this API Policy, Daybreak’s Terms of Service, and applicable laws.

Comply with this policy and applicable laws

Your website or app must comply with this policy and all applicable laws. Be sure it does not include any content that infringes somebody else's rights. If your website or app includes content that is owned by somebody else, you will need to get their permission first.

Service ID Policy

You'll need to apply for a service ID in order to access the API. The service ID "s:example" is available for casual use--it is throttled to 10 requests per minute per client IP address. Please don't share your service ID with others. Always use a service ID in your applications, whether they access the Census API from the users client machine or from your server. Daybreak Game Company may terminate your service ID access without notice if you do not comply with the Daybreak Game Company API Policy. We may also terminate your access to the API if your website or app makes excessive requests or disrupts Daybreak Game Company's games.

Daybreak Game Company Intellectual Property

Daybreak Game Company reserves all rights and title to its games, game data, and intellectual property. The title of a mobile app using Daybreak Game Company's API may not include the name of an Daybreak Game Company game or any other Daybreak Game Company trademark. All use of game data and other content must comply with this policy and Daybreak Game Company's Terms of Service. Your website or app must not suggest or imply any sponsorship, endorsement, or association with Daybreak Game Company.

No Warranty

Daybreak Game Company's API and game data are provided "AS IS."" Daybreak Game Company may choose, in its discretion, what data to make available through the API. Daybreak Game Company may, in its discretion, modify, revoke access to, or discontinue the API, and/or may remove access to any portion of the game data, or all of the game data, at any time without notice.

Daybreak Game Company MAKES NO WARRANTIES, EXPRESS, IMPLIED, ARISING FROM COURSE OF DEALING OR USAGE OF TRADE, OR STATUTORY, AS TO THE API OR GAME DATA, AND EXPRESSLY EXCLUDES ANY AND ALL WARRANTIES OF TITLE, MERCHANTABILITY, NON-INFRINGEMENT, AND FITNESS FOR A PARTICULAR PURPOSE. Daybreak Game Company DOES NOT ENSURE THE CONTINUOUS, ERROR-FREE, BUG FREE, SECURE OR VIRUS FREE ACCESS TO OR OPERATION OF THE API OR GAME DATA.

Updates

Daybreak Game Company will make a best effort to document API changes in the "Developer Notes" forums at:
(EQ2) https://forums.daybreakgames.com/eq2/index.php?categories/eq2-data-api.296/
(PS2) https://forums.daybreakgames.com/ps2/index.php?categories/planetside-2-data-api.96/
(DCUO) https://forums.daybreakgames.com/dcuo/index.php#data-api.122.

Daybreak Game Company reserves the right to update our Policies and APIs at any time.

Contact

Please use Daybreak Game Company's API forums as a platform to ask questions, contribute feedback, and get help on the forums at:
(EQ2) https://forums.daybreakgames.com/eq2/index.php?categories/eq2-data-api.296/
(PS2) https://forums.daybreakgames.com/ps2/index.php?categories/planetside-2-data-api.96/
(DCUO) https://forums.daybreakgames.com/dcuo/index.php#data-api.122.

Endpoints

The following URL is to be used to access the REST interface: https://census.daybreakgames.com

URL Pattern

All requests to the REST interface follow a pattern. There are different patterns for different types of data:

Game Data:

• /verb/game/collection/[?queryString]
• Ex. https://census.daybreakgames.com/get/ps2:v2/character/?character_id=5428018587875812257&c:show=name

• {"limit":1,"max_ts":1357933355,"min_ts":1357933355,"character_list":[{"id":"5428018587875812257","ts":"1.357933355122906E9","name":{"first_lower":"gixtr2","first":"gixtr2"}}],"internal":false,"milliseconds":2,"returned":1}

Game Images:

• /files/game/images/type/[image_id].png
• Ex. https://census.daybreakgames.com/files/ps2/images/static/5391.png

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 dataset provided in the URL.

When using the XML format, the results will be provided in a parent <{collection}_list> element. In JSON, the results will be in an array ([ ]). If no results are found, this container will be empty.

Service ID

The service ID is used to identify the customer of the Census API for tracking and quality of service issues. The service ID is an alphanumeric value. All service IDs will be of the format s:<the service id>.

For example, here is a query for the world information with the service id (s:example) attached:

https://census.daybreakgames.com/s:example/get/ps2:v2/world/

The service ID should be used when making queries to the Census API. Always use a service ID in your applications, whether they access the Census API from the users client machine or from your server. The IP Address is optional. Providing it allows the Census API to ensure others are not misusing your registered Service ID.

To change or update your registered email addresses and IP addresses, please email data-feedback@daybreakgames.com.

The service ID "s:example" is available for casual use--it is throttled to 10 requests per minute per client IP address.

Please note that Census API requests without valid Service IDs will be throttled and may be completely blocked in the future.

format

The results of a call to the REST interface will be in either JavaScript Object Notation (json) or xml. Json is the default. It was chosen as it is a very efficient way to access data for most applications.

The format may be specified immediately after the service id, i.e. https://census.daybreakgames.com/s:example/xml/get/ps2:v2/character/ or https://census.daybreakgames.com/s:example/json/get/ps2:v2/character/. Specifying no format will result in the default of json.

Note: For developers, please install a json plugin (like JSONView) on your preferred browser. This will greatly aid in readability and formatting of json.

In order to access data across the domain boundary, one may want to use JSON Padding (jsonp). To do this, append a callback attribute to the query string of the request.

https://census.daybreakgames.com/get/ps2:v2/item/?item_id=70966&callback=foo

The results from this request will be padded within the function name, foo(), so that they may be evaluated by the requesting web site within the correct domain.

verb

This informs the REST interface about the type of request that is being made. The following values are supported across all games, however, as each game has its own data needs, different verbs may be made available on a per game basis. Some collections like 'characters_online_status', for example, do not support the count verb.

Namespace

The following values are supported for values. At this time, only the games eq2, ps2, dcuo, and mtgo are supported, but others will be added when each game team is ready. Additional values are specified for unannounced games, but are not listed in this document.

A note about versions:
In order to support on-going and future development the Census API uses a versioning scheme.  This allows us to make changes that are not backwards compatible without breaking third-party developed sites. Our first version is 'ps2:v1', however the latest stable version that will always be mapped to 'ps2' i.e. https://census.daybreakgames.com/get/ps2:v1/ is exactly the same as https://census.daybreakgames.com/get/ps2:v2/. Use 'ps2' if you want to guarantee that you are always pointing at the latest and greatest. Explicitly stating the version will avoid the API suddenly changing out from under your code, i.e. 'ps2:v1'.

collection

Supported collections are dynamic and dependent on the game providing data to the service.

Some objects may be omitted from a collection due to certain policies set by each game team to protect player privacy and/or business requirements.

Examples of these policies might include:

• Characters may be marked as private so that they are omitted from searches and rankings
• Items may be hidden until they are "discovered" naturally by a customer

Listing Available Collections

A list of all collections available for eq2 can be found at the following url: https://census.daybreakgames.com/get/eq2/

A list of all collections available for ps2 (pc) can be found at the following url: https://census.daybreakgames.com/get/ps2:v2/

A list of all collections available for ps2 (ps4 in us) can be found at the following url: https://census.daybreakgames.com/get/ps2ps4us:v2/

A list of all collections available for ps2 (ps4 in eu) can be found at the following url: https://census.daybreakgames.com/get/ps2ps4eu:v2/

A list of all collections available for dcuo (pc and ps3) can be found at the following url: https://census.daybreakgames.com/get/dcuo:v1/

A list of all collections available for MTGO can be found at the following url: https://census.daybreakgames.com/get/mtgo:v1/

identifier

Most objects have a unique identifier, which is used for a direct link to the information about that object. This can be found within the structure by the top-level "[collection]_id" field. All results will have this identifier, even if all other information is hidden.

There are also identifiers that are used in reference to other collections. For example, consider the following collection information from ps2 returned by this query https://census.daybreakgames.com/get/ps2/characters_item/?character_id=5428010618020694593:

characters_item_list: [
{
character_id: "5428010618020694593",
item_id: "16"
},
...

The item_id value is a reference to a particular object within the "item" collection. When presenting this information, one can put a link to another query to the REST interface or to join that information within its parent object. For more information on how to do this, see the Query Commands section for c:join. https://census.daybreakgames.com/get/ps2/characters_item/?character_id=5428010618020694593&c:join=item^show:name.en

query string

Each request for data may take an additional query string that allows one to specify parameters for a particular query. These take the standard form of "field=value". Multiple values may be provided separated by the ampersand ("&") character. The "field" portion of a query string corresponds to a particular field within a particular object within the collection. Please refer to the game specific documentation for a description of available fields.

If the field has a hierarchy, it can be referenced using a dot (".") notation. For example, considering the following data:

item_list: [
	{
		name: {
			en: "Mag-Cutter"
		},
		faction_id: "2",
		image_path: "/files/ps2/images/static/963.png",
		item_id: "1"
	}
],

In order to find all items that have the value "Force-Blade" within name.en, one would use the following query string:

?name.en=Force-Blade

If multiple search conditions are provided within the query string, they will be combined as a Boolean 'AND' operation. For instance, consider the following values within the following query string:

?field=]10&field=[50

This request would return data where the value of the "field" attribute was between 10 and 50 (inclusively).

A regex search can be combined with c:exactMatchFirst=true in order to show exact matches at the top of the result list. This is useful for character name searches:

search modifier

A modifier may be used in front of the value portion of the Query String to further enhance the results provided. Only one modifier may be used - the second modifier character would be considered to be part of the value.

Query Commands

A Query Command is a particular query string that instructs the REST service on how to organize the results that are to be returned. These are provided as query string attributes but are namespaced with "c:" to distinguish them from a search on a particular field. Depending on the query, not all of these commands may be implemented.

Using c:show to filter returned data

It is often useful to get only a portion of the total data available for a particular collection. In this case, one can specifically ask for information using the c:show query command:

https://census.daybreakgames.com/get/ps2:v2/character/?character_id=5428010618020694593&c:show=name,faction_id,battle_rank

"character_list": [

	{
		"name": {
			"first": "Dreadnaut",
			"first_lower": "dreadnaut"
		},
		"battle_rank": {
			"percent_to_next": "0",
			"value": "100"
		},
		"faction_id": "1"
	}

]

Using c:resolve to join collections

*Note that the new c:join command can do anything c:resolve can do and more! c:join described below.

Census provides the c:resolve command in order to join the queried collection with another related collection or collections.

Say you wanted to get the names of all the items owned by a character. You could make this query to get all the item ids for a given character id: https://census.daybreakgames.com/get/ps2:v2/characters_item?character_id=5428010618020694593&c:limit=5000. Using these ids you could make a second query to get the names of those items: https://census.daybreakgames.com/get/ps2:v2/item?item_id=7,13,17,24,28,60&c:show=name.en (not all 2000 ids listed for brevity). Doing 3 queries to get a character, his item ids, and then the names of those items is not exactly simple. In order to simplify the process you can use the predefined resolves.

To find the list of resolves available on a collection look at the section of that collection under https://census.daybreakgames.com/get/ps2:v2/

{
	"name": "character",
	"count": 6279787,
	"hidden": false,
	"resolve_list": [
		"item",
		"item_full",
		"profile",
		"faction",
		"stat",
		"stat_by_faction",
		"weapon_stat",
		"weapon_stat_by_faction",
		"stat_history",
		"online_status",
		"friends",
		"world",
		"outfit",
		"outfit_member",
		"outfit_member_extended",
		"currency"
	]
}

What each resolve does can be found by experimenting. The 'item' resolve joins to 'characters_item' giving you a list of 'item_id', 'stack_count', etc. The 'item_full' resolve joins first to the 'characters_item' collection and then again to the 'item' collection. Since the returned document would be very large let's limit what fields are returned from the resolve using parentheses and listing the fields we want shown: https://census.daybreakgames.com/get/ps2:v2/character/?character_id=5428010618020694593&c:resolve=item_full(name.en,description.en)

To restrict the visible fields from the resolved collection, they can be specified within parentheses (as displayed with name.en,description.en).

Using c:join to join collections dynamically

Meant to replace c:resolve, useful for resolving or joining multiple data types in one query. Think of it as a scriptable c:resolve- c:join can do everything c:resolve does plus more, since it does not have to be configured into the API. The join is made up of key value pairs key:value^key:value etc. Each value may be top-comma delimited key:value'value^key:value etc.

Possible keys are:

c:join=type:{other_type}^on:{this_type_field}^to:{other_type_field}^list:{0|1}^show:{field}'{field}^hide:{field}'{field}^inject_at:{inject_at_field_name}^terms:{x=1}

Multiple joins can be used comma-delimited. c:join=join1,join2,join3

A join can be nested by using parens, i.e. c:join=join1...(join1a...(join1b...))

Examples:

Using c:tree to reformat lists into trees

Useful for rearranging lists of data into trees of data. The tree is made up of key value pairs key:value^key:value etc. Each value may be top-comma delimited key:value'value^key:value etc.

Possible keys are:

Examples:

Organize a list of vehicles by type:

https://census.daybreakgames.com/get/ps2:v2/vehicle?c:limit=500&c:tree=type_id^prefix:type_^list:1&c:lang=en

Organize zones, map_regions, map_hexes by facility_type:

https://census.daybreakgames.com/get/ps2:v2/zone/?zone_id=2&c:join=map_region^list:1^inject_at:regions^hide:zone_id(map_hex^list:1^inject_at:hex^hide:zone_id'map_region_id)&c:tree=start:regions^field:facility_type^list:1&c:lang=en

Item Icons

Items have an icon_id field that can be used to get an image of that item: https://census.daybreakgames.com/s:example/get/ps2:v2/item/?item_id=7256&c:show=name.en,image_id,image_path shows the image_id is 5391 for item 7256 and the path is /files/ps2/images/static/5391.png. Here is the icon: https://census.daybreakgames.com/files/ps2/images/static/5391.png

Dates / Timestamps

Many collections have date / timestamp fields. The date is UTC (Coordinated Universal Time) timezone. The timestamp is seconds since midnight, January 1st 1970 UTC. We try to provide both a date and a timestamp representing the same value--such as times.last_save and times.last_save_date on the ps2/character collection. In some cases it may be faster to query by timestamp rather than date, or vice versa, depending on which is the native representation.

"Special" PS2 Collections

Not all collections behave the same way due to technical limitations. Here is a list of the collections that only support a subset of the Census query API.

*Note: c:resolve may not be supported by the collections below. Refer to the list of resolves at https://census.daybreakgames.com/get/ps2:v2/

Game-Specific Structure

This section of the document describes the data structure used for PlanetSide 2. This is useful for those starting to use the REST interface. Where possible, it should also establish patterns and best practices for other games providing game data through this service.

A list of collections available for namespace 'ps2' can be found here:

https://census.daybreakgames.com/get/ps2:v2/

For example, in the list mentioned above, the "character" collection has the following information:

{
	"name": "character",
	"count": 6279787,
	"hidden": false,
	"resolve_list": [
		"item",
		"item_full",
		"profile",
		"faction",
		"stat",
		"stat_by_faction",
		"weapon_stat",
		"weapon_stat_by_faction",
		"stat_history",
		"online_status",
		"friends",
		"world",
		"outfit",
		"outfit_member",
		"outfit_member_extended",
		"currency"
	]
}

Notice the "resolve_list" shows what fields can be expanded with more information via the c:resolve query string parameter. Here's an example of how you can show the "world_id" information for a character using a resolve:

https://census.daybreakgames.com/get/ps2:v2/character/?character_id=5428010618020694593&c:resolve=world&c:show=character_id,world_id. The field 'world_id' refers to the 'world' collection: https://census.daybreakgames.com/get/ps2:v2/world?c:limit=100

Example Queries

Good luck exploring the API! Remember you can always ask for help on the forums at:

(EQ2) https://forums.daybreakgames.com/eq2/index.php?categories/eq2-data-api.296/
(PS2) https://forums.daybreakgames.com/ps2/index.php?categories/planetside-2-data-api.96/
(DCUO) https://forums.daybreakgames.com/dcuo/index.php#data-api.122.

or by sending an email to data-feedback@daybreakgames.com.