|
|
How to access data from any gameME Stats account?
Topics |
Overview
With the gameME API it is possible to access data of any gameME Stats account directly. Any results
of the client API are "utf-8" encoded. Example URL:
The syntax of the api commands is as follows:
| Command | Argument 1 | Argument 2 | Argument 3 |
| serverlist | Filter1 | Filter1-Value | - |
| serverinfo | Filter1-Value | Filter2 | Filter2-Value |
| playerlist | Filter1-Value | Filter2 | Filter2-Value |
| playerinfo | Filter1-Value | Filter2 | - |
| voiceserver | - | - | - |
| awards | Filter1-Value | Filter2 | Filter2-Value |
| ribbons | Filter1-Value | - | - |
| ribboninfo | Filter1-Value | Filter2 | Filter2-Value |
| ranks | Filter1-Value | - | - |
| rankinfo | Filter1-Value | Filter2 | Filter2-Value |
Additionally, with "GET" parameters it is possible to control the returned results:
| Name | Description | Parameter |
| limit | Limits the amount of returned results (Standard: 100 entries) | Numeric Values |
| page | Defines page of selected results | Numeric Values |
Example: http://fragmasters.gameme.com/api/playerlist/tf?limit=10
Currently, the following command types are available:
- serverlist - Current serverlist
- serverinfo - Detailed gameserver information
- playerlist - Current player ranking
- playerinfo - Detailed player information
- voiceserver - Voiceserver status
- awards - Award access
- ribbons - Current ribbons statistics
- ribboninfo - Player list of a specific ribbon
- ranks - Current ranks statistics
- rankinfo - Player list of a specific rank
Notes
- By default always the first 100 entries (maximum 1,000 entries) are returned. If no result
entries found, the following answer (example for an empty serverlist) will be returned:
| 1 | <gameME> | | 2 | <vendor> | | 3 | <label>gameME</label> | | 4 | <webpage>http://www.gameME.com</webpage> | | 5 | <license>personal, non-commercial use only</license> | | 6 | <copyright>Copyright © gameME 2013 - TTS Oetzel & Goerz GmbH. All rights | | 6 | reserved.</copyright> | | 7 | </vendor> | | 8 | <account> | | 9 | <webpage>http://fragmasters.gameme.com</webpage> | | 10 | </account> | | 11 | <serverlist> | | 12 | </serverlist> | | 13 | </gameME>
|
Pagination for some commands (e.g. playerlist) is added automatically if required:
| 1 | <pagination> | | 2 | <totalcount>4075</totalcount> | | 3 | <totalpages>815</totalpages> | | 4 | <currentpage>2</currentpage> | | 5 | <pageentries>5</pageentries> | | 6 | <prevpagelink> | | 7 | <![CDATA[http://fragmasters.gameme.com/api/playerlist/tf?limit=5&page=1]]> | | 8 | </prevpagelink> | | 9 | <nextpagelink> | | 10 | <![CDATA[http://fragmasters.gameme.com/api/playerlist/tf?limit=5&page=3]]> | | 11 | </nextpagelink> | | 12 | </pagination> |
The "pagination" definition is always as follows:
| Defintion | Datatype | Description |
|---|
| totalcount | Number | Total result list count | | totalpages | Number | Total result pages count | | currentpage | Number | Current page | | pageentries | Number | Displayed entries for each page | | prevpagelink | Number | Link to previous result page | | nextpagelink | Number | Link to next result page |
- In case of errors (for example, because of wrong parameters or commands) the following
answer will be returned:
| 1 | <error> | | 2 | <type>syntax</type> | | 3 | <description>http://www.gameme.com/docs/api/clientapi</description> | | 4 | </error> |
- To return properly formatted xml 1.0 results all entries with special characters are
automatically marked within a "CDATA" block. These tags are ignored by xml parser and
ensure the document can be parsed without errors. Example:
| 1 | <name><![CDATA[Bad@ze]]></name> |
- The api calls are limited to 1,000 requests within 30 minutes from one ip address.
- Empty values (null values) and values with the number "0" are delivered as tags without values. For example, a player without kills (0 kills) will be delivered with the tag "<kills />"
|
|
© 2013 TTS Oetzel & Goerz GmbH. All rights reserved. All trademarks are property of their respective owners.