Only publicly available data is accessible through Helix. That is, this is the same information you would see if you browsed www.gamerDNA.com. Under no circumstances is personally identifiable data (PII) available unless the gamerDNA member has expressly allowed it. See gamerDNA's privacy policy
Helix calls are simple HTTP GETs with XML/HTTP returns. All parameters are passed on the URL. Use your favorite programming language to make the HTTP calls and parse the resulting XML.
Checklist:
1. Create a gamerDNA account and get your APIKEY. (see Authentication section below.)
2. Follow steps for a sample Helix call. (See Sample Call section below.)
3. Expand your program to use other HELIX API calls. (See API calls chapter.)
The Samples Chapter contains a few PHP sample apps that show how to make the calls. (Please see www.gamerdna.com/helix_samples/ for the latest versions of the samples.)
Each Helix API call requires an APIKEY. Every registered member of GamerDNA receives this key.
To get your key: - log into gamerDNA. Go Manage your DNA. (See Manage button in upper right of member page.) Your APIKEY is at the bottom of the panel.
Open the panel from your profile and copy/paste the code. Please do not share the code with anyone. it isn’t secret, but we like to keep track of how many people are using the API. Also, if there is any abuse we will disable the apikey.
If you feel your API is being used by someone else let us know and we will assign you a new key.
Helix calls are simple HTTP request and responses. (note: Every call requires a valid apikey parameter.)
Typical Request:
GET http://helix.gamerdna.com/games/search?for=guild&apikey=<YOUR API KEYXXX>
Typical Response:
Reminder: XML Child elements can be in any order. They may be in a different order than what is below. (Your XML parser won't care.)
<helix>
<info>
<name>games/info</name>
<version>1.0</version>
<description>Returns information about a single game.</description>
<copyright>Content is copyright(c) gamerDNA 2009. All rights reserved. </copyright>
<request-time>Mon, 13 Apr 2009 17:25:13 -0400</request-time>
</info>
<game>
<name>Guild Wars</name>
<upc>89256600507</upc>
<publisher>NC Interactive</publisher>
<id>guild-wars</id>
</game>
</helix>
Errors will be return in XML format with the following syntax:
<Helix>
The <Error> tag is only present if an error occurred.
|
Error Code |
Meaning |
|
200 |
200 |
|
400 |
Bad Request - One of the request parameters was missing or out of range. |
| 401 | Not Authorized - Missing or invalid API key |
| 403 | User was authorized to use Helix and request was valid, but request was denied. |
|
404 |
Not Found - Helix object specified by ID parameter was not found. |
| 500 | Service Unavailable - Helix service is intentionally turned off for this period. |
|
50x |
Your browser of application environment may return a 50x error (e.g., 503) is there was a problem connecting to the Helix webservice. |
|
apikey |
Mandatory |
Required for every Helix call. See Authentication section above to find your own apikey. An apikey is a 40 char hex string similar to: 12345e03f56b6c1d09f95445ad67fc42edf41345 |
|
id |
MandatoryID | of the baseline game. Game IDs are returned from the Game/Search and Game/List calls. |
|
played_start |
Mandatory |
YYYY-MM-DD - First day when users played baseline game. |
|
played_end |
Mandatory | YYYY-MM-DD - Last day when users played baseline game. |
|
also_played_start |
Optional | timeframe of when baseline users played additional games. |
|
also_start_end |
Optional |
End of timeframe of when baseline users played additional games. |
|
limit |
Optional |
Max number of games to return. Can be between 1 and 100. Defaults to 20. |
Returns the games currently getting most attention on gamerDNA.com. This is a fast-twitch, ephemeral view of whats getting attention right now. Sometimes its one of the biggies, some times its a relatively small or unknown casual game.
Use to find out what gamers are interested in. See http://www.gamerdna.com/now/ for an example of how its used. The list is updated every 2 minutes.
|
apikey |
Mandatory |
Required for every Helix call. See Authentication section above to find your own apikey. An apikey is a 40 char hex string similar to: 12345e03f56b6c1d09f95445ad67fc42edf41345 |
|
limit |
Optional |
Number of games to return. Must be between 1 and 100. Defaults to 10. |
|
attributes |
Optional |
Controls numbers of attributes that are returned for each game. Values are MIN, NORMAL. See description in games/info for details. |
|
apikey |
Mandatory |
Required for every Helix call. See Authentication section above to find your own apikey. An apikey is a 40 char hex string similar to: 12345e03f56b6c1d09f95445ad67fc42edf41345 |
|
id |
Mandatory | ID of the game. Game IDs are returned from the Game/Search and Game/List calls. |
|
attributes |
Optional |
Controls number of attributes returned. MIN - - id - name - platform NORMAL - upc FULL - genre - style - number_players - vendors - nested data on Buy, play, rent data for games. Not all games will have this. Warning: FULL returns a lot of data. Min attributes are faster than FULL calls. Default: NORMAL |
|
apikey |
Mandatory |
Required for every Helix call. See Authentication section above to find your own apikey. An apikey is a 40 char hex string similar to: 12345e03f56b6c1d09f95445ad67fc42edf41345 |
|
id |
Mandatory | ID of the game. Game IDs are returned from the Game/Search and Game/List calls. |
|
limit |
Optional |
Number of records to elements return. Must be between 1,20. Default: 10 |
Returns an ordered list of the games gamerDNA members are playing. Games is sorted most played to least.
See also: Helix calls game_activity/rollup_day and game_activity/rollup_day
|
apikey |
Mandatory |
Required for every Helix call. See Authentication section above to find your own apikey. An apikey is a 40 char hex string similar to: 12345e03f56b6c1d09f95445ad67fc42edf41345 |
Example:
Search for a game by name or other fields. Use the Search call to find game IDs.
|
apikey |
Mandatory |
Required for every Helix call. See Authentication section above to find your own apikey. An apikey is a 40 char hex string similar to: 12345e03f56b6c1d09f95445ad67fc42edf41345 |
|
for |
Mandatory | Search phrase. |
|
on |
Optional |
Field name to search for. One of: Name, ID, UPC. Defaults to Name. (Note: UPC search requires match=EXACT.) |
|
match |
Optional |
Controls how games are matched. All matches are case-insensitive.
Default: any |
|
limit |
Optional |
Max number of games to return. Can be between 1 and 100. Defaults to 20. Only used if match=any or starts |
|
apikey |
Mandatory |
Required for every Helix call. See Authentication section above to find your own apikey. An apikey is a 40 char hex string similar to: 12345e03f56b6c1d09f95445ad67fc42edf41345 |
|
id |
Mandatory | ID of the member. Member IDs are returned from the Member/Search call. |
|
apikey |
Mandatory |
Required for every Helix call. See Authentication section above to find your own apikey. An apikey is a 40 char hex string similar to: 12345e03f56b6c1d09f95445ad67fc42edf41345 |
|
id |
Mandatory | ID of the member. Member IDs are returned from the Member/Search calls. |
|
apikey |
Mandatory |
Required for every Helix call. See Authentication section above to find your own apikey. An apikey is a 40 char hex string similar to: 12345e03f56b6c1d09f95445ad67fc42edf41345 |
|
id |
Mandatory | ID of the member. Member IDs are returned from the Member/Search call. |
Use the Search call to find Member IDs.
|
apikey |
Mandatory |
Required for every Helix call. See Authentication section above to find your own apikey. An apikey is a 40 char hex string similar to: 12345e03f56b6c1d09f95445ad67fc42edf41345 |
|
for |
Mandatory | Search phrase. |
|
on |
Optional |
Field name to search for. One of: Name or ID. Defaults to Name. |
|
match |
Optional |
Controls how Members are matched. All matches are case-insensitive.
Default: any |
|
limit |
Optional |
Max number of Members to return. Can be between 1 and 100. Defaults to 20. Only used if match=any |
|
apikey |
Mandatory |
Required for every Helix call. See Authentication section above to find your own apikey. An apikey is a 40 char hex string similar to: 12345e03f56b6c1d09f95445ad67fc42edf41345 |
|
status |
Mandatory | text message to set as the users status |
|
|
|
A Game_activity is a record of you playing a game. It could be today, yesterday or anytime in the past.
Note - each user can only have one game_activity per day for each game.
|
apikey |
Mandatory |
Required for every Helix call. See Authentication section above to find your own apikey. An apikey is a 40 char hex string similar to: 12345e03f56b6c1d09f95445ad67fc42edf41345 |
|
|
title |
Mandatory |
Title of the post. Max chars is 254 chars. |
|
|
game_id |
Mandatory |
|
|
|
date |
Optional |
|
|
|
mood |
Optional |
How are you feeling about the post? Possible values are: excited, happy, interested, neutral, bored, frustrated, angry and sad. Default: neutral. |
|
|
body |
Optional |
Text body of the post. Max chars is 512K. Default: blank. |
Delete a game_activity for a specific data and game
|
apikey |
Mandatory |
Required for every Helix call. See Authentication section above to find your own apikey. An apikey is a 40 char hex string similar to: 12345e03f56b6c1d09f95445ad67fc42edf41345 |
|
|
game_id |
Mandatory |
ID of the game_activity to delete. IDs are returned from the search and create calls. |
|
|
date |
Mandatory |
|
|
apikey |
Mandatory |
Required for every Helix call. See Authentication section above to find your own apikey. An apikey is a 40 char hex string similar to: 12345e03f56b6c1d09f95445ad67fc42edf41345 |
|
game_id |
Optional |
ID of the game. If supplied, only game posts from this game will be returned. Default: return posts from any game. |
|
user_id |
Optional |
ID of user. If supplied, only records from this user will be returned. Default: all users |
|
limit |
Optional |
limit the number of records returned, valid values are 1 to 500, defaults to 20 |
|
since |
Optional |
Date (YYYY-MM-DD) - Retrieve records on or after this date. Defaults to all dates. |
|
through |
Optional |
Date (YYYY-MM-DD) - Retrieve records up through this date. Leave blank to have no maximum date and default to all dates. |
<helix>
<info>
<name>game_activity/search</name>
<description>Returns activities.</description>
<version>1.0</version>
<request_time>Mon, 27 Jul 2009 21:44:37 -0000</request_time>
<copyright>Content is copyright(c) gamerDNA 2009. All rights reserved.</copyright>
</info>
<activities>
<count>6</count>
<activity>
<title>Wormy played Battlestations: Pacific (X360) on 2009-06-01</title>
<event_date>2009-06-01</event_date>
<by_user_id>Wormy</by_user_id>
<user_member_page>http://Wormy.dev1.com</user_member_page>
<created_at>Tue, 02 Jun 2009 11:05:35 -0400</created_at>
<mood>happy</mood>
<comment_count>0</comment_count>
<last_comment_date/>
<body>Had a GREAT mission on the Battle of Midway!</body>
<created_at>Tue, 02 Jun 2009 11:05:35 -0400</created_at>
<updated_at>Tue, 02 Jun 2009 17:33:26 -0400</updated_at>
<game>
<id>battlestations-pacific-xbox-360</id>
<name>Battlestations: Pacific</name>
<platform>X360</platform>
</game>
<milestones>
<count>0</count>
</milestones>
</activity>
<activity>
<title>Wormy played Castle Crashers (X360) on 2009-06-01</title>
<event_date>2009-06-01</event_date>
<by_user_id>Wormy</by_user_id>
<user_member_page>http://Wormy.dev1.com</user_member_page>
<created_at>Tue, 02 Jun 2009 11:05:34 -0400</created_at>
<mood/>
<comment_count>0</comment_count>
<last_comment_date/>
<body/>
<created_at>Tue, 02 Jun 2009 11:05:34 -0400</created_at>
<updated_at>Tue, 02 Jun 2009 11:05:34 -0400</updated_at>
<game>
<id>castle-crashers-xbox-360</id>
<name>Castle Crashers </name>
<platform>X360</platform>
</game>
<milestones>
<count>0</count>
</milestones>
</activity>
... some activity elements removed
</activities>
</helix>
|
|
Use this call to create a new Post. A Post is a user comment. It can be about a game (or multiple games), but it doesn't have to be. The post is created for the user specified by the apikey.
|
apikey |
Mandatory |
Required for every Helix call. See Authentication section above to find your own apikey. An apikey is a 40 char hex string similar to: 12345e03f56b6c1d09f95445ad67fc42edf41345 |
|
|
title |
Mandatory |
Title of the post. Max chars is 254 chars. |
|
|
date |
Optional |
|
|
|
game_id |
Optional |
ID(s) of the game(s). Delimit multiple IDs with semicolons (;). You can get the IDs from a games/search call. |
|
|
mood |
Optional |
How are you feeling about the post? Possible values are: excited, happy, interested, neutral, bored, frustrated, angry and sad. Default: neutral. |
|
|
body |
Optional |
Text body of the post. Max chars is 512K. |
Use this call to delete an existing post that your created.
|
apikey |
Mandatory |
Required for every Helix call. See Authentication section above to find your own apikey. An apikey is a 40 char hex string similar to: 12345e03f56b6c1d09f95445ad67fc42edf41345 |
|
id |
Mandatory |
ID of the post to delete. IDs are returned from the search and create calls. |
|
apikey |
Mandatory |
Required for every Helix call. See Authentication section above to find your own apikey. An apikey is a 40 char hex string similar to: 12345e03f56b6c1d09f95445ad67fc42edf41345 |
|
game_id |
Optional |
ID of the game. If supplied, only game posts from this game will be returned. Default: return posts from any game. |
|
user_id |
Optional |
ID of user. If supplied, only records from this user will be returned. Default: all users |
|
limit |
Optional |
limit the number of records returned, valid values are 1 to 500, defaults to 20 |
|
since |
Optional |
Date (YYYY-MM-DD) - Retrieve records on or after this date. Reviews older than the since value will not be included. Defaults to all dates. |
|
through |
Optional |
Date (YYYY-MM-DD) - Retrieve records up to and including this date. Leave blank to have no maximum date. Defaults to all dates. |
|
apikey |
Mandatory |
Required for every Helix call. See Authentication section above to find your own apikey. An apikey is a 40 char hex string similar to: 12345e03f56b6c1d09f95445ad67fc42edf41345 |
|
game_id |
One of: game_id or user_id |
ID of the game. If supplied, returns all of the traits used for a particular game. |
|
user_id |
One of: game_id or user_id. |
ID of user. If supplied, returns all of the traits a user has applied to any game. |
Use this call to create add a new image to your account. The post is created for the user specified by the apikey.
This should be done using an HTTP POST. See Sample Form
|
apikey |
Mandatory |
Required for every Helix call. See Authentication section above to find your own apikey. An apikey is a 40 char hex string similar to: 12345e03f56b6c1d09f95445ad67fc42edf41345 |
| image_file |
Mandatory |
full file post. Encoded as Content-Type multipart/form-data according to RFC2388. See sample form below. |
|
title |
Option |
Title of the image. Max chars is 254 chars. |
|
description |
Optional |
Optional description. |
|
show_public |
Optional |
true - if this image should be shown as part of your public filmstrip. false - if not. default: true |
| show_personal |
Optional |
true - if this image should be shown as part of your personal filmstrip. false - if not. default: true |
Use this call to delete an existing post that you created.
|
apikey |
Mandatory |
Required for every Helix call. See Authentication section above to find your own apikey. An apikey is a 40 char hex string similar to: 12345e03f56b6c1d09f95445ad67fc42edf41345 |
|
id |
Mandatory |
ID of the image to delete. IDs are returned from the search and create calls. See image/id field. |
|
apikey |
Mandatory |
Required for every Helix call. See Authentication section above to find your own apikey. An apikey is a 40 char hex string similar to: 12345e03f56b6c1d09f95445ad67fc42edf41345 |
|
game_id |
Optional |
ID of the game. If supplied, only images for this game. Default: return images from any game. |
|
user_id |
Optional |
ID of user. If supplied, only images from this user will be returned. Default: return images from any user. |
|
limit |
Optional |
limit the number of records returned, valid values are 1 to 100, defaults to 20 |
|
apikey |
Mandatory |
Required for every Helix call. See Authentication section above to find your own apikey. An apikey is a 40 char hex string similar to: 12345e03f56b6c1d09f95445ad67fc42edf41345 |
|
game_id |
Optional |
ID of the game. If supplied, only reviews from this game will be returned. Default: return reviews from any game. |
|
user_id |
Optional |
ID of user. If supplied, only reviews from this user will be returned. Default: return reviews from any user. |
|
limit |
Optional |
limit the number of records returned, valid values are 1 to 500, defaults to 20 |
|
apikey |
Mandatory |
Required for every Helix call. See Authentication section above to find your own apikey. An apikey is a 40 char hex string similar to: 12345e03f56b6c1d09f95445ad67fc42edf41345 |
|
name |
Mandatory |
the warhammer character name |
|
server |
Mandatory |
the warhammer server name |
|
Release |
Notes |
|
9/Jun/2009 |
|
|
20/Jul/2009 |
|
|
27/Jul/2009 |
|
|
18/Aug/2009 |
|