IFDB APIs > gametags

The gametags API

The gametags API lets applications read tags on IFDB games.

Protocol

The gametags API is implemented as an http XML web service at https://ifdb.org/gametags. All parameters are passed as POST data with the HTTP request. As typical for HTTP, there's no session state or context; the entire transaction is carried out as the single request.

Parameter names and values

id: the TUID for the game you want to update. Ordinary text parameter; required.

mine_only: if this parameter is set, then we'll only return the tags that your username has set on the current game. Boolean parameter; optional.

username: the IFDB username for the account under which the listing will be created. Ordinary text parameter; required if mine_only is true.

password: the user's IFDB password. Ordinary text parameter; required if mine_only is true.

Reply format

The server replies to the request with an XML object describing the result. The response has this tag structure for a successful transaction:

<response>
    <tag>
        <name>example</name>
        <tagcnt>1</tagcnt>
        <gamecnt>1</gamecnt>
    </tag>
</response>

The tagcnt tag shows how many users have used that tag on the currently selected game. (Normally, tagcnt will be 1, because it's unusual for a player to add a tag when the game already has that tag.)

The gamecnt tag shows how many games have used that tag.

On error, the reply has this structure:

<response>
    <error>Please specify a valid username and password to login.</error>
</response>