census.daybreakgames.comDaybreak Game Company - Census API Documentation

Daybreak Game Company Data Services API Policy Supported Games Comply with this policy and applicable laws Service ID Policy Daybreak Game Company Intellectual Property No Warranty Updates Contact General Info Endpoints URL Pattern Service ID Detailed URL Options format verb Namespace collection Listing Available Collections identifier query string search modifier Query Commands Item Icons Dates / Timestamps Exceptions/Limitations "Special" PS2 Collections "Special" MTGO Collections Examples Game-Specific Structure Example Queries PS2 Event Streaming What is it? Details Sign up for a Service ID Welcome to the Census API! Daybreak Game Company Census API Policy We encourage players to use the Daybreak Game Company Data Services API to increase their engagement with Daybreak Game Company’s games and to create websites and mobile apps for other players to use and enjoy. Players are free to monetize their websites and apps by displaying banners and other forms of advertising. Players can also sell their apps and/or charge for premium functionality and content. The following rules apply to the use of our API… Supported Games The only games supported by the Daybreak API are EQ2, PS2, and DCUO. 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 useit 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 . You may also send an email to data-feedback@daybreakgames.com . General Info 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 useit 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. Sign up for a Service ID Below Fields marked with an asterisk* are required. Personal Info Name* Email* App Info Service ID* You choose whatever value you like for your Service ID. IP Address The server IP(s) you will connect from. Leave blank if connecting from clients. App Details Website link, etc. Thanks for your submission! You should receive an email from us shortly. There was a problem with your submission. Try again later or contact us at data-feedback@daybreakgames.com Detailed URL Options 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...